diff --git a/clean.js b/clean.js index 4e01fc2..02e8fa1 100644 --- a/clean.js +++ b/clean.js @@ -1 +1,46 @@ console.log('Cleaning the project.'); + +require('dotenv').config(); + +var accessKeyId = process.env.AWS_ACCESS_KEY_ID + secretAccessKey = process.env.AWS_SECRET_ACCESS_KEY + regionName = process.env.AWS_BUCKET_REGION + bucketName = process.env.AWS_BUCKET_NAME + +var AWS = require('aws-sdk'); +AWS.config.setPromisesDependency(Promise); +AWS.config.update({ + region: regionName + , credentials: new AWS.Credentials({ + accessKeyId: accessKeyId + , secretAccessKey: secretAccessKey + }) +}); + +const s3 = new AWS.S3({ apiVersion: '2006-03-01' }); + +s3.listObjects({ Bucket: bucketName }).promise().then(function(data){ + + if (data.Contents.length <= 0) { + console.log('Your bucket is already empty :)'); + return + } + + var objectKeys = []; + + for(let i = 0; i < data.Contents.length; i++){ + objectKeys.push({ + Key: data.Contents[i].Key + }) + } + + s3.deleteObjects({ Delete: { Objects: objectKeys }, Bucket: bucketName }).promise().then(function (data) { + console.log('Your bucket was emptied :)'); + }).catch( function(err) { + console.error(err.message); + throw err; + }); +}).catch( function(err) { + console.error(err.message); + throw err; +}); \ No newline at end of file diff --git a/node_modules/.bin/uuid b/node_modules/.bin/uuid new file mode 120000 index 0000000..b3e45bc --- /dev/null +++ b/node_modules/.bin/uuid @@ -0,0 +1 @@ +../uuid/bin/uuid \ No newline at end of file diff --git a/node_modules/aws-sdk/.eslintignore b/node_modules/aws-sdk/.eslintignore new file mode 100644 index 0000000..721e9e1 --- /dev/null +++ b/node_modules/aws-sdk/.eslintignore @@ -0,0 +1,3 @@ +dist/* +test/browser/**/* +test/configuration.js diff --git a/node_modules/aws-sdk/CHANGELOG.md b/node_modules/aws-sdk/CHANGELOG.md new file mode 100644 index 0000000..3ef8625 --- /dev/null +++ b/node_modules/aws-sdk/CHANGELOG.md @@ -0,0 +1,2502 @@ +# Changelog for AWS SDK for JavaScript + + + +## 2.451.0 +* feature: AlexaForBusiness: This release adds an API allowing authorized users to delete a shared device's history of voice recordings and associated response data. +* feature: AppSync: AWS AppSync now supports the ability to add additional authentication providers to your AWS AppSync GraphQL API as well as the ability to retrieve directives configured against fields or object type definitions during schema introspection. +* feature: SSM: Patch Manager adds support for Microsoft Application Patching. +* feature: StorageGateway: Add optional field AdminUserList to CreateSMBFileShare and UpdateSMBFileShare APIs. + +## 2.450.0 +* feature: ConfigService: AWS Config now supports tagging on PutConfigRule, PutConfigurationAggregator and PutAggregationAuthorization APIs. + +## 2.449.0 +* feature: CognitoIdentityServiceProvider: This release of Amazon Cognito User Pools introduces the new AdminSetUserPassword API that allows administrators of a user pool to change a user's password. The new password can be temporary or permanent. +* feature: MediaConvert: DASH output groups using DRM encryption can now enable a playback device compatibility mode to correct problems with playback on older devices. +* feature: MediaLive: You can now switch the channel mode of your channels from standard to single pipeline and from single pipeline to standard. In order to switch a channel from single pipeline to standard all inputs attached to the channel must support two encoder pipelines. +* feature: WorkMail: Amazon WorkMail is releasing two new actions: 'GetMailboxDetails' and 'UpdateMailboxQuota'. They add insight into how much space is used by a given mailbox (size) and what its limit is (quota). A mailbox quota can be updated, but lowering the value will not influence WorkMail per user charges. For a closer look at the actions please visit https://docs.aws.amazon.com/workmail/latest/APIReference/API_Operations.html + +## 2.448.0 +* feature: AlexaForBusiness: This release allows developers and customers to send text and audio announcements to rooms. +* feature: KMS: AWS Key Management Service (KMS) can return an INTERNAL_ERROR connection error code if it cannot connect a custom key store to its AWS CloudHSM cluster. INTERNAL_ERROR is one of several connection error codes that help you to diagnose and fix a problem with your custom key store. + +## 2.447.0 +* feature: EC2: This release adds an API for the modification of a VPN Connection, enabling migration from a Virtual Private Gateway (VGW) to a Transit Gateway (TGW), while preserving the VPN endpoint IP addresses on the AWS side as well as the tunnel options. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces additional task definition parameters that enable you to define secret options for Docker log configuration, a per-container list contains secrets stored in AWS Systems Manager Parameter Store or AWS Secrets Manager. +* feature: XRay: AWS X-Ray now includes Analytics, an interactive approach to analyzing user request paths (i.e., traces). Analytics will allow you to easily understand how your application and its underlying services are performing. With X-Ray Analytics, you can quickly detect application issues, pinpoint the root cause of the issue, determine the severity of the issues, and identify which end users were impacted. With AWS X-Ray Analytics you can explore, analyze, and visualize traces, allowing you to find increases in response time to user requests or increases in error rates. Metadata around peak periods, including frequency and actual times of occurrence, can be investigated by applying filters with a few clicks. You can then drill down on specific errors, faults, and response time root causes and view the associated traces. + +## 2.446.0 +* bugfix: DocumentClient: Fixes issue stringifying sets by only including values. +* feature: CodePipeline: This release contains an update to the PipelineContext object that includes the Pipeline ARN, and the Pipeline Execution Id. The ActionContext object is also updated to include the Action Execution Id. +* feature: DirectConnect: This release adds support for AWS Direct Connect customers to use AWS Transit Gateway with AWS Direct Connect gateway to route traffic between on-premise networks and their VPCs. +* feature: ManagedBlockchain: (New Service) Amazon Managed Blockchain is a fully managed service that makes it easy to create and manage scalable blockchain networks using popular open source frameworks. +* feature: S3Control: Add support for Amazon S3 Batch Operations. +* feature: ServiceCatalog: Admin users can now associate/disassociate aws budgets with a portfolio or product in Service Catalog. End users can see the association by listing it or as part of the describe portfolio/product output. A new optional boolean parameter, "DisableTemplateValidation", is added to ProvisioningArtifactProperties data type. The purpose of the parameter is to enable or disable the CloudFormation template validtion when creating a product or a provisioning artifact. + +## 2.445.0 +* feature: EC2: Adds support for Elastic Fabric Adapter (EFA) ENIs. +* feature: Transfer: This release adds support for per-server host-key management. You can now specify the SSH RSA private key used by your SFTP server. + +## 2.444.0 +* feature: IAM: AWS Security Token Service (STS) enables you to request session tokens from the global STS endpoint that work in all AWS Regions. You can configure the global STS endpoint to vend session tokens that are compatible with all AWS Regions using the new IAM SetSecurityTokenServicePreferences API. +* feature: SNS: With this release AWS SNS adds tagging support for Topics. + +## 2.443.0 +* feature: DynamoDB: This update allows you to tag Amazon DynamoDB tables when you create them. Tags are labels you can attach to AWS resources to make them easier to manage, search, and filter. +* feature: GameLift: This release introduces the new Realtime Servers feature, giving game developers a lightweight yet flexible solution that eliminates the need to build a fully custom game server. The AWS SDK updates provide support for scripts, which are used to configure and customize Realtime Servers. +* feature: Inspector: AWS Inspector - Improve the ListFindings API response time and decreases the maximum number of agentIDs from 500 to 99. +* feature: Lambda: AWS Lambda now supports the GetLayerVersionByArn API. + +## 2.442.0 +* feature: AlexaForBusiness: This release adds support for the Alexa for Business gateway and gateway group APIs. +* feature: EC2: You can now launch the new Amazon EC2 general purpose burstable instance types T3a that feature AMD EPYC processors. +* feature: MediaConnect: Adds support for ListEntitlements pagination. +* feature: MediaTailor: AWS Elemental MediaTailor SDK now includes a new parameter to support origin servers that produce single-period DASH manifests. +* feature: RDS: A new parameter "feature-name" is added to the add-role and remove-role db cluster APIs. The value for the parameter is optional for Aurora MySQL compatible database clusters, but mandatory for Aurora PostgresQL. You can find the valid list of values using describe db engine versions API. +* feature: Route53: Amazon Route 53 now supports the Asia Pacific (Hong Kong) Region (ap-east-1) for latency records, geoproximity records, and private DNS for Amazon VPCs in that region. +* feature: SSM: This release updates AWS Systems Manager APIs to allow customers to configure parameters to use either the standard-parameter tier (the default tier) or the advanced-parameter tier. It allows customers to create parameters with larger values and attach parameter policies to an Advanced Parameter. +* feature: StorageGateway: AWS Storage Gateway now supports Access Control Lists (ACLs) on File Gateway SMB shares, enabling you to apply fine grained access controls for Active Directory users and groups. +* feature: Textract: This release adds support for checkbox also known as SELECTION_ELEMENT in Amazon Textract. + +## 2.441.0 +* feature: CostExplorer: enable cors +* feature: ResourceGroups: The AWS Resource Groups service increased the query size limit to 4096 bytes. +* feature: TranscribeService: Amazon Transcribe - support transcriptions from audio sources in Spanish Spanish (es-ES). +* feature: WorkSpaces: Added a new reserved field. + +## 2.440.0 +* feature: Discovery: The Application Discovery Service's DescribeImportTasks and BatchDeleteImportData APIs now return additional statuses for error reporting. +* feature: Kafka: Amazon Kafka - Added tagging APIs +* feature: Organizations: AWS Organizations is now available in the AWS GovCloud (US) Regions, and we added a new API action for creating accounts in those Regions. For more information, see CreateGovCloudAccount in the AWS Organizations API Reference. +* feature: RDS: This release adds the TimeoutAction parameter to the ScalingConfiguration of an Aurora Serverless DB cluster. You can now configure the behavior when an auto-scaling capacity change can't find a scaling point. +* feature: WorkLink: Amazon WorkLink is a fully managed, cloud-based service that enables secure, one-click access to internal websites and web apps from mobile phones. This release introduces new APIs to link and manage internal websites and web apps with Amazon WorkLink fleets. + +## 2.439.0 +* feature: EC2: This release adds support for requester-managed Interface VPC Endpoints (powered by AWS PrivateLink). The feature prevents VPC endpoint owners from accidentally deleting or otherwise mismanaging the VPC endpoints of some AWS VPC endpoint services. +* feature: Polly: Amazon Polly adds Arabic language support with new female voice - "Zeina" + +## 2.438.0 +* bugfix: Parser: Alloc new buffers from 0 offset when parsing the sensitive blob data and zero out the node shared buffer pool. +* bugfix: computeSha256: Before running instanceof, verify that the operand is a function +* feature: CognitoIdentityServiceProvider: This release adds support for the new email configuration in Amazon Cognito User Pools. You can now specify whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. +* feature: MQ: This release adds the ability to retrieve information about broker engines and broker instance options. See Broker Engine Types and Broker Instance Options in the Amazon MQ REST API Reference. +* feature: Redshift: DescribeResize can now return percent of data transferred from source cluster to target cluster for a classic resize. +* feature: StorageGateway: This change allows you to select either a weekly or monthly maintenance window for your volume or tape gateway. It also allows you to tag your tape and volume resources on creation by adding a Tag value on calls to the respective api endpoints. + +## 2.437.0 +* feature: Comprehend: With this release AWS Comprehend provides confusion matrix for custom document classifier. +* feature: Glue: AWS Glue now supports workerType choices in the CreateJob, UpdateJob, and StartJobRun APIs, to be used for memory-intensive jobs. +* feature: MediaConvert: Rectify incorrect modelling of DisassociateCertificate method +* feature: MediaLive: Today AWS Elemental MediaLive (https://aws.amazon.com/medialive/) adds the option to create "Single Pipeline" channels, which offers a lower-cost option compared to Standard channels. MediaLive Single Pipeline channels have a single encoding pipeline rather than the redundant dual Availability Zone (AZ) pipelines that MediaLive provides with a "Standard" channel. +* feature: docs: update doc operation example to use 'NUMBER_VALUE' instead of 0 in input + +## 2.436.0 +* feature: EKS: Added support to enable or disable publishing Kubernetes cluster logs in AWS CloudWatch + +## 2.435.0 +* bugfix: integration: remove rds create DB security group test +* feature: Batch: Support for GPU resource requirement in RegisterJobDefinition and SubmitJob +* feature: Comprehend: With this release AWS Comprehend adds tagging support for document-classifiers and entity-recognizers. + +## 2.434.0 +* feature: EC2: Add paginators. +* feature: SecurityHub: This update includes 3 additional error codes: AccessDeniedException, InvalidAccessException, and ResourceConflictException. This update also removes the error code ResourceNotFoundException from the GetFindings, GetInvitationsCount, ListInvitations, and ListMembers operations. + +## 2.433.0 +* feature: EMR: Amazon EMR adds the ability to modify instance group configurations on a running cluster through the new "configurations" field in the ModifyInstanceGroups API. + +## 2.432.0 +* feature: CloudWatch: Added 3 new APIs, and one additional parameter to PutMetricAlarm API, to support tagging of CloudWatch Alarms. +* feature: Comprehend: With this release AWS Comprehend supports encryption of output results of analysis jobs and volume data on the storage volume attached to the compute instance that processes the analysis job. +* feature: Greengrass: Greengrass APIs now support tagging operations on resources + +## 2.431.0 +* feature: MediaLive: This release adds a new output locking mode synchronized to the Unix epoch. +* feature: PinpointEmail: This release adds support for using the Amazon Pinpoint Email API to tag the following types of Amazon Pinpoint resources: configuration sets; dedicated IP pools; deliverability dashboard reports; and, email identities. A tag is a label that you optionally define and associate with these types of resources. Tags can help you categorize and manage these resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. For more information, see the Amazon Pinpoint Email API Reference. +* feature: ServiceCatalog: Adds "Tags" field in UpdateProvisionedProduct API. The product should have a new RESOURCE_UPDATE Constraint with TagUpdateOnProvisionedProduct field set to ALLOWED for it to work. See API docs for CreateConstraint for more information +* feature: WorkSpaces: Amazon WorkSpaces adds tagging support for WorkSpaces Images, WorkSpaces directories, WorkSpaces bundles and IP Access control groups. + +## 2.430.0 +* feature: AppMesh: This release includes AWS Tagging integration for App Mesh, VirtualNode access logging, TCP routing, and Mesh-wide external traffic egress control. See https://docs.aws.amazon.com/app-mesh/latest/APIReference/Welcome.html for more details. +* feature: EC2: You can now launch the new Amazon EC2 R5ad and M5ad instances that feature local NVMe attached SSD instance storage (up to 3600 GB). M5ad and R5ad feature AMD EPYC processors that offer a 10% cost savings over the M5d and R5d EC2 instances. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces support for external deployment controllers for ECS services with the launch of task set management APIs. Task sets are a new primitive for controlled management of application deployments within a single ECS service. +* feature: ELBv2: This release adds support for routing based on HTTP headers, methods, query string or query parameters and source IP addresses in Application Load Balancer. +* feature: S3: S3 Glacier Deep Archive provides secure, durable object storage class for long term data archival. This SDK release provides API support for this new storage class. +* feature: StorageGateway: This change allows you to select a pool for archiving virtual tapes. Pools are associated with S3 storage classes. You can now choose to archive virtual tapes in either S3 Glacier or S3 Glacier Deep Archive storage class. CreateTapes API now takes a new PoolId parameter which can either be GLACIER or DEEP_ARCHIVE. Tapes created with this parameter will be archived in the corresponding storage class. +* feature: Transfer: This release adds PrivateLink support to your AWS SFTP server endpoint, enabling the customer to access their SFTP server within a VPC, without having to traverse the internet. Customers can now can create a server and specify an option whether they want the endpoint to be hosted as public or in their VPC, and with the in VPC option, SFTP clients and users can access the server only from the customer's VPC or from their on-premises environments using DX or VPN. This release also relaxes the SFTP user name requirements to allow underscores and hyphens. + +## 2.429.0 +* feature: Credentials: enables use of credentials_process for sourcing credentials from an external process https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes +* feature: Glue: This new feature will now allow customers to add a customized csv classifier with classifier API. They can specify a custom delimiter, quote symbol and control other behavior they'd like crawlers to have while recognizing csv files + +## 2.428.0 +* feature: DirectConnect: Direct Connect gateway enables you to establish connectivity between your on-premise networks and Amazon Virtual Private Clouds (VPCs) in any commercial AWS Region (except in China) using AWS Direct Connect connections at any AWS Direct Connect location. This release enables multi-account support for Direct Connect gateway, with multi-account support for Direct Connect gateway, you can associate up to ten VPCs from any AWS account with a Direct Connect gateway. The AWS accounts owning VPCs and the Direct Connect gateway must belong to the same AWS payer account ID. This release also enables Direct Connect Gateway owners to allocate allowed prefixes from each associated VPCs. +* feature: FMS: AWS Firewall Manager now allows customer to centrally enable AWS Shield Advanced DDoS protection for their entire AWS infrastructure, across accounts and applications. +* feature: IoT1ClickDevicesService: This release adds tagging support for AWS IoT 1-Click Device resources. Use these APIs to add, remove, or list tags on Devices, and leverage the tags for various authorization and billing scenarios. This release also adds the ARN property for DescribeDevice response object. +* feature: IoTAnalytics: This change allows you to specify the number of versions of IoT Analytics data set content to be retained. Previously, the number of versions was managed implicitly via the setting of the data set's retention period. +* feature: MediaConvert: This release adds support for detailed job progress status and S3 server-side output encryption. In addition, the anti-alias filter will now be automatically applied to all outputs +* feature: Retry: make RequestThrottleException retryable +* feature: RoboMaker: Added additional progress metadata fields for robot deployments +* feature: TranscribeService: Amazon Transcribe - With this release Amazon Transcribe enhances the custom vocabulary feature to improve accuracy by providing customization on pronunciations and output formatting. + +## 2.427.0 +* feature: IoT1ClickProjects: This release adds tagging support for AWS IoT 1-Click Project resources. Use these APIs to add, remove, or list tags on Projects, and leverage the tags for various authorization and billing scenarios. This release also adds the ARN property to projects for DescribeProject and ListProject responses. +* feature: TranscribeService: Amazon Transcribe - support transcriptions from audio sources in German (de-DE) and Korean (ko-KR). + +## 2.426.0 +* bugfix: Paginator: still send '{}' in body for requests other than GET +* feature: CloudWatchEvents: Added 3 new APIs, and one additional parameter to the PutRule API, to support tagging of CloudWatch Events rules. +* feature: CognitoIdentityServiceProvider: This release adds tags and tag-based access control support to Amazon Cognito User Pools. +* feature: Iot: This release adds the GetStatistics API for the AWS IoT Fleet Indexing Service, which allows customers to query for statistics about registered devices that match a search query. This release only supports the count statistics. For more information about this API, see https://docs.aws.amazon.com/iot/latest/apireference/API_GetStatistics.html +* feature: Lightsail: This release adds the DeleteKnownHostKeys API, which enables Lightsail's browser-based SSH or RDP clients to connect to the instance after a host key mismatch. + +## 2.425.0 +* feature: CodePipeline: Add support for viewing details of each action execution belonging to past and latest pipeline executions that have occurred in customer's pipeline. The details include start/updated times, action execution results, input/output artifacts information, etc. Customers also have the option to add pipelineExecutionId in the input to filter the results down to a single pipeline execution. +* feature: CognitoIdentity: This release adds tags and tag-based access control support to Amazon Cognito Identity Pools (Federated Identities). +* feature: MarketplaceMetering: This release increases AWS Marketplace Metering Service maximum usage quantity to 2147483647 and makes parameters usage quantity and dryrun optional. +* feature: cors: add cors support for IAM and ResouceGroups services + +## 2.424.0 +* bugfix: Paginator: fix the issue where paginator keys are ignored in GET requests +* bugfix: Request: Fix nextPage() method signature +* feature: ConfigService: AWS Config adds a new API called SelectResourceConfig to run advanced queries based on resource configuration properties. +* feature: EKS: Added support to control private/public access to the Kubernetes API-server endpoint + +## 2.423.0 +* feature: Chime: This release adds support for the Amazon Chime Business Calling and Voice Connector features. +* feature: DMS: S3 Endpoint Settings added support for 1) Migrating to Amazon S3 as a target in Parquet format 2) Encrypting S3 objects after migration with custom KMS Server-Side encryption. Redshift Endpoint Settings added support for encrypting intermediate S3 objects during migration with custom KMS Server-Side encryption. +* feature: EC2: DescribeFpgaImages API now returns a new DataRetentionSupport attribute to indicate if the AFI meets the requirements to support DRAM data retention. DataRetentionSupport is a read-only attribute. + +## 2.422.0 +* feature: ACM: AWS Certificate Manager has added a new API action, RenewCertificate. RenewCertificate causes ACM to force the renewal of any private certificate which has been exported. +* feature: ACMPCA: AWS Certificate Manager (ACM) Private CA allows customers to manage permissions on their CAs. Customers can grant or deny AWS Certificate Manager permission to renew exported private certificates. +* feature: CloudWatch: New Messages parameter for the output of GetMetricData, to support new metric search functionality. +* feature: ConfigService: AWS Config - add ability to tag, untag and list tags for ConfigRule, ConfigurationAggregator and AggregationAuthorization resource types. Tags can be used for various scenarios including tag based authorization. +* feature: EC2: This release adds tagging support for Dedicated Host Reservations. +* feature: Iot: In this release, AWS IoT introduces support for tagging OTA Update and Stream resources. For more information about tagging, see the AWS IoT Developer Guide. +* feature: SageMaker: Amazon SageMaker Automatic Model Tuning now supports random search and hyperparameter scaling. + +## 2.421.0 +* feature: ConfigService: Config released Remediation APIs allowing Remediation of Config Rules + +## 2.420.0 +* bugfix: ManageUpload: abort request stream when body is smaller than 5MB +* feature: ServerlessApplicationRepository: The AWS Serverless Application Repository now supports associating a ZIP source code archive with versions of an application. + +## 2.419.0 +* feature: CostExplorer: The only change in this release is to make TimePeriod a required parameter in GetCostAndUsageRequest. +* feature: ElasticBeanstalk: Elastic Beanstalk added support for tagging, and tag-based access control, of all Elastic Beanstalk resources. +* feature: Glue: CreateDevEndpoint and UpdateDevEndpoint now support Arguments to configure the DevEndpoint. +* feature: QuickSight: Amazon QuickSight user and group operation results now include group principal IDs and user principal IDs. This release also adds "DeleteUserByPrincipalId", which deletes users given their principal ID. The update also improves role session name validation. + +## 2.418.0 +* bugfix: cloudfront: Fix whitespace removal on custom policy +* feature: CodeBuild: CodeBuild also now supports Git Submodules. CodeBuild now supports opting out of Encryption for S3 Build Logs. By default these logs are encrypted. +* feature: SageMaker: SageMaker notebook instances now support enabling or disabling root access for notebook users. SageMaker Neo now supports rk3399 and rk3288 as compilation target devices. + +## 2.417.0 +* feature: AppMesh: This release includes a new version of the AWS App Mesh APIs. You can read more about the new APIs here: https://docs.aws.amazon.com/app-mesh/latest/APIReference/Welcome.html. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces additional task definition parameters that enable you to define dependencies for container startup and shutdown, a per-container start and stop timeout value, as well as an AWS App Mesh proxy configuration which eases the integration between Amazon ECS and AWS App Mesh. +* feature: GameLift: Amazon GameLift-hosted instances can now securely access resources on other AWS services using IAM roles. See more details at https://aws.amazon.com/releasenotes/amazon-gamelift/. +* feature: Greengrass: Greengrass group UID and GID settings can now be configured to use a provided default via FunctionDefaultConfig. If configured, all Lambda processes in your deployed Greengrass group will by default start with the provided UID and/or GID, rather than by default starting with UID "ggc_user" and GID "ggc_group" as they would if not configured. Individual Lambdas can also be configured to override the defaults if desired via each object in the Functions list of your FunctionDefinitionVersion. +* feature: MediaLive: This release adds a MediaPackage output group, simplifying configuration of outputs to AWS Elemental MediaPackage. +* feature: RDS: You can configure your Aurora database cluster to automatically copy tags on the cluster to any automated or manual database cluster snapshots that are created from the cluster. This allows you to easily set metadata on your snapshots to match the parent cluster, including access policies. You may enable or disable this functionality while creating a new cluster, or by modifying an existing database cluster. + +## 2.416.0 +* feature: DirectConnect: Exposed a new available port speeds field in the DescribeLocation api call. +* feature: EC2: This release adds pagination support for ec2.DescribeVpcs, ec2.DescribeInternetGateways and ec2.DescribeNetworkAcls APIs + +## 2.415.0 +* feature: MediaLive: This release adds support for pausing and unpausing one or both pipelines at scheduled times. +* feature: StorageGateway: ActivateGateway, CreateNFSFileShare and CreateSMBFileShare APIs support a new parameter: Tags (to be attached to the created resource). Output for DescribeNFSFileShare, DescribeSMBFileShare and DescribeGatewayInformation APIs now also list the Tags associated with the resource. Minimum length of a KMSKey is now 7 characters. +* feature: Textract: This release is intended ONLY for customers that are officially part of the Amazon Textract Preview program. If you are not officially part of the Amazon Textract program THIS WILL NOT WORK. Our two main regions for Amazon Textract Preview are N. Virginia and Dublin. Also some members have been added to Oregon and Ohio. If you are outside of any of these AWS regions, Amazon Textract Preview definitely will not work. If you would like to be part of the Amazon Textract program, you can officially request sign up here - https://pages.awscloud.com/textract-preview.html. To set expectations appropriately, we are aiming to admit new preview participants once a week until General Availability. + +## 2.414.0 +* feature: MediaPackage: This release adds support for user-defined tagging of MediaPackage resources. Users may now call operations to list, add and remove tags from channels and origin-endpoints. Users can also specify tags to be attached to these resources during their creation. Describe and list operations on these resources will now additionally return any tags associated with them. +* feature: SSM: This release updates AWS Systems Manager APIs to support service settings for AWS customers. A service setting is a key-value pair that defines how a user interacts with or uses an AWS service, and is typically created and consumed by the AWS service team. AWS customers can read a service setting via GetServiceSetting API and update the setting via UpdateServiceSetting API or ResetServiceSetting API, which are introduced in this release. For example, if an AWS service charges money to the account based on a feature or service usage, then the AWS service team might create a setting with the default value of "false". This means the user can't use this feature unless they update the setting to "true" and intentionally opt in for a paid feature. + +## 2.413.0 +* feature: EC2: This release adds support for modifying instance event start time which allows users to reschedule EC2 events. + +## 2.412.0 +* bugfix: ComprehendMedical: enable cors on ComprehendMedical, update SERVICES.md +* feature: AlexaForBusiness: This release adds the PutInvitationConfiguration API to configure the user invitation email template with custom attributes, and the GetInvitationConfiguration API to retrieve the configured values. +* feature: ApiGatewayV2: Marking certain properties as explicitly required and fixing an issue with the GetApiMappings operation for ApiMapping resources. +* feature: SSM: AWS Systems Manager State Manager now supports associations using documents shared by other AWS accounts. + +## 2.411.0 +* feature: CUR: Adding support for Athena and new report preferences to the Cost and Usage Report API. +* feature: MediaConvert: AWS Elemental MediaConvert SDK has added several features including support for: auto-rotation or user-specified rotation of 0, 90, 180, or 270 degrees; multiple output groups with DRM; ESAM XML documents to specify ad insertion points; Offline Apple HLS FairPlay content protection. +* feature: Pinpoint: This release adds support for the Amazon Resource Groups Tagging API to Amazon Pinpoint, which means that you can now add and manage tags for Amazon Pinpoint projects (apps), campaigns, and segments. A tag is a label that you optionally define and associate with Amazon Pinpoint resource. Tags can help you categorize and manage these types of resources in different ways, such as by purpose, owner, environment, or other criteria. For example, you can use tags to apply policies or automation, or to identify resources that are subject to certain compliance requirements. A project, campaign, or segment can have as many as 50 tags. For more information about using and managing tags in Amazon Pinpoint, see the Amazon Pinpoint Developer Guide at https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html. For more information about the Amazon Resource Group Tagging API, see the Amazon Resource Group Tagging API Reference at https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/Welcome.html. + +## 2.410.0 +* feature: AutoScaling: Added support for passing an empty SpotMaxPrice parameter to remove a value previously set when updating an Amazon EC2 Auto Scaling group. +* feature: CostExplorer: Added metrics to normalized units. +* feature: ELBv2: This release enables you to use the existing client secret when modifying a rule with an action of type authenticate-oidc. +* feature: MediaStore: This release adds support for access logging, which provides detailed records for the requests that are made to objects in a container. + +## 2.409.0 +* feature: Athena: This release adds tagging support for Workgroups to Amazon Athena. Use these APIs to add, remove, or list tags on Workgroups, and leverage the tags for various authorization and billing scenarios. +* feature: Cloud9: Adding EnvironmentLifecycle to the Environment data type. +* feature: Glue: AWS Glue adds support for assigning AWS resource tags to jobs, triggers, development endpoints, and crawlers. Each tag consists of a key and an optional value, both of which you define. With this capacity, customers can use tags in AWS Glue to easily organize and identify your resources, create cost allocation reports, and control access to resources. +* feature: StepFunctions: This release adds support for tag-on-create. You can now add tags when you create AWS Step Functions activity and state machine resources. For more information about tagging, see AWS Tagging Strategies. + +## 2.408.0 +* feature: CodeBuild: Add support for CodeBuild local caching feature +* feature: KinesisVideoArchivedMedia: In this release, HLS playback of KVS streams can be configured to output MPEG TS fragments using the ContainerFormat parameter. HLS playback of KVS streams can also be configured to include the EXT-X-PROGRAM-DATE-TIME field using the DisplayFragmentTimestamp parameter. +* feature: Transfer: Bug fix: increased the max length allowed for request parameter NextToken when paginating List operations + +## 2.407.0 +* feature: CodeCommit: This release adds an API for adding / updating / deleting / copying / moving / setting file modes for one or more files directly to an AWS CodeCommit repository without requiring a Git client. +* feature: DirectConnect: Documentation updates for AWS Direct Connect +* feature: MediaLive: This release adds support for VPC inputs, allowing you to push content from your Amazon VPC directly to MediaLive. + +## 2.406.0 +* feature: DirectoryService: This release adds support for tags during directory creation (CreateDirectory, CreateMicrosoftAd, ConnectDirectory). +* feature: EFS: Amazon EFS now supports adding tags to file system resources as part of the CreateFileSystem API . Using this capability, customers can now more easily enforce tag-based authorization for EFS file system resources. +* feature: Iot: AWS IoT - AWS IoT Device Defender adds support for configuring behaviors in a security profile with statistical thresholds. Device Defender also adds support for configuring multiple data-point evaluations before a violation is either created or cleared. +* feature: SSM: AWS Systems Manager now supports adding tags when creating Activations, Patch Baselines, Documents, Parameters, and Maintenance Windows + +## 2.405.0 +* feature: Athena: This release adds support for Workgroups to Amazon Athena. Use Workgroups to isolate users, teams, applications or workloads in the same account, control costs by setting up query limits and creating Amazon SNS alarms, and publish query-related metrics to Amazon CloudWatch. +* feature: SecretsManager: This release increases the maximum allowed size of SecretString or SecretBinary from 4KB to 7KB in the CreateSecret, UpdateSecret, PutSecretValue and GetSecretValue APIs. + +## 2.404.0 +* feature: ApplicationAutoScaling: Documentation updates for Application Auto Scaling +* feature: Iot: In this release, IoT Device Defender introduces support for tagging Scheduled Audit resources. + +## 2.403.0 +* feature: EC2: This release adds tagging and ARN support for AWS Client VPN Endpoints.You can now run bare metal workloads on EC2 M5 and M5d instances. m5.metal and m5d.metal instances are powered by custom Intel Xeon Scalable Processors with a sustained all core frequency of up to 3.1 GHz. m5.metal and m5d.metal offer 96 vCPUs and 384 GiB of memory. With m5d.metal, you also have access to 3.6 TB of NVMe SSD-backed instance storage. m5.metal and m5d.metal instances deliver 25 Gbps of aggregate network bandwidth using Elastic Network Adapter (ENA)-based Enhanced Networking, as well as 14 Gbps of bandwidth to EBS.You can now run bare metal workloads on EC2 z1d instances. z1d.metal instances are powered by custom Intel Xeon Scalable Processors with a sustained all core frequency of up to 4.0 GHz. z1d.metal offers 48 vCPUs, 384 GiB of memory, and 1.8 TB of NVMe SSD-backed instance storage. z1d.metal instances deliver 25 Gbps of aggregate network bandwidth using Elastic Network Adapter (ENA)-based Enhanced Networking, as well as 14 Gbps of bandwidth to EBS. +* feature: KinesisVideo: Adds support for Tag-On-Create for Kinesis Video Streams. A list of tags associated with the stream can be created at the same time as the stream creation. + +## 2.402.0 +* feature: EFS: Customers can now use the EFS Infrequent Access (IA) storage class to more cost-effectively store larger amounts of data in their file systems. EFS IA is cost-optimized storage for files that are not accessed every day. You can create a new file system and enable Lifecycle Management to automatically move files that have not been accessed for 30 days from the Standard storage class to the IA storage class. +* feature: MediaTailor: This release adds support for tagging AWS Elemental MediaTailor resources. +* feature: Rekognition: GetContentModeration now returns the version of the moderation detection model used to detect unsafe content. + +## 2.401.0 +* feature: AppStream: This update enables customers to find the start time, max expiration time, and connection status associated with AppStream streaming session. +* feature: CodeBuild: Add customized webhook filter support +* feature: MediaPackage: Adds optional configuration for DASH to compact the manifest by combining duplicate SegmentTemplate tags. Adds optional configuration for DASH SegmentTemplate format to refer to segments by "Number" (default) or by "Time". + +## 2.400.0 +* feature: DLM: This release is to correct the timestamp format to ISO8601 for the DateCreated and DateModified files in the GetLifecyclePolicy response object. +* feature: ECS: Amazon ECS introduces the PutAccountSettingDefault API, an API that allows a user to set the default ARN/ID format opt-in status for all the roles and users in the account. Previously, setting the account's default opt-in status required the use of the root user with the PutAccountSetting API. + +## 2.399.0 +* feature: ES: Feature: Support for three Availability Zone deployments +* feature: GameLift: This release delivers a new API action for deleting unused matchmaking rule sets. More details are available at https://aws.amazon.com/releasenotes/?tag=releasenotes%23keywords%23amazon-gamelift. +* feature: MediaLive: This release adds tagging of channels, inputs, and input security groups. +* feature: RoboMaker: Added support for tagging and tag-based access control for AWS RoboMaker resources. Also, DescribeSimulationJob now includes a new failureReason field to help debug simulation job failures + +## 2.398.0 +* feature: EC2: Add Linux with SQL Server Standard, Linux with SQL Server Web, and Linux with SQL Server Enterprise to the list of allowed instance platforms for On-Demand Capacity Reservations. +* feature: FSx: New optional ExportPath parameter added to the CreateFileSystemLustreConfiguration object for user-defined export paths. Used with the CreateFileSystem action when creating an Amazon FSx for Lustre file system. + +## 2.397.0 +* feature: EC2: ec2.DescribeVpcPeeringConnections pagination support +* feature: Shield: The DescribeProtection request now accepts resource ARN as valid parameter. + +## 2.396.0 +* feature: CodeCommit: This release supports a more graceful handling of the error case when a repository is not associated with a pull request ID in a merge request in AWS CodeCommit. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces support for GPU workloads by enabling you to create clusters with GPU-enabled container instances. +* feature: WorkSpaces: This release sets ClientProperties as a required parameter. + +## 2.395.0 +* feature: CodeCommit: The PutFile API will now throw new exception FilePathConflictsWithSubmodulePathException when a submodule exists at the input file path; PutFile API will also throw FolderContentSizeLimitExceededException when the total size of any folder on the path exceeds the limit as a result of the operation. +* feature: DeviceFarm: Introduces a new rule in Device Pools - "Availability". Customers can now ensure they pick devices that are available (i.e., not being used by other customers). +* feature: MediaConnect: This release adds support for tagging, untagging, and listing tags for existing AWS Elemental MediaConnect resources. +* feature: MediaLive: This release adds support for Frame Capture output groups and for I-frame only manifests (playlists) in HLS output groups. + +## 2.394.0 +* feature: CodeBuild: This release adds support for cross-account ECR images and private registry authentication. +* feature: ECR: Amazon ECR updated the default endpoint URL to support AWS Private Link. +* feature: ELBv2: Elastic Load Balancing now supports TLS termination on Network Load Balancers. With this launch, you can offload the decryption/encryption of TLS traffic from your application servers to the Network Load Balancer. This enables you to run your backend servers optimally and keep your workloads secure. Additionally, Network Load Balancers preserve the source IP of the clients to the back-end applications, while terminating TLS on the load balancer. When TLS is enabled on an NLB, Access Logs can be enabled for the load balancer, and log entries will be emitted for all TLS connections. +* feature: PinpointSMSVoice: Added the ListConfigurationSets operation, which returns a list of the configuration sets that are associated with your account. +* feature: RDS: The Amazon RDS API allows you to add or remove Identity and Access Management (IAM) role associated with a specific feature name with an RDS database instance. This helps with capabilities such as invoking Lambda functions from within a trigger in the database, load data from Amazon S3 and so on + +## 2.393.0 +* bugfix: S3 managed uploader: S3 managed uploader will not uriEscape tags when doing a multi-part upload. +* feature: ACMPCA: Added TagOnCreate parameter to the CreateCertificateAuthority operation, updated the Tag regex pattern to align with AWS tagging APIs, and added RevokeCertificate limit. +* feature: ApiGatewayManagementApi: Fixes a typo in the 'max' constraint. +* feature: WorkLink: This is the initial SDK release for Amazon WorkLink. Amazon WorkLink is a fully managed, cloud-based service that enables secure, one-click access to internal websites and web apps from mobile phones. With Amazon WorkLink, employees can access internal websites as seamlessly as they access any other website. IT administrators can manage users, devices, and domains by enforcing their own security and access policies via the AWS Console or the AWS SDK. + +## 2.392.0 +* feature: AppStream: This API update includes support for tagging Stack, Fleet, and ImageBuilder resources at creation time. +* feature: DMS: Update for DMS TestConnectionSucceeds waiter +* feature: Discovery: The Application Discovery Service's import APIs allow you to import information about your on-premises servers and applications into ADS so that you can track the status of your migrations through the Migration Hub console. +* feature: FMS: This release provides support for cleaning up web ACLs during Firewall Management policy deletion. You can now enable the DeleteAllPolicyResources flag and it will delete all system-generated web ACLs. +* feature: SSM: AWS Systems Manager State Manager now supports configuration management of all AWS resources through integration with Automation. + +## 2.391.0 +* feature: EC2: Adjust EC2's available instance types. +* feature: Glue: AllocatedCapacity field is being deprecated and replaced with MaxCapacity field + +## 2.390.0 +* feature: Lightsail: This release adds functionality to the CreateDiskSnapshot API that allows users to snapshot instance root volumes. It also adds various documentation updates. +* feature: Pinpoint: This release updates the PutEvents operation. AppPackageName, AppTitle, AppVersionCode, SdkName fields will now be accepted as a part of the event when submitting events. +* feature: Rekognition: GetLabelDetection now returns bounding box information for common objects and a hierarchical taxonomy of detected labels. The version of the model used for video label detection is also returned. DetectModerationLabels now returns the version of the model used for detecting unsafe content. +* feature: credentials: make resolvedProfile cached inenumerable + +## 2.389.0 +* feature: Backup: AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing +* feature: DynamoDB: Amazon DynamoDB now integrates with AWS Backup, a centralized backup service that makes it easy for customers to configure and audit the AWS resources they want to backup, automate backup scheduling, set retention policies, and monitor all recent backup and restore activity. AWS Backup provides a fully managed, policy-based backup solution, simplifying your backup management, and helping you meet your business and regulatory backup compliance requirements. For more information, see the Amazon DynamoDB Developer Guide. + +## 2.388.0 +* feature: MediaConvert: IMF decode from a Composition Playlist for IMF specializations App #2 and App #2e; up to 99 input clippings; caption channel selection for MXF; and updated rate control for CBR jobs. Added support for acceleration in preview +* feature: StorageGateway: JoinDomain API supports two more parameters: organizational unit(OU) and domain controllers. Two new APIs are introduced: DetachVolume and AttachVolume. + +## 2.387.0 +* feature: RDSDataService: Documentation updates for RDS Data API. +* feature: client side monitoring: Add a new environmental variable AWS_ENDPOINT_DISCOVERY_ENABLED to work along with AWS_ENABLE_ENDPOINT_DISCOVERY +* feature: client side monitoring: CSM now can be enabled globally only from environment without code change + +## 2.386.0 +* feature: EC2: EC2 Spot: a) CreateFleet support for Single AvailabilityZone requests and b) support for paginated DescribeSpotInstanceRequests. +* feature: Iot: This release adds tagging support for rules of AWS IoT Rules Engine. Tags enable you to categorize your rules in different ways, for example, by purpose, owner, or environment. For more information about tagging, see AWS Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). For technical documentation, look for the tagging operations in the AWS IoT Core API reference or User Guide (https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot.html). +* feature: SageMaker: SageMaker Training Jobs now support Inter-Container traffic encryption. + +## 2.385.0 +* feature: DocDB: Amazon DocumentDB (with MongoDB compatibility) is a fast, reliable, and fully-managed database service. Amazon DocumentDB makes it easy for developers to set up, run, and scale MongoDB-compatible databases in the cloud. +* feature: Redshift: DescribeSnapshotSchedules returns a list of snapshot schedules. With this release, this API will have a list of clusters and number of clusters associated with the schedule. +* feature: s3: Improved sigv4 documentation on getSignedUrl operation + +## 2.384.0 +* feature: DeviceFarm: "This release provides support for running Appium Node.js and Appium Ruby tests on AWS Device Farm. + +## 2.383.0 +* bugfix: credentials: Make CredentialProviderChain coalesce resolvation synchronous +* bugfix: typings: update Attribute value to any for transaction operations input and output +* feature: IoTAnalytics: ListDatasetContents now has a filter to limit results by date scheduled. +* feature: MediaStoreData: enable cors to make MediaStoreData available in default browser build + +## 2.382.0 +* bugfix: CredentailProviderChain: CredentialProviderChain.resolve now coalesces calls, so that concurrent requests for a service instance which has yet to resolve credentials will not result in a stampede to assign config.credentials +* bugfix: documentation: swap abstract Yard tag for custom tags to support compatibility with google-closure-compiler +* feature: ACMPCA: This release marks the introduction of waiters in ACM PCA, which allow you to control the progression of your code based on the presence or state of certain resources. Waiters can be implemented in the DescribeCertificateAuthorityAuditReport, GetCertificate, and GetCertificateAuthorityCsr API operations. +* feature: DynamoDB: Added provisionedThroughPut exception on the request level for transaction APIs. +* feature: EC2MetadataCredentials: refresh now passes an error to callback if metadata service responds with expired credentials +* feature: PinpointSMSVoice: Configuration sets can now use Amazon SNS as an event destination. +* feature: StepFunctions: This release adds support for cost allocation tagging. You can now create, delete, and list tags for AWS Step Functions activity and state machine resources. For more information about tagging, see AWS Tagging Strategies. + +## 2.381.0 +* bugfix: S3: fix putObject using stream <1mb +* feature: CognitoIdentityServiceProvider: Amazon Cognito now has API support for updating the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. +* feature: Comprehend: This SDK release adds functionality to stop training Custom Document Classifier or Custom Entity Recognizer in Amazon Comprehend. +* feature: Firehose: Support for specifying customized s3 keys and supplying a separate prefix for failed-records +* feature: KinesisVideoMedia: enable cors to make KinesisVideoMedia available by default in browser build +* feature: MediaLive: This release provides support for ID3 tags and video quality setting for subgop_length. +* feature: TranscribeService: With this release, Amazon Transcribe now supports transcriptions from audio sources in Italian (it-IT). + +## 2.380.0 +* feature: EC2: This release adds support for specifying partition as a strategy for EC2 Placement Groups. This new strategy allows one to launch instances into partitions that do not share certain underlying hardware between partitions, to assist with building and deploying highly available replicated applications. +* feature: SageMaker: Batch Transform Jobs now supports TFRecord as a Split Type. ListCompilationJobs API action now supports SortOrder and SortBy inputs. +* feature: WAF: This release adds rule-level control for rule group. If a rule group contains a rule that blocks legitimate traffic, previously you had to override the entire rule group to COUNT in order to allow the traffic. You can now use the UpdateWebACL API to exclude specific rules within a rule group. Excluding rules changes the action for the individual rules to COUNT. Excluded rules will be recorded in the new "excludedRules" attribute of the WAF logs. +* feature: WAFRegional: This release adds rule-level control for rule group. If a rule group contains a rule that blocks legitimate traffic, previously you had to override the entire rule group to COUNT in order to allow the traffic. You can now use the UpdateWebACL API to exclude specific rules within a rule group. Excluding rules changes the action for the individual rules to COUNT. Excluded rules will be recorded in the new "excludedRules" attribute of the WAF logs. + +## 2.379.0 +* bugfix: S3: fix fo #2418, putObject with key as substring of bucket results in extra folder +* feature: ApiGatewayManagementApi: This is the initial SDK release for the Amazon API Gateway Management API, which allows you to directly manage runtime aspects of your APIs. This release makes it easy to send data directly to clients connected to your WebSocket-based APIs. +* feature: ApiGatewayV2: This is the initial SDK release for the Amazon API Gateway v2 APIs. This SDK will allow you to manage and configure APIs in Amazon API Gateway; this first release provides the capabilities that allow you to programmatically setup and manage WebSocket APIs end to end. +* feature: EC2: Client VPN, is a client-based VPN service. With Client VPN, you can securely access resources in AWS as well as access resources in on-premises from any location using OpenVPN based devices. With Client VPN, you can set network based firewall rules that can restrict access to networks based on Active Directory groups. +* feature: ElasticBeanstalk: This release adds a new resource that Elastic Beanstalk will soon support, EC2 launch template, to environment resource descriptions. + +## 2.378.0 +* feature: ECR: This release adds support for ECR repository tagging. +* feature: QuickSight: Amazon QuickSight's RegisterUser API now generates a user invitation URL when registering a user with the QuickSight identity type. This URL can then be used by the registered QuickSight user to complete the user registration process. This release also corrects some HTTP return status codes. + +## 2.377.0 +* feature: AlexaForBusiness: Released new APIs for managing private skill access to Enrolled Users. These API's are the equivalent of the A4B console for Private Skills checkbox "Available for Users". +* feature: Comprehend: enable cors + +## 2.376.0 +* feature: PinpointEmail: This release adds new operations for the Amazon Pinpoint Deliverability Dashboard. You can use the Deliverability Dashboard to view response and inbox placement metrics for the domains that you use to send email. You can also perform tests on individual email messages to determine how often your messages are delivered to the inbox on several major email providers. + +## 2.375.0 +* feature: EKS: Added support for updating kubernetes version of Amazon EKS clusters. +* feature: Glue: API Update for Glue: this update enables encryption of password inside connection objects stored in AWS Glue Data Catalog using DataCatalogEncryptionSettings. In addition, a new "HidePassword" flag is added to GetConnection and GetConnections to return connections without passwords. +* feature: Route53: You can now specify a new region, eu-north-1 (in Stockholm, Sweden), as a region for latency-based or geoproximity routing. +* feature: SageMaker: Amazon SageMaker Automatic Model Tuning now supports early stopping of training jobs. With early stopping, training jobs that are unlikely to generate good models will be automatically stopped during a Hyperparameter Tuning Job. + +## 2.374.0 +* feature: Connect: This update adds the GetContactAttributes operation to retrieve the attributes associated with a contact. +* feature: MediaStore: This release adds Delete Object Lifecycling to AWS MediaStore Containers. + +## 2.373.0 +* feature: AlexaForBusiness: Alexa for Business now allows IT administrators to create ad-hoc or scheduled usage reports, which help customers understand how Alexa is used in their workplace. To learn how to create usage reports, see https://docs.aws.amazon.com/a4b/latest/ag/creating-reports.html +* feature: DynamoDB: Add DynamoDB document client support for transaction operations +* feature: EC2: You can now launch the larger-sized P3dn.24xlarge instance that features NVIDIA Tesla V100s with double the GPU memory, 100Gbps networking and local NVMe storage. +* feature: IAM: We are making it easier for you to manage your AWS Identity and Access Management (IAM) policy permissions by enabling you to retrieve the last timestamp when an IAM entity (e.g., user, role, or a group) accessed an AWS service. This feature also allows you to audit service access for your entities. + +## 2.372.0 +* feature: CodeBuild: Support personal access tokens for GitHub source and app passwords for Bitbucket source +* feature: ELBv2: This release allows Application Load Balancers to route traffic to Lambda functions, in addition to instances and IP addresses. +* feature: MediaLive: This release enables the AWS Elemental MediaConnect input type in AWS Elemental MediaLive. This can then be used to automatically create and manage AWS Elemental MediaConnect Flow Outputs when you create a channel using those inputs. + +## 2.371.0 +* feature: CostExplorer: Add normalized unit support for both GetReservationUtilization and GetReservationCoverage API. +* feature: MQ: This release adds support for cost allocation tagging. You can now create, delete, and list tags for AmazonMQ resources. For more information about tagging, see AWS Tagging Strategies. +* feature: MediaTailor: AWS Elemental MediaTailor SDK now includes a new parameter to control the Location tag of DASH manifests. + +## 2.370.0 +* feature: Health: AWS Health API DescribeAffectedEntities operation now includes a field that returns the URL of the affected entity. +* feature: S3: S3 Inventory reports can now be generated in Parquet format by setting the Destination Format to be 'Parquet'. + +## 2.369.0 +* feature: DeviceFarm: Customers can now schedule runs without a need to create a Device Pool. They also get realtime information on public device availability. +* feature: StorageGateway: API list-local-disks returns a list of the gateway's local disks. This release adds a field DiskAttributeList to these disks. + +## 2.368.0 +* bugfix: md5: enable SDK to calculate content MD5 for more new S3 operations +* feature: S3: Fixed issue with Content-MD5 for S3 PutObjectLegalHold, PutObjectRetention and PutObjectLockConfiguration. + +## 2.367.0 +* feature: CloudWatchEvents: Support for Managed Rules (rules that are created and maintained by the AWS services in your account) is added. +* feature: ELBv2: This release allows Application Load Balancers to route traffic to Lambda functions, in addition to instances and IP addresses. +* feature: Kafka: This is the initial SDK release for Amazon Managed Streaming for Kafka (Amazon MSK). Amazon MSK is a service that you can use to easily build, monitor, and manage Apache Kafka clusters in the cloud. +* feature: Lambda: AWS Lambda now supports Lambda Layers and Ruby as a runtime. Lambda Layers are a new type of artifact that contains arbitrary code and data, and may be referenced by zero, one, or more functions at the same time. You can also now develop your AWS Lambda function code using the Ruby programming language. +* feature: S3: Fixed issue with ObjectLockRetainUntilDate in S3 PutObject +* feature: ServerlessApplicationRepository: AWS Serverless Application Repository now supports nested applications. You can nest individual applications as components of a larger application to make it easy to assemble and deploy new serverless architectures. +* feature: StepFunctions: AWS Step Functions is now integrated with eight additional AWS services: Amazon ECS, AWS Fargate, Amazon DynamoDB, Amazon SNS, Amazon SQS, AWS Batch, AWS Glue, and Amazon SageMaker. To learn more, please see https://docs.aws.amazon.com/step-functions/index.html +* feature: XRay: GetTraceSummaries - Now provides additional information regarding your application traces such as Availability Zone, Instance ID, Resource ARN details, Revision, Entry Point, Root Cause Exceptions and Root Causes for Fault, Error and Response Time. + +## 2.366.0 +* feature: AppMesh: AWS App Mesh is a service mesh that makes it easy to monitor and control communications between microservices of an application. AWS App Mesh APIs are available for preview in eu-west-1, us-east-1, us-east-2, and us-west-2 regions. +* feature: EC2: Adds the following updates: 1. You can now hibernate and resume Amazon-EBS backed instances using the StopInstances and StartInstances APIs. For more information about using this feature and supported instance types and operating systems, visit the user guide. 2. Amazon Elastic Inference accelerators are resources that you can attach to current generation EC2 instances to accelerate your deep learning inference workloads. With Amazon Elastic Inference, you can configure the right amount of inference acceleration to your deep learning application without being constrained by fixed hardware configurations and limited GPU selection. 3. AWS License Manager makes it easier to manage licenses in AWS and on premises when customers run applications using existing licenses from a variety of software vendors including Microsoft, SAP, Oracle, and IBM. +* feature: LicenseManager: AWS License Manager makes it easier to manage licenses in AWS and on premises when customers run applications using existing licenses from a variety of software vendors including Microsoft, SAP, Oracle, and IBM. AWS License Manager automatically tracks and controls license usage once administrators have created and enforced rules that emulate the terms of their licensing agreements. The capabilities of AWS License Manager are available through SDK and Tools, besides the management console and CLI. +* feature: Lightsail: This update adds the following features: 1. Copy instance and disk snapshots within the same AWS Region or from one region to another in Amazon Lightsail. 2. Export Lightsail instance and disk snapshots to Amazon Elastic Compute Cloud (Amazon EC2). 3. Create an Amazon EC2 instance from an exported Lightsail instance snapshot using AWS CloudFormation stacks. 4. Apply tags to filter your Lightsail resources, or organize your costs, or control access. +* feature: SageMaker: Amazon SageMaker now has Algorithm and Model Package entities that can be used to create Training Jobs, Hyperparameter Tuning Jobs and hosted Models. Subscribed Marketplace products can be used on SageMaker to create Training Jobs, Hyperparameter Tuning Jobs and Models. Notebook Instances and Endpoints can leverage Elastic Inference accelerator types for on-demand GPU computing. Model optimizations can be performed with Compilation Jobs. Labeling Jobs can be created and supported by a Workforce. Models can now contain up to 5 containers allowing for inference pipelines within Endpoints. Code Repositories (such as Git) can be linked with SageMaker and loaded into Notebook Instances. Network isolation is now possible on Models, Training Jobs, and Hyperparameter Tuning Jobs, which restricts inbound/outbound network calls for the container. However, containers can talk to their peers in distributed training mode within the same security group. A Public Beta Search API was added that currently supports Training Jobs. +* feature: ServiceDiscovery: AWS Cloud Map lets you define friendly names for your cloud resources so that your applications can quickly and dynamically discover them. When a resource becomes available (for example, an Amazon EC2 instance running a web server), you can register a Cloud Map service instance. Then your application can discover service instances by submitting DNS queries or API calls. + +## 2.365.0 +* feature: DynamoDB: Amazon DynamoDB now supports the following features: DynamoDB on-demand and transactions. DynamoDB on-demand is a flexible new billing option for DynamoDB capable of serving thousands of requests per second without capacity planning. DynamoDB on-demand offers simple pay-per-request pricing for read and write requests so that you only pay for what you use, making it easy to balance costs and performance. Transactions simplify the developer experience of making coordinated, all-or-nothing changes to multiple items both within and across tables. The new transactional APIs provide atomicity, consistency, isolation, and durability (ACID) in DynamoDB, helping developers support sophisticated workflows and business logic that requires adding, updating, or deleting multiple items using native, server-side transactions. For more information, see the Amazon DynamoDB Developer Guide. +* feature: FSx: Amazon FSx provides fully-managed third-party file systems optimized for a variety of enterprise and compute-intensive workloads. +* feature: RDS: Amazon Aurora Global Database. This release introduces support for Global Database, a feature that allows a single Amazon Aurora database to span multiple AWS regions. Customers can use the feature to replicate data with no impact on database performance, enable fast local reads with low latency in each region, and improve disaster recovery from region-wide outages. You can create, modify and describe an Aurora Global Database, as well as add or remove regions from your Global Database. +* feature: SecurityHub: AWS Security Hub is a security and compliance center that correlates AWS security findings and performs automated compliance checks + +## 2.364.0 +* feature: CloudWatchLogs: Six new APIs added to support CloudWatch Logs Insights. The APIs are StartQuery, StopQuery, GetQueryResults, GetLogRecord, GetLogGroupFields, and DescribeQueries. +* feature: CodeDeploy: Support for Amazon ECS service deployment - AWS CodeDeploy now supports the deployment of Amazon ECS services. An Amazon ECS deployment uses an Elastic Load Balancer, two Amazon ECS target groups, and a listener to reroute production traffic from your Amazon ECS service's original task set to a new replacement task set. The original task set is terminated when the deployment is complete. Success of a deployment can be validated using Lambda functions that are referenced by the deployment. This provides the opportunity to rollback if necessary. You can use the new ECSService, ECSTarget, and ECSTaskSet data types in the updated SDK to create or retrieve an Amazon ECS deployment. +* feature: ComprehendMedical: The first release of Comprehend Medical includes two APIs, detectPHI and detectEntities. DetectPHI extracts PHI from your clinical text, and detectEntities extracts entities such as medication, medical conditions, or anatomy. DetectEntities also extracts attributes (e.g. dosage for medication) and identifies contextual traits (e.g. negation) for each entity. +* feature: EC2: With VPC sharing, you can now allow multiple accounts in the same AWS Organization to launch their application resources, like EC2 instances, RDS databases, and Redshift clusters into shared, centrally managed VPCs. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces support for blue/green deployment feature. Customers can now update their ECS services in a blue/green deployment pattern via using AWS CodeDeploy. +* feature: KinesisAnalytics: Improvements to error messages, validations, and more to the Kinesis Data Analytics APIs. +* feature: KinesisAnalyticsV2: Amazon Kinesis Data Analytics now supports Java-based stream processing applications, in addition to the previously supported SQL. Now, you can use your own Java code in Amazon Kinesis Data Analytics to build and run stream processing applications. This new capability also comes with an update to the previous Amazon Kinesis Data Analytics APIs to enable support for different runtime environments and more. +* feature: MarketplaceMetering: RegisterUsage operation added to AWS Marketplace Metering Service, allowing sellers to meter and entitle Docker container software use with AWS Marketplace. For details on integrating Docker containers with RegisterUsage see: https://docs.aws.amazon.com/marketplace/latest/userguide/entitlement-and-metering-for-paid-products.html +* feature: MediaConnect: This is the initial release for AWS Elemental MediaConnect, an ingest and transport service for live video. This new AWS service allows broadcasters and content owners to send high-value live content into the cloud, securely transmit it to partners for distribution, and replicate it to multiple destinations around the globe. +* feature: Translate: This release includes the new custom terminology feature. Using custom terminology with your translation requests enables you to make sure that your brand names, character names, model names, and other unique content is translated exactly the way you need it, regardless of its context and the Amazon Translate algorithm's decision. See the documentation for more information. + +## 2.363.0 +* feature: EC2: Adds the following updates: 1. Transit Gateway helps easily scale connectivity across thousands of Amazon VPCs, AWS accounts, and on-premises networks. 2. Amazon EC2 A1 instance is a new Arm architecture based general purpose instance. 3. You can now launch the new Amazon EC2 compute optimized C5n instances that can utilize up to 100 Gbps of network bandwidth. +* feature: GlobalAccelerator: AWS Global Accelerator is a network layer service that helps you improve the availability and performance of the applications that you offer to your global customers. Global Accelerator uses the AWS global network to direct internet traffic from your users to your applications running in AWS Regions. Global Accelerator creates a fixed entry point for your applications through static anycast IP addresses, and routes user traffic to the optimal endpoint based on performance, application health and routing policies that you can configure. Global Accelerator supports the following features at launch: static anycast IP addresses, support for TCP and UDP, support for Network Load Balancers, Application Load Balancers and Elastic-IP address endpoints, continuous health checking, instant regional failover, fault isolating Network Zones, granular traffic controls, and client affinity. +* feature: Greengrass: Support Greengrass Connectors and allow Lambda functions to run without Greengrass containers. +* feature: IoTAnalytics: Added an optional list of dataset content delivery configuration for CreateDataset and UpdateDataset. DescribeDataset will now include the list of delivery configuration, and will be an empty array if none exist. +* feature: Iot: As part of this release, we are extending capability of AWS IoT Rules Engine to support IoT Events rule action. The IoT Events rule action lets you send messages from IoT sensors and applications to IoT Events for pattern recognition and event detection. +* feature: KMS: AWS Key Management Service (KMS) now enables customers to create and manage dedicated, single-tenant key stores in addition to the default KMS key store. These are known as custom key stores and are deployed using AWS CloudHSM clusters. Keys that are created in a KMS custom key store can be used like any other customer master key in KMS. +* feature: S3: Four new Amazon S3 Glacier features help you reduce your storage costs by making it even easier to build archival applications using the Amazon S3 Glacier storage class. S3 Object Lock enables customers to apply Write Once Read Many (WORM) protection to objects in S3 in order to prevent object deletion for a customer-defined retention period. S3 Inventory now supports fields for reporting on S3 Object Lock. "ObjectLockRetainUntilDate", "ObjectLockMode", and "ObjectLockLegalHoldStatus" are now available as valid optional fields. +* feature: SMS: In this release, AWS Server Migration Service (SMS) has added multi-server migration support to simplify the application migration process. Customers can migrate all their application-specific servers together as a single unit as opposed to moving individual server one at a time. The new functionality includes - 1. Ability to group on-premises servers into applications and application tiers. 2. Auto-generated CloudFormation Template and Stacks for launching migrated servers into EC2. 3. Ability to run post-launch configuration scripts to configure servers and applications in EC2. In order for SMS to launch servers into your AWS account using CloudFormation Templates, we have also updated the ServerMigrationServiceRole IAM policy to include appropriate permissions. Refer to Server Migration Service documentation for more details. + +## 2.362.0 +* bugfix: Config: fix useDualstack typing +* feature: Amplify: Release of AWS Amplify: Everything you need to develop & deploy cloud-powered mobile and web apps. +* feature: DataSync: AWS DataSync simplifies, automates, and accelerates moving and replicating data between on-premises storage and AWS services over the network. +* feature: RoboMaker: (New Service) AWS RoboMaker is a service that makes it easy to develop, simulate, and deploy intelligent robotics applications at scale. +* feature: S3: The INTELLIGENT_TIERING storage class is designed to optimize storage costs by automatically moving data to the most cost effective storage access tier, without performance impact or operational overhead. This SDK release provides API support for this new storage class. +* feature: Snowball: AWS announces the availability of AWS Snowball Edge Compute Optimized to run compute-intensive applications is disconnected and physically harsh environments. It comes with 52 vCPUs, 208GB memory, 8TB NVMe SSD, and 42TB S3-compatible storage to accelerate local processing and is well suited for use cases such as full motion video processing, deep IoT analytics, and continuous machine learning in bandwidth-constrained locations. It features new instances types called SBE-C instances that are available in eight sizes and multiple instances can be run on the device at the same time. Optionally, developers can choose the compute optimized device to include a GPU and use SBE-G instances for accelerating their application performance. +* feature: Transfer: AWS Transfer for SFTP is a fully managed service that enables transfer of secure data over the internet into and out of Amazon S3. SFTP is deeply embedded in data exchange workflows across different industries such as financial services, healthcare, advertising, and retail, among others. +* feature: protocol: Add support for 'endpoint' trait in API operation model + +## 2.361.0 +* feature: Rekognition: This release updates the DetectFaces and IndexFaces operation. When the Attributes input parameter is set to ALL, the face location landmarks includes 5 new landmarks: upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight, upperJawlineRight. + +## 2.360.0 +* feature: AppSync: AWS AppSync now supports: 1. Pipeline Resolvers - Enables execution of one or more operations against multiple data sources in order, on a single GraphQL field. This allows orchestration of actions by composing code into a single Resolver, or share code across Resolvers. 2. Aurora Serverless Data Source - Built-in resolver for executing GraphQL operations with the new Aurora Serverless Data API, including connection management functionality. +* feature: AutoScalingPlans: In this release, AWS Auto Scaling adds three features: 1) Predictive scaling for EC2 Auto Scaling, which analyzes your application workload history to forecast future capacity requirements, 2) an option to replace existing scaling policies that are associated with the resources in your scaling plan, and 3) an option that allows you to use predictive scaling with or without your plan's dynamic scaling feature. +* feature: CloudFront: With Origin Failover capability in CloudFront, you can setup two origins for your distributions - primary and secondary, such that your content is served from your secondary origin if CloudFront detects that your primary origin is unavailable. These origins can be any combination of AWS origins or non-AWS custom HTTP origins. For example, you can have two Amazon S3 buckets that serve as your origin that you independently upload your content to. If an object that CloudFront requests from your primary bucket is not present or if connection to your primary bucket times-out, CloudFront will request the object from your secondary bucket. So, you can configure CloudFront to trigger a failover in response to either HTTP 4xx or 5xx status codes. +* feature: CloudWatch: Amazon CloudWatch now supports alarms on metric math expressions. +* feature: DeviceFarm: Disabling device filters +* feature: MediaLive: You can now include the media playlist(s) from both pipelines in the HLS master manifest for seamless failover. +* feature: QuickSight: Amazon QuickSight is a fully managed, serverless, cloud business intelligence system that allows you to extend data and insights to every user in your organization. The first release of APIs for Amazon QuickSight introduces embedding and user/group management capabilities. The get-dashboard-embed-url API allows you to obtain an authenticated dashboard URL that can be embedded in application domains whitelisted for QuickSight dashboard embedding. User APIs allow you to programmatically expand and manage your QuickSight deployments while group APIs allow easier permissions management for resources within QuickSight. +* feature: RDSDataService: The RDS Data API Beta is available for the MySQL-compatible edition of Amazon Aurora Serverless in the US East (N. Virginia) Region. This API enables you to easily access Aurora Serverless with web services-based applications including AWS Lambda and AWS AppSync. +* feature: SSM: AWS Systems Manager Distributor helps you securely distribute and install software packages. +* feature: XRay: Groups build upon X-Ray filter expressions to allow for fine tuning trace summaries and service graph results. You can configure groups by using the AWS X-Ray console or by using the CreateGroup API. The addition of groups has extended the available request fields to the GetServiceGraph API. You can now specify a group name or group ARN to retrieve its service graph. + +## 2.359.0 +* feature: Batch: Adding multinode parallel jobs, placement group support for compute environments. +* feature: CloudFormation: Use the CAPABILITY_AUTO_EXPAND capability to create or update a stack directly from a stack template that contains macros, without first reviewing the resulting changes in a change set first. +* feature: CloudTrail: This release supports creating a trail in CloudTrail that logs events for all AWS accounts in an organization in AWS Organizations. This helps enable you to define a uniform event logging strategy for your organization. An organization trail is applied automatically to each account in the organization and cannot be modified by member accounts. To learn more, please see the AWS CloudTrail User Guide https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html +* feature: ConfigService: In this release, AWS Config adds support for aggregating the configuration data of AWS resources into multi-account and multi-region aggregators. AWS Config adds four APIs to query and retrieve aggregated resource configurations. 1) BatchGetAggregateResourceConfig, returns the current configuration items for resources that are present in your AWS Config aggregator. 2) GetAggregateDiscoveredResourceCounts, returns the resource counts across accounts and regions that are present in your AWS Config aggregator. 3) GetAggregateResourceConfig, returns current configuration item that is aggregated for your specific resource in a specific source account and region. 4) ListAggregateDiscoveredResources, accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. +* feature: DeviceFarm: Customers can now schedule runs without a need to create a Device Pool. They also get realtime information on public device availability. +* feature: EC2: Adding AvailabilityZoneId to DescribeAvailabilityZones +* feature: Iot: IoT now supports resource tagging and tag based access control for Billing Groups, Thing Groups, Thing Types, Jobs, and Security Profiles. IoT Billing Groups help you group devices to categorize and track your costs. AWS IoT Device Management also introduces three new features: 1. Dynamic thing groups. 2. Jobs dynamic rollouts. 3. Device connectivity indexing. Dynamic thing groups lets you to create a group of devices using a Fleet Indexing query. The devices in your group will be automatically added or removed when they match your specified query criteria. Jobs dynamic rollout allows you to configure an exponentially increasing rate of deployment for device updates and define failure criteria to cancel your job. Device connectivity indexing allows you to index your devices' lifecycle events to discover whether devices are connected or disconnected to AWS IoT. +* feature: Lambda: AWS Lambda now supports python3.7 and the Kinesis Data Streams (KDS) enhanced fan-out and HTTP/2 data retrieval features for Kinesis event sources. +* feature: MediaConvert: AWS Elemental MediaConvert SDK has added several features including support for: SPEKE full document encryption, up to 150 elements for input stitching, input and motion image insertion, AWS CLI path arguments in S3 links including special characters, AFD signaling, additional caption types, and client-side encrypted input files. +* feature: RDS: This release adds a new parameter to specify VPC security groups for restore from DB snapshot, restore to point int time and create read replica operations. For more information, see Amazon RDS Documentation. +* feature: WorkDocs: With this release, clients can now use the GetResources API to fetch files and folders from the user's SharedWithMe collection. And also through this release, the existing DescribeActivities API has been enhanced to support additional filters such as the ActivityType and the ResourceId. +* feature: WorkSpaces: Added new APIs to Modify and Describe WorkSpaces client properties for users in a directory. With the new APIs, you can enable/disable remember me option in WorkSpaces client for users in a directory. + +## 2.358.0 +* feature: Comprehend: Amazon Comprehend Custom Entities automatically trains entity recognition models using your entities and noun-based phrases. +* feature: CostExplorer: This release introduces a new operation called GetCostForecast operation, which allows you to programmatically access AWS Cost Explorer's forecasting engine and is now generally available. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces support for additional Docker flags as Task Definition parameters. Customers can now configure their ECS Tasks to use pidMode (pid) and ipcMode (ipc) Docker flags. +* feature: SSM: AWS Systems Manager Automation now allows you to execute and manage Automation workflows across multiple accounts and regions. +* feature: WorkSpaces: Added new Bring Your Own License (BYOL) automation APIs. With the new APIs, you can list available management CIDR ranges for dedicated tenancy, enable your account for BYOL, describe BYOL status of your account, and import BYOL images. Added new APIs to also describe and delete WorkSpaces images. + +## 2.357.0 +* feature: CodeBuild: Adding queue phase and configurable queue timeout to CodeBuild. +* feature: Comprehend: Amazon Comprehend Custom Classification automatically trains classification models using your text and custom labels. +* feature: DMS: Settings structures have been added to our DMS endpoint APIs to support Kinesis and Elasticsearch as targets. We are introducing the ability to configure custom DNS name servers on a replication instance as a beta feature. +* feature: DirectConnect: This release enables DirectConnect customers to have logical redundancy on virtual interfaces within supported DirectConnect locations. +* feature: ECS: In this release, Amazon ECS introduces multiple features. First, ECS now supports integration with Systems Manager Parameter Store for injecting runtime secrets. Second, ECS introduces support for resources tagging. Finally, ECS introduces a new ARN and ID Format for its resources, and provides new APIs for opt-in to the new formats. +* feature: IAM: We are making it easier for you to manage your AWS Identity and Access Management (IAM) resources by enabling you to add tags to your IAM principals (users and roles). Adding tags on IAM principals will enable you to write fewer policies for permissions management and make policies easier to comprehend. Additionally, tags will also make it easier for you to grant access to AWS resources. +* feature: Pinpoint: 1. With Amazon Pinpoint Voice, you can use text-to-speech technology to deliver personalized voice messages to your customers. Amazon Pinpoint Voice is a great way to deliver transactional messages -- such as one-time passwords and identity confirmations -- to customers. 2. Adding support for Campaign Event Triggers. With Campaign Event Triggers you can now schedule campaigns to execute based on incoming event data and target just the source of the event. +* feature: PinpointSMSVoice: With Amazon Pinpoint Voice, you can use text-to-speech technology to deliver personalized voice messages to your customers. Amazon Pinpoint Voice is a way to deliver transactional messages -- such as one-time passwords and appointment confirmations to customers. +* feature: RAM: This is the initial release of AWS Resource Access Manager (RAM) which provides you the ability to share your resources across AWS accounts or within your AWS Organization. You can now create resources centrally and use AWS RAM to share those resources with other accounts, eliminating the need to provision and manage resources in every account. When you share a resource with another account, that account is granted access. Any policies and permissions in that account apply to the shared resource. +* feature: RDS: Introduces DB Instance Automated Backups for the MySQL, MariaDB, PostgreSQL, Oracle and Microsoft SQL Server database engines. You can now retain Amazon RDS automated backups (system snapshots and transaction logs) when you delete a database instance. This allows you to restore a deleted database instance to a specified point in time within the backup retention period even after it has been deleted, protecting you against accidental deletion of data. For more information, see Amazon RDS Documentation. +* feature: Redshift: With this release, Redshift is providing API's for better snapshot management by supporting user defined automated snapshot schedules, retention periods for manual snapshots, and aggregate snapshot actions including batch deleting user snapshots, viewing account level snapshot storage metrics, and better filtering and sorting on the describe-cluster-snapshots API. Automated snapshots can be scheduled to be taken at a custom interval and the schedule created can be reused across clusters. Manual snapshot retention periods can be set at the cluster, snapshot, and cross-region-copy level. The retention period set on a manual snapshot indicates how many days the snapshot will be retained before being automatically deleted. +* feature: Route53Resolver: This is the first release of the Amazon Route 53 Resolver API. Customers now have the ability to create and manage Amazon Route 53 Resolver endpoints and Amazon Route 53 Resolver rules. +* feature: S3: Add support for new S3 Block Public Access bucket-level APIs. The new Block Public Access settings allow bucket owners to prevent public access to S3 data via bucket/object ACLs or bucket policies. +* feature: S3Control: Add support for new S3 Block Public Access account-level APIs. The Block Public Access settings allow account owners to prevent public access to S3 data via bucket/object ACLs or bucket policies. +* feature: TranscribeService: With this release, Amazon Transcribe now publicly supports transcriptions from audio sources in British English (en-GB), Australian English (en-AU), and Canadian French (fr-CA). Amazon Transcribe now also supports the following languages in Private beta: Germany German (de-DE), Brazil Portuguese (pt-BR), France French (fr-FR). + +## 2.356.0 +* feature: AutoScaling: EC2 Auto Scaling now allows users to provision and automatically scale instances across purchase options (Spot, On-Demand, and RIs) and instance types in a single Auto Scaling group (ASG). +* feature: EC2: Amazon EC2 Fleet now supports a new request type "Instant" that you can use to provision capacity synchronously across instance types & purchase models and CreateFleet will return the instances launched in the API response. +* feature: MediaTailor: AWS Elemental MediaTailor SDK now returns a manifest endpoint prefix for clients to initiate a DASH playback session. +* feature: ResourceGroups: The AWS Resource Groups service added support for AWS CloudFormation stack-based groups. +* feature: SNS: Added an optional request parameter, named Attributes, to the Amazon SNS CreateTopic API action. For more information, see the Amazon SNS API Reference (https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html). +* feature: SageMaker: SageMaker now makes the final set of metrics published from training jobs available in the DescribeTrainingJob results. Automatic Model Tuning now supports warm start of hyperparameter tuning jobs. Notebook instances now support a larger number of instance types to include instances from the ml.t3, ml.m5, ml.c4, ml.c5 families. +* feature: ServiceCatalog: Adds support for Cloudformation StackSets in Service Catalog + +## 2.355.0 +* feature: Chime: This release adds support in ListUsers API to filter the list by an email address. +* feature: Redshift: Amazon Redshift provides the option to defer non-mandatory maintenance updates to a later date. + +## 2.354.0 +* bugfix: Endpoint Discovery: Not to inspect environmental variables in browsers +* feature: Batch: Adding EC2 Launch Template support in AWS Batch Compute Environments. +* feature: Budgets: 1. Added budget performance history, enabling you to see how well your budgets matched your actual costs and usage. 2. Added budget performance history, notification state, and last updated time, enabling you to see how well your budgets matched your actual costs and usage, how often your budget alerts triggered, and when your budget was last updated. +* feature: CloudFormation: The Drift Detection feature enables customers to detect whether a stack's actual configuration differs, or has drifted, from its expected configuration as defined within AWS CloudFormation. +* feature: CodePipeline: Add support for cross-region pipeline with accompanying definitions as needed in the AWS CodePipeline API Guide. +* feature: Firehose: With this release, Amazon Kinesis Data Firehose allows you to enable/disable server-side encryption(SSE) for your delivery streams ensuring encryption of data at rest. For technical documentation, look at https://docs.aws.amazon.com/firehose/latest/dev/encryption.html +* feature: Polly: Amazon Polly adds new female voices: Italian - Bianca, Castilian Spanish - Lucia and new language: Mexican Spanish with new female voice - Mia. +* feature: RDS: API Update for RDS: this update enables Custom Endpoints, a new feature compatible with Aurora Mysql, Aurora PostgreSQL and Neptune that allows users to configure a customizable endpoint that will provide access to their instances in a cluster. + +## 2.353.0 +* feature: MediaPackage: As a part of SPEKE DRM encryption, MediaPackage now supports encrypted content keys. You can enable this enhanced content protection in an OriginEndpoint's encryption settings. When this is enabled, MediaPackage indicates to the key server that it requires an encrypted response. To use this, your DRM key provider must support content key encryption. For details on this feature, see the AWS MediaPackage User Guide at https://docs.aws.amazon.com/mediapackage/latest/ug/what-is.html. + +## 2.352.0 +* feature: DLM: Amazon Data Lifecycle Manager adds support for copying EBS volume tags to EBS snapshots. AWS resource tags allow customers to add metadata and apply access policies to your Amazon Elastic Block Store (Amazon EBS) resources. Starting today, customers can use Amazon Data Lifecycle Manager (DLM) to copy tags on EBS volumes to EBS snapshots. This allows customers to easily set snapshot metadata, such as access policies, to match the parent volume. Customers can enable this functionality on new or existing lifecycle policies. They can also choose to disable it at a future date. +* feature: Endpoint Discovery: Some services provide endpoint discovery operations (e.g. 'DescribeEndpoints()'). This SDK feature, if turned on, will automatically request endpoints from services if needed and cache the endpoints returned. +* feature: MediaLive: You can now switch a live channel between preconfigured inputs. This means assigned inputs for a running channel can be changed according to a defined schedule. You can also use MP4 files as inputs. + +## 2.351.0 +* feature: CostExplorer: Enable Payer Accounts to View Linked Account Recommendations. Payer Accounts can specify "LINKED" as scope in the request now. In the response, there is a new filed called AccountId in ReservationPurchaseRecommendationDetail for indicating which account is this recommendation detail belongs to. +* feature: DMS: Update the DMS TestConnectionSucceeds waiter. +* feature: EC2: VM Import/Export now supports generating encrypted EBS snapshots, as well as AMIs backed by encrypted EBS snapshots during the import process. + +## 2.350.0 +* feature: APIGateway: AWS WAF integration with APIGW. Changes for adding webAclArn as a part of Stage output. When the user calls a get-stage or get-stages, webAclArn will also be returned as a part of the output. +* feature: EC2: You can now launch the new Amazon EC2 memory optimized R5a and general purpose M5a instances families that feature AMD EPYC processors. +* feature: Pinpoint: This update adds the ability to send transactional email by using the SendMessage API. Transactional emails are emails that you send directly to specific email addresses. Unlike campaign-based email that you send from Amazon Pinpoint, you don't have to create segments and campaigns in order to send transactional email. +* feature: PinpointEmail: This is the first release of the Amazon Pinpoint Email API. You can use this API to configure and send transactional email from your Amazon Pinpoint account to specific email addresses. Unlike campaign-based email that you send from Amazon Pinpoint, you don't have to create segments and campaigns in order to send transactional email. +* feature: WAFRegional: You can now use AWS WAF to configure protections for your Amazon API Gateway APIs. This will enable you to block (or count) undesired traffic to your APIs based on the different AWS WAF rules and conditions you create. For more information about AWS WAF, see the AWS WAF Developer Guide. + +## 2.349.0 +* bugfix: ManagedUpload: add fix for #2304: handle situation of same part being sent twice +* feature: EKS: Adds waiters for ClusterActive and ClusterDeleted +* feature: ServerlessApplicationRepository: New AWS Serverless Application Repository APIs that support creating and reading a broader set of AWS CloudFormation templates, as well as enhancements to our existing APIs. + +## 2.348.0 +* feature: CloudDirectory: ListObjectParents API now supports a bool parameter IncludeAllLinksToEachParent, which if set to true, will return a ParentLinks list instead of a Parents map; BatchRead API now supports ListObjectParents operation. +* feature: Rekognition: This release updates the DetectLabels operation. Bounding boxes are now returned for certain objects, a hierarchical taxonomy is now available for labels, and you can now get the version of the detection model used for detection. + +## 2.347.0 +* feature: ServiceCatalog: Service Catalog integration with AWS Organizations, enables customers to more easily create and manage a portfolio of IT services across an organization. Administrators can now take advantage of the AWS account structure and account groupings configured in AWS Organizations to share Service Catalog Portfolios increasing agility and reducing risk. With this integration the admin user will leverage the trust relationship that exists within the accounts of the Organization to share portfolios to the entire Organization, a specific Organizational Unit or a specific Account. + +## 2.346.0 +* feature: ConfigService: With this release, AWS Config updated the ResourceType values. The updated list includes AWS Systems Manager AssociationCompliance and PatchCompliance, AWS Shield regional Protection, AWS Config ResourceCompliance, and AWS CodePipeline Pipeline. +* feature: Greengrass: Greengrass APIs now support bulk deployment operations, and APIs that list definition versions now support pagination. +* feature: MediaStoreData: The object size limit is increased from 10MB to 25MB and the content type is more permissive. + +## 2.345.0 +* feature: Chime: This is the initial release for the Amazon Chime AWS SDK. In this release, Amazon Chime adds support for administrative actions on users and accounts. API Documentation is also updated on https://docs.aws.amazon.com/chime/index.html +* feature: Credentials: httpsOptions for STS in SharedIniFileCredentials +* feature: DMS: Add waiters for TestConnectionSucceeds, EndpointDeleted, ReplicationInstanceAvailable, ReplicationInstanceDeleted, ReplicationTaskReady, ReplicationTaskStopped, ReplicationTaskRunning and ReplicationTaskDeleted. +* feature: RDS: This release adds the listener connection endpoint for SQL Server Always On to the list of fields returned when performing a describe-db-instances operation. + +## 2.344.0 +* bugfix: Core: Fixes issue where connectTimeout timers would not be cleared if a request errored out. Only affects node.js. +* feature: SSM: Compliance Severity feature release for State Manager. Users now have the ability to select compliance severity to their association in state manager console or CLI. +* feature: SageMaker: SageMaker notebook instances can now have a volume size configured. + +## 2.343.0 +* feature: EC2: As part of this release we are introducing EC2 On-Demand Capacity Reservations. With On-Demand Capacity Reservations, customers can reserve the exact EC2 capacity they need, and can keep it only for as long as they need it. + +## 2.342.0 +* feature: AlexaForBusiness: We extended the functionality of the Alexa for Business SDK, including additional support for third-party Alexa built-in devices, managing private and public skills, and conferencing setup. +* feature: CodeStar: This release lets you create projects from source code and a toolchain definition that you provide. + +## 2.341.0 +* feature: EC2: Provides customers the ability to Bring Your Own IP (BYOIP) prefix. You can bring part or all of your public IPv4 address range from your on-premises network to your AWS account. You continue to own the address range, but AWS advertises it on the internet. + +## 2.340.0 +* feature: Inspector: Finding will be decorated with ec2 related metadata +* feature: Shield: AWS Shield Advanced API introduced a new service-specific AccessDeniedException which will be thrown when accessing individual attack information without sufficient permission. + +## 2.339.0 +* feature: Configuration: cache shared ini files for later use +* feature: SSM: Rate Control feature release for State Manager. Users now have the ability to apply rate control parameters similar to run command to their association in state manager console or CLI. +* feature: WorkSpaces: Added support for PowerPro and GraphicsPro WorkSpaces bundles. + +## 2.338.0 +* feature: AppStream: This API update adds support for creating, managing, and deleting users in the AppStream 2.0 user pool. +* feature: MediaLive: This release allows you to now turn on Quality-Defined Variable Bitrate (QVBR) encoding for your AWS Elemental MediaLive channels. You can now deliver a consistently high-quality video viewing experience while reducing overall distribution bitrates by using Quality-Defined Variable Bitrate (QVBR) encoding with AWS Elemental MediaLive. QVBR is a video compression technique that automatically adjusts output bitrates to the complexity of source content and only use the bits required to maintain a defined level of quality. This means using QVBR encoding, you can save on distribution cost, while maintaining, or increasing video quality for your viewers. +* feature: Route53: This change allows customers to disable health checks. + +## 2.337.0 +* bugfix: npmignore: update npmignore to exclude unit tests from npm +* feature: CloudWatchEvents: AWS Events - AWS Organizations Support in Event-Bus Policies. This release introduces a new parameter in the PutPermission API named Condition. Using the Condition parameter, customers can allow one or more AWS Organizations to access their CloudWatch Events Event-Bus resource. + +## 2.336.0 +* feature: Glue: New Glue APIs for creating, updating, reading and deleting Data Catalog resource-based policies. +* feature: Lightsail: Adds support for Lightsail managed databases. +* feature: ResourceGroups: AWS Resource Groups service added a new feature to filter resource groups by resource-type when using the ListGroups operation. + +## 2.335.0 +* feature: RDS: This release adds a new parameter to specify the DB instance or cluster parameter group for restore from DB snapshot and restore to point int time operations. For more information, see Amazon RDS Documentation. +* feature: ServiceCatalog: AWS Service Catalog enables you to reduce administrative maintenance and end-user training while adhering to compliance and security measures. With service actions, you as the administrator can enable end users to perform operational tasks, troubleshoot issues, run approved commands, or request permissions within Service Catalog. Service actions are defined using AWS Systems Manager documents, where you have access to pre-defined actions that implement AWS best practices, such asEC2 stop and reboot, as well as the ability to define custom actions. + +## 2.334.0 +* feature: CloudTrail: The LookupEvents API now supports two new attribute keys: ReadOnly and AccessKeyId + +## 2.333.0 +* feature: Athena: 1. GetQueryExecution API changes to return statementType of a submitted Athena query. 2. GetQueryResults API changes to return the number of rows added to a table when a CTAS query is executed. +* feature: DirectConnect: This release adds support for Jumbo Frames over AWS Direct Connect. You can now set MTU value when creating new virtual interfaces. This release also includes a new API to modify MTU value of existing virtual interfaces. +* feature: EC2: You can now launch the smaller-sized G3 instance called g3s.xlarge. G3s.xlarge provides 4 vCPU, 30.5 GB RAM and a NVIDIA Tesla M60 GPU. It is ideal for remote workstations, engineering and architectural applications, and 3D visualizations and rendering for visual effects. +* feature: MediaConvert: Added Paginators for all the MediaConvert list operations +* feature: TranscribeService: With this release, Amazon Transcribe now supports transcriptions from audio sources in British English (en-UK), Australian English (en-AU), and Canadian French (fr-CA). + +## 2.332.0 +* feature: Comprehend: This release adds French, Italian, German and Portuguese language support for all existing synchronous and asynchronous APIs +* feature: ES: Amazon Elasticsearch Service now supports customer-scheduled service software updates. When new service software becomes available, you can request an update to your domain and benefit from new features more quickly. If you take no action, we update the service software automatically after a certain time frame. +* feature: TranscribeService: With this update Amazon Transcribe now supports deleting completed transcription jobs. + +## 2.331.0 +* feature: SSM: Adds StartDate, EndDate, and ScheduleTimezone to CreateMaintenanceWindow and UpdateMaintenanceWindow; Adds NextExecutionTime to GetMaintenanceWindow and DescribeMaintenanceWindows; Adds CancelMaintenanceWindowExecution, DescribeMaintenanceWindowSchedule and DescribeMaintenanceWindowsForTarget APIs. + +## 2.330.0 +* feature: IoTJobsDataPlane: We are releasing job execution timeout functionalities to customers. Device can now set and update their job execution timeout. +* feature: Iot: We are releasing job execution timeout functionalities to customers. Customer now can set job execution timeout on the job level when creating a job. + +## 2.329.0 +* feature: DirectoryService: SDK changes to create a new type of trust for active directory + +## 2.328.0 +* feature: APIGateway: Adding support for multi-value parameters in TestInvokeMethod and TestInvokeAuthorizer. +* feature: CodeBuild: Add resolved source version field in build output +* feature: SSM: Adds RejectedPatchesAction to baseline to enable stricted validation of the rejected Patches List ; Add InstalledRejected and InstallOverrideList to compliance reporting +* feature: StorageGateway: AWS Storage Gateway now enables you to specify folders and subfolders when you update your file gateway's view of your S3 objects using the Refresh Cache API. + +## 2.327.0 +* feature: SageMaker: Waiter for SageMaker Batch Transform Jobs. + +## 2.326.0 +* feature: GuardDuty: Support optional FindingPublishingFrequency parameter in CreateDetector and UpdateDetector operations, and ClientToken on Create* operations + +## 2.325.0 +* bugfix: ParameterValidation: Uri parameters are now validated to ensure they contain at least 1 character. This fixes issues with S3 where passing Key with an empty string can sometimes cause a different operation to be called. +* feature: CodeStar: This release enables tagging CodeStar Projects at creation. The CreateProject API now includes optional tags parameter. +* feature: EC2: You can now use EC2 High Memory instances with 6 TiB memory (u-6tb1.metal), 9 TiB memory (u-9tb1.metal), and 12 TiB memory (u-12tb1.metal), which are ideal for running large in-memory databases, including production deployments of SAP HANA. These instances offer 448 logical processors, where each logical processor is a hyperthread on 224 cores. These instance deliver high networking throughput and lower latency with up to 25 Gbps of aggregate network bandwidth using Elastic Network Adapter (ENA)-based Enhanced Networking. These instances are EBS-Optimized by default, and support encrypted and unencrypted EBS volumes. This instance is only available in host-tenancy. You will need an EC2 Dedicated Host for this instance type to launch an instance. + +## 2.324.0 +* feature: APIGateway: Adding support for OpenAPI 3.0 import and export. +* feature: CodeCommit: This release adds API support for getting the contents of a file, getting the contents of a folder, and for deleting a file in an AWS CodeCommit repository. +* feature: MQ: Amazon MQ supports ActiveMQ 5.15.6, in addition to 5.15.0. Automatic minor version upgrades can be toggled. Updated the documentation. + +## 2.323.0 +* feature: Glue: AWS Glue now supports data encryption at rest for ETL jobs and development endpoints. With encryption enabled, when you run ETL jobs, or development endpoints, Glue will use AWS KMS keys to write encrypted data at rest. You can also encrypt the metadata stored in the Glue Data Catalog using keys that you manage with AWS KMS. Additionally, you can use AWS KMS keys to encrypt the logs generated by crawlers and ETL jobs as well as encrypt ETL job bookmarks. Encryption settings for Glue crawlers, ETL jobs, and development endpoints can be configured using the security configurations in Glue. Glue Data Catalog encryption can be enabled via the settings for the Glue Data Catalog. +* feature: OpsWorksCM: This release introduces a new API called ExportServerEngineAttribute to Opsworks-CM. You can use this API call to export engine specific attributes like the UserData script used for unattended bootstrapping of new nodes that connect to the server. +* feature: RDS: This release includes Deletion Protection for RDS databases. + +## 2.322.0 +* feature: DirectoryService: API changes related to launch of cross account for Directory Service. +* feature: EC2: Add pagination support for ec2.describe-route-tables API. + +## 2.321.0 +* feature: Connect: This update adds the Amazon Connect Metrics API, which lets you get current metric data and historical metric data within 24 hours for the queues in your Amazon Connect instance. +* feature: RDS: Adds DB engine version requirements for option group option settings, and specifies if an option setting requires a value. + +## 2.320.0 +* feature: MediaConvert: To offer lower prices for predictable, non-urgent workloads, we propose the concept of Reserved Transcode pricing. Reserved Transcode pricing Reserved Transcoding pricing would offer the customer access to a fixed parallel processing capacity for a fixed monthly rate. This capacity would be stated in terms of number of Reserved Transcode Slots (RTSs). One RTS would be able to process one job at a time for a fixed monthly fee. + +## 2.319.0 +* feature: DirectoryService: Added CreateLogSubscription, DeleteLogSubscription, and ListLogSubscriptions APIs for Microsoft AD. Customers can now opt in to have Windows security event logs from the domain controllers forwarded to a log group in their account. +* feature: EC2: You can now launch f1.4xlarge, a new instance size within the existing f1 family which provides two Xilinx Virtex Field Programmable Arrays (FPGAs) for acceleration. FPGA acceleration provide additional performance and time sensitivity for specialized accelerated workloads such as clinical genomics and real-time video processing. F1.4xlarge instances are available in the US East (N. Virginia), US West (Oregon), GovCloud (US), and EU West (Dublin) AWS Regions. +* feature: RDS: This launch enables RDS start-db-cluster and stop-db-cluster. Stopping and starting Amazon Aurora clusters helps you manage costs for development and test environments. You can temporarily stop all the DB instances in your cluster, instead of setting up and tearing down all the DB instances each time that you use the cluster. + +## 2.318.0 +* feature: CloudWatch: Amazon CloudWatch adds the ability to request png image snapshots of metric widgets using the GetMetricWidgetImage API. +* feature: Organizations: Introducing a new exception - AccountOwnerNotVerifiedException which will be returned for InviteAccountToOrganization call for unverified accounts. +* feature: S3: S3 Cross Region Replication now allows customers to use S3 object tags to filter the scope of replication. By using S3 object tags, customers can identify individual objects for replication across AWS Regions for compliance and data protection. Cross Region Replication for S3 enables automatic and asynchronous replication of objects to another AWS Region, and with this release customers can replicate at a bucket level, prefix level or by using object tags. + +## 2.317.0 +* feature: ES: Amazon Elasticsearch Service adds support for node-to-node encryption for new domains running Elasticsearch version 6.0 and above +* feature: Rekognition: This release updates the Amazon Rekognition IndexFaces API operation. It introduces a QualityFilter parameter that allows you to automatically filter out detected faces that are deemed to be of low quality by Amazon Rekognition. The quality bar is based on a variety of common use cases. You can filter low-quality detected faces by setting QualityFilter to AUTO, which is also the default setting. To index all detected faces regardless of quality, you can specify NONE. This release also provides a MaxFaces parameter that is useful when you want to only index the most prominent and largest faces in an image and don't want to index other faces detected in the image, such as smaller faces belonging to people standing in the background. + +## 2.316.0 +* feature: CloudWatch: Amazon CloudWatch adds the ability to publish values and counts using PutMetricData +* feature: CodeBuild: Support build logs configuration. +* feature: EC2: Added support for customers to tag EC2 Dedicated Hosts on creation. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces support for additional Docker flags as Task Definition parameters. Customers can now configure their ECS Tasks to use systemControls (sysctl), pseudoTerminal (tty), and interactive (i) Docker flags. +* feature: ElastiCache: ElastiCache for Redis added support for adding and removing read-replicas from any cluster with no cluster downtime, Shard naming: ElastiCache for Redis customers have the option of allowing ElastiCache to create names for their node groups (shards) or generating their own node group names. For more information, see https:// docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_NodeGroupConfiguration.html, ShardsToRetain: When reducing the number of node groups (shards) in an ElastiCache for Redis (cluster mode enabled) you have the option of specifying which node groups to retain or which node groups to remove. For more information, see https:// docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html, ReservationARN: ReservedNode includes an ARN, ReservationARN, member which identifies the reserved node. For more information, see https:// docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ReservedCacheNode.html +* feature: ElasticTranscoder: Added support for MP2 container + +## 2.315.0 +* feature: Polly: Amazon Polly adds Mandarin Chinese language support with new female voice - "Zhiyu" + +## 2.314.0 +* bugfix: ReactNative: Fixes issue where attempting to use a Blob object as input to an operation would cause a parameter validaiton error in release mode. +* feature: Connect: This update adds the Amazon Connect Update Contact Attributes API, which lets you update contact attributes for contacts in your Amazon Connect instance. +* feature: EC2: Pagination Support for DescribeNetworkInterfaces API +* feature: FMS: This update of Amazon Fire Wall Manager adds the ability to scope down the policy as well as to get all the member accounts belonging to a certain Fire Wall Manager admin account. + +## 2.313.0 +* feature: SSM: Session Manager is a fully managed AWS Systems Manager capability that provides interactive one-click access to Amazon EC2 Linux and Windows instances. + +## 2.312.0 +* feature: CloudHSMV2: With this release, we are adding 2 new APIs. DeleteBackup deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. During this 7-day period, the backup will be in state PENDING_DELETION. Backups can be restored using the RestoreBackup API, which will move the backup from state PENDING_DELETION back to ACTIVE. +* feature: Redshift: Adding support to Redshift to change the encryption type after cluster creation completes. + +## 2.311.0 +* feature: CloudWatchLogs: * Adding a log prefix parameter for filter log events API and minor updates to the documentation +* feature: ConfigService: Adding a new field "createdBy" to the ConfigRule data model. The field is populated only if the rule is service linked i.e the rule is created by a service. The field is empty for normal rules created by customer. + +## 2.310.0 +* feature: APIGateway: Add support for Active X-Ray with API Gateway +* feature: CodeCommit: This release adds additional optional fields to the pull request APIs. +* feature: MediaConvert: This release adds support for Cost Allocation through tagging and also enables adding, editing, and removal of tags from the MediaConvert console. + +## 2.309.0 +* feature: AppStream: Added support for enabling persistent application settings for a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session. +* feature: DynamoDB: New feature for Amazon DynamoDB. +* feature: ELB: Documentation update for DescribeAccountLimits API to include classic-registered-instances. +* feature: S3: Parquet input format support added for the SelectObjectContent API + +## 2.308.0 +* feature: Rekognition: This release introduces a new API called DescribeCollection to Amazon Rekognition. You can use DescribeCollection to get information about an existing face collection. Given the ID for a face collection, DescribeCollection returns the following information: the number of faces indexed into the collection, the version of the face detection model used by the collection, the Amazon Resource Name (ARN) of the collection and the creation date/time of the collection. + +## 2.307.0 +* feature: EKS: Amazon EKS DescribeCluster API returns a platformVersion attribute which allows you to identify the features that are currently enabled for your clusters. The Amazon EKS platform version represents capabilities of the cluster control plane, such as which Kubernetes API server flags are enabled, as well as the current Kubernetes patch version. +* feature: WAF: This change includes support for the WAF FullLogging feature through which Customers will have access to all the logs of requests that are inspected by a WAF WebACL. The new APIs allow Customers to manage association of a WebACL with one or more supported "LogDestination" and redact any request fields from the logs. +* feature: WAFRegional: This change includes support for the WAF FullLogging feature through which Customers will have access to all the logs of requests that are inspected by a WAF WebACL. The new APIs allow Customers to manage association of a WebACL with one or more supported "LogDestination" and redact any request fields from the logs. + +## 2.306.0 +* feature: CodeBuild: Support multiple sources and artifacts for CodeBuild projects. +* feature: SageMaker: VolumeKmsKeyId now available in Batch Transform Job + +## 2.305.0 +* feature: CORS: add cors support for pricing API. Make Pricing client available by default in browsers SDK. +* feature: Glue: AWS Glue now supports data encryption at rest for ETL jobs and development endpoints. With encryption enabled, when you run ETL jobs, or development endpoints, Glue will use AWS KMS keys to write encrypted data at rest. You can also encrypt the metadata stored in the Glue Data Catalog using keys that you manage with AWS KMS. Additionally, you can use AWS KMS keys to encrypt the logs generated by crawlers and ETL jobs as well as encrypt ETL job bookmarks. Encryption settings for Glue crawlers, ETL jobs, and development endpoints can be configured using the security configurations in Glue. Glue Data Catalog encryption can be enabled via the settings for the Glue Data Catalog. +* feature: MediaPackage: MediaPackage now provides input redundancy. Channels have two ingest endpoints that can receive input from encoders. OriginEndpoints pick one of the inputs receiving content for playback and automatically switch to the other input if the active input stops receiving content. Refer to the User Guide (https://docs.aws.amazon.com/mediapackage/latest/ug/what-is.html) for more details on this feature. +* feature: Monitoring: Inactive code for future SDK instrumentation and telemetry. +* feature: SageMakerRuntime: SageMaker Runtime supports CustomAttributes header which allows customers provide additional information in a request for an inference submitted to a model or in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint. + +## 2.304.0 +* feature: Glue: New Glue APIs for creating, updating, reading and deleting Data Catalog resource-based policies. +* feature: XRay: Support for new APIs that enable management of sampling rules. + +## 2.303.0 +* feature: IoTAnalytics: Added new listDatasetContent API that shows you the list of dataset contents for the corresponding versions +* feature: Iot: This release adds support to create a Stream and Code signing for Amazon FreeRTOS job along with Over-the-air updates. +* feature: Signer: AWS Signer is a new feature that allows Amazon FreeRTOS (AFR) Over The Air (OTA) customers to cryptographically sign code using code-signing certificates managed by AWS Certificate Manager. + +## 2.302.0 +* feature: Glue: AWS Glue now supports data encryption at rest for ETL jobs and development endpoints. With encryption enabled, when you run ETL jobs, or development endpoints, Glue will use AWS KMS keys to write encrypted data at rest. You can also encrypt the metadata stored in the Glue Data Catalog using keys that you manage with AWS KMS. Additionally, you can use AWS KMS keys to encrypt the logs generated by crawlers and ETL jobs as well as encrypt ETL job bookmarks. Encryption settings for Glue crawlers, ETL jobs, and development endpoints can be configured using the security configurations in Glue. Glue Data Catalog encryption can be enabled via the settings for the Glue Data Catalog. + +## 2.301.0 +* feature: CloudWatchEvents: Added Fargate and NetworkConfiguration support to EcsParameters. +* feature: CognitoIdentityServiceProvider: Amazon Cognito now has API support for creating custom domains for our hosted UI for User Pools. + +## 2.300.0 +* feature: IoTAnalytics: AWS IoT Analytics announces three new features: (1) Bring Your Custom Container - import your custom authored code containers. (2) Automate Container Execution - lets you automate the execution of containers hosting custom authored analytical code or Jupyter Notebooks to perform continuous analysis. (3) Incremental Data Capture with Customizable Time Windows - enables users to perform analysis on new incremental data captured since the last analysis. +* feature: Iot: This release adds support for IoT Thing Group Indexing and Searching functionality. +* feature: LexModelBuildingService: Amazon Lex builds bot in two stages. After the first it sets status to READY_BASIC_TESTING. In this state the bot will match user inputs that exactly match the utterances configured for the bot's intents and values in the slot types. +* feature: MediaLive: Adds two APIs for working with Channel Schedules: BatchUpdateSchedule and DescribeSchedule. These APIs allow scheduling actions for SCTE-35 message insertion and for static image overlays. +* feature: Rekognition: This release introduces a new API called DescribeCollection to Amazon Rekognition. You can use DescribeCollection to get information about an existing face collection. Given the ID for a face collection, DescribeCollection returns the following information: the number of faces indexed into the collection, the version of the face detection model used by the collection, the Amazon Resource Name (ARN) of the collection and the creation date/time of the collection. + +## 2.299.0 +* feature: Snowball: Snowball job states allow customers to track the status of the Snowball job. We are launching a new Snowball job state "WithSortingFacility"! When customer returns the Snowball to AWS, the device first goes to a sorting facility before it reaches an AWS data center. Many customers have requested us to add a new state to reflect the presence of the device at the sorting facility for better tracking. Today when a customer returns the Snowball, the state first changes from "InTransitToAWS" to "WithAWS". With the addition of new state, the device will move from "InTransitToAWS" to "WithAWSSortingFacility", and then to "WithAWS". There are no other changes to the API at this time besides adding this new state. + +## 2.298.0 +* feature: EC2: Added support for T3 Instance type in EC2. To learn more about T3 instances, please see https://aws.amazon.com/ec2/instance-types/t3/ +* feature: ElasticBeanstalk: Elastic Beanstalk adds the "Privileged" field to the "CPUUtilization" type, to support enhanced health reporting in Windows environments. +* feature: RDS: Adds a paginator for the DescribeDBClusters operation. + +## 2.297.0 +* bugfix: S3: Fixes issue when making cross-region S3 calls where the object key is truncated if the key prefix matched the bucket name and path style addressing is not used. +* feature: DynamoDB: Added SSESpecification block to update-table command which allows users to modify table Server-Side Encryption. Added two new fields (SSEType and KMSMasterKeyId) to SSESpecification block used by create-table and update-table commands. Added new SSEDescription Status value UPDATING. +* feature: MediaConvert: This release fixes backward-incompatible changes from a previous release. That previous release changed non-required job settings to required, which prevented jobs and job templates from merging correctly. The current change removes validation of required settings from the SDK and instead centralizes the validation in the service API. For information on required settings, see the Resources chapter of the AWS Elemental MediaConvert API Reference https://docs.aws.amazon.com/mediaconvert/latest/apireference/resources.html + +## 2.296.0 +* feature: DAX: DAX CreateClusterRequest is updated to include IamRoleArn as a required request parameter. +* feature: SageMaker: Added an optional boolean parameter, 'DisassociateLifecycleConfig', to the UpdateNotebookInstance operation. When set to true, the lifecycle configuration associated with the notebook instance will be removed, allowing a new one to be set via a new 'LifecycleConfigName' parameter. + +## 2.295.0 +* feature: Discovery: The Application Discovery Service's Continuous Export APIs allow you to analyze your on-premises server inventory data, including system performance and network dependencies, in Amazon Athena. +* feature: EC2: The 'Attribute' parameter DescribeVolumeAttribute request has been marked as required - the API has always required this parameter, but up until now this wasn't reflected appropriately in the SDK. +* feature: MediaConvert: Added WriteSegmentTimelineInRepresentation option for Dash Outputs +* feature: Redshift: You can now resize your Amazon Redshift cluster quickly. With the new ResizeCluster action, your cluster is available for read and write operations within minutes +* feature: SSM: AWS Systems Manager Inventory now supports groups to quickly see a count of which managed instances are and arent configured to collect one or more Inventory types + +## 2.294.0 +* feature: DeviceFarm: Support for running tests in a custom environment with live logs/video streaming, full test features parity and reduction in overall test execution time. + +## 2.293.0 +* feature: AutoScaling: Add batch operations for creating/updating and deleting scheduled scaling actions. +* feature: CloudFront: Lambda@Edge Now Provides You Access to the Request Body for HTTP POST/PUT Processing. With this feature, you can now offload more origin logic to the edge and improve end-user latency. Developers typically use Web/HTML forms or Web Beacons/Bugs as a mechanism to collect data from the end users and then process that data at their origins servers. For example, if you are collecting end user behavior data through a web beacon on your website, you can use this feature to access the user behavior data and directly log it to an Amazon Kinesis Firehose endpoint from the Lambda function, thereby simplifying your origin infrastructure. +* feature: ES: Amazon Elasticsearch Service adds support for no downtime, in-place upgrade for Elasticsearch version 5.1 and above. + +## 2.292.0 +* feature: SageMaker: SageMaker updated the default endpoint URL to support Private Link via the CLI/SDK. + +## 2.291.0 +* feature: MediaConvert: This release adds support for a new rate control mode, Quality-Defined Variable Bitrate (QVBR) encoding, includes updates to optimize transcoding performance, and resolves previously reported bugs. + +## 2.290.0 +* feature: DAX: Add the SSESpecification field to CreateCluster to allow creation of clusters with server-side encryption, and add the SSEDescription field to DescribeClusters to display the status of server-side encryption for a cluster. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces support for Docker volumes and Docker volume drivers. Customers can now configure their ECS Tasks to use Docker volumes, enabling stateful and storage-intensive applications to be deployed on ECS. +* feature: RDS: Launch RDS Aurora Serverless + +## 2.289.0 +* feature: SSM: AWS Systems Manager Automation is launching two new features for Automation Execution Rate Control based on tags and customized parameter maps. With the first feature, customer can target their resources by specifying a Tag with Key/Value. With the second feature, Parameter maps rate control, customers can benefit from customization of input parameters. +* feature: SecretsManager: This release introduces a ForceDeleteWithoutRecovery parameter to the DeleteSecret API enabling customers to force the deletion of a secret without any recovery window + +## 2.288.0 +* feature: CloudWatchLogs: Documentation Update +* feature: CodeBuild: Release semantic versioning feature for CodeBuild +* feature: EC2: Amazon VPC Flow Logs adds support for delivering flow logs directly to S3 +* feature: Pinpoint: This release includes a new batch API call for Amazon Pinpoint which can be used to update endpoints and submit events. This call will accept events from clients such as mobile devices and AWS SDKs. This call will accept requests which has multiple endpoints and multiple events attached to those endpoints in a single call. This call will update the endpoints attached and will ingest events for those endpoints. The response from this call will be a multipart response per endpoint/per event submitted. +* feature: SSM: Two new filters ExecutionStage and DocumentName will be added to ListCommands so that customers will have more approaches to query their commands. + +## 2.287.0 +* bugfix: Typings: Updates typings-generator to remove unused model types. +* feature: DynamoDB: Amazon DynamoDB Point-in-time recovery (PITR) provides continuous backups of your table data. DynamoDB now supports the ability to self-restore a deleted PITR enabled table. Now, when a table with PITR enabled is deleted, a system backup is automatically created and retained for 35 days (at no additional cost). System backups allow you to restore the deleted PITR enabled table to the state it was just before the point of deletion. For more information, see the Amazon DynamoDB Developer Guide. +* feature: Health: Updates the ARN structure vended by AWS Health API. All ARNs will now include the service and type code of the associated event, as vended by DescribeEventTypes. + +## 2.286.2 +* bugfix: type: remove undefined exceptions from SubscribeToShardEventStream + +## 2.286.1 +* bugfix: react-native: Fixes issue where promise methods are undefined when using react-native 0.56.0. See [this issue](https://github.com/facebook/metro/issues/208) for more information. +* feature: Kinesis: Updates API to latest version. +* feature: Polly: Amazon Polly enables female voice Aditi to speak Hindi language +* feature: ResourceGroups: AWS Resource Groups service added a new feature to filter group resources by resource-type when using the ListGroupResources operation. +* feature: SSM: This release updates AWS Systems Manager APIs to let customers create and use service-linked roles to register and edit Maintenance Window tasks. + +## 2.285.1 +* feature: StorageGateway: AWS Storage Gateway now enables you to create stored volumes with AWS KMS support. +* feature: TranscribeService: With this update Amazon Transcribe now supports channel identification. It transcribes audio from separate channels and combines them into a single transcription. + +## 2.284.1 +* feature: Connect: This update includes the new User Management APIs and the Federation API used for SAML authentication. The User Management APIs let you create and manage users in your Amazon Connect instance programmatically. The Federation API enables authentication between AWS and your existing identity provider using tokens. +* feature: ES: Amazon Elasticsearch Service adds support for enabling Elasticsearch error logs, providing you valuable information for troubleshooting your Elasticsearch domains quickly and easily. These logs are published to the Amazon CloudWatch Logs service and can be turned on or off at will. +* feature: Iot: As part of this release we are introducing a new IoT security service, AWS IoT Device Defender, and extending capability of AWS IoT to support Step Functions rule action. The AWS IoT Device Defender is a fully managed service that helps you secure your fleet of IoT devices. For more details on this new service, go to https://aws.amazon.com/iot-device-defender. The Step Functions rule action lets you start an execution of AWS Step Functions state machine from a rule. +* feature: KMS: Added a KeyID parameter to the ListAliases operation. This parameter allows users to list only the aliases that refer to a particular AWS KMS customer master key. All other functionality remains intact. +* feature: MediaConvert: Fixes an issue with modeled timestamps being labeled with the incorrect format. + +## 2.283.1 +* feature: CloudHSMV2: This update to the AWS CloudHSM API adds copy-backup-to-region, which allows you to copy a backup of a cluster from one region to another. The copied backup can be used in the destination region to create a new AWS CloudHSM cluster as a clone of the original cluster. +* feature: DirectConnect: 1. awsDeviceV2 field is introduced for Connection/Lag/Interconnect/VirtualInterface/Bgp Objects, while deprecating the awsDevice field for Connection/Lag/Interconnect Objects. 2. region field is introduced for VirtualInterface/Location objects +* feature: Glue: Glue Development Endpoints now support association of multiple SSH public keys with a development endpoint. +* feature: Iot: get rid of documentParameters field from CreateJob API +* feature: MQ: Modified the CreateBroker, UpdateBroker, and DescribeBroker operations to support integration with Amazon CloudWatch Logs. Added a field to indicate the IP address(es) that correspond to wire-level endpoints of broker instances. While a single-instance broker has one IP address, an active/standby broker for high availability has 2 IP addresses. Added fields to indicate the time when resources were created. Updated documentation for Amazon MQ. +* feature: SageMaker: Added SecondaryStatusTransitions to DescribeTrainingJob to provide more visibility into SageMaker training job progress and lifecycle. + +## 2.282.1 +* feature: CodeBuild: Add artifacts encryptionDisabled and build encryptionKey. +* feature: EC2: This change provides the EC2/Spot customers with two new allocation strategies -- LowestN for Spot instances, and OD priority for on-demand instances. +* feature: Inspector: inspector will return ServiceTemporarilyUnavailableException when service is under stress +* feature: Redshift: When we make a new version of Amazon Redshift available, we update your cluster during its maintenance window. By selecting a maintenance track, you control whether we update your cluster with the most recent approved release, or with the previous release. The two values for maintenance track are current and trailing. If you choose the current track, your cluster is updated with the latest approved release. If you choose the trailing track, your cluster is updated with the release that was approved previously.The new API operation for managing maintenance tracks for a cluster is DescribeClusterTracks. In addition, the following API operations have new MaintenanceTrackName parameters: Cluster, PendingModifiedValues, ModifyCluster, RestoreFromClusterSnapshot, CreateCluster, Snapshot +* feature: SSM: This release updates AWS Systems Manager APIs to allow customers to attach labels to history parameter records and reference history parameter records via labels. It also adds Parameter Store integration with AWS Secrets Manager to allow referencing and retrieving AWS Secrets Manager's secrets from Parameter Store. + +## 2.281.1 +* feature: EC2: R5 is the successor to R4 in EC2's memory-optimized instance family. R5d is a variant of R5 that has local NVMe SSD. Z1d instances deliver both high compute and high memory. Z1d instances use custom Intel Xeon Scalable Processors running at up to 4.0 GHz, powered by sustained all-core Turbo Boost. They are available in 6 sizes, with up to 48 vCPUs, 384 GiB of memory, and 1.8 TB of local NVMe storage. +* feature: ECS: This release of Amazon Elastic Container Service (Amazon ECS) introduces support for private registry authentication using AWS Secrets Manager. With private registry authentication, private Docker images can be used in a task definition. +* feature: ELBv2: We are introducing two new actions in Application Load Balancer. Redirects and Fixed Response. These features will allow you to improve user experience and security posture. By using redirect actions in your Application Load Balancer, you can improve the security of your user requests and by using fixed-response, you can enhance the customer experience by displaying branded error pages during application maintenance or outages. + +## 2.280.1 +* bugfix: Serialization: fix timestamp serialization issue in querystring; Update the logic of formatting the timestamp; +* feature: CORS: make Translate service available in browser version of SDK by default +* feature: DynamoDB: With this SDK update, APIs UpdateGlobalTableSettings and DescribeGlobalTableSettings now allow consistently configuring AutoScaling settings for a DynamoDB global table. Previously, they would only allow consistently setting IOPS. Now new APIs are being released, existing APIs are being extended. + +## 2.279.1 +* feature: ConfigService: Setting internal length limits on resourceId for APIs. + +## 2.278.1 +* feature: MediaPackage: Adds support for DASH OriginEnpoints with multiple media presentation description periods triggered by presence of SCTE-35 ad markers in Channel input streams. + +## 2.277.1 +* feature: IoTAnalytics: This change allows publishing of channel/datastore size as part of the describe-channel/describe-datastore APIs. We introduce an optional boolean parameter 'includeStatistics' in the Describe request. If the user sets this parameter to true, the describe response will return the resource size and timestamp at which the size was recorded. If the parameter is set to false, the size won't be computed or returned. +* feature: serviceId: add service id to all current clients. It will be used as unique identifier for service clients + +## 2.276.1 +* bugfix: TypeScript: Updates waitFor methods to accept $waiter configuration in parameter fields. +* bugfix: Typings: Fixes incorrect typings for AWS.EventListeners. Renamed CORE field to Core. +* feature: CORS: KinesisVideo and KinesisVideoArchivedMedia support CORS. This change make the services available in browser version of SDK by default +* feature: Comprehend: This release gives customers the ability to tokenize (find word boundaries) text and for each word provide a label for the part of speech, using the DetectSyntax operation. This API is useful to analyze text for specific conditions like for example finding nouns and the correlating adjectives to understand customer feedback. +* feature: Polly: Amazon Polly adds new API for asynchronous synthesis to S3 +* feature: SageMaker: Amazon SageMaker has added the capability for customers to run fully-managed, high-throughput batch transform machine learning models with a simple API call. Batch Transform is ideal for high-throughput workloads and predictions in non-real-time scenarios where data is accumulated over a period of time for offline processing. +* feature: Snowball: AWS Snowball Edge announces the availability of Amazon EC2 compute instances that run on the device. AWS Snowball Edge is a 100-TB ruggedized device built to transfer data into and out of AWS with optional support for local Lambda-based compute functions. With this feature, developers and administrators can run their EC2-based applications on the device providing them with an end to end vertically integrated AWS experience. Designed for data pre-processing, compression, machine learning, and data collection applications, these new instances, called SBE1 instances, feature 1.8 GHz Intel Xeon D processors up to 16 vCPUs, and 32 GB of memory. The SBE1 instance type is available in four sizes and multiple instances can be run on the device at the same time. Customers can now run compute instances using the same Amazon Machine Images (AMIs) that are used in Amazon EC2. + +## 2.275.1 +* feature: AppStream: This API update adds support for sharing AppStream images across AWS accounts within the same region. +* feature: KinesisVideo: Adds support for HLS video playback of Kinesis Video streams using the KinesisVideo client by including "GET_HLS_STREAMING_SESSION_URL" as an additional APIName parameter in the GetDataEndpoint input. +* feature: KinesisVideoArchivedMedia: Adds support for HLS video playback of Kinesis Video streams by providing the GetHLSStreamingSessionURL function in the KinesisVideoArchivedMedia client. + +## 2.274.1 +* feature: AppSync: This release adds support for configuring HTTP endpoints as data sources for your AWS AppSync GraphQL API. +* feature: CodeBuild: Update CodeBuild CreateProject API - serviceRole is a required input +* feature: DLM: Amazon Data Lifecycle Manager (DLM) for EBS Snapshots provides a simple, automated way to back up data stored on Amazon EBS volumes. You can define backup and retention schedules for EBS snapshots by creating lifecycle policies based on tags. With this feature, you no longer have to rely on custom scripts to create and manage your backups. This feature is now available in the US East (N. Virginia), US West (Oregon), and Europe (Ireland) AWS regions at no additional cost. +* feature: EFS: Amazon EFS now allows you to instantly provision the throughput required for your applications independent of the amount of data stored in your file system, allowing you to optimize throughput for your applications performance needs. Starting today, you can provision the throughput your applications require quickly with a few simple steps using AWS Console, AWS CLI or AWS API to achieve consistent performance. +* feature: IAM: SDK release to support IAM delegated administrator feature. The feature lets customers attach permissions boundary to IAM principals. The IAM principals cannot operate exceeding the permission specified in permissions boundary. + +## 2.273.1 +* feature: APIGateway: Support for fine grain throttling for API gateway. +* feature: CostExplorer: Starting today, you can access custom Reserved Instance (RI) purchase recommendations for your Amazon Redshift, Amazon ElastiCache, and Amazon Elasticsearch reservations via AWS Cost Explorer API, in addition to accessing RI purchase recommendations for your Amazon EC2 and Amazon RDS reservations. +* feature: S3: S3 Select support for BZIP2 compressed input files +* feature: SSM: Support Conditional Branching OnFailure for SSM Automation + +## 2.272.1 +* feature: AppStream: This API update adds pagination to the DescribeImages API to support future features and enhancements. +* feature: CodeBuild: API changes to CodeBuild service, support report build status for Github sources +* feature: EC2: Support CpuOptions field in Launch Template data and allow Launch Template name to contain hyphen. +* feature: Glue: AWS Glue adds the ability to crawl DynamoDB tables. + +## 2.271.1 +* feature: ApplicationAutoScaling: The release adds support for custom resource auto scaling. +* feature: CostExplorer: AWS Cost Explorer provides you with Reserved Instance (RI) purchase recommendations based on your total cross-account Amazon EC2 and Amazon RDS usage. Starting today, linked accounts can also access custom RI purchase recommendations for specific linked accounts directly via AWS Cost Explorer API. +* feature: DMS: Added support for DmsTransfer endpoint type and support for re-validate option in table reload API. +* feature: Lambda: Add support for .NET Core 2.1 to Lambda. +* feature: TranscribeService: You can now specify an Amazon S3 output bucket to store the transcription of your audio file when you call the StartTranscriptionJob operation. + +## 2.270.1 +* feature: MediaConvert: This release adds support for the following 1) users can specify tags to be attached to queues, presets, and templates during creation of those resources on MediaConvert. 2) users can now view the count of jobs in submitted state and in progressing state on a per queue basis. +* feature: ServerlessApplicationRepository: Added required fields and documentation updates for AWS Serverless Application Repository. + +## 2.269.1 +* bugfix: browser: Fixed an issue with the browser XML parser logic where the incorrect value may be returned if a complex shape (map, structure) had an immediate child and a nested descendant with the same tag name. +* feature: CORS: The SecretsManager service supports CORS. This change adds the service to the browser version of the SDK by default. +* feature: Pinpoint: This release of the Amazon Pinpoint SDK adds the ability to create complex segments and validate phone numbers for SMS messages. It also adds the ability to get or delete endpoints based on user IDs, remove attributes from endpoints, and list the defined channels for an app. +* feature: SageMaker: Amazon SageMaker NotebookInstances supports 'Updating' as a NotebookInstanceStatus. In addition, DescribeEndpointOutput now includes Docker repository digest of deployed Model images. + +## 2.268.1 +* feature: ACM: Adds a "CertificateValidated" waiter to AWS Certificate Manager clients, which polls on a new certificate's validation state. +* feature: EC2: Added support for customers to tag EC2 Dedicated Hosts +* feature: Redshift: Feature 1 - On-demand cluster release version - When Amazon Redshift releases a new cluster version, you can choose to upgrade to that version immediately instead of waiting until your next maintenance window. You can also choose to roll back to a previous version. The two new APIs added for managing cluster release version are - ModifyClusterDbRevision, DescribeClusterDbRevisions. Feature 2 - Upgradeable reserved instance - You can now exchange one Reserved Instance for a new Reserved Instance with no changes to the terms of your existing Reserved Instance (term, payment type, or number of nodes). The two new APIs added for managing these upgrades are - AcceptReservedNodeExchange, GetReservedNodeExchangeOfferings. + +## 2.267.1 +* feature: SSM: Execution History and StartAssociationOnce release for State Manager. Users now have the ability to view association execution history with DescribeAssociationExecutions and DescribeAssociationExecutionTargets. Users can also execute an association by calling StartAssociationOnce. + +## 2.266.1 +* feature: ElasticBeanstalk: Elastic Beanstalk adds "Suspended" health status to the EnvironmentHealthStatus enum type and updates document. +* feature: Lambda: Support for SQS as an event source. +* feature: StorageGateway: AWS Storage Gateway now enables you to use Server Message Block (SMB) protocol to store and access objects in Amazon Simple Storage Service (S3). + +## 2.265.1 +* feature: CloudFront: Unpublish delete-service-linked-role API. +* feature: CodePipeline: UpdatePipeline may now throw a LimitExceededException when adding or updating Source Actions that use periodic checks for change detection +* feature: Comprehend: This release gives customers the option to batch process a set of documents stored within an S3 bucket in addition to the existing synchronous nature of the current Comprehend API. + +## 2.264.1 +* feature: Inspector: Introduce four new APIs to view and preview Exclusions. Exclusions show which intended security checks are excluded from an assessment, along with reasons and recommendations to fix. The APIs are CreateExclusionsPreview, GetExclusionsPreview, ListExclusions, and DescribeExclusions. +* feature: S3: Add AllowQuotedRecordDelimiter to Amazon S3 Select API. Please refer to https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html for usage details. +* feature: SecretsManager: This release adds support for resource-based policies that attach directly to your secrets. These policies provide an additional way to control who can access your secrets and what they can do with them. For more information, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html in the Secrets Manager User Guide. + +## 2.263.1 +* feature: AlexaForBusiness: Introduce DeviceNotRegisteredException for AWSMoneypenny +* feature: AppStream: This API update enables customers to find their VPC private IP address and ENI ID associated with AppStream streaming sessions. + +## 2.262.1 +* feature: CloudDirectory: SDK release to support Flexible Schema initiative being carried out by Amazon Cloud Directory. This feature lets customers using new capabilities like: variant typed attributes, dynamic facets and AWS managed Cloud Directory schemas. + +## 2.261.1 +* feature: Macie: Amazon Macie is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. With this release, we are launching the following Macie HTTPS API operations: AssociateMemberAccount, AssociateS3Resources, DisassociateMemberAccount, DisassociateS3Resources, ListMemberAccounts, ListS3Resources, and UpdateS3Resources. With these API operations you can issue HTTPS requests directly to the service. +* feature: Neptune: Deprecates the PubliclyAccessible parameter that is not supported by Amazon Neptune. +* feature: SSM: Adds Amazon Linux 2 support to Patch Manager + +## 2.260.1 +* feature: ACMPCA: CA Restore is a new feature within AWS Certificate Manager Private Certificate Authority (ACM PCA) that allows you to restore a private certificate authority that has been deleted. When you issue the DeleteCertificateAuthority call, you can now specify the number of days (7-30, with 30 being the default) in which the private certificate authority will remain in the DELETED state. During this time, the private certificate authority can be restored with the RestoreCertificateAuthority API call and then be returned to the PENDING_CERTIFICATE or DISABLED state, depending upon the state prior to deletion. Summary of API Changes: 1). Added RestoreCertificateAuthority API call; 2). Added optional PermanentDeletionTimeInDays parameter to DeleteCertificateAuthority API call. If this parameter is not specified, the DeleteCertificateAuthority API call will use a 30 day restore period as default. +* feature: MediaLive: AWS Elemental MediaLive now makes Reserved Outputs and Inputs available through the AWS Management Console and API. You can reserve outputs and inputs with a 12 month commitment in exchange for discounted hourly rates. Pricing is available at https://aws.amazon.com/medialive/pricing/ +* feature: RDS: This release adds a new parameter to specify the retention period for Performance Insights data for RDS instances. You can either choose 7 days (default) or 731 days. For more information, see Amazon RDS Documentation. + +## 2.259.1 +* bugfix: S3: Fixes edge case where event message lengths were sometimes incorrectly calculated. +* feature: MediaConvert: This release adds language code support according to the ISO-639-3 standard. Custom 3-character language codes are now supported on input and output for both audio and captions. + +## 2.258.1 +* bugfix: Core: Updates SDK to attempt to determine the Content-Length of a payload when an operation uses the unsigned-body trait. Content-Length will still not be calculated for non-file streams. This will allow file streams to be passed to MediaStoreData.putObject. +* feature: APIGateway: Support for PRIVATE endpoint configuration type +* feature: DynamoDB: Added two new fields SSEType and KMSMasterKeyArn to SSEDescription block in describe-table output. +* feature: IoTAnalytics: With this release, AWS IoT Analytics allows you to tag resources. Tags are metadata that you can create and use to manage your IoT Analytics resources. For more information about tagging, see AWS Tagging Strategies. For technical documentation, look for the tagging operations in the AWS IoT Analytics API reference or User Guide. + +## 2.257.1 +* feature: SSM: Added support for new parameter, CloudWatchOutputConfig, for SendCommand API. Users can now have RunCommand output sent to CloudWatchLogs. +* feature: ServiceCatalog: Introduced new length limitations for few of the product fields. + +## 2.256.1 +* feature: DeviceFarm: Adding VPCEndpoint support for Remote access. Allows customers to be able to access their private endpoints/services running in their VPC during remote access. +* feature: ECS: Introduces daemon scheduling capability to deploy one task per instance on selected instances in a cluster. Adds a "force" flag to the DeleteService API to delete a service without requiring to scale down the number of tasks to zero. +* feature: S3: Adds support for S3 Select. + +## 2.255.1 +* feature: CloudDirectory: Amazon Cloud Directory now supports optional attributes on Typed Links, giving users the ability to associate and manage data on Typed Links. +* feature: StorageGateway: AWS Storage Gateway now enables you to create cached volumes and tapes with AWS KMS support. + +## 2.254.1 +* feature: MediaTailor: Fixes a bug in the request URIs for MediaTailor PlaybackConfiguration operations. + +## 2.253.1 +* feature: MediaLive: AWS Elemental MediaLive now makes channel log information available through Amazon CloudWatch Logs. You can set up each MediaLive channel with a logging level; when the channel is run, logs will automatically be published to your account on Amazon CloudWatch Logs + +## 2.252.1 +* feature: CostExplorer: Cost Explorer API is providing programmatic access to RI saving metrics to enable customers to optimize their reservations. +* feature: Polly: Amazon Polly adds new French voice - "Lea" +* feature: RDS: This release adds customizable processor features for RDS instances. +* feature: Shield: DDoS Response Team access management for AWS Shield + +## 2.251.1 +* feature: AppStream: Amazon AppStream 2.0 adds support for Google Drive for G Suite. With this feature, customers will be able to connect their G Suite accounts with AppStream 2.0 and enable Google Drive access for an AppStream 2.0 stack. Users of the stack can then link their Google Drive using their G Suite login credentials and use their existing files stored in Drive with their AppStream 2.0 applications. File changes will be synced automatically to Google cloud. +* feature: EC2: You are now able to use instance storage (up to 3600 GB of NVMe based SSD) on M5 instances, the next generation of EC2's General Purpose instances in us-east-1, us-west-2, us-east-2, eu-west-1 and ca-central-1. M5 instances offer up to 96 vCPUs, 384 GiB of DDR4 instance memory, 25 Gbps in Network bandwidth and improved EBS and Networking bandwidth on smaller instance sizes and provide a balance of compute, memory and network resources for many applications. +* feature: EKS: Amazon Elastic Container Service for Kubernetes (Amazon EKS) is a fully managed service that makes it easy to deploy, manage, and scale containerized applications using Kubernetes on AWS. Amazon EKS runs the Kubernetes control plane for you across multiple AWS availability zones to eliminate a single point of failure. Amazon EKS is certified Kubernetes conformant so you can use existing tooling and plugins from partners and the Kubernetes community. Applications running on any standard Kubernetes environment are fully compatible and can be easily migrated to Amazon EKS. +* feature: MediaConvert: This release adds the support for Common Media Application Format (CMAF) fragmented outputs, RF64 WAV audio output format, and HEV1 or HEVC1 MP4 packaging types when using HEVC in DASH or CMAF outputs. +* feature: SageMaker: Amazon SageMaker has added the ability to run hyperparameter tuning jobs. A hyperparameter tuning job will create and evaluate multiple training jobs while tuning algorithm hyperparameters, to optimize a customer specified objective metric. + +## 2.250.1 +* feature: DirectoryService: Added ResetUserPassword API. Customers can now reset their users' passwords without providing the old passwords in Simple AD and Microsoft AD. +* feature: Iot: We are releasing force CancelJob and CancelJobExecution functionalities to customers. +* feature: MediaTailor: AWS Elemental MediaTailor is a personalization and monetization service that allows scalable server-side ad insertion. The service enables you to serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. This SDK allows user access to the AWS Elemental MediaTailor configuration interface. +* feature: SNS: The SNS Subscribe API has been updated with two new optional parameters: Attributes and ReturnSubscriptionArn. Attributes is a map of subscription attributes which can be one or more of: FilterPolicy, DeliveryPolicy, and RawMessageDelivery. ReturnSubscriptionArn is a boolean parameter that overrides the default behavior of returning "pending confirmation" for subscriptions that require confirmation instead of returning the subscription ARN. + +## 2.249.1 +* feature: ELBv2: This release of Elastic Load Balancing introduces user authentication on Application Load Balancer. +* feature: Neptune: Amazon Neptune is a fast, reliable graph database service that makes it easy to build and run applications that work with highly connected datasets. Neptune supports popular graph models Property Graph and W3C's Resource Description Frame (RDF), and their respective query languages Apache TinkerPop Gremlin 3.3.2 and SPARQL 1.1. + +## 2.248.1 +* feature: PI: Performance Insights is a feature of Amazon Relational Database Service (RDS) that helps you quickly assess the load on your database, and determine when and where to take action. You can use the SDK to retrieve Performance Insights data and integrate your monitoring solutions. + +## 2.247.1 +* feature: AppStream: This API update enables customers to control whether users can transfer data between their local devices and their streaming applications through file uploads and downloads, clipboard operations, or printing to local devices +* feature: ConfigService: AWS Config adds support for retention period, allowing you to specify a retention period for your AWS Config configuration items. +* feature: Glue: AWS Glue now sends a delay notification to Amazon CloudWatch Events when an ETL job runs longer than the specified delay notification threshold. +* feature: Iot: We are exposing DELETION_IN_PROGRESS as a new job status in regards to the release of DeleteJob API. + +## 2.246.1 +* feature: CodeBuild: AWS CodeBuild Adds Support for Windows Builds. +* feature: RDS: This release adds CloudWatch Logs integration capabilities to RDS Aurora MySQL clusters + +## 2.245.1 +* feature: ECS: Amazon Elastic Container Service (ECS) adds service discovery for services that use host or bridged network mode. ECS can now also register instance IPs for active tasks using bridged and host networking with Route 53, making them available via DNS. +* feature: Inspector: We are launching the ability to target all EC2 instances. With this launch, resourceGroupArn is now optional for CreateAssessmentTarget and UpdateAssessmentTarget. If resourceGroupArn is not specified, all EC2 instances in the account in the AWS region are included in the assessment target. + +## 2.244.1 +* feature: CloudFormation: 1) Filtered Update for StackSet based on Accounts and Regions: This feature will allow flexibility for the customers to roll out updates on a StackSet based on specific Accounts and Regions. 2) Support for customized ExecutionRoleName: This feature will allow customers to attach ExecutionRoleName to the StackSet thus ensuring more security and controlling the behavior of any AWS resources in the target accounts. + +## 2.243.1 +* feature: Iot: We are releasing DeleteJob and DeleteJobExecution APIs to allow customer to delete resources created using AWS IoT Jobs. + +## 2.242.1 +* feature: CognitoIdentityServiceProvider: Amazon Cognito User Pools now supports federation for users to sign up and sign in with any identity provider following the OpenID Connect standard. Amazon Cognito User Pools now returns the User Pool's Amazon Resource Name (ARN) from the CreateUserPool, UpdateUserPool, and DescribeUserPool APIs. +* feature: EC2: You are now able to use instance storage (up to 1800 GB of NVMe based SSD) on C5 instances, the next generation of EC2's compute optimized instances in us-east-1, us-west-2, us-east-2, eu-west-1 and ca-central-1. C5 instances offer up to 72 vCPUs, 144 GiB of DDR4 instance memory, 25 Gbps in Network bandwidth and improved EBS and Networking bandwidth on smaller instance sizes to deliver improved performance for compute-intensive workloads.You can now run bare metal workloads on EC2 with i3.metal instances. As a new instance size belonging to the I3 instance family, i3.metal instances have the same characteristics as other instances in the family, including NVMe SSD-backed instance storage optimized for low latency, very high random I/O performance, and high sequential read throughput. I3.metal instances are powered by 2.3 GHz Intel Xeon processors, offering 36 hyper-threaded cores (72 logical processors), 512 GiB of memory, and 15.2 TB of NVMe SSD-backed instance storage. These instances deliver high networking throughput and lower latency with up to 25 Gbps of aggregate network bandwidth using Elastic Network Adapter (ENA)-based Enhanced Networking. + +## 2.241.1 +* feature: ServiceCatalog: Users can now pass a new option to ListAcceptedPortfolioShares called portfolio-share-type with a value of AWS_SERVICECATALOG in order to access Getting Started Portfolios that contain selected products representing common customer use cases. + +## 2.240.1 +* feature: ConfigService: Update ResourceType enum with values for XRay resource + +## 2.239.1 +* feature: CodeBuild: Adding support for more override fields for StartBuild API, add support for idempotency token field for StartBuild API in AWS CodeBuild. +* feature: IoT1ClickDevicesService: AWS IoT 1-Click makes it easy for customers to incorporate simple ready-to-use IoT devices into their workflows. These devices can trigger AWS Lambda functions that implement business logic. In order to build applications using AWS IoT 1-Click devices, programmers can use the AWS IoT 1-Click Devices API and the AWS IoT 1-Click Projects API. Learn more at https://aws.amazon.com/documentation/iot-1-click/ +* feature: IoT1ClickProjects: AWS IoT 1-Click makes it easy for customers to incorporate simple ready-to-use IoT devices into their workflows. These devices can trigger AWS Lambda functions that implement business logic. In order to build applications using AWS IoT 1-Click devices, programmers can use the AWS IoT 1-Click Devices API and the AWS IoT 1-Click Projects API. Learn more at https://aws.amazon.com/documentation/iot-1-click/. +* feature: XML: Replaces XMLBuilder dependency with a light-weight XML builder. + +## 2.238.1 +* feature: Firehose: With this release, Amazon Kinesis Data Firehose can convert the format of your input data from JSON to Apache Parquet or Apache ORC before storing the data in Amazon S3. Parquet and ORC are columnar data formats that save space and enable faster queries compared to row-oriented formats like JSON. + +## 2.237.1 +* feature: GameLift: AutoScaling Target Tracking scaling simplification along with StartFleetActions and StopFleetActions APIs to suspend and resume automatic scaling at will. + +## 2.236.1 +* feature: Budgets: Updating the regex for the NumericValue fields. +* feature: EC2: Enable support for latest flag with Get Console Output +* feature: RDS: Changes to support the Aurora MySQL Backtrack feature. + +## 2.235.1 +* feature: EC2: Enable support for specifying CPU options during instance launch. + +## 2.234.1 +* feature: AlexaForBusiness: This release adds the new Device status "DEREGISTERED". This release also adds DEVICE_STATUS as the new DeviceEventType. +* feature: Budgets: "With this release, customers can use AWS Budgets to monitor how much of their Amazon EC2, Amazon RDS, Amazon Redshift, and Amazon ElastiCache instance usage is covered by reservations, and receive alerts when their coverage falls below the threshold they define." +* feature: ES: This change brings support for Reserved Instances to AWS Elasticsearch. +* feature: S3: Added BytesReturned details for Progress and Stats Events for Amazon S3 Select . + +## 2.233.1 +* feature: GuardDuty: 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. + +## 2.232.1 +* feature: AppSync: This release adds support for authorizing your AWS AppSync endpoint with an OpenID Connect compliant service and also to configure your AWS AppSync endpoint to log requests to Amazon CloudWatch Logs. +* feature: CodeBuild: CodeBuild now supports CORS. The CodeBuild service is now included in the default browser version of the SDK. +* feature: ConfigService: Update ResourceType enum with values for Lambda, ElasticBeanstalk, WAF and ElasticLoadBalancing resources + +## 2.231.1 +* feature: CodePipeline: Added support for webhooks with accompanying definitions as needed in the AWS CodePipeline API Guide. +* feature: EC2: 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. +* feature: SSM: Added support for new parameter, DocumentVersion, for SendCommand API. Users can now specify version of SSM document to be executed on the target(s). + +## 2.230.1 +* feature: AlexaForBusiness: Adds ListDeviceEvents API to get a paginated list of device events (such as ConnectionStatus). This release also adds ConnectionStatus field to GetDevice and SearchDevices API. +* feature: DynamoDB: 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. +* feature: GuardDuty: You can disable the email notification when inviting GuardDuty members using the disableEmailNotification parameter in the InviteMembers operation. +* feature: Route53Domains: This release adds a SubmittedSince attribute to the ListOperations API, so you can list operations that were submitted after a specified date and time. +* feature: SageMaker: 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. +* feature: WorkSpaces: 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. + +## 2.229.1 +* feature: CodeDeploy: AWS CodeDeploy has a new exception that indicates when a GitHub token is not valid. +* feature: XRay: 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. + +## 2.228.1 +* feature: ElasticBeanstalk: Support tracking Elastic Beanstalk resources in AWS Config. + +## 2.227.1 +* feature: AutoScalingPlans: The release adds the operation UpdateScalingPlan for updating a scaling plan and the support for tag filters as an application source. +* feature: IoTAnalytics: Introducing AWS IoT Analytics SDK. AWS IoT Analytics provides advanced data analysis for AWS IoT. It allows you to collect large amounts of device data, process messages, store them, and then query the data and run sophisticated analytics to make accurate decisions in your IoT applications and machine learning use cases. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight. +* feature: Iot: Add IotAnalyticsAction which sends message data to an AWS IoT Analytics channel + +## 2.226.1 +* feature: Firehose: 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. +* feature: MediaLive: 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. + +## 2.225.1 +* feature: CodePipeline: Added new SourceRevision structure to Execution Summary with accompanying definitions as needed in the AWS CodePipeline API Guide. +* feature: CostExplorer: Starting today, you can identify opportunities for Amazon RDS cost savings using AWS Cost Explorer's API to access your Amazon RDS Reserved Instance Purchase Recommendations +* feature: DeviceFarm: Adding support for VPCEndpoint feature. Allows customers to be able to access their private endpoints/services running in their VPC during test automation. +* feature: EC2: Added support for customers to see the time at which a Dedicated Host was allocated or released. +* feature: RDS: The ModifyDBCluster operation now includes an EngineVersion parameter. You can use this to upgrade the engine for a clustered database. +* feature: SSM: Added new APIs DeleteInventory and DescribeInventoryDeletions, for customers to delete their custom inventory data. + +## 2.224.1 +* feature: DMS: Native Change Data Capture start point and task recovery support in Database Migration Service. +* feature: Glue: "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." +* feature: MediaPackage: 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. +* feature: SSM: Added TooManyUpdates exception for AddTagsToResource and RemoveTagsFromResource API +* feature: WorkMail: Amazon WorkMail adds the ability to grant users and groups with "Full Access", "Send As" and "Send on Behalf" permissions on a given mailbox. + +## 2.223.1 +* feature: CloudDirectory: 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. + +## 2.222.1 +* feature: Batch: Support for Timeout in SubmitJob and RegisterJobDefinition + +## 2.221.1 +* feature: ACM: 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. +* feature: ACMPCA: AWS Certificate Manager (ACM) Private Certificate Authority (CA) is a managed private CA service that helps you easily and securely manage the lifecycle of your private certificates. ACM Private CA provides you a highly-available private CA service without the upfront investment and ongoing maintenance costs of operating your own private CA. ACM Private CA extends ACM's certificate management capabilities to private certificates, enabling you to manage public and private certificates centrally. +* feature: CloudWatch: 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. +* feature: ConfigService: AWS Config introduces multi-account multi-region data aggregation features. Customers can create an aggregator (a new resource type) in AWS Config that collects AWS Config data from multiple source accounts and regions into an aggregator account. Customers can aggregate data from individual account(s) or an organization and multiple regions. In this release, AWS Config adds several API's for multi-account multi-region data aggregation. +* feature: FMS: This release is the initial release version for AWS Firewall Manager, a new AWS service that makes it easy for customers to centrally configure WAF rules across all their resources (ALBs and CloudFront distributions) and across accounts. +* feature: S3: 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. +* feature: SageMaker: 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. +* feature: SecretsManager: 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. +* feature: TranscribeService: Amazon Transcribe is an automatic speech recognition (ASR) service that makes it easy for developers to add speech to text capability to their applications. + +## 2.220.1 +* feature: DeviceFarm: 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. +* feature: Lambda: added nodejs8.10 as a valid runtime +* feature: Translate: This release increases the maximum size of input text to 5,000 bytes. Amazon Translate now supports automatic language detection of the input text. The translation models have been improved to increase accuracy. See the documentation for more information. + +## 2.219.1 +* feature: APIGateway: Amazon API Gateway now supports resource policies for APIs making it easier to set access controls for invoking APIs. +* feature: CloudFront: 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. +* feature: ES: This adds Amazon Cognito authentication support to Kibana. + +## 2.218.1 +* feature: Connect: Amazon Connect is a contact center as a service (CCaS) solution that offers easy, self-service configuration and enables dynamic, personal, and natural customer engagement at any scale. With this release of the Amazon Connect SDK, Outbound APIs (StartOutboundVoiceContact, StopContact) are now generally available. This release supports CTR generation for calls generated through the new APIs. Additionally IAM permissions are supported for the new APIs. + +## 2.217.1 +* bugfix: DocumentClient: Fixes a bug with the minified version of the browser SDK where sending Sets of data with the DynamoDB DocumentClient would cause an error to be returned from the service. +* feature: AlexaForBusiness: Adds operations for creating and managing address books of phone contacts for use in A4B managed shared devices. +* feature: CloudFormation: Enabling resource level permission control for StackSets APIs. Adding support for customers to use customized AdministrationRole to create security boundaries between different users. +* feature: Greengrass: Greengrass APIs now support creating Machine Learning resource types and configuring binary data as the input payload for Greengrass Lambda functions. +* feature: SSM: This Patch Manager release supports creating patch baselines for CentOS. + +## 2.216.1 +* feature: IAM: 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. +* feature: MTurk: Added a new attribute "ActionsGuarded" to QualificationRequirement: This update allows MTurk Requester customers using the AWS SDK to control which Workers can see and preview their HITs. We now support hiding HITs from unqualified Workers' search results. +* feature: STS: 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. + +## 2.215.1 +* feature: ACM: AWS Certificate Manager has added support for customers to disable Certificate Transparency logging on a per-certificate basis. + +## 2.214.1 +* feature: DynamoDB: 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. + +## 2.213.1 +* feature: AppStream: 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. +* feature: CodeBuild: Adding support for branch filtering when using webhooks with AWS CodeBuild. +* feature: ECS: 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. + +## 2.212.1 +* feature: CloudWatchEvents: Added SQS FIFO queue target support +* feature: ConfigService: AWS Config adds support for BatchGetResourceConfig API, allowing you to batch-retrieve the current state of one or more of your resources. +* feature: CostExplorer: This launch will allow customers to access their Amazon EC2 Reserved Instance (RI) purchase recommendations programmatically via the AWS Cost Explorer API. +* feature: ECS: 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. +* feature: Glue: API Updates for DevEndpoint: PublicKey is now optional for CreateDevEndpoint. The new DevEndpoint field PrivateAddress will be populated for DevEndpoints associated with a VPC. +* feature: MediaLive: 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. + +## 2.211.1 +* bugfix: dependency: Pins ieee754 to 1.1.8 to avoid timestamp issue reported in issue #1977 + +## 2.211.0 +* feature: ElasticBeanstalk: AWS Elastic Beanstalk is launching a new public API named DescribeAccountAttributes which allows customers to access account level attributes. In this release, the API will support quotas for resources such as applications, application versions, and environments. + +## 2.210.0 +* feature: Organizations: This release adds additional reason codes to improve clarity to exceptions that can occur. +* feature: Pinpoint: With this release, you can delete endpoints from your Amazon Pinpoint projects. Customers can now specify one of their leased dedicated long or short codes to send text messages. +* feature: SageMaker: This release provides support for ml.p3.xlarge instance types for notebook instances. Lifecycle configuration is now available to customize your notebook instances on start; the configuration can be reused between multiple notebooks. If a notebook instance is attached to a VPC you can now opt out of internet access that by default is provided by SageMaker. + +## 2.209.0 +* feature: ServiceDiscovery: This release adds support for custom health checks, which let you check the health of resources that aren't accessible over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. + +## 2.208.0 +* feature: CloudHSMV2: CreateCluster can now take both 8 and 17 character Subnet IDs. DeleteHsm can now take both 8 and 17 character ENI IDs. +* feature: Iot: We added new fields to the response of the following APIs. (1) describe-certificate: added new generationId, customerVersion fields (2) describe-ca-certificate: added new generationId, customerVersion and lastModifiedDate fields (3) get-policy: added generationId, creationDate and lastModifiedDate fields +* feature: Redshift: DescribeClusterSnapshotsMessage with ClusterExists flag returns snapshots of existing clusters. Else both existing and deleted cluster snapshots are returned + +## 2.207.0 +* feature: ECS: Amazon Elastic Container Service (ECS) now supports container health checks. Customers can now specify a docker container health check command and parameters in their task definition. ECS will monitor, report and take scheduling action based on the health status. +* feature: MigrationHub: Unused key LABEL removed from ResourceAttrbute +* feature: Pinpoint: With this release, you can export endpoints from your Amazon Pinpoint projects. You can export a) all of the endpoints assigned to a project or b) the subset of endpoints assigned to a segment. + +## 2.206.0 +* feature: MediaLive: Updates API to model required traits and minimum/maximum constraints. + +## 2.205.0 +* feature: CloudWatchEvents: Added BatchParameters to the PutTargets API +* feature: EC2: Added support for modifying Placement Group association of instances via ModifyInstancePlacement API. +* feature: SSM: This Inventory release supports the status message details reported by the last sync for the resource data sync API. +* feature: ServiceCatalog: This release of ServiceCatalog adds the DeleteTagOption API. +* feature: StorageGateway: AWS Storage Gateway (File) support for two new file share attributes are added. 1. Users can specify the S3 Canned ACL to use for new objects created in the file share. 2. Users can create file shares for requester-pays buckets. + +## 2.204.0 +* feature: ApplicationAutoScaling: Application Auto Scaling now supports automatic scaling of SageMaker Production Variants on an Endpoint. + +## 2.203.0 +* feature: Route53: Added support for creating LBR rules using ap-northeast-3 region. + +## 2.202.0 +* feature: AppStream: This API update is to enable customers to copy their Amazon AppStream 2.0 images within and between AWS Regions + +## 2.201.0 +* feature: CostExplorer: Added GetReservationCoverage API for retrieving reservation coverage information. + +## 2.200.0 +* feature: CodeCommit: This release adds an API for adding a file directly to an AWS CodeCommit repository without requiring a Git client. +* feature: EC2: Adds support for tagging an EBS snapshot as part of the API call that creates the EBS snapshot +* feature: ServerlessApplicationRepository: Added support for delete-application API and the ability for developers to set a homepage for their application. The homepage is a URL with more information about the application, for example the location of your GitHub repository for the application. + +## 2.199.0 +* feature: AutoScaling: Amazon EC2 Auto Scaling support for service-linked roles +* feature: WAF: The new PermissionPolicy APIs in AWS WAF Regional allow customers to attach resource-based policies to their entities. +* feature: WAFRegional: The new PermissionPolicy APIs in AWS WAF Regional allow customers to attach resource-based policies to their entities. + +## 2.198.0 +* feature: ConfigService: With this release, AWS Config updated the ConfigurationItemStatus enum values. The values prior to this update did not represent appropriate values returned by GetResourceConfigHistory. You must update your code to enumerate the new enum values so this is a breaking change. To map old properties to new properties, use the following descriptions: New discovered resource - Old property: Discovered, New property: ResourceDiscovered. Updated resource - Old property: Ok, New property: OK. Deleted resource - Old property: Deleted, New property: ResourceDeleted or ResourceDeletedNotRecorded. Not-recorded resource - Old property: N/A, New property: ResourceNotRecorded or ResourceDeletedNotRecorded. + +## 2.197.0 +* feature: RDS: Updates RDS API to indicate whether a DBEngine supports read replicas. + +## 2.196.0 +* feature: GameLift: Updates to allow Fleets to run on On-Demand or Spot instances. +* feature: MediaConvert: Nielsen ID3 tags can now be inserted into transport stream (TS) and HLS outputs. For more information on Nielsen configuration you can go to https://docs.aws.amazon.com/mediaconvert/latest/apireference/jobs.html#jobs-nielsenconfiguration + +## 2.195.0 +* feature: AppSync: AWS AppSync now supports for None Data Source, CreateApiKey now supports setting expiration on API keys, new API UpdateApiKey supports updating expiration on API keys. +* feature: LexModelBuildingService: Amazon Lex now provides the ability to export and import your Amazon Lex chatbot definition as a JSON file. + +## 2.194.0 +* feature: Route53: Added support for creating Private Hosted Zones and metric-based healthchecks in the ap-northeast-3 region for whitelisted customers. + +## 2.193.0 +* feature: CognitoIdentityServiceProvider: Support for user migration using AWS Lambda trigger. Support to obtain signing certificate for user pools. +* feature: EC2: Network interfaces now supply the following additional status of "associated" to better distinguish the current status. +* feature: GuardDuty: Added PortProbeAction information to the Action section of the port probe-type finding. +* feature: KMS: This release of AWS Key Management Service includes support for InvalidArnException in the RetireGrant API. + +## 2.192.0 +* feature: EC2: Users can now better understand the longer ID opt-in status of their account using the two new APIs DescribeAggregateIdFormat and DescribePrincipalIdFormat +* feature: LexModelBuildingService: You can now define a response for your Amazon Lex chatbot directly from the AWS console. A response consists of messages dynamically selected from a group of pre-defined messages, populated by the developer. +* feature: LexRuntime: You can now define a response for your Amazon Lex chatbot directly from the AWS console. A response consists of messages dynamically selected from a group of pre-defined messages, populated by the developer. + +## 2.191.0 +* feature: AppStream: Adds support for allowing customers to provide a redirect URL for a stack. Users will be redirected to the link provided by the admin at the end of their streaming session. +* feature: Budgets: Making budgetLimit and timePeriod optional, and updating budgets docs. +* feature: DMS: This release includes the addition of two new APIs: describe replication instance task logs and reboot instance. The first allows user to see how much storage each log for a task on a given instance is occupying. The second gives users the option to reboot the application software on the instance and force a fail over for MAZ instances to test robustness of their integration with our service. +* feature: DirectoryService: Updated the regex of some input parameters to support longer EC2 identifiers. +* feature: DynamoDB: Amazon DynamoDB now supports server-side encryption using a default service key (alias/aws/dynamodb) from the AWS Key Management Service (KMS). AWS KMS is a service that combines secure, highly available hardware and software to provide a key management system scaled for the cloud. AWS KMS is used via the AWS Management Console or APIs to centrally create encryption keys, define the policies that control how keys can be used, and audit key usage to prove they are being used correctly. For more information, see the Amazon DynamoDB Developer Guide. +* feature: GameLift: Amazon GameLift FlexMatch added the StartMatchBackfill API. This API allows developers to add new players to an existing game session using the same matchmaking rules and player data that were used to initially create the session. +* feature: MediaLive: AWS Elemental MediaLive has added support for updating channel settings for idle channels. You can now update channel name, channel outputs and output destinations, encoder settings, user role ARN, and input specifications. Channel settings can be updated in the console or with API calls. Please note that running channels need to be stopped before they can be updated. We've also deprecated the 'Reserved' field. +* feature: MediaStore: AWS Elemental MediaStore now supports per-container CORS configuration. + +## 2.190.0 +* feature: Glue: This new feature will now allow customers to add a customized json classifier. They can specify a json path to indicate the object, array or field of the json documents they'd like crawlers to inspect when they crawl json files. +* feature: SSM: This Patch Manager release supports configuring Linux repos as part of patch baselines, controlling updates of non-OS security packages and also creating patch baselines for SUSE12 +* feature: ServiceCatalog: This release of Service Catalog adds SearchProvisionedProducts API and ProvisionedProductPlan APIs. +* feature: ServiceDiscovery: This release adds support for registering CNAME record types and creating Route 53 alias records that route traffic to Amazon Elastic Load Balancers using Amazon Route 53 Auto Naming APIs. + +## 2.189.0 +* feature: Kinesis: Using ListShards a Kinesis Data Streams customer or client can get information about shards in a data stream (including meta-data for each shard) without obtaining data stream level information. +* feature: OpsWorks: AWS OpsWorks Stacks supports EBS encryption and HDD volume types. Also, a new DescribeOperatingSystems API is available, which lists all operating systems supported by OpsWorks Stacks. + +## 2.188.0 +* feature: DeviceFarm: Add InteractionMode in CreateRemoteAccessSession for DirectDeviceAccess feature. +* feature: MediaLive: Add InputSpecification to CreateChannel (specification of input attributes is used for channel sizing and affects pricing); add NotFoundException to DeleteInputSecurityGroups. + +## 2.187.0 +* feature: AlexaForBusiness: Supports new field for DeviceStatusInfo which provides details about the DeviceStatus following a DeviceSync operation. +* feature: CodeBuild: Adding support for Shallow Clone and GitHub Enterprise in AWS CodeBuild. +* feature: GuardDuty: Added the missing AccessKeyDetails object to the resource shape. +* feature: Lambda: AWS Lambda now supports Revision ID on your function versions and aliases, to track and apply conditional updates when you are updating your function version or alias resources. +* feature: MetadataService: Allow environmental disabling of the AWS.MetadataService client by setting the AWS_EC2_METADATA_DISABLED environment variable to a truthy value. + +## 2.186.0 +* feature: Budgets: Add additional costTypes: IncludeDiscount, UseAmortized, to support finer control for different charges included in a cost budget. + +## 2.185.0 +* feature: Glue: New AWS Glue DataCatalog APIs to manage table versions and a new feature to skip archiving of the old table version when updating table. +* feature: TranscribeService: Amazon Transcribe Public Preview Release + +## 2.184.0 +* feature: SageMaker: CreateTrainingJob and CreateEndpointConfig now supports KMS Key for volume encryption. + +## 2.183.0 +* feature: ApplicationAutoScaling: Application Auto Scaling is adding support for Target Tracking Scaling for ECS services. +* feature: AutoScalingPlans: AWS Auto Scaling enables you to quickly discover all of the scalable resources underlying your application and set up application scaling in minutes using built-in scaling recommendations. +* feature: RDS: With this release you can now integrate RDS DB instances with CloudWatch Logs. We have added parameters to the operations for creating and modifying DB instances (for example CreateDBInstance) to allow you to take advantage of this capability through the CLI and API. Once you enable this feature, a stream of log events will publish to CloudWatch Logs for each log type you enable. + +## 2.182.0 +* feature: Lambda: Support for creating Lambda Functions using 'dotnetcore2.0' and 'go1.x'. + +## 2.181.0 +* feature: Glue: Support is added to generate ETL scripts in Scala which can now be run by AWS Glue ETL jobs. In addition, the trigger API now supports firing when any conditions are met (in addition to all conditions). Also, jobs can be triggered based on a "failed" or "stopped" job run (in addition to a "succeeded" job run). + +## 2.180.0 +* feature: ELB: Added OperationNotPermittedException to indicate that you cannot create a classic load balancer while deleting the Elastic Load Balancing service-linked role. +* feature: ELBv2: Added OperationNotPermittedException to indicate that you cannot create a load balancer while deleting the Elastic Load Balancing service-linked role. +* feature: RDS: Read Replicas for Amazon RDS for MySQL, MariaDB, and PostgreSQL now support Multi-AZ deployments.Amazon RDS Read Replicas enable you to create one or more read-only copies of your database instance within the same AWS Region or in a different AWS Region. Updates made to the source database are asynchronously copied to the Read Replicas. In addition to providing scalability for read-heavy workloads, you can choose to promote a Read Replica to become standalone a DB instance when needed.Amazon RDS Multi-AZ Deployments provide enhanced availability for database instances within a single AWS Region. With Multi-AZ, your data is synchronously replicated to a standby in a different Availability Zone (AZ). In case of an infrastructure failure, Amazon RDS performs an automatic failover to the standby, minimizing disruption to your applications.You can now combine Read Replicas with Multi-AZ as part of a disaster recovery strategy for your production databases. A well-designed and tested plan is critical for maintaining business continuity after a disaster. Since Read Replicas can also be created in different regions than the source database, your Read Replica can be promoted to become the new production database in case of a regional disruption.You can also combine Read Replicas with Multi-AZ for your database engine upgrade process. You can create a Read Replica of your production database instance and upgrade it to a new database engine version. When the upgrade is complete, you can stop applications, promote the Read Replica to a standalone database instance and switch over your applications. Since the database instance is already a Multi-AZ deployment, no additional steps are needed.For more information, see the Amazon RDS User Guide. + +## 2.179.0 +* feature: DirectoryService: On October 24 we introduced AWS Directory Service for Microsoft Active Directory (Standard Edition), also known as AWS Microsoft AD (Standard Edition), which is a managed Microsoft Active Directory (AD) that is optimized for small and midsize businesses (SMBs). With this SDK release, you can now create an AWS Microsoft AD directory using API. This enables you to run typical SMB workloads using a cost-effective, highly available, and managed Microsoft AD in the AWS Cloud. + +## 2.178.0 +* feature: CodeDeploy: The AWS CodeDeploy API was updated to support DeleteGitHubAccountToken, a new method that deletes a GitHub account connection. +* feature: Route53: This release adds an exception to the CreateTrafficPolicyVersion API operation. + +## 2.177.0 +* feature: Inspector: Added 2 new attributes to the DescribeAssessmentTemplate response, indicating the total number of assessment runs and last assessment run ARN (if present.) + +## 2.176.0 +* feature: WorkSpaces: Modify WorkSpaces have been updated with flexible storage and switching of hardware bundles feature. The following configurations have been added to ModifyWorkSpacesProperties: storage and compute. This update provides the capability to configure the storage of a WorkSpace. It also adds the capability of switching hardware bundle of a WorkSpace by specifying an eligible compute (Value, Standard, Performance, Power). + +## 2.175.0 +* feature: EC2: This release fixes an issue with tags not showing in DescribeAddresses responses. +* feature: ECS: Amazon ECS users can now set a health check initialization wait period of their ECS services, the services that are associated with an Elastic Load Balancer (ELB) will wait for a period of time before the ELB become healthy. You can now configure this in Create and Update Service. +* feature: Inspector: PreviewAgents API now returns additional fields within the AgentPreview data type. The API now shows the agent health and availability status for all instances included in the assessment target. This allows users to check the health status of Inspector Agents before running an assessment. In addition, it shows the instance ID, hostname, and IP address of the targeted instances. +* feature: SageMaker: SageMaker Models no longer support SupplementalContainers. API's that have been affected are CreateModel and DescribeModel. + +## 2.174.0 +* feature: CodeBuild: Adding support allowing AWS CodeBuild customers to select specific curated image versions. +* feature: EC2: Elastic IP tagging enables you to add key and value metadata to your Elastic IPs so that you can search, filter, and organize them according to your organization's needs. +* feature: KinesisAnalytics: Kinesis Analytics now supports AWS Lambda functions as output. + +## 2.173.0 +* feature: ConfigService: Update ResourceType enum with values for WAF, WAFRegional, and CloudFront resources +* feature: Iot: This release adds support for code signed Over-the-air update functionality for Amazon FreeRTOS. Users can now create and schedule Over-the-air updates to their Amazon FreeRTOS devices using these new APIs. + +## 2.172.0 +* feature: APIGateway: API Gateway now adds support for calling API with compressed payloads using one of the supported content codings, tagging an API stage for cost allocation, and returning API keys from a custom authorizer for use with a usage plan. +* feature: Route53: Route 53 added support for a new China (Ningxia) region, cn-northwest-1. You can now specify cn-northwest-1 as the region for latency-based or geoproximity routing. Route 53 also added support for a new EU (Paris) region, eu-west-3. You can now associate VPCs in eu-west-3 with private hosted zones and create alias records that route traffic to resources in eu-west-3. + +## 2.171.0 +* feature: AppStream: This API update is to enable customers to add tags to their Amazon AppStream 2.0 resources + +## 2.170.0 +* feature: APIGateway: Adds support for Cognito Authorizer scopes at the API method level. + +## 2.169.0 +* feature: WorkMail: Today, Amazon WorkMail released an administrative SDK and enabled AWS CloudTrail integration. With the administrative SDK, you can natively integrate WorkMail with your existing services. The SDK enables programmatic user, resource, and group management through API calls. This means your existing IT tools and workflows can now automate WorkMail management, and third party applications can streamline WorkMail migrations and account actions. + +## 2.168.0 +* feature: CognitoIdentityServiceProvider: Exposing the hosted UI domain name for a user pool that has a domain configured. +* feature: LexModelBuildingService: The GetBotChannelAssociation API now returns the status and failure reason, if any, for a bot channel. +* feature: SageMaker: CreateModel API Update: The request parameter 'ExecutionRoleArn' has changed from optional to required. + +## 2.167.0 +* feature: AppStream: This API update is to support the feature that allows customers to automatically consume the latest Amazon AppStream 2.0 agent as and when published by AWS. +* feature: CloudWatch: With this launch, you can now create a CloudWatch alarm that alerts you when M out of N datapoints of a metric are breaching your predefined threshold, such as three out of five times in any given five minutes interval or two out of six times in a thirty minutes interval. When M out of N datapoints are not breaching your threshold in an interval, the alarm will be in OK state. Please note that the M datapoints out of N datapoints in an interval can be of any order and does not need to be consecutive. Consequently, you can now get alerted even when the spikes in your metrics are intermittent over an interval. + +## 2.166.0 +* feature: ES: Added support for encryption of data at rest on Amazon Elasticsearch Service using AWS KMS +* feature: SES: Customers can customize the emails that Amazon SES sends when verifying new identities. This feature is helpful for developers whose applications send email through Amazon SES on behalf of their customers. + +## 2.165.0 +* feature: CloudDirectory: Amazon Cloud Directory makes it easier for you to apply schema changes across your directories with in-place schema upgrades. Your directories now remain available while backward-compatible schema changes are being applied, such as the addition of new fields. You also can view the history of your schema changes in Cloud Directory by using both major and minor version identifiers, which can help you track and audit schema versions across directories. +* feature: SageMaker: Initial waiters for common SageMaker workflows. + +## 2.164.0 +* feature: Iot: Add error action API for RulesEngine. +* feature: ServiceCatalog: ServiceCatalog has two distinct personas for its use, an "admin" persona (who creates sets of products with different versions and prescribes who has access to them) and an "end-user" persona (who can launch cloud resources based on the configuration data their admins have given them access to). This API update will allow admin users to deactivate/activate product versions, end-user will only be able to access and launch active product versions. +* feature: ServiceDiscovery: Amazon Route 53 Auto Naming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the Auto Naming API to register the instance, and Amazon Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries for the service receive an answer that contains up to eight healthy records. + +## 2.163.0 +* feature: Budgets: Add additional costTypes to support finer control for different charges included in a cost budget. + +## 2.162.0 +* feature: SageMaker: Preparing to release updated waiters week of December 4, 2017 for all supported SDKs. + +## 2.161.0 +* feature: APIGateway: Added support Private Integration and VPC Link features in API Gateway. This allows to create an API with the API Gateway private integration, thus providing clients access to HTTP/HTTPS resources in an Amazon VPC from outside of the VPC through a VpcLink resource. +* feature: AlexaForBusiness: Alexa for Business is now generally available for production use. Alexa for Business makes it easy for you to use Alexa in your organization. The Alexa for Business SDK gives you APIs to manage Alexa devices, enroll users, and assign skills at scale. For more information about Alexa for Business, go to https://aws.amazon.com/alexaforbusiness +* feature: Cloud9: Adds support for creating and managing AWS Cloud9 development environments. AWS Cloud9 is a cloud-based integrated development environment (IDE) that you use to write, run, and debug code. +* feature: EC2: Adds the following updates: 1. Spread Placement ensures that instances are placed on distinct hardware in order to reduce correlated failures. 2. Inter-region VPC Peering allows customers to peer VPCs across different AWS regions without requiring additional gateways, VPN connections or physical hardware +* feature: Lambda: AWS Lambda now supports the ability to set the concurrency limits for individual functions, and increasing memory to 3008MB. +* feature: ServerlessApplicationRepository: First release of the AWS Serverless Application Repository SDK + +## 2.160.0 +* feature: AutoScaling: You can now use Auto Scaling with EC2 Launch Templates via the CreateAutoScalingGroup and UpdateAutoScalingGroup APIs. +* feature: EC2: Adds the following updates: 1. T2 Unlimited enables high CPU performance for any period of time whenever required 2. You are now able to create and launch EC2 m5 and h1 instances +* feature: Lightsail: This release adds support for load balancer and TLS/SSL certificate management. This set of APIs allows customers to create, manage, and scale secure load balanced applications on Lightsail infrastructure. To provide support for customers who manage their DNS on Lightsail, we've added the ability create an Alias A type record which can point to a load balancer DNS name via the CreateDomainEntry API http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateDomainEntry.html. +* feature: ResourceGroups: AWS Resource Groups lets you search and group AWS resources from multiple services based on their tags. +* feature: SSM: This release updates AWS Systems Manager APIs to enable executing automations at controlled rate, target resources in a resource groups and execute entire automation at once or single step at a time. It is now also possible to use YAML, in addition to JSON, when creating Systems Manager documents. +* feature: WAF: This release adds support for rule group and managed rule group. Rule group is a container of rules that customers can create, put rules in it and associate the rule group to a WebACL. All rules in a rule group will function identically as they would if each rule was individually associated to the WebACL. Managed rule group is a pre-configured rule group composed by our security partners and made available via the AWS Marketplace. Customers can subscribe to these managed rule groups, associate the managed rule group to their WebACL and start using them immediately to protect their resources. +* feature: WAFRegional: This release adds support for rule group and managed rule group. Rule group is a container of rules that customers can create, put rules in it and associate the rule group to a WebACL. All rules in a rule group will function identically as they would if each rule was individually associated to the WebACL. Managed rule group is a pre-configured rule group composed by our security partners and made available via the AWS Marketplace. Customers can subscribe to these managed rule groups, associate the managed rule group to their WebACL and start using them immediately to protect their resources. + +## 2.159.0 +* feature: Comprehend: Amazon Comprehend is an AWS service for gaining insight into the content of text and documents . It develops insights by recognizing the entities, key phrases, language, sentiments, and other common elements in a document. For more information, go to the Amazon Comprehend product page. To get started, see the Amazon Comprehend Developer Guide. +* feature: DynamoDB: Amazon DynamoDB now supports the following features: Global Table and On-Demand Backup. Global Table is a fully-managed, multi-region, multi-master database. DynamoDB customers can now write anywhere and read anywhere with single-digit millisecond latency by performing database operations closest to where end users reside. Global Table also enables customers to disaster-proof their applications, keeping them running and data accessible even in the face of natural disasters or region disruptions. Customers can set up Global Table with just a few clicks in the AWS Management Console-no application rewrites required. On-Demand Backup capability is to protect data from loss due to application errors, and meet customers' archival needs for compliance and regulatory reasons. Customers can backup and restore their DynamoDB table data anytime, with a single-click in the AWS management console or a single API call. Backup and restore actions execute with zero impact on table performance or availability. For more information, see the Amazon DynamoDB Developer Guide. +* feature: ECS: Amazon Elastic Container Service (Amazon ECS) released a new launch type for running containers on a serverless infrastructure. The Fargate launch type allows you to run your containerized applications without the need to provision and manage the backend infrastructure. Just register your task definition and Fargate launches the container for you. +* feature: Glacier: This release includes support for Glacier Select, a new feature that allows you to filter and analyze your Glacier archives and store the results in a user-specified S3 location. +* feature: Greengrass: Greengrass OTA feature allows updating Greengrass Core and Greengrass OTA Agent. Local Resource Access feature allows Greengrass Lambdas to access local resources such as peripheral devices and volumes. +* feature: IoTJobsDataPlane: This release adds support for new the service called Iot Jobs. This client is built for the device SDK to use Iot Jobs Device specific APIs. +* feature: Iot: This release adds support for a number of new IoT features, including AWS IoT Device Management (Jobs, Fleet Index and Thing Registration), Thing Groups, Policies on Thing Groups, Registry & Job Events, JSON Logs, Fine-Grained Logging Controls, Custom Authorization and AWS Service Authentication Using X.509 Certificates. +* feature: KinesisVideo: Announcing Amazon Kinesis Video Streams, a fully managed video ingestion and storage service. Kinesis Video Streams makes it easy to securely stream video from connected devices to AWS for machine learning, analytics, and processing. You can also stream other time-encoded data like RADAR and LIDAR signals using Kinesis Video Streams. +* feature: KinesisVideoArchivedMedia: Announcing Amazon Kinesis Video Streams, a fully managed video ingestion and storage service. Kinesis Video Streams makes it easy to securely stream video from connected devices to AWS for machine learning, analytics, and processing. You can also stream other time-encoded data like RADAR and LIDAR signals using Kinesis Video Streams. +* feature: KinesisVideoMedia: Announcing Amazon Kinesis Video Streams, a fully managed video ingestion and storage service. Kinesis Video Streams makes it easy to securely stream video from connected devices to AWS for machine learning, analytics, and processing. You can also stream other time-encoded data like RADAR and LIDAR signals using Kinesis Video Streams. +* feature: Rekognition: This release introduces Amazon Rekognition support for video analysis. +* feature: S3: This release includes support for Glacier Select, a new feature that allows you to filter and analyze your Glacier storage class objects and store the results in a user-specified S3 location. +* feature: SageMaker: Amazon SageMaker is a fully-managed service that enables data scientists and developers to quickly and easily build, train, and deploy machine learning models, at scale. +* feature: SageMakerRuntime: Amazon SageMaker is a fully-managed service that enables data scientists and developers to quickly and easily build, train, and deploy machine learning models, at scale. +* feature: Translate: Public preview release of Amazon Translate and the Amazon Translate Developer Guide. For more information, see the Amazon Translate Developer Guide. + +## 2.158.0 +* feature: APIGateway: Changes related to CanaryReleaseDeployment feature. Enables API developer to create a deployment as canary deployment and test API changes with percentage of customers before promoting changes to all customers. +* feature: AppSync: AWS AppSync is an enterprise-level, fully managed GraphQL service with real-time data synchronization and offline programming features. +* feature: Batch: Add support for Array Jobs which allow users to easily submit many copies of a job with a single API call. This change also enhances the job dependency model to support N_TO_N and sequential dependency chains. The ListJobs and DescribeJobs APIs now have the ability to list or describe the status of entire Array Jobs or individual elements within the array. +* feature: CodeDeploy: Support for AWS Lambda function deployment - AWS CodeDeploy now supports the deployment of AWS Lambda functions. A Lambda deployment uses a Lambda function alias to shift traffic to a new version. You select a deployment configuration that specifies exactly how traffic shifts to your new version. Success of a deployment can be validated using Lambda functions that are referenced by the deployment. This provides the opportunity to rollback if necessary. +* feature: CognitoIdentityServiceProvider: AWS Cognito SDK has been updated to support new Cognito user-pool objects and operations for advanced security +* feature: EC2: Adds the following updates: 1. You are now able to host a service powered by AWS PrivateLink to provide private connectivity to other VPCs. You are now also able to create endpoints to other services powered by PrivateLink including AWS services, Marketplace Seller services or custom services created by yourself or other AWS VPC customers. 2. You are now able to save launch parameters in a single template that can be used with Auto Scaling, Spot Fleet, Spot, and On Demand instances. 3. You are now able to launch Spot instances via the RunInstances API, using a single additional parameter. RunInstances will response synchronously with an instance ID should capacity be available for your Spot request. 4. A simplified Spot pricing model which delivers low, predictable prices that adjust gradually, based on long-term trends in supply and demand. 5. Amazon EC2 Spot can now hibernate Amazon EBS-backed instances in the event of an interruption, so your workloads pick up from where they left off. Spot can fulfill your request by resuming instances from a hibernated state when capacity is available. +* feature: GuardDuty: Enable Amazon GuardDuty to continuously monitor and process AWS data sources to identify threats to your AWS accounts and workloads. You can add customization by uploading additional threat intelligence lists and IP safe lists. You can list security findings, suspend, and disable the service. +* feature: Lambda: Lambda aliases can now shift traffic between two function versions, based on preassigned weights. +* feature: MQ: This is the initial SDK release for Amazon MQ. Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message brokers in the cloud. +* feature: credentials_provider: Add general purpose RemoteCredentials and derive ECSCredentials from it + +## 2.157.0 +* feature: MediaConvert: AWS Elemental MediaConvert is a file-based video conversion service that transforms media into formats required for traditional broadcast and for internet streaming to multi-screen devices. +* feature: MediaLive: AWS Elemental MediaLive is a video service that lets you easily create live outputs for broadcast and streaming delivery. +* feature: MediaPackage: AWS Elemental MediaPackage is a just-in-time video packaging and origination service that lets you format highly secure and reliable live outputs for a variety of devices. +* feature: MediaStore: AWS Elemental MediaStore is an AWS storage service optimized for media. It gives you the performance, consistency, and low latency required to deliver live and on-demand video content. AWS Elemental MediaStore acts as the origin store in your video workflow. +* feature: MediaStoreData: AWS Elemental MediaStore is an AWS storage service optimized for media. It gives you the performance, consistency, and low latency required to deliver live and on-demand video content. AWS Elemental MediaStore acts as the origin store in your video workflow. + +## 2.156.0 +* bugfix: Presigner: Update presigner to only hoist headers in v2 +* feature: ACM: AWS Certificate Manager now supports the ability to import domainless certs and additional Key Types as well as an additional validation method for DNS. + +## 2.155.0 +* feature: APIGateway: Add support for Access logs and customizable integration timeouts +* feature: CloudFormation: 1) Instance-level parameter overrides (CloudFormation-StackSet feature): This feature will allow the customers to override the template parameters on specific stackInstances. Customers will also have ability to update their existing instances with/without parameter-overrides using a new API "UpdateStackInstances" 2) Add support for SSM parameters in CloudFormation - This feature will allow the customers to use Systems Manager parameters in CloudFormation templates. They will be able to see values for these parameters in Describe APIs. +* feature: CodeBuild: Adding support for accessing Amazon VPC resources from AWS CodeBuild, dependency caching and build badges. +* feature: EMR: Enable Kerberos on Amazon EMR. +* feature: Rekognition: This release includes updates to Amazon Rekognition for the following APIs. The new DetectText API allows you to recognize and extract textual content from images. Face Model Versioning has been added to operations that deal with face detection. +* feature: Shield: The AWS Shield SDK has been updated in order to support Elastic IP address protections, the addition of AttackProperties objects in DescribeAttack responses, and a new GetSubscriptionState operation. +* feature: StorageGateway: AWS Storage Gateway now enables you to get notification when all your files written to your NFS file share have been uploaded to Amazon S3. Storage Gateway also enables guessing of the MIME type for uploaded objects based on file extensions. +* feature: XRay: Added automatic pagination support for AWS X-Ray APIs in the SDKs that support this feature. + +## 2.154.0 +* feature: CodeCommit: AWS CodeCommit now supports pull requests. You can use pull requests to collaboratively review code changes for minor changes or fixes, major feature additions, or new versions of your released software. +* feature: CostExplorer: The AWS Cost Explorer API gives customers programmatic access to AWS cost and usage information, allowing them to perform adhoc queries and build interactive cost management applications that leverage this dataset. +* feature: Firehose: This release includes a new Kinesis Firehose feature that supports Splunk as Kinesis Firehose delivery destination. You can now use Kinesis Firehose to ingest real-time data to Splunk in a serverless, reliable, and salable manner. This release also includes a new feature that allows you to configure Lambda buffer size in Kinesis Firehose data transformation feature. You can now customize the data buffer size before invoking Lambda function in Kinesis Firehose for data transformation. This feature allows you to flexibly trade-off processing and delivery latency with cost and efficiency based on your specific use cases and requirements. +* feature: Kinesis: Customers can now obtain the important characteristics of their stream with DescribeStreamSummary. The response will not include the shard list for the stream but will have the number of open shards, and all the other fields included in the DescribeStream response. +* feature: WorkDocs: DescribeGroups API and miscellaneous enhancements + +## 2.153.0 +* feature: ApplicationAutoScaling: This SDK update contains support for Target Tracking scaling for EC2 Spot Fleet. It allows you to scale an EC2 Spot Fleet using a Target Tracking scaling policy. +* feature: DMS: Support for migration task assessment. Support for data validation after the migration. +* feature: RDS: Amazon RDS now supports importing MySQL databases by using backup files from Amazon S3. +* feature: S3: Added ORC to the supported S3 Inventory formats. + +## 2.152.0 +* bugfix: S3: Reverts default signatureVersion for S3 presigned URLs to the lowest signatureVersion the region supports. 2.150.0 changed the default signatureVersion of all presigned URLs to v4. This change does not affect S3 clients that had the signatureVersion explicitly defined. +* feature: ApplicationAutoScaling: Application Auto Scaling now supports automatic scaling of Amazon Aurora replicas +* feature: EC2: You are now able to create and launch EC2 x1e smaller instance sizes +* feature: Glue: API update for AWS Glue. New crawler configuration attribute enables customers to specify crawler behavior. New XML classifier enables classification of XML data. +* feature: Organizations: This release adds APIs that you can use to enable and disable integration with AWS services designed to work with AWS Organizations. This integration allows the AWS service to perform operations on your behalf on all of the accounts in your organization. Although you can use these APIs yourself, we recommend that you instead use the commands provided in the other AWS service to enable integration with AWS Organizations. +* feature: Route53: You can use Route 53's GetAccountLimit/GetHostedZoneLimit/GetReusableDelegationSetLimit APIs to view your current limits (including custom set limits) on Route 53 resources such as hosted zones and health checks. These APIs also return the number of each resource you're currently using to enable comparison against your current limits. + +## 2.151.0 +* feature: APIGateway: 1. Extended GetDocumentationParts operation to support retrieving documentation parts resources without contents. 2. Added hosted zone ID in the custom domain response. +* feature: Polly: Amazon Polly adds Korean language support with new female voice - "Seoyeon" and new Indian English female voice - "Aditi" +* feature: SES: SES launches Configuration Set Reputation Metrics and Email Pausing Today, two features that build upon the capabilities of the reputation dashboard. The first is the ability to export reputation metrics for individual configuration sets. The second is the ability to temporarily pause email sending, either at the configuration set level, or across your entire Amazon SES account. +* feature: StepFunctions: You can now use the UpdateStateMachine API to update your state machine definition and role ARN. Existing executions will continue to use the previous definition and role ARN. You can use the DescribeStateMachineForExecution API to determine which state machine definition and role ARN is associated with an execution + +## 2.150.0 +* feature: ECS: Added new mode for Task Networking in ECS, called awsvpc mode. Mode configuration parameters to be passed in via awsvpcConfiguration. Updated APIs now use/show this new mode - RegisterTaskDefinition, CreateService, UpdateService, RunTask, StartTask. +* feature: ECS: Remove localhost restriction for ECS credential provider +* feature: Lightsail: Lightsail now supports attached block storage, which allows you to scale your applications and protect application data with additional SSD-backed storage disks. This feature allows Lightsail customers to attach secure storage disks to their Lightsail instances and manage their attached disks, including creating and deleting disks, attaching and detaching disks from instances, and backing up disks via snapshot. +* feature: Route53: When a Route 53 health check or hosted zone is created by a linked AWS service, the object now includes information about the service that created it. Hosted zones or health checks that are created by a linked service can't be updated or deleted using Route 53. +* feature: SSM: EC2 Systems Manager GetInventory API adds support for aggregation. + +## 2.149.0 +* feature: EC2: Introduces the following features: 1. Create a default subnet in an Availability Zone if no default subnet exists. 2. Spot Fleet integrates with Elastic Load Balancing to enable you to attach one or more load balancers to a Spot Fleet request. When you attach the load balancer, it automatically registers the instance in the Spot Fleet to the load balancers which distributes incoming traffic across the instances. + +## 2.148.0 +* feature: ApplicationAutoScaling: Application Auto Scaling customers are now able to schedule adjustments to their MinCapacity and MaxCapacity, which makes it possible to pre-provision adequate capacity for anticipated demand and then reduce the provisioned capacity as demand lulls. +* feature: EC2: AWS PrivateLink for Amazon Services - Customers can now privately access Amazon services from their Amazon Virtual Private Cloud (VPC), without using public IPs, and without requiring the traffic to traverse across the Internet. +* feature: ElastiCache: This release adds online resharding for ElastiCache for Redis offering, providing the ability to add and remove shards from a running cluster. Developers can now dynamically scale-out or scale-in their Redis cluster workloads to adapt to changes in demand. ElastiCache will resize the cluster by adding or removing shards and redistribute hash slots uniformly across the new shard configuration, all while the cluster continues to stay online and serves requests. +* feature: Logger: Update the request logger to exclude sensitive input parammeters from being logged + +## 2.147.0 +* feature: ELBv2: Added a new limit related to Network Load Balancers on the number of targets per load balancer per AZ. +* feature: RDS: DescribeOrderableDBInstanceOptions now returns the minimum and maximum allowed values for storage size, total provisioned IOPS, and provisioned IOPS per GiB for a DB instance. +* feature: S3: This releases adds support for 4 features: 1. Default encryption for S3 Bucket, 2. Encryption status in inventory and Encryption support for inventory. 3. Cross region replication of KMS-encrypted objects, and 4. ownership overwrite for CRR. + +## 2.146.0 +* feature: EC2: You are now able to create and launch EC2 C5 instances, the next generation of EC2's compute-optimized instances, in us-east-1, us-west-2 and eu-west-1. C5 instances offer up to 72 vCPUs, 144 GiB of DDR4 instance memory, 25 Gbps in Network bandwidth and improved EBS and Networking bandwidth on smaller instance sizes to deliver improved performance for compute-intensive workloads. +* feature: KMS: Documentation updates for AWS KMS. +* feature: Pricing: This is the initial release of AWS Price List Service. +* feature: StepFunctions: Documentation update. + +## 2.145.0 +* feature: ECS: Amazon ECS users can now add devices to their containers and enable init process in containers through the use of docker's 'devices' and 'init' features. These fields can be specified under linuxParameters in ContainerDefinition in the Task Definition Template. + +## 2.144.0 +* feature: APIGateway: This release supports creating and managing Regional and Edge-Optimized API endpoints. + +## 2.143.0 +* feature: DirectConnect: AWS DirectConnect now provides support for Global Access for Virtual Private Cloud (VPC) via a new feature called Direct Connect Gateway. A Direct Connect Gateway will allow you to group multiple Direct Connect Private Virtual Interfaces (DX-VIF) and Private Virtual Gateways (VGW) from different AWS regions (but belonging to the same AWS Account) and pass traffic from any DX-VIF to any VPC in the grouping. + +## 2.142.0 +* feature: Configuration: Allow the logger by SDK clients to be controlled via the environment if not defined programmatically. If the `AWSJS_DEBUG` environment variable is set to a truthy value and no other logger is defined, the global `console` object will be used. +* feature: DirectConnect: AWS DirectConnect now provides support for Global Access for Virtual Private Cloud (VPC) via a new feature called Direct Connect Gateway. A Direct Connect Gateway will allow you to group multiple Direct Connect Private Virtual Interfaces (DX-VIF) and Private Virtual Gateways (VGW) from different AWS regions (but belonging to the same AWS Account) and pass traffic from any DX-VIF to any VPC in the grouping. + +## 2.141.0 +* feature: CloudFront: You can now specify additional options for MinimumProtocolVersion, which controls the SSL/TLS protocol that CloudFront uses to communicate with viewers. The minimum protocol version that you choose also determines the ciphers that CloudFront uses to encrypt the content that it returns to viewers. +* feature: EC2: You are now able to create and launch EC2 P3 instance, next generation GPU instances, optimized for machine learning and high performance computing applications. With up to eight NVIDIA Tesla V100 GPUs, P3 instances provide up to one petaflop of mixed-precision, 125 teraflops of single-precision, and 62 teraflops of double-precision floating point performance, as well as a 300 GB/s second-generation NVLink interconnect that enables high-speed, low-latency GPU-to-GPU communication. P3 instances also feature up to 64 vCPUs based on custom Intel Xeon E5 (Broadwell) processors, 488 GB of DRAM, and 25 Gbps of dedicated aggregate network bandwidth using the Elastic Network Adapter (ENA). + +## 2.140.0 +* feature: ConfigService: AWS Config support for CodeBuild Project resource type +* feature: ElastiCache: Amazon ElastiCache for Redis today announced support for data encryption both for data in-transit and data at-rest. The new encryption in-transit functionality enables ElastiCache for Redis customers to encrypt data for all communication between clients and Redis engine, and all intra-cluster Redis communication. The encryption at-rest functionality allows customers to encrypt their S3 based backups. Customers can begin using the new functionality by simply enabling this functionality via AWS console, and a small configuration change in their Redis clients. The ElastiCache for Redis service automatically manages life cycle of the certificates required for encryption, including the issuance, renewal and expiration of certificates. Additionally, as part of this launch, customers will gain the ability to start using the Redis AUTH command that provides an added level of authentication. +* feature: Glue: AWS Glue: Adding a new API, BatchStopJobRun, to stop one or more job runs for a specified Job. +* feature: Pinpoint: Added support for APNs VoIP messages. Added support for collapsible IDs, message priority, and TTL for APNs and FCM/GCM. + +## 2.139.0 +* feature: Organizations: This release supports integrating other AWS services with AWS Organizations through the use of an IAM service-linked role called AWSServiceRoleForOrganizations. Certain operations automatically create that role if it does not already exist. + +## 2.138.0 +* feature: EC2: Adding pagination support for DescribeSecurityGroups for EC2 Classic and VPC Security Groups + +## 2.137.0 +* feature: SQS: Added support for tracking cost allocation by adding, updating, removing, and listing the metadata tags of Amazon SQS queues. +* feature: SSM: EC2 Systems Manager versioning support for Parameter Store. Also support for referencing parameter versions in SSM Documents. + +## 2.136.0 +* feature: Lightsail: This release adds support for Windows Server-based Lightsail instances. The GetInstanceAccessDetails API now returns the password of your Windows Server-based instance when using the default key pair. GetInstanceAccessDetails also returns a PasswordData object for Windows Server instances containing the ciphertext and keyPairName. The Blueprint data type now includes a list of platform values (LINUX_UNIX or WINDOWS). The Bundle data type now includes a list of SupportedPlatforms values (LINUX_UNIX or WINDOWS). + +## 2.135.0 +* feature: ES: This release adds support for VPC access to Amazon Elasticsearch Service. + +## 2.134.0 +* feature: CORS: The LexModelBuildingService supports CORS. This change adds the service to the browser version of the SDK by default. +* feature: EC2: You can now change the tenancy of your VPC from dedicated to default with a single API operation. For more details refer to the documentation for changing VPC tenancy. +* feature: ES: AWS Elasticsearch adds support for enabling slow log publishing. Using slow log publishing options customers can configure and enable index/query slow log publishing of their domain to preferred AWS Cloudwatch log group. +* feature: RDS: Adds waiters for DBSnapshotAvailable and DBSnapshotDeleted. +* feature: WAF: This release adds support for regular expressions as match conditions in rules, and support for geographical location by country of request IP address as a match condition in rules. +* feature: WAFRegional: This release adds support for regular expressions as match conditions in rules, and support for geographical location by country of request IP address as a match condition in rules. + +## 2.133.0 +* feature: CodeCommit: This release includes the DeleteBranch API and a change to the contents of a Commit object. +* feature: DMS: This change includes addition of new optional parameter to an existing API +* feature: ElasticBeanstalk: Added the ability to add, delete or update Tags +* feature: Polly: Amazon Polly exposes two new voices: "Matthew" (US English) and "Takumi" (Japanese) +* feature: RDS: You can now call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. + +## 2.132.0 +* feature: ECR: Adds support for new API set used to manage Amazon ECR repository lifecycle policies. Amazon ECR lifecycle policies enable you to specify the lifecycle management of images in a repository. The configuration is a set of one or more rules, where each rule defines an action for Amazon ECR to apply to an image. This allows the automation of cleaning up unused images, for example expiring images based on age or status. A lifecycle policy preview API is provided as well, which allows you to see the impact of a lifecycle policy on an image repository before you execute it +* feature: SES: Added content related to email template management and templated email sending operations. + +## 2.131.0 +* feature: EC2: This release includes updates to AWS Virtual Private Gateway. +* feature: ELBv2: Server Name Indication (SNI) is an extension to the TLS protocol by which a client indicates the hostname to connect to at the start of the TLS handshake. The load balancer can present multiple certificates through the same secure listener, which enables it to support multiple secure websites using a single secure listener. Application Load Balancers also support a smart certificate selection algorithm with SNI. If the hostname indicated by a client matches multiple certificates, the load balancer determines the best certificate to use based on multiple factors including the capabilities of the client. +* feature: OpsWorksCM: Provide engine specific information for node associations. + +## 2.130.0 +* feature: ConfigService: Revert: Added missing enumeration values for ConfigurationItemStatus + +## 2.129.0 +* feature: ConfigService: Added missing enumeration values for ConfigurationItemStatus + +## 2.128.0 +* feature: Redshift: DescribeEventSubscriptions API supports tag keys and tag values as request parameters. + +## 2.127.0 +* feature: KinesisAnalytics: Kinesis Analytics now supports schema discovery on objects in S3. Additionally, Kinesis Analytics now supports input data preprocessing through Lambda. +* feature: Route53Domains: Added a new API that checks whether a domain name can be transferred to Amazon Route 53. + +## 2.126.0 +* feature: EC2: This release includes service updates to AWS VPN. +* feature: SSM: EC2 Systems Manager support for tagging SSM Documents. Also support for tag-based permissions to restrict access to SSM Documents based on these tags. + +## 2.125.0 +* feature: AppStream: Includes APIs for managing and accessing image builders, and deleting images. +* feature: CodeBuild: Adding support for Building GitHub Pull Requests in AWS CodeBuild +* feature: MTurk: Today, Amazon Mechanical Turk (MTurk) supports SQS Notifications being delivered to Customers' SQS queues when different stages of the MTurk workflow are complete. We are going to create new functionality so that Customers can leverage SNS topics as a destination for notification messages when various stages of the MTurk workflow are complete. +* feature: Organizations: This release flags the HandshakeParty structure's Type and Id fields as 'required'. They effectively were required in the past, as you received an error if you did not include them. This is now reflected at the API definition level. +* feature: Route53: This change allows customers to reset elements of health check. + +## 2.124.0 +* feature: Pinpoint: Added two new push notification channels: Amazon Device Messaging (ADM) and, for push notification support in China, Baidu Cloud Push. Added support for APNs auth via .p8 key file. Added operation for direct message deliveries to user IDs, enabling you to message an individual user on multiple endpoints. + +## 2.123.0 +* feature: CloudFormation: You can now prevent a stack from being accidentally deleted by enabling termination protection on the stack. If you attempt to delete a stack with termination protection enabled, the deletion fails and the stack, including its status, remains unchanged. You can enable termination protection on a stack when you create it. Termination protection on stacks is disabled by default. After creation, you can set termination protection on a stack whose status is CREATE_COMPLETE, UPDATE_COMPLETE, or UPDATE_ROLLBACK_COMPLETE. + +## 2.122.0 +* feature: ConfigService: AWS Config support for DynamoDB tables and Auto Scaling resource types +* feature: ECS: Amazon ECS users can now add and drop Linux capabilities to their containers through the use of docker's cap-add and cap-drop features. Customers can specify the capabilities they wish to add or drop for each container in their task definition. + +## 2.121.0 +* feature: Budgets: Including "DuplicateRecordException" in UpdateNotification and UpdateSubscriber. +* feature: CloudWatchLogs: Adds support for associating LogGroups with KMS Keys. +* feature: EC2: Add EC2 APIs to copy Amazon FPGA Images (AFIs) within the same region and across multiple regions, delete AFIs, and modify AFI attributes. AFI attributes include name, description and granting/denying other AWS accounts to load the AFI. + +## 2.120.0 +* feature: AppStream: API updates for supporting On-Demand fleets. +* feature: CodePipeline: This change includes a PipelineMetadata object that is part of the output from the GetPipeline API that includes the Pipeline ARN, created, and updated timestamp. +* feature: Greengrass: Reset Deployments feature allows you to clean-up the cloud resource so you can delete the group. It also cleans up the core so that it goes back to the pre-deployment state. +* feature: LexRuntime: Request attributes can be used to pass client specific information from the client to Amazon Lex as part of each request. +* feature: RDS: Introduces the --option-group-name parameter to the ModifyDBSnapshot CLI command. You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG + +## 2.119.0 +* feature: EC2: Fixed bug in EC2 clients preventing ElasticGpuSet from being set. + +## 2.118.0 +* feature: EC2: Amazon EC2 now lets you opt for Spot instances to be stopped in the event of an interruption instead of being terminated. Your Spot request can be fulfilled again by restarting instances from a previously stopped state, subject to availability of capacity at or below your preferred price. When you submit a persistent Spot request, you can choose from "terminate" or "stop" as the instance interruption behavior. Choosing "stop" will shutdown your Spot instances so you can continue from this stopped state later on. This feature is only available for instances with Amazon EBS volume as their root device. +* feature: IAM: A new API, DeleteServiceLinkedRole, submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. +* feature: SES: Amazon Simple Email Service (Amazon SES) now lets you customize the domains used for tracking open and click events. Previously, open and click tracking links referred to destinations hosted on domains operated by Amazon SES. With this feature, you can use your own branded domains for capturing open and click events. + +## 2.117.0 +* feature: APIGateway: Add a new enum "REQUEST" to '--type ' field in the current create-authorizer API, and make "identitySource" optional. + +## 2.116.0 +* bugfix: clock skew: put the updating clock skew logic to each service client instead of using global config +* feature: CodeBuild: Supporting Parameter Store in environment variables for AWS CodeBuild +* feature: ServiceCatalog: This release of Service Catalog adds API support to copy products. + +## 2.115.0 +* feature: AutoScaling: Customers can create Life Cycle Hooks at the time of creating Auto Scaling Groups through the CreateAutoScalingGroup API +* feature: CloudWatchEvents: Exposes ConcurrentModificationException as one of the valid exceptions for PutPermission and RemovePermission operation. +* feature: EC2: You are now able to create and launch EC2 x1e.32xlarge instance, a new EC2 instance in the X1 family, in us-east-1, us-west-2, eu-west-1, and ap-northeast-1. x1e.32xlarge offers 128 vCPUs, 3,904 GiB of DDR4 instance memory, high memory bandwidth, large L3 caches, and leading reliability capabilities to boost the performance and reliability of in-memory applications. + +## 2.114.0 +* feature: EC2: Fixed bug in EC2 clients preventing HostOfferingSet from being set + +## 2.113.0 +* feature: DeviceFarm: DeviceFarm has added support for two features - RemoteDebugging and Customer Artifacts. Customers can now do remote Debugging on their Private Devices and can now retrieve custom files generated by their tests on the device and the device host (execution environment) on both public and private devices. + +## 2.112.0 +* feature: CloudWatchLogs: Adds support for the PutResourcePolicy, DescribeResourcePolicy and DeleteResourcePolicy APIs. + +## 2.111.0 +* feature: EC2: With Tagging support, you can add Key and Value metadata to search, filter and organize your NAT Gateways according to your organization's needs. +* feature: ELBv2: The feature enables the new Network Load Balancer that is optimized to handle volatile traffic patterns while using a single static IP address per Availability Zone. Network Load Balancer operates at the connection level (Layer 4), routing connections to Amazon EC2 instances and containers, within Amazon Virtual Private Cloud (Amazon VPC) based on IP protocol data. +* feature: LexModelBuildingService: Amazon Lex provides the ability to export your Amazon Lex chatbot definition as a JSON file that can be added to the target platform. The JSON configuration file contains the structure of your Amazon Lex chatbot, including the intent schema with utterances, slots, prompts and slot-types. +* feature: Route53: You can configure Amazon Route 53 to log information about the DNS queries that Amazon Route 53 receives for your domains and subdomains. When you configure query logging, Amazon Route 53 starts to send logs to CloudWatch Logs. You can use various tools, including the AWS console, to access the query logs. + +## 2.110.0 +* feature: Budgets: Add an optional "thresholdType" to notifications to support percentage or absolute value thresholds. + +## 2.109.0 +* feature: CodeStar: Added support to tag CodeStar projects. Tags can be used to organize and find CodeStar projects on key-value pairs that you can choose. For example, you could add a tag with a key of "Release" and a value of "Beta" to projects your organization is working on for an upcoming beta release. + +## 2.108.0 +* feature: GameLift: GameLift VPC resources can be peered with any other AWS VPC. R4 memory-optimized instances now available to deploy. +* feature: Mobile: AWS Mobile Hub is an integrated experience designed to help developers build, test, configure and release cloud-based applications for mobile devices using Amazon Web Services. AWS Mobile Hub provides a console and API for developers, allowing them to quickly select desired features and integrate them into mobile applications. Features include NoSQL Database, Cloud Logic, Messaging and Analytics. With AWS Mobile Hub, you pay only for the underlying services that Mobile Hub provisions based on the features you choose in the Mobile Hub console. +* feature: SSM: Adding KMS encryption support to SSM Inventory Resource Data Sync. Exposes the ClientToken parameter on SSM StartAutomationExecution to provide idempotent execution requests. + +## 2.107.0 +* feature: CodeBuild: The AWS CodeBuild HTTP API now provides the BatchDeleteBuilds operation, which enables you to delete existing builds. +* feature: EC2: Descriptions for Security Group Rules enables customers to be able to define a description for ingress and egress security group rules . The Descriptions for Security Group Rules feature supports one description field per Security Group rule for both ingress and egress rules . Descriptions for Security Group Rules provides a simple way to describe the purpose or function of a Security Group Rule allowing for easier customer identification of configuration elements . Prior to the release of Descriptions for Security Group Rules , customers had to maintain a separate system outside of AWS if they wanted to track Security Group Rule mapping and their purpose for being implemented. If a security group rule has already been created and you would like to update or change your description for that security group rule you can use the UpdateSecurityGroupRuleDescription API. +* feature: ELBv2: This change now allows Application Load Balancers to distribute traffic to AWS resources using their IP addresses as targets in addition to the instance IDs. You can also load balance to resources outside the VPC hosting the load balancer using their IP addresses as targets. This includes resources in peered VPCs, EC2-Classic, and on-premises locations reachable over AWS Direct Connect or a VPN connection. +* feature: LexModelBuildingService: Amazon Lex now supports synonyms for slot type values. If the user inputs a synonym, it will be resolved to the corresponding slot value. + +## 2.106.0 +* feature: ApplicationAutoScaling: Application Auto Scaling now supports the DisableScaleIn option for Target Tracking Scaling Policies. This allows customers to create scaling policies that will only add capacity to the target. +* feature: Organizations: The exception ConstraintViolationException now contains a new reason subcode MASTERACCOUNT_MISSING_CONTACT_INFO to make it easier to understand why attempting to remove an account from an Organization can fail. We also improved several other of the text descriptions and examples. + +## 2.105.0 +* feature: ConfigService: Increased the internal size limit of resourceId +* feature: EC2: Provides capability to add secondary CIDR blocks to a VPC. + +## 2.104.0 +* feature: CloudFormation: 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. +* feature: GameLift: Update spelling of MatchmakingTicket status values for internal consistency. +* feature: RDS: Option group options now contain additional properties that identify requirements for certain options. Check these properties to determine if your DB instance must be in a VPC or have auto minor upgrade turned on before you can use an option. Check to see if you can downgrade the version of an option after you have installed it. + +## 2.103.0 +* feature: Rekognition: Update the enum value of LandmarkType and GenderType to be consistent with service response + +## 2.102.0 +* feature: SSM: Changes to associations in Systems Manager State Manager can now be recorded. Previously, when you edited associations, you could not go back and review older association settings. Now, associations are versioned, and can be named using human-readable strings, allowing you to see a trail of association changes. You can also perform rate-based scheduling, which allows you to schedule associations more granularly. + +## 2.101.0 +* feature: Firehose: This change will allow customers to attach a Firehose delivery stream to an existing Kinesis stream directly. You no longer need a forwarder to move data from a Kinesis stream to a Firehose delivery stream. You can now run your streaming applications on your Kinesis stream and easily attach a Firehose delivery stream to it for data delivery to S3, Redshift, or Elasticsearch concurrently. +* feature: Route53: Amazon Route 53 now supports CAA resource record type. A CAA record controls which certificate authorities are allowed to issue certificates for the domain or subdomain. + +## 2.100.0 +* feature: GameLift: The Matchmaking Grouping Service is a new feature that groups player match requests for a given game together into game sessions based on developer configured rules. + +## 2.99.0 +* feature: EC2: Fixed bug in EC2 clients preventing HostReservation from being set + +## 2.98.0 +* feature: Batch: This release enhances the DescribeJobs API to include the CloudWatch logStreamName attribute in ContainerDetail and ContainerDetailAttempt +* feature: CloudHSMV2: CloudHSM provides hardware security modules for protecting sensitive data and cryptographic keys within an EC2 VPC, and enable the customer to maintain control over key access and use. This is a second-generation of the service that will improve security, lower cost and provide better customer usability. +* feature: EFS: Customers can create encrypted EFS file systems and specify a KMS master key to encrypt it with. +* feature: Glue: AWS Glue is a fully managed extract, transform, and load (ETL) service that makes it easy for customers to prepare and load their data for analytics. You can create and run an ETL job with a few clicks in the AWS Management Console. You simply point AWS Glue to your data stored on AWS, and AWS Glue discovers your data and stores the associated metadata (e.g. table definition and schema) in the AWS Glue Data Catalog. Once cataloged, your data is immediately searchable, queryable, and available for ETL. AWS Glue generates the code to execute your data transformations and data loading processes. AWS Glue generates Python code that is entirely customizable, reusable, and portable. Once your ETL job is ready, you can schedule it to run on AWS Glue's fully managed, scale-out Spark environment. AWS Glue provides a flexible scheduler with dependency resolution, job monitoring, and alerting. AWS Glue is serverless, so there is no infrastructure to buy, set up, or manage. It automatically provisions the environment needed to complete the job, and customers pay only for the compute resources consumed while running ETL jobs. With AWS Glue, data can be available for analytics in minutes. +* feature: MigrationHub: AWS Migration Hub provides a single location to track migrations across multiple AWS and partner solutions. Using Migration Hub allows you to choose the AWS and partner migration tools that best fit your needs, while providing visibility into the status of your entire migration portfolio. Migration Hub also provides key metrics and progress for individual applications, regardless of which tools are being used to migrate them. For example, you might use AWS Database Migration Service, AWS Server Migration Service, and partner migration tools to migrate an application comprised of a database, virtualized web servers, and a bare metal server. Using Migration Hub will provide you with a single screen that shows the migration progress of all the resources in the application. This allows you to quickly get progress updates across all of your migrations, easily identify and troubleshoot any issues, and reduce the overall time and effort spent on your migration projects. Migration Hub is available to all AWS customers at no additional charge. You only pay for the cost of the migration tools you use, and any resources being consumed on AWS. +* feature: SSM: Systems Manager Maintenance Windows include the following changes or enhancements: New task options using Systems Manager Automation, AWS Lambda, and AWS Step Functions; enhanced ability to edit the targets of a Maintenance Window, including specifying a target name and description, and ability to edit the owner field; enhanced ability to edits tasks; enhanced support for Run Command parameters; and you can now use a --safe flag when attempting to deregister a target. If this flag is enabled when you attempt to deregister a target, the system returns an error if the target is referenced by any task. Also, Systems Manager now includes Configuration Compliance to scan your fleet of managed instances for patch compliance and configuration inconsistencies. You can collect and aggregate data from multiple AWS accounts and Regions, and then drill down into specific resources that aren't compliant. +* feature: StorageGateway: Add optional field ForceDelete to DeleteFileShare api. + +## 2.97.0 +* bugfix: REST-JSON serialization: Automatically add a content-type header of application/json to requests with a JSON body +* feature: CodeDeploy: Adds support for specifying Application Load Balancers in deployment groups, for both in-place and blue/green deployments. +* feature: CognitoIdentityServiceProvider: We have added support for features for Amazon Cognito User Pools that enable application developers to easily add and customize a sign-up and sign-in user experience, use OAuth 2.0, and integrate with Facebook, Google, Login with Amazon, and SAML-based identity providers. +* feature: EC2: Provides customers an opportunity to recover an EIP that was released + +## 2.96.0 +* feature: CloudDirectory: Enable BatchDetachPolicy +* feature: CodeBuild: Supporting Bitbucket as source type in AWS CodeBuild. + +## 2.95.0 +* bugfix: credentials: add typescript definition for resolvePromise() +* bugfix: typings: add readablestream type to clients that support streaming +* feature: ElasticBeanstalk: Add support for paginating the result of DescribeEnvironments Include the ARN of described environments in DescribeEnvironments output + +## 2.94.0 +* feature: CodeDeploy: AWS CodeDeploy now supports the use of multiple tag groups in a single deployment group (an intersection of tags) to identify the instances for a deployment. When you create or update a deployment group, use the new ec2TagSet and onPremisesTagSet structures to specify up to three groups of tags. Only instances that are identified by at least one tag in each of the tag groups are included in the deployment group. +* feature: ConfigService: Added new API, GetDiscoveredResourceCounts, which returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in the given region for your AWS account. +* feature: EC2: Ec2 SpotInstanceRequestFulfilled waiter update +* feature: ELBv2: Add TargetInService and TargetDeregistered waiters +* feature: Pinpoint: This release of the Pinpoint SDK enables App management - create, delete, update operations, Raw Content delivery for APNs and GCM campaign messages and From Address override. +* feature: SES: This update adds information about publishing email open and click events. This update also adds information about publishing email events to Amazon Simple Notification Service (Amazon SNS). + +## 2.93.0 +* feature: DynamoDB: Add a `wrapNumbers` option to the Document Client to direct the client not to convert number attributes to JavaScript numbers. +* feature: Inspector: Inspector's StopAssessmentRun API has been updated with a new input option - stopAction. This request parameter can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value, and the previous behavior) stops the AWS agent data collection and begins the results evaluation for findings generation based on the data collected so far. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated. +* feature: SSM: Adds a SendAutomationSignal API to SSM Service. This API is used to send a signal to an automation execution to change the current behavior or status of the execution. + +## 2.92.0 +* feature: EC2: The CreateDefaultVPC API enables you to create a new default VPC . You no longer need to contact AWS support, if your default VPC has been deleted. +* feature: KinesisAnalytics: Added additional exception types and clarified documentation. + +## 2.91.0 +* feature: CloudWatch: This release adds high resolution features to CloudWatch, with support for Custom Metrics down to 1 second and Alarms down to 10 seconds. +* feature: EC2: Amazon EC2 Elastic GPUs allow you to easily attach low-cost graphics acceleration to current generation EC2 instances. With Amazon EC2 Elastic GPUs, you can configure the right amount of graphics acceleration to your particular workload without being constrained by fixed hardware configurations and limited GPU selection. + +## 2.90.0 +* feature: CloudDirectory: Cloud Directory adds support for additional batch operations. +* feature: CloudFormation: AWS CloudFormation StackSets enables you to manage stacks across multiple accounts and regions. + +## 2.89.0 +* feature: AppStream: Amazon AppStream 2.0 image builders and fleets can now access applications and network resources that rely on Microsoft Active Directory (AD) for authentication and permissions. This new feature allows you to join your streaming instances to your AD, so you can use your existing AD user management tools. +* feature: EC2: Spot Fleet tagging capability allows customers to automatically tag instances launched by Spot Fleet. You can use this feature to label or distinguish instances created by distinct Spot Fleets. Tagging your EC2 instances also enables you to see instance cost allocation by tag in your AWS bill. + +## 2.88.0 +* feature: EMR: Amazon EMR now includes the ability to use a custom Amazon Linux AMI and adjustable root volume size when launching a cluster. + +## 2.87.0 +* feature: Budgets: Update budget Management API's to list/create/update RI_UTILIZATION type budget. Update budget Management API's to support DAILY timeUnit for RI_UTILIZATION type budget. + +## 2.86.0 +* feature: CognitoIdentityServiceProvider: Allows developers to configure user pools for email/phone based signup and sign-in. +* feature: Lambda: Lambda@Edge lets you run code closer to your end users without provisioning or managing servers. With Lambda@Edge, your code runs in AWS edge locations, allowing you to respond to your end users at the lowest latency. Your code is triggered by Amazon CloudFront events, such as requests to and from origin servers and viewers, and it is ready to execute at every AWS edge location whenever a request for content is received. You just upload your Node.js code to AWS Lambda and Lambda takes care of everything required to run and scale your code with high availability. You only pay for the compute time you consume - there is no charge when your code is not running. + +## 2.85.0 +* feature: Discovery: Adding feature to the Export API for Discovery Service to allow filters for the export task to allow export based on per agent id. +* feature: EC2: New EC2 GPU Graphics instance + +## 2.84.0 +* bugfix: S3: Updates S3 client to no longer attempt to determine a bucket's region when a request is aborted. +* feature: APIGateway: Adds support for management of gateway responses. +* feature: EC2: X-ENI (or Cross-Account ENI) is a new feature that allows the attachment or association of Elastic Network Interfaces (ENI) between VPCs in different AWS accounts located in the same availability zone. With this new capability, service providers and partners can deliver managed solutions in a variety of new architectural patterns where the provider and consumer of the service are in different AWS accounts. + +## 2.83.0 +* feature: AutoScaling: Auto Scaling now supports a new type of scaling policy called target tracking scaling policies that you can use to set up dynamic scaling for your application. + +## 2.82.0 +* feature: DirectoryService: You can now improve the resilience and performance of your Microsoft AD directory by deploying additional domain controllers. Added UpdateNumberofDomainControllers API that allows you to update the number of domain controllers you want for your directory, and DescribeDomainControllers API that allows you to describe the detailed information of each domain controller of your directory. Also added the 'DesiredNumberOfDomainControllers' field to the DescribeDirectories API output for Microsoft AD. +* feature: KMS: This release of AWS Key Management Service introduces the ability to determine whether a key is AWS managed or customer managed. +* feature: Kinesis: You can now encrypt your data at rest within an Amazon Kinesis Stream using server-side encryption. Server-side encryption via AWS KMS makes it easy for customers to meet strict data management requirements by encrypting their data at rest within the Amazon Kinesis Streams, a fully managed real-time data processing service. +* feature: SSM: Amazon EC2 Systems Manager now expands Patching support to Amazon Linux, Red Hat and Ubuntu in addition to the already supported Windows Server. + +## 2.81.0 +* bugfix: Core: The SDK will now throw an InvalidHeader error when a header's value is not stringifiable. See #1598. +* bugfix: apigateway: ApiGateway.getExports will no longer override user-supplied 'accepts' with 'application/json' +* feature: CloudWatch: We are excited to announce the availability of APIs and CloudFormation support for CloudWatch Dashboards. You can use the new dashboard APIs or CloudFormation templates to dynamically build and maintain dashboards to monitor your infrastructure and applications. There are four new dashboard APIs - PutDashboard, GetDashboard, DeleteDashboards, and ListDashboards APIs. PutDashboard is used to create a new dashboard or modify an existing one whereas GetDashboard is the API to get the details of a specific dashboard. ListDashboards and DeleteDashboards are used to get the names or delete multiple dashboards respectively. Getting started with dashboard APIs is similar to any other AWS APIs. The APIs can be accessed through AWS SDK or through CLI tools. +* feature: Route53: Bug fix for InvalidChangeBatch exception. + +## 2.80.0 +* feature: S3: API Update for S3: Adding Object Tagging Header to MultipartUpload Initialization + +## 2.79.0 +* bugfix: LexRuntime: Adds support for non-file streams as an input to postContent. +* feature: CloudWatchEvents: CloudWatch Events now allows different AWS accounts to share events with each other through a new resource called event bus. Event buses accept events from AWS services, other AWS accounts and PutEvents API calls. Currently all AWS accounts have one default event bus. To send events to another account, customers simply write rules to match the events of interest and attach an event bus in the receiving account as the target to the rule. The PutTargets API has been updated to allow adding cross account event buses as targets. In addition, we have released two new APIs - PutPermission and RemovePermission - that enables customers to add/remove permissions to their default event bus. +* feature: GameLift: Allow developers to download GameLift fleet creation logs to assist with debugging. +* feature: SSM: Adding Resource Data Sync support to SSM Inventory. New APIs: * CreateResourceDataSync - creates a new resource data sync configuration, * ListResourceDataSync - lists existing resource data sync configurations, * DeleteResourceDataSync - deletes an existing resource data sync configuration. + +## 2.78.0 +* feature: ServiceCatalog: Proper tagging of resources is critical to post-launch operations such as billing, cost allocation, and resource management. By using Service Catalog's TagOption Library, administrators can define a library of re-usable TagOptions that conform to company standards, and associate these with Service Catalog portfolios and products. Learn how to move your current tags to the new library, create new TagOptions, and view and associate your library items with portfolios and products. Understand how to ensure that the right tags are created on products launched through Service Catalog and how to provide users with defined selectable tags. + +## 2.77.0 +* feature: Lambda: The Lambda Invoke API will now throw new exception InvalidRuntimeException (status code 502) for invokes with deprecated runtimes. + +## 2.76.0 +* feature: CodePipeline: A new API, ListPipelineExecutions, enables you to retrieve summary information about the most recent executions in a pipeline, including pipeline execution ID, status, start time, and last updated time. You can request information for a maximum of 100 executions. Pipeline execution data is available for the most recent 12 months of activity. +* feature: DMS: Added tagging for DMS certificates. +* feature: ELB: Add retry error state to InstanceInService waiter for ElasticLoadBalancer +* feature: Lightsail: This release adds a new nextPageToken property to the result of the GetOperationsForResource API. Developers can now get the next set of items in a list by making subsequent calls to GetOperationsForResource API with the token from the previous call. This release also deprecates the nextPageCount property, which previously returned null (use the nextPageToken property instead). This release also deprecates the customImageName property on the CreateInstancesRequest class, which was previously ignored by the API. +* feature: Route53: This release reintroduces the HealthCheckInUse exception. + +## 2.75.0 +* feature: DAX: Amazon DynamoDB Accelerator (DAX) is a fully managed, highly available, in-memory cache for DynamoDB that delivers up to a 10x performance improvement - from milliseconds to microseconds - even at millions of requests per second. DAX does all the heavy lifting required to add in-memory acceleration to your DynamoDB tables, without requiring developers to manage cache invalidation, data population, or cluster management. +* feature: Route53: Amazon Route 53 now supports multivalue answers in response to DNS queries, which lets you route traffic approximately randomly to multiple resources, such as web servers. Create one multivalue answer record for each resource and, optionally, associate an Amazon Route 53 health check with each record, and Amazon Route 53 responds to DNS queries with up to eight healthy records. +* feature: S3: Allows forward slashes in Bucket names when using SigV4 to create or retrieve objects. This is to maintain compatibility with behavior when using SigV2. In new code, Buckets should not contain forward slashes. Instead, directories should be part of an object's key. +* feature: SSM: Adding hierarchy support to the SSM Parameter Store API. Added support tor tagging. New APIs: GetParameter - retrieves one parameter, DeleteParameters - deletes multiple parameters (max number 10), GetParametersByPath - retrieves parameters located in the hierarchy. Updated APIs: PutParameter - added ability to enforce parameter value by applying regex (AllowedPattern), DescribeParameters - modified to support Tag filtering. +* feature: WAFRegional: You can now create, edit, update, and delete a new type of WAF rule with a rate tracking component. + +## 2.74.0 +* feature: WorkDocs: This release provides a new API to retrieve the activities performed by WorkDocs users. + +## 2.73.0 +* feature: Organizations: Improvements to Exception Modeling + +## 2.72.0 +* feature: XRay: Add a response time histogram to the services in response of GetServiceGraph API. + +## 2.71.0 +* feature: DynamoDB: Adds two new functions to the AWS.DynamoDB.Converter namespace: one to convert full DynamoDB items (such as what you might receive for events in a DynamoDB stream) into plain vanilla JavaScript objects and one to convert JavaScript objects back into DynamoDB items +* feature: EC2: Adds API to describe Amazon FPGA Images (AFIs) available to customers, which includes public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions. +* feature: ECS: Added support for cpu, memory, and memory reservation container overrides on the RunTask and StartTask APIs. +* feature: Iot: Revert the last release: remove CertificatePem from DescribeCertificate API. +* feature: ServiceCatalog: Added ProvisioningArtifactSummaries to DescribeProductAsAdmin's output to show the provisioning artifacts belong to the product. Allow filtering by SourceProductId in SearchProductsAsAdmin for AWS Marketplace products. Added a verbose option to DescribeProvisioningArtifact to display the CloudFormation template used to create the provisioning artifact.Added DescribeProvisionedProduct API. Changed the type of ProvisionedProduct's Status to be distinct from Record's Status. New ProvisionedProduct's Status are AVAILABLE, UNDER_CHANGE, TAINTED, ERROR. Changed Record's Status set of values to CREATED, IN_PROGRESS, IN_PROGRESS_IN_ERROR, SUCCEEDED, FAILED. + +## 2.70.0 +* feature: ApplicationAutoScaling: Application Auto Scaling now supports automatic scaling of read and write throughput capacity for DynamoDB tables and global secondary indexes. + +## 2.69.0 +* feature: ConfigService: With this release AWS Config supports the Amazon CloudWatch alarm resource type. + +## 2.68.0 +* feature: RDS: API Update for RDS: this update enables copy-on-write, a new Aurora MySQL Compatible Edition feature that allows users to restore their database, and support copy of TDE enabled snapshot cross region. +* feature: S3: Switches S3 to use signatureVersion "v4" by default. To continue using signatureVersion "v2", set the signatureVersion: "v2" option in the S3 service client configuration. Presigned URLs will continue using "v2" by default. + +## 2.67.0 +* feature: EFS: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: OpsWorks: Tagging Support for AWS OpsWorks Stacks + +## 2.66.0 +* feature: Iot: In addition to using certificate ID, AWS IoT customers can now obtain the description of a certificate with the certificate PEM. +* feature: Pinpoint: Starting today Amazon Pinpoint adds SMS Text and Email Messaging support in addition to Mobile Push Notifications, providing developers, product managers and marketers with multi-channel messaging capabilities to drive user engagement in their applications. Pinpoint also enables backend services and applications to message users directly and provides advanced user and app analytics to understand user behavior and messaging performance. +* feature: Rekognition: API Update for AmazonRekognition: Adding RecognizeCelebrities API + +## 2.65.0 +* feature: CodeBuild: Add support to APIs for privileged containers. This change would allow performing privileged operations like starting the Docker daemon inside builds possible in custom docker images. +* feature: Greengrass: AWS Greengrass is software that lets you run local compute, messaging, and device state synchronization for connected devices in a secure way. With AWS Greengrass, connected devices can run AWS Lambda functions, keep device data in sync, and communicate with other devices securely even when not connected to the Internet. Using AWS Lambda, Greengrass ensures your IoT devices can respond quickly to local events, operate with intermittent connections, and minimize the cost of transmitting IoT data to the cloud. + +## 2.64.0 +* bugfix: S3: Calling send multiple times on an S3 ManagedUpload with leavePartsOnError set to true should no longer result in truncated files being uploaded to S3. Calling send multiple times is not supported with streams. +* feature: Iot: Update client side validation for SalesForce action. + +## 2.63.0 +* feature: AppStream: AppStream 2.0 Custom Security Groups allows you to easily control what network resources your streaming instances and images have access to. You can assign up to 5 security groups per Fleet to control the inbound and outbound network access to your streaming instances to specific IP ranges, network protocols, or ports. +* feature: AutoScaling: Autoscaling resource model update. +* feature: Iot: Added Salesforce action to IoT Rules Engine. + +## 2.62.0 +* feature: KinesisAnalytics: Kinesis Analytics publishes error messages CloudWatch logs in case of application misconfigurations +* feature: WorkDocs: This release includes new APIs to manage tags and custom metadata on resources and also new APIs to add and retrieve comments at the document level. + +## 2.61.0 +* feature: CodeDeploy: AWS CodeDeploy has improved how it manages connections to GitHub accounts and repositories. You can now create and store up to 25 connections to GitHub accounts in order to associate AWS CodeDeploy applications with GitHub repositories. Each connection can support multiple repositories. You can create connections to up to 25 different GitHub accounts, or create more than one connection to a single account. The ListGitHubAccountTokenNames command has been introduced to retrieve the names of stored connections to GitHub accounts that you have created. The name of the connection to GitHub used for an AWS CodeDeploy application is also included in the ApplicationInfo structure. Two new fields, lastAttemptedDeployment and lastSuccessfulDeployment, have been added to DeploymentGroupInfo to improve the handling of deployment group information in the AWS CodeDeploy console. Information about these latest deployments can also be retrieved using the GetDeploymentGroup and BatchGetDeployment group requests. Also includes a region update (us-gov-west-1). +* feature: CognitoIdentityServiceProvider: Added support within Amazon Cognito User Pools for 1) a customizable hosted UI for user sign up and sign in and 2) integration of external identity providers. +* feature: ELBv2: Update the existing DescribeRules API to support pagination. + +## 2.60.0 +* bugfix: Core: Fixes issue where some TimeStamp shapes had an incorrect timestampFormat. Specifically affects S3.putBucketLifecycleConfiguration when using Date fields. +* feature: RDS: Amazon RDS customers can now easily and quickly stop and start their DB instances. + +## 2.59.0 +* bugfix: S3: Update ManagedUploader body verification to allow empty strings +* feature: CloudDirectory: Cloud Directory has launched support for Typed Links, enabling customers to create object-to-object relationships that are not hierarchical in nature. Typed Links enable customers to quickly query for data along these relationships. Customers can also enforce referential integrity using Typed Links, ensuring data in use is not inadvertently deleted. + +## 2.58.0 +* feature: AppStream: Support added for persistent user storage, backed by S3. +* feature: Rekognition: Updated the CompareFaces API response to include orientation information, unmatched faces, landmarks, pose, and quality of the compared faces. + +## 2.57.0 +* feature: IAM: The unique ID and access key lengths were extended from 32 to 128 +* feature: STS: The unique ID and access key lengths were extended from 32 to 128. +* feature: StorageGateway: Two Storage Gateway data types, Tape and TapeArchive, each have a new response element, TapeUsedInBytes. This element helps you manage your virtual tapes. By using TapeUsedInBytes, you can see the amount of data written to each virtual tape. + +## 2.56.0 +* feature: DMS: This release adds support for using Amazon S3 and Amazon DynamoDB as targets for database migration, and using MongoDB as a source for database migration. For more information, see the AWS Database Migration Service documentation. + +## 2.55.0 +* bugfix: ReactNative: Requests will always have a Content-Type header if they also have a body. Works around an issue caused by React Native's Android XMLHttpRequest implementation that requires the Content-Type header to be present if there is a request body. +* feature: ResourceGroupsTaggingAPI: You can now specify the number of resources returned per page in GetResources operation, as an optional parameter, to easily manage the list of resources returned by your queries. + +## 2.54.0 +* feature: Athena: This release adds support for Amazon Athena. Amazon Athena is an interactive query service that makes it easy to analyze data in Amazon S3 using standard SQL. Athena is serverless, so there is no infrastructure to manage, and you pay only for the queries that you run. +* feature: Lightsail: This release adds new APIs that make it easier to set network port configurations on Lightsail instances. Developers can now make a single request to both open and close public ports on an instance using the PutInstancePublicPorts operation. + +## 2.53.0 +* feature: Polly: Amazon Polly adds new German voice "Vicki" + +## 2.52.0 +* feature: CodeDeploy: This release introduces the previousRevision field in the responses to the GetDeployment and BatchGetDeployments actions. previousRevision provides information about the application revision that was deployed to the deployment group before the most recent successful deployment. Also, the fileExistsBehavior parameter has been added for CreateDeployment action requests. In the past, if the AWS CodeDeploy agent detected files in a target location that weren't part of the application revision from the most recent successful deployment, it would fail the current deployment by default. This new parameter provides options for how the agent handles these files: fail the deployment, retain the content, or overwrite the content. +* feature: GameLift: Allow developers to specify how metrics are grouped in CloudWatch for their GameLift fleets. Developers can also specify how many concurrent game sessions activate on a per-instance basis. +* feature: Inspector: Adds ability to produce an assessment report that includes detailed and comprehensive results of a specified assessment run. + +## 2.51.0 +* feature: SSM: UpdateAssociation API now supports updating document name and targets of an association. GetAutomationExecution API can return FailureDetails as an optional field to the StepExecution Object, which contains failure type, failure stage as well as other failure related information for a failed step. + +## 2.50.0 +* bugfix: ReactNative: Fixes issue where binary responses were empty in iOS (e.g. s3.getObject) +* feature: ELB: Add a new API to allow customers to describe their account limits, such as load balancer limit, target group limit etc. +* feature: ELBv2: Add a new API to allow customers to describe their account limits, such as load balancer limit, target group limit etc. +* feature: LexModelBuildingService: Releasing new DeleteBotVersion, DeleteIntentVersion and DeleteSlotTypeVersion APIs. +* feature: Organizations: AWS Organizations APIs that return an Account object now include the email address associated with the account’s root user. +* bugfix: Request: Updates node.js request handling to obey socket read timeouts after response headers have been received. Previously timeouts were being ignored once headers were received, sometimes causing connections to hang. + +## 2.49.0 +* feature: ECS: Exposes container instance registration time in ECS:DescribeContainerInstances. +* feature: Lambda: Support for UpdateFunctionCode DryRun option +* feature: MarketplaceEntitlementService: AWS Marketplace Entitlement Service enables AWS Marketplace sellers to determine the capacity purchased by their customers. + +## 2.48.0 +* feature: CloudFormation: Adding back the removed waiters and paginators. + +## 2.47.0 +* feature: CloudFormation: API update for CloudFormation: New optional parameter ClientRequestToken which can be used as an idempotency token to safely retry certain operations as well as tagging StackEvents. +* feature: RDS: The DescribeDBClusterSnapshots API now returns a SourceDBClusterSnapshotArn field which identifies the source DB cluster snapshot of a copied snapshot. +* feature: React Native: Adds support for running the SDK in React Native. See the README for instructions. +* feature: Rekognition: Fix for missing file type check +* feature: SQS: Adding server-side encryption (SSE) support to SQS by integrating with AWS KMS; adding new queue attributes to SQS CreateQueue, SetQueueAttributes and GetQueueAttributes APIs to support SSE. +* feature: Snowball: The Snowball API has a new exception that can be thrown for list operation requests. + +## 2.46.0 +* bugfix: SharedIniFileCredentials: This fix reverts a regression introduced in version 2.44.0 in which the value returned by os.homedir would be used in preference over the value of the HOME environment variable +* feature: RDS: With Amazon Relational Database Service (Amazon RDS) running MySQL or Amazon Aurora, you can now authenticate to your DB instance using IAM database authentication. +* feature: RDS: Adds AWS.RDS.Signer class to generate auth tokens for connecting to a database. + +## 2.45.0 +* bugfix: Promise: Fixes an issue introduced in v2.44.0 where payload members on some CloudFront and S3 operations weren't hoisted when using promises. This issue was introduced in and could affect users that were accessing fields on a response that weren't documented, but were available for backwards compatibility. +* bugfix: Request: Make `$response` property of resolved promise value non-enumerable to prevent serialization errors +* feature: AppStream: The new feature named "Default Internet Access" will enable Internet access from AppStream 2.0 instances - image builders and fleet instances. Admins will check a flag either through AWS management console for AppStream 2.0 or through API while creating an image builder or while creating/updating a fleet. +* feature: Kinesis: Adds a new waiter, StreamNotExists, to Kinesis. + +## 2.44.0 +* feature: DeviceFarm: API Update for AWS Device Farm: Support for Deals and Promotions +* feature: ELBv2: Adding LoadBalancersDeleted waiter for Elasticloadbalancingv2 +* feature: EnvironmentVariable: Load config from ~/.aws/config if AWS_SDK_LOAD_CONFIG is set +* feature: EnvironmentVariable: Add support for specifying the location of the shared config file via the AWS_CONFIG_FILE environment variable. This variable is only honored if AWS_SDK_LOAD_CONFIG is set to a truthy value. +* feature: EnvironmentVariable: Add support for the AWS_SHARED_CREDENTIALS_FILE environment variable if AWS_SDK_LOAD_CONFIG is set +* feature: Promises: Binds response object to the data object with which successful request promises are resolved + +## 2.43.0 +* feature: APIGateway: Add support for "embed" property. +* feature: CodeStar: AWS CodeStar is a cloud-based service for creating, managing, and working with software development projects on AWS. An AWS CodeStar project creates and integrates AWS services for your project development toolchain. AWS CodeStar also manages the permissions required for project users. +* feature: EC2: Adds support for creating an Amazon FPGA Image (AFI) from a specified design checkpoint (DCP). +* feature: IAM: This changes introduces a new IAM role type, Service Linked Role, which works like a normal role but must be managed via services' control. +* feature: Lambda: Lambda integration with CloudDebugger service to enable customers to enable tracing for the Lambda functions and send trace information to the CloudDebugger service. +* feature: LexModelBuildingService: Amazon Lex is a service for building conversational interfaces into any application using voice and text. +* feature: Polly: API Update for Amazon Polly: Add support for speech marks +* feature: Rekognition: Given an image, the API detects explicit or suggestive adult content in the image and returns a list of corresponding labels with confidence scores, as well as a taxonomy (parent-child relation) for each label. + +## 2.42.0 +* bugfix: Parser: Makes casting payload blobs to strings an exceptional behavior rather than the default +* feature: Lambda: You can use tags to group and filter your Lambda functions, making it easier to analyze them for billing allocation purposes. For more information, see Tagging Lambda Functions. You can now write or upgrade your Lambda functions using Python version 3.6. For more information, see Programming Model for Authoring Lambda Functions in Python. Note: Features will be rolled out in the US regions on 4/19. + +## 2.41.0 +* feature: APIGateway: API Gateway request validators +* feature: Batch: API Update for AWS Batch: Customer provided AMI for MANAGED Compute Environment +* feature: GameLift: Allows developers to utilize an improved workflow when calling our Queues API and introduces a new feature that allows developers to specify a maximum allowable latency per Queue. +* feature: OpsWorks: Cloudwatch Logs agent configuration can now be attached to OpsWorks Layers using CreateLayer and UpdateLayer. OpsWorks will then automatically install and manage the CloudWatch Logs agent on the instances part of the OpsWorks Layer. + +## 2.40.0 +* feature: Redshift: This update adds the GetClusterCredentials API which is used to get temporary login credentials to the cluster. AccountWithRestoreAccess now has a new member AccountAlias, this is the identifier of the AWS support account authorized to restore the specified snapshot. This is added to support the feature where the customer can share their snapshot with the Amazon Redshift Support Account without having to manually specify the AWS Redshift Service account ID on the AWS Console/API. + +## 2.39.0 +* feature: ElastiCache: ElastiCache added support for testing the Elasticache Multi-AZ feature with Automatic Failover. +* feature: Http: Adds a connectTimeout option that allows slow-to-establish socket connections to be quickly abandoned + +## 2.38.0 +* feature: CloudWatch: Amazon Web Services announced the immediate availability of two additional alarm configuration rules for Amazon CloudWatch Alarms. The first rule is for configuring missing data treatment. Customers have the options to treat missing data as alarm threshold breached, alarm threshold not breached, maintain alarm state and the current default treatment. The second rule is for alarms based on percentiles metrics that can trigger unnecassarily if the percentile is calculated from a small number of samples. The new rule can treat percentiles with low sample counts as same as missing data. If the first rule is enabled, the same treatment will be applied when an alarm encounters a percentile with low sample counts. + +## 2.37.0 +* feature: LexRuntime: Adds support to PostContent for speech input + +## 2.36.0 +* feature: CloudDirectory: ListObjectAttributes now supports filtering by facet. + +## 2.35.0 +* feature: CloudFormation: Adding paginators for ListExports and ListImports +* feature: CloudFront: Amazon CloudFront now supports user configurable HTTP Read and Keep-Alive Idle Timeouts for your Custom Origin Servers +* feature: ResourceGroupsTaggingAPI: Resource Groups Tagging APIs can help you organize your resources and enable you to simplify resource management, access management, and cost allocation. +* feature: StorageGateway: File gateway mode in AWS Storage gateway provides access to objects in S3 as files on a Network File System (NFS) mount point. Once a file share is created, any changes made externally to the S3 bucket will not be reflected by the gateway. Using the cache refresh feature in this update, the customer can trigger an on-demand scan of the keys in their S3 bucket and refresh the file namespace cached on the gateway. It takes as an input the fileShare ARN and refreshes the cache for only that file share. Additionally there is new functionality on file gateway that allows you configure what squash options they would like on their file share, this allows a customer to configure their gateway to not squash root permissions. This can be done by setting options in NfsOptions for CreateNfsFileShare and UpdateNfsFileShare APIs. + +## 2.34.0 +* features: Batch: Customers can now provide a retryStrategy as part of the RegisterJobDefinition and SubmitJob API calls. +* features: EC2: Customers can now tag their Amazon EC2 Instances and Amazon EBS Volumes at the time of their creation. + +## 2.33.0 +* feature: core: Adds support for 'v4' and 'v4-unsigned-body' authtype traits. +* bugfix: ManagedUpload: Ensures multi-part upload locations are URI-decoded to match single-part upload locations. + +## 2.32.0 +* feature: S3: Adds a means of specifying tags to apply to objects of any size uploaded with AWS.S3.ManagedUploader +* feature: ApplicationAutoScaling: Application AutoScaling is launching support for a new target resource (AppStream 2.0 Fleets) as a scalable target. + +## 2.31.0 +* feature: DynamoDB: Adds ability to customize retry delays for DynamoDB. This previously worked for all services except DynamoDB. Also adds jitter to DynamoDB retries. See `AWS.Config.retryDelayOptions` for more information. +* feature: Waiter: Allow customization of a waiter using a special `$waiter` key +* feature: Lambda: Adds support for new runtime Node.js v6.10 for AWS Lambda service. :tada: +* feature: ELBv2: Adding waiters for Elastic Load Balancing V2 +* feature: Discovery: Adds export configuration options to the API. + +## 2.30.0 +* feature: DynamoDb: Allow objects with inheritance chains to be converted to MapAttributeValues instead of undefined +* bugfix: CredentialsError: Update AWS.Config.getCredentials to overwrite the name (in addition to message and code) of errors thrown by underlying credential providers. + +## 2.29.0 +* feature: protocol: The SDK can now support JSON-value string shapes in headers +* feature: Pinpoint: Added ability to segment endpoints by user attributes in addition to endpoint attributes. +* feature: Pinpoint: Added functionality to publish raw app analytics and campaign events data as events streams to Kinesis and Kinesis Firehose. +* feature: ELBv2: Adding waiters for LoadBalancers in ELBv2. +* feature: MarketplaceCommerceAnalytics: This update adds a new data set, us_sales_and_use_tax_records, which enables AWS Marketplace sellers to programmatically access to their U.S. Sales and Use Tax report data. + +## 2.28.0 +* feature: DeviceFarm: Network shaping allows users to simulate network connections and conditions while testing their Android, iOS, and web apps with AWS Device Farm. +* feature: CloudWatchEvents: This update extends Target Data Type for configuring Target behavior during invocation. + +## 2.27.0 +* bugfix: TemporaryCredentials: Ensure master credentials are not expired before using them to refresh temporary credentials +* feature: CodeDeploy: Add paginators for Codedeploy +* feature: EMR: This release includes support for instance fleets in Amazon EMR + +## 2.26.0 +* feature: APIGateway: API Gateway has added support for ACM certificates on custom domain names. Both Amazon-issued certificates and uploaded third-part certificates are supported. +* feature: CloudDirectory: Introduces a new Cloud Directory API that enables you to retrieve all available parent paths for any type of object (a node, leaf node, policy node, and index node) in a hierarchy. + +## 2.25.0 +* feature: WorkDocs: Amazon WorkDocs API provides full administrator level access to WorkDocs site resources, allowing developers to integrate their applications to manage WorkDocs users, content and permissions programmatically. + +## 2.24.0 +* feature: RDS: Add support to using encrypted clusters as cross-region replication masters. Update CopyDBClusterSnapshot API to support encrypted cross region copy of Aurora cluster snapshots. + +## 2.23.0 +* feature: Budgets: When creating or editing a budget via the AWS Budgets API you can define notifications that are sent to subscribers when the actual or forecasted value for cost or usage exceeds the notificationThreshold associated with the budget notification object. Starting today, the maximum allowed value for the notificationThreshold was raised from 100 to 300. This change was made to give you more flexibility when setting budget notifications. +* feature: OpsWorksCM: OpsWorks for Chef Automate has added a new field "AssociatePublicIpAddress" to the CreateServer request, "CloudFormationStackArn" to the Server model and "TERMINATED" server state. + +## 2.22.0 +* bugfix: MechanicalTurkRequester: Rename MechanicalTurkRequester to MTurk + +## 2.21.0 +* feature: DynamoDB: Time to Live (TTL) is a feature that allows you to define when items in a table expire and can be purged from the database, so that you don't have to track expired data and delete it manually. With TTL enabled on a DynamoDB table, you can set a timestamp for deletion on a per-item basis, allowing you to limit storage usage to only those records that are relevant. +* feature: DynamoDBStreams: Time to Live (TTL) is a feature that allows you to define when items in a table expire and can be purged from the database, so that you don't have to track expired data and delete it manually. With TTL enabled on a DynamoDB table, you can set a timestamp for deletion on a per-item basis, allowing you to limit storage usage to only those records that are relevant. +* feature: IAM: This release adds support for AWS Organizations service control policies (SCPs) to SimulatePrincipalPolicy operation. If there are SCPs associated with the simulated user's account, their effect on the result is captured in the OrganizationDecisionDetail element in the EvaluationResult. +* feature: MechanicalTurkRequester: Amazon Mechanical Turk is a web service that provides an on-demand, scalable, human workforce to complete jobs that humans can do better than computers, for example, recognizing objects in photos. +* feature: Organizations: AWS Organizations is a web service that enables you to consolidate your multiple AWS accounts into an organization and centrally manage your accounts and their resources. + +## 2.20.0 +* feature: ES: Added three new API calls to expose Amazon Elasticsearch imposed limits. + +## 2.19.0 +* bugfix: XHR: Fixes an issue where the callback provided to an operation would not fire if a request was aborted after being sent. The bug only affected the browser SDK. +* feature: S3: Added an instance method to S3 clients to create POST form data with presigned upload policies +* feature: DynamoDB: Expose DynamoDB DocumentClient marshaller/unmarshaller as AWS.DynamoDB.Converter + +## 2.18.0 +* feature: GameLift: Allow developers to configure global queues for creating GameSessions. Allow PlayerData on PlayerSessions to store player-specific data. +* feature: Route53: Added support for operations CreateVPCAssociationAuthorization and DeleteVPCAssociationAuthorization to throw a ConcurrentModification error when a conflicting modification occurs in parallel to the authorizations in place for a given hosted zone. +* feature: ElasticBeanstalk: Elastic Beanstalk adds support for creating and managing custom platform. + +## 2.17.0 +* bugfix: TypeScript: Enable the configuration credentials to be nulled so that the global config is not used. +* feature: EC2: Added the billingProduct parameter to the RegisterImage API. + +## 2.16.0 +* feature: DirectConnect: This update will introduce the ability for Direct Connect customers to take advantage of Link Aggregation (LAG). This allows you to bundle many individual physical interfaces into a single logical interface, referred to as a LAG. This makes administration much simpler as the majority of configuration is done on the LAG while you are free to add or remove physical interfaces from the bundle as bandwidth demand increases or decreases. A concrete example of the simplification added by LAG is that customers need only a single BGP session as opposed to one session per physical connection. + +## 2.15.0 +* feature: CognitoIdentity: Allows createIdentityPool and updateIdentityPool API to set server side token check value on identity pool. +* feature: ConfigService: AWS Config now supports a new test mode for the PutEvaluations API. Set the TestMode parameter to true in your custom rule to verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config. + +## 2.14.0 +* feature: KMS: This release of AWS Key Management Service introduces the ability to tag keys. Tagging keys can help you organize your keys and track your KMS costs in the cost allocation report. This release also increases the maximum length of a key ID to accommodate ARNs that include a long key alias. + +## 2.13.0 +* feature: Ec2: Adds support for the new Modify Volumes apis. + +## 2.12.0 +* feature: StorageGateway: File gateway mode in AWS Storage gateway provides access to objects in S3 as files on a Network File System (NFS) mount point. This is done by creating Nfs file shares using existing APIs CreateNfsFileShare. Using the feature in this update, the customer can restrict the clients that have read/write access to the gateway by specifying the list of clients as a list of IP addresses or CIDR blocks. This list can be specified using the API CreateNfsFileShare while creating new file shares, or UpdateNfsFileShare while update existing file shares. To find out the list of clients that have access, the existing API DescribeNfsFileShare will now output the list of clients that have access. + +## 2.11.0 +* bugfix: TypeScript: Add `endpoint` property to AWS.S3 instance declaration. +* feature: EC2: This feature allows customers to associate an IAM profile to running instances that do not have any. +* feature: Rekognition: DetectFaces and IndexFaces operations now return an estimate of the age of the face as an age range. + +## 2.10.0 +* bugfix: JSON: Fixes issue caused when trying to unmarshall null binary shapes. +* bugfix: TypeScript: Add `credentialProvider` as an optional parameter of `ConfigurationOptions`. +* feature: LexRuntime: Amazon Lex is a service for building conversational interactions into any application using voice or text. + +## 2.9.0 +* feature: EC2: Adds instance health check functionality to replace unhealthy EC2 Spot fleet instances with fresh ones +* feature: CloudDirectory: Amazon Cloud Directory is a highly scalable, high performance, multi-tenant directory service in the cloud. Its web-based directories make it easy for you to organize and manage application resources such as users, groups, locations, devices, policies, and the rich relationships between them. +* feature: CodeDeploy: This release of AWS CodeDeploy introduces support for blue/green deployments. In a blue/green deployment, the current set of instances in a deployment group is replaced by new instances that have the latest application revision installed on them. After traffic is rerouted behind a load balancer to the replacement instances, the original instances can be terminated automatically or kept running for other uses. +* feature: RDS: Added support for the `ModifyDBSnapshot` and `ModifyDBSnapshotMessage` operations + +## 2.8.0 +* bugfix: RDS: Fixes issue wherein the wrong parameter name was used for cross region presigned urls. +* feature: ELBv2: Application Load Balancers now support native Internet Protocol version 6 (IPv6) in an Amazon Virtual Private Cloud (VPC). With this ability, clients can now connect to the Application Load Balancer in a dual-stack mode via either IPv4 or IPv6. +* feature: RDS: Adds cross region read replica copying. + +## 2.7.28 +* feature: CognitoIdentityCredentials: Adds `clientConfig` as an optional parameter to the `CognitoIdentityCredentials` constructor. This parameter can be used to pass in client configuration to the underlying service clients. +* feature: TemporaryCredentials: Allows passing of master credentials to the TemporaryCredentials provider. +* feature: CodeCommit: Added new API to list the different files between 2 commits +* feature: ECS: Amazon ECS now supports a state for container instances that can be used to drain a container instance in preparation for maintenance or cluster scale down. + +## 2.7.27 +* bugfix: Performance: This change reverts a request body cast in the node HTTP handler that caused a performance regression. +* feature: ACM: Updated response elements for DescribeCertificate API in support of managed renewal. + +## 2.7.26 +* feature: EC2: Amazon EC2 Spot instances now support dedicated tenancy, providing the ability to run Spot instances single-tenant manner on physically isolated hardware within a VPC to satisfy security, privacy, or other compliance requirements. Dedicated Spot instances can be requested using RequestSpotInstances and RequestSpotFleet. + +## 2.7.25 +* feature: RDS: Updates AWS.RDS API to the latest version. + +## 2.7.24 +* bugfix: HTTP: Ensure that buffers are not created with Buffer.from in node 4.0-4.4 +* bugfix: core: Deprecate v2.7.23 + +## 2.7.23 +* bugfix: S3: Convert string bodies to buffers to ensure correct encoding is used +* feature: DynamoDB: Adds support for tagging tables and indexes. + +## 2.7.22 +* feature: CUR: The AWS Cost and Usage Report Service API allows you to enable and disable the Cost & Usage report, as well as modify the report name, the data granularity, and the delivery preferences. +* bugfix: DynamoDB.DocumentClient: Allows objects created using Object.create(null) to be properly serialized by the DDB document client. + +## 2.7.21 +* feature: ConfigService: Updates putConfigRule to support using/writing rules based on the OversizedConfigurationItemChangeNotification message type. +* feature: MarketplaceCommerceAnalytics: Added support for data set disbursed_amount_by_instance_hours, with historical data available starting 2012-09-04. New data is published to this data set every 30 days. +* bugfix: DynamoDB.DocumentClient: Fixes issue where empty strings in nested members were not removed when convertEmptyValues was set. +* bugfix: CognitoIdentityCredentials: Fixes issue where the cached identity id would sometimes not be retrieved when SDK is run while offline. + +## 2.7.20 +* feature: CodeDeploy: CodeDeploy supports IAM Session Arns in addition to IAM User Arns for on premise host authentication. +* feature: ECS: Amazon EC2 Container Service (ECS) now supports the ability to customize the placement of tasks on container instances. + +## 2.7.19 +* feature: APIGateway: This update introduces two new operations used to dynamically discover SDK types and what configuration each type accepts. +* feature: ElasticBeanstalk: Adds a new feature for managing Application Version Lifecycle. +* feature: IAM: Adds service-specific credentials to IAM service to make it easier to onboard CodeCommit customers. These are username/password credentials that work with a single service. + +## 2.7.18 +* feature: Rekognition: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: EC2: Adds cross region encrypted snapshot copying (CopyDBSnapshot). +* feature: ECR: Amazon ECR now implements Docker Image Manifest V2, Schema 2 providing the ability to use multiple tags per image, support for storing Windows container images, and compatibility with the Open Container Initiative (OCI) image format. With this update, customers can also add tags to an image via PutImage and delete tags using BatchDeleteImage. + +## 2.7.17 +* bugfix: Promises: Fixes issue introduced in v2.6.12. Calling AWS.config.setPromisesDependency(null) will once again force the SDK to use native promises if they are available. +* feature: Firehose: The processing feature enables users to process and modify records before Amazon Firehose delivers them to destinations. +* feature: StorageGateway: File gateway is a new mode in the AWS Storage Gateway that support a file interface into S3, alongside the current block-based volume and VTL storage. File gateway combines a service and virtual software appliance, enabling you to store and retrieve objects in Amazon S3 using industry standard file protocols such as NFS. The software appliance, or gateway, is deployed into your on-premises environment as a virtual machine (VM) running on VMware ESXi. The gateway provides access to objects in S3 as files on a Network File System (NFS) mount point. + +## 2.7.16 +* feature: DocumentClient: Add a constructor option to convert empty strings, sets, and binary strings to a Dynamo NULL typed field +* feature: Discovery: Adds new APIs to group discovered servers into Applications with get summary and neighbors. Includes additional filters for ListConfigurations and DescribeAgents API. +* feature: CognitoIdentity: Added fine-grained role-based access control for Cognito identity pools. Developers can configure an identity pool to get the IAM role from an authenticated user's token, or they can configure rules that will map a user to a different role + +## 2.7.15 +* bugfix: Buffer: Update base64 encode/decode to use Buffer.fill when available and throw an error if a number is provided. +* bugfix: XRay: Add X-Amzn-Trace-Id to list of unsigned headers to prevent signature mismatch errors if the header value is modified while the request is in flight. +* feature: Cognito: Add new regions and endpoints for Amazon Cognito Identity, Amazon Cognito Sync, and Amazon Cognito Identity Provider. +* feature: CognitoIdentityServiceProvider: User Pools now offers groups as an easy way to manage users and their permissions. +* feature: SSM: Add support for Patch Baseline and Patch Compliance APIs + +## 2.7.14 +* feature: Batch: AWS Batch is a batch computing service that lets customers define queues and compute environments and then submit work as batch jobs. +* feature: DMS: Adds support for SSL enabled Oracle endpoints and task modification. +* feature: CloudWatchLogs: Amazon CloudWatch announces detailed billing to CloudWatch Logs. You can now get usage and cost per log group. You can also add tags on your log groups to get a fine-grained view on cost for logs across business dimension such as cost center, application name, AWS services such as Lambda, CloudTrail, ECS, and other. Up to 50 tags can be added to each log group. + +## 2.7.13 +* feature: CloudFront: Add lambda function associations to cache behaviors. +* feature: RDS: Add cluster create data to DBCluster APIs. +* feature: WAFRegional: With this new feature, customers can use AWS WAF directly on Application Load Balancers in a VPC within available regions to protect their websites and web services from malicious attacks such as SQL injection, Cross Site Scripting, bad bots, etc. + +## 2.7.12 +* feature: S3: Add the Version ID field to the Get and Put object tagging operations. + +## 2.7.11 +* bugfix: TypeScript: Exposes typings for classes that live on service namespaces (i.e. DynamoDB.DocumentClient). Also exposes interfaces off of service namespaces to allow easier migration from some 3rd party typings. Interfaces will continue to be exposed via Service.Types as well. +* bugfix: TypeScript: Removes remaining `reference` comments from definitions. +* feature: ConfigService: Increases the number of config rules for all accounts from 25 to 50. +* feature: EC2: Adds T2.xlarge, T2.2xlarge, and R4 instance types. + +## 2.7.10 +* feature: APIGateway: You can now publish your APIs on Amazon API Gateway as products on the AWS Marketplace. Use the SDK to associate your APIs on API Gateway with Marketplace Product Codes. API Gateway will then send metering data to the Marketplace Metering Service on your behalf. Also, API Gateway now supports documenting your API. +* feature: Appstream: Announcing Amazon AppStream 2.0 - a secure, fully managed desktop application streaming service that provides users instant access to their apps from a web browser. +* feature: CodeBuild: AWS CodeBuild is a fully-managed build service in the cloud. CodeBuild compiles source code, runs tests, and produces packages that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. CodeBuild scales continuously and processes multiple builds concurrently, so your builds are never waiting in a queue. You can get started quickly with CodeBuild’s prepackaged build environments, or you can use custom build environments to use your own build tools. With CodeBuild, you only pay by the minute. +* feature: DirectConnect: API Update for IPv6 for Direct Connect. +* feature: EC2: Adds IPv6 Support for EC2 and new F1 Instance types. +* feature: ElasticBeanstalk: Integrates AWS CodeBuild into ElasticBeanstalk. +* feature: Health: When your business is counting on the performance of your cloud solutions, having relevant and timely insights into events impacting your AWS resources is essential. The AWS Health API serves as the primary source for you to receive personalized information related to your AWS infrastructure, guiding your through scheduled changes, and accelerating the troubleshooting of issues impacting your AWS resources and accounts. At launch, the APIs will be available to Business and Enterprise Support customers. +* feature: Lambda: Adds new API `getAccountSettings`, dotnetcore 1.0 runtime support, DeadLetterConfig, and event source mappings with kinesis streams. +* feature: OpsWorksCM: AWS OpsWorks for Chef Automate gives customers a single tenant Chef Automate server. The Chef Automate server is fully managed by AWS and supports automatic backup, restore and upgrade operations. +* feature: Pinpoint: Amazon Pinpoint makes it easy to run targeted campaigns to improve user engagement. Pinpoint helps you understand your users behavior, define who to target, what messages to send, when to deliver them, and tracks the results of the campaign. +* feature: Shield: AWS Shield is a managed Distributed Denial of Service (DDoS) protection for web applications running on AWS. +* feature: SSM: Amazon EC2 Systems Manager is a flexible and easy to use management service that enables enterprises to securely manage and administer their workloads running on-premises or in the AWS cloud, using a single unified experience. These tasks include collecting system inventory, AWSmaintaining consistent state, ad hoc remote execution, automating imaging creation, applying OS patches, and managing configuration parameters. +* feature: StepFunctions: Adds support for the AWS Step Functions API. +* feature: XRay: AWS X-Ray helps developers analyze and debug distributed applications. With X-Ray, you can understand how your application and its underlying services are performing to identify and troubleshoot the root cause of performance issues and errors. + +## 2.7.9 +* feature: Polly: Adds `AWS.Polly.Presigner` to create presigned urls for `synthesizeSpeech`. +* feature: Polly: Amazon Polly is a service that turns text into lifelike speech, making it easy to develop applications that use high-quality speech to increase engagement and accessibility. With Amazon Polly the developers can build speech-enabled apps that work in multiple geographies. +* feature: Lightsail: An extremely simplified VM creation and management service. +* feature: Rekognition: Amazon Rekognition is a service that makes it easy to add image analysis to your applications. With Rekognition, you can detect objects, scenes, and faces in images. You can also search and compare faces. Rekognition’s API enables you to quickly add sophisticated deep learning-based visual search and image classification to your applications. +* feature: Snowball: This release of AWS Snowball introduces a new job type, new APIs, and the new AWS Snowball Edge device to support local compute and storage use cases. The local compute is AWS Lambda powered by AWS Greengrass, and the local storage is compatible with Amazon S3. Each 100 TB Snowball Edge can use the storage and compute power of the AWS cloud locally in places where connecting to the internet may not be an option. Additionally, Snowball Edges can be used in clusters for applications that require greater data durability. + +## 2.7.8 +* feature: core: The SDK will now automatically provide a version 4 UUID for top-level operation parameters that are modeled with the `idempotencyToken` flag. Users may continue to provide their own tokens. +* feature: S3: Updates the AWS.S3 API to the latest version. + +## 2.7.7 +* feature: CloudFormation: List-imports API is to list all stacks of user's namespace that are using a specific output. +* feature: Glacier: Allow customers to retrieve their data with different tiers. +* feature: Route53: Expand current IPAddress field to accept IPv6 address. +* feature: S3: Allow customers to specify different restore tiers when accessing their data. + +## 2.7.6 +* feature: CloudTrail: This release of AWS CloudTrail supports configuring your trail with event selectors. Use event selectors to specify the type of events that you want your trails to log. You can configure event selectors to log read-only, write-only, or all events. CloudTrail supports logging Amazon S3 object level APIs such as GetObject, DeleteObject, and PutObject. You can configure event selectors for your trail to log object level operations. +* feature: ECS: ECS will include a new field named `version` in API responses relating to tasks and container instances. Version is a number that increments every time a change has been made to the associated resource. Users replicating their ECS resource state can use the version field reported by the ECS APIs to determine if their local state is fresh. + +## 2.7.5 +* bugfix: TypeScript: Stubs DOM interfaces and removes type reference to node. +* feature: ElasticTranscoder: Support for multiple media input files that can be stitched together. +* feature: Lambda: Adds support for Environment variables. +* feature: Gamelift: Provide the ability to remote access into GameLift managed servers. +* feature: EMR: Automatic Scaling of EMR clusters based on metrics. Adds support for cancelling a pending Amazon EMR step. +* feature: ApplicationAutoScaling: Adds support for a new target resource (EMR Instance Groups) as a scalable target. + +## 2.7.4 +* feature: MarketplaceMetering: Allows third parties to send metering records. +* feature: SQS: Updates the latest version of the SQS API. +* feature: CloudWatch: Amazon CloudWatch now supports Percentiles as a statistical function. +* feature: APIGateway: Allows defining an encoding for the API per content type in order to support 'binary' use case. + +## 2.7.3 +* feature: Route53: Adds support for cross account VPC association. +* feature: ServiceCatalog: This release enables Service Catalog users to perform administer operations via API. + +## 2.7.2 +* feature: ElastiCache: Additional parameter to 2 create apis to provide an auth Token for Redis. +* feature: DirectoryService: Adds support for SchemaExtensions. +* feature: Kinesis: Adds DescribeLimits API which displays customer's current shard limit and the number of open shards that are being used. Also adds a 'display stream creation timestamp' feature to DescribeStream API. + +## 2.7.1 +* feature: CognitoIdentityServiceProvider: Adds schema attributes to CreateUserPool. +* bugfix: TypeScript: Updates definitions to work when `noImplicitAny` and `strictNullChecks` are set to `true`. + +## 2.7.0 +* feature: TypeScript: Adds typescript definition files to the SDK. +* feature: CloudWatchLogs: Amazon CloudWatch Metrics to Logs is a capability that helps pivot from your logs-extracted metrics directly to the corresponding logs. + +## 2.6.15 +* feature: DirectConnect: AWS Direct Connect provides three new APIs to support basic tagging on Direct Connect resources. + +## 2.6.14 +* feature: SES: Amazon Simple Email Service (Amazon SES) now enables you to track your bounce, complaint, delivery, sent, and rejected email metrics with fine-grained granularity. + +## 2.6.13 +* feature: CloudFormation: Adding ResourcesToSkip parameter to ContinueUpdateRollback API, adding support for ListExports, new ChangeSet types and Transforms. + +## 2.6.12 +* feature: CredentialProviderChain: Adds promise support for the `resolve` method on the AWS.CredentialProviderChain class. Corresponding promise method is called `resolvePromise`. +* feature: Credentials: Adds promise support for the `get` and `refresh` methods of the AWS.Credentials class. Corresponding promise methods are called `getPromise` and `refreshPromise`. +* feature: ManagedUpload: Adds promise support for S3.ManagedUpload. Calling `s3.upload(params).promise()` will return a promise. +* feature: SMS: AWS Server Migration Service (SMS) is an agentless service which makes it easier and faster for you to migrate thousands of on-premises workloads to AWS. AWS SMS allows you to automate, schedule, and track incremental replications of live server volumes, making it easier for you to coordinate large-scale server migrations. + +## 2.6.11 +* feature: Budgets: Adds the AWS Budgets service API via AWS.Budgets. + +## 2.6.10 +* feature: CloudFront: Ability to use Amazon CloudFront to deliver your content both via IPv6 and IPv4 using HTTP/HTTPS. +* feature: IoT: Updates IoT API to the latest available version. +* feature: RDS: Updates RDS to support accessing other AWS services by gassociating an IAM role with necessary permissions to your DB cluster. + +## 2.6.9 +* bugfix: s3: Propagate an error from a stream to s3.upload callback #1169 +* feature: S3: Adds support for using dualstack with accelerate endpoints. +* feature: ACM: This change allows users to import third-party SSL/TLS certificates into ACM. +* feature: ElasticBeanstalk: Adds CodeCommit integraion. DescribeApplicationVersions updated to support pagination. +* feature: GameLift: New APIs to protect game developer resource (builds, alias, fleets, instances, game sessions and player sessions) against abuse. + +## 2.6.8 +* feature: ECR: DescribeImages is a new api used to expose image metadata which today includes image size and image creation timestamp. +* feature: ElastiCache: Elasticache is launching a new major engine release of Redis, 3.2 (providing stability updates and new command sets over 2.8), as well as ElasticSupport for enabling Redis Cluster in 3.2, which provides support for multiple node groups to horizontally scale data, as well as superior engine failover capabilities. + +## 2.6.7 +* feature: CognitoIdentityServiceProvider: Added new operation "AdminCreateUser" that creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). +* feature: Route53: Retries PriorRequestNotComplete errors. + +## 2.6.6 +* feature: EC2: Adding support for EC2 Convertible RIs and the EC2 RI regional benefit. +* feature: S3: S3 API update with partNumber extension and a bug fix to address list-objects command failing when a bucket is marked with request-pays. + +## 2.6.5 +* bugfix: apiVersion: Fixes an issue where some service clients would fail to instantiate if an older apiVersion was specified. +* feature: CloudFormation: Adds support for specifying an IAM service role for CloudFormation stack operations. + +## 2.6.4 +* bugfix: Browser: Updates `url` and `querystring` dependencies to be controlled by the SDK instead of tools like browserify or webpack. +* bugfix: Config: Fixes an issue where specifying service-specific config on the global AWS.config object would fail if the service had not yet been instantiated. +* feature: CodeDeploy: AWS CodeDeploy now integrates with Amazon CloudWatch alarms, making it possible to stop a deployment if there is a change in the state of a specified alarm for a number of consecutive periods, as specified in the alarm threshold. AWS CodeDeploy also now supports automatically rolling back a deployment if certain conditions are met, such as a deployment failure or an activated alarm. +* feature: EMR: Added support for Security Configurations which can be used to enable encryption at-rest and in-transit for certain applications on Amazon EMR. +* feature: RDS: Provide local time zone support for AWS RDS SqlServer database instances. +* feature: Redshift: This release of Amazon Redshift introduces Enhanced VPC Routing. When you use Amazon Redshift Enhanced VPC Routing, Amazon Redshift forces all COPY and UNLOAD traffic between your cluster and your data repositories through your Amazon VPC. + +## 2.6.3 +* bugfix: Node_Https: Fixes an issue caused when https.globalAgent is set to false. +* feature: Iot: Updates registerCertificate operation, and allows users to specify cannedAcl for S3 action. +* feature: RDS: Updates describeDbCluster operation to allow specifying a ReaderEndpoint for accessing cluster readers. + +## 2.6.2 +* feature: ServiceCatalog: Updates the API for AWS.ServiceCatalog. + +## 2.6.1 +* bugfix: SDK: Fixes an issue that caused all services to be loaded into memory when requiring the SDK. This issue was introduced in version `2.6.0` of the SDK, and address #1124. + +## 2.6.0 +* feature: CloudFront: Adds HTTP2 support for Amazon CloudFront distributions. +* feature: MetadataService: Adds retry logic to the EC2 Metadata Service, so that EC2MetadataCredentials will retry TimeoutError. This retry logic is also added to ECSCredentials. Resolves #692 +* feature: ServiceCatalog: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: Tools: Adds support for bundling the SDK with webpack. Also adds support for creating node.js bundles using webpack or browserify. + +## 2.5.6 +* feature: RDS: Adds new operation describeSourceRegions to provide list of all the source region names and endpoints for any region. Source regions are the regions where current region can get a replica or copy a snapshot from. + +## 2.5.5 +* feature: CognitoIdentityServiceProvider: Adds support for bulk import of users. +* feature: GameLift: Adds Linux support. +* feature: Iot: Adds Iot as a default service in the browser distribution of the AWS SDK for JavaScript. +* feature: RDS: Adds information in response of describeOptionGroupOptions about options that conflict with each other. + +## 2.5.4 +* feature: CloudFront: CloudFront is adding a Querystring Whitelist Option. Customers will be able to choose to forward certain querystring keys instead of a.) all of them or b.) none of them. +* feature: CodePipeline: CodePiepline has introduced a new feature to return pipeline execution details. Execution details consists of source revisions that are running in the pipeline. Customers will be able to tell what source revisions that are running through the stages in pipeline by fetching execution details of each stage. +* feature: Route53: With this release, Route 53 will support the following new features: support for the NAPTR DNS record type, a new testDNSAnswer API which enables customers to send a test query against a specific name server using spoofed delegation nameserver, resolver, and ECS IPs, and support metric-based health check in ap-south-1 region. + +## 2.5.3 +* feature: RDS: Adds resource ARNs to Describe APIs. + +## 2.5.2 +* bugfix: Waiter: Fixes bug in `clusterDeleted` waiter for AWS.Redshift. +* feature: EC2: Adds new APIs supporting dedicated host reservations. Also adds new property to response of `describeSpotFleetRequests` to indicate the activity status of spot fleet requests. +* feature: Request: eachItem method stops iteration on returning false (like eachPage) +* feature: WorkSpaces: Adds new APIs to support the launch and management of WorkSpaces that are paid for and used by the hour. + +## 2.5.1 +* feature: ACM: Increase tagging limit from 10 to 50. +* feature: APIGateway: Amazon API Gateway now supports API usage plans. Usage plans allows you to easily manage and monetize your APIs for your API-based business. +* feature: ECS: Adds support for memory reservation and network mode on task definitions. Also adds splunk as a supported log driver. + +## 2.5.0 +* feature: AutoScaling: Adds 3 new APIs for ELB L7 integration: attachLoadBalancerTargetGroups, detachLoadBalancerTargetGroups, and describeLoadBalancerTargetGroups. +* feature: ECS: Adds ECS support for ELBv2. Supports Application Load Balancer target groups to enable dynamic ports and path-based routing. +* feature: ELBv2: Adds new backwards incompatible application load balancer API version. Application load balancers are a new load balancer that is now supported by the Elastic Load Balancing service. Application load balancers support HTTP/2, WebSockets, routing based on URL path, and routing to multiple ports on a single instance. +* feature: KMS: Adds support for importing customer-supplied cryptographic keys. New import key feature lets you import keys from your own key management infrastructure to KMS for greater control over generation and storage of keys and meeting compliance requirements of sensitive workloads. +* feature: KinesisAnalytics: Adds the new service Amazon Kinesis Analytics, a fully managed service for continuously querying streaming data using standard SQL. With Kinesis Analytics, you can write standard SQL queries on streaming data and gain actionable insights in real-time, without having to learn any new programming skills. The service allows you to build applications that continuously read data from streaming data sources, process that data using standard SQL, and send the processed data to up to four destinations of your choice. Kinesis Analytics enables you to generate time-series analytics, feed a real-time dashboard, create real-time alarms and notifications, and much more. +* feature: S3: Adds support for IPv6/IPv4 Dualstack endpoint. A new opt-in boolean option `use Dualstack` can be specified for S3 service clients: `new AWS.S3({useDualstack: true})`. Alternatively, to configure it once for all subsequent S3 service clients: `AWS.config.update({s3: {useDualstack: true}})`. +* feature: Snowball: Adds Amazon Snowball, a new job management service. + +## 2.4.14 +* feature: CloudFront: Amazon CloudFront now supports tagging for Web and Streaming distributions. Tags make it easier for you to allocate costs and optimize spending by categorizing and grouping AWS resources. +* feature: ECR: Adds filtering of ListImages requests based on whether an image is tagged or untagged. +* feature: MarketplaceCommerceAnalytics: Adds the `startSupportDataExport` operation. + +## 2.4.13 +* feature: ApplicationAutoScaling: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: AutoScaling: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: CodeDeploy: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: GameLift: Provides a new Search API for GameLift, which allows game developers to retrieve filtered and sorted lists of their GameSessions. +* feature: RDS: You can now use the AWS Management Console to easily move your DB instance to a different VPC, or to a different subnet group in the same VPC. For more information, see Updating the VPC for a DB Instance. If your DB instance is not in a VPC, you can now use the AWS Management Console to easily move your DB instance into a VPC. You can now copy the source files from a MySQL database to an Amazon Simple Storage Service (Amazon S3) bucket, and then restore an Amazon Aurora DB cluster from those files. This option can be considerably faster than migrating data using mysqldump. + +## 2.4.12 +* bugfix: Request: Adds a content-length check for the stream returned from `createReadStream()`, and the stream will emit an error when the bytes received are fewer than specified by the response content-length header. +* bugfix: S3: Reverts behavior introduced in version `2.4.0` of the SDK to default the `signatureVersion` of S3 clients to `v4`. S3 clients instantiated without a user-defined `signatureVersion` will now default to `v2` unless the region only supports `v4` signing. This change is being made due to issues sending non-ascii characters in headers when using `v4` signing. +* feature: CloudWatchLogs: Updates the `putMetricFilter` operation. +* feature: EMR: Adds enhanced debugging. +* feature: Iot: Adds `listOutgoingCertificates` and support for allowing autoregistration. +* feature: MachineLearning: Adds compute time and entity timestamp to multiple operations. +* feature: RDS: Support for license model and versioning of option groups. +* feature: Route53Domains: Adds new APIs to renew domains for a specified duration, get domain suggestions, and view billing. + +## 2.4.11 +* feature: APIGateway: Adds support for authentication through Cognito User Pools. +* feature: CognitoIdentityServiceProvider: Introduces support for Your User Pools. +* feature: DirectoryService: Enables routing to on-premises public IP for Microsoft Active Directory. +* feature: EC2: Enables resolution of DNS queries from a peered VPC to a private IP address. +* feature: ES: Updates to Elasticsearch version 2.3, which offers improved performance, memory management, and security. It also offers several new features includinng pipeline aggregations to perform advanced analytics like moving averages and derivatives, and enhancements to geospatial queries. +* feature: Waiter: Adds Waiters for AWS.CodeDeploy. + +## 2.4.10 +* feature: util: Parse ini files containing comments using # +* feature: Iot: Adds support for thing types. Thing types are entities that store a description of common features of Things that are of the same logical type. Also adds support for `:` in Thing name. Adds a separator in Firehose action. + +## 2.4.9 +* feature: ACM: Adds reason for failure when describing certificates. +* feature: ConfigService: Adds support for RDS and ACM resources types and introduces two new APIs: DeleteEvaluationResults and StartConfigRulesEvaluation. Updated PutConfigRule API can now create Config rules that are triggered by both configuration changes and periodicity. +* feature: ElasticTranscoder: Adds WAV file format output support. +* feature: Paginator: Adds paginator for SSM DescribeInstanceInformation operation. + +## 2.4.8 +* feature: CloudFormation: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: CloudHSM: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: DeviceFarm: Adds session-based APIs. +* feature: EMR: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: ElastiCache: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: ElasticBeanstalk: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: Redshift: CORS support added. Now a default service in the browser build of the JavaScript SDK. +* feature: SSM: Adds notification support. diff --git a/node_modules/aws-sdk/LICENSE.txt b/node_modules/aws-sdk/LICENSE.txt new file mode 100644 index 0000000..9c5b1fe --- /dev/null +++ b/node_modules/aws-sdk/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/node_modules/aws-sdk/NOTICE.txt b/node_modules/aws-sdk/NOTICE.txt new file mode 100644 index 0000000..d8c7e15 --- /dev/null +++ b/node_modules/aws-sdk/NOTICE.txt @@ -0,0 +1,5 @@ +AWS SDK for JavaScript +Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + +This product includes software developed at +Amazon Web Services, Inc. (http://aws.amazon.com/). diff --git a/node_modules/aws-sdk/README.md b/node_modules/aws-sdk/README.md new file mode 100644 index 0000000..ef7cc19 --- /dev/null +++ b/node_modules/aws-sdk/README.md @@ -0,0 +1,180 @@ +# AWS SDK for JavaScript + +[![NPM](https://nodei.co/npm/aws-sdk.svg?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/aws-sdk/) + +[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/aws/aws-sdk-js) + +[![Version](https://badge.fury.io/js/aws-sdk.svg)](http://badge.fury.io/js/aws-sdk) [![Build Status](https://travis-ci.org/aws/aws-sdk-js.svg?branch=master)](https://travis-ci.org/aws/aws-sdk-js) [![Coverage Status](https://coveralls.io/repos/aws/aws-sdk-js/badge.svg?branch=master)](https://coveralls.io/r/aws/aws-sdk-js?branch=master) + +The official AWS SDK for JavaScript, available for browsers and mobile devices, +or Node.js backends + +For release notes, see the [CHANGELOG](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md). Prior to v2.4.8, release notes can be found at https://aws.amazon.com/releasenotes/?tag=releasenotes%23keywords%23javascript + +If you are upgrading from 1.x to 2.0 of the SDK, please see the +[upgrading notes](https://github.com/aws/aws-sdk-js/blob/master/UPGRADING.md) +for information on how to migrate existing code to work with the new major +version. + +## Installing + +### In the Browser + +To use the SDK in the browser, simply add the following script tag to your +HTML pages: + + + +You can also build a custom browser SDK with your specified set of AWS services. +This can allow you to reduce the SDK's size, specify different API versions of +services, or use AWS services that don't currently support CORS if you are +working in an environment that does not enforce CORS. To get started: + +http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html + +The AWS SDK is also compatible with [browserify](http://browserify.org). + +For browser-based web, mobile and hybrid apps, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/?utm_source=aws-js-sdk&utm_campaign=browser) which extends the AWS SDK and provides an easier and declarative interface. + +### In Node.js + +The preferred way to install the AWS SDK for Node.js is to use the +[npm](http://npmjs.org) package manager for Node.js. Simply type the following +into a terminal window: + +```sh +npm install aws-sdk +``` + +### In React Native +To use the SDK in a react native project, first install the SDK using npm: + +```sh +npm install aws-sdk +``` + +Then within your application, you can reference the react native compatible version of the SDK with the following: + +```javascript +var AWS = require('aws-sdk/dist/aws-sdk-react-native'); +``` + +Alternatively, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/media/react_native_guide?utm_source=aws-js-sdk&utm_campaign=react-native) which extends AWS SDK and provides React Native UI components and CLI support to work with AWS services. + +### Using Bower + +You can also use [Bower](http://bower.io) to install the SDK by typing the +following into a terminal window: + +```sh +bower install aws-sdk-js +``` + +## Usage and Getting Started + +You can find a getting started guide at: + +http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide + +## Usage with TypeScript +The AWS SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read `.d.ts` files. +Our goal is to keep these TypeScript definition files updated with each release for any public api. + +### Pre-requisites +Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements: + + * Use TypeScript v2.x + * Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window: + + ```sh + npm install --save-dev @types/node + ``` + + * If you are targeting at es5 or older ECMA standards, your `tsconfig.json` has to include `'es5'` and `'es2015.promise'` under `compilerOptions.lib`. + See [tsconfig.json](https://github.com/aws/aws-sdk-js/blob/master/ts/tsconfig.json) for an example. + +### In the Browser +To use the TypeScript definition files with the global `AWS` object in a front-end project, add the following line to the top of your JavaScript file: + +```javascript +/// +``` + +This will provide support for the global `AWS` object. + +### In Node.js +To use the TypeScript definition files within a Node.js project, simply import `aws-sdk` as you normally would. + +In a TypeScript file: + +```javascript +// import entire SDK +import AWS from 'aws-sdk'; +// import AWS object without services +import AWS from 'aws-sdk/global'; +// import individual service +import S3 from 'aws-sdk/clients/s3'; +``` + +In a JavaScript file: + +```javascript +// import entire SDK +var AWS = require('aws-sdk'); +// import AWS object without services +var AWS = require('aws-sdk/global'); +// import individual service +var S3 = require('aws-sdk/clients/s3'); +``` + +### With React + +To create React applications with AWS SDK, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/media/react_guide?utm_source=aws-js-sdk&utm_campaign=react) which provides React components and CLI support to work with AWS services. + +### With Angular +Due to the SDK's reliance on node.js typings, you may encounter compilation +[issues](https://github.com/aws/aws-sdk-js/issues/1271) when using the +typings provided by the SDK in an Angular project created using the Angular CLI. + +To resolve these issues, either add `"types": ["node"]` to the project's `tsconfig.app.json` +file, or remove the `"types"` field entirely. + +[AWS Amplify Library](https://aws.github.io/aws-amplify/media/angular_guide?utm_source=aws-js-sdk&utm_campaign=angular) provides Angular components and CLI support to work with AWS services. + +### Known Limitations +There are a few known limitations with the bundled TypeScript definitions at this time: + + * Service client typings reflect the latest `apiVersion`, regardless of which `apiVersion` is specified when creating a client. + * Service-bound parameters use the `any` type. + +## Getting Help +Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. + + * Ask a question on [StackOverflow](https://stackoverflow.com/) and tag it with `aws-sdk-js` + * Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js?source=orgpage) + * Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home#/) + * If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js/issues/new) + +## Opening Issues +If you encounter a bug with the AWS SDK for JavaScript we would like to hear +about it. Search the [existing issues](https://github.com/aws/aws-sdk-js/issues) +and try to make sure your problem doesn’t already exist before opening a new +issue. It’s helpful if you include the version of the SDK, Node.js or browser +environment and OS you’re using. Please include a stack trace and reduced repro +case when appropriate, too. + +The GitHub issues are intended for bug reports and feature requests. For help +and questions with using the AWS SDK for JavaScript please make use of the +resources listed in the [Getting Help](https://github.com/aws/aws-sdk-js#getting-help) +section. There are limited resources available for handling issues and by +keeping the list of open issues lean we can respond in a timely manner. + +## Supported Services + +Please see [SERVICES.md](https://github.com/aws/aws-sdk-js/blob/master/SERVICES.md) for a list of supported services. + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE.txt and NOTICE.txt for more information. diff --git a/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.examples.json b/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.min.json b/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.min.json new file mode 100644 index 0000000..c352a15 --- /dev/null +++ b/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.min.json @@ -0,0 +1,466 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-05-31", + "endpointPrefix": "mgh", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Migration Hub", + "serviceId": "Migration Hub", + "signatureVersion": "v4", + "targetPrefix": "AWSMigrationHub", + "uid": "AWSMigrationHub-2017-05-31" + }, + "operations": { + "AssociateCreatedArtifact": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName", + "CreatedArtifact" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "CreatedArtifact": { + "shape": "S4" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateDiscoveredResource": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName", + "DiscoveredResource" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "DiscoveredResource": { + "shape": "Sa" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateProgressUpdateStream": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStreamName" + ], + "members": { + "ProgressUpdateStreamName": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteProgressUpdateStream": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStreamName" + ], + "members": { + "ProgressUpdateStreamName": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeApplicationState": { + "input": { + "type": "structure", + "required": [ + "ApplicationId" + ], + "members": { + "ApplicationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationStatus": {}, + "LastUpdatedTime": { + "type": "timestamp" + } + } + } + }, + "DescribeMigrationTask": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {} + } + }, + "output": { + "type": "structure", + "members": { + "MigrationTask": { + "type": "structure", + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "Task": { + "shape": "Sq" + }, + "UpdateDateTime": { + "type": "timestamp" + }, + "ResourceAttributeList": { + "type": "list", + "member": { + "shape": "Sv" + } + } + } + } + } + } + }, + "DisassociateCreatedArtifact": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName", + "CreatedArtifactName" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "CreatedArtifactName": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateDiscoveredResource": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName", + "ConfigurationId" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "ConfigurationId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ImportMigrationTask": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListCreatedArtifacts": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "CreatedArtifactList": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + } + }, + "ListDiscoveredResources": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "DiscoveredResourceList": { + "type": "list", + "member": { + "shape": "Sa" + } + } + } + } + }, + "ListMigrationTasks": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ResourceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "MigrationTaskSummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "Status": {}, + "ProgressPercent": { + "type": "integer" + }, + "StatusDetail": {}, + "UpdateDateTime": { + "type": "timestamp" + } + } + } + } + } + } + }, + "ListProgressUpdateStreams": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProgressUpdateStreamSummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProgressUpdateStreamName": {} + } + } + }, + "NextToken": {} + } + } + }, + "NotifyApplicationState": { + "input": { + "type": "structure", + "required": [ + "ApplicationId", + "Status" + ], + "members": { + "ApplicationId": {}, + "Status": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "NotifyMigrationTaskState": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName", + "Task", + "UpdateDateTime", + "NextUpdateSeconds" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "Task": { + "shape": "Sq" + }, + "UpdateDateTime": { + "type": "timestamp" + }, + "NextUpdateSeconds": { + "type": "integer" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutResourceAttributes": { + "input": { + "type": "structure", + "required": [ + "ProgressUpdateStream", + "MigrationTaskName", + "ResourceAttributeList" + ], + "members": { + "ProgressUpdateStream": {}, + "MigrationTaskName": {}, + "ResourceAttributeList": { + "type": "list", + "member": { + "shape": "Sv" + } + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Description": {} + } + }, + "Sa": { + "type": "structure", + "required": [ + "ConfigurationId" + ], + "members": { + "ConfigurationId": {}, + "Description": {} + } + }, + "Sq": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {}, + "StatusDetail": {}, + "ProgressPercent": { + "type": "integer" + } + } + }, + "Sv": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.paginators.json b/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/AWSMigrationHub-2017-05-31.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/acm-2015-12-08.examples.json b/node_modules/aws-sdk/apis/acm-2015-12-08.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-2015-12-08.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/acm-2015-12-08.min.json b/node_modules/aws-sdk/apis/acm-2015-12-08.min.json new file mode 100644 index 0000000..ea9d290 --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-2015-12-08.min.json @@ -0,0 +1,438 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-12-08", + "endpointPrefix": "acm", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "ACM", + "serviceFullName": "AWS Certificate Manager", + "serviceId": "ACM", + "signatureVersion": "v4", + "targetPrefix": "CertificateManager", + "uid": "acm-2015-12-08" + }, + "operations": { + "AddTagsToCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn", + "Tags" + ], + "members": { + "CertificateArn": {}, + "Tags": { + "shape": "S3" + } + } + } + }, + "DeleteCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn" + ], + "members": { + "CertificateArn": {} + } + } + }, + "DescribeCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn" + ], + "members": { + "CertificateArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": { + "type": "structure", + "members": { + "CertificateArn": {}, + "DomainName": {}, + "SubjectAlternativeNames": { + "shape": "Sc" + }, + "DomainValidationOptions": { + "shape": "Sd" + }, + "Serial": {}, + "Subject": {}, + "Issuer": {}, + "CreatedAt": { + "type": "timestamp" + }, + "IssuedAt": { + "type": "timestamp" + }, + "ImportedAt": { + "type": "timestamp" + }, + "Status": {}, + "RevokedAt": { + "type": "timestamp" + }, + "RevocationReason": {}, + "NotBefore": { + "type": "timestamp" + }, + "NotAfter": { + "type": "timestamp" + }, + "KeyAlgorithm": {}, + "SignatureAlgorithm": {}, + "InUseBy": { + "type": "list", + "member": {} + }, + "FailureReason": {}, + "Type": {}, + "RenewalSummary": { + "type": "structure", + "required": [ + "RenewalStatus", + "DomainValidationOptions", + "UpdatedAt" + ], + "members": { + "RenewalStatus": {}, + "DomainValidationOptions": { + "shape": "Sd" + }, + "RenewalStatusReason": {}, + "UpdatedAt": { + "type": "timestamp" + } + } + }, + "KeyUsages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "ExtendedKeyUsages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "OID": {} + } + } + }, + "CertificateAuthorityArn": {}, + "RenewalEligibility": {}, + "Options": { + "shape": "S11" + } + } + } + } + } + }, + "ExportCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn", + "Passphrase" + ], + "members": { + "CertificateArn": {}, + "Passphrase": { + "type": "blob", + "sensitive": true + } + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": {}, + "CertificateChain": {}, + "PrivateKey": { + "type": "string", + "sensitive": true + } + } + } + }, + "GetCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn" + ], + "members": { + "CertificateArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": {}, + "CertificateChain": {} + } + } + }, + "ImportCertificate": { + "input": { + "type": "structure", + "required": [ + "Certificate", + "PrivateKey" + ], + "members": { + "CertificateArn": {}, + "Certificate": { + "type": "blob" + }, + "PrivateKey": { + "type": "blob", + "sensitive": true + }, + "CertificateChain": { + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "members": { + "CertificateArn": {} + } + } + }, + "ListCertificates": { + "input": { + "type": "structure", + "members": { + "CertificateStatuses": { + "type": "list", + "member": {} + }, + "Includes": { + "type": "structure", + "members": { + "extendedKeyUsage": { + "type": "list", + "member": {} + }, + "keyUsage": { + "type": "list", + "member": {} + }, + "keyTypes": { + "type": "list", + "member": {} + } + } + }, + "NextToken": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "CertificateSummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CertificateArn": {}, + "DomainName": {} + } + } + } + } + } + }, + "ListTagsForCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn" + ], + "members": { + "CertificateArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S3" + } + } + } + }, + "RemoveTagsFromCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn", + "Tags" + ], + "members": { + "CertificateArn": {}, + "Tags": { + "shape": "S3" + } + } + } + }, + "RenewCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn" + ], + "members": { + "CertificateArn": {} + } + } + }, + "RequestCertificate": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "ValidationMethod": {}, + "SubjectAlternativeNames": { + "shape": "Sc" + }, + "IdempotencyToken": {}, + "DomainValidationOptions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DomainName", + "ValidationDomain" + ], + "members": { + "DomainName": {}, + "ValidationDomain": {} + } + } + }, + "Options": { + "shape": "S11" + }, + "CertificateAuthorityArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "CertificateArn": {} + } + } + }, + "ResendValidationEmail": { + "input": { + "type": "structure", + "required": [ + "CertificateArn", + "Domain", + "ValidationDomain" + ], + "members": { + "CertificateArn": {}, + "Domain": {}, + "ValidationDomain": {} + } + } + }, + "UpdateCertificateOptions": { + "input": { + "type": "structure", + "required": [ + "CertificateArn", + "Options" + ], + "members": { + "CertificateArn": {}, + "Options": { + "shape": "S11" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sc": { + "type": "list", + "member": {} + }, + "Sd": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "ValidationEmails": { + "type": "list", + "member": {} + }, + "ValidationDomain": {}, + "ValidationStatus": {}, + "ResourceRecord": { + "type": "structure", + "required": [ + "Name", + "Type", + "Value" + ], + "members": { + "Name": {}, + "Type": {}, + "Value": {} + } + }, + "ValidationMethod": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "CertificateTransparencyLoggingPreference": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/acm-2015-12-08.paginators.json b/node_modules/aws-sdk/apis/acm-2015-12-08.paginators.json new file mode 100644 index 0000000..611eb86 --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-2015-12-08.paginators.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListCertificates": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "CertificateSummaryList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/acm-2015-12-08.waiters2.json b/node_modules/aws-sdk/apis/acm-2015-12-08.waiters2.json new file mode 100644 index 0000000..1fba453 --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-2015-12-08.waiters2.json @@ -0,0 +1,35 @@ +{ + "version": 2, + "waiters": { + "CertificateValidated": { + "delay": 60, + "maxAttempts": 40, + "operation": "DescribeCertificate", + "acceptors": [ + { + "matcher": "pathAll", + "expected": "SUCCESS", + "argument": "Certificate.DomainValidationOptions[].ValidationStatus", + "state": "success" + }, + { + "matcher": "pathAny", + "expected": "PENDING_VALIDATION", + "argument": "Certificate.DomainValidationOptions[].ValidationStatus", + "state": "retry" + }, + { + "matcher": "path", + "expected": "FAILED", + "argument": "Certificate.Status", + "state": "failure" + }, + { + "matcher": "error", + "expected": "ResourceNotFoundException", + "state": "failure" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/acm-pca-2017-08-22.examples.json b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/acm-pca-2017-08-22.min.json b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.min.json new file mode 100644 index 0000000..11c99d9 --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.min.json @@ -0,0 +1,530 @@ +{ + "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": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityConfiguration", + "CertificateAuthorityType" + ], + "members": { + "CertificateAuthorityConfiguration": { + "shape": "S2" + }, + "RevocationConfiguration": { + "shape": "Se" + }, + "CertificateAuthorityType": {}, + "IdempotencyToken": {}, + "Tags": { + "shape": "Sm" + } + } + }, + "output": { + "type": "structure", + "members": { + "CertificateAuthorityArn": {} + } + }, + "idempotent": true + }, + "CreateCertificateAuthorityAuditReport": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "S3BucketName", + "AuditReportResponseFormat" + ], + "members": { + "CertificateAuthorityArn": {}, + "S3BucketName": {}, + "AuditReportResponseFormat": {} + } + }, + "output": { + "type": "structure", + "members": { + "AuditReportId": {}, + "S3Key": {} + } + }, + "idempotent": true + }, + "CreatePermission": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "Principal", + "Actions" + ], + "members": { + "CertificateAuthorityArn": {}, + "Principal": {}, + "SourceAccount": {}, + "Actions": { + "shape": "S10" + } + } + } + }, + "DeleteCertificateAuthority": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {}, + "PermanentDeletionTimeInDays": { + "type": "integer" + } + } + } + }, + "DeletePermission": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "Principal" + ], + "members": { + "CertificateAuthorityArn": {}, + "Principal": {}, + "SourceAccount": {} + } + } + }, + "DescribeCertificateAuthority": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "CertificateAuthority": { + "shape": "S17" + } + } + } + }, + "DescribeCertificateAuthorityAuditReport": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "AuditReportId" + ], + "members": { + "CertificateAuthorityArn": {}, + "AuditReportId": {} + } + }, + "output": { + "type": "structure", + "members": { + "AuditReportStatus": {}, + "S3BucketName": {}, + "S3Key": {}, + "CreatedAt": { + "type": "timestamp" + } + } + } + }, + "GetCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "CertificateArn" + ], + "members": { + "CertificateAuthorityArn": {}, + "CertificateArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": {}, + "CertificateChain": {} + } + } + }, + "GetCertificateAuthorityCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": {}, + "CertificateChain": {} + } + } + }, + "GetCertificateAuthorityCsr": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Csr": {} + } + } + }, + "ImportCertificateAuthorityCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "Certificate", + "CertificateChain" + ], + "members": { + "CertificateAuthorityArn": {}, + "Certificate": { + "type": "blob" + }, + "CertificateChain": { + "type": "blob" + } + } + } + }, + "IssueCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "Csr", + "SigningAlgorithm", + "Validity" + ], + "members": { + "CertificateAuthorityArn": {}, + "Csr": { + "type": "blob" + }, + "SigningAlgorithm": {}, + "Validity": { + "type": "structure", + "required": [ + "Value", + "Type" + ], + "members": { + "Value": { + "type": "long" + }, + "Type": {} + } + }, + "IdempotencyToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "CertificateArn": {} + } + }, + "idempotent": true + }, + "ListCertificateAuthorities": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "CertificateAuthorities": { + "type": "list", + "member": { + "shape": "S17" + } + }, + "NextToken": {} + } + } + }, + "ListPermissions": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Permissions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CertificateAuthorityArn": {}, + "CreatedAt": { + "type": "timestamp" + }, + "Principal": {}, + "SourceAccount": {}, + "Actions": { + "shape": "S10" + }, + "Policy": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTags": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sm" + }, + "NextToken": {} + } + } + }, + "RestoreCertificateAuthority": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {} + } + } + }, + "RevokeCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "CertificateSerial", + "RevocationReason" + ], + "members": { + "CertificateAuthorityArn": {}, + "CertificateSerial": {}, + "RevocationReason": {} + } + } + }, + "TagCertificateAuthority": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "Tags" + ], + "members": { + "CertificateAuthorityArn": {}, + "Tags": { + "shape": "Sm" + } + } + } + }, + "UntagCertificateAuthority": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn", + "Tags" + ], + "members": { + "CertificateAuthorityArn": {}, + "Tags": { + "shape": "Sm" + } + } + } + }, + "UpdateCertificateAuthority": { + "input": { + "type": "structure", + "required": [ + "CertificateAuthorityArn" + ], + "members": { + "CertificateAuthorityArn": {}, + "RevocationConfiguration": { + "shape": "Se" + }, + "Status": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "KeyAlgorithm", + "SigningAlgorithm", + "Subject" + ], + "members": { + "KeyAlgorithm": {}, + "SigningAlgorithm": {}, + "Subject": { + "type": "structure", + "members": { + "Country": {}, + "Organization": {}, + "OrganizationalUnit": {}, + "DistinguishedNameQualifier": {}, + "State": {}, + "CommonName": {}, + "SerialNumber": {}, + "Locality": {}, + "Title": {}, + "Surname": {}, + "GivenName": {}, + "Initials": {}, + "Pseudonym": {}, + "GenerationQualifier": {} + } + } + } + }, + "Se": { + "type": "structure", + "members": { + "CrlConfiguration": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "ExpirationInDays": { + "type": "integer" + }, + "CustomCname": {}, + "S3BucketName": {} + } + } + } + }, + "Sm": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S10": { + "type": "list", + "member": {} + }, + "S17": { + "type": "structure", + "members": { + "Arn": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastStateChangeAt": { + "type": "timestamp" + }, + "Type": {}, + "Serial": {}, + "Status": {}, + "NotBefore": { + "type": "timestamp" + }, + "NotAfter": { + "type": "timestamp" + }, + "FailureReason": {}, + "CertificateAuthorityConfiguration": { + "shape": "S2" + }, + "RevocationConfiguration": { + "shape": "Se" + }, + "RestorableUntil": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/acm-pca-2017-08-22.paginators.json b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.paginators.json new file mode 100644 index 0000000..d60ea0d --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.paginators.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListCertificateAuthorities": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CertificateAuthorities" + }, + "ListPermissions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Permissions" + }, + "ListTags": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/acm-pca-2017-08-22.waiters2.json b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.waiters2.json new file mode 100644 index 0000000..79bf399 --- /dev/null +++ b/node_modules/aws-sdk/apis/acm-pca-2017-08-22.waiters2.json @@ -0,0 +1,61 @@ +{ + "version": 2, + "waiters": { + "CertificateAuthorityCSRCreated": { + "description": "Wait until a Certificate Authority CSR is created", + "operation": "GetCertificateAuthorityCsr", + "delay": 3, + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "RequestInProgressException" + } + ] + }, + "CertificateIssued": { + "description": "Wait until a certificate is issued", + "operation": "GetCertificate", + "delay": 3, + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "RequestInProgressException" + } + ] + }, + "AuditReportCreated": { + "description": "Wait until a Audit Report is created", + "operation": "DescribeCertificateAuthorityAuditReport", + "delay": 3, + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "AuditReportStatus", + "expected": "SUCCESS" + }, + { + "state": "failure", + "matcher": "path", + "argument": "AuditReportStatus", + "expected": "FAILED" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.examples.json b/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.min.json b/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.min.json new file mode 100644 index 0000000..9a7c6b8 --- /dev/null +++ b/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.min.json @@ -0,0 +1,2233 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-11-09", + "endpointPrefix": "a4b", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Alexa For Business", + "serviceId": "Alexa For Business", + "signatureVersion": "v4", + "targetPrefix": "AlexaForBusiness", + "uid": "alexaforbusiness-2017-11-09" + }, + "operations": { + "ApproveSkill": { + "input": { + "type": "structure", + "required": [ + "SkillId" + ], + "members": { + "SkillId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateContactWithAddressBook": { + "input": { + "type": "structure", + "required": [ + "ContactArn", + "AddressBookArn" + ], + "members": { + "ContactArn": {}, + "AddressBookArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateDeviceWithRoom": { + "input": { + "type": "structure", + "members": { + "DeviceArn": {}, + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateSkillGroupWithRoom": { + "input": { + "type": "structure", + "members": { + "SkillGroupArn": {}, + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateSkillWithSkillGroup": { + "input": { + "type": "structure", + "required": [ + "SkillId" + ], + "members": { + "SkillGroupArn": {}, + "SkillId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateSkillWithUsers": { + "input": { + "type": "structure", + "required": [ + "SkillId" + ], + "members": { + "SkillId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateAddressBook": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Description": {}, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "AddressBookArn": {} + } + } + }, + "CreateBusinessReportSchedule": { + "input": { + "type": "structure", + "required": [ + "Format", + "ContentRange" + ], + "members": { + "ScheduleName": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "Format": {}, + "ContentRange": { + "shape": "Sp" + }, + "Recurrence": { + "shape": "Sr" + }, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ScheduleArn": {} + } + } + }, + "CreateConferenceProvider": { + "input": { + "type": "structure", + "required": [ + "ConferenceProviderName", + "ConferenceProviderType", + "MeetingSetting" + ], + "members": { + "ConferenceProviderName": {}, + "ConferenceProviderType": {}, + "IPDialIn": { + "shape": "Sx" + }, + "PSTNDialIn": { + "shape": "S10" + }, + "MeetingSetting": { + "shape": "S15" + }, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ConferenceProviderArn": {} + } + } + }, + "CreateContact": { + "input": { + "type": "structure", + "required": [ + "FirstName" + ], + "members": { + "DisplayName": {}, + "FirstName": {}, + "LastName": {}, + "PhoneNumber": { + "shape": "S1a" + }, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ContactArn": {} + } + } + }, + "CreateGatewayGroup": { + "input": { + "type": "structure", + "required": [ + "Name", + "ClientRequestToken" + ], + "members": { + "Name": {}, + "Description": {}, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayGroupArn": {} + } + } + }, + "CreateProfile": { + "input": { + "type": "structure", + "required": [ + "ProfileName", + "Timezone", + "Address", + "DistanceUnit", + "TemperatureUnit", + "WakeWord" + ], + "members": { + "ProfileName": {}, + "Timezone": {}, + "Address": {}, + "DistanceUnit": {}, + "TemperatureUnit": {}, + "WakeWord": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "SetupModeDisabled": { + "type": "boolean" + }, + "MaxVolumeLimit": { + "type": "integer" + }, + "PSTNEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProfileArn": {} + } + } + }, + "CreateRoom": { + "input": { + "type": "structure", + "required": [ + "RoomName" + ], + "members": { + "RoomName": {}, + "Description": {}, + "ProfileArn": {}, + "ProviderCalendarId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "Tags": { + "shape": "S1u" + } + } + }, + "output": { + "type": "structure", + "members": { + "RoomArn": {} + } + } + }, + "CreateSkillGroup": { + "input": { + "type": "structure", + "required": [ + "SkillGroupName" + ], + "members": { + "SkillGroupName": {}, + "Description": {}, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "SkillGroupArn": {} + } + } + }, + "CreateUser": { + "input": { + "type": "structure", + "required": [ + "UserId" + ], + "members": { + "UserId": {}, + "FirstName": {}, + "LastName": {}, + "Email": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "Tags": { + "shape": "S1u" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserArn": {} + } + } + }, + "DeleteAddressBook": { + "input": { + "type": "structure", + "required": [ + "AddressBookArn" + ], + "members": { + "AddressBookArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteBusinessReportSchedule": { + "input": { + "type": "structure", + "required": [ + "ScheduleArn" + ], + "members": { + "ScheduleArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteConferenceProvider": { + "input": { + "type": "structure", + "required": [ + "ConferenceProviderArn" + ], + "members": { + "ConferenceProviderArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteContact": { + "input": { + "type": "structure", + "required": [ + "ContactArn" + ], + "members": { + "ContactArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDevice": { + "input": { + "type": "structure", + "required": [ + "DeviceArn" + ], + "members": { + "DeviceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDeviceUsageData": { + "input": { + "type": "structure", + "required": [ + "DeviceArn", + "DeviceUsageType" + ], + "members": { + "DeviceArn": {}, + "DeviceUsageType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteGatewayGroup": { + "input": { + "type": "structure", + "required": [ + "GatewayGroupArn" + ], + "members": { + "GatewayGroupArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteProfile": { + "input": { + "type": "structure", + "members": { + "ProfileArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRoom": { + "input": { + "type": "structure", + "members": { + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRoomSkillParameter": { + "input": { + "type": "structure", + "required": [ + "SkillId", + "ParameterKey" + ], + "members": { + "RoomArn": {}, + "SkillId": {}, + "ParameterKey": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSkillAuthorization": { + "input": { + "type": "structure", + "required": [ + "SkillId" + ], + "members": { + "SkillId": {}, + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSkillGroup": { + "input": { + "type": "structure", + "members": { + "SkillGroupArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteUser": { + "input": { + "type": "structure", + "required": [ + "EnrollmentId" + ], + "members": { + "UserArn": {}, + "EnrollmentId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateContactFromAddressBook": { + "input": { + "type": "structure", + "required": [ + "ContactArn", + "AddressBookArn" + ], + "members": { + "ContactArn": {}, + "AddressBookArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateDeviceFromRoom": { + "input": { + "type": "structure", + "members": { + "DeviceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateSkillFromSkillGroup": { + "input": { + "type": "structure", + "required": [ + "SkillId" + ], + "members": { + "SkillGroupArn": {}, + "SkillId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateSkillFromUsers": { + "input": { + "type": "structure", + "required": [ + "SkillId" + ], + "members": { + "SkillId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateSkillGroupFromRoom": { + "input": { + "type": "structure", + "members": { + "SkillGroupArn": {}, + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ForgetSmartHomeAppliances": { + "input": { + "type": "structure", + "required": [ + "RoomArn" + ], + "members": { + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetAddressBook": { + "input": { + "type": "structure", + "required": [ + "AddressBookArn" + ], + "members": { + "AddressBookArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "AddressBook": { + "type": "structure", + "members": { + "AddressBookArn": {}, + "Name": {}, + "Description": {} + } + } + } + } + }, + "GetConferencePreference": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "Preference": { + "shape": "S3j" + } + } + } + }, + "GetConferenceProvider": { + "input": { + "type": "structure", + "required": [ + "ConferenceProviderArn" + ], + "members": { + "ConferenceProviderArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConferenceProvider": { + "shape": "S3m" + } + } + } + }, + "GetContact": { + "input": { + "type": "structure", + "required": [ + "ContactArn" + ], + "members": { + "ContactArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Contact": { + "type": "structure", + "members": { + "ContactArn": {}, + "DisplayName": {}, + "FirstName": {}, + "LastName": {}, + "PhoneNumber": { + "shape": "S1a" + } + } + } + } + } + }, + "GetDevice": { + "input": { + "type": "structure", + "members": { + "DeviceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Device": { + "type": "structure", + "members": { + "DeviceArn": {}, + "DeviceSerialNumber": {}, + "DeviceType": {}, + "DeviceName": {}, + "SoftwareVersion": {}, + "MacAddress": {}, + "RoomArn": {}, + "DeviceStatus": {}, + "DeviceStatusInfo": { + "shape": "S3z" + } + } + } + } + } + }, + "GetGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayArn" + ], + "members": { + "GatewayArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Gateway": { + "type": "structure", + "members": { + "Arn": {}, + "Name": {}, + "Description": {}, + "GatewayGroupArn": {}, + "SoftwareVersion": {} + } + } + } + } + }, + "GetGatewayGroup": { + "input": { + "type": "structure", + "required": [ + "GatewayGroupArn" + ], + "members": { + "GatewayGroupArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayGroup": { + "type": "structure", + "members": { + "Arn": {}, + "Name": {}, + "Description": {} + } + } + } + } + }, + "GetInvitationConfiguration": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "OrganizationName": {}, + "ContactEmail": {}, + "PrivateSkillIds": { + "shape": "S4g" + } + } + } + }, + "GetProfile": { + "input": { + "type": "structure", + "members": { + "ProfileArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Profile": { + "type": "structure", + "members": { + "ProfileArn": {}, + "ProfileName": {}, + "IsDefault": { + "type": "boolean" + }, + "Address": {}, + "Timezone": {}, + "DistanceUnit": {}, + "TemperatureUnit": {}, + "WakeWord": {}, + "SetupModeDisabled": { + "type": "boolean" + }, + "MaxVolumeLimit": { + "type": "integer" + }, + "PSTNEnabled": { + "type": "boolean" + }, + "AddressBookArn": {} + } + } + } + } + }, + "GetRoom": { + "input": { + "type": "structure", + "members": { + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Room": { + "type": "structure", + "members": { + "RoomArn": {}, + "RoomName": {}, + "Description": {}, + "ProviderCalendarId": {}, + "ProfileArn": {} + } + } + } + } + }, + "GetRoomSkillParameter": { + "input": { + "type": "structure", + "required": [ + "SkillId", + "ParameterKey" + ], + "members": { + "RoomArn": {}, + "SkillId": {}, + "ParameterKey": {} + } + }, + "output": { + "type": "structure", + "members": { + "RoomSkillParameter": { + "shape": "S4p" + } + } + } + }, + "GetSkillGroup": { + "input": { + "type": "structure", + "members": { + "SkillGroupArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "SkillGroup": { + "type": "structure", + "members": { + "SkillGroupArn": {}, + "SkillGroupName": {}, + "Description": {} + } + } + } + } + }, + "ListBusinessReportSchedules": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "BusinessReportSchedules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ScheduleArn": {}, + "ScheduleName": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "Format": {}, + "ContentRange": { + "shape": "Sp" + }, + "Recurrence": { + "shape": "Sr" + }, + "LastBusinessReport": { + "type": "structure", + "members": { + "Status": {}, + "FailureCode": {}, + "S3Location": { + "type": "structure", + "members": { + "Path": {}, + "BucketName": {} + } + }, + "DeliveryTime": { + "type": "timestamp" + }, + "DownloadUrl": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "ListConferenceProviders": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConferenceProviders": { + "type": "list", + "member": { + "shape": "S3m" + } + }, + "NextToken": {} + } + } + }, + "ListDeviceEvents": { + "input": { + "type": "structure", + "required": [ + "DeviceArn" + ], + "members": { + "DeviceArn": {}, + "EventType": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeviceEvents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Value": {}, + "Timestamp": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListGatewayGroups": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "Name": {}, + "Description": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListGateways": { + "input": { + "type": "structure", + "members": { + "GatewayGroupArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Gateways": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "Name": {}, + "Description": {}, + "GatewayGroupArn": {}, + "SoftwareVersion": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListSkills": { + "input": { + "type": "structure", + "members": { + "SkillGroupArn": {}, + "EnablementType": {}, + "SkillType": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SkillSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SkillId": {}, + "SkillName": {}, + "SupportsLinking": { + "type": "boolean" + }, + "EnablementType": {}, + "SkillType": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListSkillsStoreCategories": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "CategoryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CategoryId": { + "type": "long" + }, + "CategoryName": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListSkillsStoreSkillsByCategory": { + "input": { + "type": "structure", + "required": [ + "CategoryId" + ], + "members": { + "CategoryId": { + "type": "long" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SkillsStoreSkills": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SkillId": {}, + "SkillName": {}, + "ShortDescription": {}, + "IconUrl": {}, + "SampleUtterances": { + "type": "list", + "member": {} + }, + "SkillDetails": { + "type": "structure", + "members": { + "ProductDescription": {}, + "InvocationPhrase": {}, + "ReleaseDate": {}, + "EndUserLicenseAgreement": {}, + "GenericKeywords": { + "type": "list", + "member": {} + }, + "BulletPoints": { + "type": "list", + "member": {} + }, + "NewInThisVersionBulletPoints": { + "type": "list", + "member": {} + }, + "SkillTypes": { + "type": "list", + "member": {} + }, + "Reviews": { + "type": "map", + "key": {}, + "value": {} + }, + "DeveloperInfo": { + "type": "structure", + "members": { + "DeveloperName": {}, + "PrivacyPolicy": {}, + "Email": {}, + "Url": {} + } + } + } + }, + "SupportsLinking": { + "type": "boolean" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListSmartHomeAppliances": { + "input": { + "type": "structure", + "required": [ + "RoomArn" + ], + "members": { + "RoomArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SmartHomeAppliances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FriendlyName": {}, + "Description": {}, + "ManufacturerName": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTags": { + "input": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S1u" + }, + "NextToken": {} + } + } + }, + "PutConferencePreference": { + "input": { + "type": "structure", + "required": [ + "ConferencePreference" + ], + "members": { + "ConferencePreference": { + "shape": "S3j" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutInvitationConfiguration": { + "input": { + "type": "structure", + "required": [ + "OrganizationName" + ], + "members": { + "OrganizationName": {}, + "ContactEmail": {}, + "PrivateSkillIds": { + "shape": "S4g" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutRoomSkillParameter": { + "input": { + "type": "structure", + "required": [ + "SkillId", + "RoomSkillParameter" + ], + "members": { + "RoomArn": {}, + "SkillId": {}, + "RoomSkillParameter": { + "shape": "S4p" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutSkillAuthorization": { + "input": { + "type": "structure", + "required": [ + "AuthorizationResult", + "SkillId" + ], + "members": { + "AuthorizationResult": { + "type": "map", + "key": {}, + "value": {}, + "sensitive": true + }, + "SkillId": {}, + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RegisterAVSDevice": { + "input": { + "type": "structure", + "required": [ + "ClientId", + "UserCode", + "ProductId", + "DeviceSerialNumber", + "AmazonId" + ], + "members": { + "ClientId": {}, + "UserCode": {}, + "ProductId": {}, + "DeviceSerialNumber": {}, + "AmazonId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DeviceArn": {} + } + } + }, + "RejectSkill": { + "input": { + "type": "structure", + "required": [ + "SkillId" + ], + "members": { + "SkillId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ResolveRoom": { + "input": { + "type": "structure", + "required": [ + "UserId", + "SkillId" + ], + "members": { + "UserId": {}, + "SkillId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RoomArn": {}, + "RoomName": {}, + "RoomSkillParameters": { + "type": "list", + "member": { + "shape": "S4p" + } + } + } + } + }, + "RevokeInvitation": { + "input": { + "type": "structure", + "members": { + "UserArn": {}, + "EnrollmentId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SearchAddressBooks": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S7x" + }, + "SortCriteria": { + "shape": "S82" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AddressBooks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AddressBookArn": {}, + "Name": {}, + "Description": {} + } + } + }, + "NextToken": {}, + "TotalCount": { + "type": "integer" + } + } + } + }, + "SearchContacts": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S7x" + }, + "SortCriteria": { + "shape": "S82" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Contacts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ContactArn": {}, + "DisplayName": {}, + "FirstName": {}, + "LastName": {}, + "PhoneNumber": { + "shape": "S1a" + } + } + } + }, + "NextToken": {}, + "TotalCount": { + "type": "integer" + } + } + } + }, + "SearchDevices": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "S7x" + }, + "SortCriteria": { + "shape": "S82" + } + } + }, + "output": { + "type": "structure", + "members": { + "Devices": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DeviceArn": {}, + "DeviceSerialNumber": {}, + "DeviceType": {}, + "DeviceName": {}, + "SoftwareVersion": {}, + "MacAddress": {}, + "DeviceStatus": {}, + "RoomArn": {}, + "RoomName": {}, + "DeviceStatusInfo": { + "shape": "S3z" + } + } + } + }, + "NextToken": {}, + "TotalCount": { + "type": "integer" + } + } + } + }, + "SearchProfiles": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "S7x" + }, + "SortCriteria": { + "shape": "S82" + } + } + }, + "output": { + "type": "structure", + "members": { + "Profiles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProfileArn": {}, + "ProfileName": {}, + "IsDefault": { + "type": "boolean" + }, + "Address": {}, + "Timezone": {}, + "DistanceUnit": {}, + "TemperatureUnit": {}, + "WakeWord": {} + } + } + }, + "NextToken": {}, + "TotalCount": { + "type": "integer" + } + } + } + }, + "SearchRooms": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "S7x" + }, + "SortCriteria": { + "shape": "S82" + } + } + }, + "output": { + "type": "structure", + "members": { + "Rooms": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RoomArn": {}, + "RoomName": {}, + "Description": {}, + "ProviderCalendarId": {}, + "ProfileArn": {}, + "ProfileName": {} + } + } + }, + "NextToken": {}, + "TotalCount": { + "type": "integer" + } + } + } + }, + "SearchSkillGroups": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "S7x" + }, + "SortCriteria": { + "shape": "S82" + } + } + }, + "output": { + "type": "structure", + "members": { + "SkillGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SkillGroupArn": {}, + "SkillGroupName": {}, + "Description": {} + } + } + }, + "NextToken": {}, + "TotalCount": { + "type": "integer" + } + } + } + }, + "SearchUsers": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "S7x" + }, + "SortCriteria": { + "shape": "S82" + } + } + }, + "output": { + "type": "structure", + "members": { + "Users": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UserArn": {}, + "FirstName": {}, + "LastName": {}, + "Email": {}, + "EnrollmentStatus": {}, + "EnrollmentId": {} + } + } + }, + "NextToken": {}, + "TotalCount": { + "type": "integer" + } + } + } + }, + "SendAnnouncement": { + "input": { + "type": "structure", + "required": [ + "RoomFilters", + "Content", + "ClientRequestToken" + ], + "members": { + "RoomFilters": { + "shape": "S7x" + }, + "Content": { + "type": "structure", + "members": { + "TextList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Locale", + "Value" + ], + "members": { + "Locale": {}, + "Value": {} + } + } + }, + "SsmlList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Locale", + "Value" + ], + "members": { + "Locale": {}, + "Value": {} + } + } + }, + "AudioList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Locale", + "Location" + ], + "members": { + "Locale": {}, + "Location": {} + } + } + } + } + }, + "TimeToLiveInSeconds": { + "type": "integer" + }, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "AnnouncementArn": {} + } + } + }, + "SendInvitation": { + "input": { + "type": "structure", + "members": { + "UserArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartDeviceSync": { + "input": { + "type": "structure", + "required": [ + "Features" + ], + "members": { + "RoomArn": {}, + "DeviceArn": {}, + "Features": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartSmartHomeApplianceDiscovery": { + "input": { + "type": "structure", + "required": [ + "RoomArn" + ], + "members": { + "RoomArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "Arn", + "Tags" + ], + "members": { + "Arn": {}, + "Tags": { + "shape": "S1u" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "Arn", + "TagKeys" + ], + "members": { + "Arn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateAddressBook": { + "input": { + "type": "structure", + "required": [ + "AddressBookArn" + ], + "members": { + "AddressBookArn": {}, + "Name": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateBusinessReportSchedule": { + "input": { + "type": "structure", + "required": [ + "ScheduleArn" + ], + "members": { + "ScheduleArn": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "Format": {}, + "ScheduleName": {}, + "Recurrence": { + "shape": "Sr" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateConferenceProvider": { + "input": { + "type": "structure", + "required": [ + "ConferenceProviderArn", + "ConferenceProviderType", + "MeetingSetting" + ], + "members": { + "ConferenceProviderArn": {}, + "ConferenceProviderType": {}, + "IPDialIn": { + "shape": "Sx" + }, + "PSTNDialIn": { + "shape": "S10" + }, + "MeetingSetting": { + "shape": "S15" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateContact": { + "input": { + "type": "structure", + "required": [ + "ContactArn" + ], + "members": { + "ContactArn": {}, + "DisplayName": {}, + "FirstName": {}, + "LastName": {}, + "PhoneNumber": { + "shape": "S1a" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDevice": { + "input": { + "type": "structure", + "members": { + "DeviceArn": {}, + "DeviceName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayArn" + ], + "members": { + "GatewayArn": {}, + "Name": {}, + "Description": {}, + "SoftwareVersion": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateGatewayGroup": { + "input": { + "type": "structure", + "required": [ + "GatewayGroupArn" + ], + "members": { + "GatewayGroupArn": {}, + "Name": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateProfile": { + "input": { + "type": "structure", + "members": { + "ProfileArn": {}, + "ProfileName": {}, + "IsDefault": { + "type": "boolean" + }, + "Timezone": {}, + "Address": {}, + "DistanceUnit": {}, + "TemperatureUnit": {}, + "WakeWord": {}, + "SetupModeDisabled": { + "type": "boolean" + }, + "MaxVolumeLimit": { + "type": "integer" + }, + "PSTNEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateRoom": { + "input": { + "type": "structure", + "members": { + "RoomArn": {}, + "RoomName": {}, + "Description": {}, + "ProviderCalendarId": {}, + "ProfileArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateSkillGroup": { + "input": { + "type": "structure", + "members": { + "SkillGroupArn": {}, + "SkillGroupName": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sp": { + "type": "structure", + "members": { + "Interval": {} + } + }, + "Sr": { + "type": "structure", + "members": { + "StartDate": {} + } + }, + "Sx": { + "type": "structure", + "required": [ + "Endpoint", + "CommsProtocol" + ], + "members": { + "Endpoint": {}, + "CommsProtocol": {} + } + }, + "S10": { + "type": "structure", + "required": [ + "CountryCode", + "PhoneNumber", + "OneClickIdDelay", + "OneClickPinDelay" + ], + "members": { + "CountryCode": {}, + "PhoneNumber": {}, + "OneClickIdDelay": {}, + "OneClickPinDelay": {} + } + }, + "S15": { + "type": "structure", + "required": [ + "RequirePin" + ], + "members": { + "RequirePin": {} + } + }, + "S1a": { + "type": "string", + "sensitive": true + }, + "S1u": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S3j": { + "type": "structure", + "members": { + "DefaultConferenceProviderArn": {} + } + }, + "S3m": { + "type": "structure", + "members": { + "Arn": {}, + "Name": {}, + "Type": {}, + "IPDialIn": { + "shape": "Sx" + }, + "PSTNDialIn": { + "shape": "S10" + }, + "MeetingSetting": { + "shape": "S15" + } + } + }, + "S3z": { + "type": "structure", + "members": { + "DeviceStatusDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Code": {} + } + } + }, + "ConnectionStatus": {} + } + }, + "S4g": { + "type": "list", + "member": {} + }, + "S4p": { + "type": "structure", + "required": [ + "ParameterKey", + "ParameterValue" + ], + "members": { + "ParameterKey": {}, + "ParameterValue": {} + } + }, + "S7x": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "S82": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.paginators.json b/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.paginators.json new file mode 100644 index 0000000..4eda436 --- /dev/null +++ b/node_modules/aws-sdk/apis/alexaforbusiness-2017-11-09.paginators.json @@ -0,0 +1,89 @@ +{ + "pagination": { + "ListBusinessReportSchedules": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListConferenceProviders": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDeviceEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGatewayGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGateways": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSkills": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSkillsStoreCategories": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSkillsStoreSkillsByCategory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSmartHomeAppliances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTags": { + "input_token": "NextToken", + "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", + "limit_key": "MaxResults" + }, + "SearchProfiles": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchRooms": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchSkillGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchUsers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/amplify-2017-07-25.examples.json b/node_modules/aws-sdk/apis/amplify-2017-07-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/amplify-2017-07-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/amplify-2017-07-25.min.json b/node_modules/aws-sdk/apis/amplify-2017-07-25.min.json new file mode 100644 index 0000000..ebbe60f --- /dev/null +++ b/node_modules/aws-sdk/apis/amplify-2017-07-25.min.json @@ -0,0 +1,1086 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-07-25", + "endpointPrefix": "amplify", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "Amplify", + "serviceFullName": "AWS Amplify", + "serviceId": "Amplify", + "signatureVersion": "v4", + "signingName": "amplify", + "uid": "amplify-2017-07-25" + }, + "operations": { + "CreateApp": { + "http": { + "requestUri": "/apps" + }, + "input": { + "type": "structure", + "required": [ + "name", + "repository", + "platform", + "oauthToken" + ], + "members": { + "name": {}, + "description": {}, + "repository": {}, + "platform": {}, + "iamServiceRoleArn": {}, + "oauthToken": {}, + "environmentVariables": { + "shape": "S8" + }, + "enableBranchAutoBuild": { + "type": "boolean" + }, + "enableBasicAuth": { + "type": "boolean" + }, + "basicAuthCredentials": {}, + "customRules": { + "shape": "Se" + }, + "tags": { + "shape": "Sk" + }, + "buildSpec": {} + } + }, + "output": { + "type": "structure", + "required": [ + "app" + ], + "members": { + "app": { + "shape": "Sp" + } + } + } + }, + "CreateBranch": { + "http": { + "requestUri": "/apps/{appId}/branches" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": {}, + "description": {}, + "stage": {}, + "framework": {}, + "enableNotification": { + "type": "boolean" + }, + "enableAutoBuild": { + "type": "boolean" + }, + "environmentVariables": { + "shape": "S8" + }, + "basicAuthCredentials": {}, + "enableBasicAuth": { + "type": "boolean" + }, + "tags": { + "shape": "Sk" + }, + "buildSpec": {}, + "ttl": {} + } + }, + "output": { + "type": "structure", + "required": [ + "branch" + ], + "members": { + "branch": { + "shape": "S16" + } + } + } + }, + "CreateDomainAssociation": { + "http": { + "requestUri": "/apps/{appId}/domains" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "domainName", + "subDomainSettings" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "domainName": {}, + "enableAutoSubDomain": { + "type": "boolean" + }, + "subDomainSettings": { + "shape": "S1g" + } + } + }, + "output": { + "type": "structure", + "required": [ + "domainAssociation" + ], + "members": { + "domainAssociation": { + "shape": "S1k" + } + } + } + }, + "DeleteApp": { + "http": { + "method": "DELETE", + "requestUri": "/apps/{appId}" + }, + "input": { + "type": "structure", + "required": [ + "appId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "app" + ], + "members": { + "app": { + "shape": "Sp" + } + } + } + }, + "DeleteBranch": { + "http": { + "method": "DELETE", + "requestUri": "/apps/{appId}/branches/{branchName}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "branch" + ], + "members": { + "branch": { + "shape": "S16" + } + } + } + }, + "DeleteDomainAssociation": { + "http": { + "method": "DELETE", + "requestUri": "/apps/{appId}/domains/{domainName}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "domainName" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "domainName": { + "location": "uri", + "locationName": "domainName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "domainAssociation" + ], + "members": { + "domainAssociation": { + "shape": "S1k" + } + } + } + }, + "DeleteJob": { + "http": { + "method": "DELETE", + "requestUri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName", + "jobId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "jobSummary" + ], + "members": { + "jobSummary": { + "shape": "S22" + } + } + } + }, + "GetApp": { + "http": { + "method": "GET", + "requestUri": "/apps/{appId}" + }, + "input": { + "type": "structure", + "required": [ + "appId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "app" + ], + "members": { + "app": { + "shape": "Sp" + } + } + } + }, + "GetBranch": { + "http": { + "method": "GET", + "requestUri": "/apps/{appId}/branches/{branchName}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "branch" + ], + "members": { + "branch": { + "shape": "S16" + } + } + } + }, + "GetDomainAssociation": { + "http": { + "method": "GET", + "requestUri": "/apps/{appId}/domains/{domainName}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "domainName" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "domainName": { + "location": "uri", + "locationName": "domainName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "domainAssociation" + ], + "members": { + "domainAssociation": { + "shape": "S1k" + } + } + } + }, + "GetJob": { + "http": { + "method": "GET", + "requestUri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName", + "jobId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "job" + ], + "members": { + "job": { + "type": "structure", + "required": [ + "summary", + "steps" + ], + "members": { + "summary": { + "shape": "S22" + }, + "steps": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "stepName", + "startTime", + "status", + "endTime" + ], + "members": { + "stepName": {}, + "startTime": { + "type": "timestamp" + }, + "status": {}, + "endTime": { + "type": "timestamp" + }, + "logUrl": {}, + "artifactsUrl": {}, + "screenshots": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + } + } + } + }, + "ListApps": { + "http": { + "method": "GET", + "requestUri": "/apps" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "apps" + ], + "members": { + "apps": { + "type": "list", + "member": { + "shape": "Sp" + } + }, + "nextToken": {} + } + } + }, + "ListBranches": { + "http": { + "method": "GET", + "requestUri": "/apps/{appId}/branches" + }, + "input": { + "type": "structure", + "required": [ + "appId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "branches" + ], + "members": { + "branches": { + "type": "list", + "member": { + "shape": "S16" + } + }, + "nextToken": {} + } + } + }, + "ListDomainAssociations": { + "http": { + "method": "GET", + "requestUri": "/apps/{appId}/domains" + }, + "input": { + "type": "structure", + "required": [ + "appId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "domainAssociations" + ], + "members": { + "domainAssociations": { + "type": "list", + "member": { + "shape": "S1k" + } + }, + "nextToken": {} + } + } + }, + "ListJobs": { + "http": { + "method": "GET", + "requestUri": "/apps/{appId}/branches/{branchName}/jobs" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "jobSummaries" + ], + "members": { + "jobSummaries": { + "type": "list", + "member": { + "shape": "S22" + } + }, + "nextToken": {} + } + } + }, + "StartJob": { + "http": { + "requestUri": "/apps/{appId}/branches/{branchName}/jobs" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName", + "jobType" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + }, + "jobId": {}, + "jobType": {}, + "jobReason": {}, + "commitId": {}, + "commitMessage": {}, + "commitTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "required": [ + "jobSummary" + ], + "members": { + "jobSummary": { + "shape": "S22" + } + } + } + }, + "StopJob": { + "http": { + "method": "DELETE", + "requestUri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}/stop" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName", + "jobId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "jobSummary" + ], + "members": { + "jobSummary": { + "shape": "S22" + } + } + } + }, + "UpdateApp": { + "http": { + "requestUri": "/apps/{appId}" + }, + "input": { + "type": "structure", + "required": [ + "appId" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "name": {}, + "description": {}, + "platform": {}, + "iamServiceRoleArn": {}, + "environmentVariables": { + "shape": "S8" + }, + "enableBranchAutoBuild": { + "type": "boolean" + }, + "enableBasicAuth": { + "type": "boolean" + }, + "basicAuthCredentials": {}, + "customRules": { + "shape": "Se" + }, + "buildSpec": {} + } + }, + "output": { + "type": "structure", + "required": [ + "app" + ], + "members": { + "app": { + "shape": "Sp" + } + } + } + }, + "UpdateBranch": { + "http": { + "requestUri": "/apps/{appId}/branches/{branchName}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "branchName" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "branchName": { + "location": "uri", + "locationName": "branchName" + }, + "description": {}, + "framework": {}, + "stage": {}, + "enableNotification": { + "type": "boolean" + }, + "enableAutoBuild": { + "type": "boolean" + }, + "environmentVariables": { + "shape": "S8" + }, + "basicAuthCredentials": {}, + "enableBasicAuth": { + "type": "boolean" + }, + "buildSpec": {}, + "ttl": {} + } + }, + "output": { + "type": "structure", + "required": [ + "branch" + ], + "members": { + "branch": { + "shape": "S16" + } + } + } + }, + "UpdateDomainAssociation": { + "http": { + "requestUri": "/apps/{appId}/domains/{domainName}" + }, + "input": { + "type": "structure", + "required": [ + "appId", + "domainName", + "subDomainSettings" + ], + "members": { + "appId": { + "location": "uri", + "locationName": "appId" + }, + "domainName": { + "location": "uri", + "locationName": "domainName" + }, + "enableAutoSubDomain": { + "type": "boolean" + }, + "subDomainSettings": { + "shape": "S1g" + } + } + }, + "output": { + "type": "structure", + "required": [ + "domainAssociation" + ], + "members": { + "domainAssociation": { + "shape": "S1k" + } + } + } + } + }, + "shapes": { + "S8": { + "type": "map", + "key": {}, + "value": {} + }, + "Se": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "source", + "target" + ], + "members": { + "source": {}, + "target": {}, + "status": {}, + "condition": {} + } + } + }, + "Sk": { + "type": "map", + "key": {}, + "value": {} + }, + "Sp": { + "type": "structure", + "required": [ + "appId", + "appArn", + "name", + "description", + "repository", + "platform", + "createTime", + "updateTime", + "environmentVariables", + "defaultDomain", + "enableBranchAutoBuild", + "enableBasicAuth" + ], + "members": { + "appId": {}, + "appArn": {}, + "name": {}, + "tags": { + "shape": "Sk" + }, + "description": {}, + "repository": {}, + "platform": {}, + "createTime": { + "type": "timestamp" + }, + "updateTime": { + "type": "timestamp" + }, + "iamServiceRoleArn": {}, + "environmentVariables": { + "shape": "S8" + }, + "defaultDomain": {}, + "enableBranchAutoBuild": { + "type": "boolean" + }, + "enableBasicAuth": { + "type": "boolean" + }, + "basicAuthCredentials": {}, + "customRules": { + "shape": "Se" + }, + "productionBranch": { + "type": "structure", + "members": { + "lastDeployTime": { + "type": "timestamp" + }, + "status": {}, + "thumbnailUrl": {}, + "branchName": {} + } + }, + "buildSpec": {} + } + }, + "S16": { + "type": "structure", + "required": [ + "branchArn", + "branchName", + "description", + "stage", + "enableNotification", + "createTime", + "updateTime", + "environmentVariables", + "enableAutoBuild", + "customDomains", + "framework", + "activeJobId", + "totalNumberOfJobs", + "enableBasicAuth", + "ttl" + ], + "members": { + "branchArn": {}, + "branchName": {}, + "description": {}, + "tags": { + "shape": "Sk" + }, + "stage": {}, + "displayName": {}, + "enableNotification": { + "type": "boolean" + }, + "createTime": { + "type": "timestamp" + }, + "updateTime": { + "type": "timestamp" + }, + "environmentVariables": { + "shape": "S8" + }, + "enableAutoBuild": { + "type": "boolean" + }, + "customDomains": { + "type": "list", + "member": {} + }, + "framework": {}, + "activeJobId": {}, + "totalNumberOfJobs": {}, + "enableBasicAuth": { + "type": "boolean" + }, + "thumbnailUrl": {}, + "basicAuthCredentials": {}, + "buildSpec": {}, + "ttl": {} + } + }, + "S1g": { + "type": "list", + "member": { + "shape": "S1h" + } + }, + "S1h": { + "type": "structure", + "required": [ + "prefix", + "branchName" + ], + "members": { + "prefix": {}, + "branchName": {} + } + }, + "S1k": { + "type": "structure", + "required": [ + "domainAssociationArn", + "domainName", + "enableAutoSubDomain", + "domainStatus", + "statusReason", + "certificateVerificationDNSRecord", + "subDomains" + ], + "members": { + "domainAssociationArn": {}, + "domainName": {}, + "enableAutoSubDomain": { + "type": "boolean" + }, + "domainStatus": {}, + "statusReason": {}, + "certificateVerificationDNSRecord": {}, + "subDomains": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "subDomainSetting", + "verified", + "dnsRecord" + ], + "members": { + "subDomainSetting": { + "shape": "S1h" + }, + "verified": { + "type": "boolean" + }, + "dnsRecord": {} + } + } + } + } + }, + "S22": { + "type": "structure", + "required": [ + "jobArn", + "jobId", + "commitId", + "commitMessage", + "commitTime", + "startTime", + "status", + "jobType" + ], + "members": { + "jobArn": {}, + "jobId": {}, + "commitId": {}, + "commitMessage": {}, + "commitTime": { + "type": "timestamp" + }, + "startTime": { + "type": "timestamp" + }, + "status": {}, + "endTime": { + "type": "timestamp" + }, + "jobType": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/amplify-2017-07-25.paginators.json b/node_modules/aws-sdk/apis/amplify-2017-07-25.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/amplify-2017-07-25.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/apigateway-2015-07-09.examples.json b/node_modules/aws-sdk/apis/apigateway-2015-07-09.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/apigateway-2015-07-09.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/apigateway-2015-07-09.min.json b/node_modules/aws-sdk/apis/apigateway-2015-07-09.min.json new file mode 100644 index 0000000..3558452 --- /dev/null +++ b/node_modules/aws-sdk/apis/apigateway-2015-07-09.min.json @@ -0,0 +1,4322 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-07-09", + "endpointPrefix": "apigateway", + "protocol": "rest-json", + "serviceFullName": "Amazon API Gateway", + "serviceId": "API Gateway", + "signatureVersion": "v4", + "uid": "apigateway-2015-07-09" + }, + "operations": { + "CreateApiKey": { + "http": { + "requestUri": "/apikeys", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "enabled": { + "type": "boolean" + }, + "generateDistinctId": { + "type": "boolean" + }, + "value": {}, + "stageKeys": { + "type": "list", + "member": { + "type": "structure", + "members": { + "restApiId": {}, + "stageName": {} + } + } + }, + "customerId": {} + } + }, + "output": { + "shape": "S6" + } + }, + "CreateAuthorizer": { + "http": { + "requestUri": "/restapis/{restapi_id}/authorizers", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "name", + "type" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "name": {}, + "type": {}, + "providerARNs": { + "shape": "Sb" + }, + "authType": {}, + "authorizerUri": {}, + "authorizerCredentials": {}, + "identitySource": {}, + "identityValidationExpression": {}, + "authorizerResultTtlInSeconds": { + "type": "integer" + } + } + }, + "output": { + "shape": "Se" + } + }, + "CreateBasePathMapping": { + "http": { + "requestUri": "/domainnames/{domain_name}/basepathmappings", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "domainName", + "restApiId" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + }, + "basePath": {}, + "restApiId": {}, + "stage": {} + } + }, + "output": { + "shape": "Sg" + } + }, + "CreateDeployment": { + "http": { + "requestUri": "/restapis/{restapi_id}/deployments", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": {}, + "stageDescription": {}, + "description": {}, + "cacheClusterEnabled": { + "type": "boolean" + }, + "cacheClusterSize": {}, + "variables": { + "shape": "Sk" + }, + "canarySettings": { + "type": "structure", + "members": { + "percentTraffic": { + "type": "double" + }, + "stageVariableOverrides": { + "shape": "Sk" + }, + "useStageCache": { + "type": "boolean" + } + } + }, + "tracingEnabled": { + "type": "boolean" + } + } + }, + "output": { + "shape": "Sn" + } + }, + "CreateDocumentationPart": { + "http": { + "requestUri": "/restapis/{restapi_id}/documentation/parts", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "location", + "properties" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "location": { + "shape": "Ss" + }, + "properties": {} + } + }, + "output": { + "shape": "Sv" + } + }, + "CreateDocumentationVersion": { + "http": { + "requestUri": "/restapis/{restapi_id}/documentation/versions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "documentationVersion" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "documentationVersion": {}, + "stageName": {}, + "description": {} + } + }, + "output": { + "shape": "Sx" + } + }, + "CreateDomainName": { + "http": { + "requestUri": "/domainnames", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": {}, + "certificateName": {}, + "certificateBody": {}, + "certificatePrivateKey": {}, + "certificateChain": {}, + "certificateArn": {}, + "regionalCertificateName": {}, + "regionalCertificateArn": {}, + "endpointConfiguration": { + "shape": "Sz" + } + } + }, + "output": { + "shape": "S12" + } + }, + "CreateModel": { + "http": { + "requestUri": "/restapis/{restapi_id}/models", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "name", + "contentType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "name": {}, + "description": {}, + "schema": {}, + "contentType": {} + } + }, + "output": { + "shape": "S14" + } + }, + "CreateRequestValidator": { + "http": { + "requestUri": "/restapis/{restapi_id}/requestvalidators", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "name": {}, + "validateRequestBody": { + "type": "boolean" + }, + "validateRequestParameters": { + "type": "boolean" + } + } + }, + "output": { + "shape": "S16" + } + }, + "CreateResource": { + "http": { + "requestUri": "/restapis/{restapi_id}/resources/{parent_id}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "parentId", + "pathPart" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "parentId": { + "location": "uri", + "locationName": "parent_id" + }, + "pathPart": {} + } + }, + "output": { + "shape": "S18" + } + }, + "CreateRestApi": { + "http": { + "requestUri": "/restapis", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "description": {}, + "version": {}, + "cloneFrom": {}, + "binaryMediaTypes": { + "shape": "S8" + }, + "minimumCompressionSize": { + "type": "integer" + }, + "apiKeySource": {}, + "endpointConfiguration": { + "shape": "Sz" + }, + "policy": {} + } + }, + "output": { + "shape": "S1o" + } + }, + "CreateStage": { + "http": { + "requestUri": "/restapis/{restapi_id}/stages", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName", + "deploymentId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": {}, + "deploymentId": {}, + "description": {}, + "cacheClusterEnabled": { + "type": "boolean" + }, + "cacheClusterSize": {}, + "variables": { + "shape": "Sk" + }, + "documentationVersion": {}, + "canarySettings": { + "shape": "S1q" + }, + "tracingEnabled": { + "type": "boolean" + }, + "tags": { + "shape": "Sk" + } + } + }, + "output": { + "shape": "S1r" + } + }, + "CreateUsagePlan": { + "http": { + "requestUri": "/usageplans", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "description": {}, + "apiStages": { + "shape": "S1y" + }, + "throttle": { + "shape": "S21" + }, + "quota": { + "shape": "S22" + } + } + }, + "output": { + "shape": "S24" + } + }, + "CreateUsagePlanKey": { + "http": { + "requestUri": "/usageplans/{usageplanId}/keys", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId", + "keyId", + "keyType" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + }, + "keyId": {}, + "keyType": {} + } + }, + "output": { + "shape": "S26" + } + }, + "CreateVpcLink": { + "http": { + "requestUri": "/vpclinks", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "name", + "targetArns" + ], + "members": { + "name": {}, + "description": {}, + "targetArns": { + "shape": "S8" + } + } + }, + "output": { + "shape": "S28" + } + }, + "DeleteApiKey": { + "http": { + "method": "DELETE", + "requestUri": "/apikeys/{api_Key}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "apiKey" + ], + "members": { + "apiKey": { + "location": "uri", + "locationName": "api_Key" + } + } + } + }, + "DeleteAuthorizer": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/authorizers/{authorizer_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "authorizerId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "authorizerId": { + "location": "uri", + "locationName": "authorizer_id" + } + } + } + }, + "DeleteBasePathMapping": { + "http": { + "method": "DELETE", + "requestUri": "/domainnames/{domain_name}/basepathmappings/{base_path}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "domainName", + "basePath" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + }, + "basePath": { + "location": "uri", + "locationName": "base_path" + } + } + } + }, + "DeleteClientCertificate": { + "http": { + "method": "DELETE", + "requestUri": "/clientcertificates/{clientcertificate_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "clientCertificateId" + ], + "members": { + "clientCertificateId": { + "location": "uri", + "locationName": "clientcertificate_id" + } + } + } + }, + "DeleteDeployment": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/deployments/{deployment_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "deploymentId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "deploymentId": { + "location": "uri", + "locationName": "deployment_id" + } + } + } + }, + "DeleteDocumentationPart": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/documentation/parts/{part_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "documentationPartId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "documentationPartId": { + "location": "uri", + "locationName": "part_id" + } + } + } + }, + "DeleteDocumentationVersion": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/documentation/versions/{doc_version}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "documentationVersion" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "documentationVersion": { + "location": "uri", + "locationName": "doc_version" + } + } + } + }, + "DeleteDomainName": { + "http": { + "method": "DELETE", + "requestUri": "/domainnames/{domain_name}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + } + } + } + }, + "DeleteGatewayResponse": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/gatewayresponses/{response_type}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "responseType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "responseType": { + "location": "uri", + "locationName": "response_type" + } + } + } + }, + "DeleteIntegration": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + } + } + } + }, + "DeleteIntegrationResponse": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + } + } + } + }, + "DeleteMethod": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + } + } + } + }, + "DeleteMethodResponse": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + } + } + } + }, + "DeleteModel": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/models/{model_name}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "modelName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "modelName": { + "location": "uri", + "locationName": "model_name" + } + } + } + }, + "DeleteRequestValidator": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "requestValidatorId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "requestValidatorId": { + "location": "uri", + "locationName": "requestvalidator_id" + } + } + } + }, + "DeleteResource": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + } + } + } + }, + "DeleteRestApi": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + } + } + } + }, + "DeleteStage": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/stages/{stage_name}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": { + "location": "uri", + "locationName": "stage_name" + } + } + } + }, + "DeleteUsagePlan": { + "http": { + "method": "DELETE", + "requestUri": "/usageplans/{usageplanId}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + } + } + } + }, + "DeleteUsagePlanKey": { + "http": { + "method": "DELETE", + "requestUri": "/usageplans/{usageplanId}/keys/{keyId}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId", + "keyId" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + }, + "keyId": { + "location": "uri", + "locationName": "keyId" + } + } + } + }, + "DeleteVpcLink": { + "http": { + "method": "DELETE", + "requestUri": "/vpclinks/{vpclink_id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "vpcLinkId" + ], + "members": { + "vpcLinkId": { + "location": "uri", + "locationName": "vpclink_id" + } + } + } + }, + "FlushStageAuthorizersCache": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": { + "location": "uri", + "locationName": "stage_name" + } + } + } + }, + "FlushStageCache": { + "http": { + "method": "DELETE", + "requestUri": "/restapis/{restapi_id}/stages/{stage_name}/cache/data", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": { + "location": "uri", + "locationName": "stage_name" + } + } + } + }, + "GenerateClientCertificate": { + "http": { + "requestUri": "/clientcertificates", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "description": {} + } + }, + "output": { + "shape": "S2z" + } + }, + "GetAccount": { + "http": { + "method": "GET", + "requestUri": "/account" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "shape": "S31" + } + }, + "GetApiKey": { + "http": { + "method": "GET", + "requestUri": "/apikeys/{api_Key}" + }, + "input": { + "type": "structure", + "required": [ + "apiKey" + ], + "members": { + "apiKey": { + "location": "uri", + "locationName": "api_Key" + }, + "includeValue": { + "location": "querystring", + "locationName": "includeValue", + "type": "boolean" + } + } + }, + "output": { + "shape": "S6" + } + }, + "GetApiKeys": { + "http": { + "method": "GET", + "requestUri": "/apikeys" + }, + "input": { + "type": "structure", + "members": { + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "nameQuery": { + "location": "querystring", + "locationName": "name" + }, + "customerId": { + "location": "querystring", + "locationName": "customerId" + }, + "includeValues": { + "location": "querystring", + "locationName": "includeValues", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "warnings": { + "shape": "S8" + }, + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S6" + } + } + } + } + }, + "GetAuthorizer": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/authorizers/{authorizer_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "authorizerId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "authorizerId": { + "location": "uri", + "locationName": "authorizer_id" + } + } + }, + "output": { + "shape": "Se" + } + }, + "GetAuthorizers": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/authorizers" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "Se" + } + } + } + } + }, + "GetBasePathMapping": { + "http": { + "method": "GET", + "requestUri": "/domainnames/{domain_name}/basepathmappings/{base_path}" + }, + "input": { + "type": "structure", + "required": [ + "domainName", + "basePath" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + }, + "basePath": { + "location": "uri", + "locationName": "base_path" + } + } + }, + "output": { + "shape": "Sg" + } + }, + "GetBasePathMappings": { + "http": { + "method": "GET", + "requestUri": "/domainnames/{domain_name}/basepathmappings" + }, + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "Sg" + } + } + } + } + }, + "GetClientCertificate": { + "http": { + "method": "GET", + "requestUri": "/clientcertificates/{clientcertificate_id}" + }, + "input": { + "type": "structure", + "required": [ + "clientCertificateId" + ], + "members": { + "clientCertificateId": { + "location": "uri", + "locationName": "clientcertificate_id" + } + } + }, + "output": { + "shape": "S2z" + } + }, + "GetClientCertificates": { + "http": { + "method": "GET", + "requestUri": "/clientcertificates" + }, + "input": { + "type": "structure", + "members": { + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S2z" + } + } + } + } + }, + "GetDeployment": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/deployments/{deployment_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "deploymentId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "deploymentId": { + "location": "uri", + "locationName": "deployment_id" + }, + "embed": { + "shape": "S8", + "location": "querystring", + "locationName": "embed" + } + } + }, + "output": { + "shape": "Sn" + } + }, + "GetDeployments": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/deployments" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "Sn" + } + } + } + } + }, + "GetDocumentationPart": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/documentation/parts/{part_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "documentationPartId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "documentationPartId": { + "location": "uri", + "locationName": "part_id" + } + } + }, + "output": { + "shape": "Sv" + } + }, + "GetDocumentationParts": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/documentation/parts" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "type": { + "location": "querystring", + "locationName": "type" + }, + "nameQuery": { + "location": "querystring", + "locationName": "name" + }, + "path": { + "location": "querystring", + "locationName": "path" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "locationStatus": { + "location": "querystring", + "locationName": "locationStatus" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "Sv" + } + } + } + } + }, + "GetDocumentationVersion": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/documentation/versions/{doc_version}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "documentationVersion" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "documentationVersion": { + "location": "uri", + "locationName": "doc_version" + } + } + }, + "output": { + "shape": "Sx" + } + }, + "GetDocumentationVersions": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/documentation/versions" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "Sx" + } + } + } + } + }, + "GetDomainName": { + "http": { + "method": "GET", + "requestUri": "/domainnames/{domain_name}" + }, + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + } + } + }, + "output": { + "shape": "S12" + } + }, + "GetDomainNames": { + "http": { + "method": "GET", + "requestUri": "/domainnames" + }, + "input": { + "type": "structure", + "members": { + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S12" + } + } + } + } + }, + "GetExport": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName", + "exportType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": { + "location": "uri", + "locationName": "stage_name" + }, + "exportType": { + "location": "uri", + "locationName": "export_type" + }, + "parameters": { + "shape": "Sk", + "location": "querystring" + }, + "accepts": { + "location": "header", + "locationName": "Accept" + } + } + }, + "output": { + "type": "structure", + "members": { + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "contentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "body": { + "type": "blob" + } + }, + "payload": "body" + } + }, + "GetGatewayResponse": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/gatewayresponses/{response_type}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "responseType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "responseType": { + "location": "uri", + "locationName": "response_type" + } + } + }, + "output": { + "shape": "S43" + } + }, + "GetGatewayResponses": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/gatewayresponses" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S43" + } + } + } + } + }, + "GetIntegration": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + } + } + }, + "output": { + "shape": "S1f" + } + }, + "GetIntegrationResponse": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + } + } + }, + "output": { + "shape": "S1l" + } + }, + "GetMethod": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + } + } + }, + "output": { + "shape": "S1a" + } + }, + "GetMethodResponse": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + } + } + }, + "output": { + "shape": "S1d" + } + }, + "GetModel": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/models/{model_name}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "modelName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "modelName": { + "location": "uri", + "locationName": "model_name" + }, + "flatten": { + "location": "querystring", + "locationName": "flatten", + "type": "boolean" + } + } + }, + "output": { + "shape": "S14" + } + }, + "GetModelTemplate": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/models/{model_name}/default_template" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "modelName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "modelName": { + "location": "uri", + "locationName": "model_name" + } + } + }, + "output": { + "type": "structure", + "members": { + "value": {} + } + } + }, + "GetModels": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/models" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S14" + } + } + } + } + }, + "GetRequestValidator": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "requestValidatorId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "requestValidatorId": { + "location": "uri", + "locationName": "requestvalidator_id" + } + } + }, + "output": { + "shape": "S16" + } + }, + "GetRequestValidators": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/requestvalidators" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S16" + } + } + } + } + }, + "GetResource": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "embed": { + "shape": "S8", + "location": "querystring", + "locationName": "embed" + } + } + }, + "output": { + "shape": "S18" + } + }, + "GetResources": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/resources" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "embed": { + "shape": "S8", + "location": "querystring", + "locationName": "embed" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S18" + } + } + } + } + }, + "GetRestApi": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + } + } + }, + "output": { + "shape": "S1o" + } + }, + "GetRestApis": { + "http": { + "method": "GET", + "requestUri": "/restapis" + }, + "input": { + "type": "structure", + "members": { + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S1o" + } + } + } + } + }, + "GetSdk": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName", + "sdkType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": { + "location": "uri", + "locationName": "stage_name" + }, + "sdkType": { + "location": "uri", + "locationName": "sdk_type" + }, + "parameters": { + "shape": "Sk", + "location": "querystring" + } + } + }, + "output": { + "type": "structure", + "members": { + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "contentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "body": { + "type": "blob" + } + }, + "payload": "body" + } + }, + "GetSdkType": { + "http": { + "method": "GET", + "requestUri": "/sdktypes/{sdktype_id}" + }, + "input": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": { + "location": "uri", + "locationName": "sdktype_id" + } + } + }, + "output": { + "shape": "S4w" + } + }, + "GetSdkTypes": { + "http": { + "method": "GET", + "requestUri": "/sdktypes" + }, + "input": { + "type": "structure", + "members": { + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S4w" + } + } + } + } + }, + "GetStage": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/stages/{stage_name}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": { + "location": "uri", + "locationName": "stage_name" + } + } + }, + "output": { + "shape": "S1r" + } + }, + "GetStages": { + "http": { + "method": "GET", + "requestUri": "/restapis/{restapi_id}/stages" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "deploymentId": { + "location": "querystring", + "locationName": "deploymentId" + } + } + }, + "output": { + "type": "structure", + "members": { + "item": { + "type": "list", + "member": { + "shape": "S1r" + } + } + } + } + }, + "GetTags": { + "http": { + "method": "GET", + "requestUri": "/tags/{resource_arn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resource_arn" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Sk" + } + } + } + }, + "GetUsage": { + "http": { + "method": "GET", + "requestUri": "/usageplans/{usageplanId}/usage" + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId", + "startDate", + "endDate" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + }, + "keyId": { + "location": "querystring", + "locationName": "keyId" + }, + "startDate": { + "location": "querystring", + "locationName": "startDate" + }, + "endDate": { + "location": "querystring", + "locationName": "endDate" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "shape": "S59" + } + }, + "GetUsagePlan": { + "http": { + "method": "GET", + "requestUri": "/usageplans/{usageplanId}" + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + } + } + }, + "output": { + "shape": "S24" + } + }, + "GetUsagePlanKey": { + "http": { + "method": "GET", + "requestUri": "/usageplans/{usageplanId}/keys/{keyId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId", + "keyId" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + }, + "keyId": { + "location": "uri", + "locationName": "keyId" + } + } + }, + "output": { + "shape": "S26" + } + }, + "GetUsagePlanKeys": { + "http": { + "method": "GET", + "requestUri": "/usageplans/{usageplanId}/keys" + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + }, + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "nameQuery": { + "location": "querystring", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S26" + } + } + } + } + }, + "GetUsagePlans": { + "http": { + "method": "GET", + "requestUri": "/usageplans" + }, + "input": { + "type": "structure", + "members": { + "position": { + "location": "querystring", + "locationName": "position" + }, + "keyId": { + "location": "querystring", + "locationName": "keyId" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S24" + } + } + } + } + }, + "GetVpcLink": { + "http": { + "method": "GET", + "requestUri": "/vpclinks/{vpclink_id}" + }, + "input": { + "type": "structure", + "required": [ + "vpcLinkId" + ], + "members": { + "vpcLinkId": { + "location": "uri", + "locationName": "vpclink_id" + } + } + }, + "output": { + "shape": "S28" + } + }, + "GetVpcLinks": { + "http": { + "method": "GET", + "requestUri": "/vpclinks" + }, + "input": { + "type": "structure", + "members": { + "position": { + "location": "querystring", + "locationName": "position" + }, + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "position": {}, + "items": { + "locationName": "item", + "type": "list", + "member": { + "shape": "S28" + } + } + } + } + }, + "ImportApiKeys": { + "http": { + "requestUri": "/apikeys?mode=import", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "body", + "format" + ], + "members": { + "body": { + "type": "blob" + }, + "format": { + "location": "querystring", + "locationName": "format" + }, + "failOnWarnings": { + "location": "querystring", + "locationName": "failonwarnings", + "type": "boolean" + } + }, + "payload": "body" + }, + "output": { + "type": "structure", + "members": { + "ids": { + "shape": "S8" + }, + "warnings": { + "shape": "S8" + } + } + } + }, + "ImportDocumentationParts": { + "http": { + "method": "PUT", + "requestUri": "/restapis/{restapi_id}/documentation/parts" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "body" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "mode": { + "location": "querystring", + "locationName": "mode" + }, + "failOnWarnings": { + "location": "querystring", + "locationName": "failonwarnings", + "type": "boolean" + }, + "body": { + "type": "blob" + } + }, + "payload": "body" + }, + "output": { + "type": "structure", + "members": { + "ids": { + "shape": "S8" + }, + "warnings": { + "shape": "S8" + } + } + } + }, + "ImportRestApi": { + "http": { + "requestUri": "/restapis?mode=import", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "body" + ], + "members": { + "failOnWarnings": { + "location": "querystring", + "locationName": "failonwarnings", + "type": "boolean" + }, + "parameters": { + "shape": "Sk", + "location": "querystring" + }, + "body": { + "type": "blob" + } + }, + "payload": "body" + }, + "output": { + "shape": "S1o" + } + }, + "PutGatewayResponse": { + "http": { + "method": "PUT", + "requestUri": "/restapis/{restapi_id}/gatewayresponses/{response_type}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "responseType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "responseType": { + "location": "uri", + "locationName": "response_type" + }, + "statusCode": {}, + "responseParameters": { + "shape": "Sk" + }, + "responseTemplates": { + "shape": "Sk" + } + } + }, + "output": { + "shape": "S43" + } + }, + "PutIntegration": { + "http": { + "method": "PUT", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "type" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "type": {}, + "integrationHttpMethod": { + "locationName": "httpMethod" + }, + "uri": {}, + "connectionType": {}, + "connectionId": {}, + "credentials": {}, + "requestParameters": { + "shape": "Sk" + }, + "requestTemplates": { + "shape": "Sk" + }, + "passthroughBehavior": {}, + "cacheNamespace": {}, + "cacheKeyParameters": { + "shape": "S8" + }, + "contentHandling": {}, + "timeoutInMillis": { + "type": "integer" + } + } + }, + "output": { + "shape": "S1f" + } + }, + "PutIntegrationResponse": { + "http": { + "method": "PUT", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + }, + "selectionPattern": {}, + "responseParameters": { + "shape": "Sk" + }, + "responseTemplates": { + "shape": "Sk" + }, + "contentHandling": {} + } + }, + "output": { + "shape": "S1l" + } + }, + "PutMethod": { + "http": { + "method": "PUT", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "authorizationType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "authorizationType": {}, + "authorizerId": {}, + "apiKeyRequired": { + "type": "boolean" + }, + "operationName": {}, + "requestParameters": { + "shape": "S1b" + }, + "requestModels": { + "shape": "Sk" + }, + "requestValidatorId": {}, + "authorizationScopes": { + "shape": "S8" + } + } + }, + "output": { + "shape": "S1a" + } + }, + "PutMethodResponse": { + "http": { + "method": "PUT", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + }, + "responseParameters": { + "shape": "S1b" + }, + "responseModels": { + "shape": "Sk" + } + } + }, + "output": { + "shape": "S1d" + } + }, + "PutRestApi": { + "http": { + "method": "PUT", + "requestUri": "/restapis/{restapi_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "body" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "mode": { + "location": "querystring", + "locationName": "mode" + }, + "failOnWarnings": { + "location": "querystring", + "locationName": "failonwarnings", + "type": "boolean" + }, + "parameters": { + "shape": "Sk", + "location": "querystring" + }, + "body": { + "type": "blob" + } + }, + "payload": "body" + }, + "output": { + "shape": "S1o" + } + }, + "TagResource": { + "http": { + "method": "PUT", + "requestUri": "/tags/{resource_arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resource_arn" + }, + "tags": { + "shape": "Sk" + } + } + } + }, + "TestInvokeAuthorizer": { + "http": { + "requestUri": "/restapis/{restapi_id}/authorizers/{authorizer_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "authorizerId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "authorizerId": { + "location": "uri", + "locationName": "authorizer_id" + }, + "headers": { + "shape": "Sk" + }, + "multiValueHeaders": { + "shape": "S65" + }, + "pathWithQueryString": {}, + "body": {}, + "stageVariables": { + "shape": "Sk" + }, + "additionalContext": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "clientStatus": { + "type": "integer" + }, + "log": {}, + "latency": { + "type": "long" + }, + "principalId": {}, + "policy": {}, + "authorization": { + "shape": "S65" + }, + "claims": { + "shape": "Sk" + } + } + } + }, + "TestInvokeMethod": { + "http": { + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "pathWithQueryString": {}, + "body": {}, + "headers": { + "shape": "Sk" + }, + "multiValueHeaders": { + "shape": "S65" + }, + "clientCertificateId": {}, + "stageVariables": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": { + "type": "integer" + }, + "body": {}, + "headers": { + "shape": "Sk" + }, + "multiValueHeaders": { + "shape": "S65" + }, + "log": {}, + "latency": { + "type": "long" + } + } + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resource_arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resource_arn" + }, + "tagKeys": { + "shape": "S8", + "location": "querystring", + "locationName": "tagKeys" + } + } + } + }, + "UpdateAccount": { + "http": { + "method": "PATCH", + "requestUri": "/account" + }, + "input": { + "type": "structure", + "members": { + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S31" + } + }, + "UpdateApiKey": { + "http": { + "method": "PATCH", + "requestUri": "/apikeys/{api_Key}" + }, + "input": { + "type": "structure", + "required": [ + "apiKey" + ], + "members": { + "apiKey": { + "location": "uri", + "locationName": "api_Key" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S6" + } + }, + "UpdateAuthorizer": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/authorizers/{authorizer_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "authorizerId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "authorizerId": { + "location": "uri", + "locationName": "authorizer_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "Se" + } + }, + "UpdateBasePathMapping": { + "http": { + "method": "PATCH", + "requestUri": "/domainnames/{domain_name}/basepathmappings/{base_path}" + }, + "input": { + "type": "structure", + "required": [ + "domainName", + "basePath" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + }, + "basePath": { + "location": "uri", + "locationName": "base_path" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "Sg" + } + }, + "UpdateClientCertificate": { + "http": { + "method": "PATCH", + "requestUri": "/clientcertificates/{clientcertificate_id}" + }, + "input": { + "type": "structure", + "required": [ + "clientCertificateId" + ], + "members": { + "clientCertificateId": { + "location": "uri", + "locationName": "clientcertificate_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S2z" + } + }, + "UpdateDeployment": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/deployments/{deployment_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "deploymentId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "deploymentId": { + "location": "uri", + "locationName": "deployment_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "Sn" + } + }, + "UpdateDocumentationPart": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/documentation/parts/{part_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "documentationPartId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "documentationPartId": { + "location": "uri", + "locationName": "part_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "Sv" + } + }, + "UpdateDocumentationVersion": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/documentation/versions/{doc_version}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "documentationVersion" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "documentationVersion": { + "location": "uri", + "locationName": "doc_version" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "Sx" + } + }, + "UpdateDomainName": { + "http": { + "method": "PATCH", + "requestUri": "/domainnames/{domain_name}" + }, + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": { + "location": "uri", + "locationName": "domain_name" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S12" + } + }, + "UpdateGatewayResponse": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/gatewayresponses/{response_type}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "responseType" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "responseType": { + "location": "uri", + "locationName": "response_type" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S43" + } + }, + "UpdateIntegration": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S1f" + } + }, + "UpdateIntegrationResponse": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S1l" + } + }, + "UpdateMethod": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S1a" + } + }, + "UpdateMethodResponse": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "httpMethod": { + "location": "uri", + "locationName": "http_method" + }, + "statusCode": { + "location": "uri", + "locationName": "status_code" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S1d" + } + }, + "UpdateModel": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/models/{model_name}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "modelName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "modelName": { + "location": "uri", + "locationName": "model_name" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S14" + } + }, + "UpdateRequestValidator": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "requestValidatorId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "requestValidatorId": { + "location": "uri", + "locationName": "requestvalidator_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S16" + } + }, + "UpdateResource": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/resources/{resource_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "resourceId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "resourceId": { + "location": "uri", + "locationName": "resource_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S18" + } + }, + "UpdateRestApi": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S1o" + } + }, + "UpdateStage": { + "http": { + "method": "PATCH", + "requestUri": "/restapis/{restapi_id}/stages/{stage_name}" + }, + "input": { + "type": "structure", + "required": [ + "restApiId", + "stageName" + ], + "members": { + "restApiId": { + "location": "uri", + "locationName": "restapi_id" + }, + "stageName": { + "location": "uri", + "locationName": "stage_name" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S1r" + } + }, + "UpdateUsage": { + "http": { + "method": "PATCH", + "requestUri": "/usageplans/{usageplanId}/keys/{keyId}/usage" + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId", + "keyId" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + }, + "keyId": { + "location": "uri", + "locationName": "keyId" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S59" + } + }, + "UpdateUsagePlan": { + "http": { + "method": "PATCH", + "requestUri": "/usageplans/{usageplanId}" + }, + "input": { + "type": "structure", + "required": [ + "usagePlanId" + ], + "members": { + "usagePlanId": { + "location": "uri", + "locationName": "usageplanId" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S24" + } + }, + "UpdateVpcLink": { + "http": { + "method": "PATCH", + "requestUri": "/vpclinks/{vpclink_id}" + }, + "input": { + "type": "structure", + "required": [ + "vpcLinkId" + ], + "members": { + "vpcLinkId": { + "location": "uri", + "locationName": "vpclink_id" + }, + "patchOperations": { + "shape": "S6b" + } + } + }, + "output": { + "shape": "S28" + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "members": { + "id": {}, + "value": {}, + "name": {}, + "customerId": {}, + "description": {}, + "enabled": { + "type": "boolean" + }, + "createdDate": { + "type": "timestamp" + }, + "lastUpdatedDate": { + "type": "timestamp" + }, + "stageKeys": { + "shape": "S8" + } + } + }, + "S8": { + "type": "list", + "member": {} + }, + "Sb": { + "type": "list", + "member": {} + }, + "Se": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "type": {}, + "providerARNs": { + "shape": "Sb" + }, + "authType": {}, + "authorizerUri": {}, + "authorizerCredentials": {}, + "identitySource": {}, + "identityValidationExpression": {}, + "authorizerResultTtlInSeconds": { + "type": "integer" + } + } + }, + "Sg": { + "type": "structure", + "members": { + "basePath": {}, + "restApiId": {}, + "stage": {} + } + }, + "Sk": { + "type": "map", + "key": {}, + "value": {} + }, + "Sn": { + "type": "structure", + "members": { + "id": {}, + "description": {}, + "createdDate": { + "type": "timestamp" + }, + "apiSummary": { + "type": "map", + "key": {}, + "value": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "authorizationType": {}, + "apiKeyRequired": { + "type": "boolean" + } + } + } + } + } + } + }, + "Ss": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "path": {}, + "method": {}, + "statusCode": {}, + "name": {} + } + }, + "Sv": { + "type": "structure", + "members": { + "id": {}, + "location": { + "shape": "Ss" + }, + "properties": {} + } + }, + "Sx": { + "type": "structure", + "members": { + "version": {}, + "createdDate": { + "type": "timestamp" + }, + "description": {} + } + }, + "Sz": { + "type": "structure", + "members": { + "types": { + "type": "list", + "member": {} + } + } + }, + "S12": { + "type": "structure", + "members": { + "domainName": {}, + "certificateName": {}, + "certificateArn": {}, + "certificateUploadDate": { + "type": "timestamp" + }, + "regionalDomainName": {}, + "regionalHostedZoneId": {}, + "regionalCertificateName": {}, + "regionalCertificateArn": {}, + "distributionDomainName": {}, + "distributionHostedZoneId": {}, + "endpointConfiguration": { + "shape": "Sz" + } + } + }, + "S14": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "description": {}, + "schema": {}, + "contentType": {} + } + }, + "S16": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "validateRequestBody": { + "type": "boolean" + }, + "validateRequestParameters": { + "type": "boolean" + } + } + }, + "S18": { + "type": "structure", + "members": { + "id": {}, + "parentId": {}, + "pathPart": {}, + "path": {}, + "resourceMethods": { + "type": "map", + "key": {}, + "value": { + "shape": "S1a" + } + } + } + }, + "S1a": { + "type": "structure", + "members": { + "httpMethod": {}, + "authorizationType": {}, + "authorizerId": {}, + "apiKeyRequired": { + "type": "boolean" + }, + "requestValidatorId": {}, + "operationName": {}, + "requestParameters": { + "shape": "S1b" + }, + "requestModels": { + "shape": "Sk" + }, + "methodResponses": { + "type": "map", + "key": {}, + "value": { + "shape": "S1d" + } + }, + "methodIntegration": { + "shape": "S1f" + }, + "authorizationScopes": { + "shape": "S8" + } + } + }, + "S1b": { + "type": "map", + "key": {}, + "value": { + "type": "boolean" + } + }, + "S1d": { + "type": "structure", + "members": { + "statusCode": {}, + "responseParameters": { + "shape": "S1b" + }, + "responseModels": { + "shape": "Sk" + } + } + }, + "S1f": { + "type": "structure", + "members": { + "type": {}, + "httpMethod": {}, + "uri": {}, + "connectionType": {}, + "connectionId": {}, + "credentials": {}, + "requestParameters": { + "shape": "Sk" + }, + "requestTemplates": { + "shape": "Sk" + }, + "passthroughBehavior": {}, + "contentHandling": {}, + "timeoutInMillis": { + "type": "integer" + }, + "cacheNamespace": {}, + "cacheKeyParameters": { + "shape": "S8" + }, + "integrationResponses": { + "type": "map", + "key": {}, + "value": { + "shape": "S1l" + } + } + } + }, + "S1l": { + "type": "structure", + "members": { + "statusCode": {}, + "selectionPattern": {}, + "responseParameters": { + "shape": "Sk" + }, + "responseTemplates": { + "shape": "Sk" + }, + "contentHandling": {} + } + }, + "S1o": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "description": {}, + "createdDate": { + "type": "timestamp" + }, + "version": {}, + "warnings": { + "shape": "S8" + }, + "binaryMediaTypes": { + "shape": "S8" + }, + "minimumCompressionSize": { + "type": "integer" + }, + "apiKeySource": {}, + "endpointConfiguration": { + "shape": "Sz" + }, + "policy": {} + } + }, + "S1q": { + "type": "structure", + "members": { + "percentTraffic": { + "type": "double" + }, + "deploymentId": {}, + "stageVariableOverrides": { + "shape": "Sk" + }, + "useStageCache": { + "type": "boolean" + } + } + }, + "S1r": { + "type": "structure", + "members": { + "deploymentId": {}, + "clientCertificateId": {}, + "stageName": {}, + "description": {}, + "cacheClusterEnabled": { + "type": "boolean" + }, + "cacheClusterSize": {}, + "cacheClusterStatus": {}, + "methodSettings": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "metricsEnabled": { + "type": "boolean" + }, + "loggingLevel": {}, + "dataTraceEnabled": { + "type": "boolean" + }, + "throttlingBurstLimit": { + "type": "integer" + }, + "throttlingRateLimit": { + "type": "double" + }, + "cachingEnabled": { + "type": "boolean" + }, + "cacheTtlInSeconds": { + "type": "integer" + }, + "cacheDataEncrypted": { + "type": "boolean" + }, + "requireAuthorizationForCacheControl": { + "type": "boolean" + }, + "unauthorizedCacheControlHeaderStrategy": {} + } + } + }, + "variables": { + "shape": "Sk" + }, + "documentationVersion": {}, + "accessLogSettings": { + "type": "structure", + "members": { + "format": {}, + "destinationArn": {} + } + }, + "canarySettings": { + "shape": "S1q" + }, + "tracingEnabled": { + "type": "boolean" + }, + "webAclArn": {}, + "tags": { + "shape": "Sk" + }, + "createdDate": { + "type": "timestamp" + }, + "lastUpdatedDate": { + "type": "timestamp" + } + } + }, + "S1y": { + "type": "list", + "member": { + "type": "structure", + "members": { + "apiId": {}, + "stage": {}, + "throttle": { + "type": "map", + "key": {}, + "value": { + "shape": "S21" + } + } + } + } + }, + "S21": { + "type": "structure", + "members": { + "burstLimit": { + "type": "integer" + }, + "rateLimit": { + "type": "double" + } + } + }, + "S22": { + "type": "structure", + "members": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "period": {} + } + }, + "S24": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "description": {}, + "apiStages": { + "shape": "S1y" + }, + "throttle": { + "shape": "S21" + }, + "quota": { + "shape": "S22" + }, + "productCode": {} + } + }, + "S26": { + "type": "structure", + "members": { + "id": {}, + "type": {}, + "value": {}, + "name": {} + } + }, + "S28": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "description": {}, + "targetArns": { + "shape": "S8" + }, + "status": {}, + "statusMessage": {} + } + }, + "S2z": { + "type": "structure", + "members": { + "clientCertificateId": {}, + "description": {}, + "pemEncodedCertificate": {}, + "createdDate": { + "type": "timestamp" + }, + "expirationDate": { + "type": "timestamp" + } + } + }, + "S31": { + "type": "structure", + "members": { + "cloudwatchRoleArn": {}, + "throttleSettings": { + "shape": "S21" + }, + "features": { + "shape": "S8" + }, + "apiKeyVersion": {} + } + }, + "S43": { + "type": "structure", + "members": { + "responseType": {}, + "statusCode": {}, + "responseParameters": { + "shape": "Sk" + }, + "responseTemplates": { + "shape": "Sk" + }, + "defaultResponse": { + "type": "boolean" + } + } + }, + "S4w": { + "type": "structure", + "members": { + "id": {}, + "friendlyName": {}, + "description": {}, + "configurationProperties": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "friendlyName": {}, + "description": {}, + "required": { + "type": "boolean" + }, + "defaultValue": {} + } + } + } + } + }, + "S59": { + "type": "structure", + "members": { + "usagePlanId": {}, + "startDate": {}, + "endDate": {}, + "position": {}, + "items": { + "locationName": "values", + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "list", + "member": { + "type": "long" + } + } + } + } + } + }, + "S65": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "S6b": { + "type": "list", + "member": { + "type": "structure", + "members": { + "op": {}, + "path": {}, + "value": {}, + "from": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/apigateway-2015-07-09.paginators.json b/node_modules/aws-sdk/apis/apigateway-2015-07-09.paginators.json new file mode 100644 index 0000000..a095aef --- /dev/null +++ b/node_modules/aws-sdk/apis/apigateway-2015-07-09.paginators.json @@ -0,0 +1,76 @@ +{ + "pagination": { + "GetApiKeys": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetBasePathMappings": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetClientCertificates": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetDeployments": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetDomainNames": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetModels": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetResources": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetRestApis": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetUsage": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetUsagePlanKeys": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetUsagePlans": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetVpcLinks": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/apigatewaymanagementapi-2018-11-29.min.json b/node_modules/aws-sdk/apis/apigatewaymanagementapi-2018-11-29.min.json new file mode 100644 index 0000000..d48f79e --- /dev/null +++ b/node_modules/aws-sdk/apis/apigatewaymanagementapi-2018-11-29.min.json @@ -0,0 +1,39 @@ +{ + "metadata": { + "apiVersion": "2018-11-29", + "endpointPrefix": "execute-api", + "signingName": "execute-api", + "serviceFullName": "AmazonApiGatewayManagementApi", + "serviceId": "ApiGatewayManagementApi", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "apigatewaymanagementapi-2018-11-29", + "signatureVersion": "v4" + }, + "operations": { + "PostToConnection": { + "http": { + "requestUri": "/@connections/{connectionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Data": { + "type": "blob" + }, + "ConnectionId": { + "location": "uri", + "locationName": "connectionId" + } + }, + "required": [ + "ConnectionId", + "Data" + ], + "payload": "Data" + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/apigatewaymanagementapi-2018-11-29.paginators.json b/node_modules/aws-sdk/apis/apigatewaymanagementapi-2018-11-29.paginators.json new file mode 100644 index 0000000..f3b7195 --- /dev/null +++ b/node_modules/aws-sdk/apis/apigatewaymanagementapi-2018-11-29.paginators.json @@ -0,0 +1,3 @@ +{ + "pagination" : { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/apigatewayv2-2018-11-29.min.json b/node_modules/aws-sdk/apis/apigatewayv2-2018-11-29.min.json new file mode 100644 index 0000000..1f5c8b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/apigatewayv2-2018-11-29.min.json @@ -0,0 +1,3414 @@ +{ + "metadata": { + "apiVersion": "2018-11-29", + "endpointPrefix": "apigateway", + "signingName": "apigateway", + "serviceFullName": "AmazonApiGatewayV2", + "serviceId": "ApiGatewayV2", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "apigatewayv2-2018-11-29", + "signatureVersion": "v4" + }, + "operations": { + "CreateApi": { + "http": { + "requestUri": "/v2/apis", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiKeySelectionExpression": { + "locationName": "apiKeySelectionExpression" + }, + "Description": { + "locationName": "description" + }, + "DisableSchemaValidation": { + "locationName": "disableSchemaValidation", + "type": "boolean" + }, + "Name": { + "locationName": "name" + }, + "ProtocolType": { + "locationName": "protocolType" + }, + "RouteSelectionExpression": { + "locationName": "routeSelectionExpression" + }, + "Version": { + "locationName": "version" + } + }, + "required": [ + "RouteSelectionExpression", + "ProtocolType", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiEndpoint": { + "locationName": "apiEndpoint" + }, + "ApiId": { + "locationName": "apiId" + }, + "ApiKeySelectionExpression": { + "locationName": "apiKeySelectionExpression" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "Description": { + "locationName": "description" + }, + "DisableSchemaValidation": { + "locationName": "disableSchemaValidation", + "type": "boolean" + }, + "Name": { + "locationName": "name" + }, + "ProtocolType": { + "locationName": "protocolType" + }, + "RouteSelectionExpression": { + "locationName": "routeSelectionExpression" + }, + "Version": { + "locationName": "version" + }, + "Warnings": { + "shape": "Sc", + "locationName": "warnings" + } + } + } + }, + "CreateApiMapping": { + "http": { + "requestUri": "/v2/domainnames/{domainName}/apimappings", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "locationName": "apiId" + }, + "ApiMappingKey": { + "locationName": "apiMappingKey" + }, + "DomainName": { + "location": "uri", + "locationName": "domainName" + }, + "Stage": { + "locationName": "stage" + } + }, + "required": [ + "DomainName", + "Stage", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiId": { + "locationName": "apiId" + }, + "ApiMappingId": { + "locationName": "apiMappingId" + }, + "ApiMappingKey": { + "locationName": "apiMappingKey" + }, + "Stage": { + "locationName": "stage" + } + } + } + }, + "CreateAuthorizer": { + "http": { + "requestUri": "/v2/apis/{apiId}/authorizers", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "AuthorizerCredentialsArn": { + "locationName": "authorizerCredentialsArn" + }, + "AuthorizerResultTtlInSeconds": { + "locationName": "authorizerResultTtlInSeconds", + "type": "integer" + }, + "AuthorizerType": { + "locationName": "authorizerType" + }, + "AuthorizerUri": { + "locationName": "authorizerUri" + }, + "IdentitySource": { + "shape": "Sl", + "locationName": "identitySource" + }, + "IdentityValidationExpression": { + "locationName": "identityValidationExpression" + }, + "Name": { + "locationName": "name" + }, + "ProviderArns": { + "shape": "Sm", + "locationName": "providerArns" + } + }, + "required": [ + "ApiId", + "AuthorizerUri", + "AuthorizerType", + "IdentitySource", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "locationName": "authorizerCredentialsArn" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "AuthorizerResultTtlInSeconds": { + "locationName": "authorizerResultTtlInSeconds", + "type": "integer" + }, + "AuthorizerType": { + "locationName": "authorizerType" + }, + "AuthorizerUri": { + "locationName": "authorizerUri" + }, + "IdentitySource": { + "shape": "Sl", + "locationName": "identitySource" + }, + "IdentityValidationExpression": { + "locationName": "identityValidationExpression" + }, + "Name": { + "locationName": "name" + }, + "ProviderArns": { + "shape": "Sm", + "locationName": "providerArns" + } + } + } + }, + "CreateDeployment": { + "http": { + "requestUri": "/v2/apis/{apiId}/deployments", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "Description": { + "locationName": "description" + }, + "StageName": { + "locationName": "stageName" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "DeploymentStatus": { + "locationName": "deploymentStatus" + }, + "DeploymentStatusMessage": { + "locationName": "deploymentStatusMessage" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "CreateDomainName": { + "http": { + "requestUri": "/v2/domainnames", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "DomainName": { + "locationName": "domainName" + }, + "DomainNameConfigurations": { + "shape": "St", + "locationName": "domainNameConfigurations" + } + }, + "required": [ + "DomainName" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "locationName": "apiMappingSelectionExpression" + }, + "DomainName": { + "locationName": "domainName" + }, + "DomainNameConfigurations": { + "shape": "St", + "locationName": "domainNameConfigurations" + } + } + } + }, + "CreateIntegration": { + "http": { + "requestUri": "/v2/apis/{apiId}/integrations", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ConnectionId": { + "locationName": "connectionId" + }, + "ConnectionType": { + "locationName": "connectionType" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "CredentialsArn": { + "locationName": "credentialsArn" + }, + "Description": { + "locationName": "description" + }, + "IntegrationMethod": { + "locationName": "integrationMethod" + }, + "IntegrationType": { + "locationName": "integrationType" + }, + "IntegrationUri": { + "locationName": "integrationUri" + }, + "PassthroughBehavior": { + "locationName": "passthroughBehavior" + }, + "RequestParameters": { + "shape": "S13", + "locationName": "requestParameters" + }, + "RequestTemplates": { + "shape": "S14", + "locationName": "requestTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + }, + "TimeoutInMillis": { + "locationName": "timeoutInMillis", + "type": "integer" + } + }, + "required": [ + "ApiId", + "IntegrationType" + ] + }, + "output": { + "type": "structure", + "members": { + "ConnectionId": { + "locationName": "connectionId" + }, + "ConnectionType": { + "locationName": "connectionType" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "CredentialsArn": { + "locationName": "credentialsArn" + }, + "Description": { + "locationName": "description" + }, + "IntegrationId": { + "locationName": "integrationId" + }, + "IntegrationMethod": { + "locationName": "integrationMethod" + }, + "IntegrationResponseSelectionExpression": { + "locationName": "integrationResponseSelectionExpression" + }, + "IntegrationType": { + "locationName": "integrationType" + }, + "IntegrationUri": { + "locationName": "integrationUri" + }, + "PassthroughBehavior": { + "locationName": "passthroughBehavior" + }, + "RequestParameters": { + "shape": "S13", + "locationName": "requestParameters" + }, + "RequestTemplates": { + "shape": "S14", + "locationName": "requestTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + }, + "TimeoutInMillis": { + "locationName": "timeoutInMillis", + "type": "integer" + } + } + } + }, + "CreateIntegrationResponse": { + "http": { + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + }, + "IntegrationResponseKey": { + "locationName": "integrationResponseKey" + }, + "ResponseParameters": { + "shape": "S13", + "locationName": "responseParameters" + }, + "ResponseTemplates": { + "shape": "S14", + "locationName": "responseTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + } + }, + "required": [ + "ApiId", + "IntegrationId", + "IntegrationResponseKey" + ] + }, + "output": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "IntegrationResponseId": { + "locationName": "integrationResponseId" + }, + "IntegrationResponseKey": { + "locationName": "integrationResponseKey" + }, + "ResponseParameters": { + "shape": "S13", + "locationName": "responseParameters" + }, + "ResponseTemplates": { + "shape": "S14", + "locationName": "responseTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + } + } + } + }, + "CreateModel": { + "http": { + "requestUri": "/v2/apis/{apiId}/models", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ContentType": { + "locationName": "contentType" + }, + "Description": { + "locationName": "description" + }, + "Name": { + "locationName": "name" + }, + "Schema": { + "locationName": "schema" + } + }, + "required": [ + "ApiId", + "Schema", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "ContentType": { + "locationName": "contentType" + }, + "Description": { + "locationName": "description" + }, + "ModelId": { + "locationName": "modelId" + }, + "Name": { + "locationName": "name" + }, + "Schema": { + "locationName": "schema" + } + } + } + }, + "CreateRoute": { + "http": { + "requestUri": "/v2/apis/{apiId}/routes", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ApiKeyRequired": { + "locationName": "apiKeyRequired", + "type": "boolean" + }, + "AuthorizationScopes": { + "shape": "S1e", + "locationName": "authorizationScopes" + }, + "AuthorizationType": { + "locationName": "authorizationType" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "OperationName": { + "locationName": "operationName" + }, + "RequestModels": { + "shape": "S1g", + "locationName": "requestModels" + }, + "RequestParameters": { + "shape": "S1h", + "locationName": "requestParameters" + }, + "RouteKey": { + "locationName": "routeKey" + }, + "RouteResponseSelectionExpression": { + "locationName": "routeResponseSelectionExpression" + }, + "Target": { + "locationName": "target" + } + }, + "required": [ + "ApiId", + "RouteKey" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiKeyRequired": { + "locationName": "apiKeyRequired", + "type": "boolean" + }, + "AuthorizationScopes": { + "shape": "S1e", + "locationName": "authorizationScopes" + }, + "AuthorizationType": { + "locationName": "authorizationType" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "OperationName": { + "locationName": "operationName" + }, + "RequestModels": { + "shape": "S1g", + "locationName": "requestModels" + }, + "RequestParameters": { + "shape": "S1h", + "locationName": "requestParameters" + }, + "RouteId": { + "locationName": "routeId" + }, + "RouteKey": { + "locationName": "routeKey" + }, + "RouteResponseSelectionExpression": { + "locationName": "routeResponseSelectionExpression" + }, + "Target": { + "locationName": "target" + } + } + } + }, + "CreateRouteResponse": { + "http": { + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "ResponseModels": { + "shape": "S1g", + "locationName": "responseModels" + }, + "ResponseParameters": { + "shape": "S1h", + "locationName": "responseParameters" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + }, + "RouteResponseKey": { + "locationName": "routeResponseKey" + } + }, + "required": [ + "ApiId", + "RouteId", + "RouteResponseKey" + ] + }, + "output": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "ResponseModels": { + "shape": "S1g", + "locationName": "responseModels" + }, + "ResponseParameters": { + "shape": "S1h", + "locationName": "responseParameters" + }, + "RouteResponseId": { + "locationName": "routeResponseId" + }, + "RouteResponseKey": { + "locationName": "routeResponseKey" + } + } + } + }, + "CreateStage": { + "http": { + "requestUri": "/v2/apis/{apiId}/stages", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "S1n", + "locationName": "accessLogSettings" + }, + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ClientCertificateId": { + "locationName": "clientCertificateId" + }, + "DefaultRouteSettings": { + "shape": "S1o", + "locationName": "defaultRouteSettings" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "Description": { + "locationName": "description" + }, + "RouteSettings": { + "shape": "S1s", + "locationName": "routeSettings" + }, + "StageName": { + "locationName": "stageName" + }, + "StageVariables": { + "shape": "S1t", + "locationName": "stageVariables" + } + }, + "required": [ + "ApiId", + "StageName" + ] + }, + "output": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "S1n", + "locationName": "accessLogSettings" + }, + "ClientCertificateId": { + "locationName": "clientCertificateId" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DefaultRouteSettings": { + "shape": "S1o", + "locationName": "defaultRouteSettings" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "Description": { + "locationName": "description" + }, + "LastUpdatedDate": { + "shape": "Sb", + "locationName": "lastUpdatedDate" + }, + "RouteSettings": { + "shape": "S1s", + "locationName": "routeSettings" + }, + "StageName": { + "locationName": "stageName" + }, + "StageVariables": { + "shape": "S1t", + "locationName": "stageVariables" + } + } + } + }, + "DeleteApi": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + } + }, + "required": [ + "ApiId" + ] + } + }, + "DeleteApiMapping": { + "http": { + "method": "DELETE", + "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiMappingId": { + "location": "uri", + "locationName": "apiMappingId" + }, + "DomainName": { + "location": "uri", + "locationName": "domainName" + } + }, + "required": [ + "ApiMappingId", + "DomainName" + ] + } + }, + "DeleteAuthorizer": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "AuthorizerId": { + "location": "uri", + "locationName": "authorizerId" + } + }, + "required": [ + "AuthorizerId", + "ApiId" + ] + } + }, + "DeleteDeployment": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "DeploymentId": { + "location": "uri", + "locationName": "deploymentId" + } + }, + "required": [ + "ApiId", + "DeploymentId" + ] + } + }, + "DeleteDomainName": { + "http": { + "method": "DELETE", + "requestUri": "/v2/domainnames/{domainName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "DomainName": { + "location": "uri", + "locationName": "domainName" + } + }, + "required": [ + "DomainName" + ] + } + }, + "DeleteIntegration": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + } + }, + "required": [ + "ApiId", + "IntegrationId" + ] + } + }, + "DeleteIntegrationResponse": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + }, + "IntegrationResponseId": { + "location": "uri", + "locationName": "integrationResponseId" + } + }, + "required": [ + "ApiId", + "IntegrationResponseId", + "IntegrationId" + ] + } + }, + "DeleteModel": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/models/{modelId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ModelId": { + "location": "uri", + "locationName": "modelId" + } + }, + "required": [ + "ModelId", + "ApiId" + ] + } + }, + "DeleteRoute": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + } + }, + "required": [ + "ApiId", + "RouteId" + ] + } + }, + "DeleteRouteResponse": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + }, + "RouteResponseId": { + "location": "uri", + "locationName": "routeResponseId" + } + }, + "required": [ + "RouteResponseId", + "ApiId", + "RouteId" + ] + } + }, + "DeleteStage": { + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "StageName": { + "location": "uri", + "locationName": "stageName" + } + }, + "required": [ + "StageName", + "ApiId" + ] + } + }, + "GetApi": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiEndpoint": { + "locationName": "apiEndpoint" + }, + "ApiId": { + "locationName": "apiId" + }, + "ApiKeySelectionExpression": { + "locationName": "apiKeySelectionExpression" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "Description": { + "locationName": "description" + }, + "DisableSchemaValidation": { + "locationName": "disableSchemaValidation", + "type": "boolean" + }, + "Name": { + "locationName": "name" + }, + "ProtocolType": { + "locationName": "protocolType" + }, + "RouteSelectionExpression": { + "locationName": "routeSelectionExpression" + }, + "Version": { + "locationName": "version" + }, + "Warnings": { + "shape": "Sc", + "locationName": "warnings" + } + } + } + }, + "GetApiMapping": { + "http": { + "method": "GET", + "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiMappingId": { + "location": "uri", + "locationName": "apiMappingId" + }, + "DomainName": { + "location": "uri", + "locationName": "domainName" + } + }, + "required": [ + "ApiMappingId", + "DomainName" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiId": { + "locationName": "apiId" + }, + "ApiMappingId": { + "locationName": "apiMappingId" + }, + "ApiMappingKey": { + "locationName": "apiMappingKey" + }, + "Stage": { + "locationName": "stage" + } + } + } + }, + "GetApiMappings": { + "http": { + "method": "GET", + "requestUri": "/v2/domainnames/{domainName}/apimappings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DomainName": { + "location": "uri", + "locationName": "domainName" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "DomainName" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApiId": { + "locationName": "apiId" + }, + "ApiMappingId": { + "locationName": "apiMappingId" + }, + "ApiMappingKey": { + "locationName": "apiMappingKey" + }, + "Stage": { + "locationName": "stage" + } + }, + "required": [ + "Stage", + "ApiId" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetApis": { + "http": { + "method": "GET", + "requestUri": "/v2/apis", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApiEndpoint": { + "locationName": "apiEndpoint" + }, + "ApiId": { + "locationName": "apiId" + }, + "ApiKeySelectionExpression": { + "locationName": "apiKeySelectionExpression" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "Description": { + "locationName": "description" + }, + "DisableSchemaValidation": { + "locationName": "disableSchemaValidation", + "type": "boolean" + }, + "Name": { + "locationName": "name" + }, + "ProtocolType": { + "locationName": "protocolType" + }, + "RouteSelectionExpression": { + "locationName": "routeSelectionExpression" + }, + "Version": { + "locationName": "version" + }, + "Warnings": { + "shape": "Sc", + "locationName": "warnings" + } + }, + "required": [ + "RouteSelectionExpression", + "ProtocolType", + "Name" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetAuthorizer": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "AuthorizerId": { + "location": "uri", + "locationName": "authorizerId" + } + }, + "required": [ + "AuthorizerId", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "locationName": "authorizerCredentialsArn" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "AuthorizerResultTtlInSeconds": { + "locationName": "authorizerResultTtlInSeconds", + "type": "integer" + }, + "AuthorizerType": { + "locationName": "authorizerType" + }, + "AuthorizerUri": { + "locationName": "authorizerUri" + }, + "IdentitySource": { + "shape": "Sl", + "locationName": "identitySource" + }, + "IdentityValidationExpression": { + "locationName": "identityValidationExpression" + }, + "Name": { + "locationName": "name" + }, + "ProviderArns": { + "shape": "Sm", + "locationName": "providerArns" + } + } + } + }, + "GetAuthorizers": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/authorizers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "locationName": "authorizerCredentialsArn" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "AuthorizerResultTtlInSeconds": { + "locationName": "authorizerResultTtlInSeconds", + "type": "integer" + }, + "AuthorizerType": { + "locationName": "authorizerType" + }, + "AuthorizerUri": { + "locationName": "authorizerUri" + }, + "IdentitySource": { + "shape": "Sl", + "locationName": "identitySource" + }, + "IdentityValidationExpression": { + "locationName": "identityValidationExpression" + }, + "Name": { + "locationName": "name" + }, + "ProviderArns": { + "shape": "Sm", + "locationName": "providerArns" + } + }, + "required": [ + "Name" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetDeployment": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "DeploymentId": { + "location": "uri", + "locationName": "deploymentId" + } + }, + "required": [ + "ApiId", + "DeploymentId" + ] + }, + "output": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "DeploymentStatus": { + "locationName": "deploymentStatus" + }, + "DeploymentStatusMessage": { + "locationName": "deploymentStatusMessage" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "GetDeployments": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/deployments", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "DeploymentStatus": { + "locationName": "deploymentStatus" + }, + "DeploymentStatusMessage": { + "locationName": "deploymentStatusMessage" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetDomainName": { + "http": { + "method": "GET", + "requestUri": "/v2/domainnames/{domainName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DomainName": { + "location": "uri", + "locationName": "domainName" + } + }, + "required": [ + "DomainName" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "locationName": "apiMappingSelectionExpression" + }, + "DomainName": { + "locationName": "domainName" + }, + "DomainNameConfigurations": { + "shape": "St", + "locationName": "domainNameConfigurations" + } + } + } + }, + "GetDomainNames": { + "http": { + "method": "GET", + "requestUri": "/v2/domainnames", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "locationName": "apiMappingSelectionExpression" + }, + "DomainName": { + "locationName": "domainName" + }, + "DomainNameConfigurations": { + "shape": "St", + "locationName": "domainNameConfigurations" + } + }, + "required": [ + "DomainName" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetIntegration": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + } + }, + "required": [ + "ApiId", + "IntegrationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ConnectionId": { + "locationName": "connectionId" + }, + "ConnectionType": { + "locationName": "connectionType" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "CredentialsArn": { + "locationName": "credentialsArn" + }, + "Description": { + "locationName": "description" + }, + "IntegrationId": { + "locationName": "integrationId" + }, + "IntegrationMethod": { + "locationName": "integrationMethod" + }, + "IntegrationResponseSelectionExpression": { + "locationName": "integrationResponseSelectionExpression" + }, + "IntegrationType": { + "locationName": "integrationType" + }, + "IntegrationUri": { + "locationName": "integrationUri" + }, + "PassthroughBehavior": { + "locationName": "passthroughBehavior" + }, + "RequestParameters": { + "shape": "S13", + "locationName": "requestParameters" + }, + "RequestTemplates": { + "shape": "S14", + "locationName": "requestTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + }, + "TimeoutInMillis": { + "locationName": "timeoutInMillis", + "type": "integer" + } + } + } + }, + "GetIntegrationResponse": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + }, + "IntegrationResponseId": { + "location": "uri", + "locationName": "integrationResponseId" + } + }, + "required": [ + "ApiId", + "IntegrationResponseId", + "IntegrationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "IntegrationResponseId": { + "locationName": "integrationResponseId" + }, + "IntegrationResponseKey": { + "locationName": "integrationResponseKey" + }, + "ResponseParameters": { + "shape": "S13", + "locationName": "responseParameters" + }, + "ResponseTemplates": { + "shape": "S14", + "locationName": "responseTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + } + } + } + }, + "GetIntegrationResponses": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "IntegrationId", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "IntegrationResponseId": { + "locationName": "integrationResponseId" + }, + "IntegrationResponseKey": { + "locationName": "integrationResponseKey" + }, + "ResponseParameters": { + "shape": "S13", + "locationName": "responseParameters" + }, + "ResponseTemplates": { + "shape": "S14", + "locationName": "responseTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + } + }, + "required": [ + "IntegrationResponseKey" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetIntegrations": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ConnectionId": { + "locationName": "connectionId" + }, + "ConnectionType": { + "locationName": "connectionType" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "CredentialsArn": { + "locationName": "credentialsArn" + }, + "Description": { + "locationName": "description" + }, + "IntegrationId": { + "locationName": "integrationId" + }, + "IntegrationMethod": { + "locationName": "integrationMethod" + }, + "IntegrationResponseSelectionExpression": { + "locationName": "integrationResponseSelectionExpression" + }, + "IntegrationType": { + "locationName": "integrationType" + }, + "IntegrationUri": { + "locationName": "integrationUri" + }, + "PassthroughBehavior": { + "locationName": "passthroughBehavior" + }, + "RequestParameters": { + "shape": "S13", + "locationName": "requestParameters" + }, + "RequestTemplates": { + "shape": "S14", + "locationName": "requestTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + }, + "TimeoutInMillis": { + "locationName": "timeoutInMillis", + "type": "integer" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetModel": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/models/{modelId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ModelId": { + "location": "uri", + "locationName": "modelId" + } + }, + "required": [ + "ModelId", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "ContentType": { + "locationName": "contentType" + }, + "Description": { + "locationName": "description" + }, + "ModelId": { + "locationName": "modelId" + }, + "Name": { + "locationName": "name" + }, + "Schema": { + "locationName": "schema" + } + } + } + }, + "GetModelTemplate": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/models/{modelId}/template", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ModelId": { + "location": "uri", + "locationName": "modelId" + } + }, + "required": [ + "ModelId", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Value": { + "locationName": "value" + } + } + } + }, + "GetModels": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/models", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ContentType": { + "locationName": "contentType" + }, + "Description": { + "locationName": "description" + }, + "ModelId": { + "locationName": "modelId" + }, + "Name": { + "locationName": "name" + }, + "Schema": { + "locationName": "schema" + } + }, + "required": [ + "Name" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetRoute": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + } + }, + "required": [ + "ApiId", + "RouteId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiKeyRequired": { + "locationName": "apiKeyRequired", + "type": "boolean" + }, + "AuthorizationScopes": { + "shape": "S1e", + "locationName": "authorizationScopes" + }, + "AuthorizationType": { + "locationName": "authorizationType" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "OperationName": { + "locationName": "operationName" + }, + "RequestModels": { + "shape": "S1g", + "locationName": "requestModels" + }, + "RequestParameters": { + "shape": "S1h", + "locationName": "requestParameters" + }, + "RouteId": { + "locationName": "routeId" + }, + "RouteKey": { + "locationName": "routeKey" + }, + "RouteResponseSelectionExpression": { + "locationName": "routeResponseSelectionExpression" + }, + "Target": { + "locationName": "target" + } + } + } + }, + "GetRouteResponse": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + }, + "RouteResponseId": { + "location": "uri", + "locationName": "routeResponseId" + } + }, + "required": [ + "RouteResponseId", + "ApiId", + "RouteId" + ] + }, + "output": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "ResponseModels": { + "shape": "S1g", + "locationName": "responseModels" + }, + "ResponseParameters": { + "shape": "S1h", + "locationName": "responseParameters" + }, + "RouteResponseId": { + "locationName": "routeResponseId" + }, + "RouteResponseKey": { + "locationName": "routeResponseKey" + } + } + } + }, + "GetRouteResponses": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + } + }, + "required": [ + "RouteId", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "ResponseModels": { + "shape": "S1g", + "locationName": "responseModels" + }, + "ResponseParameters": { + "shape": "S1h", + "locationName": "responseParameters" + }, + "RouteResponseId": { + "locationName": "routeResponseId" + }, + "RouteResponseKey": { + "locationName": "routeResponseKey" + } + }, + "required": [ + "RouteResponseKey" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetRoutes": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApiKeyRequired": { + "locationName": "apiKeyRequired", + "type": "boolean" + }, + "AuthorizationScopes": { + "shape": "S1e", + "locationName": "authorizationScopes" + }, + "AuthorizationType": { + "locationName": "authorizationType" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "OperationName": { + "locationName": "operationName" + }, + "RequestModels": { + "shape": "S1g", + "locationName": "requestModels" + }, + "RequestParameters": { + "shape": "S1h", + "locationName": "requestParameters" + }, + "RouteId": { + "locationName": "routeId" + }, + "RouteKey": { + "locationName": "routeKey" + }, + "RouteResponseSelectionExpression": { + "locationName": "routeResponseSelectionExpression" + }, + "Target": { + "locationName": "target" + } + }, + "required": [ + "RouteKey" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetStage": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "StageName": { + "location": "uri", + "locationName": "stageName" + } + }, + "required": [ + "StageName", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "S1n", + "locationName": "accessLogSettings" + }, + "ClientCertificateId": { + "locationName": "clientCertificateId" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DefaultRouteSettings": { + "shape": "S1o", + "locationName": "defaultRouteSettings" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "Description": { + "locationName": "description" + }, + "LastUpdatedDate": { + "shape": "Sb", + "locationName": "lastUpdatedDate" + }, + "RouteSettings": { + "shape": "S1s", + "locationName": "routeSettings" + }, + "StageName": { + "locationName": "stageName" + }, + "StageVariables": { + "shape": "S1t", + "locationName": "stageVariables" + } + } + } + }, + "GetStages": { + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/stages", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "Items": { + "locationName": "items", + "type": "list", + "member": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "S1n", + "locationName": "accessLogSettings" + }, + "ClientCertificateId": { + "locationName": "clientCertificateId" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DefaultRouteSettings": { + "shape": "S1o", + "locationName": "defaultRouteSettings" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "Description": { + "locationName": "description" + }, + "LastUpdatedDate": { + "shape": "Sb", + "locationName": "lastUpdatedDate" + }, + "RouteSettings": { + "shape": "S1s", + "locationName": "routeSettings" + }, + "StageName": { + "locationName": "stageName" + }, + "StageVariables": { + "shape": "S1t", + "locationName": "stageVariables" + } + }, + "required": [ + "StageName" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "UpdateApi": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ApiKeySelectionExpression": { + "locationName": "apiKeySelectionExpression" + }, + "Description": { + "locationName": "description" + }, + "DisableSchemaValidation": { + "locationName": "disableSchemaValidation", + "type": "boolean" + }, + "Name": { + "locationName": "name" + }, + "RouteSelectionExpression": { + "locationName": "routeSelectionExpression" + }, + "Version": { + "locationName": "version" + } + }, + "required": [ + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiEndpoint": { + "locationName": "apiEndpoint" + }, + "ApiId": { + "locationName": "apiId" + }, + "ApiKeySelectionExpression": { + "locationName": "apiKeySelectionExpression" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "Description": { + "locationName": "description" + }, + "DisableSchemaValidation": { + "locationName": "disableSchemaValidation", + "type": "boolean" + }, + "Name": { + "locationName": "name" + }, + "ProtocolType": { + "locationName": "protocolType" + }, + "RouteSelectionExpression": { + "locationName": "routeSelectionExpression" + }, + "Version": { + "locationName": "version" + }, + "Warnings": { + "shape": "Sc", + "locationName": "warnings" + } + } + } + }, + "UpdateApiMapping": { + "http": { + "method": "PATCH", + "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "locationName": "apiId" + }, + "ApiMappingId": { + "location": "uri", + "locationName": "apiMappingId" + }, + "ApiMappingKey": { + "locationName": "apiMappingKey" + }, + "DomainName": { + "location": "uri", + "locationName": "domainName" + }, + "Stage": { + "locationName": "stage" + } + }, + "required": [ + "ApiMappingId", + "ApiId", + "DomainName" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiId": { + "locationName": "apiId" + }, + "ApiMappingId": { + "locationName": "apiMappingId" + }, + "ApiMappingKey": { + "locationName": "apiMappingKey" + }, + "Stage": { + "locationName": "stage" + } + } + } + }, + "UpdateAuthorizer": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "AuthorizerCredentialsArn": { + "locationName": "authorizerCredentialsArn" + }, + "AuthorizerId": { + "location": "uri", + "locationName": "authorizerId" + }, + "AuthorizerResultTtlInSeconds": { + "locationName": "authorizerResultTtlInSeconds", + "type": "integer" + }, + "AuthorizerType": { + "locationName": "authorizerType" + }, + "AuthorizerUri": { + "locationName": "authorizerUri" + }, + "IdentitySource": { + "shape": "Sl", + "locationName": "identitySource" + }, + "IdentityValidationExpression": { + "locationName": "identityValidationExpression" + }, + "Name": { + "locationName": "name" + }, + "ProviderArns": { + "shape": "Sm", + "locationName": "providerArns" + } + }, + "required": [ + "AuthorizerId", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "locationName": "authorizerCredentialsArn" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "AuthorizerResultTtlInSeconds": { + "locationName": "authorizerResultTtlInSeconds", + "type": "integer" + }, + "AuthorizerType": { + "locationName": "authorizerType" + }, + "AuthorizerUri": { + "locationName": "authorizerUri" + }, + "IdentitySource": { + "shape": "Sl", + "locationName": "identitySource" + }, + "IdentityValidationExpression": { + "locationName": "identityValidationExpression" + }, + "Name": { + "locationName": "name" + }, + "ProviderArns": { + "shape": "Sm", + "locationName": "providerArns" + } + } + } + }, + "UpdateDeployment": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "DeploymentId": { + "location": "uri", + "locationName": "deploymentId" + }, + "Description": { + "locationName": "description" + } + }, + "required": [ + "ApiId", + "DeploymentId" + ] + }, + "output": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "DeploymentStatus": { + "locationName": "deploymentStatus" + }, + "DeploymentStatusMessage": { + "locationName": "deploymentStatusMessage" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "UpdateDomainName": { + "http": { + "method": "PATCH", + "requestUri": "/v2/domainnames/{domainName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DomainName": { + "location": "uri", + "locationName": "domainName" + }, + "DomainNameConfigurations": { + "shape": "St", + "locationName": "domainNameConfigurations" + } + }, + "required": [ + "DomainName" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "locationName": "apiMappingSelectionExpression" + }, + "DomainName": { + "locationName": "domainName" + }, + "DomainNameConfigurations": { + "shape": "St", + "locationName": "domainNameConfigurations" + } + } + } + }, + "UpdateIntegration": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ConnectionId": { + "locationName": "connectionId" + }, + "ConnectionType": { + "locationName": "connectionType" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "CredentialsArn": { + "locationName": "credentialsArn" + }, + "Description": { + "locationName": "description" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + }, + "IntegrationMethod": { + "locationName": "integrationMethod" + }, + "IntegrationType": { + "locationName": "integrationType" + }, + "IntegrationUri": { + "locationName": "integrationUri" + }, + "PassthroughBehavior": { + "locationName": "passthroughBehavior" + }, + "RequestParameters": { + "shape": "S13", + "locationName": "requestParameters" + }, + "RequestTemplates": { + "shape": "S14", + "locationName": "requestTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + }, + "TimeoutInMillis": { + "locationName": "timeoutInMillis", + "type": "integer" + } + }, + "required": [ + "ApiId", + "IntegrationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ConnectionId": { + "locationName": "connectionId" + }, + "ConnectionType": { + "locationName": "connectionType" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "CredentialsArn": { + "locationName": "credentialsArn" + }, + "Description": { + "locationName": "description" + }, + "IntegrationId": { + "locationName": "integrationId" + }, + "IntegrationMethod": { + "locationName": "integrationMethod" + }, + "IntegrationResponseSelectionExpression": { + "locationName": "integrationResponseSelectionExpression" + }, + "IntegrationType": { + "locationName": "integrationType" + }, + "IntegrationUri": { + "locationName": "integrationUri" + }, + "PassthroughBehavior": { + "locationName": "passthroughBehavior" + }, + "RequestParameters": { + "shape": "S13", + "locationName": "requestParameters" + }, + "RequestTemplates": { + "shape": "S14", + "locationName": "requestTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + }, + "TimeoutInMillis": { + "locationName": "timeoutInMillis", + "type": "integer" + } + } + } + }, + "UpdateIntegrationResponse": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "IntegrationId": { + "location": "uri", + "locationName": "integrationId" + }, + "IntegrationResponseId": { + "location": "uri", + "locationName": "integrationResponseId" + }, + "IntegrationResponseKey": { + "locationName": "integrationResponseKey" + }, + "ResponseParameters": { + "shape": "S13", + "locationName": "responseParameters" + }, + "ResponseTemplates": { + "shape": "S14", + "locationName": "responseTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + } + }, + "required": [ + "ApiId", + "IntegrationResponseId", + "IntegrationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "locationName": "contentHandlingStrategy" + }, + "IntegrationResponseId": { + "locationName": "integrationResponseId" + }, + "IntegrationResponseKey": { + "locationName": "integrationResponseKey" + }, + "ResponseParameters": { + "shape": "S13", + "locationName": "responseParameters" + }, + "ResponseTemplates": { + "shape": "S14", + "locationName": "responseTemplates" + }, + "TemplateSelectionExpression": { + "locationName": "templateSelectionExpression" + } + } + } + }, + "UpdateModel": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/models/{modelId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ContentType": { + "locationName": "contentType" + }, + "Description": { + "locationName": "description" + }, + "ModelId": { + "location": "uri", + "locationName": "modelId" + }, + "Name": { + "locationName": "name" + }, + "Schema": { + "locationName": "schema" + } + }, + "required": [ + "ModelId", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "ContentType": { + "locationName": "contentType" + }, + "Description": { + "locationName": "description" + }, + "ModelId": { + "locationName": "modelId" + }, + "Name": { + "locationName": "name" + }, + "Schema": { + "locationName": "schema" + } + } + } + }, + "UpdateRoute": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ApiKeyRequired": { + "locationName": "apiKeyRequired", + "type": "boolean" + }, + "AuthorizationScopes": { + "shape": "S1e", + "locationName": "authorizationScopes" + }, + "AuthorizationType": { + "locationName": "authorizationType" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "OperationName": { + "locationName": "operationName" + }, + "RequestModels": { + "shape": "S1g", + "locationName": "requestModels" + }, + "RequestParameters": { + "shape": "S1h", + "locationName": "requestParameters" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + }, + "RouteKey": { + "locationName": "routeKey" + }, + "RouteResponseSelectionExpression": { + "locationName": "routeResponseSelectionExpression" + }, + "Target": { + "locationName": "target" + } + }, + "required": [ + "ApiId", + "RouteId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApiKeyRequired": { + "locationName": "apiKeyRequired", + "type": "boolean" + }, + "AuthorizationScopes": { + "shape": "S1e", + "locationName": "authorizationScopes" + }, + "AuthorizationType": { + "locationName": "authorizationType" + }, + "AuthorizerId": { + "locationName": "authorizerId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "OperationName": { + "locationName": "operationName" + }, + "RequestModels": { + "shape": "S1g", + "locationName": "requestModels" + }, + "RequestParameters": { + "shape": "S1h", + "locationName": "requestParameters" + }, + "RouteId": { + "locationName": "routeId" + }, + "RouteKey": { + "locationName": "routeKey" + }, + "RouteResponseSelectionExpression": { + "locationName": "routeResponseSelectionExpression" + }, + "Target": { + "locationName": "target" + } + } + } + }, + "UpdateRouteResponse": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "ResponseModels": { + "shape": "S1g", + "locationName": "responseModels" + }, + "ResponseParameters": { + "shape": "S1h", + "locationName": "responseParameters" + }, + "RouteId": { + "location": "uri", + "locationName": "routeId" + }, + "RouteResponseId": { + "location": "uri", + "locationName": "routeResponseId" + }, + "RouteResponseKey": { + "locationName": "routeResponseKey" + } + }, + "required": [ + "RouteResponseId", + "ApiId", + "RouteId" + ] + }, + "output": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "locationName": "modelSelectionExpression" + }, + "ResponseModels": { + "shape": "S1g", + "locationName": "responseModels" + }, + "ResponseParameters": { + "shape": "S1h", + "locationName": "responseParameters" + }, + "RouteResponseId": { + "locationName": "routeResponseId" + }, + "RouteResponseKey": { + "locationName": "routeResponseKey" + } + } + } + }, + "UpdateStage": { + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "S1n", + "locationName": "accessLogSettings" + }, + "ApiId": { + "location": "uri", + "locationName": "apiId" + }, + "ClientCertificateId": { + "locationName": "clientCertificateId" + }, + "DefaultRouteSettings": { + "shape": "S1o", + "locationName": "defaultRouteSettings" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "Description": { + "locationName": "description" + }, + "RouteSettings": { + "shape": "S1s", + "locationName": "routeSettings" + }, + "StageName": { + "location": "uri", + "locationName": "stageName" + }, + "StageVariables": { + "shape": "S1t", + "locationName": "stageVariables" + } + }, + "required": [ + "StageName", + "ApiId" + ] + }, + "output": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "S1n", + "locationName": "accessLogSettings" + }, + "ClientCertificateId": { + "locationName": "clientCertificateId" + }, + "CreatedDate": { + "shape": "Sb", + "locationName": "createdDate" + }, + "DefaultRouteSettings": { + "shape": "S1o", + "locationName": "defaultRouteSettings" + }, + "DeploymentId": { + "locationName": "deploymentId" + }, + "Description": { + "locationName": "description" + }, + "LastUpdatedDate": { + "shape": "Sb", + "locationName": "lastUpdatedDate" + }, + "RouteSettings": { + "shape": "S1s", + "locationName": "routeSettings" + }, + "StageName": { + "locationName": "stageName" + }, + "StageVariables": { + "shape": "S1t", + "locationName": "stageVariables" + } + } + } + } + }, + "shapes": { + "Sb": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "Sc": { + "type": "list", + "member": {} + }, + "Sl": { + "type": "list", + "member": {} + }, + "Sm": { + "type": "list", + "member": {} + }, + "St": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ApiGatewayDomainName": { + "locationName": "apiGatewayDomainName" + }, + "CertificateArn": { + "locationName": "certificateArn" + }, + "CertificateName": { + "locationName": "certificateName" + }, + "CertificateUploadDate": { + "shape": "Sb", + "locationName": "certificateUploadDate" + }, + "EndpointType": { + "locationName": "endpointType" + }, + "HostedZoneId": { + "locationName": "hostedZoneId" + } + } + } + }, + "S13": { + "type": "map", + "key": {}, + "value": {} + }, + "S14": { + "type": "map", + "key": {}, + "value": {} + }, + "S1e": { + "type": "list", + "member": {} + }, + "S1g": { + "type": "map", + "key": {}, + "value": {} + }, + "S1h": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Required": { + "locationName": "required", + "type": "boolean" + } + } + } + }, + "S1n": { + "type": "structure", + "members": { + "DestinationArn": { + "locationName": "destinationArn" + }, + "Format": { + "locationName": "format" + } + } + }, + "S1o": { + "type": "structure", + "members": { + "DataTraceEnabled": { + "locationName": "dataTraceEnabled", + "type": "boolean" + }, + "DetailedMetricsEnabled": { + "locationName": "detailedMetricsEnabled", + "type": "boolean" + }, + "LoggingLevel": { + "locationName": "loggingLevel" + }, + "ThrottlingBurstLimit": { + "locationName": "throttlingBurstLimit", + "type": "integer" + }, + "ThrottlingRateLimit": { + "locationName": "throttlingRateLimit", + "type": "double" + } + } + }, + "S1s": { + "type": "map", + "key": {}, + "value": { + "shape": "S1o" + } + }, + "S1t": { + "type": "map", + "key": {}, + "value": {} + } + }, + "authorizers": { + "authorization_strategy": { + "name": "authorization_strategy", + "type": "provided", + "placement": { + "location": "header", + "name": "Authorization" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/apigatewayv2-2018-11-29.paginators.json b/node_modules/aws-sdk/apis/apigatewayv2-2018-11-29.paginators.json new file mode 100644 index 0000000..f3b7195 --- /dev/null +++ b/node_modules/aws-sdk/apis/apigatewayv2-2018-11-29.paginators.json @@ -0,0 +1,3 @@ +{ + "pagination" : { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.examples.json b/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.examples.json new file mode 100644 index 0000000..53415ec --- /dev/null +++ b/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.examples.json @@ -0,0 +1,257 @@ +{ + "version": "1.0", + "examples": { + "DeleteScalingPolicy": [ + { + "input": { + "PolicyName": "web-app-cpu-lt-25", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.", + "id": "to-delete-a-scaling-policy-1470863892689", + "title": "To delete a scaling policy" + } + ], + "DeregisterScalableTarget": [ + { + "input": { + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.", + "id": "to-deregister-a-scalable-target-1470864164895", + "title": "To deregister a scalable target" + } + ], + "DescribeScalableTargets": [ + { + "input": { + "ServiceNamespace": "ecs" + }, + "output": { + "ScalableTargets": [ + { + "CreationTime": "2016-05-06T11:21:46.199Z", + "MaxCapacity": 10, + "MinCapacity": 1, + "ResourceId": "service/default/web-app", + "RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scalable targets for the ecs service namespace.", + "id": "to-describe-scalable-targets-1470864286961", + "title": "To describe scalable targets" + } + ], + "DescribeScalingActivities": [ + { + "input": { + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "output": { + "ScalingActivities": [ + { + "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", + "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", + "Description": "Setting desired count to 1.", + "EndTime": "2016-05-06T16:04:32.111Z", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs", + "StartTime": "2016-05-06T16:03:58.171Z", + "StatusCode": "Successful", + "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs." + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.", + "id": "to-describe-scaling-activities-for-a-scalable-target-1470864398629", + "title": "To describe scaling activities for a scalable target" + } + ], + "DescribeScalingPolicies": [ + { + "input": { + "ServiceNamespace": "ecs" + }, + "output": { + "NextToken": "", + "ScalingPolicies": [ + { + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75", + "AlarmName": "web-app-cpu-gt-75" + } + ], + "CreationTime": "2016-05-06T12:11:39.230Z", + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", + "PolicyName": "web-app-cpu-gt-75", + "PolicyType": "StepScaling", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs", + "StepScalingPolicyConfiguration": { + "AdjustmentType": "PercentChangeInCapacity", + "Cooldown": 60, + "StepAdjustments": [ + { + "MetricIntervalLowerBound": 0, + "ScalingAdjustment": 200 + } + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scaling policies for the ecs service namespace.", + "id": "to-describe-scaling-policies-1470864609734", + "title": "To describe scaling policies" + } + ], + "PutScalingPolicy": [ + { + "input": { + "PolicyName": "web-app-cpu-gt-75", + "PolicyType": "StepScaling", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs", + "StepScalingPolicyConfiguration": { + "AdjustmentType": "PercentChangeInCapacity", + "Cooldown": 60, + "StepAdjustments": [ + { + "MetricIntervalLowerBound": 0, + "ScalingAdjustment": 200 + } + ] + } + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds.", + "id": "to-apply-a-scaling-policy-to-an-amazon-ecs-service-1470864779862", + "title": "To apply a scaling policy to an Amazon ECS service" + }, + { + "input": { + "PolicyName": "fleet-cpu-gt-75", + "PolicyType": "StepScaling", + "ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", + "ScalableDimension": "ec2:spot-fleet-request:TargetCapacity", + "ServiceNamespace": "ec2", + "StepScalingPolicyConfiguration": { + "AdjustmentType": "PercentChangeInCapacity", + "Cooldown": 180, + "StepAdjustments": [ + { + "MetricIntervalLowerBound": 0, + "ScalingAdjustment": 200 + } + ] + } + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.\",\n ", + "id": "to-apply-a-scaling-policy-to-an-amazon-ec2-spot-fleet-1472073278469", + "title": "To apply a scaling policy to an Amazon EC2 Spot fleet" + } + ], + "RegisterScalableTarget": [ + { + "input": { + "MaxCapacity": 10, + "MinCapacity": 1, + "ResourceId": "service/default/web-app", + "RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.", + "id": "to-register-a-new-scalable-target-1470864910380", + "title": "To register an ECS service as a scalable target" + }, + { + "input": { + "MaxCapacity": 10, + "MinCapacity": 1, + "ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", + "RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole", + "ScalableDimension": "ec2:spot-fleet-request:TargetCapacity", + "ServiceNamespace": "ec2" + }, + "output": { + }, + "comments": { + }, + "description": "This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10.", + "id": "to-register-an-ec2-spot-fleet-as-a-scalable-target-1472072899649", + "title": "To register an EC2 Spot fleet as a scalable target" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.min.json b/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.min.json new file mode 100644 index 0000000..31461b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.min.json @@ -0,0 +1,525 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-02-06", + "endpointPrefix": "autoscaling", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Application Auto Scaling", + "serviceId": "Application Auto Scaling", + "signatureVersion": "v4", + "signingName": "application-autoscaling", + "targetPrefix": "AnyScaleFrontendService", + "uid": "application-autoscaling-2016-02-06" + }, + "operations": { + "DeleteScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyName", + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members": { + "PolicyName": {}, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteScheduledAction": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace", + "ScheduledActionName", + "ResourceId", + "ScalableDimension" + ], + "members": { + "ServiceNamespace": {}, + "ScheduledActionName": {}, + "ResourceId": {}, + "ScalableDimension": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeregisterScalableTarget": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members": { + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeScalableTargets": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace" + ], + "members": { + "ServiceNamespace": {}, + "ResourceIds": { + "shape": "Sb" + }, + "ScalableDimension": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScalableTargets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "MinCapacity", + "MaxCapacity", + "RoleARN", + "CreationTime" + ], + "members": { + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "MinCapacity": { + "type": "integer" + }, + "MaxCapacity": { + "type": "integer" + }, + "RoleARN": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeScalingActivities": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace" + ], + "members": { + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScalingActivities": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ActivityId", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "Description", + "Cause", + "StartTime", + "StatusCode" + ], + "members": { + "ActivityId": {}, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "Description": {}, + "Cause": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "StatusCode": {}, + "StatusMessage": {}, + "Details": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeScalingPolicies": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace" + ], + "members": { + "PolicyNames": { + "shape": "Sb" + }, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScalingPolicies": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "PolicyARN", + "PolicyName", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "PolicyType", + "CreationTime" + ], + "members": { + "PolicyARN": {}, + "PolicyName": {}, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "PolicyType": {}, + "StepScalingPolicyConfiguration": { + "shape": "Sv" + }, + "TargetTrackingScalingPolicyConfiguration": { + "shape": "S14" + }, + "Alarms": { + "shape": "S1i" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeScheduledActions": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace" + ], + "members": { + "ScheduledActionNames": { + "shape": "Sb" + }, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScheduledActions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScheduledActionName", + "ScheduledActionARN", + "ServiceNamespace", + "Schedule", + "ResourceId", + "CreationTime" + ], + "members": { + "ScheduledActionName": {}, + "ScheduledActionARN": {}, + "ServiceNamespace": {}, + "Schedule": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "ScalableTargetAction": { + "shape": "S1p" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "PutScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyName", + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members": { + "PolicyName": {}, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "PolicyType": {}, + "StepScalingPolicyConfiguration": { + "shape": "Sv" + }, + "TargetTrackingScalingPolicyConfiguration": { + "shape": "S14" + } + } + }, + "output": { + "type": "structure", + "required": [ + "PolicyARN" + ], + "members": { + "PolicyARN": {}, + "Alarms": { + "shape": "S1i" + } + } + } + }, + "PutScheduledAction": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace", + "ScheduledActionName", + "ResourceId", + "ScalableDimension" + ], + "members": { + "ServiceNamespace": {}, + "Schedule": {}, + "ScheduledActionName": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "ScalableTargetAction": { + "shape": "S1p" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RegisterScalableTarget": { + "input": { + "type": "structure", + "required": [ + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members": { + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "MinCapacity": { + "type": "integer" + }, + "MaxCapacity": { + "type": "integer" + }, + "RoleARN": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sb": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "structure", + "members": { + "AdjustmentType": {}, + "StepAdjustments": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScalingAdjustment" + ], + "members": { + "MetricIntervalLowerBound": { + "type": "double" + }, + "MetricIntervalUpperBound": { + "type": "double" + }, + "ScalingAdjustment": { + "type": "integer" + } + } + } + }, + "MinAdjustmentMagnitude": { + "type": "integer" + }, + "Cooldown": { + "type": "integer" + }, + "MetricAggregationType": {} + } + }, + "S14": { + "type": "structure", + "required": [ + "TargetValue" + ], + "members": { + "TargetValue": { + "type": "double" + }, + "PredefinedMetricSpecification": { + "type": "structure", + "required": [ + "PredefinedMetricType" + ], + "members": { + "PredefinedMetricType": {}, + "ResourceLabel": {} + } + }, + "CustomizedMetricSpecification": { + "type": "structure", + "required": [ + "MetricName", + "Namespace", + "Statistic" + ], + "members": { + "MetricName": {}, + "Namespace": {}, + "Dimensions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "Statistic": {}, + "Unit": {} + } + }, + "ScaleOutCooldown": { + "type": "integer" + }, + "ScaleInCooldown": { + "type": "integer" + }, + "DisableScaleIn": { + "type": "boolean" + } + } + }, + "S1i": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AlarmName", + "AlarmARN" + ], + "members": { + "AlarmName": {}, + "AlarmARN": {} + } + } + }, + "S1p": { + "type": "structure", + "members": { + "MinCapacity": { + "type": "integer" + }, + "MaxCapacity": { + "type": "integer" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.paginators.json b/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.paginators.json new file mode 100644 index 0000000..72eec09 --- /dev/null +++ b/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.paginators.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeScalableTargets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScalableTargets" + }, + "DescribeScalingActivities": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScalingActivities" + }, + "DescribeScalingPolicies": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScalingPolicies" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appmesh-2018-10-01.examples.json b/node_modules/aws-sdk/apis/appmesh-2018-10-01.examples.json new file mode 100644 index 0000000..752e89e --- /dev/null +++ b/node_modules/aws-sdk/apis/appmesh-2018-10-01.examples.json @@ -0,0 +1,4 @@ +{ + "version": "1.0", + "examples": { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appmesh-2018-10-01.min.json b/node_modules/aws-sdk/apis/appmesh-2018-10-01.min.json new file mode 100644 index 0000000..df503ab --- /dev/null +++ b/node_modules/aws-sdk/apis/appmesh-2018-10-01.min.json @@ -0,0 +1,966 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-10-01", + "endpointPrefix": "appmesh", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS App Mesh", + "serviceId": "App Mesh", + "signatureVersion": "v4", + "signingName": "appmesh", + "uid": "appmesh-2018-10-01" + }, + "operations": { + "CreateMesh": { + "http": { + "method": "PUT", + "requestUri": "/meshes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": {} + } + }, + "output": { + "type": "structure", + "members": { + "mesh": { + "shape": "S5" + } + }, + "payload": "mesh" + }, + "idempotent": true + }, + "CreateRoute": { + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": {}, + "spec": { + "shape": "Sd" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "route": { + "shape": "Sl" + } + }, + "payload": "route" + }, + "idempotent": true + }, + "CreateVirtualNode": { + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "Sp" + }, + "virtualNodeName": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "S14" + } + }, + "payload": "virtualNode" + }, + "idempotent": true + }, + "CreateVirtualRouter": { + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "S18" + }, + "virtualRouterName": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "S1b" + } + }, + "payload": "virtualRouter" + }, + "idempotent": true + }, + "DeleteMesh": { + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + } + } + }, + "output": { + "type": "structure", + "members": { + "mesh": { + "shape": "S5" + } + }, + "payload": "mesh" + }, + "idempotent": true + }, + "DeleteRoute": { + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "route": { + "shape": "Sl" + } + }, + "payload": "route" + }, + "idempotent": true + }, + "DeleteVirtualNode": { + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "S14" + } + }, + "payload": "virtualNode" + }, + "idempotent": true + }, + "DeleteVirtualRouter": { + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "S1b" + } + }, + "payload": "virtualRouter" + }, + "idempotent": true + }, + "DescribeMesh": { + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + } + } + }, + "output": { + "type": "structure", + "members": { + "mesh": { + "shape": "S5" + } + }, + "payload": "mesh" + } + }, + "DescribeRoute": { + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "route": { + "shape": "Sl" + } + }, + "payload": "route" + } + }, + "DescribeVirtualNode": { + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "S14" + } + }, + "payload": "virtualNode" + } + }, + "DescribeVirtualRouter": { + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "S1b" + } + }, + "payload": "virtualRouter" + } + }, + "ListMeshes": { + "http": { + "method": "GET", + "requestUri": "/meshes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "meshes" + ], + "members": { + "meshes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "meshName": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListRoutes": { + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "routes" + ], + "members": { + "nextToken": {}, + "routes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "meshName": {}, + "routeName": {}, + "virtualRouterName": {} + } + } + } + } + } + }, + "ListVirtualNodes": { + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualNodes" + ], + "members": { + "nextToken": {}, + "virtualNodes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "meshName": {}, + "virtualNodeName": {} + } + } + } + } + } + }, + "ListVirtualRouters": { + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualRouters" + ], + "members": { + "nextToken": {}, + "virtualRouters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "meshName": {}, + "virtualRouterName": {} + } + } + } + } + } + }, + "UpdateRoute": { + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "location": "uri", + "locationName": "routeName" + }, + "spec": { + "shape": "Sd" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "route": { + "shape": "Sl" + } + }, + "payload": "route" + }, + "idempotent": true + }, + "UpdateVirtualNode": { + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "Sp" + }, + "virtualNodeName": { + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "S14" + } + }, + "payload": "virtualNode" + }, + "idempotent": true + }, + "UpdateVirtualRouter": { + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "S18" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "S1b" + } + }, + "payload": "virtualRouter" + }, + "idempotent": true + } + }, + "shapes": { + "S5": { + "type": "structure", + "required": [ + "meshName", + "metadata" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "S6" + }, + "status": { + "type": "structure", + "members": { + "status": {} + } + } + } + }, + "S6": { + "type": "structure", + "members": { + "arn": {}, + "createdAt": { + "type": "timestamp" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "uid": {}, + "version": { + "type": "long" + } + } + }, + "Sd": { + "type": "structure", + "members": { + "httpRoute": { + "type": "structure", + "members": { + "action": { + "type": "structure", + "members": { + "weightedTargets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "virtualNode": {}, + "weight": { + "type": "integer" + } + } + } + } + } + }, + "match": { + "type": "structure", + "members": { + "prefix": {} + } + } + } + } + } + }, + "Sl": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "S6" + }, + "routeName": {}, + "spec": { + "shape": "Sd" + }, + "status": { + "type": "structure", + "members": { + "status": {} + } + }, + "virtualRouterName": {} + } + }, + "Sp": { + "type": "structure", + "members": { + "backends": { + "type": "list", + "member": {} + }, + "listeners": { + "type": "list", + "member": { + "type": "structure", + "members": { + "healthCheck": { + "type": "structure", + "required": [ + "healthyThreshold", + "intervalMillis", + "protocol", + "timeoutMillis", + "unhealthyThreshold" + ], + "members": { + "healthyThreshold": { + "type": "integer" + }, + "intervalMillis": { + "type": "long" + }, + "path": {}, + "port": { + "type": "integer" + }, + "protocol": {}, + "timeoutMillis": { + "type": "long" + }, + "unhealthyThreshold": { + "type": "integer" + } + } + }, + "portMapping": { + "type": "structure", + "members": { + "port": { + "type": "integer" + }, + "protocol": {} + } + } + } + } + }, + "serviceDiscovery": { + "type": "structure", + "members": { + "dns": { + "type": "structure", + "members": { + "serviceName": {} + } + } + } + } + } + }, + "S14": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "S6" + }, + "spec": { + "shape": "Sp" + }, + "status": { + "type": "structure", + "members": { + "status": {} + } + }, + "virtualNodeName": {} + } + }, + "S18": { + "type": "structure", + "members": { + "serviceNames": { + "type": "list", + "member": {} + } + } + }, + "S1b": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "S6" + }, + "spec": { + "shape": "S18" + }, + "status": { + "type": "structure", + "members": { + "status": {} + } + }, + "virtualRouterName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appmesh-2018-10-01.paginators.json b/node_modules/aws-sdk/apis/appmesh-2018-10-01.paginators.json new file mode 100644 index 0000000..83c19c8 --- /dev/null +++ b/node_modules/aws-sdk/apis/appmesh-2018-10-01.paginators.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListMeshes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "meshes" + }, + "ListRoutes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "routes" + }, + "ListVirtualNodes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualNodes" + }, + "ListVirtualRouters": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualRouters" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appmesh-2019-01-25.examples.json b/node_modules/aws-sdk/apis/appmesh-2019-01-25.examples.json new file mode 100644 index 0000000..752e89e --- /dev/null +++ b/node_modules/aws-sdk/apis/appmesh-2019-01-25.examples.json @@ -0,0 +1,4 @@ +{ + "version": "1.0", + "examples": { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appmesh-2019-01-25.min.json b/node_modules/aws-sdk/apis/appmesh-2019-01-25.min.json new file mode 100644 index 0000000..144eb77 --- /dev/null +++ b/node_modules/aws-sdk/apis/appmesh-2019-01-25.min.json @@ -0,0 +1,1603 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-01-25", + "endpointPrefix": "appmesh", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS App Mesh", + "serviceId": "App Mesh", + "signatureVersion": "v4", + "signingName": "appmesh", + "uid": "appmesh-2019-01-25" + }, + "operations": { + "CreateMesh": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": {}, + "spec": { + "shape": "S4" + }, + "tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "Sc" + } + }, + "payload": "mesh" + }, + "idempotent": true + }, + "CreateRoute": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": {}, + "spec": { + "shape": "Sk" + }, + "tags": { + "shape": "S7" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "Su" + } + }, + "payload": "route" + }, + "idempotent": true + }, + "CreateVirtualNode": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "Sy" + }, + "tags": { + "shape": "S7" + }, + "virtualNodeName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "S1k" + } + }, + "payload": "virtualNode" + }, + "idempotent": true + }, + "CreateVirtualRouter": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "S1o" + }, + "tags": { + "shape": "S7" + }, + "virtualRouterName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "S1s" + } + }, + "payload": "virtualRouter" + }, + "idempotent": true + }, + "CreateVirtualService": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualServiceName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "S1w" + }, + "tags": { + "shape": "S7" + }, + "virtualServiceName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "S21" + } + }, + "payload": "virtualService" + }, + "idempotent": true + }, + "DeleteMesh": { + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "Sc" + } + }, + "payload": "mesh" + }, + "idempotent": true + }, + "DeleteRoute": { + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "Su" + } + }, + "payload": "route" + }, + "idempotent": true + }, + "DeleteVirtualNode": { + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "S1k" + } + }, + "payload": "virtualNode" + }, + "idempotent": true + }, + "DeleteVirtualRouter": { + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "S1s" + } + }, + "payload": "virtualRouter" + }, + "idempotent": true + }, + "DeleteVirtualService": { + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualServiceName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualServiceName": { + "location": "uri", + "locationName": "virtualServiceName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "S21" + } + }, + "payload": "virtualService" + }, + "idempotent": true + }, + "DescribeMesh": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "Sc" + } + }, + "payload": "mesh" + } + }, + "DescribeRoute": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "Su" + } + }, + "payload": "route" + } + }, + "DescribeVirtualNode": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "S1k" + } + }, + "payload": "virtualNode" + } + }, + "DescribeVirtualRouter": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "S1s" + } + }, + "payload": "virtualRouter" + } + }, + "DescribeVirtualService": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualServiceName" + ], + "members": { + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "virtualServiceName": { + "location": "uri", + "locationName": "virtualServiceName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "S21" + } + }, + "payload": "virtualService" + } + }, + "ListMeshes": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "meshes" + ], + "members": { + "meshes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "meshName" + ], + "members": { + "arn": {}, + "meshName": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListRoutes": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "routes" + ], + "members": { + "nextToken": {}, + "routes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "arn": {}, + "meshName": {}, + "routeName": {}, + "virtualRouterName": {} + } + } + } + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/v20190125/tags", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "resourceArn": { + "location": "querystring", + "locationName": "resourceArn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "tags" + ], + "members": { + "nextToken": {}, + "tags": { + "shape": "S7" + } + } + } + }, + "ListVirtualNodes": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualNodes" + ], + "members": { + "nextToken": {}, + "virtualNodes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualNodeName" + ], + "members": { + "arn": {}, + "meshName": {}, + "virtualNodeName": {} + } + } + } + } + } + }, + "ListVirtualRouters": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualRouters" + ], + "members": { + "nextToken": {}, + "virtualRouters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualRouterName" + ], + "members": { + "arn": {}, + "meshName": {}, + "virtualRouterName": {} + } + } + } + } + } + }, + "ListVirtualServices": { + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualServices" + ], + "members": { + "nextToken": {}, + "virtualServices": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualServiceName" + ], + "members": { + "arn": {}, + "meshName": {}, + "virtualServiceName": {} + } + } + } + } + } + }, + "TagResource": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/tag", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": { + "location": "querystring", + "locationName": "resourceArn" + }, + "tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UntagResource": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/untag", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "location": "querystring", + "locationName": "resourceArn" + }, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateMesh": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "Sc" + } + }, + "payload": "mesh" + }, + "idempotent": true + }, + "UpdateRoute": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "location": "uri", + "locationName": "routeName" + }, + "spec": { + "shape": "Sk" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "Su" + } + }, + "payload": "route" + }, + "idempotent": true + }, + "UpdateVirtualNode": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "Sy" + }, + "virtualNodeName": { + "location": "uri", + "locationName": "virtualNodeName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "S1k" + } + }, + "payload": "virtualNode" + }, + "idempotent": true + }, + "UpdateVirtualRouter": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "S1o" + }, + "virtualRouterName": { + "location": "uri", + "locationName": "virtualRouterName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "S1s" + } + }, + "payload": "virtualRouter" + }, + "idempotent": true + }, + "UpdateVirtualService": { + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualServiceName" + ], + "members": { + "clientToken": { + "idempotencyToken": true + }, + "meshName": { + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "S1w" + }, + "virtualServiceName": { + "location": "uri", + "locationName": "virtualServiceName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "S21" + } + }, + "payload": "virtualService" + }, + "idempotent": true + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "egressFilter": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {} + } + } + } + }, + "S7": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "Sc": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "Sd" + }, + "spec": { + "shape": "S4" + }, + "status": { + "type": "structure", + "members": { + "status": {} + } + } + } + }, + "Sd": { + "type": "structure", + "required": [ + "arn", + "createdAt", + "lastUpdatedAt", + "uid", + "version" + ], + "members": { + "arn": {}, + "createdAt": { + "type": "timestamp" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "uid": {}, + "version": { + "type": "long" + } + } + }, + "Sk": { + "type": "structure", + "members": { + "httpRoute": { + "type": "structure", + "required": [ + "action", + "match" + ], + "members": { + "action": { + "type": "structure", + "required": [ + "weightedTargets" + ], + "members": { + "weightedTargets": { + "shape": "Sn" + } + } + }, + "match": { + "type": "structure", + "required": [ + "prefix" + ], + "members": { + "prefix": {} + } + } + } + }, + "tcpRoute": { + "type": "structure", + "required": [ + "action" + ], + "members": { + "action": { + "type": "structure", + "required": [ + "weightedTargets" + ], + "members": { + "weightedTargets": { + "shape": "Sn" + } + } + } + } + } + } + }, + "Sn": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "virtualNode", + "weight" + ], + "members": { + "virtualNode": {}, + "weight": { + "type": "integer" + } + } + } + }, + "Su": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "routeName", + "spec", + "status", + "virtualRouterName" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "Sd" + }, + "routeName": {}, + "spec": { + "shape": "Sk" + }, + "status": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {} + } + }, + "virtualRouterName": {} + } + }, + "Sy": { + "type": "structure", + "members": { + "backends": { + "type": "list", + "member": { + "type": "structure", + "members": { + "virtualService": { + "type": "structure", + "required": [ + "virtualServiceName" + ], + "members": { + "virtualServiceName": {} + } + } + } + } + }, + "listeners": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "portMapping" + ], + "members": { + "healthCheck": { + "type": "structure", + "required": [ + "healthyThreshold", + "intervalMillis", + "protocol", + "timeoutMillis", + "unhealthyThreshold" + ], + "members": { + "healthyThreshold": { + "type": "integer" + }, + "intervalMillis": { + "type": "long" + }, + "path": {}, + "port": { + "type": "integer" + }, + "protocol": {}, + "timeoutMillis": { + "type": "long" + }, + "unhealthyThreshold": { + "type": "integer" + } + } + }, + "portMapping": { + "shape": "S1b" + } + } + } + }, + "logging": { + "type": "structure", + "members": { + "accessLog": { + "type": "structure", + "members": { + "file": { + "type": "structure", + "required": [ + "path" + ], + "members": { + "path": {} + } + } + } + } + } + }, + "serviceDiscovery": { + "type": "structure", + "members": { + "dns": { + "type": "structure", + "required": [ + "hostname" + ], + "members": { + "hostname": {} + } + } + } + } + } + }, + "S1b": { + "type": "structure", + "required": [ + "port", + "protocol" + ], + "members": { + "port": { + "type": "integer" + }, + "protocol": {} + } + }, + "S1k": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualNodeName" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "Sd" + }, + "spec": { + "shape": "Sy" + }, + "status": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {} + } + }, + "virtualNodeName": {} + } + }, + "S1o": { + "type": "structure", + "required": [ + "listeners" + ], + "members": { + "listeners": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "portMapping" + ], + "members": { + "portMapping": { + "shape": "S1b" + } + } + } + } + } + }, + "S1s": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualRouterName" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "Sd" + }, + "spec": { + "shape": "S1o" + }, + "status": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {} + } + }, + "virtualRouterName": {} + } + }, + "S1w": { + "type": "structure", + "members": { + "provider": { + "type": "structure", + "members": { + "virtualNode": { + "type": "structure", + "required": [ + "virtualNodeName" + ], + "members": { + "virtualNodeName": {} + } + }, + "virtualRouter": { + "type": "structure", + "required": [ + "virtualRouterName" + ], + "members": { + "virtualRouterName": {} + } + } + } + } + } + }, + "S21": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualServiceName" + ], + "members": { + "meshName": {}, + "metadata": { + "shape": "Sd" + }, + "spec": { + "shape": "S1w" + }, + "status": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {} + } + }, + "virtualServiceName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appmesh-2019-01-25.paginators.json b/node_modules/aws-sdk/apis/appmesh-2019-01-25.paginators.json new file mode 100644 index 0000000..ca51591 --- /dev/null +++ b/node_modules/aws-sdk/apis/appmesh-2019-01-25.paginators.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListMeshes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "meshes" + }, + "ListRoutes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "routes" + }, + "ListTagsForResource": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "tags" + }, + "ListVirtualNodes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualNodes" + }, + "ListVirtualRouters": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualRouters" + }, + "ListVirtualServices": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualServices" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appstream-2016-12-01.examples.json b/node_modules/aws-sdk/apis/appstream-2016-12-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/appstream-2016-12-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json b/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json new file mode 100644 index 0000000..13455bf --- /dev/null +++ b/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json @@ -0,0 +1,1520 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-12-01", + "endpointPrefix": "appstream2", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon AppStream", + "serviceId": "AppStream", + "signatureVersion": "v4", + "signingName": "appstream", + "targetPrefix": "PhotonAdminProxyService", + "uid": "appstream-2016-12-01" + }, + "operations": { + "AssociateFleet": { + "input": { + "type": "structure", + "required": [ + "FleetName", + "StackName" + ], + "members": { + "FleetName": {}, + "StackName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "BatchAssociateUserStack": { + "input": { + "type": "structure", + "required": [ + "UserStackAssociations" + ], + "members": { + "UserStackAssociations": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "errors": { + "shape": "Sb" + } + } + } + }, + "BatchDisassociateUserStack": { + "input": { + "type": "structure", + "required": [ + "UserStackAssociations" + ], + "members": { + "UserStackAssociations": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "errors": { + "shape": "Sb" + } + } + } + }, + "CopyImage": { + "input": { + "type": "structure", + "required": [ + "SourceImageName", + "DestinationImageName", + "DestinationRegion" + ], + "members": { + "SourceImageName": {}, + "DestinationImageName": {}, + "DestinationRegion": {}, + "DestinationImageDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "DestinationImageName": {} + } + } + }, + "CreateDirectoryConfig": { + "input": { + "type": "structure", + "required": [ + "DirectoryName", + "OrganizationalUnitDistinguishedNames", + "ServiceAccountCredentials" + ], + "members": { + "DirectoryName": {}, + "OrganizationalUnitDistinguishedNames": { + "shape": "Sn" + }, + "ServiceAccountCredentials": { + "shape": "Sp" + } + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryConfig": { + "shape": "St" + } + } + } + }, + "CreateFleet": { + "input": { + "type": "structure", + "required": [ + "Name", + "InstanceType", + "ComputeCapacity" + ], + "members": { + "Name": {}, + "ImageName": {}, + "ImageArn": {}, + "InstanceType": {}, + "FleetType": {}, + "ComputeCapacity": { + "shape": "Sy" + }, + "VpcConfig": { + "shape": "S10" + }, + "MaxUserDurationInSeconds": { + "type": "integer" + }, + "DisconnectTimeoutInSeconds": { + "type": "integer" + }, + "Description": {}, + "DisplayName": {}, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "DomainJoinInfo": { + "shape": "S15" + }, + "Tags": { + "shape": "S16" + } + } + }, + "output": { + "type": "structure", + "members": { + "Fleet": { + "shape": "S1a" + } + } + } + }, + "CreateImageBuilder": { + "input": { + "type": "structure", + "required": [ + "Name", + "InstanceType" + ], + "members": { + "Name": {}, + "ImageName": {}, + "ImageArn": {}, + "InstanceType": {}, + "Description": {}, + "DisplayName": {}, + "VpcConfig": { + "shape": "S10" + }, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "DomainJoinInfo": { + "shape": "S15" + }, + "AppstreamAgentVersion": {}, + "Tags": { + "shape": "S16" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageBuilder": { + "shape": "S1j" + } + } + } + }, + "CreateImageBuilderStreamingURL": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Validity": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingURL": {}, + "Expires": { + "type": "timestamp" + } + } + } + }, + "CreateStack": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Description": {}, + "DisplayName": {}, + "StorageConnectors": { + "shape": "S1u" + }, + "RedirectURL": {}, + "FeedbackURL": {}, + "UserSettings": { + "shape": "S22" + }, + "ApplicationSettings": { + "shape": "S26" + }, + "Tags": { + "shape": "S16" + } + } + }, + "output": { + "type": "structure", + "members": { + "Stack": { + "shape": "S29" + } + } + } + }, + "CreateStreamingURL": { + "input": { + "type": "structure", + "required": [ + "StackName", + "FleetName", + "UserId" + ], + "members": { + "StackName": {}, + "FleetName": {}, + "UserId": {}, + "ApplicationId": {}, + "Validity": { + "type": "long" + }, + "SessionContext": {} + } + }, + "output": { + "type": "structure", + "members": { + "StreamingURL": {}, + "Expires": { + "type": "timestamp" + } + } + } + }, + "CreateUser": { + "input": { + "type": "structure", + "required": [ + "UserName", + "AuthenticationType" + ], + "members": { + "UserName": { + "shape": "S7" + }, + "MessageAction": {}, + "FirstName": { + "shape": "S2j" + }, + "LastName": { + "shape": "S2j" + }, + "AuthenticationType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDirectoryConfig": { + "input": { + "type": "structure", + "required": [ + "DirectoryName" + ], + "members": { + "DirectoryName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteFleet": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteImage": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Image": { + "shape": "S2r" + } + } + } + }, + "DeleteImageBuilder": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImageBuilder": { + "shape": "S1j" + } + } + } + }, + "DeleteImagePermissions": { + "input": { + "type": "structure", + "required": [ + "Name", + "SharedAccountId" + ], + "members": { + "Name": {}, + "SharedAccountId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteStack": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteUser": { + "input": { + "type": "structure", + "required": [ + "UserName", + "AuthenticationType" + ], + "members": { + "UserName": { + "shape": "S7" + }, + "AuthenticationType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeDirectoryConfigs": { + "input": { + "type": "structure", + "members": { + "DirectoryNames": { + "type": "list", + "member": {} + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryConfigs": { + "type": "list", + "member": { + "shape": "St" + } + }, + "NextToken": {} + } + } + }, + "DescribeFleets": { + "input": { + "type": "structure", + "members": { + "Names": { + "shape": "S3e" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Fleets": { + "type": "list", + "member": { + "shape": "S1a" + } + }, + "NextToken": {} + } + } + }, + "DescribeImageBuilders": { + "input": { + "type": "structure", + "members": { + "Names": { + "shape": "S3e" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImageBuilders": { + "type": "list", + "member": { + "shape": "S1j" + } + }, + "NextToken": {} + } + } + }, + "DescribeImagePermissions": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "MaxResults": { + "type": "integer" + }, + "SharedAwsAccountIds": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "SharedImagePermissionsList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "sharedAccountId", + "imagePermissions" + ], + "members": { + "sharedAccountId": {}, + "imagePermissions": { + "shape": "S2z" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeImages": { + "input": { + "type": "structure", + "members": { + "Names": { + "shape": "S3e" + }, + "Arns": { + "type": "list", + "member": {} + }, + "Type": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Images": { + "type": "list", + "member": { + "shape": "S2r" + } + }, + "NextToken": {} + } + } + }, + "DescribeSessions": { + "input": { + "type": "structure", + "required": [ + "StackName", + "FleetName" + ], + "members": { + "StackName": {}, + "FleetName": {}, + "UserId": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + }, + "AuthenticationType": {} + } + }, + "output": { + "type": "structure", + "members": { + "Sessions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id", + "UserId", + "StackName", + "FleetName", + "State" + ], + "members": { + "Id": {}, + "UserId": {}, + "StackName": {}, + "FleetName": {}, + "State": {}, + "ConnectionState": {}, + "StartTime": { + "type": "timestamp" + }, + "MaxExpirationTime": { + "type": "timestamp" + }, + "AuthenticationType": {}, + "NetworkAccessConfiguration": { + "type": "structure", + "members": { + "EniPrivateIpAddress": {}, + "EniId": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeStacks": { + "input": { + "type": "structure", + "members": { + "Names": { + "shape": "S3e" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Stacks": { + "type": "list", + "member": { + "shape": "S29" + } + }, + "NextToken": {} + } + } + }, + "DescribeUserStackAssociations": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "UserName": { + "shape": "S7" + }, + "AuthenticationType": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserStackAssociations": { + "shape": "S5" + }, + "NextToken": {} + } + } + }, + "DescribeUsers": { + "input": { + "type": "structure", + "required": [ + "AuthenticationType" + ], + "members": { + "AuthenticationType": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Users": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AuthenticationType" + ], + "members": { + "Arn": {}, + "UserName": { + "shape": "S7" + }, + "Enabled": { + "type": "boolean" + }, + "Status": {}, + "FirstName": { + "shape": "S2j" + }, + "LastName": { + "shape": "S2j" + }, + "CreatedTime": { + "type": "timestamp" + }, + "AuthenticationType": {} + } + } + }, + "NextToken": {} + } + } + }, + "DisableUser": { + "input": { + "type": "structure", + "required": [ + "UserName", + "AuthenticationType" + ], + "members": { + "UserName": { + "shape": "S7" + }, + "AuthenticationType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateFleet": { + "input": { + "type": "structure", + "required": [ + "FleetName", + "StackName" + ], + "members": { + "FleetName": {}, + "StackName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "EnableUser": { + "input": { + "type": "structure", + "required": [ + "UserName", + "AuthenticationType" + ], + "members": { + "UserName": { + "shape": "S7" + }, + "AuthenticationType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ExpireSession": { + "input": { + "type": "structure", + "required": [ + "SessionId" + ], + "members": { + "SessionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListAssociatedFleets": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Names": { + "shape": "S3e" + }, + "NextToken": {} + } + } + }, + "ListAssociatedStacks": { + "input": { + "type": "structure", + "required": [ + "FleetName" + ], + "members": { + "FleetName": {}, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Names": { + "shape": "S3e" + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S16" + } + } + } + }, + "StartFleet": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartImageBuilder": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "AppstreamAgentVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImageBuilder": { + "shape": "S1j" + } + } + } + }, + "StopFleet": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopImageBuilder": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImageBuilder": { + "shape": "S1j" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S16" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDirectoryConfig": { + "input": { + "type": "structure", + "required": [ + "DirectoryName" + ], + "members": { + "DirectoryName": {}, + "OrganizationalUnitDistinguishedNames": { + "shape": "Sn" + }, + "ServiceAccountCredentials": { + "shape": "Sp" + } + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryConfig": { + "shape": "St" + } + } + } + }, + "UpdateFleet": { + "input": { + "type": "structure", + "members": { + "ImageName": {}, + "ImageArn": {}, + "Name": {}, + "InstanceType": {}, + "ComputeCapacity": { + "shape": "Sy" + }, + "VpcConfig": { + "shape": "S10" + }, + "MaxUserDurationInSeconds": { + "type": "integer" + }, + "DisconnectTimeoutInSeconds": { + "type": "integer" + }, + "DeleteVpcConfig": { + "deprecated": true, + "type": "boolean" + }, + "Description": {}, + "DisplayName": {}, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "DomainJoinInfo": { + "shape": "S15" + }, + "AttributesToDelete": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "Fleet": { + "shape": "S1a" + } + } + } + }, + "UpdateImagePermissions": { + "input": { + "type": "structure", + "required": [ + "Name", + "SharedAccountId", + "ImagePermissions" + ], + "members": { + "Name": {}, + "SharedAccountId": {}, + "ImagePermissions": { + "shape": "S2z" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateStack": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "DisplayName": {}, + "Description": {}, + "Name": {}, + "StorageConnectors": { + "shape": "S1u" + }, + "DeleteStorageConnectors": { + "deprecated": true, + "type": "boolean" + }, + "RedirectURL": {}, + "FeedbackURL": {}, + "AttributesToDelete": { + "type": "list", + "member": {} + }, + "UserSettings": { + "shape": "S22" + }, + "ApplicationSettings": { + "shape": "S26" + } + } + }, + "output": { + "type": "structure", + "members": { + "Stack": { + "shape": "S29" + } + } + } + } + }, + "shapes": { + "S5": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "S6": { + "type": "structure", + "required": [ + "StackName", + "UserName", + "AuthenticationType" + ], + "members": { + "StackName": {}, + "UserName": { + "shape": "S7" + }, + "AuthenticationType": {}, + "SendEmailNotification": { + "type": "boolean" + } + } + }, + "S7": { + "type": "string", + "sensitive": true + }, + "Sb": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UserStackAssociation": { + "shape": "S6" + }, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "Sn": { + "type": "list", + "member": {} + }, + "Sp": { + "type": "structure", + "required": [ + "AccountName", + "AccountPassword" + ], + "members": { + "AccountName": { + "type": "string", + "sensitive": true + }, + "AccountPassword": { + "type": "string", + "sensitive": true + } + } + }, + "St": { + "type": "structure", + "required": [ + "DirectoryName" + ], + "members": { + "DirectoryName": {}, + "OrganizationalUnitDistinguishedNames": { + "shape": "Sn" + }, + "ServiceAccountCredentials": { + "shape": "Sp" + }, + "CreatedTime": { + "type": "timestamp" + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "DesiredInstances" + ], + "members": { + "DesiredInstances": { + "type": "integer" + } + } + }, + "S10": { + "type": "structure", + "members": { + "SubnetIds": { + "type": "list", + "member": {} + }, + "SecurityGroupIds": { + "type": "list", + "member": {} + } + } + }, + "S15": { + "type": "structure", + "members": { + "DirectoryName": {}, + "OrganizationalUnitDistinguishedName": {} + } + }, + "S16": { + "type": "map", + "key": {}, + "value": {} + }, + "S1a": { + "type": "structure", + "required": [ + "Arn", + "Name", + "InstanceType", + "ComputeCapacityStatus", + "State" + ], + "members": { + "Arn": {}, + "Name": {}, + "DisplayName": {}, + "Description": {}, + "ImageName": {}, + "ImageArn": {}, + "InstanceType": {}, + "FleetType": {}, + "ComputeCapacityStatus": { + "type": "structure", + "required": [ + "Desired" + ], + "members": { + "Desired": { + "type": "integer" + }, + "Running": { + "type": "integer" + }, + "InUse": { + "type": "integer" + }, + "Available": { + "type": "integer" + } + } + }, + "MaxUserDurationInSeconds": { + "type": "integer" + }, + "DisconnectTimeoutInSeconds": { + "type": "integer" + }, + "State": {}, + "VpcConfig": { + "shape": "S10" + }, + "CreatedTime": { + "type": "timestamp" + }, + "FleetErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "DomainJoinInfo": { + "shape": "S15" + } + } + }, + "S1j": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Arn": {}, + "ImageArn": {}, + "Description": {}, + "DisplayName": {}, + "VpcConfig": { + "shape": "S10" + }, + "InstanceType": {}, + "Platform": {}, + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "CreatedTime": { + "type": "timestamp" + }, + "EnableDefaultInternetAccess": { + "type": "boolean" + }, + "DomainJoinInfo": { + "shape": "S15" + }, + "ImageBuilderErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ErrorCode": {}, + "ErrorMessage": {}, + "ErrorTimestamp": { + "type": "timestamp" + } + } + } + }, + "AppstreamAgentVersion": {} + } + }, + "S1u": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ConnectorType" + ], + "members": { + "ConnectorType": {}, + "ResourceIdentifier": {}, + "Domains": { + "type": "list", + "member": {} + } + } + } + }, + "S22": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "Permission" + ], + "members": { + "Action": {}, + "Permission": {} + } + } + }, + "S26": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "SettingsGroup": {} + } + }, + "S29": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Arn": {}, + "Name": {}, + "Description": {}, + "DisplayName": {}, + "CreatedTime": { + "type": "timestamp" + }, + "StorageConnectors": { + "shape": "S1u" + }, + "RedirectURL": {}, + "FeedbackURL": {}, + "StackErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "UserSettings": { + "shape": "S22" + }, + "ApplicationSettings": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "SettingsGroup": {}, + "S3BucketName": {} + } + } + } + }, + "S2j": { + "type": "string", + "sensitive": true + }, + "S2r": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Arn": {}, + "BaseImageArn": {}, + "DisplayName": {}, + "State": {}, + "Visibility": {}, + "ImageBuilderSupported": { + "type": "boolean" + }, + "Platform": {}, + "Description": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Applications": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "DisplayName": {}, + "IconURL": {}, + "LaunchPath": {}, + "LaunchParameters": {}, + "Enabled": { + "type": "boolean" + }, + "Metadata": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "CreatedTime": { + "type": "timestamp" + }, + "PublicBaseImageReleasedDate": { + "type": "timestamp" + }, + "AppstreamAgentVersion": {}, + "ImagePermissions": { + "shape": "S2z" + } + } + }, + "S2z": { + "type": "structure", + "members": { + "allowFleet": { + "type": "boolean" + }, + "allowImageBuilder": { + "type": "boolean" + } + } + }, + "S3e": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appstream-2016-12-01.paginators.json b/node_modules/aws-sdk/apis/appstream-2016-12-01.paginators.json new file mode 100644 index 0000000..b39f18a --- /dev/null +++ b/node_modules/aws-sdk/apis/appstream-2016-12-01.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "DescribeImagePermissions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "DescribeImages": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/appstream-2016-12-01.waiters2.json b/node_modules/aws-sdk/apis/appstream-2016-12-01.waiters2.json new file mode 100644 index 0000000..f53f609 --- /dev/null +++ b/node_modules/aws-sdk/apis/appstream-2016-12-01.waiters2.json @@ -0,0 +1,55 @@ +{ + "version": 2, + "waiters": { + "FleetStarted": { + "delay": 30, + "maxAttempts": 40, + "operation": "DescribeFleets", + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Fleets[].State", + "expected": "ACTIVE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "PENDING_DEACTIVATE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "INACTIVE" + } + ] + }, + "FleetStopped": { + "delay": 30, + "maxAttempts": 40, + "operation": "DescribeFleets", + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Fleets[].State", + "expected": "INACTIVE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "PENDING_ACTIVATE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "ACTIVE" + } + ] + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appsync-2017-07-25.examples.json b/node_modules/aws-sdk/apis/appsync-2017-07-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/appsync-2017-07-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json b/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json new file mode 100644 index 0000000..3cab985 --- /dev/null +++ b/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json @@ -0,0 +1,1501 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-07-25", + "endpointPrefix": "appsync", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "AWSAppSync", + "serviceFullName": "AWS AppSync", + "serviceId": "AppSync", + "signatureVersion": "v4", + "signingName": "appsync", + "uid": "appsync-2017-07-25" + }, + "operations": { + "CreateApiKey": { + "http": { + "requestUri": "/v1/apis/{apiId}/apikeys" + }, + "input": { + "type": "structure", + "required": [ + "apiId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "description": {}, + "expires": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "apiKey": { + "shape": "S5" + } + } + } + }, + "CreateDataSource": { + "http": { + "requestUri": "/v1/apis/{apiId}/datasources" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "name", + "type" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "name": {}, + "description": {}, + "type": {}, + "serviceRoleArn": {}, + "dynamodbConfig": { + "shape": "S9" + }, + "lambdaConfig": { + "shape": "Sb" + }, + "elasticsearchConfig": { + "shape": "Sc" + }, + "httpConfig": { + "shape": "Sd" + }, + "relationalDatabaseConfig": { + "shape": "Sh" + } + } + }, + "output": { + "type": "structure", + "members": { + "dataSource": { + "shape": "Sl" + } + } + } + }, + "CreateFunction": { + "http": { + "requestUri": "/v1/apis/{apiId}/functions" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "name", + "dataSourceName", + "requestMappingTemplate", + "functionVersion" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "name": {}, + "description": {}, + "dataSourceName": {}, + "requestMappingTemplate": {}, + "responseMappingTemplate": {}, + "functionVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "functionConfiguration": { + "shape": "Sp" + } + } + } + }, + "CreateGraphqlApi": { + "http": { + "requestUri": "/v1/apis" + }, + "input": { + "type": "structure", + "required": [ + "name", + "authenticationType" + ], + "members": { + "name": {}, + "logConfig": { + "shape": "Sr" + }, + "authenticationType": {}, + "userPoolConfig": { + "shape": "Su" + }, + "openIDConnectConfig": { + "shape": "Sw" + }, + "tags": { + "shape": "Sx" + }, + "additionalAuthenticationProviders": { + "shape": "S10" + } + } + }, + "output": { + "type": "structure", + "members": { + "graphqlApi": { + "shape": "S14" + } + } + } + }, + "CreateResolver": { + "http": { + "requestUri": "/v1/apis/{apiId}/types/{typeName}/resolvers" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName", + "fieldName", + "requestMappingTemplate" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + }, + "fieldName": {}, + "dataSourceName": {}, + "requestMappingTemplate": {}, + "responseMappingTemplate": {}, + "kind": {}, + "pipelineConfig": { + "shape": "S18" + } + } + }, + "output": { + "type": "structure", + "members": { + "resolver": { + "shape": "S1b" + } + } + } + }, + "CreateType": { + "http": { + "requestUri": "/v1/apis/{apiId}/types" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "definition", + "format" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "definition": {}, + "format": {} + } + }, + "output": { + "type": "structure", + "members": { + "type": { + "shape": "S1f" + } + } + } + }, + "DeleteApiKey": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apis/{apiId}/apikeys/{id}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "id" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "id": { + "location": "uri", + "locationName": "id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDataSource": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apis/{apiId}/datasources/{name}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "name" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "name": { + "location": "uri", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteFunction": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apis/{apiId}/functions/{functionId}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "functionId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "functionId": { + "location": "uri", + "locationName": "functionId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteGraphqlApi": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apis/{apiId}" + }, + "input": { + "type": "structure", + "required": [ + "apiId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteResolver": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName", + "fieldName" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + }, + "fieldName": { + "location": "uri", + "locationName": "fieldName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteType": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apis/{apiId}/types/{typeName}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetDataSource": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/datasources/{name}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "name" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "name": { + "location": "uri", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": { + "dataSource": { + "shape": "Sl" + } + } + } + }, + "GetFunction": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/functions/{functionId}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "functionId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "functionId": { + "location": "uri", + "locationName": "functionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "functionConfiguration": { + "shape": "Sp" + } + } + } + }, + "GetGraphqlApi": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}" + }, + "input": { + "type": "structure", + "required": [ + "apiId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + } + } + }, + "output": { + "type": "structure", + "members": { + "graphqlApi": { + "shape": "S14" + } + } + } + }, + "GetIntrospectionSchema": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/schema" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "format" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "format": { + "location": "querystring", + "locationName": "format" + }, + "includeDirectives": { + "location": "querystring", + "locationName": "includeDirectives", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "schema": { + "type": "blob" + } + }, + "payload": "schema" + } + }, + "GetResolver": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName", + "fieldName" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + }, + "fieldName": { + "location": "uri", + "locationName": "fieldName" + } + } + }, + "output": { + "type": "structure", + "members": { + "resolver": { + "shape": "S1b" + } + } + } + }, + "GetSchemaCreationStatus": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/schemacreation" + }, + "input": { + "type": "structure", + "required": [ + "apiId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "details": {} + } + } + }, + "GetType": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/types/{typeName}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName", + "format" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + }, + "format": { + "location": "querystring", + "locationName": "format" + } + } + }, + "output": { + "type": "structure", + "members": { + "type": { + "shape": "S1f" + } + } + } + }, + "ListApiKeys": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/apikeys" + }, + "input": { + "type": "structure", + "required": [ + "apiId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "apiKeys": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "nextToken": {} + } + } + }, + "ListDataSources": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/datasources" + }, + "input": { + "type": "structure", + "required": [ + "apiId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "dataSources": { + "type": "list", + "member": { + "shape": "Sl" + } + }, + "nextToken": {} + } + } + }, + "ListFunctions": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/functions" + }, + "input": { + "type": "structure", + "required": [ + "apiId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "functions": { + "type": "list", + "member": { + "shape": "Sp" + } + }, + "nextToken": {} + } + } + }, + "ListGraphqlApis": { + "http": { + "method": "GET", + "requestUri": "/v1/apis" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "graphqlApis": { + "type": "list", + "member": { + "shape": "S14" + } + }, + "nextToken": {} + } + } + }, + "ListResolvers": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/types/{typeName}/resolvers" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resolvers": { + "shape": "S2q" + }, + "nextToken": {} + } + } + }, + "ListResolversByFunction": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/functions/{functionId}/resolvers" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "functionId" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "functionId": { + "location": "uri", + "locationName": "functionId" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resolvers": { + "shape": "S2q" + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/v1/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Sx" + } + } + } + }, + "ListTypes": { + "http": { + "method": "GET", + "requestUri": "/v1/apis/{apiId}/types" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "format" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "format": { + "location": "querystring", + "locationName": "format" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "types": { + "type": "list", + "member": { + "shape": "S1f" + } + }, + "nextToken": {} + } + } + }, + "StartSchemaCreation": { + "http": { + "requestUri": "/v1/apis/{apiId}/schemacreation" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "definition" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "definition": { + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": {} + } + } + }, + "TagResource": { + "http": { + "requestUri": "/v1/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "tags": { + "shape": "Sx" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/v1/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "tagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateApiKey": { + "http": { + "requestUri": "/v1/apis/{apiId}/apikeys/{id}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "id" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "id": { + "location": "uri", + "locationName": "id" + }, + "description": {}, + "expires": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "apiKey": { + "shape": "S5" + } + } + } + }, + "UpdateDataSource": { + "http": { + "requestUri": "/v1/apis/{apiId}/datasources/{name}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "name", + "type" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "name": { + "location": "uri", + "locationName": "name" + }, + "description": {}, + "type": {}, + "serviceRoleArn": {}, + "dynamodbConfig": { + "shape": "S9" + }, + "lambdaConfig": { + "shape": "Sb" + }, + "elasticsearchConfig": { + "shape": "Sc" + }, + "httpConfig": { + "shape": "Sd" + }, + "relationalDatabaseConfig": { + "shape": "Sh" + } + } + }, + "output": { + "type": "structure", + "members": { + "dataSource": { + "shape": "Sl" + } + } + } + }, + "UpdateFunction": { + "http": { + "requestUri": "/v1/apis/{apiId}/functions/{functionId}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "name", + "functionId", + "dataSourceName", + "requestMappingTemplate", + "functionVersion" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "name": {}, + "description": {}, + "functionId": { + "location": "uri", + "locationName": "functionId" + }, + "dataSourceName": {}, + "requestMappingTemplate": {}, + "responseMappingTemplate": {}, + "functionVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "functionConfiguration": { + "shape": "Sp" + } + } + } + }, + "UpdateGraphqlApi": { + "http": { + "requestUri": "/v1/apis/{apiId}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "name" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "name": {}, + "logConfig": { + "shape": "Sr" + }, + "authenticationType": {}, + "userPoolConfig": { + "shape": "Su" + }, + "openIDConnectConfig": { + "shape": "Sw" + }, + "additionalAuthenticationProviders": { + "shape": "S10" + } + } + }, + "output": { + "type": "structure", + "members": { + "graphqlApi": { + "shape": "S14" + } + } + } + }, + "UpdateResolver": { + "http": { + "requestUri": "/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName", + "fieldName", + "requestMappingTemplate" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + }, + "fieldName": { + "location": "uri", + "locationName": "fieldName" + }, + "dataSourceName": {}, + "requestMappingTemplate": {}, + "responseMappingTemplate": {}, + "kind": {}, + "pipelineConfig": { + "shape": "S18" + } + } + }, + "output": { + "type": "structure", + "members": { + "resolver": { + "shape": "S1b" + } + } + } + }, + "UpdateType": { + "http": { + "requestUri": "/v1/apis/{apiId}/types/{typeName}" + }, + "input": { + "type": "structure", + "required": [ + "apiId", + "typeName", + "format" + ], + "members": { + "apiId": { + "location": "uri", + "locationName": "apiId" + }, + "typeName": { + "location": "uri", + "locationName": "typeName" + }, + "definition": {}, + "format": {} + } + }, + "output": { + "type": "structure", + "members": { + "type": { + "shape": "S1f" + } + } + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "members": { + "id": {}, + "description": {}, + "expires": { + "type": "long" + } + } + }, + "S9": { + "type": "structure", + "required": [ + "tableName", + "awsRegion" + ], + "members": { + "tableName": {}, + "awsRegion": {}, + "useCallerCredentials": { + "type": "boolean" + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "lambdaFunctionArn" + ], + "members": { + "lambdaFunctionArn": {} + } + }, + "Sc": { + "type": "structure", + "required": [ + "endpoint", + "awsRegion" + ], + "members": { + "endpoint": {}, + "awsRegion": {} + } + }, + "Sd": { + "type": "structure", + "members": { + "endpoint": {}, + "authorizationConfig": { + "type": "structure", + "required": [ + "authorizationType" + ], + "members": { + "authorizationType": {}, + "awsIamConfig": { + "type": "structure", + "members": { + "signingRegion": {}, + "signingServiceName": {} + } + } + } + } + } + }, + "Sh": { + "type": "structure", + "members": { + "relationalDatabaseSourceType": {}, + "rdsHttpEndpointConfig": { + "type": "structure", + "members": { + "awsRegion": {}, + "dbClusterIdentifier": {}, + "databaseName": {}, + "schema": {}, + "awsSecretStoreArn": {} + } + } + } + }, + "Sl": { + "type": "structure", + "members": { + "dataSourceArn": {}, + "name": {}, + "description": {}, + "type": {}, + "serviceRoleArn": {}, + "dynamodbConfig": { + "shape": "S9" + }, + "lambdaConfig": { + "shape": "Sb" + }, + "elasticsearchConfig": { + "shape": "Sc" + }, + "httpConfig": { + "shape": "Sd" + }, + "relationalDatabaseConfig": { + "shape": "Sh" + } + } + }, + "Sp": { + "type": "structure", + "members": { + "functionId": {}, + "functionArn": {}, + "name": {}, + "description": {}, + "dataSourceName": {}, + "requestMappingTemplate": {}, + "responseMappingTemplate": {}, + "functionVersion": {} + } + }, + "Sr": { + "type": "structure", + "required": [ + "fieldLogLevel", + "cloudWatchLogsRoleArn" + ], + "members": { + "fieldLogLevel": {}, + "cloudWatchLogsRoleArn": {} + } + }, + "Su": { + "type": "structure", + "required": [ + "userPoolId", + "awsRegion", + "defaultAction" + ], + "members": { + "userPoolId": {}, + "awsRegion": {}, + "defaultAction": {}, + "appIdClientRegex": {} + } + }, + "Sw": { + "type": "structure", + "required": [ + "issuer" + ], + "members": { + "issuer": {}, + "clientId": {}, + "iatTTL": { + "type": "long" + }, + "authTTL": { + "type": "long" + } + } + }, + "Sx": { + "type": "map", + "key": {}, + "value": {} + }, + "S10": { + "type": "list", + "member": { + "type": "structure", + "members": { + "authenticationType": {}, + "openIDConnectConfig": { + "shape": "Sw" + }, + "userPoolConfig": { + "type": "structure", + "required": [ + "userPoolId", + "awsRegion" + ], + "members": { + "userPoolId": {}, + "awsRegion": {}, + "appIdClientRegex": {} + } + } + } + } + }, + "S14": { + "type": "structure", + "members": { + "name": {}, + "apiId": {}, + "authenticationType": {}, + "logConfig": { + "shape": "Sr" + }, + "userPoolConfig": { + "shape": "Su" + }, + "openIDConnectConfig": { + "shape": "Sw" + }, + "arn": {}, + "uris": { + "type": "map", + "key": {}, + "value": {} + }, + "tags": { + "shape": "Sx" + }, + "additionalAuthenticationProviders": { + "shape": "S10" + } + } + }, + "S18": { + "type": "structure", + "members": { + "functions": { + "type": "list", + "member": {} + } + } + }, + "S1b": { + "type": "structure", + "members": { + "typeName": {}, + "fieldName": {}, + "dataSourceName": {}, + "resolverArn": {}, + "requestMappingTemplate": {}, + "responseMappingTemplate": {}, + "kind": {}, + "pipelineConfig": { + "shape": "S18" + } + } + }, + "S1f": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "arn": {}, + "definition": {}, + "format": {} + } + }, + "S2q": { + "type": "list", + "member": { + "shape": "S1b" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/appsync-2017-07-25.paginators.json b/node_modules/aws-sdk/apis/appsync-2017-07-25.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/appsync-2017-07-25.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/athena-2017-05-18.examples.json b/node_modules/aws-sdk/apis/athena-2017-05-18.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/athena-2017-05-18.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/athena-2017-05-18.min.json b/node_modules/aws-sdk/apis/athena-2017-05-18.min.json new file mode 100644 index 0000000..60881aa --- /dev/null +++ b/node_modules/aws-sdk/apis/athena-2017-05-18.min.json @@ -0,0 +1,670 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-05-18", + "endpointPrefix": "athena", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Athena", + "serviceId": "Athena", + "signatureVersion": "v4", + "targetPrefix": "AmazonAthena", + "uid": "athena-2017-05-18" + }, + "operations": { + "BatchGetNamedQuery": { + "input": { + "type": "structure", + "required": [ + "NamedQueryIds" + ], + "members": { + "NamedQueryIds": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "NamedQueries": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "UnprocessedNamedQueryIds": { + "type": "list", + "member": { + "type": "structure", + "members": { + "NamedQueryId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "BatchGetQueryExecution": { + "input": { + "type": "structure", + "required": [ + "QueryExecutionIds" + ], + "members": { + "QueryExecutionIds": { + "shape": "Sh" + } + } + }, + "output": { + "type": "structure", + "members": { + "QueryExecutions": { + "type": "list", + "member": { + "shape": "Sl" + } + }, + "UnprocessedQueryExecutionIds": { + "type": "list", + "member": { + "type": "structure", + "members": { + "QueryExecutionId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "CreateNamedQuery": { + "input": { + "type": "structure", + "required": [ + "Name", + "Database", + "QueryString" + ], + "members": { + "Name": {}, + "Description": {}, + "Database": {}, + "QueryString": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "WorkGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "NamedQueryId": {} + } + }, + "idempotent": true + }, + "CreateWorkGroup": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Configuration": { + "shape": "S13" + }, + "Description": {}, + "Tags": { + "shape": "S17" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteNamedQuery": { + "input": { + "type": "structure", + "required": [ + "NamedQueryId" + ], + "members": { + "NamedQueryId": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteWorkGroup": { + "input": { + "type": "structure", + "required": [ + "WorkGroup" + ], + "members": { + "WorkGroup": {}, + "RecursiveDeleteOption": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "GetNamedQuery": { + "input": { + "type": "structure", + "required": [ + "NamedQueryId" + ], + "members": { + "NamedQueryId": {} + } + }, + "output": { + "type": "structure", + "members": { + "NamedQuery": { + "shape": "S6" + } + } + } + }, + "GetQueryExecution": { + "input": { + "type": "structure", + "required": [ + "QueryExecutionId" + ], + "members": { + "QueryExecutionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "QueryExecution": { + "shape": "Sl" + } + } + } + }, + "GetQueryResults": { + "input": { + "type": "structure", + "required": [ + "QueryExecutionId" + ], + "members": { + "QueryExecutionId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "UpdateCount": { + "type": "long" + }, + "ResultSet": { + "type": "structure", + "members": { + "Rows": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Data": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VarCharValue": {} + } + } + } + } + } + }, + "ResultSetMetadata": { + "type": "structure", + "members": { + "ColumnInfo": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Type" + ], + "members": { + "CatalogName": {}, + "SchemaName": {}, + "TableName": {}, + "Name": {}, + "Label": {}, + "Type": {}, + "Precision": { + "type": "integer" + }, + "Scale": { + "type": "integer" + }, + "Nullable": {}, + "CaseSensitive": { + "type": "boolean" + } + } + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "GetWorkGroup": { + "input": { + "type": "structure", + "required": [ + "WorkGroup" + ], + "members": { + "WorkGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "WorkGroup": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "State": {}, + "Configuration": { + "shape": "S13" + }, + "Description": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + } + } + }, + "ListNamedQueries": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "WorkGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "NamedQueryIds": { + "shape": "S2" + }, + "NextToken": {} + } + } + }, + "ListQueryExecutions": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "WorkGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "QueryExecutionIds": { + "shape": "Sh" + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S17" + }, + "NextToken": {} + } + } + }, + "ListWorkGroups": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "WorkGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "State": {}, + "Description": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "StartQueryExecution": { + "input": { + "type": "structure", + "required": [ + "QueryString" + ], + "members": { + "QueryString": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "QueryExecutionContext": { + "shape": "Sr" + }, + "ResultConfiguration": { + "shape": "Sn" + }, + "WorkGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "QueryExecutionId": {} + } + }, + "idempotent": true + }, + "StopQueryExecution": { + "input": { + "type": "structure", + "required": [ + "QueryExecutionId" + ], + "members": { + "QueryExecutionId": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "Tags" + ], + "members": { + "ResourceARN": {}, + "Tags": { + "shape": "S17" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "TagKeys" + ], + "members": { + "ResourceARN": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateWorkGroup": { + "input": { + "type": "structure", + "required": [ + "WorkGroup" + ], + "members": { + "WorkGroup": {}, + "Description": {}, + "ConfigurationUpdates": { + "type": "structure", + "members": { + "EnforceWorkGroupConfiguration": { + "type": "boolean" + }, + "ResultConfigurationUpdates": { + "type": "structure", + "members": { + "OutputLocation": {}, + "RemoveOutputLocation": { + "type": "boolean" + }, + "EncryptionConfiguration": { + "shape": "Sp" + }, + "RemoveEncryptionConfiguration": { + "type": "boolean" + } + } + }, + "PublishCloudWatchMetricsEnabled": { + "type": "boolean" + }, + "BytesScannedCutoffPerQuery": { + "type": "long" + }, + "RemoveBytesScannedCutoffPerQuery": { + "type": "boolean" + } + } + }, + "State": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "S6": { + "type": "structure", + "required": [ + "Name", + "Database", + "QueryString" + ], + "members": { + "Name": {}, + "Description": {}, + "Database": {}, + "QueryString": {}, + "NamedQueryId": {}, + "WorkGroup": {} + } + }, + "Sh": { + "type": "list", + "member": {} + }, + "Sl": { + "type": "structure", + "members": { + "QueryExecutionId": {}, + "Query": {}, + "StatementType": {}, + "ResultConfiguration": { + "shape": "Sn" + }, + "QueryExecutionContext": { + "shape": "Sr" + }, + "Status": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": {}, + "SubmissionDateTime": { + "type": "timestamp" + }, + "CompletionDateTime": { + "type": "timestamp" + } + } + }, + "Statistics": { + "type": "structure", + "members": { + "EngineExecutionTimeInMillis": { + "type": "long" + }, + "DataScannedInBytes": { + "type": "long" + } + } + }, + "WorkGroup": {} + } + }, + "Sn": { + "type": "structure", + "members": { + "OutputLocation": {}, + "EncryptionConfiguration": { + "shape": "Sp" + } + } + }, + "Sp": { + "type": "structure", + "required": [ + "EncryptionOption" + ], + "members": { + "EncryptionOption": {}, + "KmsKey": {} + } + }, + "Sr": { + "type": "structure", + "members": { + "Database": {} + } + }, + "S13": { + "type": "structure", + "members": { + "ResultConfiguration": { + "shape": "Sn" + }, + "EnforceWorkGroupConfiguration": { + "type": "boolean" + }, + "PublishCloudWatchMetricsEnabled": { + "type": "boolean" + }, + "BytesScannedCutoffPerQuery": { + "type": "long" + } + } + }, + "S17": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/athena-2017-05-18.paginators.json b/node_modules/aws-sdk/apis/athena-2017-05-18.paginators.json new file mode 100644 index 0000000..eee98d0 --- /dev/null +++ b/node_modules/aws-sdk/apis/athena-2017-05-18.paginators.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "GetQueryResults": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNamedQueries": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListQueryExecutions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListWorkGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/autoscaling-2011-01-01.examples.json b/node_modules/aws-sdk/apis/autoscaling-2011-01-01.examples.json new file mode 100644 index 0000000..33ffc9c --- /dev/null +++ b/node_modules/aws-sdk/apis/autoscaling-2011-01-01.examples.json @@ -0,0 +1,1396 @@ +{ + "version": "1.0", + "examples": { + "AttachInstances": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified instance to the specified Auto Scaling group.", + "id": "autoscaling-attach-instances-1", + "title": "To attach an instance to an Auto Scaling group" + } + ], + "AttachLoadBalancerTargetGroups": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified target group to the specified Auto Scaling group.", + "id": "autoscaling-attach-load-balancer-target-groups-1", + "title": "To attach a target group to an Auto Scaling group" + } + ], + "AttachLoadBalancers": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified load balancer to the specified Auto Scaling group.", + "id": "autoscaling-attach-load-balancers-1", + "title": "To attach a load balancer to an Auto Scaling group" + } + ], + "CompleteLifecycleAction": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionResult": "CONTINUE", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", + "LifecycleHookName": "my-lifecycle-hook" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", + "id": "autoscaling-complete-lifecycle-action-1", + "title": "To complete the lifecycle action" + } + ], + "CreateAutoScalingGroup": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchConfigurationName": "my-launch-config", + "MaxSize": 3, + "MinSize": 1, + "VPCZoneIdentifier": "subnet-4176792c" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Auto Scaling group.", + "id": "autoscaling-create-auto-scaling-group-1", + "title": "To create an Auto Scaling group" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "AvailabilityZones": [ + "us-west-2c" + ], + "HealthCheckGracePeriod": 120, + "HealthCheckType": "ELB", + "LaunchConfigurationName": "my-launch-config", + "LoadBalancerNames": [ + "my-load-balancer" + ], + "MaxSize": 3, + "MinSize": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.", + "id": "autoscaling-create-auto-scaling-group-2", + "title": "To create an Auto Scaling group with an attached load balancer" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "HealthCheckGracePeriod": 120, + "HealthCheckType": "ELB", + "LaunchConfigurationName": "my-launch-config", + "MaxSize": 3, + "MinSize": 1, + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ], + "VPCZoneIdentifier": "subnet-4176792c, subnet-65ea5f08" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Auto Scaling group and attaches the specified target group.", + "id": "autoscaling-create-auto-scaling-group-3", + "title": "To create an Auto Scaling group with an attached target group" + } + ], + "CreateLaunchConfiguration": [ + { + "input": { + "IamInstanceProfile": "my-iam-role", + "ImageId": "ami-12345678", + "InstanceType": "m3.medium", + "LaunchConfigurationName": "my-launch-config", + "SecurityGroups": [ + "sg-eb2af88e" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a launch configuration.", + "id": "autoscaling-create-launch-configuration-1", + "title": "To create a launch configuration" + } + ], + "CreateOrUpdateTags": [ + { + "input": { + "Tags": [ + { + "Key": "Role", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "WebServer" + }, + { + "Key": "Dept", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "Research" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds two tags to the specified Auto Scaling group.", + "id": "autoscaling-create-or-update-tags-1", + "title": "To create or update tags for an Auto Scaling group" + } + ], + "DeleteAutoScalingGroup": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Auto Scaling group.", + "id": "autoscaling-delete-auto-scaling-group-1", + "title": "To delete an Auto Scaling group" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ForceDelete": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Auto Scaling group and all its instances.", + "id": "autoscaling-delete-auto-scaling-group-2", + "title": "To delete an Auto Scaling group and all its instances" + } + ], + "DeleteLaunchConfiguration": [ + { + "input": { + "LaunchConfigurationName": "my-launch-config" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified launch configuration.", + "id": "autoscaling-delete-launch-configuration-1", + "title": "To delete a launch configuration" + } + ], + "DeleteLifecycleHook": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified lifecycle hook.", + "id": "autoscaling-delete-lifecycle-hook-1", + "title": "To delete a lifecycle hook" + } + ], + "DeleteNotificationConfiguration": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified notification from the specified Auto Scaling group.", + "id": "autoscaling-delete-notification-configuration-1", + "title": "To delete an Auto Scaling notification" + } + ], + "DeletePolicy": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "ScaleIn" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Auto Scaling policy.", + "id": "autoscaling-delete-policy-1", + "title": "To delete an Auto Scaling policy" + } + ], + "DeleteScheduledAction": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified scheduled action from the specified Auto Scaling group.", + "id": "autoscaling-delete-scheduled-action-1", + "title": "To delete a scheduled action from an Auto Scaling group" + } + ], + "DeleteTags": [ + { + "input": { + "Tags": [ + { + "Key": "Dept", + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "Research" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified tag from the specified Auto Scaling group.", + "id": "autoscaling-delete-tags-1", + "title": "To delete a tag from an Auto Scaling group" + } + ], + "DescribeAccountLimits": [ + { + "output": { + "MaxNumberOfAutoScalingGroups": 20, + "MaxNumberOfLaunchConfigurations": 100, + "NumberOfAutoScalingGroups": 3, + "NumberOfLaunchConfigurations": 5 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Auto Scaling limits for your AWS account.", + "id": "autoscaling-describe-account-limits-1", + "title": "To describe your Auto Scaling account limits" + } + ], + "DescribeAdjustmentTypes": [ + { + "output": { + "AdjustmentTypes": [ + { + "AdjustmentType": "ChangeInCapacity" + }, + { + "AdjustmentType": "ExactCapcity" + }, + { + "AdjustmentType": "PercentChangeInCapacity" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available adjustment types.", + "id": "autoscaling-describe-adjustment-types-1", + "title": "To describe the Auto Scaling adjustment types" + } + ], + "DescribeAutoScalingGroups": [ + { + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "AutoScalingGroups": [ + { + "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group", + "AutoScalingGroupName": "my-auto-scaling-group", + "AvailabilityZones": [ + "us-west-2c" + ], + "CreatedTime": "2013-08-19T20:53:25.584Z", + "DefaultCooldown": 300, + "DesiredCapacity": 1, + "EnabledMetrics": [ + + ], + "HealthCheckGracePeriod": 300, + "HealthCheckType": "EC2", + "Instances": [ + { + "AvailabilityZone": "us-west-2c", + "HealthStatus": "Healthy", + "InstanceId": "i-4ba0837f", + "LaunchConfigurationName": "my-launch-config", + "LifecycleState": "InService", + "ProtectedFromScaleIn": false + } + ], + "LaunchConfigurationName": "my-launch-config", + "LoadBalancerNames": [ + + ], + "MaxSize": 1, + "MinSize": 0, + "NewInstancesProtectedFromScaleIn": false, + "SuspendedProcesses": [ + + ], + "Tags": [ + + ], + "TerminationPolicies": [ + "Default" + ], + "VPCZoneIdentifier": "subnet-12345678" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Auto Scaling group.", + "id": "autoscaling-describe-auto-scaling-groups-1", + "title": "To describe an Auto Scaling group" + } + ], + "DescribeAutoScalingInstances": [ + { + "input": { + "InstanceIds": [ + "i-4ba0837f" + ] + }, + "output": { + "AutoScalingInstances": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "AvailabilityZone": "us-west-2c", + "HealthStatus": "HEALTHY", + "InstanceId": "i-4ba0837f", + "LaunchConfigurationName": "my-launch-config", + "LifecycleState": "InService", + "ProtectedFromScaleIn": false + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Auto Scaling instance.", + "id": "autoscaling-describe-auto-scaling-instances-1", + "title": "To describe one or more Auto Scaling instances" + } + ], + "DescribeAutoScalingNotificationTypes": [ + { + "output": { + "AutoScalingNotificationTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCH", + "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", + "autoscaling:EC2_INSTANCE_TERMINATE", + "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", + "autoscaling:TEST_NOTIFICATION" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available notification types.", + "id": "autoscaling-describe-auto-scaling-notification-types-1", + "title": "To describe the Auto Scaling notification types" + } + ], + "DescribeLaunchConfigurations": [ + { + "input": { + "LaunchConfigurationNames": [ + "my-launch-config" + ] + }, + "output": { + "LaunchConfigurations": [ + { + "AssociatePublicIpAddress": true, + "BlockDeviceMappings": [ + + ], + "CreatedTime": "2014-05-07T17:39:28.599Z", + "EbsOptimized": false, + "ImageId": "ami-043a5034", + "InstanceMonitoring": { + "Enabled": true + }, + "InstanceType": "t1.micro", + "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", + "LaunchConfigurationName": "my-launch-config", + "SecurityGroups": [ + "sg-67ef0308" + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified launch configuration.", + "id": "autoscaling-describe-launch-configurations-1", + "title": "To describe Auto Scaling launch configurations" + } + ], + "DescribeLifecycleHookTypes": [ + { + "output": { + "LifecycleHookTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCHING", + "autoscaling:EC2_INSTANCE_TERMINATING" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available lifecycle hook types.", + "id": "autoscaling-describe-lifecycle-hook-types-1", + "title": "To describe the available types of lifecycle hooks" + } + ], + "DescribeLifecycleHooks": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LifecycleHooks": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "DefaultResult": "ABANDON", + "GlobalTimeout": 172800, + "HeartbeatTimeout": 3600, + "LifecycleHookName": "my-lifecycle-hook", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the lifecycle hooks for the specified Auto Scaling group.", + "id": "autoscaling-describe-lifecycle-hooks-1", + "title": "To describe your lifecycle hooks" + } + ], + "DescribeLoadBalancerTargetGroups": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancerTargetGroups": [ + { + "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "State": "Added" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the target groups attached to the specified Auto Scaling group.", + "id": "autoscaling-describe-load-balancer-target-groups-1", + "title": "To describe the target groups for an Auto Scaling group" + } + ], + "DescribeLoadBalancers": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancers": [ + { + "LoadBalancerName": "my-load-balancer", + "State": "Added" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the load balancers attached to the specified Auto Scaling group.", + "id": "autoscaling-describe-load-balancers-1", + "title": "To describe the load balancers for an Auto Scaling group" + } + ], + "DescribeMetricCollectionTypes": [ + { + "output": { + "Granularities": [ + { + "Granularity": "1Minute" + } + ], + "Metrics": [ + { + "Metric": "GroupMinSize" + }, + { + "Metric": "GroupMaxSize" + }, + { + "Metric": "GroupDesiredCapacity" + }, + { + "Metric": "GroupInServiceInstances" + }, + { + "Metric": "GroupPendingInstances" + }, + { + "Metric": "GroupTerminatingInstances" + }, + { + "Metric": "GroupStandbyInstances" + }, + { + "Metric": "GroupTotalInstances" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available metric collection types.", + "id": "autoscaling-describe-metric-collection-types-1", + "title": "To describe the Auto Scaling metric collection types" + } + ], + "DescribeNotificationConfigurations": [ + { + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "NotificationConfigurations": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + }, + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the notification configurations for the specified Auto Scaling group.", + "id": "autoscaling-describe-notification-configurations-1", + "title": "To describe Auto Scaling notification configurations" + } + ], + "DescribePolicies": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScalingPolicies": [ + { + "AdjustmentType": "ChangeInCapacity", + "Alarms": [ + + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", + "PolicyName": "ScaleIn", + "ScalingAdjustment": -1 + }, + { + "AdjustmentType": "PercentChangeInCapacity", + "Alarms": [ + + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "Cooldown": 60, + "MinAdjustmentStep": 2, + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", + "PolicyName": "ScalePercentChange", + "ScalingAdjustment": 25 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the policies for the specified Auto Scaling group.", + "id": "autoscaling-describe-policies-1", + "title": "To describe Auto Scaling policies" + } + ], + "DescribeScalingActivities": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "Activities": [ + { + "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", + "Description": "Launching a new EC2 instance: i-4ba0837f", + "Details": "details", + "EndTime": "2013-08-19T20:54:02Z", + "Progress": 100, + "StartTime": "2013-08-19T20:53:29.930Z", + "StatusCode": "Successful" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scaling activities for the specified Auto Scaling group.", + "id": "autoscaling-describe-scaling-activities-1", + "title": "To describe the scaling activities for an Auto Scaling group" + } + ], + "DescribeScalingProcessTypes": [ + { + "output": { + "Processes": [ + { + "ProcessName": "AZRebalance" + }, + { + "ProcessName": "AddToLoadBalancer" + }, + { + "ProcessName": "AlarmNotification" + }, + { + "ProcessName": "HealthCheck" + }, + { + "ProcessName": "Launch" + }, + { + "ProcessName": "ReplaceUnhealthy" + }, + { + "ProcessName": "ScheduledActions" + }, + { + "ProcessName": "Terminate" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Auto Scaling process types.", + "id": "autoscaling-describe-scaling-process-types-1", + "title": "To describe the Auto Scaling process types" + } + ], + "DescribeScheduledActions": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScheduledUpdateGroupActions": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 4, + "MaxSize": 6, + "MinSize": 2, + "Recurrence": "30 0 1 12 0", + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2016-12-01T00:30:00Z", + "Time": "2016-12-01T00:30:00Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scheduled actions for the specified Auto Scaling group.", + "id": "autoscaling-describe-scheduled-actions-1", + "title": "To describe scheduled actions" + } + ], + "DescribeTags": [ + { + "input": { + "Filters": [ + { + "Name": "auto-scaling-group", + "Values": [ + "my-auto-scaling-group" + ] + } + ] + }, + "output": { + "Tags": [ + { + "Key": "Dept", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "Research" + }, + { + "Key": "Role", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "WebServer" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags for the specified Auto Scaling group.", + "id": "autoscaling-describe-tags-1", + "title": "To describe tags" + } + ], + "DescribeTerminationPolicyTypes": [ + { + "output": { + "TerminationPolicyTypes": [ + "ClosestToNextInstanceHour", + "Default", + "NewestInstance", + "OldestInstance", + "OldestLaunchConfiguration" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available termination policy types.", + "id": "autoscaling-describe-termination-policy-types-1", + "title": "To describe termination policy types" + } + ], + "DetachInstances": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", + "Description": "Detaching EC2 instance: i-93633f9b", + "Details": "details", + "Progress": 50, + "StartTime": "2015-04-12T15:02:16.179Z", + "StatusCode": "InProgress" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified instance from the specified Auto Scaling group.", + "id": "autoscaling-detach-instances-1", + "title": "To detach an instance from an Auto Scaling group" + } + ], + "DetachLoadBalancerTargetGroups": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified target group from the specified Auto Scaling group", + "id": "autoscaling-detach-load-balancer-target-groups-1", + "title": "To detach a target group from an Auto Scaling group" + } + ], + "DetachLoadBalancers": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified load balancer from the specified Auto Scaling group.", + "id": "autoscaling-detach-load-balancers-1", + "title": "To detach a load balancer from an Auto Scaling group" + } + ], + "DisableMetricsCollection": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Metrics": [ + "GroupDesiredCapacity" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", + "id": "autoscaling-disable-metrics-collection-1", + "title": "To disable metrics collection for an Auto Scaling group" + } + ], + "EnableMetricsCollection": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Granularity": "1Minute" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables data collection for the specified Auto Scaling group.", + "id": "autoscaling-enable-metrics-collection-1", + "title": "To enable metrics collection for an Auto Scaling group" + } + ], + "EnterStandby": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", + "Description": "Moving EC2 instance to Standby: i-93633f9b", + "Details": "details", + "Progress": 50, + "StartTime": "2015-04-12T15:10:23.640Z", + "StatusCode": "InProgress" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example puts the specified instance into standby mode.", + "id": "autoscaling-enter-standby-1", + "title": "To move instances into standby mode" + } + ], + "ExecutePolicy": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "HonorCooldown": true, + "PolicyName": "ScaleIn" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example executes the specified Auto Scaling policy for the specified Auto Scaling group.", + "id": "autoscaling-execute-policy-1", + "title": "To execute an Auto Scaling policy" + } + ], + "ExitStandby": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ] + }, + "output": { + "Activities": [ + { + "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", + "Description": "Moving EC2 instance out of Standby: i-93633f9b", + "Details": "details", + "Progress": 30, + "StartTime": "2015-04-12T15:14:29.886Z", + "StatusCode": "PreInService" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example moves the specified instance out of standby mode.", + "id": "autoscaling-exit-standby-1", + "title": "To move instances out of standby mode" + } + ], + "PutLifecycleHook": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn", + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a lifecycle hook.", + "id": "autoscaling-put-lifecycle-hook-1", + "title": "To create a lifecycle hook" + } + ], + "PutNotificationConfiguration": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationTypes": [ + "autoscaling:TEST_NOTIFICATION" + ], + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified notification to the specified Auto Scaling group.", + "id": "autoscaling-put-notification-configuration-1", + "title": "To add an Auto Scaling notification" + } + ], + "PutScalingPolicy": [ + { + "input": { + "AdjustmentType": "ChangeInCapacity", + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "ScaleIn", + "ScalingAdjustment": -1 + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified policy to the specified Auto Scaling group.", + "id": "autoscaling-put-scaling-policy-1", + "title": "To add a scaling policy to an Auto Scaling group" + } + ], + "PutScheduledUpdateGroupAction": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 4, + "EndTime": "2014-05-12T08:00:00Z", + "MaxSize": 6, + "MinSize": 2, + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2014-05-12T08:00:00Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified scheduled action to the specified Auto Scaling group.", + "id": "autoscaling-put-scheduled-update-group-action-1", + "title": "To add a scheduled action to an Auto Scaling group" + } + ], + "RecordLifecycleActionHeartbeat": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", + "LifecycleHookName": "my-lifecycle-hook" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", + "id": "autoscaling-record-lifecycle-action-heartbeat-1", + "title": "To record a lifecycle action heartbeat" + } + ], + "ResumeProcesses": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", + "id": "autoscaling-resume-processes-1", + "title": "To resume Auto Scaling processes" + } + ], + "SetDesiredCapacity": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 2, + "HonorCooldown": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the desired capacity for the specified Auto Scaling group.", + "id": "autoscaling-set-desired-capacity-1", + "title": "To set the desired capacity for an Auto Scaling group" + } + ], + "SetInstanceHealth": [ + { + "input": { + "HealthStatus": "Unhealthy", + "InstanceId": "i-93633f9b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the health status of the specified instance to Unhealthy.", + "id": "autoscaling-set-instance-health-1", + "title": "To set the health status of an instance" + } + ], + "SetInstanceProtection": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ProtectedFromScaleIn": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables instance protection for the specified instance.", + "id": "autoscaling-set-instance-protection-1", + "title": "To enable instance protection for an instance" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ProtectedFromScaleIn": false + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables instance protection for the specified instance.", + "id": "autoscaling-set-instance-protection-2", + "title": "To disable instance protection for an instance" + } + ], + "SuspendProcesses": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example suspends the specified scaling process for the specified Auto Scaling group.", + "id": "autoscaling-suspend-processes-1", + "title": "To suspend Auto Scaling processes" + } + ], + "TerminateInstanceInAutoScalingGroup": [ + { + "input": { + "InstanceId": "i-93633f9b", + "ShouldDecrementDesiredCapacity": false + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.", + "id": "autoscaling-terminate-instance-in-auto-scaling-group-1", + "title": "To terminate an instance in an Auto Scaling group" + } + ], + "UpdateAutoScalingGroup": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchConfigurationName": "new-launch-config" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the launch configuration of the specified Auto Scaling group.", + "id": "autoscaling-update-auto-scaling-group-1", + "title": "To update the launch configuration" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "MaxSize": 3, + "MinSize": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the minimum size and maximum size of the specified Auto Scaling group.", + "id": "autoscaling-update-auto-scaling-group-2", + "title": "To update the minimum and maximum size" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "NewInstancesProtectedFromScaleIn": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables instance protection for the specified Auto Scaling group.", + "id": "autoscaling-update-auto-scaling-group-3", + "title": "To enable instance protection" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/autoscaling-2011-01-01.min.json b/node_modules/aws-sdk/apis/autoscaling-2011-01-01.min.json new file mode 100644 index 0000000..7705363 --- /dev/null +++ b/node_modules/aws-sdk/apis/autoscaling-2011-01-01.min.json @@ -0,0 +1,1856 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2011-01-01", + "endpointPrefix": "autoscaling", + "protocol": "query", + "serviceFullName": "Auto Scaling", + "serviceId": "Auto Scaling", + "signatureVersion": "v4", + "uid": "autoscaling-2011-01-01", + "xmlNamespace": "http://autoscaling.amazonaws.com/doc/2011-01-01/" + }, + "operations": { + "AttachInstances": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {} + } + } + }, + "AttachLoadBalancerTargetGroups": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "TargetGroupARNs" + ], + "members": { + "AutoScalingGroupName": {}, + "TargetGroupARNs": { + "shape": "S6" + } + } + }, + "output": { + "resultWrapper": "AttachLoadBalancerTargetGroupsResult", + "type": "structure", + "members": {} + } + }, + "AttachLoadBalancers": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "LoadBalancerNames" + ], + "members": { + "AutoScalingGroupName": {}, + "LoadBalancerNames": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "AttachLoadBalancersResult", + "type": "structure", + "members": {} + } + }, + "BatchDeleteScheduledAction": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ScheduledActionNames" + ], + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionNames": { + "shape": "Se" + } + } + }, + "output": { + "resultWrapper": "BatchDeleteScheduledActionResult", + "type": "structure", + "members": { + "FailedScheduledActions": { + "shape": "Sg" + } + } + } + }, + "BatchPutScheduledUpdateGroupAction": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ScheduledUpdateGroupActions" + ], + "members": { + "AutoScalingGroupName": {}, + "ScheduledUpdateGroupActions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScheduledActionName" + ], + "members": { + "ScheduledActionName": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Recurrence": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + } + } + } + } + } + }, + "output": { + "resultWrapper": "BatchPutScheduledUpdateGroupActionResult", + "type": "structure", + "members": { + "FailedScheduledUpdateGroupActions": { + "shape": "Sg" + } + } + } + }, + "CompleteLifecycleAction": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName", + "LifecycleActionResult" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleActionToken": {}, + "LifecycleActionResult": {}, + "InstanceId": {} + } + }, + "output": { + "resultWrapper": "CompleteLifecycleActionResult", + "type": "structure", + "members": {} + } + }, + "CreateAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "MinSize", + "MaxSize" + ], + "members": { + "AutoScalingGroupName": {}, + "LaunchConfigurationName": {}, + "LaunchTemplate": { + "shape": "Sy" + }, + "MixedInstancesPolicy": { + "shape": "S10" + }, + "InstanceId": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + }, + "DefaultCooldown": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "S1a" + }, + "LoadBalancerNames": { + "shape": "Sa" + }, + "TargetGroupARNs": { + "shape": "S6" + }, + "HealthCheckType": {}, + "HealthCheckGracePeriod": { + "type": "integer" + }, + "PlacementGroup": {}, + "VPCZoneIdentifier": {}, + "TerminationPolicies": { + "shape": "S1e" + }, + "NewInstancesProtectedFromScaleIn": { + "type": "boolean" + }, + "LifecycleHookSpecificationList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LifecycleHookName", + "LifecycleTransition" + ], + "members": { + "LifecycleHookName": {}, + "LifecycleTransition": {}, + "NotificationMetadata": {}, + "HeartbeatTimeout": { + "type": "integer" + }, + "DefaultResult": {}, + "NotificationTargetARN": {}, + "RoleARN": {} + } + } + }, + "Tags": { + "shape": "S1n" + }, + "ServiceLinkedRoleARN": {} + } + } + }, + "CreateLaunchConfiguration": { + "input": { + "type": "structure", + "required": [ + "LaunchConfigurationName" + ], + "members": { + "LaunchConfigurationName": {}, + "ImageId": {}, + "KeyName": {}, + "SecurityGroups": { + "shape": "S1t" + }, + "ClassicLinkVPCId": {}, + "ClassicLinkVPCSecurityGroups": { + "shape": "S1u" + }, + "UserData": {}, + "InstanceId": {}, + "InstanceType": {}, + "KernelId": {}, + "RamdiskId": {}, + "BlockDeviceMappings": { + "shape": "S1w" + }, + "InstanceMonitoring": { + "shape": "S25" + }, + "SpotPrice": {}, + "IamInstanceProfile": {}, + "EbsOptimized": { + "type": "boolean" + }, + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "PlacementTenancy": {} + } + } + }, + "CreateOrUpdateTags": { + "input": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S1n" + } + } + } + }, + "DeleteAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "ForceDelete": { + "type": "boolean" + } + } + } + }, + "DeleteLaunchConfiguration": { + "input": { + "type": "structure", + "required": [ + "LaunchConfigurationName" + ], + "members": { + "LaunchConfigurationName": {} + } + } + }, + "DeleteLifecycleHook": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {} + } + }, + "output": { + "resultWrapper": "DeleteLifecycleHookResult", + "type": "structure", + "members": {} + } + }, + "DeleteNotificationConfiguration": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "TopicARN" + ], + "members": { + "AutoScalingGroupName": {}, + "TopicARN": {} + } + } + }, + "DeletePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyName" + ], + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {} + } + } + }, + "DeleteScheduledAction": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ScheduledActionName" + ], + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionName": {} + } + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S1n" + } + } + } + }, + "DescribeAccountLimits": { + "output": { + "resultWrapper": "DescribeAccountLimitsResult", + "type": "structure", + "members": { + "MaxNumberOfAutoScalingGroups": { + "type": "integer" + }, + "MaxNumberOfLaunchConfigurations": { + "type": "integer" + }, + "NumberOfAutoScalingGroups": { + "type": "integer" + }, + "NumberOfLaunchConfigurations": { + "type": "integer" + } + } + } + }, + "DescribeAdjustmentTypes": { + "output": { + "resultWrapper": "DescribeAdjustmentTypesResult", + "type": "structure", + "members": { + "AdjustmentTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AdjustmentType": {} + } + } + } + } + } + }, + "DescribeAutoScalingGroups": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupNames": { + "shape": "S2t" + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeAutoScalingGroupsResult", + "type": "structure", + "required": [ + "AutoScalingGroups" + ], + "members": { + "AutoScalingGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "MinSize", + "MaxSize", + "DesiredCapacity", + "DefaultCooldown", + "AvailabilityZones", + "HealthCheckType", + "CreatedTime" + ], + "members": { + "AutoScalingGroupName": {}, + "AutoScalingGroupARN": {}, + "LaunchConfigurationName": {}, + "LaunchTemplate": { + "shape": "Sy" + }, + "MixedInstancesPolicy": { + "shape": "S10" + }, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + }, + "DefaultCooldown": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "S1a" + }, + "LoadBalancerNames": { + "shape": "Sa" + }, + "TargetGroupARNs": { + "shape": "S6" + }, + "HealthCheckType": {}, + "HealthCheckGracePeriod": { + "type": "integer" + }, + "Instances": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceId", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "ProtectedFromScaleIn" + ], + "members": { + "InstanceId": {}, + "AvailabilityZone": {}, + "LifecycleState": {}, + "HealthStatus": {}, + "LaunchConfigurationName": {}, + "LaunchTemplate": { + "shape": "Sy" + }, + "ProtectedFromScaleIn": { + "type": "boolean" + } + } + } + }, + "CreatedTime": { + "type": "timestamp" + }, + "SuspendedProcesses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProcessName": {}, + "SuspensionReason": {} + } + } + }, + "PlacementGroup": {}, + "VPCZoneIdentifier": {}, + "EnabledMetrics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Metric": {}, + "Granularity": {} + } + } + }, + "Status": {}, + "Tags": { + "shape": "S35" + }, + "TerminationPolicies": { + "shape": "S1e" + }, + "NewInstancesProtectedFromScaleIn": { + "type": "boolean" + }, + "ServiceLinkedRoleARN": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAutoScalingInstances": { + "input": { + "type": "structure", + "members": { + "InstanceIds": { + "shape": "S2" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeAutoScalingInstancesResult", + "type": "structure", + "members": { + "AutoScalingInstances": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceId", + "AutoScalingGroupName", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "ProtectedFromScaleIn" + ], + "members": { + "InstanceId": {}, + "AutoScalingGroupName": {}, + "AvailabilityZone": {}, + "LifecycleState": {}, + "HealthStatus": {}, + "LaunchConfigurationName": {}, + "LaunchTemplate": { + "shape": "Sy" + }, + "ProtectedFromScaleIn": { + "type": "boolean" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAutoScalingNotificationTypes": { + "output": { + "resultWrapper": "DescribeAutoScalingNotificationTypesResult", + "type": "structure", + "members": { + "AutoScalingNotificationTypes": { + "shape": "S3c" + } + } + } + }, + "DescribeLaunchConfigurations": { + "input": { + "type": "structure", + "members": { + "LaunchConfigurationNames": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeLaunchConfigurationsResult", + "type": "structure", + "required": [ + "LaunchConfigurations" + ], + "members": { + "LaunchConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LaunchConfigurationName", + "ImageId", + "InstanceType", + "CreatedTime" + ], + "members": { + "LaunchConfigurationName": {}, + "LaunchConfigurationARN": {}, + "ImageId": {}, + "KeyName": {}, + "SecurityGroups": { + "shape": "S1t" + }, + "ClassicLinkVPCId": {}, + "ClassicLinkVPCSecurityGroups": { + "shape": "S1u" + }, + "UserData": {}, + "InstanceType": {}, + "KernelId": {}, + "RamdiskId": {}, + "BlockDeviceMappings": { + "shape": "S1w" + }, + "InstanceMonitoring": { + "shape": "S25" + }, + "SpotPrice": {}, + "IamInstanceProfile": {}, + "CreatedTime": { + "type": "timestamp" + }, + "EbsOptimized": { + "type": "boolean" + }, + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "PlacementTenancy": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeLifecycleHookTypes": { + "output": { + "resultWrapper": "DescribeLifecycleHookTypesResult", + "type": "structure", + "members": { + "LifecycleHookTypes": { + "shape": "S3c" + } + } + } + }, + "DescribeLifecycleHooks": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "LifecycleHookNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeLifecycleHooksResult", + "type": "structure", + "members": { + "LifecycleHooks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleTransition": {}, + "NotificationTargetARN": {}, + "RoleARN": {}, + "NotificationMetadata": {}, + "HeartbeatTimeout": { + "type": "integer" + }, + "GlobalTimeout": { + "type": "integer" + }, + "DefaultResult": {} + } + } + } + } + } + }, + "DescribeLoadBalancerTargetGroups": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerTargetGroupsResult", + "type": "structure", + "members": { + "LoadBalancerTargetGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LoadBalancerTargetGroupARN": {}, + "State": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeLoadBalancers": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancersResult", + "type": "structure", + "members": { + "LoadBalancers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "State": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMetricCollectionTypes": { + "output": { + "resultWrapper": "DescribeMetricCollectionTypesResult", + "type": "structure", + "members": { + "Metrics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Metric": {} + } + } + }, + "Granularities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Granularity": {} + } + } + } + } + } + }, + "DescribeNotificationConfigurations": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupNames": { + "shape": "S2t" + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeNotificationConfigurationsResult", + "type": "structure", + "required": [ + "NotificationConfigurations" + ], + "members": { + "NotificationConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "TopicARN": {}, + "NotificationType": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribePolicies": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "PolicyNames": { + "type": "list", + "member": {} + }, + "PolicyTypes": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribePoliciesResult", + "type": "structure", + "members": { + "ScalingPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {}, + "PolicyARN": {}, + "PolicyType": {}, + "AdjustmentType": {}, + "MinAdjustmentStep": { + "shape": "S4c" + }, + "MinAdjustmentMagnitude": { + "type": "integer" + }, + "ScalingAdjustment": { + "type": "integer" + }, + "Cooldown": { + "type": "integer" + }, + "StepAdjustments": { + "shape": "S4f" + }, + "MetricAggregationType": {}, + "EstimatedInstanceWarmup": { + "type": "integer" + }, + "Alarms": { + "shape": "S4j" + }, + "TargetTrackingConfiguration": { + "shape": "S4l" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeScalingActivities": { + "input": { + "type": "structure", + "members": { + "ActivityIds": { + "type": "list", + "member": {} + }, + "AutoScalingGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeScalingActivitiesResult", + "type": "structure", + "required": [ + "Activities" + ], + "members": { + "Activities": { + "shape": "S51" + }, + "NextToken": {} + } + } + }, + "DescribeScalingProcessTypes": { + "output": { + "resultWrapper": "DescribeScalingProcessTypesResult", + "type": "structure", + "members": { + "Processes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ProcessName" + ], + "members": { + "ProcessName": {} + } + } + } + } + } + }, + "DescribeScheduledActions": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionNames": { + "shape": "Se" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeScheduledActionsResult", + "type": "structure", + "members": { + "ScheduledUpdateGroupActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionName": {}, + "ScheduledActionARN": {}, + "Time": { + "type": "timestamp" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Recurrence": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeTagsResult", + "type": "structure", + "members": { + "Tags": { + "shape": "S35" + }, + "NextToken": {} + } + } + }, + "DescribeTerminationPolicyTypes": { + "output": { + "resultWrapper": "DescribeTerminationPolicyTypesResult", + "type": "structure", + "members": { + "TerminationPolicyTypes": { + "shape": "S1e" + } + } + } + }, + "DetachInstances": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {}, + "ShouldDecrementDesiredCapacity": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DetachInstancesResult", + "type": "structure", + "members": { + "Activities": { + "shape": "S51" + } + } + } + }, + "DetachLoadBalancerTargetGroups": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "TargetGroupARNs" + ], + "members": { + "AutoScalingGroupName": {}, + "TargetGroupARNs": { + "shape": "S6" + } + } + }, + "output": { + "resultWrapper": "DetachLoadBalancerTargetGroupsResult", + "type": "structure", + "members": {} + } + }, + "DetachLoadBalancers": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "LoadBalancerNames" + ], + "members": { + "AutoScalingGroupName": {}, + "LoadBalancerNames": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "DetachLoadBalancersResult", + "type": "structure", + "members": {} + } + }, + "DisableMetricsCollection": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "Metrics": { + "shape": "S5q" + } + } + } + }, + "EnableMetricsCollection": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "Granularity" + ], + "members": { + "AutoScalingGroupName": {}, + "Metrics": { + "shape": "S5q" + }, + "Granularity": {} + } + } + }, + "EnterStandby": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {}, + "ShouldDecrementDesiredCapacity": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "EnterStandbyResult", + "type": "structure", + "members": { + "Activities": { + "shape": "S51" + } + } + } + }, + "ExecutePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyName" + ], + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {}, + "HonorCooldown": { + "type": "boolean" + }, + "MetricValue": { + "type": "double" + }, + "BreachThreshold": { + "type": "double" + } + } + } + }, + "ExitStandby": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {} + } + }, + "output": { + "resultWrapper": "ExitStandbyResult", + "type": "structure", + "members": { + "Activities": { + "shape": "S51" + } + } + } + }, + "PutLifecycleHook": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleTransition": {}, + "RoleARN": {}, + "NotificationTargetARN": {}, + "NotificationMetadata": {}, + "HeartbeatTimeout": { + "type": "integer" + }, + "DefaultResult": {} + } + }, + "output": { + "resultWrapper": "PutLifecycleHookResult", + "type": "structure", + "members": {} + } + }, + "PutNotificationConfiguration": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "TopicARN", + "NotificationTypes" + ], + "members": { + "AutoScalingGroupName": {}, + "TopicARN": {}, + "NotificationTypes": { + "shape": "S3c" + } + } + } + }, + "PutScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "PolicyName" + ], + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {}, + "PolicyType": {}, + "AdjustmentType": {}, + "MinAdjustmentStep": { + "shape": "S4c" + }, + "MinAdjustmentMagnitude": { + "type": "integer" + }, + "ScalingAdjustment": { + "type": "integer" + }, + "Cooldown": { + "type": "integer" + }, + "MetricAggregationType": {}, + "StepAdjustments": { + "shape": "S4f" + }, + "EstimatedInstanceWarmup": { + "type": "integer" + }, + "TargetTrackingConfiguration": { + "shape": "S4l" + } + } + }, + "output": { + "resultWrapper": "PutScalingPolicyResult", + "type": "structure", + "members": { + "PolicyARN": {}, + "Alarms": { + "shape": "S4j" + } + } + } + }, + "PutScheduledUpdateGroupAction": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ScheduledActionName" + ], + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionName": {}, + "Time": { + "type": "timestamp" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Recurrence": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + } + } + } + }, + "RecordLifecycleActionHeartbeat": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleActionToken": {}, + "InstanceId": {} + } + }, + "output": { + "resultWrapper": "RecordLifecycleActionHeartbeatResult", + "type": "structure", + "members": {} + } + }, + "ResumeProcesses": { + "input": { + "shape": "S66" + } + }, + "SetDesiredCapacity": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "DesiredCapacity" + ], + "members": { + "AutoScalingGroupName": {}, + "DesiredCapacity": { + "type": "integer" + }, + "HonorCooldown": { + "type": "boolean" + } + } + } + }, + "SetInstanceHealth": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "HealthStatus" + ], + "members": { + "InstanceId": {}, + "HealthStatus": {}, + "ShouldRespectGracePeriod": { + "type": "boolean" + } + } + } + }, + "SetInstanceProtection": { + "input": { + "type": "structure", + "required": [ + "InstanceIds", + "AutoScalingGroupName", + "ProtectedFromScaleIn" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {}, + "ProtectedFromScaleIn": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SetInstanceProtectionResult", + "type": "structure", + "members": {} + } + }, + "SuspendProcesses": { + "input": { + "shape": "S66" + } + }, + "TerminateInstanceInAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "ShouldDecrementDesiredCapacity" + ], + "members": { + "InstanceId": {}, + "ShouldDecrementDesiredCapacity": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "TerminateInstanceInAutoScalingGroupResult", + "type": "structure", + "members": { + "Activity": { + "shape": "S52" + } + } + } + }, + "UpdateAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "LaunchConfigurationName": {}, + "LaunchTemplate": { + "shape": "Sy" + }, + "MixedInstancesPolicy": { + "shape": "S10" + }, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + }, + "DefaultCooldown": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "S1a" + }, + "HealthCheckType": {}, + "HealthCheckGracePeriod": { + "type": "integer" + }, + "PlacementGroup": {}, + "VPCZoneIdentifier": {}, + "TerminationPolicies": { + "shape": "S1e" + }, + "NewInstancesProtectedFromScaleIn": { + "type": "boolean" + }, + "ServiceLinkedRoleARN": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "S6": { + "type": "list", + "member": {} + }, + "Sa": { + "type": "list", + "member": {} + }, + "Se": { + "type": "list", + "member": {} + }, + "Sg": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScheduledActionName" + ], + "members": { + "ScheduledActionName": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "Sy": { + "type": "structure", + "members": { + "LaunchTemplateId": {}, + "LaunchTemplateName": {}, + "Version": {} + } + }, + "S10": { + "type": "structure", + "members": { + "LaunchTemplate": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "shape": "Sy" + }, + "Overrides": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceType": {} + } + } + } + } + }, + "InstancesDistribution": { + "type": "structure", + "members": { + "OnDemandAllocationStrategy": {}, + "OnDemandBaseCapacity": { + "type": "integer" + }, + "OnDemandPercentageAboveBaseCapacity": { + "type": "integer" + }, + "SpotAllocationStrategy": {}, + "SpotInstancePools": { + "type": "integer" + }, + "SpotMaxPrice": {} + } + } + } + }, + "S1a": { + "type": "list", + "member": {} + }, + "S1e": { + "type": "list", + "member": {} + }, + "S1n": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "ResourceId": {}, + "ResourceType": {}, + "Key": {}, + "Value": {}, + "PropagateAtLaunch": { + "type": "boolean" + } + } + } + }, + "S1t": { + "type": "list", + "member": {} + }, + "S1u": { + "type": "list", + "member": {} + }, + "S1w": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DeviceName" + ], + "members": { + "VirtualName": {}, + "DeviceName": {}, + "Ebs": { + "type": "structure", + "members": { + "SnapshotId": {}, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": {}, + "DeleteOnTermination": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + }, + "NoDevice": { + "type": "boolean" + } + } + } + }, + "S25": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "S2t": { + "type": "list", + "member": {} + }, + "S35": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceId": {}, + "ResourceType": {}, + "Key": {}, + "Value": {}, + "PropagateAtLaunch": { + "type": "boolean" + } + } + } + }, + "S3c": { + "type": "list", + "member": {} + }, + "S4c": { + "type": "integer", + "deprecated": true + }, + "S4f": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScalingAdjustment" + ], + "members": { + "MetricIntervalLowerBound": { + "type": "double" + }, + "MetricIntervalUpperBound": { + "type": "double" + }, + "ScalingAdjustment": { + "type": "integer" + } + } + } + }, + "S4j": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AlarmName": {}, + "AlarmARN": {} + } + } + }, + "S4l": { + "type": "structure", + "required": [ + "TargetValue" + ], + "members": { + "PredefinedMetricSpecification": { + "type": "structure", + "required": [ + "PredefinedMetricType" + ], + "members": { + "PredefinedMetricType": {}, + "ResourceLabel": {} + } + }, + "CustomizedMetricSpecification": { + "type": "structure", + "required": [ + "MetricName", + "Namespace", + "Statistic" + ], + "members": { + "MetricName": {}, + "Namespace": {}, + "Dimensions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "Statistic": {}, + "Unit": {} + } + }, + "TargetValue": { + "type": "double" + }, + "DisableScaleIn": { + "type": "boolean" + } + } + }, + "S51": { + "type": "list", + "member": { + "shape": "S52" + } + }, + "S52": { + "type": "structure", + "required": [ + "ActivityId", + "AutoScalingGroupName", + "Cause", + "StartTime", + "StatusCode" + ], + "members": { + "ActivityId": {}, + "AutoScalingGroupName": {}, + "Description": {}, + "Cause": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "StatusCode": {}, + "StatusMessage": {}, + "Progress": { + "type": "integer" + }, + "Details": {} + } + }, + "S5q": { + "type": "list", + "member": {} + }, + "S66": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "ScalingProcesses": { + "type": "list", + "member": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/autoscaling-2011-01-01.paginators.json b/node_modules/aws-sdk/apis/autoscaling-2011-01-01.paginators.json new file mode 100644 index 0000000..1b83859 --- /dev/null +++ b/node_modules/aws-sdk/apis/autoscaling-2011-01-01.paginators.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "DescribeAutoScalingGroups": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "AutoScalingGroups" + }, + "DescribeAutoScalingInstances": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "AutoScalingInstances" + }, + "DescribeLaunchConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "LaunchConfigurations" + }, + "DescribeNotificationConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "NotificationConfigurations" + }, + "DescribePolicies": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "ScalingPolicies" + }, + "DescribeScalingActivities": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "Activities" + }, + "DescribeScheduledActions": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "ScheduledUpdateGroupActions" + }, + "DescribeTags": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.examples.json b/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.min.json b/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.min.json new file mode 100644 index 0000000..9b03ad2 --- /dev/null +++ b/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.min.json @@ -0,0 +1,429 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-01-06", + "endpointPrefix": "autoscaling", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Auto Scaling Plans", + "serviceId": "Auto Scaling Plans", + "signatureVersion": "v4", + "signingName": "autoscaling-plans", + "targetPrefix": "AnyScaleScalingPlannerFrontendService", + "uid": "autoscaling-plans-2018-01-06" + }, + "operations": { + "CreateScalingPlan": { + "input": { + "type": "structure", + "required": [ + "ScalingPlanName", + "ApplicationSource", + "ScalingInstructions" + ], + "members": { + "ScalingPlanName": {}, + "ApplicationSource": { + "shape": "S3" + }, + "ScalingInstructions": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ScalingPlanVersion" + ], + "members": { + "ScalingPlanVersion": { + "type": "long" + } + } + } + }, + "DeleteScalingPlan": { + "input": { + "type": "structure", + "required": [ + "ScalingPlanName", + "ScalingPlanVersion" + ], + "members": { + "ScalingPlanName": {}, + "ScalingPlanVersion": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeScalingPlanResources": { + "input": { + "type": "structure", + "required": [ + "ScalingPlanName", + "ScalingPlanVersion" + ], + "members": { + "ScalingPlanName": {}, + "ScalingPlanVersion": { + "type": "long" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScalingPlanResources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScalingPlanName", + "ScalingPlanVersion", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "ScalingStatusCode" + ], + "members": { + "ScalingPlanName": {}, + "ScalingPlanVersion": { + "type": "long" + }, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "ScalingPolicies": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "PolicyName", + "PolicyType" + ], + "members": { + "PolicyName": {}, + "PolicyType": {}, + "TargetTrackingConfiguration": { + "shape": "Sh" + } + } + } + }, + "ScalingStatusCode": {}, + "ScalingStatusMessage": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeScalingPlans": { + "input": { + "type": "structure", + "members": { + "ScalingPlanNames": { + "type": "list", + "member": {} + }, + "ScalingPlanVersion": { + "type": "long" + }, + "ApplicationSources": { + "type": "list", + "member": { + "shape": "S3" + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScalingPlans": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScalingPlanName", + "ScalingPlanVersion", + "ApplicationSource", + "ScalingInstructions", + "StatusCode" + ], + "members": { + "ScalingPlanName": {}, + "ScalingPlanVersion": { + "type": "long" + }, + "ApplicationSource": { + "shape": "S3" + }, + "ScalingInstructions": { + "shape": "Sa" + }, + "StatusCode": {}, + "StatusMessage": {}, + "StatusStartTime": { + "type": "timestamp" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "GetScalingPlanResourceForecastData": { + "input": { + "type": "structure", + "required": [ + "ScalingPlanName", + "ScalingPlanVersion", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "ForecastDataType", + "StartTime", + "EndTime" + ], + "members": { + "ScalingPlanName": {}, + "ScalingPlanVersion": { + "type": "long" + }, + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "ForecastDataType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Datapoints" + ], + "members": { + "Datapoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "timestamp" + }, + "Value": { + "type": "double" + } + } + } + } + } + } + }, + "UpdateScalingPlan": { + "input": { + "type": "structure", + "required": [ + "ScalingPlanName", + "ScalingPlanVersion" + ], + "members": { + "ScalingPlanName": {}, + "ScalingPlanVersion": { + "type": "long" + }, + "ApplicationSource": { + "shape": "S3" + }, + "ScalingInstructions": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "members": { + "CloudFormationStackARN": {}, + "TagFilters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "Sa": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "MinCapacity", + "MaxCapacity", + "TargetTrackingConfigurations" + ], + "members": { + "ServiceNamespace": {}, + "ResourceId": {}, + "ScalableDimension": {}, + "MinCapacity": { + "type": "integer" + }, + "MaxCapacity": { + "type": "integer" + }, + "TargetTrackingConfigurations": { + "type": "list", + "member": { + "shape": "Sh" + } + }, + "PredefinedLoadMetricSpecification": { + "type": "structure", + "required": [ + "PredefinedLoadMetricType" + ], + "members": { + "PredefinedLoadMetricType": {}, + "ResourceLabel": {} + } + }, + "CustomizedLoadMetricSpecification": { + "type": "structure", + "required": [ + "MetricName", + "Namespace", + "Statistic" + ], + "members": { + "MetricName": {}, + "Namespace": {}, + "Dimensions": { + "shape": "So" + }, + "Statistic": {}, + "Unit": {} + } + }, + "ScheduledActionBufferTime": { + "type": "integer" + }, + "PredictiveScalingMaxCapacityBehavior": {}, + "PredictiveScalingMaxCapacityBuffer": { + "type": "integer" + }, + "PredictiveScalingMode": {}, + "ScalingPolicyUpdateBehavior": {}, + "DisableDynamicScaling": { + "type": "boolean" + } + } + } + }, + "Sh": { + "type": "structure", + "required": [ + "TargetValue" + ], + "members": { + "PredefinedScalingMetricSpecification": { + "type": "structure", + "required": [ + "PredefinedScalingMetricType" + ], + "members": { + "PredefinedScalingMetricType": {}, + "ResourceLabel": {} + } + }, + "CustomizedScalingMetricSpecification": { + "type": "structure", + "required": [ + "MetricName", + "Namespace", + "Statistic" + ], + "members": { + "MetricName": {}, + "Namespace": {}, + "Dimensions": { + "shape": "So" + }, + "Statistic": {}, + "Unit": {} + } + }, + "TargetValue": { + "type": "double" + }, + "DisableScaleIn": { + "type": "boolean" + }, + "ScaleOutCooldown": { + "type": "integer" + }, + "ScaleInCooldown": { + "type": "integer" + }, + "EstimatedInstanceWarmup": { + "type": "integer" + } + } + }, + "So": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.paginators.json b/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/autoscaling-plans-2018-01-06.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/backup-2018-11-15.examples.json b/node_modules/aws-sdk/apis/backup-2018-11-15.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/backup-2018-11-15.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/backup-2018-11-15.min.json b/node_modules/aws-sdk/apis/backup-2018-11-15.min.json new file mode 100644 index 0000000..f4d618e --- /dev/null +++ b/node_modules/aws-sdk/apis/backup-2018-11-15.min.json @@ -0,0 +1,1737 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-11-15", + "endpointPrefix": "backup", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS Backup", + "serviceId": "Backup", + "signatureVersion": "v4", + "uid": "backup-2018-11-15" + }, + "operations": { + "CreateBackupPlan": { + "http": { + "method": "PUT", + "requestUri": "/backup/plans/" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlan" + ], + "members": { + "BackupPlan": { + "shape": "S2" + }, + "BackupPlanTags": { + "shape": "Sc" + }, + "CreatorRequestId": {} + } + }, + "output": { + "type": "structure", + "members": { + "BackupPlanId": {}, + "BackupPlanArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "VersionId": {} + } + }, + "idempotent": true + }, + "CreateBackupSelection": { + "http": { + "method": "PUT", + "requestUri": "/backup/plans/{backupPlanId}/selections/" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId", + "BackupSelection" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + }, + "BackupSelection": { + "shape": "Sk" + }, + "CreatorRequestId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SelectionId": {}, + "BackupPlanId": {}, + "CreationDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "CreateBackupVault": { + "http": { + "method": "PUT", + "requestUri": "/backup-vaults/{backupVaultName}" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "BackupVaultTags": { + "shape": "Sc" + }, + "EncryptionKeyArn": {}, + "CreatorRequestId": {} + } + }, + "output": { + "type": "structure", + "members": { + "BackupVaultName": {}, + "BackupVaultArn": {}, + "CreationDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DeleteBackupPlan": { + "http": { + "method": "DELETE", + "requestUri": "/backup/plans/{backupPlanId}" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupPlanId": {}, + "BackupPlanArn": {}, + "DeletionDate": { + "type": "timestamp" + }, + "VersionId": {} + } + } + }, + "DeleteBackupSelection": { + "http": { + "method": "DELETE", + "requestUri": "/backup/plans/{backupPlanId}/selections/{selectionId}" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId", + "SelectionId" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + }, + "SelectionId": { + "location": "uri", + "locationName": "selectionId" + } + } + } + }, + "DeleteBackupVault": { + "http": { + "method": "DELETE", + "requestUri": "/backup-vaults/{backupVaultName}" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + } + } + } + }, + "DeleteBackupVaultAccessPolicy": { + "http": { + "method": "DELETE", + "requestUri": "/backup-vaults/{backupVaultName}/access-policy" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + } + } + }, + "idempotent": true + }, + "DeleteBackupVaultNotifications": { + "http": { + "method": "DELETE", + "requestUri": "/backup-vaults/{backupVaultName}/notification-configuration" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + } + } + }, + "idempotent": true + }, + "DeleteRecoveryPoint": { + "http": { + "method": "DELETE", + "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName", + "RecoveryPointArn" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "RecoveryPointArn": { + "location": "uri", + "locationName": "recoveryPointArn" + } + } + }, + "idempotent": true + }, + "DescribeBackupJob": { + "http": { + "method": "GET", + "requestUri": "/backup-jobs/{backupJobId}" + }, + "input": { + "type": "structure", + "required": [ + "BackupJobId" + ], + "members": { + "BackupJobId": { + "location": "uri", + "locationName": "backupJobId" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupJobId": {}, + "BackupVaultName": {}, + "BackupVaultArn": {}, + "RecoveryPointArn": {}, + "ResourceArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "CompletionDate": { + "type": "timestamp" + }, + "State": {}, + "StatusMessage": {}, + "PercentDone": {}, + "BackupSizeInBytes": { + "type": "long" + }, + "IamRoleArn": {}, + "CreatedBy": { + "shape": "S16" + }, + "ResourceType": {}, + "BytesTransferred": { + "type": "long" + }, + "ExpectedCompletionDate": { + "type": "timestamp" + }, + "StartBy": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DescribeBackupVault": { + "http": { + "method": "GET", + "requestUri": "/backup-vaults/{backupVaultName}" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupVaultName": {}, + "BackupVaultArn": {}, + "EncryptionKeyArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "CreatorRequestId": {}, + "NumberOfRecoveryPoints": { + "type": "long" + } + } + }, + "idempotent": true + }, + "DescribeProtectedResource": { + "http": { + "method": "GET", + "requestUri": "/resources/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceArn": {}, + "ResourceType": {}, + "LastBackupTime": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DescribeRecoveryPoint": { + "http": { + "method": "GET", + "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName", + "RecoveryPointArn" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "RecoveryPointArn": { + "location": "uri", + "locationName": "recoveryPointArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "RecoveryPointArn": {}, + "BackupVaultName": {}, + "BackupVaultArn": {}, + "ResourceArn": {}, + "ResourceType": {}, + "CreatedBy": { + "shape": "S16" + }, + "IamRoleArn": {}, + "Status": {}, + "CreationDate": { + "type": "timestamp" + }, + "CompletionDate": { + "type": "timestamp" + }, + "BackupSizeInBytes": { + "type": "long" + }, + "CalculatedLifecycle": { + "shape": "S1g" + }, + "Lifecycle": { + "shape": "Sa" + }, + "EncryptionKeyArn": {}, + "IsEncrypted": { + "type": "boolean" + }, + "StorageClass": {}, + "LastRestoreTime": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DescribeRestoreJob": { + "http": { + "method": "GET", + "requestUri": "/restore-jobs/{restoreJobId}" + }, + "input": { + "type": "structure", + "required": [ + "RestoreJobId" + ], + "members": { + "RestoreJobId": { + "location": "uri", + "locationName": "restoreJobId" + } + } + }, + "output": { + "type": "structure", + "members": { + "RestoreJobId": {}, + "RecoveryPointArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "CompletionDate": { + "type": "timestamp" + }, + "Status": {}, + "StatusMessage": {}, + "PercentDone": {}, + "BackupSizeInBytes": { + "type": "long" + }, + "IamRoleArn": {}, + "ExpectedCompletionTimeMinutes": { + "type": "long" + }, + "CreatedResourceArn": {} + } + }, + "idempotent": true + }, + "ExportBackupPlanTemplate": { + "http": { + "method": "GET", + "requestUri": "/backup/plans/{backupPlanId}/toTemplate/" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupPlanTemplateJson": {} + } + } + }, + "GetBackupPlan": { + "http": { + "method": "GET", + "requestUri": "/backup/plans/{backupPlanId}/" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupPlan": { + "shape": "S1r" + }, + "BackupPlanId": {}, + "BackupPlanArn": {}, + "VersionId": {}, + "CreatorRequestId": {}, + "CreationDate": { + "type": "timestamp" + }, + "DeletionDate": { + "type": "timestamp" + }, + "LastExecutionDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "GetBackupPlanFromJSON": { + "http": { + "requestUri": "/backup/template/json/toPlan" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanTemplateJson" + ], + "members": { + "BackupPlanTemplateJson": {} + } + }, + "output": { + "type": "structure", + "members": { + "BackupPlan": { + "shape": "S1r" + } + } + } + }, + "GetBackupPlanFromTemplate": { + "http": { + "method": "GET", + "requestUri": "/backup/template/plans/{templateId}/toPlan" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanTemplateId" + ], + "members": { + "BackupPlanTemplateId": { + "location": "uri", + "locationName": "templateId" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupPlanDocument": { + "shape": "S1r" + } + } + } + }, + "GetBackupSelection": { + "http": { + "method": "GET", + "requestUri": "/backup/plans/{backupPlanId}/selections/{selectionId}" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId", + "SelectionId" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + }, + "SelectionId": { + "location": "uri", + "locationName": "selectionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupSelection": { + "shape": "Sk" + }, + "SelectionId": {}, + "BackupPlanId": {}, + "CreationDate": { + "type": "timestamp" + }, + "CreatorRequestId": {} + } + }, + "idempotent": true + }, + "GetBackupVaultAccessPolicy": { + "http": { + "method": "GET", + "requestUri": "/backup-vaults/{backupVaultName}/access-policy" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupVaultName": {}, + "BackupVaultArn": {}, + "Policy": {} + } + }, + "idempotent": true + }, + "GetBackupVaultNotifications": { + "http": { + "method": "GET", + "requestUri": "/backup-vaults/{backupVaultName}/notification-configuration" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupVaultName": {}, + "BackupVaultArn": {}, + "SNSTopicArn": {}, + "BackupVaultEvents": { + "shape": "S25" + } + } + }, + "idempotent": true + }, + "GetRecoveryPointRestoreMetadata": { + "http": { + "method": "GET", + "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/restore-metadata" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName", + "RecoveryPointArn" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "RecoveryPointArn": { + "location": "uri", + "locationName": "recoveryPointArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupVaultArn": {}, + "RecoveryPointArn": {}, + "RestoreMetadata": { + "shape": "S29" + } + } + }, + "idempotent": true + }, + "GetSupportedResourceTypes": { + "http": { + "method": "GET", + "requestUri": "/supported-resource-types" + }, + "output": { + "type": "structure", + "members": { + "ResourceTypes": { + "type": "list", + "member": {} + } + } + } + }, + "ListBackupJobs": { + "http": { + "method": "GET", + "requestUri": "/backup-jobs/" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "ByResourceArn": { + "location": "querystring", + "locationName": "resourceArn" + }, + "ByState": { + "location": "querystring", + "locationName": "state" + }, + "ByBackupVaultName": { + "location": "querystring", + "locationName": "backupVaultName" + }, + "ByCreatedBefore": { + "location": "querystring", + "locationName": "createdBefore", + "type": "timestamp" + }, + "ByCreatedAfter": { + "location": "querystring", + "locationName": "createdAfter", + "type": "timestamp" + }, + "ByResourceType": { + "location": "querystring", + "locationName": "resourceType" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupJobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BackupJobId": {}, + "BackupVaultName": {}, + "BackupVaultArn": {}, + "RecoveryPointArn": {}, + "ResourceArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "CompletionDate": { + "type": "timestamp" + }, + "State": {}, + "StatusMessage": {}, + "PercentDone": {}, + "BackupSizeInBytes": { + "type": "long" + }, + "IamRoleArn": {}, + "CreatedBy": { + "shape": "S16" + }, + "ExpectedCompletionDate": { + "type": "timestamp" + }, + "StartBy": { + "type": "timestamp" + }, + "ResourceType": {}, + "BytesTransferred": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListBackupPlanTemplates": { + "http": { + "method": "GET", + "requestUri": "/backup/template/plans" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "BackupPlanTemplatesList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BackupPlanTemplateId": {}, + "BackupPlanTemplateName": {} + } + } + } + } + } + }, + "ListBackupPlanVersions": { + "http": { + "method": "GET", + "requestUri": "/backup/plans/{backupPlanId}/versions/" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "BackupPlanVersionsList": { + "type": "list", + "member": { + "shape": "S2q" + } + } + } + }, + "idempotent": true + }, + "ListBackupPlans": { + "http": { + "method": "GET", + "requestUri": "/backup/plans/" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "IncludeDeleted": { + "location": "querystring", + "locationName": "includeDeleted", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "BackupPlansList": { + "type": "list", + "member": { + "shape": "S2q" + } + } + } + }, + "idempotent": true + }, + "ListBackupSelections": { + "http": { + "method": "GET", + "requestUri": "/backup/plans/{backupPlanId}/selections/" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "BackupSelectionsList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SelectionId": {}, + "SelectionName": {}, + "BackupPlanId": {}, + "CreationDate": { + "type": "timestamp" + }, + "CreatorRequestId": {}, + "IamRoleArn": {} + } + } + } + } + }, + "idempotent": true + }, + "ListBackupVaults": { + "http": { + "method": "GET", + "requestUri": "/backup-vaults/" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupVaultList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BackupVaultName": {}, + "BackupVaultArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "EncryptionKeyArn": {}, + "CreatorRequestId": {}, + "NumberOfRecoveryPoints": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListProtectedResources": { + "http": { + "method": "GET", + "requestUri": "/resources/" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceArn": {}, + "ResourceType": {}, + "LastBackupTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListRecoveryPointsByBackupVault": { + "http": { + "method": "GET", + "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "ByResourceArn": { + "location": "querystring", + "locationName": "resourceArn" + }, + "ByResourceType": { + "location": "querystring", + "locationName": "resourceType" + }, + "ByBackupPlanId": { + "location": "querystring", + "locationName": "backupPlanId" + }, + "ByCreatedBefore": { + "location": "querystring", + "locationName": "createdBefore", + "type": "timestamp" + }, + "ByCreatedAfter": { + "location": "querystring", + "locationName": "createdAfter", + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "RecoveryPoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RecoveryPointArn": {}, + "BackupVaultName": {}, + "BackupVaultArn": {}, + "ResourceArn": {}, + "ResourceType": {}, + "CreatedBy": { + "shape": "S16" + }, + "IamRoleArn": {}, + "Status": {}, + "CreationDate": { + "type": "timestamp" + }, + "CompletionDate": { + "type": "timestamp" + }, + "BackupSizeInBytes": { + "type": "long" + }, + "CalculatedLifecycle": { + "shape": "S1g" + }, + "Lifecycle": { + "shape": "Sa" + }, + "EncryptionKeyArn": {}, + "IsEncrypted": { + "type": "boolean" + }, + "LastRestoreTime": { + "type": "timestamp" + } + } + } + } + } + }, + "idempotent": true + }, + "ListRecoveryPointsByResource": { + "http": { + "method": "GET", + "requestUri": "/resources/{resourceArn}/recovery-points/" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "RecoveryPoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RecoveryPointArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "Status": {}, + "EncryptionKeyArn": {}, + "BackupSizeBytes": { + "type": "long" + }, + "BackupVaultName": {} + } + } + } + } + }, + "idempotent": true + }, + "ListRestoreJobs": { + "http": { + "method": "GET", + "requestUri": "/restore-jobs/" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "RestoreJobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RestoreJobId": {}, + "RecoveryPointArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "CompletionDate": { + "type": "timestamp" + }, + "Status": {}, + "StatusMessage": {}, + "PercentDone": {}, + "BackupSizeInBytes": { + "type": "long" + }, + "IamRoleArn": {}, + "ExpectedCompletionTimeMinutes": { + "type": "long" + }, + "CreatedResourceArn": {} + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListTags": { + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}/" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "idempotent": true + }, + "PutBackupVaultAccessPolicy": { + "http": { + "method": "PUT", + "requestUri": "/backup-vaults/{backupVaultName}/access-policy" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "Policy": {} + } + }, + "idempotent": true + }, + "PutBackupVaultNotifications": { + "http": { + "method": "PUT", + "requestUri": "/backup-vaults/{backupVaultName}/notification-configuration" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName", + "SNSTopicArn", + "BackupVaultEvents" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "SNSTopicArn": {}, + "BackupVaultEvents": { + "shape": "S25" + } + } + }, + "idempotent": true + }, + "StartBackupJob": { + "http": { + "method": "PUT", + "requestUri": "/backup-jobs" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName", + "ResourceArn", + "IamRoleArn" + ], + "members": { + "BackupVaultName": {}, + "ResourceArn": {}, + "IamRoleArn": {}, + "IdempotencyToken": {}, + "StartWindowMinutes": { + "type": "long" + }, + "CompleteWindowMinutes": { + "type": "long" + }, + "Lifecycle": { + "shape": "Sa" + }, + "RecoveryPointTags": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupJobId": {}, + "RecoveryPointArn": {}, + "CreationDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "StartRestoreJob": { + "http": { + "method": "PUT", + "requestUri": "/restore-jobs" + }, + "input": { + "type": "structure", + "required": [ + "RecoveryPointArn", + "Metadata", + "IamRoleArn" + ], + "members": { + "RecoveryPointArn": {}, + "Metadata": { + "shape": "S29" + }, + "IamRoleArn": {}, + "IdempotencyToken": {}, + "ResourceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "RestoreJobId": {} + } + }, + "idempotent": true + }, + "StopBackupJob": { + "http": { + "requestUri": "/backup-jobs/{backupJobId}" + }, + "input": { + "type": "structure", + "required": [ + "BackupJobId" + ], + "members": { + "BackupJobId": { + "location": "uri", + "locationName": "backupJobId" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "Tags": { + "shape": "Sc" + } + } + }, + "idempotent": true + }, + "UntagResource": { + "http": { + "requestUri": "/untag/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeyList" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "TagKeyList": { + "type": "list", + "member": {}, + "sensitive": true + } + } + }, + "idempotent": true + }, + "UpdateBackupPlan": { + "http": { + "requestUri": "/backup/plans/{backupPlanId}" + }, + "input": { + "type": "structure", + "required": [ + "BackupPlanId", + "BackupPlan" + ], + "members": { + "BackupPlanId": { + "location": "uri", + "locationName": "backupPlanId" + }, + "BackupPlan": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupPlanId": {}, + "BackupPlanArn": {}, + "CreationDate": { + "type": "timestamp" + }, + "VersionId": {} + } + }, + "idempotent": true + }, + "UpdateRecoveryPointLifecycle": { + "http": { + "requestUri": "/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" + }, + "input": { + "type": "structure", + "required": [ + "BackupVaultName", + "RecoveryPointArn" + ], + "members": { + "BackupVaultName": { + "location": "uri", + "locationName": "backupVaultName" + }, + "RecoveryPointArn": { + "location": "uri", + "locationName": "recoveryPointArn" + }, + "Lifecycle": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupVaultArn": {}, + "RecoveryPointArn": {}, + "Lifecycle": { + "shape": "Sa" + }, + "CalculatedLifecycle": { + "shape": "S1g" + } + } + }, + "idempotent": true + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "BackupPlanName", + "Rules" + ], + "members": { + "BackupPlanName": {}, + "Rules": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleName", + "TargetBackupVaultName" + ], + "members": { + "RuleName": {}, + "TargetBackupVaultName": {}, + "ScheduleExpression": {}, + "StartWindowMinutes": { + "type": "long" + }, + "CompletionWindowMinutes": { + "type": "long" + }, + "Lifecycle": { + "shape": "Sa" + }, + "RecoveryPointTags": { + "shape": "Sc" + } + } + } + } + } + }, + "Sa": { + "type": "structure", + "members": { + "MoveToColdStorageAfterDays": { + "type": "long" + }, + "DeleteAfterDays": { + "type": "long" + } + } + }, + "Sc": { + "type": "map", + "key": {}, + "value": {}, + "sensitive": true + }, + "Sk": { + "type": "structure", + "required": [ + "SelectionName", + "IamRoleArn" + ], + "members": { + "SelectionName": {}, + "IamRoleArn": {}, + "Resources": { + "type": "list", + "member": {} + }, + "ListOfTags": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ConditionType", + "ConditionKey", + "ConditionValue" + ], + "members": { + "ConditionType": {}, + "ConditionKey": {}, + "ConditionValue": {} + } + } + } + } + }, + "S16": { + "type": "structure", + "members": { + "BackupPlanId": {}, + "BackupPlanArn": {}, + "BackupPlanVersion": {}, + "BackupRuleId": {} + } + }, + "S1g": { + "type": "structure", + "members": { + "MoveToColdStorageAt": { + "type": "timestamp" + }, + "DeleteAt": { + "type": "timestamp" + } + } + }, + "S1r": { + "type": "structure", + "required": [ + "BackupPlanName", + "Rules" + ], + "members": { + "BackupPlanName": {}, + "Rules": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleName", + "TargetBackupVaultName" + ], + "members": { + "RuleName": {}, + "TargetBackupVaultName": {}, + "ScheduleExpression": {}, + "StartWindowMinutes": { + "type": "long" + }, + "CompletionWindowMinutes": { + "type": "long" + }, + "Lifecycle": { + "shape": "Sa" + }, + "RecoveryPointTags": { + "shape": "Sc" + }, + "RuleId": {} + } + } + } + } + }, + "S25": { + "type": "list", + "member": {} + }, + "S29": { + "type": "map", + "key": {}, + "value": {} + }, + "S2q": { + "type": "structure", + "members": { + "BackupPlanArn": {}, + "BackupPlanId": {}, + "CreationDate": { + "type": "timestamp" + }, + "DeletionDate": { + "type": "timestamp" + }, + "VersionId": {}, + "BackupPlanName": {}, + "CreatorRequestId": {}, + "LastExecutionDate": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json b/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json new file mode 100644 index 0000000..0df1875 --- /dev/null +++ b/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json @@ -0,0 +1,59 @@ +{ + "pagination": { + "ListBackupJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBackupPlanTemplates": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBackupPlanVersions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBackupPlans": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBackupSelections": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBackupVaults": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListProtectedResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListRecoveryPointsByBackupVault": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListRecoveryPointsByResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListRestoreJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/batch-2016-08-10.examples.json b/node_modules/aws-sdk/apis/batch-2016-08-10.examples.json new file mode 100644 index 0000000..68001e3 --- /dev/null +++ b/node_modules/aws-sdk/apis/batch-2016-08-10.examples.json @@ -0,0 +1,589 @@ +{ + "version": "1.0", + "examples": { + "CancelJob": [ + { + "input": { + "jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4", + "reason": "Cancelling job." + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels a job with the specified job ID.", + "id": "to-cancel-a-job-1481152314733", + "title": "To cancel a job" + } + ], + "CreateComputeEnvironment": [ + { + "input": { + "type": "MANAGED", + "computeEnvironmentName": "C4OnDemand", + "computeResources": { + "type": "EC2", + "desiredvCpus": 48, + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "instanceTypes": [ + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge" + ], + "maxvCpus": 128, + "minvCpus": 0, + "securityGroupIds": [ + "sg-cf5093b2" + ], + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - C4OnDemand" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "state": "ENABLED" + }, + "output": { + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", + "computeEnvironmentName": "C4OnDemand" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.", + "id": "to-create-a-managed-ec2-compute-environment-1481152600017", + "title": "To create a managed EC2 compute environment" + }, + { + "input": { + "type": "MANAGED", + "computeEnvironmentName": "M4Spot", + "computeResources": { + "type": "SPOT", + "bidPercentage": 20, + "desiredvCpus": 4, + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "instanceTypes": [ + "m4" + ], + "maxvCpus": 128, + "minvCpus": 0, + "securityGroupIds": [ + "sg-cf5093b2" + ], + "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - M4Spot" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "state": "ENABLED" + }, + "output": { + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot", + "computeEnvironmentName": "M4Spot" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.", + "id": "to-create-a-managed-ec2-spot-compute-environment-1481152844190", + "title": "To create a managed EC2 Spot compute environment" + } + ], + "CreateJobQueue": [ + { + "input": { + "computeEnvironmentOrder": [ + { + "computeEnvironment": "M4Spot", + "order": 1 + } + ], + "jobQueueName": "LowPriority", + "priority": 1, + "state": "ENABLED" + }, + "output": { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", + "jobQueueName": "LowPriority" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a job queue called LowPriority that uses the M4Spot compute environment.", + "id": "to-create-a-job-queue-with-a-single-compute-environment-1481152967946", + "title": "To create a job queue with a single compute environment" + }, + { + "input": { + "computeEnvironmentOrder": [ + { + "computeEnvironment": "C4OnDemand", + "order": 1 + }, + { + "computeEnvironment": "M4Spot", + "order": 2 + } + ], + "jobQueueName": "HighPriority", + "priority": 10, + "state": "ENABLED" + }, + "output": { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobQueueName": "HighPriority" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.", + "id": "to-create-a-job-queue-with-multiple-compute-environments-1481153027051", + "title": "To create a job queue with multiple compute environments" + } + ], + "DeleteComputeEnvironment": [ + { + "input": { + "computeEnvironment": "P2OnDemand" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the P2OnDemand compute environment.", + "id": "to-delete-a-compute-environment-1481153105644", + "title": "To delete a compute environment" + } + ], + "DeleteJobQueue": [ + { + "input": { + "jobQueue": "GPGPU" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the GPGPU job queue.", + "id": "to-delete-a-job-queue-1481153508134", + "title": "To delete a job queue" + } + ], + "DeregisterJobDefinition": [ + { + "input": { + "jobDefinition": "sleep10" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters a job definition called sleep10.", + "id": "to-deregister-a-job-definition-1481153579565", + "title": "To deregister a job definition" + } + ], + "DescribeComputeEnvironments": [ + { + "input": { + "computeEnvironments": [ + "P2OnDemand" + ] + }, + "output": { + "computeEnvironments": [ + { + "type": "MANAGED", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", + "computeEnvironmentName": "P2OnDemand", + "computeResources": { + "type": "EC2", + "desiredvCpus": 48, + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "instanceTypes": [ + "p2" + ], + "maxvCpus": 128, + "minvCpus": 0, + "securityGroupIds": [ + "sg-cf5093b2" + ], + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - P2OnDemand" + } + }, + "ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc", + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "state": "ENABLED", + "status": "VALID", + "statusReason": "ComputeEnvironment Healthy" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the P2OnDemand compute environment.", + "id": "to-describe-a-compute-environment-1481153713334", + "title": "To describe a compute environment" + } + ], + "DescribeJobDefinitions": [ + { + "input": { + "status": "ACTIVE" + }, + "output": { + "jobDefinitions": [ + { + "type": "container", + "containerProperties": { + "command": [ + "sleep", + "60" + ], + "environment": [ + + ], + "image": "busybox", + "memory": 128, + "mountPoints": [ + + ], + "ulimits": [ + + ], + "vcpus": 1, + "volumes": [ + + ] + }, + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", + "jobDefinitionName": "sleep60", + "revision": 1, + "status": "ACTIVE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your active job definitions.", + "id": "to-describe-active-job-definitions-1481153895831", + "title": "To describe active job definitions" + } + ], + "DescribeJobQueues": [ + { + "input": { + "jobQueues": [ + "HighPriority" + ] + }, + "output": { + "jobQueues": [ + { + "computeEnvironmentOrder": [ + { + "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", + "order": 1 + } + ], + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobQueueName": "HighPriority", + "priority": 1, + "state": "ENABLED", + "status": "VALID", + "statusReason": "JobQueue Healthy" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the HighPriority job queue.", + "id": "to-describe-a-job-queue-1481153995804", + "title": "To describe a job queue" + } + ], + "DescribeJobs": [ + { + "input": { + "jobs": [ + "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9" + ] + }, + "output": { + "jobs": [ + { + "container": { + "command": [ + "sleep", + "60" + ], + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c", + "environment": [ + + ], + "exitCode": 0, + "image": "busybox", + "memory": 128, + "mountPoints": [ + + ], + "ulimits": [ + + ], + "vcpus": 1, + "volumes": [ + + ] + }, + "createdAt": 1480460782010, + "dependsOn": [ + + ], + "jobDefinition": "sleep60", + "jobId": "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9", + "jobName": "example", + "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "parameters": { + }, + "startedAt": 1480460816500, + "status": "SUCCEEDED", + "stoppedAt": 1480460880699 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a job with the specified job ID.", + "id": "to-describe-a-specific-job-1481154090490", + "title": "To describe a specific job" + } + ], + "ListJobs": [ + { + "input": { + "jobQueue": "HighPriority" + }, + "output": { + "jobSummaryList": [ + { + "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb", + "jobName": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the running jobs in the HighPriority job queue.", + "id": "to-list-running-jobs-1481154202164", + "title": "To list running jobs" + }, + { + "input": { + "jobQueue": "HighPriority", + "jobStatus": "SUBMITTED" + }, + "output": { + "jobSummaryList": [ + { + "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786", + "jobName": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.", + "id": "to-list-submitted-jobs-1481154251623", + "title": "To list submitted jobs" + } + ], + "RegisterJobDefinition": [ + { + "input": { + "type": "container", + "containerProperties": { + "command": [ + "sleep", + "10" + ], + "image": "busybox", + "memory": 128, + "vcpus": 1 + }, + "jobDefinitionName": "sleep10" + }, + "output": { + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1", + "jobDefinitionName": "sleep10", + "revision": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers a job definition for a simple container job.", + "id": "to-register-a-job-definition-1481154325325", + "title": "To register a job definition" + } + ], + "SubmitJob": [ + { + "input": { + "jobDefinition": "sleep60", + "jobName": "example", + "jobQueue": "HighPriority" + }, + "output": { + "jobId": "876da822-4198-45f2-a252-6cea32512ea8", + "jobName": "example" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example submits a simple container job called example to the HighPriority job queue.", + "id": "to-submit-a-job-to-a-queue-1481154481673", + "title": "To submit a job to a queue" + } + ], + "TerminateJob": [ + { + "input": { + "jobId": "61e743ed-35e4-48da-b2de-5c8333821c84", + "reason": "Terminating job." + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example terminates a job with the specified job ID.", + "id": "to-terminate-a-job-1481154558276", + "title": "To terminate a job" + } + ], + "UpdateComputeEnvironment": [ + { + "input": { + "computeEnvironment": "P2OnDemand", + "state": "DISABLED" + }, + "output": { + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", + "computeEnvironmentName": "P2OnDemand" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables the P2OnDemand compute environment so it can be deleted.", + "id": "to-update-a-compute-environment-1481154702731", + "title": "To update a compute environment" + } + ], + "UpdateJobQueue": [ + { + "input": { + "jobQueue": "GPGPU", + "state": "DISABLED" + }, + "output": { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", + "jobQueueName": "GPGPU" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables a job queue so that it can be deleted.", + "id": "to-update-a-job-queue-1481154806981", + "title": "To update a job queue" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/batch-2016-08-10.min.json b/node_modules/aws-sdk/apis/batch-2016-08-10.min.json new file mode 100644 index 0000000..26ffdaa --- /dev/null +++ b/node_modules/aws-sdk/apis/batch-2016-08-10.min.json @@ -0,0 +1,1057 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-08-10", + "endpointPrefix": "batch", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "AWS Batch", + "serviceFullName": "AWS Batch", + "serviceId": "Batch", + "signatureVersion": "v4", + "uid": "batch-2016-08-10" + }, + "operations": { + "CancelJob": { + "http": { + "requestUri": "/v1/canceljob" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "reason" + ], + "members": { + "jobId": {}, + "reason": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateComputeEnvironment": { + "http": { + "requestUri": "/v1/createcomputeenvironment" + }, + "input": { + "type": "structure", + "required": [ + "computeEnvironmentName", + "type", + "serviceRole" + ], + "members": { + "computeEnvironmentName": {}, + "type": {}, + "state": {}, + "computeResources": { + "shape": "S7" + }, + "serviceRole": {} + } + }, + "output": { + "type": "structure", + "members": { + "computeEnvironmentName": {}, + "computeEnvironmentArn": {} + } + } + }, + "CreateJobQueue": { + "http": { + "requestUri": "/v1/createjobqueue" + }, + "input": { + "type": "structure", + "required": [ + "jobQueueName", + "priority", + "computeEnvironmentOrder" + ], + "members": { + "jobQueueName": {}, + "state": {}, + "priority": { + "type": "integer" + }, + "computeEnvironmentOrder": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "required": [ + "jobQueueName", + "jobQueueArn" + ], + "members": { + "jobQueueName": {}, + "jobQueueArn": {} + } + } + }, + "DeleteComputeEnvironment": { + "http": { + "requestUri": "/v1/deletecomputeenvironment" + }, + "input": { + "type": "structure", + "required": [ + "computeEnvironment" + ], + "members": { + "computeEnvironment": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteJobQueue": { + "http": { + "requestUri": "/v1/deletejobqueue" + }, + "input": { + "type": "structure", + "required": [ + "jobQueue" + ], + "members": { + "jobQueue": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeregisterJobDefinition": { + "http": { + "requestUri": "/v1/deregisterjobdefinition" + }, + "input": { + "type": "structure", + "required": [ + "jobDefinition" + ], + "members": { + "jobDefinition": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeComputeEnvironments": { + "http": { + "requestUri": "/v1/describecomputeenvironments" + }, + "input": { + "type": "structure", + "members": { + "computeEnvironments": { + "shape": "Sa" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "computeEnvironments": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "computeEnvironmentName", + "computeEnvironmentArn", + "ecsClusterArn" + ], + "members": { + "computeEnvironmentName": {}, + "computeEnvironmentArn": {}, + "ecsClusterArn": {}, + "type": {}, + "state": {}, + "status": {}, + "statusReason": {}, + "computeResources": { + "shape": "S7" + }, + "serviceRole": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeJobDefinitions": { + "http": { + "requestUri": "/v1/describejobdefinitions" + }, + "input": { + "type": "structure", + "members": { + "jobDefinitions": { + "shape": "Sa" + }, + "maxResults": { + "type": "integer" + }, + "jobDefinitionName": {}, + "status": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "jobDefinitions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "jobDefinitionName", + "jobDefinitionArn", + "revision", + "type" + ], + "members": { + "jobDefinitionName": {}, + "jobDefinitionArn": {}, + "revision": { + "type": "integer" + }, + "status": {}, + "type": {}, + "parameters": { + "shape": "Sy" + }, + "retryStrategy": { + "shape": "Sz" + }, + "containerProperties": { + "shape": "S10" + }, + "timeout": { + "shape": "S1e" + }, + "nodeProperties": { + "shape": "S1f" + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeJobQueues": { + "http": { + "requestUri": "/v1/describejobqueues" + }, + "input": { + "type": "structure", + "members": { + "jobQueues": { + "shape": "Sa" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "jobQueues": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "jobQueueName", + "jobQueueArn", + "state", + "priority", + "computeEnvironmentOrder" + ], + "members": { + "jobQueueName": {}, + "jobQueueArn": {}, + "state": {}, + "status": {}, + "statusReason": {}, + "priority": { + "type": "integer" + }, + "computeEnvironmentOrder": { + "shape": "Sg" + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeJobs": { + "http": { + "requestUri": "/v1/describejobs" + }, + "input": { + "type": "structure", + "required": [ + "jobs" + ], + "members": { + "jobs": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobs": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "jobName", + "jobId", + "jobQueue", + "status", + "startedAt", + "jobDefinition" + ], + "members": { + "jobName": {}, + "jobId": {}, + "jobQueue": {}, + "status": {}, + "attempts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "container": { + "type": "structure", + "members": { + "containerInstanceArn": {}, + "taskArn": {}, + "exitCode": { + "type": "integer" + }, + "reason": {}, + "logStreamName": {}, + "networkInterfaces": { + "shape": "S1v" + } + } + }, + "startedAt": { + "type": "long" + }, + "stoppedAt": { + "type": "long" + }, + "statusReason": {} + } + } + }, + "statusReason": {}, + "createdAt": { + "type": "long" + }, + "retryStrategy": { + "shape": "Sz" + }, + "startedAt": { + "type": "long" + }, + "stoppedAt": { + "type": "long" + }, + "dependsOn": { + "shape": "S1y" + }, + "jobDefinition": {}, + "parameters": { + "shape": "Sy" + }, + "container": { + "type": "structure", + "members": { + "image": {}, + "vcpus": { + "type": "integer" + }, + "memory": { + "type": "integer" + }, + "command": { + "shape": "Sa" + }, + "jobRoleArn": {}, + "volumes": { + "shape": "S11" + }, + "environment": { + "shape": "S14" + }, + "mountPoints": { + "shape": "S16" + }, + "readonlyRootFilesystem": { + "type": "boolean" + }, + "ulimits": { + "shape": "S19" + }, + "privileged": { + "type": "boolean" + }, + "user": {}, + "exitCode": { + "type": "integer" + }, + "reason": {}, + "containerInstanceArn": {}, + "taskArn": {}, + "logStreamName": {}, + "instanceType": {}, + "networkInterfaces": { + "shape": "S1v" + }, + "resourceRequirements": { + "shape": "S1b" + } + } + }, + "nodeDetails": { + "type": "structure", + "members": { + "nodeIndex": { + "type": "integer" + }, + "isMainNode": { + "type": "boolean" + } + } + }, + "nodeProperties": { + "shape": "S1f" + }, + "arrayProperties": { + "type": "structure", + "members": { + "statusSummary": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + }, + "size": { + "type": "integer" + }, + "index": { + "type": "integer" + } + } + }, + "timeout": { + "shape": "S1e" + } + } + } + } + } + } + }, + "ListJobs": { + "http": { + "requestUri": "/v1/listjobs" + }, + "input": { + "type": "structure", + "members": { + "jobQueue": {}, + "arrayJobId": {}, + "multiNodeJobId": {}, + "jobStatus": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "jobSummaryList" + ], + "members": { + "jobSummaryList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "jobId", + "jobName" + ], + "members": { + "jobId": {}, + "jobName": {}, + "createdAt": { + "type": "long" + }, + "status": {}, + "statusReason": {}, + "startedAt": { + "type": "long" + }, + "stoppedAt": { + "type": "long" + }, + "container": { + "type": "structure", + "members": { + "exitCode": { + "type": "integer" + }, + "reason": {} + } + }, + "arrayProperties": { + "type": "structure", + "members": { + "size": { + "type": "integer" + }, + "index": { + "type": "integer" + } + } + }, + "nodeProperties": { + "type": "structure", + "members": { + "isMainNode": { + "type": "boolean" + }, + "numNodes": { + "type": "integer" + }, + "nodeIndex": { + "type": "integer" + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "RegisterJobDefinition": { + "http": { + "requestUri": "/v1/registerjobdefinition" + }, + "input": { + "type": "structure", + "required": [ + "jobDefinitionName", + "type" + ], + "members": { + "jobDefinitionName": {}, + "type": {}, + "parameters": { + "shape": "Sy" + }, + "containerProperties": { + "shape": "S10" + }, + "nodeProperties": { + "shape": "S1f" + }, + "retryStrategy": { + "shape": "Sz" + }, + "timeout": { + "shape": "S1e" + } + } + }, + "output": { + "type": "structure", + "required": [ + "jobDefinitionName", + "jobDefinitionArn", + "revision" + ], + "members": { + "jobDefinitionName": {}, + "jobDefinitionArn": {}, + "revision": { + "type": "integer" + } + } + } + }, + "SubmitJob": { + "http": { + "requestUri": "/v1/submitjob" + }, + "input": { + "type": "structure", + "required": [ + "jobName", + "jobQueue", + "jobDefinition" + ], + "members": { + "jobName": {}, + "jobQueue": {}, + "arrayProperties": { + "type": "structure", + "members": { + "size": { + "type": "integer" + } + } + }, + "dependsOn": { + "shape": "S1y" + }, + "jobDefinition": {}, + "parameters": { + "shape": "Sy" + }, + "containerOverrides": { + "shape": "S2h" + }, + "nodeOverrides": { + "type": "structure", + "members": { + "numNodes": { + "type": "integer" + }, + "nodePropertyOverrides": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "targetNodes" + ], + "members": { + "targetNodes": {}, + "containerOverrides": { + "shape": "S2h" + } + } + } + } + } + }, + "retryStrategy": { + "shape": "Sz" + }, + "timeout": { + "shape": "S1e" + } + } + }, + "output": { + "type": "structure", + "required": [ + "jobName", + "jobId" + ], + "members": { + "jobName": {}, + "jobId": {} + } + } + }, + "TerminateJob": { + "http": { + "requestUri": "/v1/terminatejob" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "reason" + ], + "members": { + "jobId": {}, + "reason": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateComputeEnvironment": { + "http": { + "requestUri": "/v1/updatecomputeenvironment" + }, + "input": { + "type": "structure", + "required": [ + "computeEnvironment" + ], + "members": { + "computeEnvironment": {}, + "state": {}, + "computeResources": { + "type": "structure", + "members": { + "minvCpus": { + "type": "integer" + }, + "maxvCpus": { + "type": "integer" + }, + "desiredvCpus": { + "type": "integer" + } + } + }, + "serviceRole": {} + } + }, + "output": { + "type": "structure", + "members": { + "computeEnvironmentName": {}, + "computeEnvironmentArn": {} + } + } + }, + "UpdateJobQueue": { + "http": { + "requestUri": "/v1/updatejobqueue" + }, + "input": { + "type": "structure", + "required": [ + "jobQueue" + ], + "members": { + "jobQueue": {}, + "state": {}, + "priority": { + "type": "integer" + }, + "computeEnvironmentOrder": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobQueueName": {}, + "jobQueueArn": {} + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "required": [ + "type", + "minvCpus", + "maxvCpus", + "instanceTypes", + "subnets", + "instanceRole" + ], + "members": { + "type": {}, + "minvCpus": { + "type": "integer" + }, + "maxvCpus": { + "type": "integer" + }, + "desiredvCpus": { + "type": "integer" + }, + "instanceTypes": { + "shape": "Sa" + }, + "imageId": {}, + "subnets": { + "shape": "Sa" + }, + "securityGroupIds": { + "shape": "Sa" + }, + "ec2KeyPair": {}, + "instanceRole": {}, + "tags": { + "type": "map", + "key": {}, + "value": {} + }, + "placementGroup": {}, + "bidPercentage": { + "type": "integer" + }, + "spotIamFleetRole": {}, + "launchTemplate": { + "type": "structure", + "members": { + "launchTemplateId": {}, + "launchTemplateName": {}, + "version": {} + } + } + } + }, + "Sa": { + "type": "list", + "member": {} + }, + "Sg": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "order", + "computeEnvironment" + ], + "members": { + "order": { + "type": "integer" + }, + "computeEnvironment": {} + } + } + }, + "Sy": { + "type": "map", + "key": {}, + "value": {} + }, + "Sz": { + "type": "structure", + "members": { + "attempts": { + "type": "integer" + } + } + }, + "S10": { + "type": "structure", + "members": { + "image": {}, + "vcpus": { + "type": "integer" + }, + "memory": { + "type": "integer" + }, + "command": { + "shape": "Sa" + }, + "jobRoleArn": {}, + "volumes": { + "shape": "S11" + }, + "environment": { + "shape": "S14" + }, + "mountPoints": { + "shape": "S16" + }, + "readonlyRootFilesystem": { + "type": "boolean" + }, + "privileged": { + "type": "boolean" + }, + "ulimits": { + "shape": "S19" + }, + "user": {}, + "instanceType": {}, + "resourceRequirements": { + "shape": "S1b" + } + } + }, + "S11": { + "type": "list", + "member": { + "type": "structure", + "members": { + "host": { + "type": "structure", + "members": { + "sourcePath": {} + } + }, + "name": {} + } + } + }, + "S14": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "value": {} + } + } + }, + "S16": { + "type": "list", + "member": { + "type": "structure", + "members": { + "containerPath": {}, + "readOnly": { + "type": "boolean" + }, + "sourceVolume": {} + } + } + }, + "S19": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "hardLimit", + "name", + "softLimit" + ], + "members": { + "hardLimit": { + "type": "integer" + }, + "name": {}, + "softLimit": { + "type": "integer" + } + } + } + }, + "S1b": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "value", + "type" + ], + "members": { + "value": {}, + "type": {} + } + } + }, + "S1e": { + "type": "structure", + "members": { + "attemptDurationSeconds": { + "type": "integer" + } + } + }, + "S1f": { + "type": "structure", + "required": [ + "numNodes", + "mainNode", + "nodeRangeProperties" + ], + "members": { + "numNodes": { + "type": "integer" + }, + "mainNode": { + "type": "integer" + }, + "nodeRangeProperties": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "targetNodes" + ], + "members": { + "targetNodes": {}, + "container": { + "shape": "S10" + } + } + } + } + } + }, + "S1v": { + "type": "list", + "member": { + "type": "structure", + "members": { + "attachmentId": {}, + "ipv6Address": {}, + "privateIpv4Address": {} + } + } + }, + "S1y": { + "type": "list", + "member": { + "type": "structure", + "members": { + "jobId": {}, + "type": {} + } + } + }, + "S2h": { + "type": "structure", + "members": { + "vcpus": { + "type": "integer" + }, + "memory": { + "type": "integer" + }, + "command": { + "shape": "Sa" + }, + "instanceType": {}, + "environment": { + "shape": "S14" + }, + "resourceRequirements": { + "shape": "S1b" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/batch-2016-08-10.paginators.json b/node_modules/aws-sdk/apis/batch-2016-08-10.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/batch-2016-08-10.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/budgets-2016-10-20.examples.json b/node_modules/aws-sdk/apis/budgets-2016-10-20.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/budgets-2016-10-20.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/budgets-2016-10-20.min.json b/node_modules/aws-sdk/apis/budgets-2016-10-20.min.json new file mode 100644 index 0000000..0e2d2fb --- /dev/null +++ b/node_modules/aws-sdk/apis/budgets-2016-10-20.min.json @@ -0,0 +1,553 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-10-20", + "endpointPrefix": "budgets", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "AWSBudgets", + "serviceFullName": "AWS Budgets", + "serviceId": "Budgets", + "signatureVersion": "v4", + "targetPrefix": "AWSBudgetServiceGateway", + "uid": "budgets-2016-10-20" + }, + "operations": { + "CreateBudget": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "Budget" + ], + "members": { + "AccountId": {}, + "Budget": { + "shape": "S3" + }, + "NotificationsWithSubscribers": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Notification", + "Subscribers" + ], + "members": { + "Notification": { + "shape": "Sk" + }, + "Subscribers": { + "shape": "Sq" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateNotification": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName", + "Notification", + "Subscribers" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "Notification": { + "shape": "Sk" + }, + "Subscribers": { + "shape": "Sq" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateSubscriber": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName", + "Notification", + "Subscriber" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "Notification": { + "shape": "Sk" + }, + "Subscriber": { + "shape": "Sr" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteBudget": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName" + ], + "members": { + "AccountId": {}, + "BudgetName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteNotification": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName", + "Notification" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "Notification": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSubscriber": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName", + "Notification", + "Subscriber" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "Notification": { + "shape": "Sk" + }, + "Subscriber": { + "shape": "Sr" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeBudget": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName" + ], + "members": { + "AccountId": {}, + "BudgetName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Budget": { + "shape": "S3" + } + } + } + }, + "DescribeBudgetPerformanceHistory": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "TimePeriod": { + "shape": "Se" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "BudgetPerformanceHistory": { + "type": "structure", + "members": { + "BudgetName": {}, + "BudgetType": {}, + "CostFilters": { + "shape": "S8" + }, + "CostTypes": { + "shape": "Sb" + }, + "TimeUnit": {}, + "BudgetedAndActualAmountsList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BudgetedAmount": { + "shape": "S5" + }, + "ActualAmount": { + "shape": "S5" + }, + "TimePeriod": { + "shape": "Se" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeBudgets": { + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Budgets": { + "type": "list", + "member": { + "shape": "S3" + } + }, + "NextToken": {} + } + } + }, + "DescribeNotificationsForBudget": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Notifications": { + "type": "list", + "member": { + "shape": "Sk" + } + }, + "NextToken": {} + } + } + }, + "DescribeSubscribersForNotification": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName", + "Notification" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "Notification": { + "shape": "Sk" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Subscribers": { + "shape": "Sq" + }, + "NextToken": {} + } + } + }, + "UpdateBudget": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "NewBudget" + ], + "members": { + "AccountId": {}, + "NewBudget": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateNotification": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName", + "OldNotification", + "NewNotification" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "OldNotification": { + "shape": "Sk" + }, + "NewNotification": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateSubscriber": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "BudgetName", + "Notification", + "OldSubscriber", + "NewSubscriber" + ], + "members": { + "AccountId": {}, + "BudgetName": {}, + "Notification": { + "shape": "Sk" + }, + "OldSubscriber": { + "shape": "Sr" + }, + "NewSubscriber": { + "shape": "Sr" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "required": [ + "BudgetName", + "TimeUnit", + "BudgetType" + ], + "members": { + "BudgetName": {}, + "BudgetLimit": { + "shape": "S5" + }, + "CostFilters": { + "shape": "S8" + }, + "CostTypes": { + "shape": "Sb" + }, + "TimeUnit": {}, + "TimePeriod": { + "shape": "Se" + }, + "CalculatedSpend": { + "type": "structure", + "required": [ + "ActualSpend" + ], + "members": { + "ActualSpend": { + "shape": "S5" + }, + "ForecastedSpend": { + "shape": "S5" + } + } + }, + "BudgetType": {}, + "LastUpdatedTime": { + "type": "timestamp" + } + } + }, + "S5": { + "type": "structure", + "required": [ + "Amount", + "Unit" + ], + "members": { + "Amount": {}, + "Unit": {} + } + }, + "S8": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "Sb": { + "type": "structure", + "members": { + "IncludeTax": { + "type": "boolean" + }, + "IncludeSubscription": { + "type": "boolean" + }, + "UseBlended": { + "type": "boolean" + }, + "IncludeRefund": { + "type": "boolean" + }, + "IncludeCredit": { + "type": "boolean" + }, + "IncludeUpfront": { + "type": "boolean" + }, + "IncludeRecurring": { + "type": "boolean" + }, + "IncludeOtherSubscription": { + "type": "boolean" + }, + "IncludeSupport": { + "type": "boolean" + }, + "IncludeDiscount": { + "type": "boolean" + }, + "UseAmortized": { + "type": "boolean" + } + } + }, + "Se": { + "type": "structure", + "members": { + "Start": { + "type": "timestamp" + }, + "End": { + "type": "timestamp" + } + } + }, + "Sk": { + "type": "structure", + "required": [ + "NotificationType", + "ComparisonOperator", + "Threshold" + ], + "members": { + "NotificationType": {}, + "ComparisonOperator": {}, + "Threshold": { + "type": "double" + }, + "ThresholdType": {}, + "NotificationState": {} + } + }, + "Sq": { + "type": "list", + "member": { + "shape": "Sr" + } + }, + "Sr": { + "type": "structure", + "required": [ + "SubscriptionType", + "Address" + ], + "members": { + "SubscriptionType": {}, + "Address": { + "type": "string", + "sensitive": true + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/budgets-2016-10-20.paginators.json b/node_modules/aws-sdk/apis/budgets-2016-10-20.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/budgets-2016-10-20.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/ce-2017-10-25.examples.json b/node_modules/aws-sdk/apis/ce-2017-10-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/ce-2017-10-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/ce-2017-10-25.min.json b/node_modules/aws-sdk/apis/ce-2017-10-25.min.json new file mode 100644 index 0000000..ede815e --- /dev/null +++ b/node_modules/aws-sdk/apis/ce-2017-10-25.min.json @@ -0,0 +1,654 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-10-25", + "endpointPrefix": "ce", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "AWS Cost Explorer", + "serviceFullName": "AWS Cost Explorer Service", + "serviceId": "Cost Explorer", + "signatureVersion": "v4", + "signingName": "ce", + "targetPrefix": "AWSInsightsIndexService", + "uid": "ce-2017-10-25" + }, + "operations": { + "GetCostAndUsage": { + "input": { + "type": "structure", + "required": [ + "TimePeriod" + ], + "members": { + "TimePeriod": { + "shape": "S2" + }, + "Granularity": {}, + "Filter": { + "shape": "S5" + }, + "Metrics": { + "shape": "Sd" + }, + "GroupBy": { + "shape": "Sf" + }, + "NextPageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextPageToken": {}, + "GroupDefinitions": { + "shape": "Sf" + }, + "ResultsByTime": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TimePeriod": { + "shape": "S2" + }, + "Total": { + "shape": "Sn" + }, + "Groups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Keys": { + "type": "list", + "member": {} + }, + "Metrics": { + "shape": "Sn" + } + } + } + }, + "Estimated": { + "type": "boolean" + } + } + } + } + } + } + }, + "GetCostForecast": { + "input": { + "type": "structure", + "required": [ + "TimePeriod", + "Metric", + "Granularity" + ], + "members": { + "TimePeriod": { + "shape": "S2" + }, + "Metric": {}, + "Granularity": {}, + "Filter": { + "shape": "S5" + }, + "PredictionIntervalLevel": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Total": { + "shape": "So" + }, + "ForecastResultsByTime": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TimePeriod": { + "shape": "S2" + }, + "MeanValue": {}, + "PredictionIntervalLowerBound": {}, + "PredictionIntervalUpperBound": {} + } + } + } + } + } + }, + "GetDimensionValues": { + "input": { + "type": "structure", + "required": [ + "TimePeriod", + "Dimension" + ], + "members": { + "SearchString": {}, + "TimePeriod": { + "shape": "S2" + }, + "Dimension": {}, + "Context": {}, + "NextPageToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "DimensionValues", + "ReturnSize", + "TotalSize" + ], + "members": { + "DimensionValues": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": {}, + "Attributes": { + "shape": "S19" + } + } + } + }, + "ReturnSize": { + "type": "integer" + }, + "TotalSize": { + "type": "integer" + }, + "NextPageToken": {} + } + } + }, + "GetReservationCoverage": { + "input": { + "type": "structure", + "required": [ + "TimePeriod" + ], + "members": { + "TimePeriod": { + "shape": "S2" + }, + "GroupBy": { + "shape": "Sf" + }, + "Granularity": {}, + "Filter": { + "shape": "S5" + }, + "Metrics": { + "shape": "Sd" + }, + "NextPageToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "CoveragesByTime" + ], + "members": { + "CoveragesByTime": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TimePeriod": { + "shape": "S2" + }, + "Groups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S19" + }, + "Coverage": { + "shape": "S1j" + } + } + } + }, + "Total": { + "shape": "S1j" + } + } + } + }, + "Total": { + "shape": "S1j" + }, + "NextPageToken": {} + } + } + }, + "GetReservationPurchaseRecommendation": { + "input": { + "type": "structure", + "required": [ + "Service" + ], + "members": { + "AccountId": {}, + "Service": {}, + "AccountScope": {}, + "LookbackPeriodInDays": {}, + "TermInYears": {}, + "PaymentOption": {}, + "ServiceSpecification": { + "shape": "S21" + }, + "PageSize": { + "type": "integer" + }, + "NextPageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Metadata": { + "type": "structure", + "members": { + "RecommendationId": {}, + "GenerationTimestamp": {} + } + }, + "Recommendations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountScope": {}, + "LookbackPeriodInDays": {}, + "TermInYears": {}, + "PaymentOption": {}, + "ServiceSpecification": { + "shape": "S21" + }, + "RecommendationDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": {}, + "InstanceDetails": { + "type": "structure", + "members": { + "EC2InstanceDetails": { + "type": "structure", + "members": { + "Family": {}, + "InstanceType": {}, + "Region": {}, + "AvailabilityZone": {}, + "Platform": {}, + "Tenancy": {}, + "CurrentGeneration": { + "type": "boolean" + }, + "SizeFlexEligible": { + "type": "boolean" + } + } + }, + "RDSInstanceDetails": { + "type": "structure", + "members": { + "Family": {}, + "InstanceType": {}, + "Region": {}, + "DatabaseEngine": {}, + "DatabaseEdition": {}, + "DeploymentOption": {}, + "LicenseModel": {}, + "CurrentGeneration": { + "type": "boolean" + }, + "SizeFlexEligible": { + "type": "boolean" + } + } + }, + "RedshiftInstanceDetails": { + "type": "structure", + "members": { + "Family": {}, + "NodeType": {}, + "Region": {}, + "CurrentGeneration": { + "type": "boolean" + }, + "SizeFlexEligible": { + "type": "boolean" + } + } + }, + "ElastiCacheInstanceDetails": { + "type": "structure", + "members": { + "Family": {}, + "NodeType": {}, + "Region": {}, + "ProductDescription": {}, + "CurrentGeneration": { + "type": "boolean" + }, + "SizeFlexEligible": { + "type": "boolean" + } + } + }, + "ESInstanceDetails": { + "type": "structure", + "members": { + "InstanceClass": {}, + "InstanceSize": {}, + "Region": {}, + "CurrentGeneration": { + "type": "boolean" + }, + "SizeFlexEligible": { + "type": "boolean" + } + } + } + } + }, + "RecommendedNumberOfInstancesToPurchase": {}, + "RecommendedNormalizedUnitsToPurchase": {}, + "MinimumNumberOfInstancesUsedPerHour": {}, + "MinimumNormalizedUnitsUsedPerHour": {}, + "MaximumNumberOfInstancesUsedPerHour": {}, + "MaximumNormalizedUnitsUsedPerHour": {}, + "AverageNumberOfInstancesUsedPerHour": {}, + "AverageNormalizedUnitsUsedPerHour": {}, + "AverageUtilization": {}, + "EstimatedBreakEvenInMonths": {}, + "CurrencyCode": {}, + "EstimatedMonthlySavingsAmount": {}, + "EstimatedMonthlySavingsPercentage": {}, + "EstimatedMonthlyOnDemandCost": {}, + "EstimatedReservationCostForLookbackPeriod": {}, + "UpfrontCost": {}, + "RecurringStandardMonthlyCost": {} + } + } + }, + "RecommendationSummary": { + "type": "structure", + "members": { + "TotalEstimatedMonthlySavingsAmount": {}, + "TotalEstimatedMonthlySavingsPercentage": {}, + "CurrencyCode": {} + } + } + } + } + }, + "NextPageToken": {} + } + } + }, + "GetReservationUtilization": { + "input": { + "type": "structure", + "required": [ + "TimePeriod" + ], + "members": { + "TimePeriod": { + "shape": "S2" + }, + "GroupBy": { + "shape": "Sf" + }, + "Granularity": {}, + "Filter": { + "shape": "S5" + }, + "NextPageToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "UtilizationsByTime" + ], + "members": { + "UtilizationsByTime": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TimePeriod": { + "shape": "S2" + }, + "Groups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "Attributes": { + "shape": "S19" + }, + "Utilization": { + "shape": "S2r" + } + } + } + }, + "Total": { + "shape": "S2r" + } + } + } + }, + "Total": { + "shape": "S2r" + }, + "NextPageToken": {} + } + } + }, + "GetTags": { + "input": { + "type": "structure", + "required": [ + "TimePeriod" + ], + "members": { + "SearchString": {}, + "TimePeriod": { + "shape": "S2" + }, + "TagKey": {}, + "NextPageToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Tags", + "ReturnSize", + "TotalSize" + ], + "members": { + "NextPageToken": {}, + "Tags": { + "type": "list", + "member": {} + }, + "ReturnSize": { + "type": "integer" + }, + "TotalSize": { + "type": "integer" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "Start", + "End" + ], + "members": { + "Start": {}, + "End": {} + } + }, + "S5": { + "type": "structure", + "members": { + "Or": { + "shape": "S6" + }, + "And": { + "shape": "S6" + }, + "Not": { + "shape": "S5" + }, + "Dimensions": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "shape": "S9" + } + } + }, + "Tags": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "shape": "S9" + } + } + } + } + }, + "S6": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "S9": { + "type": "list", + "member": {} + }, + "Sd": { + "type": "list", + "member": {} + }, + "Sf": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Key": {} + } + } + }, + "Sn": { + "type": "map", + "key": {}, + "value": { + "shape": "So" + } + }, + "So": { + "type": "structure", + "members": { + "Amount": {}, + "Unit": {} + } + }, + "S19": { + "type": "map", + "key": {}, + "value": {} + }, + "S1j": { + "type": "structure", + "members": { + "CoverageHours": { + "type": "structure", + "members": { + "OnDemandHours": {}, + "ReservedHours": {}, + "TotalRunningHours": {}, + "CoverageHoursPercentage": {} + } + }, + "CoverageNormalizedUnits": { + "type": "structure", + "members": { + "OnDemandNormalizedUnits": {}, + "ReservedNormalizedUnits": {}, + "TotalRunningNormalizedUnits": {}, + "CoverageNormalizedUnitsPercentage": {} + } + }, + "CoverageCost": { + "type": "structure", + "members": { + "OnDemandCost": {} + } + } + } + }, + "S21": { + "type": "structure", + "members": { + "EC2Specification": { + "type": "structure", + "members": { + "OfferingClass": {} + } + } + } + }, + "S2r": { + "type": "structure", + "members": { + "UtilizationPercentage": {}, + "UtilizationPercentageInUnits": {}, + "PurchasedHours": {}, + "PurchasedUnits": {}, + "TotalActualHours": {}, + "TotalActualUnits": {}, + "UnusedHours": {}, + "UnusedUnits": {}, + "OnDemandCostOfRIHoursUsed": {}, + "NetRISavings": {}, + "TotalPotentialRISavings": {}, + "AmortizedUpfrontFee": {}, + "AmortizedRecurringFee": {}, + "TotalAmortizedFee": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ce-2017-10-25.paginators.json b/node_modules/aws-sdk/apis/ce-2017-10-25.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/ce-2017-10-25.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/chime-2018-05-01.examples.json b/node_modules/aws-sdk/apis/chime-2018-05-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/chime-2018-05-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/chime-2018-05-01.min.json b/node_modules/aws-sdk/apis/chime-2018-05-01.min.json new file mode 100644 index 0000000..7e4d251 --- /dev/null +++ b/node_modules/aws-sdk/apis/chime-2018-05-01.min.json @@ -0,0 +1,1783 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-05-01", + "endpointPrefix": "chime", + "protocol": "rest-json", + "serviceFullName": "Amazon Chime", + "serviceId": "Chime", + "signatureVersion": "v4", + "uid": "chime-2018-05-01" + }, + "operations": { + "AssociatePhoneNumberWithUser": { + "http": { + "requestUri": "/accounts/{accountId}/users/{userId}?operation=associate-phone-number", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId", + "E164PhoneNumber" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + }, + "E164PhoneNumber": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociatePhoneNumbersWithVoiceConnector": { + "http": { + "requestUri": "/voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + }, + "E164PhoneNumbers": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumberErrors": { + "shape": "S9" + } + } + } + }, + "BatchDeletePhoneNumber": { + "http": { + "requestUri": "/phone-numbers?operation=batch-delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PhoneNumberIds" + ], + "members": { + "PhoneNumberIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumberErrors": { + "shape": "S9" + } + } + } + }, + "BatchSuspendUser": { + "http": { + "requestUri": "/accounts/{accountId}/users?operation=suspend", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserIdList" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserIdList": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserErrors": { + "shape": "Si" + } + } + } + }, + "BatchUnsuspendUser": { + "http": { + "requestUri": "/accounts/{accountId}/users?operation=unsuspend", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserIdList" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserIdList": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserErrors": { + "shape": "Si" + } + } + } + }, + "BatchUpdatePhoneNumber": { + "http": { + "requestUri": "/phone-numbers?operation=batch-update", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "UpdatePhoneNumberRequestItems" + ], + "members": { + "UpdatePhoneNumberRequestItems": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "PhoneNumberId" + ], + "members": { + "PhoneNumberId": {}, + "ProductType": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumberErrors": { + "shape": "S9" + } + } + } + }, + "BatchUpdateUser": { + "http": { + "requestUri": "/accounts/{accountId}/users", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UpdateUserRequestItems" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UpdateUserRequestItems": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "UserId" + ], + "members": { + "UserId": {}, + "LicenseType": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "UserErrors": { + "shape": "Si" + } + } + } + }, + "CreateAccount": { + "http": { + "requestUri": "/accounts", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Account": { + "shape": "Sz" + } + } + } + }, + "CreatePhoneNumberOrder": { + "http": { + "requestUri": "/phone-number-orders", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "ProductType", + "E164PhoneNumbers" + ], + "members": { + "ProductType": {}, + "E164PhoneNumbers": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumberOrder": { + "shape": "S15" + } + } + } + }, + "CreateVoiceConnector": { + "http": { + "requestUri": "/voice-connectors", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "RequireEncryption" + ], + "members": { + "Name": {}, + "RequireEncryption": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VoiceConnector": { + "shape": "S1f" + } + } + } + }, + "DeleteAccount": { + "http": { + "method": "DELETE", + "requestUri": "/accounts/{accountId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePhoneNumber": { + "http": { + "method": "DELETE", + "requestUri": "/phone-numbers/{phoneNumberId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "PhoneNumberId" + ], + "members": { + "PhoneNumberId": { + "location": "uri", + "locationName": "phoneNumberId" + } + } + } + }, + "DeleteVoiceConnector": { + "http": { + "method": "DELETE", + "requestUri": "/voice-connectors/{voiceConnectorId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + } + }, + "DeleteVoiceConnectorOrigination": { + "http": { + "method": "DELETE", + "requestUri": "/voice-connectors/{voiceConnectorId}/origination", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + } + }, + "DeleteVoiceConnectorTermination": { + "http": { + "method": "DELETE", + "requestUri": "/voice-connectors/{voiceConnectorId}/termination", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + } + }, + "DeleteVoiceConnectorTerminationCredentials": { + "http": { + "requestUri": "/voice-connectors/{voiceConnectorId}/termination/credentials?operation=delete", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + }, + "Usernames": { + "shape": "S1n" + } + } + } + }, + "DisassociatePhoneNumberFromUser": { + "http": { + "requestUri": "/accounts/{accountId}/users/{userId}?operation=disassociate-phone-number", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociatePhoneNumbersFromVoiceConnector": { + "http": { + "requestUri": "/voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + }, + "E164PhoneNumbers": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumberErrors": { + "shape": "S9" + } + } + } + }, + "GetAccount": { + "http": { + "method": "GET", + "requestUri": "/accounts/{accountId}" + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Account": { + "shape": "Sz" + } + } + } + }, + "GetAccountSettings": { + "http": { + "method": "GET", + "requestUri": "/accounts/{accountId}/settings" + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + } + } + }, + "output": { + "type": "structure", + "members": { + "AccountSettings": { + "shape": "S1x" + } + } + } + }, + "GetGlobalSettings": { + "http": { + "method": "GET", + "requestUri": "/settings", + "responseCode": 200 + }, + "output": { + "type": "structure", + "members": { + "BusinessCalling": { + "shape": "S1z" + }, + "VoiceConnector": { + "shape": "S20" + } + } + } + }, + "GetPhoneNumber": { + "http": { + "method": "GET", + "requestUri": "/phone-numbers/{phoneNumberId}" + }, + "input": { + "type": "structure", + "required": [ + "PhoneNumberId" + ], + "members": { + "PhoneNumberId": { + "location": "uri", + "locationName": "phoneNumberId" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumber": { + "shape": "S23" + } + } + } + }, + "GetPhoneNumberOrder": { + "http": { + "method": "GET", + "requestUri": "/phone-number-orders/{phoneNumberOrderId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PhoneNumberOrderId" + ], + "members": { + "PhoneNumberOrderId": { + "location": "uri", + "locationName": "phoneNumberOrderId" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumberOrder": { + "shape": "S15" + } + } + } + }, + "GetUser": { + "http": { + "method": "GET", + "requestUri": "/accounts/{accountId}/users/{userId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "S2e" + } + } + } + }, + "GetUserSettings": { + "http": { + "method": "GET", + "requestUri": "/accounts/{accountId}/users/{userId}/settings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserSettings": { + "shape": "S2k" + } + } + } + }, + "GetVoiceConnector": { + "http": { + "method": "GET", + "requestUri": "/voice-connectors/{voiceConnectorId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + }, + "output": { + "type": "structure", + "members": { + "VoiceConnector": { + "shape": "S1f" + } + } + } + }, + "GetVoiceConnectorOrigination": { + "http": { + "method": "GET", + "requestUri": "/voice-connectors/{voiceConnectorId}/origination", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Origination": { + "shape": "S2q" + } + } + } + }, + "GetVoiceConnectorTermination": { + "http": { + "method": "GET", + "requestUri": "/voice-connectors/{voiceConnectorId}/termination", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Termination": { + "shape": "S2z" + } + } + } + }, + "GetVoiceConnectorTerminationHealth": { + "http": { + "method": "GET", + "requestUri": "/voice-connectors/{voiceConnectorId}/termination/health", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + }, + "output": { + "type": "structure", + "members": { + "TerminationHealth": { + "type": "structure", + "members": { + "Timestamp": { + "shape": "S11" + }, + "Source": {} + } + } + } + } + }, + "InviteUsers": { + "http": { + "requestUri": "/accounts/{accountId}/users?operation=add", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserEmailList" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserEmailList": { + "type": "list", + "member": { + "shape": "S2f" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Invites": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InviteId": {}, + "Status": {}, + "EmailAddress": { + "shape": "S2f" + }, + "EmailStatus": {} + } + } + } + } + } + }, + "ListAccounts": { + "http": { + "method": "GET", + "requestUri": "/accounts" + }, + "input": { + "type": "structure", + "members": { + "Name": { + "location": "querystring", + "locationName": "name" + }, + "UserEmail": { + "shape": "S2f", + "location": "querystring", + "locationName": "user-email" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Accounts": { + "type": "list", + "member": { + "shape": "Sz" + } + }, + "NextToken": {} + } + } + }, + "ListPhoneNumberOrders": { + "http": { + "method": "GET", + "requestUri": "/phone-number-orders", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumberOrders": { + "type": "list", + "member": { + "shape": "S15" + } + }, + "NextToken": {} + } + } + }, + "ListPhoneNumbers": { + "http": { + "method": "GET", + "requestUri": "/phone-numbers" + }, + "input": { + "type": "structure", + "members": { + "Status": { + "location": "querystring", + "locationName": "status" + }, + "ProductType": { + "location": "querystring", + "locationName": "product-type" + }, + "FilterName": { + "location": "querystring", + "locationName": "filter-name" + }, + "FilterValue": { + "location": "querystring", + "locationName": "filter-value" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumbers": { + "type": "list", + "member": { + "shape": "S23" + } + }, + "NextToken": {} + } + } + }, + "ListUsers": { + "http": { + "method": "GET", + "requestUri": "/accounts/{accountId}/users", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserEmail": { + "shape": "S2f", + "location": "querystring", + "locationName": "user-email" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + } + } + }, + "output": { + "type": "structure", + "members": { + "Users": { + "type": "list", + "member": { + "shape": "S2e" + } + }, + "NextToken": {} + } + } + }, + "ListVoiceConnectorTerminationCredentials": { + "http": { + "method": "GET", + "requestUri": "/voice-connectors/{voiceConnectorId}/termination/credentials", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Usernames": { + "shape": "S1n" + } + } + } + }, + "ListVoiceConnectors": { + "http": { + "method": "GET", + "requestUri": "/voice-connectors", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "VoiceConnectors": { + "type": "list", + "member": { + "shape": "S1f" + } + }, + "NextToken": {} + } + } + }, + "LogoutUser": { + "http": { + "requestUri": "/accounts/{accountId}/users/{userId}?operation=logout", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutVoiceConnectorOrigination": { + "http": { + "method": "PUT", + "requestUri": "/voice-connectors/{voiceConnectorId}/origination", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId", + "Origination" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + }, + "Origination": { + "shape": "S2q" + } + } + }, + "output": { + "type": "structure", + "members": { + "Origination": { + "shape": "S2q" + } + } + } + }, + "PutVoiceConnectorTermination": { + "http": { + "method": "PUT", + "requestUri": "/voice-connectors/{voiceConnectorId}/termination", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId", + "Termination" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + }, + "Termination": { + "shape": "S2z" + } + } + }, + "output": { + "type": "structure", + "members": { + "Termination": { + "shape": "S2z" + } + } + } + }, + "PutVoiceConnectorTerminationCredentials": { + "http": { + "requestUri": "/voice-connectors/{voiceConnectorId}/termination/credentials?operation=put", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + }, + "Credentials": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Username": { + "shape": "S1o" + }, + "Password": { + "shape": "S1o" + } + } + } + } + } + } + }, + "ResetPersonalPIN": { + "http": { + "requestUri": "/accounts/{accountId}/users/{userId}?operation=reset-personal-pin", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "S2e" + } + } + } + }, + "RestorePhoneNumber": { + "http": { + "requestUri": "/phone-numbers/{phoneNumberId}?operation=restore", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PhoneNumberId" + ], + "members": { + "PhoneNumberId": { + "location": "uri", + "locationName": "phoneNumberId" + } + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumber": { + "shape": "S23" + } + } + } + }, + "SearchAvailablePhoneNumbers": { + "http": { + "method": "GET", + "requestUri": "/search?type=phone-numbers" + }, + "input": { + "type": "structure", + "members": { + "AreaCode": { + "location": "querystring", + "locationName": "area-code" + }, + "City": { + "location": "querystring", + "locationName": "city" + }, + "Country": { + "location": "querystring", + "locationName": "country" + }, + "State": { + "location": "querystring", + "locationName": "state" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + } + } + }, + "output": { + "type": "structure", + "members": { + "E164PhoneNumbers": { + "shape": "S7" + } + } + } + }, + "UpdateAccount": { + "http": { + "requestUri": "/accounts/{accountId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Account": { + "shape": "Sz" + } + } + } + }, + "UpdateAccountSettings": { + "http": { + "method": "PUT", + "requestUri": "/accounts/{accountId}/settings", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "AccountSettings" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "AccountSettings": { + "shape": "S1x" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateGlobalSettings": { + "http": { + "method": "PUT", + "requestUri": "/settings", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "BusinessCalling", + "VoiceConnector" + ], + "members": { + "BusinessCalling": { + "shape": "S1z" + }, + "VoiceConnector": { + "shape": "S20" + } + } + } + }, + "UpdatePhoneNumber": { + "http": { + "requestUri": "/phone-numbers/{phoneNumberId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PhoneNumberId" + ], + "members": { + "PhoneNumberId": { + "location": "uri", + "locationName": "phoneNumberId" + }, + "ProductType": {} + } + }, + "output": { + "type": "structure", + "members": { + "PhoneNumber": { + "shape": "S23" + } + } + } + }, + "UpdateUser": { + "http": { + "requestUri": "/accounts/{accountId}/users/{userId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + }, + "LicenseType": {} + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "S2e" + } + } + } + }, + "UpdateUserSettings": { + "http": { + "method": "PUT", + "requestUri": "/accounts/{accountId}/users/{userId}/settings", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "UserId", + "UserSettings" + ], + "members": { + "AccountId": { + "location": "uri", + "locationName": "accountId" + }, + "UserId": { + "location": "uri", + "locationName": "userId" + }, + "UserSettings": { + "shape": "S2k" + } + } + } + }, + "UpdateVoiceConnector": { + "http": { + "method": "PUT", + "requestUri": "/voice-connectors/{voiceConnectorId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "VoiceConnectorId", + "Name", + "RequireEncryption" + ], + "members": { + "VoiceConnectorId": { + "location": "uri", + "locationName": "voiceConnectorId" + }, + "Name": {}, + "RequireEncryption": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VoiceConnector": { + "shape": "S1f" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "string", + "sensitive": true + }, + "S7": { + "type": "list", + "member": { + "shape": "S3" + } + }, + "S9": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PhoneNumberId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "Sg": { + "type": "list", + "member": {} + }, + "Si": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UserId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "Sz": { + "type": "structure", + "required": [ + "AwsAccountId", + "AccountId", + "Name" + ], + "members": { + "AwsAccountId": {}, + "AccountId": {}, + "Name": {}, + "AccountType": {}, + "CreatedTimestamp": { + "shape": "S11" + }, + "DefaultLicense": {}, + "SupportedLicenses": { + "type": "list", + "member": {} + } + } + }, + "S11": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "S15": { + "type": "structure", + "members": { + "PhoneNumberOrderId": {}, + "ProductType": {}, + "Status": {}, + "OrderedPhoneNumbers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "E164PhoneNumber": { + "shape": "S3" + }, + "Status": {} + } + } + }, + "CreatedTimestamp": { + "shape": "S11" + }, + "UpdatedTimestamp": { + "shape": "S11" + } + } + }, + "S1f": { + "type": "structure", + "members": { + "VoiceConnectorId": {}, + "Name": {}, + "OutboundHostName": {}, + "RequireEncryption": { + "type": "boolean" + }, + "CreatedTimestamp": { + "shape": "S11" + }, + "UpdatedTimestamp": { + "shape": "S11" + } + } + }, + "S1n": { + "type": "list", + "member": { + "shape": "S1o" + } + }, + "S1o": { + "type": "string", + "sensitive": true + }, + "S1x": { + "type": "structure", + "members": { + "DisableRemoteControl": { + "type": "boolean" + }, + "EnableDialOut": { + "type": "boolean" + } + } + }, + "S1z": { + "type": "structure", + "members": { + "CdrBucket": {} + } + }, + "S20": { + "type": "structure", + "members": { + "CdrBucket": {} + } + }, + "S23": { + "type": "structure", + "members": { + "PhoneNumberId": {}, + "E164PhoneNumber": { + "shape": "S3" + }, + "ProductType": {}, + "Status": {}, + "Capabilities": { + "type": "structure", + "members": { + "InboundCall": { + "type": "boolean" + }, + "OutboundCall": { + "type": "boolean" + }, + "InboundSMS": { + "type": "boolean" + }, + "OutboundSMS": { + "type": "boolean" + }, + "InboundMMS": { + "type": "boolean" + }, + "OutboundMMS": { + "type": "boolean" + } + } + }, + "Associations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": {}, + "Name": {}, + "AssociatedTimestamp": { + "shape": "S11" + } + } + } + }, + "CreatedTimestamp": { + "shape": "S11" + }, + "UpdatedTimestamp": { + "shape": "S11" + }, + "DeletionTimestamp": { + "shape": "S11" + } + } + }, + "S2e": { + "type": "structure", + "required": [ + "UserId" + ], + "members": { + "UserId": {}, + "AccountId": {}, + "PrimaryEmail": { + "shape": "S2f" + }, + "PrimaryProvisionedNumber": { + "shape": "S1o" + }, + "DisplayName": { + "shape": "S1o" + }, + "LicenseType": {}, + "UserRegistrationStatus": {}, + "UserInvitationStatus": {}, + "RegisteredOn": { + "shape": "S11" + }, + "InvitedOn": { + "shape": "S11" + }, + "PersonalPIN": {} + } + }, + "S2f": { + "type": "string", + "sensitive": true + }, + "S2k": { + "type": "structure", + "required": [ + "Telephony" + ], + "members": { + "Telephony": { + "type": "structure", + "required": [ + "InboundCalling", + "OutboundCalling", + "SMS" + ], + "members": { + "InboundCalling": { + "type": "boolean" + }, + "OutboundCalling": { + "type": "boolean" + }, + "SMS": { + "type": "boolean" + } + } + } + } + }, + "S2q": { + "type": "structure", + "members": { + "Routes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Host": {}, + "Port": { + "type": "integer" + }, + "Protocol": {}, + "Priority": { + "type": "integer" + }, + "Weight": { + "type": "integer" + } + } + } + }, + "Disabled": { + "type": "boolean" + } + } + }, + "S2z": { + "type": "structure", + "members": { + "CpsLimit": { + "type": "integer" + }, + "DefaultPhoneNumber": { + "shape": "S3" + }, + "CallingRegions": { + "type": "list", + "member": {} + }, + "CidrAllowedList": { + "type": "list", + "member": {} + }, + "Disabled": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/chime-2018-05-01.paginators.json b/node_modules/aws-sdk/apis/chime-2018-05-01.paginators.json new file mode 100644 index 0000000..042c382 --- /dev/null +++ b/node_modules/aws-sdk/apis/chime-2018-05-01.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "ListAccounts": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPhoneNumberOrders": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPhoneNumbers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListUsers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListVoiceConnectors": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/cloud9-2017-09-23.examples.json b/node_modules/aws-sdk/apis/cloud9-2017-09-23.examples.json new file mode 100644 index 0000000..0074f49 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloud9-2017-09-23.examples.json @@ -0,0 +1,308 @@ +{ + "version": "1.0", + "examples": { + "CreateEnvironmentEC2": [ + { + "input": { + "name": "my-demo-environment", + "automaticStopTimeMinutes": 60, + "description": "This is my demonstration environment.", + "instanceType": "t2.micro", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "subnetId": "subnet-1fab8aEX" + }, + "output": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "createenvironmentec2-1516821730547", + "title": "CreateEnvironmentEC2" + } + ], + "CreateEnvironmentMembership": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-write", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser" + }, + "output": { + "membership": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-write", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "userId": "AIDAJ3BA6O2FMJWCWXHEX" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "createenvironmentmembership-1516822583452", + "title": "CreateEnvironmentMembership" + } + ], + "DeleteEnvironment": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "deleteenvironment-1516822903149", + "title": "DeleteEnvironment" + } + ], + "DeleteEnvironmentMembership": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "deleteenvironmentmembership-1516822975655", + "title": "DeleteEnvironmentMembership" + } + ], + "DescribeEnvironmentMemberships": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + "memberships": [ + { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-write", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "userId": "AIDAJ3BA6O2FMJWCWXHEX" + }, + { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets information about all of the environment members for the specified AWS Cloud9 development environment.", + "id": "describeenvironmentmemberships1-1516823070453", + "title": "DescribeEnvironmentMemberships1" + }, + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": [ + "owner" + ] + }, + "output": { + "memberships": [ + { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets information about the owner of the specified AWS Cloud9 development environment.", + "id": "describeenvironmentmemberships2-1516823191355", + "title": "DescribeEnvironmentMemberships2" + }, + { + "input": { + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser" + }, + "output": { + "memberships": [ + { + "environmentId": "10a75714bd494714929e7f5ec4125aEX", + "lastAccess": "2018-01-19T11:06:13Z", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + }, + { + "environmentId": "12bfc3cd537f41cb9776f8af5525c9EX", + "lastAccess": "2018-01-19T11:39:19Z", + "permissions": "owner", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "userId": "AIDAJNUEDQAQWFELJDLEX" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets AWS Cloud9 development environment membership information for the specified user.", + "id": "describeenvironmentmemberships3-1516823268793", + "title": "DescribeEnvironmentMemberships3" + } + ], + "DescribeEnvironmentStatus": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + "message": "Environment is ready to use", + "status": "ready" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "describeenvironmentstatus-1516823462133", + "title": "DescribeEnvironmentStatus" + } + ], + "DescribeEnvironments": [ + { + "input": { + "environmentIds": [ + "8d9967e2f0624182b74e7690ad69ebEX", + "349c86d4579e4e7298d500ff57a6b2EX" + ] + }, + "output": { + "environments": [ + { + "name": "my-demo-environment", + "type": "ec2", + "arn": "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", + "description": "This is my demonstration environment.", + "id": "8d9967e2f0624182b74e7690ad69ebEX", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser" + }, + { + "name": "another-demo-environment", + "type": "ssh", + "arn": "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", + "id": "349c86d4579e4e7298d500ff57a6b2EX", + "ownerArn": "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "describeenvironments-1516823568291", + "title": "DescribeEnvironments" + } + ], + "ListEnvironments": [ + { + "input": { + }, + "output": { + "environmentIds": [ + "349c86d4579e4e7298d500ff57a6b2EX", + "45a3da47af0840f2b0c0824f5ee232EX" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "listenvironments-1516823687205", + "title": "ListEnvironments" + } + ], + "UpdateEnvironment": [ + { + "input": { + "name": "my-changed-demo-environment", + "description": "This is my changed demonstration environment.", + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "updateenvironment-1516823781910", + "title": "UpdateEnvironment" + } + ], + "UpdateEnvironmentMembership": [ + { + "input": { + "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", + "permissions": "read-only", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser" + }, + "output": { + "membership": { + "environmentId": "8d9967e2f0624182b74e7690ad69eb31", + "permissions": "read-only", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "userId": "AIDAJ3BA6O2FMJWCWXHEX" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "updateenvironmentmembership-1516823876645", + "title": "UpdateEnvironmentMembership" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/cloud9-2017-09-23.min.json b/node_modules/aws-sdk/apis/cloud9-2017-09-23.min.json new file mode 100644 index 0000000..5809fab --- /dev/null +++ b/node_modules/aws-sdk/apis/cloud9-2017-09-23.min.json @@ -0,0 +1,276 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-09-23", + "endpointPrefix": "cloud9", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Cloud9", + "serviceId": "Cloud9", + "signatureVersion": "v4", + "targetPrefix": "AWSCloud9WorkspaceManagementService", + "uid": "cloud9-2017-09-23" + }, + "operations": { + "CreateEnvironmentEC2": { + "input": { + "type": "structure", + "required": [ + "name", + "instanceType" + ], + "members": { + "name": {}, + "description": { + "shape": "S3" + }, + "clientRequestToken": {}, + "instanceType": {}, + "subnetId": {}, + "automaticStopTimeMinutes": { + "type": "integer" + }, + "ownerArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "environmentId": {} + } + }, + "idempotent": true + }, + "CreateEnvironmentMembership": { + "input": { + "type": "structure", + "required": [ + "environmentId", + "userArn", + "permissions" + ], + "members": { + "environmentId": {}, + "userArn": {}, + "permissions": {} + } + }, + "output": { + "type": "structure", + "members": { + "membership": { + "shape": "Se" + } + } + }, + "idempotent": true + }, + "DeleteEnvironment": { + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteEnvironmentMembership": { + "input": { + "type": "structure", + "required": [ + "environmentId", + "userArn" + ], + "members": { + "environmentId": {}, + "userArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DescribeEnvironmentMemberships": { + "input": { + "type": "structure", + "members": { + "userArn": {}, + "environmentId": {}, + "permissions": { + "type": "list", + "member": {} + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "memberships": { + "type": "list", + "member": { + "shape": "Se" + } + }, + "nextToken": {} + } + } + }, + "DescribeEnvironmentStatus": { + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": {} + } + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "message": {} + } + } + }, + "DescribeEnvironments": { + "input": { + "type": "structure", + "required": [ + "environmentIds" + ], + "members": { + "environmentIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "environments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "description": { + "shape": "S3" + }, + "type": {}, + "arn": {}, + "ownerArn": {}, + "lifecycle": { + "type": "structure", + "members": { + "status": {}, + "reason": {}, + "failureResource": {} + } + } + } + } + } + } + } + }, + "ListEnvironments": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "nextToken": {}, + "environmentIds": { + "type": "list", + "member": {} + } + } + } + }, + "UpdateEnvironment": { + "input": { + "type": "structure", + "required": [ + "environmentId" + ], + "members": { + "environmentId": {}, + "name": {}, + "description": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateEnvironmentMembership": { + "input": { + "type": "structure", + "required": [ + "environmentId", + "userArn", + "permissions" + ], + "members": { + "environmentId": {}, + "userArn": {}, + "permissions": {} + } + }, + "output": { + "type": "structure", + "members": { + "membership": { + "shape": "Se" + } + } + }, + "idempotent": true + } + }, + "shapes": { + "S3": { + "type": "string", + "sensitive": true + }, + "Se": { + "type": "structure", + "members": { + "permissions": {}, + "userId": {}, + "userArn": {}, + "environmentId": {}, + "lastAccess": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloud9-2017-09-23.paginators.json b/node_modules/aws-sdk/apis/cloud9-2017-09-23.paginators.json new file mode 100644 index 0000000..f66f512 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloud9-2017-09-23.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "DescribeEnvironmentMemberships": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListEnvironments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.examples.json b/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.min.json b/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.min.json new file mode 100644 index 0000000..7260e05 --- /dev/null +++ b/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.min.json @@ -0,0 +1,3170 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-05-10", + "endpointPrefix": "clouddirectory", + "protocol": "rest-json", + "serviceFullName": "Amazon CloudDirectory", + "serviceId": "CloudDirectory", + "signatureVersion": "v4", + "signingName": "clouddirectory", + "uid": "clouddirectory-2016-05-10" + }, + "operations": { + "AddFacetToObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/facets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SchemaFacet": { + "shape": "S3" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ApplySchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/apply", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members": { + "PublishedSchemaArn": {}, + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "members": { + "AppliedSchemaArn": {}, + "DirectoryArn": {} + } + } + }, + "AttachObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ParentReference", + "ChildReference", + "LinkName" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ParentReference": { + "shape": "Sf" + }, + "ChildReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "AttachedObjectIdentifier": {} + } + } + }, + "AttachPolicy": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/policy/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AttachToIndex": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/index/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttachedObjectIdentifier": {} + } + } + }, + "AttachTypedLink": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SourceObjectReference": { + "shape": "Sf" + }, + "TargetObjectReference": { + "shape": "Sf" + }, + "TypedLinkFacet": { + "shape": "St" + }, + "Attributes": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + } + }, + "BatchRead": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/batchread", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "Operations" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Operations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ListObjectAttributes": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "FacetFilter": { + "shape": "S3" + } + } + }, + "ListObjectChildren": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListAttachedIndices": { + "type": "structure", + "required": [ + "TargetReference" + ], + "members": { + "TargetReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListObjectParentPaths": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "GetObjectInformation": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + } + } + }, + "GetObjectAttributes": { + "type": "structure", + "required": [ + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "SchemaFacet": { + "shape": "S3" + }, + "AttributeNames": { + "shape": "S1a" + } + } + }, + "ListObjectPolicies": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListPolicyAttachments": { + "type": "structure", + "required": [ + "PolicyReference" + ], + "members": { + "PolicyReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "LookupPolicy": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListIndex": { + "type": "structure", + "required": [ + "IndexReference" + ], + "members": { + "RangesOnIndexedValues": { + "shape": "S1f" + }, + "IndexReference": { + "shape": "Sf" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "ListOutgoingTypedLinks": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1k" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListIncomingTypedLinks": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1k" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "GetLinkAttributes": { + "type": "structure", + "required": [ + "TypedLinkSpecifier", + "AttributeNames" + ], + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeNames": { + "shape": "S1a" + } + } + } + } + } + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SuccessfulResponse": { + "type": "structure", + "members": { + "ListObjectAttributes": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + }, + "NextToken": {} + } + }, + "ListObjectChildren": { + "type": "structure", + "members": { + "Children": { + "shape": "S1v" + }, + "NextToken": {} + } + }, + "GetObjectInformation": { + "type": "structure", + "members": { + "SchemaFacets": { + "shape": "S1x" + }, + "ObjectIdentifier": {} + } + }, + "GetObjectAttributes": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + }, + "ListAttachedIndices": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S20" + }, + "NextToken": {} + } + }, + "ListObjectParentPaths": { + "type": "structure", + "members": { + "PathToObjectIdentifiersList": { + "shape": "S23" + }, + "NextToken": {} + } + }, + "ListObjectPolicies": { + "type": "structure", + "members": { + "AttachedPolicyIds": { + "shape": "S26" + }, + "NextToken": {} + } + }, + "ListPolicyAttachments": { + "type": "structure", + "members": { + "ObjectIdentifiers": { + "shape": "S26" + }, + "NextToken": {} + } + }, + "LookupPolicy": { + "type": "structure", + "members": { + "PolicyToPathList": { + "shape": "S2a" + }, + "NextToken": {} + } + }, + "ListIndex": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S20" + }, + "NextToken": {} + } + }, + "ListOutgoingTypedLinks": { + "type": "structure", + "members": { + "TypedLinkSpecifiers": { + "shape": "S2h" + }, + "NextToken": {} + } + }, + "ListIncomingTypedLinks": { + "type": "structure", + "members": { + "LinkSpecifiers": { + "shape": "S2h" + }, + "NextToken": {} + } + }, + "GetLinkAttributes": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + } + } + }, + "ExceptionResponse": { + "type": "structure", + "members": { + "Type": {}, + "Message": {} + } + } + } + } + } + } + } + }, + "BatchWrite": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/batchwrite", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "Operations" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Operations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CreateObject": { + "type": "structure", + "required": [ + "SchemaFacet", + "ObjectAttributeList" + ], + "members": { + "SchemaFacet": { + "shape": "S1x" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {}, + "BatchReferenceName": {} + } + }, + "AttachObject": { + "type": "structure", + "required": [ + "ParentReference", + "ChildReference", + "LinkName" + ], + "members": { + "ParentReference": { + "shape": "Sf" + }, + "ChildReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "DetachObject": { + "type": "structure", + "required": [ + "ParentReference", + "LinkName" + ], + "members": { + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {}, + "BatchReferenceName": {} + } + }, + "UpdateObjectAttributes": { + "type": "structure", + "required": [ + "ObjectReference", + "AttributeUpdates" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "AttributeUpdates": { + "shape": "S2v" + } + } + }, + "DeleteObject": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + } + } + }, + "AddFacetToObject": { + "type": "structure", + "required": [ + "SchemaFacet", + "ObjectAttributeList", + "ObjectReference" + ], + "members": { + "SchemaFacet": { + "shape": "S3" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "RemoveFacetFromObject": { + "type": "structure", + "required": [ + "SchemaFacet", + "ObjectReference" + ], + "members": { + "SchemaFacet": { + "shape": "S3" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "AttachPolicy": { + "type": "structure", + "required": [ + "PolicyReference", + "ObjectReference" + ], + "members": { + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "DetachPolicy": { + "type": "structure", + "required": [ + "PolicyReference", + "ObjectReference" + ], + "members": { + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "CreateIndex": { + "type": "structure", + "required": [ + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members": { + "OrderedIndexedAttributeList": { + "shape": "S35" + }, + "IsUnique": { + "type": "boolean" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {}, + "BatchReferenceName": {} + } + }, + "AttachToIndex": { + "type": "structure", + "required": [ + "IndexReference", + "TargetReference" + ], + "members": { + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "DetachFromIndex": { + "type": "structure", + "required": [ + "IndexReference", + "TargetReference" + ], + "members": { + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "AttachTypedLink": { + "type": "structure", + "required": [ + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members": { + "SourceObjectReference": { + "shape": "Sf" + }, + "TargetObjectReference": { + "shape": "Sf" + }, + "TypedLinkFacet": { + "shape": "St" + }, + "Attributes": { + "shape": "Sv" + } + } + }, + "DetachTypedLink": { + "type": "structure", + "required": [ + "TypedLinkSpecifier" + ], + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + }, + "UpdateLinkAttributes": { + "type": "structure", + "required": [ + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeUpdates": { + "shape": "S3c" + } + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CreateObject": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + }, + "AttachObject": { + "type": "structure", + "members": { + "attachedObjectIdentifier": {} + } + }, + "DetachObject": { + "type": "structure", + "members": { + "detachedObjectIdentifier": {} + } + }, + "UpdateObjectAttributes": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + }, + "DeleteObject": { + "type": "structure", + "members": {} + }, + "AddFacetToObject": { + "type": "structure", + "members": {} + }, + "RemoveFacetFromObject": { + "type": "structure", + "members": {} + }, + "AttachPolicy": { + "type": "structure", + "members": {} + }, + "DetachPolicy": { + "type": "structure", + "members": {} + }, + "CreateIndex": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + }, + "AttachToIndex": { + "type": "structure", + "members": { + "AttachedObjectIdentifier": {} + } + }, + "DetachFromIndex": { + "type": "structure", + "members": { + "DetachedObjectIdentifier": {} + } + }, + "AttachTypedLink": { + "type": "structure", + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + }, + "DetachTypedLink": { + "type": "structure", + "members": {} + }, + "UpdateLinkAttributes": { + "type": "structure", + "members": {} + } + } + } + } + } + } + }, + "CreateDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "SchemaArn" + ], + "members": { + "Name": {}, + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn", + "Name", + "ObjectIdentifier", + "AppliedSchemaArn" + ], + "members": { + "DirectoryArn": {}, + "Name": {}, + "ObjectIdentifier": {}, + "AppliedSchemaArn": {} + } + } + }, + "CreateFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/facet/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name", + "ObjectType" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "Attributes": { + "shape": "S42" + }, + "ObjectType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateIndex": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/index", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "OrderedIndexedAttributeList": { + "shape": "S35" + }, + "IsUnique": { + "type": "boolean" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + } + }, + "CreateObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SchemaFacets" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SchemaFacets": { + "shape": "S1x" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + } + }, + "CreateSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArn": {} + } + } + }, + "CreateTypedLinkFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Facet" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Facet": { + "type": "structure", + "required": [ + "Name", + "Attributes", + "IdentityAttributeOrder" + ], + "members": { + "Name": {}, + "Attributes": { + "shape": "S4q" + }, + "IdentityAttributeOrder": { + "shape": "S1a" + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {} + } + } + }, + "DeleteFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/facet/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArn": {} + } + } + }, + "DeleteTypedLinkFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DetachFromIndex": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/index/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "DetachedObjectIdentifier": {} + } + } + }, + "DetachObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ParentReference", + "LinkName" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DetachedObjectIdentifier": {} + } + } + }, + "DetachPolicy": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/policy/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DetachTypedLink": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TypedLinkSpecifier" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + } + }, + "DisableDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory/disable", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {} + } + } + }, + "EnableDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory/enable", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {} + } + } + }, + "GetAppliedSchemaVersion": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/getappliedschema", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "AppliedSchemaArn": {} + } + } + }, + "GetDirectory": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/directory/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Directory" + ], + "members": { + "Directory": { + "shape": "S5i" + } + } + } + }, + "GetFacet": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/facet", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Facet": { + "type": "structure", + "members": { + "Name": {}, + "ObjectType": {} + } + } + } + } + }, + "GetLinkAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/attributes/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeNames" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeNames": { + "shape": "S1a" + }, + "ConsistencyLevel": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + } + }, + "GetObjectAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/attributes/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + }, + "SchemaFacet": { + "shape": "S3" + }, + "AttributeNames": { + "shape": "S1a" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + } + }, + "GetObjectInformation": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/information", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaFacets": { + "shape": "S1x" + }, + "ObjectIdentifier": {} + } + } + }, + "GetSchemaAsJson": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/json", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "Document": {} + } + } + }, + "GetTypedLinkFacetInformation": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityAttributeOrder": { + "shape": "S1a" + } + } + } + }, + "ListAppliedSchemaArns": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/applied", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {}, + "SchemaArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArns": { + "shape": "S61" + }, + "NextToken": {} + } + } + }, + "ListAttachedIndices": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/indices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TargetReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TargetReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S20" + }, + "NextToken": {} + } + } + }, + "ListDevelopmentSchemaArns": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/development", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArns": { + "shape": "S61" + }, + "NextToken": {} + } + } + }, + "ListDirectories": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/directory/list", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "state": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Directories" + ], + "members": { + "Directories": { + "type": "list", + "member": { + "shape": "S5i" + } + }, + "NextToken": {} + } + } + }, + "ListFacetAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/facet/attributes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S42" + }, + "NextToken": {} + } + } + }, + "ListFacetNames": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/facet/list", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FacetNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListIncomingTypedLinks": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/incoming", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1k" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": {} + } + }, + "output": { + "type": "structure", + "members": { + "LinkSpecifiers": { + "shape": "S2h" + }, + "NextToken": {} + } + } + }, + "ListIndex": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/index/targets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "IndexReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "RangesOnIndexedValues": { + "shape": "S1f" + }, + "IndexReference": { + "shape": "Sf" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S20" + }, + "NextToken": {} + } + } + }, + "ListObjectAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/attributes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + }, + "FacetFilter": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + }, + "NextToken": {} + } + } + }, + "ListObjectChildren": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/children", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "Children": { + "shape": "S1v" + }, + "NextToken": {} + } + } + }, + "ListObjectParentPaths": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/parentpaths", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PathToObjectIdentifiersList": { + "shape": "S23" + }, + "NextToken": {} + } + } + }, + "ListObjectParents": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/parent", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "Parents": { + "type": "map", + "key": {}, + "value": {} + }, + "NextToken": {} + } + } + }, + "ListObjectPolicies": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/policy", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttachedPolicyIds": { + "shape": "S26" + }, + "NextToken": {} + } + } + }, + "ListOutgoingTypedLinks": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/outgoing", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1k" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": {} + } + }, + "output": { + "type": "structure", + "members": { + "TypedLinkSpecifiers": { + "shape": "S2h" + }, + "NextToken": {} + } + } + }, + "ListPolicyAttachments": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/policy/attachment", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "PolicyReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "PolicyReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifiers": { + "shape": "S26" + }, + "NextToken": {} + } + } + }, + "ListPublishedSchemaArns": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/published", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "SchemaArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArns": { + "shape": "S61" + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/tags", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S72" + }, + "NextToken": {} + } + } + }, + "ListTypedLinkFacetAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/attributes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S4q" + }, + "NextToken": {} + } + } + }, + "ListTypedLinkFacetNames": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/list", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FacetNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "LookupPolicy": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/policy/lookup", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PolicyToPathList": { + "shape": "S2a" + }, + "NextToken": {} + } + } + }, + "PublishSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/publish", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DevelopmentSchemaArn", + "Version" + ], + "members": { + "DevelopmentSchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Version": {}, + "MinorVersion": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "PublishedSchemaArn": {} + } + } + }, + "PutSchemaFromJson": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/json", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Document" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Document": {} + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {} + } + } + }, + "RemoveFacetFromObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/facets/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SchemaFacet": { + "shape": "S3" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TagResource": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/tags/add", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S72" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/tags/remove", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/facet", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "AttributeUpdates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Attribute": { + "shape": "S43" + }, + "Action": {} + } + } + }, + "ObjectType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateLinkAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/attributes/update", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeUpdates": { + "shape": "S3c" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateObjectAttributes": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/update", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference", + "AttributeUpdates" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "AttributeUpdates": { + "shape": "S2v" + } + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + } + }, + "UpdateSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/update", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArn": {} + } + } + }, + "UpdateTypedLinkFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name", + "AttributeUpdates", + "IdentityAttributeOrder" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "AttributeUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Attribute", + "Action" + ], + "members": { + "Attribute": { + "shape": "S4r" + }, + "Action": {} + } + } + }, + "IdentityAttributeOrder": { + "shape": "S1a" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpgradeAppliedSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/upgradeapplied", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members": { + "PublishedSchemaArn": {}, + "DirectoryArn": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "UpgradedSchemaArn": {}, + "DirectoryArn": {} + } + } + }, + "UpgradePublishedSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/upgradepublished", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DevelopmentSchemaArn", + "PublishedSchemaArn", + "MinorVersion" + ], + "members": { + "DevelopmentSchemaArn": {}, + "PublishedSchemaArn": {}, + "MinorVersion": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "UpgradedSchemaArn": {} + } + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "members": { + "SchemaArn": {}, + "FacetName": {} + } + }, + "S5": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": { + "shape": "S7" + }, + "Value": { + "shape": "S9" + } + } + } + }, + "S7": { + "type": "structure", + "required": [ + "SchemaArn", + "FacetName", + "Name" + ], + "members": { + "SchemaArn": {}, + "FacetName": {}, + "Name": {} + } + }, + "S9": { + "type": "structure", + "members": { + "StringValue": {}, + "BinaryValue": { + "type": "blob" + }, + "BooleanValue": { + "type": "boolean" + }, + "NumberValue": {}, + "DatetimeValue": { + "type": "timestamp" + } + } + }, + "Sf": { + "type": "structure", + "members": { + "Selector": {} + } + }, + "St": { + "type": "structure", + "required": [ + "SchemaArn", + "TypedLinkName" + ], + "members": { + "SchemaArn": {}, + "TypedLinkName": {} + } + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeName", + "Value" + ], + "members": { + "AttributeName": {}, + "Value": { + "shape": "S9" + } + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "TypedLinkFacet", + "SourceObjectReference", + "TargetObjectReference", + "IdentityAttributeValues" + ], + "members": { + "TypedLinkFacet": { + "shape": "St" + }, + "SourceObjectReference": { + "shape": "Sf" + }, + "TargetObjectReference": { + "shape": "Sf" + }, + "IdentityAttributeValues": { + "shape": "Sv" + } + } + }, + "S1a": { + "type": "list", + "member": {} + }, + "S1f": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeKey": { + "shape": "S7" + }, + "Range": { + "shape": "S1h" + } + } + } + }, + "S1h": { + "type": "structure", + "required": [ + "StartMode", + "EndMode" + ], + "members": { + "StartMode": {}, + "StartValue": { + "shape": "S9" + }, + "EndMode": {}, + "EndValue": { + "shape": "S9" + } + } + }, + "S1k": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Range" + ], + "members": { + "AttributeName": {}, + "Range": { + "shape": "S1h" + } + } + } + }, + "S1v": { + "type": "map", + "key": {}, + "value": {} + }, + "S1x": { + "type": "list", + "member": { + "shape": "S3" + } + }, + "S20": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexedAttributes": { + "shape": "S5" + }, + "ObjectIdentifier": {} + } + } + }, + "S23": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "ObjectIdentifiers": { + "shape": "S26" + } + } + } + }, + "S26": { + "type": "list", + "member": {} + }, + "S2a": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "Policies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyId": {}, + "ObjectIdentifier": {}, + "PolicyType": {} + } + } + } + } + } + }, + "S2h": { + "type": "list", + "member": { + "shape": "Sy" + } + }, + "S2v": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ObjectAttributeKey": { + "shape": "S7" + }, + "ObjectAttributeAction": { + "type": "structure", + "members": { + "ObjectAttributeActionType": {}, + "ObjectAttributeUpdateValue": { + "shape": "S9" + } + } + } + } + } + }, + "S35": { + "type": "list", + "member": { + "shape": "S7" + } + }, + "S3c": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeKey": { + "shape": "S7" + }, + "AttributeAction": { + "type": "structure", + "members": { + "AttributeActionType": {}, + "AttributeUpdateValue": { + "shape": "S9" + } + } + } + } + } + }, + "S42": { + "type": "list", + "member": { + "shape": "S43" + } + }, + "S43": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "AttributeDefinition": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "DefaultValue": { + "shape": "S9" + }, + "IsImmutable": { + "type": "boolean" + }, + "Rules": { + "shape": "S46" + } + } + }, + "AttributeReference": { + "type": "structure", + "required": [ + "TargetFacetName", + "TargetAttributeName" + ], + "members": { + "TargetFacetName": {}, + "TargetAttributeName": {} + } + }, + "RequiredBehavior": {} + } + }, + "S46": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Type": {}, + "Parameters": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "S4q": { + "type": "list", + "member": { + "shape": "S4r" + } + }, + "S4r": { + "type": "structure", + "required": [ + "Name", + "Type", + "RequiredBehavior" + ], + "members": { + "Name": {}, + "Type": {}, + "DefaultValue": { + "shape": "S9" + }, + "IsImmutable": { + "type": "boolean" + }, + "Rules": { + "shape": "S46" + }, + "RequiredBehavior": {} + } + }, + "S5i": { + "type": "structure", + "members": { + "Name": {}, + "DirectoryArn": {}, + "State": {}, + "CreationDateTime": { + "type": "timestamp" + } + } + }, + "S61": { + "type": "list", + "member": {} + }, + "S72": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.paginators.json b/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.paginators.json new file mode 100644 index 0000000..d4164db --- /dev/null +++ b/node_modules/aws-sdk/apis/clouddirectory-2016-05-10.paginators.json @@ -0,0 +1,94 @@ +{ + "pagination": { + "ListAppliedSchemaArns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAttachedIndices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevelopmentSchemaArns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDirectories": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetNames": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListIndex": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectChildren": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectParentPaths": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectParents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectPolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPolicyAttachments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPublishedSchemaArns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetNames": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "LookupPolicy": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.examples.json b/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.min.json b/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.min.json new file mode 100644 index 0000000..d17dc6e --- /dev/null +++ b/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.min.json @@ -0,0 +1,3236 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-01-11", + "endpointPrefix": "clouddirectory", + "protocol": "rest-json", + "serviceFullName": "Amazon CloudDirectory", + "serviceId": "CloudDirectory", + "signatureVersion": "v4", + "signingName": "clouddirectory", + "uid": "clouddirectory-2017-01-11" + }, + "operations": { + "AddFacetToObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/facets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SchemaFacet": { + "shape": "S3" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ApplySchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/apply", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members": { + "PublishedSchemaArn": {}, + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "members": { + "AppliedSchemaArn": {}, + "DirectoryArn": {} + } + } + }, + "AttachObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ParentReference", + "ChildReference", + "LinkName" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ParentReference": { + "shape": "Sf" + }, + "ChildReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "AttachedObjectIdentifier": {} + } + } + }, + "AttachPolicy": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/policy/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AttachToIndex": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/index/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttachedObjectIdentifier": {} + } + } + }, + "AttachTypedLink": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/attach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SourceObjectReference": { + "shape": "Sf" + }, + "TargetObjectReference": { + "shape": "Sf" + }, + "TypedLinkFacet": { + "shape": "St" + }, + "Attributes": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + } + }, + "BatchRead": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/batchread", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "Operations" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Operations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ListObjectAttributes": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "FacetFilter": { + "shape": "S3" + } + } + }, + "ListObjectChildren": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListAttachedIndices": { + "type": "structure", + "required": [ + "TargetReference" + ], + "members": { + "TargetReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListObjectParentPaths": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "GetObjectInformation": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + } + } + }, + "GetObjectAttributes": { + "type": "structure", + "required": [ + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "SchemaFacet": { + "shape": "S3" + }, + "AttributeNames": { + "shape": "S1a" + } + } + }, + "ListObjectParents": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListObjectPolicies": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListPolicyAttachments": { + "type": "structure", + "required": [ + "PolicyReference" + ], + "members": { + "PolicyReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "LookupPolicy": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListIndex": { + "type": "structure", + "required": [ + "IndexReference" + ], + "members": { + "RangesOnIndexedValues": { + "shape": "S1g" + }, + "IndexReference": { + "shape": "Sf" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "ListOutgoingTypedLinks": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1l" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "ListIncomingTypedLinks": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1l" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "GetLinkAttributes": { + "type": "structure", + "required": [ + "TypedLinkSpecifier", + "AttributeNames" + ], + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeNames": { + "shape": "S1a" + } + } + } + } + } + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SuccessfulResponse": { + "type": "structure", + "members": { + "ListObjectAttributes": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + }, + "NextToken": {} + } + }, + "ListObjectChildren": { + "type": "structure", + "members": { + "Children": { + "shape": "S1w" + }, + "NextToken": {} + } + }, + "GetObjectInformation": { + "type": "structure", + "members": { + "SchemaFacets": { + "shape": "S1y" + }, + "ObjectIdentifier": {} + } + }, + "GetObjectAttributes": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + }, + "ListAttachedIndices": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S21" + }, + "NextToken": {} + } + }, + "ListObjectParentPaths": { + "type": "structure", + "members": { + "PathToObjectIdentifiersList": { + "shape": "S24" + }, + "NextToken": {} + } + }, + "ListObjectPolicies": { + "type": "structure", + "members": { + "AttachedPolicyIds": { + "shape": "S27" + }, + "NextToken": {} + } + }, + "ListPolicyAttachments": { + "type": "structure", + "members": { + "ObjectIdentifiers": { + "shape": "S27" + }, + "NextToken": {} + } + }, + "LookupPolicy": { + "type": "structure", + "members": { + "PolicyToPathList": { + "shape": "S2b" + }, + "NextToken": {} + } + }, + "ListIndex": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S21" + }, + "NextToken": {} + } + }, + "ListOutgoingTypedLinks": { + "type": "structure", + "members": { + "TypedLinkSpecifiers": { + "shape": "S2i" + }, + "NextToken": {} + } + }, + "ListIncomingTypedLinks": { + "type": "structure", + "members": { + "LinkSpecifiers": { + "shape": "S2i" + }, + "NextToken": {} + } + }, + "GetLinkAttributes": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + }, + "ListObjectParents": { + "type": "structure", + "members": { + "ParentLinks": { + "shape": "S2m" + }, + "NextToken": {} + } + } + } + }, + "ExceptionResponse": { + "type": "structure", + "members": { + "Type": {}, + "Message": {} + } + } + } + } + } + } + } + }, + "BatchWrite": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/batchwrite", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "Operations" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Operations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CreateObject": { + "type": "structure", + "required": [ + "SchemaFacet", + "ObjectAttributeList" + ], + "members": { + "SchemaFacet": { + "shape": "S1y" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {}, + "BatchReferenceName": {} + } + }, + "AttachObject": { + "type": "structure", + "required": [ + "ParentReference", + "ChildReference", + "LinkName" + ], + "members": { + "ParentReference": { + "shape": "Sf" + }, + "ChildReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "DetachObject": { + "type": "structure", + "required": [ + "ParentReference", + "LinkName" + ], + "members": { + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {}, + "BatchReferenceName": {} + } + }, + "UpdateObjectAttributes": { + "type": "structure", + "required": [ + "ObjectReference", + "AttributeUpdates" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + }, + "AttributeUpdates": { + "shape": "S2z" + } + } + }, + "DeleteObject": { + "type": "structure", + "required": [ + "ObjectReference" + ], + "members": { + "ObjectReference": { + "shape": "Sf" + } + } + }, + "AddFacetToObject": { + "type": "structure", + "required": [ + "SchemaFacet", + "ObjectAttributeList", + "ObjectReference" + ], + "members": { + "SchemaFacet": { + "shape": "S3" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "RemoveFacetFromObject": { + "type": "structure", + "required": [ + "SchemaFacet", + "ObjectReference" + ], + "members": { + "SchemaFacet": { + "shape": "S3" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "AttachPolicy": { + "type": "structure", + "required": [ + "PolicyReference", + "ObjectReference" + ], + "members": { + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "DetachPolicy": { + "type": "structure", + "required": [ + "PolicyReference", + "ObjectReference" + ], + "members": { + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "CreateIndex": { + "type": "structure", + "required": [ + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members": { + "OrderedIndexedAttributeList": { + "shape": "S39" + }, + "IsUnique": { + "type": "boolean" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {}, + "BatchReferenceName": {} + } + }, + "AttachToIndex": { + "type": "structure", + "required": [ + "IndexReference", + "TargetReference" + ], + "members": { + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "DetachFromIndex": { + "type": "structure", + "required": [ + "IndexReference", + "TargetReference" + ], + "members": { + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "AttachTypedLink": { + "type": "structure", + "required": [ + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members": { + "SourceObjectReference": { + "shape": "Sf" + }, + "TargetObjectReference": { + "shape": "Sf" + }, + "TypedLinkFacet": { + "shape": "St" + }, + "Attributes": { + "shape": "Sv" + } + } + }, + "DetachTypedLink": { + "type": "structure", + "required": [ + "TypedLinkSpecifier" + ], + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + }, + "UpdateLinkAttributes": { + "type": "structure", + "required": [ + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeUpdates": { + "shape": "S3g" + } + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CreateObject": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + }, + "AttachObject": { + "type": "structure", + "members": { + "attachedObjectIdentifier": {} + } + }, + "DetachObject": { + "type": "structure", + "members": { + "detachedObjectIdentifier": {} + } + }, + "UpdateObjectAttributes": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + }, + "DeleteObject": { + "type": "structure", + "members": {} + }, + "AddFacetToObject": { + "type": "structure", + "members": {} + }, + "RemoveFacetFromObject": { + "type": "structure", + "members": {} + }, + "AttachPolicy": { + "type": "structure", + "members": {} + }, + "DetachPolicy": { + "type": "structure", + "members": {} + }, + "CreateIndex": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + }, + "AttachToIndex": { + "type": "structure", + "members": { + "AttachedObjectIdentifier": {} + } + }, + "DetachFromIndex": { + "type": "structure", + "members": { + "DetachedObjectIdentifier": {} + } + }, + "AttachTypedLink": { + "type": "structure", + "members": { + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + }, + "DetachTypedLink": { + "type": "structure", + "members": {} + }, + "UpdateLinkAttributes": { + "type": "structure", + "members": {} + } + } + } + } + } + } + }, + "CreateDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "SchemaArn" + ], + "members": { + "Name": {}, + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn", + "Name", + "ObjectIdentifier", + "AppliedSchemaArn" + ], + "members": { + "DirectoryArn": {}, + "Name": {}, + "ObjectIdentifier": {}, + "AppliedSchemaArn": {} + } + } + }, + "CreateFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/facet/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "Attributes": { + "shape": "S46" + }, + "ObjectType": {}, + "FacetStyle": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateIndex": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/index", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "OrderedIndexedAttributeList": { + "shape": "S39" + }, + "IsUnique": { + "type": "boolean" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + } + }, + "CreateObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SchemaFacets" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SchemaFacets": { + "shape": "S1y" + }, + "ObjectAttributeList": { + "shape": "S5" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + } + }, + "CreateSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArn": {} + } + } + }, + "CreateTypedLinkFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Facet" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Facet": { + "type": "structure", + "required": [ + "Name", + "Attributes", + "IdentityAttributeOrder" + ], + "members": { + "Name": {}, + "Attributes": { + "shape": "S4v" + }, + "IdentityAttributeOrder": { + "shape": "S1a" + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {} + } + } + }, + "DeleteFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/facet/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArn": {} + } + } + }, + "DeleteTypedLinkFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DetachFromIndex": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/index/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "IndexReference": { + "shape": "Sf" + }, + "TargetReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "DetachedObjectIdentifier": {} + } + } + }, + "DetachObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ParentReference", + "LinkName" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ParentReference": { + "shape": "Sf" + }, + "LinkName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DetachedObjectIdentifier": {} + } + } + }, + "DetachPolicy": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/policy/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "PolicyReference": { + "shape": "Sf" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DetachTypedLink": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/detach", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TypedLinkSpecifier" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TypedLinkSpecifier": { + "shape": "Sy" + } + } + } + }, + "DisableDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory/disable", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {} + } + } + }, + "EnableDirectory": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/directory/enable", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {} + } + } + }, + "GetAppliedSchemaVersion": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/getappliedschema", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "AppliedSchemaArn": {} + } + } + }, + "GetDirectory": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/directory/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Directory" + ], + "members": { + "Directory": { + "shape": "S5n" + } + } + } + }, + "GetFacet": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/facet", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Facet": { + "type": "structure", + "members": { + "Name": {}, + "ObjectType": {}, + "FacetStyle": {} + } + } + } + } + }, + "GetLinkAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/attributes/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeNames" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeNames": { + "shape": "S1a" + }, + "ConsistencyLevel": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + } + }, + "GetObjectAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/attributes/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + }, + "SchemaFacet": { + "shape": "S3" + }, + "AttributeNames": { + "shape": "S1a" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + } + } + } + }, + "GetObjectInformation": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/information", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaFacets": { + "shape": "S1y" + }, + "ObjectIdentifier": {} + } + } + }, + "GetSchemaAsJson": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/json", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "Document": {} + } + } + }, + "GetTypedLinkFacetInformation": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityAttributeOrder": { + "shape": "S1a" + } + } + } + }, + "ListAppliedSchemaArns": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/applied", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn" + ], + "members": { + "DirectoryArn": {}, + "SchemaArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArns": { + "shape": "S66" + }, + "NextToken": {} + } + } + }, + "ListAttachedIndices": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/indices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TargetReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TargetReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S21" + }, + "NextToken": {} + } + } + }, + "ListDevelopmentSchemaArns": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/development", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArns": { + "shape": "S66" + }, + "NextToken": {} + } + } + }, + "ListDirectories": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/directory/list", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "state": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Directories" + ], + "members": { + "Directories": { + "type": "list", + "member": { + "shape": "S5n" + } + }, + "NextToken": {} + } + } + }, + "ListFacetAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/facet/attributes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S46" + }, + "NextToken": {} + } + } + }, + "ListFacetNames": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/facet/list", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FacetNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListIncomingTypedLinks": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/incoming", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1l" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": {} + } + }, + "output": { + "type": "structure", + "members": { + "LinkSpecifiers": { + "shape": "S2i" + }, + "NextToken": {} + } + } + }, + "ListIndex": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/index/targets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "IndexReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "RangesOnIndexedValues": { + "shape": "S1g" + }, + "IndexReference": { + "shape": "Sf" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "IndexAttachments": { + "shape": "S21" + }, + "NextToken": {} + } + } + }, + "ListManagedSchemaArns": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/managed", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "SchemaArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArns": { + "shape": "S66" + }, + "NextToken": {} + } + } + }, + "ListObjectAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/attributes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + }, + "FacetFilter": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S5" + }, + "NextToken": {} + } + } + }, + "ListObjectChildren": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/children", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "Children": { + "shape": "S1w" + }, + "NextToken": {} + } + } + }, + "ListObjectParentPaths": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/parentpaths", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PathToObjectIdentifiersList": { + "shape": "S24" + }, + "NextToken": {} + } + } + }, + "ListObjectParents": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/parent", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + }, + "IncludeAllLinksToEachParent": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Parents": { + "type": "map", + "key": {}, + "value": {} + }, + "NextToken": {}, + "ParentLinks": { + "shape": "S2m" + } + } + } + }, + "ListObjectPolicies": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/object/policy", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttachedPolicyIds": { + "shape": "S27" + }, + "NextToken": {} + } + } + }, + "ListOutgoingTypedLinks": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/outgoing", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "FilterAttributeRanges": { + "shape": "S1l" + }, + "FilterTypedLink": { + "shape": "St" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": {} + } + }, + "output": { + "type": "structure", + "members": { + "TypedLinkSpecifiers": { + "shape": "S2i" + }, + "NextToken": {} + } + } + }, + "ListPolicyAttachments": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/policy/attachment", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "PolicyReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "PolicyReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ConsistencyLevel": { + "location": "header", + "locationName": "x-amz-consistency-level" + } + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifiers": { + "shape": "S27" + }, + "NextToken": {} + } + } + }, + "ListPublishedSchemaArns": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/schema/published", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "SchemaArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArns": { + "shape": "S66" + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/tags", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S79" + }, + "NextToken": {} + } + } + }, + "ListTypedLinkFacetAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/attributes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S4v" + }, + "NextToken": {} + } + } + }, + "ListTypedLinkFacetNames": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet/list", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FacetNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "LookupPolicy": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/policy/lookup", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PolicyToPathList": { + "shape": "S2b" + }, + "NextToken": {} + } + } + }, + "PublishSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/publish", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DevelopmentSchemaArn", + "Version" + ], + "members": { + "DevelopmentSchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Version": {}, + "MinorVersion": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "PublishedSchemaArn": {} + } + } + }, + "PutSchemaFromJson": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/json", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Document" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Document": {} + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {} + } + } + }, + "RemoveFacetFromObject": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/facets/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "SchemaFacet": { + "shape": "S3" + }, + "ObjectReference": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TagResource": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/tags/add", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S79" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/tags/remove", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/facet", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "AttributeUpdates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Attribute": { + "shape": "S47" + }, + "Action": {} + } + } + }, + "ObjectType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateLinkAttributes": { + "http": { + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/attributes/update", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "TypedLinkSpecifier": { + "shape": "Sy" + }, + "AttributeUpdates": { + "shape": "S3g" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateObjectAttributes": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/object/update", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DirectoryArn", + "ObjectReference", + "AttributeUpdates" + ], + "members": { + "DirectoryArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "ObjectReference": { + "shape": "Sf" + }, + "AttributeUpdates": { + "shape": "S2z" + } + } + }, + "output": { + "type": "structure", + "members": { + "ObjectIdentifier": {} + } + } + }, + "UpdateSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/update", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "SchemaArn": {} + } + } + }, + "UpdateTypedLinkFacet": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/typedlink/facet", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SchemaArn", + "Name", + "AttributeUpdates", + "IdentityAttributeOrder" + ], + "members": { + "SchemaArn": { + "location": "header", + "locationName": "x-amz-data-partition" + }, + "Name": {}, + "AttributeUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Attribute", + "Action" + ], + "members": { + "Attribute": { + "shape": "S4w" + }, + "Action": {} + } + } + }, + "IdentityAttributeOrder": { + "shape": "S1a" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpgradeAppliedSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/upgradeapplied", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members": { + "PublishedSchemaArn": {}, + "DirectoryArn": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "UpgradedSchemaArn": {}, + "DirectoryArn": {} + } + } + }, + "UpgradePublishedSchema": { + "http": { + "method": "PUT", + "requestUri": "/amazonclouddirectory/2017-01-11/schema/upgradepublished", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DevelopmentSchemaArn", + "PublishedSchemaArn", + "MinorVersion" + ], + "members": { + "DevelopmentSchemaArn": {}, + "PublishedSchemaArn": {}, + "MinorVersion": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "UpgradedSchemaArn": {} + } + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "members": { + "SchemaArn": {}, + "FacetName": {} + } + }, + "S5": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": { + "shape": "S7" + }, + "Value": { + "shape": "S9" + } + } + } + }, + "S7": { + "type": "structure", + "required": [ + "SchemaArn", + "FacetName", + "Name" + ], + "members": { + "SchemaArn": {}, + "FacetName": {}, + "Name": {} + } + }, + "S9": { + "type": "structure", + "members": { + "StringValue": {}, + "BinaryValue": { + "type": "blob" + }, + "BooleanValue": { + "type": "boolean" + }, + "NumberValue": {}, + "DatetimeValue": { + "type": "timestamp" + } + } + }, + "Sf": { + "type": "structure", + "members": { + "Selector": {} + } + }, + "St": { + "type": "structure", + "required": [ + "SchemaArn", + "TypedLinkName" + ], + "members": { + "SchemaArn": {}, + "TypedLinkName": {} + } + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeName", + "Value" + ], + "members": { + "AttributeName": {}, + "Value": { + "shape": "S9" + } + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "TypedLinkFacet", + "SourceObjectReference", + "TargetObjectReference", + "IdentityAttributeValues" + ], + "members": { + "TypedLinkFacet": { + "shape": "St" + }, + "SourceObjectReference": { + "shape": "Sf" + }, + "TargetObjectReference": { + "shape": "Sf" + }, + "IdentityAttributeValues": { + "shape": "Sv" + } + } + }, + "S1a": { + "type": "list", + "member": {} + }, + "S1g": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeKey": { + "shape": "S7" + }, + "Range": { + "shape": "S1i" + } + } + } + }, + "S1i": { + "type": "structure", + "required": [ + "StartMode", + "EndMode" + ], + "members": { + "StartMode": {}, + "StartValue": { + "shape": "S9" + }, + "EndMode": {}, + "EndValue": { + "shape": "S9" + } + } + }, + "S1l": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Range" + ], + "members": { + "AttributeName": {}, + "Range": { + "shape": "S1i" + } + } + } + }, + "S1w": { + "type": "map", + "key": {}, + "value": {} + }, + "S1y": { + "type": "list", + "member": { + "shape": "S3" + } + }, + "S21": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexedAttributes": { + "shape": "S5" + }, + "ObjectIdentifier": {} + } + } + }, + "S24": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "ObjectIdentifiers": { + "shape": "S27" + } + } + } + }, + "S27": { + "type": "list", + "member": {} + }, + "S2b": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "Policies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyId": {}, + "ObjectIdentifier": {}, + "PolicyType": {} + } + } + } + } + } + }, + "S2i": { + "type": "list", + "member": { + "shape": "Sy" + } + }, + "S2m": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ObjectIdentifier": {}, + "LinkName": {} + } + } + }, + "S2z": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ObjectAttributeKey": { + "shape": "S7" + }, + "ObjectAttributeAction": { + "type": "structure", + "members": { + "ObjectAttributeActionType": {}, + "ObjectAttributeUpdateValue": { + "shape": "S9" + } + } + } + } + } + }, + "S39": { + "type": "list", + "member": { + "shape": "S7" + } + }, + "S3g": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeKey": { + "shape": "S7" + }, + "AttributeAction": { + "type": "structure", + "members": { + "AttributeActionType": {}, + "AttributeUpdateValue": { + "shape": "S9" + } + } + } + } + } + }, + "S46": { + "type": "list", + "member": { + "shape": "S47" + } + }, + "S47": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "AttributeDefinition": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "DefaultValue": { + "shape": "S9" + }, + "IsImmutable": { + "type": "boolean" + }, + "Rules": { + "shape": "S4a" + } + } + }, + "AttributeReference": { + "type": "structure", + "required": [ + "TargetFacetName", + "TargetAttributeName" + ], + "members": { + "TargetFacetName": {}, + "TargetAttributeName": {} + } + }, + "RequiredBehavior": {} + } + }, + "S4a": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Type": {}, + "Parameters": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "S4v": { + "type": "list", + "member": { + "shape": "S4w" + } + }, + "S4w": { + "type": "structure", + "required": [ + "Name", + "Type", + "RequiredBehavior" + ], + "members": { + "Name": {}, + "Type": {}, + "DefaultValue": { + "shape": "S9" + }, + "IsImmutable": { + "type": "boolean" + }, + "Rules": { + "shape": "S4a" + }, + "RequiredBehavior": {} + } + }, + "S5n": { + "type": "structure", + "members": { + "Name": {}, + "DirectoryArn": {}, + "State": {}, + "CreationDateTime": { + "type": "timestamp" + } + } + }, + "S66": { + "type": "list", + "member": {} + }, + "S79": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.paginators.json b/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.paginators.json new file mode 100644 index 0000000..2f01e0b --- /dev/null +++ b/node_modules/aws-sdk/apis/clouddirectory-2017-01-11.paginators.json @@ -0,0 +1,99 @@ +{ + "pagination": { + "ListAppliedSchemaArns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAttachedIndices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevelopmentSchemaArns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDirectories": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetNames": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListIndex": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListManagedSchemaArns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectChildren": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectParentPaths": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectParents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectPolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPolicyAttachments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPublishedSchemaArns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetAttributes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetNames": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "LookupPolicy": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudformation-2010-05-15.examples.json b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json new file mode 100644 index 0000000..dac78c8 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json @@ -0,0 +1,1761 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2010-05-15", + "endpointPrefix": "cloudformation", + "protocol": "query", + "serviceFullName": "AWS CloudFormation", + "serviceId": "CloudFormation", + "signatureVersion": "v4", + "uid": "cloudformation-2010-05-15", + "xmlNamespace": "http://cloudformation.amazonaws.com/doc/2010-05-15/" + }, + "operations": { + "CancelUpdateStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "ClientRequestToken": {} + } + } + }, + "ContinueUpdateRollback": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "RoleARN": {}, + "ResourcesToSkip": { + "type": "list", + "member": {} + }, + "ClientRequestToken": {} + } + }, + "output": { + "resultWrapper": "ContinueUpdateRollbackResult", + "type": "structure", + "members": {} + } + }, + "CreateChangeSet": { + "input": { + "type": "structure", + "required": [ + "StackName", + "ChangeSetName" + ], + "members": { + "StackName": {}, + "TemplateBody": {}, + "TemplateURL": {}, + "UsePreviousTemplate": { + "type": "boolean" + }, + "Parameters": { + "shape": "Se" + }, + "Capabilities": { + "shape": "Sj" + }, + "ResourceTypes": { + "shape": "Sl" + }, + "RoleARN": {}, + "RollbackConfiguration": { + "shape": "Sn" + }, + "NotificationARNs": { + "shape": "St" + }, + "Tags": { + "shape": "Sv" + }, + "ChangeSetName": {}, + "ClientToken": {}, + "Description": {}, + "ChangeSetType": {} + } + }, + "output": { + "resultWrapper": "CreateChangeSetResult", + "type": "structure", + "members": { + "Id": {}, + "StackId": {} + } + } + }, + "CreateStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "TemplateBody": {}, + "TemplateURL": {}, + "Parameters": { + "shape": "Se" + }, + "DisableRollback": { + "type": "boolean" + }, + "RollbackConfiguration": { + "shape": "Sn" + }, + "TimeoutInMinutes": { + "type": "integer" + }, + "NotificationARNs": { + "shape": "St" + }, + "Capabilities": { + "shape": "Sj" + }, + "ResourceTypes": { + "shape": "Sl" + }, + "RoleARN": {}, + "OnFailure": {}, + "StackPolicyBody": {}, + "StackPolicyURL": {}, + "Tags": { + "shape": "Sv" + }, + "ClientRequestToken": {}, + "EnableTerminationProtection": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateStackResult", + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "CreateStackInstances": { + "input": { + "type": "structure", + "required": [ + "StackSetName", + "Accounts", + "Regions" + ], + "members": { + "StackSetName": {}, + "Accounts": { + "shape": "S1g" + }, + "Regions": { + "shape": "S1i" + }, + "ParameterOverrides": { + "shape": "Se" + }, + "OperationPreferences": { + "shape": "S1k" + }, + "OperationId": { + "idempotencyToken": true + } + } + }, + "output": { + "resultWrapper": "CreateStackInstancesResult", + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "CreateStackSet": { + "input": { + "type": "structure", + "required": [ + "StackSetName" + ], + "members": { + "StackSetName": {}, + "Description": {}, + "TemplateBody": {}, + "TemplateURL": {}, + "Parameters": { + "shape": "Se" + }, + "Capabilities": { + "shape": "Sj" + }, + "Tags": { + "shape": "Sv" + }, + "AdministrationRoleARN": {}, + "ExecutionRoleName": {}, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "resultWrapper": "CreateStackSetResult", + "type": "structure", + "members": { + "StackSetId": {} + } + } + }, + "DeleteChangeSet": { + "input": { + "type": "structure", + "required": [ + "ChangeSetName" + ], + "members": { + "ChangeSetName": {}, + "StackName": {} + } + }, + "output": { + "resultWrapper": "DeleteChangeSetResult", + "type": "structure", + "members": {} + } + }, + "DeleteStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "RetainResources": { + "type": "list", + "member": {} + }, + "RoleARN": {}, + "ClientRequestToken": {} + } + } + }, + "DeleteStackInstances": { + "input": { + "type": "structure", + "required": [ + "StackSetName", + "Accounts", + "Regions", + "RetainStacks" + ], + "members": { + "StackSetName": {}, + "Accounts": { + "shape": "S1g" + }, + "Regions": { + "shape": "S1i" + }, + "OperationPreferences": { + "shape": "S1k" + }, + "RetainStacks": { + "type": "boolean" + }, + "OperationId": { + "idempotencyToken": true + } + } + }, + "output": { + "resultWrapper": "DeleteStackInstancesResult", + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "DeleteStackSet": { + "input": { + "type": "structure", + "required": [ + "StackSetName" + ], + "members": { + "StackSetName": {} + } + }, + "output": { + "resultWrapper": "DeleteStackSetResult", + "type": "structure", + "members": {} + } + }, + "DescribeAccountLimits": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeAccountLimitsResult", + "type": "structure", + "members": { + "AccountLimits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Value": { + "type": "integer" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeChangeSet": { + "input": { + "type": "structure", + "required": [ + "ChangeSetName" + ], + "members": { + "ChangeSetName": {}, + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeChangeSetResult", + "type": "structure", + "members": { + "ChangeSetName": {}, + "ChangeSetId": {}, + "StackId": {}, + "StackName": {}, + "Description": {}, + "Parameters": { + "shape": "Se" + }, + "CreationTime": { + "type": "timestamp" + }, + "ExecutionStatus": {}, + "Status": {}, + "StatusReason": {}, + "NotificationARNs": { + "shape": "St" + }, + "RollbackConfiguration": { + "shape": "Sn" + }, + "Capabilities": { + "shape": "Sj" + }, + "Tags": { + "shape": "Sv" + }, + "Changes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "ResourceChange": { + "type": "structure", + "members": { + "Action": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "Replacement": {}, + "Scope": { + "type": "list", + "member": {} + }, + "Details": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Target": { + "type": "structure", + "members": { + "Attribute": {}, + "Name": {}, + "RequiresRecreation": {} + } + }, + "Evaluation": {}, + "ChangeSource": {}, + "CausingEntity": {} + } + } + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeStackDriftDetectionStatus": { + "input": { + "type": "structure", + "required": [ + "StackDriftDetectionId" + ], + "members": { + "StackDriftDetectionId": {} + } + }, + "output": { + "resultWrapper": "DescribeStackDriftDetectionStatusResult", + "type": "structure", + "required": [ + "StackId", + "StackDriftDetectionId", + "DetectionStatus", + "Timestamp" + ], + "members": { + "StackId": {}, + "StackDriftDetectionId": {}, + "StackDriftStatus": {}, + "DetectionStatus": {}, + "DetectionStatusReason": {}, + "DriftedStackResourceCount": { + "type": "integer" + }, + "Timestamp": { + "type": "timestamp" + } + } + } + }, + "DescribeStackEvents": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeStackEventsResult", + "type": "structure", + "members": { + "StackEvents": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StackId", + "EventId", + "StackName", + "Timestamp" + ], + "members": { + "StackId": {}, + "EventId": {}, + "StackName": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "Timestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {}, + "ResourceProperties": {}, + "ClientRequestToken": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeStackInstance": { + "input": { + "type": "structure", + "required": [ + "StackSetName", + "StackInstanceAccount", + "StackInstanceRegion" + ], + "members": { + "StackSetName": {}, + "StackInstanceAccount": {}, + "StackInstanceRegion": {} + } + }, + "output": { + "resultWrapper": "DescribeStackInstanceResult", + "type": "structure", + "members": { + "StackInstance": { + "type": "structure", + "members": { + "StackSetId": {}, + "Region": {}, + "Account": {}, + "StackId": {}, + "ParameterOverrides": { + "shape": "Se" + }, + "Status": {}, + "StatusReason": {} + } + } + } + } + }, + "DescribeStackResource": { + "input": { + "type": "structure", + "required": [ + "StackName", + "LogicalResourceId" + ], + "members": { + "StackName": {}, + "LogicalResourceId": {} + } + }, + "output": { + "resultWrapper": "DescribeStackResourceResult", + "type": "structure", + "members": { + "StackResourceDetail": { + "type": "structure", + "required": [ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members": { + "StackName": {}, + "StackId": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "LastUpdatedTimestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {}, + "Description": {}, + "Metadata": {}, + "DriftInformation": { + "shape": "S3o" + } + } + } + } + } + }, + "DescribeStackResourceDrifts": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "StackResourceDriftStatusFilters": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeStackResourceDriftsResult", + "type": "structure", + "required": [ + "StackResourceDrifts" + ], + "members": { + "StackResourceDrifts": { + "type": "list", + "member": { + "shape": "S3v" + } + }, + "NextToken": {} + } + } + }, + "DescribeStackResources": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {} + } + }, + "output": { + "resultWrapper": "DescribeStackResourcesResult", + "type": "structure", + "members": { + "StackResources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LogicalResourceId", + "ResourceType", + "Timestamp", + "ResourceStatus" + ], + "members": { + "StackName": {}, + "StackId": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "Timestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {}, + "Description": {}, + "DriftInformation": { + "shape": "S3o" + } + } + } + } + } + } + }, + "DescribeStackSet": { + "input": { + "type": "structure", + "required": [ + "StackSetName" + ], + "members": { + "StackSetName": {} + } + }, + "output": { + "resultWrapper": "DescribeStackSetResult", + "type": "structure", + "members": { + "StackSet": { + "type": "structure", + "members": { + "StackSetName": {}, + "StackSetId": {}, + "Description": {}, + "Status": {}, + "TemplateBody": {}, + "Parameters": { + "shape": "Se" + }, + "Capabilities": { + "shape": "Sj" + }, + "Tags": { + "shape": "Sv" + }, + "StackSetARN": {}, + "AdministrationRoleARN": {}, + "ExecutionRoleName": {} + } + } + } + } + }, + "DescribeStackSetOperation": { + "input": { + "type": "structure", + "required": [ + "StackSetName", + "OperationId" + ], + "members": { + "StackSetName": {}, + "OperationId": {} + } + }, + "output": { + "resultWrapper": "DescribeStackSetOperationResult", + "type": "structure", + "members": { + "StackSetOperation": { + "type": "structure", + "members": { + "OperationId": {}, + "StackSetId": {}, + "Action": {}, + "Status": {}, + "OperationPreferences": { + "shape": "S1k" + }, + "RetainStacks": { + "type": "boolean" + }, + "AdministrationRoleARN": {}, + "ExecutionRoleName": {}, + "CreationTimestamp": { + "type": "timestamp" + }, + "EndTimestamp": { + "type": "timestamp" + } + } + } + } + } + }, + "DescribeStacks": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeStacksResult", + "type": "structure", + "members": { + "Stacks": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StackName", + "CreationTime", + "StackStatus" + ], + "members": { + "StackId": {}, + "StackName": {}, + "ChangeSetId": {}, + "Description": {}, + "Parameters": { + "shape": "Se" + }, + "CreationTime": { + "type": "timestamp" + }, + "DeletionTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + }, + "RollbackConfiguration": { + "shape": "Sn" + }, + "StackStatus": {}, + "StackStatusReason": {}, + "DisableRollback": { + "type": "boolean" + }, + "NotificationARNs": { + "shape": "St" + }, + "TimeoutInMinutes": { + "type": "integer" + }, + "Capabilities": { + "shape": "Sj" + }, + "Outputs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "OutputKey": {}, + "OutputValue": {}, + "Description": {}, + "ExportName": {} + } + } + }, + "RoleARN": {}, + "Tags": { + "shape": "Sv" + }, + "EnableTerminationProtection": { + "type": "boolean" + }, + "ParentId": {}, + "RootId": {}, + "DriftInformation": { + "type": "structure", + "required": [ + "StackDriftStatus" + ], + "members": { + "StackDriftStatus": {}, + "LastCheckTimestamp": { + "type": "timestamp" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DetectStackDrift": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "LogicalResourceIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DetectStackDriftResult", + "type": "structure", + "required": [ + "StackDriftDetectionId" + ], + "members": { + "StackDriftDetectionId": {} + } + } + }, + "DetectStackResourceDrift": { + "input": { + "type": "structure", + "required": [ + "StackName", + "LogicalResourceId" + ], + "members": { + "StackName": {}, + "LogicalResourceId": {} + } + }, + "output": { + "resultWrapper": "DetectStackResourceDriftResult", + "type": "structure", + "required": [ + "StackResourceDrift" + ], + "members": { + "StackResourceDrift": { + "shape": "S3v" + } + } + } + }, + "EstimateTemplateCost": { + "input": { + "type": "structure", + "members": { + "TemplateBody": {}, + "TemplateURL": {}, + "Parameters": { + "shape": "Se" + } + } + }, + "output": { + "resultWrapper": "EstimateTemplateCostResult", + "type": "structure", + "members": { + "Url": {} + } + } + }, + "ExecuteChangeSet": { + "input": { + "type": "structure", + "required": [ + "ChangeSetName" + ], + "members": { + "ChangeSetName": {}, + "StackName": {}, + "ClientRequestToken": {} + } + }, + "output": { + "resultWrapper": "ExecuteChangeSetResult", + "type": "structure", + "members": {} + } + }, + "GetStackPolicy": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {} + } + }, + "output": { + "resultWrapper": "GetStackPolicyResult", + "type": "structure", + "members": { + "StackPolicyBody": {} + } + } + }, + "GetTemplate": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "ChangeSetName": {}, + "TemplateStage": {} + } + }, + "output": { + "resultWrapper": "GetTemplateResult", + "type": "structure", + "members": { + "TemplateBody": {}, + "StagesAvailable": { + "type": "list", + "member": {} + } + } + } + }, + "GetTemplateSummary": { + "input": { + "type": "structure", + "members": { + "TemplateBody": {}, + "TemplateURL": {}, + "StackName": {}, + "StackSetName": {} + } + }, + "output": { + "resultWrapper": "GetTemplateSummaryResult", + "type": "structure", + "members": { + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterKey": {}, + "DefaultValue": {}, + "ParameterType": {}, + "NoEcho": { + "type": "boolean" + }, + "Description": {}, + "ParameterConstraints": { + "type": "structure", + "members": { + "AllowedValues": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "Description": {}, + "Capabilities": { + "shape": "Sj" + }, + "CapabilitiesReason": {}, + "ResourceTypes": { + "shape": "Sl" + }, + "Version": {}, + "Metadata": {}, + "DeclaredTransforms": { + "shape": "S5r" + } + } + } + }, + "ListChangeSets": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListChangeSetsResult", + "type": "structure", + "members": { + "Summaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackId": {}, + "StackName": {}, + "ChangeSetId": {}, + "ChangeSetName": {}, + "ExecutionStatus": {}, + "Status": {}, + "StatusReason": {}, + "CreationTime": { + "type": "timestamp" + }, + "Description": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListExports": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListExportsResult", + "type": "structure", + "members": { + "Exports": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ExportingStackId": {}, + "Name": {}, + "Value": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListImports": { + "input": { + "type": "structure", + "required": [ + "ExportName" + ], + "members": { + "ExportName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListImportsResult", + "type": "structure", + "members": { + "Imports": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListStackInstances": { + "input": { + "type": "structure", + "required": [ + "StackSetName" + ], + "members": { + "StackSetName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "StackInstanceAccount": {}, + "StackInstanceRegion": {} + } + }, + "output": { + "resultWrapper": "ListStackInstancesResult", + "type": "structure", + "members": { + "Summaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackSetId": {}, + "Region": {}, + "Account": {}, + "StackId": {}, + "Status": {}, + "StatusReason": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListStackResources": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListStackResourcesResult", + "type": "structure", + "members": { + "StackResourceSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members": { + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "LastUpdatedTimestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {}, + "DriftInformation": { + "type": "structure", + "required": [ + "StackResourceDriftStatus" + ], + "members": { + "StackResourceDriftStatus": {}, + "LastCheckTimestamp": { + "type": "timestamp" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "ListStackSetOperationResults": { + "input": { + "type": "structure", + "required": [ + "StackSetName", + "OperationId" + ], + "members": { + "StackSetName": {}, + "OperationId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListStackSetOperationResultsResult", + "type": "structure", + "members": { + "Summaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Account": {}, + "Region": {}, + "Status": {}, + "StatusReason": {}, + "AccountGateResult": { + "type": "structure", + "members": { + "Status": {}, + "StatusReason": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "ListStackSetOperations": { + "input": { + "type": "structure", + "required": [ + "StackSetName" + ], + "members": { + "StackSetName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListStackSetOperationsResult", + "type": "structure", + "members": { + "Summaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "OperationId": {}, + "Action": {}, + "Status": {}, + "CreationTimestamp": { + "type": "timestamp" + }, + "EndTimestamp": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListStackSets": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Status": {} + } + }, + "output": { + "resultWrapper": "ListStackSetsResult", + "type": "structure", + "members": { + "Summaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackSetName": {}, + "StackSetId": {}, + "Description": {}, + "Status": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListStacks": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "StackStatusFilter": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "ListStacksResult", + "type": "structure", + "members": { + "StackSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StackName", + "CreationTime", + "StackStatus" + ], + "members": { + "StackId": {}, + "StackName": {}, + "TemplateDescription": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + }, + "DeletionTime": { + "type": "timestamp" + }, + "StackStatus": {}, + "StackStatusReason": {}, + "ParentId": {}, + "RootId": {}, + "DriftInformation": { + "type": "structure", + "required": [ + "StackDriftStatus" + ], + "members": { + "StackDriftStatus": {}, + "LastCheckTimestamp": { + "type": "timestamp" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "SetStackPolicy": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "StackPolicyBody": {}, + "StackPolicyURL": {} + } + } + }, + "SignalResource": { + "input": { + "type": "structure", + "required": [ + "StackName", + "LogicalResourceId", + "UniqueId", + "Status" + ], + "members": { + "StackName": {}, + "LogicalResourceId": {}, + "UniqueId": {}, + "Status": {} + } + } + }, + "StopStackSetOperation": { + "input": { + "type": "structure", + "required": [ + "StackSetName", + "OperationId" + ], + "members": { + "StackSetName": {}, + "OperationId": {} + } + }, + "output": { + "resultWrapper": "StopStackSetOperationResult", + "type": "structure", + "members": {} + } + }, + "UpdateStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "TemplateBody": {}, + "TemplateURL": {}, + "UsePreviousTemplate": { + "type": "boolean" + }, + "StackPolicyDuringUpdateBody": {}, + "StackPolicyDuringUpdateURL": {}, + "Parameters": { + "shape": "Se" + }, + "Capabilities": { + "shape": "Sj" + }, + "ResourceTypes": { + "shape": "Sl" + }, + "RoleARN": {}, + "RollbackConfiguration": { + "shape": "Sn" + }, + "StackPolicyBody": {}, + "StackPolicyURL": {}, + "NotificationARNs": { + "shape": "St" + }, + "Tags": { + "shape": "Sv" + }, + "ClientRequestToken": {} + } + }, + "output": { + "resultWrapper": "UpdateStackResult", + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "UpdateStackInstances": { + "input": { + "type": "structure", + "required": [ + "StackSetName", + "Accounts", + "Regions" + ], + "members": { + "StackSetName": {}, + "Accounts": { + "shape": "S1g" + }, + "Regions": { + "shape": "S1i" + }, + "ParameterOverrides": { + "shape": "Se" + }, + "OperationPreferences": { + "shape": "S1k" + }, + "OperationId": { + "idempotencyToken": true + } + } + }, + "output": { + "resultWrapper": "UpdateStackInstancesResult", + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "UpdateStackSet": { + "input": { + "type": "structure", + "required": [ + "StackSetName" + ], + "members": { + "StackSetName": {}, + "Description": {}, + "TemplateBody": {}, + "TemplateURL": {}, + "UsePreviousTemplate": { + "type": "boolean" + }, + "Parameters": { + "shape": "Se" + }, + "Capabilities": { + "shape": "Sj" + }, + "Tags": { + "shape": "Sv" + }, + "OperationPreferences": { + "shape": "S1k" + }, + "AdministrationRoleARN": {}, + "ExecutionRoleName": {}, + "OperationId": { + "idempotencyToken": true + }, + "Accounts": { + "shape": "S1g" + }, + "Regions": { + "shape": "S1i" + } + } + }, + "output": { + "resultWrapper": "UpdateStackSetResult", + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "UpdateTerminationProtection": { + "input": { + "type": "structure", + "required": [ + "EnableTerminationProtection", + "StackName" + ], + "members": { + "EnableTerminationProtection": { + "type": "boolean" + }, + "StackName": {} + } + }, + "output": { + "resultWrapper": "UpdateTerminationProtectionResult", + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "ValidateTemplate": { + "input": { + "type": "structure", + "members": { + "TemplateBody": {}, + "TemplateURL": {} + } + }, + "output": { + "resultWrapper": "ValidateTemplateResult", + "type": "structure", + "members": { + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterKey": {}, + "DefaultValue": {}, + "NoEcho": { + "type": "boolean" + }, + "Description": {} + } + } + }, + "Description": {}, + "Capabilities": { + "shape": "Sj" + }, + "CapabilitiesReason": {}, + "DeclaredTransforms": { + "shape": "S5r" + } + } + } + } + }, + "shapes": { + "Se": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterKey": {}, + "ParameterValue": {}, + "UsePreviousValue": { + "type": "boolean" + }, + "ResolvedValue": {} + } + } + }, + "Sj": { + "type": "list", + "member": {} + }, + "Sl": { + "type": "list", + "member": {} + }, + "Sn": { + "type": "structure", + "members": { + "RollbackTriggers": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Arn", + "Type" + ], + "members": { + "Arn": {}, + "Type": {} + } + } + }, + "MonitoringTimeInMinutes": { + "type": "integer" + } + } + }, + "St": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S1g": { + "type": "list", + "member": {} + }, + "S1i": { + "type": "list", + "member": {} + }, + "S1k": { + "type": "structure", + "members": { + "RegionOrder": { + "shape": "S1i" + }, + "FailureToleranceCount": { + "type": "integer" + }, + "FailureTolerancePercentage": { + "type": "integer" + }, + "MaxConcurrentCount": { + "type": "integer" + }, + "MaxConcurrentPercentage": { + "type": "integer" + } + } + }, + "S3o": { + "type": "structure", + "required": [ + "StackResourceDriftStatus" + ], + "members": { + "StackResourceDriftStatus": {}, + "LastCheckTimestamp": { + "type": "timestamp" + } + } + }, + "S3v": { + "type": "structure", + "required": [ + "StackId", + "LogicalResourceId", + "ResourceType", + "StackResourceDriftStatus", + "Timestamp" + ], + "members": { + "StackId": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "PhysicalResourceIdContext": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "ResourceType": {}, + "ExpectedProperties": {}, + "ActualProperties": {}, + "PropertyDifferences": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "PropertyPath", + "ExpectedValue", + "ActualValue", + "DifferenceType" + ], + "members": { + "PropertyPath": {}, + "ExpectedValue": {}, + "ActualValue": {}, + "DifferenceType": {} + } + } + }, + "StackResourceDriftStatus": {}, + "Timestamp": { + "type": "timestamp" + } + } + }, + "S5r": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudformation-2010-05-15.paginators.json b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.paginators.json new file mode 100644 index 0000000..51df4af --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.paginators.json @@ -0,0 +1,42 @@ +{ + "pagination": { + "DescribeStackEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackEvents" + }, + "DescribeStackResourceDrifts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "DescribeStackResources": { + "result_key": "StackResources" + }, + "DescribeStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Stacks" + }, + "ListExports": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Exports" + }, + "ListImports": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Imports" + }, + "ListStackResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackResourceSummaries" + }, + "ListStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackSummaries" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudformation-2010-05-15.waiters2.json b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.waiters2.json new file mode 100644 index 0000000..4e8c828 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudformation-2010-05-15.waiters2.json @@ -0,0 +1,182 @@ +{ + "version": 2, + "waiters": { + "StackExists": { + "delay": 5, + "operation": "DescribeStacks", + "maxAttempts": 20, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "ValidationError", + "state": "retry" + } + ] + }, + "StackCreateComplete": { + "delay": 30, + "operation": "DescribeStacks", + "maxAttempts": 120, + "description": "Wait until stack status is CREATE_COMPLETE.", + "acceptors": [ + { + "argument": "Stacks[].StackStatus", + "expected": "CREATE_COMPLETE", + "matcher": "pathAll", + "state": "success" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "CREATE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_COMPLETE", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "ROLLBACK_COMPLETE", + "matcher": "pathAny", + "state": "failure" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + }, + "StackDeleteComplete": { + "delay": 30, + "operation": "DescribeStacks", + "maxAttempts": 120, + "description": "Wait until stack status is DELETE_COMPLETE.", + "acceptors": [ + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_COMPLETE", + "matcher": "pathAll", + "state": "success" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "success" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "CREATE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_ROLLBACK_IN_PROGRESS", + "matcher": "pathAny", + "state": "failure" + } + ] + }, + "StackUpdateComplete": { + "delay": 30, + "maxAttempts": 120, + "operation": "DescribeStacks", + "description": "Wait until stack status is UPDATE_COMPLETE.", + "acceptors": [ + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_COMPLETE", + "matcher": "pathAll", + "state": "success" + }, + { + "expected": "UPDATE_FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Stacks[].StackStatus" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "expected": "UPDATE_ROLLBACK_COMPLETE", + "matcher": "pathAny", + "state": "failure", + "argument": "Stacks[].StackStatus" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + }, + "ChangeSetCreateComplete": { + "delay": 30, + "operation": "DescribeChangeSet", + "maxAttempts": 120, + "description": "Wait until change set status is CREATE_COMPLETE.", + "acceptors": [ + { + "argument": "Status", + "expected": "CREATE_COMPLETE", + "matcher": "path", + "state": "success" + }, + { + "argument": "Status", + "expected": "FAILED", + "matcher": "path", + "state": "failure" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2016-11-25.min.json b/node_modules/aws-sdk/apis/cloudfront-2016-11-25.min.json new file mode 100644 index 0000000..c39d6be --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2016-11-25.min.json @@ -0,0 +1,1913 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-25", + "endpointPrefix": "cloudfront", + "globalEndpoint": "cloudfront.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "CloudFront", + "serviceFullName": "Amazon CloudFront", + "serviceId": "CloudFront", + "signatureVersion": "v4", + "uid": "cloudfront-2016-11-25" + }, + "operations": { + "CreateCloudFrontOriginAccessIdentity": { + "http": { + "requestUri": "/2016-11-25/origin-access-identity/cloudfront", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "CreateDistribution": { + "http": { + "requestUri": "/2016-11-25/distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateDistributionWithTags": { + "http": { + "requestUri": "/2016-11-25/distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfigWithTags" + ], + "members": { + "DistributionConfigWithTags": { + "locationName": "DistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + }, + "type": "structure", + "required": [ + "DistributionConfig", + "Tags" + ], + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "Tags": { + "shape": "S21" + } + } + } + }, + "payload": "DistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateInvalidation": { + "http": { + "requestUri": "/2016-11-25/distribution/{DistributionId}/invalidation", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "InvalidationBatch" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "InvalidationBatch": { + "shape": "S28", + "locationName": "InvalidationBatch", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + } + }, + "payload": "InvalidationBatch" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + }, + "Invalidation": { + "shape": "S2c" + } + }, + "payload": "Invalidation" + } + }, + "CreateStreamingDistribution": { + "http": { + "requestUri": "/2016-11-25/streaming-distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S2e", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "CreateStreamingDistributionWithTags": { + "http": { + "requestUri": "/2016-11-25/streaming-distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfigWithTags" + ], + "members": { + "StreamingDistributionConfigWithTags": { + "locationName": "StreamingDistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + }, + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Tags" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S2e" + }, + "Tags": { + "shape": "S21" + } + } + } + }, + "payload": "StreamingDistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "DeleteCloudFrontOriginAccessIdentity": { + "http": { + "method": "DELETE", + "requestUri": "/2016-11-25/origin-access-identity/cloudfront/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2016-11-25/distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteStreamingDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2016-11-25/streaming-distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "GetCloudFrontOriginAccessIdentity": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/origin-access-identity/cloudfront/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "GetCloudFrontOriginAccessIdentityConfig": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + } + }, + "GetDistribution": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "GetDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "DistributionConfig" + } + }, + "GetInvalidation": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/distribution/{DistributionId}/invalidation/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "Id" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invalidation": { + "shape": "S2c" + } + }, + "payload": "Invalidation" + } + }, + "GetStreamingDistribution": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/streaming-distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "GetStreamingDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionConfig": { + "shape": "S2e" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistributionConfig" + } + }, + "ListCloudFrontOriginAccessIdentities": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/origin-access-identity/cloudfront" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CloudFrontOriginAccessIdentitySummary", + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "CloudFrontOriginAccessIdentityList" + } + }, + "ListDistributions": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S3a" + } + }, + "payload": "DistributionList" + } + }, + "ListDistributionsByWebACLId": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/distributionsByWebACLId/{WebACLId}" + }, + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + }, + "WebACLId": { + "location": "uri", + "locationName": "WebACLId" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S3a" + } + }, + "payload": "DistributionList" + } + }, + "ListInvalidations": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/distribution/{DistributionId}/invalidation" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "InvalidationList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "InvalidationSummary", + "type": "structure", + "required": [ + "Id", + "CreateTime", + "Status" + ], + "members": { + "Id": {}, + "CreateTime": { + "type": "timestamp" + }, + "Status": {} + } + } + } + } + } + }, + "payload": "InvalidationList" + } + }, + "ListStreamingDistributions": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/streaming-distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "StreamingDistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "S3Origin": { + "shape": "S2f" + }, + "Aliases": { + "shape": "S8" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "payload": "StreamingDistributionList" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2016-11-25/tagging" + }, + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S21" + } + }, + "payload": "Tags" + } + }, + "TagResource": { + "http": { + "requestUri": "/2016-11-25/tagging?Operation=Tag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "Tags" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "Tags": { + "shape": "S21", + "locationName": "Tags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + } + }, + "payload": "Tags" + } + }, + "UntagResource": { + "http": { + "requestUri": "/2016-11-25/tagging?Operation=Untag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "TagKeys" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "TagKeys": { + "locationName": "TagKeys", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + }, + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Key" + } + } + } + } + }, + "payload": "TagKeys" + } + }, + "UpdateCloudFrontOriginAccessIdentity": { + "http": { + "method": "PUT", + "requestUri": "/2016-11-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "UpdateDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2016-11-25/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig", + "Id" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "UpdateStreamingDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2016-11-25/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Id" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S2e", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2016-11-25/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "CallerReference", + "Comment" + ], + "members": { + "CallerReference": {}, + "Comment": {} + } + }, + "S5": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + } + } + }, + "S7": { + "type": "structure", + "required": [ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members": { + "CallerReference": {}, + "Aliases": { + "shape": "S8" + }, + "DefaultRootObject": {}, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1a" + }, + "CustomErrorResponses": { + "shape": "S1d" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "IncludeCookies": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1i" + }, + "Restrictions": { + "shape": "S1m" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + }, + "S8": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CNAME" + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Origin", + "type": "structure", + "required": [ + "Id", + "DomainName" + ], + "members": { + "Id": {}, + "DomainName": {}, + "OriginPath": {}, + "CustomHeaders": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "OriginCustomHeader", + "type": "structure", + "required": [ + "HeaderName", + "HeaderValue" + ], + "members": { + "HeaderName": {}, + "HeaderValue": {} + } + } + } + } + }, + "S3OriginConfig": { + "type": "structure", + "required": [ + "OriginAccessIdentity" + ], + "members": { + "OriginAccessIdentity": {} + } + }, + "CustomOriginConfig": { + "type": "structure", + "required": [ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members": { + "HTTPPort": { + "type": "integer" + }, + "HTTPSPort": { + "type": "integer" + }, + "OriginProtocolPolicy": {}, + "OriginSslProtocols": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "SslProtocol" + } + } + } + } + } + } + } + } + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + } + } + }, + "So": { + "type": "structure", + "required": [ + "QueryString", + "Cookies" + ], + "members": { + "QueryString": { + "type": "boolean" + }, + "Cookies": { + "type": "structure", + "required": [ + "Forward" + ], + "members": { + "Forward": {}, + "WhitelistedNames": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Headers": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + }, + "QueryStringCacheKeys": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "AwsAccountNumber" + } + } + } + }, + "S12": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + }, + "CachedMethods": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + } + } + } + } + }, + "S13": { + "type": "list", + "member": { + "locationName": "Method" + } + }, + "S16": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "LambdaFunctionAssociation", + "type": "structure", + "members": { + "LambdaFunctionARN": {}, + "EventType": {} + } + } + } + } + }, + "S1a": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CacheBehavior", + "type": "structure", + "required": [ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "PathPattern": {}, + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + } + } + } + } + } + }, + "S1d": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CustomErrorResponse", + "type": "structure", + "required": [ + "ErrorCode" + ], + "members": { + "ErrorCode": { + "type": "integer" + }, + "ResponsePagePath": {}, + "ResponseCode": {}, + "ErrorCachingMinTTL": { + "type": "long" + } + } + } + } + } + }, + "S1i": { + "type": "structure", + "members": { + "CloudFrontDefaultCertificate": { + "type": "boolean" + }, + "IAMCertificateId": {}, + "ACMCertificateArn": {}, + "SSLSupportMethod": {}, + "MinimumProtocolVersion": {}, + "Certificate": { + "deprecated": true + }, + "CertificateSource": { + "deprecated": true + } + } + }, + "S1m": { + "type": "structure", + "required": [ + "GeoRestriction" + ], + "members": { + "GeoRestriction": { + "type": "structure", + "required": [ + "RestrictionType", + "Quantity" + ], + "members": { + "RestrictionType": {}, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Location" + } + } + } + } + } + }, + "S1s": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "InProgressInvalidationBatches": { + "type": "integer" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1u" + }, + "DistributionConfig": { + "shape": "S7" + } + } + }, + "S1u": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Signer", + "type": "structure", + "members": { + "AwsAccountNumber": {}, + "KeyPairIds": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "KeyPairId" + } + } + } + } + } + } + } + } + }, + "S21": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "S28": { + "type": "structure", + "required": [ + "Paths", + "CallerReference" + ], + "members": { + "Paths": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Path" + } + } + } + }, + "CallerReference": {} + } + }, + "S2c": { + "type": "structure", + "required": [ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members": { + "Id": {}, + "Status": {}, + "CreateTime": { + "type": "timestamp" + }, + "InvalidationBatch": { + "shape": "S28" + } + } + }, + "S2e": { + "type": "structure", + "required": [ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members": { + "CallerReference": {}, + "S3Origin": { + "shape": "S2f" + }, + "Aliases": { + "shape": "S8" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "TrustedSigners": { + "shape": "Sy" + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "S2f": { + "type": "structure", + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "members": { + "DomainName": {}, + "OriginAccessIdentity": {} + } + }, + "S2i": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1u" + }, + "StreamingDistributionConfig": { + "shape": "S2e" + } + } + }, + "S3a": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "DistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "Aliases": { + "shape": "S8" + }, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1a" + }, + "CustomErrorResponses": { + "shape": "S1d" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1i" + }, + "Restrictions": { + "shape": "S1m" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2016-11-25.paginators.json b/node_modules/aws-sdk/apis/cloudfront-2016-11-25.paginators.json new file mode 100644 index 0000000..51fbb90 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2016-11-25.paginators.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2016-11-25.waiters2.json b/node_modules/aws-sdk/apis/cloudfront-2016-11-25.waiters2.json new file mode 100644 index 0000000..edd74b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2016-11-25.waiters2.json @@ -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" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2017-03-25.min.json b/node_modules/aws-sdk/apis/cloudfront-2017-03-25.min.json new file mode 100644 index 0000000..0e6547d --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2017-03-25.min.json @@ -0,0 +1,1938 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-03-25", + "endpointPrefix": "cloudfront", + "globalEndpoint": "cloudfront.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "CloudFront", + "serviceFullName": "Amazon CloudFront", + "serviceId": "CloudFront", + "signatureVersion": "v4", + "uid": "cloudfront-2017-03-25" + }, + "operations": { + "CreateCloudFrontOriginAccessIdentity": { + "http": { + "requestUri": "/2017-03-25/origin-access-identity/cloudfront", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "CreateDistribution": { + "http": { + "requestUri": "/2017-03-25/distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateDistributionWithTags": { + "http": { + "requestUri": "/2017-03-25/distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfigWithTags" + ], + "members": { + "DistributionConfigWithTags": { + "locationName": "DistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + }, + "type": "structure", + "required": [ + "DistributionConfig", + "Tags" + ], + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "Tags": { + "shape": "S21" + } + } + } + }, + "payload": "DistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateInvalidation": { + "http": { + "requestUri": "/2017-03-25/distribution/{DistributionId}/invalidation", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "InvalidationBatch" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "InvalidationBatch": { + "shape": "S28", + "locationName": "InvalidationBatch", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + } + }, + "payload": "InvalidationBatch" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + }, + "Invalidation": { + "shape": "S2c" + } + }, + "payload": "Invalidation" + } + }, + "CreateStreamingDistribution": { + "http": { + "requestUri": "/2017-03-25/streaming-distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S2e", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "CreateStreamingDistributionWithTags": { + "http": { + "requestUri": "/2017-03-25/streaming-distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfigWithTags" + ], + "members": { + "StreamingDistributionConfigWithTags": { + "locationName": "StreamingDistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + }, + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Tags" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S2e" + }, + "Tags": { + "shape": "S21" + } + } + } + }, + "payload": "StreamingDistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "DeleteCloudFrontOriginAccessIdentity": { + "http": { + "method": "DELETE", + "requestUri": "/2017-03-25/origin-access-identity/cloudfront/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2017-03-25/distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteServiceLinkedRole": { + "http": { + "method": "DELETE", + "requestUri": "/2017-03-25/service-linked-role/{RoleName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": { + "location": "uri", + "locationName": "RoleName" + } + } + } + }, + "DeleteStreamingDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2017-03-25/streaming-distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "GetCloudFrontOriginAccessIdentity": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/origin-access-identity/cloudfront/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "GetCloudFrontOriginAccessIdentityConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + } + }, + "GetDistribution": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "GetDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "DistributionConfig" + } + }, + "GetInvalidation": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/distribution/{DistributionId}/invalidation/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "Id" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invalidation": { + "shape": "S2c" + } + }, + "payload": "Invalidation" + } + }, + "GetStreamingDistribution": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/streaming-distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "GetStreamingDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionConfig": { + "shape": "S2e" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistributionConfig" + } + }, + "ListCloudFrontOriginAccessIdentities": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/origin-access-identity/cloudfront" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CloudFrontOriginAccessIdentitySummary", + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "CloudFrontOriginAccessIdentityList" + } + }, + "ListDistributions": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S3b" + } + }, + "payload": "DistributionList" + } + }, + "ListDistributionsByWebACLId": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/distributionsByWebACLId/{WebACLId}" + }, + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + }, + "WebACLId": { + "location": "uri", + "locationName": "WebACLId" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S3b" + } + }, + "payload": "DistributionList" + } + }, + "ListInvalidations": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/distribution/{DistributionId}/invalidation" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "InvalidationList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "InvalidationSummary", + "type": "structure", + "required": [ + "Id", + "CreateTime", + "Status" + ], + "members": { + "Id": {}, + "CreateTime": { + "type": "timestamp" + }, + "Status": {} + } + } + } + } + } + }, + "payload": "InvalidationList" + } + }, + "ListStreamingDistributions": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/streaming-distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "StreamingDistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "S3Origin": { + "shape": "S2f" + }, + "Aliases": { + "shape": "S8" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "payload": "StreamingDistributionList" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2017-03-25/tagging" + }, + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S21" + } + }, + "payload": "Tags" + } + }, + "TagResource": { + "http": { + "requestUri": "/2017-03-25/tagging?Operation=Tag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "Tags" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "Tags": { + "shape": "S21", + "locationName": "Tags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + } + }, + "payload": "Tags" + } + }, + "UntagResource": { + "http": { + "requestUri": "/2017-03-25/tagging?Operation=Untag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "TagKeys" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "TagKeys": { + "locationName": "TagKeys", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + }, + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Key" + } + } + } + } + }, + "payload": "TagKeys" + } + }, + "UpdateCloudFrontOriginAccessIdentity": { + "http": { + "method": "PUT", + "requestUri": "/2017-03-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "UpdateDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2017-03-25/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig", + "Id" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1s" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "UpdateStreamingDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2017-03-25/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Id" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S2e", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-03-25/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S2i" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "CallerReference", + "Comment" + ], + "members": { + "CallerReference": {}, + "Comment": {} + } + }, + "S5": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + } + } + }, + "S7": { + "type": "structure", + "required": [ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members": { + "CallerReference": {}, + "Aliases": { + "shape": "S8" + }, + "DefaultRootObject": {}, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1a" + }, + "CustomErrorResponses": { + "shape": "S1d" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "IncludeCookies": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1i" + }, + "Restrictions": { + "shape": "S1m" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + }, + "S8": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CNAME" + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Origin", + "type": "structure", + "required": [ + "Id", + "DomainName" + ], + "members": { + "Id": {}, + "DomainName": {}, + "OriginPath": {}, + "CustomHeaders": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "OriginCustomHeader", + "type": "structure", + "required": [ + "HeaderName", + "HeaderValue" + ], + "members": { + "HeaderName": {}, + "HeaderValue": {} + } + } + } + } + }, + "S3OriginConfig": { + "type": "structure", + "required": [ + "OriginAccessIdentity" + ], + "members": { + "OriginAccessIdentity": {} + } + }, + "CustomOriginConfig": { + "type": "structure", + "required": [ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members": { + "HTTPPort": { + "type": "integer" + }, + "HTTPSPort": { + "type": "integer" + }, + "OriginProtocolPolicy": {}, + "OriginSslProtocols": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "SslProtocol" + } + } + } + }, + "OriginReadTimeout": { + "type": "integer" + }, + "OriginKeepaliveTimeout": { + "type": "integer" + } + } + } + } + } + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + } + } + }, + "So": { + "type": "structure", + "required": [ + "QueryString", + "Cookies" + ], + "members": { + "QueryString": { + "type": "boolean" + }, + "Cookies": { + "type": "structure", + "required": [ + "Forward" + ], + "members": { + "Forward": {}, + "WhitelistedNames": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Headers": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + }, + "QueryStringCacheKeys": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "AwsAccountNumber" + } + } + } + }, + "S12": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + }, + "CachedMethods": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + } + } + } + } + }, + "S13": { + "type": "list", + "member": { + "locationName": "Method" + } + }, + "S16": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "LambdaFunctionAssociation", + "type": "structure", + "members": { + "LambdaFunctionARN": {}, + "EventType": {} + } + } + } + } + }, + "S1a": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CacheBehavior", + "type": "structure", + "required": [ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "PathPattern": {}, + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + } + } + } + } + } + }, + "S1d": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CustomErrorResponse", + "type": "structure", + "required": [ + "ErrorCode" + ], + "members": { + "ErrorCode": { + "type": "integer" + }, + "ResponsePagePath": {}, + "ResponseCode": {}, + "ErrorCachingMinTTL": { + "type": "long" + } + } + } + } + } + }, + "S1i": { + "type": "structure", + "members": { + "CloudFrontDefaultCertificate": { + "type": "boolean" + }, + "IAMCertificateId": {}, + "ACMCertificateArn": {}, + "SSLSupportMethod": {}, + "MinimumProtocolVersion": {}, + "Certificate": { + "deprecated": true + }, + "CertificateSource": { + "deprecated": true + } + } + }, + "S1m": { + "type": "structure", + "required": [ + "GeoRestriction" + ], + "members": { + "GeoRestriction": { + "type": "structure", + "required": [ + "RestrictionType", + "Quantity" + ], + "members": { + "RestrictionType": {}, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Location" + } + } + } + } + } + }, + "S1s": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "InProgressInvalidationBatches": { + "type": "integer" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1u" + }, + "DistributionConfig": { + "shape": "S7" + } + } + }, + "S1u": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Signer", + "type": "structure", + "members": { + "AwsAccountNumber": {}, + "KeyPairIds": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "KeyPairId" + } + } + } + } + } + } + } + } + }, + "S21": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "S28": { + "type": "structure", + "required": [ + "Paths", + "CallerReference" + ], + "members": { + "Paths": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Path" + } + } + } + }, + "CallerReference": {} + } + }, + "S2c": { + "type": "structure", + "required": [ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members": { + "Id": {}, + "Status": {}, + "CreateTime": { + "type": "timestamp" + }, + "InvalidationBatch": { + "shape": "S28" + } + } + }, + "S2e": { + "type": "structure", + "required": [ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members": { + "CallerReference": {}, + "S3Origin": { + "shape": "S2f" + }, + "Aliases": { + "shape": "S8" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "TrustedSigners": { + "shape": "Sy" + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "S2f": { + "type": "structure", + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "members": { + "DomainName": {}, + "OriginAccessIdentity": {} + } + }, + "S2i": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1u" + }, + "StreamingDistributionConfig": { + "shape": "S2e" + } + } + }, + "S3b": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "DistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "Aliases": { + "shape": "S8" + }, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1a" + }, + "CustomErrorResponses": { + "shape": "S1d" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1i" + }, + "Restrictions": { + "shape": "S1m" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2017-03-25.paginators.json b/node_modules/aws-sdk/apis/cloudfront-2017-03-25.paginators.json new file mode 100644 index 0000000..8edbda2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2017-03-25.paginators.json @@ -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" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2017-03-25.waiters2.json b/node_modules/aws-sdk/apis/cloudfront-2017-03-25.waiters2.json new file mode 100644 index 0000000..edd74b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2017-03-25.waiters2.json @@ -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" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2017-10-30.examples.json b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2017-10-30.min.json b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.min.json new file mode 100644 index 0000000..7f9a181 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.min.json @@ -0,0 +1,2838 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-10-30", + "endpointPrefix": "cloudfront", + "globalEndpoint": "cloudfront.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "CloudFront", + "serviceFullName": "Amazon CloudFront", + "serviceId": "CloudFront", + "signatureVersion": "v4", + "uid": "cloudfront-2017-10-30" + }, + "operations": { + "CreateCloudFrontOriginAccessIdentity": { + "http": { + "requestUri": "/2017-10-30/origin-access-identity/cloudfront", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "CreateDistribution": { + "http": { + "requestUri": "/2017-10-30/distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateDistributionWithTags": { + "http": { + "requestUri": "/2017-10-30/distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfigWithTags" + ], + "members": { + "DistributionConfigWithTags": { + "locationName": "DistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + }, + "type": "structure", + "required": [ + "DistributionConfig", + "Tags" + ], + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "Tags": { + "shape": "S22" + } + } + } + }, + "payload": "DistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateFieldLevelEncryptionConfig": { + "http": { + "requestUri": "/2017-10-30/field-level-encryption", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S29", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2k" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "CreateFieldLevelEncryptionProfile": { + "http": { + "requestUri": "/2017-10-30/field-level-encryption-profile", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S2t" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "CreateInvalidation": { + "http": { + "requestUri": "/2017-10-30/distribution/{DistributionId}/invalidation", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "InvalidationBatch" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "InvalidationBatch": { + "shape": "S2v", + "locationName": "InvalidationBatch", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "InvalidationBatch" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + }, + "Invalidation": { + "shape": "S2z" + } + }, + "payload": "Invalidation" + } + }, + "CreatePublicKey": { + "http": { + "requestUri": "/2017-10-30/public-key", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "PublicKeyConfig" + ], + "members": { + "PublicKeyConfig": { + "shape": "S31", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "PublicKeyConfig" + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S33" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "CreateStreamingDistribution": { + "http": { + "requestUri": "/2017-10-30/streaming-distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S35", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "CreateStreamingDistributionWithTags": { + "http": { + "requestUri": "/2017-10-30/streaming-distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfigWithTags" + ], + "members": { + "StreamingDistributionConfigWithTags": { + "locationName": "StreamingDistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + }, + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Tags" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S35" + }, + "Tags": { + "shape": "S22" + } + } + } + }, + "payload": "StreamingDistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "DeleteCloudFrontOriginAccessIdentity": { + "http": { + "method": "DELETE", + "requestUri": "/2017-10-30/origin-access-identity/cloudfront/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2017-10-30/distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteFieldLevelEncryptionConfig": { + "http": { + "method": "DELETE", + "requestUri": "/2017-10-30/field-level-encryption/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteFieldLevelEncryptionProfile": { + "http": { + "method": "DELETE", + "requestUri": "/2017-10-30/field-level-encryption-profile/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeletePublicKey": { + "http": { + "method": "DELETE", + "requestUri": "/2017-10-30/public-key/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteStreamingDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2017-10-30/streaming-distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "GetCloudFrontOriginAccessIdentity": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/origin-access-identity/cloudfront/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "GetCloudFrontOriginAccessIdentityConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + } + }, + "GetDistribution": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "GetDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "DistributionConfig" + } + }, + "GetFieldLevelEncryption": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/field-level-encryption/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2k" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "GetFieldLevelEncryptionConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/field-level-encryption/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S29" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionConfig" + } + }, + "GetFieldLevelEncryptionProfile": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/field-level-encryption-profile/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S2t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "GetFieldLevelEncryptionProfileConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/field-level-encryption-profile/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + } + }, + "GetInvalidation": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/distribution/{DistributionId}/invalidation/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "Id" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invalidation": { + "shape": "S2z" + } + }, + "payload": "Invalidation" + } + }, + "GetPublicKey": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/public-key/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S33" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "GetPublicKeyConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/public-key/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyConfig": { + "shape": "S31" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKeyConfig" + } + }, + "GetStreamingDistribution": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/streaming-distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "GetStreamingDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionConfig": { + "shape": "S35" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistributionConfig" + } + }, + "ListCloudFrontOriginAccessIdentities": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/origin-access-identity/cloudfront" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CloudFrontOriginAccessIdentitySummary", + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "CloudFrontOriginAccessIdentityList" + } + }, + "ListDistributions": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S4g" + } + }, + "payload": "DistributionList" + } + }, + "ListDistributionsByWebACLId": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/distributionsByWebACLId/{WebACLId}" + }, + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + }, + "WebACLId": { + "location": "uri", + "locationName": "WebACLId" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S4g" + } + }, + "payload": "DistributionList" + } + }, + "ListFieldLevelEncryptionConfigs": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/field-level-encryption" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldLevelEncryptionSummary", + "type": "structure", + "required": [ + "Id", + "LastModifiedTime" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "Comment": {}, + "QueryArgProfileConfig": { + "shape": "S2a" + }, + "ContentTypeProfileConfig": { + "shape": "S2e" + } + } + } + } + } + } + }, + "payload": "FieldLevelEncryptionList" + } + }, + "ListFieldLevelEncryptionProfiles": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/field-level-encryption-profile" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldLevelEncryptionProfileSummary", + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "Name": {}, + "EncryptionEntities": { + "shape": "S2n" + }, + "Comment": {} + } + } + } + } + } + }, + "payload": "FieldLevelEncryptionProfileList" + } + }, + "ListInvalidations": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/distribution/{DistributionId}/invalidation" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "InvalidationList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "InvalidationSummary", + "type": "structure", + "required": [ + "Id", + "CreateTime", + "Status" + ], + "members": { + "Id": {}, + "CreateTime": { + "type": "timestamp" + }, + "Status": {} + } + } + } + } + } + }, + "payload": "InvalidationList" + } + }, + "ListPublicKeys": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/public-key" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "PublicKeySummary", + "type": "structure", + "required": [ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members": { + "Id": {}, + "Name": {}, + "CreatedTime": { + "type": "timestamp" + }, + "EncodedKey": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "PublicKeyList" + } + }, + "ListStreamingDistributions": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/streaming-distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "StreamingDistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "S3Origin": { + "shape": "S36" + }, + "Aliases": { + "shape": "S8" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "payload": "StreamingDistributionList" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2017-10-30/tagging" + }, + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S22" + } + }, + "payload": "Tags" + } + }, + "TagResource": { + "http": { + "requestUri": "/2017-10-30/tagging?Operation=Tag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "Tags" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "Tags": { + "shape": "S22", + "locationName": "Tags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + } + }, + "payload": "Tags" + } + }, + "UntagResource": { + "http": { + "requestUri": "/2017-10-30/tagging?Operation=Untag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "TagKeys" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "TagKeys": { + "locationName": "TagKeys", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + }, + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Key" + } + } + } + } + }, + "payload": "TagKeys" + } + }, + "UpdateCloudFrontOriginAccessIdentity": { + "http": { + "method": "PUT", + "requestUri": "/2017-10-30/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "UpdateDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2017-10-30/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig", + "Id" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "UpdateFieldLevelEncryptionConfig": { + "http": { + "method": "PUT", + "requestUri": "/2017-10-30/field-level-encryption/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S29", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2k" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "UpdateFieldLevelEncryptionProfile": { + "http": { + "method": "PUT", + "requestUri": "/2017-10-30/field-level-encryption-profile/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S2t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "UpdatePublicKey": { + "http": { + "method": "PUT", + "requestUri": "/2017-10-30/public-key/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "PublicKeyConfig", + "Id" + ], + "members": { + "PublicKeyConfig": { + "shape": "S31", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "PublicKeyConfig" + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S33" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "UpdateStreamingDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2017-10-30/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Id" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S35", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2017-10-30/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "CallerReference", + "Comment" + ], + "members": { + "CallerReference": {}, + "Comment": {} + } + }, + "S5": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + } + } + }, + "S7": { + "type": "structure", + "required": [ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members": { + "CallerReference": {}, + "Aliases": { + "shape": "S8" + }, + "DefaultRootObject": {}, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1b" + }, + "CustomErrorResponses": { + "shape": "S1e" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "IncludeCookies": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1j" + }, + "Restrictions": { + "shape": "S1n" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + }, + "S8": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CNAME" + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Origin", + "type": "structure", + "required": [ + "Id", + "DomainName" + ], + "members": { + "Id": {}, + "DomainName": {}, + "OriginPath": {}, + "CustomHeaders": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "OriginCustomHeader", + "type": "structure", + "required": [ + "HeaderName", + "HeaderValue" + ], + "members": { + "HeaderName": {}, + "HeaderValue": {} + } + } + } + } + }, + "S3OriginConfig": { + "type": "structure", + "required": [ + "OriginAccessIdentity" + ], + "members": { + "OriginAccessIdentity": {} + } + }, + "CustomOriginConfig": { + "type": "structure", + "required": [ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members": { + "HTTPPort": { + "type": "integer" + }, + "HTTPSPort": { + "type": "integer" + }, + "OriginProtocolPolicy": {}, + "OriginSslProtocols": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "SslProtocol" + } + } + } + }, + "OriginReadTimeout": { + "type": "integer" + }, + "OriginKeepaliveTimeout": { + "type": "integer" + } + } + } + } + } + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + }, + "FieldLevelEncryptionId": {} + } + }, + "So": { + "type": "structure", + "required": [ + "QueryString", + "Cookies" + ], + "members": { + "QueryString": { + "type": "boolean" + }, + "Cookies": { + "type": "structure", + "required": [ + "Forward" + ], + "members": { + "Forward": {}, + "WhitelistedNames": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Headers": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + }, + "QueryStringCacheKeys": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "AwsAccountNumber" + } + } + } + }, + "S12": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + }, + "CachedMethods": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + } + } + } + } + }, + "S13": { + "type": "list", + "member": { + "locationName": "Method" + } + }, + "S16": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "LambdaFunctionAssociation", + "type": "structure", + "required": [ + "LambdaFunctionARN", + "EventType" + ], + "members": { + "LambdaFunctionARN": {}, + "EventType": {} + } + } + } + } + }, + "S1b": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CacheBehavior", + "type": "structure", + "required": [ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "PathPattern": {}, + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + }, + "FieldLevelEncryptionId": {} + } + } + } + } + }, + "S1e": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CustomErrorResponse", + "type": "structure", + "required": [ + "ErrorCode" + ], + "members": { + "ErrorCode": { + "type": "integer" + }, + "ResponsePagePath": {}, + "ResponseCode": {}, + "ErrorCachingMinTTL": { + "type": "long" + } + } + } + } + } + }, + "S1j": { + "type": "structure", + "members": { + "CloudFrontDefaultCertificate": { + "type": "boolean" + }, + "IAMCertificateId": {}, + "ACMCertificateArn": {}, + "SSLSupportMethod": {}, + "MinimumProtocolVersion": {}, + "Certificate": { + "deprecated": true + }, + "CertificateSource": { + "deprecated": true + } + } + }, + "S1n": { + "type": "structure", + "required": [ + "GeoRestriction" + ], + "members": { + "GeoRestriction": { + "type": "structure", + "required": [ + "RestrictionType", + "Quantity" + ], + "members": { + "RestrictionType": {}, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Location" + } + } + } + } + } + }, + "S1t": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "InProgressInvalidationBatches": { + "type": "integer" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1v" + }, + "DistributionConfig": { + "shape": "S7" + } + } + }, + "S1v": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Signer", + "type": "structure", + "members": { + "AwsAccountNumber": {}, + "KeyPairIds": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "KeyPairId" + } + } + } + } + } + } + } + } + }, + "S22": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "S29": { + "type": "structure", + "required": [ + "CallerReference" + ], + "members": { + "CallerReference": {}, + "Comment": {}, + "QueryArgProfileConfig": { + "shape": "S2a" + }, + "ContentTypeProfileConfig": { + "shape": "S2e" + } + } + }, + "S2a": { + "type": "structure", + "required": [ + "ForwardWhenQueryArgProfileIsUnknown" + ], + "members": { + "ForwardWhenQueryArgProfileIsUnknown": { + "type": "boolean" + }, + "QueryArgProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "QueryArgProfile", + "type": "structure", + "required": [ + "QueryArg", + "ProfileId" + ], + "members": { + "QueryArg": {}, + "ProfileId": {} + } + } + } + } + } + } + }, + "S2e": { + "type": "structure", + "required": [ + "ForwardWhenContentTypeIsUnknown" + ], + "members": { + "ForwardWhenContentTypeIsUnknown": { + "type": "boolean" + }, + "ContentTypeProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "ContentTypeProfile", + "type": "structure", + "required": [ + "Format", + "ContentType" + ], + "members": { + "Format": {}, + "ProfileId": {}, + "ContentType": {} + } + } + } + } + } + } + }, + "S2k": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FieldLevelEncryptionConfig": { + "shape": "S29" + } + } + }, + "S2m": { + "type": "structure", + "required": [ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members": { + "Name": {}, + "CallerReference": {}, + "Comment": {}, + "EncryptionEntities": { + "shape": "S2n" + } + } + }, + "S2n": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "EncryptionEntity", + "type": "structure", + "required": [ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members": { + "PublicKeyId": {}, + "ProviderId": {}, + "FieldPatterns": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldPattern" + } + } + } + } + } + } + } + } + }, + "S2t": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m" + } + } + }, + "S2v": { + "type": "structure", + "required": [ + "Paths", + "CallerReference" + ], + "members": { + "Paths": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Path" + } + } + } + }, + "CallerReference": {} + } + }, + "S2z": { + "type": "structure", + "required": [ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members": { + "Id": {}, + "Status": {}, + "CreateTime": { + "type": "timestamp" + }, + "InvalidationBatch": { + "shape": "S2v" + } + } + }, + "S31": { + "type": "structure", + "required": [ + "CallerReference", + "Name", + "EncodedKey" + ], + "members": { + "CallerReference": {}, + "Name": {}, + "EncodedKey": {}, + "Comment": {} + } + }, + "S33": { + "type": "structure", + "required": [ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members": { + "Id": {}, + "CreatedTime": { + "type": "timestamp" + }, + "PublicKeyConfig": { + "shape": "S31" + } + } + }, + "S35": { + "type": "structure", + "required": [ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members": { + "CallerReference": {}, + "S3Origin": { + "shape": "S36" + }, + "Aliases": { + "shape": "S8" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "TrustedSigners": { + "shape": "Sy" + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "S36": { + "type": "structure", + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "members": { + "DomainName": {}, + "OriginAccessIdentity": {} + } + }, + "S39": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1v" + }, + "StreamingDistributionConfig": { + "shape": "S35" + } + } + }, + "S4g": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "DistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "Aliases": { + "shape": "S8" + }, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1b" + }, + "CustomErrorResponses": { + "shape": "S1e" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1j" + }, + "Restrictions": { + "shape": "S1n" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2017-10-30.paginators.json b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.paginators.json new file mode 100644 index 0000000..8edbda2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.paginators.json @@ -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" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2017-10-30.waiters2.json b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.waiters2.json new file mode 100644 index 0000000..edd74b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2017-10-30.waiters2.json @@ -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" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-06-18.examples.json b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-06-18.min.json b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.min.json new file mode 100644 index 0000000..5944fa5 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.min.json @@ -0,0 +1,2841 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-06-18", + "endpointPrefix": "cloudfront", + "globalEndpoint": "cloudfront.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "CloudFront", + "serviceFullName": "Amazon CloudFront", + "serviceId": "CloudFront", + "signatureVersion": "v4", + "uid": "cloudfront-2018-06-18" + }, + "operations": { + "CreateCloudFrontOriginAccessIdentity": { + "http": { + "requestUri": "/2018-06-18/origin-access-identity/cloudfront", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "CreateDistribution": { + "http": { + "requestUri": "/2018-06-18/distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateDistributionWithTags": { + "http": { + "requestUri": "/2018-06-18/distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfigWithTags" + ], + "members": { + "DistributionConfigWithTags": { + "locationName": "DistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + }, + "type": "structure", + "required": [ + "DistributionConfig", + "Tags" + ], + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "Tags": { + "shape": "S22" + } + } + } + }, + "payload": "DistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateFieldLevelEncryptionConfig": { + "http": { + "requestUri": "/2018-06-18/field-level-encryption", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S29", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2k" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "CreateFieldLevelEncryptionProfile": { + "http": { + "requestUri": "/2018-06-18/field-level-encryption-profile", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S2t" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "CreateInvalidation": { + "http": { + "requestUri": "/2018-06-18/distribution/{DistributionId}/invalidation", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "InvalidationBatch" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "InvalidationBatch": { + "shape": "S2v", + "locationName": "InvalidationBatch", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "InvalidationBatch" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + }, + "Invalidation": { + "shape": "S2z" + } + }, + "payload": "Invalidation" + } + }, + "CreatePublicKey": { + "http": { + "requestUri": "/2018-06-18/public-key", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "PublicKeyConfig" + ], + "members": { + "PublicKeyConfig": { + "shape": "S31", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "PublicKeyConfig" + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S33" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "CreateStreamingDistribution": { + "http": { + "requestUri": "/2018-06-18/streaming-distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S35", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "CreateStreamingDistributionWithTags": { + "http": { + "requestUri": "/2018-06-18/streaming-distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfigWithTags" + ], + "members": { + "StreamingDistributionConfigWithTags": { + "locationName": "StreamingDistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + }, + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Tags" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S35" + }, + "Tags": { + "shape": "S22" + } + } + } + }, + "payload": "StreamingDistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "DeleteCloudFrontOriginAccessIdentity": { + "http": { + "method": "DELETE", + "requestUri": "/2018-06-18/origin-access-identity/cloudfront/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2018-06-18/distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteFieldLevelEncryptionConfig": { + "http": { + "method": "DELETE", + "requestUri": "/2018-06-18/field-level-encryption/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteFieldLevelEncryptionProfile": { + "http": { + "method": "DELETE", + "requestUri": "/2018-06-18/field-level-encryption-profile/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeletePublicKey": { + "http": { + "method": "DELETE", + "requestUri": "/2018-06-18/public-key/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteStreamingDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2018-06-18/streaming-distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "GetCloudFrontOriginAccessIdentity": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/origin-access-identity/cloudfront/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "GetCloudFrontOriginAccessIdentityConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + } + }, + "GetDistribution": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "GetDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "DistributionConfig" + } + }, + "GetFieldLevelEncryption": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/field-level-encryption/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2k" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "GetFieldLevelEncryptionConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/field-level-encryption/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S29" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionConfig" + } + }, + "GetFieldLevelEncryptionProfile": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/field-level-encryption-profile/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S2t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "GetFieldLevelEncryptionProfileConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/field-level-encryption-profile/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + } + }, + "GetInvalidation": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/distribution/{DistributionId}/invalidation/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "Id" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invalidation": { + "shape": "S2z" + } + }, + "payload": "Invalidation" + } + }, + "GetPublicKey": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/public-key/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S33" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "GetPublicKeyConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/public-key/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyConfig": { + "shape": "S31" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKeyConfig" + } + }, + "GetStreamingDistribution": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/streaming-distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "GetStreamingDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionConfig": { + "shape": "S35" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistributionConfig" + } + }, + "ListCloudFrontOriginAccessIdentities": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/origin-access-identity/cloudfront" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CloudFrontOriginAccessIdentitySummary", + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "CloudFrontOriginAccessIdentityList" + } + }, + "ListDistributions": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S4g" + } + }, + "payload": "DistributionList" + } + }, + "ListDistributionsByWebACLId": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/distributionsByWebACLId/{WebACLId}" + }, + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + }, + "WebACLId": { + "location": "uri", + "locationName": "WebACLId" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S4g" + } + }, + "payload": "DistributionList" + } + }, + "ListFieldLevelEncryptionConfigs": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/field-level-encryption" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldLevelEncryptionSummary", + "type": "structure", + "required": [ + "Id", + "LastModifiedTime" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "Comment": {}, + "QueryArgProfileConfig": { + "shape": "S2a" + }, + "ContentTypeProfileConfig": { + "shape": "S2e" + } + } + } + } + } + } + }, + "payload": "FieldLevelEncryptionList" + } + }, + "ListFieldLevelEncryptionProfiles": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/field-level-encryption-profile" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldLevelEncryptionProfileSummary", + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "Name": {}, + "EncryptionEntities": { + "shape": "S2n" + }, + "Comment": {} + } + } + } + } + } + }, + "payload": "FieldLevelEncryptionProfileList" + } + }, + "ListInvalidations": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/distribution/{DistributionId}/invalidation" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "InvalidationList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "InvalidationSummary", + "type": "structure", + "required": [ + "Id", + "CreateTime", + "Status" + ], + "members": { + "Id": {}, + "CreateTime": { + "type": "timestamp" + }, + "Status": {} + } + } + } + } + } + }, + "payload": "InvalidationList" + } + }, + "ListPublicKeys": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/public-key" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "PublicKeySummary", + "type": "structure", + "required": [ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members": { + "Id": {}, + "Name": {}, + "CreatedTime": { + "type": "timestamp" + }, + "EncodedKey": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "PublicKeyList" + } + }, + "ListStreamingDistributions": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/streaming-distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "StreamingDistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "S3Origin": { + "shape": "S36" + }, + "Aliases": { + "shape": "S8" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "payload": "StreamingDistributionList" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2018-06-18/tagging" + }, + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S22" + } + }, + "payload": "Tags" + } + }, + "TagResource": { + "http": { + "requestUri": "/2018-06-18/tagging?Operation=Tag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "Tags" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "Tags": { + "shape": "S22", + "locationName": "Tags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + } + }, + "payload": "Tags" + } + }, + "UntagResource": { + "http": { + "requestUri": "/2018-06-18/tagging?Operation=Untag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "TagKeys" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "TagKeys": { + "locationName": "TagKeys", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + }, + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Key" + } + } + } + } + }, + "payload": "TagKeys" + } + }, + "UpdateCloudFrontOriginAccessIdentity": { + "http": { + "method": "PUT", + "requestUri": "/2018-06-18/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "UpdateDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2018-06-18/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig", + "Id" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "UpdateFieldLevelEncryptionConfig": { + "http": { + "method": "PUT", + "requestUri": "/2018-06-18/field-level-encryption/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S29", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2k" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "UpdateFieldLevelEncryptionProfile": { + "http": { + "method": "PUT", + "requestUri": "/2018-06-18/field-level-encryption-profile/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S2t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "UpdatePublicKey": { + "http": { + "method": "PUT", + "requestUri": "/2018-06-18/public-key/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "PublicKeyConfig", + "Id" + ], + "members": { + "PublicKeyConfig": { + "shape": "S31", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "PublicKeyConfig" + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S33" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "UpdateStreamingDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2018-06-18/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Id" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S35", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-06-18/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S39" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "CallerReference", + "Comment" + ], + "members": { + "CallerReference": {}, + "Comment": {} + } + }, + "S5": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + } + } + }, + "S7": { + "type": "structure", + "required": [ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members": { + "CallerReference": {}, + "Aliases": { + "shape": "S8" + }, + "DefaultRootObject": {}, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1b" + }, + "CustomErrorResponses": { + "shape": "S1e" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "IncludeCookies": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1j" + }, + "Restrictions": { + "shape": "S1n" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + }, + "S8": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CNAME" + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Origin", + "type": "structure", + "required": [ + "Id", + "DomainName" + ], + "members": { + "Id": {}, + "DomainName": {}, + "OriginPath": {}, + "CustomHeaders": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "OriginCustomHeader", + "type": "structure", + "required": [ + "HeaderName", + "HeaderValue" + ], + "members": { + "HeaderName": {}, + "HeaderValue": {} + } + } + } + } + }, + "S3OriginConfig": { + "type": "structure", + "required": [ + "OriginAccessIdentity" + ], + "members": { + "OriginAccessIdentity": {} + } + }, + "CustomOriginConfig": { + "type": "structure", + "required": [ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members": { + "HTTPPort": { + "type": "integer" + }, + "HTTPSPort": { + "type": "integer" + }, + "OriginProtocolPolicy": {}, + "OriginSslProtocols": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "SslProtocol" + } + } + } + }, + "OriginReadTimeout": { + "type": "integer" + }, + "OriginKeepaliveTimeout": { + "type": "integer" + } + } + } + } + } + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + }, + "FieldLevelEncryptionId": {} + } + }, + "So": { + "type": "structure", + "required": [ + "QueryString", + "Cookies" + ], + "members": { + "QueryString": { + "type": "boolean" + }, + "Cookies": { + "type": "structure", + "required": [ + "Forward" + ], + "members": { + "Forward": {}, + "WhitelistedNames": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Headers": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + }, + "QueryStringCacheKeys": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "AwsAccountNumber" + } + } + } + }, + "S12": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + }, + "CachedMethods": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S13" + } + } + } + } + }, + "S13": { + "type": "list", + "member": { + "locationName": "Method" + } + }, + "S16": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "LambdaFunctionAssociation", + "type": "structure", + "required": [ + "LambdaFunctionARN", + "EventType" + ], + "members": { + "LambdaFunctionARN": {}, + "EventType": {}, + "IncludeBody": { + "type": "boolean" + } + } + } + } + } + }, + "S1b": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CacheBehavior", + "type": "structure", + "required": [ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "PathPattern": {}, + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "So" + }, + "TrustedSigners": { + "shape": "Sy" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S12" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S16" + }, + "FieldLevelEncryptionId": {} + } + } + } + } + }, + "S1e": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CustomErrorResponse", + "type": "structure", + "required": [ + "ErrorCode" + ], + "members": { + "ErrorCode": { + "type": "integer" + }, + "ResponsePagePath": {}, + "ResponseCode": {}, + "ErrorCachingMinTTL": { + "type": "long" + } + } + } + } + } + }, + "S1j": { + "type": "structure", + "members": { + "CloudFrontDefaultCertificate": { + "type": "boolean" + }, + "IAMCertificateId": {}, + "ACMCertificateArn": {}, + "SSLSupportMethod": {}, + "MinimumProtocolVersion": {}, + "Certificate": { + "deprecated": true + }, + "CertificateSource": { + "deprecated": true + } + } + }, + "S1n": { + "type": "structure", + "required": [ + "GeoRestriction" + ], + "members": { + "GeoRestriction": { + "type": "structure", + "required": [ + "RestrictionType", + "Quantity" + ], + "members": { + "RestrictionType": {}, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Location" + } + } + } + } + } + }, + "S1t": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "InProgressInvalidationBatches": { + "type": "integer" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1v" + }, + "DistributionConfig": { + "shape": "S7" + } + } + }, + "S1v": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Signer", + "type": "structure", + "members": { + "AwsAccountNumber": {}, + "KeyPairIds": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "KeyPairId" + } + } + } + } + } + } + } + } + }, + "S22": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "S29": { + "type": "structure", + "required": [ + "CallerReference" + ], + "members": { + "CallerReference": {}, + "Comment": {}, + "QueryArgProfileConfig": { + "shape": "S2a" + }, + "ContentTypeProfileConfig": { + "shape": "S2e" + } + } + }, + "S2a": { + "type": "structure", + "required": [ + "ForwardWhenQueryArgProfileIsUnknown" + ], + "members": { + "ForwardWhenQueryArgProfileIsUnknown": { + "type": "boolean" + }, + "QueryArgProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "QueryArgProfile", + "type": "structure", + "required": [ + "QueryArg", + "ProfileId" + ], + "members": { + "QueryArg": {}, + "ProfileId": {} + } + } + } + } + } + } + }, + "S2e": { + "type": "structure", + "required": [ + "ForwardWhenContentTypeIsUnknown" + ], + "members": { + "ForwardWhenContentTypeIsUnknown": { + "type": "boolean" + }, + "ContentTypeProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "ContentTypeProfile", + "type": "structure", + "required": [ + "Format", + "ContentType" + ], + "members": { + "Format": {}, + "ProfileId": {}, + "ContentType": {} + } + } + } + } + } + } + }, + "S2k": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FieldLevelEncryptionConfig": { + "shape": "S29" + } + } + }, + "S2m": { + "type": "structure", + "required": [ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members": { + "Name": {}, + "CallerReference": {}, + "Comment": {}, + "EncryptionEntities": { + "shape": "S2n" + } + } + }, + "S2n": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "EncryptionEntity", + "type": "structure", + "required": [ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members": { + "PublicKeyId": {}, + "ProviderId": {}, + "FieldPatterns": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldPattern" + } + } + } + } + } + } + } + } + }, + "S2t": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FieldLevelEncryptionProfileConfig": { + "shape": "S2m" + } + } + }, + "S2v": { + "type": "structure", + "required": [ + "Paths", + "CallerReference" + ], + "members": { + "Paths": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Path" + } + } + } + }, + "CallerReference": {} + } + }, + "S2z": { + "type": "structure", + "required": [ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members": { + "Id": {}, + "Status": {}, + "CreateTime": { + "type": "timestamp" + }, + "InvalidationBatch": { + "shape": "S2v" + } + } + }, + "S31": { + "type": "structure", + "required": [ + "CallerReference", + "Name", + "EncodedKey" + ], + "members": { + "CallerReference": {}, + "Name": {}, + "EncodedKey": {}, + "Comment": {} + } + }, + "S33": { + "type": "structure", + "required": [ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members": { + "Id": {}, + "CreatedTime": { + "type": "timestamp" + }, + "PublicKeyConfig": { + "shape": "S31" + } + } + }, + "S35": { + "type": "structure", + "required": [ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members": { + "CallerReference": {}, + "S3Origin": { + "shape": "S36" + }, + "Aliases": { + "shape": "S8" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "TrustedSigners": { + "shape": "Sy" + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "S36": { + "type": "structure", + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "members": { + "DomainName": {}, + "OriginAccessIdentity": {} + } + }, + "S39": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1v" + }, + "StreamingDistributionConfig": { + "shape": "S35" + } + } + }, + "S4g": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "DistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "Aliases": { + "shape": "S8" + }, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sn" + }, + "CacheBehaviors": { + "shape": "S1b" + }, + "CustomErrorResponses": { + "shape": "S1e" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1j" + }, + "Restrictions": { + "shape": "S1n" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-06-18.paginators.json b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.paginators.json new file mode 100644 index 0000000..8edbda2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.paginators.json @@ -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" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-06-18.waiters2.json b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.waiters2.json new file mode 100644 index 0000000..edd74b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-06-18.waiters2.json @@ -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" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-11-05.examples.json b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-11-05.min.json b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.min.json new file mode 100644 index 0000000..7ed03a9 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.min.json @@ -0,0 +1,2926 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-11-05", + "endpointPrefix": "cloudfront", + "globalEndpoint": "cloudfront.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "CloudFront", + "serviceFullName": "Amazon CloudFront", + "serviceId": "CloudFront", + "signatureVersion": "v4", + "uid": "cloudfront-2018-11-05" + }, + "operations": { + "CreateCloudFrontOriginAccessIdentity": { + "http": { + "requestUri": "/2018-11-05/origin-access-identity/cloudfront", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "CreateDistribution": { + "http": { + "requestUri": "/2018-11-05/distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S22" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateDistributionWithTags": { + "http": { + "requestUri": "/2018-11-05/distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfigWithTags" + ], + "members": { + "DistributionConfigWithTags": { + "locationName": "DistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + }, + "type": "structure", + "required": [ + "DistributionConfig", + "Tags" + ], + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "Tags": { + "shape": "S2b" + } + } + } + }, + "payload": "DistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S22" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateFieldLevelEncryptionConfig": { + "http": { + "requestUri": "/2018-11-05/field-level-encryption", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S2i", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2t" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "CreateFieldLevelEncryptionProfile": { + "http": { + "requestUri": "/2018-11-05/field-level-encryption-profile", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2v", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S32" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "CreateInvalidation": { + "http": { + "requestUri": "/2018-11-05/distribution/{DistributionId}/invalidation", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "InvalidationBatch" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "InvalidationBatch": { + "shape": "S34", + "locationName": "InvalidationBatch", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "InvalidationBatch" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + }, + "Invalidation": { + "shape": "S38" + } + }, + "payload": "Invalidation" + } + }, + "CreatePublicKey": { + "http": { + "requestUri": "/2018-11-05/public-key", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "PublicKeyConfig" + ], + "members": { + "PublicKeyConfig": { + "shape": "S3a", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "PublicKeyConfig" + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S3c" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "CreateStreamingDistribution": { + "http": { + "requestUri": "/2018-11-05/streaming-distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S3e", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S3i" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "CreateStreamingDistributionWithTags": { + "http": { + "requestUri": "/2018-11-05/streaming-distribution?WithTags", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfigWithTags" + ], + "members": { + "StreamingDistributionConfigWithTags": { + "locationName": "StreamingDistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + }, + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Tags" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S3e" + }, + "Tags": { + "shape": "S2b" + } + } + } + }, + "payload": "StreamingDistributionConfigWithTags" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S3i" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "DeleteCloudFrontOriginAccessIdentity": { + "http": { + "method": "DELETE", + "requestUri": "/2018-11-05/origin-access-identity/cloudfront/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2018-11-05/distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteFieldLevelEncryptionConfig": { + "http": { + "method": "DELETE", + "requestUri": "/2018-11-05/field-level-encryption/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteFieldLevelEncryptionProfile": { + "http": { + "method": "DELETE", + "requestUri": "/2018-11-05/field-level-encryption-profile/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeletePublicKey": { + "http": { + "method": "DELETE", + "requestUri": "/2018-11-05/public-key/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "DeleteStreamingDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2018-11-05/streaming-distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + } + } + }, + "GetCloudFrontOriginAccessIdentity": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/origin-access-identity/cloudfront/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "GetCloudFrontOriginAccessIdentityConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + } + }, + "GetDistribution": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S22" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "GetDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "DistributionConfig" + } + }, + "GetFieldLevelEncryption": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/field-level-encryption/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "GetFieldLevelEncryptionConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/field-level-encryption/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S2i" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionConfig" + } + }, + "GetFieldLevelEncryptionProfile": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/field-level-encryption-profile/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S32" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "GetFieldLevelEncryptionProfileConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/field-level-encryption-profile/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2v" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + } + }, + "GetInvalidation": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/distribution/{DistributionId}/invalidation/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "Id" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invalidation": { + "shape": "S38" + } + }, + "payload": "Invalidation" + } + }, + "GetPublicKey": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/public-key/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S3c" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "GetPublicKeyConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/public-key/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyConfig": { + "shape": "S3a" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKeyConfig" + } + }, + "GetStreamingDistribution": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/streaming-distribution/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S3i" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "GetStreamingDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionConfig": { + "shape": "S3e" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistributionConfig" + } + }, + "ListCloudFrontOriginAccessIdentities": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/origin-access-identity/cloudfront" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CloudFrontOriginAccessIdentitySummary", + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "CloudFrontOriginAccessIdentityList" + } + }, + "ListDistributions": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S4p" + } + }, + "payload": "DistributionList" + } + }, + "ListDistributionsByWebACLId": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/distributionsByWebACLId/{WebACLId}" + }, + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + }, + "WebACLId": { + "location": "uri", + "locationName": "WebACLId" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "S4p" + } + }, + "payload": "DistributionList" + } + }, + "ListFieldLevelEncryptionConfigs": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/field-level-encryption" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldLevelEncryptionSummary", + "type": "structure", + "required": [ + "Id", + "LastModifiedTime" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "Comment": {}, + "QueryArgProfileConfig": { + "shape": "S2j" + }, + "ContentTypeProfileConfig": { + "shape": "S2n" + } + } + } + } + } + } + }, + "payload": "FieldLevelEncryptionList" + } + }, + "ListFieldLevelEncryptionProfiles": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/field-level-encryption-profile" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldLevelEncryptionProfileSummary", + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "Name": {}, + "EncryptionEntities": { + "shape": "S2w" + }, + "Comment": {} + } + } + } + } + } + }, + "payload": "FieldLevelEncryptionProfileList" + } + }, + "ListInvalidations": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/distribution/{DistributionId}/invalidation" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "InvalidationList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "InvalidationSummary", + "type": "structure", + "required": [ + "Id", + "CreateTime", + "Status" + ], + "members": { + "Id": {}, + "CreateTime": { + "type": "timestamp" + }, + "Status": {} + } + } + } + } + } + }, + "payload": "InvalidationList" + } + }, + "ListPublicKeys": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/public-key" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "PublicKeySummary", + "type": "structure", + "required": [ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members": { + "Id": {}, + "Name": {}, + "CreatedTime": { + "type": "timestamp" + }, + "EncodedKey": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "PublicKeyList" + } + }, + "ListStreamingDistributions": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/streaming-distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "StreamingDistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "S3Origin": { + "shape": "S3f" + }, + "Aliases": { + "shape": "S8" + }, + "TrustedSigners": { + "shape": "S17" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "payload": "StreamingDistributionList" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2018-11-05/tagging" + }, + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S2b" + } + }, + "payload": "Tags" + } + }, + "TagResource": { + "http": { + "requestUri": "/2018-11-05/tagging?Operation=Tag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "Tags" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "Tags": { + "shape": "S2b", + "locationName": "Tags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + } + }, + "payload": "Tags" + } + }, + "UntagResource": { + "http": { + "requestUri": "/2018-11-05/tagging?Operation=Untag", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "TagKeys" + ], + "members": { + "Resource": { + "location": "querystring", + "locationName": "Resource" + }, + "TagKeys": { + "locationName": "TagKeys", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + }, + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Key" + } + } + } + } + }, + "payload": "TagKeys" + } + }, + "UpdateCloudFrontOriginAccessIdentity": { + "http": { + "method": "PUT", + "requestUri": "/2018-11-05/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "UpdateDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2018-11-05/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig", + "Id" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S22" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "UpdateFieldLevelEncryptionConfig": { + "http": { + "method": "PUT", + "requestUri": "/2018-11-05/field-level-encryption/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "S2i", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "S2t" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + } + }, + "UpdateFieldLevelEncryptionProfile": { + "http": { + "method": "PUT", + "requestUri": "/2018-11-05/field-level-encryption-profile/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "S2v", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "output": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "S32" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + } + }, + "UpdatePublicKey": { + "http": { + "method": "PUT", + "requestUri": "/2018-11-05/public-key/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "PublicKeyConfig", + "Id" + ], + "members": { + "PublicKeyConfig": { + "shape": "S3a", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "PublicKeyConfig" + }, + "output": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "S3c" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + } + }, + "UpdateStreamingDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2018-11-05/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Id" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S3e", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2018-11-05/" + } + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S3i" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "CallerReference", + "Comment" + ], + "members": { + "CallerReference": {}, + "Comment": {} + } + }, + "S5": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + } + } + }, + "S7": { + "type": "structure", + "required": [ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members": { + "CallerReference": {}, + "Aliases": { + "shape": "S8" + }, + "DefaultRootObject": {}, + "Origins": { + "shape": "Sb" + }, + "OriginGroups": { + "shape": "Sn" + }, + "DefaultCacheBehavior": { + "shape": "Sw" + }, + "CacheBehaviors": { + "shape": "S1k" + }, + "CustomErrorResponses": { + "shape": "S1n" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "IncludeCookies": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1s" + }, + "Restrictions": { + "shape": "S1w" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + }, + "S8": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CNAME" + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Origin", + "type": "structure", + "required": [ + "Id", + "DomainName" + ], + "members": { + "Id": {}, + "DomainName": {}, + "OriginPath": {}, + "CustomHeaders": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "OriginCustomHeader", + "type": "structure", + "required": [ + "HeaderName", + "HeaderValue" + ], + "members": { + "HeaderName": {}, + "HeaderValue": {} + } + } + } + } + }, + "S3OriginConfig": { + "type": "structure", + "required": [ + "OriginAccessIdentity" + ], + "members": { + "OriginAccessIdentity": {} + } + }, + "CustomOriginConfig": { + "type": "structure", + "required": [ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members": { + "HTTPPort": { + "type": "integer" + }, + "HTTPSPort": { + "type": "integer" + }, + "OriginProtocolPolicy": {}, + "OriginSslProtocols": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "SslProtocol" + } + } + } + }, + "OriginReadTimeout": { + "type": "integer" + }, + "OriginKeepaliveTimeout": { + "type": "integer" + } + } + } + } + } + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "OriginGroup", + "type": "structure", + "required": [ + "Id", + "FailoverCriteria", + "Members" + ], + "members": { + "Id": {}, + "FailoverCriteria": { + "type": "structure", + "required": [ + "StatusCodes" + ], + "members": { + "StatusCodes": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "StatusCode", + "type": "integer" + } + } + } + } + } + }, + "Members": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "OriginGroupMember", + "type": "structure", + "required": [ + "OriginId" + ], + "members": { + "OriginId": {} + } + } + } + } + } + } + } + } + } + }, + "Sw": { + "type": "structure", + "required": [ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "Sx" + }, + "TrustedSigners": { + "shape": "S17" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S1b" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S1f" + }, + "FieldLevelEncryptionId": {} + } + }, + "Sx": { + "type": "structure", + "required": [ + "QueryString", + "Cookies" + ], + "members": { + "QueryString": { + "type": "boolean" + }, + "Cookies": { + "type": "structure", + "required": [ + "Forward" + ], + "members": { + "Forward": {}, + "WhitelistedNames": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Headers": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + }, + "QueryStringCacheKeys": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "S17": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "AwsAccountNumber" + } + } + } + }, + "S1b": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S1c" + }, + "CachedMethods": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "shape": "S1c" + } + } + } + } + }, + "S1c": { + "type": "list", + "member": { + "locationName": "Method" + } + }, + "S1f": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "LambdaFunctionAssociation", + "type": "structure", + "required": [ + "LambdaFunctionARN", + "EventType" + ], + "members": { + "LambdaFunctionARN": {}, + "EventType": {}, + "IncludeBody": { + "type": "boolean" + } + } + } + } + } + }, + "S1k": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CacheBehavior", + "type": "structure", + "required": [ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "PathPattern": {}, + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "Sx" + }, + "TrustedSigners": { + "shape": "S17" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "S1b" + }, + "SmoothStreaming": { + "type": "boolean" + }, + "DefaultTTL": { + "type": "long" + }, + "MaxTTL": { + "type": "long" + }, + "Compress": { + "type": "boolean" + }, + "LambdaFunctionAssociations": { + "shape": "S1f" + }, + "FieldLevelEncryptionId": {} + } + } + } + } + }, + "S1n": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CustomErrorResponse", + "type": "structure", + "required": [ + "ErrorCode" + ], + "members": { + "ErrorCode": { + "type": "integer" + }, + "ResponsePagePath": {}, + "ResponseCode": {}, + "ErrorCachingMinTTL": { + "type": "long" + } + } + } + } + } + }, + "S1s": { + "type": "structure", + "members": { + "CloudFrontDefaultCertificate": { + "type": "boolean" + }, + "IAMCertificateId": {}, + "ACMCertificateArn": {}, + "SSLSupportMethod": {}, + "MinimumProtocolVersion": {}, + "Certificate": { + "deprecated": true + }, + "CertificateSource": { + "deprecated": true + } + } + }, + "S1w": { + "type": "structure", + "required": [ + "GeoRestriction" + ], + "members": { + "GeoRestriction": { + "type": "structure", + "required": [ + "RestrictionType", + "Quantity" + ], + "members": { + "RestrictionType": {}, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Location" + } + } + } + } + } + }, + "S22": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "InProgressInvalidationBatches": { + "type": "integer" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S24" + }, + "DistributionConfig": { + "shape": "S7" + } + } + }, + "S24": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Signer", + "type": "structure", + "members": { + "AwsAccountNumber": {}, + "KeyPairIds": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "KeyPairId" + } + } + } + } + } + } + } + } + }, + "S2b": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "S2i": { + "type": "structure", + "required": [ + "CallerReference" + ], + "members": { + "CallerReference": {}, + "Comment": {}, + "QueryArgProfileConfig": { + "shape": "S2j" + }, + "ContentTypeProfileConfig": { + "shape": "S2n" + } + } + }, + "S2j": { + "type": "structure", + "required": [ + "ForwardWhenQueryArgProfileIsUnknown" + ], + "members": { + "ForwardWhenQueryArgProfileIsUnknown": { + "type": "boolean" + }, + "QueryArgProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "QueryArgProfile", + "type": "structure", + "required": [ + "QueryArg", + "ProfileId" + ], + "members": { + "QueryArg": {}, + "ProfileId": {} + } + } + } + } + } + } + }, + "S2n": { + "type": "structure", + "required": [ + "ForwardWhenContentTypeIsUnknown" + ], + "members": { + "ForwardWhenContentTypeIsUnknown": { + "type": "boolean" + }, + "ContentTypeProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "ContentTypeProfile", + "type": "structure", + "required": [ + "Format", + "ContentType" + ], + "members": { + "Format": {}, + "ProfileId": {}, + "ContentType": {} + } + } + } + } + } + } + }, + "S2t": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FieldLevelEncryptionConfig": { + "shape": "S2i" + } + } + }, + "S2v": { + "type": "structure", + "required": [ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members": { + "Name": {}, + "CallerReference": {}, + "Comment": {}, + "EncryptionEntities": { + "shape": "S2w" + } + } + }, + "S2w": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "EncryptionEntity", + "type": "structure", + "required": [ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members": { + "PublicKeyId": {}, + "ProviderId": {}, + "FieldPatterns": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "FieldPattern" + } + } + } + } + } + } + } + } + }, + "S32": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "Id": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FieldLevelEncryptionProfileConfig": { + "shape": "S2v" + } + } + }, + "S34": { + "type": "structure", + "required": [ + "Paths", + "CallerReference" + ], + "members": { + "Paths": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Path" + } + } + } + }, + "CallerReference": {} + } + }, + "S38": { + "type": "structure", + "required": [ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members": { + "Id": {}, + "Status": {}, + "CreateTime": { + "type": "timestamp" + }, + "InvalidationBatch": { + "shape": "S34" + } + } + }, + "S3a": { + "type": "structure", + "required": [ + "CallerReference", + "Name", + "EncodedKey" + ], + "members": { + "CallerReference": {}, + "Name": {}, + "EncodedKey": {}, + "Comment": {} + } + }, + "S3c": { + "type": "structure", + "required": [ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members": { + "Id": {}, + "CreatedTime": { + "type": "timestamp" + }, + "PublicKeyConfig": { + "shape": "S3a" + } + } + }, + "S3e": { + "type": "structure", + "required": [ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members": { + "CallerReference": {}, + "S3Origin": { + "shape": "S3f" + }, + "Aliases": { + "shape": "S8" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "TrustedSigners": { + "shape": "S17" + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "S3f": { + "type": "structure", + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "members": { + "DomainName": {}, + "OriginAccessIdentity": {} + } + }, + "S3i": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S24" + }, + "StreamingDistributionConfig": { + "shape": "S3e" + } + } + }, + "S4p": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "DistributionSummary", + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members": { + "Id": {}, + "ARN": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "Aliases": { + "shape": "S8" + }, + "Origins": { + "shape": "Sb" + }, + "OriginGroups": { + "shape": "Sn" + }, + "DefaultCacheBehavior": { + "shape": "Sw" + }, + "CacheBehaviors": { + "shape": "S1k" + }, + "CustomErrorResponses": { + "shape": "S1n" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S1s" + }, + "Restrictions": { + "shape": "S1w" + }, + "WebACLId": {}, + "HttpVersion": {}, + "IsIPV6Enabled": { + "type": "boolean" + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-11-05.paginators.json b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.paginators.json new file mode 100644 index 0000000..8edbda2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.paginators.json @@ -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" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudfront-2018-11-05.waiters2.json b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.waiters2.json new file mode 100644 index 0000000..edd74b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudfront-2018-11-05.waiters2.json @@ -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" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.examples.json b/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.min.json b/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.min.json new file mode 100644 index 0000000..e788318 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.min.json @@ -0,0 +1,521 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-05-30", + "endpointPrefix": "cloudhsm", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "CloudHSM", + "serviceFullName": "Amazon CloudHSM", + "serviceId": "CloudHSM", + "signatureVersion": "v4", + "targetPrefix": "CloudHsmFrontendService", + "uid": "cloudhsm-2014-05-30" + }, + "operations": { + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagList" + ], + "members": { + "ResourceArn": {}, + "TagList": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {} + } + } + }, + "CreateHapg": { + "input": { + "type": "structure", + "required": [ + "Label" + ], + "members": { + "Label": {} + } + }, + "output": { + "type": "structure", + "members": { + "HapgArn": {} + } + } + }, + "CreateHsm": { + "input": { + "type": "structure", + "required": [ + "SubnetId", + "SshKey", + "IamRoleArn", + "SubscriptionType" + ], + "members": { + "SubnetId": { + "locationName": "SubnetId" + }, + "SshKey": { + "locationName": "SshKey" + }, + "EniIp": { + "locationName": "EniIp" + }, + "IamRoleArn": { + "locationName": "IamRoleArn" + }, + "ExternalId": { + "locationName": "ExternalId" + }, + "SubscriptionType": { + "locationName": "SubscriptionType" + }, + "ClientToken": { + "locationName": "ClientToken" + }, + "SyslogIp": { + "locationName": "SyslogIp" + } + }, + "locationName": "CreateHsmRequest" + }, + "output": { + "type": "structure", + "members": { + "HsmArn": {} + } + } + }, + "CreateLunaClient": { + "input": { + "type": "structure", + "required": [ + "Certificate" + ], + "members": { + "Label": {}, + "Certificate": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClientArn": {} + } + } + }, + "DeleteHapg": { + "input": { + "type": "structure", + "required": [ + "HapgArn" + ], + "members": { + "HapgArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {} + } + } + }, + "DeleteHsm": { + "input": { + "type": "structure", + "required": [ + "HsmArn" + ], + "members": { + "HsmArn": { + "locationName": "HsmArn" + } + }, + "locationName": "DeleteHsmRequest" + }, + "output": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {} + } + } + }, + "DeleteLunaClient": { + "input": { + "type": "structure", + "required": [ + "ClientArn" + ], + "members": { + "ClientArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {} + } + } + }, + "DescribeHapg": { + "input": { + "type": "structure", + "required": [ + "HapgArn" + ], + "members": { + "HapgArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "HapgArn": {}, + "HapgSerial": {}, + "HsmsLastActionFailed": { + "shape": "Sz" + }, + "HsmsPendingDeletion": { + "shape": "Sz" + }, + "HsmsPendingRegistration": { + "shape": "Sz" + }, + "Label": {}, + "LastModifiedTimestamp": {}, + "PartitionSerialList": { + "shape": "S11" + }, + "State": {} + } + } + }, + "DescribeHsm": { + "input": { + "type": "structure", + "members": { + "HsmArn": {}, + "HsmSerialNumber": {} + } + }, + "output": { + "type": "structure", + "members": { + "HsmArn": {}, + "Status": {}, + "StatusDetails": {}, + "AvailabilityZone": {}, + "EniId": {}, + "EniIp": {}, + "SubscriptionType": {}, + "SubscriptionStartDate": {}, + "SubscriptionEndDate": {}, + "VpcId": {}, + "SubnetId": {}, + "IamRoleArn": {}, + "SerialNumber": {}, + "VendorName": {}, + "HsmType": {}, + "SoftwareVersion": {}, + "SshPublicKey": {}, + "SshKeyLastUpdated": {}, + "ServerCertUri": {}, + "ServerCertLastUpdated": {}, + "Partitions": { + "type": "list", + "member": {} + } + } + } + }, + "DescribeLunaClient": { + "input": { + "type": "structure", + "members": { + "ClientArn": {}, + "CertificateFingerprint": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClientArn": {}, + "Certificate": {}, + "CertificateFingerprint": {}, + "LastModifiedTimestamp": {}, + "Label": {} + } + } + }, + "GetConfig": { + "input": { + "type": "structure", + "required": [ + "ClientArn", + "ClientVersion", + "HapgList" + ], + "members": { + "ClientArn": {}, + "ClientVersion": {}, + "HapgList": { + "shape": "S1i" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigType": {}, + "ConfigFile": {}, + "ConfigCred": {} + } + } + }, + "ListAvailableZones": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AZList": { + "type": "list", + "member": {} + } + } + } + }, + "ListHapgs": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "HapgList" + ], + "members": { + "HapgList": { + "shape": "S1i" + }, + "NextToken": {} + } + } + }, + "ListHsms": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "HsmList": { + "shape": "Sz" + }, + "NextToken": {} + } + } + }, + "ListLunaClients": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ClientList" + ], + "members": { + "ClientList": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TagList" + ], + "members": { + "TagList": { + "shape": "S3" + } + } + } + }, + "ModifyHapg": { + "input": { + "type": "structure", + "required": [ + "HapgArn" + ], + "members": { + "HapgArn": {}, + "Label": {}, + "PartitionSerialList": { + "shape": "S11" + } + } + }, + "output": { + "type": "structure", + "members": { + "HapgArn": {} + } + } + }, + "ModifyHsm": { + "input": { + "type": "structure", + "required": [ + "HsmArn" + ], + "members": { + "HsmArn": { + "locationName": "HsmArn" + }, + "SubnetId": { + "locationName": "SubnetId" + }, + "EniIp": { + "locationName": "EniIp" + }, + "IamRoleArn": { + "locationName": "IamRoleArn" + }, + "ExternalId": { + "locationName": "ExternalId" + }, + "SyslogIp": { + "locationName": "SyslogIp" + } + }, + "locationName": "ModifyHsmRequest" + }, + "output": { + "type": "structure", + "members": { + "HsmArn": {} + } + } + }, + "ModifyLunaClient": { + "input": { + "type": "structure", + "required": [ + "ClientArn", + "Certificate" + ], + "members": { + "ClientArn": {}, + "Certificate": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClientArn": {} + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeyList" + ], + "members": { + "ResourceArn": {}, + "TagKeyList": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {} + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sz": { + "type": "list", + "member": {} + }, + "S11": { + "type": "list", + "member": {} + }, + "S1i": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.paginators.json b/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudhsm-2014-05-30.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.examples.json b/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.min.json b/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.min.json new file mode 100644 index 0000000..3a57245 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.min.json @@ -0,0 +1,415 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-04-28", + "endpointPrefix": "cloudhsmv2", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "CloudHSM V2", + "serviceFullName": "AWS CloudHSM V2", + "serviceId": "CloudHSM V2", + "signatureVersion": "v4", + "signingName": "cloudhsm", + "targetPrefix": "BaldrApiService", + "uid": "cloudhsmv2-2017-04-28" + }, + "operations": { + "CopyBackupToRegion": { + "input": { + "type": "structure", + "required": [ + "DestinationRegion", + "BackupId" + ], + "members": { + "DestinationRegion": {}, + "BackupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DestinationBackup": { + "type": "structure", + "members": { + "CreateTimestamp": { + "type": "timestamp" + }, + "SourceRegion": {}, + "SourceBackup": {}, + "SourceCluster": {} + } + } + } + } + }, + "CreateCluster": { + "input": { + "type": "structure", + "required": [ + "SubnetIds", + "HsmType" + ], + "members": { + "SubnetIds": { + "type": "list", + "member": {} + }, + "HsmType": {}, + "SourceBackupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sd" + } + } + } + }, + "CreateHsm": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "AvailabilityZone" + ], + "members": { + "ClusterId": {}, + "AvailabilityZone": {}, + "IpAddress": {} + } + }, + "output": { + "type": "structure", + "members": { + "Hsm": { + "shape": "Sg" + } + } + } + }, + "DeleteBackup": { + "input": { + "type": "structure", + "required": [ + "BackupId" + ], + "members": { + "BackupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Backup": { + "shape": "Sz" + } + } + } + }, + "DeleteCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sd" + } + } + } + }, + "DeleteHsm": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "HsmId": {}, + "EniId": {}, + "EniIp": {} + } + }, + "output": { + "type": "structure", + "members": { + "HsmId": {} + } + } + }, + "DescribeBackups": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "S18" + }, + "SortAscending": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Backups": { + "type": "list", + "member": { + "shape": "Sz" + } + }, + "NextToken": {} + } + } + }, + "DescribeClusters": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S18" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Clusters": { + "type": "list", + "member": { + "shape": "Sd" + } + }, + "NextToken": {} + } + } + }, + "InitializeCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "SignedCert", + "TrustAnchor" + ], + "members": { + "ClusterId": {}, + "SignedCert": {}, + "TrustAnchor": {} + } + }, + "output": { + "type": "structure", + "members": { + "State": {}, + "StateMessage": {} + } + } + }, + "ListTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "ResourceId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TagList" + ], + "members": { + "TagList": { + "shape": "S1l" + }, + "NextToken": {} + } + } + }, + "RestoreBackup": { + "input": { + "type": "structure", + "required": [ + "BackupId" + ], + "members": { + "BackupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Backup": { + "shape": "Sz" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagList" + ], + "members": { + "ResourceId": {}, + "TagList": { + "shape": "S1l" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagKeyList" + ], + "members": { + "ResourceId": {}, + "TagKeyList": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sd": { + "type": "structure", + "members": { + "BackupPolicy": {}, + "ClusterId": {}, + "CreateTimestamp": { + "type": "timestamp" + }, + "Hsms": { + "type": "list", + "member": { + "shape": "Sg" + } + }, + "HsmType": {}, + "PreCoPassword": {}, + "SecurityGroup": {}, + "SourceBackupId": {}, + "State": {}, + "StateMessage": {}, + "SubnetMapping": { + "type": "map", + "key": {}, + "value": {} + }, + "VpcId": {}, + "Certificates": { + "type": "structure", + "members": { + "ClusterCsr": {}, + "HsmCertificate": {}, + "AwsHardwareCertificate": {}, + "ManufacturerHardwareCertificate": {}, + "ClusterCertificate": {} + } + } + } + }, + "Sg": { + "type": "structure", + "required": [ + "HsmId" + ], + "members": { + "AvailabilityZone": {}, + "ClusterId": {}, + "SubnetId": {}, + "EniId": {}, + "EniIp": {}, + "HsmId": {}, + "State": {}, + "StateMessage": {} + } + }, + "Sz": { + "type": "structure", + "required": [ + "BackupId" + ], + "members": { + "BackupId": {}, + "BackupState": {}, + "ClusterId": {}, + "CreateTimestamp": { + "type": "timestamp" + }, + "CopyTimestamp": { + "type": "timestamp" + }, + "SourceRegion": {}, + "SourceBackup": {}, + "SourceCluster": {}, + "DeleteTimestamp": { + "type": "timestamp" + } + } + }, + "S18": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "S1l": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.paginators.json b/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.paginators.json new file mode 100644 index 0000000..c0e07e7 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudhsmv2-2017-04-28.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "DescribeBackups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "DescribeClusters": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudsearch-2011-02-01.min.json b/node_modules/aws-sdk/apis/cloudsearch-2011-02-01.min.json new file mode 100644 index 0000000..62ec32d --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudsearch-2011-02-01.min.json @@ -0,0 +1,838 @@ +{ + "metadata": { + "apiVersion": "2011-02-01", + "endpointPrefix": "cloudsearch", + "serviceFullName": "Amazon CloudSearch", + "serviceId": "CloudSearch", + "signatureVersion": "v4", + "xmlNamespace": "http://cloudsearch.amazonaws.com/doc/2011-02-01/", + "protocol": "query" + }, + "operations": { + "CreateDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "CreateDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S4" + } + } + } + }, + "DefineIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexField" + ], + "members": { + "DomainName": {}, + "IndexField": { + "shape": "Sf" + } + } + }, + "output": { + "resultWrapper": "DefineIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "Sx" + } + } + } + }, + "DefineRankExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "RankExpression" + ], + "members": { + "DomainName": {}, + "RankExpression": { + "shape": "S12" + } + } + }, + "output": { + "resultWrapper": "DefineRankExpressionResult", + "type": "structure", + "required": [ + "RankExpression" + ], + "members": { + "RankExpression": { + "shape": "S15" + } + } + } + }, + "DeleteDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DeleteDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S4" + } + } + } + }, + "DeleteIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexFieldName" + ], + "members": { + "DomainName": {}, + "IndexFieldName": {} + } + }, + "output": { + "resultWrapper": "DeleteIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "Sx" + } + } + } + }, + "DeleteRankExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "RankName" + ], + "members": { + "DomainName": {}, + "RankName": {} + } + }, + "output": { + "resultWrapper": "DeleteRankExpressionResult", + "type": "structure", + "required": [ + "RankExpression" + ], + "members": { + "RankExpression": { + "shape": "S15" + } + } + } + }, + "DescribeAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S1e" + } + } + } + }, + "DescribeDefaultSearchField": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeDefaultSearchFieldResult", + "type": "structure", + "required": [ + "DefaultSearchField" + ], + "members": { + "DefaultSearchField": { + "shape": "S1i" + } + } + } + }, + "DescribeDomains": { + "input": { + "type": "structure", + "members": { + "DomainNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeDomainsResult", + "type": "structure", + "required": [ + "DomainStatusList" + ], + "members": { + "DomainStatusList": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + } + }, + "DescribeIndexFields": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "FieldNames": { + "shape": "S1o" + } + } + }, + "output": { + "resultWrapper": "DescribeIndexFieldsResult", + "type": "structure", + "required": [ + "IndexFields" + ], + "members": { + "IndexFields": { + "type": "list", + "member": { + "shape": "Sx" + } + } + } + } + }, + "DescribeRankExpressions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "RankNames": { + "shape": "S1o" + } + } + }, + "output": { + "resultWrapper": "DescribeRankExpressionsResult", + "type": "structure", + "required": [ + "RankExpressions" + ], + "members": { + "RankExpressions": { + "type": "list", + "member": { + "shape": "S15" + } + } + } + } + }, + "DescribeServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S1w" + } + } + } + }, + "DescribeStemmingOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeStemmingOptionsResult", + "type": "structure", + "required": [ + "Stems" + ], + "members": { + "Stems": { + "shape": "S20" + } + } + } + }, + "DescribeStopwordOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeStopwordOptionsResult", + "type": "structure", + "required": [ + "Stopwords" + ], + "members": { + "Stopwords": { + "shape": "S24" + } + } + } + }, + "DescribeSynonymOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeSynonymOptionsResult", + "type": "structure", + "required": [ + "Synonyms" + ], + "members": { + "Synonyms": { + "shape": "S28" + } + } + } + }, + "IndexDocuments": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "IndexDocumentsResult", + "type": "structure", + "members": { + "FieldNames": { + "shape": "S1o" + } + } + } + }, + "UpdateAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "MultiAZ" + ], + "members": { + "DomainName": {}, + "MultiAZ": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "UpdateAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S1e" + } + } + } + }, + "UpdateDefaultSearchField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "DefaultSearchField" + ], + "members": { + "DomainName": {}, + "DefaultSearchField": {} + } + }, + "output": { + "resultWrapper": "UpdateDefaultSearchFieldResult", + "type": "structure", + "required": [ + "DefaultSearchField" + ], + "members": { + "DefaultSearchField": { + "shape": "S1i" + } + } + } + }, + "UpdateServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AccessPolicies" + ], + "members": { + "DomainName": {}, + "AccessPolicies": {} + } + }, + "output": { + "resultWrapper": "UpdateServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S1w" + } + } + } + }, + "UpdateStemmingOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Stems" + ], + "members": { + "DomainName": {}, + "Stems": {} + } + }, + "output": { + "resultWrapper": "UpdateStemmingOptionsResult", + "type": "structure", + "required": [ + "Stems" + ], + "members": { + "Stems": { + "shape": "S20" + } + } + } + }, + "UpdateStopwordOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Stopwords" + ], + "members": { + "DomainName": {}, + "Stopwords": {} + } + }, + "output": { + "resultWrapper": "UpdateStopwordOptionsResult", + "type": "structure", + "required": [ + "Stopwords" + ], + "members": { + "Stopwords": { + "shape": "S24" + } + } + } + }, + "UpdateSynonymOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Synonyms" + ], + "members": { + "DomainName": {}, + "Synonyms": {} + } + }, + "output": { + "resultWrapper": "UpdateSynonymOptionsResult", + "type": "structure", + "required": [ + "Synonyms" + ], + "members": { + "Synonyms": { + "shape": "S28" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members": { + "DomainId": {}, + "DomainName": {}, + "Created": { + "type": "boolean" + }, + "Deleted": { + "type": "boolean" + }, + "NumSearchableDocs": { + "type": "long" + }, + "DocService": { + "shape": "S8" + }, + "SearchService": { + "shape": "S8" + }, + "RequiresIndexDocuments": { + "type": "boolean" + }, + "Processing": { + "type": "boolean" + }, + "SearchInstanceType": {}, + "SearchPartitionCount": { + "type": "integer" + }, + "SearchInstanceCount": { + "type": "integer" + } + } + }, + "S8": { + "type": "structure", + "members": { + "Arn": {}, + "Endpoint": {} + } + }, + "Sf": { + "type": "structure", + "required": [ + "IndexFieldName", + "IndexFieldType" + ], + "members": { + "IndexFieldName": {}, + "IndexFieldType": {}, + "UIntOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "integer" + } + } + }, + "LiteralOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SearchEnabled": { + "type": "boolean" + }, + "FacetEnabled": { + "type": "boolean" + }, + "ResultEnabled": { + "type": "boolean" + } + } + }, + "TextOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "FacetEnabled": { + "type": "boolean" + }, + "ResultEnabled": { + "type": "boolean" + }, + "TextProcessor": {} + } + }, + "SourceAttributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SourceDataFunction" + ], + "members": { + "SourceDataFunction": {}, + "SourceDataCopy": { + "type": "structure", + "required": [ + "SourceName" + ], + "members": { + "SourceName": {}, + "DefaultValue": {} + } + }, + "SourceDataTrimTitle": { + "type": "structure", + "required": [ + "SourceName" + ], + "members": { + "SourceName": {}, + "DefaultValue": {}, + "Separator": {}, + "Language": {} + } + }, + "SourceDataMap": { + "type": "structure", + "required": [ + "SourceName" + ], + "members": { + "SourceName": {}, + "DefaultValue": {}, + "Cases": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + } + } + }, + "Sx": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sf" + }, + "Status": { + "shape": "Sy" + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "CreationDate", + "UpdateDate", + "State" + ], + "members": { + "CreationDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + }, + "UpdateVersion": { + "type": "integer" + }, + "State": {}, + "PendingDeletion": { + "type": "boolean" + } + } + }, + "S12": { + "type": "structure", + "required": [ + "RankName", + "RankExpression" + ], + "members": { + "RankName": {}, + "RankExpression": {} + } + }, + "S15": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S12" + }, + "Status": { + "shape": "Sy" + } + } + }, + "S1e": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "type": "boolean" + }, + "Status": { + "shape": "Sy" + } + } + }, + "S1i": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S1o": { + "type": "list", + "member": {} + }, + "S1w": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S20": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S24": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S28": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudsearch-2011-02-01.paginators.json b/node_modules/aws-sdk/apis/cloudsearch-2011-02-01.paginators.json new file mode 100644 index 0000000..5216445 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudsearch-2011-02-01.paginators.json @@ -0,0 +1,13 @@ +{ + "pagination": { + "DescribeDomains": { + "result_key": "DomainStatusList" + }, + "DescribeIndexFields": { + "result_key": "IndexFields" + }, + "DescribeRankExpressions": { + "result_key": "RankExpressions" + } + } +} diff --git a/node_modules/aws-sdk/apis/cloudsearch-2013-01-01.min.json b/node_modules/aws-sdk/apis/cloudsearch-2013-01-01.min.json new file mode 100644 index 0000000..aaa5194 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudsearch-2013-01-01.min.json @@ -0,0 +1,1088 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-01-01", + "endpointPrefix": "cloudsearch", + "serviceFullName": "Amazon CloudSearch", + "serviceId": "CloudSearch", + "signatureVersion": "v4", + "xmlNamespace": "http://cloudsearch.amazonaws.com/doc/2013-01-01/", + "protocol": "query", + "uid": "cloudsearch-2013-01-01" + }, + "operations": { + "BuildSuggesters": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "BuildSuggestersResult", + "type": "structure", + "members": { + "FieldNames": { + "shape": "S4" + } + } + } + }, + "CreateDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "CreateDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S8" + } + } + } + }, + "DefineAnalysisScheme": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AnalysisScheme" + ], + "members": { + "DomainName": {}, + "AnalysisScheme": { + "shape": "Sl" + } + } + }, + "output": { + "resultWrapper": "DefineAnalysisSchemeResult", + "type": "structure", + "required": [ + "AnalysisScheme" + ], + "members": { + "AnalysisScheme": { + "shape": "Ss" + } + } + } + }, + "DefineExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Expression" + ], + "members": { + "DomainName": {}, + "Expression": { + "shape": "Sy" + } + } + }, + "output": { + "resultWrapper": "DefineExpressionResult", + "type": "structure", + "required": [ + "Expression" + ], + "members": { + "Expression": { + "shape": "S11" + } + } + } + }, + "DefineIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexField" + ], + "members": { + "DomainName": {}, + "IndexField": { + "shape": "S13" + } + } + }, + "output": { + "resultWrapper": "DefineIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "S1n" + } + } + } + }, + "DefineSuggester": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Suggester" + ], + "members": { + "DomainName": {}, + "Suggester": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "DefineSuggesterResult", + "type": "structure", + "required": [ + "Suggester" + ], + "members": { + "Suggester": { + "shape": "S1t" + } + } + } + }, + "DeleteAnalysisScheme": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AnalysisSchemeName" + ], + "members": { + "DomainName": {}, + "AnalysisSchemeName": {} + } + }, + "output": { + "resultWrapper": "DeleteAnalysisSchemeResult", + "type": "structure", + "required": [ + "AnalysisScheme" + ], + "members": { + "AnalysisScheme": { + "shape": "Ss" + } + } + } + }, + "DeleteDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DeleteDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S8" + } + } + } + }, + "DeleteExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ExpressionName" + ], + "members": { + "DomainName": {}, + "ExpressionName": {} + } + }, + "output": { + "resultWrapper": "DeleteExpressionResult", + "type": "structure", + "required": [ + "Expression" + ], + "members": { + "Expression": { + "shape": "S11" + } + } + } + }, + "DeleteIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexFieldName" + ], + "members": { + "DomainName": {}, + "IndexFieldName": {} + } + }, + "output": { + "resultWrapper": "DeleteIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "S1n" + } + } + } + }, + "DeleteSuggester": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "SuggesterName" + ], + "members": { + "DomainName": {}, + "SuggesterName": {} + } + }, + "output": { + "resultWrapper": "DeleteSuggesterResult", + "type": "structure", + "required": [ + "Suggester" + ], + "members": { + "Suggester": { + "shape": "S1t" + } + } + } + }, + "DescribeAnalysisSchemes": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AnalysisSchemeNames": { + "shape": "S25" + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeAnalysisSchemesResult", + "type": "structure", + "required": [ + "AnalysisSchemes" + ], + "members": { + "AnalysisSchemes": { + "type": "list", + "member": { + "shape": "Ss" + } + } + } + } + }, + "DescribeAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S2a" + } + } + } + }, + "DescribeDomains": { + "input": { + "type": "structure", + "members": { + "DomainNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeDomainsResult", + "type": "structure", + "required": [ + "DomainStatusList" + ], + "members": { + "DomainStatusList": { + "type": "list", + "member": { + "shape": "S8" + } + } + } + } + }, + "DescribeExpressions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "ExpressionNames": { + "shape": "S25" + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeExpressionsResult", + "type": "structure", + "required": [ + "Expressions" + ], + "members": { + "Expressions": { + "type": "list", + "member": { + "shape": "S11" + } + } + } + } + }, + "DescribeIndexFields": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "FieldNames": { + "type": "list", + "member": {} + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeIndexFieldsResult", + "type": "structure", + "required": [ + "IndexFields" + ], + "members": { + "IndexFields": { + "type": "list", + "member": { + "shape": "S1n" + } + } + } + } + }, + "DescribeScalingParameters": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeScalingParametersResult", + "type": "structure", + "required": [ + "ScalingParameters" + ], + "members": { + "ScalingParameters": { + "shape": "S2p" + } + } + } + }, + "DescribeServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S2u" + } + } + } + }, + "DescribeSuggesters": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "SuggesterNames": { + "shape": "S25" + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeSuggestersResult", + "type": "structure", + "required": [ + "Suggesters" + ], + "members": { + "Suggesters": { + "type": "list", + "member": { + "shape": "S1t" + } + } + } + } + }, + "IndexDocuments": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "IndexDocumentsResult", + "type": "structure", + "members": { + "FieldNames": { + "shape": "S4" + } + } + } + }, + "ListDomainNames": { + "output": { + "resultWrapper": "ListDomainNamesResult", + "type": "structure", + "members": { + "DomainNames": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "UpdateAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "MultiAZ" + ], + "members": { + "DomainName": {}, + "MultiAZ": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "UpdateAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S2a" + } + } + } + }, + "UpdateScalingParameters": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ScalingParameters" + ], + "members": { + "DomainName": {}, + "ScalingParameters": { + "shape": "S2q" + } + } + }, + "output": { + "resultWrapper": "UpdateScalingParametersResult", + "type": "structure", + "required": [ + "ScalingParameters" + ], + "members": { + "ScalingParameters": { + "shape": "S2p" + } + } + } + }, + "UpdateServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AccessPolicies" + ], + "members": { + "DomainName": {}, + "AccessPolicies": {} + } + }, + "output": { + "resultWrapper": "UpdateServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S2u" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": {} + }, + "S8": { + "type": "structure", + "required": [ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members": { + "DomainId": {}, + "DomainName": {}, + "ARN": {}, + "Created": { + "type": "boolean" + }, + "Deleted": { + "type": "boolean" + }, + "DocService": { + "shape": "Sc" + }, + "SearchService": { + "shape": "Sc" + }, + "RequiresIndexDocuments": { + "type": "boolean" + }, + "Processing": { + "type": "boolean" + }, + "SearchInstanceType": {}, + "SearchPartitionCount": { + "type": "integer" + }, + "SearchInstanceCount": { + "type": "integer" + }, + "Limits": { + "type": "structure", + "required": [ + "MaximumReplicationCount", + "MaximumPartitionCount" + ], + "members": { + "MaximumReplicationCount": { + "type": "integer" + }, + "MaximumPartitionCount": { + "type": "integer" + } + } + } + } + }, + "Sc": { + "type": "structure", + "members": { + "Endpoint": {} + } + }, + "Sl": { + "type": "structure", + "required": [ + "AnalysisSchemeName", + "AnalysisSchemeLanguage" + ], + "members": { + "AnalysisSchemeName": {}, + "AnalysisSchemeLanguage": {}, + "AnalysisOptions": { + "type": "structure", + "members": { + "Synonyms": {}, + "Stopwords": {}, + "StemmingDictionary": {}, + "JapaneseTokenizationDictionary": {}, + "AlgorithmicStemming": {} + } + } + } + }, + "Ss": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sl" + }, + "Status": { + "shape": "St" + } + } + }, + "St": { + "type": "structure", + "required": [ + "CreationDate", + "UpdateDate", + "State" + ], + "members": { + "CreationDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + }, + "UpdateVersion": { + "type": "integer" + }, + "State": {}, + "PendingDeletion": { + "type": "boolean" + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "ExpressionName", + "ExpressionValue" + ], + "members": { + "ExpressionName": {}, + "ExpressionValue": {} + } + }, + "S11": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sy" + }, + "Status": { + "shape": "St" + } + } + }, + "S13": { + "type": "structure", + "required": [ + "IndexFieldName", + "IndexFieldType" + ], + "members": { + "IndexFieldName": {}, + "IndexFieldType": {}, + "IntOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "long" + }, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "DoubleOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "double" + }, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "LiteralOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "TextOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + }, + "HighlightEnabled": { + "type": "boolean" + }, + "AnalysisScheme": {} + } + }, + "DateOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "LatLonOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "IntArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "long" + }, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + }, + "DoubleArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "double" + }, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + }, + "LiteralArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + }, + "TextArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceFields": {}, + "ReturnEnabled": { + "type": "boolean" + }, + "HighlightEnabled": { + "type": "boolean" + }, + "AnalysisScheme": {} + } + }, + "DateArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + } + } + }, + "S1n": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S13" + }, + "Status": { + "shape": "St" + } + } + }, + "S1p": { + "type": "structure", + "required": [ + "SuggesterName", + "DocumentSuggesterOptions" + ], + "members": { + "SuggesterName": {}, + "DocumentSuggesterOptions": { + "type": "structure", + "required": [ + "SourceField" + ], + "members": { + "SourceField": {}, + "FuzzyMatching": {}, + "SortExpression": {} + } + } + } + }, + "S1t": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S1p" + }, + "Status": { + "shape": "St" + } + } + }, + "S25": { + "type": "list", + "member": {} + }, + "S2a": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "type": "boolean" + }, + "Status": { + "shape": "St" + } + } + }, + "S2p": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S2q" + }, + "Status": { + "shape": "St" + } + } + }, + "S2q": { + "type": "structure", + "members": { + "DesiredInstanceType": {}, + "DesiredReplicationCount": { + "type": "integer" + }, + "DesiredPartitionCount": { + "type": "integer" + } + } + }, + "S2u": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "St" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudsearch-2013-01-01.paginators.json b/node_modules/aws-sdk/apis/cloudsearch-2013-01-01.paginators.json new file mode 100644 index 0000000..82fa804 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudsearch-2013-01-01.paginators.json @@ -0,0 +1,20 @@ +{ + "pagination": { + "DescribeAnalysisSchemes": { + "result_key": "AnalysisSchemes" + }, + "DescribeDomains": { + "result_key": "DomainStatusList" + }, + "DescribeExpressions": { + "result_key": "Expressions" + }, + "DescribeIndexFields": { + "result_key": "IndexFields" + }, + "DescribeSuggesters": { + "result_key": "Suggesters" + } + } +} + diff --git a/node_modules/aws-sdk/apis/cloudsearchdomain-2013-01-01.min.json b/node_modules/aws-sdk/apis/cloudsearchdomain-2013-01-01.min.json new file mode 100644 index 0000000..06a6fda --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudsearchdomain-2013-01-01.min.json @@ -0,0 +1,299 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-01-01", + "endpointPrefix": "cloudsearchdomain", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon CloudSearch Domain", + "serviceId": "CloudSearch Domain", + "signatureVersion": "v4", + "signingName": "cloudsearch", + "uid": "cloudsearchdomain-2013-01-01" + }, + "operations": { + "Search": { + "http": { + "method": "GET", + "requestUri": "/2013-01-01/search?format=sdk&pretty=true" + }, + "input": { + "type": "structure", + "required": [ + "query" + ], + "members": { + "cursor": { + "location": "querystring", + "locationName": "cursor" + }, + "expr": { + "location": "querystring", + "locationName": "expr" + }, + "facet": { + "location": "querystring", + "locationName": "facet" + }, + "filterQuery": { + "location": "querystring", + "locationName": "fq" + }, + "highlight": { + "location": "querystring", + "locationName": "highlight" + }, + "partial": { + "location": "querystring", + "locationName": "partial", + "type": "boolean" + }, + "query": { + "location": "querystring", + "locationName": "q" + }, + "queryOptions": { + "location": "querystring", + "locationName": "q.options" + }, + "queryParser": { + "location": "querystring", + "locationName": "q.parser" + }, + "return": { + "location": "querystring", + "locationName": "return" + }, + "size": { + "location": "querystring", + "locationName": "size", + "type": "long" + }, + "sort": { + "location": "querystring", + "locationName": "sort" + }, + "start": { + "location": "querystring", + "locationName": "start", + "type": "long" + }, + "stats": { + "location": "querystring", + "locationName": "stats" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": { + "type": "structure", + "members": { + "timems": { + "type": "long" + }, + "rid": {} + } + }, + "hits": { + "type": "structure", + "members": { + "found": { + "type": "long" + }, + "start": { + "type": "long" + }, + "cursor": {}, + "hit": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "fields": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "exprs": { + "type": "map", + "key": {}, + "value": {} + }, + "highlights": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + }, + "facets": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "buckets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "value": {}, + "count": { + "type": "long" + } + } + } + } + } + } + }, + "stats": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "min": {}, + "max": {}, + "count": { + "type": "long" + }, + "missing": { + "type": "long" + }, + "sum": { + "type": "double" + }, + "sumOfSquares": { + "type": "double" + }, + "mean": {}, + "stddev": { + "type": "double" + } + } + } + } + } + } + }, + "Suggest": { + "http": { + "method": "GET", + "requestUri": "/2013-01-01/suggest?format=sdk&pretty=true" + }, + "input": { + "type": "structure", + "required": [ + "query", + "suggester" + ], + "members": { + "query": { + "location": "querystring", + "locationName": "q" + }, + "suggester": { + "location": "querystring", + "locationName": "suggester" + }, + "size": { + "location": "querystring", + "locationName": "size", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": { + "type": "structure", + "members": { + "timems": { + "type": "long" + }, + "rid": {} + } + }, + "suggest": { + "type": "structure", + "members": { + "query": {}, + "found": { + "type": "long" + }, + "suggestions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "suggestion": {}, + "score": { + "type": "long" + }, + "id": {} + } + } + } + } + } + } + } + }, + "UploadDocuments": { + "http": { + "requestUri": "/2013-01-01/documents/batch?format=sdk" + }, + "input": { + "type": "structure", + "required": [ + "documents", + "contentType" + ], + "members": { + "documents": { + "type": "blob", + "streaming": true + }, + "contentType": { + "location": "header", + "locationName": "Content-Type" + } + }, + "payload": "documents" + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "adds": { + "type": "long" + }, + "deletes": { + "type": "long" + }, + "warnings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "message": {} + } + } + } + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.examples.json b/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json b/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json new file mode 100644 index 0000000..0d71cfe --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json @@ -0,0 +1,548 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-11-01", + "endpointPrefix": "cloudtrail", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "CloudTrail", + "serviceFullName": "AWS CloudTrail", + "serviceId": "CloudTrail", + "signatureVersion": "v4", + "targetPrefix": "com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101", + "uid": "cloudtrail-2013-11-01" + }, + "operations": { + "AddTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "ResourceId": {}, + "TagsList": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "CreateTrail": { + "input": { + "type": "structure", + "required": [ + "Name", + "S3BucketName" + ], + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + }, + "IsMultiRegionTrail": { + "type": "boolean" + }, + "EnableLogFileValidation": { + "type": "boolean" + }, + "CloudWatchLogsLogGroupArn": {}, + "CloudWatchLogsRoleArn": {}, + "KmsKeyId": {}, + "IsOrganizationTrail": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": { + "deprecated": true + }, + "SnsTopicARN": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + }, + "IsMultiRegionTrail": { + "type": "boolean" + }, + "TrailARN": {}, + "LogFileValidationEnabled": { + "type": "boolean" + }, + "CloudWatchLogsLogGroupArn": {}, + "CloudWatchLogsRoleArn": {}, + "KmsKeyId": {}, + "IsOrganizationTrail": { + "type": "boolean" + } + } + }, + "idempotent": true + }, + "DeleteTrail": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DescribeTrails": { + "input": { + "type": "structure", + "members": { + "trailNameList": { + "type": "list", + "member": {} + }, + "includeShadowTrails": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "trailList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": { + "deprecated": true + }, + "SnsTopicARN": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + }, + "IsMultiRegionTrail": { + "type": "boolean" + }, + "HomeRegion": {}, + "TrailARN": {}, + "LogFileValidationEnabled": { + "type": "boolean" + }, + "CloudWatchLogsLogGroupArn": {}, + "CloudWatchLogsRoleArn": {}, + "KmsKeyId": {}, + "HasCustomEventSelectors": { + "type": "boolean" + }, + "IsOrganizationTrail": { + "type": "boolean" + } + } + } + } + } + }, + "idempotent": true + }, + "GetEventSelectors": { + "input": { + "type": "structure", + "required": [ + "TrailName" + ], + "members": { + "TrailName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TrailARN": {}, + "EventSelectors": { + "shape": "Si" + } + } + }, + "idempotent": true + }, + "GetTrailStatus": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "IsLogging": { + "type": "boolean" + }, + "LatestDeliveryError": {}, + "LatestNotificationError": {}, + "LatestDeliveryTime": { + "type": "timestamp" + }, + "LatestNotificationTime": { + "type": "timestamp" + }, + "StartLoggingTime": { + "type": "timestamp" + }, + "StopLoggingTime": { + "type": "timestamp" + }, + "LatestCloudWatchLogsDeliveryError": {}, + "LatestCloudWatchLogsDeliveryTime": { + "type": "timestamp" + }, + "LatestDigestDeliveryTime": { + "type": "timestamp" + }, + "LatestDigestDeliveryError": {}, + "LatestDeliveryAttemptTime": {}, + "LatestNotificationAttemptTime": {}, + "LatestNotificationAttemptSucceeded": {}, + "LatestDeliveryAttemptSucceeded": {}, + "TimeLoggingStarted": {}, + "TimeLoggingStopped": {} + } + }, + "idempotent": true + }, + "ListPublicKeys": { + "input": { + "type": "structure", + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": { + "type": "blob" + }, + "ValidityStartTime": { + "type": "timestamp" + }, + "ValidityEndTime": { + "type": "timestamp" + }, + "Fingerprint": {} + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListTags": { + "input": { + "type": "structure", + "required": [ + "ResourceIdList" + ], + "members": { + "ResourceIdList": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceTagList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceId": {}, + "TagsList": { + "shape": "S3" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "LookupEvents": { + "input": { + "type": "structure", + "members": { + "LookupAttributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeKey", + "AttributeValue" + ], + "members": { + "AttributeKey": {}, + "AttributeValue": {} + } + } + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventId": {}, + "EventName": {}, + "ReadOnly": {}, + "AccessKeyId": {}, + "EventTime": { + "type": "timestamp" + }, + "EventSource": {}, + "Username": {}, + "Resources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceType": {}, + "ResourceName": {} + } + } + }, + "CloudTrailEvent": {} + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "PutEventSelectors": { + "input": { + "type": "structure", + "required": [ + "TrailName", + "EventSelectors" + ], + "members": { + "TrailName": {}, + "EventSelectors": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": { + "TrailARN": {}, + "EventSelectors": { + "shape": "Si" + } + } + }, + "idempotent": true + }, + "RemoveTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "ResourceId": {}, + "TagsList": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "StartLogging": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "StopLogging": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateTrail": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + }, + "IsMultiRegionTrail": { + "type": "boolean" + }, + "EnableLogFileValidation": { + "type": "boolean" + }, + "CloudWatchLogsLogGroupArn": {}, + "CloudWatchLogsRoleArn": {}, + "KmsKeyId": {}, + "IsOrganizationTrail": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": { + "deprecated": true + }, + "SnsTopicARN": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + }, + "IsMultiRegionTrail": { + "type": "boolean" + }, + "TrailARN": {}, + "LogFileValidationEnabled": { + "type": "boolean" + }, + "CloudWatchLogsLogGroupArn": {}, + "CloudWatchLogsRoleArn": {}, + "KmsKeyId": {}, + "IsOrganizationTrail": { + "type": "boolean" + } + } + }, + "idempotent": true + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Si": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ReadWriteType": {}, + "IncludeManagementEvents": { + "type": "boolean" + }, + "DataResources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.paginators.json b/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.paginators.json new file mode 100644 index 0000000..868fef8 --- /dev/null +++ b/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.paginators.json @@ -0,0 +1,13 @@ +{ + "pagination": { + "DescribeTrails": { + "result_key": "trailList" + }, + "LookupEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Events" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codebuild-2016-10-06.examples.json b/node_modules/aws-sdk/apis/codebuild-2016-10-06.examples.json new file mode 100644 index 0000000..a5fb660 --- /dev/null +++ b/node_modules/aws-sdk/apis/codebuild-2016-10-06.examples.json @@ -0,0 +1,281 @@ +{ + "version": "1.0", + "examples": { + "BatchGetBuilds": [ + { + "input": { + "ids": [ + "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX" + ] + }, + "output": { + "builds": [ + { + "arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "artifacts": { + "location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project" + }, + "buildComplete": true, + "buildStatus": "SUCCEEDED", + "currentPhase": "COMPLETED", + "endTime": 1479832474.764, + "environment": { + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [ + + ], + "image": "aws/codebuild/java:openjdk-8", + "privilegedMode": false + }, + "id": "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "initiator": "MyDemoUser", + "logs": { + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=9b0ac37f-d19e-4254-9079-f47e9a389eEX", + "groupName": "/aws/codebuild/codebuild-demo-project", + "streamName": "9b0ac37f-d19e-4254-9079-f47e9a389eEX" + }, + "phases": [ + { + "durationInSeconds": 0, + "endTime": 1479832342.23, + "phaseStatus": "SUCCEEDED", + "phaseType": "SUBMITTED", + "startTime": 1479832341.854 + }, + { + "contexts": [ + + ], + "durationInSeconds": 72, + "endTime": 1479832415.064, + "phaseStatus": "SUCCEEDED", + "phaseType": "PROVISIONING", + "startTime": 1479832342.23 + }, + { + "contexts": [ + + ], + "durationInSeconds": 46, + "endTime": 1479832461.261, + "phaseStatus": "SUCCEEDED", + "phaseType": "DOWNLOAD_SOURCE", + "startTime": 1479832415.064 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832461.354, + "phaseStatus": "SUCCEEDED", + "phaseType": "INSTALL", + "startTime": 1479832461.261 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832461.448, + "phaseStatus": "SUCCEEDED", + "phaseType": "PRE_BUILD", + "startTime": 1479832461.354 + }, + { + "contexts": [ + + ], + "durationInSeconds": 9, + "endTime": 1479832471.115, + "phaseStatus": "SUCCEEDED", + "phaseType": "BUILD", + "startTime": 1479832461.448 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832471.224, + "phaseStatus": "SUCCEEDED", + "phaseType": "POST_BUILD", + "startTime": 1479832471.115 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479832471.791, + "phaseStatus": "SUCCEEDED", + "phaseType": "UPLOAD_ARTIFACTS", + "startTime": 1479832471.224 + }, + { + "contexts": [ + + ], + "durationInSeconds": 2, + "endTime": 1479832474.764, + "phaseStatus": "SUCCEEDED", + "phaseType": "FINALIZING", + "startTime": 1479832471.791 + }, + { + "phaseType": "COMPLETED", + "startTime": 1479832474.764 + } + ], + "projectName": "codebuild-demo-project", + "source": { + "type": "S3", + "buildspec": "", + "location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip" + }, + "startTime": 1479832341.854, + "timeoutInMinutes": 60 + }, + { + "arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX", + "artifacts": { + "location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project" + }, + "buildComplete": true, + "buildStatus": "SUCCEEDED", + "currentPhase": "COMPLETED", + "endTime": 1479401214.239, + "environment": { + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [ + + ], + "image": "aws/codebuild/java:openjdk-8", + "privilegedMode": false + }, + "id": "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX", + "initiator": "MyDemoUser", + "logs": { + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=b79a46f7-1473-4636-a23f-da9c45c208EX", + "groupName": "/aws/codebuild/codebuild-demo-project", + "streamName": "b79a46f7-1473-4636-a23f-da9c45c208EX" + }, + "phases": [ + { + "durationInSeconds": 0, + "endTime": 1479401082.342, + "phaseStatus": "SUCCEEDED", + "phaseType": "SUBMITTED", + "startTime": 1479401081.869 + }, + { + "contexts": [ + + ], + "durationInSeconds": 71, + "endTime": 1479401154.129, + "phaseStatus": "SUCCEEDED", + "phaseType": "PROVISIONING", + "startTime": 1479401082.342 + }, + { + "contexts": [ + + ], + "durationInSeconds": 45, + "endTime": 1479401199.136, + "phaseStatus": "SUCCEEDED", + "phaseType": "DOWNLOAD_SOURCE", + "startTime": 1479401154.129 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401199.236, + "phaseStatus": "SUCCEEDED", + "phaseType": "INSTALL", + "startTime": 1479401199.136 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401199.345, + "phaseStatus": "SUCCEEDED", + "phaseType": "PRE_BUILD", + "startTime": 1479401199.236 + }, + { + "contexts": [ + + ], + "durationInSeconds": 9, + "endTime": 1479401208.68, + "phaseStatus": "SUCCEEDED", + "phaseType": "BUILD", + "startTime": 1479401199.345 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401208.783, + "phaseStatus": "SUCCEEDED", + "phaseType": "POST_BUILD", + "startTime": 1479401208.68 + }, + { + "contexts": [ + + ], + "durationInSeconds": 0, + "endTime": 1479401209.463, + "phaseStatus": "SUCCEEDED", + "phaseType": "UPLOAD_ARTIFACTS", + "startTime": 1479401208.783 + }, + { + "contexts": [ + + ], + "durationInSeconds": 4, + "endTime": 1479401214.239, + "phaseStatus": "SUCCEEDED", + "phaseType": "FINALIZING", + "startTime": 1479401209.463 + }, + { + "phaseType": "COMPLETED", + "startTime": 1479401214.239 + } + ], + "projectName": "codebuild-demo-project", + "source": { + "type": "S3", + "location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip" + }, + "startTime": 1479401081.869, + "timeoutInMinutes": 60 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets information about builds with the specified build IDs.", + "id": "to-get-information-about-builds-1501187184588", + "title": "To get information about builds" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/codebuild-2016-10-06.min.json b/node_modules/aws-sdk/apis/codebuild-2016-10-06.min.json new file mode 100644 index 0000000..5977c81 --- /dev/null +++ b/node_modules/aws-sdk/apis/codebuild-2016-10-06.min.json @@ -0,0 +1,1025 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-10-06", + "endpointPrefix": "codebuild", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS CodeBuild", + "serviceId": "CodeBuild", + "signatureVersion": "v4", + "targetPrefix": "CodeBuild_20161006", + "uid": "codebuild-2016-10-06" + }, + "operations": { + "BatchDeleteBuilds": { + "input": { + "type": "structure", + "required": [ + "ids" + ], + "members": { + "ids": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "buildsDeleted": { + "shape": "S2" + }, + "buildsNotDeleted": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "statusCode": {} + } + } + } + } + } + }, + "BatchGetBuilds": { + "input": { + "type": "structure", + "required": [ + "ids" + ], + "members": { + "ids": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "builds": { + "type": "list", + "member": { + "shape": "Sb" + } + }, + "buildsNotFound": { + "shape": "S2" + } + } + } + }, + "BatchGetProjects": { + "input": { + "type": "structure", + "required": [ + "names" + ], + "members": { + "names": { + "shape": "S1k" + } + } + }, + "output": { + "type": "structure", + "members": { + "projects": { + "type": "list", + "member": { + "shape": "S1n" + } + }, + "projectsNotFound": { + "shape": "S1k" + } + } + } + }, + "CreateProject": { + "input": { + "type": "structure", + "required": [ + "name", + "source", + "artifacts", + "environment", + "serviceRole" + ], + "members": { + "name": {}, + "description": {}, + "source": { + "shape": "Sk" + }, + "secondarySources": { + "shape": "Sr" + }, + "artifacts": { + "shape": "S1q" + }, + "secondaryArtifacts": { + "shape": "S1u" + }, + "cache": { + "shape": "Sw" + }, + "environment": { + "shape": "S10" + }, + "serviceRole": {}, + "timeoutInMinutes": { + "type": "integer" + }, + "queuedTimeoutInMinutes": { + "type": "integer" + }, + "encryptionKey": {}, + "tags": { + "shape": "S1w" + }, + "vpcConfig": { + "shape": "S1f" + }, + "badgeEnabled": { + "type": "boolean" + }, + "logsConfig": { + "shape": "S26" + } + } + }, + "output": { + "type": "structure", + "members": { + "project": { + "shape": "S1n" + } + } + } + }, + "CreateWebhook": { + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": {}, + "branchFilter": {}, + "filterGroups": { + "shape": "S21" + } + } + }, + "output": { + "type": "structure", + "members": { + "webhook": { + "shape": "S20" + } + } + } + }, + "DeleteProject": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSourceCredentials": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {} + } + } + }, + "DeleteWebhook": { + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ImportSourceCredentials": { + "input": { + "type": "structure", + "required": [ + "token", + "serverType", + "authType" + ], + "members": { + "username": {}, + "token": { + "type": "string", + "sensitive": true + }, + "serverType": {}, + "authType": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {} + } + } + }, + "InvalidateProjectCache": { + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListBuilds": { + "input": { + "type": "structure", + "members": { + "sortOrder": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ids": { + "shape": "S2" + }, + "nextToken": {} + } + } + }, + "ListBuildsForProject": { + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": {}, + "sortOrder": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ids": { + "shape": "S2" + }, + "nextToken": {} + } + } + }, + "ListCuratedEnvironmentImages": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "platforms": { + "type": "list", + "member": { + "type": "structure", + "members": { + "platform": {}, + "languages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "language": {}, + "images": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "versions": { + "type": "list", + "member": {} + } + } + } + } + } + } + } + } + } + } + } + } + }, + "ListProjects": { + "input": { + "type": "structure", + "members": { + "sortBy": {}, + "sortOrder": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "nextToken": {}, + "projects": { + "shape": "S1k" + } + } + } + }, + "ListSourceCredentials": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "sourceCredentialsInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "serverType": {}, + "authType": {} + } + } + } + } + } + }, + "StartBuild": { + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": {}, + "secondarySourcesOverride": { + "shape": "Sr" + }, + "secondarySourcesVersionOverride": { + "shape": "Ss" + }, + "sourceVersion": {}, + "artifactsOverride": { + "shape": "S1q" + }, + "secondaryArtifactsOverride": { + "shape": "S1u" + }, + "environmentVariablesOverride": { + "shape": "S13" + }, + "sourceTypeOverride": {}, + "sourceLocationOverride": {}, + "sourceAuthOverride": { + "shape": "Sp" + }, + "gitCloneDepthOverride": { + "type": "integer" + }, + "gitSubmodulesConfigOverride": { + "shape": "Sn" + }, + "buildspecOverride": {}, + "insecureSslOverride": { + "type": "boolean" + }, + "reportBuildStatusOverride": { + "type": "boolean" + }, + "environmentTypeOverride": {}, + "imageOverride": {}, + "computeTypeOverride": {}, + "certificateOverride": {}, + "cacheOverride": { + "shape": "Sw" + }, + "serviceRoleOverride": {}, + "privilegedModeOverride": { + "type": "boolean" + }, + "timeoutInMinutesOverride": { + "type": "integer" + }, + "queuedTimeoutInMinutesOverride": { + "type": "integer" + }, + "idempotencyToken": {}, + "logsConfigOverride": { + "shape": "S26" + }, + "registryCredentialOverride": { + "shape": "S16" + }, + "imagePullCredentialsTypeOverride": {} + } + }, + "output": { + "type": "structure", + "members": { + "build": { + "shape": "Sb" + } + } + } + }, + "StopBuild": { + "input": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": {} + } + }, + "output": { + "type": "structure", + "members": { + "build": { + "shape": "Sb" + } + } + } + }, + "UpdateProject": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "description": {}, + "source": { + "shape": "Sk" + }, + "secondarySources": { + "shape": "Sr" + }, + "artifacts": { + "shape": "S1q" + }, + "secondaryArtifacts": { + "shape": "S1u" + }, + "cache": { + "shape": "Sw" + }, + "environment": { + "shape": "S10" + }, + "serviceRole": {}, + "timeoutInMinutes": { + "type": "integer" + }, + "queuedTimeoutInMinutes": { + "type": "integer" + }, + "encryptionKey": {}, + "tags": { + "shape": "S1w" + }, + "vpcConfig": { + "shape": "S1f" + }, + "badgeEnabled": { + "type": "boolean" + }, + "logsConfig": { + "shape": "S26" + } + } + }, + "output": { + "type": "structure", + "members": { + "project": { + "shape": "S1n" + } + } + } + }, + "UpdateWebhook": { + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": {}, + "branchFilter": {}, + "rotateSecret": { + "type": "boolean" + }, + "filterGroups": { + "shape": "S21" + } + } + }, + "output": { + "type": "structure", + "members": { + "webhook": { + "shape": "S20" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "Sb": { + "type": "structure", + "members": { + "id": {}, + "arn": {}, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "currentPhase": {}, + "buildStatus": {}, + "sourceVersion": {}, + "resolvedSourceVersion": {}, + "projectName": {}, + "phases": { + "type": "list", + "member": { + "type": "structure", + "members": { + "phaseType": {}, + "phaseStatus": {}, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "durationInSeconds": { + "type": "long" + }, + "contexts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "statusCode": {}, + "message": {} + } + } + } + } + } + }, + "source": { + "shape": "Sk" + }, + "secondarySources": { + "shape": "Sr" + }, + "secondarySourceVersions": { + "shape": "Ss" + }, + "artifacts": { + "shape": "Su" + }, + "secondaryArtifacts": { + "type": "list", + "member": { + "shape": "Su" + } + }, + "cache": { + "shape": "Sw" + }, + "environment": { + "shape": "S10" + }, + "serviceRole": {}, + "logs": { + "type": "structure", + "members": { + "groupName": {}, + "streamName": {}, + "deepLink": {}, + "s3DeepLink": {}, + "cloudWatchLogs": { + "shape": "S1a" + }, + "s3Logs": { + "shape": "S1c" + } + } + }, + "timeoutInMinutes": { + "type": "integer" + }, + "queuedTimeoutInMinutes": { + "type": "integer" + }, + "buildComplete": { + "type": "boolean" + }, + "initiator": {}, + "vpcConfig": { + "shape": "S1f" + }, + "networkInterface": { + "type": "structure", + "members": { + "subnetId": {}, + "networkInterfaceId": {} + } + }, + "encryptionKey": {} + } + }, + "Sk": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "location": {}, + "gitCloneDepth": { + "type": "integer" + }, + "gitSubmodulesConfig": { + "shape": "Sn" + }, + "buildspec": {}, + "auth": { + "shape": "Sp" + }, + "reportBuildStatus": { + "type": "boolean" + }, + "insecureSsl": { + "type": "boolean" + }, + "sourceIdentifier": {} + } + }, + "Sn": { + "type": "structure", + "required": [ + "fetchSubmodules" + ], + "members": { + "fetchSubmodules": { + "type": "boolean" + } + } + }, + "Sp": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "resource": {} + } + }, + "Sr": { + "type": "list", + "member": { + "shape": "Sk" + } + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "sourceIdentifier", + "sourceVersion" + ], + "members": { + "sourceIdentifier": {}, + "sourceVersion": {} + } + } + }, + "Su": { + "type": "structure", + "members": { + "location": {}, + "sha256sum": {}, + "md5sum": {}, + "overrideArtifactName": { + "type": "boolean" + }, + "encryptionDisabled": { + "type": "boolean" + }, + "artifactIdentifier": {} + } + }, + "Sw": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "location": {}, + "modes": { + "type": "list", + "member": {} + } + } + }, + "S10": { + "type": "structure", + "required": [ + "type", + "image", + "computeType" + ], + "members": { + "type": {}, + "image": {}, + "computeType": {}, + "environmentVariables": { + "shape": "S13" + }, + "privilegedMode": { + "type": "boolean" + }, + "certificate": {}, + "registryCredential": { + "shape": "S16" + }, + "imagePullCredentialsType": {} + } + }, + "S13": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "value" + ], + "members": { + "name": {}, + "value": {}, + "type": {} + } + } + }, + "S16": { + "type": "structure", + "required": [ + "credential", + "credentialProvider" + ], + "members": { + "credential": {}, + "credentialProvider": {} + } + }, + "S1a": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {}, + "groupName": {}, + "streamName": {} + } + }, + "S1c": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {}, + "location": {}, + "encryptionDisabled": { + "type": "boolean" + } + } + }, + "S1f": { + "type": "structure", + "members": { + "vpcId": {}, + "subnets": { + "type": "list", + "member": {} + }, + "securityGroupIds": { + "type": "list", + "member": {} + } + } + }, + "S1k": { + "type": "list", + "member": {} + }, + "S1n": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "description": {}, + "source": { + "shape": "Sk" + }, + "secondarySources": { + "shape": "Sr" + }, + "artifacts": { + "shape": "S1q" + }, + "secondaryArtifacts": { + "shape": "S1u" + }, + "cache": { + "shape": "Sw" + }, + "environment": { + "shape": "S10" + }, + "serviceRole": {}, + "timeoutInMinutes": { + "type": "integer" + }, + "queuedTimeoutInMinutes": { + "type": "integer" + }, + "encryptionKey": {}, + "tags": { + "shape": "S1w" + }, + "created": { + "type": "timestamp" + }, + "lastModified": { + "type": "timestamp" + }, + "webhook": { + "shape": "S20" + }, + "vpcConfig": { + "shape": "S1f" + }, + "badge": { + "type": "structure", + "members": { + "badgeEnabled": { + "type": "boolean" + }, + "badgeRequestUrl": {} + } + }, + "logsConfig": { + "shape": "S26" + } + } + }, + "S1q": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "location": {}, + "path": {}, + "namespaceType": {}, + "name": {}, + "packaging": {}, + "overrideArtifactName": { + "type": "boolean" + }, + "encryptionDisabled": { + "type": "boolean" + }, + "artifactIdentifier": {} + } + }, + "S1u": { + "type": "list", + "member": { + "shape": "S1q" + } + }, + "S1w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "S20": { + "type": "structure", + "members": { + "url": {}, + "payloadUrl": {}, + "secret": {}, + "branchFilter": {}, + "filterGroups": { + "shape": "S21" + }, + "lastModifiedSecret": { + "type": "timestamp" + } + } + }, + "S21": { + "type": "list", + "member": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "type", + "pattern" + ], + "members": { + "type": {}, + "pattern": {}, + "excludeMatchedPattern": { + "type": "boolean" + } + } + } + } + }, + "S26": { + "type": "structure", + "members": { + "cloudWatchLogs": { + "shape": "S1a" + }, + "s3Logs": { + "shape": "S1c" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codebuild-2016-10-06.paginators.json b/node_modules/aws-sdk/apis/codebuild-2016-10-06.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/codebuild-2016-10-06.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/codecommit-2015-04-13.examples.json b/node_modules/aws-sdk/apis/codecommit-2015-04-13.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/codecommit-2015-04-13.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/codecommit-2015-04-13.min.json b/node_modules/aws-sdk/apis/codecommit-2015-04-13.min.json new file mode 100644 index 0000000..48059b1 --- /dev/null +++ b/node_modules/aws-sdk/apis/codecommit-2015-04-13.min.json @@ -0,0 +1,1401 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-04-13", + "endpointPrefix": "codecommit", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "CodeCommit", + "serviceFullName": "AWS CodeCommit", + "serviceId": "CodeCommit", + "signatureVersion": "v4", + "targetPrefix": "CodeCommit_20150413", + "uid": "codecommit-2015-04-13" + }, + "operations": { + "BatchGetRepositories": { + "input": { + "type": "structure", + "required": [ + "repositoryNames" + ], + "members": { + "repositoryNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "repositories": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "repositoriesNotFound": { + "type": "list", + "member": {} + } + } + } + }, + "CreateBranch": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "branchName", + "commitId" + ], + "members": { + "repositoryName": {}, + "branchName": {}, + "commitId": {} + } + } + }, + "CreateCommit": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "branchName" + ], + "members": { + "repositoryName": {}, + "branchName": {}, + "parentCommitId": {}, + "authorName": {}, + "email": {}, + "commitMessage": {}, + "keepEmptyFolders": { + "type": "boolean" + }, + "putFiles": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "filePath" + ], + "members": { + "filePath": {}, + "fileMode": {}, + "fileContent": { + "type": "blob" + }, + "sourceFile": { + "type": "structure", + "required": [ + "filePath" + ], + "members": { + "filePath": {}, + "isMove": { + "type": "boolean" + } + } + } + } + } + }, + "deleteFiles": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "filePath" + ], + "members": { + "filePath": {} + } + } + }, + "setFileModes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "filePath", + "fileMode" + ], + "members": { + "filePath": {}, + "fileMode": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "commitId": {}, + "treeId": {}, + "filesAdded": { + "shape": "S11" + }, + "filesUpdated": { + "shape": "S11" + }, + "filesDeleted": { + "shape": "S11" + } + } + } + }, + "CreatePullRequest": { + "input": { + "type": "structure", + "required": [ + "title", + "targets" + ], + "members": { + "title": {}, + "description": {}, + "targets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "repositoryName", + "sourceReference" + ], + "members": { + "repositoryName": {}, + "sourceReference": {}, + "destinationReference": {} + } + } + }, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "required": [ + "pullRequest" + ], + "members": { + "pullRequest": { + "shape": "S1b" + } + } + } + }, + "CreateRepository": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {}, + "repositoryDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "repositoryMetadata": { + "shape": "S6" + } + } + } + }, + "DeleteBranch": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "branchName" + ], + "members": { + "repositoryName": {}, + "branchName": {} + } + }, + "output": { + "type": "structure", + "members": { + "deletedBranch": { + "shape": "S1m" + } + } + } + }, + "DeleteCommentContent": { + "input": { + "type": "structure", + "required": [ + "commentId" + ], + "members": { + "commentId": {} + } + }, + "output": { + "type": "structure", + "members": { + "comment": { + "shape": "S1q" + } + } + } + }, + "DeleteFile": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "branchName", + "filePath", + "parentCommitId" + ], + "members": { + "repositoryName": {}, + "branchName": {}, + "filePath": {}, + "parentCommitId": {}, + "keepEmptyFolders": { + "type": "boolean" + }, + "commitMessage": {}, + "name": {}, + "email": {} + } + }, + "output": { + "type": "structure", + "required": [ + "commitId", + "blobId", + "treeId", + "filePath" + ], + "members": { + "commitId": {}, + "blobId": {}, + "treeId": {}, + "filePath": {} + } + } + }, + "DeleteRepository": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "repositoryId": {} + } + } + }, + "DescribePullRequestEvents": { + "input": { + "type": "structure", + "required": [ + "pullRequestId" + ], + "members": { + "pullRequestId": {}, + "pullRequestEventType": {}, + "actorArn": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "pullRequestEvents" + ], + "members": { + "pullRequestEvents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "pullRequestId": {}, + "eventDate": { + "type": "timestamp" + }, + "pullRequestEventType": {}, + "actorArn": {}, + "pullRequestCreatedEventMetadata": { + "type": "structure", + "members": { + "repositoryName": {}, + "sourceCommitId": {}, + "destinationCommitId": {}, + "mergeBase": {} + } + }, + "pullRequestStatusChangedEventMetadata": { + "type": "structure", + "members": { + "pullRequestStatus": {} + } + }, + "pullRequestSourceReferenceUpdatedEventMetadata": { + "type": "structure", + "members": { + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "mergeBase": {} + } + }, + "pullRequestMergedStateChangedEventMetadata": { + "type": "structure", + "members": { + "repositoryName": {}, + "destinationReference": {}, + "mergeMetadata": { + "shape": "S1g" + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "GetBlob": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "blobId" + ], + "members": { + "repositoryName": {}, + "blobId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "content" + ], + "members": { + "content": { + "type": "blob" + } + } + } + }, + "GetBranch": { + "input": { + "type": "structure", + "members": { + "repositoryName": {}, + "branchName": {} + } + }, + "output": { + "type": "structure", + "members": { + "branch": { + "shape": "S1m" + } + } + } + }, + "GetComment": { + "input": { + "type": "structure", + "required": [ + "commentId" + ], + "members": { + "commentId": {} + } + }, + "output": { + "type": "structure", + "members": { + "comment": { + "shape": "S1q" + } + } + } + }, + "GetCommentsForComparedCommit": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "afterCommitId" + ], + "members": { + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "commentsForComparedCommitData": { + "type": "list", + "member": { + "type": "structure", + "members": { + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "beforeBlobId": {}, + "afterBlobId": {}, + "location": { + "shape": "S2k" + }, + "comments": { + "shape": "S2n" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetCommentsForPullRequest": { + "input": { + "type": "structure", + "required": [ + "pullRequestId" + ], + "members": { + "pullRequestId": {}, + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "commentsForPullRequestData": { + "type": "list", + "member": { + "type": "structure", + "members": { + "pullRequestId": {}, + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "beforeBlobId": {}, + "afterBlobId": {}, + "location": { + "shape": "S2k" + }, + "comments": { + "shape": "S2n" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetCommit": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "commitId" + ], + "members": { + "repositoryName": {}, + "commitId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "commit" + ], + "members": { + "commit": { + "type": "structure", + "members": { + "commitId": {}, + "treeId": {}, + "parents": { + "type": "list", + "member": {} + }, + "message": {}, + "author": { + "shape": "S2w" + }, + "committer": { + "shape": "S2w" + }, + "additionalData": {} + } + } + } + } + }, + "GetDifferences": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "afterCommitSpecifier" + ], + "members": { + "repositoryName": {}, + "beforeCommitSpecifier": {}, + "afterCommitSpecifier": {}, + "beforePath": {}, + "afterPath": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "differences": { + "type": "list", + "member": { + "type": "structure", + "members": { + "beforeBlob": { + "shape": "S35" + }, + "afterBlob": { + "shape": "S35" + }, + "changeType": {} + } + } + }, + "NextToken": {} + } + } + }, + "GetFile": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "filePath" + ], + "members": { + "repositoryName": {}, + "commitSpecifier": {}, + "filePath": {} + } + }, + "output": { + "type": "structure", + "required": [ + "commitId", + "blobId", + "filePath", + "fileMode", + "fileSize", + "fileContent" + ], + "members": { + "commitId": {}, + "blobId": {}, + "filePath": {}, + "fileMode": {}, + "fileSize": { + "type": "long" + }, + "fileContent": { + "type": "blob" + } + } + } + }, + "GetFolder": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "folderPath" + ], + "members": { + "repositoryName": {}, + "commitSpecifier": {}, + "folderPath": {} + } + }, + "output": { + "type": "structure", + "required": [ + "commitId", + "folderPath" + ], + "members": { + "commitId": {}, + "folderPath": {}, + "treeId": {}, + "subFolders": { + "type": "list", + "member": { + "type": "structure", + "members": { + "treeId": {}, + "absolutePath": {}, + "relativePath": {} + } + } + }, + "files": { + "type": "list", + "member": { + "type": "structure", + "members": { + "blobId": {}, + "absolutePath": {}, + "relativePath": {}, + "fileMode": {} + } + } + }, + "symbolicLinks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "blobId": {}, + "absolutePath": {}, + "relativePath": {}, + "fileMode": {} + } + } + }, + "subModules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "commitId": {}, + "absolutePath": {}, + "relativePath": {} + } + } + } + } + } + }, + "GetMergeConflicts": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "destinationCommitSpecifier", + "sourceCommitSpecifier", + "mergeOption" + ], + "members": { + "repositoryName": {}, + "destinationCommitSpecifier": {}, + "sourceCommitSpecifier": {}, + "mergeOption": {} + } + }, + "output": { + "type": "structure", + "required": [ + "mergeable", + "destinationCommitId", + "sourceCommitId" + ], + "members": { + "mergeable": { + "type": "boolean" + }, + "destinationCommitId": {}, + "sourceCommitId": {} + } + } + }, + "GetPullRequest": { + "input": { + "type": "structure", + "required": [ + "pullRequestId" + ], + "members": { + "pullRequestId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pullRequest" + ], + "members": { + "pullRequest": { + "shape": "S1b" + } + } + } + }, + "GetRepository": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "repositoryMetadata": { + "shape": "S6" + } + } + } + }, + "GetRepositoryTriggers": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "configurationId": {}, + "triggers": { + "shape": "S3w" + } + } + } + }, + "ListBranches": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "branches": { + "shape": "S40" + }, + "nextToken": {} + } + } + }, + "ListPullRequests": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {}, + "authorArn": {}, + "pullRequestStatus": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "pullRequestIds" + ], + "members": { + "pullRequestIds": { + "type": "list", + "member": {} + }, + "nextToken": {} + } + } + }, + "ListRepositories": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "sortBy": {}, + "order": {} + } + }, + "output": { + "type": "structure", + "members": { + "repositories": { + "type": "list", + "member": { + "type": "structure", + "members": { + "repositoryName": {}, + "repositoryId": {} + } + } + }, + "nextToken": {} + } + } + }, + "MergePullRequestByFastForward": { + "input": { + "type": "structure", + "required": [ + "pullRequestId", + "repositoryName" + ], + "members": { + "pullRequestId": {}, + "repositoryName": {}, + "sourceCommitId": {} + } + }, + "output": { + "type": "structure", + "members": { + "pullRequest": { + "shape": "S1b" + } + } + } + }, + "PostCommentForComparedCommit": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "afterCommitId", + "content" + ], + "members": { + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "location": { + "shape": "S2k" + }, + "content": {}, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "beforeBlobId": {}, + "afterBlobId": {}, + "location": { + "shape": "S2k" + }, + "comment": { + "shape": "S1q" + } + } + }, + "idempotent": true + }, + "PostCommentForPullRequest": { + "input": { + "type": "structure", + "required": [ + "pullRequestId", + "repositoryName", + "beforeCommitId", + "afterCommitId", + "content" + ], + "members": { + "pullRequestId": {}, + "repositoryName": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "location": { + "shape": "S2k" + }, + "content": {}, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "repositoryName": {}, + "pullRequestId": {}, + "beforeCommitId": {}, + "afterCommitId": {}, + "beforeBlobId": {}, + "afterBlobId": {}, + "location": { + "shape": "S2k" + }, + "comment": { + "shape": "S1q" + } + } + }, + "idempotent": true + }, + "PostCommentReply": { + "input": { + "type": "structure", + "required": [ + "inReplyTo", + "content" + ], + "members": { + "inReplyTo": {}, + "clientRequestToken": { + "idempotencyToken": true + }, + "content": {} + } + }, + "output": { + "type": "structure", + "members": { + "comment": { + "shape": "S1q" + } + } + }, + "idempotent": true + }, + "PutFile": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "branchName", + "fileContent", + "filePath" + ], + "members": { + "repositoryName": {}, + "branchName": {}, + "fileContent": { + "type": "blob" + }, + "filePath": {}, + "fileMode": {}, + "parentCommitId": {}, + "commitMessage": {}, + "name": {}, + "email": {} + } + }, + "output": { + "type": "structure", + "required": [ + "commitId", + "blobId", + "treeId" + ], + "members": { + "commitId": {}, + "blobId": {}, + "treeId": {} + } + } + }, + "PutRepositoryTriggers": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "triggers" + ], + "members": { + "repositoryName": {}, + "triggers": { + "shape": "S3w" + } + } + }, + "output": { + "type": "structure", + "members": { + "configurationId": {} + } + } + }, + "TestRepositoryTriggers": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "triggers" + ], + "members": { + "repositoryName": {}, + "triggers": { + "shape": "S3w" + } + } + }, + "output": { + "type": "structure", + "members": { + "successfulExecutions": { + "type": "list", + "member": {} + }, + "failedExecutions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "trigger": {}, + "failureMessage": {} + } + } + } + } + } + }, + "UpdateComment": { + "input": { + "type": "structure", + "required": [ + "commentId", + "content" + ], + "members": { + "commentId": {}, + "content": {} + } + }, + "output": { + "type": "structure", + "members": { + "comment": { + "shape": "S1q" + } + } + } + }, + "UpdateDefaultBranch": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "defaultBranchName" + ], + "members": { + "repositoryName": {}, + "defaultBranchName": {} + } + } + }, + "UpdatePullRequestDescription": { + "input": { + "type": "structure", + "required": [ + "pullRequestId", + "description" + ], + "members": { + "pullRequestId": {}, + "description": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pullRequest" + ], + "members": { + "pullRequest": { + "shape": "S1b" + } + } + } + }, + "UpdatePullRequestStatus": { + "input": { + "type": "structure", + "required": [ + "pullRequestId", + "pullRequestStatus" + ], + "members": { + "pullRequestId": {}, + "pullRequestStatus": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pullRequest" + ], + "members": { + "pullRequest": { + "shape": "S1b" + } + } + } + }, + "UpdatePullRequestTitle": { + "input": { + "type": "structure", + "required": [ + "pullRequestId", + "title" + ], + "members": { + "pullRequestId": {}, + "title": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pullRequest" + ], + "members": { + "pullRequest": { + "shape": "S1b" + } + } + } + }, + "UpdateRepositoryDescription": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {}, + "repositoryDescription": {} + } + } + }, + "UpdateRepositoryName": { + "input": { + "type": "structure", + "required": [ + "oldName", + "newName" + ], + "members": { + "oldName": {}, + "newName": {} + } + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "members": { + "accountId": {}, + "repositoryId": {}, + "repositoryName": {}, + "repositoryDescription": {}, + "defaultBranch": {}, + "lastModifiedDate": { + "type": "timestamp" + }, + "creationDate": { + "type": "timestamp" + }, + "cloneUrlHttp": {}, + "cloneUrlSsh": {}, + "Arn": {} + } + }, + "S11": { + "type": "list", + "member": { + "type": "structure", + "members": { + "absolutePath": {}, + "blobId": {}, + "fileMode": {} + } + } + }, + "S1b": { + "type": "structure", + "members": { + "pullRequestId": {}, + "title": {}, + "description": {}, + "lastActivityDate": { + "type": "timestamp" + }, + "creationDate": { + "type": "timestamp" + }, + "pullRequestStatus": {}, + "authorArn": {}, + "pullRequestTargets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "repositoryName": {}, + "sourceReference": {}, + "destinationReference": {}, + "destinationCommit": {}, + "sourceCommit": {}, + "mergeBase": {}, + "mergeMetadata": { + "shape": "S1g" + } + } + } + }, + "clientRequestToken": {} + } + }, + "S1g": { + "type": "structure", + "members": { + "isMerged": { + "type": "boolean" + }, + "mergedBy": {} + } + }, + "S1m": { + "type": "structure", + "members": { + "branchName": {}, + "commitId": {} + } + }, + "S1q": { + "type": "structure", + "members": { + "commentId": {}, + "content": {}, + "inReplyTo": {}, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + }, + "authorArn": {}, + "deleted": { + "type": "boolean" + }, + "clientRequestToken": {} + } + }, + "S2k": { + "type": "structure", + "members": { + "filePath": {}, + "filePosition": { + "type": "long" + }, + "relativeFileVersion": {} + } + }, + "S2n": { + "type": "list", + "member": { + "shape": "S1q" + } + }, + "S2w": { + "type": "structure", + "members": { + "name": {}, + "email": {}, + "date": {} + } + }, + "S35": { + "type": "structure", + "members": { + "blobId": {}, + "path": {}, + "mode": {} + } + }, + "S3w": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "destinationArn", + "events" + ], + "members": { + "name": {}, + "destinationArn": {}, + "customData": {}, + "branches": { + "shape": "S40" + }, + "events": { + "type": "list", + "member": {} + } + } + } + }, + "S40": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codecommit-2015-04-13.paginators.json b/node_modules/aws-sdk/apis/codecommit-2015-04-13.paginators.json new file mode 100644 index 0000000..fc672cb --- /dev/null +++ b/node_modules/aws-sdk/apis/codecommit-2015-04-13.paginators.json @@ -0,0 +1,39 @@ +{ + "pagination": { + "DescribePullRequestEvents": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken" + }, + "GetCommentsForComparedCommit": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken" + }, + "GetCommentsForPullRequest": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken" + }, + "GetDifferences": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListBranches": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "branches" + }, + "ListPullRequests": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken" + }, + "ListRepositories": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "repositories" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codedeploy-2014-10-06.examples.json b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/codedeploy-2014-10-06.min.json b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.min.json new file mode 100644 index 0000000..8ae92ae --- /dev/null +++ b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.min.json @@ -0,0 +1,1672 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-10-06", + "endpointPrefix": "codedeploy", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "CodeDeploy", + "serviceFullName": "AWS CodeDeploy", + "serviceId": "CodeDeploy", + "signatureVersion": "v4", + "targetPrefix": "CodeDeploy_20141006", + "uid": "codedeploy-2014-10-06" + }, + "operations": { + "AddTagsToOnPremisesInstances": { + "input": { + "type": "structure", + "required": [ + "tags", + "instanceNames" + ], + "members": { + "tags": { + "shape": "S2" + }, + "instanceNames": { + "shape": "S6" + } + } + } + }, + "BatchGetApplicationRevisions": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "revisions" + ], + "members": { + "applicationName": {}, + "revisions": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": { + "applicationName": {}, + "errorMessage": {}, + "revisions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "revisionLocation": { + "shape": "Sb" + }, + "genericRevisionInfo": { + "shape": "Su" + } + } + } + } + } + } + }, + "BatchGetApplications": { + "input": { + "type": "structure", + "required": [ + "applicationNames" + ], + "members": { + "applicationNames": { + "shape": "S10" + } + } + }, + "output": { + "type": "structure", + "members": { + "applicationsInfo": { + "type": "list", + "member": { + "shape": "S13" + } + } + } + } + }, + "BatchGetDeploymentGroups": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "deploymentGroupNames" + ], + "members": { + "applicationName": {}, + "deploymentGroupNames": { + "shape": "Sw" + } + } + }, + "output": { + "type": "structure", + "members": { + "deploymentGroupsInfo": { + "type": "list", + "member": { + "shape": "S1b" + } + }, + "errorMessage": {} + } + } + }, + "BatchGetDeploymentInstances": { + "input": { + "type": "structure", + "required": [ + "deploymentId", + "instanceIds" + ], + "members": { + "deploymentId": {}, + "instanceIds": { + "shape": "S31" + } + } + }, + "output": { + "type": "structure", + "members": { + "instancesSummary": { + "type": "list", + "member": { + "shape": "S35" + } + }, + "errorMessage": {} + } + }, + "deprecated": true, + "deprecatedMessage": "This operation is deprecated, use BatchGetDeploymentTargets instead." + }, + "BatchGetDeploymentTargets": { + "input": { + "type": "structure", + "members": { + "deploymentId": {}, + "targetIds": { + "shape": "S3i" + } + } + }, + "output": { + "type": "structure", + "members": { + "deploymentTargets": { + "type": "list", + "member": { + "shape": "S3m" + } + } + } + } + }, + "BatchGetDeployments": { + "input": { + "type": "structure", + "required": [ + "deploymentIds" + ], + "members": { + "deploymentIds": { + "shape": "S42" + } + } + }, + "output": { + "type": "structure", + "members": { + "deploymentsInfo": { + "type": "list", + "member": { + "shape": "S45" + } + } + } + } + }, + "BatchGetOnPremisesInstances": { + "input": { + "type": "structure", + "required": [ + "instanceNames" + ], + "members": { + "instanceNames": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "instanceInfos": { + "type": "list", + "member": { + "shape": "S4k" + } + } + } + } + }, + "ContinueDeployment": { + "input": { + "type": "structure", + "members": { + "deploymentId": {}, + "deploymentWaitType": {} + } + } + }, + "CreateApplication": { + "input": { + "type": "structure", + "required": [ + "applicationName" + ], + "members": { + "applicationName": {}, + "computePlatform": {} + } + }, + "output": { + "type": "structure", + "members": { + "applicationId": {} + } + } + }, + "CreateDeployment": { + "input": { + "type": "structure", + "required": [ + "applicationName" + ], + "members": { + "applicationName": {}, + "deploymentGroupName": {}, + "revision": { + "shape": "Sb" + }, + "deploymentConfigName": {}, + "description": {}, + "ignoreApplicationStopFailures": { + "type": "boolean" + }, + "targetInstances": { + "shape": "S4c" + }, + "autoRollbackConfiguration": { + "shape": "S1z" + }, + "updateOutdatedInstancesOnly": { + "type": "boolean" + }, + "fileExistsBehavior": {} + } + }, + "output": { + "type": "structure", + "members": { + "deploymentId": {} + } + } + }, + "CreateDeploymentConfig": { + "input": { + "type": "structure", + "required": [ + "deploymentConfigName" + ], + "members": { + "deploymentConfigName": {}, + "minimumHealthyHosts": { + "shape": "S4v" + }, + "trafficRoutingConfig": { + "shape": "S4y" + }, + "computePlatform": {} + } + }, + "output": { + "type": "structure", + "members": { + "deploymentConfigId": {} + } + } + }, + "CreateDeploymentGroup": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "deploymentGroupName", + "serviceRoleArn" + ], + "members": { + "applicationName": {}, + "deploymentGroupName": {}, + "deploymentConfigName": {}, + "ec2TagFilters": { + "shape": "S1e" + }, + "onPremisesInstanceTagFilters": { + "shape": "S1h" + }, + "autoScalingGroups": { + "shape": "S4d" + }, + "serviceRoleArn": {}, + "triggerConfigurations": { + "shape": "S1p" + }, + "alarmConfiguration": { + "shape": "S1v" + }, + "autoRollbackConfiguration": { + "shape": "S1z" + }, + "deploymentStyle": { + "shape": "S22" + }, + "blueGreenDeploymentConfiguration": { + "shape": "S25" + }, + "loadBalancerInfo": { + "shape": "S2d" + }, + "ec2TagSet": { + "shape": "S2s" + }, + "ecsServices": { + "shape": "S2w" + }, + "onPremisesTagSet": { + "shape": "S2u" + } + } + }, + "output": { + "type": "structure", + "members": { + "deploymentGroupId": {} + } + } + }, + "DeleteApplication": { + "input": { + "type": "structure", + "required": [ + "applicationName" + ], + "members": { + "applicationName": {} + } + } + }, + "DeleteDeploymentConfig": { + "input": { + "type": "structure", + "required": [ + "deploymentConfigName" + ], + "members": { + "deploymentConfigName": {} + } + } + }, + "DeleteDeploymentGroup": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "deploymentGroupName" + ], + "members": { + "applicationName": {}, + "deploymentGroupName": {} + } + }, + "output": { + "type": "structure", + "members": { + "hooksNotCleanedUp": { + "shape": "S1k" + } + } + } + }, + "DeleteGitHubAccountToken": { + "input": { + "type": "structure", + "members": { + "tokenName": {} + } + }, + "output": { + "type": "structure", + "members": { + "tokenName": {} + } + } + }, + "DeregisterOnPremisesInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + } + }, + "GetApplication": { + "input": { + "type": "structure", + "required": [ + "applicationName" + ], + "members": { + "applicationName": {} + } + }, + "output": { + "type": "structure", + "members": { + "application": { + "shape": "S13" + } + } + } + }, + "GetApplicationRevision": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "revision" + ], + "members": { + "applicationName": {}, + "revision": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "applicationName": {}, + "revision": { + "shape": "Sb" + }, + "revisionInfo": { + "shape": "Su" + } + } + } + }, + "GetDeployment": { + "input": { + "type": "structure", + "required": [ + "deploymentId" + ], + "members": { + "deploymentId": {} + } + }, + "output": { + "type": "structure", + "members": { + "deploymentInfo": { + "shape": "S45" + } + } + } + }, + "GetDeploymentConfig": { + "input": { + "type": "structure", + "required": [ + "deploymentConfigName" + ], + "members": { + "deploymentConfigName": {} + } + }, + "output": { + "type": "structure", + "members": { + "deploymentConfigInfo": { + "type": "structure", + "members": { + "deploymentConfigId": {}, + "deploymentConfigName": {}, + "minimumHealthyHosts": { + "shape": "S4v" + }, + "createTime": { + "type": "timestamp" + }, + "computePlatform": {}, + "trafficRoutingConfig": { + "shape": "S4y" + } + } + } + } + } + }, + "GetDeploymentGroup": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "deploymentGroupName" + ], + "members": { + "applicationName": {}, + "deploymentGroupName": {} + } + }, + "output": { + "type": "structure", + "members": { + "deploymentGroupInfo": { + "shape": "S1b" + } + } + } + }, + "GetDeploymentInstance": { + "input": { + "type": "structure", + "required": [ + "deploymentId", + "instanceId" + ], + "members": { + "deploymentId": {}, + "instanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "instanceSummary": { + "shape": "S35" + } + } + }, + "deprecated": true, + "deprecatedMessage": "This operation is deprecated, use GetDeploymentTarget instead." + }, + "GetDeploymentTarget": { + "input": { + "type": "structure", + "members": { + "deploymentId": {}, + "targetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "deploymentTarget": { + "shape": "S3m" + } + } + } + }, + "GetOnPremisesInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "instanceInfo": { + "shape": "S4k" + } + } + } + }, + "ListApplicationRevisions": { + "input": { + "type": "structure", + "required": [ + "applicationName" + ], + "members": { + "applicationName": {}, + "sortBy": {}, + "sortOrder": {}, + "s3Bucket": {}, + "s3KeyPrefix": {}, + "deployed": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "revisions": { + "shape": "Sa" + }, + "nextToken": {} + } + } + }, + "ListApplications": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "applications": { + "shape": "S10" + }, + "nextToken": {} + } + } + }, + "ListDeploymentConfigs": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "deploymentConfigsList": { + "type": "list", + "member": {} + }, + "nextToken": {} + } + } + }, + "ListDeploymentGroups": { + "input": { + "type": "structure", + "required": [ + "applicationName" + ], + "members": { + "applicationName": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "applicationName": {}, + "deploymentGroups": { + "shape": "Sw" + }, + "nextToken": {} + } + } + }, + "ListDeploymentInstances": { + "input": { + "type": "structure", + "required": [ + "deploymentId" + ], + "members": { + "deploymentId": {}, + "nextToken": {}, + "instanceStatusFilter": { + "type": "list", + "member": { + "shape": "S36" + } + }, + "instanceTypeFilter": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "instancesList": { + "shape": "S31" + }, + "nextToken": {} + } + }, + "deprecated": true, + "deprecatedMessage": "This operation is deprecated, use ListDeploymentTargets instead." + }, + "ListDeploymentTargets": { + "input": { + "type": "structure", + "members": { + "deploymentId": {}, + "nextToken": {}, + "targetFilters": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "targetIds": { + "shape": "S3i" + }, + "nextToken": {} + } + } + }, + "ListDeployments": { + "input": { + "type": "structure", + "members": { + "applicationName": {}, + "deploymentGroupName": {}, + "includeOnlyStatuses": { + "type": "list", + "member": {} + }, + "createTimeRange": { + "type": "structure", + "members": { + "start": { + "type": "timestamp" + }, + "end": { + "type": "timestamp" + } + } + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "deployments": { + "shape": "S42" + }, + "nextToken": {} + } + } + }, + "ListGitHubAccountTokenNames": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "tokenNameList": { + "type": "list", + "member": {} + }, + "nextToken": {} + } + } + }, + "ListOnPremisesInstances": { + "input": { + "type": "structure", + "members": { + "registrationStatus": {}, + "tagFilters": { + "shape": "S1h" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "instanceNames": { + "shape": "S6" + }, + "nextToken": {} + } + } + }, + "PutLifecycleEventHookExecutionStatus": { + "input": { + "type": "structure", + "members": { + "deploymentId": {}, + "lifecycleEventHookExecutionId": {}, + "status": {} + } + }, + "output": { + "type": "structure", + "members": { + "lifecycleEventHookExecutionId": {} + } + } + }, + "RegisterApplicationRevision": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "revision" + ], + "members": { + "applicationName": {}, + "description": {}, + "revision": { + "shape": "Sb" + } + } + } + }, + "RegisterOnPremisesInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {}, + "iamSessionArn": {}, + "iamUserArn": {} + } + } + }, + "RemoveTagsFromOnPremisesInstances": { + "input": { + "type": "structure", + "required": [ + "tags", + "instanceNames" + ], + "members": { + "tags": { + "shape": "S2" + }, + "instanceNames": { + "shape": "S6" + } + } + } + }, + "SkipWaitTimeForInstanceTermination": { + "input": { + "type": "structure", + "members": { + "deploymentId": {} + } + }, + "deprecated": true, + "deprecatedMessage": "This operation is deprecated, use ContinueDeployment with DeploymentWaitType instead." + }, + "StopDeployment": { + "input": { + "type": "structure", + "required": [ + "deploymentId" + ], + "members": { + "deploymentId": {}, + "autoRollbackEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "statusMessage": {} + } + } + }, + "UpdateApplication": { + "input": { + "type": "structure", + "members": { + "applicationName": {}, + "newApplicationName": {} + } + } + }, + "UpdateDeploymentGroup": { + "input": { + "type": "structure", + "required": [ + "applicationName", + "currentDeploymentGroupName" + ], + "members": { + "applicationName": {}, + "currentDeploymentGroupName": {}, + "newDeploymentGroupName": {}, + "deploymentConfigName": {}, + "ec2TagFilters": { + "shape": "S1e" + }, + "onPremisesInstanceTagFilters": { + "shape": "S1h" + }, + "autoScalingGroups": { + "shape": "S4d" + }, + "serviceRoleArn": {}, + "triggerConfigurations": { + "shape": "S1p" + }, + "alarmConfiguration": { + "shape": "S1v" + }, + "autoRollbackConfiguration": { + "shape": "S1z" + }, + "deploymentStyle": { + "shape": "S22" + }, + "blueGreenDeploymentConfiguration": { + "shape": "S25" + }, + "loadBalancerInfo": { + "shape": "S2d" + }, + "ec2TagSet": { + "shape": "S2s" + }, + "ecsServices": { + "shape": "S2w" + }, + "onPremisesTagSet": { + "shape": "S2u" + } + } + }, + "output": { + "type": "structure", + "members": { + "hooksNotCleanedUp": { + "shape": "S1k" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S6": { + "type": "list", + "member": {} + }, + "Sa": { + "type": "list", + "member": { + "shape": "Sb" + } + }, + "Sb": { + "type": "structure", + "members": { + "revisionType": {}, + "s3Location": { + "type": "structure", + "members": { + "bucket": {}, + "key": {}, + "bundleType": {}, + "version": {}, + "eTag": {} + } + }, + "gitHubLocation": { + "type": "structure", + "members": { + "repository": {}, + "commitId": {} + } + }, + "string": { + "type": "structure", + "members": { + "content": {}, + "sha256": {} + }, + "deprecated": true, + "deprecatedMessage": "RawString and String revision type are deprecated, use AppSpecContent type instead." + }, + "appSpecContent": { + "type": "structure", + "members": { + "content": {}, + "sha256": {} + } + } + } + }, + "Su": { + "type": "structure", + "members": { + "description": {}, + "deploymentGroups": { + "shape": "Sw" + }, + "firstUsedTime": { + "type": "timestamp" + }, + "lastUsedTime": { + "type": "timestamp" + }, + "registerTime": { + "type": "timestamp" + } + } + }, + "Sw": { + "type": "list", + "member": {} + }, + "S10": { + "type": "list", + "member": {} + }, + "S13": { + "type": "structure", + "members": { + "applicationId": {}, + "applicationName": {}, + "createTime": { + "type": "timestamp" + }, + "linkedToGitHub": { + "type": "boolean" + }, + "gitHubAccountName": {}, + "computePlatform": {} + } + }, + "S1b": { + "type": "structure", + "members": { + "applicationName": {}, + "deploymentGroupId": {}, + "deploymentGroupName": {}, + "deploymentConfigName": {}, + "ec2TagFilters": { + "shape": "S1e" + }, + "onPremisesInstanceTagFilters": { + "shape": "S1h" + }, + "autoScalingGroups": { + "shape": "S1k" + }, + "serviceRoleArn": {}, + "targetRevision": { + "shape": "Sb" + }, + "triggerConfigurations": { + "shape": "S1p" + }, + "alarmConfiguration": { + "shape": "S1v" + }, + "autoRollbackConfiguration": { + "shape": "S1z" + }, + "deploymentStyle": { + "shape": "S22" + }, + "blueGreenDeploymentConfiguration": { + "shape": "S25" + }, + "loadBalancerInfo": { + "shape": "S2d" + }, + "lastSuccessfulDeployment": { + "shape": "S2p" + }, + "lastAttemptedDeployment": { + "shape": "S2p" + }, + "ec2TagSet": { + "shape": "S2s" + }, + "onPremisesTagSet": { + "shape": "S2u" + }, + "computePlatform": {}, + "ecsServices": { + "shape": "S2w" + } + } + }, + "S1e": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "Type": {} + } + } + }, + "S1h": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "Type": {} + } + } + }, + "S1k": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "hook": {} + } + } + }, + "S1p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "triggerName": {}, + "triggerTargetArn": {}, + "triggerEvents": { + "type": "list", + "member": {} + } + } + } + }, + "S1v": { + "type": "structure", + "members": { + "enabled": { + "type": "boolean" + }, + "ignorePollAlarmFailure": { + "type": "boolean" + }, + "alarms": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {} + } + } + } + } + }, + "S1z": { + "type": "structure", + "members": { + "enabled": { + "type": "boolean" + }, + "events": { + "type": "list", + "member": {} + } + } + }, + "S22": { + "type": "structure", + "members": { + "deploymentType": {}, + "deploymentOption": {} + } + }, + "S25": { + "type": "structure", + "members": { + "terminateBlueInstancesOnDeploymentSuccess": { + "type": "structure", + "members": { + "action": {}, + "terminationWaitTimeInMinutes": { + "type": "integer" + } + } + }, + "deploymentReadyOption": { + "type": "structure", + "members": { + "actionOnTimeout": {}, + "waitTimeInMinutes": { + "type": "integer" + } + } + }, + "greenFleetProvisioningOption": { + "type": "structure", + "members": { + "action": {} + } + } + } + }, + "S2d": { + "type": "structure", + "members": { + "elbInfoList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {} + } + } + }, + "targetGroupInfoList": { + "shape": "S2h" + }, + "targetGroupPairInfoList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "targetGroups": { + "shape": "S2h" + }, + "prodTrafficRoute": { + "shape": "S2m" + }, + "testTrafficRoute": { + "shape": "S2m" + } + } + } + } + } + }, + "S2h": { + "type": "list", + "member": { + "shape": "S2i" + } + }, + "S2i": { + "type": "structure", + "members": { + "name": {} + } + }, + "S2m": { + "type": "structure", + "members": { + "listenerArns": { + "type": "list", + "member": {} + } + } + }, + "S2p": { + "type": "structure", + "members": { + "deploymentId": {}, + "status": {}, + "endTime": { + "type": "timestamp" + }, + "createTime": { + "type": "timestamp" + } + } + }, + "S2s": { + "type": "structure", + "members": { + "ec2TagSetList": { + "type": "list", + "member": { + "shape": "S1e" + } + } + } + }, + "S2u": { + "type": "structure", + "members": { + "onPremisesTagSetList": { + "type": "list", + "member": { + "shape": "S1h" + } + } + } + }, + "S2w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "serviceName": {}, + "clusterName": {} + } + } + }, + "S31": { + "type": "list", + "member": {} + }, + "S35": { + "type": "structure", + "members": { + "deploymentId": {}, + "instanceId": {}, + "status": { + "shape": "S36" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "lifecycleEvents": { + "shape": "S37" + }, + "instanceType": {} + }, + "deprecated": true, + "deprecatedMessage": "InstanceSummary is deprecated, use DeploymentTarget instead." + }, + "S36": { + "type": "string", + "deprecated": true, + "deprecatedMessage": "InstanceStatus is deprecated, use TargetStatus instead." + }, + "S37": { + "type": "list", + "member": { + "type": "structure", + "members": { + "lifecycleEventName": {}, + "diagnostics": { + "type": "structure", + "members": { + "errorCode": {}, + "scriptName": {}, + "message": {}, + "logTail": {} + } + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "status": {} + } + } + }, + "S3i": { + "type": "list", + "member": {} + }, + "S3m": { + "type": "structure", + "members": { + "deploymentTargetType": {}, + "instanceTarget": { + "type": "structure", + "members": { + "deploymentId": {}, + "targetId": {}, + "targetArn": {}, + "status": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "lifecycleEvents": { + "shape": "S37" + }, + "instanceLabel": {} + } + }, + "lambdaTarget": { + "type": "structure", + "members": { + "deploymentId": {}, + "targetId": {}, + "targetArn": {}, + "status": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "lifecycleEvents": { + "shape": "S37" + } + } + }, + "ecsTarget": { + "type": "structure", + "members": { + "deploymentId": {}, + "targetId": {}, + "targetArn": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "lifecycleEvents": { + "shape": "S37" + }, + "status": {}, + "taskSetsInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "identifer": {}, + "desiredCount": { + "type": "long" + }, + "pendingCount": { + "type": "long" + }, + "runningCount": { + "type": "long" + }, + "status": {}, + "trafficWeight": { + "type": "double" + }, + "targetGroup": { + "shape": "S2i" + }, + "taskSetLabel": {} + } + } + } + } + } + } + }, + "S42": { + "type": "list", + "member": {} + }, + "S45": { + "type": "structure", + "members": { + "applicationName": {}, + "deploymentGroupName": {}, + "deploymentConfigName": {}, + "deploymentId": {}, + "previousRevision": { + "shape": "Sb" + }, + "revision": { + "shape": "Sb" + }, + "status": {}, + "errorInformation": { + "type": "structure", + "members": { + "code": {}, + "message": {} + } + }, + "createTime": { + "type": "timestamp" + }, + "startTime": { + "type": "timestamp" + }, + "completeTime": { + "type": "timestamp" + }, + "deploymentOverview": { + "type": "structure", + "members": { + "Pending": { + "type": "long" + }, + "InProgress": { + "type": "long" + }, + "Succeeded": { + "type": "long" + }, + "Failed": { + "type": "long" + }, + "Skipped": { + "type": "long" + }, + "Ready": { + "type": "long" + } + } + }, + "description": {}, + "creator": {}, + "ignoreApplicationStopFailures": { + "type": "boolean" + }, + "autoRollbackConfiguration": { + "shape": "S1z" + }, + "updateOutdatedInstancesOnly": { + "type": "boolean" + }, + "rollbackInfo": { + "type": "structure", + "members": { + "rollbackDeploymentId": {}, + "rollbackTriggeringDeploymentId": {}, + "rollbackMessage": {} + } + }, + "deploymentStyle": { + "shape": "S22" + }, + "targetInstances": { + "shape": "S4c" + }, + "instanceTerminationWaitTimeStarted": { + "type": "boolean" + }, + "blueGreenDeploymentConfiguration": { + "shape": "S25" + }, + "loadBalancerInfo": { + "shape": "S2d" + }, + "additionalDeploymentStatusInfo": { + "type": "string", + "deprecated": true, + "deprecatedMessage": "AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead." + }, + "fileExistsBehavior": {}, + "deploymentStatusMessages": { + "type": "list", + "member": {} + }, + "computePlatform": {} + } + }, + "S4c": { + "type": "structure", + "members": { + "tagFilters": { + "shape": "S1e" + }, + "autoScalingGroups": { + "shape": "S4d" + }, + "ec2TagSet": { + "shape": "S2s" + } + } + }, + "S4d": { + "type": "list", + "member": {} + }, + "S4k": { + "type": "structure", + "members": { + "instanceName": {}, + "iamSessionArn": {}, + "iamUserArn": {}, + "instanceArn": {}, + "registerTime": { + "type": "timestamp" + }, + "deregisterTime": { + "type": "timestamp" + }, + "tags": { + "shape": "S2" + } + } + }, + "S4v": { + "type": "structure", + "members": { + "value": { + "type": "integer" + }, + "type": {} + } + }, + "S4y": { + "type": "structure", + "members": { + "type": {}, + "timeBasedCanary": { + "type": "structure", + "members": { + "canaryPercentage": { + "type": "integer" + }, + "canaryInterval": { + "type": "integer" + } + } + }, + "timeBasedLinear": { + "type": "structure", + "members": { + "linearPercentage": { + "type": "integer" + }, + "linearInterval": { + "type": "integer" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codedeploy-2014-10-06.paginators.json b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.paginators.json new file mode 100644 index 0000000..aa398f0 --- /dev/null +++ b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.paginators.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListApplicationRevisions": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "revisions" + }, + "ListApplications": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "applications" + }, + "ListDeploymentConfigs": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "deploymentConfigsList" + }, + "ListDeploymentGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "deploymentGroups" + }, + "ListDeploymentInstances": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "instancesList" + }, + "ListDeployments": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "deployments" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codedeploy-2014-10-06.waiters2.json b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.waiters2.json new file mode 100644 index 0000000..0fea4fa --- /dev/null +++ b/node_modules/aws-sdk/apis/codedeploy-2014-10-06.waiters2.json @@ -0,0 +1,30 @@ +{ + "version": 2, + "waiters": { + "DeploymentSuccessful": { + "delay": 15, + "operation": "GetDeployment", + "maxAttempts": 120, + "acceptors": [ + { + "expected": "Succeeded", + "matcher": "path", + "state": "success", + "argument": "deploymentInfo.status" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "deploymentInfo.status" + }, + { + "expected": "Stopped", + "matcher": "path", + "state": "failure", + "argument": "deploymentInfo.status" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/codepipeline-2015-07-09.examples.json b/node_modules/aws-sdk/apis/codepipeline-2015-07-09.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/codepipeline-2015-07-09.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/codepipeline-2015-07-09.min.json b/node_modules/aws-sdk/apis/codepipeline-2015-07-09.min.json new file mode 100644 index 0000000..7feb1d7 --- /dev/null +++ b/node_modules/aws-sdk/apis/codepipeline-2015-07-09.min.json @@ -0,0 +1,1418 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-07-09", + "endpointPrefix": "codepipeline", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "CodePipeline", + "serviceFullName": "AWS CodePipeline", + "serviceId": "CodePipeline", + "signatureVersion": "v4", + "targetPrefix": "CodePipeline_20150709", + "uid": "codepipeline-2015-07-09" + }, + "operations": { + "AcknowledgeJob": { + "input": { + "type": "structure", + "required": [ + "jobId", + "nonce" + ], + "members": { + "jobId": {}, + "nonce": {} + } + }, + "output": { + "type": "structure", + "members": { + "status": {} + } + } + }, + "AcknowledgeThirdPartyJob": { + "input": { + "type": "structure", + "required": [ + "jobId", + "nonce", + "clientToken" + ], + "members": { + "jobId": {}, + "nonce": {}, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "status": {} + } + } + }, + "CreateCustomActionType": { + "input": { + "type": "structure", + "required": [ + "category", + "provider", + "version", + "inputArtifactDetails", + "outputArtifactDetails" + ], + "members": { + "category": {}, + "provider": {}, + "version": {}, + "settings": { + "shape": "Se" + }, + "configurationProperties": { + "shape": "Sh" + }, + "inputArtifactDetails": { + "shape": "Sn" + }, + "outputArtifactDetails": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "actionType" + ], + "members": { + "actionType": { + "shape": "Sr" + } + } + } + }, + "CreatePipeline": { + "input": { + "type": "structure", + "required": [ + "pipeline" + ], + "members": { + "pipeline": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": { + "pipeline": { + "shape": "Sv" + } + } + } + }, + "DeleteCustomActionType": { + "input": { + "type": "structure", + "required": [ + "category", + "provider", + "version" + ], + "members": { + "category": {}, + "provider": {}, + "version": {} + } + } + }, + "DeletePipeline": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + } + }, + "DeleteWebhook": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeregisterWebhookWithThirdParty": { + "input": { + "type": "structure", + "members": { + "webhookName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisableStageTransition": { + "input": { + "type": "structure", + "required": [ + "pipelineName", + "stageName", + "transitionType", + "reason" + ], + "members": { + "pipelineName": {}, + "stageName": {}, + "transitionType": {}, + "reason": {} + } + } + }, + "EnableStageTransition": { + "input": { + "type": "structure", + "required": [ + "pipelineName", + "stageName", + "transitionType" + ], + "members": { + "pipelineName": {}, + "stageName": {}, + "transitionType": {} + } + } + }, + "GetJobDetails": { + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "jobDetails": { + "type": "structure", + "members": { + "id": {}, + "data": { + "shape": "S24" + }, + "accountId": {} + } + } + } + } + }, + "GetPipeline": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "version": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "pipeline": { + "shape": "Sv" + }, + "metadata": { + "type": "structure", + "members": { + "pipelineArn": {}, + "created": { + "type": "timestamp" + }, + "updated": { + "type": "timestamp" + } + } + } + } + } + }, + "GetPipelineExecution": { + "input": { + "type": "structure", + "required": [ + "pipelineName", + "pipelineExecutionId" + ], + "members": { + "pipelineName": {}, + "pipelineExecutionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "pipelineExecution": { + "type": "structure", + "members": { + "pipelineName": {}, + "pipelineVersion": { + "type": "integer" + }, + "pipelineExecutionId": {}, + "status": {}, + "artifactRevisions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "revisionId": {}, + "revisionChangeIdentifier": {}, + "revisionSummary": {}, + "created": { + "type": "timestamp" + }, + "revisionUrl": {} + } + } + } + } + } + } + } + }, + "GetPipelineState": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "output": { + "type": "structure", + "members": { + "pipelineName": {}, + "pipelineVersion": { + "type": "integer" + }, + "stageStates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "stageName": {}, + "inboundTransitionState": { + "type": "structure", + "members": { + "enabled": { + "type": "boolean" + }, + "lastChangedBy": {}, + "lastChangedAt": { + "type": "timestamp" + }, + "disabledReason": {} + } + }, + "actionStates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "actionName": {}, + "currentRevision": { + "shape": "S3c" + }, + "latestExecution": { + "type": "structure", + "members": { + "status": {}, + "summary": {}, + "lastStatusChange": { + "type": "timestamp" + }, + "token": {}, + "lastUpdatedBy": {}, + "externalExecutionId": {}, + "externalExecutionUrl": {}, + "percentComplete": { + "type": "integer" + }, + "errorDetails": { + "type": "structure", + "members": { + "code": {}, + "message": {} + } + } + } + }, + "entityUrl": {}, + "revisionUrl": {} + } + } + }, + "latestExecution": { + "type": "structure", + "required": [ + "pipelineExecutionId", + "status" + ], + "members": { + "pipelineExecutionId": {}, + "status": {} + } + } + } + } + }, + "created": { + "type": "timestamp" + }, + "updated": { + "type": "timestamp" + } + } + } + }, + "GetThirdPartyJobDetails": { + "input": { + "type": "structure", + "required": [ + "jobId", + "clientToken" + ], + "members": { + "jobId": {}, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "jobDetails": { + "type": "structure", + "members": { + "id": {}, + "data": { + "type": "structure", + "members": { + "actionTypeId": { + "shape": "Ss" + }, + "actionConfiguration": { + "shape": "S25" + }, + "pipelineContext": { + "shape": "S26" + }, + "inputArtifacts": { + "shape": "S2c" + }, + "outputArtifacts": { + "shape": "S2c" + }, + "artifactCredentials": { + "shape": "S2k" + }, + "continuationToken": {}, + "encryptionKey": { + "shape": "S11" + } + } + }, + "nonce": {} + } + } + } + } + }, + "ListActionExecutions": { + "input": { + "type": "structure", + "required": [ + "pipelineName" + ], + "members": { + "pipelineName": {}, + "filter": { + "type": "structure", + "members": { + "pipelineExecutionId": {} + } + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "actionExecutionDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "pipelineExecutionId": {}, + "actionExecutionId": {}, + "pipelineVersion": { + "type": "integer" + }, + "stageName": {}, + "actionName": {}, + "startTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + }, + "status": {}, + "input": { + "type": "structure", + "members": { + "actionTypeId": { + "shape": "Ss" + }, + "configuration": { + "shape": "S1h" + }, + "roleArn": {}, + "region": {}, + "inputArtifacts": { + "shape": "S41" + } + } + }, + "output": { + "type": "structure", + "members": { + "outputArtifacts": { + "shape": "S41" + }, + "executionResult": { + "type": "structure", + "members": { + "externalExecutionId": {}, + "externalExecutionSummary": {}, + "externalExecutionUrl": {} + } + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "ListActionTypes": { + "input": { + "type": "structure", + "members": { + "actionOwnerFilter": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "actionTypes" + ], + "members": { + "actionTypes": { + "type": "list", + "member": { + "shape": "Sr" + } + }, + "nextToken": {} + } + } + }, + "ListPipelineExecutions": { + "input": { + "type": "structure", + "required": [ + "pipelineName" + ], + "members": { + "pipelineName": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "pipelineExecutionSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "pipelineExecutionId": {}, + "status": {}, + "startTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + }, + "sourceRevisions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "actionName" + ], + "members": { + "actionName": {}, + "revisionId": {}, + "revisionSummary": {}, + "revisionUrl": {} + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "ListPipelines": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "pipelines": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "version": { + "type": "integer" + }, + "created": { + "type": "timestamp" + }, + "updated": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListWebhooks": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "webhooks": { + "type": "list", + "member": { + "shape": "S4q" + } + }, + "NextToken": {} + } + } + }, + "PollForJobs": { + "input": { + "type": "structure", + "required": [ + "actionTypeId" + ], + "members": { + "actionTypeId": { + "shape": "Ss" + }, + "maxBatchSize": { + "type": "integer" + }, + "queryParam": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "data": { + "shape": "S24" + }, + "nonce": {}, + "accountId": {} + } + } + } + } + } + }, + "PollForThirdPartyJobs": { + "input": { + "type": "structure", + "required": [ + "actionTypeId" + ], + "members": { + "actionTypeId": { + "shape": "Ss" + }, + "maxBatchSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "clientId": {}, + "jobId": {} + } + } + } + } + } + }, + "PutActionRevision": { + "input": { + "type": "structure", + "required": [ + "pipelineName", + "stageName", + "actionName", + "actionRevision" + ], + "members": { + "pipelineName": {}, + "stageName": {}, + "actionName": {}, + "actionRevision": { + "shape": "S3c" + } + } + }, + "output": { + "type": "structure", + "members": { + "newRevision": { + "type": "boolean" + }, + "pipelineExecutionId": {} + } + } + }, + "PutApprovalResult": { + "input": { + "type": "structure", + "required": [ + "pipelineName", + "stageName", + "actionName", + "result", + "token" + ], + "members": { + "pipelineName": {}, + "stageName": {}, + "actionName": {}, + "result": { + "type": "structure", + "required": [ + "summary", + "status" + ], + "members": { + "summary": {}, + "status": {} + } + }, + "token": {} + } + }, + "output": { + "type": "structure", + "members": { + "approvedAt": { + "type": "timestamp" + } + } + } + }, + "PutJobFailureResult": { + "input": { + "type": "structure", + "required": [ + "jobId", + "failureDetails" + ], + "members": { + "jobId": {}, + "failureDetails": { + "shape": "S5q" + } + } + } + }, + "PutJobSuccessResult": { + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": {}, + "currentRevision": { + "shape": "S5t" + }, + "continuationToken": {}, + "executionDetails": { + "shape": "S5v" + } + } + } + }, + "PutThirdPartyJobFailureResult": { + "input": { + "type": "structure", + "required": [ + "jobId", + "clientToken", + "failureDetails" + ], + "members": { + "jobId": {}, + "clientToken": {}, + "failureDetails": { + "shape": "S5q" + } + } + } + }, + "PutThirdPartyJobSuccessResult": { + "input": { + "type": "structure", + "required": [ + "jobId", + "clientToken" + ], + "members": { + "jobId": {}, + "clientToken": {}, + "currentRevision": { + "shape": "S5t" + }, + "continuationToken": {}, + "executionDetails": { + "shape": "S5v" + } + } + } + }, + "PutWebhook": { + "input": { + "type": "structure", + "required": [ + "webhook" + ], + "members": { + "webhook": { + "shape": "S4r" + } + } + }, + "output": { + "type": "structure", + "members": { + "webhook": { + "shape": "S4q" + } + } + } + }, + "RegisterWebhookWithThirdParty": { + "input": { + "type": "structure", + "members": { + "webhookName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RetryStageExecution": { + "input": { + "type": "structure", + "required": [ + "pipelineName", + "stageName", + "pipelineExecutionId", + "retryMode" + ], + "members": { + "pipelineName": {}, + "stageName": {}, + "pipelineExecutionId": {}, + "retryMode": {} + } + }, + "output": { + "type": "structure", + "members": { + "pipelineExecutionId": {} + } + } + }, + "StartPipelineExecution": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "pipelineExecutionId": {} + } + } + }, + "UpdatePipeline": { + "input": { + "type": "structure", + "required": [ + "pipeline" + ], + "members": { + "pipeline": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": { + "pipeline": { + "shape": "Sv" + } + } + } + } + }, + "shapes": { + "Se": { + "type": "structure", + "members": { + "thirdPartyConfigurationUrl": {}, + "entityUrlTemplate": {}, + "executionUrlTemplate": {}, + "revisionUrlTemplate": {} + } + }, + "Sh": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "required", + "key", + "secret" + ], + "members": { + "name": {}, + "required": { + "type": "boolean" + }, + "key": { + "type": "boolean" + }, + "secret": { + "type": "boolean" + }, + "queryable": { + "type": "boolean" + }, + "description": {}, + "type": {} + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "minimumCount", + "maximumCount" + ], + "members": { + "minimumCount": { + "type": "integer" + }, + "maximumCount": { + "type": "integer" + } + } + }, + "Sr": { + "type": "structure", + "required": [ + "id", + "inputArtifactDetails", + "outputArtifactDetails" + ], + "members": { + "id": { + "shape": "Ss" + }, + "settings": { + "shape": "Se" + }, + "actionConfigurationProperties": { + "shape": "Sh" + }, + "inputArtifactDetails": { + "shape": "Sn" + }, + "outputArtifactDetails": { + "shape": "Sn" + } + } + }, + "Ss": { + "type": "structure", + "required": [ + "category", + "owner", + "provider", + "version" + ], + "members": { + "category": {}, + "owner": {}, + "provider": {}, + "version": {} + } + }, + "Sv": { + "type": "structure", + "required": [ + "name", + "roleArn", + "stages" + ], + "members": { + "name": {}, + "roleArn": {}, + "artifactStore": { + "shape": "Sy" + }, + "artifactStores": { + "type": "map", + "key": {}, + "value": { + "shape": "Sy" + } + }, + "stages": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "actions" + ], + "members": { + "name": {}, + "blockers": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "type" + ], + "members": { + "name": {}, + "type": {} + } + } + }, + "actions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "actionTypeId" + ], + "members": { + "name": {}, + "actionTypeId": { + "shape": "Ss" + }, + "runOrder": { + "type": "integer" + }, + "configuration": { + "shape": "S1h" + }, + "outputArtifacts": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + } + }, + "inputArtifacts": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + } + }, + "roleArn": {}, + "region": {} + } + } + } + } + } + }, + "version": { + "type": "integer" + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "type", + "location" + ], + "members": { + "type": {}, + "location": {}, + "encryptionKey": { + "shape": "S11" + } + } + }, + "S11": { + "type": "structure", + "required": [ + "id", + "type" + ], + "members": { + "id": {}, + "type": {} + } + }, + "S1h": { + "type": "map", + "key": {}, + "value": {} + }, + "S24": { + "type": "structure", + "members": { + "actionTypeId": { + "shape": "Ss" + }, + "actionConfiguration": { + "shape": "S25" + }, + "pipelineContext": { + "shape": "S26" + }, + "inputArtifacts": { + "shape": "S2c" + }, + "outputArtifacts": { + "shape": "S2c" + }, + "artifactCredentials": { + "shape": "S2k" + }, + "continuationToken": {}, + "encryptionKey": { + "shape": "S11" + } + } + }, + "S25": { + "type": "structure", + "members": { + "configuration": { + "shape": "S1h" + } + } + }, + "S26": { + "type": "structure", + "members": { + "pipelineName": {}, + "stage": { + "type": "structure", + "members": { + "name": {} + } + }, + "action": { + "type": "structure", + "members": { + "name": {}, + "actionExecutionId": {} + } + }, + "pipelineArn": {}, + "pipelineExecutionId": {} + } + }, + "S2c": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "revision": {}, + "location": { + "type": "structure", + "members": { + "type": {}, + "s3Location": { + "type": "structure", + "required": [ + "bucketName", + "objectKey" + ], + "members": { + "bucketName": {}, + "objectKey": {} + } + } + } + } + } + } + }, + "S2k": { + "type": "structure", + "required": [ + "accessKeyId", + "secretAccessKey", + "sessionToken" + ], + "members": { + "accessKeyId": {}, + "secretAccessKey": {}, + "sessionToken": {} + }, + "sensitive": true + }, + "S3c": { + "type": "structure", + "required": [ + "revisionId", + "revisionChangeId", + "created" + ], + "members": { + "revisionId": {}, + "revisionChangeId": {}, + "created": { + "type": "timestamp" + } + } + }, + "S41": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "s3location": { + "type": "structure", + "members": { + "bucket": {}, + "key": {} + } + } + } + } + }, + "S4q": { + "type": "structure", + "required": [ + "definition", + "url" + ], + "members": { + "definition": { + "shape": "S4r" + }, + "url": {}, + "errorMessage": {}, + "errorCode": {}, + "lastTriggered": { + "type": "timestamp" + }, + "arn": {} + } + }, + "S4r": { + "type": "structure", + "required": [ + "name", + "targetPipeline", + "targetAction", + "filters", + "authentication", + "authenticationConfiguration" + ], + "members": { + "name": {}, + "targetPipeline": {}, + "targetAction": {}, + "filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "jsonPath" + ], + "members": { + "jsonPath": {}, + "matchEquals": {} + } + } + }, + "authentication": {}, + "authenticationConfiguration": { + "type": "structure", + "members": { + "AllowedIPRange": {}, + "SecretToken": {} + } + } + } + }, + "S5q": { + "type": "structure", + "required": [ + "type", + "message" + ], + "members": { + "type": {}, + "message": {}, + "externalExecutionId": {} + } + }, + "S5t": { + "type": "structure", + "required": [ + "revision", + "changeIdentifier" + ], + "members": { + "revision": {}, + "changeIdentifier": {}, + "created": { + "type": "timestamp" + }, + "revisionSummary": {} + } + }, + "S5v": { + "type": "structure", + "members": { + "summary": {}, + "externalExecutionId": {}, + "percentComplete": { + "type": "integer" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codepipeline-2015-07-09.paginators.json b/node_modules/aws-sdk/apis/codepipeline-2015-07-09.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/codepipeline-2015-07-09.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/codestar-2017-04-19.examples.json b/node_modules/aws-sdk/apis/codestar-2017-04-19.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/codestar-2017-04-19.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/codestar-2017-04-19.min.json b/node_modules/aws-sdk/apis/codestar-2017-04-19.min.json new file mode 100644 index 0000000..b8d4ecd --- /dev/null +++ b/node_modules/aws-sdk/apis/codestar-2017-04-19.min.json @@ -0,0 +1,670 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-04-19", + "endpointPrefix": "codestar", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "CodeStar", + "serviceFullName": "AWS CodeStar", + "serviceId": "CodeStar", + "signatureVersion": "v4", + "targetPrefix": "CodeStar_20170419", + "uid": "codestar-2017-04-19" + }, + "operations": { + "AssociateTeamMember": { + "input": { + "type": "structure", + "required": [ + "projectId", + "userArn", + "projectRole" + ], + "members": { + "projectId": {}, + "clientRequestToken": {}, + "userArn": {}, + "projectRole": {}, + "remoteAccessAllowed": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "clientRequestToken": {} + } + } + }, + "CreateProject": { + "input": { + "type": "structure", + "required": [ + "name", + "id" + ], + "members": { + "name": { + "shape": "S9" + }, + "id": {}, + "description": { + "shape": "Sa" + }, + "clientRequestToken": {}, + "sourceCode": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "source", + "destination" + ], + "members": { + "source": { + "type": "structure", + "required": [ + "s3" + ], + "members": { + "s3": { + "shape": "Se" + } + } + }, + "destination": { + "type": "structure", + "members": { + "codeCommit": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "gitHub": { + "type": "structure", + "required": [ + "name", + "type", + "owner", + "privateRepository", + "issuesEnabled", + "token" + ], + "members": { + "name": {}, + "description": {}, + "type": {}, + "owner": {}, + "privateRepository": { + "type": "boolean" + }, + "issuesEnabled": { + "type": "boolean" + }, + "token": { + "type": "string", + "sensitive": true + } + } + } + } + } + } + } + }, + "toolchain": { + "type": "structure", + "required": [ + "source" + ], + "members": { + "source": { + "type": "structure", + "required": [ + "s3" + ], + "members": { + "s3": { + "shape": "Se" + } + } + }, + "roleArn": {}, + "stackParameters": { + "type": "map", + "key": {}, + "value": { + "type": "string", + "sensitive": true + } + } + } + }, + "tags": { + "shape": "Sx" + } + } + }, + "output": { + "type": "structure", + "required": [ + "id", + "arn" + ], + "members": { + "id": {}, + "arn": {}, + "clientRequestToken": {}, + "projectTemplateId": {} + } + } + }, + "CreateUserProfile": { + "input": { + "type": "structure", + "required": [ + "userArn", + "displayName", + "emailAddress" + ], + "members": { + "userArn": {}, + "displayName": { + "shape": "S14" + }, + "emailAddress": { + "shape": "S15" + }, + "sshPublicKey": {} + } + }, + "output": { + "type": "structure", + "required": [ + "userArn" + ], + "members": { + "userArn": {}, + "displayName": { + "shape": "S14" + }, + "emailAddress": { + "shape": "S15" + }, + "sshPublicKey": {}, + "createdTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + } + } + } + }, + "DeleteProject": { + "input": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": {}, + "clientRequestToken": {}, + "deleteStack": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "stackId": {}, + "projectArn": {} + } + } + }, + "DeleteUserProfile": { + "input": { + "type": "structure", + "required": [ + "userArn" + ], + "members": { + "userArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "userArn" + ], + "members": { + "userArn": {} + } + } + }, + "DescribeProject": { + "input": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": { + "shape": "S9" + }, + "id": {}, + "arn": {}, + "description": { + "shape": "Sa" + }, + "clientRequestToken": {}, + "createdTimeStamp": { + "type": "timestamp" + }, + "stackId": {}, + "projectTemplateId": {}, + "status": { + "type": "structure", + "required": [ + "state" + ], + "members": { + "state": {}, + "reason": {} + } + } + } + } + }, + "DescribeUserProfile": { + "input": { + "type": "structure", + "required": [ + "userArn" + ], + "members": { + "userArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "userArn", + "createdTimestamp", + "lastModifiedTimestamp" + ], + "members": { + "userArn": {}, + "displayName": { + "shape": "S14" + }, + "emailAddress": { + "shape": "S15" + }, + "sshPublicKey": {}, + "createdTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + } + } + } + }, + "DisassociateTeamMember": { + "input": { + "type": "structure", + "required": [ + "projectId", + "userArn" + ], + "members": { + "projectId": {}, + "userArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListProjects": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "projects" + ], + "members": { + "projects": { + "type": "list", + "member": { + "type": "structure", + "members": { + "projectId": {}, + "projectArn": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListResources": { + "input": { + "type": "structure", + "required": [ + "projectId" + ], + "members": { + "projectId": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListTagsForProject": { + "input": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Sx" + }, + "nextToken": {} + } + } + }, + "ListTeamMembers": { + "input": { + "type": "structure", + "required": [ + "projectId" + ], + "members": { + "projectId": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "teamMembers" + ], + "members": { + "teamMembers": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "userArn", + "projectRole" + ], + "members": { + "userArn": {}, + "projectRole": {}, + "remoteAccessAllowed": { + "type": "boolean" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListUserProfiles": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "userProfiles" + ], + "members": { + "userProfiles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "userArn": {}, + "displayName": { + "shape": "S14" + }, + "emailAddress": { + "shape": "S15" + }, + "sshPublicKey": {} + } + } + }, + "nextToken": {} + } + } + }, + "TagProject": { + "input": { + "type": "structure", + "required": [ + "id", + "tags" + ], + "members": { + "id": {}, + "tags": { + "shape": "Sx" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Sx" + } + } + } + }, + "UntagProject": { + "input": { + "type": "structure", + "required": [ + "id", + "tags" + ], + "members": { + "id": {}, + "tags": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateProject": { + "input": { + "type": "structure", + "required": [ + "id" + ], + "members": { + "id": {}, + "name": { + "shape": "S9" + }, + "description": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateTeamMember": { + "input": { + "type": "structure", + "required": [ + "projectId", + "userArn" + ], + "members": { + "projectId": {}, + "userArn": {}, + "projectRole": {}, + "remoteAccessAllowed": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "userArn": {}, + "projectRole": {}, + "remoteAccessAllowed": { + "type": "boolean" + } + } + } + }, + "UpdateUserProfile": { + "input": { + "type": "structure", + "required": [ + "userArn" + ], + "members": { + "userArn": {}, + "displayName": { + "shape": "S14" + }, + "emailAddress": { + "shape": "S15" + }, + "sshPublicKey": {} + } + }, + "output": { + "type": "structure", + "required": [ + "userArn" + ], + "members": { + "userArn": {}, + "displayName": { + "shape": "S14" + }, + "emailAddress": { + "shape": "S15" + }, + "sshPublicKey": {}, + "createdTimestamp": { + "type": "timestamp" + }, + "lastModifiedTimestamp": { + "type": "timestamp" + } + } + } + } + }, + "shapes": { + "S9": { + "type": "string", + "sensitive": true + }, + "Sa": { + "type": "string", + "sensitive": true + }, + "Se": { + "type": "structure", + "members": { + "bucketName": {}, + "bucketKey": {} + } + }, + "Sx": { + "type": "map", + "key": {}, + "value": {} + }, + "S14": { + "type": "string", + "sensitive": true + }, + "S15": { + "type": "string", + "sensitive": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/codestar-2017-04-19.paginators.json b/node_modules/aws-sdk/apis/codestar-2017-04-19.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/codestar-2017-04-19.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.examples.json b/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.min.json b/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.min.json new file mode 100644 index 0000000..63d0643 --- /dev/null +++ b/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.min.json @@ -0,0 +1,605 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-06-30", + "endpointPrefix": "cognito-identity", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Cognito Identity", + "serviceId": "Cognito Identity", + "signatureVersion": "v4", + "targetPrefix": "AWSCognitoIdentityService", + "uid": "cognito-identity-2014-06-30" + }, + "operations": { + "CreateIdentityPool": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members": { + "IdentityPoolName": {}, + "AllowUnauthenticatedIdentities": { + "type": "boolean" + }, + "SupportedLoginProviders": { + "shape": "S4" + }, + "DeveloperProviderName": {}, + "OpenIdConnectProviderARNs": { + "shape": "S8" + }, + "CognitoIdentityProviders": { + "shape": "Sa" + }, + "SamlProviderARNs": { + "shape": "Sf" + }, + "IdentityPoolTags": { + "shape": "Sg" + } + } + }, + "output": { + "shape": "Sj" + } + }, + "DeleteIdentities": { + "input": { + "type": "structure", + "required": [ + "IdentityIdsToDelete" + ], + "members": { + "IdentityIdsToDelete": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedIdentityIds": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IdentityId": {}, + "ErrorCode": {} + } + } + } + } + } + }, + "DeleteIdentityPool": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": {} + } + } + }, + "DescribeIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityId" + ], + "members": { + "IdentityId": {} + } + }, + "output": { + "shape": "Su" + } + }, + "DescribeIdentityPool": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": {} + } + }, + "output": { + "shape": "Sj" + } + }, + "GetCredentialsForIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityId" + ], + "members": { + "IdentityId": {}, + "Logins": { + "shape": "Sz" + }, + "CustomRoleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {}, + "Credentials": { + "type": "structure", + "members": { + "AccessKeyId": {}, + "SecretKey": {}, + "SessionToken": {}, + "Expiration": { + "type": "timestamp" + } + } + } + } + } + }, + "GetId": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "AccountId": {}, + "IdentityPoolId": {}, + "Logins": { + "shape": "Sz" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {} + } + } + }, + "GetIdentityPoolRoles": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "Roles": { + "shape": "S1b" + }, + "RoleMappings": { + "shape": "S1d" + } + } + } + }, + "GetOpenIdToken": { + "input": { + "type": "structure", + "required": [ + "IdentityId" + ], + "members": { + "IdentityId": {}, + "Logins": { + "shape": "Sz" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {}, + "Token": {} + } + } + }, + "GetOpenIdTokenForDeveloperIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "Logins" + ], + "members": { + "IdentityPoolId": {}, + "IdentityId": {}, + "Logins": { + "shape": "Sz" + }, + "TokenDuration": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {}, + "Token": {} + } + } + }, + "ListIdentities": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "MaxResults" + ], + "members": { + "IdentityPoolId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "HideDisabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "Identities": { + "type": "list", + "member": { + "shape": "Su" + } + }, + "NextToken": {} + } + } + }, + "ListIdentityPools": { + "input": { + "type": "structure", + "required": [ + "MaxResults" + ], + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPools": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "IdentityPoolName": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sg" + } + } + } + }, + "LookupDeveloperIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": {}, + "IdentityId": {}, + "DeveloperUserIdentifier": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {}, + "DeveloperUserIdentifierList": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "MergeDeveloperIdentities": { + "input": { + "type": "structure", + "required": [ + "SourceUserIdentifier", + "DestinationUserIdentifier", + "DeveloperProviderName", + "IdentityPoolId" + ], + "members": { + "SourceUserIdentifier": {}, + "DestinationUserIdentifier": {}, + "DeveloperProviderName": {}, + "IdentityPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {} + } + } + }, + "SetIdentityPoolRoles": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "Roles" + ], + "members": { + "IdentityPoolId": {}, + "Roles": { + "shape": "S1b" + }, + "RoleMappings": { + "shape": "S1d" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UnlinkDeveloperIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityId", + "IdentityPoolId", + "DeveloperProviderName", + "DeveloperUserIdentifier" + ], + "members": { + "IdentityId": {}, + "IdentityPoolId": {}, + "DeveloperProviderName": {}, + "DeveloperUserIdentifier": {} + } + } + }, + "UnlinkIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityId", + "Logins", + "LoginsToRemove" + ], + "members": { + "IdentityId": {}, + "Logins": { + "shape": "Sz" + }, + "LoginsToRemove": { + "shape": "Sv" + } + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateIdentityPool": { + "input": { + "shape": "Sj" + }, + "output": { + "shape": "Sj" + } + } + }, + "shapes": { + "S4": { + "type": "map", + "key": {}, + "value": {} + }, + "S8": { + "type": "list", + "member": {} + }, + "Sa": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProviderName": {}, + "ClientId": {}, + "ServerSideTokenCheck": { + "type": "boolean" + } + } + } + }, + "Sf": { + "type": "list", + "member": {} + }, + "Sg": { + "type": "map", + "key": {}, + "value": {} + }, + "Sj": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members": { + "IdentityPoolId": {}, + "IdentityPoolName": {}, + "AllowUnauthenticatedIdentities": { + "type": "boolean" + }, + "SupportedLoginProviders": { + "shape": "S4" + }, + "DeveloperProviderName": {}, + "OpenIdConnectProviderARNs": { + "shape": "S8" + }, + "CognitoIdentityProviders": { + "shape": "Sa" + }, + "SamlProviderARNs": { + "shape": "Sf" + }, + "IdentityPoolTags": { + "shape": "Sg" + } + } + }, + "Su": { + "type": "structure", + "members": { + "IdentityId": {}, + "Logins": { + "shape": "Sv" + }, + "CreationDate": { + "type": "timestamp" + }, + "LastModifiedDate": { + "type": "timestamp" + } + } + }, + "Sv": { + "type": "list", + "member": {} + }, + "Sz": { + "type": "map", + "key": {}, + "value": {} + }, + "S1b": { + "type": "map", + "key": {}, + "value": {} + }, + "S1d": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "AmbiguousRoleResolution": {}, + "RulesConfiguration": { + "type": "structure", + "required": [ + "Rules" + ], + "members": { + "Rules": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Claim", + "MatchType", + "Value", + "RoleARN" + ], + "members": { + "Claim": {}, + "MatchType": {}, + "Value": {}, + "RoleARN": {} + } + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.paginators.json b/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/cognito-identity-2014-06-30.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.examples.json b/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json b/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json new file mode 100644 index 0000000..69294c5 --- /dev/null +++ b/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json @@ -0,0 +1,3571 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-04-18", + "endpointPrefix": "cognito-idp", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Cognito Identity Provider", + "serviceId": "Cognito Identity Provider", + "signatureVersion": "v4", + "targetPrefix": "AWSCognitoIdentityProviderService", + "uid": "cognito-idp-2016-04-18" + }, + "operations": { + "AddCustomAttributes": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "CustomAttributes" + ], + "members": { + "UserPoolId": {}, + "CustomAttributes": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminAddUserToGroup": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "GroupName" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "GroupName": {} + } + } + }, + "AdminConfirmSignUp": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminCreateUser": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "UserAttributes": { + "shape": "Si" + }, + "ValidationData": { + "shape": "Si" + }, + "TemporaryPassword": { + "shape": "Sm" + }, + "ForceAliasCreation": { + "type": "boolean" + }, + "MessageAction": {}, + "DesiredDeliveryMediums": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "Ss" + } + } + } + }, + "AdminDeleteUser": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + } + }, + "AdminDeleteUserAttributes": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "UserAttributeNames" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "UserAttributeNames": { + "shape": "Sz" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminDisableProviderForUser": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "User" + ], + "members": { + "UserPoolId": {}, + "User": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminDisableUser": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminEnableUser": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminForgetDevice": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "DeviceKey" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "DeviceKey": {} + } + } + }, + "AdminGetDevice": { + "input": { + "type": "structure", + "required": [ + "DeviceKey", + "UserPoolId", + "Username" + ], + "members": { + "DeviceKey": {}, + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Device" + ], + "members": { + "Device": { + "shape": "S1d" + } + } + } + }, + "AdminGetUser": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Username" + ], + "members": { + "Username": { + "shape": "Sd" + }, + "UserAttributes": { + "shape": "Si" + }, + "UserCreateDate": { + "type": "timestamp" + }, + "UserLastModifiedDate": { + "type": "timestamp" + }, + "Enabled": { + "type": "boolean" + }, + "UserStatus": {}, + "MFAOptions": { + "shape": "Sv" + }, + "PreferredMfaSetting": {}, + "UserMFASettingList": { + "shape": "S1g" + } + } + } + }, + "AdminInitiateAuth": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ClientId", + "AuthFlow" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + }, + "AuthFlow": {}, + "AuthParameters": { + "shape": "S1k" + }, + "ClientMetadata": { + "shape": "S1l" + }, + "AnalyticsMetadata": { + "shape": "S1m" + }, + "ContextData": { + "shape": "S1n" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChallengeName": {}, + "Session": {}, + "ChallengeParameters": { + "shape": "S1t" + }, + "AuthenticationResult": { + "shape": "S1u" + } + } + } + }, + "AdminLinkProviderForUser": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "DestinationUser", + "SourceUser" + ], + "members": { + "UserPoolId": {}, + "DestinationUser": { + "shape": "S12" + }, + "SourceUser": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminListDevices": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "Limit": { + "type": "integer" + }, + "PaginationToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Devices": { + "shape": "S24" + }, + "PaginationToken": {} + } + } + }, + "AdminListGroupsForUser": { + "input": { + "type": "structure", + "required": [ + "Username", + "UserPoolId" + ], + "members": { + "Username": { + "shape": "Sd" + }, + "UserPoolId": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Groups": { + "shape": "S28" + }, + "NextToken": {} + } + } + }, + "AdminListUserAuthEvents": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AuthEvents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventId": {}, + "EventType": {}, + "CreationDate": { + "type": "timestamp" + }, + "EventResponse": {}, + "EventRisk": { + "type": "structure", + "members": { + "RiskDecision": {}, + "RiskLevel": {} + } + }, + "ChallengeResponses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ChallengeName": {}, + "ChallengeResponse": {} + } + } + }, + "EventContextData": { + "type": "structure", + "members": { + "IpAddress": {}, + "DeviceName": {}, + "Timezone": {}, + "City": {}, + "Country": {} + } + }, + "EventFeedback": { + "type": "structure", + "required": [ + "FeedbackValue", + "Provider" + ], + "members": { + "FeedbackValue": {}, + "Provider": {}, + "FeedbackDate": { + "type": "timestamp" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "AdminRemoveUserFromGroup": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "GroupName" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "GroupName": {} + } + } + }, + "AdminResetUserPassword": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminRespondToAuthChallenge": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ClientId", + "ChallengeName" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + }, + "ChallengeName": {}, + "ChallengeResponses": { + "shape": "S2x" + }, + "Session": {}, + "AnalyticsMetadata": { + "shape": "S1m" + }, + "ContextData": { + "shape": "S1n" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChallengeName": {}, + "Session": {}, + "ChallengeParameters": { + "shape": "S1t" + }, + "AuthenticationResult": { + "shape": "S1u" + } + } + } + }, + "AdminSetUserMFAPreference": { + "input": { + "type": "structure", + "required": [ + "Username", + "UserPoolId" + ], + "members": { + "SMSMfaSettings": { + "shape": "S30" + }, + "SoftwareTokenMfaSettings": { + "shape": "S31" + }, + "Username": { + "shape": "Sd" + }, + "UserPoolId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminSetUserPassword": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "Password" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "Password": { + "shape": "Sm" + }, + "Permanent": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminSetUserSettings": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "MFAOptions" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "MFAOptions": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminUpdateAuthEventFeedback": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "EventId", + "FeedbackValue" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "EventId": {}, + "FeedbackValue": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminUpdateDeviceStatus": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "DeviceKey" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "DeviceKey": {}, + "DeviceRememberedStatus": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminUpdateUserAttributes": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "UserAttributes" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "UserAttributes": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AdminUserGlobalSignOut": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateSoftwareToken": { + "input": { + "type": "structure", + "members": { + "AccessToken": { + "shape": "S1v" + }, + "Session": {} + } + }, + "output": { + "type": "structure", + "members": { + "SecretCode": { + "type": "string", + "sensitive": true + }, + "Session": {} + } + } + }, + "ChangePassword": { + "input": { + "type": "structure", + "required": [ + "PreviousPassword", + "ProposedPassword", + "AccessToken" + ], + "members": { + "PreviousPassword": { + "shape": "Sm" + }, + "ProposedPassword": { + "shape": "Sm" + }, + "AccessToken": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "authtype": "none" + }, + "ConfirmDevice": { + "input": { + "type": "structure", + "required": [ + "AccessToken", + "DeviceKey" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "DeviceKey": {}, + "DeviceSecretVerifierConfig": { + "type": "structure", + "members": { + "PasswordVerifier": {}, + "Salt": {} + } + }, + "DeviceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserConfirmationNecessary": { + "type": "boolean" + } + } + } + }, + "ConfirmForgotPassword": { + "input": { + "type": "structure", + "required": [ + "ClientId", + "Username", + "ConfirmationCode", + "Password" + ], + "members": { + "ClientId": { + "shape": "S1i" + }, + "SecretHash": { + "shape": "S3r" + }, + "Username": { + "shape": "Sd" + }, + "ConfirmationCode": {}, + "Password": { + "shape": "Sm" + }, + "AnalyticsMetadata": { + "shape": "S1m" + }, + "UserContextData": { + "shape": "S3t" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "authtype": "none" + }, + "ConfirmSignUp": { + "input": { + "type": "structure", + "required": [ + "ClientId", + "Username", + "ConfirmationCode" + ], + "members": { + "ClientId": { + "shape": "S1i" + }, + "SecretHash": { + "shape": "S3r" + }, + "Username": { + "shape": "Sd" + }, + "ConfirmationCode": {}, + "ForceAliasCreation": { + "type": "boolean" + }, + "AnalyticsMetadata": { + "shape": "S1m" + }, + "UserContextData": { + "shape": "S3t" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "authtype": "none" + }, + "CreateGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserPoolId" + ], + "members": { + "GroupName": {}, + "UserPoolId": {}, + "Description": {}, + "RoleArn": {}, + "Precedence": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "S29" + } + } + } + }, + "CreateIdentityProvider": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ProviderName", + "ProviderType", + "ProviderDetails" + ], + "members": { + "UserPoolId": {}, + "ProviderName": {}, + "ProviderType": {}, + "ProviderDetails": { + "shape": "S42" + }, + "AttributeMapping": { + "shape": "S43" + }, + "IdpIdentifiers": { + "shape": "S45" + } + } + }, + "output": { + "type": "structure", + "required": [ + "IdentityProvider" + ], + "members": { + "IdentityProvider": { + "shape": "S48" + } + } + } + }, + "CreateResourceServer": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Identifier", + "Name" + ], + "members": { + "UserPoolId": {}, + "Identifier": {}, + "Name": {}, + "Scopes": { + "shape": "S4c" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ResourceServer" + ], + "members": { + "ResourceServer": { + "shape": "S4h" + } + } + } + }, + "CreateUserImportJob": { + "input": { + "type": "structure", + "required": [ + "JobName", + "UserPoolId", + "CloudWatchLogsRoleArn" + ], + "members": { + "JobName": {}, + "UserPoolId": {}, + "CloudWatchLogsRoleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserImportJob": { + "shape": "S4l" + } + } + } + }, + "CreateUserPool": { + "input": { + "type": "structure", + "required": [ + "PoolName" + ], + "members": { + "PoolName": {}, + "Policies": { + "shape": "S4t" + }, + "LambdaConfig": { + "shape": "S4x" + }, + "AutoVerifiedAttributes": { + "shape": "S4y" + }, + "AliasAttributes": { + "shape": "S50" + }, + "UsernameAttributes": { + "shape": "S52" + }, + "SmsVerificationMessage": {}, + "EmailVerificationMessage": {}, + "EmailVerificationSubject": {}, + "VerificationMessageTemplate": { + "shape": "S57" + }, + "SmsAuthenticationMessage": {}, + "MfaConfiguration": {}, + "DeviceConfiguration": { + "shape": "S5c" + }, + "EmailConfiguration": { + "shape": "S5d" + }, + "SmsConfiguration": { + "shape": "S5g" + }, + "UserPoolTags": { + "shape": "S5h" + }, + "AdminCreateUserConfig": { + "shape": "S5k" + }, + "Schema": { + "shape": "S5n" + }, + "UserPoolAddOns": { + "shape": "S5o" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserPool": { + "shape": "S5r" + } + } + } + }, + "CreateUserPoolClient": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ClientName" + ], + "members": { + "UserPoolId": {}, + "ClientName": {}, + "GenerateSecret": { + "type": "boolean" + }, + "RefreshTokenValidity": { + "type": "integer" + }, + "ReadAttributes": { + "shape": "S5y" + }, + "WriteAttributes": { + "shape": "S5y" + }, + "ExplicitAuthFlows": { + "shape": "S60" + }, + "SupportedIdentityProviders": { + "shape": "S62" + }, + "CallbackURLs": { + "shape": "S63" + }, + "LogoutURLs": { + "shape": "S65" + }, + "DefaultRedirectURI": {}, + "AllowedOAuthFlows": { + "shape": "S66" + }, + "AllowedOAuthScopes": { + "shape": "S68" + }, + "AllowedOAuthFlowsUserPoolClient": { + "type": "boolean" + }, + "AnalyticsConfiguration": { + "shape": "S6a" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserPoolClient": { + "shape": "S6d" + } + } + } + }, + "CreateUserPoolDomain": { + "input": { + "type": "structure", + "required": [ + "Domain", + "UserPoolId" + ], + "members": { + "Domain": {}, + "UserPoolId": {}, + "CustomDomainConfig": { + "shape": "S6g" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontDomain": {} + } + } + }, + "DeleteGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserPoolId" + ], + "members": { + "GroupName": {}, + "UserPoolId": {} + } + } + }, + "DeleteIdentityProvider": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ProviderName" + ], + "members": { + "UserPoolId": {}, + "ProviderName": {} + } + } + }, + "DeleteResourceServer": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Identifier" + ], + "members": { + "UserPoolId": {}, + "Identifier": {} + } + } + }, + "DeleteUser": { + "input": { + "type": "structure", + "required": [ + "AccessToken" + ], + "members": { + "AccessToken": { + "shape": "S1v" + } + } + }, + "authtype": "none" + }, + "DeleteUserAttributes": { + "input": { + "type": "structure", + "required": [ + "UserAttributeNames", + "AccessToken" + ], + "members": { + "UserAttributeNames": { + "shape": "Sz" + }, + "AccessToken": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "authtype": "none" + }, + "DeleteUserPool": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {} + } + } + }, + "DeleteUserPoolClient": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ClientId" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + } + } + } + }, + "DeleteUserPoolDomain": { + "input": { + "type": "structure", + "required": [ + "Domain", + "UserPoolId" + ], + "members": { + "Domain": {}, + "UserPoolId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeIdentityProvider": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ProviderName" + ], + "members": { + "UserPoolId": {}, + "ProviderName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "IdentityProvider" + ], + "members": { + "IdentityProvider": { + "shape": "S48" + } + } + } + }, + "DescribeResourceServer": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Identifier" + ], + "members": { + "UserPoolId": {}, + "Identifier": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ResourceServer" + ], + "members": { + "ResourceServer": { + "shape": "S4h" + } + } + } + }, + "DescribeRiskConfiguration": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RiskConfiguration" + ], + "members": { + "RiskConfiguration": { + "shape": "S6y" + } + } + } + }, + "DescribeUserImportJob": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "JobId" + ], + "members": { + "UserPoolId": {}, + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserImportJob": { + "shape": "S4l" + } + } + } + }, + "DescribeUserPool": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserPool": { + "shape": "S5r" + } + } + } + }, + "DescribeUserPoolClient": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ClientId" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserPoolClient": { + "shape": "S6d" + } + } + } + }, + "DescribeUserPoolDomain": { + "input": { + "type": "structure", + "required": [ + "Domain" + ], + "members": { + "Domain": {} + } + }, + "output": { + "type": "structure", + "members": { + "DomainDescription": { + "type": "structure", + "members": { + "UserPoolId": {}, + "AWSAccountId": {}, + "Domain": {}, + "S3Bucket": {}, + "CloudFrontDistribution": {}, + "Version": {}, + "Status": {}, + "CustomDomainConfig": { + "shape": "S6g" + } + } + } + } + } + }, + "ForgetDevice": { + "input": { + "type": "structure", + "required": [ + "DeviceKey" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "DeviceKey": {} + } + } + }, + "ForgotPassword": { + "input": { + "type": "structure", + "required": [ + "ClientId", + "Username" + ], + "members": { + "ClientId": { + "shape": "S1i" + }, + "SecretHash": { + "shape": "S3r" + }, + "UserContextData": { + "shape": "S3t" + }, + "Username": { + "shape": "Sd" + }, + "AnalyticsMetadata": { + "shape": "S1m" + } + } + }, + "output": { + "type": "structure", + "members": { + "CodeDeliveryDetails": { + "shape": "S7w" + } + } + }, + "authtype": "none" + }, + "GetCSVHeader": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserPoolId": {}, + "CSVHeader": { + "type": "list", + "member": {} + } + } + } + }, + "GetDevice": { + "input": { + "type": "structure", + "required": [ + "DeviceKey" + ], + "members": { + "DeviceKey": {}, + "AccessToken": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Device" + ], + "members": { + "Device": { + "shape": "S1d" + } + } + } + }, + "GetGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserPoolId" + ], + "members": { + "GroupName": {}, + "UserPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "S29" + } + } + } + }, + "GetIdentityProviderByIdentifier": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "IdpIdentifier" + ], + "members": { + "UserPoolId": {}, + "IdpIdentifier": {} + } + }, + "output": { + "type": "structure", + "required": [ + "IdentityProvider" + ], + "members": { + "IdentityProvider": { + "shape": "S48" + } + } + } + }, + "GetSigningCertificate": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": {} + } + } + }, + "GetUICustomization": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + } + } + }, + "output": { + "type": "structure", + "required": [ + "UICustomization" + ], + "members": { + "UICustomization": { + "shape": "S8a" + } + } + } + }, + "GetUser": { + "input": { + "type": "structure", + "required": [ + "AccessToken" + ], + "members": { + "AccessToken": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Username", + "UserAttributes" + ], + "members": { + "Username": { + "shape": "Sd" + }, + "UserAttributes": { + "shape": "Si" + }, + "MFAOptions": { + "shape": "Sv" + }, + "PreferredMfaSetting": {}, + "UserMFASettingList": { + "shape": "S1g" + } + } + }, + "authtype": "none" + }, + "GetUserAttributeVerificationCode": { + "input": { + "type": "structure", + "required": [ + "AccessToken", + "AttributeName" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "AttributeName": {} + } + }, + "output": { + "type": "structure", + "members": { + "CodeDeliveryDetails": { + "shape": "S7w" + } + } + }, + "authtype": "none" + }, + "GetUserPoolMfaConfig": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SmsMfaConfiguration": { + "shape": "S8k" + }, + "SoftwareTokenMfaConfiguration": { + "shape": "S8l" + }, + "MfaConfiguration": {} + } + } + }, + "GlobalSignOut": { + "input": { + "type": "structure", + "required": [ + "AccessToken" + ], + "members": { + "AccessToken": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "InitiateAuth": { + "input": { + "type": "structure", + "required": [ + "AuthFlow", + "ClientId" + ], + "members": { + "AuthFlow": {}, + "AuthParameters": { + "shape": "S1k" + }, + "ClientMetadata": { + "shape": "S1l" + }, + "ClientId": { + "shape": "S1i" + }, + "AnalyticsMetadata": { + "shape": "S1m" + }, + "UserContextData": { + "shape": "S3t" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChallengeName": {}, + "Session": {}, + "ChallengeParameters": { + "shape": "S1t" + }, + "AuthenticationResult": { + "shape": "S1u" + } + } + } + }, + "ListDevices": { + "input": { + "type": "structure", + "required": [ + "AccessToken" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "Limit": { + "type": "integer" + }, + "PaginationToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Devices": { + "shape": "S24" + }, + "PaginationToken": {} + } + } + }, + "ListGroups": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Groups": { + "shape": "S28" + }, + "NextToken": {} + } + } + }, + "ListIdentityProviders": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Providers" + ], + "members": { + "Providers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProviderName": {}, + "ProviderType": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "CreationDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListResourceServers": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ResourceServers" + ], + "members": { + "ResourceServers": { + "type": "list", + "member": { + "shape": "S4h" + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S5h" + } + } + } + }, + "ListUserImportJobs": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "MaxResults" + ], + "members": { + "UserPoolId": {}, + "MaxResults": { + "type": "integer" + }, + "PaginationToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserImportJobs": { + "type": "list", + "member": { + "shape": "S4l" + } + }, + "PaginationToken": {} + } + } + }, + "ListUserPoolClients": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserPoolClients": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ClientId": { + "shape": "S1i" + }, + "UserPoolId": {}, + "ClientName": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListUserPools": { + "input": { + "type": "structure", + "required": [ + "MaxResults" + ], + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserPools": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "LambdaConfig": { + "shape": "S4x" + }, + "Status": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "CreationDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListUsers": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "AttributesToGet": { + "type": "list", + "member": {} + }, + "Limit": { + "type": "integer" + }, + "PaginationToken": {}, + "Filter": {} + } + }, + "output": { + "type": "structure", + "members": { + "Users": { + "shape": "S9n" + }, + "PaginationToken": {} + } + } + }, + "ListUsersInGroup": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "GroupName" + ], + "members": { + "UserPoolId": {}, + "GroupName": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Users": { + "shape": "S9n" + }, + "NextToken": {} + } + } + }, + "ResendConfirmationCode": { + "input": { + "type": "structure", + "required": [ + "ClientId", + "Username" + ], + "members": { + "ClientId": { + "shape": "S1i" + }, + "SecretHash": { + "shape": "S3r" + }, + "UserContextData": { + "shape": "S3t" + }, + "Username": { + "shape": "Sd" + }, + "AnalyticsMetadata": { + "shape": "S1m" + } + } + }, + "output": { + "type": "structure", + "members": { + "CodeDeliveryDetails": { + "shape": "S7w" + } + } + }, + "authtype": "none" + }, + "RespondToAuthChallenge": { + "input": { + "type": "structure", + "required": [ + "ClientId", + "ChallengeName" + ], + "members": { + "ClientId": { + "shape": "S1i" + }, + "ChallengeName": {}, + "Session": {}, + "ChallengeResponses": { + "shape": "S2x" + }, + "AnalyticsMetadata": { + "shape": "S1m" + }, + "UserContextData": { + "shape": "S3t" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChallengeName": {}, + "Session": {}, + "ChallengeParameters": { + "shape": "S1t" + }, + "AuthenticationResult": { + "shape": "S1u" + } + } + } + }, + "SetRiskConfiguration": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + }, + "CompromisedCredentialsRiskConfiguration": { + "shape": "S6z" + }, + "AccountTakeoverRiskConfiguration": { + "shape": "S74" + }, + "RiskExceptionConfiguration": { + "shape": "S7d" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RiskConfiguration" + ], + "members": { + "RiskConfiguration": { + "shape": "S6y" + } + } + } + }, + "SetUICustomization": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + }, + "CSS": {}, + "ImageFile": { + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "required": [ + "UICustomization" + ], + "members": { + "UICustomization": { + "shape": "S8a" + } + } + } + }, + "SetUserMFAPreference": { + "input": { + "type": "structure", + "required": [ + "AccessToken" + ], + "members": { + "SMSMfaSettings": { + "shape": "S30" + }, + "SoftwareTokenMfaSettings": { + "shape": "S31" + }, + "AccessToken": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SetUserPoolMfaConfig": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "SmsMfaConfiguration": { + "shape": "S8k" + }, + "SoftwareTokenMfaConfiguration": { + "shape": "S8l" + }, + "MfaConfiguration": {} + } + }, + "output": { + "type": "structure", + "members": { + "SmsMfaConfiguration": { + "shape": "S8k" + }, + "SoftwareTokenMfaConfiguration": { + "shape": "S8l" + }, + "MfaConfiguration": {} + } + } + }, + "SetUserSettings": { + "input": { + "type": "structure", + "required": [ + "AccessToken", + "MFAOptions" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "MFAOptions": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "authtype": "none" + }, + "SignUp": { + "input": { + "type": "structure", + "required": [ + "ClientId", + "Username", + "Password" + ], + "members": { + "ClientId": { + "shape": "S1i" + }, + "SecretHash": { + "shape": "S3r" + }, + "Username": { + "shape": "Sd" + }, + "Password": { + "shape": "Sm" + }, + "UserAttributes": { + "shape": "Si" + }, + "ValidationData": { + "shape": "Si" + }, + "AnalyticsMetadata": { + "shape": "S1m" + }, + "UserContextData": { + "shape": "S3t" + } + } + }, + "output": { + "type": "structure", + "required": [ + "UserConfirmed", + "UserSub" + ], + "members": { + "UserConfirmed": { + "type": "boolean" + }, + "CodeDeliveryDetails": { + "shape": "S7w" + }, + "UserSub": {} + } + }, + "authtype": "none" + }, + "StartUserImportJob": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "JobId" + ], + "members": { + "UserPoolId": {}, + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserImportJob": { + "shape": "S4l" + } + } + } + }, + "StopUserImportJob": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "JobId" + ], + "members": { + "UserPoolId": {}, + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserImportJob": { + "shape": "S4l" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S5h" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateAuthEventFeedback": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Username", + "EventId", + "FeedbackToken", + "FeedbackValue" + ], + "members": { + "UserPoolId": {}, + "Username": { + "shape": "Sd" + }, + "EventId": {}, + "FeedbackToken": { + "shape": "S1v" + }, + "FeedbackValue": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDeviceStatus": { + "input": { + "type": "structure", + "required": [ + "AccessToken", + "DeviceKey" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "DeviceKey": {}, + "DeviceRememberedStatus": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserPoolId" + ], + "members": { + "GroupName": {}, + "UserPoolId": {}, + "Description": {}, + "RoleArn": {}, + "Precedence": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "S29" + } + } + } + }, + "UpdateIdentityProvider": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ProviderName" + ], + "members": { + "UserPoolId": {}, + "ProviderName": {}, + "ProviderDetails": { + "shape": "S42" + }, + "AttributeMapping": { + "shape": "S43" + }, + "IdpIdentifiers": { + "shape": "S45" + } + } + }, + "output": { + "type": "structure", + "required": [ + "IdentityProvider" + ], + "members": { + "IdentityProvider": { + "shape": "S48" + } + } + } + }, + "UpdateResourceServer": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "Identifier", + "Name" + ], + "members": { + "UserPoolId": {}, + "Identifier": {}, + "Name": {}, + "Scopes": { + "shape": "S4c" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ResourceServer" + ], + "members": { + "ResourceServer": { + "shape": "S4h" + } + } + } + }, + "UpdateUserAttributes": { + "input": { + "type": "structure", + "required": [ + "UserAttributes", + "AccessToken" + ], + "members": { + "UserAttributes": { + "shape": "Si" + }, + "AccessToken": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "members": { + "CodeDeliveryDetailsList": { + "type": "list", + "member": { + "shape": "S7w" + } + } + } + }, + "authtype": "none" + }, + "UpdateUserPool": { + "input": { + "type": "structure", + "required": [ + "UserPoolId" + ], + "members": { + "UserPoolId": {}, + "Policies": { + "shape": "S4t" + }, + "LambdaConfig": { + "shape": "S4x" + }, + "AutoVerifiedAttributes": { + "shape": "S4y" + }, + "SmsVerificationMessage": {}, + "EmailVerificationMessage": {}, + "EmailVerificationSubject": {}, + "VerificationMessageTemplate": { + "shape": "S57" + }, + "SmsAuthenticationMessage": {}, + "MfaConfiguration": {}, + "DeviceConfiguration": { + "shape": "S5c" + }, + "EmailConfiguration": { + "shape": "S5d" + }, + "SmsConfiguration": { + "shape": "S5g" + }, + "UserPoolTags": { + "shape": "S5h" + }, + "AdminCreateUserConfig": { + "shape": "S5k" + }, + "UserPoolAddOns": { + "shape": "S5o" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateUserPoolClient": { + "input": { + "type": "structure", + "required": [ + "UserPoolId", + "ClientId" + ], + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + }, + "ClientName": {}, + "RefreshTokenValidity": { + "type": "integer" + }, + "ReadAttributes": { + "shape": "S5y" + }, + "WriteAttributes": { + "shape": "S5y" + }, + "ExplicitAuthFlows": { + "shape": "S60" + }, + "SupportedIdentityProviders": { + "shape": "S62" + }, + "CallbackURLs": { + "shape": "S63" + }, + "LogoutURLs": { + "shape": "S65" + }, + "DefaultRedirectURI": {}, + "AllowedOAuthFlows": { + "shape": "S66" + }, + "AllowedOAuthScopes": { + "shape": "S68" + }, + "AllowedOAuthFlowsUserPoolClient": { + "type": "boolean" + }, + "AnalyticsConfiguration": { + "shape": "S6a" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserPoolClient": { + "shape": "S6d" + } + } + } + }, + "UpdateUserPoolDomain": { + "input": { + "type": "structure", + "required": [ + "Domain", + "UserPoolId", + "CustomDomainConfig" + ], + "members": { + "Domain": {}, + "UserPoolId": {}, + "CustomDomainConfig": { + "shape": "S6g" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontDomain": {} + } + } + }, + "VerifySoftwareToken": { + "input": { + "type": "structure", + "required": [ + "UserCode" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "Session": {}, + "UserCode": {}, + "FriendlyDeviceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Status": {}, + "Session": {} + } + } + }, + "VerifyUserAttribute": { + "input": { + "type": "structure", + "required": [ + "AccessToken", + "AttributeName", + "Code" + ], + "members": { + "AccessToken": { + "shape": "S1v" + }, + "AttributeName": {}, + "Code": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "authtype": "none" + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "Name": {}, + "AttributeDataType": {}, + "DeveloperOnlyAttribute": { + "type": "boolean" + }, + "Mutable": { + "type": "boolean" + }, + "Required": { + "type": "boolean" + }, + "NumberAttributeConstraints": { + "type": "structure", + "members": { + "MinValue": {}, + "MaxValue": {} + } + }, + "StringAttributeConstraints": { + "type": "structure", + "members": { + "MinLength": {}, + "MaxLength": {} + } + } + } + }, + "Sd": { + "type": "string", + "sensitive": true + }, + "Si": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Value": { + "type": "string", + "sensitive": true + } + } + } + }, + "Sm": { + "type": "string", + "sensitive": true + }, + "Ss": { + "type": "structure", + "members": { + "Username": { + "shape": "Sd" + }, + "Attributes": { + "shape": "Si" + }, + "UserCreateDate": { + "type": "timestamp" + }, + "UserLastModifiedDate": { + "type": "timestamp" + }, + "Enabled": { + "type": "boolean" + }, + "UserStatus": {}, + "MFAOptions": { + "shape": "Sv" + } + } + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DeliveryMedium": {}, + "AttributeName": {} + } + } + }, + "Sz": { + "type": "list", + "member": {} + }, + "S12": { + "type": "structure", + "members": { + "ProviderName": {}, + "ProviderAttributeName": {}, + "ProviderAttributeValue": {} + } + }, + "S1d": { + "type": "structure", + "members": { + "DeviceKey": {}, + "DeviceAttributes": { + "shape": "Si" + }, + "DeviceCreateDate": { + "type": "timestamp" + }, + "DeviceLastModifiedDate": { + "type": "timestamp" + }, + "DeviceLastAuthenticatedDate": { + "type": "timestamp" + } + } + }, + "S1g": { + "type": "list", + "member": {} + }, + "S1i": { + "type": "string", + "sensitive": true + }, + "S1k": { + "type": "map", + "key": {}, + "value": {} + }, + "S1l": { + "type": "map", + "key": {}, + "value": {} + }, + "S1m": { + "type": "structure", + "members": { + "AnalyticsEndpointId": {} + } + }, + "S1n": { + "type": "structure", + "required": [ + "IpAddress", + "ServerName", + "ServerPath", + "HttpHeaders" + ], + "members": { + "IpAddress": {}, + "ServerName": {}, + "ServerPath": {}, + "HttpHeaders": { + "type": "list", + "member": { + "type": "structure", + "members": { + "headerName": {}, + "headerValue": {} + } + } + }, + "EncodedData": {} + } + }, + "S1t": { + "type": "map", + "key": {}, + "value": {} + }, + "S1u": { + "type": "structure", + "members": { + "AccessToken": { + "shape": "S1v" + }, + "ExpiresIn": { + "type": "integer" + }, + "TokenType": {}, + "RefreshToken": { + "shape": "S1v" + }, + "IdToken": { + "shape": "S1v" + }, + "NewDeviceMetadata": { + "type": "structure", + "members": { + "DeviceKey": {}, + "DeviceGroupKey": {} + } + } + } + }, + "S1v": { + "type": "string", + "sensitive": true + }, + "S24": { + "type": "list", + "member": { + "shape": "S1d" + } + }, + "S28": { + "type": "list", + "member": { + "shape": "S29" + } + }, + "S29": { + "type": "structure", + "members": { + "GroupName": {}, + "UserPoolId": {}, + "Description": {}, + "RoleArn": {}, + "Precedence": { + "type": "integer" + }, + "LastModifiedDate": { + "type": "timestamp" + }, + "CreationDate": { + "type": "timestamp" + } + } + }, + "S2x": { + "type": "map", + "key": {}, + "value": {} + }, + "S30": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "PreferredMfa": { + "type": "boolean" + } + } + }, + "S31": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "PreferredMfa": { + "type": "boolean" + } + } + }, + "S3r": { + "type": "string", + "sensitive": true + }, + "S3t": { + "type": "structure", + "members": { + "EncodedData": {} + } + }, + "S42": { + "type": "map", + "key": {}, + "value": {} + }, + "S43": { + "type": "map", + "key": {}, + "value": {} + }, + "S45": { + "type": "list", + "member": {} + }, + "S48": { + "type": "structure", + "members": { + "UserPoolId": {}, + "ProviderName": {}, + "ProviderType": {}, + "ProviderDetails": { + "shape": "S42" + }, + "AttributeMapping": { + "shape": "S43" + }, + "IdpIdentifiers": { + "shape": "S45" + }, + "LastModifiedDate": { + "type": "timestamp" + }, + "CreationDate": { + "type": "timestamp" + } + } + }, + "S4c": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ScopeName", + "ScopeDescription" + ], + "members": { + "ScopeName": {}, + "ScopeDescription": {} + } + } + }, + "S4h": { + "type": "structure", + "members": { + "UserPoolId": {}, + "Identifier": {}, + "Name": {}, + "Scopes": { + "shape": "S4c" + } + } + }, + "S4l": { + "type": "structure", + "members": { + "JobName": {}, + "JobId": {}, + "UserPoolId": {}, + "PreSignedUrl": {}, + "CreationDate": { + "type": "timestamp" + }, + "StartDate": { + "type": "timestamp" + }, + "CompletionDate": { + "type": "timestamp" + }, + "Status": {}, + "CloudWatchLogsRoleArn": {}, + "ImportedUsers": { + "type": "long" + }, + "SkippedUsers": { + "type": "long" + }, + "FailedUsers": { + "type": "long" + }, + "CompletionMessage": {} + } + }, + "S4t": { + "type": "structure", + "members": { + "PasswordPolicy": { + "type": "structure", + "members": { + "MinimumLength": { + "type": "integer" + }, + "RequireUppercase": { + "type": "boolean" + }, + "RequireLowercase": { + "type": "boolean" + }, + "RequireNumbers": { + "type": "boolean" + }, + "RequireSymbols": { + "type": "boolean" + }, + "TemporaryPasswordValidityDays": { + "type": "integer" + } + } + } + } + }, + "S4x": { + "type": "structure", + "members": { + "PreSignUp": {}, + "CustomMessage": {}, + "PostConfirmation": {}, + "PreAuthentication": {}, + "PostAuthentication": {}, + "DefineAuthChallenge": {}, + "CreateAuthChallenge": {}, + "VerifyAuthChallengeResponse": {}, + "PreTokenGeneration": {}, + "UserMigration": {} + } + }, + "S4y": { + "type": "list", + "member": {} + }, + "S50": { + "type": "list", + "member": {} + }, + "S52": { + "type": "list", + "member": {} + }, + "S57": { + "type": "structure", + "members": { + "SmsMessage": {}, + "EmailMessage": {}, + "EmailSubject": {}, + "EmailMessageByLink": {}, + "EmailSubjectByLink": {}, + "DefaultEmailOption": {} + } + }, + "S5c": { + "type": "structure", + "members": { + "ChallengeRequiredOnNewDevice": { + "type": "boolean" + }, + "DeviceOnlyRememberedOnUserPrompt": { + "type": "boolean" + } + } + }, + "S5d": { + "type": "structure", + "members": { + "SourceArn": {}, + "ReplyToEmailAddress": {}, + "EmailSendingAccount": {} + } + }, + "S5g": { + "type": "structure", + "required": [ + "SnsCallerArn" + ], + "members": { + "SnsCallerArn": {}, + "ExternalId": {} + } + }, + "S5h": { + "type": "map", + "key": {}, + "value": {} + }, + "S5k": { + "type": "structure", + "members": { + "AllowAdminCreateUserOnly": { + "type": "boolean" + }, + "UnusedAccountValidityDays": { + "type": "integer" + }, + "InviteMessageTemplate": { + "type": "structure", + "members": { + "SMSMessage": {}, + "EmailMessage": {}, + "EmailSubject": {} + } + } + } + }, + "S5n": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "S5o": { + "type": "structure", + "required": [ + "AdvancedSecurityMode" + ], + "members": { + "AdvancedSecurityMode": {} + } + }, + "S5r": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Policies": { + "shape": "S4t" + }, + "LambdaConfig": { + "shape": "S4x" + }, + "Status": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "CreationDate": { + "type": "timestamp" + }, + "SchemaAttributes": { + "shape": "S5n" + }, + "AutoVerifiedAttributes": { + "shape": "S4y" + }, + "AliasAttributes": { + "shape": "S50" + }, + "UsernameAttributes": { + "shape": "S52" + }, + "SmsVerificationMessage": {}, + "EmailVerificationMessage": {}, + "EmailVerificationSubject": {}, + "VerificationMessageTemplate": { + "shape": "S57" + }, + "SmsAuthenticationMessage": {}, + "MfaConfiguration": {}, + "DeviceConfiguration": { + "shape": "S5c" + }, + "EstimatedNumberOfUsers": { + "type": "integer" + }, + "EmailConfiguration": { + "shape": "S5d" + }, + "SmsConfiguration": { + "shape": "S5g" + }, + "UserPoolTags": { + "shape": "S5h" + }, + "SmsConfigurationFailure": {}, + "EmailConfigurationFailure": {}, + "Domain": {}, + "CustomDomain": {}, + "AdminCreateUserConfig": { + "shape": "S5k" + }, + "UserPoolAddOns": { + "shape": "S5o" + }, + "Arn": {} + } + }, + "S5y": { + "type": "list", + "member": {} + }, + "S60": { + "type": "list", + "member": {} + }, + "S62": { + "type": "list", + "member": {} + }, + "S63": { + "type": "list", + "member": {} + }, + "S65": { + "type": "list", + "member": {} + }, + "S66": { + "type": "list", + "member": {} + }, + "S68": { + "type": "list", + "member": {} + }, + "S6a": { + "type": "structure", + "required": [ + "ApplicationId", + "RoleArn", + "ExternalId" + ], + "members": { + "ApplicationId": {}, + "RoleArn": {}, + "ExternalId": {}, + "UserDataShared": { + "type": "boolean" + } + } + }, + "S6d": { + "type": "structure", + "members": { + "UserPoolId": {}, + "ClientName": {}, + "ClientId": { + "shape": "S1i" + }, + "ClientSecret": { + "type": "string", + "sensitive": true + }, + "LastModifiedDate": { + "type": "timestamp" + }, + "CreationDate": { + "type": "timestamp" + }, + "RefreshTokenValidity": { + "type": "integer" + }, + "ReadAttributes": { + "shape": "S5y" + }, + "WriteAttributes": { + "shape": "S5y" + }, + "ExplicitAuthFlows": { + "shape": "S60" + }, + "SupportedIdentityProviders": { + "shape": "S62" + }, + "CallbackURLs": { + "shape": "S63" + }, + "LogoutURLs": { + "shape": "S65" + }, + "DefaultRedirectURI": {}, + "AllowedOAuthFlows": { + "shape": "S66" + }, + "AllowedOAuthScopes": { + "shape": "S68" + }, + "AllowedOAuthFlowsUserPoolClient": { + "type": "boolean" + }, + "AnalyticsConfiguration": { + "shape": "S6a" + } + } + }, + "S6g": { + "type": "structure", + "required": [ + "CertificateArn" + ], + "members": { + "CertificateArn": {} + } + }, + "S6y": { + "type": "structure", + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + }, + "CompromisedCredentialsRiskConfiguration": { + "shape": "S6z" + }, + "AccountTakeoverRiskConfiguration": { + "shape": "S74" + }, + "RiskExceptionConfiguration": { + "shape": "S7d" + }, + "LastModifiedDate": { + "type": "timestamp" + } + } + }, + "S6z": { + "type": "structure", + "required": [ + "Actions" + ], + "members": { + "EventFilter": { + "type": "list", + "member": {} + }, + "Actions": { + "type": "structure", + "required": [ + "EventAction" + ], + "members": { + "EventAction": {} + } + } + } + }, + "S74": { + "type": "structure", + "required": [ + "Actions" + ], + "members": { + "NotifyConfiguration": { + "type": "structure", + "required": [ + "SourceArn" + ], + "members": { + "From": {}, + "ReplyTo": {}, + "SourceArn": {}, + "BlockEmail": { + "shape": "S76" + }, + "NoActionEmail": { + "shape": "S76" + }, + "MfaEmail": { + "shape": "S76" + } + } + }, + "Actions": { + "type": "structure", + "members": { + "LowAction": { + "shape": "S7a" + }, + "MediumAction": { + "shape": "S7a" + }, + "HighAction": { + "shape": "S7a" + } + } + } + } + }, + "S76": { + "type": "structure", + "required": [ + "Subject" + ], + "members": { + "Subject": {}, + "HtmlBody": {}, + "TextBody": {} + } + }, + "S7a": { + "type": "structure", + "required": [ + "Notify", + "EventAction" + ], + "members": { + "Notify": { + "type": "boolean" + }, + "EventAction": {} + } + }, + "S7d": { + "type": "structure", + "members": { + "BlockedIPRangeList": { + "type": "list", + "member": {} + }, + "SkippedIPRangeList": { + "type": "list", + "member": {} + } + } + }, + "S7w": { + "type": "structure", + "members": { + "Destination": {}, + "DeliveryMedium": {}, + "AttributeName": {} + } + }, + "S8a": { + "type": "structure", + "members": { + "UserPoolId": {}, + "ClientId": { + "shape": "S1i" + }, + "ImageUrl": {}, + "CSS": {}, + "CSSVersion": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "CreationDate": { + "type": "timestamp" + } + } + }, + "S8k": { + "type": "structure", + "members": { + "SmsAuthenticationMessage": {}, + "SmsConfiguration": { + "shape": "S5g" + } + } + }, + "S8l": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "S9n": { + "type": "list", + "member": { + "shape": "Ss" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.paginators.json b/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.paginators.json new file mode 100644 index 0000000..87753bd --- /dev/null +++ b/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.paginators.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "AdminListGroupsForUser": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Groups" + }, + "AdminListUserAuthEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AuthEvents" + }, + "ListGroups": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Groups" + }, + "ListIdentityProviders": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Providers" + }, + "ListResourceServers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ResourceServers" + }, + "ListUserPoolClients": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "UserPoolClients" + }, + "ListUserPools": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "UserPools" + }, + "ListUsersInGroup": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Users" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cognito-sync-2014-06-30.min.json b/node_modules/aws-sdk/apis/cognito-sync-2014-06-30.min.json new file mode 100644 index 0000000..1005826 --- /dev/null +++ b/node_modules/aws-sdk/apis/cognito-sync-2014-06-30.min.json @@ -0,0 +1,748 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-06-30", + "endpointPrefix": "cognito-sync", + "jsonVersion": "1.1", + "serviceFullName": "Amazon Cognito Sync", + "serviceId": "Cognito Sync", + "signatureVersion": "v4", + "protocol": "rest-json", + "uid": "cognito-sync-2014-06-30" + }, + "operations": { + "BulkPublish": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/bulkpublish", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolId": {} + } + } + }, + "DeleteDataset": { + "http": { + "method": "DELETE", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Dataset": { + "shape": "S8" + } + } + } + }, + "DescribeDataset": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Dataset": { + "shape": "S8" + } + } + } + }, + "DescribeIdentityPoolUsage": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolUsage": { + "shape": "Sg" + } + } + } + }, + "DescribeIdentityUsage": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityUsage": { + "type": "structure", + "members": { + "IdentityId": {}, + "IdentityPoolId": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "DatasetCount": { + "type": "integer" + }, + "DataStorage": { + "type": "long" + } + } + } + } + } + }, + "GetBulkPublishDetails": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/getBulkPublishDetails", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "BulkPublishStartTime": { + "type": "timestamp" + }, + "BulkPublishCompleteTime": { + "type": "timestamp" + }, + "BulkPublishStatus": {}, + "FailureMessage": {} + } + } + }, + "GetCognitoEvents": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/events", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Events": { + "shape": "Sq" + } + } + } + }, + "GetIdentityPoolConfiguration": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "PushSync": { + "shape": "Sv" + }, + "CognitoStreams": { + "shape": "Sz" + } + } + } + }, + "ListDatasets": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityId", + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Datasets": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "Count": { + "type": "integer" + }, + "NextToken": {} + } + } + }, + "ListIdentityPoolUsage": { + "http": { + "method": "GET", + "requestUri": "/identitypools", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolUsages": { + "type": "list", + "member": { + "shape": "Sg" + } + }, + "MaxResults": { + "type": "integer" + }, + "Count": { + "type": "integer" + }, + "NextToken": {} + } + } + }, + "ListRecords": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + }, + "LastSyncCount": { + "location": "querystring", + "locationName": "lastSyncCount", + "type": "long" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "SyncSessionToken": { + "location": "querystring", + "locationName": "syncSessionToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Records": { + "shape": "S1c" + }, + "NextToken": {}, + "Count": { + "type": "integer" + }, + "DatasetSyncCount": { + "type": "long" + }, + "LastModifiedBy": {}, + "MergedDatasetNames": { + "type": "list", + "member": {} + }, + "DatasetExists": { + "type": "boolean" + }, + "DatasetDeletedAfterRequestedSyncCount": { + "type": "boolean" + }, + "SyncSessionToken": {} + } + } + }, + "RegisterDevice": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/identity/{IdentityId}/device", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "Platform", + "Token" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "Platform": {}, + "Token": {} + } + }, + "output": { + "type": "structure", + "members": { + "DeviceId": {} + } + } + }, + "SetCognitoEvents": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/events", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "Events" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "Events": { + "shape": "Sq" + } + } + } + }, + "SetIdentityPoolConfiguration": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "PushSync": { + "shape": "Sv" + }, + "CognitoStreams": { + "shape": "Sz" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "PushSync": { + "shape": "Sv" + }, + "CognitoStreams": { + "shape": "Sz" + } + } + } + }, + "SubscribeToDataset": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "DeviceId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + }, + "DeviceId": { + "location": "uri", + "locationName": "DeviceId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UnsubscribeFromDataset": { + "http": { + "method": "DELETE", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "DeviceId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + }, + "DeviceId": { + "location": "uri", + "locationName": "DeviceId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateRecords": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "SyncSessionToken" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + }, + "DeviceId": {}, + "RecordPatches": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Op", + "Key", + "SyncCount" + ], + "members": { + "Op": {}, + "Key": {}, + "Value": {}, + "SyncCount": { + "type": "long" + }, + "DeviceLastModifiedDate": { + "type": "timestamp" + } + } + } + }, + "SyncSessionToken": {}, + "ClientContext": { + "location": "header", + "locationName": "x-amz-Client-Context" + } + } + }, + "output": { + "type": "structure", + "members": { + "Records": { + "shape": "S1c" + } + } + } + } + }, + "shapes": { + "S8": { + "type": "structure", + "members": { + "IdentityId": {}, + "DatasetName": {}, + "CreationDate": { + "type": "timestamp" + }, + "LastModifiedDate": { + "type": "timestamp" + }, + "LastModifiedBy": {}, + "DataStorage": { + "type": "long" + }, + "NumRecords": { + "type": "long" + } + } + }, + "Sg": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "SyncSessionsCount": { + "type": "long" + }, + "DataStorage": { + "type": "long" + }, + "LastModifiedDate": { + "type": "timestamp" + } + } + }, + "Sq": { + "type": "map", + "key": {}, + "value": {} + }, + "Sv": { + "type": "structure", + "members": { + "ApplicationArns": { + "type": "list", + "member": {} + }, + "RoleArn": {} + } + }, + "Sz": { + "type": "structure", + "members": { + "StreamName": {}, + "RoleArn": {}, + "StreamingStatus": {} + } + }, + "S1c": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "SyncCount": { + "type": "long" + }, + "LastModifiedDate": { + "type": "timestamp" + }, + "LastModifiedBy": {}, + "DeviceLastModifiedDate": { + "type": "timestamp" + } + } + } + } + }, + "examples": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/comprehend-2017-11-27.examples.json b/node_modules/aws-sdk/apis/comprehend-2017-11-27.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/comprehend-2017-11-27.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/comprehend-2017-11-27.min.json b/node_modules/aws-sdk/apis/comprehend-2017-11-27.min.json new file mode 100644 index 0000000..6253a0e --- /dev/null +++ b/node_modules/aws-sdk/apis/comprehend-2017-11-27.min.json @@ -0,0 +1,1694 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-11-27", + "endpointPrefix": "comprehend", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Comprehend", + "serviceId": "Comprehend", + "signatureVersion": "v4", + "signingName": "comprehend", + "targetPrefix": "Comprehend_20171127", + "uid": "comprehend-2017-11-27" + }, + "operations": { + "BatchDetectDominantLanguage": { + "input": { + "type": "structure", + "required": [ + "TextList" + ], + "members": { + "TextList": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ResultList", + "ErrorList" + ], + "members": { + "ResultList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Index": { + "type": "integer" + }, + "Languages": { + "shape": "S8" + } + } + } + }, + "ErrorList": { + "shape": "Sb" + } + } + } + }, + "BatchDetectEntities": { + "input": { + "type": "structure", + "required": [ + "TextList", + "LanguageCode" + ], + "members": { + "TextList": { + "shape": "S2" + }, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ResultList", + "ErrorList" + ], + "members": { + "ResultList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Index": { + "type": "integer" + }, + "Entities": { + "shape": "Si" + } + } + } + }, + "ErrorList": { + "shape": "Sb" + } + } + } + }, + "BatchDetectKeyPhrases": { + "input": { + "type": "structure", + "required": [ + "TextList", + "LanguageCode" + ], + "members": { + "TextList": { + "shape": "S2" + }, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ResultList", + "ErrorList" + ], + "members": { + "ResultList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Index": { + "type": "integer" + }, + "KeyPhrases": { + "shape": "Sp" + } + } + } + }, + "ErrorList": { + "shape": "Sb" + } + } + } + }, + "BatchDetectSentiment": { + "input": { + "type": "structure", + "required": [ + "TextList", + "LanguageCode" + ], + "members": { + "TextList": { + "shape": "S2" + }, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ResultList", + "ErrorList" + ], + "members": { + "ResultList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Index": { + "type": "integer" + }, + "Sentiment": {}, + "SentimentScore": { + "shape": "Sw" + } + } + } + }, + "ErrorList": { + "shape": "Sb" + } + } + } + }, + "BatchDetectSyntax": { + "input": { + "type": "structure", + "required": [ + "TextList", + "LanguageCode" + ], + "members": { + "TextList": { + "shape": "S2" + }, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ResultList", + "ErrorList" + ], + "members": { + "ResultList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Index": { + "type": "integer" + }, + "SyntaxTokens": { + "shape": "S12" + } + } + } + }, + "ErrorList": { + "shape": "Sb" + } + } + } + }, + "CreateDocumentClassifier": { + "input": { + "type": "structure", + "required": [ + "DocumentClassifierName", + "DataAccessRoleArn", + "InputDataConfig", + "LanguageCode" + ], + "members": { + "DocumentClassifierName": {}, + "DataAccessRoleArn": {}, + "Tags": { + "shape": "S19" + }, + "InputDataConfig": { + "shape": "S1d" + }, + "OutputDataConfig": { + "shape": "S1f" + }, + "ClientRequestToken": { + "idempotencyToken": true + }, + "LanguageCode": {}, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentClassifierArn": {} + } + } + }, + "CreateEntityRecognizer": { + "input": { + "type": "structure", + "required": [ + "RecognizerName", + "DataAccessRoleArn", + "InputDataConfig", + "LanguageCode" + ], + "members": { + "RecognizerName": {}, + "DataAccessRoleArn": {}, + "Tags": { + "shape": "S19" + }, + "InputDataConfig": { + "shape": "S1l" + }, + "ClientRequestToken": { + "idempotencyToken": true + }, + "LanguageCode": {}, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "EntityRecognizerArn": {} + } + } + }, + "DeleteDocumentClassifier": { + "input": { + "type": "structure", + "required": [ + "DocumentClassifierArn" + ], + "members": { + "DocumentClassifierArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteEntityRecognizer": { + "input": { + "type": "structure", + "required": [ + "EntityRecognizerArn" + ], + "members": { + "EntityRecognizerArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeDocumentClassificationJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentClassificationJobProperties": { + "shape": "S21" + } + } + } + }, + "DescribeDocumentClassifier": { + "input": { + "type": "structure", + "required": [ + "DocumentClassifierArn" + ], + "members": { + "DocumentClassifierArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentClassifierProperties": { + "shape": "S2b" + } + } + } + }, + "DescribeDominantLanguageDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DominantLanguageDetectionJobProperties": { + "shape": "S2i" + } + } + } + }, + "DescribeEntitiesDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "EntitiesDetectionJobProperties": { + "shape": "S2l" + } + } + } + }, + "DescribeEntityRecognizer": { + "input": { + "type": "structure", + "required": [ + "EntityRecognizerArn" + ], + "members": { + "EntityRecognizerArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "EntityRecognizerProperties": { + "shape": "S2o" + } + } + } + }, + "DescribeKeyPhrasesDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "KeyPhrasesDetectionJobProperties": { + "shape": "S2v" + } + } + } + }, + "DescribeSentimentDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SentimentDetectionJobProperties": { + "shape": "S2y" + } + } + } + }, + "DescribeTopicsDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "TopicsDetectionJobProperties": { + "shape": "S31" + } + } + } + }, + "DetectDominantLanguage": { + "input": { + "type": "structure", + "required": [ + "Text" + ], + "members": { + "Text": {} + } + }, + "output": { + "type": "structure", + "members": { + "Languages": { + "shape": "S8" + } + } + } + }, + "DetectEntities": { + "input": { + "type": "structure", + "required": [ + "Text", + "LanguageCode" + ], + "members": { + "Text": {}, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "members": { + "Entities": { + "shape": "Si" + } + } + } + }, + "DetectKeyPhrases": { + "input": { + "type": "structure", + "required": [ + "Text", + "LanguageCode" + ], + "members": { + "Text": {}, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "members": { + "KeyPhrases": { + "shape": "Sp" + } + } + } + }, + "DetectSentiment": { + "input": { + "type": "structure", + "required": [ + "Text", + "LanguageCode" + ], + "members": { + "Text": {}, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "members": { + "Sentiment": {}, + "SentimentScore": { + "shape": "Sw" + } + } + } + }, + "DetectSyntax": { + "input": { + "type": "structure", + "required": [ + "Text", + "LanguageCode" + ], + "members": { + "Text": {}, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "members": { + "SyntaxTokens": { + "shape": "S12" + } + } + } + }, + "ListDocumentClassificationJobs": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "JobName": {}, + "JobStatus": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DocumentClassificationJobPropertiesList": { + "type": "list", + "member": { + "shape": "S21" + } + }, + "NextToken": {} + } + } + }, + "ListDocumentClassifiers": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "Status": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DocumentClassifierPropertiesList": { + "type": "list", + "member": { + "shape": "S2b" + } + }, + "NextToken": {} + } + } + }, + "ListDominantLanguageDetectionJobs": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "JobName": {}, + "JobStatus": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DominantLanguageDetectionJobPropertiesList": { + "type": "list", + "member": { + "shape": "S2i" + } + }, + "NextToken": {} + } + } + }, + "ListEntitiesDetectionJobs": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "JobName": {}, + "JobStatus": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "EntitiesDetectionJobPropertiesList": { + "type": "list", + "member": { + "shape": "S2l" + } + }, + "NextToken": {} + } + } + }, + "ListEntityRecognizers": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "Status": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "EntityRecognizerPropertiesList": { + "type": "list", + "member": { + "shape": "S2o" + } + }, + "NextToken": {} + } + } + }, + "ListKeyPhrasesDetectionJobs": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "JobName": {}, + "JobStatus": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyPhrasesDetectionJobPropertiesList": { + "type": "list", + "member": { + "shape": "S2v" + } + }, + "NextToken": {} + } + } + }, + "ListSentimentDetectionJobs": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "JobName": {}, + "JobStatus": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SentimentDetectionJobPropertiesList": { + "type": "list", + "member": { + "shape": "S2y" + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S19" + } + } + } + }, + "ListTopicsDetectionJobs": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "structure", + "members": { + "JobName": {}, + "JobStatus": {}, + "SubmitTimeBefore": { + "type": "timestamp" + }, + "SubmitTimeAfter": { + "type": "timestamp" + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TopicsDetectionJobPropertiesList": { + "type": "list", + "member": { + "shape": "S31" + } + }, + "NextToken": {} + } + } + }, + "StartDocumentClassificationJob": { + "input": { + "type": "structure", + "required": [ + "DocumentClassifierArn", + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn" + ], + "members": { + "JobName": {}, + "DocumentClassifierArn": {}, + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StartDominantLanguageDetectionJob": { + "input": { + "type": "structure", + "required": [ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn" + ], + "members": { + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "JobName": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StartEntitiesDetectionJob": { + "input": { + "type": "structure", + "required": [ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members": { + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "JobName": {}, + "EntityRecognizerArn": {}, + "LanguageCode": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StartKeyPhrasesDetectionJob": { + "input": { + "type": "structure", + "required": [ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members": { + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "JobName": {}, + "LanguageCode": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StartSentimentDetectionJob": { + "input": { + "type": "structure", + "required": [ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members": { + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "JobName": {}, + "LanguageCode": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StartTopicsDetectionJob": { + "input": { + "type": "structure", + "required": [ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn" + ], + "members": { + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "JobName": {}, + "NumberOfTopics": { + "type": "integer" + }, + "ClientRequestToken": { + "idempotencyToken": true + }, + "VolumeKmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StopDominantLanguageDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StopEntitiesDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StopKeyPhrasesDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StopSentimentDetectionJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "JobStatus": {} + } + } + }, + "StopTrainingDocumentClassifier": { + "input": { + "type": "structure", + "required": [ + "DocumentClassifierArn" + ], + "members": { + "DocumentClassifierArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopTrainingEntityRecognizer": { + "input": { + "type": "structure", + "required": [ + "EntityRecognizerArn" + ], + "members": { + "EntityRecognizerArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S19" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "S8": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LanguageCode": {}, + "Score": { + "type": "float" + } + } + } + }, + "Sb": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Index": { + "type": "integer" + }, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "Si": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Score": { + "type": "float" + }, + "Type": {}, + "Text": {}, + "BeginOffset": { + "type": "integer" + }, + "EndOffset": { + "type": "integer" + } + } + } + }, + "Sp": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Score": { + "type": "float" + }, + "Text": {}, + "BeginOffset": { + "type": "integer" + }, + "EndOffset": { + "type": "integer" + } + } + } + }, + "Sw": { + "type": "structure", + "members": { + "Positive": { + "type": "float" + }, + "Negative": { + "type": "float" + }, + "Neutral": { + "type": "float" + }, + "Mixed": { + "type": "float" + } + } + }, + "S12": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TokenId": { + "type": "integer" + }, + "Text": {}, + "BeginOffset": { + "type": "integer" + }, + "EndOffset": { + "type": "integer" + }, + "PartOfSpeech": { + "type": "structure", + "members": { + "Tag": {}, + "Score": { + "type": "float" + } + } + } + } + } + }, + "S19": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S1d": { + "type": "structure", + "required": [ + "S3Uri" + ], + "members": { + "S3Uri": {} + } + }, + "S1f": { + "type": "structure", + "members": { + "S3Uri": {}, + "KmsKeyId": {} + } + }, + "S1l": { + "type": "structure", + "required": [ + "EntityTypes", + "Documents" + ], + "members": { + "EntityTypes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + } + }, + "Documents": { + "type": "structure", + "required": [ + "S3Uri" + ], + "members": { + "S3Uri": {} + } + }, + "Annotations": { + "type": "structure", + "required": [ + "S3Uri" + ], + "members": { + "S3Uri": {} + } + }, + "EntityList": { + "type": "structure", + "required": [ + "S3Uri" + ], + "members": { + "S3Uri": {} + } + } + } + }, + "S21": { + "type": "structure", + "members": { + "JobId": {}, + "JobName": {}, + "JobStatus": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "DocumentClassifierArn": {}, + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + }, + "S26": { + "type": "structure", + "required": [ + "S3Uri" + ], + "members": { + "S3Uri": {}, + "InputFormat": {} + } + }, + "S28": { + "type": "structure", + "required": [ + "S3Uri" + ], + "members": { + "S3Uri": {}, + "KmsKeyId": {} + } + }, + "S2b": { + "type": "structure", + "members": { + "DocumentClassifierArn": {}, + "LanguageCode": {}, + "Status": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "TrainingStartTime": { + "type": "timestamp" + }, + "TrainingEndTime": { + "type": "timestamp" + }, + "InputDataConfig": { + "shape": "S1d" + }, + "OutputDataConfig": { + "shape": "S1f" + }, + "ClassifierMetadata": { + "type": "structure", + "members": { + "NumberOfLabels": { + "type": "integer" + }, + "NumberOfTrainedDocuments": { + "type": "integer" + }, + "NumberOfTestDocuments": { + "type": "integer" + }, + "EvaluationMetrics": { + "type": "structure", + "members": { + "Accuracy": { + "type": "double" + }, + "Precision": { + "type": "double" + }, + "Recall": { + "type": "double" + }, + "F1Score": { + "type": "double" + } + } + } + } + }, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + }, + "S2i": { + "type": "structure", + "members": { + "JobId": {}, + "JobName": {}, + "JobStatus": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + }, + "S2l": { + "type": "structure", + "members": { + "JobId": {}, + "JobName": {}, + "JobStatus": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "EntityRecognizerArn": {}, + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "LanguageCode": {}, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + }, + "S2o": { + "type": "structure", + "members": { + "EntityRecognizerArn": {}, + "LanguageCode": {}, + "Status": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "TrainingStartTime": { + "type": "timestamp" + }, + "TrainingEndTime": { + "type": "timestamp" + }, + "InputDataConfig": { + "shape": "S1l" + }, + "RecognizerMetadata": { + "type": "structure", + "members": { + "NumberOfTrainedDocuments": { + "type": "integer" + }, + "NumberOfTestDocuments": { + "type": "integer" + }, + "EvaluationMetrics": { + "type": "structure", + "members": { + "Precision": { + "type": "double" + }, + "Recall": { + "type": "double" + }, + "F1Score": { + "type": "double" + } + } + }, + "EntityTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {} + } + } + } + } + }, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + }, + "S2v": { + "type": "structure", + "members": { + "JobId": {}, + "JobName": {}, + "JobStatus": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "LanguageCode": {}, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + }, + "S2y": { + "type": "structure", + "members": { + "JobId": {}, + "JobName": {}, + "JobStatus": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "LanguageCode": {}, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + }, + "S31": { + "type": "structure", + "members": { + "JobId": {}, + "JobName": {}, + "JobStatus": {}, + "Message": {}, + "SubmitTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "InputDataConfig": { + "shape": "S26" + }, + "OutputDataConfig": { + "shape": "S28" + }, + "NumberOfTopics": { + "type": "integer" + }, + "DataAccessRoleArn": {}, + "VolumeKmsKeyId": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/comprehend-2017-11-27.paginators.json b/node_modules/aws-sdk/apis/comprehend-2017-11-27.paginators.json new file mode 100644 index 0000000..04005c5 --- /dev/null +++ b/node_modules/aws-sdk/apis/comprehend-2017-11-27.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "ListDominantLanguageDetectionJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListEntitiesDetectionJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListKeyPhrasesDetectionJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSentimentDetectionJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTopicsDetectionJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.examples.json b/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.min.json b/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.min.json new file mode 100644 index 0000000..0391a95 --- /dev/null +++ b/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.min.json @@ -0,0 +1,147 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-10-30", + "endpointPrefix": "comprehendmedical", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "ComprehendMedical", + "serviceFullName": "AWS Comprehend Medical", + "serviceId": "ComprehendMedical", + "signatureVersion": "v4", + "signingName": "comprehendmedical", + "targetPrefix": "ComprehendMedical_20181030", + "uid": "comprehendmedical-2018-10-30" + }, + "operations": { + "DetectEntities": { + "input": { + "type": "structure", + "required": [ + "Text" + ], + "members": { + "Text": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Entities" + ], + "members": { + "Entities": { + "shape": "S4" + }, + "UnmappedAttributes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Attribute": { + "shape": "Sf" + } + } + } + }, + "PaginationToken": {} + } + } + }, + "DetectPHI": { + "input": { + "type": "structure", + "required": [ + "Text" + ], + "members": { + "Text": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Entities" + ], + "members": { + "Entities": { + "shape": "S4" + }, + "PaginationToken": {} + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": { + "type": "integer" + }, + "BeginOffset": { + "type": "integer" + }, + "EndOffset": { + "type": "integer" + }, + "Score": { + "type": "float" + }, + "Text": {}, + "Category": {}, + "Type": {}, + "Traits": { + "shape": "Sb" + }, + "Attributes": { + "type": "list", + "member": { + "shape": "Sf" + } + } + } + } + }, + "Sb": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Score": { + "type": "float" + } + } + } + }, + "Sf": { + "type": "structure", + "members": { + "Type": {}, + "Score": { + "type": "float" + }, + "RelationshipScore": { + "type": "float" + }, + "Id": { + "type": "integer" + }, + "BeginOffset": { + "type": "integer" + }, + "EndOffset": { + "type": "integer" + }, + "Text": {}, + "Traits": { + "shape": "Sb" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.paginators.json b/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/comprehendmedical-2018-10-30.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/config-2014-11-12.examples.json b/node_modules/aws-sdk/apis/config-2014-11-12.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/config-2014-11-12.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/config-2014-11-12.min.json b/node_modules/aws-sdk/apis/config-2014-11-12.min.json new file mode 100644 index 0000000..a4dc76e --- /dev/null +++ b/node_modules/aws-sdk/apis/config-2014-11-12.min.json @@ -0,0 +1,1940 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-11-12", + "endpointPrefix": "config", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Config Service", + "serviceFullName": "AWS Config", + "serviceId": "Config Service", + "signatureVersion": "v4", + "targetPrefix": "StarlingDoveService", + "uid": "config-2014-11-12" + }, + "operations": { + "BatchGetAggregateResourceConfig": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName", + "ResourceIdentifiers" + ], + "members": { + "ConfigurationAggregatorName": {}, + "ResourceIdentifiers": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "BaseConfigurationItems": { + "shape": "Sb" + }, + "UnprocessedResourceIdentifiers": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + } + }, + "BatchGetResourceConfig": { + "input": { + "type": "structure", + "required": [ + "resourceKeys" + ], + "members": { + "resourceKeys": { + "shape": "Sq" + } + } + }, + "output": { + "type": "structure", + "members": { + "baseConfigurationItems": { + "shape": "Sb" + }, + "unprocessedResourceKeys": { + "shape": "Sq" + } + } + } + }, + "DeleteAggregationAuthorization": { + "input": { + "type": "structure", + "required": [ + "AuthorizedAccountId", + "AuthorizedAwsRegion" + ], + "members": { + "AuthorizedAccountId": {}, + "AuthorizedAwsRegion": {} + } + } + }, + "DeleteConfigRule": { + "input": { + "type": "structure", + "required": [ + "ConfigRuleName" + ], + "members": { + "ConfigRuleName": {} + } + } + }, + "DeleteConfigurationAggregator": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName" + ], + "members": { + "ConfigurationAggregatorName": {} + } + } + }, + "DeleteConfigurationRecorder": { + "input": { + "type": "structure", + "required": [ + "ConfigurationRecorderName" + ], + "members": { + "ConfigurationRecorderName": {} + } + } + }, + "DeleteDeliveryChannel": { + "input": { + "type": "structure", + "required": [ + "DeliveryChannelName" + ], + "members": { + "DeliveryChannelName": {} + } + } + }, + "DeleteEvaluationResults": { + "input": { + "type": "structure", + "required": [ + "ConfigRuleName" + ], + "members": { + "ConfigRuleName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePendingAggregationRequest": { + "input": { + "type": "structure", + "required": [ + "RequesterAccountId", + "RequesterAwsRegion" + ], + "members": { + "RequesterAccountId": {}, + "RequesterAwsRegion": {} + } + } + }, + "DeleteRemediationConfiguration": { + "input": { + "type": "structure", + "required": [ + "ConfigRuleName" + ], + "members": { + "ConfigRuleName": {}, + "ResourceType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRetentionConfiguration": { + "input": { + "type": "structure", + "required": [ + "RetentionConfigurationName" + ], + "members": { + "RetentionConfigurationName": {} + } + } + }, + "DeliverConfigSnapshot": { + "input": { + "type": "structure", + "required": [ + "deliveryChannelName" + ], + "members": { + "deliveryChannelName": {} + } + }, + "output": { + "type": "structure", + "members": { + "configSnapshotId": {} + } + } + }, + "DescribeAggregateComplianceByConfigRules": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName" + ], + "members": { + "ConfigurationAggregatorName": {}, + "Filters": { + "type": "structure", + "members": { + "ConfigRuleName": {}, + "ComplianceType": {}, + "AccountId": {}, + "AwsRegion": {} + } + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AggregateComplianceByConfigRules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ConfigRuleName": {}, + "Compliance": { + "shape": "S1k" + }, + "AccountId": {}, + "AwsRegion": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAggregationAuthorizations": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AggregationAuthorizations": { + "type": "list", + "member": { + "shape": "S1s" + } + }, + "NextToken": {} + } + } + }, + "DescribeComplianceByConfigRule": { + "input": { + "type": "structure", + "members": { + "ConfigRuleNames": { + "shape": "S1v" + }, + "ComplianceTypes": { + "shape": "S1w" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ComplianceByConfigRules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ConfigRuleName": {}, + "Compliance": { + "shape": "S1k" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeComplianceByResource": { + "input": { + "type": "structure", + "members": { + "ResourceType": {}, + "ResourceId": {}, + "ComplianceTypes": { + "shape": "S1w" + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ComplianceByResources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceType": {}, + "ResourceId": {}, + "Compliance": { + "shape": "S1k" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeConfigRuleEvaluationStatus": { + "input": { + "type": "structure", + "members": { + "ConfigRuleNames": { + "shape": "S1v" + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigRulesEvaluationStatus": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ConfigRuleName": {}, + "ConfigRuleArn": {}, + "ConfigRuleId": {}, + "LastSuccessfulInvocationTime": { + "type": "timestamp" + }, + "LastFailedInvocationTime": { + "type": "timestamp" + }, + "LastSuccessfulEvaluationTime": { + "type": "timestamp" + }, + "LastFailedEvaluationTime": { + "type": "timestamp" + }, + "FirstActivatedTime": { + "type": "timestamp" + }, + "LastErrorCode": {}, + "LastErrorMessage": {}, + "FirstEvaluationStarted": { + "type": "boolean" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeConfigRules": { + "input": { + "type": "structure", + "members": { + "ConfigRuleNames": { + "shape": "S1v" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConfigRules": { + "type": "list", + "member": { + "shape": "S2e" + } + }, + "NextToken": {} + } + } + }, + "DescribeConfigurationAggregatorSourcesStatus": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName" + ], + "members": { + "ConfigurationAggregatorName": {}, + "UpdateStatus": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AggregatedSourceStatusList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceId": {}, + "SourceType": {}, + "AwsRegion": {}, + "LastUpdateStatus": {}, + "LastUpdateTime": { + "type": "timestamp" + }, + "LastErrorCode": {}, + "LastErrorMessage": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeConfigurationAggregators": { + "input": { + "type": "structure", + "members": { + "ConfigurationAggregatorNames": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationAggregators": { + "type": "list", + "member": { + "shape": "S33" + } + }, + "NextToken": {} + } + } + }, + "DescribeConfigurationRecorderStatus": { + "input": { + "type": "structure", + "members": { + "ConfigurationRecorderNames": { + "shape": "S3b" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationRecordersStatus": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "lastStartTime": { + "type": "timestamp" + }, + "lastStopTime": { + "type": "timestamp" + }, + "recording": { + "type": "boolean" + }, + "lastStatus": {}, + "lastErrorCode": {}, + "lastErrorMessage": {}, + "lastStatusChangeTime": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeConfigurationRecorders": { + "input": { + "type": "structure", + "members": { + "ConfigurationRecorderNames": { + "shape": "S3b" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationRecorders": { + "type": "list", + "member": { + "shape": "S3j" + } + } + } + } + }, + "DescribeDeliveryChannelStatus": { + "input": { + "type": "structure", + "members": { + "DeliveryChannelNames": { + "shape": "S3p" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeliveryChannelsStatus": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "configSnapshotDeliveryInfo": { + "shape": "S3t" + }, + "configHistoryDeliveryInfo": { + "shape": "S3t" + }, + "configStreamDeliveryInfo": { + "type": "structure", + "members": { + "lastStatus": {}, + "lastErrorCode": {}, + "lastErrorMessage": {}, + "lastStatusChangeTime": { + "type": "timestamp" + } + } + } + } + } + } + } + } + }, + "DescribeDeliveryChannels": { + "input": { + "type": "structure", + "members": { + "DeliveryChannelNames": { + "shape": "S3p" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeliveryChannels": { + "type": "list", + "member": { + "shape": "S3z" + } + } + } + } + }, + "DescribePendingAggregationRequests": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "PendingAggregationRequests": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RequesterAccountId": {}, + "RequesterAwsRegion": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeRemediationConfigurations": { + "input": { + "type": "structure", + "required": [ + "ConfigRuleNames" + ], + "members": { + "ConfigRuleNames": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "members": { + "RemediationConfigurations": { + "shape": "S48" + } + } + } + }, + "DescribeRemediationExecutionStatus": { + "input": { + "type": "structure", + "required": [ + "ConfigRuleName" + ], + "members": { + "ConfigRuleName": {}, + "ResourceKeys": { + "shape": "Sq" + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RemediationExecutionStatuses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceKey": { + "shape": "Sr" + }, + "State": {}, + "StepDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "State": {}, + "ErrorMessage": {}, + "StartTime": { + "type": "timestamp" + }, + "StopTime": { + "type": "timestamp" + } + } + } + }, + "InvocationTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeRetentionConfigurations": { + "input": { + "type": "structure", + "members": { + "RetentionConfigurationNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RetentionConfigurations": { + "type": "list", + "member": { + "shape": "S4t" + } + }, + "NextToken": {} + } + } + }, + "GetAggregateComplianceDetailsByConfigRule": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName", + "ConfigRuleName", + "AccountId", + "AwsRegion" + ], + "members": { + "ConfigurationAggregatorName": {}, + "ConfigRuleName": {}, + "AccountId": {}, + "AwsRegion": {}, + "ComplianceType": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AggregateEvaluationResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EvaluationResultIdentifier": { + "shape": "S4z" + }, + "ComplianceType": {}, + "ResultRecordedTime": { + "type": "timestamp" + }, + "ConfigRuleInvokedTime": { + "type": "timestamp" + }, + "Annotation": {}, + "AccountId": {}, + "AwsRegion": {} + } + } + }, + "NextToken": {} + } + } + }, + "GetAggregateConfigRuleComplianceSummary": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName" + ], + "members": { + "ConfigurationAggregatorName": {}, + "Filters": { + "type": "structure", + "members": { + "AccountId": {}, + "AwsRegion": {} + } + }, + "GroupByKey": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "GroupByKey": {}, + "AggregateComplianceCounts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GroupName": {}, + "ComplianceSummary": { + "shape": "S57" + } + } + } + }, + "NextToken": {} + } + } + }, + "GetAggregateDiscoveredResourceCounts": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName" + ], + "members": { + "ConfigurationAggregatorName": {}, + "Filters": { + "type": "structure", + "members": { + "ResourceType": {}, + "AccountId": {}, + "Region": {} + } + }, + "GroupByKey": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TotalDiscoveredResources" + ], + "members": { + "TotalDiscoveredResources": { + "type": "long" + }, + "GroupByKey": {}, + "GroupedResourceCounts": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "GroupName", + "ResourceCount" + ], + "members": { + "GroupName": {}, + "ResourceCount": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + } + }, + "GetAggregateResourceConfig": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName", + "ResourceIdentifier" + ], + "members": { + "ConfigurationAggregatorName": {}, + "ResourceIdentifier": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationItem": { + "shape": "S5h" + } + } + } + }, + "GetComplianceDetailsByConfigRule": { + "input": { + "type": "structure", + "required": [ + "ConfigRuleName" + ], + "members": { + "ConfigRuleName": {}, + "ComplianceTypes": { + "shape": "S1w" + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "EvaluationResults": { + "shape": "S5t" + }, + "NextToken": {} + } + } + }, + "GetComplianceDetailsByResource": { + "input": { + "type": "structure", + "required": [ + "ResourceType", + "ResourceId" + ], + "members": { + "ResourceType": {}, + "ResourceId": {}, + "ComplianceTypes": { + "shape": "S1w" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "EvaluationResults": { + "shape": "S5t" + }, + "NextToken": {} + } + } + }, + "GetComplianceSummaryByConfigRule": { + "output": { + "type": "structure", + "members": { + "ComplianceSummary": { + "shape": "S57" + } + } + } + }, + "GetComplianceSummaryByResourceType": { + "input": { + "type": "structure", + "members": { + "ResourceTypes": { + "shape": "S5z" + } + } + }, + "output": { + "type": "structure", + "members": { + "ComplianceSummariesByResourceType": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceType": {}, + "ComplianceSummary": { + "shape": "S57" + } + } + } + } + } + } + }, + "GetDiscoveredResourceCounts": { + "input": { + "type": "structure", + "members": { + "resourceTypes": { + "shape": "S5z" + }, + "limit": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "totalDiscoveredResources": { + "type": "long" + }, + "resourceCounts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resourceType": {}, + "count": { + "type": "long" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetResourceConfigHistory": { + "input": { + "type": "structure", + "required": [ + "resourceType", + "resourceId" + ], + "members": { + "resourceType": {}, + "resourceId": {}, + "laterTime": { + "type": "timestamp" + }, + "earlierTime": { + "type": "timestamp" + }, + "chronologicalOrder": {}, + "limit": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "configurationItems": { + "type": "list", + "member": { + "shape": "S5h" + } + }, + "nextToken": {} + } + } + }, + "ListAggregateDiscoveredResources": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName", + "ResourceType" + ], + "members": { + "ConfigurationAggregatorName": {}, + "ResourceType": {}, + "Filters": { + "type": "structure", + "members": { + "AccountId": {}, + "ResourceId": {}, + "ResourceName": {}, + "Region": {} + } + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceIdentifiers": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "NextToken": {} + } + } + }, + "ListDiscoveredResources": { + "input": { + "type": "structure", + "required": [ + "resourceType" + ], + "members": { + "resourceType": {}, + "resourceIds": { + "type": "list", + "member": {} + }, + "resourceName": {}, + "limit": { + "type": "integer" + }, + "includeDeletedResources": { + "type": "boolean" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceIdentifiers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resourceType": {}, + "resourceId": {}, + "resourceName": {}, + "resourceDeletionTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S6q" + }, + "NextToken": {} + } + } + }, + "PutAggregationAuthorization": { + "input": { + "type": "structure", + "required": [ + "AuthorizedAccountId", + "AuthorizedAwsRegion" + ], + "members": { + "AuthorizedAccountId": {}, + "AuthorizedAwsRegion": {}, + "Tags": { + "shape": "S6v" + } + } + }, + "output": { + "type": "structure", + "members": { + "AggregationAuthorization": { + "shape": "S1s" + } + } + } + }, + "PutConfigRule": { + "input": { + "type": "structure", + "required": [ + "ConfigRule" + ], + "members": { + "ConfigRule": { + "shape": "S2e" + }, + "Tags": { + "shape": "S6v" + } + } + } + }, + "PutConfigurationAggregator": { + "input": { + "type": "structure", + "required": [ + "ConfigurationAggregatorName" + ], + "members": { + "ConfigurationAggregatorName": {}, + "AccountAggregationSources": { + "shape": "S35" + }, + "OrganizationAggregationSource": { + "shape": "S39" + }, + "Tags": { + "shape": "S6v" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationAggregator": { + "shape": "S33" + } + } + } + }, + "PutConfigurationRecorder": { + "input": { + "type": "structure", + "required": [ + "ConfigurationRecorder" + ], + "members": { + "ConfigurationRecorder": { + "shape": "S3j" + } + } + } + }, + "PutDeliveryChannel": { + "input": { + "type": "structure", + "required": [ + "DeliveryChannel" + ], + "members": { + "DeliveryChannel": { + "shape": "S3z" + } + } + } + }, + "PutEvaluations": { + "input": { + "type": "structure", + "required": [ + "ResultToken" + ], + "members": { + "Evaluations": { + "shape": "S73" + }, + "ResultToken": {}, + "TestMode": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedEvaluations": { + "shape": "S73" + } + } + } + }, + "PutRemediationConfigurations": { + "input": { + "type": "structure", + "required": [ + "RemediationConfigurations" + ], + "members": { + "RemediationConfigurations": { + "shape": "S48" + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedBatches": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FailureMessage": {}, + "FailedItems": { + "shape": "S48" + } + } + } + } + } + } + }, + "PutRetentionConfiguration": { + "input": { + "type": "structure", + "required": [ + "RetentionPeriodInDays" + ], + "members": { + "RetentionPeriodInDays": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "RetentionConfiguration": { + "shape": "S4t" + } + } + } + }, + "SelectResourceConfig": { + "input": { + "type": "structure", + "required": [ + "Expression" + ], + "members": { + "Expression": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": {} + }, + "QueryInfo": { + "type": "structure", + "members": { + "SelectFields": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "StartConfigRulesEvaluation": { + "input": { + "type": "structure", + "members": { + "ConfigRuleNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartConfigurationRecorder": { + "input": { + "type": "structure", + "required": [ + "ConfigurationRecorderName" + ], + "members": { + "ConfigurationRecorderName": {} + } + } + }, + "StartRemediationExecution": { + "input": { + "type": "structure", + "required": [ + "ConfigRuleName", + "ResourceKeys" + ], + "members": { + "ConfigRuleName": {}, + "ResourceKeys": { + "shape": "Sq" + } + } + }, + "output": { + "type": "structure", + "members": { + "FailureMessage": {}, + "FailedItems": { + "shape": "Sq" + } + } + } + }, + "StopConfigurationRecorder": { + "input": { + "type": "structure", + "required": [ + "ConfigurationRecorderName" + ], + "members": { + "ConfigurationRecorderName": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S6q" + } + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "SourceAccountId", + "SourceRegion", + "ResourceId", + "ResourceType" + ], + "members": { + "SourceAccountId": {}, + "SourceRegion": {}, + "ResourceId": {}, + "ResourceType": {}, + "ResourceName": {} + } + }, + "Sb": { + "type": "list", + "member": { + "type": "structure", + "members": { + "version": {}, + "accountId": {}, + "configurationItemCaptureTime": { + "type": "timestamp" + }, + "configurationItemStatus": {}, + "configurationStateId": {}, + "arn": {}, + "resourceType": {}, + "resourceId": {}, + "resourceName": {}, + "awsRegion": {}, + "availabilityZone": {}, + "resourceCreationTime": { + "type": "timestamp" + }, + "configuration": {}, + "supplementaryConfiguration": { + "shape": "Sl" + } + } + } + }, + "Sl": { + "type": "map", + "key": {}, + "value": {} + }, + "Sq": { + "type": "list", + "member": { + "shape": "Sr" + } + }, + "Sr": { + "type": "structure", + "required": [ + "resourceType", + "resourceId" + ], + "members": { + "resourceType": {}, + "resourceId": {} + } + }, + "S1k": { + "type": "structure", + "members": { + "ComplianceType": {}, + "ComplianceContributorCount": { + "shape": "S1l" + } + } + }, + "S1l": { + "type": "structure", + "members": { + "CappedCount": { + "type": "integer" + }, + "CapExceeded": { + "type": "boolean" + } + } + }, + "S1s": { + "type": "structure", + "members": { + "AggregationAuthorizationArn": {}, + "AuthorizedAccountId": {}, + "AuthorizedAwsRegion": {}, + "CreationTime": { + "type": "timestamp" + } + } + }, + "S1v": { + "type": "list", + "member": {} + }, + "S1w": { + "type": "list", + "member": {} + }, + "S2e": { + "type": "structure", + "required": [ + "Source" + ], + "members": { + "ConfigRuleName": {}, + "ConfigRuleArn": {}, + "ConfigRuleId": {}, + "Description": {}, + "Scope": { + "type": "structure", + "members": { + "ComplianceResourceTypes": { + "type": "list", + "member": {} + }, + "TagKey": {}, + "TagValue": {}, + "ComplianceResourceId": {} + } + }, + "Source": { + "type": "structure", + "required": [ + "Owner", + "SourceIdentifier" + ], + "members": { + "Owner": {}, + "SourceIdentifier": {}, + "SourceDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventSource": {}, + "MessageType": {}, + "MaximumExecutionFrequency": {} + } + } + } + } + }, + "InputParameters": {}, + "MaximumExecutionFrequency": {}, + "ConfigRuleState": {}, + "CreatedBy": {} + } + }, + "S33": { + "type": "structure", + "members": { + "ConfigurationAggregatorName": {}, + "ConfigurationAggregatorArn": {}, + "AccountAggregationSources": { + "shape": "S35" + }, + "OrganizationAggregationSource": { + "shape": "S39" + }, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + } + } + }, + "S35": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AccountIds" + ], + "members": { + "AccountIds": { + "type": "list", + "member": {} + }, + "AllAwsRegions": { + "type": "boolean" + }, + "AwsRegions": { + "shape": "S38" + } + } + } + }, + "S38": { + "type": "list", + "member": {} + }, + "S39": { + "type": "structure", + "required": [ + "RoleArn" + ], + "members": { + "RoleArn": {}, + "AwsRegions": { + "shape": "S38" + }, + "AllAwsRegions": { + "type": "boolean" + } + } + }, + "S3b": { + "type": "list", + "member": {} + }, + "S3j": { + "type": "structure", + "members": { + "name": {}, + "roleARN": {}, + "recordingGroup": { + "type": "structure", + "members": { + "allSupported": { + "type": "boolean" + }, + "includeGlobalResourceTypes": { + "type": "boolean" + }, + "resourceTypes": { + "type": "list", + "member": {} + } + } + } + } + }, + "S3p": { + "type": "list", + "member": {} + }, + "S3t": { + "type": "structure", + "members": { + "lastStatus": {}, + "lastErrorCode": {}, + "lastErrorMessage": {}, + "lastAttemptTime": { + "type": "timestamp" + }, + "lastSuccessfulTime": { + "type": "timestamp" + }, + "nextDeliveryTime": { + "type": "timestamp" + } + } + }, + "S3z": { + "type": "structure", + "members": { + "name": {}, + "s3BucketName": {}, + "s3KeyPrefix": {}, + "snsTopicARN": {}, + "configSnapshotDeliveryProperties": { + "type": "structure", + "members": { + "deliveryFrequency": {} + } + } + } + }, + "S48": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ConfigRuleName", + "TargetType", + "TargetId" + ], + "members": { + "ConfigRuleName": {}, + "TargetType": {}, + "TargetId": {}, + "TargetVersion": {}, + "Parameters": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "ResourceValue": { + "type": "structure", + "members": { + "Value": {} + } + }, + "StaticValue": { + "type": "structure", + "members": { + "Values": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "ResourceType": {} + } + } + }, + "S4t": { + "type": "structure", + "required": [ + "Name", + "RetentionPeriodInDays" + ], + "members": { + "Name": {}, + "RetentionPeriodInDays": { + "type": "integer" + } + } + }, + "S4z": { + "type": "structure", + "members": { + "EvaluationResultQualifier": { + "type": "structure", + "members": { + "ConfigRuleName": {}, + "ResourceType": {}, + "ResourceId": {} + } + }, + "OrderingTimestamp": { + "type": "timestamp" + } + } + }, + "S57": { + "type": "structure", + "members": { + "CompliantResourceCount": { + "shape": "S1l" + }, + "NonCompliantResourceCount": { + "shape": "S1l" + }, + "ComplianceSummaryTimestamp": { + "type": "timestamp" + } + } + }, + "S5h": { + "type": "structure", + "members": { + "version": {}, + "accountId": {}, + "configurationItemCaptureTime": { + "type": "timestamp" + }, + "configurationItemStatus": {}, + "configurationStateId": {}, + "configurationItemMD5Hash": {}, + "arn": {}, + "resourceType": {}, + "resourceId": {}, + "resourceName": {}, + "awsRegion": {}, + "availabilityZone": {}, + "resourceCreationTime": { + "type": "timestamp" + }, + "tags": { + "type": "map", + "key": {}, + "value": {} + }, + "relatedEvents": { + "type": "list", + "member": {} + }, + "relationships": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resourceType": {}, + "resourceId": {}, + "resourceName": {}, + "relationshipName": {} + } + } + }, + "configuration": {}, + "supplementaryConfiguration": { + "shape": "Sl" + } + } + }, + "S5t": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EvaluationResultIdentifier": { + "shape": "S4z" + }, + "ComplianceType": {}, + "ResultRecordedTime": { + "type": "timestamp" + }, + "ConfigRuleInvokedTime": { + "type": "timestamp" + }, + "Annotation": {}, + "ResultToken": {} + } + } + }, + "S5z": { + "type": "list", + "member": {} + }, + "S6q": { + "type": "list", + "member": { + "shape": "S6r" + } + }, + "S6r": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + }, + "S6v": { + "type": "list", + "member": { + "shape": "S6r" + } + }, + "S73": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ComplianceResourceType", + "ComplianceResourceId", + "ComplianceType", + "OrderingTimestamp" + ], + "members": { + "ComplianceResourceType": {}, + "ComplianceResourceId": {}, + "ComplianceType": {}, + "Annotation": {}, + "OrderingTimestamp": { + "type": "timestamp" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/config-2014-11-12.paginators.json b/node_modules/aws-sdk/apis/config-2014-11-12.paginators.json new file mode 100644 index 0000000..6119d09 --- /dev/null +++ b/node_modules/aws-sdk/apis/config-2014-11-12.paginators.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "DescribeRemediationExecutionStatus": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "RemediationExecutionStatuses" + }, + "GetResourceConfigHistory": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "configurationItems" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/connect-2017-08-08.examples.json b/node_modules/aws-sdk/apis/connect-2017-08-08.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/connect-2017-08-08.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/connect-2017-08-08.min.json b/node_modules/aws-sdk/apis/connect-2017-08-08.min.json new file mode 100644 index 0000000..a146fcf --- /dev/null +++ b/node_modules/aws-sdk/apis/connect-2017-08-08.min.json @@ -0,0 +1,927 @@ +{ + "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": { + "CreateUser": { + "http": { + "method": "PUT", + "requestUri": "/users/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "Username", + "PhoneConfig", + "SecurityProfileIds", + "RoutingProfileId", + "InstanceId" + ], + "members": { + "Username": {}, + "Password": {}, + "IdentityInfo": { + "shape": "S4" + }, + "PhoneConfig": { + "shape": "S8" + }, + "DirectoryUserId": {}, + "SecurityProfileIds": { + "shape": "Se" + }, + "RoutingProfileId": {}, + "HierarchyGroupId": {}, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserId": {}, + "UserArn": {} + } + } + }, + "DeleteUser": { + "http": { + "method": "DELETE", + "requestUri": "/users/{InstanceId}/{UserId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId", + "UserId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "UserId": { + "location": "uri", + "locationName": "UserId" + } + } + } + }, + "DescribeUser": { + "http": { + "method": "GET", + "requestUri": "/users/{InstanceId}/{UserId}" + }, + "input": { + "type": "structure", + "required": [ + "UserId", + "InstanceId" + ], + "members": { + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Username": {}, + "IdentityInfo": { + "shape": "S4" + }, + "PhoneConfig": { + "shape": "S8" + }, + "DirectoryUserId": {}, + "SecurityProfileIds": { + "shape": "Se" + }, + "RoutingProfileId": {}, + "HierarchyGroupId": {} + } + } + } + } + }, + "DescribeUserHierarchyGroup": { + "http": { + "method": "GET", + "requestUri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}" + }, + "input": { + "type": "structure", + "required": [ + "HierarchyGroupId", + "InstanceId" + ], + "members": { + "HierarchyGroupId": { + "location": "uri", + "locationName": "HierarchyGroupId" + }, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "HierarchyGroup": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "LevelId": {}, + "HierarchyPath": { + "type": "structure", + "members": { + "LevelOne": { + "shape": "Sw" + }, + "LevelTwo": { + "shape": "Sw" + }, + "LevelThree": { + "shape": "Sw" + }, + "LevelFour": { + "shape": "Sw" + }, + "LevelFive": { + "shape": "Sw" + } + } + } + } + } + } + } + }, + "DescribeUserHierarchyStructure": { + "http": { + "method": "GET", + "requestUri": "/user-hierarchy-structure/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "HierarchyStructure": { + "type": "structure", + "members": { + "LevelOne": { + "shape": "S10" + }, + "LevelTwo": { + "shape": "S10" + }, + "LevelThree": { + "shape": "S10" + }, + "LevelFour": { + "shape": "S10" + }, + "LevelFive": { + "shape": "S10" + } + } + } + } + } + }, + "GetContactAttributes": { + "http": { + "method": "GET", + "requestUri": "/contact/attributes/{InstanceId}/{InitialContactId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId", + "InitialContactId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "InitialContactId": { + "location": "uri", + "locationName": "InitialContactId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "S15" + } + } + } + }, + "GetCurrentMetricData": { + "http": { + "requestUri": "/metrics/current/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId", + "Filters", + "CurrentMetrics" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "Filters": { + "shape": "S19" + }, + "Groupings": { + "shape": "S1e" + }, + "CurrentMetrics": { + "type": "list", + "member": { + "shape": "S1h" + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "MetricResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "S1p" + }, + "Collections": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Metric": { + "shape": "S1h" + }, + "Value": { + "type": "double" + } + } + } + } + } + } + }, + "DataSnapshotTime": { + "type": "timestamp" + } + } + } + }, + "GetFederationToken": { + "http": { + "method": "GET", + "requestUri": "/user/federate/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Credentials": { + "type": "structure", + "members": { + "AccessToken": { + "shape": "S1y" + }, + "AccessTokenExpiration": { + "type": "timestamp" + }, + "RefreshToken": { + "shape": "S1y" + }, + "RefreshTokenExpiration": { + "type": "timestamp" + } + } + } + } + } + }, + "GetMetricData": { + "http": { + "requestUri": "/metrics/historical/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId", + "StartTime", + "EndTime", + "Filters", + "HistoricalMetrics" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Filters": { + "shape": "S19" + }, + "Groupings": { + "shape": "S1e" + }, + "HistoricalMetrics": { + "type": "list", + "member": { + "shape": "S21" + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "MetricResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "S1p" + }, + "Collections": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Metric": { + "shape": "S21" + }, + "Value": { + "type": "double" + } + } + } + } + } + } + } + } + } + }, + "ListRoutingProfiles": { + "http": { + "method": "GET", + "requestUri": "/routing-profiles-summary/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "RoutingProfileSummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListSecurityProfiles": { + "http": { + "method": "GET", + "requestUri": "/security-profiles-summary/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SecurityProfileSummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListUserHierarchyGroups": { + "http": { + "method": "GET", + "requestUri": "/user-hierarchy-groups-summary/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserHierarchyGroupSummaryList": { + "type": "list", + "member": { + "shape": "Sw" + } + }, + "NextToken": {} + } + } + }, + "ListUsers": { + "http": { + "method": "GET", + "requestUri": "/users-summary/{InstanceId}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserSummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Username": {} + } + } + }, + "NextToken": {} + } + } + }, + "StartOutboundVoiceContact": { + "http": { + "method": "PUT", + "requestUri": "/contact/outbound-voice" + }, + "input": { + "type": "structure", + "required": [ + "DestinationPhoneNumber", + "ContactFlowId", + "InstanceId" + ], + "members": { + "DestinationPhoneNumber": {}, + "ContactFlowId": {}, + "InstanceId": {}, + "ClientToken": { + "idempotencyToken": true + }, + "SourcePhoneNumber": {}, + "QueueId": {}, + "Attributes": { + "shape": "S15" + } + } + }, + "output": { + "type": "structure", + "members": { + "ContactId": {} + } + } + }, + "StopContact": { + "http": { + "requestUri": "/contact/stop" + }, + "input": { + "type": "structure", + "required": [ + "ContactId", + "InstanceId" + ], + "members": { + "ContactId": {}, + "InstanceId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateContactAttributes": { + "http": { + "requestUri": "/contact/attributes" + }, + "input": { + "type": "structure", + "required": [ + "InitialContactId", + "InstanceId", + "Attributes" + ], + "members": { + "InitialContactId": {}, + "InstanceId": {}, + "Attributes": { + "shape": "S15" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateUserHierarchy": { + "http": { + "requestUri": "/users/{InstanceId}/{UserId}/hierarchy" + }, + "input": { + "type": "structure", + "required": [ + "UserId", + "InstanceId" + ], + "members": { + "HierarchyGroupId": {}, + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + } + }, + "UpdateUserIdentityInfo": { + "http": { + "requestUri": "/users/{InstanceId}/{UserId}/identity-info" + }, + "input": { + "type": "structure", + "required": [ + "IdentityInfo", + "UserId", + "InstanceId" + ], + "members": { + "IdentityInfo": { + "shape": "S4" + }, + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + } + }, + "UpdateUserPhoneConfig": { + "http": { + "requestUri": "/users/{InstanceId}/{UserId}/phone-config" + }, + "input": { + "type": "structure", + "required": [ + "PhoneConfig", + "UserId", + "InstanceId" + ], + "members": { + "PhoneConfig": { + "shape": "S8" + }, + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + } + }, + "UpdateUserRoutingProfile": { + "http": { + "requestUri": "/users/{InstanceId}/{UserId}/routing-profile" + }, + "input": { + "type": "structure", + "required": [ + "RoutingProfileId", + "UserId", + "InstanceId" + ], + "members": { + "RoutingProfileId": {}, + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + } + }, + "UpdateUserSecurityProfiles": { + "http": { + "requestUri": "/users/{InstanceId}/{UserId}/security-profiles" + }, + "input": { + "type": "structure", + "required": [ + "SecurityProfileIds", + "UserId", + "InstanceId" + ], + "members": { + "SecurityProfileIds": { + "shape": "Se" + }, + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "InstanceId": { + "location": "uri", + "locationName": "InstanceId" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "FirstName": {}, + "LastName": {}, + "Email": {} + } + }, + "S8": { + "type": "structure", + "required": [ + "PhoneType" + ], + "members": { + "PhoneType": {}, + "AutoAccept": { + "type": "boolean" + }, + "AfterContactWorkTimeLimit": { + "type": "integer" + }, + "DeskPhoneNumber": {} + } + }, + "Se": { + "type": "list", + "member": {} + }, + "Sw": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {} + } + }, + "S10": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {} + } + }, + "S15": { + "type": "map", + "key": {}, + "value": {} + }, + "S19": { + "type": "structure", + "members": { + "Queues": { + "type": "list", + "member": {} + }, + "Channels": { + "type": "list", + "member": {} + } + } + }, + "S1e": { + "type": "list", + "member": {} + }, + "S1h": { + "type": "structure", + "members": { + "Name": {}, + "Unit": {} + } + }, + "S1p": { + "type": "structure", + "members": { + "Queue": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {} + } + }, + "Channel": {} + } + }, + "S1y": { + "type": "string", + "sensitive": true + }, + "S21": { + "type": "structure", + "members": { + "Name": {}, + "Threshold": { + "type": "structure", + "members": { + "Comparison": {}, + "ThresholdValue": { + "type": "double" + } + } + }, + "Statistic": {}, + "Unit": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json b/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json new file mode 100644 index 0000000..443b131 --- /dev/null +++ b/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "GetCurrentMetricData": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetMetricData": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/cur-2017-01-06.examples.json b/node_modules/aws-sdk/apis/cur-2017-01-06.examples.json new file mode 100644 index 0000000..d647e38 --- /dev/null +++ b/node_modules/aws-sdk/apis/cur-2017-01-06.examples.json @@ -0,0 +1,102 @@ +{ + "version": "1.0", + "examples": { + "DeleteReportDefinition": [ + { + "input": { + "ReportName": "ExampleReport" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes the AWS Cost and Usage report named ExampleReport.", + "id": "to-delete-a-report", + "title": "To delete the AWS Cost and Usage report named ExampleReport." + } + ], + "DescribeReportDefinitions": [ + { + "input": { + "MaxResults": 5 + }, + "output": { + "ReportDefinitions": [ + { + "AdditionalArtifacts": [ + "QUICKSIGHT" + ], + "AdditionalSchemaElements": [ + "RESOURCES" + ], + "Compression": "GZIP", + "Format": "textORcsv", + "ReportName": "ExampleReport", + "S3Bucket": "example-s3-bucket", + "S3Prefix": "exampleprefix", + "S3Region": "us-east-1", + "TimeUnit": "HOURLY" + }, + { + "AdditionalArtifacts": [ + "QUICKSIGHT" + ], + "AdditionalSchemaElements": [ + "RESOURCES" + ], + "Compression": "GZIP", + "Format": "textORcsv", + "ReportName": "ExampleReport2", + "S3Bucket": "example-s3-bucket", + "S3Prefix": "exampleprefix", + "S3Region": "us-east-1", + "TimeUnit": "HOURLY" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists the AWS Cost and Usage reports for the account.", + "id": "to-retrieve-report-definitions", + "title": "To list the AWS Cost and Usage reports for the account." + } + ], + "PutReportDefinition": [ + { + "input": { + "ReportDefinition": { + "AdditionalArtifacts": [ + "REDSHIFT", + "QUICKSIGHT" + ], + "AdditionalSchemaElements": [ + "RESOURCES" + ], + "Compression": "ZIP", + "Format": "textORcsv", + "ReportName": "ExampleReport", + "S3Bucket": "example-s3-bucket", + "S3Prefix": "exampleprefix", + "S3Region": "us-east-1", + "TimeUnit": "DAILY" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a AWS Cost and Usage report named ExampleReport.", + "id": "to-create-a-report-definitions", + "title": "To create a report named ExampleReport." + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/cur-2017-01-06.min.json b/node_modules/aws-sdk/apis/cur-2017-01-06.min.json new file mode 100644 index 0000000..8ac5628 --- /dev/null +++ b/node_modules/aws-sdk/apis/cur-2017-01-06.min.json @@ -0,0 +1,107 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-01-06", + "endpointPrefix": "cur", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Cost and Usage Report Service", + "serviceId": "Cost and Usage Report Service", + "signatureVersion": "v4", + "signingName": "cur", + "targetPrefix": "AWSOrigamiServiceGatewayService", + "uid": "cur-2017-01-06" + }, + "operations": { + "DeleteReportDefinition": { + "input": { + "type": "structure", + "members": { + "ReportName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResponseMessage": {} + } + } + }, + "DescribeReportDefinitions": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReportDefinitions": { + "type": "list", + "member": { + "shape": "Sa" + } + }, + "NextToken": {} + } + } + }, + "PutReportDefinition": { + "input": { + "type": "structure", + "required": [ + "ReportDefinition" + ], + "members": { + "ReportDefinition": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sa": { + "type": "structure", + "required": [ + "ReportName", + "TimeUnit", + "Format", + "Compression", + "AdditionalSchemaElements", + "S3Bucket", + "S3Prefix", + "S3Region" + ], + "members": { + "ReportName": {}, + "TimeUnit": {}, + "Format": {}, + "Compression": {}, + "AdditionalSchemaElements": { + "type": "list", + "member": {} + }, + "S3Bucket": {}, + "S3Prefix": {}, + "S3Region": {}, + "AdditionalArtifacts": { + "type": "list", + "member": {} + }, + "RefreshClosedReports": { + "type": "boolean" + }, + "ReportVersioning": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/cur-2017-01-06.paginators.json b/node_modules/aws-sdk/apis/cur-2017-01-06.paginators.json new file mode 100644 index 0000000..78c6eed --- /dev/null +++ b/node_modules/aws-sdk/apis/cur-2017-01-06.paginators.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "DescribeReportDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/datapipeline-2012-10-29.min.json b/node_modules/aws-sdk/apis/datapipeline-2012-10-29.min.json new file mode 100644 index 0000000..6bd65a2 --- /dev/null +++ b/node_modules/aws-sdk/apis/datapipeline-2012-10-29.min.json @@ -0,0 +1,668 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-10-29", + "endpointPrefix": "datapipeline", + "jsonVersion": "1.1", + "serviceFullName": "AWS Data Pipeline", + "serviceId": "Data Pipeline", + "signatureVersion": "v4", + "targetPrefix": "DataPipeline", + "protocol": "json", + "uid": "datapipeline-2012-10-29" + }, + "operations": { + "ActivatePipeline": { + "input": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {}, + "parameterValues": { + "shape": "S3" + }, + "startTimestamp": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AddTags": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "tags" + ], + "members": { + "pipelineId": {}, + "tags": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreatePipeline": { + "input": { + "type": "structure", + "required": [ + "name", + "uniqueId" + ], + "members": { + "name": {}, + "uniqueId": {}, + "description": {}, + "tags": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {} + } + } + }, + "DeactivatePipeline": { + "input": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {}, + "cancelActive": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePipeline": { + "input": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {} + } + } + }, + "DescribeObjects": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "objectIds" + ], + "members": { + "pipelineId": {}, + "objectIds": { + "shape": "Sn" + }, + "evaluateExpressions": { + "type": "boolean" + }, + "marker": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineObjects" + ], + "members": { + "pipelineObjects": { + "shape": "Sq" + }, + "marker": {}, + "hasMoreResults": { + "type": "boolean" + } + } + } + }, + "DescribePipelines": { + "input": { + "type": "structure", + "required": [ + "pipelineIds" + ], + "members": { + "pipelineIds": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineDescriptionList" + ], + "members": { + "pipelineDescriptionList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "pipelineId", + "name", + "fields" + ], + "members": { + "pipelineId": {}, + "name": {}, + "fields": { + "shape": "Ss" + }, + "description": {}, + "tags": { + "shape": "Sa" + } + } + } + } + } + } + }, + "EvaluateExpression": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "objectId", + "expression" + ], + "members": { + "pipelineId": {}, + "objectId": {}, + "expression": {} + } + }, + "output": { + "type": "structure", + "required": [ + "evaluatedExpression" + ], + "members": { + "evaluatedExpression": {} + } + } + }, + "GetPipelineDefinition": { + "input": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {}, + "version": {} + } + }, + "output": { + "type": "structure", + "members": { + "pipelineObjects": { + "shape": "Sq" + }, + "parameterObjects": { + "shape": "S13" + }, + "parameterValues": { + "shape": "S3" + } + } + } + }, + "ListPipelines": { + "input": { + "type": "structure", + "members": { + "marker": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineIdList" + ], + "members": { + "pipelineIdList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "name": {} + } + } + }, + "marker": {}, + "hasMoreResults": { + "type": "boolean" + } + } + } + }, + "PollForTask": { + "input": { + "type": "structure", + "required": [ + "workerGroup" + ], + "members": { + "workerGroup": {}, + "hostname": {}, + "instanceIdentity": { + "type": "structure", + "members": { + "document": {}, + "signature": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "taskObject": { + "type": "structure", + "members": { + "taskId": {}, + "pipelineId": {}, + "attemptId": {}, + "objects": { + "type": "map", + "key": {}, + "value": { + "shape": "Sr" + } + } + } + } + } + } + }, + "PutPipelineDefinition": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "pipelineObjects" + ], + "members": { + "pipelineId": {}, + "pipelineObjects": { + "shape": "Sq" + }, + "parameterObjects": { + "shape": "S13" + }, + "parameterValues": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "errored" + ], + "members": { + "validationErrors": { + "shape": "S1l" + }, + "validationWarnings": { + "shape": "S1p" + }, + "errored": { + "type": "boolean" + } + } + } + }, + "QueryObjects": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "sphere" + ], + "members": { + "pipelineId": {}, + "query": { + "type": "structure", + "members": { + "selectors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "fieldName": {}, + "operator": { + "type": "structure", + "members": { + "type": {}, + "values": { + "shape": "S1x" + } + } + } + } + } + } + } + }, + "sphere": {}, + "marker": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ids": { + "shape": "Sn" + }, + "marker": {}, + "hasMoreResults": { + "type": "boolean" + } + } + } + }, + "RemoveTags": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "tagKeys" + ], + "members": { + "pipelineId": {}, + "tagKeys": { + "shape": "S1x" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ReportTaskProgress": { + "input": { + "type": "structure", + "required": [ + "taskId" + ], + "members": { + "taskId": {}, + "fields": { + "shape": "Ss" + } + } + }, + "output": { + "type": "structure", + "required": [ + "canceled" + ], + "members": { + "canceled": { + "type": "boolean" + } + } + } + }, + "ReportTaskRunnerHeartbeat": { + "input": { + "type": "structure", + "required": [ + "taskrunnerId" + ], + "members": { + "taskrunnerId": {}, + "workerGroup": {}, + "hostname": {} + } + }, + "output": { + "type": "structure", + "required": [ + "terminate" + ], + "members": { + "terminate": { + "type": "boolean" + } + } + } + }, + "SetStatus": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "objectIds", + "status" + ], + "members": { + "pipelineId": {}, + "objectIds": { + "shape": "Sn" + }, + "status": {} + } + } + }, + "SetTaskStatus": { + "input": { + "type": "structure", + "required": [ + "taskId", + "taskStatus" + ], + "members": { + "taskId": {}, + "taskStatus": {}, + "errorId": {}, + "errorMessage": {}, + "errorStackTrace": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ValidatePipelineDefinition": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "pipelineObjects" + ], + "members": { + "pipelineId": {}, + "pipelineObjects": { + "shape": "Sq" + }, + "parameterObjects": { + "shape": "S13" + }, + "parameterValues": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "errored" + ], + "members": { + "validationErrors": { + "shape": "S1l" + }, + "validationWarnings": { + "shape": "S1p" + }, + "errored": { + "type": "boolean" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "id", + "stringValue" + ], + "members": { + "id": {}, + "stringValue": {} + } + } + }, + "Sa": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "Sn": { + "type": "list", + "member": {} + }, + "Sq": { + "type": "list", + "member": { + "shape": "Sr" + } + }, + "Sr": { + "type": "structure", + "required": [ + "id", + "name", + "fields" + ], + "members": { + "id": {}, + "name": {}, + "fields": { + "shape": "Ss" + } + } + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": {}, + "stringValue": {}, + "refValue": {} + } + } + }, + "S13": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "id", + "attributes" + ], + "members": { + "id": {}, + "attributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "stringValue" + ], + "members": { + "key": {}, + "stringValue": {} + } + } + } + } + } + }, + "S1l": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "errors": { + "shape": "S1n" + } + } + } + }, + "S1n": { + "type": "list", + "member": {} + }, + "S1p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "warnings": { + "shape": "S1n" + } + } + } + }, + "S1x": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/datapipeline-2012-10-29.paginators.json b/node_modules/aws-sdk/apis/datapipeline-2012-10-29.paginators.json new file mode 100644 index 0000000..db94193 --- /dev/null +++ b/node_modules/aws-sdk/apis/datapipeline-2012-10-29.paginators.json @@ -0,0 +1,26 @@ +{ + "pagination": { + "ListPipelines": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "result_key": "pipelineIdList" + }, + "DescribeObjects": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "result_key": "pipelineObjects" + }, + "DescribePipelines": { + "result_key": "pipelineDescriptionList" + }, + "QueryObjects": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "limit_key": "limit", + "result_key": "ids" + } + } +} diff --git a/node_modules/aws-sdk/apis/datasync-2018-11-09.examples.json b/node_modules/aws-sdk/apis/datasync-2018-11-09.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/datasync-2018-11-09.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json b/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json new file mode 100644 index 0000000..1dec08a --- /dev/null +++ b/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json @@ -0,0 +1,682 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-11-09", + "endpointPrefix": "datasync", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "DataSync", + "serviceFullName": "AWS DataSync", + "serviceId": "DataSync", + "signatureVersion": "v4", + "signingName": "datasync", + "targetPrefix": "FmrsService", + "uid": "datasync-2018-11-09" + }, + "operations": { + "CancelTaskExecution": { + "input": { + "type": "structure", + "required": [ + "TaskExecutionArn" + ], + "members": { + "TaskExecutionArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateAgent": { + "input": { + "type": "structure", + "required": [ + "ActivationKey" + ], + "members": { + "ActivationKey": {}, + "AgentName": {}, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "AgentArn": {} + } + } + }, + "CreateLocationEfs": { + "input": { + "type": "structure", + "required": [ + "Subdirectory", + "EfsFilesystemArn", + "Ec2Config" + ], + "members": { + "Subdirectory": {}, + "EfsFilesystemArn": {}, + "Ec2Config": { + "shape": "Sf" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocationArn": {} + } + } + }, + "CreateLocationNfs": { + "input": { + "type": "structure", + "required": [ + "Subdirectory", + "ServerHostname", + "OnPremConfig" + ], + "members": { + "Subdirectory": {}, + "ServerHostname": {}, + "OnPremConfig": { + "shape": "Sn" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocationArn": {} + } + } + }, + "CreateLocationS3": { + "input": { + "type": "structure", + "required": [ + "Subdirectory", + "S3BucketArn", + "S3Config" + ], + "members": { + "Subdirectory": {}, + "S3BucketArn": {}, + "S3Config": { + "shape": "Ss" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocationArn": {} + } + } + }, + "CreateTask": { + "input": { + "type": "structure", + "required": [ + "SourceLocationArn", + "DestinationLocationArn" + ], + "members": { + "SourceLocationArn": {}, + "DestinationLocationArn": {}, + "CloudWatchLogGroupArn": {}, + "Name": {}, + "Options": { + "shape": "Sx" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "TaskArn": {} + } + } + }, + "DeleteAgent": { + "input": { + "type": "structure", + "required": [ + "AgentArn" + ], + "members": { + "AgentArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteLocation": { + "input": { + "type": "structure", + "required": [ + "LocationArn" + ], + "members": { + "LocationArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTask": { + "input": { + "type": "structure", + "required": [ + "TaskArn" + ], + "members": { + "TaskArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeAgent": { + "input": { + "type": "structure", + "required": [ + "AgentArn" + ], + "members": { + "AgentArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "AgentArn": {}, + "Name": {}, + "Status": {}, + "LastConnectionTime": { + "type": "timestamp" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "DescribeLocationEfs": { + "input": { + "type": "structure", + "required": [ + "LocationArn" + ], + "members": { + "LocationArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "LocationArn": {}, + "LocationUri": {}, + "Ec2Config": { + "shape": "Sf" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "DescribeLocationNfs": { + "input": { + "type": "structure", + "required": [ + "LocationArn" + ], + "members": { + "LocationArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "LocationArn": {}, + "LocationUri": {}, + "OnPremConfig": { + "shape": "Sn" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "DescribeLocationS3": { + "input": { + "type": "structure", + "required": [ + "LocationArn" + ], + "members": { + "LocationArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "LocationArn": {}, + "LocationUri": {}, + "S3Config": { + "shape": "Ss" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "DescribeTask": { + "input": { + "type": "structure", + "required": [ + "TaskArn" + ], + "members": { + "TaskArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "TaskArn": {}, + "Status": {}, + "Name": {}, + "CurrentTaskExecutionArn": {}, + "SourceLocationArn": {}, + "DestinationLocationArn": {}, + "CloudWatchLogGroupArn": {}, + "Options": { + "shape": "Sx" + }, + "ErrorCode": {}, + "ErrorDetail": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "DescribeTaskExecution": { + "input": { + "type": "structure", + "required": [ + "TaskExecutionArn" + ], + "members": { + "TaskExecutionArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "TaskExecutionArn": {}, + "Status": {}, + "Options": { + "shape": "Sx" + }, + "StartTime": { + "type": "timestamp" + }, + "EstimatedFilesToTransfer": { + "type": "long" + }, + "EstimatedBytesToTransfer": { + "type": "long" + }, + "FilesTransferred": { + "type": "long" + }, + "BytesWritten": { + "type": "long" + }, + "BytesTransferred": { + "type": "long" + }, + "Result": { + "type": "structure", + "members": { + "PrepareDuration": { + "type": "long" + }, + "PrepareStatus": {}, + "TransferDuration": { + "type": "long" + }, + "TransferStatus": {}, + "VerifyDuration": { + "type": "long" + }, + "VerifyStatus": {}, + "ErrorCode": {}, + "ErrorDetail": {} + } + } + } + } + }, + "ListAgents": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Agents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AgentArn": {}, + "Name": {}, + "Status": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListLocations": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Locations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LocationArn": {}, + "LocationUri": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S7" + }, + "NextToken": {} + } + } + }, + "ListTaskExecutions": { + "input": { + "type": "structure", + "members": { + "TaskArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "TaskExecutions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TaskExecutionArn": {}, + "Status": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTasks": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tasks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TaskArn": {}, + "Status": {}, + "Name": {} + } + } + }, + "NextToken": {} + } + } + }, + "StartTaskExecution": { + "input": { + "type": "structure", + "required": [ + "TaskArn" + ], + "members": { + "TaskArn": {}, + "OverrideOptions": { + "shape": "Sx" + } + } + }, + "output": { + "type": "structure", + "members": { + "TaskExecutionArn": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Keys" + ], + "members": { + "ResourceArn": {}, + "Keys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateAgent": { + "input": { + "type": "structure", + "required": [ + "AgentArn" + ], + "members": { + "AgentArn": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateTask": { + "input": { + "type": "structure", + "required": [ + "TaskArn" + ], + "members": { + "TaskArn": {}, + "Options": { + "shape": "Sx" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S7": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sf": { + "type": "structure", + "required": [ + "SubnetArn", + "SecurityGroupArns" + ], + "members": { + "SubnetArn": {}, + "SecurityGroupArns": { + "type": "list", + "member": {} + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "AgentArns" + ], + "members": { + "AgentArns": { + "type": "list", + "member": {} + } + } + }, + "Ss": { + "type": "structure", + "required": [ + "BucketAccessRoleArn" + ], + "members": { + "BucketAccessRoleArn": {} + } + }, + "Sx": { + "type": "structure", + "members": { + "VerifyMode": {}, + "Atime": {}, + "Mtime": {}, + "Uid": {}, + "Gid": {}, + "PreserveDeletedFiles": {}, + "PreserveDevices": {}, + "PosixPermissions": {}, + "BytesPerSecond": { + "type": "long" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/datasync-2018-11-09.paginators.json b/node_modules/aws-sdk/apis/datasync-2018-11-09.paginators.json new file mode 100644 index 0000000..47fbeb7 --- /dev/null +++ b/node_modules/aws-sdk/apis/datasync-2018-11-09.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "ListAgents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListLocations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTaskExecutions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTasks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/dax-2017-04-19.examples.json b/node_modules/aws-sdk/apis/dax-2017-04-19.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/dax-2017-04-19.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/dax-2017-04-19.min.json b/node_modules/aws-sdk/apis/dax-2017-04-19.min.json new file mode 100644 index 0000000..5a8a745 --- /dev/null +++ b/node_modules/aws-sdk/apis/dax-2017-04-19.min.json @@ -0,0 +1,723 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-04-19", + "endpointPrefix": "dax", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Amazon DAX", + "serviceFullName": "Amazon DynamoDB Accelerator (DAX)", + "serviceId": "DAX", + "signatureVersion": "v4", + "targetPrefix": "AmazonDAXV3", + "uid": "dax-2017-04-19" + }, + "operations": { + "CreateCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterName", + "NodeType", + "ReplicationFactor", + "IamRoleArn" + ], + "members": { + "ClusterName": {}, + "NodeType": {}, + "Description": {}, + "ReplicationFactor": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "S4" + }, + "SubnetGroupName": {}, + "SecurityGroupIds": { + "shape": "S5" + }, + "PreferredMaintenanceWindow": {}, + "NotificationTopicArn": {}, + "IamRoleArn": {}, + "ParameterGroupName": {}, + "Tags": { + "shape": "S6" + }, + "SSESpecification": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sb" + } + } + } + }, + "CreateParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "ParameterGroup": { + "shape": "Sq" + } + } + } + }, + "CreateSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "SubnetGroupName", + "SubnetIds" + ], + "members": { + "SubnetGroupName": {}, + "Description": {}, + "SubnetIds": { + "shape": "Ss" + } + } + }, + "output": { + "type": "structure", + "members": { + "SubnetGroup": { + "shape": "Su" + } + } + } + }, + "DecreaseReplicationFactor": { + "input": { + "type": "structure", + "required": [ + "ClusterName", + "NewReplicationFactor" + ], + "members": { + "ClusterName": {}, + "NewReplicationFactor": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "S4" + }, + "NodeIdsToRemove": { + "shape": "Se" + } + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sb" + } + } + } + }, + "DeleteCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterName" + ], + "members": { + "ClusterName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sb" + } + } + } + }, + "DeleteParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DeletionMessage": {} + } + } + }, + "DeleteSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "SubnetGroupName" + ], + "members": { + "SubnetGroupName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DeletionMessage": {} + } + } + }, + "DescribeClusters": { + "input": { + "type": "structure", + "members": { + "ClusterNames": { + "type": "list", + "member": {} + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Clusters": { + "type": "list", + "member": { + "shape": "Sb" + } + } + } + } + }, + "DescribeDefaultParameters": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Parameters": { + "shape": "S1b" + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceName": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceName": {}, + "SourceType": {}, + "Message": {}, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeParameterGroups": { + "input": { + "type": "structure", + "members": { + "ParameterGroupNames": { + "type": "list", + "member": {} + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "ParameterGroups": { + "type": "list", + "member": { + "shape": "Sq" + } + } + } + } + }, + "DescribeParameters": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {}, + "Source": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Parameters": { + "shape": "S1b" + } + } + } + }, + "DescribeSubnetGroups": { + "input": { + "type": "structure", + "members": { + "SubnetGroupNames": { + "type": "list", + "member": {} + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "SubnetGroups": { + "type": "list", + "member": { + "shape": "Su" + } + } + } + } + }, + "IncreaseReplicationFactor": { + "input": { + "type": "structure", + "required": [ + "ClusterName", + "NewReplicationFactor" + ], + "members": { + "ClusterName": {}, + "NewReplicationFactor": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sb" + } + } + } + }, + "ListTags": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {}, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S6" + }, + "NextToken": {} + } + } + }, + "RebootNode": { + "input": { + "type": "structure", + "required": [ + "ClusterName", + "NodeId" + ], + "members": { + "ClusterName": {}, + "NodeId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sb" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S6" + } + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S6" + } + } + } + }, + "UpdateCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterName" + ], + "members": { + "ClusterName": {}, + "Description": {}, + "PreferredMaintenanceWindow": {}, + "NotificationTopicArn": {}, + "NotificationTopicStatus": {}, + "ParameterGroupName": {}, + "SecurityGroupIds": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Sb" + } + } + } + }, + "UpdateParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName", + "ParameterNameValues" + ], + "members": { + "ParameterGroupName": {}, + "ParameterNameValues": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ParameterGroup": { + "shape": "Sq" + } + } + } + }, + "UpdateSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "SubnetGroupName" + ], + "members": { + "SubnetGroupName": {}, + "Description": {}, + "SubnetIds": { + "shape": "Ss" + } + } + }, + "output": { + "type": "structure", + "members": { + "SubnetGroup": { + "shape": "Su" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": {} + }, + "S5": { + "type": "list", + "member": {} + }, + "S6": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sb": { + "type": "structure", + "members": { + "ClusterName": {}, + "Description": {}, + "ClusterArn": {}, + "TotalNodes": { + "type": "integer" + }, + "ActiveNodes": { + "type": "integer" + }, + "NodeType": {}, + "Status": {}, + "ClusterDiscoveryEndpoint": { + "shape": "Sd" + }, + "NodeIdsToRemove": { + "shape": "Se" + }, + "Nodes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "NodeId": {}, + "Endpoint": { + "shape": "Sd" + }, + "NodeCreateTime": { + "type": "timestamp" + }, + "AvailabilityZone": {}, + "NodeStatus": {}, + "ParameterGroupStatus": {} + } + } + }, + "PreferredMaintenanceWindow": {}, + "NotificationConfiguration": { + "type": "structure", + "members": { + "TopicArn": {}, + "TopicStatus": {} + } + }, + "SubnetGroup": {}, + "SecurityGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SecurityGroupIdentifier": {}, + "Status": {} + } + } + }, + "IamRoleArn": {}, + "ParameterGroup": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "ParameterApplyStatus": {}, + "NodeIdsToReboot": { + "shape": "Se" + } + } + }, + "SSEDescription": { + "type": "structure", + "members": { + "Status": {} + } + } + } + }, + "Sd": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "Se": { + "type": "list", + "member": {} + }, + "Sq": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "Description": {} + } + }, + "Ss": { + "type": "list", + "member": {} + }, + "Su": { + "type": "structure", + "members": { + "SubnetGroupName": {}, + "Description": {}, + "VpcId": {}, + "Subnets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": {} + } + } + } + } + }, + "S1b": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterType": {}, + "ParameterValue": {}, + "NodeTypeSpecificValues": { + "type": "list", + "member": { + "type": "structure", + "members": { + "NodeType": {}, + "Value": {} + } + } + }, + "Description": {}, + "Source": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": {}, + "ChangeType": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/dax-2017-04-19.paginators.json b/node_modules/aws-sdk/apis/dax-2017-04-19.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/dax-2017-04-19.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/devicefarm-2015-06-23.examples.json b/node_modules/aws-sdk/apis/devicefarm-2015-06-23.examples.json new file mode 100644 index 0000000..4bfa22b --- /dev/null +++ b/node_modules/aws-sdk/apis/devicefarm-2015-06-23.examples.json @@ -0,0 +1,1242 @@ +{ + "version": "1.0", + "examples": { + "CreateDevicePool": [ + { + "input": { + "name": "MyDevicePool", + "description": "My Android devices", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "rules": [ + + ] + }, + "output": { + "devicePool": { + } + }, + "comments": { + "input": { + "name": "A device pool contains related devices, such as devices that run only on Android or that run only on iOS.", + "projectArn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example creates a new device pool named MyDevicePool inside an existing project.", + "id": "createdevicepool-example-1470862210860", + "title": "To create a new device pool" + } + ], + "CreateProject": [ + { + "input": { + "name": "MyProject" + }, + "output": { + "project": { + "name": "MyProject", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", + "created": "1472660939.152" + } + }, + "comments": { + "input": { + "name": "A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices." + }, + "output": { + } + }, + "description": "The following example creates a new project named MyProject.", + "id": "createproject-example-1470862210860", + "title": "To create a new project" + } + ], + "CreateRemoteAccessSession": [ + { + "input": { + "name": "MySession", + "configuration": { + "billingMethod": "METERED" + }, + "deviceArn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "remoteAccessSession": { + } + }, + "comments": { + "input": { + "deviceArn": "You can get the device ARN by using the list-devices CLI command.", + "projectArn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example creates a remote access session named MySession.", + "id": "to-create-a-remote-access-session-1470970668274", + "title": "To create a remote access session" + } + ], + "CreateUpload": [ + { + "input": { + "name": "MyAppiumPythonUpload", + "type": "APPIUM_PYTHON_TEST_PACKAGE", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "upload": { + "name": "MyAppiumPythonUpload", + "type": "APPIUM_PYTHON_TEST_PACKAGE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE", + "created": "1472661404.186", + "status": "INITIALIZED", + "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE" + } + }, + "comments": { + "input": { + "projectArn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example creates a new Appium Python test package upload inside an existing project.", + "id": "createupload-example-1470864711775", + "title": "To create a new test package upload" + } + ], + "DeleteDevicePool": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the device pool ARN by using the list-device-pools CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific device pool.", + "id": "deletedevicepool-example-1470866975494", + "title": "To delete a device pool" + } + ], + "DeleteProject": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific project.", + "id": "deleteproject-example-1470867374212", + "title": "To delete a project" + } + ], + "DeleteRemoteAccessSession": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific remote access session.", + "id": "to-delete-a-specific-remote-access-session-1470971431677", + "title": "To delete a specific remote access session" + } + ], + "DeleteRun": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the run ARN by using the list-runs CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific test run.", + "id": "deleterun-example-1470867905129", + "title": "To delete a run" + } + ], + "DeleteUpload": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the upload ARN by using the list-uploads CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific upload.", + "id": "deleteupload-example-1470868363942", + "title": "To delete a specific upload" + } + ], + "GetAccountSettings": [ + { + "input": { + }, + "output": { + "accountSettings": { + "awsAccountNumber": "123456789101", + "unmeteredDevices": { + "ANDROID": 1, + "IOS": 2 + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns information about your Device Farm account settings.", + "id": "to-get-information-about-account-settings-1472567568189", + "title": "To get information about account settings" + } + ], + "GetDevice": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE" + }, + "output": { + "device": { + "name": "LG G2 (Sprint)", + "arn": "arn:aws:devicefarm:us-west-2::device:A0E6E6E1059E45918208DF75B2B7EF6C", + "cpu": { + "architecture": "armeabi-v7a", + "clock": 2265.6, + "frequency": "MHz" + }, + "formFactor": "PHONE", + "heapSize": 256000000, + "image": "75B2B7EF6C12345EXAMPLE", + "manufacturer": "LG", + "memory": 16000000000, + "model": "G2 (Sprint)", + "os": "4.2.2", + "platform": "ANDROID", + "resolution": { + "height": 1920, + "width": 1080 + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns information about a specific device.", + "id": "getdevice-example-1470870602173", + "title": "To get information about a device" + } + ], + "GetDevicePool": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "devicePool": { + } + }, + "comments": { + "input": { + "arn": "You can obtain the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about a specific device pool, given a project ARN.", + "id": "getdevicepool-example-1470870873136", + "title": "To get information about a device pool" + } + ], + "GetDevicePoolCompatibility": [ + { + "input": { + "appArn": "arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID", + "devicePoolArn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID", + "testType": "APPIUM_PYTHON" + }, + "output": { + "compatibleDevices": [ + + ], + "incompatibleDevices": [ + + ] + }, + "comments": { + "input": { + "devicePoolArn": "You can get the device pool ARN by using the list-device-pools CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about the compatibility of a specific device pool, given its ARN.", + "id": "getdevicepoolcompatibility-example-1470925003466", + "title": "To get information about the compatibility of a device pool" + } + ], + "GetJob": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID" + }, + "output": { + "job": { + } + }, + "comments": { + "input": { + "arn": "You can get the job ARN by using the list-jobs CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about a specific job.", + "id": "getjob-example-1470928294268", + "title": "To get information about a job" + } + ], + "GetOfferingStatus": [ + { + "input": { + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "current": { + "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": { + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + } + }, + "nextPeriod": { + "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": { + "effectiveOn": "1472688000", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + } + } + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about Device Farm offerings available to your account.", + "id": "to-get-status-information-about-device-offerings-1472568124402", + "title": "To get status information about device offerings" + } + ], + "GetProject": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE" + }, + "output": { + "project": { + "name": "My Project", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", + "created": "1472660939.152" + } + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific project.", + "id": "to-get-a-project-1470975038449", + "title": "To get information about a project" + } + ], + "GetRemoteAccessSession": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" + }, + "output": { + "remoteAccessSession": { + } + }, + "comments": { + "input": { + "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." + }, + "output": { + } + }, + "description": "The following example gets a specific remote access session.", + "id": "to-get-a-remote-access-session-1471014119414", + "title": "To get a remote access session" + } + ], + "GetRun": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE" + }, + "output": { + "run": { + "name": "My Test Run", + "type": "BUILTIN_EXPLORER", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", + "billingMethod": "METERED", + "completedJobs": 0, + "counters": { + "errored": 0, + "failed": 0, + "passed": 0, + "skipped": 0, + "stopped": 0, + "total": 0, + "warned": 0 + }, + "created": "1472667509.852", + "deviceMinutes": { + "metered": 0.0, + "total": 0.0, + "unmetered": 0.0 + }, + "platform": "ANDROID", + "result": "PENDING", + "status": "RUNNING", + "totalJobs": 3 + } + }, + "comments": { + "input": { + "arn": "You can get the run ARN by using the list-runs CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific test run.", + "id": "to-get-a-test-run-1471015895657", + "title": "To get information about a test run" + } + ], + "GetSuite": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456" + }, + "output": { + "suite": { + } + }, + "comments": { + "input": { + "arn": "You can get the suite ARN by using the list-suites CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific test suite.", + "id": "to-get-information-about-a-test-suite-1471016525008", + "title": "To get information about a test suite" + } + ], + "GetTest": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456" + }, + "output": { + "test": { + } + }, + "comments": { + "input": { + "arn": "You can get the test ARN by using the list-tests CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific test.", + "id": "to-get-information-about-a-specific-test-1471025744238", + "title": "To get information about a specific test" + } + ], + "GetUpload": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" + }, + "output": { + "upload": { + } + }, + "comments": { + "input": { + "arn": "You can get the test ARN by using the list-uploads CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific upload.", + "id": "to-get-information-about-a-specific-upload-1471025996221", + "title": "To get information about a specific upload" + } + ], + "InstallToRemoteAccessSession": [ + { + "input": { + "appArn": "arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456", + "remoteAccessSessionArn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" + }, + "output": { + "appUpload": { + } + }, + "comments": { + "input": { + "remoteAccessSessionArn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." + }, + "output": { + } + }, + "description": "The following example installs a specific app to a device in a specific remote access session.", + "id": "to-install-to-a-remote-access-session-1471634453818", + "title": "To install to a remote access session" + } + ], + "ListArtifacts": [ + { + "input": { + "type": "SCREENSHOT", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" + }, + "comments": { + "input": { + "arn": "Can also be used to list artifacts for a Job, Suite, or Test ARN." + }, + "output": { + } + }, + "description": "The following example lists screenshot artifacts for a specific run.", + "id": "to-list-artifacts-for-a-resource-1471635409527", + "title": "To list artifacts for a resource" + } + ], + "ListDevicePools": [ + { + "input": { + "type": "PRIVATE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "devicePools": [ + { + "name": "Top Devices", + "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE", + "description": "Top devices", + "rules": [ + { + "value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]", + "attribute": "ARN", + "operator": "IN" + } + ] + }, + { + "name": "My Android Device Pool", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE", + "description": "Samsung Galaxy Android devices", + "rules": [ + { + "value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]", + "attribute": "ARN", + "operator": "IN" + } + ] + } + ] + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about the private device pools in a specific project.", + "id": "to-get-information-about-device-pools-1471635745170", + "title": "To get information about device pools" + } + ], + "ListDevices": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about the available devices in a specific project.", + "id": "to-get-information-about-devices-1471641699344", + "title": "To get information about devices" + } + ], + "ListJobs": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-jobs CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about jobs in a specific project.", + "id": "to-get-information-about-jobs-1471642228071", + "title": "To get information about jobs" + } + ], + "ListOfferingTransactions": [ + { + "input": { + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "offeringTransactions": [ + { + "cost": { + "amount": 0, + "currencyCode": "USD" + }, + "createdOn": "1470021420", + "offeringStatus": { + "type": "RENEW", + "effectiveOn": "1472688000", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 0 + }, + "transactionId": "03728003-d1ea-4851-abd6-12345EXAMPLE" + }, + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "createdOn": "1470021420", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1470021420", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "56820b6e-06bd-473a-8ff8-12345EXAMPLE" + }, + { + "cost": { + "amount": 175, + "currencyCode": "USD" + }, + "createdOn": "1465538520", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1465538520", + "offering": { + "type": "RECURRING", + "description": "Android Unmetered Device Slot", + "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "953ae2c6-d760-4a04-9597-12345EXAMPLE" + }, + { + "cost": { + "amount": 8.07, + "currencyCode": "USD" + }, + "createdOn": "1459344300", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1459344300", + "offering": { + "type": "RECURRING", + "description": "iOS Unmetered Device Slot", + "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE", + "platform": "IOS" + }, + "quantity": 1 + }, + "transactionId": "2baf9021-ae3e-47f5-ab52-12345EXAMPLE" + } + ] + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about Device Farm offering transactions.", + "id": "to-get-information-about-device-offering-transactions-1472561712315", + "title": "To get information about device offering transactions" + } + ], + "ListOfferings": [ + { + "input": { + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "offerings": [ + { + "type": "RECURRING", + "description": "iOS Unmetered Device Slot", + "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE", + "platform": "IOS", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + }, + { + "type": "RECURRING", + "description": "Android Unmetered Device Slot", + "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE", + "platform": "ANDROID", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + }, + { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + }, + { + "type": "RECURRING", + "description": "iOS Remote Access Unmetered Device Slot", + "id": "552B4DAD-A6C9-45C4-94FB-12345EXAMPLE", + "platform": "IOS", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + } + ] + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about available device offerings.", + "id": "to-get-information-about-device-offerings-1472562810999", + "title": "To get information about device offerings" + } + ], + "ListProjects": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "projects": [ + { + "name": "My Test Project", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", + "created": "1453163262.105" + }, + { + "name": "Hello World", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE", + "created": "1470350112.439" + } + ] + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about the specified project in Device Farm.", + "id": "to-get-information-about-a-device-farm-project-1472564014388", + "title": "To get information about a Device Farm project" + } + ], + "ListRemoteAccessSessions": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "remoteAccessSessions": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the session by using the list-sessions CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about a specific Device Farm remote access session.", + "id": "to-get-information-about-a-remote-access-session-1472581144803", + "title": "To get information about a remote access session" + } + ], + "ListRuns": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "runs": [ + { + "name": "My Test Run", + "type": "BUILTIN_EXPLORER", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", + "billingMethod": "METERED", + "completedJobs": 0, + "counters": { + "errored": 0, + "failed": 0, + "passed": 0, + "skipped": 0, + "stopped": 0, + "total": 0, + "warned": 0 + }, + "created": "1472667509.852", + "deviceMinutes": { + "metered": 0.0, + "total": 0.0, + "unmetered": 0.0 + }, + "platform": "ANDROID", + "result": "PENDING", + "status": "RUNNING", + "totalJobs": 3 + } + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the run by using the list-runs CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about a specific test run.", + "id": "to-get-information-about-test-runs-1472582711069", + "title": "To get information about a test run" + } + ], + "ListSamples": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "samples": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about samples, given a specific Device Farm project.", + "id": "to-get-information-about-samples-1472582847534", + "title": "To get information about samples" + } + ], + "ListSuites": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "suites": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about suites, given a specific Device Farm project.", + "id": "to-get-information-about-suites-1472583038218", + "title": "To get information about suites" + } + ], + "ListTests": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "tests": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about tests, given a specific Device Farm project.", + "id": "to-get-information-about-tests-1472617372212", + "title": "To get information about tests" + } + ], + "ListUniqueProblems": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "uniqueProblems": { + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about unique problems, given a specific Device Farm project.", + "id": "to-get-information-about-unique-problems-1472617781008", + "title": "To get information about unique problems" + } + ], + "ListUploads": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "uploads": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about uploads, given a specific Device Farm project.", + "id": "to-get-information-about-uploads-1472617943090", + "title": "To get information about uploads" + } + ], + "PurchaseOffering": [ + { + "input": { + "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "quantity": 1 + }, + "output": { + "offeringTransaction": { + "cost": { + "amount": 8.07, + "currencyCode": "USD" + }, + "createdOn": "1472648340", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1472648340", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "d30614ed-1b03-404c-9893-12345EXAMPLE" + } + }, + "comments": { + "input": { + "offeringId": "You can get the offering ID by using the list-offerings CLI command." + }, + "output": { + } + }, + "description": "The following example purchases a specific device slot offering.", + "id": "to-purchase-a-device-slot-offering-1472648146343", + "title": "To purchase a device slot offering" + } + ], + "RenewOffering": [ + { + "input": { + "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "quantity": 1 + }, + "output": { + "offeringTransaction": { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "createdOn": "1472648880", + "offeringStatus": { + "type": "RENEW", + "effectiveOn": "1472688000", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "e90f1405-8c35-4561-be43-12345EXAMPLE" + } + }, + "comments": { + "input": { + "offeringId": "You can get the offering ID by using the list-offerings CLI command." + }, + "output": { + } + }, + "description": "The following example renews a specific device slot offering.", + "id": "to-renew-a-device-slot-offering-1472648899785", + "title": "To renew a device slot offering" + } + ], + "ScheduleRun": [ + { + "input": { + "name": "MyRun", + "devicePoolArn": "arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "test": { + "type": "APPIUM_JAVA_JUNIT", + "testPackageArn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456" + } + }, + "output": { + "run": { + } + }, + "comments": { + "input": { + "devicePoolArn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.", + "projectArn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "testPackageArn": "You can get the Amazon Resource Name (ARN) of the test package by using the list-tests CLI command." + }, + "output": { + } + }, + "description": "The following example schedules a test run named MyRun.", + "id": "to-schedule-a-test-run-1472652429636", + "title": "To schedule a test run" + } + ], + "StopRun": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" + }, + "output": { + "run": { + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the test run by using the list-runs CLI command." + }, + "output": { + } + }, + "description": "The following example stops a specific test run.", + "id": "to-stop-a-test-run-1472653770340", + "title": "To stop a test run" + } + ], + "UpdateDevicePool": [ + { + "input": { + "name": "NewName", + "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE", + "description": "NewDescription", + "rules": [ + { + "value": "True", + "attribute": "REMOTE_ACCESS_ENABLED", + "operator": "EQUALS" + } + ] + }, + "output": { + "devicePool": { + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command." + }, + "output": { + "devicePool": "Note: you cannot update curated device pools." + } + }, + "description": "The following example updates the specified device pool with a new name and description. It also enables remote access of devices in the device pool.", + "id": "to-update-a-device-pool-1472653887677", + "title": "To update a device pool" + } + ], + "UpdateProject": [ + { + "input": { + "name": "NewName", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE" + }, + "output": { + "project": { + "name": "NewName", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE", + "created": "1448400709.927" + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example updates the specified project with a new name.", + "id": "to-update-a-device-pool-1472653887677", + "title": "To update a device pool" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/devicefarm-2015-06-23.min.json b/node_modules/aws-sdk/apis/devicefarm-2015-06-23.min.json new file mode 100644 index 0000000..7cdbdfc --- /dev/null +++ b/node_modules/aws-sdk/apis/devicefarm-2015-06-23.min.json @@ -0,0 +1,2234 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-06-23", + "endpointPrefix": "devicefarm", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Device Farm", + "serviceId": "Device Farm", + "signatureVersion": "v4", + "targetPrefix": "DeviceFarm_20150623", + "uid": "devicefarm-2015-06-23" + }, + "operations": { + "CreateDevicePool": { + "input": { + "type": "structure", + "required": [ + "projectArn", + "name", + "rules" + ], + "members": { + "projectArn": {}, + "name": {}, + "description": {}, + "rules": { + "shape": "S5" + }, + "maxDevices": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "devicePool": { + "shape": "Sc" + } + } + } + }, + "CreateInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "description": {}, + "packageCleanup": { + "type": "boolean" + }, + "excludeAppPackagesFromCleanup": { + "shape": "Sg" + }, + "rebootAfterUse": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "instanceProfile": { + "shape": "Si" + } + } + } + }, + "CreateNetworkProfile": { + "input": { + "type": "structure", + "required": [ + "projectArn", + "name" + ], + "members": { + "projectArn": {}, + "name": {}, + "description": {}, + "type": {}, + "uplinkBandwidthBits": { + "type": "long" + }, + "downlinkBandwidthBits": { + "type": "long" + }, + "uplinkDelayMs": { + "type": "long" + }, + "downlinkDelayMs": { + "type": "long" + }, + "uplinkJitterMs": { + "type": "long" + }, + "downlinkJitterMs": { + "type": "long" + }, + "uplinkLossPercent": { + "type": "integer" + }, + "downlinkLossPercent": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "networkProfile": { + "shape": "So" + } + } + } + }, + "CreateProject": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "defaultJobTimeoutMinutes": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "project": { + "shape": "Ss" + } + } + } + }, + "CreateRemoteAccessSession": { + "input": { + "type": "structure", + "required": [ + "projectArn", + "deviceArn" + ], + "members": { + "projectArn": {}, + "deviceArn": {}, + "instanceArn": {}, + "sshPublicKey": {}, + "remoteDebugEnabled": { + "type": "boolean" + }, + "remoteRecordEnabled": { + "type": "boolean" + }, + "remoteRecordAppArn": {}, + "name": {}, + "clientId": {}, + "configuration": { + "type": "structure", + "members": { + "billingMethod": {}, + "vpceConfigurationArns": { + "shape": "Sz" + } + } + }, + "interactionMode": {}, + "skipAppResign": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "remoteAccessSession": { + "shape": "S12" + } + } + } + }, + "CreateUpload": { + "input": { + "type": "structure", + "required": [ + "projectArn", + "name", + "type" + ], + "members": { + "projectArn": {}, + "name": {}, + "type": {}, + "contentType": {} + } + }, + "output": { + "type": "structure", + "members": { + "upload": { + "shape": "S1n" + } + } + } + }, + "CreateVPCEConfiguration": { + "input": { + "type": "structure", + "required": [ + "vpceConfigurationName", + "vpceServiceName", + "serviceDnsName" + ], + "members": { + "vpceConfigurationName": {}, + "vpceServiceName": {}, + "serviceDnsName": {}, + "vpceConfigurationDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "vpceConfiguration": { + "shape": "S1y" + } + } + } + }, + "DeleteDevicePool": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteNetworkProfile": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteProject": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRemoteAccessSession": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRun": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteUpload": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteVPCEConfiguration": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetAccountSettings": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "accountSettings": { + "type": "structure", + "members": { + "awsAccountNumber": {}, + "unmeteredDevices": { + "shape": "S2j" + }, + "unmeteredRemoteAccessDevices": { + "shape": "S2j" + }, + "maxJobTimeoutMinutes": { + "type": "integer" + }, + "trialMinutes": { + "type": "structure", + "members": { + "total": { + "type": "double" + }, + "remaining": { + "type": "double" + } + } + }, + "maxSlots": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + }, + "defaultJobTimeoutMinutes": { + "type": "integer" + }, + "skipAppResign": { + "type": "boolean" + } + } + } + } + } + }, + "GetDevice": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "device": { + "shape": "S15" + } + } + } + }, + "GetDeviceInstance": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "deviceInstance": { + "shape": "S1c" + } + } + } + }, + "GetDevicePool": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "devicePool": { + "shape": "Sc" + } + } + } + }, + "GetDevicePoolCompatibility": { + "input": { + "type": "structure", + "required": [ + "devicePoolArn" + ], + "members": { + "devicePoolArn": {}, + "appArn": {}, + "testType": {}, + "test": { + "shape": "S2u" + }, + "configuration": { + "shape": "S2x" + } + } + }, + "output": { + "type": "structure", + "members": { + "compatibleDevices": { + "shape": "S35" + }, + "incompatibleDevices": { + "shape": "S35" + } + } + } + }, + "GetInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "instanceProfile": { + "shape": "Si" + } + } + } + }, + "GetJob": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "job": { + "shape": "S3d" + } + } + } + }, + "GetNetworkProfile": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "networkProfile": { + "shape": "So" + } + } + } + }, + "GetOfferingStatus": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "current": { + "shape": "S3l" + }, + "nextPeriod": { + "shape": "S3l" + }, + "nextToken": {} + } + } + }, + "GetProject": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "project": { + "shape": "Ss" + } + } + } + }, + "GetRemoteAccessSession": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "remoteAccessSession": { + "shape": "S12" + } + } + } + }, + "GetRun": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "run": { + "shape": "S42" + } + } + } + }, + "GetSuite": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "suite": { + "shape": "S4b" + } + } + } + }, + "GetTest": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "test": { + "shape": "S4e" + } + } + } + }, + "GetUpload": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "upload": { + "shape": "S1n" + } + } + } + }, + "GetVPCEConfiguration": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "vpceConfiguration": { + "shape": "S1y" + } + } + } + }, + "InstallToRemoteAccessSession": { + "input": { + "type": "structure", + "required": [ + "remoteAccessSessionArn", + "appArn" + ], + "members": { + "remoteAccessSessionArn": {}, + "appArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "appUpload": { + "shape": "S1n" + } + } + } + }, + "ListArtifacts": { + "input": { + "type": "structure", + "required": [ + "arn", + "type" + ], + "members": { + "arn": {}, + "type": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "artifacts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "type": {}, + "extension": {}, + "url": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListDeviceInstances": { + "input": { + "type": "structure", + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "deviceInstances": { + "shape": "S1b" + }, + "nextToken": {} + } + } + }, + "ListDevicePools": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "type": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "devicePools": { + "type": "list", + "member": { + "shape": "Sc" + } + }, + "nextToken": {} + } + } + }, + "ListDevices": { + "input": { + "type": "structure", + "members": { + "arn": {}, + "nextToken": {}, + "filters": { + "shape": "S45" + } + } + }, + "output": { + "type": "structure", + "members": { + "devices": { + "type": "list", + "member": { + "shape": "S15" + } + }, + "nextToken": {} + } + } + }, + "ListInstanceProfiles": { + "input": { + "type": "structure", + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "instanceProfiles": { + "type": "list", + "member": { + "shape": "Si" + } + }, + "nextToken": {} + } + } + }, + "ListJobs": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "jobs": { + "type": "list", + "member": { + "shape": "S3d" + } + }, + "nextToken": {} + } + } + }, + "ListNetworkProfiles": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "type": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "networkProfiles": { + "type": "list", + "member": { + "shape": "So" + } + }, + "nextToken": {} + } + } + }, + "ListOfferingPromotions": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "offeringPromotions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "description": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListOfferingTransactions": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "offeringTransactions": { + "type": "list", + "member": { + "shape": "S5g" + } + }, + "nextToken": {} + } + } + }, + "ListOfferings": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "offerings": { + "type": "list", + "member": { + "shape": "S3p" + } + }, + "nextToken": {} + } + } + }, + "ListProjects": { + "input": { + "type": "structure", + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "projects": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "nextToken": {} + } + } + }, + "ListRemoteAccessSessions": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "remoteAccessSessions": { + "type": "list", + "member": { + "shape": "S12" + } + }, + "nextToken": {} + } + } + }, + "ListRuns": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "runs": { + "type": "list", + "member": { + "shape": "S42" + } + }, + "nextToken": {} + } + } + }, + "ListSamples": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "samples": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "type": {}, + "url": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListSuites": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "suites": { + "type": "list", + "member": { + "shape": "S4b" + } + }, + "nextToken": {} + } + } + }, + "ListTests": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "tests": { + "type": "list", + "member": { + "shape": "S4e" + } + }, + "nextToken": {} + } + } + }, + "ListUniqueProblems": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "uniqueProblems": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "message": {}, + "problems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "run": { + "shape": "S6c" + }, + "job": { + "shape": "S6c" + }, + "suite": { + "shape": "S6c" + }, + "test": { + "shape": "S6c" + }, + "device": { + "shape": "S15" + }, + "result": {}, + "message": {} + } + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "ListUploads": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "type": {}, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "uploads": { + "type": "list", + "member": { + "shape": "S1n" + } + }, + "nextToken": {} + } + } + }, + "ListVPCEConfigurations": { + "input": { + "type": "structure", + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "vpceConfigurations": { + "type": "list", + "member": { + "shape": "S1y" + } + }, + "nextToken": {} + } + } + }, + "PurchaseOffering": { + "input": { + "type": "structure", + "members": { + "offeringId": {}, + "quantity": { + "type": "integer" + }, + "offeringPromotionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "offeringTransaction": { + "shape": "S5g" + } + } + } + }, + "RenewOffering": { + "input": { + "type": "structure", + "members": { + "offeringId": {}, + "quantity": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "offeringTransaction": { + "shape": "S5g" + } + } + } + }, + "ScheduleRun": { + "input": { + "type": "structure", + "required": [ + "projectArn", + "test" + ], + "members": { + "projectArn": {}, + "appArn": {}, + "devicePoolArn": {}, + "deviceSelectionConfiguration": { + "type": "structure", + "required": [ + "filters", + "maxDevices" + ], + "members": { + "filters": { + "shape": "S45" + }, + "maxDevices": { + "type": "integer" + } + } + }, + "name": {}, + "test": { + "shape": "S2u" + }, + "configuration": { + "shape": "S2x" + }, + "executionConfiguration": { + "type": "structure", + "members": { + "jobTimeoutMinutes": { + "type": "integer" + }, + "accountsCleanup": { + "type": "boolean" + }, + "appPackagesCleanup": { + "type": "boolean" + }, + "videoCapture": { + "type": "boolean" + }, + "skipAppResign": { + "type": "boolean" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "run": { + "shape": "S42" + } + } + } + }, + "StopJob": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "job": { + "shape": "S3d" + } + } + } + }, + "StopRemoteAccessSession": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "remoteAccessSession": { + "shape": "S12" + } + } + } + }, + "StopRun": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "run": { + "shape": "S42" + } + } + } + }, + "UpdateDeviceInstance": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "profileArn": {}, + "labels": { + "shape": "S1d" + } + } + }, + "output": { + "type": "structure", + "members": { + "deviceInstance": { + "shape": "S1c" + } + } + } + }, + "UpdateDevicePool": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "description": {}, + "rules": { + "shape": "S5" + }, + "maxDevices": { + "type": "integer" + }, + "clearMaxDevices": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "devicePool": { + "shape": "Sc" + } + } + } + }, + "UpdateInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "description": {}, + "packageCleanup": { + "type": "boolean" + }, + "excludeAppPackagesFromCleanup": { + "shape": "Sg" + }, + "rebootAfterUse": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "instanceProfile": { + "shape": "Si" + } + } + } + }, + "UpdateNetworkProfile": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "description": {}, + "type": {}, + "uplinkBandwidthBits": { + "type": "long" + }, + "downlinkBandwidthBits": { + "type": "long" + }, + "uplinkDelayMs": { + "type": "long" + }, + "downlinkDelayMs": { + "type": "long" + }, + "uplinkJitterMs": { + "type": "long" + }, + "downlinkJitterMs": { + "type": "long" + }, + "uplinkLossPercent": { + "type": "integer" + }, + "downlinkLossPercent": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "networkProfile": { + "shape": "So" + } + } + } + }, + "UpdateProject": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "defaultJobTimeoutMinutes": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "project": { + "shape": "Ss" + } + } + } + }, + "UpdateUpload": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "contentType": {}, + "editContent": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "upload": { + "shape": "S1n" + } + } + } + }, + "UpdateVPCEConfiguration": { + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "vpceConfigurationName": {}, + "vpceServiceName": {}, + "serviceDnsName": {}, + "vpceConfigurationDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "vpceConfiguration": { + "shape": "S1y" + } + } + } + } + }, + "shapes": { + "S5": { + "type": "list", + "member": { + "type": "structure", + "members": { + "attribute": {}, + "operator": {}, + "value": {} + } + } + }, + "Sc": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "description": {}, + "type": {}, + "rules": { + "shape": "S5" + }, + "maxDevices": { + "type": "integer" + } + } + }, + "Sg": { + "type": "list", + "member": {} + }, + "Si": { + "type": "structure", + "members": { + "arn": {}, + "packageCleanup": { + "type": "boolean" + }, + "excludeAppPackagesFromCleanup": { + "shape": "Sg" + }, + "rebootAfterUse": { + "type": "boolean" + }, + "name": {}, + "description": {} + } + }, + "So": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "description": {}, + "type": {}, + "uplinkBandwidthBits": { + "type": "long" + }, + "downlinkBandwidthBits": { + "type": "long" + }, + "uplinkDelayMs": { + "type": "long" + }, + "downlinkDelayMs": { + "type": "long" + }, + "uplinkJitterMs": { + "type": "long" + }, + "downlinkJitterMs": { + "type": "long" + }, + "uplinkLossPercent": { + "type": "integer" + }, + "downlinkLossPercent": { + "type": "integer" + } + } + }, + "Ss": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "defaultJobTimeoutMinutes": { + "type": "integer" + }, + "created": { + "type": "timestamp" + } + } + }, + "Sz": { + "type": "list", + "member": {} + }, + "S12": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "created": { + "type": "timestamp" + }, + "status": {}, + "result": {}, + "message": {}, + "started": { + "type": "timestamp" + }, + "stopped": { + "type": "timestamp" + }, + "device": { + "shape": "S15" + }, + "instanceArn": {}, + "remoteDebugEnabled": { + "type": "boolean" + }, + "remoteRecordEnabled": { + "type": "boolean" + }, + "remoteRecordAppArn": {}, + "hostAddress": {}, + "clientId": {}, + "billingMethod": {}, + "deviceMinutes": { + "shape": "S1h" + }, + "endpoint": {}, + "deviceUdid": {}, + "interactionMode": {}, + "skipAppResign": { + "type": "boolean" + } + } + }, + "S15": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "manufacturer": {}, + "model": {}, + "modelId": {}, + "formFactor": {}, + "platform": {}, + "os": {}, + "cpu": { + "type": "structure", + "members": { + "frequency": {}, + "architecture": {}, + "clock": { + "type": "double" + } + } + }, + "resolution": { + "type": "structure", + "members": { + "width": { + "type": "integer" + }, + "height": { + "type": "integer" + } + } + }, + "heapSize": { + "type": "long" + }, + "memory": { + "type": "long" + }, + "image": {}, + "carrier": {}, + "radio": {}, + "remoteAccessEnabled": { + "type": "boolean" + }, + "remoteDebugEnabled": { + "type": "boolean" + }, + "fleetType": {}, + "fleetName": {}, + "instances": { + "shape": "S1b" + }, + "availability": {} + } + }, + "S1b": { + "type": "list", + "member": { + "shape": "S1c" + } + }, + "S1c": { + "type": "structure", + "members": { + "arn": {}, + "deviceArn": {}, + "labels": { + "shape": "S1d" + }, + "status": {}, + "udid": {}, + "instanceProfile": { + "shape": "Si" + } + } + }, + "S1d": { + "type": "list", + "member": {} + }, + "S1h": { + "type": "structure", + "members": { + "total": { + "type": "double" + }, + "metered": { + "type": "double" + }, + "unmetered": { + "type": "double" + } + } + }, + "S1n": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "created": { + "type": "timestamp" + }, + "type": {}, + "status": {}, + "url": {}, + "metadata": {}, + "contentType": {}, + "message": {}, + "category": {} + } + }, + "S1y": { + "type": "structure", + "members": { + "arn": {}, + "vpceConfigurationName": {}, + "vpceServiceName": {}, + "serviceDnsName": {}, + "vpceConfigurationDescription": {} + } + }, + "S2j": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + }, + "S2u": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "testPackageArn": {}, + "testSpecArn": {}, + "filter": {}, + "parameters": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "S2x": { + "type": "structure", + "members": { + "extraDataPackageArn": {}, + "networkProfileArn": {}, + "locale": {}, + "location": { + "shape": "S2y" + }, + "vpceConfigurationArns": { + "shape": "Sz" + }, + "customerArtifactPaths": { + "shape": "S2z" + }, + "radios": { + "shape": "S33" + }, + "auxiliaryApps": { + "shape": "Sz" + }, + "billingMethod": {} + } + }, + "S2y": { + "type": "structure", + "required": [ + "latitude", + "longitude" + ], + "members": { + "latitude": { + "type": "double" + }, + "longitude": { + "type": "double" + } + } + }, + "S2z": { + "type": "structure", + "members": { + "iosPaths": { + "type": "list", + "member": {} + }, + "androidPaths": { + "type": "list", + "member": {} + }, + "deviceHostPaths": { + "type": "list", + "member": {} + } + } + }, + "S33": { + "type": "structure", + "members": { + "wifi": { + "type": "boolean" + }, + "bluetooth": { + "type": "boolean" + }, + "nfc": { + "type": "boolean" + }, + "gps": { + "type": "boolean" + } + } + }, + "S35": { + "type": "list", + "member": { + "type": "structure", + "members": { + "device": { + "shape": "S15" + }, + "compatible": { + "type": "boolean" + }, + "incompatibilityMessages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "message": {}, + "type": {} + } + } + } + } + } + }, + "S3d": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "type": {}, + "created": { + "type": "timestamp" + }, + "status": {}, + "result": {}, + "started": { + "type": "timestamp" + }, + "stopped": { + "type": "timestamp" + }, + "counters": { + "shape": "S3e" + }, + "message": {}, + "device": { + "shape": "S15" + }, + "instanceArn": {}, + "deviceMinutes": { + "shape": "S1h" + }, + "videoEndpoint": {}, + "videoCapture": { + "type": "boolean" + } + } + }, + "S3e": { + "type": "structure", + "members": { + "total": { + "type": "integer" + }, + "passed": { + "type": "integer" + }, + "failed": { + "type": "integer" + }, + "warned": { + "type": "integer" + }, + "errored": { + "type": "integer" + }, + "stopped": { + "type": "integer" + }, + "skipped": { + "type": "integer" + } + } + }, + "S3l": { + "type": "map", + "key": {}, + "value": { + "shape": "S3n" + } + }, + "S3n": { + "type": "structure", + "members": { + "type": {}, + "offering": { + "shape": "S3p" + }, + "quantity": { + "type": "integer" + }, + "effectiveOn": { + "type": "timestamp" + } + } + }, + "S3p": { + "type": "structure", + "members": { + "id": {}, + "description": {}, + "type": {}, + "platform": {}, + "recurringCharges": { + "type": "list", + "member": { + "type": "structure", + "members": { + "cost": { + "shape": "S3t" + }, + "frequency": {} + } + } + } + } + }, + "S3t": { + "type": "structure", + "members": { + "amount": { + "type": "double" + }, + "currencyCode": {} + } + }, + "S42": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "type": {}, + "platform": {}, + "created": { + "type": "timestamp" + }, + "status": {}, + "result": {}, + "started": { + "type": "timestamp" + }, + "stopped": { + "type": "timestamp" + }, + "counters": { + "shape": "S3e" + }, + "message": {}, + "totalJobs": { + "type": "integer" + }, + "completedJobs": { + "type": "integer" + }, + "billingMethod": {}, + "deviceMinutes": { + "shape": "S1h" + }, + "networkProfile": { + "shape": "So" + }, + "parsingResultUrl": {}, + "resultCode": {}, + "seed": { + "type": "integer" + }, + "appUpload": {}, + "eventCount": { + "type": "integer" + }, + "jobTimeoutMinutes": { + "type": "integer" + }, + "devicePoolArn": {}, + "locale": {}, + "radios": { + "shape": "S33" + }, + "location": { + "shape": "S2y" + }, + "customerArtifactPaths": { + "shape": "S2z" + }, + "webUrl": {}, + "skipAppResign": { + "type": "boolean" + }, + "testSpecArn": {}, + "deviceSelectionResult": { + "type": "structure", + "members": { + "filters": { + "shape": "S45" + }, + "matchedDevicesCount": { + "type": "integer" + }, + "maxDevices": { + "type": "integer" + } + } + } + } + }, + "S45": { + "type": "list", + "member": { + "type": "structure", + "members": { + "attribute": {}, + "operator": {}, + "values": { + "type": "list", + "member": {} + } + } + } + }, + "S4b": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "type": {}, + "created": { + "type": "timestamp" + }, + "status": {}, + "result": {}, + "started": { + "type": "timestamp" + }, + "stopped": { + "type": "timestamp" + }, + "counters": { + "shape": "S3e" + }, + "message": {}, + "deviceMinutes": { + "shape": "S1h" + } + } + }, + "S4e": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "type": {}, + "created": { + "type": "timestamp" + }, + "status": {}, + "result": {}, + "started": { + "type": "timestamp" + }, + "stopped": { + "type": "timestamp" + }, + "counters": { + "shape": "S3e" + }, + "message": {}, + "deviceMinutes": { + "shape": "S1h" + } + } + }, + "S5g": { + "type": "structure", + "members": { + "offeringStatus": { + "shape": "S3n" + }, + "transactionId": {}, + "offeringPromotionId": {}, + "createdOn": { + "type": "timestamp" + }, + "cost": { + "shape": "S3t" + } + } + }, + "S6c": { + "type": "structure", + "members": { + "arn": {}, + "name": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/devicefarm-2015-06-23.paginators.json b/node_modules/aws-sdk/apis/devicefarm-2015-06-23.paginators.json new file mode 100644 index 0000000..7f9e88c --- /dev/null +++ b/node_modules/aws-sdk/apis/devicefarm-2015-06-23.paginators.json @@ -0,0 +1,77 @@ +{ + "pagination": { + "GetOfferingStatus": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": [ + "current", + "nextPeriod" + ] + }, + "ListArtifacts": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "artifacts" + }, + "ListDevicePools": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "devicePools" + }, + "ListDevices": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "devices" + }, + "ListJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "jobs" + }, + "ListOfferingTransactions": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "offeringTransactions" + }, + "ListOfferings": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "offerings" + }, + "ListProjects": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "projects" + }, + "ListRuns": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "runs" + }, + "ListSamples": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "samples" + }, + "ListSuites": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "suites" + }, + "ListTests": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "tests" + }, + "ListUniqueProblems": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "uniqueProblems" + }, + "ListUploads": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "uploads" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/directconnect-2012-10-25.examples.json b/node_modules/aws-sdk/apis/directconnect-2012-10-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/directconnect-2012-10-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/directconnect-2012-10-25.min.json b/node_modules/aws-sdk/apis/directconnect-2012-10-25.min.json new file mode 100644 index 0000000..9aa8705 --- /dev/null +++ b/node_modules/aws-sdk/apis/directconnect-2012-10-25.min.json @@ -0,0 +1,1482 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-10-25", + "endpointPrefix": "directconnect", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Direct Connect", + "serviceId": "Direct Connect", + "signatureVersion": "v4", + "targetPrefix": "OvertureService", + "uid": "directconnect-2012-10-25" + }, + "operations": { + "AcceptDirectConnectGatewayAssociationProposal": { + "input": { + "type": "structure", + "required": [ + "directConnectGatewayId", + "proposalId", + "associatedGatewayOwnerAccount" + ], + "members": { + "directConnectGatewayId": {}, + "proposalId": {}, + "associatedGatewayOwnerAccount": {}, + "overrideAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociation": { + "shape": "S9" + } + } + } + }, + "AllocateConnectionOnInterconnect": { + "input": { + "type": "structure", + "required": [ + "bandwidth", + "connectionName", + "ownerAccount", + "interconnectId", + "vlan" + ], + "members": { + "bandwidth": {}, + "connectionName": {}, + "ownerAccount": {}, + "interconnectId": {}, + "vlan": { + "type": "integer" + } + } + }, + "output": { + "shape": "So" + }, + "deprecated": true + }, + "AllocateHostedConnection": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "ownerAccount", + "bandwidth", + "connectionName", + "vlan" + ], + "members": { + "connectionId": {}, + "ownerAccount": {}, + "bandwidth": {}, + "connectionName": {}, + "vlan": { + "type": "integer" + } + } + }, + "output": { + "shape": "So" + } + }, + "AllocatePrivateVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "ownerAccount", + "newPrivateVirtualInterfaceAllocation" + ], + "members": { + "connectionId": {}, + "ownerAccount": {}, + "newPrivateVirtualInterfaceAllocation": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "mtu": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "addressFamily": {}, + "customerAddress": {} + } + } + } + }, + "output": { + "shape": "S19" + } + }, + "AllocatePublicVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "ownerAccount", + "newPublicVirtualInterfaceAllocation" + ], + "members": { + "connectionId": {}, + "ownerAccount": {}, + "newPublicVirtualInterfaceAllocation": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "addressFamily": {}, + "routeFilterPrefixes": { + "shape": "S5" + } + } + } + } + }, + "output": { + "shape": "S19" + } + }, + "AllocateTransitVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "ownerAccount", + "newTransitVirtualInterfaceAllocation" + ], + "members": { + "connectionId": {}, + "ownerAccount": {}, + "newTransitVirtualInterfaceAllocation": { + "type": "structure", + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "mtu": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "addressFamily": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterface": { + "shape": "S19" + } + } + } + }, + "AssociateConnectionWithLag": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "lagId" + ], + "members": { + "connectionId": {}, + "lagId": {} + } + }, + "output": { + "shape": "So" + } + }, + "AssociateHostedConnection": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "parentConnectionId" + ], + "members": { + "connectionId": {}, + "parentConnectionId": {} + } + }, + "output": { + "shape": "So" + } + }, + "AssociateVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId", + "connectionId" + ], + "members": { + "virtualInterfaceId": {}, + "connectionId": {} + } + }, + "output": { + "shape": "S19" + } + }, + "ConfirmConnection": { + "input": { + "type": "structure", + "required": [ + "connectionId" + ], + "members": { + "connectionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "connectionState": {} + } + } + }, + "ConfirmPrivateVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId" + ], + "members": { + "virtualInterfaceId": {}, + "virtualGatewayId": { + "shape": "Sh" + }, + "directConnectGatewayId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaceState": {} + } + } + }, + "ConfirmPublicVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId" + ], + "members": { + "virtualInterfaceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaceState": {} + } + } + }, + "ConfirmTransitVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId", + "directConnectGatewayId" + ], + "members": { + "virtualInterfaceId": {}, + "directConnectGatewayId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaceState": {} + } + } + }, + "CreateBGPPeer": { + "input": { + "type": "structure", + "members": { + "virtualInterfaceId": {}, + "newBGPPeer": { + "type": "structure", + "members": { + "asn": { + "type": "integer" + }, + "authKey": {}, + "addressFamily": {}, + "amazonAddress": {}, + "customerAddress": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterface": { + "shape": "S19" + } + } + } + }, + "CreateConnection": { + "input": { + "type": "structure", + "required": [ + "location", + "bandwidth", + "connectionName" + ], + "members": { + "location": {}, + "bandwidth": {}, + "connectionName": {}, + "lagId": {} + } + }, + "output": { + "shape": "So" + } + }, + "CreateDirectConnectGateway": { + "input": { + "type": "structure", + "required": [ + "directConnectGatewayName" + ], + "members": { + "directConnectGatewayName": {}, + "amazonSideAsn": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGateway": { + "shape": "S27" + } + } + } + }, + "CreateDirectConnectGatewayAssociation": { + "input": { + "type": "structure", + "required": [ + "directConnectGatewayId" + ], + "members": { + "directConnectGatewayId": {}, + "gatewayId": {}, + "addAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + }, + "virtualGatewayId": { + "shape": "Sh" + } + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociation": { + "shape": "S9" + } + } + } + }, + "CreateDirectConnectGatewayAssociationProposal": { + "input": { + "type": "structure", + "required": [ + "directConnectGatewayId", + "directConnectGatewayOwnerAccount", + "gatewayId" + ], + "members": { + "directConnectGatewayId": {}, + "directConnectGatewayOwnerAccount": {}, + "gatewayId": {}, + "addAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + }, + "removeAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociationProposal": { + "shape": "S2e" + } + } + } + }, + "CreateInterconnect": { + "input": { + "type": "structure", + "required": [ + "interconnectName", + "bandwidth", + "location" + ], + "members": { + "interconnectName": {}, + "bandwidth": {}, + "location": {}, + "lagId": {} + } + }, + "output": { + "shape": "S2i" + } + }, + "CreateLag": { + "input": { + "type": "structure", + "required": [ + "numberOfConnections", + "location", + "connectionsBandwidth", + "lagName" + ], + "members": { + "numberOfConnections": { + "type": "integer" + }, + "location": {}, + "connectionsBandwidth": {}, + "lagName": {}, + "connectionId": {} + } + }, + "output": { + "shape": "S2n" + } + }, + "CreatePrivateVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "newPrivateVirtualInterface" + ], + "members": { + "connectionId": {}, + "newPrivateVirtualInterface": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "mtu": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "addressFamily": {}, + "virtualGatewayId": { + "shape": "Sh" + }, + "directConnectGatewayId": {} + } + } + } + }, + "output": { + "shape": "S19" + } + }, + "CreatePublicVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "newPublicVirtualInterface" + ], + "members": { + "connectionId": {}, + "newPublicVirtualInterface": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "addressFamily": {}, + "routeFilterPrefixes": { + "shape": "S5" + } + } + } + } + }, + "output": { + "shape": "S19" + } + }, + "CreateTransitVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "newTransitVirtualInterface" + ], + "members": { + "connectionId": {}, + "newTransitVirtualInterface": { + "type": "structure", + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "mtu": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "addressFamily": {}, + "directConnectGatewayId": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterface": { + "shape": "S19" + } + } + } + }, + "DeleteBGPPeer": { + "input": { + "type": "structure", + "members": { + "virtualInterfaceId": {}, + "asn": { + "type": "integer" + }, + "customerAddress": {}, + "bgpPeerId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterface": { + "shape": "S19" + } + } + } + }, + "DeleteConnection": { + "input": { + "type": "structure", + "required": [ + "connectionId" + ], + "members": { + "connectionId": {} + } + }, + "output": { + "shape": "So" + } + }, + "DeleteDirectConnectGateway": { + "input": { + "type": "structure", + "required": [ + "directConnectGatewayId" + ], + "members": { + "directConnectGatewayId": {} + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGateway": { + "shape": "S27" + } + } + } + }, + "DeleteDirectConnectGatewayAssociation": { + "input": { + "type": "structure", + "members": { + "associationId": {}, + "directConnectGatewayId": {}, + "virtualGatewayId": { + "shape": "Sh" + } + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociation": { + "shape": "S9" + } + } + } + }, + "DeleteDirectConnectGatewayAssociationProposal": { + "input": { + "type": "structure", + "required": [ + "proposalId" + ], + "members": { + "proposalId": {} + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociationProposal": { + "shape": "S2e" + } + } + } + }, + "DeleteInterconnect": { + "input": { + "type": "structure", + "required": [ + "interconnectId" + ], + "members": { + "interconnectId": {} + } + }, + "output": { + "type": "structure", + "members": { + "interconnectState": {} + } + } + }, + "DeleteLag": { + "input": { + "type": "structure", + "required": [ + "lagId" + ], + "members": { + "lagId": {} + } + }, + "output": { + "shape": "S2n" + } + }, + "DeleteVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId" + ], + "members": { + "virtualInterfaceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaceState": {} + } + } + }, + "DescribeConnectionLoa": { + "input": { + "type": "structure", + "required": [ + "connectionId" + ], + "members": { + "connectionId": {}, + "providerName": {}, + "loaContentType": {} + } + }, + "output": { + "type": "structure", + "members": { + "loa": { + "shape": "S3g" + } + } + }, + "deprecated": true + }, + "DescribeConnections": { + "input": { + "type": "structure", + "members": { + "connectionId": {} + } + }, + "output": { + "shape": "S3j" + } + }, + "DescribeConnectionsOnInterconnect": { + "input": { + "type": "structure", + "required": [ + "interconnectId" + ], + "members": { + "interconnectId": {} + } + }, + "output": { + "shape": "S3j" + }, + "deprecated": true + }, + "DescribeDirectConnectGatewayAssociationProposals": { + "input": { + "type": "structure", + "members": { + "directConnectGatewayId": {}, + "proposalId": {}, + "associatedGatewayId": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociationProposals": { + "type": "list", + "member": { + "shape": "S2e" + } + }, + "nextToken": {} + } + } + }, + "DescribeDirectConnectGatewayAssociations": { + "input": { + "type": "structure", + "members": { + "associationId": {}, + "associatedGatewayId": {}, + "directConnectGatewayId": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {}, + "virtualGatewayId": { + "shape": "Sh" + } + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociations": { + "type": "list", + "member": { + "shape": "S9" + } + }, + "nextToken": {} + } + } + }, + "DescribeDirectConnectGatewayAttachments": { + "input": { + "type": "structure", + "members": { + "directConnectGatewayId": {}, + "virtualInterfaceId": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAttachments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "directConnectGatewayId": {}, + "virtualInterfaceId": {}, + "virtualInterfaceRegion": {}, + "virtualInterfaceOwnerAccount": {}, + "attachmentState": {}, + "attachmentType": {}, + "stateChangeError": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeDirectConnectGateways": { + "input": { + "type": "structure", + "members": { + "directConnectGatewayId": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGateways": { + "type": "list", + "member": { + "shape": "S27" + } + }, + "nextToken": {} + } + } + }, + "DescribeHostedConnections": { + "input": { + "type": "structure", + "required": [ + "connectionId" + ], + "members": { + "connectionId": {} + } + }, + "output": { + "shape": "S3j" + } + }, + "DescribeInterconnectLoa": { + "input": { + "type": "structure", + "required": [ + "interconnectId" + ], + "members": { + "interconnectId": {}, + "providerName": {}, + "loaContentType": {} + } + }, + "output": { + "type": "structure", + "members": { + "loa": { + "shape": "S3g" + } + } + }, + "deprecated": true + }, + "DescribeInterconnects": { + "input": { + "type": "structure", + "members": { + "interconnectId": {} + } + }, + "output": { + "type": "structure", + "members": { + "interconnects": { + "type": "list", + "member": { + "shape": "S2i" + } + } + } + } + }, + "DescribeLags": { + "input": { + "type": "structure", + "members": { + "lagId": {} + } + }, + "output": { + "type": "structure", + "members": { + "lags": { + "type": "list", + "member": { + "shape": "S2n" + } + } + } + } + }, + "DescribeLoa": { + "input": { + "type": "structure", + "required": [ + "connectionId" + ], + "members": { + "connectionId": {}, + "providerName": {}, + "loaContentType": {} + } + }, + "output": { + "shape": "S3g" + } + }, + "DescribeLocations": { + "output": { + "type": "structure", + "members": { + "locations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "locationCode": {}, + "locationName": {}, + "region": {}, + "availablePortSpeeds": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "required": [ + "resourceArns" + ], + "members": { + "resourceArns": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "resourceTags": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resourceArn": {}, + "tags": { + "shape": "S4q" + } + } + } + } + } + } + }, + "DescribeVirtualGateways": { + "output": { + "type": "structure", + "members": { + "virtualGateways": { + "type": "list", + "member": { + "type": "structure", + "members": { + "virtualGatewayId": { + "shape": "Sh" + }, + "virtualGatewayState": {} + } + } + } + } + } + }, + "DescribeVirtualInterfaces": { + "input": { + "type": "structure", + "members": { + "connectionId": {}, + "virtualInterfaceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaces": { + "type": "list", + "member": { + "shape": "S19" + } + } + } + } + }, + "DisassociateConnectionFromLag": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "lagId" + ], + "members": { + "connectionId": {}, + "lagId": {} + } + }, + "output": { + "shape": "So" + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": {}, + "tags": { + "shape": "S4q" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": {}, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDirectConnectGatewayAssociation": { + "input": { + "type": "structure", + "members": { + "associationId": {}, + "addAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + }, + "removeAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "directConnectGatewayAssociation": { + "shape": "S9" + } + } + } + }, + "UpdateLag": { + "input": { + "type": "structure", + "required": [ + "lagId" + ], + "members": { + "lagId": {}, + "lagName": {}, + "minimumLinks": { + "type": "integer" + } + } + }, + "output": { + "shape": "S2n" + } + }, + "UpdateVirtualInterfaceAttributes": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId" + ], + "members": { + "virtualInterfaceId": {}, + "mtu": { + "type": "integer" + } + } + }, + "output": { + "shape": "S19" + } + } + }, + "shapes": { + "S5": { + "type": "list", + "member": { + "type": "structure", + "members": { + "cidr": {} + } + } + }, + "S9": { + "type": "structure", + "members": { + "directConnectGatewayId": {}, + "directConnectGatewayOwnerAccount": {}, + "associationState": {}, + "stateChangeError": {}, + "associatedGateway": { + "shape": "Sc" + }, + "associationId": {}, + "allowedPrefixesToDirectConnectGateway": { + "shape": "S5" + }, + "virtualGatewayId": { + "shape": "Sh" + }, + "virtualGatewayRegion": { + "type": "string", + "deprecated": true + }, + "virtualGatewayOwnerAccount": {} + } + }, + "Sc": { + "type": "structure", + "members": { + "id": {}, + "type": {}, + "ownerAccount": {}, + "region": {} + } + }, + "Sh": { + "type": "string", + "deprecated": true + }, + "So": { + "type": "structure", + "members": { + "ownerAccount": {}, + "connectionId": {}, + "connectionName": {}, + "connectionState": {}, + "region": {}, + "location": {}, + "bandwidth": {}, + "vlan": { + "type": "integer" + }, + "partnerName": {}, + "loaIssueTime": { + "type": "timestamp" + }, + "lagId": {}, + "awsDevice": { + "shape": "Sv" + }, + "jumboFrameCapable": { + "type": "boolean" + }, + "awsDeviceV2": {}, + "hasLogicalRedundancy": {} + } + }, + "Sv": { + "type": "string", + "deprecated": true + }, + "S19": { + "type": "structure", + "members": { + "ownerAccount": {}, + "virtualInterfaceId": {}, + "location": {}, + "connectionId": {}, + "virtualInterfaceType": {}, + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "amazonSideAsn": { + "type": "long" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "addressFamily": {}, + "virtualInterfaceState": {}, + "customerRouterConfig": {}, + "mtu": { + "type": "integer" + }, + "jumboFrameCapable": { + "type": "boolean" + }, + "virtualGatewayId": { + "shape": "Sh" + }, + "directConnectGatewayId": {}, + "routeFilterPrefixes": { + "shape": "S5" + }, + "bgpPeers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "bgpPeerId": {}, + "asn": { + "type": "integer" + }, + "authKey": {}, + "addressFamily": {}, + "amazonAddress": {}, + "customerAddress": {}, + "bgpPeerState": {}, + "bgpStatus": {}, + "awsDeviceV2": {} + } + } + }, + "region": {}, + "awsDeviceV2": {} + } + }, + "S27": { + "type": "structure", + "members": { + "directConnectGatewayId": {}, + "directConnectGatewayName": {}, + "amazonSideAsn": { + "type": "long" + }, + "ownerAccount": {}, + "directConnectGatewayState": {}, + "stateChangeError": {} + } + }, + "S2e": { + "type": "structure", + "members": { + "proposalId": {}, + "directConnectGatewayId": {}, + "directConnectGatewayOwnerAccount": {}, + "proposalState": {}, + "associatedGateway": { + "shape": "Sc" + }, + "existingAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + }, + "requestedAllowedPrefixesToDirectConnectGateway": { + "shape": "S5" + } + } + }, + "S2i": { + "type": "structure", + "members": { + "interconnectId": {}, + "interconnectName": {}, + "interconnectState": {}, + "region": {}, + "location": {}, + "bandwidth": {}, + "loaIssueTime": { + "type": "timestamp" + }, + "lagId": {}, + "awsDevice": { + "shape": "Sv" + }, + "jumboFrameCapable": { + "type": "boolean" + }, + "awsDeviceV2": {}, + "hasLogicalRedundancy": {} + } + }, + "S2n": { + "type": "structure", + "members": { + "connectionsBandwidth": {}, + "numberOfConnections": { + "type": "integer" + }, + "lagId": {}, + "ownerAccount": {}, + "lagName": {}, + "lagState": {}, + "location": {}, + "region": {}, + "minimumLinks": { + "type": "integer" + }, + "awsDevice": { + "shape": "Sv" + }, + "awsDeviceV2": {}, + "connections": { + "shape": "S2p" + }, + "allowsHostedConnections": { + "type": "boolean" + }, + "jumboFrameCapable": { + "type": "boolean" + }, + "hasLogicalRedundancy": {} + } + }, + "S2p": { + "type": "list", + "member": { + "shape": "So" + } + }, + "S3g": { + "type": "structure", + "members": { + "loaContent": { + "type": "blob" + }, + "loaContentType": {} + } + }, + "S3j": { + "type": "structure", + "members": { + "connections": { + "shape": "S2p" + } + } + }, + "S4q": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": {}, + "value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/directconnect-2012-10-25.paginators.json b/node_modules/aws-sdk/apis/directconnect-2012-10-25.paginators.json new file mode 100644 index 0000000..b5a985f --- /dev/null +++ b/node_modules/aws-sdk/apis/directconnect-2012-10-25.paginators.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeConnections": { + "result_key": "connections" + }, + "DescribeConnectionsOnInterconnect": { + "result_key": "connections" + }, + "DescribeInterconnects": { + "result_key": "interconnects" + }, + "DescribeLocations": { + "result_key": "locations" + }, + "DescribeVirtualGateways": { + "result_key": "virtualGateways" + }, + "DescribeVirtualInterfaces": { + "result_key": "virtualInterfaces" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/discovery-2015-11-01.examples.json b/node_modules/aws-sdk/apis/discovery-2015-11-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/discovery-2015-11-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json b/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json new file mode 100644 index 0000000..a4e3bea --- /dev/null +++ b/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json @@ -0,0 +1,915 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-11-01", + "endpointPrefix": "discovery", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Application Discovery Service", + "serviceId": "Application Discovery Service", + "signatureVersion": "v4", + "targetPrefix": "AWSPoseidonService_V2015_11_01", + "uid": "discovery-2015-11-01" + }, + "operations": { + "AssociateConfigurationItemsToApplication": { + "input": { + "type": "structure", + "required": [ + "applicationConfigurationId", + "configurationIds" + ], + "members": { + "applicationConfigurationId": {}, + "configurationIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "BatchDeleteImportData": { + "input": { + "type": "structure", + "required": [ + "importTaskIds" + ], + "members": { + "importTaskIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "errors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "importTaskId": {}, + "errorCode": {}, + "errorDescription": {} + } + } + } + } + } + }, + "CreateApplication": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "description": {} + } + }, + "output": { + "type": "structure", + "members": { + "configurationId": {} + } + } + }, + "CreateTags": { + "input": { + "type": "structure", + "required": [ + "configurationIds", + "tags" + ], + "members": { + "configurationIds": { + "shape": "S3" + }, + "tags": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteApplications": { + "input": { + "type": "structure", + "required": [ + "configurationIds" + ], + "members": { + "configurationIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "configurationIds" + ], + "members": { + "configurationIds": { + "shape": "S3" + }, + "tags": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeAgents": { + "input": { + "type": "structure", + "members": { + "agentIds": { + "shape": "St" + }, + "filters": { + "shape": "Sv" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "agentsInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "agentId": {}, + "hostName": {}, + "agentNetworkInfoList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ipAddress": {}, + "macAddress": {} + } + } + }, + "connectorId": {}, + "version": {}, + "health": {}, + "lastHealthPingTime": {}, + "collectionStatus": {}, + "agentType": {}, + "registeredTime": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeConfigurations": { + "input": { + "type": "structure", + "required": [ + "configurationIds" + ], + "members": { + "configurationIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "configurations": { + "type": "list", + "member": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + }, + "DescribeContinuousExports": { + "input": { + "type": "structure", + "members": { + "exportIds": { + "type": "list", + "member": {} + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "descriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "exportId": {}, + "status": {}, + "statusDetail": {}, + "s3Bucket": {}, + "startTime": { + "type": "timestamp" + }, + "stopTime": { + "type": "timestamp" + }, + "dataSource": {}, + "schemaStorageConfig": { + "shape": "S1o" + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeExportConfigurations": { + "input": { + "type": "structure", + "members": { + "exportIds": { + "shape": "S1r" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "exportsInfo": { + "shape": "S1t" + }, + "nextToken": {} + } + }, + "deprecated": true + }, + "DescribeExportTasks": { + "input": { + "type": "structure", + "members": { + "exportIds": { + "shape": "S1r" + }, + "filters": { + "shape": "S21" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "exportsInfo": { + "shape": "S1t" + }, + "nextToken": {} + } + } + }, + "DescribeImportTasks": { + "input": { + "type": "structure", + "members": { + "filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "values": { + "type": "list", + "member": {} + } + } + } + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "nextToken": {}, + "tasks": { + "type": "list", + "member": { + "shape": "S2e" + } + } + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "members": { + "filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "values" + ], + "members": { + "name": {}, + "values": { + "shape": "Sx" + } + } + } + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "type": "list", + "member": { + "type": "structure", + "members": { + "configurationType": {}, + "configurationId": {}, + "key": {}, + "value": {}, + "timeOfCreation": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "DisassociateConfigurationItemsFromApplication": { + "input": { + "type": "structure", + "required": [ + "applicationConfigurationId", + "configurationIds" + ], + "members": { + "applicationConfigurationId": {}, + "configurationIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ExportConfigurations": { + "output": { + "type": "structure", + "members": { + "exportId": {} + } + }, + "deprecated": true + }, + "GetDiscoverySummary": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "servers": { + "type": "long" + }, + "applications": { + "type": "long" + }, + "serversMappedToApplications": { + "type": "long" + }, + "serversMappedtoTags": { + "type": "long" + }, + "agentSummary": { + "type": "structure", + "required": [ + "activeAgents", + "healthyAgents", + "blackListedAgents", + "shutdownAgents", + "unhealthyAgents", + "totalAgents", + "unknownAgents" + ], + "members": { + "activeAgents": { + "type": "integer" + }, + "healthyAgents": { + "type": "integer" + }, + "blackListedAgents": { + "type": "integer" + }, + "shutdownAgents": { + "type": "integer" + }, + "unhealthyAgents": { + "type": "integer" + }, + "totalAgents": { + "type": "integer" + }, + "unknownAgents": { + "type": "integer" + } + } + }, + "connectorSummary": { + "type": "structure", + "required": [ + "activeConnectors", + "healthyConnectors", + "blackListedConnectors", + "shutdownConnectors", + "unhealthyConnectors", + "totalConnectors", + "unknownConnectors" + ], + "members": { + "activeConnectors": { + "type": "integer" + }, + "healthyConnectors": { + "type": "integer" + }, + "blackListedConnectors": { + "type": "integer" + }, + "shutdownConnectors": { + "type": "integer" + }, + "unhealthyConnectors": { + "type": "integer" + }, + "totalConnectors": { + "type": "integer" + }, + "unknownConnectors": { + "type": "integer" + } + } + } + } + } + }, + "ListConfigurations": { + "input": { + "type": "structure", + "required": [ + "configurationType" + ], + "members": { + "configurationType": {}, + "filters": { + "shape": "Sv" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {}, + "orderBy": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "fieldName" + ], + "members": { + "fieldName": {}, + "sortOrder": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "configurations": { + "type": "list", + "member": { + "type": "map", + "key": {}, + "value": {} + } + }, + "nextToken": {} + } + } + }, + "ListServerNeighbors": { + "input": { + "type": "structure", + "required": [ + "configurationId" + ], + "members": { + "configurationId": {}, + "portInformationNeeded": { + "type": "boolean" + }, + "neighborConfigurationIds": { + "shape": "S3" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "neighbors" + ], + "members": { + "neighbors": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "sourceServerId", + "destinationServerId", + "connectionsCount" + ], + "members": { + "sourceServerId": {}, + "destinationServerId": {}, + "destinationPort": { + "type": "integer" + }, + "transportProtocol": {}, + "connectionsCount": { + "type": "long" + } + } + } + }, + "nextToken": {}, + "knownDependencyCount": { + "type": "long" + } + } + } + }, + "StartContinuousExport": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "exportId": {}, + "s3Bucket": {}, + "startTime": { + "type": "timestamp" + }, + "dataSource": {}, + "schemaStorageConfig": { + "shape": "S1o" + } + } + } + }, + "StartDataCollectionByAgentIds": { + "input": { + "type": "structure", + "required": [ + "agentIds" + ], + "members": { + "agentIds": { + "shape": "St" + } + } + }, + "output": { + "type": "structure", + "members": { + "agentsConfigurationStatus": { + "shape": "S3f" + } + } + } + }, + "StartExportTask": { + "input": { + "type": "structure", + "members": { + "exportDataFormat": { + "type": "list", + "member": {} + }, + "filters": { + "shape": "S21" + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "exportId": {} + } + } + }, + "StartImportTask": { + "input": { + "type": "structure", + "required": [ + "name", + "importUrl" + ], + "members": { + "clientRequestToken": { + "idempotencyToken": true + }, + "name": {}, + "importUrl": {} + } + }, + "output": { + "type": "structure", + "members": { + "task": { + "shape": "S2e" + } + } + } + }, + "StopContinuousExport": { + "input": { + "type": "structure", + "required": [ + "exportId" + ], + "members": { + "exportId": {} + } + }, + "output": { + "type": "structure", + "members": { + "startTime": { + "type": "timestamp" + }, + "stopTime": { + "type": "timestamp" + } + } + } + }, + "StopDataCollectionByAgentIds": { + "input": { + "type": "structure", + "required": [ + "agentIds" + ], + "members": { + "agentIds": { + "shape": "St" + } + } + }, + "output": { + "type": "structure", + "members": { + "agentsConfigurationStatus": { + "shape": "S3f" + } + } + } + }, + "UpdateApplication": { + "input": { + "type": "structure", + "required": [ + "configurationId" + ], + "members": { + "configurationId": {}, + "name": {}, + "description": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": {} + }, + "Si": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "St": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "values", + "condition" + ], + "members": { + "name": {}, + "values": { + "shape": "Sx" + }, + "condition": {} + } + } + }, + "Sx": { + "type": "list", + "member": {} + }, + "S1o": { + "type": "map", + "key": {}, + "value": {} + }, + "S1r": { + "type": "list", + "member": {} + }, + "S1t": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "exportId", + "exportStatus", + "statusMessage", + "exportRequestTime" + ], + "members": { + "exportId": {}, + "exportStatus": {}, + "statusMessage": {}, + "configurationsDownloadUrl": {}, + "exportRequestTime": { + "type": "timestamp" + }, + "isTruncated": { + "type": "boolean" + }, + "requestedStartTime": { + "type": "timestamp" + }, + "requestedEndTime": { + "type": "timestamp" + } + } + } + }, + "S21": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "values", + "condition" + ], + "members": { + "name": {}, + "values": { + "shape": "Sx" + }, + "condition": {} + } + } + }, + "S2e": { + "type": "structure", + "members": { + "importTaskId": {}, + "clientRequestToken": {}, + "name": {}, + "importUrl": {}, + "status": {}, + "importRequestTime": { + "type": "timestamp" + }, + "importCompletionTime": { + "type": "timestamp" + }, + "importDeletedTime": { + "type": "timestamp" + }, + "serverImportSuccess": { + "type": "integer" + }, + "serverImportFailure": { + "type": "integer" + }, + "applicationImportSuccess": { + "type": "integer" + }, + "applicationImportFailure": { + "type": "integer" + }, + "errorsAndFailedEntriesZip": {} + } + }, + "S3f": { + "type": "list", + "member": { + "type": "structure", + "members": { + "agentId": {}, + "operationSucceeded": { + "type": "boolean" + }, + "description": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/discovery-2015-11-01.paginators.json b/node_modules/aws-sdk/apis/discovery-2015-11-01.paginators.json new file mode 100644 index 0000000..38fa172 --- /dev/null +++ b/node_modules/aws-sdk/apis/discovery-2015-11-01.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "DescribeContinuousExports": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "DescribeImportTasks": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/dlm-2018-01-12.examples.json b/node_modules/aws-sdk/apis/dlm-2018-01-12.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/dlm-2018-01-12.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/dlm-2018-01-12.min.json b/node_modules/aws-sdk/apis/dlm-2018-01-12.min.json new file mode 100644 index 0000000..84e1991 --- /dev/null +++ b/node_modules/aws-sdk/apis/dlm-2018-01-12.min.json @@ -0,0 +1,271 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-01-12", + "endpointPrefix": "dlm", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "Amazon DLM", + "serviceFullName": "Amazon Data Lifecycle Manager", + "serviceId": "DLM", + "signatureVersion": "v4", + "signingName": "dlm", + "uid": "dlm-2018-01-12" + }, + "operations": { + "CreateLifecyclePolicy": { + "http": { + "requestUri": "/policies" + }, + "input": { + "type": "structure", + "required": [ + "ExecutionRoleArn", + "Description", + "State", + "PolicyDetails" + ], + "members": { + "ExecutionRoleArn": {}, + "Description": {}, + "State": {}, + "PolicyDetails": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "PolicyId": {} + } + } + }, + "DeleteLifecyclePolicy": { + "http": { + "method": "DELETE", + "requestUri": "/policies/{policyId}/" + }, + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": { + "location": "uri", + "locationName": "policyId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetLifecyclePolicies": { + "http": { + "method": "GET", + "requestUri": "/policies" + }, + "input": { + "type": "structure", + "members": { + "PolicyIds": { + "location": "querystring", + "locationName": "policyIds", + "type": "list", + "member": {} + }, + "State": { + "location": "querystring", + "locationName": "state" + }, + "ResourceTypes": { + "shape": "S6", + "location": "querystring", + "locationName": "resourceTypes" + }, + "TargetTags": { + "location": "querystring", + "locationName": "targetTags", + "type": "list", + "member": {} + }, + "TagsToAdd": { + "location": "querystring", + "locationName": "tagsToAdd", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "Policies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyId": {}, + "Description": {}, + "State": {} + } + } + } + } + } + }, + "GetLifecyclePolicy": { + "http": { + "method": "GET", + "requestUri": "/policies/{policyId}/" + }, + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": { + "location": "uri", + "locationName": "policyId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": { + "type": "structure", + "members": { + "PolicyId": {}, + "Description": {}, + "State": {}, + "ExecutionRoleArn": {}, + "DateCreated": { + "shape": "S13" + }, + "DateModified": { + "shape": "S13" + }, + "PolicyDetails": { + "shape": "S5" + } + } + } + } + } + }, + "UpdateLifecyclePolicy": { + "http": { + "method": "PATCH", + "requestUri": "/policies/{policyId}" + }, + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": { + "location": "uri", + "locationName": "policyId" + }, + "ExecutionRoleArn": {}, + "State": {}, + "Description": {}, + "PolicyDetails": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "members": { + "ResourceTypes": { + "shape": "S6" + }, + "TargetTags": { + "type": "list", + "member": { + "shape": "S9" + } + }, + "Schedules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "CopyTags": { + "type": "boolean" + }, + "TagsToAdd": { + "type": "list", + "member": { + "shape": "S9" + } + }, + "CreateRule": { + "type": "structure", + "required": [ + "Interval", + "IntervalUnit" + ], + "members": { + "Interval": { + "type": "integer" + }, + "IntervalUnit": {}, + "Times": { + "type": "list", + "member": {} + } + } + }, + "RetainRule": { + "type": "structure", + "required": [ + "Count" + ], + "members": { + "Count": { + "type": "integer" + } + } + } + } + } + } + } + }, + "S6": { + "type": "list", + "member": {} + }, + "S9": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + }, + "S13": { + "type": "timestamp", + "timestampFormat": "iso8601" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/dlm-2018-01-12.paginators.json b/node_modules/aws-sdk/apis/dlm-2018-01-12.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/dlm-2018-01-12.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/dms-2016-01-01.examples.json b/node_modules/aws-sdk/apis/dms-2016-01-01.examples.json new file mode 100644 index 0000000..295fccf --- /dev/null +++ b/node_modules/aws-sdk/apis/dms-2016-01-01.examples.json @@ -0,0 +1,1053 @@ +{ + "version": "1.0", + "examples": { + "AddTagsToResource": [ + { + "input": { + "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "Tags": [ + { + "Key": "Acount", + "Value": "1633456" + } + ] + }, + "output": { + }, + "comments": { + "input": { + "ResourceArn": "Required. Use the ARN of the resource you want to tag.", + "Tags": "Required. Use the Key/Value pair format." + }, + "output": { + } + }, + "description": "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 AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.", + "id": "add-tags-to-resource-1481744141435", + "title": "Add tags to resource" + } + ], + "CreateEndpoint": [ + { + "input": { + "CertificateArn": "", + "DatabaseName": "testdb", + "EndpointIdentifier": "test-endpoint-1", + "EndpointType": "source", + "EngineName": "mysql", + "ExtraConnectionAttributes": "", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "Password": "pasword", + "Port": 3306, + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "SslMode": "require", + "Tags": [ + { + "Key": "Acount", + "Value": "143327655" + } + ], + "Username": "username" + }, + "output": { + "Endpoint": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "EndpointIdentifier": "test-endpoint-1", + "EndpointType": "source", + "EngineName": "mysql", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "Port": 3306, + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "Status": "active", + "Username": "username" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates an endpoint using the provided settings.", + "id": "create-endpoint-1481746254348", + "title": "Create endpoint" + } + ], + "CreateReplicationInstance": [ + { + "input": { + "AllocatedStorage": 123, + "AutoMinorVersionUpgrade": true, + "AvailabilityZone": "", + "EngineVersion": "", + "KmsKeyId": "", + "MultiAZ": true, + "PreferredMaintenanceWindow": "", + "PubliclyAccessible": true, + "ReplicationInstanceClass": "", + "ReplicationInstanceIdentifier": "", + "ReplicationSubnetGroupIdentifier": "", + "Tags": [ + { + "Key": "string", + "Value": "string" + } + ], + "VpcSecurityGroupIds": [ + + ] + }, + "output": { + "ReplicationInstance": { + "AllocatedStorage": 5, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "PendingModifiedValues": { + }, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "ReplicationInstanceStatus": "creating", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "ReplicationSubnetGroupIdentifier": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-3605751d", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-6741a603" + } + } + }, + "comments": { + "output": { + } + }, + "description": "Creates the replication instance using the specified parameters.", + "id": "create-replication-instance-1481746705295", + "title": "Create replication instance" + } + ], + "CreateReplicationSubnetGroup": [ + { + "input": { + "ReplicationSubnetGroupDescription": "US West subnet group", + "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366", + "SubnetIds": [ + "subnet-e145356n", + "subnet-58f79200" + ], + "Tags": [ + { + "Key": "Acount", + "Value": "145235" + } + ] + }, + "output": { + "ReplicationSubnetGroup": { + } + }, + "comments": { + "output": { + } + }, + "description": "Creates a replication subnet group given a list of the subnet IDs in a VPC.", + "id": "create-replication-subnet-group-1481747297930", + "title": "Create replication subnet group" + } + ], + "CreateReplicationTask": [ + { + "input": { + "CdcStartTime": "2016-12-14T18:25:43Z", + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "TableMappings": "file://mappingfile.json", + "Tags": [ + { + "Key": "Acount", + "Value": "24352226" + } + ], + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a replication task using the specified parameters.", + "id": "create-replication-task-1481747646288", + "title": "Create replication task" + } + ], + "DeleteCertificate": [ + { + "input": { + "CertificateArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ" + }, + "output": { + "Certificate": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified certificate.", + "id": "delete-certificate-1481751957981", + "title": "Delete Certificate" + } + ], + "DeleteEndpoint": [ + { + "input": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM" + }, + "output": { + "Endpoint": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "EndpointIdentifier": "test-endpoint-1", + "EndpointType": "source", + "EngineName": "mysql", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "Port": 3306, + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "Status": "active", + "Username": "username" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.\n", + "id": "delete-endpoint-1481752425530", + "title": "Delete Endpoint" + } + ], + "DeleteReplicationInstance": [ + { + "input": { + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "output": { + "ReplicationInstance": { + "AllocatedStorage": 5, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "PendingModifiedValues": { + }, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "ReplicationInstanceStatus": "creating", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "ReplicationSubnetGroupIdentifier": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-3605751d", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-6741a603" + } + } + }, + "comments": { + "output": { + } + }, + "description": "Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.\n\n", + "id": "delete-replication-instance-1481752552839", + "title": "Delete Replication Instance" + } + ], + "DeleteReplicationSubnetGroup": [ + { + "input": { + "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes a replication subnet group.", + "id": "delete-replication-subnet-group-1481752728597", + "title": "Delete Replication Subnet Group" + } + ], + "DeleteReplicationTask": [ + { + "input": { + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified replication task.", + "id": "delete-replication-task-1481752903506", + "title": "Delete Replication Task" + } + ], + "DescribeAccountAttributes": [ + { + "input": { + }, + "output": { + "AccountQuotas": [ + { + "AccountQuotaName": "ReplicationInstances", + "Max": 20, + "Used": 0 + }, + { + "AccountQuotaName": "AllocatedStorage", + "Max": 20, + "Used": 0 + }, + { + "AccountQuotaName": "Endpoints", + "Max": 20, + "Used": 0 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.", + "id": "describe-acount-attributes-1481753085663", + "title": "Describe acount attributes" + } + ], + "DescribeCertificates": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Certificates": [ + + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Provides a description of the certificate.", + "id": "describe-certificates-1481753186244", + "title": "Describe certificates" + } + ], + "DescribeConnections": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Connections": [ + { + "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "EndpointIdentifier": "testsrc1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceIdentifier": "test", + "Status": "successful" + } + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.", + "id": "describe-connections-1481754477953", + "title": "Describe connections" + } + ], + "DescribeEndpointTypes": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "SupportedEndpointTypes": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the type of endpoints available.", + "id": "describe-endpoint-types-1481754742591", + "title": "Describe endpoint types" + } + ], + "DescribeEndpoints": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Endpoints": [ + + ], + "Marker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the endpoints for your account in the current region.", + "id": "describe-endpoints-1481754926060", + "title": "Describe endpoints" + } + ], + "DescribeOrderableReplicationInstances": [ + { + "input": { + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "OrderableReplicationInstances": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the replication instance types that can be created in the specified region.", + "id": "describe-orderable-replication-instances-1481755123669", + "title": "Describe orderable replication instances" + } + ], + "DescribeRefreshSchemasStatus": [ + { + "input": { + "EndpointArn": "" + }, + "output": { + "RefreshSchemasStatus": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the status of the refresh-schemas operation.", + "id": "describe-refresh-schema-status-1481755303497", + "title": "Describe refresh schema status" + } + ], + "DescribeReplicationInstances": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "ReplicationInstances": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the status of the refresh-schemas operation.", + "id": "describe-replication-instances-1481755443952", + "title": "Describe replication instances" + } + ], + "DescribeReplicationSubnetGroups": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "ReplicationSubnetGroups": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the replication subnet groups.", + "id": "describe-replication-subnet-groups-1481755621284", + "title": "Describe replication subnet groups" + } + ], + "DescribeReplicationTasks": [ + { + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "ReplicationTasks": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about replication tasks for your account in the current region.", + "id": "describe-replication-tasks-1481755777563", + "title": "Describe replication tasks" + } + ], + "DescribeSchemas": [ + { + "input": { + "EndpointArn": "", + "Marker": "", + "MaxRecords": 123 + }, + "output": { + "Marker": "", + "Schemas": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the schema for the specified endpoint.", + "id": "describe-schemas-1481755933924", + "title": "Describe schemas" + } + ], + "DescribeTableStatistics": [ + { + "input": { + "Marker": "", + "MaxRecords": 123, + "ReplicationTaskArn": "" + }, + "output": { + "Marker": "", + "ReplicationTaskArn": "", + "TableStatistics": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.", + "id": "describe-table-statistics-1481756071890", + "title": "Describe table statistics" + } + ], + "ImportCertificate": [ + { + "input": { + "CertificateIdentifier": "", + "CertificatePem": "" + }, + "output": { + "Certificate": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Uploads the specified certificate.", + "id": "import-certificate-1481756197206", + "title": "Import certificate" + } + ], + "ListTagsForResource": [ + { + "input": { + "ResourceArn": "" + }, + "output": { + "TagList": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all tags for an AWS DMS resource.", + "id": "list-tags-for-resource-1481761095501", + "title": "List tags for resource" + } + ], + "ModifyEndpoint": [ + { + "input": { + "CertificateArn": "", + "DatabaseName": "", + "EndpointArn": "", + "EndpointIdentifier": "", + "EndpointType": "source", + "EngineName": "", + "ExtraConnectionAttributes": "", + "Password": "", + "Port": 123, + "ServerName": "", + "SslMode": "require", + "Username": "" + }, + "output": { + "Endpoint": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Modifies the specified endpoint.", + "id": "modify-endpoint-1481761649937", + "title": "Modify endpoint" + } + ], + "ModifyReplicationInstance": [ + { + "input": { + "AllocatedStorage": 123, + "AllowMajorVersionUpgrade": true, + "ApplyImmediately": true, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "MultiAZ": true, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "VpcSecurityGroupIds": [ + + ] + }, + "output": { + "ReplicationInstance": { + "AllocatedStorage": 5, + "AutoMinorVersionUpgrade": true, + "EngineVersion": "1.5.0", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "PendingModifiedValues": { + }, + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationInstanceIdentifier": "test-rep-1", + "ReplicationInstanceStatus": "available", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "ReplicationSubnetGroupIdentifier": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetIdentifier": "subnet-3605751d", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetStatus": "Active" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-6741a603" + } + } + }, + "comments": { + "output": { + } + }, + "description": "Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.", + "id": "modify-replication-instance-1481761784746", + "title": "Modify replication instance" + } + ], + "ModifyReplicationSubnetGroup": [ + { + "input": { + "ReplicationSubnetGroupDescription": "", + "ReplicationSubnetGroupIdentifier": "", + "SubnetIds": [ + + ] + }, + "output": { + "ReplicationSubnetGroup": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Modifies the settings for the specified replication subnet group.", + "id": "modify-replication-subnet-group-1481762275392", + "title": "Modify replication subnet group" + } + ], + "RefreshSchemas": [ + { + "input": { + "EndpointArn": "", + "ReplicationInstanceArn": "" + }, + "output": { + "RefreshSchemasStatus": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.", + "id": "refresh-schema-1481762399111", + "title": "Refresh schema" + } + ], + "RemoveTagsFromResource": [ + { + "input": { + "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "TagKeys": [ + + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Removes metadata tags from an AWS DMS resource.", + "id": "remove-tags-from-resource-1481762571330", + "title": "Remove tags from resource" + } + ], + "StartReplicationTask": [ + { + "input": { + "CdcStartTime": "2016-12-14T13:33:20Z", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "StartReplicationTaskType": "start-replication" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Starts the replication task.", + "id": "start-replication-task-1481762706778", + "title": "Start replication task" + } + ], + "StopReplicationTask": [ + { + "input": { + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + }, + "output": { + "ReplicationTask": { + "MigrationType": "full-load", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "ReplicationTaskIdentifier": "task1", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "Status": "creating", + "TableMappings": "file://mappingfile.json", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Stops the replication task.", + "id": "stop-replication-task-1481762924947", + "title": "Stop replication task" + } + ], + "TestConnection": [ + { + "input": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "output": { + "Connection": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Tests the connection between the replication instance and the endpoint.", + "id": "test-conection-1481763017636", + "title": "Test conection" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/dms-2016-01-01.min.json b/node_modules/aws-sdk/apis/dms-2016-01-01.min.json new file mode 100644 index 0000000..3894c8d --- /dev/null +++ b/node_modules/aws-sdk/apis/dms-2016-01-01.min.json @@ -0,0 +1,1838 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-01-01", + "endpointPrefix": "dms", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Database Migration Service", + "serviceId": "Database Migration Service", + "signatureVersion": "v4", + "targetPrefix": "AmazonDMSv20160101", + "uid": "dms-2016-01-01" + }, + "operations": { + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ApplyPendingMaintenanceAction": { + "input": { + "type": "structure", + "required": [ + "ReplicationInstanceArn", + "ApplyAction", + "OptInType" + ], + "members": { + "ReplicationInstanceArn": {}, + "ApplyAction": {}, + "OptInType": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourcePendingMaintenanceActions": { + "shape": "S8" + } + } + } + }, + "CreateEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointIdentifier", + "EndpointType", + "EngineName" + ], + "members": { + "EndpointIdentifier": {}, + "EndpointType": {}, + "EngineName": {}, + "Username": {}, + "Password": { + "shape": "Se" + }, + "ServerName": {}, + "Port": { + "type": "integer" + }, + "DatabaseName": {}, + "ExtraConnectionAttributes": {}, + "KmsKeyId": {}, + "Tags": { + "shape": "S3" + }, + "CertificateArn": {}, + "SslMode": {}, + "ServiceAccessRoleArn": {}, + "ExternalTableDefinition": {}, + "DynamoDbSettings": { + "shape": "Sh" + }, + "S3Settings": { + "shape": "Si" + }, + "DmsTransferSettings": { + "shape": "Sp" + }, + "MongoDbSettings": { + "shape": "Sq" + }, + "KinesisSettings": { + "shape": "Su" + }, + "ElasticsearchSettings": { + "shape": "Sw" + }, + "RedshiftSettings": { + "shape": "Sx" + } + } + }, + "output": { + "type": "structure", + "members": { + "Endpoint": { + "shape": "Sz" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S11" + }, + "SourceIds": { + "shape": "S12" + }, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S14" + } + } + } + }, + "CreateReplicationInstance": { + "input": { + "type": "structure", + "required": [ + "ReplicationInstanceIdentifier", + "ReplicationInstanceClass" + ], + "members": { + "ReplicationInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "ReplicationInstanceClass": {}, + "VpcSecurityGroupIds": { + "shape": "S17" + }, + "AvailabilityZone": {}, + "ReplicationSubnetGroupIdentifier": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Tags": { + "shape": "S3" + }, + "KmsKeyId": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "DnsNameServers": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationInstance": { + "shape": "S19" + } + } + } + }, + "CreateReplicationSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationSubnetGroupIdentifier", + "ReplicationSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "ReplicationSubnetGroupIdentifier": {}, + "ReplicationSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1l" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationSubnetGroup": { + "shape": "S1d" + } + } + } + }, + "CreateReplicationTask": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskIdentifier", + "SourceEndpointArn", + "TargetEndpointArn", + "ReplicationInstanceArn", + "MigrationType", + "TableMappings" + ], + "members": { + "ReplicationTaskIdentifier": {}, + "SourceEndpointArn": {}, + "TargetEndpointArn": {}, + "ReplicationInstanceArn": {}, + "MigrationType": {}, + "TableMappings": {}, + "ReplicationTaskSettings": {}, + "CdcStartTime": { + "type": "timestamp" + }, + "CdcStartPosition": {}, + "CdcStopPosition": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTask": { + "shape": "S1q" + } + } + } + }, + "DeleteCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateArn" + ], + "members": { + "CertificateArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": { + "shape": "S1v" + } + } + } + }, + "DeleteEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Endpoint": { + "shape": "Sz" + } + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S14" + } + } + } + }, + "DeleteReplicationInstance": { + "input": { + "type": "structure", + "required": [ + "ReplicationInstanceArn" + ], + "members": { + "ReplicationInstanceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationInstance": { + "shape": "S19" + } + } + } + }, + "DeleteReplicationSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationSubnetGroupIdentifier" + ], + "members": { + "ReplicationSubnetGroupIdentifier": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteReplicationTask": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskArn" + ], + "members": { + "ReplicationTaskArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTask": { + "shape": "S1q" + } + } + } + }, + "DescribeAccountAttributes": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AccountQuotas": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountQuotaName": {}, + "Used": { + "type": "long" + }, + "Max": { + "type": "long" + } + } + } + } + } + } + }, + "DescribeCertificates": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "Certificates": { + "type": "list", + "member": { + "shape": "S1v" + } + } + } + } + }, + "DescribeConnections": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "Connections": { + "type": "list", + "member": { + "shape": "S2k" + } + } + } + } + }, + "DescribeEndpointTypes": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "SupportedEndpointTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EngineName": {}, + "SupportsCDC": { + "type": "boolean" + }, + "EndpointType": {}, + "EngineDisplayName": {} + } + } + } + } + } + }, + "DescribeEndpoints": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "Endpoints": { + "type": "list", + "member": { + "shape": "Sz" + } + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {}, + "Filters": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "EventCategoryGroupList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S11" + } + } + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S14" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S11" + }, + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S11" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOrderableReplicationInstances": { + "input": { + "type": "structure", + "members": { + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "OrderableReplicationInstances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EngineVersion": {}, + "ReplicationInstanceClass": {}, + "StorageType": {}, + "MinAllocatedStorage": { + "type": "integer" + }, + "MaxAllocatedStorage": { + "type": "integer" + }, + "DefaultAllocatedStorage": { + "type": "integer" + }, + "IncludedAllocatedStorage": { + "type": "integer" + }, + "AvailabilityZones": { + "type": "list", + "member": {} + } + } + } + }, + "Marker": {} + } + } + }, + "DescribePendingMaintenanceActions": { + "input": { + "type": "structure", + "members": { + "ReplicationInstanceArn": {}, + "Filters": { + "shape": "S2c" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "Marker": {} + } + } + }, + "DescribeRefreshSchemasStatus": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "RefreshSchemasStatus": { + "shape": "S3e" + } + } + } + }, + "DescribeReplicationInstanceTaskLogs": { + "input": { + "type": "structure", + "required": [ + "ReplicationInstanceArn" + ], + "members": { + "ReplicationInstanceArn": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationInstanceArn": {}, + "ReplicationInstanceTaskLogs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ReplicationTaskName": {}, + "ReplicationTaskArn": {}, + "ReplicationInstanceTaskLogSize": { + "type": "long" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeReplicationInstances": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "ReplicationInstances": { + "type": "list", + "member": { + "shape": "S19" + } + } + } + } + }, + "DescribeReplicationSubnetGroups": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "ReplicationSubnetGroups": { + "type": "list", + "member": { + "shape": "S1d" + } + } + } + } + }, + "DescribeReplicationTaskAssessmentResults": { + "input": { + "type": "structure", + "members": { + "ReplicationTaskArn": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "BucketName": {}, + "ReplicationTaskAssessmentResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ReplicationTaskIdentifier": {}, + "ReplicationTaskArn": {}, + "ReplicationTaskLastAssessmentDate": { + "type": "timestamp" + }, + "AssessmentStatus": {}, + "AssessmentResultsFile": {}, + "AssessmentResults": {}, + "S3ObjectUrl": {} + } + } + } + } + } + }, + "DescribeReplicationTasks": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S2c" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "WithoutSettings": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "ReplicationTasks": { + "type": "list", + "member": { + "shape": "S1q" + } + } + } + } + }, + "DescribeSchemas": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "Schemas": { + "type": "list", + "member": {} + } + } + } + }, + "DescribeTableStatistics": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskArn" + ], + "members": { + "ReplicationTaskArn": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "Filters": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTaskArn": {}, + "TableStatistics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SchemaName": {}, + "TableName": {}, + "Inserts": { + "type": "long" + }, + "Deletes": { + "type": "long" + }, + "Updates": { + "type": "long" + }, + "Ddls": { + "type": "long" + }, + "FullLoadRows": { + "type": "long" + }, + "FullLoadCondtnlChkFailedRows": { + "type": "long" + }, + "FullLoadErrorRows": { + "type": "long" + }, + "LastUpdateTime": { + "type": "timestamp" + }, + "TableState": {}, + "ValidationPendingRecords": { + "type": "long" + }, + "ValidationFailedRecords": { + "type": "long" + }, + "ValidationSuspendedRecords": { + "type": "long" + }, + "ValidationState": {}, + "ValidationStateDetails": {} + } + } + }, + "Marker": {} + } + } + }, + "ImportCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateIdentifier" + ], + "members": { + "CertificateIdentifier": {}, + "CertificatePem": {}, + "CertificateWallet": { + "type": "blob" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": { + "shape": "S1v" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "TagList": { + "shape": "S3" + } + } + } + }, + "ModifyEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {}, + "EndpointIdentifier": {}, + "EndpointType": {}, + "EngineName": {}, + "Username": {}, + "Password": { + "shape": "Se" + }, + "ServerName": {}, + "Port": { + "type": "integer" + }, + "DatabaseName": {}, + "ExtraConnectionAttributes": {}, + "CertificateArn": {}, + "SslMode": {}, + "ServiceAccessRoleArn": {}, + "ExternalTableDefinition": {}, + "DynamoDbSettings": { + "shape": "Sh" + }, + "S3Settings": { + "shape": "Si" + }, + "DmsTransferSettings": { + "shape": "Sp" + }, + "MongoDbSettings": { + "shape": "Sq" + }, + "KinesisSettings": { + "shape": "Su" + }, + "ElasticsearchSettings": { + "shape": "Sw" + }, + "RedshiftSettings": { + "shape": "Sx" + } + } + }, + "output": { + "type": "structure", + "members": { + "Endpoint": { + "shape": "Sz" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S11" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S14" + } + } + } + }, + "ModifyReplicationInstance": { + "input": { + "type": "structure", + "required": [ + "ReplicationInstanceArn" + ], + "members": { + "ReplicationInstanceArn": {}, + "AllocatedStorage": { + "type": "integer" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "ReplicationInstanceClass": {}, + "VpcSecurityGroupIds": { + "shape": "S17" + }, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReplicationInstanceIdentifier": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationInstance": { + "shape": "S19" + } + } + } + }, + "ModifyReplicationSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationSubnetGroupIdentifier", + "SubnetIds" + ], + "members": { + "ReplicationSubnetGroupIdentifier": {}, + "ReplicationSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1l" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationSubnetGroup": { + "shape": "S1d" + } + } + } + }, + "ModifyReplicationTask": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskArn" + ], + "members": { + "ReplicationTaskArn": {}, + "ReplicationTaskIdentifier": {}, + "MigrationType": {}, + "TableMappings": {}, + "ReplicationTaskSettings": {}, + "CdcStartTime": { + "type": "timestamp" + }, + "CdcStartPosition": {}, + "CdcStopPosition": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTask": { + "shape": "S1q" + } + } + } + }, + "RebootReplicationInstance": { + "input": { + "type": "structure", + "required": [ + "ReplicationInstanceArn" + ], + "members": { + "ReplicationInstanceArn": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationInstance": { + "shape": "S19" + } + } + } + }, + "RefreshSchemas": { + "input": { + "type": "structure", + "required": [ + "EndpointArn", + "ReplicationInstanceArn" + ], + "members": { + "EndpointArn": {}, + "ReplicationInstanceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "RefreshSchemasStatus": { + "shape": "S3e" + } + } + } + }, + "ReloadTables": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskArn", + "TablesToReload" + ], + "members": { + "ReplicationTaskArn": {}, + "TablesToReload": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SchemaName": {}, + "TableName": {} + } + } + }, + "ReloadOption": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTaskArn": {} + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartReplicationTask": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskArn", + "StartReplicationTaskType" + ], + "members": { + "ReplicationTaskArn": {}, + "StartReplicationTaskType": {}, + "CdcStartTime": { + "type": "timestamp" + }, + "CdcStartPosition": {}, + "CdcStopPosition": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTask": { + "shape": "S1q" + } + } + } + }, + "StartReplicationTaskAssessment": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskArn" + ], + "members": { + "ReplicationTaskArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTask": { + "shape": "S1q" + } + } + } + }, + "StopReplicationTask": { + "input": { + "type": "structure", + "required": [ + "ReplicationTaskArn" + ], + "members": { + "ReplicationTaskArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationTask": { + "shape": "S1q" + } + } + } + }, + "TestConnection": { + "input": { + "type": "structure", + "required": [ + "ReplicationInstanceArn", + "EndpointArn" + ], + "members": { + "ReplicationInstanceArn": {}, + "EndpointArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Connection": { + "shape": "S2k" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S8": { + "type": "structure", + "members": { + "ResourceIdentifier": {}, + "PendingMaintenanceActionDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Action": {}, + "AutoAppliedAfterDate": { + "type": "timestamp" + }, + "ForcedApplyDate": { + "type": "timestamp" + }, + "OptInStatus": {}, + "CurrentApplyDate": { + "type": "timestamp" + }, + "Description": {} + } + } + } + } + }, + "Se": { + "type": "string", + "sensitive": true + }, + "Sh": { + "type": "structure", + "required": [ + "ServiceAccessRoleArn" + ], + "members": { + "ServiceAccessRoleArn": {} + } + }, + "Si": { + "type": "structure", + "members": { + "ServiceAccessRoleArn": {}, + "ExternalTableDefinition": {}, + "CsvRowDelimiter": {}, + "CsvDelimiter": {}, + "BucketFolder": {}, + "BucketName": {}, + "CompressionType": {}, + "EncryptionMode": {}, + "ServerSideEncryptionKmsKeyId": {}, + "DataFormat": {}, + "EncodingType": {}, + "DictPageSizeLimit": { + "type": "integer" + }, + "RowGroupLength": { + "type": "integer" + }, + "DataPageSize": { + "type": "integer" + }, + "ParquetVersion": {}, + "EnableStatistics": { + "type": "boolean" + }, + "CdcInsertsOnly": { + "type": "boolean" + } + } + }, + "Sp": { + "type": "structure", + "members": { + "ServiceAccessRoleArn": {}, + "BucketName": {} + } + }, + "Sq": { + "type": "structure", + "members": { + "Username": {}, + "Password": { + "shape": "Se" + }, + "ServerName": {}, + "Port": { + "type": "integer" + }, + "DatabaseName": {}, + "AuthType": {}, + "AuthMechanism": {}, + "NestingLevel": {}, + "ExtractDocId": {}, + "DocsToInvestigate": {}, + "AuthSource": {}, + "KmsKeyId": {} + } + }, + "Su": { + "type": "structure", + "members": { + "StreamArn": {}, + "MessageFormat": {}, + "ServiceAccessRoleArn": {} + } + }, + "Sw": { + "type": "structure", + "required": [ + "ServiceAccessRoleArn", + "EndpointUri" + ], + "members": { + "ServiceAccessRoleArn": {}, + "EndpointUri": {}, + "FullLoadErrorPercentage": { + "type": "integer" + }, + "ErrorRetryDuration": { + "type": "integer" + } + } + }, + "Sx": { + "type": "structure", + "members": { + "AcceptAnyDate": { + "type": "boolean" + }, + "AfterConnectScript": {}, + "BucketFolder": {}, + "BucketName": {}, + "ConnectionTimeout": { + "type": "integer" + }, + "DatabaseName": {}, + "DateFormat": {}, + "EmptyAsNull": { + "type": "boolean" + }, + "EncryptionMode": {}, + "FileTransferUploadStreams": { + "type": "integer" + }, + "LoadTimeout": { + "type": "integer" + }, + "MaxFileSize": { + "type": "integer" + }, + "Password": { + "shape": "Se" + }, + "Port": { + "type": "integer" + }, + "RemoveQuotes": { + "type": "boolean" + }, + "ReplaceInvalidChars": {}, + "ReplaceChars": {}, + "ServerName": {}, + "ServiceAccessRoleArn": {}, + "ServerSideEncryptionKmsKeyId": {}, + "TimeFormat": {}, + "TrimBlanks": { + "type": "boolean" + }, + "TruncateColumns": { + "type": "boolean" + }, + "Username": {}, + "WriteBufferSize": { + "type": "integer" + } + } + }, + "Sz": { + "type": "structure", + "members": { + "EndpointIdentifier": {}, + "EndpointType": {}, + "EngineName": {}, + "EngineDisplayName": {}, + "Username": {}, + "ServerName": {}, + "Port": { + "type": "integer" + }, + "DatabaseName": {}, + "ExtraConnectionAttributes": {}, + "Status": {}, + "KmsKeyId": {}, + "EndpointArn": {}, + "CertificateArn": {}, + "SslMode": {}, + "ServiceAccessRoleArn": {}, + "ExternalTableDefinition": {}, + "ExternalId": {}, + "DynamoDbSettings": { + "shape": "Sh" + }, + "S3Settings": { + "shape": "Si" + }, + "DmsTransferSettings": { + "shape": "Sp" + }, + "MongoDbSettings": { + "shape": "Sq" + }, + "KinesisSettings": { + "shape": "Su" + }, + "ElasticsearchSettings": { + "shape": "Sw" + }, + "RedshiftSettings": { + "shape": "Sx" + } + } + }, + "S11": { + "type": "list", + "member": {} + }, + "S12": { + "type": "list", + "member": {} + }, + "S14": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S12" + }, + "EventCategoriesList": { + "shape": "S11" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "S17": { + "type": "list", + "member": {} + }, + "S19": { + "type": "structure", + "members": { + "ReplicationInstanceIdentifier": {}, + "ReplicationInstanceClass": {}, + "ReplicationInstanceStatus": {}, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "VpcSecurityGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "AvailabilityZone": {}, + "ReplicationSubnetGroup": { + "shape": "S1d" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "ReplicationInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {} + } + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "KmsKeyId": {}, + "ReplicationInstanceArn": {}, + "ReplicationInstancePublicIpAddress": { + "deprecated": true + }, + "ReplicationInstancePrivateIpAddress": { + "deprecated": true + }, + "ReplicationInstancePublicIpAddresses": { + "type": "list", + "member": {} + }, + "ReplicationInstancePrivateIpAddresses": { + "type": "list", + "member": {} + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "SecondaryAvailabilityZone": {}, + "FreeUntil": { + "type": "timestamp" + }, + "DnsNameServers": {} + } + }, + "S1d": { + "type": "structure", + "members": { + "ReplicationSubnetGroupIdentifier": {}, + "ReplicationSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "type": "structure", + "members": { + "Name": {} + } + }, + "SubnetStatus": {} + } + } + } + } + }, + "S1l": { + "type": "list", + "member": {} + }, + "S1q": { + "type": "structure", + "members": { + "ReplicationTaskIdentifier": {}, + "SourceEndpointArn": {}, + "TargetEndpointArn": {}, + "ReplicationInstanceArn": {}, + "MigrationType": {}, + "TableMappings": {}, + "ReplicationTaskSettings": {}, + "Status": {}, + "LastFailureMessage": {}, + "StopReason": {}, + "ReplicationTaskCreationDate": { + "type": "timestamp" + }, + "ReplicationTaskStartDate": { + "type": "timestamp" + }, + "CdcStartPosition": {}, + "CdcStopPosition": {}, + "RecoveryCheckpoint": {}, + "ReplicationTaskArn": {}, + "ReplicationTaskStats": { + "type": "structure", + "members": { + "FullLoadProgressPercent": { + "type": "integer" + }, + "ElapsedTimeMillis": { + "type": "long" + }, + "TablesLoaded": { + "type": "integer" + }, + "TablesLoading": { + "type": "integer" + }, + "TablesQueued": { + "type": "integer" + }, + "TablesErrored": { + "type": "integer" + } + } + } + } + }, + "S1v": { + "type": "structure", + "members": { + "CertificateIdentifier": {}, + "CertificateCreationDate": { + "type": "timestamp" + }, + "CertificatePem": {}, + "CertificateWallet": { + "type": "blob" + }, + "CertificateArn": {}, + "CertificateOwner": {}, + "ValidFromDate": { + "type": "timestamp" + }, + "ValidToDate": { + "type": "timestamp" + }, + "SigningAlgorithm": {}, + "KeyLength": { + "type": "integer" + } + } + }, + "S2c": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "S2k": { + "type": "structure", + "members": { + "ReplicationInstanceArn": {}, + "EndpointArn": {}, + "Status": {}, + "LastFailureMessage": {}, + "EndpointIdentifier": {}, + "ReplicationInstanceIdentifier": {} + } + }, + "S3e": { + "type": "structure", + "members": { + "EndpointArn": {}, + "ReplicationInstanceArn": {}, + "Status": {}, + "LastRefreshDate": { + "type": "timestamp" + }, + "LastFailureMessage": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/dms-2016-01-01.paginators.json b/node_modules/aws-sdk/apis/dms-2016-01-01.paginators.json new file mode 100644 index 0000000..755ab79 --- /dev/null +++ b/node_modules/aws-sdk/apis/dms-2016-01-01.paginators.json @@ -0,0 +1,79 @@ +{ + "pagination": { + "DescribeCertificates": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeConnections": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEndpointTypes": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEndpoints": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeOrderableReplicationInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribePendingMaintenanceActions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationInstanceTaskLogs": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationTaskAssessmentResults": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationTasks": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeSchemas": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeTableStatistics": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords" + } + } +} diff --git a/node_modules/aws-sdk/apis/dms-2016-01-01.waiters2.json b/node_modules/aws-sdk/apis/dms-2016-01-01.waiters2.json new file mode 100644 index 0000000..ebfc736 --- /dev/null +++ b/node_modules/aws-sdk/apis/dms-2016-01-01.waiters2.json @@ -0,0 +1,336 @@ +{ + "version":2, + "waiters":{ + "TestConnectionSucceeds":{ + "acceptors":[ + { + "argument":"Connections[].Status", + "expected":"successful", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"Connections[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":5, + "description":"Wait until testing connection succeeds.", + "maxAttempts":60, + "operation":"DescribeConnections" + }, + "EndpointDeleted":{ + "acceptors":[ + { + "expected":"ResourceNotFoundFault", + "matcher":"error", + "state":"success" + }, + { + "argument":"Endpoints[].Status", + "expected":"active", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"Endpoints[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":5, + "description":"Wait until testing endpoint is deleted.", + "maxAttempts":60, + "operation":"DescribeEndpoints" + }, + "ReplicationInstanceAvailable":{ + "acceptors":[ + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"available", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"incompatible-credentials", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"incompatible-network", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"inaccessible-encryption-credentials", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":60, + "description":"Wait until DMS replication instance is available.", + "maxAttempts":60, + "operation":"DescribeReplicationInstances" + }, + "ReplicationInstanceDeleted":{ + "acceptors":[ + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"available", + "matcher":"pathAny", + "state":"failure" + }, + { + "expected":"ResourceNotFoundFault", + "matcher":"error", + "state":"success" + } + ], + "delay":15, + "description":"Wait until DMS replication instance is deleted.", + "maxAttempts":60, + "operation":"DescribeReplicationInstances" + }, + "ReplicationTaskReady":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"starting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopping", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"testing", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until DMS replication task is ready.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + }, + "ReplicationTaskStopped":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"starting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"testing", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until DMS replication task is stopped.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + }, + "ReplicationTaskRunning":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopping", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"testing", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until DMS replication task is running.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + }, + "ReplicationTaskDeleted":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "expected":"ResourceNotFoundFault", + "matcher":"error", + "state":"success" + } + ], + "delay":15, + "description":"Wait until DMS replication task is deleted.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + } + } +} diff --git a/node_modules/aws-sdk/apis/docdb-2014-10-31.examples.json b/node_modules/aws-sdk/apis/docdb-2014-10-31.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/docdb-2014-10-31.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json b/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json new file mode 100644 index 0000000..99a659a --- /dev/null +++ b/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json @@ -0,0 +1,1606 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-10-31", + "endpointPrefix": "rds", + "protocol": "query", + "serviceAbbreviation": "Amazon DocDB", + "serviceFullName": "Amazon DocumentDB with MongoDB compatibility", + "serviceId": "DocDB", + "signatureVersion": "v4", + "signingName": "rds", + "uid": "docdb-2014-10-31", + "xmlNamespace": "http://rds.amazonaws.com/doc/2014-10-31/" + }, + "operations": { + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S3" + } + } + } + }, + "ApplyPendingMaintenanceAction": { + "input": { + "type": "structure", + "required": [ + "ResourceIdentifier", + "ApplyAction", + "OptInType" + ], + "members": { + "ResourceIdentifier": {}, + "ApplyAction": {}, + "OptInType": {} + } + }, + "output": { + "resultWrapper": "ApplyPendingMaintenanceActionResult", + "type": "structure", + "members": { + "ResourcePendingMaintenanceActions": { + "shape": "S7" + } + } + } + }, + "CopyDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "SourceDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupDescription" + ], + "members": { + "SourceDBClusterParameterGroupIdentifier": {}, + "TargetDBClusterParameterGroupIdentifier": {}, + "TargetDBClusterParameterGroupDescription": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "resultWrapper": "CopyDBClusterParameterGroupResult", + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members": { + "SourceDBClusterSnapshotIdentifier": {}, + "TargetDBClusterSnapshotIdentifier": {}, + "KmsKeyId": {}, + "PreSignedUrl": {}, + "CopyTags": { + "type": "boolean" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "resultWrapper": "CopyDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "Sh" + } + } + } + }, + "CreateDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "Engine" + ], + "members": { + "AvailabilityZones": { + "shape": "Si" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBClusterIdentifier": {}, + "DBClusterParameterGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sn" + }, + "DBSubnetGroupName": {}, + "Engine": {}, + "EngineVersion": {}, + "Port": { + "type": "integer" + }, + "MasterUsername": {}, + "MasterUserPassword": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "Tags": { + "shape": "S3" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "EnableCloudwatchLogsExports": { + "shape": "So" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sq" + } + } + } + }, + "CreateDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBClusterParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterParameterGroupResult", + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {}, + "DBClusterIdentifier": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "Sh" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine", + "DBClusterIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "AvailabilityZone": {}, + "PreferredMaintenanceWindow": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Tags": { + "shape": "S3" + }, + "DBClusterIdentifier": {}, + "PromotionTier": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S13" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1e" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S15" + } + } + } + }, + "DeleteDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sq" + } + } + } + }, + "DeleteDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {} + } + } + }, + "DeleteDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "Sh" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S13" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DescribeDBClusterParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterParameterGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBClusterParameterGroup" + } + } + } + } + }, + "DescribeDBClusterParameters": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {}, + "Source": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S1w" + }, + "Marker": {} + } + } + }, + "DescribeDBClusterSnapshotAttributes": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterSnapshotAttributesResult", + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "shape": "S21" + } + } + } + }, + "DescribeDBClusterSnapshots": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "DBClusterSnapshotIdentifier": {}, + "SnapshotType": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "IncludeShared": { + "type": "boolean" + }, + "IncludePublic": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBClusterSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterSnapshots": { + "type": "list", + "member": { + "shape": "Sh", + "locationName": "DBClusterSnapshot" + } + } + } + } + }, + "DescribeDBClusters": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusters": { + "type": "list", + "member": { + "shape": "Sq", + "locationName": "DBCluster" + } + } + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + }, + "ListSupportedTimezones": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "ValidUpgradeTarget": { + "type": "list", + "member": { + "locationName": "UpgradeTarget", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "Description": {}, + "AutoUpgrade": { + "type": "boolean" + }, + "IsMajorVersionUpgrade": { + "type": "boolean" + } + } + } + }, + "ExportableLogTypes": { + "shape": "So" + }, + "SupportsLogExportsToCloudwatchLogs": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "S13", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S15", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultClusterParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultClusterParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S1w" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {}, + "Filters": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S2u" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S2u" + }, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S2u" + }, + "Date": { + "type": "timestamp" + }, + "SourceArn": {} + } + } + } + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "Filters": { + "shape": "S1p" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S18", + "locationName": "AvailabilityZone" + } + }, + "Vpc": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribePendingMaintenanceActions": { + "input": { + "type": "structure", + "members": { + "ResourceIdentifier": {}, + "Filters": { + "shape": "S1p" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribePendingMaintenanceActionsResult", + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "type": "list", + "member": { + "shape": "S7", + "locationName": "ResourcePendingMaintenanceActions" + } + }, + "Marker": {} + } + } + }, + "FailoverDBCluster": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "TargetDBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "FailoverDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sq" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {}, + "Filters": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S3" + } + } + } + }, + "ModifyDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "NewDBClusterIdentifier": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBClusterParameterGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sn" + }, + "Port": { + "type": "integer" + }, + "MasterUserPassword": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "CloudwatchLogsExportConfiguration": { + "type": "structure", + "members": { + "EnableLogTypes": { + "shape": "So" + }, + "DisableLogTypes": { + "shape": "So" + } + } + }, + "EngineVersion": {} + } + }, + "output": { + "resultWrapper": "ModifyDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sq" + } + } + } + }, + "ModifyDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName", + "Parameters" + ], + "members": { + "DBClusterParameterGroupName": {}, + "Parameters": { + "shape": "S1w" + } + } + }, + "output": { + "shape": "S3g", + "resultWrapper": "ModifyDBClusterParameterGroupResult" + } + }, + "ModifyDBClusterSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier", + "AttributeName" + ], + "members": { + "DBClusterSnapshotIdentifier": {}, + "AttributeName": {}, + "ValuesToAdd": { + "shape": "S24" + }, + "ValuesToRemove": { + "shape": "S24" + } + } + }, + "output": { + "resultWrapper": "ModifyDBClusterSnapshotAttributeResult", + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "shape": "S21" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "PreferredMaintenanceWindow": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "NewDBInstanceIdentifier": {}, + "PromotionTier": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S13" + } + } + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1e" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S15" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S13" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S1w" + } + } + }, + "output": { + "shape": "S3g", + "resultWrapper": "ResetDBClusterParameterGroupResult" + } + }, + "RestoreDBClusterFromSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members": { + "AvailabilityZones": { + "shape": "Si" + }, + "DBClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "Engine": {}, + "EngineVersion": {}, + "Port": { + "type": "integer" + }, + "DBSubnetGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sn" + }, + "Tags": { + "shape": "S3" + }, + "KmsKeyId": {}, + "EnableCloudwatchLogsExports": { + "shape": "So" + } + } + }, + "output": { + "resultWrapper": "RestoreDBClusterFromSnapshotResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sq" + } + } + } + }, + "RestoreDBClusterToPointInTime": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "SourceDBClusterIdentifier": {}, + "RestoreToTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "DBSubnetGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sn" + }, + "Tags": { + "shape": "S3" + }, + "KmsKeyId": {}, + "EnableCloudwatchLogsExports": { + "shape": "So" + } + } + }, + "output": { + "resultWrapper": "RestoreDBClusterToPointInTimeResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sq" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S7": { + "type": "structure", + "members": { + "ResourceIdentifier": {}, + "PendingMaintenanceActionDetails": { + "type": "list", + "member": { + "locationName": "PendingMaintenanceAction", + "type": "structure", + "members": { + "Action": {}, + "AutoAppliedAfterDate": { + "type": "timestamp" + }, + "ForcedApplyDate": { + "type": "timestamp" + }, + "OptInStatus": {}, + "CurrentApplyDate": { + "type": "timestamp" + }, + "Description": {} + } + } + } + }, + "wrapper": true + }, + "Sd": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "DBClusterParameterGroupArn": {} + }, + "wrapper": true + }, + "Sh": { + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "Si" + }, + "DBClusterSnapshotIdentifier": {}, + "DBClusterIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "Status": {}, + "Port": { + "type": "integer" + }, + "VpcId": {}, + "ClusterCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "SnapshotType": {}, + "PercentProgress": { + "type": "integer" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DBClusterSnapshotArn": {}, + "SourceDBClusterSnapshotArn": {} + }, + "wrapper": true + }, + "Si": { + "type": "list", + "member": { + "locationName": "AvailabilityZone" + } + }, + "Sn": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "So": { + "type": "list", + "member": {} + }, + "Sq": { + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "Si" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBClusterIdentifier": {}, + "DBClusterParameterGroup": {}, + "DBSubnetGroup": {}, + "Status": {}, + "PercentProgress": {}, + "EarliestRestorableTime": { + "type": "timestamp" + }, + "Endpoint": {}, + "ReaderEndpoint": {}, + "MultiAZ": { + "type": "boolean" + }, + "Engine": {}, + "EngineVersion": {}, + "LatestRestorableTime": { + "type": "timestamp" + }, + "Port": { + "type": "integer" + }, + "MasterUsername": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "DBClusterMembers": { + "type": "list", + "member": { + "locationName": "DBClusterMember", + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "IsClusterWriter": { + "type": "boolean" + }, + "DBClusterParameterGroupStatus": {}, + "PromotionTier": { + "type": "integer" + } + }, + "wrapper": true + } + }, + "VpcSecurityGroups": { + "shape": "St" + }, + "HostedZoneId": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DbClusterResourceId": {}, + "DBClusterArn": {}, + "AssociatedRoles": { + "type": "list", + "member": { + "locationName": "DBClusterRole", + "type": "structure", + "members": { + "RoleArn": {}, + "Status": {} + } + } + }, + "ClusterCreateTime": { + "type": "timestamp" + }, + "EnabledCloudwatchLogsExports": { + "shape": "So" + } + }, + "wrapper": true + }, + "St": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S13": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + }, + "HostedZoneId": {} + } + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "VpcSecurityGroups": { + "shape": "St" + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S15" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {}, + "StorageType": {}, + "CACertificateIdentifier": {}, + "DBSubnetGroupName": {}, + "PendingCloudwatchLogsExports": { + "type": "structure", + "members": { + "LogTypesToEnable": { + "shape": "So" + }, + "LogTypesToDisable": { + "shape": "So" + } + } + } + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "StatusInfos": { + "type": "list", + "member": { + "locationName": "DBInstanceStatusInfo", + "type": "structure", + "members": { + "StatusType": {}, + "Normal": { + "type": "boolean" + }, + "Status": {}, + "Message": {} + } + } + }, + "DBClusterIdentifier": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DbiResourceId": {}, + "PromotionTier": { + "type": "integer" + }, + "DBInstanceArn": {}, + "EnabledCloudwatchLogsExports": { + "shape": "So" + } + }, + "wrapper": true + }, + "S15": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S18" + }, + "SubnetStatus": {} + } + } + }, + "DBSubnetGroupArn": {} + }, + "wrapper": true + }, + "S18": { + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + }, + "S1e": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1p": { + "type": "list", + "member": { + "locationName": "Filter", + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": { + "locationName": "Value" + } + } + } + } + }, + "S1w": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S21": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": {}, + "DBClusterSnapshotAttributes": { + "type": "list", + "member": { + "locationName": "DBClusterSnapshotAttribute", + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValues": { + "shape": "S24" + } + } + } + } + }, + "wrapper": true + }, + "S24": { + "type": "list", + "member": { + "locationName": "AttributeValue" + } + }, + "S2u": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S3g": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/docdb-2014-10-31.paginators.json b/node_modules/aws-sdk/apis/docdb-2014-10-31.paginators.json new file mode 100644 index 0000000..7d90697 --- /dev/null +++ b/node_modules/aws-sdk/apis/docdb-2014-10-31.paginators.json @@ -0,0 +1,43 @@ +{ + "pagination": { + "DescribeDBClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusters" + }, + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/docdb-2014-10-31.waiters2.json b/node_modules/aws-sdk/apis/docdb-2014-10-31.waiters2.json new file mode 100644 index 0000000..e75f03b --- /dev/null +++ b/node_modules/aws-sdk/apis/docdb-2014-10-31.waiters2.json @@ -0,0 +1,90 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "DBInstanceNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/ds-2015-04-16.examples.json b/node_modules/aws-sdk/apis/ds-2015-04-16.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/ds-2015-04-16.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/ds-2015-04-16.min.json b/node_modules/aws-sdk/apis/ds-2015-04-16.min.json new file mode 100644 index 0000000..6198465 --- /dev/null +++ b/node_modules/aws-sdk/apis/ds-2015-04-16.min.json @@ -0,0 +1,1484 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-04-16", + "endpointPrefix": "ds", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Directory Service", + "serviceFullName": "AWS Directory Service", + "serviceId": "Directory Service", + "signatureVersion": "v4", + "targetPrefix": "DirectoryService_20150416", + "uid": "ds-2015-04-16" + }, + "operations": { + "AcceptSharedDirectory": { + "input": { + "type": "structure", + "required": [ + "SharedDirectoryId" + ], + "members": { + "SharedDirectoryId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SharedDirectory": { + "shape": "S4" + } + } + } + }, + "AddIpRoutes": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "IpRoutes" + ], + "members": { + "DirectoryId": {}, + "IpRoutes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CidrIp": {}, + "Description": {} + } + } + }, + "UpdateSecurityGroupForDirectoryControllers": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "Tags" + ], + "members": { + "ResourceId": {}, + "Tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelSchemaExtension": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "SchemaExtensionId" + ], + "members": { + "DirectoryId": {}, + "SchemaExtensionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ConnectDirectory": { + "input": { + "type": "structure", + "required": [ + "Name", + "Password", + "Size", + "ConnectSettings" + ], + "members": { + "Name": {}, + "ShortName": {}, + "Password": { + "shape": "Sv" + }, + "Description": {}, + "Size": {}, + "ConnectSettings": { + "type": "structure", + "required": [ + "VpcId", + "SubnetIds", + "CustomerDnsIps", + "CustomerUserName" + ], + "members": { + "VpcId": {}, + "SubnetIds": { + "shape": "Sz" + }, + "CustomerDnsIps": { + "shape": "S11" + }, + "CustomerUserName": {} + } + }, + "Tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryId": {} + } + } + }, + "CreateAlias": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "Alias" + ], + "members": { + "DirectoryId": {}, + "Alias": {} + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryId": {}, + "Alias": {} + } + } + }, + "CreateComputer": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "ComputerName", + "Password" + ], + "members": { + "DirectoryId": {}, + "ComputerName": {}, + "Password": { + "type": "string", + "sensitive": true + }, + "OrganizationalUnitDistinguishedName": {}, + "ComputerAttributes": { + "shape": "S1c" + } + } + }, + "output": { + "type": "structure", + "members": { + "Computer": { + "type": "structure", + "members": { + "ComputerId": {}, + "ComputerName": {}, + "ComputerAttributes": { + "shape": "S1c" + } + } + } + } + } + }, + "CreateConditionalForwarder": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "RemoteDomainName", + "DnsIpAddrs" + ], + "members": { + "DirectoryId": {}, + "RemoteDomainName": {}, + "DnsIpAddrs": { + "shape": "S11" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateDirectory": { + "input": { + "type": "structure", + "required": [ + "Name", + "Password", + "Size" + ], + "members": { + "Name": {}, + "ShortName": {}, + "Password": { + "shape": "S1n" + }, + "Description": {}, + "Size": {}, + "VpcSettings": { + "shape": "S1o" + }, + "Tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryId": {} + } + } + }, + "CreateLogSubscription": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "LogGroupName" + ], + "members": { + "DirectoryId": {}, + "LogGroupName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateMicrosoftAD": { + "input": { + "type": "structure", + "required": [ + "Name", + "Password", + "VpcSettings" + ], + "members": { + "Name": {}, + "ShortName": {}, + "Password": { + "shape": "S1n" + }, + "Description": {}, + "VpcSettings": { + "shape": "S1o" + }, + "Edition": {}, + "Tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryId": {} + } + } + }, + "CreateSnapshot": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotId": {} + } + } + }, + "CreateTrust": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "RemoteDomainName", + "TrustPassword", + "TrustDirection" + ], + "members": { + "DirectoryId": {}, + "RemoteDomainName": {}, + "TrustPassword": { + "type": "string", + "sensitive": true + }, + "TrustDirection": {}, + "TrustType": {}, + "ConditionalForwarderIpAddrs": { + "shape": "S11" + }, + "SelectiveAuth": {} + } + }, + "output": { + "type": "structure", + "members": { + "TrustId": {} + } + } + }, + "DeleteConditionalForwarder": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "RemoteDomainName" + ], + "members": { + "DirectoryId": {}, + "RemoteDomainName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDirectory": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryId": {} + } + } + }, + "DeleteLogSubscription": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotId" + ], + "members": { + "SnapshotId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotId": {} + } + } + }, + "DeleteTrust": { + "input": { + "type": "structure", + "required": [ + "TrustId" + ], + "members": { + "TrustId": {}, + "DeleteAssociatedConditionalForwarder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TrustId": {} + } + } + }, + "DeregisterEventTopic": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "TopicName" + ], + "members": { + "DirectoryId": {}, + "TopicName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeConditionalForwarders": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {}, + "RemoteDomainNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "ConditionalForwarders": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RemoteDomainName": {}, + "DnsIpAddrs": { + "shape": "S11" + }, + "ReplicationScope": {} + } + } + } + } + } + }, + "DescribeDirectories": { + "input": { + "type": "structure", + "members": { + "DirectoryIds": { + "shape": "S2s" + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DirectoryDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "Name": {}, + "ShortName": {}, + "Size": {}, + "Edition": {}, + "Alias": {}, + "AccessUrl": {}, + "Description": {}, + "DnsIpAddrs": { + "shape": "S11" + }, + "Stage": {}, + "ShareStatus": {}, + "ShareMethod": {}, + "ShareNotes": { + "shape": "S8" + }, + "LaunchTime": { + "type": "timestamp" + }, + "StageLastUpdatedDateTime": { + "type": "timestamp" + }, + "Type": {}, + "VpcSettings": { + "shape": "S32" + }, + "ConnectSettings": { + "type": "structure", + "members": { + "VpcId": {}, + "SubnetIds": { + "shape": "Sz" + }, + "CustomerUserName": {}, + "SecurityGroupId": {}, + "AvailabilityZones": { + "shape": "S34" + }, + "ConnectIps": { + "type": "list", + "member": {} + } + } + }, + "RadiusSettings": { + "shape": "S38" + }, + "RadiusStatus": {}, + "StageReason": {}, + "SsoEnabled": { + "type": "boolean" + }, + "DesiredNumberOfDomainControllers": { + "type": "integer" + }, + "OwnerDirectoryDescription": { + "type": "structure", + "members": { + "DirectoryId": {}, + "AccountId": {}, + "DnsIpAddrs": { + "shape": "S11" + }, + "VpcSettings": { + "shape": "S32" + }, + "RadiusSettings": { + "shape": "S38" + }, + "RadiusStatus": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeDomainControllers": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {}, + "DomainControllerIds": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DomainControllers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "DomainControllerId": {}, + "DnsIpAddr": {}, + "VpcId": {}, + "SubnetId": {}, + "AvailabilityZone": {}, + "Status": {}, + "StatusReason": {}, + "LaunchTime": { + "type": "timestamp" + }, + "StatusLastUpdatedDateTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeEventTopics": { + "input": { + "type": "structure", + "members": { + "DirectoryId": {}, + "TopicNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "EventTopics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "TopicName": {}, + "TopicArn": {}, + "CreatedDateTime": { + "type": "timestamp" + }, + "Status": {} + } + } + } + } + } + }, + "DescribeSharedDirectories": { + "input": { + "type": "structure", + "required": [ + "OwnerDirectoryId" + ], + "members": { + "OwnerDirectoryId": {}, + "SharedDirectoryIds": { + "shape": "S2s" + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SharedDirectories": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "NextToken": {} + } + } + }, + "DescribeSnapshots": { + "input": { + "type": "structure", + "members": { + "DirectoryId": {}, + "SnapshotIds": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Snapshots": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "SnapshotId": {}, + "Type": {}, + "Name": {}, + "Status": {}, + "StartTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeTrusts": { + "input": { + "type": "structure", + "members": { + "DirectoryId": {}, + "TrustIds": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Trusts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "TrustId": {}, + "RemoteDomainName": {}, + "TrustType": {}, + "TrustDirection": {}, + "TrustState": {}, + "CreatedDateTime": { + "type": "timestamp" + }, + "LastUpdatedDateTime": { + "type": "timestamp" + }, + "StateLastUpdatedDateTime": { + "type": "timestamp" + }, + "TrustStateReason": {}, + "SelectiveAuth": {} + } + } + }, + "NextToken": {} + } + } + }, + "DisableRadius": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisableSso": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {}, + "UserName": {}, + "Password": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "EnableRadius": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "RadiusSettings" + ], + "members": { + "DirectoryId": {}, + "RadiusSettings": { + "shape": "S38" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "EnableSso": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {}, + "UserName": {}, + "Password": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetDirectoryLimits": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "DirectoryLimits": { + "type": "structure", + "members": { + "CloudOnlyDirectoriesLimit": { + "type": "integer" + }, + "CloudOnlyDirectoriesCurrentCount": { + "type": "integer" + }, + "CloudOnlyDirectoriesLimitReached": { + "type": "boolean" + }, + "CloudOnlyMicrosoftADLimit": { + "type": "integer" + }, + "CloudOnlyMicrosoftADCurrentCount": { + "type": "integer" + }, + "CloudOnlyMicrosoftADLimitReached": { + "type": "boolean" + }, + "ConnectedDirectoriesLimit": { + "type": "integer" + }, + "ConnectedDirectoriesCurrentCount": { + "type": "integer" + }, + "ConnectedDirectoriesLimitReached": { + "type": "boolean" + } + } + } + } + } + }, + "GetSnapshotLimits": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotLimits": { + "type": "structure", + "members": { + "ManualSnapshotsLimit": { + "type": "integer" + }, + "ManualSnapshotsCurrentCount": { + "type": "integer" + }, + "ManualSnapshotsLimitReached": { + "type": "boolean" + } + } + } + } + } + }, + "ListIpRoutes": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "IpRoutesInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "CidrIp": {}, + "IpRouteStatusMsg": {}, + "AddedDateTime": { + "type": "timestamp" + }, + "IpRouteStatusReason": {}, + "Description": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListLogSubscriptions": { + "input": { + "type": "structure", + "members": { + "DirectoryId": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "LogSubscriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "LogGroupName": {}, + "SubscriptionCreatedDateTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListSchemaExtensions": { + "input": { + "type": "structure", + "required": [ + "DirectoryId" + ], + "members": { + "DirectoryId": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SchemaExtensionsInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "SchemaExtensionId": {}, + "Description": {}, + "SchemaExtensionStatus": {}, + "SchemaExtensionStatusReason": {}, + "StartDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "ResourceId": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sk" + }, + "NextToken": {} + } + } + }, + "RegisterEventTopic": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "TopicName" + ], + "members": { + "DirectoryId": {}, + "TopicName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RejectSharedDirectory": { + "input": { + "type": "structure", + "required": [ + "SharedDirectoryId" + ], + "members": { + "SharedDirectoryId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SharedDirectoryId": {} + } + } + }, + "RemoveIpRoutes": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "CidrIps" + ], + "members": { + "DirectoryId": {}, + "CidrIps": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagKeys" + ], + "members": { + "ResourceId": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ResetUserPassword": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "UserName", + "NewPassword" + ], + "members": { + "DirectoryId": {}, + "UserName": {}, + "NewPassword": { + "type": "string", + "sensitive": true + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RestoreFromSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotId" + ], + "members": { + "SnapshotId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ShareDirectory": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "ShareTarget", + "ShareMethod" + ], + "members": { + "DirectoryId": {}, + "ShareNotes": { + "shape": "S8" + }, + "ShareTarget": { + "type": "structure", + "required": [ + "Id", + "Type" + ], + "members": { + "Id": {}, + "Type": {} + } + }, + "ShareMethod": {} + } + }, + "output": { + "type": "structure", + "members": { + "SharedDirectoryId": {} + } + } + }, + "StartSchemaExtension": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "CreateSnapshotBeforeSchemaExtension", + "LdifContent", + "Description" + ], + "members": { + "DirectoryId": {}, + "CreateSnapshotBeforeSchemaExtension": { + "type": "boolean" + }, + "LdifContent": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "SchemaExtensionId": {} + } + } + }, + "UnshareDirectory": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "UnshareTarget" + ], + "members": { + "DirectoryId": {}, + "UnshareTarget": { + "type": "structure", + "required": [ + "Id", + "Type" + ], + "members": { + "Id": {}, + "Type": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SharedDirectoryId": {} + } + } + }, + "UpdateConditionalForwarder": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "RemoteDomainName", + "DnsIpAddrs" + ], + "members": { + "DirectoryId": {}, + "RemoteDomainName": {}, + "DnsIpAddrs": { + "shape": "S11" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateNumberOfDomainControllers": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "DesiredNumber" + ], + "members": { + "DirectoryId": {}, + "DesiredNumber": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateRadius": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "RadiusSettings" + ], + "members": { + "DirectoryId": {}, + "RadiusSettings": { + "shape": "S38" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateTrust": { + "input": { + "type": "structure", + "required": [ + "TrustId" + ], + "members": { + "TrustId": {}, + "SelectiveAuth": {} + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "TrustId": {} + } + } + }, + "VerifyTrust": { + "input": { + "type": "structure", + "required": [ + "TrustId" + ], + "members": { + "TrustId": {} + } + }, + "output": { + "type": "structure", + "members": { + "TrustId": {} + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "OwnerAccountId": {}, + "OwnerDirectoryId": {}, + "ShareMethod": {}, + "SharedAccountId": {}, + "SharedDirectoryId": {}, + "ShareStatus": {}, + "ShareNotes": { + "shape": "S8" + }, + "CreatedDateTime": { + "type": "timestamp" + }, + "LastUpdatedDateTime": { + "type": "timestamp" + } + } + }, + "S8": { + "type": "string", + "sensitive": true + }, + "Sk": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sv": { + "type": "string", + "sensitive": true + }, + "Sz": { + "type": "list", + "member": {} + }, + "S11": { + "type": "list", + "member": {} + }, + "S1c": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Value": {} + } + } + }, + "S1n": { + "type": "string", + "sensitive": true + }, + "S1o": { + "type": "structure", + "required": [ + "VpcId", + "SubnetIds" + ], + "members": { + "VpcId": {}, + "SubnetIds": { + "shape": "Sz" + } + } + }, + "S2s": { + "type": "list", + "member": {} + }, + "S32": { + "type": "structure", + "members": { + "VpcId": {}, + "SubnetIds": { + "shape": "Sz" + }, + "SecurityGroupId": {}, + "AvailabilityZones": { + "shape": "S34" + } + } + }, + "S34": { + "type": "list", + "member": {} + }, + "S38": { + "type": "structure", + "members": { + "RadiusServers": { + "type": "list", + "member": {} + }, + "RadiusPort": { + "type": "integer" + }, + "RadiusTimeout": { + "type": "integer" + }, + "RadiusRetries": { + "type": "integer" + }, + "SharedSecret": { + "type": "string", + "sensitive": true + }, + "AuthenticationProtocol": {}, + "DisplayLabel": {}, + "UseSameUsername": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ds-2015-04-16.paginators.json b/node_modules/aws-sdk/apis/ds-2015-04-16.paginators.json new file mode 100644 index 0000000..da0b872 --- /dev/null +++ b/node_modules/aws-sdk/apis/ds-2015-04-16.paginators.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "DescribeDomainControllers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit" + } + } +} diff --git a/node_modules/aws-sdk/apis/dynamodb-2011-12-05.examples.json b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/dynamodb-2011-12-05.min.json b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.min.json new file mode 100644 index 0000000..2be9d33 --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.min.json @@ -0,0 +1,665 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2011-12-05", + "endpointPrefix": "dynamodb", + "jsonVersion": "1.0", + "protocol": "json", + "serviceAbbreviation": "DynamoDB", + "serviceFullName": "Amazon DynamoDB", + "serviceId": "DynamoDB", + "signatureVersion": "v4", + "targetPrefix": "DynamoDB_20111205", + "uid": "dynamodb-2011-12-05" + }, + "operations": { + "BatchGetItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Items": { + "shape": "Sk" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UnprocessedKeys": { + "shape": "S2" + } + } + } + }, + "BatchWriteItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UnprocessedItems": { + "shape": "So" + } + } + } + }, + "CreateTable": { + "input": { + "type": "structure", + "required": [ + "TableName", + "KeySchema", + "ProvisionedThroughput" + ], + "members": { + "TableName": {}, + "KeySchema": { + "shape": "Sy" + }, + "ProvisionedThroughput": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S15" + } + } + } + }, + "DeleteItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "Expected": { + "shape": "S1b" + }, + "ReturnValues": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "DeleteTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S15" + } + } + } + }, + "DescribeTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Table": { + "shape": "S15" + } + } + } + }, + "GetItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributesToGet": { + "shape": "Se" + }, + "ConsistentRead": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Item": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "ListTables": { + "input": { + "type": "structure", + "members": { + "ExclusiveStartTableName": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableNames": { + "type": "list", + "member": {} + }, + "LastEvaluatedTableName": {} + } + } + }, + "PutItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Item" + ], + "members": { + "TableName": {}, + "Item": { + "shape": "Ss" + }, + "Expected": { + "shape": "S1b" + }, + "ReturnValues": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "Query": { + "input": { + "type": "structure", + "required": [ + "TableName", + "HashKeyValue" + ], + "members": { + "TableName": {}, + "AttributesToGet": { + "shape": "Se" + }, + "Limit": { + "type": "integer" + }, + "ConsistentRead": { + "type": "boolean" + }, + "Count": { + "type": "boolean" + }, + "HashKeyValue": { + "shape": "S7" + }, + "RangeKeyCondition": { + "shape": "S1u" + }, + "ScanIndexForward": { + "type": "boolean" + }, + "ExclusiveStartKey": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sk" + }, + "Count": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "Scan": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {}, + "AttributesToGet": { + "shape": "Se" + }, + "Limit": { + "type": "integer" + }, + "Count": { + "type": "boolean" + }, + "ScanFilter": { + "type": "map", + "key": {}, + "value": { + "shape": "S1u" + } + }, + "ExclusiveStartKey": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sk" + }, + "Count": { + "type": "integer" + }, + "ScannedCount": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UpdateItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key", + "AttributeUpdates" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributeUpdates": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S7" + }, + "Action": {} + } + } + }, + "Expected": { + "shape": "S1b" + }, + "ReturnValues": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UpdateTable": { + "input": { + "type": "structure", + "required": [ + "TableName", + "ProvisionedThroughput" + ], + "members": { + "TableName": {}, + "ProvisionedThroughput": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S15" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "Keys" + ], + "members": { + "Keys": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "AttributesToGet": { + "shape": "Se" + }, + "ConsistentRead": { + "type": "boolean" + } + } + } + }, + "S6": { + "type": "structure", + "required": [ + "HashKeyElement" + ], + "members": { + "HashKeyElement": { + "shape": "S7" + }, + "RangeKeyElement": { + "shape": "S7" + } + } + }, + "S7": { + "type": "structure", + "members": { + "S": {}, + "N": {}, + "B": { + "type": "blob" + }, + "SS": { + "type": "list", + "member": {} + }, + "NS": { + "type": "list", + "member": {} + }, + "BS": { + "type": "list", + "member": { + "type": "blob" + } + } + } + }, + "Se": { + "type": "list", + "member": {} + }, + "Sk": { + "type": "list", + "member": { + "shape": "Sl" + } + }, + "Sl": { + "type": "map", + "key": {}, + "value": { + "shape": "S7" + } + }, + "So": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PutRequest": { + "type": "structure", + "required": [ + "Item" + ], + "members": { + "Item": { + "shape": "Ss" + } + } + }, + "DeleteRequest": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": { + "shape": "S6" + } + } + } + } + } + } + }, + "Ss": { + "type": "map", + "key": {}, + "value": { + "shape": "S7" + } + }, + "Sy": { + "type": "structure", + "required": [ + "HashKeyElement" + ], + "members": { + "HashKeyElement": { + "shape": "Sz" + }, + "RangeKeyElement": { + "shape": "Sz" + } + } + }, + "Sz": { + "type": "structure", + "required": [ + "AttributeName", + "AttributeType" + ], + "members": { + "AttributeName": {}, + "AttributeType": {} + } + }, + "S12": { + "type": "structure", + "required": [ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "members": { + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "S15": { + "type": "structure", + "members": { + "TableName": {}, + "KeySchema": { + "shape": "Sy" + }, + "TableStatus": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "ProvisionedThroughput": { + "type": "structure", + "members": { + "LastIncreaseDateTime": { + "type": "timestamp" + }, + "LastDecreaseDateTime": { + "type": "timestamp" + }, + "NumberOfDecreasesToday": { + "type": "long" + }, + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "TableSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + } + } + }, + "S1b": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S7" + }, + "Exists": { + "type": "boolean" + } + } + } + }, + "S1u": { + "type": "structure", + "required": [ + "ComparisonOperator" + ], + "members": { + "AttributeValueList": { + "type": "list", + "member": { + "shape": "S7" + } + }, + "ComparisonOperator": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/dynamodb-2011-12-05.paginators.json b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.paginators.json new file mode 100644 index 0000000..3037d66 --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.paginators.json @@ -0,0 +1,26 @@ +{ + "pagination": { + "BatchGetItem": { + "input_token": "RequestItems", + "output_token": "UnprocessedKeys" + }, + "ListTables": { + "input_token": "ExclusiveStartTableName", + "limit_key": "Limit", + "output_token": "LastEvaluatedTableName", + "result_key": "TableNames" + }, + "Query": { + "input_token": "ExclusiveStartKey", + "limit_key": "Limit", + "output_token": "LastEvaluatedKey", + "result_key": "Items" + }, + "Scan": { + "input_token": "ExclusiveStartKey", + "limit_key": "Limit", + "output_token": "LastEvaluatedKey", + "result_key": "Items" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/dynamodb-2011-12-05.waiters2.json b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.waiters2.json new file mode 100644 index 0000000..43a55ca --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2011-12-05.waiters2.json @@ -0,0 +1,35 @@ +{ + "version": 2, + "waiters": { + "TableExists": { + "delay": 20, + "operation": "DescribeTable", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "ACTIVE", + "matcher": "path", + "state": "success", + "argument": "Table.TableStatus" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "retry" + } + ] + }, + "TableNotExists": { + "delay": 20, + "operation": "DescribeTable", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/dynamodb-2012-08-10.examples.json b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.examples.json new file mode 100644 index 0000000..5b6ad0f --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.examples.json @@ -0,0 +1,631 @@ +{ + "version": "1.0", + "examples": { + "BatchGetItem": [ + { + "input": { + "RequestItems": { + "Music": { + "Keys": [ + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ProjectionExpression": "AlbumTitle" + } + } + }, + "output": { + "Responses": { + "Music": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + } + }, + { + "AlbumTitle": { + "S": "Louder Than Ever" + } + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.", + "id": "to-retrieve-multiple-items-from-a-table-1476118438992", + "title": "To retrieve multiple items from a table" + } + ], + "BatchWriteItem": [ + { + "input": { + "RequestItems": { + "Music": [ + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Blue Sky Blues" + }, + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + } + } + ] + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds three new items to the Music table using a batch of three PutItem requests.", + "id": "to-add-multiple-items-to-a-table-1476118519747", + "title": "To add multiple items to a table" + } + ], + "CreateTable": [ + { + "input": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music" + }, + "output": { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "CreationDateTime": "1421866952.062", + "ItemCount": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music", + "TableSizeBytes": 0, + "TableStatus": "CREATING" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a table named Music.", + "id": "to-create-a-table-1476116291743", + "title": "To create a table" + } + ], + "DeleteItem": [ + { + "input": { + "Key": { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + }, + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes an item from the Music table.", + "id": "to-delete-an-item-1475884573758", + "title": "To delete an item" + } + ], + "DeleteTable": [ + { + "input": { + "TableName": "Music" + }, + "output": { + "TableDescription": { + "ItemCount": 0, + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 1, + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music", + "TableSizeBytes": 0, + "TableStatus": "DELETING" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the Music table.", + "id": "to-delete-a-table-1475884368755", + "title": "To delete a table" + } + ], + "DescribeLimits": [ + { + "input": { + }, + "output": { + "AccountMaxReadCapacityUnits": 20000, + "AccountMaxWriteCapacityUnits": 20000, + "TableMaxReadCapacityUnits": 10000, + "TableMaxWriteCapacityUnits": 10000 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.", + "id": "to-determine-capacity-limits-per-table-and-account-in-the-current-aws-region-1475884162064", + "title": "To determine capacity limits per table and account, in the current AWS region" + } + ], + "DescribeTable": [ + { + "input": { + "TableName": "Music" + }, + "output": { + "Table": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "CreationDateTime": "1421866952.062", + "ItemCount": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 1, + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music", + "TableSizeBytes": 0, + "TableStatus": "ACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Music table.", + "id": "to-describe-a-table-1475884440502", + "title": "To describe a table" + } + ], + "GetItem": [ + { + "input": { + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "TableName": "Music" + }, + "output": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.", + "id": "to-read-an-item-from-a-table-1475884258350", + "title": "To read an item from a table" + } + ], + "ListTables": [ + { + "input": { + }, + "output": { + "TableNames": [ + "Forum", + "ProductCatalog", + "Reply", + "Thread" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of the tables associated with the current AWS account and endpoint.", + "id": "to-list-tables-1475884741238", + "title": "To list tables" + } + ], + "PutItem": [ + { + "input": { + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + "ReturnConsumedCapacity": "TOTAL", + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a new item to the Music table.", + "id": "to-add-an-item-to-a-table-1476116191110", + "title": "To add an item to a table" + } + ], + "Query": [ + { + "input": { + "ExpressionAttributeValues": { + ":v1": { + "S": "No One You Know" + } + }, + "KeyConditionExpression": "Artist = :v1", + "ProjectionExpression": "SongTitle", + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + }, + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + } + } + ], + "ScannedCount": 2 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named \"No One You Know\".", + "id": "to-query-an-item-1475883874631", + "title": "To query an item" + } + ], + "Scan": [ + { + "input": { + "ExpressionAttributeNames": { + "AT": "AlbumTitle", + "ST": "SongTitle" + }, + "ExpressionAttributeValues": { + ":a": { + "S": "No One You Know" + } + }, + "FilterExpression": "Artist = :a", + "ProjectionExpression": "#ST, #AT", + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + }, + "Count": 2, + "Items": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ScannedCount": 3 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example scans the entire Music table, and then narrows the results to songs by the artist \"No One You Know\". For each item, only the album title and song title are returned.", + "id": "to-scan-a-table-1475883652470", + "title": "To scan a table" + } + ], + "UpdateItem": [ + { + "input": { + "ExpressionAttributeNames": { + "#AT": "AlbumTitle", + "#Y": "Year" + }, + "ExpressionAttributeValues": { + ":t": { + "S": "Louder Than Ever" + }, + ":y": { + "N": "2015" + } + }, + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "ReturnValues": "ALL_NEW", + "TableName": "Music", + "UpdateExpression": "SET #Y = :y, #AT = :t" + }, + "output": { + "Attributes": { + "AlbumTitle": { + "S": "Louder Than Ever" + }, + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Year": { + "N": "2015" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.", + "id": "to-update-an-item-in-a-table-1476118250055", + "title": "To update an item in a table" + } + ], + "UpdateTable": [ + { + "input": { + "ProvisionedThroughput": { + "ReadCapacityUnits": 10, + "WriteCapacityUnits": 10 + }, + "TableName": "MusicCollection" + }, + "output": { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "CreationDateTime": "1421866952.062", + "ItemCount": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "LastIncreaseDateTime": "1421874759.194", + "NumberOfDecreasesToday": 1, + "ReadCapacityUnits": 1, + "WriteCapacityUnits": 1 + }, + "TableName": "MusicCollection", + "TableSizeBytes": 0, + "TableStatus": "UPDATING" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example increases the provisioned read and write capacity on the Music table.", + "id": "to-modify-a-tables-provisioned-throughput-1476118076147", + "title": "To modify a table's provisioned throughput" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/dynamodb-2012-08-10.min.json b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.min.json new file mode 100644 index 0000000..dc2b8e9 --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.min.json @@ -0,0 +1,2226 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-08-10", + "endpointPrefix": "dynamodb", + "jsonVersion": "1.0", + "protocol": "json", + "serviceAbbreviation": "DynamoDB", + "serviceFullName": "Amazon DynamoDB", + "serviceId": "DynamoDB", + "signatureVersion": "v4", + "targetPrefix": "DynamoDB_20120810", + "uid": "dynamodb-2012-08-10" + }, + "operations": { + "BatchGetItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "S2" + }, + "ReturnConsumedCapacity": {} + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "map", + "key": {}, + "value": { + "shape": "Sr" + } + }, + "UnprocessedKeys": { + "shape": "S2" + }, + "ConsumedCapacity": { + "shape": "St" + } + } + }, + "endpointdiscovery": {} + }, + "BatchWriteItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "S10" + }, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {} + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedItems": { + "shape": "S10" + }, + "ItemCollectionMetrics": { + "shape": "S18" + }, + "ConsumedCapacity": { + "shape": "St" + } + } + }, + "endpointdiscovery": {} + }, + "CreateBackup": { + "input": { + "type": "structure", + "required": [ + "TableName", + "BackupName" + ], + "members": { + "TableName": {}, + "BackupName": {} + } + }, + "output": { + "type": "structure", + "members": { + "BackupDetails": { + "shape": "S1h" + } + } + }, + "endpointdiscovery": {} + }, + "CreateGlobalTable": { + "input": { + "type": "structure", + "required": [ + "GlobalTableName", + "ReplicationGroup" + ], + "members": { + "GlobalTableName": {}, + "ReplicationGroup": { + "shape": "S1p" + } + } + }, + "output": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "shape": "S1t" + } + } + }, + "endpointdiscovery": {} + }, + "CreateTable": { + "input": { + "type": "structure", + "required": [ + "AttributeDefinitions", + "TableName", + "KeySchema" + ], + "members": { + "AttributeDefinitions": { + "shape": "S1z" + }, + "TableName": {}, + "KeySchema": { + "shape": "S23" + }, + "LocalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IndexName", + "KeySchema", + "Projection" + ], + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S23" + }, + "Projection": { + "shape": "S28" + } + } + } + }, + "GlobalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IndexName", + "KeySchema", + "Projection" + ], + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S23" + }, + "Projection": { + "shape": "S28" + }, + "ProvisionedThroughput": { + "shape": "S2e" + } + } + } + }, + "BillingMode": {}, + "ProvisionedThroughput": { + "shape": "S2e" + }, + "StreamSpecification": { + "shape": "S2h" + }, + "SSESpecification": { + "shape": "S2k" + }, + "Tags": { + "shape": "S2o" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S2t" + } + } + }, + "endpointdiscovery": {} + }, + "DeleteBackup": { + "input": { + "type": "structure", + "required": [ + "BackupArn" + ], + "members": { + "BackupArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "BackupDescription": { + "shape": "S3g" + } + } + }, + "endpointdiscovery": {} + }, + "DeleteItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "Expected": { + "shape": "S3t" + }, + "ConditionalOperator": {}, + "ReturnValues": {}, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + }, + "ItemCollectionMetrics": { + "shape": "S1a" + } + } + }, + "endpointdiscovery": {} + }, + "DeleteTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S2t" + } + } + }, + "endpointdiscovery": {} + }, + "DescribeBackup": { + "input": { + "type": "structure", + "required": [ + "BackupArn" + ], + "members": { + "BackupArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "BackupDescription": { + "shape": "S3g" + } + } + }, + "endpointdiscovery": {} + }, + "DescribeContinuousBackups": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ContinuousBackupsDescription": { + "shape": "S4a" + } + } + }, + "endpointdiscovery": {} + }, + "DescribeEndpoints": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "Endpoints" + ], + "members": { + "Endpoints": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Address", + "CachePeriodInMinutes" + ], + "members": { + "Address": {}, + "CachePeriodInMinutes": { + "type": "long" + } + } + } + } + } + }, + "endpointoperation": true + }, + "DescribeGlobalTable": { + "input": { + "type": "structure", + "required": [ + "GlobalTableName" + ], + "members": { + "GlobalTableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "shape": "S1t" + } + } + }, + "endpointdiscovery": {} + }, + "DescribeGlobalTableSettings": { + "input": { + "type": "structure", + "required": [ + "GlobalTableName" + ], + "members": { + "GlobalTableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "GlobalTableName": {}, + "ReplicaSettings": { + "shape": "S4m" + } + } + }, + "endpointdiscovery": {} + }, + "DescribeLimits": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AccountMaxReadCapacityUnits": { + "type": "long" + }, + "AccountMaxWriteCapacityUnits": { + "type": "long" + }, + "TableMaxReadCapacityUnits": { + "type": "long" + }, + "TableMaxWriteCapacityUnits": { + "type": "long" + } + } + }, + "endpointdiscovery": {} + }, + "DescribeTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Table": { + "shape": "S2t" + } + } + }, + "endpointdiscovery": {} + }, + "DescribeTimeToLive": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TimeToLiveDescription": { + "shape": "S3p" + } + } + }, + "endpointdiscovery": {} + }, + "GetItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributesToGet": { + "shape": "Sj" + }, + "ConsistentRead": { + "type": "boolean" + }, + "ReturnConsumedCapacity": {}, + "ProjectionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + } + } + }, + "output": { + "type": "structure", + "members": { + "Item": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + } + } + }, + "endpointdiscovery": {} + }, + "ListBackups": { + "input": { + "type": "structure", + "members": { + "TableName": {}, + "Limit": { + "type": "integer" + }, + "TimeRangeLowerBound": { + "type": "timestamp" + }, + "TimeRangeUpperBound": { + "type": "timestamp" + }, + "ExclusiveStartBackupArn": {}, + "BackupType": {} + } + }, + "output": { + "type": "structure", + "members": { + "BackupSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TableName": {}, + "TableId": {}, + "TableArn": {}, + "BackupArn": {}, + "BackupName": {}, + "BackupCreationDateTime": { + "type": "timestamp" + }, + "BackupExpiryDateTime": { + "type": "timestamp" + }, + "BackupStatus": {}, + "BackupType": {}, + "BackupSizeBytes": { + "type": "long" + } + } + } + }, + "LastEvaluatedBackupArn": {} + } + }, + "endpointdiscovery": {} + }, + "ListGlobalTables": { + "input": { + "type": "structure", + "members": { + "ExclusiveStartGlobalTableName": {}, + "Limit": { + "type": "integer" + }, + "RegionName": {} + } + }, + "output": { + "type": "structure", + "members": { + "GlobalTables": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GlobalTableName": {}, + "ReplicationGroup": { + "shape": "S1p" + } + } + } + }, + "LastEvaluatedGlobalTableName": {} + } + }, + "endpointdiscovery": {} + }, + "ListTables": { + "input": { + "type": "structure", + "members": { + "ExclusiveStartTableName": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableNames": { + "type": "list", + "member": {} + }, + "LastEvaluatedTableName": {} + } + }, + "endpointdiscovery": {} + }, + "ListTagsOfResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S2o" + }, + "NextToken": {} + } + }, + "endpointdiscovery": {} + }, + "PutItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Item" + ], + "members": { + "TableName": {}, + "Item": { + "shape": "S14" + }, + "Expected": { + "shape": "S3t" + }, + "ReturnValues": {}, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {}, + "ConditionalOperator": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + }, + "ItemCollectionMetrics": { + "shape": "S1a" + } + } + }, + "endpointdiscovery": {} + }, + "Query": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {}, + "IndexName": {}, + "Select": {}, + "AttributesToGet": { + "shape": "Sj" + }, + "Limit": { + "type": "integer" + }, + "ConsistentRead": { + "type": "boolean" + }, + "KeyConditions": { + "type": "map", + "key": {}, + "value": { + "shape": "S5w" + } + }, + "QueryFilter": { + "shape": "S5x" + }, + "ConditionalOperator": {}, + "ScanIndexForward": { + "type": "boolean" + }, + "ExclusiveStartKey": { + "shape": "S6" + }, + "ReturnConsumedCapacity": {}, + "ProjectionExpression": {}, + "FilterExpression": {}, + "KeyConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sr" + }, + "Count": { + "type": "integer" + }, + "ScannedCount": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacity": { + "shape": "Su" + } + } + }, + "endpointdiscovery": {} + }, + "RestoreTableFromBackup": { + "input": { + "type": "structure", + "required": [ + "TargetTableName", + "BackupArn" + ], + "members": { + "TargetTableName": {}, + "BackupArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S2t" + } + } + }, + "endpointdiscovery": {} + }, + "RestoreTableToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceTableName", + "TargetTableName" + ], + "members": { + "SourceTableName": {}, + "TargetTableName": {}, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "RestoreDateTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S2t" + } + } + }, + "endpointdiscovery": {} + }, + "Scan": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {}, + "IndexName": {}, + "AttributesToGet": { + "shape": "Sj" + }, + "Limit": { + "type": "integer" + }, + "Select": {}, + "ScanFilter": { + "shape": "S5x" + }, + "ConditionalOperator": {}, + "ExclusiveStartKey": { + "shape": "S6" + }, + "ReturnConsumedCapacity": {}, + "TotalSegments": { + "type": "integer" + }, + "Segment": { + "type": "integer" + }, + "ProjectionExpression": {}, + "FilterExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + }, + "ConsistentRead": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sr" + }, + "Count": { + "type": "integer" + }, + "ScannedCount": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacity": { + "shape": "Su" + } + } + }, + "endpointdiscovery": {} + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S2o" + } + } + }, + "endpointdiscovery": {} + }, + "TransactGetItems": { + "input": { + "type": "structure", + "required": [ + "TransactItems" + ], + "members": { + "TransactItems": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Get" + ], + "members": { + "Get": { + "type": "structure", + "required": [ + "Key", + "TableName" + ], + "members": { + "Key": { + "shape": "S6" + }, + "TableName": {}, + "ProjectionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + } + } + } + } + } + }, + "ReturnConsumedCapacity": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConsumedCapacity": { + "shape": "St" + }, + "Responses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Item": { + "shape": "Ss" + } + } + } + } + } + }, + "endpointdiscovery": {} + }, + "TransactWriteItems": { + "input": { + "type": "structure", + "required": [ + "TransactItems" + ], + "members": { + "TransactItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ConditionCheck": { + "type": "structure", + "required": [ + "Key", + "TableName", + "ConditionExpression" + ], + "members": { + "Key": { + "shape": "S6" + }, + "TableName": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + }, + "ReturnValuesOnConditionCheckFailure": {} + } + }, + "Put": { + "type": "structure", + "required": [ + "Item", + "TableName" + ], + "members": { + "Item": { + "shape": "S14" + }, + "TableName": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + }, + "ReturnValuesOnConditionCheckFailure": {} + } + }, + "Delete": { + "type": "structure", + "required": [ + "Key", + "TableName" + ], + "members": { + "Key": { + "shape": "S6" + }, + "TableName": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + }, + "ReturnValuesOnConditionCheckFailure": {} + } + }, + "Update": { + "type": "structure", + "required": [ + "Key", + "UpdateExpression", + "TableName" + ], + "members": { + "Key": { + "shape": "S6" + }, + "UpdateExpression": {}, + "TableName": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + }, + "ReturnValuesOnConditionCheckFailure": {} + } + } + } + } + }, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {}, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ConsumedCapacity": { + "shape": "St" + }, + "ItemCollectionMetrics": { + "shape": "S18" + } + } + }, + "endpointdiscovery": {} + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "endpointdiscovery": {} + }, + "UpdateContinuousBackups": { + "input": { + "type": "structure", + "required": [ + "TableName", + "PointInTimeRecoverySpecification" + ], + "members": { + "TableName": {}, + "PointInTimeRecoverySpecification": { + "type": "structure", + "required": [ + "PointInTimeRecoveryEnabled" + ], + "members": { + "PointInTimeRecoveryEnabled": { + "type": "boolean" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ContinuousBackupsDescription": { + "shape": "S4a" + } + } + }, + "endpointdiscovery": {} + }, + "UpdateGlobalTable": { + "input": { + "type": "structure", + "required": [ + "GlobalTableName", + "ReplicaUpdates" + ], + "members": { + "GlobalTableName": {}, + "ReplicaUpdates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Create": { + "type": "structure", + "required": [ + "RegionName" + ], + "members": { + "RegionName": {} + } + }, + "Delete": { + "type": "structure", + "required": [ + "RegionName" + ], + "members": { + "RegionName": {} + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "shape": "S1t" + } + } + }, + "endpointdiscovery": {} + }, + "UpdateGlobalTableSettings": { + "input": { + "type": "structure", + "required": [ + "GlobalTableName" + ], + "members": { + "GlobalTableName": {}, + "GlobalTableBillingMode": {}, + "GlobalTableProvisionedWriteCapacityUnits": { + "type": "long" + }, + "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": { + "shape": "S74" + }, + "GlobalTableGlobalSecondaryIndexSettingsUpdate": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IndexName" + ], + "members": { + "IndexName": {}, + "ProvisionedWriteCapacityUnits": { + "type": "long" + }, + "ProvisionedWriteCapacityAutoScalingSettingsUpdate": { + "shape": "S74" + } + } + } + }, + "ReplicaSettingsUpdate": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegionName" + ], + "members": { + "RegionName": {}, + "ReplicaProvisionedReadCapacityUnits": { + "type": "long" + }, + "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": { + "shape": "S74" + }, + "ReplicaGlobalSecondaryIndexSettingsUpdate": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IndexName" + ], + "members": { + "IndexName": {}, + "ProvisionedReadCapacityUnits": { + "type": "long" + }, + "ProvisionedReadCapacityAutoScalingSettingsUpdate": { + "shape": "S74" + } + } + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "GlobalTableName": {}, + "ReplicaSettings": { + "shape": "S4m" + } + } + }, + "endpointdiscovery": {} + }, + "UpdateItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributeUpdates": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S8" + }, + "Action": {} + } + } + }, + "Expected": { + "shape": "S3t" + }, + "ConditionalOperator": {}, + "ReturnValues": {}, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {}, + "UpdateExpression": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S41" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + }, + "ItemCollectionMetrics": { + "shape": "S1a" + } + } + }, + "endpointdiscovery": {} + }, + "UpdateTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "AttributeDefinitions": { + "shape": "S1z" + }, + "TableName": {}, + "BillingMode": {}, + "ProvisionedThroughput": { + "shape": "S2e" + }, + "GlobalSecondaryIndexUpdates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Update": { + "type": "structure", + "required": [ + "IndexName", + "ProvisionedThroughput" + ], + "members": { + "IndexName": {}, + "ProvisionedThroughput": { + "shape": "S2e" + } + } + }, + "Create": { + "type": "structure", + "required": [ + "IndexName", + "KeySchema", + "Projection" + ], + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S23" + }, + "Projection": { + "shape": "S28" + }, + "ProvisionedThroughput": { + "shape": "S2e" + } + } + }, + "Delete": { + "type": "structure", + "required": [ + "IndexName" + ], + "members": { + "IndexName": {} + } + } + } + } + }, + "StreamSpecification": { + "shape": "S2h" + }, + "SSESpecification": { + "shape": "S2k" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S2t" + } + } + }, + "endpointdiscovery": {} + }, + "UpdateTimeToLive": { + "input": { + "type": "structure", + "required": [ + "TableName", + "TimeToLiveSpecification" + ], + "members": { + "TableName": {}, + "TimeToLiveSpecification": { + "shape": "S7s" + } + } + }, + "output": { + "type": "structure", + "members": { + "TimeToLiveSpecification": { + "shape": "S7s" + } + } + }, + "endpointdiscovery": {} + } + }, + "shapes": { + "S2": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "Keys" + ], + "members": { + "Keys": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "AttributesToGet": { + "shape": "Sj" + }, + "ConsistentRead": { + "type": "boolean" + }, + "ProjectionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + } + } + } + }, + "S6": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "S8": { + "type": "structure", + "members": { + "S": {}, + "N": {}, + "B": { + "type": "blob" + }, + "SS": { + "type": "list", + "member": {} + }, + "NS": { + "type": "list", + "member": {} + }, + "BS": { + "type": "list", + "member": { + "type": "blob" + } + }, + "M": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "L": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "NULL": { + "type": "boolean" + }, + "BOOL": { + "type": "boolean" + } + } + }, + "Sj": { + "type": "list", + "member": {} + }, + "Sm": { + "type": "map", + "key": {}, + "value": {} + }, + "Sr": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "Ss": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "St": { + "type": "list", + "member": { + "shape": "Su" + } + }, + "Su": { + "type": "structure", + "members": { + "TableName": {}, + "CapacityUnits": { + "type": "double" + }, + "ReadCapacityUnits": { + "type": "double" + }, + "WriteCapacityUnits": { + "type": "double" + }, + "Table": { + "shape": "Sw" + }, + "LocalSecondaryIndexes": { + "shape": "Sx" + }, + "GlobalSecondaryIndexes": { + "shape": "Sx" + } + } + }, + "Sw": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "type": "double" + }, + "WriteCapacityUnits": { + "type": "double" + }, + "CapacityUnits": { + "type": "double" + } + } + }, + "Sx": { + "type": "map", + "key": {}, + "value": { + "shape": "Sw" + } + }, + "S10": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PutRequest": { + "type": "structure", + "required": [ + "Item" + ], + "members": { + "Item": { + "shape": "S14" + } + } + }, + "DeleteRequest": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": { + "shape": "S6" + } + } + } + } + } + } + }, + "S14": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "S18": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "shape": "S1a" + } + } + }, + "S1a": { + "type": "structure", + "members": { + "ItemCollectionKey": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "SizeEstimateRangeGB": { + "type": "list", + "member": { + "type": "double" + } + } + } + }, + "S1h": { + "type": "structure", + "required": [ + "BackupArn", + "BackupName", + "BackupStatus", + "BackupType", + "BackupCreationDateTime" + ], + "members": { + "BackupArn": {}, + "BackupName": {}, + "BackupSizeBytes": { + "type": "long" + }, + "BackupStatus": {}, + "BackupType": {}, + "BackupCreationDateTime": { + "type": "timestamp" + }, + "BackupExpiryDateTime": { + "type": "timestamp" + } + } + }, + "S1p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RegionName": {} + } + } + }, + "S1t": { + "type": "structure", + "members": { + "ReplicationGroup": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RegionName": {} + } + } + }, + "GlobalTableArn": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "GlobalTableStatus": {}, + "GlobalTableName": {} + } + }, + "S1z": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeName", + "AttributeType" + ], + "members": { + "AttributeName": {}, + "AttributeType": {} + } + } + }, + "S23": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeName", + "KeyType" + ], + "members": { + "AttributeName": {}, + "KeyType": {} + } + } + }, + "S28": { + "type": "structure", + "members": { + "ProjectionType": {}, + "NonKeyAttributes": { + "type": "list", + "member": {} + } + } + }, + "S2e": { + "type": "structure", + "required": [ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "members": { + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "S2h": { + "type": "structure", + "members": { + "StreamEnabled": { + "type": "boolean" + }, + "StreamViewType": {} + } + }, + "S2k": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "SSEType": {}, + "KMSMasterKeyId": {} + } + }, + "S2o": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S2t": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "shape": "S1z" + }, + "TableName": {}, + "KeySchema": { + "shape": "S23" + }, + "TableStatus": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "ProvisionedThroughput": { + "shape": "S2v" + }, + "TableSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + }, + "TableArn": {}, + "TableId": {}, + "BillingModeSummary": { + "shape": "S30" + }, + "LocalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S23" + }, + "Projection": { + "shape": "S28" + }, + "IndexSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + }, + "IndexArn": {} + } + } + }, + "GlobalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S23" + }, + "Projection": { + "shape": "S28" + }, + "IndexStatus": {}, + "Backfilling": { + "type": "boolean" + }, + "ProvisionedThroughput": { + "shape": "S2v" + }, + "IndexSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + }, + "IndexArn": {} + } + } + }, + "StreamSpecification": { + "shape": "S2h" + }, + "LatestStreamLabel": {}, + "LatestStreamArn": {}, + "RestoreSummary": { + "type": "structure", + "required": [ + "RestoreDateTime", + "RestoreInProgress" + ], + "members": { + "SourceBackupArn": {}, + "SourceTableArn": {}, + "RestoreDateTime": { + "type": "timestamp" + }, + "RestoreInProgress": { + "type": "boolean" + } + } + }, + "SSEDescription": { + "shape": "S3b" + } + } + }, + "S2v": { + "type": "structure", + "members": { + "LastIncreaseDateTime": { + "type": "timestamp" + }, + "LastDecreaseDateTime": { + "type": "timestamp" + }, + "NumberOfDecreasesToday": { + "type": "long" + }, + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "S30": { + "type": "structure", + "members": { + "BillingMode": {}, + "LastUpdateToPayPerRequestDateTime": { + "type": "timestamp" + } + } + }, + "S3b": { + "type": "structure", + "members": { + "Status": {}, + "SSEType": {}, + "KMSMasterKeyArn": {} + } + }, + "S3g": { + "type": "structure", + "members": { + "BackupDetails": { + "shape": "S1h" + }, + "SourceTableDetails": { + "type": "structure", + "required": [ + "TableName", + "TableId", + "KeySchema", + "TableCreationDateTime", + "ProvisionedThroughput" + ], + "members": { + "TableName": {}, + "TableId": {}, + "TableArn": {}, + "TableSizeBytes": { + "type": "long" + }, + "KeySchema": { + "shape": "S23" + }, + "TableCreationDateTime": { + "type": "timestamp" + }, + "ProvisionedThroughput": { + "shape": "S2e" + }, + "ItemCount": { + "type": "long" + }, + "BillingMode": {} + } + }, + "SourceTableFeatureDetails": { + "type": "structure", + "members": { + "LocalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S23" + }, + "Projection": { + "shape": "S28" + } + } + } + }, + "GlobalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S23" + }, + "Projection": { + "shape": "S28" + }, + "ProvisionedThroughput": { + "shape": "S2e" + } + } + } + }, + "StreamDescription": { + "shape": "S2h" + }, + "TimeToLiveDescription": { + "shape": "S3p" + }, + "SSEDescription": { + "shape": "S3b" + } + } + } + } + }, + "S3p": { + "type": "structure", + "members": { + "TimeToLiveStatus": {}, + "AttributeName": {} + } + }, + "S3t": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S8" + }, + "Exists": { + "type": "boolean" + }, + "ComparisonOperator": {}, + "AttributeValueList": { + "shape": "S3x" + } + } + } + }, + "S3x": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "S41": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "S4a": { + "type": "structure", + "required": [ + "ContinuousBackupsStatus" + ], + "members": { + "ContinuousBackupsStatus": {}, + "PointInTimeRecoveryDescription": { + "type": "structure", + "members": { + "PointInTimeRecoveryStatus": {}, + "EarliestRestorableDateTime": { + "type": "timestamp" + }, + "LatestRestorableDateTime": { + "type": "timestamp" + } + } + } + } + }, + "S4m": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegionName" + ], + "members": { + "RegionName": {}, + "ReplicaStatus": {}, + "ReplicaBillingModeSummary": { + "shape": "S30" + }, + "ReplicaProvisionedReadCapacityUnits": { + "type": "long" + }, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "shape": "S4p" + }, + "ReplicaProvisionedWriteCapacityUnits": { + "type": "long" + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "shape": "S4p" + }, + "ReplicaGlobalSecondaryIndexSettings": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IndexName" + ], + "members": { + "IndexName": {}, + "IndexStatus": {}, + "ProvisionedReadCapacityUnits": { + "type": "long" + }, + "ProvisionedReadCapacityAutoScalingSettings": { + "shape": "S4p" + }, + "ProvisionedWriteCapacityUnits": { + "type": "long" + }, + "ProvisionedWriteCapacityAutoScalingSettings": { + "shape": "S4p" + } + } + } + } + } + } + }, + "S4p": { + "type": "structure", + "members": { + "MinimumUnits": { + "type": "long" + }, + "MaximumUnits": { + "type": "long" + }, + "AutoScalingDisabled": { + "type": "boolean" + }, + "AutoScalingRoleArn": {}, + "ScalingPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "TargetTrackingScalingPolicyConfiguration": { + "type": "structure", + "required": [ + "TargetValue" + ], + "members": { + "DisableScaleIn": { + "type": "boolean" + }, + "ScaleInCooldown": { + "type": "integer" + }, + "ScaleOutCooldown": { + "type": "integer" + }, + "TargetValue": { + "type": "double" + } + } + } + } + } + } + } + }, + "S5w": { + "type": "structure", + "required": [ + "ComparisonOperator" + ], + "members": { + "AttributeValueList": { + "shape": "S3x" + }, + "ComparisonOperator": {} + } + }, + "S5x": { + "type": "map", + "key": {}, + "value": { + "shape": "S5w" + } + }, + "S74": { + "type": "structure", + "members": { + "MinimumUnits": { + "type": "long" + }, + "MaximumUnits": { + "type": "long" + }, + "AutoScalingDisabled": { + "type": "boolean" + }, + "AutoScalingRoleArn": {}, + "ScalingPolicyUpdate": { + "type": "structure", + "required": [ + "TargetTrackingScalingPolicyConfiguration" + ], + "members": { + "PolicyName": {}, + "TargetTrackingScalingPolicyConfiguration": { + "type": "structure", + "required": [ + "TargetValue" + ], + "members": { + "DisableScaleIn": { + "type": "boolean" + }, + "ScaleInCooldown": { + "type": "integer" + }, + "ScaleOutCooldown": { + "type": "integer" + }, + "TargetValue": { + "type": "double" + } + } + } + } + } + } + }, + "S7s": { + "type": "structure", + "required": [ + "Enabled", + "AttributeName" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "AttributeName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/dynamodb-2012-08-10.paginators.json b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.paginators.json new file mode 100644 index 0000000..3037d66 --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.paginators.json @@ -0,0 +1,26 @@ +{ + "pagination": { + "BatchGetItem": { + "input_token": "RequestItems", + "output_token": "UnprocessedKeys" + }, + "ListTables": { + "input_token": "ExclusiveStartTableName", + "limit_key": "Limit", + "output_token": "LastEvaluatedTableName", + "result_key": "TableNames" + }, + "Query": { + "input_token": "ExclusiveStartKey", + "limit_key": "Limit", + "output_token": "LastEvaluatedKey", + "result_key": "Items" + }, + "Scan": { + "input_token": "ExclusiveStartKey", + "limit_key": "Limit", + "output_token": "LastEvaluatedKey", + "result_key": "Items" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/dynamodb-2012-08-10.waiters2.json b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.waiters2.json new file mode 100644 index 0000000..43a55ca --- /dev/null +++ b/node_modules/aws-sdk/apis/dynamodb-2012-08-10.waiters2.json @@ -0,0 +1,35 @@ +{ + "version": 2, + "waiters": { + "TableExists": { + "delay": 20, + "operation": "DescribeTable", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "ACTIVE", + "matcher": "path", + "state": "success", + "argument": "Table.TableStatus" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "retry" + } + ] + }, + "TableNotExists": { + "delay": 20, + "operation": "DescribeTable", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/ec2-2016-11-15.examples.json b/node_modules/aws-sdk/apis/ec2-2016-11-15.examples.json new file mode 100644 index 0000000..93b4bf8 --- /dev/null +++ b/node_modules/aws-sdk/apis/ec2-2016-11-15.examples.json @@ -0,0 +1,5048 @@ +{ + "version": "1.0", + "examples": { + "AllocateAddress": [ + { + "input": { + "Domain": "vpc" + }, + "output": { + "AllocationId": "eipalloc-64d5890a", + "Domain": "vpc", + "PublicIp": "203.0.113.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example allocates an Elastic IP address to use with an instance in a VPC.", + "id": "ec2-allocate-address-1", + "title": "To allocate an Elastic IP address for EC2-VPC" + }, + { + "output": { + "Domain": "standard", + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example allocates an Elastic IP address to use with an instance in EC2-Classic.", + "id": "ec2-allocate-address-2", + "title": "To allocate an Elastic IP address for EC2-Classic" + } + ], + "AssignPrivateIpAddresses": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns the specified secondary private IP address to the specified network interface.", + "id": "ec2-assign-private-ip-addresses-1", + "title": "To assign a specific secondary private IP address to an interface" + }, + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "SecondaryPrivateIpAddressCount": 2 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.", + "id": "ec2-assign-private-ip-addresses-2", + "title": "To assign secondary private IP addresses that Amazon EC2 selects to an interface" + } + ], + "AssociateAddress": [ + { + "input": { + "AllocationId": "eipalloc-64d5890a", + "InstanceId": "i-0b263919b6498b123" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified Elastic IP address with the specified instance in a VPC.", + "id": "ec2-associate-address-1", + "title": "To associate an Elastic IP address in EC2-VPC" + }, + { + "input": { + "AllocationId": "eipalloc-64d5890a", + "NetworkInterfaceId": "eni-1a2b3c4d" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified Elastic IP address with the specified network interface.", + "id": "ec2-associate-address-2", + "title": "To associate an Elastic IP address with a network interface" + }, + { + "input": { + "InstanceId": "i-07ffe74c7330ebf53", + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates an Elastic IP address with an instance in EC2-Classic.", + "id": "ec2-associate-address-3", + "title": "To associate an Elastic IP address in EC2-Classic" + } + ], + "AssociateDhcpOptions": [ + { + "input": { + "DhcpOptionsId": "dopt-d9070ebb", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified DHCP options set with the specified VPC.", + "id": "ec2-associate-dhcp-options-1", + "title": "To associate a DHCP options set with a VPC" + }, + { + "input": { + "DhcpOptionsId": "default", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the default DHCP options set with the specified VPC.", + "id": "ec2-associate-dhcp-options-2", + "title": "To associate the default DHCP options set with a VPC" + } + ], + "AssociateIamInstanceProfile": [ + { + "input": { + "IamInstanceProfile": { + "Name": "admin-role" + }, + "InstanceId": "i-123456789abcde123" + }, + "output": { + "IamInstanceProfileAssociation": { + "AssociationId": "iip-assoc-0e7736511a163c209", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role", + "Id": "AIPAJBLK7RKJKWDXVHIEC" + }, + "InstanceId": "i-123456789abcde123", + "State": "associating" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates an IAM instance profile named admin-role with the specified instance.", + "id": "to-associate-an-iam-instance-profile-with-an-instance-1528928429850", + "title": "To associate an IAM instance profile with an instance" + } + ], + "AssociateRouteTable": [ + { + "input": { + "RouteTableId": "rtb-22574640", + "SubnetId": "subnet-9d4a7b6" + }, + "output": { + "AssociationId": "rtbassoc-781d0d1a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified route table with the specified subnet.", + "id": "ec2-associate-route-table-1", + "title": "To associate a route table with a subnet" + } + ], + "AttachInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified Internet gateway to the specified VPC.", + "id": "ec2-attach-internet-gateway-1", + "title": "To attach an Internet gateway to a VPC" + } + ], + "AttachNetworkInterface": [ + { + "input": { + "DeviceIndex": 1, + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-e5aa89a3" + }, + "output": { + "AttachmentId": "eni-attach-66c4350a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified network interface to the specified instance.", + "id": "ec2-attach-network-interface-1", + "title": "To attach a network interface to an instance" + } + ], + "AttachVolume": [ + { + "input": { + "Device": "/dev/sdf", + "InstanceId": "i-01474ef662b89480", + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2016-08-29T18:52:32.724Z", + "Device": "/dev/sdf", + "InstanceId": "i-01474ef662b89480", + "State": "attaching", + "VolumeId": "vol-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.", + "id": "to-attach-a-volume-to-an-instance-1472499213109", + "title": "To attach a volume to an instance" + } + ], + "AuthorizeSecurityGroupEgress": [ + { + "input": { + "GroupId": "sg-1a2b3c4d", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "10.0.0.0/16" + } + ], + "ToPort": 80 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a rule that grants access to the specified address ranges on TCP port 80.", + "id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-address-range-1528929309636", + "title": "To add a rule that allows outbound traffic to a specific address range" + }, + { + "input": { + "GroupId": "sg-1a2b3c4d", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "ToPort": 80, + "UserIdGroupPairs": [ + { + "GroupId": "sg-4b51a32f" + } + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a rule that grants access to the specified security group on TCP port 80.", + "id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-security-group-1528929760260", + "title": "To add a rule that allows outbound traffic to a specific security group" + } + ], + "AuthorizeSecurityGroupIngress": [ + { + "input": { + "GroupId": "sg-903004f8", + "IpPermissions": [ + { + "FromPort": 22, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "SSH access from the LA office" + } + ], + "ToPort": 22 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.", + "id": "to-add-a-rule-that-allows-inbound-ssh-traffic-1529011610328", + "title": "To add a rule that allows inbound SSH traffic from an IPv4 address range" + }, + { + "input": { + "GroupId": "sg-111aaa22", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "ToPort": 80, + "UserIdGroupPairs": [ + { + "Description": "HTTP access from other instances", + "GroupId": "sg-1a2b3c4d" + } + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group.", + "id": "to-add-a-rule-that-allows-inbound-http-traffic-from-another-security-group-1529012163168", + "title": "To add a rule that allows inbound HTTP traffic from another security group" + }, + { + "input": { + "GroupId": "sg-123abc12 ", + "IpPermissions": [ + { + "FromPort": 3389, + "IpProtocol": "tcp", + "Ipv6Ranges": [ + { + "CidrIpv6": "2001:db8:1234:1a00::/64", + "Description": "RDP access from the NY office" + } + ], + "ToPort": 3389 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later.", + "id": "to-add-a-rule-with-a-description-1529012418116", + "title": "To add a rule that allows inbound RDP traffic from an IPv6 address range" + } + ], + "CancelSpotFleetRequests": [ + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": true + }, + "output": { + "SuccessfulFleetRequests": [ + { + "CurrentSpotFleetRequestState": "cancelled_running", + "PreviousSpotFleetRequestState": "active", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels the specified Spot fleet request and terminates its associated Spot Instances.", + "id": "ec2-cancel-spot-fleet-requests-1", + "title": "To cancel a Spot fleet request" + }, + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": false + }, + "output": { + "SuccessfulFleetRequests": [ + { + "CurrentSpotFleetRequestState": "cancelled_terminating", + "PreviousSpotFleetRequestState": "active", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels the specified Spot fleet request without terminating its associated Spot Instances.", + "id": "ec2-cancel-spot-fleet-requests-2", + "title": "To cancel a Spot fleet request without terminating its Spot Instances" + } + ], + "CancelSpotInstanceRequests": [ + { + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "CancelledSpotInstanceRequests": [ + { + "SpotInstanceRequestId": "sir-08b93456", + "State": "cancelled" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels a Spot Instance request.", + "id": "ec2-cancel-spot-instance-requests-1", + "title": "To cancel Spot Instance requests" + } + ], + "ConfirmProductInstance": [ + { + "input": { + "InstanceId": "i-1234567890abcdef0", + "ProductCode": "774F4FF8" + }, + "output": { + "OwnerId": "123456789012" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example determines whether the specified product code is associated with the specified instance.", + "id": "to-confirm-the-product-instance-1472712108494", + "title": "To confirm the product instance" + } + ], + "CopyImage": [ + { + "input": { + "Description": "", + "Name": "My server", + "SourceImageId": "ami-5731123e", + "SourceRegion": "us-east-1" + }, + "output": { + "ImageId": "ami-438bea42" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies the specified AMI from the us-east-1 region to the current region.", + "id": "to-copy-an-ami-to-another-region-1529022820832", + "title": "To copy an AMI to another region" + } + ], + "CopySnapshot": [ + { + "input": { + "Description": "This is my copied snapshot.", + "DestinationRegion": "us-east-1", + "SourceRegion": "us-west-2", + "SourceSnapshotId": "snap-066877671789bd71b" + }, + "output": { + "SnapshotId": "snap-066877671789bd71b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.", + "id": "to-copy-a-snapshot-1472502259774", + "title": "To copy a snapshot" + } + ], + "CreateCustomerGateway": [ + { + "input": { + "BgpAsn": 65534, + "PublicIp": "12.1.2.3", + "Type": "ipsec.1" + }, + "output": { + "CustomerGateway": { + "BgpAsn": "65534", + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a customer gateway with the specified IP address for its outside interface.", + "id": "ec2-create-customer-gateway-1", + "title": "To create a customer gateway" + } + ], + "CreateDhcpOptions": [ + { + "input": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + "10.2.5.1", + "10.2.5.2" + ] + } + ] + }, + "output": { + "DhcpOptions": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ] + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DHCP options set.", + "id": "ec2-create-dhcp-options-1", + "title": "To create a DHCP options set" + } + ], + "CreateImage": [ + { + "input": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": "100" + } + }, + { + "DeviceName": "/dev/sdc", + "VirtualName": "ephemeral1" + } + ], + "Description": "An AMI for my server", + "InstanceId": "i-1234567890abcdef0", + "Name": "My server", + "NoReboot": true + }, + "output": { + "ImageId": "ami-1a2b3c4d" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc.", + "id": "to-create-an-ami-from-an-amazon-ebs-backed-instance-1529023150636", + "title": "To create an AMI from an Amazon EBS-backed instance" + } + ], + "CreateInternetGateway": [ + { + "output": { + "InternetGateway": { + "Attachments": [ + + ], + "InternetGatewayId": "igw-c0a643a9", + "Tags": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Internet gateway.", + "id": "ec2-create-internet-gateway-1", + "title": "To create an Internet gateway" + } + ], + "CreateKeyPair": [ + { + "input": { + "KeyName": "my-key-pair" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a key pair named my-key-pair.", + "id": "ec2-create-key-pair-1", + "title": "To create a key pair" + } + ], + "CreateLaunchTemplate": [ + { + "input": { + "LaunchTemplateData": { + "ImageId": "ami-8c1be5f6", + "InstanceType": "t2.small", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Ipv6AddressCount": 1, + "SubnetId": "subnet-7b16de0c" + } + ], + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Name", + "Value": "webserver" + } + ] + } + ] + }, + "LaunchTemplateName": "my-template", + "VersionDescription": "WebVersion1" + }, + "output": { + "LaunchTemplate": { + "CreateTime": "2017-11-27T09:13:24.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 1, + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "my-template" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.", + "id": "to-create-a-launch-template-1529023655488", + "title": "To create a launch template" + } + ], + "CreateLaunchTemplateVersion": [ + { + "input": { + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2" + }, + "LaunchTemplateId": "lt-0abcd290751193123", + "SourceVersion": "1", + "VersionDescription": "WebVersion2" + }, + "output": { + "LaunchTemplateVersion": { + "CreateTime": "2017-12-01T13:35:46.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersion": false, + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "SubnetId": "subnet-7b16de0c" + } + ] + }, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "VersionDescription": "WebVersion2", + "VersionNumber": 2 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.", + "id": "to-create-a-launch-template-version-1529024195702", + "title": "To create a launch template version" + } + ], + "CreateNatGateway": [ + { + "input": { + "AllocationId": "eipalloc-37fc1a52", + "SubnetId": "subnet-1a2b3c4d" + }, + "output": { + "NatGateway": { + "CreateTime": "2015-12-17T12:45:26.732Z", + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-37fc1a52" + } + ], + "NatGatewayId": "nat-08d48af2a8e83edfd", + "State": "pending", + "SubnetId": "subnet-1a2b3c4d", + "VpcId": "vpc-1122aabb" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.", + "id": "ec2-create-nat-gateway-1", + "title": "To create a NAT gateway" + } + ], + "CreateNetworkAcl": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "NetworkAcl": { + "Associations": [ + + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": false, + "NetworkAclId": "acl-5fb85d36", + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a network ACL for the specified VPC.", + "id": "ec2-create-network-acl-1", + "title": "To create a network ACL" + } + ], + "CreateNetworkAclEntry": [ + { + "input": { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "NetworkAclId": "acl-5fb85d36", + "PortRange": { + "From": 53, + "To": 53 + }, + "Protocol": "17", + "RuleAction": "allow", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.", + "id": "ec2-create-network-acl-entry-1", + "title": "To create a network ACL entry" + } + ], + "CreateNetworkInterface": [ + { + "input": { + "Description": "my network interface", + "Groups": [ + "sg-903004f8" + ], + "PrivateIpAddress": "10.0.2.17", + "SubnetId": "subnet-9d4a7b6c" + }, + "output": { + "NetworkInterface": { + "AvailabilityZone": "us-east-1d", + "Description": "my network interface", + "Groups": [ + { + "GroupId": "sg-903004f8", + "GroupName": "default" + } + ], + "MacAddress": "02:1a:80:41:52:9c", + "NetworkInterfaceId": "eni-e5aa89a3", + "OwnerId": "123456789012", + "PrivateIpAddress": "10.0.2.17", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.2.17" + } + ], + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "pending", + "SubnetId": "subnet-9d4a7b6c", + "TagSet": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a network interface for the specified subnet.", + "id": "ec2-create-network-interface-1", + "title": "To create a network interface" + } + ], + "CreatePlacementGroup": [ + { + "input": { + "GroupName": "my-cluster", + "Strategy": "cluster" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a placement group with the specified name.", + "id": "to-create-a-placement-group-1472712245768", + "title": "To create a placement group" + } + ], + "CreateRoute": [ + { + "input": { + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-c0a643a9", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.", + "id": "ec2-create-route-1", + "title": "To create a route" + } + ], + "CreateRouteTable": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "RouteTable": { + "Associations": [ + + ], + "PropagatingVgws": [ + + ], + "RouteTableId": "rtb-22574640", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "State": "active" + } + ], + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a route table for the specified VPC.", + "id": "ec2-create-route-table-1", + "title": "To create a route table" + } + ], + "CreateSecurityGroup": [ + { + "input": { + "Description": "My security group", + "GroupName": "my-security-group", + "VpcId": "vpc-1a2b3c4d" + }, + "output": { + "GroupId": "sg-903004f8" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a security group for the specified VPC.", + "id": "to-create-a-security-group-for-a-vpc-1529024532716", + "title": "To create a security group for a VPC" + } + ], + "CreateSnapshot": [ + { + "input": { + "Description": "This is my root volume snapshot.", + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "Description": "This is my root volume snapshot.", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b", + "StartTime": "2014-02-28T21:06:01.000Z", + "State": "pending", + "Tags": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeSize": 8 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.", + "id": "to-create-a-snapshot-1472502529790", + "title": "To create a snapshot" + } + ], + "CreateSpotDatafeedSubscription": [ + { + "input": { + "Bucket": "my-s3-bucket", + "Prefix": "spotdata" + }, + "output": { + "SpotDatafeedSubscription": { + "Bucket": "my-s3-bucket", + "OwnerId": "123456789012", + "Prefix": "spotdata", + "State": "Active" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot Instance data feed for your AWS account.", + "id": "ec2-create-spot-datafeed-subscription-1", + "title": "To create a Spot Instance datafeed" + } + ], + "CreateSubnet": [ + { + "input": { + "CidrBlock": "10.0.1.0/24", + "VpcId": "vpc-a01106c2" + }, + "output": { + "Subnet": { + "AvailabilityZone": "us-west-2c", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "State": "pending", + "SubnetId": "subnet-9d4a7b6c", + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.", + "id": "ec2-create-subnet-1", + "title": "To create a subnet" + } + ], + "CreateTags": [ + { + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "production" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.", + "id": "ec2-create-tags-1", + "title": "To add a tag to a resource" + } + ], + "CreateVolume": [ + { + "input": { + "AvailabilityZone": "us-east-1a", + "Size": 80, + "VolumeType": "gp2" + }, + "output": { + "AvailabilityZone": "us-east-1a", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Encrypted": false, + "Iops": 240, + "Size": 80, + "SnapshotId": "", + "State": "creating", + "VolumeId": "vol-6b60b7c7", + "VolumeType": "gp2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.", + "id": "to-create-a-new-volume-1472496724296", + "title": "To create a new volume" + }, + { + "input": { + "AvailabilityZone": "us-east-1a", + "Iops": 1000, + "SnapshotId": "snap-066877671789bd71b", + "VolumeType": "io1" + }, + "output": { + "Attachments": [ + + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Iops": 1000, + "Size": 500, + "SnapshotId": "snap-066877671789bd71b", + "State": "creating", + "Tags": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeType": "io1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.", + "id": "to-create-a-new-provisioned-iops-ssd-volume-from-a-snapshot-1472498975176", + "title": "To create a new Provisioned IOPS (SSD) volume from a snapshot" + } + ], + "CreateVpc": [ + { + "input": { + "CidrBlock": "10.0.0.0/16" + }, + "output": { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d", + "InstanceTenancy": "default", + "State": "pending", + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a VPC with the specified CIDR block.", + "id": "ec2-create-vpc-1", + "title": "To create a VPC" + } + ], + "DeleteCustomerGateway": [ + { + "input": { + "CustomerGatewayId": "cgw-0e11f167" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified customer gateway.", + "id": "ec2-delete-customer-gateway-1", + "title": "To delete a customer gateway" + } + ], + "DeleteDhcpOptions": [ + { + "input": { + "DhcpOptionsId": "dopt-d9070ebb" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DHCP options set.", + "id": "ec2-delete-dhcp-options-1", + "title": "To delete a DHCP options set" + } + ], + "DeleteInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Internet gateway.", + "id": "ec2-delete-internet-gateway-1", + "title": "To delete an Internet gateway" + } + ], + "DeleteKeyPair": [ + { + "input": { + "KeyName": "my-key-pair" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified key pair.", + "id": "ec2-delete-key-pair-1", + "title": "To delete a key pair" + } + ], + "DeleteLaunchTemplate": [ + { + "input": { + "LaunchTemplateId": "lt-0abcd290751193123" + }, + "output": { + "LaunchTemplate": { + "CreateTime": "2017-11-23T16:46:25.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 2, + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified launch template.", + "id": "to-delete-a-launch-template-1529024658216", + "title": "To delete a launch template" + } + ], + "DeleteLaunchTemplateVersions": [ + { + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "Versions": [ + "1" + ] + }, + "output": { + "SuccessfullyDeletedLaunchTemplateVersions": [ + { + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "VersionNumber": 1 + } + ], + "UnsuccessfullyDeletedLaunchTemplateVersions": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified launch template version.", + "id": "to-delete-a-launch-template-version-1529024790864", + "title": "To delete a launch template version" + } + ], + "DeleteNatGateway": [ + { + "input": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "output": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified NAT gateway.", + "id": "ec2-delete-nat-gateway-1", + "title": "To delete a NAT gateway" + } + ], + "DeleteNetworkAcl": [ + { + "input": { + "NetworkAclId": "acl-5fb85d36" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified network ACL.", + "id": "ec2-delete-network-acl-1", + "title": "To delete a network ACL" + } + ], + "DeleteNetworkAclEntry": [ + { + "input": { + "Egress": true, + "NetworkAclId": "acl-5fb85d36", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes ingress rule number 100 from the specified network ACL.", + "id": "ec2-delete-network-acl-entry-1", + "title": "To delete a network ACL entry" + } + ], + "DeleteNetworkInterface": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified network interface.", + "id": "ec2-delete-network-interface-1", + "title": "To delete a network interface" + } + ], + "DeletePlacementGroup": [ + { + "input": { + "GroupName": "my-cluster" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified placement group.\n", + "id": "to-delete-a-placement-group-1472712349959", + "title": "To delete a placement group" + } + ], + "DeleteRoute": [ + { + "input": { + "DestinationCidrBlock": "0.0.0.0/0", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified route from the specified route table.", + "id": "ec2-delete-route-1", + "title": "To delete a route" + } + ], + "DeleteRouteTable": [ + { + "input": { + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified route table.", + "id": "ec2-delete-route-table-1", + "title": "To delete a route table" + } + ], + "DeleteSecurityGroup": [ + { + "input": { + "GroupId": "sg-903004f8" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified security group.", + "id": "to-delete-a-security-group-1529024952972", + "title": "To delete a security group" + } + ], + "DeleteSnapshot": [ + { + "input": { + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "id": "to-delete-a-snapshot-1472503042567", + "title": "To delete a snapshot" + } + ], + "DeleteSpotDatafeedSubscription": [ + { + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a Spot data feed subscription for the account.", + "id": "ec2-delete-spot-datafeed-subscription-1", + "title": "To cancel a Spot Instance data feed subscription" + } + ], + "DeleteSubnet": [ + { + "input": { + "SubnetId": "subnet-9d4a7b6c" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified subnet.", + "id": "ec2-delete-subnet-1", + "title": "To delete a subnet" + } + ], + "DeleteTags": [ + { + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "test" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the tag Stack=test from the specified image.", + "id": "ec2-delete-tags-1", + "title": "To delete a tag from a resource" + } + ], + "DeleteVolume": [ + { + "input": { + "VolumeId": "vol-049df61146c4d7901" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.", + "id": "to-delete-a-volume-1472503111160", + "title": "To delete a volume" + } + ], + "DeleteVpc": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified VPC.", + "id": "ec2-delete-vpc-1", + "title": "To delete a VPC" + } + ], + "DescribeAccountAttributes": [ + { + "input": { + "AttributeNames": [ + "supported-platforms" + ] + }, + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the supported-platforms attribute for your AWS account.", + "id": "ec2-describe-account-attributes-1", + "title": "To describe a single attribute for your AWS account" + }, + { + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + }, + { + "AttributeName": "vpc-max-security-groups-per-interface", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-instances", + "AttributeValues": [ + { + "AttributeValue": "20" + } + ] + }, + { + "AttributeName": "vpc-max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "default-vpc", + "AttributeValues": [ + { + "AttributeValue": "none" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes for your AWS account.", + "id": "ec2-describe-account-attributes-2", + "title": "To describe all attributes for your AWS account" + } + ], + "DescribeAddresses": [ + { + "output": { + "Addresses": [ + { + "Domain": "standard", + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0" + }, + { + "AllocationId": "eipalloc-12345678", + "AssociationId": "eipassoc-12345678", + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PrivateIpAddress": "10.0.1.241", + "PublicIp": "203.0.113.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses.", + "id": "ec2-describe-addresses-1", + "title": "To describe your Elastic IP addresses" + }, + { + "input": { + "Filters": [ + { + "Name": "domain", + "Values": [ + "vpc" + ] + } + ] + }, + "output": { + "Addresses": [ + { + "AllocationId": "eipalloc-12345678", + "AssociationId": "eipassoc-12345678", + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PrivateIpAddress": "10.0.1.241", + "PublicIp": "203.0.113.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses for use with instances in a VPC.", + "id": "ec2-describe-addresses-2", + "title": "To describe your Elastic IP addresses for EC2-VPC" + }, + { + "input": { + "Filters": [ + { + "Name": "domain", + "Values": [ + "standard" + ] + } + ] + }, + "output": { + "Addresses": [ + { + "Domain": "standard", + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses for use with instances in EC2-Classic.", + "id": "ec2-describe-addresses-3", + "title": "To describe your Elastic IP addresses for EC2-Classic" + } + ], + "DescribeAvailabilityZones": [ + { + "output": { + "AvailabilityZones": [ + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1b" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1c" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1d" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1e" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.", + "id": "ec2-describe-availability-zones-1", + "title": "To describe your Availability Zones" + } + ], + "DescribeCustomerGateways": [ + { + "input": { + "CustomerGatewayIds": [ + "cgw-0e11f167" + ] + }, + "output": { + "CustomerGateways": [ + { + "BgpAsn": "65534", + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified customer gateway.", + "id": "ec2-describe-customer-gateways-1", + "title": "To describe a customer gateway" + } + ], + "DescribeDhcpOptions": [ + { + "input": { + "DhcpOptionsIds": [ + "dopt-d9070ebb" + ] + }, + "output": { + "DhcpOptions": [ + { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ] + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified DHCP options set.", + "id": "ec2-describe-dhcp-options-1", + "title": "To describe a DHCP options set" + } + ], + "DescribeIamInstanceProfileAssociations": [ + { + "input": { + "AssociationIds": [ + "iip-assoc-0db249b1f25fa24b8" + ] + }, + "output": { + "IamInstanceProfileAssociations": [ + { + "AssociationId": "iip-assoc-0db249b1f25fa24b8", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role", + "Id": "AIPAJVQN4F5WVLGCJDRGM" + }, + "InstanceId": "i-09eb09efa73ec1dee", + "State": "associated" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified IAM instance profile association.", + "id": "to-describe-an-iam-instance-profile-association-1529025123918", + "title": "To describe an IAM instance profile association" + } + ], + "DescribeImageAttribute": [ + { + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": { + "ImageId": "ami-5731123e", + "LaunchPermissions": [ + { + "UserId": "123456789012" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the launch permissions for the specified AMI.", + "id": "to-describe-the-launch-permissions-for-an-ami-1529025296264", + "title": "To describe the launch permissions for an AMI" + } + ], + "DescribeImages": [ + { + "input": { + "ImageIds": [ + "ami-5731123e" + ] + }, + "output": { + "Images": [ + { + "Architecture": "x86_64", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "Description": "An AMI for my server", + "Hypervisor": "xen", + "ImageId": "ami-5731123e", + "ImageLocation": "123456789012/My server", + "ImageType": "machine", + "KernelId": "aki-88aa75e1", + "Name": "My server", + "OwnerId": "123456789012", + "Public": false, + "RootDeviceName": "/dev/sda1", + "RootDeviceType": "ebs", + "State": "available", + "VirtualizationType": "paravirtual" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified AMI.", + "id": "to-describe-an-ami-1529025482866", + "title": "To describe an AMI" + } + ], + "DescribeInstanceAttribute": [ + { + "input": { + "Attribute": "instanceType", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": { + "Value": "t1.micro" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the instance type of the specified instance.\n", + "id": "to-describe-the-instance-type-1472712432132", + "title": "To describe the instance type" + }, + { + "input": { + "Attribute": "disableApiTermination", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "DisableApiTermination": { + "Value": "false" + }, + "InstanceId": "i-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``disableApiTermination`` attribute of the specified instance.\n", + "id": "to-describe-the-disableapitermination-attribute-1472712533466", + "title": "To describe the disableApiTermination attribute" + }, + { + "input": { + "Attribute": "blockDeviceMapping", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "AttachTime": "2013-05-17T22:42:34.000Z", + "DeleteOnTermination": true, + "Status": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + }, + { + "DeviceName": "/dev/sdf", + "Ebs": { + "AttachTime": "2013-09-10T23:07:00.000Z", + "DeleteOnTermination": false, + "Status": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + } + ], + "InstanceId": "i-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``blockDeviceMapping`` attribute of the specified instance.\n", + "id": "to-describe-the-block-device-mapping-for-an-instance-1472712645423", + "title": "To describe the block device mapping for an instance" + } + ], + "DescribeInstanceStatus": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "InstanceStatuses": [ + { + "AvailabilityZone": "us-east-1d", + "InstanceId": "i-1234567890abcdef0", + "InstanceState": { + "Code": 16, + "Name": "running" + }, + "InstanceStatus": { + "Details": [ + { + "Name": "reachability", + "Status": "passed" + } + ], + "Status": "ok" + }, + "SystemStatus": { + "Details": [ + { + "Name": "reachability", + "Status": "passed" + } + ], + "Status": "ok" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the current status of the specified instance.", + "id": "to-describe-the-status-of-an-instance-1529025696830", + "title": "To describe the status of an instance" + } + ], + "DescribeInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified instance.", + "id": "to-describe-an-amazon-ec2-instance-1529025982172", + "title": "To describe an Amazon EC2 instance" + }, + { + "input": { + "Filters": [ + { + "Name": "instance-type", + "Values": [ + "t2.micro" + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the instances with the t2.micro instance type.", + "id": "to-describe-the-instances-with-the-instance-type-t2micro-1529026147602", + "title": "To describe the instances with a specific instance type" + }, + { + "input": { + "Filters": [ + { + "Name": "tag:Purpose", + "Values": [ + "test" + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the instances with the Purpose=test tag.", + "id": "to-describe-the-instances-with-a-specific-tag-1529026251928", + "title": "To describe the instances with a specific tag" + } + ], + "DescribeInternetGateways": [ + { + "input": { + "Filters": [ + { + "Name": "attachment.vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "InternetGateways": [ + { + "Attachments": [ + { + "State": "available", + "VpcId": "vpc-a01106c2" + } + ], + "InternetGatewayId": "igw-c0a643a9", + "Tags": [ + + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Internet gateway for the specified VPC.", + "id": "ec2-describe-internet-gateways-1", + "title": "To describe the Internet gateway for a VPC" + } + ], + "DescribeKeyPairs": [ + { + "input": { + "KeyNames": [ + "my-key-pair" + ] + }, + "output": { + "KeyPairs": [ + { + "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f", + "KeyName": "my-key-pair" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example displays the fingerprint for the specified key.", + "id": "ec2-describe-key-pairs-1", + "title": "To display a key pair" + } + ], + "DescribeLaunchTemplateVersions": [ + { + "input": { + "LaunchTemplateId": "068f72b72934aff71" + }, + "output": { + "LaunchTemplateVersions": [ + { + "CreateTime": "2017-11-20T13:12:32.000Z", + "CreatedBy": "arn:aws:iam::123456789102:root", + "DefaultVersion": false, + "LaunchTemplateData": { + "ImageId": "ami-6057e21a", + "InstanceType": "t2.medium", + "KeyName": "kp-us-east", + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ], + "SubnetId": "subnet-1a2b3c4d" + } + ] + }, + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 2 + }, + { + "CreateTime": "2017-11-20T12:52:33.000Z", + "CreatedBy": "arn:aws:iam::123456789102:root", + "DefaultVersion": true, + "LaunchTemplateData": { + "ImageId": "ami-aabbcc11", + "InstanceType": "t2.medium", + "KeyName": "kp-us-east", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ], + "SubnetId": "subnet-7b16de0c" + } + ], + "UserData": "" + }, + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 1 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the versions for the specified launch template.", + "id": "to-describe-the-versions-for-a-launch-template-1529344425048", + "title": "To describe the versions for a launch template" + } + ], + "DescribeLaunchTemplates": [ + { + "input": { + "LaunchTemplateIds": [ + "lt-01238c059e3466abc" + ] + }, + "output": { + "LaunchTemplates": [ + { + "CreateTime": "2018-01-16T04:32:57.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 1, + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "my-template" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified launch template.", + "id": "to-describe-a-launch-template-1529344182862", + "title": "To describe a launch template" + } + ], + "DescribeMovingAddresses": [ + { + "output": { + "MovingAddressStatuses": [ + { + "MoveStatus": "MovingToVpc", + "PublicIp": "198.51.100.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your moving Elastic IP addresses.", + "id": "ec2-describe-moving-addresses-1", + "title": "To describe your moving addresses" + } + ], + "DescribeNatGateways": [ + { + "input": { + "Filter": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-1a2b3c4d" + ] + } + ] + }, + "output": { + "NatGateways": [ + { + "CreateTime": "2015-12-01T12:26:55.983Z", + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-89c620ec", + "NetworkInterfaceId": "eni-9dec76cd", + "PrivateIp": "10.0.0.149", + "PublicIp": "198.11.222.333" + } + ], + "NatGatewayId": "nat-05dba92075d71c408", + "State": "available", + "SubnetId": "subnet-847e4dc2", + "VpcId": "vpc-1a2b3c4d" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the NAT gateway for the specified VPC.", + "id": "ec2-describe-nat-gateways-1", + "title": "To describe a NAT gateway" + } + ], + "DescribeNetworkAcls": [ + { + "input": { + "NetworkAclIds": [ + "acl-5fb85d36" + ] + }, + "output": { + "NetworkAcls": [ + { + "Associations": [ + { + "NetworkAclAssociationId": "aclassoc-66ea5f0b", + "NetworkAclId": "acl-9aeb5ef7", + "SubnetId": "subnet-65ea5f08" + } + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": false, + "NetworkAclId": "acl-5fb85d36", + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified network ACL.", + "id": "ec2-", + "title": "To describe a network ACL" + } + ], + "DescribeNetworkInterfaceAttribute": [ + { + "input": { + "Attribute": "attachment", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Attachment": { + "AttachTime": "2015-05-21T20:02:20.000Z", + "AttachmentId": "eni-attach-43348162", + "DeleteOnTermination": true, + "DeviceIndex": 0, + "InstanceId": "i-1234567890abcdef0", + "InstanceOwnerId": "123456789012", + "Status": "attached" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attachment attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-1", + "title": "To describe the attachment attribute of a network interface" + }, + { + "input": { + "Attribute": "description", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Description": { + "Value": "My description" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the description attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-2", + "title": "To describe the description attribute of a network interface" + }, + { + "input": { + "Attribute": "groupSet", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Groups": [ + { + "GroupId": "sg-903004f8", + "GroupName": "my-security-group" + } + ], + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the groupSet attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-3", + "title": "To describe the groupSet attribute of a network interface" + }, + { + "input": { + "Attribute": "sourceDestCheck", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": true + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the sourceDestCheck attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-4", + "title": "To describe the sourceDestCheck attribute of a network interface" + } + ], + "DescribeNetworkInterfaces": [ + { + "input": { + "NetworkInterfaceIds": [ + "eni-e5aa89a3" + ] + }, + "output": { + "NetworkInterfaces": [ + { + "Association": { + "AssociationId": "eipassoc-0fbb766a", + "IpOwnerId": "123456789012", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "PublicIp": "203.0.113.12" + }, + "Attachment": { + "AttachTime": "2013-11-30T23:36:42.000Z", + "AttachmentId": "eni-attach-66c4350a", + "DeleteOnTermination": false, + "DeviceIndex": 1, + "InstanceId": "i-1234567890abcdef0", + "InstanceOwnerId": "123456789012", + "Status": "attached" + }, + "AvailabilityZone": "us-east-1d", + "Description": "my network interface", + "Groups": [ + { + "GroupId": "sg-8637d3e3", + "GroupName": "default" + } + ], + "MacAddress": "02:2f:8f:b0:cf:75", + "NetworkInterfaceId": "eni-e5aa89a3", + "OwnerId": "123456789012", + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "PrivateIpAddress": "10.0.1.17", + "PrivateIpAddresses": [ + { + "Association": { + "AssociationId": "eipassoc-0fbb766a", + "IpOwnerId": "123456789012", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "PublicIp": "203.0.113.12" + }, + "Primary": true, + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "PrivateIpAddress": "10.0.1.17" + } + ], + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "in-use", + "SubnetId": "subnet-b61f49f0", + "TagSet": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "ec2-describe-network-interfaces-1", + "title": "To describe a network interface" + } + ], + "DescribeRegions": [ + { + "output": { + "Regions": [ + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all the regions that are available to you.", + "id": "ec2-describe-regions-1", + "title": "To describe your regions" + } + ], + "DescribeRouteTables": [ + { + "input": { + "RouteTableIds": [ + "rtb-1f382e7d" + ] + }, + "output": { + "RouteTables": [ + { + "Associations": [ + { + "Main": true, + "RouteTableAssociationId": "rtbassoc-d8ccddba", + "RouteTableId": "rtb-1f382e7d" + } + ], + "PropagatingVgws": [ + + ], + "RouteTableId": "rtb-1f382e7d", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "State": "active" + } + ], + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified route table.", + "id": "ec2-describe-route-tables-1", + "title": "To describe a route table" + } + ], + "DescribeScheduledInstanceAvailability": [ + { + "input": { + "FirstSlotStartTimeRange": { + "EarliestTime": "2016-01-31T00:00:00Z", + "LatestTime": "2016-01-31T04:00:00Z" + }, + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDays": [ + 1 + ] + } + }, + "output": { + "ScheduledInstanceAvailabilitySet": [ + { + "AvailabilityZone": "us-west-2b", + "AvailableInstanceCount": 20, + "FirstSlotStartTime": "2016-01-31T00:00:00Z", + "HourlyPrice": "0.095", + "InstanceType": "c4.large", + "MaxTermDurationInDays": 366, + "MinTermDurationInDays": 366, + "NetworkPlatform": "EC2-VPC", + "Platform": "Linux/UNIX", + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false + }, + "SlotDurationInHours": 23, + "TotalScheduledInstanceHours": 1219 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example.", + "id": "ec2-describe-scheduled-instance-availability-1", + "title": "To describe an available schedule" + } + ], + "DescribeScheduledInstances": [ + { + "input": { + "ScheduledInstanceIds": [ + "sci-1234-1234-1234-1234-123456789012" + ] + }, + "output": { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "CreateDate": "2016-01-25T21:43:38.612Z", + "HourlyPrice": "0.095", + "InstanceCount": 1, + "InstanceType": "c4.large", + "NetworkPlatform": "EC2-VPC", + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "Platform": "Linux/UNIX", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "SlotDurationInHours": 32, + "TermEndDate": "2017-01-31T09:00:00Z", + "TermStartDate": "2016-01-31T09:00:00Z", + "TotalScheduledInstanceHours": 1696 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Scheduled Instance.", + "id": "ec2-describe-scheduled-instances-1", + "title": "To describe your Scheduled Instances" + } + ], + "DescribeSecurityGroupReferences": [ + { + "input": { + "GroupId": [ + "sg-903004f8" + ] + }, + "output": { + "SecurityGroupReferenceSet": [ + { + "GroupId": "sg-903004f8", + "ReferencingVpcId": "vpc-1a2b3c4d", + "VpcPeeringConnectionId": "pcx-b04deed9" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the security group references for the specified security group.", + "id": "to-describe-security-group-references-1529354312088", + "title": "To describe security group references" + } + ], + "DescribeSecurityGroups": [ + { + "input": { + "GroupIds": [ + "sg-903004f8" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified security group.", + "id": "to-describe-a-security-group-1529354426314", + "title": "To describe a security group" + }, + { + "input": { + "Filters": [ + { + "Name": "tag:Purpose", + "Values": [ + "test" + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the security groups that include the specified tag (Purpose=test).", + "id": "to-describe-a-tagged-security-group-1529354553880", + "title": "To describe a tagged security group" + } + ], + "DescribeSnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "SnapshotId": "snap-066877671789bd71b" + }, + "output": { + "CreateVolumePermissions": [ + + ], + "SnapshotId": "snap-066877671789bd71b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.", + "id": "to-describe-snapshot-attributes-1472503199736", + "title": "To describe snapshot attributes" + } + ], + "DescribeSnapshots": [ + { + "input": { + "SnapshotIds": [ + "snap-1234567890abcdef0" + ] + }, + "output": { + "NextToken": "", + "Snapshots": [ + { + "Description": "This is my snapshot.", + "OwnerId": "012345678910", + "Progress": "100%", + "SnapshotId": "snap-1234567890abcdef0", + "StartTime": "2014-02-28T21:28:32.000Z", + "State": "completed", + "VolumeId": "vol-049df61146c4d7901", + "VolumeSize": 8 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.", + "id": "to-describe-a-snapshot-1472503807850", + "title": "To describe a snapshot" + }, + { + "input": { + "Filters": [ + { + "Name": "status", + "Values": [ + "pending" + ] + } + ], + "OwnerIds": [ + "012345678910" + ] + }, + "output": { + "NextToken": "", + "Snapshots": [ + { + "Description": "This is my copied snapshot.", + "OwnerId": "012345678910", + "Progress": "87%", + "SnapshotId": "snap-066877671789bd71b", + "StartTime": "2014-02-28T21:37:27.000Z", + "State": "pending", + "VolumeId": "vol-1234567890abcdef0", + "VolumeSize": 8 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.", + "id": "to-describe-snapshots-using-filters-1472503929793", + "title": "To describe snapshots using filters" + } + ], + "DescribeSpotDatafeedSubscription": [ + { + "output": { + "SpotDatafeedSubscription": { + "Bucket": "my-s3-bucket", + "OwnerId": "123456789012", + "Prefix": "spotdata", + "State": "Active" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Spot Instance datafeed subscription for your AWS account.", + "id": "ec2-describe-spot-datafeed-subscription-1", + "title": "To describe the datafeed for your AWS account" + } + ], + "DescribeSpotFleetInstances": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "output": { + "ActiveInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": "m3.medium", + "SpotInstanceRequestId": "sir-08b93456" + } + ], + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the Spot Instances associated with the specified Spot fleet.", + "id": "ec2-describe-spot-fleet-instances-1", + "title": "To describe the Spot Instances associated with a Spot fleet" + } + ], + "DescribeSpotFleetRequestHistory": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z" + }, + "output": { + "HistoryRecords": [ + { + "EventInformation": { + "EventSubType": "submitted" + }, + "EventType": "fleetRequestChange", + "Timestamp": "2015-05-26T23:17:20.697Z" + }, + { + "EventInformation": { + "EventSubType": "active" + }, + "EventType": "fleetRequestChange", + "Timestamp": "2015-05-26T23:17:20.873Z" + }, + { + "EventInformation": { + "EventSubType": "launched", + "InstanceId": "i-1234567890abcdef0" + }, + "EventType": "instanceChange", + "Timestamp": "2015-05-26T23:21:21.712Z" + }, + { + "EventInformation": { + "EventSubType": "launched", + "InstanceId": "i-1234567890abcdef1" + }, + "EventType": "instanceChange", + "Timestamp": "2015-05-26T23:21:21.816Z" + } + ], + "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example returns the history for the specified Spot fleet starting at the specified time.", + "id": "ec2-describe-spot-fleet-request-history-1", + "title": "To describe Spot fleet history" + } + ], + "DescribeSpotFleetRequests": [ + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ] + }, + "output": { + "SpotFleetRequestConfigs": [ + { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "cc2.8xlarge", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "SecondaryPrivateIpAddressCount": 0, + "SubnetId": "subnet-a61dafcf" + } + ] + }, + { + "EbsOptimized": false, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.8xlarge", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "SecondaryPrivateIpAddressCount": 0, + "SubnetId": "subnet-a61dafcf" + } + ] + } + ], + "SpotPrice": "0.05", + "TargetCapacity": 20 + }, + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "SpotFleetRequestState": "active" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Spot fleet request.", + "id": "ec2-describe-spot-fleet-requests-1", + "title": "To describe a Spot fleet request" + } + ], + "DescribeSpotInstanceRequests": [ + { + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "SpotInstanceRequests": [ + { + "CreateTime": "2014-04-30T18:14:55.000Z", + "InstanceId": "i-1234567890abcdef0", + "LaunchSpecification": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "EbsOptimized": false, + "ImageId": "ami-7aba833f", + "InstanceType": "m1.small", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-e38f24a7", + "GroupName": "my-security-group" + } + ] + }, + "LaunchedAvailabilityZone": "us-west-1b", + "ProductDescription": "Linux/UNIX", + "SpotInstanceRequestId": "sir-08b93456", + "SpotPrice": "0.010000", + "State": "active", + "Status": { + "Code": "fulfilled", + "Message": "Your Spot request is fulfilled.", + "UpdateTime": "2014-04-30T18:16:21.000Z" + }, + "Type": "one-time" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Spot Instance request.", + "id": "ec2-describe-spot-instance-requests-1", + "title": "To describe a Spot Instance request" + } + ], + "DescribeSpotPriceHistory": [ + { + "input": { + "EndTime": "2014-01-06T08:09:10", + "InstanceTypes": [ + "m1.xlarge" + ], + "ProductDescriptions": [ + "Linux/UNIX (Amazon VPC)" + ], + "StartTime": "2014-01-06T07:08:09" + }, + "output": { + "SpotPriceHistory": [ + { + "AvailabilityZone": "us-west-1a", + "InstanceType": "m1.xlarge", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "SpotPrice": "0.080000", + "Timestamp": "2014-01-06T04:32:53.000Z" + }, + { + "AvailabilityZone": "us-west-1c", + "InstanceType": "m1.xlarge", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "SpotPrice": "0.080000", + "Timestamp": "2014-01-05T11:28:26.000Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.", + "id": "ec2-describe-spot-price-history-1", + "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)" + } + ], + "DescribeSubnets": [ + { + "input": { + "Filters": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "Subnets": [ + { + "AvailabilityZone": "us-east-1c", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-9d4a7b6c", + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the subnets for the specified VPC.", + "id": "ec2-describe-subnets-1", + "title": "To describe the subnets for a VPC" + } + ], + "DescribeTags": [ + { + "input": { + "Filters": [ + { + "Name": "resource-id", + "Values": [ + "i-1234567890abcdef8" + ] + } + ] + }, + "output": { + "Tags": [ + { + "Key": "Stack", + "ResourceId": "i-1234567890abcdef8", + "ResourceType": "instance", + "Value": "test" + }, + { + "Key": "Name", + "ResourceId": "i-1234567890abcdef8", + "ResourceType": "instance", + "Value": "Beta Server" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags for the specified instance.", + "id": "ec2-describe-tags-1", + "title": "To describe the tags for a single resource" + } + ], + "DescribeVolumeAttribute": [ + { + "input": { + "Attribute": "autoEnableIO", + "VolumeId": "vol-049df61146c4d7901" + }, + "output": { + "AutoEnableIO": { + "Value": false + }, + "VolumeId": "vol-049df61146c4d7901" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.", + "id": "to-describe-a-volume-attribute-1472505773492", + "title": "To describe a volume attribute" + } + ], + "DescribeVolumeStatus": [ + { + "input": { + "VolumeIds": [ + "vol-1234567890abcdef0" + ] + }, + "output": { + "VolumeStatuses": [ + { + "Actions": [ + + ], + "AvailabilityZone": "us-east-1a", + "Events": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeStatus": { + "Details": [ + { + "Name": "io-enabled", + "Status": "passed" + }, + { + "Name": "io-performance", + "Status": "not-applicable" + } + ], + "Status": "ok" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the status for the volume ``vol-1234567890abcdef0``.", + "id": "to-describe-the-status-of-a-single-volume-1472507016193", + "title": "To describe the status of a single volume" + }, + { + "input": { + "Filters": [ + { + "Name": "volume-status.status", + "Values": [ + "impaired" + ] + } + ] + }, + "output": { + "VolumeStatuses": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.", + "id": "to-describe-the-status-of-impaired-volumes-1472507239821", + "title": "To describe the status of impaired volumes" + } + ], + "DescribeVolumes": [ + { + "input": { + }, + "output": { + "NextToken": "", + "Volumes": [ + { + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "DeleteOnTermination": true, + "Device": "/dev/sda1", + "InstanceId": "i-1234567890abcdef0", + "State": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8, + "SnapshotId": "snap-1234567890abcdef0", + "State": "in-use", + "VolumeId": "vol-049df61146c4d7901", + "VolumeType": "standard" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your volumes in the default region.", + "id": "to-describe-all-volumes-1472506358883", + "title": "To describe all volumes" + }, + { + "input": { + "Filters": [ + { + "Name": "attachment.instance-id", + "Values": [ + "i-1234567890abcdef0" + ] + }, + { + "Name": "attachment.delete-on-termination", + "Values": [ + "true" + ] + } + ] + }, + "output": { + "Volumes": [ + { + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "DeleteOnTermination": true, + "Device": "/dev/sda1", + "InstanceId": "i-1234567890abcdef0", + "State": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8, + "SnapshotId": "snap-1234567890abcdef0", + "State": "in-use", + "VolumeId": "vol-049df61146c4d7901", + "VolumeType": "standard" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.", + "id": "to-describe-volumes-that-are-attached-to-a-specific-instance-1472506613578", + "title": "To describe volumes that are attached to a specific instance" + } + ], + "DescribeVpcAttribute": [ + { + "input": { + "Attribute": "enableDnsSupport", + "VpcId": "vpc-a01106c2" + }, + "output": { + "EnableDnsSupport": { + "Value": true + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.", + "id": "ec2-describe-vpc-attribute-1", + "title": "To describe the enableDnsSupport attribute" + }, + { + "input": { + "Attribute": "enableDnsHostnames", + "VpcId": "vpc-a01106c2" + }, + "output": { + "EnableDnsHostnames": { + "Value": true + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "id": "ec2-describe-vpc-attribute-2", + "title": "To describe the enableDnsHostnames attribute" + } + ], + "DescribeVpcs": [ + { + "input": { + "VpcIds": [ + "vpc-a01106c2" + ] + }, + "output": { + "Vpcs": [ + { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d", + "InstanceTenancy": "default", + "IsDefault": false, + "State": "available", + "Tags": [ + { + "Key": "Name", + "Value": "MyVPC" + } + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified VPC.", + "id": "ec2-describe-vpcs-1", + "title": "To describe a VPC" + } + ], + "DetachInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified Internet gateway from the specified VPC.", + "id": "ec2-detach-internet-gateway-1", + "title": "To detach an Internet gateway from a VPC" + } + ], + "DetachNetworkInterface": [ + { + "input": { + "AttachmentId": "eni-attach-66c4350a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified network interface from its attached instance.", + "id": "ec2-detach-network-interface-1", + "title": "To detach a network interface from an instance" + } + ], + "DetachVolume": [ + { + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2014-02-27T19:23:06.000Z", + "Device": "/dev/sdb", + "InstanceId": "i-1234567890abcdef0", + "State": "detaching", + "VolumeId": "vol-049df61146c4d7901" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.", + "id": "to-detach-a-volume-from-an-instance-1472507977694", + "title": "To detach a volume from an instance" + } + ], + "DisableVgwRoutePropagation": [ + { + "input": { + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables the specified virtual private gateway from propagating static routes to the specified route table.", + "id": "ec2-disable-vgw-route-propagation-1", + "title": "To disable route propagation" + } + ], + "DisassociateAddress": [ + { + "input": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates an Elastic IP address from an instance in a VPC.", + "id": "ec2-disassociate-address-1", + "title": "To disassociate an Elastic IP address in EC2-VPC" + }, + { + "input": { + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates an Elastic IP address from an instance in EC2-Classic.", + "id": "ec2-disassociate-address-2", + "title": "To disassociate an Elastic IP addresses in EC2-Classic" + } + ], + "DisassociateIamInstanceProfile": [ + { + "input": { + "AssociationId": "iip-assoc-05020b59952902f5f" + }, + "output": { + "IamInstanceProfileAssociation": { + "AssociationId": "iip-assoc-05020b59952902f5f", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role", + "Id": "AIPAI5IVIHMFFYY2DKV5Y" + }, + "InstanceId": "i-123456789abcde123", + "State": "disassociating" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates the specified IAM instance profile from an instance.", + "id": "to-disassociate-an-iam-instance-profile-1529355364478", + "title": "To disassociate an IAM instance profile" + } + ], + "DisassociateRouteTable": [ + { + "input": { + "AssociationId": "rtbassoc-781d0d1a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates the specified route table from its associated subnet.", + "id": "ec2-disassociate-route-table-1", + "title": "To disassociate a route table" + } + ], + "EnableVgwRoutePropagation": [ + { + "input": { + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables the specified virtual private gateway to propagate static routes to the specified route table.", + "id": "ec2-enable-vgw-route-propagation-1", + "title": "To enable route propagation" + } + ], + "EnableVolumeIO": [ + { + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables I/O on volume ``vol-1234567890abcdef0``.", + "id": "to-enable-io-for-a-volume-1472508114867", + "title": "To enable I/O for a volume" + } + ], + "GetConsoleOutput": [ + { + "input": { + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "Output": "...", + "Timestamp": "2018-05-25T21:23:53.000Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example gets the console output for the specified instance.", + "id": "to-get-the-console-output-1529355683194", + "title": "To get the console output" + } + ], + "GetLaunchTemplateData": [ + { + "input": { + "InstanceId": "0123d646e8048babc" + }, + "output": { + "LaunchTemplateData": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/xvda", + "Ebs": { + "DeleteOnTermination": true, + "Encrypted": false, + "Iops": 100, + "SnapshotId": "snap-02594938353ef77d3", + "VolumeSize": 8, + "VolumeType": "gp2" + } + } + ], + "EbsOptimized": false, + "ImageId": "ami-32cf7b4a", + "InstanceType": "t2.medium", + "KeyName": "my-key-pair", + "Monitoring": { + "Enabled": false + }, + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": false, + "DeleteOnTermination": true, + "Description": "", + "DeviceIndex": 0, + "Groups": [ + "sg-d14e1bb4" + ], + "Ipv6Addresses": [ + + ], + "NetworkInterfaceId": "eni-4338b5a9", + "PrivateIpAddress": "10.0.3.233", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.3.233" + } + ], + "SubnetId": "subnet-5264e837" + } + ], + "Placement": { + "AvailabilityZone": "us-east-2b", + "GroupName": "", + "Tenancy": "default" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example gets the launch template data for the specified instance.", + "id": "to-get-the-launch-template-data-for-an-instance--1529356515702", + "title": "To get the launch template data for an instance " + } + ], + "ModifyImageAttribute": [ + { + "input": { + "ImageId": "ami-5731123e", + "LaunchPermission": { + "Add": [ + { + "Group": "all" + } + ] + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example makes the specified AMI public.", + "id": "to-make-an-ami-public-1529357395278", + "title": "To make an AMI public" + }, + { + "input": { + "ImageId": "ami-5731123e", + "LaunchPermission": { + "Add": [ + { + "UserId": "123456789012" + } + ] + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example grants launch permissions for the specified AMI to the specified AWS account.", + "id": "to-grant-launch-permissions-1529357727906", + "title": "To grant launch permissions" + } + ], + "ModifyInstanceAttribute": [ + { + "input": { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": { + "Value": "m5.large" + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the instance type of the specified stopped instance.", + "id": "to-modify-the-instance-type-1529357844378", + "title": "To modify the instance type" + }, + { + "input": { + "EnaSupport": { + "Value": true + }, + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables enhanced networking for the specified stopped instance.", + "id": "to-enable-enhanced-networking-1529358279870", + "title": "To enable enhanced networking" + } + ], + "ModifyLaunchTemplate": [ + { + "input": { + "DefaultVersion": "2", + "LaunchTemplateId": "lt-0abcd290751193123" + }, + "output": { + "LaunchTemplate": { + "CreateTime": "2017-12-01T13:35:46.000Z", + "CreatedBy": "arn:aws:iam::123456789012:root", + "DefaultVersionNumber": 2, + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example specifies version 2 as the default version of the specified launch template.", + "id": "to-change-the-default-version-of-a-launch-template-1529358440364", + "title": "To change the default version of a launch template" + } + ], + "ModifyNetworkInterfaceAttribute": [ + { + "input": { + "Attachment": { + "AttachmentId": "eni-attach-43348162", + "DeleteOnTermination": false + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the attachment attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-1", + "title": "To modify the attachment attribute of a network interface" + }, + { + "input": { + "Description": { + "Value": "My description" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the description attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-2", + "title": "To modify the description attribute of a network interface" + }, + { + "input": { + "Groups": [ + "sg-903004f8", + "sg-1a2b3c4d" + ], + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command modifies the groupSet attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-3", + "title": "To modify the groupSet attribute of a network interface" + }, + { + "input": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": false + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command modifies the sourceDestCheck attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-4", + "title": "To modify the sourceDestCheck attribute of a network interface" + } + ], + "ModifySnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "OperationType": "remove", + "SnapshotId": "snap-1234567890abcdef0", + "UserIds": [ + "123456789012" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.", + "id": "to-modify-a-snapshot-attribute-1472508385907", + "title": "To modify a snapshot attribute" + }, + { + "input": { + "Attribute": "createVolumePermission", + "GroupNames": [ + "all" + ], + "OperationType": "add", + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example makes the snapshot ``snap-1234567890abcdef0`` public.", + "id": "to-make-a-snapshot-public-1472508470529", + "title": "To make a snapshot public" + } + ], + "ModifySpotFleetRequest": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "TargetCapacity": 20 + }, + "output": { + "Return": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example increases the target capacity of the specified Spot fleet request.", + "id": "ec2-modify-spot-fleet-request-1", + "title": "To increase the target capacity of a Spot fleet request" + }, + { + "input": { + "ExcessCapacityTerminationPolicy": "NoTermination ", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "TargetCapacity": 10 + }, + "output": { + "Return": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result.", + "id": "ec2-modify-spot-fleet-request-2", + "title": "To decrease the target capacity of a Spot fleet request" + } + ], + "ModifySubnetAttribute": [ + { + "input": { + "MapPublicIpOnLaunch": { + "Value": true + }, + "SubnetId": "subnet-1a2b3c4d" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.", + "id": "ec2-modify-subnet-attribute-1", + "title": "To change a subnet's public IP addressing behavior" + } + ], + "ModifyVolumeAttribute": [ + { + "input": { + "AutoEnableIO": { + "Value": true + }, + "DryRun": true, + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.", + "id": "to-modify-a-volume-attribute-1472508596749", + "title": "To modify a volume attribute" + } + ], + "ModifyVpcAttribute": [ + { + "input": { + "EnableDnsSupport": { + "Value": false + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.", + "id": "ec2-modify-vpc-attribute-1", + "title": "To modify the enableDnsSupport attribute" + }, + { + "input": { + "EnableDnsHostnames": { + "Value": false + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "id": "ec2-modify-vpc-attribute-2", + "title": "To modify the enableDnsHostnames attribute" + } + ], + "MoveAddressToVpc": [ + { + "input": { + "PublicIp": "54.123.4.56" + }, + "output": { + "Status": "MoveInProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example moves the specified Elastic IP address to the EC2-VPC platform.", + "id": "ec2-move-address-to-vpc-1", + "title": "To move an address to EC2-VPC" + } + ], + "PurchaseScheduledInstances": [ + { + "input": { + "PurchaseRequests": [ + { + "InstanceCount": 1, + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi..." + } + ] + }, + "output": { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "CreateDate": "2016-01-25T21:43:38.612Z", + "HourlyPrice": "0.095", + "InstanceCount": 1, + "InstanceType": "c4.large", + "NetworkPlatform": "EC2-VPC", + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "Platform": "Linux/UNIX", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "SlotDurationInHours": 32, + "TermEndDate": "2017-01-31T09:00:00Z", + "TermStartDate": "2016-01-31T09:00:00Z", + "TotalScheduledInstanceHours": 1696 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example purchases a Scheduled Instance.", + "id": "ec2-purchase-scheduled-instances-1", + "title": "To purchase a Scheduled Instance" + } + ], + "RebootInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef5" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example reboots the specified EC2 instance.", + "id": "to-reboot-an-ec2-instance-1529358566382", + "title": "To reboot an EC2 instance" + } + ], + "ReleaseAddress": [ + { + "input": { + "AllocationId": "eipalloc-64d5890a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example releases an Elastic IP address for use with instances in a VPC.", + "id": "ec2-release-address-1", + "title": "To release an Elastic IP address for EC2-VPC" + }, + { + "input": { + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example releases an Elastic IP address for use with instances in EC2-Classic.", + "id": "ec2-release-address-2", + "title": "To release an Elastic IP addresses for EC2-Classic" + } + ], + "ReplaceNetworkAclAssociation": [ + { + "input": { + "AssociationId": "aclassoc-e5b95c8c", + "NetworkAclId": "acl-5fb85d36" + }, + "output": { + "NewAssociationId": "aclassoc-3999875b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified network ACL with the subnet for the specified network ACL association.", + "id": "ec2-replace-network-acl-association-1", + "title": "To replace the network ACL associated with a subnet" + } + ], + "ReplaceNetworkAclEntry": [ + { + "input": { + "CidrBlock": "203.0.113.12/24", + "Egress": false, + "NetworkAclId": "acl-5fb85d36", + "PortRange": { + "From": 53, + "To": 53 + }, + "Protocol": "17", + "RuleAction": "allow", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.", + "id": "ec2-replace-network-acl-entry-1", + "title": "To replace a network ACL entry" + } + ], + "ReplaceRoute": [ + { + "input": { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway.", + "id": "ec2-replace-route-1", + "title": "To replace a route" + } + ], + "ReplaceRouteTableAssociation": [ + { + "input": { + "AssociationId": "rtbassoc-781d0d1a", + "RouteTableId": "rtb-22574640" + }, + "output": { + "NewAssociationId": "rtbassoc-3a1f0f58" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified route table with the subnet for the specified route table association.", + "id": "ec2-replace-route-table-association-1", + "title": "To replace the route table associated with a subnet" + } + ], + "RequestSpotFleet": [ + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ], + "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f" + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC, they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request.", + "id": "ec2-request-spot-fleet-1", + "title": "To request a Spot fleet in the subnet with the lowest price" + }, + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2a, us-west-2b" + }, + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ] + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the Availability Zone.", + "id": "ec2-request-spot-fleet-2", + "title": "To request a Spot fleet in the Availability Zone with the lowest price" + }, + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Groups": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-1a2b3c4d" + } + ] + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network interface, you must include the subnet ID and security group ID using the network interface.", + "id": "ec2-request-spot-fleet-3", + "title": "To launch Spot instances in a subnet and assign them public IP addresses" + }, + { + "input": { + "SpotFleetRequestConfig": { + "AllocationStrategy": "diversified", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "c4.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + } + ], + "SpotPrice": "0.70", + "TargetCapacity": 30 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications such that there are 10 instances of each type.", + "id": "ec2-request-spot-fleet-4", + "title": "To request a Spot fleet using the diversified allocation strategy" + } + ], + "RequestSpotInstances": [ + { + "input": { + "InstanceCount": 5, + "LaunchSpecification": { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2a" + }, + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ] + }, + "SpotPrice": "0.03", + "Type": "one-time" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the specified Availability Zone.", + "id": "ec2-request-spot-instances-1", + "title": "To create a one-time Spot Instance request" + }, + { + "input": { + "InstanceCount": 5, + "LaunchSpecification": { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-1a2b3c4d" + }, + "SpotPrice": "0.050", + "Type": "one-time" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP address by default.", + "id": "ec2-request-spot-instances-2", + "title": "To create a one-time Spot Instance request" + } + ], + "ResetImageAttribute": [ + { + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private.", + "id": "to-reset-the-launchpermission-attribute-1529359519534", + "title": "To reset the launchPermission attribute" + } + ], + "ResetInstanceAttribute": [ + { + "input": { + "Attribute": "sourceDestCheck", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets the sourceDestCheck attribute for the specified instance.", + "id": "to-reset-the-sourcedestcheck-attribute-1529359630708", + "title": "To reset the sourceDestCheck attribute" + } + ], + "ResetSnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "id": "to-reset-a-snapshot-attribute-1472508825735", + "title": "To reset a snapshot attribute" + } + ], + "RestoreAddressToClassic": [ + { + "input": { + "PublicIp": "198.51.100.0" + }, + "output": { + "PublicIp": "198.51.100.0", + "Status": "MoveInProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example restores the specified Elastic IP address to the EC2-Classic platform.", + "id": "ec2-restore-address-to-classic-1", + "title": "To restore an address to EC2-Classic" + } + ], + "RunInstances": [ + { + "input": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": 100 + } + } + ], + "ImageId": "ami-abc12345", + "InstanceType": "t2.micro", + "KeyName": "my-key-pair", + "MaxCount": 1, + "MinCount": 1, + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-6e7f829e", + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Purpose", + "Value": "test" + } + ] + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping, and tags.", + "id": "to-launch-an-instance-1529360150806", + "title": "To launch an instance" + } + ], + "RunScheduledInstances": [ + { + "input": { + "InstanceCount": 1, + "LaunchSpecification": { + "IamInstanceProfile": { + "Name": "my-iam-role" + }, + "ImageId": "ami-12345678", + "InstanceType": "c4.large", + "KeyName": "my-key-pair", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Groups": [ + "sg-12345678" + ], + "SubnetId": "subnet-12345678" + } + ] + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" + }, + "output": { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches the specified Scheduled Instance in a VPC.", + "id": "ec2-run-scheduled-instances-1", + "title": "To launch a Scheduled Instance in a VPC" + }, + { + "input": { + "InstanceCount": 1, + "LaunchSpecification": { + "IamInstanceProfile": { + "Name": "my-iam-role" + }, + "ImageId": "ami-12345678", + "InstanceType": "c4.large", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2b" + }, + "SecurityGroupIds": [ + "sg-12345678" + ] + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" + }, + "output": { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches the specified Scheduled Instance in EC2-Classic.", + "id": "ec2-run-scheduled-instances-2", + "title": "To launch a Scheduled Instance in EC2-Classic" + } + ], + "StartInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StartingInstances": [ + { + "CurrentState": { + "Code": 0, + "Name": "pending" + }, + "InstanceId": "i-1234567890abcdef0", + "PreviousState": { + "Code": 80, + "Name": "stopped" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example starts the specified EC2 instance.", + "id": "to-start-a-stopped-ec2-instance-1529358792730", + "title": "To start a stopped EC2 instance" + } + ], + "StopInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StoppingInstances": [ + { + "CurrentState": { + "Code": 64, + "Name": "stopping" + }, + "InstanceId": "i-1234567890abcdef0", + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example stops the specified EC2 instance.", + "id": "to-stop-a-running-ec2-instance-1529358905540", + "title": "To stop a running EC2 instance" + } + ], + "TerminateInstances": [ + { + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "TerminatingInstances": [ + { + "CurrentState": { + "Code": 32, + "Name": "shutting-down" + }, + "InstanceId": "i-1234567890abcdef0", + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example terminates the specified EC2 instance.", + "id": "to-terminate-an-ec2-instance-1529359350660", + "title": "To terminate an EC2 instance" + } + ], + "UnassignPrivateIpAddresses": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example unassigns the specified private IP address from the specified network interface.", + "id": "ec2-unassign-private-ip-addresses-1", + "title": "To unassign a secondary private IP address from a network interface" + } + ], + "UpdateSecurityGroupRuleDescriptionsEgress": [ + { + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "FromPort": 80, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "Outbound HTTP access to server 2" + } + ], + "ToPort": 80 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the description for the specified security group rule.", + "id": "to-update-an-outbound-security-group-rule-description-1529360481544", + "title": "To update an outbound security group rule description" + } + ], + "UpdateSecurityGroupRuleDescriptionsIngress": [ + { + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "FromPort": 22, + "IpProtocol": "tcp", + "IpRanges": [ + { + "CidrIp": "203.0.113.0/16", + "Description": "SSH access from the LA office" + } + ], + "ToPort": 22 + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the description for the specified security group rule.", + "id": "to-update-an-inbound-security-group-rule-description-1529360820372", + "title": "To update an inbound security group rule description" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json b/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json new file mode 100644 index 0000000..9516bac --- /dev/null +++ b/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json @@ -0,0 +1,17835 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-15", + "endpointPrefix": "ec2", + "protocol": "ec2", + "serviceAbbreviation": "Amazon EC2", + "serviceFullName": "Amazon Elastic Compute Cloud", + "serviceId": "EC2", + "signatureVersion": "v4", + "uid": "ec2-2016-11-15", + "xmlNamespace": "http://ec2.amazonaws.com/doc/2016-11-15" + }, + "operations": { + "AcceptReservedInstancesExchangeQuote": { + "input": { + "type": "structure", + "required": [ + "ReservedInstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ReservedInstanceIds": { + "shape": "S3", + "locationName": "ReservedInstanceId" + }, + "TargetConfigurations": { + "shape": "S5", + "locationName": "TargetConfiguration" + } + } + }, + "output": { + "type": "structure", + "members": { + "ExchangeId": { + "locationName": "exchangeId" + } + } + } + }, + "AcceptTransitGatewayVpcAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "Sb", + "locationName": "transitGatewayVpcAttachment" + } + } + } + }, + "AcceptVpcEndpointConnections": { + "input": { + "type": "structure", + "required": [ + "ServiceId", + "VpcEndpointIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceId": {}, + "VpcEndpointIds": { + "shape": "Sd", + "locationName": "VpcEndpointId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "Sm", + "locationName": "unsuccessful" + } + } + } + }, + "AcceptVpcPeeringConnection": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "shape": "Sr", + "locationName": "vpcPeeringConnection" + } + } + } + }, + "AdvertiseByoipCidr": { + "input": { + "type": "structure", + "required": [ + "Cidr" + ], + "members": { + "Cidr": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ByoipCidr": { + "shape": "S12", + "locationName": "byoipCidr" + } + } + } + }, + "AllocateAddress": { + "input": { + "type": "structure", + "members": { + "Domain": {}, + "Address": {}, + "PublicIpv4Pool": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicIp": { + "locationName": "publicIp" + }, + "AllocationId": { + "locationName": "allocationId" + }, + "PublicIpv4Pool": { + "locationName": "publicIpv4Pool" + }, + "Domain": { + "locationName": "domain" + } + } + } + }, + "AllocateHosts": { + "input": { + "type": "structure", + "required": [ + "AvailabilityZone", + "InstanceType", + "Quantity" + ], + "members": { + "AutoPlacement": { + "locationName": "autoPlacement" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "Quantity": { + "locationName": "quantity", + "type": "integer" + }, + "TagSpecifications": { + "shape": "S19", + "locationName": "TagSpecification" + } + } + }, + "output": { + "type": "structure", + "members": { + "HostIds": { + "shape": "S1d", + "locationName": "hostIdSet" + } + } + } + }, + "ApplySecurityGroupsToClientVpnTargetNetwork": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "VpcId", + "SecurityGroupIds" + ], + "members": { + "ClientVpnEndpointId": {}, + "VpcId": {}, + "SecurityGroupIds": { + "shape": "S1f", + "locationName": "SecurityGroupId" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "shape": "S1f", + "locationName": "securityGroupIds" + } + } + } + }, + "AssignIpv6Addresses": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "Ipv6AddressCount": { + "locationName": "ipv6AddressCount", + "type": "integer" + }, + "Ipv6Addresses": { + "shape": "S1i", + "locationName": "ipv6Addresses" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssignedIpv6Addresses": { + "shape": "S1i", + "locationName": "assignedIpv6Addresses" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + } + } + } + }, + "AssignPrivateIpAddresses": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "AllowReassignment": { + "locationName": "allowReassignment", + "type": "boolean" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "PrivateIpAddresses": { + "shape": "S1l", + "locationName": "privateIpAddress" + }, + "SecondaryPrivateIpAddressCount": { + "locationName": "secondaryPrivateIpAddressCount", + "type": "integer" + } + } + } + }, + "AssociateAddress": { + "input": { + "type": "structure", + "members": { + "AllocationId": {}, + "InstanceId": {}, + "PublicIp": {}, + "AllowReassociation": { + "locationName": "allowReassociation", + "type": "boolean" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + } + } + } + }, + "AssociateClientVpnTargetNetwork": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "SubnetId" + ], + "members": { + "ClientVpnEndpointId": {}, + "SubnetId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "Status": { + "shape": "S1q", + "locationName": "status" + } + } + } + }, + "AssociateDhcpOptions": { + "input": { + "type": "structure", + "required": [ + "DhcpOptionsId", + "VpcId" + ], + "members": { + "DhcpOptionsId": {}, + "VpcId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "AssociateIamInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "IamInstanceProfile", + "InstanceId" + ], + "members": { + "IamInstanceProfile": { + "shape": "S1u" + }, + "InstanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "shape": "S1w", + "locationName": "iamInstanceProfileAssociation" + } + } + } + }, + "AssociateRouteTable": { + "input": { + "type": "structure", + "required": [ + "RouteTableId", + "SubnetId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "RouteTableId": { + "locationName": "routeTableId" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + } + } + } + }, + "AssociateSubnetCidrBlock": { + "input": { + "type": "structure", + "required": [ + "Ipv6CidrBlock", + "SubnetId" + ], + "members": { + "Ipv6CidrBlock": { + "locationName": "ipv6CidrBlock" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "shape": "S23", + "locationName": "ipv6CidrBlockAssociation" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + } + }, + "AssociateTransitGatewayRouteTable": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Association": { + "shape": "S28", + "locationName": "association" + } + } + } + }, + "AssociateVpcCidrBlock": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "AmazonProvidedIpv6CidrBlock": { + "locationName": "amazonProvidedIpv6CidrBlock", + "type": "boolean" + }, + "CidrBlock": {}, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "shape": "S2d", + "locationName": "ipv6CidrBlockAssociation" + }, + "CidrBlockAssociation": { + "shape": "S2g", + "locationName": "cidrBlockAssociation" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "AttachClassicLinkVpc": { + "input": { + "type": "structure", + "required": [ + "Groups", + "InstanceId", + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Groups": { + "shape": "S2i", + "locationName": "SecurityGroupId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "AttachInternetGateway": { + "input": { + "type": "structure", + "required": [ + "InternetGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InternetGatewayId": { + "locationName": "internetGatewayId" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "AttachNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "DeviceIndex", + "InstanceId", + "NetworkInterfaceId" + ], + "members": { + "DeviceIndex": { + "locationName": "deviceIndex", + "type": "integer" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttachmentId": { + "locationName": "attachmentId" + } + } + } + }, + "AttachVolume": { + "input": { + "type": "structure", + "required": [ + "Device", + "InstanceId", + "VolumeId" + ], + "members": { + "Device": {}, + "InstanceId": {}, + "VolumeId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "shape": "S2o" + } + }, + "AttachVpnGateway": { + "input": { + "type": "structure", + "required": [ + "VpcId", + "VpnGatewayId" + ], + "members": { + "VpcId": {}, + "VpnGatewayId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcAttachment": { + "shape": "S2s", + "locationName": "attachment" + } + } + } + }, + "AuthorizeClientVpnIngress": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "members": { + "ClientVpnEndpointId": {}, + "TargetNetworkCidr": {}, + "AccessGroupId": {}, + "AuthorizeAllGroups": { + "type": "boolean" + }, + "Description": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": { + "shape": "S2w", + "locationName": "status" + } + } + } + }, + "AuthorizeSecurityGroupEgress": { + "input": { + "type": "structure", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "GroupId": { + "locationName": "groupId" + }, + "IpPermissions": { + "shape": "S2z", + "locationName": "ipPermissions" + }, + "CidrIp": { + "locationName": "cidrIp" + }, + "FromPort": { + "locationName": "fromPort", + "type": "integer" + }, + "IpProtocol": { + "locationName": "ipProtocol" + }, + "ToPort": { + "locationName": "toPort", + "type": "integer" + }, + "SourceSecurityGroupName": { + "locationName": "sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId": { + "locationName": "sourceSecurityGroupOwnerId" + } + } + } + }, + "AuthorizeSecurityGroupIngress": { + "input": { + "type": "structure", + "members": { + "CidrIp": {}, + "FromPort": { + "type": "integer" + }, + "GroupId": {}, + "GroupName": {}, + "IpPermissions": { + "shape": "S2z" + }, + "IpProtocol": {}, + "SourceSecurityGroupName": {}, + "SourceSecurityGroupOwnerId": {}, + "ToPort": { + "type": "integer" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "BundleInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "Storage" + ], + "members": { + "InstanceId": {}, + "Storage": { + "shape": "S3b" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "BundleTask": { + "shape": "S3f", + "locationName": "bundleInstanceTask" + } + } + } + }, + "CancelBundleTask": { + "input": { + "type": "structure", + "required": [ + "BundleId" + ], + "members": { + "BundleId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "BundleTask": { + "shape": "S3f", + "locationName": "bundleInstanceTask" + } + } + } + }, + "CancelCapacityReservation": { + "input": { + "type": "structure", + "required": [ + "CapacityReservationId" + ], + "members": { + "CapacityReservationId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "CancelConversionTask": { + "input": { + "type": "structure", + "required": [ + "ConversionTaskId" + ], + "members": { + "ConversionTaskId": { + "locationName": "conversionTaskId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "ReasonMessage": { + "locationName": "reasonMessage" + } + } + } + }, + "CancelExportTask": { + "input": { + "type": "structure", + "required": [ + "ExportTaskId" + ], + "members": { + "ExportTaskId": { + "locationName": "exportTaskId" + } + } + } + }, + "CancelImportTask": { + "input": { + "type": "structure", + "members": { + "CancelReason": {}, + "DryRun": { + "type": "boolean" + }, + "ImportTaskId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImportTaskId": { + "locationName": "importTaskId" + }, + "PreviousState": { + "locationName": "previousState" + }, + "State": { + "locationName": "state" + } + } + } + }, + "CancelReservedInstancesListing": { + "input": { + "type": "structure", + "required": [ + "ReservedInstancesListingId" + ], + "members": { + "ReservedInstancesListingId": { + "locationName": "reservedInstancesListingId" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape": "S3s", + "locationName": "reservedInstancesListingsSet" + } + } + } + }, + "CancelSpotFleetRequests": { + "input": { + "type": "structure", + "required": [ + "SpotFleetRequestIds", + "TerminateInstances" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "SpotFleetRequestIds": { + "shape": "Sd", + "locationName": "spotFleetRequestId" + }, + "TerminateInstances": { + "locationName": "terminateInstances", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "SuccessfulFleetRequests": { + "locationName": "successfulFleetRequestSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CurrentSpotFleetRequestState": { + "locationName": "currentSpotFleetRequestState" + }, + "PreviousSpotFleetRequestState": { + "locationName": "previousSpotFleetRequestState" + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + } + } + } + }, + "UnsuccessfulFleetRequests": { + "locationName": "unsuccessfulFleetRequestSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Error": { + "locationName": "error", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + } + } + } + } + } + } + }, + "CancelSpotInstanceRequests": { + "input": { + "type": "structure", + "required": [ + "SpotInstanceRequestIds" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "SpotInstanceRequestIds": { + "shape": "S4d", + "locationName": "SpotInstanceRequestId" + } + } + }, + "output": { + "type": "structure", + "members": { + "CancelledSpotInstanceRequests": { + "locationName": "spotInstanceRequestSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "SpotInstanceRequestId": { + "locationName": "spotInstanceRequestId" + }, + "State": { + "locationName": "state" + } + } + } + } + } + } + }, + "ConfirmProductInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "ProductCode" + ], + "members": { + "InstanceId": {}, + "ProductCode": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "OwnerId": { + "locationName": "ownerId" + }, + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "CopyFpgaImage": { + "input": { + "type": "structure", + "required": [ + "SourceFpgaImageId", + "SourceRegion" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SourceFpgaImageId": {}, + "Description": {}, + "Name": {}, + "SourceRegion": {}, + "ClientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FpgaImageId": { + "locationName": "fpgaImageId" + } + } + } + }, + "CopyImage": { + "input": { + "type": "structure", + "required": [ + "Name", + "SourceImageId", + "SourceRegion" + ], + "members": { + "ClientToken": {}, + "Description": {}, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "Name": {}, + "SourceImageId": {}, + "SourceRegion": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageId": { + "locationName": "imageId" + } + } + } + }, + "CopySnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceRegion", + "SourceSnapshotId" + ], + "members": { + "Description": {}, + "DestinationRegion": { + "locationName": "destinationRegion" + }, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "PresignedUrl": { + "locationName": "presignedUrl" + }, + "SourceRegion": {}, + "SourceSnapshotId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotId": { + "locationName": "snapshotId" + } + } + } + }, + "CreateCapacityReservation": { + "input": { + "type": "structure", + "required": [ + "InstanceType", + "InstancePlatform", + "AvailabilityZone", + "InstanceCount" + ], + "members": { + "ClientToken": {}, + "InstanceType": {}, + "InstancePlatform": {}, + "AvailabilityZone": {}, + "Tenancy": {}, + "InstanceCount": { + "type": "integer" + }, + "EbsOptimized": { + "type": "boolean" + }, + "EphemeralStorage": { + "type": "boolean" + }, + "EndDate": { + "type": "timestamp" + }, + "EndDateType": {}, + "InstanceMatchCriteria": {}, + "TagSpecifications": { + "shape": "S19" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CapacityReservation": { + "shape": "S4w", + "locationName": "capacityReservation" + } + } + } + }, + "CreateClientVpnEndpoint": { + "input": { + "type": "structure", + "required": [ + "ClientCidrBlock", + "ServerCertificateArn", + "AuthenticationOptions", + "ConnectionLogOptions" + ], + "members": { + "ClientCidrBlock": {}, + "ServerCertificateArn": {}, + "AuthenticationOptions": { + "locationName": "Authentication", + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "ActiveDirectory": { + "type": "structure", + "members": { + "DirectoryId": {} + } + }, + "MutualAuthentication": { + "type": "structure", + "members": { + "ClientRootCertificateChainArn": {} + } + } + } + } + }, + "ConnectionLogOptions": { + "shape": "S54" + }, + "DnsServers": { + "shape": "Sd" + }, + "TransportProtocol": {}, + "Description": {}, + "DryRun": { + "type": "boolean" + }, + "ClientToken": { + "idempotencyToken": true + }, + "TagSpecifications": { + "shape": "S19", + "locationName": "TagSpecification" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "locationName": "clientVpnEndpointId" + }, + "Status": { + "shape": "S57", + "locationName": "status" + }, + "DnsName": { + "locationName": "dnsName" + } + } + } + }, + "CreateClientVpnRoute": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "DestinationCidrBlock", + "TargetVpcSubnetId" + ], + "members": { + "ClientVpnEndpointId": {}, + "DestinationCidrBlock": {}, + "TargetVpcSubnetId": {}, + "Description": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": { + "shape": "S5b", + "locationName": "status" + } + } + } + }, + "CreateCustomerGateway": { + "input": { + "type": "structure", + "required": [ + "BgpAsn", + "PublicIp", + "Type" + ], + "members": { + "BgpAsn": { + "type": "integer" + }, + "PublicIp": { + "locationName": "IpAddress" + }, + "Type": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomerGateway": { + "shape": "S5g", + "locationName": "customerGateway" + } + } + } + }, + "CreateDefaultSubnet": { + "input": { + "type": "structure", + "required": [ + "AvailabilityZone" + ], + "members": { + "AvailabilityZone": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Subnet": { + "shape": "S5j", + "locationName": "subnet" + } + } + } + }, + "CreateDefaultVpc": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Vpc": { + "shape": "S5o", + "locationName": "vpc" + } + } + } + }, + "CreateDhcpOptions": { + "input": { + "type": "structure", + "required": [ + "DhcpConfigurations" + ], + "members": { + "DhcpConfigurations": { + "locationName": "dhcpConfiguration", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Key": { + "locationName": "key" + }, + "Values": { + "shape": "Sd", + "locationName": "Value" + } + } + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DhcpOptions": { + "shape": "S5x", + "locationName": "dhcpOptions" + } + } + } + }, + "CreateEgressOnlyInternetGateway": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "ClientToken": {}, + "DryRun": { + "type": "boolean" + }, + "VpcId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClientToken": { + "locationName": "clientToken" + }, + "EgressOnlyInternetGateway": { + "shape": "S64", + "locationName": "egressOnlyInternetGateway" + } + } + } + }, + "CreateFleet": { + "input": { + "type": "structure", + "required": [ + "LaunchTemplateConfigs", + "TargetCapacitySpecification" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ClientToken": {}, + "SpotOptions": { + "type": "structure", + "members": { + "AllocationStrategy": {}, + "InstanceInterruptionBehavior": {}, + "InstancePoolsToUseCount": { + "type": "integer" + }, + "SingleInstanceType": { + "type": "boolean" + }, + "SingleAvailabilityZone": { + "type": "boolean" + }, + "MinTargetCapacity": { + "type": "integer" + } + } + }, + "OnDemandOptions": { + "type": "structure", + "members": { + "AllocationStrategy": {}, + "SingleInstanceType": { + "type": "boolean" + }, + "SingleAvailabilityZone": { + "type": "boolean" + }, + "MinTargetCapacity": { + "type": "integer" + } + } + }, + "ExcessCapacityTerminationPolicy": {}, + "LaunchTemplateConfigs": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": {}, + "LaunchTemplateName": {}, + "Version": {} + } + }, + "Overrides": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceType": {}, + "MaxPrice": {}, + "SubnetId": {}, + "AvailabilityZone": {}, + "WeightedCapacity": { + "type": "double" + }, + "Priority": { + "type": "double" + }, + "Placement": { + "shape": "S6m" + } + } + } + } + } + } + }, + "TargetCapacitySpecification": { + "shape": "S6n" + }, + "TerminateInstancesWithExpiration": { + "type": "boolean" + }, + "Type": {}, + "ValidFrom": { + "type": "timestamp" + }, + "ValidUntil": { + "type": "timestamp" + }, + "ReplaceUnhealthyInstances": { + "type": "boolean" + }, + "TagSpecifications": { + "shape": "S19", + "locationName": "TagSpecification" + } + } + }, + "output": { + "type": "structure", + "members": { + "FleetId": { + "locationName": "fleetId" + }, + "Errors": { + "locationName": "errorSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "S6u", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "locationName": "lifecycle" + }, + "ErrorCode": { + "locationName": "errorCode" + }, + "ErrorMessage": { + "locationName": "errorMessage" + } + } + } + }, + "Instances": { + "locationName": "fleetInstanceSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "S6u", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "locationName": "lifecycle" + }, + "InstanceIds": { + "shape": "S71", + "locationName": "instanceIds" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "Platform": { + "locationName": "platform" + } + } + } + } + } + } + }, + "CreateFlowLogs": { + "input": { + "type": "structure", + "required": [ + "ResourceIds", + "ResourceType", + "TrafficType" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ClientToken": {}, + "DeliverLogsPermissionArn": {}, + "LogGroupName": {}, + "ResourceIds": { + "shape": "Sd", + "locationName": "ResourceId" + }, + "ResourceType": {}, + "TrafficType": {}, + "LogDestinationType": {}, + "LogDestination": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClientToken": { + "locationName": "clientToken" + }, + "FlowLogIds": { + "shape": "Sd", + "locationName": "flowLogIdSet" + }, + "Unsuccessful": { + "shape": "Sm", + "locationName": "unsuccessful" + } + } + } + }, + "CreateFpgaImage": { + "input": { + "type": "structure", + "required": [ + "InputStorageLocation" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InputStorageLocation": { + "shape": "S7a" + }, + "LogsStorageLocation": { + "shape": "S7a" + }, + "Description": {}, + "Name": {}, + "ClientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FpgaImageId": { + "locationName": "fpgaImageId" + }, + "FpgaImageGlobalId": { + "locationName": "fpgaImageGlobalId" + } + } + } + }, + "CreateImage": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "Name" + ], + "members": { + "BlockDeviceMappings": { + "shape": "S7d", + "locationName": "blockDeviceMapping" + }, + "Description": { + "locationName": "description" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "Name": { + "locationName": "name" + }, + "NoReboot": { + "locationName": "noReboot", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageId": { + "locationName": "imageId" + } + } + } + }, + "CreateInstanceExportTask": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "Description": { + "locationName": "description" + }, + "ExportToS3Task": { + "locationName": "exportToS3", + "type": "structure", + "members": { + "ContainerFormat": { + "locationName": "containerFormat" + }, + "DiskImageFormat": { + "locationName": "diskImageFormat" + }, + "S3Bucket": { + "locationName": "s3Bucket" + }, + "S3Prefix": { + "locationName": "s3Prefix" + } + } + }, + "InstanceId": { + "locationName": "instanceId" + }, + "TargetEnvironment": { + "locationName": "targetEnvironment" + } + } + }, + "output": { + "type": "structure", + "members": { + "ExportTask": { + "shape": "S7o", + "locationName": "exportTask" + } + } + } + }, + "CreateInternetGateway": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InternetGateway": { + "shape": "S7u", + "locationName": "internetGateway" + } + } + } + }, + "CreateKeyPair": { + "input": { + "type": "structure", + "required": [ + "KeyName" + ], + "members": { + "KeyName": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyFingerprint": { + "locationName": "keyFingerprint" + }, + "KeyMaterial": { + "locationName": "keyMaterial" + }, + "KeyName": { + "locationName": "keyName" + } + } + } + }, + "CreateLaunchTemplate": { + "input": { + "type": "structure", + "required": [ + "LaunchTemplateName", + "LaunchTemplateData" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ClientToken": {}, + "LaunchTemplateName": {}, + "VersionDescription": {}, + "LaunchTemplateData": { + "shape": "S7z" + } + } + }, + "output": { + "type": "structure", + "members": { + "LaunchTemplate": { + "shape": "S8z", + "locationName": "launchTemplate" + } + } + } + }, + "CreateLaunchTemplateVersion": { + "input": { + "type": "structure", + "required": [ + "LaunchTemplateData" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ClientToken": {}, + "LaunchTemplateId": {}, + "LaunchTemplateName": {}, + "SourceVersion": {}, + "VersionDescription": {}, + "LaunchTemplateData": { + "shape": "S7z" + } + } + }, + "output": { + "type": "structure", + "members": { + "LaunchTemplateVersion": { + "shape": "S92", + "locationName": "launchTemplateVersion" + } + } + } + }, + "CreateNatGateway": { + "input": { + "type": "structure", + "required": [ + "AllocationId", + "SubnetId" + ], + "members": { + "AllocationId": {}, + "ClientToken": {}, + "SubnetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClientToken": { + "locationName": "clientToken" + }, + "NatGateway": { + "shape": "S9v", + "locationName": "natGateway" + } + } + } + }, + "CreateNetworkAcl": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkAcl": { + "shape": "Sa2", + "locationName": "networkAcl" + } + } + } + }, + "CreateNetworkAclEntry": { + "input": { + "type": "structure", + "required": [ + "Egress", + "NetworkAclId", + "Protocol", + "RuleAction", + "RuleNumber" + ], + "members": { + "CidrBlock": { + "locationName": "cidrBlock" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Egress": { + "locationName": "egress", + "type": "boolean" + }, + "IcmpTypeCode": { + "shape": "Sa7", + "locationName": "Icmp" + }, + "Ipv6CidrBlock": { + "locationName": "ipv6CidrBlock" + }, + "NetworkAclId": { + "locationName": "networkAclId" + }, + "PortRange": { + "shape": "Sa8", + "locationName": "portRange" + }, + "Protocol": { + "locationName": "protocol" + }, + "RuleAction": { + "locationName": "ruleAction" + }, + "RuleNumber": { + "locationName": "ruleNumber", + "type": "integer" + } + } + } + }, + "CreateNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "Description": { + "locationName": "description" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Groups": { + "shape": "S86", + "locationName": "SecurityGroupId" + }, + "Ipv6AddressCount": { + "locationName": "ipv6AddressCount", + "type": "integer" + }, + "Ipv6Addresses": { + "shape": "S9a", + "locationName": "ipv6Addresses" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "PrivateIpAddresses": { + "shape": "S89", + "locationName": "privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount": { + "locationName": "secondaryPrivateIpAddressCount", + "type": "integer" + }, + "InterfaceType": {}, + "SubnetId": { + "locationName": "subnetId" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkInterface": { + "shape": "Sae", + "locationName": "networkInterface" + } + } + } + }, + "CreateNetworkInterfacePermission": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId", + "Permission" + ], + "members": { + "NetworkInterfaceId": {}, + "AwsAccountId": {}, + "AwsService": {}, + "Permission": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InterfacePermission": { + "shape": "Sas", + "locationName": "interfacePermission" + } + } + } + }, + "CreatePlacementGroup": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "GroupName": { + "locationName": "groupName" + }, + "Strategy": { + "locationName": "strategy" + }, + "PartitionCount": { + "type": "integer" + } + } + } + }, + "CreateReservedInstancesListing": { + "input": { + "type": "structure", + "required": [ + "ClientToken", + "InstanceCount", + "PriceSchedules", + "ReservedInstancesId" + ], + "members": { + "ClientToken": { + "locationName": "clientToken" + }, + "InstanceCount": { + "locationName": "instanceCount", + "type": "integer" + }, + "PriceSchedules": { + "locationName": "priceSchedules", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Price": { + "locationName": "price", + "type": "double" + }, + "Term": { + "locationName": "term", + "type": "long" + } + } + } + }, + "ReservedInstancesId": { + "locationName": "reservedInstancesId" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape": "S3s", + "locationName": "reservedInstancesListingsSet" + } + } + } + }, + "CreateRoute": { + "input": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DestinationCidrBlock": { + "locationName": "destinationCidrBlock" + }, + "DestinationIpv6CidrBlock": { + "locationName": "destinationIpv6CidrBlock" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EgressOnlyInternetGatewayId": { + "locationName": "egressOnlyInternetGatewayId" + }, + "GatewayId": { + "locationName": "gatewayId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "NatGatewayId": { + "locationName": "natGatewayId" + }, + "TransitGatewayId": {}, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "RouteTableId": { + "locationName": "routeTableId" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "CreateRouteTable": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "RouteTable": { + "shape": "Sb5", + "locationName": "routeTable" + } + } + } + }, + "CreateSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "Description", + "GroupName" + ], + "members": { + "Description": { + "locationName": "GroupDescription" + }, + "GroupName": {}, + "VpcId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupId": { + "locationName": "groupId" + } + } + } + }, + "CreateSnapshot": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "Description": {}, + "VolumeId": {}, + "TagSpecifications": { + "shape": "S19", + "locationName": "TagSpecification" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "shape": "Sbh" + } + }, + "CreateSpotDatafeedSubscription": { + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "locationName": "bucket" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Prefix": { + "locationName": "prefix" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "shape": "Sbl", + "locationName": "spotDatafeedSubscription" + } + } + } + }, + "CreateSubnet": { + "input": { + "type": "structure", + "required": [ + "CidrBlock", + "VpcId" + ], + "members": { + "AvailabilityZone": {}, + "AvailabilityZoneId": {}, + "CidrBlock": {}, + "Ipv6CidrBlock": {}, + "VpcId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Subnet": { + "shape": "S5j", + "locationName": "subnet" + } + } + } + }, + "CreateTags": { + "input": { + "type": "structure", + "required": [ + "Resources", + "Tags" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Resources": { + "shape": "Sbr", + "locationName": "ResourceId" + }, + "Tags": { + "shape": "Si", + "locationName": "Tag" + } + } + } + }, + "CreateTransitGateway": { + "input": { + "type": "structure", + "members": { + "Description": {}, + "Options": { + "type": "structure", + "members": { + "AmazonSideAsn": { + "type": "long" + }, + "AutoAcceptSharedAttachments": {}, + "DefaultRouteTableAssociation": {}, + "DefaultRouteTablePropagation": {}, + "VpnEcmpSupport": {}, + "DnsSupport": {} + } + }, + "TagSpecifications": { + "shape": "S19", + "locationName": "TagSpecification" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGateway": { + "shape": "Sbz", + "locationName": "transitGateway" + } + } + } + }, + "CreateTransitGatewayRoute": { + "input": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "TransitGatewayRouteTableId" + ], + "members": { + "DestinationCidrBlock": {}, + "TransitGatewayRouteTableId": {}, + "TransitGatewayAttachmentId": {}, + "Blackhole": { + "type": "boolean" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Route": { + "shape": "Sc4", + "locationName": "route" + } + } + } + }, + "CreateTransitGatewayRouteTable": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayId" + ], + "members": { + "TransitGatewayId": {}, + "TagSpecifications": { + "shape": "S19" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "shape": "Scb", + "locationName": "transitGatewayRouteTable" + } + } + } + }, + "CreateTransitGatewayVpcAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayId", + "VpcId", + "SubnetIds" + ], + "members": { + "TransitGatewayId": {}, + "VpcId": {}, + "SubnetIds": { + "shape": "Sd" + }, + "Options": { + "type": "structure", + "members": { + "DnsSupport": {}, + "Ipv6Support": {} + } + }, + "TagSpecifications": { + "shape": "S19" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "Sb", + "locationName": "transitGatewayVpcAttachment" + } + } + } + }, + "CreateVolume": { + "input": { + "type": "structure", + "required": [ + "AvailabilityZone" + ], + "members": { + "AvailabilityZone": {}, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "KmsKeyId": {}, + "Size": { + "type": "integer" + }, + "SnapshotId": {}, + "VolumeType": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "TagSpecifications": { + "shape": "S19", + "locationName": "TagSpecification" + } + } + }, + "output": { + "shape": "Sch" + } + }, + "CreateVpc": { + "input": { + "type": "structure", + "required": [ + "CidrBlock" + ], + "members": { + "CidrBlock": {}, + "AmazonProvidedIpv6CidrBlock": { + "locationName": "amazonProvidedIpv6CidrBlock", + "type": "boolean" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceTenancy": { + "locationName": "instanceTenancy" + } + } + }, + "output": { + "type": "structure", + "members": { + "Vpc": { + "shape": "S5o", + "locationName": "vpc" + } + } + } + }, + "CreateVpcEndpoint": { + "input": { + "type": "structure", + "required": [ + "VpcId", + "ServiceName" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcEndpointType": {}, + "VpcId": {}, + "ServiceName": {}, + "PolicyDocument": {}, + "RouteTableIds": { + "shape": "Sd", + "locationName": "RouteTableId" + }, + "SubnetIds": { + "shape": "Sd", + "locationName": "SubnetId" + }, + "SecurityGroupIds": { + "shape": "Sd", + "locationName": "SecurityGroupId" + }, + "ClientToken": {}, + "PrivateDnsEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcEndpoint": { + "shape": "Scp", + "locationName": "vpcEndpoint" + }, + "ClientToken": { + "locationName": "clientToken" + } + } + } + }, + "CreateVpcEndpointConnectionNotification": { + "input": { + "type": "structure", + "required": [ + "ConnectionNotificationArn", + "ConnectionEvents" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceId": {}, + "VpcEndpointId": {}, + "ConnectionNotificationArn": {}, + "ConnectionEvents": { + "shape": "Sd" + }, + "ClientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConnectionNotification": { + "shape": "Scy", + "locationName": "connectionNotification" + }, + "ClientToken": { + "locationName": "clientToken" + } + } + } + }, + "CreateVpcEndpointServiceConfiguration": { + "input": { + "type": "structure", + "required": [ + "NetworkLoadBalancerArns" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "AcceptanceRequired": { + "type": "boolean" + }, + "NetworkLoadBalancerArns": { + "shape": "Sd", + "locationName": "NetworkLoadBalancerArn" + }, + "ClientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceConfiguration": { + "shape": "Sd3", + "locationName": "serviceConfiguration" + }, + "ClientToken": { + "locationName": "clientToken" + } + } + } + }, + "CreateVpcPeeringConnection": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "PeerOwnerId": { + "locationName": "peerOwnerId" + }, + "PeerVpcId": { + "locationName": "peerVpcId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "PeerRegion": {} + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "shape": "Sr", + "locationName": "vpcPeeringConnection" + } + } + } + }, + "CreateVpnConnection": { + "input": { + "type": "structure", + "required": [ + "CustomerGatewayId", + "Type" + ], + "members": { + "CustomerGatewayId": {}, + "Type": {}, + "VpnGatewayId": {}, + "TransitGatewayId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Options": { + "locationName": "options", + "type": "structure", + "members": { + "StaticRoutesOnly": { + "locationName": "staticRoutesOnly", + "type": "boolean" + }, + "TunnelOptions": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "TunnelInsideCidr": {}, + "PreSharedKey": {} + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnConnection": { + "shape": "Sdf", + "locationName": "vpnConnection" + } + } + } + }, + "CreateVpnConnectionRoute": { + "input": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "VpnConnectionId" + ], + "members": { + "DestinationCidrBlock": {}, + "VpnConnectionId": {} + } + } + }, + "CreateVpnGateway": { + "input": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "AvailabilityZone": {}, + "Type": {}, + "AmazonSideAsn": { + "type": "long" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnGateway": { + "shape": "Sdr", + "locationName": "vpnGateway" + } + } + } + }, + "DeleteClientVpnEndpoint": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": { + "shape": "S57", + "locationName": "status" + } + } + } + }, + "DeleteClientVpnRoute": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "DestinationCidrBlock" + ], + "members": { + "ClientVpnEndpointId": {}, + "TargetVpcSubnetId": {}, + "DestinationCidrBlock": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": { + "shape": "S5b", + "locationName": "status" + } + } + } + }, + "DeleteCustomerGateway": { + "input": { + "type": "structure", + "required": [ + "CustomerGatewayId" + ], + "members": { + "CustomerGatewayId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteDhcpOptions": { + "input": { + "type": "structure", + "required": [ + "DhcpOptionsId" + ], + "members": { + "DhcpOptionsId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteEgressOnlyInternetGateway": { + "input": { + "type": "structure", + "required": [ + "EgressOnlyInternetGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "EgressOnlyInternetGatewayId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReturnCode": { + "locationName": "returnCode", + "type": "boolean" + } + } + } + }, + "DeleteFleets": { + "input": { + "type": "structure", + "required": [ + "FleetIds", + "TerminateInstances" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "FleetIds": { + "shape": "Se2", + "locationName": "FleetId" + }, + "TerminateInstances": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "SuccessfulFleetDeletions": { + "locationName": "successfulFleetDeletionSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CurrentFleetState": { + "locationName": "currentFleetState" + }, + "PreviousFleetState": { + "locationName": "previousFleetState" + }, + "FleetId": { + "locationName": "fleetId" + } + } + } + }, + "UnsuccessfulFleetDeletions": { + "locationName": "unsuccessfulFleetDeletionSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Error": { + "locationName": "error", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "FleetId": { + "locationName": "fleetId" + } + } + } + } + } + } + }, + "DeleteFlowLogs": { + "input": { + "type": "structure", + "required": [ + "FlowLogIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "FlowLogIds": { + "shape": "Sd", + "locationName": "FlowLogId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "Sm", + "locationName": "unsuccessful" + } + } + } + }, + "DeleteFpgaImage": { + "input": { + "type": "structure", + "required": [ + "FpgaImageId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "FpgaImageId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "DeleteInternetGateway": { + "input": { + "type": "structure", + "required": [ + "InternetGatewayId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InternetGatewayId": { + "locationName": "internetGatewayId" + } + } + } + }, + "DeleteKeyPair": { + "input": { + "type": "structure", + "required": [ + "KeyName" + ], + "members": { + "KeyName": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteLaunchTemplate": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "LaunchTemplateId": {}, + "LaunchTemplateName": {} + } + }, + "output": { + "type": "structure", + "members": { + "LaunchTemplate": { + "shape": "S8z", + "locationName": "launchTemplate" + } + } + } + }, + "DeleteLaunchTemplateVersions": { + "input": { + "type": "structure", + "required": [ + "Versions" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "LaunchTemplateId": {}, + "LaunchTemplateName": {}, + "Versions": { + "shape": "Sek", + "locationName": "LaunchTemplateVersion" + } + } + }, + "output": { + "type": "structure", + "members": { + "SuccessfullyDeletedLaunchTemplateVersions": { + "locationName": "successfullyDeletedLaunchTemplateVersionSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateId": { + "locationName": "launchTemplateId" + }, + "LaunchTemplateName": { + "locationName": "launchTemplateName" + }, + "VersionNumber": { + "locationName": "versionNumber", + "type": "long" + } + } + } + }, + "UnsuccessfullyDeletedLaunchTemplateVersions": { + "locationName": "unsuccessfullyDeletedLaunchTemplateVersionSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateId": { + "locationName": "launchTemplateId" + }, + "LaunchTemplateName": { + "locationName": "launchTemplateName" + }, + "VersionNumber": { + "locationName": "versionNumber", + "type": "long" + }, + "ResponseError": { + "locationName": "responseError", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + } + } + } + } + } + } + }, + "DeleteNatGateway": { + "input": { + "type": "structure", + "required": [ + "NatGatewayId" + ], + "members": { + "NatGatewayId": {} + } + }, + "output": { + "type": "structure", + "members": { + "NatGatewayId": { + "locationName": "natGatewayId" + } + } + } + }, + "DeleteNetworkAcl": { + "input": { + "type": "structure", + "required": [ + "NetworkAclId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkAclId": { + "locationName": "networkAclId" + } + } + } + }, + "DeleteNetworkAclEntry": { + "input": { + "type": "structure", + "required": [ + "Egress", + "NetworkAclId", + "RuleNumber" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Egress": { + "locationName": "egress", + "type": "boolean" + }, + "NetworkAclId": { + "locationName": "networkAclId" + }, + "RuleNumber": { + "locationName": "ruleNumber", + "type": "integer" + } + } + } + }, + "DeleteNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + } + } + } + }, + "DeleteNetworkInterfacePermission": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfacePermissionId" + ], + "members": { + "NetworkInterfacePermissionId": {}, + "Force": { + "type": "boolean" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "DeletePlacementGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "GroupName": { + "locationName": "groupName" + } + } + } + }, + "DeleteRoute": { + "input": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DestinationCidrBlock": { + "locationName": "destinationCidrBlock" + }, + "DestinationIpv6CidrBlock": { + "locationName": "destinationIpv6CidrBlock" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "RouteTableId": { + "locationName": "routeTableId" + } + } + } + }, + "DeleteRouteTable": { + "input": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "RouteTableId": { + "locationName": "routeTableId" + } + } + } + }, + "DeleteSecurityGroup": { + "input": { + "type": "structure", + "members": { + "GroupId": {}, + "GroupName": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotId" + ], + "members": { + "SnapshotId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteSpotDatafeedSubscription": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteSubnet": { + "input": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "SubnetId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "Resources" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Resources": { + "shape": "Sbr", + "locationName": "resourceId" + }, + "Tags": { + "shape": "Si", + "locationName": "tag" + } + } + } + }, + "DeleteTransitGateway": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayId" + ], + "members": { + "TransitGatewayId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGateway": { + "shape": "Sbz", + "locationName": "transitGateway" + } + } + } + }, + "DeleteTransitGatewayRoute": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "DestinationCidrBlock" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "DestinationCidrBlock": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Route": { + "shape": "Sc4", + "locationName": "route" + } + } + } + }, + "DeleteTransitGatewayRouteTable": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "shape": "Scb", + "locationName": "transitGatewayRouteTable" + } + } + } + }, + "DeleteTransitGatewayVpcAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "Sb", + "locationName": "transitGatewayVpcAttachment" + } + } + } + }, + "DeleteVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteVpc": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "VpcId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteVpcEndpointConnectionNotifications": { + "input": { + "type": "structure", + "required": [ + "ConnectionNotificationIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ConnectionNotificationIds": { + "shape": "Sd", + "locationName": "ConnectionNotificationId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "Sm", + "locationName": "unsuccessful" + } + } + } + }, + "DeleteVpcEndpointServiceConfigurations": { + "input": { + "type": "structure", + "required": [ + "ServiceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceIds": { + "shape": "Sd", + "locationName": "ServiceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "Sm", + "locationName": "unsuccessful" + } + } + } + }, + "DeleteVpcEndpoints": { + "input": { + "type": "structure", + "required": [ + "VpcEndpointIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcEndpointIds": { + "shape": "Sd", + "locationName": "VpcEndpointId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "Sm", + "locationName": "unsuccessful" + } + } + } + }, + "DeleteVpcPeeringConnection": { + "input": { + "type": "structure", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "DeleteVpnConnection": { + "input": { + "type": "structure", + "required": [ + "VpnConnectionId" + ], + "members": { + "VpnConnectionId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeleteVpnConnectionRoute": { + "input": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "VpnConnectionId" + ], + "members": { + "DestinationCidrBlock": {}, + "VpnConnectionId": {} + } + } + }, + "DeleteVpnGateway": { + "input": { + "type": "structure", + "required": [ + "VpnGatewayId" + ], + "members": { + "VpnGatewayId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DeprovisionByoipCidr": { + "input": { + "type": "structure", + "required": [ + "Cidr" + ], + "members": { + "Cidr": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ByoipCidr": { + "shape": "S12", + "locationName": "byoipCidr" + } + } + } + }, + "DeregisterImage": { + "input": { + "type": "structure", + "required": [ + "ImageId" + ], + "members": { + "ImageId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DescribeAccountAttributes": { + "input": { + "type": "structure", + "members": { + "AttributeNames": { + "locationName": "attributeName", + "type": "list", + "member": { + "locationName": "attributeName" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "AccountAttributes": { + "locationName": "accountAttributeSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AttributeName": { + "locationName": "attributeName" + }, + "AttributeValues": { + "locationName": "attributeValueSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AttributeValue": { + "locationName": "attributeValue" + } + } + } + } + } + } + } + } + } + }, + "DescribeAddresses": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "PublicIps": { + "locationName": "PublicIp", + "type": "list", + "member": { + "locationName": "PublicIp" + } + }, + "AllocationIds": { + "locationName": "AllocationId", + "type": "list", + "member": { + "locationName": "AllocationId" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Addresses": { + "locationName": "addressesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "PublicIp": { + "locationName": "publicIp" + }, + "AllocationId": { + "locationName": "allocationId" + }, + "AssociationId": { + "locationName": "associationId" + }, + "Domain": { + "locationName": "domain" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "NetworkInterfaceOwnerId": { + "locationName": "networkInterfaceOwnerId" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "PublicIpv4Pool": { + "locationName": "publicIpv4Pool" + } + } + } + } + } + } + }, + "DescribeAggregateIdFormat": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "UseLongIdsAggregated": { + "locationName": "useLongIdsAggregated", + "type": "boolean" + }, + "Statuses": { + "shape": "Sgd", + "locationName": "statusSet" + } + } + } + }, + "DescribeAvailabilityZones": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "ZoneNames": { + "locationName": "ZoneName", + "type": "list", + "member": { + "locationName": "ZoneName" + } + }, + "ZoneIds": { + "locationName": "ZoneId", + "type": "list", + "member": { + "locationName": "ZoneId" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "AvailabilityZones": { + "locationName": "availabilityZoneInfo", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "State": { + "locationName": "zoneState" + }, + "Messages": { + "locationName": "messageSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Message": { + "locationName": "message" + } + } + } + }, + "RegionName": { + "locationName": "regionName" + }, + "ZoneName": { + "locationName": "zoneName" + }, + "ZoneId": { + "locationName": "zoneId" + } + } + } + } + } + } + }, + "DescribeBundleTasks": { + "input": { + "type": "structure", + "members": { + "BundleIds": { + "locationName": "BundleId", + "type": "list", + "member": { + "locationName": "BundleId" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "BundleTasks": { + "locationName": "bundleInstanceTasksSet", + "type": "list", + "member": { + "shape": "S3f", + "locationName": "item" + } + } + } + } + }, + "DescribeByoipCidrs": { + "input": { + "type": "structure", + "required": [ + "MaxResults" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ByoipCidrs": { + "locationName": "byoipCidrSet", + "type": "list", + "member": { + "shape": "S12", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeCapacityReservations": { + "input": { + "type": "structure", + "members": { + "CapacityReservationIds": { + "locationName": "CapacityReservationId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "CapacityReservations": { + "locationName": "capacityReservationSet", + "type": "list", + "member": { + "shape": "S4w", + "locationName": "item" + } + } + } + } + }, + "DescribeClassicLinkInstances": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "locationName": "instancesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Groups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeClientVpnAuthorizationRules": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "DryRun": { + "type": "boolean" + }, + "NextToken": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AuthorizationRules": { + "locationName": "authorizationRule", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "locationName": "clientVpnEndpointId" + }, + "Description": { + "locationName": "description" + }, + "GroupId": { + "locationName": "groupId" + }, + "AccessAll": { + "locationName": "accessAll", + "type": "boolean" + }, + "DestinationCidr": { + "locationName": "destinationCidr" + }, + "Status": { + "shape": "S2w", + "locationName": "status" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeClientVpnConnections": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Connections": { + "locationName": "connections", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "locationName": "clientVpnEndpointId" + }, + "Timestamp": { + "locationName": "timestamp" + }, + "ConnectionId": { + "locationName": "connectionId" + }, + "Username": { + "locationName": "username" + }, + "ConnectionEstablishedTime": { + "locationName": "connectionEstablishedTime" + }, + "IngressBytes": { + "locationName": "ingressBytes" + }, + "EgressBytes": { + "locationName": "egressBytes" + }, + "IngressPackets": { + "locationName": "ingressPackets" + }, + "EgressPackets": { + "locationName": "egressPackets" + }, + "ClientIp": { + "locationName": "clientIp" + }, + "CommonName": { + "locationName": "commonName" + }, + "Status": { + "shape": "She", + "locationName": "status" + }, + "ConnectionEndTime": { + "locationName": "connectionEndTime" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeClientVpnEndpoints": { + "input": { + "type": "structure", + "members": { + "ClientVpnEndpointIds": { + "shape": "Sd", + "locationName": "ClientVpnEndpointId" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClientVpnEndpoints": { + "locationName": "clientVpnEndpoint", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "locationName": "clientVpnEndpointId" + }, + "Description": { + "locationName": "description" + }, + "Status": { + "shape": "S57", + "locationName": "status" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "DeletionTime": { + "locationName": "deletionTime" + }, + "DnsName": { + "locationName": "dnsName" + }, + "ClientCidrBlock": { + "locationName": "clientCidrBlock" + }, + "DnsServers": { + "shape": "Sd", + "locationName": "dnsServer" + }, + "SplitTunnel": { + "locationName": "splitTunnel", + "type": "boolean" + }, + "VpnProtocol": { + "locationName": "vpnProtocol" + }, + "TransportProtocol": { + "locationName": "transportProtocol" + }, + "AssociatedTargetNetworks": { + "deprecated": true, + "deprecatedMessage": "This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.", + "locationName": "associatedTargetNetwork", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "NetworkId": { + "locationName": "networkId" + }, + "NetworkType": { + "locationName": "networkType" + } + } + } + }, + "ServerCertificateArn": { + "locationName": "serverCertificateArn" + }, + "AuthenticationOptions": { + "locationName": "authenticationOptions", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Type": { + "locationName": "type" + }, + "ActiveDirectory": { + "locationName": "activeDirectory", + "type": "structure", + "members": { + "DirectoryId": { + "locationName": "directoryId" + } + } + }, + "MutualAuthentication": { + "locationName": "mutualAuthentication", + "type": "structure", + "members": { + "ClientRootCertificateChain": { + "locationName": "clientRootCertificateChain" + } + } + } + } + } + }, + "ConnectionLogOptions": { + "locationName": "connectionLogOptions", + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "CloudwatchLogGroup": {}, + "CloudwatchLogStream": {} + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeClientVpnRoutes": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Routes": { + "locationName": "routes", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "locationName": "clientVpnEndpointId" + }, + "DestinationCidr": { + "locationName": "destinationCidr" + }, + "TargetSubnet": { + "locationName": "targetSubnet" + }, + "Type": { + "locationName": "type" + }, + "Origin": { + "locationName": "origin" + }, + "Status": { + "shape": "S5b", + "locationName": "status" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeClientVpnTargetNetworks": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "AssociationIds": { + "shape": "Sd" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClientVpnTargetNetworks": { + "locationName": "clientVpnTargetNetworks", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "TargetNetworkId": { + "locationName": "targetNetworkId" + }, + "ClientVpnEndpointId": { + "locationName": "clientVpnEndpointId" + }, + "Status": { + "shape": "S1q", + "locationName": "status" + }, + "SecurityGroups": { + "shape": "Sd", + "locationName": "securityGroups" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeConversionTasks": { + "input": { + "type": "structure", + "members": { + "ConversionTaskIds": { + "locationName": "conversionTaskId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConversionTasks": { + "locationName": "conversionTasks", + "type": "list", + "member": { + "shape": "Si5", + "locationName": "item" + } + } + } + } + }, + "DescribeCustomerGateways": { + "input": { + "type": "structure", + "members": { + "CustomerGatewayIds": { + "locationName": "CustomerGatewayId", + "type": "list", + "member": { + "locationName": "CustomerGatewayId" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomerGateways": { + "locationName": "customerGatewaySet", + "type": "list", + "member": { + "shape": "S5g", + "locationName": "item" + } + } + } + } + }, + "DescribeDhcpOptions": { + "input": { + "type": "structure", + "members": { + "DhcpOptionsIds": { + "locationName": "DhcpOptionsId", + "type": "list", + "member": { + "locationName": "DhcpOptionsId" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DhcpOptions": { + "locationName": "dhcpOptionsSet", + "type": "list", + "member": { + "shape": "S5x", + "locationName": "item" + } + } + } + } + }, + "DescribeEgressOnlyInternetGateways": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "EgressOnlyInternetGatewayIds": { + "locationName": "EgressOnlyInternetGatewayId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "EgressOnlyInternetGateways": { + "locationName": "egressOnlyInternetGatewaySet", + "type": "list", + "member": { + "shape": "S64", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeElasticGpus": { + "input": { + "type": "structure", + "members": { + "ElasticGpuIds": { + "locationName": "ElasticGpuId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ElasticGpuSet": { + "locationName": "elasticGpuSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ElasticGpuId": { + "locationName": "elasticGpuId" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "ElasticGpuType": { + "locationName": "elasticGpuType" + }, + "ElasticGpuHealth": { + "locationName": "elasticGpuHealth", + "type": "structure", + "members": { + "Status": { + "locationName": "status" + } + } + }, + "ElasticGpuState": { + "locationName": "elasticGpuState" + }, + "InstanceId": { + "locationName": "instanceId" + } + } + } + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeExportTasks": { + "input": { + "type": "structure", + "members": { + "ExportTaskIds": { + "locationName": "exportTaskId", + "type": "list", + "member": { + "locationName": "ExportTaskId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ExportTasks": { + "locationName": "exportTaskSet", + "type": "list", + "member": { + "shape": "S7o", + "locationName": "item" + } + } + } + } + }, + "DescribeFleetHistory": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "StartTime" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "EventType": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "FleetId": {}, + "StartTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "HistoryRecords": { + "locationName": "historyRecordSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "EventInformation": { + "shape": "Sj6", + "locationName": "eventInformation" + }, + "EventType": { + "locationName": "eventType" + }, + "Timestamp": { + "locationName": "timestamp", + "type": "timestamp" + } + } + } + }, + "LastEvaluatedTime": { + "locationName": "lastEvaluatedTime", + "type": "timestamp" + }, + "NextToken": { + "locationName": "nextToken" + }, + "FleetId": { + "locationName": "fleetId" + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + } + } + } + }, + "DescribeFleetInstances": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "FleetId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + } + } + }, + "output": { + "type": "structure", + "members": { + "ActiveInstances": { + "shape": "Sj9", + "locationName": "activeInstanceSet" + }, + "NextToken": { + "locationName": "nextToken" + }, + "FleetId": { + "locationName": "fleetId" + } + } + } + }, + "DescribeFleets": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "FleetIds": { + "shape": "Se2", + "locationName": "FleetId" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Fleets": { + "locationName": "fleetSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ActivityStatus": { + "locationName": "activityStatus" + }, + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "FleetId": { + "locationName": "fleetId" + }, + "FleetState": { + "locationName": "fleetState" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "ExcessCapacityTerminationPolicy": { + "locationName": "excessCapacityTerminationPolicy" + }, + "FulfilledCapacity": { + "locationName": "fulfilledCapacity", + "type": "double" + }, + "FulfilledOnDemandCapacity": { + "locationName": "fulfilledOnDemandCapacity", + "type": "double" + }, + "LaunchTemplateConfigs": { + "locationName": "launchTemplateConfigs", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "shape": "S6v", + "locationName": "launchTemplateSpecification" + }, + "Overrides": { + "locationName": "overrides", + "type": "list", + "member": { + "shape": "S6w", + "locationName": "item" + } + } + } + } + }, + "TargetCapacitySpecification": { + "locationName": "targetCapacitySpecification", + "type": "structure", + "members": { + "TotalTargetCapacity": { + "locationName": "totalTargetCapacity", + "type": "integer" + }, + "OnDemandTargetCapacity": { + "locationName": "onDemandTargetCapacity", + "type": "integer" + }, + "SpotTargetCapacity": { + "locationName": "spotTargetCapacity", + "type": "integer" + }, + "DefaultTargetCapacityType": { + "locationName": "defaultTargetCapacityType" + } + } + }, + "TerminateInstancesWithExpiration": { + "locationName": "terminateInstancesWithExpiration", + "type": "boolean" + }, + "Type": { + "locationName": "type" + }, + "ValidFrom": { + "locationName": "validFrom", + "type": "timestamp" + }, + "ValidUntil": { + "locationName": "validUntil", + "type": "timestamp" + }, + "ReplaceUnhealthyInstances": { + "locationName": "replaceUnhealthyInstances", + "type": "boolean" + }, + "SpotOptions": { + "locationName": "spotOptions", + "type": "structure", + "members": { + "AllocationStrategy": { + "locationName": "allocationStrategy" + }, + "InstanceInterruptionBehavior": { + "locationName": "instanceInterruptionBehavior" + }, + "InstancePoolsToUseCount": { + "locationName": "instancePoolsToUseCount", + "type": "integer" + }, + "SingleInstanceType": { + "locationName": "singleInstanceType", + "type": "boolean" + }, + "SingleAvailabilityZone": { + "locationName": "singleAvailabilityZone", + "type": "boolean" + }, + "MinTargetCapacity": { + "locationName": "minTargetCapacity", + "type": "integer" + } + } + }, + "OnDemandOptions": { + "locationName": "onDemandOptions", + "type": "structure", + "members": { + "AllocationStrategy": { + "locationName": "allocationStrategy" + }, + "SingleInstanceType": { + "locationName": "singleInstanceType", + "type": "boolean" + }, + "SingleAvailabilityZone": { + "locationName": "singleAvailabilityZone", + "type": "boolean" + }, + "MinTargetCapacity": { + "locationName": "minTargetCapacity", + "type": "integer" + } + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "Errors": { + "locationName": "errorSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "S6u", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "locationName": "lifecycle" + }, + "ErrorCode": { + "locationName": "errorCode" + }, + "ErrorMessage": { + "locationName": "errorMessage" + } + } + } + }, + "Instances": { + "locationName": "fleetInstanceSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "S6u", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "locationName": "lifecycle" + }, + "InstanceIds": { + "shape": "S71", + "locationName": "instanceIds" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "Platform": { + "locationName": "platform" + } + } + } + } + } + } + } + } + } + }, + "DescribeFlowLogs": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filter": { + "shape": "Sg4" + }, + "FlowLogIds": { + "shape": "Sd", + "locationName": "FlowLogId" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FlowLogs": { + "locationName": "flowLogSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp" + }, + "DeliverLogsErrorMessage": { + "locationName": "deliverLogsErrorMessage" + }, + "DeliverLogsPermissionArn": { + "locationName": "deliverLogsPermissionArn" + }, + "DeliverLogsStatus": { + "locationName": "deliverLogsStatus" + }, + "FlowLogId": { + "locationName": "flowLogId" + }, + "FlowLogStatus": { + "locationName": "flowLogStatus" + }, + "LogGroupName": { + "locationName": "logGroupName" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "TrafficType": { + "locationName": "trafficType" + }, + "LogDestinationType": { + "locationName": "logDestinationType" + }, + "LogDestination": { + "locationName": "logDestination" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeFpgaImageAttribute": { + "input": { + "type": "structure", + "required": [ + "FpgaImageId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "FpgaImageId": {}, + "Attribute": {} + } + }, + "output": { + "type": "structure", + "members": { + "FpgaImageAttribute": { + "shape": "Sjy", + "locationName": "fpgaImageAttribute" + } + } + } + }, + "DescribeFpgaImages": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "FpgaImageIds": { + "locationName": "FpgaImageId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "Owners": { + "shape": "Sk7", + "locationName": "Owner" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FpgaImages": { + "locationName": "fpgaImageSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "FpgaImageId": { + "locationName": "fpgaImageId" + }, + "FpgaImageGlobalId": { + "locationName": "fpgaImageGlobalId" + }, + "Name": { + "locationName": "name" + }, + "Description": { + "locationName": "description" + }, + "ShellVersion": { + "locationName": "shellVersion" + }, + "PciId": { + "locationName": "pciId", + "type": "structure", + "members": { + "DeviceId": {}, + "VendorId": {}, + "SubsystemId": {}, + "SubsystemVendorId": {} + } + }, + "State": { + "locationName": "state", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "UpdateTime": { + "locationName": "updateTime", + "type": "timestamp" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "OwnerAlias": { + "locationName": "ownerAlias" + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + }, + "Tags": { + "shape": "Si", + "locationName": "tags" + }, + "Public": { + "locationName": "public", + "type": "boolean" + }, + "DataRetentionSupport": { + "locationName": "dataRetentionSupport", + "type": "boolean" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeHostReservationOfferings": { + "input": { + "type": "structure", + "members": { + "Filter": { + "shape": "Sg4" + }, + "MaxDuration": { + "type": "integer" + }, + "MaxResults": { + "type": "integer" + }, + "MinDuration": { + "type": "integer" + }, + "NextToken": {}, + "OfferingId": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "OfferingSet": { + "locationName": "offeringSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "HourlyPrice": { + "locationName": "hourlyPrice" + }, + "InstanceFamily": { + "locationName": "instanceFamily" + }, + "OfferingId": { + "locationName": "offeringId" + }, + "PaymentOption": { + "locationName": "paymentOption" + }, + "UpfrontPrice": { + "locationName": "upfrontPrice" + } + } + } + } + } + } + }, + "DescribeHostReservations": { + "input": { + "type": "structure", + "members": { + "Filter": { + "shape": "Sg4" + }, + "HostReservationIdSet": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "HostReservationSet": { + "locationName": "hostReservationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Count": { + "locationName": "count", + "type": "integer" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "End": { + "locationName": "end", + "type": "timestamp" + }, + "HostIdSet": { + "shape": "Skp", + "locationName": "hostIdSet" + }, + "HostReservationId": { + "locationName": "hostReservationId" + }, + "HourlyPrice": { + "locationName": "hourlyPrice" + }, + "InstanceFamily": { + "locationName": "instanceFamily" + }, + "OfferingId": { + "locationName": "offeringId" + }, + "PaymentOption": { + "locationName": "paymentOption" + }, + "Start": { + "locationName": "start", + "type": "timestamp" + }, + "State": { + "locationName": "state" + }, + "UpfrontPrice": { + "locationName": "upfrontPrice" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeHosts": { + "input": { + "type": "structure", + "members": { + "Filter": { + "shape": "Sg4", + "locationName": "filter" + }, + "HostIds": { + "shape": "Sks", + "locationName": "hostId" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Hosts": { + "locationName": "hostSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AutoPlacement": { + "locationName": "autoPlacement" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "AvailableCapacity": { + "locationName": "availableCapacity", + "type": "structure", + "members": { + "AvailableInstanceCapacity": { + "locationName": "availableInstanceCapacity", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AvailableCapacity": { + "locationName": "availableCapacity", + "type": "integer" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "TotalCapacity": { + "locationName": "totalCapacity", + "type": "integer" + } + } + } + }, + "AvailableVCpus": { + "locationName": "availableVCpus", + "type": "integer" + } + } + }, + "ClientToken": { + "locationName": "clientToken" + }, + "HostId": { + "locationName": "hostId" + }, + "HostProperties": { + "locationName": "hostProperties", + "type": "structure", + "members": { + "Cores": { + "locationName": "cores", + "type": "integer" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "Sockets": { + "locationName": "sockets", + "type": "integer" + }, + "TotalVCpus": { + "locationName": "totalVCpus", + "type": "integer" + } + } + }, + "HostReservationId": { + "locationName": "hostReservationId" + }, + "Instances": { + "locationName": "instances", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceType": { + "locationName": "instanceType" + } + } + } + }, + "State": { + "locationName": "state" + }, + "AllocationTime": { + "locationName": "allocationTime", + "type": "timestamp" + }, + "ReleaseTime": { + "locationName": "releaseTime", + "type": "timestamp" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeIamInstanceProfileAssociations": { + "input": { + "type": "structure", + "members": { + "AssociationIds": { + "locationName": "AssociationId", + "type": "list", + "member": { + "locationName": "AssociationId" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IamInstanceProfileAssociations": { + "locationName": "iamInstanceProfileAssociationSet", + "type": "list", + "member": { + "shape": "S1w", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeIdFormat": { + "input": { + "type": "structure", + "members": { + "Resource": {} + } + }, + "output": { + "type": "structure", + "members": { + "Statuses": { + "shape": "Sgd", + "locationName": "statusSet" + } + } + } + }, + "DescribeIdentityIdFormat": { + "input": { + "type": "structure", + "required": [ + "PrincipalArn" + ], + "members": { + "PrincipalArn": { + "locationName": "principalArn" + }, + "Resource": { + "locationName": "resource" + } + } + }, + "output": { + "type": "structure", + "members": { + "Statuses": { + "shape": "Sgd", + "locationName": "statusSet" + } + } + } + }, + "DescribeImageAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "ImageId" + ], + "members": { + "Attribute": {}, + "ImageId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "shape": "Sle", + "locationName": "blockDeviceMapping" + }, + "ImageId": { + "locationName": "imageId" + }, + "LaunchPermissions": { + "shape": "Slf", + "locationName": "launchPermission" + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + }, + "Description": { + "shape": "S61", + "locationName": "description" + }, + "KernelId": { + "shape": "S61", + "locationName": "kernel" + }, + "RamdiskId": { + "shape": "S61", + "locationName": "ramdisk" + }, + "SriovNetSupport": { + "shape": "S61", + "locationName": "sriovNetSupport" + } + } + } + }, + "DescribeImages": { + "input": { + "type": "structure", + "members": { + "ExecutableUsers": { + "locationName": "ExecutableBy", + "type": "list", + "member": { + "locationName": "ExecutableBy" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "ImageIds": { + "locationName": "ImageId", + "type": "list", + "member": { + "locationName": "ImageId" + } + }, + "Owners": { + "shape": "Sk7", + "locationName": "Owner" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Images": { + "locationName": "imagesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Architecture": { + "locationName": "architecture" + }, + "CreationDate": { + "locationName": "creationDate" + }, + "ImageId": { + "locationName": "imageId" + }, + "ImageLocation": { + "locationName": "imageLocation" + }, + "ImageType": { + "locationName": "imageType" + }, + "Public": { + "locationName": "isPublic", + "type": "boolean" + }, + "KernelId": { + "locationName": "kernelId" + }, + "OwnerId": { + "locationName": "imageOwnerId" + }, + "Platform": { + "locationName": "platform" + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + }, + "RamdiskId": { + "locationName": "ramdiskId" + }, + "State": { + "locationName": "imageState" + }, + "BlockDeviceMappings": { + "shape": "Sle", + "locationName": "blockDeviceMapping" + }, + "Description": { + "locationName": "description" + }, + "EnaSupport": { + "locationName": "enaSupport", + "type": "boolean" + }, + "Hypervisor": { + "locationName": "hypervisor" + }, + "ImageOwnerAlias": { + "locationName": "imageOwnerAlias" + }, + "Name": { + "locationName": "name" + }, + "RootDeviceName": { + "locationName": "rootDeviceName" + }, + "RootDeviceType": { + "locationName": "rootDeviceType" + }, + "SriovNetSupport": { + "locationName": "sriovNetSupport" + }, + "StateReason": { + "shape": "Sls", + "locationName": "stateReason" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VirtualizationType": { + "locationName": "virtualizationType" + } + } + } + } + } + } + }, + "DescribeImportImageTasks": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4" + }, + "ImportTaskIds": { + "shape": "Slv", + "locationName": "ImportTaskId" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImportImageTasks": { + "locationName": "importImageTaskSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Architecture": { + "locationName": "architecture" + }, + "Description": { + "locationName": "description" + }, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "Hypervisor": { + "locationName": "hypervisor" + }, + "ImageId": { + "locationName": "imageId" + }, + "ImportTaskId": { + "locationName": "importTaskId" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "LicenseType": { + "locationName": "licenseType" + }, + "Platform": { + "locationName": "platform" + }, + "Progress": { + "locationName": "progress" + }, + "SnapshotDetails": { + "shape": "Slz", + "locationName": "snapshotDetailSet" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeImportSnapshotTasks": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4" + }, + "ImportTaskIds": { + "shape": "Slv", + "locationName": "ImportTaskId" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImportSnapshotTasks": { + "locationName": "importSnapshotTaskSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "ImportTaskId": { + "locationName": "importTaskId" + }, + "SnapshotTaskDetail": { + "shape": "Sm6", + "locationName": "snapshotTaskDetail" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeInstanceAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "InstanceId" + ], + "members": { + "Attribute": { + "locationName": "attribute" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceId": { + "locationName": "instanceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Groups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "BlockDeviceMappings": { + "shape": "Sma", + "locationName": "blockDeviceMapping" + }, + "DisableApiTermination": { + "shape": "Smd", + "locationName": "disableApiTermination" + }, + "EnaSupport": { + "shape": "Smd", + "locationName": "enaSupport" + }, + "EbsOptimized": { + "shape": "Smd", + "locationName": "ebsOptimized" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceInitiatedShutdownBehavior": { + "shape": "S61", + "locationName": "instanceInitiatedShutdownBehavior" + }, + "InstanceType": { + "shape": "S61", + "locationName": "instanceType" + }, + "KernelId": { + "shape": "S61", + "locationName": "kernel" + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + }, + "RamdiskId": { + "shape": "S61", + "locationName": "ramdisk" + }, + "RootDeviceName": { + "shape": "S61", + "locationName": "rootDeviceName" + }, + "SourceDestCheck": { + "shape": "Smd", + "locationName": "sourceDestCheck" + }, + "SriovNetSupport": { + "shape": "S61", + "locationName": "sriovNetSupport" + }, + "UserData": { + "shape": "S61", + "locationName": "userData" + } + } + } + }, + "DescribeInstanceCreditSpecifications": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceCreditSpecifications": { + "locationName": "instanceCreditSpecificationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "CpuCredits": { + "locationName": "cpuCredits" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeInstanceStatus": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "IncludeAllInstances": { + "locationName": "includeAllInstances", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceStatuses": { + "locationName": "instanceStatusSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Events": { + "locationName": "eventsSet", + "type": "list", + "member": { + "shape": "Smo", + "locationName": "item" + } + }, + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceState": { + "shape": "Smr", + "locationName": "instanceState" + }, + "InstanceStatus": { + "shape": "Smt", + "locationName": "instanceStatus" + }, + "SystemStatus": { + "shape": "Smt", + "locationName": "systemStatus" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeInstances": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Reservations": { + "locationName": "reservationSet", + "type": "list", + "member": { + "shape": "Sn2", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeInternetGateways": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InternetGatewayIds": { + "shape": "Sd", + "locationName": "internetGatewayId" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "InternetGateways": { + "locationName": "internetGatewaySet", + "type": "list", + "member": { + "shape": "S7u", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeKeyPairs": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "KeyNames": { + "locationName": "KeyName", + "type": "list", + "member": { + "locationName": "KeyName" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyPairs": { + "locationName": "keySet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "KeyFingerprint": { + "locationName": "keyFingerprint" + }, + "KeyName": { + "locationName": "keyName" + } + } + } + } + } + } + }, + "DescribeLaunchTemplateVersions": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "LaunchTemplateId": {}, + "LaunchTemplateName": {}, + "Versions": { + "shape": "Sek", + "locationName": "LaunchTemplateVersion" + }, + "MinVersion": {}, + "MaxVersion": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + } + } + }, + "output": { + "type": "structure", + "members": { + "LaunchTemplateVersions": { + "locationName": "launchTemplateVersionSet", + "type": "list", + "member": { + "shape": "S92", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeLaunchTemplates": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "LaunchTemplateIds": { + "shape": "Sd", + "locationName": "LaunchTemplateId" + }, + "LaunchTemplateNames": { + "locationName": "LaunchTemplateName", + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "LaunchTemplates": { + "locationName": "launchTemplates", + "type": "list", + "member": { + "shape": "S8z", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeMovingAddresses": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "PublicIps": { + "shape": "Sd", + "locationName": "publicIp" + } + } + }, + "output": { + "type": "structure", + "members": { + "MovingAddressStatuses": { + "locationName": "movingAddressStatusSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "MoveStatus": { + "locationName": "moveStatus" + }, + "PublicIp": { + "locationName": "publicIp" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeNatGateways": { + "input": { + "type": "structure", + "members": { + "Filter": { + "shape": "Sg4" + }, + "MaxResults": { + "type": "integer" + }, + "NatGatewayIds": { + "shape": "Sd", + "locationName": "NatGatewayId" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NatGateways": { + "locationName": "natGatewaySet", + "type": "list", + "member": { + "shape": "S9v", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeNetworkAcls": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkAclIds": { + "shape": "Sd", + "locationName": "NetworkAclId" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkAcls": { + "locationName": "networkAclSet", + "type": "list", + "member": { + "shape": "Sa2", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeNetworkInterfaceAttribute": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "Attribute": { + "locationName": "attribute" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attachment": { + "shape": "Sag", + "locationName": "attachment" + }, + "Description": { + "shape": "S61", + "locationName": "description" + }, + "Groups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "SourceDestCheck": { + "shape": "Smd", + "locationName": "sourceDestCheck" + } + } + } + }, + "DescribeNetworkInterfacePermissions": { + "input": { + "type": "structure", + "members": { + "NetworkInterfacePermissionIds": { + "locationName": "NetworkInterfacePermissionId", + "type": "list", + "member": {} + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkInterfacePermissions": { + "locationName": "networkInterfacePermissions", + "type": "list", + "member": { + "shape": "Sas", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeNetworkInterfaces": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkInterfaceIds": { + "locationName": "NetworkInterfaceId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkInterfaces": { + "locationName": "networkInterfaceSet", + "type": "list", + "member": { + "shape": "Sae", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribePlacementGroups": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "GroupNames": { + "locationName": "groupName", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "PlacementGroups": { + "locationName": "placementGroupSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "GroupName": { + "locationName": "groupName" + }, + "State": { + "locationName": "state" + }, + "Strategy": { + "locationName": "strategy" + }, + "PartitionCount": { + "locationName": "partitionCount", + "type": "integer" + } + } + } + } + } + } + }, + "DescribePrefixLists": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "PrefixListIds": { + "shape": "Sd", + "locationName": "PrefixListId" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "PrefixLists": { + "locationName": "prefixListSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Cidrs": { + "shape": "Sd", + "locationName": "cidrSet" + }, + "PrefixListId": { + "locationName": "prefixListId" + }, + "PrefixListName": { + "locationName": "prefixListName" + } + } + } + } + } + } + }, + "DescribePrincipalIdFormat": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Resources": { + "locationName": "Resource", + "type": "list", + "member": { + "locationName": "item" + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Principals": { + "locationName": "principalSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Statuses": { + "shape": "Sgd", + "locationName": "statusSet" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribePublicIpv4Pools": { + "input": { + "type": "structure", + "members": { + "PoolIds": { + "shape": "Sd", + "locationName": "PoolId" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicIpv4Pools": { + "locationName": "publicIpv4PoolSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "PoolId": { + "locationName": "poolId" + }, + "Description": { + "locationName": "description" + }, + "PoolAddressRanges": { + "locationName": "poolAddressRangeSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "FirstAddress": { + "locationName": "firstAddress" + }, + "LastAddress": { + "locationName": "lastAddress" + }, + "AddressCount": { + "locationName": "addressCount", + "type": "integer" + }, + "AvailableAddressCount": { + "locationName": "availableAddressCount", + "type": "integer" + } + } + } + }, + "TotalAddressCount": { + "locationName": "totalAddressCount", + "type": "integer" + }, + "TotalAvailableAddressCount": { + "locationName": "totalAvailableAddressCount", + "type": "integer" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeRegions": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "RegionNames": { + "locationName": "RegionName", + "type": "list", + "member": { + "locationName": "RegionName" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Regions": { + "locationName": "regionInfo", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Endpoint": { + "locationName": "regionEndpoint" + }, + "RegionName": { + "locationName": "regionName" + } + } + } + } + } + } + }, + "DescribeReservedInstances": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "OfferingClass": {}, + "ReservedInstancesIds": { + "shape": "Spj", + "locationName": "ReservedInstancesId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "OfferingType": { + "locationName": "offeringType" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstances": { + "locationName": "reservedInstancesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Duration": { + "locationName": "duration", + "type": "long" + }, + "End": { + "locationName": "end", + "type": "timestamp" + }, + "FixedPrice": { + "locationName": "fixedPrice", + "type": "float" + }, + "InstanceCount": { + "locationName": "instanceCount", + "type": "integer" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "ProductDescription": { + "locationName": "productDescription" + }, + "ReservedInstancesId": { + "locationName": "reservedInstancesId" + }, + "Start": { + "locationName": "start", + "type": "timestamp" + }, + "State": { + "locationName": "state" + }, + "UsagePrice": { + "locationName": "usagePrice", + "type": "float" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "InstanceTenancy": { + "locationName": "instanceTenancy" + }, + "OfferingClass": { + "locationName": "offeringClass" + }, + "OfferingType": { + "locationName": "offeringType" + }, + "RecurringCharges": { + "shape": "Spr", + "locationName": "recurringCharges" + }, + "Scope": { + "locationName": "scope" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + } + } + } + } + }, + "DescribeReservedInstancesListings": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "ReservedInstancesId": { + "locationName": "reservedInstancesId" + }, + "ReservedInstancesListingId": { + "locationName": "reservedInstancesListingId" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape": "S3s", + "locationName": "reservedInstancesListingsSet" + } + } + } + }, + "DescribeReservedInstancesModifications": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "ReservedInstancesModificationIds": { + "locationName": "ReservedInstancesModificationId", + "type": "list", + "member": { + "locationName": "ReservedInstancesModificationId" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "ReservedInstancesModifications": { + "locationName": "reservedInstancesModificationsSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClientToken": { + "locationName": "clientToken" + }, + "CreateDate": { + "locationName": "createDate", + "type": "timestamp" + }, + "EffectiveDate": { + "locationName": "effectiveDate", + "type": "timestamp" + }, + "ModificationResults": { + "locationName": "modificationResultSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ReservedInstancesId": { + "locationName": "reservedInstancesId" + }, + "TargetConfiguration": { + "shape": "Sq4", + "locationName": "targetConfiguration" + } + } + } + }, + "ReservedInstancesIds": { + "locationName": "reservedInstancesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ReservedInstancesId": { + "locationName": "reservedInstancesId" + } + } + } + }, + "ReservedInstancesModificationId": { + "locationName": "reservedInstancesModificationId" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "UpdateDate": { + "locationName": "updateDate", + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeReservedInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "AvailabilityZone": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "IncludeMarketplace": { + "type": "boolean" + }, + "InstanceType": {}, + "MaxDuration": { + "type": "long" + }, + "MaxInstanceCount": { + "type": "integer" + }, + "MinDuration": { + "type": "long" + }, + "OfferingClass": {}, + "ProductDescription": {}, + "ReservedInstancesOfferingIds": { + "locationName": "ReservedInstancesOfferingId", + "type": "list", + "member": {} + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceTenancy": { + "locationName": "instanceTenancy" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "OfferingType": { + "locationName": "offeringType" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesOfferings": { + "locationName": "reservedInstancesOfferingsSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Duration": { + "locationName": "duration", + "type": "long" + }, + "FixedPrice": { + "locationName": "fixedPrice", + "type": "float" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "ProductDescription": { + "locationName": "productDescription" + }, + "ReservedInstancesOfferingId": { + "locationName": "reservedInstancesOfferingId" + }, + "UsagePrice": { + "locationName": "usagePrice", + "type": "float" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "InstanceTenancy": { + "locationName": "instanceTenancy" + }, + "Marketplace": { + "locationName": "marketplace", + "type": "boolean" + }, + "OfferingClass": { + "locationName": "offeringClass" + }, + "OfferingType": { + "locationName": "offeringType" + }, + "PricingDetails": { + "locationName": "pricingDetailsSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Count": { + "locationName": "count", + "type": "integer" + }, + "Price": { + "locationName": "price", + "type": "double" + } + } + } + }, + "RecurringCharges": { + "shape": "Spr", + "locationName": "recurringCharges" + }, + "Scope": { + "locationName": "scope" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeRouteTables": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "RouteTableIds": { + "shape": "Sd", + "locationName": "RouteTableId" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "RouteTables": { + "locationName": "routeTableSet", + "type": "list", + "member": { + "shape": "Sb5", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeScheduledInstanceAvailability": { + "input": { + "type": "structure", + "required": [ + "FirstSlotStartTimeRange", + "Recurrence" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "FirstSlotStartTimeRange": { + "type": "structure", + "required": [ + "EarliestTime", + "LatestTime" + ], + "members": { + "EarliestTime": { + "type": "timestamp" + }, + "LatestTime": { + "type": "timestamp" + } + } + }, + "MaxResults": { + "type": "integer" + }, + "MaxSlotDurationInHours": { + "type": "integer" + }, + "MinSlotDurationInHours": { + "type": "integer" + }, + "NextToken": {}, + "Recurrence": { + "type": "structure", + "members": { + "Frequency": {}, + "Interval": { + "type": "integer" + }, + "OccurrenceDays": { + "locationName": "OccurrenceDay", + "type": "list", + "member": { + "locationName": "OccurenceDay", + "type": "integer" + } + }, + "OccurrenceRelativeToEnd": { + "type": "boolean" + }, + "OccurrenceUnit": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "ScheduledInstanceAvailabilitySet": { + "locationName": "scheduledInstanceAvailabilitySet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "AvailableInstanceCount": { + "locationName": "availableInstanceCount", + "type": "integer" + }, + "FirstSlotStartTime": { + "locationName": "firstSlotStartTime", + "type": "timestamp" + }, + "HourlyPrice": { + "locationName": "hourlyPrice" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "MaxTermDurationInDays": { + "locationName": "maxTermDurationInDays", + "type": "integer" + }, + "MinTermDurationInDays": { + "locationName": "minTermDurationInDays", + "type": "integer" + }, + "NetworkPlatform": { + "locationName": "networkPlatform" + }, + "Platform": { + "locationName": "platform" + }, + "PurchaseToken": { + "locationName": "purchaseToken" + }, + "Recurrence": { + "shape": "Sqo", + "locationName": "recurrence" + }, + "SlotDurationInHours": { + "locationName": "slotDurationInHours", + "type": "integer" + }, + "TotalScheduledInstanceHours": { + "locationName": "totalScheduledInstanceHours", + "type": "integer" + } + } + } + } + } + } + }, + "DescribeScheduledInstances": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "ScheduledInstanceIds": { + "locationName": "ScheduledInstanceId", + "type": "list", + "member": { + "locationName": "ScheduledInstanceId" + } + }, + "SlotStartTimeRange": { + "type": "structure", + "members": { + "EarliestTime": { + "type": "timestamp" + }, + "LatestTime": { + "type": "timestamp" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "ScheduledInstanceSet": { + "locationName": "scheduledInstanceSet", + "type": "list", + "member": { + "shape": "Sqv", + "locationName": "item" + } + } + } + } + }, + "DescribeSecurityGroupReferences": { + "input": { + "type": "structure", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupId": { + "type": "list", + "member": { + "locationName": "item" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SecurityGroupReferenceSet": { + "locationName": "securityGroupReferenceSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "GroupId": { + "locationName": "groupId" + }, + "ReferencingVpcId": { + "locationName": "referencingVpcId" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + } + } + } + } + }, + "DescribeSecurityGroups": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "GroupIds": { + "shape": "S2i", + "locationName": "GroupId" + }, + "GroupNames": { + "shape": "Sr2", + "locationName": "GroupName" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SecurityGroups": { + "locationName": "securityGroupInfo", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Description": { + "locationName": "groupDescription" + }, + "GroupName": { + "locationName": "groupName" + }, + "IpPermissions": { + "shape": "S2z", + "locationName": "ipPermissions" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "GroupId": { + "locationName": "groupId" + }, + "IpPermissionsEgress": { + "shape": "S2z", + "locationName": "ipPermissionsEgress" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "SnapshotId" + ], + "members": { + "Attribute": {}, + "SnapshotId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CreateVolumePermissions": { + "shape": "Sr9", + "locationName": "createVolumePermission" + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + }, + "SnapshotId": { + "locationName": "snapshotId" + } + } + } + }, + "DescribeSnapshots": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "OwnerIds": { + "shape": "Sk7", + "locationName": "Owner" + }, + "RestorableByUserIds": { + "locationName": "RestorableBy", + "type": "list", + "member": {} + }, + "SnapshotIds": { + "locationName": "SnapshotId", + "type": "list", + "member": { + "locationName": "SnapshotId" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Snapshots": { + "locationName": "snapshotSet", + "type": "list", + "member": { + "shape": "Sbh", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeSpotDatafeedSubscription": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "shape": "Sbl", + "locationName": "spotDatafeedSubscription" + } + } + } + }, + "DescribeSpotFleetInstances": { + "input": { + "type": "structure", + "required": [ + "SpotFleetRequestId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + } + } + }, + "output": { + "type": "structure", + "members": { + "ActiveInstances": { + "shape": "Sj9", + "locationName": "activeInstanceSet" + }, + "NextToken": { + "locationName": "nextToken" + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + } + } + } + }, + "DescribeSpotFleetRequestHistory": { + "input": { + "type": "structure", + "required": [ + "SpotFleetRequestId", + "StartTime" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EventType": { + "locationName": "eventType" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "HistoryRecords": { + "locationName": "historyRecordSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "EventInformation": { + "shape": "Sj6", + "locationName": "eventInformation" + }, + "EventType": { + "locationName": "eventType" + }, + "Timestamp": { + "locationName": "timestamp", + "type": "timestamp" + } + } + } + }, + "LastEvaluatedTime": { + "locationName": "lastEvaluatedTime", + "type": "timestamp" + }, + "NextToken": { + "locationName": "nextToken" + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + } + } + } + }, + "DescribeSpotFleetRequests": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "SpotFleetRequestIds": { + "shape": "Sd", + "locationName": "spotFleetRequestId" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "SpotFleetRequestConfigs": { + "locationName": "spotFleetRequestConfigSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ActivityStatus": { + "locationName": "activityStatus" + }, + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "SpotFleetRequestConfig": { + "shape": "Sru", + "locationName": "spotFleetRequestConfig" + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + }, + "SpotFleetRequestState": { + "locationName": "spotFleetRequestState" + } + } + } + } + } + } + }, + "DescribeSpotInstanceRequests": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "SpotInstanceRequestIds": { + "shape": "S4d", + "locationName": "SpotInstanceRequestId" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "shape": "Ssj", + "locationName": "spotInstanceRequestSet" + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeSpotPriceHistory": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EndTime": { + "locationName": "endTime", + "type": "timestamp" + }, + "InstanceTypes": { + "locationName": "InstanceType", + "type": "list", + "member": {} + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "ProductDescriptions": { + "locationName": "ProductDescription", + "type": "list", + "member": {} + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "SpotPriceHistory": { + "locationName": "spotPriceHistorySet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "ProductDescription": { + "locationName": "productDescription" + }, + "SpotPrice": { + "locationName": "spotPrice" + }, + "Timestamp": { + "locationName": "timestamp", + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeStaleSecurityGroups": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "VpcId": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "StaleSecurityGroupSet": { + "locationName": "staleSecurityGroupSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "GroupId": { + "locationName": "groupId" + }, + "GroupName": { + "locationName": "groupName" + }, + "StaleIpPermissions": { + "shape": "Ssz", + "locationName": "staleIpPermissions" + }, + "StaleIpPermissionsEgress": { + "shape": "Ssz", + "locationName": "staleIpPermissionsEgress" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + } + } + } + }, + "DescribeSubnets": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "SubnetIds": { + "locationName": "SubnetId", + "type": "list", + "member": { + "locationName": "SubnetId" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Subnets": { + "locationName": "subnetSet", + "type": "list", + "member": { + "shape": "S5j", + "locationName": "item" + } + } + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Tags": { + "locationName": "tagSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Key": { + "locationName": "key" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "Value": { + "locationName": "value" + } + } + } + } + } + } + }, + "DescribeTransitGatewayAttachments": { + "input": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "shape": "Std" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayAttachments": { + "locationName": "transitGatewayAttachments", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "TransitGatewayOwnerId": { + "locationName": "transitGatewayOwnerId" + }, + "ResourceOwnerId": { + "locationName": "resourceOwnerId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "State": { + "locationName": "state" + }, + "Association": { + "locationName": "association", + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "locationName": "transitGatewayRouteTableId" + }, + "State": { + "locationName": "state" + } + } + }, + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeTransitGatewayRouteTables": { + "input": { + "type": "structure", + "members": { + "TransitGatewayRouteTableIds": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayRouteTables": { + "locationName": "transitGatewayRouteTables", + "type": "list", + "member": { + "shape": "Scb", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeTransitGatewayVpcAttachments": { + "input": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "shape": "Std" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachments": { + "locationName": "transitGatewayVpcAttachments", + "type": "list", + "member": { + "shape": "Sb", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeTransitGateways": { + "input": { + "type": "structure", + "members": { + "TransitGatewayIds": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGateways": { + "locationName": "transitGatewaySet", + "type": "list", + "member": { + "shape": "Sbz", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVolumeAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "VolumeId" + ], + "members": { + "Attribute": {}, + "VolumeId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "AutoEnableIO": { + "shape": "Smd", + "locationName": "autoEnableIO" + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + }, + "VolumeId": { + "locationName": "volumeId" + } + } + } + }, + "DescribeVolumeStatus": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "VolumeIds": { + "shape": "Sty", + "locationName": "VolumeId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "VolumeStatuses": { + "locationName": "volumeStatusSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Actions": { + "locationName": "actionsSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Description": { + "locationName": "description" + }, + "EventId": { + "locationName": "eventId" + }, + "EventType": { + "locationName": "eventType" + } + } + } + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Events": { + "locationName": "eventsSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "EventId": { + "locationName": "eventId" + }, + "EventType": { + "locationName": "eventType" + }, + "NotAfter": { + "locationName": "notAfter", + "type": "timestamp" + }, + "NotBefore": { + "locationName": "notBefore", + "type": "timestamp" + } + } + } + }, + "VolumeId": { + "locationName": "volumeId" + }, + "VolumeStatus": { + "locationName": "volumeStatus", + "type": "structure", + "members": { + "Details": { + "locationName": "details", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Name": { + "locationName": "name" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "Status": { + "locationName": "status" + } + } + } + } + } + } + } + } + }, + "DescribeVolumes": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "VolumeIds": { + "shape": "Sty", + "locationName": "VolumeId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Volumes": { + "locationName": "volumeSet", + "type": "list", + "member": { + "shape": "Sch", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVolumesModifications": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeIds": { + "shape": "Sty", + "locationName": "VolumeId" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "VolumesModifications": { + "locationName": "volumeModificationSet", + "type": "list", + "member": { + "shape": "Suh", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "VpcId" + ], + "members": { + "Attribute": {}, + "VpcId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcId": { + "locationName": "vpcId" + }, + "EnableDnsHostnames": { + "shape": "Smd", + "locationName": "enableDnsHostnames" + }, + "EnableDnsSupport": { + "shape": "Smd", + "locationName": "enableDnsSupport" + } + } + } + }, + "DescribeVpcClassicLink": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcIds": { + "shape": "Sun", + "locationName": "VpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Vpcs": { + "locationName": "vpcSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClassicLinkEnabled": { + "locationName": "classicLinkEnabled", + "type": "boolean" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + } + } + } + }, + "DescribeVpcClassicLinkDnsSupport": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "VpcIds": { + "shape": "Sun" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Vpcs": { + "locationName": "vpcs", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClassicLinkDnsSupported": { + "locationName": "classicLinkDnsSupported", + "type": "boolean" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + } + } + } + }, + "DescribeVpcEndpointConnectionNotifications": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ConnectionNotificationId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConnectionNotificationSet": { + "locationName": "connectionNotificationSet", + "type": "list", + "member": { + "shape": "Scy", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcEndpointConnections": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "VpcEndpointConnections": { + "locationName": "vpcEndpointConnectionSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ServiceId": { + "locationName": "serviceId" + }, + "VpcEndpointId": { + "locationName": "vpcEndpointId" + }, + "VpcEndpointOwner": { + "locationName": "vpcEndpointOwner" + }, + "VpcEndpointState": { + "locationName": "vpcEndpointState" + }, + "CreationTimestamp": { + "locationName": "creationTimestamp", + "type": "timestamp" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcEndpointServiceConfigurations": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceIds": { + "shape": "Sd", + "locationName": "ServiceId" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceConfigurations": { + "locationName": "serviceConfigurationSet", + "type": "list", + "member": { + "shape": "Sd3", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcEndpointServicePermissions": { + "input": { + "type": "structure", + "required": [ + "ServiceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AllowedPrincipals": { + "locationName": "allowedPrincipals", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "PrincipalType": { + "locationName": "principalType" + }, + "Principal": { + "locationName": "principal" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcEndpointServices": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceNames": { + "shape": "Sd", + "locationName": "ServiceName" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceNames": { + "shape": "Sd", + "locationName": "serviceNameSet" + }, + "ServiceDetails": { + "locationName": "serviceDetailSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ServiceName": { + "locationName": "serviceName" + }, + "ServiceType": { + "shape": "Sd4", + "locationName": "serviceType" + }, + "AvailabilityZones": { + "shape": "Sd", + "locationName": "availabilityZoneSet" + }, + "Owner": { + "locationName": "owner" + }, + "BaseEndpointDnsNames": { + "shape": "Sd", + "locationName": "baseEndpointDnsNameSet" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "VpcEndpointPolicySupported": { + "locationName": "vpcEndpointPolicySupported", + "type": "boolean" + }, + "AcceptanceRequired": { + "locationName": "acceptanceRequired", + "type": "boolean" + }, + "ManagesVpcEndpoints": { + "locationName": "managesVpcEndpoints", + "type": "boolean" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcEndpoints": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcEndpointIds": { + "shape": "Sd", + "locationName": "VpcEndpointId" + }, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "VpcEndpoints": { + "locationName": "vpcEndpointSet", + "type": "list", + "member": { + "shape": "Scp", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcPeeringConnections": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcPeeringConnectionIds": { + "shape": "Sd", + "locationName": "VpcPeeringConnectionId" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringConnections": { + "locationName": "vpcPeeringConnectionSet", + "type": "list", + "member": { + "shape": "Sr", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpcs": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "VpcIds": { + "locationName": "VpcId", + "type": "list", + "member": { + "locationName": "VpcId" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Vpcs": { + "locationName": "vpcSet", + "type": "list", + "member": { + "shape": "S5o", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeVpnConnections": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "VpnConnectionIds": { + "locationName": "VpnConnectionId", + "type": "list", + "member": { + "locationName": "VpnConnectionId" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnConnections": { + "locationName": "vpnConnectionSet", + "type": "list", + "member": { + "shape": "Sdf", + "locationName": "item" + } + } + } + } + }, + "DescribeVpnGateways": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "VpnGatewayIds": { + "locationName": "VpnGatewayId", + "type": "list", + "member": { + "locationName": "VpnGatewayId" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnGateways": { + "locationName": "vpnGatewaySet", + "type": "list", + "member": { + "shape": "Sdr", + "locationName": "item" + } + } + } + } + }, + "DetachClassicLinkVpc": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "DetachInternetGateway": { + "input": { + "type": "structure", + "required": [ + "InternetGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InternetGatewayId": { + "locationName": "internetGatewayId" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "DetachNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "AttachmentId" + ], + "members": { + "AttachmentId": { + "locationName": "attachmentId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Force": { + "locationName": "force", + "type": "boolean" + } + } + } + }, + "DetachVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "Device": {}, + "Force": { + "type": "boolean" + }, + "InstanceId": {}, + "VolumeId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "shape": "S2o" + } + }, + "DetachVpnGateway": { + "input": { + "type": "structure", + "required": [ + "VpcId", + "VpnGatewayId" + ], + "members": { + "VpcId": {}, + "VpnGatewayId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DisableTransitGatewayRouteTablePropagation": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Propagation": { + "shape": "Sw6", + "locationName": "propagation" + } + } + } + }, + "DisableVgwRoutePropagation": { + "input": { + "type": "structure", + "required": [ + "GatewayId", + "RouteTableId" + ], + "members": { + "GatewayId": {}, + "RouteTableId": {} + } + } + }, + "DisableVpcClassicLink": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "DisableVpcClassicLinkDnsSupport": { + "input": { + "type": "structure", + "members": { + "VpcId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "DisassociateAddress": { + "input": { + "type": "structure", + "members": { + "AssociationId": {}, + "PublicIp": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DisassociateClientVpnTargetNetwork": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "AssociationId" + ], + "members": { + "ClientVpnEndpointId": {}, + "AssociationId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "Status": { + "shape": "S1q", + "locationName": "status" + } + } + } + }, + "DisassociateIamInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "AssociationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "shape": "S1w", + "locationName": "iamInstanceProfileAssociation" + } + } + } + }, + "DisassociateRouteTable": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "DisassociateSubnetCidrBlock": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "AssociationId": { + "locationName": "associationId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "shape": "S23", + "locationName": "ipv6CidrBlockAssociation" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + } + }, + "DisassociateTransitGatewayRouteTable": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Association": { + "shape": "S28", + "locationName": "association" + } + } + } + }, + "DisassociateVpcCidrBlock": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "AssociationId": { + "locationName": "associationId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "shape": "S2d", + "locationName": "ipv6CidrBlockAssociation" + }, + "CidrBlockAssociation": { + "shape": "S2g", + "locationName": "cidrBlockAssociation" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "EnableTransitGatewayRouteTablePropagation": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Propagation": { + "shape": "Sw6", + "locationName": "propagation" + } + } + } + }, + "EnableVgwRoutePropagation": { + "input": { + "type": "structure", + "required": [ + "GatewayId", + "RouteTableId" + ], + "members": { + "GatewayId": {}, + "RouteTableId": {} + } + } + }, + "EnableVolumeIO": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VolumeId": { + "locationName": "volumeId" + } + } + } + }, + "EnableVpcClassicLink": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "EnableVpcClassicLinkDnsSupport": { + "input": { + "type": "structure", + "members": { + "VpcId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ExportClientVpnClientCertificateRevocationList": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CertificateRevocationList": { + "locationName": "certificateRevocationList" + }, + "Status": { + "locationName": "status", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + } + } + } + }, + "ExportClientVpnClientConfiguration": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClientConfiguration": { + "locationName": "clientConfiguration" + } + } + } + }, + "ExportTransitGatewayRoutes": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "S3Bucket" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "S3Bucket": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "S3Location": { + "locationName": "s3Location" + } + } + } + }, + "GetConsoleOutput": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Latest": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "Output": { + "locationName": "output" + }, + "Timestamp": { + "locationName": "timestamp", + "type": "timestamp" + } + } + } + }, + "GetConsoleScreenshot": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": {}, + "WakeUp": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageData": { + "locationName": "imageData" + }, + "InstanceId": { + "locationName": "instanceId" + } + } + } + }, + "GetHostReservationPurchasePreview": { + "input": { + "type": "structure", + "required": [ + "HostIdSet", + "OfferingId" + ], + "members": { + "HostIdSet": { + "shape": "Sxa" + }, + "OfferingId": {} + } + }, + "output": { + "type": "structure", + "members": { + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Purchase": { + "shape": "Sxc", + "locationName": "purchase" + }, + "TotalHourlyPrice": { + "locationName": "totalHourlyPrice" + }, + "TotalUpfrontPrice": { + "locationName": "totalUpfrontPrice" + } + } + } + }, + "GetLaunchTemplateData": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "LaunchTemplateData": { + "shape": "S93", + "locationName": "launchTemplateData" + } + } + } + }, + "GetPasswordData": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "PasswordData": { + "locationName": "passwordData" + }, + "Timestamp": { + "locationName": "timestamp", + "type": "timestamp" + } + } + } + }, + "GetReservedInstancesExchangeQuote": { + "input": { + "type": "structure", + "required": [ + "ReservedInstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ReservedInstanceIds": { + "shape": "S3", + "locationName": "ReservedInstanceId" + }, + "TargetConfigurations": { + "shape": "S5", + "locationName": "TargetConfiguration" + } + } + }, + "output": { + "type": "structure", + "members": { + "CurrencyCode": { + "locationName": "currencyCode" + }, + "IsValidExchange": { + "locationName": "isValidExchange", + "type": "boolean" + }, + "OutputReservedInstancesWillExpireAt": { + "locationName": "outputReservedInstancesWillExpireAt", + "type": "timestamp" + }, + "PaymentDue": { + "locationName": "paymentDue" + }, + "ReservedInstanceValueRollup": { + "shape": "Sxk", + "locationName": "reservedInstanceValueRollup" + }, + "ReservedInstanceValueSet": { + "locationName": "reservedInstanceValueSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ReservationValue": { + "shape": "Sxk", + "locationName": "reservationValue" + }, + "ReservedInstanceId": { + "locationName": "reservedInstanceId" + } + } + } + }, + "TargetConfigurationValueRollup": { + "shape": "Sxk", + "locationName": "targetConfigurationValueRollup" + }, + "TargetConfigurationValueSet": { + "locationName": "targetConfigurationValueSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ReservationValue": { + "shape": "Sxk", + "locationName": "reservationValue" + }, + "TargetConfiguration": { + "locationName": "targetConfiguration", + "type": "structure", + "members": { + "InstanceCount": { + "locationName": "instanceCount", + "type": "integer" + }, + "OfferingId": { + "locationName": "offeringId" + } + } + } + } + } + }, + "ValidationFailureReason": { + "locationName": "validationFailureReason" + } + } + } + }, + "GetTransitGatewayAttachmentPropagations": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayAttachmentPropagations": { + "locationName": "transitGatewayAttachmentPropagations", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "locationName": "transitGatewayRouteTableId" + }, + "State": { + "locationName": "state" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetTransitGatewayRouteTableAssociations": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Associations": { + "locationName": "associations", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "State": { + "locationName": "state" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "GetTransitGatewayRouteTablePropagations": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayRouteTablePropagations": { + "locationName": "transitGatewayRouteTablePropagations", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "State": { + "locationName": "state" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ImportClientVpnClientCertificateRevocationList": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "CertificateRevocationList" + ], + "members": { + "ClientVpnEndpointId": {}, + "CertificateRevocationList": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ImportImage": { + "input": { + "type": "structure", + "members": { + "Architecture": {}, + "ClientData": { + "shape": "Sy5" + }, + "ClientToken": {}, + "Description": {}, + "DiskContainers": { + "locationName": "DiskContainer", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Description": {}, + "DeviceName": {}, + "Format": {}, + "SnapshotId": {}, + "Url": {}, + "UserBucket": { + "shape": "Sy8" + } + } + } + }, + "DryRun": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "Hypervisor": {}, + "KmsKeyId": {}, + "LicenseType": {}, + "Platform": {}, + "RoleName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Architecture": { + "locationName": "architecture" + }, + "Description": { + "locationName": "description" + }, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "Hypervisor": { + "locationName": "hypervisor" + }, + "ImageId": { + "locationName": "imageId" + }, + "ImportTaskId": { + "locationName": "importTaskId" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "LicenseType": { + "locationName": "licenseType" + }, + "Platform": { + "locationName": "platform" + }, + "Progress": { + "locationName": "progress" + }, + "SnapshotDetails": { + "shape": "Slz", + "locationName": "snapshotDetailSet" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + } + }, + "ImportInstance": { + "input": { + "type": "structure", + "required": [ + "Platform" + ], + "members": { + "Description": { + "locationName": "description" + }, + "DiskImages": { + "locationName": "diskImage", + "type": "list", + "member": { + "type": "structure", + "members": { + "Description": {}, + "Image": { + "shape": "Syd" + }, + "Volume": { + "shape": "Sye" + } + } + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "LaunchSpecification": { + "locationName": "launchSpecification", + "type": "structure", + "members": { + "AdditionalInfo": { + "locationName": "additionalInfo" + }, + "Architecture": { + "locationName": "architecture" + }, + "GroupIds": { + "shape": "S86", + "locationName": "GroupId" + }, + "GroupNames": { + "shape": "S8k", + "locationName": "GroupName" + }, + "InstanceInitiatedShutdownBehavior": { + "locationName": "instanceInitiatedShutdownBehavior" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "Monitoring": { + "locationName": "monitoring", + "type": "boolean" + }, + "Placement": { + "shape": "S6m", + "locationName": "placement" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "UserData": { + "locationName": "userData", + "type": "structure", + "members": { + "Data": { + "locationName": "data" + } + } + } + } + }, + "Platform": { + "locationName": "platform" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConversionTask": { + "shape": "Si5", + "locationName": "conversionTask" + } + } + } + }, + "ImportKeyPair": { + "input": { + "type": "structure", + "required": [ + "KeyName", + "PublicKeyMaterial" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "KeyName": { + "locationName": "keyName" + }, + "PublicKeyMaterial": { + "locationName": "publicKeyMaterial", + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyFingerprint": { + "locationName": "keyFingerprint" + }, + "KeyName": { + "locationName": "keyName" + } + } + } + }, + "ImportSnapshot": { + "input": { + "type": "structure", + "members": { + "ClientData": { + "shape": "Sy5" + }, + "ClientToken": {}, + "Description": {}, + "DiskContainer": { + "type": "structure", + "members": { + "Description": {}, + "Format": {}, + "Url": {}, + "UserBucket": { + "shape": "Sy8" + } + } + }, + "DryRun": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "RoleName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "ImportTaskId": { + "locationName": "importTaskId" + }, + "SnapshotTaskDetail": { + "shape": "Sm6", + "locationName": "snapshotTaskDetail" + } + } + } + }, + "ImportVolume": { + "input": { + "type": "structure", + "required": [ + "AvailabilityZone", + "Image", + "Volume" + ], + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Description": { + "locationName": "description" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Image": { + "shape": "Syd", + "locationName": "image" + }, + "Volume": { + "shape": "Sye", + "locationName": "volume" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConversionTask": { + "shape": "Si5", + "locationName": "conversionTask" + } + } + } + }, + "ModifyCapacityReservation": { + "input": { + "type": "structure", + "required": [ + "CapacityReservationId" + ], + "members": { + "CapacityReservationId": {}, + "InstanceCount": { + "type": "integer" + }, + "EndDate": { + "type": "timestamp" + }, + "EndDateType": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyClientVpnEndpoint": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "ServerCertificateArn": {}, + "ConnectionLogOptions": { + "shape": "S54" + }, + "DnsServers": { + "type": "structure", + "members": { + "CustomDnsServers": { + "shape": "Sd" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "Description": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyFleet": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "TargetCapacitySpecification" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ExcessCapacityTerminationPolicy": {}, + "FleetId": {}, + "TargetCapacitySpecification": { + "shape": "S6n" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyFpgaImageAttribute": { + "input": { + "type": "structure", + "required": [ + "FpgaImageId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "FpgaImageId": {}, + "Attribute": {}, + "OperationType": {}, + "UserIds": { + "shape": "Syy", + "locationName": "UserId" + }, + "UserGroups": { + "shape": "Syz", + "locationName": "UserGroup" + }, + "ProductCodes": { + "shape": "Sz0", + "locationName": "ProductCode" + }, + "LoadPermission": { + "type": "structure", + "members": { + "Add": { + "shape": "Sz2" + }, + "Remove": { + "shape": "Sz2" + } + } + }, + "Description": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "FpgaImageAttribute": { + "shape": "Sjy", + "locationName": "fpgaImageAttribute" + } + } + } + }, + "ModifyHosts": { + "input": { + "type": "structure", + "required": [ + "AutoPlacement", + "HostIds" + ], + "members": { + "AutoPlacement": { + "locationName": "autoPlacement" + }, + "HostIds": { + "shape": "Sks", + "locationName": "hostId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Successful": { + "shape": "S1d", + "locationName": "successful" + }, + "Unsuccessful": { + "shape": "Sz7", + "locationName": "unsuccessful" + } + } + } + }, + "ModifyIdFormat": { + "input": { + "type": "structure", + "required": [ + "Resource", + "UseLongIds" + ], + "members": { + "Resource": {}, + "UseLongIds": { + "type": "boolean" + } + } + } + }, + "ModifyIdentityIdFormat": { + "input": { + "type": "structure", + "required": [ + "PrincipalArn", + "Resource", + "UseLongIds" + ], + "members": { + "PrincipalArn": { + "locationName": "principalArn" + }, + "Resource": { + "locationName": "resource" + }, + "UseLongIds": { + "locationName": "useLongIds", + "type": "boolean" + } + } + } + }, + "ModifyImageAttribute": { + "input": { + "type": "structure", + "required": [ + "ImageId" + ], + "members": { + "Attribute": {}, + "Description": { + "shape": "S61" + }, + "ImageId": {}, + "LaunchPermission": { + "type": "structure", + "members": { + "Add": { + "shape": "Slf" + }, + "Remove": { + "shape": "Slf" + } + } + }, + "OperationType": {}, + "ProductCodes": { + "shape": "Sz0", + "locationName": "ProductCode" + }, + "UserGroups": { + "shape": "Syz", + "locationName": "UserGroup" + }, + "UserIds": { + "shape": "Syy", + "locationName": "UserId" + }, + "Value": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "ModifyInstanceAttribute": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "SourceDestCheck": { + "shape": "Smd" + }, + "Attribute": { + "locationName": "attribute" + }, + "BlockDeviceMappings": { + "locationName": "blockDeviceMapping", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "DeviceName": { + "locationName": "deviceName" + }, + "Ebs": { + "locationName": "ebs", + "type": "structure", + "members": { + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "VolumeId": { + "locationName": "volumeId" + } + } + }, + "NoDevice": { + "locationName": "noDevice" + }, + "VirtualName": { + "locationName": "virtualName" + } + } + } + }, + "DisableApiTermination": { + "shape": "Smd", + "locationName": "disableApiTermination" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EbsOptimized": { + "shape": "Smd", + "locationName": "ebsOptimized" + }, + "EnaSupport": { + "shape": "Smd", + "locationName": "enaSupport" + }, + "Groups": { + "shape": "S2i", + "locationName": "GroupId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceInitiatedShutdownBehavior": { + "shape": "S61", + "locationName": "instanceInitiatedShutdownBehavior" + }, + "InstanceType": { + "shape": "S61", + "locationName": "instanceType" + }, + "Kernel": { + "shape": "S61", + "locationName": "kernel" + }, + "Ramdisk": { + "shape": "S61", + "locationName": "ramdisk" + }, + "SriovNetSupport": { + "shape": "S61", + "locationName": "sriovNetSupport" + }, + "UserData": { + "locationName": "userData", + "type": "structure", + "members": { + "Value": { + "locationName": "value", + "type": "blob" + } + } + }, + "Value": { + "locationName": "value" + } + } + } + }, + "ModifyInstanceCapacityReservationAttributes": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "CapacityReservationSpecification" + ], + "members": { + "InstanceId": {}, + "CapacityReservationSpecification": { + "shape": "Szi" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyInstanceCreditSpecification": { + "input": { + "type": "structure", + "required": [ + "InstanceCreditSpecifications" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ClientToken": {}, + "InstanceCreditSpecifications": { + "locationName": "InstanceCreditSpecification", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": {}, + "CpuCredits": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SuccessfulInstanceCreditSpecifications": { + "locationName": "successfulInstanceCreditSpecificationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + } + } + } + }, + "UnsuccessfulInstanceCreditSpecifications": { + "locationName": "unsuccessfulInstanceCreditSpecificationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "Error": { + "locationName": "error", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + } + } + } + } + } + } + }, + "ModifyInstanceEventStartTime": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "InstanceEventId", + "NotBefore" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": {}, + "InstanceEventId": {}, + "NotBefore": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "Event": { + "shape": "Smo", + "locationName": "event" + } + } + } + }, + "ModifyInstancePlacement": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "Affinity": { + "locationName": "affinity" + }, + "GroupName": {}, + "HostId": { + "locationName": "hostId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "Tenancy": { + "locationName": "tenancy" + }, + "PartitionNumber": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyLaunchTemplate": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ClientToken": {}, + "LaunchTemplateId": {}, + "LaunchTemplateName": {}, + "DefaultVersion": { + "locationName": "SetDefaultVersion" + } + } + }, + "output": { + "type": "structure", + "members": { + "LaunchTemplate": { + "shape": "S8z", + "locationName": "launchTemplate" + } + } + } + }, + "ModifyNetworkInterfaceAttribute": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "Attachment": { + "locationName": "attachment", + "type": "structure", + "members": { + "AttachmentId": { + "locationName": "attachmentId" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + } + } + }, + "Description": { + "shape": "S61", + "locationName": "description" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Groups": { + "shape": "S86", + "locationName": "SecurityGroupId" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "SourceDestCheck": { + "shape": "Smd", + "locationName": "sourceDestCheck" + } + } + } + }, + "ModifyReservedInstances": { + "input": { + "type": "structure", + "required": [ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members": { + "ReservedInstancesIds": { + "shape": "Spj", + "locationName": "ReservedInstancesId" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "TargetConfigurations": { + "locationName": "ReservedInstancesConfigurationSetItemType", + "type": "list", + "member": { + "shape": "Sq4", + "locationName": "item" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesModificationId": { + "locationName": "reservedInstancesModificationId" + } + } + } + }, + "ModifySnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "SnapshotId" + ], + "members": { + "Attribute": {}, + "CreateVolumePermission": { + "type": "structure", + "members": { + "Add": { + "shape": "Sr9" + }, + "Remove": { + "shape": "Sr9" + } + } + }, + "GroupNames": { + "shape": "Sr2", + "locationName": "UserGroup" + }, + "OperationType": {}, + "SnapshotId": {}, + "UserIds": { + "shape": "Syy", + "locationName": "UserId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "ModifySpotFleetRequest": { + "input": { + "type": "structure", + "required": [ + "SpotFleetRequestId" + ], + "members": { + "ExcessCapacityTerminationPolicy": { + "locationName": "excessCapacityTerminationPolicy" + }, + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + }, + "TargetCapacity": { + "locationName": "targetCapacity", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifySubnetAttribute": { + "input": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "AssignIpv6AddressOnCreation": { + "shape": "Smd" + }, + "MapPublicIpOnLaunch": { + "shape": "Smd" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + } + }, + "ModifyTransitGatewayVpcAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "AddSubnetIds": { + "shape": "Sd" + }, + "RemoveSubnetIds": { + "shape": "Sd" + }, + "Options": { + "type": "structure", + "members": { + "DnsSupport": {}, + "Ipv6Support": {} + } + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "Sb", + "locationName": "transitGatewayVpcAttachment" + } + } + } + }, + "ModifyVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": {}, + "Size": { + "type": "integer" + }, + "VolumeType": {}, + "Iops": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "VolumeModification": { + "shape": "Suh", + "locationName": "volumeModification" + } + } + } + }, + "ModifyVolumeAttribute": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "AutoEnableIO": { + "shape": "Smd" + }, + "VolumeId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "ModifyVpcAttribute": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "EnableDnsHostnames": { + "shape": "Smd" + }, + "EnableDnsSupport": { + "shape": "Smd" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "ModifyVpcEndpoint": { + "input": { + "type": "structure", + "required": [ + "VpcEndpointId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcEndpointId": {}, + "ResetPolicy": { + "type": "boolean" + }, + "PolicyDocument": {}, + "AddRouteTableIds": { + "shape": "Sd", + "locationName": "AddRouteTableId" + }, + "RemoveRouteTableIds": { + "shape": "Sd", + "locationName": "RemoveRouteTableId" + }, + "AddSubnetIds": { + "shape": "Sd", + "locationName": "AddSubnetId" + }, + "RemoveSubnetIds": { + "shape": "Sd", + "locationName": "RemoveSubnetId" + }, + "AddSecurityGroupIds": { + "shape": "Sd", + "locationName": "AddSecurityGroupId" + }, + "RemoveSecurityGroupIds": { + "shape": "Sd", + "locationName": "RemoveSecurityGroupId" + }, + "PrivateDnsEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyVpcEndpointConnectionNotification": { + "input": { + "type": "structure", + "required": [ + "ConnectionNotificationId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ConnectionNotificationId": {}, + "ConnectionNotificationArn": {}, + "ConnectionEvents": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReturnValue": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyVpcEndpointServiceConfiguration": { + "input": { + "type": "structure", + "required": [ + "ServiceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceId": {}, + "AcceptanceRequired": { + "type": "boolean" + }, + "AddNetworkLoadBalancerArns": { + "shape": "Sd", + "locationName": "AddNetworkLoadBalancerArn" + }, + "RemoveNetworkLoadBalancerArns": { + "shape": "Sd", + "locationName": "RemoveNetworkLoadBalancerArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyVpcEndpointServicePermissions": { + "input": { + "type": "structure", + "required": [ + "ServiceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceId": {}, + "AddAllowedPrincipals": { + "shape": "Sd" + }, + "RemoveAllowedPrincipals": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReturnValue": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyVpcPeeringConnectionOptions": { + "input": { + "type": "structure", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "AccepterPeeringConnectionOptions": { + "shape": "S10s" + }, + "DryRun": { + "type": "boolean" + }, + "RequesterPeeringConnectionOptions": { + "shape": "S10s" + }, + "VpcPeeringConnectionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "AccepterPeeringConnectionOptions": { + "shape": "S10u", + "locationName": "accepterPeeringConnectionOptions" + }, + "RequesterPeeringConnectionOptions": { + "shape": "S10u", + "locationName": "requesterPeeringConnectionOptions" + } + } + } + }, + "ModifyVpcTenancy": { + "input": { + "type": "structure", + "required": [ + "VpcId", + "InstanceTenancy" + ], + "members": { + "VpcId": {}, + "InstanceTenancy": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReturnValue": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ModifyVpnConnection": { + "input": { + "type": "structure", + "required": [ + "VpnConnectionId" + ], + "members": { + "VpnConnectionId": {}, + "TransitGatewayId": {}, + "VpnGatewayId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnConnection": { + "shape": "Sdf", + "locationName": "vpnConnection" + } + } + } + }, + "MonitorInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "shape": "S112", + "locationName": "instancesSet" + } + } + } + }, + "MoveAddressToVpc": { + "input": { + "type": "structure", + "required": [ + "PublicIp" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "PublicIp": { + "locationName": "publicIp" + } + } + }, + "output": { + "type": "structure", + "members": { + "AllocationId": { + "locationName": "allocationId" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "ProvisionByoipCidr": { + "input": { + "type": "structure", + "required": [ + "Cidr" + ], + "members": { + "Cidr": {}, + "CidrAuthorizationContext": { + "type": "structure", + "required": [ + "Message", + "Signature" + ], + "members": { + "Message": {}, + "Signature": {} + } + }, + "Description": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ByoipCidr": { + "shape": "S12", + "locationName": "byoipCidr" + } + } + } + }, + "PurchaseHostReservation": { + "input": { + "type": "structure", + "required": [ + "HostIdSet", + "OfferingId" + ], + "members": { + "ClientToken": {}, + "CurrencyCode": {}, + "HostIdSet": { + "shape": "Sxa" + }, + "LimitPrice": {}, + "OfferingId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClientToken": { + "locationName": "clientToken" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Purchase": { + "shape": "Sxc", + "locationName": "purchase" + }, + "TotalHourlyPrice": { + "locationName": "totalHourlyPrice" + }, + "TotalUpfrontPrice": { + "locationName": "totalUpfrontPrice" + } + } + } + }, + "PurchaseReservedInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "InstanceCount", + "ReservedInstancesOfferingId" + ], + "members": { + "InstanceCount": { + "type": "integer" + }, + "ReservedInstancesOfferingId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "LimitPrice": { + "locationName": "limitPrice", + "type": "structure", + "members": { + "Amount": { + "locationName": "amount", + "type": "double" + }, + "CurrencyCode": { + "locationName": "currencyCode" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "locationName": "reservedInstancesId" + } + } + } + }, + "PurchaseScheduledInstances": { + "input": { + "type": "structure", + "required": [ + "PurchaseRequests" + ], + "members": { + "ClientToken": { + "idempotencyToken": true + }, + "DryRun": { + "type": "boolean" + }, + "PurchaseRequests": { + "locationName": "PurchaseRequest", + "type": "list", + "member": { + "locationName": "PurchaseRequest", + "type": "structure", + "required": [ + "InstanceCount", + "PurchaseToken" + ], + "members": { + "InstanceCount": { + "type": "integer" + }, + "PurchaseToken": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ScheduledInstanceSet": { + "locationName": "scheduledInstanceSet", + "type": "list", + "member": { + "shape": "Sqv", + "locationName": "item" + } + } + } + } + }, + "RebootInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "RegisterImage": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "ImageLocation": {}, + "Architecture": { + "locationName": "architecture" + }, + "BlockDeviceMappings": { + "shape": "S7d", + "locationName": "BlockDeviceMapping" + }, + "Description": { + "locationName": "description" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EnaSupport": { + "locationName": "enaSupport", + "type": "boolean" + }, + "KernelId": { + "locationName": "kernelId" + }, + "Name": { + "locationName": "name" + }, + "BillingProducts": { + "locationName": "BillingProduct", + "type": "list", + "member": { + "locationName": "item" + } + }, + "RamdiskId": { + "locationName": "ramdiskId" + }, + "RootDeviceName": { + "locationName": "rootDeviceName" + }, + "SriovNetSupport": { + "locationName": "sriovNetSupport" + }, + "VirtualizationType": { + "locationName": "virtualizationType" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageId": { + "locationName": "imageId" + } + } + } + }, + "RejectTransitGatewayVpcAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "Sb", + "locationName": "transitGatewayVpcAttachment" + } + } + } + }, + "RejectVpcEndpointConnections": { + "input": { + "type": "structure", + "required": [ + "ServiceId", + "VpcEndpointIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ServiceId": {}, + "VpcEndpointIds": { + "shape": "Sd", + "locationName": "VpcEndpointId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "Sm", + "locationName": "unsuccessful" + } + } + } + }, + "RejectVpcPeeringConnection": { + "input": { + "type": "structure", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ReleaseAddress": { + "input": { + "type": "structure", + "members": { + "AllocationId": {}, + "PublicIp": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "ReleaseHosts": { + "input": { + "type": "structure", + "required": [ + "HostIds" + ], + "members": { + "HostIds": { + "shape": "Sks", + "locationName": "hostId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Successful": { + "shape": "S1d", + "locationName": "successful" + }, + "Unsuccessful": { + "shape": "Sz7", + "locationName": "unsuccessful" + } + } + } + }, + "ReplaceIamInstanceProfileAssociation": { + "input": { + "type": "structure", + "required": [ + "IamInstanceProfile", + "AssociationId" + ], + "members": { + "IamInstanceProfile": { + "shape": "S1u" + }, + "AssociationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "shape": "S1w", + "locationName": "iamInstanceProfileAssociation" + } + } + } + }, + "ReplaceNetworkAclAssociation": { + "input": { + "type": "structure", + "required": [ + "AssociationId", + "NetworkAclId" + ], + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkAclId": { + "locationName": "networkAclId" + } + } + }, + "output": { + "type": "structure", + "members": { + "NewAssociationId": { + "locationName": "newAssociationId" + } + } + } + }, + "ReplaceNetworkAclEntry": { + "input": { + "type": "structure", + "required": [ + "Egress", + "NetworkAclId", + "Protocol", + "RuleAction", + "RuleNumber" + ], + "members": { + "CidrBlock": { + "locationName": "cidrBlock" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Egress": { + "locationName": "egress", + "type": "boolean" + }, + "IcmpTypeCode": { + "shape": "Sa7", + "locationName": "Icmp" + }, + "Ipv6CidrBlock": { + "locationName": "ipv6CidrBlock" + }, + "NetworkAclId": { + "locationName": "networkAclId" + }, + "PortRange": { + "shape": "Sa8", + "locationName": "portRange" + }, + "Protocol": { + "locationName": "protocol" + }, + "RuleAction": { + "locationName": "ruleAction" + }, + "RuleNumber": { + "locationName": "ruleNumber", + "type": "integer" + } + } + } + }, + "ReplaceRoute": { + "input": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DestinationCidrBlock": { + "locationName": "destinationCidrBlock" + }, + "DestinationIpv6CidrBlock": { + "locationName": "destinationIpv6CidrBlock" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EgressOnlyInternetGatewayId": { + "locationName": "egressOnlyInternetGatewayId" + }, + "GatewayId": { + "locationName": "gatewayId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "NatGatewayId": { + "locationName": "natGatewayId" + }, + "TransitGatewayId": {}, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "RouteTableId": { + "locationName": "routeTableId" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + } + }, + "ReplaceRouteTableAssociation": { + "input": { + "type": "structure", + "required": [ + "AssociationId", + "RouteTableId" + ], + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "RouteTableId": { + "locationName": "routeTableId" + } + } + }, + "output": { + "type": "structure", + "members": { + "NewAssociationId": { + "locationName": "newAssociationId" + } + } + } + }, + "ReplaceTransitGatewayRoute": { + "input": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "TransitGatewayRouteTableId" + ], + "members": { + "DestinationCidrBlock": {}, + "TransitGatewayRouteTableId": {}, + "TransitGatewayAttachmentId": {}, + "Blackhole": { + "type": "boolean" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Route": { + "shape": "Sc4", + "locationName": "route" + } + } + } + }, + "ReportInstanceStatus": { + "input": { + "type": "structure", + "required": [ + "Instances", + "ReasonCodes", + "Status" + ], + "members": { + "Description": { + "locationName": "description" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EndTime": { + "locationName": "endTime", + "type": "timestamp" + }, + "Instances": { + "shape": "Sh2", + "locationName": "instanceId" + }, + "ReasonCodes": { + "locationName": "reasonCode", + "type": "list", + "member": { + "locationName": "item" + } + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "RequestSpotFleet": { + "input": { + "type": "structure", + "required": [ + "SpotFleetRequestConfig" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "SpotFleetRequestConfig": { + "shape": "Sru", + "locationName": "spotFleetRequestConfig" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotFleetRequestId": { + "locationName": "spotFleetRequestId" + } + } + } + }, + "RequestSpotInstances": { + "input": { + "type": "structure", + "members": { + "AvailabilityZoneGroup": { + "locationName": "availabilityZoneGroup" + }, + "BlockDurationMinutes": { + "locationName": "blockDurationMinutes", + "type": "integer" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceCount": { + "locationName": "instanceCount", + "type": "integer" + }, + "LaunchGroup": { + "locationName": "launchGroup" + }, + "LaunchSpecification": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "shape": "Sd", + "locationName": "SecurityGroupId" + }, + "SecurityGroups": { + "shape": "Sd", + "locationName": "SecurityGroup" + }, + "AddressingType": { + "locationName": "addressingType" + }, + "BlockDeviceMappings": { + "shape": "Sle", + "locationName": "blockDeviceMapping" + }, + "EbsOptimized": { + "locationName": "ebsOptimized", + "type": "boolean" + }, + "IamInstanceProfile": { + "shape": "S1u", + "locationName": "iamInstanceProfile" + }, + "ImageId": { + "locationName": "imageId" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "KernelId": { + "locationName": "kernelId" + }, + "KeyName": { + "locationName": "keyName" + }, + "Monitoring": { + "shape": "Ssm", + "locationName": "monitoring" + }, + "NetworkInterfaces": { + "shape": "Ss1", + "locationName": "NetworkInterface" + }, + "Placement": { + "shape": "Ss3", + "locationName": "placement" + }, + "RamdiskId": { + "locationName": "ramdiskId" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "UserData": { + "locationName": "userData" + } + } + }, + "SpotPrice": { + "locationName": "spotPrice" + }, + "Type": { + "locationName": "type" + }, + "ValidFrom": { + "locationName": "validFrom", + "type": "timestamp" + }, + "ValidUntil": { + "locationName": "validUntil", + "type": "timestamp" + }, + "InstanceInterruptionBehavior": {} + } + }, + "output": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "shape": "Ssj", + "locationName": "spotInstanceRequestSet" + } + } + } + }, + "ResetFpgaImageAttribute": { + "input": { + "type": "structure", + "required": [ + "FpgaImageId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "FpgaImageId": {}, + "Attribute": {} + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "ResetImageAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "ImageId" + ], + "members": { + "Attribute": {}, + "ImageId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "ResetInstanceAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "InstanceId" + ], + "members": { + "Attribute": { + "locationName": "attribute" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "InstanceId": { + "locationName": "instanceId" + } + } + } + }, + "ResetNetworkInterfaceAttribute": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "SourceDestCheck": { + "locationName": "sourceDestCheck" + } + } + } + }, + "ResetSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "Attribute", + "SnapshotId" + ], + "members": { + "Attribute": {}, + "SnapshotId": {}, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "RestoreAddressToClassic": { + "input": { + "type": "structure", + "required": [ + "PublicIp" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "PublicIp": { + "locationName": "publicIp" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicIp": { + "locationName": "publicIp" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "RevokeClientVpnIngress": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "members": { + "ClientVpnEndpointId": {}, + "TargetNetworkCidr": {}, + "AccessGroupId": {}, + "RevokeAllGroups": { + "type": "boolean" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": { + "shape": "S2w", + "locationName": "status" + } + } + } + }, + "RevokeSecurityGroupEgress": { + "input": { + "type": "structure", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "GroupId": { + "locationName": "groupId" + }, + "IpPermissions": { + "shape": "S2z", + "locationName": "ipPermissions" + }, + "CidrIp": { + "locationName": "cidrIp" + }, + "FromPort": { + "locationName": "fromPort", + "type": "integer" + }, + "IpProtocol": { + "locationName": "ipProtocol" + }, + "ToPort": { + "locationName": "toPort", + "type": "integer" + }, + "SourceSecurityGroupName": { + "locationName": "sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId": { + "locationName": "sourceSecurityGroupOwnerId" + } + } + } + }, + "RevokeSecurityGroupIngress": { + "input": { + "type": "structure", + "members": { + "CidrIp": {}, + "FromPort": { + "type": "integer" + }, + "GroupId": {}, + "GroupName": {}, + "IpPermissions": { + "shape": "S2z" + }, + "IpProtocol": {}, + "SourceSecurityGroupName": {}, + "SourceSecurityGroupOwnerId": {}, + "ToPort": { + "type": "integer" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + } + }, + "RunInstances": { + "input": { + "type": "structure", + "required": [ + "MaxCount", + "MinCount" + ], + "members": { + "BlockDeviceMappings": { + "shape": "S7d", + "locationName": "BlockDeviceMapping" + }, + "ImageId": {}, + "InstanceType": {}, + "Ipv6AddressCount": { + "type": "integer" + }, + "Ipv6Addresses": { + "shape": "S9a", + "locationName": "Ipv6Address" + }, + "KernelId": {}, + "KeyName": {}, + "MaxCount": { + "type": "integer" + }, + "MinCount": { + "type": "integer" + }, + "Monitoring": { + "shape": "Ssm" + }, + "Placement": { + "shape": "S6m" + }, + "RamdiskId": {}, + "SecurityGroupIds": { + "shape": "S86", + "locationName": "SecurityGroupId" + }, + "SecurityGroups": { + "shape": "S8k", + "locationName": "SecurityGroup" + }, + "SubnetId": {}, + "UserData": {}, + "AdditionalInfo": { + "locationName": "additionalInfo" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "DisableApiTermination": { + "locationName": "disableApiTermination", + "type": "boolean" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "EbsOptimized": { + "locationName": "ebsOptimized", + "type": "boolean" + }, + "IamInstanceProfile": { + "shape": "S1u", + "locationName": "iamInstanceProfile" + }, + "InstanceInitiatedShutdownBehavior": { + "locationName": "instanceInitiatedShutdownBehavior" + }, + "NetworkInterfaces": { + "shape": "Ss1", + "locationName": "networkInterface" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "ElasticGpuSpecification": { + "type": "list", + "member": { + "shape": "S8h", + "locationName": "item" + } + }, + "ElasticInferenceAccelerators": { + "locationName": "ElasticInferenceAccelerator", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + } + }, + "TagSpecifications": { + "shape": "S19", + "locationName": "TagSpecification" + }, + "LaunchTemplate": { + "type": "structure", + "members": { + "LaunchTemplateId": {}, + "LaunchTemplateName": {}, + "Version": {} + } + }, + "InstanceMarketOptions": { + "type": "structure", + "members": { + "MarketType": {}, + "SpotOptions": { + "type": "structure", + "members": { + "MaxPrice": {}, + "SpotInstanceType": {}, + "BlockDurationMinutes": { + "type": "integer" + }, + "ValidUntil": { + "type": "timestamp" + }, + "InstanceInterruptionBehavior": {} + } + } + } + }, + "CreditSpecification": { + "shape": "S8q" + }, + "CpuOptions": { + "type": "structure", + "members": { + "CoreCount": { + "type": "integer" + }, + "ThreadsPerCore": { + "type": "integer" + } + } + }, + "CapacityReservationSpecification": { + "shape": "Szi" + }, + "HibernationOptions": { + "type": "structure", + "members": { + "Configured": { + "type": "boolean" + } + } + }, + "LicenseSpecifications": { + "locationName": "LicenseSpecification", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LicenseConfigurationArn": {} + } + } + } + } + }, + "output": { + "shape": "Sn2" + } + }, + "RunScheduledInstances": { + "input": { + "type": "structure", + "required": [ + "LaunchSpecification", + "ScheduledInstanceId" + ], + "members": { + "ClientToken": { + "idempotencyToken": true + }, + "DryRun": { + "type": "boolean" + }, + "InstanceCount": { + "type": "integer" + }, + "LaunchSpecification": { + "type": "structure", + "required": [ + "ImageId" + ], + "members": { + "BlockDeviceMappings": { + "locationName": "BlockDeviceMapping", + "type": "list", + "member": { + "locationName": "BlockDeviceMapping", + "type": "structure", + "members": { + "DeviceName": {}, + "Ebs": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "SnapshotId": {}, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": {} + } + }, + "NoDevice": {}, + "VirtualName": {} + } + } + }, + "EbsOptimized": { + "type": "boolean" + }, + "IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": {}, + "Name": {} + } + }, + "ImageId": {}, + "InstanceType": {}, + "KernelId": {}, + "KeyName": {}, + "Monitoring": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "NetworkInterfaces": { + "locationName": "NetworkInterface", + "type": "list", + "member": { + "locationName": "NetworkInterface", + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "Description": {}, + "DeviceIndex": { + "type": "integer" + }, + "Groups": { + "shape": "S13e", + "locationName": "Group" + }, + "Ipv6AddressCount": { + "type": "integer" + }, + "Ipv6Addresses": { + "locationName": "Ipv6Address", + "type": "list", + "member": { + "locationName": "Ipv6Address", + "type": "structure", + "members": { + "Ipv6Address": {} + } + } + }, + "NetworkInterfaceId": {}, + "PrivateIpAddress": {}, + "PrivateIpAddressConfigs": { + "locationName": "PrivateIpAddressConfig", + "type": "list", + "member": { + "locationName": "PrivateIpAddressConfigSet", + "type": "structure", + "members": { + "Primary": { + "type": "boolean" + }, + "PrivateIpAddress": {} + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer" + }, + "SubnetId": {} + } + } + }, + "Placement": { + "type": "structure", + "members": { + "AvailabilityZone": {}, + "GroupName": {} + } + }, + "RamdiskId": {}, + "SecurityGroupIds": { + "shape": "S13e", + "locationName": "SecurityGroupId" + }, + "SubnetId": {}, + "UserData": {} + } + }, + "ScheduledInstanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceIdSet": { + "locationName": "instanceIdSet", + "type": "list", + "member": { + "locationName": "item" + } + } + } + } + }, + "SearchTransitGatewayRoutes": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "Filters" + ], + "members": { + "TransitGatewayRouteTableId": {}, + "Filters": { + "shape": "Sg4", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Routes": { + "locationName": "routeSet", + "type": "list", + "member": { + "shape": "Sc4", + "locationName": "item" + } + }, + "AdditionalRoutesAvailable": { + "locationName": "additionalRoutesAvailable", + "type": "boolean" + } + } + } + }, + "StartInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "AdditionalInfo": { + "locationName": "additionalInfo" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "StartingInstances": { + "shape": "S13s", + "locationName": "instancesSet" + } + } + } + }, + "StopInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "Hibernate": { + "type": "boolean" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + }, + "Force": { + "locationName": "force", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "StoppingInstances": { + "shape": "S13s", + "locationName": "instancesSet" + } + } + } + }, + "TerminateClientVpnConnections": { + "input": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": {}, + "ConnectionId": {}, + "Username": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "locationName": "clientVpnEndpointId" + }, + "Username": { + "locationName": "username" + }, + "ConnectionStatuses": { + "locationName": "connectionStatuses", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ConnectionId": { + "locationName": "connectionId" + }, + "PreviousStatus": { + "shape": "She", + "locationName": "previousStatus" + }, + "CurrentStatus": { + "shape": "She", + "locationName": "currentStatus" + } + } + } + } + } + } + }, + "TerminateInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TerminatingInstances": { + "shape": "S13s", + "locationName": "instancesSet" + } + } + } + }, + "UnassignIpv6Addresses": { + "input": { + "type": "structure", + "required": [ + "Ipv6Addresses", + "NetworkInterfaceId" + ], + "members": { + "Ipv6Addresses": { + "shape": "S1i", + "locationName": "ipv6Addresses" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "UnassignedIpv6Addresses": { + "shape": "S1i", + "locationName": "unassignedIpv6Addresses" + } + } + } + }, + "UnassignPrivateIpAddresses": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members": { + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "PrivateIpAddresses": { + "shape": "S1l", + "locationName": "privateIpAddress" + } + } + } + }, + "UnmonitorInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sh2", + "locationName": "InstanceId" + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "shape": "S112", + "locationName": "instancesSet" + } + } + } + }, + "UpdateSecurityGroupRuleDescriptionsEgress": { + "input": { + "type": "structure", + "required": [ + "IpPermissions" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupId": {}, + "GroupName": {}, + "IpPermissions": { + "shape": "S2z" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "UpdateSecurityGroupRuleDescriptionsIngress": { + "input": { + "type": "structure", + "required": [ + "IpPermissions" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupId": {}, + "GroupName": {}, + "IpPermissions": { + "shape": "S2z" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "locationName": "return", + "type": "boolean" + } + } + } + }, + "WithdrawByoipCidr": { + "input": { + "type": "structure", + "required": [ + "Cidr" + ], + "members": { + "Cidr": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ByoipCidr": { + "shape": "S12", + "locationName": "byoipCidr" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "locationName": "ReservedInstanceId" + } + }, + "S5": { + "type": "list", + "member": { + "locationName": "TargetConfigurationRequest", + "type": "structure", + "required": [ + "OfferingId" + ], + "members": { + "InstanceCount": { + "type": "integer" + }, + "OfferingId": {} + } + } + }, + "Sb": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "VpcOwnerId": { + "locationName": "vpcOwnerId" + }, + "State": { + "locationName": "state" + }, + "SubnetIds": { + "shape": "Sd", + "locationName": "subnetIds" + }, + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp" + }, + "Options": { + "locationName": "options", + "type": "structure", + "members": { + "DnsSupport": { + "locationName": "dnsSupport" + }, + "Ipv6Support": { + "locationName": "ipv6Support" + } + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "Sd": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Si": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Key": { + "locationName": "key" + }, + "Value": { + "locationName": "value" + } + } + } + }, + "Sm": { + "type": "list", + "member": { + "shape": "Sn", + "locationName": "item" + } + }, + "Sn": { + "type": "structure", + "members": { + "Error": { + "locationName": "error", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "ResourceId": { + "locationName": "resourceId" + } + } + }, + "Sr": { + "type": "structure", + "members": { + "AccepterVpcInfo": { + "shape": "Ss", + "locationName": "accepterVpcInfo" + }, + "ExpirationTime": { + "locationName": "expirationTime", + "type": "timestamp" + }, + "RequesterVpcInfo": { + "shape": "Ss", + "locationName": "requesterVpcInfo" + }, + "Status": { + "locationName": "status", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + }, + "Ss": { + "type": "structure", + "members": { + "CidrBlock": { + "locationName": "cidrBlock" + }, + "Ipv6CidrBlockSet": { + "locationName": "ipv6CidrBlockSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Ipv6CidrBlock": { + "locationName": "ipv6CidrBlock" + } + } + } + }, + "CidrBlockSet": { + "locationName": "cidrBlockSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CidrBlock": { + "locationName": "cidrBlock" + } + } + } + }, + "OwnerId": { + "locationName": "ownerId" + }, + "PeeringOptions": { + "locationName": "peeringOptions", + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "locationName": "allowDnsResolutionFromRemoteVpc", + "type": "boolean" + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "locationName": "allowEgressFromLocalClassicLinkToRemoteVpc", + "type": "boolean" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "locationName": "allowEgressFromLocalVpcToRemoteClassicLink", + "type": "boolean" + } + } + }, + "VpcId": { + "locationName": "vpcId" + }, + "Region": { + "locationName": "region" + } + } + }, + "S12": { + "type": "structure", + "members": { + "Cidr": { + "locationName": "cidr" + }, + "Description": { + "locationName": "description" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "State": { + "locationName": "state" + } + } + }, + "S19": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ResourceType": { + "locationName": "resourceType" + }, + "Tags": { + "shape": "Si", + "locationName": "Tag" + } + } + } + }, + "S1d": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "S1f": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "S1i": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "S1l": { + "type": "list", + "member": { + "locationName": "PrivateIpAddress" + } + }, + "S1q": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "S1u": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Name": { + "locationName": "name" + } + } + }, + "S1w": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "IamInstanceProfile": { + "shape": "S1x", + "locationName": "iamInstanceProfile" + }, + "State": { + "locationName": "state" + }, + "Timestamp": { + "locationName": "timestamp", + "type": "timestamp" + } + } + }, + "S1x": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Id": { + "locationName": "id" + } + } + }, + "S23": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "Ipv6CidrBlock": { + "locationName": "ipv6CidrBlock" + }, + "Ipv6CidrBlockState": { + "locationName": "ipv6CidrBlockState", + "type": "structure", + "members": { + "State": { + "locationName": "state" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + } + } + }, + "S28": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "locationName": "transitGatewayRouteTableId" + }, + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "State": { + "locationName": "state" + } + } + }, + "S2d": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "Ipv6CidrBlock": { + "locationName": "ipv6CidrBlock" + }, + "Ipv6CidrBlockState": { + "shape": "S2e", + "locationName": "ipv6CidrBlockState" + } + } + }, + "S2e": { + "type": "structure", + "members": { + "State": { + "locationName": "state" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + }, + "S2g": { + "type": "structure", + "members": { + "AssociationId": { + "locationName": "associationId" + }, + "CidrBlock": { + "locationName": "cidrBlock" + }, + "CidrBlockState": { + "shape": "S2e", + "locationName": "cidrBlockState" + } + } + }, + "S2i": { + "type": "list", + "member": { + "locationName": "groupId" + } + }, + "S2o": { + "type": "structure", + "members": { + "AttachTime": { + "locationName": "attachTime", + "type": "timestamp" + }, + "Device": { + "locationName": "device" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "State": { + "locationName": "status" + }, + "VolumeId": { + "locationName": "volumeId" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + } + } + }, + "S2s": { + "type": "structure", + "members": { + "State": { + "locationName": "state" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "S2w": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "S2z": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "FromPort": { + "locationName": "fromPort", + "type": "integer" + }, + "IpProtocol": { + "locationName": "ipProtocol" + }, + "IpRanges": { + "locationName": "ipRanges", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CidrIp": { + "locationName": "cidrIp" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "Ipv6Ranges": { + "locationName": "ipv6Ranges", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CidrIpv6": { + "locationName": "cidrIpv6" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "PrefixListIds": { + "locationName": "prefixListIds", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "PrefixListId": { + "locationName": "prefixListId" + } + } + } + }, + "ToPort": { + "locationName": "toPort", + "type": "integer" + }, + "UserIdGroupPairs": { + "locationName": "groups", + "type": "list", + "member": { + "shape": "S38", + "locationName": "item" + } + } + } + } + }, + "S38": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "GroupId": { + "locationName": "groupId" + }, + "GroupName": { + "locationName": "groupName" + }, + "PeeringStatus": { + "locationName": "peeringStatus" + }, + "UserId": { + "locationName": "userId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + }, + "S3b": { + "type": "structure", + "members": { + "S3": { + "type": "structure", + "members": { + "AWSAccessKeyId": {}, + "Bucket": { + "locationName": "bucket" + }, + "Prefix": { + "locationName": "prefix" + }, + "UploadPolicy": { + "locationName": "uploadPolicy", + "type": "blob" + }, + "UploadPolicySignature": { + "locationName": "uploadPolicySignature" + } + } + } + } + }, + "S3f": { + "type": "structure", + "members": { + "BundleId": { + "locationName": "bundleId" + }, + "BundleTaskError": { + "locationName": "error", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "InstanceId": { + "locationName": "instanceId" + }, + "Progress": { + "locationName": "progress" + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + }, + "State": { + "locationName": "state" + }, + "Storage": { + "shape": "S3b", + "locationName": "storage" + }, + "UpdateTime": { + "locationName": "updateTime", + "type": "timestamp" + } + } + }, + "S3s": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ClientToken": { + "locationName": "clientToken" + }, + "CreateDate": { + "locationName": "createDate", + "type": "timestamp" + }, + "InstanceCounts": { + "locationName": "instanceCounts", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceCount": { + "locationName": "instanceCount", + "type": "integer" + }, + "State": { + "locationName": "state" + } + } + } + }, + "PriceSchedules": { + "locationName": "priceSchedules", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Active": { + "locationName": "active", + "type": "boolean" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Price": { + "locationName": "price", + "type": "double" + }, + "Term": { + "locationName": "term", + "type": "long" + } + } + } + }, + "ReservedInstancesId": { + "locationName": "reservedInstancesId" + }, + "ReservedInstancesListingId": { + "locationName": "reservedInstancesListingId" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "UpdateDate": { + "locationName": "updateDate", + "type": "timestamp" + } + } + } + }, + "S4d": { + "type": "list", + "member": { + "locationName": "SpotInstanceRequestId" + } + }, + "S4w": { + "type": "structure", + "members": { + "CapacityReservationId": { + "locationName": "capacityReservationId" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "InstancePlatform": { + "locationName": "instancePlatform" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Tenancy": { + "locationName": "tenancy" + }, + "TotalInstanceCount": { + "locationName": "totalInstanceCount", + "type": "integer" + }, + "AvailableInstanceCount": { + "locationName": "availableInstanceCount", + "type": "integer" + }, + "EbsOptimized": { + "locationName": "ebsOptimized", + "type": "boolean" + }, + "EphemeralStorage": { + "locationName": "ephemeralStorage", + "type": "boolean" + }, + "State": { + "locationName": "state" + }, + "EndDate": { + "locationName": "endDate", + "type": "timestamp" + }, + "EndDateType": { + "locationName": "endDateType" + }, + "InstanceMatchCriteria": { + "locationName": "instanceMatchCriteria" + }, + "CreateDate": { + "locationName": "createDate", + "type": "timestamp" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "S54": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "CloudwatchLogGroup": {}, + "CloudwatchLogStream": {} + } + }, + "S57": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "S5b": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "S5g": { + "type": "structure", + "members": { + "BgpAsn": { + "locationName": "bgpAsn" + }, + "CustomerGatewayId": { + "locationName": "customerGatewayId" + }, + "IpAddress": { + "locationName": "ipAddress" + }, + "State": { + "locationName": "state" + }, + "Type": { + "locationName": "type" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "S5j": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "AvailabilityZoneId": { + "locationName": "availabilityZoneId" + }, + "AvailableIpAddressCount": { + "locationName": "availableIpAddressCount", + "type": "integer" + }, + "CidrBlock": { + "locationName": "cidrBlock" + }, + "DefaultForAz": { + "locationName": "defaultForAz", + "type": "boolean" + }, + "MapPublicIpOnLaunch": { + "locationName": "mapPublicIpOnLaunch", + "type": "boolean" + }, + "State": { + "locationName": "state" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "AssignIpv6AddressOnCreation": { + "locationName": "assignIpv6AddressOnCreation", + "type": "boolean" + }, + "Ipv6CidrBlockAssociationSet": { + "locationName": "ipv6CidrBlockAssociationSet", + "type": "list", + "member": { + "shape": "S23", + "locationName": "item" + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "SubnetArn": { + "locationName": "subnetArn" + } + } + }, + "S5o": { + "type": "structure", + "members": { + "CidrBlock": { + "locationName": "cidrBlock" + }, + "DhcpOptionsId": { + "locationName": "dhcpOptionsId" + }, + "State": { + "locationName": "state" + }, + "VpcId": { + "locationName": "vpcId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "InstanceTenancy": { + "locationName": "instanceTenancy" + }, + "Ipv6CidrBlockAssociationSet": { + "locationName": "ipv6CidrBlockAssociationSet", + "type": "list", + "member": { + "shape": "S2d", + "locationName": "item" + } + }, + "CidrBlockAssociationSet": { + "locationName": "cidrBlockAssociationSet", + "type": "list", + "member": { + "shape": "S2g", + "locationName": "item" + } + }, + "IsDefault": { + "locationName": "isDefault", + "type": "boolean" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "S5x": { + "type": "structure", + "members": { + "DhcpConfigurations": { + "locationName": "dhcpConfigurationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Key": { + "locationName": "key" + }, + "Values": { + "locationName": "valueSet", + "type": "list", + "member": { + "shape": "S61", + "locationName": "item" + } + } + } + } + }, + "DhcpOptionsId": { + "locationName": "dhcpOptionsId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "S61": { + "type": "structure", + "members": { + "Value": { + "locationName": "value" + } + } + }, + "S64": { + "type": "structure", + "members": { + "Attachments": { + "shape": "S65", + "locationName": "attachmentSet" + }, + "EgressOnlyInternetGatewayId": { + "locationName": "egressOnlyInternetGatewayId" + } + } + }, + "S65": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "State": { + "locationName": "state" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "S6m": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Affinity": { + "locationName": "affinity" + }, + "GroupName": { + "locationName": "groupName" + }, + "PartitionNumber": { + "locationName": "partitionNumber", + "type": "integer" + }, + "HostId": { + "locationName": "hostId" + }, + "Tenancy": { + "locationName": "tenancy" + }, + "SpreadDomain": { + "locationName": "spreadDomain" + } + } + }, + "S6n": { + "type": "structure", + "required": [ + "TotalTargetCapacity" + ], + "members": { + "TotalTargetCapacity": { + "type": "integer" + }, + "OnDemandTargetCapacity": { + "type": "integer" + }, + "SpotTargetCapacity": { + "type": "integer" + }, + "DefaultTargetCapacityType": {} + } + }, + "S6u": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "shape": "S6v", + "locationName": "launchTemplateSpecification" + }, + "Overrides": { + "shape": "S6w", + "locationName": "overrides" + } + } + }, + "S6v": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "locationName": "launchTemplateId" + }, + "LaunchTemplateName": { + "locationName": "launchTemplateName" + }, + "Version": { + "locationName": "version" + } + } + }, + "S6w": { + "type": "structure", + "members": { + "InstanceType": { + "locationName": "instanceType" + }, + "MaxPrice": { + "locationName": "maxPrice" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "WeightedCapacity": { + "locationName": "weightedCapacity", + "type": "double" + }, + "Priority": { + "locationName": "priority", + "type": "double" + }, + "Placement": { + "locationName": "placement", + "type": "structure", + "members": { + "GroupName": { + "locationName": "groupName" + } + } + } + } + }, + "S71": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "S7a": { + "type": "structure", + "members": { + "Bucket": {}, + "Key": {} + } + }, + "S7d": { + "type": "list", + "member": { + "shape": "S7e", + "locationName": "BlockDeviceMapping" + } + }, + "S7e": { + "type": "structure", + "members": { + "DeviceName": { + "locationName": "deviceName" + }, + "VirtualName": { + "locationName": "virtualName" + }, + "Ebs": { + "locationName": "ebs", + "type": "structure", + "members": { + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "Iops": { + "locationName": "iops", + "type": "integer" + }, + "SnapshotId": { + "locationName": "snapshotId" + }, + "VolumeSize": { + "locationName": "volumeSize", + "type": "integer" + }, + "VolumeType": { + "locationName": "volumeType" + }, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "KmsKeyId": {} + } + }, + "NoDevice": { + "locationName": "noDevice" + } + } + }, + "S7o": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "ExportTaskId": { + "locationName": "exportTaskId" + }, + "ExportToS3Task": { + "locationName": "exportToS3", + "type": "structure", + "members": { + "ContainerFormat": { + "locationName": "containerFormat" + }, + "DiskImageFormat": { + "locationName": "diskImageFormat" + }, + "S3Bucket": { + "locationName": "s3Bucket" + }, + "S3Key": { + "locationName": "s3Key" + } + } + }, + "InstanceExportDetails": { + "locationName": "instanceExport", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "TargetEnvironment": { + "locationName": "targetEnvironment" + } + } + }, + "State": { + "locationName": "state" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + }, + "S7u": { + "type": "structure", + "members": { + "Attachments": { + "shape": "S65", + "locationName": "attachmentSet" + }, + "InternetGatewayId": { + "locationName": "internetGatewayId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "S7z": { + "type": "structure", + "members": { + "KernelId": {}, + "EbsOptimized": { + "type": "boolean" + }, + "IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": {}, + "Name": {} + } + }, + "BlockDeviceMappings": { + "locationName": "BlockDeviceMapping", + "type": "list", + "member": { + "locationName": "BlockDeviceMapping", + "type": "structure", + "members": { + "DeviceName": {}, + "VirtualName": {}, + "Ebs": { + "type": "structure", + "members": { + "Encrypted": { + "type": "boolean" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "KmsKeyId": {}, + "SnapshotId": {}, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": {} + } + }, + "NoDevice": {} + } + } + }, + "NetworkInterfaces": { + "locationName": "NetworkInterface", + "type": "list", + "member": { + "locationName": "InstanceNetworkInterfaceSpecification", + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "Description": {}, + "DeviceIndex": { + "type": "integer" + }, + "Groups": { + "shape": "S86", + "locationName": "SecurityGroupId" + }, + "InterfaceType": {}, + "Ipv6AddressCount": { + "type": "integer" + }, + "Ipv6Addresses": { + "type": "list", + "member": { + "locationName": "InstanceIpv6Address", + "type": "structure", + "members": { + "Ipv6Address": {} + } + } + }, + "NetworkInterfaceId": {}, + "PrivateIpAddress": {}, + "PrivateIpAddresses": { + "shape": "S89" + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer" + }, + "SubnetId": {} + } + } + }, + "ImageId": {}, + "InstanceType": {}, + "KeyName": {}, + "Monitoring": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "Placement": { + "type": "structure", + "members": { + "AvailabilityZone": {}, + "Affinity": {}, + "GroupName": {}, + "HostId": {}, + "Tenancy": {}, + "SpreadDomain": {} + } + }, + "RamDiskId": {}, + "DisableApiTermination": { + "type": "boolean" + }, + "InstanceInitiatedShutdownBehavior": {}, + "UserData": {}, + "TagSpecifications": { + "locationName": "TagSpecification", + "type": "list", + "member": { + "locationName": "LaunchTemplateTagSpecificationRequest", + "type": "structure", + "members": { + "ResourceType": {}, + "Tags": { + "shape": "Si", + "locationName": "Tag" + } + } + } + }, + "ElasticGpuSpecifications": { + "locationName": "ElasticGpuSpecification", + "type": "list", + "member": { + "shape": "S8h", + "locationName": "ElasticGpuSpecification" + } + }, + "ElasticInferenceAccelerators": { + "locationName": "ElasticInferenceAccelerator", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + } + }, + "SecurityGroupIds": { + "shape": "S86", + "locationName": "SecurityGroupId" + }, + "SecurityGroups": { + "shape": "S8k", + "locationName": "SecurityGroup" + }, + "InstanceMarketOptions": { + "type": "structure", + "members": { + "MarketType": {}, + "SpotOptions": { + "type": "structure", + "members": { + "MaxPrice": {}, + "SpotInstanceType": {}, + "BlockDurationMinutes": { + "type": "integer" + }, + "ValidUntil": { + "type": "timestamp" + }, + "InstanceInterruptionBehavior": {} + } + } + } + }, + "CreditSpecification": { + "shape": "S8q" + }, + "CpuOptions": { + "type": "structure", + "members": { + "CoreCount": { + "type": "integer" + }, + "ThreadsPerCore": { + "type": "integer" + } + } + }, + "CapacityReservationSpecification": { + "type": "structure", + "members": { + "CapacityReservationPreference": {}, + "CapacityReservationTarget": { + "shape": "S8u" + } + } + }, + "LicenseSpecifications": { + "locationName": "LicenseSpecification", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LicenseConfigurationArn": {} + } + } + }, + "HibernationOptions": { + "type": "structure", + "members": { + "Configured": { + "type": "boolean" + } + } + } + } + }, + "S86": { + "type": "list", + "member": { + "locationName": "SecurityGroupId" + } + }, + "S89": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Primary": { + "locationName": "primary", + "type": "boolean" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + } + } + } + }, + "S8h": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + }, + "S8k": { + "type": "list", + "member": { + "locationName": "SecurityGroup" + } + }, + "S8q": { + "type": "structure", + "required": [ + "CpuCredits" + ], + "members": { + "CpuCredits": {} + } + }, + "S8u": { + "type": "structure", + "members": { + "CapacityReservationId": {} + } + }, + "S8z": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "locationName": "launchTemplateId" + }, + "LaunchTemplateName": { + "locationName": "launchTemplateName" + }, + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "CreatedBy": { + "locationName": "createdBy" + }, + "DefaultVersionNumber": { + "locationName": "defaultVersionNumber", + "type": "long" + }, + "LatestVersionNumber": { + "locationName": "latestVersionNumber", + "type": "long" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "S92": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "locationName": "launchTemplateId" + }, + "LaunchTemplateName": { + "locationName": "launchTemplateName" + }, + "VersionNumber": { + "locationName": "versionNumber", + "type": "long" + }, + "VersionDescription": { + "locationName": "versionDescription" + }, + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "CreatedBy": { + "locationName": "createdBy" + }, + "DefaultVersion": { + "locationName": "defaultVersion", + "type": "boolean" + }, + "LaunchTemplateData": { + "shape": "S93", + "locationName": "launchTemplateData" + } + } + }, + "S93": { + "type": "structure", + "members": { + "KernelId": { + "locationName": "kernelId" + }, + "EbsOptimized": { + "locationName": "ebsOptimized", + "type": "boolean" + }, + "IamInstanceProfile": { + "locationName": "iamInstanceProfile", + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Name": { + "locationName": "name" + } + } + }, + "BlockDeviceMappings": { + "locationName": "blockDeviceMappingSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "DeviceName": { + "locationName": "deviceName" + }, + "VirtualName": { + "locationName": "virtualName" + }, + "Ebs": { + "locationName": "ebs", + "type": "structure", + "members": { + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "Iops": { + "locationName": "iops", + "type": "integer" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "SnapshotId": { + "locationName": "snapshotId" + }, + "VolumeSize": { + "locationName": "volumeSize", + "type": "integer" + }, + "VolumeType": { + "locationName": "volumeType" + } + } + }, + "NoDevice": { + "locationName": "noDevice" + } + } + } + }, + "NetworkInterfaces": { + "locationName": "networkInterfaceSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "locationName": "associatePublicIpAddress", + "type": "boolean" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "Description": { + "locationName": "description" + }, + "DeviceIndex": { + "locationName": "deviceIndex", + "type": "integer" + }, + "Groups": { + "shape": "S2i", + "locationName": "groupSet" + }, + "InterfaceType": { + "locationName": "interfaceType" + }, + "Ipv6AddressCount": { + "locationName": "ipv6AddressCount", + "type": "integer" + }, + "Ipv6Addresses": { + "shape": "S9a", + "locationName": "ipv6AddressesSet" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "PrivateIpAddresses": { + "shape": "S89", + "locationName": "privateIpAddressesSet" + }, + "SecondaryPrivateIpAddressCount": { + "locationName": "secondaryPrivateIpAddressCount", + "type": "integer" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + } + }, + "ImageId": { + "locationName": "imageId" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "KeyName": { + "locationName": "keyName" + }, + "Monitoring": { + "locationName": "monitoring", + "type": "structure", + "members": { + "Enabled": { + "locationName": "enabled", + "type": "boolean" + } + } + }, + "Placement": { + "locationName": "placement", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Affinity": { + "locationName": "affinity" + }, + "GroupName": { + "locationName": "groupName" + }, + "HostId": { + "locationName": "hostId" + }, + "Tenancy": { + "locationName": "tenancy" + }, + "SpreadDomain": { + "locationName": "spreadDomain" + } + } + }, + "RamDiskId": { + "locationName": "ramDiskId" + }, + "DisableApiTermination": { + "locationName": "disableApiTermination", + "type": "boolean" + }, + "InstanceInitiatedShutdownBehavior": { + "locationName": "instanceInitiatedShutdownBehavior" + }, + "UserData": { + "locationName": "userData" + }, + "TagSpecifications": { + "locationName": "tagSpecificationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ResourceType": { + "locationName": "resourceType" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + } + }, + "ElasticGpuSpecifications": { + "locationName": "elasticGpuSpecificationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Type": { + "locationName": "type" + } + } + } + }, + "ElasticInferenceAccelerators": { + "locationName": "elasticInferenceAcceleratorSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Type": { + "locationName": "type" + } + } + } + }, + "SecurityGroupIds": { + "shape": "Sd", + "locationName": "securityGroupIdSet" + }, + "SecurityGroups": { + "shape": "Sd", + "locationName": "securityGroupSet" + }, + "InstanceMarketOptions": { + "locationName": "instanceMarketOptions", + "type": "structure", + "members": { + "MarketType": { + "locationName": "marketType" + }, + "SpotOptions": { + "locationName": "spotOptions", + "type": "structure", + "members": { + "MaxPrice": { + "locationName": "maxPrice" + }, + "SpotInstanceType": { + "locationName": "spotInstanceType" + }, + "BlockDurationMinutes": { + "locationName": "blockDurationMinutes", + "type": "integer" + }, + "ValidUntil": { + "locationName": "validUntil", + "type": "timestamp" + }, + "InstanceInterruptionBehavior": { + "locationName": "instanceInterruptionBehavior" + } + } + } + } + }, + "CreditSpecification": { + "locationName": "creditSpecification", + "type": "structure", + "members": { + "CpuCredits": { + "locationName": "cpuCredits" + } + } + }, + "CpuOptions": { + "locationName": "cpuOptions", + "type": "structure", + "members": { + "CoreCount": { + "locationName": "coreCount", + "type": "integer" + }, + "ThreadsPerCore": { + "locationName": "threadsPerCore", + "type": "integer" + } + } + }, + "CapacityReservationSpecification": { + "locationName": "capacityReservationSpecification", + "type": "structure", + "members": { + "CapacityReservationPreference": { + "locationName": "capacityReservationPreference" + }, + "CapacityReservationTarget": { + "shape": "S9p", + "locationName": "capacityReservationTarget" + } + } + }, + "LicenseSpecifications": { + "locationName": "licenseSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "locationName": "licenseConfigurationArn" + } + } + } + }, + "HibernationOptions": { + "locationName": "hibernationOptions", + "type": "structure", + "members": { + "Configured": { + "locationName": "configured", + "type": "boolean" + } + } + } + } + }, + "S9a": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Ipv6Address": { + "locationName": "ipv6Address" + } + } + } + }, + "S9p": { + "type": "structure", + "members": { + "CapacityReservationId": { + "locationName": "capacityReservationId" + } + } + }, + "S9v": { + "type": "structure", + "members": { + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "DeleteTime": { + "locationName": "deleteTime", + "type": "timestamp" + }, + "FailureCode": { + "locationName": "failureCode" + }, + "FailureMessage": { + "locationName": "failureMessage" + }, + "NatGatewayAddresses": { + "locationName": "natGatewayAddressSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AllocationId": { + "locationName": "allocationId" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "PrivateIp": { + "locationName": "privateIp" + }, + "PublicIp": { + "locationName": "publicIp" + } + } + } + }, + "NatGatewayId": { + "locationName": "natGatewayId" + }, + "ProvisionedBandwidth": { + "locationName": "provisionedBandwidth", + "type": "structure", + "members": { + "ProvisionTime": { + "locationName": "provisionTime", + "type": "timestamp" + }, + "Provisioned": { + "locationName": "provisioned" + }, + "RequestTime": { + "locationName": "requestTime", + "type": "timestamp" + }, + "Requested": { + "locationName": "requested" + }, + "Status": { + "locationName": "status" + } + } + }, + "State": { + "locationName": "state" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "Sa2": { + "type": "structure", + "members": { + "Associations": { + "locationName": "associationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "NetworkAclAssociationId": { + "locationName": "networkAclAssociationId" + }, + "NetworkAclId": { + "locationName": "networkAclId" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + } + }, + "Entries": { + "locationName": "entrySet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CidrBlock": { + "locationName": "cidrBlock" + }, + "Egress": { + "locationName": "egress", + "type": "boolean" + }, + "IcmpTypeCode": { + "shape": "Sa7", + "locationName": "icmpTypeCode" + }, + "Ipv6CidrBlock": { + "locationName": "ipv6CidrBlock" + }, + "PortRange": { + "shape": "Sa8", + "locationName": "portRange" + }, + "Protocol": { + "locationName": "protocol" + }, + "RuleAction": { + "locationName": "ruleAction" + }, + "RuleNumber": { + "locationName": "ruleNumber", + "type": "integer" + } + } + } + }, + "IsDefault": { + "locationName": "default", + "type": "boolean" + }, + "NetworkAclId": { + "locationName": "networkAclId" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VpcId": { + "locationName": "vpcId" + }, + "OwnerId": { + "locationName": "ownerId" + } + } + }, + "Sa7": { + "type": "structure", + "members": { + "Code": { + "locationName": "code", + "type": "integer" + }, + "Type": { + "locationName": "type", + "type": "integer" + } + } + }, + "Sa8": { + "type": "structure", + "members": { + "From": { + "locationName": "from", + "type": "integer" + }, + "To": { + "locationName": "to", + "type": "integer" + } + } + }, + "Sae": { + "type": "structure", + "members": { + "Association": { + "shape": "Saf", + "locationName": "association" + }, + "Attachment": { + "shape": "Sag", + "locationName": "attachment" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Description": { + "locationName": "description" + }, + "Groups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "InterfaceType": { + "locationName": "interfaceType" + }, + "Ipv6Addresses": { + "locationName": "ipv6AddressesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Ipv6Address": { + "locationName": "ipv6Address" + } + } + } + }, + "MacAddress": { + "locationName": "macAddress" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "PrivateIpAddresses": { + "locationName": "privateIpAddressesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Association": { + "shape": "Saf", + "locationName": "association" + }, + "Primary": { + "locationName": "primary", + "type": "boolean" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + } + } + } + }, + "RequesterId": { + "locationName": "requesterId" + }, + "RequesterManaged": { + "locationName": "requesterManaged", + "type": "boolean" + }, + "SourceDestCheck": { + "locationName": "sourceDestCheck", + "type": "boolean" + }, + "Status": { + "locationName": "status" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "TagSet": { + "shape": "Si", + "locationName": "tagSet" + }, + "VpcId": { + "locationName": "vpcId" + } + } + }, + "Saf": { + "type": "structure", + "members": { + "AllocationId": { + "locationName": "allocationId" + }, + "AssociationId": { + "locationName": "associationId" + }, + "IpOwnerId": { + "locationName": "ipOwnerId" + }, + "PublicDnsName": { + "locationName": "publicDnsName" + }, + "PublicIp": { + "locationName": "publicIp" + } + } + }, + "Sag": { + "type": "structure", + "members": { + "AttachTime": { + "locationName": "attachTime", + "type": "timestamp" + }, + "AttachmentId": { + "locationName": "attachmentId" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "DeviceIndex": { + "locationName": "deviceIndex", + "type": "integer" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "locationName": "instanceOwnerId" + }, + "Status": { + "locationName": "status" + } + } + }, + "Sah": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "GroupName": { + "locationName": "groupName" + }, + "GroupId": { + "locationName": "groupId" + } + } + } + }, + "Sas": { + "type": "structure", + "members": { + "NetworkInterfacePermissionId": { + "locationName": "networkInterfacePermissionId" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "AwsAccountId": { + "locationName": "awsAccountId" + }, + "AwsService": { + "locationName": "awsService" + }, + "Permission": { + "locationName": "permission" + }, + "PermissionState": { + "locationName": "permissionState", + "type": "structure", + "members": { + "State": { + "locationName": "state" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + } + } + }, + "Sb5": { + "type": "structure", + "members": { + "Associations": { + "locationName": "associationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Main": { + "locationName": "main", + "type": "boolean" + }, + "RouteTableAssociationId": { + "locationName": "routeTableAssociationId" + }, + "RouteTableId": { + "locationName": "routeTableId" + }, + "SubnetId": { + "locationName": "subnetId" + } + } + } + }, + "PropagatingVgws": { + "locationName": "propagatingVgwSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "GatewayId": { + "locationName": "gatewayId" + } + } + } + }, + "RouteTableId": { + "locationName": "routeTableId" + }, + "Routes": { + "locationName": "routeSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "DestinationCidrBlock": { + "locationName": "destinationCidrBlock" + }, + "DestinationIpv6CidrBlock": { + "locationName": "destinationIpv6CidrBlock" + }, + "DestinationPrefixListId": { + "locationName": "destinationPrefixListId" + }, + "EgressOnlyInternetGatewayId": { + "locationName": "egressOnlyInternetGatewayId" + }, + "GatewayId": { + "locationName": "gatewayId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "locationName": "instanceOwnerId" + }, + "NatGatewayId": { + "locationName": "natGatewayId" + }, + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "Origin": { + "locationName": "origin" + }, + "State": { + "locationName": "state" + }, + "VpcPeeringConnectionId": { + "locationName": "vpcPeeringConnectionId" + } + } + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VpcId": { + "locationName": "vpcId" + }, + "OwnerId": { + "locationName": "ownerId" + } + } + }, + "Sbh": { + "type": "structure", + "members": { + "DataEncryptionKeyId": { + "locationName": "dataEncryptionKeyId" + }, + "Description": { + "locationName": "description" + }, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "Progress": { + "locationName": "progress" + }, + "SnapshotId": { + "locationName": "snapshotId" + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + }, + "State": { + "locationName": "status" + }, + "StateMessage": { + "locationName": "statusMessage" + }, + "VolumeId": { + "locationName": "volumeId" + }, + "VolumeSize": { + "locationName": "volumeSize", + "type": "integer" + }, + "OwnerAlias": { + "locationName": "ownerAlias" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "Sbl": { + "type": "structure", + "members": { + "Bucket": { + "locationName": "bucket" + }, + "Fault": { + "shape": "Sbm", + "locationName": "fault" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "Prefix": { + "locationName": "prefix" + }, + "State": { + "locationName": "state" + } + } + }, + "Sbm": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "Sbr": { + "type": "list", + "member": {} + }, + "Sbz": { + "type": "structure", + "members": { + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "TransitGatewayArn": { + "locationName": "transitGatewayArn" + }, + "State": { + "locationName": "state" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "Description": { + "locationName": "description" + }, + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp" + }, + "Options": { + "locationName": "options", + "type": "structure", + "members": { + "AmazonSideAsn": { + "locationName": "amazonSideAsn", + "type": "long" + }, + "AutoAcceptSharedAttachments": { + "locationName": "autoAcceptSharedAttachments" + }, + "DefaultRouteTableAssociation": { + "locationName": "defaultRouteTableAssociation" + }, + "AssociationDefaultRouteTableId": { + "locationName": "associationDefaultRouteTableId" + }, + "DefaultRouteTablePropagation": { + "locationName": "defaultRouteTablePropagation" + }, + "PropagationDefaultRouteTableId": { + "locationName": "propagationDefaultRouteTableId" + }, + "VpnEcmpSupport": { + "locationName": "vpnEcmpSupport" + }, + "DnsSupport": { + "locationName": "dnsSupport" + } + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "Sc4": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "locationName": "destinationCidrBlock" + }, + "TransitGatewayAttachments": { + "locationName": "transitGatewayAttachments", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ResourceId": { + "locationName": "resourceId" + }, + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "ResourceType": { + "locationName": "resourceType" + } + } + } + }, + "Type": { + "locationName": "type" + }, + "State": { + "locationName": "state" + } + } + }, + "Scb": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "locationName": "transitGatewayRouteTableId" + }, + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "State": { + "locationName": "state" + }, + "DefaultAssociationRouteTable": { + "locationName": "defaultAssociationRouteTable", + "type": "boolean" + }, + "DefaultPropagationRouteTable": { + "locationName": "defaultPropagationRouteTable", + "type": "boolean" + }, + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "Sch": { + "type": "structure", + "members": { + "Attachments": { + "locationName": "attachmentSet", + "type": "list", + "member": { + "shape": "S2o", + "locationName": "item" + } + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "Size": { + "locationName": "size", + "type": "integer" + }, + "SnapshotId": { + "locationName": "snapshotId" + }, + "State": { + "locationName": "status" + }, + "VolumeId": { + "locationName": "volumeId" + }, + "Iops": { + "locationName": "iops", + "type": "integer" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VolumeType": { + "locationName": "volumeType" + } + } + }, + "Scp": { + "type": "structure", + "members": { + "VpcEndpointId": { + "locationName": "vpcEndpointId" + }, + "VpcEndpointType": { + "locationName": "vpcEndpointType" + }, + "VpcId": { + "locationName": "vpcId" + }, + "ServiceName": { + "locationName": "serviceName" + }, + "State": { + "locationName": "state" + }, + "PolicyDocument": { + "locationName": "policyDocument" + }, + "RouteTableIds": { + "shape": "Sd", + "locationName": "routeTableIdSet" + }, + "SubnetIds": { + "shape": "Sd", + "locationName": "subnetIdSet" + }, + "Groups": { + "locationName": "groupSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "GroupId": { + "locationName": "groupId" + }, + "GroupName": { + "locationName": "groupName" + } + } + } + }, + "PrivateDnsEnabled": { + "locationName": "privateDnsEnabled", + "type": "boolean" + }, + "RequesterManaged": { + "locationName": "requesterManaged", + "type": "boolean" + }, + "NetworkInterfaceIds": { + "shape": "Sd", + "locationName": "networkInterfaceIdSet" + }, + "DnsEntries": { + "locationName": "dnsEntrySet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "DnsName": { + "locationName": "dnsName" + }, + "HostedZoneId": { + "locationName": "hostedZoneId" + } + } + } + }, + "CreationTimestamp": { + "locationName": "creationTimestamp", + "type": "timestamp" + } + } + }, + "Scy": { + "type": "structure", + "members": { + "ConnectionNotificationId": { + "locationName": "connectionNotificationId" + }, + "ServiceId": { + "locationName": "serviceId" + }, + "VpcEndpointId": { + "locationName": "vpcEndpointId" + }, + "ConnectionNotificationType": { + "locationName": "connectionNotificationType" + }, + "ConnectionNotificationArn": { + "locationName": "connectionNotificationArn" + }, + "ConnectionEvents": { + "shape": "Sd", + "locationName": "connectionEvents" + }, + "ConnectionNotificationState": { + "locationName": "connectionNotificationState" + } + } + }, + "Sd3": { + "type": "structure", + "members": { + "ServiceType": { + "shape": "Sd4", + "locationName": "serviceType" + }, + "ServiceId": { + "locationName": "serviceId" + }, + "ServiceName": { + "locationName": "serviceName" + }, + "ServiceState": { + "locationName": "serviceState" + }, + "AvailabilityZones": { + "shape": "Sd", + "locationName": "availabilityZoneSet" + }, + "AcceptanceRequired": { + "locationName": "acceptanceRequired", + "type": "boolean" + }, + "ManagesVpcEndpoints": { + "locationName": "managesVpcEndpoints", + "type": "boolean" + }, + "NetworkLoadBalancerArns": { + "shape": "Sd", + "locationName": "networkLoadBalancerArnSet" + }, + "BaseEndpointDnsNames": { + "shape": "Sd", + "locationName": "baseEndpointDnsNameSet" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + } + } + }, + "Sd4": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ServiceType": { + "locationName": "serviceType" + } + } + } + }, + "Sdf": { + "type": "structure", + "members": { + "CustomerGatewayConfiguration": { + "locationName": "customerGatewayConfiguration" + }, + "CustomerGatewayId": { + "locationName": "customerGatewayId" + }, + "Category": { + "locationName": "category" + }, + "State": { + "locationName": "state" + }, + "Type": { + "locationName": "type" + }, + "VpnConnectionId": { + "locationName": "vpnConnectionId" + }, + "VpnGatewayId": { + "locationName": "vpnGatewayId" + }, + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "Options": { + "locationName": "options", + "type": "structure", + "members": { + "StaticRoutesOnly": { + "locationName": "staticRoutesOnly", + "type": "boolean" + } + } + }, + "Routes": { + "locationName": "routes", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "DestinationCidrBlock": { + "locationName": "destinationCidrBlock" + }, + "Source": { + "locationName": "source" + }, + "State": { + "locationName": "state" + } + } + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VgwTelemetry": { + "locationName": "vgwTelemetry", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AcceptedRouteCount": { + "locationName": "acceptedRouteCount", + "type": "integer" + }, + "LastStatusChange": { + "locationName": "lastStatusChange", + "type": "timestamp" + }, + "OutsideIpAddress": { + "locationName": "outsideIpAddress" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + } + } + } + }, + "Sdr": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "State": { + "locationName": "state" + }, + "Type": { + "locationName": "type" + }, + "VpcAttachments": { + "locationName": "attachments", + "type": "list", + "member": { + "shape": "S2s", + "locationName": "item" + } + }, + "VpnGatewayId": { + "locationName": "vpnGatewayId" + }, + "AmazonSideAsn": { + "locationName": "amazonSideAsn", + "type": "long" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "Se2": { + "type": "list", + "member": {} + }, + "Sek": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Sg4": { + "type": "list", + "member": { + "locationName": "Filter", + "type": "structure", + "members": { + "Name": {}, + "Values": { + "shape": "Sd", + "locationName": "Value" + } + } + } + }, + "Sgd": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Deadline": { + "locationName": "deadline", + "type": "timestamp" + }, + "Resource": { + "locationName": "resource" + }, + "UseLongIds": { + "locationName": "useLongIds", + "type": "boolean" + } + } + } + }, + "Sh2": { + "type": "list", + "member": { + "locationName": "InstanceId" + } + }, + "She": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "Si5": { + "type": "structure", + "members": { + "ConversionTaskId": { + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "locationName": "expirationTime" + }, + "ImportInstance": { + "locationName": "importInstance", + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "Platform": { + "locationName": "platform" + }, + "Volumes": { + "locationName": "volumes", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "BytesConverted": { + "locationName": "bytesConverted", + "type": "long" + }, + "Description": { + "locationName": "description" + }, + "Image": { + "shape": "Si9", + "locationName": "image" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "Volume": { + "shape": "Sia", + "locationName": "volume" + } + } + } + } + } + }, + "ImportVolume": { + "locationName": "importVolume", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "BytesConverted": { + "locationName": "bytesConverted", + "type": "long" + }, + "Description": { + "locationName": "description" + }, + "Image": { + "shape": "Si9", + "locationName": "image" + }, + "Volume": { + "shape": "Sia", + "locationName": "volume" + } + } + }, + "State": { + "locationName": "state" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + } + } + }, + "Si9": { + "type": "structure", + "members": { + "Checksum": { + "locationName": "checksum" + }, + "Format": { + "locationName": "format" + }, + "ImportManifestUrl": { + "locationName": "importManifestUrl" + }, + "Size": { + "locationName": "size", + "type": "long" + } + } + }, + "Sia": { + "type": "structure", + "members": { + "Id": { + "locationName": "id" + }, + "Size": { + "locationName": "size", + "type": "long" + } + } + }, + "Sj6": { + "type": "structure", + "members": { + "EventDescription": { + "locationName": "eventDescription" + }, + "EventSubType": { + "locationName": "eventSubType" + }, + "InstanceId": { + "locationName": "instanceId" + } + } + }, + "Sj9": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "SpotInstanceRequestId": { + "locationName": "spotInstanceRequestId" + }, + "InstanceHealth": { + "locationName": "instanceHealth" + } + } + } + }, + "Sjy": { + "type": "structure", + "members": { + "FpgaImageId": { + "locationName": "fpgaImageId" + }, + "Name": { + "locationName": "name" + }, + "Description": { + "locationName": "description" + }, + "LoadPermissions": { + "locationName": "loadPermissions", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "UserId": { + "locationName": "userId" + }, + "Group": { + "locationName": "group" + } + } + } + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + } + } + }, + "Sk2": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ProductCodeId": { + "locationName": "productCode" + }, + "ProductCodeType": { + "locationName": "type" + } + } + } + }, + "Sk7": { + "type": "list", + "member": { + "locationName": "Owner" + } + }, + "Skp": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Sks": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Sle": { + "type": "list", + "member": { + "shape": "S7e", + "locationName": "item" + } + }, + "Slf": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Group": { + "locationName": "group" + }, + "UserId": { + "locationName": "userId" + } + } + } + }, + "Sls": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "Slv": { + "type": "list", + "member": { + "locationName": "ImportTaskId" + } + }, + "Slz": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "DeviceName": { + "locationName": "deviceName" + }, + "DiskImageSize": { + "locationName": "diskImageSize", + "type": "double" + }, + "Format": { + "locationName": "format" + }, + "Progress": { + "locationName": "progress" + }, + "SnapshotId": { + "locationName": "snapshotId" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "Url": { + "locationName": "url" + }, + "UserBucket": { + "shape": "Sm1", + "locationName": "userBucket" + } + } + } + }, + "Sm1": { + "type": "structure", + "members": { + "S3Bucket": { + "locationName": "s3Bucket" + }, + "S3Key": { + "locationName": "s3Key" + } + } + }, + "Sm6": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "DiskImageSize": { + "locationName": "diskImageSize", + "type": "double" + }, + "Encrypted": { + "locationName": "encrypted", + "type": "boolean" + }, + "Format": { + "locationName": "format" + }, + "KmsKeyId": { + "locationName": "kmsKeyId" + }, + "Progress": { + "locationName": "progress" + }, + "SnapshotId": { + "locationName": "snapshotId" + }, + "Status": { + "locationName": "status" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "Url": { + "locationName": "url" + }, + "UserBucket": { + "shape": "Sm1", + "locationName": "userBucket" + } + } + }, + "Sma": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "DeviceName": { + "locationName": "deviceName" + }, + "Ebs": { + "locationName": "ebs", + "type": "structure", + "members": { + "AttachTime": { + "locationName": "attachTime", + "type": "timestamp" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "Status": { + "locationName": "status" + }, + "VolumeId": { + "locationName": "volumeId" + } + } + } + } + } + }, + "Smd": { + "type": "structure", + "members": { + "Value": { + "locationName": "value", + "type": "boolean" + } + } + }, + "Smo": { + "type": "structure", + "members": { + "InstanceEventId": { + "locationName": "instanceEventId" + }, + "Code": { + "locationName": "code" + }, + "Description": { + "locationName": "description" + }, + "NotAfter": { + "locationName": "notAfter", + "type": "timestamp" + }, + "NotBefore": { + "locationName": "notBefore", + "type": "timestamp" + }, + "NotBeforeDeadline": { + "locationName": "notBeforeDeadline", + "type": "timestamp" + } + } + }, + "Smr": { + "type": "structure", + "members": { + "Code": { + "locationName": "code", + "type": "integer" + }, + "Name": { + "locationName": "name" + } + } + }, + "Smt": { + "type": "structure", + "members": { + "Details": { + "locationName": "details", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ImpairedSince": { + "locationName": "impairedSince", + "type": "timestamp" + }, + "Name": { + "locationName": "name" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "Status": { + "locationName": "status" + } + } + }, + "Sn2": { + "type": "structure", + "members": { + "Groups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "Instances": { + "locationName": "instancesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AmiLaunchIndex": { + "locationName": "amiLaunchIndex", + "type": "integer" + }, + "ImageId": { + "locationName": "imageId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "KernelId": { + "locationName": "kernelId" + }, + "KeyName": { + "locationName": "keyName" + }, + "LaunchTime": { + "locationName": "launchTime", + "type": "timestamp" + }, + "Monitoring": { + "shape": "Sn5", + "locationName": "monitoring" + }, + "Placement": { + "shape": "S6m", + "locationName": "placement" + }, + "Platform": { + "locationName": "platform" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "ProductCodes": { + "shape": "Sk2", + "locationName": "productCodes" + }, + "PublicDnsName": { + "locationName": "dnsName" + }, + "PublicIpAddress": { + "locationName": "ipAddress" + }, + "RamdiskId": { + "locationName": "ramdiskId" + }, + "State": { + "shape": "Smr", + "locationName": "instanceState" + }, + "StateTransitionReason": { + "locationName": "reason" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "Architecture": { + "locationName": "architecture" + }, + "BlockDeviceMappings": { + "shape": "Sma", + "locationName": "blockDeviceMapping" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "EbsOptimized": { + "locationName": "ebsOptimized", + "type": "boolean" + }, + "EnaSupport": { + "locationName": "enaSupport", + "type": "boolean" + }, + "Hypervisor": { + "locationName": "hypervisor" + }, + "IamInstanceProfile": { + "shape": "S1x", + "locationName": "iamInstanceProfile" + }, + "InstanceLifecycle": { + "locationName": "instanceLifecycle" + }, + "ElasticGpuAssociations": { + "locationName": "elasticGpuAssociationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ElasticGpuId": { + "locationName": "elasticGpuId" + }, + "ElasticGpuAssociationId": { + "locationName": "elasticGpuAssociationId" + }, + "ElasticGpuAssociationState": { + "locationName": "elasticGpuAssociationState" + }, + "ElasticGpuAssociationTime": { + "locationName": "elasticGpuAssociationTime" + } + } + } + }, + "ElasticInferenceAcceleratorAssociations": { + "locationName": "elasticInferenceAcceleratorAssociationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ElasticInferenceAcceleratorArn": { + "locationName": "elasticInferenceAcceleratorArn" + }, + "ElasticInferenceAcceleratorAssociationId": { + "locationName": "elasticInferenceAcceleratorAssociationId" + }, + "ElasticInferenceAcceleratorAssociationState": { + "locationName": "elasticInferenceAcceleratorAssociationState" + }, + "ElasticInferenceAcceleratorAssociationTime": { + "locationName": "elasticInferenceAcceleratorAssociationTime", + "type": "timestamp" + } + } + } + }, + "NetworkInterfaces": { + "locationName": "networkInterfaceSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Association": { + "shape": "Sne", + "locationName": "association" + }, + "Attachment": { + "locationName": "attachment", + "type": "structure", + "members": { + "AttachTime": { + "locationName": "attachTime", + "type": "timestamp" + }, + "AttachmentId": { + "locationName": "attachmentId" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "DeviceIndex": { + "locationName": "deviceIndex", + "type": "integer" + }, + "Status": { + "locationName": "status" + } + } + }, + "Description": { + "locationName": "description" + }, + "Groups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "Ipv6Addresses": { + "shape": "S9a", + "locationName": "ipv6AddressesSet" + }, + "MacAddress": { + "locationName": "macAddress" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "PrivateIpAddresses": { + "locationName": "privateIpAddressesSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Association": { + "shape": "Sne", + "locationName": "association" + }, + "Primary": { + "locationName": "primary", + "type": "boolean" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + } + } + } + }, + "SourceDestCheck": { + "locationName": "sourceDestCheck", + "type": "boolean" + }, + "Status": { + "locationName": "status" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "InterfaceType": { + "locationName": "interfaceType" + } + } + } + }, + "RootDeviceName": { + "locationName": "rootDeviceName" + }, + "RootDeviceType": { + "locationName": "rootDeviceType" + }, + "SecurityGroups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "SourceDestCheck": { + "locationName": "sourceDestCheck", + "type": "boolean" + }, + "SpotInstanceRequestId": { + "locationName": "spotInstanceRequestId" + }, + "SriovNetSupport": { + "locationName": "sriovNetSupport" + }, + "StateReason": { + "shape": "Sls", + "locationName": "stateReason" + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "VirtualizationType": { + "locationName": "virtualizationType" + }, + "CpuOptions": { + "locationName": "cpuOptions", + "type": "structure", + "members": { + "CoreCount": { + "locationName": "coreCount", + "type": "integer" + }, + "ThreadsPerCore": { + "locationName": "threadsPerCore", + "type": "integer" + } + } + }, + "CapacityReservationId": { + "locationName": "capacityReservationId" + }, + "CapacityReservationSpecification": { + "locationName": "capacityReservationSpecification", + "type": "structure", + "members": { + "CapacityReservationPreference": { + "locationName": "capacityReservationPreference" + }, + "CapacityReservationTarget": { + "shape": "S9p", + "locationName": "capacityReservationTarget" + } + } + }, + "HibernationOptions": { + "locationName": "hibernationOptions", + "type": "structure", + "members": { + "Configured": { + "locationName": "configured", + "type": "boolean" + } + } + }, + "Licenses": { + "locationName": "licenseSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "locationName": "licenseConfigurationArn" + } + } + } + } + } + } + }, + "OwnerId": { + "locationName": "ownerId" + }, + "RequesterId": { + "locationName": "requesterId" + }, + "ReservationId": { + "locationName": "reservationId" + } + } + }, + "Sn5": { + "type": "structure", + "members": { + "State": { + "locationName": "state" + } + } + }, + "Sne": { + "type": "structure", + "members": { + "IpOwnerId": { + "locationName": "ipOwnerId" + }, + "PublicDnsName": { + "locationName": "publicDnsName" + }, + "PublicIp": { + "locationName": "publicIp" + } + } + }, + "Spj": { + "type": "list", + "member": { + "locationName": "ReservedInstancesId" + } + }, + "Spr": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Amount": { + "locationName": "amount", + "type": "double" + }, + "Frequency": { + "locationName": "frequency" + } + } + } + }, + "Sq4": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "InstanceCount": { + "locationName": "instanceCount", + "type": "integer" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "Platform": { + "locationName": "platform" + }, + "Scope": { + "locationName": "scope" + } + } + }, + "Sqo": { + "type": "structure", + "members": { + "Frequency": { + "locationName": "frequency" + }, + "Interval": { + "locationName": "interval", + "type": "integer" + }, + "OccurrenceDaySet": { + "locationName": "occurrenceDaySet", + "type": "list", + "member": { + "locationName": "item", + "type": "integer" + } + }, + "OccurrenceRelativeToEnd": { + "locationName": "occurrenceRelativeToEnd", + "type": "boolean" + }, + "OccurrenceUnit": { + "locationName": "occurrenceUnit" + } + } + }, + "Sqv": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "CreateDate": { + "locationName": "createDate", + "type": "timestamp" + }, + "HourlyPrice": { + "locationName": "hourlyPrice" + }, + "InstanceCount": { + "locationName": "instanceCount", + "type": "integer" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "NetworkPlatform": { + "locationName": "networkPlatform" + }, + "NextSlotStartTime": { + "locationName": "nextSlotStartTime", + "type": "timestamp" + }, + "Platform": { + "locationName": "platform" + }, + "PreviousSlotEndTime": { + "locationName": "previousSlotEndTime", + "type": "timestamp" + }, + "Recurrence": { + "shape": "Sqo", + "locationName": "recurrence" + }, + "ScheduledInstanceId": { + "locationName": "scheduledInstanceId" + }, + "SlotDurationInHours": { + "locationName": "slotDurationInHours", + "type": "integer" + }, + "TermEndDate": { + "locationName": "termEndDate", + "type": "timestamp" + }, + "TermStartDate": { + "locationName": "termStartDate", + "type": "timestamp" + }, + "TotalScheduledInstanceHours": { + "locationName": "totalScheduledInstanceHours", + "type": "integer" + } + } + }, + "Sr2": { + "type": "list", + "member": { + "locationName": "GroupName" + } + }, + "Sr9": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Group": { + "locationName": "group" + }, + "UserId": { + "locationName": "userId" + } + } + } + }, + "Sru": { + "type": "structure", + "required": [ + "IamFleetRole", + "TargetCapacity" + ], + "members": { + "AllocationStrategy": { + "locationName": "allocationStrategy" + }, + "OnDemandAllocationStrategy": { + "locationName": "onDemandAllocationStrategy" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "ExcessCapacityTerminationPolicy": { + "locationName": "excessCapacityTerminationPolicy" + }, + "FulfilledCapacity": { + "locationName": "fulfilledCapacity", + "type": "double" + }, + "OnDemandFulfilledCapacity": { + "locationName": "onDemandFulfilledCapacity", + "type": "double" + }, + "IamFleetRole": { + "locationName": "iamFleetRole" + }, + "LaunchSpecifications": { + "locationName": "launchSpecifications", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "SecurityGroups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "AddressingType": { + "locationName": "addressingType" + }, + "BlockDeviceMappings": { + "shape": "Sle", + "locationName": "blockDeviceMapping" + }, + "EbsOptimized": { + "locationName": "ebsOptimized", + "type": "boolean" + }, + "IamInstanceProfile": { + "shape": "S1u", + "locationName": "iamInstanceProfile" + }, + "ImageId": { + "locationName": "imageId" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "KernelId": { + "locationName": "kernelId" + }, + "KeyName": { + "locationName": "keyName" + }, + "Monitoring": { + "locationName": "monitoring", + "type": "structure", + "members": { + "Enabled": { + "locationName": "enabled", + "type": "boolean" + } + } + }, + "NetworkInterfaces": { + "shape": "Ss1", + "locationName": "networkInterfaceSet" + }, + "Placement": { + "shape": "Ss3", + "locationName": "placement" + }, + "RamdiskId": { + "locationName": "ramdiskId" + }, + "SpotPrice": { + "locationName": "spotPrice" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "UserData": { + "locationName": "userData" + }, + "WeightedCapacity": { + "locationName": "weightedCapacity", + "type": "double" + }, + "TagSpecifications": { + "locationName": "tagSpecificationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ResourceType": { + "locationName": "resourceType" + }, + "Tags": { + "shape": "Si", + "locationName": "tag" + } + } + } + } + } + } + }, + "LaunchTemplateConfigs": { + "locationName": "launchTemplateConfigs", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "shape": "S6v", + "locationName": "launchTemplateSpecification" + }, + "Overrides": { + "locationName": "overrides", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceType": { + "locationName": "instanceType" + }, + "SpotPrice": { + "locationName": "spotPrice" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "WeightedCapacity": { + "locationName": "weightedCapacity", + "type": "double" + }, + "Priority": { + "locationName": "priority", + "type": "double" + } + } + } + } + } + } + }, + "SpotPrice": { + "locationName": "spotPrice" + }, + "TargetCapacity": { + "locationName": "targetCapacity", + "type": "integer" + }, + "OnDemandTargetCapacity": { + "locationName": "onDemandTargetCapacity", + "type": "integer" + }, + "TerminateInstancesWithExpiration": { + "locationName": "terminateInstancesWithExpiration", + "type": "boolean" + }, + "Type": { + "locationName": "type" + }, + "ValidFrom": { + "locationName": "validFrom", + "type": "timestamp" + }, + "ValidUntil": { + "locationName": "validUntil", + "type": "timestamp" + }, + "ReplaceUnhealthyInstances": { + "locationName": "replaceUnhealthyInstances", + "type": "boolean" + }, + "InstanceInterruptionBehavior": { + "locationName": "instanceInterruptionBehavior" + }, + "LoadBalancersConfig": { + "locationName": "loadBalancersConfig", + "type": "structure", + "members": { + "ClassicLoadBalancersConfig": { + "locationName": "classicLoadBalancersConfig", + "type": "structure", + "members": { + "ClassicLoadBalancers": { + "locationName": "classicLoadBalancers", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Name": { + "locationName": "name" + } + } + } + } + } + }, + "TargetGroupsConfig": { + "locationName": "targetGroupsConfig", + "type": "structure", + "members": { + "TargetGroups": { + "locationName": "targetGroups", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + } + } + } + } + } + } + } + }, + "InstancePoolsToUseCount": { + "locationName": "instancePoolsToUseCount", + "type": "integer" + } + } + }, + "Ss1": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "locationName": "associatePublicIpAddress", + "type": "boolean" + }, + "DeleteOnTermination": { + "locationName": "deleteOnTermination", + "type": "boolean" + }, + "Description": { + "locationName": "description" + }, + "DeviceIndex": { + "locationName": "deviceIndex", + "type": "integer" + }, + "Groups": { + "shape": "S86", + "locationName": "SecurityGroupId" + }, + "Ipv6AddressCount": { + "locationName": "ipv6AddressCount", + "type": "integer" + }, + "Ipv6Addresses": { + "shape": "S9a", + "locationName": "ipv6AddressesSet", + "queryName": "Ipv6Addresses" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "PrivateIpAddresses": { + "shape": "S89", + "locationName": "privateIpAddressesSet", + "queryName": "PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount": { + "locationName": "secondaryPrivateIpAddressCount", + "type": "integer" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "InterfaceType": {} + } + } + }, + "Ss3": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "GroupName": { + "locationName": "groupName" + }, + "Tenancy": { + "locationName": "tenancy" + } + } + }, + "Ssj": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "ActualBlockHourlyPrice": { + "locationName": "actualBlockHourlyPrice" + }, + "AvailabilityZoneGroup": { + "locationName": "availabilityZoneGroup" + }, + "BlockDurationMinutes": { + "locationName": "blockDurationMinutes", + "type": "integer" + }, + "CreateTime": { + "locationName": "createTime", + "type": "timestamp" + }, + "Fault": { + "shape": "Sbm", + "locationName": "fault" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "LaunchGroup": { + "locationName": "launchGroup" + }, + "LaunchSpecification": { + "locationName": "launchSpecification", + "type": "structure", + "members": { + "UserData": { + "locationName": "userData" + }, + "SecurityGroups": { + "shape": "Sah", + "locationName": "groupSet" + }, + "AddressingType": { + "locationName": "addressingType" + }, + "BlockDeviceMappings": { + "shape": "Sle", + "locationName": "blockDeviceMapping" + }, + "EbsOptimized": { + "locationName": "ebsOptimized", + "type": "boolean" + }, + "IamInstanceProfile": { + "shape": "S1u", + "locationName": "iamInstanceProfile" + }, + "ImageId": { + "locationName": "imageId" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "KernelId": { + "locationName": "kernelId" + }, + "KeyName": { + "locationName": "keyName" + }, + "NetworkInterfaces": { + "shape": "Ss1", + "locationName": "networkInterfaceSet" + }, + "Placement": { + "shape": "Ss3", + "locationName": "placement" + }, + "RamdiskId": { + "locationName": "ramdiskId" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "Monitoring": { + "shape": "Ssm", + "locationName": "monitoring" + } + } + }, + "LaunchedAvailabilityZone": { + "locationName": "launchedAvailabilityZone" + }, + "ProductDescription": { + "locationName": "productDescription" + }, + "SpotInstanceRequestId": { + "locationName": "spotInstanceRequestId" + }, + "SpotPrice": { + "locationName": "spotPrice" + }, + "State": { + "locationName": "state" + }, + "Status": { + "locationName": "status", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + }, + "UpdateTime": { + "locationName": "updateTime", + "type": "timestamp" + } + } + }, + "Tags": { + "shape": "Si", + "locationName": "tagSet" + }, + "Type": { + "locationName": "type" + }, + "ValidFrom": { + "locationName": "validFrom", + "type": "timestamp" + }, + "ValidUntil": { + "locationName": "validUntil", + "type": "timestamp" + }, + "InstanceInterruptionBehavior": { + "locationName": "instanceInterruptionBehavior" + } + } + } + }, + "Ssm": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "locationName": "enabled", + "type": "boolean" + } + } + }, + "Ssz": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "FromPort": { + "locationName": "fromPort", + "type": "integer" + }, + "IpProtocol": { + "locationName": "ipProtocol" + }, + "IpRanges": { + "locationName": "ipRanges", + "type": "list", + "member": { + "locationName": "item" + } + }, + "PrefixListIds": { + "locationName": "prefixListIds", + "type": "list", + "member": { + "locationName": "item" + } + }, + "ToPort": { + "locationName": "toPort", + "type": "integer" + }, + "UserIdGroupPairs": { + "locationName": "groups", + "type": "list", + "member": { + "shape": "S38", + "locationName": "item" + } + } + } + } + }, + "Std": { + "type": "list", + "member": {} + }, + "Sty": { + "type": "list", + "member": { + "locationName": "VolumeId" + } + }, + "Suh": { + "type": "structure", + "members": { + "VolumeId": { + "locationName": "volumeId" + }, + "ModificationState": { + "locationName": "modificationState" + }, + "StatusMessage": { + "locationName": "statusMessage" + }, + "TargetSize": { + "locationName": "targetSize", + "type": "integer" + }, + "TargetIops": { + "locationName": "targetIops", + "type": "integer" + }, + "TargetVolumeType": { + "locationName": "targetVolumeType" + }, + "OriginalSize": { + "locationName": "originalSize", + "type": "integer" + }, + "OriginalIops": { + "locationName": "originalIops", + "type": "integer" + }, + "OriginalVolumeType": { + "locationName": "originalVolumeType" + }, + "Progress": { + "locationName": "progress", + "type": "long" + }, + "StartTime": { + "locationName": "startTime", + "type": "timestamp" + }, + "EndTime": { + "locationName": "endTime", + "type": "timestamp" + } + } + }, + "Sun": { + "type": "list", + "member": { + "locationName": "VpcId" + } + }, + "Sw6": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "TransitGatewayRouteTableId": { + "locationName": "transitGatewayRouteTableId" + }, + "State": { + "locationName": "state" + } + } + }, + "Sxa": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Sxc": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "HostIdSet": { + "shape": "Skp", + "locationName": "hostIdSet" + }, + "HostReservationId": { + "locationName": "hostReservationId" + }, + "HourlyPrice": { + "locationName": "hourlyPrice" + }, + "InstanceFamily": { + "locationName": "instanceFamily" + }, + "PaymentOption": { + "locationName": "paymentOption" + }, + "UpfrontPrice": { + "locationName": "upfrontPrice" + } + } + } + }, + "Sxk": { + "type": "structure", + "members": { + "HourlyPrice": { + "locationName": "hourlyPrice" + }, + "RemainingTotalValue": { + "locationName": "remainingTotalValue" + }, + "RemainingUpfrontValue": { + "locationName": "remainingUpfrontValue" + } + } + }, + "Sy5": { + "type": "structure", + "members": { + "Comment": {}, + "UploadEnd": { + "type": "timestamp" + }, + "UploadSize": { + "type": "double" + }, + "UploadStart": { + "type": "timestamp" + } + } + }, + "Sy8": { + "type": "structure", + "members": { + "S3Bucket": {}, + "S3Key": {} + } + }, + "Syd": { + "type": "structure", + "required": [ + "Bytes", + "Format", + "ImportManifestUrl" + ], + "members": { + "Bytes": { + "locationName": "bytes", + "type": "long" + }, + "Format": { + "locationName": "format" + }, + "ImportManifestUrl": { + "locationName": "importManifestUrl" + } + } + }, + "Sye": { + "type": "structure", + "required": [ + "Size" + ], + "members": { + "Size": { + "locationName": "size", + "type": "long" + } + } + }, + "Syy": { + "type": "list", + "member": { + "locationName": "UserId" + } + }, + "Syz": { + "type": "list", + "member": { + "locationName": "UserGroup" + } + }, + "Sz0": { + "type": "list", + "member": { + "locationName": "ProductCode" + } + }, + "Sz2": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Group": {}, + "UserId": {} + } + } + }, + "Sz7": { + "type": "list", + "member": { + "shape": "Sn", + "locationName": "item" + } + }, + "Szi": { + "type": "structure", + "members": { + "CapacityReservationPreference": {}, + "CapacityReservationTarget": { + "shape": "S8u" + } + } + }, + "S10s": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "type": "boolean" + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "type": "boolean" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "type": "boolean" + } + } + }, + "S10u": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "locationName": "allowDnsResolutionFromRemoteVpc", + "type": "boolean" + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "locationName": "allowEgressFromLocalClassicLinkToRemoteVpc", + "type": "boolean" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "locationName": "allowEgressFromLocalVpcToRemoteClassicLink", + "type": "boolean" + } + } + }, + "S112": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "InstanceId": { + "locationName": "instanceId" + }, + "Monitoring": { + "shape": "Sn5", + "locationName": "monitoring" + } + } + } + }, + "S13e": { + "type": "list", + "member": { + "locationName": "SecurityGroupId" + } + }, + "S13s": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "CurrentState": { + "shape": "Smr", + "locationName": "currentState" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "PreviousState": { + "shape": "Smr", + "locationName": "previousState" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json b/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json new file mode 100644 index 0000000..3d91934 --- /dev/null +++ b/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json @@ -0,0 +1,426 @@ +{ + "pagination": { + "DescribeAccountAttributes": { + "result_key": "AccountAttributes" + }, + "DescribeAddresses": { + "result_key": "Addresses" + }, + "DescribeAvailabilityZones": { + "result_key": "AvailabilityZones" + }, + "DescribeBundleTasks": { + "result_key": "BundleTasks" + }, + "DescribeByoipCidrs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ByoipCidrs" + }, + "DescribeCapacityReservations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CapacityReservations" + }, + "DescribeClassicLinkInstances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Instances" + }, + "DescribeClientVpnAuthorizationRules": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AuthorizationRules" + }, + "DescribeClientVpnConnections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Connections" + }, + "DescribeClientVpnEndpoints": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ClientVpnEndpoints" + }, + "DescribeClientVpnRoutes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Routes" + }, + "DescribeClientVpnTargetNetworks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ClientVpnTargetNetworks" + }, + "DescribeConversionTasks": { + "result_key": "ConversionTasks" + }, + "DescribeCustomerGateways": { + "result_key": "CustomerGateways" + }, + "DescribeDhcpOptions": { + "result_key": "DhcpOptions" + }, + "DescribeEgressOnlyInternetGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EgressOnlyInternetGateways" + }, + "DescribeExportTasks": { + "result_key": "ExportTasks" + }, + "DescribeFleets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Fleets" + }, + "DescribeFlowLogs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FlowLogs" + }, + "DescribeFpgaImages": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FpgaImages" + }, + "DescribeHostReservationOfferings": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "OfferingSet" + }, + "DescribeHostReservations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "HostReservationSet" + }, + "DescribeHosts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Hosts" + }, + "DescribeIamInstanceProfileAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IamInstanceProfileAssociations" + }, + "DescribeImages": { + "result_key": "Images" + }, + "DescribeImportImageTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ImportImageTasks" + }, + "DescribeImportSnapshotTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ImportSnapshotTasks" + }, + "DescribeInstanceCreditSpecifications": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InstanceCreditSpecifications" + }, + "DescribeInstanceStatus": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Reservations" + }, + "DescribeInternetGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InternetGateways" + }, + "DescribeKeyPairs": { + "result_key": "KeyPairs" + }, + "DescribeLaunchTemplateVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LaunchTemplateVersions" + }, + "DescribeLaunchTemplates": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LaunchTemplates" + }, + "DescribeMovingAddresses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "MovingAddressStatuses" + }, + "DescribeNatGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NatGateways" + }, + "DescribeNetworkAcls": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkAcls" + }, + "DescribeNetworkInterfacePermissions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkInterfacePermissions" + }, + "DescribeNetworkInterfaces": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkInterfaces" + }, + "DescribePlacementGroups": { + "result_key": "PlacementGroups" + }, + "DescribePrefixLists": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PrefixLists" + }, + "DescribePrincipalIdFormat": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Principals" + }, + "DescribePublicIpv4Pools": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PublicIpv4Pools" + }, + "DescribeRegions": { + "result_key": "Regions" + }, + "DescribeReservedInstances": { + "result_key": "ReservedInstances" + }, + "DescribeReservedInstancesListings": { + "result_key": "ReservedInstancesListings" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeRouteTables": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "RouteTables" + }, + "DescribeScheduledInstanceAvailability": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScheduledInstanceAvailabilitySet" + }, + "DescribeScheduledInstances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScheduledInstanceSet" + }, + "DescribeSecurityGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SecurityGroups" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Snapshots" + }, + "DescribeSpotFleetRequests": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SpotFleetRequestConfigs" + }, + "DescribeSpotInstanceRequests": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SpotInstanceRequests" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SpotPriceHistory" + }, + "DescribeStaleSecurityGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "StaleSecurityGroupSet" + }, + "DescribeSubnets": { + "result_key": "Subnets" + }, + "DescribeTags": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tags" + }, + "DescribeTransitGatewayAttachments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayAttachments" + }, + "DescribeTransitGatewayRouteTables": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayRouteTables" + }, + "DescribeTransitGatewayVpcAttachments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayVpcAttachments" + }, + "DescribeTransitGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGateways" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "VolumeStatuses" + }, + "DescribeVolumes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Volumes" + }, + "DescribeVolumesModifications": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "VolumesModifications" + }, + "DescribeVpcClassicLinkDnsSupport": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Vpcs" + }, + "DescribeVpcEndpointConnectionNotifications": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ConnectionNotificationSet" + }, + "DescribeVpcEndpointConnections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "VpcEndpointConnections" + }, + "DescribeVpcEndpointServiceConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ServiceConfigurations" + }, + "DescribeVpcEndpointServicePermissions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AllowedPrincipals" + }, + "DescribeVpcEndpoints": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "VpcEndpoints" + }, + "DescribeVpcPeeringConnections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "VpcPeeringConnections" + }, + "DescribeVpcs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Vpcs" + }, + "DescribeVpnConnections": { + "result_key": "VpnConnections" + }, + "DescribeVpnGateways": { + "result_key": "VpnGateways" + }, + "GetTransitGatewayAttachmentPropagations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayAttachmentPropagations" + }, + "GetTransitGatewayRouteTableAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Associations" + }, + "GetTransitGatewayRouteTablePropagations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayRouteTablePropagations" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json b/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json new file mode 100644 index 0000000..33ea7b0 --- /dev/null +++ b/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json @@ -0,0 +1,622 @@ +{ + "version": 2, + "waiters": { + "InstanceExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeInstances", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Reservations[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageExists": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Images[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidAMIID.NotFound", + "state": "retry" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "KeyPairExists": { + "operation": "DescribeKeyPairs", + "delay": 5, + "maxAttempts": 6, + "acceptors": [ + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(KeyPairs[].KeyName) > `0`" + }, + { + "expected": "InvalidKeyPair.NotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "NatGatewayAvailable": { + "operation": "DescribeNatGateways", + "delay": 15, + "maxAttempts": 40, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "NatGateways[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "failed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleting" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleted" + }, + { + "state": "retry", + "matcher": "error", + "expected": "NatGatewayNotFound" + } + ] + }, + "NetworkInterfaceAvailable": { + "operation": "DescribeNetworkInterfaces", + "delay": 20, + "maxAttempts": 10, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "NetworkInterfaces[].Status" + }, + { + "expected": "InvalidNetworkInterfaceID.NotFound", + "matcher": "error", + "state": "failure" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "request-canceled-and-instance-running" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + }, + { + "state": "retry", + "matcher": "error", + "expected": "InvalidSpotInstanceRequestID.NotFound" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "matcher": "error", + "expected": "InvalidVolume.NotFound", + "state": "success" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpcExists": { + "operation": "DescribeVpcs", + "delay": 1, + "maxAttempts": 5, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcID.NotFound", + "state": "retry" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpcPeeringConnectionExists": { + "delay": 15, + "operation": "DescribeVpcPeeringConnections", + "maxAttempts": 40, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcPeeringConnectionID.NotFound", + "state": "retry" + } + ] + }, + "VpcPeeringConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpcPeeringConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpcPeeringConnections[].Status.Code" + }, + { + "matcher": "error", + "expected": "InvalidVpcPeeringConnectionID.NotFound", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/ecr-2015-09-21.examples.json b/node_modules/aws-sdk/apis/ecr-2015-09-21.examples.json new file mode 100644 index 0000000..d11aa8d --- /dev/null +++ b/node_modules/aws-sdk/apis/ecr-2015-09-21.examples.json @@ -0,0 +1,215 @@ +{ + "version": "1.0", + "examples": { + "BatchDeleteImage": [ + { + "input": { + "imageIds": [ + { + "imageTag": "precise" + } + ], + "repositoryName": "ubuntu" + }, + "output": { + "failures": [ + + ], + "imageIds": [ + { + "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f", + "imageTag": "precise" + } + ] + }, + "comments": { + }, + "description": "This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.", + "id": "batchdeleteimages-example-1470860541707", + "title": "To delete multiple images" + } + ], + "BatchGetImage": [ + { + "input": { + "imageIds": [ + { + "imageTag": "precise" + } + ], + "repositoryName": "ubuntu" + }, + "output": { + "failures": [ + + ], + "images": [ + { + "imageId": { + "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a", + "imageTag": "precise" + }, + "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...", + "registryId": "244698725403", + "repositoryName": "ubuntu" + } + ] + }, + "comments": { + "output": { + "imageManifest": "In this example, the imageManifest in the output JSON has been truncated." + } + }, + "description": "This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.", + "id": "batchgetimage-example-1470862771437", + "title": "To obtain multiple images in a single request" + } + ], + "CreateRepository": [ + { + "input": { + "repositoryName": "project-a/nginx-web-app" + }, + "output": { + "repository": { + "registryId": "012345678901", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app", + "repositoryName": "project-a/nginx-web-app" + } + }, + "comments": { + "output": { + "imageManifest": "In this example, the imageManifest in the output JSON has been truncated." + } + }, + "description": "This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.", + "id": "createrepository-example-1470863688724", + "title": "To create a new repository" + } + ], + "DeleteRepository": [ + { + "input": { + "force": true, + "repositoryName": "ubuntu" + }, + "output": { + "repository": { + "registryId": "012345678901", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/ubuntu", + "repositoryName": "ubuntu" + } + }, + "comments": { + "output": { + "imageManifest": "In this example, the imageManifest in the output JSON has been truncated." + } + }, + "description": "This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.", + "id": "deleterepository-example-1470863805703", + "title": "To force delete a repository" + } + ], + "DeleteRepositoryPolicy": [ + { + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "policyText": "{ ... }", + "registryId": "012345678901", + "repositoryName": "ubuntu" + }, + "comments": { + }, + "description": "This example deletes the policy associated with the repository named ubuntu in the current account.", + "id": "deleterepositorypolicy-example-1470866943748", + "title": "To delete the policy associated with a repository" + } + ], + "DescribeRepositories": [ + { + "input": { + }, + "output": { + "repositories": [ + { + "registryId": "012345678910", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu", + "repositoryName": "ubuntu" + }, + { + "registryId": "012345678910", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test", + "repositoryName": "test" + } + ] + }, + "comments": { + "output": { + } + }, + "description": "The following example obtains a list and description of all repositories in the default registry to which the current user has access.", + "id": "describe-repositories-1470856017467", + "title": "To describe all repositories in the current account" + } + ], + "GetAuthorizationToken": [ + { + "input": { + }, + "output": { + "authorizationData": [ + { + "authorizationToken": "QVdTOkN...", + "expiresAt": "1470951892432", + "proxyEndpoint": "https://012345678901.dkr.ecr.us-west-2.amazonaws.com" + } + ] + }, + "comments": { + }, + "description": "This example gets an authorization token for your default registry.", + "id": "getauthorizationtoken-example-1470867047084", + "title": "To obtain an authorization token" + } + ], + "GetRepositoryPolicy": [ + { + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"new statement\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::012345678901:role/CodeDeployDemo\"\n },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}", + "registryId": "012345678901", + "repositoryName": "ubuntu" + }, + "comments": { + }, + "description": "This example obtains the repository policy for the repository named ubuntu.", + "id": "getrepositorypolicy-example-1470867669211", + "title": "To get the current policy for a repository" + } + ], + "ListImages": [ + { + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "imageIds": [ + { + "imageDigest": "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a", + "imageTag": "precise" + } + ] + }, + "comments": { + }, + "description": "This example lists all of the images in the repository named ubuntu in the default registry in the current account. ", + "id": "listimages-example-1470868161594", + "title": "To list all images in a repository" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json b/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json new file mode 100644 index 0000000..6098c8e --- /dev/null +++ b/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json @@ -0,0 +1,785 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-09-21", + "endpointPrefix": "api.ecr", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Amazon ECR", + "serviceFullName": "Amazon EC2 Container Registry", + "serviceId": "ECR", + "signatureVersion": "v4", + "signingName": "ecr", + "targetPrefix": "AmazonEC2ContainerRegistry_V20150921", + "uid": "ecr-2015-09-21" + }, + "operations": { + "BatchCheckLayerAvailability": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "layerDigests" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "layerDigests": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "layers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "layerDigest": {}, + "layerAvailability": {}, + "layerSize": { + "type": "long" + }, + "mediaType": {} + } + } + }, + "failures": { + "type": "list", + "member": { + "type": "structure", + "members": { + "layerDigest": {}, + "failureCode": {}, + "failureReason": {} + } + } + } + } + } + }, + "BatchDeleteImage": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "imageIds" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "imageIds": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": { + "imageIds": { + "shape": "Si" + }, + "failures": { + "shape": "Sn" + } + } + } + }, + "BatchGetImage": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "imageIds" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "imageIds": { + "shape": "Si" + }, + "acceptedMediaTypes": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "images": { + "type": "list", + "member": { + "shape": "Sv" + } + }, + "failures": { + "shape": "Sn" + } + } + } + }, + "CompleteLayerUpload": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "uploadId", + "layerDigests" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "uploadId": {}, + "layerDigests": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "uploadId": {}, + "layerDigest": {} + } + } + }, + "CreateRepository": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "repositoryName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "repository": { + "shape": "S17" + } + } + } + }, + "DeleteLifecyclePolicy": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "lifecyclePolicyText": {}, + "lastEvaluatedAt": { + "type": "timestamp" + } + } + } + }, + "DeleteRepository": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "repository": { + "shape": "S17" + } + } + } + }, + "DeleteRepositoryPolicy": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "policyText": {} + } + } + }, + "DescribeImages": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "imageIds": { + "shape": "Si" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filter": { + "type": "structure", + "members": { + "tagStatus": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "imageDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "imageDigest": {}, + "imageTags": { + "shape": "S1t" + }, + "imageSizeInBytes": { + "type": "long" + }, + "imagePushedAt": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeRepositories": { + "input": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryNames": { + "type": "list", + "member": {} + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "repositories": { + "type": "list", + "member": { + "shape": "S17" + } + }, + "nextToken": {} + } + } + }, + "GetAuthorizationToken": { + "input": { + "type": "structure", + "members": { + "registryIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "authorizationData": { + "type": "list", + "member": { + "type": "structure", + "members": { + "authorizationToken": {}, + "expiresAt": { + "type": "timestamp" + }, + "proxyEndpoint": {} + } + } + } + } + } + }, + "GetDownloadUrlForLayer": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "layerDigest" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "layerDigest": {} + } + }, + "output": { + "type": "structure", + "members": { + "downloadUrl": {}, + "layerDigest": {} + } + } + }, + "GetLifecyclePolicy": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "lifecyclePolicyText": {}, + "lastEvaluatedAt": { + "type": "timestamp" + } + } + } + }, + "GetLifecyclePolicyPreview": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "imageIds": { + "shape": "Si" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filter": { + "type": "structure", + "members": { + "tagStatus": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "lifecyclePolicyText": {}, + "status": {}, + "nextToken": {}, + "previewResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "imageTags": { + "shape": "S1t" + }, + "imageDigest": {}, + "imagePushedAt": { + "type": "timestamp" + }, + "action": { + "type": "structure", + "members": { + "type": {} + } + }, + "appliedRulePriority": { + "type": "integer" + } + } + } + }, + "summary": { + "type": "structure", + "members": { + "expiringImageTotalCount": { + "type": "integer" + } + } + } + } + } + }, + "GetRepositoryPolicy": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "policyText": {} + } + } + }, + "InitiateLayerUpload": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {} + } + }, + "output": { + "type": "structure", + "members": { + "uploadId": {}, + "partSize": { + "type": "long" + } + } + } + }, + "ListImages": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filter": { + "type": "structure", + "members": { + "tagStatus": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "imageIds": { + "shape": "Si" + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "S12" + } + } + } + }, + "PutImage": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "imageManifest" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "imageManifest": {}, + "imageTag": {} + } + }, + "output": { + "type": "structure", + "members": { + "image": { + "shape": "Sv" + } + } + } + }, + "PutLifecyclePolicy": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "lifecyclePolicyText" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "lifecyclePolicyText": {} + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "lifecyclePolicyText": {} + } + } + }, + "SetRepositoryPolicy": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "policyText" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "policyText": {}, + "force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "policyText": {} + } + } + }, + "StartLifecyclePolicyPreview": { + "input": { + "type": "structure", + "required": [ + "repositoryName" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "lifecyclePolicyText": {} + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "lifecyclePolicyText": {}, + "status": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": {}, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UploadLayerPart": { + "input": { + "type": "structure", + "required": [ + "repositoryName", + "uploadId", + "partFirstByte", + "partLastByte", + "layerPartBlob" + ], + "members": { + "registryId": {}, + "repositoryName": {}, + "uploadId": {}, + "partFirstByte": { + "type": "long" + }, + "partLastByte": { + "type": "long" + }, + "layerPartBlob": { + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "uploadId": {}, + "lastByteReceived": { + "type": "long" + } + } + } + } + }, + "shapes": { + "Si": { + "type": "list", + "member": { + "shape": "Sj" + } + }, + "Sj": { + "type": "structure", + "members": { + "imageDigest": {}, + "imageTag": {} + } + }, + "Sn": { + "type": "list", + "member": { + "type": "structure", + "members": { + "imageId": { + "shape": "Sj" + }, + "failureCode": {}, + "failureReason": {} + } + } + }, + "Sv": { + "type": "structure", + "members": { + "registryId": {}, + "repositoryName": {}, + "imageId": { + "shape": "Sj" + }, + "imageManifest": {} + } + }, + "S12": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S17": { + "type": "structure", + "members": { + "repositoryArn": {}, + "registryId": {}, + "repositoryName": {}, + "repositoryUri": {}, + "createdAt": { + "type": "timestamp" + } + } + }, + "S1t": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ecr-2015-09-21.paginators.json b/node_modules/aws-sdk/apis/ecr-2015-09-21.paginators.json new file mode 100644 index 0000000..f7a7f10 --- /dev/null +++ b/node_modules/aws-sdk/apis/ecr-2015-09-21.paginators.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeImages": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "imageDetails" + }, + "DescribeRepositories": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "repositories" + }, + "ListImages": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "imageIds" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ecs-2014-11-13.examples.json b/node_modules/aws-sdk/apis/ecs-2014-11-13.examples.json new file mode 100644 index 0000000..0fbf7b3 --- /dev/null +++ b/node_modules/aws-sdk/apis/ecs-2014-11-13.examples.json @@ -0,0 +1,1137 @@ +{ + "version": "1.0", + "examples": { + "CreateCluster": [ + { + "input": { + "clusterName": "my_cluster" + }, + "output": { + "cluster": { + "activeServicesCount": 0, + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", + "clusterName": "my_cluster", + "pendingTasksCount": 0, + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "status": "ACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a cluster in your default region.", + "id": "to-create-a-new-cluster-1472514079365", + "title": "To create a new cluster" + } + ], + "CreateService": [ + { + "input": { + "desiredCount": 10, + "serviceName": "ecs-simple-service", + "taskDefinition": "hello_world" + }, + "output": { + "service": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:13:47.298Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:13:47.298Z", + "desiredCount": 10, + "id": "ecs-svc/9223370564342348388", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:13:47.298Z" + }, + { + "createdAt": "2016-08-29T15:52:44.481Z", + "desiredCount": 0, + "id": "ecs-svc/9223370564343611322", + "pendingCount": 0, + "runningCount": 0, + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:11:38.941Z" + } + ], + "desiredCount": 10, + "events": [ + + ], + "loadBalancers": [ + + ], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.", + "id": "to-create-a-new-service-1472512584282", + "title": "To create a new service" + }, + { + "input": { + "desiredCount": 10, + "loadBalancers": [ + { + "containerName": "simple-app", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2" + } + ], + "role": "ecsServiceRole", + "serviceName": "ecs-simple-service-elb", + "taskDefinition": "console-sample-app-static" + }, + "output": { + "service": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:02:54.884Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:02:54.884Z", + "desiredCount": 10, + "id": "ecs-svc/9223370564343000923", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", + "updatedAt": "2016-08-29T16:02:54.884Z" + } + ], + "desiredCount": 10, + "events": [ + + ], + "loadBalancers": [ + { + "containerName": "simple-app", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2" + } + ], + "pendingCount": 0, + "roleArn": "arn:aws:iam::012345678910:role/ecsServiceRole", + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service-elb", + "serviceName": "ecs-simple-service-elb", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.", + "id": "to-create-a-new-service-behind-a-load-balancer-1472512484823", + "title": "To create a new service behind a load balancer" + } + ], + "DeleteAccountSetting": [ + { + "input": { + "name": "serviceLongArnFormat" + }, + "output": { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the account setting for your user for the specified resource type.", + "id": "to-delete-the-account-setting-for-your-user-account-1549524548115", + "title": "To delete your account setting" + }, + { + "input": { + "name": "containerInstanceLongArnFormat", + "principalArn": "arn:aws:iam:::user/principalName" + }, + "output": { + "setting": { + "name": "containerInstanceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user.", + "id": "to-delete-the-account-setting-for-a-specific-iam-user-or-iam-role-1549524612917", + "title": "To delete the account settings for a specific IAM user or IAM role" + } + ], + "DeleteCluster": [ + { + "input": { + "cluster": "my_cluster" + }, + "output": { + "cluster": { + "activeServicesCount": 0, + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", + "clusterName": "my_cluster", + "pendingTasksCount": 0, + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "status": "INACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes an empty cluster in your default region.", + "id": "to-delete-an-empty-cluster-1472512705352", + "title": "To delete an empty cluster" + } + ], + "DeleteService": [ + { + "input": { + "service": "my-http-service" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.", + "id": "e8183e38-f86e-4390-b811-f74f30a6007d", + "title": "To delete a service" + } + ], + "DeregisterContainerInstance": [ + { + "input": { + "cluster": "default", + "containerInstance": "container_instance_UUID", + "force": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.", + "id": "bf624927-cf64-4f4b-8b7e-c024a4e682f6", + "title": "To deregister a container instance from a cluster" + } + ], + "DescribeClusters": [ + { + "input": { + "clusters": [ + "default" + ] + }, + "output": { + "clusters": [ + { + "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default", + "clusterName": "default", + "status": "ACTIVE" + } + ], + "failures": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified cluster in your default region.", + "id": "ba88d100-9672-4231-80da-a4bd210bf728", + "title": "To describe a cluster" + } + ], + "DescribeContainerInstances": [ + { + "input": { + "cluster": "default", + "containerInstances": [ + "f2756532-8f13-4d53-87c9-aed50dc94cd7" + ] + }, + "output": { + "containerInstances": [ + { + "agentConnected": true, + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7", + "ec2InstanceId": "i-807f3249", + "pendingTasksCount": 0, + "registeredResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 2048, + "longValue": 0 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 3768, + "longValue": 0 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0.0, + "integerValue": 0, + "longValue": 0, + "stringSetValue": [ + "2376", + "22", + "51678", + "2375" + ] + } + ], + "remainingResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 1948, + "longValue": 0 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 3668, + "longValue": 0 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0.0, + "integerValue": 0, + "longValue": 0, + "stringSetValue": [ + "2376", + "22", + "80", + "51678", + "2375" + ] + } + ], + "runningTasksCount": 1, + "status": "ACTIVE" + } + ], + "failures": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.", + "id": "c8f439de-eb27-4269-8ca7-2c0a7ba75ab0", + "title": "To describe container instance" + } + ], + "DescribeServices": [ + { + "input": { + "services": [ + "ecs-simple-service" + ] + }, + "output": { + "failures": [ + + ], + "services": [ + { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:25:52.130Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:25:52.130Z", + "desiredCount": 1, + "id": "ecs-svc/9223370564341623665", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:25:52.130Z" + } + ], + "desiredCount": 1, + "events": [ + { + "createdAt": "2016-08-29T16:25:58.520Z", + "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d", + "message": "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide." + } + ], + "loadBalancers": [ + + ], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6" + } + ] + }, + "comments": { + "input": { + }, + "output": { + "services[0].events[0].message": "In this example, there is a service event that shows unavailable cluster resources." + } + }, + "description": "This example provides descriptive information about the service named ``ecs-simple-service``.", + "id": "to-describe-a-service-1472513256350", + "title": "To describe a service" + } + ], + "DescribeTaskDefinition": [ + { + "input": { + "taskDefinition": "hello_world:8" + }, + "output": { + "taskDefinition": { + "containerDefinitions": [ + { + "name": "wordpress", + "cpu": 10, + "environment": [ + + ], + "essential": true, + "image": "wordpress", + "links": [ + "mysql" + ], + "memory": 500, + "mountPoints": [ + + ], + "portMappings": [ + { + "containerPort": 80, + "hostPort": 80 + } + ], + "volumesFrom": [ + + ] + }, + { + "name": "mysql", + "cpu": 10, + "environment": [ + { + "name": "MYSQL_ROOT_PASSWORD", + "value": "password" + } + ], + "essential": true, + "image": "mysql", + "memory": 500, + "mountPoints": [ + + ], + "portMappings": [ + + ], + "volumesFrom": [ + + ] + } + ], + "family": "hello_world", + "revision": 8, + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/hello_world:8", + "volumes": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified task definition.", + "id": "4c21eeb1-f1da-4a08-8c44-297fc8d0ea88", + "title": "To describe a task definition" + } + ], + "DescribeTasks": [ + { + "input": { + "tasks": [ + "c5cba4eb-5dad-405e-96db-71ef8eefe6a8" + ] + }, + "output": { + "failures": [ + + ], + "tasks": [ + { + "clusterArn": "arn:aws:ecs:::cluster/default", + "containerInstanceArn": "arn:aws:ecs:::container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb", + "containers": [ + { + "name": "ecs-demo", + "containerArn": "arn:aws:ecs:::container/7c01765b-c588-45b3-8290-4ba38bd6c5a6", + "lastStatus": "RUNNING", + "networkBindings": [ + { + "bindIP": "0.0.0.0", + "containerPort": 80, + "hostPort": 80 + } + ], + "taskArn": "arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8" + } + ], + "desiredStatus": "RUNNING", + "lastStatus": "RUNNING", + "overrides": { + "containerOverrides": [ + { + "name": "ecs-demo" + } + ] + }, + "startedBy": "ecs-svc/9223370608528463088", + "taskArn": "arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", + "taskDefinitionArn": "arn:aws:ecs:::task-definition/amazon-ecs-sample:1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified task, using the task UUID as an identifier.", + "id": "a90b0cde-f965-4946-b55e-cfd8cc54e827", + "title": "To describe a task" + } + ], + "ListAccountSettings": [ + { + "input": { + "effectiveSettings": true + }, + "output": { + "settings": [ + { + "name": "containerInstanceLongArnFormat", + "value": "disabled", + "principalArn": "arn:aws:iam:::user/principalName" + }, + { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + }, + { + "name": "taskLongArnFormat", + "value": "disabled", + "principalArn": "arn:aws:iam:::user/principalName" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example displays the effective account settings for your account.", + "id": "to-view-your-account-settings-1549524118170", + "title": "To view your effective account settings" + }, + { + "input": { + "effectiveSettings": true, + "principalArn": "arn:aws:iam:::user/principalName" + }, + "output": { + "settings": [ + { + "name": "containerInstanceLongArnFormat", + "value": "disabled", + "principalArn": "arn:aws:iam:::user/principalName" + }, + { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + }, + { + "name": "taskLongArnFormat", + "value": "disabled", + "principalArn": "arn:aws:iam:::user/principalName" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example displays the effective account settings for the specified user or role.", + "id": "to-view-the-account-settings-for-a-specific-iam-user-or-iam-role-1549524237932", + "title": "To view the effective account settings for a specific IAM user or IAM role" + } + ], + "ListClusters": [ + { + "input": { + }, + "output": { + "clusterArns": [ + "arn:aws:ecs:us-east-1::cluster/test", + "arn:aws:ecs:us-east-1::cluster/default" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your available clusters in your default region.", + "id": "e337d059-134f-4125-ba8e-4f499139facf", + "title": "To list your available clusters" + } + ], + "ListContainerInstances": [ + { + "input": { + "cluster": "default" + }, + "output": { + "containerInstanceArns": [ + "arn:aws:ecs:us-east-1::container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f", + "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your available container instances in the specified cluster in your default region.", + "id": "62a82a94-713c-4e18-8420-1d2b2ba9d484", + "title": "To list your available container instances in a cluster" + } + ], + "ListServices": [ + { + "input": { + }, + "output": { + "serviceArns": [ + "arn:aws:ecs:us-east-1:012345678910:service/my-http-service" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the services running in the default cluster for an account.", + "id": "1d9a8037-4e0e-4234-a528-609656809a3a", + "title": "To list the services in a cluster" + } + ], + "ListTagsForResource": [ + { + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev" + }, + "output": { + "tags": [ + { + "key": "team", + "value": "dev" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the tags for the 'dev' cluster.", + "id": "to-list-the-tags-for-a-cluster-1540582700259", + "title": "To list the tags for a cluster." + } + ], + "ListTaskDefinitionFamilies": [ + { + "input": { + }, + "output": { + "families": [ + "node-js-app", + "web-timer", + "hpcc", + "hpcc-c4-8xlarge" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your registered task definition families.", + "id": "b5c89769-1d94-4ca2-a79e-8069103c7f75", + "title": "To list your registered task definition families" + }, + { + "input": { + "familyPrefix": "hpcc" + }, + "output": { + "families": [ + "hpcc", + "hpcc-c4-8xlarge" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the task definition revisions that start with \"hpcc\".", + "id": "8a4cf9a6-42c1-4fe3-852d-99ac8968e11b", + "title": "To filter your registered task definition families" + } + ], + "ListTaskDefinitions": [ + { + "input": { + }, + "output": { + "taskDefinitionArns": [ + "arn:aws:ecs:us-east-1::task-definition/sleep300:2", + "arn:aws:ecs:us-east-1::task-definition/sleep360:1", + "arn:aws:ecs:us-east-1::task-definition/wordpress:3", + "arn:aws:ecs:us-east-1::task-definition/wordpress:4", + "arn:aws:ecs:us-east-1::task-definition/wordpress:5", + "arn:aws:ecs:us-east-1::task-definition/wordpress:6" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your registered task definitions.", + "id": "b381ebaf-7eba-4d60-b99b-7f6ae49d3d60", + "title": "To list your registered task definitions" + }, + { + "input": { + "familyPrefix": "wordpress" + }, + "output": { + "taskDefinitionArns": [ + "arn:aws:ecs:us-east-1::task-definition/wordpress:3", + "arn:aws:ecs:us-east-1::task-definition/wordpress:4", + "arn:aws:ecs:us-east-1::task-definition/wordpress:5", + "arn:aws:ecs:us-east-1::task-definition/wordpress:6" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the task definition revisions of a specified family.", + "id": "734e7afd-753a-4bc2-85d0-badddce10910", + "title": "To list the registered task definitions in a family" + } + ], + "ListTasks": [ + { + "input": { + "cluster": "default" + }, + "output": { + "taskArns": [ + "arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", + "arn:aws:ecs:us-east-1:012345678910:task/6b809ef6-c67e-4467-921f-ee261c15a0a1" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of the tasks in a cluster.", + "id": "9a6ec707-1a77-45d0-b2eb-516b5dd9e924", + "title": "To list the tasks in a cluster" + }, + { + "input": { + "cluster": "default", + "containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f" + }, + "output": { + "taskArns": [ + "arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.", + "id": "024bf3b7-9cbb-44e3-848f-9d074e1fecce", + "title": "To list the tasks on a particular container instance" + } + ], + "PutAccountSetting": [ + { + "input": { + "name": "serviceLongArnFormat", + "value": "enabled" + }, + "output": { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", + "id": "to-modify-the-account-settings-for-your-iam-user-account-1549523130939", + "title": "To modify your account settings" + }, + { + "input": { + "name": "containerInstanceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + }, + "output": { + "setting": { + "name": "containerInstanceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", + "id": "to-modify-the-account-settings-for-a-specific-iam-user-or-iam-role-1549523518390", + "title": "To modify the account settings for a specific IAM user or IAM role" + } + ], + "PutAccountSettingDefault": [ + { + "input": { + "name": "serviceLongArnFormat", + "value": "enabled" + }, + "output": { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::root" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", + "id": "to-modify-the-default-account-settings-for-all-iam-users-or-roles-on-your-account-1549523794603", + "title": "To modify the default account settings for all IAM users or roles on an account" + } + ], + "RegisterTaskDefinition": [ + { + "input": { + "containerDefinitions": [ + { + "name": "sleep", + "command": [ + "sleep", + "360" + ], + "cpu": 10, + "essential": true, + "image": "busybox", + "memory": 10 + } + ], + "family": "sleep360", + "taskRoleArn": "", + "volumes": [ + + ] + }, + "output": { + "taskDefinition": { + "containerDefinitions": [ + { + "name": "sleep", + "command": [ + "sleep", + "360" + ], + "cpu": 10, + "environment": [ + + ], + "essential": true, + "image": "busybox", + "memory": 10, + "mountPoints": [ + + ], + "portMappings": [ + + ], + "volumesFrom": [ + + ] + } + ], + "family": "sleep360", + "revision": 1, + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:19", + "volumes": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers a task definition to the specified family.", + "id": "to-register-a-task-definition-1470764550877", + "title": "To register a task definition" + } + ], + "RunTask": [ + { + "input": { + "cluster": "default", + "taskDefinition": "sleep360:1" + }, + "output": { + "tasks": [ + { + "containerInstanceArn": "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb", + "containers": [ + { + "name": "sleep", + "containerArn": "arn:aws:ecs:us-east-1::container/58591c8e-be29-4ddf-95aa-ee459d4c59fd", + "lastStatus": "PENDING", + "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0" + } + ], + "desiredStatus": "RUNNING", + "lastStatus": "PENDING", + "overrides": { + "containerOverrides": [ + { + "name": "sleep" + } + ] + }, + "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example runs the specified task definition on your default cluster.", + "id": "6f238c83-a133-42cd-ab3d-abeca0560445", + "title": "To run a task on your default cluster" + } + ], + "TagResource": [ + { + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", + "tags": [ + { + "key": "team", + "value": "dev" + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example tags the 'dev' cluster with key 'team' and value 'dev'.", + "id": "to-tag-a-cluster-1540581863751", + "title": "To tag a cluster." + } + ], + "UntagResource": [ + { + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", + "tagKeys": [ + "team" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the 'team' tag from the 'dev' cluster.", + "id": "to-untag-a-cluster-1540582546056", + "title": "To untag a cluster." + } + ], + "UpdateService": [ + { + "input": { + "service": "my-http-service", + "taskDefinition": "amazon-ecs-sample" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the my-http-service service to use the amazon-ecs-sample task definition.", + "id": "cc9e8900-0cc2-44d2-8491-64d1d3d37887", + "title": "To change the task definition used in a service" + }, + { + "input": { + "desiredCount": 10, + "service": "my-http-service" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the desired count of the my-http-service service to 10.", + "id": "9581d6c5-02e3-4140-8cc1-5a4301586633", + "title": "To change the number of tasks in a service" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json b/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json new file mode 100644 index 0000000..16853b6 --- /dev/null +++ b/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json @@ -0,0 +1,2226 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-11-13", + "endpointPrefix": "ecs", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Amazon ECS", + "serviceFullName": "Amazon EC2 Container Service", + "serviceId": "ECS", + "signatureVersion": "v4", + "targetPrefix": "AmazonEC2ContainerServiceV20141113", + "uid": "ecs-2014-11-13" + }, + "operations": { + "CreateCluster": { + "input": { + "type": "structure", + "members": { + "clusterName": {}, + "tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "cluster": { + "shape": "S8" + } + } + } + }, + "CreateService": { + "input": { + "type": "structure", + "required": [ + "serviceName" + ], + "members": { + "cluster": {}, + "serviceName": {}, + "taskDefinition": {}, + "loadBalancers": { + "shape": "Sd" + }, + "serviceRegistries": { + "shape": "Sg" + }, + "desiredCount": { + "type": "integer" + }, + "clientToken": {}, + "launchType": {}, + "platformVersion": {}, + "role": {}, + "deploymentConfiguration": { + "shape": "Sj" + }, + "placementConstraints": { + "shape": "Sk" + }, + "placementStrategy": { + "shape": "Sn" + }, + "networkConfiguration": { + "shape": "Sq" + }, + "healthCheckGracePeriodSeconds": { + "type": "integer" + }, + "schedulingStrategy": {}, + "deploymentController": { + "shape": "Sv" + }, + "tags": { + "shape": "S3" + }, + "enableECSManagedTags": { + "type": "boolean" + }, + "propagateTags": {} + } + }, + "output": { + "type": "structure", + "members": { + "service": { + "shape": "S10" + } + } + } + }, + "CreateTaskSet": { + "input": { + "type": "structure", + "required": [ + "service", + "cluster", + "taskDefinition" + ], + "members": { + "service": {}, + "cluster": {}, + "externalId": {}, + "taskDefinition": {}, + "networkConfiguration": { + "shape": "Sq" + }, + "loadBalancers": { + "shape": "Sd" + }, + "serviceRegistries": { + "shape": "Sg" + }, + "launchType": {}, + "platformVersion": {}, + "scale": { + "shape": "S14" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "taskSet": { + "shape": "S12" + } + } + } + }, + "DeleteAccountSetting": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "principalArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "setting": { + "shape": "S1h" + } + } + } + }, + "DeleteAttributes": { + "input": { + "type": "structure", + "required": [ + "attributes" + ], + "members": { + "cluster": {}, + "attributes": { + "shape": "S1j" + } + } + }, + "output": { + "type": "structure", + "members": { + "attributes": { + "shape": "S1j" + } + } + } + }, + "DeleteCluster": { + "input": { + "type": "structure", + "required": [ + "cluster" + ], + "members": { + "cluster": {} + } + }, + "output": { + "type": "structure", + "members": { + "cluster": { + "shape": "S8" + } + } + } + }, + "DeleteService": { + "input": { + "type": "structure", + "required": [ + "service" + ], + "members": { + "cluster": {}, + "service": {}, + "force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "service": { + "shape": "S10" + } + } + } + }, + "DeleteTaskSet": { + "input": { + "type": "structure", + "required": [ + "cluster", + "service", + "taskSet" + ], + "members": { + "cluster": {}, + "service": {}, + "taskSet": {}, + "force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskSet": { + "shape": "S12" + } + } + } + }, + "DeregisterContainerInstance": { + "input": { + "type": "structure", + "required": [ + "containerInstance" + ], + "members": { + "cluster": {}, + "containerInstance": {}, + "force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "containerInstance": { + "shape": "S1w" + } + } + } + }, + "DeregisterTaskDefinition": { + "input": { + "type": "structure", + "required": [ + "taskDefinition" + ], + "members": { + "taskDefinition": {} + } + }, + "output": { + "type": "structure", + "members": { + "taskDefinition": { + "shape": "S27" + } + } + } + }, + "DescribeClusters": { + "input": { + "type": "structure", + "members": { + "clusters": { + "shape": "Ss" + }, + "include": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "clusters": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "DescribeContainerInstances": { + "input": { + "type": "structure", + "required": [ + "containerInstances" + ], + "members": { + "cluster": {}, + "containerInstances": { + "shape": "Ss" + }, + "include": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "containerInstances": { + "shape": "S45" + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "DescribeServices": { + "input": { + "type": "structure", + "required": [ + "services" + ], + "members": { + "cluster": {}, + "services": { + "shape": "Ss" + }, + "include": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "services": { + "type": "list", + "member": { + "shape": "S10" + } + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "DescribeTaskDefinition": { + "input": { + "type": "structure", + "required": [ + "taskDefinition" + ], + "members": { + "taskDefinition": {}, + "include": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "taskDefinition": { + "shape": "S27" + }, + "tags": { + "shape": "S3" + } + } + } + }, + "DescribeTaskSets": { + "input": { + "type": "structure", + "required": [ + "cluster", + "service" + ], + "members": { + "cluster": {}, + "service": {}, + "taskSets": { + "shape": "Ss" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskSets": { + "shape": "S11" + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "DescribeTasks": { + "input": { + "type": "structure", + "required": [ + "tasks" + ], + "members": { + "cluster": {}, + "tasks": { + "shape": "Ss" + }, + "include": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "tasks": { + "shape": "S4l" + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "DiscoverPollEndpoint": { + "input": { + "type": "structure", + "members": { + "containerInstance": {}, + "cluster": {} + } + }, + "output": { + "type": "structure", + "members": { + "endpoint": {}, + "telemetryEndpoint": {} + } + } + }, + "ListAccountSettings": { + "input": { + "type": "structure", + "members": { + "name": {}, + "value": {}, + "principalArn": {}, + "effectiveSettings": { + "type": "boolean" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "settings": { + "type": "list", + "member": { + "shape": "S1h" + } + }, + "nextToken": {} + } + } + }, + "ListAttributes": { + "input": { + "type": "structure", + "required": [ + "targetType" + ], + "members": { + "cluster": {}, + "targetType": {}, + "attributeName": {}, + "attributeValue": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "attributes": { + "shape": "S1j" + }, + "nextToken": {} + } + } + }, + "ListClusters": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "clusterArns": { + "shape": "Ss" + }, + "nextToken": {} + } + } + }, + "ListContainerInstances": { + "input": { + "type": "structure", + "members": { + "cluster": {}, + "filter": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "status": {} + } + }, + "output": { + "type": "structure", + "members": { + "containerInstanceArns": { + "shape": "Ss" + }, + "nextToken": {} + } + } + }, + "ListServices": { + "input": { + "type": "structure", + "members": { + "cluster": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "launchType": {}, + "schedulingStrategy": {} + } + }, + "output": { + "type": "structure", + "members": { + "serviceArns": { + "shape": "Ss" + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "S3" + } + } + } + }, + "ListTaskDefinitionFamilies": { + "input": { + "type": "structure", + "members": { + "familyPrefix": {}, + "status": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "families": { + "shape": "Ss" + }, + "nextToken": {} + } + } + }, + "ListTaskDefinitions": { + "input": { + "type": "structure", + "members": { + "familyPrefix": {}, + "status": {}, + "sort": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskDefinitionArns": { + "shape": "Ss" + }, + "nextToken": {} + } + } + }, + "ListTasks": { + "input": { + "type": "structure", + "members": { + "cluster": {}, + "containerInstance": {}, + "family": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "startedBy": {}, + "serviceName": {}, + "desiredStatus": {}, + "launchType": {} + } + }, + "output": { + "type": "structure", + "members": { + "taskArns": { + "shape": "Ss" + }, + "nextToken": {} + } + } + }, + "PutAccountSetting": { + "input": { + "type": "structure", + "required": [ + "name", + "value" + ], + "members": { + "name": {}, + "value": {}, + "principalArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "setting": { + "shape": "S1h" + } + } + } + }, + "PutAccountSettingDefault": { + "input": { + "type": "structure", + "required": [ + "name", + "value" + ], + "members": { + "name": {}, + "value": {} + } + }, + "output": { + "type": "structure", + "members": { + "setting": { + "shape": "S1h" + } + } + } + }, + "PutAttributes": { + "input": { + "type": "structure", + "required": [ + "attributes" + ], + "members": { + "cluster": {}, + "attributes": { + "shape": "S1j" + } + } + }, + "output": { + "type": "structure", + "members": { + "attributes": { + "shape": "S1j" + } + } + } + }, + "RegisterContainerInstance": { + "input": { + "type": "structure", + "members": { + "cluster": {}, + "instanceIdentityDocument": {}, + "instanceIdentityDocumentSignature": {}, + "totalResources": { + "shape": "S1z" + }, + "versionInfo": { + "shape": "S1y" + }, + "containerInstanceArn": {}, + "attributes": { + "shape": "S1j" + }, + "platformDevices": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "id", + "type" + ], + "members": { + "id": {}, + "type": {} + } + } + }, + "tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "containerInstance": { + "shape": "S1w" + } + } + } + }, + "RegisterTaskDefinition": { + "input": { + "type": "structure", + "required": [ + "family", + "containerDefinitions" + ], + "members": { + "family": {}, + "taskRoleArn": {}, + "executionRoleArn": {}, + "networkMode": {}, + "containerDefinitions": { + "shape": "S28" + }, + "volumes": { + "shape": "S3c" + }, + "placementConstraints": { + "shape": "S3k" + }, + "requiresCompatibilities": { + "shape": "S3n" + }, + "cpu": {}, + "memory": {}, + "tags": { + "shape": "S3" + }, + "pidMode": {}, + "ipcMode": {}, + "proxyConfiguration": { + "shape": "S3r" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskDefinition": { + "shape": "S27" + }, + "tags": { + "shape": "S3" + } + } + } + }, + "RunTask": { + "input": { + "type": "structure", + "required": [ + "taskDefinition" + ], + "members": { + "cluster": {}, + "taskDefinition": {}, + "overrides": { + "shape": "S4n" + }, + "count": { + "type": "integer" + }, + "startedBy": {}, + "group": {}, + "placementConstraints": { + "shape": "Sk" + }, + "placementStrategy": { + "shape": "Sn" + }, + "launchType": {}, + "platformVersion": {}, + "networkConfiguration": { + "shape": "Sq" + }, + "tags": { + "shape": "S3" + }, + "enableECSManagedTags": { + "type": "boolean" + }, + "propagateTags": {} + } + }, + "output": { + "type": "structure", + "members": { + "tasks": { + "shape": "S4l" + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "StartTask": { + "input": { + "type": "structure", + "required": [ + "taskDefinition", + "containerInstances" + ], + "members": { + "cluster": {}, + "taskDefinition": {}, + "overrides": { + "shape": "S4n" + }, + "containerInstances": { + "shape": "Ss" + }, + "startedBy": {}, + "group": {}, + "networkConfiguration": { + "shape": "Sq" + }, + "tags": { + "shape": "S3" + }, + "enableECSManagedTags": { + "type": "boolean" + }, + "propagateTags": {} + } + }, + "output": { + "type": "structure", + "members": { + "tasks": { + "shape": "S4l" + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "StopTask": { + "input": { + "type": "structure", + "required": [ + "task" + ], + "members": { + "cluster": {}, + "task": {}, + "reason": {} + } + }, + "output": { + "type": "structure", + "members": { + "task": { + "shape": "S4m" + } + } + } + }, + "SubmitContainerStateChange": { + "input": { + "type": "structure", + "members": { + "cluster": {}, + "task": {}, + "containerName": {}, + "status": {}, + "exitCode": { + "type": "integer" + }, + "reason": {}, + "networkBindings": { + "shape": "S4s" + } + } + }, + "output": { + "type": "structure", + "members": { + "acknowledgment": {} + } + } + }, + "SubmitTaskStateChange": { + "input": { + "type": "structure", + "members": { + "cluster": {}, + "task": {}, + "status": {}, + "reason": {}, + "containers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "containerName": {}, + "exitCode": { + "type": "integer" + }, + "networkBindings": { + "shape": "S4s" + }, + "reason": {}, + "status": {} + } + } + }, + "attachments": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "attachmentArn", + "status" + ], + "members": { + "attachmentArn": {}, + "status": {} + } + } + }, + "pullStartedAt": { + "type": "timestamp" + }, + "pullStoppedAt": { + "type": "timestamp" + }, + "executionStoppedAt": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "acknowledgment": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": {}, + "tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": {}, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateContainerAgent": { + "input": { + "type": "structure", + "required": [ + "containerInstance" + ], + "members": { + "cluster": {}, + "containerInstance": {} + } + }, + "output": { + "type": "structure", + "members": { + "containerInstance": { + "shape": "S1w" + } + } + } + }, + "UpdateContainerInstancesState": { + "input": { + "type": "structure", + "required": [ + "containerInstances", + "status" + ], + "members": { + "cluster": {}, + "containerInstances": { + "shape": "Ss" + }, + "status": {} + } + }, + "output": { + "type": "structure", + "members": { + "containerInstances": { + "shape": "S45" + }, + "failures": { + "shape": "S3z" + } + } + } + }, + "UpdateService": { + "input": { + "type": "structure", + "required": [ + "service" + ], + "members": { + "cluster": {}, + "service": {}, + "desiredCount": { + "type": "integer" + }, + "taskDefinition": {}, + "deploymentConfiguration": { + "shape": "Sj" + }, + "networkConfiguration": { + "shape": "Sq" + }, + "platformVersion": {}, + "forceNewDeployment": { + "type": "boolean" + }, + "healthCheckGracePeriodSeconds": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "service": { + "shape": "S10" + } + } + } + }, + "UpdateServicePrimaryTaskSet": { + "input": { + "type": "structure", + "required": [ + "cluster", + "service", + "primaryTaskSet" + ], + "members": { + "cluster": {}, + "service": {}, + "primaryTaskSet": {} + } + }, + "output": { + "type": "structure", + "members": { + "taskSet": { + "shape": "S12" + } + } + } + }, + "UpdateTaskSet": { + "input": { + "type": "structure", + "required": [ + "cluster", + "service", + "taskSet", + "scale" + ], + "members": { + "cluster": {}, + "service": {}, + "taskSet": {}, + "scale": { + "shape": "S14" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskSet": { + "shape": "S12" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "S8": { + "type": "structure", + "members": { + "clusterArn": {}, + "clusterName": {}, + "status": {}, + "registeredContainerInstancesCount": { + "type": "integer" + }, + "runningTasksCount": { + "type": "integer" + }, + "pendingTasksCount": { + "type": "integer" + }, + "activeServicesCount": { + "type": "integer" + }, + "statistics": { + "type": "list", + "member": { + "shape": "Sb" + } + }, + "tags": { + "shape": "S3" + } + } + }, + "Sb": { + "type": "structure", + "members": { + "name": {}, + "value": {} + } + }, + "Sd": { + "type": "list", + "member": { + "type": "structure", + "members": { + "targetGroupArn": {}, + "loadBalancerName": {}, + "containerName": {}, + "containerPort": { + "type": "integer" + } + } + } + }, + "Sg": { + "type": "list", + "member": { + "type": "structure", + "members": { + "registryArn": {}, + "port": { + "type": "integer" + }, + "containerName": {}, + "containerPort": { + "type": "integer" + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "maximumPercent": { + "type": "integer" + }, + "minimumHealthyPercent": { + "type": "integer" + } + } + }, + "Sk": { + "type": "list", + "member": { + "type": "structure", + "members": { + "type": {}, + "expression": {} + } + } + }, + "Sn": { + "type": "list", + "member": { + "type": "structure", + "members": { + "type": {}, + "field": {} + } + } + }, + "Sq": { + "type": "structure", + "members": { + "awsvpcConfiguration": { + "type": "structure", + "required": [ + "subnets" + ], + "members": { + "subnets": { + "shape": "Ss" + }, + "securityGroups": { + "shape": "Ss" + }, + "assignPublicIp": {} + } + } + } + }, + "Ss": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {} + } + }, + "S10": { + "type": "structure", + "members": { + "serviceArn": {}, + "serviceName": {}, + "clusterArn": {}, + "loadBalancers": { + "shape": "Sd" + }, + "serviceRegistries": { + "shape": "Sg" + }, + "status": {}, + "desiredCount": { + "type": "integer" + }, + "runningCount": { + "type": "integer" + }, + "pendingCount": { + "type": "integer" + }, + "launchType": {}, + "platformVersion": {}, + "taskDefinition": {}, + "deploymentConfiguration": { + "shape": "Sj" + }, + "taskSets": { + "shape": "S11" + }, + "deployments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "status": {}, + "taskDefinition": {}, + "desiredCount": { + "type": "integer" + }, + "pendingCount": { + "type": "integer" + }, + "runningCount": { + "type": "integer" + }, + "createdAt": { + "type": "timestamp" + }, + "updatedAt": { + "type": "timestamp" + }, + "launchType": {}, + "platformVersion": {}, + "networkConfiguration": { + "shape": "Sq" + } + } + } + }, + "roleArn": {}, + "events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "createdAt": { + "type": "timestamp" + }, + "message": {} + } + } + }, + "createdAt": { + "type": "timestamp" + }, + "placementConstraints": { + "shape": "Sk" + }, + "placementStrategy": { + "shape": "Sn" + }, + "networkConfiguration": { + "shape": "Sq" + }, + "healthCheckGracePeriodSeconds": { + "type": "integer" + }, + "schedulingStrategy": {}, + "deploymentController": { + "shape": "Sv" + }, + "tags": { + "shape": "S3" + }, + "createdBy": {}, + "enableECSManagedTags": { + "type": "boolean" + }, + "propagateTags": {} + } + }, + "S11": { + "type": "list", + "member": { + "shape": "S12" + } + }, + "S12": { + "type": "structure", + "members": { + "id": {}, + "taskSetArn": {}, + "serviceArn": {}, + "clusterArn": {}, + "startedBy": {}, + "externalId": {}, + "status": {}, + "taskDefinition": {}, + "computedDesiredCount": { + "type": "integer" + }, + "pendingCount": { + "type": "integer" + }, + "runningCount": { + "type": "integer" + }, + "createdAt": { + "type": "timestamp" + }, + "updatedAt": { + "type": "timestamp" + }, + "launchType": {}, + "platformVersion": {}, + "networkConfiguration": { + "shape": "Sq" + }, + "loadBalancers": { + "shape": "Sd" + }, + "serviceRegistries": { + "shape": "Sg" + }, + "scale": { + "shape": "S14" + }, + "stabilityStatus": {}, + "stabilityStatusAt": { + "type": "timestamp" + } + } + }, + "S14": { + "type": "structure", + "members": { + "value": { + "type": "double" + }, + "unit": {} + } + }, + "S1h": { + "type": "structure", + "members": { + "name": {}, + "value": {}, + "principalArn": {} + } + }, + "S1j": { + "type": "list", + "member": { + "shape": "S1k" + } + }, + "S1k": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "value": {}, + "targetType": {}, + "targetId": {} + } + }, + "S1w": { + "type": "structure", + "members": { + "containerInstanceArn": {}, + "ec2InstanceId": {}, + "version": { + "type": "long" + }, + "versionInfo": { + "shape": "S1y" + }, + "remainingResources": { + "shape": "S1z" + }, + "registeredResources": { + "shape": "S1z" + }, + "status": {}, + "agentConnected": { + "type": "boolean" + }, + "runningTasksCount": { + "type": "integer" + }, + "pendingTasksCount": { + "type": "integer" + }, + "agentUpdateStatus": {}, + "attributes": { + "shape": "S1j" + }, + "registeredAt": { + "type": "timestamp" + }, + "attachments": { + "shape": "S22" + }, + "tags": { + "shape": "S3" + } + } + }, + "S1y": { + "type": "structure", + "members": { + "agentVersion": {}, + "agentHash": {}, + "dockerVersion": {} + } + }, + "S1z": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "type": {}, + "doubleValue": { + "type": "double" + }, + "longValue": { + "type": "long" + }, + "integerValue": { + "type": "integer" + }, + "stringSetValue": { + "shape": "Ss" + } + } + } + }, + "S22": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "type": {}, + "status": {}, + "details": { + "type": "list", + "member": { + "shape": "Sb" + } + } + } + } + }, + "S27": { + "type": "structure", + "members": { + "taskDefinitionArn": {}, + "containerDefinitions": { + "shape": "S28" + }, + "family": {}, + "taskRoleArn": {}, + "executionRoleArn": {}, + "networkMode": {}, + "revision": { + "type": "integer" + }, + "volumes": { + "shape": "S3c" + }, + "status": {}, + "requiresAttributes": { + "type": "list", + "member": { + "shape": "S1k" + } + }, + "placementConstraints": { + "shape": "S3k" + }, + "compatibilities": { + "shape": "S3n" + }, + "requiresCompatibilities": { + "shape": "S3n" + }, + "cpu": {}, + "memory": {}, + "pidMode": {}, + "ipcMode": {}, + "proxyConfiguration": { + "shape": "S3r" + } + } + }, + "S28": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "image": {}, + "repositoryCredentials": { + "type": "structure", + "required": [ + "credentialsParameter" + ], + "members": { + "credentialsParameter": {} + } + }, + "cpu": { + "type": "integer" + }, + "memory": { + "type": "integer" + }, + "memoryReservation": { + "type": "integer" + }, + "links": { + "shape": "Ss" + }, + "portMappings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "containerPort": { + "type": "integer" + }, + "hostPort": { + "type": "integer" + }, + "protocol": {} + } + } + }, + "essential": { + "type": "boolean" + }, + "entryPoint": { + "shape": "Ss" + }, + "command": { + "shape": "Ss" + }, + "environment": { + "shape": "S2e" + }, + "mountPoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "sourceVolume": {}, + "containerPath": {}, + "readOnly": { + "type": "boolean" + } + } + } + }, + "volumesFrom": { + "type": "list", + "member": { + "type": "structure", + "members": { + "sourceContainer": {}, + "readOnly": { + "type": "boolean" + } + } + } + }, + "linuxParameters": { + "type": "structure", + "members": { + "capabilities": { + "type": "structure", + "members": { + "add": { + "shape": "Ss" + }, + "drop": { + "shape": "Ss" + } + } + }, + "devices": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "hostPath" + ], + "members": { + "hostPath": {}, + "containerPath": {}, + "permissions": { + "type": "list", + "member": {} + } + } + } + }, + "initProcessEnabled": { + "type": "boolean" + }, + "sharedMemorySize": { + "type": "integer" + }, + "tmpfs": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "containerPath", + "size" + ], + "members": { + "containerPath": {}, + "size": { + "type": "integer" + }, + "mountOptions": { + "shape": "Ss" + } + } + } + } + } + }, + "secrets": { + "shape": "S2r" + }, + "dependsOn": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "containerName", + "condition" + ], + "members": { + "containerName": {}, + "condition": {} + } + } + }, + "startTimeout": { + "type": "integer" + }, + "stopTimeout": { + "type": "integer" + }, + "hostname": {}, + "user": {}, + "workingDirectory": {}, + "disableNetworking": { + "type": "boolean" + }, + "privileged": { + "type": "boolean" + }, + "readonlyRootFilesystem": { + "type": "boolean" + }, + "dnsServers": { + "shape": "Ss" + }, + "dnsSearchDomains": { + "shape": "Ss" + }, + "extraHosts": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "hostname", + "ipAddress" + ], + "members": { + "hostname": {}, + "ipAddress": {} + } + } + }, + "dockerSecurityOptions": { + "shape": "Ss" + }, + "interactive": { + "type": "boolean" + }, + "pseudoTerminal": { + "type": "boolean" + }, + "dockerLabels": { + "type": "map", + "key": {}, + "value": {} + }, + "ulimits": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "softLimit", + "hardLimit" + ], + "members": { + "name": {}, + "softLimit": { + "type": "integer" + }, + "hardLimit": { + "type": "integer" + } + } + } + }, + "logConfiguration": { + "type": "structure", + "required": [ + "logDriver" + ], + "members": { + "logDriver": {}, + "options": { + "type": "map", + "key": {}, + "value": {} + }, + "secretOptions": { + "shape": "S2r" + } + } + }, + "healthCheck": { + "type": "structure", + "required": [ + "command" + ], + "members": { + "command": { + "shape": "Ss" + }, + "interval": { + "type": "integer" + }, + "timeout": { + "type": "integer" + }, + "retries": { + "type": "integer" + }, + "startPeriod": { + "type": "integer" + } + } + }, + "systemControls": { + "type": "list", + "member": { + "type": "structure", + "members": { + "namespace": {}, + "value": {} + } + } + }, + "resourceRequirements": { + "shape": "S38" + } + } + } + }, + "S2e": { + "type": "list", + "member": { + "shape": "Sb" + } + }, + "S2r": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "valueFrom" + ], + "members": { + "name": {}, + "valueFrom": {} + } + } + }, + "S38": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "value", + "type" + ], + "members": { + "value": {}, + "type": {} + } + } + }, + "S3c": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "host": { + "type": "structure", + "members": { + "sourcePath": {} + } + }, + "dockerVolumeConfiguration": { + "type": "structure", + "members": { + "scope": {}, + "autoprovision": { + "type": "boolean" + }, + "driver": {}, + "driverOpts": { + "shape": "S3h" + }, + "labels": { + "shape": "S3h" + } + } + } + } + } + }, + "S3h": { + "type": "map", + "key": {}, + "value": {} + }, + "S3k": { + "type": "list", + "member": { + "type": "structure", + "members": { + "type": {}, + "expression": {} + } + } + }, + "S3n": { + "type": "list", + "member": {} + }, + "S3r": { + "type": "structure", + "required": [ + "containerName" + ], + "members": { + "type": {}, + "containerName": {}, + "properties": { + "type": "list", + "member": { + "shape": "Sb" + } + } + } + }, + "S3z": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "reason": {} + } + } + }, + "S45": { + "type": "list", + "member": { + "shape": "S1w" + } + }, + "S4l": { + "type": "list", + "member": { + "shape": "S4m" + } + }, + "S4m": { + "type": "structure", + "members": { + "taskArn": {}, + "clusterArn": {}, + "taskDefinitionArn": {}, + "containerInstanceArn": {}, + "overrides": { + "shape": "S4n" + }, + "lastStatus": {}, + "desiredStatus": {}, + "cpu": {}, + "memory": {}, + "containers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "containerArn": {}, + "taskArn": {}, + "name": {}, + "lastStatus": {}, + "exitCode": { + "type": "integer" + }, + "reason": {}, + "networkBindings": { + "shape": "S4s" + }, + "networkInterfaces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "attachmentId": {}, + "privateIpv4Address": {}, + "ipv6Address": {} + } + } + }, + "healthStatus": {}, + "cpu": {}, + "memory": {}, + "memoryReservation": {}, + "gpuIds": { + "type": "list", + "member": {} + } + } + } + }, + "startedBy": {}, + "version": { + "type": "long" + }, + "stoppedReason": {}, + "stopCode": {}, + "connectivity": {}, + "connectivityAt": { + "type": "timestamp" + }, + "pullStartedAt": { + "type": "timestamp" + }, + "pullStoppedAt": { + "type": "timestamp" + }, + "executionStoppedAt": { + "type": "timestamp" + }, + "createdAt": { + "type": "timestamp" + }, + "startedAt": { + "type": "timestamp" + }, + "stoppingAt": { + "type": "timestamp" + }, + "stoppedAt": { + "type": "timestamp" + }, + "group": {}, + "launchType": {}, + "platformVersion": {}, + "attachments": { + "shape": "S22" + }, + "healthStatus": {}, + "tags": { + "shape": "S3" + } + } + }, + "S4n": { + "type": "structure", + "members": { + "containerOverrides": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "command": { + "shape": "Ss" + }, + "environment": { + "shape": "S2e" + }, + "cpu": { + "type": "integer" + }, + "memory": { + "type": "integer" + }, + "memoryReservation": { + "type": "integer" + }, + "resourceRequirements": { + "shape": "S38" + } + } + } + }, + "taskRoleArn": {}, + "executionRoleArn": {} + } + }, + "S4s": { + "type": "list", + "member": { + "type": "structure", + "members": { + "bindIP": {}, + "containerPort": { + "type": "integer" + }, + "hostPort": { + "type": "integer" + }, + "protocol": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ecs-2014-11-13.paginators.json b/node_modules/aws-sdk/apis/ecs-2014-11-13.paginators.json new file mode 100644 index 0000000..46cea2a --- /dev/null +++ b/node_modules/aws-sdk/apis/ecs-2014-11-13.paginators.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListClusters": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "clusterArns" + }, + "ListContainerInstances": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "containerInstanceArns" + }, + "ListServices": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "serviceArns" + }, + "ListTaskDefinitionFamilies": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "families" + }, + "ListTaskDefinitions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "taskDefinitionArns" + }, + "ListTasks": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "taskArns" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ecs-2014-11-13.waiters2.json b/node_modules/aws-sdk/apis/ecs-2014-11-13.waiters2.json new file mode 100644 index 0000000..8a0b19d --- /dev/null +++ b/node_modules/aws-sdk/apis/ecs-2014-11-13.waiters2.json @@ -0,0 +1,93 @@ +{ + "version": 2, + "waiters": { + "TasksRunning": { + "delay": 6, + "operation": "DescribeTasks", + "maxAttempts": 100, + "acceptors": [ + { + "expected": "STOPPED", + "matcher": "pathAny", + "state": "failure", + "argument": "tasks[].lastStatus" + }, + { + "expected": "MISSING", + "matcher": "pathAny", + "state": "failure", + "argument": "failures[].reason" + }, + { + "expected": "RUNNING", + "matcher": "pathAll", + "state": "success", + "argument": "tasks[].lastStatus" + } + ] + }, + "TasksStopped": { + "delay": 6, + "operation": "DescribeTasks", + "maxAttempts": 100, + "acceptors": [ + { + "expected": "STOPPED", + "matcher": "pathAll", + "state": "success", + "argument": "tasks[].lastStatus" + } + ] + }, + "ServicesStable": { + "delay": 15, + "operation": "DescribeServices", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "MISSING", + "matcher": "pathAny", + "state": "failure", + "argument": "failures[].reason" + }, + { + "expected": "DRAINING", + "matcher": "pathAny", + "state": "failure", + "argument": "services[].status" + }, + { + "expected": "INACTIVE", + "matcher": "pathAny", + "state": "failure", + "argument": "services[].status" + }, + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`" + } + ] + }, + "ServicesInactive": { + "delay": 15, + "operation": "DescribeServices", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "MISSING", + "matcher": "pathAny", + "state": "failure", + "argument": "failures[].reason" + }, + { + "expected": "INACTIVE", + "matcher": "pathAny", + "state": "success", + "argument": "services[].status" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/eks-2017-11-01.examples.json b/node_modules/aws-sdk/apis/eks-2017-11-01.examples.json new file mode 100644 index 0000000..6a83da7 --- /dev/null +++ b/node_modules/aws-sdk/apis/eks-2017-11-01.examples.json @@ -0,0 +1,114 @@ +{ + "version": "1.0", + "examples": { + "CreateCluster": [ + { + "input": { + "version": "1.10", + "name": "prod", + "clientRequestToken": "1d2129a1-3d38-460a-9756-e5b91fddb951", + "resourcesVpcConfig": { + "securityGroupIds": [ + "sg-6979fe18" + ], + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ] + }, + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an Amazon EKS cluster called prod.", + "id": "to-create-a-new-cluster-1527868185648", + "title": "To create a new cluster" + } + ], + "DeleteCluster": [ + { + "input": { + "name": "devel" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command deletes a cluster named `devel` in your default region.", + "id": "to-delete-a-cluster-1527868641252", + "title": "To delete a cluster" + } + ], + "DescribeCluster": [ + { + "input": { + "name": "devel" + }, + "output": { + "cluster": { + "version": "1.10", + "name": "devel", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel", + "certificateAuthority": { + "data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=" + }, + "createdAt": 1527807879.988, + "endpoint": "https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com", + "resourcesVpcConfig": { + "securityGroupIds": [ + "sg-6979fe18" + ], + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "vpcId": "vpc-950809ec" + }, + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "status": "ACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command provides a description of the specified cluster in your default region.", + "id": "to-describe-a-cluster-1527868708512", + "title": "To describe a cluster" + } + ], + "ListClusters": [ + { + "input": { + }, + "output": { + "clusters": [ + "devel", + "prod" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command lists all of your available clusters in your default region.", + "id": "to-list-your-available-clusters-1527868801040", + "title": "To list your available clusters" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/eks-2017-11-01.min.json b/node_modules/aws-sdk/apis/eks-2017-11-01.min.json new file mode 100644 index 0000000..6bece82 --- /dev/null +++ b/node_modules/aws-sdk/apis/eks-2017-11-01.min.json @@ -0,0 +1,384 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-11-01", + "endpointPrefix": "eks", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "Amazon EKS", + "serviceFullName": "Amazon Elastic Container Service for Kubernetes", + "serviceId": "EKS", + "signatureVersion": "v4", + "signingName": "eks", + "uid": "eks-2017-11-01" + }, + "operations": { + "CreateCluster": { + "http": { + "requestUri": "/clusters" + }, + "input": { + "type": "structure", + "required": [ + "name", + "roleArn", + "resourcesVpcConfig" + ], + "members": { + "name": {}, + "version": {}, + "roleArn": {}, + "resourcesVpcConfig": { + "shape": "S4" + }, + "logging": { + "shape": "S7" + }, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "cluster": { + "shape": "Sd" + } + } + } + }, + "DeleteCluster": { + "http": { + "method": "DELETE", + "requestUri": "/clusters/{name}" + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": { + "cluster": { + "shape": "Sd" + } + } + } + }, + "DescribeCluster": { + "http": { + "method": "GET", + "requestUri": "/clusters/{name}" + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": { + "cluster": { + "shape": "Sd" + } + } + } + }, + "DescribeUpdate": { + "http": { + "method": "GET", + "requestUri": "/clusters/{name}/updates/{updateId}" + }, + "input": { + "type": "structure", + "required": [ + "name", + "updateId" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "updateId": { + "location": "uri", + "locationName": "updateId" + } + } + }, + "output": { + "type": "structure", + "members": { + "update": { + "shape": "Sp" + } + } + } + }, + "ListClusters": { + "http": { + "method": "GET", + "requestUri": "/clusters" + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "clusters": { + "shape": "S5" + }, + "nextToken": {} + } + } + }, + "ListUpdates": { + "http": { + "method": "GET", + "requestUri": "/clusters/{name}/updates" + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "updateIds": { + "shape": "S5" + }, + "nextToken": {} + } + } + }, + "UpdateClusterConfig": { + "http": { + "requestUri": "/clusters/{name}/update-config" + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "resourcesVpcConfig": { + "shape": "S4" + }, + "logging": { + "shape": "S7" + }, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "update": { + "shape": "Sp" + } + } + } + }, + "UpdateClusterVersion": { + "http": { + "requestUri": "/clusters/{name}/updates" + }, + "input": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "version": {}, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "update": { + "shape": "Sp" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "subnetIds": { + "shape": "S5" + }, + "securityGroupIds": { + "shape": "S5" + }, + "endpointPublicAccess": { + "type": "boolean" + }, + "endpointPrivateAccess": { + "type": "boolean" + } + } + }, + "S5": { + "type": "list", + "member": {} + }, + "S7": { + "type": "structure", + "members": { + "clusterLogging": { + "type": "list", + "member": { + "type": "structure", + "members": { + "types": { + "type": "list", + "member": {} + }, + "enabled": { + "type": "boolean" + } + } + } + } + } + }, + "Sd": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "createdAt": { + "type": "timestamp" + }, + "version": {}, + "endpoint": {}, + "roleArn": {}, + "resourcesVpcConfig": { + "type": "structure", + "members": { + "subnetIds": { + "shape": "S5" + }, + "securityGroupIds": { + "shape": "S5" + }, + "vpcId": {}, + "endpointPublicAccess": { + "type": "boolean" + }, + "endpointPrivateAccess": { + "type": "boolean" + } + } + }, + "logging": { + "shape": "S7" + }, + "status": {}, + "certificateAuthority": { + "type": "structure", + "members": { + "data": {} + } + }, + "clientRequestToken": {}, + "platformVersion": {} + } + }, + "Sp": { + "type": "structure", + "members": { + "id": {}, + "status": {}, + "type": {}, + "params": { + "type": "list", + "member": { + "type": "structure", + "members": { + "type": {}, + "value": {} + } + } + }, + "createdAt": { + "type": "timestamp" + }, + "errors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "errorCode": {}, + "errorMessage": {}, + "resourceIds": { + "shape": "S5" + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/eks-2017-11-01.paginators.json b/node_modules/aws-sdk/apis/eks-2017-11-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/eks-2017-11-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/eks-2017-11-01.waiters2.json b/node_modules/aws-sdk/apis/eks-2017-11-01.waiters2.json new file mode 100644 index 0000000..c325e52 --- /dev/null +++ b/node_modules/aws-sdk/apis/eks-2017-11-01.waiters2.json @@ -0,0 +1,54 @@ +{ + "version": 2, + "waiters": { + "ClusterActive": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "DELETING", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "FAILED", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "ACTIVE", + "matcher": "path", + "state": "success", + "argument": "cluster.status" + } + ] + }, + "ClusterDeleted": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "ACTIVE", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "CREATING", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json b/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json new file mode 100644 index 0000000..61357c8 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json @@ -0,0 +1,1779 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-02-02", + "endpointPrefix": "elasticache", + "protocol": "query", + "serviceFullName": "Amazon ElastiCache", + "serviceId": "ElastiCache", + "signatureVersion": "v4", + "uid": "elasticache-2015-02-02", + "xmlNamespace": "http://elasticache.amazonaws.com/doc/2015-02-02/" + }, + "operations": { + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "shape": "S5", + "resultWrapper": "AddTagsToResourceResult" + } + }, + "AuthorizeCacheSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members": { + "CacheSecurityGroupName": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "AuthorizeCacheSecurityGroupIngressResult", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape": "S8" + } + } + } + }, + "CopySnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceSnapshotName", + "TargetSnapshotName" + ], + "members": { + "SourceSnapshotName": {}, + "TargetSnapshotName": {}, + "TargetBucket": {} + } + }, + "output": { + "resultWrapper": "CopySnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sd" + } + } + } + }, + "CreateCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId" + ], + "members": { + "CacheClusterId": {}, + "ReplicationGroupId": {}, + "AZMode": {}, + "PreferredAvailabilityZone": {}, + "PreferredAvailabilityZones": { + "shape": "Sp" + }, + "NumCacheNodes": { + "type": "integer" + }, + "CacheNodeType": {}, + "Engine": {}, + "EngineVersion": {}, + "CacheParameterGroupName": {}, + "CacheSubnetGroupName": {}, + "CacheSecurityGroupNames": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "Sr" + }, + "Tags": { + "shape": "S3" + }, + "SnapshotArns": { + "shape": "Ss" + }, + "SnapshotName": {}, + "PreferredMaintenanceWindow": {}, + "Port": { + "type": "integer" + }, + "NotificationTopicArn": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "AuthToken": {} + } + }, + "output": { + "resultWrapper": "CreateCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sv" + } + } + } + }, + "CreateCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName", + "CacheParameterGroupFamily", + "Description" + ], + "members": { + "CacheParameterGroupName": {}, + "CacheParameterGroupFamily": {}, + "Description": {} + } + }, + "output": { + "resultWrapper": "CreateCacheParameterGroupResult", + "type": "structure", + "members": { + "CacheParameterGroup": { + "shape": "S1a" + } + } + } + }, + "CreateCacheSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName", + "Description" + ], + "members": { + "CacheSecurityGroupName": {}, + "Description": {} + } + }, + "output": { + "resultWrapper": "CreateCacheSecurityGroupResult", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape": "S8" + } + } + } + }, + "CreateCacheSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSubnetGroupName", + "CacheSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "CacheSubnetGroupName": {}, + "CacheSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1e" + } + } + }, + "output": { + "resultWrapper": "CreateCacheSubnetGroupResult", + "type": "structure", + "members": { + "CacheSubnetGroup": { + "shape": "S1g" + } + } + } + }, + "CreateReplicationGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId", + "ReplicationGroupDescription" + ], + "members": { + "ReplicationGroupId": {}, + "ReplicationGroupDescription": {}, + "PrimaryClusterId": {}, + "AutomaticFailoverEnabled": { + "type": "boolean" + }, + "NumCacheClusters": { + "type": "integer" + }, + "PreferredCacheClusterAZs": { + "shape": "Sm" + }, + "NumNodeGroups": { + "type": "integer" + }, + "ReplicasPerNodeGroup": { + "type": "integer" + }, + "NodeGroupConfiguration": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "NodeGroupConfiguration" + } + }, + "CacheNodeType": {}, + "Engine": {}, + "EngineVersion": {}, + "CacheParameterGroupName": {}, + "CacheSubnetGroupName": {}, + "CacheSecurityGroupNames": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "Sr" + }, + "Tags": { + "shape": "S3" + }, + "SnapshotArns": { + "shape": "Ss" + }, + "SnapshotName": {}, + "PreferredMaintenanceWindow": {}, + "Port": { + "type": "integer" + }, + "NotificationTopicArn": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "AuthToken": {}, + "TransitEncryptionEnabled": { + "type": "boolean" + }, + "AtRestEncryptionEnabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateReplicationGroupResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1n" + } + } + } + }, + "CreateSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotName" + ], + "members": { + "ReplicationGroupId": {}, + "CacheClusterId": {}, + "SnapshotName": {} + } + }, + "output": { + "resultWrapper": "CreateSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sd" + } + } + } + }, + "DecreaseReplicaCount": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId", + "ApplyImmediately" + ], + "members": { + "ReplicationGroupId": {}, + "NewReplicaCount": { + "type": "integer" + }, + "ReplicaConfiguration": { + "shape": "S21" + }, + "ReplicasToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DecreaseReplicaCountResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1n" + } + } + } + }, + "DeleteCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId" + ], + "members": { + "CacheClusterId": {}, + "FinalSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sv" + } + } + } + }, + "DeleteCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName" + ], + "members": { + "CacheParameterGroupName": {} + } + } + }, + "DeleteCacheSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName" + ], + "members": { + "CacheSecurityGroupName": {} + } + } + }, + "DeleteCacheSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSubnetGroupName" + ], + "members": { + "CacheSubnetGroupName": {} + } + } + }, + "DeleteReplicationGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId" + ], + "members": { + "ReplicationGroupId": {}, + "RetainPrimaryCluster": { + "type": "boolean" + }, + "FinalSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteReplicationGroupResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1n" + } + } + } + }, + "DeleteSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotName" + ], + "members": { + "SnapshotName": {} + } + }, + "output": { + "resultWrapper": "DeleteSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sd" + } + } + } + }, + "DescribeCacheClusters": { + "input": { + "type": "structure", + "members": { + "CacheClusterId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "ShowCacheNodeInfo": { + "type": "boolean" + }, + "ShowCacheClustersNotInReplicationGroups": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeCacheClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheClusters": { + "type": "list", + "member": { + "shape": "Sv", + "locationName": "CacheCluster" + } + } + } + } + }, + "DescribeCacheEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "CacheParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeCacheEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheEngineVersions": { + "type": "list", + "member": { + "locationName": "CacheEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "CacheParameterGroupFamily": {}, + "CacheEngineDescription": {}, + "CacheEngineVersionDescription": {} + } + } + } + } + } + }, + "DescribeCacheParameterGroups": { + "input": { + "type": "structure", + "members": { + "CacheParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheParameterGroups": { + "type": "list", + "member": { + "shape": "S1a", + "locationName": "CacheParameterGroup" + } + } + } + } + }, + "DescribeCacheParameters": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName" + ], + "members": { + "CacheParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheParametersResult", + "type": "structure", + "members": { + "Marker": {}, + "Parameters": { + "shape": "S2q" + }, + "CacheNodeTypeSpecificParameters": { + "shape": "S2t" + } + } + } + }, + "DescribeCacheSecurityGroups": { + "input": { + "type": "structure", + "members": { + "CacheSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheSecurityGroups": { + "type": "list", + "member": { + "shape": "S8", + "locationName": "CacheSecurityGroup" + } + } + } + } + }, + "DescribeCacheSubnetGroups": { + "input": { + "type": "structure", + "members": { + "CacheSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheSubnetGroups": { + "type": "list", + "member": { + "shape": "S1g", + "locationName": "CacheSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupFamily" + ], + "members": { + "CacheParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "CacheParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2q" + }, + "CacheNodeTypeSpecificParameters": { + "shape": "S2t" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeReplicationGroups": { + "input": { + "type": "structure", + "members": { + "ReplicationGroupId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReplicationGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReplicationGroups": { + "type": "list", + "member": { + "shape": "S1n", + "locationName": "ReplicationGroup" + } + } + } + } + }, + "DescribeReservedCacheNodes": { + "input": { + "type": "structure", + "members": { + "ReservedCacheNodeId": {}, + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedCacheNodesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedCacheNodes": { + "type": "list", + "member": { + "shape": "S3h", + "locationName": "ReservedCacheNode" + } + } + } + } + }, + "DescribeReservedCacheNodesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedCacheNodesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedCacheNodesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedCacheNodesOffering", + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "ProductDescription": {}, + "OfferingType": {}, + "RecurringCharges": { + "shape": "S3i" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeSnapshots": { + "input": { + "type": "structure", + "members": { + "ReplicationGroupId": {}, + "CacheClusterId": {}, + "SnapshotName": {}, + "SnapshotSource": {}, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "ShowNodeGroupConfig": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "Snapshots": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "Snapshot" + } + } + } + } + }, + "IncreaseReplicaCount": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId", + "ApplyImmediately" + ], + "members": { + "ReplicationGroupId": {}, + "NewReplicaCount": { + "type": "integer" + }, + "ReplicaConfiguration": { + "shape": "S21" + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "IncreaseReplicaCountResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1n" + } + } + } + }, + "ListAllowedNodeTypeModifications": { + "input": { + "type": "structure", + "members": { + "CacheClusterId": {}, + "ReplicationGroupId": {} + } + }, + "output": { + "resultWrapper": "ListAllowedNodeTypeModificationsResult", + "type": "structure", + "members": { + "ScaleUpModifications": { + "type": "list", + "member": {} + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {} + } + }, + "output": { + "shape": "S5", + "resultWrapper": "ListTagsForResourceResult" + } + }, + "ModifyCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId" + ], + "members": { + "CacheClusterId": {}, + "NumCacheNodes": { + "type": "integer" + }, + "CacheNodeIdsToRemove": { + "shape": "Sz" + }, + "AZMode": {}, + "NewAvailabilityZones": { + "shape": "Sp" + }, + "CacheSecurityGroupNames": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "Sr" + }, + "PreferredMaintenanceWindow": {}, + "NotificationTopicArn": {}, + "CacheParameterGroupName": {}, + "NotificationTopicStatus": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "CacheNodeType": {} + } + }, + "output": { + "resultWrapper": "ModifyCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sv" + } + } + } + }, + "ModifyCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members": { + "CacheParameterGroupName": {}, + "ParameterNameValues": { + "shape": "S40" + } + } + }, + "output": { + "shape": "S42", + "resultWrapper": "ModifyCacheParameterGroupResult" + } + }, + "ModifyCacheSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSubnetGroupName" + ], + "members": { + "CacheSubnetGroupName": {}, + "CacheSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1e" + } + } + }, + "output": { + "resultWrapper": "ModifyCacheSubnetGroupResult", + "type": "structure", + "members": { + "CacheSubnetGroup": { + "shape": "S1g" + } + } + } + }, + "ModifyReplicationGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId" + ], + "members": { + "ReplicationGroupId": {}, + "ReplicationGroupDescription": {}, + "PrimaryClusterId": {}, + "SnapshottingClusterId": {}, + "AutomaticFailoverEnabled": { + "type": "boolean" + }, + "CacheSecurityGroupNames": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "Sr" + }, + "PreferredMaintenanceWindow": {}, + "NotificationTopicArn": {}, + "CacheParameterGroupName": {}, + "NotificationTopicStatus": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "CacheNodeType": {}, + "NodeGroupId": { + "deprecated": true + } + } + }, + "output": { + "resultWrapper": "ModifyReplicationGroupResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1n" + } + } + } + }, + "ModifyReplicationGroupShardConfiguration": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId", + "NodeGroupCount", + "ApplyImmediately" + ], + "members": { + "ReplicationGroupId": {}, + "NodeGroupCount": { + "type": "integer" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "ReshardingConfiguration": { + "type": "list", + "member": { + "locationName": "ReshardingConfiguration", + "type": "structure", + "members": { + "NodeGroupId": {}, + "PreferredAvailabilityZones": { + "shape": "Sm" + } + } + } + }, + "NodeGroupsToRemove": { + "type": "list", + "member": { + "locationName": "NodeGroupToRemove" + } + }, + "NodeGroupsToRetain": { + "type": "list", + "member": { + "locationName": "NodeGroupToRetain" + } + } + } + }, + "output": { + "resultWrapper": "ModifyReplicationGroupShardConfigurationResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1n" + } + } + } + }, + "PurchaseReservedCacheNodesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedCacheNodesOfferingId" + ], + "members": { + "ReservedCacheNodesOfferingId": {}, + "ReservedCacheNodeId": {}, + "CacheNodeCount": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "PurchaseReservedCacheNodesOfferingResult", + "type": "structure", + "members": { + "ReservedCacheNode": { + "shape": "S3h" + } + } + } + }, + "RebootCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId", + "CacheNodeIdsToReboot" + ], + "members": { + "CacheClusterId": {}, + "CacheNodeIdsToReboot": { + "shape": "Sz" + } + } + }, + "output": { + "resultWrapper": "RebootCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sv" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "shape": "S5", + "resultWrapper": "RemoveTagsFromResourceResult" + } + }, + "ResetCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName" + ], + "members": { + "CacheParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "ParameterNameValues": { + "shape": "S40" + } + } + }, + "output": { + "shape": "S42", + "resultWrapper": "ResetCacheParameterGroupResult" + } + }, + "RevokeCacheSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members": { + "CacheSecurityGroupName": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "RevokeCacheSecurityGroupIngressResult", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape": "S8" + } + } + } + }, + "TestFailover": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId", + "NodeGroupId" + ], + "members": { + "ReplicationGroupId": {}, + "NodeGroupId": {} + } + }, + "output": { + "resultWrapper": "TestFailoverResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1n" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S5": { + "type": "structure", + "members": { + "TagList": { + "shape": "S3" + } + } + }, + "S8": { + "type": "structure", + "members": { + "OwnerId": {}, + "CacheSecurityGroupName": {}, + "Description": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + } + } + }, + "wrapper": true + }, + "Sd": { + "type": "structure", + "members": { + "SnapshotName": {}, + "ReplicationGroupId": {}, + "ReplicationGroupDescription": {}, + "CacheClusterId": {}, + "SnapshotStatus": {}, + "SnapshotSource": {}, + "CacheNodeType": {}, + "Engine": {}, + "EngineVersion": {}, + "NumCacheNodes": { + "type": "integer" + }, + "PreferredAvailabilityZone": {}, + "CacheClusterCreateTime": { + "type": "timestamp" + }, + "PreferredMaintenanceWindow": {}, + "TopicArn": {}, + "Port": { + "type": "integer" + }, + "CacheParameterGroupName": {}, + "CacheSubnetGroupName": {}, + "VpcId": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "NumNodeGroups": { + "type": "integer" + }, + "AutomaticFailover": {}, + "NodeSnapshots": { + "type": "list", + "member": { + "locationName": "NodeSnapshot", + "type": "structure", + "members": { + "CacheClusterId": {}, + "NodeGroupId": {}, + "CacheNodeId": {}, + "NodeGroupConfiguration": { + "shape": "Sk" + }, + "CacheSize": {}, + "CacheNodeCreateTime": { + "type": "timestamp" + }, + "SnapshotCreateTime": { + "type": "timestamp" + } + }, + "wrapper": true + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "NodeGroupId": {}, + "Slots": {}, + "ReplicaCount": { + "type": "integer" + }, + "PrimaryAvailabilityZone": {}, + "ReplicaAvailabilityZones": { + "shape": "Sm" + } + } + }, + "Sm": { + "type": "list", + "member": { + "locationName": "AvailabilityZone" + } + }, + "Sp": { + "type": "list", + "member": { + "locationName": "PreferredAvailabilityZone" + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "CacheSecurityGroupName" + } + }, + "Sr": { + "type": "list", + "member": { + "locationName": "SecurityGroupId" + } + }, + "Ss": { + "type": "list", + "member": { + "locationName": "SnapshotArn" + } + }, + "Sv": { + "type": "structure", + "members": { + "CacheClusterId": {}, + "ConfigurationEndpoint": { + "shape": "Sw" + }, + "ClientDownloadLandingPage": {}, + "CacheNodeType": {}, + "Engine": {}, + "EngineVersion": {}, + "CacheClusterStatus": {}, + "NumCacheNodes": { + "type": "integer" + }, + "PreferredAvailabilityZone": {}, + "CacheClusterCreateTime": { + "type": "timestamp" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "NumCacheNodes": { + "type": "integer" + }, + "CacheNodeIdsToRemove": { + "shape": "Sz" + }, + "EngineVersion": {}, + "CacheNodeType": {} + } + }, + "NotificationConfiguration": { + "type": "structure", + "members": { + "TopicArn": {}, + "TopicStatus": {} + } + }, + "CacheSecurityGroups": { + "type": "list", + "member": { + "locationName": "CacheSecurityGroup", + "type": "structure", + "members": { + "CacheSecurityGroupName": {}, + "Status": {} + } + } + }, + "CacheParameterGroup": { + "type": "structure", + "members": { + "CacheParameterGroupName": {}, + "ParameterApplyStatus": {}, + "CacheNodeIdsToReboot": { + "shape": "Sz" + } + } + }, + "CacheSubnetGroupName": {}, + "CacheNodes": { + "type": "list", + "member": { + "locationName": "CacheNode", + "type": "structure", + "members": { + "CacheNodeId": {}, + "CacheNodeStatus": {}, + "CacheNodeCreateTime": { + "type": "timestamp" + }, + "Endpoint": { + "shape": "Sw" + }, + "ParameterGroupStatus": {}, + "SourceCacheNodeId": {}, + "CustomerAvailabilityZone": {} + } + } + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SecurityGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SecurityGroupId": {}, + "Status": {} + } + } + }, + "ReplicationGroupId": {}, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "AuthTokenEnabled": { + "type": "boolean" + }, + "TransitEncryptionEnabled": { + "type": "boolean" + }, + "AtRestEncryptionEnabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "Sw": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "Sz": { + "type": "list", + "member": { + "locationName": "CacheNodeId" + } + }, + "S1a": { + "type": "structure", + "members": { + "CacheParameterGroupName": {}, + "CacheParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1e": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1g": { + "type": "structure", + "members": { + "CacheSubnetGroupName": {}, + "CacheSubnetGroupDescription": {}, + "VpcId": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + } + } + } + } + }, + "wrapper": true + }, + "S1n": { + "type": "structure", + "members": { + "ReplicationGroupId": {}, + "Description": {}, + "Status": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "PrimaryClusterId": {}, + "AutomaticFailoverStatus": {}, + "Resharding": { + "type": "structure", + "members": { + "SlotMigration": { + "type": "structure", + "members": { + "ProgressPercentage": { + "type": "double" + } + } + } + } + } + } + }, + "MemberClusters": { + "type": "list", + "member": { + "locationName": "ClusterId" + } + }, + "NodeGroups": { + "type": "list", + "member": { + "locationName": "NodeGroup", + "type": "structure", + "members": { + "NodeGroupId": {}, + "Status": {}, + "PrimaryEndpoint": { + "shape": "Sw" + }, + "Slots": {}, + "NodeGroupMembers": { + "type": "list", + "member": { + "locationName": "NodeGroupMember", + "type": "structure", + "members": { + "CacheClusterId": {}, + "CacheNodeId": {}, + "ReadEndpoint": { + "shape": "Sw" + }, + "PreferredAvailabilityZone": {}, + "CurrentRole": {} + } + } + } + } + } + }, + "SnapshottingClusterId": {}, + "AutomaticFailover": {}, + "ConfigurationEndpoint": { + "shape": "Sw" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "ClusterEnabled": { + "type": "boolean" + }, + "CacheNodeType": {}, + "AuthTokenEnabled": { + "type": "boolean" + }, + "TransitEncryptionEnabled": { + "type": "boolean" + }, + "AtRestEncryptionEnabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S21": { + "type": "list", + "member": { + "locationName": "ConfigureShard", + "type": "structure", + "required": [ + "NodeGroupId", + "NewReplicaCount" + ], + "members": { + "NodeGroupId": {}, + "NewReplicaCount": { + "type": "integer" + }, + "PreferredAvailabilityZones": { + "shape": "Sp" + } + } + } + }, + "S2q": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ChangeType": {} + } + } + }, + "S2t": { + "type": "list", + "member": { + "locationName": "CacheNodeTypeSpecificParameter", + "type": "structure", + "members": { + "ParameterName": {}, + "Description": {}, + "Source": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "CacheNodeTypeSpecificValues": { + "type": "list", + "member": { + "locationName": "CacheNodeTypeSpecificValue", + "type": "structure", + "members": { + "CacheNodeType": {}, + "Value": {} + } + } + }, + "ChangeType": {} + } + } + }, + "S3h": { + "type": "structure", + "members": { + "ReservedCacheNodeId": {}, + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CacheNodeCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "State": {}, + "RecurringCharges": { + "shape": "S3i" + }, + "ReservationARN": {} + }, + "wrapper": true + }, + "S3i": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S40": { + "type": "list", + "member": { + "locationName": "ParameterNameValue", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {} + } + } + }, + "S42": { + "type": "structure", + "members": { + "CacheParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticache-2015-02-02.paginators.json b/node_modules/aws-sdk/apis/elasticache-2015-02-02.paginators.json new file mode 100644 index 0000000..44f5926 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticache-2015-02-02.paginators.json @@ -0,0 +1,76 @@ +{ + "pagination": { + "DescribeCacheClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "CacheClusters" + }, + "DescribeCacheEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "CacheEngineVersions" + }, + "DescribeCacheParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "CacheParameterGroups" + }, + "DescribeCacheParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeCacheSecurityGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "CacheSecurityGroups" + }, + "DescribeCacheSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "CacheSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "EngineDefaults.Marker", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeReplicationGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReplicationGroups" + }, + "DescribeReservedCacheNodes": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedCacheNodes" + }, + "DescribeReservedCacheNodesOfferings": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedCacheNodesOfferings" + }, + "DescribeSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Snapshots" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticache-2015-02-02.waiters2.json b/node_modules/aws-sdk/apis/elasticache-2015-02-02.waiters2.json new file mode 100644 index 0000000..c177d7b --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticache-2015-02-02.waiters2.json @@ -0,0 +1,143 @@ +{ + "version":2, + "waiters":{ + "CacheClusterAvailable":{ + "acceptors":[ + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"available", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"deleted", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"incompatible-network", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"restore-failed", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until ElastiCache cluster is available.", + "maxAttempts":40, + "operation":"DescribeCacheClusters" + }, + "CacheClusterDeleted":{ + "acceptors":[ + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"deleted", + "matcher":"pathAll", + "state":"success" + }, + { + "expected":"CacheClusterNotFound", + "matcher":"error", + "state":"success" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"available", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"incompatible-network", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"restore-failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"snapshotting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until ElastiCache cluster is deleted.", + "maxAttempts":40, + "operation":"DescribeCacheClusters" + }, + "ReplicationGroupAvailable":{ + "acceptors":[ + { + "argument":"ReplicationGroups[].Status", + "expected":"available", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationGroups[].Status", + "expected":"deleted", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until ElastiCache replication group is available.", + "maxAttempts":40, + "operation":"DescribeReplicationGroups" + }, + "ReplicationGroupDeleted":{ + "acceptors":[ + { + "argument":"ReplicationGroups[].Status", + "expected":"deleted", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationGroups[].Status", + "expected":"available", + "matcher":"pathAny", + "state":"failure" + }, + { + "expected":"ReplicationGroupNotFoundFault", + "matcher":"error", + "state":"success" + } + ], + "delay":15, + "description":"Wait until ElastiCache replication group is deleted.", + "maxAttempts":40, + "operation":"DescribeReplicationGroups" + } + } +} diff --git a/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.examples.json b/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.examples.json new file mode 100644 index 0000000..0fded62 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.examples.json @@ -0,0 +1,1109 @@ +{ + "version": "1.0", + "examples": { + "AbortEnvironmentUpdate": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following code aborts a running application version deployment for an environment named my-env:", + "id": "to-abort-a-deployment-1456267848227", + "title": "To abort a deployment" + } + ], + "CheckDNSAvailability": [ + { + "input": { + "CNAMEPrefix": "my-cname" + }, + "output": { + "Available": true, + "FullyQualifiedCNAME": "my-cname.us-west-2.elasticbeanstalk.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation checks the availability of the subdomain my-cname:", + "id": "to-check-the-availability-of-a-cname-1456268589537", + "title": "To check the availability of a CNAME" + } + ], + "CreateApplication": [ + { + "input": { + "ApplicationName": "my-app", + "Description": "my application" + }, + "output": { + "Application": { + "ApplicationName": "my-app", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-02-12T18:32:21.181Z", + "DateUpdated": "2015-02-12T18:32:21.181Z", + "Description": "my application" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new application named my-app:", + "id": "to-create-a-new-application-1456268895683", + "title": "To create a new application" + } + ], + "CreateApplicationVersion": [ + { + "input": { + "ApplicationName": "my-app", + "AutoCreateApplication": true, + "Description": "my-app-v1", + "Process": true, + "SourceBundle": { + "S3Bucket": "my-bucket", + "S3Key": "sample.war" + }, + "VersionLabel": "v1" + }, + "output": { + "ApplicationVersion": { + "ApplicationName": "my-app", + "DateCreated": "2015-02-03T23:01:25.412Z", + "DateUpdated": "2015-02-03T23:01:25.412Z", + "Description": "my-app-v1", + "SourceBundle": { + "S3Bucket": "my-bucket", + "S3Key": "sample.war" + }, + "VersionLabel": "v1" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new version (v1) of an application named my-app:", + "id": "to-create-a-new-application-1456268895683", + "title": "To create a new application" + } + ], + "CreateConfigurationTemplate": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentId": "e-rpqsewtp2j", + "TemplateName": "my-app-v1" + }, + "output": { + "ApplicationName": "my-app", + "DateCreated": "2015-08-12T18:40:39Z", + "DateUpdated": "2015-08-12T18:40:39Z", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "TemplateName": "my-app-v1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:", + "id": "to-create-a-configuration-template-1456269283586", + "title": "To create a configuration template" + } + ], + "CreateEnvironment": [ + { + "input": { + "ApplicationName": "my-app", + "CNAMEPrefix": "my-app", + "EnvironmentName": "my-env", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "VersionLabel": "v1" + }, + "output": { + "ApplicationName": "my-app", + "CNAME": "my-app.elasticbeanstalk.com", + "DateCreated": "2015-02-03T23:04:54.479Z", + "DateUpdated": "2015-02-03T23:04:54.479Z", + "EnvironmentId": "e-izqpassy4h", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Launching", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "v1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new environment for version v1 of a java application named my-app:", + "id": "to-create-a-new-environment-for-an-application-1456269380396", + "title": "To create a new environment for an application" + } + ], + "CreateStorageLocation": [ + { + "output": { + "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new environment for version v1 of a java application named my-app:", + "id": "to-create-a-new-environment-for-an-application-1456269380396", + "title": "To create a new environment for an application" + } + ], + "DeleteApplication": [ + { + "input": { + "ApplicationName": "my-app" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes an application named my-app:", + "id": "to-delete-an-application-1456269699366", + "title": "To delete an application" + } + ], + "DeleteApplicationVersion": [ + { + "input": { + "ApplicationName": "my-app", + "DeleteSourceBundle": true, + "VersionLabel": "22a0-stage-150819_182129" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:", + "id": "to-delete-an-application-version-1456269792956", + "title": "To delete an application version" + } + ], + "DeleteConfigurationTemplate": [ + { + "input": { + "ApplicationName": "my-app", + "TemplateName": "my-template" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes a configuration template named my-template for an application named my-app:", + "id": "to-delete-a-configuration-template-1456269836701", + "title": "To delete a configuration template" + } + ], + "DeleteEnvironmentConfiguration": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes a draft configuration for an environment named my-env:", + "id": "to-delete-a-draft-configuration-1456269886654", + "title": "To delete a draft configuration" + } + ], + "DescribeApplicationVersions": [ + { + "input": { + "ApplicationName": "my-app", + "VersionLabels": [ + "v2" + ] + }, + "output": { + "ApplicationVersions": [ + { + "ApplicationName": "my-app", + "DateCreated": "2015-07-23T01:32:26.079Z", + "DateUpdated": "2015-07-23T01:32:26.079Z", + "Description": "update cover page", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", + "S3Key": "my-app/5026-stage-150723_224258.war" + }, + "VersionLabel": "v2" + }, + { + "ApplicationName": "my-app", + "DateCreated": "2015-07-23T22:26:10.816Z", + "DateUpdated": "2015-07-23T22:26:10.816Z", + "Description": "initial version", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", + "S3Key": "my-app/5026-stage-150723_222618.war" + }, + "VersionLabel": "v1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about an application version labeled v2:", + "id": "to-view-information-about-an-application-version-1456269947428", + "title": "To view information about an application version" + } + ], + "DescribeApplications": [ + { + "input": { + }, + "output": { + "Applications": [ + { + "ApplicationName": "ruby", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-13T21:05:44.376Z", + "DateUpdated": "2015-08-13T21:05:44.376Z", + "Versions": [ + "Sample Application" + ] + }, + { + "ApplicationName": "pythonsample", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-13T19:05:43.637Z", + "DateUpdated": "2015-08-13T19:05:43.637Z", + "Description": "Application created from the EB CLI using \"eb init\"", + "Versions": [ + "Sample Application" + ] + }, + { + "ApplicationName": "nodejs-example", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-06T17:50:02.486Z", + "DateUpdated": "2015-08-06T17:50:02.486Z", + "Versions": [ + "add elasticache", + "First Release" + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about applications in the current region:", + "id": "to-view-a-list-of-applications-1456270027373", + "title": "To view a list of applications" + } + ], + "DescribeConfigurationOptions": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env" + }, + "output": { + "Options": [ + { + "ChangeSeverity": "NoInterruption", + "DefaultValue": "30", + "MaxValue": 300, + "MinValue": 5, + "Name": "Interval", + "Namespace": "aws:elb:healthcheck", + "UserDefined": false, + "ValueType": "Scalar" + }, + { + "ChangeSeverity": "NoInterruption", + "DefaultValue": "2000000", + "MinValue": 0, + "Name": "LowerThreshold", + "Namespace": "aws:autoscaling:trigger", + "UserDefined": false, + "ValueType": "Scalar" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves descriptions of all available configuration options for an environment named my-env:", + "id": "to-view-configuration-options-for-an-environment-1456276763917", + "title": "To view configuration options for an environment" + } + ], + "DescribeConfigurationSettings": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env" + }, + "output": { + "ConfigurationSettings": [ + { + "ApplicationName": "my-app", + "DateCreated": "2015-08-13T19:16:25Z", + "DateUpdated": "2015-08-13T23:30:07Z", + "DeploymentStatus": "deployed", + "Description": "Environment created from the EB CLI using \"eb create\"", + "EnvironmentName": "my-env", + "OptionSettings": [ + { + "Namespace": "aws:autoscaling:asg", + "OptionName": "Availability Zones", + "ResourceName": "AWSEBAutoScalingGroup", + "Value": "Any" + }, + { + "Namespace": "aws:autoscaling:asg", + "OptionName": "Cooldown", + "ResourceName": "AWSEBAutoScalingGroup", + "Value": "360" + }, + { + "Namespace": "aws:elb:policies", + "OptionName": "ConnectionDrainingTimeout", + "ResourceName": "AWSEBLoadBalancer", + "Value": "20" + }, + { + "Namespace": "aws:elb:policies", + "OptionName": "ConnectionSettingIdleTimeout", + "ResourceName": "AWSEBLoadBalancer", + "Value": "60" + } + ], + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" + } + ] + }, + "comments": { + "input": { + }, + "output": { + "abbreviated": "Output is abbreviated" + } + }, + "description": "The following operation retrieves configuration settings for an environment named my-env:", + "id": "to-view-configurations-settings-for-an-environment-1456276924537", + "title": "To view configurations settings for an environment" + } + ], + "DescribeEnvironmentHealth": [ + { + "input": { + "AttributeNames": [ + "All" + ], + "EnvironmentName": "my-env" + }, + "output": { + "ApplicationMetrics": { + "Duration": 10, + "Latency": { + "P10": 0.001, + "P50": 0.001, + "P75": 0.002, + "P85": 0.003, + "P90": 0.003, + "P95": 0.004, + "P99": 0.004, + "P999": 0.004 + }, + "RequestCount": 45, + "StatusCodes": { + "Status2xx": 45, + "Status3xx": 0, + "Status4xx": 0, + "Status5xx": 0 + } + }, + "Causes": [ + + ], + "Color": "Green", + "EnvironmentName": "my-env", + "HealthStatus": "Ok", + "InstancesHealth": { + "Degraded": 0, + "Info": 0, + "NoData": 0, + "Ok": 1, + "Pending": 0, + "Severe": 0, + "Unknown": 0, + "Warning": 0 + }, + "RefreshedAt": "2015-08-20T21:09:18Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves overall health information for an environment named my-env:", + "id": "to-view-environment-health-1456277109510", + "title": "To view environment health" + } + ], + "DescribeEnvironmentResources": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "output": { + "EnvironmentResources": { + "AutoScalingGroups": [ + { + "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT" + } + ], + "EnvironmentName": "my-env", + "Instances": [ + { + "Id": "i-0c91c786" + } + ], + "LaunchConfigurations": [ + { + "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2" + } + ], + "LoadBalancers": [ + { + "Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0" + } + ], + "Queues": [ + + ], + "Triggers": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about resources in an environment named my-env:", + "id": "to-view-information-about-the-aws-resources-in-your-environment-1456277206232", + "title": "To view information about the AWS resources in your environment" + } + ], + "DescribeEnvironments": [ + { + "input": { + "EnvironmentNames": [ + "my-env" + ] + }, + "output": { + "Environments": [ + { + "AbortableOperationInProgress": false, + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-08-07T20:48:49.599Z", + "DateUpdated": "2015-08-12T18:16:55.019Z", + "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com", + "EnvironmentId": "e-rpqsewtp2j", + "EnvironmentName": "my-env", + "Health": "Green", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Ready", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "7f58-stage-150812_025409" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about an environment named my-env:", + "id": "to-view-information-about-an-environment-1456277288662", + "title": "To view information about an environment" + } + ], + "DescribeEvents": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "output": { + "Events": [ + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-20T07:06:53.535Z", + "Message": "Environment health has transitioned from Info to Ok.", + "Severity": "INFO" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-20T07:06:02.049Z", + "Message": "Environment update completed successfully.", + "RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41", + "Severity": "INFO" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-13T19:16:27.561Z", + "Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.", + "RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b", + "Severity": "INFO" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-13T19:16:26.581Z", + "Message": "createEnvironment is starting.", + "RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b", + "Severity": "INFO" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves events for an environment named my-env:", + "id": "to-view-events-for-an-environment-1456277367589", + "title": "To view events for an environment" + } + ], + "DescribeInstancesHealth": [ + { + "input": { + "AttributeNames": [ + "All" + ], + "EnvironmentName": "my-env" + }, + "output": { + "InstanceHealthList": [ + { + "ApplicationMetrics": { + "Duration": 10, + "Latency": { + "P10": 0, + "P50": 0.001, + "P75": 0.002, + "P85": 0.003, + "P90": 0.004, + "P95": 0.005, + "P99": 0.006, + "P999": 0.006 + }, + "RequestCount": 48, + "StatusCodes": { + "Status2xx": 47, + "Status3xx": 0, + "Status4xx": 1, + "Status5xx": 0 + } + }, + "Causes": [ + + ], + "Color": "Green", + "HealthStatus": "Ok", + "InstanceId": "i-08691cc7", + "LaunchedAt": "2015-08-13T19:17:09Z", + "System": { + "CPUUtilization": { + "IOWait": 0.2, + "IRQ": 0, + "Idle": 97.8, + "Nice": 0.1, + "SoftIRQ": 0.1, + "System": 0.3, + "User": 1.5 + }, + "LoadAverage": [ + 0, + 0.02, + 0.05 + ] + } + } + ], + "RefreshedAt": "2015-08-20T21:09:08Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves health information for instances in an environment named my-env:", + "id": "to-view-environment-health-1456277424757", + "title": "To view environment health" + } + ], + "ListAvailableSolutionStacks": [ + { + "output": { + "SolutionStackDetails": [ + { + "PermittedFileTypes": [ + "zip" + ], + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js" + } + ], + "SolutionStacks": [ + "64bit Amazon Linux 2015.03 v2.0.0 running Node.js", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4", + "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4", + "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7", + "64bit Amazon Linux 2015.03 v2.0.0 running Python", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6", + "64bit Windows Server Core 2012 R2 running IIS 8.5", + "64bit Windows Server 2012 R2 running IIS 8.5", + "64bit Windows Server 2012 running IIS 8", + "64bit Windows Server 2008 R2 running IIS 7.5", + "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2", + "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)", + "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:", + "id": "to-view-solution-stacks-1456277504811", + "title": "To view solution stacks" + } + ], + "RebuildEnvironment": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation terminates and recreates the resources in an environment named my-env:", + "id": "to-rebuild-an-environment-1456277600918", + "title": "To rebuild an environment" + } + ], + "RequestEnvironmentInfo": [ + { + "input": { + "EnvironmentName": "my-env", + "InfoType": "tail" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation requests logs from an environment named my-env:", + "id": "to-request-tailed-logs-1456277657045", + "title": "To request tailed logs" + } + ], + "RestartAppServer": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation restarts application servers on all instances in an environment named my-env:", + "id": "to-restart-application-servers-1456277739302", + "title": "To restart application servers" + } + ], + "RetrieveEnvironmentInfo": [ + { + "input": { + "EnvironmentName": "my-env", + "InfoType": "tail" + }, + "output": { + "EnvironmentInfo": [ + { + "Ec2InstanceId": "i-09c1c867", + "InfoType": "tail", + "Message": "https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D", + "SampleTimestamp": "2015-08-20T22:23:17.703Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves a link to logs from an environment named my-env:", + "id": "to-retrieve-tailed-logs-1456277792734", + "title": "To retrieve tailed logs" + } + ], + "SwapEnvironmentCNAMEs": [ + { + "input": { + "DestinationEnvironmentName": "my-env-green", + "SourceEnvironmentName": "my-env-blue" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation swaps the assigned subdomains of two environments:", + "id": "to-swap-environment-cnames-1456277839438", + "title": "To swap environment CNAMES" + } + ], + "TerminateEnvironment": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "output": { + "AbortableOperationInProgress": false, + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-08-12T18:52:53.622Z", + "DateUpdated": "2015-08-12T19:05:54.744Z", + "EndpointURL": "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com", + "EnvironmentId": "e-fh2eravpns", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Terminating", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation terminates an Elastic Beanstalk environment named my-env:", + "id": "to-terminate-an-environment-1456277888556", + "title": "To terminate an environment" + } + ], + "UpdateApplication": [ + { + "input": { + "ApplicationName": "my-app", + "Description": "my Elastic Beanstalk application" + }, + "output": { + "Application": { + "ApplicationName": "my-app", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-13T19:15:50.449Z", + "DateUpdated": "2015-08-20T22:34:56.195Z", + "Description": "my Elastic Beanstalk application", + "Versions": [ + "2fba-stage-150819_234450", + "bf07-stage-150820_214945", + "93f8", + "fd7c-stage-150820_000431", + "22a0-stage-150819_185942" + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation updates the description of an application named my-app:", + "id": "to-change-an-applications-description-1456277957075", + "title": "To change an application's description" + } + ], + "UpdateApplicationVersion": [ + { + "input": { + "ApplicationName": "my-app", + "Description": "new description", + "VersionLabel": "22a0-stage-150819_185942" + }, + "output": { + "ApplicationVersion": { + "ApplicationName": "my-app", + "DateCreated": "2015-08-19T18:59:17.646Z", + "DateUpdated": "2015-08-20T22:53:28.871Z", + "Description": "new description", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012", + "S3Key": "my-app/22a0-stage-150819_185942.war" + }, + "VersionLabel": "22a0-stage-150819_185942" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation updates the description of an application version named 22a0-stage-150819_185942:", + "id": "to-change-an-application-versions-description-1456278019237", + "title": "To change an application version's description" + } + ], + "UpdateConfigurationTemplate": [ + { + "input": { + "ApplicationName": "my-app", + "OptionsToRemove": [ + { + "Namespace": "aws:elasticbeanstalk:healthreporting:system", + "OptionName": "ConfigDocument" + } + ], + "TemplateName": "my-template" + }, + "output": { + "ApplicationName": "my-app", + "DateCreated": "2015-08-20T22:39:31Z", + "DateUpdated": "2015-08-20T22:43:11Z", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "TemplateName": "my-template" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:", + "id": "to-update-a-configuration-template-1456278075300", + "title": "To update a configuration template" + } + ], + "UpdateEnvironment": [ + { + "input": { + "EnvironmentName": "my-env", + "VersionLabel": "v2" + }, + "output": { + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-02-03T23:04:54.453Z", + "DateUpdated": "2015-02-03T23:12:29.119Z", + "EndpointURL": "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com", + "EnvironmentId": "e-szqipays4h", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux running Tomcat 7", + "Status": "Updating", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "v2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation updates an environment named \"my-env\" to version \"v2\" of the application to which it belongs:", + "id": "to-update-an-environment-to-a-new-version-1456278210718", + "title": "To update an environment to a new version" + }, + { + "input": { + "EnvironmentName": "my-env", + "OptionSettings": [ + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Interval", + "Value": "15" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Timeout", + "Value": "8" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "HealthyThreshold", + "Value": "2" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "UnhealthyThreshold", + "Value": "3" + } + ] + }, + "output": { + "AbortableOperationInProgress": true, + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-08-07T20:48:49.599Z", + "DateUpdated": "2015-08-12T18:15:23.804Z", + "EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com", + "EnvironmentId": "e-wtp2rpqsej", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Updating", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "7f58-stage-150812_025409" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation configures several options in the aws:elb:loadbalancer namespace:", + "id": "to-configure-option-settings-1456278286349", + "title": "To configure option settings" + } + ], + "ValidateConfigurationSettings": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "OptionSettings": [ + { + "Namespace": "aws:elasticbeanstalk:healthreporting:system", + "OptionName": "ConfigDocument", + "Value": "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}" + } + ] + }, + "output": { + "Messages": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation validates a CloudWatch custom metrics config document:", + "id": "to-validate-configuration-settings-1456278393654", + "title": "To validate configuration settings" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.min.json b/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.min.json new file mode 100644 index 0000000..b8da48e --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.min.json @@ -0,0 +1,1699 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2010-12-01", + "endpointPrefix": "elasticbeanstalk", + "protocol": "query", + "serviceAbbreviation": "Elastic Beanstalk", + "serviceFullName": "AWS Elastic Beanstalk", + "serviceId": "Elastic Beanstalk", + "signatureVersion": "v4", + "uid": "elasticbeanstalk-2010-12-01", + "xmlNamespace": "http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/" + }, + "operations": { + "AbortEnvironmentUpdate": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {} + } + } + }, + "ApplyEnvironmentManagedAction": { + "input": { + "type": "structure", + "required": [ + "ActionId" + ], + "members": { + "EnvironmentName": {}, + "EnvironmentId": {}, + "ActionId": {} + } + }, + "output": { + "resultWrapper": "ApplyEnvironmentManagedActionResult", + "type": "structure", + "members": { + "ActionId": {}, + "ActionDescription": {}, + "ActionType": {}, + "Status": {} + } + } + }, + "CheckDNSAvailability": { + "input": { + "type": "structure", + "required": [ + "CNAMEPrefix" + ], + "members": { + "CNAMEPrefix": {} + } + }, + "output": { + "resultWrapper": "CheckDNSAvailabilityResult", + "type": "structure", + "members": { + "Available": { + "type": "boolean" + }, + "FullyQualifiedCNAME": {} + } + } + }, + "ComposeEnvironments": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "GroupName": {}, + "VersionLabels": { + "type": "list", + "member": {} + } + } + }, + "output": { + "shape": "Si", + "resultWrapper": "ComposeEnvironmentsResult" + } + }, + "CreateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "Description": {}, + "ResourceLifecycleConfig": { + "shape": "S17" + }, + "Tags": { + "shape": "S1d" + } + } + }, + "output": { + "shape": "S1h", + "resultWrapper": "CreateApplicationResult" + } + }, + "CreateApplicationVersion": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "VersionLabel" + ], + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "Description": {}, + "SourceBuildInformation": { + "shape": "S1n" + }, + "SourceBundle": { + "shape": "S1r" + }, + "BuildConfiguration": { + "type": "structure", + "required": [ + "CodeBuildServiceRole", + "Image" + ], + "members": { + "ArtifactName": {}, + "CodeBuildServiceRole": {}, + "ComputeType": {}, + "Image": {}, + "TimeoutInMinutes": { + "type": "integer" + } + } + }, + "AutoCreateApplication": { + "type": "boolean" + }, + "Process": { + "type": "boolean" + }, + "Tags": { + "shape": "S1d" + } + } + }, + "output": { + "shape": "S1z", + "resultWrapper": "CreateApplicationVersionResult" + } + }, + "CreateConfigurationTemplate": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "TemplateName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "SolutionStackName": {}, + "PlatformArn": {}, + "SourceConfiguration": { + "type": "structure", + "members": { + "ApplicationName": {}, + "TemplateName": {} + } + }, + "EnvironmentId": {}, + "Description": {}, + "OptionSettings": { + "shape": "S25" + }, + "Tags": { + "shape": "S1d" + } + } + }, + "output": { + "shape": "S2b", + "resultWrapper": "CreateConfigurationTemplateResult" + } + }, + "CreateEnvironment": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "EnvironmentName": {}, + "GroupName": {}, + "Description": {}, + "CNAMEPrefix": {}, + "Tier": { + "shape": "S11" + }, + "Tags": { + "shape": "S1d" + }, + "VersionLabel": {}, + "TemplateName": {}, + "SolutionStackName": {}, + "PlatformArn": {}, + "OptionSettings": { + "shape": "S25" + }, + "OptionsToRemove": { + "shape": "S2e" + } + } + }, + "output": { + "shape": "Sk", + "resultWrapper": "CreateEnvironmentResult" + } + }, + "CreatePlatformVersion": { + "input": { + "type": "structure", + "required": [ + "PlatformName", + "PlatformVersion", + "PlatformDefinitionBundle" + ], + "members": { + "PlatformName": {}, + "PlatformVersion": {}, + "PlatformDefinitionBundle": { + "shape": "S1r" + }, + "EnvironmentName": {}, + "OptionSettings": { + "shape": "S25" + }, + "Tags": { + "shape": "S1d" + } + } + }, + "output": { + "resultWrapper": "CreatePlatformVersionResult", + "type": "structure", + "members": { + "PlatformSummary": { + "shape": "S2k" + }, + "Builder": { + "type": "structure", + "members": { + "ARN": {} + } + } + } + } + }, + "CreateStorageLocation": { + "output": { + "resultWrapper": "CreateStorageLocationResult", + "type": "structure", + "members": { + "S3Bucket": {} + } + } + }, + "DeleteApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "TerminateEnvByForce": { + "type": "boolean" + } + } + } + }, + "DeleteApplicationVersion": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "VersionLabel" + ], + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "DeleteSourceBundle": { + "type": "boolean" + } + } + } + }, + "DeleteConfigurationTemplate": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "TemplateName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {} + } + } + }, + "DeleteEnvironmentConfiguration": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "EnvironmentName" + ], + "members": { + "ApplicationName": {}, + "EnvironmentName": {} + } + } + }, + "DeletePlatformVersion": { + "input": { + "type": "structure", + "members": { + "PlatformArn": {} + } + }, + "output": { + "resultWrapper": "DeletePlatformVersionResult", + "type": "structure", + "members": { + "PlatformSummary": { + "shape": "S2k" + } + } + } + }, + "DescribeAccountAttributes": { + "output": { + "resultWrapper": "DescribeAccountAttributesResult", + "type": "structure", + "members": { + "ResourceQuotas": { + "type": "structure", + "members": { + "ApplicationQuota": { + "shape": "S37" + }, + "ApplicationVersionQuota": { + "shape": "S37" + }, + "EnvironmentQuota": { + "shape": "S37" + }, + "ConfigurationTemplateQuota": { + "shape": "S37" + }, + "CustomPlatformQuota": { + "shape": "S37" + } + } + } + } + } + }, + "DescribeApplicationVersions": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "VersionLabels": { + "shape": "S1k" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeApplicationVersionsResult", + "type": "structure", + "members": { + "ApplicationVersions": { + "type": "list", + "member": { + "shape": "S20" + } + }, + "NextToken": {} + } + } + }, + "DescribeApplications": { + "input": { + "type": "structure", + "members": { + "ApplicationNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeApplicationsResult", + "type": "structure", + "members": { + "Applications": { + "type": "list", + "member": { + "shape": "S1i" + } + } + } + } + }, + "DescribeConfigurationOptions": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "EnvironmentName": {}, + "SolutionStackName": {}, + "PlatformArn": {}, + "Options": { + "shape": "S2e" + } + } + }, + "output": { + "resultWrapper": "DescribeConfigurationOptionsResult", + "type": "structure", + "members": { + "SolutionStackName": {}, + "PlatformArn": {}, + "Options": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Namespace": {}, + "Name": {}, + "DefaultValue": {}, + "ChangeSeverity": {}, + "UserDefined": { + "type": "boolean" + }, + "ValueType": {}, + "ValueOptions": { + "type": "list", + "member": {} + }, + "MinValue": { + "type": "integer" + }, + "MaxValue": { + "type": "integer" + }, + "MaxLength": { + "type": "integer" + }, + "Regex": { + "type": "structure", + "members": { + "Pattern": {}, + "Label": {} + } + } + } + } + } + } + } + }, + "DescribeConfigurationSettings": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "EnvironmentName": {} + } + }, + "output": { + "resultWrapper": "DescribeConfigurationSettingsResult", + "type": "structure", + "members": { + "ConfigurationSettings": { + "type": "list", + "member": { + "shape": "S2b" + } + } + } + } + }, + "DescribeEnvironmentHealth": { + "input": { + "type": "structure", + "members": { + "EnvironmentName": {}, + "EnvironmentId": {}, + "AttributeNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeEnvironmentHealthResult", + "type": "structure", + "members": { + "EnvironmentName": {}, + "HealthStatus": {}, + "Status": {}, + "Color": {}, + "Causes": { + "shape": "S43" + }, + "ApplicationMetrics": { + "shape": "S45" + }, + "InstancesHealth": { + "type": "structure", + "members": { + "NoData": { + "type": "integer" + }, + "Unknown": { + "type": "integer" + }, + "Pending": { + "type": "integer" + }, + "Ok": { + "type": "integer" + }, + "Info": { + "type": "integer" + }, + "Warning": { + "type": "integer" + }, + "Degraded": { + "type": "integer" + }, + "Severe": { + "type": "integer" + } + } + }, + "RefreshedAt": { + "type": "timestamp" + } + } + } + }, + "DescribeEnvironmentManagedActionHistory": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "NextToken": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeEnvironmentManagedActionHistoryResult", + "type": "structure", + "members": { + "ManagedActionHistoryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ActionId": {}, + "ActionType": {}, + "ActionDescription": {}, + "FailureType": {}, + "Status": {}, + "FailureDescription": {}, + "ExecutedTime": { + "type": "timestamp" + }, + "FinishedTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeEnvironmentManagedActions": { + "input": { + "type": "structure", + "members": { + "EnvironmentName": {}, + "EnvironmentId": {}, + "Status": {} + } + }, + "output": { + "resultWrapper": "DescribeEnvironmentManagedActionsResult", + "type": "structure", + "members": { + "ManagedActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ActionId": {}, + "ActionDescription": {}, + "ActionType": {}, + "Status": {}, + "WindowStartTime": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeEnvironmentResources": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {} + } + }, + "output": { + "resultWrapper": "DescribeEnvironmentResourcesResult", + "type": "structure", + "members": { + "EnvironmentResources": { + "type": "structure", + "members": { + "EnvironmentName": {}, + "AutoScalingGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {} + } + } + }, + "LaunchConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "LaunchTemplates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {} + } + } + }, + "LoadBalancers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "Triggers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "Queues": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "URL": {} + } + } + } + } + } + } + } + }, + "DescribeEnvironments": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "EnvironmentIds": { + "type": "list", + "member": {} + }, + "EnvironmentNames": { + "type": "list", + "member": {} + }, + "IncludeDeleted": { + "type": "boolean" + }, + "IncludedDeletedBackTo": { + "type": "timestamp" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "shape": "Si", + "resultWrapper": "DescribeEnvironmentsResult" + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "TemplateName": {}, + "EnvironmentId": {}, + "EnvironmentName": {}, + "PlatformArn": {}, + "RequestId": {}, + "Severity": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventDate": { + "type": "timestamp" + }, + "Message": {}, + "ApplicationName": {}, + "VersionLabel": {}, + "TemplateName": {}, + "EnvironmentName": {}, + "PlatformArn": {}, + "RequestId": {}, + "Severity": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeInstancesHealth": { + "input": { + "type": "structure", + "members": { + "EnvironmentName": {}, + "EnvironmentId": {}, + "AttributeNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeInstancesHealthResult", + "type": "structure", + "members": { + "InstanceHealthList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "HealthStatus": {}, + "Color": {}, + "Causes": { + "shape": "S43" + }, + "LaunchedAt": { + "type": "timestamp" + }, + "ApplicationMetrics": { + "shape": "S45" + }, + "System": { + "type": "structure", + "members": { + "CPUUtilization": { + "type": "structure", + "members": { + "User": { + "type": "double" + }, + "Nice": { + "type": "double" + }, + "System": { + "type": "double" + }, + "Idle": { + "type": "double" + }, + "IOWait": { + "type": "double" + }, + "IRQ": { + "type": "double" + }, + "SoftIRQ": { + "type": "double" + }, + "Privileged": { + "type": "double" + } + } + }, + "LoadAverage": { + "type": "list", + "member": { + "type": "double" + } + } + } + }, + "Deployment": { + "type": "structure", + "members": { + "VersionLabel": {}, + "DeploymentId": { + "type": "long" + }, + "Status": {}, + "DeploymentTime": { + "type": "timestamp" + } + } + }, + "AvailabilityZone": {}, + "InstanceType": {} + } + } + }, + "RefreshedAt": { + "type": "timestamp" + }, + "NextToken": {} + } + } + }, + "DescribePlatformVersion": { + "input": { + "type": "structure", + "members": { + "PlatformArn": {} + } + }, + "output": { + "resultWrapper": "DescribePlatformVersionResult", + "type": "structure", + "members": { + "PlatformDescription": { + "type": "structure", + "members": { + "PlatformArn": {}, + "PlatformOwner": {}, + "PlatformName": {}, + "PlatformVersion": {}, + "SolutionStackName": {}, + "PlatformStatus": {}, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "PlatformCategory": {}, + "Description": {}, + "Maintainer": {}, + "OperatingSystemName": {}, + "OperatingSystemVersion": {}, + "ProgrammingLanguages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Version": {} + } + } + }, + "Frameworks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Version": {} + } + } + }, + "CustomAmiList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VirtualizationType": {}, + "ImageId": {} + } + } + }, + "SupportedTierList": { + "shape": "S2q" + }, + "SupportedAddonList": { + "shape": "S2s" + } + } + } + } + } + }, + "ListAvailableSolutionStacks": { + "output": { + "resultWrapper": "ListAvailableSolutionStacksResult", + "type": "structure", + "members": { + "SolutionStacks": { + "type": "list", + "member": {} + }, + "SolutionStackDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SolutionStackName": {}, + "PermittedFileTypes": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "ListPlatformVersions": { + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Operator": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListPlatformVersionsResult", + "type": "structure", + "members": { + "PlatformSummaryList": { + "type": "list", + "member": { + "shape": "S2k" + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "ResourceArn": {}, + "ResourceTags": { + "shape": "S6x" + } + } + } + }, + "RebuildEnvironment": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {} + } + } + }, + "RequestEnvironmentInfo": { + "input": { + "type": "structure", + "required": [ + "InfoType" + ], + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "InfoType": {} + } + } + }, + "RestartAppServer": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {} + } + } + }, + "RetrieveEnvironmentInfo": { + "input": { + "type": "structure", + "required": [ + "InfoType" + ], + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "InfoType": {} + } + }, + "output": { + "resultWrapper": "RetrieveEnvironmentInfoResult", + "type": "structure", + "members": { + "EnvironmentInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InfoType": {}, + "Ec2InstanceId": {}, + "SampleTimestamp": { + "type": "timestamp" + }, + "Message": {} + } + } + } + } + } + }, + "SwapEnvironmentCNAMEs": { + "input": { + "type": "structure", + "members": { + "SourceEnvironmentId": {}, + "SourceEnvironmentName": {}, + "DestinationEnvironmentId": {}, + "DestinationEnvironmentName": {} + } + } + }, + "TerminateEnvironment": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "TerminateResources": { + "type": "boolean" + }, + "ForceTerminate": { + "type": "boolean" + } + } + }, + "output": { + "shape": "Sk", + "resultWrapper": "TerminateEnvironmentResult" + } + }, + "UpdateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "Description": {} + } + }, + "output": { + "shape": "S1h", + "resultWrapper": "UpdateApplicationResult" + } + }, + "UpdateApplicationResourceLifecycle": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "ResourceLifecycleConfig" + ], + "members": { + "ApplicationName": {}, + "ResourceLifecycleConfig": { + "shape": "S17" + } + } + }, + "output": { + "resultWrapper": "UpdateApplicationResourceLifecycleResult", + "type": "structure", + "members": { + "ApplicationName": {}, + "ResourceLifecycleConfig": { + "shape": "S17" + } + } + } + }, + "UpdateApplicationVersion": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "VersionLabel" + ], + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "Description": {} + } + }, + "output": { + "shape": "S1z", + "resultWrapper": "UpdateApplicationVersionResult" + } + }, + "UpdateConfigurationTemplate": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "TemplateName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "Description": {}, + "OptionSettings": { + "shape": "S25" + }, + "OptionsToRemove": { + "shape": "S2e" + } + } + }, + "output": { + "shape": "S2b", + "resultWrapper": "UpdateConfigurationTemplateResult" + } + }, + "UpdateEnvironment": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "EnvironmentId": {}, + "EnvironmentName": {}, + "GroupName": {}, + "Description": {}, + "Tier": { + "shape": "S11" + }, + "VersionLabel": {}, + "TemplateName": {}, + "SolutionStackName": {}, + "PlatformArn": {}, + "OptionSettings": { + "shape": "S25" + }, + "OptionsToRemove": { + "shape": "S2e" + } + } + }, + "output": { + "shape": "Sk", + "resultWrapper": "UpdateEnvironmentResult" + } + }, + "UpdateTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "TagsToAdd": { + "shape": "S6x" + }, + "TagsToRemove": { + "type": "list", + "member": {} + } + } + } + }, + "ValidateConfigurationSettings": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "OptionSettings" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "EnvironmentName": {}, + "OptionSettings": { + "shape": "S25" + } + } + }, + "output": { + "resultWrapper": "ValidateConfigurationSettingsResult", + "type": "structure", + "members": { + "Messages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Message": {}, + "Severity": {}, + "Namespace": {}, + "OptionName": {} + } + } + } + } + } + } + }, + "shapes": { + "Si": { + "type": "structure", + "members": { + "Environments": { + "type": "list", + "member": { + "shape": "Sk" + } + }, + "NextToken": {} + } + }, + "Sk": { + "type": "structure", + "members": { + "EnvironmentName": {}, + "EnvironmentId": {}, + "ApplicationName": {}, + "VersionLabel": {}, + "SolutionStackName": {}, + "PlatformArn": {}, + "TemplateName": {}, + "Description": {}, + "EndpointURL": {}, + "CNAME": {}, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "Status": {}, + "AbortableOperationInProgress": { + "type": "boolean" + }, + "Health": {}, + "HealthStatus": {}, + "Resources": { + "type": "structure", + "members": { + "LoadBalancer": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "Domain": {}, + "Listeners": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Protocol": {}, + "Port": { + "type": "integer" + } + } + } + } + } + } + } + }, + "Tier": { + "shape": "S11" + }, + "EnvironmentLinks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LinkName": {}, + "EnvironmentName": {} + } + } + }, + "EnvironmentArn": {} + } + }, + "S11": { + "type": "structure", + "members": { + "Name": {}, + "Type": {}, + "Version": {} + } + }, + "S17": { + "type": "structure", + "members": { + "ServiceRole": {}, + "VersionLifecycleConfig": { + "type": "structure", + "members": { + "MaxCountRule": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "MaxCount": { + "type": "integer" + }, + "DeleteSourceFromS3": { + "type": "boolean" + } + } + }, + "MaxAgeRule": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "MaxAgeInDays": { + "type": "integer" + }, + "DeleteSourceFromS3": { + "type": "boolean" + } + } + } + } + } + } + }, + "S1d": { + "type": "list", + "member": { + "shape": "S1e" + } + }, + "S1e": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + }, + "S1h": { + "type": "structure", + "members": { + "Application": { + "shape": "S1i" + } + } + }, + "S1i": { + "type": "structure", + "members": { + "ApplicationArn": {}, + "ApplicationName": {}, + "Description": {}, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "Versions": { + "shape": "S1k" + }, + "ConfigurationTemplates": { + "type": "list", + "member": {} + }, + "ResourceLifecycleConfig": { + "shape": "S17" + } + } + }, + "S1k": { + "type": "list", + "member": {} + }, + "S1n": { + "type": "structure", + "required": [ + "SourceType", + "SourceRepository", + "SourceLocation" + ], + "members": { + "SourceType": {}, + "SourceRepository": {}, + "SourceLocation": {} + } + }, + "S1r": { + "type": "structure", + "members": { + "S3Bucket": {}, + "S3Key": {} + } + }, + "S1z": { + "type": "structure", + "members": { + "ApplicationVersion": { + "shape": "S20" + } + } + }, + "S20": { + "type": "structure", + "members": { + "ApplicationVersionArn": {}, + "ApplicationName": {}, + "Description": {}, + "VersionLabel": {}, + "SourceBuildInformation": { + "shape": "S1n" + }, + "BuildArn": {}, + "SourceBundle": { + "shape": "S1r" + }, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "Status": {} + } + }, + "S25": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceName": {}, + "Namespace": {}, + "OptionName": {}, + "Value": {} + } + } + }, + "S2b": { + "type": "structure", + "members": { + "SolutionStackName": {}, + "PlatformArn": {}, + "ApplicationName": {}, + "TemplateName": {}, + "Description": {}, + "EnvironmentName": {}, + "DeploymentStatus": {}, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "OptionSettings": { + "shape": "S25" + } + } + }, + "S2e": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceName": {}, + "Namespace": {}, + "OptionName": {} + } + } + }, + "S2k": { + "type": "structure", + "members": { + "PlatformArn": {}, + "PlatformOwner": {}, + "PlatformStatus": {}, + "PlatformCategory": {}, + "OperatingSystemName": {}, + "OperatingSystemVersion": {}, + "SupportedTierList": { + "shape": "S2q" + }, + "SupportedAddonList": { + "shape": "S2s" + } + } + }, + "S2q": { + "type": "list", + "member": {} + }, + "S2s": { + "type": "list", + "member": {} + }, + "S37": { + "type": "structure", + "members": { + "Maximum": { + "type": "integer" + } + } + }, + "S43": { + "type": "list", + "member": {} + }, + "S45": { + "type": "structure", + "members": { + "Duration": { + "type": "integer" + }, + "RequestCount": { + "type": "integer" + }, + "StatusCodes": { + "type": "structure", + "members": { + "Status2xx": { + "type": "integer" + }, + "Status3xx": { + "type": "integer" + }, + "Status4xx": { + "type": "integer" + }, + "Status5xx": { + "type": "integer" + } + } + }, + "Latency": { + "type": "structure", + "members": { + "P999": { + "type": "double" + }, + "P99": { + "type": "double" + }, + "P95": { + "type": "double" + }, + "P90": { + "type": "double" + }, + "P85": { + "type": "double" + }, + "P75": { + "type": "double" + }, + "P50": { + "type": "double" + }, + "P10": { + "type": "double" + } + } + } + } + }, + "S6x": { + "type": "list", + "member": { + "shape": "S1e" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.paginators.json b/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.paginators.json new file mode 100644 index 0000000..b4e93b3 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticbeanstalk-2010-12-01.paginators.json @@ -0,0 +1,25 @@ +{ + "pagination": { + "DescribeApplicationVersions": { + "result_key": "ApplicationVersions" + }, + "DescribeApplications": { + "result_key": "Applications" + }, + "DescribeConfigurationOptions": { + "result_key": "Options" + }, + "DescribeEnvironments": { + "result_key": "Environments" + }, + "DescribeEvents": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "Events" + }, + "ListAvailableSolutionStacks": { + "result_key": "SolutionStacks" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.examples.json b/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.examples.json new file mode 100644 index 0000000..7ed7763 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.examples.json @@ -0,0 +1,291 @@ +{ + "version": "1.0", + "examples": { + "CreateFileSystem": [ + { + "input": { + "CreationToken": "tokenstring", + "PerformanceMode": "generalPurpose", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "output": { + "CreationTime": "1481841524.0", + "CreationToken": "tokenstring", + "FileSystemId": "fs-01234567", + "LifeCycleState": "creating", + "NumberOfMountTargets": 0, + "OwnerId": "012345678912", + "PerformanceMode": "generalPurpose", + "SizeInBytes": { + "Value": 0 + }, + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation creates a new file system with the default generalpurpose performance mode.", + "id": "to-create-a-new-file-system-1481840798547", + "title": "To create a new file system" + } + ], + "CreateMountTarget": [ + { + "input": { + "FileSystemId": "fs-01234567", + "SubnetId": "subnet-1234abcd" + }, + "output": { + "FileSystemId": "fs-01234567", + "IpAddress": "192.0.0.2", + "LifeCycleState": "creating", + "MountTargetId": "fsmt-12340abc", + "NetworkInterfaceId": "eni-cedf6789", + "OwnerId": "012345678912", + "SubnetId": "subnet-1234abcd" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation creates a new mount target for an EFS file system.", + "id": "to-create-a-new-mount-target-1481842289329", + "title": "To create a new mount target" + } + ], + "CreateTags": [ + { + "input": { + "FileSystemId": "fs-01234567", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "comments": { + }, + "description": "This operation creates a new tag for an EFS file system.", + "id": "to-create-a-new-tag-1481843409357", + "title": "To create a new tag" + } + ], + "DeleteFileSystem": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "comments": { + }, + "description": "This operation deletes an EFS file system.", + "id": "to-delete-a-file-system-1481847318348", + "title": "To delete a file system" + } + ], + "DeleteMountTarget": [ + { + "input": { + "MountTargetId": "fsmt-12340abc" + }, + "comments": { + }, + "description": "This operation deletes a mount target.", + "id": "to-delete-a-mount-target-1481847635607", + "title": "To delete a mount target" + } + ], + "DeleteTags": [ + { + "input": { + "FileSystemId": "fs-01234567", + "TagKeys": [ + "Name" + ] + }, + "comments": { + }, + "description": "This operation deletes tags for an EFS file system.", + "id": "to-delete-tags-for-an-efs-file-system-1481848189061", + "title": "To delete tags for an EFS file system" + } + ], + "DescribeFileSystems": [ + { + "input": { + }, + "output": { + "FileSystems": [ + { + "CreationTime": "1481841524.0", + "CreationToken": "tokenstring", + "FileSystemId": "fs-01234567", + "LifeCycleState": "available", + "Name": "MyFileSystem", + "NumberOfMountTargets": 1, + "OwnerId": "012345678912", + "PerformanceMode": "generalPurpose", + "SizeInBytes": { + "Value": 6144 + }, + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + } + ] + }, + "comments": { + }, + "description": "This operation describes all of the EFS file systems in an account.", + "id": "to-describe-an-efs-file-system-1481848448460", + "title": "To describe an EFS file system" + } + ], + "DescribeLifecycleConfiguration": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "output": { + "LifecyclePolicies": [ + { + "TransitionToIA": "AFTER_30_DAYS" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. ", + "id": "to-describe-the-lifecycle-configuration-for-a-file-system-1551200664502", + "title": "To describe the lifecycle configuration for a file system" + } + ], + "DescribeMountTargetSecurityGroups": [ + { + "input": { + "MountTargetId": "fsmt-12340abc" + }, + "output": { + "SecurityGroups": [ + "sg-fghi4567" + ] + }, + "comments": { + }, + "description": "This operation describes all of the security groups for a file system's mount target.", + "id": "to-describe-the-security-groups-for-a-mount-target-1481849317823", + "title": "To describe the security groups for a mount target" + } + ], + "DescribeMountTargets": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "output": { + "MountTargets": [ + { + "FileSystemId": "fs-01234567", + "IpAddress": "192.0.0.2", + "LifeCycleState": "available", + "MountTargetId": "fsmt-12340abc", + "NetworkInterfaceId": "eni-cedf6789", + "OwnerId": "012345678912", + "SubnetId": "subnet-1234abcd" + } + ] + }, + "comments": { + }, + "description": "This operation describes all of a file system's mount targets.", + "id": "to-describe-the-mount-targets-for-a-file-system-1481849958584", + "title": "To describe the mount targets for a file system" + } + ], + "DescribeTags": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "output": { + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "comments": { + }, + "description": "This operation describes all of a file system's tags.", + "id": "to-describe-the-tags-for-a-file-system-1481850497090", + "title": "To describe the tags for a file system" + } + ], + "ModifyMountTargetSecurityGroups": [ + { + "input": { + "MountTargetId": "fsmt-12340abc", + "SecurityGroups": [ + "sg-abcd1234" + ] + }, + "comments": { + }, + "description": "This operation modifies the security groups associated with a mount target for a file system.", + "id": "to-modify-the-security-groups-associated-with-a-mount-target-for-a-file-system-1481850772562", + "title": "To modify the security groups associated with a mount target for a file system" + } + ], + "PutLifecycleConfiguration": [ + { + "input": { + "FileSystemId": "fs-01234567", + "LifecyclePolicies": [ + { + "TransitionToIA": "AFTER_30_DAYS" + } + ] + }, + "output": { + "LifecyclePolicies": [ + { + "TransitionToIA": "AFTER_30_DAYS" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.", + "id": "creates-a-new-lifecycleconfiguration-object-for-a-file-system-1551201594692", + "title": "Creates a new lifecycleconfiguration object for a file system" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json b/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json new file mode 100644 index 0000000..fa8a252 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json @@ -0,0 +1,517 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-02-01", + "endpointPrefix": "elasticfilesystem", + "protocol": "rest-json", + "serviceAbbreviation": "EFS", + "serviceFullName": "Amazon Elastic File System", + "serviceId": "EFS", + "signatureVersion": "v4", + "uid": "elasticfilesystem-2015-02-01" + }, + "operations": { + "CreateFileSystem": { + "http": { + "requestUri": "/2015-02-01/file-systems", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "CreationToken" + ], + "members": { + "CreationToken": {}, + "PerformanceMode": {}, + "Encrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "ThroughputMode": {}, + "ProvisionedThroughputInMibps": { + "type": "double" + }, + "Tags": { + "shape": "S8" + } + } + }, + "output": { + "shape": "Sc" + } + }, + "CreateMountTarget": { + "http": { + "requestUri": "/2015-02-01/mount-targets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId", + "SubnetId" + ], + "members": { + "FileSystemId": {}, + "SubnetId": {}, + "IpAddress": {}, + "SecurityGroups": { + "shape": "So" + } + } + }, + "output": { + "shape": "Sq" + } + }, + "CreateTags": { + "http": { + "requestUri": "/2015-02-01/create-tags/{FileSystemId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId", + "Tags" + ], + "members": { + "FileSystemId": { + "location": "uri", + "locationName": "FileSystemId" + }, + "Tags": { + "shape": "S8" + } + } + } + }, + "DeleteFileSystem": { + "http": { + "method": "DELETE", + "requestUri": "/2015-02-01/file-systems/{FileSystemId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId" + ], + "members": { + "FileSystemId": { + "location": "uri", + "locationName": "FileSystemId" + } + } + } + }, + "DeleteMountTarget": { + "http": { + "method": "DELETE", + "requestUri": "/2015-02-01/mount-targets/{MountTargetId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "MountTargetId" + ], + "members": { + "MountTargetId": { + "location": "uri", + "locationName": "MountTargetId" + } + } + } + }, + "DeleteTags": { + "http": { + "requestUri": "/2015-02-01/delete-tags/{FileSystemId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId", + "TagKeys" + ], + "members": { + "FileSystemId": { + "location": "uri", + "locationName": "FileSystemId" + }, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "DescribeFileSystems": { + "http": { + "method": "GET", + "requestUri": "/2015-02-01/file-systems", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "CreationToken": { + "location": "querystring", + "locationName": "CreationToken" + }, + "FileSystemId": { + "location": "querystring", + "locationName": "FileSystemId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "FileSystems": { + "type": "list", + "member": { + "shape": "Sc" + } + }, + "NextMarker": {} + } + } + }, + "DescribeLifecycleConfiguration": { + "http": { + "method": "GET", + "requestUri": "/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId" + ], + "members": { + "FileSystemId": { + "location": "uri", + "locationName": "FileSystemId" + } + } + }, + "output": { + "shape": "S14" + } + }, + "DescribeMountTargetSecurityGroups": { + "http": { + "method": "GET", + "requestUri": "/2015-02-01/mount-targets/{MountTargetId}/security-groups", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "MountTargetId" + ], + "members": { + "MountTargetId": { + "location": "uri", + "locationName": "MountTargetId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "SecurityGroups" + ], + "members": { + "SecurityGroups": { + "shape": "So" + } + } + } + }, + "DescribeMountTargets": { + "http": { + "method": "GET", + "requestUri": "/2015-02-01/mount-targets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "FileSystemId": { + "location": "querystring", + "locationName": "FileSystemId" + }, + "MountTargetId": { + "location": "querystring", + "locationName": "MountTargetId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "MountTargets": { + "type": "list", + "member": { + "shape": "Sq" + } + }, + "NextMarker": {} + } + } + }, + "DescribeTags": { + "http": { + "method": "GET", + "requestUri": "/2015-02-01/tags/{FileSystemId}/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId" + ], + "members": { + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "FileSystemId": { + "location": "uri", + "locationName": "FileSystemId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Marker": {}, + "Tags": { + "shape": "S8" + }, + "NextMarker": {} + } + } + }, + "ModifyMountTargetSecurityGroups": { + "http": { + "method": "PUT", + "requestUri": "/2015-02-01/mount-targets/{MountTargetId}/security-groups", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "MountTargetId" + ], + "members": { + "MountTargetId": { + "location": "uri", + "locationName": "MountTargetId" + }, + "SecurityGroups": { + "shape": "So" + } + } + } + }, + "PutLifecycleConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId", + "LifecyclePolicies" + ], + "members": { + "FileSystemId": { + "location": "uri", + "locationName": "FileSystemId" + }, + "LifecyclePolicies": { + "shape": "S15" + } + } + }, + "output": { + "shape": "S14" + } + }, + "UpdateFileSystem": { + "http": { + "method": "PUT", + "requestUri": "/2015-02-01/file-systems/{FileSystemId}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "FileSystemId" + ], + "members": { + "FileSystemId": { + "location": "uri", + "locationName": "FileSystemId" + }, + "ThroughputMode": {}, + "ProvisionedThroughputInMibps": { + "type": "double" + } + } + }, + "output": { + "shape": "Sc" + } + } + }, + "shapes": { + "S8": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sc": { + "type": "structure", + "required": [ + "OwnerId", + "CreationToken", + "FileSystemId", + "CreationTime", + "LifeCycleState", + "NumberOfMountTargets", + "SizeInBytes", + "PerformanceMode", + "Tags" + ], + "members": { + "OwnerId": {}, + "CreationToken": {}, + "FileSystemId": {}, + "CreationTime": { + "type": "timestamp" + }, + "LifeCycleState": {}, + "Name": {}, + "NumberOfMountTargets": { + "type": "integer" + }, + "SizeInBytes": { + "type": "structure", + "required": [ + "Value" + ], + "members": { + "Value": { + "type": "long" + }, + "Timestamp": { + "type": "timestamp" + }, + "ValueInIA": { + "type": "long" + }, + "ValueInStandard": { + "type": "long" + } + } + }, + "PerformanceMode": {}, + "Encrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "ThroughputMode": {}, + "ProvisionedThroughputInMibps": { + "type": "double" + }, + "Tags": { + "shape": "S8" + } + } + }, + "So": { + "type": "list", + "member": {} + }, + "Sq": { + "type": "structure", + "required": [ + "MountTargetId", + "FileSystemId", + "SubnetId", + "LifeCycleState" + ], + "members": { + "OwnerId": {}, + "MountTargetId": {}, + "FileSystemId": {}, + "SubnetId": {}, + "LifeCycleState": {}, + "IpAddress": {}, + "NetworkInterfaceId": {} + } + }, + "S14": { + "type": "structure", + "members": { + "LifecyclePolicies": { + "shape": "S15" + } + } + }, + "S15": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TransitionToIA": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.paginators.json b/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.examples.json b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.examples.json new file mode 100644 index 0000000..ce50fdd --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.examples.json @@ -0,0 +1,1036 @@ +{ + "version": "1.0", + "examples": { + "AddTags": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ], + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds two tags to the specified load balancer.", + "id": "elb-add-tags-1", + "title": "To add tags to a load balancer" + } + ], + "ApplySecurityGroupsToLoadBalancer": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "SecurityGroups": [ + "sg-fc448899" + ] + }, + "output": { + "SecurityGroups": [ + "sg-fc448899" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates a security group with the specified load balancer in a VPC.", + "id": "elb-apply-security-groups-to-load-balancer-1", + "title": "To associate a security group with a load balancer in a VPC" + } + ], + "AttachLoadBalancerToSubnets": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "Subnets": [ + "subnet-0ecac448" + ] + }, + "output": { + "Subnets": [ + "subnet-15aaab61", + "subnet-0ecac448" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified subnet to the set of configured subnets for the specified load balancer.", + "id": "elb-attach-load-balancer-to-subnets-1", + "title": "To attach subnets to a load balancer" + } + ], + "ConfigureHealthCheck": [ + { + "input": { + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + }, + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example specifies the health check settings used to evaluate the health of your backend EC2 instances.", + "id": "elb-configure-health-check-1", + "title": "To specify the health check settings for your backend EC2 instances" + } + ], + "CreateAppCookieStickinessPolicy": [ + { + "input": { + "CookieName": "my-app-cookie", + "LoadBalancerName": "my-load-balancer", + "PolicyName": "my-app-cookie-policy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example generates a stickiness policy that follows the sticky session lifetimes of the application-generated cookie.", + "id": "elb-create-app-cookie-stickiness-policy-1", + "title": "To generate a stickiness policy for your load balancer" + } + ], + "CreateLBCookieStickinessPolicy": [ + { + "input": { + "CookieExpirationPeriod": 60, + "LoadBalancerName": "my-load-balancer", + "PolicyName": "my-duration-cookie-policy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example generates a stickiness policy with sticky session lifetimes controlled by the specified expiration period.", + "id": "elb-create-lb-cookie-stickiness-policy-1", + "title": "To generate a duration-based stickiness policy for your load balancer" + } + ], + "CreateLoadBalancer": [ + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer", + "SecurityGroups": [ + "sg-a61988c3" + ], + "Subnets": [ + "subnet-15aaab61" + ] + }, + "output": { + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTP listener in a VPC.", + "id": "elb-create-load-balancer-1", + "title": "To create an HTTP load balancer in a VPC" + }, + { + "input": { + "AvailabilityZones": [ + "us-west-2a" + ], + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTP listener in EC2-Classic.", + "id": "elb-create-load-balancer-2", + "title": "To create an HTTP load balancer in EC2-Classic" + }, + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + }, + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerName": "my-load-balancer", + "SecurityGroups": [ + "sg-a61988c3" + ], + "Subnets": [ + "subnet-15aaab61" + ] + }, + "output": { + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTPS listener in a VPC.", + "id": "elb-create-load-balancer-3", + "title": "To create an HTTPS load balancer in a VPC" + }, + { + "input": { + "AvailabilityZones": [ + "us-west-2a" + ], + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + }, + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTPS listener in EC2-Classic.", + "id": "elb-create-load-balancer-4", + "title": "To create an HTTPS load balancer in EC2-Classic" + }, + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer", + "Scheme": "internal", + "SecurityGroups": [ + "sg-a61988c3" + ], + "Subnets": [ + "subnet-15aaab61" + ] + }, + "output": { + "DNSName": "internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an internal load balancer with an HTTP listener in a VPC.", + "id": "elb-create-load-balancer-5", + "title": "To create an internal load balancer" + } + ], + "CreateLoadBalancerListeners": [ + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a listener for your load balancer at port 80 using the HTTP protocol.", + "id": "elb-create-load-balancer-listeners-1", + "title": "To create an HTTP listener for a load balancer" + }, + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a listener for your load balancer at port 443 using the HTTPS protocol.", + "id": "elb-create-load-balancer-listeners-2", + "title": "To create an HTTPS listener for a load balancer" + } + ], + "CreateLoadBalancerPolicy": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyAttributes": [ + { + "AttributeName": "ProxyProtocol", + "AttributeValue": "true" + } + ], + "PolicyName": "my-ProxyProtocol-policy", + "PolicyTypeName": "ProxyProtocolPolicyType" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a policy that enables Proxy Protocol on the specified load balancer.", + "id": "elb-create-load-balancer-policy-1", + "title": "To create a policy that enables Proxy Protocol on a load balancer" + }, + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyAttributes": [ + { + "AttributeName": "PublicKey", + "AttributeValue": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwAYUjnfyEyXr1pxjhFWBpMlggUcqoi3kl+dS74kj//c6x7ROtusUaeQCTgIUkayttRDWchuqo1pHC1u+n5xxXnBBe2ejbb2WRsKIQ5rXEeixsjFpFsojpSQKkzhVGI6mJVZBJDVKSHmswnwLBdofLhzvllpovBPTHe+o4haAWvDBALJU0pkSI1FecPHcs2hwxf14zHoXy1e2k36A64nXW43wtfx5qcVSIxtCEOjnYRg7RPvybaGfQ+v6Iaxb/+7J5kEvZhTFQId+bSiJImF1FSUT1W1xwzBZPUbcUkkXDj45vC2s3Z8E+Lk7a3uZhvsQHLZnrfuWjBWGWvZ/MhZYgEXAMPLE" + } + ], + "PolicyName": "my-PublicKey-policy", + "PolicyTypeName": "PublicKeyPolicyType" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a public key policy.", + "id": "elb-create-load-balancer-policy-2", + "title": "To create a public key policy" + }, + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyAttributes": [ + { + "AttributeName": "PublicKeyPolicyName", + "AttributeValue": "my-PublicKey-policy" + } + ], + "PolicyName": "my-authentication-policy", + "PolicyTypeName": "BackendServerAuthenticationPolicyType" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a backend server authentication policy that enables authentication on your backend instance using a public key policy.", + "id": "elb-create-load-balancer-policy-3", + "title": "To create a backend server authentication policy" + } + ], + "DeleteLoadBalancer": [ + { + "input": { + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified load balancer.", + "id": "elb-delete-load-balancer-1", + "title": "To delete a load balancer" + } + ], + "DeleteLoadBalancerListeners": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "LoadBalancerPorts": [ + 80 + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the listener for the specified port from the specified load balancer.", + "id": "elb-delete-load-balancer-listeners-1", + "title": "To delete a listener from your load balancer" + } + ], + "DeleteLoadBalancerPolicy": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyName": "my-duration-cookie-policy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified policy from the specified load balancer. The policy must not be enabled on any listener.", + "id": "elb-delete-load-balancer-policy-1", + "title": "To delete a policy from your load balancer" + } + ], + "DeregisterInstancesFromLoadBalancer": [ + { + "input": { + "Instances": [ + { + "InstanceId": "i-d6f6fae3" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "Instances": [ + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters the specified instance from the specified load balancer.", + "id": "elb-deregister-instances-from-load-balancer-1", + "title": "To deregister instances from a load balancer" + } + ], + "DescribeInstanceHealth": [ + { + "input": { + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "InstanceStates": [ + { + "Description": "N/A", + "InstanceId": "i-207d9717", + "ReasonCode": "N/A", + "State": "InService" + }, + { + "Description": "N/A", + "InstanceId": "i-afefb49b", + "ReasonCode": "N/A", + "State": "InService" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the health of the instances for the specified load balancer.", + "id": "elb-describe-instance-health-1", + "title": "To describe the health of the instances for a load balancer" + } + ], + "DescribeLoadBalancerAttributes": [ + { + "input": { + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "LoadBalancerAttributes": { + "AccessLog": { + "Enabled": false + }, + "ConnectionDraining": { + "Enabled": false, + "Timeout": 300 + }, + "ConnectionSettings": { + "IdleTimeout": 60 + }, + "CrossZoneLoadBalancing": { + "Enabled": false + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes of the specified load balancer.", + "id": "elb-describe-load-balancer-attributes-1", + "title": "To describe the attributes of a load balancer" + } + ], + "DescribeLoadBalancerPolicies": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyNames": [ + "my-authentication-policy" + ] + }, + "output": { + "PolicyDescriptions": [ + { + "PolicyAttributeDescriptions": [ + { + "AttributeName": "PublicKeyPolicyName", + "AttributeValue": "my-PublicKey-policy" + } + ], + "PolicyName": "my-authentication-policy", + "PolicyTypeName": "BackendServerAuthenticationPolicyType" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified policy associated with the specified load balancer.", + "id": "elb-describe-load-balancer-policies-1", + "title": "To describe a policy associated with a load balancer" + } + ], + "DescribeLoadBalancerPolicyTypes": [ + { + "input": { + "PolicyTypeNames": [ + "ProxyProtocolPolicyType" + ] + }, + "output": { + "PolicyTypeDescriptions": [ + { + "Description": "Policy that controls whether to include the IP address and port of the originating request for TCP messages. This policy operates on TCP listeners only.", + "PolicyAttributeTypeDescriptions": [ + { + "AttributeName": "ProxyProtocol", + "AttributeType": "Boolean", + "Cardinality": "ONE" + } + ], + "PolicyTypeName": "ProxyProtocolPolicyType" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified load balancer policy type.", + "id": "elb-describe-load-balancer-policy-types-1", + "title": "To describe a load balancer policy type defined by Elastic Load Balancing" + } + ], + "DescribeLoadBalancers": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "output": { + "LoadBalancerDescriptions": [ + { + "AvailabilityZones": [ + "us-west-2a" + ], + "BackendServerDescriptions": [ + { + "InstancePort": 80, + "PolicyNames": [ + "my-ProxyProtocol-policy" + ] + } + ], + "CanonicalHostedZoneName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", + "CanonicalHostedZoneNameID": "Z3DZXE0EXAMPLE", + "CreatedTime": "2015-03-19T03:24:02.650Z", + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + }, + "Instances": [ + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ], + "ListenerDescriptions": [ + { + "Listener": { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + }, + "PolicyNames": [ + + ] + }, + { + "Listener": { + "InstancePort": 443, + "InstanceProtocol": "HTTPS", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + }, + "PolicyNames": [ + "ELBSecurityPolicy-2015-03" + ] + } + ], + "LoadBalancerName": "my-load-balancer", + "Policies": { + "AppCookieStickinessPolicies": [ + + ], + "LBCookieStickinessPolicies": [ + { + "CookieExpirationPeriod": 60, + "PolicyName": "my-duration-cookie-policy" + } + ], + "OtherPolicies": [ + "my-PublicKey-policy", + "my-authentication-policy", + "my-SSLNegotiation-policy", + "my-ProxyProtocol-policy", + "ELBSecurityPolicy-2015-03" + ] + }, + "Scheme": "internet-facing", + "SecurityGroups": [ + "sg-a61988c3" + ], + "SourceSecurityGroup": { + "GroupName": "my-elb-sg", + "OwnerAlias": "123456789012" + }, + "Subnets": [ + "subnet-15aaab61" + ], + "VPCId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified load balancer.", + "id": "elb-describe-load-balancers-1", + "title": "To describe one of your load balancers" + } + ], + "DescribeTags": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "output": { + "TagDescriptions": [ + { + "LoadBalancerName": "my-load-balancer", + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags for the specified load balancer.", + "id": "elb-describe-tags-1", + "title": "To describe the tags for a load balancer" + } + ], + "DetachLoadBalancerFromSubnets": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "Subnets": [ + "subnet-0ecac448" + ] + }, + "output": { + "Subnets": [ + "subnet-15aaab61" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified load balancer from the specified subnet.", + "id": "elb-detach-load-balancer-from-subnets-1", + "title": "To detach a load balancer from a subnet" + } + ], + "DisableAvailabilityZonesForLoadBalancer": [ + { + "input": { + "AvailabilityZones": [ + "us-west-2a" + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "AvailabilityZones": [ + "us-west-2b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified Availability Zone from the set of Availability Zones for the specified load balancer.", + "id": "elb-disable-availability-zones-for-load-balancer-1", + "title": "To disable an Availability Zone for a load balancer" + } + ], + "EnableAvailabilityZonesForLoadBalancer": [ + { + "input": { + "AvailabilityZones": [ + "us-west-2b" + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified Availability Zone to the specified load balancer.", + "id": "elb-enable-availability-zones-for-load-balancer-1", + "title": "To enable an Availability Zone for a load balancer" + } + ], + "ModifyLoadBalancerAttributes": [ + { + "input": { + "LoadBalancerAttributes": { + "CrossZoneLoadBalancing": { + "Enabled": true + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "LoadBalancerAttributes": { + "CrossZoneLoadBalancing": { + "Enabled": true + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables cross-zone load balancing for the specified load balancer.", + "id": "elb-modify-load-balancer-attributes-1", + "title": "To enable cross-zone load balancing" + }, + { + "input": { + "LoadBalancerAttributes": { + "ConnectionDraining": { + "Enabled": true, + "Timeout": 300 + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "LoadBalancerAttributes": { + "ConnectionDraining": { + "Enabled": true, + "Timeout": 300 + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables connection draining for the specified load balancer.", + "id": "elb-modify-load-balancer-attributes-2", + "title": "To enable connection draining" + } + ], + "RegisterInstancesWithLoadBalancer": [ + { + "input": { + "Instances": [ + { + "InstanceId": "i-d6f6fae3" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "Instances": [ + { + "InstanceId": "i-d6f6fae3" + }, + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers the specified instance with the specified load balancer.", + "id": "elb-register-instances-with-load-balancer-1", + "title": "To register instances with a load balancer" + } + ], + "RemoveTags": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ], + "Tags": [ + { + "Key": "project" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified tag from the specified load balancer.", + "id": "elb-remove-tags-1", + "title": "To remove tags from a load balancer" + } + ], + "SetLoadBalancerListenerSSLCertificate": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "LoadBalancerPort": 443, + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/new-server-cert" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the existing SSL certificate for the specified HTTPS listener.", + "id": "elb-set-load-balancer-listener-ssl-certificate-1", + "title": "To update the SSL certificate for an HTTPS listener" + } + ], + "SetLoadBalancerPoliciesForBackendServer": [ + { + "input": { + "InstancePort": 80, + "LoadBalancerName": "my-load-balancer", + "PolicyNames": [ + "my-ProxyProtocol-policy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the policies that are currently associated with the specified port.", + "id": "elb-set-load-balancer-policies-for-backend-server-1", + "title": "To replace the policies associated with a port for a backend instance" + } + ], + "SetLoadBalancerPoliciesOfListener": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "LoadBalancerPort": 80, + "PolicyNames": [ + "my-SSLNegotiation-policy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the policies that are currently associated with the specified listener.", + "id": "elb-set-load-balancer-policies-of-listener-1", + "title": "To replace the policies associated with a listener" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.min.json b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.min.json new file mode 100644 index 0000000..dfb0f7c --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.min.json @@ -0,0 +1,1003 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-06-01", + "endpointPrefix": "elasticloadbalancing", + "protocol": "query", + "serviceFullName": "Elastic Load Balancing", + "serviceId": "Elastic Load Balancing", + "signatureVersion": "v4", + "uid": "elasticloadbalancing-2012-06-01", + "xmlNamespace": "http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/" + }, + "operations": { + "AddTags": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerNames", + "Tags" + ], + "members": { + "LoadBalancerNames": { + "shape": "S2" + }, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "resultWrapper": "AddTagsResult", + "type": "structure", + "members": {} + } + }, + "ApplySecurityGroupsToLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "SecurityGroups" + ], + "members": { + "LoadBalancerName": {}, + "SecurityGroups": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "ApplySecurityGroupsToLoadBalancerResult", + "type": "structure", + "members": { + "SecurityGroups": { + "shape": "Sa" + } + } + } + }, + "AttachLoadBalancerToSubnets": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Subnets" + ], + "members": { + "LoadBalancerName": {}, + "Subnets": { + "shape": "Se" + } + } + }, + "output": { + "resultWrapper": "AttachLoadBalancerToSubnetsResult", + "type": "structure", + "members": { + "Subnets": { + "shape": "Se" + } + } + } + }, + "ConfigureHealthCheck": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "HealthCheck" + ], + "members": { + "LoadBalancerName": {}, + "HealthCheck": { + "shape": "Si" + } + } + }, + "output": { + "resultWrapper": "ConfigureHealthCheckResult", + "type": "structure", + "members": { + "HealthCheck": { + "shape": "Si" + } + } + } + }, + "CreateAppCookieStickinessPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName", + "CookieName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {}, + "CookieName": {} + } + }, + "output": { + "resultWrapper": "CreateAppCookieStickinessPolicyResult", + "type": "structure", + "members": {} + } + }, + "CreateLBCookieStickinessPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {}, + "CookieExpirationPeriod": { + "type": "long" + } + } + }, + "output": { + "resultWrapper": "CreateLBCookieStickinessPolicyResult", + "type": "structure", + "members": {} + } + }, + "CreateLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Listeners" + ], + "members": { + "LoadBalancerName": {}, + "Listeners": { + "shape": "Sx" + }, + "AvailabilityZones": { + "shape": "S13" + }, + "Subnets": { + "shape": "Se" + }, + "SecurityGroups": { + "shape": "Sa" + }, + "Scheme": {}, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "resultWrapper": "CreateLoadBalancerResult", + "type": "structure", + "members": { + "DNSName": {} + } + } + }, + "CreateLoadBalancerListeners": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Listeners" + ], + "members": { + "LoadBalancerName": {}, + "Listeners": { + "shape": "Sx" + } + } + }, + "output": { + "resultWrapper": "CreateLoadBalancerListenersResult", + "type": "structure", + "members": {} + } + }, + "CreateLoadBalancerPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName", + "PolicyTypeName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {}, + "PolicyTypeName": {}, + "PolicyAttributes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValue": {} + } + } + } + } + }, + "output": { + "resultWrapper": "CreateLoadBalancerPolicyResult", + "type": "structure", + "members": {} + } + }, + "DeleteLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName" + ], + "members": { + "LoadBalancerName": {} + } + }, + "output": { + "resultWrapper": "DeleteLoadBalancerResult", + "type": "structure", + "members": {} + } + }, + "DeleteLoadBalancerListeners": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerPorts" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerPorts": { + "type": "list", + "member": { + "type": "integer" + } + } + } + }, + "output": { + "resultWrapper": "DeleteLoadBalancerListenersResult", + "type": "structure", + "members": {} + } + }, + "DeleteLoadBalancerPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "DeleteLoadBalancerPolicyResult", + "type": "structure", + "members": {} + } + }, + "DeregisterInstancesFromLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Instances" + ], + "members": { + "LoadBalancerName": {}, + "Instances": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "DeregisterInstancesFromLoadBalancerResult", + "type": "structure", + "members": { + "Instances": { + "shape": "S1p" + } + } + } + }, + "DescribeAccountLimits": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeAccountLimitsResult", + "type": "structure", + "members": { + "Limits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Max": {} + } + } + }, + "NextMarker": {} + } + } + }, + "DescribeInstanceHealth": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName" + ], + "members": { + "LoadBalancerName": {}, + "Instances": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "DescribeInstanceHealthResult", + "type": "structure", + "members": { + "InstanceStates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "State": {}, + "ReasonCode": {}, + "Description": {} + } + } + } + } + } + }, + "DescribeLoadBalancerAttributes": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName" + ], + "members": { + "LoadBalancerName": {} + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerAttributesResult", + "type": "structure", + "members": { + "LoadBalancerAttributes": { + "shape": "S2a" + } + } + } + }, + "DescribeLoadBalancerPolicies": { + "input": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "PolicyNames": { + "shape": "S2s" + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerPoliciesResult", + "type": "structure", + "members": { + "PolicyDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "PolicyTypeName": {}, + "PolicyAttributeDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValue": {} + } + } + } + } + } + } + } + } + }, + "DescribeLoadBalancerPolicyTypes": { + "input": { + "type": "structure", + "members": { + "PolicyTypeNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerPolicyTypesResult", + "type": "structure", + "members": { + "PolicyTypeDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyTypeName": {}, + "Description": {}, + "PolicyAttributeTypeDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeType": {}, + "Description": {}, + "DefaultValue": {}, + "Cardinality": {} + } + } + } + } + } + } + } + } + }, + "DescribeLoadBalancers": { + "input": { + "type": "structure", + "members": { + "LoadBalancerNames": { + "shape": "S2" + }, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancersResult", + "type": "structure", + "members": { + "LoadBalancerDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "DNSName": {}, + "CanonicalHostedZoneName": {}, + "CanonicalHostedZoneNameID": {}, + "ListenerDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Listener": { + "shape": "Sy" + }, + "PolicyNames": { + "shape": "S2s" + } + } + } + }, + "Policies": { + "type": "structure", + "members": { + "AppCookieStickinessPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "CookieName": {} + } + } + }, + "LBCookieStickinessPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "CookieExpirationPeriod": { + "type": "long" + } + } + } + }, + "OtherPolicies": { + "shape": "S2s" + } + } + }, + "BackendServerDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstancePort": { + "type": "integer" + }, + "PolicyNames": { + "shape": "S2s" + } + } + } + }, + "AvailabilityZones": { + "shape": "S13" + }, + "Subnets": { + "shape": "Se" + }, + "VPCId": {}, + "Instances": { + "shape": "S1p" + }, + "HealthCheck": { + "shape": "Si" + }, + "SourceSecurityGroup": { + "type": "structure", + "members": { + "OwnerAlias": {}, + "GroupName": {} + } + }, + "SecurityGroups": { + "shape": "Sa" + }, + "CreatedTime": { + "type": "timestamp" + }, + "Scheme": {} + } + } + }, + "NextMarker": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerNames" + ], + "members": { + "LoadBalancerNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeTagsResult", + "type": "structure", + "members": { + "TagDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "Tags": { + "shape": "S4" + } + } + } + } + } + } + }, + "DetachLoadBalancerFromSubnets": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Subnets" + ], + "members": { + "LoadBalancerName": {}, + "Subnets": { + "shape": "Se" + } + } + }, + "output": { + "resultWrapper": "DetachLoadBalancerFromSubnetsResult", + "type": "structure", + "members": { + "Subnets": { + "shape": "Se" + } + } + } + }, + "DisableAvailabilityZonesForLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "AvailabilityZones" + ], + "members": { + "LoadBalancerName": {}, + "AvailabilityZones": { + "shape": "S13" + } + } + }, + "output": { + "resultWrapper": "DisableAvailabilityZonesForLoadBalancerResult", + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "S13" + } + } + } + }, + "EnableAvailabilityZonesForLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "AvailabilityZones" + ], + "members": { + "LoadBalancerName": {}, + "AvailabilityZones": { + "shape": "S13" + } + } + }, + "output": { + "resultWrapper": "EnableAvailabilityZonesForLoadBalancerResult", + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "S13" + } + } + } + }, + "ModifyLoadBalancerAttributes": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerAttributes" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerAttributes": { + "shape": "S2a" + } + } + }, + "output": { + "resultWrapper": "ModifyLoadBalancerAttributesResult", + "type": "structure", + "members": { + "LoadBalancerName": {}, + "LoadBalancerAttributes": { + "shape": "S2a" + } + } + } + }, + "RegisterInstancesWithLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Instances" + ], + "members": { + "LoadBalancerName": {}, + "Instances": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "RegisterInstancesWithLoadBalancerResult", + "type": "structure", + "members": { + "Instances": { + "shape": "S1p" + } + } + } + }, + "RemoveTags": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerNames", + "Tags" + ], + "members": { + "LoadBalancerNames": { + "shape": "S2" + }, + "Tags": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {} + } + } + } + } + }, + "output": { + "resultWrapper": "RemoveTagsResult", + "type": "structure", + "members": {} + } + }, + "SetLoadBalancerListenerSSLCertificate": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerPort", + "SSLCertificateId" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerPort": { + "type": "integer" + }, + "SSLCertificateId": {} + } + }, + "output": { + "resultWrapper": "SetLoadBalancerListenerSSLCertificateResult", + "type": "structure", + "members": {} + } + }, + "SetLoadBalancerPoliciesForBackendServer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "InstancePort", + "PolicyNames" + ], + "members": { + "LoadBalancerName": {}, + "InstancePort": { + "type": "integer" + }, + "PolicyNames": { + "shape": "S2s" + } + } + }, + "output": { + "resultWrapper": "SetLoadBalancerPoliciesForBackendServerResult", + "type": "structure", + "members": {} + } + }, + "SetLoadBalancerPoliciesOfListener": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerPort", + "PolicyNames" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerPort": { + "type": "integer" + }, + "PolicyNames": { + "shape": "S2s" + } + } + }, + "output": { + "resultWrapper": "SetLoadBalancerPoliciesOfListenerResult", + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "S4": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sa": { + "type": "list", + "member": {} + }, + "Se": { + "type": "list", + "member": {} + }, + "Si": { + "type": "structure", + "required": [ + "Target", + "Interval", + "Timeout", + "UnhealthyThreshold", + "HealthyThreshold" + ], + "members": { + "Target": {}, + "Interval": { + "type": "integer" + }, + "Timeout": { + "type": "integer" + }, + "UnhealthyThreshold": { + "type": "integer" + }, + "HealthyThreshold": { + "type": "integer" + } + } + }, + "Sx": { + "type": "list", + "member": { + "shape": "Sy" + } + }, + "Sy": { + "type": "structure", + "required": [ + "Protocol", + "LoadBalancerPort", + "InstancePort" + ], + "members": { + "Protocol": {}, + "LoadBalancerPort": { + "type": "integer" + }, + "InstanceProtocol": {}, + "InstancePort": { + "type": "integer" + }, + "SSLCertificateId": {} + } + }, + "S13": { + "type": "list", + "member": {} + }, + "S1p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {} + } + } + }, + "S2a": { + "type": "structure", + "members": { + "CrossZoneLoadBalancing": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "AccessLog": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "S3BucketName": {}, + "EmitInterval": { + "type": "integer" + }, + "S3BucketPrefix": {} + } + }, + "ConnectionDraining": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Timeout": { + "type": "integer" + } + } + }, + "ConnectionSettings": { + "type": "structure", + "required": [ + "IdleTimeout" + ], + "members": { + "IdleTimeout": { + "type": "integer" + } + } + }, + "AdditionalAttributes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "S2s": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.paginators.json b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.paginators.json new file mode 100644 index 0000000..85742cc --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.paginators.json @@ -0,0 +1,18 @@ +{ + "pagination": { + "DescribeInstanceHealth": { + "result_key": "InstanceStates" + }, + "DescribeLoadBalancerPolicies": { + "result_key": "PolicyDescriptions" + }, + "DescribeLoadBalancerPolicyTypes": { + "result_key": "PolicyTypeDescriptions" + }, + "DescribeLoadBalancers": { + "input_token": "Marker", + "output_token": "NextMarker", + "result_key": "LoadBalancerDescriptions" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.waiters2.json b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.waiters2.json new file mode 100644 index 0000000..182e070 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancing-2012-06-01.waiters2.json @@ -0,0 +1,54 @@ +{ + "version":2, + "waiters":{ + "InstanceDeregistered": { + "delay": 15, + "operation": "DescribeInstanceHealth", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "OutOfService", + "matcher": "pathAll", + "state": "success", + "argument": "InstanceStates[].State" + }, + { + "matcher": "error", + "expected": "InvalidInstance", + "state": "success" + } + ] + }, + "AnyInstanceInService":{ + "acceptors":[ + { + "argument":"InstanceStates[].State", + "expected":"InService", + "matcher":"pathAny", + "state":"success" + } + ], + "delay":15, + "maxAttempts":40, + "operation":"DescribeInstanceHealth" + }, + "InstanceInService":{ + "acceptors":[ + { + "argument":"InstanceStates[].State", + "expected":"InService", + "matcher":"pathAll", + "state":"success" + }, + { + "matcher": "error", + "expected": "InvalidInstance", + "state": "retry" + } + ], + "delay":15, + "maxAttempts":40, + "operation":"DescribeInstanceHealth" + } + } +} diff --git a/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.examples.json b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.examples.json new file mode 100644 index 0000000..508b099 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.examples.json @@ -0,0 +1,1384 @@ +{ + "version": "1.0", + "examples": { + "AddTags": [ + { + "input": { + "ResourceArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified tags to the specified load balancer.", + "id": "elbv2-add-tags-1", + "title": "To add tags to a load balancer" + } + ], + "CreateListener": [ + { + "input": { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + }, + "output": { + "Listeners": [ + { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.", + "id": "elbv2-create-listener-1", + "title": "To create an HTTP listener" + }, + { + "input": { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "Protocol": "HTTPS", + "SslPolicy": "ELBSecurityPolicy-2015-05" + }, + "output": { + "Listeners": [ + { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "Protocol": "HTTPS", + "SslPolicy": "ELBSecurityPolicy-2015-05" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).", + "id": "elbv2-create-listener-2", + "title": "To create an HTTPS listener" + } + ], + "CreateLoadBalancer": [ + { + "input": { + "Name": "my-load-balancer", + "Subnets": [ + "subnet-b7d581c0", + "subnet-8360a9e7" + ] + }, + "output": { + "LoadBalancers": [ + { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ], + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "CreatedTime": "2016-03-25T21:26:12.920Z", + "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "LoadBalancerName": "my-load-balancer", + "Scheme": "internet-facing", + "SecurityGroups": [ + "sg-5943793c" + ], + "State": { + "Code": "provisioning" + }, + "Type": "application", + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.", + "id": "elbv2-create-load-balancer-1", + "title": "To create an Internet-facing load balancer" + }, + { + "input": { + "Name": "my-internal-load-balancer", + "Scheme": "internal", + "SecurityGroups": [ + + ], + "Subnets": [ + "subnet-b7d581c0", + "subnet-8360a9e7" + ] + }, + "output": { + "LoadBalancers": [ + { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ], + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "CreatedTime": "2016-03-25T21:29:48.850Z", + "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2", + "LoadBalancerName": "my-internal-load-balancer", + "Scheme": "internal", + "SecurityGroups": [ + "sg-5943793c" + ], + "State": { + "Code": "provisioning" + }, + "Type": "application", + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an internal load balancer and enables the Availability Zones for the specified subnets.", + "id": "elbv2-create-load-balancer-2", + "title": "To create an internal load balancer" + } + ], + "CreateRule": [ + { + "input": { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "Priority": 10 + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "IsDefault": false, + "Priority": "10", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).", + "id": "elbv2-create-rule-1", + "title": "To create a rule" + } + ], + "CreateTargetGroup": [ + { + "input": { + "Name": "my-targets", + "Port": 80, + "Protocol": "HTTP", + "VpcId": "vpc-3ac0fb5f" + }, + "output": { + "TargetGroups": [ + { + "HealthCheckIntervalSeconds": 30, + "HealthCheckPath": "/", + "HealthCheckPort": "traffic-port", + "HealthCheckProtocol": "HTTP", + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "Matcher": { + "HttpCode": "200" + }, + "Port": 80, + "Protocol": "HTTP", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "TargetGroupName": "my-targets", + "UnhealthyThresholdCount": 2, + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.", + "id": "elbv2-create-target-group-1", + "title": "To create a target group" + } + ], + "DeleteListener": [ + { + "input": { + "ListenerArn": "arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified listener.", + "id": "elbv2-delete-listener-1", + "title": "To delete a listener" + } + ], + "DeleteLoadBalancer": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified load balancer.", + "id": "elbv2-delete-load-balancer-1", + "title": "To delete a load balancer" + } + ], + "DeleteRule": [ + { + "input": { + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified rule.", + "id": "elbv2-delete-rule-1", + "title": "To delete a rule" + } + ], + "DeleteTargetGroup": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified target group.", + "id": "elbv2-delete-target-group-1", + "title": "To delete a target group" + } + ], + "DeregisterTargets": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-0f76fade" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters the specified instance from the specified target group.", + "id": "elbv2-deregister-targets-1", + "title": "To deregister a target from a target group" + } + ], + "DescribeListeners": [ + { + "input": { + "ListenerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + ] + }, + "output": { + "Listeners": [ + { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified listener.", + "id": "elbv2-describe-listeners-1", + "title": "To describe a listener" + } + ], + "DescribeLoadBalancerAttributes": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "false" + }, + { + "Key": "idle_timeout.timeout_seconds", + "Value": "60" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "" + }, + { + "Key": "deletion_protection.enabled", + "Value": "false" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes of the specified load balancer.", + "id": "elbv2-describe-load-balancer-attributes-1", + "title": "To describe load balancer attributes" + } + ], + "DescribeLoadBalancers": [ + { + "input": { + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ] + }, + "output": { + "LoadBalancers": [ + { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ], + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "CreatedTime": "2016-03-25T21:26:12.920Z", + "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "LoadBalancerName": "my-load-balancer", + "Scheme": "internet-facing", + "SecurityGroups": [ + "sg-5943793c" + ], + "State": { + "Code": "active" + }, + "Type": "application", + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified load balancer.", + "id": "elbv2-describe-load-balancers-1", + "title": "To describe a load balancer" + } + ], + "DescribeRules": [ + { + "input": { + "RuleArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + ] + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "IsDefault": false, + "Priority": "10", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified rule.", + "id": "elbv2-describe-rules-1", + "title": "To describe a rule" + } + ], + "DescribeSSLPolicies": [ + { + "input": { + "Names": [ + "ELBSecurityPolicy-2015-05" + ] + }, + "output": { + "SslPolicies": [ + { + "Ciphers": [ + { + "Name": "ECDHE-ECDSA-AES128-GCM-SHA256", + "Priority": 1 + }, + { + "Name": "ECDHE-RSA-AES128-GCM-SHA256", + "Priority": 2 + }, + { + "Name": "ECDHE-ECDSA-AES128-SHA256", + "Priority": 3 + }, + { + "Name": "ECDHE-RSA-AES128-SHA256", + "Priority": 4 + }, + { + "Name": "ECDHE-ECDSA-AES128-SHA", + "Priority": 5 + }, + { + "Name": "ECDHE-RSA-AES128-SHA", + "Priority": 6 + }, + { + "Name": "DHE-RSA-AES128-SHA", + "Priority": 7 + }, + { + "Name": "ECDHE-ECDSA-AES256-GCM-SHA384", + "Priority": 8 + }, + { + "Name": "ECDHE-RSA-AES256-GCM-SHA384", + "Priority": 9 + }, + { + "Name": "ECDHE-ECDSA-AES256-SHA384", + "Priority": 10 + }, + { + "Name": "ECDHE-RSA-AES256-SHA384", + "Priority": 11 + }, + { + "Name": "ECDHE-RSA-AES256-SHA", + "Priority": 12 + }, + { + "Name": "ECDHE-ECDSA-AES256-SHA", + "Priority": 13 + }, + { + "Name": "AES128-GCM-SHA256", + "Priority": 14 + }, + { + "Name": "AES128-SHA256", + "Priority": 15 + }, + { + "Name": "AES128-SHA", + "Priority": 16 + }, + { + "Name": "AES256-GCM-SHA384", + "Priority": 17 + }, + { + "Name": "AES256-SHA256", + "Priority": 18 + }, + { + "Name": "AES256-SHA", + "Priority": 19 + } + ], + "Name": "ELBSecurityPolicy-2015-05", + "SslProtocols": [ + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified policy used for SSL negotiation.", + "id": "elbv2-describe-ssl-policies-1", + "title": "To describe a policy used for SSL negotiation" + } + ], + "DescribeTags": [ + { + "input": { + "ResourceArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ] + }, + "output": { + "TagDescriptions": [ + { + "ResourceArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags assigned to the specified load balancer.", + "id": "elbv2-describe-tags-1", + "title": "To describe the tags assigned to a load balancer" + } + ], + "DescribeTargetGroupAttributes": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "output": { + "Attributes": [ + { + "Key": "stickiness.enabled", + "Value": "false" + }, + { + "Key": "deregistration_delay.timeout_seconds", + "Value": "300" + }, + { + "Key": "stickiness.type", + "Value": "lb_cookie" + }, + { + "Key": "stickiness.lb_cookie.duration_seconds", + "Value": "86400" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes of the specified target group.", + "id": "elbv2-describe-target-group-attributes-1", + "title": "To describe target group attributes" + } + ], + "DescribeTargetGroups": [ + { + "input": { + "TargetGroupArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + }, + "output": { + "TargetGroups": [ + { + "HealthCheckIntervalSeconds": 30, + "HealthCheckPath": "/", + "HealthCheckPort": "traffic-port", + "HealthCheckProtocol": "HTTP", + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "Matcher": { + "HttpCode": "200" + }, + "Port": 80, + "Protocol": "HTTP", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "TargetGroupName": "my-targets", + "UnhealthyThresholdCount": 2, + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified target group.", + "id": "elbv2-describe-target-groups-1", + "title": "To describe a target group" + } + ], + "DescribeTargetHealth": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "output": { + "TargetHealthDescriptions": [ + { + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "Description": "Given target group is not configured to receive traffic from ELB", + "Reason": "Target.NotInUse", + "State": "unused" + } + }, + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.", + "id": "elbv2-describe-target-health-1", + "title": "To describe the health of the targets for a target group" + }, + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-0f76fade", + "Port": 80 + } + ] + }, + "output": { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the health of the specified target. This target is healthy.", + "id": "elbv2-describe-target-health-2", + "title": "To describe the health of a target" + } + ], + "ModifyListener": [ + { + "input": { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + }, + "output": { + "Listeners": [ + { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the default action for the specified listener.", + "id": "elbv2-modify-listener-1", + "title": "To change the default action for a listener" + }, + { + "input": { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + }, + "output": { + "Listeners": [ + { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "Protocol": "HTTPS", + "SslPolicy": "ELBSecurityPolicy-2015-05" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the server certificate for the specified HTTPS listener.", + "id": "elbv2-modify-listener-2", + "title": "To change the server certificate" + } + ], + "ModifyLoadBalancerAttributes": [ + { + "input": { + "Attributes": [ + { + "Key": "deletion_protection.enabled", + "Value": "true" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "deletion_protection.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.enabled", + "Value": "false" + }, + { + "Key": "idle_timeout.timeout_seconds", + "Value": "60" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables deletion protection for the specified load balancer.", + "id": "elbv2-modify-load-balancer-attributes-1", + "title": "To enable deletion protection" + }, + { + "input": { + "Attributes": [ + { + "Key": "idle_timeout.timeout_seconds", + "Value": "30" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "idle_timeout.timeout_seconds", + "Value": "30" + }, + { + "Key": "access_logs.s3.enabled", + "Value": "false" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "" + }, + { + "Key": "deletion_protection.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the idle timeout value for the specified load balancer.", + "id": "elbv2-modify-load-balancer-attributes-2", + "title": "To change the idle timeout" + }, + { + "input": { + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "my-loadbalancer-logs" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "myapp" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "my-load-balancer-logs" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "myapp" + }, + { + "Key": "idle_timeout.timeout_seconds", + "Value": "60" + }, + { + "Key": "deletion_protection.enabled", + "Value": "false" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.", + "id": "elbv2-modify-load-balancer-attributes-3", + "title": "To enable access logs" + } + ], + "ModifyRule": [ + { + "input": { + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/images/*" + ] + } + ], + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/images/*" + ] + } + ], + "IsDefault": false, + "Priority": "10", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the condition for the specified rule.", + "id": "elbv2-modify-rule-1", + "title": "To modify a rule" + } + ], + "ModifyTargetGroup": [ + { + "input": { + "HealthCheckPort": "443", + "HealthCheckProtocol": "HTTPS", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f" + }, + "output": { + "TargetGroups": [ + { + "HealthCheckIntervalSeconds": 30, + "HealthCheckPort": "443", + "HealthCheckProtocol": "HTTPS", + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "Matcher": { + "HttpCode": "200" + }, + "Port": 443, + "Protocol": "HTTPS", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", + "TargetGroupName": "my-https-targets", + "UnhealthyThresholdCount": 2, + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.", + "id": "elbv2-modify-target-group-1", + "title": "To modify the health check configuration for a target group" + } + ], + "ModifyTargetGroupAttributes": [ + { + "input": { + "Attributes": [ + { + "Key": "deregistration_delay.timeout_seconds", + "Value": "600" + } + ], + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "output": { + "Attributes": [ + { + "Key": "stickiness.enabled", + "Value": "false" + }, + { + "Key": "deregistration_delay.timeout_seconds", + "Value": "600" + }, + { + "Key": "stickiness.type", + "Value": "lb_cookie" + }, + { + "Key": "stickiness.lb_cookie.duration_seconds", + "Value": "86400" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the deregistration delay timeout to the specified value for the specified target group.", + "id": "elbv2-modify-target-group-attributes-1", + "title": "To modify the deregistration delay timeout" + } + ], + "RegisterTargets": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-80c8dd94" + }, + { + "Id": "i-ceddcd4d" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers the specified instances with the specified target group.", + "id": "elbv2-register-targets-1", + "title": "To register targets with a target group" + }, + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", + "Targets": [ + { + "Id": "i-80c8dd94", + "Port": 80 + }, + { + "Id": "i-80c8dd94", + "Port": 766 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.", + "id": "elbv2-register-targets-2", + "title": "To register targets with a target group using port overrides" + } + ], + "RemoveTags": [ + { + "input": { + "ResourceArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "TagKeys": [ + "project", + "department" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified tags from the specified load balancer.", + "id": "elbv2-remove-tags-1", + "title": "To remove tags from a load balancer" + } + ], + "SetRulePriorities": [ + { + "input": { + "RulePriorities": [ + { + "Priority": 5, + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" + } + ] + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "IsDefault": false, + "Priority": "5", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the priority of the specified rule.", + "id": "elbv2-set-rule-priorities-1", + "title": "To set the rule priority" + } + ], + "SetSecurityGroups": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "SecurityGroups": [ + "sg-5943793c" + ] + }, + "output": { + "SecurityGroupIds": [ + "sg-5943793c" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified security group with the specified load balancer.", + "id": "elbv2-set-security-groups-1", + "title": "To associate a security group with a load balancer" + } + ], + "SetSubnets": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Subnets": [ + "subnet-8360a9e7", + "subnet-b7d581c0" + ] + }, + "output": { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables the Availability Zones for the specified subnets for the specified load balancer.", + "id": "elbv2-set-subnets-1", + "title": "To enable Availability Zones for a load balancer" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.min.json b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.min.json new file mode 100644 index 0000000..e35b193 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.min.json @@ -0,0 +1,1327 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-12-01", + "endpointPrefix": "elasticloadbalancing", + "protocol": "query", + "serviceAbbreviation": "Elastic Load Balancing v2", + "serviceFullName": "Elastic Load Balancing", + "serviceId": "Elastic Load Balancing v2", + "signatureVersion": "v4", + "uid": "elasticloadbalancingv2-2015-12-01", + "xmlNamespace": "http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/" + }, + "operations": { + "AddListenerCertificates": { + "input": { + "type": "structure", + "required": [ + "ListenerArn", + "Certificates" + ], + "members": { + "ListenerArn": {}, + "Certificates": { + "shape": "S3" + } + } + }, + "output": { + "resultWrapper": "AddListenerCertificatesResult", + "type": "structure", + "members": { + "Certificates": { + "shape": "S3" + } + } + } + }, + "AddTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArns", + "Tags" + ], + "members": { + "ResourceArns": { + "shape": "S9" + }, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "AddTagsResult", + "type": "structure", + "members": {} + } + }, + "CreateListener": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerArn", + "Protocol", + "Port", + "DefaultActions" + ], + "members": { + "LoadBalancerArn": {}, + "Protocol": {}, + "Port": { + "type": "integer" + }, + "SslPolicy": {}, + "Certificates": { + "shape": "S3" + }, + "DefaultActions": { + "shape": "Sl" + } + } + }, + "output": { + "resultWrapper": "CreateListenerResult", + "type": "structure", + "members": { + "Listeners": { + "shape": "S1s" + } + } + } + }, + "CreateLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Subnets": { + "shape": "S1w" + }, + "SubnetMappings": { + "shape": "S1y" + }, + "SecurityGroups": { + "shape": "S21" + }, + "Scheme": {}, + "Tags": { + "shape": "Sb" + }, + "Type": {}, + "IpAddressType": {} + } + }, + "output": { + "resultWrapper": "CreateLoadBalancerResult", + "type": "structure", + "members": { + "LoadBalancers": { + "shape": "S27" + } + } + } + }, + "CreateRule": { + "input": { + "type": "structure", + "required": [ + "ListenerArn", + "Conditions", + "Priority", + "Actions" + ], + "members": { + "ListenerArn": {}, + "Conditions": { + "shape": "S2n" + }, + "Priority": { + "type": "integer" + }, + "Actions": { + "shape": "Sl" + } + } + }, + "output": { + "resultWrapper": "CreateRuleResult", + "type": "structure", + "members": { + "Rules": { + "shape": "S33" + } + } + } + }, + "CreateTargetGroup": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Protocol": {}, + "Port": { + "type": "integer" + }, + "VpcId": {}, + "HealthCheckProtocol": {}, + "HealthCheckPort": {}, + "HealthCheckEnabled": { + "type": "boolean" + }, + "HealthCheckPath": {}, + "HealthCheckIntervalSeconds": { + "type": "integer" + }, + "HealthCheckTimeoutSeconds": { + "type": "integer" + }, + "HealthyThresholdCount": { + "type": "integer" + }, + "UnhealthyThresholdCount": { + "type": "integer" + }, + "Matcher": { + "shape": "S3g" + }, + "TargetType": {} + } + }, + "output": { + "resultWrapper": "CreateTargetGroupResult", + "type": "structure", + "members": { + "TargetGroups": { + "shape": "S3k" + } + } + } + }, + "DeleteListener": { + "input": { + "type": "structure", + "required": [ + "ListenerArn" + ], + "members": { + "ListenerArn": {} + } + }, + "output": { + "resultWrapper": "DeleteListenerResult", + "type": "structure", + "members": {} + } + }, + "DeleteLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerArn" + ], + "members": { + "LoadBalancerArn": {} + } + }, + "output": { + "resultWrapper": "DeleteLoadBalancerResult", + "type": "structure", + "members": {} + } + }, + "DeleteRule": { + "input": { + "type": "structure", + "required": [ + "RuleArn" + ], + "members": { + "RuleArn": {} + } + }, + "output": { + "resultWrapper": "DeleteRuleResult", + "type": "structure", + "members": {} + } + }, + "DeleteTargetGroup": { + "input": { + "type": "structure", + "required": [ + "TargetGroupArn" + ], + "members": { + "TargetGroupArn": {} + } + }, + "output": { + "resultWrapper": "DeleteTargetGroupResult", + "type": "structure", + "members": {} + } + }, + "DeregisterTargets": { + "input": { + "type": "structure", + "required": [ + "TargetGroupArn", + "Targets" + ], + "members": { + "TargetGroupArn": {}, + "Targets": { + "shape": "S3w" + } + } + }, + "output": { + "resultWrapper": "DeregisterTargetsResult", + "type": "structure", + "members": {} + } + }, + "DescribeAccountLimits": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeAccountLimitsResult", + "type": "structure", + "members": { + "Limits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Max": {} + } + } + }, + "NextMarker": {} + } + } + }, + "DescribeListenerCertificates": { + "input": { + "type": "structure", + "required": [ + "ListenerArn" + ], + "members": { + "ListenerArn": {}, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeListenerCertificatesResult", + "type": "structure", + "members": { + "Certificates": { + "shape": "S3" + }, + "NextMarker": {} + } + } + }, + "DescribeListeners": { + "input": { + "type": "structure", + "members": { + "LoadBalancerArn": {}, + "ListenerArns": { + "type": "list", + "member": {} + }, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeListenersResult", + "type": "structure", + "members": { + "Listeners": { + "shape": "S1s" + }, + "NextMarker": {} + } + } + }, + "DescribeLoadBalancerAttributes": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerArn" + ], + "members": { + "LoadBalancerArn": {} + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "S4f" + } + } + } + }, + "DescribeLoadBalancers": { + "input": { + "type": "structure", + "members": { + "LoadBalancerArns": { + "shape": "S3m" + }, + "Names": { + "type": "list", + "member": {} + }, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancersResult", + "type": "structure", + "members": { + "LoadBalancers": { + "shape": "S27" + }, + "NextMarker": {} + } + } + }, + "DescribeRules": { + "input": { + "type": "structure", + "members": { + "ListenerArn": {}, + "RuleArns": { + "type": "list", + "member": {} + }, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeRulesResult", + "type": "structure", + "members": { + "Rules": { + "shape": "S33" + }, + "NextMarker": {} + } + } + }, + "DescribeSSLPolicies": { + "input": { + "type": "structure", + "members": { + "Names": { + "type": "list", + "member": {} + }, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeSSLPoliciesResult", + "type": "structure", + "members": { + "SslPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SslProtocols": { + "type": "list", + "member": {} + }, + "Ciphers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Priority": { + "type": "integer" + } + } + } + }, + "Name": {} + } + } + }, + "NextMarker": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArns" + ], + "members": { + "ResourceArns": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "DescribeTagsResult", + "type": "structure", + "members": { + "TagDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "Sb" + } + } + } + } + } + } + }, + "DescribeTargetGroupAttributes": { + "input": { + "type": "structure", + "required": [ + "TargetGroupArn" + ], + "members": { + "TargetGroupArn": {} + } + }, + "output": { + "resultWrapper": "DescribeTargetGroupAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "S56" + } + } + } + }, + "DescribeTargetGroups": { + "input": { + "type": "structure", + "members": { + "LoadBalancerArn": {}, + "TargetGroupArns": { + "type": "list", + "member": {} + }, + "Names": { + "type": "list", + "member": {} + }, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeTargetGroupsResult", + "type": "structure", + "members": { + "TargetGroups": { + "shape": "S3k" + }, + "NextMarker": {} + } + } + }, + "DescribeTargetHealth": { + "input": { + "type": "structure", + "required": [ + "TargetGroupArn" + ], + "members": { + "TargetGroupArn": {}, + "Targets": { + "shape": "S3w" + } + } + }, + "output": { + "resultWrapper": "DescribeTargetHealthResult", + "type": "structure", + "members": { + "TargetHealthDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Target": { + "shape": "S3x" + }, + "HealthCheckPort": {}, + "TargetHealth": { + "type": "structure", + "members": { + "State": {}, + "Reason": {}, + "Description": {} + } + } + } + } + } + } + } + }, + "ModifyListener": { + "input": { + "type": "structure", + "required": [ + "ListenerArn" + ], + "members": { + "ListenerArn": {}, + "Port": { + "type": "integer" + }, + "Protocol": {}, + "SslPolicy": {}, + "Certificates": { + "shape": "S3" + }, + "DefaultActions": { + "shape": "Sl" + } + } + }, + "output": { + "resultWrapper": "ModifyListenerResult", + "type": "structure", + "members": { + "Listeners": { + "shape": "S1s" + } + } + } + }, + "ModifyLoadBalancerAttributes": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerArn", + "Attributes" + ], + "members": { + "LoadBalancerArn": {}, + "Attributes": { + "shape": "S4f" + } + } + }, + "output": { + "resultWrapper": "ModifyLoadBalancerAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "S4f" + } + } + } + }, + "ModifyRule": { + "input": { + "type": "structure", + "required": [ + "RuleArn" + ], + "members": { + "RuleArn": {}, + "Conditions": { + "shape": "S2n" + }, + "Actions": { + "shape": "Sl" + } + } + }, + "output": { + "resultWrapper": "ModifyRuleResult", + "type": "structure", + "members": { + "Rules": { + "shape": "S33" + } + } + } + }, + "ModifyTargetGroup": { + "input": { + "type": "structure", + "required": [ + "TargetGroupArn" + ], + "members": { + "TargetGroupArn": {}, + "HealthCheckProtocol": {}, + "HealthCheckPort": {}, + "HealthCheckPath": {}, + "HealthCheckEnabled": { + "type": "boolean" + }, + "HealthCheckIntervalSeconds": { + "type": "integer" + }, + "HealthCheckTimeoutSeconds": { + "type": "integer" + }, + "HealthyThresholdCount": { + "type": "integer" + }, + "UnhealthyThresholdCount": { + "type": "integer" + }, + "Matcher": { + "shape": "S3g" + } + } + }, + "output": { + "resultWrapper": "ModifyTargetGroupResult", + "type": "structure", + "members": { + "TargetGroups": { + "shape": "S3k" + } + } + } + }, + "ModifyTargetGroupAttributes": { + "input": { + "type": "structure", + "required": [ + "TargetGroupArn", + "Attributes" + ], + "members": { + "TargetGroupArn": {}, + "Attributes": { + "shape": "S56" + } + } + }, + "output": { + "resultWrapper": "ModifyTargetGroupAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "S56" + } + } + } + }, + "RegisterTargets": { + "input": { + "type": "structure", + "required": [ + "TargetGroupArn", + "Targets" + ], + "members": { + "TargetGroupArn": {}, + "Targets": { + "shape": "S3w" + } + } + }, + "output": { + "resultWrapper": "RegisterTargetsResult", + "type": "structure", + "members": {} + } + }, + "RemoveListenerCertificates": { + "input": { + "type": "structure", + "required": [ + "ListenerArn", + "Certificates" + ], + "members": { + "ListenerArn": {}, + "Certificates": { + "shape": "S3" + } + } + }, + "output": { + "resultWrapper": "RemoveListenerCertificatesResult", + "type": "structure", + "members": {} + } + }, + "RemoveTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArns", + "TagKeys" + ], + "members": { + "ResourceArns": { + "shape": "S9" + }, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "RemoveTagsResult", + "type": "structure", + "members": {} + } + }, + "SetIpAddressType": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerArn", + "IpAddressType" + ], + "members": { + "LoadBalancerArn": {}, + "IpAddressType": {} + } + }, + "output": { + "resultWrapper": "SetIpAddressTypeResult", + "type": "structure", + "members": { + "IpAddressType": {} + } + } + }, + "SetRulePriorities": { + "input": { + "type": "structure", + "required": [ + "RulePriorities" + ], + "members": { + "RulePriorities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RuleArn": {}, + "Priority": { + "type": "integer" + } + } + } + } + } + }, + "output": { + "resultWrapper": "SetRulePrioritiesResult", + "type": "structure", + "members": { + "Rules": { + "shape": "S33" + } + } + } + }, + "SetSecurityGroups": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerArn", + "SecurityGroups" + ], + "members": { + "LoadBalancerArn": {}, + "SecurityGroups": { + "shape": "S21" + } + } + }, + "output": { + "resultWrapper": "SetSecurityGroupsResult", + "type": "structure", + "members": { + "SecurityGroupIds": { + "shape": "S21" + } + } + } + }, + "SetSubnets": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerArn" + ], + "members": { + "LoadBalancerArn": {}, + "Subnets": { + "shape": "S1w" + }, + "SubnetMappings": { + "shape": "S1y" + } + } + }, + "output": { + "resultWrapper": "SetSubnetsResult", + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "S2g" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CertificateArn": {}, + "IsDefault": { + "type": "boolean" + } + } + } + }, + "S9": { + "type": "list", + "member": {} + }, + "Sb": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sl": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "TargetGroupArn": {}, + "AuthenticateOidcConfig": { + "type": "structure", + "required": [ + "Issuer", + "AuthorizationEndpoint", + "TokenEndpoint", + "UserInfoEndpoint", + "ClientId" + ], + "members": { + "Issuer": {}, + "AuthorizationEndpoint": {}, + "TokenEndpoint": {}, + "UserInfoEndpoint": {}, + "ClientId": {}, + "ClientSecret": {}, + "SessionCookieName": {}, + "Scope": {}, + "SessionTimeout": { + "type": "long" + }, + "AuthenticationRequestExtraParams": { + "type": "map", + "key": {}, + "value": {} + }, + "OnUnauthenticatedRequest": {}, + "UseExistingClientSecret": { + "type": "boolean" + } + } + }, + "AuthenticateCognitoConfig": { + "type": "structure", + "required": [ + "UserPoolArn", + "UserPoolClientId", + "UserPoolDomain" + ], + "members": { + "UserPoolArn": {}, + "UserPoolClientId": {}, + "UserPoolDomain": {}, + "SessionCookieName": {}, + "Scope": {}, + "SessionTimeout": { + "type": "long" + }, + "AuthenticationRequestExtraParams": { + "type": "map", + "key": {}, + "value": {} + }, + "OnUnauthenticatedRequest": {} + } + }, + "Order": { + "type": "integer" + }, + "RedirectConfig": { + "type": "structure", + "required": [ + "StatusCode" + ], + "members": { + "Protocol": {}, + "Port": {}, + "Host": {}, + "Path": {}, + "Query": {}, + "StatusCode": {} + } + }, + "FixedResponseConfig": { + "type": "structure", + "required": [ + "StatusCode" + ], + "members": { + "MessageBody": {}, + "StatusCode": {}, + "ContentType": {} + } + } + } + } + }, + "S1s": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ListenerArn": {}, + "LoadBalancerArn": {}, + "Port": { + "type": "integer" + }, + "Protocol": {}, + "Certificates": { + "shape": "S3" + }, + "SslPolicy": {}, + "DefaultActions": { + "shape": "Sl" + } + } + } + }, + "S1w": { + "type": "list", + "member": {} + }, + "S1y": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SubnetId": {}, + "AllocationId": {} + } + } + }, + "S21": { + "type": "list", + "member": {} + }, + "S27": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LoadBalancerArn": {}, + "DNSName": {}, + "CanonicalHostedZoneId": {}, + "CreatedTime": { + "type": "timestamp" + }, + "LoadBalancerName": {}, + "Scheme": {}, + "VpcId": {}, + "State": { + "type": "structure", + "members": { + "Code": {}, + "Reason": {} + } + }, + "Type": {}, + "AvailabilityZones": { + "shape": "S2g" + }, + "SecurityGroups": { + "shape": "S21" + }, + "IpAddressType": {} + } + } + }, + "S2g": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ZoneName": {}, + "SubnetId": {}, + "LoadBalancerAddresses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IpAddress": {}, + "AllocationId": {} + } + } + } + } + } + }, + "S2n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Field": {}, + "Values": { + "shape": "S2q" + }, + "HostHeaderConfig": { + "type": "structure", + "members": { + "Values": { + "shape": "S2q" + } + } + }, + "PathPatternConfig": { + "type": "structure", + "members": { + "Values": { + "shape": "S2q" + } + } + }, + "HttpHeaderConfig": { + "type": "structure", + "members": { + "HttpHeaderName": {}, + "Values": { + "shape": "S2q" + } + } + }, + "QueryStringConfig": { + "type": "structure", + "members": { + "Values": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "HttpRequestMethodConfig": { + "type": "structure", + "members": { + "Values": { + "shape": "S2q" + } + } + }, + "SourceIpConfig": { + "type": "structure", + "members": { + "Values": { + "shape": "S2q" + } + } + } + } + } + }, + "S2q": { + "type": "list", + "member": {} + }, + "S33": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RuleArn": {}, + "Priority": {}, + "Conditions": { + "shape": "S2n" + }, + "Actions": { + "shape": "Sl" + }, + "IsDefault": { + "type": "boolean" + } + } + } + }, + "S3g": { + "type": "structure", + "required": [ + "HttpCode" + ], + "members": { + "HttpCode": {} + } + }, + "S3k": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TargetGroupArn": {}, + "TargetGroupName": {}, + "Protocol": {}, + "Port": { + "type": "integer" + }, + "VpcId": {}, + "HealthCheckProtocol": {}, + "HealthCheckPort": {}, + "HealthCheckEnabled": { + "type": "boolean" + }, + "HealthCheckIntervalSeconds": { + "type": "integer" + }, + "HealthCheckTimeoutSeconds": { + "type": "integer" + }, + "HealthyThresholdCount": { + "type": "integer" + }, + "UnhealthyThresholdCount": { + "type": "integer" + }, + "HealthCheckPath": {}, + "Matcher": { + "shape": "S3g" + }, + "LoadBalancerArns": { + "shape": "S3m" + }, + "TargetType": {} + } + } + }, + "S3m": { + "type": "list", + "member": {} + }, + "S3w": { + "type": "list", + "member": { + "shape": "S3x" + } + }, + "S3x": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {} + } + }, + "S4f": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S56": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.paginators.json b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.paginators.json new file mode 100644 index 0000000..1a281f2 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "DescribeListeners": { + "input_token": "Marker", + "output_token": "NextMarker", + "result_key": "Listeners" + }, + "DescribeLoadBalancers": { + "input_token": "Marker", + "output_token": "NextMarker", + "result_key": "LoadBalancers" + }, + "DescribeTargetGroups": { + "input_token": "Marker", + "output_token": "NextMarker", + "result_key": "TargetGroups" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.waiters2.json b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.waiters2.json new file mode 100644 index 0000000..9f3d77d --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.waiters2.json @@ -0,0 +1,100 @@ +{ + "version": 2, + "waiters": { + "LoadBalancerExists": { + "delay": 15, + "operation": "DescribeLoadBalancers", + "maxAttempts": 40, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "LoadBalancerNotFound", + "state": "retry" + } + ] + }, + "LoadBalancerAvailable": { + "delay": 15, + "operation": "DescribeLoadBalancers", + "maxAttempts": 40, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "LoadBalancers[].State.Code", + "expected": "active" + }, + { + "state": "retry", + "matcher": "pathAny", + "argument": "LoadBalancers[].State.Code", + "expected": "provisioning" + }, + { + "state": "retry", + "matcher": "error", + "expected": "LoadBalancerNotFound" + } + ] + }, + "LoadBalancersDeleted": { + "delay": 15, + "operation": "DescribeLoadBalancers", + "maxAttempts": 40, + "acceptors": [ + { + "state": "retry", + "matcher": "pathAll", + "argument": "LoadBalancers[].State.Code", + "expected": "active" + }, + { + "matcher": "error", + "expected": "LoadBalancerNotFound", + "state": "success" + } + ] + }, + "TargetInService":{ + "delay":15, + "maxAttempts":40, + "operation":"DescribeTargetHealth", + "acceptors":[ + { + "argument":"TargetHealthDescriptions[].TargetHealth.State", + "expected":"healthy", + "matcher":"pathAll", + "state":"success" + }, + { + "matcher": "error", + "expected": "InvalidInstance", + "state": "retry" + } + ] + }, + "TargetDeregistered": { + "delay": 15, + "maxAttempts": 40, + "operation": "DescribeTargetHealth", + "acceptors": [ + { + "matcher": "error", + "expected": "InvalidTarget", + "state": "success" + }, + { + "argument":"TargetHealthDescriptions[].TargetHealth.State", + "expected":"unused", + "matcher":"pathAll", + "state":"success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.examples.json b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json new file mode 100644 index 0000000..0be7432 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json @@ -0,0 +1,1751 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2009-03-31", + "endpointPrefix": "elasticmapreduce", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Amazon EMR", + "serviceFullName": "Amazon Elastic MapReduce", + "serviceId": "EMR", + "signatureVersion": "v4", + "targetPrefix": "ElasticMapReduce", + "uid": "elasticmapreduce-2009-03-31" + }, + "operations": { + "AddInstanceFleet": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "InstanceFleet" + ], + "members": { + "ClusterId": {}, + "InstanceFleet": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClusterId": {}, + "InstanceFleetId": {} + } + } + }, + "AddInstanceGroups": { + "input": { + "type": "structure", + "required": [ + "InstanceGroups", + "JobFlowId" + ], + "members": { + "InstanceGroups": { + "shape": "Sq" + }, + "JobFlowId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobFlowId": {}, + "InstanceGroupIds": { + "type": "list", + "member": {} + } + } + } + }, + "AddJobFlowSteps": { + "input": { + "type": "structure", + "required": [ + "JobFlowId", + "Steps" + ], + "members": { + "JobFlowId": {}, + "Steps": { + "shape": "S1b" + } + } + }, + "output": { + "type": "structure", + "members": { + "StepIds": { + "shape": "S1k" + } + } + } + }, + "AddTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "Tags" + ], + "members": { + "ResourceId": {}, + "Tags": { + "shape": "S1n" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelSteps": { + "input": { + "type": "structure", + "members": { + "ClusterId": {}, + "StepIds": { + "shape": "S1k" + } + } + }, + "output": { + "type": "structure", + "members": { + "CancelStepsInfoList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StepId": {}, + "Status": {}, + "Reason": {} + } + } + } + } + } + }, + "CreateSecurityConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name", + "SecurityConfiguration" + ], + "members": { + "Name": {}, + "SecurityConfiguration": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Name", + "CreationDateTime" + ], + "members": { + "Name": {}, + "CreationDateTime": { + "type": "timestamp" + } + } + } + }, + "DeleteSecurityConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Status": { + "shape": "S25" + }, + "Ec2InstanceAttributes": { + "type": "structure", + "members": { + "Ec2KeyName": {}, + "Ec2SubnetId": {}, + "RequestedEc2SubnetIds": { + "shape": "S2b" + }, + "Ec2AvailabilityZone": {}, + "RequestedEc2AvailabilityZones": { + "shape": "S2b" + }, + "IamInstanceProfile": {}, + "EmrManagedMasterSecurityGroup": {}, + "EmrManagedSlaveSecurityGroup": {}, + "ServiceAccessSecurityGroup": {}, + "AdditionalMasterSecurityGroups": { + "shape": "S2c" + }, + "AdditionalSlaveSecurityGroups": { + "shape": "S2c" + } + } + }, + "InstanceCollectionType": {}, + "LogUri": {}, + "RequestedAmiVersion": {}, + "RunningAmiVersion": {}, + "ReleaseLabel": {}, + "AutoTerminate": { + "type": "boolean" + }, + "TerminationProtected": { + "type": "boolean" + }, + "VisibleToAllUsers": { + "type": "boolean" + }, + "Applications": { + "shape": "S2f" + }, + "Tags": { + "shape": "S1n" + }, + "ServiceRole": {}, + "NormalizedInstanceHours": { + "type": "integer" + }, + "MasterPublicDnsName": {}, + "Configurations": { + "shape": "Sh" + }, + "SecurityConfiguration": {}, + "AutoScalingRole": {}, + "ScaleDownBehavior": {}, + "CustomAmiId": {}, + "EbsRootVolumeSize": { + "type": "integer" + }, + "RepoUpgradeOnBoot": {}, + "KerberosAttributes": { + "shape": "S2j" + } + } + } + } + } + }, + "DescribeJobFlows": { + "input": { + "type": "structure", + "members": { + "CreatedAfter": { + "type": "timestamp" + }, + "CreatedBefore": { + "type": "timestamp" + }, + "JobFlowIds": { + "shape": "S1i" + }, + "JobFlowStates": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "JobFlows": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "JobFlowId", + "Name", + "ExecutionStatusDetail", + "Instances" + ], + "members": { + "JobFlowId": {}, + "Name": {}, + "LogUri": {}, + "AmiVersion": {}, + "ExecutionStatusDetail": { + "type": "structure", + "required": [ + "State", + "CreationDateTime" + ], + "members": { + "State": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + }, + "LastStateChangeReason": {} + } + }, + "Instances": { + "type": "structure", + "required": [ + "MasterInstanceType", + "SlaveInstanceType", + "InstanceCount" + ], + "members": { + "MasterInstanceType": {}, + "MasterPublicDnsName": {}, + "MasterInstanceId": {}, + "SlaveInstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "InstanceGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Market", + "InstanceRole", + "InstanceType", + "InstanceRequestCount", + "InstanceRunningCount", + "State", + "CreationDateTime" + ], + "members": { + "InstanceGroupId": {}, + "Name": {}, + "Market": {}, + "InstanceRole": {}, + "BidPrice": {}, + "InstanceType": {}, + "InstanceRequestCount": { + "type": "integer" + }, + "InstanceRunningCount": { + "type": "integer" + }, + "State": {}, + "LastStateChangeReason": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + }, + "NormalizedInstanceHours": { + "type": "integer" + }, + "Ec2KeyName": {}, + "Ec2SubnetId": {}, + "Placement": { + "shape": "S2v" + }, + "KeepJobFlowAliveWhenNoSteps": { + "type": "boolean" + }, + "TerminationProtected": { + "type": "boolean" + }, + "HadoopVersion": {} + } + }, + "Steps": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StepConfig", + "ExecutionStatusDetail" + ], + "members": { + "StepConfig": { + "shape": "S1c" + }, + "ExecutionStatusDetail": { + "type": "structure", + "required": [ + "State", + "CreationDateTime" + ], + "members": { + "State": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + }, + "LastStateChangeReason": {} + } + } + } + } + }, + "BootstrapActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BootstrapActionConfig": { + "shape": "S32" + } + } + } + }, + "SupportedProducts": { + "shape": "S34" + }, + "VisibleToAllUsers": { + "type": "boolean" + }, + "JobFlowRole": {}, + "ServiceRole": {}, + "AutoScalingRole": {}, + "ScaleDownBehavior": {} + } + } + } + } + }, + "deprecated": true + }, + "DescribeSecurityConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "SecurityConfiguration": {}, + "CreationDateTime": { + "type": "timestamp" + } + } + } + }, + "DescribeStep": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "StepId" + ], + "members": { + "ClusterId": {}, + "StepId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Step": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Config": { + "shape": "S3a" + }, + "ActionOnFailure": {}, + "Status": { + "shape": "S3b" + } + } + } + } + } + }, + "ListBootstrapActions": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "BootstrapActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "ScriptPath": {}, + "Args": { + "shape": "S2c" + } + } + } + }, + "Marker": {} + } + } + }, + "ListClusters": { + "input": { + "type": "structure", + "members": { + "CreatedAfter": { + "type": "timestamp" + }, + "CreatedBefore": { + "type": "timestamp" + }, + "ClusterStates": { + "type": "list", + "member": {} + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Clusters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Status": { + "shape": "S25" + }, + "NormalizedInstanceHours": { + "type": "integer" + } + } + } + }, + "Marker": {} + } + } + }, + "ListInstanceFleets": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceFleets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Status": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + }, + "InstanceFleetType": {}, + "TargetOnDemandCapacity": { + "type": "integer" + }, + "TargetSpotCapacity": { + "type": "integer" + }, + "ProvisionedOnDemandCapacity": { + "type": "integer" + }, + "ProvisionedSpotCapacity": { + "type": "integer" + }, + "InstanceTypeSpecifications": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceType": {}, + "WeightedCapacity": { + "type": "integer" + }, + "BidPrice": {}, + "BidPriceAsPercentageOfOnDemandPrice": { + "type": "double" + }, + "Configurations": { + "shape": "Sh" + }, + "EbsBlockDevices": { + "shape": "S42" + }, + "EbsOptimized": { + "type": "boolean" + } + } + } + }, + "LaunchSpecifications": { + "shape": "Sk" + } + } + } + }, + "Marker": {} + } + } + }, + "ListInstanceGroups": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Market": {}, + "InstanceGroupType": {}, + "BidPrice": {}, + "InstanceType": {}, + "RequestedInstanceCount": { + "type": "integer" + }, + "RunningInstanceCount": { + "type": "integer" + }, + "Status": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + }, + "Configurations": { + "shape": "Sh" + }, + "ConfigurationsVersion": { + "type": "long" + }, + "LastSuccessfullyAppliedConfigurations": { + "shape": "Sh" + }, + "LastSuccessfullyAppliedConfigurationsVersion": { + "type": "long" + }, + "EbsBlockDevices": { + "shape": "S42" + }, + "EbsOptimized": { + "type": "boolean" + }, + "ShrinkPolicy": { + "shape": "S4f" + }, + "AutoScalingPolicy": { + "shape": "S4j" + } + } + } + }, + "Marker": {} + } + } + }, + "ListInstances": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "InstanceGroupId": {}, + "InstanceGroupTypes": { + "type": "list", + "member": {} + }, + "InstanceFleetId": {}, + "InstanceFleetType": {}, + "InstanceStates": { + "type": "list", + "member": {} + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Ec2InstanceId": {}, + "PublicDnsName": {}, + "PublicIpAddress": {}, + "PrivateDnsName": {}, + "PrivateIpAddress": {}, + "Status": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + }, + "InstanceGroupId": {}, + "InstanceFleetId": {}, + "Market": {}, + "InstanceType": {}, + "EbsVolumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Device": {}, + "VolumeId": {} + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "ListSecurityConfigurations": { + "input": { + "type": "structure", + "members": { + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "SecurityConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "CreationDateTime": { + "type": "timestamp" + } + } + } + }, + "Marker": {} + } + } + }, + "ListSteps": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "StepStates": { + "type": "list", + "member": {} + }, + "StepIds": { + "shape": "S1i" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Steps": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Config": { + "shape": "S3a" + }, + "ActionOnFailure": {}, + "Status": { + "shape": "S3b" + } + } + } + }, + "Marker": {} + } + } + }, + "ModifyInstanceFleet": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "InstanceFleet" + ], + "members": { + "ClusterId": {}, + "InstanceFleet": { + "type": "structure", + "required": [ + "InstanceFleetId" + ], + "members": { + "InstanceFleetId": {}, + "TargetOnDemandCapacity": { + "type": "integer" + }, + "TargetSpotCapacity": { + "type": "integer" + } + } + } + } + } + }, + "ModifyInstanceGroups": { + "input": { + "type": "structure", + "members": { + "ClusterId": {}, + "InstanceGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceGroupId" + ], + "members": { + "InstanceGroupId": {}, + "InstanceCount": { + "type": "integer" + }, + "EC2InstanceIdsToTerminate": { + "type": "list", + "member": {} + }, + "ShrinkPolicy": { + "shape": "S4f" + }, + "Configurations": { + "shape": "Sh" + } + } + } + } + } + } + }, + "PutAutoScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "InstanceGroupId", + "AutoScalingPolicy" + ], + "members": { + "ClusterId": {}, + "InstanceGroupId": {}, + "AutoScalingPolicy": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClusterId": {}, + "InstanceGroupId": {}, + "AutoScalingPolicy": { + "shape": "S4j" + } + } + } + }, + "RemoveAutoScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "InstanceGroupId" + ], + "members": { + "ClusterId": {}, + "InstanceGroupId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RemoveTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagKeys" + ], + "members": { + "ResourceId": {}, + "TagKeys": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RunJobFlow": { + "input": { + "type": "structure", + "required": [ + "Name", + "Instances" + ], + "members": { + "Name": {}, + "LogUri": {}, + "AdditionalInfo": {}, + "AmiVersion": {}, + "ReleaseLabel": {}, + "Instances": { + "type": "structure", + "members": { + "MasterInstanceType": {}, + "SlaveInstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "InstanceGroups": { + "shape": "Sq" + }, + "InstanceFleets": { + "type": "list", + "member": { + "shape": "S3" + } + }, + "Ec2KeyName": {}, + "Placement": { + "shape": "S2v" + }, + "KeepJobFlowAliveWhenNoSteps": { + "type": "boolean" + }, + "TerminationProtected": { + "type": "boolean" + }, + "HadoopVersion": {}, + "Ec2SubnetId": {}, + "Ec2SubnetIds": { + "shape": "S2b" + }, + "EmrManagedMasterSecurityGroup": {}, + "EmrManagedSlaveSecurityGroup": {}, + "ServiceAccessSecurityGroup": {}, + "AdditionalMasterSecurityGroups": { + "shape": "S5p" + }, + "AdditionalSlaveSecurityGroups": { + "shape": "S5p" + } + } + }, + "Steps": { + "shape": "S1b" + }, + "BootstrapActions": { + "type": "list", + "member": { + "shape": "S32" + } + }, + "SupportedProducts": { + "shape": "S34" + }, + "NewSupportedProducts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Args": { + "shape": "S1i" + } + } + } + }, + "Applications": { + "shape": "S2f" + }, + "Configurations": { + "shape": "Sh" + }, + "VisibleToAllUsers": { + "type": "boolean" + }, + "JobFlowRole": {}, + "ServiceRole": {}, + "Tags": { + "shape": "S1n" + }, + "SecurityConfiguration": {}, + "AutoScalingRole": {}, + "ScaleDownBehavior": {}, + "CustomAmiId": {}, + "EbsRootVolumeSize": { + "type": "integer" + }, + "RepoUpgradeOnBoot": {}, + "KerberosAttributes": { + "shape": "S2j" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobFlowId": {} + } + } + }, + "SetTerminationProtection": { + "input": { + "type": "structure", + "required": [ + "JobFlowIds", + "TerminationProtected" + ], + "members": { + "JobFlowIds": { + "shape": "S1i" + }, + "TerminationProtected": { + "type": "boolean" + } + } + } + }, + "SetVisibleToAllUsers": { + "input": { + "type": "structure", + "required": [ + "JobFlowIds", + "VisibleToAllUsers" + ], + "members": { + "JobFlowIds": { + "shape": "S1i" + }, + "VisibleToAllUsers": { + "type": "boolean" + } + } + } + }, + "TerminateJobFlows": { + "input": { + "type": "structure", + "required": [ + "JobFlowIds" + ], + "members": { + "JobFlowIds": { + "shape": "S1i" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "required": [ + "InstanceFleetType" + ], + "members": { + "Name": {}, + "InstanceFleetType": {}, + "TargetOnDemandCapacity": { + "type": "integer" + }, + "TargetSpotCapacity": { + "type": "integer" + }, + "InstanceTypeConfigs": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceType" + ], + "members": { + "InstanceType": {}, + "WeightedCapacity": { + "type": "integer" + }, + "BidPrice": {}, + "BidPriceAsPercentageOfOnDemandPrice": { + "type": "double" + }, + "EbsConfiguration": { + "shape": "Sa" + }, + "Configurations": { + "shape": "Sh" + } + } + } + }, + "LaunchSpecifications": { + "shape": "Sk" + } + } + }, + "Sa": { + "type": "structure", + "members": { + "EbsBlockDeviceConfigs": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VolumeSpecification" + ], + "members": { + "VolumeSpecification": { + "shape": "Sd" + }, + "VolumesPerInstance": { + "type": "integer" + } + } + } + }, + "EbsOptimized": { + "type": "boolean" + } + } + }, + "Sd": { + "type": "structure", + "required": [ + "VolumeType", + "SizeInGB" + ], + "members": { + "VolumeType": {}, + "Iops": { + "type": "integer" + }, + "SizeInGB": { + "type": "integer" + } + } + }, + "Sh": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Classification": {}, + "Configurations": { + "shape": "Sh" + }, + "Properties": { + "shape": "Sj" + } + } + } + }, + "Sj": { + "type": "map", + "key": {}, + "value": {} + }, + "Sk": { + "type": "structure", + "required": [ + "SpotSpecification" + ], + "members": { + "SpotSpecification": { + "type": "structure", + "required": [ + "TimeoutDurationMinutes", + "TimeoutAction" + ], + "members": { + "TimeoutDurationMinutes": { + "type": "integer" + }, + "TimeoutAction": {}, + "BlockDurationMinutes": { + "type": "integer" + } + } + } + } + }, + "Sq": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceRole", + "InstanceType", + "InstanceCount" + ], + "members": { + "Name": {}, + "Market": {}, + "InstanceRole": {}, + "BidPrice": {}, + "InstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "Configurations": { + "shape": "Sh" + }, + "EbsConfiguration": { + "shape": "Sa" + }, + "AutoScalingPolicy": { + "shape": "Su" + } + } + } + }, + "Su": { + "type": "structure", + "required": [ + "Constraints", + "Rules" + ], + "members": { + "Constraints": { + "shape": "Sv" + }, + "Rules": { + "shape": "Sw" + } + } + }, + "Sv": { + "type": "structure", + "required": [ + "MinCapacity", + "MaxCapacity" + ], + "members": { + "MinCapacity": { + "type": "integer" + }, + "MaxCapacity": { + "type": "integer" + } + } + }, + "Sw": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Action", + "Trigger" + ], + "members": { + "Name": {}, + "Description": {}, + "Action": { + "type": "structure", + "required": [ + "SimpleScalingPolicyConfiguration" + ], + "members": { + "Market": {}, + "SimpleScalingPolicyConfiguration": { + "type": "structure", + "required": [ + "ScalingAdjustment" + ], + "members": { + "AdjustmentType": {}, + "ScalingAdjustment": { + "type": "integer" + }, + "CoolDown": { + "type": "integer" + } + } + } + } + }, + "Trigger": { + "type": "structure", + "required": [ + "CloudWatchAlarmDefinition" + ], + "members": { + "CloudWatchAlarmDefinition": { + "type": "structure", + "required": [ + "ComparisonOperator", + "MetricName", + "Period", + "Threshold" + ], + "members": { + "ComparisonOperator": {}, + "EvaluationPeriods": { + "type": "integer" + }, + "MetricName": {}, + "Namespace": {}, + "Period": { + "type": "integer" + }, + "Statistic": {}, + "Threshold": { + "type": "double" + }, + "Unit": {}, + "Dimensions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } + } + } + } + } + } + }, + "S1b": { + "type": "list", + "member": { + "shape": "S1c" + } + }, + "S1c": { + "type": "structure", + "required": [ + "Name", + "HadoopJarStep" + ], + "members": { + "Name": {}, + "ActionOnFailure": {}, + "HadoopJarStep": { + "type": "structure", + "required": [ + "Jar" + ], + "members": { + "Properties": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Jar": {}, + "MainClass": {}, + "Args": { + "shape": "S1i" + } + } + } + } + }, + "S1i": { + "type": "list", + "member": {} + }, + "S1k": { + "type": "list", + "member": {} + }, + "S1n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S25": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + }, + "S2b": { + "type": "list", + "member": {} + }, + "S2c": { + "type": "list", + "member": {} + }, + "S2f": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Version": {}, + "Args": { + "shape": "S2c" + }, + "AdditionalInfo": { + "shape": "Sj" + } + } + } + }, + "S2j": { + "type": "structure", + "required": [ + "Realm", + "KdcAdminPassword" + ], + "members": { + "Realm": {}, + "KdcAdminPassword": {}, + "CrossRealmTrustPrincipalPassword": {}, + "ADDomainJoinUser": {}, + "ADDomainJoinPassword": {} + } + }, + "S2v": { + "type": "structure", + "members": { + "AvailabilityZone": {}, + "AvailabilityZones": { + "shape": "S2b" + } + } + }, + "S32": { + "type": "structure", + "required": [ + "Name", + "ScriptBootstrapAction" + ], + "members": { + "Name": {}, + "ScriptBootstrapAction": { + "type": "structure", + "required": [ + "Path" + ], + "members": { + "Path": {}, + "Args": { + "shape": "S1i" + } + } + } + } + }, + "S34": { + "type": "list", + "member": {} + }, + "S3a": { + "type": "structure", + "members": { + "Jar": {}, + "Properties": { + "shape": "Sj" + }, + "MainClass": {}, + "Args": { + "shape": "S2c" + } + } + }, + "S3b": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "FailureDetails": { + "type": "structure", + "members": { + "Reason": {}, + "Message": {}, + "LogFile": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + }, + "S42": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeSpecification": { + "shape": "Sd" + }, + "Device": {} + } + } + }, + "S4f": { + "type": "structure", + "members": { + "DecommissionTimeout": { + "type": "integer" + }, + "InstanceResizePolicy": { + "type": "structure", + "members": { + "InstancesToTerminate": { + "shape": "S4h" + }, + "InstancesToProtect": { + "shape": "S4h" + }, + "InstanceTerminationTimeout": { + "type": "integer" + } + } + } + } + }, + "S4h": { + "type": "list", + "member": {} + }, + "S4j": { + "type": "structure", + "members": { + "Status": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + } + } + }, + "Constraints": { + "shape": "Sv" + }, + "Rules": { + "shape": "Sw" + } + } + }, + "S5p": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.paginators.json b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.paginators.json new file mode 100644 index 0000000..2d164ca --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.paginators.json @@ -0,0 +1,42 @@ +{ + "pagination": { + "DescribeJobFlows": { + "result_key": "JobFlows" + }, + "ListBootstrapActions": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "BootstrapActions" + }, + "ListClusters": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Clusters" + }, + "ListInstanceFleets": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "InstanceFleets" + }, + "ListInstanceGroups": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "InstanceGroups" + }, + "ListInstances": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Instances" + }, + "ListSecurityConfigurations": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "SecurityConfigurations" + }, + "ListSteps": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Steps" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.waiters2.json b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.waiters2.json new file mode 100644 index 0000000..abba8c3 --- /dev/null +++ b/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.waiters2.json @@ -0,0 +1,86 @@ +{ + "version": 2, + "waiters": { + "ClusterRunning": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "RUNNING" + }, + { + "state": "success", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "WAITING" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATING" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED_WITH_ERRORS" + } + ] + }, + "StepComplete": { + "delay": 30, + "operation": "DescribeStep", + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "Step.Status.State", + "expected": "COMPLETED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Step.Status.State", + "expected": "FAILED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Step.Status.State", + "expected": "CANCELLED" + } + ] + }, + "ClusterTerminated": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED_WITH_ERRORS" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.examples.json b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.min.json b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.min.json new file mode 100644 index 0000000..d88ee52 --- /dev/null +++ b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.min.json @@ -0,0 +1,1060 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-09-25", + "endpointPrefix": "elastictranscoder", + "protocol": "rest-json", + "serviceFullName": "Amazon Elastic Transcoder", + "serviceId": "Elastic Transcoder", + "signatureVersion": "v4", + "uid": "elastictranscoder-2012-09-25" + }, + "operations": { + "CancelJob": { + "http": { + "method": "DELETE", + "requestUri": "/2012-09-25/jobs/{Id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateJob": { + "http": { + "requestUri": "/2012-09-25/jobs", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "PipelineId" + ], + "members": { + "PipelineId": {}, + "Input": { + "shape": "S5" + }, + "Inputs": { + "shape": "St" + }, + "Output": { + "shape": "Su" + }, + "Outputs": { + "type": "list", + "member": { + "shape": "Su" + } + }, + "OutputKeyPrefix": {}, + "Playlists": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Format": {}, + "OutputKeys": { + "shape": "S1l" + }, + "HlsContentProtection": { + "shape": "S1m" + }, + "PlayReadyDrm": { + "shape": "S1q" + } + } + } + }, + "UserMetadata": { + "shape": "S1v" + } + } + }, + "output": { + "type": "structure", + "members": { + "Job": { + "shape": "S1y" + } + } + } + }, + "CreatePipeline": { + "http": { + "requestUri": "/2012-09-25/pipelines", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "InputBucket", + "Role" + ], + "members": { + "Name": {}, + "InputBucket": {}, + "OutputBucket": {}, + "Role": {}, + "AwsKmsKeyArn": {}, + "Notifications": { + "shape": "S2a" + }, + "ContentConfig": { + "shape": "S2c" + }, + "ThumbnailConfig": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S2l" + }, + "Warnings": { + "shape": "S2n" + } + } + } + }, + "CreatePreset": { + "http": { + "requestUri": "/2012-09-25/presets", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "Container" + ], + "members": { + "Name": {}, + "Description": {}, + "Container": {}, + "Video": { + "shape": "S2r" + }, + "Audio": { + "shape": "S37" + }, + "Thumbnails": { + "shape": "S3i" + } + } + }, + "output": { + "type": "structure", + "members": { + "Preset": { + "shape": "S3m" + }, + "Warning": {} + } + } + }, + "DeletePipeline": { + "http": { + "method": "DELETE", + "requestUri": "/2012-09-25/pipelines/{Id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePreset": { + "http": { + "method": "DELETE", + "requestUri": "/2012-09-25/presets/{Id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListJobsByPipeline": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/jobsByPipeline/{PipelineId}" + }, + "input": { + "type": "structure", + "required": [ + "PipelineId" + ], + "members": { + "PipelineId": { + "location": "uri", + "locationName": "PipelineId" + }, + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Jobs": { + "shape": "S3v" + }, + "NextPageToken": {} + } + } + }, + "ListJobsByStatus": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/jobsByStatus/{Status}" + }, + "input": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": { + "location": "uri", + "locationName": "Status" + }, + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Jobs": { + "shape": "S3v" + }, + "NextPageToken": {} + } + } + }, + "ListPipelines": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/pipelines" + }, + "input": { + "type": "structure", + "members": { + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipelines": { + "type": "list", + "member": { + "shape": "S2l" + } + }, + "NextPageToken": {} + } + } + }, + "ListPresets": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/presets" + }, + "input": { + "type": "structure", + "members": { + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Presets": { + "type": "list", + "member": { + "shape": "S3m" + } + }, + "NextPageToken": {} + } + } + }, + "ReadJob": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/jobs/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Job": { + "shape": "S1y" + } + } + } + }, + "ReadPipeline": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/pipelines/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S2l" + }, + "Warnings": { + "shape": "S2n" + } + } + } + }, + "ReadPreset": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/presets/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Preset": { + "shape": "S3m" + } + } + } + }, + "TestRole": { + "http": { + "requestUri": "/2012-09-25/roleTests", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Role", + "InputBucket", + "OutputBucket", + "Topics" + ], + "members": { + "Role": {}, + "InputBucket": {}, + "OutputBucket": {}, + "Topics": { + "type": "list", + "member": {} + } + }, + "deprecated": true + }, + "output": { + "type": "structure", + "members": { + "Success": {}, + "Messages": { + "type": "list", + "member": {} + } + }, + "deprecated": true + }, + "deprecated": true + }, + "UpdatePipeline": { + "http": { + "method": "PUT", + "requestUri": "/2012-09-25/pipelines/{Id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Name": {}, + "InputBucket": {}, + "Role": {}, + "AwsKmsKeyArn": {}, + "Notifications": { + "shape": "S2a" + }, + "ContentConfig": { + "shape": "S2c" + }, + "ThumbnailConfig": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S2l" + }, + "Warnings": { + "shape": "S2n" + } + } + } + }, + "UpdatePipelineNotifications": { + "http": { + "requestUri": "/2012-09-25/pipelines/{Id}/notifications" + }, + "input": { + "type": "structure", + "required": [ + "Id", + "Notifications" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Notifications": { + "shape": "S2a" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S2l" + } + } + } + }, + "UpdatePipelineStatus": { + "http": { + "requestUri": "/2012-09-25/pipelines/{Id}/status" + }, + "input": { + "type": "structure", + "required": [ + "Id", + "Status" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Status": {} + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S2l" + } + } + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "members": { + "Key": {}, + "FrameRate": {}, + "Resolution": {}, + "AspectRatio": {}, + "Interlaced": {}, + "Container": {}, + "Encryption": { + "shape": "Sc" + }, + "TimeSpan": { + "shape": "Sg" + }, + "InputCaptions": { + "type": "structure", + "members": { + "MergePolicy": {}, + "CaptionSources": { + "shape": "Sk" + } + } + }, + "DetectedProperties": { + "type": "structure", + "members": { + "Width": { + "type": "integer" + }, + "Height": { + "type": "integer" + }, + "FrameRate": {}, + "FileSize": { + "type": "long" + }, + "DurationMillis": { + "type": "long" + } + } + } + } + }, + "Sc": { + "type": "structure", + "members": { + "Mode": {}, + "Key": {}, + "KeyMd5": {}, + "InitializationVector": {} + } + }, + "Sg": { + "type": "structure", + "members": { + "StartTime": {}, + "Duration": {} + } + }, + "Sk": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Language": {}, + "TimeOffset": {}, + "Label": {}, + "Encryption": { + "shape": "Sc" + } + } + } + }, + "St": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "Su": { + "type": "structure", + "members": { + "Key": {}, + "ThumbnailPattern": {}, + "ThumbnailEncryption": { + "shape": "Sc" + }, + "Rotate": {}, + "PresetId": {}, + "SegmentDuration": {}, + "Watermarks": { + "shape": "Sx" + }, + "AlbumArt": { + "shape": "S11" + }, + "Composition": { + "shape": "S19", + "deprecated": true + }, + "Captions": { + "shape": "S1b" + }, + "Encryption": { + "shape": "Sc" + } + } + }, + "Sx": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PresetWatermarkId": {}, + "InputKey": {}, + "Encryption": { + "shape": "Sc" + } + } + } + }, + "S11": { + "type": "structure", + "members": { + "MergePolicy": {}, + "Artwork": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InputKey": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "SizingPolicy": {}, + "PaddingPolicy": {}, + "AlbumArtFormat": {}, + "Encryption": { + "shape": "Sc" + } + } + } + } + } + }, + "S19": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TimeSpan": { + "shape": "Sg" + } + }, + "deprecated": true + }, + "deprecated": true + }, + "S1b": { + "type": "structure", + "members": { + "MergePolicy": { + "deprecated": true + }, + "CaptionSources": { + "shape": "Sk", + "deprecated": true + }, + "CaptionFormats": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Format": {}, + "Pattern": {}, + "Encryption": { + "shape": "Sc" + } + } + } + } + } + }, + "S1l": { + "type": "list", + "member": {} + }, + "S1m": { + "type": "structure", + "members": { + "Method": {}, + "Key": {}, + "KeyMd5": {}, + "InitializationVector": {}, + "LicenseAcquisitionUrl": {}, + "KeyStoragePolicy": {} + } + }, + "S1q": { + "type": "structure", + "members": { + "Format": {}, + "Key": {}, + "KeyMd5": {}, + "KeyId": {}, + "InitializationVector": {}, + "LicenseAcquisitionUrl": {} + } + }, + "S1v": { + "type": "map", + "key": {}, + "value": {} + }, + "S1y": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "PipelineId": {}, + "Input": { + "shape": "S5" + }, + "Inputs": { + "shape": "St" + }, + "Output": { + "shape": "S1z" + }, + "Outputs": { + "type": "list", + "member": { + "shape": "S1z" + } + }, + "OutputKeyPrefix": {}, + "Playlists": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Format": {}, + "OutputKeys": { + "shape": "S1l" + }, + "HlsContentProtection": { + "shape": "S1m" + }, + "PlayReadyDrm": { + "shape": "S1q" + }, + "Status": {}, + "StatusDetail": {} + } + } + }, + "Status": {}, + "UserMetadata": { + "shape": "S1v" + }, + "Timing": { + "type": "structure", + "members": { + "SubmitTimeMillis": { + "type": "long" + }, + "StartTimeMillis": { + "type": "long" + }, + "FinishTimeMillis": { + "type": "long" + } + } + } + } + }, + "S1z": { + "type": "structure", + "members": { + "Id": {}, + "Key": {}, + "ThumbnailPattern": {}, + "ThumbnailEncryption": { + "shape": "Sc" + }, + "Rotate": {}, + "PresetId": {}, + "SegmentDuration": {}, + "Status": {}, + "StatusDetail": {}, + "Duration": { + "type": "long" + }, + "Width": { + "type": "integer" + }, + "Height": { + "type": "integer" + }, + "FrameRate": {}, + "FileSize": { + "type": "long" + }, + "DurationMillis": { + "type": "long" + }, + "Watermarks": { + "shape": "Sx" + }, + "AlbumArt": { + "shape": "S11" + }, + "Composition": { + "shape": "S19", + "deprecated": true + }, + "Captions": { + "shape": "S1b" + }, + "Encryption": { + "shape": "Sc" + }, + "AppliedColorSpaceConversion": {} + } + }, + "S2a": { + "type": "structure", + "members": { + "Progressing": {}, + "Completed": {}, + "Warning": {}, + "Error": {} + } + }, + "S2c": { + "type": "structure", + "members": { + "Bucket": {}, + "StorageClass": {}, + "Permissions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GranteeType": {}, + "Grantee": {}, + "Access": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "S2l": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Status": {}, + "InputBucket": {}, + "OutputBucket": {}, + "Role": {}, + "AwsKmsKeyArn": {}, + "Notifications": { + "shape": "S2a" + }, + "ContentConfig": { + "shape": "S2c" + }, + "ThumbnailConfig": { + "shape": "S2c" + } + } + }, + "S2n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + } + }, + "S2r": { + "type": "structure", + "members": { + "Codec": {}, + "CodecOptions": { + "type": "map", + "key": {}, + "value": {} + }, + "KeyframesMaxDist": {}, + "FixedGOP": {}, + "BitRate": {}, + "FrameRate": {}, + "MaxFrameRate": {}, + "Resolution": {}, + "AspectRatio": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "DisplayAspectRatio": {}, + "SizingPolicy": {}, + "PaddingPolicy": {}, + "Watermarks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "SizingPolicy": {}, + "HorizontalAlign": {}, + "HorizontalOffset": {}, + "VerticalAlign": {}, + "VerticalOffset": {}, + "Opacity": {}, + "Target": {} + } + } + } + } + }, + "S37": { + "type": "structure", + "members": { + "Codec": {}, + "SampleRate": {}, + "BitRate": {}, + "Channels": {}, + "AudioPackingMode": {}, + "CodecOptions": { + "type": "structure", + "members": { + "Profile": {}, + "BitDepth": {}, + "BitOrder": {}, + "Signed": {} + } + } + } + }, + "S3i": { + "type": "structure", + "members": { + "Format": {}, + "Interval": {}, + "Resolution": {}, + "AspectRatio": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "SizingPolicy": {}, + "PaddingPolicy": {} + } + }, + "S3m": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Description": {}, + "Container": {}, + "Audio": { + "shape": "S37" + }, + "Video": { + "shape": "S2r" + }, + "Thumbnails": { + "shape": "S3i" + }, + "Type": {} + } + }, + "S3v": { + "type": "list", + "member": { + "shape": "S1y" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.paginators.json b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.paginators.json new file mode 100644 index 0000000..d922607 --- /dev/null +++ b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.paginators.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "ListJobsByPipeline": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Jobs" + }, + "ListJobsByStatus": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Jobs" + }, + "ListPipelines": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Pipelines" + }, + "ListPresets": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Presets" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.waiters2.json b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.waiters2.json new file mode 100644 index 0000000..55c3628 --- /dev/null +++ b/node_modules/aws-sdk/apis/elastictranscoder-2012-09-25.waiters2.json @@ -0,0 +1,30 @@ +{ + "version": 2, + "waiters": { + "JobComplete": { + "delay": 30, + "operation": "ReadJob", + "maxAttempts": 120, + "acceptors": [ + { + "expected": "Complete", + "matcher": "path", + "state": "success", + "argument": "Job.Status" + }, + { + "expected": "Canceled", + "matcher": "path", + "state": "failure", + "argument": "Job.Status" + }, + { + "expected": "Error", + "matcher": "path", + "state": "failure", + "argument": "Job.Status" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/email-2010-12-01.examples.json b/node_modules/aws-sdk/apis/email-2010-12-01.examples.json new file mode 100644 index 0000000..e569033 --- /dev/null +++ b/node_modules/aws-sdk/apis/email-2010-12-01.examples.json @@ -0,0 +1,1021 @@ +{ + "version": "1.0", + "examples": { + "CloneReceiptRuleSet": [ + { + "input": { + "OriginalRuleSetName": "RuleSetToClone", + "RuleSetName": "RuleSetToCreate" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a receipt rule set by cloning an existing one:", + "id": "clonereceiptruleset-1469055039770", + "title": "CloneReceiptRuleSet" + } + ], + "CreateReceiptFilter": [ + { + "input": { + "Filter": { + "IpFilter": { + "Cidr": "1.2.3.4/24", + "Policy": "Allow" + }, + "Name": "MyFilter" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a new IP address filter:", + "id": "createreceiptfilter-1469122681253", + "title": "CreateReceiptFilter" + } + ], + "CreateReceiptRule": [ + { + "input": { + "After": "", + "Rule": { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + }, + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a new receipt rule:", + "id": "createreceiptrule-1469122946515", + "title": "CreateReceiptRule" + } + ], + "CreateReceiptRuleSet": [ + { + "input": { + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an empty receipt rule set:", + "id": "createreceiptruleset-1469058761646", + "title": "CreateReceiptRuleSet" + } + ], + "DeleteIdentity": [ + { + "input": { + "Identity": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:", + "id": "deleteidentity-1469047858906", + "title": "DeleteIdentity" + } + ], + "DeleteIdentityPolicy": [ + { + "input": { + "Identity": "user@example.com", + "PolicyName": "MyPolicy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a sending authorization policy for an identity:", + "id": "deleteidentitypolicy-1469055282499", + "title": "DeleteIdentityPolicy" + } + ], + "DeleteReceiptFilter": [ + { + "input": { + "FilterName": "MyFilter" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IP address filter:", + "id": "deletereceiptfilter-1469055456835", + "title": "DeleteReceiptFilter" + } + ], + "DeleteReceiptRule": [ + { + "input": { + "RuleName": "MyRule", + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a receipt rule:", + "id": "deletereceiptrule-1469055563599", + "title": "DeleteReceiptRule" + } + ], + "DeleteReceiptRuleSet": [ + { + "input": { + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a receipt rule set:", + "id": "deletereceiptruleset-1469055713690", + "title": "DeleteReceiptRuleSet" + } + ], + "DeleteVerifiedEmailAddress": [ + { + "input": { + "EmailAddress": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:", + "id": "deleteverifiedemailaddress-1469051086444", + "title": "DeleteVerifiedEmailAddress" + } + ], + "DescribeActiveReceiptRuleSet": [ + { + "input": { + }, + "output": { + "Metadata": { + "CreatedTimestamp": "2016-07-15T16:25:59.607Z", + "Name": "default-rule-set" + }, + "Rules": [ + { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the metadata and receipt rules for the receipt rule set that is currently active:", + "id": "describeactivereceiptruleset-1469121611502", + "title": "DescribeActiveReceiptRuleSet" + } + ], + "DescribeReceiptRule": [ + { + "input": { + "RuleName": "MyRule", + "RuleSetName": "MyRuleSet" + }, + "output": { + "Rule": { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a receipt rule:", + "id": "describereceiptrule-1469055813118", + "title": "DescribeReceiptRule" + } + ], + "DescribeReceiptRuleSet": [ + { + "input": { + "RuleSetName": "MyRuleSet" + }, + "output": { + "Metadata": { + "CreatedTimestamp": "2016-07-15T16:25:59.607Z", + "Name": "MyRuleSet" + }, + "Rules": [ + { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the metadata and receipt rules of a receipt rule set:", + "id": "describereceiptruleset-1469121240385", + "title": "DescribeReceiptRuleSet" + } + ], + "GetAccountSendingEnabled": [ + { + "output": { + "Enabled": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns if sending status for an account is enabled. (true / false):", + "id": "getaccountsendingenabled-1469047741333", + "title": "GetAccountSendingEnabled" + } + ], + "GetIdentityDkimAttributes": [ + { + "input": { + "Identities": [ + "example.com", + "user@example.com" + ] + }, + "output": { + "DkimAttributes": { + "example.com": { + "DkimEnabled": true, + "DkimTokens": [ + "EXAMPLEjcs5xoyqytjsotsijas7236gr", + "EXAMPLEjr76cvoc6mysspnioorxsn6ep", + "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k" + ], + "DkimVerificationStatus": "Success" + }, + "user@example.com": { + "DkimEnabled": false, + "DkimVerificationStatus": "NotStarted" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:", + "id": "getidentitydkimattributes-1469050695628", + "title": "GetIdentityDkimAttributes" + } + ], + "GetIdentityMailFromDomainAttributes": [ + { + "input": { + "Identities": [ + "example.com" + ] + }, + "output": { + "MailFromDomainAttributes": { + "example.com": { + "BehaviorOnMXFailure": "UseDefaultValue", + "MailFromDomain": "bounces.example.com", + "MailFromDomainStatus": "Success" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the custom MAIL FROM attributes for an identity:", + "id": "getidentitymailfromdomainattributes-1469123114860", + "title": "GetIdentityMailFromDomainAttributes" + } + ], + "GetIdentityNotificationAttributes": [ + { + "input": { + "Identities": [ + "example.com" + ] + }, + "output": { + "NotificationAttributes": { + "example.com": { + "BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", + "ComplaintTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", + "DeliveryTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", + "ForwardingEnabled": true, + "HeadersInBounceNotificationsEnabled": false, + "HeadersInComplaintNotificationsEnabled": false, + "HeadersInDeliveryNotificationsEnabled": false + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the notification attributes for an identity:", + "id": "getidentitynotificationattributes-1469123466947", + "title": "GetIdentityNotificationAttributes" + } + ], + "GetIdentityPolicies": [ + { + "input": { + "Identity": "example.com", + "PolicyNames": [ + "MyPolicy" + ] + }, + "output": { + "Policies": { + "MyPolicy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a sending authorization policy for an identity:", + "id": "getidentitypolicies-1469123949351", + "title": "GetIdentityPolicies" + } + ], + "GetIdentityVerificationAttributes": [ + { + "input": { + "Identities": [ + "example.com" + ] + }, + "output": { + "VerificationAttributes": { + "example.com": { + "VerificationStatus": "Success", + "VerificationToken": "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY=" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the verification status and the verification token for a domain identity:", + "id": "getidentityverificationattributes-1469124205897", + "title": "GetIdentityVerificationAttributes" + } + ], + "GetSendQuota": [ + { + "output": { + "Max24HourSend": 200, + "MaxSendRate": 1, + "SentLast24Hours": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the Amazon SES sending limits for an AWS account:", + "id": "getsendquota-1469047324508", + "title": "GetSendQuota" + } + ], + "GetSendStatistics": [ + { + "output": { + "SendDataPoints": [ + { + "Bounces": 0, + "Complaints": 0, + "DeliveryAttempts": 5, + "Rejects": 0, + "Timestamp": "2016-07-13T22:43:00Z" + }, + { + "Bounces": 0, + "Complaints": 0, + "DeliveryAttempts": 3, + "Rejects": 0, + "Timestamp": "2016-07-13T23:13:00Z" + }, + { + "Bounces": 0, + "Complaints": 0, + "DeliveryAttempts": 1, + "Rejects": 0, + "Timestamp": "2016-07-13T21:13:00Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns Amazon SES sending statistics:", + "id": "getsendstatistics-1469047741329", + "title": "GetSendStatistics" + } + ], + "ListIdentities": [ + { + "input": { + "IdentityType": "EmailAddress", + "MaxItems": 123, + "NextToken": "" + }, + "output": { + "Identities": [ + "user@example.com" + ], + "NextToken": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists the email address identities that have been submitted for verification with Amazon SES:", + "id": "listidentities-1469048638493", + "title": "ListIdentities" + } + ], + "ListIdentityPolicies": [ + { + "input": { + "Identity": "example.com" + }, + "output": { + "PolicyNames": [ + "MyPolicy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a list of sending authorization policies that are attached to an identity:", + "id": "listidentitypolicies-1469124417674", + "title": "ListIdentityPolicies" + } + ], + "ListReceiptFilters": [ + { + "output": { + "Filters": [ + { + "IpFilter": { + "Cidr": "1.2.3.4/24", + "Policy": "Block" + }, + "Name": "MyFilter" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists the IP address filters that are associated with an AWS account:", + "id": "listreceiptfilters-1469120786789", + "title": "ListReceiptFilters" + } + ], + "ListReceiptRuleSets": [ + { + "input": { + "NextToken": "" + }, + "output": { + "NextToken": "", + "RuleSets": [ + { + "CreatedTimestamp": "2016-07-15T16:25:59.607Z", + "Name": "MyRuleSet" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists the receipt rule sets that exist under an AWS account:", + "id": "listreceiptrulesets-1469121037235", + "title": "ListReceiptRuleSets" + } + ], + "ListVerifiedEmailAddresses": [ + { + "output": { + "VerifiedEmailAddresses": [ + "user1@example.com", + "user2@example.com" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists all email addresses that have been submitted for verification with Amazon SES:", + "id": "listverifiedemailaddresses-1469051402570", + "title": "ListVerifiedEmailAddresses" + } + ], + "PutIdentityPolicy": [ + { + "input": { + "Identity": "example.com", + "Policy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}", + "PolicyName": "MyPolicy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds a sending authorization policy to an identity:", + "id": "putidentitypolicy-1469124560016", + "title": "PutIdentityPolicy" + } + ], + "ReorderReceiptRuleSet": [ + { + "input": { + "RuleNames": [ + "MyRule", + "MyOtherRule" + ], + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example reorders the receipt rules within a receipt rule set:", + "id": "reorderreceiptruleset-1469058156806", + "title": "ReorderReceiptRuleSet" + } + ], + "SendEmail": [ + { + "input": { + "Destination": { + "BccAddresses": [ + + ], + "CcAddresses": [ + "recipient3@example.com" + ], + "ToAddresses": [ + "recipient1@example.com", + "recipient2@example.com" + ] + }, + "Message": { + "Body": { + "Html": { + "Charset": "UTF-8", + "Data": "This message body contains HTML formatting. It can, for example, contain links like this one: Amazon SES Developer Guide." + }, + "Text": { + "Charset": "UTF-8", + "Data": "This is the message body in text format." + } + }, + "Subject": { + "Charset": "UTF-8", + "Data": "Test email" + } + }, + "ReplyToAddresses": [ + + ], + "ReturnPath": "", + "ReturnPathArn": "", + "Source": "sender@example.com", + "SourceArn": "" + }, + "output": { + "MessageId": "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sends a formatted email:", + "id": "sendemail-1469049656296", + "title": "SendEmail" + } + ], + "SendRawEmail": [ + { + "input": { + "Destinations": [ + + ], + "FromArn": "", + "RawMessage": { + "Data": "From: sender@example.com\\nTo: recipient@example.com\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--" + }, + "ReturnPathArn": "", + "Source": "", + "SourceArn": "" + }, + "output": { + "MessageId": "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sends an email with an attachment:", + "id": "sendrawemail-1469118548649", + "title": "SendRawEmail" + } + ], + "SetActiveReceiptRuleSet": [ + { + "input": { + "RuleSetName": "RuleSetToActivate" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets the active receipt rule set:", + "id": "setactivereceiptruleset-1469058391329", + "title": "SetActiveReceiptRuleSet" + } + ], + "SetIdentityDkimEnabled": [ + { + "input": { + "DkimEnabled": true, + "Identity": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:", + "id": "setidentitydkimenabled-1469057485202", + "title": "SetIdentityDkimEnabled" + } + ], + "SetIdentityFeedbackForwardingEnabled": [ + { + "input": { + "ForwardingEnabled": true, + "Identity": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to forward an identity's bounces and complaints via email:", + "id": "setidentityfeedbackforwardingenabled-1469056811329", + "title": "SetIdentityFeedbackForwardingEnabled" + } + ], + "SetIdentityHeadersInNotificationsEnabled": [ + { + "input": { + "Enabled": true, + "Identity": "user@example.com", + "NotificationType": "Bounce" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:", + "id": "setidentityheadersinnotificationsenabled-1469057295001", + "title": "SetIdentityHeadersInNotificationsEnabled" + } + ], + "SetIdentityMailFromDomain": [ + { + "input": { + "BehaviorOnMXFailure": "UseDefaultValue", + "Identity": "user@example.com", + "MailFromDomain": "bounces.example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:", + "id": "setidentitymailfromdomain-1469057693908", + "title": "SetIdentityMailFromDomain" + } + ], + "SetIdentityNotificationTopic": [ + { + "input": { + "Identity": "user@example.com", + "NotificationType": "Bounce", + "SnsTopic": "arn:aws:sns:us-west-2:111122223333:MyTopic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:", + "id": "setidentitynotificationtopic-1469057854966", + "title": "SetIdentityNotificationTopic" + } + ], + "SetReceiptRulePosition": [ + { + "input": { + "After": "PutRuleAfterThisRule", + "RuleName": "RuleToReposition", + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets the position of a receipt rule in a receipt rule set:", + "id": "setreceiptruleposition-1469058530550", + "title": "SetReceiptRulePosition" + } + ], + "UpdateAccountSendingEnabled": [ + { + "input": { + "Enabled": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example updated the sending status for this account.", + "id": "updateaccountsendingenabled-1469047741333", + "title": "UpdateAccountSendingEnabled" + } + ], + "UpdateConfigurationSetReputationMetricsEnabled": [ + { + "input": { + "ConfigurationSetName": "foo", + "Enabled": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Set the reputationMetricsEnabled flag for a specific configuration set.", + "id": "updateconfigurationsetreputationmetricsenabled-2362747741333", + "title": "UpdateConfigurationSetReputationMetricsEnabled" + } + ], + "UpdateConfigurationSetSendingEnabled": [ + { + "input": { + "ConfigurationSetName": "foo", + "Enabled": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Set the sending enabled flag for a specific configuration set.", + "id": "updateconfigurationsetsendingenabled-2362747741333", + "title": "UpdateConfigurationSetReputationMetricsEnabled" + } + ], + "UpdateReceiptRule": [ + { + "input": { + "Rule": { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + }, + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example updates a receipt rule to use an Amazon S3 action:", + "id": "updatereceiptrule-1469051756940", + "title": "UpdateReceiptRule" + } + ], + "VerifyDomainDkim": [ + { + "input": { + "Domain": "example.com" + }, + "output": { + "DkimTokens": [ + "EXAMPLEq76owjnks3lnluwg65scbemvw", + "EXAMPLEi3dnsj67hstzaj673klariwx2", + "EXAMPLEwfbtcukvimehexktmdtaz6naj" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example generates DKIM tokens for a domain that has been verified with Amazon SES:", + "id": "verifydomaindkim-1469049503083", + "title": "VerifyDomainDkim" + } + ], + "VerifyDomainIdentity": [ + { + "input": { + "Domain": "example.com" + }, + "output": { + "VerificationToken": "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example starts the domain verification process with Amazon SES:", + "id": "verifydomainidentity-1469049165936", + "title": "VerifyDomainIdentity" + } + ], + "VerifyEmailAddress": [ + { + "input": { + "EmailAddress": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example starts the email address verification process with Amazon SES:", + "id": "verifyemailaddress-1469048849187", + "title": "VerifyEmailAddress" + } + ], + "VerifyEmailIdentity": [ + { + "input": { + "EmailAddress": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example starts the email address verification process with Amazon SES:", + "id": "verifyemailidentity-1469049068623", + "title": "VerifyEmailIdentity" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/email-2010-12-01.min.json b/node_modules/aws-sdk/apis/email-2010-12-01.min.json new file mode 100644 index 0000000..bbb471c --- /dev/null +++ b/node_modules/aws-sdk/apis/email-2010-12-01.min.json @@ -0,0 +1,1948 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2010-12-01", + "endpointPrefix": "email", + "protocol": "query", + "serviceAbbreviation": "Amazon SES", + "serviceFullName": "Amazon Simple Email Service", + "serviceId": "SES", + "signatureVersion": "v4", + "signingName": "ses", + "uid": "email-2010-12-01", + "xmlNamespace": "http://ses.amazonaws.com/doc/2010-12-01/" + }, + "operations": { + "CloneReceiptRuleSet": { + "input": { + "type": "structure", + "required": [ + "RuleSetName", + "OriginalRuleSetName" + ], + "members": { + "RuleSetName": {}, + "OriginalRuleSetName": {} + } + }, + "output": { + "resultWrapper": "CloneReceiptRuleSetResult", + "type": "structure", + "members": {} + } + }, + "CreateConfigurationSet": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSet" + ], + "members": { + "ConfigurationSet": { + "shape": "S5" + } + } + }, + "output": { + "resultWrapper": "CreateConfigurationSetResult", + "type": "structure", + "members": {} + } + }, + "CreateConfigurationSetEventDestination": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestination" + ], + "members": { + "ConfigurationSetName": {}, + "EventDestination": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateConfigurationSetEventDestinationResult", + "type": "structure", + "members": {} + } + }, + "CreateConfigurationSetTrackingOptions": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "TrackingOptions" + ], + "members": { + "ConfigurationSetName": {}, + "TrackingOptions": { + "shape": "Sp" + } + } + }, + "output": { + "resultWrapper": "CreateConfigurationSetTrackingOptionsResult", + "type": "structure", + "members": {} + } + }, + "CreateCustomVerificationEmailTemplate": { + "input": { + "type": "structure", + "required": [ + "TemplateName", + "FromEmailAddress", + "TemplateSubject", + "TemplateContent", + "SuccessRedirectionURL", + "FailureRedirectionURL" + ], + "members": { + "TemplateName": {}, + "FromEmailAddress": {}, + "TemplateSubject": {}, + "TemplateContent": {}, + "SuccessRedirectionURL": {}, + "FailureRedirectionURL": {} + } + } + }, + "CreateReceiptFilter": { + "input": { + "type": "structure", + "required": [ + "Filter" + ], + "members": { + "Filter": { + "shape": "S10" + } + } + }, + "output": { + "resultWrapper": "CreateReceiptFilterResult", + "type": "structure", + "members": {} + } + }, + "CreateReceiptRule": { + "input": { + "type": "structure", + "required": [ + "RuleSetName", + "Rule" + ], + "members": { + "RuleSetName": {}, + "After": {}, + "Rule": { + "shape": "S18" + } + } + }, + "output": { + "resultWrapper": "CreateReceiptRuleResult", + "type": "structure", + "members": {} + } + }, + "CreateReceiptRuleSet": { + "input": { + "type": "structure", + "required": [ + "RuleSetName" + ], + "members": { + "RuleSetName": {} + } + }, + "output": { + "resultWrapper": "CreateReceiptRuleSetResult", + "type": "structure", + "members": {} + } + }, + "CreateTemplate": { + "input": { + "type": "structure", + "required": [ + "Template" + ], + "members": { + "Template": { + "shape": "S20" + } + } + }, + "output": { + "resultWrapper": "CreateTemplateResult", + "type": "structure", + "members": {} + } + }, + "DeleteConfigurationSet": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": {} + } + }, + "output": { + "resultWrapper": "DeleteConfigurationSetResult", + "type": "structure", + "members": {} + } + }, + "DeleteConfigurationSetEventDestination": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestinationName" + ], + "members": { + "ConfigurationSetName": {}, + "EventDestinationName": {} + } + }, + "output": { + "resultWrapper": "DeleteConfigurationSetEventDestinationResult", + "type": "structure", + "members": {} + } + }, + "DeleteConfigurationSetTrackingOptions": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": {} + } + }, + "output": { + "resultWrapper": "DeleteConfigurationSetTrackingOptionsResult", + "type": "structure", + "members": {} + } + }, + "DeleteCustomVerificationEmailTemplate": { + "input": { + "type": "structure", + "required": [ + "TemplateName" + ], + "members": { + "TemplateName": {} + } + } + }, + "DeleteIdentity": { + "input": { + "type": "structure", + "required": [ + "Identity" + ], + "members": { + "Identity": {} + } + }, + "output": { + "resultWrapper": "DeleteIdentityResult", + "type": "structure", + "members": {} + } + }, + "DeleteIdentityPolicy": { + "input": { + "type": "structure", + "required": [ + "Identity", + "PolicyName" + ], + "members": { + "Identity": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "DeleteIdentityPolicyResult", + "type": "structure", + "members": {} + } + }, + "DeleteReceiptFilter": { + "input": { + "type": "structure", + "required": [ + "FilterName" + ], + "members": { + "FilterName": {} + } + }, + "output": { + "resultWrapper": "DeleteReceiptFilterResult", + "type": "structure", + "members": {} + } + }, + "DeleteReceiptRule": { + "input": { + "type": "structure", + "required": [ + "RuleSetName", + "RuleName" + ], + "members": { + "RuleSetName": {}, + "RuleName": {} + } + }, + "output": { + "resultWrapper": "DeleteReceiptRuleResult", + "type": "structure", + "members": {} + } + }, + "DeleteReceiptRuleSet": { + "input": { + "type": "structure", + "required": [ + "RuleSetName" + ], + "members": { + "RuleSetName": {} + } + }, + "output": { + "resultWrapper": "DeleteReceiptRuleSetResult", + "type": "structure", + "members": {} + } + }, + "DeleteTemplate": { + "input": { + "type": "structure", + "required": [ + "TemplateName" + ], + "members": { + "TemplateName": {} + } + }, + "output": { + "resultWrapper": "DeleteTemplateResult", + "type": "structure", + "members": {} + } + }, + "DeleteVerifiedEmailAddress": { + "input": { + "type": "structure", + "required": [ + "EmailAddress" + ], + "members": { + "EmailAddress": {} + } + } + }, + "DescribeActiveReceiptRuleSet": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "DescribeActiveReceiptRuleSetResult", + "type": "structure", + "members": { + "Metadata": { + "shape": "S2t" + }, + "Rules": { + "shape": "S2v" + } + } + } + }, + "DescribeConfigurationSet": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": {}, + "ConfigurationSetAttributeNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeConfigurationSetResult", + "type": "structure", + "members": { + "ConfigurationSet": { + "shape": "S5" + }, + "EventDestinations": { + "type": "list", + "member": { + "shape": "S9" + } + }, + "TrackingOptions": { + "shape": "Sp" + }, + "ReputationOptions": { + "type": "structure", + "members": { + "SendingEnabled": { + "type": "boolean" + }, + "ReputationMetricsEnabled": { + "type": "boolean" + }, + "LastFreshStart": { + "type": "timestamp" + } + } + } + } + } + }, + "DescribeReceiptRule": { + "input": { + "type": "structure", + "required": [ + "RuleSetName", + "RuleName" + ], + "members": { + "RuleSetName": {}, + "RuleName": {} + } + }, + "output": { + "resultWrapper": "DescribeReceiptRuleResult", + "type": "structure", + "members": { + "Rule": { + "shape": "S18" + } + } + } + }, + "DescribeReceiptRuleSet": { + "input": { + "type": "structure", + "required": [ + "RuleSetName" + ], + "members": { + "RuleSetName": {} + } + }, + "output": { + "resultWrapper": "DescribeReceiptRuleSetResult", + "type": "structure", + "members": { + "Metadata": { + "shape": "S2t" + }, + "Rules": { + "shape": "S2v" + } + } + } + }, + "GetAccountSendingEnabled": { + "output": { + "resultWrapper": "GetAccountSendingEnabledResult", + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + } + }, + "GetCustomVerificationEmailTemplate": { + "input": { + "type": "structure", + "required": [ + "TemplateName" + ], + "members": { + "TemplateName": {} + } + }, + "output": { + "resultWrapper": "GetCustomVerificationEmailTemplateResult", + "type": "structure", + "members": { + "TemplateName": {}, + "FromEmailAddress": {}, + "TemplateSubject": {}, + "TemplateContent": {}, + "SuccessRedirectionURL": {}, + "FailureRedirectionURL": {} + } + } + }, + "GetIdentityDkimAttributes": { + "input": { + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S3b" + } + } + }, + "output": { + "resultWrapper": "GetIdentityDkimAttributesResult", + "type": "structure", + "required": [ + "DkimAttributes" + ], + "members": { + "DkimAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "DkimEnabled", + "DkimVerificationStatus" + ], + "members": { + "DkimEnabled": { + "type": "boolean" + }, + "DkimVerificationStatus": {}, + "DkimTokens": { + "shape": "S3g" + } + } + } + } + } + } + }, + "GetIdentityMailFromDomainAttributes": { + "input": { + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S3b" + } + } + }, + "output": { + "resultWrapper": "GetIdentityMailFromDomainAttributesResult", + "type": "structure", + "required": [ + "MailFromDomainAttributes" + ], + "members": { + "MailFromDomainAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "MailFromDomain", + "MailFromDomainStatus", + "BehaviorOnMXFailure" + ], + "members": { + "MailFromDomain": {}, + "MailFromDomainStatus": {}, + "BehaviorOnMXFailure": {} + } + } + } + } + } + }, + "GetIdentityNotificationAttributes": { + "input": { + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S3b" + } + } + }, + "output": { + "resultWrapper": "GetIdentityNotificationAttributesResult", + "type": "structure", + "required": [ + "NotificationAttributes" + ], + "members": { + "NotificationAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "BounceTopic", + "ComplaintTopic", + "DeliveryTopic", + "ForwardingEnabled" + ], + "members": { + "BounceTopic": {}, + "ComplaintTopic": {}, + "DeliveryTopic": {}, + "ForwardingEnabled": { + "type": "boolean" + }, + "HeadersInBounceNotificationsEnabled": { + "type": "boolean" + }, + "HeadersInComplaintNotificationsEnabled": { + "type": "boolean" + }, + "HeadersInDeliveryNotificationsEnabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "GetIdentityPolicies": { + "input": { + "type": "structure", + "required": [ + "Identity", + "PolicyNames" + ], + "members": { + "Identity": {}, + "PolicyNames": { + "shape": "S3v" + } + } + }, + "output": { + "resultWrapper": "GetIdentityPoliciesResult", + "type": "structure", + "required": [ + "Policies" + ], + "members": { + "Policies": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "GetIdentityVerificationAttributes": { + "input": { + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S3b" + } + } + }, + "output": { + "resultWrapper": "GetIdentityVerificationAttributesResult", + "type": "structure", + "required": [ + "VerificationAttributes" + ], + "members": { + "VerificationAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "VerificationStatus" + ], + "members": { + "VerificationStatus": {}, + "VerificationToken": {} + } + } + } + } + } + }, + "GetSendQuota": { + "output": { + "resultWrapper": "GetSendQuotaResult", + "type": "structure", + "members": { + "Max24HourSend": { + "type": "double" + }, + "MaxSendRate": { + "type": "double" + }, + "SentLast24Hours": { + "type": "double" + } + } + } + }, + "GetSendStatistics": { + "output": { + "resultWrapper": "GetSendStatisticsResult", + "type": "structure", + "members": { + "SendDataPoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "timestamp" + }, + "DeliveryAttempts": { + "type": "long" + }, + "Bounces": { + "type": "long" + }, + "Complaints": { + "type": "long" + }, + "Rejects": { + "type": "long" + } + } + } + } + } + } + }, + "GetTemplate": { + "input": { + "type": "structure", + "required": [ + "TemplateName" + ], + "members": { + "TemplateName": {} + } + }, + "output": { + "resultWrapper": "GetTemplateResult", + "type": "structure", + "members": { + "Template": { + "shape": "S20" + } + } + } + }, + "ListConfigurationSets": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListConfigurationSetsResult", + "type": "structure", + "members": { + "ConfigurationSets": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "NextToken": {} + } + } + }, + "ListCustomVerificationEmailTemplates": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListCustomVerificationEmailTemplatesResult", + "type": "structure", + "members": { + "CustomVerificationEmailTemplates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TemplateName": {}, + "FromEmailAddress": {}, + "TemplateSubject": {}, + "SuccessRedirectionURL": {}, + "FailureRedirectionURL": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListIdentities": { + "input": { + "type": "structure", + "members": { + "IdentityType": {}, + "NextToken": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListIdentitiesResult", + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S3b" + }, + "NextToken": {} + } + } + }, + "ListIdentityPolicies": { + "input": { + "type": "structure", + "required": [ + "Identity" + ], + "members": { + "Identity": {} + } + }, + "output": { + "resultWrapper": "ListIdentityPoliciesResult", + "type": "structure", + "required": [ + "PolicyNames" + ], + "members": { + "PolicyNames": { + "shape": "S3v" + } + } + } + }, + "ListReceiptFilters": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "ListReceiptFiltersResult", + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "shape": "S10" + } + } + } + } + }, + "ListReceiptRuleSets": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListReceiptRuleSetsResult", + "type": "structure", + "members": { + "RuleSets": { + "type": "list", + "member": { + "shape": "S2t" + } + }, + "NextToken": {} + } + } + }, + "ListTemplates": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListTemplatesResult", + "type": "structure", + "members": { + "TemplatesMetadata": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListVerifiedEmailAddresses": { + "output": { + "resultWrapper": "ListVerifiedEmailAddressesResult", + "type": "structure", + "members": { + "VerifiedEmailAddresses": { + "shape": "S53" + } + } + } + }, + "PutIdentityPolicy": { + "input": { + "type": "structure", + "required": [ + "Identity", + "PolicyName", + "Policy" + ], + "members": { + "Identity": {}, + "PolicyName": {}, + "Policy": {} + } + }, + "output": { + "resultWrapper": "PutIdentityPolicyResult", + "type": "structure", + "members": {} + } + }, + "ReorderReceiptRuleSet": { + "input": { + "type": "structure", + "required": [ + "RuleSetName", + "RuleNames" + ], + "members": { + "RuleSetName": {}, + "RuleNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "ReorderReceiptRuleSetResult", + "type": "structure", + "members": {} + } + }, + "SendBounce": { + "input": { + "type": "structure", + "required": [ + "OriginalMessageId", + "BounceSender", + "BouncedRecipientInfoList" + ], + "members": { + "OriginalMessageId": {}, + "BounceSender": {}, + "Explanation": {}, + "MessageDsn": { + "type": "structure", + "required": [ + "ReportingMta" + ], + "members": { + "ReportingMta": {}, + "ArrivalDate": { + "type": "timestamp" + }, + "ExtensionFields": { + "shape": "S5f" + } + } + }, + "BouncedRecipientInfoList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Recipient" + ], + "members": { + "Recipient": {}, + "RecipientArn": {}, + "BounceType": {}, + "RecipientDsnFields": { + "type": "structure", + "required": [ + "Action", + "Status" + ], + "members": { + "FinalRecipient": {}, + "Action": {}, + "RemoteMta": {}, + "Status": {}, + "DiagnosticCode": {}, + "LastAttemptDate": { + "type": "timestamp" + }, + "ExtensionFields": { + "shape": "S5f" + } + } + } + } + } + }, + "BounceSenderArn": {} + } + }, + "output": { + "resultWrapper": "SendBounceResult", + "type": "structure", + "members": { + "MessageId": {} + } + } + }, + "SendBulkTemplatedEmail": { + "input": { + "type": "structure", + "required": [ + "Source", + "Template", + "Destinations" + ], + "members": { + "Source": {}, + "SourceArn": {}, + "ReplyToAddresses": { + "shape": "S53" + }, + "ReturnPath": {}, + "ReturnPathArn": {}, + "ConfigurationSetName": {}, + "DefaultTags": { + "shape": "S5u" + }, + "Template": {}, + "TemplateArn": {}, + "DefaultTemplateData": {}, + "Destinations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Destination" + ], + "members": { + "Destination": { + "shape": "S61" + }, + "ReplacementTags": { + "shape": "S5u" + }, + "ReplacementTemplateData": {} + } + } + } + } + }, + "output": { + "resultWrapper": "SendBulkTemplatedEmailResult", + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Status": {}, + "Error": {}, + "MessageId": {} + } + } + } + } + } + }, + "SendCustomVerificationEmail": { + "input": { + "type": "structure", + "required": [ + "EmailAddress", + "TemplateName" + ], + "members": { + "EmailAddress": {}, + "TemplateName": {}, + "ConfigurationSetName": {} + } + }, + "output": { + "resultWrapper": "SendCustomVerificationEmailResult", + "type": "structure", + "members": { + "MessageId": {} + } + } + }, + "SendEmail": { + "input": { + "type": "structure", + "required": [ + "Source", + "Destination", + "Message" + ], + "members": { + "Source": {}, + "Destination": { + "shape": "S61" + }, + "Message": { + "type": "structure", + "required": [ + "Subject", + "Body" + ], + "members": { + "Subject": { + "shape": "S6b" + }, + "Body": { + "type": "structure", + "members": { + "Text": { + "shape": "S6b" + }, + "Html": { + "shape": "S6b" + } + } + } + } + }, + "ReplyToAddresses": { + "shape": "S53" + }, + "ReturnPath": {}, + "SourceArn": {}, + "ReturnPathArn": {}, + "Tags": { + "shape": "S5u" + }, + "ConfigurationSetName": {} + } + }, + "output": { + "resultWrapper": "SendEmailResult", + "type": "structure", + "required": [ + "MessageId" + ], + "members": { + "MessageId": {} + } + } + }, + "SendRawEmail": { + "input": { + "type": "structure", + "required": [ + "RawMessage" + ], + "members": { + "Source": {}, + "Destinations": { + "shape": "S53" + }, + "RawMessage": { + "type": "structure", + "required": [ + "Data" + ], + "members": { + "Data": { + "type": "blob" + } + } + }, + "FromArn": {}, + "SourceArn": {}, + "ReturnPathArn": {}, + "Tags": { + "shape": "S5u" + }, + "ConfigurationSetName": {} + } + }, + "output": { + "resultWrapper": "SendRawEmailResult", + "type": "structure", + "required": [ + "MessageId" + ], + "members": { + "MessageId": {} + } + } + }, + "SendTemplatedEmail": { + "input": { + "type": "structure", + "required": [ + "Source", + "Destination", + "Template", + "TemplateData" + ], + "members": { + "Source": {}, + "Destination": { + "shape": "S61" + }, + "ReplyToAddresses": { + "shape": "S53" + }, + "ReturnPath": {}, + "SourceArn": {}, + "ReturnPathArn": {}, + "Tags": { + "shape": "S5u" + }, + "ConfigurationSetName": {}, + "Template": {}, + "TemplateArn": {}, + "TemplateData": {} + } + }, + "output": { + "resultWrapper": "SendTemplatedEmailResult", + "type": "structure", + "required": [ + "MessageId" + ], + "members": { + "MessageId": {} + } + } + }, + "SetActiveReceiptRuleSet": { + "input": { + "type": "structure", + "members": { + "RuleSetName": {} + } + }, + "output": { + "resultWrapper": "SetActiveReceiptRuleSetResult", + "type": "structure", + "members": {} + } + }, + "SetIdentityDkimEnabled": { + "input": { + "type": "structure", + "required": [ + "Identity", + "DkimEnabled" + ], + "members": { + "Identity": {}, + "DkimEnabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SetIdentityDkimEnabledResult", + "type": "structure", + "members": {} + } + }, + "SetIdentityFeedbackForwardingEnabled": { + "input": { + "type": "structure", + "required": [ + "Identity", + "ForwardingEnabled" + ], + "members": { + "Identity": {}, + "ForwardingEnabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SetIdentityFeedbackForwardingEnabledResult", + "type": "structure", + "members": {} + } + }, + "SetIdentityHeadersInNotificationsEnabled": { + "input": { + "type": "structure", + "required": [ + "Identity", + "NotificationType", + "Enabled" + ], + "members": { + "Identity": {}, + "NotificationType": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SetIdentityHeadersInNotificationsEnabledResult", + "type": "structure", + "members": {} + } + }, + "SetIdentityMailFromDomain": { + "input": { + "type": "structure", + "required": [ + "Identity" + ], + "members": { + "Identity": {}, + "MailFromDomain": {}, + "BehaviorOnMXFailure": {} + } + }, + "output": { + "resultWrapper": "SetIdentityMailFromDomainResult", + "type": "structure", + "members": {} + } + }, + "SetIdentityNotificationTopic": { + "input": { + "type": "structure", + "required": [ + "Identity", + "NotificationType" + ], + "members": { + "Identity": {}, + "NotificationType": {}, + "SnsTopic": {} + } + }, + "output": { + "resultWrapper": "SetIdentityNotificationTopicResult", + "type": "structure", + "members": {} + } + }, + "SetReceiptRulePosition": { + "input": { + "type": "structure", + "required": [ + "RuleSetName", + "RuleName" + ], + "members": { + "RuleSetName": {}, + "RuleName": {}, + "After": {} + } + }, + "output": { + "resultWrapper": "SetReceiptRulePositionResult", + "type": "structure", + "members": {} + } + }, + "TestRenderTemplate": { + "input": { + "type": "structure", + "required": [ + "TemplateName", + "TemplateData" + ], + "members": { + "TemplateName": {}, + "TemplateData": {} + } + }, + "output": { + "resultWrapper": "TestRenderTemplateResult", + "type": "structure", + "members": { + "RenderedTemplate": {} + } + } + }, + "UpdateAccountSendingEnabled": { + "input": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + } + }, + "UpdateConfigurationSetEventDestination": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestination" + ], + "members": { + "ConfigurationSetName": {}, + "EventDestination": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "UpdateConfigurationSetEventDestinationResult", + "type": "structure", + "members": {} + } + }, + "UpdateConfigurationSetReputationMetricsEnabled": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "Enabled" + ], + "members": { + "ConfigurationSetName": {}, + "Enabled": { + "type": "boolean" + } + } + } + }, + "UpdateConfigurationSetSendingEnabled": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "Enabled" + ], + "members": { + "ConfigurationSetName": {}, + "Enabled": { + "type": "boolean" + } + } + } + }, + "UpdateConfigurationSetTrackingOptions": { + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "TrackingOptions" + ], + "members": { + "ConfigurationSetName": {}, + "TrackingOptions": { + "shape": "Sp" + } + } + }, + "output": { + "resultWrapper": "UpdateConfigurationSetTrackingOptionsResult", + "type": "structure", + "members": {} + } + }, + "UpdateCustomVerificationEmailTemplate": { + "input": { + "type": "structure", + "required": [ + "TemplateName" + ], + "members": { + "TemplateName": {}, + "FromEmailAddress": {}, + "TemplateSubject": {}, + "TemplateContent": {}, + "SuccessRedirectionURL": {}, + "FailureRedirectionURL": {} + } + } + }, + "UpdateReceiptRule": { + "input": { + "type": "structure", + "required": [ + "RuleSetName", + "Rule" + ], + "members": { + "RuleSetName": {}, + "Rule": { + "shape": "S18" + } + } + }, + "output": { + "resultWrapper": "UpdateReceiptRuleResult", + "type": "structure", + "members": {} + } + }, + "UpdateTemplate": { + "input": { + "type": "structure", + "required": [ + "Template" + ], + "members": { + "Template": { + "shape": "S20" + } + } + }, + "output": { + "resultWrapper": "UpdateTemplateResult", + "type": "structure", + "members": {} + } + }, + "VerifyDomainDkim": { + "input": { + "type": "structure", + "required": [ + "Domain" + ], + "members": { + "Domain": {} + } + }, + "output": { + "resultWrapper": "VerifyDomainDkimResult", + "type": "structure", + "required": [ + "DkimTokens" + ], + "members": { + "DkimTokens": { + "shape": "S3g" + } + } + } + }, + "VerifyDomainIdentity": { + "input": { + "type": "structure", + "required": [ + "Domain" + ], + "members": { + "Domain": {} + } + }, + "output": { + "resultWrapper": "VerifyDomainIdentityResult", + "type": "structure", + "required": [ + "VerificationToken" + ], + "members": { + "VerificationToken": {} + } + } + }, + "VerifyEmailAddress": { + "input": { + "type": "structure", + "required": [ + "EmailAddress" + ], + "members": { + "EmailAddress": {} + } + } + }, + "VerifyEmailIdentity": { + "input": { + "type": "structure", + "required": [ + "EmailAddress" + ], + "members": { + "EmailAddress": {} + } + }, + "output": { + "resultWrapper": "VerifyEmailIdentityResult", + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "S9": { + "type": "structure", + "required": [ + "Name", + "MatchingEventTypes" + ], + "members": { + "Name": {}, + "Enabled": { + "type": "boolean" + }, + "MatchingEventTypes": { + "type": "list", + "member": {} + }, + "KinesisFirehoseDestination": { + "type": "structure", + "required": [ + "IAMRoleARN", + "DeliveryStreamARN" + ], + "members": { + "IAMRoleARN": {}, + "DeliveryStreamARN": {} + } + }, + "CloudWatchDestination": { + "type": "structure", + "required": [ + "DimensionConfigurations" + ], + "members": { + "DimensionConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DimensionName", + "DimensionValueSource", + "DefaultDimensionValue" + ], + "members": { + "DimensionName": {}, + "DimensionValueSource": {}, + "DefaultDimensionValue": {} + } + } + } + } + }, + "SNSDestination": { + "type": "structure", + "required": [ + "TopicARN" + ], + "members": { + "TopicARN": {} + } + } + } + }, + "Sp": { + "type": "structure", + "members": { + "CustomRedirectDomain": {} + } + }, + "S10": { + "type": "structure", + "required": [ + "Name", + "IpFilter" + ], + "members": { + "Name": {}, + "IpFilter": { + "type": "structure", + "required": [ + "Policy", + "Cidr" + ], + "members": { + "Policy": {}, + "Cidr": {} + } + } + } + }, + "S18": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Enabled": { + "type": "boolean" + }, + "TlsPolicy": {}, + "Recipients": { + "type": "list", + "member": {} + }, + "Actions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "S3Action": { + "type": "structure", + "required": [ + "BucketName" + ], + "members": { + "TopicArn": {}, + "BucketName": {}, + "ObjectKeyPrefix": {}, + "KmsKeyArn": {} + } + }, + "BounceAction": { + "type": "structure", + "required": [ + "SmtpReplyCode", + "Message", + "Sender" + ], + "members": { + "TopicArn": {}, + "SmtpReplyCode": {}, + "StatusCode": {}, + "Message": {}, + "Sender": {} + } + }, + "WorkmailAction": { + "type": "structure", + "required": [ + "OrganizationArn" + ], + "members": { + "TopicArn": {}, + "OrganizationArn": {} + } + }, + "LambdaAction": { + "type": "structure", + "required": [ + "FunctionArn" + ], + "members": { + "TopicArn": {}, + "FunctionArn": {}, + "InvocationType": {} + } + }, + "StopAction": { + "type": "structure", + "required": [ + "Scope" + ], + "members": { + "Scope": {}, + "TopicArn": {} + } + }, + "AddHeaderAction": { + "type": "structure", + "required": [ + "HeaderName", + "HeaderValue" + ], + "members": { + "HeaderName": {}, + "HeaderValue": {} + } + }, + "SNSAction": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {}, + "Encoding": {} + } + } + } + } + }, + "ScanEnabled": { + "type": "boolean" + } + } + }, + "S20": { + "type": "structure", + "required": [ + "TemplateName" + ], + "members": { + "TemplateName": {}, + "SubjectPart": {}, + "TextPart": {}, + "HtmlPart": {} + } + }, + "S2t": { + "type": "structure", + "members": { + "Name": {}, + "CreatedTimestamp": { + "type": "timestamp" + } + } + }, + "S2v": { + "type": "list", + "member": { + "shape": "S18" + } + }, + "S3b": { + "type": "list", + "member": {} + }, + "S3g": { + "type": "list", + "member": {} + }, + "S3v": { + "type": "list", + "member": {} + }, + "S53": { + "type": "list", + "member": {} + }, + "S5f": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "S5u": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "S61": { + "type": "structure", + "members": { + "ToAddresses": { + "shape": "S53" + }, + "CcAddresses": { + "shape": "S53" + }, + "BccAddresses": { + "shape": "S53" + } + } + }, + "S6b": { + "type": "structure", + "required": [ + "Data" + ], + "members": { + "Data": {}, + "Charset": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/email-2010-12-01.paginators.json b/node_modules/aws-sdk/apis/email-2010-12-01.paginators.json new file mode 100644 index 0000000..b3b142d --- /dev/null +++ b/node_modules/aws-sdk/apis/email-2010-12-01.paginators.json @@ -0,0 +1,18 @@ +{ + "pagination": { + "ListCustomVerificationEmailTemplates": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListIdentities": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "Identities" + }, + "ListVerifiedEmailAddresses": { + "result_key": "VerifiedEmailAddresses" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/email-2010-12-01.waiters2.json b/node_modules/aws-sdk/apis/email-2010-12-01.waiters2.json new file mode 100644 index 0000000..b585d30 --- /dev/null +++ b/node_modules/aws-sdk/apis/email-2010-12-01.waiters2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "IdentityExists": { + "delay": 3, + "operation": "GetIdentityVerificationAttributes", + "maxAttempts": 20, + "acceptors": [ + { + "expected": "Success", + "matcher": "pathAll", + "state": "success", + "argument": "VerificationAttributes.*.VerificationStatus" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.examples.json b/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.min.json b/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.min.json new file mode 100644 index 0000000..edc68ed --- /dev/null +++ b/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.min.json @@ -0,0 +1,76 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-01-11", + "endpointPrefix": "entitlement.marketplace", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Marketplace Entitlement Service", + "serviceId": "Marketplace Entitlement Service", + "signatureVersion": "v4", + "signingName": "aws-marketplace", + "targetPrefix": "AWSMPEntitlementService", + "uid": "entitlement.marketplace-2017-01-11" + }, + "operations": { + "GetEntitlements": { + "input": { + "type": "structure", + "required": [ + "ProductCode" + ], + "members": { + "ProductCode": {}, + "Filter": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Entitlements": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProductCode": {}, + "Dimension": {}, + "CustomerIdentifier": {}, + "Value": { + "type": "structure", + "members": { + "IntegerValue": { + "type": "integer" + }, + "DoubleValue": { + "type": "double" + }, + "BooleanValue": { + "type": "boolean" + }, + "StringValue": {} + } + }, + "ExpirationDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.paginators.json b/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/entitlement.marketplace-2017-01-11.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/es-2015-01-01.examples.json b/node_modules/aws-sdk/apis/es-2015-01-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/es-2015-01-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/es-2015-01-01.min.json b/node_modules/aws-sdk/apis/es-2015-01-01.min.json new file mode 100644 index 0000000..75dd781 --- /dev/null +++ b/node_modules/aws-sdk/apis/es-2015-01-01.min.json @@ -0,0 +1,1245 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-01-01", + "endpointPrefix": "es", + "protocol": "rest-json", + "serviceFullName": "Amazon Elasticsearch Service", + "serviceId": "Elasticsearch Service", + "signatureVersion": "v4", + "uid": "es-2015-01-01" + }, + "operations": { + "AddTags": { + "http": { + "requestUri": "/2015-01-01/tags" + }, + "input": { + "type": "structure", + "required": [ + "ARN", + "TagList" + ], + "members": { + "ARN": {}, + "TagList": { + "shape": "S3" + } + } + } + }, + "CancelElasticsearchServiceSoftwareUpdate": { + "http": { + "requestUri": "/2015-01-01/es/serviceSoftwareUpdate/cancel" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceSoftwareOptions": { + "shape": "Sa" + } + } + } + }, + "CreateElasticsearchDomain": { + "http": { + "requestUri": "/2015-01-01/es/domain" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "ElasticsearchVersion": {}, + "ElasticsearchClusterConfig": { + "shape": "Sh" + }, + "EBSOptions": { + "shape": "Sl" + }, + "AccessPolicies": {}, + "SnapshotOptions": { + "shape": "So" + }, + "VPCOptions": { + "shape": "Sp" + }, + "CognitoOptions": { + "shape": "Sr" + }, + "EncryptionAtRestOptions": { + "shape": "Sv" + }, + "NodeToNodeEncryptionOptions": { + "shape": "Sx" + }, + "AdvancedOptions": { + "shape": "Sy" + }, + "LogPublishingOptions": { + "shape": "Sz" + } + } + }, + "output": { + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S14" + } + } + } + }, + "DeleteElasticsearchDomain": { + "http": { + "method": "DELETE", + "requestUri": "/2015-01-01/es/domain/{DomainName}" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + } + } + }, + "output": { + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S14" + } + } + } + }, + "DeleteElasticsearchServiceRole": { + "http": { + "method": "DELETE", + "requestUri": "/2015-01-01/es/role" + } + }, + "DescribeElasticsearchDomain": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/domain/{DomainName}" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DomainStatus" + ], + "members": { + "DomainStatus": { + "shape": "S14" + } + } + } + }, + "DescribeElasticsearchDomainConfig": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/domain/{DomainName}/config" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DomainConfig" + ], + "members": { + "DomainConfig": { + "shape": "S1f" + } + } + } + }, + "DescribeElasticsearchDomains": { + "http": { + "requestUri": "/2015-01-01/es/domain-info" + }, + "input": { + "type": "structure", + "required": [ + "DomainNames" + ], + "members": { + "DomainNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "required": [ + "DomainStatusList" + ], + "members": { + "DomainStatusList": { + "type": "list", + "member": { + "shape": "S14" + } + } + } + } + }, + "DescribeElasticsearchInstanceTypeLimits": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}" + }, + "input": { + "type": "structure", + "required": [ + "InstanceType", + "ElasticsearchVersion" + ], + "members": { + "DomainName": { + "location": "querystring", + "locationName": "domainName" + }, + "InstanceType": { + "location": "uri", + "locationName": "InstanceType" + }, + "ElasticsearchVersion": { + "location": "uri", + "locationName": "ElasticsearchVersion" + } + } + }, + "output": { + "type": "structure", + "members": { + "LimitsByRole": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "StorageTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StorageTypeName": {}, + "StorageSubTypeName": {}, + "StorageTypeLimits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LimitName": {}, + "LimitValues": { + "shape": "S2b" + } + } + } + } + } + } + }, + "InstanceLimits": { + "type": "structure", + "members": { + "InstanceCountLimits": { + "type": "structure", + "members": { + "MinimumInstanceCount": { + "type": "integer" + }, + "MaximumInstanceCount": { + "type": "integer" + } + } + } + } + }, + "AdditionalLimits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LimitName": {}, + "LimitValues": { + "shape": "S2b" + } + } + } + } + } + } + } + } + } + }, + "DescribeReservedElasticsearchInstanceOfferings": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/reservedInstanceOfferings" + }, + "input": { + "type": "structure", + "members": { + "ReservedElasticsearchInstanceOfferingId": { + "location": "querystring", + "locationName": "offeringId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "ReservedElasticsearchInstanceOfferings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ReservedElasticsearchInstanceOfferingId": {}, + "ElasticsearchInstanceType": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "PaymentOption": {}, + "RecurringCharges": { + "shape": "S2t" + } + } + } + } + } + } + }, + "DescribeReservedElasticsearchInstances": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/reservedInstances" + }, + "input": { + "type": "structure", + "members": { + "ReservedElasticsearchInstanceId": { + "location": "querystring", + "locationName": "reservationId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "ReservedElasticsearchInstances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ReservationName": {}, + "ReservedElasticsearchInstanceId": {}, + "ReservedElasticsearchInstanceOfferingId": {}, + "ElasticsearchInstanceType": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ElasticsearchInstanceCount": { + "type": "integer" + }, + "State": {}, + "PaymentOption": {}, + "RecurringCharges": { + "shape": "S2t" + } + } + } + } + } + } + }, + "GetCompatibleElasticsearchVersions": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/compatibleVersions" + }, + "input": { + "type": "structure", + "members": { + "DomainName": { + "location": "querystring", + "locationName": "domainName" + } + } + }, + "output": { + "type": "structure", + "members": { + "CompatibleElasticsearchVersions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceVersion": {}, + "TargetVersions": { + "shape": "S34" + } + } + } + } + } + } + }, + "GetUpgradeHistory": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/upgradeDomain/{DomainName}/history" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "UpgradeHistories": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UpgradeName": {}, + "StartTimestamp": { + "type": "timestamp" + }, + "UpgradeStatus": {}, + "StepsList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UpgradeStep": {}, + "UpgradeStepStatus": {}, + "Issues": { + "type": "list", + "member": {} + }, + "ProgressPercent": { + "type": "double" + } + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "GetUpgradeStatus": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/upgradeDomain/{DomainName}/status" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + } + } + }, + "output": { + "type": "structure", + "members": { + "UpgradeStep": {}, + "StepStatus": {}, + "UpgradeName": {} + } + } + }, + "ListDomainNames": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/domain" + }, + "output": { + "type": "structure", + "members": { + "DomainNames": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DomainName": {} + } + } + } + } + } + }, + "ListElasticsearchInstanceTypes": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/instanceTypes/{ElasticsearchVersion}" + }, + "input": { + "type": "structure", + "required": [ + "ElasticsearchVersion" + ], + "members": { + "ElasticsearchVersion": { + "location": "uri", + "locationName": "ElasticsearchVersion" + }, + "DomainName": { + "location": "querystring", + "locationName": "domainName" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "ElasticsearchInstanceTypes": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListElasticsearchVersions": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/es/versions" + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "ElasticsearchVersions": { + "shape": "S34" + }, + "NextToken": {} + } + } + }, + "ListTags": { + "http": { + "method": "GET", + "requestUri": "/2015-01-01/tags/" + }, + "input": { + "type": "structure", + "required": [ + "ARN" + ], + "members": { + "ARN": { + "location": "querystring", + "locationName": "arn" + } + } + }, + "output": { + "type": "structure", + "members": { + "TagList": { + "shape": "S3" + } + } + } + }, + "PurchaseReservedElasticsearchInstanceOffering": { + "http": { + "requestUri": "/2015-01-01/es/purchaseReservedInstanceOffering" + }, + "input": { + "type": "structure", + "required": [ + "ReservedElasticsearchInstanceOfferingId", + "ReservationName" + ], + "members": { + "ReservedElasticsearchInstanceOfferingId": {}, + "ReservationName": {}, + "InstanceCount": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedElasticsearchInstanceId": {}, + "ReservationName": {} + } + } + }, + "RemoveTags": { + "http": { + "requestUri": "/2015-01-01/tags-removal" + }, + "input": { + "type": "structure", + "required": [ + "ARN", + "TagKeys" + ], + "members": { + "ARN": {}, + "TagKeys": { + "shape": "Sq" + } + } + } + }, + "StartElasticsearchServiceSoftwareUpdate": { + "http": { + "requestUri": "/2015-01-01/es/serviceSoftwareUpdate/start" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceSoftwareOptions": { + "shape": "Sa" + } + } + } + }, + "UpdateElasticsearchDomainConfig": { + "http": { + "requestUri": "/2015-01-01/es/domain/{DomainName}/config" + }, + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": { + "location": "uri", + "locationName": "DomainName" + }, + "ElasticsearchClusterConfig": { + "shape": "Sh" + }, + "EBSOptions": { + "shape": "Sl" + }, + "SnapshotOptions": { + "shape": "So" + }, + "VPCOptions": { + "shape": "Sp" + }, + "CognitoOptions": { + "shape": "Sr" + }, + "AdvancedOptions": { + "shape": "Sy" + }, + "AccessPolicies": {}, + "LogPublishingOptions": { + "shape": "Sz" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DomainConfig" + ], + "members": { + "DomainConfig": { + "shape": "S1f" + } + } + } + }, + "UpgradeElasticsearchDomain": { + "http": { + "requestUri": "/2015-01-01/es/upgradeDomain" + }, + "input": { + "type": "structure", + "required": [ + "DomainName", + "TargetVersion" + ], + "members": { + "DomainName": {}, + "TargetVersion": {}, + "PerformCheckOnly": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DomainName": {}, + "TargetVersion": {}, + "PerformCheckOnly": { + "type": "boolean" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sa": { + "type": "structure", + "members": { + "CurrentVersion": {}, + "NewVersion": {}, + "UpdateAvailable": { + "type": "boolean" + }, + "Cancellable": { + "type": "boolean" + }, + "UpdateStatus": {}, + "Description": {}, + "AutomatedUpdateDate": { + "type": "timestamp" + } + } + }, + "Sh": { + "type": "structure", + "members": { + "InstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "DedicatedMasterEnabled": { + "type": "boolean" + }, + "ZoneAwarenessEnabled": { + "type": "boolean" + }, + "ZoneAwarenessConfig": { + "type": "structure", + "members": { + "AvailabilityZoneCount": { + "type": "integer" + } + } + }, + "DedicatedMasterType": {}, + "DedicatedMasterCount": { + "type": "integer" + } + } + }, + "Sl": { + "type": "structure", + "members": { + "EBSEnabled": { + "type": "boolean" + }, + "VolumeType": {}, + "VolumeSize": { + "type": "integer" + }, + "Iops": { + "type": "integer" + } + } + }, + "So": { + "type": "structure", + "members": { + "AutomatedSnapshotStartHour": { + "type": "integer" + } + } + }, + "Sp": { + "type": "structure", + "members": { + "SubnetIds": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "Sq" + } + } + }, + "Sq": { + "type": "list", + "member": {} + }, + "Sr": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "UserPoolId": {}, + "IdentityPoolId": {}, + "RoleArn": {} + } + }, + "Sv": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "KmsKeyId": {} + } + }, + "Sx": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "Sy": { + "type": "map", + "key": {}, + "value": {} + }, + "Sz": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": {}, + "Enabled": { + "type": "boolean" + } + } + } + }, + "S14": { + "type": "structure", + "required": [ + "DomainId", + "DomainName", + "ARN", + "ElasticsearchClusterConfig" + ], + "members": { + "DomainId": {}, + "DomainName": {}, + "ARN": {}, + "Created": { + "type": "boolean" + }, + "Deleted": { + "type": "boolean" + }, + "Endpoint": {}, + "Endpoints": { + "type": "map", + "key": {}, + "value": {} + }, + "Processing": { + "type": "boolean" + }, + "UpgradeProcessing": { + "type": "boolean" + }, + "ElasticsearchVersion": {}, + "ElasticsearchClusterConfig": { + "shape": "Sh" + }, + "EBSOptions": { + "shape": "Sl" + }, + "AccessPolicies": {}, + "SnapshotOptions": { + "shape": "So" + }, + "VPCOptions": { + "shape": "S18" + }, + "CognitoOptions": { + "shape": "Sr" + }, + "EncryptionAtRestOptions": { + "shape": "Sv" + }, + "NodeToNodeEncryptionOptions": { + "shape": "Sx" + }, + "AdvancedOptions": { + "shape": "Sy" + }, + "LogPublishingOptions": { + "shape": "Sz" + }, + "ServiceSoftwareOptions": { + "shape": "Sa" + } + } + }, + "S18": { + "type": "structure", + "members": { + "VPCId": {}, + "SubnetIds": { + "shape": "Sq" + }, + "AvailabilityZones": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "Sq" + } + } + }, + "S1f": { + "type": "structure", + "members": { + "ElasticsearchVersion": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "S1h" + } + } + }, + "ElasticsearchClusterConfig": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sh" + }, + "Status": { + "shape": "S1h" + } + } + }, + "EBSOptions": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sl" + }, + "Status": { + "shape": "S1h" + } + } + }, + "AccessPolicies": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "S1h" + } + } + }, + "SnapshotOptions": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "So" + }, + "Status": { + "shape": "S1h" + } + } + }, + "VPCOptions": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S18" + }, + "Status": { + "shape": "S1h" + } + } + }, + "CognitoOptions": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sr" + }, + "Status": { + "shape": "S1h" + } + } + }, + "EncryptionAtRestOptions": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sv" + }, + "Status": { + "shape": "S1h" + } + } + }, + "NodeToNodeEncryptionOptions": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sx" + }, + "Status": { + "shape": "S1h" + } + } + }, + "AdvancedOptions": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sy" + }, + "Status": { + "shape": "S1h" + } + } + }, + "LogPublishingOptions": { + "type": "structure", + "members": { + "Options": { + "shape": "Sz" + }, + "Status": { + "shape": "S1h" + } + } + } + } + }, + "S1h": { + "type": "structure", + "required": [ + "CreationDate", + "UpdateDate", + "State" + ], + "members": { + "CreationDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + }, + "UpdateVersion": { + "type": "integer" + }, + "State": {}, + "PendingDeletion": { + "type": "boolean" + } + } + }, + "S2b": { + "type": "list", + "member": {} + }, + "S2t": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + } + } + }, + "S34": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/es-2015-01-01.paginators.json b/node_modules/aws-sdk/apis/es-2015-01-01.paginators.json new file mode 100644 index 0000000..a8442e1 --- /dev/null +++ b/node_modules/aws-sdk/apis/es-2015-01-01.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "DescribeReservedElasticsearchInstanceOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "DescribeReservedElasticsearchInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetUpgradeHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListElasticsearchInstanceTypes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListElasticsearchVersions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/events-2015-10-07.examples.json b/node_modules/aws-sdk/apis/events-2015-10-07.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/events-2015-10-07.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/events-2015-10-07.min.json b/node_modules/aws-sdk/apis/events-2015-10-07.min.json new file mode 100644 index 0000000..ef3ff03 --- /dev/null +++ b/node_modules/aws-sdk/apis/events-2015-10-07.min.json @@ -0,0 +1,588 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-10-07", + "endpointPrefix": "events", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon CloudWatch Events", + "serviceId": "CloudWatch Events", + "signatureVersion": "v4", + "targetPrefix": "AWSEvents", + "uid": "events-2015-10-07" + }, + "operations": { + "DeleteRule": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Force": { + "type": "boolean" + } + } + } + }, + "DescribeEventBus": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "Arn": {}, + "Policy": {} + } + } + }, + "DescribeRule": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "Arn": {}, + "EventPattern": {}, + "ScheduleExpression": {}, + "State": {}, + "Description": {}, + "RoleArn": {}, + "ManagedBy": {} + } + } + }, + "DisableRule": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + } + }, + "EnableRule": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + } + }, + "ListRuleNamesByTarget": { + "input": { + "type": "structure", + "required": [ + "TargetArn" + ], + "members": { + "TargetArn": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "RuleNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListRules": { + "input": { + "type": "structure", + "members": { + "NamePrefix": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Rules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Arn": {}, + "EventPattern": {}, + "State": {}, + "Description": {}, + "ScheduleExpression": {}, + "RoleArn": {}, + "ManagedBy": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sv" + } + } + } + }, + "ListTargetsByRule": { + "input": { + "type": "structure", + "required": [ + "Rule" + ], + "members": { + "Rule": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Targets": { + "shape": "S11" + }, + "NextToken": {} + } + } + }, + "PutEvents": { + "input": { + "type": "structure", + "required": [ + "Entries" + ], + "members": { + "Entries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Time": { + "type": "timestamp" + }, + "Source": {}, + "Resources": { + "type": "list", + "member": {} + }, + "DetailType": {}, + "Detail": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedEntryCount": { + "type": "integer" + }, + "Entries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "PutPermission": { + "input": { + "type": "structure", + "required": [ + "Action", + "Principal", + "StatementId" + ], + "members": { + "Action": {}, + "Principal": {}, + "StatementId": {}, + "Condition": { + "type": "structure", + "required": [ + "Type", + "Key", + "Value" + ], + "members": { + "Type": {}, + "Key": {}, + "Value": {} + } + } + } + } + }, + "PutRule": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "ScheduleExpression": {}, + "EventPattern": {}, + "State": {}, + "Description": {}, + "RoleArn": {}, + "Tags": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": { + "RuleArn": {} + } + } + }, + "PutTargets": { + "input": { + "type": "structure", + "required": [ + "Rule", + "Targets" + ], + "members": { + "Rule": {}, + "Targets": { + "shape": "S11" + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedEntryCount": { + "type": "integer" + }, + "FailedEntries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TargetId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "RemovePermission": { + "input": { + "type": "structure", + "required": [ + "StatementId" + ], + "members": { + "StatementId": {} + } + } + }, + "RemoveTargets": { + "input": { + "type": "structure", + "required": [ + "Rule", + "Ids" + ], + "members": { + "Rule": {}, + "Ids": { + "type": "list", + "member": {} + }, + "Force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedEntryCount": { + "type": "integer" + }, + "FailedEntries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TargetId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "Tags" + ], + "members": { + "ResourceARN": {}, + "Tags": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TestEventPattern": { + "input": { + "type": "structure", + "required": [ + "EventPattern", + "Event" + ], + "members": { + "EventPattern": {}, + "Event": {} + } + }, + "output": { + "type": "structure", + "members": { + "Result": { + "type": "boolean" + } + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "TagKeys" + ], + "members": { + "ResourceARN": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S11": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id", + "Arn" + ], + "members": { + "Id": {}, + "Arn": {}, + "RoleArn": {}, + "Input": {}, + "InputPath": {}, + "InputTransformer": { + "type": "structure", + "required": [ + "InputTemplate" + ], + "members": { + "InputPathsMap": { + "type": "map", + "key": {}, + "value": {} + }, + "InputTemplate": {} + } + }, + "KinesisParameters": { + "type": "structure", + "required": [ + "PartitionKeyPath" + ], + "members": { + "PartitionKeyPath": {} + } + }, + "RunCommandParameters": { + "type": "structure", + "required": [ + "RunCommandTargets" + ], + "members": { + "RunCommandTargets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "EcsParameters": { + "type": "structure", + "required": [ + "TaskDefinitionArn" + ], + "members": { + "TaskDefinitionArn": {}, + "TaskCount": { + "type": "integer" + }, + "LaunchType": {}, + "NetworkConfiguration": { + "type": "structure", + "members": { + "awsvpcConfiguration": { + "type": "structure", + "required": [ + "Subnets" + ], + "members": { + "Subnets": { + "shape": "S1n" + }, + "SecurityGroups": { + "shape": "S1n" + }, + "AssignPublicIp": {} + } + } + } + }, + "PlatformVersion": {}, + "Group": {} + } + }, + "BatchParameters": { + "type": "structure", + "required": [ + "JobDefinition", + "JobName" + ], + "members": { + "JobDefinition": {}, + "JobName": {}, + "ArrayProperties": { + "type": "structure", + "members": { + "Size": { + "type": "integer" + } + } + }, + "RetryStrategy": { + "type": "structure", + "members": { + "Attempts": { + "type": "integer" + } + } + } + } + }, + "SqsParameters": { + "type": "structure", + "members": { + "MessageGroupId": {} + } + } + } + } + }, + "S1n": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/events-2015-10-07.paginators.json b/node_modules/aws-sdk/apis/events-2015-10-07.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/events-2015-10-07.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/firehose-2015-08-04.examples.json b/node_modules/aws-sdk/apis/firehose-2015-08-04.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/firehose-2015-08-04.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json b/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json new file mode 100644 index 0000000..4d6a8f5 --- /dev/null +++ b/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json @@ -0,0 +1,1083 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-08-04", + "endpointPrefix": "firehose", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Firehose", + "serviceFullName": "Amazon Kinesis Firehose", + "serviceId": "Firehose", + "signatureVersion": "v4", + "targetPrefix": "Firehose_20150804", + "uid": "firehose-2015-08-04" + }, + "operations": { + "CreateDeliveryStream": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName" + ], + "members": { + "DeliveryStreamName": {}, + "DeliveryStreamType": {}, + "KinesisStreamSourceConfiguration": { + "type": "structure", + "required": [ + "KinesisStreamARN", + "RoleARN" + ], + "members": { + "KinesisStreamARN": {}, + "RoleARN": {} + } + }, + "S3DestinationConfiguration": { + "shape": "S7", + "deprecated": true + }, + "ExtendedS3DestinationConfiguration": { + "type": "structure", + "required": [ + "RoleARN", + "BucketARN" + ], + "members": { + "RoleARN": {}, + "BucketARN": {}, + "Prefix": {}, + "ErrorOutputPrefix": {}, + "BufferingHints": { + "shape": "Sb" + }, + "CompressionFormat": {}, + "EncryptionConfiguration": { + "shape": "Sf" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "S3BackupMode": {}, + "S3BackupConfiguration": { + "shape": "S7" + }, + "DataFormatConversionConfiguration": { + "shape": "Sx" + } + } + }, + "RedshiftDestinationConfiguration": { + "type": "structure", + "required": [ + "RoleARN", + "ClusterJDBCURL", + "CopyCommand", + "Username", + "Password", + "S3Configuration" + ], + "members": { + "RoleARN": {}, + "ClusterJDBCURL": {}, + "CopyCommand": { + "shape": "S1o" + }, + "Username": { + "shape": "S1s" + }, + "Password": { + "shape": "S1t" + }, + "RetryOptions": { + "shape": "S1u" + }, + "S3Configuration": { + "shape": "S7" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "S3BackupMode": {}, + "S3BackupConfiguration": { + "shape": "S7" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "ElasticsearchDestinationConfiguration": { + "type": "structure", + "required": [ + "RoleARN", + "DomainARN", + "IndexName", + "TypeName", + "S3Configuration" + ], + "members": { + "RoleARN": {}, + "DomainARN": {}, + "IndexName": {}, + "TypeName": {}, + "IndexRotationPeriod": {}, + "BufferingHints": { + "shape": "S22" + }, + "RetryOptions": { + "shape": "S25" + }, + "S3BackupMode": {}, + "S3Configuration": { + "shape": "S7" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "SplunkDestinationConfiguration": { + "type": "structure", + "required": [ + "HECEndpoint", + "HECEndpointType", + "HECToken", + "S3Configuration" + ], + "members": { + "HECEndpoint": {}, + "HECEndpointType": {}, + "HECToken": {}, + "HECAcknowledgmentTimeoutInSeconds": { + "type": "integer" + }, + "RetryOptions": { + "shape": "S2d" + }, + "S3BackupMode": {}, + "S3Configuration": { + "shape": "S7" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "Tags": { + "shape": "S2g" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeliveryStreamARN": {} + } + } + }, + "DeleteDeliveryStream": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName" + ], + "members": { + "DeliveryStreamName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeDeliveryStream": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName" + ], + "members": { + "DeliveryStreamName": {}, + "Limit": { + "type": "integer" + }, + "ExclusiveStartDestinationId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "DeliveryStreamDescription" + ], + "members": { + "DeliveryStreamDescription": { + "type": "structure", + "required": [ + "DeliveryStreamName", + "DeliveryStreamARN", + "DeliveryStreamStatus", + "DeliveryStreamType", + "VersionId", + "Destinations", + "HasMoreDestinations" + ], + "members": { + "DeliveryStreamName": {}, + "DeliveryStreamARN": {}, + "DeliveryStreamStatus": {}, + "DeliveryStreamEncryptionConfiguration": { + "type": "structure", + "members": { + "Status": {} + } + }, + "DeliveryStreamType": {}, + "VersionId": {}, + "CreateTimestamp": { + "type": "timestamp" + }, + "LastUpdateTimestamp": { + "type": "timestamp" + }, + "Source": { + "type": "structure", + "members": { + "KinesisStreamSourceDescription": { + "type": "structure", + "members": { + "KinesisStreamARN": {}, + "RoleARN": {}, + "DeliveryStartTimestamp": { + "type": "timestamp" + } + } + } + } + }, + "Destinations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DestinationId" + ], + "members": { + "DestinationId": {}, + "S3DestinationDescription": { + "shape": "S33" + }, + "ExtendedS3DestinationDescription": { + "type": "structure", + "required": [ + "RoleARN", + "BucketARN", + "BufferingHints", + "CompressionFormat", + "EncryptionConfiguration" + ], + "members": { + "RoleARN": {}, + "BucketARN": {}, + "Prefix": {}, + "ErrorOutputPrefix": {}, + "BufferingHints": { + "shape": "Sb" + }, + "CompressionFormat": {}, + "EncryptionConfiguration": { + "shape": "Sf" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "S3BackupMode": {}, + "S3BackupDescription": { + "shape": "S33" + }, + "DataFormatConversionConfiguration": { + "shape": "Sx" + } + } + }, + "RedshiftDestinationDescription": { + "type": "structure", + "required": [ + "RoleARN", + "ClusterJDBCURL", + "CopyCommand", + "Username", + "S3DestinationDescription" + ], + "members": { + "RoleARN": {}, + "ClusterJDBCURL": {}, + "CopyCommand": { + "shape": "S1o" + }, + "Username": { + "shape": "S1s" + }, + "RetryOptions": { + "shape": "S1u" + }, + "S3DestinationDescription": { + "shape": "S33" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "S3BackupMode": {}, + "S3BackupDescription": { + "shape": "S33" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "ElasticsearchDestinationDescription": { + "type": "structure", + "members": { + "RoleARN": {}, + "DomainARN": {}, + "IndexName": {}, + "TypeName": {}, + "IndexRotationPeriod": {}, + "BufferingHints": { + "shape": "S22" + }, + "RetryOptions": { + "shape": "S25" + }, + "S3BackupMode": {}, + "S3DestinationDescription": { + "shape": "S33" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "SplunkDestinationDescription": { + "type": "structure", + "members": { + "HECEndpoint": {}, + "HECEndpointType": {}, + "HECToken": {}, + "HECAcknowledgmentTimeoutInSeconds": { + "type": "integer" + }, + "RetryOptions": { + "shape": "S2d" + }, + "S3BackupMode": {}, + "S3DestinationDescription": { + "shape": "S33" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + } + } + } + }, + "HasMoreDestinations": { + "type": "boolean" + } + } + } + } + } + }, + "ListDeliveryStreams": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "DeliveryStreamType": {}, + "ExclusiveStartDeliveryStreamName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "DeliveryStreamNames", + "HasMoreDeliveryStreams" + ], + "members": { + "DeliveryStreamNames": { + "type": "list", + "member": {} + }, + "HasMoreDeliveryStreams": { + "type": "boolean" + } + } + } + }, + "ListTagsForDeliveryStream": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName" + ], + "members": { + "DeliveryStreamName": {}, + "ExclusiveStartTagKey": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags", + "HasMoreTags" + ], + "members": { + "Tags": { + "type": "list", + "member": { + "shape": "S2h" + } + }, + "HasMoreTags": { + "type": "boolean" + } + } + } + }, + "PutRecord": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName", + "Record" + ], + "members": { + "DeliveryStreamName": {}, + "Record": { + "shape": "S3h" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RecordId" + ], + "members": { + "RecordId": {}, + "Encrypted": { + "type": "boolean" + } + } + } + }, + "PutRecordBatch": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName", + "Records" + ], + "members": { + "DeliveryStreamName": {}, + "Records": { + "type": "list", + "member": { + "shape": "S3h" + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "FailedPutCount", + "RequestResponses" + ], + "members": { + "FailedPutCount": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + }, + "RequestResponses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RecordId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "StartDeliveryStreamEncryption": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName" + ], + "members": { + "DeliveryStreamName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopDeliveryStreamEncryption": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName" + ], + "members": { + "DeliveryStreamName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TagDeliveryStream": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName", + "Tags" + ], + "members": { + "DeliveryStreamName": {}, + "Tags": { + "shape": "S2g" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagDeliveryStream": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName", + "TagKeys" + ], + "members": { + "DeliveryStreamName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDestination": { + "input": { + "type": "structure", + "required": [ + "DeliveryStreamName", + "CurrentDeliveryStreamVersionId", + "DestinationId" + ], + "members": { + "DeliveryStreamName": {}, + "CurrentDeliveryStreamVersionId": {}, + "DestinationId": {}, + "S3DestinationUpdate": { + "shape": "S42", + "deprecated": true + }, + "ExtendedS3DestinationUpdate": { + "type": "structure", + "members": { + "RoleARN": {}, + "BucketARN": {}, + "Prefix": {}, + "ErrorOutputPrefix": {}, + "BufferingHints": { + "shape": "Sb" + }, + "CompressionFormat": {}, + "EncryptionConfiguration": { + "shape": "Sf" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "S3BackupMode": {}, + "S3BackupUpdate": { + "shape": "S42" + }, + "DataFormatConversionConfiguration": { + "shape": "Sx" + } + } + }, + "RedshiftDestinationUpdate": { + "type": "structure", + "members": { + "RoleARN": {}, + "ClusterJDBCURL": {}, + "CopyCommand": { + "shape": "S1o" + }, + "Username": { + "shape": "S1s" + }, + "Password": { + "shape": "S1t" + }, + "RetryOptions": { + "shape": "S1u" + }, + "S3Update": { + "shape": "S42" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "S3BackupMode": {}, + "S3BackupUpdate": { + "shape": "S42" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "ElasticsearchDestinationUpdate": { + "type": "structure", + "members": { + "RoleARN": {}, + "DomainARN": {}, + "IndexName": {}, + "TypeName": {}, + "IndexRotationPeriod": {}, + "BufferingHints": { + "shape": "S22" + }, + "RetryOptions": { + "shape": "S25" + }, + "S3Update": { + "shape": "S42" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "SplunkDestinationUpdate": { + "type": "structure", + "members": { + "HECEndpoint": {}, + "HECEndpointType": {}, + "HECToken": {}, + "HECAcknowledgmentTimeoutInSeconds": { + "type": "integer" + }, + "RetryOptions": { + "shape": "S2d" + }, + "S3BackupMode": {}, + "S3Update": { + "shape": "S42" + }, + "ProcessingConfiguration": { + "shape": "So" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "required": [ + "RoleARN", + "BucketARN" + ], + "members": { + "RoleARN": {}, + "BucketARN": {}, + "Prefix": {}, + "ErrorOutputPrefix": {}, + "BufferingHints": { + "shape": "Sb" + }, + "CompressionFormat": {}, + "EncryptionConfiguration": { + "shape": "Sf" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "Sb": { + "type": "structure", + "members": { + "SizeInMBs": { + "type": "integer" + }, + "IntervalInSeconds": { + "type": "integer" + } + } + }, + "Sf": { + "type": "structure", + "members": { + "NoEncryptionConfig": {}, + "KMSEncryptionConfig": { + "type": "structure", + "required": [ + "AWSKMSKeyARN" + ], + "members": { + "AWSKMSKeyARN": {} + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "LogGroupName": {}, + "LogStreamName": {} + } + }, + "So": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "Processors": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ParameterName", + "ParameterValue" + ], + "members": { + "ParameterName": {}, + "ParameterValue": {} + } + } + } + } + } + } + } + }, + "Sx": { + "type": "structure", + "members": { + "SchemaConfiguration": { + "type": "structure", + "members": { + "RoleARN": {}, + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "Region": {}, + "VersionId": {} + } + }, + "InputFormatConfiguration": { + "type": "structure", + "members": { + "Deserializer": { + "type": "structure", + "members": { + "OpenXJsonSerDe": { + "type": "structure", + "members": { + "ConvertDotsInJsonKeysToUnderscores": { + "type": "boolean" + }, + "CaseInsensitive": { + "type": "boolean" + }, + "ColumnToJsonKeyMappings": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "HiveJsonSerDe": { + "type": "structure", + "members": { + "TimestampFormats": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "OutputFormatConfiguration": { + "type": "structure", + "members": { + "Serializer": { + "type": "structure", + "members": { + "ParquetSerDe": { + "type": "structure", + "members": { + "BlockSizeBytes": { + "type": "integer" + }, + "PageSizeBytes": { + "type": "integer" + }, + "Compression": {}, + "EnableDictionaryCompression": { + "type": "boolean" + }, + "MaxPaddingBytes": { + "type": "integer" + }, + "WriterVersion": {} + } + }, + "OrcSerDe": { + "type": "structure", + "members": { + "StripeSizeBytes": { + "type": "integer" + }, + "BlockSizeBytes": { + "type": "integer" + }, + "RowIndexStride": { + "type": "integer" + }, + "EnablePadding": { + "type": "boolean" + }, + "PaddingTolerance": { + "type": "double" + }, + "Compression": {}, + "BloomFilterColumns": { + "type": "list", + "member": {} + }, + "BloomFilterFalsePositiveProbability": { + "type": "double" + }, + "DictionaryKeyThreshold": { + "type": "double" + }, + "FormatVersion": {} + } + } + } + } + } + }, + "Enabled": { + "type": "boolean" + } + } + }, + "S1o": { + "type": "structure", + "required": [ + "DataTableName" + ], + "members": { + "DataTableName": {}, + "DataTableColumns": {}, + "CopyOptions": {} + } + }, + "S1s": { + "type": "string", + "sensitive": true + }, + "S1t": { + "type": "string", + "sensitive": true + }, + "S1u": { + "type": "structure", + "members": { + "DurationInSeconds": { + "type": "integer" + } + } + }, + "S22": { + "type": "structure", + "members": { + "IntervalInSeconds": { + "type": "integer" + }, + "SizeInMBs": { + "type": "integer" + } + } + }, + "S25": { + "type": "structure", + "members": { + "DurationInSeconds": { + "type": "integer" + } + } + }, + "S2d": { + "type": "structure", + "members": { + "DurationInSeconds": { + "type": "integer" + } + } + }, + "S2g": { + "type": "list", + "member": { + "shape": "S2h" + } + }, + "S2h": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + }, + "S33": { + "type": "structure", + "required": [ + "RoleARN", + "BucketARN", + "BufferingHints", + "CompressionFormat", + "EncryptionConfiguration" + ], + "members": { + "RoleARN": {}, + "BucketARN": {}, + "Prefix": {}, + "ErrorOutputPrefix": {}, + "BufferingHints": { + "shape": "Sb" + }, + "CompressionFormat": {}, + "EncryptionConfiguration": { + "shape": "Sf" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + }, + "S3h": { + "type": "structure", + "required": [ + "Data" + ], + "members": { + "Data": { + "type": "blob" + } + } + }, + "S42": { + "type": "structure", + "members": { + "RoleARN": {}, + "BucketARN": {}, + "Prefix": {}, + "ErrorOutputPrefix": {}, + "BufferingHints": { + "shape": "Sb" + }, + "CompressionFormat": {}, + "EncryptionConfiguration": { + "shape": "Sf" + }, + "CloudWatchLoggingOptions": { + "shape": "Sj" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/firehose-2015-08-04.paginators.json b/node_modules/aws-sdk/apis/firehose-2015-08-04.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/firehose-2015-08-04.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/fms-2018-01-01.examples.json b/node_modules/aws-sdk/apis/fms-2018-01-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/fms-2018-01-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/fms-2018-01-01.min.json b/node_modules/aws-sdk/apis/fms-2018-01-01.min.json new file mode 100644 index 0000000..aabbba9 --- /dev/null +++ b/node_modules/aws-sdk/apis/fms-2018-01-01.min.json @@ -0,0 +1,390 @@ +{ + "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": { + "input": { + "type": "structure", + "required": [ + "AdminAccount" + ], + "members": { + "AdminAccount": {} + } + } + }, + "DeleteNotificationChannel": { + "input": { + "type": "structure", + "members": {} + } + }, + "DeletePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {}, + "DeleteAllPolicyResources": { + "type": "boolean" + } + } + } + }, + "DisassociateAdminAccount": { + "input": { + "type": "structure", + "members": {} + } + }, + "GetAdminAccount": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AdminAccount": {}, + "RoleStatus": {} + } + } + }, + "GetComplianceDetail": { + "input": { + "type": "structure", + "required": [ + "PolicyId", + "MemberAccount" + ], + "members": { + "PolicyId": {}, + "MemberAccount": {} + } + }, + "output": { + "type": "structure", + "members": { + "PolicyComplianceDetail": { + "type": "structure", + "members": { + "PolicyOwner": {}, + "PolicyId": {}, + "MemberAccount": {}, + "Violators": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceId": {}, + "ViolationReason": {}, + "ResourceType": {} + } + } + }, + "EvaluationLimitExceeded": { + "type": "boolean" + }, + "ExpiredAt": { + "type": "timestamp" + }, + "IssueInfoMap": { + "shape": "Sk" + } + } + } + } + } + }, + "GetNotificationChannel": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "SnsTopicArn": {}, + "SnsRoleName": {} + } + } + }, + "GetPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Policy": { + "shape": "Ss" + }, + "PolicyArn": {} + } + } + }, + "GetProtectionStatus": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {}, + "MemberAccountId": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AdminAccountId": {}, + "ServiceType": {}, + "Data": {}, + "NextToken": {} + } + } + }, + "ListComplianceStatus": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PolicyComplianceStatusList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyOwner": {}, + "PolicyId": {}, + "PolicyName": {}, + "MemberAccount": {}, + "EvaluationResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ComplianceStatus": {}, + "ViolatorCount": { + "type": "long" + }, + "EvaluationLimitExceeded": { + "type": "boolean" + } + } + } + }, + "LastUpdated": { + "type": "timestamp" + }, + "IssueInfoMap": { + "shape": "Sk" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListMemberAccounts": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "MemberAccounts": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListPolicies": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PolicyList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyArn": {}, + "PolicyId": {}, + "PolicyName": {}, + "ResourceType": {}, + "SecurityServiceType": {}, + "RemediationEnabled": { + "type": "boolean" + } + } + } + }, + "NextToken": {} + } + } + }, + "PutNotificationChannel": { + "input": { + "type": "structure", + "required": [ + "SnsTopicArn", + "SnsRoleName" + ], + "members": { + "SnsTopicArn": {}, + "SnsRoleName": {} + } + } + }, + "PutPolicy": { + "input": { + "type": "structure", + "required": [ + "Policy" + ], + "members": { + "Policy": { + "shape": "Ss" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": { + "shape": "Ss" + }, + "PolicyArn": {} + } + } + } + }, + "shapes": { + "Sk": { + "type": "map", + "key": {}, + "value": {} + }, + "Ss": { + "type": "structure", + "required": [ + "PolicyName", + "SecurityServicePolicyData", + "ResourceType", + "ExcludeResourceTags", + "RemediationEnabled" + ], + "members": { + "PolicyId": {}, + "PolicyName": {}, + "PolicyUpdateToken": {}, + "SecurityServicePolicyData": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "ManagedServiceData": {} + } + }, + "ResourceType": {}, + "ResourceTypeList": { + "type": "list", + "member": {} + }, + "ResourceTags": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "ExcludeResourceTags": { + "type": "boolean" + }, + "RemediationEnabled": { + "type": "boolean" + }, + "IncludeMap": { + "shape": "S13" + }, + "ExcludeMap": { + "shape": "S13" + } + } + }, + "S13": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/fms-2018-01-01.paginators.json b/node_modules/aws-sdk/apis/fms-2018-01-01.paginators.json new file mode 100644 index 0000000..7b2fd73 --- /dev/null +++ b/node_modules/aws-sdk/apis/fms-2018-01-01.paginators.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListComplianceStatus": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PolicyComplianceStatusList" + }, + "ListMemberAccounts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "MemberAccounts" + }, + "ListPolicies": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PolicyList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/fsx-2018-03-01.examples.json b/node_modules/aws-sdk/apis/fsx-2018-03-01.examples.json new file mode 100644 index 0000000..90ed818 --- /dev/null +++ b/node_modules/aws-sdk/apis/fsx-2018-03-01.examples.json @@ -0,0 +1,384 @@ +{ + "version": "1.0", + "examples": { + "CreateBackup": [ + { + "input": { + "FileSystemId": "fs-0498eed5fe91001ec", + "Tags": [ + { + "Key": "Name", + "Value": "MyBackup" + } + ] + }, + "output": { + "Backup": { + "BackupId": "backup-03e3c82e0183b7b6b", + "CreationTime": "1481841524.0", + "FileSystem": { + "FileSystemId": "fs-0498eed5fe91001ec", + "OwnerId": "012345678912", + "StorageCapacity": 300, + "WindowsConfiguration": { + "ActiveDirectoryId": "d-1234abcd12", + "AutomaticBackupRetentionDays": 30, + "DailyAutomaticBackupStartTime": "05:00", + "WeeklyMaintenanceStartTime": "1:05:00" + } + }, + "Lifecycle": "CREATING", + "ProgressPercent": 0, + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b", + "Tags": [ + { + "Key": "Name", + "Value": "MyBackup" + } + ], + "Type": "USER_INITIATED" + } + }, + "comments": { + }, + "description": "This operation creates a new backup.", + "id": "to-create-a-new-backup-1481840798597", + "title": "To create a new backup" + } + ], + "CreateFileSystem": [ + { + "input": { + "ClientRequestToken": "a8ca07e4-61ec-4399-99f4-19853801bcd5", + "FileSystemType": "WINDOWS", + "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", + "SecurityGroupIds": [ + "sg-edcd9784" + ], + "StorageCapacity": 300, + "SubnetIds": [ + "subnet-1234abcd" + ], + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ], + "WindowsConfiguration": { + "ActiveDirectoryId": "d-1234abcd12", + "AutomaticBackupRetentionDays": 30, + "DailyAutomaticBackupStartTime": "05:00", + "ThroughputCapacity": 8, + "WeeklyMaintenanceStartTime": "1:05:00" + } + }, + "output": { + "FileSystem": { + "CreationTime": "1481841524.0", + "DNSName": "fs-0498eed5fe91001ec.fsx.com", + "FileSystemId": "fs-0498eed5fe91001ec", + "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", + "Lifecycle": "CREATING", + "OwnerId": "012345678912", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "StorageCapacity": 300, + "SubnetIds": [ + "subnet-1234abcd" + ], + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ], + "VpcId": "vpc-ab1234cd", + "WindowsConfiguration": { + "ActiveDirectoryId": "d-1234abcd12", + "AutomaticBackupRetentionDays": 30, + "DailyAutomaticBackupStartTime": "05:00", + "ThroughputCapacity": 8, + "WeeklyMaintenanceStartTime": "1:05:00" + } + } + }, + "comments": { + }, + "description": "This operation creates a new file system.", + "id": "to-create-a-new-file-system-1481840798547", + "title": "To create a new file system" + } + ], + "CreateFileSystemFromBackup": [ + { + "input": { + "BackupId": "backup-03e3c82e0183b7b6b", + "ClientRequestToken": "f4c94ed7-238d-4c46-93db-48cd62ec33b7", + "SecurityGroupIds": [ + "sg-edcd9784" + ], + "SubnetIds": [ + "subnet-1234abcd" + ], + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ], + "WindowsConfiguration": { + "ThroughputCapacity": 8 + } + }, + "output": { + "FileSystem": { + "CreationTime": "1481841524.0", + "DNSName": "fs-0498eed5fe91001ec.fsx.com", + "FileSystemId": "fs-0498eed5fe91001ec", + "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", + "Lifecycle": "CREATING", + "OwnerId": "012345678912", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "StorageCapacity": 300, + "SubnetIds": [ + "subnet-1234abcd" + ], + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ], + "VpcId": "vpc-ab1234cd", + "WindowsConfiguration": { + "ActiveDirectoryId": "d-1234abcd12", + "AutomaticBackupRetentionDays": 30, + "DailyAutomaticBackupStartTime": "05:00", + "ThroughputCapacity": 8, + "WeeklyMaintenanceStartTime": "1:05:00" + } + } + }, + "comments": { + }, + "description": "This operation creates a new file system from backup.", + "id": "to-create-a-new-file-system-from-backup-1481840798598", + "title": "To create a new file system from backup" + } + ], + "DeleteBackup": [ + { + "input": { + "BackupId": "backup-03e3c82e0183b7b6b" + }, + "output": { + "BackupId": "backup-03e3c82e0183b7b6b", + "Lifecycle": "DELETED" + }, + "comments": { + }, + "description": "This operation deletes an Amazon FSx file system backup.", + "id": "to-delete-a-file-system-1481847318399", + "title": "To delete a backup" + } + ], + "DeleteFileSystem": [ + { + "input": { + "FileSystemId": "fs-0498eed5fe91001ec" + }, + "output": { + "FileSystemId": "fs-0498eed5fe91001ec", + "Lifecycle": "DELETING" + }, + "comments": { + }, + "description": "This operation deletes an Amazon FSx file system.", + "id": "to-delete-a-file-system-1481847318348", + "title": "To delete a file system" + } + ], + "DescribeBackups": [ + { + "input": { + }, + "output": { + "Backups": [ + { + "BackupId": "backup-03e3c82e0183b7b6b", + "CreationTime": "1481841524.0", + "FileSystem": { + "FileSystemId": "fs-0498eed5fe91001ec", + "OwnerId": "012345678912", + "StorageCapacity": 300, + "WindowsConfiguration": { + "ActiveDirectoryId": "d-1234abcd12", + "AutomaticBackupRetentionDays": 30, + "DailyAutomaticBackupStartTime": "05:00", + "WeeklyMaintenanceStartTime": "1:05:00" + } + }, + "Lifecycle": "AVAILABLE", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b", + "Tags": [ + { + "Key": "Name", + "Value": "MyBackup" + } + ], + "Type": "USER_INITIATED" + } + ] + }, + "comments": { + }, + "description": "This operation describes all of the Amazon FSx backups in an account.", + "id": "to-describe-backups-1481848448499", + "title": "To describe Amazon FSx backups" + } + ], + "DescribeFileSystems": [ + { + "input": { + }, + "output": { + "FileSystems": [ + { + "CreationTime": "1481841524.0", + "DNSName": "fs-0498eed5fe91001ec.fsx.com", + "FileSystemId": "fs-0498eed5fe91001ec", + "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", + "Lifecycle": "AVAILABLE", + "NetworkInterfaceIds": [ + "eni-abcd1234" + ], + "OwnerId": "012345678912", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "StorageCapacity": 300, + "SubnetIds": [ + "subnet-1234abcd" + ], + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ], + "VpcId": "vpc-ab1234cd", + "WindowsConfiguration": { + "ActiveDirectoryId": "d-1234abcd12", + "AutomaticBackupRetentionDays": 30, + "DailyAutomaticBackupStartTime": "05:00", + "ThroughputCapacity": 8, + "WeeklyMaintenanceStartTime": "1:05:00" + } + } + ] + }, + "comments": { + }, + "description": "This operation describes all of the Amazon FSx file systems in an account.", + "id": "to-describe-a-file-systems-1481848448460", + "title": "To describe an Amazon FSx file system" + } + ], + "ListTagsForResource": [ + { + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec" + }, + "output": { + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "comments": { + }, + "description": "This operation lists tags for an Amazon FSx resource.", + "id": "to-list-tags-for-a-fsx-resource-1481847318372", + "title": "To list tags for a resource" + } + ], + "TagResource": [ + { + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "comments": { + }, + "description": "This operation tags an Amazon FSx resource.", + "id": "to-tag-a-fsx-resource-1481847318371", + "title": "To tag a resource" + } + ], + "UntagResource": [ + { + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "TagKeys": [ + "Name" + ] + }, + "comments": { + }, + "description": "This operation untags an Amazon FSx resource.", + "id": "to-untag-a-fsx-resource-1481847318373", + "title": "To untag a resource" + } + ], + "UpdateFileSystem": [ + { + "input": { + "FileSystemId": "fs-0498eed5fe91001ec", + "WindowsConfiguration": { + "AutomaticBackupRetentionDays": 10, + "DailyAutomaticBackupStartTime": "06:00", + "WeeklyMaintenanceStartTime": "3:06:00" + } + }, + "output": { + "FileSystem": { + "CreationTime": "1481841524.0", + "DNSName": "fs-0498eed5fe91001ec.fsx.com", + "FileSystemId": "fs-0498eed5fe91001ec", + "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", + "Lifecycle": "AVAILABLE", + "OwnerId": "012345678912", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "StorageCapacity": 300, + "SubnetIds": [ + "subnet-1234abcd" + ], + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ], + "VpcId": "vpc-ab1234cd", + "WindowsConfiguration": { + "AutomaticBackupRetentionDays": 10, + "DailyAutomaticBackupStartTime": "06:00", + "ThroughputCapacity": 8, + "WeeklyMaintenanceStartTime": "3:06:00" + } + } + }, + "comments": { + }, + "description": "This operation updates an existing file system.", + "id": "to-update-a-file-system-1481840798595", + "title": "To update an existing file system" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json b/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json new file mode 100644 index 0000000..873ca8d --- /dev/null +++ b/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json @@ -0,0 +1,509 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-03-01", + "endpointPrefix": "fsx", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon FSx", + "serviceId": "FSx", + "signatureVersion": "v4", + "targetPrefix": "AWSSimbaAPIService_v20180301", + "uid": "fsx-2018-03-01" + }, + "operations": { + "CreateBackup": { + "input": { + "type": "structure", + "required": [ + "FileSystemId" + ], + "members": { + "FileSystemId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "Backup": { + "shape": "S9" + } + } + }, + "idempotent": true + }, + "CreateFileSystem": { + "input": { + "type": "structure", + "required": [ + "FileSystemType", + "StorageCapacity", + "SubnetIds" + ], + "members": { + "ClientRequestToken": { + "idempotencyToken": true + }, + "FileSystemType": {}, + "StorageCapacity": { + "type": "integer" + }, + "SubnetIds": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "S19" + }, + "Tags": { + "shape": "S4" + }, + "KmsKeyId": {}, + "WindowsConfiguration": { + "shape": "S1b" + }, + "LustreConfiguration": { + "type": "structure", + "members": { + "WeeklyMaintenanceStartTime": {}, + "ImportPath": {}, + "ExportPath": {}, + "ImportedFileChunkSize": { + "type": "integer" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FileSystem": { + "shape": "Sj" + } + } + } + }, + "CreateFileSystemFromBackup": { + "input": { + "type": "structure", + "required": [ + "BackupId", + "SubnetIds" + ], + "members": { + "BackupId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "SubnetIds": { + "shape": "Sq" + }, + "SecurityGroupIds": { + "shape": "S19" + }, + "Tags": { + "shape": "S4" + }, + "WindowsConfiguration": { + "shape": "S1b" + } + } + }, + "output": { + "type": "structure", + "members": { + "FileSystem": { + "shape": "Sj" + } + } + } + }, + "DeleteBackup": { + "input": { + "type": "structure", + "required": [ + "BackupId" + ], + "members": { + "BackupId": {}, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "BackupId": {}, + "Lifecycle": {} + } + }, + "idempotent": true + }, + "DeleteFileSystem": { + "input": { + "type": "structure", + "required": [ + "FileSystemId" + ], + "members": { + "FileSystemId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "WindowsConfiguration": { + "type": "structure", + "members": { + "SkipFinalBackup": { + "type": "boolean" + }, + "FinalBackupTags": { + "shape": "S4" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FileSystemId": {}, + "Lifecycle": {}, + "WindowsResponse": { + "type": "structure", + "members": { + "FinalBackupId": {}, + "FinalBackupTags": { + "shape": "S4" + } + } + } + } + }, + "idempotent": true + }, + "DescribeBackups": { + "input": { + "type": "structure", + "members": { + "BackupIds": { + "type": "list", + "member": {} + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Backups": { + "type": "list", + "member": { + "shape": "S9" + } + }, + "NextToken": {} + } + } + }, + "DescribeFileSystems": { + "input": { + "type": "structure", + "members": { + "FileSystemIds": { + "type": "list", + "member": {} + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FileSystems": { + "type": "list", + "member": { + "shape": "Sj" + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S4" + }, + "NextToken": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "Tags" + ], + "members": { + "ResourceARN": {}, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "TagKeys" + ], + "members": { + "ResourceARN": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateFileSystem": { + "input": { + "type": "structure", + "required": [ + "FileSystemId" + ], + "members": { + "FileSystemId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "WindowsConfiguration": { + "type": "structure", + "members": { + "WeeklyMaintenanceStartTime": {}, + "DailyAutomaticBackupStartTime": {}, + "AutomaticBackupRetentionDays": { + "type": "integer" + } + } + }, + "LustreConfiguration": { + "type": "structure", + "members": { + "WeeklyMaintenanceStartTime": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FileSystem": { + "shape": "Sj" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S9": { + "type": "structure", + "required": [ + "BackupId", + "Lifecycle", + "Type", + "CreationTime", + "FileSystem" + ], + "members": { + "BackupId": {}, + "Lifecycle": {}, + "FailureDetails": { + "type": "structure", + "members": { + "Message": {} + } + }, + "Type": {}, + "ProgressPercent": { + "type": "integer" + }, + "CreationTime": { + "type": "timestamp" + }, + "KmsKeyId": {}, + "ResourceARN": {}, + "Tags": { + "shape": "S4" + }, + "FileSystem": { + "shape": "Sj" + } + } + }, + "Sj": { + "type": "structure", + "members": { + "OwnerId": {}, + "CreationTime": { + "type": "timestamp" + }, + "FileSystemId": {}, + "FileSystemType": {}, + "Lifecycle": {}, + "FailureDetails": { + "type": "structure", + "members": { + "Message": {} + } + }, + "StorageCapacity": { + "type": "integer" + }, + "VpcId": {}, + "SubnetIds": { + "shape": "Sq" + }, + "NetworkInterfaceIds": { + "type": "list", + "member": {} + }, + "DNSName": {}, + "KmsKeyId": {}, + "ResourceARN": {}, + "Tags": { + "shape": "S4" + }, + "WindowsConfiguration": { + "type": "structure", + "members": { + "ActiveDirectoryId": {}, + "ThroughputCapacity": { + "type": "integer" + }, + "MaintenanceOperationsInProgress": { + "type": "list", + "member": {} + }, + "WeeklyMaintenanceStartTime": {}, + "DailyAutomaticBackupStartTime": {}, + "AutomaticBackupRetentionDays": { + "type": "integer" + }, + "CopyTagsToBackups": { + "type": "boolean" + } + } + }, + "LustreConfiguration": { + "type": "structure", + "members": { + "WeeklyMaintenanceStartTime": {}, + "DataRepositoryConfiguration": { + "type": "structure", + "members": { + "ImportPath": {}, + "ExportPath": {}, + "ImportedFileChunkSize": { + "type": "integer" + } + } + } + } + } + } + }, + "Sq": { + "type": "list", + "member": {} + }, + "S19": { + "type": "list", + "member": {} + }, + "S1b": { + "type": "structure", + "required": [ + "ThroughputCapacity" + ], + "members": { + "ActiveDirectoryId": {}, + "ThroughputCapacity": { + "type": "integer" + }, + "WeeklyMaintenanceStartTime": {}, + "DailyAutomaticBackupStartTime": {}, + "AutomaticBackupRetentionDays": { + "type": "integer" + }, + "CopyTagsToBackups": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/fsx-2018-03-01.paginators.json b/node_modules/aws-sdk/apis/fsx-2018-03-01.paginators.json new file mode 100644 index 0000000..912e2f2 --- /dev/null +++ b/node_modules/aws-sdk/apis/fsx-2018-03-01.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "DescribeBackups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "DescribeFileSystems": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/gamelift-2015-10-01.examples.json b/node_modules/aws-sdk/apis/gamelift-2015-10-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/gamelift-2015-10-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/gamelift-2015-10-01.min.json b/node_modules/aws-sdk/apis/gamelift-2015-10-01.min.json new file mode 100644 index 0000000..b1aa4c9 --- /dev/null +++ b/node_modules/aws-sdk/apis/gamelift-2015-10-01.min.json @@ -0,0 +1,2370 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-10-01", + "endpointPrefix": "gamelift", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon GameLift", + "serviceId": "GameLift", + "signatureVersion": "v4", + "targetPrefix": "GameLift", + "uid": "gamelift-2015-10-01" + }, + "operations": { + "AcceptMatch": { + "input": { + "type": "structure", + "required": [ + "TicketId", + "PlayerIds", + "AcceptanceType" + ], + "members": { + "TicketId": {}, + "PlayerIds": { + "shape": "S3" + }, + "AcceptanceType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateAlias": { + "input": { + "type": "structure", + "required": [ + "Name", + "RoutingStrategy" + ], + "members": { + "Name": {}, + "Description": {}, + "RoutingStrategy": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "Alias": { + "shape": "Se" + } + } + } + }, + "CreateBuild": { + "input": { + "type": "structure", + "members": { + "Name": {}, + "Version": {}, + "StorageLocation": { + "shape": "Sj" + }, + "OperatingSystem": {} + } + }, + "output": { + "type": "structure", + "members": { + "Build": { + "shape": "Sn" + }, + "UploadCredentials": { + "shape": "Sr" + }, + "StorageLocation": { + "shape": "Sj" + } + } + } + }, + "CreateFleet": { + "input": { + "type": "structure", + "required": [ + "Name", + "EC2InstanceType" + ], + "members": { + "Name": {}, + "Description": {}, + "BuildId": {}, + "ScriptId": {}, + "ServerLaunchPath": {}, + "ServerLaunchParameters": {}, + "LogPaths": { + "shape": "S3" + }, + "EC2InstanceType": {}, + "EC2InboundPermissions": { + "shape": "Sv" + }, + "NewGameSessionProtectionPolicy": {}, + "RuntimeConfiguration": { + "shape": "S11" + }, + "ResourceCreationLimitPolicy": { + "shape": "S17" + }, + "MetricGroups": { + "shape": "S19" + }, + "PeerVpcAwsAccountId": {}, + "PeerVpcId": {}, + "FleetType": {}, + "InstanceRoleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "FleetAttributes": { + "shape": "S1d" + } + } + } + }, + "CreateGameSession": { + "input": { + "type": "structure", + "required": [ + "MaximumPlayerSessionCount" + ], + "members": { + "FleetId": {}, + "AliasId": {}, + "MaximumPlayerSessionCount": { + "type": "integer" + }, + "Name": {}, + "GameProperties": { + "shape": "S1i" + }, + "CreatorId": {}, + "GameSessionId": {}, + "IdempotencyToken": {}, + "GameSessionData": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSession": { + "shape": "S1p" + } + } + } + }, + "CreateGameSessionQueue": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "TimeoutInSeconds": { + "type": "integer" + }, + "PlayerLatencyPolicies": { + "shape": "S1x" + }, + "Destinations": { + "shape": "S1z" + } + } + }, + "output": { + "type": "structure", + "members": { + "GameSessionQueue": { + "shape": "S22" + } + } + } + }, + "CreateMatchmakingConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name", + "GameSessionQueueArns", + "RequestTimeoutSeconds", + "AcceptanceRequired", + "RuleSetName" + ], + "members": { + "Name": {}, + "Description": {}, + "GameSessionQueueArns": { + "shape": "S24" + }, + "RequestTimeoutSeconds": { + "type": "integer" + }, + "AcceptanceTimeoutSeconds": { + "type": "integer" + }, + "AcceptanceRequired": { + "type": "boolean" + }, + "RuleSetName": {}, + "NotificationTarget": {}, + "AdditionalPlayerCount": { + "type": "integer" + }, + "CustomEventData": {}, + "GameProperties": { + "shape": "S1i" + }, + "GameSessionData": {} + } + }, + "output": { + "type": "structure", + "members": { + "Configuration": { + "shape": "S2b" + } + } + } + }, + "CreateMatchmakingRuleSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "RuleSetBody" + ], + "members": { + "Name": {}, + "RuleSetBody": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RuleSet" + ], + "members": { + "RuleSet": { + "shape": "S2f" + } + } + } + }, + "CreatePlayerSession": { + "input": { + "type": "structure", + "required": [ + "GameSessionId", + "PlayerId" + ], + "members": { + "GameSessionId": {}, + "PlayerId": {}, + "PlayerData": {} + } + }, + "output": { + "type": "structure", + "members": { + "PlayerSession": { + "shape": "S2j" + } + } + } + }, + "CreatePlayerSessions": { + "input": { + "type": "structure", + "required": [ + "GameSessionId", + "PlayerIds" + ], + "members": { + "GameSessionId": {}, + "PlayerIds": { + "type": "list", + "member": {} + }, + "PlayerDataMap": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "PlayerSessions": { + "shape": "S2q" + } + } + } + }, + "CreateScript": { + "input": { + "type": "structure", + "members": { + "Name": {}, + "Version": {}, + "StorageLocation": { + "shape": "Sj" + }, + "ZipFile": { + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "members": { + "Script": { + "shape": "S2u" + } + } + } + }, + "CreateVpcPeeringAuthorization": { + "input": { + "type": "structure", + "required": [ + "GameLiftAwsAccountId", + "PeerVpcId" + ], + "members": { + "GameLiftAwsAccountId": {}, + "PeerVpcId": {} + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringAuthorization": { + "shape": "S2x" + } + } + } + }, + "CreateVpcPeeringConnection": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "PeerVpcAwsAccountId", + "PeerVpcId" + ], + "members": { + "FleetId": {}, + "PeerVpcAwsAccountId": {}, + "PeerVpcId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteAlias": { + "input": { + "type": "structure", + "required": [ + "AliasId" + ], + "members": { + "AliasId": {} + } + } + }, + "DeleteBuild": { + "input": { + "type": "structure", + "required": [ + "BuildId" + ], + "members": { + "BuildId": {} + } + } + }, + "DeleteFleet": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {} + } + } + }, + "DeleteGameSessionQueue": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteMatchmakingConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteMatchmakingRuleSet": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "Name", + "FleetId" + ], + "members": { + "Name": {}, + "FleetId": {} + } + } + }, + "DeleteScript": { + "input": { + "type": "structure", + "required": [ + "ScriptId" + ], + "members": { + "ScriptId": {} + } + } + }, + "DeleteVpcPeeringAuthorization": { + "input": { + "type": "structure", + "required": [ + "GameLiftAwsAccountId", + "PeerVpcId" + ], + "members": { + "GameLiftAwsAccountId": {}, + "PeerVpcId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteVpcPeeringConnection": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "VpcPeeringConnectionId" + ], + "members": { + "FleetId": {}, + "VpcPeeringConnectionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeAlias": { + "input": { + "type": "structure", + "required": [ + "AliasId" + ], + "members": { + "AliasId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Alias": { + "shape": "Se" + } + } + } + }, + "DescribeBuild": { + "input": { + "type": "structure", + "required": [ + "BuildId" + ], + "members": { + "BuildId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Build": { + "shape": "Sn" + } + } + } + }, + "DescribeEC2InstanceLimits": { + "input": { + "type": "structure", + "members": { + "EC2InstanceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "EC2InstanceLimits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EC2InstanceType": {}, + "CurrentInstances": { + "type": "integer" + }, + "InstanceLimit": { + "type": "integer" + } + } + } + } + } + } + }, + "DescribeFleetAttributes": { + "input": { + "type": "structure", + "members": { + "FleetIds": { + "shape": "S3o" + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FleetAttributes": { + "type": "list", + "member": { + "shape": "S1d" + } + }, + "NextToken": {} + } + } + }, + "DescribeFleetCapacity": { + "input": { + "type": "structure", + "members": { + "FleetIds": { + "shape": "S3o" + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FleetCapacity": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FleetId": {}, + "InstanceType": {}, + "InstanceCounts": { + "type": "structure", + "members": { + "DESIRED": { + "type": "integer" + }, + "MINIMUM": { + "type": "integer" + }, + "MAXIMUM": { + "type": "integer" + }, + "PENDING": { + "type": "integer" + }, + "ACTIVE": { + "type": "integer" + }, + "IDLE": { + "type": "integer" + }, + "TERMINATING": { + "type": "integer" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeFleetEvents": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventId": {}, + "ResourceId": {}, + "EventCode": {}, + "Message": {}, + "EventTime": { + "type": "timestamp" + }, + "PreSignedLogUrl": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeFleetPortSettings": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "InboundPermissions": { + "shape": "Sv" + } + } + } + }, + "DescribeFleetUtilization": { + "input": { + "type": "structure", + "members": { + "FleetIds": { + "shape": "S3o" + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FleetUtilization": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FleetId": {}, + "ActiveServerProcessCount": { + "type": "integer" + }, + "ActiveGameSessionCount": { + "type": "integer" + }, + "CurrentPlayerSessionCount": { + "type": "integer" + }, + "MaximumPlayerSessionCount": { + "type": "integer" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeGameSessionDetails": { + "input": { + "type": "structure", + "members": { + "FleetId": {}, + "GameSessionId": {}, + "AliasId": {}, + "StatusFilter": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSessionDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GameSession": { + "shape": "S1p" + }, + "ProtectionPolicy": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeGameSessionPlacement": { + "input": { + "type": "structure", + "required": [ + "PlacementId" + ], + "members": { + "PlacementId": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSessionPlacement": { + "shape": "S4d" + } + } + } + }, + "DescribeGameSessionQueues": { + "input": { + "type": "structure", + "members": { + "Names": { + "type": "list", + "member": {} + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSessionQueues": { + "type": "list", + "member": { + "shape": "S22" + } + }, + "NextToken": {} + } + } + }, + "DescribeGameSessions": { + "input": { + "type": "structure", + "members": { + "FleetId": {}, + "GameSessionId": {}, + "AliasId": {}, + "StatusFilter": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSessions": { + "shape": "S4q" + }, + "NextToken": {} + } + } + }, + "DescribeInstances": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {}, + "InstanceId": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FleetId": {}, + "InstanceId": {}, + "IpAddress": {}, + "OperatingSystem": {}, + "Type": {}, + "Status": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMatchmaking": { + "input": { + "type": "structure", + "required": [ + "TicketIds" + ], + "members": { + "TicketIds": { + "shape": "S4y" + } + } + }, + "output": { + "type": "structure", + "members": { + "TicketList": { + "type": "list", + "member": { + "shape": "S51" + } + } + } + } + }, + "DescribeMatchmakingConfigurations": { + "input": { + "type": "structure", + "members": { + "Names": { + "shape": "S4y" + }, + "RuleSetName": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Configurations": { + "type": "list", + "member": { + "shape": "S2b" + } + }, + "NextToken": {} + } + } + }, + "DescribeMatchmakingRuleSets": { + "input": { + "type": "structure", + "members": { + "Names": { + "type": "list", + "member": {} + }, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RuleSets" + ], + "members": { + "RuleSets": { + "type": "list", + "member": { + "shape": "S2f" + } + }, + "NextToken": {} + } + } + }, + "DescribePlayerSessions": { + "input": { + "type": "structure", + "members": { + "GameSessionId": {}, + "PlayerId": {}, + "PlayerSessionId": {}, + "PlayerSessionStatusFilter": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "PlayerSessions": { + "shape": "S2q" + }, + "NextToken": {} + } + } + }, + "DescribeRuntimeConfiguration": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RuntimeConfiguration": { + "shape": "S11" + } + } + } + }, + "DescribeScalingPolicies": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {}, + "StatusFilter": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScalingPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FleetId": {}, + "Name": {}, + "Status": {}, + "ScalingAdjustment": { + "type": "integer" + }, + "ScalingAdjustmentType": {}, + "ComparisonOperator": {}, + "Threshold": { + "type": "double" + }, + "EvaluationPeriods": { + "type": "integer" + }, + "MetricName": {}, + "PolicyType": {}, + "TargetConfiguration": { + "shape": "S61" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeScript": { + "input": { + "type": "structure", + "required": [ + "ScriptId" + ], + "members": { + "ScriptId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Script": { + "shape": "S2u" + } + } + } + }, + "DescribeVpcPeeringAuthorizations": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringAuthorizations": { + "type": "list", + "member": { + "shape": "S2x" + } + } + } + } + }, + "DescribeVpcPeeringConnections": { + "input": { + "type": "structure", + "members": { + "FleetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringConnections": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FleetId": {}, + "IpV4CidrBlock": {}, + "VpcPeeringConnectionId": {}, + "Status": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "PeerVpcId": {}, + "GameLiftVpcId": {} + } + } + } + } + } + }, + "GetGameSessionLogUrl": { + "input": { + "type": "structure", + "required": [ + "GameSessionId" + ], + "members": { + "GameSessionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "PreSignedUrl": {} + } + } + }, + "GetInstanceAccess": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "InstanceId" + ], + "members": { + "FleetId": {}, + "InstanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceAccess": { + "type": "structure", + "members": { + "FleetId": {}, + "InstanceId": {}, + "IpAddress": {}, + "OperatingSystem": {}, + "Credentials": { + "type": "structure", + "members": { + "UserName": {}, + "Secret": {} + }, + "sensitive": true + } + } + } + } + } + }, + "ListAliases": { + "input": { + "type": "structure", + "members": { + "RoutingStrategyType": {}, + "Name": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Aliases": { + "type": "list", + "member": { + "shape": "Se" + } + }, + "NextToken": {} + } + } + }, + "ListBuilds": { + "input": { + "type": "structure", + "members": { + "Status": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Builds": { + "type": "list", + "member": { + "shape": "Sn" + } + }, + "NextToken": {} + } + } + }, + "ListFleets": { + "input": { + "type": "structure", + "members": { + "BuildId": {}, + "ScriptId": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "FleetIds": { + "shape": "S3o" + }, + "NextToken": {} + } + } + }, + "ListScripts": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Scripts": { + "type": "list", + "member": { + "shape": "S2u" + } + }, + "NextToken": {} + } + } + }, + "PutScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "Name", + "FleetId", + "MetricName" + ], + "members": { + "Name": {}, + "FleetId": {}, + "ScalingAdjustment": { + "type": "integer" + }, + "ScalingAdjustmentType": {}, + "Threshold": { + "type": "double" + }, + "ComparisonOperator": {}, + "EvaluationPeriods": { + "type": "integer" + }, + "MetricName": {}, + "PolicyType": {}, + "TargetConfiguration": { + "shape": "S61" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "RequestUploadCredentials": { + "input": { + "type": "structure", + "required": [ + "BuildId" + ], + "members": { + "BuildId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UploadCredentials": { + "shape": "Sr" + }, + "StorageLocation": { + "shape": "Sj" + } + } + } + }, + "ResolveAlias": { + "input": { + "type": "structure", + "required": [ + "AliasId" + ], + "members": { + "AliasId": {} + } + }, + "output": { + "type": "structure", + "members": { + "FleetId": {} + } + } + }, + "SearchGameSessions": { + "input": { + "type": "structure", + "members": { + "FleetId": {}, + "AliasId": {}, + "FilterExpression": {}, + "SortExpression": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSessions": { + "shape": "S4q" + }, + "NextToken": {} + } + } + }, + "StartFleetActions": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "Actions" + ], + "members": { + "FleetId": {}, + "Actions": { + "shape": "S1f" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartGameSessionPlacement": { + "input": { + "type": "structure", + "required": [ + "PlacementId", + "GameSessionQueueName", + "MaximumPlayerSessionCount" + ], + "members": { + "PlacementId": {}, + "GameSessionQueueName": {}, + "GameProperties": { + "shape": "S1i" + }, + "MaximumPlayerSessionCount": { + "type": "integer" + }, + "GameSessionName": {}, + "PlayerLatencies": { + "shape": "S4f" + }, + "DesiredPlayerSessions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlayerId": {}, + "PlayerData": {} + } + } + }, + "GameSessionData": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSessionPlacement": { + "shape": "S4d" + } + } + } + }, + "StartMatchBackfill": { + "input": { + "type": "structure", + "required": [ + "ConfigurationName", + "GameSessionArn", + "Players" + ], + "members": { + "TicketId": {}, + "ConfigurationName": {}, + "GameSessionArn": {}, + "Players": { + "shape": "S54" + } + } + }, + "output": { + "type": "structure", + "members": { + "MatchmakingTicket": { + "shape": "S51" + } + } + } + }, + "StartMatchmaking": { + "input": { + "type": "structure", + "required": [ + "ConfigurationName", + "Players" + ], + "members": { + "TicketId": {}, + "ConfigurationName": {}, + "Players": { + "shape": "S54" + } + } + }, + "output": { + "type": "structure", + "members": { + "MatchmakingTicket": { + "shape": "S51" + } + } + } + }, + "StopFleetActions": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "Actions" + ], + "members": { + "FleetId": {}, + "Actions": { + "shape": "S1f" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopGameSessionPlacement": { + "input": { + "type": "structure", + "required": [ + "PlacementId" + ], + "members": { + "PlacementId": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSessionPlacement": { + "shape": "S4d" + } + } + } + }, + "StopMatchmaking": { + "input": { + "type": "structure", + "required": [ + "TicketId" + ], + "members": { + "TicketId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateAlias": { + "input": { + "type": "structure", + "required": [ + "AliasId" + ], + "members": { + "AliasId": {}, + "Name": {}, + "Description": {}, + "RoutingStrategy": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "Alias": { + "shape": "Se" + } + } + } + }, + "UpdateBuild": { + "input": { + "type": "structure", + "required": [ + "BuildId" + ], + "members": { + "BuildId": {}, + "Name": {}, + "Version": {} + } + }, + "output": { + "type": "structure", + "members": { + "Build": { + "shape": "Sn" + } + } + } + }, + "UpdateFleetAttributes": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {}, + "Name": {}, + "Description": {}, + "NewGameSessionProtectionPolicy": {}, + "ResourceCreationLimitPolicy": { + "shape": "S17" + }, + "MetricGroups": { + "shape": "S19" + } + } + }, + "output": { + "type": "structure", + "members": { + "FleetId": {} + } + } + }, + "UpdateFleetCapacity": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {}, + "DesiredInstances": { + "type": "integer" + }, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FleetId": {} + } + } + }, + "UpdateFleetPortSettings": { + "input": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "FleetId": {}, + "InboundPermissionAuthorizations": { + "shape": "Sv" + }, + "InboundPermissionRevocations": { + "shape": "Sv" + } + } + }, + "output": { + "type": "structure", + "members": { + "FleetId": {} + } + } + }, + "UpdateGameSession": { + "input": { + "type": "structure", + "required": [ + "GameSessionId" + ], + "members": { + "GameSessionId": {}, + "MaximumPlayerSessionCount": { + "type": "integer" + }, + "Name": {}, + "PlayerSessionCreationPolicy": {}, + "ProtectionPolicy": {} + } + }, + "output": { + "type": "structure", + "members": { + "GameSession": { + "shape": "S1p" + } + } + } + }, + "UpdateGameSessionQueue": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "TimeoutInSeconds": { + "type": "integer" + }, + "PlayerLatencyPolicies": { + "shape": "S1x" + }, + "Destinations": { + "shape": "S1z" + } + } + }, + "output": { + "type": "structure", + "members": { + "GameSessionQueue": { + "shape": "S22" + } + } + } + }, + "UpdateMatchmakingConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Description": {}, + "GameSessionQueueArns": { + "shape": "S24" + }, + "RequestTimeoutSeconds": { + "type": "integer" + }, + "AcceptanceTimeoutSeconds": { + "type": "integer" + }, + "AcceptanceRequired": { + "type": "boolean" + }, + "RuleSetName": {}, + "NotificationTarget": {}, + "AdditionalPlayerCount": { + "type": "integer" + }, + "CustomEventData": {}, + "GameProperties": { + "shape": "S1i" + }, + "GameSessionData": {} + } + }, + "output": { + "type": "structure", + "members": { + "Configuration": { + "shape": "S2b" + } + } + } + }, + "UpdateRuntimeConfiguration": { + "input": { + "type": "structure", + "required": [ + "FleetId", + "RuntimeConfiguration" + ], + "members": { + "FleetId": {}, + "RuntimeConfiguration": { + "shape": "S11" + } + } + }, + "output": { + "type": "structure", + "members": { + "RuntimeConfiguration": { + "shape": "S11" + } + } + } + }, + "UpdateScript": { + "input": { + "type": "structure", + "required": [ + "ScriptId" + ], + "members": { + "ScriptId": {}, + "Name": {}, + "Version": {}, + "StorageLocation": { + "shape": "Sj" + }, + "ZipFile": { + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "members": { + "Script": { + "shape": "S2u" + } + } + } + }, + "ValidateMatchmakingRuleSet": { + "input": { + "type": "structure", + "required": [ + "RuleSetBody" + ], + "members": { + "RuleSetBody": {} + } + }, + "output": { + "type": "structure", + "members": { + "Valid": { + "type": "boolean" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": {} + }, + "S9": { + "type": "structure", + "members": { + "Type": {}, + "FleetId": {}, + "Message": {} + } + }, + "Se": { + "type": "structure", + "members": { + "AliasId": {}, + "Name": {}, + "AliasArn": {}, + "Description": {}, + "RoutingStrategy": { + "shape": "S9" + }, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + } + } + }, + "Sj": { + "type": "structure", + "members": { + "Bucket": {}, + "Key": {}, + "RoleArn": {}, + "ObjectVersion": {} + } + }, + "Sn": { + "type": "structure", + "members": { + "BuildId": {}, + "Name": {}, + "Version": {}, + "Status": {}, + "SizeOnDisk": { + "type": "long" + }, + "OperatingSystem": {}, + "CreationTime": { + "type": "timestamp" + } + } + }, + "Sr": { + "type": "structure", + "members": { + "AccessKeyId": {}, + "SecretAccessKey": {}, + "SessionToken": {} + }, + "sensitive": true + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "FromPort", + "ToPort", + "IpRange", + "Protocol" + ], + "members": { + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "IpRange": {}, + "Protocol": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "ServerProcesses": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LaunchPath", + "ConcurrentExecutions" + ], + "members": { + "LaunchPath": {}, + "Parameters": {}, + "ConcurrentExecutions": { + "type": "integer" + } + } + } + }, + "MaxConcurrentGameSessionActivations": { + "type": "integer" + }, + "GameSessionActivationTimeoutSeconds": { + "type": "integer" + } + } + }, + "S17": { + "type": "structure", + "members": { + "NewGameSessionsPerCreator": { + "type": "integer" + }, + "PolicyPeriodInMinutes": { + "type": "integer" + } + } + }, + "S19": { + "type": "list", + "member": {} + }, + "S1d": { + "type": "structure", + "members": { + "FleetId": {}, + "FleetArn": {}, + "FleetType": {}, + "InstanceType": {}, + "Description": {}, + "Name": {}, + "CreationTime": { + "type": "timestamp" + }, + "TerminationTime": { + "type": "timestamp" + }, + "Status": {}, + "BuildId": {}, + "ScriptId": {}, + "ServerLaunchPath": {}, + "ServerLaunchParameters": {}, + "LogPaths": { + "shape": "S3" + }, + "NewGameSessionProtectionPolicy": {}, + "OperatingSystem": {}, + "ResourceCreationLimitPolicy": { + "shape": "S17" + }, + "MetricGroups": { + "shape": "S19" + }, + "StoppedActions": { + "shape": "S1f" + }, + "InstanceRoleArn": {} + } + }, + "S1f": { + "type": "list", + "member": {} + }, + "S1i": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S1p": { + "type": "structure", + "members": { + "GameSessionId": {}, + "Name": {}, + "FleetId": {}, + "CreationTime": { + "type": "timestamp" + }, + "TerminationTime": { + "type": "timestamp" + }, + "CurrentPlayerSessionCount": { + "type": "integer" + }, + "MaximumPlayerSessionCount": { + "type": "integer" + }, + "Status": {}, + "StatusReason": {}, + "GameProperties": { + "shape": "S1i" + }, + "IpAddress": {}, + "Port": { + "type": "integer" + }, + "PlayerSessionCreationPolicy": {}, + "CreatorId": {}, + "GameSessionData": {}, + "MatchmakerData": {} + } + }, + "S1x": { + "type": "list", + "member": { + "type": "structure", + "members": { + "MaximumIndividualPlayerLatencyMilliseconds": { + "type": "integer" + }, + "PolicyDurationSeconds": { + "type": "integer" + } + } + } + }, + "S1z": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DestinationArn": {} + } + } + }, + "S22": { + "type": "structure", + "members": { + "Name": {}, + "GameSessionQueueArn": {}, + "TimeoutInSeconds": { + "type": "integer" + }, + "PlayerLatencyPolicies": { + "shape": "S1x" + }, + "Destinations": { + "shape": "S1z" + } + } + }, + "S24": { + "type": "list", + "member": {} + }, + "S2b": { + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "GameSessionQueueArns": { + "shape": "S24" + }, + "RequestTimeoutSeconds": { + "type": "integer" + }, + "AcceptanceTimeoutSeconds": { + "type": "integer" + }, + "AcceptanceRequired": { + "type": "boolean" + }, + "RuleSetName": {}, + "NotificationTarget": {}, + "AdditionalPlayerCount": { + "type": "integer" + }, + "CustomEventData": {}, + "CreationTime": { + "type": "timestamp" + }, + "GameProperties": { + "shape": "S1i" + }, + "GameSessionData": {} + } + }, + "S2f": { + "type": "structure", + "required": [ + "RuleSetBody" + ], + "members": { + "RuleSetName": {}, + "RuleSetBody": {}, + "CreationTime": { + "type": "timestamp" + } + } + }, + "S2j": { + "type": "structure", + "members": { + "PlayerSessionId": {}, + "PlayerId": {}, + "GameSessionId": {}, + "FleetId": {}, + "CreationTime": { + "type": "timestamp" + }, + "TerminationTime": { + "type": "timestamp" + }, + "Status": {}, + "IpAddress": {}, + "Port": { + "type": "integer" + }, + "PlayerData": {} + } + }, + "S2q": { + "type": "list", + "member": { + "shape": "S2j" + } + }, + "S2u": { + "type": "structure", + "members": { + "ScriptId": {}, + "Name": {}, + "Version": {}, + "SizeOnDisk": { + "type": "long" + }, + "CreationTime": { + "type": "timestamp" + }, + "StorageLocation": { + "shape": "Sj" + } + } + }, + "S2x": { + "type": "structure", + "members": { + "GameLiftAwsAccountId": {}, + "PeerVpcAwsAccountId": {}, + "PeerVpcId": {}, + "CreationTime": { + "type": "timestamp" + }, + "ExpirationTime": { + "type": "timestamp" + } + } + }, + "S3o": { + "type": "list", + "member": {} + }, + "S4d": { + "type": "structure", + "members": { + "PlacementId": {}, + "GameSessionQueueName": {}, + "Status": {}, + "GameProperties": { + "shape": "S1i" + }, + "MaximumPlayerSessionCount": { + "type": "integer" + }, + "GameSessionName": {}, + "GameSessionId": {}, + "GameSessionArn": {}, + "GameSessionRegion": {}, + "PlayerLatencies": { + "shape": "S4f" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "IpAddress": {}, + "Port": { + "type": "integer" + }, + "PlacedPlayerSessions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlayerId": {}, + "PlayerSessionId": {} + } + } + }, + "GameSessionData": {}, + "MatchmakerData": {} + } + }, + "S4f": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlayerId": {}, + "RegionIdentifier": {}, + "LatencyInMilliseconds": { + "type": "float" + } + } + } + }, + "S4q": { + "type": "list", + "member": { + "shape": "S1p" + } + }, + "S4y": { + "type": "list", + "member": {} + }, + "S51": { + "type": "structure", + "members": { + "TicketId": {}, + "ConfigurationName": {}, + "Status": {}, + "StatusReason": {}, + "StatusMessage": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Players": { + "shape": "S54" + }, + "GameSessionConnectionInfo": { + "type": "structure", + "members": { + "GameSessionArn": {}, + "IpAddress": {}, + "Port": { + "type": "integer" + }, + "MatchedPlayerSessions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlayerId": {}, + "PlayerSessionId": {} + } + } + } + } + }, + "EstimatedWaitTime": { + "type": "integer" + } + } + }, + "S54": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlayerId": {}, + "PlayerAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "S": {}, + "N": { + "type": "double" + }, + "SL": { + "shape": "S3" + }, + "SDM": { + "type": "map", + "key": {}, + "value": { + "type": "double" + } + } + } + } + }, + "Team": {}, + "LatencyInMs": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + } + }, + "S61": { + "type": "structure", + "required": [ + "TargetValue" + ], + "members": { + "TargetValue": { + "type": "double" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/gamelift-2015-10-01.paginators.json b/node_modules/aws-sdk/apis/gamelift-2015-10-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/gamelift-2015-10-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/glacier-2012-06-01.examples.json b/node_modules/aws-sdk/apis/glacier-2012-06-01.examples.json new file mode 100644 index 0000000..7ecea25 --- /dev/null +++ b/node_modules/aws-sdk/apis/glacier-2012-06-01.examples.json @@ -0,0 +1,806 @@ +{ + "version": "1.0", + "examples": { + "AbortMultipartUpload": [ + { + "input": { + "accountId": "-", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "vaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes an in-progress multipart upload to a vault named my-vault:", + "id": "f3d907f6-e71c-420c-8f71-502346a2c48a", + "title": "To abort a multipart upload identified by the upload ID" + } + ], + "AbortVaultLock": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.", + "id": "to-abort-a-vault-lock-1481839357947", + "title": "To abort a vault lock" + } + ], + "AddTagsToVault": [ + { + "input": { + "Tags": { + "examplekey1": "examplevalue1", + "examplekey2": "examplevalue2" + }, + "accountId": "-", + "vaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example adds two tags to a my-vault.", + "id": "add-tags-to-vault-post-tags-add-1481663457694", + "title": "To add tags to a vault" + } + ], + "CompleteMultipartUpload": [ + { + "input": { + "accountId": "-", + "archiveSize": "3145728", + "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "vaultName": "my-vault" + }, + "output": { + "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId", + "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "location": "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example completes a multipart upload for a 3 MiB archive.", + "id": "272aa0b8-e44c-4a64-add2-ad905a37984d", + "title": "To complete a multipart upload" + } + ], + "CompleteVaultLock": [ + { + "input": { + "accountId": "-", + "lockId": "AE863rKkWZU53SLW5be4DUcW", + "vaultName": "example-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.", + "id": "to-complete-a-vault-lock-1481839721312", + "title": "To complete a vault lock" + } + ], + "CreateVault": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "location": "/111122223333/vaults/my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a new vault named my-vault.", + "id": "1dc0313d-ace1-4e6c-9d13-1ec7813b14b7", + "title": "To create a new vault" + } + ], + "DeleteArchive": [ + { + "input": { + "accountId": "-", + "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes the archive specified by the archive ID.", + "id": "delete-archive-1481667809463", + "title": "To delete an archive" + } + ], + "DeleteVault": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes a vault named my-vault:", + "id": "7f7f000b-4bdb-40d2-91e6-7c902f60f60f", + "title": "To delete a vault" + } + ], + "DeleteVaultAccessPolicy": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes the access policy associated with the vault named examplevault.", + "id": "to-delete-the-vault-access-policy-1481840424677", + "title": "To delete the vault access policy" + } + ], + "DeleteVaultNotifications": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes the notification configuration set for the vault named examplevault.", + "id": "to-delete-the-notification-configuration-set-for-a-vault-1481840646090", + "title": "To delete the notification configuration set for a vault" + } + ], + "DescribeJob": [ + { + "input": { + "accountId": "-", + "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn", + "vaultName": "my-vault" + }, + "output": { + "Action": "InventoryRetrieval", + "Completed": false, + "CreationDate": "2015-07-17T20:23:41.616Z", + "InventoryRetrievalParameters": { + "Format": "JSON" + }, + "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "StatusCode": "InProgress", + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example returns information about the previously initiated job specified by the job ID.", + "id": "to-get-information-about-a-job-you-previously-initiated-1481840928592", + "title": "To get information about a previously initiated job" + } + ], + "DescribeVault": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "CreationDate": "2016-09-23T19:27:18.665Z", + "NumberOfArchives": 0, + "SizeInBytes": 0, + "VaultARN": "arn:aws:glacier:us-west-2:111122223333:vaults/my-vault", + "VaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves data about a vault named my-vault.", + "id": "3c1c6e9d-f5a2-427a-aa6a-f439eacfc05f", + "title": "To retrieve information about a vault" + } + ], + "GetDataRetrievalPolicy": [ + { + "input": { + "accountId": "-" + }, + "output": { + "Policy": { + "Rules": [ + { + "BytesPerHour": 10737418240, + "Strategy": "BytesPerHour" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example returns the current data retrieval policy for the account.", + "id": "to-get-the-current-data-retrieval-policy-for-the-account-1481851580439", + "title": "To get the current data retrieval policy for an account" + } + ], + "GetJobOutput": [ + { + "input": { + "accountId": "-", + "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "range": "", + "vaultName": "my-vaul" + }, + "output": { + "acceptRanges": "bytes", + "body": "inventory-data", + "contentType": "application/json", + "status": 200 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.", + "id": "to-get-the-output-of-a-previously-initiated-job-1481848550859", + "title": "To get the output of a previously initiated job" + } + ], + "GetVaultAccessPolicy": [ + { + "input": { + "accountId": "-", + "vaultName": "example-vault" + }, + "output": { + "policy": { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves the access-policy set on the vault named example-vault.", + "id": "to--get-the-access-policy-set-on-the-vault-1481936004590", + "title": "To get the access-policy set on the vault" + } + ], + "GetVaultLock": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "output": { + "CreationDate": "exampledate", + "ExpirationDate": "exampledate", + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}", + "State": "InProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.", + "id": "to-retrieve-vault-lock-policy-related-attributes-that-are-set-on-a-vault-1481851363097", + "title": "To retrieve vault lock-policy related attributes that are set on a vault" + } + ], + "GetVaultNotifications": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "vaultNotificationConfig": { + "Events": [ + "InventoryRetrievalCompleted", + "ArchiveRetrievalCompleted" + ], + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves the notification-configuration for the vault named my-vault.", + "id": "to-get-the-notification-configuration-for-the-specified-vault-1481918746677", + "title": "To get the notification-configuration for the specified vault" + } + ], + "InitiateJob": [ + { + "input": { + "accountId": "-", + "jobParameters": { + "Description": "My inventory job", + "Format": "CSV", + "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example", + "Type": "inventory-retrieval" + }, + "vaultName": "examplevault" + }, + "output": { + "jobId": " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID", + "location": "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example initiates an inventory-retrieval job for the vault named examplevault.", + "id": "to-initiate-an-inventory-retrieval-job-1482186883826", + "title": "To initiate an inventory-retrieval job" + } + ], + "InitiateMultipartUpload": [ + { + "input": { + "accountId": "-", + "partSize": "1048576", + "vaultName": "my-vault" + }, + "output": { + "location": "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file.", + "id": "72f2db19-3d93-4c74-b2ed-38703baacf49", + "title": "To initiate a multipart upload" + } + ], + "InitiateVaultLock": [ + { + "input": { + "accountId": "-", + "policy": { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}" + }, + "vaultName": "my-vault" + }, + "output": { + "lockId": "AE863rKkWZU53SLW5be4DUcW" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example initiates the vault locking process for the vault named my-vault.", + "id": "to-initiate-the-vault-locking-process-1481919693394", + "title": "To initiate the vault locking process" + } + ], + "ListJobs": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "JobList": [ + { + "Action": "ArchiveRetrieval", + "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", + "ArchiveSHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "ArchiveSizeInBytes": 3145728, + "Completed": false, + "CreationDate": "2015-07-17T21:16:13.840Z", + "JobDescription": "Retrieve archive on 2015-07-17", + "JobId": "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", + "RetrievalByteRange": "0-3145727", + "SHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault", + "StatusCode": "InProgress", + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault" + }, + { + "Action": "InventoryRetrieval", + "Completed": false, + "CreationDate": "2015-07-17T20:23:41.616Z", + "InventoryRetrievalParameters": { + "Format": "JSON" + }, + "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "StatusCode": "InProgress", + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists jobs for the vault named my-vault.", + "id": "to-list-jobs-for-a-vault-1481920530537", + "title": "To list jobs for a vault" + } + ], + "ListMultipartUploads": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "output": { + "Marker": "null", + "UploadsList": [ + { + "ArchiveDescription": "archive 1", + "CreationDate": "2012-03-19T23:20:59.130Z", + "MultipartUploadId": "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev", + "PartSizeInBytes": 4194304, + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" + }, + { + "ArchiveDescription": "archive 2", + "CreationDate": "2012-04-01T15:00:00.000Z", + "MultipartUploadId": "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc", + "PartSizeInBytes": 4194304, + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" + }, + { + "ArchiveDescription": "archive 3", + "CreationDate": "2012-03-20T17:03:43.221Z", + "MultipartUploadId": "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV", + "PartSizeInBytes": 4194304, + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all the in-progress multipart uploads for the vault named examplevault.", + "id": "to-list-all-the-in-progress-multipart-uploads-for-a-vault-1481935250590", + "title": "To list all the in-progress multipart uploads for a vault" + } + ], + "ListParts": [ + { + "input": { + "accountId": "-", + "uploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE", + "vaultName": "examplevault" + }, + "output": { + "ArchiveDescription": "archive description", + "CreationDate": "2012-03-20T17:03:43.221Z", + "Marker": "null", + "MultipartUploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE", + "PartSizeInBytes": 4194304, + "Parts": [ + { + "RangeInBytes": "0-4194303", + "SHA256TreeHash": "01d34dabf7be316472c93b1ef80721f5d4" + }, + { + "RangeInBytes": "4194304-8388607", + "SHA256TreeHash": "0195875365afda349fc21c84c099987164" + } + ], + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all the parts of a multipart upload.", + "id": "to-list-the-parts-of-an-archive-that-have-been-uploaded-in-a-multipart-upload-1481921767590", + "title": "To list the parts of an archive that have been uploaded in a multipart upload" + } + ], + "ListProvisionedCapacity": [ + { + "input": { + "accountId": "-" + }, + "output": { + "ProvisionedCapacityList": [ + { + "CapacityId": "zSaq7NzHFQDANTfQkDen4V7z", + "ExpirationDate": "2016-12-12T00:00:00.000Z", + "StartDate": "2016-11-11T20:11:51.095Z" + }, + { + "CapacityId": "yXaq7NzHFQNADTfQkDen4V7z", + "ExpirationDate": "2017-01-15T00:00:00.000Z", + "StartDate": "2016-12-13T20:11:51.095Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists the provisioned capacity units for an account.", + "id": "to-list-the-provisioned-capacity-units-for-an-account-1481923656130", + "title": "To list the provisioned capacity units for an account" + } + ], + "ListTagsForVault": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "output": { + "Tags": { + "date": "july2015", + "id": "1234" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all the tags attached to the vault examplevault.", + "id": "list-tags-for-vault-1481755839720", + "title": "To list the tags for a vault" + } + ], + "ListVaults": [ + { + "input": { + "accountId": "-", + "limit": "", + "marker": "" + }, + "output": { + "VaultList": [ + { + "CreationDate": "2015-04-06T21:23:45.708Z", + "LastInventoryDate": "2015-04-07T00:26:19.028Z", + "NumberOfArchives": 1, + "SizeInBytes": 3178496, + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", + "VaultName": "my-vault" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all vaults owned by the specified AWS account.", + "id": "list-vaults-1481753006990", + "title": "To list all vaults owned by the calling user's account" + } + ], + "PurchaseProvisionedCapacity": [ + { + "input": { + "accountId": "-" + }, + "output": { + "capacityId": "zSaq7NzHFQDANTfQkDen4V7z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example purchases provisioned capacity unit for an AWS account.", + "id": "to-purchases-a-provisioned-capacity-unit-for-an-aws-account-1481927446662", + "title": "To purchases a provisioned capacity unit for an AWS account" + } + ], + "RemoveTagsFromVault": [ + { + "input": { + "TagKeys": [ + "examplekey1", + "examplekey2" + ], + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example removes two tags from the vault named examplevault.", + "id": "remove-tags-from-vault-1481754998801", + "title": "To remove tags from a vault" + } + ], + "SetDataRetrievalPolicy": [ + { + "input": { + "Policy": { + "Rules": [ + { + "BytesPerHour": 10737418240, + "Strategy": "BytesPerHour" + } + ] + }, + "accountId": "-" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example sets and then enacts a data retrieval policy.", + "id": "to-set-and-then-enact-a-data-retrieval-policy--1481928352408", + "title": "To set and then enact a data retrieval policy " + } + ], + "SetVaultAccessPolicy": [ + { + "input": { + "accountId": "-", + "policy": { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}" + }, + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example configures an access policy for the vault named examplevault.", + "id": "to--set-the-access-policy-on-a-vault-1482185872517", + "title": "To set the access-policy on a vault" + } + ], + "SetVaultNotifications": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault", + "vaultNotificationConfig": { + "Events": [ + "ArchiveRetrievalCompleted", + "InventoryRetrievalCompleted" + ], + "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example sets the examplevault notification configuration.", + "id": "to-configure-a-vault-to-post-a-message-to-an-amazon-simple-notification-service-amazon-sns-topic-when-jobs-complete-1482186397475", + "title": "To configure a vault to post a message to an Amazon SNS topic when jobs complete" + } + ], + "UploadArchive": [ + { + "input": { + "accountId": "-", + "archiveDescription": "", + "body": "example-data-to-upload", + "checksum": "", + "vaultName": "my-vault" + }, + "output": { + "archiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", + "checksum": "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67", + "location": "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example adds an archive to a vault.", + "id": "upload-archive-1481668510494", + "title": "To upload an archive" + } + ], + "UploadMultipartPart": [ + { + "input": { + "accountId": "-", + "body": "part1", + "checksum": "c06f7cd4baacb087002a99a5f48bf953", + "range": "bytes 0-1048575/*", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "vaultName": "examplevault" + }, + "output": { + "checksum": "c06f7cd4baacb087002a99a5f48bf953" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.", + "id": "to-upload-the-first-part-of-an-archive-1481835899519", + "title": "To upload the first part of an archive" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/glacier-2012-06-01.min.json b/node_modules/aws-sdk/apis/glacier-2012-06-01.min.json new file mode 100644 index 0000000..1276f3a --- /dev/null +++ b/node_modules/aws-sdk/apis/glacier-2012-06-01.min.json @@ -0,0 +1,1389 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-06-01", + "checksumFormat": "sha256", + "endpointPrefix": "glacier", + "protocol": "rest-json", + "serviceFullName": "Amazon Glacier", + "serviceId": "Glacier", + "signatureVersion": "v4", + "uid": "glacier-2012-06-01" + }, + "operations": { + "AbortMultipartUpload": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "uploadId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + } + } + } + }, + "AbortVaultLock": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/lock-policy", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + } + }, + "AddTagsToVault": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/tags?operation=add", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "Tags": { + "shape": "S5" + } + } + } + }, + "CompleteMultipartUpload": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "uploadId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + }, + "archiveSize": { + "location": "header", + "locationName": "x-amz-archive-size" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + } + } + }, + "output": { + "shape": "S9" + } + }, + "CompleteVaultLock": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/lock-policy/{lockId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "lockId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "lockId": { + "location": "uri", + "locationName": "lockId" + } + } + } + }, + "CreateVault": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/vaults/{vaultName}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "DeleteArchive": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/archives/{archiveId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "archiveId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "archiveId": { + "location": "uri", + "locationName": "archiveId" + } + } + } + }, + "DeleteVault": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + } + }, + "DeleteVaultAccessPolicy": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/access-policy", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + } + }, + "DeleteVaultNotifications": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + } + }, + "DescribeJob": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "jobId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + } + } + }, + "output": { + "shape": "Si" + } + }, + "DescribeVault": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + }, + "output": { + "shape": "S1a" + } + }, + "GetDataRetrievalPolicy": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/policies/data-retrieval" + }, + "input": { + "type": "structure", + "required": [ + "accountId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": { + "shape": "S1e" + } + } + } + }, + "GetJobOutput": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/jobs/{jobId}/output" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "jobId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "range": { + "location": "header", + "locationName": "Range" + } + } + }, + "output": { + "type": "structure", + "members": { + "body": { + "shape": "S1k" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "status": { + "location": "statusCode", + "type": "integer" + }, + "contentRange": { + "location": "header", + "locationName": "Content-Range" + }, + "acceptRanges": { + "location": "header", + "locationName": "Accept-Ranges" + }, + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "archiveDescription": { + "location": "header", + "locationName": "x-amz-archive-description" + } + }, + "payload": "body" + } + }, + "GetVaultAccessPolicy": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/access-policy" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "policy": { + "shape": "S1o" + } + }, + "payload": "policy" + } + }, + "GetVaultLock": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/lock-policy" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {}, + "State": {}, + "ExpirationDate": {}, + "CreationDate": {} + } + } + }, + "GetVaultNotifications": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/notification-configuration" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "vaultNotificationConfig": { + "shape": "S1t" + } + }, + "payload": "vaultNotificationConfig" + } + }, + "InitiateJob": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/jobs", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "jobParameters": { + "type": "structure", + "members": { + "Format": {}, + "Type": {}, + "ArchiveId": {}, + "Description": {}, + "SNSTopic": {}, + "RetrievalByteRange": {}, + "Tier": {}, + "InventoryRetrievalParameters": { + "type": "structure", + "members": { + "StartDate": {}, + "EndDate": {}, + "Limit": {}, + "Marker": {} + } + }, + "SelectParameters": { + "shape": "Sp" + }, + "OutputLocation": { + "shape": "Sx" + } + } + } + }, + "payload": "jobParameters" + }, + "output": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + }, + "jobId": { + "location": "header", + "locationName": "x-amz-job-id" + }, + "jobOutputPath": { + "location": "header", + "locationName": "x-amz-job-output-path" + } + } + } + }, + "InitiateMultipartUpload": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "archiveDescription": { + "location": "header", + "locationName": "x-amz-archive-description" + }, + "partSize": { + "location": "header", + "locationName": "x-amz-part-size" + } + } + }, + "output": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + }, + "uploadId": { + "location": "header", + "locationName": "x-amz-multipart-upload-id" + } + } + } + }, + "InitiateVaultLock": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/lock-policy", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "policy": { + "type": "structure", + "members": { + "Policy": {} + } + } + }, + "payload": "policy" + }, + "output": { + "type": "structure", + "members": { + "lockId": { + "location": "header", + "locationName": "x-amz-lock-id" + } + } + } + }, + "ListJobs": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/jobs" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "statuscode": { + "location": "querystring", + "locationName": "statuscode" + }, + "completed": { + "location": "querystring", + "locationName": "completed" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobList": { + "type": "list", + "member": { + "shape": "Si" + } + }, + "Marker": {} + } + } + }, + "ListMultipartUploads": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + } + } + }, + "output": { + "type": "structure", + "members": { + "UploadsList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "MultipartUploadId": {}, + "VaultARN": {}, + "ArchiveDescription": {}, + "PartSizeInBytes": { + "type": "long" + }, + "CreationDate": {} + } + } + }, + "Marker": {} + } + } + }, + "ListParts": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "uploadId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + } + } + }, + "output": { + "type": "structure", + "members": { + "MultipartUploadId": {}, + "VaultARN": {}, + "ArchiveDescription": {}, + "PartSizeInBytes": { + "type": "long" + }, + "CreationDate": {}, + "Parts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RangeInBytes": {}, + "SHA256TreeHash": {} + } + } + }, + "Marker": {} + } + } + }, + "ListProvisionedCapacity": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/provisioned-capacity" + }, + "input": { + "type": "structure", + "required": [ + "accountId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProvisionedCapacityList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CapacityId": {}, + "StartDate": {}, + "ExpirationDate": {} + } + } + } + } + } + }, + "ListTagsForVault": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/tags" + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S5" + } + } + } + }, + "ListVaults": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults" + }, + "input": { + "type": "structure", + "required": [ + "accountId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + } + } + }, + "output": { + "type": "structure", + "members": { + "VaultList": { + "type": "list", + "member": { + "shape": "S1a" + } + }, + "Marker": {} + } + } + }, + "PurchaseProvisionedCapacity": { + "http": { + "requestUri": "/{accountId}/provisioned-capacity", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "accountId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + } + } + }, + "output": { + "type": "structure", + "members": { + "capacityId": { + "location": "header", + "locationName": "x-amz-capacity-id" + } + } + } + }, + "RemoveTagsFromVault": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/tags?operation=remove", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "SetDataRetrievalPolicy": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/policies/data-retrieval", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "Policy": { + "shape": "S1e" + } + } + } + }, + "SetVaultAccessPolicy": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/vaults/{vaultName}/access-policy", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "policy": { + "shape": "S1o" + } + }, + "payload": "policy" + } + }, + "SetVaultNotifications": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "vaultNotificationConfig": { + "shape": "S1t" + } + }, + "payload": "vaultNotificationConfig" + } + }, + "UploadArchive": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/archives", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "vaultName", + "accountId" + ], + "members": { + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "archiveDescription": { + "location": "header", + "locationName": "x-amz-archive-description" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "body": { + "shape": "S1k" + } + }, + "payload": "body" + }, + "output": { + "shape": "S9" + } + }, + "UploadMultipartPart": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "accountId", + "vaultName", + "uploadId" + ], + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "range": { + "location": "header", + "locationName": "Content-Range" + }, + "body": { + "shape": "S1k" + } + }, + "payload": "body" + }, + "output": { + "type": "structure", + "members": { + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + } + } + } + } + }, + "shapes": { + "S5": { + "type": "map", + "key": {}, + "value": {} + }, + "S9": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "archiveId": { + "location": "header", + "locationName": "x-amz-archive-id" + } + } + }, + "Si": { + "type": "structure", + "members": { + "JobId": {}, + "JobDescription": {}, + "Action": {}, + "ArchiveId": {}, + "VaultARN": {}, + "CreationDate": {}, + "Completed": { + "type": "boolean" + }, + "StatusCode": {}, + "StatusMessage": {}, + "ArchiveSizeInBytes": { + "type": "long" + }, + "InventorySizeInBytes": { + "type": "long" + }, + "SNSTopic": {}, + "CompletionDate": {}, + "SHA256TreeHash": {}, + "ArchiveSHA256TreeHash": {}, + "RetrievalByteRange": {}, + "Tier": {}, + "InventoryRetrievalParameters": { + "type": "structure", + "members": { + "Format": {}, + "StartDate": {}, + "EndDate": {}, + "Limit": {}, + "Marker": {} + } + }, + "JobOutputPath": {}, + "SelectParameters": { + "shape": "Sp" + }, + "OutputLocation": { + "shape": "Sx" + } + } + }, + "Sp": { + "type": "structure", + "members": { + "InputSerialization": { + "type": "structure", + "members": { + "csv": { + "type": "structure", + "members": { + "FileHeaderInfo": {}, + "Comments": {}, + "QuoteEscapeCharacter": {}, + "RecordDelimiter": {}, + "FieldDelimiter": {}, + "QuoteCharacter": {} + } + } + } + }, + "ExpressionType": {}, + "Expression": {}, + "OutputSerialization": { + "type": "structure", + "members": { + "csv": { + "type": "structure", + "members": { + "QuoteFields": {}, + "QuoteEscapeCharacter": {}, + "RecordDelimiter": {}, + "FieldDelimiter": {}, + "QuoteCharacter": {} + } + } + } + } + } + }, + "Sx": { + "type": "structure", + "members": { + "S3": { + "type": "structure", + "members": { + "BucketName": {}, + "Prefix": {}, + "Encryption": { + "type": "structure", + "members": { + "EncryptionType": {}, + "KMSKeyId": {}, + "KMSContext": {} + } + }, + "CannedACL": {}, + "AccessControlList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Grantee": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "DisplayName": {}, + "URI": {}, + "ID": {}, + "EmailAddress": {} + } + }, + "Permission": {} + } + } + }, + "Tagging": { + "shape": "S17" + }, + "UserMetadata": { + "shape": "S17" + }, + "StorageClass": {} + } + } + } + }, + "S17": { + "type": "map", + "key": {}, + "value": {} + }, + "S1a": { + "type": "structure", + "members": { + "VaultARN": {}, + "VaultName": {}, + "CreationDate": {}, + "LastInventoryDate": {}, + "NumberOfArchives": { + "type": "long" + }, + "SizeInBytes": { + "type": "long" + } + } + }, + "S1e": { + "type": "structure", + "members": { + "Rules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Strategy": {}, + "BytesPerHour": { + "type": "long" + } + } + } + } + } + }, + "S1k": { + "type": "blob", + "streaming": true + }, + "S1o": { + "type": "structure", + "members": { + "Policy": {} + } + }, + "S1t": { + "type": "structure", + "members": { + "SNSTopic": {}, + "Events": { + "type": "list", + "member": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/glacier-2012-06-01.paginators.json b/node_modules/aws-sdk/apis/glacier-2012-06-01.paginators.json new file mode 100644 index 0000000..cf247b7 --- /dev/null +++ b/node_modules/aws-sdk/apis/glacier-2012-06-01.paginators.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "marker", + "limit_key": "limit", + "output_token": "Marker", + "result_key": "JobList" + }, + "ListMultipartUploads": { + "input_token": "marker", + "limit_key": "limit", + "output_token": "Marker", + "result_key": "UploadsList" + }, + "ListParts": { + "input_token": "marker", + "limit_key": "limit", + "output_token": "Marker", + "result_key": "Parts" + }, + "ListVaults": { + "input_token": "marker", + "limit_key": "limit", + "output_token": "Marker", + "result_key": "VaultList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/glacier-2012-06-01.waiters2.json b/node_modules/aws-sdk/apis/glacier-2012-06-01.waiters2.json new file mode 100644 index 0000000..07a64a0 --- /dev/null +++ b/node_modules/aws-sdk/apis/glacier-2012-06-01.waiters2.json @@ -0,0 +1,39 @@ +{ + "version": 2, + "waiters": { + "VaultExists": { + "operation": "DescribeVault", + "delay": 3, + "maxAttempts": 15, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "ResourceNotFoundException" + } + ] + }, + "VaultNotExists": { + "operation": "DescribeVault", + "delay": 3, + "maxAttempts": 15, + "acceptors": [ + { + "state": "retry", + "matcher": "status", + "expected": 200 + }, + { + "state": "success", + "matcher": "error", + "expected": "ResourceNotFoundException" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.examples.json b/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.min.json b/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.min.json new file mode 100644 index 0000000..492796b --- /dev/null +++ b/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.min.json @@ -0,0 +1,513 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-08-08", + "endpointPrefix": "globalaccelerator", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Global Accelerator", + "serviceId": "Global Accelerator", + "signatureVersion": "v4", + "signingName": "globalaccelerator", + "targetPrefix": "GlobalAccelerator_V20180706", + "uid": "globalaccelerator-2018-08-08" + }, + "operations": { + "CreateAccelerator": { + "input": { + "type": "structure", + "required": [ + "Name", + "IdempotencyToken" + ], + "members": { + "Name": {}, + "IpAddressType": {}, + "Enabled": { + "type": "boolean" + }, + "IdempotencyToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Accelerator": { + "shape": "S7" + } + } + } + }, + "CreateEndpointGroup": { + "input": { + "type": "structure", + "required": [ + "ListenerArn", + "EndpointGroupRegion", + "IdempotencyToken" + ], + "members": { + "ListenerArn": {}, + "EndpointGroupRegion": {}, + "EndpointConfigurations": { + "shape": "Sf" + }, + "TrafficDialPercentage": { + "type": "float" + }, + "HealthCheckPort": { + "type": "integer" + }, + "HealthCheckProtocol": {}, + "HealthCheckPath": {}, + "HealthCheckIntervalSeconds": { + "type": "integer" + }, + "ThresholdCount": { + "type": "integer" + }, + "IdempotencyToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "EndpointGroup": { + "shape": "So" + } + } + } + }, + "CreateListener": { + "input": { + "type": "structure", + "required": [ + "AcceleratorArn", + "PortRanges", + "Protocol", + "IdempotencyToken" + ], + "members": { + "AcceleratorArn": {}, + "PortRanges": { + "shape": "St" + }, + "Protocol": {}, + "ClientAffinity": {}, + "IdempotencyToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Listener": { + "shape": "Sz" + } + } + } + }, + "DeleteAccelerator": { + "input": { + "type": "structure", + "required": [ + "AcceleratorArn" + ], + "members": { + "AcceleratorArn": {} + } + } + }, + "DeleteEndpointGroup": { + "input": { + "type": "structure", + "required": [ + "EndpointGroupArn" + ], + "members": { + "EndpointGroupArn": {} + } + } + }, + "DeleteListener": { + "input": { + "type": "structure", + "required": [ + "ListenerArn" + ], + "members": { + "ListenerArn": {} + } + } + }, + "DescribeAccelerator": { + "input": { + "type": "structure", + "required": [ + "AcceleratorArn" + ], + "members": { + "AcceleratorArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Accelerator": { + "shape": "S7" + } + } + } + }, + "DescribeAcceleratorAttributes": { + "input": { + "type": "structure", + "members": { + "AcceleratorArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "AcceleratorAttributes": { + "shape": "S17" + } + } + } + }, + "DescribeEndpointGroup": { + "input": { + "type": "structure", + "required": [ + "EndpointGroupArn" + ], + "members": { + "EndpointGroupArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "EndpointGroup": { + "shape": "So" + } + } + } + }, + "DescribeListener": { + "input": { + "type": "structure", + "required": [ + "ListenerArn" + ], + "members": { + "ListenerArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Listener": { + "shape": "Sz" + } + } + } + }, + "ListAccelerators": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Accelerators": { + "type": "list", + "member": { + "shape": "S7" + } + }, + "NextToken": {} + } + } + }, + "ListEndpointGroups": { + "input": { + "type": "structure", + "required": [ + "ListenerArn" + ], + "members": { + "ListenerArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "EndpointGroups": { + "type": "list", + "member": { + "shape": "So" + } + }, + "NextToken": {} + } + } + }, + "ListListeners": { + "input": { + "type": "structure", + "required": [ + "AcceleratorArn" + ], + "members": { + "AcceleratorArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Listeners": { + "type": "list", + "member": { + "shape": "Sz" + } + }, + "NextToken": {} + } + } + }, + "UpdateAccelerator": { + "input": { + "type": "structure", + "required": [ + "AcceleratorArn" + ], + "members": { + "AcceleratorArn": {}, + "Name": {}, + "IpAddressType": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Accelerator": { + "shape": "S7" + } + } + } + }, + "UpdateAcceleratorAttributes": { + "input": { + "type": "structure", + "members": { + "AcceleratorArn": {}, + "FlowLogsEnabled": { + "type": "boolean" + }, + "FlowLogsS3Bucket": {}, + "FlowLogsS3Prefix": {} + } + }, + "output": { + "type": "structure", + "members": { + "AcceleratorAttributes": { + "shape": "S17" + } + } + } + }, + "UpdateEndpointGroup": { + "input": { + "type": "structure", + "required": [ + "EndpointGroupArn" + ], + "members": { + "EndpointGroupArn": {}, + "EndpointConfigurations": { + "shape": "Sf" + }, + "TrafficDialPercentage": { + "type": "float" + }, + "HealthCheckPort": { + "type": "integer" + }, + "HealthCheckProtocol": {}, + "HealthCheckPath": {}, + "HealthCheckIntervalSeconds": { + "type": "integer" + }, + "ThresholdCount": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "EndpointGroup": { + "shape": "So" + } + } + } + }, + "UpdateListener": { + "input": { + "type": "structure", + "required": [ + "ListenerArn" + ], + "members": { + "ListenerArn": {}, + "PortRanges": { + "shape": "St" + }, + "Protocol": {}, + "ClientAffinity": {} + } + }, + "output": { + "type": "structure", + "members": { + "Listener": { + "shape": "Sz" + } + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "AcceleratorArn": {}, + "Name": {}, + "IpAddressType": {}, + "Enabled": { + "type": "boolean" + }, + "IpSets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IpFamily": {}, + "IpAddresses": { + "type": "list", + "member": {} + } + } + } + }, + "Status": {}, + "CreatedTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + } + } + }, + "Sf": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EndpointId": {}, + "Weight": { + "type": "integer" + } + } + } + }, + "So": { + "type": "structure", + "members": { + "EndpointGroupArn": {}, + "EndpointGroupRegion": {}, + "EndpointDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EndpointId": {}, + "Weight": { + "type": "integer" + }, + "HealthState": {}, + "HealthReason": {} + } + } + }, + "TrafficDialPercentage": { + "type": "float" + }, + "HealthCheckPort": { + "type": "integer" + }, + "HealthCheckProtocol": {}, + "HealthCheckPath": {}, + "HealthCheckIntervalSeconds": { + "type": "integer" + }, + "ThresholdCount": { + "type": "integer" + } + } + }, + "St": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + } + } + } + }, + "Sz": { + "type": "structure", + "members": { + "ListenerArn": {}, + "PortRanges": { + "shape": "St" + }, + "Protocol": {}, + "ClientAffinity": {} + } + }, + "S17": { + "type": "structure", + "members": { + "FlowLogsEnabled": { + "type": "boolean" + }, + "FlowLogsS3Bucket": {}, + "FlowLogsS3Prefix": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.paginators.json b/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/globalaccelerator-2018-08-08.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/glue-2017-03-31.examples.json b/node_modules/aws-sdk/apis/glue-2017-03-31.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/glue-2017-03-31.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/glue-2017-03-31.min.json b/node_modules/aws-sdk/apis/glue-2017-03-31.min.json new file mode 100644 index 0000000..0bdf81e --- /dev/null +++ b/node_modules/aws-sdk/apis/glue-2017-03-31.min.json @@ -0,0 +1,3577 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-03-31", + "endpointPrefix": "glue", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Glue", + "serviceId": "Glue", + "signatureVersion": "v4", + "targetPrefix": "AWSGlue", + "uid": "glue-2017-03-31" + }, + "operations": { + "BatchCreatePartition": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "PartitionInputList" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "PartitionInputList": { + "type": "list", + "member": { + "shape": "S5" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Errors": { + "shape": "Sv" + } + } + } + }, + "BatchDeleteConnection": { + "input": { + "type": "structure", + "required": [ + "ConnectionNameList" + ], + "members": { + "CatalogId": {}, + "ConnectionNameList": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "Succeeded": { + "shape": "Sm" + }, + "Errors": { + "type": "map", + "key": {}, + "value": { + "shape": "Sx" + } + } + } + } + }, + "BatchDeletePartition": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "PartitionsToDelete" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "PartitionsToDelete": { + "type": "list", + "member": { + "shape": "S15" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Errors": { + "shape": "Sv" + } + } + } + }, + "BatchDeleteTable": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TablesToDelete" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TablesToDelete": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "Errors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TableName": {}, + "ErrorDetail": { + "shape": "Sx" + } + } + } + } + } + } + }, + "BatchDeleteTableVersion": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "VersionIds" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "VersionIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "Errors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TableName": {}, + "VersionId": {}, + "ErrorDetail": { + "shape": "Sx" + } + } + } + } + } + } + }, + "BatchGetCrawlers": { + "input": { + "type": "structure", + "required": [ + "CrawlerNames" + ], + "members": { + "CrawlerNames": { + "shape": "S1j" + } + } + }, + "output": { + "type": "structure", + "members": { + "Crawlers": { + "shape": "S1l" + }, + "CrawlersNotFound": { + "shape": "S1j" + } + } + } + }, + "BatchGetDevEndpoints": { + "input": { + "type": "structure", + "required": [ + "DevEndpointNames" + ], + "members": { + "DevEndpointNames": { + "shape": "S2i" + } + } + }, + "output": { + "type": "structure", + "members": { + "DevEndpoints": { + "shape": "S2l" + }, + "DevEndpointsNotFound": { + "shape": "S2i" + } + } + } + }, + "BatchGetJobs": { + "input": { + "type": "structure", + "required": [ + "JobNames" + ], + "members": { + "JobNames": { + "shape": "S2u" + } + } + }, + "output": { + "type": "structure", + "members": { + "Jobs": { + "shape": "S2w" + }, + "JobsNotFound": { + "shape": "S2u" + } + } + } + }, + "BatchGetPartition": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "PartitionsToGet" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "PartitionsToGet": { + "shape": "S3e" + } + } + }, + "output": { + "type": "structure", + "members": { + "Partitions": { + "shape": "S3g" + }, + "UnprocessedKeys": { + "shape": "S3e" + } + } + } + }, + "BatchGetTriggers": { + "input": { + "type": "structure", + "required": [ + "TriggerNames" + ], + "members": { + "TriggerNames": { + "shape": "S3j" + } + } + }, + "output": { + "type": "structure", + "members": { + "Triggers": { + "shape": "S3l" + }, + "TriggersNotFound": { + "shape": "S3j" + } + } + } + }, + "BatchStopJobRun": { + "input": { + "type": "structure", + "required": [ + "JobName", + "JobRunIds" + ], + "members": { + "JobName": {}, + "JobRunIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "SuccessfulSubmissions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobName": {}, + "JobRunId": {} + } + } + }, + "Errors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobName": {}, + "JobRunId": {}, + "ErrorDetail": { + "shape": "Sx" + } + } + } + } + } + } + }, + "CreateClassifier": { + "input": { + "type": "structure", + "members": { + "GrokClassifier": { + "type": "structure", + "required": [ + "Classification", + "Name", + "GrokPattern" + ], + "members": { + "Classification": {}, + "Name": {}, + "GrokPattern": {}, + "CustomPatterns": {} + } + }, + "XMLClassifier": { + "type": "structure", + "required": [ + "Classification", + "Name" + ], + "members": { + "Classification": {}, + "Name": {}, + "RowTag": {} + } + }, + "JsonClassifier": { + "type": "structure", + "required": [ + "Name", + "JsonPath" + ], + "members": { + "Name": {}, + "JsonPath": {} + } + }, + "CsvClassifier": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Delimiter": {}, + "QuoteSymbol": {}, + "ContainsHeader": {}, + "Header": { + "shape": "S4i" + }, + "DisableValueTrimming": { + "type": "boolean" + }, + "AllowSingleColumn": { + "type": "boolean" + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateConnection": { + "input": { + "type": "structure", + "required": [ + "ConnectionInput" + ], + "members": { + "CatalogId": {}, + "ConnectionInput": { + "shape": "S4m" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateCrawler": { + "input": { + "type": "structure", + "required": [ + "Name", + "Role", + "DatabaseName", + "Targets" + ], + "members": { + "Name": {}, + "Role": {}, + "DatabaseName": {}, + "Description": {}, + "Targets": { + "shape": "S1o" + }, + "Schedule": {}, + "Classifiers": { + "shape": "S1z" + }, + "TablePrefix": {}, + "SchemaChangePolicy": { + "shape": "S20" + }, + "Configuration": {}, + "CrawlerSecurityConfiguration": {}, + "Tags": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateDatabase": { + "input": { + "type": "structure", + "required": [ + "DatabaseInput" + ], + "members": { + "CatalogId": {}, + "DatabaseInput": { + "shape": "S50" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateDevEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName", + "RoleArn" + ], + "members": { + "EndpointName": {}, + "RoleArn": {}, + "SecurityGroupIds": { + "shape": "S2o" + }, + "SubnetId": {}, + "PublicKey": {}, + "PublicKeys": { + "shape": "S2r" + }, + "NumberOfNodes": { + "type": "integer" + }, + "ExtraPythonLibsS3Path": {}, + "ExtraJarsS3Path": {}, + "SecurityConfiguration": {}, + "Tags": { + "shape": "S4v" + }, + "Arguments": { + "shape": "S2s" + } + } + }, + "output": { + "type": "structure", + "members": { + "EndpointName": {}, + "Status": {}, + "SecurityGroupIds": { + "shape": "S2o" + }, + "SubnetId": {}, + "RoleArn": {}, + "YarnEndpointAddress": {}, + "ZeppelinRemoteSparkInterpreterPort": { + "type": "integer" + }, + "NumberOfNodes": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "ExtraPythonLibsS3Path": {}, + "ExtraJarsS3Path": {}, + "FailureReason": {}, + "SecurityConfiguration": {}, + "CreatedTimestamp": { + "type": "timestamp" + }, + "Arguments": { + "shape": "S2s" + } + } + } + }, + "CreateJob": { + "input": { + "type": "structure", + "required": [ + "Name", + "Role", + "Command" + ], + "members": { + "Name": {}, + "Description": {}, + "LogUri": {}, + "Role": {}, + "ExecutionProperty": { + "shape": "S30" + }, + "Command": { + "shape": "S32" + }, + "DefaultArguments": { + "shape": "S34" + }, + "Connections": { + "shape": "S35" + }, + "MaxRetries": { + "type": "integer" + }, + "AllocatedCapacity": { + "deprecated": true, + "deprecatedMessage": "This property is deprecated, use MaxCapacity instead.", + "type": "integer" + }, + "Timeout": { + "type": "integer" + }, + "MaxCapacity": { + "type": "double" + }, + "NotificationProperty": { + "shape": "S3b" + }, + "WorkerType": {}, + "NumberOfWorkers": { + "type": "integer" + }, + "SecurityConfiguration": {}, + "Tags": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "CreatePartition": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "PartitionInput" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "PartitionInput": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateScript": { + "input": { + "type": "structure", + "members": { + "DagNodes": { + "shape": "S5a" + }, + "DagEdges": { + "shape": "S5i" + }, + "Language": {} + } + }, + "output": { + "type": "structure", + "members": { + "PythonScript": {}, + "ScalaCode": {} + } + } + }, + "CreateSecurityConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name", + "EncryptionConfiguration" + ], + "members": { + "Name": {}, + "EncryptionConfiguration": { + "shape": "S5p" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "CreateTable": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableInput" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableInput": { + "shape": "S60" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateTrigger": { + "input": { + "type": "structure", + "required": [ + "Name", + "Type", + "Actions" + ], + "members": { + "Name": {}, + "Type": {}, + "Schedule": {}, + "Predicate": { + "shape": "S3s" + }, + "Actions": { + "shape": "S3q" + }, + "Description": {}, + "StartOnCreation": { + "type": "boolean" + }, + "Tags": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "CreateUserDefinedFunction": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "FunctionInput" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "FunctionInput": { + "shape": "S69" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteClassifier": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteConnection": { + "input": { + "type": "structure", + "required": [ + "ConnectionName" + ], + "members": { + "CatalogId": {}, + "ConnectionName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteCrawler": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDatabase": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "CatalogId": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDevEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName" + ], + "members": { + "EndpointName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteJob": { + "input": { + "type": "structure", + "required": [ + "JobName" + ], + "members": { + "JobName": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobName": {} + } + } + }, + "DeletePartition": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "PartitionValues" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "PartitionValues": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteResourcePolicy": { + "input": { + "type": "structure", + "members": { + "PolicyHashCondition": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSecurityConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTable": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "Name" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTableVersion": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "VersionId" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "VersionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTrigger": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "DeleteUserDefinedFunction": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "FunctionName" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "FunctionName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetCatalogImportStatus": { + "input": { + "type": "structure", + "members": { + "CatalogId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ImportStatus": { + "type": "structure", + "members": { + "ImportCompleted": { + "type": "boolean" + }, + "ImportTime": { + "type": "timestamp" + }, + "ImportedBy": {} + } + } + } + } + }, + "GetClassifier": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Classifier": { + "shape": "S7b" + } + } + } + }, + "GetClassifiers": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Classifiers": { + "type": "list", + "member": { + "shape": "S7b" + } + }, + "NextToken": {} + } + } + }, + "GetConnection": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "CatalogId": {}, + "Name": {}, + "HidePassword": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Connection": { + "shape": "S7n" + } + } + } + }, + "GetConnections": { + "input": { + "type": "structure", + "members": { + "CatalogId": {}, + "Filter": { + "type": "structure", + "members": { + "MatchCriteria": { + "shape": "S4o" + }, + "ConnectionType": {} + } + }, + "HidePassword": { + "type": "boolean" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConnectionList": { + "type": "list", + "member": { + "shape": "S7n" + } + }, + "NextToken": {} + } + } + }, + "GetCrawler": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Crawler": { + "shape": "S1m" + } + } + } + }, + "GetCrawlerMetrics": { + "input": { + "type": "structure", + "members": { + "CrawlerNameList": { + "shape": "S1j" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "CrawlerMetricsList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CrawlerName": {}, + "TimeLeftSeconds": { + "type": "double" + }, + "StillEstimating": { + "type": "boolean" + }, + "LastRuntimeSeconds": { + "type": "double" + }, + "MedianRuntimeSeconds": { + "type": "double" + }, + "TablesCreated": { + "type": "integer" + }, + "TablesUpdated": { + "type": "integer" + }, + "TablesDeleted": { + "type": "integer" + } + } + } + }, + "NextToken": {} + } + } + }, + "GetCrawlers": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Crawlers": { + "shape": "S1l" + }, + "NextToken": {} + } + } + }, + "GetDataCatalogEncryptionSettings": { + "input": { + "type": "structure", + "members": { + "CatalogId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DataCatalogEncryptionSettings": { + "shape": "S83" + } + } + } + }, + "GetDatabase": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "CatalogId": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Database": { + "shape": "S89" + } + } + } + }, + "GetDatabases": { + "input": { + "type": "structure", + "members": { + "CatalogId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DatabaseList" + ], + "members": { + "DatabaseList": { + "type": "list", + "member": { + "shape": "S89" + } + }, + "NextToken": {} + } + } + }, + "GetDataflowGraph": { + "input": { + "type": "structure", + "members": { + "PythonScript": {} + } + }, + "output": { + "type": "structure", + "members": { + "DagNodes": { + "shape": "S5a" + }, + "DagEdges": { + "shape": "S5i" + } + } + } + }, + "GetDevEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName" + ], + "members": { + "EndpointName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DevEndpoint": { + "shape": "S2m" + } + } + } + }, + "GetDevEndpoints": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "DevEndpoints": { + "shape": "S2l" + }, + "NextToken": {} + } + } + }, + "GetJob": { + "input": { + "type": "structure", + "required": [ + "JobName" + ], + "members": { + "JobName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Job": { + "shape": "S2x" + } + } + } + }, + "GetJobRun": { + "input": { + "type": "structure", + "required": [ + "JobName", + "RunId" + ], + "members": { + "JobName": {}, + "RunId": {}, + "PredecessorsIncluded": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobRun": { + "shape": "S8n" + } + } + } + }, + "GetJobRuns": { + "input": { + "type": "structure", + "required": [ + "JobName" + ], + "members": { + "JobName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobRuns": { + "type": "list", + "member": { + "shape": "S8n" + } + }, + "NextToken": {} + } + } + }, + "GetJobs": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Jobs": { + "shape": "S2w" + }, + "NextToken": {} + } + } + }, + "GetMapping": { + "input": { + "type": "structure", + "required": [ + "Source" + ], + "members": { + "Source": { + "shape": "S8z" + }, + "Sinks": { + "shape": "S90" + }, + "Location": { + "shape": "S91" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Mapping" + ], + "members": { + "Mapping": { + "shape": "S93" + } + } + } + }, + "GetPartition": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "PartitionValues" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "PartitionValues": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "Partition": { + "shape": "S3h" + } + } + } + }, + "GetPartitions": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "Expression": {}, + "NextToken": {}, + "Segment": { + "type": "structure", + "required": [ + "SegmentNumber", + "TotalSegments" + ], + "members": { + "SegmentNumber": { + "type": "integer" + }, + "TotalSegments": { + "type": "integer" + } + } + }, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Partitions": { + "shape": "S3g" + }, + "NextToken": {} + } + } + }, + "GetPlan": { + "input": { + "type": "structure", + "required": [ + "Mapping", + "Source" + ], + "members": { + "Mapping": { + "shape": "S93" + }, + "Source": { + "shape": "S8z" + }, + "Sinks": { + "shape": "S90" + }, + "Location": { + "shape": "S91" + }, + "Language": {} + } + }, + "output": { + "type": "structure", + "members": { + "PythonScript": {}, + "ScalaCode": {} + } + } + }, + "GetResourcePolicy": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "PolicyInJson": {}, + "PolicyHash": {}, + "CreateTime": { + "type": "timestamp" + }, + "UpdateTime": { + "type": "timestamp" + } + } + } + }, + "GetSecurityConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "SecurityConfiguration": { + "shape": "S9m" + } + } + } + }, + "GetSecurityConfigurations": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SecurityConfigurations": { + "type": "list", + "member": { + "shape": "S9m" + } + }, + "NextToken": {} + } + } + }, + "GetTable": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "Name" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Table": { + "shape": "S9s" + } + } + } + }, + "GetTableVersion": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "VersionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "TableVersion": { + "shape": "S9v" + } + } + } + }, + "GetTableVersions": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableVersions": { + "type": "list", + "member": { + "shape": "S9v" + } + }, + "NextToken": {} + } + } + }, + "GetTables": { + "input": { + "type": "structure", + "required": [ + "DatabaseName" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "Expression": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableList": { + "type": "list", + "member": { + "shape": "S9s" + } + }, + "NextToken": {} + } + } + }, + "GetTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S4v" + } + } + } + }, + "GetTrigger": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Trigger": { + "shape": "S3m" + } + } + } + }, + "GetTriggers": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "DependentJobName": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Triggers": { + "shape": "S3l" + }, + "NextToken": {} + } + } + }, + "GetUserDefinedFunction": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "FunctionName" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "FunctionName": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserDefinedFunction": { + "shape": "Sac" + } + } + } + }, + "GetUserDefinedFunctions": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "Pattern" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "Pattern": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserDefinedFunctions": { + "type": "list", + "member": { + "shape": "Sac" + } + }, + "NextToken": {} + } + } + }, + "ImportCatalogToGlue": { + "input": { + "type": "structure", + "members": { + "CatalogId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListCrawlers": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Tags": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": { + "CrawlerNames": { + "shape": "S1j" + }, + "NextToken": {} + } + } + }, + "ListDevEndpoints": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Tags": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": { + "DevEndpointNames": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListJobs": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Tags": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobNames": { + "shape": "S2u" + }, + "NextToken": {} + } + } + }, + "ListTriggers": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "DependentJobName": {}, + "MaxResults": { + "type": "integer" + }, + "Tags": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": { + "TriggerNames": { + "shape": "S3j" + }, + "NextToken": {} + } + } + }, + "PutDataCatalogEncryptionSettings": { + "input": { + "type": "structure", + "required": [ + "DataCatalogEncryptionSettings" + ], + "members": { + "CatalogId": {}, + "DataCatalogEncryptionSettings": { + "shape": "S83" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutResourcePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyInJson" + ], + "members": { + "PolicyInJson": {}, + "PolicyHashCondition": {}, + "PolicyExistsCondition": {} + } + }, + "output": { + "type": "structure", + "members": { + "PolicyHash": {} + } + } + }, + "ResetJobBookmark": { + "input": { + "type": "structure", + "required": [ + "JobName" + ], + "members": { + "JobName": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobBookmarkEntry": { + "type": "structure", + "members": { + "JobName": {}, + "Version": { + "type": "integer" + }, + "Run": { + "type": "integer" + }, + "Attempt": { + "type": "integer" + }, + "JobBookmark": {} + } + } + } + } + }, + "StartCrawler": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartCrawlerSchedule": { + "input": { + "type": "structure", + "required": [ + "CrawlerName" + ], + "members": { + "CrawlerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartJobRun": { + "input": { + "type": "structure", + "required": [ + "JobName" + ], + "members": { + "JobName": {}, + "JobRunId": {}, + "Arguments": { + "shape": "S34" + }, + "AllocatedCapacity": { + "deprecated": true, + "deprecatedMessage": "This property is deprecated, use MaxCapacity instead.", + "type": "integer" + }, + "Timeout": { + "type": "integer" + }, + "MaxCapacity": { + "type": "double" + }, + "WorkerType": {}, + "NumberOfWorkers": { + "type": "integer" + }, + "SecurityConfiguration": {}, + "NotificationProperty": { + "shape": "S3b" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobRunId": {} + } + } + }, + "StartTrigger": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "StopCrawler": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopCrawlerSchedule": { + "input": { + "type": "structure", + "required": [ + "CrawlerName" + ], + "members": { + "CrawlerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopTrigger": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagsToAdd" + ], + "members": { + "ResourceArn": {}, + "TagsToAdd": { + "shape": "S4v" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagsToRemove" + ], + "members": { + "ResourceArn": {}, + "TagsToRemove": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateClassifier": { + "input": { + "type": "structure", + "members": { + "GrokClassifier": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Classification": {}, + "GrokPattern": {}, + "CustomPatterns": {} + } + }, + "XMLClassifier": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Classification": {}, + "RowTag": {} + } + }, + "JsonClassifier": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "JsonPath": {} + } + }, + "CsvClassifier": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Delimiter": {}, + "QuoteSymbol": {}, + "ContainsHeader": {}, + "Header": { + "shape": "S4i" + }, + "DisableValueTrimming": { + "type": "boolean" + }, + "AllowSingleColumn": { + "type": "boolean" + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateConnection": { + "input": { + "type": "structure", + "required": [ + "Name", + "ConnectionInput" + ], + "members": { + "CatalogId": {}, + "Name": {}, + "ConnectionInput": { + "shape": "S4m" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateCrawler": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Role": {}, + "DatabaseName": {}, + "Description": {}, + "Targets": { + "shape": "S1o" + }, + "Schedule": {}, + "Classifiers": { + "shape": "S1z" + }, + "TablePrefix": {}, + "SchemaChangePolicy": { + "shape": "S20" + }, + "Configuration": {}, + "CrawlerSecurityConfiguration": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateCrawlerSchedule": { + "input": { + "type": "structure", + "required": [ + "CrawlerName" + ], + "members": { + "CrawlerName": {}, + "Schedule": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDatabase": { + "input": { + "type": "structure", + "required": [ + "Name", + "DatabaseInput" + ], + "members": { + "CatalogId": {}, + "Name": {}, + "DatabaseInput": { + "shape": "S50" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDevEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName" + ], + "members": { + "EndpointName": {}, + "PublicKey": {}, + "AddPublicKeys": { + "shape": "S2r" + }, + "DeletePublicKeys": { + "shape": "S2r" + }, + "CustomLibraries": { + "type": "structure", + "members": { + "ExtraPythonLibsS3Path": {}, + "ExtraJarsS3Path": {} + } + }, + "UpdateEtlLibraries": { + "type": "boolean" + }, + "DeleteArguments": { + "shape": "S2o" + }, + "AddArguments": { + "shape": "S2s" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateJob": { + "input": { + "type": "structure", + "required": [ + "JobName", + "JobUpdate" + ], + "members": { + "JobName": {}, + "JobUpdate": { + "type": "structure", + "members": { + "Description": {}, + "LogUri": {}, + "Role": {}, + "ExecutionProperty": { + "shape": "S30" + }, + "Command": { + "shape": "S32" + }, + "DefaultArguments": { + "shape": "S34" + }, + "Connections": { + "shape": "S35" + }, + "MaxRetries": { + "type": "integer" + }, + "AllocatedCapacity": { + "deprecated": true, + "deprecatedMessage": "This property is deprecated, use MaxCapacity instead.", + "type": "integer" + }, + "Timeout": { + "type": "integer" + }, + "MaxCapacity": { + "type": "double" + }, + "WorkerType": {}, + "NumberOfWorkers": { + "type": "integer" + }, + "SecurityConfiguration": {}, + "NotificationProperty": { + "shape": "S3b" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "JobName": {} + } + } + }, + "UpdatePartition": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "PartitionValueList", + "PartitionInput" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableName": {}, + "PartitionValueList": { + "type": "list", + "member": {} + }, + "PartitionInput": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateTable": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "TableInput" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "TableInput": { + "shape": "S60" + }, + "SkipArchive": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateTrigger": { + "input": { + "type": "structure", + "required": [ + "Name", + "TriggerUpdate" + ], + "members": { + "Name": {}, + "TriggerUpdate": { + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "Schedule": {}, + "Actions": { + "shape": "S3q" + }, + "Predicate": { + "shape": "S3s" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Trigger": { + "shape": "S3m" + } + } + } + }, + "UpdateUserDefinedFunction": { + "input": { + "type": "structure", + "required": [ + "DatabaseName", + "FunctionName", + "FunctionInput" + ], + "members": { + "CatalogId": {}, + "DatabaseName": {}, + "FunctionName": {}, + "FunctionInput": { + "shape": "S69" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "members": { + "Values": { + "shape": "S6" + }, + "LastAccessTime": { + "type": "timestamp" + }, + "StorageDescriptor": { + "shape": "S9" + }, + "Parameters": { + "shape": "Sj" + }, + "LastAnalyzedTime": { + "type": "timestamp" + } + } + }, + "S6": { + "type": "list", + "member": {} + }, + "S9": { + "type": "structure", + "members": { + "Columns": { + "shape": "Sa" + }, + "Location": {}, + "InputFormat": {}, + "OutputFormat": {}, + "Compressed": { + "type": "boolean" + }, + "NumberOfBuckets": { + "type": "integer" + }, + "SerdeInfo": { + "type": "structure", + "members": { + "Name": {}, + "SerializationLibrary": {}, + "Parameters": { + "shape": "Sj" + } + } + }, + "BucketColumns": { + "shape": "Sm" + }, + "SortColumns": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Column", + "SortOrder" + ], + "members": { + "Column": {}, + "SortOrder": { + "type": "integer" + } + } + } + }, + "Parameters": { + "shape": "Sj" + }, + "SkewedInfo": { + "type": "structure", + "members": { + "SkewedColumnNames": { + "shape": "Sm" + }, + "SkewedColumnValues": { + "type": "list", + "member": {} + }, + "SkewedColumnValueLocationMaps": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "StoredAsSubDirectories": { + "type": "boolean" + } + } + }, + "Sa": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Type": {}, + "Comment": {} + } + } + }, + "Sj": { + "type": "map", + "key": {}, + "value": {} + }, + "Sm": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PartitionValues": { + "shape": "S6" + }, + "ErrorDetail": { + "shape": "Sx" + } + } + } + }, + "Sx": { + "type": "structure", + "members": { + "ErrorCode": {}, + "ErrorMessage": {} + } + }, + "S15": { + "type": "structure", + "required": [ + "Values" + ], + "members": { + "Values": { + "shape": "S6" + } + } + }, + "S1j": { + "type": "list", + "member": {} + }, + "S1l": { + "type": "list", + "member": { + "shape": "S1m" + } + }, + "S1m": { + "type": "structure", + "members": { + "Name": {}, + "Role": {}, + "Targets": { + "shape": "S1o" + }, + "DatabaseName": {}, + "Description": {}, + "Classifiers": { + "shape": "S1z" + }, + "SchemaChangePolicy": { + "shape": "S20" + }, + "State": {}, + "TablePrefix": {}, + "Schedule": { + "type": "structure", + "members": { + "ScheduleExpression": {}, + "State": {} + } + }, + "CrawlElapsedTime": { + "type": "long" + }, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdated": { + "type": "timestamp" + }, + "LastCrawl": { + "type": "structure", + "members": { + "Status": {}, + "ErrorMessage": {}, + "LogGroup": {}, + "LogStream": {}, + "MessagePrefix": {}, + "StartTime": { + "type": "timestamp" + } + } + }, + "Version": { + "type": "long" + }, + "Configuration": {}, + "CrawlerSecurityConfiguration": {} + } + }, + "S1o": { + "type": "structure", + "members": { + "S3Targets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "Exclusions": { + "shape": "S1s" + } + } + } + }, + "JdbcTargets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ConnectionName": {}, + "Path": {}, + "Exclusions": { + "shape": "S1s" + } + } + } + }, + "DynamoDBTargets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {} + } + } + } + } + }, + "S1s": { + "type": "list", + "member": {} + }, + "S1z": { + "type": "list", + "member": {} + }, + "S20": { + "type": "structure", + "members": { + "UpdateBehavior": {}, + "DeleteBehavior": {} + } + }, + "S2i": { + "type": "list", + "member": {} + }, + "S2l": { + "type": "list", + "member": { + "shape": "S2m" + } + }, + "S2m": { + "type": "structure", + "members": { + "EndpointName": {}, + "RoleArn": {}, + "SecurityGroupIds": { + "shape": "S2o" + }, + "SubnetId": {}, + "YarnEndpointAddress": {}, + "PrivateAddress": {}, + "ZeppelinRemoteSparkInterpreterPort": { + "type": "integer" + }, + "PublicAddress": {}, + "Status": {}, + "NumberOfNodes": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "ExtraPythonLibsS3Path": {}, + "ExtraJarsS3Path": {}, + "FailureReason": {}, + "LastUpdateStatus": {}, + "CreatedTimestamp": { + "type": "timestamp" + }, + "LastModifiedTimestamp": { + "type": "timestamp" + }, + "PublicKey": {}, + "PublicKeys": { + "shape": "S2r" + }, + "SecurityConfiguration": {}, + "Arguments": { + "shape": "S2s" + } + } + }, + "S2o": { + "type": "list", + "member": {} + }, + "S2r": { + "type": "list", + "member": {} + }, + "S2s": { + "type": "map", + "key": {}, + "value": {} + }, + "S2u": { + "type": "list", + "member": {} + }, + "S2w": { + "type": "list", + "member": { + "shape": "S2x" + } + }, + "S2x": { + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "LogUri": {}, + "Role": {}, + "CreatedOn": { + "type": "timestamp" + }, + "LastModifiedOn": { + "type": "timestamp" + }, + "ExecutionProperty": { + "shape": "S30" + }, + "Command": { + "shape": "S32" + }, + "DefaultArguments": { + "shape": "S34" + }, + "Connections": { + "shape": "S35" + }, + "MaxRetries": { + "type": "integer" + }, + "AllocatedCapacity": { + "deprecated": true, + "deprecatedMessage": "This property is deprecated, use MaxCapacity instead.", + "type": "integer" + }, + "Timeout": { + "type": "integer" + }, + "MaxCapacity": { + "type": "double" + }, + "WorkerType": {}, + "NumberOfWorkers": { + "type": "integer" + }, + "SecurityConfiguration": {}, + "NotificationProperty": { + "shape": "S3b" + } + } + }, + "S30": { + "type": "structure", + "members": { + "MaxConcurrentRuns": { + "type": "integer" + } + } + }, + "S32": { + "type": "structure", + "members": { + "Name": {}, + "ScriptLocation": {} + } + }, + "S34": { + "type": "map", + "key": {}, + "value": {} + }, + "S35": { + "type": "structure", + "members": { + "Connections": { + "shape": "S2o" + } + } + }, + "S3b": { + "type": "structure", + "members": { + "NotifyDelayAfter": { + "type": "integer" + } + } + }, + "S3e": { + "type": "list", + "member": { + "shape": "S15" + } + }, + "S3g": { + "type": "list", + "member": { + "shape": "S3h" + } + }, + "S3h": { + "type": "structure", + "members": { + "Values": { + "shape": "S6" + }, + "DatabaseName": {}, + "TableName": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastAccessTime": { + "type": "timestamp" + }, + "StorageDescriptor": { + "shape": "S9" + }, + "Parameters": { + "shape": "Sj" + }, + "LastAnalyzedTime": { + "type": "timestamp" + } + } + }, + "S3j": { + "type": "list", + "member": {} + }, + "S3l": { + "type": "list", + "member": { + "shape": "S3m" + } + }, + "S3m": { + "type": "structure", + "members": { + "Name": {}, + "Id": {}, + "Type": {}, + "State": {}, + "Description": {}, + "Schedule": {}, + "Actions": { + "shape": "S3q" + }, + "Predicate": { + "shape": "S3s" + } + } + }, + "S3q": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobName": {}, + "Arguments": { + "shape": "S34" + }, + "Timeout": { + "type": "integer" + }, + "NotificationProperty": { + "shape": "S3b" + }, + "SecurityConfiguration": {} + } + } + }, + "S3s": { + "type": "structure", + "members": { + "Logical": {}, + "Conditions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LogicalOperator": {}, + "JobName": {}, + "State": {} + } + } + } + } + }, + "S4i": { + "type": "list", + "member": {} + }, + "S4m": { + "type": "structure", + "required": [ + "Name", + "ConnectionType", + "ConnectionProperties" + ], + "members": { + "Name": {}, + "Description": {}, + "ConnectionType": {}, + "MatchCriteria": { + "shape": "S4o" + }, + "ConnectionProperties": { + "shape": "S4p" + }, + "PhysicalConnectionRequirements": { + "shape": "S4r" + } + } + }, + "S4o": { + "type": "list", + "member": {} + }, + "S4p": { + "type": "map", + "key": {}, + "value": {} + }, + "S4r": { + "type": "structure", + "members": { + "SubnetId": {}, + "SecurityGroupIdList": { + "type": "list", + "member": {} + }, + "AvailabilityZone": {} + } + }, + "S4v": { + "type": "map", + "key": {}, + "value": {} + }, + "S50": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Description": {}, + "LocationUri": {}, + "Parameters": { + "shape": "Sj" + } + } + }, + "S5a": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id", + "NodeType", + "Args" + ], + "members": { + "Id": {}, + "NodeType": {}, + "Args": { + "shape": "S5e" + }, + "LineNumber": { + "type": "integer" + } + } + } + }, + "S5e": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {}, + "Param": { + "type": "boolean" + } + } + } + }, + "S5i": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Source", + "Target" + ], + "members": { + "Source": {}, + "Target": {}, + "TargetParameter": {} + } + } + }, + "S5p": { + "type": "structure", + "members": { + "S3Encryption": { + "type": "list", + "member": { + "type": "structure", + "members": { + "S3EncryptionMode": {}, + "KmsKeyArn": {} + } + } + }, + "CloudWatchEncryption": { + "type": "structure", + "members": { + "CloudWatchEncryptionMode": {}, + "KmsKeyArn": {} + } + }, + "JobBookmarksEncryption": { + "type": "structure", + "members": { + "JobBookmarksEncryptionMode": {}, + "KmsKeyArn": {} + } + } + } + }, + "S60": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Description": {}, + "Owner": {}, + "LastAccessTime": { + "type": "timestamp" + }, + "LastAnalyzedTime": { + "type": "timestamp" + }, + "Retention": { + "type": "integer" + }, + "StorageDescriptor": { + "shape": "S9" + }, + "PartitionKeys": { + "shape": "Sa" + }, + "ViewOriginalText": {}, + "ViewExpandedText": {}, + "TableType": {}, + "Parameters": { + "shape": "Sj" + } + } + }, + "S69": { + "type": "structure", + "members": { + "FunctionName": {}, + "ClassName": {}, + "OwnerName": {}, + "OwnerType": {}, + "ResourceUris": { + "shape": "S6b" + } + } + }, + "S6b": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceType": {}, + "Uri": {} + } + } + }, + "S7b": { + "type": "structure", + "members": { + "GrokClassifier": { + "type": "structure", + "required": [ + "Name", + "Classification", + "GrokPattern" + ], + "members": { + "Name": {}, + "Classification": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdated": { + "type": "timestamp" + }, + "Version": { + "type": "long" + }, + "GrokPattern": {}, + "CustomPatterns": {} + } + }, + "XMLClassifier": { + "type": "structure", + "required": [ + "Name", + "Classification" + ], + "members": { + "Name": {}, + "Classification": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdated": { + "type": "timestamp" + }, + "Version": { + "type": "long" + }, + "RowTag": {} + } + }, + "JsonClassifier": { + "type": "structure", + "required": [ + "Name", + "JsonPath" + ], + "members": { + "Name": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdated": { + "type": "timestamp" + }, + "Version": { + "type": "long" + }, + "JsonPath": {} + } + }, + "CsvClassifier": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdated": { + "type": "timestamp" + }, + "Version": { + "type": "long" + }, + "Delimiter": {}, + "QuoteSymbol": {}, + "ContainsHeader": {}, + "Header": { + "shape": "S4i" + }, + "DisableValueTrimming": { + "type": "boolean" + }, + "AllowSingleColumn": { + "type": "boolean" + } + } + } + } + }, + "S7n": { + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "ConnectionType": {}, + "MatchCriteria": { + "shape": "S4o" + }, + "ConnectionProperties": { + "shape": "S4p" + }, + "PhysicalConnectionRequirements": { + "shape": "S4r" + }, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + }, + "LastUpdatedBy": {} + } + }, + "S83": { + "type": "structure", + "members": { + "EncryptionAtRest": { + "type": "structure", + "required": [ + "CatalogEncryptionMode" + ], + "members": { + "CatalogEncryptionMode": {}, + "SseAwsKmsKeyId": {} + } + }, + "ConnectionPasswordEncryption": { + "type": "structure", + "required": [ + "ReturnConnectionPasswordEncrypted" + ], + "members": { + "ReturnConnectionPasswordEncrypted": { + "type": "boolean" + }, + "AwsKmsKeyId": {} + } + } + } + }, + "S89": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Description": {}, + "LocationUri": {}, + "Parameters": { + "shape": "Sj" + }, + "CreateTime": { + "type": "timestamp" + } + } + }, + "S8n": { + "type": "structure", + "members": { + "Id": {}, + "Attempt": { + "type": "integer" + }, + "PreviousRunId": {}, + "TriggerName": {}, + "JobName": {}, + "StartedOn": { + "type": "timestamp" + }, + "LastModifiedOn": { + "type": "timestamp" + }, + "CompletedOn": { + "type": "timestamp" + }, + "JobRunState": {}, + "Arguments": { + "shape": "S34" + }, + "ErrorMessage": {}, + "PredecessorRuns": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobName": {}, + "RunId": {} + } + } + }, + "AllocatedCapacity": { + "deprecated": true, + "deprecatedMessage": "This property is deprecated, use MaxCapacity instead.", + "type": "integer" + }, + "ExecutionTime": { + "type": "integer" + }, + "Timeout": { + "type": "integer" + }, + "MaxCapacity": { + "type": "double" + }, + "NotificationProperty": { + "shape": "S3b" + }, + "WorkerType": {}, + "NumberOfWorkers": { + "type": "integer" + }, + "SecurityConfiguration": {}, + "LogGroupName": {} + } + }, + "S8z": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName" + ], + "members": { + "DatabaseName": {}, + "TableName": {} + } + }, + "S90": { + "type": "list", + "member": { + "shape": "S8z" + } + }, + "S91": { + "type": "structure", + "members": { + "Jdbc": { + "shape": "S5e" + }, + "S3": { + "shape": "S5e" + }, + "DynamoDB": { + "shape": "S5e" + } + } + }, + "S93": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceTable": {}, + "SourcePath": {}, + "SourceType": {}, + "TargetTable": {}, + "TargetPath": {}, + "TargetType": {} + } + } + }, + "S9m": { + "type": "structure", + "members": { + "Name": {}, + "CreatedTimeStamp": { + "type": "timestamp" + }, + "EncryptionConfiguration": { + "shape": "S5p" + } + } + }, + "S9s": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "DatabaseName": {}, + "Description": {}, + "Owner": {}, + "CreateTime": { + "type": "timestamp" + }, + "UpdateTime": { + "type": "timestamp" + }, + "LastAccessTime": { + "type": "timestamp" + }, + "LastAnalyzedTime": { + "type": "timestamp" + }, + "Retention": { + "type": "integer" + }, + "StorageDescriptor": { + "shape": "S9" + }, + "PartitionKeys": { + "shape": "Sa" + }, + "ViewOriginalText": {}, + "ViewExpandedText": {}, + "TableType": {}, + "Parameters": { + "shape": "Sj" + }, + "CreatedBy": {} + } + }, + "S9v": { + "type": "structure", + "members": { + "Table": { + "shape": "S9s" + }, + "VersionId": {} + } + }, + "Sac": { + "type": "structure", + "members": { + "FunctionName": {}, + "ClassName": {}, + "OwnerName": {}, + "OwnerType": {}, + "CreateTime": { + "type": "timestamp" + }, + "ResourceUris": { + "shape": "S6b" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json b/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json new file mode 100644 index 0000000..cba25d9 --- /dev/null +++ b/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json @@ -0,0 +1,95 @@ +{ + "pagination": { + "GetClassifiers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetConnections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetCrawlerMetrics": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetCrawlers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetDatabases": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetDevEndpoints": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetJobRuns": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetPartitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetSecurityConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SecurityConfigurations" + }, + "GetTableVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetTables": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetTriggers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetUserDefinedFunctions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListCrawlers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListDevEndpoints": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListTriggers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/greengrass-2017-06-07.min.json b/node_modules/aws-sdk/apis/greengrass-2017-06-07.min.json new file mode 100644 index 0000000..e1a11f6 --- /dev/null +++ b/node_modules/aws-sdk/apis/greengrass-2017-06-07.min.json @@ -0,0 +1,3202 @@ +{ + "metadata": { + "apiVersion": "2017-06-07", + "endpointPrefix": "greengrass", + "signingName": "greengrass", + "serviceFullName": "AWS Greengrass", + "serviceId": "Greengrass", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "greengrass-2017-06-07", + "signatureVersion": "v4" + }, + "operations": { + "AssociateRoleToGroup": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/groups/{GroupId}/role", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + }, + "RoleArn": {} + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "AssociatedAt": {} + } + } + }, + "AssociateServiceRoleToAccount": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/servicerole", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "RoleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "AssociatedAt": {} + } + } + }, + "CreateConnectorDefinition": { + "http": { + "requestUri": "/greengrass/definition/connectors", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "S7" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateConnectorDefinitionVersion": { + "http": { + "requestUri": "/greengrass/definition/connectors/{ConnectorDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "ConnectorDefinitionId": { + "location": "uri", + "locationName": "ConnectorDefinitionId" + }, + "Connectors": { + "shape": "S8" + } + }, + "required": [ + "ConnectorDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "CreateCoreDefinition": { + "http": { + "requestUri": "/greengrass/definition/cores", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "Sg" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateCoreDefinitionVersion": { + "http": { + "requestUri": "/greengrass/definition/cores/{CoreDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "CoreDefinitionId": { + "location": "uri", + "locationName": "CoreDefinitionId" + }, + "Cores": { + "shape": "Sh" + } + }, + "required": [ + "CoreDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "CreateDeployment": { + "http": { + "requestUri": "/greengrass/groups/{GroupId}/deployments", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "DeploymentId": {}, + "DeploymentType": {}, + "GroupId": { + "location": "uri", + "locationName": "GroupId" + }, + "GroupVersionId": {} + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "DeploymentArn": {}, + "DeploymentId": {} + } + } + }, + "CreateDeviceDefinition": { + "http": { + "requestUri": "/greengrass/definition/devices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "Sr" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateDeviceDefinitionVersion": { + "http": { + "requestUri": "/greengrass/definition/devices/{DeviceDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "DeviceDefinitionId": { + "location": "uri", + "locationName": "DeviceDefinitionId" + }, + "Devices": { + "shape": "Ss" + } + }, + "required": [ + "DeviceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "CreateFunctionDefinition": { + "http": { + "requestUri": "/greengrass/definition/functions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "Sy" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateFunctionDefinitionVersion": { + "http": { + "requestUri": "/greengrass/definition/functions/{FunctionDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "DefaultConfig": { + "shape": "Sz" + }, + "FunctionDefinitionId": { + "location": "uri", + "locationName": "FunctionDefinitionId" + }, + "Functions": { + "shape": "S14" + } + }, + "required": [ + "FunctionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "CreateGroup": { + "http": { + "requestUri": "/greengrass/groups", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "S1h" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateGroupCertificateAuthority": { + "http": { + "requestUri": "/greengrass/groups/{GroupId}/certificateauthorities", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "GroupCertificateAuthorityArn": {} + } + } + }, + "CreateGroupVersion": { + "http": { + "requestUri": "/greengrass/groups/{GroupId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "ConnectorDefinitionVersionArn": {}, + "CoreDefinitionVersionArn": {}, + "DeviceDefinitionVersionArn": {}, + "FunctionDefinitionVersionArn": {}, + "GroupId": { + "location": "uri", + "locationName": "GroupId" + }, + "LoggerDefinitionVersionArn": {}, + "ResourceDefinitionVersionArn": {}, + "SubscriptionDefinitionVersionArn": {} + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "CreateLoggerDefinition": { + "http": { + "requestUri": "/greengrass/definition/loggers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "S1o" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateLoggerDefinitionVersion": { + "http": { + "requestUri": "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "LoggerDefinitionId": { + "location": "uri", + "locationName": "LoggerDefinitionId" + }, + "Loggers": { + "shape": "S1p" + } + }, + "required": [ + "LoggerDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "CreateResourceDefinition": { + "http": { + "requestUri": "/greengrass/definition/resources", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "S1y" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateResourceDefinitionVersion": { + "http": { + "requestUri": "/greengrass/definition/resources/{ResourceDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "ResourceDefinitionId": { + "location": "uri", + "locationName": "ResourceDefinitionId" + }, + "Resources": { + "shape": "S1z" + } + }, + "required": [ + "ResourceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "CreateSoftwareUpdateJob": { + "http": { + "requestUri": "/greengrass/updates", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "S3UrlSignerRole": {}, + "SoftwareToUpdate": {}, + "UpdateAgentLogLevel": {}, + "UpdateTargets": { + "type": "list", + "member": {} + }, + "UpdateTargetsArchitecture": {}, + "UpdateTargetsOperatingSystem": {} + } + }, + "output": { + "type": "structure", + "members": { + "IotJobArn": {}, + "IotJobId": {} + } + } + }, + "CreateSubscriptionDefinition": { + "http": { + "requestUri": "/greengrass/definition/subscriptions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "InitialVersion": { + "shape": "S2l" + }, + "Name": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "CreateSubscriptionDefinitionVersion": { + "http": { + "requestUri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "SubscriptionDefinitionId": { + "location": "uri", + "locationName": "SubscriptionDefinitionId" + }, + "Subscriptions": { + "shape": "S2m" + } + }, + "required": [ + "SubscriptionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "tags": { + "shape": "Sa" + } + }, + "required": [ + "ResourceArn", + "tags" + ] + } + }, + "DeleteConnectorDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/definition/connectors/{ConnectorDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConnectorDefinitionId": { + "location": "uri", + "locationName": "ConnectorDefinitionId" + } + }, + "required": [ + "ConnectorDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteCoreDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/definition/cores/{CoreDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CoreDefinitionId": { + "location": "uri", + "locationName": "CoreDefinitionId" + } + }, + "required": [ + "CoreDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDeviceDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/definition/devices/{DeviceDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceDefinitionId": { + "location": "uri", + "locationName": "DeviceDefinitionId" + } + }, + "required": [ + "DeviceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteFunctionDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/definition/functions/{FunctionDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "FunctionDefinitionId": { + "location": "uri", + "locationName": "FunctionDefinitionId" + } + }, + "required": [ + "FunctionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteGroup": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/groups/{GroupId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteLoggerDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/definition/loggers/{LoggerDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "LoggerDefinitionId": { + "location": "uri", + "locationName": "LoggerDefinitionId" + } + }, + "required": [ + "LoggerDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteResourceDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/definition/resources/{ResourceDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceDefinitionId": { + "location": "uri", + "locationName": "ResourceDefinitionId" + } + }, + "required": [ + "ResourceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSubscriptionDefinition": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "SubscriptionDefinitionId": { + "location": "uri", + "locationName": "SubscriptionDefinitionId" + } + }, + "required": [ + "SubscriptionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "shape": "S28", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + } + }, + "DisassociateRoleFromGroup": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/groups/{GroupId}/role", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "DisassociatedAt": {} + } + } + }, + "DisassociateServiceRoleFromAccount": { + "http": { + "method": "DELETE", + "requestUri": "/greengrass/servicerole", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "DisassociatedAt": {} + } + } + }, + "GetAssociatedRole": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/role", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "AssociatedAt": {}, + "RoleArn": {} + } + } + }, + "GetBulkDeploymentStatus": { + "http": { + "method": "GET", + "requestUri": "/greengrass/bulk/deployments/{BulkDeploymentId}/status", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BulkDeploymentId": { + "location": "uri", + "locationName": "BulkDeploymentId" + } + }, + "required": [ + "BulkDeploymentId" + ] + }, + "output": { + "type": "structure", + "members": { + "BulkDeploymentMetrics": { + "type": "structure", + "members": { + "InvalidInputRecords": { + "type": "integer" + }, + "RecordsProcessed": { + "type": "integer" + }, + "RetryAttempts": { + "type": "integer" + } + } + }, + "BulkDeploymentStatus": {}, + "CreatedAt": {}, + "ErrorDetails": { + "shape": "S3j" + }, + "ErrorMessage": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetConnectivityInfo": { + "http": { + "method": "GET", + "requestUri": "/greengrass/things/{ThingName}/connectivityInfo", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ThingName": { + "location": "uri", + "locationName": "ThingName" + } + }, + "required": [ + "ThingName" + ] + }, + "output": { + "type": "structure", + "members": { + "ConnectivityInfo": { + "shape": "S3n" + }, + "Message": { + "locationName": "message" + } + } + } + }, + "GetConnectorDefinition": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/connectors/{ConnectorDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConnectorDefinitionId": { + "location": "uri", + "locationName": "ConnectorDefinitionId" + } + }, + "required": [ + "ConnectorDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetConnectorDefinitionVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/connectors/{ConnectorDefinitionId}/versions/{ConnectorDefinitionVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConnectorDefinitionId": { + "location": "uri", + "locationName": "ConnectorDefinitionId" + }, + "ConnectorDefinitionVersionId": { + "location": "uri", + "locationName": "ConnectorDefinitionVersionId" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "ConnectorDefinitionId", + "ConnectorDefinitionVersionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "S7" + }, + "Id": {}, + "NextToken": {}, + "Version": {} + } + } + }, + "GetCoreDefinition": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/cores/{CoreDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CoreDefinitionId": { + "location": "uri", + "locationName": "CoreDefinitionId" + } + }, + "required": [ + "CoreDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetCoreDefinitionVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/cores/{CoreDefinitionId}/versions/{CoreDefinitionVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CoreDefinitionId": { + "location": "uri", + "locationName": "CoreDefinitionId" + }, + "CoreDefinitionVersionId": { + "location": "uri", + "locationName": "CoreDefinitionVersionId" + } + }, + "required": [ + "CoreDefinitionId", + "CoreDefinitionVersionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "Sg" + }, + "Id": {}, + "NextToken": {}, + "Version": {} + } + } + }, + "GetDeploymentStatus": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/deployments/{DeploymentId}/status", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeploymentId": { + "location": "uri", + "locationName": "DeploymentId" + }, + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId", + "DeploymentId" + ] + }, + "output": { + "type": "structure", + "members": { + "DeploymentStatus": {}, + "DeploymentType": {}, + "ErrorDetails": { + "shape": "S3j" + }, + "ErrorMessage": {}, + "UpdatedAt": {} + } + } + }, + "GetDeviceDefinition": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/devices/{DeviceDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceDefinitionId": { + "location": "uri", + "locationName": "DeviceDefinitionId" + } + }, + "required": [ + "DeviceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetDeviceDefinitionVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/devices/{DeviceDefinitionId}/versions/{DeviceDefinitionVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceDefinitionId": { + "location": "uri", + "locationName": "DeviceDefinitionId" + }, + "DeviceDefinitionVersionId": { + "location": "uri", + "locationName": "DeviceDefinitionVersionId" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "DeviceDefinitionVersionId", + "DeviceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "Sr" + }, + "Id": {}, + "NextToken": {}, + "Version": {} + } + } + }, + "GetFunctionDefinition": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/functions/{FunctionDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "FunctionDefinitionId": { + "location": "uri", + "locationName": "FunctionDefinitionId" + } + }, + "required": [ + "FunctionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetFunctionDefinitionVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/functions/{FunctionDefinitionId}/versions/{FunctionDefinitionVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "FunctionDefinitionId": { + "location": "uri", + "locationName": "FunctionDefinitionId" + }, + "FunctionDefinitionVersionId": { + "location": "uri", + "locationName": "FunctionDefinitionVersionId" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "FunctionDefinitionId", + "FunctionDefinitionVersionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "Sy" + }, + "Id": {}, + "NextToken": {}, + "Version": {} + } + } + }, + "GetGroup": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetGroupCertificateAuthority": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/certificateauthorities/{CertificateAuthorityId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CertificateAuthorityId": { + "location": "uri", + "locationName": "CertificateAuthorityId" + }, + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "CertificateAuthorityId", + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "GroupCertificateAuthorityArn": {}, + "GroupCertificateAuthorityId": {}, + "PemEncodedCertificate": {} + } + } + }, + "GetGroupCertificateConfiguration": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "CertificateAuthorityExpiryInMilliseconds": {}, + "CertificateExpiryInMilliseconds": {}, + "GroupId": {} + } + } + }, + "GetGroupVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/versions/{GroupVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + }, + "GroupVersionId": { + "location": "uri", + "locationName": "GroupVersionId" + } + }, + "required": [ + "GroupVersionId", + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "S1h" + }, + "Id": {}, + "Version": {} + } + } + }, + "GetLoggerDefinition": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/loggers/{LoggerDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "LoggerDefinitionId": { + "location": "uri", + "locationName": "LoggerDefinitionId" + } + }, + "required": [ + "LoggerDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetLoggerDefinitionVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/loggers/{LoggerDefinitionId}/versions/{LoggerDefinitionVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "LoggerDefinitionId": { + "location": "uri", + "locationName": "LoggerDefinitionId" + }, + "LoggerDefinitionVersionId": { + "location": "uri", + "locationName": "LoggerDefinitionVersionId" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "LoggerDefinitionVersionId", + "LoggerDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "S1o" + }, + "Id": {}, + "Version": {} + } + } + }, + "GetResourceDefinition": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/resources/{ResourceDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceDefinitionId": { + "location": "uri", + "locationName": "ResourceDefinitionId" + } + }, + "required": [ + "ResourceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetResourceDefinitionVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/resources/{ResourceDefinitionId}/versions/{ResourceDefinitionVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceDefinitionId": { + "location": "uri", + "locationName": "ResourceDefinitionId" + }, + "ResourceDefinitionVersionId": { + "location": "uri", + "locationName": "ResourceDefinitionVersionId" + } + }, + "required": [ + "ResourceDefinitionVersionId", + "ResourceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "S1y" + }, + "Id": {}, + "Version": {} + } + } + }, + "GetServiceRoleForAccount": { + "http": { + "method": "GET", + "requestUri": "/greengrass/servicerole", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AssociatedAt": {}, + "RoleArn": {} + } + } + }, + "GetSubscriptionDefinition": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "SubscriptionDefinitionId": { + "location": "uri", + "locationName": "SubscriptionDefinitionId" + } + }, + "required": [ + "SubscriptionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "tags": { + "shape": "Sa" + } + } + } + }, + "GetSubscriptionDefinitionVersion": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "SubscriptionDefinitionId": { + "location": "uri", + "locationName": "SubscriptionDefinitionId" + }, + "SubscriptionDefinitionVersionId": { + "location": "uri", + "locationName": "SubscriptionDefinitionVersionId" + } + }, + "required": [ + "SubscriptionDefinitionId", + "SubscriptionDefinitionVersionId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Definition": { + "shape": "S2l" + }, + "Id": {}, + "NextToken": {}, + "Version": {} + } + } + }, + "ListBulkDeploymentDetailedReports": { + "http": { + "method": "GET", + "requestUri": "/greengrass/bulk/deployments/{BulkDeploymentId}/detailed-reports", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BulkDeploymentId": { + "location": "uri", + "locationName": "BulkDeploymentId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "BulkDeploymentId" + ] + }, + "output": { + "type": "structure", + "members": { + "Deployments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CreatedAt": {}, + "DeploymentArn": {}, + "DeploymentId": {}, + "DeploymentStatus": {}, + "DeploymentType": {}, + "ErrorDetails": { + "shape": "S3j" + }, + "ErrorMessage": {}, + "GroupArn": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListBulkDeployments": { + "http": { + "method": "GET", + "requestUri": "/greengrass/bulk/deployments", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "BulkDeployments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BulkDeploymentArn": {}, + "BulkDeploymentId": {}, + "CreatedAt": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListConnectorDefinitionVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/connectors/{ConnectorDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConnectorDefinitionId": { + "location": "uri", + "locationName": "ConnectorDefinitionId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "ConnectorDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListConnectorDefinitions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/connectors", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Definitions": { + "shape": "S57" + }, + "NextToken": {} + } + } + }, + "ListCoreDefinitionVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/cores/{CoreDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CoreDefinitionId": { + "location": "uri", + "locationName": "CoreDefinitionId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "CoreDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListCoreDefinitions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/cores", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Definitions": { + "shape": "S57" + }, + "NextToken": {} + } + } + }, + "ListDeployments": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/deployments", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "Deployments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CreatedAt": {}, + "DeploymentArn": {}, + "DeploymentId": {}, + "DeploymentType": {}, + "GroupArn": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListDeviceDefinitionVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/devices/{DeviceDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceDefinitionId": { + "location": "uri", + "locationName": "DeviceDefinitionId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "DeviceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListDeviceDefinitions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/devices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Definitions": { + "shape": "S57" + }, + "NextToken": {} + } + } + }, + "ListFunctionDefinitionVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/functions/{FunctionDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "FunctionDefinitionId": { + "location": "uri", + "locationName": "FunctionDefinitionId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "FunctionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListFunctionDefinitions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/functions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Definitions": { + "shape": "S57" + }, + "NextToken": {} + } + } + }, + "ListGroupCertificateAuthorities": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/certificateauthorities", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "GroupCertificateAuthorities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GroupCertificateAuthorityArn": {}, + "GroupCertificateAuthorityId": {} + } + } + } + } + } + }, + "ListGroupVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups/{GroupId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListGroups": { + "http": { + "method": "GET", + "requestUri": "/greengrass/groups", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Groups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListLoggerDefinitionVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "LoggerDefinitionId": { + "location": "uri", + "locationName": "LoggerDefinitionId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "required": [ + "LoggerDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListLoggerDefinitions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/loggers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Definitions": { + "shape": "S57" + }, + "NextToken": {} + } + } + }, + "ListResourceDefinitionVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/resources/{ResourceDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "ResourceDefinitionId": { + "location": "uri", + "locationName": "ResourceDefinitionId" + } + }, + "required": [ + "ResourceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListResourceDefinitions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/resources", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Definitions": { + "shape": "S57" + }, + "NextToken": {} + } + } + }, + "ListSubscriptionDefinitionVersions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "SubscriptionDefinitionId": { + "location": "uri", + "locationName": "SubscriptionDefinitionId" + } + }, + "required": [ + "SubscriptionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Versions": { + "shape": "S53" + } + } + } + }, + "ListSubscriptionDefinitions": { + "http": { + "method": "GET", + "requestUri": "/greengrass/definition/subscriptions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Definitions": { + "shape": "S57" + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Sa" + } + } + } + }, + "ResetDeployments": { + "http": { + "requestUri": "/greengrass/groups/{GroupId}/deployments/$reset", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "Force": { + "type": "boolean" + }, + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "DeploymentArn": {}, + "DeploymentId": {} + } + } + }, + "StartBulkDeployment": { + "http": { + "requestUri": "/greengrass/bulk/deployments", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AmznClientToken": { + "location": "header", + "locationName": "X-Amzn-Client-Token" + }, + "ExecutionRoleArn": {}, + "InputFileUri": {}, + "tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "BulkDeploymentArn": {}, + "BulkDeploymentId": {} + } + } + }, + "StopBulkDeployment": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/bulk/deployments/{BulkDeploymentId}/$stop", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BulkDeploymentId": { + "location": "uri", + "locationName": "BulkDeploymentId" + } + }, + "required": [ + "BulkDeploymentId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateConnectivityInfo": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/things/{ThingName}/connectivityInfo", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConnectivityInfo": { + "shape": "S3n" + }, + "ThingName": { + "location": "uri", + "locationName": "ThingName" + } + }, + "required": [ + "ThingName" + ] + }, + "output": { + "type": "structure", + "members": { + "Message": { + "locationName": "message" + }, + "Version": {} + } + } + }, + "UpdateConnectorDefinition": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/definition/connectors/{ConnectorDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConnectorDefinitionId": { + "location": "uri", + "locationName": "ConnectorDefinitionId" + }, + "Name": {} + }, + "required": [ + "ConnectorDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateCoreDefinition": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/definition/cores/{CoreDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CoreDefinitionId": { + "location": "uri", + "locationName": "CoreDefinitionId" + }, + "Name": {} + }, + "required": [ + "CoreDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDeviceDefinition": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/definition/devices/{DeviceDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceDefinitionId": { + "location": "uri", + "locationName": "DeviceDefinitionId" + }, + "Name": {} + }, + "required": [ + "DeviceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateFunctionDefinition": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/definition/functions/{FunctionDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "FunctionDefinitionId": { + "location": "uri", + "locationName": "FunctionDefinitionId" + }, + "Name": {} + }, + "required": [ + "FunctionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateGroup": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/groups/{GroupId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "GroupId": { + "location": "uri", + "locationName": "GroupId" + }, + "Name": {} + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateGroupCertificateConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CertificateExpiryInMilliseconds": {}, + "GroupId": { + "location": "uri", + "locationName": "GroupId" + } + }, + "required": [ + "GroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "CertificateAuthorityExpiryInMilliseconds": {}, + "CertificateExpiryInMilliseconds": {}, + "GroupId": {} + } + } + }, + "UpdateLoggerDefinition": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/definition/loggers/{LoggerDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "LoggerDefinitionId": { + "location": "uri", + "locationName": "LoggerDefinitionId" + }, + "Name": {} + }, + "required": [ + "LoggerDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateResourceDefinition": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/definition/resources/{ResourceDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Name": {}, + "ResourceDefinitionId": { + "location": "uri", + "locationName": "ResourceDefinitionId" + } + }, + "required": [ + "ResourceDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateSubscriptionDefinition": { + "http": { + "method": "PUT", + "requestUri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Name": {}, + "SubscriptionDefinitionId": { + "location": "uri", + "locationName": "SubscriptionDefinitionId" + } + }, + "required": [ + "SubscriptionDefinitionId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "Connectors": { + "shape": "S8" + } + } + }, + "S8": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ConnectorArn": {}, + "Id": {}, + "Parameters": { + "shape": "Sa" + } + }, + "required": [] + } + }, + "Sa": { + "type": "map", + "key": {}, + "value": {} + }, + "Sb": { + "type": "map", + "key": {}, + "value": {} + }, + "Sg": { + "type": "structure", + "members": { + "Cores": { + "shape": "Sh" + } + } + }, + "Sh": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CertificateArn": {}, + "Id": {}, + "SyncShadow": { + "type": "boolean" + }, + "ThingArn": {} + }, + "required": [] + } + }, + "Sr": { + "type": "structure", + "members": { + "Devices": { + "shape": "Ss" + } + } + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CertificateArn": {}, + "Id": {}, + "SyncShadow": { + "type": "boolean" + }, + "ThingArn": {} + }, + "required": [] + } + }, + "Sy": { + "type": "structure", + "members": { + "DefaultConfig": { + "shape": "Sz" + }, + "Functions": { + "shape": "S14" + } + } + }, + "Sz": { + "type": "structure", + "members": { + "Execution": { + "type": "structure", + "members": { + "IsolationMode": {}, + "RunAs": { + "shape": "S12" + } + } + } + } + }, + "S12": { + "type": "structure", + "members": { + "Gid": { + "type": "integer" + }, + "Uid": { + "type": "integer" + } + } + }, + "S14": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FunctionArn": {}, + "FunctionConfiguration": { + "type": "structure", + "members": { + "EncodingType": {}, + "Environment": { + "type": "structure", + "members": { + "AccessSysfs": { + "type": "boolean" + }, + "Execution": { + "type": "structure", + "members": { + "IsolationMode": {}, + "RunAs": { + "shape": "S12" + } + } + }, + "ResourceAccessPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Permission": {}, + "ResourceId": {} + }, + "required": [] + } + }, + "Variables": { + "shape": "Sa" + } + } + }, + "ExecArgs": {}, + "Executable": {}, + "MemorySize": { + "type": "integer" + }, + "Pinned": { + "type": "boolean" + }, + "Timeout": { + "type": "integer" + } + } + }, + "Id": {} + }, + "required": [] + } + }, + "S1h": { + "type": "structure", + "members": { + "ConnectorDefinitionVersionArn": {}, + "CoreDefinitionVersionArn": {}, + "DeviceDefinitionVersionArn": {}, + "FunctionDefinitionVersionArn": {}, + "LoggerDefinitionVersionArn": {}, + "ResourceDefinitionVersionArn": {}, + "SubscriptionDefinitionVersionArn": {} + } + }, + "S1o": { + "type": "structure", + "members": { + "Loggers": { + "shape": "S1p" + } + } + }, + "S1p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Component": {}, + "Id": {}, + "Level": {}, + "Space": { + "type": "integer" + }, + "Type": {} + }, + "required": [] + } + }, + "S1y": { + "type": "structure", + "members": { + "Resources": { + "shape": "S1z" + } + } + }, + "S1z": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "ResourceDataContainer": { + "type": "structure", + "members": { + "LocalDeviceResourceData": { + "type": "structure", + "members": { + "GroupOwnerSetting": { + "shape": "S23" + }, + "SourcePath": {} + } + }, + "LocalVolumeResourceData": { + "type": "structure", + "members": { + "DestinationPath": {}, + "GroupOwnerSetting": { + "shape": "S23" + }, + "SourcePath": {} + } + }, + "S3MachineLearningModelResourceData": { + "type": "structure", + "members": { + "DestinationPath": {}, + "S3Uri": {} + } + }, + "SageMakerMachineLearningModelResourceData": { + "type": "structure", + "members": { + "DestinationPath": {}, + "SageMakerJobArn": {} + } + }, + "SecretsManagerSecretResourceData": { + "type": "structure", + "members": { + "ARN": {}, + "AdditionalStagingLabelsToDownload": { + "shape": "S28" + } + } + } + } + } + }, + "required": [] + } + }, + "S23": { + "type": "structure", + "members": { + "AutoAddGroupOwner": { + "type": "boolean" + }, + "GroupOwner": {} + } + }, + "S28": { + "type": "list", + "member": {} + }, + "S2l": { + "type": "structure", + "members": { + "Subscriptions": { + "shape": "S2m" + } + } + }, + "S2m": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Source": {}, + "Subject": {}, + "Target": {} + }, + "required": [] + } + }, + "S3j": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DetailedErrorCode": {}, + "DetailedErrorMessage": {} + } + } + }, + "S3n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "HostAddress": {}, + "Id": {}, + "Metadata": {}, + "PortNumber": { + "type": "integer" + } + } + } + }, + "S53": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "Version": {} + } + } + }, + "S57": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "CreationTimestamp": {}, + "Id": {}, + "LastUpdatedTimestamp": {}, + "LatestVersion": {}, + "LatestVersionArn": {}, + "Name": {}, + "Tags": { + "shape": "Sb", + "locationName": "tags" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json b/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json new file mode 100644 index 0000000..3a7621e --- /dev/null +++ b/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json @@ -0,0 +1,2074 @@ +{ + "metadata": { + "apiVersion": "2017-11-28", + "endpointPrefix": "guardduty", + "signingName": "guardduty", + "serviceFullName": "Amazon GuardDuty", + "serviceId": "GuardDuty", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "guardduty-2017-11-28", + "signatureVersion": "v4" + }, + "operations": { + "AcceptInvitation": { + "http": { + "requestUri": "/detector/{detectorId}/master", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "InvitationId": { + "locationName": "invitationId" + }, + "MasterId": { + "locationName": "masterId" + } + }, + "required": [ + "DetectorId", + "MasterId", + "InvitationId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ArchiveFindings": { + "http": { + "requestUri": "/detector/{detectorId}/findings/archive", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FindingIds": { + "shape": "S7", + "locationName": "findingIds" + } + }, + "required": [ + "DetectorId", + "FindingIds" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateDetector": { + "http": { + "requestUri": "/detector", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ClientToken": { + "locationName": "clientToken", + "idempotencyToken": true + }, + "Enable": { + "locationName": "enable", + "type": "boolean" + }, + "FindingPublishingFrequency": { + "locationName": "findingPublishingFrequency" + } + }, + "required": [ + "Enable" + ] + }, + "output": { + "type": "structure", + "members": { + "DetectorId": { + "locationName": "detectorId" + } + } + } + }, + "CreateFilter": { + "http": { + "requestUri": "/detector/{detectorId}/filter", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Action": { + "locationName": "action" + }, + "ClientToken": { + "locationName": "clientToken", + "idempotencyToken": true + }, + "Description": { + "locationName": "description" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FindingCriteria": { + "shape": "Sj", + "locationName": "findingCriteria" + }, + "Name": { + "locationName": "name" + }, + "Rank": { + "locationName": "rank", + "type": "integer" + } + }, + "required": [ + "DetectorId", + "FindingCriteria", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + } + } + } + }, + "CreateIPSet": { + "http": { + "requestUri": "/detector/{detectorId}/ipset", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Activate": { + "locationName": "activate", + "type": "boolean" + }, + "ClientToken": { + "locationName": "clientToken", + "idempotencyToken": true + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "Format": { + "locationName": "format" + }, + "Location": { + "locationName": "location" + }, + "Name": { + "locationName": "name" + } + }, + "required": [ + "DetectorId", + "Format", + "Activate", + "Location", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "IpSetId": { + "locationName": "ipSetId" + } + } + } + }, + "CreateMembers": { + "http": { + "requestUri": "/detector/{detectorId}/member", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountDetails": { + "locationName": "accountDetails", + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": { + "locationName": "accountId" + }, + "Email": { + "locationName": "email" + } + }, + "required": [ + "Email", + "AccountId" + ] + } + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId", + "AccountDetails" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "CreateSampleFindings": { + "http": { + "requestUri": "/detector/{detectorId}/findings/create", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FindingTypes": { + "locationName": "findingTypes", + "type": "list", + "member": {} + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateThreatIntelSet": { + "http": { + "requestUri": "/detector/{detectorId}/threatintelset", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Activate": { + "locationName": "activate", + "type": "boolean" + }, + "ClientToken": { + "locationName": "clientToken", + "idempotencyToken": true + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "Format": { + "locationName": "format" + }, + "Location": { + "locationName": "location" + }, + "Name": { + "locationName": "name" + } + }, + "required": [ + "DetectorId", + "Format", + "Activate", + "Location", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "ThreatIntelSetId": { + "locationName": "threatIntelSetId" + } + } + } + }, + "DeclineInvitations": { + "http": { + "requestUri": "/invitation/decline", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + } + }, + "required": [ + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "DeleteDetector": { + "http": { + "method": "DELETE", + "requestUri": "/detector/{detectorId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteFilter": { + "http": { + "method": "DELETE", + "requestUri": "/detector/{detectorId}/filter/{filterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FilterName": { + "location": "uri", + "locationName": "filterName" + } + }, + "required": [ + "DetectorId", + "FilterName" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteIPSet": { + "http": { + "method": "DELETE", + "requestUri": "/detector/{detectorId}/ipset/{ipSetId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "IpSetId": { + "location": "uri", + "locationName": "ipSetId" + } + }, + "required": [ + "DetectorId", + "IpSetId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteInvitations": { + "http": { + "requestUri": "/invitation/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + } + }, + "required": [ + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "DeleteMembers": { + "http": { + "requestUri": "/detector/{detectorId}/member/delete", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId", + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "DeleteThreatIntelSet": { + "http": { + "method": "DELETE", + "requestUri": "/detector/{detectorId}/threatintelset/{threatIntelSetId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "ThreatIntelSetId": { + "location": "uri", + "locationName": "threatIntelSetId" + } + }, + "required": [ + "ThreatIntelSetId", + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateFromMasterAccount": { + "http": { + "requestUri": "/detector/{detectorId}/master/disassociate", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateMembers": { + "http": { + "requestUri": "/detector/{detectorId}/member/disassociate", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId", + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "GetDetector": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "CreatedAt": { + "locationName": "createdAt" + }, + "FindingPublishingFrequency": { + "locationName": "findingPublishingFrequency" + }, + "ServiceRole": { + "locationName": "serviceRole" + }, + "Status": { + "locationName": "status" + }, + "UpdatedAt": { + "locationName": "updatedAt" + } + } + } + }, + "GetFilter": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/filter/{filterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FilterName": { + "location": "uri", + "locationName": "filterName" + } + }, + "required": [ + "DetectorId", + "FilterName" + ] + }, + "output": { + "type": "structure", + "members": { + "Action": { + "locationName": "action" + }, + "Description": { + "locationName": "description" + }, + "FindingCriteria": { + "shape": "Sj", + "locationName": "findingCriteria" + }, + "Name": { + "locationName": "name" + }, + "Rank": { + "locationName": "rank", + "type": "integer" + } + } + } + }, + "GetFindings": { + "http": { + "requestUri": "/detector/{detectorId}/findings/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FindingIds": { + "shape": "S7", + "locationName": "findingIds" + }, + "SortCriteria": { + "shape": "S27", + "locationName": "sortCriteria" + } + }, + "required": [ + "DetectorId", + "FindingIds" + ] + }, + "output": { + "type": "structure", + "members": { + "Findings": { + "locationName": "findings", + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": { + "locationName": "accountId" + }, + "Arn": { + "locationName": "arn" + }, + "Confidence": { + "locationName": "confidence", + "type": "double" + }, + "CreatedAt": { + "locationName": "createdAt" + }, + "Description": { + "locationName": "description" + }, + "Id": { + "locationName": "id" + }, + "Partition": { + "locationName": "partition" + }, + "Region": { + "locationName": "region" + }, + "Resource": { + "locationName": "resource", + "type": "structure", + "members": { + "AccessKeyDetails": { + "locationName": "accessKeyDetails", + "type": "structure", + "members": { + "AccessKeyId": { + "locationName": "accessKeyId" + }, + "PrincipalId": { + "locationName": "principalId" + }, + "UserName": { + "locationName": "userName" + }, + "UserType": { + "locationName": "userType" + } + } + }, + "InstanceDetails": { + "locationName": "instanceDetails", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "IamInstanceProfile": { + "locationName": "iamInstanceProfile", + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Id": { + "locationName": "id" + } + } + }, + "ImageDescription": { + "locationName": "imageDescription" + }, + "ImageId": { + "locationName": "imageId" + }, + "InstanceId": { + "locationName": "instanceId" + }, + "InstanceState": { + "locationName": "instanceState" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "LaunchTime": { + "locationName": "launchTime" + }, + "NetworkInterfaces": { + "locationName": "networkInterfaces", + "type": "list", + "member": { + "type": "structure", + "members": { + "Ipv6Addresses": { + "locationName": "ipv6Addresses", + "type": "list", + "member": {} + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + }, + "PrivateIpAddresses": { + "locationName": "privateIpAddresses", + "type": "list", + "member": { + "type": "structure", + "members": { + "PrivateDnsName": { + "locationName": "privateDnsName" + }, + "PrivateIpAddress": { + "locationName": "privateIpAddress" + } + } + } + }, + "PublicDnsName": { + "locationName": "publicDnsName" + }, + "PublicIp": { + "locationName": "publicIp" + }, + "SecurityGroups": { + "locationName": "securityGroups", + "type": "list", + "member": { + "type": "structure", + "members": { + "GroupId": { + "locationName": "groupId" + }, + "GroupName": { + "locationName": "groupName" + } + } + } + }, + "SubnetId": { + "locationName": "subnetId" + }, + "VpcId": { + "locationName": "vpcId" + } + } + } + }, + "Platform": { + "locationName": "platform" + }, + "ProductCodes": { + "locationName": "productCodes", + "type": "list", + "member": { + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "ProductType": { + "locationName": "productType" + } + } + } + }, + "Tags": { + "locationName": "tags", + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": { + "locationName": "key" + }, + "Value": { + "locationName": "value" + } + } + } + } + } + }, + "ResourceType": { + "locationName": "resourceType" + } + } + }, + "SchemaVersion": { + "locationName": "schemaVersion" + }, + "Service": { + "locationName": "service", + "type": "structure", + "members": { + "Action": { + "locationName": "action", + "type": "structure", + "members": { + "ActionType": { + "locationName": "actionType" + }, + "AwsApiCallAction": { + "locationName": "awsApiCallAction", + "type": "structure", + "members": { + "Api": { + "locationName": "api" + }, + "CallerType": { + "locationName": "callerType" + }, + "DomainDetails": { + "locationName": "domainDetails", + "type": "structure", + "members": {} + }, + "RemoteIpDetails": { + "shape": "S30", + "locationName": "remoteIpDetails" + }, + "ServiceName": { + "locationName": "serviceName" + } + } + }, + "DnsRequestAction": { + "locationName": "dnsRequestAction", + "type": "structure", + "members": { + "Domain": { + "locationName": "domain" + } + } + }, + "NetworkConnectionAction": { + "locationName": "networkConnectionAction", + "type": "structure", + "members": { + "Blocked": { + "locationName": "blocked", + "type": "boolean" + }, + "ConnectionDirection": { + "locationName": "connectionDirection" + }, + "LocalPortDetails": { + "shape": "S39", + "locationName": "localPortDetails" + }, + "Protocol": { + "locationName": "protocol" + }, + "RemoteIpDetails": { + "shape": "S30", + "locationName": "remoteIpDetails" + }, + "RemotePortDetails": { + "locationName": "remotePortDetails", + "type": "structure", + "members": { + "Port": { + "locationName": "port", + "type": "integer" + }, + "PortName": { + "locationName": "portName" + } + } + } + } + }, + "PortProbeAction": { + "locationName": "portProbeAction", + "type": "structure", + "members": { + "Blocked": { + "locationName": "blocked", + "type": "boolean" + }, + "PortProbeDetails": { + "locationName": "portProbeDetails", + "type": "list", + "member": { + "type": "structure", + "members": { + "LocalPortDetails": { + "shape": "S39", + "locationName": "localPortDetails" + }, + "RemoteIpDetails": { + "shape": "S30", + "locationName": "remoteIpDetails" + } + } + } + } + } + } + } + }, + "Archived": { + "locationName": "archived", + "type": "boolean" + }, + "Count": { + "locationName": "count", + "type": "integer" + }, + "DetectorId": { + "locationName": "detectorId" + }, + "EventFirstSeen": { + "locationName": "eventFirstSeen" + }, + "EventLastSeen": { + "locationName": "eventLastSeen" + }, + "ResourceRole": { + "locationName": "resourceRole" + }, + "ServiceName": { + "locationName": "serviceName" + }, + "UserFeedback": { + "locationName": "userFeedback" + } + } + }, + "Severity": { + "locationName": "severity", + "type": "double" + }, + "Title": { + "locationName": "title" + }, + "Type": { + "locationName": "type" + }, + "UpdatedAt": { + "locationName": "updatedAt" + } + }, + "required": [ + "AccountId", + "SchemaVersion", + "CreatedAt", + "Resource", + "Severity", + "UpdatedAt", + "Type", + "Region", + "Id", + "Arn" + ] + } + } + } + } + }, + "GetFindingsStatistics": { + "http": { + "requestUri": "/detector/{detectorId}/findings/statistics", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FindingCriteria": { + "shape": "Sj", + "locationName": "findingCriteria" + }, + "FindingStatisticTypes": { + "locationName": "findingStatisticTypes", + "type": "list", + "member": {} + } + }, + "required": [ + "DetectorId", + "FindingStatisticTypes" + ] + }, + "output": { + "type": "structure", + "members": { + "FindingStatistics": { + "locationName": "findingStatistics", + "type": "structure", + "members": { + "CountBySeverity": { + "locationName": "countBySeverity", + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + } + } + } + }, + "GetIPSet": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/ipset/{ipSetId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "IpSetId": { + "location": "uri", + "locationName": "ipSetId" + } + }, + "required": [ + "DetectorId", + "IpSetId" + ] + }, + "output": { + "type": "structure", + "members": { + "Format": { + "locationName": "format" + }, + "Location": { + "locationName": "location" + }, + "Name": { + "locationName": "name" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "GetInvitationsCount": { + "http": { + "method": "GET", + "requestUri": "/invitation/count", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "InvitationsCount": { + "locationName": "invitationsCount", + "type": "integer" + } + } + } + }, + "GetMasterAccount": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/master", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "Master": { + "locationName": "master", + "type": "structure", + "members": { + "AccountId": { + "locationName": "accountId" + }, + "InvitationId": { + "locationName": "invitationId" + }, + "InvitedAt": { + "locationName": "invitedAt" + }, + "RelationshipStatus": { + "locationName": "relationshipStatus" + } + } + } + } + } + }, + "GetMembers": { + "http": { + "requestUri": "/detector/{detectorId}/member/get", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId", + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "Members": { + "shape": "S3w", + "locationName": "members" + }, + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "GetThreatIntelSet": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/threatintelset/{threatIntelSetId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "ThreatIntelSetId": { + "location": "uri", + "locationName": "threatIntelSetId" + } + }, + "required": [ + "ThreatIntelSetId", + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "Format": { + "locationName": "format" + }, + "Location": { + "locationName": "location" + }, + "Name": { + "locationName": "name" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "InviteMembers": { + "http": { + "requestUri": "/detector/{detectorId}/member/invite", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "DisableEmailNotification": { + "locationName": "disableEmailNotification", + "type": "boolean" + }, + "Message": { + "locationName": "message" + } + }, + "required": [ + "DetectorId", + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "ListDetectors": { + "http": { + "method": "GET", + "requestUri": "/detector", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "DetectorIds": { + "locationName": "detectorIds", + "type": "list", + "member": {} + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListFilters": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/filter", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "FilterNames": { + "locationName": "filterNames", + "type": "list", + "member": {} + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListFindings": { + "http": { + "requestUri": "/detector/{detectorId}/findings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FindingCriteria": { + "shape": "Sj", + "locationName": "findingCriteria" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "SortCriteria": { + "shape": "S27", + "locationName": "sortCriteria" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "FindingIds": { + "shape": "S7", + "locationName": "findingIds" + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListIPSets": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/ipset", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "IpSetIds": { + "locationName": "ipSetIds", + "type": "list", + "member": {} + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListInvitations": { + "http": { + "method": "GET", + "requestUri": "/invitation", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invitations": { + "locationName": "invitations", + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": { + "locationName": "accountId" + }, + "InvitationId": { + "locationName": "invitationId" + }, + "InvitedAt": { + "locationName": "invitedAt" + }, + "RelationshipStatus": { + "locationName": "relationshipStatus" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListMembers": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/member", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "OnlyAssociated": { + "location": "querystring", + "locationName": "onlyAssociated" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "Members": { + "shape": "S3w", + "locationName": "members" + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListThreatIntelSets": { + "http": { + "method": "GET", + "requestUri": "/detector/{detectorId}/threatintelset", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "ThreatIntelSetIds": { + "locationName": "threatIntelSetIds", + "type": "list", + "member": {} + } + } + } + }, + "StartMonitoringMembers": { + "http": { + "requestUri": "/detector/{detectorId}/member/start", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId", + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "StopMonitoringMembers": { + "http": { + "requestUri": "/detector/{detectorId}/member/stop", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S1g", + "locationName": "accountIds" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + } + }, + "required": [ + "DetectorId", + "AccountIds" + ] + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S15", + "locationName": "unprocessedAccounts" + } + } + } + }, + "UnarchiveFindings": { + "http": { + "requestUri": "/detector/{detectorId}/findings/unarchive", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FindingIds": { + "shape": "S7", + "locationName": "findingIds" + } + }, + "required": [ + "DetectorId", + "FindingIds" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDetector": { + "http": { + "requestUri": "/detector/{detectorId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "Enable": { + "locationName": "enable", + "type": "boolean" + }, + "FindingPublishingFrequency": { + "locationName": "findingPublishingFrequency" + } + }, + "required": [ + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateFilter": { + "http": { + "requestUri": "/detector/{detectorId}/filter/{filterName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Action": { + "locationName": "action" + }, + "Description": { + "locationName": "description" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "FilterName": { + "location": "uri", + "locationName": "filterName" + }, + "FindingCriteria": { + "shape": "Sj", + "locationName": "findingCriteria" + }, + "Rank": { + "locationName": "rank", + "type": "integer" + } + }, + "required": [ + "DetectorId", + "FilterName" + ] + }, + "output": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + } + } + } + }, + "UpdateFindingsFeedback": { + "http": { + "requestUri": "/detector/{detectorId}/findings/feedback", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Comments": { + "locationName": "comments" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "Feedback": { + "locationName": "feedback" + }, + "FindingIds": { + "shape": "S7", + "locationName": "findingIds" + } + }, + "required": [ + "DetectorId", + "Feedback", + "FindingIds" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateIPSet": { + "http": { + "requestUri": "/detector/{detectorId}/ipset/{ipSetId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Activate": { + "locationName": "activate", + "type": "boolean" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "IpSetId": { + "location": "uri", + "locationName": "ipSetId" + }, + "Location": { + "locationName": "location" + }, + "Name": { + "locationName": "name" + } + }, + "required": [ + "DetectorId", + "IpSetId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateThreatIntelSet": { + "http": { + "requestUri": "/detector/{detectorId}/threatintelset/{threatIntelSetId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Activate": { + "locationName": "activate", + "type": "boolean" + }, + "DetectorId": { + "location": "uri", + "locationName": "detectorId" + }, + "Location": { + "locationName": "location" + }, + "Name": { + "locationName": "name" + }, + "ThreatIntelSetId": { + "location": "uri", + "locationName": "threatIntelSetId" + } + }, + "required": [ + "ThreatIntelSetId", + "DetectorId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S7": { + "type": "list", + "member": {} + }, + "Sj": { + "type": "structure", + "members": { + "Criterion": { + "locationName": "criterion", + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Eq": { + "locationName": "eq", + "type": "list", + "member": {} + }, + "Gt": { + "locationName": "gt", + "type": "integer" + }, + "Gte": { + "locationName": "gte", + "type": "integer" + }, + "Lt": { + "locationName": "lt", + "type": "integer" + }, + "Lte": { + "locationName": "lte", + "type": "integer" + }, + "Neq": { + "locationName": "neq", + "type": "list", + "member": {} + } + } + } + } + } + }, + "S15": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": { + "locationName": "accountId" + }, + "Result": { + "locationName": "result" + } + }, + "required": [ + "AccountId", + "Result" + ] + } + }, + "S1g": { + "type": "list", + "member": {} + }, + "S27": { + "type": "structure", + "members": { + "AttributeName": { + "locationName": "attributeName" + }, + "OrderBy": { + "locationName": "orderBy" + } + } + }, + "S30": { + "type": "structure", + "members": { + "City": { + "locationName": "city", + "type": "structure", + "members": { + "CityName": { + "locationName": "cityName" + } + } + }, + "Country": { + "locationName": "country", + "type": "structure", + "members": { + "CountryCode": { + "locationName": "countryCode" + }, + "CountryName": { + "locationName": "countryName" + } + } + }, + "GeoLocation": { + "locationName": "geoLocation", + "type": "structure", + "members": { + "Lat": { + "locationName": "lat", + "type": "double" + }, + "Lon": { + "locationName": "lon", + "type": "double" + } + } + }, + "IpAddressV4": { + "locationName": "ipAddressV4" + }, + "Organization": { + "locationName": "organization", + "type": "structure", + "members": { + "Asn": { + "locationName": "asn" + }, + "AsnOrg": { + "locationName": "asnOrg" + }, + "Isp": { + "locationName": "isp" + }, + "Org": { + "locationName": "org" + } + } + } + } + }, + "S39": { + "type": "structure", + "members": { + "Port": { + "locationName": "port", + "type": "integer" + }, + "PortName": { + "locationName": "portName" + } + } + }, + "S3w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": { + "locationName": "accountId" + }, + "DetectorId": { + "locationName": "detectorId" + }, + "Email": { + "locationName": "email" + }, + "InvitedAt": { + "locationName": "invitedAt" + }, + "MasterId": { + "locationName": "masterId" + }, + "RelationshipStatus": { + "locationName": "relationshipStatus" + }, + "UpdatedAt": { + "locationName": "updatedAt" + } + }, + "required": [ + "Email", + "AccountId", + "MasterId", + "UpdatedAt", + "RelationshipStatus" + ] + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/guardduty-2017-11-28.paginators.json b/node_modules/aws-sdk/apis/guardduty-2017-11-28.paginators.json new file mode 100644 index 0000000..92a10d3 --- /dev/null +++ b/node_modules/aws-sdk/apis/guardduty-2017-11-28.paginators.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "ListDetectors": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DetectorIds" + }, + "ListFindings": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FindingIds" + }, + "ListIPSets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IpSetIds" + }, + "ListThreatIntelSets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ThreatIntelSetIds" + }, + "ListInvitations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Invitations" + }, + "ListMembers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Members" + }, + "ListFilters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FilterNames" + } + } +} diff --git a/node_modules/aws-sdk/apis/health-2016-08-04.examples.json b/node_modules/aws-sdk/apis/health-2016-08-04.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/health-2016-08-04.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/health-2016-08-04.min.json b/node_modules/aws-sdk/apis/health-2016-08-04.min.json new file mode 100644 index 0000000..8f81b5f --- /dev/null +++ b/node_modules/aws-sdk/apis/health-2016-08-04.min.json @@ -0,0 +1,392 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-08-04", + "endpointPrefix": "health", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "AWSHealth", + "serviceFullName": "AWS Health APIs and Notifications", + "serviceId": "Health", + "signatureVersion": "v4", + "targetPrefix": "AWSHealth_20160804", + "uid": "health-2016-08-04" + }, + "operations": { + "DescribeAffectedEntities": { + "input": { + "type": "structure", + "required": [ + "filter" + ], + "members": { + "filter": { + "type": "structure", + "required": [ + "eventArns" + ], + "members": { + "eventArns": { + "shape": "S3" + }, + "entityArns": { + "shape": "S5" + }, + "entityValues": { + "shape": "S7" + }, + "lastUpdatedTimes": { + "shape": "S9" + }, + "tags": { + "shape": "Sc" + }, + "statusCodes": { + "type": "list", + "member": {} + } + } + }, + "locale": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "entities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "entityArn": {}, + "eventArn": {}, + "entityValue": {}, + "entityUrl": {}, + "awsAccountId": {}, + "lastUpdatedTime": { + "type": "timestamp" + }, + "statusCode": {}, + "tags": { + "shape": "Sd" + } + } + } + }, + "nextToken": {} + } + }, + "idempotent": true + }, + "DescribeEntityAggregates": { + "input": { + "type": "structure", + "members": { + "eventArns": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "entityAggregates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "eventArn": {}, + "count": { + "type": "integer" + } + } + } + } + } + }, + "idempotent": true + }, + "DescribeEventAggregates": { + "input": { + "type": "structure", + "required": [ + "aggregateField" + ], + "members": { + "filter": { + "shape": "Sx" + }, + "aggregateField": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "eventAggregates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "aggregateValue": {}, + "count": { + "type": "integer" + } + } + } + }, + "nextToken": {} + } + }, + "idempotent": true + }, + "DescribeEventDetails": { + "input": { + "type": "structure", + "required": [ + "eventArns" + ], + "members": { + "eventArns": { + "shape": "S3" + }, + "locale": {} + } + }, + "output": { + "type": "structure", + "members": { + "successfulSet": { + "type": "list", + "member": { + "type": "structure", + "members": { + "event": { + "shape": "S1j" + }, + "eventDescription": { + "type": "structure", + "members": { + "latestDescription": {} + } + }, + "eventMetadata": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "failedSet": { + "type": "list", + "member": { + "type": "structure", + "members": { + "eventArn": {}, + "errorName": {}, + "errorMessage": {} + } + } + } + } + }, + "idempotent": true + }, + "DescribeEventTypes": { + "input": { + "type": "structure", + "members": { + "filter": { + "type": "structure", + "members": { + "eventTypeCodes": { + "type": "list", + "member": {} + }, + "services": { + "shape": "S10" + }, + "eventTypeCategories": { + "type": "list", + "member": {} + } + } + }, + "locale": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "eventTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "service": {}, + "code": {}, + "category": {} + } + } + }, + "nextToken": {} + } + }, + "idempotent": true + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "filter": { + "shape": "Sx" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "locale": {} + } + }, + "output": { + "type": "structure", + "members": { + "events": { + "type": "list", + "member": { + "shape": "S1j" + } + }, + "nextToken": {} + } + }, + "idempotent": true + } + }, + "shapes": { + "S3": { + "type": "list", + "member": {} + }, + "S5": { + "type": "list", + "member": {} + }, + "S7": { + "type": "list", + "member": {} + }, + "S9": { + "type": "list", + "member": { + "type": "structure", + "members": { + "from": { + "type": "timestamp" + }, + "to": { + "type": "timestamp" + } + } + } + }, + "Sc": { + "type": "list", + "member": { + "shape": "Sd" + } + }, + "Sd": { + "type": "map", + "key": {}, + "value": {} + }, + "Sx": { + "type": "structure", + "members": { + "eventArns": { + "shape": "S3" + }, + "eventTypeCodes": { + "type": "list", + "member": {} + }, + "services": { + "shape": "S10" + }, + "regions": { + "type": "list", + "member": {} + }, + "availabilityZones": { + "type": "list", + "member": {} + }, + "startTimes": { + "shape": "S9" + }, + "endTimes": { + "shape": "S9" + }, + "lastUpdatedTimes": { + "shape": "S9" + }, + "entityArns": { + "shape": "S5" + }, + "entityValues": { + "shape": "S7" + }, + "eventTypeCategories": { + "type": "list", + "member": {} + }, + "tags": { + "shape": "Sc" + }, + "eventStatusCodes": { + "type": "list", + "member": {} + } + } + }, + "S10": { + "type": "list", + "member": {} + }, + "S1j": { + "type": "structure", + "members": { + "arn": {}, + "service": {}, + "eventTypeCode": {}, + "eventTypeCategory": {}, + "region": {}, + "availabilityZone": {}, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "lastUpdatedTime": { + "type": "timestamp" + }, + "statusCode": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/health-2016-08-04.paginators.json b/node_modules/aws-sdk/apis/health-2016-08-04.paginators.json new file mode 100644 index 0000000..3a30b01 --- /dev/null +++ b/node_modules/aws-sdk/apis/health-2016-08-04.paginators.json @@ -0,0 +1,31 @@ +{ + "pagination": { + "DescribeAffectedEntities": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "entities" + }, + "DescribeEntityAggregates": { + "result_key": "entityAggregates" + }, + "DescribeEventAggregates": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "eventAggregates" + }, + "DescribeEventTypes": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "eventTypes" + }, + "DescribeEvents": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "events" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iam-2010-05-08.examples.json b/node_modules/aws-sdk/apis/iam-2010-05-08.examples.json new file mode 100644 index 0000000..bcc4c23 --- /dev/null +++ b/node_modules/aws-sdk/apis/iam-2010-05-08.examples.json @@ -0,0 +1,1506 @@ +{ + "version": "1.0", + "examples": { + "AddClientIDToOpenIDConnectProvider": [ + { + "input": { + "ClientID": "my-application-ID", + "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:", + "id": "028e91f4-e2a6-4d59-9e3b-4965a3fb19be", + "title": "To add a client ID (audience) to an Open-ID Connect (OIDC) provider" + } + ], + "AddRoleToInstanceProfile": [ + { + "input": { + "InstanceProfileName": "Webserver", + "RoleName": "S3Access" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds the role named S3Access to the instance profile named Webserver:", + "id": "c107fac3-edb6-4827-8a71-8863ec91c81f", + "title": "To add a role to an instance profile" + } + ], + "AddUserToGroup": [ + { + "input": { + "GroupName": "Admins", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds an IAM user named Bob to the IAM group named Admins:", + "id": "619c7e6b-09f8-4036-857b-51a6ea5027ca", + "title": "To add a user to an IAM group" + } + ], + "AttachGroupPolicy": [ + { + "input": { + "GroupName": "Finance", + "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.", + "id": "87551489-86f0-45db-9889-759936778f2b", + "title": "To attach a managed policy to an IAM group" + } + ], + "AttachRolePolicy": [ + { + "input": { + "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess", + "RoleName": "ReadOnlyRole" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.", + "id": "3e1b8c7c-99c8-4fc4-a20c-131fe3f22c7e", + "title": "To attach a managed policy to an IAM role" + } + ], + "AttachUserPolicy": [ + { + "input": { + "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess", + "UserName": "Alice" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.", + "id": "1372ebd8-9475-4b1a-a479-23b6fd4b8b3e", + "title": "To attach a managed policy to an IAM user" + } + ], + "ChangePassword": [ + { + "input": { + "NewPassword": "]35d/{pB9Fo9wJ", + "OldPassword": "3s0K_;xh4~8XXI" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the password for the current IAM user.", + "id": "3a80c66f-bffb-46df-947c-1e8fa583b470", + "title": "To change the password for your IAM user" + } + ], + "CreateAccessKey": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "AccessKey": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "CreateDate": "2015-03-09T18:39:23.411Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "Status": "Active", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.", + "id": "1fbb3211-4cf2-41db-8c20-ba58d9f5802d", + "title": "To create an access key for an IAM user" + } + ], + "CreateAccountAlias": [ + { + "input": { + "AccountAlias": "examplecorp" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command associates the alias examplecorp to your AWS account.", + "id": "5adaf6fb-94fc-4ca2-b825-2fbc2062add1", + "title": "To create an account alias" + } + ], + "CreateGroup": [ + { + "input": { + "GroupName": "Admins" + }, + "output": { + "Group": { + "Arn": "arn:aws:iam::123456789012:group/Admins", + "CreateDate": "2015-03-09T20:30:24.940Z", + "GroupId": "AIDGPMS9RO4H3FEXAMPLE", + "GroupName": "Admins", + "Path": "/" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates an IAM group named Admins.", + "id": "d5da2a90-5e69-4ef7-8ae8-4c33dc21fd21", + "title": "To create an IAM group" + } + ], + "CreateInstanceProfile": [ + { + "input": { + "InstanceProfileName": "Webserver" + }, + "output": { + "InstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver", + "CreateDate": "2015-03-09T20:33:19.626Z", + "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", + "InstanceProfileName": "Webserver", + "Path": "/", + "Roles": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.", + "id": "5d84e6ae-5921-4e39-8454-10232cd9ff9a", + "title": "To create an instance profile" + } + ], + "CreateLoginProfile": [ + { + "input": { + "Password": "h]6EszR}vJ*m", + "PasswordResetRequired": true, + "UserName": "Bob" + }, + "output": { + "LoginProfile": { + "CreateDate": "2015-03-10T20:55:40.274Z", + "PasswordResetRequired": true, + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.", + "id": "c63795bc-3444-40b3-89df-83c474ef88be", + "title": "To create an instance profile" + } + ], + "CreateOpenIDConnectProvider": [ + { + "input": { + "ClientIDList": [ + "my-application-id" + ], + "ThumbprintList": [ + "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE" + ], + "Url": "https://server.example.com" + }, + "output": { + "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the server with a URL of https://server.example.com.", + "id": "4e4a6bff-cc97-4406-922e-0ab4a82cdb63", + "title": "To create an instance profile" + } + ], + "CreateRole": [ + { + "input": { + "AssumeRolePolicyDocument": "", + "Path": "/", + "RoleName": "Test-Role" + }, + "output": { + "Role": { + "Arn": "arn:aws:iam::123456789012:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-06-07T20:43:32.821Z", + "Path": "/", + "RoleId": "AKIAIOSFODNN7EXAMPLE", + "RoleName": "Test-Role" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates a role named Test-Role and attaches a trust policy to it that is provided as a URL-encoded JSON string.", + "id": "eaaa4b5f-51f1-4f73-b0d3-30127040eff8", + "title": "To create an IAM role" + } + ], + "CreateUser": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "User": { + "Arn": "arn:aws:iam::123456789012:user/Bob", + "CreateDate": "2013-06-08T03:20:41.270Z", + "Path": "/", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following create-user command creates an IAM user named Bob in the current account.", + "id": "eb15f90b-e5f5-4af8-a594-e4e82b181a62", + "title": "To create an IAM user" + } + ], + "DeleteAccessKey": [ + { + "input": { + "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.", + "id": "61a785a7-d30a-415a-ae18-ab9236e56871", + "title": "To delete an access key for an IAM user" + } + ], + "DeleteAccountAlias": [ + { + "input": { + "AccountAlias": "mycompany" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the alias mycompany from the current AWS account:", + "id": "7abeca65-04a8-4500-a890-47f1092bf766", + "title": "To delete an account alias" + } + ], + "DeleteAccountPasswordPolicy": [ + { + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the password policy from the current AWS account:", + "id": "9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf", + "title": "To delete the current account password policy" + } + ], + "DeleteGroupPolicy": [ + { + "input": { + "GroupName": "Admins", + "PolicyName": "ExamplePolicy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the policy named ExamplePolicy from the group named Admins:", + "id": "e683f2bd-98a4-4fe0-bb66-33169c692d4a", + "title": "To delete a policy from an IAM group" + } + ], + "DeleteInstanceProfile": [ + { + "input": { + "InstanceProfileName": "ExampleInstanceProfile" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the instance profile named ExampleInstanceProfile", + "id": "12d74fb8-3433-49db-8171-a1fc764e354d", + "title": "To delete an instance profile" + } + ], + "DeleteLoginProfile": [ + { + "input": { + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the password for the IAM user named Bob.", + "id": "1fe57059-fc73-42e2-b992-517b7d573b5c", + "title": "To delete a password for an IAM user" + } + ], + "DeleteRole": [ + { + "input": { + "RoleName": "Test-Role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the role named Test-Role.", + "id": "053cdf74-9bda-44b8-bdbb-140fd5a32603", + "title": "To delete an IAM role" + } + ], + "DeleteRolePolicy": [ + { + "input": { + "PolicyName": "ExamplePolicy", + "RoleName": "Test-Role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the policy named ExamplePolicy from the role named Test-Role.", + "id": "9c667336-fde3-462c-b8f3-950800821e27", + "title": "To remove a policy from an IAM role" + } + ], + "DeleteSigningCertificate": [ + { + "input": { + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "UserName": "Anika" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the specified signing certificate for the IAM user named Anika.", + "id": "e3357586-ba9c-4070-b35b-d1a899b71987", + "title": "To delete a signing certificate for an IAM user" + } + ], + "DeleteUser": [ + { + "input": { + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the IAM user named Bob from the current account.", + "id": "a13dc3f9-59fe-42d9-abbb-fb98b204fdf0", + "title": "To delete an IAM user" + } + ], + "DeleteUserPolicy": [ + { + "input": { + "PolicyName": "ExamplePolicy", + "UserName": "Juan" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:", + "id": "34f07ddc-9bc1-4f52-bc59-cd0a3ccd06c8", + "title": "To remove a policy from an IAM user" + } + ], + "DeleteVirtualMFADevice": [ + { + "input": { + "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.", + "id": "2933b08b-dbe7-4b89-b8c1-fdf75feea1ee", + "title": "To remove a virtual MFA device" + } + ], + "GenerateServiceLastAccessedDetails": [ + { + "input": { + "Arn": "arn:aws:iam::123456789012:policy/ExamplePolicy1" + }, + "output": { + "JobId": "examplef-1305-c245-eba4-71fe298bcda7" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation generates a report for the policy: ExamplePolicy1", + "id": "generateaccessdata-policy-1541695178514", + "title": "To generate a service last accessed data report for a policy" + } + ], + "GetAccountPasswordPolicy": [ + { + "output": { + "PasswordPolicy": { + "AllowUsersToChangePassword": false, + "ExpirePasswords": false, + "HardExpiry": false, + "MaxPasswordAge": 90, + "MinimumPasswordLength": 8, + "PasswordReusePrevention": 12, + "RequireLowercaseCharacters": false, + "RequireNumbers": true, + "RequireSymbols": true, + "RequireUppercaseCharacters": false + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command displays details about the password policy for the current AWS account.", + "id": "5e4598c7-c425-431f-8af1-19073b3c4a5f", + "title": "To see the current account password policy" + } + ], + "GetAccountSummary": [ + { + "output": { + "SummaryMap": { + "AccessKeysPerUserQuota": 2, + "AccountAccessKeysPresent": 1, + "AccountMFAEnabled": 0, + "AccountSigningCertificatesPresent": 0, + "AttachedPoliciesPerGroupQuota": 10, + "AttachedPoliciesPerRoleQuota": 10, + "AttachedPoliciesPerUserQuota": 10, + "GlobalEndpointTokenVersion": 2, + "GroupPolicySizeQuota": 5120, + "Groups": 15, + "GroupsPerUserQuota": 10, + "GroupsQuota": 100, + "MFADevices": 6, + "MFADevicesInUse": 3, + "Policies": 8, + "PoliciesQuota": 1000, + "PolicySizeQuota": 5120, + "PolicyVersionsInUse": 22, + "PolicyVersionsInUseQuota": 10000, + "ServerCertificates": 1, + "ServerCertificatesQuota": 20, + "SigningCertificatesPerUserQuota": 2, + "UserPolicySizeQuota": 2048, + "Users": 27, + "UsersQuota": 5000, + "VersionsPerPolicyQuota": 5 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command returns information about the IAM entity quotas and usage in the current AWS account.", + "id": "9d8447af-f344-45de-8219-2cebc3cce7f2", + "title": "To get information about IAM entity quotas and usage in the current account" + } + ], + "GetInstanceProfile": [ + { + "input": { + "InstanceProfileName": "ExampleInstanceProfile" + }, + "output": { + "InstanceProfile": { + "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile", + "CreateDate": "2013-06-12T23:52:02Z", + "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE", + "InstanceProfileName": "ExampleInstanceProfile", + "Path": "/", + "Roles": [ + { + "Arn": "arn:aws:iam::336924118301:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-01-09T06:33:26Z", + "Path": "/", + "RoleId": "AIDGPMS9RO4H3FEXAMPLE", + "RoleName": "Test-Role" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the instance profile named ExampleInstanceProfile.", + "id": "463b9ba5-18cc-4608-9ccb-5a7c6b6e5fe7", + "title": "To get information about an instance profile" + } + ], + "GetLoginProfile": [ + { + "input": { + "UserName": "Anika" + }, + "output": { + "LoginProfile": { + "CreateDate": "2012-09-21T23:03:39Z", + "UserName": "Anika" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the password for the IAM user named Anika.", + "id": "d6b580cc-909f-4925-9caa-d425cbc1ad47", + "title": "To get password information for an IAM user" + } + ], + "GetRole": [ + { + "input": { + "RoleName": "Test-Role" + }, + "output": { + "Role": { + "Arn": "arn:aws:iam::123456789012:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-04-18T05:01:58Z", + "Path": "/", + "RoleId": "AIDIODR4TAW7CSEXAMPLE", + "RoleName": "Test-Role" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the role named Test-Role.", + "id": "5b7d03a6-340c-472d-aa77-56425950d8b0", + "title": "To get information about an IAM role" + } + ], + "GetServiceLastAccessedDetails": [ + { + "input": { + "JobId": "examplef-1305-c245-eba4-71fe298bcda7" + }, + "output": { + "IsTruncated": false, + "JobCompletionDate": "2018-10-24T19:47:35.241Z", + "JobCreationDate": "2018-10-24T19:47:31.466Z", + "JobStatus": "COMPLETED", + "ServicesLastAccessed": [ + { + "LastAuthenticated": "2018-10-24T19:11:00Z", + "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01", + "ServiceName": "AWS Identity and Access Management", + "ServiceNamespace": "iam", + "TotalAuthenticatedEntities": 2 + }, + { + "ServiceName": "Amazon Simple Storage Service", + "ServiceNamespace": "s3", + "TotalAuthenticatedEntities": 0 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7", + "id": "getserviceaccessdetails-policy-1541696298085", + "title": "To get details from a previously-generated report" + } + ], + "GetServiceLastAccessedDetailsWithEntities": [ + { + "input": { + "JobId": "examplef-1305-c245-eba4-71fe298bcda7", + "ServiceNamespace": "iam" + }, + "output": { + "EntityDetailsList": [ + { + "EntityInfo": { + "Arn": "arn:aws:iam::123456789012:user/AWSExampleUser01", + "Id": "AIDAEX2EXAMPLEB6IGCDC", + "Name": "AWSExampleUser01", + "Path": "/", + "Type": "USER" + }, + "LastAuthenticated": "2018-10-24T19:10:00Z" + }, + { + "EntityInfo": { + "Arn": "arn:aws:iam::123456789012:role/AWSExampleRole01", + "Id": "AROAEAEXAMPLEIANXSIU4", + "Name": "AWSExampleRole01", + "Path": "/", + "Type": "ROLE" + } + } + ], + "IsTruncated": false, + "JobCompletionDate": "2018-10-24T19:47:35.241Z", + "JobCreationDate": "2018-10-24T19:47:31.466Z", + "JobStatus": "COMPLETED" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation returns details about the entities that attempted to access the IAM service.", + "id": "getserviceaccessdetailsentity-policy-1541697621384", + "title": "To get sntity details from a previously-generated report" + } + ], + "GetUser": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "User": { + "Arn": "arn:aws:iam::123456789012:user/Bob", + "CreateDate": "2012-09-21T23:03:13Z", + "Path": "/", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the IAM user named Bob.", + "id": "ede000a1-9e4c-40db-bd0a-d4f95e41a6ab", + "title": "To get information about an IAM user" + } + ], + "ListAccessKeys": [ + { + "input": { + "UserName": "Alice" + }, + "output": { + "AccessKeyMetadata": [ + { + "AccessKeyId": "AKIA111111111EXAMPLE", + "CreateDate": "2016-12-01T22:19:58Z", + "Status": "Active", + "UserName": "Alice" + }, + { + "AccessKeyId": "AKIA222222222EXAMPLE", + "CreateDate": "2016-12-01T22:20:01Z", + "Status": "Active", + "UserName": "Alice" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the access keys IDs for the IAM user named Alice.", + "id": "15571463-ebea-411a-a021-1c76bd2a3625", + "title": "To list the access key IDs for an IAM user" + } + ], + "ListAccountAliases": [ + { + "input": { + }, + "output": { + "AccountAliases": [ + "exmaple-corporation" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the aliases for the current account.", + "id": "e27b457a-16f9-4e05-a006-3df7b3472741", + "title": "To list account aliases" + } + ], + "ListGroupPolicies": [ + { + "input": { + "GroupName": "Admins" + }, + "output": { + "PolicyNames": [ + "AdminRoot", + "KeyPolicy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the names of in-line policies that are embedded in the IAM group named Admins.", + "id": "02de5095-2410-4d3a-ac1b-cc40234af68f", + "title": "To list the in-line policies for an IAM group" + } + ], + "ListGroups": [ + { + "input": { + }, + "output": { + "Groups": [ + { + "Arn": "arn:aws:iam::123456789012:group/Admins", + "CreateDate": "2016-12-15T21:40:08.121Z", + "GroupId": "AGPA1111111111EXAMPLE", + "GroupName": "Admins", + "Path": "/division_abc/subdivision_xyz/" + }, + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", + "CreateDate": "2016-11-30T14:10:01.156Z", + "GroupId": "AGP22222222222EXAMPLE", + "GroupName": "Test", + "Path": "/division_abc/subdivision_xyz/product_1234/engineering/" + }, + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", + "CreateDate": "2016-06-12T20:14:52.032Z", + "GroupId": "AGPI3333333333EXAMPLE", + "GroupName": "Managers", + "Path": "/division_abc/subdivision_xyz/product_1234/" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the IAM groups in the current account:", + "id": "b3ab1380-2a21-42fb-8e85-503f65512c66", + "title": "To list the IAM groups for the current account" + } + ], + "ListGroupsForUser": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "Groups": [ + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", + "CreateDate": "2016-11-30T14:10:01.156Z", + "GroupId": "AGP2111111111EXAMPLE", + "GroupName": "Test", + "Path": "/division_abc/subdivision_xyz/product_1234/engineering/" + }, + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", + "CreateDate": "2016-06-12T20:14:52.032Z", + "GroupId": "AGPI222222222SEXAMPLE", + "GroupName": "Managers", + "Path": "/division_abc/subdivision_xyz/product_1234/" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command displays the groups that the IAM user named Bob belongs to.", + "id": "278ec2ee-fc28-4136-83fb-433af0ae46a2", + "title": "To list the groups that an IAM user belongs to" + } + ], + "ListPoliciesGrantingServiceAccess": [ + { + "input": { + "Arn": "arn:aws:iam::123456789012:user/ExampleUser01", + "ServiceNamespaces": [ + "iam", + "ec2" + ] + }, + "output": { + "IsTruncated": false, + "PoliciesGrantingServiceAccess": [ + { + "Policies": [ + { + "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleIamPolicy", + "PolicyName": "ExampleIamPolicy", + "PolicyType": "MANAGED" + }, + { + "EntityName": "AWSExampleGroup1", + "EntityType": "GROUP", + "PolicyName": "ExampleGroup1Policy", + "PolicyType": "INLINE" + } + ], + "ServiceNamespace": "iam" + }, + { + "Policies": [ + { + "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleEc2Policy", + "PolicyName": "ExampleEc2Policy", + "PolicyType": "MANAGED" + } + ], + "ServiceNamespace": "ec2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation lists policies that allow ExampleUser01 to access IAM or EC2.", + "id": "listpoliciesaccess-user-1541698749508", + "title": "To list policies that allow access to a service" + } + ], + "ListRoleTags": [ + { + "input": { + "RoleName": "taggedrole1" + }, + "output": { + "IsTruncated": false, + "Tags": [ + { + "Key": "Dept", + "Value": "12345" + }, + { + "Key": "Team", + "Value": "Accounting" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to list the tags attached to a role.", + "id": "to-list-the-tags-attached-to-an-iam-role-1506719238376", + "title": "To list the tags attached to an IAM role" + } + ], + "ListSigningCertificates": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "Certificates": [ + { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "Status": "Active", + "UploadDate": "2013-06-06T21:40:08Z", + "UserName": "Bob" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the signing certificates for the IAM user named Bob.", + "id": "b4c10256-4fc9-457e-b3fd-4a110d4d73dc", + "title": "To list the signing certificates for an IAM user" + } + ], + "ListUserTags": [ + { + "input": { + "UserName": "anika" + }, + "output": { + "IsTruncated": false, + "Tags": [ + { + "Key": "Dept", + "Value": "12345" + }, + { + "Key": "Team", + "Value": "Accounting" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to list the tags attached to a user.", + "id": "to-list-the-tags-attached-to-an-iam-user-1506719473186", + "title": "To list the tags attached to an IAM user" + } + ], + "ListUsers": [ + { + "input": { + }, + "output": { + "Users": [ + { + "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan", + "CreateDate": "2012-09-05T19:38:48Z", + "PasswordLastUsed": "2016-09-08T21:47:36Z", + "Path": "/division_abc/subdivision_xyz/engineering/", + "UserId": "AID2MAB8DPLSRHEXAMPLE", + "UserName": "Juan" + }, + { + "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika", + "CreateDate": "2014-04-09T15:43:45Z", + "PasswordLastUsed": "2016-09-24T16:18:07Z", + "Path": "/division_abc/subdivision_xyz/engineering/", + "UserId": "AIDIODR4TAW7CSEXAMPLE", + "UserName": "Anika" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the IAM users in the current account.", + "id": "9edfbd73-03d8-4d8a-9a79-76c85e8c8298", + "title": "To list IAM users" + } + ], + "ListVirtualMFADevices": [ + { + "input": { + }, + "output": { + "VirtualMFADevices": [ + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice" + }, + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/Juan" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the virtual MFA devices that have been configured for the current account.", + "id": "54f9ac18-5100-4070-bec4-fe5f612710d5", + "title": "To list virtual MFA devices" + } + ], + "PutGroupPolicy": [ + { + "input": { + "GroupName": "Admins", + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}", + "PolicyName": "AllPerms" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds a policy named AllPerms to the IAM group named Admins.", + "id": "4bc17418-758f-4d0f-ab0c-4d00265fec2e", + "title": "To add a policy to a group" + } + ], + "PutRolePolicy": [ + { + "input": { + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}", + "PolicyName": "S3AccessPolicy", + "RoleName": "S3Access" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds a permissions policy to the role named Test-Role.", + "id": "de62fd00-46c7-4601-9e0d-71d5fbb11ecb", + "title": "To attach a permissions policy to an IAM role" + } + ], + "PutUserPolicy": [ + { + "input": { + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}", + "PolicyName": "AllAccessPolicy", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches a policy to the IAM user named Bob.", + "id": "2551ffc6-3576-4d39-823f-30b60bffc2c7", + "title": "To attach a policy to an IAM user" + } + ], + "RemoveRoleFromInstanceProfile": [ + { + "input": { + "InstanceProfileName": "ExampleInstanceProfile", + "RoleName": "Test-Role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.", + "id": "6d9f46f1-9f4a-4873-b403-51a85c5c627c", + "title": "To remove a role from an instance profile" + } + ], + "RemoveUserFromGroup": [ + { + "input": { + "GroupName": "Admins", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the user named Bob from the IAM group named Admins.", + "id": "fb54d5b4-0caf-41d8-af0e-10a84413f174", + "title": "To remove a user from an IAM group" + } + ], + "SetSecurityTokenServicePreferences": [ + { + "input": { + "GlobalEndpointTokenVersion": "v2Token" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.", + "id": "61a785a7-d30a-415a-ae18-ab9236e56871", + "title": "To delete an access key for an IAM user" + } + ], + "TagRole": [ + { + "input": { + "RoleName": "taggedrole", + "Tags": [ + { + "Key": "Dept", + "Value": "Accounting" + }, + { + "Key": "CostCenter", + "Value": "12345" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to add tags to an existing role.", + "id": "to-add-a-tag-key-and-value-to-an-iam-role-1506718791513", + "title": "To add a tag key and value to an IAM role" + } + ], + "TagUser": [ + { + "input": { + "Tags": [ + { + "Key": "Dept", + "Value": "Accounting" + }, + { + "Key": "CostCenter", + "Value": "12345" + } + ], + "UserName": "anika" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to add tags to an existing user.", + "id": "to-add-a-tag-key-and-value-to-an-iam-user-1506719044227", + "title": "To add a tag key and value to an IAM user" + } + ], + "UntagRole": [ + { + "input": { + "RoleName": "taggedrole", + "TagKeys": [ + "Dept" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.", + "id": "to-remove-a-tag-from-an-iam-role-1506719589943", + "title": "To remove a tag from an IAM role" + } + ], + "UntagUser": [ + { + "input": { + "TagKeys": [ + "Dept" + ], + "UserName": "anika" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to remove tags that are attached to a user named 'anika'.", + "id": "to-remove-a-tag-from-an-iam-user-1506719725554", + "title": "To remove a tag from an IAM user" + } + ], + "UpdateAccessKey": [ + { + "input": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Status": "Inactive", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.", + "id": "02b556fd-e673-49b7-ab6b-f2f9035967d0", + "title": "To activate or deactivate an access key for an IAM user" + } + ], + "UpdateAccountPasswordPolicy": [ + { + "input": { + "MinimumPasswordLength": 8, + "RequireNumbers": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:", + "id": "c263a1af-37dc-4423-8dba-9790284ef5e0", + "title": "To set or change the current account password policy" + } + ], + "UpdateAssumeRolePolicy": [ + { + "input": { + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}", + "RoleName": "S3AccessForEC2Instances" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command updates the role trust policy for the role named Test-Role:", + "id": "c9150063-d953-4e99-9576-9685872006c6", + "title": "To update the trust policy for an IAM role" + } + ], + "UpdateGroup": [ + { + "input": { + "GroupName": "Test", + "NewGroupName": "Test-1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the name of the IAM group Test to Test-1.", + "id": "f0cf1662-91ae-4278-a80e-7db54256ccba", + "title": "To rename an IAM group" + } + ], + "UpdateLoginProfile": [ + { + "input": { + "Password": "SomeKindOfPassword123!@#", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates or changes the password for the IAM user named Bob.", + "id": "036d9498-ecdb-4ed6-a8d8-366c383d1487", + "title": "To change the password for an IAM user" + } + ], + "UpdateSigningCertificate": [ + { + "input": { + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "Status": "Inactive", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the status of a signing certificate for a user named Bob to Inactive.", + "id": "829aee7b-efc5-4b3b-84a5-7f899b38018d", + "title": "To change the active status of a signing certificate for an IAM user" + } + ], + "UpdateUser": [ + { + "input": { + "NewUserName": "Robert", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.", + "id": "275d53ed-347a-44e6-b7d0-a96276154352", + "title": "To change an IAM user's name" + } + ], + "UploadServerCertificate": [ + { + "input": { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "Path": "/company/servercerts/", + "PrivateKey": "-----BEGIN DSA PRIVATE KEY----------END DSA PRIVATE KEY-----", + "ServerCertificateName": "ProdServerCert" + }, + "output": { + "ServerCertificateMetadata": { + "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert", + "Expiration": "2012-05-08T01:02:03.004Z", + "Path": "/company/servercerts/", + "ServerCertificateId": "ASCA1111111111EXAMPLE", + "ServerCertificateName": "ProdServerCert", + "UploadDate": "2010-05-08T01:02:03.004Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following upload-server-certificate command uploads a server certificate to your AWS account:", + "id": "06eab6d1-ebf2-4bd9-839d-f7508b9a38b6", + "title": "To upload a server certificate to your AWS account" + } + ], + "UploadSigningCertificate": [ + { + "input": { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "UserName": "Bob" + }, + "output": { + "Certificate": { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "ID123456789012345EXAMPLE", + "Status": "Active", + "UploadDate": "2015-06-06T21:40:08.121Z", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command uploads a signing certificate for the IAM user named Bob.", + "id": "e67489b6-7b73-4e30-9ed3-9a9e0231e458", + "title": "To upload a signing certificate for an IAM user" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/iam-2010-05-08.min.json b/node_modules/aws-sdk/apis/iam-2010-05-08.min.json new file mode 100644 index 0000000..5a39f5d --- /dev/null +++ b/node_modules/aws-sdk/apis/iam-2010-05-08.min.json @@ -0,0 +1,3679 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2010-05-08", + "endpointPrefix": "iam", + "globalEndpoint": "iam.amazonaws.com", + "protocol": "query", + "serviceAbbreviation": "IAM", + "serviceFullName": "AWS Identity and Access Management", + "serviceId": "IAM", + "signatureVersion": "v4", + "uid": "iam-2010-05-08", + "xmlNamespace": "https://iam.amazonaws.com/doc/2010-05-08/" + }, + "operations": { + "AddClientIDToOpenIDConnectProvider": { + "input": { + "type": "structure", + "required": [ + "OpenIDConnectProviderArn", + "ClientID" + ], + "members": { + "OpenIDConnectProviderArn": {}, + "ClientID": {} + } + } + }, + "AddRoleToInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName", + "RoleName" + ], + "members": { + "InstanceProfileName": {}, + "RoleName": {} + } + } + }, + "AddUserToGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserName" + ], + "members": { + "GroupName": {}, + "UserName": {} + } + } + }, + "AttachGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyArn" + ], + "members": { + "GroupName": {}, + "PolicyArn": {} + } + } + }, + "AttachRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyArn" + ], + "members": { + "RoleName": {}, + "PolicyArn": {} + } + } + }, + "AttachUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyArn" + ], + "members": { + "UserName": {}, + "PolicyArn": {} + } + } + }, + "ChangePassword": { + "input": { + "type": "structure", + "required": [ + "OldPassword", + "NewPassword" + ], + "members": { + "OldPassword": { + "shape": "Sf" + }, + "NewPassword": { + "shape": "Sf" + } + } + } + }, + "CreateAccessKey": { + "input": { + "type": "structure", + "members": { + "UserName": {} + } + }, + "output": { + "resultWrapper": "CreateAccessKeyResult", + "type": "structure", + "required": [ + "AccessKey" + ], + "members": { + "AccessKey": { + "type": "structure", + "required": [ + "UserName", + "AccessKeyId", + "Status", + "SecretAccessKey" + ], + "members": { + "UserName": {}, + "AccessKeyId": {}, + "Status": {}, + "SecretAccessKey": { + "type": "string", + "sensitive": true + }, + "CreateDate": { + "type": "timestamp" + } + } + } + } + } + }, + "CreateAccountAlias": { + "input": { + "type": "structure", + "required": [ + "AccountAlias" + ], + "members": { + "AccountAlias": {} + } + } + }, + "CreateGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "Path": {}, + "GroupName": {} + } + }, + "output": { + "resultWrapper": "CreateGroupResult", + "type": "structure", + "required": [ + "Group" + ], + "members": { + "Group": { + "shape": "Ss" + } + } + } + }, + "CreateInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName" + ], + "members": { + "InstanceProfileName": {}, + "Path": {} + } + }, + "output": { + "resultWrapper": "CreateInstanceProfileResult", + "type": "structure", + "required": [ + "InstanceProfile" + ], + "members": { + "InstanceProfile": { + "shape": "Sw" + } + } + } + }, + "CreateLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName", + "Password" + ], + "members": { + "UserName": {}, + "Password": { + "shape": "Sf" + }, + "PasswordResetRequired": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateLoginProfileResult", + "type": "structure", + "required": [ + "LoginProfile" + ], + "members": { + "LoginProfile": { + "shape": "S1b" + } + } + } + }, + "CreateOpenIDConnectProvider": { + "input": { + "type": "structure", + "required": [ + "Url", + "ThumbprintList" + ], + "members": { + "Url": {}, + "ClientIDList": { + "shape": "S1e" + }, + "ThumbprintList": { + "shape": "S1f" + } + } + }, + "output": { + "resultWrapper": "CreateOpenIDConnectProviderResult", + "type": "structure", + "members": { + "OpenIDConnectProviderArn": {} + } + } + }, + "CreatePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyName", + "PolicyDocument" + ], + "members": { + "PolicyName": {}, + "Path": {}, + "PolicyDocument": {}, + "Description": {} + } + }, + "output": { + "resultWrapper": "CreatePolicyResult", + "type": "structure", + "members": { + "Policy": { + "shape": "S1n" + } + } + } + }, + "CreatePolicyVersion": { + "input": { + "type": "structure", + "required": [ + "PolicyArn", + "PolicyDocument" + ], + "members": { + "PolicyArn": {}, + "PolicyDocument": {}, + "SetAsDefault": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreatePolicyVersionResult", + "type": "structure", + "members": { + "PolicyVersion": { + "shape": "S1s" + } + } + } + }, + "CreateRole": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "AssumeRolePolicyDocument" + ], + "members": { + "Path": {}, + "RoleName": {}, + "AssumeRolePolicyDocument": {}, + "Description": {}, + "MaxSessionDuration": { + "type": "integer" + }, + "PermissionsBoundary": {}, + "Tags": { + "shape": "S14" + } + } + }, + "output": { + "resultWrapper": "CreateRoleResult", + "type": "structure", + "required": [ + "Role" + ], + "members": { + "Role": { + "shape": "Sy" + } + } + } + }, + "CreateSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLMetadataDocument", + "Name" + ], + "members": { + "SAMLMetadataDocument": {}, + "Name": {} + } + }, + "output": { + "resultWrapper": "CreateSAMLProviderResult", + "type": "structure", + "members": { + "SAMLProviderArn": {} + } + } + }, + "CreateServiceLinkedRole": { + "input": { + "type": "structure", + "required": [ + "AWSServiceName" + ], + "members": { + "AWSServiceName": {}, + "Description": {}, + "CustomSuffix": {} + } + }, + "output": { + "resultWrapper": "CreateServiceLinkedRoleResult", + "type": "structure", + "members": { + "Role": { + "shape": "Sy" + } + } + } + }, + "CreateServiceSpecificCredential": { + "input": { + "type": "structure", + "required": [ + "UserName", + "ServiceName" + ], + "members": { + "UserName": {}, + "ServiceName": {} + } + }, + "output": { + "resultWrapper": "CreateServiceSpecificCredentialResult", + "type": "structure", + "members": { + "ServiceSpecificCredential": { + "shape": "S25" + } + } + } + }, + "CreateUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "Path": {}, + "UserName": {}, + "PermissionsBoundary": {}, + "Tags": { + "shape": "S14" + } + } + }, + "output": { + "resultWrapper": "CreateUserResult", + "type": "structure", + "members": { + "User": { + "shape": "S2b" + } + } + } + }, + "CreateVirtualMFADevice": { + "input": { + "type": "structure", + "required": [ + "VirtualMFADeviceName" + ], + "members": { + "Path": {}, + "VirtualMFADeviceName": {} + } + }, + "output": { + "resultWrapper": "CreateVirtualMFADeviceResult", + "type": "structure", + "required": [ + "VirtualMFADevice" + ], + "members": { + "VirtualMFADevice": { + "shape": "S2f" + } + } + } + }, + "DeactivateMFADevice": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber" + ], + "members": { + "UserName": {}, + "SerialNumber": {} + } + } + }, + "DeleteAccessKey": { + "input": { + "type": "structure", + "required": [ + "AccessKeyId" + ], + "members": { + "UserName": {}, + "AccessKeyId": {} + } + } + }, + "DeleteAccountAlias": { + "input": { + "type": "structure", + "required": [ + "AccountAlias" + ], + "members": { + "AccountAlias": {} + } + } + }, + "DeleteAccountPasswordPolicy": {}, + "DeleteGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {} + } + } + }, + "DeleteGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyName" + ], + "members": { + "GroupName": {}, + "PolicyName": {} + } + } + }, + "DeleteInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName" + ], + "members": { + "InstanceProfileName": {} + } + } + }, + "DeleteLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {} + } + } + }, + "DeleteOpenIDConnectProvider": { + "input": { + "type": "structure", + "required": [ + "OpenIDConnectProviderArn" + ], + "members": { + "OpenIDConnectProviderArn": {} + } + } + }, + "DeletePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyArn" + ], + "members": { + "PolicyArn": {} + } + } + }, + "DeletePolicyVersion": { + "input": { + "type": "structure", + "required": [ + "PolicyArn", + "VersionId" + ], + "members": { + "PolicyArn": {}, + "VersionId": {} + } + } + }, + "DeleteRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {} + } + } + }, + "DeleteRolePermissionsBoundary": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {} + } + } + }, + "DeleteRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyName" + ], + "members": { + "RoleName": {}, + "PolicyName": {} + } + } + }, + "DeleteSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLProviderArn" + ], + "members": { + "SAMLProviderArn": {} + } + } + }, + "DeleteSSHPublicKey": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SSHPublicKeyId" + ], + "members": { + "UserName": {}, + "SSHPublicKeyId": {} + } + } + }, + "DeleteServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName" + ], + "members": { + "ServerCertificateName": {} + } + } + }, + "DeleteServiceLinkedRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {} + } + }, + "output": { + "resultWrapper": "DeleteServiceLinkedRoleResult", + "type": "structure", + "required": [ + "DeletionTaskId" + ], + "members": { + "DeletionTaskId": {} + } + } + }, + "DeleteServiceSpecificCredential": { + "input": { + "type": "structure", + "required": [ + "ServiceSpecificCredentialId" + ], + "members": { + "UserName": {}, + "ServiceSpecificCredentialId": {} + } + } + }, + "DeleteSigningCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateId" + ], + "members": { + "UserName": {}, + "CertificateId": {} + } + } + }, + "DeleteUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {} + } + } + }, + "DeleteUserPermissionsBoundary": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {} + } + } + }, + "DeleteUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyName" + ], + "members": { + "UserName": {}, + "PolicyName": {} + } + } + }, + "DeleteVirtualMFADevice": { + "input": { + "type": "structure", + "required": [ + "SerialNumber" + ], + "members": { + "SerialNumber": {} + } + } + }, + "DetachGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyArn" + ], + "members": { + "GroupName": {}, + "PolicyArn": {} + } + } + }, + "DetachRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyArn" + ], + "members": { + "RoleName": {}, + "PolicyArn": {} + } + } + }, + "DetachUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyArn" + ], + "members": { + "UserName": {}, + "PolicyArn": {} + } + } + }, + "EnableMFADevice": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members": { + "UserName": {}, + "SerialNumber": {}, + "AuthenticationCode1": {}, + "AuthenticationCode2": {} + } + } + }, + "GenerateCredentialReport": { + "output": { + "resultWrapper": "GenerateCredentialReportResult", + "type": "structure", + "members": { + "State": {}, + "Description": {} + } + } + }, + "GenerateServiceLastAccessedDetails": { + "input": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {} + } + }, + "output": { + "resultWrapper": "GenerateServiceLastAccessedDetailsResult", + "type": "structure", + "members": { + "JobId": {} + } + } + }, + "GetAccessKeyLastUsed": { + "input": { + "type": "structure", + "required": [ + "AccessKeyId" + ], + "members": { + "AccessKeyId": {} + } + }, + "output": { + "resultWrapper": "GetAccessKeyLastUsedResult", + "type": "structure", + "members": { + "UserName": {}, + "AccessKeyLastUsed": { + "type": "structure", + "required": [ + "LastUsedDate", + "ServiceName", + "Region" + ], + "members": { + "LastUsedDate": { + "type": "timestamp" + }, + "ServiceName": {}, + "Region": {} + } + } + } + } + }, + "GetAccountAuthorizationDetails": { + "input": { + "type": "structure", + "members": { + "Filter": { + "type": "list", + "member": {} + }, + "MaxItems": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "GetAccountAuthorizationDetailsResult", + "type": "structure", + "members": { + "UserDetailList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "UserName": {}, + "UserId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "UserPolicyList": { + "shape": "S3x" + }, + "GroupList": { + "type": "list", + "member": {} + }, + "AttachedManagedPolicies": { + "shape": "S40" + }, + "PermissionsBoundary": { + "shape": "S12" + }, + "Tags": { + "shape": "S14" + } + } + } + }, + "GroupDetailList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "GroupName": {}, + "GroupId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "GroupPolicyList": { + "shape": "S3x" + }, + "AttachedManagedPolicies": { + "shape": "S40" + } + } + } + }, + "RoleDetailList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Path": {}, + "RoleName": {}, + "RoleId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "AssumeRolePolicyDocument": {}, + "InstanceProfileList": { + "shape": "S46" + }, + "RolePolicyList": { + "shape": "S3x" + }, + "AttachedManagedPolicies": { + "shape": "S40" + }, + "PermissionsBoundary": { + "shape": "S12" + }, + "Tags": { + "shape": "S14" + } + } + } + }, + "Policies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "PolicyId": {}, + "Arn": {}, + "Path": {}, + "DefaultVersionId": {}, + "AttachmentCount": { + "type": "integer" + }, + "PermissionsBoundaryUsageCount": { + "type": "integer" + }, + "IsAttachable": { + "type": "boolean" + }, + "Description": {}, + "CreateDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + }, + "PolicyVersionList": { + "shape": "S49" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "GetAccountPasswordPolicy": { + "output": { + "resultWrapper": "GetAccountPasswordPolicyResult", + "type": "structure", + "required": [ + "PasswordPolicy" + ], + "members": { + "PasswordPolicy": { + "type": "structure", + "members": { + "MinimumPasswordLength": { + "type": "integer" + }, + "RequireSymbols": { + "type": "boolean" + }, + "RequireNumbers": { + "type": "boolean" + }, + "RequireUppercaseCharacters": { + "type": "boolean" + }, + "RequireLowercaseCharacters": { + "type": "boolean" + }, + "AllowUsersToChangePassword": { + "type": "boolean" + }, + "ExpirePasswords": { + "type": "boolean" + }, + "MaxPasswordAge": { + "type": "integer" + }, + "PasswordReusePrevention": { + "type": "integer" + }, + "HardExpiry": { + "type": "boolean" + } + } + } + } + } + }, + "GetAccountSummary": { + "output": { + "resultWrapper": "GetAccountSummaryResult", + "type": "structure", + "members": { + "SummaryMap": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + } + }, + "GetContextKeysForCustomPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyInputList" + ], + "members": { + "PolicyInputList": { + "shape": "S4m" + } + } + }, + "output": { + "shape": "S4n", + "resultWrapper": "GetContextKeysForCustomPolicyResult" + } + }, + "GetContextKeysForPrincipalPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicySourceArn" + ], + "members": { + "PolicySourceArn": {}, + "PolicyInputList": { + "shape": "S4m" + } + } + }, + "output": { + "shape": "S4n", + "resultWrapper": "GetContextKeysForPrincipalPolicyResult" + } + }, + "GetCredentialReport": { + "output": { + "resultWrapper": "GetCredentialReportResult", + "type": "structure", + "members": { + "Content": { + "type": "blob" + }, + "ReportFormat": {}, + "GeneratedTime": { + "type": "timestamp" + } + } + } + }, + "GetGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "GetGroupResult", + "type": "structure", + "required": [ + "Group", + "Users" + ], + "members": { + "Group": { + "shape": "Ss" + }, + "Users": { + "shape": "S4w" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "GetGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyName" + ], + "members": { + "GroupName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "GetGroupPolicyResult", + "type": "structure", + "required": [ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "GroupName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "GetInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName" + ], + "members": { + "InstanceProfileName": {} + } + }, + "output": { + "resultWrapper": "GetInstanceProfileResult", + "type": "structure", + "required": [ + "InstanceProfile" + ], + "members": { + "InstanceProfile": { + "shape": "Sw" + } + } + } + }, + "GetLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {} + } + }, + "output": { + "resultWrapper": "GetLoginProfileResult", + "type": "structure", + "required": [ + "LoginProfile" + ], + "members": { + "LoginProfile": { + "shape": "S1b" + } + } + } + }, + "GetOpenIDConnectProvider": { + "input": { + "type": "structure", + "required": [ + "OpenIDConnectProviderArn" + ], + "members": { + "OpenIDConnectProviderArn": {} + } + }, + "output": { + "resultWrapper": "GetOpenIDConnectProviderResult", + "type": "structure", + "members": { + "Url": {}, + "ClientIDList": { + "shape": "S1e" + }, + "ThumbprintList": { + "shape": "S1f" + }, + "CreateDate": { + "type": "timestamp" + } + } + } + }, + "GetPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyArn" + ], + "members": { + "PolicyArn": {} + } + }, + "output": { + "resultWrapper": "GetPolicyResult", + "type": "structure", + "members": { + "Policy": { + "shape": "S1n" + } + } + } + }, + "GetPolicyVersion": { + "input": { + "type": "structure", + "required": [ + "PolicyArn", + "VersionId" + ], + "members": { + "PolicyArn": {}, + "VersionId": {} + } + }, + "output": { + "resultWrapper": "GetPolicyVersionResult", + "type": "structure", + "members": { + "PolicyVersion": { + "shape": "S1s" + } + } + } + }, + "GetRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {} + } + }, + "output": { + "resultWrapper": "GetRoleResult", + "type": "structure", + "required": [ + "Role" + ], + "members": { + "Role": { + "shape": "Sy" + } + } + } + }, + "GetRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyName" + ], + "members": { + "RoleName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "GetRolePolicyResult", + "type": "structure", + "required": [ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "RoleName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "GetSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLProviderArn" + ], + "members": { + "SAMLProviderArn": {} + } + }, + "output": { + "resultWrapper": "GetSAMLProviderResult", + "type": "structure", + "members": { + "SAMLMetadataDocument": {}, + "CreateDate": { + "type": "timestamp" + }, + "ValidUntil": { + "type": "timestamp" + } + } + } + }, + "GetSSHPublicKey": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SSHPublicKeyId", + "Encoding" + ], + "members": { + "UserName": {}, + "SSHPublicKeyId": {}, + "Encoding": {} + } + }, + "output": { + "resultWrapper": "GetSSHPublicKeyResult", + "type": "structure", + "members": { + "SSHPublicKey": { + "shape": "S5i" + } + } + } + }, + "GetServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName" + ], + "members": { + "ServerCertificateName": {} + } + }, + "output": { + "resultWrapper": "GetServerCertificateResult", + "type": "structure", + "required": [ + "ServerCertificate" + ], + "members": { + "ServerCertificate": { + "type": "structure", + "required": [ + "ServerCertificateMetadata", + "CertificateBody" + ], + "members": { + "ServerCertificateMetadata": { + "shape": "S5o" + }, + "CertificateBody": {}, + "CertificateChain": {} + } + } + } + } + }, + "GetServiceLastAccessedDetails": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxItems": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "GetServiceLastAccessedDetailsResult", + "type": "structure", + "required": [ + "JobStatus", + "JobCreationDate", + "ServicesLastAccessed", + "JobCompletionDate" + ], + "members": { + "JobStatus": {}, + "JobCreationDate": { + "type": "timestamp" + }, + "ServicesLastAccessed": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ServiceName", + "ServiceNamespace" + ], + "members": { + "ServiceName": {}, + "LastAuthenticated": { + "type": "timestamp" + }, + "ServiceNamespace": {}, + "LastAuthenticatedEntity": {}, + "TotalAuthenticatedEntities": { + "type": "integer" + } + } + } + }, + "JobCompletionDate": { + "type": "timestamp" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {}, + "Error": { + "shape": "S5z" + } + } + } + }, + "GetServiceLastAccessedDetailsWithEntities": { + "input": { + "type": "structure", + "required": [ + "JobId", + "ServiceNamespace" + ], + "members": { + "JobId": {}, + "ServiceNamespace": {}, + "MaxItems": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "GetServiceLastAccessedDetailsWithEntitiesResult", + "type": "structure", + "required": [ + "JobStatus", + "JobCreationDate", + "JobCompletionDate", + "EntityDetailsList" + ], + "members": { + "JobStatus": {}, + "JobCreationDate": { + "type": "timestamp" + }, + "JobCompletionDate": { + "type": "timestamp" + }, + "EntityDetailsList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "EntityInfo" + ], + "members": { + "EntityInfo": { + "type": "structure", + "required": [ + "Arn", + "Name", + "Type", + "Id" + ], + "members": { + "Arn": {}, + "Name": {}, + "Type": {}, + "Id": {}, + "Path": {} + } + }, + "LastAuthenticated": { + "type": "timestamp" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {}, + "Error": { + "shape": "S5z" + } + } + } + }, + "GetServiceLinkedRoleDeletionStatus": { + "input": { + "type": "structure", + "required": [ + "DeletionTaskId" + ], + "members": { + "DeletionTaskId": {} + } + }, + "output": { + "resultWrapper": "GetServiceLinkedRoleDeletionStatusResult", + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {}, + "Reason": { + "type": "structure", + "members": { + "Reason": {}, + "RoleUsageList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Region": {}, + "Resources": { + "type": "list", + "member": {} + } + } + } + } + } + } + } + } + }, + "GetUser": { + "input": { + "type": "structure", + "members": { + "UserName": {} + } + }, + "output": { + "resultWrapper": "GetUserResult", + "type": "structure", + "required": [ + "User" + ], + "members": { + "User": { + "shape": "S2b" + } + } + } + }, + "GetUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyName" + ], + "members": { + "UserName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "GetUserPolicyResult", + "type": "structure", + "required": [ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "UserName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "ListAccessKeys": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListAccessKeysResult", + "type": "structure", + "required": [ + "AccessKeyMetadata" + ], + "members": { + "AccessKeyMetadata": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UserName": {}, + "AccessKeyId": {}, + "Status": {}, + "CreateDate": { + "type": "timestamp" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListAccountAliases": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListAccountAliasesResult", + "type": "structure", + "required": [ + "AccountAliases" + ], + "members": { + "AccountAliases": { + "type": "list", + "member": {} + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListAttachedGroupPolicies": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListAttachedGroupPoliciesResult", + "type": "structure", + "members": { + "AttachedPolicies": { + "shape": "S40" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListAttachedRolePolicies": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {}, + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListAttachedRolePoliciesResult", + "type": "structure", + "members": { + "AttachedPolicies": { + "shape": "S40" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListAttachedUserPolicies": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListAttachedUserPoliciesResult", + "type": "structure", + "members": { + "AttachedPolicies": { + "shape": "S40" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListEntitiesForPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyArn" + ], + "members": { + "PolicyArn": {}, + "EntityFilter": {}, + "PathPrefix": {}, + "PolicyUsageFilter": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListEntitiesForPolicyResult", + "type": "structure", + "members": { + "PolicyGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GroupName": {}, + "GroupId": {} + } + } + }, + "PolicyUsers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UserName": {}, + "UserId": {} + } + } + }, + "PolicyRoles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RoleName": {}, + "RoleId": {} + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListGroupPolicies": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListGroupPoliciesResult", + "type": "structure", + "required": [ + "PolicyNames" + ], + "members": { + "PolicyNames": { + "shape": "S77" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListGroups": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListGroupsResult", + "type": "structure", + "required": [ + "Groups" + ], + "members": { + "Groups": { + "shape": "S7b" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListGroupsForUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListGroupsForUserResult", + "type": "structure", + "required": [ + "Groups" + ], + "members": { + "Groups": { + "shape": "S7b" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListInstanceProfiles": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListInstanceProfilesResult", + "type": "structure", + "required": [ + "InstanceProfiles" + ], + "members": { + "InstanceProfiles": { + "shape": "S46" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListInstanceProfilesForRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListInstanceProfilesForRoleResult", + "type": "structure", + "required": [ + "InstanceProfiles" + ], + "members": { + "InstanceProfiles": { + "shape": "S46" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListMFADevices": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListMFADevicesResult", + "type": "structure", + "required": [ + "MFADevices" + ], + "members": { + "MFADevices": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber", + "EnableDate" + ], + "members": { + "UserName": {}, + "SerialNumber": {}, + "EnableDate": { + "type": "timestamp" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListOpenIDConnectProviders": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "ListOpenIDConnectProvidersResult", + "type": "structure", + "members": { + "OpenIDConnectProviderList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {} + } + } + } + } + } + }, + "ListPolicies": { + "input": { + "type": "structure", + "members": { + "Scope": {}, + "OnlyAttached": { + "type": "boolean" + }, + "PathPrefix": {}, + "PolicyUsageFilter": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListPoliciesResult", + "type": "structure", + "members": { + "Policies": { + "type": "list", + "member": { + "shape": "S1n" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListPoliciesGrantingServiceAccess": { + "input": { + "type": "structure", + "required": [ + "Arn", + "ServiceNamespaces" + ], + "members": { + "Marker": {}, + "Arn": {}, + "ServiceNamespaces": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "ListPoliciesGrantingServiceAccessResult", + "type": "structure", + "required": [ + "PoliciesGrantingServiceAccess" + ], + "members": { + "PoliciesGrantingServiceAccess": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ServiceNamespace": {}, + "Policies": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "PolicyName", + "PolicyType" + ], + "members": { + "PolicyName": {}, + "PolicyType": {}, + "PolicyArn": {}, + "EntityType": {}, + "EntityName": {} + } + } + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListPolicyVersions": { + "input": { + "type": "structure", + "required": [ + "PolicyArn" + ], + "members": { + "PolicyArn": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListPolicyVersionsResult", + "type": "structure", + "members": { + "Versions": { + "shape": "S49" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListRolePolicies": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListRolePoliciesResult", + "type": "structure", + "required": [ + "PolicyNames" + ], + "members": { + "PolicyNames": { + "shape": "S77" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListRoleTags": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListRoleTagsResult", + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S14" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListRoles": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListRolesResult", + "type": "structure", + "required": [ + "Roles" + ], + "members": { + "Roles": { + "shape": "Sx" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListSAMLProviders": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "ListSAMLProvidersResult", + "type": "structure", + "members": { + "SAMLProviderList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "ValidUntil": { + "type": "timestamp" + }, + "CreateDate": { + "type": "timestamp" + } + } + } + } + } + } + }, + "ListSSHPublicKeys": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListSSHPublicKeysResult", + "type": "structure", + "members": { + "SSHPublicKeys": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "UserName", + "SSHPublicKeyId", + "Status", + "UploadDate" + ], + "members": { + "UserName": {}, + "SSHPublicKeyId": {}, + "Status": {}, + "UploadDate": { + "type": "timestamp" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListServerCertificates": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListServerCertificatesResult", + "type": "structure", + "required": [ + "ServerCertificateMetadataList" + ], + "members": { + "ServerCertificateMetadataList": { + "type": "list", + "member": { + "shape": "S5o" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListServiceSpecificCredentials": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "ServiceName": {} + } + }, + "output": { + "resultWrapper": "ListServiceSpecificCredentialsResult", + "type": "structure", + "members": { + "ServiceSpecificCredentials": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "UserName", + "Status", + "ServiceUserName", + "CreateDate", + "ServiceSpecificCredentialId", + "ServiceName" + ], + "members": { + "UserName": {}, + "Status": {}, + "ServiceUserName": {}, + "CreateDate": { + "type": "timestamp" + }, + "ServiceSpecificCredentialId": {}, + "ServiceName": {} + } + } + } + } + } + }, + "ListSigningCertificates": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListSigningCertificatesResult", + "type": "structure", + "required": [ + "Certificates" + ], + "members": { + "Certificates": { + "type": "list", + "member": { + "shape": "S8t" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListUserPolicies": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListUserPoliciesResult", + "type": "structure", + "required": [ + "PolicyNames" + ], + "members": { + "PolicyNames": { + "shape": "S77" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListUserTags": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListUserTagsResult", + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "S14" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListUsers": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListUsersResult", + "type": "structure", + "required": [ + "Users" + ], + "members": { + "Users": { + "shape": "S4w" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListVirtualMFADevices": { + "input": { + "type": "structure", + "members": { + "AssignmentStatus": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListVirtualMFADevicesResult", + "type": "structure", + "required": [ + "VirtualMFADevices" + ], + "members": { + "VirtualMFADevices": { + "type": "list", + "member": { + "shape": "S2f" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "PutGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "GroupName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "PutRolePermissionsBoundary": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PermissionsBoundary" + ], + "members": { + "RoleName": {}, + "PermissionsBoundary": {} + } + } + }, + "PutRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "RoleName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "PutUserPermissionsBoundary": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PermissionsBoundary" + ], + "members": { + "UserName": {}, + "PermissionsBoundary": {} + } + } + }, + "PutUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "UserName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "RemoveClientIDFromOpenIDConnectProvider": { + "input": { + "type": "structure", + "required": [ + "OpenIDConnectProviderArn", + "ClientID" + ], + "members": { + "OpenIDConnectProviderArn": {}, + "ClientID": {} + } + } + }, + "RemoveRoleFromInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName", + "RoleName" + ], + "members": { + "InstanceProfileName": {}, + "RoleName": {} + } + } + }, + "RemoveUserFromGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserName" + ], + "members": { + "GroupName": {}, + "UserName": {} + } + } + }, + "ResetServiceSpecificCredential": { + "input": { + "type": "structure", + "required": [ + "ServiceSpecificCredentialId" + ], + "members": { + "UserName": {}, + "ServiceSpecificCredentialId": {} + } + }, + "output": { + "resultWrapper": "ResetServiceSpecificCredentialResult", + "type": "structure", + "members": { + "ServiceSpecificCredential": { + "shape": "S25" + } + } + } + }, + "ResyncMFADevice": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members": { + "UserName": {}, + "SerialNumber": {}, + "AuthenticationCode1": {}, + "AuthenticationCode2": {} + } + } + }, + "SetDefaultPolicyVersion": { + "input": { + "type": "structure", + "required": [ + "PolicyArn", + "VersionId" + ], + "members": { + "PolicyArn": {}, + "VersionId": {} + } + } + }, + "SetSecurityTokenServicePreferences": { + "input": { + "type": "structure", + "required": [ + "GlobalEndpointTokenVersion" + ], + "members": { + "GlobalEndpointTokenVersion": {} + } + } + }, + "SimulateCustomPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyInputList", + "ActionNames" + ], + "members": { + "PolicyInputList": { + "shape": "S4m" + }, + "ActionNames": { + "shape": "S9j" + }, + "ResourceArns": { + "shape": "S9l" + }, + "ResourcePolicy": {}, + "ResourceOwner": {}, + "CallerArn": {}, + "ContextEntries": { + "shape": "S9n" + }, + "ResourceHandlingOption": {}, + "MaxItems": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "shape": "S9t", + "resultWrapper": "SimulateCustomPolicyResult" + } + }, + "SimulatePrincipalPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicySourceArn", + "ActionNames" + ], + "members": { + "PolicySourceArn": {}, + "PolicyInputList": { + "shape": "S4m" + }, + "ActionNames": { + "shape": "S9j" + }, + "ResourceArns": { + "shape": "S9l" + }, + "ResourcePolicy": {}, + "ResourceOwner": {}, + "CallerArn": {}, + "ContextEntries": { + "shape": "S9n" + }, + "ResourceHandlingOption": {}, + "MaxItems": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "shape": "S9t", + "resultWrapper": "SimulatePrincipalPolicyResult" + } + }, + "TagRole": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "Tags" + ], + "members": { + "RoleName": {}, + "Tags": { + "shape": "S14" + } + } + } + }, + "TagUser": { + "input": { + "type": "structure", + "required": [ + "UserName", + "Tags" + ], + "members": { + "UserName": {}, + "Tags": { + "shape": "S14" + } + } + } + }, + "UntagRole": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "TagKeys" + ], + "members": { + "RoleName": {}, + "TagKeys": { + "shape": "Sad" + } + } + } + }, + "UntagUser": { + "input": { + "type": "structure", + "required": [ + "UserName", + "TagKeys" + ], + "members": { + "UserName": {}, + "TagKeys": { + "shape": "Sad" + } + } + } + }, + "UpdateAccessKey": { + "input": { + "type": "structure", + "required": [ + "AccessKeyId", + "Status" + ], + "members": { + "UserName": {}, + "AccessKeyId": {}, + "Status": {} + } + } + }, + "UpdateAccountPasswordPolicy": { + "input": { + "type": "structure", + "members": { + "MinimumPasswordLength": { + "type": "integer" + }, + "RequireSymbols": { + "type": "boolean" + }, + "RequireNumbers": { + "type": "boolean" + }, + "RequireUppercaseCharacters": { + "type": "boolean" + }, + "RequireLowercaseCharacters": { + "type": "boolean" + }, + "AllowUsersToChangePassword": { + "type": "boolean" + }, + "MaxPasswordAge": { + "type": "integer" + }, + "PasswordReusePrevention": { + "type": "integer" + }, + "HardExpiry": { + "type": "boolean" + } + } + } + }, + "UpdateAssumeRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyDocument" + ], + "members": { + "RoleName": {}, + "PolicyDocument": {} + } + } + }, + "UpdateGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "NewPath": {}, + "NewGroupName": {} + } + } + }, + "UpdateLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "Password": { + "shape": "Sf" + }, + "PasswordResetRequired": { + "type": "boolean" + } + } + } + }, + "UpdateOpenIDConnectProviderThumbprint": { + "input": { + "type": "structure", + "required": [ + "OpenIDConnectProviderArn", + "ThumbprintList" + ], + "members": { + "OpenIDConnectProviderArn": {}, + "ThumbprintList": { + "shape": "S1f" + } + } + } + }, + "UpdateRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {}, + "Description": {}, + "MaxSessionDuration": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "UpdateRoleResult", + "type": "structure", + "members": {} + } + }, + "UpdateRoleDescription": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "Description" + ], + "members": { + "RoleName": {}, + "Description": {} + } + }, + "output": { + "resultWrapper": "UpdateRoleDescriptionResult", + "type": "structure", + "members": { + "Role": { + "shape": "Sy" + } + } + } + }, + "UpdateSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLMetadataDocument", + "SAMLProviderArn" + ], + "members": { + "SAMLMetadataDocument": {}, + "SAMLProviderArn": {} + } + }, + "output": { + "resultWrapper": "UpdateSAMLProviderResult", + "type": "structure", + "members": { + "SAMLProviderArn": {} + } + } + }, + "UpdateSSHPublicKey": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SSHPublicKeyId", + "Status" + ], + "members": { + "UserName": {}, + "SSHPublicKeyId": {}, + "Status": {} + } + } + }, + "UpdateServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName" + ], + "members": { + "ServerCertificateName": {}, + "NewPath": {}, + "NewServerCertificateName": {} + } + } + }, + "UpdateServiceSpecificCredential": { + "input": { + "type": "structure", + "required": [ + "ServiceSpecificCredentialId", + "Status" + ], + "members": { + "UserName": {}, + "ServiceSpecificCredentialId": {}, + "Status": {} + } + } + }, + "UpdateSigningCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateId", + "Status" + ], + "members": { + "UserName": {}, + "CertificateId": {}, + "Status": {} + } + } + }, + "UpdateUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "NewPath": {}, + "NewUserName": {} + } + } + }, + "UploadSSHPublicKey": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SSHPublicKeyBody" + ], + "members": { + "UserName": {}, + "SSHPublicKeyBody": {} + } + }, + "output": { + "resultWrapper": "UploadSSHPublicKeyResult", + "type": "structure", + "members": { + "SSHPublicKey": { + "shape": "S5i" + } + } + } + }, + "UploadServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName", + "CertificateBody", + "PrivateKey" + ], + "members": { + "Path": {}, + "ServerCertificateName": {}, + "CertificateBody": {}, + "PrivateKey": { + "type": "string", + "sensitive": true + }, + "CertificateChain": {} + } + }, + "output": { + "resultWrapper": "UploadServerCertificateResult", + "type": "structure", + "members": { + "ServerCertificateMetadata": { + "shape": "S5o" + } + } + } + }, + "UploadSigningCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateBody" + ], + "members": { + "UserName": {}, + "CertificateBody": {} + } + }, + "output": { + "resultWrapper": "UploadSigningCertificateResult", + "type": "structure", + "required": [ + "Certificate" + ], + "members": { + "Certificate": { + "shape": "S8t" + } + } + } + } + }, + "shapes": { + "Sf": { + "type": "string", + "sensitive": true + }, + "Ss": { + "type": "structure", + "required": [ + "Path", + "GroupName", + "GroupId", + "Arn", + "CreateDate" + ], + "members": { + "Path": {}, + "GroupName": {}, + "GroupId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + } + } + }, + "Sw": { + "type": "structure", + "required": [ + "Path", + "InstanceProfileName", + "InstanceProfileId", + "Arn", + "CreateDate", + "Roles" + ], + "members": { + "Path": {}, + "InstanceProfileName": {}, + "InstanceProfileId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "Roles": { + "shape": "Sx" + } + } + }, + "Sx": { + "type": "list", + "member": { + "shape": "Sy" + } + }, + "Sy": { + "type": "structure", + "required": [ + "Path", + "RoleName", + "RoleId", + "Arn", + "CreateDate" + ], + "members": { + "Path": {}, + "RoleName": {}, + "RoleId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "AssumeRolePolicyDocument": {}, + "Description": {}, + "MaxSessionDuration": { + "type": "integer" + }, + "PermissionsBoundary": { + "shape": "S12" + }, + "Tags": { + "shape": "S14" + } + } + }, + "S12": { + "type": "structure", + "members": { + "PermissionsBoundaryType": {}, + "PermissionsBoundaryArn": {} + } + }, + "S14": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S1b": { + "type": "structure", + "required": [ + "UserName", + "CreateDate" + ], + "members": { + "UserName": {}, + "CreateDate": { + "type": "timestamp" + }, + "PasswordResetRequired": { + "type": "boolean" + } + } + }, + "S1e": { + "type": "list", + "member": {} + }, + "S1f": { + "type": "list", + "member": {} + }, + "S1n": { + "type": "structure", + "members": { + "PolicyName": {}, + "PolicyId": {}, + "Arn": {}, + "Path": {}, + "DefaultVersionId": {}, + "AttachmentCount": { + "type": "integer" + }, + "PermissionsBoundaryUsageCount": { + "type": "integer" + }, + "IsAttachable": { + "type": "boolean" + }, + "Description": {}, + "CreateDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + } + } + }, + "S1s": { + "type": "structure", + "members": { + "Document": {}, + "VersionId": {}, + "IsDefaultVersion": { + "type": "boolean" + }, + "CreateDate": { + "type": "timestamp" + } + } + }, + "S25": { + "type": "structure", + "required": [ + "CreateDate", + "ServiceName", + "ServiceUserName", + "ServicePassword", + "ServiceSpecificCredentialId", + "UserName", + "Status" + ], + "members": { + "CreateDate": { + "type": "timestamp" + }, + "ServiceName": {}, + "ServiceUserName": {}, + "ServicePassword": { + "type": "string", + "sensitive": true + }, + "ServiceSpecificCredentialId": {}, + "UserName": {}, + "Status": {} + } + }, + "S2b": { + "type": "structure", + "required": [ + "Path", + "UserName", + "UserId", + "Arn", + "CreateDate" + ], + "members": { + "Path": {}, + "UserName": {}, + "UserId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "PasswordLastUsed": { + "type": "timestamp" + }, + "PermissionsBoundary": { + "shape": "S12" + }, + "Tags": { + "shape": "S14" + } + } + }, + "S2f": { + "type": "structure", + "required": [ + "SerialNumber" + ], + "members": { + "SerialNumber": {}, + "Base32StringSeed": { + "shape": "S2h" + }, + "QRCodePNG": { + "shape": "S2h" + }, + "User": { + "shape": "S2b" + }, + "EnableDate": { + "type": "timestamp" + } + } + }, + "S2h": { + "type": "blob", + "sensitive": true + }, + "S3x": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "S40": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "PolicyArn": {} + } + } + }, + "S46": { + "type": "list", + "member": { + "shape": "Sw" + } + }, + "S49": { + "type": "list", + "member": { + "shape": "S1s" + } + }, + "S4m": { + "type": "list", + "member": {} + }, + "S4n": { + "type": "structure", + "members": { + "ContextKeyNames": { + "shape": "S4o" + } + } + }, + "S4o": { + "type": "list", + "member": {} + }, + "S4w": { + "type": "list", + "member": { + "shape": "S2b" + } + }, + "S5i": { + "type": "structure", + "required": [ + "UserName", + "SSHPublicKeyId", + "Fingerprint", + "SSHPublicKeyBody", + "Status" + ], + "members": { + "UserName": {}, + "SSHPublicKeyId": {}, + "Fingerprint": {}, + "SSHPublicKeyBody": {}, + "Status": {}, + "UploadDate": { + "type": "timestamp" + } + } + }, + "S5o": { + "type": "structure", + "required": [ + "Path", + "ServerCertificateName", + "ServerCertificateId", + "Arn" + ], + "members": { + "Path": {}, + "ServerCertificateName": {}, + "ServerCertificateId": {}, + "Arn": {}, + "UploadDate": { + "type": "timestamp" + }, + "Expiration": { + "type": "timestamp" + } + } + }, + "S5z": { + "type": "structure", + "required": [ + "Message", + "Code" + ], + "members": { + "Message": {}, + "Code": {} + } + }, + "S77": { + "type": "list", + "member": {} + }, + "S7b": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "S8t": { + "type": "structure", + "required": [ + "UserName", + "CertificateId", + "CertificateBody", + "Status" + ], + "members": { + "UserName": {}, + "CertificateId": {}, + "CertificateBody": {}, + "Status": {}, + "UploadDate": { + "type": "timestamp" + } + } + }, + "S9j": { + "type": "list", + "member": {} + }, + "S9l": { + "type": "list", + "member": {} + }, + "S9n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ContextKeyName": {}, + "ContextKeyValues": { + "type": "list", + "member": {} + }, + "ContextKeyType": {} + } + } + }, + "S9t": { + "type": "structure", + "members": { + "EvaluationResults": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "EvalActionName", + "EvalDecision" + ], + "members": { + "EvalActionName": {}, + "EvalResourceName": {}, + "EvalDecision": {}, + "MatchedStatements": { + "shape": "S9x" + }, + "MissingContextValues": { + "shape": "S4o" + }, + "OrganizationsDecisionDetail": { + "type": "structure", + "members": { + "AllowedByOrganizations": { + "type": "boolean" + } + } + }, + "EvalDecisionDetails": { + "shape": "Sa5" + }, + "ResourceSpecificResults": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "EvalResourceName", + "EvalResourceDecision" + ], + "members": { + "EvalResourceName": {}, + "EvalResourceDecision": {}, + "MatchedStatements": { + "shape": "S9x" + }, + "MissingContextValues": { + "shape": "S4o" + }, + "EvalDecisionDetails": { + "shape": "Sa5" + } + } + } + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + }, + "S9x": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourcePolicyId": {}, + "SourcePolicyType": {}, + "StartPosition": { + "shape": "Sa1" + }, + "EndPosition": { + "shape": "Sa1" + } + } + } + }, + "Sa1": { + "type": "structure", + "members": { + "Line": { + "type": "integer" + }, + "Column": { + "type": "integer" + } + } + }, + "Sa5": { + "type": "map", + "key": {}, + "value": {} + }, + "Sad": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iam-2010-05-08.paginators.json b/node_modules/aws-sdk/apis/iam-2010-05-08.paginators.json new file mode 100644 index 0000000..3ac7a42 --- /dev/null +++ b/node_modules/aws-sdk/apis/iam-2010-05-08.paginators.json @@ -0,0 +1,198 @@ +{ + "pagination": { + "GetAccountAuthorizationDetails": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": [ + "UserDetailList", + "GroupDetailList", + "RoleDetailList", + "Policies" + ] + }, + "GetGroup": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Users" + }, + "ListAccessKeys": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AccessKeyMetadata" + }, + "ListAccountAliases": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AccountAliases" + }, + "ListAttachedGroupPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListAttachedRolePolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListAttachedUserPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListEntitiesForPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": [ + "PolicyGroups", + "PolicyUsers", + "PolicyRoles" + ] + }, + "ListGroupPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListGroups": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Groups" + }, + "ListGroupsForUser": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Groups" + }, + "ListInstanceProfiles": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "InstanceProfiles" + }, + "ListInstanceProfilesForRole": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "InstanceProfiles" + }, + "ListMFADevices": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "MFADevices" + }, + "ListPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Policies" + }, + "ListPolicyVersions": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Versions" + }, + "ListRolePolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListRoles": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Roles" + }, + "ListSAMLProviders": { + "result_key": "SAMLProviderList" + }, + "ListSSHPublicKeys": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "SSHPublicKeys" + }, + "ListServerCertificates": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "ServerCertificateMetadataList" + }, + "ListSigningCertificates": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Certificates" + }, + "ListUserPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListUsers": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Users" + }, + "ListVirtualMFADevices": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "VirtualMFADevices" + }, + "SimulateCustomPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "EvaluationResults" + }, + "SimulatePrincipalPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "EvaluationResults" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iam-2010-05-08.waiters2.json b/node_modules/aws-sdk/apis/iam-2010-05-08.waiters2.json new file mode 100644 index 0000000..6248041 --- /dev/null +++ b/node_modules/aws-sdk/apis/iam-2010-05-08.waiters2.json @@ -0,0 +1,73 @@ +{ + "version": 2, + "waiters": { + "InstanceProfileExists": { + "delay": 1, + "operation": "GetInstanceProfile", + "maxAttempts": 40, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "state": "retry", + "matcher": "status", + "expected": 404 + } + ] + }, + "UserExists": { + "delay": 1, + "operation": "GetUser", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "NoSuchEntity" + } + ] + }, + "RoleExists": { + "delay": 1, + "operation": "GetRole", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "NoSuchEntity" + } + ] + }, + "PolicyExists": { + "delay": 1, + "operation": "GetPolicy", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "NoSuchEntity" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/importexport-2010-06-01.min.json b/node_modules/aws-sdk/apis/importexport-2010-06-01.min.json new file mode 100644 index 0000000..f3e7eb0 --- /dev/null +++ b/node_modules/aws-sdk/apis/importexport-2010-06-01.min.json @@ -0,0 +1,244 @@ +{ + "version": "2.0", + "metadata": { + "uid": "importexport-2010-06-01", + "apiVersion": "2010-06-01", + "endpointPrefix": "importexport", + "globalEndpoint": "importexport.amazonaws.com", + "serviceFullName": "AWS Import/Export", + "serviceId": "ImportExport", + "signatureVersion": "v2", + "xmlNamespace": "http://importexport.amazonaws.com/doc/2010-06-01/", + "protocol": "query" + }, + "operations": { + "CancelJob": { + "http": { + "requestUri": "/?Operation=CancelJob" + }, + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "APIVersion": {} + } + }, + "output": { + "resultWrapper": "CancelJobResult", + "type": "structure", + "members": { + "Success": { + "type": "boolean" + } + } + } + }, + "CreateJob": { + "http": { + "requestUri": "/?Operation=CreateJob" + }, + "input": { + "type": "structure", + "required": [ + "JobType", + "Manifest", + "ValidateOnly" + ], + "members": { + "JobType": {}, + "Manifest": {}, + "ManifestAddendum": {}, + "ValidateOnly": { + "type": "boolean" + }, + "APIVersion": {} + } + }, + "output": { + "resultWrapper": "CreateJobResult", + "type": "structure", + "members": { + "JobId": {}, + "JobType": {}, + "Signature": {}, + "SignatureFileContents": {}, + "WarningMessage": {}, + "ArtifactList": { + "shape": "Sf" + } + } + } + }, + "GetShippingLabel": { + "http": { + "requestUri": "/?Operation=GetShippingLabel" + }, + "input": { + "type": "structure", + "required": [ + "jobIds" + ], + "members": { + "jobIds": { + "type": "list", + "member": {} + }, + "name": {}, + "company": {}, + "phoneNumber": {}, + "country": {}, + "stateOrProvince": {}, + "city": {}, + "postalCode": {}, + "street1": {}, + "street2": {}, + "street3": {}, + "APIVersion": {} + } + }, + "output": { + "resultWrapper": "GetShippingLabelResult", + "type": "structure", + "members": { + "ShippingLabelURL": {}, + "Warning": {} + } + } + }, + "GetStatus": { + "http": { + "requestUri": "/?Operation=GetStatus" + }, + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "APIVersion": {} + } + }, + "output": { + "resultWrapper": "GetStatusResult", + "type": "structure", + "members": { + "JobId": {}, + "JobType": {}, + "LocationCode": {}, + "LocationMessage": {}, + "ProgressCode": {}, + "ProgressMessage": {}, + "Carrier": {}, + "TrackingNumber": {}, + "LogBucket": {}, + "LogKey": {}, + "ErrorCount": { + "type": "integer" + }, + "Signature": {}, + "SignatureFileContents": {}, + "CurrentManifest": {}, + "CreationDate": { + "type": "timestamp" + }, + "ArtifactList": { + "shape": "Sf" + } + } + } + }, + "ListJobs": { + "http": { + "requestUri": "/?Operation=ListJobs" + }, + "input": { + "type": "structure", + "members": { + "MaxJobs": { + "type": "integer" + }, + "Marker": {}, + "APIVersion": {} + } + }, + "output": { + "resultWrapper": "ListJobsResult", + "type": "structure", + "members": { + "Jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobId": {}, + "CreationDate": { + "type": "timestamp" + }, + "IsCanceled": { + "type": "boolean" + }, + "JobType": {} + } + } + }, + "IsTruncated": { + "type": "boolean" + } + } + } + }, + "UpdateJob": { + "http": { + "requestUri": "/?Operation=UpdateJob" + }, + "input": { + "type": "structure", + "required": [ + "JobId", + "Manifest", + "JobType", + "ValidateOnly" + ], + "members": { + "JobId": {}, + "Manifest": {}, + "JobType": {}, + "ValidateOnly": { + "type": "boolean" + }, + "APIVersion": {} + } + }, + "output": { + "resultWrapper": "UpdateJobResult", + "type": "structure", + "members": { + "Success": { + "type": "boolean" + }, + "WarningMessage": {}, + "ArtifactList": { + "shape": "Sf" + } + } + } + } + }, + "shapes": { + "Sf": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Description": {}, + "URL": {} + } + } + } + }, + "examples": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/importexport-2010-06-01.paginators.json b/node_modules/aws-sdk/apis/importexport-2010-06-01.paginators.json new file mode 100644 index 0000000..702385e --- /dev/null +++ b/node_modules/aws-sdk/apis/importexport-2010-06-01.paginators.json @@ -0,0 +1,11 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "Marker", + "output_token": "Jobs[-1].JobId", + "more_results": "IsTruncated", + "limit_key": "MaxJobs", + "result_key": "Jobs" + } + } +} diff --git a/node_modules/aws-sdk/apis/inspector-2016-02-16.examples.json b/node_modules/aws-sdk/apis/inspector-2016-02-16.examples.json new file mode 100644 index 0000000..05b541f --- /dev/null +++ b/node_modules/aws-sdk/apis/inspector-2016-02-16.examples.json @@ -0,0 +1,1148 @@ +{ + "version": "1.0", + "examples": { + "AddAttributesToFindings": [ + { + "input": { + "attributes": [ + { + "key": "Example", + "value": "example" + } + ], + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU" + ] + }, + "output": { + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.", + "id": "add-attributes-to-findings-1481063856401", + "title": "Add attributes to findings" + } + ], + "CreateAssessmentTarget": [ + { + "input": { + "assessmentTargetName": "ExampleAssessmentTarget", + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv" + }, + "output": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account.", + "id": "create-assessment-target-1481063953657", + "title": "Create assessment target" + } + ], + "CreateAssessmentTemplate": [ + { + "input": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", + "assessmentTemplateName": "ExampleAssessmentTemplate", + "durationInSeconds": 180, + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp" + ], + "userAttributesForFindings": [ + { + "key": "Example", + "value": "example" + } + ] + }, + "output": { + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.", + "id": "create-assessment-template-1481064046719", + "title": "Create assessment template" + } + ], + "CreateResourceGroup": [ + { + "input": { + "resourceGroupTags": [ + { + "key": "Name", + "value": "example" + } + ] + }, + "output": { + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. ", + "id": "create-resource-group-1481064169037", + "title": "Create resource group" + } + ], + "DeleteAssessmentRun": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the assessment run that is specified by the ARN of the assessment run.", + "id": "delete-assessment-run-1481064251629", + "title": "Delete assessment run" + } + ], + "DeleteAssessmentTarget": [ + { + "input": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the assessment target that is specified by the ARN of the assessment target.", + "id": "delete-assessment-target-1481064309029", + "title": "Delete assessment target" + } + ], + "DeleteAssessmentTemplate": [ + { + "input": { + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the assessment template that is specified by the ARN of the assessment template.", + "id": "delete-assessment-template-1481064364074", + "title": "Delete assessment template" + } + ], + "DescribeAssessmentRuns": [ + { + "input": { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE" + ] + }, + "output": { + "assessmentRuns": [ + { + "name": "Run 1 for ExampleAssessmentTemplate", + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "completedAt": "1458680301.4", + "createdAt": "1458680170.035", + "dataCollected": true, + "durationInSeconds": 3600, + "findingCounts": { + "High": 14, + "Informational": 0, + "Low": 0, + "Medium": 2, + "Undefined": 0 + }, + "notifications": [ + + ], + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" + ], + "startedAt": "1458680170.161", + "state": "COMPLETED", + "stateChangedAt": "1458680301.4", + "stateChanges": [ + { + "state": "CREATED", + "stateChangedAt": "1458680170.035" + }, + { + "state": "START_DATA_COLLECTION_PENDING", + "stateChangedAt": "1458680170.065" + }, + { + "state": "START_DATA_COLLECTION_IN_PROGRESS", + "stateChangedAt": "1458680170.096" + }, + { + "state": "COLLECTING_DATA", + "stateChangedAt": "1458680170.161" + }, + { + "state": "STOP_DATA_COLLECTION_PENDING", + "stateChangedAt": "1458680239.883" + }, + { + "state": "DATA_COLLECTED", + "stateChangedAt": "1458680299.847" + }, + { + "state": "EVALUATING_RULES", + "stateChangedAt": "1458680300.099" + }, + { + "state": "COMPLETED", + "stateChangedAt": "1458680301.4" + } + ], + "userAttributesForFindings": [ + + ] + } + ], + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the assessment runs that are specified by the ARNs of the assessment runs.", + "id": "describte-assessment-runs-1481064424352", + "title": "Describte assessment runs" + } + ], + "DescribeAssessmentTargets": [ + { + "input": { + "assessmentTargetArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + ] + }, + "output": { + "assessmentTargets": [ + { + "name": "ExampleAssessmentTarget", + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", + "createdAt": "1458074191.459", + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", + "updatedAt": "1458074191.459" + } + ], + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the assessment targets that are specified by the ARNs of the assessment targets.", + "id": "describte-assessment-targets-1481064527735", + "title": "Describte assessment targets" + } + ], + "DescribeAssessmentTemplates": [ + { + "input": { + "assessmentTemplateArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw" + ] + }, + "output": { + "assessmentTemplates": [ + { + "name": "ExampleAssessmentTemplate", + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "assessmentRunCount": 0, + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", + "createdAt": "1458074191.844", + "durationInSeconds": 3600, + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" + ], + "userAttributesForFindings": [ + + ] + } + ], + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the assessment templates that are specified by the ARNs of the assessment templates.", + "id": "describte-assessment-templates-1481064606829", + "title": "Describte assessment templates" + } + ], + "DescribeCrossAccountAccessRole": [ + { + "output": { + "registeredAt": "1458069182.826", + "roleArn": "arn:aws:iam::123456789012:role/inspector", + "valid": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the IAM role that enables Amazon Inspector to access your AWS account.", + "id": "describte-cross-account-access-role-1481064682267", + "title": "Describte cross account access role" + } + ], + "DescribeFindings": [ + { + "input": { + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4" + ] + }, + "output": { + "failedItems": { + }, + "findings": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", + "assetAttributes": { + "ipv4Addresses": [ + + ], + "schemaVersion": 1 + }, + "assetType": "ec2-instance", + "attributes": [ + + ], + "confidence": 10, + "createdAt": "1458680301.37", + "description": "Amazon Inspector did not find any potential security issues during this assessment.", + "indicatorOfCompromise": false, + "numericSeverity": 0, + "recommendation": "No remediation needed.", + "schemaVersion": 1, + "service": "Inspector", + "serviceAttributes": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", + "schemaVersion": 1 + }, + "severity": "Informational", + "title": "No potential security issues found", + "updatedAt": "1458680301.37", + "userAttributes": [ + + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the findings that are specified by the ARNs of the findings.", + "id": "describte-findings-1481064771803", + "title": "Describe findings" + } + ], + "DescribeResourceGroups": [ + { + "input": { + "resourceGroupArns": [ + "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI" + ] + }, + "output": { + "failedItems": { + }, + "resourceGroups": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", + "createdAt": "1458074191.098", + "tags": [ + { + "key": "Name", + "value": "example" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the resource groups that are specified by the ARNs of the resource groups.", + "id": "describe-resource-groups-1481065787743", + "title": "Describe resource groups" + } + ], + "DescribeRulesPackages": [ + { + "input": { + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ" + ] + }, + "output": { + "failedItems": { + }, + "rulesPackages": [ + { + "version": "1.1", + "name": "Security Best Practices", + "arn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", + "description": "The rules in this package help determine whether your systems are configured securely.", + "provider": "Amazon Web Services, Inc." + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the rules packages that are specified by the ARNs of the rules packages.", + "id": "describe-rules-packages-1481069641979", + "title": "Describe rules packages" + } + ], + "GetTelemetryMetadata": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE" + }, + "output": { + "telemetryMetadata": [ + { + "count": 2, + "dataSize": 345, + "messageType": "InspectorDuplicateProcess" + }, + { + "count": 3, + "dataSize": 255, + "messageType": "InspectorTimeEventMsg" + }, + { + "count": 4, + "dataSize": 1082, + "messageType": "InspectorNetworkInterface" + }, + { + "count": 2, + "dataSize": 349, + "messageType": "InspectorDnsEntry" + }, + { + "count": 11, + "dataSize": 2514, + "messageType": "InspectorDirectoryInfoMsg" + }, + { + "count": 1, + "dataSize": 179, + "messageType": "InspectorTcpV6ListeningPort" + }, + { + "count": 101, + "dataSize": 10949, + "messageType": "InspectorTerminal" + }, + { + "count": 26, + "dataSize": 5916, + "messageType": "InspectorUser" + }, + { + "count": 282, + "dataSize": 32148, + "messageType": "InspectorDynamicallyLoadedCodeModule" + }, + { + "count": 18, + "dataSize": 10172, + "messageType": "InspectorCreateProcess" + }, + { + "count": 3, + "dataSize": 8001, + "messageType": "InspectorProcessPerformance" + }, + { + "count": 1, + "dataSize": 360, + "messageType": "InspectorOperatingSystem" + }, + { + "count": 6, + "dataSize": 546, + "messageType": "InspectorStopProcess" + }, + { + "count": 1, + "dataSize": 1553, + "messageType": "InspectorInstanceMetaData" + }, + { + "count": 2, + "dataSize": 434, + "messageType": "InspectorTcpV4Connection" + }, + { + "count": 474, + "dataSize": 2960322, + "messageType": "InspectorPackageInfo" + }, + { + "count": 3, + "dataSize": 2235, + "messageType": "InspectorSystemPerformance" + }, + { + "count": 105, + "dataSize": 46048, + "messageType": "InspectorCodeModule" + }, + { + "count": 1, + "dataSize": 182, + "messageType": "InspectorUdpV6ListeningPort" + }, + { + "count": 2, + "dataSize": 371, + "messageType": "InspectorUdpV4ListeningPort" + }, + { + "count": 18, + "dataSize": 8362, + "messageType": "InspectorKernelModule" + }, + { + "count": 29, + "dataSize": 48788, + "messageType": "InspectorConfigurationInfo" + }, + { + "count": 1, + "dataSize": 79, + "messageType": "InspectorMonitoringStart" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgBegin" + }, + { + "count": 51, + "dataSize": 4593, + "messageType": "InspectorGroup" + }, + { + "count": 1, + "dataSize": 184, + "messageType": "InspectorTcpV4ListeningPort" + }, + { + "count": 1159, + "dataSize": 3146579, + "messageType": "Total" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgEnd" + }, + { + "count": 1, + "dataSize": 612, + "messageType": "InspectorLoadImageInProcess" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Information about the data that is collected for the specified assessment run.", + "id": "get-telemetry-metadata-1481066021297", + "title": "Get telemetry metadata" + } + ], + "ListAssessmentRunAgents": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "maxResults": 123 + }, + "output": { + "assessmentRunAgents": [ + { + "agentHealth": "HEALTHY", + "agentHealthCode": "RUNNING", + "agentId": "i-49113b93", + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "telemetryMetadata": [ + { + "count": 2, + "dataSize": 345, + "messageType": "InspectorDuplicateProcess" + }, + { + "count": 3, + "dataSize": 255, + "messageType": "InspectorTimeEventMsg" + }, + { + "count": 4, + "dataSize": 1082, + "messageType": "InspectorNetworkInterface" + }, + { + "count": 2, + "dataSize": 349, + "messageType": "InspectorDnsEntry" + }, + { + "count": 11, + "dataSize": 2514, + "messageType": "InspectorDirectoryInfoMsg" + }, + { + "count": 1, + "dataSize": 179, + "messageType": "InspectorTcpV6ListeningPort" + }, + { + "count": 101, + "dataSize": 10949, + "messageType": "InspectorTerminal" + }, + { + "count": 26, + "dataSize": 5916, + "messageType": "InspectorUser" + }, + { + "count": 282, + "dataSize": 32148, + "messageType": "InspectorDynamicallyLoadedCodeModule" + }, + { + "count": 18, + "dataSize": 10172, + "messageType": "InspectorCreateProcess" + }, + { + "count": 3, + "dataSize": 8001, + "messageType": "InspectorProcessPerformance" + }, + { + "count": 1, + "dataSize": 360, + "messageType": "InspectorOperatingSystem" + }, + { + "count": 6, + "dataSize": 546, + "messageType": "InspectorStopProcess" + }, + { + "count": 1, + "dataSize": 1553, + "messageType": "InspectorInstanceMetaData" + }, + { + "count": 2, + "dataSize": 434, + "messageType": "InspectorTcpV4Connection" + }, + { + "count": 474, + "dataSize": 2960322, + "messageType": "InspectorPackageInfo" + }, + { + "count": 3, + "dataSize": 2235, + "messageType": "InspectorSystemPerformance" + }, + { + "count": 105, + "dataSize": 46048, + "messageType": "InspectorCodeModule" + }, + { + "count": 1, + "dataSize": 182, + "messageType": "InspectorUdpV6ListeningPort" + }, + { + "count": 2, + "dataSize": 371, + "messageType": "InspectorUdpV4ListeningPort" + }, + { + "count": 18, + "dataSize": 8362, + "messageType": "InspectorKernelModule" + }, + { + "count": 29, + "dataSize": 48788, + "messageType": "InspectorConfigurationInfo" + }, + { + "count": 1, + "dataSize": 79, + "messageType": "InspectorMonitoringStart" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgBegin" + }, + { + "count": 51, + "dataSize": 4593, + "messageType": "InspectorGroup" + }, + { + "count": 1, + "dataSize": 184, + "messageType": "InspectorTcpV4ListeningPort" + }, + { + "count": 1159, + "dataSize": 3146579, + "messageType": "Total" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgEnd" + }, + { + "count": 1, + "dataSize": 612, + "messageType": "InspectorLoadImageInProcess" + } + ] + } + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.", + "id": "list-assessment-run-agents-1481918140642", + "title": "List assessment run agents" + } + ], + "ListAssessmentRuns": [ + { + "input": { + "assessmentTemplateArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw" + ], + "maxResults": 123 + }, + "output": { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.", + "id": "list-assessment-runs-1481066340844", + "title": "List assessment runs" + } + ], + "ListAssessmentTargets": [ + { + "input": { + "maxResults": 123 + }, + "output": { + "assessmentTargetArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the ARNs of the assessment targets within this AWS account. ", + "id": "list-assessment-targets-1481066540849", + "title": "List assessment targets" + } + ], + "ListAssessmentTemplates": [ + { + "input": { + "assessmentTargetArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + ], + "maxResults": 123 + }, + "output": { + "assessmentTemplateArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-Uza6ihLh" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.", + "id": "list-assessment-templates-1481066623520", + "title": "List assessment templates" + } + ], + "ListEventSubscriptions": [ + { + "input": { + "maxResults": 123, + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0" + }, + "output": { + "nextToken": "1", + "subscriptions": [ + { + "eventSubscriptions": [ + { + "event": "ASSESSMENT_RUN_COMPLETED", + "subscribedAt": "1459455440.867" + } + ], + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. ", + "id": "list-event-subscriptions-1481068376945", + "title": "List event subscriptions" + } + ], + "ListFindings": [ + { + "input": { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE" + ], + "maxResults": 123 + }, + "output": { + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.", + "id": "list-findings-1481066840611", + "title": "List findings" + } + ], + "ListRulesPackages": [ + { + "input": { + "maxResults": 123 + }, + "output": { + "nextToken": "1", + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all available Amazon Inspector rules packages.", + "id": "list-rules-packages-1481066954883", + "title": "List rules packages" + } + ], + "ListTagsForResource": [ + { + "input": { + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu" + }, + "output": { + "tags": [ + { + "key": "Name", + "value": "Example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all tags associated with an assessment template.", + "id": "list-tags-for-resource-1481067025240", + "title": "List tags for resource" + } + ], + "PreviewAgents": [ + { + "input": { + "maxResults": 123, + "previewAgentsArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + }, + "output": { + "agentPreviews": [ + { + "agentId": "i-49113b93" + } + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Previews the agents installed on the EC2 instances that are part of the specified assessment target.", + "id": "preview-agents-1481067101888", + "title": "Preview agents" + } + ], + "RegisterCrossAccountAccessRole": [ + { + "input": { + "roleArn": "arn:aws:iam::123456789012:role/inspector" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.", + "id": "register-cross-account-access-role-1481067178301", + "title": "Register cross account access role" + } + ], + "RemoveAttributesFromFindings": [ + { + "input": { + "attributeKeys": [ + "key=Example,value=example" + ], + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU" + ] + }, + "output": { + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.", + "id": "remove-attributes-from-findings-1481067246548", + "title": "Remove attributes from findings" + } + ], + "SetTagsForResource": [ + { + "input": { + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "tags": [ + { + "key": "Example", + "value": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.", + "id": "set-tags-for-resource-1481067329646", + "title": "Set tags for resource" + } + ], + "StartAssessmentRun": [ + { + "input": { + "assessmentRunName": "examplerun", + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" + }, + "output": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.", + "id": "start-assessment-run-1481067407484", + "title": "Start assessment run" + } + ], + "StopAssessmentRun": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Stops the assessment run that is specified by the ARN of the assessment run.", + "id": "stop-assessment-run-1481067502857", + "title": "Stop assessment run" + } + ], + "SubscribeToEvent": [ + { + "input": { + "event": "ASSESSMENT_RUN_COMPLETED", + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.", + "id": "subscribe-to-event-1481067686031", + "title": "Subscribe to event" + } + ], + "UnsubscribeFromEvent": [ + { + "input": { + "event": "ASSESSMENT_RUN_COMPLETED", + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.", + "id": "unsubscribe-from-event-1481067781705", + "title": "Unsubscribe from event" + } + ], + "UpdateAssessmentTarget": [ + { + "input": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", + "assessmentTargetName": "Example", + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the assessment target that is specified by the ARN of the assessment target.", + "id": "update-assessment-target-1481067866692", + "title": "Update assessment target" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/inspector-2016-02-16.min.json b/node_modules/aws-sdk/apis/inspector-2016-02-16.min.json new file mode 100644 index 0000000..8679cf9 --- /dev/null +++ b/node_modules/aws-sdk/apis/inspector-2016-02-16.min.json @@ -0,0 +1,1501 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-02-16", + "endpointPrefix": "inspector", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Inspector", + "serviceId": "Inspector", + "signatureVersion": "v4", + "targetPrefix": "InspectorService", + "uid": "inspector-2016-02-16" + }, + "operations": { + "AddAttributesToFindings": { + "input": { + "type": "structure", + "required": [ + "findingArns", + "attributes" + ], + "members": { + "findingArns": { + "shape": "S2" + }, + "attributes": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "required": [ + "failedItems" + ], + "members": { + "failedItems": { + "shape": "S9" + } + } + } + }, + "CreateAssessmentTarget": { + "input": { + "type": "structure", + "required": [ + "assessmentTargetName" + ], + "members": { + "assessmentTargetName": {}, + "resourceGroupArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentTargetArn" + ], + "members": { + "assessmentTargetArn": {} + } + } + }, + "CreateAssessmentTemplate": { + "input": { + "type": "structure", + "required": [ + "assessmentTargetArn", + "assessmentTemplateName", + "durationInSeconds", + "rulesPackageArns" + ], + "members": { + "assessmentTargetArn": {}, + "assessmentTemplateName": {}, + "durationInSeconds": { + "type": "integer" + }, + "rulesPackageArns": { + "shape": "Sj" + }, + "userAttributesForFindings": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentTemplateArn" + ], + "members": { + "assessmentTemplateArn": {} + } + } + }, + "CreateExclusionsPreview": { + "input": { + "type": "structure", + "required": [ + "assessmentTemplateArn" + ], + "members": { + "assessmentTemplateArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "previewToken" + ], + "members": { + "previewToken": {} + } + } + }, + "CreateResourceGroup": { + "input": { + "type": "structure", + "required": [ + "resourceGroupTags" + ], + "members": { + "resourceGroupTags": { + "shape": "Sp" + } + } + }, + "output": { + "type": "structure", + "required": [ + "resourceGroupArn" + ], + "members": { + "resourceGroupArn": {} + } + } + }, + "DeleteAssessmentRun": { + "input": { + "type": "structure", + "required": [ + "assessmentRunArn" + ], + "members": { + "assessmentRunArn": {} + } + } + }, + "DeleteAssessmentTarget": { + "input": { + "type": "structure", + "required": [ + "assessmentTargetArn" + ], + "members": { + "assessmentTargetArn": {} + } + } + }, + "DeleteAssessmentTemplate": { + "input": { + "type": "structure", + "required": [ + "assessmentTemplateArn" + ], + "members": { + "assessmentTemplateArn": {} + } + } + }, + "DescribeAssessmentRuns": { + "input": { + "type": "structure", + "required": [ + "assessmentRunArns" + ], + "members": { + "assessmentRunArns": { + "shape": "Sy" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentRuns", + "failedItems" + ], + "members": { + "assessmentRuns": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "name", + "assessmentTemplateArn", + "state", + "durationInSeconds", + "rulesPackageArns", + "userAttributesForFindings", + "createdAt", + "stateChangedAt", + "dataCollected", + "stateChanges", + "notifications", + "findingCounts" + ], + "members": { + "arn": {}, + "name": {}, + "assessmentTemplateArn": {}, + "state": {}, + "durationInSeconds": { + "type": "integer" + }, + "rulesPackageArns": { + "type": "list", + "member": {} + }, + "userAttributesForFindings": { + "shape": "S4" + }, + "createdAt": { + "type": "timestamp" + }, + "startedAt": { + "type": "timestamp" + }, + "completedAt": { + "type": "timestamp" + }, + "stateChangedAt": { + "type": "timestamp" + }, + "dataCollected": { + "type": "boolean" + }, + "stateChanges": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "stateChangedAt", + "state" + ], + "members": { + "stateChangedAt": { + "type": "timestamp" + }, + "state": {} + } + } + }, + "notifications": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "date", + "event", + "error" + ], + "members": { + "date": { + "type": "timestamp" + }, + "event": {}, + "message": {}, + "error": { + "type": "boolean" + }, + "snsTopicArn": {}, + "snsPublishStatusCode": {} + } + } + }, + "findingCounts": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + } + }, + "failedItems": { + "shape": "S9" + } + } + } + }, + "DescribeAssessmentTargets": { + "input": { + "type": "structure", + "required": [ + "assessmentTargetArns" + ], + "members": { + "assessmentTargetArns": { + "shape": "Sy" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentTargets", + "failedItems" + ], + "members": { + "assessmentTargets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "name", + "createdAt", + "updatedAt" + ], + "members": { + "arn": {}, + "name": {}, + "resourceGroupArn": {}, + "createdAt": { + "type": "timestamp" + }, + "updatedAt": { + "type": "timestamp" + } + } + } + }, + "failedItems": { + "shape": "S9" + } + } + } + }, + "DescribeAssessmentTemplates": { + "input": { + "type": "structure", + "required": [ + "assessmentTemplateArns" + ], + "members": { + "assessmentTemplateArns": { + "shape": "Sy" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentTemplates", + "failedItems" + ], + "members": { + "assessmentTemplates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "name", + "assessmentTargetArn", + "durationInSeconds", + "rulesPackageArns", + "userAttributesForFindings", + "assessmentRunCount", + "createdAt" + ], + "members": { + "arn": {}, + "name": {}, + "assessmentTargetArn": {}, + "durationInSeconds": { + "type": "integer" + }, + "rulesPackageArns": { + "shape": "Sj" + }, + "userAttributesForFindings": { + "shape": "S4" + }, + "lastAssessmentRunArn": {}, + "assessmentRunCount": { + "type": "integer" + }, + "createdAt": { + "type": "timestamp" + } + } + } + }, + "failedItems": { + "shape": "S9" + } + } + } + }, + "DescribeCrossAccountAccessRole": { + "output": { + "type": "structure", + "required": [ + "roleArn", + "valid", + "registeredAt" + ], + "members": { + "roleArn": {}, + "valid": { + "type": "boolean" + }, + "registeredAt": { + "type": "timestamp" + } + } + } + }, + "DescribeExclusions": { + "input": { + "type": "structure", + "required": [ + "exclusionArns" + ], + "members": { + "exclusionArns": { + "type": "list", + "member": {} + }, + "locale": {} + } + }, + "output": { + "type": "structure", + "required": [ + "exclusions", + "failedItems" + ], + "members": { + "exclusions": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "arn", + "title", + "description", + "recommendation", + "scopes" + ], + "members": { + "arn": {}, + "title": {}, + "description": {}, + "recommendation": {}, + "scopes": { + "shape": "S1x" + }, + "attributes": { + "shape": "S21" + } + } + } + }, + "failedItems": { + "shape": "S9" + } + } + } + }, + "DescribeFindings": { + "input": { + "type": "structure", + "required": [ + "findingArns" + ], + "members": { + "findingArns": { + "shape": "Sy" + }, + "locale": {} + } + }, + "output": { + "type": "structure", + "required": [ + "findings", + "failedItems" + ], + "members": { + "findings": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "attributes", + "userAttributes", + "createdAt", + "updatedAt" + ], + "members": { + "arn": {}, + "schemaVersion": { + "type": "integer" + }, + "service": {}, + "serviceAttributes": { + "type": "structure", + "required": [ + "schemaVersion" + ], + "members": { + "schemaVersion": { + "type": "integer" + }, + "assessmentRunArn": {}, + "rulesPackageArn": {} + } + }, + "assetType": {}, + "assetAttributes": { + "type": "structure", + "required": [ + "schemaVersion" + ], + "members": { + "schemaVersion": { + "type": "integer" + }, + "agentId": {}, + "autoScalingGroup": {}, + "amiId": {}, + "hostname": {}, + "ipv4Addresses": { + "type": "list", + "member": {} + }, + "tags": { + "type": "list", + "member": { + "shape": "S2i" + } + }, + "networkInterfaces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "networkInterfaceId": {}, + "subnetId": {}, + "vpcId": {}, + "privateDnsName": {}, + "privateIpAddress": {}, + "privateIpAddresses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "privateDnsName": {}, + "privateIpAddress": {} + } + } + }, + "publicDnsName": {}, + "publicIp": {}, + "ipv6Addresses": { + "type": "list", + "member": {} + }, + "securityGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "groupName": {}, + "groupId": {} + } + } + } + } + } + } + } + }, + "id": {}, + "title": {}, + "description": {}, + "recommendation": {}, + "severity": {}, + "numericSeverity": { + "type": "double" + }, + "confidence": { + "type": "integer" + }, + "indicatorOfCompromise": { + "type": "boolean" + }, + "attributes": { + "shape": "S21" + }, + "userAttributes": { + "shape": "S4" + }, + "createdAt": { + "type": "timestamp" + }, + "updatedAt": { + "type": "timestamp" + } + } + } + }, + "failedItems": { + "shape": "S9" + } + } + } + }, + "DescribeResourceGroups": { + "input": { + "type": "structure", + "required": [ + "resourceGroupArns" + ], + "members": { + "resourceGroupArns": { + "shape": "Sy" + } + } + }, + "output": { + "type": "structure", + "required": [ + "resourceGroups", + "failedItems" + ], + "members": { + "resourceGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "tags", + "createdAt" + ], + "members": { + "arn": {}, + "tags": { + "shape": "Sp" + }, + "createdAt": { + "type": "timestamp" + } + } + } + }, + "failedItems": { + "shape": "S9" + } + } + } + }, + "DescribeRulesPackages": { + "input": { + "type": "structure", + "required": [ + "rulesPackageArns" + ], + "members": { + "rulesPackageArns": { + "shape": "Sy" + }, + "locale": {} + } + }, + "output": { + "type": "structure", + "required": [ + "rulesPackages", + "failedItems" + ], + "members": { + "rulesPackages": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "name", + "version", + "provider" + ], + "members": { + "arn": {}, + "name": {}, + "version": {}, + "provider": {}, + "description": {} + } + } + }, + "failedItems": { + "shape": "S9" + } + } + } + }, + "GetAssessmentReport": { + "input": { + "type": "structure", + "required": [ + "assessmentRunArn", + "reportFileFormat", + "reportType" + ], + "members": { + "assessmentRunArn": {}, + "reportFileFormat": {}, + "reportType": {} + } + }, + "output": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {}, + "url": {} + } + } + }, + "GetExclusionsPreview": { + "input": { + "type": "structure", + "required": [ + "assessmentTemplateArn", + "previewToken" + ], + "members": { + "assessmentTemplateArn": {}, + "previewToken": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "locale": {} + } + }, + "output": { + "type": "structure", + "required": [ + "previewStatus" + ], + "members": { + "previewStatus": {}, + "exclusionPreviews": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "title", + "description", + "recommendation", + "scopes" + ], + "members": { + "title": {}, + "description": {}, + "recommendation": {}, + "scopes": { + "shape": "S1x" + }, + "attributes": { + "shape": "S21" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetTelemetryMetadata": { + "input": { + "type": "structure", + "required": [ + "assessmentRunArn" + ], + "members": { + "assessmentRunArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "telemetryMetadata" + ], + "members": { + "telemetryMetadata": { + "shape": "S3j" + } + } + } + }, + "ListAssessmentRunAgents": { + "input": { + "type": "structure", + "required": [ + "assessmentRunArn" + ], + "members": { + "assessmentRunArn": {}, + "filter": { + "type": "structure", + "required": [ + "agentHealths", + "agentHealthCodes" + ], + "members": { + "agentHealths": { + "type": "list", + "member": {} + }, + "agentHealthCodes": { + "type": "list", + "member": {} + } + } + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentRunAgents" + ], + "members": { + "assessmentRunAgents": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "agentId", + "assessmentRunArn", + "agentHealth", + "agentHealthCode", + "telemetryMetadata" + ], + "members": { + "agentId": {}, + "assessmentRunArn": {}, + "agentHealth": {}, + "agentHealthCode": {}, + "agentHealthDetails": {}, + "autoScalingGroup": {}, + "telemetryMetadata": { + "shape": "S3j" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListAssessmentRuns": { + "input": { + "type": "structure", + "members": { + "assessmentTemplateArns": { + "shape": "S3x" + }, + "filter": { + "type": "structure", + "members": { + "namePattern": {}, + "states": { + "type": "list", + "member": {} + }, + "durationRange": { + "shape": "S41" + }, + "rulesPackageArns": { + "shape": "S42" + }, + "startTimeRange": { + "shape": "S43" + }, + "completionTimeRange": { + "shape": "S43" + }, + "stateChangeTimeRange": { + "shape": "S43" + } + } + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentRunArns" + ], + "members": { + "assessmentRunArns": { + "shape": "S45" + }, + "nextToken": {} + } + } + }, + "ListAssessmentTargets": { + "input": { + "type": "structure", + "members": { + "filter": { + "type": "structure", + "members": { + "assessmentTargetNamePattern": {} + } + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentTargetArns" + ], + "members": { + "assessmentTargetArns": { + "shape": "S45" + }, + "nextToken": {} + } + } + }, + "ListAssessmentTemplates": { + "input": { + "type": "structure", + "members": { + "assessmentTargetArns": { + "shape": "S3x" + }, + "filter": { + "type": "structure", + "members": { + "namePattern": {}, + "durationRange": { + "shape": "S41" + }, + "rulesPackageArns": { + "shape": "S42" + } + } + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentTemplateArns" + ], + "members": { + "assessmentTemplateArns": { + "shape": "S45" + }, + "nextToken": {} + } + } + }, + "ListEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "resourceArn": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "subscriptions" + ], + "members": { + "subscriptions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "resourceArn", + "topicArn", + "eventSubscriptions" + ], + "members": { + "resourceArn": {}, + "topicArn": {}, + "eventSubscriptions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "event", + "subscribedAt" + ], + "members": { + "event": {}, + "subscribedAt": { + "type": "timestamp" + } + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "ListExclusions": { + "input": { + "type": "structure", + "required": [ + "assessmentRunArn" + ], + "members": { + "assessmentRunArn": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "exclusionArns" + ], + "members": { + "exclusionArns": { + "shape": "S45" + }, + "nextToken": {} + } + } + }, + "ListFindings": { + "input": { + "type": "structure", + "members": { + "assessmentRunArns": { + "shape": "S3x" + }, + "filter": { + "type": "structure", + "members": { + "agentIds": { + "type": "list", + "member": {} + }, + "autoScalingGroups": { + "type": "list", + "member": {} + }, + "ruleNames": { + "type": "list", + "member": {} + }, + "severities": { + "type": "list", + "member": {} + }, + "rulesPackageArns": { + "shape": "S42" + }, + "attributes": { + "shape": "S21" + }, + "userAttributes": { + "shape": "S21" + }, + "creationTimeRange": { + "shape": "S43" + } + } + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "findingArns" + ], + "members": { + "findingArns": { + "shape": "S45" + }, + "nextToken": {} + } + } + }, + "ListRulesPackages": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "rulesPackageArns" + ], + "members": { + "rulesPackageArns": { + "shape": "S45" + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "tags" + ], + "members": { + "tags": { + "shape": "S4x" + } + } + } + }, + "PreviewAgents": { + "input": { + "type": "structure", + "required": [ + "previewAgentsArn" + ], + "members": { + "previewAgentsArn": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "agentPreviews" + ], + "members": { + "agentPreviews": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "agentId" + ], + "members": { + "hostname": {}, + "agentId": {}, + "autoScalingGroup": {}, + "agentHealth": {}, + "agentVersion": {}, + "operatingSystem": {}, + "kernelVersion": {}, + "ipv4Address": {} + } + } + }, + "nextToken": {} + } + } + }, + "RegisterCrossAccountAccessRole": { + "input": { + "type": "structure", + "required": [ + "roleArn" + ], + "members": { + "roleArn": {} + } + } + }, + "RemoveAttributesFromFindings": { + "input": { + "type": "structure", + "required": [ + "findingArns", + "attributeKeys" + ], + "members": { + "findingArns": { + "shape": "S2" + }, + "attributeKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "required": [ + "failedItems" + ], + "members": { + "failedItems": { + "shape": "S9" + } + } + } + }, + "SetTagsForResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": {}, + "tags": { + "shape": "S4x" + } + } + } + }, + "StartAssessmentRun": { + "input": { + "type": "structure", + "required": [ + "assessmentTemplateArn" + ], + "members": { + "assessmentTemplateArn": {}, + "assessmentRunName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "assessmentRunArn" + ], + "members": { + "assessmentRunArn": {} + } + } + }, + "StopAssessmentRun": { + "input": { + "type": "structure", + "required": [ + "assessmentRunArn" + ], + "members": { + "assessmentRunArn": {}, + "stopAction": {} + } + } + }, + "SubscribeToEvent": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "event", + "topicArn" + ], + "members": { + "resourceArn": {}, + "event": {}, + "topicArn": {} + } + } + }, + "UnsubscribeFromEvent": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "event", + "topicArn" + ], + "members": { + "resourceArn": {}, + "event": {}, + "topicArn": {} + } + } + }, + "UpdateAssessmentTarget": { + "input": { + "type": "structure", + "required": [ + "assessmentTargetArn", + "assessmentTargetName" + ], + "members": { + "assessmentTargetArn": {}, + "assessmentTargetName": {}, + "resourceGroupArn": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "S4": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "S5": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": {}, + "value": {} + } + }, + "S9": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "failureCode", + "retryable" + ], + "members": { + "failureCode": {}, + "retryable": { + "type": "boolean" + } + } + } + }, + "Sj": { + "type": "list", + "member": {} + }, + "Sp": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "Sy": { + "type": "list", + "member": {} + }, + "S1x": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "S21": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "S2i": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": {}, + "value": {} + } + }, + "S3j": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "messageType", + "count" + ], + "members": { + "messageType": {}, + "count": { + "type": "long" + }, + "dataSize": { + "type": "long" + } + } + } + }, + "S3x": { + "type": "list", + "member": {} + }, + "S41": { + "type": "structure", + "members": { + "minSeconds": { + "type": "integer" + }, + "maxSeconds": { + "type": "integer" + } + } + }, + "S42": { + "type": "list", + "member": {} + }, + "S43": { + "type": "structure", + "members": { + "beginDate": { + "type": "timestamp" + }, + "endDate": { + "type": "timestamp" + } + } + }, + "S45": { + "type": "list", + "member": {} + }, + "S4x": { + "type": "list", + "member": { + "shape": "S2i" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/inspector-2016-02-16.paginators.json b/node_modules/aws-sdk/apis/inspector-2016-02-16.paginators.json new file mode 100644 index 0000000..e702bf0 --- /dev/null +++ b/node_modules/aws-sdk/apis/inspector-2016-02-16.paginators.json @@ -0,0 +1,54 @@ +{ + "pagination": { + "GetExclusionsPreview": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentRunAgents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentRuns": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentTargets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListEventSubscriptions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListExclusions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListFindings": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListRulesPackages": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "PreviewAgents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/iot-2015-05-28.examples.json b/node_modules/aws-sdk/apis/iot-2015-05-28.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/iot-2015-05-28.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/iot-2015-05-28.min.json b/node_modules/aws-sdk/apis/iot-2015-05-28.min.json new file mode 100644 index 0000000..529106a --- /dev/null +++ b/node_modules/aws-sdk/apis/iot-2015-05-28.min.json @@ -0,0 +1,6485 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-05-28", + "endpointPrefix": "iot", + "protocol": "rest-json", + "serviceFullName": "AWS IoT", + "serviceId": "IoT", + "signatureVersion": "v4", + "signingName": "execute-api", + "uid": "iot-2015-05-28" + }, + "operations": { + "AcceptCertificateTransfer": { + "http": { + "method": "PATCH", + "requestUri": "/accept-certificate-transfer/{certificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "certificateId" + }, + "setAsActive": { + "location": "querystring", + "locationName": "setAsActive", + "type": "boolean" + } + } + } + }, + "AddThingToBillingGroup": { + "http": { + "method": "PUT", + "requestUri": "/billing-groups/addThingToBillingGroup" + }, + "input": { + "type": "structure", + "members": { + "billingGroupName": {}, + "billingGroupArn": {}, + "thingName": {}, + "thingArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AddThingToThingGroup": { + "http": { + "method": "PUT", + "requestUri": "/thing-groups/addThingToThingGroup" + }, + "input": { + "type": "structure", + "members": { + "thingGroupName": {}, + "thingGroupArn": {}, + "thingName": {}, + "thingArn": {}, + "overrideDynamicGroups": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateTargetsWithJob": { + "http": { + "requestUri": "/jobs/{jobId}/targets" + }, + "input": { + "type": "structure", + "required": [ + "targets", + "jobId" + ], + "members": { + "targets": { + "shape": "Sg" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "comment": {} + } + }, + "output": { + "type": "structure", + "members": { + "jobArn": {}, + "jobId": {}, + "description": {} + } + } + }, + "AttachPolicy": { + "http": { + "method": "PUT", + "requestUri": "/target-policies/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "target" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "target": {} + } + } + }, + "AttachPrincipalPolicy": { + "http": { + "method": "PUT", + "requestUri": "/principal-policies/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "principal" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "principal": { + "location": "header", + "locationName": "x-amzn-iot-principal" + } + } + }, + "deprecated": true + }, + "AttachSecurityProfile": { + "http": { + "method": "PUT", + "requestUri": "/security-profiles/{securityProfileName}/targets" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileName", + "securityProfileTargetArn" + ], + "members": { + "securityProfileName": { + "location": "uri", + "locationName": "securityProfileName" + }, + "securityProfileTargetArn": { + "location": "querystring", + "locationName": "securityProfileTargetArn" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AttachThingPrincipal": { + "http": { + "method": "PUT", + "requestUri": "/things/{thingName}/principals" + }, + "input": { + "type": "structure", + "required": [ + "thingName", + "principal" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "principal": { + "location": "header", + "locationName": "x-amzn-principal" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelAuditTask": { + "http": { + "method": "PUT", + "requestUri": "/audit/tasks/{taskId}/cancel" + }, + "input": { + "type": "structure", + "required": [ + "taskId" + ], + "members": { + "taskId": { + "location": "uri", + "locationName": "taskId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelCertificateTransfer": { + "http": { + "method": "PATCH", + "requestUri": "/cancel-certificate-transfer/{certificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "certificateId" + } + } + } + }, + "CancelJob": { + "http": { + "method": "PUT", + "requestUri": "/jobs/{jobId}/cancel" + }, + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "reasonCode": {}, + "comment": {}, + "force": { + "location": "querystring", + "locationName": "force", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobArn": {}, + "jobId": {}, + "description": {} + } + } + }, + "CancelJobExecution": { + "http": { + "method": "PUT", + "requestUri": "/things/{thingName}/jobs/{jobId}/cancel" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "thingName" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "force": { + "location": "querystring", + "locationName": "force", + "type": "boolean" + }, + "expectedVersion": { + "type": "long" + }, + "statusDetails": { + "shape": "S18" + } + } + } + }, + "ClearDefaultAuthorizer": { + "http": { + "method": "DELETE", + "requestUri": "/default-authorizer" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateAuthorizer": { + "http": { + "requestUri": "/authorizer/{authorizerName}" + }, + "input": { + "type": "structure", + "required": [ + "authorizerName", + "authorizerFunctionArn", + "tokenKeyName", + "tokenSigningPublicKeys" + ], + "members": { + "authorizerName": { + "location": "uri", + "locationName": "authorizerName" + }, + "authorizerFunctionArn": {}, + "tokenKeyName": {}, + "tokenSigningPublicKeys": { + "shape": "S1h" + }, + "status": {} + } + }, + "output": { + "type": "structure", + "members": { + "authorizerName": {}, + "authorizerArn": {} + } + } + }, + "CreateBillingGroup": { + "http": { + "requestUri": "/billing-groups/{billingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "billingGroupName" + ], + "members": { + "billingGroupName": { + "location": "uri", + "locationName": "billingGroupName" + }, + "billingGroupProperties": { + "shape": "S1o" + }, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "billingGroupName": {}, + "billingGroupArn": {}, + "billingGroupId": {} + } + } + }, + "CreateCertificateFromCsr": { + "http": { + "requestUri": "/certificates" + }, + "input": { + "type": "structure", + "required": [ + "certificateSigningRequest" + ], + "members": { + "certificateSigningRequest": {}, + "setAsActive": { + "location": "querystring", + "locationName": "setAsActive", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {}, + "certificatePem": {} + } + } + }, + "CreateDynamicThingGroup": { + "http": { + "requestUri": "/dynamic-thing-groups/{thingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName", + "queryString" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + }, + "thingGroupProperties": { + "shape": "S22" + }, + "indexName": {}, + "queryString": {}, + "queryVersion": {}, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingGroupName": {}, + "thingGroupArn": {}, + "thingGroupId": {}, + "indexName": {}, + "queryString": {}, + "queryVersion": {} + } + } + }, + "CreateJob": { + "http": { + "method": "PUT", + "requestUri": "/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "targets" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "targets": { + "shape": "Sg" + }, + "documentSource": {}, + "document": {}, + "description": {}, + "presignedUrlConfig": { + "shape": "S2h" + }, + "targetSelection": {}, + "jobExecutionsRolloutConfig": { + "shape": "S2l" + }, + "abortConfig": { + "shape": "S2s" + }, + "timeoutConfig": { + "shape": "S2z" + }, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobArn": {}, + "jobId": {}, + "description": {} + } + } + }, + "CreateKeysAndCertificate": { + "http": { + "requestUri": "/keys-and-certificate" + }, + "input": { + "type": "structure", + "members": { + "setAsActive": { + "location": "querystring", + "locationName": "setAsActive", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {}, + "certificatePem": {}, + "keyPair": { + "type": "structure", + "members": { + "PublicKey": {}, + "PrivateKey": { + "type": "string", + "sensitive": true + } + } + } + } + } + }, + "CreateOTAUpdate": { + "http": { + "requestUri": "/otaUpdates/{otaUpdateId}" + }, + "input": { + "type": "structure", + "required": [ + "otaUpdateId", + "targets", + "files", + "roleArn" + ], + "members": { + "otaUpdateId": { + "location": "uri", + "locationName": "otaUpdateId" + }, + "description": {}, + "targets": { + "shape": "S3a" + }, + "targetSelection": {}, + "awsJobExecutionsRolloutConfig": { + "shape": "S3c" + }, + "files": { + "shape": "S3e" + }, + "roleArn": {}, + "additionalParameters": { + "shape": "S4b" + }, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "otaUpdateId": {}, + "awsIotJobId": {}, + "otaUpdateArn": {}, + "awsIotJobArn": {}, + "otaUpdateStatus": {} + } + } + }, + "CreatePolicy": { + "http": { + "requestUri": "/policies/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "policyDocument" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "policyDocument": {} + } + }, + "output": { + "type": "structure", + "members": { + "policyName": {}, + "policyArn": {}, + "policyDocument": {}, + "policyVersionId": {} + } + } + }, + "CreatePolicyVersion": { + "http": { + "requestUri": "/policies/{policyName}/version" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "policyDocument" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "policyDocument": {}, + "setAsDefault": { + "location": "querystring", + "locationName": "setAsDefault", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "policyArn": {}, + "policyDocument": {}, + "policyVersionId": {}, + "isDefaultVersion": { + "type": "boolean" + } + } + } + }, + "CreateRoleAlias": { + "http": { + "requestUri": "/role-aliases/{roleAlias}" + }, + "input": { + "type": "structure", + "required": [ + "roleAlias", + "roleArn" + ], + "members": { + "roleAlias": { + "location": "uri", + "locationName": "roleAlias" + }, + "roleArn": {}, + "credentialDurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "roleAlias": {}, + "roleAliasArn": {} + } + } + }, + "CreateScheduledAudit": { + "http": { + "requestUri": "/audit/scheduledaudits/{scheduledAuditName}" + }, + "input": { + "type": "structure", + "required": [ + "frequency", + "targetCheckNames", + "scheduledAuditName" + ], + "members": { + "frequency": {}, + "dayOfMonth": {}, + "dayOfWeek": {}, + "targetCheckNames": { + "shape": "S4z" + }, + "tags": { + "shape": "S1q" + }, + "scheduledAuditName": { + "location": "uri", + "locationName": "scheduledAuditName" + } + } + }, + "output": { + "type": "structure", + "members": { + "scheduledAuditArn": {} + } + } + }, + "CreateSecurityProfile": { + "http": { + "requestUri": "/security-profiles/{securityProfileName}" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileName" + ], + "members": { + "securityProfileName": { + "location": "uri", + "locationName": "securityProfileName" + }, + "securityProfileDescription": {}, + "behaviors": { + "shape": "S56" + }, + "alertTargets": { + "shape": "S5n" + }, + "additionalMetricsToRetain": { + "shape": "S5r" + }, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "securityProfileName": {}, + "securityProfileArn": {} + } + } + }, + "CreateStream": { + "http": { + "requestUri": "/streams/{streamId}" + }, + "input": { + "type": "structure", + "required": [ + "streamId", + "files", + "roleArn" + ], + "members": { + "streamId": { + "location": "uri", + "locationName": "streamId" + }, + "description": {}, + "files": { + "shape": "S5w" + }, + "roleArn": {}, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "streamId": {}, + "streamArn": {}, + "description": {}, + "streamVersion": { + "type": "integer" + } + } + } + }, + "CreateThing": { + "http": { + "requestUri": "/things/{thingName}" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "thingTypeName": {}, + "attributePayload": { + "shape": "S24" + }, + "billingGroupName": {} + } + }, + "output": { + "type": "structure", + "members": { + "thingName": {}, + "thingArn": {}, + "thingId": {} + } + } + }, + "CreateThingGroup": { + "http": { + "requestUri": "/thing-groups/{thingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + }, + "parentGroupName": {}, + "thingGroupProperties": { + "shape": "S22" + }, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingGroupName": {}, + "thingGroupArn": {}, + "thingGroupId": {} + } + } + }, + "CreateThingType": { + "http": { + "requestUri": "/thing-types/{thingTypeName}" + }, + "input": { + "type": "structure", + "required": [ + "thingTypeName" + ], + "members": { + "thingTypeName": { + "location": "uri", + "locationName": "thingTypeName" + }, + "thingTypeProperties": { + "shape": "S68" + }, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingTypeName": {}, + "thingTypeArn": {}, + "thingTypeId": {} + } + } + }, + "CreateTopicRule": { + "http": { + "requestUri": "/rules/{ruleName}" + }, + "input": { + "type": "structure", + "required": [ + "ruleName", + "topicRulePayload" + ], + "members": { + "ruleName": { + "location": "uri", + "locationName": "ruleName" + }, + "topicRulePayload": { + "shape": "S6g" + }, + "tags": { + "location": "header", + "locationName": "x-amz-tagging" + } + }, + "payload": "topicRulePayload" + } + }, + "DeleteAccountAuditConfiguration": { + "http": { + "method": "DELETE", + "requestUri": "/audit/configuration" + }, + "input": { + "type": "structure", + "members": { + "deleteScheduledAudits": { + "location": "querystring", + "locationName": "deleteScheduledAudits", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteAuthorizer": { + "http": { + "method": "DELETE", + "requestUri": "/authorizer/{authorizerName}" + }, + "input": { + "type": "structure", + "required": [ + "authorizerName" + ], + "members": { + "authorizerName": { + "location": "uri", + "locationName": "authorizerName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteBillingGroup": { + "http": { + "method": "DELETE", + "requestUri": "/billing-groups/{billingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "billingGroupName" + ], + "members": { + "billingGroupName": { + "location": "uri", + "locationName": "billingGroupName" + }, + "expectedVersion": { + "location": "querystring", + "locationName": "expectedVersion", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteCACertificate": { + "http": { + "method": "DELETE", + "requestUri": "/cacertificate/{caCertificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "caCertificateId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteCertificate": { + "http": { + "method": "DELETE", + "requestUri": "/certificates/{certificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "certificateId" + }, + "forceDelete": { + "location": "querystring", + "locationName": "forceDelete", + "type": "boolean" + } + } + } + }, + "DeleteDynamicThingGroup": { + "http": { + "method": "DELETE", + "requestUri": "/dynamic-thing-groups/{thingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + }, + "expectedVersion": { + "location": "querystring", + "locationName": "expectedVersion", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteJob": { + "http": { + "method": "DELETE", + "requestUri": "/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "force": { + "location": "querystring", + "locationName": "force", + "type": "boolean" + } + } + } + }, + "DeleteJobExecution": { + "http": { + "method": "DELETE", + "requestUri": "/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "thingName", + "executionNumber" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "executionNumber": { + "location": "uri", + "locationName": "executionNumber", + "type": "long" + }, + "force": { + "location": "querystring", + "locationName": "force", + "type": "boolean" + } + } + } + }, + "DeleteOTAUpdate": { + "http": { + "method": "DELETE", + "requestUri": "/otaUpdates/{otaUpdateId}" + }, + "input": { + "type": "structure", + "required": [ + "otaUpdateId" + ], + "members": { + "otaUpdateId": { + "location": "uri", + "locationName": "otaUpdateId" + }, + "deleteStream": { + "location": "querystring", + "locationName": "deleteStream", + "type": "boolean" + }, + "forceDeleteAWSJob": { + "location": "querystring", + "locationName": "forceDeleteAWSJob", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePolicy": { + "http": { + "method": "DELETE", + "requestUri": "/policies/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + } + } + } + }, + "DeletePolicyVersion": { + "http": { + "method": "DELETE", + "requestUri": "/policies/{policyName}/version/{policyVersionId}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "policyVersionId" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "policyVersionId": { + "location": "uri", + "locationName": "policyVersionId" + } + } + } + }, + "DeleteRegistrationCode": { + "http": { + "method": "DELETE", + "requestUri": "/registrationcode" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRoleAlias": { + "http": { + "method": "DELETE", + "requestUri": "/role-aliases/{roleAlias}" + }, + "input": { + "type": "structure", + "required": [ + "roleAlias" + ], + "members": { + "roleAlias": { + "location": "uri", + "locationName": "roleAlias" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteScheduledAudit": { + "http": { + "method": "DELETE", + "requestUri": "/audit/scheduledaudits/{scheduledAuditName}" + }, + "input": { + "type": "structure", + "required": [ + "scheduledAuditName" + ], + "members": { + "scheduledAuditName": { + "location": "uri", + "locationName": "scheduledAuditName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSecurityProfile": { + "http": { + "method": "DELETE", + "requestUri": "/security-profiles/{securityProfileName}" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileName" + ], + "members": { + "securityProfileName": { + "location": "uri", + "locationName": "securityProfileName" + }, + "expectedVersion": { + "location": "querystring", + "locationName": "expectedVersion", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteStream": { + "http": { + "method": "DELETE", + "requestUri": "/streams/{streamId}" + }, + "input": { + "type": "structure", + "required": [ + "streamId" + ], + "members": { + "streamId": { + "location": "uri", + "locationName": "streamId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteThing": { + "http": { + "method": "DELETE", + "requestUri": "/things/{thingName}" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "expectedVersion": { + "location": "querystring", + "locationName": "expectedVersion", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteThingGroup": { + "http": { + "method": "DELETE", + "requestUri": "/thing-groups/{thingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + }, + "expectedVersion": { + "location": "querystring", + "locationName": "expectedVersion", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteThingType": { + "http": { + "method": "DELETE", + "requestUri": "/thing-types/{thingTypeName}" + }, + "input": { + "type": "structure", + "required": [ + "thingTypeName" + ], + "members": { + "thingTypeName": { + "location": "uri", + "locationName": "thingTypeName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTopicRule": { + "http": { + "method": "DELETE", + "requestUri": "/rules/{ruleName}" + }, + "input": { + "type": "structure", + "required": [ + "ruleName" + ], + "members": { + "ruleName": { + "location": "uri", + "locationName": "ruleName" + } + } + } + }, + "DeleteV2LoggingLevel": { + "http": { + "method": "DELETE", + "requestUri": "/v2LoggingLevel" + }, + "input": { + "type": "structure", + "required": [ + "targetType", + "targetName" + ], + "members": { + "targetType": { + "location": "querystring", + "locationName": "targetType" + }, + "targetName": { + "location": "querystring", + "locationName": "targetName" + } + } + } + }, + "DeprecateThingType": { + "http": { + "requestUri": "/thing-types/{thingTypeName}/deprecate" + }, + "input": { + "type": "structure", + "required": [ + "thingTypeName" + ], + "members": { + "thingTypeName": { + "location": "uri", + "locationName": "thingTypeName" + }, + "undoDeprecate": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeAccountAuditConfiguration": { + "http": { + "method": "GET", + "requestUri": "/audit/configuration" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "roleArn": {}, + "auditNotificationTargetConfigurations": { + "shape": "S9g" + }, + "auditCheckConfigurations": { + "shape": "S9k" + } + } + } + }, + "DescribeAuditTask": { + "http": { + "method": "GET", + "requestUri": "/audit/tasks/{taskId}" + }, + "input": { + "type": "structure", + "required": [ + "taskId" + ], + "members": { + "taskId": { + "location": "uri", + "locationName": "taskId" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskStatus": {}, + "taskType": {}, + "taskStartTime": { + "type": "timestamp" + }, + "taskStatistics": { + "type": "structure", + "members": { + "totalChecks": { + "type": "integer" + }, + "inProgressChecks": { + "type": "integer" + }, + "waitingForDataCollectionChecks": { + "type": "integer" + }, + "compliantChecks": { + "type": "integer" + }, + "nonCompliantChecks": { + "type": "integer" + }, + "failedChecks": { + "type": "integer" + }, + "canceledChecks": { + "type": "integer" + } + } + }, + "scheduledAuditName": {}, + "auditDetails": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "checkRunStatus": {}, + "checkCompliant": { + "type": "boolean" + }, + "totalResourcesCount": { + "type": "long" + }, + "nonCompliantResourcesCount": { + "type": "long" + }, + "errorCode": {}, + "message": {} + } + } + } + } + } + }, + "DescribeAuthorizer": { + "http": { + "method": "GET", + "requestUri": "/authorizer/{authorizerName}" + }, + "input": { + "type": "structure", + "required": [ + "authorizerName" + ], + "members": { + "authorizerName": { + "location": "uri", + "locationName": "authorizerName" + } + } + }, + "output": { + "type": "structure", + "members": { + "authorizerDescription": { + "shape": "Sa9" + } + } + } + }, + "DescribeBillingGroup": { + "http": { + "method": "GET", + "requestUri": "/billing-groups/{billingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "billingGroupName" + ], + "members": { + "billingGroupName": { + "location": "uri", + "locationName": "billingGroupName" + } + } + }, + "output": { + "type": "structure", + "members": { + "billingGroupName": {}, + "billingGroupId": {}, + "billingGroupArn": {}, + "version": { + "type": "long" + }, + "billingGroupProperties": { + "shape": "S1o" + }, + "billingGroupMetadata": { + "type": "structure", + "members": { + "creationDate": { + "type": "timestamp" + } + } + } + } + } + }, + "DescribeCACertificate": { + "http": { + "method": "GET", + "requestUri": "/cacertificate/{caCertificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "caCertificateId" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificateDescription": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {}, + "status": {}, + "certificatePem": {}, + "ownedBy": {}, + "creationDate": { + "type": "timestamp" + }, + "autoRegistrationStatus": {}, + "lastModifiedDate": { + "type": "timestamp" + }, + "customerVersion": { + "type": "integer" + }, + "generationId": {}, + "validity": { + "shape": "Sao" + } + } + }, + "registrationConfig": { + "shape": "Sap" + } + } + } + }, + "DescribeCertificate": { + "http": { + "method": "GET", + "requestUri": "/certificates/{certificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "certificateId" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificateDescription": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {}, + "caCertificateId": {}, + "status": {}, + "certificatePem": {}, + "ownedBy": {}, + "previousOwnedBy": {}, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + }, + "customerVersion": { + "type": "integer" + }, + "transferData": { + "type": "structure", + "members": { + "transferMessage": {}, + "rejectReason": {}, + "transferDate": { + "type": "timestamp" + }, + "acceptDate": { + "type": "timestamp" + }, + "rejectDate": { + "type": "timestamp" + } + } + }, + "generationId": {}, + "validity": { + "shape": "Sao" + } + } + } + } + } + }, + "DescribeDefaultAuthorizer": { + "http": { + "method": "GET", + "requestUri": "/default-authorizer" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "authorizerDescription": { + "shape": "Sa9" + } + } + } + }, + "DescribeEndpoint": { + "http": { + "method": "GET", + "requestUri": "/endpoint" + }, + "input": { + "type": "structure", + "members": { + "endpointType": { + "location": "querystring", + "locationName": "endpointType" + } + } + }, + "output": { + "type": "structure", + "members": { + "endpointAddress": {} + } + } + }, + "DescribeEventConfigurations": { + "http": { + "method": "GET", + "requestUri": "/event-configurations" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "eventConfigurations": { + "shape": "Sb5" + }, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + } + } + } + }, + "DescribeIndex": { + "http": { + "method": "GET", + "requestUri": "/indices/{indexName}" + }, + "input": { + "type": "structure", + "required": [ + "indexName" + ], + "members": { + "indexName": { + "location": "uri", + "locationName": "indexName" + } + } + }, + "output": { + "type": "structure", + "members": { + "indexName": {}, + "indexStatus": {}, + "schema": {} + } + } + }, + "DescribeJob": { + "http": { + "method": "GET", + "requestUri": "/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + } + } + }, + "output": { + "type": "structure", + "members": { + "documentSource": {}, + "job": { + "type": "structure", + "members": { + "jobArn": {}, + "jobId": {}, + "targetSelection": {}, + "status": {}, + "forceCanceled": { + "type": "boolean" + }, + "reasonCode": {}, + "comment": {}, + "targets": { + "shape": "Sg" + }, + "description": {}, + "presignedUrlConfig": { + "shape": "S2h" + }, + "jobExecutionsRolloutConfig": { + "shape": "S2l" + }, + "abortConfig": { + "shape": "S2s" + }, + "createdAt": { + "type": "timestamp" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "completedAt": { + "type": "timestamp" + }, + "jobProcessDetails": { + "type": "structure", + "members": { + "processingTargets": { + "type": "list", + "member": {} + }, + "numberOfCanceledThings": { + "type": "integer" + }, + "numberOfSucceededThings": { + "type": "integer" + }, + "numberOfFailedThings": { + "type": "integer" + }, + "numberOfRejectedThings": { + "type": "integer" + }, + "numberOfQueuedThings": { + "type": "integer" + }, + "numberOfInProgressThings": { + "type": "integer" + }, + "numberOfRemovedThings": { + "type": "integer" + }, + "numberOfTimedOutThings": { + "type": "integer" + } + } + }, + "timeoutConfig": { + "shape": "S2z" + } + } + } + } + } + }, + "DescribeJobExecution": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "thingName" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "executionNumber": { + "location": "querystring", + "locationName": "executionNumber", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "execution": { + "type": "structure", + "members": { + "jobId": {}, + "status": {}, + "forceCanceled": { + "type": "boolean" + }, + "statusDetails": { + "type": "structure", + "members": { + "detailsMap": { + "shape": "S18" + } + } + }, + "thingArn": {}, + "queuedAt": { + "type": "timestamp" + }, + "startedAt": { + "type": "timestamp" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "executionNumber": { + "type": "long" + }, + "versionNumber": { + "type": "long" + }, + "approximateSecondsBeforeTimedOut": { + "type": "long" + } + } + } + } + } + }, + "DescribeRoleAlias": { + "http": { + "method": "GET", + "requestUri": "/role-aliases/{roleAlias}" + }, + "input": { + "type": "structure", + "required": [ + "roleAlias" + ], + "members": { + "roleAlias": { + "location": "uri", + "locationName": "roleAlias" + } + } + }, + "output": { + "type": "structure", + "members": { + "roleAliasDescription": { + "type": "structure", + "members": { + "roleAlias": {}, + "roleAliasArn": {}, + "roleArn": {}, + "owner": {}, + "credentialDurationSeconds": { + "type": "integer" + }, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + } + } + } + } + } + }, + "DescribeScheduledAudit": { + "http": { + "method": "GET", + "requestUri": "/audit/scheduledaudits/{scheduledAuditName}" + }, + "input": { + "type": "structure", + "required": [ + "scheduledAuditName" + ], + "members": { + "scheduledAuditName": { + "location": "uri", + "locationName": "scheduledAuditName" + } + } + }, + "output": { + "type": "structure", + "members": { + "frequency": {}, + "dayOfMonth": {}, + "dayOfWeek": {}, + "targetCheckNames": { + "shape": "S4z" + }, + "scheduledAuditName": {}, + "scheduledAuditArn": {} + } + } + }, + "DescribeSecurityProfile": { + "http": { + "method": "GET", + "requestUri": "/security-profiles/{securityProfileName}" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileName" + ], + "members": { + "securityProfileName": { + "location": "uri", + "locationName": "securityProfileName" + } + } + }, + "output": { + "type": "structure", + "members": { + "securityProfileName": {}, + "securityProfileArn": {}, + "securityProfileDescription": {}, + "behaviors": { + "shape": "S56" + }, + "alertTargets": { + "shape": "S5n" + }, + "additionalMetricsToRetain": { + "shape": "S5r" + }, + "version": { + "type": "long" + }, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + } + } + } + }, + "DescribeStream": { + "http": { + "method": "GET", + "requestUri": "/streams/{streamId}" + }, + "input": { + "type": "structure", + "required": [ + "streamId" + ], + "members": { + "streamId": { + "location": "uri", + "locationName": "streamId" + } + } + }, + "output": { + "type": "structure", + "members": { + "streamInfo": { + "type": "structure", + "members": { + "streamId": {}, + "streamArn": {}, + "streamVersion": { + "type": "integer" + }, + "description": {}, + "files": { + "shape": "S5w" + }, + "createdAt": { + "type": "timestamp" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "roleArn": {} + } + } + } + } + }, + "DescribeThing": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + } + } + }, + "output": { + "type": "structure", + "members": { + "defaultClientId": {}, + "thingName": {}, + "thingId": {}, + "thingArn": {}, + "thingTypeName": {}, + "attributes": { + "shape": "S25" + }, + "version": { + "type": "long" + }, + "billingGroupName": {} + } + } + }, + "DescribeThingGroup": { + "http": { + "method": "GET", + "requestUri": "/thing-groups/{thingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingGroupName": {}, + "thingGroupId": {}, + "thingGroupArn": {}, + "version": { + "type": "long" + }, + "thingGroupProperties": { + "shape": "S22" + }, + "thingGroupMetadata": { + "type": "structure", + "members": { + "parentGroupName": {}, + "rootToParentThingGroups": { + "shape": "Scg" + }, + "creationDate": { + "type": "timestamp" + } + } + }, + "indexName": {}, + "queryString": {}, + "queryVersion": {}, + "status": {} + } + } + }, + "DescribeThingRegistrationTask": { + "http": { + "method": "GET", + "requestUri": "/thing-registration-tasks/{taskId}" + }, + "input": { + "type": "structure", + "required": [ + "taskId" + ], + "members": { + "taskId": { + "location": "uri", + "locationName": "taskId" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskId": {}, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + }, + "templateBody": {}, + "inputFileBucket": {}, + "inputFileKey": {}, + "roleArn": {}, + "status": {}, + "message": {}, + "successCount": { + "type": "integer" + }, + "failureCount": { + "type": "integer" + }, + "percentageProgress": { + "type": "integer" + } + } + } + }, + "DescribeThingType": { + "http": { + "method": "GET", + "requestUri": "/thing-types/{thingTypeName}" + }, + "input": { + "type": "structure", + "required": [ + "thingTypeName" + ], + "members": { + "thingTypeName": { + "location": "uri", + "locationName": "thingTypeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingTypeName": {}, + "thingTypeId": {}, + "thingTypeArn": {}, + "thingTypeProperties": { + "shape": "S68" + }, + "thingTypeMetadata": { + "shape": "Sct" + } + } + } + }, + "DetachPolicy": { + "http": { + "requestUri": "/target-policies/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "target" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "target": {} + } + } + }, + "DetachPrincipalPolicy": { + "http": { + "method": "DELETE", + "requestUri": "/principal-policies/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "principal" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "principal": { + "location": "header", + "locationName": "x-amzn-iot-principal" + } + } + }, + "deprecated": true + }, + "DetachSecurityProfile": { + "http": { + "method": "DELETE", + "requestUri": "/security-profiles/{securityProfileName}/targets" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileName", + "securityProfileTargetArn" + ], + "members": { + "securityProfileName": { + "location": "uri", + "locationName": "securityProfileName" + }, + "securityProfileTargetArn": { + "location": "querystring", + "locationName": "securityProfileTargetArn" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DetachThingPrincipal": { + "http": { + "method": "DELETE", + "requestUri": "/things/{thingName}/principals" + }, + "input": { + "type": "structure", + "required": [ + "thingName", + "principal" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "principal": { + "location": "header", + "locationName": "x-amzn-principal" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisableTopicRule": { + "http": { + "requestUri": "/rules/{ruleName}/disable" + }, + "input": { + "type": "structure", + "required": [ + "ruleName" + ], + "members": { + "ruleName": { + "location": "uri", + "locationName": "ruleName" + } + } + } + }, + "EnableTopicRule": { + "http": { + "requestUri": "/rules/{ruleName}/enable" + }, + "input": { + "type": "structure", + "required": [ + "ruleName" + ], + "members": { + "ruleName": { + "location": "uri", + "locationName": "ruleName" + } + } + } + }, + "GetEffectivePolicies": { + "http": { + "requestUri": "/effective-policies" + }, + "input": { + "type": "structure", + "members": { + "principal": {}, + "cognitoIdentityPoolId": {}, + "thingName": { + "location": "querystring", + "locationName": "thingName" + } + } + }, + "output": { + "type": "structure", + "members": { + "effectivePolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "policyName": {}, + "policyArn": {}, + "policyDocument": {} + } + } + } + } + } + }, + "GetIndexingConfiguration": { + "http": { + "method": "GET", + "requestUri": "/indexing/config" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "thingIndexingConfiguration": { + "shape": "Sdb" + }, + "thingGroupIndexingConfiguration": { + "shape": "Sde" + } + } + } + }, + "GetJobDocument": { + "http": { + "method": "GET", + "requestUri": "/jobs/{jobId}/job-document" + }, + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + } + } + }, + "output": { + "type": "structure", + "members": { + "document": {} + } + } + }, + "GetLoggingOptions": { + "http": { + "method": "GET", + "requestUri": "/loggingOptions" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "roleArn": {}, + "logLevel": {} + } + } + }, + "GetOTAUpdate": { + "http": { + "method": "GET", + "requestUri": "/otaUpdates/{otaUpdateId}" + }, + "input": { + "type": "structure", + "required": [ + "otaUpdateId" + ], + "members": { + "otaUpdateId": { + "location": "uri", + "locationName": "otaUpdateId" + } + } + }, + "output": { + "type": "structure", + "members": { + "otaUpdateInfo": { + "type": "structure", + "members": { + "otaUpdateId": {}, + "otaUpdateArn": {}, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + }, + "description": {}, + "targets": { + "shape": "S3a" + }, + "awsJobExecutionsRolloutConfig": { + "shape": "S3c" + }, + "targetSelection": {}, + "otaUpdateFiles": { + "shape": "S3e" + }, + "otaUpdateStatus": {}, + "awsIotJobId": {}, + "awsIotJobArn": {}, + "errorInfo": { + "type": "structure", + "members": { + "code": {}, + "message": {} + } + }, + "additionalParameters": { + "shape": "S4b" + } + } + } + } + } + }, + "GetPolicy": { + "http": { + "method": "GET", + "requestUri": "/policies/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + } + } + }, + "output": { + "type": "structure", + "members": { + "policyName": {}, + "policyArn": {}, + "policyDocument": {}, + "defaultVersionId": {}, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + }, + "generationId": {} + } + } + }, + "GetPolicyVersion": { + "http": { + "method": "GET", + "requestUri": "/policies/{policyName}/version/{policyVersionId}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "policyVersionId" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "policyVersionId": { + "location": "uri", + "locationName": "policyVersionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "policyArn": {}, + "policyName": {}, + "policyDocument": {}, + "policyVersionId": {}, + "isDefaultVersion": { + "type": "boolean" + }, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + }, + "generationId": {} + } + } + }, + "GetRegistrationCode": { + "http": { + "method": "GET", + "requestUri": "/registrationcode" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "registrationCode": {} + } + } + }, + "GetStatistics": { + "http": { + "requestUri": "/indices/statistics" + }, + "input": { + "type": "structure", + "required": [ + "queryString" + ], + "members": { + "indexName": {}, + "queryString": {}, + "aggregationField": {}, + "queryVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "statistics": { + "type": "structure", + "members": { + "count": { + "type": "integer" + } + } + } + } + } + }, + "GetTopicRule": { + "http": { + "method": "GET", + "requestUri": "/rules/{ruleName}" + }, + "input": { + "type": "structure", + "required": [ + "ruleName" + ], + "members": { + "ruleName": { + "location": "uri", + "locationName": "ruleName" + } + } + }, + "output": { + "type": "structure", + "members": { + "ruleArn": {}, + "rule": { + "type": "structure", + "members": { + "ruleName": {}, + "sql": {}, + "description": {}, + "createdAt": { + "type": "timestamp" + }, + "actions": { + "shape": "S6j" + }, + "ruleDisabled": { + "type": "boolean" + }, + "awsIotSqlVersion": {}, + "errorAction": { + "shape": "S6k" + } + } + } + } + } + }, + "GetV2LoggingOptions": { + "http": { + "method": "GET", + "requestUri": "/v2LoggingOptions" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "roleArn": {}, + "defaultLogLevel": {}, + "disableAllLogs": { + "type": "boolean" + } + } + } + }, + "ListActiveViolations": { + "http": { + "method": "GET", + "requestUri": "/active-violations" + }, + "input": { + "type": "structure", + "members": { + "thingName": { + "location": "querystring", + "locationName": "thingName" + }, + "securityProfileName": { + "location": "querystring", + "locationName": "securityProfileName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "activeViolations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "violationId": {}, + "thingName": {}, + "securityProfileName": {}, + "behavior": { + "shape": "S57" + }, + "lastViolationValue": { + "shape": "S5c" + }, + "lastViolationTime": { + "type": "timestamp" + }, + "violationStartTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListAttachedPolicies": { + "http": { + "requestUri": "/attached-policies/{target}" + }, + "input": { + "type": "structure", + "required": [ + "target" + ], + "members": { + "target": { + "location": "uri", + "locationName": "target" + }, + "recursive": { + "location": "querystring", + "locationName": "recursive", + "type": "boolean" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "policies": { + "shape": "Sem" + }, + "nextMarker": {} + } + } + }, + "ListAuditFindings": { + "http": { + "requestUri": "/audit/findings" + }, + "input": { + "type": "structure", + "members": { + "taskId": {}, + "checkName": {}, + "resourceIdentifier": { + "shape": "Sep" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {}, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "findings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "taskId": {}, + "checkName": {}, + "taskStartTime": { + "type": "timestamp" + }, + "findingTime": { + "type": "timestamp" + }, + "severity": {}, + "nonCompliantResource": { + "type": "structure", + "members": { + "resourceType": {}, + "resourceIdentifier": { + "shape": "Sep" + }, + "additionalInfo": { + "shape": "Sex" + } + } + }, + "relatedResources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resourceType": {}, + "resourceIdentifier": { + "shape": "Sep" + }, + "additionalInfo": { + "shape": "Sex" + } + } + } + }, + "reasonForNonCompliance": {}, + "reasonForNonComplianceCode": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListAuditTasks": { + "http": { + "method": "GET", + "requestUri": "/audit/tasks" + }, + "input": { + "type": "structure", + "required": [ + "startTime", + "endTime" + ], + "members": { + "startTime": { + "location": "querystring", + "locationName": "startTime", + "type": "timestamp" + }, + "endTime": { + "location": "querystring", + "locationName": "endTime", + "type": "timestamp" + }, + "taskType": { + "location": "querystring", + "locationName": "taskType" + }, + "taskStatus": { + "location": "querystring", + "locationName": "taskStatus" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "tasks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "taskId": {}, + "taskStatus": {}, + "taskType": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListAuthorizers": { + "http": { + "method": "GET", + "requestUri": "/authorizers/" + }, + "input": { + "type": "structure", + "members": { + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + }, + "status": { + "location": "querystring", + "locationName": "status" + } + } + }, + "output": { + "type": "structure", + "members": { + "authorizers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "authorizerName": {}, + "authorizerArn": {} + } + } + }, + "nextMarker": {} + } + } + }, + "ListBillingGroups": { + "http": { + "method": "GET", + "requestUri": "/billing-groups" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "namePrefixFilter": { + "location": "querystring", + "locationName": "namePrefixFilter" + } + } + }, + "output": { + "type": "structure", + "members": { + "billingGroups": { + "type": "list", + "member": { + "shape": "Sch" + } + }, + "nextToken": {} + } + } + }, + "ListCACertificates": { + "http": { + "method": "GET", + "requestUri": "/cacertificates" + }, + "input": { + "type": "structure", + "members": { + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {}, + "status": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "nextMarker": {} + } + } + }, + "ListCertificates": { + "http": { + "method": "GET", + "requestUri": "/certificates" + }, + "input": { + "type": "structure", + "members": { + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificates": { + "shape": "Sfl" + }, + "nextMarker": {} + } + } + }, + "ListCertificatesByCA": { + "http": { + "method": "GET", + "requestUri": "/certificates-by-ca/{caCertificateId}" + }, + "input": { + "type": "structure", + "required": [ + "caCertificateId" + ], + "members": { + "caCertificateId": { + "location": "uri", + "locationName": "caCertificateId" + }, + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificates": { + "shape": "Sfl" + }, + "nextMarker": {} + } + } + }, + "ListIndices": { + "http": { + "method": "GET", + "requestUri": "/indices" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "indexNames": { + "type": "list", + "member": {} + }, + "nextToken": {} + } + } + }, + "ListJobExecutionsForJob": { + "http": { + "method": "GET", + "requestUri": "/jobs/{jobId}/things" + }, + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "status": { + "location": "querystring", + "locationName": "status" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "executionSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "thingArn": {}, + "jobExecutionSummary": { + "shape": "Sfy" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListJobExecutionsForThing": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}/jobs" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "status": { + "location": "querystring", + "locationName": "status" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "executionSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "jobId": {}, + "jobExecutionSummary": { + "shape": "Sfy" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListJobs": { + "http": { + "method": "GET", + "requestUri": "/jobs" + }, + "input": { + "type": "structure", + "members": { + "status": { + "location": "querystring", + "locationName": "status" + }, + "targetSelection": { + "location": "querystring", + "locationName": "targetSelection" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "thingGroupName": { + "location": "querystring", + "locationName": "thingGroupName" + }, + "thingGroupId": { + "location": "querystring", + "locationName": "thingGroupId" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "jobArn": {}, + "jobId": {}, + "thingGroupId": {}, + "targetSelection": {}, + "status": {}, + "createdAt": { + "type": "timestamp" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "completedAt": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListOTAUpdates": { + "http": { + "method": "GET", + "requestUri": "/otaUpdates" + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "otaUpdateStatus": { + "location": "querystring", + "locationName": "otaUpdateStatus" + } + } + }, + "output": { + "type": "structure", + "members": { + "otaUpdates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "otaUpdateId": {}, + "otaUpdateArn": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListOutgoingCertificates": { + "http": { + "method": "GET", + "requestUri": "/certificates-out-going" + }, + "input": { + "type": "structure", + "members": { + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "outgoingCertificates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {}, + "transferredTo": {}, + "transferDate": { + "type": "timestamp" + }, + "transferMessage": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "nextMarker": {} + } + } + }, + "ListPolicies": { + "http": { + "method": "GET", + "requestUri": "/policies" + }, + "input": { + "type": "structure", + "members": { + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "policies": { + "shape": "Sem" + }, + "nextMarker": {} + } + } + }, + "ListPolicyPrincipals": { + "http": { + "method": "GET", + "requestUri": "/policy-principals" + }, + "input": { + "type": "structure", + "required": [ + "policyName" + ], + "members": { + "policyName": { + "location": "header", + "locationName": "x-amzn-iot-policy" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "principals": { + "shape": "Sgj" + }, + "nextMarker": {} + } + }, + "deprecated": true + }, + "ListPolicyVersions": { + "http": { + "method": "GET", + "requestUri": "/policies/{policyName}/version" + }, + "input": { + "type": "structure", + "required": [ + "policyName" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + } + } + }, + "output": { + "type": "structure", + "members": { + "policyVersions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "versionId": {}, + "isDefaultVersion": { + "type": "boolean" + }, + "createDate": { + "type": "timestamp" + } + } + } + } + } + } + }, + "ListPrincipalPolicies": { + "http": { + "method": "GET", + "requestUri": "/principal-policies" + }, + "input": { + "type": "structure", + "required": [ + "principal" + ], + "members": { + "principal": { + "location": "header", + "locationName": "x-amzn-iot-principal" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "policies": { + "shape": "Sem" + }, + "nextMarker": {} + } + }, + "deprecated": true + }, + "ListPrincipalThings": { + "http": { + "method": "GET", + "requestUri": "/principals/things" + }, + "input": { + "type": "structure", + "required": [ + "principal" + ], + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "principal": { + "location": "header", + "locationName": "x-amzn-principal" + } + } + }, + "output": { + "type": "structure", + "members": { + "things": { + "shape": "Sgt" + }, + "nextToken": {} + } + } + }, + "ListRoleAliases": { + "http": { + "method": "GET", + "requestUri": "/role-aliases" + }, + "input": { + "type": "structure", + "members": { + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "roleAliases": { + "type": "list", + "member": {} + }, + "nextMarker": {} + } + } + }, + "ListScheduledAudits": { + "http": { + "method": "GET", + "requestUri": "/audit/scheduledaudits" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "scheduledAudits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "scheduledAuditName": {}, + "scheduledAuditArn": {}, + "frequency": {}, + "dayOfMonth": {}, + "dayOfWeek": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListSecurityProfiles": { + "http": { + "method": "GET", + "requestUri": "/security-profiles" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "securityProfileIdentifiers": { + "type": "list", + "member": { + "shape": "Sh4" + } + }, + "nextToken": {} + } + } + }, + "ListSecurityProfilesForTarget": { + "http": { + "method": "GET", + "requestUri": "/security-profiles-for-target" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileTargetArn" + ], + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "recursive": { + "location": "querystring", + "locationName": "recursive", + "type": "boolean" + }, + "securityProfileTargetArn": { + "location": "querystring", + "locationName": "securityProfileTargetArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "securityProfileTargetMappings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "securityProfileIdentifier": { + "shape": "Sh4" + }, + "target": { + "shape": "Sh9" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListStreams": { + "http": { + "method": "GET", + "requestUri": "/streams" + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "ascendingOrder": { + "location": "querystring", + "locationName": "isAscendingOrder", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "streams": { + "type": "list", + "member": { + "type": "structure", + "members": { + "streamId": {}, + "streamArn": {}, + "streamVersion": { + "type": "integer" + }, + "description": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "location": "querystring", + "locationName": "resourceArn" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "S1q" + }, + "nextToken": {} + } + } + }, + "ListTargetsForPolicy": { + "http": { + "requestUri": "/policy-targets/{policyName}" + }, + "input": { + "type": "structure", + "required": [ + "policyName" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "pageSize": { + "location": "querystring", + "locationName": "pageSize", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "targets": { + "type": "list", + "member": {} + }, + "nextMarker": {} + } + } + }, + "ListTargetsForSecurityProfile": { + "http": { + "method": "GET", + "requestUri": "/security-profiles/{securityProfileName}/targets" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileName" + ], + "members": { + "securityProfileName": { + "location": "uri", + "locationName": "securityProfileName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "securityProfileTargets": { + "type": "list", + "member": { + "shape": "Sh9" + } + }, + "nextToken": {} + } + } + }, + "ListThingGroups": { + "http": { + "method": "GET", + "requestUri": "/thing-groups" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "parentGroup": { + "location": "querystring", + "locationName": "parentGroup" + }, + "namePrefixFilter": { + "location": "querystring", + "locationName": "namePrefixFilter" + }, + "recursive": { + "location": "querystring", + "locationName": "recursive", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingGroups": { + "shape": "Scg" + }, + "nextToken": {} + } + } + }, + "ListThingGroupsForThing": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}/thing-groups" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingGroups": { + "shape": "Scg" + }, + "nextToken": {} + } + } + }, + "ListThingPrincipals": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}/principals" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + } + } + }, + "output": { + "type": "structure", + "members": { + "principals": { + "shape": "Sgj" + } + } + } + }, + "ListThingRegistrationTaskReports": { + "http": { + "method": "GET", + "requestUri": "/thing-registration-tasks/{taskId}/reports" + }, + "input": { + "type": "structure", + "required": [ + "taskId", + "reportType" + ], + "members": { + "taskId": { + "location": "uri", + "locationName": "taskId" + }, + "reportType": { + "location": "querystring", + "locationName": "reportType" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resourceLinks": { + "type": "list", + "member": {} + }, + "reportType": {}, + "nextToken": {} + } + } + }, + "ListThingRegistrationTasks": { + "http": { + "method": "GET", + "requestUri": "/thing-registration-tasks" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "status": { + "location": "querystring", + "locationName": "status" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskIds": { + "type": "list", + "member": {} + }, + "nextToken": {} + } + } + }, + "ListThingTypes": { + "http": { + "method": "GET", + "requestUri": "/thing-types" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "thingTypeName": { + "location": "querystring", + "locationName": "thingTypeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "thingTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "thingTypeName": {}, + "thingTypeArn": {}, + "thingTypeProperties": { + "shape": "S68" + }, + "thingTypeMetadata": { + "shape": "Sct" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListThings": { + "http": { + "method": "GET", + "requestUri": "/things" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "attributeName": { + "location": "querystring", + "locationName": "attributeName" + }, + "attributeValue": { + "location": "querystring", + "locationName": "attributeValue" + }, + "thingTypeName": { + "location": "querystring", + "locationName": "thingTypeName" + } + } + }, + "output": { + "type": "structure", + "members": { + "things": { + "type": "list", + "member": { + "type": "structure", + "members": { + "thingName": {}, + "thingTypeName": {}, + "thingArn": {}, + "attributes": { + "shape": "S25" + }, + "version": { + "type": "long" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListThingsInBillingGroup": { + "http": { + "method": "GET", + "requestUri": "/billing-groups/{billingGroupName}/things" + }, + "input": { + "type": "structure", + "required": [ + "billingGroupName" + ], + "members": { + "billingGroupName": { + "location": "uri", + "locationName": "billingGroupName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "things": { + "shape": "Sgt" + }, + "nextToken": {} + } + } + }, + "ListThingsInThingGroup": { + "http": { + "method": "GET", + "requestUri": "/thing-groups/{thingGroupName}/things" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + }, + "recursive": { + "location": "querystring", + "locationName": "recursive", + "type": "boolean" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "things": { + "shape": "Sgt" + }, + "nextToken": {} + } + } + }, + "ListTopicRules": { + "http": { + "method": "GET", + "requestUri": "/rules" + }, + "input": { + "type": "structure", + "members": { + "topic": { + "location": "querystring", + "locationName": "topic" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "ruleDisabled": { + "location": "querystring", + "locationName": "ruleDisabled", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "rules": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ruleArn": {}, + "ruleName": {}, + "topicPattern": {}, + "createdAt": { + "type": "timestamp" + }, + "ruleDisabled": { + "type": "boolean" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListV2LoggingLevels": { + "http": { + "method": "GET", + "requestUri": "/v2LoggingLevel" + }, + "input": { + "type": "structure", + "members": { + "targetType": { + "location": "querystring", + "locationName": "targetType" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "logTargetConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "logTarget": { + "shape": "Sip" + }, + "logLevel": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListViolationEvents": { + "http": { + "method": "GET", + "requestUri": "/violation-events" + }, + "input": { + "type": "structure", + "required": [ + "startTime", + "endTime" + ], + "members": { + "startTime": { + "location": "querystring", + "locationName": "startTime", + "type": "timestamp" + }, + "endTime": { + "location": "querystring", + "locationName": "endTime", + "type": "timestamp" + }, + "thingName": { + "location": "querystring", + "locationName": "thingName" + }, + "securityProfileName": { + "location": "querystring", + "locationName": "securityProfileName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "violationEvents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "violationId": {}, + "thingName": {}, + "securityProfileName": {}, + "behavior": { + "shape": "S57" + }, + "metricValue": { + "shape": "S5c" + }, + "violationEventType": {}, + "violationEventTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "RegisterCACertificate": { + "http": { + "requestUri": "/cacertificate" + }, + "input": { + "type": "structure", + "required": [ + "caCertificate", + "verificationCertificate" + ], + "members": { + "caCertificate": {}, + "verificationCertificate": {}, + "setAsActive": { + "location": "querystring", + "locationName": "setAsActive", + "type": "boolean" + }, + "allowAutoRegistration": { + "location": "querystring", + "locationName": "allowAutoRegistration", + "type": "boolean" + }, + "registrationConfig": { + "shape": "Sap" + } + } + }, + "output": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {} + } + } + }, + "RegisterCertificate": { + "http": { + "requestUri": "/certificate/register" + }, + "input": { + "type": "structure", + "required": [ + "certificatePem" + ], + "members": { + "certificatePem": {}, + "caCertificatePem": {}, + "setAsActive": { + "deprecated": true, + "location": "querystring", + "locationName": "setAsActive", + "type": "boolean" + }, + "status": {} + } + }, + "output": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {} + } + } + }, + "RegisterThing": { + "http": { + "requestUri": "/things" + }, + "input": { + "type": "structure", + "required": [ + "templateBody" + ], + "members": { + "templateBody": {}, + "parameters": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "certificatePem": {}, + "resourceArns": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "RejectCertificateTransfer": { + "http": { + "method": "PATCH", + "requestUri": "/reject-certificate-transfer/{certificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "certificateId" + }, + "rejectReason": {} + } + } + }, + "RemoveThingFromBillingGroup": { + "http": { + "method": "PUT", + "requestUri": "/billing-groups/removeThingFromBillingGroup" + }, + "input": { + "type": "structure", + "members": { + "billingGroupName": {}, + "billingGroupArn": {}, + "thingName": {}, + "thingArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RemoveThingFromThingGroup": { + "http": { + "method": "PUT", + "requestUri": "/thing-groups/removeThingFromThingGroup" + }, + "input": { + "type": "structure", + "members": { + "thingGroupName": {}, + "thingGroupArn": {}, + "thingName": {}, + "thingArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ReplaceTopicRule": { + "http": { + "method": "PATCH", + "requestUri": "/rules/{ruleName}" + }, + "input": { + "type": "structure", + "required": [ + "ruleName", + "topicRulePayload" + ], + "members": { + "ruleName": { + "location": "uri", + "locationName": "ruleName" + }, + "topicRulePayload": { + "shape": "S6g" + } + }, + "payload": "topicRulePayload" + } + }, + "SearchIndex": { + "http": { + "requestUri": "/indices/search" + }, + "input": { + "type": "structure", + "required": [ + "queryString" + ], + "members": { + "indexName": {}, + "queryString": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "queryVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "nextToken": {}, + "things": { + "type": "list", + "member": { + "type": "structure", + "members": { + "thingName": {}, + "thingId": {}, + "thingTypeName": {}, + "thingGroupNames": { + "shape": "Sjh" + }, + "attributes": { + "shape": "S25" + }, + "shadow": {}, + "connectivity": { + "type": "structure", + "members": { + "connected": { + "type": "boolean" + }, + "timestamp": { + "type": "long" + } + } + } + } + } + }, + "thingGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "thingGroupName": {}, + "thingGroupId": {}, + "thingGroupDescription": {}, + "attributes": { + "shape": "S25" + }, + "parentGroupNames": { + "shape": "Sjh" + } + } + } + } + } + } + }, + "SetDefaultAuthorizer": { + "http": { + "requestUri": "/default-authorizer" + }, + "input": { + "type": "structure", + "required": [ + "authorizerName" + ], + "members": { + "authorizerName": {} + } + }, + "output": { + "type": "structure", + "members": { + "authorizerName": {}, + "authorizerArn": {} + } + } + }, + "SetDefaultPolicyVersion": { + "http": { + "method": "PATCH", + "requestUri": "/policies/{policyName}/version/{policyVersionId}" + }, + "input": { + "type": "structure", + "required": [ + "policyName", + "policyVersionId" + ], + "members": { + "policyName": { + "location": "uri", + "locationName": "policyName" + }, + "policyVersionId": { + "location": "uri", + "locationName": "policyVersionId" + } + } + } + }, + "SetLoggingOptions": { + "http": { + "requestUri": "/loggingOptions" + }, + "input": { + "type": "structure", + "required": [ + "loggingOptionsPayload" + ], + "members": { + "loggingOptionsPayload": { + "type": "structure", + "required": [ + "roleArn" + ], + "members": { + "roleArn": {}, + "logLevel": {} + } + } + }, + "payload": "loggingOptionsPayload" + } + }, + "SetV2LoggingLevel": { + "http": { + "requestUri": "/v2LoggingLevel" + }, + "input": { + "type": "structure", + "required": [ + "logTarget", + "logLevel" + ], + "members": { + "logTarget": { + "shape": "Sip" + }, + "logLevel": {} + } + } + }, + "SetV2LoggingOptions": { + "http": { + "requestUri": "/v2LoggingOptions" + }, + "input": { + "type": "structure", + "members": { + "roleArn": {}, + "defaultLogLevel": {}, + "disableAllLogs": { + "type": "boolean" + } + } + } + }, + "StartOnDemandAuditTask": { + "http": { + "requestUri": "/audit/tasks" + }, + "input": { + "type": "structure", + "required": [ + "targetCheckNames" + ], + "members": { + "targetCheckNames": { + "shape": "S4z" + } + } + }, + "output": { + "type": "structure", + "members": { + "taskId": {} + } + } + }, + "StartThingRegistrationTask": { + "http": { + "requestUri": "/thing-registration-tasks" + }, + "input": { + "type": "structure", + "required": [ + "templateBody", + "inputFileBucket", + "inputFileKey", + "roleArn" + ], + "members": { + "templateBody": {}, + "inputFileBucket": {}, + "inputFileKey": {}, + "roleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "taskId": {} + } + } + }, + "StopThingRegistrationTask": { + "http": { + "method": "PUT", + "requestUri": "/thing-registration-tasks/{taskId}/cancel" + }, + "input": { + "type": "structure", + "required": [ + "taskId" + ], + "members": { + "taskId": { + "location": "uri", + "locationName": "taskId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TagResource": { + "http": { + "requestUri": "/tags" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": {}, + "tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TestAuthorization": { + "http": { + "requestUri": "/test-authorization" + }, + "input": { + "type": "structure", + "required": [ + "authInfos" + ], + "members": { + "principal": {}, + "cognitoIdentityPoolId": {}, + "authInfos": { + "type": "list", + "member": { + "shape": "Sk4" + } + }, + "clientId": { + "location": "querystring", + "locationName": "clientId" + }, + "policyNamesToAdd": { + "shape": "Sk8" + }, + "policyNamesToSkip": { + "shape": "Sk8" + } + } + }, + "output": { + "type": "structure", + "members": { + "authResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "authInfo": { + "shape": "Sk4" + }, + "allowed": { + "type": "structure", + "members": { + "policies": { + "shape": "Sem" + } + } + }, + "denied": { + "type": "structure", + "members": { + "implicitDeny": { + "type": "structure", + "members": { + "policies": { + "shape": "Sem" + } + } + }, + "explicitDeny": { + "type": "structure", + "members": { + "policies": { + "shape": "Sem" + } + } + } + } + }, + "authDecision": {}, + "missingContextValues": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "TestInvokeAuthorizer": { + "http": { + "requestUri": "/authorizer/{authorizerName}/test" + }, + "input": { + "type": "structure", + "required": [ + "authorizerName", + "token", + "tokenSignature" + ], + "members": { + "authorizerName": { + "location": "uri", + "locationName": "authorizerName" + }, + "token": {}, + "tokenSignature": {} + } + }, + "output": { + "type": "structure", + "members": { + "isAuthenticated": { + "type": "boolean" + }, + "principalId": {}, + "policyDocuments": { + "type": "list", + "member": {} + }, + "refreshAfterInSeconds": { + "type": "integer" + }, + "disconnectAfterInSeconds": { + "type": "integer" + } + } + } + }, + "TransferCertificate": { + "http": { + "method": "PATCH", + "requestUri": "/transfer-certificate/{certificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId", + "targetAwsAccount" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "certificateId" + }, + "targetAwsAccount": { + "location": "querystring", + "locationName": "targetAwsAccount" + }, + "transferMessage": {} + } + }, + "output": { + "type": "structure", + "members": { + "transferredCertificateArn": {} + } + } + }, + "UntagResource": { + "http": { + "requestUri": "/untag" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": {}, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateAccountAuditConfiguration": { + "http": { + "method": "PATCH", + "requestUri": "/audit/configuration" + }, + "input": { + "type": "structure", + "members": { + "roleArn": {}, + "auditNotificationTargetConfigurations": { + "shape": "S9g" + }, + "auditCheckConfigurations": { + "shape": "S9k" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateAuthorizer": { + "http": { + "method": "PUT", + "requestUri": "/authorizer/{authorizerName}" + }, + "input": { + "type": "structure", + "required": [ + "authorizerName" + ], + "members": { + "authorizerName": { + "location": "uri", + "locationName": "authorizerName" + }, + "authorizerFunctionArn": {}, + "tokenKeyName": {}, + "tokenSigningPublicKeys": { + "shape": "S1h" + }, + "status": {} + } + }, + "output": { + "type": "structure", + "members": { + "authorizerName": {}, + "authorizerArn": {} + } + } + }, + "UpdateBillingGroup": { + "http": { + "method": "PATCH", + "requestUri": "/billing-groups/{billingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "billingGroupName", + "billingGroupProperties" + ], + "members": { + "billingGroupName": { + "location": "uri", + "locationName": "billingGroupName" + }, + "billingGroupProperties": { + "shape": "S1o" + }, + "expectedVersion": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "version": { + "type": "long" + } + } + } + }, + "UpdateCACertificate": { + "http": { + "method": "PUT", + "requestUri": "/cacertificate/{caCertificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "caCertificateId" + }, + "newStatus": { + "location": "querystring", + "locationName": "newStatus" + }, + "newAutoRegistrationStatus": { + "location": "querystring", + "locationName": "newAutoRegistrationStatus" + }, + "registrationConfig": { + "shape": "Sap" + }, + "removeAutoRegistration": { + "type": "boolean" + } + } + } + }, + "UpdateCertificate": { + "http": { + "method": "PUT", + "requestUri": "/certificates/{certificateId}" + }, + "input": { + "type": "structure", + "required": [ + "certificateId", + "newStatus" + ], + "members": { + "certificateId": { + "location": "uri", + "locationName": "certificateId" + }, + "newStatus": { + "location": "querystring", + "locationName": "newStatus" + } + } + } + }, + "UpdateDynamicThingGroup": { + "http": { + "method": "PATCH", + "requestUri": "/dynamic-thing-groups/{thingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName", + "thingGroupProperties" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + }, + "thingGroupProperties": { + "shape": "S22" + }, + "expectedVersion": { + "type": "long" + }, + "indexName": {}, + "queryString": {}, + "queryVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "version": { + "type": "long" + } + } + } + }, + "UpdateEventConfigurations": { + "http": { + "method": "PATCH", + "requestUri": "/event-configurations" + }, + "input": { + "type": "structure", + "members": { + "eventConfigurations": { + "shape": "Sb5" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateIndexingConfiguration": { + "http": { + "requestUri": "/indexing/config" + }, + "input": { + "type": "structure", + "members": { + "thingIndexingConfiguration": { + "shape": "Sdb" + }, + "thingGroupIndexingConfiguration": { + "shape": "Sde" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateJob": { + "http": { + "method": "PATCH", + "requestUri": "/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "description": {}, + "presignedUrlConfig": { + "shape": "S2h" + }, + "jobExecutionsRolloutConfig": { + "shape": "S2l" + }, + "abortConfig": { + "shape": "S2s" + }, + "timeoutConfig": { + "shape": "S2z" + } + } + } + }, + "UpdateRoleAlias": { + "http": { + "method": "PUT", + "requestUri": "/role-aliases/{roleAlias}" + }, + "input": { + "type": "structure", + "required": [ + "roleAlias" + ], + "members": { + "roleAlias": { + "location": "uri", + "locationName": "roleAlias" + }, + "roleArn": {}, + "credentialDurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "roleAlias": {}, + "roleAliasArn": {} + } + } + }, + "UpdateScheduledAudit": { + "http": { + "method": "PATCH", + "requestUri": "/audit/scheduledaudits/{scheduledAuditName}" + }, + "input": { + "type": "structure", + "required": [ + "scheduledAuditName" + ], + "members": { + "frequency": {}, + "dayOfMonth": {}, + "dayOfWeek": {}, + "targetCheckNames": { + "shape": "S4z" + }, + "scheduledAuditName": { + "location": "uri", + "locationName": "scheduledAuditName" + } + } + }, + "output": { + "type": "structure", + "members": { + "scheduledAuditArn": {} + } + } + }, + "UpdateSecurityProfile": { + "http": { + "method": "PATCH", + "requestUri": "/security-profiles/{securityProfileName}" + }, + "input": { + "type": "structure", + "required": [ + "securityProfileName" + ], + "members": { + "securityProfileName": { + "location": "uri", + "locationName": "securityProfileName" + }, + "securityProfileDescription": {}, + "behaviors": { + "shape": "S56" + }, + "alertTargets": { + "shape": "S5n" + }, + "additionalMetricsToRetain": { + "shape": "S5r" + }, + "deleteBehaviors": { + "type": "boolean" + }, + "deleteAlertTargets": { + "type": "boolean" + }, + "deleteAdditionalMetricsToRetain": { + "type": "boolean" + }, + "expectedVersion": { + "location": "querystring", + "locationName": "expectedVersion", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "securityProfileName": {}, + "securityProfileArn": {}, + "securityProfileDescription": {}, + "behaviors": { + "shape": "S56" + }, + "alertTargets": { + "shape": "S5n" + }, + "additionalMetricsToRetain": { + "shape": "S5r" + }, + "version": { + "type": "long" + }, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + } + } + } + }, + "UpdateStream": { + "http": { + "method": "PUT", + "requestUri": "/streams/{streamId}" + }, + "input": { + "type": "structure", + "required": [ + "streamId" + ], + "members": { + "streamId": { + "location": "uri", + "locationName": "streamId" + }, + "description": {}, + "files": { + "shape": "S5w" + }, + "roleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "streamId": {}, + "streamArn": {}, + "description": {}, + "streamVersion": { + "type": "integer" + } + } + } + }, + "UpdateThing": { + "http": { + "method": "PATCH", + "requestUri": "/things/{thingName}" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "thingTypeName": {}, + "attributePayload": { + "shape": "S24" + }, + "expectedVersion": { + "type": "long" + }, + "removeThingType": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateThingGroup": { + "http": { + "method": "PATCH", + "requestUri": "/thing-groups/{thingGroupName}" + }, + "input": { + "type": "structure", + "required": [ + "thingGroupName", + "thingGroupProperties" + ], + "members": { + "thingGroupName": { + "location": "uri", + "locationName": "thingGroupName" + }, + "thingGroupProperties": { + "shape": "S22" + }, + "expectedVersion": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "version": { + "type": "long" + } + } + } + }, + "UpdateThingGroupsForThing": { + "http": { + "method": "PUT", + "requestUri": "/thing-groups/updateThingGroupsForThing" + }, + "input": { + "type": "structure", + "members": { + "thingName": {}, + "thingGroupsToAdd": { + "shape": "Slt" + }, + "thingGroupsToRemove": { + "shape": "Slt" + }, + "overrideDynamicGroups": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ValidateSecurityProfileBehaviors": { + "http": { + "requestUri": "/security-profile-behaviors/validate" + }, + "input": { + "type": "structure", + "required": [ + "behaviors" + ], + "members": { + "behaviors": { + "shape": "S56" + } + } + }, + "output": { + "type": "structure", + "members": { + "valid": { + "type": "boolean" + }, + "validationErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "errorMessage": {} + } + } + } + } + } + } + }, + "shapes": { + "Sg": { + "type": "list", + "member": {} + }, + "S18": { + "type": "map", + "key": {}, + "value": {} + }, + "S1h": { + "type": "map", + "key": {}, + "value": {} + }, + "S1o": { + "type": "structure", + "members": { + "billingGroupDescription": {} + } + }, + "S1q": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S22": { + "type": "structure", + "members": { + "thingGroupDescription": {}, + "attributePayload": { + "shape": "S24" + } + } + }, + "S24": { + "type": "structure", + "members": { + "attributes": { + "shape": "S25" + }, + "merge": { + "type": "boolean" + } + } + }, + "S25": { + "type": "map", + "key": {}, + "value": {} + }, + "S2h": { + "type": "structure", + "members": { + "roleArn": {}, + "expiresInSec": { + "type": "long" + } + } + }, + "S2l": { + "type": "structure", + "members": { + "maximumPerMinute": { + "type": "integer" + }, + "exponentialRate": { + "type": "structure", + "required": [ + "baseRatePerMinute", + "incrementFactor", + "rateIncreaseCriteria" + ], + "members": { + "baseRatePerMinute": { + "type": "integer" + }, + "incrementFactor": { + "type": "double" + }, + "rateIncreaseCriteria": { + "type": "structure", + "members": { + "numberOfNotifiedThings": { + "type": "integer" + }, + "numberOfSucceededThings": { + "type": "integer" + } + } + } + } + } + } + }, + "S2s": { + "type": "structure", + "required": [ + "criteriaList" + ], + "members": { + "criteriaList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "failureType", + "action", + "thresholdPercentage", + "minNumberOfExecutedThings" + ], + "members": { + "failureType": {}, + "action": {}, + "thresholdPercentage": { + "type": "double" + }, + "minNumberOfExecutedThings": { + "type": "integer" + } + } + } + } + } + }, + "S2z": { + "type": "structure", + "members": { + "inProgressTimeoutInMinutes": { + "type": "long" + } + } + }, + "S3a": { + "type": "list", + "member": {} + }, + "S3c": { + "type": "structure", + "members": { + "maximumPerMinute": { + "type": "integer" + } + } + }, + "S3e": { + "type": "list", + "member": { + "type": "structure", + "members": { + "fileName": {}, + "fileVersion": {}, + "fileLocation": { + "type": "structure", + "members": { + "stream": { + "type": "structure", + "members": { + "streamId": {}, + "fileId": { + "type": "integer" + } + } + }, + "s3Location": { + "shape": "S3m" + } + } + }, + "codeSigning": { + "type": "structure", + "members": { + "awsSignerJobId": {}, + "startSigningJobParameter": { + "type": "structure", + "members": { + "signingProfileParameter": { + "type": "structure", + "members": { + "certificateArn": {}, + "platform": {}, + "certificatePathOnDevice": {} + } + }, + "signingProfileName": {}, + "destination": { + "type": "structure", + "members": { + "s3Destination": { + "type": "structure", + "members": { + "bucket": {}, + "prefix": {} + } + } + } + } + } + }, + "customCodeSigning": { + "type": "structure", + "members": { + "signature": { + "type": "structure", + "members": { + "inlineDocument": { + "type": "blob" + } + } + }, + "certificateChain": { + "type": "structure", + "members": { + "certificateName": {}, + "inlineDocument": {} + } + }, + "hashAlgorithm": {}, + "signatureAlgorithm": {} + } + } + } + }, + "attributes": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "S3m": { + "type": "structure", + "members": { + "bucket": {}, + "key": {}, + "version": {} + } + }, + "S4b": { + "type": "map", + "key": {}, + "value": {} + }, + "S4z": { + "type": "list", + "member": {} + }, + "S56": { + "type": "list", + "member": { + "shape": "S57" + } + }, + "S57": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "metric": {}, + "criteria": { + "type": "structure", + "members": { + "comparisonOperator": {}, + "value": { + "shape": "S5c" + }, + "durationSeconds": { + "type": "integer" + }, + "consecutiveDatapointsToAlarm": { + "type": "integer" + }, + "consecutiveDatapointsToClear": { + "type": "integer" + }, + "statisticalThreshold": { + "type": "structure", + "members": { + "statistic": {} + } + } + } + } + } + }, + "S5c": { + "type": "structure", + "members": { + "count": { + "type": "long" + }, + "cidrs": { + "type": "list", + "member": {} + }, + "ports": { + "type": "list", + "member": { + "type": "integer" + } + } + } + }, + "S5n": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "alertTargetArn", + "roleArn" + ], + "members": { + "alertTargetArn": {}, + "roleArn": {} + } + } + }, + "S5r": { + "type": "list", + "member": {} + }, + "S5w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "fileId": { + "type": "integer" + }, + "s3Location": { + "shape": "S3m" + } + } + } + }, + "S68": { + "type": "structure", + "members": { + "thingTypeDescription": {}, + "searchableAttributes": { + "type": "list", + "member": {} + } + } + }, + "S6g": { + "type": "structure", + "required": [ + "sql", + "actions" + ], + "members": { + "sql": {}, + "description": {}, + "actions": { + "shape": "S6j" + }, + "ruleDisabled": { + "type": "boolean" + }, + "awsIotSqlVersion": {}, + "errorAction": { + "shape": "S6k" + } + } + }, + "S6j": { + "type": "list", + "member": { + "shape": "S6k" + } + }, + "S6k": { + "type": "structure", + "members": { + "dynamoDB": { + "type": "structure", + "required": [ + "tableName", + "roleArn", + "hashKeyField", + "hashKeyValue" + ], + "members": { + "tableName": {}, + "roleArn": {}, + "operation": {}, + "hashKeyField": {}, + "hashKeyValue": {}, + "hashKeyType": {}, + "rangeKeyField": {}, + "rangeKeyValue": {}, + "rangeKeyType": {}, + "payloadField": {} + } + }, + "dynamoDBv2": { + "type": "structure", + "required": [ + "roleArn", + "putItem" + ], + "members": { + "roleArn": {}, + "putItem": { + "type": "structure", + "required": [ + "tableName" + ], + "members": { + "tableName": {} + } + } + } + }, + "lambda": { + "type": "structure", + "required": [ + "functionArn" + ], + "members": { + "functionArn": {} + } + }, + "sns": { + "type": "structure", + "required": [ + "targetArn", + "roleArn" + ], + "members": { + "targetArn": {}, + "roleArn": {}, + "messageFormat": {} + } + }, + "sqs": { + "type": "structure", + "required": [ + "roleArn", + "queueUrl" + ], + "members": { + "roleArn": {}, + "queueUrl": {}, + "useBase64": { + "type": "boolean" + } + } + }, + "kinesis": { + "type": "structure", + "required": [ + "roleArn", + "streamName" + ], + "members": { + "roleArn": {}, + "streamName": {}, + "partitionKey": {} + } + }, + "republish": { + "type": "structure", + "required": [ + "roleArn", + "topic" + ], + "members": { + "roleArn": {}, + "topic": {} + } + }, + "s3": { + "type": "structure", + "required": [ + "roleArn", + "bucketName", + "key" + ], + "members": { + "roleArn": {}, + "bucketName": {}, + "key": {}, + "cannedAcl": {} + } + }, + "firehose": { + "type": "structure", + "required": [ + "roleArn", + "deliveryStreamName" + ], + "members": { + "roleArn": {}, + "deliveryStreamName": {}, + "separator": {} + } + }, + "cloudwatchMetric": { + "type": "structure", + "required": [ + "roleArn", + "metricNamespace", + "metricName", + "metricValue", + "metricUnit" + ], + "members": { + "roleArn": {}, + "metricNamespace": {}, + "metricName": {}, + "metricValue": {}, + "metricUnit": {}, + "metricTimestamp": {} + } + }, + "cloudwatchAlarm": { + "type": "structure", + "required": [ + "roleArn", + "alarmName", + "stateReason", + "stateValue" + ], + "members": { + "roleArn": {}, + "alarmName": {}, + "stateReason": {}, + "stateValue": {} + } + }, + "elasticsearch": { + "type": "structure", + "required": [ + "roleArn", + "endpoint", + "index", + "type", + "id" + ], + "members": { + "roleArn": {}, + "endpoint": {}, + "index": {}, + "type": {}, + "id": {} + } + }, + "salesforce": { + "type": "structure", + "required": [ + "token", + "url" + ], + "members": { + "token": {}, + "url": {} + } + }, + "iotAnalytics": { + "type": "structure", + "members": { + "channelArn": {}, + "channelName": {}, + "roleArn": {} + } + }, + "iotEvents": { + "type": "structure", + "required": [ + "inputName", + "roleArn" + ], + "members": { + "inputName": {}, + "messageId": {}, + "roleArn": {} + } + }, + "stepFunctions": { + "type": "structure", + "required": [ + "stateMachineName", + "roleArn" + ], + "members": { + "executionNamePrefix": {}, + "stateMachineName": {}, + "roleArn": {} + } + } + } + }, + "S9g": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "targetArn": {}, + "roleArn": {}, + "enabled": { + "type": "boolean" + } + } + } + }, + "S9k": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "enabled": { + "type": "boolean" + } + } + } + }, + "Sa9": { + "type": "structure", + "members": { + "authorizerName": {}, + "authorizerArn": {}, + "authorizerFunctionArn": {}, + "tokenKeyName": {}, + "tokenSigningPublicKeys": { + "shape": "S1h" + }, + "status": {}, + "creationDate": { + "type": "timestamp" + }, + "lastModifiedDate": { + "type": "timestamp" + } + } + }, + "Sao": { + "type": "structure", + "members": { + "notBefore": { + "type": "timestamp" + }, + "notAfter": { + "type": "timestamp" + } + } + }, + "Sap": { + "type": "structure", + "members": { + "templateBody": {}, + "roleArn": {} + } + }, + "Sb5": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + } + }, + "Scg": { + "type": "list", + "member": { + "shape": "Sch" + } + }, + "Sch": { + "type": "structure", + "members": { + "groupName": {}, + "groupArn": {} + } + }, + "Sct": { + "type": "structure", + "members": { + "deprecated": { + "type": "boolean" + }, + "deprecationDate": { + "type": "timestamp" + }, + "creationDate": { + "type": "timestamp" + } + } + }, + "Sdb": { + "type": "structure", + "required": [ + "thingIndexingMode" + ], + "members": { + "thingIndexingMode": {}, + "thingConnectivityIndexingMode": {} + } + }, + "Sde": { + "type": "structure", + "required": [ + "thingGroupIndexingMode" + ], + "members": { + "thingGroupIndexingMode": {} + } + }, + "Sem": { + "type": "list", + "member": { + "type": "structure", + "members": { + "policyName": {}, + "policyArn": {} + } + } + }, + "Sep": { + "type": "structure", + "members": { + "deviceCertificateId": {}, + "caCertificateId": {}, + "cognitoIdentityPoolId": {}, + "clientId": {}, + "policyVersionIdentifier": { + "type": "structure", + "members": { + "policyName": {}, + "policyVersionId": {} + } + }, + "account": {} + } + }, + "Sex": { + "type": "map", + "key": {}, + "value": {} + }, + "Sfl": { + "type": "list", + "member": { + "type": "structure", + "members": { + "certificateArn": {}, + "certificateId": {}, + "status": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "Sfy": { + "type": "structure", + "members": { + "status": {}, + "queuedAt": { + "type": "timestamp" + }, + "startedAt": { + "type": "timestamp" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "executionNumber": { + "type": "long" + } + } + }, + "Sgj": { + "type": "list", + "member": {} + }, + "Sgt": { + "type": "list", + "member": {} + }, + "Sh4": { + "type": "structure", + "required": [ + "name", + "arn" + ], + "members": { + "name": {}, + "arn": {} + } + }, + "Sh9": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "Sip": { + "type": "structure", + "required": [ + "targetType" + ], + "members": { + "targetType": {}, + "targetName": {} + } + }, + "Sjh": { + "type": "list", + "member": {} + }, + "Sk4": { + "type": "structure", + "members": { + "actionType": {}, + "resources": { + "type": "list", + "member": {} + } + } + }, + "Sk8": { + "type": "list", + "member": {} + }, + "Slt": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iot-2015-05-28.paginators.json b/node_modules/aws-sdk/apis/iot-2015-05-28.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/iot-2015-05-28.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/iot-data-2015-05-28.min.json b/node_modules/aws-sdk/apis/iot-data-2015-05-28.min.json new file mode 100644 index 0000000..f22f0a1 --- /dev/null +++ b/node_modules/aws-sdk/apis/iot-data-2015-05-28.min.json @@ -0,0 +1,130 @@ +{ + "version": "2.0", + "metadata": { + "uid": "iot-data-2015-05-28", + "apiVersion": "2015-05-28", + "endpointPrefix": "data.iot", + "protocol": "rest-json", + "serviceFullName": "AWS IoT Data Plane", + "serviceId": "IoT Data Plane", + "signatureVersion": "v4", + "signingName": "iotdata" + }, + "operations": { + "DeleteThingShadow": { + "http": { + "method": "DELETE", + "requestUri": "/things/{thingName}/shadow" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "payload" + ], + "members": { + "payload": { + "type": "blob" + } + }, + "payload": "payload" + } + }, + "GetThingShadow": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}/shadow" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + } + } + }, + "output": { + "type": "structure", + "members": { + "payload": { + "type": "blob" + } + }, + "payload": "payload" + } + }, + "Publish": { + "http": { + "requestUri": "/topics/{topic}" + }, + "input": { + "type": "structure", + "required": [ + "topic" + ], + "members": { + "topic": { + "location": "uri", + "locationName": "topic" + }, + "qos": { + "location": "querystring", + "locationName": "qos", + "type": "integer" + }, + "payload": { + "type": "blob" + } + }, + "payload": "payload" + } + }, + "UpdateThingShadow": { + "http": { + "requestUri": "/things/{thingName}/shadow" + }, + "input": { + "type": "structure", + "required": [ + "thingName", + "payload" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "payload": { + "type": "blob" + } + }, + "payload": "payload" + }, + "output": { + "type": "structure", + "members": { + "payload": { + "type": "blob" + } + }, + "payload": "payload" + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.examples.json b/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.min.json b/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.min.json new file mode 100644 index 0000000..f28f070 --- /dev/null +++ b/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.min.json @@ -0,0 +1,238 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-09-29", + "endpointPrefix": "data.jobs.iot", + "protocol": "rest-json", + "serviceFullName": "AWS IoT Jobs Data Plane", + "serviceId": "IoT Jobs Data Plane", + "signatureVersion": "v4", + "signingName": "iot-jobs-data", + "uid": "iot-jobs-data-2017-09-29" + }, + "operations": { + "DescribeJobExecution": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "thingName" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "includeJobDocument": { + "location": "querystring", + "locationName": "includeJobDocument", + "type": "boolean" + }, + "executionNumber": { + "location": "querystring", + "locationName": "executionNumber", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "execution": { + "shape": "S7" + } + } + } + }, + "GetPendingJobExecutions": { + "http": { + "method": "GET", + "requestUri": "/things/{thingName}/jobs" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + } + } + }, + "output": { + "type": "structure", + "members": { + "inProgressJobs": { + "shape": "Sl" + }, + "queuedJobs": { + "shape": "Sl" + } + } + } + }, + "StartNextPendingJobExecution": { + "http": { + "method": "PUT", + "requestUri": "/things/{thingName}/jobs/$next" + }, + "input": { + "type": "structure", + "required": [ + "thingName" + ], + "members": { + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "statusDetails": { + "shape": "Sa" + }, + "stepTimeoutInMinutes": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "execution": { + "shape": "S7" + } + } + } + }, + "UpdateJobExecution": { + "http": { + "requestUri": "/things/{thingName}/jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId", + "thingName", + "status" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "thingName": { + "location": "uri", + "locationName": "thingName" + }, + "status": {}, + "statusDetails": { + "shape": "Sa" + }, + "stepTimeoutInMinutes": { + "type": "long" + }, + "expectedVersion": { + "type": "long" + }, + "includeJobExecutionState": { + "type": "boolean" + }, + "includeJobDocument": { + "type": "boolean" + }, + "executionNumber": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "executionState": { + "type": "structure", + "members": { + "status": {}, + "statusDetails": { + "shape": "Sa" + }, + "versionNumber": { + "type": "long" + } + } + }, + "jobDocument": {} + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "jobId": {}, + "thingName": {}, + "status": {}, + "statusDetails": { + "shape": "Sa" + }, + "queuedAt": { + "type": "long" + }, + "startedAt": { + "type": "long" + }, + "lastUpdatedAt": { + "type": "long" + }, + "approximateSecondsBeforeTimedOut": { + "type": "long" + }, + "versionNumber": { + "type": "long" + }, + "executionNumber": { + "type": "long" + }, + "jobDocument": {} + } + }, + "Sa": { + "type": "map", + "key": {}, + "value": {} + }, + "Sl": { + "type": "list", + "member": { + "type": "structure", + "members": { + "jobId": {}, + "queuedAt": { + "type": "long" + }, + "startedAt": { + "type": "long" + }, + "lastUpdatedAt": { + "type": "long" + }, + "versionNumber": { + "type": "long" + }, + "executionNumber": { + "type": "long" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.paginators.json b/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/iot-jobs-data-2017-09-29.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/iot1click-devices-2018-05-14.min.json b/node_modules/aws-sdk/apis/iot1click-devices-2018-05-14.min.json new file mode 100644 index 0000000..097623d --- /dev/null +++ b/node_modules/aws-sdk/apis/iot1click-devices-2018-05-14.min.json @@ -0,0 +1,498 @@ +{ + "metadata": { + "apiVersion": "2018-05-14", + "endpointPrefix": "devices.iot1click", + "signingName": "iot1click", + "serviceFullName": "AWS IoT 1-Click Devices Service", + "serviceId": "IoT 1Click Devices Service", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "devices-2018-05-14", + "signatureVersion": "v4" + }, + "operations": { + "ClaimDevicesByClaimCode": { + "http": { + "method": "PUT", + "requestUri": "/claims/{claimCode}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ClaimCode": { + "location": "uri", + "locationName": "claimCode" + } + }, + "required": [ + "ClaimCode" + ] + }, + "output": { + "type": "structure", + "members": { + "ClaimCode": { + "locationName": "claimCode" + }, + "Total": { + "locationName": "total", + "type": "integer" + } + } + } + }, + "DescribeDevice": { + "http": { + "method": "GET", + "requestUri": "/devices/{deviceId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + } + }, + "required": [ + "DeviceId" + ] + }, + "output": { + "type": "structure", + "members": { + "DeviceDescription": { + "shape": "S8", + "locationName": "deviceDescription" + } + } + } + }, + "FinalizeDeviceClaim": { + "http": { + "method": "PUT", + "requestUri": "/devices/{deviceId}/finalize-claim", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + }, + "required": [ + "DeviceId" + ] + }, + "output": { + "type": "structure", + "members": { + "State": { + "locationName": "state" + } + } + } + }, + "GetDeviceMethods": { + "http": { + "method": "GET", + "requestUri": "/devices/{deviceId}/methods", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + } + }, + "required": [ + "DeviceId" + ] + }, + "output": { + "type": "structure", + "members": { + "DeviceMethods": { + "locationName": "deviceMethods", + "type": "list", + "member": { + "shape": "Si" + } + } + } + } + }, + "InitiateDeviceClaim": { + "http": { + "method": "PUT", + "requestUri": "/devices/{deviceId}/initiate-claim", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + } + }, + "required": [ + "DeviceId" + ] + }, + "output": { + "type": "structure", + "members": { + "State": { + "locationName": "state" + } + } + } + }, + "InvokeDeviceMethod": { + "http": { + "requestUri": "/devices/{deviceId}/methods", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + }, + "DeviceMethod": { + "shape": "Si", + "locationName": "deviceMethod" + }, + "DeviceMethodParameters": { + "locationName": "deviceMethodParameters" + } + }, + "required": [ + "DeviceId" + ] + }, + "output": { + "type": "structure", + "members": { + "DeviceMethodResponse": { + "locationName": "deviceMethodResponse" + } + } + } + }, + "ListDeviceEvents": { + "http": { + "method": "GET", + "requestUri": "/devices/{deviceId}/events", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + }, + "FromTimeStamp": { + "shape": "So", + "location": "querystring", + "locationName": "fromTimeStamp" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "ToTimeStamp": { + "shape": "So", + "location": "querystring", + "locationName": "toTimeStamp" + } + }, + "required": [ + "DeviceId", + "FromTimeStamp", + "ToTimeStamp" + ] + }, + "output": { + "type": "structure", + "members": { + "Events": { + "locationName": "events", + "type": "list", + "member": { + "type": "structure", + "members": { + "Device": { + "locationName": "device", + "type": "structure", + "members": { + "Attributes": { + "locationName": "attributes", + "type": "structure", + "members": {} + }, + "DeviceId": { + "locationName": "deviceId" + }, + "Type": { + "locationName": "type" + } + } + }, + "StdEvent": { + "locationName": "stdEvent" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListDevices": { + "http": { + "method": "GET", + "requestUri": "/devices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceType": { + "location": "querystring", + "locationName": "deviceType" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Devices": { + "locationName": "devices", + "type": "list", + "member": { + "shape": "S8" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + }, + "required": [ + "ResourceArn", + "Tags" + ] + } + }, + "UnclaimDevice": { + "http": { + "method": "PUT", + "requestUri": "/devices/{deviceId}/unclaim", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + } + }, + "required": [ + "DeviceId" + ] + }, + "output": { + "type": "structure", + "members": { + "State": { + "locationName": "state" + } + } + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "type": "list", + "member": {} + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + } + }, + "UpdateDeviceState": { + "http": { + "method": "PUT", + "requestUri": "/devices/{deviceId}/state", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + }, + "Enabled": { + "locationName": "enabled", + "type": "boolean" + } + }, + "required": [ + "DeviceId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S8": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Attributes": { + "locationName": "attributes", + "type": "map", + "key": {}, + "value": {} + }, + "DeviceId": { + "locationName": "deviceId" + }, + "Enabled": { + "locationName": "enabled", + "type": "boolean" + }, + "RemainingLife": { + "locationName": "remainingLife", + "type": "double" + }, + "Type": { + "locationName": "type" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + } + }, + "Sc": { + "type": "map", + "key": {}, + "value": {} + }, + "Si": { + "type": "structure", + "members": { + "DeviceType": { + "locationName": "deviceType" + }, + "MethodName": { + "locationName": "methodName" + } + } + }, + "So": { + "type": "timestamp", + "timestampFormat": "iso8601" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.examples.json b/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.min.json b/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.min.json new file mode 100644 index 0000000..0fd8f61 --- /dev/null +++ b/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.min.json @@ -0,0 +1,608 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-05-14", + "endpointPrefix": "projects.iot1click", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "AWS IoT 1-Click Projects", + "serviceFullName": "AWS IoT 1-Click Projects Service", + "serviceId": "IoT 1Click Projects", + "signatureVersion": "v4", + "signingName": "iot1click", + "uid": "iot1click-projects-2018-05-14" + }, + "operations": { + "AssociateDeviceWithPlacement": { + "http": { + "method": "PUT", + "requestUri": "/projects/{projectName}/placements/{placementName}/devices/{deviceTemplateName}" + }, + "input": { + "type": "structure", + "required": [ + "projectName", + "placementName", + "deviceId", + "deviceTemplateName" + ], + "members": { + "projectName": { + "location": "uri", + "locationName": "projectName" + }, + "placementName": { + "location": "uri", + "locationName": "placementName" + }, + "deviceId": {}, + "deviceTemplateName": { + "location": "uri", + "locationName": "deviceTemplateName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreatePlacement": { + "http": { + "requestUri": "/projects/{projectName}/placements" + }, + "input": { + "type": "structure", + "required": [ + "placementName", + "projectName" + ], + "members": { + "placementName": {}, + "projectName": { + "location": "uri", + "locationName": "projectName" + }, + "attributes": { + "shape": "S8" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateProject": { + "http": { + "requestUri": "/projects" + }, + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": {}, + "description": {}, + "placementTemplate": { + "shape": "Se" + }, + "tags": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePlacement": { + "http": { + "method": "DELETE", + "requestUri": "/projects/{projectName}/placements/{placementName}" + }, + "input": { + "type": "structure", + "required": [ + "placementName", + "projectName" + ], + "members": { + "placementName": { + "location": "uri", + "locationName": "placementName" + }, + "projectName": { + "location": "uri", + "locationName": "projectName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteProject": { + "http": { + "method": "DELETE", + "requestUri": "/projects/{projectName}" + }, + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": { + "location": "uri", + "locationName": "projectName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribePlacement": { + "http": { + "method": "GET", + "requestUri": "/projects/{projectName}/placements/{placementName}" + }, + "input": { + "type": "structure", + "required": [ + "placementName", + "projectName" + ], + "members": { + "placementName": { + "location": "uri", + "locationName": "placementName" + }, + "projectName": { + "location": "uri", + "locationName": "projectName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "placement" + ], + "members": { + "placement": { + "type": "structure", + "required": [ + "projectName", + "placementName", + "attributes", + "createdDate", + "updatedDate" + ], + "members": { + "projectName": {}, + "placementName": {}, + "attributes": { + "shape": "S8" + }, + "createdDate": { + "type": "timestamp" + }, + "updatedDate": { + "type": "timestamp" + } + } + } + } + } + }, + "DescribeProject": { + "http": { + "method": "GET", + "requestUri": "/projects/{projectName}" + }, + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": { + "location": "uri", + "locationName": "projectName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "project" + ], + "members": { + "project": { + "type": "structure", + "required": [ + "projectName", + "createdDate", + "updatedDate" + ], + "members": { + "arn": {}, + "projectName": {}, + "description": {}, + "createdDate": { + "type": "timestamp" + }, + "updatedDate": { + "type": "timestamp" + }, + "placementTemplate": { + "shape": "Se" + }, + "tags": { + "shape": "Sn" + } + } + } + } + } + }, + "DisassociateDeviceFromPlacement": { + "http": { + "method": "DELETE", + "requestUri": "/projects/{projectName}/placements/{placementName}/devices/{deviceTemplateName}" + }, + "input": { + "type": "structure", + "required": [ + "projectName", + "placementName", + "deviceTemplateName" + ], + "members": { + "projectName": { + "location": "uri", + "locationName": "projectName" + }, + "placementName": { + "location": "uri", + "locationName": "placementName" + }, + "deviceTemplateName": { + "location": "uri", + "locationName": "deviceTemplateName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetDevicesInPlacement": { + "http": { + "method": "GET", + "requestUri": "/projects/{projectName}/placements/{placementName}/devices" + }, + "input": { + "type": "structure", + "required": [ + "projectName", + "placementName" + ], + "members": { + "projectName": { + "location": "uri", + "locationName": "projectName" + }, + "placementName": { + "location": "uri", + "locationName": "placementName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "devices" + ], + "members": { + "devices": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "ListPlacements": { + "http": { + "method": "GET", + "requestUri": "/projects/{projectName}/placements" + }, + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": { + "location": "uri", + "locationName": "projectName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "placements" + ], + "members": { + "placements": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "projectName", + "placementName", + "createdDate", + "updatedDate" + ], + "members": { + "projectName": {}, + "placementName": {}, + "createdDate": { + "type": "timestamp" + }, + "updatedDate": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListProjects": { + "http": { + "method": "GET", + "requestUri": "/projects" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "projects" + ], + "members": { + "projects": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "projectName", + "createdDate", + "updatedDate" + ], + "members": { + "arn": {}, + "projectName": {}, + "createdDate": { + "type": "timestamp" + }, + "updatedDate": { + "type": "timestamp" + }, + "tags": { + "shape": "Sn" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Sn" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "tags": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "tagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdatePlacement": { + "http": { + "method": "PUT", + "requestUri": "/projects/{projectName}/placements/{placementName}" + }, + "input": { + "type": "structure", + "required": [ + "placementName", + "projectName" + ], + "members": { + "placementName": { + "location": "uri", + "locationName": "placementName" + }, + "projectName": { + "location": "uri", + "locationName": "projectName" + }, + "attributes": { + "shape": "S8" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateProject": { + "http": { + "method": "PUT", + "requestUri": "/projects/{projectName}" + }, + "input": { + "type": "structure", + "required": [ + "projectName" + ], + "members": { + "projectName": { + "location": "uri", + "locationName": "projectName" + }, + "description": {}, + "placementTemplate": { + "shape": "Se" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S8": { + "type": "map", + "key": {}, + "value": {} + }, + "Se": { + "type": "structure", + "members": { + "defaultAttributes": { + "type": "map", + "key": {}, + "value": {} + }, + "deviceTemplates": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "deviceType": {}, + "callbackOverrides": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + }, + "Sn": { + "type": "map", + "key": {}, + "value": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.paginators.json b/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/iot1click-projects-2018-05-14.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.examples.json b/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.min.json b/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.min.json new file mode 100644 index 0000000..9be70c3 --- /dev/null +++ b/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.min.json @@ -0,0 +1,1543 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-11-27", + "endpointPrefix": "iotanalytics", + "protocol": "rest-json", + "serviceFullName": "AWS IoT Analytics", + "serviceId": "IoTAnalytics", + "signatureVersion": "v4", + "signingName": "iotanalytics", + "uid": "iotanalytics-2017-11-27" + }, + "operations": { + "BatchPutMessage": { + "http": { + "requestUri": "/messages/batch", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "channelName", + "messages" + ], + "members": { + "channelName": {}, + "messages": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "messageId", + "payload" + ], + "members": { + "messageId": {}, + "payload": { + "type": "blob" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "batchPutMessageErrorEntries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "messageId": {}, + "errorCode": {}, + "errorMessage": {} + } + } + } + } + } + }, + "CancelPipelineReprocessing": { + "http": { + "method": "DELETE", + "requestUri": "/pipelines/{pipelineName}/reprocessing/{reprocessingId}" + }, + "input": { + "type": "structure", + "required": [ + "pipelineName", + "reprocessingId" + ], + "members": { + "pipelineName": { + "location": "uri", + "locationName": "pipelineName" + }, + "reprocessingId": { + "location": "uri", + "locationName": "reprocessingId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateChannel": { + "http": { + "requestUri": "/channels", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "channelName" + ], + "members": { + "channelName": {}, + "retentionPeriod": { + "shape": "Sh" + }, + "tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "channelName": {}, + "channelArn": {}, + "retentionPeriod": { + "shape": "Sh" + } + } + } + }, + "CreateDataset": { + "http": { + "requestUri": "/datasets", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "datasetName", + "actions" + ], + "members": { + "datasetName": {}, + "actions": { + "shape": "Ss" + }, + "triggers": { + "shape": "S1g" + }, + "contentDeliveryRules": { + "shape": "S1l" + }, + "retentionPeriod": { + "shape": "Sh" + }, + "versioningConfiguration": { + "shape": "S1r" + }, + "tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "datasetName": {}, + "datasetArn": {}, + "retentionPeriod": { + "shape": "Sh" + } + } + } + }, + "CreateDatasetContent": { + "http": { + "requestUri": "/datasets/{datasetName}/content" + }, + "input": { + "type": "structure", + "required": [ + "datasetName" + ], + "members": { + "datasetName": { + "location": "uri", + "locationName": "datasetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "versionId": {} + } + } + }, + "CreateDatastore": { + "http": { + "requestUri": "/datastores", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "datastoreName" + ], + "members": { + "datastoreName": {}, + "retentionPeriod": { + "shape": "Sh" + }, + "tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "datastoreName": {}, + "datastoreArn": {}, + "retentionPeriod": { + "shape": "Sh" + } + } + } + }, + "CreatePipeline": { + "http": { + "requestUri": "/pipelines", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "pipelineName", + "pipelineActivities" + ], + "members": { + "pipelineName": {}, + "pipelineActivities": { + "shape": "S24" + }, + "tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "pipelineName": {}, + "pipelineArn": {} + } + } + }, + "DeleteChannel": { + "http": { + "method": "DELETE", + "requestUri": "/channels/{channelName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "channelName" + ], + "members": { + "channelName": { + "location": "uri", + "locationName": "channelName" + } + } + } + }, + "DeleteDataset": { + "http": { + "method": "DELETE", + "requestUri": "/datasets/{datasetName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "datasetName" + ], + "members": { + "datasetName": { + "location": "uri", + "locationName": "datasetName" + } + } + } + }, + "DeleteDatasetContent": { + "http": { + "method": "DELETE", + "requestUri": "/datasets/{datasetName}/content", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "datasetName" + ], + "members": { + "datasetName": { + "location": "uri", + "locationName": "datasetName" + }, + "versionId": { + "location": "querystring", + "locationName": "versionId" + } + } + } + }, + "DeleteDatastore": { + "http": { + "method": "DELETE", + "requestUri": "/datastores/{datastoreName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "datastoreName" + ], + "members": { + "datastoreName": { + "location": "uri", + "locationName": "datastoreName" + } + } + } + }, + "DeletePipeline": { + "http": { + "method": "DELETE", + "requestUri": "/pipelines/{pipelineName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "pipelineName" + ], + "members": { + "pipelineName": { + "location": "uri", + "locationName": "pipelineName" + } + } + } + }, + "DescribeChannel": { + "http": { + "method": "GET", + "requestUri": "/channels/{channelName}" + }, + "input": { + "type": "structure", + "required": [ + "channelName" + ], + "members": { + "channelName": { + "location": "uri", + "locationName": "channelName" + }, + "includeStatistics": { + "location": "querystring", + "locationName": "includeStatistics", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "channel": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "status": {}, + "retentionPeriod": { + "shape": "Sh" + }, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + } + } + }, + "statistics": { + "type": "structure", + "members": { + "size": { + "shape": "S32" + } + } + } + } + } + }, + "DescribeDataset": { + "http": { + "method": "GET", + "requestUri": "/datasets/{datasetName}" + }, + "input": { + "type": "structure", + "required": [ + "datasetName" + ], + "members": { + "datasetName": { + "location": "uri", + "locationName": "datasetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "dataset": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "actions": { + "shape": "Ss" + }, + "triggers": { + "shape": "S1g" + }, + "contentDeliveryRules": { + "shape": "S1l" + }, + "status": {}, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + }, + "retentionPeriod": { + "shape": "Sh" + }, + "versioningConfiguration": { + "shape": "S1r" + } + } + } + } + } + }, + "DescribeDatastore": { + "http": { + "method": "GET", + "requestUri": "/datastores/{datastoreName}" + }, + "input": { + "type": "structure", + "required": [ + "datastoreName" + ], + "members": { + "datastoreName": { + "location": "uri", + "locationName": "datastoreName" + }, + "includeStatistics": { + "location": "querystring", + "locationName": "includeStatistics", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "datastore": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "status": {}, + "retentionPeriod": { + "shape": "Sh" + }, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + } + } + }, + "statistics": { + "type": "structure", + "members": { + "size": { + "shape": "S32" + } + } + } + } + } + }, + "DescribeLoggingOptions": { + "http": { + "method": "GET", + "requestUri": "/logging" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "loggingOptions": { + "shape": "S3f" + } + } + } + }, + "DescribePipeline": { + "http": { + "method": "GET", + "requestUri": "/pipelines/{pipelineName}" + }, + "input": { + "type": "structure", + "required": [ + "pipelineName" + ], + "members": { + "pipelineName": { + "location": "uri", + "locationName": "pipelineName" + } + } + }, + "output": { + "type": "structure", + "members": { + "pipeline": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "activities": { + "shape": "S24" + }, + "reprocessingSummaries": { + "shape": "S3l" + }, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + } + } + } + } + } + }, + "GetDatasetContent": { + "http": { + "method": "GET", + "requestUri": "/datasets/{datasetName}/content" + }, + "input": { + "type": "structure", + "required": [ + "datasetName" + ], + "members": { + "datasetName": { + "location": "uri", + "locationName": "datasetName" + }, + "versionId": { + "location": "querystring", + "locationName": "versionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "entries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "entryName": {}, + "dataURI": {} + } + } + }, + "timestamp": { + "type": "timestamp" + }, + "status": { + "shape": "S3t" + } + } + } + }, + "ListChannels": { + "http": { + "method": "GET", + "requestUri": "/channels" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "channelSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "channelName": {}, + "status": {}, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListDatasetContents": { + "http": { + "method": "GET", + "requestUri": "/datasets/{datasetName}/contents" + }, + "input": { + "type": "structure", + "required": [ + "datasetName" + ], + "members": { + "datasetName": { + "location": "uri", + "locationName": "datasetName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "scheduledOnOrAfter": { + "location": "querystring", + "locationName": "scheduledOnOrAfter", + "type": "timestamp" + }, + "scheduledBefore": { + "location": "querystring", + "locationName": "scheduledBefore", + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "datasetContentSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "version": {}, + "status": { + "shape": "S3t" + }, + "creationTime": { + "type": "timestamp" + }, + "scheduleTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListDatasets": { + "http": { + "method": "GET", + "requestUri": "/datasets" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "datasetSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "datasetName": {}, + "status": {}, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + }, + "triggers": { + "shape": "S1g" + }, + "actions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "actionName": {}, + "actionType": {} + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "ListDatastores": { + "http": { + "method": "GET", + "requestUri": "/datastores" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "datastoreSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "datastoreName": {}, + "status": {}, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListPipelines": { + "http": { + "method": "GET", + "requestUri": "/pipelines" + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "pipelineSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "pipelineName": {}, + "reprocessingSummaries": { + "shape": "S3l" + }, + "creationTime": { + "type": "timestamp" + }, + "lastUpdateTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "location": "querystring", + "locationName": "resourceArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Sk" + } + } + } + }, + "PutLoggingOptions": { + "http": { + "method": "PUT", + "requestUri": "/logging" + }, + "input": { + "type": "structure", + "required": [ + "loggingOptions" + ], + "members": { + "loggingOptions": { + "shape": "S3f" + } + } + } + }, + "RunPipelineActivity": { + "http": { + "requestUri": "/pipelineactivities/run" + }, + "input": { + "type": "structure", + "required": [ + "pipelineActivity", + "payloads" + ], + "members": { + "pipelineActivity": { + "shape": "S25" + }, + "payloads": { + "shape": "S4q" + } + } + }, + "output": { + "type": "structure", + "members": { + "payloads": { + "shape": "S4q" + }, + "logResult": {} + } + } + }, + "SampleChannelData": { + "http": { + "method": "GET", + "requestUri": "/channels/{channelName}/sample" + }, + "input": { + "type": "structure", + "required": [ + "channelName" + ], + "members": { + "channelName": { + "location": "uri", + "locationName": "channelName" + }, + "maxMessages": { + "location": "querystring", + "locationName": "maxMessages", + "type": "integer" + }, + "startTime": { + "location": "querystring", + "locationName": "startTime", + "type": "timestamp" + }, + "endTime": { + "location": "querystring", + "locationName": "endTime", + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "payloads": { + "shape": "S4q" + } + } + } + }, + "StartPipelineReprocessing": { + "http": { + "requestUri": "/pipelines/{pipelineName}/reprocessing" + }, + "input": { + "type": "structure", + "required": [ + "pipelineName" + ], + "members": { + "pipelineName": { + "location": "uri", + "locationName": "pipelineName" + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "reprocessingId": {} + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": { + "location": "querystring", + "locationName": "resourceArn" + }, + "tags": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "location": "querystring", + "locationName": "resourceArn" + }, + "tagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateChannel": { + "http": { + "method": "PUT", + "requestUri": "/channels/{channelName}" + }, + "input": { + "type": "structure", + "required": [ + "channelName" + ], + "members": { + "channelName": { + "location": "uri", + "locationName": "channelName" + }, + "retentionPeriod": { + "shape": "Sh" + } + } + } + }, + "UpdateDataset": { + "http": { + "method": "PUT", + "requestUri": "/datasets/{datasetName}" + }, + "input": { + "type": "structure", + "required": [ + "datasetName", + "actions" + ], + "members": { + "datasetName": { + "location": "uri", + "locationName": "datasetName" + }, + "actions": { + "shape": "Ss" + }, + "triggers": { + "shape": "S1g" + }, + "contentDeliveryRules": { + "shape": "S1l" + }, + "retentionPeriod": { + "shape": "Sh" + }, + "versioningConfiguration": { + "shape": "S1r" + } + } + } + }, + "UpdateDatastore": { + "http": { + "method": "PUT", + "requestUri": "/datastores/{datastoreName}" + }, + "input": { + "type": "structure", + "required": [ + "datastoreName" + ], + "members": { + "datastoreName": { + "location": "uri", + "locationName": "datastoreName" + }, + "retentionPeriod": { + "shape": "Sh" + } + } + } + }, + "UpdatePipeline": { + "http": { + "method": "PUT", + "requestUri": "/pipelines/{pipelineName}" + }, + "input": { + "type": "structure", + "required": [ + "pipelineName", + "pipelineActivities" + ], + "members": { + "pipelineName": { + "location": "uri", + "locationName": "pipelineName" + }, + "pipelineActivities": { + "shape": "S24" + } + } + } + } + }, + "shapes": { + "Sh": { + "type": "structure", + "members": { + "unlimited": { + "type": "boolean" + }, + "numberOfDays": { + "type": "integer" + } + } + }, + "Sk": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "members": { + "actionName": {}, + "queryAction": { + "type": "structure", + "required": [ + "sqlQuery" + ], + "members": { + "sqlQuery": {}, + "filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "deltaTime": { + "type": "structure", + "required": [ + "offsetSeconds", + "timeExpression" + ], + "members": { + "offsetSeconds": { + "type": "integer" + }, + "timeExpression": {} + } + } + } + } + } + } + }, + "containerAction": { + "type": "structure", + "required": [ + "image", + "executionRoleArn", + "resourceConfiguration" + ], + "members": { + "image": {}, + "executionRoleArn": {}, + "resourceConfiguration": { + "type": "structure", + "required": [ + "computeType", + "volumeSizeInGB" + ], + "members": { + "computeType": {}, + "volumeSizeInGB": { + "type": "integer" + } + } + }, + "variables": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "stringValue": {}, + "doubleValue": { + "type": "double" + }, + "datasetContentVersionValue": { + "type": "structure", + "required": [ + "datasetName" + ], + "members": { + "datasetName": {} + } + }, + "outputFileUriValue": { + "type": "structure", + "required": [ + "fileName" + ], + "members": { + "fileName": {} + } + } + } + } + } + } + } + } + } + }, + "S1g": { + "type": "list", + "member": { + "type": "structure", + "members": { + "schedule": { + "type": "structure", + "members": { + "expression": {} + } + }, + "dataset": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + } + } + } + }, + "S1l": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "destination" + ], + "members": { + "entryName": {}, + "destination": { + "type": "structure", + "members": { + "iotEventsDestinationConfiguration": { + "type": "structure", + "required": [ + "inputName", + "roleArn" + ], + "members": { + "inputName": {}, + "roleArn": {} + } + } + } + } + } + } + }, + "S1r": { + "type": "structure", + "members": { + "unlimited": { + "type": "boolean" + }, + "maxVersions": { + "type": "integer" + } + } + }, + "S24": { + "type": "list", + "member": { + "shape": "S25" + } + }, + "S25": { + "type": "structure", + "members": { + "channel": { + "type": "structure", + "required": [ + "name", + "channelName" + ], + "members": { + "name": {}, + "channelName": {}, + "next": {} + } + }, + "lambda": { + "type": "structure", + "required": [ + "name", + "lambdaName", + "batchSize" + ], + "members": { + "name": {}, + "lambdaName": {}, + "batchSize": { + "type": "integer" + }, + "next": {} + } + }, + "datastore": { + "type": "structure", + "required": [ + "name", + "datastoreName" + ], + "members": { + "name": {}, + "datastoreName": {} + } + }, + "addAttributes": { + "type": "structure", + "required": [ + "name", + "attributes" + ], + "members": { + "name": {}, + "attributes": { + "type": "map", + "key": {}, + "value": {} + }, + "next": {} + } + }, + "removeAttributes": { + "type": "structure", + "required": [ + "name", + "attributes" + ], + "members": { + "name": {}, + "attributes": { + "shape": "S2g" + }, + "next": {} + } + }, + "selectAttributes": { + "type": "structure", + "required": [ + "name", + "attributes" + ], + "members": { + "name": {}, + "attributes": { + "shape": "S2g" + }, + "next": {} + } + }, + "filter": { + "type": "structure", + "required": [ + "name", + "filter" + ], + "members": { + "name": {}, + "filter": {}, + "next": {} + } + }, + "math": { + "type": "structure", + "required": [ + "name", + "attribute", + "math" + ], + "members": { + "name": {}, + "attribute": {}, + "math": {}, + "next": {} + } + }, + "deviceRegistryEnrich": { + "type": "structure", + "required": [ + "name", + "attribute", + "thingName", + "roleArn" + ], + "members": { + "name": {}, + "attribute": {}, + "thingName": {}, + "roleArn": {}, + "next": {} + } + }, + "deviceShadowEnrich": { + "type": "structure", + "required": [ + "name", + "attribute", + "thingName", + "roleArn" + ], + "members": { + "name": {}, + "attribute": {}, + "thingName": {}, + "roleArn": {}, + "next": {} + } + } + } + }, + "S2g": { + "type": "list", + "member": {} + }, + "S32": { + "type": "structure", + "members": { + "estimatedSizeInBytes": { + "type": "double" + }, + "estimatedOn": { + "type": "timestamp" + } + } + }, + "S3f": { + "type": "structure", + "required": [ + "roleArn", + "level", + "enabled" + ], + "members": { + "roleArn": {}, + "level": {}, + "enabled": { + "type": "boolean" + } + } + }, + "S3l": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "status": {}, + "creationTime": { + "type": "timestamp" + } + } + } + }, + "S3t": { + "type": "structure", + "members": { + "state": {}, + "reason": {} + } + }, + "S4q": { + "type": "list", + "member": { + "type": "blob" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.paginators.json b/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.paginators.json new file mode 100644 index 0000000..c234bf0 --- /dev/null +++ b/node_modules/aws-sdk/apis/iotanalytics-2017-11-27.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "ListChannels": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListDatasetContents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListDatasets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListDatastores": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListPipelines": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json b/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json new file mode 100644 index 0000000..a5a1fa7 --- /dev/null +++ b/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json @@ -0,0 +1,497 @@ +{ + "metadata": { + "apiVersion": "2018-11-14", + "endpointPrefix": "kafka", + "signingName": "kafka", + "serviceFullName": "Managed Streaming for Kafka", + "serviceAbbreviation": "Kafka", + "serviceId": "Kafka", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "kafka-2018-11-14", + "signatureVersion": "v4" + }, + "operations": { + "CreateCluster": { + "http": { + "requestUri": "/v1/clusters", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerNodeGroupInfo": { + "shape": "S2", + "locationName": "brokerNodeGroupInfo" + }, + "ClusterName": { + "locationName": "clusterName" + }, + "EncryptionInfo": { + "shape": "Sb", + "locationName": "encryptionInfo" + }, + "EnhancedMonitoring": { + "locationName": "enhancedMonitoring" + }, + "KafkaVersion": { + "locationName": "kafkaVersion" + }, + "NumberOfBrokerNodes": { + "locationName": "numberOfBrokerNodes", + "type": "integer" + } + }, + "required": [ + "BrokerNodeGroupInfo", + "KafkaVersion", + "NumberOfBrokerNodes", + "ClusterName" + ] + }, + "output": { + "type": "structure", + "members": { + "ClusterArn": { + "locationName": "clusterArn" + }, + "ClusterName": { + "locationName": "clusterName" + }, + "State": { + "locationName": "state" + } + } + } + }, + "DeleteCluster": { + "http": { + "method": "DELETE", + "requestUri": "/v1/clusters/{clusterArn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ClusterArn": { + "location": "uri", + "locationName": "clusterArn" + }, + "CurrentVersion": { + "location": "querystring", + "locationName": "currentVersion" + } + }, + "required": [ + "ClusterArn" + ] + }, + "output": { + "type": "structure", + "members": { + "ClusterArn": { + "locationName": "clusterArn" + }, + "State": { + "locationName": "state" + } + } + } + }, + "DescribeCluster": { + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ClusterArn": { + "location": "uri", + "locationName": "clusterArn" + } + }, + "required": [ + "ClusterArn" + ] + }, + "output": { + "type": "structure", + "members": { + "ClusterInfo": { + "shape": "Sm", + "locationName": "clusterInfo" + } + } + } + }, + "GetBootstrapBrokers": { + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/bootstrap-brokers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ClusterArn": { + "location": "uri", + "locationName": "clusterArn" + } + }, + "required": [ + "ClusterArn" + ] + }, + "output": { + "type": "structure", + "members": { + "BootstrapBrokerString": { + "locationName": "bootstrapBrokerString" + } + } + } + }, + "ListClusters": { + "http": { + "method": "GET", + "requestUri": "/v1/clusters", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ClusterNameFilter": { + "location": "querystring", + "locationName": "clusterNameFilter" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "ClusterInfoList": { + "locationName": "clusterInfoList", + "type": "list", + "member": { + "shape": "Sm" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListNodes": { + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/nodes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ClusterArn": { + "location": "uri", + "locationName": "clusterArn" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ClusterArn" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "NodeInfoList": { + "locationName": "nodeInfoList", + "type": "list", + "member": { + "type": "structure", + "members": { + "AddedToClusterTime": { + "locationName": "addedToClusterTime" + }, + "BrokerNodeInfo": { + "locationName": "brokerNodeInfo", + "type": "structure", + "members": { + "AttachedENIId": { + "locationName": "attachedENIId" + }, + "BrokerId": { + "locationName": "brokerId", + "type": "double" + }, + "ClientSubnet": { + "locationName": "clientSubnet" + }, + "ClientVpcIpAddress": { + "locationName": "clientVpcIpAddress" + }, + "CurrentBrokerSoftwareInfo": { + "shape": "So", + "locationName": "currentBrokerSoftwareInfo" + } + } + }, + "InstanceType": { + "locationName": "instanceType" + }, + "NodeARN": { + "locationName": "nodeARN" + }, + "NodeType": { + "locationName": "nodeType" + }, + "ZookeeperNodeInfo": { + "locationName": "zookeeperNodeInfo", + "type": "structure", + "members": { + "AttachedENIId": { + "locationName": "attachedENIId" + }, + "ClientVpcIpAddress": { + "locationName": "clientVpcIpAddress" + }, + "ZookeeperId": { + "locationName": "zookeeperId", + "type": "double" + }, + "ZookeeperVersion": { + "locationName": "zookeeperVersion" + } + } + } + } + } + } + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/v1/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S16", + "locationName": "tags" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/v1/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "Tags": { + "shape": "S16", + "locationName": "tags" + } + }, + "required": [ + "ResourceArn", + "Tags" + ] + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/v1/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "TagKeys": { + "shape": "S4", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "members": { + "BrokerAZDistribution": { + "locationName": "brokerAZDistribution" + }, + "ClientSubnets": { + "shape": "S4", + "locationName": "clientSubnets" + }, + "InstanceType": { + "locationName": "instanceType" + }, + "SecurityGroups": { + "shape": "S4", + "locationName": "securityGroups" + }, + "StorageInfo": { + "locationName": "storageInfo", + "type": "structure", + "members": { + "EbsStorageInfo": { + "locationName": "ebsStorageInfo", + "type": "structure", + "members": { + "VolumeSize": { + "locationName": "volumeSize", + "type": "integer" + } + } + } + } + } + }, + "required": [ + "ClientSubnets", + "InstanceType" + ] + }, + "S4": { + "type": "list", + "member": {} + }, + "Sb": { + "type": "structure", + "members": { + "EncryptionAtRest": { + "locationName": "encryptionAtRest", + "type": "structure", + "members": { + "DataVolumeKMSKeyId": { + "locationName": "dataVolumeKMSKeyId" + } + }, + "required": [ + "DataVolumeKMSKeyId" + ] + } + } + }, + "Sm": { + "type": "structure", + "members": { + "BrokerNodeGroupInfo": { + "shape": "S2", + "locationName": "brokerNodeGroupInfo" + }, + "ClusterArn": { + "locationName": "clusterArn" + }, + "ClusterName": { + "locationName": "clusterName" + }, + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "CurrentBrokerSoftwareInfo": { + "shape": "So", + "locationName": "currentBrokerSoftwareInfo" + }, + "CurrentVersion": { + "locationName": "currentVersion" + }, + "EncryptionInfo": { + "shape": "Sb", + "locationName": "encryptionInfo" + }, + "EnhancedMonitoring": { + "locationName": "enhancedMonitoring" + }, + "NumberOfBrokerNodes": { + "locationName": "numberOfBrokerNodes", + "type": "integer" + }, + "State": { + "locationName": "state" + }, + "ZookeeperConnectString": { + "locationName": "zookeeperConnectString" + } + } + }, + "So": { + "type": "structure", + "members": { + "ConfigurationArn": { + "locationName": "configurationArn" + }, + "ConfigurationRevision": { + "locationName": "configurationRevision" + }, + "KafkaVersion": { + "locationName": "kafkaVersion" + } + } + }, + "S16": { + "type": "map", + "key": {}, + "value": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kafka-2018-11-14.paginators.json b/node_modules/aws-sdk/apis/kafka-2018-11-14.paginators.json new file mode 100644 index 0000000..f3b7195 --- /dev/null +++ b/node_modules/aws-sdk/apis/kafka-2018-11-14.paginators.json @@ -0,0 +1,3 @@ +{ + "pagination" : { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesis-2013-12-02.examples.json b/node_modules/aws-sdk/apis/kinesis-2013-12-02.examples.json new file mode 100644 index 0000000..d381c79 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-2013-12-02.examples.json @@ -0,0 +1,4 @@ +{ + "version": "1.0", + "examples": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesis-2013-12-02.min.json b/node_modules/aws-sdk/apis/kinesis-2013-12-02.min.json new file mode 100644 index 0000000..a221021 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-2013-12-02.min.json @@ -0,0 +1,802 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-12-02", + "endpointPrefix": "kinesis", + "jsonVersion": "1.1", + "protocol": "json", + "protocolSettings": { + "h2": "eventstream" + }, + "serviceAbbreviation": "Kinesis", + "serviceFullName": "Amazon Kinesis", + "serviceId": "Kinesis", + "signatureVersion": "v4", + "targetPrefix": "Kinesis_20131202", + "uid": "kinesis-2013-12-02" + }, + "operations": { + "AddTagsToStream": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "Tags" + ], + "members": { + "StreamName": {}, + "Tags": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "CreateStream": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardCount" + ], + "members": { + "StreamName": {}, + "ShardCount": { + "type": "integer" + } + } + } + }, + "DecreaseStreamRetentionPeriod": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "RetentionPeriodHours" + ], + "members": { + "StreamName": {}, + "RetentionPeriodHours": { + "type": "integer" + } + } + } + }, + "DeleteStream": { + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {}, + "EnforceConsumerDeletion": { + "type": "boolean" + } + } + } + }, + "DeregisterStreamConsumer": { + "input": { + "type": "structure", + "members": { + "StreamARN": {}, + "ConsumerName": {}, + "ConsumerARN": {} + } + } + }, + "DescribeLimits": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "ShardLimit", + "OpenShardCount" + ], + "members": { + "ShardLimit": { + "type": "integer" + }, + "OpenShardCount": { + "type": "integer" + } + } + } + }, + "DescribeStream": { + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {}, + "Limit": { + "type": "integer" + }, + "ExclusiveStartShardId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "StreamDescription" + ], + "members": { + "StreamDescription": { + "type": "structure", + "required": [ + "StreamName", + "StreamARN", + "StreamStatus", + "Shards", + "HasMoreShards", + "RetentionPeriodHours", + "StreamCreationTimestamp", + "EnhancedMonitoring" + ], + "members": { + "StreamName": {}, + "StreamARN": {}, + "StreamStatus": {}, + "Shards": { + "shape": "Sp" + }, + "HasMoreShards": { + "type": "boolean" + }, + "RetentionPeriodHours": { + "type": "integer" + }, + "StreamCreationTimestamp": { + "type": "timestamp" + }, + "EnhancedMonitoring": { + "shape": "Sw" + }, + "EncryptionType": {}, + "KeyId": {} + } + } + } + } + }, + "DescribeStreamConsumer": { + "input": { + "type": "structure", + "members": { + "StreamARN": {}, + "ConsumerName": {}, + "ConsumerARN": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ConsumerDescription" + ], + "members": { + "ConsumerDescription": { + "type": "structure", + "required": [ + "ConsumerName", + "ConsumerARN", + "ConsumerStatus", + "ConsumerCreationTimestamp", + "StreamARN" + ], + "members": { + "ConsumerName": {}, + "ConsumerARN": {}, + "ConsumerStatus": {}, + "ConsumerCreationTimestamp": { + "type": "timestamp" + }, + "StreamARN": {} + } + } + } + } + }, + "DescribeStreamSummary": { + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "StreamDescriptionSummary" + ], + "members": { + "StreamDescriptionSummary": { + "type": "structure", + "required": [ + "StreamName", + "StreamARN", + "StreamStatus", + "RetentionPeriodHours", + "StreamCreationTimestamp", + "EnhancedMonitoring", + "OpenShardCount" + ], + "members": { + "StreamName": {}, + "StreamARN": {}, + "StreamStatus": {}, + "RetentionPeriodHours": { + "type": "integer" + }, + "StreamCreationTimestamp": { + "type": "timestamp" + }, + "EnhancedMonitoring": { + "shape": "Sw" + }, + "EncryptionType": {}, + "KeyId": {}, + "OpenShardCount": { + "type": "integer" + }, + "ConsumerCount": { + "type": "integer" + } + } + } + } + } + }, + "DisableEnhancedMonitoring": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardLevelMetrics" + ], + "members": { + "StreamName": {}, + "ShardLevelMetrics": { + "shape": "Sy" + } + } + }, + "output": { + "shape": "S1b" + } + }, + "EnableEnhancedMonitoring": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardLevelMetrics" + ], + "members": { + "StreamName": {}, + "ShardLevelMetrics": { + "shape": "Sy" + } + } + }, + "output": { + "shape": "S1b" + } + }, + "GetRecords": { + "input": { + "type": "structure", + "required": [ + "ShardIterator" + ], + "members": { + "ShardIterator": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Records" + ], + "members": { + "Records": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SequenceNumber", + "Data", + "PartitionKey" + ], + "members": { + "SequenceNumber": {}, + "ApproximateArrivalTimestamp": { + "type": "timestamp" + }, + "Data": { + "type": "blob" + }, + "PartitionKey": {}, + "EncryptionType": {} + } + } + }, + "NextShardIterator": {}, + "MillisBehindLatest": { + "type": "long" + } + } + } + }, + "GetShardIterator": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardId", + "ShardIteratorType" + ], + "members": { + "StreamName": {}, + "ShardId": {}, + "ShardIteratorType": {}, + "StartingSequenceNumber": {}, + "Timestamp": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "ShardIterator": {} + } + } + }, + "IncreaseStreamRetentionPeriod": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "RetentionPeriodHours" + ], + "members": { + "StreamName": {}, + "RetentionPeriodHours": { + "type": "integer" + } + } + } + }, + "ListShards": { + "input": { + "type": "structure", + "members": { + "StreamName": {}, + "NextToken": {}, + "ExclusiveStartShardId": {}, + "MaxResults": { + "type": "integer" + }, + "StreamCreationTimestamp": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "Shards": { + "shape": "Sp" + }, + "NextToken": {} + } + } + }, + "ListStreamConsumers": { + "input": { + "type": "structure", + "required": [ + "StreamARN" + ], + "members": { + "StreamARN": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "StreamCreationTimestamp": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "Consumers": { + "type": "list", + "member": { + "shape": "S1y" + } + }, + "NextToken": {} + } + } + }, + "ListStreams": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "ExclusiveStartStreamName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "StreamNames", + "HasMoreStreams" + ], + "members": { + "StreamNames": { + "type": "list", + "member": {} + }, + "HasMoreStreams": { + "type": "boolean" + } + } + } + }, + "ListTagsForStream": { + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {}, + "ExclusiveStartTagKey": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags", + "HasMoreTags" + ], + "members": { + "Tags": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "HasMoreTags": { + "type": "boolean" + } + } + } + }, + "MergeShards": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardToMerge", + "AdjacentShardToMerge" + ], + "members": { + "StreamName": {}, + "ShardToMerge": {}, + "AdjacentShardToMerge": {} + } + } + }, + "PutRecord": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "Data", + "PartitionKey" + ], + "members": { + "StreamName": {}, + "Data": { + "type": "blob" + }, + "PartitionKey": {}, + "ExplicitHashKey": {}, + "SequenceNumberForOrdering": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ShardId", + "SequenceNumber" + ], + "members": { + "ShardId": {}, + "SequenceNumber": {}, + "EncryptionType": {} + } + } + }, + "PutRecords": { + "input": { + "type": "structure", + "required": [ + "Records", + "StreamName" + ], + "members": { + "Records": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Data", + "PartitionKey" + ], + "members": { + "Data": { + "type": "blob" + }, + "ExplicitHashKey": {}, + "PartitionKey": {} + } + } + }, + "StreamName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Records" + ], + "members": { + "FailedRecordCount": { + "type": "integer" + }, + "Records": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SequenceNumber": {}, + "ShardId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "EncryptionType": {} + } + } + }, + "RegisterStreamConsumer": { + "input": { + "type": "structure", + "required": [ + "StreamARN", + "ConsumerName" + ], + "members": { + "StreamARN": {}, + "ConsumerName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Consumer" + ], + "members": { + "Consumer": { + "shape": "S1y" + } + } + } + }, + "RemoveTagsFromStream": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "TagKeys" + ], + "members": { + "StreamName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "SplitShard": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardToSplit", + "NewStartingHashKey" + ], + "members": { + "StreamName": {}, + "ShardToSplit": {}, + "NewStartingHashKey": {} + } + } + }, + "StartStreamEncryption": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "EncryptionType", + "KeyId" + ], + "members": { + "StreamName": {}, + "EncryptionType": {}, + "KeyId": {} + } + } + }, + "StopStreamEncryption": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "EncryptionType", + "KeyId" + ], + "members": { + "StreamName": {}, + "EncryptionType": {}, + "KeyId": {} + } + } + }, + "UpdateShardCount": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "TargetShardCount", + "ScalingType" + ], + "members": { + "StreamName": {}, + "TargetShardCount": { + "type": "integer" + }, + "ScalingType": {} + } + }, + "output": { + "type": "structure", + "members": { + "StreamName": {}, + "CurrentShardCount": { + "type": "integer" + }, + "TargetShardCount": { + "type": "integer" + } + } + } + } + }, + "shapes": { + "Sp": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ShardId", + "HashKeyRange", + "SequenceNumberRange" + ], + "members": { + "ShardId": {}, + "ParentShardId": {}, + "AdjacentParentShardId": {}, + "HashKeyRange": { + "type": "structure", + "required": [ + "StartingHashKey", + "EndingHashKey" + ], + "members": { + "StartingHashKey": {}, + "EndingHashKey": {} + } + }, + "SequenceNumberRange": { + "type": "structure", + "required": [ + "StartingSequenceNumber" + ], + "members": { + "StartingSequenceNumber": {}, + "EndingSequenceNumber": {} + } + } + } + } + }, + "Sw": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ShardLevelMetrics": { + "shape": "Sy" + } + } + } + }, + "Sy": { + "type": "list", + "member": {} + }, + "S1b": { + "type": "structure", + "members": { + "StreamName": {}, + "CurrentShardLevelMetrics": { + "shape": "Sy" + }, + "DesiredShardLevelMetrics": { + "shape": "Sy" + } + } + }, + "S1y": { + "type": "structure", + "required": [ + "ConsumerName", + "ConsumerARN", + "ConsumerStatus", + "ConsumerCreationTimestamp" + ], + "members": { + "ConsumerName": {}, + "ConsumerARN": {}, + "ConsumerStatus": {}, + "ConsumerCreationTimestamp": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesis-2013-12-02.paginators.json b/node_modules/aws-sdk/apis/kinesis-2013-12-02.paginators.json new file mode 100644 index 0000000..c6f155e --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-2013-12-02.paginators.json @@ -0,0 +1,23 @@ +{ + "pagination": { + "DescribeStream": { + "input_token": "ExclusiveStartShardId", + "limit_key": "Limit", + "more_results": "StreamDescription.HasMoreShards", + "output_token": "StreamDescription.Shards[-1].ShardId", + "result_key": "StreamDescription.Shards" + }, + "ListStreamConsumers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListStreams": { + "input_token": "ExclusiveStartStreamName", + "limit_key": "Limit", + "more_results": "HasMoreStreams", + "output_token": "StreamNames[-1]", + "result_key": "StreamNames" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesis-2013-12-02.waiters2.json b/node_modules/aws-sdk/apis/kinesis-2013-12-02.waiters2.json new file mode 100644 index 0000000..d61efe4 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-2013-12-02.waiters2.json @@ -0,0 +1,30 @@ +{ + "version": 2, + "waiters": { + "StreamExists": { + "delay": 10, + "operation": "DescribeStream", + "maxAttempts": 18, + "acceptors": [ + { + "expected": "ACTIVE", + "matcher": "path", + "state": "success", + "argument": "StreamDescription.StreamStatus" + } + ] + }, + "StreamNotExists": { + "delay": 10, + "operation": "DescribeStream", + "maxAttempts": 18, + "acceptors": [ + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.examples.json b/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.min.json b/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.min.json new file mode 100644 index 0000000..c040acf --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.min.json @@ -0,0 +1,164 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-09-30", + "endpointPrefix": "kinesisvideo", + "protocol": "rest-json", + "serviceAbbreviation": "Kinesis Video Archived Media", + "serviceFullName": "Amazon Kinesis Video Streams Archived Media", + "serviceId": "Kinesis Video Archived Media", + "signatureVersion": "v4", + "uid": "kinesis-video-archived-media-2017-09-30" + }, + "operations": { + "GetHLSStreamingSessionURL": { + "http": { + "requestUri": "/getHLSStreamingSessionURL" + }, + "input": { + "type": "structure", + "members": { + "StreamName": {}, + "StreamARN": {}, + "PlaybackMode": {}, + "HLSFragmentSelector": { + "type": "structure", + "members": { + "FragmentSelectorType": {}, + "TimestampRange": { + "type": "structure", + "members": { + "StartTimestamp": { + "type": "timestamp" + }, + "EndTimestamp": { + "type": "timestamp" + } + } + } + } + }, + "ContainerFormat": {}, + "DiscontinuityMode": {}, + "DisplayFragmentTimestamp": {}, + "Expires": { + "type": "integer" + }, + "MaxMediaPlaylistFragmentResults": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "HLSStreamingSessionURL": {} + } + } + }, + "GetMediaForFragmentList": { + "http": { + "requestUri": "/getMediaForFragmentList" + }, + "input": { + "type": "structure", + "required": [ + "StreamName", + "Fragments" + ], + "members": { + "StreamName": {}, + "Fragments": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Payload": { + "type": "blob", + "streaming": true + } + }, + "payload": "Payload" + } + }, + "ListFragments": { + "http": { + "requestUri": "/listFragments" + }, + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {}, + "MaxResults": { + "type": "long" + }, + "NextToken": {}, + "FragmentSelector": { + "type": "structure", + "required": [ + "FragmentSelectorType", + "TimestampRange" + ], + "members": { + "FragmentSelectorType": {}, + "TimestampRange": { + "type": "structure", + "required": [ + "StartTimestamp", + "EndTimestamp" + ], + "members": { + "StartTimestamp": { + "type": "timestamp" + }, + "EndTimestamp": { + "type": "timestamp" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Fragments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FragmentNumber": {}, + "FragmentSizeInBytes": { + "type": "long" + }, + "ProducerTimestamp": { + "type": "timestamp" + }, + "ServerTimestamp": { + "type": "timestamp" + }, + "FragmentLengthInMilliseconds": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json b/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.examples.json b/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.min.json b/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.min.json new file mode 100644 index 0000000..873dbbf --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.min.json @@ -0,0 +1,59 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-09-30", + "endpointPrefix": "kinesisvideo", + "protocol": "rest-json", + "serviceAbbreviation": "Kinesis Video Media", + "serviceFullName": "Amazon Kinesis Video Streams Media", + "serviceId": "Kinesis Video Media", + "signatureVersion": "v4", + "uid": "kinesis-video-media-2017-09-30" + }, + "operations": { + "GetMedia": { + "http": { + "requestUri": "/getMedia" + }, + "input": { + "type": "structure", + "required": [ + "StartSelector" + ], + "members": { + "StreamName": {}, + "StreamARN": {}, + "StartSelector": { + "type": "structure", + "required": [ + "StartSelectorType" + ], + "members": { + "StartSelectorType": {}, + "AfterFragmentNumber": {}, + "StartTimestamp": { + "type": "timestamp" + }, + "ContinuationToken": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Payload": { + "type": "blob", + "streaming": true + } + }, + "payload": "Payload" + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.paginators.json b/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesis-video-media-2017-09-30.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.examples.json b/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.min.json b/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.min.json new file mode 100644 index 0000000..a301956 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.min.json @@ -0,0 +1,985 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-08-14", + "endpointPrefix": "kinesisanalytics", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Kinesis Analytics", + "serviceFullName": "Amazon Kinesis Analytics", + "serviceId": "Kinesis Analytics", + "signatureVersion": "v4", + "targetPrefix": "KinesisAnalytics_20150814", + "uid": "kinesisanalytics-2015-08-14" + }, + "operations": { + "AddApplicationCloudWatchLoggingOption": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOption" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "CloudWatchLoggingOption": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AddApplicationInput": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "Input" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "Input": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AddApplicationInputProcessingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId", + "InputProcessingConfiguration" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "InputId": {}, + "InputProcessingConfiguration": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AddApplicationOutput": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "Output" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "Output": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AddApplicationReferenceDataSource": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceDataSource" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "ReferenceDataSource": { + "type": "structure", + "required": [ + "TableName", + "ReferenceSchema" + ], + "members": { + "TableName": {}, + "S3ReferenceDataSource": { + "type": "structure", + "required": [ + "BucketARN", + "FileKey", + "ReferenceRoleARN" + ], + "members": { + "BucketARN": {}, + "FileKey": {}, + "ReferenceRoleARN": {} + } + }, + "ReferenceSchema": { + "shape": "Si" + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "ApplicationDescription": {}, + "Inputs": { + "type": "list", + "member": { + "shape": "S9" + } + }, + "Outputs": { + "type": "list", + "member": { + "shape": "S12" + } + }, + "CloudWatchLoggingOptions": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "ApplicationCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ApplicationSummary" + ], + "members": { + "ApplicationSummary": { + "shape": "S1m" + } + } + } + }, + "DeleteApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CreateTimestamp" + ], + "members": { + "ApplicationName": {}, + "CreateTimestamp": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteApplicationCloudWatchLoggingOption": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOptionId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "CloudWatchLoggingOptionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteApplicationInputProcessingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "InputId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteApplicationOutput": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "OutputId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "OutputId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteApplicationReferenceDataSource": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "ReferenceId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ApplicationDetail" + ], + "members": { + "ApplicationDetail": { + "type": "structure", + "required": [ + "ApplicationName", + "ApplicationARN", + "ApplicationStatus", + "ApplicationVersionId" + ], + "members": { + "ApplicationName": {}, + "ApplicationDescription": {}, + "ApplicationARN": {}, + "ApplicationStatus": {}, + "CreateTimestamp": { + "type": "timestamp" + }, + "LastUpdateTimestamp": { + "type": "timestamp" + }, + "InputDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InputId": {}, + "NamePrefix": {}, + "InAppStreamNames": { + "type": "list", + "member": {} + }, + "InputProcessingConfigurationDescription": { + "type": "structure", + "members": { + "InputLambdaProcessorDescription": { + "type": "structure", + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + } + } + }, + "KinesisStreamsInputDescription": { + "type": "structure", + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "KinesisFirehoseInputDescription": { + "type": "structure", + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "InputSchema": { + "shape": "Si" + }, + "InputParallelism": { + "shape": "Sg" + }, + "InputStartingPositionConfiguration": { + "shape": "S29" + } + } + } + }, + "OutputDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "OutputId": {}, + "Name": {}, + "KinesisStreamsOutputDescription": { + "type": "structure", + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "KinesisFirehoseOutputDescription": { + "type": "structure", + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "LambdaOutputDescription": { + "type": "structure", + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "DestinationSchema": { + "shape": "S16" + } + } + } + }, + "ReferenceDataSourceDescriptions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ReferenceId", + "TableName", + "S3ReferenceDataSourceDescription" + ], + "members": { + "ReferenceId": {}, + "TableName": {}, + "S3ReferenceDataSourceDescription": { + "type": "structure", + "required": [ + "BucketARN", + "FileKey", + "ReferenceRoleARN" + ], + "members": { + "BucketARN": {}, + "FileKey": {}, + "ReferenceRoleARN": {} + } + }, + "ReferenceSchema": { + "shape": "Si" + } + } + } + }, + "CloudWatchLoggingOptionDescriptions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LogStreamARN", + "RoleARN" + ], + "members": { + "CloudWatchLoggingOptionId": {}, + "LogStreamARN": {}, + "RoleARN": {} + } + } + }, + "ApplicationCode": {}, + "ApplicationVersionId": { + "type": "long" + } + } + } + } + } + }, + "DiscoverInputSchema": { + "input": { + "type": "structure", + "members": { + "ResourceARN": {}, + "RoleARN": {}, + "InputStartingPositionConfiguration": { + "shape": "S29" + }, + "S3Configuration": { + "type": "structure", + "required": [ + "RoleARN", + "BucketARN", + "FileKey" + ], + "members": { + "RoleARN": {}, + "BucketARN": {}, + "FileKey": {} + } + }, + "InputProcessingConfiguration": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "InputSchema": { + "shape": "Si" + }, + "ParsedInputRecords": { + "type": "list", + "member": { + "type": "list", + "member": {} + } + }, + "ProcessedInputRecords": { + "type": "list", + "member": {} + }, + "RawInputRecords": { + "type": "list", + "member": {} + } + } + } + }, + "ListApplications": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "ExclusiveStartApplicationName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ApplicationSummaries", + "HasMoreApplications" + ], + "members": { + "ApplicationSummaries": { + "type": "list", + "member": { + "shape": "S1m" + } + }, + "HasMoreApplications": { + "type": "boolean" + } + } + } + }, + "StartApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "InputConfigurations" + ], + "members": { + "ApplicationName": {}, + "InputConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id", + "InputStartingPositionConfiguration" + ], + "members": { + "Id": {}, + "InputStartingPositionConfiguration": { + "shape": "S29" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "ApplicationUpdate" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "ApplicationUpdate": { + "type": "structure", + "members": { + "InputUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InputId" + ], + "members": { + "InputId": {}, + "NamePrefixUpdate": {}, + "InputProcessingConfigurationUpdate": { + "type": "structure", + "required": [ + "InputLambdaProcessorUpdate" + ], + "members": { + "InputLambdaProcessorUpdate": { + "type": "structure", + "members": { + "ResourceARNUpdate": {}, + "RoleARNUpdate": {} + } + } + } + }, + "KinesisStreamsInputUpdate": { + "type": "structure", + "members": { + "ResourceARNUpdate": {}, + "RoleARNUpdate": {} + } + }, + "KinesisFirehoseInputUpdate": { + "type": "structure", + "members": { + "ResourceARNUpdate": {}, + "RoleARNUpdate": {} + } + }, + "InputSchemaUpdate": { + "type": "structure", + "members": { + "RecordFormatUpdate": { + "shape": "Sj" + }, + "RecordEncodingUpdate": {}, + "RecordColumnUpdates": { + "shape": "Ss" + } + } + }, + "InputParallelismUpdate": { + "type": "structure", + "members": { + "CountUpdate": { + "type": "integer" + } + } + } + } + } + }, + "ApplicationCodeUpdate": {}, + "OutputUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "OutputId" + ], + "members": { + "OutputId": {}, + "NameUpdate": {}, + "KinesisStreamsOutputUpdate": { + "type": "structure", + "members": { + "ResourceARNUpdate": {}, + "RoleARNUpdate": {} + } + }, + "KinesisFirehoseOutputUpdate": { + "type": "structure", + "members": { + "ResourceARNUpdate": {}, + "RoleARNUpdate": {} + } + }, + "LambdaOutputUpdate": { + "type": "structure", + "members": { + "ResourceARNUpdate": {}, + "RoleARNUpdate": {} + } + }, + "DestinationSchemaUpdate": { + "shape": "S16" + } + } + } + }, + "ReferenceDataSourceUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ReferenceId" + ], + "members": { + "ReferenceId": {}, + "TableNameUpdate": {}, + "S3ReferenceDataSourceUpdate": { + "type": "structure", + "members": { + "BucketARNUpdate": {}, + "FileKeyUpdate": {}, + "ReferenceRoleARNUpdate": {} + } + }, + "ReferenceSchemaUpdate": { + "shape": "Si" + } + } + } + }, + "CloudWatchLoggingOptionUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "CloudWatchLoggingOptionId" + ], + "members": { + "CloudWatchLoggingOptionId": {}, + "LogStreamARNUpdate": {}, + "RoleARNUpdate": {} + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "LogStreamARN", + "RoleARN" + ], + "members": { + "LogStreamARN": {}, + "RoleARN": {} + } + }, + "S9": { + "type": "structure", + "required": [ + "NamePrefix", + "InputSchema" + ], + "members": { + "NamePrefix": {}, + "InputProcessingConfiguration": { + "shape": "Sb" + }, + "KinesisStreamsInput": { + "type": "structure", + "required": [ + "ResourceARN", + "RoleARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "KinesisFirehoseInput": { + "type": "structure", + "required": [ + "ResourceARN", + "RoleARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "InputParallelism": { + "shape": "Sg" + }, + "InputSchema": { + "shape": "Si" + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "InputLambdaProcessor" + ], + "members": { + "InputLambdaProcessor": { + "type": "structure", + "required": [ + "ResourceARN", + "RoleARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + } + } + }, + "Sg": { + "type": "structure", + "members": { + "Count": { + "type": "integer" + } + } + }, + "Si": { + "type": "structure", + "required": [ + "RecordFormat", + "RecordColumns" + ], + "members": { + "RecordFormat": { + "shape": "Sj" + }, + "RecordEncoding": {}, + "RecordColumns": { + "shape": "Ss" + } + } + }, + "Sj": { + "type": "structure", + "required": [ + "RecordFormatType" + ], + "members": { + "RecordFormatType": {}, + "MappingParameters": { + "type": "structure", + "members": { + "JSONMappingParameters": { + "type": "structure", + "required": [ + "RecordRowPath" + ], + "members": { + "RecordRowPath": {} + } + }, + "CSVMappingParameters": { + "type": "structure", + "required": [ + "RecordRowDelimiter", + "RecordColumnDelimiter" + ], + "members": { + "RecordRowDelimiter": {}, + "RecordColumnDelimiter": {} + } + } + } + } + } + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "SqlType" + ], + "members": { + "Name": {}, + "Mapping": {}, + "SqlType": {} + } + } + }, + "S12": { + "type": "structure", + "required": [ + "Name", + "DestinationSchema" + ], + "members": { + "Name": {}, + "KinesisStreamsOutput": { + "type": "structure", + "required": [ + "ResourceARN", + "RoleARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "KinesisFirehoseOutput": { + "type": "structure", + "required": [ + "ResourceARN", + "RoleARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "LambdaOutput": { + "type": "structure", + "required": [ + "ResourceARN", + "RoleARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "DestinationSchema": { + "shape": "S16" + } + } + }, + "S16": { + "type": "structure", + "required": [ + "RecordFormatType" + ], + "members": { + "RecordFormatType": {} + } + }, + "S1m": { + "type": "structure", + "required": [ + "ApplicationName", + "ApplicationARN", + "ApplicationStatus" + ], + "members": { + "ApplicationName": {}, + "ApplicationARN": {}, + "ApplicationStatus": {} + } + }, + "S29": { + "type": "structure", + "members": { + "InputStartingPosition": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.paginators.json b/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisanalytics-2015-08-14.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.examples.json b/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.min.json b/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.min.json new file mode 100644 index 0000000..163e8cf --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.min.json @@ -0,0 +1,1577 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-05-23", + "endpointPrefix": "kinesisanalytics", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Kinesis Analytics V2", + "serviceFullName": "Amazon Kinesis Analytics", + "serviceId": "Kinesis Analytics V2", + "signatureVersion": "v4", + "signingName": "kinesisanalytics", + "targetPrefix": "KinesisAnalytics_20180523", + "uid": "kinesisanalyticsv2-2018-05-23" + }, + "operations": { + "AddApplicationCloudWatchLoggingOption": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOption" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "CloudWatchLoggingOption": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + }, + "CloudWatchLoggingOptionDescriptions": { + "shape": "S8" + } + } + } + }, + "AddApplicationInput": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "Input" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "Input": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + }, + "InputDescriptions": { + "shape": "S11" + } + } + } + }, + "AddApplicationInputProcessingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId", + "InputProcessingConfiguration" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "InputId": {}, + "InputProcessingConfiguration": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + }, + "InputId": {}, + "InputProcessingConfigurationDescription": { + "shape": "S14" + } + } + } + }, + "AddApplicationOutput": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "Output" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "Output": { + "shape": "S1d" + } + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + }, + "OutputDescriptions": { + "shape": "S1j" + } + } + } + }, + "AddApplicationReferenceDataSource": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceDataSource" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "ReferenceDataSource": { + "shape": "S1p" + } + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + }, + "ReferenceDataSourceDescriptions": { + "shape": "S1v" + } + } + } + }, + "CreateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "RuntimeEnvironment", + "ServiceExecutionRole" + ], + "members": { + "ApplicationName": {}, + "ApplicationDescription": {}, + "RuntimeEnvironment": {}, + "ServiceExecutionRole": {}, + "ApplicationConfiguration": { + "type": "structure", + "required": [ + "ApplicationCodeConfiguration" + ], + "members": { + "SqlApplicationConfiguration": { + "type": "structure", + "members": { + "Inputs": { + "type": "list", + "member": { + "shape": "Sd" + } + }, + "Outputs": { + "type": "list", + "member": { + "shape": "S1d" + } + }, + "ReferenceDataSources": { + "type": "list", + "member": { + "shape": "S1p" + } + } + } + }, + "FlinkApplicationConfiguration": { + "type": "structure", + "members": { + "CheckpointConfiguration": { + "type": "structure", + "required": [ + "ConfigurationType" + ], + "members": { + "ConfigurationType": {}, + "CheckpointingEnabled": { + "type": "boolean" + }, + "CheckpointInterval": { + "type": "long" + }, + "MinPauseBetweenCheckpoints": { + "type": "long" + } + } + }, + "MonitoringConfiguration": { + "type": "structure", + "required": [ + "ConfigurationType" + ], + "members": { + "ConfigurationType": {}, + "MetricsLevel": {}, + "LogLevel": {} + } + }, + "ParallelismConfiguration": { + "type": "structure", + "required": [ + "ConfigurationType" + ], + "members": { + "ConfigurationType": {}, + "Parallelism": { + "type": "integer" + }, + "ParallelismPerKPU": { + "type": "integer" + }, + "AutoScalingEnabled": { + "type": "boolean" + } + } + } + } + }, + "EnvironmentProperties": { + "type": "structure", + "required": [ + "PropertyGroups" + ], + "members": { + "PropertyGroups": { + "shape": "S2j" + } + } + }, + "ApplicationCodeConfiguration": { + "type": "structure", + "required": [ + "CodeContentType" + ], + "members": { + "CodeContent": { + "type": "structure", + "members": { + "TextContent": {}, + "ZipFileContent": { + "type": "blob" + }, + "S3ContentLocation": { + "type": "structure", + "required": [ + "BucketARN", + "FileKey" + ], + "members": { + "BucketARN": {}, + "FileKey": {}, + "ObjectVersion": {} + } + } + } + }, + "CodeContentType": {} + } + }, + "ApplicationSnapshotConfiguration": { + "type": "structure", + "required": [ + "SnapshotsEnabled" + ], + "members": { + "SnapshotsEnabled": { + "type": "boolean" + } + } + } + } + }, + "CloudWatchLoggingOptions": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "ApplicationDetail" + ], + "members": { + "ApplicationDetail": { + "shape": "S2y" + } + } + } + }, + "CreateApplicationSnapshot": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "SnapshotName" + ], + "members": { + "ApplicationName": {}, + "SnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CreateTimestamp" + ], + "members": { + "ApplicationName": {}, + "CreateTimestamp": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteApplicationCloudWatchLoggingOption": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOptionId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "CloudWatchLoggingOptionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + }, + "CloudWatchLoggingOptionDescriptions": { + "shape": "S8" + } + } + } + }, + "DeleteApplicationInputProcessingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "InputId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + } + } + } + }, + "DeleteApplicationOutput": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "OutputId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "OutputId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + } + } + } + }, + "DeleteApplicationReferenceDataSource": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "ReferenceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationARN": {}, + "ApplicationVersionId": { + "type": "long" + } + } + } + }, + "DeleteApplicationSnapshot": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "SnapshotName", + "SnapshotCreationTimestamp" + ], + "members": { + "ApplicationName": {}, + "SnapshotName": {}, + "SnapshotCreationTimestamp": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "IncludeAdditionalDetails": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ApplicationDetail" + ], + "members": { + "ApplicationDetail": { + "shape": "S2y" + } + } + } + }, + "DescribeApplicationSnapshot": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "SnapshotName" + ], + "members": { + "ApplicationName": {}, + "SnapshotName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "SnapshotDetails" + ], + "members": { + "SnapshotDetails": { + "shape": "S41" + } + } + } + }, + "DiscoverInputSchema": { + "input": { + "type": "structure", + "required": [ + "ServiceExecutionRole" + ], + "members": { + "ResourceARN": {}, + "ServiceExecutionRole": {}, + "InputStartingPositionConfiguration": { + "shape": "S18" + }, + "S3Configuration": { + "type": "structure", + "required": [ + "BucketARN", + "FileKey" + ], + "members": { + "BucketARN": {}, + "FileKey": {} + } + }, + "InputProcessingConfiguration": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "InputSchema": { + "shape": "Sl" + }, + "ParsedInputRecords": { + "type": "list", + "member": { + "type": "list", + "member": {} + } + }, + "ProcessedInputRecords": { + "type": "list", + "member": {} + }, + "RawInputRecords": { + "type": "list", + "member": {} + } + } + } + }, + "ListApplicationSnapshots": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotSummaries": { + "type": "list", + "member": { + "shape": "S41" + } + }, + "NextToken": {} + } + } + }, + "ListApplications": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ApplicationSummaries" + ], + "members": { + "ApplicationSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ApplicationName", + "ApplicationARN", + "ApplicationStatus", + "ApplicationVersionId", + "RuntimeEnvironment" + ], + "members": { + "ApplicationName": {}, + "ApplicationARN": {}, + "ApplicationStatus": {}, + "ApplicationVersionId": { + "type": "long" + }, + "RuntimeEnvironment": {} + } + } + }, + "NextToken": {} + } + } + }, + "StartApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "RunConfiguration" + ], + "members": { + "ApplicationName": {}, + "RunConfiguration": { + "type": "structure", + "members": { + "SqlRunConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InputId", + "InputStartingPositionConfiguration" + ], + "members": { + "InputId": {}, + "InputStartingPositionConfiguration": { + "shape": "S18" + } + } + } + }, + "ApplicationRestoreConfiguration": { + "shape": "S39" + } + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "CurrentApplicationVersionId" + ], + "members": { + "ApplicationName": {}, + "CurrentApplicationVersionId": { + "type": "long" + }, + "ApplicationConfigurationUpdate": { + "type": "structure", + "members": { + "SqlApplicationConfigurationUpdate": { + "type": "structure", + "members": { + "InputUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InputId" + ], + "members": { + "InputId": {}, + "NamePrefixUpdate": {}, + "InputProcessingConfigurationUpdate": { + "type": "structure", + "required": [ + "InputLambdaProcessorUpdate" + ], + "members": { + "InputLambdaProcessorUpdate": { + "type": "structure", + "required": [ + "ResourceARNUpdate" + ], + "members": { + "ResourceARNUpdate": {} + } + } + } + }, + "KinesisStreamsInputUpdate": { + "type": "structure", + "required": [ + "ResourceARNUpdate" + ], + "members": { + "ResourceARNUpdate": {} + } + }, + "KinesisFirehoseInputUpdate": { + "type": "structure", + "required": [ + "ResourceARNUpdate" + ], + "members": { + "ResourceARNUpdate": {} + } + }, + "InputSchemaUpdate": { + "type": "structure", + "members": { + "RecordFormatUpdate": { + "shape": "Sm" + }, + "RecordEncodingUpdate": {}, + "RecordColumnUpdates": { + "shape": "Sv" + } + } + }, + "InputParallelismUpdate": { + "type": "structure", + "required": [ + "CountUpdate" + ], + "members": { + "CountUpdate": { + "type": "integer" + } + } + } + } + } + }, + "OutputUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "OutputId" + ], + "members": { + "OutputId": {}, + "NameUpdate": {}, + "KinesisStreamsOutputUpdate": { + "type": "structure", + "required": [ + "ResourceARNUpdate" + ], + "members": { + "ResourceARNUpdate": {} + } + }, + "KinesisFirehoseOutputUpdate": { + "type": "structure", + "required": [ + "ResourceARNUpdate" + ], + "members": { + "ResourceARNUpdate": {} + } + }, + "LambdaOutputUpdate": { + "type": "structure", + "required": [ + "ResourceARNUpdate" + ], + "members": { + "ResourceARNUpdate": {} + } + }, + "DestinationSchemaUpdate": { + "shape": "S1h" + } + } + } + }, + "ReferenceDataSourceUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ReferenceId" + ], + "members": { + "ReferenceId": {}, + "TableNameUpdate": {}, + "S3ReferenceDataSourceUpdate": { + "type": "structure", + "members": { + "BucketARNUpdate": {}, + "FileKeyUpdate": {} + } + }, + "ReferenceSchemaUpdate": { + "shape": "Sl" + } + } + } + } + } + }, + "ApplicationCodeConfigurationUpdate": { + "type": "structure", + "members": { + "CodeContentTypeUpdate": {}, + "CodeContentUpdate": { + "type": "structure", + "members": { + "TextContentUpdate": {}, + "ZipFileContentUpdate": { + "type": "blob" + }, + "S3ContentLocationUpdate": { + "type": "structure", + "members": { + "BucketARNUpdate": {}, + "FileKeyUpdate": {}, + "ObjectVersionUpdate": {} + } + } + } + } + } + }, + "FlinkApplicationConfigurationUpdate": { + "type": "structure", + "members": { + "CheckpointConfigurationUpdate": { + "type": "structure", + "members": { + "ConfigurationTypeUpdate": {}, + "CheckpointingEnabledUpdate": { + "type": "boolean" + }, + "CheckpointIntervalUpdate": { + "type": "long" + }, + "MinPauseBetweenCheckpointsUpdate": { + "type": "long" + } + } + }, + "MonitoringConfigurationUpdate": { + "type": "structure", + "members": { + "ConfigurationTypeUpdate": {}, + "MetricsLevelUpdate": {}, + "LogLevelUpdate": {} + } + }, + "ParallelismConfigurationUpdate": { + "type": "structure", + "members": { + "ConfigurationTypeUpdate": {}, + "ParallelismUpdate": { + "type": "integer" + }, + "ParallelismPerKPUUpdate": { + "type": "integer" + }, + "AutoScalingEnabledUpdate": { + "type": "boolean" + } + } + } + } + }, + "EnvironmentPropertyUpdates": { + "type": "structure", + "required": [ + "PropertyGroups" + ], + "members": { + "PropertyGroups": { + "shape": "S2j" + } + } + }, + "ApplicationSnapshotConfigurationUpdate": { + "type": "structure", + "required": [ + "SnapshotsEnabledUpdate" + ], + "members": { + "SnapshotsEnabledUpdate": { + "type": "boolean" + } + } + } + } + }, + "ServiceExecutionRoleUpdate": {}, + "RunConfigurationUpdate": { + "type": "structure", + "members": { + "ApplicationRestoreConfiguration": { + "shape": "S39" + } + } + }, + "CloudWatchLoggingOptionUpdates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "CloudWatchLoggingOptionId" + ], + "members": { + "CloudWatchLoggingOptionId": {}, + "LogStreamARNUpdate": {} + } + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "ApplicationDetail" + ], + "members": { + "ApplicationDetail": { + "shape": "S2y" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "LogStreamARN" + ], + "members": { + "LogStreamARN": {} + } + }, + "S8": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LogStreamARN" + ], + "members": { + "CloudWatchLoggingOptionId": {}, + "LogStreamARN": {}, + "RoleARN": {} + } + } + }, + "Sd": { + "type": "structure", + "required": [ + "NamePrefix", + "InputSchema" + ], + "members": { + "NamePrefix": {}, + "InputProcessingConfiguration": { + "shape": "Sf" + }, + "KinesisStreamsInput": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + }, + "KinesisFirehoseInput": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + }, + "InputParallelism": { + "shape": "Sj" + }, + "InputSchema": { + "shape": "Sl" + } + } + }, + "Sf": { + "type": "structure", + "required": [ + "InputLambdaProcessor" + ], + "members": { + "InputLambdaProcessor": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "Count": { + "type": "integer" + } + } + }, + "Sl": { + "type": "structure", + "required": [ + "RecordFormat", + "RecordColumns" + ], + "members": { + "RecordFormat": { + "shape": "Sm" + }, + "RecordEncoding": {}, + "RecordColumns": { + "shape": "Sv" + } + } + }, + "Sm": { + "type": "structure", + "required": [ + "RecordFormatType" + ], + "members": { + "RecordFormatType": {}, + "MappingParameters": { + "type": "structure", + "members": { + "JSONMappingParameters": { + "type": "structure", + "required": [ + "RecordRowPath" + ], + "members": { + "RecordRowPath": {} + } + }, + "CSVMappingParameters": { + "type": "structure", + "required": [ + "RecordRowDelimiter", + "RecordColumnDelimiter" + ], + "members": { + "RecordRowDelimiter": {}, + "RecordColumnDelimiter": {} + } + } + } + } + } + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "SqlType" + ], + "members": { + "Name": {}, + "Mapping": {}, + "SqlType": {} + } + } + }, + "S11": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InputId": {}, + "NamePrefix": {}, + "InAppStreamNames": { + "type": "list", + "member": {} + }, + "InputProcessingConfigurationDescription": { + "shape": "S14" + }, + "KinesisStreamsInputDescription": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "KinesisFirehoseInputDescription": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "InputSchema": { + "shape": "Sl" + }, + "InputParallelism": { + "shape": "Sj" + }, + "InputStartingPositionConfiguration": { + "shape": "S18" + } + } + } + }, + "S14": { + "type": "structure", + "members": { + "InputLambdaProcessorDescription": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + } + } + }, + "S18": { + "type": "structure", + "members": { + "InputStartingPosition": {} + } + }, + "S1d": { + "type": "structure", + "required": [ + "Name", + "DestinationSchema" + ], + "members": { + "Name": {}, + "KinesisStreamsOutput": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + }, + "KinesisFirehoseOutput": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + }, + "LambdaOutput": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + }, + "DestinationSchema": { + "shape": "S1h" + } + } + }, + "S1h": { + "type": "structure", + "required": [ + "RecordFormatType" + ], + "members": { + "RecordFormatType": {} + } + }, + "S1j": { + "type": "list", + "member": { + "type": "structure", + "members": { + "OutputId": {}, + "Name": {}, + "KinesisStreamsOutputDescription": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "KinesisFirehoseOutputDescription": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "LambdaOutputDescription": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "RoleARN": {} + } + }, + "DestinationSchema": { + "shape": "S1h" + } + } + } + }, + "S1p": { + "type": "structure", + "required": [ + "TableName", + "ReferenceSchema" + ], + "members": { + "TableName": {}, + "S3ReferenceDataSource": { + "type": "structure", + "members": { + "BucketARN": {}, + "FileKey": {} + } + }, + "ReferenceSchema": { + "shape": "Sl" + } + } + }, + "S1v": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ReferenceId", + "TableName", + "S3ReferenceDataSourceDescription" + ], + "members": { + "ReferenceId": {}, + "TableName": {}, + "S3ReferenceDataSourceDescription": { + "type": "structure", + "required": [ + "BucketARN", + "FileKey" + ], + "members": { + "BucketARN": {}, + "FileKey": {}, + "ReferenceRoleARN": {} + } + }, + "ReferenceSchema": { + "shape": "Sl" + } + } + } + }, + "S2j": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "PropertyGroupId", + "PropertyMap" + ], + "members": { + "PropertyGroupId": {}, + "PropertyMap": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "S2y": { + "type": "structure", + "required": [ + "ApplicationARN", + "ApplicationName", + "RuntimeEnvironment", + "ApplicationStatus", + "ApplicationVersionId" + ], + "members": { + "ApplicationARN": {}, + "ApplicationDescription": {}, + "ApplicationName": {}, + "RuntimeEnvironment": {}, + "ServiceExecutionRole": {}, + "ApplicationStatus": {}, + "ApplicationVersionId": { + "type": "long" + }, + "CreateTimestamp": { + "type": "timestamp" + }, + "LastUpdateTimestamp": { + "type": "timestamp" + }, + "ApplicationConfigurationDescription": { + "type": "structure", + "members": { + "SqlApplicationConfigurationDescription": { + "type": "structure", + "members": { + "InputDescriptions": { + "shape": "S11" + }, + "OutputDescriptions": { + "shape": "S1j" + }, + "ReferenceDataSourceDescriptions": { + "shape": "S1v" + } + } + }, + "ApplicationCodeConfigurationDescription": { + "type": "structure", + "required": [ + "CodeContentType" + ], + "members": { + "CodeContentType": {}, + "CodeContentDescription": { + "type": "structure", + "members": { + "TextContent": {}, + "CodeMD5": {}, + "CodeSize": { + "type": "long" + }, + "S3ApplicationCodeLocationDescription": { + "type": "structure", + "required": [ + "BucketARN", + "FileKey" + ], + "members": { + "BucketARN": {}, + "FileKey": {}, + "ObjectVersion": {} + } + } + } + } + } + }, + "RunConfigurationDescription": { + "type": "structure", + "members": { + "ApplicationRestoreConfigurationDescription": { + "shape": "S39" + } + } + }, + "FlinkApplicationConfigurationDescription": { + "type": "structure", + "members": { + "CheckpointConfigurationDescription": { + "type": "structure", + "members": { + "ConfigurationType": {}, + "CheckpointingEnabled": { + "type": "boolean" + }, + "CheckpointInterval": { + "type": "long" + }, + "MinPauseBetweenCheckpoints": { + "type": "long" + } + } + }, + "MonitoringConfigurationDescription": { + "type": "structure", + "members": { + "ConfigurationType": {}, + "MetricsLevel": {}, + "LogLevel": {} + } + }, + "ParallelismConfigurationDescription": { + "type": "structure", + "members": { + "ConfigurationType": {}, + "Parallelism": { + "type": "integer" + }, + "ParallelismPerKPU": { + "type": "integer" + }, + "CurrentParallelism": { + "type": "integer" + }, + "AutoScalingEnabled": { + "type": "boolean" + } + } + }, + "JobPlanDescription": {} + } + }, + "EnvironmentPropertyDescriptions": { + "type": "structure", + "members": { + "PropertyGroupDescriptions": { + "shape": "S2j" + } + } + }, + "ApplicationSnapshotConfigurationDescription": { + "type": "structure", + "required": [ + "SnapshotsEnabled" + ], + "members": { + "SnapshotsEnabled": { + "type": "boolean" + } + } + } + } + }, + "CloudWatchLoggingOptionDescriptions": { + "shape": "S8" + } + } + }, + "S39": { + "type": "structure", + "required": [ + "ApplicationRestoreType" + ], + "members": { + "ApplicationRestoreType": {}, + "SnapshotName": {} + } + }, + "S41": { + "type": "structure", + "required": [ + "SnapshotName", + "SnapshotStatus", + "ApplicationVersionId" + ], + "members": { + "SnapshotName": {}, + "SnapshotStatus": {}, + "ApplicationVersionId": { + "type": "long" + }, + "SnapshotCreationTimestamp": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.paginators.json b/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.examples.json b/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json b/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json new file mode 100644 index 0000000..a06bfe2 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json @@ -0,0 +1,278 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-09-30", + "endpointPrefix": "kinesisvideo", + "protocol": "rest-json", + "serviceAbbreviation": "Kinesis Video", + "serviceFullName": "Amazon Kinesis Video Streams", + "serviceId": "Kinesis Video", + "signatureVersion": "v4", + "uid": "kinesisvideo-2017-09-30" + }, + "operations": { + "CreateStream": { + "http": { + "requestUri": "/createStream" + }, + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "DeviceName": {}, + "StreamName": {}, + "MediaType": {}, + "KmsKeyId": {}, + "DataRetentionInHours": { + "type": "integer" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamARN": {} + } + } + }, + "DeleteStream": { + "http": { + "requestUri": "/deleteStream" + }, + "input": { + "type": "structure", + "required": [ + "StreamARN" + ], + "members": { + "StreamARN": {}, + "CurrentVersion": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeStream": { + "http": { + "requestUri": "/describeStream" + }, + "input": { + "type": "structure", + "members": { + "StreamName": {}, + "StreamARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "StreamInfo": { + "shape": "Sh" + } + } + } + }, + "GetDataEndpoint": { + "http": { + "requestUri": "/getDataEndpoint" + }, + "input": { + "type": "structure", + "required": [ + "APIName" + ], + "members": { + "StreamName": {}, + "StreamARN": {}, + "APIName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DataEndpoint": {} + } + } + }, + "ListStreams": { + "http": { + "requestUri": "/listStreams" + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "StreamNameCondition": { + "type": "structure", + "members": { + "ComparisonOperator": {}, + "ComparisonValue": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamInfoList": { + "type": "list", + "member": { + "shape": "Sh" + } + }, + "NextToken": {} + } + } + }, + "ListTagsForStream": { + "http": { + "requestUri": "/listTagsForStream" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "StreamARN": {}, + "StreamName": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Tags": { + "shape": "S7" + } + } + } + }, + "TagStream": { + "http": { + "requestUri": "/tagStream" + }, + "input": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "StreamARN": {}, + "StreamName": {}, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagStream": { + "http": { + "requestUri": "/untagStream" + }, + "input": { + "type": "structure", + "required": [ + "TagKeyList" + ], + "members": { + "StreamARN": {}, + "StreamName": {}, + "TagKeyList": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDataRetention": { + "http": { + "requestUri": "/updateDataRetention" + }, + "input": { + "type": "structure", + "required": [ + "CurrentVersion", + "Operation", + "DataRetentionChangeInHours" + ], + "members": { + "StreamName": {}, + "StreamARN": {}, + "CurrentVersion": {}, + "Operation": {}, + "DataRetentionChangeInHours": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateStream": { + "http": { + "requestUri": "/updateStream" + }, + "input": { + "type": "structure", + "required": [ + "CurrentVersion" + ], + "members": { + "StreamName": {}, + "StreamARN": {}, + "CurrentVersion": {}, + "DeviceName": {}, + "MediaType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S7": { + "type": "map", + "key": {}, + "value": {} + }, + "Sh": { + "type": "structure", + "members": { + "DeviceName": {}, + "StreamName": {}, + "StreamARN": {}, + "MediaType": {}, + "KmsKeyId": {}, + "Version": {}, + "Status": {}, + "CreationTime": { + "type": "timestamp" + }, + "DataRetentionInHours": { + "type": "integer" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.paginators.json b/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json b/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json new file mode 100644 index 0000000..b0a17a5 --- /dev/null +++ b/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json @@ -0,0 +1,906 @@ +{ + "version": "1.0", + "examples": { + "CancelKeyDeletion": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "KeyId": "The ARN of the CMK whose deletion you canceled." + } + }, + "description": "The following example cancels deletion of the specified CMK.", + "id": "to-cancel-deletion-of-a-cmk-1477428535102", + "title": "To cancel deletion of a customer master key (CMK)" + } + ], + "CreateAlias": [ + { + "input": { + "AliasName": "alias/ExampleAlias", + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "AliasName": "The alias to create. Aliases must begin with 'alias/'. Do not use aliases that begin with 'alias/aws' because they are reserved for use by AWS.", + "TargetKeyId": "The identifier of the CMK whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example creates an alias for the specified customer master key (CMK).", + "id": "to-create-an-alias-1477505685119", + "title": "To create an alias" + } + ], + "CreateGrant": [ + { + "input": { + "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole", + "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "Decrypt" + ] + }, + "output": { + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "GrantToken": "AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA" + }, + "comments": { + "input": { + "GranteePrincipal": "The identity that is given permission to perform the operations specified in the grant.", + "KeyId": "The identifier of the CMK to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "Operations": "A list of operations that the grant allows." + }, + "output": { + "GrantId": "The unique identifier of the grant.", + "GrantToken": "The grant token." + } + }, + "description": "The following example creates a grant that allows the specified IAM role to encrypt data with the specified customer master key (CMK).", + "id": "to-create-a-grant-1477972226782", + "title": "To create a grant" + } + ], + "CreateKey": [ + { + "input": { + "Tags": [ + { + "TagKey": "CreatedBy", + "TagValue": "ExampleUser" + } + ] + }, + "output": { + "KeyMetadata": { + "AWSAccountId": "111122223333", + "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "CreationDate": "2017-07-05T14:04:55-07:00", + "Description": "", + "Enabled": true, + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyManager": "CUSTOMER", + "KeyState": "Enabled", + "KeyUsage": "ENCRYPT_DECRYPT", + "Origin": "AWS_KMS" + } + }, + "comments": { + "input": { + "Tags": "One or more tags. Each tag consists of a tag key and a tag value." + }, + "output": { + "KeyMetadata": "An object that contains information about the CMK created by this operation." + } + }, + "description": "The following example creates a CMK.", + "id": "to-create-a-cmk-1478028992966", + "title": "To create a customer master key (CMK)" + } + ], + "Decrypt": [ + { + "input": { + "CiphertextBlob": "" + }, + "output": { + "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Plaintext": "" + }, + "comments": { + "input": { + "CiphertextBlob": "The encrypted data (ciphertext)." + }, + "output": { + "KeyId": "The Amazon Resource Name (ARN) of the CMK that was used to decrypt the data.", + "Plaintext": "The decrypted (plaintext) data." + } + }, + "description": "The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS.", + "id": "to-decrypt-data-1478281622886", + "title": "To decrypt data" + } + ], + "DeleteAlias": [ + { + "input": { + "AliasName": "alias/ExampleAlias" + }, + "comments": { + "input": { + "AliasName": "The alias to delete." + } + }, + "description": "The following example deletes the specified alias.", + "id": "to-delete-an-alias-1478285209338", + "title": "To delete an alias" + } + ], + "DeleteImportedKeyMaterial": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example deletes the imported key material from the specified customer master key (CMK).", + "id": "to-delete-imported-key-material-1478561674507", + "title": "To delete imported key material" + } + ], + "DescribeKey": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "KeyMetadata": { + "AWSAccountId": "111122223333", + "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "CreationDate": "2017-07-05T14:04:55-07:00", + "Description": "", + "Enabled": true, + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyManager": "CUSTOMER", + "KeyState": "Enabled", + "KeyUsage": "ENCRYPT_DECRYPT", + "Origin": "AWS_KMS" + } + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK that you want information about. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "KeyMetadata": "An object that contains information about the specified CMK." + } + }, + "description": "The following example returns information (metadata) about the specified CMK.", + "id": "to-obtain-information-about-a-cmk-1478565820907", + "title": "To obtain information about a customer master key (CMK)" + } + ], + "DisableKey": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to disable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example disables the specified CMK.", + "id": "to-disable-a-cmk-1478566583659", + "title": "To disable a customer master key (CMK)" + } + ], + "DisableKeyRotation": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example disables automatic annual rotation of the key material for the specified CMK.", + "id": "to-disable-automatic-rotation-of-key-material-1478624396092", + "title": "To disable automatic rotation of key material" + } + ], + "EnableKey": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to enable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example enables the specified CMK.", + "id": "to-enable-a-cmk-1478627501129", + "title": "To enable a customer master key (CMK)" + } + ], + "EnableKeyRotation": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example enables automatic annual rotation of the key material for the specified CMK.", + "id": "to-enable-automatic-rotation-of-key-material-1478629109677", + "title": "To enable automatic rotation of key material" + } + ], + "Encrypt": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Plaintext": "" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.", + "Plaintext": "The data to encrypt." + }, + "output": { + "CiphertextBlob": "The encrypted data (ciphertext).", + "KeyId": "The ARN of the CMK that was used to encrypt the data." + } + }, + "description": "The following example encrypts data with the specified customer master key (CMK).", + "id": "to-encrypt-data-1478906026012", + "title": "To encrypt data" + } + ], + "GenerateDataKey": [ + { + "input": { + "KeyId": "alias/ExampleAlias", + "KeySpec": "AES_256" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Plaintext": "" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.", + "KeySpec": "Specifies the type of data key to return." + }, + "output": { + "CiphertextBlob": "The encrypted data key.", + "KeyId": "The ARN of the CMK that was used to encrypt the data key.", + "Plaintext": "The unencrypted (plaintext) data key." + } + }, + "description": "The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified customer master key (CMK).", + "id": "to-generate-a-data-key-1478912956062", + "title": "To generate a data key" + } + ], + "GenerateDataKeyWithoutPlaintext": [ + { + "input": { + "KeyId": "alias/ExampleAlias", + "KeySpec": "AES_256" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.", + "KeySpec": "Specifies the type of data key to return." + }, + "output": { + "CiphertextBlob": "The encrypted data key.", + "KeyId": "The ARN of the CMK that was used to encrypt the data key." + } + }, + "description": "The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified customer master key (CMK).", + "id": "to-generate-an-encrypted-data-key-1478914121134", + "title": "To generate an encrypted data key" + } + ], + "GenerateRandom": [ + { + "input": { + "NumberOfBytes": 32 + }, + "output": { + "Plaintext": "" + }, + "comments": { + "input": { + "NumberOfBytes": "The length of the random data, specified in number of bytes." + }, + "output": { + "Plaintext": "The random data." + } + }, + "description": "The following example uses AWS KMS to generate 32 bytes of random data.", + "id": "to-generate-random-data-1479163645600", + "title": "To generate random data" + } + ], + "GetKeyPolicy": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "PolicyName": "default" + }, + "output": { + "Policy": "{\n \"Version\" : \"2012-10-17\",\n \"Id\" : \"key-default-1\",\n \"Statement\" : [ {\n \"Sid\" : \"Enable IAM User Permissions\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::111122223333:root\"\n },\n \"Action\" : \"kms:*\",\n \"Resource\" : \"*\"\n } ]\n}" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "PolicyName": "The name of the key policy to retrieve." + }, + "output": { + "Policy": "The key policy document." + } + }, + "description": "The following example retrieves the key policy for the specified customer master key (CMK).", + "id": "to-retrieve-a-key-policy-1479170128325", + "title": "To retrieve a key policy" + } + ], + "GetKeyRotationStatus": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "KeyRotationEnabled": true + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "KeyRotationEnabled": "A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not." + } + }, + "description": "The following example retrieves the status of automatic annual rotation of the key material for the specified CMK.", + "id": "to-retrieve-the-rotation-status-for-a-cmk-1479172287408", + "title": "To retrieve the rotation status for a customer master key (CMK)" + } + ], + "GetParametersForImport": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "WrappingAlgorithm": "RSAES_OAEP_SHA_1", + "WrappingKeySpec": "RSA_2048" + }, + "output": { + "ImportToken": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "ParametersValidTo": "2016-12-01T14:52:17-08:00", + "PublicKey": "" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "WrappingAlgorithm": "The algorithm that you will use to encrypt the key material before importing it.", + "WrappingKeySpec": "The type of wrapping key (public key) to return in the response." + }, + "output": { + "ImportToken": "The import token to send with a subsequent ImportKeyMaterial request.", + "KeyId": "The ARN of the CMK for which you are retrieving the public key and import token. This is the same CMK specified in the request.", + "ParametersValidTo": "The time at which the import token and public key are no longer valid.", + "PublicKey": "The public key to use to encrypt the key material before importing it." + } + }, + "description": "The following example retrieves the public key and import token for the specified CMK.", + "id": "to-retrieve-the-public-key-and-import-token-for-a-cmk-1480626483211", + "title": "To retrieve the public key and import token for a customer master key (CMK)" + } + ], + "ImportKeyMaterial": [ + { + "input": { + "EncryptedKeyMaterial": "", + "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE", + "ImportToken": "", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "EncryptedKeyMaterial": "The encrypted key material to import.", + "ExpirationModel": "A value that specifies whether the key material expires.", + "ImportToken": "The import token that you received in the response to a previous GetParametersForImport request.", + "KeyId": "The identifier of the CMK to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example imports key material into the specified CMK.", + "id": "to-import-key-material-into-a-cmk-1480630551969", + "title": "To import key material into a customer master key (CMK)" + } + ], + "ListAliases": [ + { + "output": { + "Aliases": [ + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/acm", + "AliasName": "alias/aws/acm", + "TargetKeyId": "da03f6f7-d279-427a-9cae-de48d07e5b66" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs", + "AliasName": "alias/aws/ebs", + "TargetKeyId": "25a217e7-7170-4b8c-8bf6-045ea5f70e5b" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/rds", + "AliasName": "alias/aws/rds", + "TargetKeyId": "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift", + "AliasName": "alias/aws/redshift", + "TargetKeyId": "08f7a25a-69e2-4fb5-8f10-393db27326fa" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/s3", + "AliasName": "alias/aws/s3", + "TargetKeyId": "d2b0f1a3-580d-4f79-b836-bc983be8cfa5" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example1", + "AliasName": "alias/example1", + "TargetKeyId": "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example2", + "AliasName": "alias/example2", + "TargetKeyId": "f32fef59-2cc2-445b-8573-2d73328acbee" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example3", + "AliasName": "alias/example3", + "TargetKeyId": "1374ef38-d34e-4d5f-b2c9-4e0daee38855" + } + ], + "Truncated": false + }, + "comments": { + "output": { + "Aliases": "A list of aliases, including the key ID of the customer master key (CMK) that each alias refers to.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists aliases.", + "id": "to-list-aliases-1480729693349", + "title": "To list aliases" + } + ], + "ListGrants": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "Grants": [ + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + }, + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + }, + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + }, + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + } + ], + "Truncated": true + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "Grants": "A list of grants.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists grants for the specified CMK.", + "id": "to-list-grants-for-a-cmk-1481067365389", + "title": "To list grants for a customer master key (CMK)" + } + ], + "ListKeyPolicies": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "PolicyNames": [ + "default" + ], + "Truncated": false + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "PolicyNames": "A list of key policy names.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists key policies for the specified CMK.", + "id": "to-list-key-policies-for-a-cmk-1481069780998", + "title": "To list key policies for a customer master key (CMK)" + } + ], + "ListKeys": [ + { + "output": { + "Keys": [ + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e", + "KeyId": "0d990263-018e-4e65-a703-eff731de951e" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841", + "KeyId": "144be297-0ae1-44ac-9c8f-93cd8c82f841" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571", + "KeyId": "21184251-b765-428e-b852-2c7353e72571" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c", + "KeyId": "214fe92f-5b03-4ae1-b350-db2a45dbe10c" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458", + "KeyId": "339963f2-e523-49d3-af24-a0fe752aa458" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a", + "KeyId": "b776a44b-df37-4438-9be4-a27494e4271a" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb", + "KeyId": "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb" + } + ], + "Truncated": false + }, + "comments": { + "output": { + "Keys": "A list of CMKs, including the key ID and Amazon Resource Name (ARN) of each one.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists CMKs.", + "id": "to-list-cmks-1481071643069", + "title": "To list customer master keys (CMKs)" + } + ], + "ListResourceTags": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "Tags": [ + { + "TagKey": "CostCenter", + "TagValue": "87654" + }, + { + "TagKey": "CreatedBy", + "TagValue": "ExampleUser" + }, + { + "TagKey": "Purpose", + "TagValue": "Test" + } + ], + "Truncated": false + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "Tags": "A list of tags.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists tags for a CMK.", + "id": "to-list-tags-for-a-cmk-1483996855796", + "title": "To list tags for a customer master key (CMK)" + } + ], + "ListRetirableGrants": [ + { + "input": { + "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole" + }, + "output": { + "Grants": [ + { + "CreationDate": "2016-12-07T11:09:35-08:00", + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole", + "IssuingAccount": "arn:aws:iam::444455556666:root", + "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Decrypt", + "Encrypt" + ], + "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole" + } + ], + "Truncated": false + }, + "comments": { + "input": { + "RetiringPrincipal": "The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of an AWS principal such as an AWS account (root), IAM user, federated user, or assumed role user." + }, + "output": { + "Grants": "A list of grants that the specified principal can retire.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists the grants that the specified principal (identity) can retire.", + "id": "to-list-grants-that-the-specified-principal-can-retire-1481140499620", + "title": "To list grants that the specified principal can retire" + } + ], + "PutKeyPolicy": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Policy": "{\n \"Version\": \"2012-10-17\",\n \"Id\": \"custom-policy-2016-12-07\",\n \"Statement\": [\n {\n \"Sid\": \"Enable IAM User Permissions\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:root\"\n },\n \"Action\": \"kms:*\",\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow access for Key Administrators\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": [\n \"arn:aws:iam::111122223333:user/ExampleAdminUser\",\n \"arn:aws:iam::111122223333:role/ExampleAdminRole\"\n ]\n },\n \"Action\": [\n \"kms:Create*\",\n \"kms:Describe*\",\n \"kms:Enable*\",\n \"kms:List*\",\n \"kms:Put*\",\n \"kms:Update*\",\n \"kms:Revoke*\",\n \"kms:Disable*\",\n \"kms:Get*\",\n \"kms:Delete*\",\n \"kms:ScheduleKeyDeletion\",\n \"kms:CancelKeyDeletion\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow use of the key\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n },\n \"Action\": [\n \"kms:Encrypt\",\n \"kms:Decrypt\",\n \"kms:ReEncrypt*\",\n \"kms:GenerateDataKey*\",\n \"kms:DescribeKey\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow attachment of persistent resources\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n },\n \"Action\": [\n \"kms:CreateGrant\",\n \"kms:ListGrants\",\n \"kms:RevokeGrant\"\n ],\n \"Resource\": \"*\",\n \"Condition\": {\n \"Bool\": {\n \"kms:GrantIsForAWSResource\": \"true\"\n }\n }\n }\n ]\n}\n", + "PolicyName": "default" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "Policy": "The key policy document.", + "PolicyName": "The name of the key policy." + } + }, + "description": "The following example attaches a key policy to the specified CMK.", + "id": "to-attach-a-key-policy-to-a-cmk-1481147345018", + "title": "To attach a key policy to a customer master key (CMK)" + } + ], + "ReEncrypt": [ + { + "input": { + "CiphertextBlob": "", + "DestinationKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", + "SourceKeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "CiphertextBlob": "The data to reencrypt.", + "DestinationKeyId": "The identifier of the CMK to use to reencrypt the data. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK." + }, + "output": { + "CiphertextBlob": "The reencrypted data.", + "KeyId": "The ARN of the CMK that was used to reencrypt the data.", + "SourceKeyId": "The ARN of the CMK that was used to originally encrypt the data." + } + }, + "description": "The following example reencrypts data with the specified CMK.", + "id": "to-reencrypt-data-1481230358001", + "title": "To reencrypt data" + } + ], + "RetireGrant": [ + { + "input": { + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "GrantId": "The identifier of the grant to retire.", + "KeyId": "The Amazon Resource Name (ARN) of the customer master key (CMK) associated with the grant." + } + }, + "description": "The following example retires a grant.", + "id": "to-retire-a-grant-1481327028297", + "title": "To retire a grant" + } + ], + "RevokeGrant": [ + { + "input": { + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "GrantId": "The identifier of the grant to revoke.", + "KeyId": "The identifier of the customer master key (CMK) associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example revokes a grant.", + "id": "to-revoke-a-grant-1481329549302", + "title": "To revoke a grant" + } + ], + "ScheduleKeyDeletion": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "PendingWindowInDays": 7 + }, + "output": { + "DeletionDate": "2016-12-17T16:00:00-08:00", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "PendingWindowInDays": "The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the CMK." + }, + "output": { + "DeletionDate": "The date and time after which AWS KMS deletes the CMK.", + "KeyId": "The ARN of the CMK that is scheduled for deletion." + } + }, + "description": "The following example schedules the specified CMK for deletion.", + "id": "to-schedule-a-cmk-for-deletion-1481331111094", + "title": "To schedule a customer master key (CMK) for deletion" + } + ], + "TagResource": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Tags": [ + { + "TagKey": "Purpose", + "TagValue": "Test" + } + ] + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "Tags": "A list of tags." + } + }, + "description": "The following example tags a CMK.", + "id": "to-tag-a-cmk-1483997246518", + "title": "To tag a customer master key (CMK)" + } + ], + "UntagResource": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "TagKeys": [ + "Purpose", + "CostCenter" + ] + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose tags you are removing.", + "TagKeys": "A list of tag keys. Provide only the tag keys, not the tag values." + } + }, + "description": "The following example removes tags from a CMK.", + "id": "to-remove-tags-from-a-cmk-1483997590962", + "title": "To remove tags from a customer master key (CMK)" + } + ], + "UpdateAlias": [ + { + "input": { + "AliasName": "alias/ExampleAlias", + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "AliasName": "The alias to update.", + "TargetKeyId": "The identifier of the CMK that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example updates the specified alias to refer to the specified customer master key (CMK).", + "id": "to-update-an-alias-1481572726920", + "title": "To update an alias" + } + ], + "UpdateKeyDescription": [ + { + "input": { + "Description": "Example description that indicates the intended use of this CMK.", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "Description": "The updated description.", + "KeyId": "The identifier of the CMK whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example updates the description of the specified CMK.", + "id": "to-update-the-description-of-a-cmk-1481574808619", + "title": "To update the description of a customer master key (CMK)" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/kms-2014-11-01.min.json b/node_modules/aws-sdk/apis/kms-2014-11-01.min.json new file mode 100644 index 0000000..f598197 --- /dev/null +++ b/node_modules/aws-sdk/apis/kms-2014-11-01.min.json @@ -0,0 +1,976 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-11-01", + "endpointPrefix": "kms", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "KMS", + "serviceFullName": "AWS Key Management Service", + "serviceId": "KMS", + "signatureVersion": "v4", + "targetPrefix": "TrentService", + "uid": "kms-2014-11-01" + }, + "operations": { + "CancelKeyDeletion": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "KeyId": {} + } + } + }, + "ConnectCustomKeyStore": { + "input": { + "type": "structure", + "required": [ + "CustomKeyStoreId" + ], + "members": { + "CustomKeyStoreId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateAlias": { + "input": { + "type": "structure", + "required": [ + "AliasName", + "TargetKeyId" + ], + "members": { + "AliasName": {}, + "TargetKeyId": {} + } + } + }, + "CreateCustomKeyStore": { + "input": { + "type": "structure", + "required": [ + "CustomKeyStoreName", + "CloudHsmClusterId", + "TrustAnchorCertificate", + "KeyStorePassword" + ], + "members": { + "CustomKeyStoreName": {}, + "CloudHsmClusterId": {}, + "TrustAnchorCertificate": {}, + "KeyStorePassword": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomKeyStoreId": {} + } + } + }, + "CreateGrant": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "GranteePrincipal", + "Operations" + ], + "members": { + "KeyId": {}, + "GranteePrincipal": {}, + "RetiringPrincipal": {}, + "Operations": { + "shape": "Sh" + }, + "Constraints": { + "shape": "Sj" + }, + "GrantTokens": { + "shape": "Sn" + }, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "GrantToken": {}, + "GrantId": {} + } + } + }, + "CreateKey": { + "input": { + "type": "structure", + "members": { + "Policy": {}, + "Description": {}, + "KeyUsage": {}, + "Origin": {}, + "CustomKeyStoreId": {}, + "BypassPolicyLockoutSafetyCheck": { + "type": "boolean" + }, + "Tags": { + "shape": "Sy" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyMetadata": { + "shape": "S13" + } + } + } + }, + "Decrypt": { + "input": { + "type": "structure", + "required": [ + "CiphertextBlob" + ], + "members": { + "CiphertextBlob": { + "type": "blob" + }, + "EncryptionContext": { + "shape": "Sk" + }, + "GrantTokens": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyId": {}, + "Plaintext": { + "shape": "S1d" + } + } + } + }, + "DeleteAlias": { + "input": { + "type": "structure", + "required": [ + "AliasName" + ], + "members": { + "AliasName": {} + } + } + }, + "DeleteCustomKeyStore": { + "input": { + "type": "structure", + "required": [ + "CustomKeyStoreId" + ], + "members": { + "CustomKeyStoreId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteImportedKeyMaterial": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {} + } + } + }, + "DescribeCustomKeyStores": { + "input": { + "type": "structure", + "members": { + "CustomKeyStoreId": {}, + "CustomKeyStoreName": {}, + "Limit": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "CustomKeyStores": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CustomKeyStoreId": {}, + "CustomKeyStoreName": {}, + "CloudHsmClusterId": {}, + "TrustAnchorCertificate": {}, + "ConnectionState": {}, + "ConnectionErrorCode": {}, + "CreationDate": { + "type": "timestamp" + } + } + } + }, + "NextMarker": {}, + "Truncated": { + "type": "boolean" + } + } + } + }, + "DescribeKey": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {}, + "GrantTokens": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyMetadata": { + "shape": "S13" + } + } + } + }, + "DisableKey": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {} + } + } + }, + "DisableKeyRotation": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {} + } + } + }, + "DisconnectCustomKeyStore": { + "input": { + "type": "structure", + "required": [ + "CustomKeyStoreId" + ], + "members": { + "CustomKeyStoreId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "EnableKey": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {} + } + } + }, + "EnableKeyRotation": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {} + } + } + }, + "Encrypt": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "Plaintext" + ], + "members": { + "KeyId": {}, + "Plaintext": { + "shape": "S1d" + }, + "EncryptionContext": { + "shape": "Sk" + }, + "GrantTokens": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "CiphertextBlob": { + "type": "blob" + }, + "KeyId": {} + } + } + }, + "GenerateDataKey": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {}, + "EncryptionContext": { + "shape": "Sk" + }, + "NumberOfBytes": { + "type": "integer" + }, + "KeySpec": {}, + "GrantTokens": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "CiphertextBlob": { + "type": "blob" + }, + "Plaintext": { + "shape": "S1d" + }, + "KeyId": {} + } + } + }, + "GenerateDataKeyWithoutPlaintext": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {}, + "EncryptionContext": { + "shape": "Sk" + }, + "KeySpec": {}, + "NumberOfBytes": { + "type": "integer" + }, + "GrantTokens": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "CiphertextBlob": { + "type": "blob" + }, + "KeyId": {} + } + } + }, + "GenerateRandom": { + "input": { + "type": "structure", + "members": { + "NumberOfBytes": { + "type": "integer" + }, + "CustomKeyStoreId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Plaintext": { + "shape": "S1d" + } + } + } + }, + "GetKeyPolicy": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "PolicyName" + ], + "members": { + "KeyId": {}, + "PolicyName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {} + } + } + }, + "GetKeyRotationStatus": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "KeyRotationEnabled": { + "type": "boolean" + } + } + } + }, + "GetParametersForImport": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "WrappingAlgorithm", + "WrappingKeySpec" + ], + "members": { + "KeyId": {}, + "WrappingAlgorithm": {}, + "WrappingKeySpec": {} + } + }, + "output": { + "type": "structure", + "members": { + "KeyId": {}, + "ImportToken": { + "type": "blob" + }, + "PublicKey": { + "shape": "S1d" + }, + "ParametersValidTo": { + "type": "timestamp" + } + } + } + }, + "ImportKeyMaterial": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "ImportToken", + "EncryptedKeyMaterial" + ], + "members": { + "KeyId": {}, + "ImportToken": { + "type": "blob" + }, + "EncryptedKeyMaterial": { + "type": "blob" + }, + "ValidTo": { + "type": "timestamp" + }, + "ExpirationModel": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListAliases": { + "input": { + "type": "structure", + "members": { + "KeyId": {}, + "Limit": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Aliases": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AliasName": {}, + "AliasArn": {}, + "TargetKeyId": {} + } + } + }, + "NextMarker": {}, + "Truncated": { + "type": "boolean" + } + } + } + }, + "ListGrants": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "Limit": { + "type": "integer" + }, + "Marker": {}, + "KeyId": {} + } + }, + "output": { + "shape": "S2o" + } + }, + "ListKeyPolicies": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {}, + "Limit": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "PolicyNames": { + "type": "list", + "member": {} + }, + "NextMarker": {}, + "Truncated": { + "type": "boolean" + } + } + } + }, + "ListKeys": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Keys": { + "type": "list", + "member": { + "type": "structure", + "members": { + "KeyId": {}, + "KeyArn": {} + } + } + }, + "NextMarker": {}, + "Truncated": { + "type": "boolean" + } + } + } + }, + "ListResourceTags": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {}, + "Limit": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sy" + }, + "NextMarker": {}, + "Truncated": { + "type": "boolean" + } + } + } + }, + "ListRetirableGrants": { + "input": { + "type": "structure", + "required": [ + "RetiringPrincipal" + ], + "members": { + "Limit": { + "type": "integer" + }, + "Marker": {}, + "RetiringPrincipal": {} + } + }, + "output": { + "shape": "S2o" + } + }, + "PutKeyPolicy": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "PolicyName", + "Policy" + ], + "members": { + "KeyId": {}, + "PolicyName": {}, + "Policy": {}, + "BypassPolicyLockoutSafetyCheck": { + "type": "boolean" + } + } + } + }, + "ReEncrypt": { + "input": { + "type": "structure", + "required": [ + "CiphertextBlob", + "DestinationKeyId" + ], + "members": { + "CiphertextBlob": { + "type": "blob" + }, + "SourceEncryptionContext": { + "shape": "Sk" + }, + "DestinationKeyId": {}, + "DestinationEncryptionContext": { + "shape": "Sk" + }, + "GrantTokens": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "CiphertextBlob": { + "type": "blob" + }, + "SourceKeyId": {}, + "KeyId": {} + } + } + }, + "RetireGrant": { + "input": { + "type": "structure", + "members": { + "GrantToken": {}, + "KeyId": {}, + "GrantId": {} + } + } + }, + "RevokeGrant": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "GrantId" + ], + "members": { + "KeyId": {}, + "GrantId": {} + } + } + }, + "ScheduleKeyDeletion": { + "input": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": {}, + "PendingWindowInDays": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyId": {}, + "DeletionDate": { + "type": "timestamp" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "Tags" + ], + "members": { + "KeyId": {}, + "Tags": { + "shape": "Sy" + } + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "TagKeys" + ], + "members": { + "KeyId": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "UpdateAlias": { + "input": { + "type": "structure", + "required": [ + "AliasName", + "TargetKeyId" + ], + "members": { + "AliasName": {}, + "TargetKeyId": {} + } + } + }, + "UpdateCustomKeyStore": { + "input": { + "type": "structure", + "required": [ + "CustomKeyStoreId" + ], + "members": { + "CustomKeyStoreId": {}, + "NewCustomKeyStoreName": {}, + "KeyStorePassword": { + "shape": "Sd" + }, + "CloudHsmClusterId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateKeyDescription": { + "input": { + "type": "structure", + "required": [ + "KeyId", + "Description" + ], + "members": { + "KeyId": {}, + "Description": {} + } + } + } + }, + "shapes": { + "Sd": { + "type": "string", + "sensitive": true + }, + "Sh": { + "type": "list", + "member": {} + }, + "Sj": { + "type": "structure", + "members": { + "EncryptionContextSubset": { + "shape": "Sk" + }, + "EncryptionContextEquals": { + "shape": "Sk" + } + } + }, + "Sk": { + "type": "map", + "key": {}, + "value": {} + }, + "Sn": { + "type": "list", + "member": {} + }, + "Sy": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "TagKey", + "TagValue" + ], + "members": { + "TagKey": {}, + "TagValue": {} + } + } + }, + "S13": { + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "AWSAccountId": {}, + "KeyId": {}, + "Arn": {}, + "CreationDate": { + "type": "timestamp" + }, + "Enabled": { + "type": "boolean" + }, + "Description": {}, + "KeyUsage": {}, + "KeyState": {}, + "DeletionDate": { + "type": "timestamp" + }, + "ValidTo": { + "type": "timestamp" + }, + "Origin": {}, + "CustomKeyStoreId": {}, + "CloudHsmClusterId": {}, + "ExpirationModel": {}, + "KeyManager": {} + } + }, + "S1d": { + "type": "blob", + "sensitive": true + }, + "S2o": { + "type": "structure", + "members": { + "Grants": { + "type": "list", + "member": { + "type": "structure", + "members": { + "KeyId": {}, + "GrantId": {}, + "Name": {}, + "CreationDate": { + "type": "timestamp" + }, + "GranteePrincipal": {}, + "RetiringPrincipal": {}, + "IssuingAccount": {}, + "Operations": { + "shape": "Sh" + }, + "Constraints": { + "shape": "Sj" + } + } + } + }, + "NextMarker": {}, + "Truncated": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/kms-2014-11-01.paginators.json b/node_modules/aws-sdk/apis/kms-2014-11-01.paginators.json new file mode 100644 index 0000000..6b5be67 --- /dev/null +++ b/node_modules/aws-sdk/apis/kms-2014-11-01.paginators.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListAliases": { + "input_token": "Marker", + "limit_key": "Limit", + "more_results": "Truncated", + "output_token": "NextMarker", + "result_key": "Aliases" + }, + "ListGrants": { + "input_token": "Marker", + "limit_key": "Limit", + "more_results": "Truncated", + "output_token": "NextMarker", + "result_key": "Grants" + }, + "ListKeyPolicies": { + "input_token": "Marker", + "limit_key": "Limit", + "more_results": "Truncated", + "output_token": "NextMarker", + "result_key": "PolicyNames" + }, + "ListKeys": { + "input_token": "Marker", + "limit_key": "Limit", + "more_results": "Truncated", + "output_token": "NextMarker", + "result_key": "Keys" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/lambda-2014-11-11.min.json b/node_modules/aws-sdk/apis/lambda-2014-11-11.min.json new file mode 100644 index 0000000..6fd4831 --- /dev/null +++ b/node_modules/aws-sdk/apis/lambda-2014-11-11.min.json @@ -0,0 +1,424 @@ +{ + "metadata": { + "apiVersion": "2014-11-11", + "endpointPrefix": "lambda", + "serviceFullName": "AWS Lambda", + "serviceId": "Lambda", + "signatureVersion": "v4", + "protocol": "rest-json" + }, + "operations": { + "AddEventSource": { + "http": { + "requestUri": "/2014-11-13/event-source-mappings/" + }, + "input": { + "type": "structure", + "required": [ + "EventSource", + "FunctionName", + "Role" + ], + "members": { + "EventSource": {}, + "FunctionName": {}, + "Role": {}, + "BatchSize": { + "type": "integer" + }, + "Parameters": { + "shape": "S6" + } + } + }, + "output": { + "shape": "S7" + } + }, + "DeleteFunction": { + "http": { + "method": "DELETE", + "requestUri": "/2014-11-13/functions/{FunctionName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + } + } + } + }, + "GetEventSource": { + "http": { + "method": "GET", + "requestUri": "/2014-11-13/event-source-mappings/{UUID}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "UUID" + ], + "members": { + "UUID": { + "location": "uri", + "locationName": "UUID" + } + } + }, + "output": { + "shape": "S7" + } + }, + "GetFunction": { + "http": { + "method": "GET", + "requestUri": "/2014-11-13/functions/{FunctionName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Configuration": { + "shape": "Se" + }, + "Code": { + "type": "structure", + "members": { + "RepositoryType": {}, + "Location": {} + } + } + } + } + }, + "GetFunctionConfiguration": { + "http": { + "method": "GET", + "requestUri": "/2014-11-13/functions/{FunctionName}/configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + } + } + }, + "output": { + "shape": "Se" + } + }, + "InvokeAsync": { + "http": { + "requestUri": "/2014-11-13/functions/{FunctionName}/invoke-async/", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "InvokeArgs" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "InvokeArgs": { + "shape": "Sq" + } + }, + "payload": "InvokeArgs" + }, + "output": { + "type": "structure", + "members": { + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "ListEventSources": { + "http": { + "method": "GET", + "requestUri": "/2014-11-13/event-source-mappings/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "EventSourceArn": { + "location": "querystring", + "locationName": "EventSource" + }, + "FunctionName": { + "location": "querystring", + "locationName": "FunctionName" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "EventSources": { + "type": "list", + "member": { + "shape": "S7" + } + } + } + } + }, + "ListFunctions": { + "http": { + "method": "GET", + "requestUri": "/2014-11-13/functions/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Functions": { + "type": "list", + "member": { + "shape": "Se" + } + } + } + } + }, + "RemoveEventSource": { + "http": { + "method": "DELETE", + "requestUri": "/2014-11-13/event-source-mappings/{UUID}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "UUID" + ], + "members": { + "UUID": { + "location": "uri", + "locationName": "UUID" + } + } + } + }, + "UpdateFunctionConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/2014-11-13/functions/{FunctionName}/configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Role": { + "location": "querystring", + "locationName": "Role" + }, + "Handler": { + "location": "querystring", + "locationName": "Handler" + }, + "Description": { + "location": "querystring", + "locationName": "Description" + }, + "Timeout": { + "location": "querystring", + "locationName": "Timeout", + "type": "integer" + }, + "MemorySize": { + "location": "querystring", + "locationName": "MemorySize", + "type": "integer" + } + } + }, + "output": { + "shape": "Se" + } + }, + "UploadFunction": { + "http": { + "method": "PUT", + "requestUri": "/2014-11-13/functions/{FunctionName}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "FunctionZip", + "Runtime", + "Role", + "Handler", + "Mode" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "FunctionZip": { + "shape": "Sq" + }, + "Runtime": { + "location": "querystring", + "locationName": "Runtime" + }, + "Role": { + "location": "querystring", + "locationName": "Role" + }, + "Handler": { + "location": "querystring", + "locationName": "Handler" + }, + "Mode": { + "location": "querystring", + "locationName": "Mode" + }, + "Description": { + "location": "querystring", + "locationName": "Description" + }, + "Timeout": { + "location": "querystring", + "locationName": "Timeout", + "type": "integer" + }, + "MemorySize": { + "location": "querystring", + "locationName": "MemorySize", + "type": "integer" + } + }, + "payload": "FunctionZip" + }, + "output": { + "shape": "Se" + } + } + }, + "shapes": { + "S6": { + "type": "map", + "key": {}, + "value": {} + }, + "S7": { + "type": "structure", + "members": { + "UUID": {}, + "BatchSize": { + "type": "integer" + }, + "EventSource": {}, + "FunctionName": {}, + "Parameters": { + "shape": "S6" + }, + "Role": {}, + "LastModified": { + "type": "timestamp" + }, + "IsActive": { + "type": "boolean" + }, + "Status": {} + } + }, + "Se": { + "type": "structure", + "members": { + "FunctionName": {}, + "FunctionARN": {}, + "ConfigurationId": {}, + "Runtime": {}, + "Role": {}, + "Handler": {}, + "Mode": {}, + "CodeSize": { + "type": "long" + }, + "Description": {}, + "Timeout": { + "type": "integer" + }, + "MemorySize": { + "type": "integer" + }, + "LastModified": { + "type": "timestamp" + } + } + }, + "Sq": { + "type": "blob", + "streaming": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/lambda-2014-11-11.paginators.json b/node_modules/aws-sdk/apis/lambda-2014-11-11.paginators.json new file mode 100644 index 0000000..deaf07d --- /dev/null +++ b/node_modules/aws-sdk/apis/lambda-2014-11-11.paginators.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListEventSources": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "EventSources" + }, + "ListFunctions": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "Functions" + } + } +} diff --git a/node_modules/aws-sdk/apis/lambda-2015-03-31.examples.json b/node_modules/aws-sdk/apis/lambda-2015-03-31.examples.json new file mode 100644 index 0000000..41c4bc6 --- /dev/null +++ b/node_modules/aws-sdk/apis/lambda-2015-03-31.examples.json @@ -0,0 +1,614 @@ +{ + "version": "1.0", + "examples": { + "AddPermission": [ + { + "input": { + "Action": "lambda:InvokeFunction", + "FunctionName": "MyFunction", + "Principal": "s3.amazonaws.com", + "SourceAccount": "123456789012", + "SourceArn": "arn:aws:s3:::examplebucket/*", + "StatementId": "ID-1" + }, + "output": { + "Statement": "ID-1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a permission for an S3 bucket to invoke a Lambda function.", + "id": "add-permission-1474651469455", + "title": "add-permission" + } + ], + "CreateFunction": [ + { + "input": { + "Code": { + }, + "Description": "", + "FunctionName": "MyFunction", + "Handler": "souce_file.handler_name", + "MemorySize": 128, + "Publish": true, + "Role": "arn:aws:iam::123456789012:role/service-role/role-name", + "Runtime": "nodejs8.10", + "Timeout": 15, + "VpcConfig": { + } + }, + "output": { + "CodeSha256": "", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:MyFunction", + "FunctionName": "MyFunction", + "Handler": "source_file.handler_name", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/service-role/role-name", + "Runtime": "nodejs8.10", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + "Handler": "is of the form of the name of your source file and then name of your function handler", + "Role": "replace with the actual arn of the execution role you created" + }, + "output": { + } + }, + "description": "This example creates a Lambda function.", + "id": "create-function-1474653449931", + "title": "create-function" + } + ], + "DeleteAlias": [ + { + "input": { + "FunctionName": "myFunction", + "Name": "alias" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Lambda function alias", + "id": "to-delete-a-lambda-function-alias-1481660370804", + "title": "To delete a Lambda function alias" + } + ], + "DeleteEventSourceMapping": [ + { + "input": { + "UUID": "12345kxodurf3443" + }, + "output": { + "BatchSize": 123, + "EventSourceArn": "arn:aws:s3:::examplebucket/*", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "LastModified": "2016-11-21T19:49:20.006+0000", + "LastProcessingResult": "", + "State": "", + "StateTransitionReason": "", + "UUID": "12345kxodurf3443" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Lambda function event source mapping", + "id": "to-delete-a-lambda-function-event-source-mapping-1481658973862", + "title": "To delete a Lambda function event source mapping" + } + ], + "DeleteFunction": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Lambda function", + "id": "to-delete-a-lambda-function-1481648553696", + "title": "To delete a Lambda function" + } + ], + "GetAccountSettings": [ + { + "input": { + }, + "output": { + "AccountLimit": { + }, + "AccountUsage": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda customer's account settings", + "id": "to-retrieves-a-lambda-customers-account-settings-1481657495274", + "title": "To retrieves a Lambda customer's account settings" + } + ], + "GetAlias": [ + { + "input": { + "FunctionName": "myFunction", + "Name": "myFunctionAlias" + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias", + "Description": "", + "FunctionVersion": "1", + "Name": "myFunctionAlias" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function alias", + "id": "to-retrieve-a-lambda-function-alias-1481648742254", + "title": "To retrieve a Lambda function alias" + } + ], + "GetEventSourceMapping": [ + { + "input": { + "UUID": "123489-xxxxx-kdla8d89d7" + }, + "output": { + "BatchSize": 123, + "EventSourceArn": "arn:aws:iam::123456789012:eventsource", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "LastModified": "2016-11-21T19:49:20.006+0000", + "LastProcessingResult": "", + "State": "", + "StateTransitionReason": "", + "UUID": "123489-xxxxx-kdla8d89d7" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's event source mapping", + "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799", + "title": "To retrieve a Lambda function's event source mapping" + } + ], + "GetFunction": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "output": { + "Code": { + "Location": "somelocation", + "RepositoryType": "S3" + }, + "Configuration": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 262, + "Description": "A starter AWS Lambda function.", + "Environment": { + "Variables": { + "S3_BUCKET": "test" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "nodejs8.10", + "Timeout": 3, + "Version": "$LATEST", + "VpcConfig": { + "SecurityGroupIds": [ + + ], + "SubnetIds": [ + + ] + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's event source mapping", + "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799", + "title": "To retrieve a Lambda function's event source mapping" + } + ], + "GetFunctionConfiguration": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "output": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 123, + "DeadLetterConfig": { + }, + "Description": "", + "Environment": { + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "KMSKeyArn": "", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's event source mapping", + "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799", + "title": "To retrieve a Lambda function's event source mapping" + } + ], + "GetPolicy": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "output": { + "Policy": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function policy", + "id": "to-retrieve-a-lambda-function-policy-1481649319053", + "title": "To retrieve a Lambda function policy" + } + ], + "Invoke": [ + { + "input": { + "ClientContext": "MyApp", + "FunctionName": "MyFunction", + "InvocationType": "Event", + "LogType": "Tail", + "Payload": "fileb://file-path/input.json", + "Qualifier": "1" + }, + "output": { + "FunctionError": "", + "LogResult": "", + "Payload": "?", + "StatusCode": 123 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation invokes a Lambda function", + "id": "to-invoke-a-lambda-function-1481659683915", + "title": "To invoke a Lambda function" + } + ], + "InvokeAsync": [ + { + "input": { + "FunctionName": "myFunction", + "InvokeArgs": "fileb://file-path/input.json" + }, + "output": { + "Status": 123 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation invokes a Lambda function asynchronously", + "id": "to-invoke-a-lambda-function-asynchronously-1481649694923", + "title": "To invoke a Lambda function asynchronously" + } + ], + "ListAliases": [ + { + "input": { + "FunctionName": "myFunction", + "FunctionVersion": "1", + "Marker": "", + "MaxItems": 123 + }, + "output": { + "Aliases": [ + + ], + "NextMarker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's aliases", + "id": "to-retrieve-a-lambda-function-aliases-1481650199732", + "title": "To retrieve a Lambda function aliases" + } + ], + "ListFunctions": [ + { + "input": { + "Marker": "", + "MaxItems": 123 + }, + "output": { + "Functions": [ + + ], + "NextMarker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda functions", + "id": "to-retrieve-a-list-of-lambda-functions-1481650507425", + "title": "To retrieve a list of Lambda functions" + } + ], + "ListVersionsByFunction": [ + { + "input": { + "FunctionName": "myFunction", + "Marker": "", + "MaxItems": 123 + }, + "output": { + "NextMarker": "", + "Versions": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function versions", + "id": "to-retrieve-a-list-of-lambda-function-versions-1481650603750", + "title": "To retrieve a list of Lambda function versions" + } + ], + "PublishVersion": [ + { + "input": { + "CodeSha256": "", + "Description": "", + "FunctionName": "myFunction" + }, + "output": { + "CodeSha256": "", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation publishes a version of a Lambda function", + "id": "to-publish-a-version-of-a-lambda-function-1481650704986", + "title": "To publish a version of a Lambda function" + } + ], + "RemovePermission": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1", + "StatementId": "role-statement-id" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation removes a Lambda function's permissions", + "id": "to-remove-a-lambda-functions-permissions-1481661337021", + "title": "To remove a Lambda function's permissions" + } + ], + "UpdateAlias": [ + { + "input": { + "Description": "", + "FunctionName": "myFunction", + "FunctionVersion": "1", + "Name": "functionAlias" + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:functionAlias", + "Description": "", + "FunctionVersion": "1", + "Name": "functionAlias" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function alias", + "id": "to-update-a-lambda-function-alias-1481650817950", + "title": "To update a Lambda function alias" + } + ], + "UpdateEventSourceMapping": [ + { + "input": { + "BatchSize": 123, + "Enabled": true, + "FunctionName": "myFunction", + "UUID": "1234xCy789012" + }, + "output": { + "BatchSize": 123, + "EventSourceArn": "arn:aws:s3:::examplebucket/*", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "LastModified": "2016-11-21T19:49:20.006+0000", + "LastProcessingResult": "", + "State": "", + "StateTransitionReason": "", + "UUID": "1234xCy789012" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function event source mapping", + "id": "to-update-a-lambda-function-event-source-mapping-1481650907413", + "title": "To update a Lambda function event source mapping" + } + ], + "UpdateFunctionCode": [ + { + "input": { + "FunctionName": "myFunction", + "Publish": true, + "S3Bucket": "myBucket", + "S3Key": "myKey", + "S3ObjectVersion": "1", + "ZipFile": "fileb://file-path/file.zip" + }, + "output": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function's code", + "id": "to-update-a-lambda-functions-code-1481650992672", + "title": "To update a Lambda function's code" + } + ], + "UpdateFunctionConfiguration": [ + { + "input": { + "Description": "", + "FunctionName": "myFunction", + "Handler": "index.handler", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "VpcConfig": { + } + }, + "output": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function's configuration", + "id": "to-update-a-lambda-functions-configuration-1481651096447", + "title": "To update a Lambda function's configuration" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json b/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json new file mode 100644 index 0000000..2264ae1 --- /dev/null +++ b/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json @@ -0,0 +1,1592 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-03-31", + "endpointPrefix": "lambda", + "protocol": "rest-json", + "serviceFullName": "AWS Lambda", + "serviceId": "Lambda", + "signatureVersion": "v4", + "uid": "lambda-2015-03-31" + }, + "operations": { + "AddLayerVersionPermission": { + "http": { + "requestUri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "LayerName", + "VersionNumber", + "StatementId", + "Action", + "Principal" + ], + "members": { + "LayerName": { + "location": "uri", + "locationName": "LayerName" + }, + "VersionNumber": { + "location": "uri", + "locationName": "VersionNumber", + "type": "long" + }, + "StatementId": {}, + "Action": {}, + "Principal": {}, + "OrganizationId": {}, + "RevisionId": { + "location": "querystring", + "locationName": "RevisionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Statement": {}, + "RevisionId": {} + } + } + }, + "AddPermission": { + "http": { + "requestUri": "/2015-03-31/functions/{FunctionName}/policy", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "StatementId", + "Action", + "Principal" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "StatementId": {}, + "Action": {}, + "Principal": {}, + "SourceArn": {}, + "SourceAccount": {}, + "EventSourceToken": {}, + "Qualifier": { + "location": "querystring", + "locationName": "Qualifier" + }, + "RevisionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Statement": {} + } + } + }, + "CreateAlias": { + "http": { + "requestUri": "/2015-03-31/functions/{FunctionName}/aliases", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "Name", + "FunctionVersion" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Name": {}, + "FunctionVersion": {}, + "Description": {}, + "RoutingConfig": { + "shape": "Sn" + } + } + }, + "output": { + "shape": "Sr" + } + }, + "CreateEventSourceMapping": { + "http": { + "requestUri": "/2015-03-31/event-source-mappings/", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "EventSourceArn", + "FunctionName" + ], + "members": { + "EventSourceArn": {}, + "FunctionName": {}, + "Enabled": { + "type": "boolean" + }, + "BatchSize": { + "type": "integer" + }, + "StartingPosition": {}, + "StartingPositionTimestamp": { + "type": "timestamp" + } + } + }, + "output": { + "shape": "Sy" + } + }, + "CreateFunction": { + "http": { + "requestUri": "/2015-03-31/functions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "Runtime", + "Role", + "Handler", + "Code" + ], + "members": { + "FunctionName": {}, + "Runtime": {}, + "Role": {}, + "Handler": {}, + "Code": { + "type": "structure", + "members": { + "ZipFile": { + "shape": "S14" + }, + "S3Bucket": {}, + "S3Key": {}, + "S3ObjectVersion": {} + } + }, + "Description": {}, + "Timeout": { + "type": "integer" + }, + "MemorySize": { + "type": "integer" + }, + "Publish": { + "type": "boolean" + }, + "VpcConfig": { + "shape": "S1b" + }, + "DeadLetterConfig": { + "shape": "S1g" + }, + "Environment": { + "shape": "S1i" + }, + "KMSKeyArn": {}, + "TracingConfig": { + "shape": "S1n" + }, + "Tags": { + "shape": "S1p" + }, + "Layers": { + "shape": "S1s" + } + } + }, + "output": { + "shape": "S1u" + } + }, + "DeleteAlias": { + "http": { + "method": "DELETE", + "requestUri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "Name" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Name": { + "location": "uri", + "locationName": "Name" + } + } + } + }, + "DeleteEventSourceMapping": { + "http": { + "method": "DELETE", + "requestUri": "/2015-03-31/event-source-mappings/{UUID}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "UUID" + ], + "members": { + "UUID": { + "location": "uri", + "locationName": "UUID" + } + } + }, + "output": { + "shape": "Sy" + } + }, + "DeleteFunction": { + "http": { + "method": "DELETE", + "requestUri": "/2015-03-31/functions/{FunctionName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Qualifier": { + "location": "querystring", + "locationName": "Qualifier" + } + } + } + }, + "DeleteFunctionConcurrency": { + "http": { + "method": "DELETE", + "requestUri": "/2017-10-31/functions/{FunctionName}/concurrency", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + } + } + } + }, + "DeleteLayerVersion": { + "http": { + "method": "DELETE", + "requestUri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "LayerName", + "VersionNumber" + ], + "members": { + "LayerName": { + "location": "uri", + "locationName": "LayerName" + }, + "VersionNumber": { + "location": "uri", + "locationName": "VersionNumber", + "type": "long" + } + } + } + }, + "GetAccountSettings": { + "http": { + "method": "GET", + "requestUri": "/2016-08-19/account-settings/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AccountLimit": { + "type": "structure", + "members": { + "TotalCodeSize": { + "type": "long" + }, + "CodeSizeUnzipped": { + "type": "long" + }, + "CodeSizeZipped": { + "type": "long" + }, + "ConcurrentExecutions": { + "type": "integer" + }, + "UnreservedConcurrentExecutions": { + "type": "integer" + } + } + }, + "AccountUsage": { + "type": "structure", + "members": { + "TotalCodeSize": { + "type": "long" + }, + "FunctionCount": { + "type": "long" + } + } + } + } + } + }, + "GetAlias": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "Name" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Name": { + "location": "uri", + "locationName": "Name" + } + } + }, + "output": { + "shape": "Sr" + } + }, + "GetEventSourceMapping": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/event-source-mappings/{UUID}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "UUID" + ], + "members": { + "UUID": { + "location": "uri", + "locationName": "UUID" + } + } + }, + "output": { + "shape": "Sy" + } + }, + "GetFunction": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/functions/{FunctionName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Qualifier": { + "location": "querystring", + "locationName": "Qualifier" + } + } + }, + "output": { + "type": "structure", + "members": { + "Configuration": { + "shape": "S1u" + }, + "Code": { + "type": "structure", + "members": { + "RepositoryType": {}, + "Location": {} + } + }, + "Tags": { + "shape": "S1p" + }, + "Concurrency": { + "shape": "S2n" + } + } + } + }, + "GetFunctionConfiguration": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/functions/{FunctionName}/configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Qualifier": { + "location": "querystring", + "locationName": "Qualifier" + } + } + }, + "output": { + "shape": "S1u" + } + }, + "GetLayerVersion": { + "http": { + "method": "GET", + "requestUri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "LayerName", + "VersionNumber" + ], + "members": { + "LayerName": { + "location": "uri", + "locationName": "LayerName" + }, + "VersionNumber": { + "location": "uri", + "locationName": "VersionNumber", + "type": "long" + } + } + }, + "output": { + "shape": "S2r" + } + }, + "GetLayerVersionByArn": { + "http": { + "method": "GET", + "requestUri": "/2018-10-31/layers?find=LayerVersion", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": { + "location": "querystring", + "locationName": "Arn" + } + } + }, + "output": { + "shape": "S2r" + } + }, + "GetLayerVersionPolicy": { + "http": { + "method": "GET", + "requestUri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "LayerName", + "VersionNumber" + ], + "members": { + "LayerName": { + "location": "uri", + "locationName": "LayerName" + }, + "VersionNumber": { + "location": "uri", + "locationName": "VersionNumber", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {}, + "RevisionId": {} + } + } + }, + "GetPolicy": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/functions/{FunctionName}/policy", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Qualifier": { + "location": "querystring", + "locationName": "Qualifier" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {}, + "RevisionId": {} + } + } + }, + "Invoke": { + "http": { + "requestUri": "/2015-03-31/functions/{FunctionName}/invocations" + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "InvocationType": { + "location": "header", + "locationName": "X-Amz-Invocation-Type" + }, + "LogType": { + "location": "header", + "locationName": "X-Amz-Log-Type" + }, + "ClientContext": { + "location": "header", + "locationName": "X-Amz-Client-Context" + }, + "Payload": { + "shape": "S14" + }, + "Qualifier": { + "location": "querystring", + "locationName": "Qualifier" + } + }, + "payload": "Payload" + }, + "output": { + "type": "structure", + "members": { + "StatusCode": { + "location": "statusCode", + "type": "integer" + }, + "FunctionError": { + "location": "header", + "locationName": "X-Amz-Function-Error" + }, + "LogResult": { + "location": "header", + "locationName": "X-Amz-Log-Result" + }, + "Payload": { + "shape": "S14" + }, + "ExecutedVersion": { + "location": "header", + "locationName": "X-Amz-Executed-Version" + } + }, + "payload": "Payload" + } + }, + "InvokeAsync": { + "http": { + "requestUri": "/2014-11-13/functions/{FunctionName}/invoke-async/", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "InvokeArgs" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "InvokeArgs": { + "type": "blob", + "streaming": true + } + }, + "deprecated": true, + "payload": "InvokeArgs" + }, + "output": { + "type": "structure", + "members": { + "Status": { + "location": "statusCode", + "type": "integer" + } + }, + "deprecated": true + }, + "deprecated": true + }, + "ListAliases": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/functions/{FunctionName}/aliases", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "FunctionVersion": { + "location": "querystring", + "locationName": "FunctionVersion" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Aliases": { + "type": "list", + "member": { + "shape": "Sr" + } + } + } + } + }, + "ListEventSourceMappings": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/event-source-mappings/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "EventSourceArn": { + "location": "querystring", + "locationName": "EventSourceArn" + }, + "FunctionName": { + "location": "querystring", + "locationName": "FunctionName" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "EventSourceMappings": { + "type": "list", + "member": { + "shape": "Sy" + } + } + } + } + }, + "ListFunctions": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/functions/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MasterRegion": { + "location": "querystring", + "locationName": "MasterRegion" + }, + "FunctionVersion": { + "location": "querystring", + "locationName": "FunctionVersion" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Functions": { + "shape": "S3k" + } + } + } + }, + "ListLayerVersions": { + "http": { + "method": "GET", + "requestUri": "/2018-10-31/layers/{LayerName}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "LayerName" + ], + "members": { + "CompatibleRuntime": { + "location": "querystring", + "locationName": "CompatibleRuntime" + }, + "LayerName": { + "location": "uri", + "locationName": "LayerName" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "LayerVersions": { + "type": "list", + "member": { + "shape": "S3p" + } + } + } + } + }, + "ListLayers": { + "http": { + "method": "GET", + "requestUri": "/2018-10-31/layers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CompatibleRuntime": { + "location": "querystring", + "locationName": "CompatibleRuntime" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Layers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LayerName": {}, + "LayerArn": {}, + "LatestMatchingVersion": { + "shape": "S3p" + } + } + } + } + } + } + }, + "ListTags": { + "http": { + "method": "GET", + "requestUri": "/2017-03-31/tags/{ARN}" + }, + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": { + "location": "uri", + "locationName": "ARN" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S1p" + } + } + } + }, + "ListVersionsByFunction": { + "http": { + "method": "GET", + "requestUri": "/2015-03-31/functions/{FunctionName}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Versions": { + "shape": "S3k" + } + } + } + }, + "PublishLayerVersion": { + "http": { + "requestUri": "/2018-10-31/layers/{LayerName}/versions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "LayerName", + "Content" + ], + "members": { + "LayerName": { + "location": "uri", + "locationName": "LayerName" + }, + "Description": {}, + "Content": { + "type": "structure", + "members": { + "S3Bucket": {}, + "S3Key": {}, + "S3ObjectVersion": {}, + "ZipFile": { + "shape": "S14" + } + } + }, + "CompatibleRuntimes": { + "shape": "S2u" + }, + "LicenseInfo": {} + } + }, + "output": { + "type": "structure", + "members": { + "Content": { + "shape": "S2s" + }, + "LayerArn": {}, + "LayerVersionArn": {}, + "Description": {}, + "CreatedDate": {}, + "Version": { + "type": "long" + }, + "CompatibleRuntimes": { + "shape": "S2u" + }, + "LicenseInfo": {} + } + } + }, + "PublishVersion": { + "http": { + "requestUri": "/2015-03-31/functions/{FunctionName}/versions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "CodeSha256": {}, + "Description": {}, + "RevisionId": {} + } + }, + "output": { + "shape": "S1u" + } + }, + "PutFunctionConcurrency": { + "http": { + "method": "PUT", + "requestUri": "/2017-10-31/functions/{FunctionName}/concurrency", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "ReservedConcurrentExecutions" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "ReservedConcurrentExecutions": { + "type": "integer" + } + } + }, + "output": { + "shape": "S2n" + } + }, + "RemoveLayerVersionPermission": { + "http": { + "method": "DELETE", + "requestUri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "LayerName", + "VersionNumber", + "StatementId" + ], + "members": { + "LayerName": { + "location": "uri", + "locationName": "LayerName" + }, + "VersionNumber": { + "location": "uri", + "locationName": "VersionNumber", + "type": "long" + }, + "StatementId": { + "location": "uri", + "locationName": "StatementId" + }, + "RevisionId": { + "location": "querystring", + "locationName": "RevisionId" + } + } + } + }, + "RemovePermission": { + "http": { + "method": "DELETE", + "requestUri": "/2015-03-31/functions/{FunctionName}/policy/{StatementId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "StatementId" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "StatementId": { + "location": "uri", + "locationName": "StatementId" + }, + "Qualifier": { + "location": "querystring", + "locationName": "Qualifier" + }, + "RevisionId": { + "location": "querystring", + "locationName": "RevisionId" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/2017-03-31/tags/{ARN}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "Tags" + ], + "members": { + "Resource": { + "location": "uri", + "locationName": "ARN" + }, + "Tags": { + "shape": "S1p" + } + } + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/2017-03-31/tags/{ARN}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Resource", + "TagKeys" + ], + "members": { + "Resource": { + "location": "uri", + "locationName": "ARN" + }, + "TagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "type": "list", + "member": {} + } + } + } + }, + "UpdateAlias": { + "http": { + "method": "PUT", + "requestUri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName", + "Name" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Name": { + "location": "uri", + "locationName": "Name" + }, + "FunctionVersion": {}, + "Description": {}, + "RoutingConfig": { + "shape": "Sn" + }, + "RevisionId": {} + } + }, + "output": { + "shape": "Sr" + } + }, + "UpdateEventSourceMapping": { + "http": { + "method": "PUT", + "requestUri": "/2015-03-31/event-source-mappings/{UUID}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "UUID" + ], + "members": { + "UUID": { + "location": "uri", + "locationName": "UUID" + }, + "FunctionName": {}, + "Enabled": { + "type": "boolean" + }, + "BatchSize": { + "type": "integer" + } + } + }, + "output": { + "shape": "Sy" + } + }, + "UpdateFunctionCode": { + "http": { + "method": "PUT", + "requestUri": "/2015-03-31/functions/{FunctionName}/code", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "ZipFile": { + "shape": "S14" + }, + "S3Bucket": {}, + "S3Key": {}, + "S3ObjectVersion": {}, + "Publish": { + "type": "boolean" + }, + "DryRun": { + "type": "boolean" + }, + "RevisionId": {} + } + }, + "output": { + "shape": "S1u" + } + }, + "UpdateFunctionConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/2015-03-31/functions/{FunctionName}/configuration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FunctionName" + ], + "members": { + "FunctionName": { + "location": "uri", + "locationName": "FunctionName" + }, + "Role": {}, + "Handler": {}, + "Description": {}, + "Timeout": { + "type": "integer" + }, + "MemorySize": { + "type": "integer" + }, + "VpcConfig": { + "shape": "S1b" + }, + "Environment": { + "shape": "S1i" + }, + "Runtime": {}, + "DeadLetterConfig": { + "shape": "S1g" + }, + "KMSKeyArn": {}, + "TracingConfig": { + "shape": "S1n" + }, + "RevisionId": {}, + "Layers": { + "shape": "S1s" + } + } + }, + "output": { + "shape": "S1u" + } + } + }, + "shapes": { + "Sn": { + "type": "structure", + "members": { + "AdditionalVersionWeights": { + "type": "map", + "key": {}, + "value": { + "type": "double" + } + } + } + }, + "Sr": { + "type": "structure", + "members": { + "AliasArn": {}, + "Name": {}, + "FunctionVersion": {}, + "Description": {}, + "RoutingConfig": { + "shape": "Sn" + }, + "RevisionId": {} + } + }, + "Sy": { + "type": "structure", + "members": { + "UUID": {}, + "BatchSize": { + "type": "integer" + }, + "EventSourceArn": {}, + "FunctionArn": {}, + "LastModified": { + "type": "timestamp" + }, + "LastProcessingResult": {}, + "State": {}, + "StateTransitionReason": {} + } + }, + "S14": { + "type": "blob", + "sensitive": true + }, + "S1b": { + "type": "structure", + "members": { + "SubnetIds": { + "shape": "S1c" + }, + "SecurityGroupIds": { + "shape": "S1e" + } + } + }, + "S1c": { + "type": "list", + "member": {} + }, + "S1e": { + "type": "list", + "member": {} + }, + "S1g": { + "type": "structure", + "members": { + "TargetArn": {} + } + }, + "S1i": { + "type": "structure", + "members": { + "Variables": { + "shape": "S1j" + } + } + }, + "S1j": { + "type": "map", + "key": { + "type": "string", + "sensitive": true + }, + "value": { + "type": "string", + "sensitive": true + }, + "sensitive": true + }, + "S1n": { + "type": "structure", + "members": { + "Mode": {} + } + }, + "S1p": { + "type": "map", + "key": {}, + "value": {} + }, + "S1s": { + "type": "list", + "member": {} + }, + "S1u": { + "type": "structure", + "members": { + "FunctionName": {}, + "FunctionArn": {}, + "Runtime": {}, + "Role": {}, + "Handler": {}, + "CodeSize": { + "type": "long" + }, + "Description": {}, + "Timeout": { + "type": "integer" + }, + "MemorySize": { + "type": "integer" + }, + "LastModified": {}, + "CodeSha256": {}, + "Version": {}, + "VpcConfig": { + "type": "structure", + "members": { + "SubnetIds": { + "shape": "S1c" + }, + "SecurityGroupIds": { + "shape": "S1e" + }, + "VpcId": {} + } + }, + "DeadLetterConfig": { + "shape": "S1g" + }, + "Environment": { + "type": "structure", + "members": { + "Variables": { + "shape": "S1j" + }, + "Error": { + "type": "structure", + "members": { + "ErrorCode": {}, + "Message": { + "type": "string", + "sensitive": true + } + } + } + } + }, + "KMSKeyArn": {}, + "TracingConfig": { + "type": "structure", + "members": { + "Mode": {} + } + }, + "MasterArn": {}, + "RevisionId": {}, + "Layers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "CodeSize": { + "type": "long" + } + } + } + } + } + }, + "S2n": { + "type": "structure", + "members": { + "ReservedConcurrentExecutions": { + "type": "integer" + } + } + }, + "S2r": { + "type": "structure", + "members": { + "Content": { + "shape": "S2s" + }, + "LayerArn": {}, + "LayerVersionArn": {}, + "Description": {}, + "CreatedDate": {}, + "Version": { + "type": "long" + }, + "CompatibleRuntimes": { + "shape": "S2u" + }, + "LicenseInfo": {} + } + }, + "S2s": { + "type": "structure", + "members": { + "Location": {}, + "CodeSha256": {}, + "CodeSize": { + "type": "long" + } + } + }, + "S2u": { + "type": "list", + "member": {} + }, + "S3k": { + "type": "list", + "member": { + "shape": "S1u" + } + }, + "S3p": { + "type": "structure", + "members": { + "LayerVersionArn": {}, + "Version": { + "type": "long" + }, + "Description": {}, + "CreatedDate": {}, + "CompatibleRuntimes": { + "shape": "S2u" + }, + "LicenseInfo": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/lambda-2015-03-31.paginators.json b/node_modules/aws-sdk/apis/lambda-2015-03-31.paginators.json new file mode 100644 index 0000000..a667b8a --- /dev/null +++ b/node_modules/aws-sdk/apis/lambda-2015-03-31.paginators.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListEventSourceMappings": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextMarker", + "result_key": "EventSourceMappings" + }, + "ListFunctions": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextMarker", + "result_key": "Functions" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/lex-models-2017-04-19.examples.json b/node_modules/aws-sdk/apis/lex-models-2017-04-19.examples.json new file mode 100644 index 0000000..4a56e6e --- /dev/null +++ b/node_modules/aws-sdk/apis/lex-models-2017-04-19.examples.json @@ -0,0 +1,758 @@ +{ + "version": "1.0", + "examples": { + "GetBot": [ + { + "input": { + "name": "DocOrderPizza", + "versionOrAlias": "$LATEST" + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizzaBot", + "abortStatement": { + "messages": [ + { + "content": "I don't understand. Can you try again?", + "contentType": "PlainText" + }, + { + "content": "I'm sorry, I don't understand.", + "contentType": "PlainText" + } + ] + }, + "checksum": "20172ee3-fa06-49b2-bbc5-667c090303e9", + "childDirected": true, + "clarificationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "I'm sorry, I didn't hear that. Can you repeate what you just said?", + "contentType": "PlainText" + }, + { + "content": "Can you say that again?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494360160.133, + "description": "Orders a pizza from a local pizzeria.", + "idleSessionTTLInSeconds": 300, + "intents": [ + { + "intentName": "DocOrderPizza", + "intentVersion": "$LATEST" + } + ], + "lastUpdatedDate": 1494360160.133, + "locale": "en-US", + "status": "NOT_BUILT" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get configuration information for a bot.", + "id": "to-get-information-about-a-bot-1494431724188", + "title": "To get information about a bot" + } + ], + "GetBots": [ + { + "input": { + "maxResults": 5, + "nextToken": "" + }, + "output": { + "bots": [ + { + "version": "$LATEST", + "name": "DocOrderPizzaBot", + "createdDate": 1494360160.133, + "description": "Orders a pizza from a local pizzeria.", + "lastUpdatedDate": 1494360160.133, + "status": "NOT_BUILT" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get a list of all of the bots in your account.", + "id": "to-get-a-list-of-bots-1494432220036", + "title": "To get a list of bots" + } + ], + "GetIntent": [ + { + "input": { + "version": "$LATEST", + "name": "DocOrderPizza" + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizza", + "checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", + "conclusionStatement": { + "messages": [ + { + "content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.", + "contentType": "PlainText" + }, + { + "content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", + "contentType": "PlainText" + } + ], + "responseCard": "foo" + }, + "confirmationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494359783.453, + "description": "Order a pizza from a local pizzeria.", + "fulfillmentActivity": { + "type": "ReturnIntent" + }, + "lastUpdatedDate": 1494359783.453, + "rejectionStatement": { + "messages": [ + { + "content": "Ok, I'll cancel your order.", + "contentType": "PlainText" + }, + { + "content": "I cancelled your order.", + "contentType": "PlainText" + } + ] + }, + "sampleUtterances": [ + "Order me a pizza.", + "Order me a {Type} pizza.", + "I want a {Crust} crust {Type} pizza", + "I want a {Crust} crust {Type} pizza with {Sauce} sauce." + ], + "slots": [ + { + "name": "Type", + "description": "The type of pizza to order.", + "priority": 1, + "sampleUtterances": [ + "Get me a {Type} pizza.", + "A {Type} pizza please.", + "I'd like a {Type} pizza." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of pizza would you like?", + "contentType": "PlainText" + }, + { + "content": "Vegie or cheese pizza?", + "contentType": "PlainText" + }, + { + "content": "I can get you a vegie or a cheese pizza.", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Crust", + "description": "The type of pizza crust to order.", + "priority": 2, + "sampleUtterances": [ + "Make it a {Crust} crust.", + "I'd like a {Crust} crust." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaCrustType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of crust would you like?", + "contentType": "PlainText" + }, + { + "content": "Thick or thin crust?", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Sauce", + "description": "The type of sauce to use on the pizza.", + "priority": 3, + "sampleUtterances": [ + "Make it {Sauce} sauce.", + "I'd like {Sauce} sauce." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaSauceType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "White or red sauce?", + "contentType": "PlainText" + }, + { + "content": "Garlic or tomato sauce?", + "contentType": "PlainText" + } + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get information about an intent.", + "id": "to-get-a-information-about-an-intent-1494432574147", + "title": "To get a information about an intent" + } + ], + "GetIntents": [ + { + "input": { + "maxResults": 10, + "nextToken": "" + }, + "output": { + "intents": [ + { + "version": "$LATEST", + "name": "DocOrderPizza", + "createdDate": 1494359783.453, + "description": "Order a pizza from a local pizzeria.", + "lastUpdatedDate": 1494359783.453 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get a list of all of the intents in your account.", + "id": "to-get-a-list-of-intents-1494432416363", + "title": "To get a list of intents" + } + ], + "GetSlotType": [ + { + "input": { + "version": "$LATEST", + "name": "DocPizzaCrustType" + }, + "output": { + "version": "$LATEST", + "name": "DocPizzaCrustType", + "checksum": "210b3d5a-90a3-4b22-ac7e-f50c2c71095f", + "createdDate": 1494359274.403, + "description": "Available crust types", + "enumerationValues": [ + { + "value": "thick" + }, + { + "value": "thin" + } + ], + "lastUpdatedDate": 1494359274.403 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get information about a slot type.", + "id": "to-get-information-about-a-slot-type-1494432961004", + "title": "To get information about a slot type" + } + ], + "GetSlotTypes": [ + { + "input": { + "maxResults": 10, + "nextToken": "" + }, + "output": { + "slotTypes": [ + { + "version": "$LATEST", + "name": "DocPizzaCrustType", + "createdDate": 1494359274.403, + "description": "Available crust types", + "lastUpdatedDate": 1494359274.403 + }, + { + "version": "$LATEST", + "name": "DocPizzaSauceType", + "createdDate": 1494356442.23, + "description": "Available pizza sauces", + "lastUpdatedDate": 1494356442.23 + }, + { + "version": "$LATEST", + "name": "DocPizzaType", + "createdDate": 1494359198.656, + "description": "Available pizzas", + "lastUpdatedDate": 1494359198.656 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to get a list of all of the slot types in your account.", + "id": "to-get-a-list-of-slot-types-1494432757458", + "title": "To get a list of slot types" + } + ], + "PutBot": [ + { + "input": { + "name": "DocOrderPizzaBot", + "abortStatement": { + "messages": [ + { + "content": "I don't understand. Can you try again?", + "contentType": "PlainText" + }, + { + "content": "I'm sorry, I don't understand.", + "contentType": "PlainText" + } + ] + }, + "childDirected": true, + "clarificationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "I'm sorry, I didn't hear that. Can you repeate what you just said?", + "contentType": "PlainText" + }, + { + "content": "Can you say that again?", + "contentType": "PlainText" + } + ] + }, + "description": "Orders a pizza from a local pizzeria.", + "idleSessionTTLInSeconds": 300, + "intents": [ + { + "intentName": "DocOrderPizza", + "intentVersion": "$LATEST" + } + ], + "locale": "en-US", + "processBehavior": "SAVE" + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizzaBot", + "abortStatement": { + "messages": [ + { + "content": "I don't understand. Can you try again?", + "contentType": "PlainText" + }, + { + "content": "I'm sorry, I don't understand.", + "contentType": "PlainText" + } + ] + }, + "checksum": "20172ee3-fa06-49b2-bbc5-667c090303e9", + "childDirected": true, + "clarificationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "I'm sorry, I didn't hear that. Can you repeate what you just said?", + "contentType": "PlainText" + }, + { + "content": "Can you say that again?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494360160.133, + "description": "Orders a pizza from a local pizzeria.", + "idleSessionTTLInSeconds": 300, + "intents": [ + { + "intentName": "DocOrderPizza", + "intentVersion": "$LATEST" + } + ], + "lastUpdatedDate": 1494360160.133, + "locale": "en-US", + "status": "NOT_BUILT" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to create a bot for ordering pizzas.", + "id": "to-create-a-bot-1494360003886", + "title": "To create a bot" + } + ], + "PutIntent": [ + { + "input": { + "name": "DocOrderPizza", + "conclusionStatement": { + "messages": [ + { + "content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.", + "contentType": "PlainText" + }, + { + "content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", + "contentType": "PlainText" + } + ], + "responseCard": "foo" + }, + "confirmationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?", + "contentType": "PlainText" + } + ] + }, + "description": "Order a pizza from a local pizzeria.", + "fulfillmentActivity": { + "type": "ReturnIntent" + }, + "rejectionStatement": { + "messages": [ + { + "content": "Ok, I'll cancel your order.", + "contentType": "PlainText" + }, + { + "content": "I cancelled your order.", + "contentType": "PlainText" + } + ] + }, + "sampleUtterances": [ + "Order me a pizza.", + "Order me a {Type} pizza.", + "I want a {Crust} crust {Type} pizza", + "I want a {Crust} crust {Type} pizza with {Sauce} sauce." + ], + "slots": [ + { + "name": "Type", + "description": "The type of pizza to order.", + "priority": 1, + "sampleUtterances": [ + "Get me a {Type} pizza.", + "A {Type} pizza please.", + "I'd like a {Type} pizza." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of pizza would you like?", + "contentType": "PlainText" + }, + { + "content": "Vegie or cheese pizza?", + "contentType": "PlainText" + }, + { + "content": "I can get you a vegie or a cheese pizza.", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Crust", + "description": "The type of pizza crust to order.", + "priority": 2, + "sampleUtterances": [ + "Make it a {Crust} crust.", + "I'd like a {Crust} crust." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaCrustType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of crust would you like?", + "contentType": "PlainText" + }, + { + "content": "Thick or thin crust?", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Sauce", + "description": "The type of sauce to use on the pizza.", + "priority": 3, + "sampleUtterances": [ + "Make it {Sauce} sauce.", + "I'd like {Sauce} sauce." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaSauceType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "White or red sauce?", + "contentType": "PlainText" + }, + { + "content": "Garlic or tomato sauce?", + "contentType": "PlainText" + } + ] + } + } + ] + }, + "output": { + "version": "$LATEST", + "name": "DocOrderPizza", + "checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", + "conclusionStatement": { + "messages": [ + { + "content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.", + "contentType": "PlainText" + }, + { + "content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", + "contentType": "PlainText" + } + ], + "responseCard": "foo" + }, + "confirmationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?", + "contentType": "PlainText" + } + ] + }, + "createdDate": 1494359783.453, + "description": "Order a pizza from a local pizzeria.", + "fulfillmentActivity": { + "type": "ReturnIntent" + }, + "lastUpdatedDate": 1494359783.453, + "rejectionStatement": { + "messages": [ + { + "content": "Ok, I'll cancel your order.", + "contentType": "PlainText" + }, + { + "content": "I cancelled your order.", + "contentType": "PlainText" + } + ] + }, + "sampleUtterances": [ + "Order me a pizza.", + "Order me a {Type} pizza.", + "I want a {Crust} crust {Type} pizza", + "I want a {Crust} crust {Type} pizza with {Sauce} sauce." + ], + "slots": [ + { + "name": "Sauce", + "description": "The type of sauce to use on the pizza.", + "priority": 3, + "sampleUtterances": [ + "Make it {Sauce} sauce.", + "I'd like {Sauce} sauce." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaSauceType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "White or red sauce?", + "contentType": "PlainText" + }, + { + "content": "Garlic or tomato sauce?", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Type", + "description": "The type of pizza to order.", + "priority": 1, + "sampleUtterances": [ + "Get me a {Type} pizza.", + "A {Type} pizza please.", + "I'd like a {Type} pizza." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of pizza would you like?", + "contentType": "PlainText" + }, + { + "content": "Vegie or cheese pizza?", + "contentType": "PlainText" + }, + { + "content": "I can get you a vegie or a cheese pizza.", + "contentType": "PlainText" + } + ] + } + }, + { + "name": "Crust", + "description": "The type of pizza crust to order.", + "priority": 2, + "sampleUtterances": [ + "Make it a {Crust} crust.", + "I'd like a {Crust} crust." + ], + "slotConstraint": "Required", + "slotType": "DocPizzaCrustType", + "slotTypeVersion": "$LATEST", + "valueElicitationPrompt": { + "maxAttempts": 1, + "messages": [ + { + "content": "What type of crust would you like?", + "contentType": "PlainText" + }, + { + "content": "Thick or thin crust?", + "contentType": "PlainText" + } + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to create an intent for ordering pizzas.", + "id": "to-create-an-intent-1494358144659", + "title": "To create an intent" + } + ], + "PutSlotType": [ + { + "input": { + "name": "PizzaSauceType", + "description": "Available pizza sauces", + "enumerationValues": [ + { + "value": "red" + }, + { + "value": "white" + } + ] + }, + "output": { + "version": "$LATEST", + "name": "DocPizzaSauceType", + "checksum": "cfd00ed1-775d-4357-947c-aca7e73b44ba", + "createdDate": 1494356442.23, + "description": "Available pizza sauces", + "enumerationValues": [ + { + "value": "red" + }, + { + "value": "white" + } + ], + "lastUpdatedDate": 1494356442.23 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to create a slot type that describes pizza sauces.", + "id": "to-create-a-slot-type-1494357262258", + "title": "To Create a Slot Type" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/lex-models-2017-04-19.min.json b/node_modules/aws-sdk/apis/lex-models-2017-04-19.min.json new file mode 100644 index 0000000..e7f3ced --- /dev/null +++ b/node_modules/aws-sdk/apis/lex-models-2017-04-19.min.json @@ -0,0 +1,1748 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-04-19", + "endpointPrefix": "models.lex", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon Lex Model Building Service", + "serviceId": "Lex Model Building Service", + "signatureVersion": "v4", + "signingName": "lex", + "uid": "lex-models-2017-04-19" + }, + "operations": { + "CreateBotVersion": { + "http": { + "requestUri": "/bots/{name}/versions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "checksum": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "intents": { + "shape": "S6" + }, + "clarificationPrompt": { + "shape": "Sa" + }, + "abortStatement": { + "shape": "Si" + }, + "status": {}, + "failureReason": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "idleSessionTTLInSeconds": { + "type": "integer" + }, + "voiceId": {}, + "checksum": {}, + "version": {}, + "locale": {}, + "childDirected": { + "type": "boolean" + } + } + } + }, + "CreateIntentVersion": { + "http": { + "requestUri": "/intents/{name}/versions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "checksum": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "slots": { + "shape": "Sq" + }, + "sampleUtterances": { + "shape": "Sy" + }, + "confirmationPrompt": { + "shape": "Sa" + }, + "rejectionStatement": { + "shape": "Si" + }, + "followUpPrompt": { + "shape": "Sz" + }, + "conclusionStatement": { + "shape": "Si" + }, + "dialogCodeHook": { + "shape": "S10" + }, + "fulfillmentActivity": { + "shape": "S13" + }, + "parentIntentSignature": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {}, + "checksum": {} + } + } + }, + "CreateSlotTypeVersion": { + "http": { + "requestUri": "/slottypes/{name}/versions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "checksum": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "enumerationValues": { + "shape": "S19" + }, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {}, + "checksum": {}, + "valueSelectionStrategy": {} + } + } + }, + "DeleteBot": { + "http": { + "method": "DELETE", + "requestUri": "/bots/{name}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + } + } + } + }, + "DeleteBotAlias": { + "http": { + "method": "DELETE", + "requestUri": "/bots/{botName}/aliases/{name}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name", + "botName" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "botName": { + "location": "uri", + "locationName": "botName" + } + } + } + }, + "DeleteBotChannelAssociation": { + "http": { + "method": "DELETE", + "requestUri": "/bots/{botName}/aliases/{aliasName}/channels/{name}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name", + "botName", + "botAlias" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "botName": { + "location": "uri", + "locationName": "botName" + }, + "botAlias": { + "location": "uri", + "locationName": "aliasName" + } + } + } + }, + "DeleteBotVersion": { + "http": { + "method": "DELETE", + "requestUri": "/bots/{name}/versions/{version}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "version": { + "location": "uri", + "locationName": "version" + } + } + } + }, + "DeleteIntent": { + "http": { + "method": "DELETE", + "requestUri": "/intents/{name}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + } + } + } + }, + "DeleteIntentVersion": { + "http": { + "method": "DELETE", + "requestUri": "/intents/{name}/versions/{version}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "version": { + "location": "uri", + "locationName": "version" + } + } + } + }, + "DeleteSlotType": { + "http": { + "method": "DELETE", + "requestUri": "/slottypes/{name}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + } + } + } + }, + "DeleteSlotTypeVersion": { + "http": { + "method": "DELETE", + "requestUri": "/slottypes/{name}/version/{version}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "version": { + "location": "uri", + "locationName": "version" + } + } + } + }, + "DeleteUtterances": { + "http": { + "method": "DELETE", + "requestUri": "/bots/{botName}/utterances/{userId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "botName", + "userId" + ], + "members": { + "botName": { + "location": "uri", + "locationName": "botName" + }, + "userId": { + "location": "uri", + "locationName": "userId" + } + } + } + }, + "GetBot": { + "http": { + "method": "GET", + "requestUri": "/bots/{name}/versions/{versionoralias}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "versionOrAlias" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "versionOrAlias": { + "location": "uri", + "locationName": "versionoralias" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "intents": { + "shape": "S6" + }, + "clarificationPrompt": { + "shape": "Sa" + }, + "abortStatement": { + "shape": "Si" + }, + "status": {}, + "failureReason": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "idleSessionTTLInSeconds": { + "type": "integer" + }, + "voiceId": {}, + "checksum": {}, + "version": {}, + "locale": {}, + "childDirected": { + "type": "boolean" + } + } + } + }, + "GetBotAlias": { + "http": { + "method": "GET", + "requestUri": "/bots/{botName}/aliases/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "botName" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "botName": { + "location": "uri", + "locationName": "botName" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "botVersion": {}, + "botName": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "checksum": {} + } + } + }, + "GetBotAliases": { + "http": { + "method": "GET", + "requestUri": "/bots/{botName}/aliases/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "botName" + ], + "members": { + "botName": { + "location": "uri", + "locationName": "botName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nameContains": { + "location": "querystring", + "locationName": "nameContains" + } + } + }, + "output": { + "type": "structure", + "members": { + "BotAliases": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "botVersion": {}, + "botName": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "checksum": {} + } + } + }, + "nextToken": {} + } + } + }, + "GetBotChannelAssociation": { + "http": { + "method": "GET", + "requestUri": "/bots/{botName}/aliases/{aliasName}/channels/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "botName", + "botAlias" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "botName": { + "location": "uri", + "locationName": "botName" + }, + "botAlias": { + "location": "uri", + "locationName": "aliasName" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "botAlias": {}, + "botName": {}, + "createdDate": { + "type": "timestamp" + }, + "type": {}, + "botConfiguration": { + "shape": "S24" + }, + "status": {}, + "failureReason": {} + } + } + }, + "GetBotChannelAssociations": { + "http": { + "method": "GET", + "requestUri": "/bots/{botName}/aliases/{aliasName}/channels/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "botName", + "botAlias" + ], + "members": { + "botName": { + "location": "uri", + "locationName": "botName" + }, + "botAlias": { + "location": "uri", + "locationName": "aliasName" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nameContains": { + "location": "querystring", + "locationName": "nameContains" + } + } + }, + "output": { + "type": "structure", + "members": { + "botChannelAssociations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "botAlias": {}, + "botName": {}, + "createdDate": { + "type": "timestamp" + }, + "type": {}, + "botConfiguration": { + "shape": "S24" + }, + "status": {}, + "failureReason": {} + } + } + }, + "nextToken": {} + } + } + }, + "GetBotVersions": { + "http": { + "method": "GET", + "requestUri": "/bots/{name}/versions/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "bots": { + "shape": "S2d" + }, + "nextToken": {} + } + } + }, + "GetBots": { + "http": { + "method": "GET", + "requestUri": "/bots/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nameContains": { + "location": "querystring", + "locationName": "nameContains" + } + } + }, + "output": { + "type": "structure", + "members": { + "bots": { + "shape": "S2d" + }, + "nextToken": {} + } + } + }, + "GetBuiltinIntent": { + "http": { + "method": "GET", + "requestUri": "/builtins/intents/{signature}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "signature" + ], + "members": { + "signature": { + "location": "uri", + "locationName": "signature" + } + } + }, + "output": { + "type": "structure", + "members": { + "signature": {}, + "supportedLocales": { + "shape": "S2j" + }, + "slots": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {} + } + } + } + } + } + }, + "GetBuiltinIntents": { + "http": { + "method": "GET", + "requestUri": "/builtins/intents/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "locale": { + "location": "querystring", + "locationName": "locale" + }, + "signatureContains": { + "location": "querystring", + "locationName": "signatureContains" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "intents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "signature": {}, + "supportedLocales": { + "shape": "S2j" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetBuiltinSlotTypes": { + "http": { + "method": "GET", + "requestUri": "/builtins/slottypes/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "locale": { + "location": "querystring", + "locationName": "locale" + }, + "signatureContains": { + "location": "querystring", + "locationName": "signatureContains" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "slotTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "signature": {}, + "supportedLocales": { + "shape": "S2j" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetExport": { + "http": { + "method": "GET", + "requestUri": "/exports/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "version", + "resourceType", + "exportType" + ], + "members": { + "name": { + "location": "querystring", + "locationName": "name" + }, + "version": { + "location": "querystring", + "locationName": "version" + }, + "resourceType": { + "location": "querystring", + "locationName": "resourceType" + }, + "exportType": { + "location": "querystring", + "locationName": "exportType" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "version": {}, + "resourceType": {}, + "exportType": {}, + "exportStatus": {}, + "failureReason": {}, + "url": {} + } + } + }, + "GetImport": { + "http": { + "method": "GET", + "requestUri": "/imports/{importId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "importId" + ], + "members": { + "importId": { + "location": "uri", + "locationName": "importId" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "resourceType": {}, + "mergeStrategy": {}, + "importId": {}, + "importStatus": {}, + "failureReason": { + "type": "list", + "member": {} + }, + "createdDate": { + "type": "timestamp" + } + } + } + }, + "GetIntent": { + "http": { + "method": "GET", + "requestUri": "/intents/{name}/versions/{version}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "version": { + "location": "uri", + "locationName": "version" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "slots": { + "shape": "Sq" + }, + "sampleUtterances": { + "shape": "Sy" + }, + "confirmationPrompt": { + "shape": "Sa" + }, + "rejectionStatement": { + "shape": "Si" + }, + "followUpPrompt": { + "shape": "Sz" + }, + "conclusionStatement": { + "shape": "Si" + }, + "dialogCodeHook": { + "shape": "S10" + }, + "fulfillmentActivity": { + "shape": "S13" + }, + "parentIntentSignature": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {}, + "checksum": {} + } + } + }, + "GetIntentVersions": { + "http": { + "method": "GET", + "requestUri": "/intents/{name}/versions/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "intents": { + "shape": "S3a" + }, + "nextToken": {} + } + } + }, + "GetIntents": { + "http": { + "method": "GET", + "requestUri": "/intents/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nameContains": { + "location": "querystring", + "locationName": "nameContains" + } + } + }, + "output": { + "type": "structure", + "members": { + "intents": { + "shape": "S3a" + }, + "nextToken": {} + } + } + }, + "GetSlotType": { + "http": { + "method": "GET", + "requestUri": "/slottypes/{name}/versions/{version}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "version": { + "location": "uri", + "locationName": "version" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "enumerationValues": { + "shape": "S19" + }, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {}, + "checksum": {}, + "valueSelectionStrategy": {} + } + } + }, + "GetSlotTypeVersions": { + "http": { + "method": "GET", + "requestUri": "/slottypes/{name}/versions/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "slotTypes": { + "shape": "S3i" + }, + "nextToken": {} + } + } + }, + "GetSlotTypes": { + "http": { + "method": "GET", + "requestUri": "/slottypes/", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nameContains": { + "location": "querystring", + "locationName": "nameContains" + } + } + }, + "output": { + "type": "structure", + "members": { + "slotTypes": { + "shape": "S3i" + }, + "nextToken": {} + } + } + }, + "GetUtterancesView": { + "http": { + "method": "GET", + "requestUri": "/bots/{botname}/utterances?view=aggregation", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "botName", + "botVersions", + "statusType" + ], + "members": { + "botName": { + "location": "uri", + "locationName": "botname" + }, + "botVersions": { + "location": "querystring", + "locationName": "bot_versions", + "type": "list", + "member": {} + }, + "statusType": { + "location": "querystring", + "locationName": "status_type" + } + } + }, + "output": { + "type": "structure", + "members": { + "botName": {}, + "utterances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "botVersion": {}, + "utterances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "utteranceString": {}, + "count": { + "type": "integer" + }, + "distinctUsers": { + "type": "integer" + }, + "firstUtteredDate": { + "type": "timestamp" + }, + "lastUtteredDate": { + "type": "timestamp" + } + } + } + } + } + } + } + } + } + }, + "PutBot": { + "http": { + "method": "PUT", + "requestUri": "/bots/{name}/versions/$LATEST", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "locale", + "childDirected" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "description": {}, + "intents": { + "shape": "S6" + }, + "clarificationPrompt": { + "shape": "Sa" + }, + "abortStatement": { + "shape": "Si" + }, + "idleSessionTTLInSeconds": { + "type": "integer" + }, + "voiceId": {}, + "checksum": {}, + "processBehavior": {}, + "locale": {}, + "childDirected": { + "type": "boolean" + }, + "createVersion": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "intents": { + "shape": "S6" + }, + "clarificationPrompt": { + "shape": "Sa" + }, + "abortStatement": { + "shape": "Si" + }, + "status": {}, + "failureReason": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "idleSessionTTLInSeconds": { + "type": "integer" + }, + "voiceId": {}, + "checksum": {}, + "version": {}, + "locale": {}, + "childDirected": { + "type": "boolean" + }, + "createVersion": { + "type": "boolean" + } + } + } + }, + "PutBotAlias": { + "http": { + "method": "PUT", + "requestUri": "/bots/{botName}/aliases/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name", + "botVersion", + "botName" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "description": {}, + "botVersion": {}, + "botName": { + "location": "uri", + "locationName": "botName" + }, + "checksum": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "botVersion": {}, + "botName": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "checksum": {} + } + } + }, + "PutIntent": { + "http": { + "method": "PUT", + "requestUri": "/intents/{name}/versions/$LATEST", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "description": {}, + "slots": { + "shape": "Sq" + }, + "sampleUtterances": { + "shape": "Sy" + }, + "confirmationPrompt": { + "shape": "Sa" + }, + "rejectionStatement": { + "shape": "Si" + }, + "followUpPrompt": { + "shape": "Sz" + }, + "conclusionStatement": { + "shape": "Si" + }, + "dialogCodeHook": { + "shape": "S10" + }, + "fulfillmentActivity": { + "shape": "S13" + }, + "parentIntentSignature": {}, + "checksum": {}, + "createVersion": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "slots": { + "shape": "Sq" + }, + "sampleUtterances": { + "shape": "Sy" + }, + "confirmationPrompt": { + "shape": "Sa" + }, + "rejectionStatement": { + "shape": "Si" + }, + "followUpPrompt": { + "shape": "Sz" + }, + "conclusionStatement": { + "shape": "Si" + }, + "dialogCodeHook": { + "shape": "S10" + }, + "fulfillmentActivity": { + "shape": "S13" + }, + "parentIntentSignature": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {}, + "checksum": {}, + "createVersion": { + "type": "boolean" + } + } + } + }, + "PutSlotType": { + "http": { + "method": "PUT", + "requestUri": "/slottypes/{name}/versions/$LATEST", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "location": "uri", + "locationName": "name" + }, + "description": {}, + "enumerationValues": { + "shape": "S19" + }, + "checksum": {}, + "valueSelectionStrategy": {}, + "createVersion": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "enumerationValues": { + "shape": "S19" + }, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {}, + "checksum": {}, + "valueSelectionStrategy": {}, + "createVersion": { + "type": "boolean" + } + } + } + }, + "StartImport": { + "http": { + "requestUri": "/imports/", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "payload", + "resourceType", + "mergeStrategy" + ], + "members": { + "payload": { + "type": "blob" + }, + "resourceType": {}, + "mergeStrategy": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "resourceType": {}, + "mergeStrategy": {}, + "importId": {}, + "importStatus": {}, + "createdDate": { + "type": "timestamp" + } + } + } + } + }, + "shapes": { + "S6": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "intentName", + "intentVersion" + ], + "members": { + "intentName": {}, + "intentVersion": {} + } + } + }, + "Sa": { + "type": "structure", + "required": [ + "messages", + "maxAttempts" + ], + "members": { + "messages": { + "shape": "Sb" + }, + "maxAttempts": { + "type": "integer" + }, + "responseCard": {} + } + }, + "Sb": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "contentType", + "content" + ], + "members": { + "contentType": {}, + "content": {}, + "groupNumber": { + "type": "integer" + } + } + } + }, + "Si": { + "type": "structure", + "required": [ + "messages" + ], + "members": { + "messages": { + "shape": "Sb" + }, + "responseCard": {} + } + }, + "Sq": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "slotConstraint" + ], + "members": { + "name": {}, + "description": {}, + "slotConstraint": {}, + "slotType": {}, + "slotTypeVersion": {}, + "valueElicitationPrompt": { + "shape": "Sa" + }, + "priority": { + "type": "integer" + }, + "sampleUtterances": { + "type": "list", + "member": {} + }, + "responseCard": {} + } + } + }, + "Sy": { + "type": "list", + "member": {} + }, + "Sz": { + "type": "structure", + "required": [ + "prompt", + "rejectionStatement" + ], + "members": { + "prompt": { + "shape": "Sa" + }, + "rejectionStatement": { + "shape": "Si" + } + } + }, + "S10": { + "type": "structure", + "required": [ + "uri", + "messageVersion" + ], + "members": { + "uri": {}, + "messageVersion": {} + } + }, + "S13": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "codeHook": { + "shape": "S10" + } + } + }, + "S19": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "value" + ], + "members": { + "value": {}, + "synonyms": { + "type": "list", + "member": {} + } + } + } + }, + "S24": { + "type": "map", + "key": {}, + "value": {}, + "sensitive": true + }, + "S2d": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "status": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {} + } + } + }, + "S2j": { + "type": "list", + "member": {} + }, + "S3a": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {} + } + } + }, + "S3i": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "lastUpdatedDate": { + "type": "timestamp" + }, + "createdDate": { + "type": "timestamp" + }, + "version": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/lex-models-2017-04-19.paginators.json b/node_modules/aws-sdk/apis/lex-models-2017-04-19.paginators.json new file mode 100644 index 0000000..57cb7bf --- /dev/null +++ b/node_modules/aws-sdk/apis/lex-models-2017-04-19.paginators.json @@ -0,0 +1,54 @@ +{ + "pagination": { + "GetBotAliases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBotChannelAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBotVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBots": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBuiltinIntents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBuiltinSlotTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetIntentVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetIntents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetSlotTypeVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetSlotTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/license-manager-2018-08-01.examples.json b/node_modules/aws-sdk/apis/license-manager-2018-08-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/license-manager-2018-08-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/license-manager-2018-08-01.min.json b/node_modules/aws-sdk/apis/license-manager-2018-08-01.min.json new file mode 100644 index 0000000..39bf7b9 --- /dev/null +++ b/node_modules/aws-sdk/apis/license-manager-2018-08-01.min.json @@ -0,0 +1,530 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-08-01", + "endpointPrefix": "license-manager", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS License Manager", + "serviceId": "License Manager", + "signatureVersion": "v4", + "targetPrefix": "AWSLicenseManager", + "uid": "license-manager-2018-08-01" + }, + "operations": { + "CreateLicenseConfiguration": { + "input": { + "type": "structure", + "required": [ + "Name", + "LicenseCountingType" + ], + "members": { + "Name": {}, + "Description": {}, + "LicenseCountingType": {}, + "LicenseCount": { + "type": "long" + }, + "LicenseCountHardLimit": { + "type": "boolean" + }, + "LicenseRules": { + "shape": "S6" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "LicenseConfigurationArn": {} + } + } + }, + "DeleteLicenseConfiguration": { + "input": { + "type": "structure", + "required": [ + "LicenseConfigurationArn" + ], + "members": { + "LicenseConfigurationArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetLicenseConfiguration": { + "input": { + "type": "structure", + "required": [ + "LicenseConfigurationArn" + ], + "members": { + "LicenseConfigurationArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "LicenseConfigurationId": {}, + "LicenseConfigurationArn": {}, + "Name": {}, + "Description": {}, + "LicenseCountingType": {}, + "LicenseRules": { + "shape": "S6" + }, + "LicenseCount": { + "type": "long" + }, + "LicenseCountHardLimit": { + "type": "boolean" + }, + "ConsumedLicenses": { + "type": "long" + }, + "Status": {}, + "OwnerAccountId": {}, + "ConsumedLicenseSummaryList": { + "shape": "Se" + }, + "ManagedResourceSummaryList": { + "shape": "Sh" + }, + "Tags": { + "shape": "S7" + } + } + } + }, + "GetServiceSettings": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "S3BucketArn": {}, + "SnsTopicArn": {}, + "OrganizationConfiguration": { + "shape": "Sl" + }, + "EnableCrossAccountsDiscovery": { + "type": "boolean" + } + } + } + }, + "ListAssociationsForLicenseConfiguration": { + "input": { + "type": "structure", + "required": [ + "LicenseConfigurationArn" + ], + "members": { + "LicenseConfigurationArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "LicenseConfigurationAssociations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceArn": {}, + "ResourceType": {}, + "ResourceOwnerId": {}, + "AssociationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListLicenseConfigurations": { + "input": { + "type": "structure", + "members": { + "LicenseConfigurationArns": { + "shape": "S6" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "LicenseConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LicenseConfigurationId": {}, + "LicenseConfigurationArn": {}, + "Name": {}, + "Description": {}, + "LicenseCountingType": {}, + "LicenseRules": { + "shape": "S6" + }, + "LicenseCount": { + "type": "long" + }, + "LicenseCountHardLimit": { + "type": "boolean" + }, + "ConsumedLicenses": { + "type": "long" + }, + "Status": {}, + "OwnerAccountId": {}, + "ConsumedLicenseSummaryList": { + "shape": "Se" + }, + "ManagedResourceSummaryList": { + "shape": "Sh" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListLicenseSpecificationsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "LicenseSpecifications": { + "shape": "S14" + }, + "NextToken": {} + } + } + }, + "ListResourceInventory": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Condition" + ], + "members": { + "Name": {}, + "Condition": {}, + "Value": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceInventoryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceId": {}, + "ResourceType": {}, + "ResourceArn": {}, + "Platform": {}, + "PlatformVersion": {}, + "ResourceOwningAccountId": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S7" + } + } + } + }, + "ListUsageForLicenseConfiguration": { + "input": { + "type": "structure", + "required": [ + "LicenseConfigurationArn" + ], + "members": { + "LicenseConfigurationArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "LicenseConfigurationUsageList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceArn": {}, + "ResourceType": {}, + "ResourceStatus": {}, + "ResourceOwnerId": {}, + "AssociationTime": { + "type": "timestamp" + }, + "ConsumedLicenses": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateLicenseConfiguration": { + "input": { + "type": "structure", + "required": [ + "LicenseConfigurationArn" + ], + "members": { + "LicenseConfigurationArn": {}, + "LicenseConfigurationStatus": {}, + "LicenseRules": { + "shape": "S6" + }, + "LicenseCount": { + "type": "long" + }, + "LicenseCountHardLimit": { + "type": "boolean" + }, + "Name": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateLicenseSpecificationsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "AddLicenseSpecifications": { + "shape": "S14" + }, + "RemoveLicenseSpecifications": { + "shape": "S14" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateServiceSettings": { + "input": { + "type": "structure", + "members": { + "S3BucketArn": {}, + "SnsTopicArn": {}, + "OrganizationConfiguration": { + "shape": "Sl" + }, + "EnableCrossAccountsDiscovery": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S6": { + "type": "list", + "member": {} + }, + "S7": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Se": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceType": {}, + "ConsumedLicenses": { + "type": "long" + } + } + } + }, + "Sh": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceType": {}, + "AssociationCount": { + "type": "long" + } + } + } + }, + "Sl": { + "type": "structure", + "required": [ + "EnableIntegration" + ], + "members": { + "EnableIntegration": { + "type": "boolean" + } + } + }, + "Su": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "S14": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LicenseConfigurationArn" + ], + "members": { + "LicenseConfigurationArn": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/license-manager-2018-08-01.paginators.json b/node_modules/aws-sdk/apis/license-manager-2018-08-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/license-manager-2018-08-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/lightsail-2016-11-28.examples.json b/node_modules/aws-sdk/apis/lightsail-2016-11-28.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/lightsail-2016-11-28.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json b/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json new file mode 100644 index 0000000..3f19241 --- /dev/null +++ b/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json @@ -0,0 +1,3209 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-28", + "endpointPrefix": "lightsail", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Lightsail", + "serviceId": "Lightsail", + "signatureVersion": "v4", + "targetPrefix": "Lightsail_20161128", + "uid": "lightsail-2016-11-28" + }, + "operations": { + "AllocateStaticIp": { + "input": { + "type": "structure", + "required": [ + "staticIpName" + ], + "members": { + "staticIpName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "AttachDisk": { + "input": { + "type": "structure", + "required": [ + "diskName", + "instanceName", + "diskPath" + ], + "members": { + "diskName": {}, + "instanceName": {}, + "diskPath": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "AttachInstancesToLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "instanceNames" + ], + "members": { + "loadBalancerName": {}, + "instanceNames": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "AttachLoadBalancerTlsCertificate": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "certificateName" + ], + "members": { + "loadBalancerName": {}, + "certificateName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "AttachStaticIp": { + "input": { + "type": "structure", + "required": [ + "staticIpName", + "instanceName" + ], + "members": { + "staticIpName": {}, + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CloseInstancePublicPorts": { + "input": { + "type": "structure", + "required": [ + "portInfo", + "instanceName" + ], + "members": { + "portInfo": { + "shape": "Sp" + }, + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "CopySnapshot": { + "input": { + "type": "structure", + "required": [ + "sourceSnapshotName", + "targetSnapshotName", + "sourceRegion" + ], + "members": { + "sourceSnapshotName": {}, + "targetSnapshotName": {}, + "sourceRegion": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateCloudFormationStack": { + "input": { + "type": "structure", + "required": [ + "instances" + ], + "members": { + "instances": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "sourceName", + "instanceType", + "portInfoSource", + "availabilityZone" + ], + "members": { + "sourceName": {}, + "instanceType": {}, + "portInfoSource": {}, + "userData": {}, + "availabilityZone": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateDisk": { + "input": { + "type": "structure", + "required": [ + "diskName", + "availabilityZone", + "sizeInGb" + ], + "members": { + "diskName": {}, + "availabilityZone": {}, + "sizeInGb": { + "type": "integer" + }, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateDiskFromSnapshot": { + "input": { + "type": "structure", + "required": [ + "diskName", + "diskSnapshotName", + "availabilityZone", + "sizeInGb" + ], + "members": { + "diskName": {}, + "diskSnapshotName": {}, + "availabilityZone": {}, + "sizeInGb": { + "type": "integer" + }, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateDiskSnapshot": { + "input": { + "type": "structure", + "required": [ + "diskSnapshotName" + ], + "members": { + "diskName": {}, + "diskSnapshotName": {}, + "instanceName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateDomain": { + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "CreateDomainEntry": { + "input": { + "type": "structure", + "required": [ + "domainName", + "domainEntry" + ], + "members": { + "domainName": {}, + "domainEntry": { + "shape": "S1f" + } + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "CreateInstanceSnapshot": { + "input": { + "type": "structure", + "required": [ + "instanceSnapshotName", + "instanceName" + ], + "members": { + "instanceSnapshotName": {}, + "instanceName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateInstances": { + "input": { + "type": "structure", + "required": [ + "instanceNames", + "availabilityZone", + "blueprintId", + "bundleId" + ], + "members": { + "instanceNames": { + "shape": "S1n" + }, + "availabilityZone": {}, + "customImageName": { + "deprecated": true + }, + "blueprintId": {}, + "bundleId": {}, + "userData": {}, + "keyPairName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateInstancesFromSnapshot": { + "input": { + "type": "structure", + "required": [ + "instanceNames", + "availabilityZone", + "instanceSnapshotName", + "bundleId" + ], + "members": { + "instanceNames": { + "shape": "S1n" + }, + "attachedDiskMapping": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "originalDiskPath": {}, + "newDiskName": {} + } + } + } + }, + "availabilityZone": {}, + "instanceSnapshotName": {}, + "bundleId": {}, + "userData": {}, + "keyPairName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateKeyPair": { + "input": { + "type": "structure", + "required": [ + "keyPairName" + ], + "members": { + "keyPairName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "keyPair": { + "shape": "S1w" + }, + "publicKeyBase64": {}, + "privateKeyBase64": {}, + "operation": { + "shape": "S5" + } + } + } + }, + "CreateLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "instancePort" + ], + "members": { + "loadBalancerName": {}, + "instancePort": { + "type": "integer" + }, + "healthCheckPath": {}, + "certificateName": {}, + "certificateDomainName": {}, + "certificateAlternativeNames": { + "shape": "S1z" + }, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateLoadBalancerTlsCertificate": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "certificateName", + "certificateDomainName" + ], + "members": { + "loadBalancerName": {}, + "certificateName": {}, + "certificateDomainName": {}, + "certificateAlternativeNames": { + "shape": "S1z" + }, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateRelationalDatabase": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName", + "relationalDatabaseBlueprintId", + "relationalDatabaseBundleId", + "masterDatabaseName", + "masterUsername" + ], + "members": { + "relationalDatabaseName": {}, + "availabilityZone": {}, + "relationalDatabaseBlueprintId": {}, + "relationalDatabaseBundleId": {}, + "masterDatabaseName": {}, + "masterUsername": {}, + "masterUserPassword": { + "shape": "S24" + }, + "preferredBackupWindow": {}, + "preferredMaintenanceWindow": {}, + "publiclyAccessible": { + "type": "boolean" + }, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateRelationalDatabaseFromSnapshot": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {}, + "availabilityZone": {}, + "publiclyAccessible": { + "type": "boolean" + }, + "relationalDatabaseSnapshotName": {}, + "relationalDatabaseBundleId": {}, + "sourceRelationalDatabaseName": {}, + "restoreTime": { + "type": "timestamp" + }, + "useLatestRestorableTime": { + "type": "boolean" + }, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "CreateRelationalDatabaseSnapshot": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName", + "relationalDatabaseSnapshotName" + ], + "members": { + "relationalDatabaseName": {}, + "relationalDatabaseSnapshotName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteDisk": { + "input": { + "type": "structure", + "required": [ + "diskName" + ], + "members": { + "diskName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteDiskSnapshot": { + "input": { + "type": "structure", + "required": [ + "diskSnapshotName" + ], + "members": { + "diskSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteDomain": { + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "DeleteDomainEntry": { + "input": { + "type": "structure", + "required": [ + "domainName", + "domainEntry" + ], + "members": { + "domainName": {}, + "domainEntry": { + "shape": "S1f" + } + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "DeleteInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteInstanceSnapshot": { + "input": { + "type": "structure", + "required": [ + "instanceSnapshotName" + ], + "members": { + "instanceSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteKeyPair": { + "input": { + "type": "structure", + "required": [ + "keyPairName" + ], + "members": { + "keyPairName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "DeleteKnownHostKeys": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName" + ], + "members": { + "loadBalancerName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteLoadBalancerTlsCertificate": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "certificateName" + ], + "members": { + "loadBalancerName": {}, + "certificateName": {}, + "force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteRelationalDatabase": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {}, + "skipFinalSnapshot": { + "type": "boolean" + }, + "finalRelationalDatabaseSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DeleteRelationalDatabaseSnapshot": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseSnapshotName" + ], + "members": { + "relationalDatabaseSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DetachDisk": { + "input": { + "type": "structure", + "required": [ + "diskName" + ], + "members": { + "diskName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DetachInstancesFromLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "instanceNames" + ], + "members": { + "loadBalancerName": {}, + "instanceNames": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DetachStaticIp": { + "input": { + "type": "structure", + "required": [ + "staticIpName" + ], + "members": { + "staticIpName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "DownloadDefaultKeyPair": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "publicKeyBase64": {}, + "privateKeyBase64": {} + } + } + }, + "ExportSnapshot": { + "input": { + "type": "structure", + "required": [ + "sourceSnapshotName" + ], + "members": { + "sourceSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "GetActiveNames": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "activeNames": { + "shape": "S1n" + }, + "nextPageToken": {} + } + } + }, + "GetBlueprints": { + "input": { + "type": "structure", + "members": { + "includeInactive": { + "type": "boolean" + }, + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "blueprints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "blueprintId": {}, + "name": {}, + "group": {}, + "type": {}, + "description": {}, + "isActive": { + "type": "boolean" + }, + "minPower": { + "type": "integer" + }, + "version": {}, + "versionCode": {}, + "productUrl": {}, + "licenseUrl": {}, + "platform": {} + } + } + }, + "nextPageToken": {} + } + } + }, + "GetBundles": { + "input": { + "type": "structure", + "members": { + "includeInactive": { + "type": "boolean" + }, + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "bundles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "price": { + "type": "float" + }, + "cpuCount": { + "type": "integer" + }, + "diskSizeInGb": { + "type": "integer" + }, + "bundleId": {}, + "instanceType": {}, + "isActive": { + "type": "boolean" + }, + "name": {}, + "power": { + "type": "integer" + }, + "ramSizeInGb": { + "type": "float" + }, + "transferPerMonthInGb": { + "type": "integer" + }, + "supportedPlatforms": { + "type": "list", + "member": {} + } + } + } + }, + "nextPageToken": {} + } + } + }, + "GetCloudFormationStackRecords": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "cloudFormationStackRecords": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "state": {}, + "sourceInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resourceType": {}, + "name": {}, + "arn": {} + } + } + }, + "destinationInfo": { + "shape": "S3u" + } + } + } + }, + "nextPageToken": {} + } + } + }, + "GetDisk": { + "input": { + "type": "structure", + "required": [ + "diskName" + ], + "members": { + "diskName": {} + } + }, + "output": { + "type": "structure", + "members": { + "disk": { + "shape": "S3x" + } + } + } + }, + "GetDiskSnapshot": { + "input": { + "type": "structure", + "required": [ + "diskSnapshotName" + ], + "members": { + "diskSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "diskSnapshot": { + "shape": "S41" + } + } + } + }, + "GetDiskSnapshots": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "diskSnapshots": { + "type": "list", + "member": { + "shape": "S41" + } + }, + "nextPageToken": {} + } + } + }, + "GetDisks": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "disks": { + "shape": "S48" + }, + "nextPageToken": {} + } + } + }, + "GetDomain": { + "input": { + "type": "structure", + "required": [ + "domainName" + ], + "members": { + "domainName": {} + } + }, + "output": { + "type": "structure", + "members": { + "domain": { + "shape": "S4b" + } + } + } + }, + "GetDomains": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "domains": { + "type": "list", + "member": { + "shape": "S4b" + } + }, + "nextPageToken": {} + } + } + }, + "GetExportSnapshotRecords": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "exportSnapshotRecords": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "state": {}, + "sourceInfo": { + "type": "structure", + "members": { + "resourceType": {}, + "createdAt": { + "type": "timestamp" + }, + "name": {}, + "arn": {}, + "fromResourceName": {}, + "fromResourceArn": {}, + "instanceSnapshotInfo": { + "type": "structure", + "members": { + "fromBundleId": {}, + "fromBlueprintId": {}, + "fromDiskInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "path": {}, + "sizeInGb": { + "type": "integer" + }, + "isSystemDisk": { + "type": "boolean" + } + } + } + } + } + }, + "diskSnapshotInfo": { + "type": "structure", + "members": { + "sizeInGb": { + "type": "integer" + } + } + } + } + }, + "destinationInfo": { + "shape": "S3u" + } + } + } + }, + "nextPageToken": {} + } + } + }, + "GetInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "instance": { + "shape": "S4s" + } + } + } + }, + "GetInstanceAccessDetails": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {}, + "protocol": {} + } + }, + "output": { + "type": "structure", + "members": { + "accessDetails": { + "type": "structure", + "members": { + "certKey": {}, + "expiresAt": { + "type": "timestamp" + }, + "ipAddress": {}, + "password": {}, + "passwordData": { + "type": "structure", + "members": { + "ciphertext": {}, + "keyPairName": {} + } + }, + "privateKey": {}, + "protocol": {}, + "instanceName": {}, + "username": {}, + "hostKeys": { + "type": "list", + "member": { + "type": "structure", + "members": { + "algorithm": {}, + "publicKey": {}, + "witnessedAt": { + "type": "timestamp" + }, + "fingerprintSHA1": {}, + "fingerprintSHA256": {}, + "notValidBefore": { + "type": "timestamp" + }, + "notValidAfter": { + "type": "timestamp" + } + } + } + } + } + } + } + } + }, + "GetInstanceMetricData": { + "input": { + "type": "structure", + "required": [ + "instanceName", + "metricName", + "period", + "startTime", + "endTime", + "unit", + "statistics" + ], + "members": { + "instanceName": {}, + "metricName": {}, + "period": { + "type": "integer" + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "unit": {}, + "statistics": { + "shape": "S5f" + } + } + }, + "output": { + "type": "structure", + "members": { + "metricName": {}, + "metricData": { + "shape": "S5i" + } + } + } + }, + "GetInstancePortStates": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "portStates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "fromPort": { + "type": "integer" + }, + "toPort": { + "type": "integer" + }, + "protocol": {}, + "state": {} + } + } + } + } + } + }, + "GetInstanceSnapshot": { + "input": { + "type": "structure", + "required": [ + "instanceSnapshotName" + ], + "members": { + "instanceSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "instanceSnapshot": { + "shape": "S5s" + } + } + } + }, + "GetInstanceSnapshots": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "instanceSnapshots": { + "type": "list", + "member": { + "shape": "S5s" + } + }, + "nextPageToken": {} + } + } + }, + "GetInstanceState": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "state": { + "shape": "S52" + } + } + } + }, + "GetInstances": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "instances": { + "type": "list", + "member": { + "shape": "S4s" + } + }, + "nextPageToken": {} + } + } + }, + "GetKeyPair": { + "input": { + "type": "structure", + "required": [ + "keyPairName" + ], + "members": { + "keyPairName": {} + } + }, + "output": { + "type": "structure", + "members": { + "keyPair": { + "shape": "S1w" + } + } + } + }, + "GetKeyPairs": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "keyPairs": { + "type": "list", + "member": { + "shape": "S1w" + } + }, + "nextPageToken": {} + } + } + }, + "GetLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName" + ], + "members": { + "loadBalancerName": {} + } + }, + "output": { + "type": "structure", + "members": { + "loadBalancer": { + "shape": "S69" + } + } + } + }, + "GetLoadBalancerMetricData": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "metricName", + "period", + "startTime", + "endTime", + "unit", + "statistics" + ], + "members": { + "loadBalancerName": {}, + "metricName": {}, + "period": { + "type": "integer" + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "unit": {}, + "statistics": { + "shape": "S5f" + } + } + }, + "output": { + "type": "structure", + "members": { + "metricName": {}, + "metricData": { + "shape": "S5i" + } + } + } + }, + "GetLoadBalancerTlsCertificates": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName" + ], + "members": { + "loadBalancerName": {} + } + }, + "output": { + "type": "structure", + "members": { + "tlsCertificates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "loadBalancerName": {}, + "isAttached": { + "type": "boolean" + }, + "status": {}, + "domainName": {}, + "domainValidationRecords": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "type": {}, + "value": {}, + "validationStatus": {}, + "domainName": {} + } + } + }, + "failureReason": {}, + "issuedAt": { + "type": "timestamp" + }, + "issuer": {}, + "keyAlgorithm": {}, + "notAfter": { + "type": "timestamp" + }, + "notBefore": { + "type": "timestamp" + }, + "renewalSummary": { + "type": "structure", + "members": { + "renewalStatus": {}, + "domainValidationOptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "domainName": {}, + "validationStatus": {} + } + } + } + } + }, + "revocationReason": {}, + "revokedAt": { + "type": "timestamp" + }, + "serial": {}, + "signatureAlgorithm": {}, + "subject": {}, + "subjectAlternativeNames": { + "shape": "S1n" + } + } + } + } + } + } + }, + "GetLoadBalancers": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "loadBalancers": { + "type": "list", + "member": { + "shape": "S69" + } + }, + "nextPageToken": {} + } + } + }, + "GetOperation": { + "input": { + "type": "structure", + "required": [ + "operationId" + ], + "members": { + "operationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "GetOperations": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + }, + "nextPageToken": {} + } + } + }, + "GetOperationsForResource": { + "input": { + "type": "structure", + "required": [ + "resourceName" + ], + "members": { + "resourceName": {}, + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + }, + "nextPageCount": { + "deprecated": true + }, + "nextPageToken": {} + } + } + }, + "GetRegions": { + "input": { + "type": "structure", + "members": { + "includeAvailabilityZones": { + "type": "boolean" + }, + "includeRelationalDatabaseAvailabilityZones": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "regions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "continentCode": {}, + "description": {}, + "displayName": {}, + "name": {}, + "availabilityZones": { + "shape": "S7f" + }, + "relationalDatabaseAvailabilityZones": { + "shape": "S7f" + } + } + } + } + } + } + }, + "GetRelationalDatabase": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {} + } + }, + "output": { + "type": "structure", + "members": { + "relationalDatabase": { + "shape": "S7j" + } + } + } + }, + "GetRelationalDatabaseBlueprints": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "blueprints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "blueprintId": {}, + "engine": {}, + "engineVersion": {}, + "engineDescription": {}, + "engineVersionDescription": {}, + "isEngineDefault": { + "type": "boolean" + } + } + } + }, + "nextPageToken": {} + } + } + }, + "GetRelationalDatabaseBundles": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "bundles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "bundleId": {}, + "name": {}, + "price": { + "type": "float" + }, + "ramSizeInGb": { + "type": "float" + }, + "diskSizeInGb": { + "type": "integer" + }, + "transferPerMonthInGb": { + "type": "integer" + }, + "cpuCount": { + "type": "integer" + }, + "isEncrypted": { + "type": "boolean" + }, + "isActive": { + "type": "boolean" + } + } + } + }, + "nextPageToken": {} + } + } + }, + "GetRelationalDatabaseEvents": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {}, + "durationInMinutes": { + "type": "integer" + }, + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "relationalDatabaseEvents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resource": {}, + "createdAt": { + "type": "timestamp" + }, + "message": {}, + "eventCategories": { + "shape": "S1n" + } + } + } + }, + "nextPageToken": {} + } + } + }, + "GetRelationalDatabaseLogEvents": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName", + "logStreamName" + ], + "members": { + "relationalDatabaseName": {}, + "logStreamName": {}, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "startFromHead": { + "type": "boolean" + }, + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceLogEvents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "createdAt": { + "type": "timestamp" + }, + "message": {} + } + } + }, + "nextBackwardToken": {}, + "nextForwardToken": {} + } + } + }, + "GetRelationalDatabaseLogStreams": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {} + } + }, + "output": { + "type": "structure", + "members": { + "logStreams": { + "shape": "S1n" + } + } + } + }, + "GetRelationalDatabaseMasterUserPassword": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {}, + "passwordVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "masterUserPassword": { + "shape": "S24" + }, + "createdAt": { + "type": "timestamp" + } + } + } + }, + "GetRelationalDatabaseMetricData": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName", + "metricName", + "period", + "startTime", + "endTime", + "unit", + "statistics" + ], + "members": { + "relationalDatabaseName": {}, + "metricName": {}, + "period": { + "type": "integer" + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + }, + "unit": {}, + "statistics": { + "shape": "S5f" + } + } + }, + "output": { + "type": "structure", + "members": { + "metricName": {}, + "metricData": { + "shape": "S5i" + } + } + } + }, + "GetRelationalDatabaseParameters": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {}, + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "parameters": { + "shape": "S8g" + }, + "nextPageToken": {} + } + } + }, + "GetRelationalDatabaseSnapshot": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseSnapshotName" + ], + "members": { + "relationalDatabaseSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "relationalDatabaseSnapshot": { + "shape": "S8k" + } + } + } + }, + "GetRelationalDatabaseSnapshots": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "relationalDatabaseSnapshots": { + "type": "list", + "member": { + "shape": "S8k" + } + }, + "nextPageToken": {} + } + } + }, + "GetRelationalDatabases": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "relationalDatabases": { + "type": "list", + "member": { + "shape": "S7j" + } + }, + "nextPageToken": {} + } + } + }, + "GetStaticIp": { + "input": { + "type": "structure", + "required": [ + "staticIpName" + ], + "members": { + "staticIpName": {} + } + }, + "output": { + "type": "structure", + "members": { + "staticIp": { + "shape": "S8t" + } + } + } + }, + "GetStaticIps": { + "input": { + "type": "structure", + "members": { + "pageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "staticIps": { + "type": "list", + "member": { + "shape": "S8t" + } + }, + "nextPageToken": {} + } + } + }, + "ImportKeyPair": { + "input": { + "type": "structure", + "required": [ + "keyPairName", + "publicKeyBase64" + ], + "members": { + "keyPairName": {}, + "publicKeyBase64": {} + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "IsVpcPeered": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "isPeered": { + "type": "boolean" + } + } + } + }, + "OpenInstancePublicPorts": { + "input": { + "type": "structure", + "required": [ + "portInfo", + "instanceName" + ], + "members": { + "portInfo": { + "shape": "Sp" + }, + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "PeerVpc": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "PutInstancePublicPorts": { + "input": { + "type": "structure", + "required": [ + "portInfos", + "instanceName" + ], + "members": { + "portInfos": { + "type": "list", + "member": { + "shape": "Sp" + } + }, + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "RebootInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "RebootRelationalDatabase": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "ReleaseStaticIp": { + "input": { + "type": "structure", + "required": [ + "staticIpName" + ], + "members": { + "staticIpName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "StartInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "StartRelationalDatabase": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "StopInstance": { + "input": { + "type": "structure", + "required": [ + "instanceName" + ], + "members": { + "instanceName": {}, + "force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "StopRelationalDatabase": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {}, + "relationalDatabaseSnapshotName": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "resourceName", + "tags" + ], + "members": { + "resourceName": {}, + "tags": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "UnpeerVpc": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "operation": { + "shape": "S5" + } + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "resourceName", + "tagKeys" + ], + "members": { + "resourceName": {}, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "UpdateDomainEntry": { + "input": { + "type": "structure", + "required": [ + "domainName", + "domainEntry" + ], + "members": { + "domainName": {}, + "domainEntry": { + "shape": "S1f" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "UpdateLoadBalancerAttribute": { + "input": { + "type": "structure", + "required": [ + "loadBalancerName", + "attributeName", + "attributeValue" + ], + "members": { + "loadBalancerName": {}, + "attributeName": {}, + "attributeValue": {} + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "UpdateRelationalDatabase": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName" + ], + "members": { + "relationalDatabaseName": {}, + "masterUserPassword": { + "shape": "S24" + }, + "rotateMasterUserPassword": { + "type": "boolean" + }, + "preferredBackupWindow": {}, + "preferredMaintenanceWindow": {}, + "enableBackupRetention": { + "type": "boolean" + }, + "disableBackupRetention": { + "type": "boolean" + }, + "publiclyAccessible": { + "type": "boolean" + }, + "applyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + }, + "UpdateRelationalDatabaseParameters": { + "input": { + "type": "structure", + "required": [ + "relationalDatabaseName", + "parameters" + ], + "members": { + "relationalDatabaseName": {}, + "parameters": { + "shape": "S8g" + } + } + }, + "output": { + "type": "structure", + "members": { + "operations": { + "shape": "S4" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "S5": { + "type": "structure", + "members": { + "id": {}, + "resourceName": {}, + "resourceType": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "isTerminal": { + "type": "boolean" + }, + "operationDetails": {}, + "operationType": {}, + "status": {}, + "statusChangedAt": { + "type": "timestamp" + }, + "errorCode": {}, + "errorDetails": {} + } + }, + "S9": { + "type": "structure", + "members": { + "availabilityZone": {}, + "regionName": {} + } + }, + "Si": { + "type": "list", + "member": {} + }, + "Sp": { + "type": "structure", + "members": { + "fromPort": { + "type": "integer" + }, + "toPort": { + "type": "integer" + }, + "protocol": {} + } + }, + "S12": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "S1f": { + "type": "structure", + "members": { + "id": {}, + "name": {}, + "target": {}, + "isAlias": { + "type": "boolean" + }, + "type": {}, + "options": { + "deprecated": true, + "type": "map", + "key": {}, + "value": {} + } + } + }, + "S1n": { + "type": "list", + "member": {} + }, + "S1w": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "fingerprint": {} + } + }, + "S1z": { + "type": "list", + "member": {} + }, + "S24": { + "type": "string", + "sensitive": true + }, + "S3u": { + "type": "structure", + "members": { + "id": {}, + "service": {} + } + }, + "S3x": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "sizeInGb": { + "type": "integer" + }, + "isSystemDisk": { + "type": "boolean" + }, + "iops": { + "type": "integer" + }, + "path": {}, + "state": {}, + "attachedTo": {}, + "isAttached": { + "type": "boolean" + }, + "attachmentState": { + "deprecated": true + }, + "gbInUse": { + "deprecated": true, + "type": "integer" + } + } + }, + "S41": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "sizeInGb": { + "type": "integer" + }, + "state": {}, + "progress": {}, + "fromDiskName": {}, + "fromDiskArn": {}, + "fromInstanceName": {}, + "fromInstanceArn": {} + } + }, + "S48": { + "type": "list", + "member": { + "shape": "S3x" + } + }, + "S4b": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "domainEntries": { + "type": "list", + "member": { + "shape": "S1f" + } + } + } + }, + "S4s": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "blueprintId": {}, + "blueprintName": {}, + "bundleId": {}, + "isStaticIp": { + "type": "boolean" + }, + "privateIpAddress": {}, + "publicIpAddress": {}, + "ipv6Address": {}, + "hardware": { + "type": "structure", + "members": { + "cpuCount": { + "type": "integer" + }, + "disks": { + "shape": "S48" + }, + "ramSizeInGb": { + "type": "float" + } + } + }, + "networking": { + "type": "structure", + "members": { + "monthlyTransfer": { + "type": "structure", + "members": { + "gbPerMonthAllocated": { + "type": "integer" + } + } + }, + "ports": { + "type": "list", + "member": { + "type": "structure", + "members": { + "fromPort": { + "type": "integer" + }, + "toPort": { + "type": "integer" + }, + "protocol": {}, + "accessFrom": {}, + "accessType": {}, + "commonName": {}, + "accessDirection": {} + } + } + } + } + }, + "state": { + "shape": "S52" + }, + "username": {}, + "sshKeyName": {} + } + }, + "S52": { + "type": "structure", + "members": { + "code": { + "type": "integer" + }, + "name": {} + } + }, + "S5f": { + "type": "list", + "member": {} + }, + "S5i": { + "type": "list", + "member": { + "type": "structure", + "members": { + "average": { + "type": "double" + }, + "maximum": { + "type": "double" + }, + "minimum": { + "type": "double" + }, + "sampleCount": { + "type": "double" + }, + "sum": { + "type": "double" + }, + "timestamp": { + "type": "timestamp" + }, + "unit": {} + } + } + }, + "S5s": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "state": {}, + "progress": {}, + "fromAttachedDisks": { + "shape": "S48" + }, + "fromInstanceName": {}, + "fromInstanceArn": {}, + "fromBlueprintId": {}, + "fromBundleId": {}, + "sizeInGb": { + "type": "integer" + } + } + }, + "S69": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "dnsName": {}, + "state": {}, + "protocol": {}, + "publicPorts": { + "type": "list", + "member": { + "type": "integer" + } + }, + "healthCheckPath": {}, + "instancePort": { + "type": "integer" + }, + "instanceHealthSummary": { + "type": "list", + "member": { + "type": "structure", + "members": { + "instanceName": {}, + "instanceHealth": {}, + "instanceHealthReason": {} + } + } + }, + "tlsCertificateSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "isAttached": { + "type": "boolean" + } + } + } + }, + "configurationOptions": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "S7f": { + "type": "list", + "member": { + "type": "structure", + "members": { + "zoneName": {}, + "state": {} + } + } + }, + "S7j": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "relationalDatabaseBlueprintId": {}, + "relationalDatabaseBundleId": {}, + "masterDatabaseName": {}, + "hardware": { + "type": "structure", + "members": { + "cpuCount": { + "type": "integer" + }, + "diskSizeInGb": { + "type": "integer" + }, + "ramSizeInGb": { + "type": "float" + } + } + }, + "state": {}, + "secondaryAvailabilityZone": {}, + "backupRetentionEnabled": { + "type": "boolean" + }, + "pendingModifiedValues": { + "type": "structure", + "members": { + "masterUserPassword": {}, + "engineVersion": {}, + "backupRetentionEnabled": { + "type": "boolean" + } + } + }, + "engine": {}, + "engineVersion": {}, + "latestRestorableTime": { + "type": "timestamp" + }, + "masterUsername": {}, + "parameterApplyStatus": {}, + "preferredBackupWindow": {}, + "preferredMaintenanceWindow": {}, + "publiclyAccessible": { + "type": "boolean" + }, + "masterEndpoint": { + "type": "structure", + "members": { + "port": { + "type": "integer" + }, + "address": {} + } + }, + "pendingMaintenanceActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "action": {}, + "description": {}, + "currentApplyDate": { + "type": "timestamp" + } + } + } + } + } + }, + "S8g": { + "type": "list", + "member": { + "type": "structure", + "members": { + "allowedValues": {}, + "applyMethod": {}, + "applyType": {}, + "dataType": {}, + "description": {}, + "isModifiable": { + "type": "boolean" + }, + "parameterName": {}, + "parameterValue": {} + } + } + }, + "S8k": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "tags": { + "shape": "S12" + }, + "engine": {}, + "engineVersion": {}, + "sizeInGb": { + "type": "integer" + }, + "state": {}, + "fromRelationalDatabaseName": {}, + "fromRelationalDatabaseArn": {}, + "fromRelationalDatabaseBundleId": {}, + "fromRelationalDatabaseBlueprintId": {} + } + }, + "S8t": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "supportCode": {}, + "createdAt": { + "type": "timestamp" + }, + "location": { + "shape": "S9" + }, + "resourceType": {}, + "ipAddress": {}, + "attachedTo": {}, + "isAttached": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/lightsail-2016-11-28.paginators.json b/node_modules/aws-sdk/apis/lightsail-2016-11-28.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/lightsail-2016-11-28.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/logs-2014-03-28.examples.json b/node_modules/aws-sdk/apis/logs-2014-03-28.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/logs-2014-03-28.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/logs-2014-03-28.min.json b/node_modules/aws-sdk/apis/logs-2014-03-28.min.json new file mode 100644 index 0000000..f8a32d2 --- /dev/null +++ b/node_modules/aws-sdk/apis/logs-2014-03-28.min.json @@ -0,0 +1,1048 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-03-28", + "endpointPrefix": "logs", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon CloudWatch Logs", + "serviceId": "CloudWatch Logs", + "signatureVersion": "v4", + "targetPrefix": "Logs_20140328", + "uid": "logs-2014-03-28" + }, + "operations": { + "AssociateKmsKey": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "kmsKeyId" + ], + "members": { + "logGroupName": {}, + "kmsKeyId": {} + } + } + }, + "CancelExportTask": { + "input": { + "type": "structure", + "required": [ + "taskId" + ], + "members": { + "taskId": {} + } + } + }, + "CreateExportTask": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "from", + "to", + "destination" + ], + "members": { + "taskName": {}, + "logGroupName": {}, + "logStreamNamePrefix": {}, + "from": { + "type": "long" + }, + "to": { + "type": "long" + }, + "destination": {}, + "destinationPrefix": {} + } + }, + "output": { + "type": "structure", + "members": { + "taskId": {} + } + } + }, + "CreateLogGroup": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {}, + "kmsKeyId": {}, + "tags": { + "shape": "Se" + } + } + } + }, + "CreateLogStream": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName" + ], + "members": { + "logGroupName": {}, + "logStreamName": {} + } + } + }, + "DeleteDestination": { + "input": { + "type": "structure", + "required": [ + "destinationName" + ], + "members": { + "destinationName": {} + } + } + }, + "DeleteLogGroup": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {} + } + } + }, + "DeleteLogStream": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName" + ], + "members": { + "logGroupName": {}, + "logStreamName": {} + } + } + }, + "DeleteMetricFilter": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "filterName" + ], + "members": { + "logGroupName": {}, + "filterName": {} + } + } + }, + "DeleteResourcePolicy": { + "input": { + "type": "structure", + "members": { + "policyName": {} + } + } + }, + "DeleteRetentionPolicy": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {} + } + } + }, + "DeleteSubscriptionFilter": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "filterName" + ], + "members": { + "logGroupName": {}, + "filterName": {} + } + } + }, + "DescribeDestinations": { + "input": { + "type": "structure", + "members": { + "DestinationNamePrefix": {}, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "destinations": { + "type": "list", + "member": { + "shape": "Sx" + } + }, + "nextToken": {} + } + } + }, + "DescribeExportTasks": { + "input": { + "type": "structure", + "members": { + "taskId": {}, + "statusCode": {}, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "exportTasks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "taskId": {}, + "taskName": {}, + "logGroupName": {}, + "from": { + "type": "long" + }, + "to": { + "type": "long" + }, + "destination": {}, + "destinationPrefix": {}, + "status": { + "type": "structure", + "members": { + "code": {}, + "message": {} + } + }, + "executionInfo": { + "type": "structure", + "members": { + "creationTime": { + "type": "long" + }, + "completionTime": { + "type": "long" + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeLogGroups": { + "input": { + "type": "structure", + "members": { + "logGroupNamePrefix": {}, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "logGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "logGroupName": {}, + "creationTime": { + "type": "long" + }, + "retentionInDays": { + "type": "integer" + }, + "metricFilterCount": { + "type": "integer" + }, + "arn": {}, + "storedBytes": { + "type": "long" + }, + "kmsKeyId": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeLogStreams": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {}, + "logStreamNamePrefix": {}, + "orderBy": {}, + "descending": { + "type": "boolean" + }, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "logStreams": { + "type": "list", + "member": { + "type": "structure", + "members": { + "logStreamName": {}, + "creationTime": { + "type": "long" + }, + "firstEventTimestamp": { + "type": "long" + }, + "lastEventTimestamp": { + "type": "long" + }, + "lastIngestionTime": { + "type": "long" + }, + "uploadSequenceToken": {}, + "arn": {}, + "storedBytes": { + "type": "long" + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeMetricFilters": { + "input": { + "type": "structure", + "members": { + "logGroupName": {}, + "filterNamePrefix": {}, + "nextToken": {}, + "limit": { + "type": "integer" + }, + "metricName": {}, + "metricNamespace": {} + } + }, + "output": { + "type": "structure", + "members": { + "metricFilters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "filterName": {}, + "filterPattern": {}, + "metricTransformations": { + "shape": "S1v" + }, + "creationTime": { + "type": "long" + }, + "logGroupName": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeQueries": { + "input": { + "type": "structure", + "members": { + "logGroupName": {}, + "status": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "queries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "queryId": {}, + "queryString": {}, + "status": {}, + "createTime": { + "type": "long" + }, + "logGroupName": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeResourcePolicies": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resourcePolicies": { + "type": "list", + "member": { + "shape": "S2a" + } + }, + "nextToken": {} + } + } + }, + "DescribeSubscriptionFilters": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {}, + "filterNamePrefix": {}, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "subscriptionFilters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "filterName": {}, + "logGroupName": {}, + "filterPattern": {}, + "destinationArn": {}, + "roleArn": {}, + "distribution": {}, + "creationTime": { + "type": "long" + } + } + } + }, + "nextToken": {} + } + } + }, + "DisassociateKmsKey": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {} + } + } + }, + "FilterLogEvents": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {}, + "logStreamNames": { + "type": "list", + "member": {} + }, + "logStreamNamePrefix": {}, + "startTime": { + "type": "long" + }, + "endTime": { + "type": "long" + }, + "filterPattern": {}, + "nextToken": {}, + "limit": { + "type": "integer" + }, + "interleaved": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "logStreamName": {}, + "timestamp": { + "type": "long" + }, + "message": {}, + "ingestionTime": { + "type": "long" + }, + "eventId": {} + } + } + }, + "searchedLogStreams": { + "type": "list", + "member": { + "type": "structure", + "members": { + "logStreamName": {}, + "searchedCompletely": { + "type": "boolean" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetLogEvents": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName" + ], + "members": { + "logGroupName": {}, + "logStreamName": {}, + "startTime": { + "type": "long" + }, + "endTime": { + "type": "long" + }, + "nextToken": {}, + "limit": { + "type": "integer" + }, + "startFromHead": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "timestamp": { + "type": "long" + }, + "message": {}, + "ingestionTime": { + "type": "long" + } + } + } + }, + "nextForwardToken": {}, + "nextBackwardToken": {} + } + } + }, + "GetLogGroupFields": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {}, + "time": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "logGroupFields": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "percent": { + "type": "integer" + } + } + } + } + } + } + }, + "GetLogRecord": { + "input": { + "type": "structure", + "required": [ + "logRecordPointer" + ], + "members": { + "logRecordPointer": {} + } + }, + "output": { + "type": "structure", + "members": { + "logRecord": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "GetQueryResults": { + "input": { + "type": "structure", + "required": [ + "queryId" + ], + "members": { + "queryId": {} + } + }, + "output": { + "type": "structure", + "members": { + "results": { + "type": "list", + "member": { + "type": "list", + "member": { + "type": "structure", + "members": { + "field": {}, + "value": {} + } + } + } + }, + "statistics": { + "type": "structure", + "members": { + "recordsMatched": { + "type": "double" + }, + "recordsScanned": { + "type": "double" + }, + "bytesScanned": { + "type": "double" + } + } + }, + "status": {} + } + } + }, + "ListTagsLogGroup": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {} + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Se" + } + } + } + }, + "PutDestination": { + "input": { + "type": "structure", + "required": [ + "destinationName", + "targetArn", + "roleArn" + ], + "members": { + "destinationName": {}, + "targetArn": {}, + "roleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "destination": { + "shape": "Sx" + } + } + } + }, + "PutDestinationPolicy": { + "input": { + "type": "structure", + "required": [ + "destinationName", + "accessPolicy" + ], + "members": { + "destinationName": {}, + "accessPolicy": {} + } + } + }, + "PutLogEvents": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName", + "logEvents" + ], + "members": { + "logGroupName": {}, + "logStreamName": {}, + "logEvents": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "timestamp", + "message" + ], + "members": { + "timestamp": { + "type": "long" + }, + "message": {} + } + } + }, + "sequenceToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "nextSequenceToken": {}, + "rejectedLogEventsInfo": { + "type": "structure", + "members": { + "tooNewLogEventStartIndex": { + "type": "integer" + }, + "tooOldLogEventEndIndex": { + "type": "integer" + }, + "expiredLogEventEndIndex": { + "type": "integer" + } + } + } + } + } + }, + "PutMetricFilter": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "filterName", + "filterPattern", + "metricTransformations" + ], + "members": { + "logGroupName": {}, + "filterName": {}, + "filterPattern": {}, + "metricTransformations": { + "shape": "S1v" + } + } + } + }, + "PutResourcePolicy": { + "input": { + "type": "structure", + "members": { + "policyName": {}, + "policyDocument": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourcePolicy": { + "shape": "S2a" + } + } + } + }, + "PutRetentionPolicy": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "retentionInDays" + ], + "members": { + "logGroupName": {}, + "retentionInDays": { + "type": "integer" + } + } + } + }, + "PutSubscriptionFilter": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "filterName", + "filterPattern", + "destinationArn" + ], + "members": { + "logGroupName": {}, + "filterName": {}, + "filterPattern": {}, + "destinationArn": {}, + "roleArn": {}, + "distribution": {} + } + } + }, + "StartQuery": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "startTime", + "endTime", + "queryString" + ], + "members": { + "logGroupName": {}, + "startTime": { + "type": "long" + }, + "endTime": { + "type": "long" + }, + "queryString": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "queryId": {} + } + } + }, + "StopQuery": { + "input": { + "type": "structure", + "required": [ + "queryId" + ], + "members": { + "queryId": {} + } + }, + "output": { + "type": "structure", + "members": { + "success": { + "type": "boolean" + } + } + } + }, + "TagLogGroup": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "tags" + ], + "members": { + "logGroupName": {}, + "tags": { + "shape": "Se" + } + } + } + }, + "TestMetricFilter": { + "input": { + "type": "structure", + "required": [ + "filterPattern", + "logEventMessages" + ], + "members": { + "filterPattern": {}, + "logEventMessages": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "matches": { + "type": "list", + "member": { + "type": "structure", + "members": { + "eventNumber": { + "type": "long" + }, + "eventMessage": {}, + "extractedValues": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + } + }, + "UntagLogGroup": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "tags" + ], + "members": { + "logGroupName": {}, + "tags": { + "type": "list", + "member": {} + } + } + } + } + }, + "shapes": { + "Se": { + "type": "map", + "key": {}, + "value": {} + }, + "Sx": { + "type": "structure", + "members": { + "destinationName": {}, + "targetArn": {}, + "roleArn": {}, + "accessPolicy": {}, + "arn": {}, + "creationTime": { + "type": "long" + } + } + }, + "S1v": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "metricName", + "metricNamespace", + "metricValue" + ], + "members": { + "metricName": {}, + "metricNamespace": {}, + "metricValue": {}, + "defaultValue": { + "type": "double" + } + } + } + }, + "S2a": { + "type": "structure", + "members": { + "policyName": {}, + "policyDocument": {}, + "lastUpdatedTime": { + "type": "long" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/logs-2014-03-28.paginators.json b/node_modules/aws-sdk/apis/logs-2014-03-28.paginators.json new file mode 100644 index 0000000..d702068 --- /dev/null +++ b/node_modules/aws-sdk/apis/logs-2014-03-28.paginators.json @@ -0,0 +1,49 @@ +{ + "pagination": { + "DescribeDestinations": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "destinations" + }, + "DescribeLogGroups": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "logGroups" + }, + "DescribeLogStreams": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "logStreams" + }, + "DescribeMetricFilters": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "metricFilters" + }, + "DescribeSubscriptionFilters": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "subscriptionFilters" + }, + "FilterLogEvents": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": [ + "events", + "searchedLogStreams" + ] + }, + "GetLogEvents": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextForwardToken", + "result_key": "events" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/machinelearning-2014-12-12.min.json b/node_modules/aws-sdk/apis/machinelearning-2014-12-12.min.json new file mode 100644 index 0000000..b926a89 --- /dev/null +++ b/node_modules/aws-sdk/apis/machinelearning-2014-12-12.min.json @@ -0,0 +1,1109 @@ +{ + "version": "2.0", + "metadata": { + "uid": "machinelearning-2014-12-12", + "apiVersion": "2014-12-12", + "endpointPrefix": "machinelearning", + "jsonVersion": "1.1", + "serviceFullName": "Amazon Machine Learning", + "serviceId": "Machine Learning", + "signatureVersion": "v4", + "targetPrefix": "AmazonML_20141212", + "protocol": "json" + }, + "operations": { + "AddTags": { + "input": { + "type": "structure", + "required": [ + "Tags", + "ResourceId", + "ResourceType" + ], + "members": { + "Tags": { + "shape": "S2" + }, + "ResourceId": {}, + "ResourceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceId": {}, + "ResourceType": {} + } + } + }, + "CreateBatchPrediction": { + "input": { + "type": "structure", + "required": [ + "BatchPredictionId", + "MLModelId", + "BatchPredictionDataSourceId", + "OutputUri" + ], + "members": { + "BatchPredictionId": {}, + "BatchPredictionName": {}, + "MLModelId": {}, + "BatchPredictionDataSourceId": {}, + "OutputUri": {} + } + }, + "output": { + "type": "structure", + "members": { + "BatchPredictionId": {} + } + } + }, + "CreateDataSourceFromRDS": { + "input": { + "type": "structure", + "required": [ + "DataSourceId", + "RDSData", + "RoleARN" + ], + "members": { + "DataSourceId": {}, + "DataSourceName": {}, + "RDSData": { + "type": "structure", + "required": [ + "DatabaseInformation", + "SelectSqlQuery", + "DatabaseCredentials", + "S3StagingLocation", + "ResourceRole", + "ServiceRole", + "SubnetId", + "SecurityGroupIds" + ], + "members": { + "DatabaseInformation": { + "shape": "Sf" + }, + "SelectSqlQuery": {}, + "DatabaseCredentials": { + "type": "structure", + "required": [ + "Username", + "Password" + ], + "members": { + "Username": {}, + "Password": {} + } + }, + "S3StagingLocation": {}, + "DataRearrangement": {}, + "DataSchema": {}, + "DataSchemaUri": {}, + "ResourceRole": {}, + "ServiceRole": {}, + "SubnetId": {}, + "SecurityGroupIds": { + "type": "list", + "member": {} + } + } + }, + "RoleARN": {}, + "ComputeStatistics": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DataSourceId": {} + } + } + }, + "CreateDataSourceFromRedshift": { + "input": { + "type": "structure", + "required": [ + "DataSourceId", + "DataSpec", + "RoleARN" + ], + "members": { + "DataSourceId": {}, + "DataSourceName": {}, + "DataSpec": { + "type": "structure", + "required": [ + "DatabaseInformation", + "SelectSqlQuery", + "DatabaseCredentials", + "S3StagingLocation" + ], + "members": { + "DatabaseInformation": { + "shape": "Sy" + }, + "SelectSqlQuery": {}, + "DatabaseCredentials": { + "type": "structure", + "required": [ + "Username", + "Password" + ], + "members": { + "Username": {}, + "Password": {} + } + }, + "S3StagingLocation": {}, + "DataRearrangement": {}, + "DataSchema": {}, + "DataSchemaUri": {} + } + }, + "RoleARN": {}, + "ComputeStatistics": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DataSourceId": {} + } + } + }, + "CreateDataSourceFromS3": { + "input": { + "type": "structure", + "required": [ + "DataSourceId", + "DataSpec" + ], + "members": { + "DataSourceId": {}, + "DataSourceName": {}, + "DataSpec": { + "type": "structure", + "required": [ + "DataLocationS3" + ], + "members": { + "DataLocationS3": {}, + "DataRearrangement": {}, + "DataSchema": {}, + "DataSchemaLocationS3": {} + } + }, + "ComputeStatistics": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DataSourceId": {} + } + } + }, + "CreateEvaluation": { + "input": { + "type": "structure", + "required": [ + "EvaluationId", + "MLModelId", + "EvaluationDataSourceId" + ], + "members": { + "EvaluationId": {}, + "EvaluationName": {}, + "MLModelId": {}, + "EvaluationDataSourceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "EvaluationId": {} + } + } + }, + "CreateMLModel": { + "input": { + "type": "structure", + "required": [ + "MLModelId", + "MLModelType", + "TrainingDataSourceId" + ], + "members": { + "MLModelId": {}, + "MLModelName": {}, + "MLModelType": {}, + "Parameters": { + "shape": "S1d" + }, + "TrainingDataSourceId": {}, + "Recipe": {}, + "RecipeUri": {} + } + }, + "output": { + "type": "structure", + "members": { + "MLModelId": {} + } + } + }, + "CreateRealtimeEndpoint": { + "input": { + "type": "structure", + "required": [ + "MLModelId" + ], + "members": { + "MLModelId": {} + } + }, + "output": { + "type": "structure", + "members": { + "MLModelId": {}, + "RealtimeEndpointInfo": { + "shape": "S1j" + } + } + } + }, + "DeleteBatchPrediction": { + "input": { + "type": "structure", + "required": [ + "BatchPredictionId" + ], + "members": { + "BatchPredictionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "BatchPredictionId": {} + } + } + }, + "DeleteDataSource": { + "input": { + "type": "structure", + "required": [ + "DataSourceId" + ], + "members": { + "DataSourceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "DataSourceId": {} + } + } + }, + "DeleteEvaluation": { + "input": { + "type": "structure", + "required": [ + "EvaluationId" + ], + "members": { + "EvaluationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "EvaluationId": {} + } + } + }, + "DeleteMLModel": { + "input": { + "type": "structure", + "required": [ + "MLModelId" + ], + "members": { + "MLModelId": {} + } + }, + "output": { + "type": "structure", + "members": { + "MLModelId": {} + } + } + }, + "DeleteRealtimeEndpoint": { + "input": { + "type": "structure", + "required": [ + "MLModelId" + ], + "members": { + "MLModelId": {} + } + }, + "output": { + "type": "structure", + "members": { + "MLModelId": {}, + "RealtimeEndpointInfo": { + "shape": "S1j" + } + } + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "TagKeys", + "ResourceId", + "ResourceType" + ], + "members": { + "TagKeys": { + "type": "list", + "member": {} + }, + "ResourceId": {}, + "ResourceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceId": {}, + "ResourceType": {} + } + } + }, + "DescribeBatchPredictions": { + "input": { + "type": "structure", + "members": { + "FilterVariable": {}, + "EQ": {}, + "GT": {}, + "LT": {}, + "GE": {}, + "LE": {}, + "NE": {}, + "Prefix": {}, + "SortOrder": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BatchPredictionId": {}, + "MLModelId": {}, + "BatchPredictionDataSourceId": {}, + "InputDataLocationS3": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Name": {}, + "Status": {}, + "OutputUri": {}, + "Message": {}, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + }, + "TotalRecordCount": { + "type": "long" + }, + "InvalidRecordCount": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeDataSources": { + "input": { + "type": "structure", + "members": { + "FilterVariable": {}, + "EQ": {}, + "GT": {}, + "LT": {}, + "GE": {}, + "LE": {}, + "NE": {}, + "Prefix": {}, + "SortOrder": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DataSourceId": {}, + "DataLocationS3": {}, + "DataRearrangement": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "DataSizeInBytes": { + "type": "long" + }, + "NumberOfFiles": { + "type": "long" + }, + "Name": {}, + "Status": {}, + "Message": {}, + "RedshiftMetadata": { + "shape": "S2i" + }, + "RDSMetadata": { + "shape": "S2j" + }, + "RoleARN": {}, + "ComputeStatistics": { + "type": "boolean" + }, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeEvaluations": { + "input": { + "type": "structure", + "members": { + "FilterVariable": {}, + "EQ": {}, + "GT": {}, + "LT": {}, + "GE": {}, + "LE": {}, + "NE": {}, + "Prefix": {}, + "SortOrder": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EvaluationId": {}, + "MLModelId": {}, + "EvaluationDataSourceId": {}, + "InputDataLocationS3": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Name": {}, + "Status": {}, + "PerformanceMetrics": { + "shape": "S2q" + }, + "Message": {}, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMLModels": { + "input": { + "type": "structure", + "members": { + "FilterVariable": {}, + "EQ": {}, + "GT": {}, + "LT": {}, + "GE": {}, + "LE": {}, + "NE": {}, + "Prefix": {}, + "SortOrder": {}, + "NextToken": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": { + "type": "structure", + "members": { + "MLModelId": {}, + "TrainingDataSourceId": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Name": {}, + "Status": {}, + "SizeInBytes": { + "type": "long" + }, + "EndpointInfo": { + "shape": "S1j" + }, + "TrainingParameters": { + "shape": "S1d" + }, + "InputDataLocationS3": {}, + "Algorithm": {}, + "MLModelType": {}, + "ScoreThreshold": { + "type": "float" + }, + "ScoreThresholdLastUpdatedAt": { + "type": "timestamp" + }, + "Message": {}, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "ResourceType" + ], + "members": { + "ResourceId": {}, + "ResourceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceId": {}, + "ResourceType": {}, + "Tags": { + "shape": "S2" + } + } + } + }, + "GetBatchPrediction": { + "input": { + "type": "structure", + "required": [ + "BatchPredictionId" + ], + "members": { + "BatchPredictionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "BatchPredictionId": {}, + "MLModelId": {}, + "BatchPredictionDataSourceId": {}, + "InputDataLocationS3": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Name": {}, + "Status": {}, + "OutputUri": {}, + "LogUri": {}, + "Message": {}, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + }, + "TotalRecordCount": { + "type": "long" + }, + "InvalidRecordCount": { + "type": "long" + } + } + } + }, + "GetDataSource": { + "input": { + "type": "structure", + "required": [ + "DataSourceId" + ], + "members": { + "DataSourceId": {}, + "Verbose": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DataSourceId": {}, + "DataLocationS3": {}, + "DataRearrangement": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "DataSizeInBytes": { + "type": "long" + }, + "NumberOfFiles": { + "type": "long" + }, + "Name": {}, + "Status": {}, + "LogUri": {}, + "Message": {}, + "RedshiftMetadata": { + "shape": "S2i" + }, + "RDSMetadata": { + "shape": "S2j" + }, + "RoleARN": {}, + "ComputeStatistics": { + "type": "boolean" + }, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + }, + "DataSourceSchema": {} + } + } + }, + "GetEvaluation": { + "input": { + "type": "structure", + "required": [ + "EvaluationId" + ], + "members": { + "EvaluationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "EvaluationId": {}, + "MLModelId": {}, + "EvaluationDataSourceId": {}, + "InputDataLocationS3": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Name": {}, + "Status": {}, + "PerformanceMetrics": { + "shape": "S2q" + }, + "LogUri": {}, + "Message": {}, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + } + } + } + }, + "GetMLModel": { + "input": { + "type": "structure", + "required": [ + "MLModelId" + ], + "members": { + "MLModelId": {}, + "Verbose": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "MLModelId": {}, + "TrainingDataSourceId": {}, + "CreatedByIamUser": {}, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + }, + "Name": {}, + "Status": {}, + "SizeInBytes": { + "type": "long" + }, + "EndpointInfo": { + "shape": "S1j" + }, + "TrainingParameters": { + "shape": "S1d" + }, + "InputDataLocationS3": {}, + "MLModelType": {}, + "ScoreThreshold": { + "type": "float" + }, + "ScoreThresholdLastUpdatedAt": { + "type": "timestamp" + }, + "LogUri": {}, + "Message": {}, + "ComputeTime": { + "type": "long" + }, + "FinishedAt": { + "type": "timestamp" + }, + "StartedAt": { + "type": "timestamp" + }, + "Recipe": {}, + "Schema": {} + } + } + }, + "Predict": { + "input": { + "type": "structure", + "required": [ + "MLModelId", + "Record", + "PredictEndpoint" + ], + "members": { + "MLModelId": {}, + "Record": { + "type": "map", + "key": {}, + "value": {} + }, + "PredictEndpoint": {} + } + }, + "output": { + "type": "structure", + "members": { + "Prediction": { + "type": "structure", + "members": { + "predictedLabel": {}, + "predictedValue": { + "type": "float" + }, + "predictedScores": { + "type": "map", + "key": {}, + "value": { + "type": "float" + } + }, + "details": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + }, + "UpdateBatchPrediction": { + "input": { + "type": "structure", + "required": [ + "BatchPredictionId", + "BatchPredictionName" + ], + "members": { + "BatchPredictionId": {}, + "BatchPredictionName": {} + } + }, + "output": { + "type": "structure", + "members": { + "BatchPredictionId": {} + } + } + }, + "UpdateDataSource": { + "input": { + "type": "structure", + "required": [ + "DataSourceId", + "DataSourceName" + ], + "members": { + "DataSourceId": {}, + "DataSourceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DataSourceId": {} + } + } + }, + "UpdateEvaluation": { + "input": { + "type": "structure", + "required": [ + "EvaluationId", + "EvaluationName" + ], + "members": { + "EvaluationId": {}, + "EvaluationName": {} + } + }, + "output": { + "type": "structure", + "members": { + "EvaluationId": {} + } + } + }, + "UpdateMLModel": { + "input": { + "type": "structure", + "required": [ + "MLModelId" + ], + "members": { + "MLModelId": {}, + "MLModelName": {}, + "ScoreThreshold": { + "type": "float" + } + } + }, + "output": { + "type": "structure", + "members": { + "MLModelId": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sf": { + "type": "structure", + "required": [ + "InstanceIdentifier", + "DatabaseName" + ], + "members": { + "InstanceIdentifier": {}, + "DatabaseName": {} + } + }, + "Sy": { + "type": "structure", + "required": [ + "DatabaseName", + "ClusterIdentifier" + ], + "members": { + "DatabaseName": {}, + "ClusterIdentifier": {} + } + }, + "S1d": { + "type": "map", + "key": {}, + "value": {} + }, + "S1j": { + "type": "structure", + "members": { + "PeakRequestsPerSecond": { + "type": "integer" + }, + "CreatedAt": { + "type": "timestamp" + }, + "EndpointUrl": {}, + "EndpointStatus": {} + } + }, + "S2i": { + "type": "structure", + "members": { + "RedshiftDatabase": { + "shape": "Sy" + }, + "DatabaseUserName": {}, + "SelectSqlQuery": {} + } + }, + "S2j": { + "type": "structure", + "members": { + "Database": { + "shape": "Sf" + }, + "DatabaseUserName": {}, + "SelectSqlQuery": {}, + "ResourceRole": {}, + "ServiceRole": {}, + "DataPipelineId": {} + } + }, + "S2q": { + "type": "structure", + "members": { + "Properties": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "examples": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/machinelearning-2014-12-12.paginators.json b/node_modules/aws-sdk/apis/machinelearning-2014-12-12.paginators.json new file mode 100644 index 0000000..c13ce65 --- /dev/null +++ b/node_modules/aws-sdk/apis/machinelearning-2014-12-12.paginators.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "DescribeBatchPredictions": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + }, + "DescribeDataSources": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + }, + "DescribeEvaluations": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + }, + "DescribeMLModels": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + } + } +} diff --git a/node_modules/aws-sdk/apis/machinelearning-2014-12-12.waiters2.json b/node_modules/aws-sdk/apis/machinelearning-2014-12-12.waiters2.json new file mode 100644 index 0000000..da6b1c9 --- /dev/null +++ b/node_modules/aws-sdk/apis/machinelearning-2014-12-12.waiters2.json @@ -0,0 +1,81 @@ +{ + "version": 2, + "waiters": { + "DataSourceAvailable": { + "delay": 30, + "operation": "DescribeDataSources", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + }, + "MLModelAvailable": { + "delay": 30, + "operation": "DescribeMLModels", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + }, + "EvaluationAvailable": { + "delay": 30, + "operation": "DescribeEvaluations", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + }, + "BatchPredictionAvailable": { + "delay": 30, + "operation": "DescribeBatchPredictions", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/macie-2017-12-19.examples.json b/node_modules/aws-sdk/apis/macie-2017-12-19.examples.json new file mode 100644 index 0000000..faff768 --- /dev/null +++ b/node_modules/aws-sdk/apis/macie-2017-12-19.examples.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/node_modules/aws-sdk/apis/macie-2017-12-19.min.json b/node_modules/aws-sdk/apis/macie-2017-12-19.min.json new file mode 100644 index 0000000..a4bab61 --- /dev/null +++ b/node_modules/aws-sdk/apis/macie-2017-12-19.min.json @@ -0,0 +1,222 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-12-19", + "endpointPrefix": "macie", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Macie", + "serviceId": "Macie", + "signatureVersion": "v4", + "targetPrefix": "MacieService", + "uid": "macie-2017-12-19" + }, + "operations": { + "AssociateMemberAccount": { + "input": { + "type": "structure", + "required": [ + "memberAccountId" + ], + "members": { + "memberAccountId": {} + } + } + }, + "AssociateS3Resources": { + "input": { + "type": "structure", + "required": [ + "s3Resources" + ], + "members": { + "memberAccountId": {}, + "s3Resources": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "failedS3Resources": { + "shape": "Sc" + } + } + } + }, + "DisassociateMemberAccount": { + "input": { + "type": "structure", + "required": [ + "memberAccountId" + ], + "members": { + "memberAccountId": {} + } + } + }, + "DisassociateS3Resources": { + "input": { + "type": "structure", + "required": [ + "associatedS3Resources" + ], + "members": { + "memberAccountId": {}, + "associatedS3Resources": { + "type": "list", + "member": { + "shape": "Se" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "failedS3Resources": { + "shape": "Sc" + } + } + } + }, + "ListMemberAccounts": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "memberAccounts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "accountId": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListS3Resources": { + "input": { + "type": "structure", + "members": { + "memberAccountId": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "s3Resources": { + "shape": "S4" + }, + "nextToken": {} + } + } + }, + "UpdateS3Resources": { + "input": { + "type": "structure", + "required": [ + "s3ResourcesUpdate" + ], + "members": { + "memberAccountId": {}, + "s3ResourcesUpdate": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "bucketName", + "classificationTypeUpdate" + ], + "members": { + "bucketName": {}, + "prefix": {}, + "classificationTypeUpdate": { + "type": "structure", + "members": { + "oneTime": {}, + "continuous": {} + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "failedS3Resources": { + "shape": "Sc" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "bucketName", + "classificationType" + ], + "members": { + "bucketName": {}, + "prefix": {}, + "classificationType": { + "type": "structure", + "required": [ + "oneTime", + "continuous" + ], + "members": { + "oneTime": {}, + "continuous": {} + } + } + } + } + }, + "Sc": { + "type": "list", + "member": { + "type": "structure", + "members": { + "failedItem": { + "shape": "Se" + }, + "errorCode": {}, + "errorMessage": {} + } + } + }, + "Se": { + "type": "structure", + "required": [ + "bucketName" + ], + "members": { + "bucketName": {}, + "prefix": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/macie-2017-12-19.paginators.json b/node_modules/aws-sdk/apis/macie-2017-12-19.paginators.json new file mode 100644 index 0000000..0b3465f --- /dev/null +++ b/node_modules/aws-sdk/apis/macie-2017-12-19.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination":{ + "ListMemberAccounts":{ + "input_token":"nextToken", + "output_token":"nextToken", + "limit_key":"maxResults" + }, + "ListS3Resources":{ + "input_token":"nextToken", + "output_token":"nextToken", + "limit_key":"maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.examples.json b/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.min.json b/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.min.json new file mode 100644 index 0000000..f1c0733 --- /dev/null +++ b/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.min.json @@ -0,0 +1,920 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-09-24", + "endpointPrefix": "managedblockchain", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "ManagedBlockchain", + "serviceFullName": "Amazon Managed Blockchain", + "serviceId": "ManagedBlockchain", + "signatureVersion": "v4", + "signingName": "managedblockchain", + "uid": "managedblockchain-2018-09-24" + }, + "operations": { + "CreateMember": { + "http": { + "requestUri": "/networks/{networkId}/members" + }, + "input": { + "type": "structure", + "required": [ + "ClientRequestToken", + "InvitationId", + "NetworkId", + "MemberConfiguration" + ], + "members": { + "ClientRequestToken": { + "idempotencyToken": true + }, + "InvitationId": {}, + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberConfiguration": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "MemberId": {} + } + } + }, + "CreateNetwork": { + "http": { + "requestUri": "/networks" + }, + "input": { + "type": "structure", + "required": [ + "ClientRequestToken", + "Name", + "Framework", + "FrameworkVersion", + "VotingPolicy", + "MemberConfiguration" + ], + "members": { + "ClientRequestToken": { + "idempotencyToken": true + }, + "Name": {}, + "Description": {}, + "Framework": {}, + "FrameworkVersion": {}, + "FrameworkConfiguration": { + "type": "structure", + "members": { + "Fabric": { + "type": "structure", + "required": [ + "Edition" + ], + "members": { + "Edition": {} + } + } + } + }, + "VotingPolicy": { + "shape": "Sj" + }, + "MemberConfiguration": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkId": {}, + "MemberId": {} + } + } + }, + "CreateNode": { + "http": { + "requestUri": "/networks/{networkId}/members/{memberId}/nodes" + }, + "input": { + "type": "structure", + "required": [ + "ClientRequestToken", + "NetworkId", + "MemberId", + "NodeConfiguration" + ], + "members": { + "ClientRequestToken": { + "idempotencyToken": true + }, + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberId": { + "location": "uri", + "locationName": "memberId" + }, + "NodeConfiguration": { + "type": "structure", + "required": [ + "InstanceType", + "AvailabilityZone" + ], + "members": { + "InstanceType": {}, + "AvailabilityZone": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "NodeId": {} + } + } + }, + "CreateProposal": { + "http": { + "requestUri": "/networks/{networkId}/proposals" + }, + "input": { + "type": "structure", + "required": [ + "ClientRequestToken", + "NetworkId", + "MemberId", + "Actions" + ], + "members": { + "ClientRequestToken": { + "idempotencyToken": true + }, + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberId": {}, + "Actions": { + "shape": "Sv" + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProposalId": {} + } + } + }, + "DeleteMember": { + "http": { + "method": "DELETE", + "requestUri": "/networks/{networkId}/members/{memberId}" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "MemberId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberId": { + "location": "uri", + "locationName": "memberId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteNode": { + "http": { + "method": "DELETE", + "requestUri": "/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "MemberId", + "NodeId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberId": { + "location": "uri", + "locationName": "memberId" + }, + "NodeId": { + "location": "uri", + "locationName": "nodeId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetMember": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}/members/{memberId}" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "MemberId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberId": { + "location": "uri", + "locationName": "memberId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Member": { + "type": "structure", + "members": { + "NetworkId": {}, + "Id": {}, + "Name": {}, + "Description": {}, + "FrameworkAttributes": { + "type": "structure", + "members": { + "Fabric": { + "type": "structure", + "members": { + "AdminUsername": {}, + "CaEndpoint": {} + } + } + } + }, + "Status": {}, + "CreationDate": { + "shape": "S1d" + } + } + } + } + } + }, + "GetNetwork": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Network": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Description": {}, + "Framework": {}, + "FrameworkVersion": {}, + "FrameworkAttributes": { + "type": "structure", + "members": { + "Fabric": { + "type": "structure", + "members": { + "OrderingServiceEndpoint": {}, + "Edition": {} + } + } + } + }, + "VpcEndpointServiceName": {}, + "VotingPolicy": { + "shape": "Sj" + }, + "Status": {}, + "CreationDate": { + "shape": "S1d" + } + } + } + } + } + }, + "GetNode": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "MemberId", + "NodeId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberId": { + "location": "uri", + "locationName": "memberId" + }, + "NodeId": { + "location": "uri", + "locationName": "nodeId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Node": { + "type": "structure", + "members": { + "NetworkId": {}, + "MemberId": {}, + "Id": {}, + "InstanceType": {}, + "AvailabilityZone": {}, + "FrameworkAttributes": { + "type": "structure", + "members": { + "Fabric": { + "type": "structure", + "members": { + "PeerEndpoint": {}, + "PeerEventEndpoint": {} + } + } + } + }, + "Status": {}, + "CreationDate": { + "shape": "S1d" + } + } + } + } + } + }, + "GetProposal": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}/proposals/{proposalId}" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "ProposalId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "ProposalId": { + "location": "uri", + "locationName": "proposalId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Proposal": { + "type": "structure", + "members": { + "ProposalId": {}, + "NetworkId": {}, + "Description": {}, + "Actions": { + "shape": "Sv" + }, + "ProposedByMemberId": {}, + "ProposedByMemberName": {}, + "Status": {}, + "CreationDate": { + "shape": "S1d" + }, + "ExpirationDate": { + "shape": "S1d" + }, + "YesVoteCount": { + "type": "integer" + }, + "NoVoteCount": { + "type": "integer" + }, + "OutstandingVoteCount": { + "type": "integer" + } + } + } + } + } + }, + "ListInvitations": { + "http": { + "method": "GET", + "requestUri": "/invitations" + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invitations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InvitationId": {}, + "CreationDate": { + "shape": "S1d" + }, + "ExpirationDate": { + "shape": "S1d" + }, + "Status": {}, + "NetworkSummary": { + "shape": "S22" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListMembers": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}/members" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "Name": { + "location": "querystring", + "locationName": "name" + }, + "Status": { + "location": "querystring", + "locationName": "status" + }, + "IsOwned": { + "location": "querystring", + "locationName": "isOwned", + "type": "boolean" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Members": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Description": {}, + "Status": {}, + "CreationDate": { + "shape": "S1d" + }, + "IsOwned": { + "type": "boolean" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListNetworks": { + "http": { + "method": "GET", + "requestUri": "/networks" + }, + "input": { + "type": "structure", + "members": { + "Name": { + "location": "querystring", + "locationName": "name" + }, + "Framework": { + "location": "querystring", + "locationName": "framework" + }, + "Status": { + "location": "querystring", + "locationName": "status" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Networks": { + "type": "list", + "member": { + "shape": "S22" + } + }, + "NextToken": {} + } + } + }, + "ListNodes": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}/members/{memberId}/nodes" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "MemberId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MemberId": { + "location": "uri", + "locationName": "memberId" + }, + "Status": { + "location": "querystring", + "locationName": "status" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Nodes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Status": {}, + "CreationDate": { + "shape": "S1d" + }, + "AvailabilityZone": {}, + "InstanceType": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListProposalVotes": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}/proposals/{proposalId}/votes" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "ProposalId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "ProposalId": { + "location": "uri", + "locationName": "proposalId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProposalVotes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Vote": {}, + "MemberName": {}, + "MemberId": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListProposals": { + "http": { + "method": "GET", + "requestUri": "/networks/{networkId}/proposals" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Proposals": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProposalId": {}, + "Description": {}, + "ProposedByMemberId": {}, + "ProposedByMemberName": {}, + "Status": {}, + "CreationDate": { + "shape": "S1d" + }, + "ExpirationDate": { + "shape": "S1d" + } + } + } + }, + "NextToken": {} + } + } + }, + "RejectInvitation": { + "http": { + "method": "DELETE", + "requestUri": "/invitations/{invitationId}" + }, + "input": { + "type": "structure", + "required": [ + "InvitationId" + ], + "members": { + "InvitationId": { + "location": "uri", + "locationName": "invitationId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "VoteOnProposal": { + "http": { + "requestUri": "/networks/{networkId}/proposals/{proposalId}/votes" + }, + "input": { + "type": "structure", + "required": [ + "NetworkId", + "ProposalId", + "VoterMemberId", + "Vote" + ], + "members": { + "NetworkId": { + "location": "uri", + "locationName": "networkId" + }, + "ProposalId": { + "location": "uri", + "locationName": "proposalId" + }, + "VoterMemberId": {}, + "Vote": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "Name", + "FrameworkConfiguration" + ], + "members": { + "Name": {}, + "Description": {}, + "FrameworkConfiguration": { + "type": "structure", + "members": { + "Fabric": { + "type": "structure", + "required": [ + "AdminUsername", + "AdminPassword" + ], + "members": { + "AdminUsername": {}, + "AdminPassword": { + "type": "string", + "sensitive": true + } + } + } + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "ApprovalThresholdPolicy": { + "type": "structure", + "members": { + "ThresholdPercentage": { + "type": "integer" + }, + "ProposalDurationInHours": { + "type": "integer" + }, + "ThresholdComparator": {} + } + } + } + }, + "Sv": { + "type": "structure", + "members": { + "Invitations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Principal" + ], + "members": { + "Principal": {} + } + } + }, + "Removals": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "MemberId" + ], + "members": { + "MemberId": {} + } + } + } + } + }, + "S1d": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "S22": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Description": {}, + "Framework": {}, + "FrameworkVersion": {}, + "Status": {}, + "CreationDate": { + "shape": "S1d" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.paginators.json b/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.paginators.json new file mode 100644 index 0000000..e6864d2 --- /dev/null +++ b/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.paginators.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListInvitations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListMembers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNetworks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNodes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListProposalVotes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListProposals": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.examples.json b/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.min.json b/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.min.json new file mode 100644 index 0000000..837684b --- /dev/null +++ b/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.min.json @@ -0,0 +1,86 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-07-01", + "endpointPrefix": "marketplacecommerceanalytics", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Marketplace Commerce Analytics", + "serviceId": "Marketplace Commerce Analytics", + "signatureVersion": "v4", + "signingName": "marketplacecommerceanalytics", + "targetPrefix": "MarketplaceCommerceAnalytics20150701", + "uid": "marketplacecommerceanalytics-2015-07-01" + }, + "operations": { + "GenerateDataSet": { + "input": { + "type": "structure", + "required": [ + "dataSetType", + "dataSetPublicationDate", + "roleNameArn", + "destinationS3BucketName", + "snsTopicArn" + ], + "members": { + "dataSetType": {}, + "dataSetPublicationDate": { + "type": "timestamp" + }, + "roleNameArn": {}, + "destinationS3BucketName": {}, + "destinationS3Prefix": {}, + "snsTopicArn": {}, + "customerDefinedValues": { + "shape": "S8" + } + } + }, + "output": { + "type": "structure", + "members": { + "dataSetRequestId": {} + } + } + }, + "StartSupportDataExport": { + "input": { + "type": "structure", + "required": [ + "dataSetType", + "fromDate", + "roleNameArn", + "destinationS3BucketName", + "snsTopicArn" + ], + "members": { + "dataSetType": {}, + "fromDate": { + "type": "timestamp" + }, + "roleNameArn": {}, + "destinationS3BucketName": {}, + "destinationS3Prefix": {}, + "snsTopicArn": {}, + "customerDefinedValues": { + "shape": "S8" + } + } + }, + "output": { + "type": "structure", + "members": { + "dataSetRequestId": {} + } + } + } + }, + "shapes": { + "S8": { + "type": "map", + "key": {}, + "value": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.paginators.json b/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/marketplacecommerceanalytics-2015-07-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.min.json b/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.min.json new file mode 100644 index 0000000..20d8c62 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.min.json @@ -0,0 +1,1034 @@ +{ + "metadata": { + "apiVersion": "2018-11-14", + "endpointPrefix": "mediaconnect", + "signingName": "mediaconnect", + "serviceFullName": "AWS MediaConnect", + "serviceId": "MediaConnect", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "mediaconnect-2018-11-14", + "signatureVersion": "v4" + }, + "operations": { + "AddFlowOutputs": { + "http": { + "requestUri": "/v1/flows/{flowArn}/outputs", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + }, + "Outputs": { + "shape": "S3", + "locationName": "outputs" + } + }, + "required": [ + "FlowArn", + "Outputs" + ] + }, + "output": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + }, + "Outputs": { + "shape": "Sb", + "locationName": "outputs" + } + } + } + }, + "CreateFlow": { + "http": { + "requestUri": "/v1/flows", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Entitlements": { + "shape": "Sf", + "locationName": "entitlements" + }, + "Name": { + "locationName": "name" + }, + "Outputs": { + "shape": "S3", + "locationName": "outputs" + }, + "Source": { + "locationName": "source", + "type": "structure", + "members": { + "Decryption": { + "shape": "S5", + "locationName": "decryption" + }, + "Description": { + "locationName": "description" + }, + "EntitlementArn": { + "locationName": "entitlementArn" + }, + "IngestPort": { + "locationName": "ingestPort", + "type": "integer" + }, + "MaxBitrate": { + "locationName": "maxBitrate", + "type": "integer" + }, + "MaxLatency": { + "locationName": "maxLatency", + "type": "integer" + }, + "Name": { + "locationName": "name" + }, + "Protocol": { + "locationName": "protocol" + }, + "StreamId": { + "locationName": "streamId" + }, + "WhitelistCidr": { + "locationName": "whitelistCidr" + } + } + } + }, + "required": [ + "Source", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Flow": { + "shape": "Sk", + "locationName": "flow" + } + } + } + }, + "DeleteFlow": { + "http": { + "method": "DELETE", + "requestUri": "/v1/flows/{flowArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + } + }, + "required": [ + "FlowArn" + ] + }, + "output": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "DescribeFlow": { + "http": { + "method": "GET", + "requestUri": "/v1/flows/{flowArn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + } + }, + "required": [ + "FlowArn" + ] + }, + "output": { + "type": "structure", + "members": { + "Flow": { + "shape": "Sk", + "locationName": "flow" + }, + "Messages": { + "locationName": "messages", + "type": "structure", + "members": { + "Errors": { + "shape": "Sh", + "locationName": "errors" + } + }, + "required": [ + "Errors" + ] + } + } + } + }, + "GrantFlowEntitlements": { + "http": { + "requestUri": "/v1/flows/{flowArn}/entitlements", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Entitlements": { + "shape": "Sf", + "locationName": "entitlements" + }, + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + } + }, + "required": [ + "FlowArn", + "Entitlements" + ] + }, + "output": { + "type": "structure", + "members": { + "Entitlements": { + "shape": "Sl", + "locationName": "entitlements" + }, + "FlowArn": { + "locationName": "flowArn" + } + } + } + }, + "ListEntitlements": { + "http": { + "method": "GET", + "requestUri": "/v1/entitlements", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Entitlements": { + "locationName": "entitlements", + "type": "list", + "member": { + "type": "structure", + "members": { + "EntitlementArn": { + "locationName": "entitlementArn" + }, + "EntitlementName": { + "locationName": "entitlementName" + } + }, + "required": [ + "EntitlementArn", + "EntitlementName" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListFlows": { + "http": { + "method": "GET", + "requestUri": "/v1/flows", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Flows": { + "locationName": "flows", + "type": "list", + "member": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Description": { + "locationName": "description" + }, + "FlowArn": { + "locationName": "flowArn" + }, + "Name": { + "locationName": "name" + }, + "SourceType": { + "locationName": "sourceType" + }, + "Status": { + "locationName": "status" + } + }, + "required": [ + "Status", + "Description", + "SourceType", + "AvailabilityZone", + "FlowArn", + "Name" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S18", + "locationName": "tags" + } + } + } + }, + "RemoveFlowOutput": { + "http": { + "method": "DELETE", + "requestUri": "/v1/flows/{flowArn}/outputs/{outputArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + }, + "OutputArn": { + "location": "uri", + "locationName": "outputArn" + } + }, + "required": [ + "FlowArn", + "OutputArn" + ] + }, + "output": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + }, + "OutputArn": { + "locationName": "outputArn" + } + } + } + }, + "RevokeFlowEntitlement": { + "http": { + "method": "DELETE", + "requestUri": "/v1/flows/{flowArn}/entitlements/{entitlementArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "EntitlementArn": { + "location": "uri", + "locationName": "entitlementArn" + }, + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + } + }, + "required": [ + "FlowArn", + "EntitlementArn" + ] + }, + "output": { + "type": "structure", + "members": { + "EntitlementArn": { + "locationName": "entitlementArn" + }, + "FlowArn": { + "locationName": "flowArn" + } + } + } + }, + "StartFlow": { + "http": { + "requestUri": "/v1/flows/start/{flowArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + } + }, + "required": [ + "FlowArn" + ] + }, + "output": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "StopFlow": { + "http": { + "requestUri": "/v1/flows/stop/{flowArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + } + }, + "required": [ + "FlowArn" + ] + }, + "output": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + }, + "Status": { + "locationName": "status" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "Tags": { + "shape": "S18", + "locationName": "tags" + } + }, + "required": [ + "ResourceArn", + "Tags" + ] + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "TagKeys": { + "shape": "Sh", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + } + }, + "UpdateFlowEntitlement": { + "http": { + "method": "PUT", + "requestUri": "/v1/flows/{flowArn}/entitlements/{entitlementArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Encryption": { + "shape": "S1k", + "locationName": "encryption" + }, + "EntitlementArn": { + "location": "uri", + "locationName": "entitlementArn" + }, + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + }, + "Subscribers": { + "shape": "Sh", + "locationName": "subscribers" + } + }, + "required": [ + "FlowArn", + "EntitlementArn" + ] + }, + "output": { + "type": "structure", + "members": { + "Entitlement": { + "shape": "Sm", + "locationName": "entitlement" + }, + "FlowArn": { + "locationName": "flowArn" + } + } + } + }, + "UpdateFlowOutput": { + "http": { + "method": "PUT", + "requestUri": "/v1/flows/{flowArn}/outputs/{outputArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Destination": { + "locationName": "destination" + }, + "Encryption": { + "shape": "S1k", + "locationName": "encryption" + }, + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + }, + "MaxLatency": { + "locationName": "maxLatency", + "type": "integer" + }, + "OutputArn": { + "location": "uri", + "locationName": "outputArn" + }, + "Port": { + "locationName": "port", + "type": "integer" + }, + "Protocol": { + "locationName": "protocol" + }, + "SmoothingLatency": { + "locationName": "smoothingLatency", + "type": "integer" + }, + "StreamId": { + "locationName": "streamId" + } + }, + "required": [ + "FlowArn", + "OutputArn" + ] + }, + "output": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + }, + "Output": { + "shape": "Sc", + "locationName": "output" + } + } + } + }, + "UpdateFlowSource": { + "http": { + "method": "PUT", + "requestUri": "/v1/flows/{flowArn}/source/{sourceArn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Decryption": { + "shape": "S1k", + "locationName": "decryption" + }, + "Description": { + "locationName": "description" + }, + "EntitlementArn": { + "locationName": "entitlementArn" + }, + "FlowArn": { + "location": "uri", + "locationName": "flowArn" + }, + "IngestPort": { + "locationName": "ingestPort", + "type": "integer" + }, + "MaxBitrate": { + "locationName": "maxBitrate", + "type": "integer" + }, + "MaxLatency": { + "locationName": "maxLatency", + "type": "integer" + }, + "Protocol": { + "locationName": "protocol" + }, + "SourceArn": { + "location": "uri", + "locationName": "sourceArn" + }, + "StreamId": { + "locationName": "streamId" + }, + "WhitelistCidr": { + "locationName": "whitelistCidr" + } + }, + "required": [ + "FlowArn", + "SourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + }, + "Source": { + "shape": "Sn", + "locationName": "source" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Destination": { + "locationName": "destination" + }, + "Encryption": { + "shape": "S5", + "locationName": "encryption" + }, + "MaxLatency": { + "locationName": "maxLatency", + "type": "integer" + }, + "Name": { + "locationName": "name" + }, + "Port": { + "locationName": "port", + "type": "integer" + }, + "Protocol": { + "locationName": "protocol" + }, + "SmoothingLatency": { + "locationName": "smoothingLatency", + "type": "integer" + }, + "StreamId": { + "locationName": "streamId" + } + }, + "required": [ + "Destination", + "Port", + "Protocol" + ] + } + }, + "S5": { + "type": "structure", + "members": { + "Algorithm": { + "locationName": "algorithm" + }, + "KeyType": { + "locationName": "keyType" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "SecretArn": { + "locationName": "secretArn" + } + }, + "required": [ + "SecretArn", + "Algorithm", + "RoleArn" + ] + }, + "Sb": { + "type": "list", + "member": { + "shape": "Sc" + } + }, + "Sc": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Destination": { + "locationName": "destination" + }, + "Encryption": { + "shape": "S5", + "locationName": "encryption" + }, + "EntitlementArn": { + "locationName": "entitlementArn" + }, + "MediaLiveInputArn": { + "locationName": "mediaLiveInputArn" + }, + "Name": { + "locationName": "name" + }, + "OutputArn": { + "locationName": "outputArn" + }, + "Port": { + "locationName": "port", + "type": "integer" + }, + "Transport": { + "shape": "Sd", + "locationName": "transport" + } + }, + "required": [ + "OutputArn", + "Name" + ] + }, + "Sd": { + "type": "structure", + "members": { + "MaxBitrate": { + "locationName": "maxBitrate", + "type": "integer" + }, + "MaxLatency": { + "locationName": "maxLatency", + "type": "integer" + }, + "Protocol": { + "locationName": "protocol" + }, + "SmoothingLatency": { + "locationName": "smoothingLatency", + "type": "integer" + }, + "StreamId": { + "locationName": "streamId" + } + }, + "required": [ + "Protocol" + ] + }, + "Sf": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Encryption": { + "shape": "S5", + "locationName": "encryption" + }, + "Name": { + "locationName": "name" + }, + "Subscribers": { + "shape": "Sh", + "locationName": "subscribers" + } + }, + "required": [ + "Subscribers" + ] + } + }, + "Sh": { + "type": "list", + "member": {} + }, + "Sk": { + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "Description": { + "locationName": "description" + }, + "EgressIp": { + "locationName": "egressIp" + }, + "Entitlements": { + "shape": "Sl", + "locationName": "entitlements" + }, + "FlowArn": { + "locationName": "flowArn" + }, + "Name": { + "locationName": "name" + }, + "Outputs": { + "shape": "Sb", + "locationName": "outputs" + }, + "Source": { + "shape": "Sn", + "locationName": "source" + }, + "Status": { + "locationName": "status" + } + }, + "required": [ + "Status", + "Entitlements", + "Outputs", + "AvailabilityZone", + "FlowArn", + "Source", + "Name" + ] + }, + "Sl": { + "type": "list", + "member": { + "shape": "Sm" + } + }, + "Sm": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Encryption": { + "shape": "S5", + "locationName": "encryption" + }, + "EntitlementArn": { + "locationName": "entitlementArn" + }, + "Name": { + "locationName": "name" + }, + "Subscribers": { + "shape": "Sh", + "locationName": "subscribers" + } + }, + "required": [ + "EntitlementArn", + "Subscribers", + "Name" + ] + }, + "Sn": { + "type": "structure", + "members": { + "Decryption": { + "shape": "S5", + "locationName": "decryption" + }, + "Description": { + "locationName": "description" + }, + "EntitlementArn": { + "locationName": "entitlementArn" + }, + "IngestIp": { + "locationName": "ingestIp" + }, + "IngestPort": { + "locationName": "ingestPort", + "type": "integer" + }, + "Name": { + "locationName": "name" + }, + "SourceArn": { + "locationName": "sourceArn" + }, + "Transport": { + "shape": "Sd", + "locationName": "transport" + }, + "WhitelistCidr": { + "locationName": "whitelistCidr" + } + }, + "required": [ + "SourceArn", + "Name" + ] + }, + "S18": { + "type": "map", + "key": {}, + "value": {} + }, + "S1k": { + "type": "structure", + "members": { + "Algorithm": { + "locationName": "algorithm" + }, + "KeyType": { + "locationName": "keyType" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "SecretArn": { + "locationName": "secretArn" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.paginators.json b/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.paginators.json new file mode 100644 index 0000000..92e6fc6 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.paginators.json @@ -0,0 +1,16 @@ +{ + "pagination" : { + "ListEntitlements" : { + "input_token" : "NextToken", + "output_token" : "NextToken", + "limit_key" : "MaxResults", + "result_key" : "Entitlements" + }, + "ListFlows" : { + "input_token" : "NextToken", + "output_token" : "NextToken", + "limit_key" : "MaxResults", + "result_key" : "Flows" + } + } +} diff --git a/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json b/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json new file mode 100644 index 0000000..eff9524 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json @@ -0,0 +1,3820 @@ +{ + "metadata": { + "apiVersion": "2017-08-29", + "endpointPrefix": "mediaconvert", + "signingName": "mediaconvert", + "serviceFullName": "AWS Elemental MediaConvert", + "serviceId": "MediaConvert", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "mediaconvert-2017-08-29", + "signatureVersion": "v4", + "serviceAbbreviation": "MediaConvert" + }, + "operations": { + "AssociateCertificate": { + "http": { + "requestUri": "/2017-08-29/certificates", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + } + }, + "required": [ + "Arn" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelJob": { + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/jobs/{id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Id": { + "locationName": "id", + "location": "uri" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateJob": { + "http": { + "requestUri": "/2017-08-29/jobs", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "S7", + "locationName": "accelerationSettings" + }, + "BillingTagsSource": { + "locationName": "billingTagsSource" + }, + "ClientRequestToken": { + "locationName": "clientRequestToken", + "idempotencyToken": true + }, + "JobTemplate": { + "locationName": "jobTemplate" + }, + "Queue": { + "locationName": "queue" + }, + "Role": { + "locationName": "role" + }, + "Settings": { + "shape": "Sa", + "locationName": "settings" + }, + "StatusUpdateInterval": { + "locationName": "statusUpdateInterval" + }, + "UserMetadata": { + "shape": "Scj", + "locationName": "userMetadata" + } + }, + "required": [ + "Role", + "Settings" + ] + }, + "output": { + "type": "structure", + "members": { + "Job": { + "shape": "Scl", + "locationName": "job" + } + } + } + }, + "CreateJobTemplate": { + "http": { + "requestUri": "/2017-08-29/jobTemplates", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "S7", + "locationName": "accelerationSettings" + }, + "Category": { + "locationName": "category" + }, + "Description": { + "locationName": "description" + }, + "Name": { + "locationName": "name" + }, + "Queue": { + "locationName": "queue" + }, + "Settings": { + "shape": "Scx", + "locationName": "settings" + }, + "StatusUpdateInterval": { + "locationName": "statusUpdateInterval" + }, + "Tags": { + "shape": "Scj", + "locationName": "tags" + } + }, + "required": [ + "Settings", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "JobTemplate": { + "shape": "Sd1", + "locationName": "jobTemplate" + } + } + } + }, + "CreatePreset": { + "http": { + "requestUri": "/2017-08-29/presets", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "Category": { + "locationName": "category" + }, + "Description": { + "locationName": "description" + }, + "Name": { + "locationName": "name" + }, + "Settings": { + "shape": "Sd4", + "locationName": "settings" + }, + "Tags": { + "shape": "Scj", + "locationName": "tags" + } + }, + "required": [ + "Settings", + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Preset": { + "shape": "Sd8", + "locationName": "preset" + } + } + } + }, + "CreateQueue": { + "http": { + "requestUri": "/2017-08-29/queues", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Name": { + "locationName": "name" + }, + "PricingPlan": { + "locationName": "pricingPlan" + }, + "ReservationPlanSettings": { + "shape": "Sdb", + "locationName": "reservationPlanSettings" + }, + "Tags": { + "shape": "Scj", + "locationName": "tags" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Queue": { + "shape": "Sdf", + "locationName": "queue" + } + } + } + }, + "DeleteJobTemplate": { + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/jobTemplates/{name}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Name": { + "locationName": "name", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePreset": { + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/presets/{name}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Name": { + "locationName": "name", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteQueue": { + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/queues/{name}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Name": { + "locationName": "name", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeEndpoints": { + "http": { + "requestUri": "/2017-08-29/endpoints", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "Mode": { + "locationName": "mode" + }, + "NextToken": { + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Endpoints": { + "locationName": "endpoints", + "type": "list", + "member": { + "type": "structure", + "members": { + "Url": { + "locationName": "url" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DisassociateCertificate": { + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/certificates/{arn}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn", + "location": "uri" + } + }, + "required": [ + "Arn" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetJob": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobs/{id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Id": { + "locationName": "id", + "location": "uri" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": { + "Job": { + "shape": "Scl", + "locationName": "job" + } + } + } + }, + "GetJobTemplate": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobTemplates/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Name": { + "locationName": "name", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "JobTemplate": { + "shape": "Sd1", + "locationName": "jobTemplate" + } + } + } + }, + "GetPreset": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/presets/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Name": { + "locationName": "name", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Preset": { + "shape": "Sd8", + "locationName": "preset" + } + } + } + }, + "GetQueue": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/queues/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Name": { + "locationName": "name", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Queue": { + "shape": "Sdf", + "locationName": "queue" + } + } + } + }, + "ListJobTemplates": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobTemplates", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Category": { + "locationName": "category", + "location": "querystring" + }, + "ListBy": { + "locationName": "listBy", + "location": "querystring" + }, + "MaxResults": { + "locationName": "maxResults", + "location": "querystring", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken", + "location": "querystring" + }, + "Order": { + "locationName": "order", + "location": "querystring" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobTemplates": { + "locationName": "jobTemplates", + "type": "list", + "member": { + "shape": "Sd1" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListJobs": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobs", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "locationName": "maxResults", + "location": "querystring", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken", + "location": "querystring" + }, + "Order": { + "locationName": "order", + "location": "querystring" + }, + "Queue": { + "locationName": "queue", + "location": "querystring" + }, + "Status": { + "locationName": "status", + "location": "querystring" + } + } + }, + "output": { + "type": "structure", + "members": { + "Jobs": { + "locationName": "jobs", + "type": "list", + "member": { + "shape": "Scl" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListPresets": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/presets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Category": { + "locationName": "category", + "location": "querystring" + }, + "ListBy": { + "locationName": "listBy", + "location": "querystring" + }, + "MaxResults": { + "locationName": "maxResults", + "location": "querystring", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken", + "location": "querystring" + }, + "Order": { + "locationName": "order", + "location": "querystring" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Presets": { + "locationName": "presets", + "type": "list", + "member": { + "shape": "Sd8" + } + } + } + } + }, + "ListQueues": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/queues", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ListBy": { + "locationName": "listBy", + "location": "querystring" + }, + "MaxResults": { + "locationName": "maxResults", + "location": "querystring", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken", + "location": "querystring" + }, + "Order": { + "locationName": "order", + "location": "querystring" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Queues": { + "locationName": "queues", + "type": "list", + "member": { + "shape": "Sdf" + } + } + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2017-08-29/tags/{arn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn", + "location": "uri" + } + }, + "required": [ + "Arn" + ] + }, + "output": { + "type": "structure", + "members": { + "ResourceTags": { + "locationName": "resourceTags", + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Tags": { + "shape": "Scj", + "locationName": "tags" + } + } + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/2017-08-29/tags", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Tags": { + "shape": "Scj", + "locationName": "tags" + } + }, + "required": [ + "Arn", + "Tags" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/tags/{arn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn", + "location": "uri" + }, + "TagKeys": { + "locationName": "tagKeys", + "type": "list", + "member": {} + } + }, + "required": [ + "Arn" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateJobTemplate": { + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/jobTemplates/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "S7", + "locationName": "accelerationSettings" + }, + "Category": { + "locationName": "category" + }, + "Description": { + "locationName": "description" + }, + "Name": { + "locationName": "name", + "location": "uri" + }, + "Queue": { + "locationName": "queue" + }, + "Settings": { + "shape": "Scx", + "locationName": "settings" + }, + "StatusUpdateInterval": { + "locationName": "statusUpdateInterval" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "JobTemplate": { + "shape": "Sd1", + "locationName": "jobTemplate" + } + } + } + }, + "UpdatePreset": { + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/presets/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Category": { + "locationName": "category" + }, + "Description": { + "locationName": "description" + }, + "Name": { + "locationName": "name", + "location": "uri" + }, + "Settings": { + "shape": "Sd4", + "locationName": "settings" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Preset": { + "shape": "Sd8", + "locationName": "preset" + } + } + } + }, + "UpdateQueue": { + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/queues/{name}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Description": { + "locationName": "description" + }, + "Name": { + "locationName": "name", + "location": "uri" + }, + "ReservationPlanSettings": { + "shape": "Sdb", + "locationName": "reservationPlanSettings" + }, + "Status": { + "locationName": "status" + } + }, + "required": [ + "Name" + ] + }, + "output": { + "type": "structure", + "members": { + "Queue": { + "shape": "Sdf", + "locationName": "queue" + } + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "Mode": { + "locationName": "mode" + } + }, + "required": [ + "Mode" + ] + }, + "Sa": { + "type": "structure", + "members": { + "AdAvailOffset": { + "locationName": "adAvailOffset", + "type": "integer" + }, + "AvailBlanking": { + "shape": "Sc", + "locationName": "availBlanking" + }, + "Esam": { + "shape": "Se", + "locationName": "esam" + }, + "Inputs": { + "locationName": "inputs", + "type": "list", + "member": { + "type": "structure", + "members": { + "AudioSelectorGroups": { + "shape": "Sm", + "locationName": "audioSelectorGroups" + }, + "AudioSelectors": { + "shape": "Sq", + "locationName": "audioSelectors" + }, + "CaptionSelectors": { + "shape": "S19", + "locationName": "captionSelectors" + }, + "DeblockFilter": { + "locationName": "deblockFilter" + }, + "DecryptionSettings": { + "locationName": "decryptionSettings", + "type": "structure", + "members": { + "DecryptionMode": { + "locationName": "decryptionMode" + }, + "EncryptedDecryptionKey": { + "locationName": "encryptedDecryptionKey" + }, + "InitializationVector": { + "locationName": "initializationVector" + }, + "KmsKeyRegion": { + "locationName": "kmsKeyRegion" + } + } + }, + "DenoiseFilter": { + "locationName": "denoiseFilter" + }, + "FileInput": { + "locationName": "fileInput" + }, + "FilterEnable": { + "locationName": "filterEnable" + }, + "FilterStrength": { + "locationName": "filterStrength", + "type": "integer" + }, + "ImageInserter": { + "shape": "S1z", + "locationName": "imageInserter" + }, + "InputClippings": { + "shape": "S27", + "locationName": "inputClippings" + }, + "ProgramNumber": { + "locationName": "programNumber", + "type": "integer" + }, + "PsiControl": { + "locationName": "psiControl" + }, + "SupplementalImps": { + "locationName": "supplementalImps", + "type": "list", + "member": {} + }, + "TimecodeSource": { + "locationName": "timecodeSource" + }, + "VideoSelector": { + "shape": "S2e", + "locationName": "videoSelector" + } + } + } + }, + "MotionImageInserter": { + "shape": "S2l", + "locationName": "motionImageInserter" + }, + "NielsenConfiguration": { + "shape": "S2u", + "locationName": "nielsenConfiguration" + }, + "OutputGroups": { + "shape": "S2w", + "locationName": "outputGroups" + }, + "TimecodeConfig": { + "shape": "Scb", + "locationName": "timecodeConfig" + }, + "TimedMetadataInsertion": { + "shape": "Sce", + "locationName": "timedMetadataInsertion" + } + } + }, + "Sc": { + "type": "structure", + "members": { + "AvailBlankingImage": { + "locationName": "availBlankingImage" + } + } + }, + "Se": { + "type": "structure", + "members": { + "ManifestConfirmConditionNotification": { + "locationName": "manifestConfirmConditionNotification", + "type": "structure", + "members": { + "MccXml": { + "locationName": "mccXml" + } + } + }, + "ResponseSignalPreroll": { + "locationName": "responseSignalPreroll", + "type": "integer" + }, + "SignalProcessingNotification": { + "locationName": "signalProcessingNotification", + "type": "structure", + "members": { + "SccXml": { + "locationName": "sccXml" + } + } + } + } + }, + "Sm": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "AudioSelectorNames": { + "locationName": "audioSelectorNames", + "type": "list", + "member": {} + } + } + } + }, + "Sq": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "CustomLanguageCode": { + "locationName": "customLanguageCode" + }, + "DefaultSelection": { + "locationName": "defaultSelection" + }, + "ExternalAudioFileInput": { + "locationName": "externalAudioFileInput" + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "Offset": { + "locationName": "offset", + "type": "integer" + }, + "Pids": { + "shape": "Sx", + "locationName": "pids" + }, + "ProgramSelection": { + "locationName": "programSelection", + "type": "integer" + }, + "RemixSettings": { + "shape": "S10", + "locationName": "remixSettings" + }, + "SelectorType": { + "locationName": "selectorType" + }, + "Tracks": { + "shape": "Sx", + "locationName": "tracks" + } + } + } + }, + "Sx": { + "type": "list", + "member": { + "type": "integer" + } + }, + "S10": { + "type": "structure", + "members": { + "ChannelMapping": { + "locationName": "channelMapping", + "type": "structure", + "members": { + "OutputChannels": { + "locationName": "outputChannels", + "type": "list", + "member": { + "type": "structure", + "members": { + "InputChannels": { + "locationName": "inputChannels", + "type": "list", + "member": { + "type": "integer" + } + } + } + } + } + } + }, + "ChannelsIn": { + "locationName": "channelsIn", + "type": "integer" + }, + "ChannelsOut": { + "locationName": "channelsOut", + "type": "integer" + } + } + }, + "S19": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "CustomLanguageCode": { + "locationName": "customLanguageCode" + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "SourceSettings": { + "locationName": "sourceSettings", + "type": "structure", + "members": { + "AncillarySourceSettings": { + "locationName": "ancillarySourceSettings", + "type": "structure", + "members": { + "SourceAncillaryChannelNumber": { + "locationName": "sourceAncillaryChannelNumber", + "type": "integer" + } + } + }, + "DvbSubSourceSettings": { + "locationName": "dvbSubSourceSettings", + "type": "structure", + "members": { + "Pid": { + "locationName": "pid", + "type": "integer" + } + } + }, + "EmbeddedSourceSettings": { + "locationName": "embeddedSourceSettings", + "type": "structure", + "members": { + "Convert608To708": { + "locationName": "convert608To708" + }, + "Source608ChannelNumber": { + "locationName": "source608ChannelNumber", + "type": "integer" + }, + "Source608TrackNumber": { + "locationName": "source608TrackNumber", + "type": "integer" + } + } + }, + "FileSourceSettings": { + "locationName": "fileSourceSettings", + "type": "structure", + "members": { + "Convert608To708": { + "locationName": "convert608To708" + }, + "SourceFile": { + "locationName": "sourceFile" + }, + "TimeDelta": { + "locationName": "timeDelta", + "type": "integer" + } + } + }, + "SourceType": { + "locationName": "sourceType" + }, + "TeletextSourceSettings": { + "locationName": "teletextSourceSettings", + "type": "structure", + "members": { + "PageNumber": { + "locationName": "pageNumber" + } + } + }, + "TrackSourceSettings": { + "locationName": "trackSourceSettings", + "type": "structure", + "members": { + "TrackNumber": { + "locationName": "trackNumber", + "type": "integer" + } + } + } + } + } + } + } + }, + "S1z": { + "type": "structure", + "members": { + "InsertableImages": { + "locationName": "insertableImages", + "type": "list", + "member": { + "type": "structure", + "members": { + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "FadeIn": { + "locationName": "fadeIn", + "type": "integer" + }, + "FadeOut": { + "locationName": "fadeOut", + "type": "integer" + }, + "Height": { + "locationName": "height", + "type": "integer" + }, + "ImageInserterInput": { + "locationName": "imageInserterInput" + }, + "ImageX": { + "locationName": "imageX", + "type": "integer" + }, + "ImageY": { + "locationName": "imageY", + "type": "integer" + }, + "Layer": { + "locationName": "layer", + "type": "integer" + }, + "Opacity": { + "locationName": "opacity", + "type": "integer" + }, + "StartTime": { + "locationName": "startTime" + }, + "Width": { + "locationName": "width", + "type": "integer" + } + } + } + } + } + }, + "S27": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EndTimecode": { + "locationName": "endTimecode" + }, + "StartTimecode": { + "locationName": "startTimecode" + } + } + } + }, + "S2e": { + "type": "structure", + "members": { + "ColorSpace": { + "locationName": "colorSpace" + }, + "ColorSpaceUsage": { + "locationName": "colorSpaceUsage" + }, + "Hdr10Metadata": { + "shape": "S2h", + "locationName": "hdr10Metadata" + }, + "Pid": { + "locationName": "pid", + "type": "integer" + }, + "ProgramNumber": { + "locationName": "programNumber", + "type": "integer" + }, + "Rotate": { + "locationName": "rotate" + } + } + }, + "S2h": { + "type": "structure", + "members": { + "BluePrimaryX": { + "locationName": "bluePrimaryX", + "type": "integer" + }, + "BluePrimaryY": { + "locationName": "bluePrimaryY", + "type": "integer" + }, + "GreenPrimaryX": { + "locationName": "greenPrimaryX", + "type": "integer" + }, + "GreenPrimaryY": { + "locationName": "greenPrimaryY", + "type": "integer" + }, + "MaxContentLightLevel": { + "locationName": "maxContentLightLevel", + "type": "integer" + }, + "MaxFrameAverageLightLevel": { + "locationName": "maxFrameAverageLightLevel", + "type": "integer" + }, + "MaxLuminance": { + "locationName": "maxLuminance", + "type": "integer" + }, + "MinLuminance": { + "locationName": "minLuminance", + "type": "integer" + }, + "RedPrimaryX": { + "locationName": "redPrimaryX", + "type": "integer" + }, + "RedPrimaryY": { + "locationName": "redPrimaryY", + "type": "integer" + }, + "WhitePointX": { + "locationName": "whitePointX", + "type": "integer" + }, + "WhitePointY": { + "locationName": "whitePointY", + "type": "integer" + } + } + }, + "S2l": { + "type": "structure", + "members": { + "Framerate": { + "locationName": "framerate", + "type": "structure", + "members": { + "FramerateDenominator": { + "locationName": "framerateDenominator", + "type": "integer" + }, + "FramerateNumerator": { + "locationName": "framerateNumerator", + "type": "integer" + } + } + }, + "Input": { + "locationName": "input" + }, + "InsertionMode": { + "locationName": "insertionMode" + }, + "Offset": { + "locationName": "offset", + "type": "structure", + "members": { + "ImageX": { + "locationName": "imageX", + "type": "integer" + }, + "ImageY": { + "locationName": "imageY", + "type": "integer" + } + } + }, + "Playback": { + "locationName": "playback" + }, + "StartTime": { + "locationName": "startTime" + } + } + }, + "S2u": { + "type": "structure", + "members": { + "BreakoutCode": { + "locationName": "breakoutCode", + "type": "integer" + }, + "DistributorId": { + "locationName": "distributorId" + } + } + }, + "S2w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CustomName": { + "locationName": "customName" + }, + "Name": { + "locationName": "name" + }, + "OutputGroupSettings": { + "locationName": "outputGroupSettings", + "type": "structure", + "members": { + "CmafGroupSettings": { + "locationName": "cmafGroupSettings", + "type": "structure", + "members": { + "BaseUrl": { + "locationName": "baseUrl" + }, + "ClientCache": { + "locationName": "clientCache" + }, + "CodecSpecification": { + "locationName": "codecSpecification" + }, + "Destination": { + "locationName": "destination" + }, + "DestinationSettings": { + "shape": "S33", + "locationName": "destinationSettings" + }, + "Encryption": { + "locationName": "encryption", + "type": "structure", + "members": { + "ConstantInitializationVector": { + "locationName": "constantInitializationVector" + }, + "EncryptionMethod": { + "locationName": "encryptionMethod" + }, + "InitializationVectorInManifest": { + "locationName": "initializationVectorInManifest" + }, + "StaticKeyProvider": { + "shape": "S3c", + "locationName": "staticKeyProvider" + }, + "Type": { + "locationName": "type" + } + } + }, + "FragmentLength": { + "locationName": "fragmentLength", + "type": "integer" + }, + "ManifestCompression": { + "locationName": "manifestCompression" + }, + "ManifestDurationFormat": { + "locationName": "manifestDurationFormat" + }, + "MinBufferTime": { + "locationName": "minBufferTime", + "type": "integer" + }, + "MinFinalSegmentLength": { + "locationName": "minFinalSegmentLength", + "type": "double" + }, + "SegmentControl": { + "locationName": "segmentControl" + }, + "SegmentLength": { + "locationName": "segmentLength", + "type": "integer" + }, + "StreamInfResolution": { + "locationName": "streamInfResolution" + }, + "WriteDashManifest": { + "locationName": "writeDashManifest" + }, + "WriteHlsManifest": { + "locationName": "writeHlsManifest" + } + } + }, + "DashIsoGroupSettings": { + "locationName": "dashIsoGroupSettings", + "type": "structure", + "members": { + "BaseUrl": { + "locationName": "baseUrl" + }, + "Destination": { + "locationName": "destination" + }, + "DestinationSettings": { + "shape": "S33", + "locationName": "destinationSettings" + }, + "Encryption": { + "locationName": "encryption", + "type": "structure", + "members": { + "PlaybackDeviceCompatibility": { + "locationName": "playbackDeviceCompatibility" + }, + "SpekeKeyProvider": { + "shape": "S3r", + "locationName": "spekeKeyProvider" + } + } + }, + "FragmentLength": { + "locationName": "fragmentLength", + "type": "integer" + }, + "HbbtvCompliance": { + "locationName": "hbbtvCompliance" + }, + "MinBufferTime": { + "locationName": "minBufferTime", + "type": "integer" + }, + "SegmentControl": { + "locationName": "segmentControl" + }, + "SegmentLength": { + "locationName": "segmentLength", + "type": "integer" + }, + "WriteSegmentTimelineInRepresentation": { + "locationName": "writeSegmentTimelineInRepresentation" + } + } + }, + "FileGroupSettings": { + "locationName": "fileGroupSettings", + "type": "structure", + "members": { + "Destination": { + "locationName": "destination" + }, + "DestinationSettings": { + "shape": "S33", + "locationName": "destinationSettings" + } + } + }, + "HlsGroupSettings": { + "locationName": "hlsGroupSettings", + "type": "structure", + "members": { + "AdMarkers": { + "locationName": "adMarkers", + "type": "list", + "member": {} + }, + "BaseUrl": { + "locationName": "baseUrl" + }, + "CaptionLanguageMappings": { + "locationName": "captionLanguageMappings", + "type": "list", + "member": { + "type": "structure", + "members": { + "CaptionChannel": { + "locationName": "captionChannel", + "type": "integer" + }, + "CustomLanguageCode": { + "locationName": "customLanguageCode" + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageDescription": { + "locationName": "languageDescription" + } + } + } + }, + "CaptionLanguageSetting": { + "locationName": "captionLanguageSetting" + }, + "ClientCache": { + "locationName": "clientCache" + }, + "CodecSpecification": { + "locationName": "codecSpecification" + }, + "Destination": { + "locationName": "destination" + }, + "DestinationSettings": { + "shape": "S33", + "locationName": "destinationSettings" + }, + "DirectoryStructure": { + "locationName": "directoryStructure" + }, + "Encryption": { + "locationName": "encryption", + "type": "structure", + "members": { + "ConstantInitializationVector": { + "locationName": "constantInitializationVector" + }, + "EncryptionMethod": { + "locationName": "encryptionMethod" + }, + "InitializationVectorInManifest": { + "locationName": "initializationVectorInManifest" + }, + "OfflineEncrypted": { + "locationName": "offlineEncrypted" + }, + "SpekeKeyProvider": { + "shape": "S3r", + "locationName": "spekeKeyProvider" + }, + "StaticKeyProvider": { + "shape": "S3c", + "locationName": "staticKeyProvider" + }, + "Type": { + "locationName": "type" + } + } + }, + "ManifestCompression": { + "locationName": "manifestCompression" + }, + "ManifestDurationFormat": { + "locationName": "manifestDurationFormat" + }, + "MinFinalSegmentLength": { + "locationName": "minFinalSegmentLength", + "type": "double" + }, + "MinSegmentLength": { + "locationName": "minSegmentLength", + "type": "integer" + }, + "OutputSelection": { + "locationName": "outputSelection" + }, + "ProgramDateTime": { + "locationName": "programDateTime" + }, + "ProgramDateTimePeriod": { + "locationName": "programDateTimePeriod", + "type": "integer" + }, + "SegmentControl": { + "locationName": "segmentControl" + }, + "SegmentLength": { + "locationName": "segmentLength", + "type": "integer" + }, + "SegmentsPerSubdirectory": { + "locationName": "segmentsPerSubdirectory", + "type": "integer" + }, + "StreamInfResolution": { + "locationName": "streamInfResolution" + }, + "TimedMetadataId3Frame": { + "locationName": "timedMetadataId3Frame" + }, + "TimedMetadataId3Period": { + "locationName": "timedMetadataId3Period", + "type": "integer" + }, + "TimestampDeltaMilliseconds": { + "locationName": "timestampDeltaMilliseconds", + "type": "integer" + } + } + }, + "MsSmoothGroupSettings": { + "locationName": "msSmoothGroupSettings", + "type": "structure", + "members": { + "AudioDeduplication": { + "locationName": "audioDeduplication" + }, + "Destination": { + "locationName": "destination" + }, + "DestinationSettings": { + "shape": "S33", + "locationName": "destinationSettings" + }, + "Encryption": { + "locationName": "encryption", + "type": "structure", + "members": { + "SpekeKeyProvider": { + "shape": "S3r", + "locationName": "spekeKeyProvider" + } + } + }, + "FragmentLength": { + "locationName": "fragmentLength", + "type": "integer" + }, + "ManifestEncoding": { + "locationName": "manifestEncoding" + } + } + }, + "Type": { + "locationName": "type" + } + } + }, + "Outputs": { + "locationName": "outputs", + "type": "list", + "member": { + "type": "structure", + "members": { + "AudioDescriptions": { + "shape": "S4t", + "locationName": "audioDescriptions" + }, + "CaptionDescriptions": { + "locationName": "captionDescriptions", + "type": "list", + "member": { + "type": "structure", + "members": { + "CaptionSelectorName": { + "locationName": "captionSelectorName" + }, + "CustomLanguageCode": { + "locationName": "customLanguageCode" + }, + "DestinationSettings": { + "shape": "S6j", + "locationName": "destinationSettings" + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageDescription": { + "locationName": "languageDescription" + } + } + } + }, + "ContainerSettings": { + "shape": "S79", + "locationName": "containerSettings" + }, + "Extension": { + "locationName": "extension" + }, + "NameModifier": { + "locationName": "nameModifier" + }, + "OutputSettings": { + "locationName": "outputSettings", + "type": "structure", + "members": { + "HlsSettings": { + "locationName": "hlsSettings", + "type": "structure", + "members": { + "AudioGroupId": { + "locationName": "audioGroupId" + }, + "AudioRenditionSets": { + "locationName": "audioRenditionSets" + }, + "AudioTrackType": { + "locationName": "audioTrackType" + }, + "IFrameOnlyManifest": { + "locationName": "iFrameOnlyManifest" + }, + "SegmentModifier": { + "locationName": "segmentModifier" + } + } + } + } + }, + "Preset": { + "locationName": "preset" + }, + "VideoDescription": { + "shape": "S8p", + "locationName": "videoDescription" + } + } + } + } + } + } + }, + "S33": { + "type": "structure", + "members": { + "S3Settings": { + "locationName": "s3Settings", + "type": "structure", + "members": { + "Encryption": { + "locationName": "encryption", + "type": "structure", + "members": { + "EncryptionType": { + "locationName": "encryptionType" + }, + "KmsKeyArn": { + "locationName": "kmsKeyArn" + } + } + } + } + } + } + }, + "S3c": { + "type": "structure", + "members": { + "KeyFormat": { + "locationName": "keyFormat" + }, + "KeyFormatVersions": { + "locationName": "keyFormatVersions" + }, + "StaticKeyValue": { + "locationName": "staticKeyValue" + }, + "Url": { + "locationName": "url" + } + } + }, + "S3r": { + "type": "structure", + "members": { + "CertificateArn": { + "locationName": "certificateArn" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "SystemIds": { + "locationName": "systemIds", + "type": "list", + "member": {} + }, + "Url": { + "locationName": "url" + } + } + }, + "S4t": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AudioNormalizationSettings": { + "locationName": "audioNormalizationSettings", + "type": "structure", + "members": { + "Algorithm": { + "locationName": "algorithm" + }, + "AlgorithmControl": { + "locationName": "algorithmControl" + }, + "CorrectionGateLevel": { + "locationName": "correctionGateLevel", + "type": "integer" + }, + "LoudnessLogging": { + "locationName": "loudnessLogging" + }, + "PeakCalculation": { + "locationName": "peakCalculation" + }, + "TargetLkfs": { + "locationName": "targetLkfs", + "type": "double" + } + } + }, + "AudioSourceName": { + "locationName": "audioSourceName" + }, + "AudioType": { + "locationName": "audioType", + "type": "integer" + }, + "AudioTypeControl": { + "locationName": "audioTypeControl" + }, + "CodecSettings": { + "locationName": "codecSettings", + "type": "structure", + "members": { + "AacSettings": { + "locationName": "aacSettings", + "type": "structure", + "members": { + "AudioDescriptionBroadcasterMix": { + "locationName": "audioDescriptionBroadcasterMix" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "CodecProfile": { + "locationName": "codecProfile" + }, + "CodingMode": { + "locationName": "codingMode" + }, + "RateControlMode": { + "locationName": "rateControlMode" + }, + "RawFormat": { + "locationName": "rawFormat" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "integer" + }, + "Specification": { + "locationName": "specification" + }, + "VbrQuality": { + "locationName": "vbrQuality" + } + } + }, + "Ac3Settings": { + "locationName": "ac3Settings", + "type": "structure", + "members": { + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "BitstreamMode": { + "locationName": "bitstreamMode" + }, + "CodingMode": { + "locationName": "codingMode" + }, + "Dialnorm": { + "locationName": "dialnorm", + "type": "integer" + }, + "DynamicRangeCompressionProfile": { + "locationName": "dynamicRangeCompressionProfile" + }, + "LfeFilter": { + "locationName": "lfeFilter" + }, + "MetadataControl": { + "locationName": "metadataControl" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "integer" + } + } + }, + "AiffSettings": { + "locationName": "aiffSettings", + "type": "structure", + "members": { + "BitDepth": { + "locationName": "bitDepth", + "type": "integer" + }, + "Channels": { + "locationName": "channels", + "type": "integer" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "integer" + } + } + }, + "Codec": { + "locationName": "codec" + }, + "Eac3Settings": { + "locationName": "eac3Settings", + "type": "structure", + "members": { + "AttenuationControl": { + "locationName": "attenuationControl" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "BitstreamMode": { + "locationName": "bitstreamMode" + }, + "CodingMode": { + "locationName": "codingMode" + }, + "DcFilter": { + "locationName": "dcFilter" + }, + "Dialnorm": { + "locationName": "dialnorm", + "type": "integer" + }, + "DynamicRangeCompressionLine": { + "locationName": "dynamicRangeCompressionLine" + }, + "DynamicRangeCompressionRf": { + "locationName": "dynamicRangeCompressionRf" + }, + "LfeControl": { + "locationName": "lfeControl" + }, + "LfeFilter": { + "locationName": "lfeFilter" + }, + "LoRoCenterMixLevel": { + "locationName": "loRoCenterMixLevel", + "type": "double" + }, + "LoRoSurroundMixLevel": { + "locationName": "loRoSurroundMixLevel", + "type": "double" + }, + "LtRtCenterMixLevel": { + "locationName": "ltRtCenterMixLevel", + "type": "double" + }, + "LtRtSurroundMixLevel": { + "locationName": "ltRtSurroundMixLevel", + "type": "double" + }, + "MetadataControl": { + "locationName": "metadataControl" + }, + "PassthroughControl": { + "locationName": "passthroughControl" + }, + "PhaseControl": { + "locationName": "phaseControl" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "integer" + }, + "StereoDownmix": { + "locationName": "stereoDownmix" + }, + "SurroundExMode": { + "locationName": "surroundExMode" + }, + "SurroundMode": { + "locationName": "surroundMode" + } + } + }, + "Mp2Settings": { + "locationName": "mp2Settings", + "type": "structure", + "members": { + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "Channels": { + "locationName": "channels", + "type": "integer" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "integer" + } + } + }, + "WavSettings": { + "locationName": "wavSettings", + "type": "structure", + "members": { + "BitDepth": { + "locationName": "bitDepth", + "type": "integer" + }, + "Channels": { + "locationName": "channels", + "type": "integer" + }, + "Format": { + "locationName": "format" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "integer" + } + } + } + } + }, + "CustomLanguageCode": { + "locationName": "customLanguageCode" + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageCodeControl": { + "locationName": "languageCodeControl" + }, + "RemixSettings": { + "shape": "S10", + "locationName": "remixSettings" + }, + "StreamName": { + "locationName": "streamName" + } + } + } + }, + "S6j": { + "type": "structure", + "members": { + "BurninDestinationSettings": { + "locationName": "burninDestinationSettings", + "type": "structure", + "members": { + "Alignment": { + "locationName": "alignment" + }, + "BackgroundColor": { + "locationName": "backgroundColor" + }, + "BackgroundOpacity": { + "locationName": "backgroundOpacity", + "type": "integer" + }, + "FontColor": { + "locationName": "fontColor" + }, + "FontOpacity": { + "locationName": "fontOpacity", + "type": "integer" + }, + "FontResolution": { + "locationName": "fontResolution", + "type": "integer" + }, + "FontScript": { + "locationName": "fontScript" + }, + "FontSize": { + "locationName": "fontSize", + "type": "integer" + }, + "OutlineColor": { + "locationName": "outlineColor" + }, + "OutlineSize": { + "locationName": "outlineSize", + "type": "integer" + }, + "ShadowColor": { + "locationName": "shadowColor" + }, + "ShadowOpacity": { + "locationName": "shadowOpacity", + "type": "integer" + }, + "ShadowXOffset": { + "locationName": "shadowXOffset", + "type": "integer" + }, + "ShadowYOffset": { + "locationName": "shadowYOffset", + "type": "integer" + }, + "TeletextSpacing": { + "locationName": "teletextSpacing" + }, + "XPosition": { + "locationName": "xPosition", + "type": "integer" + }, + "YPosition": { + "locationName": "yPosition", + "type": "integer" + } + } + }, + "DestinationType": { + "locationName": "destinationType" + }, + "DvbSubDestinationSettings": { + "locationName": "dvbSubDestinationSettings", + "type": "structure", + "members": { + "Alignment": { + "locationName": "alignment" + }, + "BackgroundColor": { + "locationName": "backgroundColor" + }, + "BackgroundOpacity": { + "locationName": "backgroundOpacity", + "type": "integer" + }, + "FontColor": { + "locationName": "fontColor" + }, + "FontOpacity": { + "locationName": "fontOpacity", + "type": "integer" + }, + "FontResolution": { + "locationName": "fontResolution", + "type": "integer" + }, + "FontScript": { + "locationName": "fontScript" + }, + "FontSize": { + "locationName": "fontSize", + "type": "integer" + }, + "OutlineColor": { + "locationName": "outlineColor" + }, + "OutlineSize": { + "locationName": "outlineSize", + "type": "integer" + }, + "ShadowColor": { + "locationName": "shadowColor" + }, + "ShadowOpacity": { + "locationName": "shadowOpacity", + "type": "integer" + }, + "ShadowXOffset": { + "locationName": "shadowXOffset", + "type": "integer" + }, + "ShadowYOffset": { + "locationName": "shadowYOffset", + "type": "integer" + }, + "TeletextSpacing": { + "locationName": "teletextSpacing" + }, + "XPosition": { + "locationName": "xPosition", + "type": "integer" + }, + "YPosition": { + "locationName": "yPosition", + "type": "integer" + } + } + }, + "EmbeddedDestinationSettings": { + "locationName": "embeddedDestinationSettings", + "type": "structure", + "members": { + "Destination608ChannelNumber": { + "locationName": "destination608ChannelNumber", + "type": "integer" + } + } + }, + "SccDestinationSettings": { + "locationName": "sccDestinationSettings", + "type": "structure", + "members": { + "Framerate": { + "locationName": "framerate" + } + } + }, + "TeletextDestinationSettings": { + "locationName": "teletextDestinationSettings", + "type": "structure", + "members": { + "PageNumber": { + "locationName": "pageNumber" + } + } + }, + "TtmlDestinationSettings": { + "locationName": "ttmlDestinationSettings", + "type": "structure", + "members": { + "StylePassthrough": { + "locationName": "stylePassthrough" + } + } + } + } + }, + "S79": { + "type": "structure", + "members": { + "Container": { + "locationName": "container" + }, + "F4vSettings": { + "locationName": "f4vSettings", + "type": "structure", + "members": { + "MoovPlacement": { + "locationName": "moovPlacement" + } + } + }, + "M2tsSettings": { + "locationName": "m2tsSettings", + "type": "structure", + "members": { + "AudioBufferModel": { + "locationName": "audioBufferModel" + }, + "AudioFramesPerPes": { + "locationName": "audioFramesPerPes", + "type": "integer" + }, + "AudioPids": { + "shape": "S7f", + "locationName": "audioPids" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "BufferModel": { + "locationName": "bufferModel" + }, + "DvbNitSettings": { + "locationName": "dvbNitSettings", + "type": "structure", + "members": { + "NetworkId": { + "locationName": "networkId", + "type": "integer" + }, + "NetworkName": { + "locationName": "networkName" + }, + "NitInterval": { + "locationName": "nitInterval", + "type": "integer" + } + } + }, + "DvbSdtSettings": { + "locationName": "dvbSdtSettings", + "type": "structure", + "members": { + "OutputSdt": { + "locationName": "outputSdt" + }, + "SdtInterval": { + "locationName": "sdtInterval", + "type": "integer" + }, + "ServiceName": { + "locationName": "serviceName" + }, + "ServiceProviderName": { + "locationName": "serviceProviderName" + } + } + }, + "DvbSubPids": { + "shape": "S7f", + "locationName": "dvbSubPids" + }, + "DvbTdtSettings": { + "locationName": "dvbTdtSettings", + "type": "structure", + "members": { + "TdtInterval": { + "locationName": "tdtInterval", + "type": "integer" + } + } + }, + "DvbTeletextPid": { + "locationName": "dvbTeletextPid", + "type": "integer" + }, + "EbpAudioInterval": { + "locationName": "ebpAudioInterval" + }, + "EbpPlacement": { + "locationName": "ebpPlacement" + }, + "EsRateInPes": { + "locationName": "esRateInPes" + }, + "ForceTsVideoEbpOrder": { + "locationName": "forceTsVideoEbpOrder" + }, + "FragmentTime": { + "locationName": "fragmentTime", + "type": "double" + }, + "MaxPcrInterval": { + "locationName": "maxPcrInterval", + "type": "integer" + }, + "MinEbpInterval": { + "locationName": "minEbpInterval", + "type": "integer" + }, + "NielsenId3": { + "locationName": "nielsenId3" + }, + "NullPacketBitrate": { + "locationName": "nullPacketBitrate", + "type": "double" + }, + "PatInterval": { + "locationName": "patInterval", + "type": "integer" + }, + "PcrControl": { + "locationName": "pcrControl" + }, + "PcrPid": { + "locationName": "pcrPid", + "type": "integer" + }, + "PmtInterval": { + "locationName": "pmtInterval", + "type": "integer" + }, + "PmtPid": { + "locationName": "pmtPid", + "type": "integer" + }, + "PrivateMetadataPid": { + "locationName": "privateMetadataPid", + "type": "integer" + }, + "ProgramNumber": { + "locationName": "programNumber", + "type": "integer" + }, + "RateMode": { + "locationName": "rateMode" + }, + "Scte35Esam": { + "locationName": "scte35Esam", + "type": "structure", + "members": { + "Scte35EsamPid": { + "locationName": "scte35EsamPid", + "type": "integer" + } + } + }, + "Scte35Pid": { + "locationName": "scte35Pid", + "type": "integer" + }, + "Scte35Source": { + "locationName": "scte35Source" + }, + "SegmentationMarkers": { + "locationName": "segmentationMarkers" + }, + "SegmentationStyle": { + "locationName": "segmentationStyle" + }, + "SegmentationTime": { + "locationName": "segmentationTime", + "type": "double" + }, + "TimedMetadataPid": { + "locationName": "timedMetadataPid", + "type": "integer" + }, + "TransportStreamId": { + "locationName": "transportStreamId", + "type": "integer" + }, + "VideoPid": { + "locationName": "videoPid", + "type": "integer" + } + } + }, + "M3u8Settings": { + "locationName": "m3u8Settings", + "type": "structure", + "members": { + "AudioFramesPerPes": { + "locationName": "audioFramesPerPes", + "type": "integer" + }, + "AudioPids": { + "shape": "S7f", + "locationName": "audioPids" + }, + "NielsenId3": { + "locationName": "nielsenId3" + }, + "PatInterval": { + "locationName": "patInterval", + "type": "integer" + }, + "PcrControl": { + "locationName": "pcrControl" + }, + "PcrPid": { + "locationName": "pcrPid", + "type": "integer" + }, + "PmtInterval": { + "locationName": "pmtInterval", + "type": "integer" + }, + "PmtPid": { + "locationName": "pmtPid", + "type": "integer" + }, + "PrivateMetadataPid": { + "locationName": "privateMetadataPid", + "type": "integer" + }, + "ProgramNumber": { + "locationName": "programNumber", + "type": "integer" + }, + "Scte35Pid": { + "locationName": "scte35Pid", + "type": "integer" + }, + "Scte35Source": { + "locationName": "scte35Source" + }, + "TimedMetadata": { + "locationName": "timedMetadata" + }, + "TimedMetadataPid": { + "locationName": "timedMetadataPid", + "type": "integer" + }, + "TransportStreamId": { + "locationName": "transportStreamId", + "type": "integer" + }, + "VideoPid": { + "locationName": "videoPid", + "type": "integer" + } + } + }, + "MovSettings": { + "locationName": "movSettings", + "type": "structure", + "members": { + "ClapAtom": { + "locationName": "clapAtom" + }, + "CslgAtom": { + "locationName": "cslgAtom" + }, + "Mpeg2FourCCControl": { + "locationName": "mpeg2FourCCControl" + }, + "PaddingControl": { + "locationName": "paddingControl" + }, + "Reference": { + "locationName": "reference" + } + } + }, + "Mp4Settings": { + "locationName": "mp4Settings", + "type": "structure", + "members": { + "CslgAtom": { + "locationName": "cslgAtom" + }, + "FreeSpaceBox": { + "locationName": "freeSpaceBox" + }, + "MoovPlacement": { + "locationName": "moovPlacement" + }, + "Mp4MajorBrand": { + "locationName": "mp4MajorBrand" + } + } + } + } + }, + "S7f": { + "type": "list", + "member": { + "type": "integer" + } + }, + "S8p": { + "type": "structure", + "members": { + "AfdSignaling": { + "locationName": "afdSignaling" + }, + "AntiAlias": { + "locationName": "antiAlias" + }, + "CodecSettings": { + "locationName": "codecSettings", + "type": "structure", + "members": { + "Codec": { + "locationName": "codec" + }, + "FrameCaptureSettings": { + "locationName": "frameCaptureSettings", + "type": "structure", + "members": { + "FramerateDenominator": { + "locationName": "framerateDenominator", + "type": "integer" + }, + "FramerateNumerator": { + "locationName": "framerateNumerator", + "type": "integer" + }, + "MaxCaptures": { + "locationName": "maxCaptures", + "type": "integer" + }, + "Quality": { + "locationName": "quality", + "type": "integer" + } + } + }, + "H264Settings": { + "locationName": "h264Settings", + "type": "structure", + "members": { + "AdaptiveQuantization": { + "locationName": "adaptiveQuantization" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "CodecLevel": { + "locationName": "codecLevel" + }, + "CodecProfile": { + "locationName": "codecProfile" + }, + "DynamicSubGop": { + "locationName": "dynamicSubGop" + }, + "EntropyEncoding": { + "locationName": "entropyEncoding" + }, + "FieldEncoding": { + "locationName": "fieldEncoding" + }, + "FlickerAdaptiveQuantization": { + "locationName": "flickerAdaptiveQuantization" + }, + "FramerateControl": { + "locationName": "framerateControl" + }, + "FramerateConversionAlgorithm": { + "locationName": "framerateConversionAlgorithm" + }, + "FramerateDenominator": { + "locationName": "framerateDenominator", + "type": "integer" + }, + "FramerateNumerator": { + "locationName": "framerateNumerator", + "type": "integer" + }, + "GopBReference": { + "locationName": "gopBReference" + }, + "GopClosedCadence": { + "locationName": "gopClosedCadence", + "type": "integer" + }, + "GopSize": { + "locationName": "gopSize", + "type": "double" + }, + "GopSizeUnits": { + "locationName": "gopSizeUnits" + }, + "HrdBufferInitialFillPercentage": { + "locationName": "hrdBufferInitialFillPercentage", + "type": "integer" + }, + "HrdBufferSize": { + "locationName": "hrdBufferSize", + "type": "integer" + }, + "InterlaceMode": { + "locationName": "interlaceMode" + }, + "MaxBitrate": { + "locationName": "maxBitrate", + "type": "integer" + }, + "MinIInterval": { + "locationName": "minIInterval", + "type": "integer" + }, + "NumberBFramesBetweenReferenceFrames": { + "locationName": "numberBFramesBetweenReferenceFrames", + "type": "integer" + }, + "NumberReferenceFrames": { + "locationName": "numberReferenceFrames", + "type": "integer" + }, + "ParControl": { + "locationName": "parControl" + }, + "ParDenominator": { + "locationName": "parDenominator", + "type": "integer" + }, + "ParNumerator": { + "locationName": "parNumerator", + "type": "integer" + }, + "QualityTuningLevel": { + "locationName": "qualityTuningLevel" + }, + "QvbrSettings": { + "locationName": "qvbrSettings", + "type": "structure", + "members": { + "MaxAverageBitrate": { + "locationName": "maxAverageBitrate", + "type": "integer" + }, + "QvbrQualityLevel": { + "locationName": "qvbrQualityLevel", + "type": "integer" + } + } + }, + "RateControlMode": { + "locationName": "rateControlMode" + }, + "RepeatPps": { + "locationName": "repeatPps" + }, + "SceneChangeDetect": { + "locationName": "sceneChangeDetect" + }, + "Slices": { + "locationName": "slices", + "type": "integer" + }, + "SlowPal": { + "locationName": "slowPal" + }, + "Softness": { + "locationName": "softness", + "type": "integer" + }, + "SpatialAdaptiveQuantization": { + "locationName": "spatialAdaptiveQuantization" + }, + "Syntax": { + "locationName": "syntax" + }, + "Telecine": { + "locationName": "telecine" + }, + "TemporalAdaptiveQuantization": { + "locationName": "temporalAdaptiveQuantization" + }, + "UnregisteredSeiTimecode": { + "locationName": "unregisteredSeiTimecode" + } + } + }, + "H265Settings": { + "locationName": "h265Settings", + "type": "structure", + "members": { + "AdaptiveQuantization": { + "locationName": "adaptiveQuantization" + }, + "AlternateTransferFunctionSei": { + "locationName": "alternateTransferFunctionSei" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "CodecLevel": { + "locationName": "codecLevel" + }, + "CodecProfile": { + "locationName": "codecProfile" + }, + "DynamicSubGop": { + "locationName": "dynamicSubGop" + }, + "FlickerAdaptiveQuantization": { + "locationName": "flickerAdaptiveQuantization" + }, + "FramerateControl": { + "locationName": "framerateControl" + }, + "FramerateConversionAlgorithm": { + "locationName": "framerateConversionAlgorithm" + }, + "FramerateDenominator": { + "locationName": "framerateDenominator", + "type": "integer" + }, + "FramerateNumerator": { + "locationName": "framerateNumerator", + "type": "integer" + }, + "GopBReference": { + "locationName": "gopBReference" + }, + "GopClosedCadence": { + "locationName": "gopClosedCadence", + "type": "integer" + }, + "GopSize": { + "locationName": "gopSize", + "type": "double" + }, + "GopSizeUnits": { + "locationName": "gopSizeUnits" + }, + "HrdBufferInitialFillPercentage": { + "locationName": "hrdBufferInitialFillPercentage", + "type": "integer" + }, + "HrdBufferSize": { + "locationName": "hrdBufferSize", + "type": "integer" + }, + "InterlaceMode": { + "locationName": "interlaceMode" + }, + "MaxBitrate": { + "locationName": "maxBitrate", + "type": "integer" + }, + "MinIInterval": { + "locationName": "minIInterval", + "type": "integer" + }, + "NumberBFramesBetweenReferenceFrames": { + "locationName": "numberBFramesBetweenReferenceFrames", + "type": "integer" + }, + "NumberReferenceFrames": { + "locationName": "numberReferenceFrames", + "type": "integer" + }, + "ParControl": { + "locationName": "parControl" + }, + "ParDenominator": { + "locationName": "parDenominator", + "type": "integer" + }, + "ParNumerator": { + "locationName": "parNumerator", + "type": "integer" + }, + "QualityTuningLevel": { + "locationName": "qualityTuningLevel" + }, + "QvbrSettings": { + "locationName": "qvbrSettings", + "type": "structure", + "members": { + "MaxAverageBitrate": { + "locationName": "maxAverageBitrate", + "type": "integer" + }, + "QvbrQualityLevel": { + "locationName": "qvbrQualityLevel", + "type": "integer" + } + } + }, + "RateControlMode": { + "locationName": "rateControlMode" + }, + "SampleAdaptiveOffsetFilterMode": { + "locationName": "sampleAdaptiveOffsetFilterMode" + }, + "SceneChangeDetect": { + "locationName": "sceneChangeDetect" + }, + "Slices": { + "locationName": "slices", + "type": "integer" + }, + "SlowPal": { + "locationName": "slowPal" + }, + "SpatialAdaptiveQuantization": { + "locationName": "spatialAdaptiveQuantization" + }, + "Telecine": { + "locationName": "telecine" + }, + "TemporalAdaptiveQuantization": { + "locationName": "temporalAdaptiveQuantization" + }, + "TemporalIds": { + "locationName": "temporalIds" + }, + "Tiles": { + "locationName": "tiles" + }, + "UnregisteredSeiTimecode": { + "locationName": "unregisteredSeiTimecode" + }, + "WriteMp4PackagingType": { + "locationName": "writeMp4PackagingType" + } + } + }, + "Mpeg2Settings": { + "locationName": "mpeg2Settings", + "type": "structure", + "members": { + "AdaptiveQuantization": { + "locationName": "adaptiveQuantization" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "CodecLevel": { + "locationName": "codecLevel" + }, + "CodecProfile": { + "locationName": "codecProfile" + }, + "DynamicSubGop": { + "locationName": "dynamicSubGop" + }, + "FramerateControl": { + "locationName": "framerateControl" + }, + "FramerateConversionAlgorithm": { + "locationName": "framerateConversionAlgorithm" + }, + "FramerateDenominator": { + "locationName": "framerateDenominator", + "type": "integer" + }, + "FramerateNumerator": { + "locationName": "framerateNumerator", + "type": "integer" + }, + "GopClosedCadence": { + "locationName": "gopClosedCadence", + "type": "integer" + }, + "GopSize": { + "locationName": "gopSize", + "type": "double" + }, + "GopSizeUnits": { + "locationName": "gopSizeUnits" + }, + "HrdBufferInitialFillPercentage": { + "locationName": "hrdBufferInitialFillPercentage", + "type": "integer" + }, + "HrdBufferSize": { + "locationName": "hrdBufferSize", + "type": "integer" + }, + "InterlaceMode": { + "locationName": "interlaceMode" + }, + "IntraDcPrecision": { + "locationName": "intraDcPrecision" + }, + "MaxBitrate": { + "locationName": "maxBitrate", + "type": "integer" + }, + "MinIInterval": { + "locationName": "minIInterval", + "type": "integer" + }, + "NumberBFramesBetweenReferenceFrames": { + "locationName": "numberBFramesBetweenReferenceFrames", + "type": "integer" + }, + "ParControl": { + "locationName": "parControl" + }, + "ParDenominator": { + "locationName": "parDenominator", + "type": "integer" + }, + "ParNumerator": { + "locationName": "parNumerator", + "type": "integer" + }, + "QualityTuningLevel": { + "locationName": "qualityTuningLevel" + }, + "RateControlMode": { + "locationName": "rateControlMode" + }, + "SceneChangeDetect": { + "locationName": "sceneChangeDetect" + }, + "SlowPal": { + "locationName": "slowPal" + }, + "Softness": { + "locationName": "softness", + "type": "integer" + }, + "SpatialAdaptiveQuantization": { + "locationName": "spatialAdaptiveQuantization" + }, + "Syntax": { + "locationName": "syntax" + }, + "Telecine": { + "locationName": "telecine" + }, + "TemporalAdaptiveQuantization": { + "locationName": "temporalAdaptiveQuantization" + } + } + }, + "ProresSettings": { + "locationName": "proresSettings", + "type": "structure", + "members": { + "CodecProfile": { + "locationName": "codecProfile" + }, + "FramerateControl": { + "locationName": "framerateControl" + }, + "FramerateConversionAlgorithm": { + "locationName": "framerateConversionAlgorithm" + }, + "FramerateDenominator": { + "locationName": "framerateDenominator", + "type": "integer" + }, + "FramerateNumerator": { + "locationName": "framerateNumerator", + "type": "integer" + }, + "InterlaceMode": { + "locationName": "interlaceMode" + }, + "ParControl": { + "locationName": "parControl" + }, + "ParDenominator": { + "locationName": "parDenominator", + "type": "integer" + }, + "ParNumerator": { + "locationName": "parNumerator", + "type": "integer" + }, + "SlowPal": { + "locationName": "slowPal" + }, + "Telecine": { + "locationName": "telecine" + } + } + } + } + }, + "ColorMetadata": { + "locationName": "colorMetadata" + }, + "Crop": { + "shape": "Sbj", + "locationName": "crop" + }, + "DropFrameTimecode": { + "locationName": "dropFrameTimecode" + }, + "FixedAfd": { + "locationName": "fixedAfd", + "type": "integer" + }, + "Height": { + "locationName": "height", + "type": "integer" + }, + "Position": { + "shape": "Sbj", + "locationName": "position" + }, + "RespondToAfd": { + "locationName": "respondToAfd" + }, + "ScalingBehavior": { + "locationName": "scalingBehavior" + }, + "Sharpness": { + "locationName": "sharpness", + "type": "integer" + }, + "TimecodeInsertion": { + "locationName": "timecodeInsertion" + }, + "VideoPreprocessors": { + "locationName": "videoPreprocessors", + "type": "structure", + "members": { + "ColorCorrector": { + "locationName": "colorCorrector", + "type": "structure", + "members": { + "Brightness": { + "locationName": "brightness", + "type": "integer" + }, + "ColorSpaceConversion": { + "locationName": "colorSpaceConversion" + }, + "Contrast": { + "locationName": "contrast", + "type": "integer" + }, + "Hdr10Metadata": { + "shape": "S2h", + "locationName": "hdr10Metadata" + }, + "Hue": { + "locationName": "hue", + "type": "integer" + }, + "Saturation": { + "locationName": "saturation", + "type": "integer" + } + } + }, + "Deinterlacer": { + "locationName": "deinterlacer", + "type": "structure", + "members": { + "Algorithm": { + "locationName": "algorithm" + }, + "Control": { + "locationName": "control" + }, + "Mode": { + "locationName": "mode" + } + } + }, + "ImageInserter": { + "shape": "S1z", + "locationName": "imageInserter" + }, + "NoiseReducer": { + "locationName": "noiseReducer", + "type": "structure", + "members": { + "Filter": { + "locationName": "filter" + }, + "FilterSettings": { + "locationName": "filterSettings", + "type": "structure", + "members": { + "Strength": { + "locationName": "strength", + "type": "integer" + } + } + }, + "SpatialFilterSettings": { + "locationName": "spatialFilterSettings", + "type": "structure", + "members": { + "PostFilterSharpenStrength": { + "locationName": "postFilterSharpenStrength", + "type": "integer" + }, + "Speed": { + "locationName": "speed", + "type": "integer" + }, + "Strength": { + "locationName": "strength", + "type": "integer" + } + } + } + } + }, + "TimecodeBurnin": { + "locationName": "timecodeBurnin", + "type": "structure", + "members": { + "FontSize": { + "locationName": "fontSize", + "type": "integer" + }, + "Position": { + "locationName": "position" + }, + "Prefix": { + "locationName": "prefix" + } + } + } + } + }, + "Width": { + "locationName": "width", + "type": "integer" + } + } + }, + "Sbj": { + "type": "structure", + "members": { + "Height": { + "locationName": "height", + "type": "integer" + }, + "Width": { + "locationName": "width", + "type": "integer" + }, + "X": { + "locationName": "x", + "type": "integer" + }, + "Y": { + "locationName": "y", + "type": "integer" + } + } + }, + "Scb": { + "type": "structure", + "members": { + "Anchor": { + "locationName": "anchor" + }, + "Source": { + "locationName": "source" + }, + "Start": { + "locationName": "start" + }, + "TimestampOffset": { + "locationName": "timestampOffset" + } + } + }, + "Sce": { + "type": "structure", + "members": { + "Id3Insertions": { + "locationName": "id3Insertions", + "type": "list", + "member": { + "type": "structure", + "members": { + "Id3": { + "locationName": "id3" + }, + "Timecode": { + "locationName": "timecode" + } + } + } + } + } + }, + "Scj": { + "type": "map", + "key": {}, + "value": {} + }, + "Scl": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "S7", + "locationName": "accelerationSettings" + }, + "Arn": { + "locationName": "arn" + }, + "BillingTagsSource": { + "locationName": "billingTagsSource" + }, + "CreatedAt": { + "shape": "Scm", + "locationName": "createdAt" + }, + "CurrentPhase": { + "locationName": "currentPhase" + }, + "ErrorCode": { + "locationName": "errorCode", + "type": "integer" + }, + "ErrorMessage": { + "locationName": "errorMessage" + }, + "Id": { + "locationName": "id" + }, + "JobPercentComplete": { + "locationName": "jobPercentComplete", + "type": "integer" + }, + "JobTemplate": { + "locationName": "jobTemplate" + }, + "OutputGroupDetails": { + "locationName": "outputGroupDetails", + "type": "list", + "member": { + "type": "structure", + "members": { + "OutputDetails": { + "locationName": "outputDetails", + "type": "list", + "member": { + "type": "structure", + "members": { + "DurationInMs": { + "locationName": "durationInMs", + "type": "integer" + }, + "VideoDetails": { + "locationName": "videoDetails", + "type": "structure", + "members": { + "HeightInPx": { + "locationName": "heightInPx", + "type": "integer" + }, + "WidthInPx": { + "locationName": "widthInPx", + "type": "integer" + } + } + } + } + } + } + } + } + }, + "Queue": { + "locationName": "queue" + }, + "RetryCount": { + "locationName": "retryCount", + "type": "integer" + }, + "Role": { + "locationName": "role" + }, + "Settings": { + "shape": "Sa", + "locationName": "settings" + }, + "Status": { + "locationName": "status" + }, + "StatusUpdateInterval": { + "locationName": "statusUpdateInterval" + }, + "Timing": { + "locationName": "timing", + "type": "structure", + "members": { + "FinishTime": { + "shape": "Scm", + "locationName": "finishTime" + }, + "StartTime": { + "shape": "Scm", + "locationName": "startTime" + }, + "SubmitTime": { + "shape": "Scm", + "locationName": "submitTime" + } + } + }, + "UserMetadata": { + "shape": "Scj", + "locationName": "userMetadata" + } + }, + "required": [ + "Role", + "Settings" + ] + }, + "Scm": { + "type": "timestamp", + "timestampFormat": "unixTimestamp" + }, + "Scx": { + "type": "structure", + "members": { + "AdAvailOffset": { + "locationName": "adAvailOffset", + "type": "integer" + }, + "AvailBlanking": { + "shape": "Sc", + "locationName": "availBlanking" + }, + "Esam": { + "shape": "Se", + "locationName": "esam" + }, + "Inputs": { + "locationName": "inputs", + "type": "list", + "member": { + "type": "structure", + "members": { + "AudioSelectorGroups": { + "shape": "Sm", + "locationName": "audioSelectorGroups" + }, + "AudioSelectors": { + "shape": "Sq", + "locationName": "audioSelectors" + }, + "CaptionSelectors": { + "shape": "S19", + "locationName": "captionSelectors" + }, + "DeblockFilter": { + "locationName": "deblockFilter" + }, + "DenoiseFilter": { + "locationName": "denoiseFilter" + }, + "FilterEnable": { + "locationName": "filterEnable" + }, + "FilterStrength": { + "locationName": "filterStrength", + "type": "integer" + }, + "ImageInserter": { + "shape": "S1z", + "locationName": "imageInserter" + }, + "InputClippings": { + "shape": "S27", + "locationName": "inputClippings" + }, + "ProgramNumber": { + "locationName": "programNumber", + "type": "integer" + }, + "PsiControl": { + "locationName": "psiControl" + }, + "TimecodeSource": { + "locationName": "timecodeSource" + }, + "VideoSelector": { + "shape": "S2e", + "locationName": "videoSelector" + } + } + } + }, + "MotionImageInserter": { + "shape": "S2l", + "locationName": "motionImageInserter" + }, + "NielsenConfiguration": { + "shape": "S2u", + "locationName": "nielsenConfiguration" + }, + "OutputGroups": { + "shape": "S2w", + "locationName": "outputGroups" + }, + "TimecodeConfig": { + "shape": "Scb", + "locationName": "timecodeConfig" + }, + "TimedMetadataInsertion": { + "shape": "Sce", + "locationName": "timedMetadataInsertion" + } + } + }, + "Sd1": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "S7", + "locationName": "accelerationSettings" + }, + "Arn": { + "locationName": "arn" + }, + "Category": { + "locationName": "category" + }, + "CreatedAt": { + "shape": "Scm", + "locationName": "createdAt" + }, + "Description": { + "locationName": "description" + }, + "LastUpdated": { + "shape": "Scm", + "locationName": "lastUpdated" + }, + "Name": { + "locationName": "name" + }, + "Queue": { + "locationName": "queue" + }, + "Settings": { + "shape": "Scx", + "locationName": "settings" + }, + "StatusUpdateInterval": { + "locationName": "statusUpdateInterval" + }, + "Type": { + "locationName": "type" + } + }, + "required": [ + "Settings", + "Name" + ] + }, + "Sd4": { + "type": "structure", + "members": { + "AudioDescriptions": { + "shape": "S4t", + "locationName": "audioDescriptions" + }, + "CaptionDescriptions": { + "locationName": "captionDescriptions", + "type": "list", + "member": { + "type": "structure", + "members": { + "CustomLanguageCode": { + "locationName": "customLanguageCode" + }, + "DestinationSettings": { + "shape": "S6j", + "locationName": "destinationSettings" + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageDescription": { + "locationName": "languageDescription" + } + } + } + }, + "ContainerSettings": { + "shape": "S79", + "locationName": "containerSettings" + }, + "VideoDescription": { + "shape": "S8p", + "locationName": "videoDescription" + } + } + }, + "Sd8": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Category": { + "locationName": "category" + }, + "CreatedAt": { + "shape": "Scm", + "locationName": "createdAt" + }, + "Description": { + "locationName": "description" + }, + "LastUpdated": { + "shape": "Scm", + "locationName": "lastUpdated" + }, + "Name": { + "locationName": "name" + }, + "Settings": { + "shape": "Sd4", + "locationName": "settings" + }, + "Type": { + "locationName": "type" + } + }, + "required": [ + "Settings", + "Name" + ] + }, + "Sdb": { + "type": "structure", + "members": { + "Commitment": { + "locationName": "commitment" + }, + "RenewalType": { + "locationName": "renewalType" + }, + "ReservedSlots": { + "locationName": "reservedSlots", + "type": "integer" + } + }, + "required": [ + "Commitment", + "ReservedSlots", + "RenewalType" + ] + }, + "Sdf": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "CreatedAt": { + "shape": "Scm", + "locationName": "createdAt" + }, + "Description": { + "locationName": "description" + }, + "LastUpdated": { + "shape": "Scm", + "locationName": "lastUpdated" + }, + "Name": { + "locationName": "name" + }, + "PricingPlan": { + "locationName": "pricingPlan" + }, + "ProgressingJobsCount": { + "locationName": "progressingJobsCount", + "type": "integer" + }, + "ReservationPlan": { + "locationName": "reservationPlan", + "type": "structure", + "members": { + "Commitment": { + "locationName": "commitment" + }, + "ExpiresAt": { + "shape": "Scm", + "locationName": "expiresAt" + }, + "PurchasedAt": { + "shape": "Scm", + "locationName": "purchasedAt" + }, + "RenewalType": { + "locationName": "renewalType" + }, + "ReservedSlots": { + "locationName": "reservedSlots", + "type": "integer" + }, + "Status": { + "locationName": "status" + } + } + }, + "Status": { + "locationName": "status" + }, + "SubmittedJobsCount": { + "locationName": "submittedJobsCount", + "type": "integer" + }, + "Type": { + "locationName": "type" + } + }, + "required": [ + "Name" + ] + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.paginators.json b/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.paginators.json new file mode 100644 index 0000000..24b088e --- /dev/null +++ b/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.paginators.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "DescribeEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Endpoints" + }, + "ListJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Jobs" + }, + "ListPresets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Presets" + }, + "ListJobTemplates": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "JobTemplates" + }, + "ListQueues": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Queues" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json b/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json new file mode 100644 index 0000000..e5155f6 --- /dev/null +++ b/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json @@ -0,0 +1,4377 @@ +{ + "metadata": { + "apiVersion": "2017-10-14", + "endpointPrefix": "medialive", + "signingName": "medialive", + "serviceFullName": "AWS Elemental MediaLive", + "serviceId": "MediaLive", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "medialive-2017-10-14", + "signatureVersion": "v4", + "serviceAbbreviation": "MediaLive" + }, + "operations": { + "BatchUpdateSchedule": { + "http": { + "method": "PUT", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + }, + "Creates": { + "locationName": "creates", + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "S4", + "locationName": "scheduleActions" + } + }, + "required": [ + "ScheduleActions" + ] + }, + "Deletes": { + "locationName": "deletes", + "type": "structure", + "members": { + "ActionNames": { + "shape": "S16", + "locationName": "actionNames" + } + }, + "required": [ + "ActionNames" + ] + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": { + "Creates": { + "locationName": "creates", + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "S4", + "locationName": "scheduleActions" + } + }, + "required": [ + "ScheduleActions" + ] + }, + "Deletes": { + "locationName": "deletes", + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "S4", + "locationName": "scheduleActions" + } + }, + "required": [ + "ScheduleActions" + ] + } + } + } + }, + "CreateChannel": { + "http": { + "requestUri": "/prod/channels", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ChannelClass": { + "locationName": "channelClass" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EncoderSettings": { + "shape": "S1j", + "locationName": "encoderSettings" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "RequestId": { + "locationName": "requestId", + "idempotencyToken": true + }, + "Reserved": { + "locationName": "reserved", + "deprecated": true + }, + "RoleArn": { + "locationName": "roleArn" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + }, + "output": { + "type": "structure", + "members": { + "Channel": { + "shape": "Sad", + "locationName": "channel" + } + } + } + }, + "CreateInput": { + "http": { + "requestUri": "/prod/inputs", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "Destinations": { + "shape": "Sai", + "locationName": "destinations" + }, + "InputSecurityGroups": { + "shape": "S16", + "locationName": "inputSecurityGroups" + }, + "MediaConnectFlows": { + "shape": "Sak", + "locationName": "mediaConnectFlows" + }, + "Name": { + "locationName": "name" + }, + "RequestId": { + "locationName": "requestId", + "idempotencyToken": true + }, + "RoleArn": { + "locationName": "roleArn" + }, + "Sources": { + "shape": "Sam", + "locationName": "sources" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "Type": { + "locationName": "type" + }, + "Vpc": { + "locationName": "vpc", + "type": "structure", + "members": { + "SecurityGroupIds": { + "shape": "S16", + "locationName": "securityGroupIds" + }, + "SubnetIds": { + "shape": "S16", + "locationName": "subnetIds" + } + }, + "required": [ + "SubnetIds" + ] + } + } + }, + "output": { + "type": "structure", + "members": { + "Input": { + "shape": "Sar", + "locationName": "input" + } + } + } + }, + "CreateInputSecurityGroup": { + "http": { + "requestUri": "/prod/inputSecurityGroups", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "WhitelistRules": { + "shape": "Sb2", + "locationName": "whitelistRules" + } + } + }, + "output": { + "type": "structure", + "members": { + "SecurityGroup": { + "shape": "Sb5", + "locationName": "securityGroup" + } + } + } + }, + "CreateTags": { + "http": { + "requestUri": "/prod/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + }, + "required": [ + "ResourceArn" + ] + } + }, + "DeleteChannel": { + "http": { + "method": "DELETE", + "requestUri": "/prod/channels/{channelId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelClass": { + "locationName": "channelClass" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EgressEndpoints": { + "shape": "Sae", + "locationName": "egressEndpoints" + }, + "EncoderSettings": { + "shape": "S1j", + "locationName": "encoderSettings" + }, + "Id": { + "locationName": "id" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "PipelinesRunningCount": { + "locationName": "pipelinesRunningCount", + "type": "integer" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + } + }, + "DeleteInput": { + "http": { + "method": "DELETE", + "requestUri": "/prod/inputs/{inputId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "InputId": { + "location": "uri", + "locationName": "inputId" + } + }, + "required": [ + "InputId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteInputSecurityGroup": { + "http": { + "method": "DELETE", + "requestUri": "/prod/inputSecurityGroups/{inputSecurityGroupId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "InputSecurityGroupId": { + "location": "uri", + "locationName": "inputSecurityGroupId" + } + }, + "required": [ + "InputSecurityGroupId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteReservation": { + "http": { + "method": "DELETE", + "requestUri": "/prod/reservations/{reservationId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ReservationId": { + "location": "uri", + "locationName": "reservationId" + } + }, + "required": [ + "ReservationId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Count": { + "locationName": "count", + "type": "integer" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "DurationUnits": { + "locationName": "durationUnits" + }, + "End": { + "locationName": "end" + }, + "FixedPrice": { + "locationName": "fixedPrice", + "type": "double" + }, + "Name": { + "locationName": "name" + }, + "OfferingDescription": { + "locationName": "offeringDescription" + }, + "OfferingId": { + "locationName": "offeringId" + }, + "OfferingType": { + "locationName": "offeringType" + }, + "Region": { + "locationName": "region" + }, + "ReservationId": { + "locationName": "reservationId" + }, + "ResourceSpecification": { + "shape": "Sbk", + "locationName": "resourceSpecification" + }, + "Start": { + "locationName": "start" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "UsagePrice": { + "locationName": "usagePrice", + "type": "double" + } + } + } + }, + "DeleteSchedule": { + "http": { + "method": "DELETE", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTags": { + "http": { + "method": "DELETE", + "requestUri": "/prod/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "shape": "S16", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + } + }, + "DescribeChannel": { + "http": { + "method": "GET", + "requestUri": "/prod/channels/{channelId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelClass": { + "locationName": "channelClass" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EgressEndpoints": { + "shape": "Sae", + "locationName": "egressEndpoints" + }, + "EncoderSettings": { + "shape": "S1j", + "locationName": "encoderSettings" + }, + "Id": { + "locationName": "id" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "PipelinesRunningCount": { + "locationName": "pipelinesRunningCount", + "type": "integer" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + } + }, + "DescribeInput": { + "http": { + "method": "GET", + "requestUri": "/prod/inputs/{inputId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "InputId": { + "location": "uri", + "locationName": "inputId" + } + }, + "required": [ + "InputId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "AttachedChannels": { + "shape": "S16", + "locationName": "attachedChannels" + }, + "Destinations": { + "shape": "Sas", + "locationName": "destinations" + }, + "Id": { + "locationName": "id" + }, + "InputClass": { + "locationName": "inputClass" + }, + "MediaConnectFlows": { + "shape": "Saw", + "locationName": "mediaConnectFlows" + }, + "Name": { + "locationName": "name" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "SecurityGroups": { + "shape": "S16", + "locationName": "securityGroups" + }, + "Sources": { + "shape": "Say", + "locationName": "sources" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "Type": { + "locationName": "type" + } + } + } + }, + "DescribeInputSecurityGroup": { + "http": { + "method": "GET", + "requestUri": "/prod/inputSecurityGroups/{inputSecurityGroupId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "InputSecurityGroupId": { + "location": "uri", + "locationName": "inputSecurityGroupId" + } + }, + "required": [ + "InputSecurityGroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Id": { + "locationName": "id" + }, + "Inputs": { + "shape": "S16", + "locationName": "inputs" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "WhitelistRules": { + "shape": "Sb7", + "locationName": "whitelistRules" + } + } + } + }, + "DescribeOffering": { + "http": { + "method": "GET", + "requestUri": "/prod/offerings/{offeringId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "OfferingId": { + "location": "uri", + "locationName": "offeringId" + } + }, + "required": [ + "OfferingId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "DurationUnits": { + "locationName": "durationUnits" + }, + "FixedPrice": { + "locationName": "fixedPrice", + "type": "double" + }, + "OfferingDescription": { + "locationName": "offeringDescription" + }, + "OfferingId": { + "locationName": "offeringId" + }, + "OfferingType": { + "locationName": "offeringType" + }, + "Region": { + "locationName": "region" + }, + "ResourceSpecification": { + "shape": "Sbk", + "locationName": "resourceSpecification" + }, + "UsagePrice": { + "locationName": "usagePrice", + "type": "double" + } + } + } + }, + "DescribeReservation": { + "http": { + "method": "GET", + "requestUri": "/prod/reservations/{reservationId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ReservationId": { + "location": "uri", + "locationName": "reservationId" + } + }, + "required": [ + "ReservationId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Count": { + "locationName": "count", + "type": "integer" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "DurationUnits": { + "locationName": "durationUnits" + }, + "End": { + "locationName": "end" + }, + "FixedPrice": { + "locationName": "fixedPrice", + "type": "double" + }, + "Name": { + "locationName": "name" + }, + "OfferingDescription": { + "locationName": "offeringDescription" + }, + "OfferingId": { + "locationName": "offeringId" + }, + "OfferingType": { + "locationName": "offeringType" + }, + "Region": { + "locationName": "region" + }, + "ReservationId": { + "locationName": "reservationId" + }, + "ResourceSpecification": { + "shape": "Sbk", + "locationName": "resourceSpecification" + }, + "Start": { + "locationName": "start" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "UsagePrice": { + "locationName": "usagePrice", + "type": "double" + } + } + } + }, + "DescribeSchedule": { + "http": { + "method": "GET", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "ScheduleActions": { + "shape": "S4", + "locationName": "scheduleActions" + } + } + } + }, + "ListChannels": { + "http": { + "method": "GET", + "requestUri": "/prod/channels", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Channels": { + "locationName": "channels", + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelClass": { + "locationName": "channelClass" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EgressEndpoints": { + "shape": "Sae", + "locationName": "egressEndpoints" + }, + "Id": { + "locationName": "id" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "PipelinesRunningCount": { + "locationName": "pipelinesRunningCount", + "type": "integer" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListInputSecurityGroups": { + "http": { + "method": "GET", + "requestUri": "/prod/inputSecurityGroups", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "InputSecurityGroups": { + "locationName": "inputSecurityGroups", + "type": "list", + "member": { + "shape": "Sb5" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListInputs": { + "http": { + "method": "GET", + "requestUri": "/prod/inputs", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Inputs": { + "locationName": "inputs", + "type": "list", + "member": { + "shape": "Sar" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListOfferings": { + "http": { + "method": "GET", + "requestUri": "/prod/offerings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelClass": { + "location": "querystring", + "locationName": "channelClass" + }, + "ChannelConfiguration": { + "location": "querystring", + "locationName": "channelConfiguration" + }, + "Codec": { + "location": "querystring", + "locationName": "codec" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "MaximumBitrate": { + "location": "querystring", + "locationName": "maximumBitrate" + }, + "MaximumFramerate": { + "location": "querystring", + "locationName": "maximumFramerate" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "Resolution": { + "location": "querystring", + "locationName": "resolution" + }, + "ResourceType": { + "location": "querystring", + "locationName": "resourceType" + }, + "SpecialFeature": { + "location": "querystring", + "locationName": "specialFeature" + }, + "VideoQuality": { + "location": "querystring", + "locationName": "videoQuality" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Offerings": { + "locationName": "offerings", + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "DurationUnits": { + "locationName": "durationUnits" + }, + "FixedPrice": { + "locationName": "fixedPrice", + "type": "double" + }, + "OfferingDescription": { + "locationName": "offeringDescription" + }, + "OfferingId": { + "locationName": "offeringId" + }, + "OfferingType": { + "locationName": "offeringType" + }, + "Region": { + "locationName": "region" + }, + "ResourceSpecification": { + "shape": "Sbk", + "locationName": "resourceSpecification" + }, + "UsagePrice": { + "locationName": "usagePrice", + "type": "double" + } + } + } + } + } + } + }, + "ListReservations": { + "http": { + "method": "GET", + "requestUri": "/prod/reservations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelClass": { + "location": "querystring", + "locationName": "channelClass" + }, + "Codec": { + "location": "querystring", + "locationName": "codec" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "MaximumBitrate": { + "location": "querystring", + "locationName": "maximumBitrate" + }, + "MaximumFramerate": { + "location": "querystring", + "locationName": "maximumFramerate" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "Resolution": { + "location": "querystring", + "locationName": "resolution" + }, + "ResourceType": { + "location": "querystring", + "locationName": "resourceType" + }, + "SpecialFeature": { + "location": "querystring", + "locationName": "specialFeature" + }, + "VideoQuality": { + "location": "querystring", + "locationName": "videoQuality" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Reservations": { + "locationName": "reservations", + "type": "list", + "member": { + "shape": "Scq" + } + } + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/prod/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + } + }, + "PurchaseOffering": { + "http": { + "requestUri": "/prod/offerings/{offeringId}/purchase", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "Count": { + "locationName": "count", + "type": "integer" + }, + "Name": { + "locationName": "name" + }, + "OfferingId": { + "location": "uri", + "locationName": "offeringId" + }, + "RequestId": { + "locationName": "requestId", + "idempotencyToken": true + }, + "Start": { + "locationName": "start" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + }, + "required": [ + "OfferingId", + "Count" + ] + }, + "output": { + "type": "structure", + "members": { + "Reservation": { + "shape": "Scq", + "locationName": "reservation" + } + } + } + }, + "StartChannel": { + "http": { + "requestUri": "/prod/channels/{channelId}/start", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelClass": { + "locationName": "channelClass" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EgressEndpoints": { + "shape": "Sae", + "locationName": "egressEndpoints" + }, + "EncoderSettings": { + "shape": "S1j", + "locationName": "encoderSettings" + }, + "Id": { + "locationName": "id" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "PipelinesRunningCount": { + "locationName": "pipelinesRunningCount", + "type": "integer" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + } + }, + "StopChannel": { + "http": { + "requestUri": "/prod/channels/{channelId}/stop", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelClass": { + "locationName": "channelClass" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EgressEndpoints": { + "shape": "Sae", + "locationName": "egressEndpoints" + }, + "EncoderSettings": { + "shape": "S1j", + "locationName": "encoderSettings" + }, + "Id": { + "locationName": "id" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "PipelinesRunningCount": { + "locationName": "pipelinesRunningCount", + "type": "integer" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + } + }, + "UpdateChannel": { + "http": { + "method": "PUT", + "requestUri": "/prod/channels/{channelId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelId": { + "location": "uri", + "locationName": "channelId" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EncoderSettings": { + "shape": "S1j", + "locationName": "encoderSettings" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "RoleArn": { + "locationName": "roleArn" + } + }, + "required": [ + "ChannelId" + ] + }, + "output": { + "type": "structure", + "members": { + "Channel": { + "shape": "Sad", + "locationName": "channel" + } + } + } + }, + "UpdateChannelClass": { + "http": { + "method": "PUT", + "requestUri": "/prod/channels/{channelId}/channelClass", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ChannelClass": { + "locationName": "channelClass" + }, + "ChannelId": { + "location": "uri", + "locationName": "channelId" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + } + }, + "required": [ + "ChannelId", + "ChannelClass" + ] + }, + "output": { + "type": "structure", + "members": { + "Channel": { + "shape": "Sad", + "locationName": "channel" + } + } + } + }, + "UpdateInput": { + "http": { + "method": "PUT", + "requestUri": "/prod/inputs/{inputId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Destinations": { + "shape": "Sai", + "locationName": "destinations" + }, + "InputId": { + "location": "uri", + "locationName": "inputId" + }, + "InputSecurityGroups": { + "shape": "S16", + "locationName": "inputSecurityGroups" + }, + "MediaConnectFlows": { + "shape": "Sak", + "locationName": "mediaConnectFlows" + }, + "Name": { + "locationName": "name" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "Sources": { + "shape": "Sam", + "locationName": "sources" + } + }, + "required": [ + "InputId" + ] + }, + "output": { + "type": "structure", + "members": { + "Input": { + "shape": "Sar", + "locationName": "input" + } + } + } + }, + "UpdateInputSecurityGroup": { + "http": { + "method": "PUT", + "requestUri": "/prod/inputSecurityGroups/{inputSecurityGroupId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "InputSecurityGroupId": { + "location": "uri", + "locationName": "inputSecurityGroupId" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "WhitelistRules": { + "shape": "Sb2", + "locationName": "whitelistRules" + } + }, + "required": [ + "InputSecurityGroupId" + ] + }, + "output": { + "type": "structure", + "members": { + "SecurityGroup": { + "shape": "Sb5", + "locationName": "securityGroup" + } + } + } + }, + "UpdateReservation": { + "http": { + "method": "PUT", + "requestUri": "/prod/reservations/{reservationId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + }, + "ReservationId": { + "location": "uri", + "locationName": "reservationId" + } + }, + "required": [ + "ReservationId" + ] + }, + "output": { + "type": "structure", + "members": { + "Reservation": { + "shape": "Scq", + "locationName": "reservation" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ActionName": { + "locationName": "actionName" + }, + "ScheduleActionSettings": { + "locationName": "scheduleActionSettings", + "type": "structure", + "members": { + "HlsTimedMetadataSettings": { + "locationName": "hlsTimedMetadataSettings", + "type": "structure", + "members": { + "Id3": { + "locationName": "id3" + } + }, + "required": [ + "Id3" + ] + }, + "InputSwitchSettings": { + "locationName": "inputSwitchSettings", + "type": "structure", + "members": { + "InputAttachmentNameReference": { + "locationName": "inputAttachmentNameReference" + } + }, + "required": [ + "InputAttachmentNameReference" + ] + }, + "PauseStateSettings": { + "locationName": "pauseStateSettings", + "type": "structure", + "members": { + "Pipelines": { + "locationName": "pipelines", + "type": "list", + "member": { + "type": "structure", + "members": { + "PipelineId": { + "locationName": "pipelineId" + } + }, + "required": [ + "PipelineId" + ] + } + } + } + }, + "Scte35ReturnToNetworkSettings": { + "locationName": "scte35ReturnToNetworkSettings", + "type": "structure", + "members": { + "SpliceEventId": { + "locationName": "spliceEventId", + "type": "long" + } + }, + "required": [ + "SpliceEventId" + ] + }, + "Scte35SpliceInsertSettings": { + "locationName": "scte35SpliceInsertSettings", + "type": "structure", + "members": { + "Duration": { + "locationName": "duration", + "type": "long" + }, + "SpliceEventId": { + "locationName": "spliceEventId", + "type": "long" + } + }, + "required": [ + "SpliceEventId" + ] + }, + "Scte35TimeSignalSettings": { + "locationName": "scte35TimeSignalSettings", + "type": "structure", + "members": { + "Scte35Descriptors": { + "locationName": "scte35Descriptors", + "type": "list", + "member": { + "type": "structure", + "members": { + "Scte35DescriptorSettings": { + "locationName": "scte35DescriptorSettings", + "type": "structure", + "members": { + "SegmentationDescriptorScte35DescriptorSettings": { + "locationName": "segmentationDescriptorScte35DescriptorSettings", + "type": "structure", + "members": { + "DeliveryRestrictions": { + "locationName": "deliveryRestrictions", + "type": "structure", + "members": { + "ArchiveAllowedFlag": { + "locationName": "archiveAllowedFlag" + }, + "DeviceRestrictions": { + "locationName": "deviceRestrictions" + }, + "NoRegionalBlackoutFlag": { + "locationName": "noRegionalBlackoutFlag" + }, + "WebDeliveryAllowedFlag": { + "locationName": "webDeliveryAllowedFlag" + } + }, + "required": [ + "DeviceRestrictions", + "ArchiveAllowedFlag", + "WebDeliveryAllowedFlag", + "NoRegionalBlackoutFlag" + ] + }, + "SegmentNum": { + "locationName": "segmentNum", + "type": "integer" + }, + "SegmentationCancelIndicator": { + "locationName": "segmentationCancelIndicator" + }, + "SegmentationDuration": { + "locationName": "segmentationDuration", + "type": "long" + }, + "SegmentationEventId": { + "locationName": "segmentationEventId", + "type": "long" + }, + "SegmentationTypeId": { + "locationName": "segmentationTypeId", + "type": "integer" + }, + "SegmentationUpid": { + "locationName": "segmentationUpid" + }, + "SegmentationUpidType": { + "locationName": "segmentationUpidType", + "type": "integer" + }, + "SegmentsExpected": { + "locationName": "segmentsExpected", + "type": "integer" + }, + "SubSegmentNum": { + "locationName": "subSegmentNum", + "type": "integer" + }, + "SubSegmentsExpected": { + "locationName": "subSegmentsExpected", + "type": "integer" + } + }, + "required": [ + "SegmentationEventId", + "SegmentationCancelIndicator" + ] + } + }, + "required": [ + "SegmentationDescriptorScte35DescriptorSettings" + ] + } + }, + "required": [ + "Scte35DescriptorSettings" + ] + } + } + }, + "required": [ + "Scte35Descriptors" + ] + }, + "StaticImageActivateSettings": { + "locationName": "staticImageActivateSettings", + "type": "structure", + "members": { + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "FadeIn": { + "locationName": "fadeIn", + "type": "integer" + }, + "FadeOut": { + "locationName": "fadeOut", + "type": "integer" + }, + "Height": { + "locationName": "height", + "type": "integer" + }, + "Image": { + "shape": "Sx", + "locationName": "image" + }, + "ImageX": { + "locationName": "imageX", + "type": "integer" + }, + "ImageY": { + "locationName": "imageY", + "type": "integer" + }, + "Layer": { + "locationName": "layer", + "type": "integer" + }, + "Opacity": { + "locationName": "opacity", + "type": "integer" + }, + "Width": { + "locationName": "width", + "type": "integer" + } + }, + "required": [ + "Image" + ] + }, + "StaticImageDeactivateSettings": { + "locationName": "staticImageDeactivateSettings", + "type": "structure", + "members": { + "FadeOut": { + "locationName": "fadeOut", + "type": "integer" + }, + "Layer": { + "locationName": "layer", + "type": "integer" + } + } + } + } + }, + "ScheduleActionStartSettings": { + "locationName": "scheduleActionStartSettings", + "type": "structure", + "members": { + "FixedModeScheduleActionStartSettings": { + "locationName": "fixedModeScheduleActionStartSettings", + "type": "structure", + "members": { + "Time": { + "locationName": "time" + } + }, + "required": [ + "Time" + ] + }, + "FollowModeScheduleActionStartSettings": { + "locationName": "followModeScheduleActionStartSettings", + "type": "structure", + "members": { + "FollowPoint": { + "locationName": "followPoint" + }, + "ReferenceActionName": { + "locationName": "referenceActionName" + } + }, + "required": [ + "ReferenceActionName", + "FollowPoint" + ] + } + } + } + }, + "required": [ + "ActionName", + "ScheduleActionStartSettings", + "ScheduleActionSettings" + ] + } + }, + "Sx": { + "type": "structure", + "members": { + "PasswordParam": { + "locationName": "passwordParam" + }, + "Uri": { + "locationName": "uri" + }, + "Username": { + "locationName": "username" + } + }, + "required": [ + "Uri" + ] + }, + "S16": { + "type": "list", + "member": {} + }, + "S1c": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": { + "locationName": "id" + }, + "MediaPackageSettings": { + "locationName": "mediaPackageSettings", + "type": "list", + "member": { + "type": "structure", + "members": { + "ChannelId": { + "locationName": "channelId" + } + } + } + }, + "Settings": { + "locationName": "settings", + "type": "list", + "member": { + "type": "structure", + "members": { + "PasswordParam": { + "locationName": "passwordParam" + }, + "StreamName": { + "locationName": "streamName" + }, + "Url": { + "locationName": "url" + }, + "Username": { + "locationName": "username" + } + } + } + } + } + } + }, + "S1j": { + "type": "structure", + "members": { + "AudioDescriptions": { + "locationName": "audioDescriptions", + "type": "list", + "member": { + "type": "structure", + "members": { + "AudioNormalizationSettings": { + "locationName": "audioNormalizationSettings", + "type": "structure", + "members": { + "Algorithm": { + "locationName": "algorithm" + }, + "AlgorithmControl": { + "locationName": "algorithmControl" + }, + "TargetLkfs": { + "locationName": "targetLkfs", + "type": "double" + } + } + }, + "AudioSelectorName": { + "locationName": "audioSelectorName" + }, + "AudioType": { + "locationName": "audioType" + }, + "AudioTypeControl": { + "locationName": "audioTypeControl" + }, + "CodecSettings": { + "locationName": "codecSettings", + "type": "structure", + "members": { + "AacSettings": { + "locationName": "aacSettings", + "type": "structure", + "members": { + "Bitrate": { + "locationName": "bitrate", + "type": "double" + }, + "CodingMode": { + "locationName": "codingMode" + }, + "InputType": { + "locationName": "inputType" + }, + "Profile": { + "locationName": "profile" + }, + "RateControlMode": { + "locationName": "rateControlMode" + }, + "RawFormat": { + "locationName": "rawFormat" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "double" + }, + "Spec": { + "locationName": "spec" + }, + "VbrQuality": { + "locationName": "vbrQuality" + } + } + }, + "Ac3Settings": { + "locationName": "ac3Settings", + "type": "structure", + "members": { + "Bitrate": { + "locationName": "bitrate", + "type": "double" + }, + "BitstreamMode": { + "locationName": "bitstreamMode" + }, + "CodingMode": { + "locationName": "codingMode" + }, + "Dialnorm": { + "locationName": "dialnorm", + "type": "integer" + }, + "DrcProfile": { + "locationName": "drcProfile" + }, + "LfeFilter": { + "locationName": "lfeFilter" + }, + "MetadataControl": { + "locationName": "metadataControl" + } + } + }, + "Eac3Settings": { + "locationName": "eac3Settings", + "type": "structure", + "members": { + "AttenuationControl": { + "locationName": "attenuationControl" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "double" + }, + "BitstreamMode": { + "locationName": "bitstreamMode" + }, + "CodingMode": { + "locationName": "codingMode" + }, + "DcFilter": { + "locationName": "dcFilter" + }, + "Dialnorm": { + "locationName": "dialnorm", + "type": "integer" + }, + "DrcLine": { + "locationName": "drcLine" + }, + "DrcRf": { + "locationName": "drcRf" + }, + "LfeControl": { + "locationName": "lfeControl" + }, + "LfeFilter": { + "locationName": "lfeFilter" + }, + "LoRoCenterMixLevel": { + "locationName": "loRoCenterMixLevel", + "type": "double" + }, + "LoRoSurroundMixLevel": { + "locationName": "loRoSurroundMixLevel", + "type": "double" + }, + "LtRtCenterMixLevel": { + "locationName": "ltRtCenterMixLevel", + "type": "double" + }, + "LtRtSurroundMixLevel": { + "locationName": "ltRtSurroundMixLevel", + "type": "double" + }, + "MetadataControl": { + "locationName": "metadataControl" + }, + "PassthroughControl": { + "locationName": "passthroughControl" + }, + "PhaseControl": { + "locationName": "phaseControl" + }, + "StereoDownmix": { + "locationName": "stereoDownmix" + }, + "SurroundExMode": { + "locationName": "surroundExMode" + }, + "SurroundMode": { + "locationName": "surroundMode" + } + } + }, + "Mp2Settings": { + "locationName": "mp2Settings", + "type": "structure", + "members": { + "Bitrate": { + "locationName": "bitrate", + "type": "double" + }, + "CodingMode": { + "locationName": "codingMode" + }, + "SampleRate": { + "locationName": "sampleRate", + "type": "double" + } + } + }, + "PassThroughSettings": { + "locationName": "passThroughSettings", + "type": "structure", + "members": {} + } + } + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageCodeControl": { + "locationName": "languageCodeControl" + }, + "Name": { + "locationName": "name" + }, + "RemixSettings": { + "locationName": "remixSettings", + "type": "structure", + "members": { + "ChannelMappings": { + "locationName": "channelMappings", + "type": "list", + "member": { + "type": "structure", + "members": { + "InputChannelLevels": { + "locationName": "inputChannelLevels", + "type": "list", + "member": { + "type": "structure", + "members": { + "Gain": { + "locationName": "gain", + "type": "integer" + }, + "InputChannel": { + "locationName": "inputChannel", + "type": "integer" + } + }, + "required": [ + "InputChannel", + "Gain" + ] + } + }, + "OutputChannel": { + "locationName": "outputChannel", + "type": "integer" + } + }, + "required": [ + "OutputChannel", + "InputChannelLevels" + ] + } + }, + "ChannelsIn": { + "locationName": "channelsIn", + "type": "integer" + }, + "ChannelsOut": { + "locationName": "channelsOut", + "type": "integer" + } + }, + "required": [ + "ChannelMappings" + ] + }, + "StreamName": { + "locationName": "streamName" + } + }, + "required": [ + "AudioSelectorName", + "Name" + ] + } + }, + "AvailBlanking": { + "locationName": "availBlanking", + "type": "structure", + "members": { + "AvailBlankingImage": { + "shape": "Sx", + "locationName": "availBlankingImage" + }, + "State": { + "locationName": "state" + } + } + }, + "AvailConfiguration": { + "locationName": "availConfiguration", + "type": "structure", + "members": { + "AvailSettings": { + "locationName": "availSettings", + "type": "structure", + "members": { + "Scte35SpliceInsert": { + "locationName": "scte35SpliceInsert", + "type": "structure", + "members": { + "AdAvailOffset": { + "locationName": "adAvailOffset", + "type": "integer" + }, + "NoRegionalBlackoutFlag": { + "locationName": "noRegionalBlackoutFlag" + }, + "WebDeliveryAllowedFlag": { + "locationName": "webDeliveryAllowedFlag" + } + } + }, + "Scte35TimeSignalApos": { + "locationName": "scte35TimeSignalApos", + "type": "structure", + "members": { + "AdAvailOffset": { + "locationName": "adAvailOffset", + "type": "integer" + }, + "NoRegionalBlackoutFlag": { + "locationName": "noRegionalBlackoutFlag" + }, + "WebDeliveryAllowedFlag": { + "locationName": "webDeliveryAllowedFlag" + } + } + } + } + } + } + }, + "BlackoutSlate": { + "locationName": "blackoutSlate", + "type": "structure", + "members": { + "BlackoutSlateImage": { + "shape": "Sx", + "locationName": "blackoutSlateImage" + }, + "NetworkEndBlackout": { + "locationName": "networkEndBlackout" + }, + "NetworkEndBlackoutImage": { + "shape": "Sx", + "locationName": "networkEndBlackoutImage" + }, + "NetworkId": { + "locationName": "networkId" + }, + "State": { + "locationName": "state" + } + } + }, + "CaptionDescriptions": { + "locationName": "captionDescriptions", + "type": "list", + "member": { + "type": "structure", + "members": { + "CaptionSelectorName": { + "locationName": "captionSelectorName" + }, + "DestinationSettings": { + "locationName": "destinationSettings", + "type": "structure", + "members": { + "AribDestinationSettings": { + "locationName": "aribDestinationSettings", + "type": "structure", + "members": {} + }, + "BurnInDestinationSettings": { + "locationName": "burnInDestinationSettings", + "type": "structure", + "members": { + "Alignment": { + "locationName": "alignment" + }, + "BackgroundColor": { + "locationName": "backgroundColor" + }, + "BackgroundOpacity": { + "locationName": "backgroundOpacity", + "type": "integer" + }, + "Font": { + "shape": "Sx", + "locationName": "font" + }, + "FontColor": { + "locationName": "fontColor" + }, + "FontOpacity": { + "locationName": "fontOpacity", + "type": "integer" + }, + "FontResolution": { + "locationName": "fontResolution", + "type": "integer" + }, + "FontSize": { + "locationName": "fontSize" + }, + "OutlineColor": { + "locationName": "outlineColor" + }, + "OutlineSize": { + "locationName": "outlineSize", + "type": "integer" + }, + "ShadowColor": { + "locationName": "shadowColor" + }, + "ShadowOpacity": { + "locationName": "shadowOpacity", + "type": "integer" + }, + "ShadowXOffset": { + "locationName": "shadowXOffset", + "type": "integer" + }, + "ShadowYOffset": { + "locationName": "shadowYOffset", + "type": "integer" + }, + "TeletextGridControl": { + "locationName": "teletextGridControl" + }, + "XPosition": { + "locationName": "xPosition", + "type": "integer" + }, + "YPosition": { + "locationName": "yPosition", + "type": "integer" + } + } + }, + "DvbSubDestinationSettings": { + "locationName": "dvbSubDestinationSettings", + "type": "structure", + "members": { + "Alignment": { + "locationName": "alignment" + }, + "BackgroundColor": { + "locationName": "backgroundColor" + }, + "BackgroundOpacity": { + "locationName": "backgroundOpacity", + "type": "integer" + }, + "Font": { + "shape": "Sx", + "locationName": "font" + }, + "FontColor": { + "locationName": "fontColor" + }, + "FontOpacity": { + "locationName": "fontOpacity", + "type": "integer" + }, + "FontResolution": { + "locationName": "fontResolution", + "type": "integer" + }, + "FontSize": { + "locationName": "fontSize" + }, + "OutlineColor": { + "locationName": "outlineColor" + }, + "OutlineSize": { + "locationName": "outlineSize", + "type": "integer" + }, + "ShadowColor": { + "locationName": "shadowColor" + }, + "ShadowOpacity": { + "locationName": "shadowOpacity", + "type": "integer" + }, + "ShadowXOffset": { + "locationName": "shadowXOffset", + "type": "integer" + }, + "ShadowYOffset": { + "locationName": "shadowYOffset", + "type": "integer" + }, + "TeletextGridControl": { + "locationName": "teletextGridControl" + }, + "XPosition": { + "locationName": "xPosition", + "type": "integer" + }, + "YPosition": { + "locationName": "yPosition", + "type": "integer" + } + } + }, + "EmbeddedDestinationSettings": { + "locationName": "embeddedDestinationSettings", + "type": "structure", + "members": {} + }, + "EmbeddedPlusScte20DestinationSettings": { + "locationName": "embeddedPlusScte20DestinationSettings", + "type": "structure", + "members": {} + }, + "RtmpCaptionInfoDestinationSettings": { + "locationName": "rtmpCaptionInfoDestinationSettings", + "type": "structure", + "members": {} + }, + "Scte20PlusEmbeddedDestinationSettings": { + "locationName": "scte20PlusEmbeddedDestinationSettings", + "type": "structure", + "members": {} + }, + "Scte27DestinationSettings": { + "locationName": "scte27DestinationSettings", + "type": "structure", + "members": {} + }, + "SmpteTtDestinationSettings": { + "locationName": "smpteTtDestinationSettings", + "type": "structure", + "members": {} + }, + "TeletextDestinationSettings": { + "locationName": "teletextDestinationSettings", + "type": "structure", + "members": {} + }, + "TtmlDestinationSettings": { + "locationName": "ttmlDestinationSettings", + "type": "structure", + "members": { + "StyleControl": { + "locationName": "styleControl" + } + } + }, + "WebvttDestinationSettings": { + "locationName": "webvttDestinationSettings", + "type": "structure", + "members": {} + } + } + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageDescription": { + "locationName": "languageDescription" + }, + "Name": { + "locationName": "name" + } + }, + "required": [ + "CaptionSelectorName", + "Name" + ] + } + }, + "GlobalConfiguration": { + "locationName": "globalConfiguration", + "type": "structure", + "members": { + "InitialAudioGain": { + "locationName": "initialAudioGain", + "type": "integer" + }, + "InputEndAction": { + "locationName": "inputEndAction" + }, + "InputLossBehavior": { + "locationName": "inputLossBehavior", + "type": "structure", + "members": { + "BlackFrameMsec": { + "locationName": "blackFrameMsec", + "type": "integer" + }, + "InputLossImageColor": { + "locationName": "inputLossImageColor" + }, + "InputLossImageSlate": { + "shape": "Sx", + "locationName": "inputLossImageSlate" + }, + "InputLossImageType": { + "locationName": "inputLossImageType" + }, + "RepeatFrameMsec": { + "locationName": "repeatFrameMsec", + "type": "integer" + } + } + }, + "OutputLockingMode": { + "locationName": "outputLockingMode" + }, + "OutputTimingSource": { + "locationName": "outputTimingSource" + }, + "SupportLowFramerateInputs": { + "locationName": "supportLowFramerateInputs" + } + } + }, + "OutputGroups": { + "locationName": "outputGroups", + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + }, + "OutputGroupSettings": { + "locationName": "outputGroupSettings", + "type": "structure", + "members": { + "ArchiveGroupSettings": { + "locationName": "archiveGroupSettings", + "type": "structure", + "members": { + "Destination": { + "shape": "S4r", + "locationName": "destination" + }, + "RolloverInterval": { + "locationName": "rolloverInterval", + "type": "integer" + } + }, + "required": [ + "Destination" + ] + }, + "FrameCaptureGroupSettings": { + "locationName": "frameCaptureGroupSettings", + "type": "structure", + "members": { + "Destination": { + "shape": "S4r", + "locationName": "destination" + } + }, + "required": [ + "Destination" + ] + }, + "HlsGroupSettings": { + "locationName": "hlsGroupSettings", + "type": "structure", + "members": { + "AdMarkers": { + "locationName": "adMarkers", + "type": "list", + "member": {} + }, + "BaseUrlContent": { + "locationName": "baseUrlContent" + }, + "BaseUrlManifest": { + "locationName": "baseUrlManifest" + }, + "CaptionLanguageMappings": { + "locationName": "captionLanguageMappings", + "type": "list", + "member": { + "type": "structure", + "members": { + "CaptionChannel": { + "locationName": "captionChannel", + "type": "integer" + }, + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageDescription": { + "locationName": "languageDescription" + } + }, + "required": [ + "LanguageCode", + "LanguageDescription", + "CaptionChannel" + ] + } + }, + "CaptionLanguageSetting": { + "locationName": "captionLanguageSetting" + }, + "ClientCache": { + "locationName": "clientCache" + }, + "CodecSpecification": { + "locationName": "codecSpecification" + }, + "ConstantIv": { + "locationName": "constantIv" + }, + "Destination": { + "shape": "S4r", + "locationName": "destination" + }, + "DirectoryStructure": { + "locationName": "directoryStructure" + }, + "EncryptionType": { + "locationName": "encryptionType" + }, + "HlsCdnSettings": { + "locationName": "hlsCdnSettings", + "type": "structure", + "members": { + "HlsAkamaiSettings": { + "locationName": "hlsAkamaiSettings", + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "locationName": "connectionRetryInterval", + "type": "integer" + }, + "FilecacheDuration": { + "locationName": "filecacheDuration", + "type": "integer" + }, + "HttpTransferMode": { + "locationName": "httpTransferMode" + }, + "NumRetries": { + "locationName": "numRetries", + "type": "integer" + }, + "RestartDelay": { + "locationName": "restartDelay", + "type": "integer" + }, + "Salt": { + "locationName": "salt" + }, + "Token": { + "locationName": "token" + } + } + }, + "HlsBasicPutSettings": { + "locationName": "hlsBasicPutSettings", + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "locationName": "connectionRetryInterval", + "type": "integer" + }, + "FilecacheDuration": { + "locationName": "filecacheDuration", + "type": "integer" + }, + "NumRetries": { + "locationName": "numRetries", + "type": "integer" + }, + "RestartDelay": { + "locationName": "restartDelay", + "type": "integer" + } + } + }, + "HlsMediaStoreSettings": { + "locationName": "hlsMediaStoreSettings", + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "locationName": "connectionRetryInterval", + "type": "integer" + }, + "FilecacheDuration": { + "locationName": "filecacheDuration", + "type": "integer" + }, + "MediaStoreStorageClass": { + "locationName": "mediaStoreStorageClass" + }, + "NumRetries": { + "locationName": "numRetries", + "type": "integer" + }, + "RestartDelay": { + "locationName": "restartDelay", + "type": "integer" + } + } + }, + "HlsWebdavSettings": { + "locationName": "hlsWebdavSettings", + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "locationName": "connectionRetryInterval", + "type": "integer" + }, + "FilecacheDuration": { + "locationName": "filecacheDuration", + "type": "integer" + }, + "HttpTransferMode": { + "locationName": "httpTransferMode" + }, + "NumRetries": { + "locationName": "numRetries", + "type": "integer" + }, + "RestartDelay": { + "locationName": "restartDelay", + "type": "integer" + } + } + } + } + }, + "IFrameOnlyPlaylists": { + "locationName": "iFrameOnlyPlaylists" + }, + "IndexNSegments": { + "locationName": "indexNSegments", + "type": "integer" + }, + "InputLossAction": { + "locationName": "inputLossAction" + }, + "IvInManifest": { + "locationName": "ivInManifest" + }, + "IvSource": { + "locationName": "ivSource" + }, + "KeepSegments": { + "locationName": "keepSegments", + "type": "integer" + }, + "KeyFormat": { + "locationName": "keyFormat" + }, + "KeyFormatVersions": { + "locationName": "keyFormatVersions" + }, + "KeyProviderSettings": { + "locationName": "keyProviderSettings", + "type": "structure", + "members": { + "StaticKeySettings": { + "locationName": "staticKeySettings", + "type": "structure", + "members": { + "KeyProviderServer": { + "shape": "Sx", + "locationName": "keyProviderServer" + }, + "StaticKeyValue": { + "locationName": "staticKeyValue" + } + }, + "required": [ + "StaticKeyValue" + ] + } + } + }, + "ManifestCompression": { + "locationName": "manifestCompression" + }, + "ManifestDurationFormat": { + "locationName": "manifestDurationFormat" + }, + "MinSegmentLength": { + "locationName": "minSegmentLength", + "type": "integer" + }, + "Mode": { + "locationName": "mode" + }, + "OutputSelection": { + "locationName": "outputSelection" + }, + "ProgramDateTime": { + "locationName": "programDateTime" + }, + "ProgramDateTimePeriod": { + "locationName": "programDateTimePeriod", + "type": "integer" + }, + "RedundantManifest": { + "locationName": "redundantManifest" + }, + "SegmentLength": { + "locationName": "segmentLength", + "type": "integer" + }, + "SegmentationMode": { + "locationName": "segmentationMode" + }, + "SegmentsPerSubdirectory": { + "locationName": "segmentsPerSubdirectory", + "type": "integer" + }, + "StreamInfResolution": { + "locationName": "streamInfResolution" + }, + "TimedMetadataId3Frame": { + "locationName": "timedMetadataId3Frame" + }, + "TimedMetadataId3Period": { + "locationName": "timedMetadataId3Period", + "type": "integer" + }, + "TimestampDeltaMilliseconds": { + "locationName": "timestampDeltaMilliseconds", + "type": "integer" + }, + "TsFileMode": { + "locationName": "tsFileMode" + } + }, + "required": [ + "Destination" + ] + }, + "MediaPackageGroupSettings": { + "locationName": "mediaPackageGroupSettings", + "type": "structure", + "members": { + "Destination": { + "shape": "S4r", + "locationName": "destination" + } + }, + "required": [ + "Destination" + ] + }, + "MsSmoothGroupSettings": { + "locationName": "msSmoothGroupSettings", + "type": "structure", + "members": { + "AcquisitionPointId": { + "locationName": "acquisitionPointId" + }, + "AudioOnlyTimecodeControl": { + "locationName": "audioOnlyTimecodeControl" + }, + "CertificateMode": { + "locationName": "certificateMode" + }, + "ConnectionRetryInterval": { + "locationName": "connectionRetryInterval", + "type": "integer" + }, + "Destination": { + "shape": "S4r", + "locationName": "destination" + }, + "EventId": { + "locationName": "eventId" + }, + "EventIdMode": { + "locationName": "eventIdMode" + }, + "EventStopBehavior": { + "locationName": "eventStopBehavior" + }, + "FilecacheDuration": { + "locationName": "filecacheDuration", + "type": "integer" + }, + "FragmentLength": { + "locationName": "fragmentLength", + "type": "integer" + }, + "InputLossAction": { + "locationName": "inputLossAction" + }, + "NumRetries": { + "locationName": "numRetries", + "type": "integer" + }, + "RestartDelay": { + "locationName": "restartDelay", + "type": "integer" + }, + "SegmentationMode": { + "locationName": "segmentationMode" + }, + "SendDelayMs": { + "locationName": "sendDelayMs", + "type": "integer" + }, + "SparseTrackType": { + "locationName": "sparseTrackType" + }, + "StreamManifestBehavior": { + "locationName": "streamManifestBehavior" + }, + "TimestampOffset": { + "locationName": "timestampOffset" + }, + "TimestampOffsetMode": { + "locationName": "timestampOffsetMode" + } + }, + "required": [ + "Destination" + ] + }, + "RtmpGroupSettings": { + "locationName": "rtmpGroupSettings", + "type": "structure", + "members": { + "AuthenticationScheme": { + "locationName": "authenticationScheme" + }, + "CacheFullBehavior": { + "locationName": "cacheFullBehavior" + }, + "CacheLength": { + "locationName": "cacheLength", + "type": "integer" + }, + "CaptionData": { + "locationName": "captionData" + }, + "InputLossAction": { + "locationName": "inputLossAction" + }, + "RestartDelay": { + "locationName": "restartDelay", + "type": "integer" + } + } + }, + "UdpGroupSettings": { + "locationName": "udpGroupSettings", + "type": "structure", + "members": { + "InputLossAction": { + "locationName": "inputLossAction" + }, + "TimedMetadataId3Frame": { + "locationName": "timedMetadataId3Frame" + }, + "TimedMetadataId3Period": { + "locationName": "timedMetadataId3Period", + "type": "integer" + } + } + } + } + }, + "Outputs": { + "locationName": "outputs", + "type": "list", + "member": { + "type": "structure", + "members": { + "AudioDescriptionNames": { + "shape": "S16", + "locationName": "audioDescriptionNames" + }, + "CaptionDescriptionNames": { + "shape": "S16", + "locationName": "captionDescriptionNames" + }, + "OutputName": { + "locationName": "outputName" + }, + "OutputSettings": { + "locationName": "outputSettings", + "type": "structure", + "members": { + "ArchiveOutputSettings": { + "locationName": "archiveOutputSettings", + "type": "structure", + "members": { + "ContainerSettings": { + "locationName": "containerSettings", + "type": "structure", + "members": { + "M2tsSettings": { + "shape": "S6n", + "locationName": "m2tsSettings" + } + } + }, + "Extension": { + "locationName": "extension" + }, + "NameModifier": { + "locationName": "nameModifier" + } + }, + "required": [ + "ContainerSettings" + ] + }, + "FrameCaptureOutputSettings": { + "locationName": "frameCaptureOutputSettings", + "type": "structure", + "members": { + "NameModifier": { + "locationName": "nameModifier" + } + } + }, + "HlsOutputSettings": { + "locationName": "hlsOutputSettings", + "type": "structure", + "members": { + "HlsSettings": { + "locationName": "hlsSettings", + "type": "structure", + "members": { + "AudioOnlyHlsSettings": { + "locationName": "audioOnlyHlsSettings", + "type": "structure", + "members": { + "AudioGroupId": { + "locationName": "audioGroupId" + }, + "AudioOnlyImage": { + "shape": "Sx", + "locationName": "audioOnlyImage" + }, + "AudioTrackType": { + "locationName": "audioTrackType" + } + } + }, + "StandardHlsSettings": { + "locationName": "standardHlsSettings", + "type": "structure", + "members": { + "AudioRenditionSets": { + "locationName": "audioRenditionSets" + }, + "M3u8Settings": { + "locationName": "m3u8Settings", + "type": "structure", + "members": { + "AudioFramesPerPes": { + "locationName": "audioFramesPerPes", + "type": "integer" + }, + "AudioPids": { + "locationName": "audioPids" + }, + "EcmPid": { + "locationName": "ecmPid" + }, + "PatInterval": { + "locationName": "patInterval", + "type": "integer" + }, + "PcrControl": { + "locationName": "pcrControl" + }, + "PcrPeriod": { + "locationName": "pcrPeriod", + "type": "integer" + }, + "PcrPid": { + "locationName": "pcrPid" + }, + "PmtInterval": { + "locationName": "pmtInterval", + "type": "integer" + }, + "PmtPid": { + "locationName": "pmtPid" + }, + "ProgramNum": { + "locationName": "programNum", + "type": "integer" + }, + "Scte35Behavior": { + "locationName": "scte35Behavior" + }, + "Scte35Pid": { + "locationName": "scte35Pid" + }, + "TimedMetadataBehavior": { + "locationName": "timedMetadataBehavior" + }, + "TimedMetadataPid": { + "locationName": "timedMetadataPid" + }, + "TransportStreamId": { + "locationName": "transportStreamId", + "type": "integer" + }, + "VideoPid": { + "locationName": "videoPid" + } + } + } + }, + "required": [ + "M3u8Settings" + ] + } + } + }, + "NameModifier": { + "locationName": "nameModifier" + }, + "SegmentModifier": { + "locationName": "segmentModifier" + } + }, + "required": [ + "HlsSettings" + ] + }, + "MediaPackageOutputSettings": { + "locationName": "mediaPackageOutputSettings", + "type": "structure", + "members": {} + }, + "MsSmoothOutputSettings": { + "locationName": "msSmoothOutputSettings", + "type": "structure", + "members": { + "NameModifier": { + "locationName": "nameModifier" + } + } + }, + "RtmpOutputSettings": { + "locationName": "rtmpOutputSettings", + "type": "structure", + "members": { + "CertificateMode": { + "locationName": "certificateMode" + }, + "ConnectionRetryInterval": { + "locationName": "connectionRetryInterval", + "type": "integer" + }, + "Destination": { + "shape": "S4r", + "locationName": "destination" + }, + "NumRetries": { + "locationName": "numRetries", + "type": "integer" + } + }, + "required": [ + "Destination" + ] + }, + "UdpOutputSettings": { + "locationName": "udpOutputSettings", + "type": "structure", + "members": { + "BufferMsec": { + "locationName": "bufferMsec", + "type": "integer" + }, + "ContainerSettings": { + "locationName": "containerSettings", + "type": "structure", + "members": { + "M2tsSettings": { + "shape": "S6n", + "locationName": "m2tsSettings" + } + } + }, + "Destination": { + "shape": "S4r", + "locationName": "destination" + }, + "FecOutputSettings": { + "locationName": "fecOutputSettings", + "type": "structure", + "members": { + "ColumnDepth": { + "locationName": "columnDepth", + "type": "integer" + }, + "IncludeFec": { + "locationName": "includeFec" + }, + "RowLength": { + "locationName": "rowLength", + "type": "integer" + } + } + } + }, + "required": [ + "Destination", + "ContainerSettings" + ] + } + } + }, + "VideoDescriptionName": { + "locationName": "videoDescriptionName" + } + }, + "required": [ + "OutputSettings" + ] + } + } + }, + "required": [ + "Outputs", + "OutputGroupSettings" + ] + } + }, + "TimecodeConfig": { + "locationName": "timecodeConfig", + "type": "structure", + "members": { + "Source": { + "locationName": "source" + }, + "SyncThreshold": { + "locationName": "syncThreshold", + "type": "integer" + } + }, + "required": [ + "Source" + ] + }, + "VideoDescriptions": { + "locationName": "videoDescriptions", + "type": "list", + "member": { + "type": "structure", + "members": { + "CodecSettings": { + "locationName": "codecSettings", + "type": "structure", + "members": { + "FrameCaptureSettings": { + "locationName": "frameCaptureSettings", + "type": "structure", + "members": { + "CaptureInterval": { + "locationName": "captureInterval", + "type": "integer" + } + }, + "required": [ + "CaptureInterval" + ] + }, + "H264Settings": { + "locationName": "h264Settings", + "type": "structure", + "members": { + "AdaptiveQuantization": { + "locationName": "adaptiveQuantization" + }, + "AfdSignaling": { + "locationName": "afdSignaling" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "BufFillPct": { + "locationName": "bufFillPct", + "type": "integer" + }, + "BufSize": { + "locationName": "bufSize", + "type": "integer" + }, + "ColorMetadata": { + "locationName": "colorMetadata" + }, + "EntropyEncoding": { + "locationName": "entropyEncoding" + }, + "FixedAfd": { + "locationName": "fixedAfd" + }, + "FlickerAq": { + "locationName": "flickerAq" + }, + "FramerateControl": { + "locationName": "framerateControl" + }, + "FramerateDenominator": { + "locationName": "framerateDenominator", + "type": "integer" + }, + "FramerateNumerator": { + "locationName": "framerateNumerator", + "type": "integer" + }, + "GopBReference": { + "locationName": "gopBReference" + }, + "GopClosedCadence": { + "locationName": "gopClosedCadence", + "type": "integer" + }, + "GopNumBFrames": { + "locationName": "gopNumBFrames", + "type": "integer" + }, + "GopSize": { + "locationName": "gopSize", + "type": "double" + }, + "GopSizeUnits": { + "locationName": "gopSizeUnits" + }, + "Level": { + "locationName": "level" + }, + "LookAheadRateControl": { + "locationName": "lookAheadRateControl" + }, + "MaxBitrate": { + "locationName": "maxBitrate", + "type": "integer" + }, + "MinIInterval": { + "locationName": "minIInterval", + "type": "integer" + }, + "NumRefFrames": { + "locationName": "numRefFrames", + "type": "integer" + }, + "ParControl": { + "locationName": "parControl" + }, + "ParDenominator": { + "locationName": "parDenominator", + "type": "integer" + }, + "ParNumerator": { + "locationName": "parNumerator", + "type": "integer" + }, + "Profile": { + "locationName": "profile" + }, + "QvbrQualityLevel": { + "locationName": "qvbrQualityLevel", + "type": "integer" + }, + "RateControlMode": { + "locationName": "rateControlMode" + }, + "ScanType": { + "locationName": "scanType" + }, + "SceneChangeDetect": { + "locationName": "sceneChangeDetect" + }, + "Slices": { + "locationName": "slices", + "type": "integer" + }, + "Softness": { + "locationName": "softness", + "type": "integer" + }, + "SpatialAq": { + "locationName": "spatialAq" + }, + "SubgopLength": { + "locationName": "subgopLength" + }, + "Syntax": { + "locationName": "syntax" + }, + "TemporalAq": { + "locationName": "temporalAq" + }, + "TimecodeInsertion": { + "locationName": "timecodeInsertion" + } + } + } + } + }, + "Height": { + "locationName": "height", + "type": "integer" + }, + "Name": { + "locationName": "name" + }, + "RespondToAfd": { + "locationName": "respondToAfd" + }, + "ScalingBehavior": { + "locationName": "scalingBehavior" + }, + "Sharpness": { + "locationName": "sharpness", + "type": "integer" + }, + "Width": { + "locationName": "width", + "type": "integer" + } + }, + "required": [ + "Name" + ] + } + } + }, + "required": [ + "VideoDescriptions", + "AudioDescriptions", + "OutputGroups", + "TimecodeConfig" + ] + }, + "S4r": { + "type": "structure", + "members": { + "DestinationRefId": { + "locationName": "destinationRefId" + } + } + }, + "S6n": { + "type": "structure", + "members": { + "AbsentInputAudioBehavior": { + "locationName": "absentInputAudioBehavior" + }, + "Arib": { + "locationName": "arib" + }, + "AribCaptionsPid": { + "locationName": "aribCaptionsPid" + }, + "AribCaptionsPidControl": { + "locationName": "aribCaptionsPidControl" + }, + "AudioBufferModel": { + "locationName": "audioBufferModel" + }, + "AudioFramesPerPes": { + "locationName": "audioFramesPerPes", + "type": "integer" + }, + "AudioPids": { + "locationName": "audioPids" + }, + "AudioStreamType": { + "locationName": "audioStreamType" + }, + "Bitrate": { + "locationName": "bitrate", + "type": "integer" + }, + "BufferModel": { + "locationName": "bufferModel" + }, + "CcDescriptor": { + "locationName": "ccDescriptor" + }, + "DvbNitSettings": { + "locationName": "dvbNitSettings", + "type": "structure", + "members": { + "NetworkId": { + "locationName": "networkId", + "type": "integer" + }, + "NetworkName": { + "locationName": "networkName" + }, + "RepInterval": { + "locationName": "repInterval", + "type": "integer" + } + }, + "required": [ + "NetworkName", + "NetworkId" + ] + }, + "DvbSdtSettings": { + "locationName": "dvbSdtSettings", + "type": "structure", + "members": { + "OutputSdt": { + "locationName": "outputSdt" + }, + "RepInterval": { + "locationName": "repInterval", + "type": "integer" + }, + "ServiceName": { + "locationName": "serviceName" + }, + "ServiceProviderName": { + "locationName": "serviceProviderName" + } + } + }, + "DvbSubPids": { + "locationName": "dvbSubPids" + }, + "DvbTdtSettings": { + "locationName": "dvbTdtSettings", + "type": "structure", + "members": { + "RepInterval": { + "locationName": "repInterval", + "type": "integer" + } + } + }, + "DvbTeletextPid": { + "locationName": "dvbTeletextPid" + }, + "Ebif": { + "locationName": "ebif" + }, + "EbpAudioInterval": { + "locationName": "ebpAudioInterval" + }, + "EbpLookaheadMs": { + "locationName": "ebpLookaheadMs", + "type": "integer" + }, + "EbpPlacement": { + "locationName": "ebpPlacement" + }, + "EcmPid": { + "locationName": "ecmPid" + }, + "EsRateInPes": { + "locationName": "esRateInPes" + }, + "EtvPlatformPid": { + "locationName": "etvPlatformPid" + }, + "EtvSignalPid": { + "locationName": "etvSignalPid" + }, + "FragmentTime": { + "locationName": "fragmentTime", + "type": "double" + }, + "Klv": { + "locationName": "klv" + }, + "KlvDataPids": { + "locationName": "klvDataPids" + }, + "NullPacketBitrate": { + "locationName": "nullPacketBitrate", + "type": "double" + }, + "PatInterval": { + "locationName": "patInterval", + "type": "integer" + }, + "PcrControl": { + "locationName": "pcrControl" + }, + "PcrPeriod": { + "locationName": "pcrPeriod", + "type": "integer" + }, + "PcrPid": { + "locationName": "pcrPid" + }, + "PmtInterval": { + "locationName": "pmtInterval", + "type": "integer" + }, + "PmtPid": { + "locationName": "pmtPid" + }, + "ProgramNum": { + "locationName": "programNum", + "type": "integer" + }, + "RateMode": { + "locationName": "rateMode" + }, + "Scte27Pids": { + "locationName": "scte27Pids" + }, + "Scte35Control": { + "locationName": "scte35Control" + }, + "Scte35Pid": { + "locationName": "scte35Pid" + }, + "SegmentationMarkers": { + "locationName": "segmentationMarkers" + }, + "SegmentationStyle": { + "locationName": "segmentationStyle" + }, + "SegmentationTime": { + "locationName": "segmentationTime", + "type": "double" + }, + "TimedMetadataBehavior": { + "locationName": "timedMetadataBehavior" + }, + "TimedMetadataPid": { + "locationName": "timedMetadataPid" + }, + "TransportStreamId": { + "locationName": "transportStreamId", + "type": "integer" + }, + "VideoPid": { + "locationName": "videoPid" + } + } + }, + "S96": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InputAttachmentName": { + "locationName": "inputAttachmentName" + }, + "InputId": { + "locationName": "inputId" + }, + "InputSettings": { + "locationName": "inputSettings", + "type": "structure", + "members": { + "AudioSelectors": { + "locationName": "audioSelectors", + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + }, + "SelectorSettings": { + "locationName": "selectorSettings", + "type": "structure", + "members": { + "AudioLanguageSelection": { + "locationName": "audioLanguageSelection", + "type": "structure", + "members": { + "LanguageCode": { + "locationName": "languageCode" + }, + "LanguageSelectionPolicy": { + "locationName": "languageSelectionPolicy" + } + }, + "required": [ + "LanguageCode" + ] + }, + "AudioPidSelection": { + "locationName": "audioPidSelection", + "type": "structure", + "members": { + "Pid": { + "locationName": "pid", + "type": "integer" + } + }, + "required": [ + "Pid" + ] + } + } + } + }, + "required": [ + "Name" + ] + } + }, + "CaptionSelectors": { + "locationName": "captionSelectors", + "type": "list", + "member": { + "type": "structure", + "members": { + "LanguageCode": { + "locationName": "languageCode" + }, + "Name": { + "locationName": "name" + }, + "SelectorSettings": { + "locationName": "selectorSettings", + "type": "structure", + "members": { + "AribSourceSettings": { + "locationName": "aribSourceSettings", + "type": "structure", + "members": {} + }, + "DvbSubSourceSettings": { + "locationName": "dvbSubSourceSettings", + "type": "structure", + "members": { + "Pid": { + "locationName": "pid", + "type": "integer" + } + } + }, + "EmbeddedSourceSettings": { + "locationName": "embeddedSourceSettings", + "type": "structure", + "members": { + "Convert608To708": { + "locationName": "convert608To708" + }, + "Scte20Detection": { + "locationName": "scte20Detection" + }, + "Source608ChannelNumber": { + "locationName": "source608ChannelNumber", + "type": "integer" + }, + "Source608TrackNumber": { + "locationName": "source608TrackNumber", + "type": "integer" + } + } + }, + "Scte20SourceSettings": { + "locationName": "scte20SourceSettings", + "type": "structure", + "members": { + "Convert608To708": { + "locationName": "convert608To708" + }, + "Source608ChannelNumber": { + "locationName": "source608ChannelNumber", + "type": "integer" + } + } + }, + "Scte27SourceSettings": { + "locationName": "scte27SourceSettings", + "type": "structure", + "members": { + "Pid": { + "locationName": "pid", + "type": "integer" + } + } + }, + "TeletextSourceSettings": { + "locationName": "teletextSourceSettings", + "type": "structure", + "members": { + "PageNumber": { + "locationName": "pageNumber" + } + } + } + } + } + }, + "required": [ + "Name" + ] + } + }, + "DeblockFilter": { + "locationName": "deblockFilter" + }, + "DenoiseFilter": { + "locationName": "denoiseFilter" + }, + "FilterStrength": { + "locationName": "filterStrength", + "type": "integer" + }, + "InputFilter": { + "locationName": "inputFilter" + }, + "NetworkInputSettings": { + "locationName": "networkInputSettings", + "type": "structure", + "members": { + "HlsInputSettings": { + "locationName": "hlsInputSettings", + "type": "structure", + "members": { + "Bandwidth": { + "locationName": "bandwidth", + "type": "integer" + }, + "BufferSegments": { + "locationName": "bufferSegments", + "type": "integer" + }, + "Retries": { + "locationName": "retries", + "type": "integer" + }, + "RetryInterval": { + "locationName": "retryInterval", + "type": "integer" + } + } + }, + "ServerValidation": { + "locationName": "serverValidation" + } + } + }, + "SourceEndBehavior": { + "locationName": "sourceEndBehavior" + }, + "VideoSelector": { + "locationName": "videoSelector", + "type": "structure", + "members": { + "ColorSpace": { + "locationName": "colorSpace" + }, + "ColorSpaceUsage": { + "locationName": "colorSpaceUsage" + }, + "SelectorSettings": { + "locationName": "selectorSettings", + "type": "structure", + "members": { + "VideoSelectorPid": { + "locationName": "videoSelectorPid", + "type": "structure", + "members": { + "Pid": { + "locationName": "pid", + "type": "integer" + } + } + }, + "VideoSelectorProgramId": { + "locationName": "videoSelectorProgramId", + "type": "structure", + "members": { + "ProgramId": { + "locationName": "programId", + "type": "integer" + } + } + } + } + } + } + } + } + } + } + } + }, + "Sa6": { + "type": "structure", + "members": { + "Codec": { + "locationName": "codec" + }, + "MaximumBitrate": { + "locationName": "maximumBitrate" + }, + "Resolution": { + "locationName": "resolution" + } + } + }, + "Sab": { + "type": "map", + "key": {}, + "value": {} + }, + "Sad": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelClass": { + "locationName": "channelClass" + }, + "Destinations": { + "shape": "S1c", + "locationName": "destinations" + }, + "EgressEndpoints": { + "shape": "Sae", + "locationName": "egressEndpoints" + }, + "EncoderSettings": { + "shape": "S1j", + "locationName": "encoderSettings" + }, + "Id": { + "locationName": "id" + }, + "InputAttachments": { + "shape": "S96", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "Sa6", + "locationName": "inputSpecification" + }, + "LogLevel": { + "locationName": "logLevel" + }, + "Name": { + "locationName": "name" + }, + "PipelinesRunningCount": { + "locationName": "pipelinesRunningCount", + "type": "integer" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + } + } + }, + "Sae": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceIp": { + "locationName": "sourceIp" + } + } + } + }, + "Sai": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StreamName": { + "locationName": "streamName" + } + } + } + }, + "Sak": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + } + } + } + }, + "Sam": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PasswordParam": { + "locationName": "passwordParam" + }, + "Url": { + "locationName": "url" + }, + "Username": { + "locationName": "username" + } + } + } + }, + "Sar": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "AttachedChannels": { + "shape": "S16", + "locationName": "attachedChannels" + }, + "Destinations": { + "shape": "Sas", + "locationName": "destinations" + }, + "Id": { + "locationName": "id" + }, + "InputClass": { + "locationName": "inputClass" + }, + "MediaConnectFlows": { + "shape": "Saw", + "locationName": "mediaConnectFlows" + }, + "Name": { + "locationName": "name" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "SecurityGroups": { + "shape": "S16", + "locationName": "securityGroups" + }, + "Sources": { + "shape": "Say", + "locationName": "sources" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "Type": { + "locationName": "type" + } + } + }, + "Sas": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Ip": { + "locationName": "ip" + }, + "Port": { + "locationName": "port" + }, + "Url": { + "locationName": "url" + }, + "Vpc": { + "locationName": "vpc", + "type": "structure", + "members": { + "AvailabilityZone": { + "locationName": "availabilityZone" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + } + } + } + } + } + }, + "Saw": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FlowArn": { + "locationName": "flowArn" + } + } + } + }, + "Say": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PasswordParam": { + "locationName": "passwordParam" + }, + "Url": { + "locationName": "url" + }, + "Username": { + "locationName": "username" + } + } + } + }, + "Sb2": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Cidr": { + "locationName": "cidr" + } + } + } + }, + "Sb5": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Id": { + "locationName": "id" + }, + "Inputs": { + "shape": "S16", + "locationName": "inputs" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "WhitelistRules": { + "shape": "Sb7", + "locationName": "whitelistRules" + } + } + }, + "Sb7": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Cidr": { + "locationName": "cidr" + } + } + } + }, + "Sbk": { + "type": "structure", + "members": { + "ChannelClass": { + "locationName": "channelClass" + }, + "Codec": { + "locationName": "codec" + }, + "MaximumBitrate": { + "locationName": "maximumBitrate" + }, + "MaximumFramerate": { + "locationName": "maximumFramerate" + }, + "Resolution": { + "locationName": "resolution" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "SpecialFeature": { + "locationName": "specialFeature" + }, + "VideoQuality": { + "locationName": "videoQuality" + } + } + }, + "Scq": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Count": { + "locationName": "count", + "type": "integer" + }, + "CurrencyCode": { + "locationName": "currencyCode" + }, + "Duration": { + "locationName": "duration", + "type": "integer" + }, + "DurationUnits": { + "locationName": "durationUnits" + }, + "End": { + "locationName": "end" + }, + "FixedPrice": { + "locationName": "fixedPrice", + "type": "double" + }, + "Name": { + "locationName": "name" + }, + "OfferingDescription": { + "locationName": "offeringDescription" + }, + "OfferingId": { + "locationName": "offeringId" + }, + "OfferingType": { + "locationName": "offeringType" + }, + "Region": { + "locationName": "region" + }, + "ReservationId": { + "locationName": "reservationId" + }, + "ResourceSpecification": { + "shape": "Sbk", + "locationName": "resourceSpecification" + }, + "Start": { + "locationName": "start" + }, + "State": { + "locationName": "state" + }, + "Tags": { + "shape": "Sab", + "locationName": "tags" + }, + "UsagePrice": { + "locationName": "usagePrice", + "type": "double" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/medialive-2017-10-14.paginators.json b/node_modules/aws-sdk/apis/medialive-2017-10-14.paginators.json new file mode 100644 index 0000000..8613491 --- /dev/null +++ b/node_modules/aws-sdk/apis/medialive-2017-10-14.paginators.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "DescribeSchedule": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListChannels": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListInputSecurityGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListInputs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListReservations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/mediapackage-2017-10-12.min.json b/node_modules/aws-sdk/apis/mediapackage-2017-10-12.min.json new file mode 100644 index 0000000..353bd71 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediapackage-2017-10-12.min.json @@ -0,0 +1,1171 @@ +{ + "metadata": { + "apiVersion": "2017-10-12", + "endpointPrefix": "mediapackage", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "MediaPackage", + "serviceFullName": "AWS Elemental MediaPackage", + "serviceId": "MediaPackage", + "signatureVersion": "v4", + "signingName": "mediapackage", + "uid": "mediapackage-2017-10-12" + }, + "operations": { + "CreateChannel": { + "http": { + "requestUri": "/channels", + "responseCode": 200 + }, + "input": { + "members": { + "Description": { + "locationName": "description" + }, + "Id": { + "locationName": "id" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "members": { + "Arn": { + "locationName": "arn" + }, + "Description": { + "locationName": "description" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "S5" + }, + "Id": { + "locationName": "id" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + } + }, + "type": "structure" + } + }, + "CreateOriginEndpoint": { + "http": { + "requestUri": "/origin_endpoints", + "responseCode": 200 + }, + "input": { + "members": { + "ChannelId": { + "locationName": "channelId" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "S9" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "Sl" + }, + "Description": { + "locationName": "description" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "Ss" + }, + "Id": { + "locationName": "id" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "Sv" + }, + "StartoverWindowSeconds": { + "locationName": "startoverWindowSeconds", + "type": "integer" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + }, + "TimeDelaySeconds": { + "locationName": "timeDelaySeconds", + "type": "integer" + }, + "Whitelist": { + "locationName": "whitelist", + "shape": "Sd" + } + }, + "required": [ + "ChannelId", + "Id" + ], + "type": "structure" + }, + "output": { + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelId": { + "locationName": "channelId" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "Sy" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "Sl" + }, + "Description": { + "locationName": "description" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "Ss" + }, + "Id": { + "locationName": "id" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "Sv" + }, + "StartoverWindowSeconds": { + "locationName": "startoverWindowSeconds", + "type": "integer" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + }, + "TimeDelaySeconds": { + "locationName": "timeDelaySeconds", + "type": "integer" + }, + "Url": { + "locationName": "url" + }, + "Whitelist": { + "locationName": "whitelist", + "shape": "Sd" + } + }, + "type": "structure" + } + }, + "DeleteChannel": { + "http": { + "method": "DELETE", + "requestUri": "/channels/{id}", + "responseCode": 202 + }, + "input": { + "members": { + "Id": { + "location": "uri", + "locationName": "id" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "members": {}, + "type": "structure" + } + }, + "DeleteOriginEndpoint": { + "http": { + "method": "DELETE", + "requestUri": "/origin_endpoints/{id}", + "responseCode": 202 + }, + "input": { + "members": { + "Id": { + "location": "uri", + "locationName": "id" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "members": {}, + "type": "structure" + } + }, + "DescribeChannel": { + "http": { + "method": "GET", + "requestUri": "/channels/{id}", + "responseCode": 200 + }, + "input": { + "members": { + "Id": { + "location": "uri", + "locationName": "id" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "members": { + "Arn": { + "locationName": "arn" + }, + "Description": { + "locationName": "description" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "S5" + }, + "Id": { + "locationName": "id" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + } + }, + "type": "structure" + } + }, + "DescribeOriginEndpoint": { + "http": { + "method": "GET", + "requestUri": "/origin_endpoints/{id}", + "responseCode": 200 + }, + "input": { + "members": { + "Id": { + "location": "uri", + "locationName": "id" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelId": { + "locationName": "channelId" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "Sy" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "Sl" + }, + "Description": { + "locationName": "description" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "Ss" + }, + "Id": { + "locationName": "id" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "Sv" + }, + "StartoverWindowSeconds": { + "locationName": "startoverWindowSeconds", + "type": "integer" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + }, + "TimeDelaySeconds": { + "locationName": "timeDelaySeconds", + "type": "integer" + }, + "Url": { + "locationName": "url" + }, + "Whitelist": { + "locationName": "whitelist", + "shape": "Sd" + } + }, + "type": "structure" + } + }, + "ListChannels": { + "http": { + "method": "GET", + "requestUri": "/channels", + "responseCode": 200 + }, + "input": { + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "type": "structure" + }, + "output": { + "members": { + "Channels": { + "locationName": "channels", + "member": { + "members": { + "Arn": { + "locationName": "arn" + }, + "Description": { + "locationName": "description" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "S5" + }, + "Id": { + "locationName": "id" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + } + }, + "type": "structure" + }, + "type": "list" + }, + "NextToken": { + "locationName": "nextToken" + } + }, + "type": "structure" + } + }, + "ListOriginEndpoints": { + "http": { + "method": "GET", + "requestUri": "/origin_endpoints", + "responseCode": 200 + }, + "input": { + "members": { + "ChannelId": { + "location": "querystring", + "locationName": "channelId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "type": "structure" + }, + "output": { + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "OriginEndpoints": { + "locationName": "originEndpoints", + "member": { + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelId": { + "locationName": "channelId" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "Sy" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "Sl" + }, + "Description": { + "locationName": "description" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "Ss" + }, + "Id": { + "locationName": "id" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "Sv" + }, + "StartoverWindowSeconds": { + "locationName": "startoverWindowSeconds", + "type": "integer" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + }, + "TimeDelaySeconds": { + "locationName": "timeDelaySeconds", + "type": "integer" + }, + "Url": { + "locationName": "url" + }, + "Whitelist": { + "locationName": "whitelist", + "shape": "Sd" + } + }, + "type": "structure" + }, + "type": "list" + } + }, + "type": "structure" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ], + "type": "structure" + }, + "output": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "S1k" + } + }, + "type": "structure" + } + }, + "RotateChannelCredentials": { + "deprecated": true, + "deprecatedMessage": "This API is deprecated. Please use RotateIngestEndpointCredentials instead", + "http": { + "method": "PUT", + "requestUri": "/channels/{id}/credentials", + "responseCode": 200 + }, + "input": { + "deprecated": true, + "members": { + "Id": { + "location": "uri", + "locationName": "id" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "deprecated": true, + "members": { + "Arn": { + "locationName": "arn" + }, + "Description": { + "locationName": "description" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "S5" + }, + "Id": { + "locationName": "id" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + } + }, + "type": "structure" + } + }, + "RotateIngestEndpointCredentials": { + "http": { + "method": "PUT", + "requestUri": "/channels/{id}/ingest_endpoints/{ingest_endpoint_id}/credentials", + "responseCode": 200 + }, + "input": { + "members": { + "Id": { + "location": "uri", + "locationName": "id" + }, + "IngestEndpointId": { + "location": "uri", + "locationName": "ingest_endpoint_id" + } + }, + "required": [ + "IngestEndpointId", + "Id" + ], + "type": "structure" + }, + "output": { + "members": { + "Arn": { + "locationName": "arn" + }, + "Description": { + "locationName": "description" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "S5" + }, + "Id": { + "locationName": "id" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + } + }, + "type": "structure" + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "Tags": { + "locationName": "tags", + "shape": "S1k" + } + }, + "required": [ + "ResourceArn", + "Tags" + ], + "type": "structure" + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "shape": "Sd" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ], + "type": "structure" + } + }, + "UpdateChannel": { + "http": { + "method": "PUT", + "requestUri": "/channels/{id}", + "responseCode": 200 + }, + "input": { + "members": { + "Description": { + "locationName": "description" + }, + "Id": { + "location": "uri", + "locationName": "id" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "members": { + "Arn": { + "locationName": "arn" + }, + "Description": { + "locationName": "description" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "S5" + }, + "Id": { + "locationName": "id" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + } + }, + "type": "structure" + } + }, + "UpdateOriginEndpoint": { + "http": { + "method": "PUT", + "requestUri": "/origin_endpoints/{id}", + "responseCode": 200 + }, + "input": { + "members": { + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "S9" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "Sl" + }, + "Description": { + "locationName": "description" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "Ss" + }, + "Id": { + "location": "uri", + "locationName": "id" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "Sv" + }, + "StartoverWindowSeconds": { + "locationName": "startoverWindowSeconds", + "type": "integer" + }, + "TimeDelaySeconds": { + "locationName": "timeDelaySeconds", + "type": "integer" + }, + "Whitelist": { + "locationName": "whitelist", + "shape": "Sd" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "output": { + "members": { + "Arn": { + "locationName": "arn" + }, + "ChannelId": { + "locationName": "channelId" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "Sy" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "Sl" + }, + "Description": { + "locationName": "description" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "Ss" + }, + "Id": { + "locationName": "id" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "Sv" + }, + "StartoverWindowSeconds": { + "locationName": "startoverWindowSeconds", + "type": "integer" + }, + "Tags": { + "locationName": "tags", + "shape": "S3" + }, + "TimeDelaySeconds": { + "locationName": "timeDelaySeconds", + "type": "integer" + }, + "Url": { + "locationName": "url" + }, + "Whitelist": { + "locationName": "whitelist", + "shape": "Sd" + } + }, + "type": "structure" + } + } + }, + "shapes": { + "S3": { + "key": {}, + "type": "map", + "value": {} + }, + "S5": { + "members": { + "IngestEndpoints": { + "locationName": "ingestEndpoints", + "member": { + "members": { + "Id": { + "locationName": "id" + }, + "Password": { + "locationName": "password" + }, + "Url": { + "locationName": "url" + }, + "Username": { + "locationName": "username" + } + }, + "type": "structure" + }, + "type": "list" + } + }, + "type": "structure" + }, + "S9": { + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "Sa" + }, + "HlsManifests": { + "locationName": "hlsManifests", + "member": { + "members": { + "AdMarkers": { + "locationName": "adMarkers" + }, + "Id": { + "locationName": "id" + }, + "IncludeIframeOnlyStream": { + "locationName": "includeIframeOnlyStream", + "type": "boolean" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "PlaylistType": { + "locationName": "playlistType" + }, + "PlaylistWindowSeconds": { + "locationName": "playlistWindowSeconds", + "type": "integer" + }, + "ProgramDateTimeIntervalSeconds": { + "locationName": "programDateTimeIntervalSeconds", + "type": "integer" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "type": "list" + }, + "SegmentDurationSeconds": { + "locationName": "segmentDurationSeconds", + "type": "integer" + }, + "SegmentPrefix": { + "locationName": "segmentPrefix" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "Sj" + } + }, + "type": "structure" + }, + "Sa": { + "members": { + "KeyRotationIntervalSeconds": { + "locationName": "keyRotationIntervalSeconds", + "type": "integer" + }, + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "Sc" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "Sc": { + "members": { + "CertificateArn": { + "locationName": "certificateArn" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "RoleArn": { + "locationName": "roleArn" + }, + "SystemIds": { + "locationName": "systemIds", + "shape": "Sd" + }, + "Url": { + "locationName": "url" + } + }, + "required": [ + "Url", + "ResourceId", + "RoleArn", + "SystemIds" + ], + "type": "structure" + }, + "Sd": { + "member": {}, + "type": "list" + }, + "Sj": { + "members": { + "MaxVideoBitsPerSecond": { + "locationName": "maxVideoBitsPerSecond", + "type": "integer" + }, + "MinVideoBitsPerSecond": { + "locationName": "minVideoBitsPerSecond", + "type": "integer" + }, + "StreamOrder": { + "locationName": "streamOrder" + } + }, + "type": "structure" + }, + "Sl": { + "members": { + "Encryption": { + "locationName": "encryption", + "members": { + "KeyRotationIntervalSeconds": { + "locationName": "keyRotationIntervalSeconds", + "type": "integer" + }, + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "Sc" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "ManifestLayout": { + "locationName": "manifestLayout" + }, + "ManifestWindowSeconds": { + "locationName": "manifestWindowSeconds", + "type": "integer" + }, + "MinBufferTimeSeconds": { + "locationName": "minBufferTimeSeconds", + "type": "integer" + }, + "MinUpdatePeriodSeconds": { + "locationName": "minUpdatePeriodSeconds", + "type": "integer" + }, + "PeriodTriggers": { + "locationName": "periodTriggers", + "member": {}, + "type": "list" + }, + "Profile": { + "locationName": "profile" + }, + "SegmentDurationSeconds": { + "locationName": "segmentDurationSeconds", + "type": "integer" + }, + "SegmentTemplateFormat": { + "locationName": "segmentTemplateFormat" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "Sj" + }, + "SuggestedPresentationDelaySeconds": { + "locationName": "suggestedPresentationDelaySeconds", + "type": "integer" + } + }, + "type": "structure" + }, + "Ss": { + "members": { + "AdMarkers": { + "locationName": "adMarkers" + }, + "Encryption": { + "locationName": "encryption", + "members": { + "ConstantInitializationVector": { + "locationName": "constantInitializationVector" + }, + "EncryptionMethod": { + "locationName": "encryptionMethod" + }, + "KeyRotationIntervalSeconds": { + "locationName": "keyRotationIntervalSeconds", + "type": "integer" + }, + "RepeatExtXKey": { + "locationName": "repeatExtXKey", + "type": "boolean" + }, + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "Sc" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "IncludeIframeOnlyStream": { + "locationName": "includeIframeOnlyStream", + "type": "boolean" + }, + "PlaylistType": { + "locationName": "playlistType" + }, + "PlaylistWindowSeconds": { + "locationName": "playlistWindowSeconds", + "type": "integer" + }, + "ProgramDateTimeIntervalSeconds": { + "locationName": "programDateTimeIntervalSeconds", + "type": "integer" + }, + "SegmentDurationSeconds": { + "locationName": "segmentDurationSeconds", + "type": "integer" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "Sj" + }, + "UseAudioRenditionGroup": { + "locationName": "useAudioRenditionGroup", + "type": "boolean" + } + }, + "type": "structure" + }, + "Sv": { + "members": { + "Encryption": { + "locationName": "encryption", + "members": { + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "Sc" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "ManifestWindowSeconds": { + "locationName": "manifestWindowSeconds", + "type": "integer" + }, + "SegmentDurationSeconds": { + "locationName": "segmentDurationSeconds", + "type": "integer" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "Sj" + } + }, + "type": "structure" + }, + "Sy": { + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "Sa" + }, + "HlsManifests": { + "locationName": "hlsManifests", + "member": { + "members": { + "AdMarkers": { + "locationName": "adMarkers" + }, + "Id": { + "locationName": "id" + }, + "IncludeIframeOnlyStream": { + "locationName": "includeIframeOnlyStream", + "type": "boolean" + }, + "ManifestName": { + "locationName": "manifestName" + }, + "PlaylistType": { + "locationName": "playlistType" + }, + "PlaylistWindowSeconds": { + "locationName": "playlistWindowSeconds", + "type": "integer" + }, + "ProgramDateTimeIntervalSeconds": { + "locationName": "programDateTimeIntervalSeconds", + "type": "integer" + }, + "Url": { + "locationName": "url" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "type": "list" + }, + "SegmentDurationSeconds": { + "locationName": "segmentDurationSeconds", + "type": "integer" + }, + "SegmentPrefix": { + "locationName": "segmentPrefix" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "Sj" + } + }, + "type": "structure" + }, + "S1k": { + "key": {}, + "type": "map", + "value": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mediapackage-2017-10-12.paginators.json b/node_modules/aws-sdk/apis/mediapackage-2017-10-12.paginators.json new file mode 100644 index 0000000..34eaef1 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediapackage-2017-10-12.paginators.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListChannels": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Channels" + }, + "ListOriginEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "OriginEndpoints" + } + } +} diff --git a/node_modules/aws-sdk/apis/mediastore-2017-09-01.examples.json b/node_modules/aws-sdk/apis/mediastore-2017-09-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/mediastore-2017-09-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/mediastore-2017-09-01.min.json b/node_modules/aws-sdk/apis/mediastore-2017-09-01.min.json new file mode 100644 index 0000000..ed92a44 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediastore-2017-09-01.min.json @@ -0,0 +1,335 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-09-01", + "endpointPrefix": "mediastore", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "MediaStore", + "serviceFullName": "AWS Elemental MediaStore", + "serviceId": "MediaStore", + "signatureVersion": "v4", + "signingName": "mediastore", + "targetPrefix": "MediaStore_20170901", + "uid": "mediastore-2017-09-01" + }, + "operations": { + "CreateContainer": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Container" + ], + "members": { + "Container": { + "shape": "S4" + } + } + } + }, + "DeleteContainer": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteContainerPolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteCorsPolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteLifecyclePolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeContainer": { + "input": { + "type": "structure", + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Container": { + "shape": "S4" + } + } + } + }, + "GetContainerPolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Policy" + ], + "members": { + "Policy": {} + } + } + }, + "GetCorsPolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "CorsPolicy" + ], + "members": { + "CorsPolicy": { + "shape": "Sp" + } + } + } + }, + "GetLifecyclePolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "LifecyclePolicy" + ], + "members": { + "LifecyclePolicy": {} + } + } + }, + "ListContainers": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Containers" + ], + "members": { + "Containers": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "NextToken": {} + } + } + }, + "PutContainerPolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName", + "Policy" + ], + "members": { + "ContainerName": {}, + "Policy": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutCorsPolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName", + "CorsPolicy" + ], + "members": { + "ContainerName": {}, + "CorsPolicy": { + "shape": "Sp" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutLifecyclePolicy": { + "input": { + "type": "structure", + "required": [ + "ContainerName", + "LifecyclePolicy" + ], + "members": { + "ContainerName": {}, + "LifecyclePolicy": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartAccessLogging": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopAccessLogging": { + "input": { + "type": "structure", + "required": [ + "ContainerName" + ], + "members": { + "ContainerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "Endpoint": {}, + "CreationTime": { + "type": "timestamp" + }, + "ARN": {}, + "Name": {}, + "Status": {}, + "AccessLoggingEnabled": { + "type": "boolean" + } + } + }, + "Sp": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AllowedOrigins", + "AllowedHeaders" + ], + "members": { + "AllowedOrigins": { + "type": "list", + "member": {} + }, + "AllowedMethods": { + "type": "list", + "member": {} + }, + "AllowedHeaders": { + "type": "list", + "member": {} + }, + "MaxAgeSeconds": { + "type": "integer" + }, + "ExposeHeaders": { + "type": "list", + "member": {} + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mediastore-2017-09-01.paginators.json b/node_modules/aws-sdk/apis/mediastore-2017-09-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediastore-2017-09-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.examples.json b/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.min.json b/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.min.json new file mode 100644 index 0000000..56bf0e8 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.min.json @@ -0,0 +1,244 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-09-01", + "endpointPrefix": "data.mediastore", + "protocol": "rest-json", + "serviceAbbreviation": "MediaStore Data", + "serviceFullName": "AWS Elemental MediaStore Data Plane", + "serviceId": "MediaStore Data", + "signatureVersion": "v4", + "signingName": "mediastore", + "uid": "mediastore-data-2017-09-01" + }, + "operations": { + "DeleteObject": { + "http": { + "method": "DELETE", + "requestUri": "/{Path+}" + }, + "input": { + "type": "structure", + "required": [ + "Path" + ], + "members": { + "Path": { + "location": "uri", + "locationName": "Path" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeObject": { + "http": { + "method": "HEAD", + "requestUri": "/{Path+}" + }, + "input": { + "type": "structure", + "required": [ + "Path" + ], + "members": { + "Path": { + "location": "uri", + "locationName": "Path" + } + } + }, + "output": { + "type": "structure", + "members": { + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "long" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "LastModified": { + "location": "header", + "locationName": "Last-Modified", + "type": "timestamp" + } + } + } + }, + "GetObject": { + "http": { + "method": "GET", + "requestUri": "/{Path+}" + }, + "input": { + "type": "structure", + "required": [ + "Path" + ], + "members": { + "Path": { + "location": "uri", + "locationName": "Path" + }, + "Range": { + "location": "header", + "locationName": "Range" + } + } + }, + "output": { + "type": "structure", + "required": [ + "StatusCode" + ], + "members": { + "Body": { + "shape": "Se" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentRange": { + "location": "header", + "locationName": "Content-Range" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "long" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "LastModified": { + "location": "header", + "locationName": "Last-Modified", + "type": "timestamp" + }, + "StatusCode": { + "location": "statusCode", + "type": "integer" + } + }, + "payload": "Body" + } + }, + "ListItems": { + "http": { + "method": "GET" + }, + "input": { + "type": "structure", + "members": { + "Path": { + "location": "querystring", + "locationName": "Path" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Type": {}, + "ETag": {}, + "LastModified": { + "type": "timestamp" + }, + "ContentType": {}, + "ContentLength": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + } + }, + "PutObject": { + "http": { + "method": "PUT", + "requestUri": "/{Path+}" + }, + "input": { + "type": "structure", + "required": [ + "Body", + "Path" + ], + "members": { + "Body": { + "shape": "Se" + }, + "Path": { + "location": "uri", + "locationName": "Path" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + } + }, + "payload": "Body" + }, + "output": { + "type": "structure", + "members": { + "ContentSHA256": {}, + "ETag": {}, + "StorageClass": {} + } + }, + "authtype": "v4-unsigned-body" + } + }, + "shapes": { + "Se": { + "type": "blob", + "streaming": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.paginators.json b/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediastore-data-2017-09-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/mediatailor-2018-04-23.min.json b/node_modules/aws-sdk/apis/mediatailor-2018-04-23.min.json new file mode 100644 index 0000000..c29bf88 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediatailor-2018-04-23.min.json @@ -0,0 +1,302 @@ +{ + "metadata": { + "apiVersion": "2018-04-23", + "endpointPrefix": "api.mediatailor", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "MediaTailor", + "serviceFullName": "AWS MediaTailor", + "serviceId": "MediaTailor", + "signatureVersion": "v4", + "signingName": "mediatailor", + "uid": "mediatailor-2018-04-23" + }, + "operations": { + "DeletePlaybackConfiguration": { + "http": { + "method": "DELETE", + "requestUri": "/playbackConfiguration/{Name}", + "responseCode": 204 + }, + "input": { + "members": { + "Name": { + "location": "uri", + "locationName": "Name" + } + }, + "required": [ + "Name" + ], + "type": "structure" + }, + "output": { + "members": {}, + "type": "structure" + } + }, + "GetPlaybackConfiguration": { + "http": { + "method": "GET", + "requestUri": "/playbackConfiguration/{Name}", + "responseCode": 200 + }, + "input": { + "members": { + "Name": { + "location": "uri", + "locationName": "Name" + } + }, + "required": [ + "Name" + ], + "type": "structure" + }, + "output": { + "members": { + "AdDecisionServerUrl": {}, + "CdnConfiguration": { + "shape": "S6" + }, + "DashConfiguration": { + "shape": "S7" + }, + "HlsConfiguration": { + "shape": "S9" + }, + "Name": {}, + "PlaybackConfigurationArn": {}, + "PlaybackEndpointPrefix": {}, + "SessionInitializationEndpointPrefix": {}, + "SlateAdUrl": {}, + "Tags": { + "locationName": "tags", + "shape": "Sa" + }, + "TranscodeProfileName": {}, + "VideoContentSourceUrl": {} + }, + "type": "structure" + } + }, + "ListPlaybackConfigurations": { + "http": { + "method": "GET", + "requestUri": "/playbackConfigurations", + "responseCode": 200 + }, + "input": { + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + }, + "type": "structure" + }, + "output": { + "members": { + "Items": { + "member": { + "members": { + "AdDecisionServerUrl": {}, + "CdnConfiguration": { + "shape": "S6" + }, + "DashConfiguration": { + "shape": "S7" + }, + "HlsConfiguration": { + "shape": "S9" + }, + "Name": {}, + "PlaybackConfigurationArn": {}, + "PlaybackEndpointPrefix": {}, + "SessionInitializationEndpointPrefix": {}, + "SlateAdUrl": {}, + "Tags": { + "locationName": "tags", + "shape": "Sa" + }, + "TranscodeProfileName": {}, + "VideoContentSourceUrl": {} + }, + "type": "structure" + }, + "type": "list" + }, + "NextToken": {} + }, + "type": "structure" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{ResourceArn}", + "responseCode": 200 + }, + "input": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "ResourceArn" + } + }, + "required": [ + "ResourceArn" + ], + "type": "structure" + }, + "output": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "Sa" + } + }, + "type": "structure" + } + }, + "PutPlaybackConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/playbackConfiguration", + "responseCode": 200 + }, + "input": { + "members": { + "AdDecisionServerUrl": {}, + "CdnConfiguration": { + "shape": "S6" + }, + "DashConfiguration": { + "members": { + "MpdLocation": {}, + "OriginManifestType": {} + }, + "type": "structure" + }, + "Name": {}, + "SlateAdUrl": {}, + "Tags": { + "locationName": "tags", + "shape": "Sa" + }, + "TranscodeProfileName": {}, + "VideoContentSourceUrl": {} + }, + "type": "structure" + }, + "output": { + "members": { + "AdDecisionServerUrl": {}, + "CdnConfiguration": { + "shape": "S6" + }, + "DashConfiguration": { + "shape": "S7" + }, + "HlsConfiguration": { + "shape": "S9" + }, + "Name": {}, + "PlaybackConfigurationArn": {}, + "PlaybackEndpointPrefix": {}, + "SessionInitializationEndpointPrefix": {}, + "SlateAdUrl": {}, + "Tags": { + "locationName": "tags", + "shape": "Sa" + }, + "TranscodeProfileName": {}, + "VideoContentSourceUrl": {} + }, + "type": "structure" + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{ResourceArn}", + "responseCode": 204 + }, + "input": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "ResourceArn" + }, + "Tags": { + "locationName": "tags", + "shape": "Sa" + } + }, + "required": [ + "ResourceArn", + "Tags" + ], + "type": "structure" + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{ResourceArn}", + "responseCode": 204 + }, + "input": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "ResourceArn" + }, + "TagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "member": {}, + "type": "list" + } + }, + "required": [ + "ResourceArn", + "TagKeys" + ], + "type": "structure" + } + } + }, + "shapes": { + "S6": { + "members": { + "AdSegmentUrlPrefix": {}, + "ContentSegmentUrlPrefix": {} + }, + "type": "structure" + }, + "S7": { + "members": { + "ManifestEndpointPrefix": {}, + "MpdLocation": {}, + "OriginManifestType": {} + }, + "type": "structure" + }, + "S9": { + "members": { + "ManifestEndpointPrefix": {} + }, + "type": "structure" + }, + "Sa": { + "key": {}, + "type": "map", + "value": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mediatailor-2018-04-23.paginators.json b/node_modules/aws-sdk/apis/mediatailor-2018-04-23.paginators.json new file mode 100644 index 0000000..f3b7195 --- /dev/null +++ b/node_modules/aws-sdk/apis/mediatailor-2018-04-23.paginators.json @@ -0,0 +1,3 @@ +{ + "pagination" : { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/metadata.json b/node_modules/aws-sdk/apis/metadata.json new file mode 100644 index 0000000..0d0fde7 --- /dev/null +++ b/node_modules/aws-sdk/apis/metadata.json @@ -0,0 +1,700 @@ +{ + "acm": { + "name": "ACM", + "cors": true + }, + "apigateway": { + "name": "APIGateway", + "cors": true + }, + "applicationautoscaling": { + "prefix": "application-autoscaling", + "name": "ApplicationAutoScaling", + "cors": true + }, + "appstream": { + "name": "AppStream" + }, + "autoscaling": { + "name": "AutoScaling", + "cors": true + }, + "batch": { + "name": "Batch" + }, + "budgets": { + "name": "Budgets" + }, + "clouddirectory": { + "name": "CloudDirectory", + "versions": [ + "2016-05-10*" + ] + }, + "cloudformation": { + "name": "CloudFormation", + "cors": true + }, + "cloudfront": { + "name": "CloudFront", + "versions": [ + "2013-05-12*", + "2013-11-11*", + "2014-05-31*", + "2014-10-21*", + "2014-11-06*", + "2015-04-17*", + "2015-07-27*", + "2015-09-17*", + "2016-01-13*", + "2016-01-28*", + "2016-08-01*", + "2016-08-20*", + "2016-09-07*", + "2016-09-29*", + "2016-11-25*", + "2017-03-25*", + "2017-10-30*", + "2018-06-18*" + ], + "cors": true + }, + "cloudhsm": { + "name": "CloudHSM", + "cors": true + }, + "cloudsearch": { + "name": "CloudSearch" + }, + "cloudsearchdomain": { + "name": "CloudSearchDomain" + }, + "cloudtrail": { + "name": "CloudTrail", + "cors": true + }, + "cloudwatch": { + "prefix": "monitoring", + "name": "CloudWatch", + "cors": true + }, + "cloudwatchevents": { + "prefix": "events", + "name": "CloudWatchEvents", + "versions": [ + "2014-02-03*" + ], + "cors": true + }, + "cloudwatchlogs": { + "prefix": "logs", + "name": "CloudWatchLogs", + "cors": true + }, + "codebuild": { + "name": "CodeBuild", + "cors": true + }, + "codecommit": { + "name": "CodeCommit", + "cors": true + }, + "codedeploy": { + "name": "CodeDeploy", + "cors": true + }, + "codepipeline": { + "name": "CodePipeline", + "cors": true + }, + "cognitoidentity": { + "prefix": "cognito-identity", + "name": "CognitoIdentity", + "cors": true + }, + "cognitoidentityserviceprovider": { + "prefix": "cognito-idp", + "name": "CognitoIdentityServiceProvider", + "cors": true + }, + "cognitosync": { + "prefix": "cognito-sync", + "name": "CognitoSync", + "cors": true + }, + "configservice": { + "prefix": "config", + "name": "ConfigService", + "cors": true + }, + "cur": { + "name": "CUR", + "cors": true + }, + "datapipeline": { + "name": "DataPipeline" + }, + "devicefarm": { + "name": "DeviceFarm", + "cors": true + }, + "directconnect": { + "name": "DirectConnect", + "cors": true + }, + "directoryservice": { + "prefix": "ds", + "name": "DirectoryService" + }, + "discovery": { + "name": "Discovery" + }, + "dms": { + "name": "DMS" + }, + "dynamodb": { + "name": "DynamoDB", + "cors": true + }, + "dynamodbstreams": { + "prefix": "streams.dynamodb", + "name": "DynamoDBStreams", + "cors": true + }, + "ec2": { + "name": "EC2", + "versions": [ + "2013-06-15*", + "2013-10-15*", + "2014-02-01*", + "2014-05-01*", + "2014-06-15*", + "2014-09-01*", + "2014-10-01*", + "2015-03-01*", + "2015-04-15*", + "2015-10-01*", + "2016-04-01*", + "2016-09-15*" + ], + "cors": true + }, + "ecr": { + "name": "ECR", + "cors": true + }, + "ecs": { + "name": "ECS", + "cors": true + }, + "efs": { + "prefix": "elasticfilesystem", + "name": "EFS", + "cors": true + }, + "elasticache": { + "name": "ElastiCache", + "versions": [ + "2012-11-15*", + "2014-03-24*", + "2014-07-15*", + "2014-09-30*" + ], + "cors": true + }, + "elasticbeanstalk": { + "name": "ElasticBeanstalk", + "cors": true + }, + "elb": { + "prefix": "elasticloadbalancing", + "name": "ELB", + "cors": true + }, + "elbv2": { + "prefix": "elasticloadbalancingv2", + "name": "ELBv2", + "cors": true + }, + "emr": { + "prefix": "elasticmapreduce", + "name": "EMR", + "cors": true + }, + "es": { + "name": "ES" + }, + "elastictranscoder": { + "name": "ElasticTranscoder", + "cors": true + }, + "firehose": { + "name": "Firehose", + "cors": true + }, + "gamelift": { + "name": "GameLift", + "cors": true + }, + "glacier": { + "name": "Glacier" + }, + "health": { + "name": "Health" + }, + "iam": { + "name": "IAM", + "cors": true + }, + "importexport": { + "name": "ImportExport" + }, + "inspector": { + "name": "Inspector", + "versions": [ + "2015-08-18*" + ], + "cors": true + }, + "iot": { + "name": "Iot", + "cors": true + }, + "iotdata": { + "prefix": "iot-data", + "name": "IotData", + "cors": true + }, + "kinesis": { + "name": "Kinesis", + "cors": true + }, + "kinesisanalytics": { + "name": "KinesisAnalytics" + }, + "kms": { + "name": "KMS", + "cors": true + }, + "lambda": { + "name": "Lambda", + "cors": true + }, + "lexruntime": { + "prefix": "runtime.lex", + "name": "LexRuntime", + "cors": true + }, + "lightsail": { + "name": "Lightsail" + }, + "machinelearning": { + "name": "MachineLearning", + "cors": true + }, + "marketplacecommerceanalytics": { + "name": "MarketplaceCommerceAnalytics", + "cors": true + }, + "marketplacemetering": { + "prefix": "meteringmarketplace", + "name": "MarketplaceMetering" + }, + "mturk": { + "prefix": "mturk-requester", + "name": "MTurk", + "cors": true + }, + "mobileanalytics": { + "name": "MobileAnalytics", + "cors": true + }, + "opsworks": { + "name": "OpsWorks", + "cors": true + }, + "opsworkscm": { + "name": "OpsWorksCM" + }, + "organizations": { + "name": "Organizations" + }, + "pinpoint": { + "name": "Pinpoint" + }, + "polly": { + "name": "Polly", + "cors": true + }, + "rds": { + "name": "RDS", + "versions": [ + "2014-09-01*" + ], + "cors": true + }, + "redshift": { + "name": "Redshift", + "cors": true + }, + "rekognition": { + "name": "Rekognition", + "cors": true + }, + "resourcegroupstaggingapi": { + "name": "ResourceGroupsTaggingAPI" + }, + "route53": { + "name": "Route53", + "cors": true + }, + "route53domains": { + "name": "Route53Domains", + "cors": true + }, + "s3": { + "name": "S3", + "dualstackAvailable": true, + "cors": true + }, + "s3control": { + "name": "S3Control", + "dualstackAvailable": true + }, + "servicecatalog": { + "name": "ServiceCatalog", + "cors": true + }, + "ses": { + "prefix": "email", + "name": "SES", + "cors": true + }, + "shield": { + "name": "Shield" + }, + "simpledb": { + "prefix": "sdb", + "name": "SimpleDB" + }, + "sms": { + "name": "SMS" + }, + "snowball": { + "name": "Snowball" + }, + "sns": { + "name": "SNS", + "cors": true + }, + "sqs": { + "name": "SQS", + "cors": true + }, + "ssm": { + "name": "SSM", + "cors": true + }, + "storagegateway": { + "name": "StorageGateway", + "cors": true + }, + "stepfunctions": { + "prefix": "states", + "name": "StepFunctions" + }, + "sts": { + "name": "STS", + "cors": true + }, + "support": { + "name": "Support" + }, + "swf": { + "name": "SWF" + }, + "xray": { + "name": "XRay" + }, + "waf": { + "name": "WAF", + "cors": true + }, + "wafregional": { + "prefix": "waf-regional", + "name": "WAFRegional" + }, + "workdocs": { + "name": "WorkDocs", + "cors": true + }, + "workspaces": { + "name": "WorkSpaces" + }, + "codestar": { + "name": "CodeStar" + }, + "lexmodelbuildingservice": { + "prefix": "lex-models", + "name": "LexModelBuildingService", + "cors": true + }, + "marketplaceentitlementservice": { + "prefix": "entitlement.marketplace", + "name": "MarketplaceEntitlementService" + }, + "athena": { + "name": "Athena" + }, + "greengrass": { + "name": "Greengrass" + }, + "dax": { + "name": "DAX" + }, + "migrationhub": { + "prefix": "AWSMigrationHub", + "name": "MigrationHub" + }, + "cloudhsmv2": { + "name": "CloudHSMV2" + }, + "glue": { + "name": "Glue" + }, + "mobile": { + "name": "Mobile" + }, + "pricing": { + "name": "Pricing", + "cors": true + }, + "costexplorer": { + "prefix": "ce", + "name": "CostExplorer", + "cors": true + }, + "mediaconvert": { + "name": "MediaConvert" + }, + "medialive": { + "name": "MediaLive" + }, + "mediapackage": { + "name": "MediaPackage" + }, + "mediastore": { + "name": "MediaStore" + }, + "mediastoredata": { + "prefix": "mediastore-data", + "name": "MediaStoreData", + "cors": true + }, + "appsync": { + "name": "AppSync" + }, + "guardduty": { + "name": "GuardDuty" + }, + "mq": { + "name": "MQ" + }, + "comprehend": { + "name": "Comprehend", + "cors": true + }, + "iotjobsdataplane": { + "prefix": "iot-jobs-data", + "name": "IoTJobsDataPlane" + }, + "kinesisvideoarchivedmedia": { + "prefix": "kinesis-video-archived-media", + "name": "KinesisVideoArchivedMedia", + "cors": true + }, + "kinesisvideomedia": { + "prefix": "kinesis-video-media", + "name": "KinesisVideoMedia", + "cors": true + }, + "kinesisvideo": { + "name": "KinesisVideo", + "cors": true + }, + "sagemakerruntime": { + "prefix": "runtime.sagemaker", + "name": "SageMakerRuntime" + }, + "sagemaker": { + "name": "SageMaker" + }, + "translate": { + "name": "Translate", + "cors": true + }, + "resourcegroups": { + "prefix": "resource-groups", + "name": "ResourceGroups", + "cors": true + }, + "alexaforbusiness": { + "name": "AlexaForBusiness" + }, + "cloud9": { + "name": "Cloud9" + }, + "serverlessapplicationrepository": { + "prefix": "serverlessrepo", + "name": "ServerlessApplicationRepository" + }, + "servicediscovery": { + "name": "ServiceDiscovery" + }, + "workmail": { + "name": "WorkMail" + }, + "autoscalingplans": { + "prefix": "autoscaling-plans", + "name": "AutoScalingPlans" + }, + "transcribeservice": { + "prefix": "transcribe", + "name": "TranscribeService" + }, + "connect": { + "name": "Connect" + }, + "acmpca": { + "prefix": "acm-pca", + "name": "ACMPCA" + }, + "fms": { + "name": "FMS" + }, + "secretsmanager": { + "name": "SecretsManager", + "cors": true + }, + "iotanalytics": { + "name": "IoTAnalytics" + }, + "iot1clickdevicesservice": { + "prefix": "iot1click-devices", + "name": "IoT1ClickDevicesService" + }, + "iot1clickprojects": { + "prefix": "iot1click-projects", + "name": "IoT1ClickProjects" + }, + "pi": { + "name": "PI" + }, + "neptune": { + "name": "Neptune" + }, + "mediatailor": { + "name": "MediaTailor" + }, + "eks": { + "name": "EKS" + }, + "macie": { + "name": "Macie" + }, + "dlm": { + "name": "DLM" + }, + "signer": { + "name": "Signer" + }, + "chime": { + "name": "Chime" + }, + "pinpointemail": { + "prefix": "pinpoint-email", + "name": "PinpointEmail" + }, + "ram": { + "name": "RAM" + }, + "route53resolver": { + "name": "Route53Resolver" + }, + "pinpointsmsvoice": { + "prefix": "sms-voice", + "name": "PinpointSMSVoice" + }, + "quicksight": { + "name": "QuickSight" + }, + "rdsdataservice": { + "prefix": "rds-data", + "name": "RDSDataService" + }, + "amplify": { + "name": "Amplify" + }, + "datasync": { + "name": "DataSync" + }, + "robomaker": { + "name": "RoboMaker" + }, + "transfer": { + "name": "Transfer" + }, + "globalaccelerator": { + "name": "GlobalAccelerator" + }, + "comprehendmedical": { + "name": "ComprehendMedical", + "cors": true + }, + "kinesisanalyticsv2": { + "name": "KinesisAnalyticsV2" + }, + "mediaconnect": { + "name": "MediaConnect" + }, + "fsx": { + "name": "FSx" + }, + "securityhub": { + "name": "SecurityHub" + }, + "appmesh": { + "name": "AppMesh", + "versions": [ + "2018-10-01*" + ] + }, + "licensemanager": { + "prefix": "license-manager", + "name": "LicenseManager" + }, + "kafka": { + "name": "Kafka" + }, + "apigatewaymanagementapi": { + "name": "ApiGatewayManagementApi" + }, + "apigatewayv2": { + "name": "ApiGatewayV2" + }, + "docdb": { + "name": "DocDB" + }, + "backup": { + "name": "Backup" + }, + "worklink": { + "name": "WorkLink" + }, + "textract": { + "name": "Textract" + }, + "managedblockchain": { + "name": "ManagedBlockchain" + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.examples.json b/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.min.json b/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.min.json new file mode 100644 index 0000000..d1ea6af --- /dev/null +++ b/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.min.json @@ -0,0 +1,151 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-01-14", + "endpointPrefix": "metering.marketplace", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWSMarketplace Metering", + "serviceId": "Marketplace Metering", + "signatureVersion": "v4", + "signingName": "aws-marketplace", + "targetPrefix": "AWSMPMeteringService", + "uid": "meteringmarketplace-2016-01-14" + }, + "operations": { + "BatchMeterUsage": { + "input": { + "type": "structure", + "required": [ + "UsageRecords", + "ProductCode" + ], + "members": { + "UsageRecords": { + "shape": "S2" + }, + "ProductCode": {} + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UsageRecord": { + "shape": "S3" + }, + "MeteringRecordId": {}, + "Status": {} + } + } + }, + "UnprocessedRecords": { + "shape": "S2" + } + } + } + }, + "MeterUsage": { + "input": { + "type": "structure", + "required": [ + "ProductCode", + "Timestamp", + "UsageDimension" + ], + "members": { + "ProductCode": {}, + "Timestamp": { + "type": "timestamp" + }, + "UsageDimension": {}, + "UsageQuantity": { + "type": "integer" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "MeteringRecordId": {} + } + } + }, + "RegisterUsage": { + "input": { + "type": "structure", + "required": [ + "ProductCode", + "PublicKeyVersion" + ], + "members": { + "ProductCode": {}, + "PublicKeyVersion": { + "type": "integer" + }, + "Nonce": {} + } + }, + "output": { + "type": "structure", + "members": { + "PublicKeyRotationTimestamp": { + "type": "timestamp" + }, + "Signature": {} + } + } + }, + "ResolveCustomer": { + "input": { + "type": "structure", + "required": [ + "RegistrationToken" + ], + "members": { + "RegistrationToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "CustomerIdentifier": {}, + "ProductCode": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": { + "shape": "S3" + } + }, + "S3": { + "type": "structure", + "required": [ + "Timestamp", + "CustomerIdentifier", + "Dimension" + ], + "members": { + "Timestamp": { + "type": "timestamp" + }, + "CustomerIdentifier": {}, + "Dimension": {}, + "Quantity": { + "type": "integer" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.paginators.json b/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/meteringmarketplace-2016-01-14.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/mobile-2017-07-01.examples.json b/node_modules/aws-sdk/apis/mobile-2017-07-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/mobile-2017-07-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/mobile-2017-07-01.min.json b/node_modules/aws-sdk/apis/mobile-2017-07-01.min.json new file mode 100644 index 0000000..d2cde28 --- /dev/null +++ b/node_modules/aws-sdk/apis/mobile-2017-07-01.min.json @@ -0,0 +1,341 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-07-01", + "endpointPrefix": "mobile", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS Mobile", + "serviceId": "Mobile", + "signatureVersion": "v4", + "signingName": "AWSMobileHubService", + "uid": "mobile-2017-07-01" + }, + "operations": { + "CreateProject": { + "http": { + "requestUri": "/projects" + }, + "input": { + "type": "structure", + "members": { + "name": { + "location": "querystring", + "locationName": "name" + }, + "region": { + "location": "querystring", + "locationName": "region" + }, + "contents": { + "type": "blob" + }, + "snapshotId": { + "location": "querystring", + "locationName": "snapshotId" + } + }, + "payload": "contents" + }, + "output": { + "type": "structure", + "members": { + "details": { + "shape": "S7" + } + } + } + }, + "DeleteProject": { + "http": { + "method": "DELETE", + "requestUri": "/projects/{projectId}" + }, + "input": { + "type": "structure", + "required": [ + "projectId" + ], + "members": { + "projectId": { + "location": "uri", + "locationName": "projectId" + } + } + }, + "output": { + "type": "structure", + "members": { + "deletedResources": { + "shape": "Sc" + }, + "orphanedResources": { + "shape": "Sc" + } + } + } + }, + "DescribeBundle": { + "http": { + "method": "GET", + "requestUri": "/bundles/{bundleId}" + }, + "input": { + "type": "structure", + "required": [ + "bundleId" + ], + "members": { + "bundleId": { + "location": "uri", + "locationName": "bundleId" + } + } + }, + "output": { + "type": "structure", + "members": { + "details": { + "shape": "Sq" + } + } + } + }, + "DescribeProject": { + "http": { + "method": "GET", + "requestUri": "/project" + }, + "input": { + "type": "structure", + "required": [ + "projectId" + ], + "members": { + "projectId": { + "location": "querystring", + "locationName": "projectId" + }, + "syncFromResources": { + "location": "querystring", + "locationName": "syncFromResources", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "details": { + "shape": "S7" + } + } + } + }, + "ExportBundle": { + "http": { + "requestUri": "/bundles/{bundleId}" + }, + "input": { + "type": "structure", + "required": [ + "bundleId" + ], + "members": { + "bundleId": { + "location": "uri", + "locationName": "bundleId" + }, + "projectId": { + "location": "querystring", + "locationName": "projectId" + }, + "platform": { + "location": "querystring", + "locationName": "platform" + } + } + }, + "output": { + "type": "structure", + "members": { + "downloadUrl": {} + } + } + }, + "ExportProject": { + "http": { + "requestUri": "/exports/{projectId}" + }, + "input": { + "type": "structure", + "required": [ + "projectId" + ], + "members": { + "projectId": { + "location": "uri", + "locationName": "projectId" + } + } + }, + "output": { + "type": "structure", + "members": { + "downloadUrl": {}, + "shareUrl": {}, + "snapshotId": {} + } + } + }, + "ListBundles": { + "http": { + "method": "GET", + "requestUri": "/bundles" + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "bundleList": { + "type": "list", + "member": { + "shape": "Sq" + } + }, + "nextToken": {} + } + } + }, + "ListProjects": { + "http": { + "method": "GET", + "requestUri": "/projects" + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "projects": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "projectId": {} + } + } + }, + "nextToken": {} + } + } + }, + "UpdateProject": { + "http": { + "requestUri": "/update" + }, + "input": { + "type": "structure", + "required": [ + "projectId" + ], + "members": { + "contents": { + "type": "blob" + }, + "projectId": { + "location": "querystring", + "locationName": "projectId" + } + }, + "payload": "contents" + }, + "output": { + "type": "structure", + "members": { + "details": { + "shape": "S7" + } + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "name": {}, + "projectId": {}, + "region": {}, + "state": {}, + "createdDate": { + "type": "timestamp" + }, + "lastUpdatedDate": { + "type": "timestamp" + }, + "consoleUrl": {}, + "resources": { + "shape": "Sc" + } + } + }, + "Sc": { + "type": "list", + "member": { + "type": "structure", + "members": { + "type": {}, + "name": {}, + "arn": {}, + "feature": {}, + "attributes": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "Sq": { + "type": "structure", + "members": { + "bundleId": {}, + "title": {}, + "version": {}, + "description": {}, + "iconUrl": {}, + "availablePlatforms": { + "type": "list", + "member": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mobile-2017-07-01.paginators.json b/node_modules/aws-sdk/apis/mobile-2017-07-01.paginators.json new file mode 100644 index 0000000..6dcde77 --- /dev/null +++ b/node_modules/aws-sdk/apis/mobile-2017-07-01.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "ListBundles": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListProjects": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/mobileanalytics-2014-06-05.min.json b/node_modules/aws-sdk/apis/mobileanalytics-2014-06-05.min.json new file mode 100644 index 0000000..4c0622a --- /dev/null +++ b/node_modules/aws-sdk/apis/mobileanalytics-2014-06-05.min.json @@ -0,0 +1,75 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-06-05", + "endpointPrefix": "mobileanalytics", + "serviceFullName": "Amazon Mobile Analytics", + "serviceId": "Mobile Analytics", + "signatureVersion": "v4", + "protocol": "rest-json" + }, + "operations": { + "PutEvents": { + "http": { + "requestUri": "/2014-06-05/events", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "events", + "clientContext" + ], + "members": { + "events": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "eventType", + "timestamp" + ], + "members": { + "eventType": {}, + "timestamp": {}, + "session": { + "type": "structure", + "members": { + "id": {}, + "duration": { + "type": "long" + }, + "startTimestamp": {}, + "stopTimestamp": {} + } + }, + "version": {}, + "attributes": { + "type": "map", + "key": {}, + "value": {} + }, + "metrics": { + "type": "map", + "key": {}, + "value": { + "type": "double" + } + } + } + } + }, + "clientContext": { + "location": "header", + "locationName": "x-amz-Client-Context" + }, + "clientContextEncoding": { + "location": "header", + "locationName": "x-amz-Client-Context-Encoding" + } + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/monitoring-2010-08-01.examples.json b/node_modules/aws-sdk/apis/monitoring-2010-08-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/monitoring-2010-08-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json b/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json new file mode 100644 index 0000000..5149d41 --- /dev/null +++ b/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json @@ -0,0 +1,858 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2010-08-01", + "endpointPrefix": "monitoring", + "protocol": "query", + "serviceAbbreviation": "CloudWatch", + "serviceFullName": "Amazon CloudWatch", + "serviceId": "CloudWatch", + "signatureVersion": "v4", + "uid": "monitoring-2010-08-01", + "xmlNamespace": "http://monitoring.amazonaws.com/doc/2010-08-01/" + }, + "operations": { + "DeleteAlarms": { + "input": { + "type": "structure", + "required": [ + "AlarmNames" + ], + "members": { + "AlarmNames": { + "shape": "S2" + } + } + } + }, + "DeleteDashboards": { + "input": { + "type": "structure", + "required": [ + "DashboardNames" + ], + "members": { + "DashboardNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DeleteDashboardsResult", + "type": "structure", + "members": {} + } + }, + "DescribeAlarmHistory": { + "input": { + "type": "structure", + "members": { + "AlarmName": {}, + "HistoryItemType": {}, + "StartDate": { + "type": "timestamp" + }, + "EndDate": { + "type": "timestamp" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeAlarmHistoryResult", + "type": "structure", + "members": { + "AlarmHistoryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AlarmName": {}, + "Timestamp": { + "type": "timestamp" + }, + "HistoryItemType": {}, + "HistorySummary": {}, + "HistoryData": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAlarms": { + "input": { + "type": "structure", + "members": { + "AlarmNames": { + "shape": "S2" + }, + "AlarmNamePrefix": {}, + "StateValue": {}, + "ActionPrefix": {}, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeAlarmsResult", + "type": "structure", + "members": { + "MetricAlarms": { + "shape": "Sn" + }, + "NextToken": {} + } + } + }, + "DescribeAlarmsForMetric": { + "input": { + "type": "structure", + "required": [ + "MetricName", + "Namespace" + ], + "members": { + "MetricName": {}, + "Namespace": {}, + "Statistic": {}, + "ExtendedStatistic": {}, + "Dimensions": { + "shape": "S10" + }, + "Period": { + "type": "integer" + }, + "Unit": {} + } + }, + "output": { + "resultWrapper": "DescribeAlarmsForMetricResult", + "type": "structure", + "members": { + "MetricAlarms": { + "shape": "Sn" + } + } + } + }, + "DisableAlarmActions": { + "input": { + "type": "structure", + "required": [ + "AlarmNames" + ], + "members": { + "AlarmNames": { + "shape": "S2" + } + } + } + }, + "EnableAlarmActions": { + "input": { + "type": "structure", + "required": [ + "AlarmNames" + ], + "members": { + "AlarmNames": { + "shape": "S2" + } + } + } + }, + "GetDashboard": { + "input": { + "type": "structure", + "required": [ + "DashboardName" + ], + "members": { + "DashboardName": {} + } + }, + "output": { + "resultWrapper": "GetDashboardResult", + "type": "structure", + "members": { + "DashboardArn": {}, + "DashboardBody": {}, + "DashboardName": {} + } + } + }, + "GetMetricData": { + "input": { + "type": "structure", + "required": [ + "MetricDataQueries", + "StartTime", + "EndTime" + ], + "members": { + "MetricDataQueries": { + "shape": "S1c" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "NextToken": {}, + "ScanBy": {}, + "MaxDatapoints": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "GetMetricDataResult", + "type": "structure", + "members": { + "MetricDataResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Label": {}, + "Timestamps": { + "type": "list", + "member": { + "type": "timestamp" + } + }, + "Values": { + "type": "list", + "member": { + "type": "double" + } + }, + "StatusCode": {}, + "Messages": { + "shape": "S23" + } + } + } + }, + "NextToken": {}, + "Messages": { + "shape": "S23" + } + } + } + }, + "GetMetricStatistics": { + "input": { + "type": "structure", + "required": [ + "Namespace", + "MetricName", + "StartTime", + "EndTime", + "Period" + ], + "members": { + "Namespace": {}, + "MetricName": {}, + "Dimensions": { + "shape": "S10" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Period": { + "type": "integer" + }, + "Statistics": { + "type": "list", + "member": {} + }, + "ExtendedStatistics": { + "type": "list", + "member": {} + }, + "Unit": {} + } + }, + "output": { + "resultWrapper": "GetMetricStatisticsResult", + "type": "structure", + "members": { + "Label": {}, + "Datapoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "timestamp" + }, + "SampleCount": { + "type": "double" + }, + "Average": { + "type": "double" + }, + "Sum": { + "type": "double" + }, + "Minimum": { + "type": "double" + }, + "Maximum": { + "type": "double" + }, + "Unit": {}, + "ExtendedStatistics": { + "type": "map", + "key": {}, + "value": { + "type": "double" + } + } + }, + "xmlOrder": [ + "Timestamp", + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum", + "Unit", + "ExtendedStatistics" + ] + } + } + } + } + }, + "GetMetricWidgetImage": { + "input": { + "type": "structure", + "required": [ + "MetricWidget" + ], + "members": { + "MetricWidget": {}, + "OutputFormat": {} + } + }, + "output": { + "resultWrapper": "GetMetricWidgetImageResult", + "type": "structure", + "members": { + "MetricWidgetImage": { + "type": "blob" + } + } + } + }, + "ListDashboards": { + "input": { + "type": "structure", + "members": { + "DashboardNamePrefix": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListDashboardsResult", + "type": "structure", + "members": { + "DashboardEntries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DashboardName": {}, + "DashboardArn": {}, + "LastModified": { + "type": "timestamp" + }, + "Size": { + "type": "long" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListMetrics": { + "input": { + "type": "structure", + "members": { + "Namespace": {}, + "MetricName": {}, + "Dimensions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListMetricsResult", + "type": "structure", + "members": { + "Metrics": { + "type": "list", + "member": { + "shape": "S1g" + } + }, + "NextToken": {} + }, + "xmlOrder": [ + "Metrics", + "NextToken" + ] + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "Tags": { + "shape": "S2y" + } + } + } + }, + "PutDashboard": { + "input": { + "type": "structure", + "required": [ + "DashboardName", + "DashboardBody" + ], + "members": { + "DashboardName": {}, + "DashboardBody": {} + } + }, + "output": { + "resultWrapper": "PutDashboardResult", + "type": "structure", + "members": { + "DashboardValidationMessages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DataPath": {}, + "Message": {} + } + } + } + } + } + }, + "PutMetricAlarm": { + "input": { + "type": "structure", + "required": [ + "AlarmName", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator" + ], + "members": { + "AlarmName": {}, + "AlarmDescription": {}, + "ActionsEnabled": { + "type": "boolean" + }, + "OKActions": { + "shape": "Ss" + }, + "AlarmActions": { + "shape": "Ss" + }, + "InsufficientDataActions": { + "shape": "Ss" + }, + "MetricName": {}, + "Namespace": {}, + "Statistic": {}, + "ExtendedStatistic": {}, + "Dimensions": { + "shape": "S10" + }, + "Period": { + "type": "integer" + }, + "Unit": {}, + "EvaluationPeriods": { + "type": "integer" + }, + "DatapointsToAlarm": { + "type": "integer" + }, + "Threshold": { + "type": "double" + }, + "ComparisonOperator": {}, + "TreatMissingData": {}, + "EvaluateLowSampleCountPercentile": {}, + "Metrics": { + "shape": "S1c" + }, + "Tags": { + "shape": "S2y" + } + } + } + }, + "PutMetricData": { + "input": { + "type": "structure", + "required": [ + "Namespace", + "MetricData" + ], + "members": { + "Namespace": {}, + "MetricData": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "MetricName" + ], + "members": { + "MetricName": {}, + "Dimensions": { + "shape": "S10" + }, + "Timestamp": { + "type": "timestamp" + }, + "Value": { + "type": "double" + }, + "StatisticValues": { + "type": "structure", + "required": [ + "SampleCount", + "Sum", + "Minimum", + "Maximum" + ], + "members": { + "SampleCount": { + "type": "double" + }, + "Sum": { + "type": "double" + }, + "Minimum": { + "type": "double" + }, + "Maximum": { + "type": "double" + } + } + }, + "Values": { + "type": "list", + "member": { + "type": "double" + } + }, + "Counts": { + "type": "list", + "member": { + "type": "double" + } + }, + "Unit": {}, + "StorageResolution": { + "type": "integer" + } + } + } + } + } + } + }, + "SetAlarmState": { + "input": { + "type": "structure", + "required": [ + "AlarmName", + "StateValue", + "StateReason" + ], + "members": { + "AlarmName": {}, + "StateValue": {}, + "StateReason": {}, + "StateReasonData": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "Tags" + ], + "members": { + "ResourceARN": {}, + "Tags": { + "shape": "S2y" + } + } + }, + "output": { + "resultWrapper": "TagResourceResult", + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "TagKeys" + ], + "members": { + "ResourceARN": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "UntagResourceResult", + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "Sn": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AlarmName": {}, + "AlarmArn": {}, + "AlarmDescription": {}, + "AlarmConfigurationUpdatedTimestamp": { + "type": "timestamp" + }, + "ActionsEnabled": { + "type": "boolean" + }, + "OKActions": { + "shape": "Ss" + }, + "AlarmActions": { + "shape": "Ss" + }, + "InsufficientDataActions": { + "shape": "Ss" + }, + "StateValue": {}, + "StateReason": {}, + "StateReasonData": {}, + "StateUpdatedTimestamp": { + "type": "timestamp" + }, + "MetricName": {}, + "Namespace": {}, + "Statistic": {}, + "ExtendedStatistic": {}, + "Dimensions": { + "shape": "S10" + }, + "Period": { + "type": "integer" + }, + "Unit": {}, + "EvaluationPeriods": { + "type": "integer" + }, + "DatapointsToAlarm": { + "type": "integer" + }, + "Threshold": { + "type": "double" + }, + "ComparisonOperator": {}, + "TreatMissingData": {}, + "EvaluateLowSampleCountPercentile": {}, + "Metrics": { + "shape": "S1c" + } + }, + "xmlOrder": [ + "AlarmName", + "AlarmArn", + "AlarmDescription", + "AlarmConfigurationUpdatedTimestamp", + "ActionsEnabled", + "OKActions", + "AlarmActions", + "InsufficientDataActions", + "StateValue", + "StateReason", + "StateReasonData", + "StateUpdatedTimestamp", + "MetricName", + "Namespace", + "Statistic", + "Dimensions", + "Period", + "Unit", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator", + "ExtendedStatistic", + "TreatMissingData", + "EvaluateLowSampleCountPercentile", + "DatapointsToAlarm", + "Metrics" + ] + } + }, + "Ss": { + "type": "list", + "member": {} + }, + "S10": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + }, + "xmlOrder": [ + "Name", + "Value" + ] + } + }, + "S1c": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "MetricStat": { + "type": "structure", + "required": [ + "Metric", + "Period", + "Stat" + ], + "members": { + "Metric": { + "shape": "S1g" + }, + "Period": { + "type": "integer" + }, + "Stat": {}, + "Unit": {} + } + }, + "Expression": {}, + "Label": {}, + "ReturnData": { + "type": "boolean" + } + } + } + }, + "S1g": { + "type": "structure", + "members": { + "Namespace": {}, + "MetricName": {}, + "Dimensions": { + "shape": "S10" + } + }, + "xmlOrder": [ + "Namespace", + "MetricName", + "Dimensions" + ] + }, + "S23": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Code": {}, + "Value": {} + } + } + }, + "S2y": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/monitoring-2010-08-01.paginators.json b/node_modules/aws-sdk/apis/monitoring-2010-08-01.paginators.json new file mode 100644 index 0000000..a9875d4 --- /dev/null +++ b/node_modules/aws-sdk/apis/monitoring-2010-08-01.paginators.json @@ -0,0 +1,38 @@ +{ + "pagination": { + "DescribeAlarmHistory": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "AlarmHistoryItems" + }, + "DescribeAlarms": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "MetricAlarms" + }, + "DescribeAlarmsForMetric": { + "result_key": "MetricAlarms" + }, + "GetMetricData": { + "input_token": "NextToken", + "limit_key": "MaxDatapoints", + "output_token": "NextToken", + "result_key": [ + "MetricDataResults", + "Messages" + ] + }, + "ListDashboards": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "DashboardEntries" + }, + "ListMetrics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Metrics" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/monitoring-2010-08-01.waiters2.json b/node_modules/aws-sdk/apis/monitoring-2010-08-01.waiters2.json new file mode 100644 index 0000000..cb0cf0b --- /dev/null +++ b/node_modules/aws-sdk/apis/monitoring-2010-08-01.waiters2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "AlarmExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeAlarms", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(MetricAlarms[]) > `0`", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/mq-2017-11-27.min.json b/node_modules/aws-sdk/apis/mq-2017-11-27.min.json new file mode 100644 index 0000000..2da2f38 --- /dev/null +++ b/node_modules/aws-sdk/apis/mq-2017-11-27.min.json @@ -0,0 +1,1267 @@ +{ + "metadata": { + "apiVersion": "2017-11-27", + "endpointPrefix": "mq", + "signingName": "mq", + "serviceFullName": "AmazonMQ", + "serviceId": "mq", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "mq-2017-11-27", + "signatureVersion": "v4" + }, + "operations": { + "CreateBroker": { + "http": { + "requestUri": "/v1/brokers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AutoMinorVersionUpgrade": { + "locationName": "autoMinorVersionUpgrade", + "type": "boolean" + }, + "BrokerName": { + "locationName": "brokerName" + }, + "Configuration": { + "shape": "S4", + "locationName": "configuration" + }, + "CreatorRequestId": { + "locationName": "creatorRequestId", + "idempotencyToken": true + }, + "DeploymentMode": { + "locationName": "deploymentMode" + }, + "EngineType": { + "locationName": "engineType" + }, + "EngineVersion": { + "locationName": "engineVersion" + }, + "HostInstanceType": { + "locationName": "hostInstanceType" + }, + "Logs": { + "shape": "S8", + "locationName": "logs" + }, + "MaintenanceWindowStartTime": { + "shape": "S9", + "locationName": "maintenanceWindowStartTime" + }, + "PubliclyAccessible": { + "locationName": "publiclyAccessible", + "type": "boolean" + }, + "SecurityGroups": { + "shape": "Sb", + "locationName": "securityGroups" + }, + "SubnetIds": { + "shape": "Sb", + "locationName": "subnetIds" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + }, + "Users": { + "locationName": "users", + "type": "list", + "member": { + "type": "structure", + "members": { + "ConsoleAccess": { + "locationName": "consoleAccess", + "type": "boolean" + }, + "Groups": { + "shape": "Sb", + "locationName": "groups" + }, + "Password": { + "locationName": "password" + }, + "Username": { + "locationName": "username" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "BrokerArn": { + "locationName": "brokerArn" + }, + "BrokerId": { + "locationName": "brokerId" + } + } + } + }, + "CreateConfiguration": { + "http": { + "requestUri": "/v1/configurations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "EngineType": { + "locationName": "engineType" + }, + "EngineVersion": { + "locationName": "engineVersion" + }, + "Name": { + "locationName": "name" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Created": { + "shape": "Si", + "locationName": "created" + }, + "Id": { + "locationName": "id" + }, + "LatestRevision": { + "shape": "Sj", + "locationName": "latestRevision" + }, + "Name": { + "locationName": "name" + } + } + } + }, + "CreateTags": { + "http": { + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + }, + "required": [ + "ResourceArn" + ] + } + }, + "CreateUser": { + "http": { + "requestUri": "/v1/brokers/{broker-id}/users/{username}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + }, + "ConsoleAccess": { + "locationName": "consoleAccess", + "type": "boolean" + }, + "Groups": { + "shape": "Sb", + "locationName": "groups" + }, + "Password": { + "locationName": "password" + }, + "Username": { + "location": "uri", + "locationName": "username" + } + }, + "required": [ + "Username", + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteBroker": { + "http": { + "method": "DELETE", + "requestUri": "/v1/brokers/{broker-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + } + }, + "required": [ + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": { + "BrokerId": { + "locationName": "brokerId" + } + } + } + }, + "DeleteTags": { + "http": { + "method": "DELETE", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "shape": "Sb", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + } + }, + "DeleteUser": { + "http": { + "method": "DELETE", + "requestUri": "/v1/brokers/{broker-id}/users/{username}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + }, + "Username": { + "location": "uri", + "locationName": "username" + } + }, + "required": [ + "Username", + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeBroker": { + "http": { + "method": "GET", + "requestUri": "/v1/brokers/{broker-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + } + }, + "required": [ + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": { + "AutoMinorVersionUpgrade": { + "locationName": "autoMinorVersionUpgrade", + "type": "boolean" + }, + "BrokerArn": { + "locationName": "brokerArn" + }, + "BrokerId": { + "locationName": "brokerId" + }, + "BrokerInstances": { + "locationName": "brokerInstances", + "type": "list", + "member": { + "type": "structure", + "members": { + "ConsoleURL": { + "locationName": "consoleURL" + }, + "Endpoints": { + "shape": "Sb", + "locationName": "endpoints" + }, + "IpAddress": { + "locationName": "ipAddress" + } + } + } + }, + "BrokerName": { + "locationName": "brokerName" + }, + "BrokerState": { + "locationName": "brokerState" + }, + "Configurations": { + "locationName": "configurations", + "type": "structure", + "members": { + "Current": { + "shape": "S4", + "locationName": "current" + }, + "History": { + "locationName": "history", + "type": "list", + "member": { + "shape": "S4" + } + }, + "Pending": { + "shape": "S4", + "locationName": "pending" + } + } + }, + "Created": { + "shape": "Si", + "locationName": "created" + }, + "DeploymentMode": { + "locationName": "deploymentMode" + }, + "EngineType": { + "locationName": "engineType" + }, + "EngineVersion": { + "locationName": "engineVersion" + }, + "HostInstanceType": { + "locationName": "hostInstanceType" + }, + "Logs": { + "locationName": "logs", + "type": "structure", + "members": { + "Audit": { + "locationName": "audit", + "type": "boolean" + }, + "AuditLogGroup": { + "locationName": "auditLogGroup" + }, + "General": { + "locationName": "general", + "type": "boolean" + }, + "GeneralLogGroup": { + "locationName": "generalLogGroup" + }, + "Pending": { + "locationName": "pending", + "type": "structure", + "members": { + "Audit": { + "locationName": "audit", + "type": "boolean" + }, + "General": { + "locationName": "general", + "type": "boolean" + } + } + } + } + }, + "MaintenanceWindowStartTime": { + "shape": "S9", + "locationName": "maintenanceWindowStartTime" + }, + "PendingEngineVersion": { + "locationName": "pendingEngineVersion" + }, + "PubliclyAccessible": { + "locationName": "publiclyAccessible", + "type": "boolean" + }, + "SecurityGroups": { + "shape": "Sb", + "locationName": "securityGroups" + }, + "SubnetIds": { + "shape": "Sb", + "locationName": "subnetIds" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + }, + "Users": { + "shape": "S11", + "locationName": "users" + } + } + } + }, + "DescribeBrokerEngineTypes": { + "http": { + "method": "GET", + "requestUri": "/v1/broker-engine-types", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "EngineType": { + "location": "querystring", + "locationName": "engineType" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "BrokerEngineTypes": { + "locationName": "brokerEngineTypes", + "type": "list", + "member": { + "type": "structure", + "members": { + "EngineType": { + "locationName": "engineType" + }, + "EngineVersions": { + "locationName": "engineVersions", + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + } + } + } + } + } + } + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeBrokerInstanceOptions": { + "http": { + "method": "GET", + "requestUri": "/v1/broker-instance-options", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "EngineType": { + "location": "querystring", + "locationName": "engineType" + }, + "HostInstanceType": { + "location": "querystring", + "locationName": "hostInstanceType" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "BrokerInstanceOptions": { + "locationName": "brokerInstanceOptions", + "type": "list", + "member": { + "type": "structure", + "members": { + "AvailabilityZones": { + "locationName": "availabilityZones", + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + } + } + } + }, + "EngineType": { + "locationName": "engineType" + }, + "HostInstanceType": { + "locationName": "hostInstanceType" + }, + "SupportedEngineVersions": { + "shape": "Sb", + "locationName": "supportedEngineVersions" + } + } + } + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeConfiguration": { + "http": { + "method": "GET", + "requestUri": "/v1/configurations/{configuration-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationId": { + "location": "uri", + "locationName": "configuration-id" + } + }, + "required": [ + "ConfigurationId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Created": { + "shape": "Si", + "locationName": "created" + }, + "Description": { + "locationName": "description" + }, + "EngineType": { + "locationName": "engineType" + }, + "EngineVersion": { + "locationName": "engineVersion" + }, + "Id": { + "locationName": "id" + }, + "LatestRevision": { + "shape": "Sj", + "locationName": "latestRevision" + }, + "Name": { + "locationName": "name" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + } + } + }, + "DescribeConfigurationRevision": { + "http": { + "method": "GET", + "requestUri": "/v1/configurations/{configuration-id}/revisions/{configuration-revision}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationId": { + "location": "uri", + "locationName": "configuration-id" + }, + "ConfigurationRevision": { + "location": "uri", + "locationName": "configuration-revision" + } + }, + "required": [ + "ConfigurationRevision", + "ConfigurationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ConfigurationId": { + "locationName": "configurationId" + }, + "Created": { + "shape": "Si", + "locationName": "created" + }, + "Data": { + "locationName": "data" + }, + "Description": { + "locationName": "description" + } + } + } + }, + "DescribeUser": { + "http": { + "method": "GET", + "requestUri": "/v1/brokers/{broker-id}/users/{username}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + }, + "Username": { + "location": "uri", + "locationName": "username" + } + }, + "required": [ + "Username", + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": { + "BrokerId": { + "locationName": "brokerId" + }, + "ConsoleAccess": { + "locationName": "consoleAccess", + "type": "boolean" + }, + "Groups": { + "shape": "Sb", + "locationName": "groups" + }, + "Pending": { + "locationName": "pending", + "type": "structure", + "members": { + "ConsoleAccess": { + "locationName": "consoleAccess", + "type": "boolean" + }, + "Groups": { + "shape": "Sb", + "locationName": "groups" + }, + "PendingChange": { + "locationName": "pendingChange" + } + } + }, + "Username": { + "locationName": "username" + } + } + } + }, + "ListBrokers": { + "http": { + "method": "GET", + "requestUri": "/v1/brokers", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "BrokerSummaries": { + "locationName": "brokerSummaries", + "type": "list", + "member": { + "type": "structure", + "members": { + "BrokerArn": { + "locationName": "brokerArn" + }, + "BrokerId": { + "locationName": "brokerId" + }, + "BrokerName": { + "locationName": "brokerName" + }, + "BrokerState": { + "locationName": "brokerState" + }, + "Created": { + "shape": "Si", + "locationName": "created" + }, + "DeploymentMode": { + "locationName": "deploymentMode" + }, + "HostInstanceType": { + "locationName": "hostInstanceType" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListConfigurationRevisions": { + "http": { + "method": "GET", + "requestUri": "/v1/configurations/{configuration-id}/revisions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationId": { + "location": "uri", + "locationName": "configuration-id" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ConfigurationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ConfigurationId": { + "locationName": "configurationId" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "Revisions": { + "locationName": "revisions", + "type": "list", + "member": { + "shape": "Sj" + } + } + } + } + }, + "ListConfigurations": { + "http": { + "method": "GET", + "requestUri": "/v1/configurations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Configurations": { + "locationName": "configurations", + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Created": { + "shape": "Si", + "locationName": "created" + }, + "Description": { + "locationName": "description" + }, + "EngineType": { + "locationName": "engineType" + }, + "EngineVersion": { + "locationName": "engineVersion" + }, + "Id": { + "locationName": "id" + }, + "LatestRevision": { + "shape": "Sj", + "locationName": "latestRevision" + }, + "Name": { + "locationName": "name" + }, + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + } + } + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListTags": { + "http": { + "method": "GET", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "Sc", + "locationName": "tags" + } + } + } + }, + "ListUsers": { + "http": { + "method": "GET", + "requestUri": "/v1/brokers/{broker-id}/users", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": { + "BrokerId": { + "locationName": "brokerId" + }, + "MaxResults": { + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "locationName": "nextToken" + }, + "Users": { + "shape": "S11", + "locationName": "users" + } + } + } + }, + "RebootBroker": { + "http": { + "requestUri": "/v1/brokers/{broker-id}/reboot", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + } + }, + "required": [ + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateBroker": { + "http": { + "method": "PUT", + "requestUri": "/v1/brokers/{broker-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AutoMinorVersionUpgrade": { + "locationName": "autoMinorVersionUpgrade", + "type": "boolean" + }, + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + }, + "Configuration": { + "shape": "S4", + "locationName": "configuration" + }, + "EngineVersion": { + "locationName": "engineVersion" + }, + "Logs": { + "shape": "S8", + "locationName": "logs" + } + }, + "required": [ + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": { + "AutoMinorVersionUpgrade": { + "locationName": "autoMinorVersionUpgrade", + "type": "boolean" + }, + "BrokerId": { + "locationName": "brokerId" + }, + "Configuration": { + "shape": "S4", + "locationName": "configuration" + }, + "EngineVersion": { + "locationName": "engineVersion" + }, + "Logs": { + "shape": "S8", + "locationName": "logs" + } + } + } + }, + "UpdateConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/v1/configurations/{configuration-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationId": { + "location": "uri", + "locationName": "configuration-id" + }, + "Data": { + "locationName": "data" + }, + "Description": { + "locationName": "description" + } + }, + "required": [ + "ConfigurationId" + ] + }, + "output": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Created": { + "shape": "Si", + "locationName": "created" + }, + "Id": { + "locationName": "id" + }, + "LatestRevision": { + "shape": "Sj", + "locationName": "latestRevision" + }, + "Name": { + "locationName": "name" + }, + "Warnings": { + "locationName": "warnings", + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeName": { + "locationName": "attributeName" + }, + "ElementName": { + "locationName": "elementName" + }, + "Reason": { + "locationName": "reason" + } + } + } + } + } + } + }, + "UpdateUser": { + "http": { + "method": "PUT", + "requestUri": "/v1/brokers/{broker-id}/users/{username}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "BrokerId": { + "location": "uri", + "locationName": "broker-id" + }, + "ConsoleAccess": { + "locationName": "consoleAccess", + "type": "boolean" + }, + "Groups": { + "shape": "Sb", + "locationName": "groups" + }, + "Password": { + "locationName": "password" + }, + "Username": { + "location": "uri", + "locationName": "username" + } + }, + "required": [ + "Username", + "BrokerId" + ] + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "Id": { + "locationName": "id" + }, + "Revision": { + "locationName": "revision", + "type": "integer" + } + } + }, + "S8": { + "type": "structure", + "members": { + "Audit": { + "locationName": "audit", + "type": "boolean" + }, + "General": { + "locationName": "general", + "type": "boolean" + } + } + }, + "S9": { + "type": "structure", + "members": { + "DayOfWeek": { + "locationName": "dayOfWeek" + }, + "TimeOfDay": { + "locationName": "timeOfDay" + }, + "TimeZone": { + "locationName": "timeZone" + } + } + }, + "Sb": { + "type": "list", + "member": {} + }, + "Sc": { + "type": "map", + "key": {}, + "value": {} + }, + "Si": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "Sj": { + "type": "structure", + "members": { + "Created": { + "shape": "Si", + "locationName": "created" + }, + "Description": { + "locationName": "description" + }, + "Revision": { + "locationName": "revision", + "type": "integer" + } + } + }, + "S11": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PendingChange": { + "locationName": "pendingChange" + }, + "Username": { + "locationName": "username" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mq-2017-11-27.paginators.json b/node_modules/aws-sdk/apis/mq-2017-11-27.paginators.json new file mode 100644 index 0000000..f3b7195 --- /dev/null +++ b/node_modules/aws-sdk/apis/mq-2017-11-27.paginators.json @@ -0,0 +1,3 @@ +{ + "pagination" : { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.examples.json b/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.min.json b/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.min.json new file mode 100644 index 0000000..81955b1 --- /dev/null +++ b/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.min.json @@ -0,0 +1,1297 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-01-17", + "endpointPrefix": "mturk-requester", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Amazon MTurk", + "serviceFullName": "Amazon Mechanical Turk", + "serviceId": "MTurk", + "signatureVersion": "v4", + "targetPrefix": "MTurkRequesterServiceV20170117", + "uid": "mturk-requester-2017-01-17" + }, + "operations": { + "AcceptQualificationRequest": { + "input": { + "type": "structure", + "required": [ + "QualificationRequestId" + ], + "members": { + "QualificationRequestId": {}, + "IntegerValue": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ApproveAssignment": { + "input": { + "type": "structure", + "required": [ + "AssignmentId" + ], + "members": { + "AssignmentId": {}, + "RequesterFeedback": {}, + "OverrideRejection": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "AssociateQualificationWithWorker": { + "input": { + "type": "structure", + "required": [ + "QualificationTypeId", + "WorkerId" + ], + "members": { + "QualificationTypeId": {}, + "WorkerId": {}, + "IntegerValue": { + "type": "integer" + }, + "SendNotification": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateAdditionalAssignmentsForHIT": { + "input": { + "type": "structure", + "required": [ + "HITId", + "NumberOfAdditionalAssignments" + ], + "members": { + "HITId": {}, + "NumberOfAdditionalAssignments": { + "type": "integer" + }, + "UniqueRequestToken": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateHIT": { + "input": { + "type": "structure", + "required": [ + "LifetimeInSeconds", + "AssignmentDurationInSeconds", + "Reward", + "Title", + "Description" + ], + "members": { + "MaxAssignments": { + "type": "integer" + }, + "AutoApprovalDelayInSeconds": { + "type": "long" + }, + "LifetimeInSeconds": { + "type": "long" + }, + "AssignmentDurationInSeconds": { + "type": "long" + }, + "Reward": {}, + "Title": {}, + "Keywords": {}, + "Description": {}, + "Question": {}, + "RequesterAnnotation": {}, + "QualificationRequirements": { + "shape": "Si" + }, + "UniqueRequestToken": {}, + "AssignmentReviewPolicy": { + "shape": "Sq" + }, + "HITReviewPolicy": { + "shape": "Sq" + }, + "HITLayoutId": {}, + "HITLayoutParameters": { + "shape": "Sw" + } + } + }, + "output": { + "type": "structure", + "members": { + "HIT": { + "shape": "Sz" + } + } + } + }, + "CreateHITType": { + "input": { + "type": "structure", + "required": [ + "AssignmentDurationInSeconds", + "Reward", + "Title", + "Description" + ], + "members": { + "AutoApprovalDelayInSeconds": { + "type": "long" + }, + "AssignmentDurationInSeconds": { + "type": "long" + }, + "Reward": {}, + "Title": {}, + "Keywords": {}, + "Description": {}, + "QualificationRequirements": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": { + "HITTypeId": {} + } + }, + "idempotent": true + }, + "CreateHITWithHITType": { + "input": { + "type": "structure", + "required": [ + "HITTypeId", + "LifetimeInSeconds" + ], + "members": { + "HITTypeId": {}, + "MaxAssignments": { + "type": "integer" + }, + "LifetimeInSeconds": { + "type": "long" + }, + "Question": {}, + "RequesterAnnotation": {}, + "UniqueRequestToken": {}, + "AssignmentReviewPolicy": { + "shape": "Sq" + }, + "HITReviewPolicy": { + "shape": "Sq" + }, + "HITLayoutId": {}, + "HITLayoutParameters": { + "shape": "Sw" + } + } + }, + "output": { + "type": "structure", + "members": { + "HIT": { + "shape": "Sz" + } + } + } + }, + "CreateQualificationType": { + "input": { + "type": "structure", + "required": [ + "Name", + "Description", + "QualificationTypeStatus" + ], + "members": { + "Name": {}, + "Keywords": {}, + "Description": {}, + "QualificationTypeStatus": {}, + "RetryDelayInSeconds": { + "type": "long" + }, + "Test": {}, + "AnswerKey": {}, + "TestDurationInSeconds": { + "type": "long" + }, + "AutoGranted": { + "type": "boolean" + }, + "AutoGrantedValue": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "QualificationType": { + "shape": "S1a" + } + } + } + }, + "CreateWorkerBlock": { + "input": { + "type": "structure", + "required": [ + "WorkerId", + "Reason" + ], + "members": { + "WorkerId": {}, + "Reason": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteHIT": { + "input": { + "type": "structure", + "required": [ + "HITId" + ], + "members": { + "HITId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteQualificationType": { + "input": { + "type": "structure", + "required": [ + "QualificationTypeId" + ], + "members": { + "QualificationTypeId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteWorkerBlock": { + "input": { + "type": "structure", + "required": [ + "WorkerId" + ], + "members": { + "WorkerId": {}, + "Reason": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DisassociateQualificationFromWorker": { + "input": { + "type": "structure", + "required": [ + "WorkerId", + "QualificationTypeId" + ], + "members": { + "WorkerId": {}, + "QualificationTypeId": {}, + "Reason": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetAccountBalance": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AvailableBalance": {}, + "OnHoldBalance": {} + } + }, + "idempotent": true + }, + "GetAssignment": { + "input": { + "type": "structure", + "required": [ + "AssignmentId" + ], + "members": { + "AssignmentId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Assignment": { + "shape": "S1p" + }, + "HIT": { + "shape": "Sz" + } + } + }, + "idempotent": true + }, + "GetFileUploadURL": { + "input": { + "type": "structure", + "required": [ + "AssignmentId", + "QuestionIdentifier" + ], + "members": { + "AssignmentId": {}, + "QuestionIdentifier": {} + } + }, + "output": { + "type": "structure", + "members": { + "FileUploadURL": {} + } + }, + "idempotent": true + }, + "GetHIT": { + "input": { + "type": "structure", + "required": [ + "HITId" + ], + "members": { + "HITId": {} + } + }, + "output": { + "type": "structure", + "members": { + "HIT": { + "shape": "Sz" + } + } + }, + "idempotent": true + }, + "GetQualificationScore": { + "input": { + "type": "structure", + "required": [ + "QualificationTypeId", + "WorkerId" + ], + "members": { + "QualificationTypeId": {}, + "WorkerId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Qualification": { + "shape": "S1x" + } + } + }, + "idempotent": true + }, + "GetQualificationType": { + "input": { + "type": "structure", + "required": [ + "QualificationTypeId" + ], + "members": { + "QualificationTypeId": {} + } + }, + "output": { + "type": "structure", + "members": { + "QualificationType": { + "shape": "S1a" + } + } + }, + "idempotent": true + }, + "ListAssignmentsForHIT": { + "input": { + "type": "structure", + "required": [ + "HITId" + ], + "members": { + "HITId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "AssignmentStatuses": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NumResults": { + "type": "integer" + }, + "Assignments": { + "type": "list", + "member": { + "shape": "S1p" + } + } + } + }, + "idempotent": true + }, + "ListBonusPayments": { + "input": { + "type": "structure", + "members": { + "HITId": {}, + "AssignmentId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NumResults": { + "type": "integer" + }, + "NextToken": {}, + "BonusPayments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WorkerId": {}, + "BonusAmount": {}, + "AssignmentId": {}, + "Reason": {}, + "GrantTime": { + "type": "timestamp" + } + } + } + } + } + }, + "idempotent": true + }, + "ListHITs": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NumResults": { + "type": "integer" + }, + "HITs": { + "shape": "S2d" + } + } + }, + "idempotent": true + }, + "ListHITsForQualificationType": { + "input": { + "type": "structure", + "required": [ + "QualificationTypeId" + ], + "members": { + "QualificationTypeId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NumResults": { + "type": "integer" + }, + "HITs": { + "shape": "S2d" + } + } + }, + "idempotent": true + }, + "ListQualificationRequests": { + "input": { + "type": "structure", + "members": { + "QualificationTypeId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NumResults": { + "type": "integer" + }, + "NextToken": {}, + "QualificationRequests": { + "type": "list", + "member": { + "type": "structure", + "members": { + "QualificationRequestId": {}, + "QualificationTypeId": {}, + "WorkerId": {}, + "Test": {}, + "Answer": {}, + "SubmitTime": { + "type": "timestamp" + } + } + } + } + } + }, + "idempotent": true + }, + "ListQualificationTypes": { + "input": { + "type": "structure", + "required": [ + "MustBeRequestable" + ], + "members": { + "Query": {}, + "MustBeRequestable": { + "type": "boolean" + }, + "MustBeOwnedByCaller": { + "type": "boolean" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NumResults": { + "type": "integer" + }, + "NextToken": {}, + "QualificationTypes": { + "type": "list", + "member": { + "shape": "S1a" + } + } + } + }, + "idempotent": true + }, + "ListReviewPolicyResultsForHIT": { + "input": { + "type": "structure", + "required": [ + "HITId" + ], + "members": { + "HITId": {}, + "PolicyLevels": { + "type": "list", + "member": {} + }, + "RetrieveActions": { + "type": "boolean" + }, + "RetrieveResults": { + "type": "boolean" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "HITId": {}, + "AssignmentReviewPolicy": { + "shape": "Sq" + }, + "HITReviewPolicy": { + "shape": "Sq" + }, + "AssignmentReviewReport": { + "shape": "S2r" + }, + "HITReviewReport": { + "shape": "S2r" + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListReviewableHITs": { + "input": { + "type": "structure", + "members": { + "HITTypeId": {}, + "Status": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NumResults": { + "type": "integer" + }, + "HITs": { + "shape": "S2d" + } + } + }, + "idempotent": true + }, + "ListWorkerBlocks": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NumResults": { + "type": "integer" + }, + "WorkerBlocks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WorkerId": {}, + "Reason": {} + } + } + } + } + }, + "idempotent": true + }, + "ListWorkersWithQualificationType": { + "input": { + "type": "structure", + "required": [ + "QualificationTypeId" + ], + "members": { + "QualificationTypeId": {}, + "Status": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NumResults": { + "type": "integer" + }, + "Qualifications": { + "type": "list", + "member": { + "shape": "S1x" + } + } + } + }, + "idempotent": true + }, + "NotifyWorkers": { + "input": { + "type": "structure", + "required": [ + "Subject", + "MessageText", + "WorkerIds" + ], + "members": { + "Subject": {}, + "MessageText": {}, + "WorkerIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "NotifyWorkersFailureStatuses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "NotifyWorkersFailureCode": {}, + "NotifyWorkersFailureMessage": {}, + "WorkerId": {} + } + } + } + } + } + }, + "RejectAssignment": { + "input": { + "type": "structure", + "required": [ + "AssignmentId", + "RequesterFeedback" + ], + "members": { + "AssignmentId": {}, + "RequesterFeedback": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "RejectQualificationRequest": { + "input": { + "type": "structure", + "required": [ + "QualificationRequestId" + ], + "members": { + "QualificationRequestId": {}, + "Reason": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SendBonus": { + "input": { + "type": "structure", + "required": [ + "WorkerId", + "BonusAmount", + "AssignmentId", + "Reason" + ], + "members": { + "WorkerId": {}, + "BonusAmount": {}, + "AssignmentId": {}, + "Reason": {}, + "UniqueRequestToken": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SendTestEventNotification": { + "input": { + "type": "structure", + "required": [ + "Notification", + "TestEventType" + ], + "members": { + "Notification": { + "shape": "S3k" + }, + "TestEventType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateExpirationForHIT": { + "input": { + "type": "structure", + "required": [ + "HITId", + "ExpireAt" + ], + "members": { + "HITId": {}, + "ExpireAt": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateHITReviewStatus": { + "input": { + "type": "structure", + "required": [ + "HITId" + ], + "members": { + "HITId": {}, + "Revert": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateHITTypeOfHIT": { + "input": { + "type": "structure", + "required": [ + "HITId", + "HITTypeId" + ], + "members": { + "HITId": {}, + "HITTypeId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateNotificationSettings": { + "input": { + "type": "structure", + "required": [ + "HITTypeId" + ], + "members": { + "HITTypeId": {}, + "Notification": { + "shape": "S3k" + }, + "Active": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateQualificationType": { + "input": { + "type": "structure", + "required": [ + "QualificationTypeId" + ], + "members": { + "QualificationTypeId": {}, + "Description": {}, + "QualificationTypeStatus": {}, + "Test": {}, + "AnswerKey": {}, + "TestDurationInSeconds": { + "type": "long" + }, + "RetryDelayInSeconds": { + "type": "long" + }, + "AutoGranted": { + "type": "boolean" + }, + "AutoGrantedValue": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "QualificationType": { + "shape": "S1a" + } + } + } + } + }, + "shapes": { + "Si": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "QualificationTypeId", + "Comparator" + ], + "members": { + "QualificationTypeId": {}, + "Comparator": {}, + "IntegerValues": { + "type": "list", + "member": { + "type": "integer" + } + }, + "LocaleValues": { + "type": "list", + "member": { + "shape": "Sn" + } + }, + "RequiredToPreview": { + "deprecated": true, + "type": "boolean" + }, + "ActionsGuarded": {} + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "Country" + ], + "members": { + "Country": {}, + "Subdivision": {} + } + }, + "Sq": { + "type": "structure", + "required": [ + "PolicyName" + ], + "members": { + "PolicyName": {}, + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "shape": "St" + }, + "MapEntries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "shape": "St" + } + } + } + } + } + } + } + } + }, + "St": { + "type": "list", + "member": {} + }, + "Sw": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "Sz": { + "type": "structure", + "members": { + "HITId": {}, + "HITTypeId": {}, + "HITGroupId": {}, + "HITLayoutId": {}, + "CreationTime": { + "type": "timestamp" + }, + "Title": {}, + "Description": {}, + "Question": {}, + "Keywords": {}, + "HITStatus": {}, + "MaxAssignments": { + "type": "integer" + }, + "Reward": {}, + "AutoApprovalDelayInSeconds": { + "type": "long" + }, + "Expiration": { + "type": "timestamp" + }, + "AssignmentDurationInSeconds": { + "type": "long" + }, + "RequesterAnnotation": {}, + "QualificationRequirements": { + "shape": "Si" + }, + "HITReviewStatus": {}, + "NumberOfAssignmentsPending": { + "type": "integer" + }, + "NumberOfAssignmentsAvailable": { + "type": "integer" + }, + "NumberOfAssignmentsCompleted": { + "type": "integer" + } + } + }, + "S1a": { + "type": "structure", + "members": { + "QualificationTypeId": {}, + "CreationTime": { + "type": "timestamp" + }, + "Name": {}, + "Description": {}, + "Keywords": {}, + "QualificationTypeStatus": {}, + "Test": {}, + "TestDurationInSeconds": { + "type": "long" + }, + "AnswerKey": {}, + "RetryDelayInSeconds": { + "type": "long" + }, + "IsRequestable": { + "type": "boolean" + }, + "AutoGranted": { + "type": "boolean" + }, + "AutoGrantedValue": { + "type": "integer" + } + } + }, + "S1p": { + "type": "structure", + "members": { + "AssignmentId": {}, + "WorkerId": {}, + "HITId": {}, + "AssignmentStatus": {}, + "AutoApprovalTime": { + "type": "timestamp" + }, + "AcceptTime": { + "type": "timestamp" + }, + "SubmitTime": { + "type": "timestamp" + }, + "ApprovalTime": { + "type": "timestamp" + }, + "RejectionTime": { + "type": "timestamp" + }, + "Deadline": { + "type": "timestamp" + }, + "Answer": {}, + "RequesterFeedback": {} + } + }, + "S1x": { + "type": "structure", + "members": { + "QualificationTypeId": {}, + "WorkerId": {}, + "GrantTime": { + "type": "timestamp" + }, + "IntegerValue": { + "type": "integer" + }, + "LocaleValue": { + "shape": "Sn" + }, + "Status": {} + } + }, + "S2d": { + "type": "list", + "member": { + "shape": "Sz" + } + }, + "S2r": { + "type": "structure", + "members": { + "ReviewResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ActionId": {}, + "SubjectId": {}, + "SubjectType": {}, + "QuestionId": {}, + "Key": {}, + "Value": {} + } + } + }, + "ReviewActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ActionId": {}, + "ActionName": {}, + "TargetId": {}, + "TargetType": {}, + "Status": {}, + "CompleteTime": { + "type": "timestamp" + }, + "Result": {}, + "ErrorCode": {} + } + } + } + } + }, + "S3k": { + "type": "structure", + "required": [ + "Destination", + "Transport", + "Version", + "EventTypes" + ], + "members": { + "Destination": {}, + "Transport": {}, + "Version": {}, + "EventTypes": { + "type": "list", + "member": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.paginators.json b/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.paginators.json new file mode 100644 index 0000000..4a99bf7 --- /dev/null +++ b/node_modules/aws-sdk/apis/mturk-requester-2017-01-17.paginators.json @@ -0,0 +1,54 @@ +{ + "pagination": { + "ListAssignmentsForHIT": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBonusPayments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListHITs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListHITsForQualificationType": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListQualificationRequests": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListQualificationTypes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListReviewPolicyResultsForHIT": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListReviewableHITs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListWorkerBlocks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListWorkersWithQualificationType": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/neptune-2014-10-31.examples.json b/node_modules/aws-sdk/apis/neptune-2014-10-31.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/neptune-2014-10-31.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/neptune-2014-10-31.min.json b/node_modules/aws-sdk/apis/neptune-2014-10-31.min.json new file mode 100644 index 0000000..8aba1a7 --- /dev/null +++ b/node_modules/aws-sdk/apis/neptune-2014-10-31.min.json @@ -0,0 +1,2455 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-10-31", + "endpointPrefix": "rds", + "protocol": "query", + "serviceAbbreviation": "Amazon Neptune", + "serviceFullName": "Amazon Neptune", + "serviceId": "Neptune", + "signatureVersion": "v4", + "signingName": "rds", + "uid": "neptune-2014-10-31", + "xmlNamespace": "http://rds.amazonaws.com/doc/2014-10-31/" + }, + "operations": { + "AddRoleToDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "RoleArn" + ], + "members": { + "DBClusterIdentifier": {}, + "RoleArn": {} + } + } + }, + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S5" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "Sa" + } + } + } + }, + "ApplyPendingMaintenanceAction": { + "input": { + "type": "structure", + "required": [ + "ResourceIdentifier", + "ApplyAction", + "OptInType" + ], + "members": { + "ResourceIdentifier": {}, + "ApplyAction": {}, + "OptInType": {} + } + }, + "output": { + "resultWrapper": "ApplyPendingMaintenanceActionResult", + "type": "structure", + "members": { + "ResourcePendingMaintenanceActions": { + "shape": "Se" + } + } + } + }, + "CopyDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "SourceDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupDescription" + ], + "members": { + "SourceDBClusterParameterGroupIdentifier": {}, + "TargetDBClusterParameterGroupIdentifier": {}, + "TargetDBClusterParameterGroupDescription": {}, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CopyDBClusterParameterGroupResult", + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "shape": "Sk" + } + } + } + }, + "CopyDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members": { + "SourceDBClusterSnapshotIdentifier": {}, + "TargetDBClusterSnapshotIdentifier": {}, + "KmsKeyId": {}, + "PreSignedUrl": {}, + "CopyTags": { + "type": "boolean" + }, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CopyDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "So" + } + } + } + }, + "CopyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members": { + "SourceDBParameterGroupIdentifier": {}, + "TargetDBParameterGroupIdentifier": {}, + "TargetDBParameterGroupDescription": {}, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CopyDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "St" + } + } + } + }, + "CreateDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "Engine" + ], + "members": { + "AvailabilityZones": { + "shape": "Sp" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "CharacterSetName": {}, + "DatabaseName": {}, + "DBClusterIdentifier": {}, + "DBClusterParameterGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sw" + }, + "DBSubnetGroupName": {}, + "Engine": {}, + "EngineVersion": {}, + "Port": { + "type": "integer" + }, + "MasterUsername": {}, + "MasterUserPassword": {}, + "OptionGroupName": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "ReplicationSourceIdentifier": {}, + "Tags": { + "shape": "Sa" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "PreSignedUrl": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sy" + } + } + } + }, + "CreateDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBClusterParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterParameterGroupResult", + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "shape": "Sk" + } + } + } + }, + "CreateDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {}, + "DBClusterIdentifier": {}, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "So" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "S1d" + }, + "VpcSecurityGroupIds": { + "shape": "Sw" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "deprecated": true, + "type": "boolean" + }, + "Tags": { + "shape": "Sa" + }, + "DBClusterIdentifier": {}, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "Domain": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "MonitoringRoleArn": {}, + "DomainIAMRoleName": {}, + "PromotionTier": { + "type": "integer" + }, + "Timezone": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EnablePerformanceInsights": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "EnableCloudwatchLogsExports": { + "shape": "S1e" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S1g" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "St" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S23" + }, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S1m" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S7" + }, + "SourceIds": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S5" + } + } + } + }, + "DeleteDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sy" + } + } + } + }, + "DeleteDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {} + } + } + }, + "DeleteDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "So" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S1g" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S5" + } + } + } + }, + "DescribeDBClusterParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterParameterGroups": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBClusterParameterGroup" + } + } + } + } + }, + "DescribeDBClusterParameters": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {}, + "Source": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2q" + }, + "Marker": {} + } + } + }, + "DescribeDBClusterSnapshotAttributes": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterSnapshotAttributesResult", + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "shape": "S2v" + } + } + } + }, + "DescribeDBClusterSnapshots": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "DBClusterSnapshotIdentifier": {}, + "SnapshotType": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "IncludeShared": { + "type": "boolean" + }, + "IncludePublic": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBClusterSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterSnapshots": { + "type": "list", + "member": { + "shape": "So", + "locationName": "DBClusterSnapshot" + } + } + } + } + }, + "DescribeDBClusters": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusters": { + "type": "list", + "member": { + "shape": "Sy", + "locationName": "DBCluster" + } + } + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + }, + "ListSupportedTimezones": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S39" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S39", + "locationName": "CharacterSet" + } + }, + "ValidUpgradeTarget": { + "type": "list", + "member": { + "locationName": "UpgradeTarget", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "Description": {}, + "AutoUpgrade": { + "type": "boolean" + }, + "IsMajorVersionUpgrade": { + "type": "boolean" + } + } + } + }, + "SupportedTimezones": { + "type": "list", + "member": { + "locationName": "Timezone", + "type": "structure", + "members": { + "TimezoneName": {} + } + } + }, + "ExportableLogTypes": { + "shape": "S1e" + }, + "SupportsLogExportsToCloudwatchLogs": { + "type": "boolean" + }, + "SupportsReadReplica": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "S1g", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "St", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2q" + }, + "Marker": {} + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S1m", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultClusterParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultClusterParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "shape": "S3s" + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "shape": "S3s" + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {}, + "Filters": { + "shape": "S2j" + } + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S7" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S5", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S7" + }, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S7" + }, + "Date": { + "type": "timestamp" + }, + "SourceArn": {} + } + } + } + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "Filters": { + "shape": "S2j" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S1p", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + }, + "SupportsStorageEncryption": { + "type": "boolean" + }, + "StorageType": {}, + "SupportsIops": { + "type": "boolean" + }, + "SupportsEnhancedMonitoring": { + "type": "boolean" + }, + "SupportsIAMDatabaseAuthentication": { + "type": "boolean" + }, + "SupportsPerformanceInsights": { + "type": "boolean" + }, + "MinStorageSize": { + "type": "integer" + }, + "MaxStorageSize": { + "type": "integer" + }, + "MinIopsPerDbInstance": { + "type": "integer" + }, + "MaxIopsPerDbInstance": { + "type": "integer" + }, + "MinIopsPerGib": { + "type": "double" + }, + "MaxIopsPerGib": { + "type": "double" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribePendingMaintenanceActions": { + "input": { + "type": "structure", + "members": { + "ResourceIdentifier": {}, + "Filters": { + "shape": "S2j" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribePendingMaintenanceActionsResult", + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "type": "list", + "member": { + "shape": "Se", + "locationName": "ResourcePendingMaintenanceActions" + } + }, + "Marker": {} + } + } + }, + "DescribeValidDBInstanceModifications": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "DescribeValidDBInstanceModificationsResult", + "type": "structure", + "members": { + "ValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "Storage": { + "type": "list", + "member": { + "locationName": "ValidStorageOptions", + "type": "structure", + "members": { + "StorageType": {}, + "StorageSize": { + "shape": "S4l" + }, + "ProvisionedIops": { + "shape": "S4l" + }, + "IopsToStorageRatio": { + "type": "list", + "member": { + "locationName": "DoubleRange", + "type": "structure", + "members": { + "From": { + "type": "double" + }, + "To": { + "type": "double" + } + } + } + } + } + } + } + }, + "wrapper": true + } + } + } + }, + "FailoverDBCluster": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "TargetDBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "FailoverDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sy" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {}, + "Filters": { + "shape": "S2j" + } + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "Sa" + } + } + } + }, + "ModifyDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "NewDBClusterIdentifier": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBClusterParameterGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sw" + }, + "Port": { + "type": "integer" + }, + "MasterUserPassword": {}, + "OptionGroupName": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EngineVersion": {} + } + }, + "output": { + "resultWrapper": "ModifyDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sy" + } + } + } + }, + "ModifyDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName", + "Parameters" + ], + "members": { + "DBClusterParameterGroupName": {}, + "Parameters": { + "shape": "S2q" + } + } + }, + "output": { + "shape": "S4x", + "resultWrapper": "ModifyDBClusterParameterGroupResult" + } + }, + "ModifyDBClusterSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier", + "AttributeName" + ], + "members": { + "DBClusterSnapshotIdentifier": {}, + "AttributeName": {}, + "ValuesToAdd": { + "shape": "S2y" + }, + "ValuesToRemove": { + "shape": "S2y" + } + } + }, + "output": { + "resultWrapper": "ModifyDBClusterSnapshotAttributeResult", + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "shape": "S2v" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSubnetGroupName": {}, + "DBSecurityGroups": { + "shape": "S1d" + }, + "VpcSecurityGroupIds": { + "shape": "Sw" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {}, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {}, + "CACertificateIdentifier": {}, + "Domain": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "DBPortNumber": { + "type": "integer" + }, + "PubliclyAccessible": { + "deprecated": true, + "type": "boolean" + }, + "MonitoringRoleArn": {}, + "DomainIAMRoleName": {}, + "PromotionTier": { + "type": "integer" + }, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EnablePerformanceInsights": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "CloudwatchLogsExportConfiguration": { + "type": "structure", + "members": { + "EnableLogTypes": { + "shape": "S1e" + }, + "DisableLogTypes": { + "shape": "S1e" + } + } + } + } + }, + "output": { + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S1g" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2q" + } + } + }, + "output": { + "shape": "S54", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S23" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S1m" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S7" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S5" + } + } + } + }, + "PromoteReadReplicaDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "PromoteReadReplicaDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sy" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S1g" + } + } + } + }, + "RemoveRoleFromDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "RoleArn" + ], + "members": { + "DBClusterIdentifier": {}, + "RoleArn": {} + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S5" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2q" + } + } + }, + "output": { + "shape": "S4x", + "resultWrapper": "ResetDBClusterParameterGroupResult" + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2q" + } + } + }, + "output": { + "shape": "S54", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBClusterFromSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members": { + "AvailabilityZones": { + "shape": "Sp" + }, + "DBClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "Engine": {}, + "EngineVersion": {}, + "Port": { + "type": "integer" + }, + "DBSubnetGroupName": {}, + "DatabaseName": {}, + "OptionGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sw" + }, + "Tags": { + "shape": "Sa" + }, + "KmsKeyId": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "DBClusterParameterGroupName": {} + } + }, + "output": { + "resultWrapper": "RestoreDBClusterFromSnapshotResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sy" + } + } + } + }, + "RestoreDBClusterToPointInTime": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "RestoreType": {}, + "SourceDBClusterIdentifier": {}, + "RestoreToTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "DBSubnetGroupName": {}, + "OptionGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "Sw" + }, + "Tags": { + "shape": "Sa" + }, + "KmsKeyId": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "DBClusterParameterGroupName": {} + } + }, + "output": { + "resultWrapper": "RestoreDBClusterToPointInTimeResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "Sy" + } + } + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S6" + }, + "EventCategoriesList": { + "shape": "S7" + }, + "Enabled": { + "type": "boolean" + }, + "EventSubscriptionArn": {} + }, + "wrapper": true + }, + "S6": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S7": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "Sa": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Se": { + "type": "structure", + "members": { + "ResourceIdentifier": {}, + "PendingMaintenanceActionDetails": { + "type": "list", + "member": { + "locationName": "PendingMaintenanceAction", + "type": "structure", + "members": { + "Action": {}, + "AutoAppliedAfterDate": { + "type": "timestamp" + }, + "ForcedApplyDate": { + "type": "timestamp" + }, + "OptInStatus": {}, + "CurrentApplyDate": { + "type": "timestamp" + }, + "Description": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "DBClusterParameterGroupArn": {} + }, + "wrapper": true + }, + "So": { + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "Sp" + }, + "DBClusterSnapshotIdentifier": {}, + "DBClusterIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "VpcId": {}, + "ClusterCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "PercentProgress": { + "type": "integer" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DBClusterSnapshotArn": {}, + "SourceDBClusterSnapshotArn": {}, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "Sp": { + "type": "list", + "member": { + "locationName": "AvailabilityZone" + } + }, + "St": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "DBParameterGroupArn": {} + }, + "wrapper": true + }, + "Sw": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "Sy": { + "type": "structure", + "members": { + "AllocatedStorage": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "Sp" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "CharacterSetName": {}, + "DatabaseName": {}, + "DBClusterIdentifier": {}, + "DBClusterParameterGroup": {}, + "DBSubnetGroup": {}, + "Status": {}, + "PercentProgress": {}, + "EarliestRestorableTime": { + "type": "timestamp" + }, + "Endpoint": {}, + "ReaderEndpoint": {}, + "MultiAZ": { + "type": "boolean" + }, + "Engine": {}, + "EngineVersion": {}, + "LatestRestorableTime": { + "type": "timestamp" + }, + "Port": { + "type": "integer" + }, + "MasterUsername": {}, + "DBClusterOptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "DBClusterOptionGroup", + "type": "structure", + "members": { + "DBClusterOptionGroupName": {}, + "Status": {} + } + } + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "ReplicationSourceIdentifier": {}, + "ReadReplicaIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaIdentifier" + } + }, + "DBClusterMembers": { + "type": "list", + "member": { + "locationName": "DBClusterMember", + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "IsClusterWriter": { + "type": "boolean" + }, + "DBClusterParameterGroupStatus": {}, + "PromotionTier": { + "type": "integer" + } + }, + "wrapper": true + } + }, + "VpcSecurityGroups": { + "shape": "S14" + }, + "HostedZoneId": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DbClusterResourceId": {}, + "DBClusterArn": {}, + "AssociatedRoles": { + "type": "list", + "member": { + "locationName": "DBClusterRole", + "type": "structure", + "members": { + "RoleArn": {}, + "Status": {} + } + } + }, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + }, + "CloneGroupId": {}, + "ClusterCreateTime": { + "type": "timestamp" + } + }, + "wrapper": true + }, + "S14": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S1d": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "S1e": { + "type": "list", + "member": {} + }, + "S1g": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + }, + "HostedZoneId": {} + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "VpcSecurityGroups": { + "shape": "S14" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S1m" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {}, + "StorageType": {}, + "CACertificateIdentifier": {}, + "DBSubnetGroupName": {}, + "PendingCloudwatchLogsExports": { + "type": "structure", + "members": { + "LogTypesToEnable": { + "shape": "S1e" + }, + "LogTypesToDisable": { + "shape": "S1e" + } + } + } + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "ReadReplicaDBClusterIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBClusterIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "OptionGroupMembership", + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "deprecated": true, + "type": "boolean" + }, + "StatusInfos": { + "type": "list", + "member": { + "locationName": "DBInstanceStatusInfo", + "type": "structure", + "members": { + "StatusType": {}, + "Normal": { + "type": "boolean" + }, + "Status": {}, + "Message": {} + } + } + }, + "StorageType": {}, + "TdeCredentialArn": {}, + "DbInstancePort": { + "type": "integer" + }, + "DBClusterIdentifier": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DbiResourceId": {}, + "CACertificateIdentifier": {}, + "DomainMemberships": { + "type": "list", + "member": { + "locationName": "DomainMembership", + "type": "structure", + "members": { + "Domain": {}, + "Status": {}, + "FQDN": {}, + "IAMRoleName": {} + } + } + }, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "EnhancedMonitoringResourceArn": {}, + "MonitoringRoleArn": {}, + "PromotionTier": { + "type": "integer" + }, + "DBInstanceArn": {}, + "Timezone": {}, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + }, + "PerformanceInsightsEnabled": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "EnabledCloudwatchLogsExports": { + "shape": "S1e" + } + }, + "wrapper": true + }, + "S1m": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S1p" + }, + "SubnetStatus": {} + } + } + }, + "DBSubnetGroupArn": {} + }, + "wrapper": true + }, + "S1p": { + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + }, + "S23": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S2j": { + "type": "list", + "member": { + "locationName": "Filter", + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": { + "locationName": "Value" + } + } + } + } + }, + "S2q": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S2v": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": {}, + "DBClusterSnapshotAttributes": { + "type": "list", + "member": { + "locationName": "DBClusterSnapshotAttribute", + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValues": { + "shape": "S2y" + } + } + } + } + }, + "wrapper": true + }, + "S2y": { + "type": "list", + "member": { + "locationName": "AttributeValue" + } + }, + "S39": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S3s": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2q" + } + }, + "wrapper": true + }, + "S4l": { + "type": "list", + "member": { + "locationName": "Range", + "type": "structure", + "members": { + "From": { + "type": "integer" + }, + "To": { + "type": "integer" + }, + "Step": { + "type": "integer" + } + } + } + }, + "S4x": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {} + } + }, + "S54": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/neptune-2014-10-31.paginators.json b/node_modules/aws-sdk/apis/neptune-2014-10-31.paginators.json new file mode 100644 index 0000000..2a45886 --- /dev/null +++ b/node_modules/aws-sdk/apis/neptune-2014-10-31.paginators.json @@ -0,0 +1,61 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "EngineDefaults.Marker", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/neptune-2014-10-31.waiters2.json b/node_modules/aws-sdk/apis/neptune-2014-10-31.waiters2.json new file mode 100644 index 0000000..e75f03b --- /dev/null +++ b/node_modules/aws-sdk/apis/neptune-2014-10-31.waiters2.json @@ -0,0 +1,90 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "DBInstanceNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/opsworks-2013-02-18.examples.json b/node_modules/aws-sdk/apis/opsworks-2013-02-18.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworks-2013-02-18.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/opsworks-2013-02-18.min.json b/node_modules/aws-sdk/apis/opsworks-2013-02-18.min.json new file mode 100644 index 0000000..b6e5660 --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworks-2013-02-18.min.json @@ -0,0 +1,2292 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-02-18", + "endpointPrefix": "opsworks", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS OpsWorks", + "serviceId": "OpsWorks", + "signatureVersion": "v4", + "targetPrefix": "OpsWorks_20130218", + "uid": "opsworks-2013-02-18" + }, + "operations": { + "AssignInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "LayerIds" + ], + "members": { + "InstanceId": {}, + "LayerIds": { + "shape": "S3" + } + } + } + }, + "AssignVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {}, + "InstanceId": {} + } + } + }, + "AssociateElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {}, + "InstanceId": {} + } + } + }, + "AttachElasticLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "ElasticLoadBalancerName", + "LayerId" + ], + "members": { + "ElasticLoadBalancerName": {}, + "LayerId": {} + } + } + }, + "CloneStack": { + "input": { + "type": "structure", + "required": [ + "SourceStackId", + "ServiceRoleArn" + ], + "members": { + "SourceStackId": {}, + "Name": {}, + "Region": {}, + "VpcId": {}, + "Attributes": { + "shape": "S8" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "Sa" + }, + "ChefConfiguration": { + "shape": "Sb" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sd" + }, + "DefaultSshKeyName": {}, + "ClonePermissions": { + "type": "boolean" + }, + "CloneAppIds": { + "shape": "S3" + }, + "DefaultRootDeviceType": {}, + "AgentVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "CreateApp": { + "input": { + "type": "structure", + "required": [ + "StackId", + "Name", + "Type" + ], + "members": { + "StackId": {}, + "Shortname": {}, + "Name": {}, + "Description": {}, + "DataSources": { + "shape": "Si" + }, + "Type": {}, + "AppSource": { + "shape": "Sd" + }, + "Domains": { + "shape": "S3" + }, + "EnableSsl": { + "type": "boolean" + }, + "SslConfiguration": { + "shape": "Sl" + }, + "Attributes": { + "shape": "Sm" + }, + "Environment": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "AppId": {} + } + } + }, + "CreateDeployment": { + "input": { + "type": "structure", + "required": [ + "StackId", + "Command" + ], + "members": { + "StackId": {}, + "AppId": {}, + "InstanceIds": { + "shape": "S3" + }, + "LayerIds": { + "shape": "S3" + }, + "Command": { + "shape": "Ss" + }, + "Comment": {}, + "CustomJson": {} + } + }, + "output": { + "type": "structure", + "members": { + "DeploymentId": {} + } + } + }, + "CreateInstance": { + "input": { + "type": "structure", + "required": [ + "StackId", + "LayerIds", + "InstanceType" + ], + "members": { + "StackId": {}, + "LayerIds": { + "shape": "S3" + }, + "InstanceType": {}, + "AutoScalingType": {}, + "Hostname": {}, + "Os": {}, + "AmiId": {}, + "SshKeyName": {}, + "AvailabilityZone": {}, + "VirtualizationType": {}, + "SubnetId": {}, + "Architecture": {}, + "RootDeviceType": {}, + "BlockDeviceMappings": { + "shape": "Sz" + }, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "EbsOptimized": { + "type": "boolean" + }, + "AgentVersion": {}, + "Tenancy": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": {} + } + } + }, + "CreateLayer": { + "input": { + "type": "structure", + "required": [ + "StackId", + "Type", + "Name", + "Shortname" + ], + "members": { + "StackId": {}, + "Type": {}, + "Name": {}, + "Shortname": {}, + "Attributes": { + "shape": "S17" + }, + "CloudWatchLogsConfiguration": { + "shape": "S19" + }, + "CustomInstanceProfileArn": {}, + "CustomJson": {}, + "CustomSecurityGroupIds": { + "shape": "S3" + }, + "Packages": { + "shape": "S3" + }, + "VolumeConfigurations": { + "shape": "S1f" + }, + "EnableAutoHealing": { + "type": "boolean" + }, + "AutoAssignElasticIps": { + "type": "boolean" + }, + "AutoAssignPublicIps": { + "type": "boolean" + }, + "CustomRecipes": { + "shape": "S1h" + }, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "UseEbsOptimizedInstances": { + "type": "boolean" + }, + "LifecycleEventConfiguration": { + "shape": "S1i" + } + } + }, + "output": { + "type": "structure", + "members": { + "LayerId": {} + } + } + }, + "CreateStack": { + "input": { + "type": "structure", + "required": [ + "Name", + "Region", + "ServiceRoleArn", + "DefaultInstanceProfileArn" + ], + "members": { + "Name": {}, + "Region": {}, + "VpcId": {}, + "Attributes": { + "shape": "S8" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "Sa" + }, + "ChefConfiguration": { + "shape": "Sb" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sd" + }, + "DefaultSshKeyName": {}, + "DefaultRootDeviceType": {}, + "AgentVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "CreateUserProfile": { + "input": { + "type": "structure", + "required": [ + "IamUserArn" + ], + "members": { + "IamUserArn": {}, + "SshUsername": {}, + "SshPublicKey": {}, + "AllowSelfManagement": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "IamUserArn": {} + } + } + }, + "DeleteApp": { + "input": { + "type": "structure", + "required": [ + "AppId" + ], + "members": { + "AppId": {} + } + } + }, + "DeleteInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "DeleteElasticIp": { + "type": "boolean" + }, + "DeleteVolumes": { + "type": "boolean" + } + } + } + }, + "DeleteLayer": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {} + } + } + }, + "DeleteStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + } + }, + "DeleteUserProfile": { + "input": { + "type": "structure", + "required": [ + "IamUserArn" + ], + "members": { + "IamUserArn": {} + } + } + }, + "DeregisterEcsCluster": { + "input": { + "type": "structure", + "required": [ + "EcsClusterArn" + ], + "members": { + "EcsClusterArn": {} + } + } + }, + "DeregisterElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {} + } + } + }, + "DeregisterInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + } + }, + "DeregisterRdsDbInstance": { + "input": { + "type": "structure", + "required": [ + "RdsDbInstanceArn" + ], + "members": { + "RdsDbInstanceArn": {} + } + } + }, + "DeregisterVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {} + } + } + }, + "DescribeAgentVersions": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "ConfigurationManager": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "members": { + "AgentVersions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Version": {}, + "ConfigurationManager": { + "shape": "Sa" + } + } + } + } + } + } + }, + "DescribeApps": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "AppIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Apps": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AppId": {}, + "StackId": {}, + "Shortname": {}, + "Name": {}, + "Description": {}, + "DataSources": { + "shape": "Si" + }, + "Type": {}, + "AppSource": { + "shape": "Sd" + }, + "Domains": { + "shape": "S3" + }, + "EnableSsl": { + "type": "boolean" + }, + "SslConfiguration": { + "shape": "Sl" + }, + "Attributes": { + "shape": "Sm" + }, + "CreatedAt": {}, + "Environment": { + "shape": "So" + } + } + } + } + } + } + }, + "DescribeCommands": { + "input": { + "type": "structure", + "members": { + "DeploymentId": {}, + "InstanceId": {}, + "CommandIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Commands": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CommandId": {}, + "InstanceId": {}, + "DeploymentId": {}, + "CreatedAt": {}, + "AcknowledgedAt": {}, + "CompletedAt": {}, + "Status": {}, + "ExitCode": { + "type": "integer" + }, + "LogUrl": {}, + "Type": {} + } + } + } + } + } + }, + "DescribeDeployments": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "AppId": {}, + "DeploymentIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Deployments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DeploymentId": {}, + "StackId": {}, + "AppId": {}, + "CreatedAt": {}, + "CompletedAt": {}, + "Duration": { + "type": "integer" + }, + "IamUserArn": {}, + "Comment": {}, + "Command": { + "shape": "Ss" + }, + "Status": {}, + "CustomJson": {}, + "InstanceIds": { + "shape": "S3" + } + } + } + } + } + } + }, + "DescribeEcsClusters": { + "input": { + "type": "structure", + "members": { + "EcsClusterArns": { + "shape": "S3" + }, + "StackId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "EcsClusters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EcsClusterArn": {}, + "EcsClusterName": {}, + "StackId": {}, + "RegisteredAt": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeElasticIps": { + "input": { + "type": "structure", + "members": { + "InstanceId": {}, + "StackId": {}, + "Ips": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ElasticIps": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Ip": {}, + "Name": {}, + "Domain": {}, + "Region": {}, + "InstanceId": {} + } + } + } + } + } + }, + "DescribeElasticLoadBalancers": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "LayerIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ElasticLoadBalancers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ElasticLoadBalancerName": {}, + "Region": {}, + "DnsName": {}, + "StackId": {}, + "LayerId": {}, + "VpcId": {}, + "AvailabilityZones": { + "shape": "S3" + }, + "SubnetIds": { + "shape": "S3" + }, + "Ec2InstanceIds": { + "shape": "S3" + } + } + } + } + } + } + }, + "DescribeInstances": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "LayerId": {}, + "InstanceIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AgentVersion": {}, + "AmiId": {}, + "Architecture": {}, + "Arn": {}, + "AutoScalingType": {}, + "AvailabilityZone": {}, + "BlockDeviceMappings": { + "shape": "Sz" + }, + "CreatedAt": {}, + "EbsOptimized": { + "type": "boolean" + }, + "Ec2InstanceId": {}, + "EcsClusterArn": {}, + "EcsContainerInstanceArn": {}, + "ElasticIp": {}, + "Hostname": {}, + "InfrastructureClass": {}, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "InstanceId": {}, + "InstanceProfileArn": {}, + "InstanceType": {}, + "LastServiceErrorId": {}, + "LayerIds": { + "shape": "S3" + }, + "Os": {}, + "Platform": {}, + "PrivateDns": {}, + "PrivateIp": {}, + "PublicDns": {}, + "PublicIp": {}, + "RegisteredBy": {}, + "ReportedAgentVersion": {}, + "ReportedOs": { + "type": "structure", + "members": { + "Family": {}, + "Name": {}, + "Version": {} + } + }, + "RootDeviceType": {}, + "RootDeviceVolumeId": {}, + "SecurityGroupIds": { + "shape": "S3" + }, + "SshHostDsaKeyFingerprint": {}, + "SshHostRsaKeyFingerprint": {}, + "SshKeyName": {}, + "StackId": {}, + "Status": {}, + "SubnetId": {}, + "Tenancy": {}, + "VirtualizationType": {} + } + } + } + } + } + }, + "DescribeLayers": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "LayerIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Layers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "StackId": {}, + "LayerId": {}, + "Type": {}, + "Name": {}, + "Shortname": {}, + "Attributes": { + "shape": "S17" + }, + "CloudWatchLogsConfiguration": { + "shape": "S19" + }, + "CustomInstanceProfileArn": {}, + "CustomJson": {}, + "CustomSecurityGroupIds": { + "shape": "S3" + }, + "DefaultSecurityGroupNames": { + "shape": "S3" + }, + "Packages": { + "shape": "S3" + }, + "VolumeConfigurations": { + "shape": "S1f" + }, + "EnableAutoHealing": { + "type": "boolean" + }, + "AutoAssignElasticIps": { + "type": "boolean" + }, + "AutoAssignPublicIps": { + "type": "boolean" + }, + "DefaultRecipes": { + "shape": "S1h" + }, + "CustomRecipes": { + "shape": "S1h" + }, + "CreatedAt": {}, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "UseEbsOptimizedInstances": { + "type": "boolean" + }, + "LifecycleEventConfiguration": { + "shape": "S1i" + } + } + } + } + } + } + }, + "DescribeLoadBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "LayerIds" + ], + "members": { + "LayerIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoadBasedAutoScalingConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LayerId": {}, + "Enable": { + "type": "boolean" + }, + "UpScaling": { + "shape": "S36" + }, + "DownScaling": { + "shape": "S36" + } + } + } + } + } + } + }, + "DescribeMyUserProfile": { + "output": { + "type": "structure", + "members": { + "UserProfile": { + "type": "structure", + "members": { + "IamUserArn": {}, + "Name": {}, + "SshUsername": {}, + "SshPublicKey": {} + } + } + } + } + }, + "DescribeOperatingSystems": { + "output": { + "type": "structure", + "members": { + "OperatingSystems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Id": {}, + "Type": {}, + "ConfigurationManagers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Version": {} + } + } + }, + "ReportedName": {}, + "ReportedVersion": {}, + "Supported": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribePermissions": { + "input": { + "type": "structure", + "members": { + "IamUserArn": {}, + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Permissions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackId": {}, + "IamUserArn": {}, + "AllowSsh": { + "type": "boolean" + }, + "AllowSudo": { + "type": "boolean" + }, + "Level": {} + } + } + } + } + } + }, + "DescribeRaidArrays": { + "input": { + "type": "structure", + "members": { + "InstanceId": {}, + "StackId": {}, + "RaidArrayIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "RaidArrays": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RaidArrayId": {}, + "InstanceId": {}, + "Name": {}, + "RaidLevel": { + "type": "integer" + }, + "NumberOfDisks": { + "type": "integer" + }, + "Size": { + "type": "integer" + }, + "Device": {}, + "MountPoint": {}, + "AvailabilityZone": {}, + "CreatedAt": {}, + "StackId": {}, + "VolumeType": {}, + "Iops": { + "type": "integer" + } + } + } + } + } + } + }, + "DescribeRdsDbInstances": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {}, + "RdsDbInstanceArns": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "RdsDbInstances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RdsDbInstanceArn": {}, + "DbInstanceIdentifier": {}, + "DbUser": {}, + "DbPassword": {}, + "Region": {}, + "Address": {}, + "Engine": {}, + "StackId": {}, + "MissingOnRds": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeServiceErrors": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "InstanceId": {}, + "ServiceErrorIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ServiceErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ServiceErrorId": {}, + "StackId": {}, + "InstanceId": {}, + "Type": {}, + "Message": {}, + "CreatedAt": {} + } + } + } + } + } + }, + "DescribeStackProvisioningParameters": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "AgentInstallerUrl": {}, + "Parameters": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "DescribeStackSummary": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "StackSummary": { + "type": "structure", + "members": { + "StackId": {}, + "Name": {}, + "Arn": {}, + "LayersCount": { + "type": "integer" + }, + "AppsCount": { + "type": "integer" + }, + "InstancesCount": { + "type": "structure", + "members": { + "Assigning": { + "type": "integer" + }, + "Booting": { + "type": "integer" + }, + "ConnectionLost": { + "type": "integer" + }, + "Deregistering": { + "type": "integer" + }, + "Online": { + "type": "integer" + }, + "Pending": { + "type": "integer" + }, + "Rebooting": { + "type": "integer" + }, + "Registered": { + "type": "integer" + }, + "Registering": { + "type": "integer" + }, + "Requested": { + "type": "integer" + }, + "RunningSetup": { + "type": "integer" + }, + "SetupFailed": { + "type": "integer" + }, + "ShuttingDown": { + "type": "integer" + }, + "StartFailed": { + "type": "integer" + }, + "StopFailed": { + "type": "integer" + }, + "Stopped": { + "type": "integer" + }, + "Stopping": { + "type": "integer" + }, + "Terminated": { + "type": "integer" + }, + "Terminating": { + "type": "integer" + }, + "Unassigning": { + "type": "integer" + } + } + } + } + } + } + } + }, + "DescribeStacks": { + "input": { + "type": "structure", + "members": { + "StackIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Stacks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackId": {}, + "Name": {}, + "Arn": {}, + "Region": {}, + "VpcId": {}, + "Attributes": { + "shape": "S8" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "Sa" + }, + "ChefConfiguration": { + "shape": "Sb" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sd" + }, + "DefaultSshKeyName": {}, + "CreatedAt": {}, + "DefaultRootDeviceType": {}, + "AgentVersion": {} + } + } + } + } + } + }, + "DescribeTimeBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "TimeBasedAutoScalingConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "AutoScalingSchedule": { + "shape": "S4b" + } + } + } + } + } + } + }, + "DescribeUserProfiles": { + "input": { + "type": "structure", + "members": { + "IamUserArns": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserProfiles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IamUserArn": {}, + "Name": {}, + "SshUsername": {}, + "SshPublicKey": {}, + "AllowSelfManagement": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeVolumes": { + "input": { + "type": "structure", + "members": { + "InstanceId": {}, + "StackId": {}, + "RaidArrayId": {}, + "VolumeIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Volumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeId": {}, + "Ec2VolumeId": {}, + "Name": {}, + "RaidArrayId": {}, + "InstanceId": {}, + "Status": {}, + "Size": { + "type": "integer" + }, + "Device": {}, + "MountPoint": {}, + "Region": {}, + "AvailabilityZone": {}, + "VolumeType": {}, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + } + } + } + } + }, + "DetachElasticLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "ElasticLoadBalancerName", + "LayerId" + ], + "members": { + "ElasticLoadBalancerName": {}, + "LayerId": {} + } + } + }, + "DisassociateElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {} + } + } + }, + "GetHostnameSuggestion": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {} + } + }, + "output": { + "type": "structure", + "members": { + "LayerId": {}, + "Hostname": {} + } + } + }, + "GrantAccess": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "ValidForInMinutes": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TemporaryCredential": { + "type": "structure", + "members": { + "Username": {}, + "Password": {}, + "ValidForInMinutes": { + "type": "integer" + }, + "InstanceId": {} + } + } + } + } + }, + "ListTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S50" + }, + "NextToken": {} + } + } + }, + "RebootInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + } + }, + "RegisterEcsCluster": { + "input": { + "type": "structure", + "required": [ + "EcsClusterArn", + "StackId" + ], + "members": { + "EcsClusterArn": {}, + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "EcsClusterArn": {} + } + } + }, + "RegisterElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp", + "StackId" + ], + "members": { + "ElasticIp": {}, + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ElasticIp": {} + } + } + }, + "RegisterInstance": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {}, + "Hostname": {}, + "PublicIp": {}, + "PrivateIp": {}, + "RsaPublicKey": {}, + "RsaPublicKeyFingerprint": {}, + "InstanceIdentity": { + "type": "structure", + "members": { + "Document": {}, + "Signature": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": {} + } + } + }, + "RegisterRdsDbInstance": { + "input": { + "type": "structure", + "required": [ + "StackId", + "RdsDbInstanceArn", + "DbUser", + "DbPassword" + ], + "members": { + "StackId": {}, + "RdsDbInstanceArn": {}, + "DbUser": {}, + "DbPassword": {} + } + } + }, + "RegisterVolume": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "Ec2VolumeId": {}, + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeId": {} + } + } + }, + "SetLoadBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {}, + "Enable": { + "type": "boolean" + }, + "UpScaling": { + "shape": "S36" + }, + "DownScaling": { + "shape": "S36" + } + } + } + }, + "SetPermission": { + "input": { + "type": "structure", + "required": [ + "StackId", + "IamUserArn" + ], + "members": { + "StackId": {}, + "IamUserArn": {}, + "AllowSsh": { + "type": "boolean" + }, + "AllowSudo": { + "type": "boolean" + }, + "Level": {} + } + } + }, + "SetTimeBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "AutoScalingSchedule": { + "shape": "S4b" + } + } + } + }, + "StartInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + } + }, + "StartStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + } + }, + "StopInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "Force": { + "type": "boolean" + } + } + } + }, + "StopStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S50" + } + } + } + }, + "UnassignInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + } + }, + "UnassignVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {} + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "UpdateApp": { + "input": { + "type": "structure", + "required": [ + "AppId" + ], + "members": { + "AppId": {}, + "Name": {}, + "Description": {}, + "DataSources": { + "shape": "Si" + }, + "Type": {}, + "AppSource": { + "shape": "Sd" + }, + "Domains": { + "shape": "S3" + }, + "EnableSsl": { + "type": "boolean" + }, + "SslConfiguration": { + "shape": "Sl" + }, + "Attributes": { + "shape": "Sm" + }, + "Environment": { + "shape": "So" + } + } + } + }, + "UpdateElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {}, + "Name": {} + } + } + }, + "UpdateInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "LayerIds": { + "shape": "S3" + }, + "InstanceType": {}, + "AutoScalingType": {}, + "Hostname": {}, + "Os": {}, + "AmiId": {}, + "SshKeyName": {}, + "Architecture": {}, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "EbsOptimized": { + "type": "boolean" + }, + "AgentVersion": {} + } + } + }, + "UpdateLayer": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {}, + "Name": {}, + "Shortname": {}, + "Attributes": { + "shape": "S17" + }, + "CloudWatchLogsConfiguration": { + "shape": "S19" + }, + "CustomInstanceProfileArn": {}, + "CustomJson": {}, + "CustomSecurityGroupIds": { + "shape": "S3" + }, + "Packages": { + "shape": "S3" + }, + "VolumeConfigurations": { + "shape": "S1f" + }, + "EnableAutoHealing": { + "type": "boolean" + }, + "AutoAssignElasticIps": { + "type": "boolean" + }, + "AutoAssignPublicIps": { + "type": "boolean" + }, + "CustomRecipes": { + "shape": "S1h" + }, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "UseEbsOptimizedInstances": { + "type": "boolean" + }, + "LifecycleEventConfiguration": { + "shape": "S1i" + } + } + } + }, + "UpdateMyUserProfile": { + "input": { + "type": "structure", + "members": { + "SshPublicKey": {} + } + } + }, + "UpdateRdsDbInstance": { + "input": { + "type": "structure", + "required": [ + "RdsDbInstanceArn" + ], + "members": { + "RdsDbInstanceArn": {}, + "DbUser": {}, + "DbPassword": {} + } + } + }, + "UpdateStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {}, + "Name": {}, + "Attributes": { + "shape": "S8" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "Sa" + }, + "ChefConfiguration": { + "shape": "Sb" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sd" + }, + "DefaultSshKeyName": {}, + "DefaultRootDeviceType": {}, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "AgentVersion": {} + } + } + }, + "UpdateUserProfile": { + "input": { + "type": "structure", + "required": [ + "IamUserArn" + ], + "members": { + "IamUserArn": {}, + "SshUsername": {}, + "SshPublicKey": {}, + "AllowSelfManagement": { + "type": "boolean" + } + } + } + }, + "UpdateVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {}, + "Name": {}, + "MountPoint": {} + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": {} + }, + "S8": { + "type": "map", + "key": {}, + "value": {} + }, + "Sa": { + "type": "structure", + "members": { + "Name": {}, + "Version": {} + } + }, + "Sb": { + "type": "structure", + "members": { + "ManageBerkshelf": { + "type": "boolean" + }, + "BerkshelfVersion": {} + } + }, + "Sd": { + "type": "structure", + "members": { + "Type": {}, + "Url": {}, + "Username": {}, + "Password": {}, + "SshKey": {}, + "Revision": {} + } + }, + "Si": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Arn": {}, + "DatabaseName": {} + } + } + }, + "Sl": { + "type": "structure", + "required": [ + "Certificate", + "PrivateKey" + ], + "members": { + "Certificate": {}, + "PrivateKey": {}, + "Chain": {} + } + }, + "Sm": { + "type": "map", + "key": {}, + "value": {} + }, + "So": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {}, + "Secure": { + "type": "boolean" + } + } + } + }, + "Ss": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Args": { + "type": "map", + "key": {}, + "value": { + "shape": "S3" + } + } + } + }, + "Sz": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DeviceName": {}, + "NoDevice": {}, + "VirtualName": {}, + "Ebs": { + "type": "structure", + "members": { + "SnapshotId": {}, + "Iops": { + "type": "integer" + }, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": {}, + "DeleteOnTermination": { + "type": "boolean" + } + } + } + } + } + }, + "S17": { + "type": "map", + "key": {}, + "value": {} + }, + "S19": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "LogStreams": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LogGroupName": {}, + "DatetimeFormat": {}, + "TimeZone": {}, + "File": {}, + "FileFingerprintLines": {}, + "MultiLineStartPattern": {}, + "InitialPosition": {}, + "Encoding": {}, + "BufferDuration": { + "type": "integer" + }, + "BatchCount": { + "type": "integer" + }, + "BatchSize": { + "type": "integer" + } + } + } + } + } + }, + "S1f": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "MountPoint", + "NumberOfDisks", + "Size" + ], + "members": { + "MountPoint": {}, + "RaidLevel": { + "type": "integer" + }, + "NumberOfDisks": { + "type": "integer" + }, + "Size": { + "type": "integer" + }, + "VolumeType": {}, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + } + }, + "S1h": { + "type": "structure", + "members": { + "Setup": { + "shape": "S3" + }, + "Configure": { + "shape": "S3" + }, + "Deploy": { + "shape": "S3" + }, + "Undeploy": { + "shape": "S3" + }, + "Shutdown": { + "shape": "S3" + } + } + }, + "S1i": { + "type": "structure", + "members": { + "Shutdown": { + "type": "structure", + "members": { + "ExecutionTimeout": { + "type": "integer" + }, + "DelayUntilElbConnectionsDrained": { + "type": "boolean" + } + } + } + } + }, + "S36": { + "type": "structure", + "members": { + "InstanceCount": { + "type": "integer" + }, + "ThresholdsWaitTime": { + "type": "integer" + }, + "IgnoreMetricsTime": { + "type": "integer" + }, + "CpuThreshold": { + "type": "double" + }, + "MemoryThreshold": { + "type": "double" + }, + "LoadThreshold": { + "type": "double" + }, + "Alarms": { + "shape": "S3" + } + } + }, + "S4b": { + "type": "structure", + "members": { + "Monday": { + "shape": "S4c" + }, + "Tuesday": { + "shape": "S4c" + }, + "Wednesday": { + "shape": "S4c" + }, + "Thursday": { + "shape": "S4c" + }, + "Friday": { + "shape": "S4c" + }, + "Saturday": { + "shape": "S4c" + }, + "Sunday": { + "shape": "S4c" + } + } + }, + "S4c": { + "type": "map", + "key": {}, + "value": {} + }, + "S50": { + "type": "map", + "key": {}, + "value": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/opsworks-2013-02-18.paginators.json b/node_modules/aws-sdk/apis/opsworks-2013-02-18.paginators.json new file mode 100644 index 0000000..775589a --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworks-2013-02-18.paginators.json @@ -0,0 +1,55 @@ +{ + "pagination": { + "DescribeApps": { + "result_key": "Apps" + }, + "DescribeCommands": { + "result_key": "Commands" + }, + "DescribeDeployments": { + "result_key": "Deployments" + }, + "DescribeEcsClusters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EcsClusters" + }, + "DescribeElasticIps": { + "result_key": "ElasticIps" + }, + "DescribeElasticLoadBalancers": { + "result_key": "ElasticLoadBalancers" + }, + "DescribeInstances": { + "result_key": "Instances" + }, + "DescribeLayers": { + "result_key": "Layers" + }, + "DescribeLoadBasedAutoScaling": { + "result_key": "LoadBasedAutoScalingConfigurations" + }, + "DescribePermissions": { + "result_key": "Permissions" + }, + "DescribeRaidArrays": { + "result_key": "RaidArrays" + }, + "DescribeServiceErrors": { + "result_key": "ServiceErrors" + }, + "DescribeStacks": { + "result_key": "Stacks" + }, + "DescribeTimeBasedAutoScaling": { + "result_key": "TimeBasedAutoScalingConfigurations" + }, + "DescribeUserProfiles": { + "result_key": "UserProfiles" + }, + "DescribeVolumes": { + "result_key": "Volumes" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/opsworks-2013-02-18.waiters2.json b/node_modules/aws-sdk/apis/opsworks-2013-02-18.waiters2.json new file mode 100644 index 0000000..1b9dfaa --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworks-2013-02-18.waiters2.json @@ -0,0 +1,289 @@ +{ + "version": 2, + "waiters": { + "AppExists": { + "delay": 1, + "operation": "DescribeApps", + "maxAttempts": 40, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "matcher": "status", + "expected": 400, + "state": "failure" + } + ] + }, + "DeploymentSuccessful": { + "delay": 15, + "operation": "DescribeDeployments", + "maxAttempts": 40, + "description": "Wait until a deployment has completed successfully.", + "acceptors": [ + { + "expected": "successful", + "matcher": "pathAll", + "state": "success", + "argument": "Deployments[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Deployments[].Status" + } + ] + }, + "InstanceOnline": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is online.", + "acceptors": [ + { + "expected": "online", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "shutting_down", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "start_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopped", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminating", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stop_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + }, + "InstanceRegistered": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is registered.", + "acceptors": [ + { + "expected": "registered", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "shutting_down", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopped", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminating", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stop_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is stopped.", + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "booting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "requested", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "running_setup", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "start_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stop_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is terminated.", + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + }, + { + "expected": "booting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "online", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "requested", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "running_setup", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "start_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.examples.json b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.min.json b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.min.json new file mode 100644 index 0000000..5f55b06 --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.min.json @@ -0,0 +1,514 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-01", + "endpointPrefix": "opsworks-cm", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "OpsWorksCM", + "serviceFullName": "AWS OpsWorks for Chef Automate", + "serviceId": "OpsWorksCM", + "signatureVersion": "v4", + "signingName": "opsworks-cm", + "targetPrefix": "OpsWorksCM_V2016_11_01", + "uid": "opsworkscm-2016-11-01" + }, + "operations": { + "AssociateNode": { + "input": { + "type": "structure", + "required": [ + "ServerName", + "NodeName", + "EngineAttributes" + ], + "members": { + "ServerName": {}, + "NodeName": {}, + "EngineAttributes": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "NodeAssociationStatusToken": {} + } + } + }, + "CreateBackup": { + "input": { + "type": "structure", + "required": [ + "ServerName" + ], + "members": { + "ServerName": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "Backup": { + "shape": "Sd" + } + } + } + }, + "CreateServer": { + "input": { + "type": "structure", + "required": [ + "ServerName", + "InstanceProfileArn", + "InstanceType", + "ServiceRoleArn" + ], + "members": { + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "DisableAutomatedBackup": { + "type": "boolean" + }, + "Engine": {}, + "EngineModel": {}, + "EngineVersion": {}, + "EngineAttributes": { + "shape": "S4" + }, + "BackupRetentionCount": { + "type": "integer" + }, + "ServerName": {}, + "InstanceProfileArn": {}, + "InstanceType": {}, + "KeyPair": {}, + "PreferredMaintenanceWindow": {}, + "PreferredBackupWindow": {}, + "SecurityGroupIds": { + "shape": "Sj" + }, + "ServiceRoleArn": {}, + "SubnetIds": { + "shape": "Sj" + }, + "BackupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Server": { + "shape": "Ss" + } + } + } + }, + "DeleteBackup": { + "input": { + "type": "structure", + "required": [ + "BackupId" + ], + "members": { + "BackupId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteServer": { + "input": { + "type": "structure", + "required": [ + "ServerName" + ], + "members": { + "ServerName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeAccountAttributes": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Maximum": { + "type": "integer" + }, + "Used": { + "type": "integer" + } + } + } + } + } + } + }, + "DescribeBackups": { + "input": { + "type": "structure", + "members": { + "BackupId": {}, + "ServerName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Backups": { + "type": "list", + "member": { + "shape": "Sd" + } + }, + "NextToken": {} + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "required": [ + "ServerName" + ], + "members": { + "ServerName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ServerEvents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CreatedAt": { + "type": "timestamp" + }, + "ServerName": {}, + "Message": {}, + "LogUrl": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeNodeAssociationStatus": { + "input": { + "type": "structure", + "required": [ + "NodeAssociationStatusToken", + "ServerName" + ], + "members": { + "NodeAssociationStatusToken": {}, + "ServerName": {} + } + }, + "output": { + "type": "structure", + "members": { + "NodeAssociationStatus": {}, + "EngineAttributes": { + "shape": "S4" + } + } + } + }, + "DescribeServers": { + "input": { + "type": "structure", + "members": { + "ServerName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Servers": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "NextToken": {} + } + } + }, + "DisassociateNode": { + "input": { + "type": "structure", + "required": [ + "ServerName", + "NodeName" + ], + "members": { + "ServerName": {}, + "NodeName": {}, + "EngineAttributes": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "NodeAssociationStatusToken": {} + } + } + }, + "ExportServerEngineAttribute": { + "input": { + "type": "structure", + "required": [ + "ExportAttributeName", + "ServerName" + ], + "members": { + "ExportAttributeName": {}, + "ServerName": {}, + "InputAttributes": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "EngineAttribute": { + "shape": "S5" + }, + "ServerName": {} + } + } + }, + "RestoreServer": { + "input": { + "type": "structure", + "required": [ + "BackupId", + "ServerName" + ], + "members": { + "BackupId": {}, + "ServerName": {}, + "InstanceType": {}, + "KeyPair": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartMaintenance": { + "input": { + "type": "structure", + "required": [ + "ServerName" + ], + "members": { + "ServerName": {}, + "EngineAttributes": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "Server": { + "shape": "Ss" + } + } + } + }, + "UpdateServer": { + "input": { + "type": "structure", + "required": [ + "ServerName" + ], + "members": { + "DisableAutomatedBackup": { + "type": "boolean" + }, + "BackupRetentionCount": { + "type": "integer" + }, + "ServerName": {}, + "PreferredMaintenanceWindow": {}, + "PreferredBackupWindow": {} + } + }, + "output": { + "type": "structure", + "members": { + "Server": { + "shape": "Ss" + } + } + } + }, + "UpdateServerEngineAttributes": { + "input": { + "type": "structure", + "required": [ + "ServerName", + "AttributeName" + ], + "members": { + "ServerName": {}, + "AttributeName": {}, + "AttributeValue": {} + } + }, + "output": { + "type": "structure", + "members": { + "Server": { + "shape": "Ss" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": { + "shape": "S5" + } + }, + "S5": { + "type": "structure", + "members": { + "Name": {}, + "Value": { + "type": "string", + "sensitive": true + } + } + }, + "Sd": { + "type": "structure", + "members": { + "BackupArn": {}, + "BackupId": {}, + "BackupType": {}, + "CreatedAt": { + "type": "timestamp" + }, + "Description": {}, + "Engine": {}, + "EngineModel": {}, + "EngineVersion": {}, + "InstanceProfileArn": {}, + "InstanceType": {}, + "KeyPair": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "S3DataSize": { + "deprecated": true, + "type": "integer" + }, + "S3DataUrl": { + "deprecated": true + }, + "S3LogUrl": {}, + "SecurityGroupIds": { + "shape": "Sj" + }, + "ServerName": {}, + "ServiceRoleArn": {}, + "Status": {}, + "StatusDescription": {}, + "SubnetIds": { + "shape": "Sj" + }, + "ToolsVersion": {}, + "UserArn": {} + } + }, + "Sj": { + "type": "list", + "member": {} + }, + "Ss": { + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "BackupRetentionCount": { + "type": "integer" + }, + "ServerName": {}, + "CreatedAt": { + "type": "timestamp" + }, + "CloudFormationStackArn": {}, + "DisableAutomatedBackup": { + "type": "boolean" + }, + "Endpoint": {}, + "Engine": {}, + "EngineModel": {}, + "EngineAttributes": { + "shape": "S4" + }, + "EngineVersion": {}, + "InstanceProfileArn": {}, + "InstanceType": {}, + "KeyPair": {}, + "MaintenanceStatus": {}, + "PreferredMaintenanceWindow": {}, + "PreferredBackupWindow": {}, + "SecurityGroupIds": { + "shape": "Sj" + }, + "ServiceRoleArn": {}, + "Status": {}, + "StatusReason": {}, + "SubnetIds": { + "shape": "Sj" + }, + "ServerArn": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.paginators.json b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.waiters2.json b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.waiters2.json new file mode 100644 index 0000000..f37dd04 --- /dev/null +++ b/node_modules/aws-sdk/apis/opsworkscm-2016-11-01.waiters2.json @@ -0,0 +1,25 @@ +{ + "version": 2, + "waiters": { + "NodeAssociated": { + "delay": 15, + "maxAttempts": 15, + "operation": "DescribeNodeAssociationStatus", + "description": "Wait until node is associated or disassociated.", + "acceptors": [ + { + "expected": "SUCCESS", + "state": "success", + "matcher": "path", + "argument": "NodeAssociationStatus" + }, + { + "expected": "FAILED", + "state": "failure", + "matcher": "path", + "argument": "NodeAssociationStatus" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/organizations-2016-11-28.examples.json b/node_modules/aws-sdk/apis/organizations-2016-11-28.examples.json new file mode 100644 index 0000000..8e39290 --- /dev/null +++ b/node_modules/aws-sdk/apis/organizations-2016-11-28.examples.json @@ -0,0 +1,1409 @@ +{ + "version": "1.0", + "examples": { + "AcceptHandshake": [ + { + "input": { + "HandshakeId": "h-examplehandshakeid111" + }, + "output": { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "20170228T1215Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": "20170214T1215Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "ALL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "ACCOUNT", + "Value": "222222222222" + } + ], + "State": "ACCEPTED" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Bill is the owner of an organization, and he invites Juan's account (222222222222) to join his organization. The following example shows Juan's account accepting the handshake and thus agreeing to the invitation.", + "id": "to-accept-a-handshake-from-another-account-1472500561150", + "title": "To accept a handshake from another account" + } + ], + "AttachPolicy": [ + { + "input": { + "PolicyId": "p-examplepolicyid111", + "TargetId": "ou-examplerootid111-exampleouid111" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to attach a service control policy (SCP) to an OU:\n", + "id": "to-attach-a-policy-to-an-ou", + "title": "To attach a policy to an OU" + }, + { + "input": { + "PolicyId": "p-examplepolicyid111", + "TargetId": "333333333333" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to attach a service control policy (SCP) to an account:\n", + "id": "to-attach-a-policy-to-an-account", + "title": "To attach a policy to an account" + } + ], + "CancelHandshake": [ + { + "input": { + "HandshakeId": "h-examplehandshakeid111" + }, + "output": { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "20170228T1215Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "susan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": "20170214T1215Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "CONSOLIDATED_BILLING" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "ACCOUNT", + "Value": "222222222222" + }, + { + "Type": "NOTES", + "Value": "This is a request for Susan's account to join Bob's organization." + } + ], + "State": "CANCELED" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:\n", + "id": "to-cancel-a-handshake-sent-to-a-member-account-1472501320506", + "title": "To cancel a handshake sent to a member account" + } + ], + "CreateAccount": [ + { + "input": { + "AccountName": "Production Account", + "Email": "susan@example.com" + }, + "output": { + "CreateAccountStatus": { + "Id": "car-examplecreateaccountrequestid111", + "State": "IN_PROGRESS" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name \"Production Account\" and an owner email address of susan@example.com. An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a \"Welcome to AWS\" email:\n\n", + "id": "to-create-a-new-account-that-is-automatically-part-of-the-organization-1472501463507", + "title": "To create a new account that is automatically part of the organization" + } + ], + "CreateOrganization": [ + { + "input": { + }, + "output": { + "Organization": { + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", + "AvailablePolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ], + "FeatureSet": "ALL", + "Id": "o-exampleorgid", + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "MasterAccountId": "111111111111" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:\n\n", + "id": "to-create-a-new-organization-with-all-features enabled", + "title": "To create a new organization with all features enabled" + }, + { + "input": { + "FeatureSet": "CONSOLIDATED_BILLING" + }, + "output": { + "Organization": { + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", + "AvailablePolicyTypes": [ + + ], + "FeatureSet": "CONSOLIDATED_BILLING", + "Id": "o-exampleorgid", + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "MasterAccountId": "111111111111" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "In the following example, Bill creates an organization using credentials from account 111111111111, and configures the organization to support only the consolidated billing feature set:\n\n", + "id": "to-create-a-new-organization-with-consolidated-billing-features-only", + "title": "To create a new organization with consolidated billing features only" + } + ], + "CreateOrganizationalUnit": [ + { + "input": { + "Name": "AccountingOU", + "ParentId": "r-examplerootid111" + }, + "output": { + "OrganizationalUnit": { + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Id": "ou-examplerootid111-exampleouid111", + "Name": "AccountingOU" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:\n\n", + "id": "to-create-a-new-organizational-unit", + "title": "To create a new organization unit" + } + ], + "CreatePolicy": [ + { + "input": { + "Content": "{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}", + "Description": "Enables admins of attached accounts to delegate all S3 permissions", + "Name": "AllowAllS3Actions", + "Type": "SERVICE_CONTROL_POLICY" + }, + "output": { + "Policy": { + "Content": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "Description": "Allows delegation of all S3 actions", + "Name": "AllowAllS3Actions", + "Type": "SERVICE_CONTROL_POLICY" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:\n\n", + "id": "to-create-a-service-control-policy", + "title": "To create a service control policy" + } + ], + "DeclineHandshake": [ + { + "input": { + "HandshakeId": "h-examplehandshakeid111" + }, + "output": { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "2016-12-15T19:27:58Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "222222222222", + "Type": "ACCOUNT" + }, + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + } + ], + "RequestedTimestamp": "2016-11-30T19:27:58Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "ACCOUNT", + "Value": "222222222222" + }, + { + "Type": "NOTES", + "Value": "This is an invitation to Susan's account to join the Bill's organization." + } + ], + "State": "DECLINED" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED:", + "id": "to-decline-a-handshake-sent-from-the-master-account-1472502666967", + "title": "To decline a handshake sent from the master account" + } + ], + "DeleteOrganizationalUnit": [ + { + "input": { + "OrganizationalUnitId": "ou-examplerootid111-exampleouid111" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:\n\n", + "id": "to-delete-an-organizational-unit", + "title": "To delete an organization unit" + } + ], + "DeletePolicy": [ + { + "input": { + "PolicyId": "p-examplepolicyid111" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:\n\n", + "id": "to-delete-a-policy", + "title": "To delete a policy" + } + ], + "DescribeAccount": [ + { + "input": { + "AccountId": "555555555555" + }, + "output": { + "Account": { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", + "Email": "anika@example.com", + "Id": "555555555555", + "Name": "Beta Account" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows a user in the master account (111111111111) asking for details about account 555555555555:", + "id": "to-get-the-details-about-an-account-1472503166868", + "title": "To get the details about an account" + } + ], + "DescribeCreateAccountStatus": [ + { + "input": { + "CreateAccountRequestId": "car-exampleaccountcreationrequestid" + }, + "output": { + "CreateAccountStatus": { + "AccountId": "333333333333", + "Id": "car-exampleaccountcreationrequestid", + "State": "SUCCEEDED" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization's master account. In the example, the specified \"createAccountRequestId\" comes from the response of the original call to \"CreateAccount\":", + "id": "to-get-information-about-a-request-to-create-an-account-1472503727223", + "title": "To get information about a request to create an account" + } + ], + "DescribeHandshake": [ + { + "input": { + "HandshakeId": "h-examplehandshakeid111" + }, + "output": { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "2016-11-30T17:24:58.046Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "333333333333", + "Type": "ACCOUNT" + } + ], + "RequestedTimestamp": "2016-11-30T17:24:58.046Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "ACCOUNT", + "Value": "333333333333" + } + ], + "State": "OPEN" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to \"InviteAccountToOrganization\", or from a call to \"ListHandshakesForAccount\" or \"ListHandshakesForOrganization\":", + "id": "to-get-information-about-a-handshake-1472503400505", + "title": "To get information about a handshake" + } + ], + "DescribeOrganization": [ + { + "output": { + "Organization": { + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", + "AvailablePolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ], + "FeatureSet": "ALL", + "Id": "o-exampleorgid", + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request information about the current user's organization:/n/n", + "id": "to-get-information-about-an-organization-1472503400505", + "title": "To get information about an organization" + } + ], + "DescribeOrganizationalUnit": [ + { + "input": { + "OrganizationalUnitId": "ou-examplerootid111-exampleouid111" + }, + "output": { + "OrganizationalUnit": { + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Id": "ou-examplerootid111-exampleouid111", + "Name": "Accounting Group" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request details about an OU:/n/n", + "id": "to-get-information-about-an-organizational-unit", + "title": "To get information about an organizational unit" + } + ], + "DescribePolicy": [ + { + "input": { + "PolicyId": "p-examplepolicyid111" + }, + "output": { + "Policy": { + "Content": "{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": \\\"*\\\",\\n \\\"Resource\\\": \\\"*\\\"\\n }\\n ]\\n}", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "AwsManaged": false, + "Description": "Enables admins to delegate S3 permissions", + "Id": "p-examplepolicyid111", + "Name": "AllowAllS3Actions", + "Type": "SERVICE_CONTROL_POLICY" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request information about a policy:/n/n", + "id": "to-get-information-about-a-policy", + "title": "To get information about a policy" + } + ], + "DetachPolicy": [ + { + "input": { + "PolicyId": "p-examplepolicyid111", + "TargetId": "ou-examplerootid111-exampleouid111" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to detach a policy from an OU:/n/n", + "id": "to-detach-a-policy-from-a-root-ou-or-account", + "title": "To detach a policy from a root, OU, or account" + } + ], + "DisablePolicyType": [ + { + "input": { + "PolicyType": "SERVICE_CONTROL_POLICY", + "RootId": "r-examplerootid111" + }, + "output": { + "Root": { + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Id": "r-examplerootid111", + "Name": "Root", + "PolicyTypes": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to disable the service control policy (SCP) policy type in a root. The response shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY:/n/n", + "id": "to-disable-a-policy-type-in-a-root", + "title": "To disable a policy type in a root" + } + ], + "EnableAllFeatures": [ + { + "input": { + }, + "output": { + "Handshake": { + "Action": "ENABLE_ALL_FEATURES", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", + "ExpirationTimestamp": "2017-02-28T09:35:40.05Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + } + ], + "RequestedTimestamp": "2017-02-13T09:35:40.05Z", + "Resources": [ + { + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + } + ], + "State": "REQUESTED" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows the administrator asking all the invited accounts in the organization to approve enabling all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to enable all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts:/n/n", + "id": "to-enable-all-features-in-an-organization", + "title": "To enable all features in an organization" + } + ], + "EnablePolicyType": [ + { + "input": { + "PolicyType": "SERVICE_CONTROL_POLICY", + "RootId": "r-examplerootid111" + }, + "output": { + "Root": { + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Id": "r-examplerootid111", + "Name": "Root", + "PolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to enable the service control policy (SCP) policy type in a root. The output shows a root object with a PolicyTypes response element showing that SCPs are now enabled:/n/n", + "id": "to-enable-a-policy-type-in-a-root", + "title": "To enable a policy type in a root" + } + ], + "InviteAccountToOrganization": [ + { + "input": { + "Notes": "This is a request for Juan's account to join Bill's organization", + "Target": { + "Id": "juan@example.com", + "Type": "EMAIL" + } + }, + "output": { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "2017-02-16T09:36:05.02Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": "2017-02-01T09:36:05.02Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "OPEN" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows the admin of the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization.", + "id": "to-invite-an-account-to-join-an-organization-1472508594110", + "title": "To invite an account to join an organization" + } + ], + "LeaveOrganization": [ + { + "comments": { + "input": { + }, + "output": { + } + }, + "description": "TThe following example shows how to remove your member account from an organization:", + "id": "to-leave-an-organization-as-a-member-account-1472508784736", + "title": "To leave an organization as a member account" + } + ], + "ListAccounts": [ + { + "input": { + }, + "output": { + "Accounts": [ + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "Email": "bill@example.com", + "Id": "111111111111", + "JoinedMethod": "INVITED", + "JoinedTimestamp": "20161215T193015Z", + "Name": "Master Account", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222", + "Email": "alice@example.com", + "Id": "222222222222", + "JoinedMethod": "INVITED", + "JoinedTimestamp": "20161215T210221Z", + "Name": "Developer Account", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", + "Email": "juan@example.com", + "Id": "333333333333", + "JoinedMethod": "INVITED", + "JoinedTimestamp": "20161215T210347Z", + "Name": "Test Account", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", + "Email": "anika@example.com", + "Id": "444444444444", + "JoinedMethod": "INVITED", + "JoinedTimestamp": "20161215T210332Z", + "Name": "Production Account", + "Status": "ACTIVE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to request a list of the accounts in an organization:", + "id": "to-retrieve-a-list-of-all-of-the-accounts-in-an-organization-1472509590974", + "title": "To retrieve a list of all of the accounts in an organization" + } + ], + "ListAccountsForParent": [ + { + "input": { + "ParentId": "ou-examplerootid111-exampleouid111" + }, + "output": { + "Accounts": [ + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", + "Email": "juan@example.com", + "Id": "333333333333", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835795.536, + "Name": "Development Account", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", + "Email": "anika@example.com", + "Id": "444444444444", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835812.143, + "Name": "Test Account", + "Status": "ACTIVE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request a list of the accounts in an OU:/n/n", + "id": "to-retrieve-a-list-of-all-of-the-accounts-in-a-root-or-ou-1472509590974", + "title": "To retrieve a list of all of the accounts in a root or OU" + } + ], + "ListChildren": [ + { + "input": { + "ChildType": "ORGANIZATIONAL_UNIT", + "ParentId": "ou-examplerootid111-exampleouid111" + }, + "output": { + "Children": [ + { + "Id": "ou-examplerootid111-exampleouid111", + "Type": "ORGANIZATIONAL_UNIT" + }, + { + "Id": "ou-examplerootid111-exampleouid222", + "Type": "ORGANIZATIONAL_UNIT" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request a list of the child OUs in a parent root or OU:/n/n", + "id": "to-retrieve-a-list-of-all-of-the-child-accounts-and-OUs-in-a-parent-container", + "title": "To retrieve a list of all of the child accounts and OUs in a parent root or OU" + } + ], + "ListCreateAccountStatus": [ + { + "input": { + "States": [ + "SUCCEEDED" + ] + }, + "output": { + "CreateAccountStatuses": [ + { + "AccountId": "444444444444", + "AccountName": "Developer Test Account", + "CompletedTimestamp": "2017-01-15T13:45:23.6Z", + "Id": "car-exampleaccountcreationrequestid1", + "RequestedTimestamp": "2017-01-15T13:45:23.01Z", + "State": "SUCCEEDED" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows a user requesting a list of only the completed account creation requests made for the current organization:", + "id": "to-get-a-list-of-completed-account-creation-requests-made-in-the-organization", + "title": "To get a list of completed account creation requests made in the organization" + }, + { + "input": { + "States": [ + "IN_PROGRESS" + ] + }, + "output": { + "CreateAccountStatuses": [ + { + "AccountName": "Production Account", + "Id": "car-exampleaccountcreationrequestid2", + "RequestedTimestamp": "2017-01-15T13:45:23.01Z", + "State": "IN_PROGRESS" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:", + "id": "to-get-a-list-of-all-account-creation-requests-made-in-the-organization-1472509174532", + "title": "To get a list of all account creation requests made in the organization" + } + ], + "ListHandshakesForAccount": [ + { + "output": { + "Handshakes": [ + { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "2017-01-28T14:35:23.3Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": "2017-01-13T14:35:23.3Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "OPEN" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:", + "id": "to-retrieve-a-list-of-the-handshakes-sent-to-an-account-1472510214747", + "title": "To retrieve a list of the handshakes sent to an account" + } + ], + "ListHandshakesForOrganization": [ + { + "output": { + "Handshakes": [ + { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "2017-01-28T14:35:23.3Z", + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": "2017-01-13T14:35:23.3Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "OPEN" + }, + { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": "2017-01-28T14:35:23.3Z", + "Id": "h-examplehandshakeid222", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "anika@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": "2017-01-13T14:35:23.3Z", + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "anika@example.com" + }, + { + "Type": "NOTES", + "Value": "This is an invitation to Anika's account to join Bill's organization." + } + ], + "State": "ACCEPTED" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to get a list of handshakes associated with the current organization:", + "id": "to-retrieve-a-list-of-the-handshakes-associated-with-an-organization-1472511206653", + "title": "To retrieve a list of the handshakes associated with an organization" + } + ], + "ListOrganizationalUnitsForParent": [ + { + "input": { + "ParentId": "r-examplerootid111" + }, + "output": { + "OrganizationalUnits": [ + { + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111", + "Id": "ou-examplerootid111-exampleouid111", + "Name": "Development" + }, + { + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222", + "Id": "ou-examplerootid111-exampleouid222", + "Name": "Production" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to get a list of OUs in a specified root:/n/n", + "id": "to-retrieve-a-list-of-all-of-the-OUs-in-a-parent-container", + "title": "To retrieve a list of all of the child OUs in a parent root or OU" + } + ], + "ListParents": [ + { + "input": { + "ChildId": "444444444444" + }, + "output": { + "Parents": [ + { + "Id": "ou-examplerootid111-exampleouid111", + "Type": "ORGANIZATIONAL_UNIT" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to list the root or OUs that contain account 444444444444:/n/n", + "id": "to-retrieve-a-list-of-all-of-the-parents-of-a-child-ou-or-account", + "title": "To retrieve a list of all of the parents of a child OU or account" + } + ], + "ListPolicies": [ + { + "input": { + "Filter": "SERVICE_CONTROL_POLICY" + }, + "output": { + "Policies": [ + { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "AwsManaged": false, + "Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts.", + "Id": "p-examplepolicyid111", + "Name": "AllowAllS3Actions", + "Type": "SERVICE_CONTROL_POLICY" + }, + { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222", + "AwsManaged": false, + "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.", + "Id": "p-examplepolicyid222", + "Name": "AllowAllEC2Actions", + "Type": "SERVICE_CONTROL_POLICY" + }, + { + "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess", + "AwsManaged": true, + "Description": "Allows access to every operation", + "Id": "p-FullAWSAccess", + "Name": "FullAWSAccess", + "Type": "SERVICE_CONTROL_POLICY" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to get a list of service control policies (SCPs):/n/n", + "id": "to-retrieve-a-list-of--policies-in-the-organization", + "title": "To retrieve a list policies in the organization" + } + ], + "ListPoliciesForTarget": [ + { + "input": { + "Filter": "SERVICE_CONTROL_POLICY", + "TargetId": "444444444444" + }, + "output": { + "Policies": [ + { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222", + "AwsManaged": false, + "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.", + "Id": "p-examplepolicyid222", + "Name": "AllowAllEC2Actions", + "Type": "SERVICE_CONTROL_POLICY" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n", + "id": "to-retrieve-a-list-of-policies-attached-to-a-root-ou-or-account", + "title": "To retrieve a list policies attached to a root, OU, or account" + } + ], + "ListRoots": [ + { + "input": { + }, + "output": { + "Roots": [ + { + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Id": "r-examplerootid111", + "Name": "Root", + "PolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to get the list of the roots in the current organization:/n/n", + "id": "to-retrieve-a-list-of-roots-in-the-organization", + "title": "To retrieve a list of roots in the organization" + } + ], + "ListTargetsForPolicy": [ + { + "input": { + "PolicyId": "p-FullAWSAccess" + }, + "output": { + "Targets": [ + { + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Name": "Root", + "TargetId": "r-examplerootid111", + "Type": "ROOT" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;", + "Name": "Developer Test Account", + "TargetId": "333333333333", + "Type": "ACCOUNT" + }, + { + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Name": "Accounting", + "TargetId": "ou-examplerootid111-exampleouid111", + "Type": "ORGANIZATIONAL_UNIT" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n", + "id": "to-retrieve-a-list-of-roots-ous-and-accounts-to-which-a-policy-is-attached", + "title": "To retrieve a list of roots, OUs, and accounts to which a policy is attached" + } + ], + "MoveAccount": [ + { + "input": { + "AccountId": "333333333333", + "DestinationParentId": "ou-examplerootid111-exampleouid111", + "SourceParentId": "r-examplerootid111" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to move a member account from the root to an OU:/n/n", + "id": "to-move-an-ou-or-account-to-another-ou-or-the-root", + "title": "To move an OU or account to another OU or the root" + } + ], + "RemoveAccountFromOrganization": [ + { + "input": { + "AccountId": "333333333333" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to remove an account from an organization:", + "id": "to-remove-an-account-from-an-organization-as-the-master-account", + "title": "To remove an account from an organization as the master account" + } + ], + "UpdateOrganizationalUnit": [ + { + "input": { + "Name": "AccountingOU", + "OrganizationalUnitId": "ou-examplerootid111-exampleouid111" + }, + "output": { + "OrganizationalUnit": { + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Id": "ou-examplerootid111-exampleouid111", + "Name": "AccountingOU" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to rename an OU. The output confirms the new name:/n/n", + "id": "to-rename-an-organizational-unit", + "title": "To rename an organizational unit" + } + ], + "UpdatePolicy": [ + { + "input": { + "Description": "This description replaces the original.", + "Name": "Renamed-Policy", + "PolicyId": "p-examplepolicyid111" + }, + "output": { + "Policy": { + "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "AwsManaged": false, + "Description": "This description replaces the original.", + "Id": "p-examplepolicyid111", + "Name": "Renamed-Policy", + "Type": "SERVICE_CONTROL_POLICY" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n", + "id": "to-update-the-details-of-a-policy", + "title": "To update the details of a policy" + }, + { + "input": { + "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", + "PolicyId": "p-examplepolicyid111" + }, + "output": { + "Policy": { + "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "AwsManaged": false, + "Description": "This description replaces the original.", + "Id": "p-examplepolicyid111", + "Name": "Renamed-Policy", + "Type": "SERVICE_CONTROL_POLICY" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n", + "id": "to-update-the-content-of-a-policy", + "title": "To update the content of a policy" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/organizations-2016-11-28.min.json b/node_modules/aws-sdk/apis/organizations-2016-11-28.min.json new file mode 100644 index 0000000..a555ea8 --- /dev/null +++ b/node_modules/aws-sdk/apis/organizations-2016-11-28.min.json @@ -0,0 +1,1052 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-28", + "endpointPrefix": "organizations", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Organizations", + "serviceFullName": "AWS Organizations", + "serviceId": "Organizations", + "signatureVersion": "v4", + "targetPrefix": "AWSOrganizationsV20161128", + "uid": "organizations-2016-11-28" + }, + "operations": { + "AcceptHandshake": { + "input": { + "type": "structure", + "required": [ + "HandshakeId" + ], + "members": { + "HandshakeId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Handshake": { + "shape": "S4" + } + } + } + }, + "AttachPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId", + "TargetId" + ], + "members": { + "PolicyId": {}, + "TargetId": {} + } + } + }, + "CancelHandshake": { + "input": { + "type": "structure", + "required": [ + "HandshakeId" + ], + "members": { + "HandshakeId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Handshake": { + "shape": "S4" + } + } + } + }, + "CreateAccount": { + "input": { + "type": "structure", + "required": [ + "Email", + "AccountName" + ], + "members": { + "Email": { + "shape": "Sn" + }, + "AccountName": { + "shape": "So" + }, + "RoleName": {}, + "IamUserAccessToBilling": {} + } + }, + "output": { + "type": "structure", + "members": { + "CreateAccountStatus": { + "shape": "Ss" + } + } + } + }, + "CreateGovCloudAccount": { + "input": { + "type": "structure", + "required": [ + "Email", + "AccountName" + ], + "members": { + "Email": { + "shape": "Sn" + }, + "AccountName": { + "shape": "So" + }, + "RoleName": {}, + "IamUserAccessToBilling": {} + } + }, + "output": { + "type": "structure", + "members": { + "CreateAccountStatus": { + "shape": "Ss" + } + } + } + }, + "CreateOrganization": { + "input": { + "type": "structure", + "members": { + "FeatureSet": {} + } + }, + "output": { + "type": "structure", + "members": { + "Organization": { + "shape": "S12" + } + } + } + }, + "CreateOrganizationalUnit": { + "input": { + "type": "structure", + "required": [ + "ParentId", + "Name" + ], + "members": { + "ParentId": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "OrganizationalUnit": { + "shape": "S1e" + } + } + } + }, + "CreatePolicy": { + "input": { + "type": "structure", + "required": [ + "Content", + "Description", + "Name", + "Type" + ], + "members": { + "Content": {}, + "Description": {}, + "Name": {}, + "Type": {} + } + }, + "output": { + "type": "structure", + "members": { + "Policy": { + "shape": "S1m" + } + } + } + }, + "DeclineHandshake": { + "input": { + "type": "structure", + "required": [ + "HandshakeId" + ], + "members": { + "HandshakeId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Handshake": { + "shape": "S4" + } + } + } + }, + "DeleteOrganization": {}, + "DeleteOrganizationalUnit": { + "input": { + "type": "structure", + "required": [ + "OrganizationalUnitId" + ], + "members": { + "OrganizationalUnitId": {} + } + } + }, + "DeletePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {} + } + } + }, + "DescribeAccount": { + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Account": { + "shape": "S1w" + } + } + } + }, + "DescribeCreateAccountStatus": { + "input": { + "type": "structure", + "required": [ + "CreateAccountRequestId" + ], + "members": { + "CreateAccountRequestId": {} + } + }, + "output": { + "type": "structure", + "members": { + "CreateAccountStatus": { + "shape": "Ss" + } + } + } + }, + "DescribeHandshake": { + "input": { + "type": "structure", + "required": [ + "HandshakeId" + ], + "members": { + "HandshakeId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Handshake": { + "shape": "S4" + } + } + } + }, + "DescribeOrganization": { + "output": { + "type": "structure", + "members": { + "Organization": { + "shape": "S12" + } + } + } + }, + "DescribeOrganizationalUnit": { + "input": { + "type": "structure", + "required": [ + "OrganizationalUnitId" + ], + "members": { + "OrganizationalUnitId": {} + } + }, + "output": { + "type": "structure", + "members": { + "OrganizationalUnit": { + "shape": "S1e" + } + } + } + }, + "DescribePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Policy": { + "shape": "S1m" + } + } + } + }, + "DetachPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId", + "TargetId" + ], + "members": { + "PolicyId": {}, + "TargetId": {} + } + } + }, + "DisableAWSServiceAccess": { + "input": { + "type": "structure", + "required": [ + "ServicePrincipal" + ], + "members": { + "ServicePrincipal": {} + } + } + }, + "DisablePolicyType": { + "input": { + "type": "structure", + "required": [ + "RootId", + "PolicyType" + ], + "members": { + "RootId": {}, + "PolicyType": {} + } + }, + "output": { + "type": "structure", + "members": { + "Root": { + "shape": "S2e" + } + } + } + }, + "EnableAWSServiceAccess": { + "input": { + "type": "structure", + "required": [ + "ServicePrincipal" + ], + "members": { + "ServicePrincipal": {} + } + } + }, + "EnableAllFeatures": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "Handshake": { + "shape": "S4" + } + } + } + }, + "EnablePolicyType": { + "input": { + "type": "structure", + "required": [ + "RootId", + "PolicyType" + ], + "members": { + "RootId": {}, + "PolicyType": {} + } + }, + "output": { + "type": "structure", + "members": { + "Root": { + "shape": "S2e" + } + } + } + }, + "InviteAccountToOrganization": { + "input": { + "type": "structure", + "required": [ + "Target" + ], + "members": { + "Target": { + "shape": "S7" + }, + "Notes": { + "type": "string", + "sensitive": true + } + } + }, + "output": { + "type": "structure", + "members": { + "Handshake": { + "shape": "S4" + } + } + } + }, + "LeaveOrganization": {}, + "ListAWSServiceAccessForOrganization": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "EnabledServicePrincipals": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ServicePrincipal": {}, + "DateEnabled": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListAccounts": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Accounts": { + "shape": "S2x" + }, + "NextToken": {} + } + } + }, + "ListAccountsForParent": { + "input": { + "type": "structure", + "required": [ + "ParentId" + ], + "members": { + "ParentId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Accounts": { + "shape": "S2x" + }, + "NextToken": {} + } + } + }, + "ListChildren": { + "input": { + "type": "structure", + "required": [ + "ParentId", + "ChildType" + ], + "members": { + "ParentId": {}, + "ChildType": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Children": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Type": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListCreateAccountStatus": { + "input": { + "type": "structure", + "members": { + "States": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "CreateAccountStatuses": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "NextToken": {} + } + } + }, + "ListHandshakesForAccount": { + "input": { + "type": "structure", + "members": { + "Filter": { + "shape": "S3b" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Handshakes": { + "shape": "S3d" + }, + "NextToken": {} + } + } + }, + "ListHandshakesForOrganization": { + "input": { + "type": "structure", + "members": { + "Filter": { + "shape": "S3b" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Handshakes": { + "shape": "S3d" + }, + "NextToken": {} + } + } + }, + "ListOrganizationalUnitsForParent": { + "input": { + "type": "structure", + "required": [ + "ParentId" + ], + "members": { + "ParentId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "OrganizationalUnits": { + "type": "list", + "member": { + "shape": "S1e" + } + }, + "NextToken": {} + } + } + }, + "ListParents": { + "input": { + "type": "structure", + "required": [ + "ChildId" + ], + "members": { + "ChildId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Parents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Type": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListPolicies": { + "input": { + "type": "structure", + "required": [ + "Filter" + ], + "members": { + "Filter": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policies": { + "shape": "S3q" + }, + "NextToken": {} + } + } + }, + "ListPoliciesForTarget": { + "input": { + "type": "structure", + "required": [ + "TargetId", + "Filter" + ], + "members": { + "TargetId": {}, + "Filter": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policies": { + "shape": "S3q" + }, + "NextToken": {} + } + } + }, + "ListRoots": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Roots": { + "type": "list", + "member": { + "shape": "S2e" + } + }, + "NextToken": {} + } + } + }, + "ListTargetsForPolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Targets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TargetId": {}, + "Arn": {}, + "Name": {}, + "Type": {} + } + } + }, + "NextToken": {} + } + } + }, + "MoveAccount": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "SourceParentId", + "DestinationParentId" + ], + "members": { + "AccountId": {}, + "SourceParentId": {}, + "DestinationParentId": {} + } + } + }, + "RemoveAccountFromOrganization": { + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": {} + } + } + }, + "UpdateOrganizationalUnit": { + "input": { + "type": "structure", + "required": [ + "OrganizationalUnitId" + ], + "members": { + "OrganizationalUnitId": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "OrganizationalUnit": { + "shape": "S1e" + } + } + } + }, + "UpdatePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyId" + ], + "members": { + "PolicyId": {}, + "Name": {}, + "Description": {}, + "Content": {} + } + }, + "output": { + "type": "structure", + "members": { + "Policy": { + "shape": "S1m" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Parties": { + "type": "list", + "member": { + "shape": "S7" + } + }, + "State": {}, + "RequestedTimestamp": { + "type": "timestamp" + }, + "ExpirationTimestamp": { + "type": "timestamp" + }, + "Action": {}, + "Resources": { + "shape": "Sd" + } + } + }, + "S7": { + "type": "structure", + "required": [ + "Id", + "Type" + ], + "members": { + "Id": { + "type": "string", + "sensitive": true + }, + "Type": {} + } + }, + "Sd": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": { + "type": "string", + "sensitive": true + }, + "Type": {}, + "Resources": { + "shape": "Sd" + } + } + } + }, + "Sn": { + "type": "string", + "sensitive": true + }, + "So": { + "type": "string", + "sensitive": true + }, + "Ss": { + "type": "structure", + "members": { + "Id": {}, + "AccountName": { + "shape": "So" + }, + "State": {}, + "RequestedTimestamp": { + "type": "timestamp" + }, + "CompletedTimestamp": { + "type": "timestamp" + }, + "AccountId": {}, + "GovCloudAccountId": {}, + "FailureReason": {} + } + }, + "S12": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "FeatureSet": {}, + "MasterAccountArn": {}, + "MasterAccountId": {}, + "MasterAccountEmail": { + "shape": "Sn" + }, + "AvailablePolicyTypes": { + "shape": "S16" + } + } + }, + "S16": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Status": {} + } + } + }, + "S1e": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {} + } + }, + "S1m": { + "type": "structure", + "members": { + "PolicySummary": { + "shape": "S1n" + }, + "Content": {} + } + }, + "S1n": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Description": {}, + "Type": {}, + "AwsManaged": { + "type": "boolean" + } + } + }, + "S1w": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Email": { + "shape": "Sn" + }, + "Name": { + "shape": "So" + }, + "Status": {}, + "JoinedMethod": {}, + "JoinedTimestamp": { + "type": "timestamp" + } + } + }, + "S2e": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "PolicyTypes": { + "shape": "S16" + } + } + }, + "S2x": { + "type": "list", + "member": { + "shape": "S1w" + } + }, + "S3b": { + "type": "structure", + "members": { + "ActionType": {}, + "ParentHandshakeId": {} + } + }, + "S3d": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "S3q": { + "type": "list", + "member": { + "shape": "S1n" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/organizations-2016-11-28.paginators.json b/node_modules/aws-sdk/apis/organizations-2016-11-28.paginators.json new file mode 100644 index 0000000..dd5602f --- /dev/null +++ b/node_modules/aws-sdk/apis/organizations-2016-11-28.paginators.json @@ -0,0 +1,69 @@ +{ + "pagination": { + "ListAWSServiceAccessForOrganization": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAccounts": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAccountsForParent": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListChildren": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListCreateAccountStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListHandshakesForAccount": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListHandshakesForOrganization": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListOrganizationalUnitsForParent": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListParents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPoliciesForTarget": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListRoots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTargetsForPolicy": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/pi-2018-02-27.examples.json b/node_modules/aws-sdk/apis/pi-2018-02-27.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/pi-2018-02-27.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/pi-2018-02-27.min.json b/node_modules/aws-sdk/apis/pi-2018-02-27.min.json new file mode 100644 index 0000000..5e512bd --- /dev/null +++ b/node_modules/aws-sdk/apis/pi-2018-02-27.min.json @@ -0,0 +1,230 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-02-27", + "endpointPrefix": "pi", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "AWS PI", + "serviceFullName": "AWS Performance Insights", + "serviceId": "PI", + "signatureVersion": "v4", + "signingName": "pi", + "targetPrefix": "PerformanceInsightsv20180227", + "uid": "pi-2018-02-27" + }, + "operations": { + "DescribeDimensionKeys": { + "input": { + "type": "structure", + "required": [ + "ServiceType", + "Identifier", + "StartTime", + "EndTime", + "Metric", + "GroupBy" + ], + "members": { + "ServiceType": {}, + "Identifier": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Metric": {}, + "PeriodInSeconds": { + "type": "integer" + }, + "GroupBy": { + "shape": "S6" + }, + "PartitionBy": { + "shape": "S6" + }, + "Filter": { + "shape": "S9" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AlignedStartTime": { + "type": "timestamp" + }, + "AlignedEndTime": { + "type": "timestamp" + }, + "PartitionKeys": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Dimensions" + ], + "members": { + "Dimensions": { + "shape": "Se" + } + } + } + }, + "Keys": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "Se" + }, + "Total": { + "type": "double" + }, + "Partitions": { + "type": "list", + "member": { + "type": "double" + } + } + } + } + }, + "NextToken": {} + } + } + }, + "GetResourceMetrics": { + "input": { + "type": "structure", + "required": [ + "ServiceType", + "Identifier", + "MetricQueries", + "StartTime", + "EndTime" + ], + "members": { + "ServiceType": {}, + "Identifier": {}, + "MetricQueries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Metric" + ], + "members": { + "Metric": {}, + "GroupBy": { + "shape": "S6" + }, + "Filter": { + "shape": "S9" + } + } + } + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "PeriodInSeconds": { + "type": "integer" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AlignedStartTime": { + "type": "timestamp" + }, + "AlignedEndTime": { + "type": "timestamp" + }, + "Identifier": {}, + "MetricList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": { + "type": "structure", + "required": [ + "Metric" + ], + "members": { + "Metric": {}, + "Dimensions": { + "shape": "Se" + } + } + }, + "DataPoints": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Timestamp", + "Value" + ], + "members": { + "Timestamp": { + "type": "timestamp" + }, + "Value": { + "type": "double" + } + } + } + } + } + } + }, + "NextToken": {} + } + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "required": [ + "Group" + ], + "members": { + "Group": {}, + "Dimensions": { + "type": "list", + "member": {} + }, + "Limit": { + "type": "integer" + } + } + }, + "S9": { + "type": "map", + "key": {}, + "value": {} + }, + "Se": { + "type": "map", + "key": {}, + "value": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/pi-2018-02-27.paginators.json b/node_modules/aws-sdk/apis/pi-2018-02-27.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/pi-2018-02-27.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/pinpoint-2016-12-01.examples.json b/node_modules/aws-sdk/apis/pinpoint-2016-12-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/pinpoint-2016-12-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json b/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json new file mode 100644 index 0000000..ee3ef65 --- /dev/null +++ b/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json @@ -0,0 +1,4502 @@ +{ + "metadata": { + "apiVersion": "2016-12-01", + "endpointPrefix": "pinpoint", + "signingName": "mobiletargeting", + "serviceFullName": "Amazon Pinpoint", + "serviceId": "Pinpoint", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "pinpoint-2016-12-01", + "signatureVersion": "v4" + }, + "operations": { + "CreateApp": { + "http": { + "requestUri": "/v1/apps", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "CreateApplicationRequest": { + "type": "structure", + "members": { + "Name": {}, + "tags": { + "shape": "S4", + "locationName": "tags" + } + }, + "required": [] + } + }, + "required": [ + "CreateApplicationRequest" + ], + "payload": "CreateApplicationRequest" + }, + "output": { + "type": "structure", + "members": { + "ApplicationResponse": { + "shape": "S6" + } + }, + "required": [ + "ApplicationResponse" + ], + "payload": "ApplicationResponse" + } + }, + "CreateCampaign": { + "http": { + "requestUri": "/v1/apps/{application-id}/campaigns", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "WriteCampaignRequest": { + "shape": "S8" + } + }, + "required": [ + "ApplicationId", + "WriteCampaignRequest" + ], + "payload": "WriteCampaignRequest" + }, + "output": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "S12" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + } + }, + "CreateExportJob": { + "http": { + "requestUri": "/v1/apps/{application-id}/jobs/export", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "ExportJobRequest": { + "type": "structure", + "members": { + "RoleArn": {}, + "S3UrlPrefix": {}, + "SegmentId": {}, + "SegmentVersion": { + "type": "integer" + } + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "ExportJobRequest" + ], + "payload": "ExportJobRequest" + }, + "output": { + "type": "structure", + "members": { + "ExportJobResponse": { + "shape": "S1a" + } + }, + "required": [ + "ExportJobResponse" + ], + "payload": "ExportJobResponse" + } + }, + "CreateImportJob": { + "http": { + "requestUri": "/v1/apps/{application-id}/jobs/import", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "ImportJobRequest": { + "type": "structure", + "members": { + "DefineSegment": { + "type": "boolean" + }, + "ExternalId": {}, + "Format": {}, + "RegisterEndpoints": { + "type": "boolean" + }, + "RoleArn": {}, + "S3Url": {}, + "SegmentId": {}, + "SegmentName": {} + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "ImportJobRequest" + ], + "payload": "ImportJobRequest" + }, + "output": { + "type": "structure", + "members": { + "ImportJobResponse": { + "shape": "S1h" + } + }, + "required": [ + "ImportJobResponse" + ], + "payload": "ImportJobResponse" + } + }, + "CreateSegment": { + "http": { + "requestUri": "/v1/apps/{application-id}/segments", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "WriteSegmentRequest": { + "shape": "S1k" + } + }, + "required": [ + "ApplicationId", + "WriteSegmentRequest" + ], + "payload": "WriteSegmentRequest" + }, + "output": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "S24" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + } + }, + "DeleteAdmChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/adm", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ADMChannelResponse": { + "shape": "S2a" + } + }, + "required": [ + "ADMChannelResponse" + ], + "payload": "ADMChannelResponse" + } + }, + "DeleteApnsChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSChannelResponse": { + "shape": "S2d" + } + }, + "required": [ + "APNSChannelResponse" + ], + "payload": "APNSChannelResponse" + } + }, + "DeleteApnsSandboxChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSSandboxChannelResponse": { + "shape": "S2g" + } + }, + "required": [ + "APNSSandboxChannelResponse" + ], + "payload": "APNSSandboxChannelResponse" + } + }, + "DeleteApnsVoipChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSVoipChannelResponse": { + "shape": "S2j" + } + }, + "required": [ + "APNSVoipChannelResponse" + ], + "payload": "APNSVoipChannelResponse" + } + }, + "DeleteApnsVoipSandboxChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelResponse": { + "shape": "S2m" + } + }, + "required": [ + "APNSVoipSandboxChannelResponse" + ], + "payload": "APNSVoipSandboxChannelResponse" + } + }, + "DeleteApp": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationResponse": { + "shape": "S6" + } + }, + "required": [ + "ApplicationResponse" + ], + "payload": "ApplicationResponse" + } + }, + "DeleteBaiduChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/baidu", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "BaiduChannelResponse": { + "shape": "S2r" + } + }, + "required": [ + "BaiduChannelResponse" + ], + "payload": "BaiduChannelResponse" + } + }, + "DeleteCampaign": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "CampaignId": { + "location": "uri", + "locationName": "campaign-id" + } + }, + "required": [ + "CampaignId", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "S12" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + } + }, + "DeleteEmailChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/email", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "EmailChannelResponse": { + "shape": "S2w" + } + }, + "required": [ + "EmailChannelResponse" + ], + "payload": "EmailChannelResponse" + } + }, + "DeleteEndpoint": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "EndpointId": { + "location": "uri", + "locationName": "endpoint-id" + } + }, + "required": [ + "ApplicationId", + "EndpointId" + ] + }, + "output": { + "type": "structure", + "members": { + "EndpointResponse": { + "shape": "S2z" + } + }, + "required": [ + "EndpointResponse" + ], + "payload": "EndpointResponse" + } + }, + "DeleteEventStream": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/eventstream", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "EventStream": { + "shape": "S38" + } + }, + "required": [ + "EventStream" + ], + "payload": "EventStream" + } + }, + "DeleteGcmChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/gcm", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "GCMChannelResponse": { + "shape": "S3b" + } + }, + "required": [ + "GCMChannelResponse" + ], + "payload": "GCMChannelResponse" + } + }, + "DeleteSegment": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "SegmentId": { + "location": "uri", + "locationName": "segment-id" + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "S24" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + } + }, + "DeleteSmsChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/sms", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "SMSChannelResponse": { + "shape": "S3g" + } + }, + "required": [ + "SMSChannelResponse" + ], + "payload": "SMSChannelResponse" + } + }, + "DeleteUserEndpoints": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/users/{user-id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "UserId": { + "location": "uri", + "locationName": "user-id" + } + }, + "required": [ + "ApplicationId", + "UserId" + ] + }, + "output": { + "type": "structure", + "members": { + "EndpointsResponse": { + "shape": "S3j" + } + }, + "required": [ + "EndpointsResponse" + ], + "payload": "EndpointsResponse" + } + }, + "DeleteVoiceChannel": { + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/voice", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "VoiceChannelResponse": { + "shape": "S3n" + } + }, + "required": [ + "VoiceChannelResponse" + ], + "payload": "VoiceChannelResponse" + } + }, + "GetAdmChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/adm", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ADMChannelResponse": { + "shape": "S2a" + } + }, + "required": [ + "ADMChannelResponse" + ], + "payload": "ADMChannelResponse" + } + }, + "GetApnsChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSChannelResponse": { + "shape": "S2d" + } + }, + "required": [ + "APNSChannelResponse" + ], + "payload": "APNSChannelResponse" + } + }, + "GetApnsSandboxChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSSandboxChannelResponse": { + "shape": "S2g" + } + }, + "required": [ + "APNSSandboxChannelResponse" + ], + "payload": "APNSSandboxChannelResponse" + } + }, + "GetApnsVoipChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSVoipChannelResponse": { + "shape": "S2j" + } + }, + "required": [ + "APNSVoipChannelResponse" + ], + "payload": "APNSVoipChannelResponse" + } + }, + "GetApnsVoipSandboxChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelResponse": { + "shape": "S2m" + } + }, + "required": [ + "APNSVoipSandboxChannelResponse" + ], + "payload": "APNSVoipSandboxChannelResponse" + } + }, + "GetApp": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationResponse": { + "shape": "S6" + } + }, + "required": [ + "ApplicationResponse" + ], + "payload": "ApplicationResponse" + } + }, + "GetApplicationSettings": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/settings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationSettingsResource": { + "shape": "S42" + } + }, + "required": [ + "ApplicationSettingsResource" + ], + "payload": "ApplicationSettingsResource" + } + }, + "GetApps": { + "http": { + "method": "GET", + "requestUri": "/v1/apps", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + } + }, + "output": { + "type": "structure", + "members": { + "ApplicationsResponse": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "NextToken": {} + } + } + }, + "required": [ + "ApplicationsResponse" + ], + "payload": "ApplicationsResponse" + } + }, + "GetBaiduChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/baidu", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "BaiduChannelResponse": { + "shape": "S2r" + } + }, + "required": [ + "BaiduChannelResponse" + ], + "payload": "BaiduChannelResponse" + } + }, + "GetCampaign": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "CampaignId": { + "location": "uri", + "locationName": "campaign-id" + } + }, + "required": [ + "CampaignId", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "S12" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + } + }, + "GetCampaignActivities": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/activities", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "CampaignId": { + "location": "uri", + "locationName": "campaign-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "ApplicationId", + "CampaignId" + ] + }, + "output": { + "type": "structure", + "members": { + "ActivitiesResponse": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CampaignId": {}, + "End": {}, + "Id": {}, + "Result": {}, + "ScheduledStart": {}, + "Start": {}, + "State": {}, + "SuccessfulEndpointCount": { + "type": "integer" + }, + "TimezonesCompletedCount": { + "type": "integer" + }, + "TimezonesTotalCount": { + "type": "integer" + }, + "TotalEndpointCount": { + "type": "integer" + }, + "TreatmentId": {} + }, + "required": [] + } + }, + "NextToken": {} + }, + "required": [] + } + }, + "required": [ + "ActivitiesResponse" + ], + "payload": "ActivitiesResponse" + } + }, + "GetCampaignVersion": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "CampaignId": { + "location": "uri", + "locationName": "campaign-id" + }, + "Version": { + "location": "uri", + "locationName": "version" + } + }, + "required": [ + "Version", + "ApplicationId", + "CampaignId" + ] + }, + "output": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "S12" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + } + }, + "GetCampaignVersions": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "CampaignId": { + "location": "uri", + "locationName": "campaign-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "ApplicationId", + "CampaignId" + ] + }, + "output": { + "type": "structure", + "members": { + "CampaignsResponse": { + "shape": "S4k" + } + }, + "required": [ + "CampaignsResponse" + ], + "payload": "CampaignsResponse" + } + }, + "GetCampaigns": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "CampaignsResponse": { + "shape": "S4k" + } + }, + "required": [ + "CampaignsResponse" + ], + "payload": "CampaignsResponse" + } + }, + "GetChannels": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Version": { + "type": "integer" + } + } + } + } + }, + "required": [] + } + }, + "required": [ + "ChannelsResponse" + ], + "payload": "ChannelsResponse" + } + }, + "GetEmailChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/email", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "EmailChannelResponse": { + "shape": "S2w" + } + }, + "required": [ + "EmailChannelResponse" + ], + "payload": "EmailChannelResponse" + } + }, + "GetEndpoint": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "EndpointId": { + "location": "uri", + "locationName": "endpoint-id" + } + }, + "required": [ + "ApplicationId", + "EndpointId" + ] + }, + "output": { + "type": "structure", + "members": { + "EndpointResponse": { + "shape": "S2z" + } + }, + "required": [ + "EndpointResponse" + ], + "payload": "EndpointResponse" + } + }, + "GetEventStream": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/eventstream", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "EventStream": { + "shape": "S38" + } + }, + "required": [ + "EventStream" + ], + "payload": "EventStream" + } + }, + "GetExportJob": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/export/{job-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "JobId": { + "location": "uri", + "locationName": "job-id" + } + }, + "required": [ + "ApplicationId", + "JobId" + ] + }, + "output": { + "type": "structure", + "members": { + "ExportJobResponse": { + "shape": "S1a" + } + }, + "required": [ + "ExportJobResponse" + ], + "payload": "ExportJobResponse" + } + }, + "GetExportJobs": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/export", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ExportJobsResponse": { + "shape": "S53" + } + }, + "required": [ + "ExportJobsResponse" + ], + "payload": "ExportJobsResponse" + } + }, + "GetGcmChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/gcm", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "GCMChannelResponse": { + "shape": "S3b" + } + }, + "required": [ + "GCMChannelResponse" + ], + "payload": "GCMChannelResponse" + } + }, + "GetImportJob": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/import/{job-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "JobId": { + "location": "uri", + "locationName": "job-id" + } + }, + "required": [ + "ApplicationId", + "JobId" + ] + }, + "output": { + "type": "structure", + "members": { + "ImportJobResponse": { + "shape": "S1h" + } + }, + "required": [ + "ImportJobResponse" + ], + "payload": "ImportJobResponse" + } + }, + "GetImportJobs": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/import", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ImportJobsResponse": { + "shape": "S5b" + } + }, + "required": [ + "ImportJobsResponse" + ], + "payload": "ImportJobsResponse" + } + }, + "GetSegment": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "SegmentId": { + "location": "uri", + "locationName": "segment-id" + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "S24" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + } + }, + "GetSegmentExportJobs": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/jobs/export", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "SegmentId": { + "location": "uri", + "locationName": "segment-id" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ExportJobsResponse": { + "shape": "S53" + } + }, + "required": [ + "ExportJobsResponse" + ], + "payload": "ExportJobsResponse" + } + }, + "GetSegmentImportJobs": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/jobs/import", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "SegmentId": { + "location": "uri", + "locationName": "segment-id" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ImportJobsResponse": { + "shape": "S5b" + } + }, + "required": [ + "ImportJobsResponse" + ], + "payload": "ImportJobsResponse" + } + }, + "GetSegmentVersion": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "SegmentId": { + "location": "uri", + "locationName": "segment-id" + }, + "Version": { + "location": "uri", + "locationName": "version" + } + }, + "required": [ + "SegmentId", + "Version", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "S24" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + } + }, + "GetSegmentVersions": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "SegmentId": { + "location": "uri", + "locationName": "segment-id" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "SegmentsResponse": { + "shape": "S5n" + } + }, + "required": [ + "SegmentsResponse" + ], + "payload": "SegmentsResponse" + } + }, + "GetSegments": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "PageSize": { + "location": "querystring", + "locationName": "page-size" + }, + "Token": { + "location": "querystring", + "locationName": "token" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "SegmentsResponse": { + "shape": "S5n" + } + }, + "required": [ + "SegmentsResponse" + ], + "payload": "SegmentsResponse" + } + }, + "GetSmsChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/sms", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "SMSChannelResponse": { + "shape": "S3g" + } + }, + "required": [ + "SMSChannelResponse" + ], + "payload": "SMSChannelResponse" + } + }, + "GetUserEndpoints": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/users/{user-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "UserId": { + "location": "uri", + "locationName": "user-id" + } + }, + "required": [ + "ApplicationId", + "UserId" + ] + }, + "output": { + "type": "structure", + "members": { + "EndpointsResponse": { + "shape": "S3j" + } + }, + "required": [ + "EndpointsResponse" + ], + "payload": "EndpointsResponse" + } + }, + "GetVoiceChannel": { + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/voice", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "VoiceChannelResponse": { + "shape": "S3n" + } + }, + "required": [ + "VoiceChannelResponse" + ], + "payload": "VoiceChannelResponse" + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ] + }, + "output": { + "type": "structure", + "members": { + "TagsModel": { + "shape": "S5z" + } + }, + "required": [ + "TagsModel" + ], + "payload": "TagsModel" + } + }, + "PhoneNumberValidate": { + "http": { + "requestUri": "/v1/phone/number/validate", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NumberValidateRequest": { + "type": "structure", + "members": { + "IsoCountryCode": {}, + "PhoneNumber": {} + } + } + }, + "required": [ + "NumberValidateRequest" + ], + "payload": "NumberValidateRequest" + }, + "output": { + "type": "structure", + "members": { + "NumberValidateResponse": { + "type": "structure", + "members": { + "Carrier": {}, + "City": {}, + "CleansedPhoneNumberE164": {}, + "CleansedPhoneNumberNational": {}, + "Country": {}, + "CountryCodeIso2": {}, + "CountryCodeNumeric": {}, + "County": {}, + "OriginalCountryCodeIso2": {}, + "OriginalPhoneNumber": {}, + "PhoneType": {}, + "PhoneTypeCode": { + "type": "integer" + }, + "Timezone": {}, + "ZipCode": {} + } + } + }, + "required": [ + "NumberValidateResponse" + ], + "payload": "NumberValidateResponse" + } + }, + "PutEventStream": { + "http": { + "requestUri": "/v1/apps/{application-id}/eventstream", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "WriteEventStream": { + "type": "structure", + "members": { + "DestinationStreamArn": {}, + "RoleArn": {} + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "WriteEventStream" + ], + "payload": "WriteEventStream" + }, + "output": { + "type": "structure", + "members": { + "EventStream": { + "shape": "S38" + } + }, + "required": [ + "EventStream" + ], + "payload": "EventStream" + } + }, + "PutEvents": { + "http": { + "requestUri": "/v1/apps/{application-id}/events", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "EventsRequest": { + "type": "structure", + "members": { + "BatchItem": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Attributes": { + "shape": "S30" + }, + "ChannelType": {}, + "Demographic": { + "shape": "S32" + }, + "EffectiveDate": {}, + "EndpointStatus": {}, + "Location": { + "shape": "S33" + }, + "Metrics": { + "shape": "S34" + }, + "OptOut": {}, + "RequestId": {}, + "User": { + "shape": "S35" + } + } + }, + "Events": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "AppPackageName": {}, + "AppTitle": {}, + "AppVersionCode": {}, + "Attributes": { + "shape": "S4" + }, + "ClientSdkVersion": {}, + "EventType": {}, + "Metrics": { + "shape": "S34" + }, + "SdkName": {}, + "Session": { + "type": "structure", + "members": { + "Duration": { + "type": "integer" + }, + "Id": {}, + "StartTimestamp": {}, + "StopTimestamp": {} + }, + "required": [] + }, + "Timestamp": {} + }, + "required": [] + } + } + }, + "required": [] + } + } + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "EventsRequest" + ], + "payload": "EventsRequest" + }, + "output": { + "type": "structure", + "members": { + "EventsResponse": { + "type": "structure", + "members": { + "Results": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "EndpointItemResponse": { + "type": "structure", + "members": { + "Message": {}, + "StatusCode": { + "type": "integer" + } + } + }, + "EventsItemResponse": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Message": {}, + "StatusCode": { + "type": "integer" + } + } + } + } + } + } + } + } + } + }, + "required": [ + "EventsResponse" + ], + "payload": "EventsResponse" + } + }, + "RemoveAttributes": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/attributes/{attribute-type}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "AttributeType": { + "location": "uri", + "locationName": "attribute-type" + }, + "UpdateAttributesRequest": { + "type": "structure", + "members": { + "Blacklist": { + "shape": "Sp" + } + } + } + }, + "required": [ + "AttributeType", + "ApplicationId", + "UpdateAttributesRequest" + ], + "payload": "UpdateAttributesRequest" + }, + "output": { + "type": "structure", + "members": { + "AttributesResource": { + "type": "structure", + "members": { + "ApplicationId": {}, + "AttributeType": {}, + "Attributes": { + "shape": "Sp" + } + }, + "required": [] + } + }, + "required": [ + "AttributesResource" + ], + "payload": "AttributesResource" + } + }, + "SendMessages": { + "http": { + "requestUri": "/v1/apps/{application-id}/messages", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "MessageRequest": { + "type": "structure", + "members": { + "Addresses": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "BodyOverride": {}, + "ChannelType": {}, + "Context": { + "shape": "S4" + }, + "RawContent": {}, + "Substitutions": { + "shape": "S30" + }, + "TitleOverride": {} + } + } + }, + "Context": { + "shape": "S4" + }, + "Endpoints": { + "shape": "S6u" + }, + "MessageConfiguration": { + "shape": "S6w" + }, + "TraceId": {} + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "MessageRequest" + ], + "payload": "MessageRequest" + }, + "output": { + "type": "structure", + "members": { + "MessageResponse": { + "type": "structure", + "members": { + "ApplicationId": {}, + "EndpointResult": { + "shape": "S7c" + }, + "RequestId": {}, + "Result": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "DeliveryStatus": {}, + "MessageId": {}, + "StatusCode": { + "type": "integer" + }, + "StatusMessage": {}, + "UpdatedToken": {} + }, + "required": [] + } + } + }, + "required": [] + } + }, + "required": [ + "MessageResponse" + ], + "payload": "MessageResponse" + } + }, + "SendUsersMessages": { + "http": { + "requestUri": "/v1/apps/{application-id}/users-messages", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "SendUsersMessageRequest": { + "type": "structure", + "members": { + "Context": { + "shape": "S4" + }, + "MessageConfiguration": { + "shape": "S6w" + }, + "TraceId": {}, + "Users": { + "shape": "S6u" + } + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "SendUsersMessageRequest" + ], + "payload": "SendUsersMessageRequest" + }, + "output": { + "type": "structure", + "members": { + "SendUsersMessageResponse": { + "type": "structure", + "members": { + "ApplicationId": {}, + "RequestId": {}, + "Result": { + "type": "map", + "key": {}, + "value": { + "shape": "S7c" + } + } + }, + "required": [] + } + }, + "required": [ + "SendUsersMessageResponse" + ], + "payload": "SendUsersMessageResponse" + } + }, + "TagResource": { + "http": { + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "TagsModel": { + "shape": "S5z" + } + }, + "required": [ + "ResourceArn", + "TagsModel" + ], + "payload": "TagsModel" + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "shape": "Sp", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + } + }, + "UpdateAdmChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/adm", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ADMChannelRequest": { + "type": "structure", + "members": { + "ClientId": {}, + "ClientSecret": {}, + "Enabled": { + "type": "boolean" + } + }, + "required": [] + }, + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId", + "ADMChannelRequest" + ], + "payload": "ADMChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "ADMChannelResponse": { + "shape": "S2a" + } + }, + "required": [ + "ADMChannelResponse" + ], + "payload": "ADMChannelResponse" + } + }, + "UpdateApnsChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "APNSChannelRequest": { + "type": "structure", + "members": { + "BundleId": {}, + "Certificate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "PrivateKey": {}, + "TeamId": {}, + "TokenKey": {}, + "TokenKeyId": {} + }, + "required": [] + }, + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId", + "APNSChannelRequest" + ], + "payload": "APNSChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "APNSChannelResponse": { + "shape": "S2d" + } + }, + "required": [ + "APNSChannelResponse" + ], + "payload": "APNSChannelResponse" + } + }, + "UpdateApnsSandboxChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "APNSSandboxChannelRequest": { + "type": "structure", + "members": { + "BundleId": {}, + "Certificate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "PrivateKey": {}, + "TeamId": {}, + "TokenKey": {}, + "TokenKeyId": {} + }, + "required": [] + }, + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId", + "APNSSandboxChannelRequest" + ], + "payload": "APNSSandboxChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "APNSSandboxChannelResponse": { + "shape": "S2g" + } + }, + "required": [ + "APNSSandboxChannelResponse" + ], + "payload": "APNSSandboxChannelResponse" + } + }, + "UpdateApnsVoipChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "APNSVoipChannelRequest": { + "type": "structure", + "members": { + "BundleId": {}, + "Certificate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "PrivateKey": {}, + "TeamId": {}, + "TokenKey": {}, + "TokenKeyId": {} + }, + "required": [] + }, + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId", + "APNSVoipChannelRequest" + ], + "payload": "APNSVoipChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "APNSVoipChannelResponse": { + "shape": "S2j" + } + }, + "required": [ + "APNSVoipChannelResponse" + ], + "payload": "APNSVoipChannelResponse" + } + }, + "UpdateApnsVoipSandboxChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelRequest": { + "type": "structure", + "members": { + "BundleId": {}, + "Certificate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "PrivateKey": {}, + "TeamId": {}, + "TokenKey": {}, + "TokenKeyId": {} + }, + "required": [] + }, + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + } + }, + "required": [ + "ApplicationId", + "APNSVoipSandboxChannelRequest" + ], + "payload": "APNSVoipSandboxChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelResponse": { + "shape": "S2m" + } + }, + "required": [ + "APNSVoipSandboxChannelResponse" + ], + "payload": "APNSVoipSandboxChannelResponse" + } + }, + "UpdateApplicationSettings": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/settings", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "WriteApplicationSettingsRequest": { + "type": "structure", + "members": { + "CampaignHook": { + "shape": "Sy" + }, + "CloudWatchMetricsEnabled": { + "type": "boolean" + }, + "Limits": { + "shape": "S10" + }, + "QuietTime": { + "shape": "Sx" + } + } + } + }, + "required": [ + "ApplicationId", + "WriteApplicationSettingsRequest" + ], + "payload": "WriteApplicationSettingsRequest" + }, + "output": { + "type": "structure", + "members": { + "ApplicationSettingsResource": { + "shape": "S42" + } + }, + "required": [ + "ApplicationSettingsResource" + ], + "payload": "ApplicationSettingsResource" + } + }, + "UpdateBaiduChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/baidu", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "BaiduChannelRequest": { + "type": "structure", + "members": { + "ApiKey": {}, + "Enabled": { + "type": "boolean" + }, + "SecretKey": {} + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "BaiduChannelRequest" + ], + "payload": "BaiduChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "BaiduChannelResponse": { + "shape": "S2r" + } + }, + "required": [ + "BaiduChannelResponse" + ], + "payload": "BaiduChannelResponse" + } + }, + "UpdateCampaign": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "CampaignId": { + "location": "uri", + "locationName": "campaign-id" + }, + "WriteCampaignRequest": { + "shape": "S8" + } + }, + "required": [ + "CampaignId", + "ApplicationId", + "WriteCampaignRequest" + ], + "payload": "WriteCampaignRequest" + }, + "output": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "S12" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + } + }, + "UpdateEmailChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/email", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "EmailChannelRequest": { + "type": "structure", + "members": { + "ConfigurationSet": {}, + "Enabled": { + "type": "boolean" + }, + "FromAddress": {}, + "Identity": {}, + "RoleArn": {} + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "EmailChannelRequest" + ], + "payload": "EmailChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "EmailChannelResponse": { + "shape": "S2w" + } + }, + "required": [ + "EmailChannelResponse" + ], + "payload": "EmailChannelResponse" + } + }, + "UpdateEndpoint": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "EndpointId": { + "location": "uri", + "locationName": "endpoint-id" + }, + "EndpointRequest": { + "type": "structure", + "members": { + "Address": {}, + "Attributes": { + "shape": "S30" + }, + "ChannelType": {}, + "Demographic": { + "shape": "S32" + }, + "EffectiveDate": {}, + "EndpointStatus": {}, + "Location": { + "shape": "S33" + }, + "Metrics": { + "shape": "S34" + }, + "OptOut": {}, + "RequestId": {}, + "User": { + "shape": "S35" + } + } + } + }, + "required": [ + "ApplicationId", + "EndpointId", + "EndpointRequest" + ], + "payload": "EndpointRequest" + }, + "output": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "S8h" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + } + }, + "UpdateEndpointsBatch": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/endpoints", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "EndpointBatchRequest": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Address": {}, + "Attributes": { + "shape": "S30" + }, + "ChannelType": {}, + "Demographic": { + "shape": "S32" + }, + "EffectiveDate": {}, + "EndpointStatus": {}, + "Id": {}, + "Location": { + "shape": "S33" + }, + "Metrics": { + "shape": "S34" + }, + "OptOut": {}, + "RequestId": {}, + "User": { + "shape": "S35" + } + } + } + } + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "EndpointBatchRequest" + ], + "payload": "EndpointBatchRequest" + }, + "output": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "S8h" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + } + }, + "UpdateGcmChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/gcm", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "GCMChannelRequest": { + "type": "structure", + "members": { + "ApiKey": {}, + "Enabled": { + "type": "boolean" + } + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "GCMChannelRequest" + ], + "payload": "GCMChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "GCMChannelResponse": { + "shape": "S3b" + } + }, + "required": [ + "GCMChannelResponse" + ], + "payload": "GCMChannelResponse" + } + }, + "UpdateSegment": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "SegmentId": { + "location": "uri", + "locationName": "segment-id" + }, + "WriteSegmentRequest": { + "shape": "S1k" + } + }, + "required": [ + "SegmentId", + "ApplicationId", + "WriteSegmentRequest" + ], + "payload": "WriteSegmentRequest" + }, + "output": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "S24" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + } + }, + "UpdateSmsChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/sms", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "SMSChannelRequest": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "SenderId": {}, + "ShortCode": {} + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "SMSChannelRequest" + ], + "payload": "SMSChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "SMSChannelResponse": { + "shape": "S3g" + } + }, + "required": [ + "SMSChannelResponse" + ], + "payload": "SMSChannelResponse" + } + }, + "UpdateVoiceChannel": { + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/voice", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "application-id" + }, + "VoiceChannelRequest": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + }, + "required": [] + } + }, + "required": [ + "ApplicationId", + "VoiceChannelRequest" + ], + "payload": "VoiceChannelRequest" + }, + "output": { + "type": "structure", + "members": { + "VoiceChannelResponse": { + "shape": "S3n" + } + }, + "required": [ + "VoiceChannelResponse" + ], + "payload": "VoiceChannelResponse" + } + } + }, + "shapes": { + "S4": { + "type": "map", + "key": {}, + "value": {} + }, + "S6": { + "type": "structure", + "members": { + "Arn": {}, + "Id": {}, + "Name": {}, + "tags": { + "shape": "S4", + "locationName": "tags" + } + }, + "required": [] + }, + "S8": { + "type": "structure", + "members": { + "AdditionalTreatments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "MessageConfiguration": { + "shape": "Sb" + }, + "Schedule": { + "shape": "Sj" + }, + "SizePercent": { + "type": "integer" + }, + "TreatmentDescription": {}, + "TreatmentName": {} + }, + "required": [] + } + }, + "Description": {}, + "HoldoutPercent": { + "type": "integer" + }, + "Hook": { + "shape": "Sy" + }, + "IsPaused": { + "type": "boolean" + }, + "Limits": { + "shape": "S10" + }, + "MessageConfiguration": { + "shape": "Sb" + }, + "Name": {}, + "Schedule": { + "shape": "Sj" + }, + "SegmentId": {}, + "SegmentVersion": { + "type": "integer" + }, + "tags": { + "shape": "S4", + "locationName": "tags" + }, + "TreatmentDescription": {}, + "TreatmentName": {} + } + }, + "Sb": { + "type": "structure", + "members": { + "ADMMessage": { + "shape": "Sc" + }, + "APNSMessage": { + "shape": "Sc" + }, + "BaiduMessage": { + "shape": "Sc" + }, + "DefaultMessage": { + "shape": "Sc" + }, + "EmailMessage": { + "type": "structure", + "members": { + "Body": {}, + "FromAddress": {}, + "HtmlBody": {}, + "Title": {} + }, + "required": [] + }, + "GCMMessage": { + "shape": "Sc" + }, + "SMSMessage": { + "type": "structure", + "members": { + "Body": {}, + "MessageType": {}, + "SenderId": {} + } + } + } + }, + "Sc": { + "type": "structure", + "members": { + "Action": {}, + "Body": {}, + "ImageIconUrl": {}, + "ImageSmallIconUrl": {}, + "ImageUrl": {}, + "JsonBody": {}, + "MediaUrl": {}, + "RawContent": {}, + "SilentPush": { + "type": "boolean" + }, + "TimeToLive": { + "type": "integer" + }, + "Title": {}, + "Url": {} + }, + "required": [] + }, + "Sj": { + "type": "structure", + "members": { + "EndTime": {}, + "EventFilter": { + "type": "structure", + "members": { + "Dimensions": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sm" + }, + "EventType": { + "shape": "Sq" + }, + "Metrics": { + "shape": "Ss" + } + } + }, + "FilterType": {} + }, + "required": [] + }, + "Frequency": {}, + "IsLocalTime": { + "type": "boolean" + }, + "QuietTime": { + "shape": "Sx" + }, + "StartTime": {}, + "Timezone": {} + }, + "required": [] + }, + "Sm": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "AttributeType": {}, + "Values": { + "shape": "Sp" + } + }, + "required": [] + } + }, + "Sp": { + "type": "list", + "member": {} + }, + "Sq": { + "type": "structure", + "members": { + "DimensionType": {}, + "Values": { + "shape": "Sp" + } + }, + "required": [] + }, + "Ss": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "ComparisonOperator": {}, + "Value": { + "type": "double" + } + }, + "required": [] + } + }, + "Sx": { + "type": "structure", + "members": { + "End": {}, + "Start": {} + } + }, + "Sy": { + "type": "structure", + "members": { + "LambdaFunctionName": {}, + "Mode": {}, + "WebUrl": {} + } + }, + "S10": { + "type": "structure", + "members": { + "Daily": { + "type": "integer" + }, + "MaximumDuration": { + "type": "integer" + }, + "MessagesPerSecond": { + "type": "integer" + }, + "Total": { + "type": "integer" + } + } + }, + "S12": { + "type": "structure", + "members": { + "AdditionalTreatments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "MessageConfiguration": { + "shape": "Sb" + }, + "Schedule": { + "shape": "Sj" + }, + "SizePercent": { + "type": "integer" + }, + "State": { + "shape": "S15" + }, + "TreatmentDescription": {}, + "TreatmentName": {} + }, + "required": [] + } + }, + "ApplicationId": {}, + "Arn": {}, + "CreationDate": {}, + "DefaultState": { + "shape": "S15" + }, + "Description": {}, + "HoldoutPercent": { + "type": "integer" + }, + "Hook": { + "shape": "Sy" + }, + "Id": {}, + "IsPaused": { + "type": "boolean" + }, + "LastModifiedDate": {}, + "Limits": { + "shape": "S10" + }, + "MessageConfiguration": { + "shape": "Sb" + }, + "Name": {}, + "Schedule": { + "shape": "Sj" + }, + "SegmentId": {}, + "SegmentVersion": { + "type": "integer" + }, + "State": { + "shape": "S15" + }, + "tags": { + "shape": "S4", + "locationName": "tags" + }, + "TreatmentDescription": {}, + "TreatmentName": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S15": { + "type": "structure", + "members": { + "CampaignStatus": {} + } + }, + "S1a": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CompletedPieces": { + "type": "integer" + }, + "CompletionDate": {}, + "CreationDate": {}, + "Definition": { + "type": "structure", + "members": { + "RoleArn": {}, + "S3UrlPrefix": {}, + "SegmentId": {}, + "SegmentVersion": { + "type": "integer" + } + }, + "required": [] + }, + "FailedPieces": { + "type": "integer" + }, + "Failures": { + "shape": "Sp" + }, + "Id": {}, + "JobStatus": {}, + "TotalFailures": { + "type": "integer" + }, + "TotalPieces": { + "type": "integer" + }, + "TotalProcessed": { + "type": "integer" + }, + "Type": {} + }, + "required": [] + }, + "S1h": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CompletedPieces": { + "type": "integer" + }, + "CompletionDate": {}, + "CreationDate": {}, + "Definition": { + "type": "structure", + "members": { + "DefineSegment": { + "type": "boolean" + }, + "ExternalId": {}, + "Format": {}, + "RegisterEndpoints": { + "type": "boolean" + }, + "RoleArn": {}, + "S3Url": {}, + "SegmentId": {}, + "SegmentName": {} + }, + "required": [] + }, + "FailedPieces": { + "type": "integer" + }, + "Failures": { + "shape": "Sp" + }, + "Id": {}, + "JobStatus": {}, + "TotalFailures": { + "type": "integer" + }, + "TotalPieces": { + "type": "integer" + }, + "TotalProcessed": { + "type": "integer" + }, + "Type": {} + }, + "required": [] + }, + "S1k": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "S1l" + }, + "Name": {}, + "SegmentGroups": { + "shape": "S1u" + }, + "tags": { + "shape": "S4", + "locationName": "tags" + } + }, + "required": [] + }, + "S1l": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sm" + }, + "Behavior": { + "type": "structure", + "members": { + "Recency": { + "type": "structure", + "members": { + "Duration": {}, + "RecencyType": {} + }, + "required": [] + } + } + }, + "Demographic": { + "type": "structure", + "members": { + "AppVersion": { + "shape": "Sq" + }, + "Channel": { + "shape": "Sq" + }, + "DeviceType": { + "shape": "Sq" + }, + "Make": { + "shape": "Sq" + }, + "Model": { + "shape": "Sq" + }, + "Platform": { + "shape": "Sq" + } + } + }, + "Location": { + "type": "structure", + "members": { + "Country": { + "shape": "Sq" + }, + "GPSPoint": { + "type": "structure", + "members": { + "Coordinates": { + "type": "structure", + "members": { + "Latitude": { + "type": "double" + }, + "Longitude": { + "type": "double" + } + }, + "required": [] + }, + "RangeInKilometers": { + "type": "double" + } + }, + "required": [] + } + } + }, + "Metrics": { + "shape": "Ss" + }, + "UserAttributes": { + "shape": "Sm" + } + } + }, + "S1u": { + "type": "structure", + "members": { + "Groups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Dimensions": { + "type": "list", + "member": { + "shape": "S1l" + } + }, + "SourceSegments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + } + }, + "SourceType": {}, + "Type": {} + }, + "required": [] + } + }, + "Include": {} + }, + "required": [] + }, + "S24": { + "type": "structure", + "members": { + "ApplicationId": {}, + "Arn": {}, + "CreationDate": {}, + "Dimensions": { + "shape": "S1l" + }, + "Id": {}, + "ImportDefinition": { + "type": "structure", + "members": { + "ChannelCounts": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + }, + "ExternalId": {}, + "Format": {}, + "RoleArn": {}, + "S3Url": {}, + "Size": { + "type": "integer" + } + }, + "required": [] + }, + "LastModifiedDate": {}, + "Name": {}, + "SegmentGroups": { + "shape": "S1u" + }, + "SegmentType": {}, + "tags": { + "shape": "S4", + "locationName": "tags" + }, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2a": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2d": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "HasTokenKey": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2g": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "HasTokenKey": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2j": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "HasTokenKey": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2m": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "DefaultAuthenticationMethod": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "HasTokenKey": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2r": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "Credential": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2w": { + "type": "structure", + "members": { + "ApplicationId": {}, + "ConfigurationSet": {}, + "CreationDate": {}, + "Enabled": { + "type": "boolean" + }, + "FromAddress": {}, + "HasCredential": { + "type": "boolean" + }, + "Id": {}, + "Identity": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "MessagesPerSecond": { + "type": "integer" + }, + "Platform": {}, + "RoleArn": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S2z": { + "type": "structure", + "members": { + "Address": {}, + "ApplicationId": {}, + "Attributes": { + "shape": "S30" + }, + "ChannelType": {}, + "CohortId": {}, + "CreationDate": {}, + "Demographic": { + "shape": "S32" + }, + "EffectiveDate": {}, + "EndpointStatus": {}, + "Id": {}, + "Location": { + "shape": "S33" + }, + "Metrics": { + "shape": "S34" + }, + "OptOut": {}, + "RequestId": {}, + "User": { + "shape": "S35" + } + } + }, + "S30": { + "type": "map", + "key": {}, + "value": { + "shape": "Sp" + } + }, + "S32": { + "type": "structure", + "members": { + "AppVersion": {}, + "Locale": {}, + "Make": {}, + "Model": {}, + "ModelVersion": {}, + "Platform": {}, + "PlatformVersion": {}, + "Timezone": {} + } + }, + "S33": { + "type": "structure", + "members": { + "City": {}, + "Country": {}, + "Latitude": { + "type": "double" + }, + "Longitude": { + "type": "double" + }, + "PostalCode": {}, + "Region": {} + } + }, + "S34": { + "type": "map", + "key": {}, + "value": { + "type": "double" + } + }, + "S35": { + "type": "structure", + "members": { + "UserAttributes": { + "shape": "S30" + }, + "UserId": {} + } + }, + "S38": { + "type": "structure", + "members": { + "ApplicationId": {}, + "DestinationStreamArn": {}, + "ExternalId": {}, + "LastModifiedDate": {}, + "LastUpdatedBy": {}, + "RoleArn": {} + }, + "required": [] + }, + "S3b": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "Credential": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S3g": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "PromotionalMessagesPerSecond": { + "type": "integer" + }, + "SenderId": {}, + "ShortCode": {}, + "TransactionalMessagesPerSecond": { + "type": "integer" + }, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S3j": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "shape": "S2z" + } + } + }, + "required": [] + }, + "S3n": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CreationDate": {}, + "Enabled": { + "type": "boolean" + }, + "HasCredential": { + "type": "boolean" + }, + "Id": {}, + "IsArchived": { + "type": "boolean" + }, + "LastModifiedBy": {}, + "LastModifiedDate": {}, + "Platform": {}, + "Version": { + "type": "integer" + } + }, + "required": [] + }, + "S42": { + "type": "structure", + "members": { + "ApplicationId": {}, + "CampaignHook": { + "shape": "Sy" + }, + "LastModifiedDate": {}, + "Limits": { + "shape": "S10" + }, + "QuietTime": { + "shape": "Sx" + } + }, + "required": [] + }, + "S4k": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "shape": "S12" + } + }, + "NextToken": {} + }, + "required": [] + }, + "S53": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "shape": "S1a" + } + }, + "NextToken": {} + }, + "required": [] + }, + "S5b": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "shape": "S1h" + } + }, + "NextToken": {} + }, + "required": [] + }, + "S5n": { + "type": "structure", + "members": { + "Item": { + "type": "list", + "member": { + "shape": "S24" + } + }, + "NextToken": {} + }, + "required": [] + }, + "S5z": { + "type": "structure", + "members": { + "tags": { + "shape": "S4", + "locationName": "tags" + } + }, + "required": [ + "tags" + ] + }, + "S6u": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "BodyOverride": {}, + "Context": { + "shape": "S4" + }, + "RawContent": {}, + "Substitutions": { + "shape": "S30" + }, + "TitleOverride": {} + } + } + }, + "S6w": { + "type": "structure", + "members": { + "ADMMessage": { + "type": "structure", + "members": { + "Action": {}, + "Body": {}, + "ConsolidationKey": {}, + "Data": { + "shape": "S4" + }, + "ExpiresAfter": {}, + "IconReference": {}, + "ImageIconUrl": {}, + "ImageUrl": {}, + "MD5": {}, + "RawContent": {}, + "SilentPush": { + "type": "boolean" + }, + "SmallImageIconUrl": {}, + "Sound": {}, + "Substitutions": { + "shape": "S30" + }, + "Title": {}, + "Url": {} + } + }, + "APNSMessage": { + "type": "structure", + "members": { + "Action": {}, + "Badge": { + "type": "integer" + }, + "Body": {}, + "Category": {}, + "CollapseId": {}, + "Data": { + "shape": "S4" + }, + "MediaUrl": {}, + "PreferredAuthenticationMethod": {}, + "Priority": {}, + "RawContent": {}, + "SilentPush": { + "type": "boolean" + }, + "Sound": {}, + "Substitutions": { + "shape": "S30" + }, + "ThreadId": {}, + "TimeToLive": { + "type": "integer" + }, + "Title": {}, + "Url": {} + } + }, + "BaiduMessage": { + "type": "structure", + "members": { + "Action": {}, + "Body": {}, + "Data": { + "shape": "S4" + }, + "IconReference": {}, + "ImageIconUrl": {}, + "ImageUrl": {}, + "RawContent": {}, + "SilentPush": { + "type": "boolean" + }, + "SmallImageIconUrl": {}, + "Sound": {}, + "Substitutions": { + "shape": "S30" + }, + "TimeToLive": { + "type": "integer" + }, + "Title": {}, + "Url": {} + } + }, + "DefaultMessage": { + "type": "structure", + "members": { + "Body": {}, + "Substitutions": { + "shape": "S30" + } + } + }, + "DefaultPushNotificationMessage": { + "type": "structure", + "members": { + "Action": {}, + "Body": {}, + "Data": { + "shape": "S4" + }, + "SilentPush": { + "type": "boolean" + }, + "Substitutions": { + "shape": "S30" + }, + "Title": {}, + "Url": {} + } + }, + "EmailMessage": { + "type": "structure", + "members": { + "Body": {}, + "FeedbackForwardingAddress": {}, + "FromAddress": {}, + "RawEmail": { + "type": "structure", + "members": { + "Data": { + "type": "blob" + } + } + }, + "ReplyToAddresses": { + "shape": "Sp" + }, + "SimpleEmail": { + "type": "structure", + "members": { + "HtmlPart": { + "shape": "S76" + }, + "Subject": { + "shape": "S76" + }, + "TextPart": { + "shape": "S76" + } + } + }, + "Substitutions": { + "shape": "S30" + } + } + }, + "GCMMessage": { + "type": "structure", + "members": { + "Action": {}, + "Body": {}, + "CollapseKey": {}, + "Data": { + "shape": "S4" + }, + "IconReference": {}, + "ImageIconUrl": {}, + "ImageUrl": {}, + "Priority": {}, + "RawContent": {}, + "RestrictedPackageName": {}, + "SilentPush": { + "type": "boolean" + }, + "SmallImageIconUrl": {}, + "Sound": {}, + "Substitutions": { + "shape": "S30" + }, + "TimeToLive": { + "type": "integer" + }, + "Title": {}, + "Url": {} + } + }, + "SMSMessage": { + "type": "structure", + "members": { + "Body": {}, + "Keyword": {}, + "MessageType": {}, + "OriginationNumber": {}, + "SenderId": {}, + "Substitutions": { + "shape": "S30" + } + } + }, + "VoiceMessage": { + "type": "structure", + "members": { + "Body": {}, + "LanguageCode": {}, + "OriginationNumber": {}, + "Substitutions": { + "shape": "S30" + }, + "VoiceId": {} + } + } + }, + "required": [] + }, + "S76": { + "type": "structure", + "members": { + "Charset": {}, + "Data": {} + } + }, + "S7c": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Address": {}, + "DeliveryStatus": {}, + "MessageId": {}, + "StatusCode": { + "type": "integer" + }, + "StatusMessage": {}, + "UpdatedToken": {} + }, + "required": [] + } + }, + "S8h": { + "type": "structure", + "members": { + "Message": {}, + "RequestID": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.examples.json b/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.min.json b/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.min.json new file mode 100644 index 0000000..bca4ff7 --- /dev/null +++ b/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.min.json @@ -0,0 +1,1493 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-07-26", + "endpointPrefix": "email", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "Pinpoint Email", + "serviceFullName": "Amazon Pinpoint Email Service", + "serviceId": "Pinpoint Email", + "signatureVersion": "v4", + "signingName": "ses", + "targetPrefix": "com.amazonaws.services.pinpoint.email", + "uid": "pinpoint-email-2018-07-26" + }, + "operations": { + "CreateConfigurationSet": { + "http": { + "requestUri": "/v1/email/configuration-sets" + }, + "input": { + "type": "structure", + "members": { + "ConfigurationSetName": {}, + "TrackingOptions": { + "shape": "S3" + }, + "DeliveryOptions": { + "shape": "S5" + }, + "ReputationOptions": { + "shape": "S7" + }, + "SendingOptions": { + "shape": "Sa" + }, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateConfigurationSetEventDestination": { + "http": { + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestinationName", + "EventDestination" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "EventDestinationName": {}, + "EventDestination": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateDedicatedIpPool": { + "http": { + "requestUri": "/v1/email/dedicated-ip-pools" + }, + "input": { + "type": "structure", + "required": [ + "PoolName" + ], + "members": { + "PoolName": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateDeliverabilityTestReport": { + "http": { + "requestUri": "/v1/email/deliverability-dashboard/test" + }, + "input": { + "type": "structure", + "required": [ + "FromEmailAddress", + "Content" + ], + "members": { + "ReportName": {}, + "FromEmailAddress": {}, + "Content": { + "shape": "S11" + }, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ReportId", + "DeliverabilityTestStatus" + ], + "members": { + "ReportId": {}, + "DeliverabilityTestStatus": {} + } + } + }, + "CreateEmailIdentity": { + "http": { + "requestUri": "/v1/email/identities" + }, + "input": { + "type": "structure", + "required": [ + "EmailIdentity" + ], + "members": { + "EmailIdentity": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityType": {}, + "VerifiedForSendingStatus": { + "type": "boolean" + }, + "DkimAttributes": { + "shape": "S1g" + } + } + } + }, + "DeleteConfigurationSet": { + "http": { + "method": "DELETE", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteConfigurationSetEventDestination": { + "http": { + "method": "DELETE", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestinationName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "EventDestinationName": { + "location": "uri", + "locationName": "EventDestinationName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDedicatedIpPool": { + "http": { + "method": "DELETE", + "requestUri": "/v1/email/dedicated-ip-pools/{PoolName}" + }, + "input": { + "type": "structure", + "required": [ + "PoolName" + ], + "members": { + "PoolName": { + "location": "uri", + "locationName": "PoolName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteEmailIdentity": { + "http": { + "method": "DELETE", + "requestUri": "/v1/email/identities/{EmailIdentity}" + }, + "input": { + "type": "structure", + "required": [ + "EmailIdentity" + ], + "members": { + "EmailIdentity": { + "location": "uri", + "locationName": "EmailIdentity" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetAccount": { + "http": { + "method": "GET", + "requestUri": "/v1/email/account" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "SendQuota": { + "type": "structure", + "members": { + "Max24HourSend": { + "type": "double" + }, + "MaxSendRate": { + "type": "double" + }, + "SentLast24Hours": { + "type": "double" + } + } + }, + "SendingEnabled": { + "type": "boolean" + }, + "DedicatedIpAutoWarmupEnabled": { + "type": "boolean" + }, + "EnforcementStatus": {}, + "ProductionAccessEnabled": { + "type": "boolean" + } + } + } + }, + "GetBlacklistReports": { + "http": { + "method": "GET", + "requestUri": "/v1/email/deliverability-dashboard/blacklist-report" + }, + "input": { + "type": "structure", + "required": [ + "BlacklistItemNames" + ], + "members": { + "BlacklistItemNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "required": [ + "BlacklistReport" + ], + "members": { + "BlacklistReport": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RblName": {}, + "ListingTime": { + "type": "timestamp" + }, + "Description": {} + } + } + } + } + } + } + }, + "GetConfigurationSet": { + "http": { + "method": "GET", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationSetName": {}, + "TrackingOptions": { + "shape": "S3" + }, + "DeliveryOptions": { + "shape": "S5" + }, + "ReputationOptions": { + "shape": "S7" + }, + "SendingOptions": { + "shape": "Sa" + } + } + } + }, + "GetConfigurationSetEventDestinations": { + "http": { + "method": "GET", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "EventDestinations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "MatchingEventTypes" + ], + "members": { + "Name": {}, + "Enabled": { + "type": "boolean" + }, + "MatchingEventTypes": { + "shape": "Sj" + }, + "KinesisFirehoseDestination": { + "shape": "Sl" + }, + "CloudWatchDestination": { + "shape": "Sn" + }, + "SnsDestination": { + "shape": "St" + }, + "PinpointDestination": { + "shape": "Su" + } + } + } + } + } + } + }, + "GetDedicatedIp": { + "http": { + "method": "GET", + "requestUri": "/v1/email/dedicated-ips/{IP}" + }, + "input": { + "type": "structure", + "required": [ + "Ip" + ], + "members": { + "Ip": { + "location": "uri", + "locationName": "IP" + } + } + }, + "output": { + "type": "structure", + "members": { + "DedicatedIp": { + "shape": "S2i" + } + } + } + }, + "GetDedicatedIps": { + "http": { + "method": "GET", + "requestUri": "/v1/email/dedicated-ips" + }, + "input": { + "type": "structure", + "members": { + "PoolName": {}, + "NextToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DedicatedIps": { + "type": "list", + "member": { + "shape": "S2i" + } + }, + "NextToken": {} + } + } + }, + "GetDeliverabilityDashboardOptions": { + "http": { + "method": "GET", + "requestUri": "/v1/email/deliverability-dashboard" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "DashboardEnabled" + ], + "members": { + "DashboardEnabled": { + "type": "boolean" + } + } + } + }, + "GetDeliverabilityTestReport": { + "http": { + "method": "GET", + "requestUri": "/v1/email/deliverability-dashboard/test-reports/{ReportId}" + }, + "input": { + "type": "structure", + "required": [ + "ReportId" + ], + "members": { + "ReportId": { + "location": "uri", + "locationName": "ReportId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DeliverabilityTestReport", + "OverallPlacement", + "IspPlacements" + ], + "members": { + "DeliverabilityTestReport": { + "shape": "S2u" + }, + "OverallPlacement": { + "shape": "S2w" + }, + "IspPlacements": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IspName": {}, + "PlacementStatistics": { + "shape": "S2w" + } + } + } + }, + "Message": {} + } + } + }, + "GetDomainStatisticsReport": { + "http": { + "method": "GET", + "requestUri": "/v1/email/deliverability-dashboard/statistics-report/{Domain}" + }, + "input": { + "type": "structure", + "required": [ + "Domain", + "StartDate", + "EndDate" + ], + "members": { + "Domain": { + "location": "uri", + "locationName": "Domain" + }, + "StartDate": { + "type": "timestamp" + }, + "EndDate": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OverallVolume", + "DailyVolumes" + ], + "members": { + "OverallVolume": { + "type": "structure", + "members": { + "VolumeStatistics": { + "shape": "S35" + }, + "ReadRatePercent": { + "type": "double" + }, + "DomainIspPlacements": { + "shape": "S37" + } + } + }, + "DailyVolumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StartDate": { + "type": "timestamp" + }, + "VolumeStatistics": { + "shape": "S35" + }, + "DomainIspPlacements": { + "shape": "S37" + } + } + } + } + } + } + }, + "GetEmailIdentity": { + "http": { + "method": "GET", + "requestUri": "/v1/email/identities/{EmailIdentity}" + }, + "input": { + "type": "structure", + "required": [ + "EmailIdentity" + ], + "members": { + "EmailIdentity": { + "location": "uri", + "locationName": "EmailIdentity" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityType": {}, + "FeedbackForwardingStatus": { + "type": "boolean" + }, + "VerifiedForSendingStatus": { + "type": "boolean" + }, + "DkimAttributes": { + "shape": "S1g" + }, + "MailFromAttributes": { + "type": "structure", + "required": [ + "MailFromDomain", + "MailFromDomainStatus", + "BehaviorOnMxFailure" + ], + "members": { + "MailFromDomain": {}, + "MailFromDomainStatus": {}, + "BehaviorOnMxFailure": {} + } + } + } + } + }, + "ListConfigurationSets": { + "http": { + "method": "GET", + "requestUri": "/v1/email/configuration-sets" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationSets": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListDedicatedIpPools": { + "http": { + "method": "GET", + "requestUri": "/v1/email/dedicated-ip-pools" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DedicatedIpPools": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListDeliverabilityTestReports": { + "http": { + "method": "GET", + "requestUri": "/v1/email/deliverability-dashboard/test-reports" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DeliverabilityTestReports" + ], + "members": { + "DeliverabilityTestReports": { + "type": "list", + "member": { + "shape": "S2u" + } + }, + "NextToken": {} + } + } + }, + "ListEmailIdentities": { + "http": { + "method": "GET", + "requestUri": "/v1/email/identities" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "EmailIdentities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IdentityType": {}, + "IdentityName": {}, + "SendingEnabled": { + "type": "boolean" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/v1/email/tags" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "Sb" + } + } + } + }, + "PutAccountDedicatedIpWarmupAttributes": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/account/dedicated-ips/warmup" + }, + "input": { + "type": "structure", + "members": { + "AutoWarmupEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutAccountSendingAttributes": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/account/sending" + }, + "input": { + "type": "structure", + "members": { + "SendingEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutConfigurationSetDeliveryOptions": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/delivery-options" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "SendingPoolName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutConfigurationSetReputationOptions": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/reputation-options" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "ReputationMetricsEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutConfigurationSetSendingOptions": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/sending" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "SendingEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutConfigurationSetTrackingOptions": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/tracking-options" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "CustomRedirectDomain": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutDedicatedIpInPool": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/dedicated-ips/{IP}/pool" + }, + "input": { + "type": "structure", + "required": [ + "Ip", + "DestinationPoolName" + ], + "members": { + "Ip": { + "location": "uri", + "locationName": "IP" + }, + "DestinationPoolName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutDedicatedIpWarmupAttributes": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/dedicated-ips/{IP}/warmup" + }, + "input": { + "type": "structure", + "required": [ + "Ip", + "WarmupPercentage" + ], + "members": { + "Ip": { + "location": "uri", + "locationName": "IP" + }, + "WarmupPercentage": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutDeliverabilityDashboardOption": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/deliverability-dashboard" + }, + "input": { + "type": "structure", + "required": [ + "DashboardEnabled" + ], + "members": { + "DashboardEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutEmailIdentityDkimAttributes": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/identities/{EmailIdentity}/dkim" + }, + "input": { + "type": "structure", + "required": [ + "EmailIdentity" + ], + "members": { + "EmailIdentity": { + "location": "uri", + "locationName": "EmailIdentity" + }, + "SigningEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutEmailIdentityFeedbackAttributes": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/identities/{EmailIdentity}/feedback" + }, + "input": { + "type": "structure", + "required": [ + "EmailIdentity" + ], + "members": { + "EmailIdentity": { + "location": "uri", + "locationName": "EmailIdentity" + }, + "EmailForwardingEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutEmailIdentityMailFromAttributes": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/identities/{EmailIdentity}/mail-from" + }, + "input": { + "type": "structure", + "required": [ + "EmailIdentity" + ], + "members": { + "EmailIdentity": { + "location": "uri", + "locationName": "EmailIdentity" + }, + "MailFromDomain": {}, + "BehaviorOnMxFailure": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SendEmail": { + "http": { + "requestUri": "/v1/email/outbound-emails" + }, + "input": { + "type": "structure", + "required": [ + "Destination", + "Content" + ], + "members": { + "FromEmailAddress": {}, + "Destination": { + "type": "structure", + "members": { + "ToAddresses": { + "shape": "S4n" + }, + "CcAddresses": { + "shape": "S4n" + }, + "BccAddresses": { + "shape": "S4n" + } + } + }, + "ReplyToAddresses": { + "shape": "S4n" + }, + "FeedbackForwardingEmailAddress": {}, + "Content": { + "shape": "S11" + }, + "EmailTags": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "ConfigurationSetName": {} + } + }, + "output": { + "type": "structure", + "members": { + "MessageId": {} + } + } + }, + "TagResource": { + "http": { + "requestUri": "/v1/email/tags" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/v1/email/tags" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": { + "location": "querystring", + "locationName": "ResourceArn" + }, + "TagKeys": { + "location": "querystring", + "locationName": "TagKeys", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateConfigurationSetEventDestination": { + "http": { + "method": "PUT", + "requestUri": "/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}" + }, + "input": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestinationName", + "EventDestination" + ], + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "EventDestinationName": { + "location": "uri", + "locationName": "EventDestinationName" + }, + "EventDestination": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "required": [ + "CustomRedirectDomain" + ], + "members": { + "CustomRedirectDomain": {} + } + }, + "S5": { + "type": "structure", + "members": { + "SendingPoolName": {} + } + }, + "S7": { + "type": "structure", + "members": { + "ReputationMetricsEnabled": { + "type": "boolean" + }, + "LastFreshStart": { + "type": "timestamp" + } + } + }, + "Sa": { + "type": "structure", + "members": { + "SendingEnabled": { + "type": "boolean" + } + } + }, + "Sb": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Si": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + }, + "MatchingEventTypes": { + "shape": "Sj" + }, + "KinesisFirehoseDestination": { + "shape": "Sl" + }, + "CloudWatchDestination": { + "shape": "Sn" + }, + "SnsDestination": { + "shape": "St" + }, + "PinpointDestination": { + "shape": "Su" + } + } + }, + "Sj": { + "type": "list", + "member": {} + }, + "Sl": { + "type": "structure", + "required": [ + "IamRoleArn", + "DeliveryStreamArn" + ], + "members": { + "IamRoleArn": {}, + "DeliveryStreamArn": {} + } + }, + "Sn": { + "type": "structure", + "required": [ + "DimensionConfigurations" + ], + "members": { + "DimensionConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DimensionName", + "DimensionValueSource", + "DefaultDimensionValue" + ], + "members": { + "DimensionName": {}, + "DimensionValueSource": {}, + "DefaultDimensionValue": {} + } + } + } + } + }, + "St": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {} + } + }, + "Su": { + "type": "structure", + "members": { + "ApplicationArn": {} + } + }, + "S11": { + "type": "structure", + "members": { + "Simple": { + "type": "structure", + "required": [ + "Subject", + "Body" + ], + "members": { + "Subject": { + "shape": "S13" + }, + "Body": { + "type": "structure", + "members": { + "Text": { + "shape": "S13" + }, + "Html": { + "shape": "S13" + } + } + } + } + }, + "Raw": { + "type": "structure", + "required": [ + "Data" + ], + "members": { + "Data": { + "type": "blob" + } + } + } + } + }, + "S13": { + "type": "structure", + "required": [ + "Data" + ], + "members": { + "Data": {}, + "Charset": {} + } + }, + "S1g": { + "type": "structure", + "members": { + "SigningEnabled": { + "type": "boolean" + }, + "Status": {}, + "Tokens": { + "type": "list", + "member": {} + } + } + }, + "S2i": { + "type": "structure", + "required": [ + "Ip", + "WarmupStatus", + "WarmupPercentage" + ], + "members": { + "Ip": {}, + "WarmupStatus": {}, + "WarmupPercentage": { + "type": "integer" + }, + "PoolName": {} + } + }, + "S2u": { + "type": "structure", + "members": { + "ReportId": {}, + "ReportName": {}, + "Subject": {}, + "FromEmailAddress": {}, + "CreateDate": { + "type": "timestamp" + }, + "DeliverabilityTestStatus": {} + } + }, + "S2w": { + "type": "structure", + "members": { + "InboxPercentage": { + "type": "double" + }, + "SpamPercentage": { + "type": "double" + }, + "MissingPercentage": { + "type": "double" + }, + "SpfPercentage": { + "type": "double" + }, + "DkimPercentage": { + "type": "double" + } + } + }, + "S35": { + "type": "structure", + "members": { + "InboxRawCount": { + "type": "long" + }, + "SpamRawCount": { + "type": "long" + }, + "ProjectedInbox": { + "type": "long" + }, + "ProjectedSpam": { + "type": "long" + } + } + }, + "S37": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IspName": {}, + "InboxRawCount": { + "type": "long" + }, + "SpamRawCount": { + "type": "long" + }, + "InboxPercentage": { + "type": "double" + }, + "SpamPercentage": { + "type": "double" + } + } + } + }, + "S4n": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.paginators.json b/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.paginators.json new file mode 100644 index 0000000..447d3ec --- /dev/null +++ b/node_modules/aws-sdk/apis/pinpoint-email-2018-07-26.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "GetDedicatedIps": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize" + }, + "ListConfigurationSets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize" + }, + "ListDedicatedIpPools": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize" + }, + "ListDeliverabilityTestReports": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize" + }, + "ListEmailIdentities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize" + } + } +} diff --git a/node_modules/aws-sdk/apis/polly-2016-06-10.examples.json b/node_modules/aws-sdk/apis/polly-2016-06-10.examples.json new file mode 100644 index 0000000..38205db --- /dev/null +++ b/node_modules/aws-sdk/apis/polly-2016-06-10.examples.json @@ -0,0 +1,171 @@ +{ + "version": "1.0", + "examples": { + "DeleteLexicon": [ + { + "input": { + "Name": "example" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes a specified pronunciation lexicon stored in an AWS Region.", + "id": "to-delete-a-lexicon-1481922498332", + "title": "To delete a lexicon" + } + ], + "DescribeVoices": [ + { + "input": { + "LanguageCode": "en-GB" + }, + "output": { + "Voices": [ + { + "Gender": "Female", + "Id": "Emma", + "LanguageCode": "en-GB", + "LanguageName": "British English", + "Name": "Emma" + }, + { + "Gender": "Male", + "Id": "Brian", + "LanguageCode": "en-GB", + "LanguageName": "British English", + "Name": "Brian" + }, + { + "Gender": "Female", + "Id": "Amy", + "LanguageCode": "en-GB", + "LanguageName": "British English", + "Name": "Amy" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those within the specified language code. If no language code is specified, voices for all available languages are displayed.", + "id": "to-describe-available-voices-1482180557753", + "title": "To describe available voices" + } + ], + "GetLexicon": [ + { + "input": { + "Name": "" + }, + "output": { + "Lexicon": { + "Content": "\r\n\r\n \r\n W3C\r\n World Wide Web Consortium\r\n \r\n", + "Name": "example" + }, + "LexiconAttributes": { + "Alphabet": "ipa", + "LanguageCode": "en-US", + "LastModified": 1478542980.117, + "LexemesCount": 1, + "LexiconArn": "arn:aws:polly:us-east-1:123456789012:lexicon/example", + "Size": 503 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the content of the specified pronunciation lexicon stored in an AWS Region.", + "id": "to-retrieve-a-lexicon-1481912870836", + "title": "To retrieve a lexicon" + } + ], + "ListLexicons": [ + { + "input": { + }, + "output": { + "Lexicons": [ + { + "Attributes": { + "Alphabet": "ipa", + "LanguageCode": "en-US", + "LastModified": 1478542980.117, + "LexemesCount": 1, + "LexiconArn": "arn:aws:polly:us-east-1:123456789012:lexicon/example", + "Size": 503 + }, + "Name": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a list of pronunciation lexicons stored in an AWS Region.", + "id": "to-list-all-lexicons-in-a-region-1481842106487", + "title": "To list all lexicons in a region" + } + ], + "PutLexicon": [ + { + "input": { + "Content": "file://example.pls", + "Name": "W3C" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Stores a pronunciation lexicon in an AWS Region.", + "id": "to-save-a-lexicon-1482272584088", + "title": "To save a lexicon" + } + ], + "SynthesizeSpeech": [ + { + "input": { + "LexiconNames": [ + "example" + ], + "OutputFormat": "mp3", + "SampleRate": "8000", + "Text": "All Gaul is divided into three parts", + "TextType": "text", + "VoiceId": "Joanna" + }, + "output": { + "AudioStream": "TEXT", + "ContentType": "audio/mpeg", + "RequestCharacters": 37 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Synthesizes plain text or SSML into a file of human-like speech.", + "id": "to-synthesize-speech-1482186064046", + "title": "To synthesize speech" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/polly-2016-06-10.min.json b/node_modules/aws-sdk/apis/polly-2016-06-10.min.json new file mode 100644 index 0000000..290c3f1 --- /dev/null +++ b/node_modules/aws-sdk/apis/polly-2016-06-10.min.json @@ -0,0 +1,396 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-06-10", + "endpointPrefix": "polly", + "protocol": "rest-json", + "serviceFullName": "Amazon Polly", + "serviceId": "Polly", + "signatureVersion": "v4", + "uid": "polly-2016-06-10" + }, + "operations": { + "DeleteLexicon": { + "http": { + "method": "DELETE", + "requestUri": "/v1/lexicons/{LexiconName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": { + "shape": "S2", + "location": "uri", + "locationName": "LexiconName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeVoices": { + "http": { + "method": "GET", + "requestUri": "/v1/voices", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "LanguageCode": { + "location": "querystring", + "locationName": "LanguageCode" + }, + "IncludeAdditionalLanguageCodes": { + "location": "querystring", + "locationName": "IncludeAdditionalLanguageCodes", + "type": "boolean" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Voices": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Gender": {}, + "Id": {}, + "LanguageCode": {}, + "LanguageName": {}, + "Name": {}, + "AdditionalLanguageCodes": { + "type": "list", + "member": {} + } + } + } + }, + "NextToken": {} + } + } + }, + "GetLexicon": { + "http": { + "method": "GET", + "requestUri": "/v1/lexicons/{LexiconName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": { + "shape": "S2", + "location": "uri", + "locationName": "LexiconName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Lexicon": { + "type": "structure", + "members": { + "Content": {}, + "Name": { + "shape": "S2" + } + } + }, + "LexiconAttributes": { + "shape": "Sk" + } + } + } + }, + "GetSpeechSynthesisTask": { + "http": { + "method": "GET", + "requestUri": "/v1/synthesisTasks/{TaskId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "TaskId" + ], + "members": { + "TaskId": { + "location": "uri", + "locationName": "TaskId" + } + } + }, + "output": { + "type": "structure", + "members": { + "SynthesisTask": { + "shape": "St" + } + } + } + }, + "ListLexicons": { + "http": { + "method": "GET", + "requestUri": "/v1/lexicons", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Lexicons": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": { + "shape": "S2" + }, + "Attributes": { + "shape": "Sk" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListSpeechSynthesisTasks": { + "http": { + "method": "GET", + "requestUri": "/v1/synthesisTasks", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "Status": { + "location": "querystring", + "locationName": "Status" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "SynthesisTasks": { + "type": "list", + "member": { + "shape": "St" + } + } + } + } + }, + "PutLexicon": { + "http": { + "method": "PUT", + "requestUri": "/v1/lexicons/{LexiconName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "Content" + ], + "members": { + "Name": { + "shape": "S2", + "location": "uri", + "locationName": "LexiconName" + }, + "Content": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartSpeechSynthesisTask": { + "http": { + "requestUri": "/v1/synthesisTasks", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "OutputFormat", + "OutputS3BucketName", + "Text", + "VoiceId" + ], + "members": { + "LexiconNames": { + "shape": "S10" + }, + "OutputFormat": {}, + "OutputS3BucketName": {}, + "OutputS3KeyPrefix": {}, + "SampleRate": {}, + "SnsTopicArn": {}, + "SpeechMarkTypes": { + "shape": "S13" + }, + "Text": {}, + "TextType": {}, + "VoiceId": {}, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "members": { + "SynthesisTask": { + "shape": "St" + } + } + } + }, + "SynthesizeSpeech": { + "http": { + "requestUri": "/v1/speech", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "OutputFormat", + "Text", + "VoiceId" + ], + "members": { + "LexiconNames": { + "shape": "S10" + }, + "OutputFormat": {}, + "SampleRate": {}, + "SpeechMarkTypes": { + "shape": "S13" + }, + "Text": {}, + "TextType": {}, + "VoiceId": {}, + "LanguageCode": {} + } + }, + "output": { + "type": "structure", + "members": { + "AudioStream": { + "type": "blob", + "streaming": true + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "RequestCharacters": { + "location": "header", + "locationName": "x-amzn-RequestCharacters", + "type": "integer" + } + }, + "payload": "AudioStream" + } + } + }, + "shapes": { + "S2": { + "type": "string", + "sensitive": true + }, + "Sk": { + "type": "structure", + "members": { + "Alphabet": {}, + "LanguageCode": {}, + "LastModified": { + "type": "timestamp" + }, + "LexiconArn": {}, + "LexemesCount": { + "type": "integer" + }, + "Size": { + "type": "integer" + } + } + }, + "St": { + "type": "structure", + "members": { + "TaskId": {}, + "TaskStatus": {}, + "TaskStatusReason": {}, + "OutputUri": {}, + "CreationTime": { + "type": "timestamp" + }, + "RequestCharacters": { + "type": "integer" + }, + "SnsTopicArn": {}, + "LexiconNames": { + "shape": "S10" + }, + "OutputFormat": {}, + "SampleRate": {}, + "SpeechMarkTypes": { + "shape": "S13" + }, + "TextType": {}, + "VoiceId": {}, + "LanguageCode": {} + } + }, + "S10": { + "type": "list", + "member": { + "shape": "S2" + } + }, + "S13": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/polly-2016-06-10.paginators.json b/node_modules/aws-sdk/apis/polly-2016-06-10.paginators.json new file mode 100644 index 0000000..3b06676 --- /dev/null +++ b/node_modules/aws-sdk/apis/polly-2016-06-10.paginators.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "ListSpeechSynthesisTasks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/pricing-2017-10-15.examples.json b/node_modules/aws-sdk/apis/pricing-2017-10-15.examples.json new file mode 100644 index 0000000..90aa3ef --- /dev/null +++ b/node_modules/aws-sdk/apis/pricing-2017-10-15.examples.json @@ -0,0 +1,103 @@ +{ + "version": "1.0", + "examples": { + "DescribeServices": [ + { + "input": { + "FormatVersion": "aws_v1", + "MaxResults": 1, + "ServiceCode": "AmazonEC2" + }, + "output": { + "FormatVersion": "aws_v1", + "NextToken": "abcdefg123", + "Services": [ + { + "AttributeNames": [ + "volumeType", + "maxIopsvolume", + "instanceCapacity10xlarge", + "locationType", + "operation" + ], + "ServiceCode": "AmazonEC2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "id": "to-retrieve-service-metadata", + "title": "To retrieve a list of services and service codes" + } + ], + "GetAttributeValues": [ + { + "input": { + "AttributeName": "volumeType", + "MaxResults": 2, + "ServiceCode": "AmazonEC2" + }, + "output": { + "AttributeValues": [ + { + "Value": "Throughput Optimized HDD" + }, + { + "Value": "Provisioned IOPS" + } + ], + "NextToken": "GpgauEXAMPLEezucl5LV0w==:7GzYJ0nw0DBTJ2J66EoTIIynE6O1uXwQtTRqioJzQadBnDVgHPzI1en4BUQnPCLpzeBk9RQQAWaFieA4+DapFAGLgk+Z/9/cTw9GldnPOHN98+FdmJP7wKU3QQpQ8MQr5KOeBkIsAqvAQYdL0DkL7tHwPtE5iCEByAmg9gcC/yBU1vAOsf7R3VaNN4M5jMDv3woSWqASSIlBVB6tgW78YL22KhssoItM/jWW+aP6Jqtq4mldxp/ct6DWAl+xLFwHU/CbketimPPXyqHF3/UXDw==" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation returns a list of values available for the given attribute.", + "id": "to-retreive-attribute-values", + "title": "To retrieve a list of attribute values" + } + ], + "GetProducts": [ + { + "input": { + "Filters": [ + { + "Field": "ServiceCode", + "Type": "TERM_MATCH", + "Value": "AmazonEC2" + }, + { + "Field": "volumeType", + "Type": "TERM_MATCH", + "Value": "Provisioned IOPS" + } + ], + "FormatVersion": "aws_v1", + "MaxResults": 1 + }, + "output": { + "FormatVersion": "aws_v1", + "NextToken": "57r3EXAMPLEujbzWfHF7Ciw==:ywSmZsD3mtpQmQLQ5XfOsIMkYybSj+vAT+kGmwMFq+K9DGmIoJkz7lunVeamiOPgthdWSO2a7YKojCO+zY4dJmuNl2QvbNhXs+AJ2Ufn7xGmJncNI2TsEuAsVCUfTAvAQNcwwamtk6XuZ4YdNnooV62FjkV3ZAn40d9+wAxV7+FImvhUHi/+f8afgZdGh2zPUlH8jlV9uUtj0oHp8+DhPUuHXh+WBII1E/aoKpPSm3c=", + "PriceList": [ + "{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"storageMedia\":\"SSD-backed\",\"maxThroughputvolume\":\"320 MB/sec\",\"volumeType\":\"Provisioned IOPS\",\"maxIopsvolume\":\"20000\",\"servicecode\":\"AmazonEC2\",\"usagetype\":\"CAN1-EBS:VolumeUsage.piops\",\"locationType\":\"AWS Region\",\"location\":\"Canada (Central)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"maxVolumeSize\":\"16 TiB\",\"operation\":\"\"},\"sku\":\"WQGC34PB2AWS8R4U\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF\":{\"priceDimensions\":{\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.138 per GB-month of Provisioned IOPS SSD (io1) provisioned storage - Canada (Central)\",\"appliesTo\":[],\"rateCode\":\"WQGC34PB2AWS8R4U.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1380000000\"}}},\"sku\":\"WQGC34PB2AWS8R4U\",\"effectiveDate\":\"2017-08-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20170901182201\",\"publicationDate\":\"2017-09-01T18:22:01Z\"}" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation returns a list of products that match the given criteria.", + "id": "to-retrieve-available products", + "title": "To retrieve a list of products" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/pricing-2017-10-15.min.json b/node_modules/aws-sdk/apis/pricing-2017-10-15.min.json new file mode 100644 index 0000000..9a72067 --- /dev/null +++ b/node_modules/aws-sdk/apis/pricing-2017-10-15.min.json @@ -0,0 +1,126 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-10-15", + "endpointPrefix": "api.pricing", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "AWS Pricing", + "serviceFullName": "AWS Price List Service", + "serviceId": "Pricing", + "signatureVersion": "v4", + "signingName": "pricing", + "targetPrefix": "AWSPriceListService", + "uid": "pricing-2017-10-15" + }, + "operations": { + "DescribeServices": { + "input": { + "type": "structure", + "members": { + "ServiceCode": {}, + "FormatVersion": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Services": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ServiceCode": {}, + "AttributeNames": { + "type": "list", + "member": {} + } + } + } + }, + "FormatVersion": {}, + "NextToken": {} + } + } + }, + "GetAttributeValues": { + "input": { + "type": "structure", + "required": [ + "ServiceCode", + "AttributeName" + ], + "members": { + "ServiceCode": {}, + "AttributeName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttributeValues": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": {} + } + } + }, + "NextToken": {} + } + } + }, + "GetProducts": { + "input": { + "type": "structure", + "members": { + "ServiceCode": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Type", + "Field", + "Value" + ], + "members": { + "Type": {}, + "Field": {}, + "Value": {} + } + } + }, + "FormatVersion": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FormatVersion": {}, + "PriceList": { + "type": "list", + "member": { + "jsonvalue": true + } + }, + "NextToken": {} + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/pricing-2017-10-15.paginators.json b/node_modules/aws-sdk/apis/pricing-2017-10-15.paginators.json new file mode 100644 index 0000000..f4b247c --- /dev/null +++ b/node_modules/aws-sdk/apis/pricing-2017-10-15.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "DescribeServices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetAttributeValues": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetProducts": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/quicksight-2018-04-01.examples.json b/node_modules/aws-sdk/apis/quicksight-2018-04-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/quicksight-2018-04-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json b/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json new file mode 100644 index 0000000..e53567b --- /dev/null +++ b/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json @@ -0,0 +1,765 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-04-01", + "endpointPrefix": "quicksight", + "jsonVersion": "1.0", + "protocol": "rest-json", + "serviceFullName": "Amazon QuickSight", + "serviceId": "QuickSight", + "signatureVersion": "v4", + "uid": "quicksight-2018-04-01" + }, + "operations": { + "CreateGroup": { + "http": { + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups" + }, + "input": { + "type": "structure", + "required": [ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members": { + "GroupName": {}, + "Description": {}, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "S7" + }, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "CreateGroupMembership": { + "http": { + "method": "PUT", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}" + }, + "input": { + "type": "structure", + "required": [ + "MemberName", + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members": { + "MemberName": { + "location": "uri", + "locationName": "MemberName" + }, + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupMember": { + "shape": "Se" + }, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "DeleteGroup": { + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}" + }, + "input": { + "type": "structure", + "required": [ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "DeleteGroupMembership": { + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}" + }, + "input": { + "type": "structure", + "required": [ + "MemberName", + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members": { + "MemberName": { + "location": "uri", + "locationName": "MemberName" + }, + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "DeleteUser": { + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}" + }, + "input": { + "type": "structure", + "required": [ + "UserName", + "AwsAccountId", + "Namespace" + ], + "members": { + "UserName": { + "location": "uri", + "locationName": "UserName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "DeleteUserByPrincipalId": { + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}" + }, + "input": { + "type": "structure", + "required": [ + "PrincipalId", + "AwsAccountId", + "Namespace" + ], + "members": { + "PrincipalId": { + "location": "uri", + "locationName": "PrincipalId" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "DescribeGroup": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}" + }, + "input": { + "type": "structure", + "required": [ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "S7" + }, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "DescribeUser": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}" + }, + "input": { + "type": "structure", + "required": [ + "UserName", + "AwsAccountId", + "Namespace" + ], + "members": { + "UserName": { + "location": "uri", + "locationName": "UserName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "Ss" + }, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "GetDashboardEmbedUrl": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url" + }, + "input": { + "type": "structure", + "required": [ + "AwsAccountId", + "DashboardId", + "IdentityType" + ], + "members": { + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "DashboardId": { + "location": "uri", + "locationName": "DashboardId" + }, + "IdentityType": { + "location": "querystring", + "locationName": "creds-type" + }, + "SessionLifetimeInMinutes": { + "location": "querystring", + "locationName": "session-lifetime", + "type": "long" + }, + "UndoRedoDisabled": { + "location": "querystring", + "locationName": "undo-redo-disabled", + "type": "boolean" + }, + "ResetDisabled": { + "location": "querystring", + "locationName": "reset-disabled", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "EmbedUrl": { + "type": "string", + "sensitive": true + }, + "Status": { + "location": "statusCode", + "type": "integer" + }, + "RequestId": {} + } + } + }, + "ListGroupMemberships": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members" + }, + "input": { + "type": "structure", + "required": [ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupMemberList": { + "type": "list", + "member": { + "shape": "Se" + } + }, + "NextToken": {}, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "ListGroups": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups" + }, + "input": { + "type": "structure", + "required": [ + "AwsAccountId", + "Namespace" + ], + "members": { + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupList": { + "shape": "S17" + }, + "NextToken": {}, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "ListUserGroups": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups" + }, + "input": { + "type": "structure", + "required": [ + "UserName", + "AwsAccountId", + "Namespace" + ], + "members": { + "UserName": { + "location": "uri", + "locationName": "UserName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupList": { + "shape": "S17" + }, + "NextToken": {}, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "ListUsers": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users" + }, + "input": { + "type": "structure", + "required": [ + "AwsAccountId", + "Namespace" + ], + "members": { + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserList": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "NextToken": {}, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "RegisterUser": { + "http": { + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users" + }, + "input": { + "type": "structure", + "required": [ + "IdentityType", + "Email", + "UserRole", + "AwsAccountId", + "Namespace" + ], + "members": { + "IdentityType": {}, + "Email": {}, + "UserRole": {}, + "IamArn": {}, + "SessionName": {}, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + }, + "UserName": {} + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "Ss" + }, + "UserInvitationUrl": {}, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "UpdateGroup": { + "http": { + "method": "PUT", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}" + }, + "input": { + "type": "structure", + "required": [ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "Description": {}, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "S7" + }, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, + "UpdateUser": { + "http": { + "method": "PUT", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}" + }, + "input": { + "type": "structure", + "required": [ + "UserName", + "AwsAccountId", + "Namespace", + "Email", + "Role" + ], + "members": { + "UserName": { + "location": "uri", + "locationName": "UserName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + }, + "Email": {}, + "Role": {} + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "Ss" + }, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "Arn": {}, + "GroupName": {}, + "Description": {}, + "PrincipalId": {} + } + }, + "Se": { + "type": "structure", + "members": { + "Arn": {}, + "MemberName": {} + } + }, + "Ss": { + "type": "structure", + "members": { + "Arn": {}, + "UserName": {}, + "Email": {}, + "Role": {}, + "IdentityType": {}, + "Active": { + "type": "boolean" + }, + "PrincipalId": {} + } + }, + "S17": { + "type": "list", + "member": { + "shape": "S7" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/quicksight-2018-04-01.paginators.json b/node_modules/aws-sdk/apis/quicksight-2018-04-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/quicksight-2018-04-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/ram-2018-01-04.examples.json b/node_modules/aws-sdk/apis/ram-2018-01-04.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/ram-2018-01-04.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/ram-2018-01-04.min.json b/node_modules/aws-sdk/apis/ram-2018-01-04.min.json new file mode 100644 index 0000000..c3f2ed2 --- /dev/null +++ b/node_modules/aws-sdk/apis/ram-2018-01-04.min.json @@ -0,0 +1,613 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-01-04", + "endpointPrefix": "ram", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "RAM", + "serviceFullName": "AWS Resource Access Manager", + "serviceId": "RAM", + "signatureVersion": "v4", + "uid": "ram-2018-01-04" + }, + "operations": { + "AcceptResourceShareInvitation": { + "http": { + "requestUri": "/acceptresourceshareinvitation" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareInvitationArn" + ], + "members": { + "resourceShareInvitationArn": {}, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceShareInvitation": { + "shape": "S4" + }, + "clientToken": {} + } + } + }, + "AssociateResourceShare": { + "http": { + "requestUri": "/associateresourceshare" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareArn" + ], + "members": { + "resourceShareArn": {}, + "resourceArns": { + "shape": "Sd" + }, + "principals": { + "shape": "Se" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceShareAssociations": { + "shape": "S7" + }, + "clientToken": {} + } + } + }, + "CreateResourceShare": { + "http": { + "requestUri": "/createresourceshare" + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "resourceArns": { + "shape": "Sd" + }, + "principals": { + "shape": "Se" + }, + "tags": { + "shape": "Sh" + }, + "allowExternalPrincipals": { + "type": "boolean" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceShare": { + "shape": "Sm" + }, + "clientToken": {} + } + } + }, + "DeleteResourceShare": { + "http": { + "method": "DELETE", + "requestUri": "/deleteresourceshare" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareArn" + ], + "members": { + "resourceShareArn": { + "location": "querystring", + "locationName": "resourceShareArn" + }, + "clientToken": { + "location": "querystring", + "locationName": "clientToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "returnValue": { + "type": "boolean" + }, + "clientToken": {} + } + } + }, + "DisassociateResourceShare": { + "http": { + "requestUri": "/disassociateresourceshare" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareArn" + ], + "members": { + "resourceShareArn": {}, + "resourceArns": { + "shape": "Sd" + }, + "principals": { + "shape": "Se" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceShareAssociations": { + "shape": "S7" + }, + "clientToken": {} + } + } + }, + "EnableSharingWithAwsOrganization": { + "http": { + "requestUri": "/enablesharingwithawsorganization" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "returnValue": { + "type": "boolean" + } + } + } + }, + "GetResourcePolicies": { + "http": { + "requestUri": "/getresourcepolicies" + }, + "input": { + "type": "structure", + "required": [ + "resourceArns" + ], + "members": { + "resourceArns": { + "shape": "Sd" + }, + "principal": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "policies": { + "type": "list", + "member": {} + }, + "nextToken": {} + } + } + }, + "GetResourceShareAssociations": { + "http": { + "requestUri": "/getresourceshareassociations" + }, + "input": { + "type": "structure", + "required": [ + "associationType" + ], + "members": { + "associationType": {}, + "resourceShareArns": { + "shape": "S10" + }, + "resourceArn": {}, + "principal": {}, + "associationStatus": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resourceShareAssociations": { + "shape": "S7" + }, + "nextToken": {} + } + } + }, + "GetResourceShareInvitations": { + "http": { + "requestUri": "/getresourceshareinvitations" + }, + "input": { + "type": "structure", + "members": { + "resourceShareInvitationArns": { + "type": "list", + "member": {} + }, + "resourceShareArns": { + "shape": "S10" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resourceShareInvitations": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "nextToken": {} + } + } + }, + "GetResourceShares": { + "http": { + "requestUri": "/getresourceshares" + }, + "input": { + "type": "structure", + "required": [ + "resourceOwner" + ], + "members": { + "resourceShareArns": { + "shape": "S10" + }, + "resourceShareStatus": {}, + "resourceOwner": {}, + "name": {}, + "tagFilters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "tagKey": {}, + "tagValues": { + "type": "list", + "member": {} + } + } + } + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resourceShares": { + "type": "list", + "member": { + "shape": "Sm" + } + }, + "nextToken": {} + } + } + }, + "ListPrincipals": { + "http": { + "requestUri": "/listprincipals" + }, + "input": { + "type": "structure", + "required": [ + "resourceOwner" + ], + "members": { + "resourceOwner": {}, + "resourceArn": {}, + "principals": { + "shape": "Se" + }, + "resourceType": {}, + "resourceShareArns": { + "shape": "S10" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "principals": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "resourceShareArn": {}, + "creationTime": { + "type": "timestamp" + }, + "lastUpdatedTime": { + "type": "timestamp" + }, + "external": { + "type": "boolean" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListResources": { + "http": { + "requestUri": "/listresources" + }, + "input": { + "type": "structure", + "required": [ + "resourceOwner" + ], + "members": { + "resourceOwner": {}, + "principal": {}, + "resourceType": {}, + "resourceArns": { + "shape": "Sd" + }, + "resourceShareArns": { + "shape": "S10" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "resources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "type": {}, + "resourceShareArn": {}, + "status": {}, + "statusMessage": {}, + "creationTime": { + "type": "timestamp" + }, + "lastUpdatedTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "RejectResourceShareInvitation": { + "http": { + "requestUri": "/rejectresourceshareinvitation" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareInvitationArn" + ], + "members": { + "resourceShareInvitationArn": {}, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceShareInvitation": { + "shape": "S4" + }, + "clientToken": {} + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tagresource" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareArn", + "tags" + ], + "members": { + "resourceShareArn": {}, + "tags": { + "shape": "Sh" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "requestUri": "/untagresource" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareArn", + "tagKeys" + ], + "members": { + "resourceShareArn": {}, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateResourceShare": { + "http": { + "requestUri": "/updateresourceshare" + }, + "input": { + "type": "structure", + "required": [ + "resourceShareArn" + ], + "members": { + "resourceShareArn": {}, + "name": {}, + "allowExternalPrincipals": { + "type": "boolean" + }, + "clientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "resourceShare": { + "shape": "Sm" + }, + "clientToken": {} + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "resourceShareInvitationArn": {}, + "resourceShareName": {}, + "resourceShareArn": {}, + "senderAccountId": {}, + "receiverAccountId": {}, + "invitationTimestamp": { + "type": "timestamp" + }, + "status": {}, + "resourceShareAssociations": { + "shape": "S7" + } + } + }, + "S7": { + "type": "list", + "member": { + "type": "structure", + "members": { + "resourceShareArn": {}, + "associatedEntity": {}, + "associationType": {}, + "status": {}, + "statusMessage": {}, + "creationTime": { + "type": "timestamp" + }, + "lastUpdatedTime": { + "type": "timestamp" + }, + "external": { + "type": "boolean" + } + } + } + }, + "Sd": { + "type": "list", + "member": {} + }, + "Se": { + "type": "list", + "member": {} + }, + "Sh": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "Sm": { + "type": "structure", + "members": { + "resourceShareArn": {}, + "name": {}, + "owningAccountId": {}, + "allowExternalPrincipals": { + "type": "boolean" + }, + "status": {}, + "statusMessage": {}, + "tags": { + "shape": "Sh" + }, + "creationTime": { + "type": "timestamp" + }, + "lastUpdatedTime": { + "type": "timestamp" + } + } + }, + "S10": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ram-2018-01-04.paginators.json b/node_modules/aws-sdk/apis/ram-2018-01-04.paginators.json new file mode 100644 index 0000000..2f491c9 --- /dev/null +++ b/node_modules/aws-sdk/apis/ram-2018-01-04.paginators.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "GetResourcePolicies": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetResourceShareAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetResourceShareInvitations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetResourceShares": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListPrincipals": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/rds-2013-01-10.examples.json b/node_modules/aws-sdk/apis/rds-2013-01-10.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-01-10.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/rds-2013-01-10.min.json b/node_modules/aws-sdk/apis/rds-2013-01-10.min.json new file mode 100644 index 0000000..06451d4 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-01-10.min.json @@ -0,0 +1,1897 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-01-10", + "endpointPrefix": "rds", + "protocol": "query", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "serviceId": "RDS", + "signatureVersion": "v4", + "uid": "rds-2013-01-10", + "xmlNamespace": "http://rds.amazonaws.com/doc/2013-01-10/" + }, + "operations": { + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + } + }, + "output": { + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S1c" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {} + } + }, + "output": { + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1i" + } + } + }, + "output": { + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "SourceIds": { + "shape": "S5" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {} + } + }, + "output": { + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1o" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S25" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S25", + "locationName": "CharacterSet" + } + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "St", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "S1c", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2f" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S11", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2f" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {} + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S6" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S6" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S6" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "S1o", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S14", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S3m", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S3o" + } + }, + "wrapper": true + } + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S9" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2f" + } + } + }, + "output": { + "shape": "S3z", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1i" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sp" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sq" + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1o" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S3m" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2f" + } + } + }, + "output": { + "shape": "S3z", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "Id": {}, + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S5" + }, + "EventCategoriesList": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S5": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S6": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S9": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sd": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + } + }, + "wrapper": true + }, + "Sp": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "St": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "Sv" + }, + "VpcSecurityGroups": { + "shape": "Sx" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S11" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {} + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMembership": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + } + }, + "wrapper": true + }, + "Sv": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "Sx": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S14" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S14": { + "type": "structure", + "members": { + "Name": {}, + "ProvisionedIopsCapable": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1c": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1i": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1o": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sv" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sx" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {} + }, + "wrapper": true + }, + "S25": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S2f": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S3m": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S3o" + } + }, + "wrapper": true + }, + "S3o": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S3z": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2013-01-10.paginators.json b/node_modules/aws-sdk/apis/rds-2013-01-10.paginators.json new file mode 100644 index 0000000..2461b48 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-01-10.paginators.json @@ -0,0 +1,97 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "EngineDefaults.Marker", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstancesOfferings" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2013-02-12.examples.json b/node_modules/aws-sdk/apis/rds-2013-02-12.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-02-12.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/rds-2013-02-12.min.json b/node_modules/aws-sdk/apis/rds-2013-02-12.min.json new file mode 100644 index 0000000..e50c32f --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-02-12.min.json @@ -0,0 +1,2029 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-02-12", + "endpointPrefix": "rds", + "protocol": "query", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "serviceId": "RDS", + "signatureVersion": "v4", + "uid": "rds-2013-02-12", + "xmlNamespace": "http://rds.amazonaws.com/doc/2013-02-12/" + }, + "operations": { + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + } + }, + "output": { + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S1d" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {} + } + }, + "output": { + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1j" + } + } + }, + "output": { + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "SourceIds": { + "shape": "S5" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {} + } + }, + "output": { + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1p" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S28" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S28", + "locationName": "CharacterSet" + } + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "St", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBLogFiles": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "FilenameContains": {}, + "FileLastWritten": { + "type": "long" + }, + "FileSize": { + "type": "long" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBLogFilesResult", + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "type": "list", + "member": { + "locationName": "DescribeDBLogFilesDetails", + "type": "structure", + "members": { + "LogFileName": {}, + "LastWritten": { + "type": "long" + }, + "Size": { + "type": "long" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "S1d", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2n" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S11", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2n" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {} + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S6" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S6" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S6" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + }, + "Persistent": { + "type": "boolean" + }, + "OptionGroupOptionSettings": { + "type": "list", + "member": { + "locationName": "OptionGroupOptionSetting", + "type": "structure", + "members": { + "SettingName": {}, + "SettingDescription": {}, + "DefaultValue": {}, + "ApplyType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "S1p", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S14", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S3w", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S3y" + } + }, + "wrapper": true + } + } + } + } + }, + "DownloadDBLogFilePortion": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "LogFileName" + ], + "members": { + "DBInstanceIdentifier": {}, + "LogFileName": {}, + "Marker": {}, + "NumberOfLines": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DownloadDBLogFilePortionResult", + "type": "structure", + "members": { + "LogFileData": {}, + "Marker": {}, + "AdditionalDataPending": { + "type": "boolean" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S9" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2n" + } + } + }, + "output": { + "shape": "S4b", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1j" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sp" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sq" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1t", + "locationName": "OptionSetting" + } + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1p" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S3w" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2n" + } + } + }, + "output": { + "shape": "S4b", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S5" + }, + "EventCategoriesList": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S5": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S6": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S9": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sd": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + }, + "wrapper": true + }, + "Sp": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "St": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "Sv" + }, + "VpcSecurityGroups": { + "shape": "Sx" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S11" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {} + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "OptionGroupMembership", + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + } + }, + "wrapper": true + }, + "Sv": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "Sx": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S14" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S14": { + "type": "structure", + "members": { + "Name": {}, + "ProvisionedIopsCapable": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1d": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1j": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1p": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Persistent": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1t", + "locationName": "OptionSetting" + } + }, + "DBSecurityGroupMemberships": { + "shape": "Sv" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sx" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {} + }, + "wrapper": true + }, + "S1t": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "DefaultValue": {}, + "Description": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "IsCollection": { + "type": "boolean" + } + } + }, + "S28": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S2n": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S3w": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S3y" + } + }, + "wrapper": true + }, + "S3y": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S4b": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2013-02-12.paginators.json b/node_modules/aws-sdk/apis/rds-2013-02-12.paginators.json new file mode 100644 index 0000000..c51d8d1 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-02-12.paginators.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "EngineDefaults.Marker", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "output_token": "Marker", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2013-09-09.examples.json b/node_modules/aws-sdk/apis/rds-2013-09-09.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-09-09.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/rds-2013-09-09.min.json b/node_modules/aws-sdk/apis/rds-2013-09-09.min.json new file mode 100644 index 0000000..a420adc --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-09-09.min.json @@ -0,0 +1,2165 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-09-09", + "endpointPrefix": "rds", + "protocol": "query", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "serviceId": "RDS", + "signatureVersion": "v4", + "uid": "rds-2013-09-09", + "xmlNamespace": "http://rds.amazonaws.com/doc/2013-09-09/" + }, + "operations": { + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + }, + "DBSubnetGroupName": {} + } + }, + "output": { + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S1f" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1l" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "SourceIds": { + "shape": "S5" + }, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1r" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S2d" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S2d", + "locationName": "CharacterSet" + } + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "St", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBLogFiles": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "FilenameContains": {}, + "FileLastWritten": { + "type": "long" + }, + "FileSize": { + "type": "long" + }, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBLogFilesResult", + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "type": "list", + "member": { + "locationName": "DescribeDBLogFilesDetails", + "type": "structure", + "members": { + "LogFileName": {}, + "LastWritten": { + "type": "long" + }, + "Size": { + "type": "long" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "S1f", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2s" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S11", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2s" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {}, + "Filters": { + "shape": "S27" + } + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S6" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S6" + }, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S6" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + }, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "OptionGroupOptionSettings": { + "type": "list", + "member": { + "locationName": "OptionGroupOptionSetting", + "type": "structure", + "members": { + "SettingName": {}, + "SettingDescription": {}, + "DefaultValue": {}, + "ApplyType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Filters": { + "shape": "S27" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "S1r", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S14", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S41", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "Filters": { + "shape": "S27" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S43" + } + }, + "wrapper": true + } + } + } + } + }, + "DownloadDBLogFilePortion": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "LogFileName" + ], + "members": { + "DBInstanceIdentifier": {}, + "LogFileName": {}, + "Marker": {}, + "NumberOfLines": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DownloadDBLogFilePortionResult", + "type": "structure", + "members": { + "LogFileData": {}, + "Marker": {}, + "AdditionalDataPending": { + "type": "boolean" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {}, + "Filters": { + "shape": "S27" + } + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S9" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2s" + } + } + }, + "output": { + "shape": "S4g", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1l" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sp" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sq" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1v", + "locationName": "OptionSetting" + } + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1r" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S41" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2s" + } + } + }, + "output": { + "shape": "S4g", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S5" + }, + "EventCategoriesList": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S5": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S6": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S9": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sd": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PercentProgress": { + "type": "integer" + }, + "SourceRegion": {} + }, + "wrapper": true + }, + "Sp": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "St": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "Sv" + }, + "VpcSecurityGroups": { + "shape": "Sx" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S11" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {} + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "OptionGroupMembership", + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "StatusInfos": { + "type": "list", + "member": { + "locationName": "DBInstanceStatusInfo", + "type": "structure", + "members": { + "StatusType": {}, + "Normal": { + "type": "boolean" + }, + "Status": {}, + "Message": {} + } + } + } + }, + "wrapper": true + }, + "Sv": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "Sx": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S14" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S14": { + "type": "structure", + "members": { + "Name": {}, + "ProvisionedIopsCapable": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1f": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1l": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1r": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1v", + "locationName": "OptionSetting" + } + }, + "DBSecurityGroupMemberships": { + "shape": "Sv" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sx" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {} + }, + "wrapper": true + }, + "S1v": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "DefaultValue": {}, + "Description": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "IsCollection": { + "type": "boolean" + } + } + }, + "S27": { + "type": "list", + "member": { + "locationName": "Filter", + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": { + "locationName": "Value" + } + } + } + } + }, + "S2d": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S2s": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S41": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S43" + } + }, + "wrapper": true + }, + "S43": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S4g": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2013-09-09.paginators.json b/node_modules/aws-sdk/apis/rds-2013-09-09.paginators.json new file mode 100644 index 0000000..c51d8d1 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-09-09.paginators.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "EngineDefaults.Marker", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "output_token": "Marker", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2013-09-09.waiters2.json b/node_modules/aws-sdk/apis/rds-2013-09-09.waiters2.json new file mode 100644 index 0000000..b015007 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2013-09-09.waiters2.json @@ -0,0 +1,97 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/rds-2014-09-01.examples.json b/node_modules/aws-sdk/apis/rds-2014-09-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2014-09-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/rds-2014-09-01.min.json b/node_modules/aws-sdk/apis/rds-2014-09-01.min.json new file mode 100644 index 0000000..bf8534e --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2014-09-01.min.json @@ -0,0 +1,2238 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-09-01", + "endpointPrefix": "rds", + "protocol": "query", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "serviceId": "RDS", + "signatureVersion": "v4", + "uid": "rds-2014-09-01", + "xmlNamespace": "http://rds.amazonaws.com/doc/2014-09-01/" + }, + "operations": { + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members": { + "SourceDBParameterGroupIdentifier": {}, + "TargetDBParameterGroupIdentifier": {}, + "TargetDBParameterGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CopyDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "Sk" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sn" + } + } + } + }, + "CopyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "SourceOptionGroupIdentifier", + "TargetOptionGroupIdentifier", + "TargetOptionGroupDescription" + ], + "members": { + "SourceOptionGroupIdentifier": {}, + "TargetOptionGroupIdentifier": {}, + "TargetOptionGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CopyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "St" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "S13" + }, + "VpcSecurityGroupIds": { + "shape": "S14" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + }, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {} + } + }, + "output": { + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + }, + "DBSubnetGroupName": {}, + "StorageType": {} + } + }, + "output": { + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "Sk" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sn" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1u" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S1b" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "SourceIds": { + "shape": "S5" + }, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "St" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sn" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S2h" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S2h", + "locationName": "CharacterSet" + } + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "S17", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBLogFiles": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "FilenameContains": {}, + "FileLastWritten": { + "type": "long" + }, + "FileSize": { + "type": "long" + }, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBLogFilesResult", + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "type": "list", + "member": { + "locationName": "DescribeDBLogFilesDetails", + "type": "structure", + "members": { + "LogFileName": {}, + "LastWritten": { + "type": "long" + }, + "Size": { + "type": "long" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2w" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "Sn", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S1b", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2w" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {}, + "Filters": { + "shape": "S2b" + } + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S6" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S6" + }, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S6" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + }, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "OptionGroupOptionSettings": { + "type": "list", + "member": { + "locationName": "OptionGroupOptionSetting", + "type": "structure", + "members": { + "SettingName": {}, + "SettingDescription": {}, + "DefaultValue": {}, + "ApplyType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Filters": { + "shape": "S2b" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "St", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S1e", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + }, + "StorageType": {}, + "SupportsIops": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S45", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "Filters": { + "shape": "S2b" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S47" + } + }, + "wrapper": true + } + } + } + } + }, + "DownloadDBLogFilePortion": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "LogFileName" + ], + "members": { + "DBInstanceIdentifier": {}, + "LogFileName": {}, + "Marker": {}, + "NumberOfLines": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DownloadDBLogFilePortionResult", + "type": "structure", + "members": { + "LogFileData": {}, + "Marker": {}, + "AdditionalDataPending": { + "type": "boolean" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {}, + "Filters": { + "shape": "S2b" + } + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S9" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSecurityGroups": { + "shape": "S13" + }, + "VpcSecurityGroupIds": { + "shape": "S14" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {}, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {} + } + }, + "output": { + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2w" + } + } + }, + "output": { + "shape": "S4k", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1u" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S1b" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "S13" + }, + "VpcSecurityGroupMemberships": { + "shape": "S14" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "Sx", + "locationName": "OptionSetting" + } + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "St" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S45" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2w" + } + } + }, + "output": { + "shape": "S4k", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "Tags": { + "shape": "S9" + }, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {} + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "Tags": { + "shape": "S9" + }, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {} + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S17" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S5" + }, + "EventCategoriesList": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S5": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S6": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S9": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sd": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "Sn": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PercentProgress": { + "type": "integer" + }, + "SourceRegion": {}, + "StorageType": {}, + "TdeCredentialArn": {} + }, + "wrapper": true + }, + "St": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "Sx", + "locationName": "OptionSetting" + } + }, + "DBSecurityGroupMemberships": { + "shape": "Sy" + }, + "VpcSecurityGroupMemberships": { + "shape": "S10" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {} + }, + "wrapper": true + }, + "Sx": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "DefaultValue": {}, + "Description": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "IsCollection": { + "type": "boolean" + } + } + }, + "Sy": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "S10": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S13": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "S14": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "S17": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "Sy" + }, + "VpcSecurityGroups": { + "shape": "S10" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S1b" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {}, + "StorageType": {} + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "OptionGroupMembership", + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "StatusInfos": { + "type": "list", + "member": { + "locationName": "DBInstanceStatusInfo", + "type": "structure", + "members": { + "StatusType": {}, + "Normal": { + "type": "boolean" + }, + "Status": {}, + "Message": {} + } + } + }, + "StorageType": {}, + "TdeCredentialArn": {} + }, + "wrapper": true + }, + "S1b": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S1e" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S1e": { + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + }, + "S1u": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S2b": { + "type": "list", + "member": { + "locationName": "Filter", + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": { + "locationName": "Value" + } + } + } + } + }, + "S2h": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S2w": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S45": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S47" + } + }, + "wrapper": true + }, + "S47": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S4k": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2014-09-01.paginators.json b/node_modules/aws-sdk/apis/rds-2014-09-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2014-09-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/rds-2014-10-31.min.json b/node_modules/aws-sdk/apis/rds-2014-10-31.min.json new file mode 100644 index 0000000..d8fe612 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2014-10-31.min.json @@ -0,0 +1,4822 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-10-31", + "endpointPrefix": "rds", + "protocol": "query", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "serviceId": "RDS", + "signatureVersion": "v4", + "uid": "rds-2014-10-31", + "xmlNamespace": "http://rds.amazonaws.com/doc/2014-10-31/" + }, + "operations": { + "AddRoleToDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "RoleArn" + ], + "members": { + "DBClusterIdentifier": {}, + "RoleArn": {}, + "FeatureName": {} + } + } + }, + "AddRoleToDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "RoleArn", + "FeatureName" + ], + "members": { + "DBInstanceIdentifier": {}, + "RoleArn": {}, + "FeatureName": {} + } + } + }, + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S6" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "Sb" + } + } + } + }, + "ApplyPendingMaintenanceAction": { + "input": { + "type": "structure", + "required": [ + "ResourceIdentifier", + "ApplyAction", + "OptInType" + ], + "members": { + "ResourceIdentifier": {}, + "ApplyAction": {}, + "OptInType": {} + } + }, + "output": { + "resultWrapper": "ApplyPendingMaintenanceActionResult", + "type": "structure", + "members": { + "ResourcePendingMaintenanceActions": { + "shape": "Sf" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sl" + } + } + } + }, + "BacktrackDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "BacktrackTo" + ], + "members": { + "DBClusterIdentifier": {}, + "BacktrackTo": { + "type": "timestamp" + }, + "Force": { + "type": "boolean" + }, + "UseEarliestTimeOnPointInTimeUnavailable": { + "type": "boolean" + } + } + }, + "output": { + "shape": "Ss", + "resultWrapper": "BacktrackDBClusterResult" + } + }, + "CopyDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "SourceDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupDescription" + ], + "members": { + "SourceDBClusterParameterGroupIdentifier": {}, + "TargetDBClusterParameterGroupIdentifier": {}, + "TargetDBClusterParameterGroupDescription": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CopyDBClusterParameterGroupResult", + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "shape": "Sv" + } + } + } + }, + "CopyDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members": { + "SourceDBClusterSnapshotIdentifier": {}, + "TargetDBClusterSnapshotIdentifier": {}, + "KmsKeyId": {}, + "PreSignedUrl": {}, + "CopyTags": { + "type": "boolean" + }, + "Tags": { + "shape": "Sb" + }, + "SourceRegion": {} + } + }, + "output": { + "resultWrapper": "CopyDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "Sy" + } + } + } + }, + "CopyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members": { + "SourceDBParameterGroupIdentifier": {}, + "TargetDBParameterGroupIdentifier": {}, + "TargetDBParameterGroupDescription": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CopyDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S13" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {}, + "KmsKeyId": {}, + "Tags": { + "shape": "Sb" + }, + "CopyTags": { + "type": "boolean" + }, + "PreSignedUrl": {}, + "OptionGroupName": {}, + "SourceRegion": {} + } + }, + "output": { + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "S16" + } + } + } + }, + "CopyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "SourceOptionGroupIdentifier", + "TargetOptionGroupIdentifier", + "TargetOptionGroupDescription" + ], + "members": { + "SourceOptionGroupIdentifier": {}, + "TargetOptionGroupIdentifier": {}, + "TargetOptionGroupDescription": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CopyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1c" + } + } + } + }, + "CreateDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "Engine" + ], + "members": { + "AvailabilityZones": { + "shape": "Sz" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "CharacterSetName": {}, + "DatabaseName": {}, + "DBClusterIdentifier": {}, + "DBClusterParameterGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "DBSubnetGroupName": {}, + "Engine": {}, + "EngineVersion": {}, + "Port": { + "type": "integer" + }, + "MasterUsername": {}, + "MasterUserPassword": {}, + "OptionGroupName": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "ReplicationSourceIdentifier": {}, + "Tags": { + "shape": "Sb" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "PreSignedUrl": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "BacktrackWindow": { + "type": "long" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "EngineMode": {}, + "ScalingConfiguration": { + "shape": "S1p" + }, + "DeletionProtection": { + "type": "boolean" + }, + "GlobalClusterIdentifier": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "SourceRegion": {} + } + }, + "output": { + "resultWrapper": "CreateDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "CreateDBClusterEndpoint": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "DBClusterEndpointIdentifier", + "EndpointType" + ], + "members": { + "DBClusterIdentifier": {}, + "DBClusterEndpointIdentifier": {}, + "EndpointType": {}, + "StaticMembers": { + "shape": "S1s" + }, + "ExcludedMembers": { + "shape": "S1s" + } + } + }, + "output": { + "shape": "S22", + "resultWrapper": "CreateDBClusterEndpointResult" + } + }, + "CreateDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBClusterParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterParameterGroupResult", + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "shape": "Sv" + } + } + } + }, + "CreateDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {}, + "DBClusterIdentifier": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "Sy" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "S28" + }, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "Sb" + }, + "DBClusterIdentifier": {}, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "Domain": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "MonitoringRoleArn": {}, + "DomainIAMRoleName": {}, + "PromotionTier": { + "type": "integer" + }, + "Timezone": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EnablePerformanceInsights": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "PerformanceInsightsRetentionPeriod": { + "type": "integer" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "DeletionProtection": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "Sb" + }, + "DBSubnetGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "StorageType": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "MonitoringRoleArn": {}, + "KmsKeyId": {}, + "PreSignedUrl": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EnablePerformanceInsights": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "PerformanceInsightsRetentionPeriod": { + "type": "integer" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "UseDefaultProcessorFeatures": { + "type": "boolean" + }, + "DeletionProtection": { + "type": "boolean" + }, + "SourceRegion": {} + } + }, + "output": { + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S13" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sl" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "S16" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S33" + }, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S2e" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S8" + }, + "SourceIds": { + "shape": "S7" + }, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S6" + } + } + } + }, + "CreateGlobalCluster": { + "input": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": {}, + "SourceDBClusterIdentifier": {}, + "Engine": {}, + "EngineVersion": {}, + "DeletionProtection": { + "type": "boolean" + }, + "DatabaseName": {}, + "StorageEncrypted": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateGlobalClusterResult", + "type": "structure", + "members": { + "GlobalCluster": { + "shape": "S39" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {}, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1c" + } + } + } + }, + "DeleteDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "DeleteDBClusterEndpoint": { + "input": { + "type": "structure", + "required": [ + "DBClusterEndpointIdentifier" + ], + "members": { + "DBClusterEndpointIdentifier": {} + } + }, + "output": { + "shape": "S22", + "resultWrapper": "DeleteDBClusterEndpointResult" + } + }, + "DeleteDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {} + } + } + }, + "DeleteDBClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBClusterSnapshotResult", + "type": "structure", + "members": { + "DBClusterSnapshot": { + "shape": "Sy" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {}, + "DeleteAutomatedBackups": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "DeleteDBInstanceAutomatedBackup": { + "input": { + "type": "structure", + "required": [ + "DbiResourceId" + ], + "members": { + "DbiResourceId": {} + } + }, + "output": { + "resultWrapper": "DeleteDBInstanceAutomatedBackupResult", + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "shape": "S3p" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "S16" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S6" + } + } + } + }, + "DeleteGlobalCluster": { + "input": { + "type": "structure", + "required": [ + "GlobalClusterIdentifier" + ], + "members": { + "GlobalClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "DeleteGlobalClusterResult", + "type": "structure", + "members": { + "GlobalCluster": { + "shape": "S39" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeAccountAttributes": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "DescribeAccountAttributesResult", + "type": "structure", + "members": { + "AccountQuotas": { + "type": "list", + "member": { + "locationName": "AccountQuota", + "type": "structure", + "members": { + "AccountQuotaName": {}, + "Used": { + "type": "long" + }, + "Max": { + "type": "long" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeCertificates": { + "input": { + "type": "structure", + "members": { + "CertificateIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCertificatesResult", + "type": "structure", + "members": { + "Certificates": { + "type": "list", + "member": { + "locationName": "Certificate", + "type": "structure", + "members": { + "CertificateIdentifier": {}, + "CertificateType": {}, + "Thumbprint": {}, + "ValidFrom": { + "type": "timestamp" + }, + "ValidTill": { + "type": "timestamp" + }, + "CertificateArn": {} + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeDBClusterBacktracks": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "BacktrackIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterBacktracksResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterBacktracks": { + "type": "list", + "member": { + "shape": "Ss", + "locationName": "DBClusterBacktrack" + } + } + } + } + }, + "DescribeDBClusterEndpoints": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "DBClusterEndpointIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterEndpointsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterEndpoints": { + "type": "list", + "member": { + "shape": "S22", + "locationName": "DBClusterEndpointList" + } + } + } + } + }, + "DescribeDBClusterParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterParameterGroups": { + "type": "list", + "member": { + "shape": "Sv", + "locationName": "DBClusterParameterGroup" + } + } + } + } + }, + "DescribeDBClusterParameters": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {}, + "Source": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S4o" + }, + "Marker": {} + } + } + }, + "DescribeDBClusterSnapshotAttributes": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier" + ], + "members": { + "DBClusterSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClusterSnapshotAttributesResult", + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "shape": "S4u" + } + } + } + }, + "DescribeDBClusterSnapshots": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "DBClusterSnapshotIdentifier": {}, + "SnapshotType": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "IncludeShared": { + "type": "boolean" + }, + "IncludePublic": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBClusterSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusterSnapshots": { + "type": "list", + "member": { + "shape": "Sy", + "locationName": "DBClusterSnapshot" + } + } + } + } + }, + "DescribeDBClusters": { + "input": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "DBClusters": { + "type": "list", + "member": { + "shape": "S1r", + "locationName": "DBCluster" + } + } + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + }, + "ListSupportedTimezones": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S58" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S58", + "locationName": "CharacterSet" + } + }, + "ValidUpgradeTarget": { + "type": "list", + "member": { + "locationName": "UpgradeTarget", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "Description": {}, + "AutoUpgrade": { + "type": "boolean" + }, + "IsMajorVersionUpgrade": { + "type": "boolean" + } + } + } + }, + "SupportedTimezones": { + "type": "list", + "member": { + "locationName": "Timezone", + "type": "structure", + "members": { + "TimezoneName": {} + } + } + }, + "ExportableLogTypes": { + "shape": "S1o" + }, + "SupportsLogExportsToCloudwatchLogs": { + "type": "boolean" + }, + "SupportsReadReplica": { + "type": "boolean" + }, + "SupportedEngineModes": { + "shape": "S4r" + }, + "SupportedFeatureNames": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "DescribeDBInstanceAutomatedBackups": { + "input": { + "type": "structure", + "members": { + "DbiResourceId": {}, + "DBInstanceIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstanceAutomatedBackupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstanceAutomatedBackups": { + "type": "list", + "member": { + "shape": "S3p", + "locationName": "DBInstanceAutomatedBackup" + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "S2a", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBLogFiles": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "FilenameContains": {}, + "FileLastWritten": { + "type": "long" + }, + "FileSize": { + "type": "long" + }, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBLogFilesResult", + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "type": "list", + "member": { + "locationName": "DescribeDBLogFilesDetails", + "type": "structure", + "members": { + "LogFileName": {}, + "LastWritten": { + "type": "long" + }, + "Size": { + "type": "long" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "S13", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S4o" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sl", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshotAttributes": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotAttributesResult", + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "shape": "S5z" + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "IncludeShared": { + "type": "boolean" + }, + "IncludePublic": { + "type": "boolean" + }, + "DbiResourceId": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "S16", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S2e", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultClusterParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultClusterParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "shape": "S6a" + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "shape": "S6a" + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {}, + "Filters": { + "shape": "S47" + } + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S8" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S6", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S8" + }, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S8" + }, + "Date": { + "type": "timestamp" + }, + "SourceArn": {} + } + } + } + } + } + }, + "DescribeGlobalClusters": { + "input": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeGlobalClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "GlobalClusters": { + "type": "list", + "member": { + "shape": "S39", + "locationName": "GlobalClusterMember" + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + }, + "OptionsConflictsWith": { + "type": "list", + "member": { + "locationName": "OptionConflictName" + } + }, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "RequiresAutoMinorEngineVersionUpgrade": { + "type": "boolean" + }, + "VpcOnly": { + "type": "boolean" + }, + "SupportsOptionVersionDowngrade": { + "type": "boolean" + }, + "OptionGroupOptionSettings": { + "type": "list", + "member": { + "locationName": "OptionGroupOptionSetting", + "type": "structure", + "members": { + "SettingName": {}, + "SettingDescription": {}, + "DefaultValue": {}, + "ApplyType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "IsRequired": { + "type": "boolean" + }, + "MinimumEngineVersionPerAllowedValue": { + "type": "list", + "member": { + "locationName": "MinimumEngineVersionPerAllowedValue", + "type": "structure", + "members": { + "AllowedValue": {}, + "MinimumEngineVersion": {} + } + } + } + } + } + }, + "OptionGroupOptionVersions": { + "type": "list", + "member": { + "locationName": "OptionVersion", + "type": "structure", + "members": { + "Version": {}, + "IsDefault": { + "type": "boolean" + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Filters": { + "shape": "S47" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "S1c", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S2h", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + }, + "SupportsStorageEncryption": { + "type": "boolean" + }, + "StorageType": {}, + "SupportsIops": { + "type": "boolean" + }, + "SupportsEnhancedMonitoring": { + "type": "boolean" + }, + "SupportsIAMDatabaseAuthentication": { + "type": "boolean" + }, + "SupportsPerformanceInsights": { + "type": "boolean" + }, + "MinStorageSize": { + "type": "integer" + }, + "MaxStorageSize": { + "type": "integer" + }, + "MinIopsPerDbInstance": { + "type": "integer" + }, + "MaxIopsPerDbInstance": { + "type": "integer" + }, + "MinIopsPerGib": { + "type": "double" + }, + "MaxIopsPerGib": { + "type": "double" + }, + "AvailableProcessorFeatures": { + "shape": "S7d" + }, + "SupportedEngineModes": { + "shape": "S4r" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribePendingMaintenanceActions": { + "input": { + "type": "structure", + "members": { + "ResourceIdentifier": {}, + "Filters": { + "shape": "S47" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribePendingMaintenanceActionsResult", + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "type": "list", + "member": { + "shape": "Sf", + "locationName": "ResourcePendingMaintenanceActions" + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S7l", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "Filters": { + "shape": "S47" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S7n" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeSourceRegions": { + "input": { + "type": "structure", + "members": { + "RegionName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "Filters": { + "shape": "S47" + } + } + }, + "output": { + "resultWrapper": "DescribeSourceRegionsResult", + "type": "structure", + "members": { + "Marker": {}, + "SourceRegions": { + "type": "list", + "member": { + "locationName": "SourceRegion", + "type": "structure", + "members": { + "RegionName": {}, + "Endpoint": {}, + "Status": {} + } + } + } + } + } + }, + "DescribeValidDBInstanceModifications": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "DescribeValidDBInstanceModificationsResult", + "type": "structure", + "members": { + "ValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "Storage": { + "type": "list", + "member": { + "locationName": "ValidStorageOptions", + "type": "structure", + "members": { + "StorageType": {}, + "StorageSize": { + "shape": "S82" + }, + "ProvisionedIops": { + "shape": "S82" + }, + "IopsToStorageRatio": { + "type": "list", + "member": { + "locationName": "DoubleRange", + "type": "structure", + "members": { + "From": { + "type": "double" + }, + "To": { + "type": "double" + } + } + } + } + } + } + }, + "ValidProcessorFeatures": { + "shape": "S7d" + } + }, + "wrapper": true + } + } + } + }, + "DownloadDBLogFilePortion": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "LogFileName" + ], + "members": { + "DBInstanceIdentifier": {}, + "LogFileName": {}, + "Marker": {}, + "NumberOfLines": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DownloadDBLogFilePortionResult", + "type": "structure", + "members": { + "LogFileData": {}, + "Marker": {}, + "AdditionalDataPending": { + "type": "boolean" + } + } + } + }, + "FailoverDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "TargetDBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "FailoverDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {}, + "Filters": { + "shape": "S47" + } + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "Sb" + } + } + } + }, + "ModifyCurrentDBClusterCapacity": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "Capacity": { + "type": "integer" + }, + "SecondsBeforeTimeout": { + "type": "integer" + }, + "TimeoutAction": {} + } + }, + "output": { + "resultWrapper": "ModifyCurrentDBClusterCapacityResult", + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "PendingCapacity": { + "type": "integer" + }, + "CurrentCapacity": { + "type": "integer" + }, + "SecondsBeforeTimeout": { + "type": "integer" + }, + "TimeoutAction": {} + } + } + }, + "ModifyDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "NewDBClusterIdentifier": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBClusterParameterGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "Port": { + "type": "integer" + }, + "MasterUserPassword": {}, + "OptionGroupName": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "BacktrackWindow": { + "type": "long" + }, + "CloudwatchLogsExportConfiguration": { + "shape": "S8f" + }, + "EngineVersion": {}, + "ScalingConfiguration": { + "shape": "S1p" + }, + "DeletionProtection": { + "type": "boolean" + }, + "EnableHttpEndpoint": { + "type": "boolean" + }, + "CopyTagsToSnapshot": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "ModifyDBClusterEndpoint": { + "input": { + "type": "structure", + "required": [ + "DBClusterEndpointIdentifier" + ], + "members": { + "DBClusterEndpointIdentifier": {}, + "EndpointType": {}, + "StaticMembers": { + "shape": "S1s" + }, + "ExcludedMembers": { + "shape": "S1s" + } + } + }, + "output": { + "shape": "S22", + "resultWrapper": "ModifyDBClusterEndpointResult" + } + }, + "ModifyDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName", + "Parameters" + ], + "members": { + "DBClusterParameterGroupName": {}, + "Parameters": { + "shape": "S4o" + } + } + }, + "output": { + "shape": "S8j", + "resultWrapper": "ModifyDBClusterParameterGroupResult" + } + }, + "ModifyDBClusterSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "DBClusterSnapshotIdentifier", + "AttributeName" + ], + "members": { + "DBClusterSnapshotIdentifier": {}, + "AttributeName": {}, + "ValuesToAdd": { + "shape": "S4x" + }, + "ValuesToRemove": { + "shape": "S4x" + } + } + }, + "output": { + "resultWrapper": "ModifyDBClusterSnapshotAttributeResult", + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "shape": "S4u" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSubnetGroupName": {}, + "DBSecurityGroups": { + "shape": "S28" + }, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {}, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {}, + "CACertificateIdentifier": {}, + "Domain": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "DBPortNumber": { + "type": "integer" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "MonitoringRoleArn": {}, + "DomainIAMRoleName": {}, + "PromotionTier": { + "type": "integer" + }, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EnablePerformanceInsights": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "PerformanceInsightsRetentionPeriod": { + "type": "integer" + }, + "CloudwatchLogsExportConfiguration": { + "shape": "S8f" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "UseDefaultProcessorFeatures": { + "type": "boolean" + }, + "DeletionProtection": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S4o" + } + } + }, + "output": { + "shape": "S8p", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "EngineVersion": {}, + "OptionGroupName": {} + } + }, + "output": { + "resultWrapper": "ModifyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "S16" + } + } + } + }, + "ModifyDBSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "AttributeName" + ], + "members": { + "DBSnapshotIdentifier": {}, + "AttributeName": {}, + "ValuesToAdd": { + "shape": "S4x" + }, + "ValuesToRemove": { + "shape": "S4x" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSnapshotAttributeResult", + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "shape": "S5z" + } + } + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S33" + } + } + }, + "output": { + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S2e" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S8" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S6" + } + } + } + }, + "ModifyGlobalCluster": { + "input": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": {}, + "NewGlobalClusterIdentifier": {}, + "DeletionProtection": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyGlobalClusterResult", + "type": "structure", + "members": { + "GlobalCluster": { + "shape": "S39" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "OptionVersion": {}, + "DBSecurityGroupMemberships": { + "shape": "S28" + }, + "VpcSecurityGroupMemberships": { + "shape": "S1m" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1g", + "locationName": "OptionSetting" + } + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1c" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "PromoteReadReplicaDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "PromoteReadReplicaDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + }, + "Tags": { + "shape": "Sb" + } + } + }, + "output": { + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S7l" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "RemoveFromGlobalCluster": { + "input": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": {}, + "DbClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "RemoveFromGlobalClusterResult", + "type": "structure", + "members": { + "GlobalCluster": { + "shape": "S39" + } + } + } + }, + "RemoveRoleFromDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "RoleArn" + ], + "members": { + "DBClusterIdentifier": {}, + "RoleArn": {}, + "FeatureName": {} + } + } + }, + "RemoveRoleFromDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "RoleArn", + "FeatureName" + ], + "members": { + "DBInstanceIdentifier": {}, + "RoleArn": {}, + "FeatureName": {} + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S6" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBClusterParameterGroupName" + ], + "members": { + "DBClusterParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S4o" + } + } + }, + "output": { + "shape": "S8j", + "resultWrapper": "ResetDBClusterParameterGroupResult" + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S4o" + } + } + }, + "output": { + "shape": "S8p", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBClusterFromS3": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "Engine", + "MasterUsername", + "MasterUserPassword", + "SourceEngine", + "SourceEngineVersion", + "S3BucketName", + "S3IngestionRoleArn" + ], + "members": { + "AvailabilityZones": { + "shape": "Sz" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "CharacterSetName": {}, + "DatabaseName": {}, + "DBClusterIdentifier": {}, + "DBClusterParameterGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "DBSubnetGroupName": {}, + "Engine": {}, + "EngineVersion": {}, + "Port": { + "type": "integer" + }, + "MasterUsername": {}, + "MasterUserPassword": {}, + "OptionGroupName": {}, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "Tags": { + "shape": "Sb" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "SourceEngine": {}, + "SourceEngineVersion": {}, + "S3BucketName": {}, + "S3Prefix": {}, + "S3IngestionRoleArn": {}, + "BacktrackWindow": { + "type": "long" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "DeletionProtection": { + "type": "boolean" + }, + "CopyTagsToSnapshot": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RestoreDBClusterFromS3Result", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "RestoreDBClusterFromSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members": { + "AvailabilityZones": { + "shape": "Sz" + }, + "DBClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "Engine": {}, + "EngineVersion": {}, + "Port": { + "type": "integer" + }, + "DBSubnetGroupName": {}, + "DatabaseName": {}, + "OptionGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "Tags": { + "shape": "Sb" + }, + "KmsKeyId": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "BacktrackWindow": { + "type": "long" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "EngineMode": {}, + "ScalingConfiguration": { + "shape": "S1p" + }, + "DBClusterParameterGroupName": {}, + "DeletionProtection": { + "type": "boolean" + }, + "CopyTagsToSnapshot": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RestoreDBClusterFromSnapshotResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "RestoreDBClusterToPointInTime": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {}, + "RestoreType": {}, + "SourceDBClusterIdentifier": {}, + "RestoreToTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "DBSubnetGroupName": {}, + "OptionGroupName": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "Tags": { + "shape": "Sb" + }, + "KmsKeyId": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "BacktrackWindow": { + "type": "long" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "DBClusterParameterGroupName": {}, + "DeletionProtection": { + "type": "boolean" + }, + "CopyTagsToSnapshot": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RestoreDBClusterToPointInTimeResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "Tags": { + "shape": "Sb" + }, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "Domain": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "DomainIAMRoleName": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "UseDefaultProcessorFeatures": { + "type": "boolean" + }, + "DBParameterGroupName": {}, + "DeletionProtection": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "RestoreDBInstanceFromS3": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine", + "SourceEngine", + "SourceEngineVersion", + "S3BucketName", + "S3IngestionRoleArn" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "S28" + }, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "Sb" + }, + "StorageType": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "MonitoringRoleArn": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "SourceEngine": {}, + "SourceEngineVersion": {}, + "S3BucketName": {}, + "S3Prefix": {}, + "S3IngestionRoleArn": {}, + "EnablePerformanceInsights": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "PerformanceInsightsRetentionPeriod": { + "type": "integer" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "UseDefaultProcessorFeatures": { + "type": "boolean" + }, + "DeletionProtection": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceFromS3Result", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "Tags": { + "shape": "Sb" + }, + "StorageType": {}, + "TdeCredentialArn": {}, + "TdeCredentialPassword": {}, + "VpcSecurityGroupIds": { + "shape": "S1m" + }, + "Domain": {}, + "DomainIAMRoleName": {}, + "EnableIAMDatabaseAuthentication": { + "type": "boolean" + }, + "EnableCloudwatchLogsExports": { + "shape": "S1o" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "UseDefaultProcessorFeatures": { + "type": "boolean" + }, + "DBParameterGroupName": {}, + "DeletionProtection": { + "type": "boolean" + }, + "SourceDbiResourceId": {} + } + }, + "output": { + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sl" + } + } + } + }, + "StartDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "StartDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "StartDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {} + } + }, + "output": { + "resultWrapper": "StartDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + }, + "StopDBCluster": { + "input": { + "type": "structure", + "required": [ + "DBClusterIdentifier" + ], + "members": { + "DBClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "StopDBClusterResult", + "type": "structure", + "members": { + "DBCluster": { + "shape": "S1r" + } + } + } + }, + "StopDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {} + } + }, + "output": { + "resultWrapper": "StopDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "S2a" + } + } + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S7" + }, + "EventCategoriesList": { + "shape": "S8" + }, + "Enabled": { + "type": "boolean" + }, + "EventSubscriptionArn": {} + }, + "wrapper": true + }, + "S7": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S8": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "Sb": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sf": { + "type": "structure", + "members": { + "ResourceIdentifier": {}, + "PendingMaintenanceActionDetails": { + "type": "list", + "member": { + "locationName": "PendingMaintenanceAction", + "type": "structure", + "members": { + "Action": {}, + "AutoAppliedAfterDate": { + "type": "timestamp" + }, + "ForcedApplyDate": { + "type": "timestamp" + }, + "OptInStatus": {}, + "CurrentApplyDate": { + "type": "timestamp" + }, + "Description": {} + } + } + } + }, + "wrapper": true + }, + "Sl": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + }, + "DBSecurityGroupArn": {} + }, + "wrapper": true + }, + "Ss": { + "type": "structure", + "members": { + "DBClusterIdentifier": {}, + "BacktrackIdentifier": {}, + "BacktrackTo": { + "type": "timestamp" + }, + "BacktrackedFrom": { + "type": "timestamp" + }, + "BacktrackRequestCreationTime": { + "type": "timestamp" + }, + "Status": {} + } + }, + "Sv": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "DBClusterParameterGroupArn": {} + }, + "wrapper": true + }, + "Sy": { + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "Sz" + }, + "DBClusterSnapshotIdentifier": {}, + "DBClusterIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "VpcId": {}, + "ClusterCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "PercentProgress": { + "type": "integer" + }, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DBClusterSnapshotArn": {}, + "SourceDBClusterSnapshotArn": {}, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "Sz": { + "type": "list", + "member": { + "locationName": "AvailabilityZone" + } + }, + "S13": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "DBParameterGroupArn": {} + }, + "wrapper": true + }, + "S16": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PercentProgress": { + "type": "integer" + }, + "SourceRegion": {}, + "SourceDBSnapshotIdentifier": {}, + "StorageType": {}, + "TdeCredentialArn": {}, + "Encrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DBSnapshotArn": {}, + "Timezone": {}, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "DbiResourceId": {} + }, + "wrapper": true + }, + "S18": { + "type": "list", + "member": { + "locationName": "ProcessorFeature", + "type": "structure", + "members": { + "Name": {}, + "Value": {} + } + } + }, + "S1c": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "OptionVersion": {}, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1g", + "locationName": "OptionSetting" + } + }, + "DBSecurityGroupMemberships": { + "shape": "S1h" + }, + "VpcSecurityGroupMemberships": { + "shape": "S1j" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {}, + "OptionGroupArn": {} + }, + "wrapper": true + }, + "S1g": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "DefaultValue": {}, + "Description": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "IsCollection": { + "type": "boolean" + } + } + }, + "S1h": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "S1j": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S1m": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "S1o": { + "type": "list", + "member": {} + }, + "S1p": { + "type": "structure", + "members": { + "MinCapacity": { + "type": "integer" + }, + "MaxCapacity": { + "type": "integer" + }, + "AutoPause": { + "type": "boolean" + }, + "SecondsUntilAutoPause": { + "type": "integer" + }, + "TimeoutAction": {} + } + }, + "S1r": { + "type": "structure", + "members": { + "AllocatedStorage": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "Sz" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "CharacterSetName": {}, + "DatabaseName": {}, + "DBClusterIdentifier": {}, + "DBClusterParameterGroup": {}, + "DBSubnetGroup": {}, + "Status": {}, + "PercentProgress": {}, + "EarliestRestorableTime": { + "type": "timestamp" + }, + "Endpoint": {}, + "ReaderEndpoint": {}, + "CustomEndpoints": { + "shape": "S1s" + }, + "MultiAZ": { + "type": "boolean" + }, + "Engine": {}, + "EngineVersion": {}, + "LatestRestorableTime": { + "type": "timestamp" + }, + "Port": { + "type": "integer" + }, + "MasterUsername": {}, + "DBClusterOptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "DBClusterOptionGroup", + "type": "structure", + "members": { + "DBClusterOptionGroupName": {}, + "Status": {} + } + } + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "ReplicationSourceIdentifier": {}, + "ReadReplicaIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaIdentifier" + } + }, + "DBClusterMembers": { + "type": "list", + "member": { + "locationName": "DBClusterMember", + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "IsClusterWriter": { + "type": "boolean" + }, + "DBClusterParameterGroupStatus": {}, + "PromotionTier": { + "type": "integer" + } + }, + "wrapper": true + } + }, + "VpcSecurityGroups": { + "shape": "S1j" + }, + "HostedZoneId": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DbClusterResourceId": {}, + "DBClusterArn": {}, + "AssociatedRoles": { + "type": "list", + "member": { + "locationName": "DBClusterRole", + "type": "structure", + "members": { + "RoleArn": {}, + "Status": {}, + "FeatureName": {} + } + } + }, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + }, + "CloneGroupId": {}, + "ClusterCreateTime": { + "type": "timestamp" + }, + "EarliestBacktrackTime": { + "type": "timestamp" + }, + "BacktrackWindow": { + "type": "long" + }, + "BacktrackConsumedChangeRecords": { + "type": "long" + }, + "EnabledCloudwatchLogsExports": { + "shape": "S1o" + }, + "Capacity": { + "type": "integer" + }, + "EngineMode": {}, + "ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "type": "integer" + }, + "MaxCapacity": { + "type": "integer" + }, + "AutoPause": { + "type": "boolean" + }, + "SecondsUntilAutoPause": { + "type": "integer" + }, + "TimeoutAction": {} + } + }, + "DeletionProtection": { + "type": "boolean" + }, + "HttpEndpointEnabled": { + "type": "boolean" + }, + "CopyTagsToSnapshot": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1s": { + "type": "list", + "member": {} + }, + "S22": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": {}, + "DBClusterIdentifier": {}, + "DBClusterEndpointResourceIdentifier": {}, + "Endpoint": {}, + "Status": {}, + "EndpointType": {}, + "CustomEndpointType": {}, + "StaticMembers": { + "shape": "S1s" + }, + "ExcludedMembers": { + "shape": "S1s" + }, + "DBClusterEndpointArn": {} + } + }, + "S28": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "S2a": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "shape": "S2b" + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "S1h" + }, + "VpcSecurityGroups": { + "shape": "S1j" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S2e" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {}, + "StorageType": {}, + "CACertificateIdentifier": {}, + "DBSubnetGroupName": {}, + "PendingCloudwatchLogsExports": { + "type": "structure", + "members": { + "LogTypesToEnable": { + "shape": "S1o" + }, + "LogTypesToDisable": { + "shape": "S1o" + } + } + }, + "ProcessorFeatures": { + "shape": "S18" + } + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "ReadReplicaDBClusterIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBClusterIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "OptionGroupMembership", + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "StatusInfos": { + "type": "list", + "member": { + "locationName": "DBInstanceStatusInfo", + "type": "structure", + "members": { + "StatusType": {}, + "Normal": { + "type": "boolean" + }, + "Status": {}, + "Message": {} + } + } + }, + "StorageType": {}, + "TdeCredentialArn": {}, + "DbInstancePort": { + "type": "integer" + }, + "DBClusterIdentifier": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "DbiResourceId": {}, + "CACertificateIdentifier": {}, + "DomainMemberships": { + "type": "list", + "member": { + "locationName": "DomainMembership", + "type": "structure", + "members": { + "Domain": {}, + "Status": {}, + "FQDN": {}, + "IAMRoleName": {} + } + } + }, + "CopyTagsToSnapshot": { + "type": "boolean" + }, + "MonitoringInterval": { + "type": "integer" + }, + "EnhancedMonitoringResourceArn": {}, + "MonitoringRoleArn": {}, + "PromotionTier": { + "type": "integer" + }, + "DBInstanceArn": {}, + "Timezone": {}, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + }, + "PerformanceInsightsEnabled": { + "type": "boolean" + }, + "PerformanceInsightsKMSKeyId": {}, + "PerformanceInsightsRetentionPeriod": { + "type": "integer" + }, + "EnabledCloudwatchLogsExports": { + "shape": "S1o" + }, + "ProcessorFeatures": { + "shape": "S18" + }, + "DeletionProtection": { + "type": "boolean" + }, + "AssociatedRoles": { + "type": "list", + "member": { + "locationName": "DBInstanceRole", + "type": "structure", + "members": { + "RoleArn": {}, + "FeatureName": {}, + "Status": {} + } + } + }, + "ListenerEndpoint": { + "shape": "S2b" + } + }, + "wrapper": true + }, + "S2b": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + }, + "HostedZoneId": {} + } + }, + "S2e": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S2h" + }, + "SubnetStatus": {} + } + } + }, + "DBSubnetGroupArn": {} + }, + "wrapper": true + }, + "S2h": { + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + }, + "S33": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S39": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": {}, + "GlobalClusterResourceId": {}, + "GlobalClusterArn": {}, + "Status": {}, + "Engine": {}, + "EngineVersion": {}, + "DatabaseName": {}, + "StorageEncrypted": { + "type": "boolean" + }, + "DeletionProtection": { + "type": "boolean" + }, + "GlobalClusterMembers": { + "type": "list", + "member": { + "locationName": "GlobalClusterMember", + "type": "structure", + "members": { + "DBClusterArn": {}, + "Readers": { + "type": "list", + "member": {} + }, + "IsWriter": { + "type": "boolean" + } + }, + "wrapper": true + } + } + }, + "wrapper": true + }, + "S3p": { + "type": "structure", + "members": { + "DBInstanceArn": {}, + "DbiResourceId": {}, + "Region": {}, + "DBInstanceIdentifier": {}, + "RestoreWindow": { + "type": "structure", + "members": { + "EarliestTime": { + "type": "timestamp" + }, + "LatestTime": { + "type": "timestamp" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "Engine": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "TdeCredentialArn": {}, + "Encrypted": { + "type": "boolean" + }, + "StorageType": {}, + "KmsKeyId": {}, + "Timezone": {}, + "IAMDatabaseAuthenticationEnabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S47": { + "type": "list", + "member": { + "locationName": "Filter", + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": { + "locationName": "Value" + } + } + } + } + }, + "S4o": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {}, + "SupportedEngineModes": { + "shape": "S4r" + } + } + } + }, + "S4r": { + "type": "list", + "member": {} + }, + "S4u": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": {}, + "DBClusterSnapshotAttributes": { + "type": "list", + "member": { + "locationName": "DBClusterSnapshotAttribute", + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValues": { + "shape": "S4x" + } + } + } + } + }, + "wrapper": true + }, + "S4x": { + "type": "list", + "member": { + "locationName": "AttributeValue" + } + }, + "S58": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S5z": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBSnapshotAttributes": { + "type": "list", + "member": { + "locationName": "DBSnapshotAttribute", + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValues": { + "shape": "S4x" + } + }, + "wrapper": true + } + } + }, + "wrapper": true + }, + "S6a": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S4o" + } + }, + "wrapper": true + }, + "S7d": { + "type": "list", + "member": { + "locationName": "AvailableProcessorFeature", + "type": "structure", + "members": { + "Name": {}, + "DefaultValue": {}, + "AllowedValues": {} + } + } + }, + "S7l": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S7n" + }, + "ReservedDBInstanceArn": {} + }, + "wrapper": true + }, + "S7n": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S82": { + "type": "list", + "member": { + "locationName": "Range", + "type": "structure", + "members": { + "From": { + "type": "integer" + }, + "To": { + "type": "integer" + }, + "Step": { + "type": "integer" + } + } + } + }, + "S8f": { + "type": "structure", + "members": { + "EnableLogTypes": { + "shape": "S1o" + }, + "DisableLogTypes": { + "shape": "S1o" + } + } + }, + "S8j": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": {} + } + }, + "S8p": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2014-10-31.paginators.json b/node_modules/aws-sdk/apis/rds-2014-10-31.paginators.json new file mode 100644 index 0000000..ad97d06 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2014-10-31.paginators.json @@ -0,0 +1,128 @@ +{ + "pagination": { + "DescribeDBClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusters" + }, + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstanceAutomatedBackups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstanceAutomatedBackups" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "EngineDefaults.Marker", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeGlobalClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "GlobalClusters" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "output_token": "Marker", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-2014-10-31.waiters2.json b/node_modules/aws-sdk/apis/rds-2014-10-31.waiters2.json new file mode 100644 index 0000000..6a223a5 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-2014-10-31.waiters2.json @@ -0,0 +1,175 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "DBInstanceNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBSnapshotAvailable": { + "delay": 30, + "operation": "DescribeDBSnapshots", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + } + ] + }, + "DBSnapshotDeleted": { + "delay": 30, + "operation": "DescribeDBSnapshots", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "DBSnapshotNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/rds-data-2018-08-01.examples.json b/node_modules/aws-sdk/apis/rds-data-2018-08-01.examples.json new file mode 100644 index 0000000..d4b556b --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-data-2018-08-01.examples.json @@ -0,0 +1,4 @@ +{ + "version": "1.0", + "examples": { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json b/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json new file mode 100644 index 0000000..a256552 --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json @@ -0,0 +1,169 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-08-01", + "endpointPrefix": "rds-data", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS RDS DataService", + "serviceId": "RDS Data", + "signatureVersion": "v4", + "signingName": "rds-data", + "uid": "rds-data-2018-08-01" + }, + "operations": { + "ExecuteSql": { + "http": { + "requestUri": "/ExecuteSql", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "awsSecretStoreArn", + "dbClusterOrInstanceArn", + "sqlStatements" + ], + "members": { + "awsSecretStoreArn": {}, + "database": {}, + "dbClusterOrInstanceArn": {}, + "schema": {}, + "sqlStatements": {} + } + }, + "output": { + "type": "structure", + "required": [ + "sqlStatementResults" + ], + "members": { + "sqlStatementResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "numberOfRecordsUpdated": { + "type": "long" + }, + "resultFrame": { + "type": "structure", + "members": { + "records": { + "type": "list", + "member": { + "type": "structure", + "members": { + "values": { + "type": "list", + "member": { + "shape": "Sd" + } + } + } + } + }, + "resultSetMetadata": { + "type": "structure", + "members": { + "columnCount": { + "type": "long" + }, + "columnMetadata": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arrayBaseColumnType": { + "type": "integer" + }, + "isAutoIncrement": { + "type": "boolean" + }, + "isCaseSensitive": { + "type": "boolean" + }, + "isCurrency": { + "type": "boolean" + }, + "isSigned": { + "type": "boolean" + }, + "label": {}, + "name": {}, + "nullable": { + "type": "integer" + }, + "precision": { + "type": "integer" + }, + "scale": { + "type": "integer" + }, + "schemaName": {}, + "tableName": {}, + "type": { + "type": "integer" + }, + "typeName": {} + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "shapes": { + "Sd": { + "type": "structure", + "members": { + "arrayValues": { + "shape": "Se" + }, + "bigIntValue": { + "type": "long" + }, + "bitValue": { + "type": "boolean" + }, + "blobValue": { + "type": "blob" + }, + "doubleValue": { + "type": "double" + }, + "intValue": { + "type": "integer" + }, + "isNull": { + "type": "boolean" + }, + "realValue": { + "type": "float" + }, + "stringValue": {}, + "structValue": { + "type": "structure", + "members": { + "attributes": { + "shape": "Se" + } + } + } + } + }, + "Se": { + "type": "list", + "member": { + "shape": "Sd" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rds-data-2018-08-01.paginators.json b/node_modules/aws-sdk/apis/rds-data-2018-08-01.paginators.json new file mode 100644 index 0000000..4b2351b --- /dev/null +++ b/node_modules/aws-sdk/apis/rds-data-2018-08-01.paginators.json @@ -0,0 +1,3 @@ +{ + "pagination": { } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/redshift-2012-12-01.examples.json b/node_modules/aws-sdk/apis/redshift-2012-12-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/redshift-2012-12-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json b/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json new file mode 100644 index 0000000..9579e4a --- /dev/null +++ b/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json @@ -0,0 +1,3054 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-12-01", + "endpointPrefix": "redshift", + "protocol": "query", + "serviceFullName": "Amazon Redshift", + "serviceId": "Redshift", + "signatureVersion": "v4", + "uid": "redshift-2012-12-01", + "xmlNamespace": "http://redshift.amazonaws.com/doc/2012-12-01/" + }, + "operations": { + "AcceptReservedNodeExchange": { + "input": { + "type": "structure", + "required": [ + "ReservedNodeId", + "TargetReservedNodeOfferingId" + ], + "members": { + "ReservedNodeId": {}, + "TargetReservedNodeOfferingId": {} + } + }, + "output": { + "resultWrapper": "AcceptReservedNodeExchangeResult", + "type": "structure", + "members": { + "ExchangedReservedNode": { + "shape": "S4" + } + } + } + }, + "AuthorizeClusterSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName" + ], + "members": { + "ClusterSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "AuthorizeClusterSecurityGroupIngressResult", + "type": "structure", + "members": { + "ClusterSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "AuthorizeSnapshotAccess": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members": { + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {}, + "AccountWithRestoreAccess": {} + } + }, + "output": { + "resultWrapper": "AuthorizeSnapshotAccessResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sm" + } + } + } + }, + "BatchDeleteClusterSnapshots": { + "input": { + "type": "structure", + "required": [ + "Identifiers" + ], + "members": { + "Identifiers": { + "type": "list", + "member": { + "shape": "Sv", + "locationName": "DeleteClusterSnapshotMessage" + } + } + } + }, + "output": { + "resultWrapper": "BatchDeleteClusterSnapshotsResult", + "type": "structure", + "members": { + "Resources": { + "shape": "Sx" + }, + "Errors": { + "type": "list", + "member": { + "shape": "Sz", + "locationName": "SnapshotErrorMessage" + } + } + } + } + }, + "BatchModifyClusterSnapshots": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifierList" + ], + "members": { + "SnapshotIdentifierList": { + "shape": "Sx" + }, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "Force": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "BatchModifyClusterSnapshotsResult", + "type": "structure", + "members": { + "Resources": { + "shape": "Sx" + }, + "Errors": { + "type": "list", + "member": { + "shape": "Sz", + "locationName": "SnapshotErrorMessage" + } + } + } + } + }, + "CancelResize": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "shape": "S14", + "resultWrapper": "CancelResizeResult" + } + }, + "CopyClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceSnapshotIdentifier", + "TargetSnapshotIdentifier" + ], + "members": { + "SourceSnapshotIdentifier": {}, + "SourceSnapshotClusterIdentifier": {}, + "TargetSnapshotIdentifier": {}, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "CopyClusterSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sm" + } + } + } + }, + "CreateCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "NodeType", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "ClusterIdentifier": {}, + "ClusterType": {}, + "NodeType": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "ClusterSecurityGroups": { + "shape": "S1d" + }, + "VpcSecurityGroupIds": { + "shape": "S1e" + }, + "ClusterSubnetGroupName": {}, + "AvailabilityZone": {}, + "PreferredMaintenanceWindow": {}, + "ClusterParameterGroupName": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "Port": { + "type": "integer" + }, + "ClusterVersion": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "NumberOfNodes": { + "type": "integer" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "ElasticIp": {}, + "Tags": { + "shape": "Sg" + }, + "KmsKeyId": {}, + "EnhancedVpcRouting": { + "type": "boolean" + }, + "AdditionalInfo": {}, + "IamRoles": { + "shape": "S1g" + }, + "MaintenanceTrackName": {}, + "SnapshotScheduleIdentifier": {} + } + }, + "output": { + "resultWrapper": "CreateClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "CreateClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName", + "ParameterGroupFamily", + "Description" + ], + "members": { + "ParameterGroupName": {}, + "ParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateClusterParameterGroupResult", + "type": "structure", + "members": { + "ClusterParameterGroup": { + "shape": "S29" + } + } + } + }, + "CreateClusterSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName", + "Description" + ], + "members": { + "ClusterSecurityGroupName": {}, + "Description": {}, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateClusterSecurityGroupResult", + "type": "structure", + "members": { + "ClusterSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier", + "ClusterIdentifier" + ], + "members": { + "SnapshotIdentifier": {}, + "ClusterIdentifier": {}, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateClusterSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sm" + } + } + } + }, + "CreateClusterSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSubnetGroupName", + "Description", + "SubnetIds" + ], + "members": { + "ClusterSubnetGroupName": {}, + "Description": {}, + "SubnetIds": { + "shape": "S2f" + }, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateClusterSubnetGroupResult", + "type": "structure", + "members": { + "ClusterSubnetGroup": { + "shape": "S2h" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "SourceIds": { + "shape": "S2o" + }, + "EventCategories": { + "shape": "S2p" + }, + "Severity": {}, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S2r" + } + } + } + }, + "CreateHsmClientCertificate": { + "input": { + "type": "structure", + "required": [ + "HsmClientCertificateIdentifier" + ], + "members": { + "HsmClientCertificateIdentifier": {}, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateHsmClientCertificateResult", + "type": "structure", + "members": { + "HsmClientCertificate": { + "shape": "S2u" + } + } + } + }, + "CreateHsmConfiguration": { + "input": { + "type": "structure", + "required": [ + "HsmConfigurationIdentifier", + "Description", + "HsmIpAddress", + "HsmPartitionName", + "HsmPartitionPassword", + "HsmServerPublicCertificate" + ], + "members": { + "HsmConfigurationIdentifier": {}, + "Description": {}, + "HsmIpAddress": {}, + "HsmPartitionName": {}, + "HsmPartitionPassword": {}, + "HsmServerPublicCertificate": {}, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateHsmConfigurationResult", + "type": "structure", + "members": { + "HsmConfiguration": { + "shape": "S2x" + } + } + } + }, + "CreateSnapshotCopyGrant": { + "input": { + "type": "structure", + "required": [ + "SnapshotCopyGrantName" + ], + "members": { + "SnapshotCopyGrantName": {}, + "KmsKeyId": {}, + "Tags": { + "shape": "Sg" + } + } + }, + "output": { + "resultWrapper": "CreateSnapshotCopyGrantResult", + "type": "structure", + "members": { + "SnapshotCopyGrant": { + "shape": "S30" + } + } + } + }, + "CreateSnapshotSchedule": { + "input": { + "type": "structure", + "members": { + "ScheduleDefinitions": { + "shape": "S32" + }, + "ScheduleIdentifier": {}, + "ScheduleDescription": {}, + "Tags": { + "shape": "Sg" + }, + "DryRun": { + "type": "boolean" + }, + "NextInvocations": { + "type": "integer" + } + } + }, + "output": { + "shape": "S33", + "resultWrapper": "CreateSnapshotScheduleResult" + } + }, + "CreateTags": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "Sg" + } + } + } + }, + "DeleteCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "SkipFinalClusterSnapshot": { + "type": "boolean" + }, + "FinalClusterSnapshotIdentifier": {}, + "FinalClusterSnapshotRetentionPeriod": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DeleteClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "DeleteClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {} + } + } + }, + "DeleteClusterSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName" + ], + "members": { + "ClusterSecurityGroupName": {} + } + } + }, + "DeleteClusterSnapshot": { + "input": { + "shape": "Sv" + }, + "output": { + "resultWrapper": "DeleteClusterSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sm" + } + } + } + }, + "DeleteClusterSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSubnetGroupName" + ], + "members": { + "ClusterSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + } + }, + "DeleteHsmClientCertificate": { + "input": { + "type": "structure", + "required": [ + "HsmClientCertificateIdentifier" + ], + "members": { + "HsmClientCertificateIdentifier": {} + } + } + }, + "DeleteHsmConfiguration": { + "input": { + "type": "structure", + "required": [ + "HsmConfigurationIdentifier" + ], + "members": { + "HsmConfigurationIdentifier": {} + } + } + }, + "DeleteSnapshotCopyGrant": { + "input": { + "type": "structure", + "required": [ + "SnapshotCopyGrantName" + ], + "members": { + "SnapshotCopyGrantName": {} + } + } + }, + "DeleteSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "ScheduleIdentifier" + ], + "members": { + "ScheduleIdentifier": {} + } + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "shape": "S3k" + } + } + } + }, + "DescribeAccountAttributes": { + "input": { + "type": "structure", + "members": { + "AttributeNames": { + "type": "list", + "member": { + "locationName": "AttributeName" + } + } + } + }, + "output": { + "resultWrapper": "DescribeAccountAttributesResult", + "type": "structure", + "members": { + "AccountAttributes": { + "type": "list", + "member": { + "locationName": "AccountAttribute", + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValues": { + "type": "list", + "member": { + "locationName": "AttributeValueTarget", + "type": "structure", + "members": { + "AttributeValue": {} + } + } + } + } + } + } + } + } + }, + "DescribeClusterDbRevisions": { + "input": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterDbRevisionsResult", + "type": "structure", + "members": { + "Marker": {}, + "ClusterDbRevisions": { + "type": "list", + "member": { + "locationName": "ClusterDbRevision", + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "CurrentDatabaseRevision": {}, + "DatabaseRevisionReleaseDate": { + "type": "timestamp" + }, + "RevisionTargets": { + "type": "list", + "member": { + "locationName": "RevisionTarget", + "type": "structure", + "members": { + "DatabaseRevision": {}, + "Description": {}, + "DatabaseRevisionReleaseDate": { + "type": "timestamp" + } + } + } + } + } + } + } + } + } + }, + "DescribeClusterParameterGroups": { + "input": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeClusterParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ParameterGroups": { + "type": "list", + "member": { + "shape": "S29", + "locationName": "ClusterParameterGroup" + } + } + } + } + }, + "DescribeClusterParameters": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S44" + }, + "Marker": {} + } + } + }, + "DescribeClusterSecurityGroups": { + "input": { + "type": "structure", + "members": { + "ClusterSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeClusterSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ClusterSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "ClusterSecurityGroup" + } + } + } + } + }, + "DescribeClusterSnapshots": { + "input": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "SnapshotType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "OwnerAccount": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + }, + "ClusterExists": { + "type": "boolean" + }, + "SortingEntities": { + "type": "list", + "member": { + "locationName": "SnapshotSortingEntity", + "type": "structure", + "required": [ + "Attribute" + ], + "members": { + "Attribute": {}, + "SortOrder": {} + } + } + } + } + }, + "output": { + "resultWrapper": "DescribeClusterSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "Snapshots": { + "type": "list", + "member": { + "shape": "Sm", + "locationName": "Snapshot" + } + } + } + } + }, + "DescribeClusterSubnetGroups": { + "input": { + "type": "structure", + "members": { + "ClusterSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeClusterSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ClusterSubnetGroups": { + "type": "list", + "member": { + "shape": "S2h", + "locationName": "ClusterSubnetGroup" + } + } + } + } + }, + "DescribeClusterTracks": { + "input": { + "type": "structure", + "members": { + "MaintenanceTrackName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterTracksResult", + "type": "structure", + "members": { + "MaintenanceTracks": { + "type": "list", + "member": { + "locationName": "MaintenanceTrack", + "type": "structure", + "members": { + "MaintenanceTrackName": {}, + "DatabaseVersion": {}, + "UpdateTargets": { + "type": "list", + "member": { + "locationName": "UpdateTarget", + "type": "structure", + "members": { + "MaintenanceTrackName": {}, + "DatabaseVersion": {}, + "SupportedOperations": { + "type": "list", + "member": { + "locationName": "SupportedOperation", + "type": "structure", + "members": { + "OperationName": {} + } + } + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeClusterVersions": { + "input": { + "type": "structure", + "members": { + "ClusterVersion": {}, + "ClusterParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "ClusterVersions": { + "type": "list", + "member": { + "locationName": "ClusterVersion", + "type": "structure", + "members": { + "ClusterVersion": {}, + "ClusterParameterGroupFamily": {}, + "Description": {} + } + } + } + } + } + }, + "DescribeClusters": { + "input": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "Clusters": { + "type": "list", + "member": { + "shape": "S1i", + "locationName": "Cluster" + } + } + } + } + }, + "DescribeDefaultClusterParameters": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupFamily" + ], + "members": { + "ParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDefaultClusterParametersResult", + "type": "structure", + "members": { + "DefaultClusterParameters": { + "type": "structure", + "members": { + "ParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S44" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {} + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "Events": { + "type": "list", + "member": { + "locationName": "EventInfoMap", + "type": "structure", + "members": { + "EventId": {}, + "EventCategories": { + "shape": "S2p" + }, + "EventDescription": {}, + "Severity": {} + }, + "wrapper": true + } + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S2r", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S2p" + }, + "Severity": {}, + "Date": { + "type": "timestamp" + }, + "EventId": {} + } + } + } + } + } + }, + "DescribeHsmClientCertificates": { + "input": { + "type": "structure", + "members": { + "HsmClientCertificateIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeHsmClientCertificatesResult", + "type": "structure", + "members": { + "Marker": {}, + "HsmClientCertificates": { + "type": "list", + "member": { + "shape": "S2u", + "locationName": "HsmClientCertificate" + } + } + } + } + }, + "DescribeHsmConfigurations": { + "input": { + "type": "structure", + "members": { + "HsmConfigurationIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeHsmConfigurationsResult", + "type": "structure", + "members": { + "Marker": {}, + "HsmConfigurations": { + "type": "list", + "member": { + "shape": "S2x", + "locationName": "HsmConfiguration" + } + } + } + } + }, + "DescribeLoggingStatus": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "shape": "S5n", + "resultWrapper": "DescribeLoggingStatusResult" + } + }, + "DescribeOrderableClusterOptions": { + "input": { + "type": "structure", + "members": { + "ClusterVersion": {}, + "NodeType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableClusterOptionsResult", + "type": "structure", + "members": { + "OrderableClusterOptions": { + "type": "list", + "member": { + "locationName": "OrderableClusterOption", + "type": "structure", + "members": { + "ClusterVersion": {}, + "ClusterType": {}, + "NodeType": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S2k", + "locationName": "AvailabilityZone" + } + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedNodeOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedNodeOfferingId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedNodeOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedNodeOfferings": { + "shape": "S5v" + } + } + } + }, + "DescribeReservedNodes": { + "input": { + "type": "structure", + "members": { + "ReservedNodeId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedNodesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedNodes": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "ReservedNode" + } + } + } + } + }, + "DescribeResize": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "shape": "S14", + "resultWrapper": "DescribeResizeResult" + } + }, + "DescribeSnapshotCopyGrants": { + "input": { + "type": "structure", + "members": { + "SnapshotCopyGrantName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeSnapshotCopyGrantsResult", + "type": "structure", + "members": { + "Marker": {}, + "SnapshotCopyGrants": { + "type": "list", + "member": { + "shape": "S30", + "locationName": "SnapshotCopyGrant" + } + } + } + } + }, + "DescribeSnapshotSchedules": { + "input": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "ScheduleIdentifier": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeSnapshotSchedulesResult", + "type": "structure", + "members": { + "SnapshotSchedules": { + "type": "list", + "member": { + "shape": "S33", + "locationName": "SnapshotSchedule" + } + }, + "Marker": {} + } + } + }, + "DescribeStorage": { + "output": { + "resultWrapper": "DescribeStorageResult", + "type": "structure", + "members": { + "TotalBackupSizeInMegaBytes": { + "type": "double" + }, + "TotalProvisionedStorageInMegaBytes": { + "type": "double" + } + } + } + }, + "DescribeTableRestoreStatus": { + "input": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "TableRestoreRequestId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeTableRestoreStatusResult", + "type": "structure", + "members": { + "TableRestoreStatusDetails": { + "type": "list", + "member": { + "shape": "S6b", + "locationName": "TableRestoreStatus" + } + }, + "Marker": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "members": { + "ResourceName": {}, + "ResourceType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "TagKeys": { + "shape": "S3k" + }, + "TagValues": { + "shape": "S3z" + } + } + }, + "output": { + "resultWrapper": "DescribeTagsResult", + "type": "structure", + "members": { + "TaggedResources": { + "type": "list", + "member": { + "locationName": "TaggedResource", + "type": "structure", + "members": { + "Tag": { + "shape": "Sh" + }, + "ResourceName": {}, + "ResourceType": {} + } + } + }, + "Marker": {} + } + } + }, + "DisableLogging": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "shape": "S5n", + "resultWrapper": "DisableLoggingResult" + } + }, + "DisableSnapshotCopy": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "DisableSnapshotCopyResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "EnableLogging": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "BucketName" + ], + "members": { + "ClusterIdentifier": {}, + "BucketName": {}, + "S3KeyPrefix": {} + } + }, + "output": { + "shape": "S5n", + "resultWrapper": "EnableLoggingResult" + } + }, + "EnableSnapshotCopy": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "DestinationRegion" + ], + "members": { + "ClusterIdentifier": {}, + "DestinationRegion": {}, + "RetentionPeriod": { + "type": "integer" + }, + "SnapshotCopyGrantName": {}, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "EnableSnapshotCopyResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "GetClusterCredentials": { + "input": { + "type": "structure", + "required": [ + "DbUser", + "ClusterIdentifier" + ], + "members": { + "DbUser": {}, + "DbName": {}, + "ClusterIdentifier": {}, + "DurationSeconds": { + "type": "integer" + }, + "AutoCreate": { + "type": "boolean" + }, + "DbGroups": { + "type": "list", + "member": { + "locationName": "DbGroup" + } + } + } + }, + "output": { + "resultWrapper": "GetClusterCredentialsResult", + "type": "structure", + "members": { + "DbUser": {}, + "DbPassword": { + "type": "string", + "sensitive": true + }, + "Expiration": { + "type": "timestamp" + } + } + } + }, + "GetReservedNodeExchangeOfferings": { + "input": { + "type": "structure", + "required": [ + "ReservedNodeId" + ], + "members": { + "ReservedNodeId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "GetReservedNodeExchangeOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedNodeOfferings": { + "shape": "S5v" + } + } + } + }, + "ModifyCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "ClusterType": {}, + "NodeType": {}, + "NumberOfNodes": { + "type": "integer" + }, + "ClusterSecurityGroups": { + "shape": "S1d" + }, + "VpcSecurityGroupIds": { + "shape": "S1e" + }, + "MasterUserPassword": {}, + "ClusterParameterGroupName": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "PreferredMaintenanceWindow": {}, + "ClusterVersion": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "NewClusterIdentifier": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "ElasticIp": {}, + "EnhancedVpcRouting": { + "type": "boolean" + }, + "MaintenanceTrackName": {}, + "Encrypted": { + "type": "boolean" + }, + "KmsKeyId": {} + } + }, + "output": { + "resultWrapper": "ModifyClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "ModifyClusterDbRevision": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "RevisionTarget" + ], + "members": { + "ClusterIdentifier": {}, + "RevisionTarget": {} + } + }, + "output": { + "resultWrapper": "ModifyClusterDbRevisionResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "ModifyClusterIamRoles": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "AddIamRoles": { + "shape": "S1g" + }, + "RemoveIamRoles": { + "shape": "S1g" + } + } + }, + "output": { + "resultWrapper": "ModifyClusterIamRolesResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "ModifyClusterMaintenance": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "DeferMaintenance": { + "type": "boolean" + }, + "DeferMaintenanceIdentifier": {}, + "DeferMaintenanceStartTime": { + "type": "timestamp" + }, + "DeferMaintenanceEndTime": { + "type": "timestamp" + }, + "DeferMaintenanceDuration": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ModifyClusterMaintenanceResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "ModifyClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName", + "Parameters" + ], + "members": { + "ParameterGroupName": {}, + "Parameters": { + "shape": "S44" + } + } + }, + "output": { + "shape": "S72", + "resultWrapper": "ModifyClusterParameterGroupResult" + } + }, + "ModifyClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier" + ], + "members": { + "SnapshotIdentifier": {}, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "Force": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyClusterSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sm" + } + } + } + }, + "ModifyClusterSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "ScheduleIdentifier": {}, + "DisassociateSchedule": { + "type": "boolean" + } + } + } + }, + "ModifyClusterSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSubnetGroupName", + "SubnetIds" + ], + "members": { + "ClusterSubnetGroupName": {}, + "Description": {}, + "SubnetIds": { + "shape": "S2f" + } + } + }, + "output": { + "resultWrapper": "ModifyClusterSubnetGroupResult", + "type": "structure", + "members": { + "ClusterSubnetGroup": { + "shape": "S2h" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "SourceIds": { + "shape": "S2o" + }, + "EventCategories": { + "shape": "S2p" + }, + "Severity": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S2r" + } + } + } + }, + "ModifySnapshotCopyRetentionPeriod": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "RetentionPeriod" + ], + "members": { + "ClusterIdentifier": {}, + "RetentionPeriod": { + "type": "integer" + }, + "Manual": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ModifySnapshotCopyRetentionPeriodResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "ModifySnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "ScheduleIdentifier", + "ScheduleDefinitions" + ], + "members": { + "ScheduleIdentifier": {}, + "ScheduleDefinitions": { + "shape": "S32" + } + } + }, + "output": { + "shape": "S33", + "resultWrapper": "ModifySnapshotScheduleResult" + } + }, + "PurchaseReservedNodeOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedNodeOfferingId" + ], + "members": { + "ReservedNodeOfferingId": {}, + "NodeCount": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "PurchaseReservedNodeOfferingResult", + "type": "structure", + "members": { + "ReservedNode": { + "shape": "S4" + } + } + } + }, + "RebootCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "RebootClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "ResetClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S44" + } + } + }, + "output": { + "shape": "S72", + "resultWrapper": "ResetClusterParameterGroupResult" + } + }, + "ResizeCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "NumberOfNodes" + ], + "members": { + "ClusterIdentifier": {}, + "ClusterType": {}, + "NodeType": {}, + "NumberOfNodes": { + "type": "integer" + }, + "Classic": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "ResizeClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "RestoreFromClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "SnapshotIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "ClusterSubnetGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "OwnerAccount": {}, + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "ElasticIp": {}, + "ClusterParameterGroupName": {}, + "ClusterSecurityGroups": { + "shape": "S1d" + }, + "VpcSecurityGroupIds": { + "shape": "S1e" + }, + "PreferredMaintenanceWindow": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "KmsKeyId": {}, + "NodeType": {}, + "EnhancedVpcRouting": { + "type": "boolean" + }, + "AdditionalInfo": {}, + "IamRoles": { + "shape": "S1g" + }, + "MaintenanceTrackName": {}, + "SnapshotScheduleIdentifier": {} + } + }, + "output": { + "resultWrapper": "RestoreFromClusterSnapshotResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + }, + "RestoreTableFromClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "SnapshotIdentifier", + "SourceDatabaseName", + "SourceTableName", + "NewTableName" + ], + "members": { + "ClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "SourceDatabaseName": {}, + "SourceSchemaName": {}, + "SourceTableName": {}, + "TargetDatabaseName": {}, + "TargetSchemaName": {}, + "NewTableName": {} + } + }, + "output": { + "resultWrapper": "RestoreTableFromClusterSnapshotResult", + "type": "structure", + "members": { + "TableRestoreStatus": { + "shape": "S6b" + } + } + } + }, + "RevokeClusterSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName" + ], + "members": { + "ClusterSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "resultWrapper": "RevokeClusterSecurityGroupIngressResult", + "type": "structure", + "members": { + "ClusterSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "RevokeSnapshotAccess": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members": { + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {}, + "AccountWithRestoreAccess": {} + } + }, + "output": { + "resultWrapper": "RevokeSnapshotAccessResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sm" + } + } + } + }, + "RotateEncryptionKey": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "RotateEncryptionKeyResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "S1i" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "ReservedNodeId": {}, + "ReservedNodeOfferingId": {}, + "NodeType": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "NodeCount": { + "type": "integer" + }, + "State": {}, + "OfferingType": {}, + "RecurringCharges": { + "shape": "S8" + }, + "ReservedNodeOfferingType": {} + }, + "wrapper": true + }, + "S8": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "Sd": { + "type": "structure", + "members": { + "ClusterSecurityGroupName": {}, + "Description": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {}, + "Tags": { + "shape": "Sg" + } + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {}, + "Tags": { + "shape": "Sg" + } + } + } + }, + "Tags": { + "shape": "Sg" + } + }, + "wrapper": true + }, + "Sg": { + "type": "list", + "member": { + "shape": "Sh", + "locationName": "Tag" + } + }, + "Sh": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + }, + "Sm": { + "type": "structure", + "members": { + "SnapshotIdentifier": {}, + "ClusterIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "ClusterCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "ClusterVersion": {}, + "SnapshotType": {}, + "NodeType": {}, + "NumberOfNodes": { + "type": "integer" + }, + "DBName": {}, + "VpcId": {}, + "Encrypted": { + "type": "boolean" + }, + "KmsKeyId": {}, + "EncryptedWithHSM": { + "type": "boolean" + }, + "AccountsWithRestoreAccess": { + "type": "list", + "member": { + "locationName": "AccountWithRestoreAccess", + "type": "structure", + "members": { + "AccountId": {}, + "AccountAlias": {} + } + } + }, + "OwnerAccount": {}, + "TotalBackupSizeInMegaBytes": { + "type": "double" + }, + "ActualIncrementalBackupSizeInMegaBytes": { + "type": "double" + }, + "BackupProgressInMegaBytes": { + "type": "double" + }, + "CurrentBackupRateInMegaBytesPerSecond": { + "type": "double" + }, + "EstimatedSecondsToCompletion": { + "type": "long" + }, + "ElapsedTimeInSeconds": { + "type": "long" + }, + "SourceRegion": {}, + "Tags": { + "shape": "Sg" + }, + "RestorableNodeTypes": { + "type": "list", + "member": { + "locationName": "NodeType" + } + }, + "EnhancedVpcRouting": { + "type": "boolean" + }, + "MaintenanceTrackName": {}, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "ManualSnapshotRemainingDays": { + "type": "integer" + }, + "SnapshotRetentionStartTime": { + "type": "timestamp" + } + }, + "wrapper": true + }, + "Sv": { + "type": "structure", + "required": [ + "SnapshotIdentifier" + ], + "members": { + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {} + } + }, + "Sx": { + "type": "list", + "member": { + "locationName": "String" + } + }, + "Sz": { + "type": "structure", + "members": { + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {}, + "FailureCode": {}, + "FailureReason": {} + } + }, + "S14": { + "type": "structure", + "members": { + "TargetNodeType": {}, + "TargetNumberOfNodes": { + "type": "integer" + }, + "TargetClusterType": {}, + "Status": {}, + "ImportTablesCompleted": { + "type": "list", + "member": {} + }, + "ImportTablesInProgress": { + "type": "list", + "member": {} + }, + "ImportTablesNotStarted": { + "type": "list", + "member": {} + }, + "AvgResizeRateInMegaBytesPerSecond": { + "type": "double" + }, + "TotalResizeDataInMegaBytes": { + "type": "long" + }, + "ProgressInMegaBytes": { + "type": "long" + }, + "ElapsedTimeInSeconds": { + "type": "long" + }, + "EstimatedTimeToCompletionInSeconds": { + "type": "long" + }, + "ResizeType": {}, + "Message": {}, + "TargetEncryptionType": {}, + "DataTransferProgressPercent": { + "type": "double" + } + } + }, + "S1d": { + "type": "list", + "member": { + "locationName": "ClusterSecurityGroupName" + } + }, + "S1e": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "S1g": { + "type": "list", + "member": { + "locationName": "IamRoleArn" + } + }, + "S1i": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "NodeType": {}, + "ClusterStatus": {}, + "ModifyStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "ClusterCreateTime": { + "type": "timestamp" + }, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "ClusterSecurityGroups": { + "type": "list", + "member": { + "locationName": "ClusterSecurityGroup", + "type": "structure", + "members": { + "ClusterSecurityGroupName": {}, + "Status": {} + } + } + }, + "VpcSecurityGroups": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroup", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "ClusterParameterGroups": { + "type": "list", + "member": { + "locationName": "ClusterParameterGroup", + "type": "structure", + "members": { + "ParameterGroupName": {}, + "ParameterApplyStatus": {}, + "ClusterParameterStatusList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterApplyStatus": {}, + "ParameterApplyErrorDescription": {} + } + } + } + } + } + }, + "ClusterSubnetGroupName": {}, + "VpcId": {}, + "AvailabilityZone": {}, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "MasterUserPassword": {}, + "NodeType": {}, + "NumberOfNodes": { + "type": "integer" + }, + "ClusterType": {}, + "ClusterVersion": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "ClusterIdentifier": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "EnhancedVpcRouting": { + "type": "boolean" + }, + "MaintenanceTrackName": {}, + "EncryptionType": {} + } + }, + "ClusterVersion": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "NumberOfNodes": { + "type": "integer" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "RestoreStatus": { + "type": "structure", + "members": { + "Status": {}, + "CurrentRestoreRateInMegaBytesPerSecond": { + "type": "double" + }, + "SnapshotSizeInMegaBytes": { + "type": "long" + }, + "ProgressInMegaBytes": { + "type": "long" + }, + "ElapsedTimeInSeconds": { + "type": "long" + }, + "EstimatedTimeToCompletionInSeconds": { + "type": "long" + } + } + }, + "DataTransferProgress": { + "type": "structure", + "members": { + "Status": {}, + "CurrentRateInMegaBytesPerSecond": { + "type": "double" + }, + "TotalDataInMegaBytes": { + "type": "long" + }, + "DataTransferredInMegaBytes": { + "type": "long" + }, + "EstimatedTimeToCompletionInSeconds": { + "type": "long" + }, + "ElapsedTimeInSeconds": { + "type": "long" + } + } + }, + "HsmStatus": { + "type": "structure", + "members": { + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "Status": {} + } + }, + "ClusterSnapshotCopyStatus": { + "type": "structure", + "members": { + "DestinationRegion": {}, + "RetentionPeriod": { + "type": "long" + }, + "ManualSnapshotRetentionPeriod": { + "type": "integer" + }, + "SnapshotCopyGrantName": {} + } + }, + "ClusterPublicKey": {}, + "ClusterNodes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "NodeRole": {}, + "PrivateIPAddress": {}, + "PublicIPAddress": {} + } + } + }, + "ElasticIpStatus": { + "type": "structure", + "members": { + "ElasticIp": {}, + "Status": {} + } + }, + "ClusterRevisionNumber": {}, + "Tags": { + "shape": "Sg" + }, + "KmsKeyId": {}, + "EnhancedVpcRouting": { + "type": "boolean" + }, + "IamRoles": { + "type": "list", + "member": { + "locationName": "ClusterIamRole", + "type": "structure", + "members": { + "IamRoleArn": {}, + "ApplyStatus": {} + } + } + }, + "PendingActions": { + "type": "list", + "member": {} + }, + "MaintenanceTrackName": {}, + "ElasticResizeNumberOfNodeOptions": {}, + "DeferredMaintenanceWindows": { + "type": "list", + "member": { + "locationName": "DeferredMaintenanceWindow", + "type": "structure", + "members": { + "DeferMaintenanceIdentifier": {}, + "DeferMaintenanceStartTime": { + "type": "timestamp" + }, + "DeferMaintenanceEndTime": { + "type": "timestamp" + } + } + } + }, + "SnapshotScheduleIdentifier": {}, + "SnapshotScheduleState": {}, + "ResizeInfo": { + "type": "structure", + "members": { + "ResizeType": {}, + "AllowCancelResize": { + "type": "boolean" + } + } + } + }, + "wrapper": true + }, + "S29": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "ParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "Sg" + } + }, + "wrapper": true + }, + "S2f": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S2h": { + "type": "structure", + "members": { + "ClusterSubnetGroupName": {}, + "Description": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S2k" + }, + "SubnetStatus": {} + } + } + }, + "Tags": { + "shape": "Sg" + } + }, + "wrapper": true + }, + "S2k": { + "type": "structure", + "members": { + "Name": {}, + "SupportedPlatforms": { + "type": "list", + "member": { + "locationName": "SupportedPlatform", + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + } + } + }, + "wrapper": true + }, + "S2o": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S2p": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S2r": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": { + "type": "timestamp" + }, + "SourceType": {}, + "SourceIdsList": { + "shape": "S2o" + }, + "EventCategoriesList": { + "shape": "S2p" + }, + "Severity": {}, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "Sg" + } + }, + "wrapper": true + }, + "S2u": { + "type": "structure", + "members": { + "HsmClientCertificateIdentifier": {}, + "HsmClientCertificatePublicKey": {}, + "Tags": { + "shape": "Sg" + } + }, + "wrapper": true + }, + "S2x": { + "type": "structure", + "members": { + "HsmConfigurationIdentifier": {}, + "Description": {}, + "HsmIpAddress": {}, + "HsmPartitionName": {}, + "Tags": { + "shape": "Sg" + } + }, + "wrapper": true + }, + "S30": { + "type": "structure", + "members": { + "SnapshotCopyGrantName": {}, + "KmsKeyId": {}, + "Tags": { + "shape": "Sg" + } + }, + "wrapper": true + }, + "S32": { + "type": "list", + "member": { + "locationName": "ScheduleDefinition" + } + }, + "S33": { + "type": "structure", + "members": { + "ScheduleDefinitions": { + "shape": "S32" + }, + "ScheduleIdentifier": {}, + "ScheduleDescription": {}, + "Tags": { + "shape": "Sg" + }, + "NextInvocations": { + "type": "list", + "member": { + "locationName": "SnapshotTime", + "type": "timestamp" + } + }, + "AssociatedClusterCount": { + "type": "integer" + }, + "AssociatedClusters": { + "type": "list", + "member": { + "locationName": "ClusterAssociatedToSchedule", + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "ScheduleAssociationState": {} + } + } + } + } + }, + "S3k": { + "type": "list", + "member": { + "locationName": "TagKey" + } + }, + "S3z": { + "type": "list", + "member": { + "locationName": "TagValue" + } + }, + "S44": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "DataType": {}, + "AllowedValues": {}, + "ApplyType": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {} + } + } + }, + "S5n": { + "type": "structure", + "members": { + "LoggingEnabled": { + "type": "boolean" + }, + "BucketName": {}, + "S3KeyPrefix": {}, + "LastSuccessfulDeliveryTime": { + "type": "timestamp" + }, + "LastFailureTime": { + "type": "timestamp" + }, + "LastFailureMessage": {} + } + }, + "S5v": { + "type": "list", + "member": { + "locationName": "ReservedNodeOffering", + "type": "structure", + "members": { + "ReservedNodeOfferingId": {}, + "NodeType": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "OfferingType": {}, + "RecurringCharges": { + "shape": "S8" + }, + "ReservedNodeOfferingType": {} + }, + "wrapper": true + } + }, + "S6b": { + "type": "structure", + "members": { + "TableRestoreRequestId": {}, + "Status": {}, + "Message": {}, + "RequestTime": { + "type": "timestamp" + }, + "ProgressInMegaBytes": { + "type": "long" + }, + "TotalDataInMegaBytes": { + "type": "long" + }, + "ClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "SourceDatabaseName": {}, + "SourceSchemaName": {}, + "SourceTableName": {}, + "TargetDatabaseName": {}, + "TargetSchemaName": {}, + "NewTableName": {} + }, + "wrapper": true + }, + "S72": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "ParameterGroupStatus": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/redshift-2012-12-01.paginators.json b/node_modules/aws-sdk/apis/redshift-2012-12-01.paginators.json new file mode 100644 index 0000000..9ed71e3 --- /dev/null +++ b/node_modules/aws-sdk/apis/redshift-2012-12-01.paginators.json @@ -0,0 +1,94 @@ +{ + "pagination": { + "DescribeClusterParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ParameterGroups" + }, + "DescribeClusterParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeClusterSecurityGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ClusterSecurityGroups" + }, + "DescribeClusterSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Snapshots" + }, + "DescribeClusterSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ClusterSubnetGroups" + }, + "DescribeClusterVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ClusterVersions" + }, + "DescribeClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Clusters" + }, + "DescribeDefaultClusterParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "DefaultClusterParameters.Marker", + "result_key": "DefaultClusterParameters.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeHsmClientCertificates": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "HsmClientCertificates" + }, + "DescribeHsmConfigurations": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "HsmConfigurations" + }, + "DescribeOrderableClusterOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableClusterOptions" + }, + "DescribeReservedNodeOfferings": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedNodeOfferings" + }, + "DescribeReservedNodes": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedNodes" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/redshift-2012-12-01.waiters2.json b/node_modules/aws-sdk/apis/redshift-2012-12-01.waiters2.json new file mode 100644 index 0000000..164e9b0 --- /dev/null +++ b/node_modules/aws-sdk/apis/redshift-2012-12-01.waiters2.json @@ -0,0 +1,97 @@ +{ + "version": 2, + "waiters": { + "ClusterAvailable": { + "delay": 60, + "operation": "DescribeClusters", + "maxAttempts": 30, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "ClusterNotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "ClusterDeleted": { + "delay": 60, + "operation": "DescribeClusters", + "maxAttempts": 30, + "acceptors": [ + { + "expected": "ClusterNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + } + ] + }, + "ClusterRestored": { + "operation": "DescribeClusters", + "maxAttempts": 30, + "delay": 60, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Clusters[].RestoreStatus.Status", + "expected": "completed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Clusters[].ClusterStatus", + "expected": "deleting" + } + ] + }, + "SnapshotAvailable": { + "delay": 15, + "operation": "DescribeClusterSnapshots", + "maxAttempts": 20, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Snapshots[].Status" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Snapshots[].Status" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/rekognition-2016-06-27.examples.json b/node_modules/aws-sdk/apis/rekognition-2016-06-27.examples.json new file mode 100644 index 0000000..039e04d --- /dev/null +++ b/node_modules/aws-sdk/apis/rekognition-2016-06-27.examples.json @@ -0,0 +1,651 @@ +{ + "version": "1.0", + "examples": { + "CompareFaces": [ + { + "input": { + "SimilarityThreshold": 90, + "SourceImage": { + "S3Object": { + "Bucket": "mybucket", + "Name": "mysourceimage" + } + }, + "TargetImage": { + "S3Object": { + "Bucket": "mybucket", + "Name": "mytargetimage" + } + } + }, + "output": { + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289 + }, + "Similarity": 100 + } + ], + "SourceImageFace": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation compares the largest face detected in the source image with each face detected in the target image.", + "id": "to-compare-two-images-1482181985581", + "title": "To compare two images" + } + ], + "CreateCollection": [ + { + "input": { + "CollectionId": "myphotos" + }, + "output": { + "CollectionArn": "aws:rekognition:us-west-2:123456789012:collection/myphotos", + "StatusCode": 200 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation creates a Rekognition collection for storing image data.", + "id": "to-create-a-collection-1481833313674", + "title": "To create a collection" + } + ], + "DeleteCollection": [ + { + "input": { + "CollectionId": "myphotos" + }, + "output": { + "StatusCode": 200 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Rekognition collection.", + "id": "to-delete-a-collection-1481838179973", + "title": "To delete a collection" + } + ], + "DeleteFaces": [ + { + "input": { + "CollectionId": "myphotos", + "FaceIds": [ + "ff43d742-0c13-5d16-a3e8-03d3f58e980b" + ] + }, + "output": { + "DeletedFaces": [ + "ff43d742-0c13-5d16-a3e8-03d3f58e980b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes one or more faces from a Rekognition collection.", + "id": "to-delete-a-face-1482182799377", + "title": "To delete a face" + } + ], + "DetectFaces": [ + { + "input": { + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + } + }, + "output": { + "FaceDetails": [ + { + "BoundingBox": { + "Height": 0.18000000715255737, + "Left": 0.5555555820465088, + "Top": 0.33666667342185974, + "Width": 0.23999999463558197 + }, + "Confidence": 100, + "Landmarks": [ + { + "Type": "eyeLeft", + "X": 0.6394737362861633, + "Y": 0.40819624066352844 + }, + { + "Type": "eyeRight", + "X": 0.7266660928726196, + "Y": 0.41039225459098816 + }, + { + "Type": "eyeRight", + "X": 0.6912462115287781, + "Y": 0.44240960478782654 + }, + { + "Type": "mouthDown", + "X": 0.6306198239326477, + "Y": 0.46700039505958557 + }, + { + "Type": "mouthUp", + "X": 0.7215608954429626, + "Y": 0.47114261984825134 + } + ], + "Pose": { + "Pitch": 4.050806522369385, + "Roll": 0.9950747489929199, + "Yaw": 13.693790435791016 + }, + "Quality": { + "Brightness": 37.60169982910156, + "Sharpness": 80 + } + } + ], + "OrientationCorrection": "ROTATE_0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation detects faces in an image stored in an AWS S3 bucket.", + "id": "to-detect-faces-in-an-image-1481841782793", + "title": "To detect faces in an image" + } + ], + "DetectLabels": [ + { + "input": { + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + }, + "MaxLabels": 123, + "MinConfidence": 70 + }, + "output": { + "Labels": [ + { + "Confidence": 99.25072479248047, + "Name": "People" + }, + { + "Confidence": 99.25074005126953, + "Name": "Person" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation detects labels in the supplied image", + "id": "to-detect-labels-1481834255770", + "title": "To detect labels" + } + ], + "IndexFaces": [ + { + "input": { + "CollectionId": "myphotos", + "DetectionAttributes": [ + + ], + "ExternalImageId": "myphotoid", + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + } + }, + "output": { + "FaceRecords": [ + { + "Face": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289, + "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + "FaceDetail": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289, + "Landmarks": [ + { + "Type": "eyeLeft", + "X": 0.3976764678955078, + "Y": 0.6248345971107483 + }, + { + "Type": "eyeRight", + "X": 0.4810936450958252, + "Y": 0.6317117214202881 + }, + { + "Type": "noseLeft", + "X": 0.41986238956451416, + "Y": 0.7111940383911133 + }, + { + "Type": "mouthDown", + "X": 0.40525302290916443, + "Y": 0.7497701048851013 + }, + { + "Type": "mouthUp", + "X": 0.4753248989582062, + "Y": 0.7558549642562866 + } + ], + "Pose": { + "Pitch": -9.713645935058594, + "Roll": 4.707281112670898, + "Yaw": -24.438663482666016 + }, + "Quality": { + "Brightness": 29.23358917236328, + "Sharpness": 80 + } + } + }, + { + "Face": { + "BoundingBox": { + "Height": 0.32592591643333435, + "Left": 0.5144444704055786, + "Top": 0.15111111104488373, + "Width": 0.24444444477558136 + }, + "Confidence": 99.99950408935547, + "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + "FaceDetail": { + "BoundingBox": { + "Height": 0.32592591643333435, + "Left": 0.5144444704055786, + "Top": 0.15111111104488373, + "Width": 0.24444444477558136 + }, + "Confidence": 99.99950408935547, + "Landmarks": [ + { + "Type": "eyeLeft", + "X": 0.6006892323493958, + "Y": 0.290842205286026 + }, + { + "Type": "eyeRight", + "X": 0.6808141469955444, + "Y": 0.29609042406082153 + }, + { + "Type": "noseLeft", + "X": 0.6395332217216492, + "Y": 0.3522595763206482 + }, + { + "Type": "mouthDown", + "X": 0.5892083048820496, + "Y": 0.38689887523651123 + }, + { + "Type": "mouthUp", + "X": 0.674560010433197, + "Y": 0.394125759601593 + } + ], + "Pose": { + "Pitch": -4.683138370513916, + "Roll": 2.1029529571533203, + "Yaw": 6.716655254364014 + }, + "Quality": { + "Brightness": 34.951698303222656, + "Sharpness": 160 + } + } + } + ], + "OrientationCorrection": "ROTATE_0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation detects faces in an image and adds them to the specified Rekognition collection.", + "id": "to-add-a-face-to-a-collection-1482179542923", + "title": "To add a face to a collection" + } + ], + "ListCollections": [ + { + "input": { + }, + "output": { + "CollectionIds": [ + "myphotos" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation returns a list of Rekognition collections.", + "id": "to-list-the-collections-1482179199088", + "title": "To list the collections" + } + ], + "ListFaces": [ + { + "input": { + "CollectionId": "myphotos", + "MaxResults": 20 + }, + "output": { + "Faces": [ + { + "BoundingBox": { + "Height": 0.18000000715255737, + "Left": 0.5555559992790222, + "Top": 0.336667001247406, + "Width": 0.23999999463558197 + }, + "Confidence": 100, + "FaceId": "1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7", + "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e" + }, + { + "BoundingBox": { + "Height": 0.16555599868297577, + "Left": 0.30963000655174255, + "Top": 0.7066670060157776, + "Width": 0.22074100375175476 + }, + "Confidence": 100, + "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c", + "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e" + }, + { + "BoundingBox": { + "Height": 0.3234420120716095, + "Left": 0.3233329951763153, + "Top": 0.5, + "Width": 0.24222199618816376 + }, + "Confidence": 99.99829864501953, + "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85", + "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5" + }, + { + "BoundingBox": { + "Height": 0.03555560111999512, + "Left": 0.37388700246810913, + "Top": 0.2477779984474182, + "Width": 0.04747769981622696 + }, + "Confidence": 99.99210357666016, + "FaceId": "3b01bef0-c883-5654-ba42-d5ad28b720b3", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.05333330109715462, + "Left": 0.2937690019607544, + "Top": 0.35666701197624207, + "Width": 0.07121659815311432 + }, + "Confidence": 99.99919891357422, + "FaceId": "4839a608-49d0-566c-8301-509d71b534d1", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.3249259889125824, + "Left": 0.5155559778213501, + "Top": 0.1513350009918213, + "Width": 0.24333299696445465 + }, + "Confidence": 99.99949645996094, + "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14", + "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5" + }, + { + "BoundingBox": { + "Height": 0.03777780011296272, + "Left": 0.7002969980239868, + "Top": 0.18777799606323242, + "Width": 0.05044509842991829 + }, + "Confidence": 99.92639923095703, + "FaceId": "7f5f88ed-d684-5a88-b0df-01e4a521552b", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.05555560067296028, + "Left": 0.13946600258350372, + "Top": 0.46333301067352295, + "Width": 0.07270029932260513 + }, + "Confidence": 99.99469757080078, + "FaceId": "895b4e2c-81de-5902-a4bd-d1792bda00b2", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.3259260058403015, + "Left": 0.5144439935684204, + "Top": 0.15111100673675537, + "Width": 0.24444399774074554 + }, + "Confidence": 99.99949645996094, + "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + { + "BoundingBox": { + "Height": 0.18888899683952332, + "Left": 0.3783380091190338, + "Top": 0.2355560064315796, + "Width": 0.25222599506378174 + }, + "Confidence": 99.9999008178711, + "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5", + "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07" + }, + { + "BoundingBox": { + "Height": 0.33481499552726746, + "Left": 0.31888899207115173, + "Top": 0.49333301186561584, + "Width": 0.25 + }, + "Confidence": 99.99909973144531, + "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation lists the faces in a Rekognition collection.", + "id": "to-list-the-faces-in-a-collection-1482181416530", + "title": "To list the faces in a collection" + } + ], + "SearchFaces": [ + { + "input": { + "CollectionId": "myphotos", + "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14", + "FaceMatchThreshold": 90, + "MaxFaces": 10 + }, + "output": { + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Height": 0.3259260058403015, + "Left": 0.5144439935684204, + "Top": 0.15111100673675537, + "Width": 0.24444399774074554 + }, + "Confidence": 99.99949645996094, + "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + "Similarity": 99.97222137451172 + }, + { + "Face": { + "BoundingBox": { + "Height": 0.16555599868297577, + "Left": 0.30963000655174255, + "Top": 0.7066670060157776, + "Width": 0.22074100375175476 + }, + "Confidence": 100, + "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c", + "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e" + }, + "Similarity": 97.04154968261719 + }, + { + "Face": { + "BoundingBox": { + "Height": 0.18888899683952332, + "Left": 0.3783380091190338, + "Top": 0.2355560064315796, + "Width": 0.25222599506378174 + }, + "Confidence": 99.9999008178711, + "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5", + "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07" + }, + "Similarity": 95.94520568847656 + } + ], + "SearchedFaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation searches for matching faces in the collection the supplied face belongs to.", + "id": "to-delete-a-face-1482182799377", + "title": "To delete a face" + } + ], + "SearchFacesByImage": [ + { + "input": { + "CollectionId": "myphotos", + "FaceMatchThreshold": 95, + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + }, + "MaxFaces": 5 + }, + "output": { + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Height": 0.3234420120716095, + "Left": 0.3233329951763153, + "Top": 0.5, + "Width": 0.24222199618816376 + }, + "Confidence": 99.99829864501953, + "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85", + "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5" + }, + "Similarity": 99.97036743164062 + } + ], + "SearchedFaceBoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "SearchedFaceConfidence": 99.9991226196289 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image.", + "id": "to-search-for-faces-matching-a-supplied-image-1482175994491", + "title": "To search for faces matching a supplied image" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json b/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json new file mode 100644 index 0000000..c4ec656 --- /dev/null +++ b/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json @@ -0,0 +1,1513 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-06-27", + "endpointPrefix": "rekognition", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Rekognition", + "serviceId": "Rekognition", + "signatureVersion": "v4", + "targetPrefix": "RekognitionService", + "uid": "rekognition-2016-06-27" + }, + "operations": { + "CompareFaces": { + "input": { + "type": "structure", + "required": [ + "SourceImage", + "TargetImage" + ], + "members": { + "SourceImage": { + "shape": "S2" + }, + "TargetImage": { + "shape": "S2" + }, + "SimilarityThreshold": { + "type": "float" + } + } + }, + "output": { + "type": "structure", + "members": { + "SourceImageFace": { + "type": "structure", + "members": { + "BoundingBox": { + "shape": "Sb" + }, + "Confidence": { + "type": "float" + } + } + }, + "FaceMatches": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Similarity": { + "type": "float" + }, + "Face": { + "shape": "Sf" + } + } + } + }, + "UnmatchedFaces": { + "type": "list", + "member": { + "shape": "Sf" + } + }, + "SourceImageOrientationCorrection": {}, + "TargetImageOrientationCorrection": {} + } + } + }, + "CreateCollection": { + "input": { + "type": "structure", + "required": [ + "CollectionId" + ], + "members": { + "CollectionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "StatusCode": { + "type": "integer" + }, + "CollectionArn": {}, + "FaceModelVersion": {} + } + } + }, + "CreateStreamProcessor": { + "input": { + "type": "structure", + "required": [ + "Input", + "Output", + "Name", + "Settings", + "RoleArn" + ], + "members": { + "Input": { + "shape": "Su" + }, + "Output": { + "shape": "Sx" + }, + "Name": {}, + "Settings": { + "shape": "S11" + }, + "RoleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "StreamProcessorArn": {} + } + } + }, + "DeleteCollection": { + "input": { + "type": "structure", + "required": [ + "CollectionId" + ], + "members": { + "CollectionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "StatusCode": { + "type": "integer" + } + } + } + }, + "DeleteFaces": { + "input": { + "type": "structure", + "required": [ + "CollectionId", + "FaceIds" + ], + "members": { + "CollectionId": {}, + "FaceIds": { + "shape": "S19" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeletedFaces": { + "shape": "S19" + } + } + } + }, + "DeleteStreamProcessor": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeCollection": { + "input": { + "type": "structure", + "required": [ + "CollectionId" + ], + "members": { + "CollectionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "FaceCount": { + "type": "long" + }, + "FaceModelVersion": {}, + "CollectionARN": {}, + "CreationTimestamp": { + "type": "timestamp" + } + } + } + }, + "DescribeStreamProcessor": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "StreamProcessorArn": {}, + "Status": {}, + "StatusMessage": {}, + "CreationTimestamp": { + "type": "timestamp" + }, + "LastUpdateTimestamp": { + "type": "timestamp" + }, + "Input": { + "shape": "Su" + }, + "Output": { + "shape": "Sx" + }, + "RoleArn": {}, + "Settings": { + "shape": "S11" + } + } + } + }, + "DetectFaces": { + "input": { + "type": "structure", + "required": [ + "Image" + ], + "members": { + "Image": { + "shape": "S2" + }, + "Attributes": { + "shape": "S1m" + } + } + }, + "output": { + "type": "structure", + "members": { + "FaceDetails": { + "type": "list", + "member": { + "shape": "S1q" + } + }, + "OrientationCorrection": {} + } + } + }, + "DetectLabels": { + "input": { + "type": "structure", + "required": [ + "Image" + ], + "members": { + "Image": { + "shape": "S2" + }, + "MaxLabels": { + "type": "integer" + }, + "MinConfidence": { + "type": "float" + } + } + }, + "output": { + "type": "structure", + "members": { + "Labels": { + "type": "list", + "member": { + "shape": "S28" + } + }, + "OrientationCorrection": {}, + "LabelModelVersion": {} + } + } + }, + "DetectModerationLabels": { + "input": { + "type": "structure", + "required": [ + "Image" + ], + "members": { + "Image": { + "shape": "S2" + }, + "MinConfidence": { + "type": "float" + } + } + }, + "output": { + "type": "structure", + "members": { + "ModerationLabels": { + "type": "list", + "member": { + "shape": "S2g" + } + }, + "ModerationModelVersion": {} + } + } + }, + "DetectText": { + "input": { + "type": "structure", + "required": [ + "Image" + ], + "members": { + "Image": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "TextDetections": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DetectedText": {}, + "Type": {}, + "Id": { + "type": "integer" + }, + "ParentId": { + "type": "integer" + }, + "Confidence": { + "type": "float" + }, + "Geometry": { + "type": "structure", + "members": { + "BoundingBox": { + "shape": "Sb" + }, + "Polygon": { + "type": "list", + "member": { + "type": "structure", + "members": { + "X": { + "type": "float" + }, + "Y": { + "type": "float" + } + } + } + } + } + } + } + } + } + } + } + }, + "GetCelebrityInfo": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "Urls": { + "shape": "S2s" + }, + "Name": {} + } + } + }, + "GetCelebrityRecognition": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "SortBy": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobStatus": {}, + "StatusMessage": {}, + "VideoMetadata": { + "shape": "S32" + }, + "NextToken": {}, + "Celebrities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "long" + }, + "Celebrity": { + "type": "structure", + "members": { + "Urls": { + "shape": "S2s" + }, + "Name": {}, + "Id": {}, + "Confidence": { + "type": "float" + }, + "BoundingBox": { + "shape": "Sb" + }, + "Face": { + "shape": "S1q" + } + } + } + } + } + } + } + } + }, + "GetContentModeration": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "SortBy": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobStatus": {}, + "StatusMessage": {}, + "VideoMetadata": { + "shape": "S32" + }, + "ModerationLabels": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "long" + }, + "ModerationLabel": { + "shape": "S2g" + } + } + } + }, + "NextToken": {}, + "ModerationModelVersion": {} + } + } + }, + "GetFaceDetection": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobStatus": {}, + "StatusMessage": {}, + "VideoMetadata": { + "shape": "S32" + }, + "NextToken": {}, + "Faces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "long" + }, + "Face": { + "shape": "S1q" + } + } + } + } + } + } + }, + "GetFaceSearch": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "SortBy": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobStatus": {}, + "StatusMessage": {}, + "NextToken": {}, + "VideoMetadata": { + "shape": "S32" + }, + "Persons": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "long" + }, + "Person": { + "shape": "S3l" + }, + "FaceMatches": { + "shape": "S3n" + } + } + } + } + } + } + }, + "GetLabelDetection": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "SortBy": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobStatus": {}, + "StatusMessage": {}, + "VideoMetadata": { + "shape": "S32" + }, + "NextToken": {}, + "Labels": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "long" + }, + "Label": { + "shape": "S28" + } + } + } + }, + "LabelModelVersion": {} + } + } + }, + "GetPersonTracking": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "SortBy": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobStatus": {}, + "StatusMessage": {}, + "VideoMetadata": { + "shape": "S32" + }, + "NextToken": {}, + "Persons": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "long" + }, + "Person": { + "shape": "S3l" + } + } + } + } + } + } + }, + "IndexFaces": { + "input": { + "type": "structure", + "required": [ + "CollectionId", + "Image" + ], + "members": { + "CollectionId": {}, + "Image": { + "shape": "S2" + }, + "ExternalImageId": {}, + "DetectionAttributes": { + "shape": "S1m" + }, + "MaxFaces": { + "type": "integer" + }, + "QualityFilter": {} + } + }, + "output": { + "type": "structure", + "members": { + "FaceRecords": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Face": { + "shape": "S3p" + }, + "FaceDetail": { + "shape": "S1q" + } + } + } + }, + "OrientationCorrection": {}, + "FaceModelVersion": {}, + "UnindexedFaces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Reasons": { + "type": "list", + "member": {} + }, + "FaceDetail": { + "shape": "S1q" + } + } + } + } + } + } + }, + "ListCollections": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "CollectionIds": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "FaceModelVersions": { + "type": "list", + "member": {} + } + } + } + }, + "ListFaces": { + "input": { + "type": "structure", + "required": [ + "CollectionId" + ], + "members": { + "CollectionId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Faces": { + "type": "list", + "member": { + "shape": "S3p" + } + }, + "NextToken": {}, + "FaceModelVersion": {} + } + } + }, + "ListStreamProcessors": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "StreamProcessors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Status": {} + } + } + } + } + } + }, + "RecognizeCelebrities": { + "input": { + "type": "structure", + "required": [ + "Image" + ], + "members": { + "Image": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "CelebrityFaces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Urls": { + "shape": "S2s" + }, + "Name": {}, + "Id": {}, + "Face": { + "shape": "Sf" + }, + "MatchConfidence": { + "type": "float" + } + } + } + }, + "UnrecognizedFaces": { + "type": "list", + "member": { + "shape": "Sf" + } + }, + "OrientationCorrection": {} + } + } + }, + "SearchFaces": { + "input": { + "type": "structure", + "required": [ + "CollectionId", + "FaceId" + ], + "members": { + "CollectionId": {}, + "FaceId": {}, + "MaxFaces": { + "type": "integer" + }, + "FaceMatchThreshold": { + "type": "float" + } + } + }, + "output": { + "type": "structure", + "members": { + "SearchedFaceId": {}, + "FaceMatches": { + "shape": "S3n" + }, + "FaceModelVersion": {} + } + } + }, + "SearchFacesByImage": { + "input": { + "type": "structure", + "required": [ + "CollectionId", + "Image" + ], + "members": { + "CollectionId": {}, + "Image": { + "shape": "S2" + }, + "MaxFaces": { + "type": "integer" + }, + "FaceMatchThreshold": { + "type": "float" + } + } + }, + "output": { + "type": "structure", + "members": { + "SearchedFaceBoundingBox": { + "shape": "Sb" + }, + "SearchedFaceConfidence": { + "type": "float" + }, + "FaceMatches": { + "shape": "S3n" + }, + "FaceModelVersion": {} + } + } + }, + "StartCelebrityRecognition": { + "input": { + "type": "structure", + "required": [ + "Video" + ], + "members": { + "Video": { + "shape": "S4z" + }, + "ClientRequestToken": {}, + "NotificationChannel": { + "shape": "S51" + }, + "JobTag": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + }, + "idempotent": true + }, + "StartContentModeration": { + "input": { + "type": "structure", + "required": [ + "Video" + ], + "members": { + "Video": { + "shape": "S4z" + }, + "MinConfidence": { + "type": "float" + }, + "ClientRequestToken": {}, + "NotificationChannel": { + "shape": "S51" + }, + "JobTag": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + }, + "idempotent": true + }, + "StartFaceDetection": { + "input": { + "type": "structure", + "required": [ + "Video" + ], + "members": { + "Video": { + "shape": "S4z" + }, + "ClientRequestToken": {}, + "NotificationChannel": { + "shape": "S51" + }, + "FaceAttributes": {}, + "JobTag": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + }, + "idempotent": true + }, + "StartFaceSearch": { + "input": { + "type": "structure", + "required": [ + "Video", + "CollectionId" + ], + "members": { + "Video": { + "shape": "S4z" + }, + "ClientRequestToken": {}, + "FaceMatchThreshold": { + "type": "float" + }, + "CollectionId": {}, + "NotificationChannel": { + "shape": "S51" + }, + "JobTag": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + }, + "idempotent": true + }, + "StartLabelDetection": { + "input": { + "type": "structure", + "required": [ + "Video" + ], + "members": { + "Video": { + "shape": "S4z" + }, + "ClientRequestToken": {}, + "MinConfidence": { + "type": "float" + }, + "NotificationChannel": { + "shape": "S51" + }, + "JobTag": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + }, + "idempotent": true + }, + "StartPersonTracking": { + "input": { + "type": "structure", + "required": [ + "Video" + ], + "members": { + "Video": { + "shape": "S4z" + }, + "ClientRequestToken": {}, + "NotificationChannel": { + "shape": "S51" + }, + "JobTag": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + }, + "idempotent": true + }, + "StartStreamProcessor": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopStreamProcessor": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "members": { + "Bytes": { + "type": "blob" + }, + "S3Object": { + "shape": "S4" + } + } + }, + "S4": { + "type": "structure", + "members": { + "Bucket": {}, + "Name": {}, + "Version": {} + } + }, + "Sb": { + "type": "structure", + "members": { + "Width": { + "type": "float" + }, + "Height": { + "type": "float" + }, + "Left": { + "type": "float" + }, + "Top": { + "type": "float" + } + } + }, + "Sf": { + "type": "structure", + "members": { + "BoundingBox": { + "shape": "Sb" + }, + "Confidence": { + "type": "float" + }, + "Landmarks": { + "shape": "Sg" + }, + "Pose": { + "shape": "Sj" + }, + "Quality": { + "shape": "Sl" + } + } + }, + "Sg": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "X": { + "type": "float" + }, + "Y": { + "type": "float" + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "Roll": { + "type": "float" + }, + "Yaw": { + "type": "float" + }, + "Pitch": { + "type": "float" + } + } + }, + "Sl": { + "type": "structure", + "members": { + "Brightness": { + "type": "float" + }, + "Sharpness": { + "type": "float" + } + } + }, + "Su": { + "type": "structure", + "members": { + "KinesisVideoStream": { + "type": "structure", + "members": { + "Arn": {} + } + } + } + }, + "Sx": { + "type": "structure", + "members": { + "KinesisDataStream": { + "type": "structure", + "members": { + "Arn": {} + } + } + } + }, + "S11": { + "type": "structure", + "members": { + "FaceSearch": { + "type": "structure", + "members": { + "CollectionId": {}, + "FaceMatchThreshold": { + "type": "float" + } + } + } + } + }, + "S19": { + "type": "list", + "member": {} + }, + "S1m": { + "type": "list", + "member": {} + }, + "S1q": { + "type": "structure", + "members": { + "BoundingBox": { + "shape": "Sb" + }, + "AgeRange": { + "type": "structure", + "members": { + "Low": { + "type": "integer" + }, + "High": { + "type": "integer" + } + } + }, + "Smile": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + }, + "Confidence": { + "type": "float" + } + } + }, + "Eyeglasses": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + }, + "Confidence": { + "type": "float" + } + } + }, + "Sunglasses": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + }, + "Confidence": { + "type": "float" + } + } + }, + "Gender": { + "type": "structure", + "members": { + "Value": {}, + "Confidence": { + "type": "float" + } + } + }, + "Beard": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + }, + "Confidence": { + "type": "float" + } + } + }, + "Mustache": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + }, + "Confidence": { + "type": "float" + } + } + }, + "EyesOpen": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + }, + "Confidence": { + "type": "float" + } + } + }, + "MouthOpen": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + }, + "Confidence": { + "type": "float" + } + } + }, + "Emotions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Confidence": { + "type": "float" + } + } + } + }, + "Landmarks": { + "shape": "Sg" + }, + "Pose": { + "shape": "Sj" + }, + "Quality": { + "shape": "Sl" + }, + "Confidence": { + "type": "float" + } + } + }, + "S28": { + "type": "structure", + "members": { + "Name": {}, + "Confidence": { + "type": "float" + }, + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BoundingBox": { + "shape": "Sb" + }, + "Confidence": { + "type": "float" + } + } + } + }, + "Parents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + } + } + }, + "S2g": { + "type": "structure", + "members": { + "Confidence": { + "type": "float" + }, + "Name": {}, + "ParentName": {} + } + }, + "S2s": { + "type": "list", + "member": {} + }, + "S32": { + "type": "structure", + "members": { + "Codec": {}, + "DurationMillis": { + "type": "long" + }, + "Format": {}, + "FrameRate": { + "type": "float" + }, + "FrameHeight": { + "type": "long" + }, + "FrameWidth": { + "type": "long" + } + } + }, + "S3l": { + "type": "structure", + "members": { + "Index": { + "type": "long" + }, + "BoundingBox": { + "shape": "Sb" + }, + "Face": { + "shape": "S1q" + } + } + }, + "S3n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Similarity": { + "type": "float" + }, + "Face": { + "shape": "S3p" + } + } + } + }, + "S3p": { + "type": "structure", + "members": { + "FaceId": {}, + "BoundingBox": { + "shape": "Sb" + }, + "ImageId": {}, + "ExternalImageId": {}, + "Confidence": { + "type": "float" + } + } + }, + "S4z": { + "type": "structure", + "members": { + "S3Object": { + "shape": "S4" + } + } + }, + "S51": { + "type": "structure", + "required": [ + "SNSTopicArn", + "RoleArn" + ], + "members": { + "SNSTopicArn": {}, + "RoleArn": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/rekognition-2016-06-27.paginators.json b/node_modules/aws-sdk/apis/rekognition-2016-06-27.paginators.json new file mode 100644 index 0000000..2448075 --- /dev/null +++ b/node_modules/aws-sdk/apis/rekognition-2016-06-27.paginators.json @@ -0,0 +1,51 @@ +{ + "pagination": { + "GetCelebrityRecognition": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetContentModeration": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetFaceDetection": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetFaceSearch": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetLabelDetection": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetPersonTracking": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListCollections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CollectionIds" + }, + "ListFaces": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Faces" + }, + "ListStreamProcessors": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/resource-groups-2017-11-27.examples.json b/node_modules/aws-sdk/apis/resource-groups-2017-11-27.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/resource-groups-2017-11-27.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/resource-groups-2017-11-27.min.json b/node_modules/aws-sdk/apis/resource-groups-2017-11-27.min.json new file mode 100644 index 0000000..9173871 --- /dev/null +++ b/node_modules/aws-sdk/apis/resource-groups-2017-11-27.min.json @@ -0,0 +1,490 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-11-27", + "endpointPrefix": "resource-groups", + "protocol": "rest-json", + "serviceAbbreviation": "Resource Groups", + "serviceFullName": "AWS Resource Groups", + "serviceId": "Resource Groups", + "signatureVersion": "v4", + "signingName": "resource-groups", + "uid": "resource-groups-2017-11-27" + }, + "operations": { + "CreateGroup": { + "http": { + "requestUri": "/groups" + }, + "input": { + "type": "structure", + "required": [ + "Name", + "ResourceQuery" + ], + "members": { + "Name": {}, + "Description": {}, + "ResourceQuery": { + "shape": "S4" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "Sb" + }, + "ResourceQuery": { + "shape": "S4" + }, + "Tags": { + "shape": "S7" + } + } + } + }, + "DeleteGroup": { + "http": { + "method": "DELETE", + "requestUri": "/groups/{GroupName}" + }, + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "Sb" + } + } + } + }, + "GetGroup": { + "http": { + "method": "GET", + "requestUri": "/groups/{GroupName}" + }, + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "Sb" + } + } + } + }, + "GetGroupQuery": { + "http": { + "method": "GET", + "requestUri": "/groups/{GroupName}/query" + }, + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupQuery": { + "shape": "Sj" + } + } + } + }, + "GetTags": { + "http": { + "method": "GET", + "requestUri": "/resources/{Arn}/tags" + }, + "input": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": { + "location": "uri", + "locationName": "Arn" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "Tags": { + "shape": "S7" + } + } + } + }, + "ListGroupResources": { + "http": { + "requestUri": "/groups/{GroupName}/resource-identifiers-list" + }, + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceIdentifiers": { + "shape": "Sv" + }, + "NextToken": {}, + "QueryErrors": { + "shape": "Sz" + } + } + } + }, + "ListGroups": { + "http": { + "requestUri": "/groups-list" + }, + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupIdentifiers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GroupName": {}, + "GroupArn": {} + } + } + }, + "Groups": { + "deprecated": true, + "deprecatedMessage": "This field is deprecated, use GroupIdentifiers instead.", + "type": "list", + "member": { + "shape": "Sb" + } + }, + "NextToken": {} + } + } + }, + "SearchResources": { + "http": { + "requestUri": "/resources/search" + }, + "input": { + "type": "structure", + "required": [ + "ResourceQuery" + ], + "members": { + "ResourceQuery": { + "shape": "S4" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceIdentifiers": { + "shape": "Sv" + }, + "NextToken": {}, + "QueryErrors": { + "shape": "Sz" + } + } + } + }, + "Tag": { + "http": { + "method": "PUT", + "requestUri": "/resources/{Arn}/tags" + }, + "input": { + "type": "structure", + "required": [ + "Arn", + "Tags" + ], + "members": { + "Arn": { + "location": "uri", + "locationName": "Arn" + }, + "Tags": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "Tags": { + "shape": "S7" + } + } + } + }, + "Untag": { + "http": { + "method": "PATCH", + "requestUri": "/resources/{Arn}/tags" + }, + "input": { + "type": "structure", + "required": [ + "Arn", + "Keys" + ], + "members": { + "Arn": { + "location": "uri", + "locationName": "Arn" + }, + "Keys": { + "shape": "S1i" + } + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "Keys": { + "shape": "S1i" + } + } + } + }, + "UpdateGroup": { + "http": { + "method": "PUT", + "requestUri": "/groups/{GroupName}" + }, + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "Sb" + } + } + } + }, + "UpdateGroupQuery": { + "http": { + "method": "PUT", + "requestUri": "/groups/{GroupName}/query" + }, + "input": { + "type": "structure", + "required": [ + "GroupName", + "ResourceQuery" + ], + "members": { + "GroupName": { + "location": "uri", + "locationName": "GroupName" + }, + "ResourceQuery": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupQuery": { + "shape": "Sj" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "Type", + "Query" + ], + "members": { + "Type": {}, + "Query": {} + } + }, + "S7": { + "type": "map", + "key": {}, + "value": {} + }, + "Sb": { + "type": "structure", + "required": [ + "GroupArn", + "Name" + ], + "members": { + "GroupArn": {}, + "Name": {}, + "Description": {} + } + }, + "Sj": { + "type": "structure", + "required": [ + "GroupName", + "ResourceQuery" + ], + "members": { + "GroupName": {}, + "ResourceQuery": { + "shape": "S4" + } + } + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceArn": {}, + "ResourceType": {} + } + } + }, + "Sz": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ErrorCode": {}, + "Message": {} + } + } + }, + "S1i": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/resource-groups-2017-11-27.paginators.json b/node_modules/aws-sdk/apis/resource-groups-2017-11-27.paginators.json new file mode 100644 index 0000000..809603d --- /dev/null +++ b/node_modules/aws-sdk/apis/resource-groups-2017-11-27.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "ListGroupResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.examples.json b/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.min.json b/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.min.json new file mode 100644 index 0000000..122cc13 --- /dev/null +++ b/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.min.json @@ -0,0 +1,189 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-01-26", + "endpointPrefix": "tagging", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Resource Groups Tagging API", + "serviceId": "Resource Groups Tagging API", + "signatureVersion": "v4", + "targetPrefix": "ResourceGroupsTaggingAPI_20170126", + "uid": "resourcegroupstaggingapi-2017-01-26" + }, + "operations": { + "GetResources": { + "input": { + "type": "structure", + "members": { + "PaginationToken": {}, + "TagFilters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "ResourcesPerPage": { + "type": "integer" + }, + "TagsPerPage": { + "type": "integer" + }, + "ResourceTypeFilters": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "PaginationToken": {}, + "ResourceTagMappingList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceARN": {}, + "Tags": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } + } + } + } + } + }, + "GetTagKeys": { + "input": { + "type": "structure", + "members": { + "PaginationToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "PaginationToken": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "GetTagValues": { + "input": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "PaginationToken": {}, + "Key": {} + } + }, + "output": { + "type": "structure", + "members": { + "PaginationToken": {}, + "TagValues": { + "type": "list", + "member": {} + } + } + } + }, + "TagResources": { + "input": { + "type": "structure", + "required": [ + "ResourceARNList", + "Tags" + ], + "members": { + "ResourceARNList": { + "shape": "Sp" + }, + "Tags": { + "type": "map", + "key": {}, + "value": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedResourcesMap": { + "shape": "Ss" + } + } + } + }, + "UntagResources": { + "input": { + "type": "structure", + "required": [ + "ResourceARNList", + "TagKeys" + ], + "members": { + "ResourceARNList": { + "shape": "Sp" + }, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedResourcesMap": { + "shape": "Ss" + } + } + } + } + }, + "shapes": { + "Sp": { + "type": "list", + "member": {} + }, + "Ss": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "StatusCode": { + "type": "integer" + }, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.paginators.json b/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.paginators.json new file mode 100644 index 0000000..7bff285 --- /dev/null +++ b/node_modules/aws-sdk/apis/resourcegroupstaggingapi-2017-01-26.paginators.json @@ -0,0 +1,20 @@ +{ + "pagination": { + "GetResources": { + "input_token": "PaginationToken", + "limit_key": "ResourcesPerPage", + "output_token": "PaginationToken", + "result_key": "ResourceTagMappingList" + }, + "GetTagKeys": { + "input_token": "PaginationToken", + "output_token": "PaginationToken", + "result_key": "TagKeys" + }, + "GetTagValues": { + "input_token": "PaginationToken", + "output_token": "PaginationToken", + "result_key": "TagValues" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/robomaker-2018-06-29.examples.json b/node_modules/aws-sdk/apis/robomaker-2018-06-29.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/robomaker-2018-06-29.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/robomaker-2018-06-29.min.json b/node_modules/aws-sdk/apis/robomaker-2018-06-29.min.json new file mode 100644 index 0000000..dbc4dd5 --- /dev/null +++ b/node_modules/aws-sdk/apis/robomaker-2018-06-29.min.json @@ -0,0 +1,1546 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-06-29", + "endpointPrefix": "robomaker", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "RoboMaker", + "serviceFullName": "AWS RoboMaker", + "serviceId": "RoboMaker", + "signatureVersion": "v4", + "signingName": "robomaker", + "uid": "robomaker-2018-06-29" + }, + "operations": { + "BatchDescribeSimulationJob": { + "http": { + "requestUri": "/batchDescribeSimulationJob" + }, + "input": { + "type": "structure", + "required": [ + "jobs" + ], + "members": { + "jobs": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "status": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "failureBehavior": {}, + "failureCode": {}, + "failureReason": {}, + "clientRequestToken": {}, + "outputLocation": { + "shape": "Se" + }, + "maxJobDurationInSeconds": { + "type": "long" + }, + "simulationTimeMillis": { + "type": "long" + }, + "iamRole": {}, + "robotApplications": { + "shape": "Sk" + }, + "simulationApplications": { + "shape": "Ss" + }, + "tags": { + "shape": "Su" + }, + "vpcConfig": { + "shape": "Sx" + } + } + } + }, + "unprocessedJobs": { + "shape": "S2" + } + } + } + }, + "CancelSimulationJob": { + "http": { + "requestUri": "/cancelSimulationJob" + }, + "input": { + "type": "structure", + "required": [ + "job" + ], + "members": { + "job": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateDeploymentJob": { + "http": { + "requestUri": "/createDeploymentJob" + }, + "input": { + "type": "structure", + "required": [ + "clientRequestToken", + "fleet", + "deploymentApplicationConfigs" + ], + "members": { + "deploymentConfig": { + "shape": "S14" + }, + "clientRequestToken": { + "idempotencyToken": true + }, + "fleet": {}, + "deploymentApplicationConfigs": { + "shape": "S16" + }, + "tags": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "fleet": {}, + "status": {}, + "deploymentApplicationConfigs": { + "shape": "S16" + }, + "failureReason": {}, + "failureCode": {}, + "createdAt": { + "type": "timestamp" + }, + "deploymentConfig": { + "shape": "S14" + }, + "tags": { + "shape": "Su" + } + } + } + }, + "CreateFleet": { + "http": { + "requestUri": "/createFleet" + }, + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "tags": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "createdAt": { + "type": "timestamp" + }, + "tags": { + "shape": "Su" + } + } + } + }, + "CreateRobot": { + "http": { + "requestUri": "/createRobot" + }, + "input": { + "type": "structure", + "required": [ + "name", + "architecture", + "greengrassGroupId" + ], + "members": { + "name": {}, + "architecture": {}, + "greengrassGroupId": {}, + "tags": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "createdAt": { + "type": "timestamp" + }, + "greengrassGroupId": {}, + "architecture": {}, + "tags": { + "shape": "Su" + } + } + } + }, + "CreateRobotApplication": { + "http": { + "requestUri": "/createRobotApplication" + }, + "input": { + "type": "structure", + "required": [ + "name", + "sources", + "robotSoftwareSuite" + ], + "members": { + "name": {}, + "sources": { + "shape": "S1m" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "tags": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "revisionId": {}, + "tags": { + "shape": "Su" + } + } + } + }, + "CreateRobotApplicationVersion": { + "http": { + "requestUri": "/createRobotApplicationVersion" + }, + "input": { + "type": "structure", + "required": [ + "application" + ], + "members": { + "application": {}, + "currentRevisionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "revisionId": {} + } + } + }, + "CreateSimulationApplication": { + "http": { + "requestUri": "/createSimulationApplication" + }, + "input": { + "type": "structure", + "required": [ + "name", + "sources", + "simulationSoftwareSuite", + "robotSoftwareSuite", + "renderingEngine" + ], + "members": { + "name": {}, + "sources": { + "shape": "S1m" + }, + "simulationSoftwareSuite": { + "shape": "S1z" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "renderingEngine": { + "shape": "S22" + }, + "tags": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "simulationSoftwareSuite": { + "shape": "S1z" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "renderingEngine": { + "shape": "S22" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "revisionId": {}, + "tags": { + "shape": "Su" + } + } + } + }, + "CreateSimulationApplicationVersion": { + "http": { + "requestUri": "/createSimulationApplicationVersion" + }, + "input": { + "type": "structure", + "required": [ + "application" + ], + "members": { + "application": {}, + "currentRevisionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "simulationSoftwareSuite": { + "shape": "S1z" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "renderingEngine": { + "shape": "S22" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "revisionId": {} + } + } + }, + "CreateSimulationJob": { + "http": { + "requestUri": "/createSimulationJob" + }, + "input": { + "type": "structure", + "required": [ + "maxJobDurationInSeconds", + "iamRole" + ], + "members": { + "clientRequestToken": { + "idempotencyToken": true + }, + "outputLocation": { + "shape": "Se" + }, + "maxJobDurationInSeconds": { + "type": "long" + }, + "iamRole": {}, + "failureBehavior": {}, + "robotApplications": { + "shape": "Sk" + }, + "simulationApplications": { + "shape": "Ss" + }, + "tags": { + "shape": "Su" + }, + "vpcConfig": { + "type": "structure", + "required": [ + "subnets" + ], + "members": { + "subnets": { + "shape": "Sy" + }, + "securityGroups": { + "shape": "Sz" + }, + "assignPublicIp": { + "type": "boolean" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "status": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "failureBehavior": {}, + "failureCode": {}, + "clientRequestToken": {}, + "outputLocation": { + "shape": "Se" + }, + "maxJobDurationInSeconds": { + "type": "long" + }, + "simulationTimeMillis": { + "type": "long" + }, + "iamRole": {}, + "robotApplications": { + "shape": "Sk" + }, + "simulationApplications": { + "shape": "Ss" + }, + "tags": { + "shape": "Su" + }, + "vpcConfig": { + "shape": "Sx" + } + } + } + }, + "DeleteFleet": { + "http": { + "requestUri": "/deleteFleet" + }, + "input": { + "type": "structure", + "required": [ + "fleet" + ], + "members": { + "fleet": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRobot": { + "http": { + "requestUri": "/deleteRobot" + }, + "input": { + "type": "structure", + "required": [ + "robot" + ], + "members": { + "robot": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRobotApplication": { + "http": { + "requestUri": "/deleteRobotApplication" + }, + "input": { + "type": "structure", + "required": [ + "application" + ], + "members": { + "application": {}, + "applicationVersion": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSimulationApplication": { + "http": { + "requestUri": "/deleteSimulationApplication" + }, + "input": { + "type": "structure", + "required": [ + "application" + ], + "members": { + "application": {}, + "applicationVersion": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeregisterRobot": { + "http": { + "requestUri": "/deregisterRobot" + }, + "input": { + "type": "structure", + "required": [ + "fleet", + "robot" + ], + "members": { + "fleet": {}, + "robot": {} + } + }, + "output": { + "type": "structure", + "members": { + "fleet": {}, + "robot": {} + } + } + }, + "DescribeDeploymentJob": { + "http": { + "requestUri": "/describeDeploymentJob" + }, + "input": { + "type": "structure", + "required": [ + "job" + ], + "members": { + "job": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "fleet": {}, + "status": {}, + "deploymentConfig": { + "shape": "S14" + }, + "deploymentApplicationConfigs": { + "shape": "S16" + }, + "failureReason": {}, + "failureCode": {}, + "createdAt": { + "type": "timestamp" + }, + "robotDeploymentSummary": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "deploymentStartTime": { + "type": "timestamp" + }, + "deploymentFinishTime": { + "type": "timestamp" + }, + "status": {}, + "progressDetail": { + "type": "structure", + "members": { + "currentProgress": {}, + "percentDone": { + "type": "float" + }, + "estimatedTimeRemainingSeconds": { + "type": "integer" + }, + "targetResource": {} + } + }, + "failureReason": {}, + "failureCode": {} + } + } + }, + "tags": { + "shape": "Su" + } + } + } + }, + "DescribeFleet": { + "http": { + "requestUri": "/describeFleet" + }, + "input": { + "type": "structure", + "required": [ + "fleet" + ], + "members": { + "fleet": {} + } + }, + "output": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "robots": { + "shape": "S2w" + }, + "createdAt": { + "type": "timestamp" + }, + "lastDeploymentStatus": {}, + "lastDeploymentJob": {}, + "lastDeploymentTime": { + "type": "timestamp" + }, + "tags": { + "shape": "Su" + } + } + } + }, + "DescribeRobot": { + "http": { + "requestUri": "/describeRobot" + }, + "input": { + "type": "structure", + "required": [ + "robot" + ], + "members": { + "robot": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "fleetArn": {}, + "status": {}, + "greengrassGroupId": {}, + "createdAt": { + "type": "timestamp" + }, + "architecture": {}, + "lastDeploymentJob": {}, + "lastDeploymentTime": { + "type": "timestamp" + }, + "tags": { + "shape": "Su" + } + } + } + }, + "DescribeRobotApplication": { + "http": { + "requestUri": "/describeRobotApplication" + }, + "input": { + "type": "structure", + "required": [ + "application" + ], + "members": { + "application": {}, + "applicationVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "revisionId": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "tags": { + "shape": "Su" + } + } + } + }, + "DescribeSimulationApplication": { + "http": { + "requestUri": "/describeSimulationApplication" + }, + "input": { + "type": "structure", + "required": [ + "application" + ], + "members": { + "application": {}, + "applicationVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "simulationSoftwareSuite": { + "shape": "S1z" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "renderingEngine": { + "shape": "S22" + }, + "revisionId": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "tags": { + "shape": "Su" + } + } + } + }, + "DescribeSimulationJob": { + "http": { + "requestUri": "/describeSimulationJob" + }, + "input": { + "type": "structure", + "required": [ + "job" + ], + "members": { + "job": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "status": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "failureBehavior": {}, + "failureCode": {}, + "failureReason": {}, + "clientRequestToken": {}, + "outputLocation": { + "shape": "Se" + }, + "maxJobDurationInSeconds": { + "type": "long" + }, + "simulationTimeMillis": { + "type": "long" + }, + "iamRole": {}, + "robotApplications": { + "shape": "Sk" + }, + "simulationApplications": { + "shape": "Ss" + }, + "tags": { + "shape": "Su" + }, + "vpcConfig": { + "shape": "Sx" + } + } + } + }, + "ListDeploymentJobs": { + "http": { + "requestUri": "/listDeploymentJobs" + }, + "input": { + "type": "structure", + "members": { + "filters": { + "shape": "S37" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "deploymentJobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "fleet": {}, + "status": {}, + "deploymentApplicationConfigs": { + "shape": "S16" + }, + "deploymentConfig": { + "shape": "S14" + }, + "failureReason": {}, + "failureCode": {}, + "createdAt": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListFleets": { + "http": { + "requestUri": "/listFleets" + }, + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filters": { + "shape": "S37" + } + } + }, + "output": { + "type": "structure", + "members": { + "fleetDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "createdAt": { + "type": "timestamp" + }, + "lastDeploymentStatus": {}, + "lastDeploymentJob": {}, + "lastDeploymentTime": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListRobotApplications": { + "http": { + "requestUri": "/listRobotApplications" + }, + "input": { + "type": "structure", + "members": { + "versionQualifier": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filters": { + "shape": "S37" + } + } + }, + "output": { + "type": "structure", + "members": { + "robotApplicationSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "version": {}, + "lastUpdatedAt": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListRobots": { + "http": { + "requestUri": "/listRobots" + }, + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filters": { + "shape": "S37" + } + } + }, + "output": { + "type": "structure", + "members": { + "robots": { + "shape": "S2w" + }, + "nextToken": {} + } + } + }, + "ListSimulationApplications": { + "http": { + "requestUri": "/listSimulationApplications" + }, + "input": { + "type": "structure", + "members": { + "versionQualifier": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filters": { + "shape": "S37" + } + } + }, + "output": { + "type": "structure", + "members": { + "simulationApplicationSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "arn": {}, + "version": {}, + "lastUpdatedAt": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListSimulationJobs": { + "http": { + "requestUri": "/listSimulationJobs" + }, + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filters": { + "shape": "S37" + } + } + }, + "output": { + "type": "structure", + "required": [ + "simulationJobSummaries" + ], + "members": { + "simulationJobSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "lastUpdatedAt": { + "type": "timestamp" + }, + "name": {}, + "status": {}, + "simulationApplicationNames": { + "type": "list", + "member": {} + }, + "robotApplicationNames": { + "type": "list", + "member": {} + } + } + } + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "Su" + } + } + } + }, + "RegisterRobot": { + "http": { + "requestUri": "/registerRobot" + }, + "input": { + "type": "structure", + "required": [ + "fleet", + "robot" + ], + "members": { + "fleet": {}, + "robot": {} + } + }, + "output": { + "type": "structure", + "members": { + "fleet": {}, + "robot": {} + } + } + }, + "RestartSimulationJob": { + "http": { + "requestUri": "/restartSimulationJob" + }, + "input": { + "type": "structure", + "required": [ + "job" + ], + "members": { + "job": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SyncDeploymentJob": { + "http": { + "requestUri": "/syncDeploymentJob" + }, + "input": { + "type": "structure", + "required": [ + "clientRequestToken", + "fleet" + ], + "members": { + "clientRequestToken": { + "idempotencyToken": true + }, + "fleet": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "fleet": {}, + "status": {}, + "deploymentConfig": { + "shape": "S14" + }, + "deploymentApplicationConfigs": { + "shape": "S16" + }, + "failureReason": {}, + "failureCode": {}, + "createdAt": { + "type": "timestamp" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "tags": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "tagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateRobotApplication": { + "http": { + "requestUri": "/updateRobotApplication" + }, + "input": { + "type": "structure", + "required": [ + "application", + "sources", + "robotSoftwareSuite" + ], + "members": { + "application": {}, + "sources": { + "shape": "S1m" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "currentRevisionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "revisionId": {} + } + } + }, + "UpdateSimulationApplication": { + "http": { + "requestUri": "/updateSimulationApplication" + }, + "input": { + "type": "structure", + "required": [ + "application", + "sources", + "simulationSoftwareSuite", + "robotSoftwareSuite", + "renderingEngine" + ], + "members": { + "application": {}, + "sources": { + "shape": "S1m" + }, + "simulationSoftwareSuite": { + "shape": "S1z" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "renderingEngine": { + "shape": "S22" + }, + "currentRevisionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "version": {}, + "sources": { + "shape": "S1s" + }, + "simulationSoftwareSuite": { + "shape": "S1z" + }, + "robotSoftwareSuite": { + "shape": "S1o" + }, + "renderingEngine": { + "shape": "S22" + }, + "lastUpdatedAt": { + "type": "timestamp" + }, + "revisionId": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "Se": { + "type": "structure", + "members": { + "s3Bucket": {}, + "s3Prefix": {} + } + }, + "Sk": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "application", + "launchConfig" + ], + "members": { + "application": {}, + "applicationVersion": {}, + "launchConfig": { + "shape": "Sn" + } + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "packageName", + "launchFile" + ], + "members": { + "packageName": {}, + "launchFile": {}, + "environmentVariables": { + "shape": "Sp" + } + } + }, + "Sp": { + "type": "map", + "key": {}, + "value": {} + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "application", + "launchConfig" + ], + "members": { + "application": {}, + "applicationVersion": {}, + "launchConfig": { + "shape": "Sn" + } + } + } + }, + "Su": { + "type": "map", + "key": {}, + "value": {} + }, + "Sx": { + "type": "structure", + "members": { + "subnets": { + "shape": "Sy" + }, + "securityGroups": { + "shape": "Sz" + }, + "vpcId": {}, + "assignPublicIp": { + "type": "boolean" + } + } + }, + "Sy": { + "type": "list", + "member": {} + }, + "Sz": { + "type": "list", + "member": {} + }, + "S14": { + "type": "structure", + "members": { + "concurrentDeploymentPercentage": { + "type": "integer" + }, + "failureThresholdPercentage": { + "type": "integer" + } + } + }, + "S16": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "application", + "applicationVersion", + "launchConfig" + ], + "members": { + "application": {}, + "applicationVersion": {}, + "launchConfig": { + "type": "structure", + "required": [ + "packageName", + "launchFile" + ], + "members": { + "packageName": {}, + "preLaunchFile": {}, + "launchFile": {}, + "postLaunchFile": {}, + "environmentVariables": { + "shape": "Sp" + } + } + } + } + } + }, + "S1m": { + "type": "list", + "member": { + "type": "structure", + "members": { + "s3Bucket": {}, + "s3Key": {}, + "architecture": {} + } + } + }, + "S1o": { + "type": "structure", + "members": { + "name": {}, + "version": {} + } + }, + "S1s": { + "type": "list", + "member": { + "type": "structure", + "members": { + "s3Bucket": {}, + "s3Key": {}, + "etag": {}, + "architecture": {} + } + } + }, + "S1z": { + "type": "structure", + "members": { + "name": {}, + "version": {} + } + }, + "S22": { + "type": "structure", + "members": { + "name": {}, + "version": {} + } + }, + "S2w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "fleetArn": {}, + "status": {}, + "greenGrassGroupId": {}, + "createdAt": { + "type": "timestamp" + }, + "architecture": {}, + "lastDeploymentJob": {}, + "lastDeploymentTime": { + "type": "timestamp" + } + } + } + }, + "S37": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "values": { + "type": "list", + "member": {} + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/robomaker-2018-06-29.paginators.json b/node_modules/aws-sdk/apis/robomaker-2018-06-29.paginators.json new file mode 100644 index 0000000..581613c --- /dev/null +++ b/node_modules/aws-sdk/apis/robomaker-2018-06-29.paginators.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListDeploymentJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListFleets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListRobotApplications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListRobots": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListSimulationApplications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListSimulationJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/route53-2013-04-01.examples.json b/node_modules/aws-sdk/apis/route53-2013-04-01.examples.json new file mode 100644 index 0000000..d757c2b --- /dev/null +++ b/node_modules/aws-sdk/apis/route53-2013-04-01.examples.json @@ -0,0 +1,762 @@ +{ + "version": "1.0", + "examples": { + "AssociateVPCWithHostedZone": [ + { + "input": { + "Comment": "", + "HostedZoneId": "Z3M3LMPEXAMPLE", + "VPC": { + "VPCId": "vpc-1a2b3c4d", + "VPCRegion": "us-east-2" + } + }, + "output": { + "ChangeInfo": { + "Comment": "", + "Id": "/change/C3HC6WDB2UANE2", + "Status": "INSYNC", + "SubmittedAt": "2017-01-31T01:36:41.958Z" + } + }, + "comments": { + "input": { + }, + "output": { + "Status": "Valid values are PENDING and INSYNC.", + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example associates the VPC with ID vpc-1a2b3c4d with the hosted zone with ID Z3M3LMPEXAMPLE.", + "id": "to-associate-a-vpc-with-a-hosted-zone-1484069228699", + "title": "To associate a VPC with a hosted zone" + } + ], + "ChangeResourceRecordSets": [ + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "Web server for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Web server for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates a resource record set that routes Internet traffic to a resource with an IP address of 192.0.2.44.", + "id": "to-create-update-or-delete-resource-record-sets-1484344703668", + "title": "To create a basic resource record set" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "Seattle data center", + "TTL": 60, + "Type": "A", + "Weight": 100 + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "Portland data center", + "TTL": 60, + "Type": "A", + "Weight": 200 + } + } + ], + "Comment": "Web servers for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Web servers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53. TTLs must be the same for all weighted resource record sets that have the same name and type.", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two weighted resource record sets. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", + "id": "to-create-weighted-resource-record-sets-1484348208522", + "title": "To create weighted resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "d123rk29d0stfj.cloudfront.net", + "EvaluateTargetHealth": false, + "HostedZoneId": "Z2FDTNDATAQYW2" + }, + "Name": "example.com", + "Type": "A" + } + } + ], + "Comment": "CloudFront distribution for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "CloudFront distribution for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates an alias resource record set that routes traffic to a CloudFront distribution.", + "id": "to-create-an-alias-resource-record-set-1484348404062", + "title": "To create an alias resource record set" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "Name": "example.com", + "SetIdentifier": "Ohio region", + "Type": "A", + "Weight": 100 + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1H1FL5HABSF5" + }, + "Name": "example.com", + "SetIdentifier": "Oregon region", + "Type": "A", + "Weight": 200 + } + } + ], + "Comment": "ELB load balancers for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "ELB load balancers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two weighted alias resource record sets that route traffic to ELB load balancers. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", + "id": "to-create-weighted-alias-resource-record-sets-1484349467416", + "title": "To create weighted alias resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba", + "Name": "example.com", + "Region": "us-east-2", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "Ohio region", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba", + "Name": "example.com", + "Region": "us-west-2", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "Oregon region", + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "EC2 instances for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "EC2 instances for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two latency resource record sets that route traffic to EC2 instances. Traffic for example.com is routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", + "id": "to-create-latency-resource-record-sets-1484350219917", + "title": "To create latency resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "Name": "example.com", + "Region": "us-east-2", + "SetIdentifier": "Ohio region", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1H1FL5HABSF5" + }, + "Name": "example.com", + "Region": "us-west-2", + "SetIdentifier": "Oregon region", + "Type": "A" + } + } + ], + "Comment": "ELB load balancers for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "ELB load balancers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates two latency alias resource record sets that route traffic for example.com to ELB load balancers. Requests are routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", + "id": "to-create-latency-alias-resource-record-sets-1484601774179", + "title": "To create latency alias resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Failover": "PRIMARY", + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "Ohio region", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Failover": "SECONDARY", + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba", + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "Oregon region", + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "Failover configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Failover configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates primary and secondary failover resource record sets that route traffic to EC2 instances. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", + "id": "to-create-failover-resource-record-sets-1484604541740", + "title": "To create failover resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "Failover": "PRIMARY", + "Name": "example.com", + "SetIdentifier": "Ohio region", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1H1FL5HABSF5" + }, + "Failover": "SECONDARY", + "Name": "example.com", + "SetIdentifier": "Oregon region", + "Type": "A" + } + } + ], + "Comment": "Failover alias configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Failover alias configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates primary and secondary failover alias resource record sets that route traffic to ELB load balancers. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", + "id": "to-create-failover-alias-resource-record-sets-1484607497724", + "title": "To create failover alias resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "ContinentCode": "NA" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "SetIdentifier": "North America", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "ContinentCode": "SA" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "SetIdentifier": "South America", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "ContinentCode": "EU" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.46" + } + ], + "SetIdentifier": "Europe", + "TTL": 60, + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "GeoLocation": { + "CountryCode": "*" + }, + "Name": "example.com", + "ResourceRecords": [ + { + "Value": "192.0.2.47" + } + ], + "SetIdentifier": "Other locations", + "TTL": 60, + "Type": "A" + } + } + ], + "Comment": "Geolocation configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Geolocation configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "TTL": "The amount of time in seconds that you want DNS resolvers to cache the values in this resource record set before submitting another request to Route 53", + "Value": "The value that is applicable to the value of Type. For example, if Type is A, Value is an IPv4 address" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates four geolocation resource record sets that use IPv4 addresses to route traffic to resources such as web servers running on EC2 instances. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", + "id": "to-create-geolocation-resource-record-sets-1484612462466", + "title": "To create geolocation resource record sets" + }, + { + "input": { + "ChangeBatch": { + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z3AADJGX6KTTL2" + }, + "GeoLocation": { + "ContinentCode": "NA" + }, + "Name": "example.com", + "SetIdentifier": "North America", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-234567890.sa-east-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z2P70J7HTTTPLU" + }, + "GeoLocation": { + "ContinentCode": "SA" + }, + "Name": "example.com", + "SetIdentifier": "South America", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-234567890.eu-central-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z215JYRZR1TBD5" + }, + "GeoLocation": { + "ContinentCode": "EU" + }, + "Name": "example.com", + "SetIdentifier": "Europe", + "Type": "A" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "AliasTarget": { + "DNSName": "example-com-234567890.ap-southeast-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true, + "HostedZoneId": "Z1LMS91P8CMLE5" + }, + "GeoLocation": { + "CountryCode": "*" + }, + "Name": "example.com", + "SetIdentifier": "Other locations", + "Type": "A" + } + } + ], + "Comment": "Geolocation alias configuration for example.com" + }, + "HostedZoneId": "Z3M3LMPEXAMPLE" + }, + "output": { + "ChangeInfo": { + "Comment": "Geolocation alias configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + }, + "comments": { + "input": { + "Action": "Valid values: CREATE, DELETE, UPSERT", + "DNSName": "The DNS name assigned to the resource", + "HostedZoneId": "Depends on the type of resource that you want to route traffic to", + "Type": "A or AAAA, depending on the type of resource that you want to route traffic to" + }, + "output": { + "SubmittedAt": "The date and time are in Coordinated Universal Time (UTC) and ISO 8601 format." + } + }, + "description": "The following example creates four geolocation alias resource record sets that route traffic to ELB load balancers. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", + "id": "to-create-geolocation-alias-resource-record-sets-1484612871203", + "title": "To create geolocation alias resource record sets" + } + ], + "ChangeTagsForResource": [ + { + "input": { + "AddTags": [ + { + "Key": "apex", + "Value": "3874" + }, + { + "Key": "acme", + "Value": "4938" + } + ], + "RemoveTagKeys": [ + "Nadir" + ], + "ResourceId": "Z3M3LMPEXAMPLE", + "ResourceType": "hostedzone" + }, + "output": { + }, + "comments": { + "input": { + "ResourceType": "Valid values are healthcheck and hostedzone." + }, + "output": { + } + }, + "description": "The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE.", + "id": "to-add-or-remove-tags-from-a-hosted-zone-or-health-check-1484084752409", + "title": "To add or remove tags from a hosted zone or health check" + } + ], + "GetHostedZone": [ + { + "input": { + "Id": "Z3M3LMPEXAMPLE" + }, + "output": { + "DelegationSet": { + "NameServers": [ + "ns-2048.awsdns-64.com", + "ns-2049.awsdns-65.net", + "ns-2050.awsdns-66.org", + "ns-2051.awsdns-67.co.uk" + ] + }, + "HostedZone": { + "CallerReference": "C741617D-04E4-F8DE-B9D7-0D150FC61C2E", + "Config": { + "PrivateZone": false + }, + "Id": "/hostedzone/Z3M3LMPEXAMPLE", + "Name": "myawsbucket.com.", + "ResourceRecordSetCount": 8 + } + }, + "comments": { + "input": { + }, + "output": { + "Id": "The ID of the hosted zone that you specified in the GetHostedZone request.", + "Name": "The name of the hosted zone.", + "NameServers": "The servers that you specify in your domain configuration.", + "PrivateZone": "True if this is a private hosted zone, false if it's a public hosted zone." + } + }, + "description": "The following example gets information about the Z3M3LMPEXAMPLE hosted zone.", + "id": "to-get-information-about-a-hosted-zone-1481752361124", + "title": "To get information about a hosted zone" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/route53-2013-04-01.min.json b/node_modules/aws-sdk/apis/route53-2013-04-01.min.json new file mode 100644 index 0000000..e631960 --- /dev/null +++ b/node_modules/aws-sdk/apis/route53-2013-04-01.min.json @@ -0,0 +1,2588 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-04-01", + "endpointPrefix": "route53", + "globalEndpoint": "route53.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "Route 53", + "serviceFullName": "Amazon Route 53", + "serviceId": "Route 53", + "signatureVersion": "v4", + "uid": "route53-2013-04-01" + }, + "operations": { + "AssociateVPCWithHostedZone": { + "http": { + "requestUri": "/2013-04-01/hostedzone/{Id}/associatevpc" + }, + "input": { + "locationName": "AssociateVPCWithHostedZoneRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HostedZoneId", + "VPC" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "VPC": { + "shape": "S3" + }, + "Comment": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "S8" + } + } + } + }, + "ChangeResourceRecordSets": { + "http": { + "requestUri": "/2013-04-01/hostedzone/{Id}/rrset/" + }, + "input": { + "locationName": "ChangeResourceRecordSetsRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HostedZoneId", + "ChangeBatch" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "ChangeBatch": { + "type": "structure", + "required": [ + "Changes" + ], + "members": { + "Comment": {}, + "Changes": { + "type": "list", + "member": { + "locationName": "Change", + "type": "structure", + "required": [ + "Action", + "ResourceRecordSet" + ], + "members": { + "Action": {}, + "ResourceRecordSet": { + "shape": "Sh" + } + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "S8" + } + } + } + }, + "ChangeTagsForResource": { + "http": { + "requestUri": "/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input": { + "locationName": "ChangeTagsForResourceRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "ResourceType", + "ResourceId" + ], + "members": { + "ResourceType": { + "location": "uri", + "locationName": "ResourceType" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "AddTags": { + "shape": "S15" + }, + "RemoveTagKeys": { + "type": "list", + "member": { + "locationName": "Key" + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateHealthCheck": { + "http": { + "requestUri": "/2013-04-01/healthcheck", + "responseCode": 201 + }, + "input": { + "locationName": "CreateHealthCheckRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "CallerReference", + "HealthCheckConfig" + ], + "members": { + "CallerReference": {}, + "HealthCheckConfig": { + "shape": "S1d" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HealthCheck", + "Location" + ], + "members": { + "HealthCheck": { + "shape": "S1z" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateHostedZone": { + "http": { + "requestUri": "/2013-04-01/hostedzone", + "responseCode": 201 + }, + "input": { + "locationName": "CreateHostedZoneRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "Name", + "CallerReference" + ], + "members": { + "Name": {}, + "VPC": { + "shape": "S3" + }, + "CallerReference": {}, + "HostedZoneConfig": { + "shape": "S2h" + }, + "DelegationSetId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ], + "members": { + "HostedZone": { + "shape": "S2k" + }, + "ChangeInfo": { + "shape": "S8" + }, + "DelegationSet": { + "shape": "S2m" + }, + "VPC": { + "shape": "S3" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateQueryLoggingConfig": { + "http": { + "requestUri": "/2013-04-01/queryloggingconfig", + "responseCode": 201 + }, + "input": { + "locationName": "CreateQueryLoggingConfigRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HostedZoneId", + "CloudWatchLogsLogGroupArn" + ], + "members": { + "HostedZoneId": {}, + "CloudWatchLogsLogGroupArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "QueryLoggingConfig", + "Location" + ], + "members": { + "QueryLoggingConfig": { + "shape": "S2r" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateReusableDelegationSet": { + "http": { + "requestUri": "/2013-04-01/delegationset", + "responseCode": 201 + }, + "input": { + "locationName": "CreateReusableDelegationSetRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "CallerReference" + ], + "members": { + "CallerReference": {}, + "HostedZoneId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "DelegationSet", + "Location" + ], + "members": { + "DelegationSet": { + "shape": "S2m" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateTrafficPolicy": { + "http": { + "requestUri": "/2013-04-01/trafficpolicy", + "responseCode": 201 + }, + "input": { + "locationName": "CreateTrafficPolicyRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "Name", + "Document" + ], + "members": { + "Name": {}, + "Document": {}, + "Comment": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicy", + "Location" + ], + "members": { + "TrafficPolicy": { + "shape": "S30" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateTrafficPolicyInstance": { + "http": { + "requestUri": "/2013-04-01/trafficpolicyinstance", + "responseCode": 201 + }, + "input": { + "locationName": "CreateTrafficPolicyInstanceRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HostedZoneId", + "Name", + "TTL", + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members": { + "HostedZoneId": {}, + "Name": {}, + "TTL": { + "type": "long" + }, + "TrafficPolicyId": {}, + "TrafficPolicyVersion": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicyInstance", + "Location" + ], + "members": { + "TrafficPolicyInstance": { + "shape": "S35" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateTrafficPolicyVersion": { + "http": { + "requestUri": "/2013-04-01/trafficpolicy/{Id}", + "responseCode": 201 + }, + "input": { + "locationName": "CreateTrafficPolicyVersionRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "Id", + "Document" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Document": {}, + "Comment": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicy", + "Location" + ], + "members": { + "TrafficPolicy": { + "shape": "S30" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateVPCAssociationAuthorization": { + "http": { + "requestUri": "/2013-04-01/hostedzone/{Id}/authorizevpcassociation" + }, + "input": { + "locationName": "CreateVPCAssociationAuthorizationRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HostedZoneId", + "VPC" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "VPC": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HostedZoneId", + "VPC" + ], + "members": { + "HostedZoneId": {}, + "VPC": { + "shape": "S3" + } + } + } + }, + "DeleteHealthCheck": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input": { + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteHostedZone": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/hostedzone/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "S8" + } + } + } + }, + "DeleteQueryLoggingConfig": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/queryloggingconfig/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteReusableDelegationSet": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/delegationset/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTrafficPolicy": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input": { + "type": "structure", + "required": [ + "Id", + "Version" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Version": { + "location": "uri", + "locationName": "Version", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTrafficPolicyInstance": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteVPCAssociationAuthorization": { + "http": { + "requestUri": "/2013-04-01/hostedzone/{Id}/deauthorizevpcassociation" + }, + "input": { + "locationName": "DeleteVPCAssociationAuthorizationRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HostedZoneId", + "VPC" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "VPC": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateVPCFromHostedZone": { + "http": { + "requestUri": "/2013-04-01/hostedzone/{Id}/disassociatevpc" + }, + "input": { + "locationName": "DisassociateVPCFromHostedZoneRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HostedZoneId", + "VPC" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "VPC": { + "shape": "S3" + }, + "Comment": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "S8" + } + } + } + }, + "GetAccountLimit": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/accountlimit/{Type}" + }, + "input": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": { + "location": "uri", + "locationName": "Type" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Limit", + "Count" + ], + "members": { + "Limit": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": { + "type": "long" + } + } + }, + "Count": { + "type": "long" + } + } + } + }, + "GetChange": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/change/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "S8" + } + } + } + }, + "GetCheckerIpRanges": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/checkeripranges" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "CheckerIpRanges" + ], + "members": { + "CheckerIpRanges": { + "type": "list", + "member": {} + } + } + } + }, + "GetGeoLocation": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/geolocation" + }, + "input": { + "type": "structure", + "members": { + "ContinentCode": { + "location": "querystring", + "locationName": "continentcode" + }, + "CountryCode": { + "location": "querystring", + "locationName": "countrycode" + }, + "SubdivisionCode": { + "location": "querystring", + "locationName": "subdivisioncode" + } + } + }, + "output": { + "type": "structure", + "required": [ + "GeoLocationDetails" + ], + "members": { + "GeoLocationDetails": { + "shape": "S47" + } + } + } + }, + "GetHealthCheck": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input": { + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HealthCheck" + ], + "members": { + "HealthCheck": { + "shape": "S1z" + } + } + } + }, + "GetHealthCheckCount": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheckcount" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "HealthCheckCount" + ], + "members": { + "HealthCheckCount": { + "type": "long" + } + } + } + }, + "GetHealthCheckLastFailureReason": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason" + }, + "input": { + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HealthCheckObservations" + ], + "members": { + "HealthCheckObservations": { + "shape": "S4i" + } + } + } + }, + "GetHealthCheckStatus": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}/status" + }, + "input": { + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HealthCheckObservations" + ], + "members": { + "HealthCheckObservations": { + "shape": "S4i" + } + } + } + }, + "GetHostedZone": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzone/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HostedZone" + ], + "members": { + "HostedZone": { + "shape": "S2k" + }, + "DelegationSet": { + "shape": "S2m" + }, + "VPCs": { + "shape": "S4q" + } + } + } + }, + "GetHostedZoneCount": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzonecount" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "HostedZoneCount" + ], + "members": { + "HostedZoneCount": { + "type": "long" + } + } + } + }, + "GetHostedZoneLimit": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzonelimit/{Id}/{Type}" + }, + "input": { + "type": "structure", + "required": [ + "Type", + "HostedZoneId" + ], + "members": { + "Type": { + "location": "uri", + "locationName": "Type" + }, + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Limit", + "Count" + ], + "members": { + "Limit": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": { + "type": "long" + } + } + }, + "Count": { + "type": "long" + } + } + } + }, + "GetQueryLoggingConfig": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/queryloggingconfig/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "QueryLoggingConfig" + ], + "members": { + "QueryLoggingConfig": { + "shape": "S2r" + } + } + } + }, + "GetReusableDelegationSet": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/delegationset/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DelegationSet" + ], + "members": { + "DelegationSet": { + "shape": "S2m" + } + } + } + }, + "GetReusableDelegationSetLimit": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/reusabledelegationsetlimit/{Id}/{Type}" + }, + "input": { + "type": "structure", + "required": [ + "Type", + "DelegationSetId" + ], + "members": { + "Type": { + "location": "uri", + "locationName": "Type" + }, + "DelegationSetId": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Limit", + "Count" + ], + "members": { + "Limit": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": { + "type": "long" + } + } + }, + "Count": { + "type": "long" + } + } + } + }, + "GetTrafficPolicy": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input": { + "type": "structure", + "required": [ + "Id", + "Version" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Version": { + "location": "uri", + "locationName": "Version", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicy" + ], + "members": { + "TrafficPolicy": { + "shape": "S30" + } + } + } + }, + "GetTrafficPolicyInstance": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicyInstance" + ], + "members": { + "TrafficPolicyInstance": { + "shape": "S35" + } + } + } + }, + "GetTrafficPolicyInstanceCount": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicyinstancecount" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicyInstanceCount" + ], + "members": { + "TrafficPolicyInstanceCount": { + "type": "integer" + } + } + } + }, + "ListGeoLocations": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/geolocations" + }, + "input": { + "type": "structure", + "members": { + "StartContinentCode": { + "location": "querystring", + "locationName": "startcontinentcode" + }, + "StartCountryCode": { + "location": "querystring", + "locationName": "startcountrycode" + }, + "StartSubdivisionCode": { + "location": "querystring", + "locationName": "startsubdivisioncode" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "GeoLocationDetailsList", + "IsTruncated", + "MaxItems" + ], + "members": { + "GeoLocationDetailsList": { + "type": "list", + "member": { + "shape": "S47", + "locationName": "GeoLocationDetails" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "NextContinentCode": {}, + "NextCountryCode": {}, + "NextSubdivisionCode": {}, + "MaxItems": {} + } + } + }, + "ListHealthChecks": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheck" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HealthChecks", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members": { + "HealthChecks": { + "type": "list", + "member": { + "shape": "S1z", + "locationName": "HealthCheck" + } + }, + "Marker": {}, + "IsTruncated": { + "type": "boolean" + }, + "NextMarker": {}, + "MaxItems": {} + } + } + }, + "ListHostedZones": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzone" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + }, + "DelegationSetId": { + "location": "querystring", + "locationName": "delegationsetid" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HostedZones", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members": { + "HostedZones": { + "shape": "S5o" + }, + "Marker": {}, + "IsTruncated": { + "type": "boolean" + }, + "NextMarker": {}, + "MaxItems": {} + } + } + }, + "ListHostedZonesByName": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzonesbyname" + }, + "input": { + "type": "structure", + "members": { + "DNSName": { + "location": "querystring", + "locationName": "dnsname" + }, + "HostedZoneId": { + "location": "querystring", + "locationName": "hostedzoneid" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HostedZones", + "IsTruncated", + "MaxItems" + ], + "members": { + "HostedZones": { + "shape": "S5o" + }, + "DNSName": {}, + "HostedZoneId": {}, + "IsTruncated": { + "type": "boolean" + }, + "NextDNSName": {}, + "NextHostedZoneId": {}, + "MaxItems": {} + } + } + }, + "ListQueryLoggingConfigs": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/queryloggingconfig" + }, + "input": { + "type": "structure", + "members": { + "HostedZoneId": { + "location": "querystring", + "locationName": "hostedzoneid" + }, + "NextToken": { + "location": "querystring", + "locationName": "nexttoken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxresults" + } + } + }, + "output": { + "type": "structure", + "required": [ + "QueryLoggingConfigs" + ], + "members": { + "QueryLoggingConfigs": { + "type": "list", + "member": { + "shape": "S2r", + "locationName": "QueryLoggingConfig" + } + }, + "NextToken": {} + } + } + }, + "ListResourceRecordSets": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzone/{Id}/rrset" + }, + "input": { + "type": "structure", + "required": [ + "HostedZoneId" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "StartRecordName": { + "location": "querystring", + "locationName": "name" + }, + "StartRecordType": { + "location": "querystring", + "locationName": "type" + }, + "StartRecordIdentifier": { + "location": "querystring", + "locationName": "identifier" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ResourceRecordSets", + "IsTruncated", + "MaxItems" + ], + "members": { + "ResourceRecordSets": { + "type": "list", + "member": { + "shape": "Sh", + "locationName": "ResourceRecordSet" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "NextRecordName": {}, + "NextRecordType": {}, + "NextRecordIdentifier": {}, + "MaxItems": {} + } + } + }, + "ListReusableDelegationSets": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/delegationset" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "DelegationSets", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members": { + "DelegationSets": { + "type": "list", + "member": { + "shape": "S2m", + "locationName": "DelegationSet" + } + }, + "Marker": {}, + "IsTruncated": { + "type": "boolean" + }, + "NextMarker": {}, + "MaxItems": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input": { + "type": "structure", + "required": [ + "ResourceType", + "ResourceId" + ], + "members": { + "ResourceType": { + "location": "uri", + "locationName": "ResourceType" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ResourceTagSet" + ], + "members": { + "ResourceTagSet": { + "shape": "S64" + } + } + } + }, + "ListTagsForResources": { + "http": { + "requestUri": "/2013-04-01/tags/{ResourceType}" + }, + "input": { + "locationName": "ListTagsForResourcesRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "ResourceType", + "ResourceIds" + ], + "members": { + "ResourceType": { + "location": "uri", + "locationName": "ResourceType" + }, + "ResourceIds": { + "type": "list", + "member": { + "locationName": "ResourceId" + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "ResourceTagSets" + ], + "members": { + "ResourceTagSets": { + "type": "list", + "member": { + "shape": "S64", + "locationName": "ResourceTagSet" + } + } + } + } + }, + "ListTrafficPolicies": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicies" + }, + "input": { + "type": "structure", + "members": { + "TrafficPolicyIdMarker": { + "location": "querystring", + "locationName": "trafficpolicyid" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicySummaries", + "IsTruncated", + "TrafficPolicyIdMarker", + "MaxItems" + ], + "members": { + "TrafficPolicySummaries": { + "type": "list", + "member": { + "locationName": "TrafficPolicySummary", + "type": "structure", + "required": [ + "Id", + "Name", + "Type", + "LatestVersion", + "TrafficPolicyCount" + ], + "members": { + "Id": {}, + "Name": {}, + "Type": {}, + "LatestVersion": { + "type": "integer" + }, + "TrafficPolicyCount": { + "type": "integer" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "TrafficPolicyIdMarker": {}, + "MaxItems": {} + } + } + }, + "ListTrafficPolicyInstances": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicyinstances" + }, + "input": { + "type": "structure", + "members": { + "HostedZoneIdMarker": { + "location": "querystring", + "locationName": "hostedzoneid" + }, + "TrafficPolicyInstanceNameMarker": { + "location": "querystring", + "locationName": "trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker": { + "location": "querystring", + "locationName": "trafficpolicyinstancetype" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members": { + "TrafficPolicyInstances": { + "shape": "S6f" + }, + "HostedZoneIdMarker": {}, + "TrafficPolicyInstanceNameMarker": {}, + "TrafficPolicyInstanceTypeMarker": {}, + "IsTruncated": { + "type": "boolean" + }, + "MaxItems": {} + } + } + }, + "ListTrafficPolicyInstancesByHostedZone": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicyinstances/hostedzone" + }, + "input": { + "type": "structure", + "required": [ + "HostedZoneId" + ], + "members": { + "HostedZoneId": { + "location": "querystring", + "locationName": "id" + }, + "TrafficPolicyInstanceNameMarker": { + "location": "querystring", + "locationName": "trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker": { + "location": "querystring", + "locationName": "trafficpolicyinstancetype" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members": { + "TrafficPolicyInstances": { + "shape": "S6f" + }, + "TrafficPolicyInstanceNameMarker": {}, + "TrafficPolicyInstanceTypeMarker": {}, + "IsTruncated": { + "type": "boolean" + }, + "MaxItems": {} + } + } + }, + "ListTrafficPolicyInstancesByPolicy": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicyinstances/trafficpolicy" + }, + "input": { + "type": "structure", + "required": [ + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members": { + "TrafficPolicyId": { + "location": "querystring", + "locationName": "id" + }, + "TrafficPolicyVersion": { + "location": "querystring", + "locationName": "version", + "type": "integer" + }, + "HostedZoneIdMarker": { + "location": "querystring", + "locationName": "hostedzoneid" + }, + "TrafficPolicyInstanceNameMarker": { + "location": "querystring", + "locationName": "trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker": { + "location": "querystring", + "locationName": "trafficpolicyinstancetype" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members": { + "TrafficPolicyInstances": { + "shape": "S6f" + }, + "HostedZoneIdMarker": {}, + "TrafficPolicyInstanceNameMarker": {}, + "TrafficPolicyInstanceTypeMarker": {}, + "IsTruncated": { + "type": "boolean" + }, + "MaxItems": {} + } + } + }, + "ListTrafficPolicyVersions": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/trafficpolicies/{Id}/versions" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "TrafficPolicyVersionMarker": { + "location": "querystring", + "locationName": "trafficpolicyversion" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicies", + "IsTruncated", + "TrafficPolicyVersionMarker", + "MaxItems" + ], + "members": { + "TrafficPolicies": { + "type": "list", + "member": { + "shape": "S30", + "locationName": "TrafficPolicy" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "TrafficPolicyVersionMarker": {}, + "MaxItems": {} + } + } + }, + "ListVPCAssociationAuthorizations": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzone/{Id}/authorizevpcassociation" + }, + "input": { + "type": "structure", + "required": [ + "HostedZoneId" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "NextToken": { + "location": "querystring", + "locationName": "nexttoken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxresults" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HostedZoneId", + "VPCs" + ], + "members": { + "HostedZoneId": {}, + "NextToken": {}, + "VPCs": { + "shape": "S4q" + } + } + } + }, + "TestDNSAnswer": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/testdnsanswer" + }, + "input": { + "type": "structure", + "required": [ + "HostedZoneId", + "RecordName", + "RecordType" + ], + "members": { + "HostedZoneId": { + "location": "querystring", + "locationName": "hostedzoneid" + }, + "RecordName": { + "location": "querystring", + "locationName": "recordname" + }, + "RecordType": { + "location": "querystring", + "locationName": "recordtype" + }, + "ResolverIP": { + "location": "querystring", + "locationName": "resolverip" + }, + "EDNS0ClientSubnetIP": { + "location": "querystring", + "locationName": "edns0clientsubnetip" + }, + "EDNS0ClientSubnetMask": { + "location": "querystring", + "locationName": "edns0clientsubnetmask" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Nameserver", + "RecordName", + "RecordType", + "RecordData", + "ResponseCode", + "Protocol" + ], + "members": { + "Nameserver": {}, + "RecordName": {}, + "RecordType": {}, + "RecordData": { + "type": "list", + "member": { + "locationName": "RecordDataEntry" + } + }, + "ResponseCode": {}, + "Protocol": {} + } + } + }, + "UpdateHealthCheck": { + "http": { + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input": { + "locationName": "UpdateHealthCheckRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + }, + "HealthCheckVersion": { + "type": "long" + }, + "IPAddress": {}, + "Port": { + "type": "integer" + }, + "ResourcePath": {}, + "FullyQualifiedDomainName": {}, + "SearchString": {}, + "FailureThreshold": { + "type": "integer" + }, + "Inverted": { + "type": "boolean" + }, + "Disabled": { + "type": "boolean" + }, + "HealthThreshold": { + "type": "integer" + }, + "ChildHealthChecks": { + "shape": "S1q" + }, + "EnableSNI": { + "type": "boolean" + }, + "Regions": { + "shape": "S1s" + }, + "AlarmIdentifier": { + "shape": "S1u" + }, + "InsufficientDataHealthStatus": {}, + "ResetElements": { + "type": "list", + "member": { + "locationName": "ResettableElementName" + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "HealthCheck" + ], + "members": { + "HealthCheck": { + "shape": "S1z" + } + } + } + }, + "UpdateHostedZoneComment": { + "http": { + "requestUri": "/2013-04-01/hostedzone/{Id}" + }, + "input": { + "locationName": "UpdateHostedZoneCommentRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Comment": {} + } + }, + "output": { + "type": "structure", + "required": [ + "HostedZone" + ], + "members": { + "HostedZone": { + "shape": "S2k" + } + } + } + }, + "UpdateTrafficPolicyComment": { + "http": { + "requestUri": "/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input": { + "locationName": "UpdateTrafficPolicyCommentRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "Id", + "Version", + "Comment" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Version": { + "location": "uri", + "locationName": "Version", + "type": "integer" + }, + "Comment": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicy" + ], + "members": { + "TrafficPolicy": { + "shape": "S30" + } + } + } + }, + "UpdateTrafficPolicyInstance": { + "http": { + "requestUri": "/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input": { + "locationName": "UpdateTrafficPolicyInstanceRequest", + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "type": "structure", + "required": [ + "Id", + "TTL", + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "TTL": { + "type": "long" + }, + "TrafficPolicyId": {}, + "TrafficPolicyVersion": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrafficPolicyInstance" + ], + "members": { + "TrafficPolicyInstance": { + "shape": "S35" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "members": { + "VPCRegion": {}, + "VPCId": {} + } + }, + "S8": { + "type": "structure", + "required": [ + "Id", + "Status", + "SubmittedAt" + ], + "members": { + "Id": {}, + "Status": {}, + "SubmittedAt": { + "type": "timestamp" + }, + "Comment": {} + } + }, + "Sh": { + "type": "structure", + "required": [ + "Name", + "Type" + ], + "members": { + "Name": {}, + "Type": {}, + "SetIdentifier": {}, + "Weight": { + "type": "long" + }, + "Region": {}, + "GeoLocation": { + "type": "structure", + "members": { + "ContinentCode": {}, + "CountryCode": {}, + "SubdivisionCode": {} + } + }, + "Failover": {}, + "MultiValueAnswer": { + "type": "boolean" + }, + "TTL": { + "type": "long" + }, + "ResourceRecords": { + "type": "list", + "member": { + "locationName": "ResourceRecord", + "type": "structure", + "required": [ + "Value" + ], + "members": { + "Value": {} + } + } + }, + "AliasTarget": { + "type": "structure", + "required": [ + "HostedZoneId", + "DNSName", + "EvaluateTargetHealth" + ], + "members": { + "HostedZoneId": {}, + "DNSName": {}, + "EvaluateTargetHealth": { + "type": "boolean" + } + } + }, + "HealthCheckId": {}, + "TrafficPolicyInstanceId": {} + } + }, + "S15": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S1d": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "IPAddress": {}, + "Port": { + "type": "integer" + }, + "Type": {}, + "ResourcePath": {}, + "FullyQualifiedDomainName": {}, + "SearchString": {}, + "RequestInterval": { + "type": "integer" + }, + "FailureThreshold": { + "type": "integer" + }, + "MeasureLatency": { + "type": "boolean" + }, + "Inverted": { + "type": "boolean" + }, + "Disabled": { + "type": "boolean" + }, + "HealthThreshold": { + "type": "integer" + }, + "ChildHealthChecks": { + "shape": "S1q" + }, + "EnableSNI": { + "type": "boolean" + }, + "Regions": { + "shape": "S1s" + }, + "AlarmIdentifier": { + "shape": "S1u" + }, + "InsufficientDataHealthStatus": {} + } + }, + "S1q": { + "type": "list", + "member": { + "locationName": "ChildHealthCheck" + } + }, + "S1s": { + "type": "list", + "member": { + "locationName": "Region" + } + }, + "S1u": { + "type": "structure", + "required": [ + "Region", + "Name" + ], + "members": { + "Region": {}, + "Name": {} + } + }, + "S1z": { + "type": "structure", + "required": [ + "Id", + "CallerReference", + "HealthCheckConfig", + "HealthCheckVersion" + ], + "members": { + "Id": {}, + "CallerReference": {}, + "LinkedService": { + "shape": "S20" + }, + "HealthCheckConfig": { + "shape": "S1d" + }, + "HealthCheckVersion": { + "type": "long" + }, + "CloudWatchAlarmConfiguration": { + "type": "structure", + "required": [ + "EvaluationPeriods", + "Threshold", + "ComparisonOperator", + "Period", + "MetricName", + "Namespace", + "Statistic" + ], + "members": { + "EvaluationPeriods": { + "type": "integer" + }, + "Threshold": { + "type": "double" + }, + "ComparisonOperator": {}, + "Period": { + "type": "integer" + }, + "MetricName": {}, + "Namespace": {}, + "Statistic": {}, + "Dimensions": { + "type": "list", + "member": { + "locationName": "Dimension", + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + } + } + } + } + }, + "S20": { + "type": "structure", + "members": { + "ServicePrincipal": {}, + "Description": {} + } + }, + "S2h": { + "type": "structure", + "members": { + "Comment": {}, + "PrivateZone": { + "type": "boolean" + } + } + }, + "S2k": { + "type": "structure", + "required": [ + "Id", + "Name", + "CallerReference" + ], + "members": { + "Id": {}, + "Name": {}, + "CallerReference": {}, + "Config": { + "shape": "S2h" + }, + "ResourceRecordSetCount": { + "type": "long" + }, + "LinkedService": { + "shape": "S20" + } + } + }, + "S2m": { + "type": "structure", + "required": [ + "NameServers" + ], + "members": { + "Id": {}, + "CallerReference": {}, + "NameServers": { + "type": "list", + "member": { + "locationName": "NameServer" + } + } + } + }, + "S2r": { + "type": "structure", + "required": [ + "Id", + "HostedZoneId", + "CloudWatchLogsLogGroupArn" + ], + "members": { + "Id": {}, + "HostedZoneId": {}, + "CloudWatchLogsLogGroupArn": {} + } + }, + "S30": { + "type": "structure", + "required": [ + "Id", + "Version", + "Name", + "Type", + "Document" + ], + "members": { + "Id": {}, + "Version": { + "type": "integer" + }, + "Name": {}, + "Type": {}, + "Document": {}, + "Comment": {} + } + }, + "S35": { + "type": "structure", + "required": [ + "Id", + "HostedZoneId", + "Name", + "TTL", + "State", + "Message", + "TrafficPolicyId", + "TrafficPolicyVersion", + "TrafficPolicyType" + ], + "members": { + "Id": {}, + "HostedZoneId": {}, + "Name": {}, + "TTL": { + "type": "long" + }, + "State": {}, + "Message": {}, + "TrafficPolicyId": {}, + "TrafficPolicyVersion": { + "type": "integer" + }, + "TrafficPolicyType": {} + } + }, + "S47": { + "type": "structure", + "members": { + "ContinentCode": {}, + "ContinentName": {}, + "CountryCode": {}, + "CountryName": {}, + "SubdivisionCode": {}, + "SubdivisionName": {} + } + }, + "S4i": { + "type": "list", + "member": { + "locationName": "HealthCheckObservation", + "type": "structure", + "members": { + "Region": {}, + "IPAddress": {}, + "StatusReport": { + "type": "structure", + "members": { + "Status": {}, + "CheckedTime": { + "type": "timestamp" + } + } + } + } + } + }, + "S4q": { + "type": "list", + "member": { + "shape": "S3", + "locationName": "VPC" + } + }, + "S5o": { + "type": "list", + "member": { + "shape": "S2k", + "locationName": "HostedZone" + } + }, + "S64": { + "type": "structure", + "members": { + "ResourceType": {}, + "ResourceId": {}, + "Tags": { + "shape": "S15" + } + } + }, + "S6f": { + "type": "list", + "member": { + "shape": "S35", + "locationName": "TrafficPolicyInstance" + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/route53-2013-04-01.paginators.json b/node_modules/aws-sdk/apis/route53-2013-04-01.paginators.json new file mode 100644 index 0000000..5a7cea3 --- /dev/null +++ b/node_modules/aws-sdk/apis/route53-2013-04-01.paginators.json @@ -0,0 +1,33 @@ +{ + "pagination": { + "ListHealthChecks": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "NextMarker", + "result_key": "HealthChecks" + }, + "ListHostedZones": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "NextMarker", + "result_key": "HostedZones" + }, + "ListResourceRecordSets": { + "input_token": [ + "StartRecordName", + "StartRecordType", + "StartRecordIdentifier" + ], + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": [ + "NextRecordName", + "NextRecordType", + "NextRecordIdentifier" + ], + "result_key": "ResourceRecordSets" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/route53-2013-04-01.waiters2.json b/node_modules/aws-sdk/apis/route53-2013-04-01.waiters2.json new file mode 100644 index 0000000..94aad39 --- /dev/null +++ b/node_modules/aws-sdk/apis/route53-2013-04-01.waiters2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "ResourceRecordSetsChanged": { + "delay": 30, + "maxAttempts": 60, + "operation": "GetChange", + "acceptors": [ + { + "matcher": "path", + "expected": "INSYNC", + "argument": "ChangeInfo.Status", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/route53domains-2014-05-15.examples.json b/node_modules/aws-sdk/apis/route53domains-2014-05-15.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/route53domains-2014-05-15.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/route53domains-2014-05-15.min.json b/node_modules/aws-sdk/apis/route53domains-2014-05-15.min.json new file mode 100644 index 0000000..b6c89e1 --- /dev/null +++ b/node_modules/aws-sdk/apis/route53domains-2014-05-15.min.json @@ -0,0 +1,782 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-05-15", + "endpointPrefix": "route53domains", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Route 53 Domains", + "serviceId": "Route 53 Domains", + "signatureVersion": "v4", + "targetPrefix": "Route53Domains_v20140515", + "uid": "route53domains-2014-05-15" + }, + "operations": { + "CheckDomainAvailability": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "IdnLangCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Availability" + ], + "members": { + "Availability": {} + } + } + }, + "CheckDomainTransferability": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AuthCode": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Transferability" + ], + "members": { + "Transferability": { + "type": "structure", + "members": { + "Transferable": {} + } + } + } + } + }, + "DeleteTagsForDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "TagsToDelete" + ], + "members": { + "DomainName": {}, + "TagsToDelete": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisableDomainAutoRenew": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisableDomainTransferLock": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "EnableDomainAutoRenew": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "EnableDomainTransferLock": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "GetContactReachabilityStatus": { + "input": { + "type": "structure", + "members": { + "domainName": {} + } + }, + "output": { + "type": "structure", + "members": { + "domainName": {}, + "status": {} + } + } + }, + "GetDomainDetail": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "DomainName", + "Nameservers", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members": { + "DomainName": {}, + "Nameservers": { + "shape": "St" + }, + "AutoRenew": { + "type": "boolean" + }, + "AdminContact": { + "shape": "Sz" + }, + "RegistrantContact": { + "shape": "Sz" + }, + "TechContact": { + "shape": "Sz" + }, + "AdminPrivacy": { + "type": "boolean" + }, + "RegistrantPrivacy": { + "type": "boolean" + }, + "TechPrivacy": { + "type": "boolean" + }, + "RegistrarName": {}, + "WhoIsServer": {}, + "RegistrarUrl": {}, + "AbuseContactEmail": {}, + "AbuseContactPhone": {}, + "RegistryDomainId": {}, + "CreationDate": { + "type": "timestamp" + }, + "UpdatedDate": { + "type": "timestamp" + }, + "ExpirationDate": { + "type": "timestamp" + }, + "Reseller": {}, + "DnsSec": {}, + "StatusList": { + "type": "list", + "member": {} + } + } + } + }, + "GetDomainSuggestions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "SuggestionCount", + "OnlyAvailable" + ], + "members": { + "DomainName": {}, + "SuggestionCount": { + "type": "integer" + }, + "OnlyAvailable": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "SuggestionsList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DomainName": {}, + "Availability": {} + } + } + } + } + } + }, + "GetOperationDetail": { + "input": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {}, + "Status": {}, + "Message": {}, + "DomainName": {}, + "Type": {}, + "SubmittedDate": { + "type": "timestamp" + } + } + } + }, + "ListDomains": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Domains" + ], + "members": { + "Domains": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AutoRenew": { + "type": "boolean" + }, + "TransferLock": { + "type": "boolean" + }, + "Expiry": { + "type": "timestamp" + } + } + } + }, + "NextPageMarker": {} + } + } + }, + "ListOperations": { + "input": { + "type": "structure", + "members": { + "SubmittedSince": { + "type": "timestamp" + }, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Operations" + ], + "members": { + "Operations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "OperationId", + "Status", + "Type", + "SubmittedDate" + ], + "members": { + "OperationId": {}, + "Status": {}, + "Type": {}, + "SubmittedDate": { + "type": "timestamp" + } + } + } + }, + "NextPageMarker": {} + } + } + }, + "ListTagsForDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TagList" + ], + "members": { + "TagList": { + "shape": "S29" + } + } + } + }, + "RegisterDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members": { + "DomainName": {}, + "IdnLangCode": {}, + "DurationInYears": { + "type": "integer" + }, + "AutoRenew": { + "type": "boolean" + }, + "AdminContact": { + "shape": "Sz" + }, + "RegistrantContact": { + "shape": "Sz" + }, + "TechContact": { + "shape": "Sz" + }, + "PrivacyProtectAdminContact": { + "type": "boolean" + }, + "PrivacyProtectRegistrantContact": { + "type": "boolean" + }, + "PrivacyProtectTechContact": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "RenewDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "CurrentExpiryYear" + ], + "members": { + "DomainName": {}, + "DurationInYears": { + "type": "integer" + }, + "CurrentExpiryYear": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "ResendContactReachabilityEmail": { + "input": { + "type": "structure", + "members": { + "domainName": {} + } + }, + "output": { + "type": "structure", + "members": { + "domainName": {}, + "emailAddress": {}, + "isAlreadyVerified": { + "type": "boolean" + } + } + } + }, + "RetrieveDomainAuthCode": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "AuthCode" + ], + "members": { + "AuthCode": { + "shape": "S7" + } + } + } + }, + "TransferDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members": { + "DomainName": {}, + "IdnLangCode": {}, + "DurationInYears": { + "type": "integer" + }, + "Nameservers": { + "shape": "St" + }, + "AuthCode": { + "shape": "S7" + }, + "AutoRenew": { + "type": "boolean" + }, + "AdminContact": { + "shape": "Sz" + }, + "RegistrantContact": { + "shape": "Sz" + }, + "TechContact": { + "shape": "Sz" + }, + "PrivacyProtectAdminContact": { + "type": "boolean" + }, + "PrivacyProtectRegistrantContact": { + "type": "boolean" + }, + "PrivacyProtectTechContact": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "UpdateDomainContact": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AdminContact": { + "shape": "Sz" + }, + "RegistrantContact": { + "shape": "Sz" + }, + "TechContact": { + "shape": "Sz" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "UpdateDomainContactPrivacy": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AdminPrivacy": { + "type": "boolean" + }, + "RegistrantPrivacy": { + "type": "boolean" + }, + "TechPrivacy": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "UpdateDomainNameservers": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Nameservers" + ], + "members": { + "DomainName": {}, + "FIAuthKey": { + "deprecated": true + }, + "Nameservers": { + "shape": "St" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "UpdateTagsForDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "TagsToUpdate": { + "shape": "S29" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ViewBilling": { + "input": { + "type": "structure", + "members": { + "Start": { + "type": "timestamp" + }, + "End": { + "type": "timestamp" + }, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextPageMarker": {}, + "BillingRecords": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DomainName": {}, + "Operation": {}, + "InvoiceId": {}, + "BillDate": { + "type": "timestamp" + }, + "Price": { + "type": "double" + } + } + } + } + } + } + } + }, + "shapes": { + "S7": { + "type": "string", + "sensitive": true + }, + "St": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "GlueIps": { + "type": "list", + "member": {} + } + } + } + }, + "Sz": { + "type": "structure", + "members": { + "FirstName": {}, + "LastName": {}, + "ContactType": {}, + "OrganizationName": {}, + "AddressLine1": {}, + "AddressLine2": {}, + "City": {}, + "State": {}, + "CountryCode": {}, + "ZipCode": {}, + "PhoneNumber": {}, + "Email": {}, + "Fax": {}, + "ExtraParams": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + } + }, + "sensitive": true + }, + "S29": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/route53domains-2014-05-15.paginators.json b/node_modules/aws-sdk/apis/route53domains-2014-05-15.paginators.json new file mode 100644 index 0000000..eaeaed7 --- /dev/null +++ b/node_modules/aws-sdk/apis/route53domains-2014-05-15.paginators.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListDomains": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextPageMarker", + "result_key": "Domains" + }, + "ListOperations": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextPageMarker", + "result_key": "Operations" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/route53resolver-2018-04-01.examples.json b/node_modules/aws-sdk/apis/route53resolver-2018-04-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/route53resolver-2018-04-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/route53resolver-2018-04-01.min.json b/node_modules/aws-sdk/apis/route53resolver-2018-04-01.min.json new file mode 100644 index 0000000..8acdd5a --- /dev/null +++ b/node_modules/aws-sdk/apis/route53resolver-2018-04-01.min.json @@ -0,0 +1,655 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-04-01", + "endpointPrefix": "route53resolver", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Route53Resolver", + "serviceFullName": "Amazon Route 53 Resolver", + "serviceId": "Route53Resolver", + "signatureVersion": "v4", + "targetPrefix": "Route53Resolver", + "uid": "route53resolver-2018-04-01" + }, + "operations": { + "AssociateResolverEndpointIpAddress": { + "input": { + "type": "structure", + "required": [ + "ResolverEndpointId", + "IpAddress" + ], + "members": { + "ResolverEndpointId": {}, + "IpAddress": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResolverEndpoint": { + "shape": "S7" + } + } + } + }, + "AssociateResolverRule": { + "input": { + "type": "structure", + "required": [ + "ResolverRuleId", + "VPCId" + ], + "members": { + "ResolverRuleId": {}, + "Name": {}, + "VPCId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRuleAssociation": { + "shape": "Sj" + } + } + } + }, + "CreateResolverEndpoint": { + "input": { + "type": "structure", + "required": [ + "CreatorRequestId", + "SecurityGroupIds", + "Direction", + "IpAddresses" + ], + "members": { + "CreatorRequestId": {}, + "Name": {}, + "SecurityGroupIds": { + "shape": "Sb" + }, + "Direction": {}, + "IpAddresses": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "SubnetId": {}, + "Ip": {} + } + } + }, + "Tags": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResolverEndpoint": { + "shape": "S7" + } + } + } + }, + "CreateResolverRule": { + "input": { + "type": "structure", + "required": [ + "CreatorRequestId", + "RuleType", + "DomainName" + ], + "members": { + "CreatorRequestId": {}, + "Name": {}, + "RuleType": {}, + "DomainName": {}, + "TargetIps": { + "shape": "Sw" + }, + "ResolverEndpointId": {}, + "Tags": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRule": { + "shape": "S10" + } + } + } + }, + "DeleteResolverEndpoint": { + "input": { + "type": "structure", + "required": [ + "ResolverEndpointId" + ], + "members": { + "ResolverEndpointId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverEndpoint": { + "shape": "S7" + } + } + } + }, + "DeleteResolverRule": { + "input": { + "type": "structure", + "required": [ + "ResolverRuleId" + ], + "members": { + "ResolverRuleId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRule": { + "shape": "S10" + } + } + } + }, + "DisassociateResolverEndpointIpAddress": { + "input": { + "type": "structure", + "required": [ + "ResolverEndpointId", + "IpAddress" + ], + "members": { + "ResolverEndpointId": {}, + "IpAddress": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResolverEndpoint": { + "shape": "S7" + } + } + } + }, + "DisassociateResolverRule": { + "input": { + "type": "structure", + "required": [ + "VPCId", + "ResolverRuleId" + ], + "members": { + "VPCId": {}, + "ResolverRuleId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRuleAssociation": { + "shape": "Sj" + } + } + } + }, + "GetResolverEndpoint": { + "input": { + "type": "structure", + "required": [ + "ResolverEndpointId" + ], + "members": { + "ResolverEndpointId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverEndpoint": { + "shape": "S7" + } + } + } + }, + "GetResolverRule": { + "input": { + "type": "structure", + "required": [ + "ResolverRuleId" + ], + "members": { + "ResolverRuleId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRule": { + "shape": "S10" + } + } + } + }, + "GetResolverRuleAssociation": { + "input": { + "type": "structure", + "required": [ + "ResolverRuleAssociationId" + ], + "members": { + "ResolverRuleAssociationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRuleAssociation": { + "shape": "Sj" + } + } + } + }, + "GetResolverRulePolicy": { + "input": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRulePolicy": {} + } + } + }, + "ListResolverEndpointIpAddresses": { + "input": { + "type": "structure", + "required": [ + "ResolverEndpointId" + ], + "members": { + "ResolverEndpointId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "IpAddresses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IpId": {}, + "SubnetId": {}, + "Ip": {}, + "Status": {}, + "StatusMessage": {}, + "CreationTime": {}, + "ModificationTime": {} + } + } + } + } + } + }, + "ListResolverEndpoints": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "S1t" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ResolverEndpoints": { + "type": "list", + "member": { + "shape": "S7" + } + } + } + } + }, + "ListResolverRuleAssociations": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "S1t" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ResolverRuleAssociations": { + "type": "list", + "member": { + "shape": "Sj" + } + } + } + } + }, + "ListResolverRules": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "S1t" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ResolverRules": { + "type": "list", + "member": { + "shape": "S10" + } + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "So" + }, + "NextToken": {} + } + } + }, + "PutResolverRulePolicy": { + "input": { + "type": "structure", + "required": [ + "Arn", + "ResolverRulePolicy" + ], + "members": { + "Arn": {}, + "ResolverRulePolicy": {} + } + }, + "output": { + "type": "structure", + "members": { + "ReturnValue": { + "type": "boolean" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateResolverEndpoint": { + "input": { + "type": "structure", + "required": [ + "ResolverEndpointId" + ], + "members": { + "ResolverEndpointId": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResolverEndpoint": { + "shape": "S7" + } + } + } + }, + "UpdateResolverRule": { + "input": { + "type": "structure", + "required": [ + "ResolverRuleId", + "Config" + ], + "members": { + "ResolverRuleId": {}, + "Config": { + "type": "structure", + "members": { + "Name": {}, + "TargetIps": { + "shape": "Sw" + }, + "ResolverEndpointId": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ResolverRule": { + "shape": "S10" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "members": { + "IpId": {}, + "SubnetId": {}, + "Ip": {} + } + }, + "S7": { + "type": "structure", + "members": { + "Id": {}, + "CreatorRequestId": {}, + "Arn": {}, + "Name": {}, + "SecurityGroupIds": { + "shape": "Sb" + }, + "Direction": {}, + "IpAddressCount": { + "type": "integer" + }, + "HostVPCId": {}, + "Status": {}, + "StatusMessage": {}, + "CreationTime": {}, + "ModificationTime": {} + } + }, + "Sb": { + "type": "list", + "member": {} + }, + "Sj": { + "type": "structure", + "members": { + "Id": {}, + "ResolverRuleId": {}, + "Name": {}, + "VPCId": {}, + "Status": {}, + "StatusMessage": {} + } + }, + "So": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sw": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Ip" + ], + "members": { + "Ip": {}, + "Port": { + "type": "integer" + } + } + } + }, + "S10": { + "type": "structure", + "members": { + "Id": {}, + "CreatorRequestId": {}, + "Arn": {}, + "DomainName": {}, + "Status": {}, + "StatusMessage": {}, + "RuleType": {}, + "Name": {}, + "TargetIps": { + "shape": "Sw" + }, + "ResolverEndpointId": {}, + "OwnerId": {}, + "ShareStatus": {} + } + }, + "S1t": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/route53resolver-2018-04-01.paginators.json b/node_modules/aws-sdk/apis/route53resolver-2018-04-01.paginators.json new file mode 100644 index 0000000..c6fb889 --- /dev/null +++ b/node_modules/aws-sdk/apis/route53resolver-2018-04-01.paginators.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "ListResolverEndpointIpAddresses": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListResolverEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListResolverRuleAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListResolverRules": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.examples.json b/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.min.json b/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.min.json new file mode 100644 index 0000000..05b89de --- /dev/null +++ b/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.min.json @@ -0,0 +1,226 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-28", + "endpointPrefix": "runtime.lex", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon Lex Runtime Service", + "serviceId": "Lex Runtime Service", + "signatureVersion": "v4", + "signingName": "lex", + "uid": "runtime.lex-2016-11-28" + }, + "operations": { + "PostContent": { + "http": { + "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/content" + }, + "input": { + "type": "structure", + "required": [ + "botName", + "botAlias", + "userId", + "contentType", + "inputStream" + ], + "members": { + "botName": { + "location": "uri", + "locationName": "botName" + }, + "botAlias": { + "location": "uri", + "locationName": "botAlias" + }, + "userId": { + "location": "uri", + "locationName": "userId" + }, + "sessionAttributes": { + "shape": "S5", + "jsonvalue": true, + "location": "header", + "locationName": "x-amz-lex-session-attributes" + }, + "requestAttributes": { + "shape": "S5", + "jsonvalue": true, + "location": "header", + "locationName": "x-amz-lex-request-attributes" + }, + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "accept": { + "location": "header", + "locationName": "Accept" + }, + "inputStream": { + "shape": "S8" + } + }, + "payload": "inputStream" + }, + "output": { + "type": "structure", + "members": { + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "intentName": { + "location": "header", + "locationName": "x-amz-lex-intent-name" + }, + "slots": { + "jsonvalue": true, + "location": "header", + "locationName": "x-amz-lex-slots" + }, + "sessionAttributes": { + "jsonvalue": true, + "location": "header", + "locationName": "x-amz-lex-session-attributes" + }, + "message": { + "shape": "Sc", + "location": "header", + "locationName": "x-amz-lex-message" + }, + "messageFormat": { + "location": "header", + "locationName": "x-amz-lex-message-format" + }, + "dialogState": { + "location": "header", + "locationName": "x-amz-lex-dialog-state" + }, + "slotToElicit": { + "location": "header", + "locationName": "x-amz-lex-slot-to-elicit" + }, + "inputTranscript": { + "location": "header", + "locationName": "x-amz-lex-input-transcript" + }, + "audioStream": { + "shape": "S8" + } + }, + "payload": "audioStream" + }, + "authtype": "v4-unsigned-body" + }, + "PostText": { + "http": { + "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/text" + }, + "input": { + "type": "structure", + "required": [ + "botName", + "botAlias", + "userId", + "inputText" + ], + "members": { + "botName": { + "location": "uri", + "locationName": "botName" + }, + "botAlias": { + "location": "uri", + "locationName": "botAlias" + }, + "userId": { + "location": "uri", + "locationName": "userId" + }, + "sessionAttributes": { + "shape": "Sg" + }, + "requestAttributes": { + "shape": "Sg" + }, + "inputText": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "intentName": {}, + "slots": { + "shape": "Sg" + }, + "sessionAttributes": { + "shape": "Sg" + }, + "message": { + "shape": "Sc" + }, + "messageFormat": {}, + "dialogState": {}, + "slotToElicit": {}, + "responseCard": { + "type": "structure", + "members": { + "version": {}, + "contentType": {}, + "genericAttachments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "title": {}, + "subTitle": {}, + "attachmentLinkUrl": {}, + "imageUrl": {}, + "buttons": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "text", + "value" + ], + "members": { + "text": {}, + "value": {} + } + } + } + } + } + } + } + } + } + } + } + }, + "shapes": { + "S5": { + "type": "string", + "sensitive": true + }, + "S8": { + "type": "blob", + "streaming": true + }, + "Sc": { + "type": "string", + "sensitive": true + }, + "Sg": { + "type": "map", + "key": {}, + "value": {}, + "sensitive": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.paginators.json b/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/runtime.lex-2016-11-28.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.examples.json b/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.min.json b/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.min.json new file mode 100644 index 0000000..ce3ac43 --- /dev/null +++ b/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.min.json @@ -0,0 +1,86 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-05-13", + "endpointPrefix": "runtime.sagemaker", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon SageMaker Runtime", + "serviceId": "SageMaker Runtime", + "signatureVersion": "v4", + "signingName": "sagemaker", + "uid": "runtime.sagemaker-2017-05-13" + }, + "operations": { + "InvokeEndpoint": { + "http": { + "requestUri": "/endpoints/{EndpointName}/invocations" + }, + "input": { + "type": "structure", + "required": [ + "EndpointName", + "Body" + ], + "members": { + "EndpointName": { + "location": "uri", + "locationName": "EndpointName" + }, + "Body": { + "shape": "S3" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Accept": { + "location": "header", + "locationName": "Accept" + }, + "CustomAttributes": { + "shape": "S5", + "location": "header", + "locationName": "X-Amzn-SageMaker-Custom-Attributes" + } + }, + "payload": "Body" + }, + "output": { + "type": "structure", + "required": [ + "Body" + ], + "members": { + "Body": { + "shape": "S3" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "InvokedProductionVariant": { + "location": "header", + "locationName": "x-Amzn-Invoked-Production-Variant" + }, + "CustomAttributes": { + "shape": "S5", + "location": "header", + "locationName": "X-Amzn-SageMaker-Custom-Attributes" + } + }, + "payload": "Body" + } + } + }, + "shapes": { + "S3": { + "type": "blob", + "sensitive": true + }, + "S5": { + "type": "string", + "sensitive": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.paginators.json b/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/runtime.sagemaker-2017-05-13.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json b/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json new file mode 100644 index 0000000..9546326 --- /dev/null +++ b/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json @@ -0,0 +1,1876 @@ +{ + "version": "1.0", + "examples": { + "AbortMultipartUpload": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example aborts a multipart upload.", + "id": "to-abort-a-multipart-upload-1481853354987", + "title": "To abort a multipart upload" + } + ], + "CompleteMultipartUpload": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "MultipartUpload": { + "Parts": [ + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "PartNumber": "1" + }, + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "PartNumber": "2" + } + ] + }, + "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "Bucket": "acexamplebucket", + "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"", + "Key": "bigobject", + "Location": "https://examplebucket.s3.amazonaws.com/bigobject" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example completes a multipart upload.", + "id": "to-complete-multipart-upload-1481851590483", + "title": "To complete multipart upload" + } + ], + "CopyObject": [ + { + "input": { + "Bucket": "destinationbucket", + "CopySource": "/sourcebucket/HappyFacejpg", + "Key": "HappyFaceCopyjpg" + }, + "output": { + "CopyObjectResult": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "2016-12-15T17:38:53.000Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example copies an object from one bucket to another.", + "id": "to-copy-an-object-1481823186878", + "title": "To copy an object" + } + ], + "CreateBucket": [ + { + "input": { + "Bucket": "examplebucket", + "CreateBucketConfiguration": { + "LocationConstraint": "eu-west-1" + } + }, + "output": { + "Location": "http://examplebucket.s3.amazonaws.com/" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", + "id": "to-create-a-bucket-in-a-specific-region-1483399072992", + "title": "To create a bucket in a specific region" + }, + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Location": "/examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a bucket.", + "id": "to-create-a-bucket--1472851826060", + "title": "To create a bucket " + } + ], + "CreateMultipartUpload": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "largeobject" + }, + "output": { + "Bucket": "examplebucket", + "Key": "largeobject", + "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example initiates a multipart upload.", + "id": "to-initiate-a-multipart-upload-1481836794513", + "title": "To initiate a multipart upload" + } + ], + "DeleteBucket": [ + { + "input": { + "Bucket": "forrandall2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes the specified bucket.", + "id": "to-delete-a-bucket-1473108514262", + "title": "To delete a bucket" + } + ], + "DeleteBucketCors": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes CORS configuration on a bucket.", + "id": "to-delete-cors-configuration-on-a-bucket-1483042856112", + "title": "To delete cors configuration on a bucket." + } + ], + "DeleteBucketLifecycle": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes lifecycle configuration on a bucket.", + "id": "to-delete-lifecycle-configuration-on-a-bucket-1483043310583", + "title": "To delete lifecycle configuration on a bucket." + } + ], + "DeleteBucketPolicy": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes bucket policy on the specified bucket.", + "id": "to-delete-bucket-policy-1483043406577", + "title": "To delete bucket policy" + } + ], + "DeleteBucketReplication": [ + { + "input": { + "Bucket": "example" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes replication configuration set on bucket.", + "id": "to-delete-bucket-replication-configuration-1483043684668", + "title": "To delete bucket replication configuration" + } + ], + "DeleteBucketTagging": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes bucket tags.", + "id": "to-delete-bucket-tags-1483043846509", + "title": "To delete bucket tags" + } + ], + "DeleteBucketWebsite": [ + { + "input": { + "Bucket": "examplebucket" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes bucket website configuration.", + "id": "to-delete-bucket-website-configuration-1483043937825", + "title": "To delete bucket website configuration" + } + ], + "DeleteObject": [ + { + "input": { + "Bucket": "ExampleBucket", + "Key": "HappyFace.jpg" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an object from a non-versioned bucket.", + "id": "to-delete-an-object-from-a-non-versioned-bucket-1481588533089", + "title": "To delete an object (from a non-versioned bucket)" + }, + { + "input": { + "Bucket": "examplebucket", + "Key": "objectkey.jpg" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an object from an S3 bucket.", + "id": "to-delete-an-object-1472850136595", + "title": "To delete an object" + } + ], + "DeleteObjectTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "output": { + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", + "id": "to-remove-tag-set-from-an-object-version-1483145285913", + "title": "To remove tag set from an object version" + }, + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", + "id": "to-remove-tag-set-from-an-object-1483145342862", + "title": "To remove tag set from an object" + } + ], + "DeleteObjects": [ + { + "input": { + "Bucket": "examplebucket", + "Delete": { + "Objects": [ + { + "Key": "objectkey1" + }, + { + "Key": "objectkey2" + } + ], + "Quiet": false + } + }, + "output": { + "Deleted": [ + { + "DeleteMarker": "true", + "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", + "Key": "objectkey1" + }, + { + "DeleteMarker": "true", + "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", + "Key": "objectkey2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", + "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", + "title": "To delete multiple objects from a versioned bucket" + }, + { + "input": { + "Bucket": "examplebucket", + "Delete": { + "Objects": [ + { + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + }, + { + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + } + ], + "Quiet": false + } + }, + "output": { + "Deleted": [ + { + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + }, + { + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", + "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", + "title": "To delete multiple object versions from a versioned bucket" + } + ], + "GetBucketCors": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "CORSRules": [ + { + "AllowedHeaders": [ + "Authorization" + ], + "AllowedMethods": [ + "GET" + ], + "AllowedOrigins": [ + "*" + ], + "MaxAgeSeconds": 3000 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.", + "id": "to-get-cors-configuration-set-on-a-bucket-1481596855475", + "title": "To get cors configuration set on a bucket" + } + ], + "GetBucketLifecycle": [ + { + "input": { + "Bucket": "acl1" + }, + "output": { + "Rules": [ + { + "Expiration": { + "Days": 1 + }, + "ID": "delete logs", + "Prefix": "123/", + "Status": "Enabled" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gets ACL on the specified bucket.", + "id": "to-get-a-bucket-acl-1474413606503", + "title": "To get a bucket acl" + } + ], + "GetBucketLifecycleConfiguration": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Rules": [ + { + "ID": "Rule for TaxDocs/", + "Prefix": "TaxDocs", + "Status": "Enabled", + "Transitions": [ + { + "Days": 365, + "StorageClass": "STANDARD_IA" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves lifecycle configuration on set on a bucket. ", + "id": "to-get-lifecycle-configuration-on-a-bucket-1481666063200", + "title": "To get lifecycle configuration on a bucket" + } + ], + "GetBucketLocation": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "LocationConstraint": "us-west-2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns bucket location.", + "id": "to-get-bucket-location-1481594573609", + "title": "To get bucket location" + } + ], + "GetBucketNotification": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "QueueConfiguration": { + "Event": "s3:ObjectCreated:Put", + "Events": [ + "s3:ObjectCreated:Put" + ], + "Id": "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", + "Queue": "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue" + }, + "TopicConfiguration": { + "Event": "s3:ObjectCreated:Copy", + "Events": [ + "s3:ObjectCreated:Copy" + ], + "Id": "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", + "Topic": "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns notification configuration set on a bucket.", + "id": "to-get-notification-configuration-set-on-a-bucket-1481594028667", + "title": "To get notification configuration set on a bucket" + }, + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "QueueConfiguration": { + "Event": "s3:ObjectCreated:Put", + "Events": [ + "s3:ObjectCreated:Put" + ], + "Id": "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", + "Queue": "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue" + }, + "TopicConfiguration": { + "Event": "s3:ObjectCreated:Copy", + "Events": [ + "s3:ObjectCreated:Copy" + ], + "Id": "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", + "Topic": "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns notification configuration set on a bucket.", + "id": "to-get-notification-configuration-set-on-a-bucket-1481594028667", + "title": "To get notification configuration set on a bucket" + } + ], + "GetBucketPolicy": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns bucket policy associated with a bucket.", + "id": "to-get-bucket-policy-1481595098424", + "title": "To get bucket policy" + } + ], + "GetBucketReplication": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "ReplicationConfiguration": { + "Role": "arn:aws:iam::acct-id:role/example-role", + "Rules": [ + { + "Destination": { + "Bucket": "arn:aws:s3:::destination-bucket" + }, + "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy", + "Prefix": "Tax", + "Status": "Enabled" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns replication configuration set on a bucket.", + "id": "to-get-replication-configuration-set-on-a-bucket-1481593597175", + "title": "To get replication configuration set on a bucket" + } + ], + "GetBucketRequestPayment": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Payer": "BucketOwner" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves bucket versioning configuration.", + "id": "to-get-bucket-versioning-configuration-1483037183929", + "title": "To get bucket versioning configuration" + } + ], + "GetBucketTagging": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "TagSet": [ + { + "Key": "key1", + "Value": "value1" + }, + { + "Key": "key2", + "Value": "value2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns tag set associated with a bucket", + "id": "to-get-tag-set-associated-with-a-bucket-1481593232107", + "title": "To get tag set associated with a bucket" + } + ], + "GetBucketVersioning": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "MFADelete": "Disabled", + "Status": "Enabled" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves bucket versioning configuration.", + "id": "to-get-bucket-versioning-configuration-1483037183929", + "title": "To get bucket versioning configuration" + } + ], + "GetBucketWebsite": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "ErrorDocument": { + "Key": "error.html" + }, + "IndexDocument": { + "Suffix": "index.html" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves website configuration of a bucket.", + "id": "to-get-bucket-website-configuration-1483037016926", + "title": "To get bucket website configuration" + } + ], + "GetObject": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "AcceptRanges": "bytes", + "ContentLength": "3191", + "ContentType": "image/jpeg", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT", + "Metadata": { + }, + "TagCount": 2, + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves an object for an S3 bucket.", + "id": "to-retrieve-an-object-1481827837012", + "title": "To retrieve an object" + }, + { + "input": { + "Bucket": "examplebucket", + "Key": "SampleFile.txt", + "Range": "bytes=0-9" + }, + "output": { + "AcceptRanges": "bytes", + "ContentLength": "10", + "ContentRange": "bytes 0-9/43", + "ContentType": "text/plain", + "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"", + "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT", + "Metadata": { + }, + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.", + "id": "to-retrieve-a-byte-range-of-an-object--1481832674603", + "title": "To retrieve a byte range of an object " + } + ], + "GetObjectAcl": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "Grants": [ + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "WRITE" + }, + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "WRITE_ACP" + }, + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "READ" + }, + { + "Grantee": { + "DisplayName": "owner-display-name", + "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", + "Type": "CanonicalUser" + }, + "Permission": "READ_ACP" + } + ], + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves access control list (ACL) of an object.", + "id": "to-retrieve-object-acl-1481833557740", + "title": "To retrieve object ACL" + } + ], + "GetObjectTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "exampleobject", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "output": { + "TagSet": [ + { + "Key": "Key1", + "Value": "Value1" + } + ], + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves tag set of an object. The request specifies object version.", + "id": "to-retrieve-tag-set-of-a-specific-object-version-1483400283663", + "title": "To retrieve tag set of a specific object version" + }, + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "TagSet": [ + { + "Key": "Key4", + "Value": "Value4" + }, + { + "Key": "Key3", + "Value": "Value3" + } + ], + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves tag set of an object.", + "id": "to-retrieve-tag-set-of-an-object-1481833847896", + "title": "To retrieve tag set of an object" + } + ], + "GetObjectTorrent": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves torrent files of an object.", + "id": "to-retrieve-torrent-files-for-an-object-1481834115959", + "title": "To retrieve torrent files for an object" + } + ], + "HeadBucket": [ + { + "input": { + "Bucket": "acl1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation checks to see if a bucket exists.", + "id": "to-determine-if-bucket-exists-1473110292262", + "title": "To determine if bucket exists" + } + ], + "HeadObject": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "AcceptRanges": "bytes", + "ContentLength": "3191", + "ContentType": "image/jpeg", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT", + "Metadata": { + }, + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves an object metadata.", + "id": "to-retrieve-metadata-of-an-object-without-returning-the-object-itself-1481834820480", + "title": "To retrieve metadata of an object without returning the object itself" + } + ], + "ListBuckets": [ + { + "output": { + "Buckets": [ + { + "CreationDate": "2012-02-15T21: 03: 02.000Z", + "Name": "examplebucket" + }, + { + "CreationDate": "2011-07-24T19: 33: 50.000Z", + "Name": "examplebucket2" + }, + { + "CreationDate": "2010-12-17T00: 56: 49.000Z", + "Name": "examplebucket3" + } + ], + "Owner": { + "DisplayName": "own-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.", + "id": "to-list-object-versions-1481910996058", + "title": "To list object versions" + } + ], + "ListMultipartUploads": [ + { + "input": { + "Bucket": "examplebucket" + }, + "output": { + "Uploads": [ + { + "Initiated": "2014-05-01T05:40:58.000Z", + "Initiator": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" + }, + { + "Initiated": "2014-05-01T05:41:27.000Z", + "Initiator": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists in-progress multipart uploads on a specific bucket.", + "id": "to-list-in-progress-multipart-uploads-on-a-bucket-1481852775260", + "title": "To list in-progress multipart uploads on a bucket" + }, + { + "input": { + "Bucket": "examplebucket", + "KeyMarker": "nextkeyfrompreviousresponse", + "MaxUploads": "2", + "UploadIdMarker": "valuefrompreviousresponse" + }, + "output": { + "Bucket": "acl1", + "IsTruncated": true, + "KeyMarker": "", + "MaxUploads": "2", + "NextKeyMarker": "someobjectkey", + "NextUploadIdMarker": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", + "UploadIdMarker": "", + "Uploads": [ + { + "Initiated": "2014-05-01T05:40:58.000Z", + "Initiator": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "mohanataws", + "ID": "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" + }, + { + "Initiated": "2014-05-01T05:41:27.000Z", + "Initiator": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Key": "JavaFile", + "Owner": { + "DisplayName": "ownder-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "StorageClass": "STANDARD", + "UploadId": "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.", + "id": "list-next-set-of-multipart-uploads-when-previous-result-is-truncated-1482428106748", + "title": "List next set of multipart uploads when previous result is truncated" + } + ], + "ListObjectVersions": [ + { + "input": { + "Bucket": "examplebucket", + "Prefix": "HappyFace.jpg" + }, + "output": { + "Versions": [ + { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "IsLatest": true, + "Key": "HappyFace.jpg", + "LastModified": "2016-12-15T01:19:41.000Z", + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 3191, + "StorageClass": "STANDARD", + "VersionId": "null" + }, + { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "IsLatest": false, + "Key": "HappyFace.jpg", + "LastModified": "2016-12-13T00:58:26.000Z", + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 3191, + "StorageClass": "STANDARD", + "VersionId": "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.", + "id": "to-list-object-versions-1481910996058", + "title": "To list object versions" + } + ], + "ListObjects": [ + { + "input": { + "Bucket": "examplebucket", + "MaxKeys": "2" + }, + "output": { + "Contents": [ + { + "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", + "Key": "example1.jpg", + "LastModified": "2014-11-21T19:40:05.000Z", + "Owner": { + "DisplayName": "myname", + "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 11, + "StorageClass": "STANDARD" + }, + { + "ETag": "\"9c8af9a76df052144598c115ef33e511\"", + "Key": "example2.jpg", + "LastModified": "2013-11-15T01:10:49.000Z", + "Owner": { + "DisplayName": "myname", + "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Size": 713193, + "StorageClass": "STANDARD" + } + ], + "NextMarker": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example list two objects in a bucket.", + "id": "to-list-objects-in-a-bucket-1473447646507", + "title": "To list objects in a bucket" + } + ], + "ListObjectsV2": [ + { + "input": { + "Bucket": "examplebucket", + "MaxKeys": "2" + }, + "output": { + "Contents": [ + { + "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", + "Key": "happyface.jpg", + "LastModified": "2014-11-21T19:40:05.000Z", + "Size": 11, + "StorageClass": "STANDARD" + }, + { + "ETag": "\"becf17f89c30367a9a44495d62ed521a-1\"", + "Key": "test.jpg", + "LastModified": "2014-05-02T04:51:50.000Z", + "Size": 4192256, + "StorageClass": "STANDARD" + } + ], + "IsTruncated": true, + "KeyCount": "2", + "MaxKeys": "2", + "Name": "examplebucket", + "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==", + "Prefix": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys. ", + "id": "to-get-object-list", + "title": "To get object list" + } + ], + "ListParts": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "bigobject", + "UploadId": "example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "Initiator": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Owner": { + "DisplayName": "owner-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + }, + "Parts": [ + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "LastModified": "2016-12-16T00:11:42.000Z", + "PartNumber": "1", + "Size": 26246026 + }, + { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", + "LastModified": "2016-12-16T00:15:01.000Z", + "PartNumber": "2", + "Size": 26246026 + } + ], + "StorageClass": "STANDARD" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists parts uploaded for a specific multipart upload.", + "id": "to-list-parts-of-a-multipart-upload-1481852006923", + "title": "To list parts of a multipart upload." + } + ], + "PutBucketAcl": [ + { + "input": { + "Bucket": "examplebucket", + "GrantFullControl": "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484", + "GrantWrite": "uri=http://acs.amazonaws.com/groups/s3/LogDelivery" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.", + "id": "put-bucket-acl-1482260397033", + "title": "Put bucket acl" + } + ], + "PutBucketCors": [ + { + "input": { + "Bucket": "", + "CORSConfiguration": { + "CORSRules": [ + { + "AllowedHeaders": [ + "*" + ], + "AllowedMethods": [ + "PUT", + "POST", + "DELETE" + ], + "AllowedOrigins": [ + "http://www.example.com" + ], + "ExposeHeaders": [ + "x-amz-server-side-encryption" + ], + "MaxAgeSeconds": 3000 + }, + { + "AllowedHeaders": [ + "Authorization" + ], + "AllowedMethods": [ + "GET" + ], + "AllowedOrigins": [ + "*" + ], + "MaxAgeSeconds": 3000 + } + ] + }, + "ContentMD5": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.", + "id": "to-set-cors-configuration-on-a-bucket-1483037818805", + "title": "To set cors configuration on a bucket." + } + ], + "PutBucketLifecycleConfiguration": [ + { + "input": { + "Bucket": "examplebucket", + "LifecycleConfiguration": { + "Rules": [ + { + "Expiration": { + "Days": 3650 + }, + "Filter": { + "Prefix": "documents/" + }, + "ID": "TestOnly", + "Status": "Enabled", + "Transitions": [ + { + "Days": 365, + "StorageClass": "GLACIER" + } + ] + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example replaces existing lifecycle configuration, if any, on the specified bucket. ", + "id": "put-bucket-lifecycle-1482264533092", + "title": "Put bucket lifecycle" + } + ], + "PutBucketLogging": [ + { + "input": { + "Bucket": "sourcebucket", + "BucketLoggingStatus": { + "LoggingEnabled": { + "TargetBucket": "targetbucket", + "TargetGrants": [ + { + "Grantee": { + "Type": "Group", + "URI": "http://acs.amazonaws.com/groups/global/AllUsers" + }, + "Permission": "READ" + } + ], + "TargetPrefix": "MyBucketLogs/" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.", + "id": "set-logging-configuration-for-a-bucket-1482269119909", + "title": "Set logging configuration for a bucket" + } + ], + "PutBucketNotificationConfiguration": [ + { + "input": { + "Bucket": "examplebucket", + "NotificationConfiguration": { + "TopicConfigurations": [ + { + "Events": [ + "s3:ObjectCreated:*" + ], + "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.", + "id": "set-notification-configuration-for-a-bucket-1482270296426", + "title": "Set notification configuration for a bucket" + } + ], + "PutBucketPolicy": [ + { + "input": { + "Bucket": "examplebucket", + "Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets a permission policy on a bucket.", + "id": "set-bucket-policy-1482448903302", + "title": "Set bucket policy" + } + ], + "PutBucketReplication": [ + { + "input": { + "Bucket": "examplebucket", + "ReplicationConfiguration": { + "Role": "arn:aws:iam::123456789012:role/examplerole", + "Rules": [ + { + "Destination": { + "Bucket": "arn:aws:s3:::destinationbucket", + "StorageClass": "STANDARD" + }, + "Prefix": "", + "Status": "Enabled" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets replication configuration on a bucket.", + "id": "id-1", + "title": "Set replication configuration on a bucket" + } + ], + "PutBucketRequestPayment": [ + { + "input": { + "Bucket": "examplebucket", + "RequestPaymentConfiguration": { + "Payer": "Requester" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets request payment configuration on a bucket so that person requesting the download is charged.", + "id": "set-request-payment-configuration-on-a-bucket-1482343596680", + "title": "Set request payment configuration on a bucket." + } + ], + "PutBucketTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Tagging": { + "TagSet": [ + { + "Key": "Key1", + "Value": "Value1" + }, + { + "Key": "Key2", + "Value": "Value2" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets tags on a bucket. Any existing tags are replaced.", + "id": "set-tags-on-a-bucket-1482346269066", + "title": "Set tags on a bucket" + } + ], + "PutBucketVersioning": [ + { + "input": { + "Bucket": "examplebucket", + "VersioningConfiguration": { + "MFADelete": "Disabled", + "Status": "Enabled" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.", + "id": "set-versioning-configuration-on-a-bucket-1482344186279", + "title": "Set versioning configuration on a bucket" + } + ], + "PutBucketWebsite": [ + { + "input": { + "Bucket": "examplebucket", + "ContentMD5": "", + "WebsiteConfiguration": { + "ErrorDocument": { + "Key": "error.html" + }, + "IndexDocument": { + "Suffix": "index.html" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds website configuration to a bucket.", + "id": "set-website-configuration-on-a-bucket-1482346836261", + "title": "Set website configuration on a bucket" + } + ], + "PutObject": [ + { + "input": { + "Body": "c:\\HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "Tagging": "key1=value1&key2=value2" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", + "title": "To upload an object and specify optional tags" + }, + { + "input": { + "ACL": "authenticated-read", + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", + "title": "To upload an object and specify canned ACL." + }, + { + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "objectkey" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-create-an-object-1483147613675", + "title": "To create an object." + }, + { + "input": { + "Body": "HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "ServerSideEncryption": "AES256", + "StorageClass": "STANDARD_IA" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "ServerSideEncryption": "AES256", + "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", + "id": "to-upload-an-object-(specify-optional-headers)", + "title": "To upload an object (specify optional headers)" + }, + { + "input": { + "Body": "HappyFace.jpg", + "Bucket": "examplebucket", + "Key": "HappyFace.jpg" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", + "id": "to-upload-an-object-1481760101010", + "title": "To upload an object" + }, + { + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject", + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", + "title": "To upload object and specify user-defined metadata" + }, + { + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "exampleobject", + "ServerSideEncryption": "AES256", + "Tagging": "key1=value1&key2=value2" + }, + "output": { + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "ServerSideEncryption": "AES256", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", + "title": "To upload an object and specify server-side encryption and object tags" + } + ], + "PutObjectAcl": [ + { + "input": { + "AccessControlPolicy": { + }, + "Bucket": "examplebucket", + "GrantFullControl": "emailaddress=user1@example.com,emailaddress=user2@example.com", + "GrantRead": "uri=http://acs.amazonaws.com/groups/global/AllUsers", + "Key": "HappyFace.jpg" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.", + "id": "to-grant-permissions-using-object-acl-1481835549285", + "title": "To grant permissions using object ACL" + } + ], + "PutObjectTagging": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "HappyFace.jpg", + "Tagging": { + "TagSet": [ + { + "Key": "Key3", + "Value": "Value3" + }, + { + "Key": "Key4", + "Value": "Value4" + } + ] + } + }, + "output": { + "VersionId": "null" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds tags to an existing object.", + "id": "to-add-tags-to-an-existing-object-1481764668793", + "title": "To add tags to an existing object" + } + ], + "RestoreObject": [ + { + "input": { + "Bucket": "examplebucket", + "Key": "archivedobjectkey", + "RestoreRequest": { + "Days": 1, + "GlacierJobParameters": { + "Tier": "Expedited" + } + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example restores for one day an archived copy of an object back into Amazon S3 bucket.", + "id": "to-restore-an-archived-object-1483049329953", + "title": "To restore an archived object" + } + ], + "UploadPart": [ + { + "input": { + "Body": "fileToUpload", + "Bucket": "examplebucket", + "Key": "examplelargeobject", + "PartNumber": "1", + "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" + }, + "output": { + "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.", + "id": "to-upload-a-part-1481847914943", + "title": "To upload a part" + } + ], + "UploadPartCopy": [ + { + "input": { + "Bucket": "examplebucket", + "CopySource": "/bucketname/sourceobjectkey", + "CopySourceRange": "bytes=1-100000", + "Key": "examplelargeobject", + "PartNumber": "2", + "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" + }, + "output": { + "CopyPartResult": { + "ETag": "\"65d16d19e65a7508a51f043180edcc36\"", + "LastModified": "2016-12-29T21:44:28.000Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.", + "id": "to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594", + "title": "To upload a part by copying byte range from an existing object as data source" + }, + { + "input": { + "Bucket": "examplebucket", + "CopySource": "/bucketname/sourceobjectkey", + "Key": "examplelargeobject", + "PartNumber": "1", + "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" + }, + "output": { + "CopyPartResult": { + "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", + "LastModified": "2016-12-29T21:24:43.000Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example uploads a part of a multipart upload by copying data from an existing object as data source.", + "id": "to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348", + "title": "To upload a part by copying data from an existing object as data source" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/s3-2006-03-01.min.json b/node_modules/aws-sdk/apis/s3-2006-03-01.min.json new file mode 100644 index 0000000..e223add --- /dev/null +++ b/node_modules/aws-sdk/apis/s3-2006-03-01.min.json @@ -0,0 +1,5492 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2006-03-01", + "checksumFormat": "md5", + "endpointPrefix": "s3", + "globalEndpoint": "s3.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "Amazon S3", + "serviceFullName": "Amazon Simple Storage Service", + "serviceId": "S3", + "signatureVersion": "s3", + "uid": "s3-2006-03-01" + }, + "operations": { + "AbortMultipartUpload": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}/{Key+}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "CompleteMultipartUpload": { + "http": { + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "MultipartUpload": { + "locationName": "CompleteMultipartUpload", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "members": { + "Parts": { + "locationName": "Part", + "type": "list", + "member": { + "type": "structure", + "members": { + "ETag": {}, + "PartNumber": { + "type": "integer" + } + } + }, + "flattened": true + } + } + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + }, + "payload": "MultipartUpload" + }, + "output": { + "type": "structure", + "members": { + "Location": {}, + "Bucket": {}, + "Key": {}, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration" + }, + "ETag": {}, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "CopyObject": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "CopySource", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "CopySource": { + "location": "header", + "locationName": "x-amz-copy-source" + }, + "CopySourceIfMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-modified-since", + "type": "timestamp" + }, + "CopySourceIfNoneMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-unmodified-since", + "type": "timestamp" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Metadata": { + "shape": "S11", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "MetadataDirective": { + "location": "header", + "locationName": "x-amz-metadata-directive" + }, + "TaggingDirective": { + "location": "header", + "locationName": "x-amz-tagging-directive" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "CopySourceSSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey": { + "shape": "S1c", + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "Tagging": { + "location": "header", + "locationName": "x-amz-tagging" + }, + "ObjectLockMode": { + "location": "header", + "locationName": "x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate": { + "shape": "S1g", + "location": "header", + "locationName": "x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus": { + "location": "header", + "locationName": "x-amz-object-lock-legal-hold" + } + } + }, + "output": { + "type": "structure", + "members": { + "CopyObjectResult": { + "type": "structure", + "members": { + "ETag": {}, + "LastModified": { + "type": "timestamp" + } + } + }, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration" + }, + "CopySourceVersionId": { + "location": "header", + "locationName": "x-amz-copy-source-version-id" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + }, + "payload": "CopyObjectResult" + }, + "alias": "PutObjectCopy" + }, + "CreateBucket": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CreateBucketConfiguration": { + "locationName": "CreateBucketConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "members": { + "LocationConstraint": {} + } + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWrite": { + "location": "header", + "locationName": "x-amz-grant-write" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "ObjectLockEnabledForBucket": { + "location": "header", + "locationName": "x-amz-bucket-object-lock-enabled", + "type": "boolean" + } + }, + "payload": "CreateBucketConfiguration" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + } + } + }, + "alias": "PutBucket" + }, + "CreateMultipartUpload": { + "http": { + "requestUri": "/{Bucket}/{Key+}?uploads" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Metadata": { + "shape": "S11", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "Tagging": { + "location": "header", + "locationName": "x-amz-tagging" + }, + "ObjectLockMode": { + "location": "header", + "locationName": "x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate": { + "shape": "S1g", + "location": "header", + "locationName": "x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus": { + "location": "header", + "locationName": "x-amz-object-lock-legal-hold" + } + } + }, + "output": { + "type": "structure", + "members": { + "AbortDate": { + "location": "header", + "locationName": "x-amz-abort-date", + "type": "timestamp" + }, + "AbortRuleId": { + "location": "header", + "locationName": "x-amz-abort-rule-id" + }, + "Bucket": { + "locationName": "Bucket" + }, + "Key": {}, + "UploadId": {}, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + }, + "alias": "InitiateMultipartUpload" + }, + "DeleteBucket": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketAnalyticsConfiguration": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?analytics", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + } + } + } + }, + "DeleteBucketCors": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?cors", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketEncryption": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?encryption", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketInventoryConfiguration": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?inventory", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + } + } + } + }, + "DeleteBucketLifecycle": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?lifecycle", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketMetricsConfiguration": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?metrics", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + } + } + } + }, + "DeleteBucketPolicy": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?policy", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketReplication": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?replication", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketTagging": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?tagging", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketWebsite": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?website", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteObject": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}/{Key+}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "MFA": { + "location": "header", + "locationName": "x-amz-mfa" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "BypassGovernanceRetention": { + "location": "header", + "locationName": "x-amz-bypass-governance-retention", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeleteMarker": { + "location": "header", + "locationName": "x-amz-delete-marker", + "type": "boolean" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "DeleteObjectTagging": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}/{Key+}?tagging", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + } + } + } + }, + "DeleteObjects": { + "http": { + "requestUri": "/{Bucket}?delete" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Delete" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delete": { + "locationName": "Delete", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "required": [ + "Objects" + ], + "members": { + "Objects": { + "locationName": "Object", + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "VersionId": {} + } + }, + "flattened": true + }, + "Quiet": { + "type": "boolean" + } + } + }, + "MFA": { + "location": "header", + "locationName": "x-amz-mfa" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "BypassGovernanceRetention": { + "location": "header", + "locationName": "x-amz-bypass-governance-retention", + "type": "boolean" + } + }, + "payload": "Delete" + }, + "output": { + "type": "structure", + "members": { + "Deleted": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "VersionId": {}, + "DeleteMarker": { + "type": "boolean" + }, + "DeleteMarkerVersionId": {} + } + }, + "flattened": true + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + }, + "Errors": { + "locationName": "Error", + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "VersionId": {}, + "Code": {}, + "Message": {} + } + }, + "flattened": true + } + } + }, + "alias": "DeleteMultipleObjects" + }, + "DeletePublicAccessBlock": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?publicAccessBlock", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "GetBucketAccelerateConfiguration": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?accelerate" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": {} + } + } + }, + "GetBucketAcl": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Owner": { + "shape": "S31" + }, + "Grants": { + "shape": "S34", + "locationName": "AccessControlList" + } + } + } + }, + "GetBucketAnalyticsConfiguration": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?analytics" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + } + } + }, + "output": { + "type": "structure", + "members": { + "AnalyticsConfiguration": { + "shape": "S3d" + } + }, + "payload": "AnalyticsConfiguration" + } + }, + "GetBucketCors": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?cors" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "CORSRules": { + "shape": "S3t", + "locationName": "CORSRule" + } + } + } + }, + "GetBucketEncryption": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?encryption" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "ServerSideEncryptionConfiguration": { + "shape": "S46" + } + }, + "payload": "ServerSideEncryptionConfiguration" + } + }, + "GetBucketInventoryConfiguration": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?inventory" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + } + } + }, + "output": { + "type": "structure", + "members": { + "InventoryConfiguration": { + "shape": "S4c" + } + }, + "payload": "InventoryConfiguration" + } + }, + "GetBucketLifecycle": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?lifecycle" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Rules": { + "shape": "S4s", + "locationName": "Rule" + } + } + }, + "deprecated": true + }, + "GetBucketLifecycleConfiguration": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?lifecycle" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Rules": { + "shape": "S57", + "locationName": "Rule" + } + } + } + }, + "GetBucketLocation": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?location" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocationConstraint": {} + } + } + }, + "GetBucketLogging": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?logging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoggingEnabled": { + "shape": "S5h" + } + } + } + }, + "GetBucketMetricsConfiguration": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?metrics" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + } + } + }, + "output": { + "type": "structure", + "members": { + "MetricsConfiguration": { + "shape": "S5p" + } + }, + "payload": "MetricsConfiguration" + } + }, + "GetBucketNotification": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?notification" + }, + "input": { + "shape": "S5s" + }, + "output": { + "shape": "S5t" + }, + "deprecated": true + }, + "GetBucketNotificationConfiguration": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?notification" + }, + "input": { + "shape": "S5s" + }, + "output": { + "shape": "S64" + } + }, + "GetBucketPolicy": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?policy" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {} + }, + "payload": "Policy" + } + }, + "GetBucketPolicyStatus": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?policyStatus" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "PolicyStatus": { + "type": "structure", + "members": { + "IsPublic": { + "locationName": "IsPublic", + "type": "boolean" + } + } + } + }, + "payload": "PolicyStatus" + } + }, + "GetBucketReplication": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?replication" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReplicationConfiguration": { + "shape": "S6r" + } + }, + "payload": "ReplicationConfiguration" + } + }, + "GetBucketRequestPayment": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?requestPayment" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Payer": {} + } + } + }, + "GetBucketTagging": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?tagging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TagSet" + ], + "members": { + "TagSet": { + "shape": "S3j" + } + } + } + }, + "GetBucketVersioning": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?versioning" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": {}, + "MFADelete": { + "locationName": "MfaDelete" + } + } + } + }, + "GetBucketWebsite": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?website" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "RedirectAllRequestsTo": { + "shape": "S7k" + }, + "IndexDocument": { + "shape": "S7n" + }, + "ErrorDocument": { + "shape": "S7p" + }, + "RoutingRules": { + "shape": "S7q" + } + } + } + }, + "GetObject": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + }, + "IfModifiedSince": { + "location": "header", + "locationName": "If-Modified-Since", + "type": "timestamp" + }, + "IfNoneMatch": { + "location": "header", + "locationName": "If-None-Match" + }, + "IfUnmodifiedSince": { + "location": "header", + "locationName": "If-Unmodified-Since", + "type": "timestamp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Range": { + "location": "header", + "locationName": "Range" + }, + "ResponseCacheControl": { + "location": "querystring", + "locationName": "response-cache-control" + }, + "ResponseContentDisposition": { + "location": "querystring", + "locationName": "response-content-disposition" + }, + "ResponseContentEncoding": { + "location": "querystring", + "locationName": "response-content-encoding" + }, + "ResponseContentLanguage": { + "location": "querystring", + "locationName": "response-content-language" + }, + "ResponseContentType": { + "location": "querystring", + "locationName": "response-content-type" + }, + "ResponseExpires": { + "location": "querystring", + "locationName": "response-expires", + "type": "timestamp" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "PartNumber": { + "location": "querystring", + "locationName": "partNumber", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Body": { + "streaming": true, + "type": "blob" + }, + "DeleteMarker": { + "location": "header", + "locationName": "x-amz-delete-marker", + "type": "boolean" + }, + "AcceptRanges": { + "location": "header", + "locationName": "accept-ranges" + }, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration" + }, + "Restore": { + "location": "header", + "locationName": "x-amz-restore" + }, + "LastModified": { + "location": "header", + "locationName": "Last-Modified", + "type": "timestamp" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "long" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "MissingMeta": { + "location": "header", + "locationName": "x-amz-missing-meta", + "type": "integer" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentRange": { + "location": "header", + "locationName": "Content-Range" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "Metadata": { + "shape": "S11", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + }, + "ReplicationStatus": { + "location": "header", + "locationName": "x-amz-replication-status" + }, + "PartsCount": { + "location": "header", + "locationName": "x-amz-mp-parts-count", + "type": "integer" + }, + "TagCount": { + "location": "header", + "locationName": "x-amz-tagging-count", + "type": "integer" + }, + "ObjectLockMode": { + "location": "header", + "locationName": "x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate": { + "shape": "S1g", + "location": "header", + "locationName": "x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus": { + "location": "header", + "locationName": "x-amz-object-lock-legal-hold" + } + }, + "payload": "Body" + } + }, + "GetObjectAcl": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key+}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Owner": { + "shape": "S31" + }, + "Grants": { + "shape": "S34", + "locationName": "AccessControlList" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "GetObjectLegalHold": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key+}?legal-hold" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "LegalHold": { + "shape": "S8p" + } + }, + "payload": "LegalHold" + } + }, + "GetObjectLockConfiguration": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?object-lock" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "ObjectLockConfiguration": { + "shape": "S8s" + } + }, + "payload": "ObjectLockConfiguration" + } + }, + "GetObjectRetention": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key+}?retention" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Retention": { + "shape": "S90" + } + }, + "payload": "Retention" + } + }, + "GetObjectTagging": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key+}?tagging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TagSet" + ], + "members": { + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "TagSet": { + "shape": "S3j" + } + } + } + }, + "GetObjectTorrent": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key+}?torrent" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Body": { + "streaming": true, + "type": "blob" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + }, + "payload": "Body" + } + }, + "GetPublicAccessBlock": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?publicAccessBlock" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicAccessBlockConfiguration": { + "shape": "S97" + } + }, + "payload": "PublicAccessBlockConfiguration" + } + }, + "HeadBucket": { + "http": { + "method": "HEAD", + "requestUri": "/{Bucket}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "HeadObject": { + "http": { + "method": "HEAD", + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + }, + "IfModifiedSince": { + "location": "header", + "locationName": "If-Modified-Since", + "type": "timestamp" + }, + "IfNoneMatch": { + "location": "header", + "locationName": "If-None-Match" + }, + "IfUnmodifiedSince": { + "location": "header", + "locationName": "If-Unmodified-Since", + "type": "timestamp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Range": { + "location": "header", + "locationName": "Range" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "PartNumber": { + "location": "querystring", + "locationName": "partNumber", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeleteMarker": { + "location": "header", + "locationName": "x-amz-delete-marker", + "type": "boolean" + }, + "AcceptRanges": { + "location": "header", + "locationName": "accept-ranges" + }, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration" + }, + "Restore": { + "location": "header", + "locationName": "x-amz-restore" + }, + "LastModified": { + "location": "header", + "locationName": "Last-Modified", + "type": "timestamp" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "long" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "MissingMeta": { + "location": "header", + "locationName": "x-amz-missing-meta", + "type": "integer" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "Metadata": { + "shape": "S11", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + }, + "ReplicationStatus": { + "location": "header", + "locationName": "x-amz-replication-status" + }, + "PartsCount": { + "location": "header", + "locationName": "x-amz-mp-parts-count", + "type": "integer" + }, + "ObjectLockMode": { + "location": "header", + "locationName": "x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate": { + "shape": "S1g", + "location": "header", + "locationName": "x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus": { + "location": "header", + "locationName": "x-amz-object-lock-legal-hold" + } + } + } + }, + "ListBucketAnalyticsConfigurations": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?analytics" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContinuationToken": { + "location": "querystring", + "locationName": "continuation-token" + } + } + }, + "output": { + "type": "structure", + "members": { + "IsTruncated": { + "type": "boolean" + }, + "ContinuationToken": {}, + "NextContinuationToken": {}, + "AnalyticsConfigurationList": { + "locationName": "AnalyticsConfiguration", + "type": "list", + "member": { + "shape": "S3d" + }, + "flattened": true + } + } + } + }, + "ListBucketInventoryConfigurations": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?inventory" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContinuationToken": { + "location": "querystring", + "locationName": "continuation-token" + } + } + }, + "output": { + "type": "structure", + "members": { + "ContinuationToken": {}, + "InventoryConfigurationList": { + "locationName": "InventoryConfiguration", + "type": "list", + "member": { + "shape": "S4c" + }, + "flattened": true + }, + "IsTruncated": { + "type": "boolean" + }, + "NextContinuationToken": {} + } + } + }, + "ListBucketMetricsConfigurations": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?metrics" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContinuationToken": { + "location": "querystring", + "locationName": "continuation-token" + } + } + }, + "output": { + "type": "structure", + "members": { + "IsTruncated": { + "type": "boolean" + }, + "ContinuationToken": {}, + "NextContinuationToken": {}, + "MetricsConfigurationList": { + "locationName": "MetricsConfiguration", + "type": "list", + "member": { + "shape": "S5p" + }, + "flattened": true + } + } + } + }, + "ListBuckets": { + "http": { + "method": "GET" + }, + "output": { + "type": "structure", + "members": { + "Buckets": { + "type": "list", + "member": { + "locationName": "Bucket", + "type": "structure", + "members": { + "Name": {}, + "CreationDate": { + "type": "timestamp" + } + } + } + }, + "Owner": { + "shape": "S31" + } + } + }, + "alias": "GetService" + }, + "ListMultipartUploads": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?uploads" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delimiter": { + "location": "querystring", + "locationName": "delimiter" + }, + "EncodingType": { + "location": "querystring", + "locationName": "encoding-type" + }, + "KeyMarker": { + "location": "querystring", + "locationName": "key-marker" + }, + "MaxUploads": { + "location": "querystring", + "locationName": "max-uploads", + "type": "integer" + }, + "Prefix": { + "location": "querystring", + "locationName": "prefix" + }, + "UploadIdMarker": { + "location": "querystring", + "locationName": "upload-id-marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Bucket": {}, + "KeyMarker": {}, + "UploadIdMarker": {}, + "NextKeyMarker": {}, + "Prefix": {}, + "Delimiter": {}, + "NextUploadIdMarker": {}, + "MaxUploads": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Uploads": { + "locationName": "Upload", + "type": "list", + "member": { + "type": "structure", + "members": { + "UploadId": {}, + "Key": {}, + "Initiated": { + "type": "timestamp" + }, + "StorageClass": {}, + "Owner": { + "shape": "S31" + }, + "Initiator": { + "shape": "Sa4" + } + } + }, + "flattened": true + }, + "CommonPrefixes": { + "shape": "Sa5" + }, + "EncodingType": {} + } + } + }, + "ListObjectVersions": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?versions" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delimiter": { + "location": "querystring", + "locationName": "delimiter" + }, + "EncodingType": { + "location": "querystring", + "locationName": "encoding-type" + }, + "KeyMarker": { + "location": "querystring", + "locationName": "key-marker" + }, + "MaxKeys": { + "location": "querystring", + "locationName": "max-keys", + "type": "integer" + }, + "Prefix": { + "location": "querystring", + "locationName": "prefix" + }, + "VersionIdMarker": { + "location": "querystring", + "locationName": "version-id-marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "IsTruncated": { + "type": "boolean" + }, + "KeyMarker": {}, + "VersionIdMarker": {}, + "NextKeyMarker": {}, + "NextVersionIdMarker": {}, + "Versions": { + "locationName": "Version", + "type": "list", + "member": { + "type": "structure", + "members": { + "ETag": {}, + "Size": { + "type": "integer" + }, + "StorageClass": {}, + "Key": {}, + "VersionId": {}, + "IsLatest": { + "type": "boolean" + }, + "LastModified": { + "type": "timestamp" + }, + "Owner": { + "shape": "S31" + } + } + }, + "flattened": true + }, + "DeleteMarkers": { + "locationName": "DeleteMarker", + "type": "list", + "member": { + "type": "structure", + "members": { + "Owner": { + "shape": "S31" + }, + "Key": {}, + "VersionId": {}, + "IsLatest": { + "type": "boolean" + }, + "LastModified": { + "type": "timestamp" + } + } + }, + "flattened": true + }, + "Name": {}, + "Prefix": {}, + "Delimiter": {}, + "MaxKeys": { + "type": "integer" + }, + "CommonPrefixes": { + "shape": "Sa5" + }, + "EncodingType": {} + } + }, + "alias": "GetBucketObjectVersions" + }, + "ListObjects": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delimiter": { + "location": "querystring", + "locationName": "delimiter" + }, + "EncodingType": { + "location": "querystring", + "locationName": "encoding-type" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "MaxKeys": { + "location": "querystring", + "locationName": "max-keys", + "type": "integer" + }, + "Prefix": { + "location": "querystring", + "locationName": "prefix" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "IsTruncated": { + "type": "boolean" + }, + "Marker": {}, + "NextMarker": {}, + "Contents": { + "shape": "San" + }, + "Name": {}, + "Prefix": {}, + "Delimiter": {}, + "MaxKeys": { + "type": "integer" + }, + "CommonPrefixes": { + "shape": "Sa5" + }, + "EncodingType": {} + } + }, + "alias": "GetBucket" + }, + "ListObjectsV2": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?list-type=2" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delimiter": { + "location": "querystring", + "locationName": "delimiter" + }, + "EncodingType": { + "location": "querystring", + "locationName": "encoding-type" + }, + "MaxKeys": { + "location": "querystring", + "locationName": "max-keys", + "type": "integer" + }, + "Prefix": { + "location": "querystring", + "locationName": "prefix" + }, + "ContinuationToken": { + "location": "querystring", + "locationName": "continuation-token" + }, + "FetchOwner": { + "location": "querystring", + "locationName": "fetch-owner", + "type": "boolean" + }, + "StartAfter": { + "location": "querystring", + "locationName": "start-after" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "IsTruncated": { + "type": "boolean" + }, + "Contents": { + "shape": "San" + }, + "Name": {}, + "Prefix": {}, + "Delimiter": {}, + "MaxKeys": { + "type": "integer" + }, + "CommonPrefixes": { + "shape": "Sa5" + }, + "EncodingType": {}, + "KeyCount": { + "type": "integer" + }, + "ContinuationToken": {}, + "NextContinuationToken": {}, + "StartAfter": {} + } + } + }, + "ListParts": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "MaxParts": { + "location": "querystring", + "locationName": "max-parts", + "type": "integer" + }, + "PartNumberMarker": { + "location": "querystring", + "locationName": "part-number-marker", + "type": "integer" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AbortDate": { + "location": "header", + "locationName": "x-amz-abort-date", + "type": "timestamp" + }, + "AbortRuleId": { + "location": "header", + "locationName": "x-amz-abort-rule-id" + }, + "Bucket": {}, + "Key": {}, + "UploadId": {}, + "PartNumberMarker": { + "type": "integer" + }, + "NextPartNumberMarker": { + "type": "integer" + }, + "MaxParts": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Parts": { + "locationName": "Part", + "type": "list", + "member": { + "type": "structure", + "members": { + "PartNumber": { + "type": "integer" + }, + "LastModified": { + "type": "timestamp" + }, + "ETag": {}, + "Size": { + "type": "integer" + } + } + }, + "flattened": true + }, + "Initiator": { + "shape": "Sa4" + }, + "Owner": { + "shape": "S31" + }, + "StorageClass": {}, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "PutBucketAccelerateConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?accelerate" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "AccelerateConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "AccelerateConfiguration": { + "locationName": "AccelerateConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "members": { + "Status": {} + } + } + }, + "payload": "AccelerateConfiguration" + } + }, + "PutBucketAcl": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "AccessControlPolicy": { + "shape": "Sb5", + "locationName": "AccessControlPolicy", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWrite": { + "location": "header", + "locationName": "x-amz-grant-write" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + } + }, + "payload": "AccessControlPolicy" + } + }, + "PutBucketAnalyticsConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?analytics" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id", + "AnalyticsConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + }, + "AnalyticsConfiguration": { + "shape": "S3d", + "locationName": "AnalyticsConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "AnalyticsConfiguration" + } + }, + "PutBucketCors": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?cors" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "CORSConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CORSConfiguration": { + "locationName": "CORSConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "required": [ + "CORSRules" + ], + "members": { + "CORSRules": { + "shape": "S3t", + "locationName": "CORSRule" + } + } + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + } + }, + "payload": "CORSConfiguration" + } + }, + "PutBucketEncryption": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?encryption" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "ServerSideEncryptionConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "ServerSideEncryptionConfiguration": { + "shape": "S46", + "locationName": "ServerSideEncryptionConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "ServerSideEncryptionConfiguration" + } + }, + "PutBucketInventoryConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?inventory" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id", + "InventoryConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + }, + "InventoryConfiguration": { + "shape": "S4c", + "locationName": "InventoryConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "InventoryConfiguration" + } + }, + "PutBucketLifecycle": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?lifecycle" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "LifecycleConfiguration": { + "locationName": "LifecycleConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "required": [ + "Rules" + ], + "members": { + "Rules": { + "shape": "S4s", + "locationName": "Rule" + } + } + } + }, + "payload": "LifecycleConfiguration" + }, + "deprecated": true + }, + "PutBucketLifecycleConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?lifecycle" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "LifecycleConfiguration": { + "locationName": "LifecycleConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "required": [ + "Rules" + ], + "members": { + "Rules": { + "shape": "S57", + "locationName": "Rule" + } + } + } + }, + "payload": "LifecycleConfiguration" + } + }, + "PutBucketLogging": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?logging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "BucketLoggingStatus" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "BucketLoggingStatus": { + "locationName": "BucketLoggingStatus", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "members": { + "LoggingEnabled": { + "shape": "S5h" + } + } + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + } + }, + "payload": "BucketLoggingStatus" + } + }, + "PutBucketMetricsConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?metrics" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Id", + "MetricsConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Id": { + "location": "querystring", + "locationName": "id" + }, + "MetricsConfiguration": { + "shape": "S5p", + "locationName": "MetricsConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "MetricsConfiguration" + } + }, + "PutBucketNotification": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?notification" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "NotificationConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "NotificationConfiguration": { + "shape": "S5t", + "locationName": "NotificationConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "NotificationConfiguration" + }, + "deprecated": true + }, + "PutBucketNotificationConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?notification" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "NotificationConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "NotificationConfiguration": { + "shape": "S64", + "locationName": "NotificationConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "NotificationConfiguration" + } + }, + "PutBucketPolicy": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?policy" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Policy" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "ConfirmRemoveSelfBucketAccess": { + "location": "header", + "locationName": "x-amz-confirm-remove-self-bucket-access", + "type": "boolean" + }, + "Policy": {} + }, + "payload": "Policy" + } + }, + "PutBucketReplication": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?replication" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "ReplicationConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "ReplicationConfiguration": { + "shape": "S6r", + "locationName": "ReplicationConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "ReplicationConfiguration" + } + }, + "PutBucketRequestPayment": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?requestPayment" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "RequestPaymentConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "RequestPaymentConfiguration": { + "locationName": "RequestPaymentConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "required": [ + "Payer" + ], + "members": { + "Payer": {} + } + } + }, + "payload": "RequestPaymentConfiguration" + } + }, + "PutBucketTagging": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?tagging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Tagging" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "Tagging": { + "shape": "Sbr", + "locationName": "Tagging", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "Tagging" + } + }, + "PutBucketVersioning": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?versioning" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "VersioningConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "MFA": { + "location": "header", + "locationName": "x-amz-mfa" + }, + "VersioningConfiguration": { + "locationName": "VersioningConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "members": { + "MFADelete": { + "locationName": "MfaDelete" + }, + "Status": {} + } + } + }, + "payload": "VersioningConfiguration" + } + }, + "PutBucketWebsite": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?website" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "WebsiteConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "WebsiteConfiguration": { + "locationName": "WebsiteConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "members": { + "ErrorDocument": { + "shape": "S7p" + }, + "IndexDocument": { + "shape": "S7n" + }, + "RedirectAllRequestsTo": { + "shape": "S7k" + }, + "RoutingRules": { + "shape": "S7q" + } + } + } + }, + "payload": "WebsiteConfiguration" + } + }, + "PutObject": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Body": { + "streaming": true, + "type": "blob" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "long" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Metadata": { + "shape": "S11", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "Tagging": { + "location": "header", + "locationName": "x-amz-tagging" + }, + "ObjectLockMode": { + "location": "header", + "locationName": "x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate": { + "shape": "S1g", + "location": "header", + "locationName": "x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus": { + "location": "header", + "locationName": "x-amz-object-lock-legal-hold" + } + }, + "payload": "Body" + }, + "output": { + "type": "structure", + "members": { + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "PutObjectAcl": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "AccessControlPolicy": { + "shape": "Sb5", + "locationName": "AccessControlPolicy", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWrite": { + "location": "header", + "locationName": "x-amz-grant-write" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + } + }, + "payload": "AccessControlPolicy" + }, + "output": { + "type": "structure", + "members": { + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "PutObjectLegalHold": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}?legal-hold" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "LegalHold": { + "shape": "S8p", + "locationName": "LegalHold", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + } + }, + "payload": "LegalHold" + }, + "output": { + "type": "structure", + "members": { + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "PutObjectLockConfiguration": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?object-lock" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ObjectLockConfiguration": { + "shape": "S8s", + "locationName": "ObjectLockConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "Token": { + "location": "header", + "locationName": "x-amz-bucket-object-lock-token" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + } + }, + "payload": "ObjectLockConfiguration" + }, + "output": { + "type": "structure", + "members": { + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "PutObjectRetention": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}?retention" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Retention": { + "shape": "S90", + "locationName": "Retention", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "BypassGovernanceRetention": { + "location": "header", + "locationName": "x-amz-bypass-governance-retention", + "type": "boolean" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + } + }, + "payload": "Retention" + }, + "output": { + "type": "structure", + "members": { + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "PutObjectTagging": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}?tagging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "Tagging" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "Tagging": { + "shape": "Sbr", + "locationName": "Tagging", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "Tagging" + }, + "output": { + "type": "structure", + "members": { + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + } + } + } + }, + "PutPublicAccessBlock": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?publicAccessBlock" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "PublicAccessBlockConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "PublicAccessBlockConfiguration": { + "shape": "S97", + "locationName": "PublicAccessBlockConfiguration", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "payload": "PublicAccessBlockConfiguration" + } + }, + "RestoreObject": { + "http": { + "requestUri": "/{Bucket}/{Key+}?restore" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "RestoreRequest": { + "locationName": "RestoreRequest", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "members": { + "Days": { + "type": "integer" + }, + "GlacierJobParameters": { + "type": "structure", + "required": [ + "Tier" + ], + "members": { + "Tier": {} + } + }, + "Type": {}, + "Tier": {}, + "Description": {}, + "SelectParameters": { + "type": "structure", + "required": [ + "InputSerialization", + "ExpressionType", + "Expression", + "OutputSerialization" + ], + "members": { + "InputSerialization": { + "shape": "Sci" + }, + "ExpressionType": {}, + "Expression": {}, + "OutputSerialization": { + "shape": "Scx" + } + } + }, + "OutputLocation": { + "type": "structure", + "members": { + "S3": { + "type": "structure", + "required": [ + "BucketName", + "Prefix" + ], + "members": { + "BucketName": {}, + "Prefix": {}, + "Encryption": { + "type": "structure", + "required": [ + "EncryptionType" + ], + "members": { + "EncryptionType": {}, + "KMSKeyId": { + "shape": "Sj" + }, + "KMSContext": {} + } + }, + "CannedACL": {}, + "AccessControlList": { + "shape": "S34" + }, + "Tagging": { + "shape": "Sbr" + }, + "UserMetadata": { + "type": "list", + "member": { + "locationName": "MetadataEntry", + "type": "structure", + "members": { + "Name": {}, + "Value": {} + } + } + }, + "StorageClass": {} + } + } + } + } + } + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + }, + "payload": "RestoreRequest" + }, + "output": { + "type": "structure", + "members": { + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + }, + "RestoreOutputPath": { + "location": "header", + "locationName": "x-amz-restore-output-path" + } + } + }, + "alias": "PostObjectRestore" + }, + "SelectObjectContent": { + "http": { + "requestUri": "/{Bucket}/{Key+}?select&select-type=2" + }, + "input": { + "locationName": "SelectObjectContentRequest", + "xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + }, + "type": "structure", + "required": [ + "Bucket", + "Key", + "Expression", + "ExpressionType", + "InputSerialization", + "OutputSerialization" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "Expression": {}, + "ExpressionType": {}, + "RequestProgress": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "InputSerialization": { + "shape": "Sci" + }, + "OutputSerialization": { + "shape": "Scx" + } + } + }, + "output": { + "type": "structure", + "members": { + "Payload": { + "type": "structure", + "members": { + "Records": { + "type": "structure", + "members": { + "Payload": { + "eventpayload": true, + "type": "blob" + } + }, + "event": true + }, + "Stats": { + "type": "structure", + "members": { + "Details": { + "eventpayload": true, + "type": "structure", + "members": { + "BytesScanned": { + "type": "long" + }, + "BytesProcessed": { + "type": "long" + }, + "BytesReturned": { + "type": "long" + } + } + } + }, + "event": true + }, + "Progress": { + "type": "structure", + "members": { + "Details": { + "eventpayload": true, + "type": "structure", + "members": { + "BytesScanned": { + "type": "long" + }, + "BytesProcessed": { + "type": "long" + }, + "BytesReturned": { + "type": "long" + } + } + } + }, + "event": true + }, + "Cont": { + "type": "structure", + "members": {}, + "event": true + }, + "End": { + "type": "structure", + "members": {}, + "event": true + } + }, + "eventstream": true + } + }, + "payload": "Payload" + } + }, + "UploadPart": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "PartNumber", + "UploadId" + ], + "members": { + "Body": { + "streaming": true, + "type": "blob" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "long" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "PartNumber": { + "location": "querystring", + "locationName": "partNumber", + "type": "integer" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + }, + "payload": "Body" + }, + "output": { + "type": "structure", + "members": { + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + } + } + }, + "UploadPartCopy": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key+}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "CopySource", + "Key", + "PartNumber", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CopySource": { + "location": "header", + "locationName": "x-amz-copy-source" + }, + "CopySourceIfMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-modified-since", + "type": "timestamp" + }, + "CopySourceIfNoneMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-unmodified-since", + "type": "timestamp" + }, + "CopySourceRange": { + "location": "header", + "locationName": "x-amz-copy-source-range" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "PartNumber": { + "location": "querystring", + "locationName": "partNumber", + "type": "integer" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "shape": "S19", + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "CopySourceSSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey": { + "shape": "S1c", + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + }, + "RequestPayer": { + "location": "header", + "locationName": "x-amz-request-payer" + } + } + }, + "output": { + "type": "structure", + "members": { + "CopySourceVersionId": { + "location": "header", + "locationName": "x-amz-copy-source-version-id" + }, + "CopyPartResult": { + "type": "structure", + "members": { + "ETag": {}, + "LastModified": { + "type": "timestamp" + } + } + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId": { + "shape": "Sj", + "location": "header", + "locationName": "x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged": { + "location": "header", + "locationName": "x-amz-request-charged" + } + }, + "payload": "CopyPartResult" + } + } + }, + "shapes": { + "Sj": { + "type": "string", + "sensitive": true + }, + "S11": { + "type": "map", + "key": {}, + "value": {} + }, + "S19": { + "type": "blob", + "sensitive": true + }, + "S1c": { + "type": "blob", + "sensitive": true + }, + "S1g": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "S31": { + "type": "structure", + "members": { + "DisplayName": {}, + "ID": {} + } + }, + "S34": { + "type": "list", + "member": { + "locationName": "Grant", + "type": "structure", + "members": { + "Grantee": { + "shape": "S36" + }, + "Permission": {} + } + } + }, + "S36": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "DisplayName": {}, + "EmailAddress": {}, + "ID": {}, + "Type": { + "locationName": "xsi:type", + "xmlAttribute": true + }, + "URI": {} + }, + "xmlNamespace": { + "prefix": "xsi", + "uri": "http://www.w3.org/2001/XMLSchema-instance" + } + }, + "S3d": { + "type": "structure", + "required": [ + "Id", + "StorageClassAnalysis" + ], + "members": { + "Id": {}, + "Filter": { + "type": "structure", + "members": { + "Prefix": {}, + "Tag": { + "shape": "S3g" + }, + "And": { + "type": "structure", + "members": { + "Prefix": {}, + "Tags": { + "shape": "S3j", + "flattened": true, + "locationName": "Tag" + } + } + } + } + }, + "StorageClassAnalysis": { + "type": "structure", + "members": { + "DataExport": { + "type": "structure", + "required": [ + "OutputSchemaVersion", + "Destination" + ], + "members": { + "OutputSchemaVersion": {}, + "Destination": { + "type": "structure", + "required": [ + "S3BucketDestination" + ], + "members": { + "S3BucketDestination": { + "type": "structure", + "required": [ + "Format", + "Bucket" + ], + "members": { + "Format": {}, + "BucketAccountId": {}, + "Bucket": {}, + "Prefix": {} + } + } + } + } + } + } + } + } + } + }, + "S3g": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + }, + "S3j": { + "type": "list", + "member": { + "shape": "S3g", + "locationName": "Tag" + } + }, + "S3t": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AllowedMethods", + "AllowedOrigins" + ], + "members": { + "AllowedHeaders": { + "locationName": "AllowedHeader", + "type": "list", + "member": {}, + "flattened": true + }, + "AllowedMethods": { + "locationName": "AllowedMethod", + "type": "list", + "member": {}, + "flattened": true + }, + "AllowedOrigins": { + "locationName": "AllowedOrigin", + "type": "list", + "member": {}, + "flattened": true + }, + "ExposeHeaders": { + "locationName": "ExposeHeader", + "type": "list", + "member": {}, + "flattened": true + }, + "MaxAgeSeconds": { + "type": "integer" + } + } + }, + "flattened": true + }, + "S46": { + "type": "structure", + "required": [ + "Rules" + ], + "members": { + "Rules": { + "locationName": "Rule", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApplyServerSideEncryptionByDefault": { + "type": "structure", + "required": [ + "SSEAlgorithm" + ], + "members": { + "SSEAlgorithm": {}, + "KMSMasterKeyID": { + "shape": "Sj" + } + } + } + } + }, + "flattened": true + } + } + }, + "S4c": { + "type": "structure", + "required": [ + "Destination", + "IsEnabled", + "Id", + "IncludedObjectVersions", + "Schedule" + ], + "members": { + "Destination": { + "type": "structure", + "required": [ + "S3BucketDestination" + ], + "members": { + "S3BucketDestination": { + "type": "structure", + "required": [ + "Bucket", + "Format" + ], + "members": { + "AccountId": {}, + "Bucket": {}, + "Format": {}, + "Prefix": {}, + "Encryption": { + "type": "structure", + "members": { + "SSES3": { + "locationName": "SSE-S3", + "type": "structure", + "members": {} + }, + "SSEKMS": { + "locationName": "SSE-KMS", + "type": "structure", + "required": [ + "KeyId" + ], + "members": { + "KeyId": { + "shape": "Sj" + } + } + } + } + } + } + } + } + }, + "IsEnabled": { + "type": "boolean" + }, + "Filter": { + "type": "structure", + "required": [ + "Prefix" + ], + "members": { + "Prefix": {} + } + }, + "Id": {}, + "IncludedObjectVersions": {}, + "OptionalFields": { + "type": "list", + "member": { + "locationName": "Field" + } + }, + "Schedule": { + "type": "structure", + "required": [ + "Frequency" + ], + "members": { + "Frequency": {} + } + } + } + }, + "S4s": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Prefix", + "Status" + ], + "members": { + "Expiration": { + "shape": "S4u" + }, + "ID": {}, + "Prefix": {}, + "Status": {}, + "Transition": { + "shape": "S4z" + }, + "NoncurrentVersionTransition": { + "shape": "S51" + }, + "NoncurrentVersionExpiration": { + "shape": "S52" + }, + "AbortIncompleteMultipartUpload": { + "shape": "S53" + } + } + }, + "flattened": true + }, + "S4u": { + "type": "structure", + "members": { + "Date": { + "shape": "S4v" + }, + "Days": { + "type": "integer" + }, + "ExpiredObjectDeleteMarker": { + "type": "boolean" + } + } + }, + "S4v": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "S4z": { + "type": "structure", + "members": { + "Date": { + "shape": "S4v" + }, + "Days": { + "type": "integer" + }, + "StorageClass": {} + } + }, + "S51": { + "type": "structure", + "members": { + "NoncurrentDays": { + "type": "integer" + }, + "StorageClass": {} + } + }, + "S52": { + "type": "structure", + "members": { + "NoncurrentDays": { + "type": "integer" + } + } + }, + "S53": { + "type": "structure", + "members": { + "DaysAfterInitiation": { + "type": "integer" + } + } + }, + "S57": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Expiration": { + "shape": "S4u" + }, + "ID": {}, + "Prefix": { + "deprecated": true + }, + "Filter": { + "type": "structure", + "members": { + "Prefix": {}, + "Tag": { + "shape": "S3g" + }, + "And": { + "type": "structure", + "members": { + "Prefix": {}, + "Tags": { + "shape": "S3j", + "flattened": true, + "locationName": "Tag" + } + } + } + } + }, + "Status": {}, + "Transitions": { + "locationName": "Transition", + "type": "list", + "member": { + "shape": "S4z" + }, + "flattened": true + }, + "NoncurrentVersionTransitions": { + "locationName": "NoncurrentVersionTransition", + "type": "list", + "member": { + "shape": "S51" + }, + "flattened": true + }, + "NoncurrentVersionExpiration": { + "shape": "S52" + }, + "AbortIncompleteMultipartUpload": { + "shape": "S53" + } + } + }, + "flattened": true + }, + "S5h": { + "type": "structure", + "required": [ + "TargetBucket", + "TargetPrefix" + ], + "members": { + "TargetBucket": {}, + "TargetGrants": { + "type": "list", + "member": { + "locationName": "Grant", + "type": "structure", + "members": { + "Grantee": { + "shape": "S36" + }, + "Permission": {} + } + } + }, + "TargetPrefix": {} + } + }, + "S5p": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "Filter": { + "type": "structure", + "members": { + "Prefix": {}, + "Tag": { + "shape": "S3g" + }, + "And": { + "type": "structure", + "members": { + "Prefix": {}, + "Tags": { + "shape": "S3j", + "flattened": true, + "locationName": "Tag" + } + } + } + } + } + } + }, + "S5s": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "S5t": { + "type": "structure", + "members": { + "TopicConfiguration": { + "type": "structure", + "members": { + "Id": {}, + "Events": { + "shape": "S5w", + "locationName": "Event" + }, + "Event": { + "deprecated": true + }, + "Topic": {} + } + }, + "QueueConfiguration": { + "type": "structure", + "members": { + "Id": {}, + "Event": { + "deprecated": true + }, + "Events": { + "shape": "S5w", + "locationName": "Event" + }, + "Queue": {} + } + }, + "CloudFunctionConfiguration": { + "type": "structure", + "members": { + "Id": {}, + "Event": { + "deprecated": true + }, + "Events": { + "shape": "S5w", + "locationName": "Event" + }, + "CloudFunction": {}, + "InvocationRole": {} + } + } + } + }, + "S5w": { + "type": "list", + "member": {}, + "flattened": true + }, + "S64": { + "type": "structure", + "members": { + "TopicConfigurations": { + "locationName": "TopicConfiguration", + "type": "list", + "member": { + "type": "structure", + "required": [ + "TopicArn", + "Events" + ], + "members": { + "Id": {}, + "TopicArn": { + "locationName": "Topic" + }, + "Events": { + "shape": "S5w", + "locationName": "Event" + }, + "Filter": { + "shape": "S67" + } + } + }, + "flattened": true + }, + "QueueConfigurations": { + "locationName": "QueueConfiguration", + "type": "list", + "member": { + "type": "structure", + "required": [ + "QueueArn", + "Events" + ], + "members": { + "Id": {}, + "QueueArn": { + "locationName": "Queue" + }, + "Events": { + "shape": "S5w", + "locationName": "Event" + }, + "Filter": { + "shape": "S67" + } + } + }, + "flattened": true + }, + "LambdaFunctionConfigurations": { + "locationName": "CloudFunctionConfiguration", + "type": "list", + "member": { + "type": "structure", + "required": [ + "LambdaFunctionArn", + "Events" + ], + "members": { + "Id": {}, + "LambdaFunctionArn": { + "locationName": "CloudFunction" + }, + "Events": { + "shape": "S5w", + "locationName": "Event" + }, + "Filter": { + "shape": "S67" + } + } + }, + "flattened": true + } + } + }, + "S67": { + "type": "structure", + "members": { + "Key": { + "locationName": "S3Key", + "type": "structure", + "members": { + "FilterRules": { + "locationName": "FilterRule", + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Value": {} + } + }, + "flattened": true + } + } + } + } + }, + "S6r": { + "type": "structure", + "required": [ + "Role", + "Rules" + ], + "members": { + "Role": {}, + "Rules": { + "locationName": "Rule", + "type": "list", + "member": { + "type": "structure", + "required": [ + "Status", + "Destination" + ], + "members": { + "ID": {}, + "Priority": { + "type": "integer" + }, + "Prefix": { + "deprecated": true + }, + "Filter": { + "type": "structure", + "members": { + "Prefix": {}, + "Tag": { + "shape": "S3g" + }, + "And": { + "type": "structure", + "members": { + "Prefix": {}, + "Tags": { + "shape": "S3j", + "flattened": true, + "locationName": "Tag" + } + } + } + } + }, + "Status": {}, + "SourceSelectionCriteria": { + "type": "structure", + "members": { + "SseKmsEncryptedObjects": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": {} + } + } + } + }, + "Destination": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": {}, + "Account": {}, + "StorageClass": {}, + "AccessControlTranslation": { + "type": "structure", + "required": [ + "Owner" + ], + "members": { + "Owner": {} + } + }, + "EncryptionConfiguration": { + "type": "structure", + "members": { + "ReplicaKmsKeyID": {} + } + } + } + }, + "DeleteMarkerReplication": { + "type": "structure", + "members": { + "Status": {} + } + } + } + }, + "flattened": true + } + } + }, + "S7k": { + "type": "structure", + "required": [ + "HostName" + ], + "members": { + "HostName": {}, + "Protocol": {} + } + }, + "S7n": { + "type": "structure", + "required": [ + "Suffix" + ], + "members": { + "Suffix": {} + } + }, + "S7p": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {} + } + }, + "S7q": { + "type": "list", + "member": { + "locationName": "RoutingRule", + "type": "structure", + "required": [ + "Redirect" + ], + "members": { + "Condition": { + "type": "structure", + "members": { + "HttpErrorCodeReturnedEquals": {}, + "KeyPrefixEquals": {} + } + }, + "Redirect": { + "type": "structure", + "members": { + "HostName": {}, + "HttpRedirectCode": {}, + "Protocol": {}, + "ReplaceKeyPrefixWith": {}, + "ReplaceKeyWith": {} + } + } + } + } + }, + "S8p": { + "type": "structure", + "members": { + "Status": {} + } + }, + "S8s": { + "type": "structure", + "members": { + "ObjectLockEnabled": {}, + "Rule": { + "type": "structure", + "members": { + "DefaultRetention": { + "type": "structure", + "members": { + "Mode": {}, + "Days": { + "type": "integer" + }, + "Years": { + "type": "integer" + } + } + } + } + } + } + }, + "S90": { + "type": "structure", + "members": { + "Mode": {}, + "RetainUntilDate": { + "shape": "S4v" + } + } + }, + "S97": { + "type": "structure", + "members": { + "BlockPublicAcls": { + "locationName": "BlockPublicAcls", + "type": "boolean" + }, + "IgnorePublicAcls": { + "locationName": "IgnorePublicAcls", + "type": "boolean" + }, + "BlockPublicPolicy": { + "locationName": "BlockPublicPolicy", + "type": "boolean" + }, + "RestrictPublicBuckets": { + "locationName": "RestrictPublicBuckets", + "type": "boolean" + } + } + }, + "Sa4": { + "type": "structure", + "members": { + "ID": {}, + "DisplayName": {} + } + }, + "Sa5": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Prefix": {} + } + }, + "flattened": true + }, + "San": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "LastModified": { + "type": "timestamp" + }, + "ETag": {}, + "Size": { + "type": "integer" + }, + "StorageClass": {}, + "Owner": { + "shape": "S31" + } + } + }, + "flattened": true + }, + "Sb5": { + "type": "structure", + "members": { + "Grants": { + "shape": "S34", + "locationName": "AccessControlList" + }, + "Owner": { + "shape": "S31" + } + } + }, + "Sbr": { + "type": "structure", + "required": [ + "TagSet" + ], + "members": { + "TagSet": { + "shape": "S3j" + } + } + }, + "Sci": { + "type": "structure", + "members": { + "CSV": { + "type": "structure", + "members": { + "FileHeaderInfo": {}, + "Comments": {}, + "QuoteEscapeCharacter": {}, + "RecordDelimiter": {}, + "FieldDelimiter": {}, + "QuoteCharacter": {}, + "AllowQuotedRecordDelimiter": { + "type": "boolean" + } + } + }, + "CompressionType": {}, + "JSON": { + "type": "structure", + "members": { + "Type": {} + } + }, + "Parquet": { + "type": "structure", + "members": {} + } + } + }, + "Scx": { + "type": "structure", + "members": { + "CSV": { + "type": "structure", + "members": { + "QuoteFields": {}, + "QuoteEscapeCharacter": {}, + "RecordDelimiter": {}, + "FieldDelimiter": {}, + "QuoteCharacter": {} + } + }, + "JSON": { + "type": "structure", + "members": { + "RecordDelimiter": {} + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/s3-2006-03-01.paginators.json b/node_modules/aws-sdk/apis/s3-2006-03-01.paginators.json new file mode 100644 index 0000000..6d24346 --- /dev/null +++ b/node_modules/aws-sdk/apis/s3-2006-03-01.paginators.json @@ -0,0 +1,66 @@ +{ + "pagination": { + "ListBuckets": { + "result_key": "Buckets" + }, + "ListMultipartUploads": { + "input_token": [ + "KeyMarker", + "UploadIdMarker" + ], + "limit_key": "MaxUploads", + "more_results": "IsTruncated", + "output_token": [ + "NextKeyMarker", + "NextUploadIdMarker" + ], + "result_key": [ + "Uploads", + "CommonPrefixes" + ] + }, + "ListObjectVersions": { + "input_token": [ + "KeyMarker", + "VersionIdMarker" + ], + "limit_key": "MaxKeys", + "more_results": "IsTruncated", + "output_token": [ + "NextKeyMarker", + "NextVersionIdMarker" + ], + "result_key": [ + "Versions", + "DeleteMarkers", + "CommonPrefixes" + ] + }, + "ListObjects": { + "input_token": "Marker", + "limit_key": "MaxKeys", + "more_results": "IsTruncated", + "output_token": "NextMarker || Contents[-1].Key", + "result_key": [ + "Contents", + "CommonPrefixes" + ] + }, + "ListObjectsV2": { + "input_token": "ContinuationToken", + "limit_key": "MaxKeys", + "output_token": "NextContinuationToken", + "result_key": [ + "Contents", + "CommonPrefixes" + ] + }, + "ListParts": { + "input_token": "PartNumberMarker", + "limit_key": "MaxParts", + "more_results": "IsTruncated", + "output_token": "NextPartNumberMarker", + "result_key": "Parts" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/s3-2006-03-01.waiters2.json b/node_modules/aws-sdk/apis/s3-2006-03-01.waiters2.json new file mode 100644 index 0000000..b508a8f --- /dev/null +++ b/node_modules/aws-sdk/apis/s3-2006-03-01.waiters2.json @@ -0,0 +1,73 @@ +{ + "version": 2, + "waiters": { + "BucketExists": { + "delay": 5, + "operation": "HeadBucket", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "expected": 301, + "matcher": "status", + "state": "success" + }, + { + "expected": 403, + "matcher": "status", + "state": "success" + }, + { + "expected": 404, + "matcher": "status", + "state": "retry" + } + ] + }, + "BucketNotExists": { + "delay": 5, + "operation": "HeadBucket", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 404, + "matcher": "status", + "state": "success" + } + ] + }, + "ObjectExists": { + "delay": 5, + "operation": "HeadObject", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "expected": 404, + "matcher": "status", + "state": "retry" + } + ] + }, + "ObjectNotExists": { + "delay": 5, + "operation": "HeadObject", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 404, + "matcher": "status", + "state": "success" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/s3control-2018-08-20.examples.json b/node_modules/aws-sdk/apis/s3control-2018-08-20.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/s3control-2018-08-20.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json b/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json new file mode 100644 index 0000000..104ed12 --- /dev/null +++ b/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json @@ -0,0 +1,592 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-08-20", + "endpointPrefix": "s3-control", + "protocol": "rest-xml", + "serviceFullName": "AWS S3 Control", + "serviceId": "S3 Control", + "signatureVersion": "s3v4", + "signingName": "s3", + "uid": "s3control-2018-08-20" + }, + "operations": { + "CreateJob": { + "http": { + "requestUri": "/v20180820/jobs" + }, + "input": { + "locationName": "CreateJobRequest", + "xmlNamespace": { + "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" + }, + "type": "structure", + "required": [ + "AccountId", + "Operation", + "Report", + "ClientRequestToken", + "Manifest", + "Priority", + "RoleArn" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "ConfirmationRequired": { + "type": "boolean" + }, + "Operation": { + "shape": "S4" + }, + "Report": { + "shape": "S12" + }, + "ClientRequestToken": { + "idempotencyToken": true + }, + "Manifest": { + "shape": "S17" + }, + "Description": {}, + "Priority": { + "type": "integer" + }, + "RoleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + } + }, + "DeletePublicAccessBlock": { + "http": { + "method": "DELETE", + "requestUri": "/v20180820/configuration/publicAccessBlock" + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + } + } + } + }, + "DescribeJob": { + "http": { + "method": "GET", + "requestUri": "/v20180820/jobs/{id}" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "JobId" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "JobId": { + "location": "uri", + "locationName": "id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Job": { + "type": "structure", + "members": { + "JobId": {}, + "ConfirmationRequired": { + "type": "boolean" + }, + "Description": {}, + "JobArn": {}, + "Status": {}, + "Manifest": { + "shape": "S17" + }, + "Operation": { + "shape": "S4" + }, + "Priority": { + "type": "integer" + }, + "ProgressSummary": { + "shape": "S1q" + }, + "StatusUpdateReason": {}, + "FailureReasons": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FailureCode": {}, + "FailureReason": {} + } + } + }, + "Report": { + "shape": "S12" + }, + "CreationTime": { + "type": "timestamp" + }, + "TerminationDate": { + "type": "timestamp" + }, + "RoleArn": {}, + "SuspendedDate": { + "type": "timestamp" + }, + "SuspendedCause": {} + } + } + } + } + }, + "GetPublicAccessBlock": { + "http": { + "method": "GET", + "requestUri": "/v20180820/configuration/publicAccessBlock" + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicAccessBlockConfiguration": { + "shape": "S25" + } + }, + "payload": "PublicAccessBlockConfiguration" + } + }, + "ListJobs": { + "http": { + "method": "GET", + "requestUri": "/v20180820/jobs" + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "JobStatuses": { + "location": "querystring", + "locationName": "jobStatuses", + "type": "list", + "member": {} + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "Jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobId": {}, + "Description": {}, + "Operation": {}, + "Priority": { + "type": "integer" + }, + "Status": {}, + "CreationTime": { + "type": "timestamp" + }, + "TerminationDate": { + "type": "timestamp" + }, + "ProgressSummary": { + "shape": "S1q" + } + } + } + } + } + } + }, + "PutPublicAccessBlock": { + "http": { + "method": "PUT", + "requestUri": "/v20180820/configuration/publicAccessBlock" + }, + "input": { + "type": "structure", + "required": [ + "PublicAccessBlockConfiguration", + "AccountId" + ], + "members": { + "PublicAccessBlockConfiguration": { + "shape": "S25", + "locationName": "PublicAccessBlockConfiguration", + "xmlNamespace": { + "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" + } + }, + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + } + }, + "payload": "PublicAccessBlockConfiguration" + } + }, + "UpdateJobPriority": { + "http": { + "requestUri": "/v20180820/jobs/{id}/priority" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "JobId", + "Priority" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "JobId": { + "location": "uri", + "locationName": "id" + }, + "Priority": { + "location": "querystring", + "locationName": "priority", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "JobId", + "Priority" + ], + "members": { + "JobId": {}, + "Priority": { + "type": "integer" + } + } + } + }, + "UpdateJobStatus": { + "http": { + "requestUri": "/v20180820/jobs/{id}/status" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "JobId", + "RequestedJobStatus" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "JobId": { + "location": "uri", + "locationName": "id" + }, + "RequestedJobStatus": { + "location": "querystring", + "locationName": "requestedJobStatus" + }, + "StatusUpdateReason": { + "location": "querystring", + "locationName": "statusUpdateReason" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {}, + "Status": {}, + "StatusUpdateReason": {} + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "LambdaInvoke": { + "type": "structure", + "members": { + "FunctionArn": {} + } + }, + "S3PutObjectCopy": { + "type": "structure", + "members": { + "TargetResource": {}, + "CannedAccessControlList": {}, + "AccessControlGrants": { + "shape": "Sa" + }, + "MetadataDirective": {}, + "ModifiedSinceConstraint": { + "type": "timestamp" + }, + "NewObjectMetadata": { + "type": "structure", + "members": { + "CacheControl": {}, + "ContentDisposition": {}, + "ContentEncoding": {}, + "ContentLanguage": {}, + "UserMetadata": { + "type": "map", + "key": {}, + "value": {} + }, + "ContentLength": { + "type": "long" + }, + "ContentMD5": {}, + "ContentType": {}, + "HttpExpiresDate": { + "type": "timestamp" + }, + "RequesterCharged": { + "type": "boolean" + }, + "SSEAlgorithm": {} + } + }, + "NewObjectTagging": { + "shape": "Sn" + }, + "RedirectLocation": {}, + "RequesterPays": { + "type": "boolean" + }, + "StorageClass": {}, + "UnModifiedSinceConstraint": { + "type": "timestamp" + }, + "SSEAwsKmsKeyId": {}, + "TargetKeyPrefix": {}, + "ObjectLockLegalHoldStatus": {}, + "ObjectLockMode": {}, + "ObjectLockRetainUntilDate": { + "type": "timestamp" + } + } + }, + "S3PutObjectAcl": { + "type": "structure", + "members": { + "AccessControlPolicy": { + "type": "structure", + "members": { + "AccessControlList": { + "type": "structure", + "required": [ + "Owner" + ], + "members": { + "Owner": { + "type": "structure", + "members": { + "ID": {}, + "DisplayName": {} + } + }, + "Grants": { + "shape": "Sa" + } + } + }, + "CannedAccessControlList": {} + } + } + } + }, + "S3PutObjectTagging": { + "type": "structure", + "members": { + "TagSet": { + "shape": "Sn" + } + } + }, + "S3InitiateRestoreObject": { + "type": "structure", + "members": { + "ExpirationInDays": { + "type": "integer" + }, + "GlacierJobTier": {} + } + } + } + }, + "Sa": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Grantee": { + "type": "structure", + "members": { + "TypeIdentifier": {}, + "Identifier": {}, + "DisplayName": {} + } + }, + "Permission": {} + } + } + }, + "Sn": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S12": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Bucket": {}, + "Format": {}, + "Enabled": { + "type": "boolean" + }, + "Prefix": {}, + "ReportScope": {} + } + }, + "S17": { + "type": "structure", + "required": [ + "Spec", + "Location" + ], + "members": { + "Spec": { + "type": "structure", + "required": [ + "Format" + ], + "members": { + "Format": {}, + "Fields": { + "type": "list", + "member": {} + } + } + }, + "Location": { + "type": "structure", + "required": [ + "ObjectArn", + "ETag" + ], + "members": { + "ObjectArn": {}, + "ObjectVersionId": {}, + "ETag": {} + } + } + } + }, + "S1q": { + "type": "structure", + "members": { + "TotalNumberOfTasks": { + "type": "long" + }, + "NumberOfTasksSucceeded": { + "type": "long" + }, + "NumberOfTasksFailed": { + "type": "long" + } + } + }, + "S25": { + "type": "structure", + "members": { + "BlockPublicAcls": { + "locationName": "BlockPublicAcls", + "type": "boolean" + }, + "IgnorePublicAcls": { + "locationName": "IgnorePublicAcls", + "type": "boolean" + }, + "BlockPublicPolicy": { + "locationName": "BlockPublicPolicy", + "type": "boolean" + }, + "RestrictPublicBuckets": { + "locationName": "RestrictPublicBuckets", + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/s3control-2018-08-20.paginators.json b/node_modules/aws-sdk/apis/s3control-2018-08-20.paginators.json new file mode 100644 index 0000000..8861104 --- /dev/null +++ b/node_modules/aws-sdk/apis/s3control-2018-08-20.paginators.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/sagemaker-2017-07-24.examples.json b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json new file mode 100644 index 0000000..cdb6f90 --- /dev/null +++ b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json @@ -0,0 +1,4024 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-07-24", + "endpointPrefix": "api.sagemaker", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "SageMaker", + "serviceFullName": "Amazon SageMaker Service", + "serviceId": "SageMaker", + "signatureVersion": "v4", + "signingName": "sagemaker", + "targetPrefix": "SageMaker", + "uid": "sagemaker-2017-07-24" + }, + "operations": { + "AddTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S3" + } + } + } + }, + "CreateAlgorithm": { + "input": { + "type": "structure", + "required": [ + "AlgorithmName", + "TrainingSpecification" + ], + "members": { + "AlgorithmName": {}, + "AlgorithmDescription": {}, + "TrainingSpecification": { + "shape": "Sb" + }, + "InferenceSpecification": { + "shape": "S17" + }, + "ValidationSpecification": { + "shape": "S1j" + }, + "CertifyForMarketplace": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "AlgorithmArn" + ], + "members": { + "AlgorithmArn": {} + } + } + }, + "CreateCodeRepository": { + "input": { + "type": "structure", + "required": [ + "CodeRepositoryName", + "GitConfig" + ], + "members": { + "CodeRepositoryName": {}, + "GitConfig": { + "shape": "S2t" + } + } + }, + "output": { + "type": "structure", + "required": [ + "CodeRepositoryArn" + ], + "members": { + "CodeRepositoryArn": {} + } + } + }, + "CreateCompilationJob": { + "input": { + "type": "structure", + "required": [ + "CompilationJobName", + "RoleArn", + "InputConfig", + "OutputConfig", + "StoppingCondition" + ], + "members": { + "CompilationJobName": {}, + "RoleArn": {}, + "InputConfig": { + "shape": "S30" + }, + "OutputConfig": { + "shape": "S33" + }, + "StoppingCondition": { + "shape": "S27" + } + } + }, + "output": { + "type": "structure", + "required": [ + "CompilationJobArn" + ], + "members": { + "CompilationJobArn": {} + } + } + }, + "CreateEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName", + "EndpointConfigName" + ], + "members": { + "EndpointName": {}, + "EndpointConfigName": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + } + }, + "CreateEndpointConfig": { + "input": { + "type": "structure", + "required": [ + "EndpointConfigName", + "ProductionVariants" + ], + "members": { + "EndpointConfigName": {}, + "ProductionVariants": { + "shape": "S3d" + }, + "Tags": { + "shape": "S3" + }, + "KmsKeyId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "EndpointConfigArn" + ], + "members": { + "EndpointConfigArn": {} + } + } + }, + "CreateHyperParameterTuningJob": { + "input": { + "type": "structure", + "required": [ + "HyperParameterTuningJobName", + "HyperParameterTuningJobConfig", + "TrainingJobDefinition" + ], + "members": { + "HyperParameterTuningJobName": {}, + "HyperParameterTuningJobConfig": { + "shape": "S3o" + }, + "TrainingJobDefinition": { + "shape": "S42" + }, + "WarmStartConfig": { + "shape": "S4b" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HyperParameterTuningJobArn" + ], + "members": { + "HyperParameterTuningJobArn": {} + } + } + }, + "CreateLabelingJob": { + "input": { + "type": "structure", + "required": [ + "LabelingJobName", + "LabelAttributeName", + "InputConfig", + "OutputConfig", + "RoleArn", + "HumanTaskConfig" + ], + "members": { + "LabelingJobName": {}, + "LabelAttributeName": {}, + "InputConfig": { + "shape": "S4k" + }, + "OutputConfig": { + "shape": "S4q" + }, + "RoleArn": {}, + "LabelCategoryConfigS3Uri": {}, + "StoppingConditions": { + "shape": "S4r" + }, + "LabelingJobAlgorithmsConfig": { + "shape": "S4u" + }, + "HumanTaskConfig": { + "shape": "S4y" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "LabelingJobArn" + ], + "members": { + "LabelingJobArn": {} + } + } + }, + "CreateModel": { + "input": { + "type": "structure", + "required": [ + "ModelName", + "ExecutionRoleArn" + ], + "members": { + "ModelName": {}, + "PrimaryContainer": { + "shape": "S5j" + }, + "Containers": { + "shape": "S5n" + }, + "ExecutionRoleArn": {}, + "Tags": { + "shape": "S3" + }, + "VpcConfig": { + "shape": "S46" + }, + "EnableNetworkIsolation": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ModelArn" + ], + "members": { + "ModelArn": {} + } + } + }, + "CreateModelPackage": { + "input": { + "type": "structure", + "required": [ + "ModelPackageName" + ], + "members": { + "ModelPackageName": {}, + "ModelPackageDescription": {}, + "InferenceSpecification": { + "shape": "S17" + }, + "ValidationSpecification": { + "shape": "S5q" + }, + "SourceAlgorithmSpecification": { + "shape": "S5t" + }, + "CertifyForMarketplace": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ModelPackageArn" + ], + "members": { + "ModelPackageArn": {} + } + } + }, + "CreateNotebookInstance": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceName", + "InstanceType", + "RoleArn" + ], + "members": { + "NotebookInstanceName": {}, + "InstanceType": {}, + "SubnetId": {}, + "SecurityGroupIds": { + "shape": "S61" + }, + "RoleArn": {}, + "KmsKeyId": {}, + "Tags": { + "shape": "S3" + }, + "LifecycleConfigName": {}, + "DirectInternetAccess": {}, + "VolumeSizeInGB": { + "type": "integer" + }, + "AcceleratorTypes": { + "shape": "S65" + }, + "DefaultCodeRepository": {}, + "AdditionalCodeRepositories": { + "shape": "S68" + }, + "RootAccess": {} + } + }, + "output": { + "type": "structure", + "members": { + "NotebookInstanceArn": {} + } + } + }, + "CreateNotebookInstanceLifecycleConfig": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceLifecycleConfigName" + ], + "members": { + "NotebookInstanceLifecycleConfigName": {}, + "OnCreate": { + "shape": "S6d" + }, + "OnStart": { + "shape": "S6d" + } + } + }, + "output": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigArn": {} + } + } + }, + "CreatePresignedNotebookInstanceUrl": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceName" + ], + "members": { + "NotebookInstanceName": {}, + "SessionExpirationDurationInSeconds": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AuthorizedUrl": {} + } + } + }, + "CreateTrainingJob": { + "input": { + "type": "structure", + "required": [ + "TrainingJobName", + "AlgorithmSpecification", + "RoleArn", + "OutputDataConfig", + "ResourceConfig", + "StoppingCondition" + ], + "members": { + "TrainingJobName": {}, + "HyperParameters": { + "shape": "S1o" + }, + "AlgorithmSpecification": { + "shape": "S6o" + }, + "RoleArn": {}, + "InputDataConfig": { + "shape": "S1q" + }, + "OutputDataConfig": { + "shape": "S22" + }, + "ResourceConfig": { + "shape": "S24" + }, + "VpcConfig": { + "shape": "S46" + }, + "StoppingCondition": { + "shape": "S27" + }, + "Tags": { + "shape": "S3" + }, + "EnableNetworkIsolation": { + "type": "boolean" + }, + "EnableInterContainerTrafficEncryption": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TrainingJobArn" + ], + "members": { + "TrainingJobArn": {} + } + } + }, + "CreateTransformJob": { + "input": { + "type": "structure", + "required": [ + "TransformJobName", + "ModelName", + "TransformInput", + "TransformOutput", + "TransformResources" + ], + "members": { + "TransformJobName": {}, + "ModelName": {}, + "MaxConcurrentTransforms": { + "type": "integer" + }, + "MaxPayloadInMB": { + "type": "integer" + }, + "BatchStrategy": {}, + "Environment": { + "shape": "S2d" + }, + "TransformInput": { + "shape": "S2g" + }, + "TransformOutput": { + "shape": "S2k" + }, + "TransformResources": { + "shape": "S2n" + }, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TransformJobArn" + ], + "members": { + "TransformJobArn": {} + } + } + }, + "CreateWorkteam": { + "input": { + "type": "structure", + "required": [ + "WorkteamName", + "MemberDefinitions", + "Description" + ], + "members": { + "WorkteamName": {}, + "MemberDefinitions": { + "shape": "S6x" + }, + "Description": {}, + "Tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "WorkteamArn": {} + } + } + }, + "DeleteAlgorithm": { + "input": { + "type": "structure", + "required": [ + "AlgorithmName" + ], + "members": { + "AlgorithmName": {} + } + } + }, + "DeleteCodeRepository": { + "input": { + "type": "structure", + "required": [ + "CodeRepositoryName" + ], + "members": { + "CodeRepositoryName": {} + } + } + }, + "DeleteEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName" + ], + "members": { + "EndpointName": {} + } + } + }, + "DeleteEndpointConfig": { + "input": { + "type": "structure", + "required": [ + "EndpointConfigName" + ], + "members": { + "EndpointConfigName": {} + } + } + }, + "DeleteModel": { + "input": { + "type": "structure", + "required": [ + "ModelName" + ], + "members": { + "ModelName": {} + } + } + }, + "DeleteModelPackage": { + "input": { + "type": "structure", + "required": [ + "ModelPackageName" + ], + "members": { + "ModelPackageName": {} + } + } + }, + "DeleteNotebookInstance": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceName" + ], + "members": { + "NotebookInstanceName": {} + } + } + }, + "DeleteNotebookInstanceLifecycleConfig": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceLifecycleConfigName" + ], + "members": { + "NotebookInstanceLifecycleConfigName": {} + } + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteWorkteam": { + "input": { + "type": "structure", + "required": [ + "WorkteamName" + ], + "members": { + "WorkteamName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Success" + ], + "members": { + "Success": { + "type": "boolean" + } + } + } + }, + "DescribeAlgorithm": { + "input": { + "type": "structure", + "required": [ + "AlgorithmName" + ], + "members": { + "AlgorithmName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "AlgorithmName", + "AlgorithmArn", + "CreationTime", + "TrainingSpecification", + "AlgorithmStatus", + "AlgorithmStatusDetails" + ], + "members": { + "AlgorithmName": {}, + "AlgorithmArn": {}, + "AlgorithmDescription": {}, + "CreationTime": { + "type": "timestamp" + }, + "TrainingSpecification": { + "shape": "Sb" + }, + "InferenceSpecification": { + "shape": "S17" + }, + "ValidationSpecification": { + "shape": "S1j" + }, + "AlgorithmStatus": {}, + "AlgorithmStatusDetails": { + "type": "structure", + "members": { + "ValidationStatuses": { + "shape": "S7o" + }, + "ImageScanStatuses": { + "shape": "S7o" + } + } + }, + "ProductId": {}, + "CertifyForMarketplace": { + "type": "boolean" + } + } + } + }, + "DescribeCodeRepository": { + "input": { + "type": "structure", + "required": [ + "CodeRepositoryName" + ], + "members": { + "CodeRepositoryName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "CodeRepositoryName", + "CodeRepositoryArn", + "CreationTime", + "LastModifiedTime" + ], + "members": { + "CodeRepositoryName": {}, + "CodeRepositoryArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "GitConfig": { + "shape": "S2t" + } + } + } + }, + "DescribeCompilationJob": { + "input": { + "type": "structure", + "required": [ + "CompilationJobName" + ], + "members": { + "CompilationJobName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "CompilationJobName", + "CompilationJobArn", + "CompilationJobStatus", + "StoppingCondition", + "CreationTime", + "LastModifiedTime", + "FailureReason", + "ModelArtifacts", + "RoleArn", + "InputConfig", + "OutputConfig" + ], + "members": { + "CompilationJobName": {}, + "CompilationJobArn": {}, + "CompilationJobStatus": {}, + "CompilationStartTime": { + "type": "timestamp" + }, + "CompilationEndTime": { + "type": "timestamp" + }, + "StoppingCondition": { + "shape": "S27" + }, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "FailureReason": {}, + "ModelArtifacts": { + "shape": "S80" + }, + "RoleArn": {}, + "InputConfig": { + "shape": "S30" + }, + "OutputConfig": { + "shape": "S33" + } + } + } + }, + "DescribeEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName" + ], + "members": { + "EndpointName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "EndpointName", + "EndpointArn", + "EndpointConfigName", + "EndpointStatus", + "CreationTime", + "LastModifiedTime" + ], + "members": { + "EndpointName": {}, + "EndpointArn": {}, + "EndpointConfigName": {}, + "ProductionVariants": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VariantName" + ], + "members": { + "VariantName": {}, + "DeployedImages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SpecifiedImage": {}, + "ResolvedImage": {}, + "ResolutionTime": { + "type": "timestamp" + } + } + } + }, + "CurrentWeight": { + "type": "float" + }, + "DesiredWeight": { + "type": "float" + }, + "CurrentInstanceCount": { + "type": "integer" + }, + "DesiredInstanceCount": { + "type": "integer" + } + } + } + }, + "EndpointStatus": {}, + "FailureReason": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + } + } + } + }, + "DescribeEndpointConfig": { + "input": { + "type": "structure", + "required": [ + "EndpointConfigName" + ], + "members": { + "EndpointConfigName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "EndpointConfigName", + "EndpointConfigArn", + "ProductionVariants", + "CreationTime" + ], + "members": { + "EndpointConfigName": {}, + "EndpointConfigArn": {}, + "ProductionVariants": { + "shape": "S3d" + }, + "KmsKeyId": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "DescribeHyperParameterTuningJob": { + "input": { + "type": "structure", + "required": [ + "HyperParameterTuningJobName" + ], + "members": { + "HyperParameterTuningJobName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "HyperParameterTuningJobName", + "HyperParameterTuningJobArn", + "HyperParameterTuningJobConfig", + "TrainingJobDefinition", + "HyperParameterTuningJobStatus", + "CreationTime", + "TrainingJobStatusCounters", + "ObjectiveStatusCounters" + ], + "members": { + "HyperParameterTuningJobName": {}, + "HyperParameterTuningJobArn": {}, + "HyperParameterTuningJobConfig": { + "shape": "S3o" + }, + "TrainingJobDefinition": { + "shape": "S42" + }, + "HyperParameterTuningJobStatus": {}, + "CreationTime": { + "type": "timestamp" + }, + "HyperParameterTuningEndTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "TrainingJobStatusCounters": { + "shape": "S8d" + }, + "ObjectiveStatusCounters": { + "shape": "S8f" + }, + "BestTrainingJob": { + "shape": "S8h" + }, + "OverallBestTrainingJob": { + "shape": "S8h" + }, + "WarmStartConfig": { + "shape": "S4b" + }, + "FailureReason": {} + } + } + }, + "DescribeLabelingJob": { + "input": { + "type": "structure", + "required": [ + "LabelingJobName" + ], + "members": { + "LabelingJobName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "LabelingJobStatus", + "LabelCounters", + "CreationTime", + "LastModifiedTime", + "JobReferenceCode", + "LabelingJobName", + "LabelingJobArn", + "InputConfig", + "OutputConfig", + "RoleArn", + "HumanTaskConfig" + ], + "members": { + "LabelingJobStatus": {}, + "LabelCounters": { + "shape": "S8p" + }, + "FailureReason": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "JobReferenceCode": {}, + "LabelingJobName": {}, + "LabelingJobArn": {}, + "LabelAttributeName": {}, + "InputConfig": { + "shape": "S4k" + }, + "OutputConfig": { + "shape": "S4q" + }, + "RoleArn": {}, + "LabelCategoryConfigS3Uri": {}, + "StoppingConditions": { + "shape": "S4r" + }, + "LabelingJobAlgorithmsConfig": { + "shape": "S4u" + }, + "HumanTaskConfig": { + "shape": "S4y" + }, + "Tags": { + "shape": "S3" + }, + "LabelingJobOutput": { + "shape": "S8s" + } + } + } + }, + "DescribeModel": { + "input": { + "type": "structure", + "required": [ + "ModelName" + ], + "members": { + "ModelName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ModelName", + "ExecutionRoleArn", + "CreationTime", + "ModelArn" + ], + "members": { + "ModelName": {}, + "PrimaryContainer": { + "shape": "S5j" + }, + "Containers": { + "shape": "S5n" + }, + "ExecutionRoleArn": {}, + "VpcConfig": { + "shape": "S46" + }, + "CreationTime": { + "type": "timestamp" + }, + "ModelArn": {}, + "EnableNetworkIsolation": { + "type": "boolean" + } + } + } + }, + "DescribeModelPackage": { + "input": { + "type": "structure", + "required": [ + "ModelPackageName" + ], + "members": { + "ModelPackageName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ModelPackageName", + "ModelPackageArn", + "CreationTime", + "ModelPackageStatus", + "ModelPackageStatusDetails" + ], + "members": { + "ModelPackageName": {}, + "ModelPackageArn": {}, + "ModelPackageDescription": {}, + "CreationTime": { + "type": "timestamp" + }, + "InferenceSpecification": { + "shape": "S17" + }, + "SourceAlgorithmSpecification": { + "shape": "S5t" + }, + "ValidationSpecification": { + "shape": "S5q" + }, + "ModelPackageStatus": {}, + "ModelPackageStatusDetails": { + "type": "structure", + "required": [ + "ValidationStatuses" + ], + "members": { + "ValidationStatuses": { + "shape": "S8z" + }, + "ImageScanStatuses": { + "shape": "S8z" + } + } + }, + "CertifyForMarketplace": { + "type": "boolean" + } + } + } + }, + "DescribeNotebookInstance": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceName" + ], + "members": { + "NotebookInstanceName": {} + } + }, + "output": { + "type": "structure", + "members": { + "NotebookInstanceArn": {}, + "NotebookInstanceName": {}, + "NotebookInstanceStatus": {}, + "FailureReason": {}, + "Url": {}, + "InstanceType": {}, + "SubnetId": {}, + "SecurityGroups": { + "shape": "S61" + }, + "RoleArn": {}, + "KmsKeyId": {}, + "NetworkInterfaceId": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "CreationTime": { + "type": "timestamp" + }, + "NotebookInstanceLifecycleConfigName": {}, + "DirectInternetAccess": {}, + "VolumeSizeInGB": { + "type": "integer" + }, + "AcceleratorTypes": { + "shape": "S65" + }, + "DefaultCodeRepository": {}, + "AdditionalCodeRepositories": { + "shape": "S68" + }, + "RootAccess": {} + } + } + }, + "DescribeNotebookInstanceLifecycleConfig": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceLifecycleConfigName" + ], + "members": { + "NotebookInstanceLifecycleConfigName": {} + } + }, + "output": { + "type": "structure", + "members": { + "NotebookInstanceLifecycleConfigArn": {}, + "NotebookInstanceLifecycleConfigName": {}, + "OnCreate": { + "shape": "S6d" + }, + "OnStart": { + "shape": "S6d" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "DescribeSubscribedWorkteam": { + "input": { + "type": "structure", + "required": [ + "WorkteamArn" + ], + "members": { + "WorkteamArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "SubscribedWorkteam" + ], + "members": { + "SubscribedWorkteam": { + "shape": "S9a" + } + } + } + }, + "DescribeTrainingJob": { + "input": { + "type": "structure", + "required": [ + "TrainingJobName" + ], + "members": { + "TrainingJobName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TrainingJobName", + "TrainingJobArn", + "ModelArtifacts", + "TrainingJobStatus", + "SecondaryStatus", + "AlgorithmSpecification", + "ResourceConfig", + "StoppingCondition", + "CreationTime" + ], + "members": { + "TrainingJobName": {}, + "TrainingJobArn": {}, + "TuningJobArn": {}, + "LabelingJobArn": {}, + "ModelArtifacts": { + "shape": "S80" + }, + "TrainingJobStatus": {}, + "SecondaryStatus": {}, + "FailureReason": {}, + "HyperParameters": { + "shape": "S1o" + }, + "AlgorithmSpecification": { + "shape": "S6o" + }, + "RoleArn": {}, + "InputDataConfig": { + "shape": "S1q" + }, + "OutputDataConfig": { + "shape": "S22" + }, + "ResourceConfig": { + "shape": "S24" + }, + "VpcConfig": { + "shape": "S46" + }, + "StoppingCondition": { + "shape": "S27" + }, + "CreationTime": { + "type": "timestamp" + }, + "TrainingStartTime": { + "type": "timestamp" + }, + "TrainingEndTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "SecondaryStatusTransitions": { + "shape": "S9e" + }, + "FinalMetricDataList": { + "shape": "S9h" + }, + "EnableNetworkIsolation": { + "type": "boolean" + }, + "EnableInterContainerTrafficEncryption": { + "type": "boolean" + } + } + } + }, + "DescribeTransformJob": { + "input": { + "type": "structure", + "required": [ + "TransformJobName" + ], + "members": { + "TransformJobName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TransformJobName", + "TransformJobArn", + "TransformJobStatus", + "ModelName", + "TransformInput", + "TransformResources", + "CreationTime" + ], + "members": { + "TransformJobName": {}, + "TransformJobArn": {}, + "TransformJobStatus": {}, + "FailureReason": {}, + "ModelName": {}, + "MaxConcurrentTransforms": { + "type": "integer" + }, + "MaxPayloadInMB": { + "type": "integer" + }, + "BatchStrategy": {}, + "Environment": { + "shape": "S2d" + }, + "TransformInput": { + "shape": "S2g" + }, + "TransformOutput": { + "shape": "S2k" + }, + "TransformResources": { + "shape": "S2n" + }, + "CreationTime": { + "type": "timestamp" + }, + "TransformStartTime": { + "type": "timestamp" + }, + "TransformEndTime": { + "type": "timestamp" + }, + "LabelingJobArn": {} + } + } + }, + "DescribeWorkteam": { + "input": { + "type": "structure", + "required": [ + "WorkteamName" + ], + "members": { + "WorkteamName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Workteam" + ], + "members": { + "Workteam": { + "shape": "S9p" + } + } + } + }, + "GetSearchSuggestions": { + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": {}, + "SuggestionQuery": { + "type": "structure", + "members": { + "PropertyNameQuery": { + "type": "structure", + "required": [ + "PropertyNameHint" + ], + "members": { + "PropertyNameHint": {} + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "PropertyNameSuggestions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PropertyName": {} + } + } + } + } + } + }, + "ListAlgorithms": { + "input": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "MaxResults": { + "type": "integer" + }, + "NameContains": {}, + "NextToken": {}, + "SortBy": {}, + "SortOrder": {} + } + }, + "output": { + "type": "structure", + "required": [ + "AlgorithmSummaryList" + ], + "members": { + "AlgorithmSummaryList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AlgorithmName", + "AlgorithmArn", + "CreationTime", + "AlgorithmStatus" + ], + "members": { + "AlgorithmName": {}, + "AlgorithmArn": {}, + "AlgorithmDescription": {}, + "CreationTime": { + "type": "timestamp" + }, + "AlgorithmStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListCodeRepositories": { + "input": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "MaxResults": { + "type": "integer" + }, + "NameContains": {}, + "NextToken": {}, + "SortBy": {}, + "SortOrder": {} + } + }, + "output": { + "type": "structure", + "required": [ + "CodeRepositorySummaryList" + ], + "members": { + "CodeRepositorySummaryList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "CodeRepositoryName", + "CodeRepositoryArn", + "CreationTime", + "LastModifiedTime" + ], + "members": { + "CodeRepositoryName": {}, + "CodeRepositoryArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "GitConfig": { + "shape": "S2t" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListCompilationJobs": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "NameContains": {}, + "StatusEquals": {}, + "SortBy": {}, + "SortOrder": {} + } + }, + "output": { + "type": "structure", + "required": [ + "CompilationJobSummaries" + ], + "members": { + "CompilationJobSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "CompilationJobName", + "CompilationJobArn", + "CreationTime", + "CompilationTargetDevice", + "CompilationJobStatus" + ], + "members": { + "CompilationJobName": {}, + "CompilationJobArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "CompilationStartTime": { + "type": "timestamp" + }, + "CompilationEndTime": { + "type": "timestamp" + }, + "CompilationTargetDevice": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "CompilationJobStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListEndpointConfigs": { + "input": { + "type": "structure", + "members": { + "SortBy": {}, + "SortOrder": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "NameContains": {}, + "CreationTimeBefore": { + "type": "timestamp" + }, + "CreationTimeAfter": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "required": [ + "EndpointConfigs" + ], + "members": { + "EndpointConfigs": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "EndpointConfigName", + "EndpointConfigArn", + "CreationTime" + ], + "members": { + "EndpointConfigName": {}, + "EndpointConfigArn": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListEndpoints": { + "input": { + "type": "structure", + "members": { + "SortBy": {}, + "SortOrder": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "NameContains": {}, + "CreationTimeBefore": { + "type": "timestamp" + }, + "CreationTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "StatusEquals": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Endpoints" + ], + "members": { + "Endpoints": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "EndpointName", + "EndpointArn", + "CreationTime", + "LastModifiedTime", + "EndpointStatus" + ], + "members": { + "EndpointName": {}, + "EndpointArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "EndpointStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListHyperParameterTuningJobs": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "SortBy": {}, + "SortOrder": {}, + "NameContains": {}, + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "StatusEquals": {} + } + }, + "output": { + "type": "structure", + "required": [ + "HyperParameterTuningJobSummaries" + ], + "members": { + "HyperParameterTuningJobSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "HyperParameterTuningJobName", + "HyperParameterTuningJobArn", + "HyperParameterTuningJobStatus", + "Strategy", + "CreationTime", + "TrainingJobStatusCounters", + "ObjectiveStatusCounters" + ], + "members": { + "HyperParameterTuningJobName": {}, + "HyperParameterTuningJobArn": {}, + "HyperParameterTuningJobStatus": {}, + "Strategy": {}, + "CreationTime": { + "type": "timestamp" + }, + "HyperParameterTuningEndTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "TrainingJobStatusCounters": { + "shape": "S8d" + }, + "ObjectiveStatusCounters": { + "shape": "S8f" + }, + "ResourceLimits": { + "shape": "S3q" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListLabelingJobs": { + "input": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "NameContains": {}, + "SortBy": {}, + "SortOrder": {}, + "StatusEquals": {} + } + }, + "output": { + "type": "structure", + "members": { + "LabelingJobSummaryList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LabelingJobName", + "LabelingJobArn", + "CreationTime", + "LastModifiedTime", + "LabelingJobStatus", + "LabelCounters", + "WorkteamArn", + "PreHumanTaskLambdaArn" + ], + "members": { + "LabelingJobName": {}, + "LabelingJobArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "LabelingJobStatus": {}, + "LabelCounters": { + "shape": "S8p" + }, + "WorkteamArn": {}, + "PreHumanTaskLambdaArn": {}, + "AnnotationConsolidationLambdaArn": {}, + "FailureReason": {}, + "LabelingJobOutput": { + "shape": "S8s" + }, + "InputConfig": { + "shape": "S4k" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListLabelingJobsForWorkteam": { + "input": { + "type": "structure", + "required": [ + "WorkteamArn" + ], + "members": { + "WorkteamArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "JobReferenceCodeContains": {}, + "SortBy": {}, + "SortOrder": {} + } + }, + "output": { + "type": "structure", + "required": [ + "LabelingJobSummaryList" + ], + "members": { + "LabelingJobSummaryList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "JobReferenceCode", + "WorkRequesterAccountId", + "CreationTime" + ], + "members": { + "LabelingJobName": {}, + "JobReferenceCode": {}, + "WorkRequesterAccountId": {}, + "CreationTime": { + "type": "timestamp" + }, + "LabelCounters": { + "type": "structure", + "members": { + "HumanLabeled": { + "type": "integer" + }, + "PendingHuman": { + "type": "integer" + }, + "Total": { + "type": "integer" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "ListModelPackages": { + "input": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "MaxResults": { + "type": "integer" + }, + "NameContains": {}, + "NextToken": {}, + "SortBy": {}, + "SortOrder": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ModelPackageSummaryList" + ], + "members": { + "ModelPackageSummaryList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ModelPackageName", + "ModelPackageArn", + "CreationTime", + "ModelPackageStatus" + ], + "members": { + "ModelPackageName": {}, + "ModelPackageArn": {}, + "ModelPackageDescription": {}, + "CreationTime": { + "type": "timestamp" + }, + "ModelPackageStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListModels": { + "input": { + "type": "structure", + "members": { + "SortBy": {}, + "SortOrder": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "NameContains": {}, + "CreationTimeBefore": { + "type": "timestamp" + }, + "CreationTimeAfter": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Models" + ], + "members": { + "Models": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ModelName", + "ModelArn", + "CreationTime" + ], + "members": { + "ModelName": {}, + "ModelArn": {}, + "CreationTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListNotebookInstanceLifecycleConfigs": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "SortBy": {}, + "SortOrder": {}, + "NameContains": {}, + "CreationTimeBefore": { + "type": "timestamp" + }, + "CreationTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NotebookInstanceLifecycleConfigs": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "NotebookInstanceLifecycleConfigName", + "NotebookInstanceLifecycleConfigArn" + ], + "members": { + "NotebookInstanceLifecycleConfigName": {}, + "NotebookInstanceLifecycleConfigArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + } + } + } + } + } + } + }, + "ListNotebookInstances": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "SortBy": {}, + "SortOrder": {}, + "NameContains": {}, + "CreationTimeBefore": { + "type": "timestamp" + }, + "CreationTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "StatusEquals": {}, + "NotebookInstanceLifecycleConfigNameContains": {}, + "DefaultCodeRepositoryContains": {}, + "AdditionalCodeRepositoryEquals": {} + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "NotebookInstances": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "NotebookInstanceName", + "NotebookInstanceArn" + ], + "members": { + "NotebookInstanceName": {}, + "NotebookInstanceArn": {}, + "NotebookInstanceStatus": {}, + "Url": {}, + "InstanceType": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "NotebookInstanceLifecycleConfigName": {}, + "DefaultCodeRepository": {}, + "AdditionalCodeRepositories": { + "shape": "S68" + } + } + } + } + } + } + }, + "ListSubscribedWorkteams": { + "input": { + "type": "structure", + "members": { + "NameContains": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "SubscribedWorkteams" + ], + "members": { + "SubscribedWorkteams": { + "type": "list", + "member": { + "shape": "S9a" + } + }, + "NextToken": {} + } + } + }, + "ListTags": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "shape": "S3" + }, + "NextToken": {} + } + } + }, + "ListTrainingJobs": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "NameContains": {}, + "StatusEquals": {}, + "SortBy": {}, + "SortOrder": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TrainingJobSummaries" + ], + "members": { + "TrainingJobSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "TrainingJobName", + "TrainingJobArn", + "CreationTime", + "TrainingJobStatus" + ], + "members": { + "TrainingJobName": {}, + "TrainingJobArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "TrainingEndTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "TrainingJobStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTrainingJobsForHyperParameterTuningJob": { + "input": { + "type": "structure", + "required": [ + "HyperParameterTuningJobName" + ], + "members": { + "HyperParameterTuningJobName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "StatusEquals": {}, + "SortBy": {}, + "SortOrder": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TrainingJobSummaries" + ], + "members": { + "TrainingJobSummaries": { + "type": "list", + "member": { + "shape": "S8h" + } + }, + "NextToken": {} + } + } + }, + "ListTransformJobs": { + "input": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "type": "timestamp" + }, + "CreationTimeBefore": { + "type": "timestamp" + }, + "LastModifiedTimeAfter": { + "type": "timestamp" + }, + "LastModifiedTimeBefore": { + "type": "timestamp" + }, + "NameContains": {}, + "StatusEquals": {}, + "SortBy": {}, + "SortOrder": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TransformJobSummaries" + ], + "members": { + "TransformJobSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "TransformJobName", + "TransformJobArn", + "CreationTime", + "TransformJobStatus" + ], + "members": { + "TransformJobName": {}, + "TransformJobArn": {}, + "CreationTime": { + "type": "timestamp" + }, + "TransformEndTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "TransformJobStatus": {}, + "FailureReason": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListWorkteams": { + "input": { + "type": "structure", + "members": { + "SortBy": {}, + "SortOrder": {}, + "NameContains": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Workteams" + ], + "members": { + "Workteams": { + "type": "list", + "member": { + "shape": "S9p" + } + }, + "NextToken": {} + } + } + }, + "RenderUiTemplate": { + "input": { + "type": "structure", + "required": [ + "UiTemplate", + "Task", + "RoleArn" + ], + "members": { + "UiTemplate": { + "type": "structure", + "required": [ + "Content" + ], + "members": { + "Content": {} + } + }, + "Task": { + "type": "structure", + "required": [ + "Input" + ], + "members": { + "Input": {} + } + }, + "RoleArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RenderedContent", + "Errors" + ], + "members": { + "RenderedContent": {}, + "Errors": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Code", + "Message" + ], + "members": { + "Code": {}, + "Message": {} + } + } + } + } + } + }, + "Search": { + "input": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": {}, + "SearchExpression": { + "shape": "Sd2" + }, + "SortBy": {}, + "SortOrder": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Results": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TrainingJob": { + "type": "structure", + "members": { + "TrainingJobName": {}, + "TrainingJobArn": {}, + "TuningJobArn": {}, + "LabelingJobArn": {}, + "ModelArtifacts": { + "shape": "S80" + }, + "TrainingJobStatus": {}, + "SecondaryStatus": {}, + "FailureReason": {}, + "HyperParameters": { + "shape": "S1o" + }, + "AlgorithmSpecification": { + "shape": "S6o" + }, + "RoleArn": {}, + "InputDataConfig": { + "shape": "S1q" + }, + "OutputDataConfig": { + "shape": "S22" + }, + "ResourceConfig": { + "shape": "S24" + }, + "VpcConfig": { + "shape": "S46" + }, + "StoppingCondition": { + "shape": "S27" + }, + "CreationTime": { + "type": "timestamp" + }, + "TrainingStartTime": { + "type": "timestamp" + }, + "TrainingEndTime": { + "type": "timestamp" + }, + "LastModifiedTime": { + "type": "timestamp" + }, + "SecondaryStatusTransitions": { + "shape": "S9e" + }, + "FinalMetricDataList": { + "shape": "S9h" + }, + "EnableNetworkIsolation": { + "type": "boolean" + }, + "EnableInterContainerTrafficEncryption": { + "type": "boolean" + }, + "Tags": { + "shape": "S3" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "StartNotebookInstance": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceName" + ], + "members": { + "NotebookInstanceName": {} + } + } + }, + "StopCompilationJob": { + "input": { + "type": "structure", + "required": [ + "CompilationJobName" + ], + "members": { + "CompilationJobName": {} + } + } + }, + "StopHyperParameterTuningJob": { + "input": { + "type": "structure", + "required": [ + "HyperParameterTuningJobName" + ], + "members": { + "HyperParameterTuningJobName": {} + } + } + }, + "StopLabelingJob": { + "input": { + "type": "structure", + "required": [ + "LabelingJobName" + ], + "members": { + "LabelingJobName": {} + } + } + }, + "StopNotebookInstance": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceName" + ], + "members": { + "NotebookInstanceName": {} + } + } + }, + "StopTrainingJob": { + "input": { + "type": "structure", + "required": [ + "TrainingJobName" + ], + "members": { + "TrainingJobName": {} + } + } + }, + "StopTransformJob": { + "input": { + "type": "structure", + "required": [ + "TransformJobName" + ], + "members": { + "TransformJobName": {} + } + } + }, + "UpdateCodeRepository": { + "input": { + "type": "structure", + "required": [ + "CodeRepositoryName" + ], + "members": { + "CodeRepositoryName": {}, + "GitConfig": { + "type": "structure", + "members": { + "SecretArn": {} + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "CodeRepositoryArn" + ], + "members": { + "CodeRepositoryArn": {} + } + } + }, + "UpdateEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointName", + "EndpointConfigName" + ], + "members": { + "EndpointName": {}, + "EndpointConfigName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + } + }, + "UpdateEndpointWeightsAndCapacities": { + "input": { + "type": "structure", + "required": [ + "EndpointName", + "DesiredWeightsAndCapacities" + ], + "members": { + "EndpointName": {}, + "DesiredWeightsAndCapacities": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VariantName" + ], + "members": { + "VariantName": {}, + "DesiredWeight": { + "type": "float" + }, + "DesiredInstanceCount": { + "type": "integer" + } + } + } + } + } + }, + "output": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + } + }, + "UpdateNotebookInstance": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceName" + ], + "members": { + "NotebookInstanceName": {}, + "InstanceType": {}, + "RoleArn": {}, + "LifecycleConfigName": {}, + "DisassociateLifecycleConfig": { + "type": "boolean" + }, + "VolumeSizeInGB": { + "type": "integer" + }, + "DefaultCodeRepository": {}, + "AdditionalCodeRepositories": { + "shape": "S68" + }, + "AcceleratorTypes": { + "shape": "S65" + }, + "DisassociateAcceleratorTypes": { + "type": "boolean" + }, + "DisassociateDefaultCodeRepository": { + "type": "boolean" + }, + "DisassociateAdditionalCodeRepositories": { + "type": "boolean" + }, + "RootAccess": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateNotebookInstanceLifecycleConfig": { + "input": { + "type": "structure", + "required": [ + "NotebookInstanceLifecycleConfigName" + ], + "members": { + "NotebookInstanceLifecycleConfigName": {}, + "OnCreate": { + "shape": "S6d" + }, + "OnStart": { + "shape": "S6d" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateWorkteam": { + "input": { + "type": "structure", + "required": [ + "WorkteamName" + ], + "members": { + "WorkteamName": {}, + "MemberDefinitions": { + "shape": "S6x" + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Workteam" + ], + "members": { + "Workteam": { + "shape": "S9p" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "TrainingImage", + "SupportedTrainingInstanceTypes", + "TrainingChannels" + ], + "members": { + "TrainingImage": {}, + "TrainingImageDigest": {}, + "SupportedHyperParameters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Type" + ], + "members": { + "Name": {}, + "Description": {}, + "Type": {}, + "Range": { + "type": "structure", + "members": { + "IntegerParameterRangeSpecification": { + "type": "structure", + "required": [ + "MinValue", + "MaxValue" + ], + "members": { + "MinValue": {}, + "MaxValue": {} + } + }, + "ContinuousParameterRangeSpecification": { + "type": "structure", + "required": [ + "MinValue", + "MaxValue" + ], + "members": { + "MinValue": {}, + "MaxValue": {} + } + }, + "CategoricalParameterRangeSpecification": { + "type": "structure", + "required": [ + "Values" + ], + "members": { + "Values": { + "shape": "Sn" + } + } + } + } + }, + "IsTunable": { + "type": "boolean" + }, + "IsRequired": { + "type": "boolean" + }, + "DefaultValue": {} + } + } + }, + "SupportedTrainingInstanceTypes": { + "type": "list", + "member": {} + }, + "SupportsDistributedTraining": { + "type": "boolean" + }, + "MetricDefinitions": { + "shape": "Sr" + }, + "TrainingChannels": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "SupportedContentTypes", + "SupportedInputModes" + ], + "members": { + "Name": {}, + "Description": {}, + "IsRequired": { + "type": "boolean" + }, + "SupportedContentTypes": { + "shape": "Sy" + }, + "SupportedCompressionTypes": { + "type": "list", + "member": {} + }, + "SupportedInputModes": { + "type": "list", + "member": {} + } + } + } + }, + "SupportedTuningJobObjectiveMetrics": { + "type": "list", + "member": { + "shape": "S15" + } + } + } + }, + "Sn": { + "type": "list", + "member": {} + }, + "Sr": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Regex" + ], + "members": { + "Name": {}, + "Regex": {} + } + } + }, + "Sy": { + "type": "list", + "member": {} + }, + "S15": { + "type": "structure", + "required": [ + "Type", + "MetricName" + ], + "members": { + "Type": {}, + "MetricName": {} + } + }, + "S17": { + "type": "structure", + "required": [ + "Containers", + "SupportedTransformInstanceTypes", + "SupportedRealtimeInferenceInstanceTypes", + "SupportedContentTypes", + "SupportedResponseMIMETypes" + ], + "members": { + "Containers": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Image" + ], + "members": { + "ContainerHostname": {}, + "Image": {}, + "ImageDigest": {}, + "ModelDataUrl": {}, + "ProductId": {} + } + } + }, + "SupportedTransformInstanceTypes": { + "type": "list", + "member": {} + }, + "SupportedRealtimeInferenceInstanceTypes": { + "type": "list", + "member": {} + }, + "SupportedContentTypes": { + "shape": "Sy" + }, + "SupportedResponseMIMETypes": { + "type": "list", + "member": {} + } + } + }, + "S1j": { + "type": "structure", + "required": [ + "ValidationRole", + "ValidationProfiles" + ], + "members": { + "ValidationRole": {}, + "ValidationProfiles": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ProfileName", + "TrainingJobDefinition" + ], + "members": { + "ProfileName": {}, + "TrainingJobDefinition": { + "type": "structure", + "required": [ + "TrainingInputMode", + "InputDataConfig", + "OutputDataConfig", + "ResourceConfig", + "StoppingCondition" + ], + "members": { + "TrainingInputMode": {}, + "HyperParameters": { + "shape": "S1o" + }, + "InputDataConfig": { + "shape": "S1q" + }, + "OutputDataConfig": { + "shape": "S22" + }, + "ResourceConfig": { + "shape": "S24" + }, + "StoppingCondition": { + "shape": "S27" + } + } + }, + "TransformJobDefinition": { + "shape": "S29" + } + } + } + } + } + }, + "S1o": { + "type": "map", + "key": {}, + "value": {} + }, + "S1q": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ChannelName", + "DataSource" + ], + "members": { + "ChannelName": {}, + "DataSource": { + "type": "structure", + "required": [ + "S3DataSource" + ], + "members": { + "S3DataSource": { + "type": "structure", + "required": [ + "S3DataType", + "S3Uri" + ], + "members": { + "S3DataType": {}, + "S3Uri": {}, + "S3DataDistributionType": {}, + "AttributeNames": { + "type": "list", + "member": {} + } + } + } + } + }, + "ContentType": {}, + "CompressionType": {}, + "RecordWrapperType": {}, + "InputMode": {}, + "ShuffleConfig": { + "type": "structure", + "required": [ + "Seed" + ], + "members": { + "Seed": { + "type": "long" + } + } + } + } + } + }, + "S22": { + "type": "structure", + "required": [ + "S3OutputPath" + ], + "members": { + "KmsKeyId": {}, + "S3OutputPath": {} + } + }, + "S24": { + "type": "structure", + "required": [ + "InstanceType", + "InstanceCount", + "VolumeSizeInGB" + ], + "members": { + "InstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "VolumeSizeInGB": { + "type": "integer" + }, + "VolumeKmsKeyId": {} + } + }, + "S27": { + "type": "structure", + "members": { + "MaxRuntimeInSeconds": { + "type": "integer" + } + } + }, + "S29": { + "type": "structure", + "required": [ + "TransformInput", + "TransformOutput", + "TransformResources" + ], + "members": { + "MaxConcurrentTransforms": { + "type": "integer" + }, + "MaxPayloadInMB": { + "type": "integer" + }, + "BatchStrategy": {}, + "Environment": { + "shape": "S2d" + }, + "TransformInput": { + "shape": "S2g" + }, + "TransformOutput": { + "shape": "S2k" + }, + "TransformResources": { + "shape": "S2n" + } + } + }, + "S2d": { + "type": "map", + "key": {}, + "value": {} + }, + "S2g": { + "type": "structure", + "required": [ + "DataSource" + ], + "members": { + "DataSource": { + "type": "structure", + "required": [ + "S3DataSource" + ], + "members": { + "S3DataSource": { + "type": "structure", + "required": [ + "S3DataType", + "S3Uri" + ], + "members": { + "S3DataType": {}, + "S3Uri": {} + } + } + } + }, + "ContentType": {}, + "CompressionType": {}, + "SplitType": {} + } + }, + "S2k": { + "type": "structure", + "required": [ + "S3OutputPath" + ], + "members": { + "S3OutputPath": {}, + "Accept": {}, + "AssembleWith": {}, + "KmsKeyId": {} + } + }, + "S2n": { + "type": "structure", + "required": [ + "InstanceType", + "InstanceCount" + ], + "members": { + "InstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "VolumeKmsKeyId": {} + } + }, + "S2t": { + "type": "structure", + "required": [ + "RepositoryUrl" + ], + "members": { + "RepositoryUrl": {}, + "Branch": {}, + "SecretArn": {} + } + }, + "S30": { + "type": "structure", + "required": [ + "S3Uri", + "DataInputConfig", + "Framework" + ], + "members": { + "S3Uri": {}, + "DataInputConfig": {}, + "Framework": {} + } + }, + "S33": { + "type": "structure", + "required": [ + "S3OutputLocation", + "TargetDevice" + ], + "members": { + "S3OutputLocation": {}, + "TargetDevice": {} + } + }, + "S3d": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VariantName", + "ModelName", + "InitialInstanceCount", + "InstanceType" + ], + "members": { + "VariantName": {}, + "ModelName": {}, + "InitialInstanceCount": { + "type": "integer" + }, + "InstanceType": {}, + "InitialVariantWeight": { + "type": "float" + }, + "AcceleratorType": {} + } + } + }, + "S3o": { + "type": "structure", + "required": [ + "Strategy", + "HyperParameterTuningJobObjective", + "ResourceLimits", + "ParameterRanges" + ], + "members": { + "Strategy": {}, + "HyperParameterTuningJobObjective": { + "shape": "S15" + }, + "ResourceLimits": { + "shape": "S3q" + }, + "ParameterRanges": { + "type": "structure", + "members": { + "IntegerParameterRanges": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "MinValue", + "MaxValue" + ], + "members": { + "Name": {}, + "MinValue": {}, + "MaxValue": {}, + "ScalingType": {} + } + } + }, + "ContinuousParameterRanges": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "MinValue", + "MaxValue" + ], + "members": { + "Name": {}, + "MinValue": {}, + "MaxValue": {}, + "ScalingType": {} + } + } + }, + "CategoricalParameterRanges": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "Sn" + } + } + } + } + } + }, + "TrainingJobEarlyStoppingType": {} + } + }, + "S3q": { + "type": "structure", + "required": [ + "MaxNumberOfTrainingJobs", + "MaxParallelTrainingJobs" + ], + "members": { + "MaxNumberOfTrainingJobs": { + "type": "integer" + }, + "MaxParallelTrainingJobs": { + "type": "integer" + } + } + }, + "S42": { + "type": "structure", + "required": [ + "AlgorithmSpecification", + "RoleArn", + "OutputDataConfig", + "ResourceConfig", + "StoppingCondition" + ], + "members": { + "StaticHyperParameters": { + "shape": "S1o" + }, + "AlgorithmSpecification": { + "type": "structure", + "required": [ + "TrainingInputMode" + ], + "members": { + "TrainingImage": {}, + "TrainingInputMode": {}, + "AlgorithmName": {}, + "MetricDefinitions": { + "shape": "Sr" + } + } + }, + "RoleArn": {}, + "InputDataConfig": { + "shape": "S1q" + }, + "VpcConfig": { + "shape": "S46" + }, + "OutputDataConfig": { + "shape": "S22" + }, + "ResourceConfig": { + "shape": "S24" + }, + "StoppingCondition": { + "shape": "S27" + }, + "EnableNetworkIsolation": { + "type": "boolean" + }, + "EnableInterContainerTrafficEncryption": { + "type": "boolean" + } + } + }, + "S46": { + "type": "structure", + "required": [ + "SecurityGroupIds", + "Subnets" + ], + "members": { + "SecurityGroupIds": { + "type": "list", + "member": {} + }, + "Subnets": { + "type": "list", + "member": {} + } + } + }, + "S4b": { + "type": "structure", + "required": [ + "ParentHyperParameterTuningJobs", + "WarmStartType" + ], + "members": { + "ParentHyperParameterTuningJobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "HyperParameterTuningJobName": {} + } + } + }, + "WarmStartType": {} + } + }, + "S4k": { + "type": "structure", + "required": [ + "DataSource" + ], + "members": { + "DataSource": { + "type": "structure", + "required": [ + "S3DataSource" + ], + "members": { + "S3DataSource": { + "type": "structure", + "required": [ + "ManifestS3Uri" + ], + "members": { + "ManifestS3Uri": {} + } + } + } + }, + "DataAttributes": { + "type": "structure", + "members": { + "ContentClassifiers": { + "type": "list", + "member": {} + } + } + } + } + }, + "S4q": { + "type": "structure", + "required": [ + "S3OutputPath" + ], + "members": { + "S3OutputPath": {}, + "KmsKeyId": {} + } + }, + "S4r": { + "type": "structure", + "members": { + "MaxHumanLabeledObjectCount": { + "type": "integer" + }, + "MaxPercentageOfInputDatasetLabeled": { + "type": "integer" + } + } + }, + "S4u": { + "type": "structure", + "required": [ + "LabelingJobAlgorithmSpecificationArn" + ], + "members": { + "LabelingJobAlgorithmSpecificationArn": {}, + "InitialActiveLearningModelArn": {}, + "LabelingJobResourceConfig": { + "type": "structure", + "members": { + "VolumeKmsKeyId": {} + } + } + } + }, + "S4y": { + "type": "structure", + "required": [ + "WorkteamArn", + "UiConfig", + "PreHumanTaskLambdaArn", + "TaskTitle", + "TaskDescription", + "NumberOfHumanWorkersPerDataObject", + "TaskTimeLimitInSeconds", + "AnnotationConsolidationConfig" + ], + "members": { + "WorkteamArn": {}, + "UiConfig": { + "type": "structure", + "required": [ + "UiTemplateS3Uri" + ], + "members": { + "UiTemplateS3Uri": {} + } + }, + "PreHumanTaskLambdaArn": {}, + "TaskKeywords": { + "type": "list", + "member": {} + }, + "TaskTitle": {}, + "TaskDescription": {}, + "NumberOfHumanWorkersPerDataObject": { + "type": "integer" + }, + "TaskTimeLimitInSeconds": { + "type": "integer" + }, + "TaskAvailabilityLifetimeInSeconds": { + "type": "integer" + }, + "MaxConcurrentTaskCount": { + "type": "integer" + }, + "AnnotationConsolidationConfig": { + "type": "structure", + "required": [ + "AnnotationConsolidationLambdaArn" + ], + "members": { + "AnnotationConsolidationLambdaArn": {} + } + }, + "PublicWorkforceTaskPrice": { + "type": "structure", + "members": { + "AmountInUsd": { + "type": "structure", + "members": { + "Dollars": { + "type": "integer" + }, + "Cents": { + "type": "integer" + }, + "TenthFractionsOfACent": { + "type": "integer" + } + } + } + } + } + } + }, + "S5j": { + "type": "structure", + "members": { + "ContainerHostname": {}, + "Image": {}, + "ModelDataUrl": {}, + "Environment": { + "type": "map", + "key": {}, + "value": {} + }, + "ModelPackageName": {} + } + }, + "S5n": { + "type": "list", + "member": { + "shape": "S5j" + } + }, + "S5q": { + "type": "structure", + "required": [ + "ValidationRole", + "ValidationProfiles" + ], + "members": { + "ValidationRole": {}, + "ValidationProfiles": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ProfileName", + "TransformJobDefinition" + ], + "members": { + "ProfileName": {}, + "TransformJobDefinition": { + "shape": "S29" + } + } + } + } + } + }, + "S5t": { + "type": "structure", + "required": [ + "SourceAlgorithms" + ], + "members": { + "SourceAlgorithms": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AlgorithmName" + ], + "members": { + "ModelDataUrl": {}, + "AlgorithmName": {} + } + } + } + } + }, + "S61": { + "type": "list", + "member": {} + }, + "S65": { + "type": "list", + "member": {} + }, + "S68": { + "type": "list", + "member": {} + }, + "S6d": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Content": {} + } + } + }, + "S6o": { + "type": "structure", + "required": [ + "TrainingInputMode" + ], + "members": { + "TrainingImage": {}, + "AlgorithmName": {}, + "TrainingInputMode": {}, + "MetricDefinitions": { + "shape": "Sr" + } + } + }, + "S6x": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CognitoMemberDefinition": { + "type": "structure", + "required": [ + "UserPool", + "UserGroup", + "ClientId" + ], + "members": { + "UserPool": {}, + "UserGroup": {}, + "ClientId": {} + } + } + } + } + }, + "S7o": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Status" + ], + "members": { + "Name": {}, + "Status": {}, + "FailureReason": {} + } + } + }, + "S80": { + "type": "structure", + "required": [ + "S3ModelArtifacts" + ], + "members": { + "S3ModelArtifacts": {} + } + }, + "S8d": { + "type": "structure", + "members": { + "Completed": { + "type": "integer" + }, + "InProgress": { + "type": "integer" + }, + "RetryableError": { + "type": "integer" + }, + "NonRetryableError": { + "type": "integer" + }, + "Stopped": { + "type": "integer" + } + } + }, + "S8f": { + "type": "structure", + "members": { + "Succeeded": { + "type": "integer" + }, + "Pending": { + "type": "integer" + }, + "Failed": { + "type": "integer" + } + } + }, + "S8h": { + "type": "structure", + "required": [ + "TrainingJobName", + "TrainingJobArn", + "CreationTime", + "TrainingJobStatus", + "TunedHyperParameters" + ], + "members": { + "TrainingJobName": {}, + "TrainingJobArn": {}, + "TuningJobName": {}, + "CreationTime": { + "type": "timestamp" + }, + "TrainingStartTime": { + "type": "timestamp" + }, + "TrainingEndTime": { + "type": "timestamp" + }, + "TrainingJobStatus": {}, + "TunedHyperParameters": { + "shape": "S1o" + }, + "FailureReason": {}, + "FinalHyperParameterTuningJobObjectiveMetric": { + "type": "structure", + "required": [ + "MetricName", + "Value" + ], + "members": { + "Type": {}, + "MetricName": {}, + "Value": { + "type": "float" + } + } + }, + "ObjectiveStatus": {} + } + }, + "S8p": { + "type": "structure", + "members": { + "TotalLabeled": { + "type": "integer" + }, + "HumanLabeled": { + "type": "integer" + }, + "MachineLabeled": { + "type": "integer" + }, + "FailedNonRetryableError": { + "type": "integer" + }, + "Unlabeled": { + "type": "integer" + } + } + }, + "S8s": { + "type": "structure", + "required": [ + "OutputDatasetS3Uri" + ], + "members": { + "OutputDatasetS3Uri": {}, + "FinalActiveLearningModelArn": {} + } + }, + "S8z": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Status" + ], + "members": { + "Name": {}, + "Status": {}, + "FailureReason": {} + } + } + }, + "S9a": { + "type": "structure", + "required": [ + "WorkteamArn" + ], + "members": { + "WorkteamArn": {}, + "MarketplaceTitle": {}, + "SellerName": {}, + "MarketplaceDescription": {}, + "ListingId": {} + } + }, + "S9e": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Status", + "StartTime" + ], + "members": { + "Status": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "StatusMessage": {} + } + } + }, + "S9h": { + "type": "list", + "member": { + "type": "structure", + "members": { + "MetricName": {}, + "Value": { + "type": "float" + }, + "Timestamp": { + "type": "timestamp" + } + } + } + }, + "S9p": { + "type": "structure", + "required": [ + "WorkteamName", + "MemberDefinitions", + "WorkteamArn", + "Description" + ], + "members": { + "WorkteamName": {}, + "MemberDefinitions": { + "shape": "S6x" + }, + "WorkteamArn": {}, + "ProductListingIds": { + "type": "list", + "member": {} + }, + "Description": {}, + "SubDomain": {}, + "CreateDate": { + "type": "timestamp" + }, + "LastUpdatedDate": { + "type": "timestamp" + } + } + }, + "Sd2": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sd3" + }, + "NestedFilters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "NestedPropertyName", + "Filters" + ], + "members": { + "NestedPropertyName": {}, + "Filters": { + "shape": "Sd3" + } + } + } + }, + "SubExpressions": { + "type": "list", + "member": { + "shape": "Sd2" + } + }, + "Operator": {} + } + }, + "Sd3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Operator": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sagemaker-2017-07-24.paginators.json b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.paginators.json new file mode 100644 index 0000000..45db078 --- /dev/null +++ b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.paginators.json @@ -0,0 +1,84 @@ +{ + "pagination": { + "ListCompilationJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListEndpointConfigs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListHyperParameterTuningJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListLabelingJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListLabelingJobsForWorkteam": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListModels": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNotebookInstanceLifecycleConfigs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNotebookInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSubscribedWorkteams": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTrainingJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTrainingJobsForHyperParameterTuningJob": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTransformJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListWorkteams": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "Search": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/sagemaker-2017-07-24.waiters2.json b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.waiters2.json new file mode 100644 index 0000000..d033ea3 --- /dev/null +++ b/node_modules/aws-sdk/apis/sagemaker-2017-07-24.waiters2.json @@ -0,0 +1,163 @@ +{ + "version": 2, + "waiters": { + "NotebookInstanceInService": { + "delay": 30, + "maxAttempts": 60, + "operation": "DescribeNotebookInstance", + "acceptors": [ + { + "expected": "InService", + "matcher": "path", + "state": "success", + "argument": "NotebookInstanceStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "NotebookInstanceStatus" + } + ] + }, + "NotebookInstanceStopped": { + "delay": 30, + "operation": "DescribeNotebookInstance", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "Stopped", + "matcher": "path", + "state": "success", + "argument": "NotebookInstanceStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "NotebookInstanceStatus" + } + ] + }, + "NotebookInstanceDeleted": { + "delay": 30, + "maxAttempts": 60, + "operation": "DescribeNotebookInstance", + "acceptors": [ + { + "expected": "ValidationException", + "matcher": "error", + "state": "success" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "NotebookInstanceStatus" + } + ] + }, + "TrainingJobCompletedOrStopped": { + "delay": 120, + "maxAttempts": 180, + "operation": "DescribeTrainingJob", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "TrainingJobStatus" + }, + { + "expected": "Stopped", + "matcher": "path", + "state": "success", + "argument": "TrainingJobStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "TrainingJobStatus" + }, + { + "expected": "ValidationException", + "matcher": "error", + "state": "failure" + } + ] + }, + "EndpointInService": { + "delay": 30, + "maxAttempts": 120, + "operation": "DescribeEndpoint", + "acceptors": [ + { + "expected": "InService", + "matcher": "path", + "state": "success", + "argument": "EndpointStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "EndpointStatus" + }, + { + "expected": "ValidationException", + "matcher": "error", + "state": "failure" + } + ] + }, + "EndpointDeleted": { + "delay": 30, + "maxAttempts": 60, + "operation": "DescribeEndpoint", + "acceptors": [ + { + "expected": "ValidationException", + "matcher": "error", + "state": "success" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "EndpointStatus" + } + ] + }, + "TransformJobCompletedOrStopped": { + "delay": 60, + "maxAttempts": 60, + "operation": "DescribeTransformJob", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "TransformJobStatus" + }, + { + "expected": "Stopped", + "matcher": "path", + "state": "success", + "argument": "TransformJobStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "TransformJobStatus" + }, + { + "expected": "ValidationException", + "matcher": "error", + "state": "failure" + } + ] + } + } +} diff --git a/node_modules/aws-sdk/apis/sdb-2009-04-15.min.json b/node_modules/aws-sdk/apis/sdb-2009-04-15.min.json new file mode 100644 index 0000000..76dae11 --- /dev/null +++ b/node_modules/aws-sdk/apis/sdb-2009-04-15.min.json @@ -0,0 +1,337 @@ +{ + "metadata": { + "apiVersion": "2009-04-15", + "endpointPrefix": "sdb", + "serviceFullName": "Amazon SimpleDB", + "serviceId": "SimpleDB", + "signatureVersion": "v2", + "xmlNamespace": "http://sdb.amazonaws.com/doc/2009-04-15/", + "protocol": "query" + }, + "operations": { + "BatchDeleteAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Items" + ], + "members": { + "DomainName": {}, + "Items": { + "type": "list", + "member": { + "locationName": "Item", + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": { + "locationName": "ItemName" + }, + "Attributes": { + "shape": "S5" + } + } + }, + "flattened": true + } + } + } + }, + "BatchPutAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Items" + ], + "members": { + "DomainName": {}, + "Items": { + "type": "list", + "member": { + "locationName": "Item", + "type": "structure", + "required": [ + "Name", + "Attributes" + ], + "members": { + "Name": { + "locationName": "ItemName" + }, + "Attributes": { + "shape": "Sa" + } + } + }, + "flattened": true + } + } + } + }, + "CreateDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + } + }, + "DeleteAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ItemName" + ], + "members": { + "DomainName": {}, + "ItemName": {}, + "Attributes": { + "shape": "S5" + }, + "Expected": { + "shape": "Sf" + } + } + } + }, + "DeleteDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + } + }, + "DomainMetadata": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DomainMetadataResult", + "type": "structure", + "members": { + "ItemCount": { + "type": "integer" + }, + "ItemNamesSizeBytes": { + "type": "long" + }, + "AttributeNameCount": { + "type": "integer" + }, + "AttributeNamesSizeBytes": { + "type": "long" + }, + "AttributeValueCount": { + "type": "integer" + }, + "AttributeValuesSizeBytes": { + "type": "long" + }, + "Timestamp": { + "type": "integer" + } + } + } + }, + "GetAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ItemName" + ], + "members": { + "DomainName": {}, + "ItemName": {}, + "AttributeNames": { + "type": "list", + "member": { + "locationName": "AttributeName" + }, + "flattened": true + }, + "ConsistentRead": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "GetAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "So" + } + } + } + }, + "ListDomains": { + "input": { + "type": "structure", + "members": { + "MaxNumberOfDomains": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListDomainsResult", + "type": "structure", + "members": { + "DomainNames": { + "type": "list", + "member": { + "locationName": "DomainName" + }, + "flattened": true + }, + "NextToken": {} + } + } + }, + "PutAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ItemName", + "Attributes" + ], + "members": { + "DomainName": {}, + "ItemName": {}, + "Attributes": { + "shape": "Sa" + }, + "Expected": { + "shape": "Sf" + } + } + } + }, + "Select": { + "input": { + "type": "structure", + "required": [ + "SelectExpression" + ], + "members": { + "SelectExpression": {}, + "NextToken": {}, + "ConsistentRead": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SelectResult", + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Item", + "type": "structure", + "required": [ + "Name", + "Attributes" + ], + "members": { + "Name": {}, + "AlternateNameEncoding": {}, + "Attributes": { + "shape": "So" + } + } + }, + "flattened": true + }, + "NextToken": {} + } + } + } + }, + "shapes": { + "S5": { + "type": "list", + "member": { + "locationName": "Attribute", + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Value": {} + } + }, + "flattened": true + }, + "Sa": { + "type": "list", + "member": { + "locationName": "Attribute", + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {}, + "Replace": { + "type": "boolean" + } + } + }, + "flattened": true + }, + "Sf": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "Exists": { + "type": "boolean" + } + } + }, + "So": { + "type": "list", + "member": { + "locationName": "Attribute", + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "AlternateNameEncoding": {}, + "Value": {}, + "AlternateValueEncoding": {} + } + }, + "flattened": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sdb-2009-04-15.paginators.json b/node_modules/aws-sdk/apis/sdb-2009-04-15.paginators.json new file mode 100644 index 0000000..2362098 --- /dev/null +++ b/node_modules/aws-sdk/apis/sdb-2009-04-15.paginators.json @@ -0,0 +1,15 @@ +{ + "pagination": { + "ListDomains": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxNumberOfDomains", + "result_key": "DomainNames" + }, + "Select": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Items" + } + } +} diff --git a/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json b/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json new file mode 100644 index 0000000..8433121 --- /dev/null +++ b/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json @@ -0,0 +1,571 @@ +{ + "version": "1.0", + "examples": { + "CancelRotateSecret": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "Name" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation.", + "id": "to-cancel-scheduled-rotation-for-a-secret-1523996016032", + "title": "To cancel scheduled rotation for a secret" + } + ], + "CreateSecret": [ + { + "input": { + "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "Description": "My test database secret created with the CLI", + "Name": "MyTestDatabaseSecret", + "SecretString": "{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.", + "id": "to-create-a-basic-secret-1523996473658", + "title": "To create a basic secret" + } + ], + "DeleteResourcePolicy": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to delete the resource-based policy that is attached to a secret.", + "id": "to-delete-the-resource-based-policy-attached-to-a-secret-1530209419204", + "title": "To delete the resource-based policy attached to a secret" + } + ], + "DeleteSecret": [ + { + "input": { + "RecoveryWindowInDays": 7, + "SecretId": "MyTestDatabaseSecret1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "DeletionDate": "1524085349.095", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret.", + "id": "to-delete-a-secret-1523996905092", + "title": "To delete a secret" + } + ], + "DescribeSecret": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Description": "My test database secret", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987KMSKEY1", + "LastAccessedDate": "1523923200", + "LastChangedDate": 1523477145.729, + "LastRotatedDate": 1525747253.72, + "Name": "MyTestDatabaseSecret", + "RotationEnabled": true, + "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", + "RotationRules": { + "AutomaticallyAfterDays": 30 + }, + "Tags": [ + { + "Key": "SecondTag", + "Value": "AnotherValue" + }, + { + "Key": "FirstTag", + "Value": "SomeValue" + } + ], + "VersionIdsToStages": { + "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSPREVIOUS" + ], + "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to get the details about a secret.", + "id": "to-retrieve-the-details-of-a-secret-1524000138629", + "title": "To retrieve the details of a secret" + } + ], + "GetRandomPassword": [ + { + "input": { + "IncludeSpace": true, + "PasswordLength": 20, + "RequireEachIncludedType": true + }, + "output": { + "RandomPassword": "N+Z43a,>vx7j O8^*<8i3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.", + "id": "to-generate-a-random-password-1524000546092", + "title": "To generate a random password" + } + ], + "GetResourcePolicy": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to retrieve the resource-based policy that is attached to a secret.", + "id": "to-retrieve-the-resource-based-policy-attached-to-a-secret-1530209677536", + "title": "To retrieve the resource-based policy attached to a secret" + } + ], + "GetSecretValue": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "AWSPREVIOUS" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "CreatedDate": 1523477145.713, + "Name": "MyTestDatabaseSecret", + "SecretString": "{\n \"username\":\"david\",\n \"password\":\"BnQw&XDWgaEeT9XGTT29\"\n}\n", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "VersionStages": [ + "AWSPREVIOUS" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to retrieve the secret string value from the version of the secret that has the AWSPREVIOUS staging label attached. If you want to retrieve the AWSCURRENT version of the secret, then you can omit the VersionStage parameter because it defaults to AWSCURRENT.", + "id": "to-retrieve-the-encrypted-secret-value-of-a-secret-1524000702484", + "title": "To retrieve the encrypted secret value of a secret" + } + ], + "ListSecretVersionIds": [ + { + "input": { + "IncludeDeprecated": true, + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "Versions": [ + { + "CreatedDate": 1523477145.713, + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSPREVIOUS" + ] + }, + { + "CreatedDate": 1523486221.391, + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSCURRENT" + ] + }, + { + "CreatedDate": 1511974462.36, + "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.", + "id": "to-list-all-of-the-secret-versions-associated-with-a-secret-1524000999164", + "title": "To list all of the secret versions associated with a secret" + } + ], + "ListSecrets": [ + { + "input": { + }, + "output": { + "SecretList": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Description": "My test database secret", + "LastChangedDate": 1523477145.729, + "Name": "MyTestDatabaseSecret", + "SecretVersionsToStages": { + "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", + "Description": "Another secret created for a different database", + "LastChangedDate": 1523482025.685, + "Name": "MyTestDatabaseSecret1", + "SecretVersionsToStages": { + "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to list all of the secrets in your account.", + "id": "to-list-the-secrets-in-your-account-1524001246087", + "title": "To list the secrets in your account" + } + ], + "PutResourcePolicy": [ + { + "input": { + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}", + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to add a resource-based policy to a secret.", + "id": "to-add-a-resource-based-policy-to-a-secret-1530209881839", + "title": "To add a resource-based policy to a secret" + } + ], + "PutSecretValue": [ + { + "input": { + "ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "SecretId": "MyTestDatabaseSecret", + "SecretString": "{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSCURRENT" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.", + "id": "to-store-a-secret-value-in-a-new-version-of-a-secret-1524001393971", + "title": "To store a secret value in a new version of a secret" + } + ], + "RestoreSecret": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to restore a secret that you previously scheduled for deletion.", + "id": "to-restore-a-previously-deleted-secret-1524001513930", + "title": "To restore a previously deleted secret" + } + ], + "RotateSecret": [ + { + "input": { + "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", + "RotationRules": { + "AutomaticallyAfterDays": 30 + }, + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures rotation for a secret by providing the ARN of a Lambda rotation function (which must already exist) and the number of days between rotation. The first rotation happens immediately upon completion of this command. The rotation function runs asynchronously in the background.", + "id": "to-configure-rotation-for-a-secret-1524001629475", + "title": "To configure rotation for a secret" + }, + { + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "SecretARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "SecretName": "MyTestDatabaseSecret", + "SecretVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.", + "id": "to-request-an-immediate-rotation-for-a-secret-1524001949004", + "title": "To request an immediate rotation for a secret" + } + ], + "TagResource": [ + { + "input": { + "SecretId": "MyExampleSecret", + "Tags": [ + { + "Key": "FirstTag", + "Value": "SomeValue" + }, + { + "Key": "SecondTag", + "Value": "AnotherValue" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.", + "id": "to-add-tags-to-a-secret-1524002106718", + "title": "To add tags to a secret" + } + ], + "UntagResource": [ + { + "input": { + "SecretId": "MyTestDatabaseSecret", + "TagKeys": [ + "FirstTag", + "SecondTag" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.", + "id": "to-remove-tags-from-a-secret-1524002239065", + "title": "To remove tags from a secret" + } + ], + "UpdateSecret": [ + { + "input": { + "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "Description": "This is a new description for the secret.", + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to modify the description of a secret.", + "id": "to-update-the-description-of-a-secret-1524002349094", + "title": "To update the description of a secret" + }, + { + "input": { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.", + "id": "to-update-the-kms-key-associated-with-a-secret-1524002421563", + "title": "To update the KMS key associated with a secret" + }, + { + "input": { + "SecretId": "MyTestDatabaseSecret", + "SecretString": "{JSON STRING WITH CREDENTIALS}" + }, + "output": { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.", + "id": "to-create-a-new-version-of-the-encrypted-secret-value-1524004651836", + "title": "To create a new version of the encrypted secret value" + } + ], + "UpdateSecretVersionStage": [ + { + "input": { + "MoveToVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "STAGINGLABEL1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "id": "to-add-a-staging-label-attached-to-a-version-of-a-secret-1524004783841", + "title": "To add a staging label attached to a version of a secret" + }, + { + "input": { + "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "STAGINGLABEL1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "id": "to-delete-a-staging-label-attached-to-a-version-of-a-secret-1524004862181", + "title": "To delete a staging label attached to a version of a secret" + }, + { + "input": { + "MoveToVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2", + "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "AWSCURRENT" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "id": "to-move-a-staging-label-from-one-version-of-a-secret-to-another-1524004963841", + "title": "To move a staging label from one version of a secret to another" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json b/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json new file mode 100644 index 0000000..7c6e56d --- /dev/null +++ b/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json @@ -0,0 +1,564 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-10-17", + "endpointPrefix": "secretsmanager", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Secrets Manager", + "serviceId": "Secrets Manager", + "signatureVersion": "v4", + "signingName": "secretsmanager", + "targetPrefix": "secretsmanager", + "uid": "secretsmanager-2017-10-17" + }, + "operations": { + "CancelRotateSecret": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "VersionId": {} + } + } + }, + "CreateSecret": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "Description": {}, + "KmsKeyId": {}, + "SecretBinary": { + "shape": "Sc" + }, + "SecretString": { + "shape": "Sd" + }, + "Tags": { + "shape": "Se" + } + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "VersionId": {} + } + } + }, + "DeleteResourcePolicy": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {} + } + } + }, + "DeleteSecret": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {}, + "RecoveryWindowInDays": { + "type": "long" + }, + "ForceDeleteWithoutRecovery": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "DeletionDate": { + "type": "timestamp" + } + } + } + }, + "DescribeSecret": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "Description": {}, + "KmsKeyId": {}, + "RotationEnabled": { + "type": "boolean" + }, + "RotationLambdaARN": {}, + "RotationRules": { + "shape": "Su" + }, + "LastRotatedDate": { + "type": "timestamp" + }, + "LastChangedDate": { + "type": "timestamp" + }, + "LastAccessedDate": { + "type": "timestamp" + }, + "DeletedDate": { + "type": "timestamp" + }, + "Tags": { + "shape": "Se" + }, + "VersionIdsToStages": { + "shape": "S10" + } + } + } + }, + "GetRandomPassword": { + "input": { + "type": "structure", + "members": { + "PasswordLength": { + "type": "long" + }, + "ExcludeCharacters": {}, + "ExcludeNumbers": { + "type": "boolean" + }, + "ExcludePunctuation": { + "type": "boolean" + }, + "ExcludeUppercase": { + "type": "boolean" + }, + "ExcludeLowercase": { + "type": "boolean" + }, + "IncludeSpace": { + "type": "boolean" + }, + "RequireEachIncludedType": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "RandomPassword": {} + } + } + }, + "GetResourcePolicy": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "ResourcePolicy": {} + } + } + }, + "GetSecretValue": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {}, + "VersionId": {}, + "VersionStage": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "VersionId": {}, + "SecretBinary": { + "shape": "Sc" + }, + "SecretString": { + "shape": "Sd" + }, + "VersionStages": { + "shape": "S11" + }, + "CreatedDate": { + "type": "timestamp" + } + } + } + }, + "ListSecretVersionIds": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "IncludeDeprecated": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Versions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VersionId": {}, + "VersionStages": { + "shape": "S11" + }, + "LastAccessedDate": { + "type": "timestamp" + }, + "CreatedDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {}, + "ARN": {}, + "Name": {} + } + } + }, + "ListSecrets": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SecretList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "Description": {}, + "KmsKeyId": {}, + "RotationEnabled": { + "type": "boolean" + }, + "RotationLambdaARN": {}, + "RotationRules": { + "shape": "Su" + }, + "LastRotatedDate": { + "type": "timestamp" + }, + "LastChangedDate": { + "type": "timestamp" + }, + "LastAccessedDate": { + "type": "timestamp" + }, + "DeletedDate": { + "type": "timestamp" + }, + "Tags": { + "shape": "Se" + }, + "SecretVersionsToStages": { + "shape": "S10" + } + } + } + }, + "NextToken": {} + } + } + }, + "PutResourcePolicy": { + "input": { + "type": "structure", + "required": [ + "SecretId", + "ResourcePolicy" + ], + "members": { + "SecretId": {}, + "ResourcePolicy": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {} + } + } + }, + "PutSecretValue": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "SecretBinary": { + "shape": "Sc" + }, + "SecretString": { + "shape": "Sd" + }, + "VersionStages": { + "shape": "S11" + } + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "VersionId": {}, + "VersionStages": { + "shape": "S11" + } + } + } + }, + "RestoreSecret": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {} + } + } + }, + "RotateSecret": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "RotationLambdaARN": {}, + "RotationRules": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "VersionId": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "SecretId", + "Tags" + ], + "members": { + "SecretId": {}, + "Tags": { + "shape": "Se" + } + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "SecretId", + "TagKeys" + ], + "members": { + "SecretId": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "UpdateSecret": { + "input": { + "type": "structure", + "required": [ + "SecretId" + ], + "members": { + "SecretId": {}, + "ClientRequestToken": { + "idempotencyToken": true + }, + "Description": {}, + "KmsKeyId": {}, + "SecretBinary": { + "shape": "Sc" + }, + "SecretString": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {}, + "VersionId": {} + } + } + }, + "UpdateSecretVersionStage": { + "input": { + "type": "structure", + "required": [ + "SecretId", + "VersionStage" + ], + "members": { + "SecretId": {}, + "VersionStage": {}, + "RemoveFromVersionId": {}, + "MoveToVersionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ARN": {}, + "Name": {} + } + } + } + }, + "shapes": { + "Sc": { + "type": "blob", + "sensitive": true + }, + "Sd": { + "type": "string", + "sensitive": true + }, + "Se": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Su": { + "type": "structure", + "members": { + "AutomaticallyAfterDays": { + "type": "long" + } + } + }, + "S10": { + "type": "map", + "key": {}, + "value": { + "shape": "S11" + } + }, + "S11": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.paginators.json b/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.paginators.json new file mode 100644 index 0000000..2358962 --- /dev/null +++ b/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "ListSecretVersionIds": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSecrets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/securityhub-2018-10-26.examples.json b/node_modules/aws-sdk/apis/securityhub-2018-10-26.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/securityhub-2018-10-26.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json b/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json new file mode 100644 index 0000000..707eddc --- /dev/null +++ b/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json @@ -0,0 +1,1447 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-10-26", + "endpointPrefix": "securityhub", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS SecurityHub", + "serviceId": "SecurityHub", + "signatureVersion": "v4", + "signingName": "securityhub", + "uid": "securityhub-2018-10-26" + }, + "operations": { + "AcceptInvitation": { + "http": { + "requestUri": "/master" + }, + "input": { + "type": "structure", + "members": { + "MasterId": {}, + "InvitationId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "BatchDisableStandards": { + "http": { + "requestUri": "/standards/deregister" + }, + "input": { + "type": "structure", + "required": [ + "StandardsSubscriptionArns" + ], + "members": { + "StandardsSubscriptionArns": { + "shape": "S5" + } + } + }, + "output": { + "type": "structure", + "members": { + "StandardsSubscriptions": { + "shape": "S7" + } + } + } + }, + "BatchEnableStandards": { + "http": { + "requestUri": "/standards/register" + }, + "input": { + "type": "structure", + "required": [ + "StandardsSubscriptionRequests" + ], + "members": { + "StandardsSubscriptionRequests": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StandardsArn" + ], + "members": { + "StandardsArn": {}, + "StandardsInput": { + "shape": "S9" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "StandardsSubscriptions": { + "shape": "S7" + } + } + } + }, + "BatchImportFindings": { + "http": { + "requestUri": "/findings/import" + }, + "input": { + "type": "structure", + "required": [ + "Findings" + ], + "members": { + "Findings": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "required": [ + "FailedCount", + "SuccessCount" + ], + "members": { + "FailedCount": { + "type": "integer" + }, + "SuccessCount": { + "type": "integer" + }, + "FailedFindings": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id", + "ErrorCode", + "ErrorMessage" + ], + "members": { + "Id": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "CreateInsight": { + "http": { + "requestUri": "/insights" + }, + "input": { + "type": "structure", + "required": [ + "Name", + "Filters", + "GroupByAttribute" + ], + "members": { + "Name": {}, + "Filters": { + "shape": "S1m" + }, + "GroupByAttribute": {} + } + }, + "output": { + "type": "structure", + "required": [ + "InsightArn" + ], + "members": { + "InsightArn": {} + } + } + }, + "CreateMembers": { + "http": { + "requestUri": "/members" + }, + "input": { + "type": "structure", + "members": { + "AccountDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": {}, + "Email": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S29" + } + } + } + }, + "DeclineInvitations": { + "http": { + "requestUri": "/invitations/decline" + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S29" + } + } + } + }, + "DeleteInsight": { + "http": { + "method": "DELETE", + "requestUri": "/insights/{InsightArn+}" + }, + "input": { + "type": "structure", + "required": [ + "InsightArn" + ], + "members": { + "InsightArn": { + "location": "uri", + "locationName": "InsightArn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "InsightArn" + ], + "members": { + "InsightArn": {} + } + } + }, + "DeleteInvitations": { + "http": { + "requestUri": "/invitations/delete" + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S29" + } + } + } + }, + "DeleteMembers": { + "http": { + "requestUri": "/members/delete" + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S29" + } + } + } + }, + "DisableImportFindingsForProduct": { + "http": { + "method": "DELETE", + "requestUri": "/productSubscriptions/{ProductSubscriptionArn+}" + }, + "input": { + "type": "structure", + "required": [ + "ProductSubscriptionArn" + ], + "members": { + "ProductSubscriptionArn": { + "location": "uri", + "locationName": "ProductSubscriptionArn" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisableSecurityHub": { + "http": { + "method": "DELETE", + "requestUri": "/accounts" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateFromMasterAccount": { + "http": { + "requestUri": "/master/disassociate" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateMembers": { + "http": { + "requestUri": "/members/disassociate" + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "EnableImportFindingsForProduct": { + "http": { + "requestUri": "/productSubscriptions" + }, + "input": { + "type": "structure", + "required": [ + "ProductArn" + ], + "members": { + "ProductArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProductSubscriptionArn": {} + } + } + }, + "EnableSecurityHub": { + "http": { + "requestUri": "/accounts" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetEnabledStandards": { + "http": { + "requestUri": "/standards/get" + }, + "input": { + "type": "structure", + "members": { + "StandardsSubscriptionArns": { + "shape": "S5" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "StandardsSubscriptions": { + "shape": "S7" + }, + "NextToken": {} + } + } + }, + "GetFindings": { + "http": { + "requestUri": "/findings" + }, + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S1m" + }, + "SortCriteria": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Field": {}, + "SortOrder": {} + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Findings" + ], + "members": { + "Findings": { + "shape": "Sg" + }, + "NextToken": {} + } + } + }, + "GetInsightResults": { + "http": { + "method": "GET", + "requestUri": "/insights/results/{InsightArn+}" + }, + "input": { + "type": "structure", + "required": [ + "InsightArn" + ], + "members": { + "InsightArn": { + "location": "uri", + "locationName": "InsightArn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "InsightResults" + ], + "members": { + "InsightResults": { + "type": "structure", + "required": [ + "InsightArn", + "GroupByAttribute", + "ResultValues" + ], + "members": { + "InsightArn": {}, + "GroupByAttribute": {}, + "ResultValues": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "GroupByAttributeValue", + "Count" + ], + "members": { + "GroupByAttributeValue": {}, + "Count": { + "type": "integer" + } + } + } + } + } + } + } + } + }, + "GetInsights": { + "http": { + "requestUri": "/insights/get" + }, + "input": { + "type": "structure", + "members": { + "InsightArns": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Insights" + ], + "members": { + "Insights": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InsightArn", + "Name", + "Filters", + "GroupByAttribute" + ], + "members": { + "InsightArn": {}, + "Name": {}, + "Filters": { + "shape": "S1m" + }, + "GroupByAttribute": {} + } + } + }, + "NextToken": {} + } + } + }, + "GetInvitationsCount": { + "http": { + "method": "GET", + "requestUri": "/invitations/count" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "InvitationsCount": { + "type": "integer" + } + } + } + }, + "GetMasterAccount": { + "http": { + "method": "GET", + "requestUri": "/master" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "Master": { + "shape": "S3j" + } + } + } + }, + "GetMembers": { + "http": { + "requestUri": "/members/get" + }, + "input": { + "type": "structure", + "required": [ + "AccountIds" + ], + "members": { + "AccountIds": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "Members": { + "shape": "S3n" + }, + "UnprocessedAccounts": { + "shape": "S29" + } + } + } + }, + "InviteMembers": { + "http": { + "requestUri": "/members/invite" + }, + "input": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S2c" + } + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "shape": "S29" + } + } + } + }, + "ListEnabledProductsForImport": { + "http": { + "method": "GET", + "requestUri": "/productSubscriptions" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProductSubscriptions": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ListInvitations": { + "http": { + "method": "GET", + "requestUri": "/invitations" + }, + "input": { + "type": "structure", + "members": { + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invitations": { + "type": "list", + "member": { + "shape": "S3j" + } + }, + "NextToken": {} + } + } + }, + "ListMembers": { + "http": { + "method": "GET", + "requestUri": "/members" + }, + "input": { + "type": "structure", + "members": { + "OnlyAssociated": { + "location": "querystring", + "locationName": "OnlyAssociated", + "type": "boolean" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Members": { + "shape": "S3n" + }, + "NextToken": {} + } + } + }, + "UpdateFindings": { + "http": { + "method": "PATCH", + "requestUri": "/findings" + }, + "input": { + "type": "structure", + "required": [ + "Filters" + ], + "members": { + "Filters": { + "shape": "S1m" + }, + "Note": { + "type": "structure", + "required": [ + "Text", + "UpdatedBy" + ], + "members": { + "Text": {}, + "UpdatedBy": {} + } + }, + "RecordState": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateInsight": { + "http": { + "method": "PATCH", + "requestUri": "/insights/{InsightArn+}" + }, + "input": { + "type": "structure", + "required": [ + "InsightArn" + ], + "members": { + "InsightArn": { + "location": "uri", + "locationName": "InsightArn" + }, + "Name": {}, + "Filters": { + "shape": "S1m" + }, + "GroupByAttribute": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S5": { + "type": "list", + "member": {} + }, + "S7": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StandardsSubscriptionArn", + "StandardsArn", + "StandardsInput", + "StandardsStatus" + ], + "members": { + "StandardsSubscriptionArn": {}, + "StandardsArn": {}, + "StandardsInput": { + "shape": "S9" + }, + "StandardsStatus": {} + } + } + }, + "S9": { + "type": "map", + "key": {}, + "value": {} + }, + "Sg": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SchemaVersion", + "Id", + "ProductArn", + "GeneratorId", + "AwsAccountId", + "Types", + "CreatedAt", + "UpdatedAt", + "Severity", + "Resources" + ], + "members": { + "SchemaVersion": {}, + "Id": {}, + "ProductArn": {}, + "GeneratorId": {}, + "AwsAccountId": {}, + "Types": { + "type": "list", + "member": {} + }, + "FirstObservedAt": {}, + "LastObservedAt": {}, + "CreatedAt": {}, + "UpdatedAt": {}, + "Severity": { + "type": "structure", + "required": [ + "Normalized" + ], + "members": { + "Product": { + "type": "double" + }, + "Normalized": { + "type": "integer" + } + } + }, + "Confidence": { + "type": "integer" + }, + "Criticality": { + "type": "integer" + }, + "Title": {}, + "Description": {}, + "Remediation": { + "type": "structure", + "members": { + "Recommendation": { + "type": "structure", + "members": { + "Text": {}, + "Url": {} + } + } + } + }, + "SourceUrl": {}, + "ProductFields": { + "shape": "So" + }, + "UserDefinedFields": { + "shape": "So" + }, + "Malware": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Type": {}, + "Path": {}, + "State": {} + } + } + }, + "Network": { + "type": "structure", + "members": { + "Direction": {}, + "Protocol": {}, + "SourceIpV4": {}, + "SourceIpV6": {}, + "SourcePort": { + "type": "integer" + }, + "SourceDomain": {}, + "SourceMac": {}, + "DestinationIpV4": {}, + "DestinationIpV6": {}, + "DestinationPort": { + "type": "integer" + }, + "DestinationDomain": {} + } + }, + "Process": { + "type": "structure", + "members": { + "Name": {}, + "Path": {}, + "Pid": { + "type": "integer" + }, + "ParentPid": { + "type": "integer" + }, + "LaunchedAt": {}, + "TerminatedAt": {} + } + }, + "ThreatIntelIndicators": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Value": {}, + "Category": {}, + "LastObservedAt": {}, + "Source": {}, + "SourceUrl": {} + } + } + }, + "Resources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Type", + "Id" + ], + "members": { + "Type": {}, + "Id": {}, + "Partition": {}, + "Region": {}, + "Tags": { + "shape": "So" + }, + "Details": { + "type": "structure", + "members": { + "AwsEc2Instance": { + "type": "structure", + "members": { + "Type": {}, + "ImageId": {}, + "IpV4Addresses": { + "shape": "S15" + }, + "IpV6Addresses": { + "shape": "S15" + }, + "KeyName": {}, + "IamInstanceProfileArn": {}, + "VpcId": {}, + "SubnetId": {}, + "LaunchedAt": {} + } + }, + "AwsS3Bucket": { + "type": "structure", + "members": { + "OwnerId": {}, + "OwnerName": {} + } + }, + "AwsIamAccessKey": { + "type": "structure", + "members": { + "UserName": {}, + "Status": {}, + "CreatedAt": {} + } + }, + "Container": { + "type": "structure", + "members": { + "Name": {}, + "ImageId": {}, + "ImageName": {}, + "LaunchedAt": {} + } + }, + "Other": { + "shape": "So" + } + } + } + } + } + }, + "Compliance": { + "type": "structure", + "members": { + "Status": {} + } + }, + "VerificationState": {}, + "WorkflowState": {}, + "RecordState": {}, + "RelatedFindings": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ProductArn", + "Id" + ], + "members": { + "ProductArn": {}, + "Id": {} + } + } + }, + "Note": { + "type": "structure", + "required": [ + "Text", + "UpdatedBy", + "UpdatedAt" + ], + "members": { + "Text": {}, + "UpdatedBy": {}, + "UpdatedAt": {} + } + } + } + } + }, + "So": { + "type": "map", + "key": {}, + "value": {} + }, + "S15": { + "type": "list", + "member": {} + }, + "S1m": { + "type": "structure", + "members": { + "ProductArn": { + "shape": "S1n" + }, + "AwsAccountId": { + "shape": "S1n" + }, + "Id": { + "shape": "S1n" + }, + "GeneratorId": { + "shape": "S1n" + }, + "Type": { + "shape": "S1n" + }, + "FirstObservedAt": { + "shape": "S1q" + }, + "LastObservedAt": { + "shape": "S1q" + }, + "CreatedAt": { + "shape": "S1q" + }, + "UpdatedAt": { + "shape": "S1q" + }, + "SeverityProduct": { + "shape": "S1u" + }, + "SeverityNormalized": { + "shape": "S1u" + }, + "SeverityLabel": { + "shape": "S1n" + }, + "Confidence": { + "shape": "S1u" + }, + "Criticality": { + "shape": "S1u" + }, + "Title": { + "shape": "S1n" + }, + "Description": { + "shape": "S1n" + }, + "RecommendationText": { + "shape": "S1n" + }, + "SourceUrl": { + "shape": "S1n" + }, + "ProductFields": { + "shape": "S1w" + }, + "ProductName": { + "shape": "S1n" + }, + "CompanyName": { + "shape": "S1n" + }, + "UserDefinedFields": { + "shape": "S1w" + }, + "MalwareName": { + "shape": "S1n" + }, + "MalwareType": { + "shape": "S1n" + }, + "MalwarePath": { + "shape": "S1n" + }, + "MalwareState": { + "shape": "S1n" + }, + "NetworkDirection": { + "shape": "S1n" + }, + "NetworkProtocol": { + "shape": "S1n" + }, + "NetworkSourceIpV4": { + "shape": "S1z" + }, + "NetworkSourceIpV6": { + "shape": "S1z" + }, + "NetworkSourcePort": { + "shape": "S1u" + }, + "NetworkSourceDomain": { + "shape": "S1n" + }, + "NetworkSourceMac": { + "shape": "S1n" + }, + "NetworkDestinationIpV4": { + "shape": "S1z" + }, + "NetworkDestinationIpV6": { + "shape": "S1z" + }, + "NetworkDestinationPort": { + "shape": "S1u" + }, + "NetworkDestinationDomain": { + "shape": "S1n" + }, + "ProcessName": { + "shape": "S1n" + }, + "ProcessPath": { + "shape": "S1n" + }, + "ProcessPid": { + "shape": "S1u" + }, + "ProcessParentPid": { + "shape": "S1u" + }, + "ProcessLaunchedAt": { + "shape": "S1q" + }, + "ProcessTerminatedAt": { + "shape": "S1q" + }, + "ThreatIntelIndicatorType": { + "shape": "S1n" + }, + "ThreatIntelIndicatorValue": { + "shape": "S1n" + }, + "ThreatIntelIndicatorCategory": { + "shape": "S1n" + }, + "ThreatIntelIndicatorLastObservedAt": { + "shape": "S1q" + }, + "ThreatIntelIndicatorSource": { + "shape": "S1n" + }, + "ThreatIntelIndicatorSourceUrl": { + "shape": "S1n" + }, + "ResourceType": { + "shape": "S1n" + }, + "ResourceId": { + "shape": "S1n" + }, + "ResourcePartition": { + "shape": "S1n" + }, + "ResourceRegion": { + "shape": "S1n" + }, + "ResourceTags": { + "shape": "S1w" + }, + "ResourceAwsEc2InstanceType": { + "shape": "S1n" + }, + "ResourceAwsEc2InstanceImageId": { + "shape": "S1n" + }, + "ResourceAwsEc2InstanceIpV4Addresses": { + "shape": "S1z" + }, + "ResourceAwsEc2InstanceIpV6Addresses": { + "shape": "S1z" + }, + "ResourceAwsEc2InstanceKeyName": { + "shape": "S1n" + }, + "ResourceAwsEc2InstanceIamInstanceProfileArn": { + "shape": "S1n" + }, + "ResourceAwsEc2InstanceVpcId": { + "shape": "S1n" + }, + "ResourceAwsEc2InstanceSubnetId": { + "shape": "S1n" + }, + "ResourceAwsEc2InstanceLaunchedAt": { + "shape": "S1q" + }, + "ResourceAwsS3BucketOwnerId": { + "shape": "S1n" + }, + "ResourceAwsS3BucketOwnerName": { + "shape": "S1n" + }, + "ResourceAwsIamAccessKeyUserName": { + "shape": "S1n" + }, + "ResourceAwsIamAccessKeyStatus": { + "shape": "S1n" + }, + "ResourceAwsIamAccessKeyCreatedAt": { + "shape": "S1q" + }, + "ResourceContainerName": { + "shape": "S1n" + }, + "ResourceContainerImageId": { + "shape": "S1n" + }, + "ResourceContainerImageName": { + "shape": "S1n" + }, + "ResourceContainerLaunchedAt": { + "shape": "S1q" + }, + "ResourceDetailsOther": { + "shape": "S1w" + }, + "ComplianceStatus": { + "shape": "S1n" + }, + "VerificationState": { + "shape": "S1n" + }, + "WorkflowState": { + "shape": "S1n" + }, + "RecordState": { + "shape": "S1n" + }, + "RelatedFindingsProductArn": { + "shape": "S1n" + }, + "RelatedFindingsId": { + "shape": "S1n" + }, + "NoteText": { + "shape": "S1n" + }, + "NoteUpdatedAt": { + "shape": "S1q" + }, + "NoteUpdatedBy": { + "shape": "S1n" + }, + "Keyword": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": {} + } + } + } + } + }, + "S1n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": {}, + "Comparison": {} + } + } + }, + "S1q": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Start": {}, + "End": {}, + "DateRange": { + "type": "structure", + "members": { + "Value": { + "type": "integer" + }, + "Unit": {} + } + } + } + } + }, + "S1u": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Gte": { + "type": "double" + }, + "Lte": { + "type": "double" + }, + "Eq": { + "type": "double" + } + } + } + }, + "S1w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "Comparison": {} + } + } + }, + "S1z": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Cidr": {} + } + } + }, + "S29": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": {}, + "ProcessingResult": {} + } + } + }, + "S2c": { + "type": "list", + "member": {} + }, + "S3j": { + "type": "structure", + "members": { + "AccountId": {}, + "InvitationId": {}, + "InvitedAt": { + "shape": "S3k" + }, + "MemberStatus": {} + } + }, + "S3k": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "S3n": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AccountId": {}, + "Email": {}, + "MasterId": {}, + "MemberStatus": {}, + "InvitedAt": { + "shape": "S3k" + }, + "UpdatedAt": { + "shape": "S3k" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/securityhub-2018-10-26.paginators.json b/node_modules/aws-sdk/apis/securityhub-2018-10-26.paginators.json new file mode 100644 index 0000000..83851d3 --- /dev/null +++ b/node_modules/aws-sdk/apis/securityhub-2018-10-26.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "GetFindings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetInsights": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListEnabledProductsForImport": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/serverlessrepo-2017-09-08.min.json b/node_modules/aws-sdk/apis/serverlessrepo-2017-09-08.min.json new file mode 100644 index 0000000..60a50b1 --- /dev/null +++ b/node_modules/aws-sdk/apis/serverlessrepo-2017-09-08.min.json @@ -0,0 +1,964 @@ +{ + "metadata": { + "apiVersion": "2017-09-08", + "endpointPrefix": "serverlessrepo", + "signingName": "serverlessrepo", + "serviceFullName": "AWSServerlessApplicationRepository", + "serviceId": "ServerlessApplicationRepository", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "serverlessrepo-2017-09-08", + "signatureVersion": "v4" + }, + "operations": { + "CreateApplication": { + "http": { + "requestUri": "/applications", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "Author": { + "locationName": "author" + }, + "Description": { + "locationName": "description" + }, + "HomePageUrl": { + "locationName": "homePageUrl" + }, + "Labels": { + "shape": "S3", + "locationName": "labels" + }, + "LicenseBody": { + "locationName": "licenseBody" + }, + "LicenseUrl": { + "locationName": "licenseUrl" + }, + "Name": { + "locationName": "name" + }, + "ReadmeBody": { + "locationName": "readmeBody" + }, + "ReadmeUrl": { + "locationName": "readmeUrl" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "SourceCodeArchiveUrl": { + "locationName": "sourceCodeArchiveUrl" + }, + "SourceCodeUrl": { + "locationName": "sourceCodeUrl" + }, + "SpdxLicenseId": { + "locationName": "spdxLicenseId" + }, + "TemplateBody": { + "locationName": "templateBody" + }, + "TemplateUrl": { + "locationName": "templateUrl" + } + }, + "required": [ + "Description", + "Name", + "Author" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "Author": { + "locationName": "author" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "Description": { + "locationName": "description" + }, + "HomePageUrl": { + "locationName": "homePageUrl" + }, + "Labels": { + "shape": "S3", + "locationName": "labels" + }, + "LicenseUrl": { + "locationName": "licenseUrl" + }, + "Name": { + "locationName": "name" + }, + "ReadmeUrl": { + "locationName": "readmeUrl" + }, + "SpdxLicenseId": { + "locationName": "spdxLicenseId" + }, + "Version": { + "shape": "S5", + "locationName": "version" + } + } + } + }, + "CreateApplicationVersion": { + "http": { + "method": "PUT", + "requestUri": "/applications/{applicationId}/versions/{semanticVersion}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "SemanticVersion": { + "location": "uri", + "locationName": "semanticVersion" + }, + "SourceCodeArchiveUrl": { + "locationName": "sourceCodeArchiveUrl" + }, + "SourceCodeUrl": { + "locationName": "sourceCodeUrl" + }, + "TemplateBody": { + "locationName": "templateBody" + }, + "TemplateUrl": { + "locationName": "templateUrl" + } + }, + "required": [ + "ApplicationId", + "SemanticVersion" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "ParameterDefinitions": { + "shape": "S6", + "locationName": "parameterDefinitions" + }, + "RequiredCapabilities": { + "shape": "Sa", + "locationName": "requiredCapabilities" + }, + "ResourcesSupported": { + "locationName": "resourcesSupported", + "type": "boolean" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "SourceCodeArchiveUrl": { + "locationName": "sourceCodeArchiveUrl" + }, + "SourceCodeUrl": { + "locationName": "sourceCodeUrl" + }, + "TemplateUrl": { + "locationName": "templateUrl" + } + } + } + }, + "CreateCloudFormationChangeSet": { + "http": { + "requestUri": "/applications/{applicationId}/changesets", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "Capabilities": { + "shape": "S3", + "locationName": "capabilities" + }, + "ChangeSetName": { + "locationName": "changeSetName" + }, + "ClientToken": { + "locationName": "clientToken" + }, + "Description": { + "locationName": "description" + }, + "NotificationArns": { + "shape": "S3", + "locationName": "notificationArns" + }, + "ParameterOverrides": { + "locationName": "parameterOverrides", + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": { + "locationName": "name" + }, + "Value": { + "locationName": "value" + } + }, + "required": [ + "Value", + "Name" + ] + } + }, + "ResourceTypes": { + "shape": "S3", + "locationName": "resourceTypes" + }, + "RollbackConfiguration": { + "locationName": "rollbackConfiguration", + "type": "structure", + "members": { + "MonitoringTimeInMinutes": { + "locationName": "monitoringTimeInMinutes", + "type": "integer" + }, + "RollbackTriggers": { + "locationName": "rollbackTriggers", + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": { + "locationName": "arn" + }, + "Type": { + "locationName": "type" + } + }, + "required": [ + "Type", + "Arn" + ] + } + } + } + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "StackName": { + "locationName": "stackName" + }, + "Tags": { + "locationName": "tags", + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": { + "locationName": "key" + }, + "Value": { + "locationName": "value" + } + }, + "required": [ + "Value", + "Key" + ] + } + }, + "TemplateId": { + "locationName": "templateId" + } + }, + "required": [ + "ApplicationId", + "StackName" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "ChangeSetId": { + "locationName": "changeSetId" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "StackId": { + "locationName": "stackId" + } + } + } + }, + "CreateCloudFormationTemplate": { + "http": { + "requestUri": "/applications/{applicationId}/templates", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "ExpirationTime": { + "locationName": "expirationTime" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "Status": { + "locationName": "status" + }, + "TemplateId": { + "locationName": "templateId" + }, + "TemplateUrl": { + "locationName": "templateUrl" + } + } + } + }, + "DeleteApplication": { + "http": { + "method": "DELETE", + "requestUri": "/applications/{applicationId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + } + }, + "required": [ + "ApplicationId" + ] + } + }, + "GetApplication": { + "http": { + "method": "GET", + "requestUri": "/applications/{applicationId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "SemanticVersion": { + "location": "querystring", + "locationName": "semanticVersion" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "Author": { + "locationName": "author" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "Description": { + "locationName": "description" + }, + "HomePageUrl": { + "locationName": "homePageUrl" + }, + "Labels": { + "shape": "S3", + "locationName": "labels" + }, + "LicenseUrl": { + "locationName": "licenseUrl" + }, + "Name": { + "locationName": "name" + }, + "ReadmeUrl": { + "locationName": "readmeUrl" + }, + "SpdxLicenseId": { + "locationName": "spdxLicenseId" + }, + "Version": { + "shape": "S5", + "locationName": "version" + } + } + } + }, + "GetApplicationPolicy": { + "http": { + "method": "GET", + "requestUri": "/applications/{applicationId}/policy", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "Statements": { + "shape": "Sv", + "locationName": "statements" + } + } + } + }, + "GetCloudFormationTemplate": { + "http": { + "method": "GET", + "requestUri": "/applications/{applicationId}/templates/{templateId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "TemplateId": { + "location": "uri", + "locationName": "templateId" + } + }, + "required": [ + "ApplicationId", + "TemplateId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "ExpirationTime": { + "locationName": "expirationTime" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "Status": { + "locationName": "status" + }, + "TemplateId": { + "locationName": "templateId" + }, + "TemplateUrl": { + "locationName": "templateUrl" + } + } + } + }, + "ListApplicationDependencies": { + "http": { + "method": "GET", + "requestUri": "/applications/{applicationId}/dependencies", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxItems", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "SemanticVersion": { + "location": "querystring", + "locationName": "semanticVersion" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "Dependencies": { + "locationName": "dependencies", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + } + }, + "required": [ + "ApplicationId", + "SemanticVersion" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "ListApplicationVersions": { + "http": { + "method": "GET", + "requestUri": "/applications/{applicationId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxItems", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "NextToken": { + "locationName": "nextToken" + }, + "Versions": { + "locationName": "versions", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "SourceCodeUrl": { + "locationName": "sourceCodeUrl" + } + }, + "required": [ + "CreationTime", + "ApplicationId", + "SemanticVersion" + ] + } + } + } + } + }, + "ListApplications": { + "http": { + "method": "GET", + "requestUri": "/applications", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "MaxItems": { + "location": "querystring", + "locationName": "maxItems", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Applications": { + "locationName": "applications", + "type": "list", + "member": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "Author": { + "locationName": "author" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "Description": { + "locationName": "description" + }, + "HomePageUrl": { + "locationName": "homePageUrl" + }, + "Labels": { + "shape": "S3", + "locationName": "labels" + }, + "Name": { + "locationName": "name" + }, + "SpdxLicenseId": { + "locationName": "spdxLicenseId" + } + }, + "required": [ + "Description", + "Author", + "ApplicationId", + "Name" + ] + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "PutApplicationPolicy": { + "http": { + "method": "PUT", + "requestUri": "/applications/{applicationId}/policy", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "Statements": { + "shape": "Sv", + "locationName": "statements" + } + }, + "required": [ + "ApplicationId", + "Statements" + ] + }, + "output": { + "type": "structure", + "members": { + "Statements": { + "shape": "Sv", + "locationName": "statements" + } + } + } + }, + "UpdateApplication": { + "http": { + "method": "PATCH", + "requestUri": "/applications/{applicationId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ApplicationId": { + "location": "uri", + "locationName": "applicationId" + }, + "Author": { + "locationName": "author" + }, + "Description": { + "locationName": "description" + }, + "HomePageUrl": { + "locationName": "homePageUrl" + }, + "Labels": { + "shape": "S3", + "locationName": "labels" + }, + "ReadmeBody": { + "locationName": "readmeBody" + }, + "ReadmeUrl": { + "locationName": "readmeUrl" + } + }, + "required": [ + "ApplicationId" + ] + }, + "output": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "Author": { + "locationName": "author" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "Description": { + "locationName": "description" + }, + "HomePageUrl": { + "locationName": "homePageUrl" + }, + "Labels": { + "shape": "S3", + "locationName": "labels" + }, + "LicenseUrl": { + "locationName": "licenseUrl" + }, + "Name": { + "locationName": "name" + }, + "ReadmeUrl": { + "locationName": "readmeUrl" + }, + "SpdxLicenseId": { + "locationName": "spdxLicenseId" + }, + "Version": { + "shape": "S5", + "locationName": "version" + } + } + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": {} + }, + "S5": { + "type": "structure", + "members": { + "ApplicationId": { + "locationName": "applicationId" + }, + "CreationTime": { + "locationName": "creationTime" + }, + "ParameterDefinitions": { + "shape": "S6", + "locationName": "parameterDefinitions" + }, + "RequiredCapabilities": { + "shape": "Sa", + "locationName": "requiredCapabilities" + }, + "ResourcesSupported": { + "locationName": "resourcesSupported", + "type": "boolean" + }, + "SemanticVersion": { + "locationName": "semanticVersion" + }, + "SourceCodeArchiveUrl": { + "locationName": "sourceCodeArchiveUrl" + }, + "SourceCodeUrl": { + "locationName": "sourceCodeUrl" + }, + "TemplateUrl": { + "locationName": "templateUrl" + } + }, + "required": [ + "TemplateUrl", + "ParameterDefinitions", + "ResourcesSupported", + "CreationTime", + "RequiredCapabilities", + "ApplicationId", + "SemanticVersion" + ] + }, + "S6": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AllowedPattern": { + "locationName": "allowedPattern" + }, + "AllowedValues": { + "shape": "S3", + "locationName": "allowedValues" + }, + "ConstraintDescription": { + "locationName": "constraintDescription" + }, + "DefaultValue": { + "locationName": "defaultValue" + }, + "Description": { + "locationName": "description" + }, + "MaxLength": { + "locationName": "maxLength", + "type": "integer" + }, + "MaxValue": { + "locationName": "maxValue", + "type": "integer" + }, + "MinLength": { + "locationName": "minLength", + "type": "integer" + }, + "MinValue": { + "locationName": "minValue", + "type": "integer" + }, + "Name": { + "locationName": "name" + }, + "NoEcho": { + "locationName": "noEcho", + "type": "boolean" + }, + "ReferencedByResources": { + "shape": "S3", + "locationName": "referencedByResources" + }, + "Type": { + "locationName": "type" + } + }, + "required": [ + "ReferencedByResources", + "Name" + ] + } + }, + "Sa": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Actions": { + "shape": "S3", + "locationName": "actions" + }, + "Principals": { + "shape": "S3", + "locationName": "principals" + }, + "StatementId": { + "locationName": "statementId" + } + }, + "required": [ + "Principals", + "Actions" + ] + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/serverlessrepo-2017-09-08.paginators.json b/node_modules/aws-sdk/apis/serverlessrepo-2017-09-08.paginators.json new file mode 100644 index 0000000..a407a3b --- /dev/null +++ b/node_modules/aws-sdk/apis/serverlessrepo-2017-09-08.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination" : { + "ListApplicationVersions" : { + "input_token" : "NextToken", + "output_token" : "NextToken", + "limit_key" : "MaxItems" + }, + "ListApplications" : { + "input_token" : "NextToken", + "output_token" : "NextToken", + "limit_key" : "MaxItems" + }, + "ListApplicationDependencies" : { + "input_token" : "NextToken", + "output_token" : "NextToken", + "limit_key" : "MaxItems" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.examples.json b/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.min.json b/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.min.json new file mode 100644 index 0000000..157c9f7 --- /dev/null +++ b/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.min.json @@ -0,0 +1,2623 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-12-10", + "endpointPrefix": "servicecatalog", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Service Catalog", + "serviceId": "Service Catalog", + "signatureVersion": "v4", + "targetPrefix": "AWS242ServiceCatalogService", + "uid": "servicecatalog-2015-12-10" + }, + "operations": { + "AcceptPortfolioShare": { + "input": { + "type": "structure", + "required": [ + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "PortfolioShareType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateBudgetWithResource": { + "input": { + "type": "structure", + "required": [ + "BudgetName", + "ResourceId" + ], + "members": { + "BudgetName": {}, + "ResourceId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociatePrincipalWithPortfolio": { + "input": { + "type": "structure", + "required": [ + "PortfolioId", + "PrincipalARN", + "PrincipalType" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "PrincipalARN": {}, + "PrincipalType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateProductWithPortfolio": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "PortfolioId": {}, + "SourcePortfolioId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateServiceActionWithProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "ProvisioningArtifactId", + "ServiceActionId" + ], + "members": { + "ProductId": {}, + "ProvisioningArtifactId": {}, + "ServiceActionId": {}, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateTagOptionWithResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagOptionId" + ], + "members": { + "ResourceId": {}, + "TagOptionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "BatchAssociateServiceActionWithProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ServiceActionAssociations" + ], + "members": { + "ServiceActionAssociations": { + "shape": "Sm" + }, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "FailedServiceActionAssociations": { + "shape": "Sp" + } + } + } + }, + "BatchDisassociateServiceActionFromProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ServiceActionAssociations" + ], + "members": { + "ServiceActionAssociations": { + "shape": "Sm" + }, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "FailedServiceActionAssociations": { + "shape": "Sp" + } + } + } + }, + "CopyProduct": { + "input": { + "type": "structure", + "required": [ + "SourceProductArn", + "IdempotencyToken" + ], + "members": { + "AcceptLanguage": {}, + "SourceProductArn": {}, + "TargetProductId": {}, + "TargetProductName": {}, + "SourceProvisioningArtifactIdentifiers": { + "type": "list", + "member": { + "type": "map", + "key": {}, + "value": {} + } + }, + "CopyOptions": { + "type": "list", + "member": {} + }, + "IdempotencyToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "CopyProductToken": {} + } + } + }, + "CreateConstraint": { + "input": { + "type": "structure", + "required": [ + "PortfolioId", + "ProductId", + "Parameters", + "Type", + "IdempotencyToken" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "ProductId": {}, + "Parameters": {}, + "Type": {}, + "Description": {}, + "IdempotencyToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ConstraintDetail": { + "shape": "S1b" + }, + "ConstraintParameters": {}, + "Status": {} + } + } + }, + "CreatePortfolio": { + "input": { + "type": "structure", + "required": [ + "DisplayName", + "ProviderName", + "IdempotencyToken" + ], + "members": { + "AcceptLanguage": {}, + "DisplayName": {}, + "Description": {}, + "ProviderName": {}, + "Tags": { + "shape": "S1i" + }, + "IdempotencyToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioDetail": { + "shape": "S1n" + }, + "Tags": { + "shape": "S1q" + } + } + } + }, + "CreatePortfolioShare": { + "input": { + "type": "structure", + "required": [ + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "AccountId": {}, + "OrganizationNode": { + "shape": "S1s" + } + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioShareToken": {} + } + } + }, + "CreateProduct": { + "input": { + "type": "structure", + "required": [ + "Name", + "Owner", + "ProductType", + "ProvisioningArtifactParameters", + "IdempotencyToken" + ], + "members": { + "AcceptLanguage": {}, + "Name": {}, + "Owner": {}, + "Description": {}, + "Distributor": {}, + "SupportDescription": {}, + "SupportEmail": {}, + "SupportUrl": {}, + "ProductType": {}, + "Tags": { + "shape": "S1i" + }, + "ProvisioningArtifactParameters": { + "shape": "S23" + }, + "IdempotencyToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ProductViewDetail": { + "shape": "S2c" + }, + "ProvisioningArtifactDetail": { + "shape": "S2h" + }, + "Tags": { + "shape": "S1q" + } + } + } + }, + "CreateProvisionedProductPlan": { + "input": { + "type": "structure", + "required": [ + "PlanName", + "PlanType", + "ProductId", + "ProvisionedProductName", + "ProvisioningArtifactId", + "IdempotencyToken" + ], + "members": { + "AcceptLanguage": {}, + "PlanName": {}, + "PlanType": {}, + "NotificationArns": { + "shape": "S2m" + }, + "PathId": {}, + "ProductId": {}, + "ProvisionedProductName": {}, + "ProvisioningArtifactId": {}, + "ProvisioningParameters": { + "shape": "S2p" + }, + "IdempotencyToken": { + "idempotencyToken": true + }, + "Tags": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "PlanName": {}, + "PlanId": {}, + "ProvisionProductId": {}, + "ProvisionedProductName": {}, + "ProvisioningArtifactId": {} + } + } + }, + "CreateProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "Parameters", + "IdempotencyToken" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "Parameters": { + "shape": "S23" + }, + "IdempotencyToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ProvisioningArtifactDetail": { + "shape": "S2h" + }, + "Info": { + "shape": "S26" + }, + "Status": {} + } + } + }, + "CreateServiceAction": { + "input": { + "type": "structure", + "required": [ + "Name", + "DefinitionType", + "Definition", + "IdempotencyToken" + ], + "members": { + "Name": {}, + "DefinitionType": {}, + "Definition": { + "shape": "S30" + }, + "Description": {}, + "AcceptLanguage": {}, + "IdempotencyToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "ServiceActionDetail": { + "shape": "S35" + } + } + } + }, + "CreateTagOption": { + "input": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + }, + "output": { + "type": "structure", + "members": { + "TagOptionDetail": { + "shape": "S3b" + } + } + } + }, + "DeleteConstraint": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePortfolio": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePortfolioShare": { + "input": { + "type": "structure", + "required": [ + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "AccountId": {}, + "OrganizationNode": { + "shape": "S1s" + } + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioShareToken": {} + } + } + }, + "DeleteProduct": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteProvisionedProductPlan": { + "input": { + "type": "structure", + "required": [ + "PlanId" + ], + "members": { + "AcceptLanguage": {}, + "PlanId": {}, + "IgnoreErrors": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "ProvisioningArtifactId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "ProvisioningArtifactId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteServiceAction": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTagOption": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeConstraint": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConstraintDetail": { + "shape": "S1b" + }, + "ConstraintParameters": {}, + "Status": {} + } + } + }, + "DescribeCopyProductStatus": { + "input": { + "type": "structure", + "required": [ + "CopyProductToken" + ], + "members": { + "AcceptLanguage": {}, + "CopyProductToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "CopyProductStatus": {}, + "TargetProductId": {}, + "StatusDetail": {} + } + } + }, + "DescribePortfolio": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioDetail": { + "shape": "S1n" + }, + "Tags": { + "shape": "S1q" + }, + "TagOptions": { + "shape": "S42" + }, + "Budgets": { + "shape": "S43" + } + } + } + }, + "DescribePortfolioShareStatus": { + "input": { + "type": "structure", + "required": [ + "PortfolioShareToken" + ], + "members": { + "PortfolioShareToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioShareToken": {}, + "PortfolioId": {}, + "OrganizationNodeValue": {}, + "Status": {}, + "ShareDetails": { + "type": "structure", + "members": { + "SuccessfulShares": { + "type": "list", + "member": {} + }, + "ShareErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Accounts": { + "type": "list", + "member": {} + }, + "Message": {}, + "Error": {} + } + } + } + } + } + } + } + }, + "DescribeProduct": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProductViewSummary": { + "shape": "S2d" + }, + "ProvisioningArtifacts": { + "shape": "S4h" + }, + "Budgets": { + "shape": "S43" + } + } + } + }, + "DescribeProductAsAdmin": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProductViewDetail": { + "shape": "S2c" + }, + "ProvisioningArtifactSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Description": {}, + "CreatedTime": { + "type": "timestamp" + }, + "ProvisioningArtifactMetadata": { + "shape": "S26" + } + } + } + }, + "Tags": { + "shape": "S1q" + }, + "TagOptions": { + "shape": "S42" + }, + "Budgets": { + "shape": "S43" + } + } + } + }, + "DescribeProductView": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProductViewSummary": { + "shape": "S2d" + }, + "ProvisioningArtifacts": { + "shape": "S4h" + } + } + } + }, + "DescribeProvisionedProduct": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProvisionedProductDetail": { + "shape": "S4s" + }, + "CloudWatchDashboards": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + } + } + } + }, + "DescribeProvisionedProductPlan": { + "input": { + "type": "structure", + "required": [ + "PlanId" + ], + "members": { + "AcceptLanguage": {}, + "PlanId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProvisionedProductPlanDetails": { + "type": "structure", + "members": { + "CreatedTime": { + "type": "timestamp" + }, + "PathId": {}, + "ProductId": {}, + "PlanName": {}, + "PlanId": {}, + "ProvisionProductId": {}, + "ProvisionProductName": {}, + "PlanType": {}, + "ProvisioningArtifactId": {}, + "Status": {}, + "UpdatedTime": { + "type": "timestamp" + }, + "NotificationArns": { + "shape": "S2m" + }, + "ProvisioningParameters": { + "shape": "S2p" + }, + "Tags": { + "shape": "S1q" + }, + "StatusMessage": {} + } + }, + "ResourceChanges": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Action": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "Replacement": {}, + "Scope": { + "type": "list", + "member": {} + }, + "Details": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Target": { + "type": "structure", + "members": { + "Attribute": {}, + "Name": {}, + "RequiresRecreation": {} + } + }, + "Evaluation": {}, + "CausingEntity": {} + } + } + } + } + } + }, + "NextPageToken": {} + } + } + }, + "DescribeProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ProvisioningArtifactId", + "ProductId" + ], + "members": { + "AcceptLanguage": {}, + "ProvisioningArtifactId": {}, + "ProductId": {}, + "Verbose": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProvisioningArtifactDetail": { + "shape": "S2h" + }, + "Info": { + "shape": "S26" + }, + "Status": {} + } + } + }, + "DescribeProvisioningParameters": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "ProvisioningArtifactId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "ProvisioningArtifactId": {}, + "PathId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProvisioningArtifactParameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterKey": {}, + "DefaultValue": {}, + "ParameterType": {}, + "IsNoEcho": { + "type": "boolean" + }, + "Description": {}, + "ParameterConstraints": { + "type": "structure", + "members": { + "AllowedValues": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "ConstraintSummaries": { + "shape": "S64" + }, + "UsageInstructions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Value": {} + } + } + }, + "TagOptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "ProvisioningArtifactPreferences": { + "type": "structure", + "members": { + "StackSetAccounts": { + "shape": "S6e" + }, + "StackSetRegions": { + "shape": "S6f" + } + } + } + } + } + }, + "DescribeRecord": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {}, + "PageToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "RecordDetail": { + "shape": "S6j" + }, + "RecordOutputs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "OutputKey": {}, + "OutputValue": {}, + "Description": {} + } + } + }, + "NextPageToken": {} + } + } + }, + "DescribeServiceAction": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceActionDetail": { + "shape": "S35" + } + } + } + }, + "DescribeTagOption": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "TagOptionDetail": { + "shape": "S3b" + } + } + } + }, + "DisableAWSOrganizationsAccess": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateBudgetFromResource": { + "input": { + "type": "structure", + "required": [ + "BudgetName", + "ResourceId" + ], + "members": { + "BudgetName": {}, + "ResourceId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociatePrincipalFromPortfolio": { + "input": { + "type": "structure", + "required": [ + "PortfolioId", + "PrincipalARN" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "PrincipalARN": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateProductFromPortfolio": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "PortfolioId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateServiceActionFromProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "ProvisioningArtifactId", + "ServiceActionId" + ], + "members": { + "ProductId": {}, + "ProvisioningArtifactId": {}, + "ServiceActionId": {}, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateTagOptionFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagOptionId" + ], + "members": { + "ResourceId": {}, + "TagOptionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "EnableAWSOrganizationsAccess": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ExecuteProvisionedProductPlan": { + "input": { + "type": "structure", + "required": [ + "PlanId", + "IdempotencyToken" + ], + "members": { + "AcceptLanguage": {}, + "PlanId": {}, + "IdempotencyToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "RecordDetail": { + "shape": "S6j" + } + } + } + }, + "ExecuteProvisionedProductServiceAction": { + "input": { + "type": "structure", + "required": [ + "ProvisionedProductId", + "ServiceActionId", + "ExecuteToken" + ], + "members": { + "ProvisionedProductId": {}, + "ServiceActionId": {}, + "ExecuteToken": { + "idempotencyToken": true + }, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "RecordDetail": { + "shape": "S6j" + } + } + } + }, + "GetAWSOrganizationsAccessStatus": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "AccessStatus": {} + } + } + }, + "ListAcceptedPortfolioShares": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "PageToken": {}, + "PageSize": { + "type": "integer" + }, + "PortfolioShareType": {} + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioDetails": { + "shape": "S7p" + }, + "NextPageToken": {} + } + } + }, + "ListBudgetsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "AcceptLanguage": {}, + "ResourceId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Budgets": { + "shape": "S43" + }, + "NextPageToken": {} + } + } + }, + "ListConstraintsForPortfolio": { + "input": { + "type": "structure", + "required": [ + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "ProductId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConstraintDetails": { + "type": "list", + "member": { + "shape": "S1b" + } + }, + "NextPageToken": {} + } + } + }, + "ListLaunchPaths": { + "input": { + "type": "structure", + "required": [ + "ProductId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "LaunchPathSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "ConstraintSummaries": { + "shape": "S64" + }, + "Tags": { + "shape": "S1q" + }, + "Name": {} + } + } + }, + "NextPageToken": {} + } + } + }, + "ListOrganizationPortfolioAccess": { + "input": { + "type": "structure", + "required": [ + "PortfolioId", + "OrganizationNodeType" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "OrganizationNodeType": {}, + "PageToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "OrganizationNodes": { + "type": "list", + "member": { + "shape": "S1s" + } + }, + "NextPageToken": {} + } + } + }, + "ListPortfolioAccess": { + "input": { + "type": "structure", + "required": [ + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {} + } + }, + "output": { + "type": "structure", + "members": { + "AccountIds": { + "type": "list", + "member": {} + }, + "NextPageToken": {} + } + } + }, + "ListPortfolios": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "PageToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioDetails": { + "shape": "S7p" + }, + "NextPageToken": {} + } + } + }, + "ListPortfoliosForProduct": { + "input": { + "type": "structure", + "required": [ + "ProductId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "PageToken": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioDetails": { + "shape": "S7p" + }, + "NextPageToken": {} + } + } + }, + "ListPrincipalsForPortfolio": { + "input": { + "type": "structure", + "required": [ + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Principals": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PrincipalARN": {}, + "PrincipalType": {} + } + } + }, + "NextPageToken": {} + } + } + }, + "ListProvisionedProductPlans": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "ProvisionProductId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {}, + "AccessLevelFilter": { + "shape": "S8f" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProvisionedProductPlans": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlanName": {}, + "PlanId": {}, + "ProvisionProductId": {}, + "ProvisionProductName": {}, + "PlanType": {}, + "ProvisioningArtifactId": {} + } + } + }, + "NextPageToken": {} + } + } + }, + "ListProvisioningArtifacts": { + "input": { + "type": "structure", + "required": [ + "ProductId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProvisioningArtifactDetails": { + "type": "list", + "member": { + "shape": "S2h" + } + }, + "NextPageToken": {} + } + } + }, + "ListProvisioningArtifactsForServiceAction": { + "input": { + "type": "structure", + "required": [ + "ServiceActionId" + ], + "members": { + "ServiceActionId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {}, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProvisioningArtifactViews": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProductViewSummary": { + "shape": "S2d" + }, + "ProvisioningArtifact": { + "shape": "S4i" + } + } + } + }, + "NextPageToken": {} + } + } + }, + "ListRecordHistory": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "AccessLevelFilter": { + "shape": "S8f" + }, + "SearchFilter": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + }, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RecordDetails": { + "type": "list", + "member": { + "shape": "S6j" + } + }, + "NextPageToken": {} + } + } + }, + "ListResourcesForTagOption": { + "input": { + "type": "structure", + "required": [ + "TagOptionId" + ], + "members": { + "TagOptionId": {}, + "ResourceType": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "ARN": {}, + "Name": {}, + "Description": {}, + "CreatedTime": { + "type": "timestamp" + } + } + } + }, + "PageToken": {} + } + } + }, + "ListServiceActions": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceActionSummaries": { + "shape": "S9a" + }, + "NextPageToken": {} + } + } + }, + "ListServiceActionsForProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "ProvisioningArtifactId" + ], + "members": { + "ProductId": {}, + "ProvisioningArtifactId": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {}, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceActionSummaries": { + "shape": "S9a" + }, + "NextPageToken": {} + } + } + }, + "ListTagOptions": { + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "Active": { + "type": "boolean" + } + } + }, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "TagOptionDetails": { + "shape": "S42" + }, + "PageToken": {} + } + } + }, + "ProvisionProduct": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "ProvisioningArtifactId", + "ProvisionedProductName", + "ProvisionToken" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "ProvisioningArtifactId": {}, + "PathId": {}, + "ProvisionedProductName": {}, + "ProvisioningParameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "ProvisioningPreferences": { + "type": "structure", + "members": { + "StackSetAccounts": { + "shape": "S6e" + }, + "StackSetRegions": { + "shape": "S6f" + }, + "StackSetFailureToleranceCount": { + "type": "integer" + }, + "StackSetFailureTolerancePercentage": { + "type": "integer" + }, + "StackSetMaxConcurrencyCount": { + "type": "integer" + }, + "StackSetMaxConcurrencyPercentage": { + "type": "integer" + } + } + }, + "Tags": { + "shape": "S1q" + }, + "NotificationArns": { + "shape": "S2m" + }, + "ProvisionToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "RecordDetail": { + "shape": "S6j" + } + } + } + }, + "RejectPortfolioShare": { + "input": { + "type": "structure", + "required": [ + "PortfolioId" + ], + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "PortfolioShareType": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ScanProvisionedProducts": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "AccessLevelFilter": { + "shape": "S8f" + }, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProvisionedProducts": { + "type": "list", + "member": { + "shape": "S4s" + } + }, + "NextPageToken": {} + } + } + }, + "SearchProducts": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "Filters": { + "shape": "S9v" + }, + "PageSize": { + "type": "integer" + }, + "SortBy": {}, + "SortOrder": {}, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProductViewSummaries": { + "type": "list", + "member": { + "shape": "S2d" + } + }, + "ProductViewAggregations": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": {}, + "ApproximateCount": { + "type": "integer" + } + } + } + } + }, + "NextPageToken": {} + } + } + }, + "SearchProductsAsAdmin": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "PortfolioId": {}, + "Filters": { + "shape": "S9v" + }, + "SortBy": {}, + "SortOrder": {}, + "PageToken": {}, + "PageSize": { + "type": "integer" + }, + "ProductSource": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProductViewDetails": { + "type": "list", + "member": { + "shape": "S2c" + } + }, + "NextPageToken": {} + } + } + }, + "SearchProvisionedProducts": { + "input": { + "type": "structure", + "members": { + "AcceptLanguage": {}, + "AccessLevelFilter": { + "shape": "S8f" + }, + "Filters": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "SortBy": {}, + "SortOrder": {}, + "PageSize": { + "type": "integer" + }, + "PageToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProvisionedProducts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Arn": {}, + "Type": {}, + "Id": {}, + "Status": {}, + "StatusMessage": {}, + "CreatedTime": { + "type": "timestamp" + }, + "IdempotencyToken": {}, + "LastRecordId": {}, + "Tags": { + "shape": "S1q" + }, + "PhysicalId": {}, + "ProductId": {}, + "ProvisioningArtifactId": {}, + "UserArn": {}, + "UserArnSession": {} + } + } + }, + "TotalResultsCount": { + "type": "integer" + }, + "NextPageToken": {} + } + } + }, + "TerminateProvisionedProduct": { + "input": { + "type": "structure", + "required": [ + "TerminateToken" + ], + "members": { + "ProvisionedProductName": {}, + "ProvisionedProductId": {}, + "TerminateToken": { + "idempotencyToken": true + }, + "IgnoreErrors": { + "type": "boolean" + }, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "RecordDetail": { + "shape": "S6j" + } + } + } + }, + "UpdateConstraint": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {}, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "ConstraintDetail": { + "shape": "S1b" + }, + "ConstraintParameters": {}, + "Status": {} + } + } + }, + "UpdatePortfolio": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {}, + "DisplayName": {}, + "Description": {}, + "ProviderName": {}, + "AddTags": { + "shape": "S1i" + }, + "RemoveTags": { + "shape": "Saw" + } + } + }, + "output": { + "type": "structure", + "members": { + "PortfolioDetail": { + "shape": "S1n" + }, + "Tags": { + "shape": "S1q" + } + } + } + }, + "UpdateProduct": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "AcceptLanguage": {}, + "Id": {}, + "Name": {}, + "Owner": {}, + "Description": {}, + "Distributor": {}, + "SupportDescription": {}, + "SupportEmail": {}, + "SupportUrl": {}, + "AddTags": { + "shape": "S1i" + }, + "RemoveTags": { + "shape": "Saw" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProductViewDetail": { + "shape": "S2c" + }, + "Tags": { + "shape": "S1q" + } + } + } + }, + "UpdateProvisionedProduct": { + "input": { + "type": "structure", + "required": [ + "UpdateToken" + ], + "members": { + "AcceptLanguage": {}, + "ProvisionedProductName": {}, + "ProvisionedProductId": {}, + "ProductId": {}, + "ProvisioningArtifactId": {}, + "PathId": {}, + "ProvisioningParameters": { + "shape": "S2p" + }, + "ProvisioningPreferences": { + "type": "structure", + "members": { + "StackSetAccounts": { + "shape": "S6e" + }, + "StackSetRegions": { + "shape": "S6f" + }, + "StackSetFailureToleranceCount": { + "type": "integer" + }, + "StackSetFailureTolerancePercentage": { + "type": "integer" + }, + "StackSetMaxConcurrencyCount": { + "type": "integer" + }, + "StackSetMaxConcurrencyPercentage": { + "type": "integer" + }, + "StackSetOperationType": {} + } + }, + "Tags": { + "shape": "S1q" + }, + "UpdateToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "RecordDetail": { + "shape": "S6j" + } + } + } + }, + "UpdateProvisioningArtifact": { + "input": { + "type": "structure", + "required": [ + "ProductId", + "ProvisioningArtifactId" + ], + "members": { + "AcceptLanguage": {}, + "ProductId": {}, + "ProvisioningArtifactId": {}, + "Name": {}, + "Description": {}, + "Active": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "ProvisioningArtifactDetail": { + "shape": "S2h" + }, + "Info": { + "shape": "S26" + }, + "Status": {} + } + } + }, + "UpdateServiceAction": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "Name": {}, + "Definition": { + "shape": "S30" + }, + "Description": {}, + "AcceptLanguage": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceActionDetail": { + "shape": "S35" + } + } + } + }, + "UpdateTagOption": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "Value": {}, + "Active": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TagOptionDetail": { + "shape": "S3b" + } + } + } + } + }, + "shapes": { + "Sm": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ServiceActionId", + "ProductId", + "ProvisioningArtifactId" + ], + "members": { + "ServiceActionId": {}, + "ProductId": {}, + "ProvisioningArtifactId": {} + } + } + }, + "Sp": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ServiceActionId": {}, + "ProductId": {}, + "ProvisioningArtifactId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "S1b": { + "type": "structure", + "members": { + "ConstraintId": {}, + "Type": {}, + "Description": {}, + "Owner": {} + } + }, + "S1i": { + "type": "list", + "member": { + "shape": "S1j" + } + }, + "S1j": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + }, + "S1n": { + "type": "structure", + "members": { + "Id": {}, + "ARN": {}, + "DisplayName": {}, + "Description": {}, + "CreatedTime": { + "type": "timestamp" + }, + "ProviderName": {} + } + }, + "S1q": { + "type": "list", + "member": { + "shape": "S1j" + } + }, + "S1s": { + "type": "structure", + "members": { + "Type": {}, + "Value": {} + } + }, + "S23": { + "type": "structure", + "required": [ + "Info" + ], + "members": { + "Name": {}, + "Description": {}, + "Info": { + "shape": "S26" + }, + "Type": {}, + "DisableTemplateValidation": { + "type": "boolean" + } + } + }, + "S26": { + "type": "map", + "key": {}, + "value": {} + }, + "S2c": { + "type": "structure", + "members": { + "ProductViewSummary": { + "shape": "S2d" + }, + "Status": {}, + "ProductARN": {}, + "CreatedTime": { + "type": "timestamp" + } + } + }, + "S2d": { + "type": "structure", + "members": { + "Id": {}, + "ProductId": {}, + "Name": {}, + "Owner": {}, + "ShortDescription": {}, + "Type": {}, + "Distributor": {}, + "HasDefaultPath": { + "type": "boolean" + }, + "SupportEmail": {}, + "SupportDescription": {}, + "SupportUrl": {} + } + }, + "S2h": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Description": {}, + "Type": {}, + "CreatedTime": { + "type": "timestamp" + }, + "Active": { + "type": "boolean" + } + } + }, + "S2m": { + "type": "list", + "member": {} + }, + "S2p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "UsePreviousValue": { + "type": "boolean" + } + } + } + }, + "S30": { + "type": "map", + "key": {}, + "value": {} + }, + "S35": { + "type": "structure", + "members": { + "ServiceActionSummary": { + "shape": "S36" + }, + "Definition": { + "shape": "S30" + } + } + }, + "S36": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Description": {}, + "DefinitionType": {} + } + }, + "S3b": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "Active": { + "type": "boolean" + }, + "Id": {} + } + }, + "S42": { + "type": "list", + "member": { + "shape": "S3b" + } + }, + "S43": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BudgetName": {} + } + } + }, + "S4h": { + "type": "list", + "member": { + "shape": "S4i" + } + }, + "S4i": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Description": {}, + "CreatedTime": { + "type": "timestamp" + } + } + }, + "S4s": { + "type": "structure", + "members": { + "Name": {}, + "Arn": {}, + "Type": {}, + "Id": {}, + "Status": {}, + "StatusMessage": {}, + "CreatedTime": { + "type": "timestamp" + }, + "IdempotencyToken": {}, + "LastRecordId": {}, + "ProductId": {}, + "ProvisioningArtifactId": {} + } + }, + "S64": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Description": {} + } + } + }, + "S6e": { + "type": "list", + "member": {} + }, + "S6f": { + "type": "list", + "member": {} + }, + "S6j": { + "type": "structure", + "members": { + "RecordId": {}, + "ProvisionedProductName": {}, + "Status": {}, + "CreatedTime": { + "type": "timestamp" + }, + "UpdatedTime": { + "type": "timestamp" + }, + "ProvisionedProductType": {}, + "RecordType": {}, + "ProvisionedProductId": {}, + "ProductId": {}, + "ProvisioningArtifactId": {}, + "PathId": {}, + "RecordErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Code": {}, + "Description": {} + } + } + }, + "RecordTags": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } + }, + "S7p": { + "type": "list", + "member": { + "shape": "S1n" + } + }, + "S8f": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + }, + "S9a": { + "type": "list", + "member": { + "shape": "S36" + } + }, + "S9v": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "Saw": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.paginators.json b/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.paginators.json new file mode 100644 index 0000000..fc6c7ba --- /dev/null +++ b/node_modules/aws-sdk/apis/servicecatalog-2015-12-10.paginators.json @@ -0,0 +1,84 @@ +{ + "pagination": { + "ListAcceptedPortfolioShares": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListBudgetsForResource": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListConstraintsForPortfolio": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListLaunchPaths": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListOrganizationPortfolioAccess": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListPortfolios": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListPortfoliosForProduct": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListPrincipalsForPortfolio": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListProvisioningArtifactsForServiceAction": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListResourcesForTagOption": { + "input_token": "PageToken", + "output_token": "PageToken", + "limit_key": "PageSize" + }, + "ListServiceActions": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListServiceActionsForProvisioningArtifact": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "ListTagOptions": { + "input_token": "PageToken", + "output_token": "PageToken", + "limit_key": "PageSize" + }, + "SearchProducts": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "SearchProductsAsAdmin": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + }, + "SearchProvisionedProducts": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "limit_key": "PageSize" + } + } +} diff --git a/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.examples.json b/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.min.json b/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.min.json new file mode 100644 index 0000000..5fec650 --- /dev/null +++ b/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.min.json @@ -0,0 +1,745 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-03-14", + "endpointPrefix": "servicediscovery", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "ServiceDiscovery", + "serviceFullName": "AWS Cloud Map", + "serviceId": "ServiceDiscovery", + "signatureVersion": "v4", + "targetPrefix": "Route53AutoNaming_v20170314", + "uid": "servicediscovery-2017-03-14" + }, + "operations": { + "CreateHttpNamespace": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "CreatorRequestId": { + "idempotencyToken": true + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "CreatePrivateDnsNamespace": { + "input": { + "type": "structure", + "required": [ + "Name", + "Vpc" + ], + "members": { + "Name": {}, + "CreatorRequestId": { + "idempotencyToken": true + }, + "Description": {}, + "Vpc": {} + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "CreatePublicDnsNamespace": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "CreatorRequestId": { + "idempotencyToken": true + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "CreateService": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "NamespaceId": {}, + "CreatorRequestId": { + "idempotencyToken": true + }, + "Description": {}, + "DnsConfig": { + "shape": "Sd" + }, + "HealthCheckConfig": { + "shape": "Sj" + }, + "HealthCheckCustomConfig": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "Service": { + "shape": "Sp" + } + } + } + }, + "DeleteNamespace": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "DeleteService": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeregisterInstance": { + "input": { + "type": "structure", + "required": [ + "ServiceId", + "InstanceId" + ], + "members": { + "ServiceId": {}, + "InstanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "DiscoverInstances": { + "input": { + "type": "structure", + "required": [ + "NamespaceName", + "ServiceName" + ], + "members": { + "NamespaceName": {}, + "ServiceName": {}, + "MaxResults": { + "type": "integer" + }, + "QueryParameters": { + "shape": "S11" + }, + "HealthStatus": {} + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "NamespaceName": {}, + "ServiceName": {}, + "HealthStatus": {}, + "Attributes": { + "shape": "S11" + } + } + } + } + } + }, + "endpoint": { + "hostPrefix": "data-" + } + }, + "GetInstance": { + "input": { + "type": "structure", + "required": [ + "ServiceId", + "InstanceId" + ], + "members": { + "ServiceId": {}, + "InstanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Instance": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "CreatorRequestId": {}, + "Attributes": { + "shape": "S11" + } + } + } + } + } + }, + "GetInstancesHealthStatus": { + "input": { + "type": "structure", + "required": [ + "ServiceId" + ], + "members": { + "ServiceId": {}, + "Instances": { + "type": "list", + "member": {} + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Status": { + "type": "map", + "key": {}, + "value": {} + }, + "NextToken": {} + } + } + }, + "GetNamespace": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "Namespace": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Type": {}, + "Description": {}, + "ServiceCount": { + "type": "integer" + }, + "Properties": { + "shape": "S1l" + }, + "CreateDate": { + "type": "timestamp" + }, + "CreatorRequestId": {} + } + } + } + } + }, + "GetOperation": { + "input": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Operation": { + "type": "structure", + "members": { + "Id": {}, + "Type": {}, + "Status": {}, + "ErrorMessage": {}, + "ErrorCode": {}, + "CreateDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + }, + "Targets": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + }, + "GetService": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "Service": { + "shape": "Sp" + } + } + } + }, + "ListInstances": { + "input": { + "type": "structure", + "required": [ + "ServiceId" + ], + "members": { + "ServiceId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Attributes": { + "shape": "S11" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListNamespaces": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S27" + }, + "Condition": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Namespaces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Type": {}, + "Description": {}, + "ServiceCount": { + "type": "integer" + }, + "Properties": { + "shape": "S1l" + }, + "CreateDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListOperations": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S27" + }, + "Condition": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Operations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Status": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListServices": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S27" + }, + "Condition": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Services": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Description": {}, + "InstanceCount": { + "type": "integer" + }, + "DnsConfig": { + "shape": "Sd" + }, + "HealthCheckConfig": { + "shape": "Sj" + }, + "HealthCheckCustomConfig": { + "shape": "Sn" + }, + "CreateDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "RegisterInstance": { + "input": { + "type": "structure", + "required": [ + "ServiceId", + "InstanceId", + "Attributes" + ], + "members": { + "ServiceId": {}, + "InstanceId": {}, + "CreatorRequestId": { + "idempotencyToken": true + }, + "Attributes": { + "shape": "S11" + } + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {} + } + } + }, + "UpdateInstanceCustomHealthStatus": { + "input": { + "type": "structure", + "required": [ + "ServiceId", + "InstanceId", + "Status" + ], + "members": { + "ServiceId": {}, + "InstanceId": {}, + "Status": {} + } + } + }, + "UpdateService": { + "input": { + "type": "structure", + "required": [ + "Id", + "Service" + ], + "members": { + "Id": {}, + "Service": { + "type": "structure", + "required": [ + "DnsConfig" + ], + "members": { + "Description": {}, + "DnsConfig": { + "type": "structure", + "required": [ + "DnsRecords" + ], + "members": { + "DnsRecords": { + "shape": "Sf" + } + } + }, + "HealthCheckConfig": { + "shape": "Sj" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {} + } + } + } + }, + "shapes": { + "Sd": { + "type": "structure", + "required": [ + "DnsRecords" + ], + "members": { + "NamespaceId": { + "deprecated": true, + "deprecatedMessage": "Top level attribute in request should be used to reference namespace-id" + }, + "RoutingPolicy": {}, + "DnsRecords": { + "shape": "Sf" + } + } + }, + "Sf": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Type", + "TTL" + ], + "members": { + "Type": {}, + "TTL": { + "type": "long" + } + } + } + }, + "Sj": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "ResourcePath": {}, + "FailureThreshold": { + "type": "integer" + } + } + }, + "Sn": { + "type": "structure", + "members": { + "FailureThreshold": { + "type": "integer" + } + } + }, + "Sp": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "NamespaceId": {}, + "Description": {}, + "InstanceCount": { + "type": "integer" + }, + "DnsConfig": { + "shape": "Sd" + }, + "HealthCheckConfig": { + "shape": "Sj" + }, + "HealthCheckCustomConfig": { + "shape": "Sn" + }, + "CreateDate": { + "type": "timestamp" + }, + "CreatorRequestId": {} + } + }, + "S11": { + "type": "map", + "key": {}, + "value": {} + }, + "S1l": { + "type": "structure", + "members": { + "DnsProperties": { + "type": "structure", + "members": { + "HostedZoneId": {} + } + }, + "HttpProperties": { + "type": "structure", + "members": { + "HttpName": {} + } + } + } + }, + "S27": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.paginators.json b/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.paginators.json new file mode 100644 index 0000000..2891999 --- /dev/null +++ b/node_modules/aws-sdk/apis/servicediscovery-2017-03-14.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "GetInstancesHealthStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNamespaces": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListOperations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListServices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/shield-2016-06-02.examples.json b/node_modules/aws-sdk/apis/shield-2016-06-02.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/shield-2016-06-02.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/shield-2016-06-02.min.json b/node_modules/aws-sdk/apis/shield-2016-06-02.min.json new file mode 100644 index 0000000..08d05a1 --- /dev/null +++ b/node_modules/aws-sdk/apis/shield-2016-06-02.min.json @@ -0,0 +1,483 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-06-02", + "endpointPrefix": "shield", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "AWS Shield", + "serviceFullName": "AWS Shield", + "serviceId": "Shield", + "signatureVersion": "v4", + "targetPrefix": "AWSShield_20160616", + "uid": "shield-2016-06-02" + }, + "operations": { + "AssociateDRTLogBucket": { + "input": { + "type": "structure", + "required": [ + "LogBucket" + ], + "members": { + "LogBucket": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateDRTRole": { + "input": { + "type": "structure", + "required": [ + "RoleArn" + ], + "members": { + "RoleArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateProtection": { + "input": { + "type": "structure", + "required": [ + "Name", + "ResourceArn" + ], + "members": { + "Name": {}, + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "ProtectionId": {} + } + } + }, + "CreateSubscription": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteProtection": { + "input": { + "type": "structure", + "required": [ + "ProtectionId" + ], + "members": { + "ProtectionId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSubscription": { + "input": { + "type": "structure", + "members": {}, + "deprecated": true + }, + "output": { + "type": "structure", + "members": {}, + "deprecated": true + }, + "deprecated": true + }, + "DescribeAttack": { + "input": { + "type": "structure", + "required": [ + "AttackId" + ], + "members": { + "AttackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attack": { + "type": "structure", + "members": { + "AttackId": {}, + "ResourceArn": {}, + "SubResources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Id": {}, + "AttackVectors": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VectorType" + ], + "members": { + "VectorType": {}, + "VectorCounters": { + "shape": "Ss" + } + } + } + }, + "Counters": { + "shape": "Ss" + } + } + } + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "AttackCounters": { + "shape": "Ss" + }, + "AttackProperties": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttackLayer": {}, + "AttackPropertyIdentifier": {}, + "TopContributors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Value": { + "type": "long" + } + } + } + }, + "Unit": {}, + "Total": { + "type": "long" + } + } + } + }, + "Mitigations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "MitigationName": {} + } + } + } + } + } + } + } + }, + "DescribeDRTAccess": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "RoleArn": {}, + "LogBucketList": { + "type": "list", + "member": {} + } + } + } + }, + "DescribeEmergencyContactSettings": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "EmergencyContactList": { + "shape": "S1c" + } + } + } + }, + "DescribeProtection": { + "input": { + "type": "structure", + "members": { + "ProtectionId": {}, + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Protection": { + "shape": "S1h" + } + } + } + }, + "DescribeSubscription": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "Subscription": { + "type": "structure", + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "TimeCommitmentInSeconds": { + "type": "long" + }, + "AutoRenew": {}, + "Limits": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Max": { + "type": "long" + } + } + } + } + } + } + } + } + }, + "DisassociateDRTLogBucket": { + "input": { + "type": "structure", + "required": [ + "LogBucket" + ], + "members": { + "LogBucket": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateDRTRole": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetSubscriptionState": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "SubscriptionState" + ], + "members": { + "SubscriptionState": {} + } + } + }, + "ListAttacks": { + "input": { + "type": "structure", + "members": { + "ResourceArns": { + "type": "list", + "member": {} + }, + "StartTime": { + "shape": "S1z" + }, + "EndTime": { + "shape": "S1z" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttackSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttackId": {}, + "ResourceArn": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "AttackVectors": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VectorType" + ], + "members": { + "VectorType": {} + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "ListProtections": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Protections": { + "type": "list", + "member": { + "shape": "S1h" + } + }, + "NextToken": {} + } + } + }, + "UpdateEmergencyContactSettings": { + "input": { + "type": "structure", + "members": { + "EmergencyContactList": { + "shape": "S1c" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateSubscription": { + "input": { + "type": "structure", + "members": { + "AutoRenew": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Ss": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Max": { + "type": "double" + }, + "Average": { + "type": "double" + }, + "Sum": { + "type": "double" + }, + "N": { + "type": "integer" + }, + "Unit": {} + } + } + }, + "S1c": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "EmailAddress" + ], + "members": { + "EmailAddress": {} + } + } + }, + "S1h": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "ResourceArn": {} + } + }, + "S1z": { + "type": "structure", + "members": { + "FromInclusive": { + "type": "timestamp" + }, + "ToExclusive": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/shield-2016-06-02.paginators.json b/node_modules/aws-sdk/apis/shield-2016-06-02.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/shield-2016-06-02.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/signer-2017-08-25.examples.json b/node_modules/aws-sdk/apis/signer-2017-08-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/signer-2017-08-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/signer-2017-08-25.min.json b/node_modules/aws-sdk/apis/signer-2017-08-25.min.json new file mode 100644 index 0000000..ddaa0ca --- /dev/null +++ b/node_modules/aws-sdk/apis/signer-2017-08-25.min.json @@ -0,0 +1,510 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-08-25", + "endpointPrefix": "signer", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "signer", + "serviceFullName": "AWS Signer", + "serviceId": "signer", + "signatureVersion": "v4", + "signingName": "signer", + "uid": "signer-2017-08-25" + }, + "operations": { + "CancelSigningProfile": { + "http": { + "method": "DELETE", + "requestUri": "/signing-profiles/{profileName}" + }, + "input": { + "type": "structure", + "required": [ + "profileName" + ], + "members": { + "profileName": { + "location": "uri", + "locationName": "profileName" + } + } + } + }, + "DescribeSigningJob": { + "http": { + "method": "GET", + "requestUri": "/signing-jobs/{jobId}" + }, + "input": { + "type": "structure", + "required": [ + "jobId" + ], + "members": { + "jobId": { + "location": "uri", + "locationName": "jobId" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobId": {}, + "source": { + "shape": "S6" + }, + "signingMaterial": { + "shape": "Sb" + }, + "platformId": {}, + "profileName": {}, + "overrides": { + "shape": "Se" + }, + "signingParameters": { + "shape": "Si" + }, + "createdAt": { + "type": "timestamp" + }, + "completedAt": { + "type": "timestamp" + }, + "requestedBy": {}, + "status": {}, + "statusReason": {}, + "signedObject": { + "shape": "Sq" + } + } + } + }, + "GetSigningPlatform": { + "http": { + "method": "GET", + "requestUri": "/signing-platforms/{platformId}" + }, + "input": { + "type": "structure", + "required": [ + "platformId" + ], + "members": { + "platformId": { + "location": "uri", + "locationName": "platformId" + } + } + }, + "output": { + "type": "structure", + "members": { + "platformId": {}, + "displayName": {}, + "partner": {}, + "target": {}, + "category": {}, + "signingConfiguration": { + "shape": "Sy" + }, + "signingImageFormat": { + "shape": "S13" + }, + "maxSizeInMB": { + "type": "integer" + } + } + } + }, + "GetSigningProfile": { + "http": { + "method": "GET", + "requestUri": "/signing-profiles/{profileName}" + }, + "input": { + "type": "structure", + "required": [ + "profileName" + ], + "members": { + "profileName": { + "location": "uri", + "locationName": "profileName" + } + } + }, + "output": { + "type": "structure", + "members": { + "profileName": {}, + "signingMaterial": { + "shape": "Sb" + }, + "platformId": {}, + "overrides": { + "shape": "Se" + }, + "signingParameters": { + "shape": "Si" + }, + "status": {} + } + } + }, + "ListSigningJobs": { + "http": { + "method": "GET", + "requestUri": "/signing-jobs" + }, + "input": { + "type": "structure", + "members": { + "status": { + "location": "querystring", + "locationName": "status" + }, + "platformId": { + "location": "querystring", + "locationName": "platformId" + }, + "requestedBy": { + "location": "querystring", + "locationName": "requestedBy" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "jobId": {}, + "source": { + "shape": "S6" + }, + "signedObject": { + "shape": "Sq" + }, + "signingMaterial": { + "shape": "Sb" + }, + "createdAt": { + "type": "timestamp" + }, + "status": {} + } + } + }, + "nextToken": {} + } + } + }, + "ListSigningPlatforms": { + "http": { + "method": "GET", + "requestUri": "/signing-platforms" + }, + "input": { + "type": "structure", + "members": { + "category": { + "location": "querystring", + "locationName": "category" + }, + "partner": { + "location": "querystring", + "locationName": "partner" + }, + "target": { + "location": "querystring", + "locationName": "target" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "platforms": { + "type": "list", + "member": { + "type": "structure", + "members": { + "platformId": {}, + "displayName": {}, + "partner": {}, + "target": {}, + "category": {}, + "signingConfiguration": { + "shape": "Sy" + }, + "signingImageFormat": { + "shape": "S13" + }, + "maxSizeInMB": { + "type": "integer" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListSigningProfiles": { + "http": { + "method": "GET", + "requestUri": "/signing-profiles" + }, + "input": { + "type": "structure", + "members": { + "includeCanceled": { + "location": "querystring", + "locationName": "includeCanceled", + "type": "boolean" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "profiles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "profileName": {}, + "signingMaterial": { + "shape": "Sb" + }, + "platformId": {}, + "signingParameters": { + "shape": "Si" + }, + "status": {} + } + } + }, + "nextToken": {} + } + } + }, + "PutSigningProfile": { + "http": { + "method": "PUT", + "requestUri": "/signing-profiles/{profileName}" + }, + "input": { + "type": "structure", + "required": [ + "profileName", + "signingMaterial", + "platformId" + ], + "members": { + "profileName": { + "location": "uri", + "locationName": "profileName" + }, + "signingMaterial": { + "shape": "Sb" + }, + "platformId": {}, + "overrides": { + "shape": "Se" + }, + "signingParameters": { + "shape": "Si" + } + } + }, + "output": { + "type": "structure", + "members": { + "arn": {} + } + } + }, + "StartSigningJob": { + "http": { + "requestUri": "/signing-jobs" + }, + "input": { + "type": "structure", + "required": [ + "source", + "destination", + "clientRequestToken" + ], + "members": { + "source": { + "shape": "S6" + }, + "destination": { + "type": "structure", + "members": { + "s3": { + "type": "structure", + "members": { + "bucketName": {}, + "prefix": {} + } + } + } + }, + "profileName": {}, + "clientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "jobId": {} + } + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "members": { + "s3": { + "type": "structure", + "required": [ + "bucketName", + "key", + "version" + ], + "members": { + "bucketName": {}, + "key": {}, + "version": {} + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "certificateArn" + ], + "members": { + "certificateArn": {} + } + }, + "Se": { + "type": "structure", + "members": { + "signingConfiguration": { + "type": "structure", + "members": { + "encryptionAlgorithm": {}, + "hashAlgorithm": {} + } + } + } + }, + "Si": { + "type": "map", + "key": {}, + "value": {} + }, + "Sq": { + "type": "structure", + "members": { + "s3": { + "type": "structure", + "members": { + "bucketName": {}, + "key": {} + } + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "encryptionAlgorithmOptions", + "hashAlgorithmOptions" + ], + "members": { + "encryptionAlgorithmOptions": { + "type": "structure", + "required": [ + "allowedValues", + "defaultValue" + ], + "members": { + "allowedValues": { + "type": "list", + "member": {} + }, + "defaultValue": {} + } + }, + "hashAlgorithmOptions": { + "type": "structure", + "required": [ + "allowedValues", + "defaultValue" + ], + "members": { + "allowedValues": { + "type": "list", + "member": {} + }, + "defaultValue": {} + } + } + } + }, + "S13": { + "type": "structure", + "required": [ + "supportedFormats", + "defaultFormat" + ], + "members": { + "supportedFormats": { + "type": "list", + "member": {} + }, + "defaultFormat": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/signer-2017-08-25.paginators.json b/node_modules/aws-sdk/apis/signer-2017-08-25.paginators.json new file mode 100644 index 0000000..db5c1a8 --- /dev/null +++ b/node_modules/aws-sdk/apis/signer-2017-08-25.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "ListSigningJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListSigningPlatforms": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListSigningProfiles": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/signer-2017-08-25.waiters2.json b/node_modules/aws-sdk/apis/signer-2017-08-25.waiters2.json new file mode 100644 index 0000000..a0890ad --- /dev/null +++ b/node_modules/aws-sdk/apis/signer-2017-08-25.waiters2.json @@ -0,0 +1,29 @@ +{ + "version": 2, + "waiters": { + "SuccessfulSigningJob": { + "delay": 20, + "operation": "DescribeSigningJob", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "Succeeded", + "matcher": "path", + "state": "success", + "argument": "status" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "status" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "failure" + } + ] + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sms-2016-10-24.examples.json b/node_modules/aws-sdk/apis/sms-2016-10-24.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/sms-2016-10-24.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/sms-2016-10-24.min.json b/node_modules/aws-sdk/apis/sms-2016-10-24.min.json new file mode 100644 index 0000000..6d52465 --- /dev/null +++ b/node_modules/aws-sdk/apis/sms-2016-10-24.min.json @@ -0,0 +1,837 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-10-24", + "endpointPrefix": "sms", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "SMS", + "serviceFullName": "AWS Server Migration Service", + "serviceId": "SMS", + "signatureVersion": "v4", + "targetPrefix": "AWSServerMigrationService_V2016_10_24", + "uid": "sms-2016-10-24" + }, + "operations": { + "CreateApp": { + "input": { + "type": "structure", + "members": { + "name": {}, + "description": {}, + "roleName": {}, + "clientToken": {}, + "serverGroups": { + "shape": "S6" + }, + "tags": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "appSummary": { + "shape": "St" + }, + "serverGroups": { + "shape": "S6" + }, + "tags": { + "shape": "So" + } + } + } + }, + "CreateReplicationJob": { + "input": { + "type": "structure", + "required": [ + "serverId", + "seedReplicationTime" + ], + "members": { + "serverId": {}, + "seedReplicationTime": { + "type": "timestamp" + }, + "frequency": { + "type": "integer" + }, + "runOnce": { + "type": "boolean" + }, + "licenseType": {}, + "roleName": {}, + "description": {}, + "numberOfRecentAmisToKeep": { + "type": "integer" + }, + "encrypted": { + "type": "boolean" + }, + "kmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": { + "replicationJobId": {} + } + } + }, + "DeleteApp": { + "input": { + "type": "structure", + "members": { + "appId": {}, + "forceStopAppReplication": { + "type": "boolean" + }, + "forceTerminateApp": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteAppLaunchConfiguration": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteAppReplicationConfiguration": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteReplicationJob": { + "input": { + "type": "structure", + "required": [ + "replicationJobId" + ], + "members": { + "replicationJobId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteServerCatalog": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateConnector": { + "input": { + "type": "structure", + "required": [ + "connectorId" + ], + "members": { + "connectorId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GenerateChangeSet": { + "input": { + "type": "structure", + "members": { + "appId": {}, + "changesetFormat": {} + } + }, + "output": { + "type": "structure", + "members": { + "s3Location": { + "shape": "S1y" + } + } + } + }, + "GenerateTemplate": { + "input": { + "type": "structure", + "members": { + "appId": {}, + "templateFormat": {} + } + }, + "output": { + "type": "structure", + "members": { + "s3Location": { + "shape": "S1y" + } + } + } + }, + "GetApp": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": { + "appSummary": { + "shape": "St" + }, + "serverGroups": { + "shape": "S6" + }, + "tags": { + "shape": "So" + } + } + } + }, + "GetAppLaunchConfiguration": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": { + "appId": {}, + "roleName": {}, + "serverGroupLaunchConfigurations": { + "shape": "S27" + } + } + } + }, + "GetAppReplicationConfiguration": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": { + "serverGroupReplicationConfigurations": { + "shape": "S2m" + } + } + } + }, + "GetConnectors": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "connectorList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "connectorId": {}, + "version": {}, + "status": {}, + "capabilityList": { + "type": "list", + "member": {} + }, + "vmManagerName": {}, + "vmManagerType": {}, + "vmManagerId": {}, + "ipAddress": {}, + "macAddress": {}, + "associatedOn": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetReplicationJobs": { + "input": { + "type": "structure", + "members": { + "replicationJobId": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "replicationJobList": { + "type": "list", + "member": { + "shape": "S36" + } + }, + "nextToken": {} + } + } + }, + "GetReplicationRuns": { + "input": { + "type": "structure", + "required": [ + "replicationJobId" + ], + "members": { + "replicationJobId": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "replicationJob": { + "shape": "S36" + }, + "replicationRunList": { + "shape": "S3a" + }, + "nextToken": {} + } + } + }, + "GetServers": { + "input": { + "type": "structure", + "members": { + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "vmServerAddressList": { + "type": "list", + "member": { + "shape": "Sf" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "lastModifiedOn": { + "type": "timestamp" + }, + "serverCatalogStatus": {}, + "serverList": { + "shape": "Sa" + }, + "nextToken": {} + } + } + }, + "ImportServerCatalog": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": {} + } + }, + "LaunchApp": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListApps": { + "input": { + "type": "structure", + "members": { + "appIds": { + "type": "list", + "member": {} + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "apps": { + "type": "list", + "member": { + "shape": "St" + } + }, + "nextToken": {} + } + } + }, + "PutAppLaunchConfiguration": { + "input": { + "type": "structure", + "members": { + "appId": {}, + "roleName": {}, + "serverGroupLaunchConfigurations": { + "shape": "S27" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutAppReplicationConfiguration": { + "input": { + "type": "structure", + "members": { + "appId": {}, + "serverGroupReplicationConfigurations": { + "shape": "S2m" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartAppReplication": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartOnDemandReplicationRun": { + "input": { + "type": "structure", + "required": [ + "replicationJobId" + ], + "members": { + "replicationJobId": {}, + "description": {} + } + }, + "output": { + "type": "structure", + "members": { + "replicationRunId": {} + } + } + }, + "StopAppReplication": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TerminateApp": { + "input": { + "type": "structure", + "members": { + "appId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateApp": { + "input": { + "type": "structure", + "members": { + "appId": {}, + "name": {}, + "description": {}, + "roleName": {}, + "serverGroups": { + "shape": "S6" + }, + "tags": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "appSummary": { + "shape": "St" + }, + "serverGroups": { + "shape": "S6" + }, + "tags": { + "shape": "So" + } + } + } + }, + "UpdateReplicationJob": { + "input": { + "type": "structure", + "required": [ + "replicationJobId" + ], + "members": { + "replicationJobId": {}, + "frequency": { + "type": "integer" + }, + "nextReplicationRunStartTime": { + "type": "timestamp" + }, + "licenseType": {}, + "roleName": {}, + "description": {}, + "numberOfRecentAmisToKeep": { + "type": "integer" + }, + "encrypted": { + "type": "boolean" + }, + "kmsKeyId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S6": { + "type": "list", + "member": { + "type": "structure", + "members": { + "serverGroupId": {}, + "name": {}, + "serverList": { + "shape": "Sa" + } + } + } + }, + "Sa": { + "type": "list", + "member": { + "shape": "Sb" + } + }, + "Sb": { + "type": "structure", + "members": { + "serverId": {}, + "serverType": {}, + "vmServer": { + "shape": "Se" + }, + "replicationJobId": {}, + "replicationJobTerminated": { + "type": "boolean" + } + } + }, + "Se": { + "type": "structure", + "members": { + "vmServerAddress": { + "shape": "Sf" + }, + "vmName": {}, + "vmManagerName": {}, + "vmManagerType": {}, + "vmPath": {} + } + }, + "Sf": { + "type": "structure", + "members": { + "vmManagerId": {}, + "vmId": {} + } + }, + "So": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "St": { + "type": "structure", + "members": { + "appId": {}, + "name": {}, + "description": {}, + "status": {}, + "statusMessage": {}, + "replicationStatus": {}, + "replicationStatusMessage": {}, + "latestReplicationTime": { + "type": "timestamp" + }, + "launchStatus": {}, + "launchStatusMessage": {}, + "launchDetails": { + "type": "structure", + "members": { + "latestLaunchTime": { + "type": "timestamp" + }, + "stackName": {}, + "stackId": {} + } + }, + "creationTime": { + "type": "timestamp" + }, + "lastModified": { + "type": "timestamp" + }, + "roleName": {}, + "totalServerGroups": { + "type": "integer" + }, + "totalServers": { + "type": "integer" + } + } + }, + "S1y": { + "type": "structure", + "members": { + "bucket": {}, + "key": {} + } + }, + "S27": { + "type": "list", + "member": { + "type": "structure", + "members": { + "serverGroupId": {}, + "launchOrder": { + "type": "integer" + }, + "serverLaunchConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "server": { + "shape": "Sb" + }, + "logicalId": {}, + "vpc": {}, + "subnet": {}, + "securityGroup": {}, + "ec2KeyName": {}, + "userData": { + "type": "structure", + "members": { + "s3Location": { + "shape": "S1y" + } + } + }, + "instanceType": {}, + "associatePublicIpAddress": { + "type": "boolean" + } + } + } + } + } + } + }, + "S2m": { + "type": "list", + "member": { + "type": "structure", + "members": { + "serverGroupId": {}, + "serverReplicationConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "server": { + "shape": "Sb" + }, + "serverReplicationParameters": { + "type": "structure", + "members": { + "seedTime": { + "type": "timestamp" + }, + "frequency": { + "type": "integer" + }, + "runOnce": { + "type": "boolean" + }, + "licenseType": {}, + "numberOfRecentAmisToKeep": { + "type": "integer" + }, + "encrypted": { + "type": "boolean" + }, + "kmsKeyId": {} + } + } + } + } + } + } + } + }, + "S36": { + "type": "structure", + "members": { + "replicationJobId": {}, + "serverId": {}, + "serverType": {}, + "vmServer": { + "shape": "Se" + }, + "seedReplicationTime": { + "type": "timestamp" + }, + "frequency": { + "type": "integer" + }, + "runOnce": { + "type": "boolean" + }, + "nextReplicationRunStartTime": { + "type": "timestamp" + }, + "licenseType": {}, + "roleName": {}, + "latestAmiId": {}, + "state": {}, + "statusMessage": {}, + "description": {}, + "numberOfRecentAmisToKeep": { + "type": "integer" + }, + "encrypted": { + "type": "boolean" + }, + "kmsKeyId": {}, + "replicationRunList": { + "shape": "S3a" + } + } + }, + "S3a": { + "type": "list", + "member": { + "type": "structure", + "members": { + "replicationRunId": {}, + "state": {}, + "type": {}, + "stageDetails": { + "type": "structure", + "members": { + "stage": {}, + "stageProgress": {} + } + }, + "statusMessage": {}, + "amiId": {}, + "scheduledStartTime": { + "type": "timestamp" + }, + "completedTime": { + "type": "timestamp" + }, + "description": {}, + "encrypted": { + "type": "boolean" + }, + "kmsKeyId": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sms-2016-10-24.paginators.json b/node_modules/aws-sdk/apis/sms-2016-10-24.paginators.json new file mode 100644 index 0000000..23528a0 --- /dev/null +++ b/node_modules/aws-sdk/apis/sms-2016-10-24.paginators.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "GetConnectors": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "connectorList" + }, + "GetReplicationJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "replicationJobList" + }, + "GetReplicationRuns": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "replicationRunList" + }, + "GetServers": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "serverList" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sms-voice-2018-09-05.min.json b/node_modules/aws-sdk/apis/sms-voice-2018-09-05.min.json new file mode 100644 index 0000000..cb163e3 --- /dev/null +++ b/node_modules/aws-sdk/apis/sms-voice-2018-09-05.min.json @@ -0,0 +1,319 @@ +{ + "metadata": { + "apiVersion": "2018-09-05", + "endpointPrefix": "sms-voice.pinpoint", + "signingName": "sms-voice", + "serviceAbbreviation": "Pinpoint SMS Voice", + "serviceFullName": "Amazon Pinpoint SMS and Voice Service", + "serviceId": "Pinpoint SMS Voice", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "pinpoint-sms-voice-2018-09-05", + "signatureVersion": "v4" + }, + "operations": { + "CreateConfigurationSet": { + "http": { + "requestUri": "/v1/sms-voice/configuration-sets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationSetName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateConfigurationSetEventDestination": { + "http": { + "requestUri": "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "EventDestination": { + "shape": "S6" + }, + "EventDestinationName": {} + }, + "required": [ + "ConfigurationSetName" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteConfigurationSet": { + "http": { + "method": "DELETE", + "requestUri": "/v1/sms-voice/configuration-sets/{ConfigurationSetName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + } + }, + "required": [ + "ConfigurationSetName" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteConfigurationSetEventDestination": { + "http": { + "method": "DELETE", + "requestUri": "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "EventDestinationName": { + "location": "uri", + "locationName": "EventDestinationName" + } + }, + "required": [ + "EventDestinationName", + "ConfigurationSetName" + ] + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetConfigurationSetEventDestinations": { + "http": { + "method": "GET", + "requestUri": "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + } + }, + "required": [ + "ConfigurationSetName" + ] + }, + "output": { + "type": "structure", + "members": { + "EventDestinations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CloudWatchLogsDestination": { + "shape": "S7" + }, + "Enabled": { + "type": "boolean" + }, + "KinesisFirehoseDestination": { + "shape": "Sa" + }, + "MatchingEventTypes": { + "shape": "Sb" + }, + "Name": {}, + "SnsDestination": { + "shape": "Sd" + } + } + } + } + } + } + }, + "ListConfigurationSets": { + "http": { + "method": "GET", + "requestUri": "/v1/sms-voice/configuration-sets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "PageSize": { + "location": "querystring", + "locationName": "PageSize" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConfigurationSets": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "SendVoiceMessage": { + "http": { + "requestUri": "/v1/sms-voice/voice/message", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "CallerId": {}, + "ConfigurationSetName": {}, + "Content": { + "type": "structure", + "members": { + "CallInstructionsMessage": { + "type": "structure", + "members": { + "Text": {} + }, + "required": [] + }, + "PlainTextMessage": { + "type": "structure", + "members": { + "LanguageCode": {}, + "Text": {}, + "VoiceId": {} + }, + "required": [] + }, + "SSMLMessage": { + "type": "structure", + "members": { + "LanguageCode": {}, + "Text": {}, + "VoiceId": {} + }, + "required": [] + } + } + }, + "DestinationPhoneNumber": {}, + "OriginationPhoneNumber": {} + } + }, + "output": { + "type": "structure", + "members": { + "MessageId": {} + } + } + }, + "UpdateConfigurationSetEventDestination": { + "http": { + "method": "PUT", + "requestUri": "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "ConfigurationSetName": { + "location": "uri", + "locationName": "ConfigurationSetName" + }, + "EventDestination": { + "shape": "S6" + }, + "EventDestinationName": { + "location": "uri", + "locationName": "EventDestinationName" + } + }, + "required": [ + "EventDestinationName", + "ConfigurationSetName" + ] + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "members": { + "CloudWatchLogsDestination": { + "shape": "S7" + }, + "Enabled": { + "type": "boolean" + }, + "KinesisFirehoseDestination": { + "shape": "Sa" + }, + "MatchingEventTypes": { + "shape": "Sb" + }, + "SnsDestination": { + "shape": "Sd" + } + }, + "required": [] + }, + "S7": { + "type": "structure", + "members": { + "IamRoleArn": {}, + "LogGroupArn": {} + }, + "required": [] + }, + "Sa": { + "type": "structure", + "members": { + "DeliveryStreamArn": {}, + "IamRoleArn": {} + }, + "required": [] + }, + "Sb": { + "type": "list", + "member": {} + }, + "Sd": { + "type": "structure", + "members": { + "TopicArn": {} + }, + "required": [] + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/snowball-2016-06-30.examples.json b/node_modules/aws-sdk/apis/snowball-2016-06-30.examples.json new file mode 100644 index 0000000..9d69971 --- /dev/null +++ b/node_modules/aws-sdk/apis/snowball-2016-06-30.examples.json @@ -0,0 +1,442 @@ +{ + "version": "1.0", + "examples": { + "CancelCluster": [ + { + "input": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.", + "id": "to-cancel-a-cluster-job-1482533760554", + "title": "To cancel a cluster job" + } + ], + "CancelJob": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.", + "id": "to-cancel-a-job-for-a-snowball-device-1482534699477", + "title": "To cancel a job for a Snowball device" + } + ], + "CreateAddress": [ + { + "input": { + "Address": { + "City": "Seattle", + "Company": "My Company's Name", + "Country": "USA", + "Name": "My Name", + "PhoneNumber": "425-555-5555", + "PostalCode": "98101", + "StateOrProvince": "WA", + "Street1": "123 Main Street" + } + }, + "output": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b" + }, + "comments": { + }, + "description": "This operation creates an address for a job. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.", + "id": "to-create-an-address-for-a-job-1482535416294", + "title": "To create an address for a job" + } + ], + "CreateCluster": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "Description": "MyCluster", + "JobType": "LOCAL_USE", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingOption": "SECOND_DAY", + "SnowballType": "EDGE" + }, + "output": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.", + "id": "to-create-a-cluster-1482864724077", + "title": "To create a cluster" + } + ], + "CreateJob": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "Description": "My Job", + "JobType": "IMPORT", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingOption": "SECOND_DAY", + "SnowballCapacityPreference": "T80", + "SnowballType": "STANDARD" + }, + "output": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.", + "id": "to-create-a-job-1482864834886", + "title": "To create a job" + } + ], + "DescribeAddress": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b" + }, + "output": { + "Address": { + "AddressId": "ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b", + "City": "Seattle", + "Company": "My Company", + "Country": "US", + "Name": "My Name", + "PhoneNumber": "425-555-5555", + "PostalCode": "98101", + "StateOrProvince": "WA", + "Street1": "123 Main Street" + } + }, + "comments": { + }, + "description": "This operation describes an address for a job.", + "id": "to-describe-an-address-for-a-job-1482538608745", + "title": "To describe an address for a job" + } + ], + "DescribeAddresses": [ + { + "input": { + }, + "output": { + "Addresses": [ + { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "City": "Seattle", + "Company": "My Company", + "Country": "US", + "Name": "My Name", + "PhoneNumber": "425-555-5555", + "PostalCode": "98101", + "StateOrProvince": "WA", + "Street1": "123 Main Street" + } + ] + }, + "comments": { + }, + "description": "This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.", + "id": "to-describe-all-the-addresses-youve-created-for-aws-snowball-1482538936603", + "title": "To describe all the addresses you've created for AWS Snowball" + } + ], + "DescribeCluster": [ + { + "input": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "ClusterMetadata": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000", + "ClusterState": "Pending", + "CreationDate": "1480475517.0", + "Description": "MyCluster", + "JobType": "LOCAL_USE", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingOption": "SECOND_DAY" + } + }, + "comments": { + }, + "description": "Returns information about a specific cluster including shipping information, cluster status, and other important metadata.", + "id": "to-describe-a-cluster-1482864218396", + "title": "To describe a cluster" + } + ], + "DescribeJob": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "JobMetadata": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "CreationDate": "1475626164", + "Description": "My Job", + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "JobState": "New", + "JobType": "IMPORT", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingDetails": { + "ShippingOption": "SECOND_DAY" + }, + "SnowballCapacityPreference": "T80", + "SnowballType": "STANDARD" + } + }, + "comments": { + }, + "description": "This operation describes a job you've created for AWS Snowball.", + "id": "to-describe-a-job-youve-created-for-aws-snowball-1482539500180", + "title": "To describe a job you've created for AWS Snowball" + } + ], + "GetJobManifest": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "ManifestURI": "https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=..." + }, + "comments": { + }, + "description": "Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.\n\nThe manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.\n\nAs a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.\n\nThe credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.", + "id": "to-get-the-manifest-for-a-job-youve-created-for-aws-snowball-1482540389246", + "title": "To get the manifest for a job you've created for AWS Snowball" + } + ], + "GetJobUnlockCode": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "UnlockCode": "12345-abcde-56789-fghij-01234" + }, + "comments": { + }, + "description": "Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.\n\nThe UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.\n\nAs a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.", + "id": "to-get-the-unlock-code-for-a-job-youve-created-for-aws-snowball-1482541987286", + "title": "To get the unlock code for a job you've created for AWS Snowball" + } + ], + "GetSnowballUsage": [ + { + "input": { + }, + "output": { + "SnowballLimit": 1, + "SnowballsInUse": 0 + }, + "comments": { + }, + "description": "Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.\n\nThe default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.", + "id": "to-see-your-snowball-service-limit-and-the-number-of-snowballs-you-have-in-use-1482863394588", + "title": "To see your Snowball service limit and the number of Snowballs you have in use" + } + ], + "ListClusterJobs": [ + { + "input": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "JobListEntries": [ + { + "CreationDate": "1480475524.0", + "Description": "MyClustrer-node-001", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-002", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440001", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-003", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440002", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-004", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440003", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-005", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440004", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + } + ] + }, + "comments": { + }, + "description": "Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.", + "id": "to-get-a-list-of-jobs-in-a-cluster-that-youve-created-for-aws-snowball-1482863105773", + "title": "To get a list of jobs in a cluster that you've created for AWS Snowball" + } + ], + "ListClusters": [ + { + "input": { + }, + "output": { + "ClusterListEntries": [ + { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000", + "ClusterState": "Pending", + "CreationDate": "1480475517.0", + "Description": "MyCluster" + } + ] + }, + "comments": { + }, + "description": "Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.", + "id": "to-get-a-list-of-clusters-that-youve-created-for-aws-snowball-1482862223003", + "title": "To get a list of clusters that you've created for AWS Snowball" + } + ], + "ListJobs": [ + { + "input": { + }, + "output": { + "JobListEntries": [ + { + "CreationDate": "1460678186.0", + "Description": "MyJob", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "JobState": "New", + "JobType": "IMPORT", + "SnowballType": "STANDARD" + } + ] + }, + "comments": { + }, + "description": "Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.", + "id": "to-get-a-list-of-jobs-that-youve-created-for-aws-snowball-1482542167627", + "title": "To get a list of jobs that you've created for AWS Snowball" + } + ], + "UpdateCluster": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000", + "Description": "Updated the address to send this to image processing - RJ" + }, + "comments": { + }, + "description": "This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available.", + "id": "to-update-a-cluster-1482863900595", + "title": "To update a cluster" + } + ], + "UpdateJob": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "Description": "Upgraded to Edge, shipped to Finance Dept, and requested faster shipping speed - TS.", + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "ShippingOption": "NEXT_DAY", + "SnowballCapacityPreference": "T100" + }, + "comments": { + }, + "description": "This action allows you to update certain parameters for a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.", + "id": "to-update-a-job-1482863556886", + "title": "To update a job" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/snowball-2016-06-30.min.json b/node_modules/aws-sdk/apis/snowball-2016-06-30.min.json new file mode 100644 index 0000000..b62afd0 --- /dev/null +++ b/node_modules/aws-sdk/apis/snowball-2016-06-30.min.json @@ -0,0 +1,618 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-06-30", + "endpointPrefix": "snowball", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Amazon Snowball", + "serviceFullName": "Amazon Import/Export Snowball", + "serviceId": "Snowball", + "signatureVersion": "v4", + "targetPrefix": "AWSIESnowballJobManagementService", + "uid": "snowball-2016-06-30" + }, + "operations": { + "CancelCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateAddress": { + "input": { + "type": "structure", + "required": [ + "Address" + ], + "members": { + "Address": { + "shape": "S8" + } + } + }, + "output": { + "type": "structure", + "members": { + "AddressId": {} + } + } + }, + "CreateCluster": { + "input": { + "type": "structure", + "required": [ + "JobType", + "Resources", + "AddressId", + "RoleARN", + "ShippingOption" + ], + "members": { + "JobType": {}, + "Resources": { + "shape": "Sf" + }, + "Description": {}, + "AddressId": {}, + "KmsKeyARN": {}, + "RoleARN": {}, + "SnowballType": {}, + "ShippingOption": {}, + "Notification": { + "shape": "Sv" + }, + "ForwardingAddressId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClusterId": {} + } + } + }, + "CreateJob": { + "input": { + "type": "structure", + "members": { + "JobType": {}, + "Resources": { + "shape": "Sf" + }, + "Description": {}, + "AddressId": {}, + "KmsKeyARN": {}, + "RoleARN": {}, + "SnowballCapacityPreference": {}, + "ShippingOption": {}, + "Notification": { + "shape": "Sv" + }, + "ClusterId": {}, + "SnowballType": {}, + "ForwardingAddressId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + } + }, + "DescribeAddress": { + "input": { + "type": "structure", + "required": [ + "AddressId" + ], + "members": { + "AddressId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Address": { + "shape": "S8" + } + } + } + }, + "DescribeAddresses": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Addresses": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "NextToken": {} + } + } + }, + "DescribeCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClusterMetadata": { + "type": "structure", + "members": { + "ClusterId": {}, + "Description": {}, + "KmsKeyARN": {}, + "RoleARN": {}, + "ClusterState": {}, + "JobType": {}, + "SnowballType": {}, + "CreationDate": { + "type": "timestamp" + }, + "Resources": { + "shape": "Sf" + }, + "AddressId": {}, + "ShippingOption": {}, + "Notification": { + "shape": "Sv" + }, + "ForwardingAddressId": {} + } + } + } + } + }, + "DescribeJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobMetadata": { + "shape": "S1g" + }, + "SubJobMetadata": { + "type": "list", + "member": { + "shape": "S1g" + } + } + } + } + }, + "GetJobManifest": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ManifestURI": {} + } + } + }, + "GetJobUnlockCode": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UnlockCode": {} + } + } + }, + "GetSnowballUsage": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "SnowballLimit": { + "type": "integer" + }, + "SnowballsInUse": { + "type": "integer" + } + } + } + }, + "ListClusterJobs": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobListEntries": { + "shape": "S1w" + }, + "NextToken": {} + } + } + }, + "ListClusters": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ClusterListEntries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ClusterId": {}, + "ClusterState": {}, + "CreationDate": { + "type": "timestamp" + }, + "Description": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListCompatibleImages": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "CompatibleImages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AmiId": {}, + "Name": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListJobs": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobListEntries": { + "shape": "S1w" + }, + "NextToken": {} + } + } + }, + "UpdateCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "RoleARN": {}, + "Description": {}, + "Resources": { + "shape": "Sf" + }, + "AddressId": {}, + "ShippingOption": {}, + "Notification": { + "shape": "Sv" + }, + "ForwardingAddressId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateJob": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "RoleARN": {}, + "Notification": { + "shape": "Sv" + }, + "Resources": { + "shape": "Sf" + }, + "AddressId": {}, + "ShippingOption": {}, + "Description": {}, + "SnowballCapacityPreference": {}, + "ForwardingAddressId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S8": { + "type": "structure", + "members": { + "AddressId": {}, + "Name": {}, + "Company": {}, + "Street1": {}, + "Street2": {}, + "Street3": {}, + "City": {}, + "StateOrProvince": {}, + "PrefectureOrDistrict": {}, + "Landmark": {}, + "Country": {}, + "PostalCode": {}, + "PhoneNumber": {}, + "IsRestricted": { + "type": "boolean" + } + } + }, + "Sf": { + "type": "structure", + "members": { + "S3Resources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BucketArn": {}, + "KeyRange": { + "type": "structure", + "members": { + "BeginMarker": {}, + "EndMarker": {} + } + } + } + } + }, + "LambdaResources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LambdaArn": {}, + "EventTriggers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventResourceARN": {} + } + } + } + } + } + }, + "Ec2AmiResources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AmiId" + ], + "members": { + "AmiId": {}, + "SnowballAmiId": {} + } + } + } + } + }, + "Sv": { + "type": "structure", + "members": { + "SnsTopicARN": {}, + "JobStatesToNotify": { + "type": "list", + "member": {} + }, + "NotifyAll": { + "type": "boolean" + } + } + }, + "S1g": { + "type": "structure", + "members": { + "JobId": {}, + "JobState": {}, + "JobType": {}, + "SnowballType": {}, + "CreationDate": { + "type": "timestamp" + }, + "Resources": { + "shape": "Sf" + }, + "Description": {}, + "KmsKeyARN": {}, + "RoleARN": {}, + "AddressId": {}, + "ShippingDetails": { + "type": "structure", + "members": { + "ShippingOption": {}, + "InboundShipment": { + "shape": "S1i" + }, + "OutboundShipment": { + "shape": "S1i" + } + } + }, + "SnowballCapacityPreference": {}, + "Notification": { + "shape": "Sv" + }, + "DataTransferProgress": { + "type": "structure", + "members": { + "BytesTransferred": { + "type": "long" + }, + "ObjectsTransferred": { + "type": "long" + }, + "TotalBytes": { + "type": "long" + }, + "TotalObjects": { + "type": "long" + } + } + }, + "JobLogInfo": { + "type": "structure", + "members": { + "JobCompletionReportURI": {}, + "JobSuccessLogURI": {}, + "JobFailureLogURI": {} + } + }, + "ClusterId": {}, + "ForwardingAddressId": {} + } + }, + "S1i": { + "type": "structure", + "members": { + "Status": {}, + "TrackingNumber": {} + } + }, + "S1w": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobId": {}, + "JobState": {}, + "IsMaster": { + "type": "boolean" + }, + "JobType": {}, + "SnowballType": {}, + "CreationDate": { + "type": "timestamp" + }, + "Description": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/snowball-2016-06-30.paginators.json b/node_modules/aws-sdk/apis/snowball-2016-06-30.paginators.json new file mode 100644 index 0000000..c5d937b --- /dev/null +++ b/node_modules/aws-sdk/apis/snowball-2016-06-30.paginators.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "DescribeAddresses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Addresses" + }, + "ListJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "JobListEntries" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sns-2010-03-31.examples.json b/node_modules/aws-sdk/apis/sns-2010-03-31.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/sns-2010-03-31.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/sns-2010-03-31.min.json b/node_modules/aws-sdk/apis/sns-2010-03-31.min.json new file mode 100644 index 0000000..f1e4ccc --- /dev/null +++ b/node_modules/aws-sdk/apis/sns-2010-03-31.min.json @@ -0,0 +1,717 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2010-03-31", + "endpointPrefix": "sns", + "protocol": "query", + "serviceAbbreviation": "Amazon SNS", + "serviceFullName": "Amazon Simple Notification Service", + "serviceId": "SNS", + "signatureVersion": "v4", + "uid": "sns-2010-03-31", + "xmlNamespace": "http://sns.amazonaws.com/doc/2010-03-31/" + }, + "operations": { + "AddPermission": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Label", + "AWSAccountId", + "ActionName" + ], + "members": { + "TopicArn": {}, + "Label": {}, + "AWSAccountId": { + "type": "list", + "member": {} + }, + "ActionName": { + "type": "list", + "member": {} + } + } + } + }, + "CheckIfPhoneNumberIsOptedOut": { + "input": { + "type": "structure", + "required": [ + "phoneNumber" + ], + "members": { + "phoneNumber": {} + } + }, + "output": { + "resultWrapper": "CheckIfPhoneNumberIsOptedOutResult", + "type": "structure", + "members": { + "isOptedOut": { + "type": "boolean" + } + } + } + }, + "ConfirmSubscription": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Token" + ], + "members": { + "TopicArn": {}, + "Token": {}, + "AuthenticateOnUnsubscribe": {} + } + }, + "output": { + "resultWrapper": "ConfirmSubscriptionResult", + "type": "structure", + "members": { + "SubscriptionArn": {} + } + } + }, + "CreatePlatformApplication": { + "input": { + "type": "structure", + "required": [ + "Name", + "Platform", + "Attributes" + ], + "members": { + "Name": {}, + "Platform": {}, + "Attributes": { + "shape": "Sj" + } + } + }, + "output": { + "resultWrapper": "CreatePlatformApplicationResult", + "type": "structure", + "members": { + "PlatformApplicationArn": {} + } + } + }, + "CreatePlatformEndpoint": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn", + "Token" + ], + "members": { + "PlatformApplicationArn": {}, + "Token": {}, + "CustomUserData": {}, + "Attributes": { + "shape": "Sj" + } + } + }, + "output": { + "resultWrapper": "CreatePlatformEndpointResult", + "type": "structure", + "members": { + "EndpointArn": {} + } + } + }, + "CreateTopic": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Attributes": { + "shape": "Sp" + }, + "Tags": { + "shape": "Ss" + } + } + }, + "output": { + "resultWrapper": "CreateTopicResult", + "type": "structure", + "members": { + "TopicArn": {} + } + } + }, + "DeleteEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + } + }, + "DeletePlatformApplication": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn" + ], + "members": { + "PlatformApplicationArn": {} + } + } + }, + "DeleteTopic": { + "input": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {} + } + } + }, + "GetEndpointAttributes": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + }, + "output": { + "resultWrapper": "GetEndpointAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "Sj" + } + } + } + }, + "GetPlatformApplicationAttributes": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn" + ], + "members": { + "PlatformApplicationArn": {} + } + }, + "output": { + "resultWrapper": "GetPlatformApplicationAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "Sj" + } + } + } + }, + "GetSMSAttributes": { + "input": { + "type": "structure", + "members": { + "attributes": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "GetSMSAttributesResult", + "type": "structure", + "members": { + "attributes": { + "shape": "Sj" + } + } + } + }, + "GetSubscriptionAttributes": { + "input": { + "type": "structure", + "required": [ + "SubscriptionArn" + ], + "members": { + "SubscriptionArn": {} + } + }, + "output": { + "resultWrapper": "GetSubscriptionAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "S19" + } + } + } + }, + "GetTopicAttributes": { + "input": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {} + } + }, + "output": { + "resultWrapper": "GetTopicAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "Sp" + } + } + } + }, + "ListEndpointsByPlatformApplication": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn" + ], + "members": { + "PlatformApplicationArn": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListEndpointsByPlatformApplicationResult", + "type": "structure", + "members": { + "Endpoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EndpointArn": {}, + "Attributes": { + "shape": "Sj" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListPhoneNumbersOptedOut": { + "input": { + "type": "structure", + "members": { + "nextToken": {} + } + }, + "output": { + "resultWrapper": "ListPhoneNumbersOptedOutResult", + "type": "structure", + "members": { + "phoneNumbers": { + "type": "list", + "member": {} + }, + "nextToken": {} + } + } + }, + "ListPlatformApplications": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListPlatformApplicationsResult", + "type": "structure", + "members": { + "PlatformApplications": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlatformApplicationArn": {}, + "Attributes": { + "shape": "Sj" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListSubscriptions": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListSubscriptionsResult", + "type": "structure", + "members": { + "Subscriptions": { + "shape": "S1r" + }, + "NextToken": {} + } + } + }, + "ListSubscriptionsByTopic": { + "input": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListSubscriptionsByTopicResult", + "type": "structure", + "members": { + "Subscriptions": { + "shape": "S1r" + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "Tags": { + "shape": "Ss" + } + } + } + }, + "ListTopics": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListTopicsResult", + "type": "structure", + "members": { + "Topics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TopicArn": {} + } + } + }, + "NextToken": {} + } + } + }, + "OptInPhoneNumber": { + "input": { + "type": "structure", + "required": [ + "phoneNumber" + ], + "members": { + "phoneNumber": {} + } + }, + "output": { + "resultWrapper": "OptInPhoneNumberResult", + "type": "structure", + "members": {} + } + }, + "Publish": { + "input": { + "type": "structure", + "required": [ + "Message" + ], + "members": { + "TopicArn": {}, + "TargetArn": {}, + "PhoneNumber": {}, + "Message": {}, + "Subject": {}, + "MessageStructure": {}, + "MessageAttributes": { + "type": "map", + "key": { + "locationName": "Name" + }, + "value": { + "locationName": "Value", + "type": "structure", + "required": [ + "DataType" + ], + "members": { + "DataType": {}, + "StringValue": {}, + "BinaryValue": { + "type": "blob" + } + } + } + } + } + }, + "output": { + "resultWrapper": "PublishResult", + "type": "structure", + "members": { + "MessageId": {} + } + } + }, + "RemovePermission": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Label" + ], + "members": { + "TopicArn": {}, + "Label": {} + } + } + }, + "SetEndpointAttributes": { + "input": { + "type": "structure", + "required": [ + "EndpointArn", + "Attributes" + ], + "members": { + "EndpointArn": {}, + "Attributes": { + "shape": "Sj" + } + } + } + }, + "SetPlatformApplicationAttributes": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn", + "Attributes" + ], + "members": { + "PlatformApplicationArn": {}, + "Attributes": { + "shape": "Sj" + } + } + } + }, + "SetSMSAttributes": { + "input": { + "type": "structure", + "required": [ + "attributes" + ], + "members": { + "attributes": { + "shape": "Sj" + } + } + }, + "output": { + "resultWrapper": "SetSMSAttributesResult", + "type": "structure", + "members": {} + } + }, + "SetSubscriptionAttributes": { + "input": { + "type": "structure", + "required": [ + "SubscriptionArn", + "AttributeName" + ], + "members": { + "SubscriptionArn": {}, + "AttributeName": {}, + "AttributeValue": {} + } + } + }, + "SetTopicAttributes": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "AttributeName" + ], + "members": { + "TopicArn": {}, + "AttributeName": {}, + "AttributeValue": {} + } + } + }, + "Subscribe": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Protocol" + ], + "members": { + "TopicArn": {}, + "Protocol": {}, + "Endpoint": {}, + "Attributes": { + "shape": "S19" + }, + "ReturnSubscriptionArn": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SubscribeResult", + "type": "structure", + "members": { + "SubscriptionArn": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": {}, + "Tags": { + "shape": "Ss" + } + } + }, + "output": { + "resultWrapper": "TagResourceResult", + "type": "structure", + "members": {} + } + }, + "Unsubscribe": { + "input": { + "type": "structure", + "required": [ + "SubscriptionArn" + ], + "members": { + "SubscriptionArn": {} + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "UntagResourceResult", + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sj": { + "type": "map", + "key": {}, + "value": {} + }, + "Sp": { + "type": "map", + "key": {}, + "value": {} + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S19": { + "type": "map", + "key": {}, + "value": {} + }, + "S1r": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SubscriptionArn": {}, + "Owner": {}, + "Protocol": {}, + "Endpoint": {}, + "TopicArn": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sns-2010-03-31.paginators.json b/node_modules/aws-sdk/apis/sns-2010-03-31.paginators.json new file mode 100644 index 0000000..df5bc6b --- /dev/null +++ b/node_modules/aws-sdk/apis/sns-2010-03-31.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "ListEndpointsByPlatformApplication": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Endpoints" + }, + "ListPlatformApplications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "PlatformApplications" + }, + "ListSubscriptions": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListSubscriptionsByTopic": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListTopics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Topics" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sqs-2012-11-05.examples.json b/node_modules/aws-sdk/apis/sqs-2012-11-05.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/sqs-2012-11-05.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/sqs-2012-11-05.min.json b/node_modules/aws-sdk/apis/sqs-2012-11-05.min.json new file mode 100644 index 0000000..ebf5b89 --- /dev/null +++ b/node_modules/aws-sdk/apis/sqs-2012-11-05.min.json @@ -0,0 +1,665 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-11-05", + "endpointPrefix": "sqs", + "protocol": "query", + "serviceAbbreviation": "Amazon SQS", + "serviceFullName": "Amazon Simple Queue Service", + "serviceId": "SQS", + "signatureVersion": "v4", + "uid": "sqs-2012-11-05", + "xmlNamespace": "http://queue.amazonaws.com/doc/2012-11-05/" + }, + "operations": { + "AddPermission": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Label", + "AWSAccountIds", + "Actions" + ], + "members": { + "QueueUrl": {}, + "Label": {}, + "AWSAccountIds": { + "type": "list", + "member": { + "locationName": "AWSAccountId" + }, + "flattened": true + }, + "Actions": { + "type": "list", + "member": { + "locationName": "ActionName" + }, + "flattened": true + } + } + } + }, + "ChangeMessageVisibility": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "ReceiptHandle", + "VisibilityTimeout" + ], + "members": { + "QueueUrl": {}, + "ReceiptHandle": {}, + "VisibilityTimeout": { + "type": "integer" + } + } + } + }, + "ChangeMessageVisibilityBatch": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Entries" + ], + "members": { + "QueueUrl": {}, + "Entries": { + "type": "list", + "member": { + "locationName": "ChangeMessageVisibilityBatchRequestEntry", + "type": "structure", + "required": [ + "Id", + "ReceiptHandle" + ], + "members": { + "Id": {}, + "ReceiptHandle": {}, + "VisibilityTimeout": { + "type": "integer" + } + } + }, + "flattened": true + } + } + }, + "output": { + "resultWrapper": "ChangeMessageVisibilityBatchResult", + "type": "structure", + "required": [ + "Successful", + "Failed" + ], + "members": { + "Successful": { + "type": "list", + "member": { + "locationName": "ChangeMessageVisibilityBatchResultEntry", + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "flattened": true + }, + "Failed": { + "shape": "Sd" + } + } + } + }, + "CreateQueue": { + "input": { + "type": "structure", + "required": [ + "QueueName" + ], + "members": { + "QueueName": {}, + "Attributes": { + "shape": "Sh", + "locationName": "Attribute" + } + } + }, + "output": { + "resultWrapper": "CreateQueueResult", + "type": "structure", + "members": { + "QueueUrl": {} + } + } + }, + "DeleteMessage": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "ReceiptHandle" + ], + "members": { + "QueueUrl": {}, + "ReceiptHandle": {} + } + } + }, + "DeleteMessageBatch": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Entries" + ], + "members": { + "QueueUrl": {}, + "Entries": { + "type": "list", + "member": { + "locationName": "DeleteMessageBatchRequestEntry", + "type": "structure", + "required": [ + "Id", + "ReceiptHandle" + ], + "members": { + "Id": {}, + "ReceiptHandle": {} + } + }, + "flattened": true + } + } + }, + "output": { + "resultWrapper": "DeleteMessageBatchResult", + "type": "structure", + "required": [ + "Successful", + "Failed" + ], + "members": { + "Successful": { + "type": "list", + "member": { + "locationName": "DeleteMessageBatchResultEntry", + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "flattened": true + }, + "Failed": { + "shape": "Sd" + } + } + } + }, + "DeleteQueue": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {} + } + } + }, + "GetQueueAttributes": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {}, + "AttributeNames": { + "shape": "St" + } + } + }, + "output": { + "resultWrapper": "GetQueueAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "Sh", + "locationName": "Attribute" + } + } + } + }, + "GetQueueUrl": { + "input": { + "type": "structure", + "required": [ + "QueueName" + ], + "members": { + "QueueName": {}, + "QueueOwnerAWSAccountId": {} + } + }, + "output": { + "resultWrapper": "GetQueueUrlResult", + "type": "structure", + "members": { + "QueueUrl": {} + } + } + }, + "ListDeadLetterSourceQueues": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {} + } + }, + "output": { + "resultWrapper": "ListDeadLetterSourceQueuesResult", + "type": "structure", + "required": [ + "queueUrls" + ], + "members": { + "queueUrls": { + "shape": "Sz" + } + } + } + }, + "ListQueueTags": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {} + } + }, + "output": { + "resultWrapper": "ListQueueTagsResult", + "type": "structure", + "members": { + "Tags": { + "shape": "S12", + "locationName": "Tag" + } + } + } + }, + "ListQueues": { + "input": { + "type": "structure", + "members": { + "QueueNamePrefix": {} + } + }, + "output": { + "resultWrapper": "ListQueuesResult", + "type": "structure", + "members": { + "QueueUrls": { + "shape": "Sz" + } + } + } + }, + "PurgeQueue": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {} + } + } + }, + "ReceiveMessage": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {}, + "AttributeNames": { + "shape": "St" + }, + "MessageAttributeNames": { + "type": "list", + "member": { + "locationName": "MessageAttributeName" + }, + "flattened": true + }, + "MaxNumberOfMessages": { + "type": "integer" + }, + "VisibilityTimeout": { + "type": "integer" + }, + "WaitTimeSeconds": { + "type": "integer" + }, + "ReceiveRequestAttemptId": {} + } + }, + "output": { + "resultWrapper": "ReceiveMessageResult", + "type": "structure", + "members": { + "Messages": { + "type": "list", + "member": { + "locationName": "Message", + "type": "structure", + "members": { + "MessageId": {}, + "ReceiptHandle": {}, + "MD5OfBody": {}, + "Body": {}, + "Attributes": { + "locationName": "Attribute", + "type": "map", + "key": { + "locationName": "Name" + }, + "value": { + "locationName": "Value" + }, + "flattened": true + }, + "MD5OfMessageAttributes": {}, + "MessageAttributes": { + "shape": "S1g", + "locationName": "MessageAttribute" + } + } + }, + "flattened": true + } + } + } + }, + "RemovePermission": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Label" + ], + "members": { + "QueueUrl": {}, + "Label": {} + } + } + }, + "SendMessage": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "MessageBody" + ], + "members": { + "QueueUrl": {}, + "MessageBody": {}, + "DelaySeconds": { + "type": "integer" + }, + "MessageAttributes": { + "shape": "S1g", + "locationName": "MessageAttribute" + }, + "MessageDeduplicationId": {}, + "MessageGroupId": {} + } + }, + "output": { + "resultWrapper": "SendMessageResult", + "type": "structure", + "members": { + "MD5OfMessageBody": {}, + "MD5OfMessageAttributes": {}, + "MessageId": {}, + "SequenceNumber": {} + } + } + }, + "SendMessageBatch": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Entries" + ], + "members": { + "QueueUrl": {}, + "Entries": { + "type": "list", + "member": { + "locationName": "SendMessageBatchRequestEntry", + "type": "structure", + "required": [ + "Id", + "MessageBody" + ], + "members": { + "Id": {}, + "MessageBody": {}, + "DelaySeconds": { + "type": "integer" + }, + "MessageAttributes": { + "shape": "S1g", + "locationName": "MessageAttribute" + }, + "MessageDeduplicationId": {}, + "MessageGroupId": {} + } + }, + "flattened": true + } + } + }, + "output": { + "resultWrapper": "SendMessageBatchResult", + "type": "structure", + "required": [ + "Successful", + "Failed" + ], + "members": { + "Successful": { + "type": "list", + "member": { + "locationName": "SendMessageBatchResultEntry", + "type": "structure", + "required": [ + "Id", + "MessageId", + "MD5OfMessageBody" + ], + "members": { + "Id": {}, + "MessageId": {}, + "MD5OfMessageBody": {}, + "MD5OfMessageAttributes": {}, + "SequenceNumber": {} + } + }, + "flattened": true + }, + "Failed": { + "shape": "Sd" + } + } + } + }, + "SetQueueAttributes": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Attributes" + ], + "members": { + "QueueUrl": {}, + "Attributes": { + "shape": "Sh", + "locationName": "Attribute" + } + } + } + }, + "TagQueue": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Tags" + ], + "members": { + "QueueUrl": {}, + "Tags": { + "shape": "S12" + } + } + } + }, + "UntagQueue": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "TagKeys" + ], + "members": { + "QueueUrl": {}, + "TagKeys": { + "type": "list", + "member": { + "locationName": "TagKey" + }, + "flattened": true + } + } + } + } + }, + "shapes": { + "Sd": { + "type": "list", + "member": { + "locationName": "BatchResultErrorEntry", + "type": "structure", + "required": [ + "Id", + "SenderFault", + "Code" + ], + "members": { + "Id": {}, + "SenderFault": { + "type": "boolean" + }, + "Code": {}, + "Message": {} + } + }, + "flattened": true + }, + "Sh": { + "type": "map", + "key": { + "locationName": "Name" + }, + "value": { + "locationName": "Value" + }, + "flattened": true, + "locationName": "Attribute" + }, + "St": { + "type": "list", + "member": { + "locationName": "AttributeName" + }, + "flattened": true + }, + "Sz": { + "type": "list", + "member": { + "locationName": "QueueUrl" + }, + "flattened": true + }, + "S12": { + "type": "map", + "key": { + "locationName": "Key" + }, + "value": { + "locationName": "Value" + }, + "flattened": true, + "locationName": "Tag" + }, + "S1g": { + "type": "map", + "key": { + "locationName": "Name" + }, + "value": { + "locationName": "Value", + "type": "structure", + "required": [ + "DataType" + ], + "members": { + "StringValue": {}, + "BinaryValue": { + "type": "blob" + }, + "StringListValues": { + "flattened": true, + "locationName": "StringListValue", + "type": "list", + "member": { + "locationName": "StringListValue" + } + }, + "BinaryListValues": { + "flattened": true, + "locationName": "BinaryListValue", + "type": "list", + "member": { + "locationName": "BinaryListValue", + "type": "blob" + } + }, + "DataType": {} + } + }, + "flattened": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sqs-2012-11-05.paginators.json b/node_modules/aws-sdk/apis/sqs-2012-11-05.paginators.json new file mode 100644 index 0000000..4d5fe76 --- /dev/null +++ b/node_modules/aws-sdk/apis/sqs-2012-11-05.paginators.json @@ -0,0 +1,7 @@ +{ + "pagination": { + "ListQueues": { + "result_key": "QueueUrls" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ssm-2014-11-06.examples.json b/node_modules/aws-sdk/apis/ssm-2014-11-06.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/ssm-2014-11-06.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json b/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json new file mode 100644 index 0000000..1a87562 --- /dev/null +++ b/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json @@ -0,0 +1,5127 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2014-11-06", + "endpointPrefix": "ssm", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "Amazon SSM", + "serviceFullName": "Amazon Simple Systems Manager (SSM)", + "serviceId": "SSM", + "signatureVersion": "v4", + "targetPrefix": "AmazonSSM", + "uid": "ssm-2014-11-06" + }, + "operations": { + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceType", + "ResourceId", + "Tags" + ], + "members": { + "ResourceType": {}, + "ResourceId": {}, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelCommand": { + "input": { + "type": "structure", + "required": [ + "CommandId" + ], + "members": { + "CommandId": {}, + "InstanceIds": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CancelMaintenanceWindowExecution": { + "input": { + "type": "structure", + "required": [ + "WindowExecutionId" + ], + "members": { + "WindowExecutionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowExecutionId": {} + } + } + }, + "CreateActivation": { + "input": { + "type": "structure", + "required": [ + "IamRole" + ], + "members": { + "Description": {}, + "DefaultInstanceName": {}, + "IamRole": {}, + "RegistrationLimit": { + "type": "integer" + }, + "ExpirationDate": { + "type": "timestamp" + }, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "ActivationId": {}, + "ActivationCode": {} + } + } + }, + "CreateAssociation": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "DocumentVersion": {}, + "InstanceId": {}, + "Parameters": { + "shape": "St" + }, + "Targets": { + "shape": "Sx" + }, + "ScheduleExpression": {}, + "OutputLocation": { + "shape": "S13" + }, + "AssociationName": {}, + "AutomationTargetParameterName": {}, + "MaxErrors": {}, + "MaxConcurrency": {}, + "ComplianceSeverity": {} + } + }, + "output": { + "type": "structure", + "members": { + "AssociationDescription": { + "shape": "S1e" + } + } + } + }, + "CreateAssociationBatch": { + "input": { + "type": "structure", + "required": [ + "Entries" + ], + "members": { + "Entries": { + "type": "list", + "member": { + "shape": "S1s" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Successful": { + "type": "list", + "member": { + "shape": "S1e" + } + }, + "Failed": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Entry": { + "shape": "S1s" + }, + "Message": {}, + "Fault": {} + } + } + } + } + } + }, + "CreateDocument": { + "input": { + "type": "structure", + "required": [ + "Content", + "Name" + ], + "members": { + "Content": {}, + "Attachments": { + "shape": "S21" + }, + "Name": {}, + "VersionName": {}, + "DocumentType": {}, + "DocumentFormat": {}, + "TargetType": {}, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "DocumentDescription": { + "shape": "S2c" + } + } + } + }, + "CreateMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "Name", + "Schedule", + "Duration", + "Cutoff", + "AllowUnassociatedTargets" + ], + "members": { + "Name": {}, + "Description": { + "shape": "S2y" + }, + "StartDate": {}, + "EndDate": {}, + "Schedule": {}, + "ScheduleTimezone": {}, + "Duration": { + "type": "integer" + }, + "Cutoff": { + "type": "integer" + }, + "AllowUnassociatedTargets": { + "type": "boolean" + }, + "ClientToken": { + "idempotencyToken": true + }, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {} + } + } + }, + "CreatePatchBaseline": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "OperatingSystem": {}, + "Name": {}, + "GlobalFilters": { + "shape": "S3b" + }, + "ApprovalRules": { + "shape": "S3h" + }, + "ApprovedPatches": { + "shape": "S3n" + }, + "ApprovedPatchesComplianceLevel": {}, + "ApprovedPatchesEnableNonSecurity": { + "type": "boolean" + }, + "RejectedPatches": { + "shape": "S3n" + }, + "RejectedPatchesAction": {}, + "Description": {}, + "Sources": { + "shape": "S3r" + }, + "ClientToken": { + "idempotencyToken": true + }, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {} + } + } + }, + "CreateResourceDataSync": { + "input": { + "type": "structure", + "required": [ + "SyncName", + "S3Destination" + ], + "members": { + "SyncName": {}, + "S3Destination": { + "shape": "S41" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteActivation": { + "input": { + "type": "structure", + "required": [ + "ActivationId" + ], + "members": { + "ActivationId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteAssociation": { + "input": { + "type": "structure", + "members": { + "Name": {}, + "InstanceId": {}, + "AssociationId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDocument": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteInventory": { + "input": { + "type": "structure", + "required": [ + "TypeName" + ], + "members": { + "TypeName": {}, + "SchemaDeleteOption": {}, + "DryRun": { + "type": "boolean" + }, + "ClientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "DeletionId": {}, + "TypeName": {}, + "DeletionSummary": { + "shape": "S4k" + } + } + } + }, + "DeleteMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "WindowId" + ], + "members": { + "WindowId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {} + } + } + }, + "DeleteParameter": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteParameters": { + "input": { + "type": "structure", + "required": [ + "Names" + ], + "members": { + "Names": { + "shape": "S4x" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeletedParameters": { + "shape": "S4x" + }, + "InvalidParameters": { + "shape": "S4x" + } + } + } + }, + "DeletePatchBaseline": { + "input": { + "type": "structure", + "required": [ + "BaselineId" + ], + "members": { + "BaselineId": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {} + } + } + }, + "DeleteResourceDataSync": { + "input": { + "type": "structure", + "required": [ + "SyncName" + ], + "members": { + "SyncName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeregisterManagedInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeregisterPatchBaselineForPatchGroup": { + "input": { + "type": "structure", + "required": [ + "BaselineId", + "PatchGroup" + ], + "members": { + "BaselineId": {}, + "PatchGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {}, + "PatchGroup": {} + } + } + }, + "DeregisterTargetFromMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "WindowId", + "WindowTargetId" + ], + "members": { + "WindowId": {}, + "WindowTargetId": {}, + "Safe": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowTargetId": {} + } + } + }, + "DeregisterTaskFromMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "WindowId", + "WindowTaskId" + ], + "members": { + "WindowId": {}, + "WindowTaskId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowTaskId": {} + } + } + }, + "DescribeActivations": { + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FilterKey": {}, + "FilterValues": { + "type": "list", + "member": {} + } + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ActivationList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ActivationId": {}, + "Description": {}, + "DefaultInstanceName": {}, + "IamRole": {}, + "RegistrationLimit": { + "type": "integer" + }, + "RegistrationsCount": { + "type": "integer" + }, + "ExpirationDate": { + "type": "timestamp" + }, + "Expired": { + "type": "boolean" + }, + "CreatedDate": { + "type": "timestamp" + }, + "Tags": { + "shape": "S4" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAssociation": { + "input": { + "type": "structure", + "members": { + "Name": {}, + "InstanceId": {}, + "AssociationId": {}, + "AssociationVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "AssociationDescription": { + "shape": "S1e" + } + } + } + }, + "DescribeAssociationExecutionTargets": { + "input": { + "type": "structure", + "required": [ + "AssociationId", + "ExecutionId" + ], + "members": { + "AssociationId": {}, + "ExecutionId": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AssociationExecutionTargets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AssociationId": {}, + "AssociationVersion": {}, + "ExecutionId": {}, + "ResourceId": {}, + "ResourceType": {}, + "Status": {}, + "DetailedStatus": {}, + "LastExecutionDate": { + "type": "timestamp" + }, + "OutputSource": { + "type": "structure", + "members": { + "OutputSourceId": {}, + "OutputSourceType": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAssociationExecutions": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "AssociationId": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value", + "Type" + ], + "members": { + "Key": {}, + "Value": {}, + "Type": {} + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AssociationExecutions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AssociationId": {}, + "AssociationVersion": {}, + "ExecutionId": {}, + "Status": {}, + "DetailedStatus": {}, + "CreatedTime": { + "type": "timestamp" + }, + "LastExecutionDate": { + "type": "timestamp" + }, + "ResourceCountByStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAutomationExecutions": { + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AutomationExecutionMetadataList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AutomationExecutionId": {}, + "DocumentName": {}, + "DocumentVersion": {}, + "AutomationExecutionStatus": {}, + "ExecutionStartTime": { + "type": "timestamp" + }, + "ExecutionEndTime": { + "type": "timestamp" + }, + "ExecutedBy": {}, + "LogFile": {}, + "Outputs": { + "shape": "S6t" + }, + "Mode": {}, + "ParentAutomationExecutionId": {}, + "CurrentStepName": {}, + "CurrentAction": {}, + "FailureMessage": {}, + "TargetParameterName": {}, + "Targets": { + "shape": "Sx" + }, + "TargetMaps": { + "shape": "S6y" + }, + "ResolvedTargets": { + "shape": "S73" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "Target": {}, + "AutomationType": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAutomationStepExecutions": { + "input": { + "type": "structure", + "required": [ + "AutomationExecutionId" + ], + "members": { + "AutomationExecutionId": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "ReverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "StepExecutions": { + "shape": "S7d" + }, + "NextToken": {} + } + } + }, + "DescribeAvailablePatches": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S7t" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Patches": { + "type": "list", + "member": { + "shape": "S81" + } + }, + "NextToken": {} + } + } + }, + "DescribeDocument": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "DocumentVersion": {}, + "VersionName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Document": { + "shape": "S2c" + } + } + } + }, + "DescribeDocumentPermission": { + "input": { + "type": "structure", + "required": [ + "Name", + "PermissionType" + ], + "members": { + "Name": {}, + "PermissionType": {} + } + }, + "output": { + "type": "structure", + "members": { + "AccountIds": { + "shape": "S8i" + } + } + } + }, + "DescribeEffectiveInstanceAssociations": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Associations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AssociationId": {}, + "InstanceId": {}, + "Content": {}, + "AssociationVersion": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeEffectivePatchesForPatchBaseline": { + "input": { + "type": "structure", + "required": [ + "BaselineId" + ], + "members": { + "BaselineId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "EffectivePatches": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Patch": { + "shape": "S81" + }, + "PatchStatus": { + "type": "structure", + "members": { + "DeploymentStatus": {}, + "ComplianceLevel": {}, + "ApprovalDate": { + "type": "timestamp" + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeInstanceAssociationsStatus": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceAssociationStatusInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AssociationId": {}, + "Name": {}, + "DocumentVersion": {}, + "AssociationVersion": {}, + "InstanceId": {}, + "ExecutionDate": { + "type": "timestamp" + }, + "Status": {}, + "DetailedStatus": {}, + "ExecutionSummary": {}, + "ErrorCode": {}, + "OutputUrl": { + "type": "structure", + "members": { + "S3OutputUrl": { + "type": "structure", + "members": { + "OutputUrl": {} + } + } + } + }, + "AssociationName": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeInstanceInformation": { + "input": { + "type": "structure", + "members": { + "InstanceInformationFilterList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "valueSet" + ], + "members": { + "key": {}, + "valueSet": { + "shape": "S98" + } + } + } + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "shape": "S98" + } + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceInformationList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "PingStatus": {}, + "LastPingDateTime": { + "type": "timestamp" + }, + "AgentVersion": {}, + "IsLatestVersion": { + "type": "boolean" + }, + "PlatformType": {}, + "PlatformName": {}, + "PlatformVersion": {}, + "ActivationId": {}, + "IamRole": {}, + "RegistrationDate": { + "type": "timestamp" + }, + "ResourceType": {}, + "Name": {}, + "IPAddress": {}, + "ComputerName": {}, + "AssociationStatus": {}, + "LastAssociationExecutionDate": { + "type": "timestamp" + }, + "LastSuccessfulAssociationExecutionDate": { + "type": "timestamp" + }, + "AssociationOverview": { + "type": "structure", + "members": { + "DetailedStatus": {}, + "InstanceAssociationStatusAggregatedCount": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeInstancePatchStates": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sb" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstancePatchStates": { + "type": "list", + "member": { + "shape": "S9s" + } + }, + "NextToken": {} + } + } + }, + "DescribeInstancePatchStatesForPatchGroup": { + "input": { + "type": "structure", + "required": [ + "PatchGroup" + ], + "members": { + "PatchGroup": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values", + "Type" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + }, + "Type": {} + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstancePatchStates": { + "type": "list", + "member": { + "shape": "S9s" + } + }, + "NextToken": {} + } + } + }, + "DescribeInstancePatches": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "Filters": { + "shape": "S7t" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Patches": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Title", + "KBId", + "Classification", + "Severity", + "State", + "InstalledTime" + ], + "members": { + "Title": {}, + "KBId": {}, + "Classification": {}, + "Severity": {}, + "State": {}, + "InstalledTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeInventoryDeletions": { + "input": { + "type": "structure", + "members": { + "DeletionId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "InventoryDeletions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DeletionId": {}, + "TypeName": {}, + "DeletionStartTime": { + "type": "timestamp" + }, + "LastStatus": {}, + "LastStatusMessage": {}, + "DeletionSummary": { + "shape": "S4k" + }, + "LastStatusUpdateTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindowExecutionTaskInvocations": { + "input": { + "type": "structure", + "required": [ + "WindowExecutionId", + "TaskId" + ], + "members": { + "WindowExecutionId": {}, + "TaskId": {}, + "Filters": { + "shape": "Sat" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowExecutionTaskInvocationIdentities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowExecutionId": {}, + "TaskExecutionId": {}, + "InvocationId": {}, + "ExecutionId": {}, + "TaskType": {}, + "Parameters": { + "shape": "Sb5" + }, + "Status": {}, + "StatusDetails": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "OwnerInformation": { + "shape": "S9v" + }, + "WindowTargetId": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindowExecutionTasks": { + "input": { + "type": "structure", + "required": [ + "WindowExecutionId" + ], + "members": { + "WindowExecutionId": {}, + "Filters": { + "shape": "Sat" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowExecutionTaskIdentities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowExecutionId": {}, + "TaskExecutionId": {}, + "Status": {}, + "StatusDetails": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "TaskArn": {}, + "TaskType": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindowExecutions": { + "input": { + "type": "structure", + "required": [ + "WindowId" + ], + "members": { + "WindowId": {}, + "Filters": { + "shape": "Sat" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowExecutions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowExecutionId": {}, + "Status": {}, + "StatusDetails": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindowSchedule": { + "input": { + "type": "structure", + "members": { + "WindowId": {}, + "Targets": { + "shape": "Sx" + }, + "ResourceType": {}, + "Filters": { + "shape": "S7t" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ScheduledWindowExecutions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowId": {}, + "Name": {}, + "ExecutionTime": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindowTargets": { + "input": { + "type": "structure", + "required": [ + "WindowId" + ], + "members": { + "WindowId": {}, + "Filters": { + "shape": "Sat" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Targets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowTargetId": {}, + "ResourceType": {}, + "Targets": { + "shape": "Sx" + }, + "OwnerInformation": { + "shape": "S9v" + }, + "Name": {}, + "Description": { + "shape": "S2y" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindowTasks": { + "input": { + "type": "structure", + "required": [ + "WindowId" + ], + "members": { + "WindowId": {}, + "Filters": { + "shape": "Sat" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Tasks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowTaskId": {}, + "TaskArn": {}, + "Type": {}, + "Targets": { + "shape": "Sx" + }, + "TaskParameters": { + "shape": "Sbw" + }, + "Priority": { + "type": "integer" + }, + "LoggingInfo": { + "shape": "Sc2" + }, + "ServiceRoleArn": {}, + "MaxConcurrency": {}, + "MaxErrors": {}, + "Name": {}, + "Description": { + "shape": "S2y" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindows": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sat" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowIdentities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowId": {}, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "Enabled": { + "type": "boolean" + }, + "Duration": { + "type": "integer" + }, + "Cutoff": { + "type": "integer" + }, + "Schedule": {}, + "ScheduleTimezone": {}, + "EndDate": {}, + "StartDate": {}, + "NextExecutionTime": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeMaintenanceWindowsForTarget": { + "input": { + "type": "structure", + "required": [ + "Targets", + "ResourceType" + ], + "members": { + "Targets": { + "shape": "Sx" + }, + "ResourceType": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowIdentities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WindowId": {}, + "Name": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeParameters": { + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "ParameterFilters": { + "shape": "Scj" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Type": {}, + "KeyId": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "LastModifiedUser": {}, + "Description": {}, + "AllowedPattern": {}, + "Version": { + "type": "long" + }, + "Tier": {}, + "Policies": { + "shape": "Scy" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribePatchBaselines": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "S7t" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineIdentities": { + "type": "list", + "member": { + "shape": "Sd3" + } + }, + "NextToken": {} + } + } + }, + "DescribePatchGroupState": { + "input": { + "type": "structure", + "required": [ + "PatchGroup" + ], + "members": { + "PatchGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "integer" + }, + "InstancesWithInstalledPatches": { + "type": "integer" + }, + "InstancesWithInstalledOtherPatches": { + "type": "integer" + }, + "InstancesWithInstalledRejectedPatches": { + "type": "integer" + }, + "InstancesWithMissingPatches": { + "type": "integer" + }, + "InstancesWithFailedPatches": { + "type": "integer" + }, + "InstancesWithNotApplicablePatches": { + "type": "integer" + }, + "InstancesWithUnreportedNotApplicablePatches": { + "type": "integer" + } + } + } + }, + "DescribePatchGroups": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "Filters": { + "shape": "S7t" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Mappings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PatchGroup": {}, + "BaselineIdentity": { + "shape": "Sd3" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribePatchProperties": { + "input": { + "type": "structure", + "required": [ + "OperatingSystem", + "Property" + ], + "members": { + "OperatingSystem": {}, + "Property": {}, + "PatchSet": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Properties": { + "type": "list", + "member": { + "type": "map", + "key": {}, + "value": {} + } + }, + "NextToken": {} + } + } + }, + "DescribeSessions": { + "input": { + "type": "structure", + "required": [ + "State" + ], + "members": { + "State": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Sessions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SessionId": {}, + "Target": {}, + "Status": {}, + "StartDate": { + "type": "timestamp" + }, + "EndDate": { + "type": "timestamp" + }, + "DocumentName": {}, + "Owner": {}, + "Details": {}, + "OutputUrl": { + "type": "structure", + "members": { + "S3OutputUrl": {}, + "CloudWatchOutputUrl": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "GetAutomationExecution": { + "input": { + "type": "structure", + "required": [ + "AutomationExecutionId" + ], + "members": { + "AutomationExecutionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "AutomationExecution": { + "type": "structure", + "members": { + "AutomationExecutionId": {}, + "DocumentName": {}, + "DocumentVersion": {}, + "ExecutionStartTime": { + "type": "timestamp" + }, + "ExecutionEndTime": { + "type": "timestamp" + }, + "AutomationExecutionStatus": {}, + "StepExecutions": { + "shape": "S7d" + }, + "StepExecutionsTruncated": { + "type": "boolean" + }, + "Parameters": { + "shape": "S6t" + }, + "Outputs": { + "shape": "S6t" + }, + "FailureMessage": {}, + "Mode": {}, + "ParentAutomationExecutionId": {}, + "ExecutedBy": {}, + "CurrentStepName": {}, + "CurrentAction": {}, + "TargetParameterName": {}, + "Targets": { + "shape": "Sx" + }, + "TargetMaps": { + "shape": "S6y" + }, + "ResolvedTargets": { + "shape": "S73" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "Target": {}, + "TargetLocations": { + "shape": "Se5" + }, + "ProgressCounters": { + "type": "structure", + "members": { + "TotalSteps": { + "type": "integer" + }, + "SuccessSteps": { + "type": "integer" + }, + "FailedSteps": { + "type": "integer" + }, + "CancelledSteps": { + "type": "integer" + }, + "TimedOutSteps": { + "type": "integer" + } + } + } + } + } + } + } + }, + "GetCommandInvocation": { + "input": { + "type": "structure", + "required": [ + "CommandId", + "InstanceId" + ], + "members": { + "CommandId": {}, + "InstanceId": {}, + "PluginName": {} + } + }, + "output": { + "type": "structure", + "members": { + "CommandId": {}, + "InstanceId": {}, + "Comment": {}, + "DocumentName": {}, + "DocumentVersion": {}, + "PluginName": {}, + "ResponseCode": { + "type": "integer" + }, + "ExecutionStartDateTime": {}, + "ExecutionElapsedTime": {}, + "ExecutionEndDateTime": {}, + "Status": {}, + "StatusDetails": {}, + "StandardOutputContent": {}, + "StandardOutputUrl": {}, + "StandardErrorContent": {}, + "StandardErrorUrl": {}, + "CloudWatchOutputConfig": { + "shape": "Seh" + } + } + } + }, + "GetConnectionStatus": { + "input": { + "type": "structure", + "required": [ + "Target" + ], + "members": { + "Target": {} + } + }, + "output": { + "type": "structure", + "members": { + "Target": {}, + "Status": {} + } + } + }, + "GetDefaultPatchBaseline": { + "input": { + "type": "structure", + "members": { + "OperatingSystem": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {}, + "OperatingSystem": {} + } + } + }, + "GetDeployablePatchSnapshotForInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "SnapshotId" + ], + "members": { + "InstanceId": {}, + "SnapshotId": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": {}, + "SnapshotId": {}, + "SnapshotDownloadUrl": {}, + "Product": {} + } + } + }, + "GetDocument": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "VersionName": {}, + "DocumentVersion": {}, + "DocumentFormat": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "VersionName": {}, + "DocumentVersion": {}, + "Status": {}, + "StatusInformation": {}, + "Content": {}, + "DocumentType": {}, + "DocumentFormat": {}, + "AttachmentsContent": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Size": { + "type": "long" + }, + "Hash": {}, + "HashType": {}, + "Url": {} + } + } + } + } + } + }, + "GetInventory": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Sf2" + }, + "Aggregators": { + "shape": "Sf8" + }, + "ResultAttributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "TypeName" + ], + "members": { + "TypeName": {} + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Entities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Data": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "TypeName", + "SchemaVersion", + "Content" + ], + "members": { + "TypeName": {}, + "SchemaVersion": {}, + "CaptureTime": {}, + "ContentHash": {}, + "Content": { + "shape": "Sfp" + } + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "GetInventorySchema": { + "input": { + "type": "structure", + "members": { + "TypeName": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "Aggregator": { + "type": "boolean" + }, + "SubType": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Schemas": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "TypeName", + "Attributes" + ], + "members": { + "TypeName": {}, + "Version": {}, + "Attributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "DataType" + ], + "members": { + "Name": {}, + "DataType": {} + } + } + }, + "DisplayName": {} + } + } + }, + "NextToken": {} + } + } + }, + "GetMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "WindowId" + ], + "members": { + "WindowId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {}, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "StartDate": {}, + "EndDate": {}, + "Schedule": {}, + "ScheduleTimezone": {}, + "NextExecutionTime": {}, + "Duration": { + "type": "integer" + }, + "Cutoff": { + "type": "integer" + }, + "AllowUnassociatedTargets": { + "type": "boolean" + }, + "Enabled": { + "type": "boolean" + }, + "CreatedDate": { + "type": "timestamp" + }, + "ModifiedDate": { + "type": "timestamp" + } + } + } + }, + "GetMaintenanceWindowExecution": { + "input": { + "type": "structure", + "required": [ + "WindowExecutionId" + ], + "members": { + "WindowExecutionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowExecutionId": {}, + "TaskIds": { + "type": "list", + "member": {} + }, + "Status": {}, + "StatusDetails": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + } + } + } + }, + "GetMaintenanceWindowExecutionTask": { + "input": { + "type": "structure", + "required": [ + "WindowExecutionId", + "TaskId" + ], + "members": { + "WindowExecutionId": {}, + "TaskId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowExecutionId": {}, + "TaskExecutionId": {}, + "TaskArn": {}, + "ServiceRole": {}, + "Type": {}, + "TaskParameters": { + "type": "list", + "member": { + "shape": "Sbw" + }, + "sensitive": true + }, + "Priority": { + "type": "integer" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "Status": {}, + "StatusDetails": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + } + } + } + }, + "GetMaintenanceWindowExecutionTaskInvocation": { + "input": { + "type": "structure", + "required": [ + "WindowExecutionId", + "TaskId", + "InvocationId" + ], + "members": { + "WindowExecutionId": {}, + "TaskId": {}, + "InvocationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowExecutionId": {}, + "TaskExecutionId": {}, + "InvocationId": {}, + "ExecutionId": {}, + "TaskType": {}, + "Parameters": { + "shape": "Sb5" + }, + "Status": {}, + "StatusDetails": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "OwnerInformation": { + "shape": "S9v" + }, + "WindowTargetId": {} + } + } + }, + "GetMaintenanceWindowTask": { + "input": { + "type": "structure", + "required": [ + "WindowId", + "WindowTaskId" + ], + "members": { + "WindowId": {}, + "WindowTaskId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowTaskId": {}, + "Targets": { + "shape": "Sx" + }, + "TaskArn": {}, + "ServiceRoleArn": {}, + "TaskType": {}, + "TaskParameters": { + "shape": "Sbw" + }, + "TaskInvocationParameters": { + "shape": "Sgg" + }, + "Priority": { + "type": "integer" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "LoggingInfo": { + "shape": "Sc2" + }, + "Name": {}, + "Description": { + "shape": "S2y" + } + } + } + }, + "GetParameter": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "WithDecryption": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Parameter": { + "shape": "Sgy" + } + } + } + }, + "GetParameterHistory": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "WithDecryption": { + "type": "boolean" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Type": {}, + "KeyId": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "LastModifiedUser": {}, + "Description": {}, + "Value": {}, + "AllowedPattern": {}, + "Version": { + "type": "long" + }, + "Labels": { + "shape": "Sh5" + }, + "Tier": {}, + "Policies": { + "shape": "Scy" + } + } + } + }, + "NextToken": {} + } + } + }, + "GetParameters": { + "input": { + "type": "structure", + "required": [ + "Names" + ], + "members": { + "Names": { + "shape": "S4x" + }, + "WithDecryption": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Parameters": { + "shape": "Sh9" + }, + "InvalidParameters": { + "shape": "S4x" + } + } + } + }, + "GetParametersByPath": { + "input": { + "type": "structure", + "required": [ + "Path" + ], + "members": { + "Path": {}, + "Recursive": { + "type": "boolean" + }, + "ParameterFilters": { + "shape": "Scj" + }, + "WithDecryption": { + "type": "boolean" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Parameters": { + "shape": "Sh9" + }, + "NextToken": {} + } + } + }, + "GetPatchBaseline": { + "input": { + "type": "structure", + "required": [ + "BaselineId" + ], + "members": { + "BaselineId": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {}, + "Name": {}, + "OperatingSystem": {}, + "GlobalFilters": { + "shape": "S3b" + }, + "ApprovalRules": { + "shape": "S3h" + }, + "ApprovedPatches": { + "shape": "S3n" + }, + "ApprovedPatchesComplianceLevel": {}, + "ApprovedPatchesEnableNonSecurity": { + "type": "boolean" + }, + "RejectedPatches": { + "shape": "S3n" + }, + "RejectedPatchesAction": {}, + "PatchGroups": { + "type": "list", + "member": {} + }, + "CreatedDate": { + "type": "timestamp" + }, + "ModifiedDate": { + "type": "timestamp" + }, + "Description": {}, + "Sources": { + "shape": "S3r" + } + } + } + }, + "GetPatchBaselineForPatchGroup": { + "input": { + "type": "structure", + "required": [ + "PatchGroup" + ], + "members": { + "PatchGroup": {}, + "OperatingSystem": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {}, + "PatchGroup": {}, + "OperatingSystem": {} + } + } + }, + "GetServiceSetting": { + "input": { + "type": "structure", + "required": [ + "SettingId" + ], + "members": { + "SettingId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceSetting": { + "shape": "Shl" + } + } + } + }, + "LabelParameterVersion": { + "input": { + "type": "structure", + "required": [ + "Name", + "Labels" + ], + "members": { + "Name": {}, + "ParameterVersion": { + "type": "long" + }, + "Labels": { + "shape": "Sh5" + } + } + }, + "output": { + "type": "structure", + "members": { + "InvalidLabels": { + "shape": "Sh5" + } + } + } + }, + "ListAssociationVersions": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "AssociationId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AssociationVersions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AssociationId": {}, + "AssociationVersion": {}, + "CreatedDate": { + "type": "timestamp" + }, + "Name": {}, + "DocumentVersion": {}, + "Parameters": { + "shape": "St" + }, + "Targets": { + "shape": "Sx" + }, + "ScheduleExpression": {}, + "OutputLocation": { + "shape": "S13" + }, + "AssociationName": {}, + "MaxErrors": {}, + "MaxConcurrency": {}, + "ComplianceSeverity": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListAssociations": { + "input": { + "type": "structure", + "members": { + "AssociationFilterList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Associations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "InstanceId": {}, + "AssociationId": {}, + "AssociationVersion": {}, + "DocumentVersion": {}, + "Targets": { + "shape": "Sx" + }, + "LastExecutionDate": { + "type": "timestamp" + }, + "Overview": { + "shape": "S1l" + }, + "ScheduleExpression": {}, + "AssociationName": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListCommandInvocations": { + "input": { + "type": "structure", + "members": { + "CommandId": {}, + "InstanceId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "Si3" + }, + "Details": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CommandInvocations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CommandId": {}, + "InstanceId": {}, + "InstanceName": {}, + "Comment": {}, + "DocumentName": {}, + "DocumentVersion": {}, + "RequestedDateTime": { + "type": "timestamp" + }, + "Status": {}, + "StatusDetails": {}, + "TraceOutput": {}, + "StandardOutputUrl": {}, + "StandardErrorUrl": {}, + "CommandPlugins": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Status": {}, + "StatusDetails": {}, + "ResponseCode": { + "type": "integer" + }, + "ResponseStartDateTime": { + "type": "timestamp" + }, + "ResponseFinishDateTime": { + "type": "timestamp" + }, + "Output": {}, + "StandardOutputUrl": {}, + "StandardErrorUrl": {}, + "OutputS3Region": {}, + "OutputS3BucketName": {}, + "OutputS3KeyPrefix": {} + } + } + }, + "ServiceRole": {}, + "NotificationConfig": { + "shape": "Sgi" + }, + "CloudWatchOutputConfig": { + "shape": "Seh" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListCommands": { + "input": { + "type": "structure", + "members": { + "CommandId": {}, + "InstanceId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "Filters": { + "shape": "Si3" + } + } + }, + "output": { + "type": "structure", + "members": { + "Commands": { + "type": "list", + "member": { + "shape": "Sij" + } + }, + "NextToken": {} + } + } + }, + "ListComplianceItems": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Siq" + }, + "ResourceIds": { + "type": "list", + "member": {} + }, + "ResourceTypes": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ComplianceItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ComplianceType": {}, + "ResourceType": {}, + "ResourceId": {}, + "Id": {}, + "Title": {}, + "Status": {}, + "Severity": {}, + "ExecutionSummary": { + "shape": "Sj8" + }, + "Details": { + "shape": "Sjb" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListComplianceSummaries": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Siq" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ComplianceSummaryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ComplianceType": {}, + "CompliantSummary": { + "shape": "Sjg" + }, + "NonCompliantSummary": { + "shape": "Sjj" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListDocumentVersions": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentVersions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "DocumentVersion": {}, + "VersionName": {}, + "CreatedDate": { + "type": "timestamp" + }, + "IsDefaultVersion": { + "type": "boolean" + }, + "DocumentFormat": {}, + "Status": {}, + "StatusInformation": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListDocuments": { + "input": { + "type": "structure", + "members": { + "DocumentFilterList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentIdentifiers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Owner": {}, + "VersionName": {}, + "PlatformTypes": { + "shape": "S2q" + }, + "DocumentVersion": {}, + "DocumentType": {}, + "SchemaVersion": {}, + "DocumentFormat": {}, + "TargetType": {}, + "Tags": { + "shape": "S4" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListInventoryEntries": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "TypeName" + ], + "members": { + "InstanceId": {}, + "TypeName": {}, + "Filters": { + "shape": "Sf2" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TypeName": {}, + "InstanceId": {}, + "SchemaVersion": {}, + "CaptureTime": {}, + "Entries": { + "shape": "Sfp" + }, + "NextToken": {} + } + } + }, + "ListResourceComplianceSummaries": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Siq" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceComplianceSummaryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ComplianceType": {}, + "ResourceType": {}, + "ResourceId": {}, + "Status": {}, + "OverallSeverity": {}, + "ExecutionSummary": { + "shape": "Sj8" + }, + "CompliantSummary": { + "shape": "Sjg" + }, + "NonCompliantSummary": { + "shape": "Sjj" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListResourceDataSync": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceDataSyncItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SyncName": {}, + "S3Destination": { + "shape": "S41" + }, + "LastSyncTime": { + "type": "timestamp" + }, + "LastSuccessfulSyncTime": { + "type": "timestamp" + }, + "LastStatus": {}, + "SyncCreatedTime": { + "type": "timestamp" + }, + "LastSyncStatusMessage": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceType", + "ResourceId" + ], + "members": { + "ResourceType": {}, + "ResourceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "TagList": { + "shape": "S4" + } + } + } + }, + "ModifyDocumentPermission": { + "input": { + "type": "structure", + "required": [ + "Name", + "PermissionType" + ], + "members": { + "Name": {}, + "PermissionType": {}, + "AccountIdsToAdd": { + "shape": "S8i" + }, + "AccountIdsToRemove": { + "shape": "S8i" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutComplianceItems": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "ResourceType", + "ComplianceType", + "ExecutionSummary", + "Items" + ], + "members": { + "ResourceId": {}, + "ResourceType": {}, + "ComplianceType": {}, + "ExecutionSummary": { + "shape": "Sj8" + }, + "Items": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Severity", + "Status" + ], + "members": { + "Id": {}, + "Title": {}, + "Severity": {}, + "Status": {}, + "Details": { + "shape": "Sjb" + } + } + } + }, + "ItemContentHash": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutInventory": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "Items" + ], + "members": { + "InstanceId": {}, + "Items": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "TypeName", + "SchemaVersion", + "CaptureTime" + ], + "members": { + "TypeName": {}, + "SchemaVersion": {}, + "CaptureTime": {}, + "ContentHash": {}, + "Content": { + "shape": "Sfp" + }, + "Context": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Message": {} + } + } + }, + "PutParameter": { + "input": { + "type": "structure", + "required": [ + "Name", + "Value", + "Type" + ], + "members": { + "Name": {}, + "Description": {}, + "Value": {}, + "Type": {}, + "KeyId": {}, + "Overwrite": { + "type": "boolean" + }, + "AllowedPattern": {}, + "Tags": { + "shape": "S4" + }, + "Tier": {}, + "Policies": {} + } + }, + "output": { + "type": "structure", + "members": { + "Version": { + "type": "long" + } + } + } + }, + "RegisterDefaultPatchBaseline": { + "input": { + "type": "structure", + "required": [ + "BaselineId" + ], + "members": { + "BaselineId": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {} + } + } + }, + "RegisterPatchBaselineForPatchGroup": { + "input": { + "type": "structure", + "required": [ + "BaselineId", + "PatchGroup" + ], + "members": { + "BaselineId": {}, + "PatchGroup": {} + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {}, + "PatchGroup": {} + } + } + }, + "RegisterTargetWithMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "WindowId", + "ResourceType", + "Targets" + ], + "members": { + "WindowId": {}, + "ResourceType": {}, + "Targets": { + "shape": "Sx" + }, + "OwnerInformation": { + "shape": "S9v" + }, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "ClientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "WindowTargetId": {} + } + } + }, + "RegisterTaskWithMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "WindowId", + "Targets", + "TaskArn", + "TaskType", + "MaxConcurrency", + "MaxErrors" + ], + "members": { + "WindowId": {}, + "Targets": { + "shape": "Sx" + }, + "TaskArn": {}, + "ServiceRoleArn": {}, + "TaskType": {}, + "TaskParameters": { + "shape": "Sbw" + }, + "TaskInvocationParameters": { + "shape": "Sgg" + }, + "Priority": { + "type": "integer" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "LoggingInfo": { + "shape": "Sc2" + }, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "ClientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "WindowTaskId": {} + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceType", + "ResourceId", + "TagKeys" + ], + "members": { + "ResourceType": {}, + "ResourceId": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ResetServiceSetting": { + "input": { + "type": "structure", + "required": [ + "SettingId" + ], + "members": { + "SettingId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ServiceSetting": { + "shape": "Shl" + } + } + } + }, + "ResumeSession": { + "input": { + "type": "structure", + "required": [ + "SessionId" + ], + "members": { + "SessionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SessionId": {}, + "TokenValue": {}, + "StreamUrl": {} + } + } + }, + "SendAutomationSignal": { + "input": { + "type": "structure", + "required": [ + "AutomationExecutionId", + "SignalType" + ], + "members": { + "AutomationExecutionId": {}, + "SignalType": {}, + "Payload": { + "shape": "S6t" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SendCommand": { + "input": { + "type": "structure", + "required": [ + "DocumentName" + ], + "members": { + "InstanceIds": { + "shape": "Sb" + }, + "Targets": { + "shape": "Sx" + }, + "DocumentName": {}, + "DocumentVersion": {}, + "DocumentHash": {}, + "DocumentHashType": {}, + "TimeoutSeconds": { + "type": "integer" + }, + "Comment": {}, + "Parameters": { + "shape": "St" + }, + "OutputS3Region": {}, + "OutputS3BucketName": {}, + "OutputS3KeyPrefix": {}, + "MaxConcurrency": {}, + "MaxErrors": {}, + "ServiceRoleArn": {}, + "NotificationConfig": { + "shape": "Sgi" + }, + "CloudWatchOutputConfig": { + "shape": "Seh" + } + } + }, + "output": { + "type": "structure", + "members": { + "Command": { + "shape": "Sij" + } + } + } + }, + "StartAssociationsOnce": { + "input": { + "type": "structure", + "required": [ + "AssociationIds" + ], + "members": { + "AssociationIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartAutomationExecution": { + "input": { + "type": "structure", + "required": [ + "DocumentName" + ], + "members": { + "DocumentName": {}, + "DocumentVersion": {}, + "Parameters": { + "shape": "S6t" + }, + "ClientToken": {}, + "Mode": {}, + "TargetParameterName": {}, + "Targets": { + "shape": "Sx" + }, + "TargetMaps": { + "shape": "S6y" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "TargetLocations": { + "shape": "Se5" + } + } + }, + "output": { + "type": "structure", + "members": { + "AutomationExecutionId": {} + } + } + }, + "StartSession": { + "input": { + "type": "structure", + "required": [ + "Target" + ], + "members": { + "Target": {}, + "DocumentName": {}, + "Parameters": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SessionId": {}, + "TokenValue": {}, + "StreamUrl": {} + } + } + }, + "StopAutomationExecution": { + "input": { + "type": "structure", + "required": [ + "AutomationExecutionId" + ], + "members": { + "AutomationExecutionId": {}, + "Type": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "TerminateSession": { + "input": { + "type": "structure", + "required": [ + "SessionId" + ], + "members": { + "SessionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SessionId": {} + } + } + }, + "UpdateAssociation": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "AssociationId": {}, + "Parameters": { + "shape": "St" + }, + "DocumentVersion": {}, + "ScheduleExpression": {}, + "OutputLocation": { + "shape": "S13" + }, + "Name": {}, + "Targets": { + "shape": "Sx" + }, + "AssociationName": {}, + "AssociationVersion": {}, + "AutomationTargetParameterName": {}, + "MaxErrors": {}, + "MaxConcurrency": {}, + "ComplianceSeverity": {} + } + }, + "output": { + "type": "structure", + "members": { + "AssociationDescription": { + "shape": "S1e" + } + } + } + }, + "UpdateAssociationStatus": { + "input": { + "type": "structure", + "required": [ + "Name", + "InstanceId", + "AssociationStatus" + ], + "members": { + "Name": {}, + "InstanceId": {}, + "AssociationStatus": { + "shape": "S1h" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssociationDescription": { + "shape": "S1e" + } + } + } + }, + "UpdateDocument": { + "input": { + "type": "structure", + "required": [ + "Content", + "Name" + ], + "members": { + "Content": {}, + "Attachments": { + "shape": "S21" + }, + "Name": {}, + "VersionName": {}, + "DocumentVersion": {}, + "DocumentFormat": {}, + "TargetType": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentDescription": { + "shape": "S2c" + } + } + } + }, + "UpdateDocumentDefaultVersion": { + "input": { + "type": "structure", + "required": [ + "Name", + "DocumentVersion" + ], + "members": { + "Name": {}, + "DocumentVersion": {} + } + }, + "output": { + "type": "structure", + "members": { + "Description": { + "type": "structure", + "members": { + "Name": {}, + "DefaultVersion": {}, + "DefaultVersionName": {} + } + } + } + } + }, + "UpdateMaintenanceWindow": { + "input": { + "type": "structure", + "required": [ + "WindowId" + ], + "members": { + "WindowId": {}, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "StartDate": {}, + "EndDate": {}, + "Schedule": {}, + "ScheduleTimezone": {}, + "Duration": { + "type": "integer" + }, + "Cutoff": { + "type": "integer" + }, + "AllowUnassociatedTargets": { + "type": "boolean" + }, + "Enabled": { + "type": "boolean" + }, + "Replace": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {}, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "StartDate": {}, + "EndDate": {}, + "Schedule": {}, + "ScheduleTimezone": {}, + "Duration": { + "type": "integer" + }, + "Cutoff": { + "type": "integer" + }, + "AllowUnassociatedTargets": { + "type": "boolean" + }, + "Enabled": { + "type": "boolean" + } + } + } + }, + "UpdateMaintenanceWindowTarget": { + "input": { + "type": "structure", + "required": [ + "WindowId", + "WindowTargetId" + ], + "members": { + "WindowId": {}, + "WindowTargetId": {}, + "Targets": { + "shape": "Sx" + }, + "OwnerInformation": { + "shape": "S9v" + }, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "Replace": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowTargetId": {}, + "Targets": { + "shape": "Sx" + }, + "OwnerInformation": { + "shape": "S9v" + }, + "Name": {}, + "Description": { + "shape": "S2y" + } + } + } + }, + "UpdateMaintenanceWindowTask": { + "input": { + "type": "structure", + "required": [ + "WindowId", + "WindowTaskId" + ], + "members": { + "WindowId": {}, + "WindowTaskId": {}, + "Targets": { + "shape": "Sx" + }, + "TaskArn": {}, + "ServiceRoleArn": {}, + "TaskParameters": { + "shape": "Sbw" + }, + "TaskInvocationParameters": { + "shape": "Sgg" + }, + "Priority": { + "type": "integer" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "LoggingInfo": { + "shape": "Sc2" + }, + "Name": {}, + "Description": { + "shape": "S2y" + }, + "Replace": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "WindowId": {}, + "WindowTaskId": {}, + "Targets": { + "shape": "Sx" + }, + "TaskArn": {}, + "ServiceRoleArn": {}, + "TaskParameters": { + "shape": "Sbw" + }, + "TaskInvocationParameters": { + "shape": "Sgg" + }, + "Priority": { + "type": "integer" + }, + "MaxConcurrency": {}, + "MaxErrors": {}, + "LoggingInfo": { + "shape": "Sc2" + }, + "Name": {}, + "Description": { + "shape": "S2y" + } + } + } + }, + "UpdateManagedInstanceRole": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "IamRole" + ], + "members": { + "InstanceId": {}, + "IamRole": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdatePatchBaseline": { + "input": { + "type": "structure", + "required": [ + "BaselineId" + ], + "members": { + "BaselineId": {}, + "Name": {}, + "GlobalFilters": { + "shape": "S3b" + }, + "ApprovalRules": { + "shape": "S3h" + }, + "ApprovedPatches": { + "shape": "S3n" + }, + "ApprovedPatchesComplianceLevel": {}, + "ApprovedPatchesEnableNonSecurity": { + "type": "boolean" + }, + "RejectedPatches": { + "shape": "S3n" + }, + "RejectedPatchesAction": {}, + "Description": {}, + "Sources": { + "shape": "S3r" + }, + "Replace": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "BaselineId": {}, + "Name": {}, + "OperatingSystem": {}, + "GlobalFilters": { + "shape": "S3b" + }, + "ApprovalRules": { + "shape": "S3h" + }, + "ApprovedPatches": { + "shape": "S3n" + }, + "ApprovedPatchesComplianceLevel": {}, + "ApprovedPatchesEnableNonSecurity": { + "type": "boolean" + }, + "RejectedPatches": { + "shape": "S3n" + }, + "RejectedPatchesAction": {}, + "CreatedDate": { + "type": "timestamp" + }, + "ModifiedDate": { + "type": "timestamp" + }, + "Description": {}, + "Sources": { + "shape": "S3r" + } + } + } + }, + "UpdateServiceSetting": { + "input": { + "type": "structure", + "required": [ + "SettingId", + "SettingValue" + ], + "members": { + "SettingId": {}, + "SettingValue": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sb": { + "type": "list", + "member": {} + }, + "St": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "Sx": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "S13": { + "type": "structure", + "members": { + "S3Location": { + "type": "structure", + "members": { + "OutputS3Region": {}, + "OutputS3BucketName": {}, + "OutputS3KeyPrefix": {} + } + } + } + }, + "S1e": { + "type": "structure", + "members": { + "Name": {}, + "InstanceId": {}, + "AssociationVersion": {}, + "Date": { + "type": "timestamp" + }, + "LastUpdateAssociationDate": { + "type": "timestamp" + }, + "Status": { + "shape": "S1h" + }, + "Overview": { + "shape": "S1l" + }, + "DocumentVersion": {}, + "AutomationTargetParameterName": {}, + "Parameters": { + "shape": "St" + }, + "AssociationId": {}, + "Targets": { + "shape": "Sx" + }, + "ScheduleExpression": {}, + "OutputLocation": { + "shape": "S13" + }, + "LastExecutionDate": { + "type": "timestamp" + }, + "LastSuccessfulExecutionDate": { + "type": "timestamp" + }, + "AssociationName": {}, + "MaxErrors": {}, + "MaxConcurrency": {}, + "ComplianceSeverity": {} + } + }, + "S1h": { + "type": "structure", + "required": [ + "Date", + "Name", + "Message" + ], + "members": { + "Date": { + "type": "timestamp" + }, + "Name": {}, + "Message": {}, + "AdditionalInfo": {} + } + }, + "S1l": { + "type": "structure", + "members": { + "Status": {}, + "DetailedStatus": {}, + "AssociationStatusAggregatedCount": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + }, + "S1s": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "InstanceId": {}, + "Parameters": { + "shape": "St" + }, + "AutomationTargetParameterName": {}, + "DocumentVersion": {}, + "Targets": { + "shape": "Sx" + }, + "ScheduleExpression": {}, + "OutputLocation": { + "shape": "S13" + }, + "AssociationName": {}, + "MaxErrors": {}, + "MaxConcurrency": {}, + "ComplianceSeverity": {} + } + }, + "S21": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "S2c": { + "type": "structure", + "members": { + "Sha1": {}, + "Hash": {}, + "HashType": {}, + "Name": {}, + "VersionName": {}, + "Owner": {}, + "CreatedDate": { + "type": "timestamp" + }, + "Status": {}, + "StatusInformation": {}, + "DocumentVersion": {}, + "Description": {}, + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Type": {}, + "Description": {}, + "DefaultValue": {} + } + } + }, + "PlatformTypes": { + "shape": "S2q" + }, + "DocumentType": {}, + "SchemaVersion": {}, + "LatestVersion": {}, + "DefaultVersion": {}, + "DocumentFormat": {}, + "TargetType": {}, + "Tags": { + "shape": "S4" + }, + "AttachmentsInformation": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + } + } + }, + "S2q": { + "type": "list", + "member": {} + }, + "S2y": { + "type": "string", + "sensitive": true + }, + "S3b": { + "type": "structure", + "required": [ + "PatchFilters" + ], + "members": { + "PatchFilters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "S3h": { + "type": "structure", + "required": [ + "PatchRules" + ], + "members": { + "PatchRules": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "PatchFilterGroup", + "ApproveAfterDays" + ], + "members": { + "PatchFilterGroup": { + "shape": "S3b" + }, + "ComplianceLevel": {}, + "ApproveAfterDays": { + "type": "integer" + }, + "EnableNonSecurity": { + "type": "boolean" + } + } + } + } + } + }, + "S3n": { + "type": "list", + "member": {} + }, + "S3r": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Products", + "Configuration" + ], + "members": { + "Name": {}, + "Products": { + "type": "list", + "member": {} + }, + "Configuration": { + "type": "string", + "sensitive": true + } + } + } + }, + "S41": { + "type": "structure", + "required": [ + "BucketName", + "SyncFormat", + "Region" + ], + "members": { + "BucketName": {}, + "Prefix": {}, + "SyncFormat": {}, + "Region": {}, + "AWSKMSKeyARN": {} + } + }, + "S4k": { + "type": "structure", + "members": { + "TotalCount": { + "type": "integer" + }, + "RemainingCount": { + "type": "integer" + }, + "SummaryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Version": {}, + "Count": { + "type": "integer" + }, + "RemainingCount": { + "type": "integer" + } + } + } + } + } + }, + "S4x": { + "type": "list", + "member": {} + }, + "S6t": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "S6y": { + "type": "list", + "member": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + } + }, + "S73": { + "type": "structure", + "members": { + "ParameterValues": { + "type": "list", + "member": {} + }, + "Truncated": { + "type": "boolean" + } + } + }, + "S7d": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StepName": {}, + "Action": {}, + "TimeoutSeconds": { + "type": "long" + }, + "OnFailure": {}, + "MaxAttempts": { + "type": "integer" + }, + "ExecutionStartTime": { + "type": "timestamp" + }, + "ExecutionEndTime": { + "type": "timestamp" + }, + "StepStatus": {}, + "ResponseCode": {}, + "Inputs": { + "type": "map", + "key": {}, + "value": {} + }, + "Outputs": { + "shape": "S6t" + }, + "Response": {}, + "FailureMessage": {}, + "FailureDetails": { + "type": "structure", + "members": { + "FailureStage": {}, + "FailureType": {}, + "Details": { + "shape": "S6t" + } + } + }, + "StepExecutionId": {}, + "OverriddenParameters": { + "shape": "S6t" + }, + "IsEnd": { + "type": "boolean" + }, + "NextStep": {}, + "IsCritical": { + "type": "boolean" + }, + "ValidNextSteps": { + "type": "list", + "member": {} + }, + "Targets": { + "shape": "Sx" + }, + "TargetLocation": { + "shape": "S7m" + } + } + } + }, + "S7m": { + "type": "structure", + "members": { + "Accounts": { + "type": "list", + "member": {} + }, + "Regions": { + "type": "list", + "member": {} + }, + "TargetLocationMaxConcurrency": {}, + "TargetLocationMaxErrors": {}, + "ExecutionRoleName": {} + } + }, + "S7t": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "S81": { + "type": "structure", + "members": { + "Id": {}, + "ReleaseDate": { + "type": "timestamp" + }, + "Title": {}, + "Description": {}, + "ContentUrl": {}, + "Vendor": {}, + "ProductFamily": {}, + "Product": {}, + "Classification": {}, + "MsrcSeverity": {}, + "KbNumber": {}, + "MsrcNumber": {}, + "Language": {} + } + }, + "S8i": { + "type": "list", + "member": {} + }, + "S98": { + "type": "list", + "member": {} + }, + "S9s": { + "type": "structure", + "required": [ + "InstanceId", + "PatchGroup", + "BaselineId", + "OperationStartTime", + "OperationEndTime", + "Operation" + ], + "members": { + "InstanceId": {}, + "PatchGroup": {}, + "BaselineId": {}, + "SnapshotId": {}, + "InstallOverrideList": {}, + "OwnerInformation": { + "shape": "S9v" + }, + "InstalledCount": { + "type": "integer" + }, + "InstalledOtherCount": { + "type": "integer" + }, + "InstalledRejectedCount": { + "type": "integer" + }, + "MissingCount": { + "type": "integer" + }, + "FailedCount": { + "type": "integer" + }, + "UnreportedNotApplicableCount": { + "type": "integer" + }, + "NotApplicableCount": { + "type": "integer" + }, + "OperationStartTime": { + "type": "timestamp" + }, + "OperationEndTime": { + "type": "timestamp" + }, + "Operation": {} + } + }, + "S9v": { + "type": "string", + "sensitive": true + }, + "Sat": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "Sb5": { + "type": "string", + "sensitive": true + }, + "Sbw": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Values": { + "type": "list", + "member": { + "type": "string", + "sensitive": true + }, + "sensitive": true + } + }, + "sensitive": true + }, + "sensitive": true + }, + "Sc2": { + "type": "structure", + "required": [ + "S3BucketName", + "S3Region" + ], + "members": { + "S3BucketName": {}, + "S3KeyPrefix": {}, + "S3Region": {} + } + }, + "Scj": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Option": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "Scy": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyText": {}, + "PolicyType": {}, + "PolicyStatus": {} + } + } + }, + "Sd3": { + "type": "structure", + "members": { + "BaselineId": {}, + "BaselineName": {}, + "OperatingSystem": {}, + "BaselineDescription": {}, + "DefaultBaseline": { + "type": "boolean" + } + } + }, + "Se5": { + "type": "list", + "member": { + "shape": "S7m" + } + }, + "Seh": { + "type": "structure", + "members": { + "CloudWatchLogGroupName": {}, + "CloudWatchOutputEnabled": { + "type": "boolean" + } + } + }, + "Sf2": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Values" + ], + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + }, + "Type": {} + } + } + }, + "Sf8": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Expression": {}, + "Aggregators": { + "shape": "Sf8" + }, + "Groups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Filters" + ], + "members": { + "Name": {}, + "Filters": { + "shape": "Sf2" + } + } + } + } + } + } + }, + "Sfp": { + "type": "list", + "member": { + "type": "map", + "key": {}, + "value": {} + } + }, + "Sgg": { + "type": "structure", + "members": { + "RunCommand": { + "type": "structure", + "members": { + "Comment": {}, + "DocumentHash": {}, + "DocumentHashType": {}, + "NotificationConfig": { + "shape": "Sgi" + }, + "OutputS3BucketName": {}, + "OutputS3KeyPrefix": {}, + "Parameters": { + "shape": "St" + }, + "ServiceRoleArn": {}, + "TimeoutSeconds": { + "type": "integer" + } + } + }, + "Automation": { + "type": "structure", + "members": { + "DocumentVersion": {}, + "Parameters": { + "shape": "S6t" + } + } + }, + "StepFunctions": { + "type": "structure", + "members": { + "Input": { + "type": "string", + "sensitive": true + }, + "Name": {} + } + }, + "Lambda": { + "type": "structure", + "members": { + "ClientContext": {}, + "Qualifier": {}, + "Payload": { + "type": "blob", + "sensitive": true + } + } + } + } + }, + "Sgi": { + "type": "structure", + "members": { + "NotificationArn": {}, + "NotificationEvents": { + "type": "list", + "member": {} + }, + "NotificationType": {} + } + }, + "Sgy": { + "type": "structure", + "members": { + "Name": {}, + "Type": {}, + "Value": {}, + "Version": { + "type": "long" + }, + "Selector": {}, + "SourceResult": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "ARN": {} + } + }, + "Sh5": { + "type": "list", + "member": {} + }, + "Sh9": { + "type": "list", + "member": { + "shape": "Sgy" + } + }, + "Shl": { + "type": "structure", + "members": { + "SettingId": {}, + "SettingValue": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "LastModifiedUser": {}, + "ARN": {}, + "Status": {} + } + }, + "Si3": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": {} + } + } + }, + "Sij": { + "type": "structure", + "members": { + "CommandId": {}, + "DocumentName": {}, + "DocumentVersion": {}, + "Comment": {}, + "ExpiresAfter": { + "type": "timestamp" + }, + "Parameters": { + "shape": "St" + }, + "InstanceIds": { + "shape": "Sb" + }, + "Targets": { + "shape": "Sx" + }, + "RequestedDateTime": { + "type": "timestamp" + }, + "Status": {}, + "StatusDetails": {}, + "OutputS3Region": {}, + "OutputS3BucketName": {}, + "OutputS3KeyPrefix": {}, + "MaxConcurrency": {}, + "MaxErrors": {}, + "TargetCount": { + "type": "integer" + }, + "CompletedCount": { + "type": "integer" + }, + "ErrorCount": { + "type": "integer" + }, + "DeliveryTimedOutCount": { + "type": "integer" + }, + "ServiceRole": {}, + "NotificationConfig": { + "shape": "Sgi" + }, + "CloudWatchOutputConfig": { + "shape": "Seh" + } + } + }, + "Siq": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Values": { + "type": "list", + "member": {} + }, + "Type": {} + } + } + }, + "Sj8": { + "type": "structure", + "required": [ + "ExecutionTime" + ], + "members": { + "ExecutionTime": { + "type": "timestamp" + }, + "ExecutionId": {}, + "ExecutionType": {} + } + }, + "Sjb": { + "type": "map", + "key": {}, + "value": {} + }, + "Sjg": { + "type": "structure", + "members": { + "CompliantCount": { + "type": "integer" + }, + "SeveritySummary": { + "shape": "Sji" + } + } + }, + "Sji": { + "type": "structure", + "members": { + "CriticalCount": { + "type": "integer" + }, + "HighCount": { + "type": "integer" + }, + "MediumCount": { + "type": "integer" + }, + "LowCount": { + "type": "integer" + }, + "InformationalCount": { + "type": "integer" + }, + "UnspecifiedCount": { + "type": "integer" + } + } + }, + "Sjj": { + "type": "structure", + "members": { + "NonCompliantCount": { + "type": "integer" + }, + "SeveritySummary": { + "shape": "Sji" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/ssm-2014-11-06.paginators.json b/node_modules/aws-sdk/apis/ssm-2014-11-06.paginators.json new file mode 100644 index 0000000..dedcc0b --- /dev/null +++ b/node_modules/aws-sdk/apis/ssm-2014-11-06.paginators.json @@ -0,0 +1,55 @@ +{ + "pagination": { + "DescribeActivations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ActivationList" + }, + "DescribeInstanceInformation": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InstanceInformationList" + }, + "DescribeParameters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetParameterHistory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "GetParametersByPath": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Associations" + }, + "ListCommandInvocations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CommandInvocations" + }, + "ListCommands": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Commands" + }, + "ListDocuments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DocumentIdentifiers" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/states-2016-11-23.examples.json b/node_modules/aws-sdk/apis/states-2016-11-23.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/states-2016-11-23.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/states-2016-11-23.min.json b/node_modules/aws-sdk/apis/states-2016-11-23.min.json new file mode 100644 index 0000000..a1afb12 --- /dev/null +++ b/node_modules/aws-sdk/apis/states-2016-11-23.min.json @@ -0,0 +1,996 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-23", + "endpointPrefix": "states", + "jsonVersion": "1.0", + "protocol": "json", + "serviceAbbreviation": "AWS SFN", + "serviceFullName": "AWS Step Functions", + "serviceId": "SFN", + "signatureVersion": "v4", + "targetPrefix": "AWSStepFunctions", + "uid": "states-2016-11-23" + }, + "operations": { + "CreateActivity": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "activityArn", + "creationDate" + ], + "members": { + "activityArn": {}, + "creationDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "CreateStateMachine": { + "input": { + "type": "structure", + "required": [ + "name", + "definition", + "roleArn" + ], + "members": { + "name": {}, + "definition": { + "shape": "Sb" + }, + "roleArn": {}, + "tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "required": [ + "stateMachineArn", + "creationDate" + ], + "members": { + "stateMachineArn": {}, + "creationDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DeleteActivity": { + "input": { + "type": "structure", + "required": [ + "activityArn" + ], + "members": { + "activityArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteStateMachine": { + "input": { + "type": "structure", + "required": [ + "stateMachineArn" + ], + "members": { + "stateMachineArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeActivity": { + "input": { + "type": "structure", + "required": [ + "activityArn" + ], + "members": { + "activityArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "activityArn", + "name", + "creationDate" + ], + "members": { + "activityArn": {}, + "name": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "DescribeExecution": { + "input": { + "type": "structure", + "required": [ + "executionArn" + ], + "members": { + "executionArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "executionArn", + "stateMachineArn", + "status", + "startDate", + "input" + ], + "members": { + "executionArn": {}, + "stateMachineArn": {}, + "name": {}, + "status": {}, + "startDate": { + "type": "timestamp" + }, + "stopDate": { + "type": "timestamp" + }, + "input": { + "shape": "Sm" + }, + "output": { + "shape": "Sm" + } + } + } + }, + "DescribeStateMachine": { + "input": { + "type": "structure", + "required": [ + "stateMachineArn" + ], + "members": { + "stateMachineArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "stateMachineArn", + "name", + "definition", + "roleArn", + "creationDate" + ], + "members": { + "stateMachineArn": {}, + "name": {}, + "status": {}, + "definition": { + "shape": "Sb" + }, + "roleArn": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "DescribeStateMachineForExecution": { + "input": { + "type": "structure", + "required": [ + "executionArn" + ], + "members": { + "executionArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "stateMachineArn", + "name", + "definition", + "roleArn", + "updateDate" + ], + "members": { + "stateMachineArn": {}, + "name": {}, + "definition": { + "shape": "Sb" + }, + "roleArn": {}, + "updateDate": { + "type": "timestamp" + } + } + } + }, + "GetActivityTask": { + "input": { + "type": "structure", + "required": [ + "activityArn" + ], + "members": { + "activityArn": {}, + "workerName": {} + } + }, + "output": { + "type": "structure", + "members": { + "taskToken": {}, + "input": { + "type": "string", + "sensitive": true + } + } + } + }, + "GetExecutionHistory": { + "input": { + "type": "structure", + "required": [ + "executionArn" + ], + "members": { + "executionArn": {}, + "maxResults": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "events" + ], + "members": { + "events": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "timestamp", + "type", + "id" + ], + "members": { + "timestamp": { + "type": "timestamp" + }, + "type": {}, + "id": { + "type": "long" + }, + "previousEventId": { + "type": "long" + }, + "activityFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "activityScheduleFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "activityScheduledEventDetails": { + "type": "structure", + "required": [ + "resource" + ], + "members": { + "resource": {}, + "input": { + "shape": "Sm" + }, + "timeoutInSeconds": { + "type": "long" + }, + "heartbeatInSeconds": { + "type": "long" + } + } + }, + "activityStartedEventDetails": { + "type": "structure", + "members": { + "workerName": {} + } + }, + "activitySucceededEventDetails": { + "type": "structure", + "members": { + "output": { + "shape": "Sm" + } + } + }, + "activityTimedOutEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "taskFailedEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource" + ], + "members": { + "resourceType": {}, + "resource": {}, + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "taskScheduledEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource", + "region", + "parameters" + ], + "members": { + "resourceType": {}, + "resource": {}, + "region": {}, + "parameters": { + "type": "string", + "sensitive": true + }, + "timeoutInSeconds": { + "type": "long" + } + } + }, + "taskStartFailedEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource" + ], + "members": { + "resourceType": {}, + "resource": {}, + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "taskStartedEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource" + ], + "members": { + "resourceType": {}, + "resource": {} + } + }, + "taskSubmitFailedEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource" + ], + "members": { + "resourceType": {}, + "resource": {}, + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "taskSubmittedEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource" + ], + "members": { + "resourceType": {}, + "resource": {}, + "output": { + "shape": "Sm" + } + } + }, + "taskSucceededEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource" + ], + "members": { + "resourceType": {}, + "resource": {}, + "output": { + "shape": "Sm" + } + } + }, + "taskTimedOutEventDetails": { + "type": "structure", + "required": [ + "resourceType", + "resource" + ], + "members": { + "resourceType": {}, + "resource": {}, + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "executionFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "executionStartedEventDetails": { + "type": "structure", + "members": { + "input": { + "shape": "Sm" + }, + "roleArn": {} + } + }, + "executionSucceededEventDetails": { + "type": "structure", + "members": { + "output": { + "shape": "Sm" + } + } + }, + "executionAbortedEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "executionTimedOutEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "lambdaFunctionFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "lambdaFunctionScheduleFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "lambdaFunctionScheduledEventDetails": { + "type": "structure", + "required": [ + "resource" + ], + "members": { + "resource": {}, + "input": { + "shape": "Sm" + }, + "timeoutInSeconds": { + "type": "long" + } + } + }, + "lambdaFunctionStartFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "lambdaFunctionSucceededEventDetails": { + "type": "structure", + "members": { + "output": { + "shape": "Sm" + } + } + }, + "lambdaFunctionTimedOutEventDetails": { + "type": "structure", + "members": { + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "stateEnteredEventDetails": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "input": { + "shape": "Sm" + } + } + }, + "stateExitedEventDetails": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "output": { + "shape": "Sm" + } + } + } + } + } + }, + "nextToken": {} + } + } + }, + "ListActivities": { + "input": { + "type": "structure", + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "activities" + ], + "members": { + "activities": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "activityArn", + "name", + "creationDate" + ], + "members": { + "activityArn": {}, + "name": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListExecutions": { + "input": { + "type": "structure", + "required": [ + "stateMachineArn" + ], + "members": { + "stateMachineArn": {}, + "statusFilter": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "executions" + ], + "members": { + "executions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "executionArn", + "stateMachineArn", + "name", + "status", + "startDate" + ], + "members": { + "executionArn": {}, + "stateMachineArn": {}, + "name": {}, + "status": {}, + "startDate": { + "type": "timestamp" + }, + "stopDate": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListStateMachines": { + "input": { + "type": "structure", + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "stateMachines" + ], + "members": { + "stateMachines": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "stateMachineArn", + "name", + "creationDate" + ], + "members": { + "stateMachineArn": {}, + "name": {}, + "creationDate": { + "type": "timestamp" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "tags": { + "shape": "S3" + } + } + } + }, + "SendTaskFailure": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SendTaskHeartbeat": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SendTaskSuccess": { + "input": { + "type": "structure", + "required": [ + "taskToken", + "output" + ], + "members": { + "taskToken": {}, + "output": { + "shape": "Sm" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartExecution": { + "input": { + "type": "structure", + "required": [ + "stateMachineArn" + ], + "members": { + "stateMachineArn": {}, + "name": {}, + "input": { + "shape": "Sm" + } + } + }, + "output": { + "type": "structure", + "required": [ + "executionArn", + "startDate" + ], + "members": { + "executionArn": {}, + "startDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "StopExecution": { + "input": { + "type": "structure", + "required": [ + "executionArn" + ], + "members": { + "executionArn": {}, + "error": { + "shape": "S16" + }, + "cause": { + "shape": "S17" + } + } + }, + "output": { + "type": "structure", + "required": [ + "stopDate" + ], + "members": { + "stopDate": { + "type": "timestamp" + } + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": {}, + "tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": {}, + "tagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateStateMachine": { + "input": { + "type": "structure", + "required": [ + "stateMachineArn" + ], + "members": { + "stateMachineArn": {}, + "definition": { + "shape": "Sb" + }, + "roleArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "updateDate" + ], + "members": { + "updateDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + } + }, + "shapes": { + "S3": { + "type": "list", + "member": { + "type": "structure", + "members": { + "key": {}, + "value": {} + } + } + }, + "Sb": { + "type": "string", + "sensitive": true + }, + "Sm": { + "type": "string", + "sensitive": true + }, + "S16": { + "type": "string", + "sensitive": true + }, + "S17": { + "type": "string", + "sensitive": true + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/states-2016-11-23.paginators.json b/node_modules/aws-sdk/apis/states-2016-11-23.paginators.json new file mode 100644 index 0000000..d7f0580 --- /dev/null +++ b/node_modules/aws-sdk/apis/states-2016-11-23.paginators.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "GetExecutionHistory": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "events" + }, + "ListActivities": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "activities" + }, + "ListExecutions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "executions" + }, + "ListStateMachines": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "stateMachines" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/storagegateway-2013-06-30.examples.json b/node_modules/aws-sdk/apis/storagegateway-2013-06-30.examples.json new file mode 100644 index 0000000..7cc0d7d --- /dev/null +++ b/node_modules/aws-sdk/apis/storagegateway-2013-06-30.examples.json @@ -0,0 +1,1381 @@ +{ + "version": "1.0", + "examples": { + "ActivateGateway": [ + { + "input": { + "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V", + "GatewayName": "My_Gateway", + "GatewayRegion": "us-east-1", + "GatewayTimezone": "GMT-12:00", + "GatewayType": "STORED", + "MediumChangerType": "AWS-Gateway-VTL", + "TapeDriveType": "IBM-ULT3580-TD5" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Activates the gateway you previously deployed on your host.", + "id": "to-activate-the-gateway-1471281611207", + "title": "To activate the gateway" + } + ], + "AddCache": [ + { + "input": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows a request that activates a gateway-stored volume.", + "id": "to-add-a-cache-1471043606854", + "title": "To add a cache" + } + ], + "AddTagsToResource": [ + { + "input": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", + "Tags": [ + { + "Key": "Dev Gatgeway Region", + "Value": "East Coast" + } + ] + }, + "output": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Adds one or more tags to the specified resource.", + "id": "to-add-tags-to-resource-1471283689460", + "title": "To add tags to resource" + } + ], + "AddUploadBuffer": [ + { + "input": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Configures one or more gateway local disks as upload buffer for a specified gateway.", + "id": "to-add-upload-buffer-on-local-disk-1471293902847", + "title": "To add upload buffer on local disk" + } + ], + "AddWorkingStorage": [ + { + "input": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)", + "id": "to-add-storage-on-local-disk-1471294305401", + "title": "To add storage on local disk" + } + ], + "CancelArchival": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.", + "id": "to-cancel-virtual-tape-archiving-1471294865203", + "title": "To cancel virtual tape archiving" + } + ], + "CancelRetrieval": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.", + "id": "to-cancel-virtual-tape-retrieval-1471295704491", + "title": "To cancel virtual tape retrieval" + } + ], + "CreateCachediSCSIVolume": [ + { + "input": { + "ClientToken": "cachedvol112233", + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "NetworkInterfaceId": "10.1.1.1", + "SnapshotId": "snap-f47b7b94", + "TargetName": "my-volume", + "VolumeSizeInBytes": 536870912000 + }, + "output": { + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a cached volume on a specified cached gateway.", + "id": "to-create-a-cached-iscsi-volume-1471296661787", + "title": "To create a cached iSCSI volume" + } + ], + "CreateSnapshot": [ + { + "input": { + "SnapshotDescription": "My root volume snapshot as of 10/03/2017", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "SnapshotId": "snap-78e22663", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Initiates an ad-hoc snapshot of a gateway volume.", + "id": "to-create-a-snapshot-of-a-gateway-volume-1471301469561", + "title": "To create a snapshot of a gateway volume" + } + ], + "CreateSnapshotFromVolumeRecoveryPoint": [ + { + "input": { + "SnapshotDescription": "My root volume snapshot as of 2017-06-30T10:10:10.000Z", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "SnapshotId": "snap-78e22663", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeRecoveryPointTime": "2017-06-30T10:10:10.000Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Initiates a snapshot of a gateway from a volume recovery point.", + "id": "to-create-a-snapshot-of-a-gateway-volume-1471301469561", + "title": "To create a snapshot of a gateway volume" + } + ], + "CreateStorediSCSIVolume": [ + { + "input": { + "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "NetworkInterfaceId": "10.1.1.1", + "PreserveExistingData": true, + "SnapshotId": "snap-f47b7b94", + "TargetName": "my-volume" + }, + "output": { + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeSizeInBytes": 1099511627776 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a stored volume on a specified stored gateway.", + "id": "to-create-a-stored-iscsi-volume-1471367662813", + "title": "To create a stored iSCSI volume" + } + ], + "CreateTapeWithBarcode": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "TapeBarcode": "TEST12345", + "TapeSizeInBytes": 107374182400 + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a virtual tape by using your own barcode.", + "id": "to-create-a-virtual-tape-using-a-barcode-1471371842452", + "title": "To create a virtual tape using a barcode" + } + ], + "CreateTapes": [ + { + "input": { + "ClientToken": "77777", + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "NumTapesToCreate": 3, + "TapeBarcodePrefix": "TEST", + "TapeSizeInBytes": 107374182400 + }, + "output": { + "TapeARNs": [ + "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D", + "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F", + "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates one or more virtual tapes.", + "id": "to-create-a-virtual-tape-1471372061659", + "title": "To create a virtual tape" + } + ], + "DeleteBandwidthRateLimit": [ + { + "input": { + "BandwidthType": "All", + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.", + "id": "to-delete-bandwidth-rate-limits-of-gateway-1471373225520", + "title": "To delete bandwidth rate limits of gateway" + } + ], + "DeleteChapCredentials": [ + { + "input": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "output": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.", + "id": "to-delete-chap-credentials-1471375025612", + "title": "To delete CHAP credentials" + } + ], + "DeleteGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes the gateway, but not the gateway's VM from the host computer.", + "id": "to-delete-a-gatgeway-1471381697333", + "title": "To delete a gatgeway" + } + ], + "DeleteSnapshotSchedule": [ + { + "input": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This action enables you to delete a snapshot schedule for a volume.", + "id": "to-delete-a-snapshot-of-a-volume-1471382234377", + "title": "To delete a snapshot of a volume" + } + ], + "DeleteTape": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified virtual tape.", + "id": "to-delete-a-virtual-tape-1471382444157", + "title": "To delete a virtual tape" + } + ], + "DeleteTapeArchive": [ + { + "input": { + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified virtual tape from the virtual tape shelf (VTS).", + "id": "to-delete-a-virtual-tape-from-the-shelf-vts-1471383964329", + "title": "To delete a virtual tape from the shelf (VTS)" + } + ], + "DeleteVolume": [ + { + "input": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.", + "id": "to-delete-a-gateway-volume-1471384418416", + "title": "To delete a gateway volume" + } + ], + "DescribeBandwidthRateLimit": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "AverageDownloadRateLimitInBitsPerSec": 204800, + "AverageUploadRateLimitInBitsPerSec": 102400, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.", + "id": "to-describe-the-bandwidth-rate-limits-of-a-gateway-1471384826404", + "title": "To describe the bandwidth rate limits of a gateway" + } + ], + "DescribeCache": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "CacheAllocatedInBytes": 2199023255552, + "CacheDirtyPercentage": 0.07, + "CacheHitPercentage": 99.68, + "CacheMissPercentage": 0.32, + "CacheUsedPercentage": 0.07, + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:04:00.0-scsi-0:1:0:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the cache of a gateway.", + "id": "to-describe-cache-information-1471385756036", + "title": "To describe cache information" + } + ], + "DescribeCachediSCSIVolumes": [ + { + "input": { + "VolumeARNs": [ + "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + ] + }, + "output": { + "CachediSCSIVolumes": [ + { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeId": "vol-1122AABB", + "VolumeSizeInBytes": 1099511627776, + "VolumeStatus": "AVAILABLE", + "VolumeType": "CACHED iSCSI", + "VolumeiSCSIAttributes": { + "ChapEnabled": true, + "LunNumber": 1, + "NetworkInterfaceId": "10.243.43.207", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of the gateway cached iSCSI volumes specified in the request.", + "id": "to-describe-gateway-cached-iscsi-volumes-1471458094649", + "title": "To describe gateway cached iSCSI volumes" + } + ], + "DescribeChapCredentials": [ + { + "input": { + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "output": { + "ChapCredentials": [ + { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "SecretToAuthenticateInitiator": "111111111111", + "SecretToAuthenticateTarget": "222222222222", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.", + "id": "to-describe-chap-credetnitals-for-an-iscsi-1471467462967", + "title": "To describe CHAP credetnitals for an iSCSI" + } + ], + "DescribeGatewayInformation": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayId": "sgw-AABB1122", + "GatewayName": "My_Gateway", + "GatewayNetworkInterfaces": [ + { + "Ipv4Address": "10.35.69.216" + } + ], + "GatewayState": "STATE_RUNNING", + "GatewayTimezone": "GMT-8:00", + "GatewayType": "STORED", + "LastSoftwareUpdate": "2016-01-02T16:00:00", + "NextUpdateAvailabilityDate": "2017-01-02T16:00:00" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).", + "id": "to-describe-metadata-about-the-gateway-1471467849079", + "title": "To describe metadata about the gateway" + } + ], + "DescribeMaintenanceStartTime": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DayOfWeek": 2, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "HourOfDay": 15, + "MinuteOfHour": 35, + "Timezone": "GMT+7:00" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns your gateway's weekly maintenance start time including the day and time of the week.", + "id": "to-describe-gateways-maintenance-start-time-1471470727387", + "title": "To describe gateway's maintenance start time" + } + ], + "DescribeSnapshotSchedule": [ + { + "input": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "Description": "sgw-AABB1122:vol-AABB1122:Schedule", + "RecurrenceInHours": 24, + "StartAt": 6, + "Timezone": "GMT+7:00", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.", + "id": "to-describe-snapshot-schedule-for-gateway-volume-1471471139538", + "title": "To describe snapshot schedule for gateway volume" + } + ], + "DescribeStorediSCSIVolumes": [ + { + "input": { + "VolumeARNs": [ + "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + ] + }, + "output": { + "StorediSCSIVolumes": [ + { + "PreservedExistingData": false, + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0", + "VolumeId": "vol-1122AABB", + "VolumeProgress": 23.7, + "VolumeSizeInBytes": 1099511627776, + "VolumeStatus": "BOOTSTRAPPING", + "VolumeiSCSIAttributes": { + "ChapEnabled": true, + "NetworkInterfaceId": "10.243.43.207", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the description of the gateway volumes specified in the request belonging to the same gateway.", + "id": "to-describe-the-volumes-of-a-gateway-1471472640660", + "title": "To describe the volumes of a gateway" + } + ], + "DescribeTapeArchives": [ + { + "input": { + "Limit": 123, + "Marker": "1", + "TapeARNs": [ + "arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD", + "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + ] + }, + "output": { + "Marker": "1", + "TapeArchives": [ + { + "CompletionTime": "2016-12-16T13:50Z", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD", + "TapeBarcode": "AM08A1AD", + "TapeSizeInBytes": 107374182400, + "TapeStatus": "ARCHIVED" + }, + { + "CompletionTime": "2016-12-16T13:59Z", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4", + "TapeBarcode": "AMZN01A2A4", + "TapeSizeInBytes": 429496729600, + "TapeStatus": "ARCHIVED" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of specified virtual tapes in the virtual tape shelf (VTS).", + "id": "to-describe-virtual-tapes-in-the-vts-1471473188198", + "title": "To describe virtual tapes in the VTS" + } + ], + "DescribeTapeRecoveryPoints": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Limit": 1, + "Marker": "1" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Marker": "1", + "TapeRecoveryPointInfos": [ + { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4", + "TapeRecoveryPointTime": "2016-12-16T13:50Z", + "TapeSizeInBytes": 1471550497, + "TapeStatus": "AVAILABLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.", + "id": "to-describe-virtual-tape-recovery-points-1471542042026", + "title": "To describe virtual tape recovery points" + } + ], + "DescribeTapes": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "Limit": 2, + "Marker": "1", + "TapeARNs": [ + "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1", + "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0" + ] + }, + "output": { + "Marker": "1", + "Tapes": [ + { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1", + "TapeBarcode": "TEST04A2A1", + "TapeSizeInBytes": 107374182400, + "TapeStatus": "AVAILABLE" + }, + { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0", + "TapeBarcode": "TEST05A2A0", + "TapeSizeInBytes": 107374182400, + "TapeStatus": "AVAILABLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes.", + "id": "to-describe-virtual-tapes-associated-with-gateway-1471629287727", + "title": "To describe virtual tape(s) associated with gateway" + } + ], + "DescribeUploadBuffer": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:04:00.0-scsi-0:1:0:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "UploadBufferAllocatedInBytes": 0, + "UploadBufferUsedInBytes": 161061273600 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.", + "id": "to-describe-upload-buffer-of-gateway-1471631099003", + "title": "To describe upload buffer of gateway" + }, + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:04:00.0-scsi-0:1:0:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "UploadBufferAllocatedInBytes": 161061273600, + "UploadBufferUsedInBytes": 0 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.", + "id": "to-describe-upload-buffer-of-a-gateway--1471904566370", + "title": "To describe upload buffer of a gateway" + } + ], + "DescribeVTLDevices": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "Limit": 123, + "Marker": "1", + "VTLDeviceARNs": [ + + ] + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "Marker": "1", + "VTLDevices": [ + { + "DeviceiSCSIAttributes": { + "ChapEnabled": false, + "NetworkInterfaceId": "10.243.43.207", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger" + }, + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001", + "VTLDeviceProductIdentifier": "L700", + "VTLDeviceType": "Medium Changer", + "VTLDeviceVendor": "STK" + }, + { + "DeviceiSCSIAttributes": { + "ChapEnabled": false, + "NetworkInterfaceId": "10.243.43.209", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01" + }, + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001", + "VTLDeviceProductIdentifier": "ULT3580-TD5", + "VTLDeviceType": "Tape Drive", + "VTLDeviceVendor": "IBM" + }, + { + "DeviceiSCSIAttributes": { + "ChapEnabled": false, + "NetworkInterfaceId": "10.243.43.209", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02" + }, + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002", + "VTLDeviceProductIdentifier": "ULT3580-TD5", + "VTLDeviceType": "Tape Drive", + "VTLDeviceVendor": "IBM" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of virtual tape library (VTL) devices for the specified gateway.", + "id": "to-describe-virtual-tape-library-vtl-devices-of-a-single-gateway-1471906071410", + "title": "To describe virtual tape library (VTL) devices of a single gateway" + } + ], + "DescribeWorkingStorage": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "WorkingStorageAllocatedInBytes": 2199023255552, + "WorkingStorageUsedInBytes": 789207040 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.", + "id": "to-describe-the-working-storage-of-a-gateway-depreciated-1472070842332", + "title": "To describe the working storage of a gateway [Depreciated]" + } + ], + "DisableGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.", + "id": "to-disable-a-gateway-when-it-is-no-longer-functioning-1472076046936", + "title": "To disable a gateway when it is no longer functioning" + } + ], + "ListGateways": [ + { + "input": { + "Limit": 2, + "Marker": "1" + }, + "output": { + "Gateways": [ + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C" + } + ], + "Marker": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.", + "id": "to-lists-region-specific-gateways-per-aws-account-1472077860657", + "title": "To lists region specific gateways per AWS account" + } + ], + "ListLocalDisks": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "Disks": [ + { + "DiskAllocationType": "CACHE_STORAGE", + "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", + "DiskNode": "SCSI(0:0)", + "DiskPath": "/dev/sda", + "DiskSizeInBytes": 1099511627776, + "DiskStatus": "missing" + }, + { + "DiskAllocationResource": "", + "DiskAllocationType": "UPLOAD_BUFFER", + "DiskId": "pci-0000:03:00.0-scsi-0:0:1:0", + "DiskNode": "SCSI(0:1)", + "DiskPath": "/dev/sdb", + "DiskSizeInBytes": 1099511627776, + "DiskStatus": "present" + } + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all.", + "id": "to-list-the-gateways-local-disks-1472079564618", + "title": "To list the gateway's local disks" + } + ], + "ListTagsForResource": [ + { + "input": { + "Limit": 1, + "Marker": "1", + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "output": { + "Marker": "1", + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", + "Tags": [ + { + "Key": "Dev Gatgeway Region", + "Value": "East Coast" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the tags that have been added to the specified resource.", + "id": "to-list-tags-that-have-been-added-to-a-resource-1472080268972", + "title": "To list tags that have been added to a resource" + } + ], + "ListVolumeRecoveryPoints": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "VolumeRecoveryPointInfos": [ + { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeRecoveryPointTime": "2012-09-04T21:08:44.627Z", + "VolumeSizeInBytes": 536870912000 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.", + "id": "to-list-recovery-points-for-a-gateway-1472143015088", + "title": "To list recovery points for a gateway" + } + ], + "ListVolumes": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Limit": 2, + "Marker": "1" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Marker": "1", + "VolumeInfos": [ + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayId": "sgw-12A3456B", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeId": "vol-1122AABB", + "VolumeSizeInBytes": 107374182400, + "VolumeType": "STORED" + }, + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C", + "GatewayId": "sgw-gw-13B4567C", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD", + "VolumeId": "vol-1122AABB", + "VolumeSizeInBytes": 107374182400, + "VolumeType": "STORED" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.", + "id": "to-list-the-iscsi-stored-volumes-of-a-gateway-1472145723653", + "title": "To list the iSCSI stored volumes of a gateway" + } + ], + "RemoveTagsFromResource": [ + { + "input": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", + "TagKeys": [ + "Dev Gatgeway Region", + "East Coast" + ] + }, + "output": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.", + "id": "to-remove-tags-from-a-resource-1472147210553", + "title": "To remove tags from a resource" + } + ], + "ResetCache": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.", + "id": "to-reset-cache-disks-in-error-status-1472148909807", + "title": "To reset cache disks in error status" + } + ], + "RetrieveTapeArchive": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway.", + "id": "to-retrieve-an-archived-tape-from-the-vts-1472149812358", + "title": "To retrieve an archived tape from the VTS" + } + ], + "RetrieveTapeRecoveryPoint": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Retrieves the recovery point for the specified virtual tape.", + "id": "to-retrieve-the-recovery-point-of-a-virtual-tape-1472150014805", + "title": "To retrieve the recovery point of a virtual tape" + } + ], + "SetLocalConsolePassword": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "LocalConsolePassword": "PassWordMustBeAtLeast6Chars." + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Sets the password for your VM local console.", + "id": "to-set-a-password-for-your-vm-1472150202632", + "title": "To set a password for your VM" + } + ], + "ShutdownGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.", + "id": "to-shut-down-a-gateway-service-1472150508835", + "title": "To shut down a gateway service" + } + ], + "StartGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Starts a gateway service that was previously shut down.", + "id": "to-start-a-gateway-service-1472150722315", + "title": "To start a gateway service" + } + ], + "UpdateBandwidthRateLimit": [ + { + "input": { + "AverageDownloadRateLimitInBitsPerSec": 102400, + "AverageUploadRateLimitInBitsPerSec": 51200, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.", + "id": "to-update-the-bandwidth-rate-limits-of-a-gateway-1472151016202", + "title": "To update the bandwidth rate limits of a gateway" + } + ], + "UpdateChapCredentials": [ + { + "input": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "SecretToAuthenticateInitiator": "111111111111", + "SecretToAuthenticateTarget": "222222222222", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "output": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.", + "id": "to-update-chap-credentials-for-an-iscsi-target-1472151325795", + "title": "To update CHAP credentials for an iSCSI target" + } + ], + "UpdateGatewayInformation": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayName": "MyGateway2", + "GatewayTimezone": "GMT-12:00" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayName": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates a gateway's metadata, which includes the gateway's name and time zone.", + "id": "to-update-a-gateways-metadata-1472151688693", + "title": "To update a gateway's metadata" + } + ], + "UpdateGatewaySoftwareNow": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.", + "id": "to-update-a-gateways-vm-software-1472152020929", + "title": "To update a gateway's VM software" + } + ], + "UpdateMaintenanceStartTime": [ + { + "input": { + "DayOfWeek": 2, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "HourOfDay": 0, + "MinuteOfHour": 30 + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone.", + "id": "to-update-a-gateways-maintenance-start-time-1472152552031", + "title": "To update a gateway's maintenance start time" + } + ], + "UpdateSnapshotSchedule": [ + { + "input": { + "Description": "Hourly snapshot", + "RecurrenceInHours": 1, + "StartAt": 0, + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates a snapshot schedule configured for a gateway volume.", + "id": "to-update-a-volume-snapshot-schedule-1472152757068", + "title": "To update a volume snapshot schedule" + } + ], + "UpdateVTLDeviceType": [ + { + "input": { + "DeviceType": "Medium Changer", + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001" + }, + "output": { + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.", + "id": "to-update-a-vtl-device-type-1472153012967", + "title": "To update a VTL device type" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/storagegateway-2013-06-30.min.json b/node_modules/aws-sdk/apis/storagegateway-2013-06-30.min.json new file mode 100644 index 0000000..4e37d8c --- /dev/null +++ b/node_modules/aws-sdk/apis/storagegateway-2013-06-30.min.json @@ -0,0 +1,2118 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2013-06-30", + "endpointPrefix": "storagegateway", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Storage Gateway", + "serviceId": "Storage Gateway", + "signatureVersion": "v4", + "targetPrefix": "StorageGateway_20130630", + "uid": "storagegateway-2013-06-30" + }, + "operations": { + "ActivateGateway": { + "input": { + "type": "structure", + "required": [ + "ActivationKey", + "GatewayName", + "GatewayTimezone", + "GatewayRegion" + ], + "members": { + "ActivationKey": {}, + "GatewayName": {}, + "GatewayTimezone": {}, + "GatewayRegion": {}, + "GatewayType": {}, + "TapeDriveType": {}, + "MediumChangerType": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "AddCache": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskIds" + ], + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "Tags" + ], + "members": { + "ResourceARN": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceARN": {} + } + } + }, + "AddUploadBuffer": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskIds" + ], + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "AddWorkingStorage": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskIds" + ], + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sg" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "AttachVolume": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "VolumeARN", + "NetworkInterfaceId" + ], + "members": { + "GatewayARN": {}, + "TargetName": {}, + "VolumeARN": {}, + "NetworkInterfaceId": {}, + "DiskId": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "TargetARN": {} + } + } + }, + "CancelArchival": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeARN" + ], + "members": { + "GatewayARN": {}, + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "CancelRetrieval": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeARN" + ], + "members": { + "GatewayARN": {}, + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "CreateCachediSCSIVolume": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "VolumeSizeInBytes", + "TargetName", + "NetworkInterfaceId", + "ClientToken" + ], + "members": { + "GatewayARN": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "SnapshotId": {}, + "TargetName": {}, + "SourceVolumeARN": {}, + "NetworkInterfaceId": {}, + "ClientToken": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "TargetARN": {} + } + } + }, + "CreateNFSFileShare": { + "input": { + "type": "structure", + "required": [ + "ClientToken", + "GatewayARN", + "Role", + "LocationARN" + ], + "members": { + "ClientToken": {}, + "NFSFileShareDefaults": { + "shape": "S19" + }, + "GatewayARN": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "Role": {}, + "LocationARN": {}, + "DefaultStorageClass": {}, + "ObjectACL": {}, + "ClientList": { + "shape": "S1g" + }, + "Squash": {}, + "ReadOnly": { + "type": "boolean" + }, + "GuessMIMETypeEnabled": { + "type": "boolean" + }, + "RequesterPays": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "FileShareARN": {} + } + } + }, + "CreateSMBFileShare": { + "input": { + "type": "structure", + "required": [ + "ClientToken", + "GatewayARN", + "Role", + "LocationARN" + ], + "members": { + "ClientToken": {}, + "GatewayARN": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "Role": {}, + "LocationARN": {}, + "DefaultStorageClass": {}, + "ObjectACL": {}, + "ReadOnly": { + "type": "boolean" + }, + "GuessMIMETypeEnabled": { + "type": "boolean" + }, + "RequesterPays": { + "type": "boolean" + }, + "SMBACLEnabled": { + "type": "boolean" + }, + "AdminUserList": { + "shape": "S1m" + }, + "ValidUserList": { + "shape": "S1m" + }, + "InvalidUserList": { + "shape": "S1m" + }, + "Authentication": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "FileShareARN": {} + } + } + }, + "CreateSnapshot": { + "input": { + "type": "structure", + "required": [ + "VolumeARN", + "SnapshotDescription" + ], + "members": { + "VolumeARN": {}, + "SnapshotDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "SnapshotId": {} + } + } + }, + "CreateSnapshotFromVolumeRecoveryPoint": { + "input": { + "type": "structure", + "required": [ + "VolumeARN", + "SnapshotDescription" + ], + "members": { + "VolumeARN": {}, + "SnapshotDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotId": {}, + "VolumeARN": {}, + "VolumeRecoveryPointTime": {} + } + } + }, + "CreateStorediSCSIVolume": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskId", + "PreserveExistingData", + "TargetName", + "NetworkInterfaceId" + ], + "members": { + "GatewayARN": {}, + "DiskId": {}, + "SnapshotId": {}, + "PreserveExistingData": { + "type": "boolean" + }, + "TargetName": {}, + "NetworkInterfaceId": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "TargetARN": {} + } + } + }, + "CreateTapeWithBarcode": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeSizeInBytes", + "TapeBarcode" + ], + "members": { + "GatewayARN": {}, + "TapeSizeInBytes": { + "type": "long" + }, + "TapeBarcode": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "PoolId": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "CreateTapes": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeSizeInBytes", + "ClientToken", + "NumTapesToCreate", + "TapeBarcodePrefix" + ], + "members": { + "GatewayARN": {}, + "TapeSizeInBytes": { + "type": "long" + }, + "ClientToken": {}, + "NumTapesToCreate": { + "type": "integer" + }, + "TapeBarcodePrefix": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "PoolId": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "members": { + "TapeARNs": { + "shape": "S28" + } + } + } + }, + "DeleteBandwidthRateLimit": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "BandwidthType" + ], + "members": { + "GatewayARN": {}, + "BandwidthType": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "DeleteChapCredentials": { + "input": { + "type": "structure", + "required": [ + "TargetARN", + "InitiatorName" + ], + "members": { + "TargetARN": {}, + "InitiatorName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TargetARN": {}, + "InitiatorName": {} + } + } + }, + "DeleteFileShare": { + "input": { + "type": "structure", + "required": [ + "FileShareARN" + ], + "members": { + "FileShareARN": {}, + "ForceDelete": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "FileShareARN": {} + } + } + }, + "DeleteGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "DeleteSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {} + } + } + }, + "DeleteTape": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeARN" + ], + "members": { + "GatewayARN": {}, + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "DeleteTapeArchive": { + "input": { + "type": "structure", + "required": [ + "TapeARN" + ], + "members": { + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "DeleteVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {} + } + } + }, + "DescribeBandwidthRateLimit": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "AverageUploadRateLimitInBitsPerSec": { + "type": "long" + }, + "AverageDownloadRateLimitInBitsPerSec": { + "type": "long" + } + } + } + }, + "DescribeCache": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sg" + }, + "CacheAllocatedInBytes": { + "type": "long" + }, + "CacheUsedPercentage": { + "type": "double" + }, + "CacheDirtyPercentage": { + "type": "double" + }, + "CacheHitPercentage": { + "type": "double" + }, + "CacheMissPercentage": { + "type": "double" + } + } + } + }, + "DescribeCachediSCSIVolumes": { + "input": { + "type": "structure", + "required": [ + "VolumeARNs" + ], + "members": { + "VolumeARNs": { + "shape": "S2z" + } + } + }, + "output": { + "type": "structure", + "members": { + "CachediSCSIVolumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeId": {}, + "VolumeType": {}, + "VolumeStatus": {}, + "VolumeAttachmentStatus": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "VolumeProgress": { + "type": "double" + }, + "SourceSnapshotId": {}, + "VolumeiSCSIAttributes": { + "shape": "S38" + }, + "CreatedDate": { + "type": "timestamp" + }, + "VolumeUsedInBytes": { + "type": "long" + }, + "KMSKey": {}, + "TargetName": {} + } + } + } + } + } + }, + "DescribeChapCredentials": { + "input": { + "type": "structure", + "required": [ + "TargetARN" + ], + "members": { + "TargetARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChapCredentials": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TargetARN": {}, + "SecretToAuthenticateInitiator": {}, + "InitiatorName": {}, + "SecretToAuthenticateTarget": {} + } + } + } + } + } + }, + "DescribeGatewayInformation": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "GatewayId": {}, + "GatewayName": {}, + "GatewayTimezone": {}, + "GatewayState": {}, + "GatewayNetworkInterfaces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Ipv4Address": {}, + "MacAddress": {}, + "Ipv6Address": {} + } + } + }, + "GatewayType": {}, + "NextUpdateAvailabilityDate": {}, + "LastSoftwareUpdate": {}, + "Ec2InstanceId": {}, + "Ec2InstanceRegion": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "DescribeMaintenanceStartTime": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "HourOfDay": { + "type": "integer" + }, + "MinuteOfHour": { + "type": "integer" + }, + "DayOfWeek": { + "type": "integer" + }, + "DayOfMonth": { + "type": "integer" + }, + "Timezone": {} + } + } + }, + "DescribeNFSFileShares": { + "input": { + "type": "structure", + "required": [ + "FileShareARNList" + ], + "members": { + "FileShareARNList": { + "shape": "S3z" + } + } + }, + "output": { + "type": "structure", + "members": { + "NFSFileShareInfoList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "NFSFileShareDefaults": { + "shape": "S19" + }, + "FileShareARN": {}, + "FileShareId": {}, + "FileShareStatus": {}, + "GatewayARN": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "Path": {}, + "Role": {}, + "LocationARN": {}, + "DefaultStorageClass": {}, + "ObjectACL": {}, + "ClientList": { + "shape": "S1g" + }, + "Squash": {}, + "ReadOnly": { + "type": "boolean" + }, + "GuessMIMETypeEnabled": { + "type": "boolean" + }, + "RequesterPays": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + } + } + } + } + } + } + }, + "DescribeSMBFileShares": { + "input": { + "type": "structure", + "required": [ + "FileShareARNList" + ], + "members": { + "FileShareARNList": { + "shape": "S3z" + } + } + }, + "output": { + "type": "structure", + "members": { + "SMBFileShareInfoList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FileShareARN": {}, + "FileShareId": {}, + "FileShareStatus": {}, + "GatewayARN": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "Path": {}, + "Role": {}, + "LocationARN": {}, + "DefaultStorageClass": {}, + "ObjectACL": {}, + "ReadOnly": { + "type": "boolean" + }, + "GuessMIMETypeEnabled": { + "type": "boolean" + }, + "RequesterPays": { + "type": "boolean" + }, + "SMBACLEnabled": { + "type": "boolean" + }, + "AdminUserList": { + "shape": "S1m" + }, + "ValidUserList": { + "shape": "S1m" + }, + "InvalidUserList": { + "shape": "S1m" + }, + "Authentication": {}, + "Tags": { + "shape": "S9" + } + } + } + } + } + } + }, + "DescribeSMBSettings": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "DomainName": {}, + "SMBGuestPasswordSet": { + "type": "boolean" + } + } + } + }, + "DescribeSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "StartAt": { + "type": "integer" + }, + "RecurrenceInHours": { + "type": "integer" + }, + "Description": {}, + "Timezone": {} + } + } + }, + "DescribeStorediSCSIVolumes": { + "input": { + "type": "structure", + "required": [ + "VolumeARNs" + ], + "members": { + "VolumeARNs": { + "shape": "S2z" + } + } + }, + "output": { + "type": "structure", + "members": { + "StorediSCSIVolumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeId": {}, + "VolumeType": {}, + "VolumeStatus": {}, + "VolumeAttachmentStatus": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "VolumeProgress": { + "type": "double" + }, + "VolumeDiskId": {}, + "SourceSnapshotId": {}, + "PreservedExistingData": { + "type": "boolean" + }, + "VolumeiSCSIAttributes": { + "shape": "S38" + }, + "CreatedDate": { + "type": "timestamp" + }, + "VolumeUsedInBytes": { + "type": "long" + }, + "KMSKey": {}, + "TargetName": {} + } + } + } + } + } + }, + "DescribeTapeArchives": { + "input": { + "type": "structure", + "members": { + "TapeARNs": { + "shape": "S28" + }, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TapeArchives": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TapeARN": {}, + "TapeBarcode": {}, + "TapeCreatedDate": { + "type": "timestamp" + }, + "TapeSizeInBytes": { + "type": "long" + }, + "CompletionTime": { + "type": "timestamp" + }, + "RetrievedTo": {}, + "TapeStatus": {}, + "TapeUsedInBytes": { + "type": "long" + }, + "KMSKey": {}, + "PoolId": {} + } + } + }, + "Marker": {} + } + } + }, + "DescribeTapeRecoveryPoints": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "TapeRecoveryPointInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TapeARN": {}, + "TapeRecoveryPointTime": { + "type": "timestamp" + }, + "TapeSizeInBytes": { + "type": "long" + }, + "TapeStatus": {} + } + } + }, + "Marker": {} + } + } + }, + "DescribeTapes": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "TapeARNs": { + "shape": "S28" + }, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tapes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TapeARN": {}, + "TapeBarcode": {}, + "TapeCreatedDate": { + "type": "timestamp" + }, + "TapeSizeInBytes": { + "type": "long" + }, + "TapeStatus": {}, + "VTLDevice": {}, + "Progress": { + "type": "double" + }, + "TapeUsedInBytes": { + "type": "long" + }, + "KMSKey": {}, + "PoolId": {} + } + } + }, + "Marker": {} + } + } + }, + "DescribeUploadBuffer": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sg" + }, + "UploadBufferUsedInBytes": { + "type": "long" + }, + "UploadBufferAllocatedInBytes": { + "type": "long" + } + } + } + }, + "DescribeVTLDevices": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "VTLDeviceARNs": { + "type": "list", + "member": {} + }, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "VTLDevices": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VTLDeviceARN": {}, + "VTLDeviceType": {}, + "VTLDeviceVendor": {}, + "VTLDeviceProductIdentifier": {}, + "DeviceiSCSIAttributes": { + "type": "structure", + "members": { + "TargetARN": {}, + "NetworkInterfaceId": {}, + "NetworkInterfacePort": { + "type": "integer" + }, + "ChapEnabled": { + "type": "boolean" + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeWorkingStorage": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sg" + }, + "WorkingStorageUsedInBytes": { + "type": "long" + }, + "WorkingStorageAllocatedInBytes": { + "type": "long" + } + } + } + }, + "DetachVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {}, + "ForceDetach": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {} + } + } + }, + "DisableGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "JoinDomain": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DomainName", + "UserName", + "Password" + ], + "members": { + "GatewayARN": {}, + "DomainName": {}, + "OrganizationalUnit": {}, + "DomainControllers": { + "type": "list", + "member": {} + }, + "UserName": {}, + "Password": { + "type": "string", + "sensitive": true + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "ListFileShares": { + "input": { + "type": "structure", + "members": { + "GatewayARN": {}, + "Limit": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Marker": {}, + "NextMarker": {}, + "FileShareInfoList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FileShareType": {}, + "FileShareARN": {}, + "FileShareId": {}, + "FileShareStatus": {}, + "GatewayARN": {} + } + } + } + } + } + }, + "ListGateways": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Gateways": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GatewayId": {}, + "GatewayARN": {}, + "GatewayType": {}, + "GatewayOperationalState": {}, + "GatewayName": {}, + "Ec2InstanceId": {}, + "Ec2InstanceRegion": {} + } + } + }, + "Marker": {} + } + } + }, + "ListLocalDisks": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "Disks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DiskId": {}, + "DiskPath": {}, + "DiskNode": {}, + "DiskStatus": {}, + "DiskSizeInBytes": { + "type": "long" + }, + "DiskAllocationType": {}, + "DiskAllocationResource": {}, + "DiskAttributeList": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN" + ], + "members": { + "ResourceARN": {}, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceARN": {}, + "Marker": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "ListTapes": { + "input": { + "type": "structure", + "members": { + "TapeARNs": { + "shape": "S28" + }, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TapeInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TapeARN": {}, + "TapeBarcode": {}, + "TapeSizeInBytes": { + "type": "long" + }, + "TapeStatus": {}, + "GatewayARN": {}, + "PoolId": {} + } + } + }, + "Marker": {} + } + } + }, + "ListVolumeInitiators": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "Initiators": { + "type": "list", + "member": {} + } + } + } + }, + "ListVolumeRecoveryPoints": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "VolumeRecoveryPointInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "VolumeUsageInBytes": { + "type": "long" + }, + "VolumeRecoveryPointTime": {} + } + } + } + } + } + }, + "ListVolumes": { + "input": { + "type": "structure", + "members": { + "GatewayARN": {}, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "Marker": {}, + "VolumeInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeId": {}, + "GatewayARN": {}, + "GatewayId": {}, + "VolumeType": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "VolumeAttachmentStatus": {} + } + } + } + } + } + }, + "NotifyWhenUploaded": { + "input": { + "type": "structure", + "required": [ + "FileShareARN" + ], + "members": { + "FileShareARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "FileShareARN": {}, + "NotificationId": {} + } + } + }, + "RefreshCache": { + "input": { + "type": "structure", + "required": [ + "FileShareARN" + ], + "members": { + "FileShareARN": {}, + "FolderList": { + "type": "list", + "member": {} + }, + "Recursive": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "FileShareARN": {}, + "NotificationId": {} + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceARN", + "TagKeys" + ], + "members": { + "ResourceARN": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "ResourceARN": {} + } + } + }, + "ResetCache": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "RetrieveTapeArchive": { + "input": { + "type": "structure", + "required": [ + "TapeARN", + "GatewayARN" + ], + "members": { + "TapeARN": {}, + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "RetrieveTapeRecoveryPoint": { + "input": { + "type": "structure", + "required": [ + "TapeARN", + "GatewayARN" + ], + "members": { + "TapeARN": {}, + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "SetLocalConsolePassword": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "LocalConsolePassword" + ], + "members": { + "GatewayARN": {}, + "LocalConsolePassword": { + "type": "string", + "sensitive": true + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "SetSMBGuestPassword": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "Password" + ], + "members": { + "GatewayARN": {}, + "Password": { + "type": "string", + "sensitive": true + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "ShutdownGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "StartGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateBandwidthRateLimit": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "AverageUploadRateLimitInBitsPerSec": { + "type": "long" + }, + "AverageDownloadRateLimitInBitsPerSec": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateChapCredentials": { + "input": { + "type": "structure", + "required": [ + "TargetARN", + "SecretToAuthenticateInitiator", + "InitiatorName" + ], + "members": { + "TargetARN": {}, + "SecretToAuthenticateInitiator": {}, + "InitiatorName": {}, + "SecretToAuthenticateTarget": {} + } + }, + "output": { + "type": "structure", + "members": { + "TargetARN": {}, + "InitiatorName": {} + } + } + }, + "UpdateGatewayInformation": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "GatewayName": {}, + "GatewayTimezone": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "GatewayName": {} + } + } + }, + "UpdateGatewaySoftwareNow": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateMaintenanceStartTime": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "HourOfDay", + "MinuteOfHour" + ], + "members": { + "GatewayARN": {}, + "HourOfDay": { + "type": "integer" + }, + "MinuteOfHour": { + "type": "integer" + }, + "DayOfWeek": { + "type": "integer" + }, + "DayOfMonth": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateNFSFileShare": { + "input": { + "type": "structure", + "required": [ + "FileShareARN" + ], + "members": { + "FileShareARN": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "NFSFileShareDefaults": { + "shape": "S19" + }, + "DefaultStorageClass": {}, + "ObjectACL": {}, + "ClientList": { + "shape": "S1g" + }, + "Squash": {}, + "ReadOnly": { + "type": "boolean" + }, + "GuessMIMETypeEnabled": { + "type": "boolean" + }, + "RequesterPays": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "FileShareARN": {} + } + } + }, + "UpdateSMBFileShare": { + "input": { + "type": "structure", + "required": [ + "FileShareARN" + ], + "members": { + "FileShareARN": {}, + "KMSEncrypted": { + "type": "boolean" + }, + "KMSKey": {}, + "DefaultStorageClass": {}, + "ObjectACL": {}, + "ReadOnly": { + "type": "boolean" + }, + "GuessMIMETypeEnabled": { + "type": "boolean" + }, + "RequesterPays": { + "type": "boolean" + }, + "SMBACLEnabled": { + "type": "boolean" + }, + "AdminUserList": { + "shape": "S1m" + }, + "ValidUserList": { + "shape": "S1m" + }, + "InvalidUserList": { + "shape": "S1m" + } + } + }, + "output": { + "type": "structure", + "members": { + "FileShareARN": {} + } + } + }, + "UpdateSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "VolumeARN", + "StartAt", + "RecurrenceInHours" + ], + "members": { + "VolumeARN": {}, + "StartAt": { + "type": "integer" + }, + "RecurrenceInHours": { + "type": "integer" + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {} + } + } + }, + "UpdateVTLDeviceType": { + "input": { + "type": "structure", + "required": [ + "VTLDeviceARN", + "DeviceType" + ], + "members": { + "VTLDeviceARN": {}, + "DeviceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "VTLDeviceARN": {} + } + } + } + }, + "shapes": { + "S9": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sg": { + "type": "list", + "member": {} + }, + "S19": { + "type": "structure", + "members": { + "FileMode": {}, + "DirectoryMode": {}, + "GroupId": { + "type": "long" + }, + "OwnerId": { + "type": "long" + } + } + }, + "S1g": { + "type": "list", + "member": {} + }, + "S1m": { + "type": "list", + "member": {} + }, + "S28": { + "type": "list", + "member": {} + }, + "S2z": { + "type": "list", + "member": {} + }, + "S38": { + "type": "structure", + "members": { + "TargetARN": {}, + "NetworkInterfaceId": {}, + "NetworkInterfacePort": { + "type": "integer" + }, + "LunNumber": { + "type": "integer" + }, + "ChapEnabled": { + "type": "boolean" + } + } + }, + "S3z": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/storagegateway-2013-06-30.paginators.json b/node_modules/aws-sdk/apis/storagegateway-2013-06-30.paginators.json new file mode 100644 index 0000000..78ba862 --- /dev/null +++ b/node_modules/aws-sdk/apis/storagegateway-2013-06-30.paginators.json @@ -0,0 +1,76 @@ +{ + "pagination": { + "DescribeCachediSCSIVolumes": { + "result_key": "CachediSCSIVolumes" + }, + "DescribeStorediSCSIVolumes": { + "result_key": "StorediSCSIVolumes" + }, + "DescribeTapeArchives": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeArchives" + }, + "DescribeTapeRecoveryPoints": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeRecoveryPointInfos" + }, + "DescribeTapes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Tapes" + }, + "DescribeVTLDevices": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VTLDevices" + }, + "ListFileShares": { + "input_token": "Marker", + "limit_key": "Limit", + "non_aggregate_keys": [ + "Marker" + ], + "output_token": "NextMarker", + "result_key": "FileShareInfoList" + }, + "ListGateways": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Gateways" + }, + "ListLocalDisks": { + "result_key": "Disks" + }, + "ListTagsForResource": { + "input_token": "Marker", + "limit_key": "Limit", + "non_aggregate_keys": [ + "ResourceARN" + ], + "output_token": "Marker", + "result_key": "Tags" + }, + "ListTapes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeInfos" + }, + "ListVolumeRecoveryPoints": { + "result_key": "VolumeRecoveryPointInfos" + }, + "ListVolumes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VolumeInfos" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.examples.json b/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.examples.json new file mode 100644 index 0000000..8287e2c --- /dev/null +++ b/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.examples.json @@ -0,0 +1,212 @@ +{ + "version": "1.0", + "examples": { + "DescribeStream": [ + { + "input": { + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252" + }, + "output": { + "StreamDescription": { + "CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015", + "KeySchema": [ + { + "AttributeName": "ForumName", + "KeyType": "HASH" + }, + { + "AttributeName": "Subject", + "KeyType": "RANGE" + } + ], + "Shards": [ + { + "SequenceNumberRange": { + "EndingSequenceNumber": "20500000000000000910398", + "StartingSequenceNumber": "20500000000000000910398" + }, + "ShardId": "shardId-00000001414562045508-2bac9cd2" + }, + { + "ParentShardId": "shardId-00000001414562045508-2bac9cd2", + "SequenceNumberRange": { + "EndingSequenceNumber": "820400000000000001192334", + "StartingSequenceNumber": "820400000000000001192334" + }, + "ShardId": "shardId-00000001414576573621-f55eea83" + }, + { + "ParentShardId": "shardId-00000001414576573621-f55eea83", + "SequenceNumberRange": { + "EndingSequenceNumber": "1683700000000000001135967", + "StartingSequenceNumber": "1683700000000000001135967" + }, + "ShardId": "shardId-00000001414592258131-674fd923" + }, + { + "ParentShardId": "shardId-00000001414592258131-674fd923", + "SequenceNumberRange": { + "StartingSequenceNumber": "2574600000000000000935255" + }, + "ShardId": "shardId-00000001414608446368-3a1afbaf" + } + ], + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", + "StreamLabel": "2015-05-20T20:51:10.252", + "StreamStatus": "ENABLED", + "StreamViewType": "NEW_AND_OLD_IMAGES", + "TableName": "Forum" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example describes a stream with a given stream ARN.", + "id": "to-describe-a-stream-with-a-given-stream-arn-1473457835200", + "title": "To describe a stream with a given stream ARN" + } + ], + "GetRecords": [ + { + "input": { + "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... ..." + }, + "output": { + "NextShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... ...", + "Records": [ + { + "awsRegion": "us-west-2", + "dynamodb": { + "ApproximateCreationDateTime": "1.46480646E9", + "Keys": { + "ForumName": { + "S": "DynamoDB" + }, + "Subject": { + "S": "DynamoDB Thread 3" + } + }, + "SequenceNumber": "300000000000000499659", + "SizeBytes": 41, + "StreamViewType": "KEYS_ONLY" + }, + "eventID": "e2fd9c34eff2d779b297b26f5fef4206", + "eventName": "INSERT", + "eventSource": "aws:dynamodb", + "eventVersion": "1.0" + }, + { + "awsRegion": "us-west-2", + "dynamodb": { + "ApproximateCreationDateTime": "1.46480527E9", + "Keys": { + "ForumName": { + "S": "DynamoDB" + }, + "Subject": { + "S": "DynamoDB Thread 1" + } + }, + "SequenceNumber": "400000000000000499660", + "SizeBytes": 41, + "StreamViewType": "KEYS_ONLY" + }, + "eventID": "4b25bd0da9a181a155114127e4837252", + "eventName": "MODIFY", + "eventSource": "aws:dynamodb", + "eventVersion": "1.0" + }, + { + "awsRegion": "us-west-2", + "dynamodb": { + "ApproximateCreationDateTime": "1.46480646E9", + "Keys": { + "ForumName": { + "S": "DynamoDB" + }, + "Subject": { + "S": "DynamoDB Thread 2" + } + }, + "SequenceNumber": "500000000000000499661", + "SizeBytes": 41, + "StreamViewType": "KEYS_ONLY" + }, + "eventID": "740280c73a3df7842edab3548a1b08ad", + "eventName": "REMOVE", + "eventSource": "aws:dynamodb", + "eventVersion": "1.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves all the stream records from a shard.", + "id": "to-retrieve-all-the-stream-records-from-a-shard-1473707781419", + "title": "To retrieve all the stream records from a shard" + } + ], + "GetShardIterator": [ + { + "input": { + "ShardId": "00000001414576573621-f55eea83", + "ShardIteratorType": "TRIM_HORIZON", + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252" + }, + "output": { + "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... ..." + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a shard iterator for the provided stream ARN and shard ID.", + "id": "to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476", + "title": "To obtain a shard iterator for the provided stream ARN and shard ID" + } + ], + "ListStreams": [ + { + "input": { + }, + "output": { + "Streams": [ + { + "StreamArn": "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", + "StreamLabel": "2015-05-20T20:51:10.252", + "TableName": "Forum" + }, + { + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714", + "StreamLabel": "2015-05-20T20:50:02.714", + "TableName": "Forum" + }, + { + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641", + "StreamLabel": "2015-05-19T23:03:50.641", + "TableName": "Forum" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists all of the stream ARNs.", + "id": "to-list-all-of-the-stream-arns--1473459534285", + "title": "To list all of the stream ARNs " + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.min.json b/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.min.json new file mode 100644 index 0000000..39fa911 --- /dev/null +++ b/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.min.json @@ -0,0 +1,247 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-08-10", + "endpointPrefix": "streams.dynamodb", + "jsonVersion": "1.0", + "protocol": "json", + "serviceFullName": "Amazon DynamoDB Streams", + "serviceId": "DynamoDB Streams", + "signatureVersion": "v4", + "signingName": "dynamodb", + "targetPrefix": "DynamoDBStreams_20120810", + "uid": "streams-dynamodb-2012-08-10" + }, + "operations": { + "DescribeStream": { + "input": { + "type": "structure", + "required": [ + "StreamArn" + ], + "members": { + "StreamArn": {}, + "Limit": { + "type": "integer" + }, + "ExclusiveStartShardId": {} + } + }, + "output": { + "type": "structure", + "members": { + "StreamDescription": { + "type": "structure", + "members": { + "StreamArn": {}, + "StreamLabel": {}, + "StreamStatus": {}, + "StreamViewType": {}, + "CreationRequestDateTime": { + "type": "timestamp" + }, + "TableName": {}, + "KeySchema": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeName", + "KeyType" + ], + "members": { + "AttributeName": {}, + "KeyType": {} + } + } + }, + "Shards": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ShardId": {}, + "SequenceNumberRange": { + "type": "structure", + "members": { + "StartingSequenceNumber": {}, + "EndingSequenceNumber": {} + } + }, + "ParentShardId": {} + } + } + }, + "LastEvaluatedShardId": {} + } + } + } + } + }, + "GetRecords": { + "input": { + "type": "structure", + "required": [ + "ShardIterator" + ], + "members": { + "ShardIterator": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Records": { + "type": "list", + "member": { + "type": "structure", + "members": { + "eventID": {}, + "eventName": {}, + "eventVersion": {}, + "eventSource": {}, + "awsRegion": {}, + "dynamodb": { + "type": "structure", + "members": { + "ApproximateCreationDateTime": { + "type": "timestamp" + }, + "Keys": { + "shape": "Sr" + }, + "NewImage": { + "shape": "Sr" + }, + "OldImage": { + "shape": "Sr" + }, + "SequenceNumber": {}, + "SizeBytes": { + "type": "long" + }, + "StreamViewType": {} + } + }, + "userIdentity": { + "type": "structure", + "members": { + "PrincipalId": {}, + "Type": {} + } + } + } + } + }, + "NextShardIterator": {} + } + } + }, + "GetShardIterator": { + "input": { + "type": "structure", + "required": [ + "StreamArn", + "ShardId", + "ShardIteratorType" + ], + "members": { + "StreamArn": {}, + "ShardId": {}, + "ShardIteratorType": {}, + "SequenceNumber": {} + } + }, + "output": { + "type": "structure", + "members": { + "ShardIterator": {} + } + } + }, + "ListStreams": { + "input": { + "type": "structure", + "members": { + "TableName": {}, + "Limit": { + "type": "integer" + }, + "ExclusiveStartStreamArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Streams": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StreamArn": {}, + "TableName": {}, + "StreamLabel": {} + } + } + }, + "LastEvaluatedStreamArn": {} + } + } + } + }, + "shapes": { + "Sr": { + "type": "map", + "key": {}, + "value": { + "shape": "St" + } + }, + "St": { + "type": "structure", + "members": { + "S": {}, + "N": {}, + "B": { + "type": "blob" + }, + "SS": { + "type": "list", + "member": {} + }, + "NS": { + "type": "list", + "member": {} + }, + "BS": { + "type": "list", + "member": { + "type": "blob" + } + }, + "M": { + "type": "map", + "key": {}, + "value": { + "shape": "St" + } + }, + "L": { + "type": "list", + "member": { + "shape": "St" + } + }, + "NULL": { + "type": "boolean" + }, + "BOOL": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.paginators.json b/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/streams.dynamodb-2012-08-10.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/sts-2011-06-15.examples.json b/node_modules/aws-sdk/apis/sts-2011-06-15.examples.json new file mode 100644 index 0000000..84442a1 --- /dev/null +++ b/node_modules/aws-sdk/apis/sts-2011-06-15.examples.json @@ -0,0 +1,206 @@ +{ + "version": "1.0", + "examples": { + "AssumeRole": [ + { + "input": { + "DurationSeconds": 3600, + "ExternalId": "123ABC", + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}]}", + "RoleArn": "arn:aws:iam::123456789012:role/demo", + "RoleSessionName": "Bob" + }, + "output": { + "AssumedRoleUser": { + "Arn": "arn:aws:sts::123456789012:assumed-role/demo/Bob", + "AssumedRoleId": "ARO123EXAMPLE123:Bob" + }, + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2011-07-15T23:28:33.359Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==" + }, + "PackedPolicySize": 6 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-assume-a-role-1480532402212", + "title": "To assume a role" + } + ], + "AssumeRoleWithWebIdentity": [ + { + "input": { + "DurationSeconds": 3600, + "ProviderId": "www.amazon.com", + "RoleArn": "arn:aws:iam::123456789012:role/FederatedWebIdentityRole", + "RoleSessionName": "app1", + "WebIdentityToken": "Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXXXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFBmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNIL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAGpsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ" + }, + "output": { + "AssumedRoleUser": { + "Arn": "arn:aws:sts::123456789012:assumed-role/FederatedWebIdentityRole/app1", + "AssumedRoleId": "AROACLKWSDQRAOEXAMPLE:app1" + }, + "Audience": "client.5498841531868486423.1548@apps.example.com", + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2014-10-24T23:00:23Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IEXAMPLE" + }, + "PackedPolicySize": 123, + "Provider": "www.amazon.com", + "SubjectFromWebIdentityToken": "amzn1.account.AF6RHO7KZU5XRVQJGXK6HEXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-assume-a-role-as-an-openid-connect-federated-user-1480533445696", + "title": "To assume a role as an OpenID Connect-federated user" + } + ], + "DecodeAuthorizationMessage": [ + { + "input": { + "EncodedMessage": "" + }, + "output": { + "DecodedMessage": "{\"allowed\": \"false\",\"explicitDeny\": \"false\",\"matchedStatements\": \"\",\"failures\": \"\",\"context\": {\"principal\": {\"id\": \"AIDACKCEVSQ6C2EXAMPLE\",\"name\": \"Bob\",\"arn\": \"arn:aws:iam::123456789012:user/Bob\"},\"action\": \"ec2:StopInstances\",\"resource\": \"arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd\",\"conditions\": [{\"item\": {\"key\": \"ec2:Tenancy\",\"values\": [\"default\"]},{\"item\": {\"key\": \"ec2:ResourceTag/elasticbeanstalk:environment-name\",\"values\": [\"Default-Environment\"]}},(Additional items ...)]}}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-decode-information-about-an-authorization-status-of-a-request-1480533854499", + "title": "To decode information about an authorization status of a request" + } + ], + "GetCallerIdentity": [ + { + "input": { + }, + "output": { + "Account": "123456789012", + "Arn": "arn:aws:iam::123456789012:user/Alice", + "UserId": "AKIAI44QH8DHBEXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows a request and response made with the credentials for a user named Alice in the AWS account 123456789012.", + "id": "to-get-details-about-a-calling-iam-user-1480540050376", + "title": "To get details about a calling IAM user" + }, + { + "input": { + }, + "output": { + "Account": "123456789012", + "Arn": "arn:aws:sts::123456789012:assumed-role/my-role-name/my-role-session-name", + "UserId": "AKIAI44QH8DHBEXAMPLE:my-role-session-name" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows a request and response made with temporary credentials created by AssumeRole. The name of the assumed role is my-role-name, and the RoleSessionName is set to my-role-session-name.", + "id": "to-get-details-about-a-calling-user-federated-with-assumerole-1480540158545", + "title": "To get details about a calling user federated with AssumeRole" + }, + { + "input": { + }, + "output": { + "Account": "123456789012", + "Arn": "arn:aws:sts::123456789012:federated-user/my-federated-user-name", + "UserId": "123456789012:my-federated-user-name" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows a request and response made with temporary credentials created by using GetFederationToken. The Name parameter is set to my-federated-user-name.", + "id": "to-get-details-about-a-calling-user-federated-with-getfederationtoken-1480540231316", + "title": "To get details about a calling user federated with GetFederationToken" + } + ], + "GetFederationToken": [ + { + "input": { + "DurationSeconds": 3600, + "Name": "Bob", + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}]}" + }, + "output": { + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2011-07-15T23:28:33.359Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==" + }, + "FederatedUser": { + "Arn": "arn:aws:sts::123456789012:federated-user/Bob", + "FederatedUserId": "123456789012:Bob" + }, + "PackedPolicySize": 6 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-get-temporary-credentials-for-a-role-by-using-getfederationtoken-1480540749900", + "title": "To get temporary credentials for a role by using GetFederationToken" + } + ], + "GetSessionToken": [ + { + "input": { + "DurationSeconds": 3600, + "SerialNumber": "YourMFASerialNumber", + "TokenCode": "123456" + }, + "output": { + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2011-07-11T19:55:29.611Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtpZ3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-get-temporary-credentials-for-an-iam-user-or-an-aws-account-1480540814038", + "title": "To get temporary credentials for an IAM user or an AWS account" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/sts-2011-06-15.min.json b/node_modules/aws-sdk/apis/sts-2011-06-15.min.json new file mode 100644 index 0000000..f3448d5 --- /dev/null +++ b/node_modules/aws-sdk/apis/sts-2011-06-15.min.json @@ -0,0 +1,251 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2011-06-15", + "endpointPrefix": "sts", + "globalEndpoint": "sts.amazonaws.com", + "protocol": "query", + "serviceAbbreviation": "AWS STS", + "serviceFullName": "AWS Security Token Service", + "serviceId": "STS", + "signatureVersion": "v4", + "uid": "sts-2011-06-15", + "xmlNamespace": "https://sts.amazonaws.com/doc/2011-06-15/" + }, + "operations": { + "AssumeRole": { + "input": { + "type": "structure", + "required": [ + "RoleArn", + "RoleSessionName" + ], + "members": { + "RoleArn": {}, + "RoleSessionName": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + }, + "ExternalId": {}, + "SerialNumber": {}, + "TokenCode": {} + } + }, + "output": { + "resultWrapper": "AssumeRoleResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "AssumedRoleUser": { + "shape": "Sf" + }, + "PackedPolicySize": { + "type": "integer" + } + } + } + }, + "AssumeRoleWithSAML": { + "input": { + "type": "structure", + "required": [ + "RoleArn", + "PrincipalArn", + "SAMLAssertion" + ], + "members": { + "RoleArn": {}, + "PrincipalArn": {}, + "SAMLAssertion": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "AssumeRoleWithSAMLResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "AssumedRoleUser": { + "shape": "Sf" + }, + "PackedPolicySize": { + "type": "integer" + }, + "Subject": {}, + "SubjectType": {}, + "Issuer": {}, + "Audience": {}, + "NameQualifier": {} + } + } + }, + "AssumeRoleWithWebIdentity": { + "input": { + "type": "structure", + "required": [ + "RoleArn", + "RoleSessionName", + "WebIdentityToken" + ], + "members": { + "RoleArn": {}, + "RoleSessionName": {}, + "WebIdentityToken": {}, + "ProviderId": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "AssumeRoleWithWebIdentityResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "SubjectFromWebIdentityToken": {}, + "AssumedRoleUser": { + "shape": "Sf" + }, + "PackedPolicySize": { + "type": "integer" + }, + "Provider": {}, + "Audience": {} + } + } + }, + "DecodeAuthorizationMessage": { + "input": { + "type": "structure", + "required": [ + "EncodedMessage" + ], + "members": { + "EncodedMessage": {} + } + }, + "output": { + "resultWrapper": "DecodeAuthorizationMessageResult", + "type": "structure", + "members": { + "DecodedMessage": {} + } + } + }, + "GetCallerIdentity": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "GetCallerIdentityResult", + "type": "structure", + "members": { + "UserId": {}, + "Account": {}, + "Arn": {} + } + } + }, + "GetFederationToken": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "GetFederationTokenResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "FederatedUser": { + "type": "structure", + "required": [ + "FederatedUserId", + "Arn" + ], + "members": { + "FederatedUserId": {}, + "Arn": {} + } + }, + "PackedPolicySize": { + "type": "integer" + } + } + } + }, + "GetSessionToken": { + "input": { + "type": "structure", + "members": { + "DurationSeconds": { + "type": "integer" + }, + "SerialNumber": {}, + "TokenCode": {} + } + }, + "output": { + "resultWrapper": "GetSessionTokenResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + } + } + } + } + }, + "shapes": { + "Sa": { + "type": "structure", + "required": [ + "AccessKeyId", + "SecretAccessKey", + "SessionToken", + "Expiration" + ], + "members": { + "AccessKeyId": {}, + "SecretAccessKey": {}, + "SessionToken": {}, + "Expiration": { + "type": "timestamp" + } + } + }, + "Sf": { + "type": "structure", + "required": [ + "AssumedRoleId", + "Arn" + ], + "members": { + "AssumedRoleId": {}, + "Arn": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/sts-2011-06-15.paginators.json b/node_modules/aws-sdk/apis/sts-2011-06-15.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/sts-2011-06-15.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/support-2013-04-15.min.json b/node_modules/aws-sdk/apis/support-2013-04-15.min.json new file mode 100644 index 0000000..d4ce40d --- /dev/null +++ b/node_modules/aws-sdk/apis/support-2013-04-15.min.json @@ -0,0 +1,571 @@ +{ + "version": "2.0", + "metadata": { + "uid": "support-2013-04-15", + "apiVersion": "2013-04-15", + "endpointPrefix": "support", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "AWS Support", + "serviceId": "Support", + "signatureVersion": "v4", + "targetPrefix": "AWSSupport_20130415" + }, + "operations": { + "AddAttachmentsToSet": { + "input": { + "type": "structure", + "required": [ + "attachments" + ], + "members": { + "attachmentSetId": {}, + "attachments": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "attachmentSetId": {}, + "expiryTime": {} + } + } + }, + "AddCommunicationToCase": { + "input": { + "type": "structure", + "required": [ + "communicationBody" + ], + "members": { + "caseId": {}, + "communicationBody": {}, + "ccEmailAddresses": { + "shape": "Sc" + }, + "attachmentSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "result": { + "type": "boolean" + } + } + } + }, + "CreateCase": { + "input": { + "type": "structure", + "required": [ + "subject", + "communicationBody" + ], + "members": { + "subject": {}, + "serviceCode": {}, + "severityCode": {}, + "categoryCode": {}, + "communicationBody": {}, + "ccEmailAddresses": { + "shape": "Sc" + }, + "language": {}, + "issueType": {}, + "attachmentSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "caseId": {} + } + } + }, + "DescribeAttachment": { + "input": { + "type": "structure", + "required": [ + "attachmentId" + ], + "members": { + "attachmentId": {} + } + }, + "output": { + "type": "structure", + "members": { + "attachment": { + "shape": "S4" + } + } + } + }, + "DescribeCases": { + "input": { + "type": "structure", + "members": { + "caseIdList": { + "type": "list", + "member": {} + }, + "displayId": {}, + "afterTime": {}, + "beforeTime": {}, + "includeResolvedCases": { + "type": "boolean" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "language": {}, + "includeCommunications": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "cases": { + "type": "list", + "member": { + "type": "structure", + "members": { + "caseId": {}, + "displayId": {}, + "subject": {}, + "status": {}, + "serviceCode": {}, + "categoryCode": {}, + "severityCode": {}, + "submittedBy": {}, + "timeCreated": {}, + "recentCommunications": { + "type": "structure", + "members": { + "communications": { + "shape": "S17" + }, + "nextToken": {} + } + }, + "ccEmailAddresses": { + "shape": "Sc" + }, + "language": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeCommunications": { + "input": { + "type": "structure", + "required": [ + "caseId" + ], + "members": { + "caseId": {}, + "beforeTime": {}, + "afterTime": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "communications": { + "shape": "S17" + }, + "nextToken": {} + } + } + }, + "DescribeServices": { + "input": { + "type": "structure", + "members": { + "serviceCodeList": { + "type": "list", + "member": {} + }, + "language": {} + } + }, + "output": { + "type": "structure", + "members": { + "services": { + "type": "list", + "member": { + "type": "structure", + "members": { + "code": {}, + "name": {}, + "categories": { + "type": "list", + "member": { + "type": "structure", + "members": { + "code": {}, + "name": {} + } + } + } + } + } + } + } + } + }, + "DescribeSeverityLevels": { + "input": { + "type": "structure", + "members": { + "language": {} + } + }, + "output": { + "type": "structure", + "members": { + "severityLevels": { + "type": "list", + "member": { + "type": "structure", + "members": { + "code": {}, + "name": {} + } + } + } + } + } + }, + "DescribeTrustedAdvisorCheckRefreshStatuses": { + "input": { + "type": "structure", + "required": [ + "checkIds" + ], + "members": { + "checkIds": { + "shape": "S1t" + } + } + }, + "output": { + "type": "structure", + "required": [ + "statuses" + ], + "members": { + "statuses": { + "type": "list", + "member": { + "shape": "S1x" + } + } + } + } + }, + "DescribeTrustedAdvisorCheckResult": { + "input": { + "type": "structure", + "required": [ + "checkId" + ], + "members": { + "checkId": {}, + "language": {} + } + }, + "output": { + "type": "structure", + "members": { + "result": { + "type": "structure", + "required": [ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary", + "flaggedResources" + ], + "members": { + "checkId": {}, + "timestamp": {}, + "status": {}, + "resourcesSummary": { + "shape": "S22" + }, + "categorySpecificSummary": { + "shape": "S23" + }, + "flaggedResources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "status", + "resourceId", + "metadata" + ], + "members": { + "status": {}, + "region": {}, + "resourceId": {}, + "isSuppressed": { + "type": "boolean" + }, + "metadata": { + "shape": "S1t" + } + } + } + } + } + } + } + } + }, + "DescribeTrustedAdvisorCheckSummaries": { + "input": { + "type": "structure", + "required": [ + "checkIds" + ], + "members": { + "checkIds": { + "shape": "S1t" + } + } + }, + "output": { + "type": "structure", + "required": [ + "summaries" + ], + "members": { + "summaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary" + ], + "members": { + "checkId": {}, + "timestamp": {}, + "status": {}, + "hasFlaggedResources": { + "type": "boolean" + }, + "resourcesSummary": { + "shape": "S22" + }, + "categorySpecificSummary": { + "shape": "S23" + } + } + } + } + } + } + }, + "DescribeTrustedAdvisorChecks": { + "input": { + "type": "structure", + "required": [ + "language" + ], + "members": { + "language": {} + } + }, + "output": { + "type": "structure", + "required": [ + "checks" + ], + "members": { + "checks": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "id", + "name", + "description", + "category", + "metadata" + ], + "members": { + "id": {}, + "name": {}, + "description": {}, + "category": {}, + "metadata": { + "shape": "S1t" + } + } + } + } + } + } + }, + "RefreshTrustedAdvisorCheck": { + "input": { + "type": "structure", + "required": [ + "checkId" + ], + "members": { + "checkId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "S1x" + } + } + } + }, + "ResolveCase": { + "input": { + "type": "structure", + "members": { + "caseId": {} + } + }, + "output": { + "type": "structure", + "members": { + "initialCaseStatus": {}, + "finalCaseStatus": {} + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "fileName": {}, + "data": { + "type": "blob" + } + } + }, + "Sc": { + "type": "list", + "member": {} + }, + "S17": { + "type": "list", + "member": { + "type": "structure", + "members": { + "caseId": {}, + "body": {}, + "submittedBy": {}, + "timeCreated": {}, + "attachmentSet": { + "type": "list", + "member": { + "type": "structure", + "members": { + "attachmentId": {}, + "fileName": {} + } + } + } + } + } + }, + "S1t": { + "type": "list", + "member": {} + }, + "S1x": { + "type": "structure", + "required": [ + "checkId", + "status", + "millisUntilNextRefreshable" + ], + "members": { + "checkId": {}, + "status": {}, + "millisUntilNextRefreshable": { + "type": "long" + } + } + }, + "S22": { + "type": "structure", + "required": [ + "resourcesProcessed", + "resourcesFlagged", + "resourcesIgnored", + "resourcesSuppressed" + ], + "members": { + "resourcesProcessed": { + "type": "long" + }, + "resourcesFlagged": { + "type": "long" + }, + "resourcesIgnored": { + "type": "long" + }, + "resourcesSuppressed": { + "type": "long" + } + } + }, + "S23": { + "type": "structure", + "members": { + "costOptimizing": { + "type": "structure", + "required": [ + "estimatedMonthlySavings", + "estimatedPercentMonthlySavings" + ], + "members": { + "estimatedMonthlySavings": { + "type": "double" + }, + "estimatedPercentMonthlySavings": { + "type": "double" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/support-2013-04-15.paginators.json b/node_modules/aws-sdk/apis/support-2013-04-15.paginators.json new file mode 100644 index 0000000..1368630 --- /dev/null +++ b/node_modules/aws-sdk/apis/support-2013-04-15.paginators.json @@ -0,0 +1,25 @@ +{ + "pagination": { + "DescribeCases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "cases" + }, + "DescribeCommunications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "communications" + }, + "DescribeServices": { + "result_key": "services" + }, + "DescribeTrustedAdvisorCheckRefreshStatuses": { + "result_key": "statuses" + }, + "DescribeTrustedAdvisorCheckSummaries": { + "result_key": "summaries" + } + } +} diff --git a/node_modules/aws-sdk/apis/swf-2012-01-25.examples.json b/node_modules/aws-sdk/apis/swf-2012-01-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/swf-2012-01-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/swf-2012-01-25.min.json b/node_modules/aws-sdk/apis/swf-2012-01-25.min.json new file mode 100644 index 0000000..c75bca7 --- /dev/null +++ b/node_modules/aws-sdk/apis/swf-2012-01-25.min.json @@ -0,0 +1,2220 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2012-01-25", + "endpointPrefix": "swf", + "jsonVersion": "1.0", + "protocol": "json", + "serviceAbbreviation": "Amazon SWF", + "serviceFullName": "Amazon Simple Workflow Service", + "serviceId": "SWF", + "signatureVersion": "v4", + "targetPrefix": "SimpleWorkflowService", + "timestampFormat": "unixTimestamp", + "uid": "swf-2012-01-25" + }, + "operations": { + "CountClosedWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "closeTimeFilter": { + "shape": "S3" + }, + "executionFilter": { + "shape": "S5" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "closeStatusFilter": { + "shape": "Sc" + } + } + }, + "output": { + "shape": "Se" + } + }, + "CountOpenWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain", + "startTimeFilter" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "executionFilter": { + "shape": "S5" + } + } + }, + "output": { + "shape": "Se" + } + }, + "CountPendingActivityTasks": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + } + } + }, + "output": { + "shape": "Sk" + } + }, + "CountPendingDecisionTasks": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + } + } + }, + "output": { + "shape": "Sk" + } + }, + "DeprecateActivityType": { + "input": { + "type": "structure", + "required": [ + "domain", + "activityType" + ], + "members": { + "domain": {}, + "activityType": { + "shape": "Sn" + } + } + } + }, + "DeprecateDomain": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + } + }, + "DeprecateWorkflowType": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowType" + ], + "members": { + "domain": {}, + "workflowType": { + "shape": "Sr" + } + } + } + }, + "DescribeActivityType": { + "input": { + "type": "structure", + "required": [ + "domain", + "activityType" + ], + "members": { + "domain": {}, + "activityType": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfo", + "configuration" + ], + "members": { + "typeInfo": { + "shape": "Su" + }, + "configuration": { + "type": "structure", + "members": { + "defaultTaskStartToCloseTimeout": {}, + "defaultTaskHeartbeatTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultTaskPriority": {}, + "defaultTaskScheduleToStartTimeout": {}, + "defaultTaskScheduleToCloseTimeout": {} + } + } + } + } + }, + "DescribeDomain": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "output": { + "type": "structure", + "required": [ + "domainInfo", + "configuration" + ], + "members": { + "domainInfo": { + "shape": "S12" + }, + "configuration": { + "type": "structure", + "required": [ + "workflowExecutionRetentionPeriodInDays" + ], + "members": { + "workflowExecutionRetentionPeriodInDays": {} + } + } + } + } + }, + "DescribeWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "execution" + ], + "members": { + "domain": {}, + "execution": { + "shape": "S16" + } + } + }, + "output": { + "type": "structure", + "required": [ + "executionInfo", + "executionConfiguration", + "openCounts" + ], + "members": { + "executionInfo": { + "shape": "S19" + }, + "executionConfiguration": { + "type": "structure", + "required": [ + "taskStartToCloseTimeout", + "executionStartToCloseTimeout", + "taskList", + "childPolicy" + ], + "members": { + "taskStartToCloseTimeout": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "childPolicy": {}, + "lambdaRole": {} + } + }, + "openCounts": { + "type": "structure", + "required": [ + "openActivityTasks", + "openDecisionTasks", + "openTimers", + "openChildWorkflowExecutions" + ], + "members": { + "openActivityTasks": { + "type": "integer" + }, + "openDecisionTasks": { + "type": "integer" + }, + "openTimers": { + "type": "integer" + }, + "openChildWorkflowExecutions": { + "type": "integer" + }, + "openLambdaFunctions": { + "type": "integer" + } + } + }, + "latestActivityTaskTimestamp": { + "type": "timestamp" + }, + "latestExecutionContext": {} + } + } + }, + "DescribeWorkflowType": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowType" + ], + "members": { + "domain": {}, + "workflowType": { + "shape": "Sr" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfo", + "configuration" + ], + "members": { + "typeInfo": { + "shape": "S1m" + }, + "configuration": { + "type": "structure", + "members": { + "defaultTaskStartToCloseTimeout": {}, + "defaultExecutionStartToCloseTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultTaskPriority": {}, + "defaultChildPolicy": {}, + "defaultLambdaRole": {} + } + } + } + } + }, + "GetWorkflowExecutionHistory": { + "input": { + "type": "structure", + "required": [ + "domain", + "execution" + ], + "members": { + "domain": {}, + "execution": { + "shape": "S16" + }, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "events" + ], + "members": { + "events": { + "shape": "S1t" + }, + "nextPageToken": {} + } + } + }, + "ListActivityTypes": { + "input": { + "type": "structure", + "required": [ + "domain", + "registrationStatus" + ], + "members": { + "domain": {}, + "name": {}, + "registrationStatus": {}, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfos" + ], + "members": { + "typeInfos": { + "type": "list", + "member": { + "shape": "Su" + } + }, + "nextPageToken": {} + } + } + }, + "ListClosedWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "closeTimeFilter": { + "shape": "S3" + }, + "executionFilter": { + "shape": "S5" + }, + "closeStatusFilter": { + "shape": "Sc" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "shape": "S4g" + } + }, + "ListDomains": { + "input": { + "type": "structure", + "required": [ + "registrationStatus" + ], + "members": { + "nextPageToken": {}, + "registrationStatus": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "domainInfos" + ], + "members": { + "domainInfos": { + "type": "list", + "member": { + "shape": "S12" + } + }, + "nextPageToken": {} + } + } + }, + "ListOpenWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain", + "startTimeFilter" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + }, + "executionFilter": { + "shape": "S5" + } + } + }, + "output": { + "shape": "S4g" + } + }, + "ListWorkflowTypes": { + "input": { + "type": "structure", + "required": [ + "domain", + "registrationStatus" + ], + "members": { + "domain": {}, + "name": {}, + "registrationStatus": {}, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfos" + ], + "members": { + "typeInfos": { + "type": "list", + "member": { + "shape": "S1m" + } + }, + "nextPageToken": {} + } + } + }, + "PollForActivityTask": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + }, + "identity": {} + } + }, + "output": { + "type": "structure", + "required": [ + "taskToken", + "activityId", + "startedEventId", + "workflowExecution", + "activityType" + ], + "members": { + "taskToken": {}, + "activityId": {}, + "startedEventId": { + "type": "long" + }, + "workflowExecution": { + "shape": "S16" + }, + "activityType": { + "shape": "Sn" + }, + "input": {} + } + } + }, + "PollForDecisionTask": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + }, + "identity": {}, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "events" + ], + "members": { + "taskToken": {}, + "startedEventId": { + "type": "long" + }, + "workflowExecution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "events": { + "shape": "S1t" + }, + "nextPageToken": {}, + "previousStartedEventId": { + "type": "long" + } + } + } + }, + "RecordActivityTaskHeartbeat": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "details": {} + } + }, + "output": { + "type": "structure", + "required": [ + "cancelRequested" + ], + "members": { + "cancelRequested": { + "type": "boolean" + } + } + } + }, + "RegisterActivityType": { + "input": { + "type": "structure", + "required": [ + "domain", + "name", + "version" + ], + "members": { + "domain": {}, + "name": {}, + "version": {}, + "description": {}, + "defaultTaskStartToCloseTimeout": {}, + "defaultTaskHeartbeatTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultTaskPriority": {}, + "defaultTaskScheduleToStartTimeout": {}, + "defaultTaskScheduleToCloseTimeout": {} + } + } + }, + "RegisterDomain": { + "input": { + "type": "structure", + "required": [ + "name", + "workflowExecutionRetentionPeriodInDays" + ], + "members": { + "name": {}, + "description": {}, + "workflowExecutionRetentionPeriodInDays": {} + } + } + }, + "RegisterWorkflowType": { + "input": { + "type": "structure", + "required": [ + "domain", + "name", + "version" + ], + "members": { + "domain": {}, + "name": {}, + "version": {}, + "description": {}, + "defaultTaskStartToCloseTimeout": {}, + "defaultExecutionStartToCloseTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultTaskPriority": {}, + "defaultChildPolicy": {}, + "defaultLambdaRole": {} + } + } + }, + "RequestCancelWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId" + ], + "members": { + "domain": {}, + "workflowId": {}, + "runId": {} + } + } + }, + "RespondActivityTaskCanceled": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "details": {} + } + } + }, + "RespondActivityTaskCompleted": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "result": {} + } + } + }, + "RespondActivityTaskFailed": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "reason": {}, + "details": {} + } + } + }, + "RespondDecisionTaskCompleted": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "decisions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "decisionType" + ], + "members": { + "decisionType": {}, + "scheduleActivityTaskDecisionAttributes": { + "type": "structure", + "required": [ + "activityType", + "activityId" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "activityId": {}, + "control": {}, + "input": {}, + "scheduleToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "scheduleToStartTimeout": {}, + "startToCloseTimeout": {}, + "heartbeatTimeout": {} + } + }, + "requestCancelActivityTaskDecisionAttributes": { + "type": "structure", + "required": [ + "activityId" + ], + "members": { + "activityId": {} + } + }, + "completeWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "result": {} + } + }, + "failWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "reason": {}, + "details": {} + } + }, + "cancelWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "details": {} + } + }, + "continueAsNewWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "input": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "tagList": { + "shape": "S1b" + }, + "workflowTypeVersion": {}, + "lambdaRole": {} + } + }, + "recordMarkerDecisionAttributes": { + "type": "structure", + "required": [ + "markerName" + ], + "members": { + "markerName": {}, + "details": {} + } + }, + "startTimerDecisionAttributes": { + "type": "structure", + "required": [ + "timerId", + "startToFireTimeout" + ], + "members": { + "timerId": {}, + "control": {}, + "startToFireTimeout": {} + } + }, + "cancelTimerDecisionAttributes": { + "type": "structure", + "required": [ + "timerId" + ], + "members": { + "timerId": {} + } + }, + "signalExternalWorkflowExecutionDecisionAttributes": { + "type": "structure", + "required": [ + "workflowId", + "signalName" + ], + "members": { + "workflowId": {}, + "runId": {}, + "signalName": {}, + "input": {}, + "control": {} + } + }, + "requestCancelExternalWorkflowExecutionDecisionAttributes": { + "type": "structure", + "required": [ + "workflowId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "control": {} + } + }, + "startChildWorkflowExecutionDecisionAttributes": { + "type": "structure", + "required": [ + "workflowType", + "workflowId" + ], + "members": { + "workflowType": { + "shape": "Sr" + }, + "workflowId": {}, + "control": {}, + "input": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "tagList": { + "shape": "S1b" + }, + "lambdaRole": {} + } + }, + "scheduleLambdaFunctionDecisionAttributes": { + "type": "structure", + "required": [ + "id", + "name" + ], + "members": { + "id": {}, + "name": {}, + "control": {}, + "input": {}, + "startToCloseTimeout": {} + } + } + } + } + }, + "executionContext": {} + } + } + }, + "SignalWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId", + "signalName" + ], + "members": { + "domain": {}, + "workflowId": {}, + "runId": {}, + "signalName": {}, + "input": {} + } + } + }, + "StartWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId", + "workflowType" + ], + "members": { + "domain": {}, + "workflowId": {}, + "workflowType": { + "shape": "Sr" + }, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "input": {}, + "executionStartToCloseTimeout": {}, + "tagList": { + "shape": "S1b" + }, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "lambdaRole": {} + } + }, + "output": { + "type": "structure", + "members": { + "runId": {} + } + } + }, + "TerminateWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId" + ], + "members": { + "domain": {}, + "workflowId": {}, + "runId": {}, + "reason": {}, + "details": {}, + "childPolicy": {} + } + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "required": [ + "oldestDate" + ], + "members": { + "oldestDate": { + "type": "timestamp" + }, + "latestDate": { + "type": "timestamp" + } + } + }, + "S5": { + "type": "structure", + "required": [ + "workflowId" + ], + "members": { + "workflowId": {} + } + }, + "S7": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "version": {} + } + }, + "Sa": { + "type": "structure", + "required": [ + "tag" + ], + "members": { + "tag": {} + } + }, + "Sc": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {} + } + }, + "Se": { + "type": "structure", + "required": [ + "count" + ], + "members": { + "count": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + } + } + }, + "Sj": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "Sk": { + "type": "structure", + "required": [ + "count" + ], + "members": { + "count": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": {}, + "version": {} + } + }, + "Sr": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": {}, + "version": {} + } + }, + "Su": { + "type": "structure", + "required": [ + "activityType", + "status", + "creationDate" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "status": {}, + "description": {}, + "creationDate": { + "type": "timestamp" + }, + "deprecationDate": { + "type": "timestamp" + } + } + }, + "S12": { + "type": "structure", + "required": [ + "name", + "status" + ], + "members": { + "name": {}, + "status": {}, + "description": {} + } + }, + "S16": { + "type": "structure", + "required": [ + "workflowId", + "runId" + ], + "members": { + "workflowId": {}, + "runId": {} + } + }, + "S19": { + "type": "structure", + "required": [ + "execution", + "workflowType", + "startTimestamp", + "executionStatus" + ], + "members": { + "execution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "startTimestamp": { + "type": "timestamp" + }, + "closeTimestamp": { + "type": "timestamp" + }, + "executionStatus": {}, + "closeStatus": {}, + "parent": { + "shape": "S16" + }, + "tagList": { + "shape": "S1b" + }, + "cancelRequested": { + "type": "boolean" + } + } + }, + "S1b": { + "type": "list", + "member": {} + }, + "S1m": { + "type": "structure", + "required": [ + "workflowType", + "status", + "creationDate" + ], + "members": { + "workflowType": { + "shape": "Sr" + }, + "status": {}, + "description": {}, + "creationDate": { + "type": "timestamp" + }, + "deprecationDate": { + "type": "timestamp" + } + } + }, + "S1t": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "eventTimestamp", + "eventType", + "eventId" + ], + "members": { + "eventTimestamp": { + "type": "timestamp" + }, + "eventType": {}, + "eventId": { + "type": "long" + }, + "workflowExecutionStartedEventAttributes": { + "type": "structure", + "required": [ + "childPolicy", + "taskList", + "workflowType" + ], + "members": { + "input": {}, + "executionStartToCloseTimeout": {}, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "workflowType": { + "shape": "Sr" + }, + "tagList": { + "shape": "S1b" + }, + "continuedExecutionRunId": {}, + "parentWorkflowExecution": { + "shape": "S16" + }, + "parentInitiatedEventId": { + "type": "long" + }, + "lambdaRole": {} + } + }, + "workflowExecutionCompletedEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId" + ], + "members": { + "result": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "completeWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId" + ], + "members": { + "reason": {}, + "details": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "failWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionTimedOutEventAttributes": { + "type": "structure", + "required": [ + "timeoutType", + "childPolicy" + ], + "members": { + "timeoutType": {}, + "childPolicy": {} + } + }, + "workflowExecutionCanceledEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId" + ], + "members": { + "details": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "cancelWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionContinuedAsNewEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId", + "newExecutionRunId", + "taskList", + "childPolicy", + "workflowType" + ], + "members": { + "input": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "newExecutionRunId": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "tagList": { + "shape": "S1b" + }, + "workflowType": { + "shape": "Sr" + }, + "lambdaRole": {} + } + }, + "continueAsNewWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionTerminatedEventAttributes": { + "type": "structure", + "required": [ + "childPolicy" + ], + "members": { + "reason": {}, + "details": {}, + "childPolicy": {}, + "cause": {} + } + }, + "workflowExecutionCancelRequestedEventAttributes": { + "type": "structure", + "members": { + "externalWorkflowExecution": { + "shape": "S16" + }, + "externalInitiatedEventId": { + "type": "long" + }, + "cause": {} + } + }, + "decisionTaskScheduledEventAttributes": { + "type": "structure", + "required": [ + "taskList" + ], + "members": { + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "startToCloseTimeout": {} + } + }, + "decisionTaskStartedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId" + ], + "members": { + "identity": {}, + "scheduledEventId": { + "type": "long" + } + } + }, + "decisionTaskCompletedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "executionContext": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "decisionTaskTimedOutEventAttributes": { + "type": "structure", + "required": [ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members": { + "timeoutType": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "activityTaskScheduledEventAttributes": { + "type": "structure", + "required": [ + "activityType", + "activityId", + "taskList", + "decisionTaskCompletedEventId" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "activityId": {}, + "input": {}, + "control": {}, + "scheduleToStartTimeout": {}, + "scheduleToCloseTimeout": {}, + "startToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "heartbeatTimeout": {} + } + }, + "activityTaskStartedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId" + ], + "members": { + "identity": {}, + "scheduledEventId": { + "type": "long" + } + } + }, + "activityTaskCompletedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "result": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "activityTaskFailedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "reason": {}, + "details": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "activityTaskTimedOutEventAttributes": { + "type": "structure", + "required": [ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members": { + "timeoutType": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + }, + "details": {} + } + }, + "activityTaskCanceledEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "details": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + }, + "latestCancelRequestedEventId": { + "type": "long" + } + } + }, + "activityTaskCancelRequestedEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId", + "activityId" + ], + "members": { + "decisionTaskCompletedEventId": { + "type": "long" + }, + "activityId": {} + } + }, + "workflowExecutionSignaledEventAttributes": { + "type": "structure", + "required": [ + "signalName" + ], + "members": { + "signalName": {}, + "input": {}, + "externalWorkflowExecution": { + "shape": "S16" + }, + "externalInitiatedEventId": { + "type": "long" + } + } + }, + "markerRecordedEventAttributes": { + "type": "structure", + "required": [ + "markerName", + "decisionTaskCompletedEventId" + ], + "members": { + "markerName": {}, + "details": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "recordMarkerFailedEventAttributes": { + "type": "structure", + "required": [ + "markerName", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "markerName": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "timerStartedEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "startToFireTimeout", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "control": {}, + "startToFireTimeout": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "timerFiredEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "startedEventId" + ], + "members": { + "timerId": {}, + "startedEventId": { + "type": "long" + } + } + }, + "timerCanceledEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "startedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "startedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "startChildWorkflowExecutionInitiatedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "workflowType", + "taskList", + "decisionTaskCompletedEventId", + "childPolicy" + ], + "members": { + "workflowId": {}, + "workflowType": { + "shape": "Sr" + }, + "control": {}, + "input": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskPriority": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "childPolicy": {}, + "taskStartToCloseTimeout": {}, + "tagList": { + "shape": "S1b" + }, + "lambdaRole": {} + } + }, + "childWorkflowExecutionStartedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "initiatedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionCompletedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "result": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "reason": {}, + "details": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionTimedOutEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "timeoutType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "timeoutType": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionCanceledEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "details": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionTerminatedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "workflowType": { + "shape": "Sr" + }, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "signalExternalWorkflowExecutionInitiatedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "signalName", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "signalName": {}, + "input": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "externalWorkflowExecutionSignaledEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "initiatedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "initiatedEventId": { + "type": "long" + } + } + }, + "signalExternalWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "cause": {}, + "initiatedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "externalWorkflowExecutionCancelRequestedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "initiatedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S16" + }, + "initiatedEventId": { + "type": "long" + } + } + }, + "requestCancelExternalWorkflowExecutionInitiatedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "requestCancelExternalWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "cause": {}, + "initiatedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "scheduleActivityTaskFailedEventAttributes": { + "type": "structure", + "required": [ + "activityType", + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "activityId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "requestCancelActivityTaskFailedEventAttributes": { + "type": "structure", + "required": [ + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "activityId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "startTimerFailedEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "cancelTimerFailedEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "startChildWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowType", + "cause", + "workflowId", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowType": { + "shape": "Sr" + }, + "cause": {}, + "workflowId": {}, + "initiatedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "lambdaFunctionScheduledEventAttributes": { + "type": "structure", + "required": [ + "id", + "name", + "decisionTaskCompletedEventId" + ], + "members": { + "id": {}, + "name": {}, + "control": {}, + "input": {}, + "startToCloseTimeout": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "lambdaFunctionStartedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId" + ], + "members": { + "scheduledEventId": { + "type": "long" + } + } + }, + "lambdaFunctionCompletedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + }, + "result": {} + } + }, + "lambdaFunctionFailedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + }, + "reason": {}, + "details": {} + } + }, + "lambdaFunctionTimedOutEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + }, + "timeoutType": {} + } + }, + "scheduleLambdaFunctionFailedEventAttributes": { + "type": "structure", + "required": [ + "id", + "name", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "id": {}, + "name": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "startLambdaFunctionFailedEventAttributes": { + "type": "structure", + "members": { + "scheduledEventId": { + "type": "long" + }, + "cause": {}, + "message": {} + } + } + } + } + }, + "S4g": { + "type": "structure", + "required": [ + "executionInfos" + ], + "members": { + "executionInfos": { + "type": "list", + "member": { + "shape": "S19" + } + }, + "nextPageToken": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/swf-2012-01-25.paginators.json b/node_modules/aws-sdk/apis/swf-2012-01-25.paginators.json new file mode 100644 index 0000000..86cec20 --- /dev/null +++ b/node_modules/aws-sdk/apis/swf-2012-01-25.paginators.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "GetWorkflowExecutionHistory": { + "input_token": "nextPageToken", + "limit_key": "maximumPageSize", + "output_token": "nextPageToken", + "result_key": "events" + }, + "ListActivityTypes": { + "input_token": "nextPageToken", + "limit_key": "maximumPageSize", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "ListClosedWorkflowExecutions": { + "input_token": "nextPageToken", + "limit_key": "maximumPageSize", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListDomains": { + "input_token": "nextPageToken", + "limit_key": "maximumPageSize", + "output_token": "nextPageToken", + "result_key": "domainInfos" + }, + "ListOpenWorkflowExecutions": { + "input_token": "nextPageToken", + "limit_key": "maximumPageSize", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListWorkflowTypes": { + "input_token": "nextPageToken", + "limit_key": "maximumPageSize", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "PollForDecisionTask": { + "input_token": "nextPageToken", + "limit_key": "maximumPageSize", + "output_token": "nextPageToken", + "result_key": "events" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/textract-2018-06-27.examples.json b/node_modules/aws-sdk/apis/textract-2018-06-27.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/textract-2018-06-27.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/textract-2018-06-27.min.json b/node_modules/aws-sdk/apis/textract-2018-06-27.min.json new file mode 100644 index 0000000..ec7d0bf --- /dev/null +++ b/node_modules/aws-sdk/apis/textract-2018-06-27.min.json @@ -0,0 +1,334 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-06-27", + "endpointPrefix": "textract", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Textract", + "serviceId": "Textract", + "signatureVersion": "v4", + "targetPrefix": "Textract", + "uid": "textract-2018-06-27" + }, + "operations": { + "AnalyzeDocument": { + "input": { + "type": "structure", + "required": [ + "Document", + "FeatureTypes" + ], + "members": { + "Document": { + "shape": "S2" + }, + "FeatureTypes": { + "shape": "S8" + } + } + }, + "output": { + "type": "structure", + "members": { + "DocumentMetadata": { + "shape": "Sb" + }, + "Blocks": { + "shape": "Sd" + } + } + } + }, + "DetectDocumentText": { + "input": { + "type": "structure", + "required": [ + "Document" + ], + "members": { + "Document": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "DocumentMetadata": { + "shape": "Sb" + }, + "Blocks": { + "shape": "Sd" + } + } + } + }, + "GetDocumentAnalysis": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentMetadata": { + "shape": "Sb" + }, + "JobStatus": {}, + "NextToken": {}, + "Blocks": { + "shape": "Sd" + }, + "Warnings": { + "shape": "S13" + }, + "StatusMessage": {} + } + } + }, + "GetDocumentTextDetection": { + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "DocumentMetadata": { + "shape": "Sb" + }, + "JobStatus": {}, + "NextToken": {}, + "Blocks": { + "shape": "Sd" + }, + "Warnings": { + "shape": "S13" + }, + "StatusMessage": {} + } + } + }, + "StartDocumentAnalysis": { + "input": { + "type": "structure", + "required": [ + "DocumentLocation", + "FeatureTypes" + ], + "members": { + "DocumentLocation": { + "shape": "S1b" + }, + "FeatureTypes": { + "shape": "S8" + }, + "ClientRequestToken": {}, + "JobTag": {}, + "NotificationChannel": { + "shape": "S1e" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + } + }, + "StartDocumentTextDetection": { + "input": { + "type": "structure", + "required": [ + "DocumentLocation" + ], + "members": { + "DocumentLocation": { + "shape": "S1b" + }, + "ClientRequestToken": {}, + "JobTag": {}, + "NotificationChannel": { + "shape": "S1e" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobId": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "members": { + "Bytes": { + "type": "blob" + }, + "S3Object": { + "shape": "S4" + } + } + }, + "S4": { + "type": "structure", + "members": { + "Bucket": {}, + "Name": {}, + "Version": {} + } + }, + "S8": { + "type": "list", + "member": {} + }, + "Sb": { + "type": "structure", + "members": { + "Pages": { + "type": "integer" + } + } + }, + "Sd": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BlockType": {}, + "Confidence": { + "type": "float" + }, + "Text": {}, + "RowIndex": { + "type": "integer" + }, + "ColumnIndex": { + "type": "integer" + }, + "RowSpan": { + "type": "integer" + }, + "ColumnSpan": { + "type": "integer" + }, + "Geometry": { + "type": "structure", + "members": { + "BoundingBox": { + "type": "structure", + "members": { + "Width": { + "type": "float" + }, + "Height": { + "type": "float" + }, + "Left": { + "type": "float" + }, + "Top": { + "type": "float" + } + } + }, + "Polygon": { + "type": "list", + "member": { + "type": "structure", + "members": { + "X": { + "type": "float" + }, + "Y": { + "type": "float" + } + } + } + } + } + }, + "Id": {}, + "Relationships": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Ids": { + "type": "list", + "member": {} + } + } + } + }, + "EntityTypes": { + "type": "list", + "member": {} + }, + "SelectionStatus": {}, + "Page": { + "type": "integer" + } + } + } + }, + "S13": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ErrorCode": {}, + "Pages": { + "type": "list", + "member": { + "type": "integer" + } + } + } + } + }, + "S1b": { + "type": "structure", + "members": { + "S3Object": { + "shape": "S4" + } + } + }, + "S1e": { + "type": "structure", + "required": [ + "SNSTopicArn", + "RoleArn" + ], + "members": { + "SNSTopicArn": {}, + "RoleArn": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/textract-2018-06-27.paginators.json b/node_modules/aws-sdk/apis/textract-2018-06-27.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/textract-2018-06-27.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/transcribe-2017-10-26.examples.json b/node_modules/aws-sdk/apis/transcribe-2017-10-26.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/transcribe-2017-10-26.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json b/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json new file mode 100644 index 0000000..789f580 --- /dev/null +++ b/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json @@ -0,0 +1,304 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-10-26", + "endpointPrefix": "transcribe", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Transcribe Service", + "serviceId": "Transcribe", + "signatureVersion": "v4", + "signingName": "transcribe", + "targetPrefix": "Transcribe", + "uid": "transcribe-2017-10-26" + }, + "operations": { + "CreateVocabulary": { + "input": { + "type": "structure", + "required": [ + "VocabularyName", + "LanguageCode" + ], + "members": { + "VocabularyName": {}, + "LanguageCode": {}, + "Phrases": { + "shape": "S4" + }, + "VocabularyFileUri": {} + } + }, + "output": { + "type": "structure", + "members": { + "VocabularyName": {}, + "LanguageCode": {}, + "VocabularyState": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FailureReason": {} + } + } + }, + "DeleteTranscriptionJob": { + "input": { + "type": "structure", + "required": [ + "TranscriptionJobName" + ], + "members": { + "TranscriptionJobName": {} + } + } + }, + "DeleteVocabulary": { + "input": { + "type": "structure", + "required": [ + "VocabularyName" + ], + "members": { + "VocabularyName": {} + } + } + }, + "GetTranscriptionJob": { + "input": { + "type": "structure", + "required": [ + "TranscriptionJobName" + ], + "members": { + "TranscriptionJobName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TranscriptionJob": { + "shape": "Sg" + } + } + } + }, + "GetVocabulary": { + "input": { + "type": "structure", + "required": [ + "VocabularyName" + ], + "members": { + "VocabularyName": {} + } + }, + "output": { + "type": "structure", + "members": { + "VocabularyName": {}, + "LanguageCode": {}, + "VocabularyState": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "FailureReason": {}, + "DownloadUri": {} + } + } + }, + "ListTranscriptionJobs": { + "input": { + "type": "structure", + "members": { + "Status": {}, + "JobNameContains": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": {}, + "NextToken": {}, + "TranscriptionJobSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TranscriptionJobName": {}, + "CreationTime": { + "type": "timestamp" + }, + "CompletionTime": { + "type": "timestamp" + }, + "LanguageCode": {}, + "TranscriptionJobStatus": {}, + "FailureReason": {}, + "OutputLocationType": {} + } + } + } + } + } + }, + "ListVocabularies": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "StateEquals": {}, + "NameContains": {} + } + }, + "output": { + "type": "structure", + "members": { + "Status": {}, + "NextToken": {}, + "Vocabularies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VocabularyName": {}, + "LanguageCode": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "VocabularyState": {} + } + } + } + } + } + }, + "StartTranscriptionJob": { + "input": { + "type": "structure", + "required": [ + "TranscriptionJobName", + "LanguageCode", + "MediaFormat", + "Media" + ], + "members": { + "TranscriptionJobName": {}, + "LanguageCode": {}, + "MediaSampleRateHertz": { + "type": "integer" + }, + "MediaFormat": {}, + "Media": { + "shape": "Sk" + }, + "OutputBucketName": {}, + "Settings": { + "shape": "Sm" + } + } + }, + "output": { + "type": "structure", + "members": { + "TranscriptionJob": { + "shape": "Sg" + } + } + } + }, + "UpdateVocabulary": { + "input": { + "type": "structure", + "required": [ + "VocabularyName", + "LanguageCode" + ], + "members": { + "VocabularyName": {}, + "LanguageCode": {}, + "Phrases": { + "shape": "S4" + }, + "VocabularyFileUri": {} + } + }, + "output": { + "type": "structure", + "members": { + "VocabularyName": {}, + "LanguageCode": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "VocabularyState": {} + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": {} + }, + "Sg": { + "type": "structure", + "members": { + "TranscriptionJobName": {}, + "TranscriptionJobStatus": {}, + "LanguageCode": {}, + "MediaSampleRateHertz": { + "type": "integer" + }, + "MediaFormat": {}, + "Media": { + "shape": "Sk" + }, + "Transcript": { + "type": "structure", + "members": { + "TranscriptFileUri": {} + } + }, + "CreationTime": { + "type": "timestamp" + }, + "CompletionTime": { + "type": "timestamp" + }, + "FailureReason": {}, + "Settings": { + "shape": "Sm" + } + } + }, + "Sk": { + "type": "structure", + "members": { + "MediaFileUri": {} + } + }, + "Sm": { + "type": "structure", + "members": { + "VocabularyName": {}, + "ShowSpeakerLabels": { + "type": "boolean" + }, + "MaxSpeakerLabels": { + "type": "integer" + }, + "ChannelIdentification": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/transcribe-2017-10-26.paginators.json b/node_modules/aws-sdk/apis/transcribe-2017-10-26.paginators.json new file mode 100644 index 0000000..cdf0f1f --- /dev/null +++ b/node_modules/aws-sdk/apis/transcribe-2017-10-26.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "ListTranscriptionJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListVocabularies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/transfer-2018-11-05.examples.json b/node_modules/aws-sdk/apis/transfer-2018-11-05.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/transfer-2018-11-05.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json b/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json new file mode 100644 index 0000000..d04f357 --- /dev/null +++ b/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json @@ -0,0 +1,524 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-11-05", + "endpointPrefix": "transfer", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "AWS Transfer", + "serviceFullName": "AWS Transfer for SFTP", + "serviceId": "Transfer", + "signatureVersion": "v4", + "signingName": "transfer", + "targetPrefix": "TransferService", + "uid": "transfer-2018-11-05" + }, + "operations": { + "CreateServer": { + "input": { + "type": "structure", + "members": { + "EndpointDetails": { + "shape": "S2" + }, + "EndpointType": {}, + "HostKey": {}, + "IdentityProviderDetails": { + "shape": "S6" + }, + "IdentityProviderType": {}, + "LoggingRole": {}, + "Tags": { + "shape": "Sa" + } + } + }, + "output": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "ServerId": {} + } + } + }, + "CreateUser": { + "input": { + "type": "structure", + "required": [ + "Role", + "ServerId", + "UserName" + ], + "members": { + "HomeDirectory": {}, + "Policy": {}, + "Role": {}, + "ServerId": {}, + "SshPublicKeyBody": {}, + "Tags": { + "shape": "Sa" + }, + "UserName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ServerId", + "UserName" + ], + "members": { + "ServerId": {}, + "UserName": {} + } + } + }, + "DeleteServer": { + "input": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "ServerId": {} + } + } + }, + "DeleteSshPublicKey": { + "input": { + "type": "structure", + "required": [ + "ServerId", + "SshPublicKeyId", + "UserName" + ], + "members": { + "ServerId": {}, + "SshPublicKeyId": {}, + "UserName": {} + } + } + }, + "DeleteUser": { + "input": { + "type": "structure", + "required": [ + "ServerId", + "UserName" + ], + "members": { + "ServerId": {}, + "UserName": {} + } + } + }, + "DescribeServer": { + "input": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "ServerId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Server" + ], + "members": { + "Server": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {}, + "EndpointDetails": { + "shape": "S2" + }, + "EndpointType": {}, + "HostKeyFingerprint": {}, + "IdentityProviderDetails": { + "shape": "S6" + }, + "IdentityProviderType": {}, + "LoggingRole": {}, + "ServerId": {}, + "State": {}, + "Tags": { + "shape": "Sa" + }, + "UserCount": { + "type": "integer" + } + } + } + } + } + }, + "DescribeUser": { + "input": { + "type": "structure", + "required": [ + "ServerId", + "UserName" + ], + "members": { + "ServerId": {}, + "UserName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ServerId", + "User" + ], + "members": { + "ServerId": {}, + "User": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {}, + "HomeDirectory": {}, + "Policy": {}, + "Role": {}, + "SshPublicKeys": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DateImported", + "SshPublicKeyBody", + "SshPublicKeyId" + ], + "members": { + "DateImported": { + "type": "timestamp" + }, + "SshPublicKeyBody": {}, + "SshPublicKeyId": {} + } + } + }, + "Tags": { + "shape": "Sa" + }, + "UserName": {} + } + } + } + } + }, + "ImportSshPublicKey": { + "input": { + "type": "structure", + "required": [ + "ServerId", + "SshPublicKeyBody", + "UserName" + ], + "members": { + "ServerId": {}, + "SshPublicKeyBody": {}, + "UserName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ServerId", + "SshPublicKeyId", + "UserName" + ], + "members": { + "ServerId": {}, + "SshPublicKeyId": {}, + "UserName": {} + } + } + }, + "ListServers": { + "input": { + "type": "structure", + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Servers" + ], + "members": { + "NextToken": {}, + "Servers": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {}, + "IdentityProviderType": {}, + "EndpointType": {}, + "LoggingRole": {}, + "ServerId": {}, + "State": {}, + "UserCount": { + "type": "integer" + } + } + } + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Arn": {}, + "NextToken": {}, + "Tags": { + "shape": "Sa" + } + } + } + }, + "ListUsers": { + "input": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "ServerId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ServerId", + "Users" + ], + "members": { + "NextToken": {}, + "ServerId": {}, + "Users": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Arn" + ], + "members": { + "Arn": {}, + "HomeDirectory": {}, + "Role": {}, + "SshPublicKeyCount": { + "type": "integer" + }, + "UserName": {} + } + } + } + } + } + }, + "StartServer": { + "input": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "ServerId": {} + } + } + }, + "StopServer": { + "input": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "ServerId": {} + } + } + }, + "TagResource": { + "input": { + "type": "structure", + "required": [ + "Arn", + "Tags" + ], + "members": { + "Arn": {}, + "Tags": { + "shape": "Sa" + } + } + } + }, + "TestIdentityProvider": { + "input": { + "type": "structure", + "required": [ + "ServerId", + "UserName" + ], + "members": { + "ServerId": {}, + "UserName": {}, + "UserPassword": {} + } + }, + "output": { + "type": "structure", + "required": [ + "StatusCode", + "Url" + ], + "members": { + "Message": {}, + "StatusCode": { + "type": "integer" + }, + "Url": {} + } + } + }, + "UntagResource": { + "input": { + "type": "structure", + "required": [ + "Arn", + "TagKeys" + ], + "members": { + "Arn": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "UpdateServer": { + "input": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "EndpointDetails": { + "shape": "S2" + }, + "EndpointType": {}, + "HostKey": {}, + "IdentityProviderDetails": { + "shape": "S6" + }, + "LoggingRole": {}, + "ServerId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ServerId" + ], + "members": { + "ServerId": {} + } + } + }, + "UpdateUser": { + "input": { + "type": "structure", + "required": [ + "ServerId", + "UserName" + ], + "members": { + "HomeDirectory": {}, + "Policy": {}, + "Role": {}, + "ServerId": {}, + "UserName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ServerId", + "UserName" + ], + "members": { + "ServerId": {}, + "UserName": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "members": { + "VpcEndpointId": {} + } + }, + "S6": { + "type": "structure", + "members": { + "Url": {}, + "InvocationRole": {} + } + }, + "Sa": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/transfer-2018-11-05.paginators.json b/node_modules/aws-sdk/apis/transfer-2018-11-05.paginators.json new file mode 100644 index 0000000..fabd797 --- /dev/null +++ b/node_modules/aws-sdk/apis/transfer-2018-11-05.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "ListServers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListUsers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/translate-2017-07-01.examples.json b/node_modules/aws-sdk/apis/translate-2017-07-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/translate-2017-07-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/translate-2017-07-01.min.json b/node_modules/aws-sdk/apis/translate-2017-07-01.min.json new file mode 100644 index 0000000..cb41805 --- /dev/null +++ b/node_modules/aws-sdk/apis/translate-2017-07-01.min.json @@ -0,0 +1,215 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-07-01", + "endpointPrefix": "translate", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon Translate", + "serviceId": "Translate", + "signatureVersion": "v4", + "signingName": "translate", + "targetPrefix": "AWSShineFrontendService_20170701", + "uid": "translate-2017-07-01" + }, + "operations": { + "DeleteTerminology": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + } + }, + "GetTerminology": { + "input": { + "type": "structure", + "required": [ + "Name", + "TerminologyDataFormat" + ], + "members": { + "Name": {}, + "TerminologyDataFormat": {} + } + }, + "output": { + "type": "structure", + "members": { + "TerminologyProperties": { + "shape": "S6" + }, + "TerminologyDataLocation": { + "type": "structure", + "required": [ + "RepositoryType", + "Location" + ], + "members": { + "RepositoryType": {}, + "Location": {} + } + } + } + } + }, + "ImportTerminology": { + "input": { + "type": "structure", + "required": [ + "Name", + "MergeStrategy", + "TerminologyData" + ], + "members": { + "Name": {}, + "MergeStrategy": {}, + "Description": {}, + "TerminologyData": { + "type": "structure", + "required": [ + "File", + "Format" + ], + "members": { + "File": { + "type": "blob", + "sensitive": true + }, + "Format": {} + } + }, + "EncryptionKey": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "TerminologyProperties": { + "shape": "S6" + } + } + } + }, + "ListTerminologies": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TerminologyPropertiesList": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "NextToken": {} + } + } + }, + "TranslateText": { + "input": { + "type": "structure", + "required": [ + "Text", + "SourceLanguageCode", + "TargetLanguageCode" + ], + "members": { + "Text": {}, + "TerminologyNames": { + "type": "list", + "member": {} + }, + "SourceLanguageCode": {}, + "TargetLanguageCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "TranslatedText", + "SourceLanguageCode", + "TargetLanguageCode" + ], + "members": { + "TranslatedText": {}, + "SourceLanguageCode": {}, + "TargetLanguageCode": {}, + "AppliedTerminologies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Terms": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SourceText": {}, + "TargetText": {} + } + } + } + } + } + } + } + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "Arn": {}, + "SourceLanguageCode": {}, + "TargetLanguageCodes": { + "type": "list", + "member": {} + }, + "EncryptionKey": { + "shape": "Sb" + }, + "SizeBytes": { + "type": "integer" + }, + "TermCount": { + "type": "integer" + }, + "CreatedAt": { + "type": "timestamp" + }, + "LastUpdatedAt": { + "type": "timestamp" + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "Type", + "Id" + ], + "members": { + "Type": {}, + "Id": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/translate-2017-07-01.paginators.json b/node_modules/aws-sdk/apis/translate-2017-07-01.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/translate-2017-07-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/waf-2015-08-24.examples.json b/node_modules/aws-sdk/apis/waf-2015-08-24.examples.json new file mode 100644 index 0000000..eee5b6f --- /dev/null +++ b/node_modules/aws-sdk/apis/waf-2015-08-24.examples.json @@ -0,0 +1,1017 @@ +{ + "version": "1.0", + "examples": { + "CreateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an IP match set named MyIPSetFriendlyName.", + "id": "createipset-1472501003122", + "title": "To create an IP set" + } + ], + "CreateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "WAFRule-1-Example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a rule named WAFByteHeaderRule.", + "id": "createrule-1474072675555", + "title": "To create a rule" + } + ], + "CreateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleSizeConstraintSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates size constraint set named MySampleSizeConstraintSet.", + "id": "createsizeconstraint-1474299140754", + "title": "To create a size constraint" + } + ], + "CreateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySQLInjectionMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a SQL injection match set named MySQLInjectionMatchSet.", + "id": "createsqlinjectionmatchset-1474492796105", + "title": "To create a SQL injection match set" + } + ], + "CreateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "example-46da-4444-5555-example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a web ACL named CreateExample.", + "id": "createwebacl-1472061481310", + "title": "To create a web ACL" + } + ], + "CreateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleXssMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an XSS match set named MySampleXssMatchSet.", + "id": "createxssmatchset-1474560868500", + "title": "To create an XSS match set" + } + ], + "DeleteByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletebytematchset-1473367566229", + "title": "To delete a byte match set" + } + ], + "DeleteIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deleteipset-1472767434306", + "title": "To delete an IP set" + } + ], + "DeleteRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "WAFRule-1-Example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a rule with the ID WAFRule-1-Example.", + "id": "deleterule-1474073108749", + "title": "To delete a rule" + } + ], + "DeleteSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesizeconstraintset-1474299857905", + "title": "To delete a size constraint set" + } + ], + "DeleteSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesqlinjectionmatchset-1474493373197", + "title": "To delete a SQL injection match set" + } + ], + "DeleteWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACLId": "example-46da-4444-5555-example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a web ACL with the ID example-46da-4444-5555-example.", + "id": "deletewebacl-1472767755931", + "title": "To delete a web ACL" + } + ], + "DeleteXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletexssmatchset-1474561302618", + "title": "To delete an XSS match set" + } + ], + "GetByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ByteMatchSet": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ByteMatchTuples": [ + { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + ], + "Name": "ByteMatchNameExample" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getbytematchset-1473273311532", + "title": "To get a byte match set" + } + ], + "GetChangeToken": [ + { + "input": { + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a change token to use for a create, update or delete operation.", + "id": "get-change-token-example-1471635120794", + "title": "To get a change token" + } + ], + "GetChangeTokenStatus": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeTokenStatus": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.", + "id": "getchangetokenstatus-1474658417107", + "title": "To get the change token status" + } + ], + "GetIPSet": [ + { + "input": { + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getipset-1474658688675", + "title": "To get an IP set" + } + ], + "GetRule": [ + { + "input": { + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getrule-1474659238790", + "title": "To get a rule" + } + ], + "GetSampledRequests": [ + { + "input": { + "MaxItems": 100, + "RuleId": "WAFRule-1-Example", + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T15:50Z" + }, + "WebAclId": "createwebacl-1472061481310" + }, + "output": { + "PopulationSize": 50, + "SampledRequests": [ + { + "Action": "BLOCK", + "Request": { + "ClientIP": "192.0.2.44", + "Country": "US", + "HTTPVersion": "HTTP/1.1", + "Headers": [ + { + "Name": "User-Agent", + "Value": "BadBot " + } + ], + "Method": "HEAD" + }, + "Timestamp": "2016-09-27T14:55Z", + "Weight": 1 + } + ], + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T14:50Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.", + "id": "getsampledrequests-1474927997195", + "title": "To get a sampled requests" + } + ], + "GetSizeConstraintSet": [ + { + "input": { + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsizeconstraintset-1475005422493", + "title": "To get a size constraint set" + } + ], + "GetSqlInjectionMatchSet": [ + { + "input": { + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsqlinjectionmatchset-1475005940137", + "title": "To get a SQL injection match set" + } + ], + "GetWebACL": [ + { + "input": { + "WebACLId": "createwebacl-1472061481310" + }, + "output": { + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "createwebacl-1472061481310" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a web ACL with the ID createwebacl-1472061481310.", + "id": "getwebacl-1475006348525", + "title": "To get a web ACL" + } + ], + "GetXssMatchSet": [ + { + "input": { + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getxssmatchset-1475187879017", + "title": "To get an XSS match set" + } + ], + "ListIPSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "IPSets": [ + { + "IPSetId": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 IP match sets.", + "id": "listipsets-1472235676229", + "title": "To list IP sets" + } + ], + "ListRules": [ + { + "input": { + "Limit": 100 + }, + "output": { + "Rules": [ + { + "Name": "WAFByteHeaderRule", + "RuleId": "WAFRule-1-Example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 rules.", + "id": "listrules-1475258406433", + "title": "To list rules" + } + ], + "ListSizeConstraintSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SizeConstraintSets": [ + { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 size contraint match sets.", + "id": "listsizeconstraintsets-1474300067597", + "title": "To list a size constraint sets" + } + ], + "ListSqlInjectionMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SqlInjectionMatchSets": [ + { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 SQL injection match sets.", + "id": "listsqlinjectionmatchset-1474493560103", + "title": "To list SQL injection match sets" + } + ], + "ListWebACLs": [ + { + "input": { + "Limit": 100 + }, + "output": { + "WebACLs": [ + { + "Name": "WebACLexample", + "WebACLId": "webacl-1472061481310" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 web ACLs.", + "id": "listwebacls-1475258732691", + "title": "To list Web ACLs" + } + ], + "ListXssMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "XssMatchSets": [ + { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 XSS match sets.", + "id": "listxssmatchsets-1474561481168", + "title": "To list XSS match sets" + } + ], + "UpdateByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "ByteMatchTuple": { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatebytematchset-1475259074558", + "title": "To update a byte match set" + } + ], + "UpdateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "IPSetDescriptor": { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updateipset-1475259733625", + "title": "To update an IP set" + } + ], + "UpdateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "Predicate": { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updaterule-1475260064720", + "title": "To update a rule" + } + ], + "UpdateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SizeConstraint": { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesizeconstraintset-1475531697891", + "title": "To update a size constraint set" + } + ], + "UpdateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SqlInjectionMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesqlinjectionmatchset-1475532094686", + "title": "To update a SQL injection match set" + } + ], + "UpdateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "Updates": [ + { + "Action": "DELETE", + "ActivatedRule": { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + } + ], + "WebACLId": "webacl-1472061481310" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.", + "id": "updatewebacl-1475533627385", + "title": "To update a Web ACL" + } + ], + "UpdateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "XssMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ], + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatexssmatchset-1475534098881", + "title": "To update an XSS match set" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/waf-2015-08-24.min.json b/node_modules/aws-sdk/apis/waf-2015-08-24.min.json new file mode 100644 index 0000000..8950000 --- /dev/null +++ b/node_modules/aws-sdk/apis/waf-2015-08-24.min.json @@ -0,0 +1,2268 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-08-24", + "endpointPrefix": "waf", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "WAF", + "serviceFullName": "AWS WAF", + "serviceId": "WAF", + "signatureVersion": "v4", + "targetPrefix": "AWSWAF_20150824", + "uid": "waf-2015-08-24" + }, + "operations": { + "CreateByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ByteMatchSet": { + "shape": "S5" + }, + "ChangeToken": {} + } + } + }, + "CreateGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "GeoMatchSet": { + "shape": "Sh" + }, + "ChangeToken": {} + } + } + }, + "CreateIPSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IPSet": { + "shape": "So" + }, + "ChangeToken": {} + } + } + }, + "CreateRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "RateKey", + "RateLimit", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "RateKey": {}, + "RateLimit": { + "type": "long" + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "Sy" + }, + "ChangeToken": {} + } + } + }, + "CreateRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexMatchSet": { + "shape": "S15" + }, + "ChangeToken": {} + } + } + }, + "CreateRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexPatternSet": { + "shape": "S1a" + }, + "ChangeToken": {} + } + } + }, + "CreateRule": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "S1f" + }, + "ChangeToken": {} + } + } + }, + "CreateRuleGroup": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RuleGroup": { + "shape": "S1i" + }, + "ChangeToken": {} + } + } + }, + "CreateSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SizeConstraintSet": { + "shape": "S1l" + }, + "ChangeToken": {} + } + } + }, + "CreateSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SqlInjectionMatchSet": { + "shape": "S1s" + }, + "ChangeToken": {} + } + } + }, + "CreateWebACL": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "DefaultAction", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "DefaultAction": { + "shape": "S1w" + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WebACL": { + "shape": "S1z" + }, + "ChangeToken": {} + } + } + }, + "CreateXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "XssMatchSet": { + "shape": "S2b" + }, + "ChangeToken": {} + } + } + }, + "DeleteByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "ChangeToken" + ], + "members": { + "ByteMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "ChangeToken" + ], + "members": { + "GeoMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteIPSet": { + "input": { + "type": "structure", + "required": [ + "IPSetId", + "ChangeToken" + ], + "members": { + "IPSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteLoggingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePermissionPolicy": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken" + ], + "members": { + "RuleId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "RegexMatchSetId", + "ChangeToken" + ], + "members": { + "RegexMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "ChangeToken" + ], + "members": { + "RegexPatternSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken" + ], + "members": { + "RuleId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRuleGroup": { + "input": { + "type": "structure", + "required": [ + "RuleGroupId", + "ChangeToken" + ], + "members": { + "RuleGroupId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "ChangeToken" + ], + "members": { + "SizeConstraintSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "ChangeToken" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId", + "ChangeToken" + ], + "members": { + "WebACLId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "XssMatchSetId", + "ChangeToken" + ], + "members": { + "XssMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "GetByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "ByteMatchSetId" + ], + "members": { + "ByteMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ByteMatchSet": { + "shape": "S5" + } + } + } + }, + "GetChangeToken": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "GetChangeTokenStatus": { + "input": { + "type": "structure", + "required": [ + "ChangeToken" + ], + "members": { + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeTokenStatus": {} + } + } + }, + "GetGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "GeoMatchSetId" + ], + "members": { + "GeoMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "GeoMatchSet": { + "shape": "Sh" + } + } + } + }, + "GetIPSet": { + "input": { + "type": "structure", + "required": [ + "IPSetId" + ], + "members": { + "IPSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IPSet": { + "shape": "So" + } + } + } + }, + "GetLoggingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "shape": "S3j" + } + } + } + }, + "GetPermissionPolicy": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {} + } + } + }, + "GetRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "Sy" + } + } + } + }, + "GetRateBasedRuleManagedKeys": { + "input": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {}, + "NextMarker": {} + } + }, + "output": { + "type": "structure", + "members": { + "ManagedKeys": { + "type": "list", + "member": {} + }, + "NextMarker": {} + } + } + }, + "GetRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "RegexMatchSetId" + ], + "members": { + "RegexMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexMatchSet": { + "shape": "S15" + } + } + } + }, + "GetRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "RegexPatternSetId" + ], + "members": { + "RegexPatternSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexPatternSet": { + "shape": "S1a" + } + } + } + }, + "GetRule": { + "input": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "S1f" + } + } + } + }, + "GetRuleGroup": { + "input": { + "type": "structure", + "required": [ + "RuleGroupId" + ], + "members": { + "RuleGroupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RuleGroup": { + "shape": "S1i" + } + } + } + }, + "GetSampledRequests": { + "input": { + "type": "structure", + "required": [ + "WebAclId", + "RuleId", + "TimeWindow", + "MaxItems" + ], + "members": { + "WebAclId": {}, + "RuleId": {}, + "TimeWindow": { + "shape": "S45" + }, + "MaxItems": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "SampledRequests": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Request", + "Weight" + ], + "members": { + "Request": { + "type": "structure", + "members": { + "ClientIP": {}, + "Country": {}, + "URI": {}, + "Method": {}, + "HTTPVersion": {}, + "Headers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Value": {} + } + } + } + } + }, + "Weight": { + "type": "long" + }, + "Timestamp": { + "type": "timestamp" + }, + "Action": {}, + "RuleWithinRuleGroup": {} + } + } + }, + "PopulationSize": { + "type": "long" + }, + "TimeWindow": { + "shape": "S45" + } + } + } + }, + "GetSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "SizeConstraintSetId" + ], + "members": { + "SizeConstraintSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SizeConstraintSet": { + "shape": "S1l" + } + } + } + }, + "GetSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId" + ], + "members": { + "SqlInjectionMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SqlInjectionMatchSet": { + "shape": "S1s" + } + } + } + }, + "GetWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "WebACLId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WebACL": { + "shape": "S1z" + } + } + } + }, + "GetXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "XssMatchSetId" + ], + "members": { + "XssMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "XssMatchSet": { + "shape": "S2b" + } + } + } + }, + "ListActivatedRulesInRuleGroup": { + "input": { + "type": "structure", + "members": { + "RuleGroupId": {}, + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "ActivatedRules": { + "shape": "S20" + } + } + } + }, + "ListByteMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "ByteMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "Name" + ], + "members": { + "ByteMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListGeoMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "GeoMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "Name" + ], + "members": { + "GeoMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListIPSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "IPSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IPSetId", + "Name" + ], + "members": { + "IPSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListLoggingConfigurations": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoggingConfigurations": { + "type": "list", + "member": { + "shape": "S3j" + } + }, + "NextMarker": {} + } + } + }, + "ListRateBasedRules": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Rules": { + "shape": "S5g" + } + } + } + }, + "ListRegexMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RegexMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegexMatchSetId", + "Name" + ], + "members": { + "RegexMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListRegexPatternSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RegexPatternSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "Name" + ], + "members": { + "RegexPatternSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListRuleGroups": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RuleGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleGroupId", + "Name" + ], + "members": { + "RuleGroupId": {}, + "Name": {} + } + } + } + } + } + }, + "ListRules": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Rules": { + "shape": "S5g" + } + } + } + }, + "ListSizeConstraintSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "SizeConstraintSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "Name" + ], + "members": { + "SizeConstraintSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListSqlInjectionMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "SqlInjectionMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "Name" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListSubscribedRuleGroups": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RuleGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleGroupId", + "Name", + "MetricName" + ], + "members": { + "RuleGroupId": {}, + "Name": {}, + "MetricName": {} + } + } + } + } + } + }, + "ListWebACLs": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "WebACLs": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "WebACLId", + "Name" + ], + "members": { + "WebACLId": {}, + "Name": {} + } + } + } + } + } + }, + "ListXssMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "XssMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "XssMatchSetId", + "Name" + ], + "members": { + "XssMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "PutLoggingConfiguration": { + "input": { + "type": "structure", + "required": [ + "LoggingConfiguration" + ], + "members": { + "LoggingConfiguration": { + "shape": "S3j" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "shape": "S3j" + } + } + } + }, + "PutPermissionPolicy": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Policy" + ], + "members": { + "ResourceArn": {}, + "Policy": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "ByteMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "ByteMatchTuple" + ], + "members": { + "Action": {}, + "ByteMatchTuple": { + "shape": "S8" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "GeoMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "GeoMatchConstraint" + ], + "members": { + "Action": {}, + "GeoMatchConstraint": { + "shape": "Sj" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateIPSet": { + "input": { + "type": "structure", + "required": [ + "IPSetId", + "ChangeToken", + "Updates" + ], + "members": { + "IPSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "IPSetDescriptor" + ], + "members": { + "Action": {}, + "IPSetDescriptor": { + "shape": "Sq" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken", + "Updates", + "RateLimit" + ], + "members": { + "RuleId": {}, + "ChangeToken": {}, + "Updates": { + "shape": "S6y" + }, + "RateLimit": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "RegexMatchSetId", + "Updates", + "ChangeToken" + ], + "members": { + "RegexMatchSetId": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "RegexMatchTuple" + ], + "members": { + "Action": {}, + "RegexMatchTuple": { + "shape": "S17" + } + } + } + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "Updates", + "ChangeToken" + ], + "members": { + "RegexPatternSetId": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "RegexPatternString" + ], + "members": { + "Action": {}, + "RegexPatternString": {} + } + } + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken", + "Updates" + ], + "members": { + "RuleId": {}, + "ChangeToken": {}, + "Updates": { + "shape": "S6y" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRuleGroup": { + "input": { + "type": "structure", + "required": [ + "RuleGroupId", + "Updates", + "ChangeToken" + ], + "members": { + "RuleGroupId": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "ActivatedRule" + ], + "members": { + "Action": {}, + "ActivatedRule": { + "shape": "S21" + } + } + } + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "ChangeToken", + "Updates" + ], + "members": { + "SizeConstraintSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "SizeConstraint" + ], + "members": { + "Action": {}, + "SizeConstraint": { + "shape": "S1n" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "SqlInjectionMatchTuple" + ], + "members": { + "Action": {}, + "SqlInjectionMatchTuple": { + "shape": "S1u" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId", + "ChangeToken" + ], + "members": { + "WebACLId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "ActivatedRule" + ], + "members": { + "Action": {}, + "ActivatedRule": { + "shape": "S21" + } + } + } + }, + "DefaultAction": { + "shape": "S1w" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "XssMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "XssMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "XssMatchTuple" + ], + "members": { + "Action": {}, + "XssMatchTuple": { + "shape": "S2d" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "ByteMatchTuples" + ], + "members": { + "ByteMatchSetId": {}, + "Name": {}, + "ByteMatchTuples": { + "type": "list", + "member": { + "shape": "S8" + } + } + } + }, + "S8": { + "type": "structure", + "required": [ + "FieldToMatch", + "TargetString", + "TextTransformation", + "PositionalConstraint" + ], + "members": { + "FieldToMatch": { + "shape": "S9" + }, + "TargetString": { + "type": "blob" + }, + "TextTransformation": {}, + "PositionalConstraint": {} + } + }, + "S9": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "Data": {} + } + }, + "Sh": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "GeoMatchConstraints" + ], + "members": { + "GeoMatchSetId": {}, + "Name": {}, + "GeoMatchConstraints": { + "type": "list", + "member": { + "shape": "Sj" + } + } + } + }, + "Sj": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": {} + } + }, + "So": { + "type": "structure", + "required": [ + "IPSetId", + "IPSetDescriptors" + ], + "members": { + "IPSetId": {}, + "Name": {}, + "IPSetDescriptors": { + "type": "list", + "member": { + "shape": "Sq" + } + } + } + }, + "Sq": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": {} + } + }, + "Sy": { + "type": "structure", + "required": [ + "RuleId", + "MatchPredicates", + "RateKey", + "RateLimit" + ], + "members": { + "RuleId": {}, + "Name": {}, + "MetricName": {}, + "MatchPredicates": { + "shape": "Sz" + }, + "RateKey": {}, + "RateLimit": { + "type": "long" + } + } + }, + "Sz": { + "type": "list", + "member": { + "shape": "S10" + } + }, + "S10": { + "type": "structure", + "required": [ + "Negated", + "Type", + "DataId" + ], + "members": { + "Negated": { + "type": "boolean" + }, + "Type": {}, + "DataId": {} + } + }, + "S15": { + "type": "structure", + "members": { + "RegexMatchSetId": {}, + "Name": {}, + "RegexMatchTuples": { + "type": "list", + "member": { + "shape": "S17" + } + } + } + }, + "S17": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation", + "RegexPatternSetId" + ], + "members": { + "FieldToMatch": { + "shape": "S9" + }, + "TextTransformation": {}, + "RegexPatternSetId": {} + } + }, + "S1a": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "RegexPatternStrings" + ], + "members": { + "RegexPatternSetId": {}, + "Name": {}, + "RegexPatternStrings": { + "type": "list", + "member": {} + } + } + }, + "S1f": { + "type": "structure", + "required": [ + "RuleId", + "Predicates" + ], + "members": { + "RuleId": {}, + "Name": {}, + "MetricName": {}, + "Predicates": { + "shape": "Sz" + } + } + }, + "S1i": { + "type": "structure", + "required": [ + "RuleGroupId" + ], + "members": { + "RuleGroupId": {}, + "Name": {}, + "MetricName": {} + } + }, + "S1l": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "SizeConstraints" + ], + "members": { + "SizeConstraintSetId": {}, + "Name": {}, + "SizeConstraints": { + "type": "list", + "member": { + "shape": "S1n" + } + } + } + }, + "S1n": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation", + "ComparisonOperator", + "Size" + ], + "members": { + "FieldToMatch": { + "shape": "S9" + }, + "TextTransformation": {}, + "ComparisonOperator": {}, + "Size": { + "type": "long" + } + } + }, + "S1s": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "SqlInjectionMatchTuples" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "Name": {}, + "SqlInjectionMatchTuples": { + "type": "list", + "member": { + "shape": "S1u" + } + } + } + }, + "S1u": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation" + ], + "members": { + "FieldToMatch": { + "shape": "S9" + }, + "TextTransformation": {} + } + }, + "S1w": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + }, + "S1z": { + "type": "structure", + "required": [ + "WebACLId", + "DefaultAction", + "Rules" + ], + "members": { + "WebACLId": {}, + "Name": {}, + "MetricName": {}, + "DefaultAction": { + "shape": "S1w" + }, + "Rules": { + "shape": "S20" + }, + "WebACLArn": {} + } + }, + "S20": { + "type": "list", + "member": { + "shape": "S21" + } + }, + "S21": { + "type": "structure", + "required": [ + "Priority", + "RuleId" + ], + "members": { + "Priority": { + "type": "integer" + }, + "RuleId": {}, + "Action": { + "shape": "S1w" + }, + "OverrideAction": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + }, + "Type": {}, + "ExcludedRules": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {} + } + } + } + } + }, + "S2b": { + "type": "structure", + "required": [ + "XssMatchSetId", + "XssMatchTuples" + ], + "members": { + "XssMatchSetId": {}, + "Name": {}, + "XssMatchTuples": { + "type": "list", + "member": { + "shape": "S2d" + } + } + } + }, + "S2d": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation" + ], + "members": { + "FieldToMatch": { + "shape": "S9" + }, + "TextTransformation": {} + } + }, + "S3j": { + "type": "structure", + "required": [ + "ResourceArn", + "LogDestinationConfigs" + ], + "members": { + "ResourceArn": {}, + "LogDestinationConfigs": { + "type": "list", + "member": {} + }, + "RedactedFields": { + "type": "list", + "member": { + "shape": "S9" + } + } + } + }, + "S45": { + "type": "structure", + "required": [ + "StartTime", + "EndTime" + ], + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + } + } + }, + "S5g": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleId", + "Name" + ], + "members": { + "RuleId": {}, + "Name": {} + } + } + }, + "S6y": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "Predicate" + ], + "members": { + "Action": {}, + "Predicate": { + "shape": "S10" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/waf-2015-08-24.paginators.json b/node_modules/aws-sdk/apis/waf-2015-08-24.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/waf-2015-08-24.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/waf-regional-2016-11-28.examples.json b/node_modules/aws-sdk/apis/waf-regional-2016-11-28.examples.json new file mode 100644 index 0000000..eee5b6f --- /dev/null +++ b/node_modules/aws-sdk/apis/waf-regional-2016-11-28.examples.json @@ -0,0 +1,1017 @@ +{ + "version": "1.0", + "examples": { + "CreateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an IP match set named MyIPSetFriendlyName.", + "id": "createipset-1472501003122", + "title": "To create an IP set" + } + ], + "CreateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "WAFRule-1-Example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a rule named WAFByteHeaderRule.", + "id": "createrule-1474072675555", + "title": "To create a rule" + } + ], + "CreateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleSizeConstraintSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates size constraint set named MySampleSizeConstraintSet.", + "id": "createsizeconstraint-1474299140754", + "title": "To create a size constraint" + } + ], + "CreateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySQLInjectionMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a SQL injection match set named MySQLInjectionMatchSet.", + "id": "createsqlinjectionmatchset-1474492796105", + "title": "To create a SQL injection match set" + } + ], + "CreateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "example-46da-4444-5555-example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a web ACL named CreateExample.", + "id": "createwebacl-1472061481310", + "title": "To create a web ACL" + } + ], + "CreateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleXssMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an XSS match set named MySampleXssMatchSet.", + "id": "createxssmatchset-1474560868500", + "title": "To create an XSS match set" + } + ], + "DeleteByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletebytematchset-1473367566229", + "title": "To delete a byte match set" + } + ], + "DeleteIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deleteipset-1472767434306", + "title": "To delete an IP set" + } + ], + "DeleteRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "WAFRule-1-Example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a rule with the ID WAFRule-1-Example.", + "id": "deleterule-1474073108749", + "title": "To delete a rule" + } + ], + "DeleteSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesizeconstraintset-1474299857905", + "title": "To delete a size constraint set" + } + ], + "DeleteSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesqlinjectionmatchset-1474493373197", + "title": "To delete a SQL injection match set" + } + ], + "DeleteWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACLId": "example-46da-4444-5555-example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a web ACL with the ID example-46da-4444-5555-example.", + "id": "deletewebacl-1472767755931", + "title": "To delete a web ACL" + } + ], + "DeleteXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletexssmatchset-1474561302618", + "title": "To delete an XSS match set" + } + ], + "GetByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ByteMatchSet": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ByteMatchTuples": [ + { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + ], + "Name": "ByteMatchNameExample" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getbytematchset-1473273311532", + "title": "To get a byte match set" + } + ], + "GetChangeToken": [ + { + "input": { + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a change token to use for a create, update or delete operation.", + "id": "get-change-token-example-1471635120794", + "title": "To get a change token" + } + ], + "GetChangeTokenStatus": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeTokenStatus": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.", + "id": "getchangetokenstatus-1474658417107", + "title": "To get the change token status" + } + ], + "GetIPSet": [ + { + "input": { + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getipset-1474658688675", + "title": "To get an IP set" + } + ], + "GetRule": [ + { + "input": { + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getrule-1474659238790", + "title": "To get a rule" + } + ], + "GetSampledRequests": [ + { + "input": { + "MaxItems": 100, + "RuleId": "WAFRule-1-Example", + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T15:50Z" + }, + "WebAclId": "createwebacl-1472061481310" + }, + "output": { + "PopulationSize": 50, + "SampledRequests": [ + { + "Action": "BLOCK", + "Request": { + "ClientIP": "192.0.2.44", + "Country": "US", + "HTTPVersion": "HTTP/1.1", + "Headers": [ + { + "Name": "User-Agent", + "Value": "BadBot " + } + ], + "Method": "HEAD" + }, + "Timestamp": "2016-09-27T14:55Z", + "Weight": 1 + } + ], + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T14:50Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.", + "id": "getsampledrequests-1474927997195", + "title": "To get a sampled requests" + } + ], + "GetSizeConstraintSet": [ + { + "input": { + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsizeconstraintset-1475005422493", + "title": "To get a size constraint set" + } + ], + "GetSqlInjectionMatchSet": [ + { + "input": { + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsqlinjectionmatchset-1475005940137", + "title": "To get a SQL injection match set" + } + ], + "GetWebACL": [ + { + "input": { + "WebACLId": "createwebacl-1472061481310" + }, + "output": { + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "createwebacl-1472061481310" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a web ACL with the ID createwebacl-1472061481310.", + "id": "getwebacl-1475006348525", + "title": "To get a web ACL" + } + ], + "GetXssMatchSet": [ + { + "input": { + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getxssmatchset-1475187879017", + "title": "To get an XSS match set" + } + ], + "ListIPSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "IPSets": [ + { + "IPSetId": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 IP match sets.", + "id": "listipsets-1472235676229", + "title": "To list IP sets" + } + ], + "ListRules": [ + { + "input": { + "Limit": 100 + }, + "output": { + "Rules": [ + { + "Name": "WAFByteHeaderRule", + "RuleId": "WAFRule-1-Example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 rules.", + "id": "listrules-1475258406433", + "title": "To list rules" + } + ], + "ListSizeConstraintSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SizeConstraintSets": [ + { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 size contraint match sets.", + "id": "listsizeconstraintsets-1474300067597", + "title": "To list a size constraint sets" + } + ], + "ListSqlInjectionMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SqlInjectionMatchSets": [ + { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 SQL injection match sets.", + "id": "listsqlinjectionmatchset-1474493560103", + "title": "To list SQL injection match sets" + } + ], + "ListWebACLs": [ + { + "input": { + "Limit": 100 + }, + "output": { + "WebACLs": [ + { + "Name": "WebACLexample", + "WebACLId": "webacl-1472061481310" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 web ACLs.", + "id": "listwebacls-1475258732691", + "title": "To list Web ACLs" + } + ], + "ListXssMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "XssMatchSets": [ + { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 XSS match sets.", + "id": "listxssmatchsets-1474561481168", + "title": "To list XSS match sets" + } + ], + "UpdateByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "ByteMatchTuple": { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatebytematchset-1475259074558", + "title": "To update a byte match set" + } + ], + "UpdateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "IPSetDescriptor": { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updateipset-1475259733625", + "title": "To update an IP set" + } + ], + "UpdateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "Predicate": { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updaterule-1475260064720", + "title": "To update a rule" + } + ], + "UpdateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SizeConstraint": { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesizeconstraintset-1475531697891", + "title": "To update a size constraint set" + } + ], + "UpdateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SqlInjectionMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesqlinjectionmatchset-1475532094686", + "title": "To update a SQL injection match set" + } + ], + "UpdateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "Updates": [ + { + "Action": "DELETE", + "ActivatedRule": { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + } + ], + "WebACLId": "webacl-1472061481310" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.", + "id": "updatewebacl-1475533627385", + "title": "To update a Web ACL" + } + ], + "UpdateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "XssMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ], + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatexssmatchset-1475534098881", + "title": "To update an XSS match set" + } + ] + } +} diff --git a/node_modules/aws-sdk/apis/waf-regional-2016-11-28.min.json b/node_modules/aws-sdk/apis/waf-regional-2016-11-28.min.json new file mode 100644 index 0000000..a9af5ce --- /dev/null +++ b/node_modules/aws-sdk/apis/waf-regional-2016-11-28.min.json @@ -0,0 +1,2343 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-28", + "endpointPrefix": "waf-regional", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "WAF Regional", + "serviceFullName": "AWS WAF Regional", + "serviceId": "WAF Regional", + "signatureVersion": "v4", + "targetPrefix": "AWSWAF_Regional_20161128", + "uid": "waf-regional-2016-11-28" + }, + "operations": { + "AssociateWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId", + "ResourceArn" + ], + "members": { + "WebACLId": {}, + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ByteMatchSet": { + "shape": "S9" + }, + "ChangeToken": {} + } + } + }, + "CreateGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "GeoMatchSet": { + "shape": "Sk" + }, + "ChangeToken": {} + } + } + }, + "CreateIPSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IPSet": { + "shape": "Sr" + }, + "ChangeToken": {} + } + } + }, + "CreateRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "RateKey", + "RateLimit", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "RateKey": {}, + "RateLimit": { + "type": "long" + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "S11" + }, + "ChangeToken": {} + } + } + }, + "CreateRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexMatchSet": { + "shape": "S18" + }, + "ChangeToken": {} + } + } + }, + "CreateRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexPatternSet": { + "shape": "S1d" + }, + "ChangeToken": {} + } + } + }, + "CreateRule": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "S1i" + }, + "ChangeToken": {} + } + } + }, + "CreateRuleGroup": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "RuleGroup": { + "shape": "S1l" + }, + "ChangeToken": {} + } + } + }, + "CreateSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SizeConstraintSet": { + "shape": "S1o" + }, + "ChangeToken": {} + } + } + }, + "CreateSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SqlInjectionMatchSet": { + "shape": "S1v" + }, + "ChangeToken": {} + } + } + }, + "CreateWebACL": { + "input": { + "type": "structure", + "required": [ + "Name", + "MetricName", + "DefaultAction", + "ChangeToken" + ], + "members": { + "Name": {}, + "MetricName": {}, + "DefaultAction": { + "shape": "S1z" + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WebACL": { + "shape": "S22" + }, + "ChangeToken": {} + } + } + }, + "CreateXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "Name", + "ChangeToken" + ], + "members": { + "Name": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "XssMatchSet": { + "shape": "S2d" + }, + "ChangeToken": {} + } + } + }, + "DeleteByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "ChangeToken" + ], + "members": { + "ByteMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "ChangeToken" + ], + "members": { + "GeoMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteIPSet": { + "input": { + "type": "structure", + "required": [ + "IPSetId", + "ChangeToken" + ], + "members": { + "IPSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteLoggingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePermissionPolicy": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken" + ], + "members": { + "RuleId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "RegexMatchSetId", + "ChangeToken" + ], + "members": { + "RegexMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "ChangeToken" + ], + "members": { + "RegexPatternSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken" + ], + "members": { + "RuleId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteRuleGroup": { + "input": { + "type": "structure", + "required": [ + "RuleGroupId", + "ChangeToken" + ], + "members": { + "RuleGroupId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "ChangeToken" + ], + "members": { + "SizeConstraintSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "ChangeToken" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId", + "ChangeToken" + ], + "members": { + "WebACLId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DeleteXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "XssMatchSetId", + "ChangeToken" + ], + "members": { + "XssMatchSetId": {}, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "DisassociateWebACL": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "GetByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "ByteMatchSetId" + ], + "members": { + "ByteMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ByteMatchSet": { + "shape": "S9" + } + } + } + }, + "GetChangeToken": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "GetChangeTokenStatus": { + "input": { + "type": "structure", + "required": [ + "ChangeToken" + ], + "members": { + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeTokenStatus": {} + } + } + }, + "GetGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "GeoMatchSetId" + ], + "members": { + "GeoMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "GeoMatchSet": { + "shape": "Sk" + } + } + } + }, + "GetIPSet": { + "input": { + "type": "structure", + "required": [ + "IPSetId" + ], + "members": { + "IPSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IPSet": { + "shape": "Sr" + } + } + } + }, + "GetLoggingConfiguration": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "shape": "S3n" + } + } + } + }, + "GetPermissionPolicy": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {} + } + } + }, + "GetRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "S11" + } + } + } + }, + "GetRateBasedRuleManagedKeys": { + "input": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {}, + "NextMarker": {} + } + }, + "output": { + "type": "structure", + "members": { + "ManagedKeys": { + "type": "list", + "member": {} + }, + "NextMarker": {} + } + } + }, + "GetRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "RegexMatchSetId" + ], + "members": { + "RegexMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexMatchSet": { + "shape": "S18" + } + } + } + }, + "GetRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "RegexPatternSetId" + ], + "members": { + "RegexPatternSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RegexPatternSet": { + "shape": "S1d" + } + } + } + }, + "GetRule": { + "input": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Rule": { + "shape": "S1i" + } + } + } + }, + "GetRuleGroup": { + "input": { + "type": "structure", + "required": [ + "RuleGroupId" + ], + "members": { + "RuleGroupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "RuleGroup": { + "shape": "S1l" + } + } + } + }, + "GetSampledRequests": { + "input": { + "type": "structure", + "required": [ + "WebAclId", + "RuleId", + "TimeWindow", + "MaxItems" + ], + "members": { + "WebAclId": {}, + "RuleId": {}, + "TimeWindow": { + "shape": "S49" + }, + "MaxItems": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "SampledRequests": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Request", + "Weight" + ], + "members": { + "Request": { + "type": "structure", + "members": { + "ClientIP": {}, + "Country": {}, + "URI": {}, + "Method": {}, + "HTTPVersion": {}, + "Headers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Value": {} + } + } + } + } + }, + "Weight": { + "type": "long" + }, + "Timestamp": { + "type": "timestamp" + }, + "Action": {}, + "RuleWithinRuleGroup": {} + } + } + }, + "PopulationSize": { + "type": "long" + }, + "TimeWindow": { + "shape": "S49" + } + } + } + }, + "GetSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "SizeConstraintSetId" + ], + "members": { + "SizeConstraintSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SizeConstraintSet": { + "shape": "S1o" + } + } + } + }, + "GetSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId" + ], + "members": { + "SqlInjectionMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "SqlInjectionMatchSet": { + "shape": "S1v" + } + } + } + }, + "GetWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "WebACLId": {} + } + }, + "output": { + "type": "structure", + "members": { + "WebACL": { + "shape": "S22" + } + } + } + }, + "GetWebACLForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "WebACLSummary": { + "shape": "S50" + } + } + } + }, + "GetXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "XssMatchSetId" + ], + "members": { + "XssMatchSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "XssMatchSet": { + "shape": "S2d" + } + } + } + }, + "ListActivatedRulesInRuleGroup": { + "input": { + "type": "structure", + "members": { + "RuleGroupId": {}, + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "ActivatedRules": { + "shape": "S23" + } + } + } + }, + "ListByteMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "ByteMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "Name" + ], + "members": { + "ByteMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListGeoMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "GeoMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "Name" + ], + "members": { + "GeoMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListIPSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "IPSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IPSetId", + "Name" + ], + "members": { + "IPSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListLoggingConfigurations": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoggingConfigurations": { + "type": "list", + "member": { + "shape": "S3n" + } + }, + "NextMarker": {} + } + } + }, + "ListRateBasedRules": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Rules": { + "shape": "S5n" + } + } + } + }, + "ListRegexMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RegexMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegexMatchSetId", + "Name" + ], + "members": { + "RegexMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListRegexPatternSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RegexPatternSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "Name" + ], + "members": { + "RegexPatternSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListResourcesForWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "WebACLId": {}, + "ResourceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceArns": { + "type": "list", + "member": {} + } + } + } + }, + "ListRuleGroups": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RuleGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleGroupId", + "Name" + ], + "members": { + "RuleGroupId": {}, + "Name": {} + } + } + } + } + } + }, + "ListRules": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "Rules": { + "shape": "S5n" + } + } + } + }, + "ListSizeConstraintSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "SizeConstraintSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "Name" + ], + "members": { + "SizeConstraintSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListSqlInjectionMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "SqlInjectionMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "Name" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "ListSubscribedRuleGroups": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "RuleGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleGroupId", + "Name", + "MetricName" + ], + "members": { + "RuleGroupId": {}, + "Name": {}, + "MetricName": {} + } + } + } + } + } + }, + "ListWebACLs": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "WebACLs": { + "type": "list", + "member": { + "shape": "S50" + } + } + } + } + }, + "ListXssMatchSets": { + "input": { + "type": "structure", + "members": { + "NextMarker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextMarker": {}, + "XssMatchSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "XssMatchSetId", + "Name" + ], + "members": { + "XssMatchSetId": {}, + "Name": {} + } + } + } + } + } + }, + "PutLoggingConfiguration": { + "input": { + "type": "structure", + "required": [ + "LoggingConfiguration" + ], + "members": { + "LoggingConfiguration": { + "shape": "S3n" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "shape": "S3n" + } + } + } + }, + "PutPermissionPolicy": { + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Policy" + ], + "members": { + "ResourceArn": {}, + "Policy": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateByteMatchSet": { + "input": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "ByteMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "ByteMatchTuple" + ], + "members": { + "Action": {}, + "ByteMatchTuple": { + "shape": "Sb" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateGeoMatchSet": { + "input": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "GeoMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "GeoMatchConstraint" + ], + "members": { + "Action": {}, + "GeoMatchConstraint": { + "shape": "Sm" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateIPSet": { + "input": { + "type": "structure", + "required": [ + "IPSetId", + "ChangeToken", + "Updates" + ], + "members": { + "IPSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "IPSetDescriptor" + ], + "members": { + "Action": {}, + "IPSetDescriptor": { + "shape": "St" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRateBasedRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken", + "Updates", + "RateLimit" + ], + "members": { + "RuleId": {}, + "ChangeToken": {}, + "Updates": { + "shape": "S78" + }, + "RateLimit": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRegexMatchSet": { + "input": { + "type": "structure", + "required": [ + "RegexMatchSetId", + "Updates", + "ChangeToken" + ], + "members": { + "RegexMatchSetId": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "RegexMatchTuple" + ], + "members": { + "Action": {}, + "RegexMatchTuple": { + "shape": "S1a" + } + } + } + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRegexPatternSet": { + "input": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "Updates", + "ChangeToken" + ], + "members": { + "RegexPatternSetId": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "RegexPatternString" + ], + "members": { + "Action": {}, + "RegexPatternString": {} + } + } + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRule": { + "input": { + "type": "structure", + "required": [ + "RuleId", + "ChangeToken", + "Updates" + ], + "members": { + "RuleId": {}, + "ChangeToken": {}, + "Updates": { + "shape": "S78" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateRuleGroup": { + "input": { + "type": "structure", + "required": [ + "RuleGroupId", + "Updates", + "ChangeToken" + ], + "members": { + "RuleGroupId": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "ActivatedRule" + ], + "members": { + "Action": {}, + "ActivatedRule": { + "shape": "S24" + } + } + } + }, + "ChangeToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateSizeConstraintSet": { + "input": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "ChangeToken", + "Updates" + ], + "members": { + "SizeConstraintSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "SizeConstraint" + ], + "members": { + "Action": {}, + "SizeConstraint": { + "shape": "S1q" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateSqlInjectionMatchSet": { + "input": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "SqlInjectionMatchTuple" + ], + "members": { + "Action": {}, + "SqlInjectionMatchTuple": { + "shape": "S1x" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateWebACL": { + "input": { + "type": "structure", + "required": [ + "WebACLId", + "ChangeToken" + ], + "members": { + "WebACLId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "ActivatedRule" + ], + "members": { + "Action": {}, + "ActivatedRule": { + "shape": "S24" + } + } + } + }, + "DefaultAction": { + "shape": "S1z" + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + }, + "UpdateXssMatchSet": { + "input": { + "type": "structure", + "required": [ + "XssMatchSetId", + "ChangeToken", + "Updates" + ], + "members": { + "XssMatchSetId": {}, + "ChangeToken": {}, + "Updates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "XssMatchTuple" + ], + "members": { + "Action": {}, + "XssMatchTuple": { + "shape": "S2f" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ChangeToken": {} + } + } + } + }, + "shapes": { + "S9": { + "type": "structure", + "required": [ + "ByteMatchSetId", + "ByteMatchTuples" + ], + "members": { + "ByteMatchSetId": {}, + "Name": {}, + "ByteMatchTuples": { + "type": "list", + "member": { + "shape": "Sb" + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "FieldToMatch", + "TargetString", + "TextTransformation", + "PositionalConstraint" + ], + "members": { + "FieldToMatch": { + "shape": "Sc" + }, + "TargetString": { + "type": "blob" + }, + "TextTransformation": {}, + "PositionalConstraint": {} + } + }, + "Sc": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {}, + "Data": {} + } + }, + "Sk": { + "type": "structure", + "required": [ + "GeoMatchSetId", + "GeoMatchConstraints" + ], + "members": { + "GeoMatchSetId": {}, + "Name": {}, + "GeoMatchConstraints": { + "type": "list", + "member": { + "shape": "Sm" + } + } + } + }, + "Sm": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": {} + } + }, + "Sr": { + "type": "structure", + "required": [ + "IPSetId", + "IPSetDescriptors" + ], + "members": { + "IPSetId": {}, + "Name": {}, + "IPSetDescriptors": { + "type": "list", + "member": { + "shape": "St" + } + } + } + }, + "St": { + "type": "structure", + "required": [ + "Type", + "Value" + ], + "members": { + "Type": {}, + "Value": {} + } + }, + "S11": { + "type": "structure", + "required": [ + "RuleId", + "MatchPredicates", + "RateKey", + "RateLimit" + ], + "members": { + "RuleId": {}, + "Name": {}, + "MetricName": {}, + "MatchPredicates": { + "shape": "S12" + }, + "RateKey": {}, + "RateLimit": { + "type": "long" + } + } + }, + "S12": { + "type": "list", + "member": { + "shape": "S13" + } + }, + "S13": { + "type": "structure", + "required": [ + "Negated", + "Type", + "DataId" + ], + "members": { + "Negated": { + "type": "boolean" + }, + "Type": {}, + "DataId": {} + } + }, + "S18": { + "type": "structure", + "members": { + "RegexMatchSetId": {}, + "Name": {}, + "RegexMatchTuples": { + "type": "list", + "member": { + "shape": "S1a" + } + } + } + }, + "S1a": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation", + "RegexPatternSetId" + ], + "members": { + "FieldToMatch": { + "shape": "Sc" + }, + "TextTransformation": {}, + "RegexPatternSetId": {} + } + }, + "S1d": { + "type": "structure", + "required": [ + "RegexPatternSetId", + "RegexPatternStrings" + ], + "members": { + "RegexPatternSetId": {}, + "Name": {}, + "RegexPatternStrings": { + "type": "list", + "member": {} + } + } + }, + "S1i": { + "type": "structure", + "required": [ + "RuleId", + "Predicates" + ], + "members": { + "RuleId": {}, + "Name": {}, + "MetricName": {}, + "Predicates": { + "shape": "S12" + } + } + }, + "S1l": { + "type": "structure", + "required": [ + "RuleGroupId" + ], + "members": { + "RuleGroupId": {}, + "Name": {}, + "MetricName": {} + } + }, + "S1o": { + "type": "structure", + "required": [ + "SizeConstraintSetId", + "SizeConstraints" + ], + "members": { + "SizeConstraintSetId": {}, + "Name": {}, + "SizeConstraints": { + "type": "list", + "member": { + "shape": "S1q" + } + } + } + }, + "S1q": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation", + "ComparisonOperator", + "Size" + ], + "members": { + "FieldToMatch": { + "shape": "Sc" + }, + "TextTransformation": {}, + "ComparisonOperator": {}, + "Size": { + "type": "long" + } + } + }, + "S1v": { + "type": "structure", + "required": [ + "SqlInjectionMatchSetId", + "SqlInjectionMatchTuples" + ], + "members": { + "SqlInjectionMatchSetId": {}, + "Name": {}, + "SqlInjectionMatchTuples": { + "type": "list", + "member": { + "shape": "S1x" + } + } + } + }, + "S1x": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation" + ], + "members": { + "FieldToMatch": { + "shape": "Sc" + }, + "TextTransformation": {} + } + }, + "S1z": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + }, + "S22": { + "type": "structure", + "required": [ + "WebACLId", + "DefaultAction", + "Rules" + ], + "members": { + "WebACLId": {}, + "Name": {}, + "MetricName": {}, + "DefaultAction": { + "shape": "S1z" + }, + "Rules": { + "shape": "S23" + }, + "WebACLArn": {} + } + }, + "S23": { + "type": "list", + "member": { + "shape": "S24" + } + }, + "S24": { + "type": "structure", + "required": [ + "Priority", + "RuleId" + ], + "members": { + "Priority": { + "type": "integer" + }, + "RuleId": {}, + "Action": { + "shape": "S1z" + }, + "OverrideAction": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "Type": {} + } + }, + "Type": {}, + "ExcludedRules": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleId" + ], + "members": { + "RuleId": {} + } + } + } + } + }, + "S2d": { + "type": "structure", + "required": [ + "XssMatchSetId", + "XssMatchTuples" + ], + "members": { + "XssMatchSetId": {}, + "Name": {}, + "XssMatchTuples": { + "type": "list", + "member": { + "shape": "S2f" + } + } + } + }, + "S2f": { + "type": "structure", + "required": [ + "FieldToMatch", + "TextTransformation" + ], + "members": { + "FieldToMatch": { + "shape": "Sc" + }, + "TextTransformation": {} + } + }, + "S3n": { + "type": "structure", + "required": [ + "ResourceArn", + "LogDestinationConfigs" + ], + "members": { + "ResourceArn": {}, + "LogDestinationConfigs": { + "type": "list", + "member": {} + }, + "RedactedFields": { + "type": "list", + "member": { + "shape": "Sc" + } + } + } + }, + "S49": { + "type": "structure", + "required": [ + "StartTime", + "EndTime" + ], + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + } + } + }, + "S50": { + "type": "structure", + "required": [ + "WebACLId", + "Name" + ], + "members": { + "WebACLId": {}, + "Name": {} + } + }, + "S5n": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleId", + "Name" + ], + "members": { + "RuleId": {}, + "Name": {} + } + } + }, + "S78": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Action", + "Predicate" + ], + "members": { + "Action": {}, + "Predicate": { + "shape": "S13" + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/waf-regional-2016-11-28.paginators.json b/node_modules/aws-sdk/apis/waf-regional-2016-11-28.paginators.json new file mode 100644 index 0000000..5677bd8 --- /dev/null +++ b/node_modules/aws-sdk/apis/waf-regional-2016-11-28.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/node_modules/aws-sdk/apis/workdocs-2016-05-01.examples.json b/node_modules/aws-sdk/apis/workdocs-2016-05-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/workdocs-2016-05-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/workdocs-2016-05-01.min.json b/node_modules/aws-sdk/apis/workdocs-2016-05-01.min.json new file mode 100644 index 0000000..3576bc4 --- /dev/null +++ b/node_modules/aws-sdk/apis/workdocs-2016-05-01.min.json @@ -0,0 +1,1944 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-05-01", + "endpointPrefix": "workdocs", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon WorkDocs", + "serviceId": "WorkDocs", + "signatureVersion": "v4", + "uid": "workdocs-2016-05-01" + }, + "operations": { + "AbortDocumentVersionUpload": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId", + "VersionId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "VersionId": { + "location": "uri", + "locationName": "VersionId" + } + } + } + }, + "ActivateUser": { + "http": { + "requestUri": "/api/v1/users/{UserId}/activation", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "UserId" + ], + "members": { + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "S8" + } + } + } + }, + "AddResourcePermissions": { + "http": { + "requestUri": "/api/v1/resources/{ResourceId}/permissions", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId", + "Principals" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "Principals": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id", + "Type", + "Role" + ], + "members": { + "Id": {}, + "Type": {}, + "Role": {} + } + } + }, + "NotificationOptions": { + "type": "structure", + "members": { + "SendEmail": { + "type": "boolean" + }, + "EmailMessage": { + "shape": "St" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ShareResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PrincipalId": {}, + "InviteePrincipalId": {}, + "Role": {}, + "Status": {}, + "ShareId": {}, + "StatusMessage": { + "shape": "St" + } + } + } + } + } + } + }, + "CreateComment": { + "http": { + "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId", + "VersionId", + "Text" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "VersionId": { + "location": "uri", + "locationName": "VersionId" + }, + "ParentId": {}, + "ThreadId": {}, + "Text": { + "shape": "S10" + }, + "Visibility": {}, + "NotifyCollaborators": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Comment": { + "shape": "S13" + } + } + } + }, + "CreateCustomMetadata": { + "http": { + "method": "PUT", + "requestUri": "/api/v1/resources/{ResourceId}/customMetadata", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId", + "CustomMetadata" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionid" + }, + "CustomMetadata": { + "shape": "S16" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateFolder": { + "http": { + "requestUri": "/api/v1/folders", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "ParentFolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "Name": {}, + "ParentFolderId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Metadata": { + "shape": "S1d" + } + } + } + }, + "CreateLabels": { + "http": { + "method": "PUT", + "requestUri": "/api/v1/resources/{ResourceId}/labels", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId", + "Labels" + ], + "members": { + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "Labels": { + "shape": "S1g" + }, + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateNotificationSubscription": { + "http": { + "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "Endpoint", + "Protocol", + "SubscriptionType" + ], + "members": { + "OrganizationId": { + "location": "uri", + "locationName": "OrganizationId" + }, + "Endpoint": {}, + "Protocol": {}, + "SubscriptionType": {} + } + }, + "output": { + "type": "structure", + "members": { + "Subscription": { + "shape": "S1p" + } + } + } + }, + "CreateUser": { + "http": { + "requestUri": "/api/v1/users", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "Username", + "GivenName", + "Surname", + "Password" + ], + "members": { + "OrganizationId": {}, + "Username": {}, + "EmailAddress": {}, + "GivenName": {}, + "Surname": {}, + "Password": { + "type": "string", + "sensitive": true + }, + "TimeZoneId": {}, + "StorageRule": { + "shape": "Sj" + }, + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "S8" + } + } + } + }, + "DeactivateUser": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/users/{UserId}/activation", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "UserId" + ], + "members": { + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + } + } + } + }, + "DeleteComment": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId", + "VersionId", + "CommentId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "VersionId": { + "location": "uri", + "locationName": "VersionId" + }, + "CommentId": { + "location": "uri", + "locationName": "CommentId" + } + } + } + }, + "DeleteCustomMetadata": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/resources/{ResourceId}/customMetadata", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "Keys": { + "location": "querystring", + "locationName": "keys", + "type": "list", + "member": {} + }, + "DeleteAll": { + "location": "querystring", + "locationName": "deleteAll", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteDocument": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/documents/{DocumentId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + } + } + } + }, + "DeleteFolder": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/folders/{FolderId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "FolderId": { + "location": "uri", + "locationName": "FolderId" + } + } + } + }, + "DeleteFolderContents": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/folders/{FolderId}/contents", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "FolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "FolderId": { + "location": "uri", + "locationName": "FolderId" + } + } + } + }, + "DeleteLabels": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/resources/{ResourceId}/labels", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "Labels": { + "shape": "S1g", + "location": "querystring", + "locationName": "labels" + }, + "DeleteAll": { + "location": "querystring", + "locationName": "deleteAll", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteNotificationSubscription": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SubscriptionId", + "OrganizationId" + ], + "members": { + "SubscriptionId": { + "location": "uri", + "locationName": "SubscriptionId" + }, + "OrganizationId": { + "location": "uri", + "locationName": "OrganizationId" + } + } + } + }, + "DeleteUser": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/users/{UserId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "UserId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "UserId": { + "location": "uri", + "locationName": "UserId" + } + } + } + }, + "DescribeActivities": { + "http": { + "method": "GET", + "requestUri": "/api/v1/activities", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "StartTime": { + "location": "querystring", + "locationName": "startTime", + "type": "timestamp" + }, + "EndTime": { + "location": "querystring", + "locationName": "endTime", + "type": "timestamp" + }, + "OrganizationId": { + "location": "querystring", + "locationName": "organizationId" + }, + "ActivityTypes": { + "location": "querystring", + "locationName": "activityTypes" + }, + "ResourceId": { + "location": "querystring", + "locationName": "resourceId" + }, + "UserId": { + "location": "querystring", + "locationName": "userId" + }, + "IncludeIndirectActivities": { + "location": "querystring", + "locationName": "includeIndirectActivities", + "type": "boolean" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserActivities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "TimeStamp": { + "type": "timestamp" + }, + "IsIndirectActivity": { + "type": "boolean" + }, + "OrganizationId": {}, + "Initiator": { + "shape": "S2d" + }, + "Participants": { + "type": "structure", + "members": { + "Users": { + "type": "list", + "member": { + "shape": "S2d" + } + }, + "Groups": { + "shape": "S2g" + } + } + }, + "ResourceMetadata": { + "shape": "S2j" + }, + "OriginalParent": { + "shape": "S2j" + }, + "CommentMetadata": { + "type": "structure", + "members": { + "CommentId": {}, + "Contributor": { + "shape": "S8" + }, + "CreatedTimestamp": { + "type": "timestamp" + }, + "CommentStatus": {}, + "RecipientId": {} + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeComments": { + "http": { + "method": "GET", + "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comments", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId", + "VersionId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "VersionId": { + "location": "uri", + "locationName": "VersionId" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Comments": { + "type": "list", + "member": { + "shape": "S13" + } + }, + "Marker": {} + } + } + }, + "DescribeDocumentVersions": { + "http": { + "method": "GET", + "requestUri": "/api/v1/documents/{DocumentId}/versions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Include": { + "location": "querystring", + "locationName": "include" + }, + "Fields": { + "location": "querystring", + "locationName": "fields" + } + } + }, + "output": { + "type": "structure", + "members": { + "DocumentVersions": { + "type": "list", + "member": { + "shape": "S2u" + } + }, + "Marker": {} + } + } + }, + "DescribeFolderContents": { + "http": { + "method": "GET", + "requestUri": "/api/v1/folders/{FolderId}/contents", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "FolderId": { + "location": "uri", + "locationName": "FolderId" + }, + "Sort": { + "location": "querystring", + "locationName": "sort" + }, + "Order": { + "location": "querystring", + "locationName": "order" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "Type": { + "location": "querystring", + "locationName": "type" + }, + "Include": { + "location": "querystring", + "locationName": "include" + } + } + }, + "output": { + "type": "structure", + "members": { + "Folders": { + "shape": "S37" + }, + "Documents": { + "shape": "S38" + }, + "Marker": {} + } + } + }, + "DescribeGroups": { + "http": { + "method": "GET", + "requestUri": "/api/v1/groups", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "SearchQuery" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "SearchQuery": { + "shape": "S3b", + "location": "querystring", + "locationName": "searchQuery" + }, + "OrganizationId": { + "location": "querystring", + "locationName": "organizationId" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Groups": { + "shape": "S2g" + }, + "Marker": {} + } + } + }, + "DescribeNotificationSubscriptions": { + "http": { + "method": "GET", + "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "OrganizationId" + ], + "members": { + "OrganizationId": { + "location": "uri", + "locationName": "OrganizationId" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Subscriptions": { + "type": "list", + "member": { + "shape": "S1p" + } + }, + "Marker": {} + } + } + }, + "DescribeResourcePermissions": { + "http": { + "method": "GET", + "requestUri": "/api/v1/resources/{ResourceId}/permissions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "PrincipalId": { + "location": "querystring", + "locationName": "principalId" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Principals": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Type": {}, + "Roles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Role": {}, + "Type": {} + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeRootFolders": { + "http": { + "method": "GET", + "requestUri": "/api/v1/me/root", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AuthenticationToken" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Folders": { + "shape": "S37" + }, + "Marker": {} + } + } + }, + "DescribeUsers": { + "http": { + "method": "GET", + "requestUri": "/api/v1/users", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "OrganizationId": { + "location": "querystring", + "locationName": "organizationId" + }, + "UserIds": { + "location": "querystring", + "locationName": "userIds" + }, + "Query": { + "shape": "S3b", + "location": "querystring", + "locationName": "query" + }, + "Include": { + "location": "querystring", + "locationName": "include" + }, + "Order": { + "location": "querystring", + "locationName": "order" + }, + "Sort": { + "location": "querystring", + "locationName": "sort" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Fields": { + "location": "querystring", + "locationName": "fields" + } + } + }, + "output": { + "type": "structure", + "members": { + "Users": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "TotalNumberOfUsers": { + "deprecated": true, + "type": "long" + }, + "Marker": {} + } + } + }, + "GetCurrentUser": { + "http": { + "method": "GET", + "requestUri": "/api/v1/me", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "AuthenticationToken" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + } + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "S8" + } + } + } + }, + "GetDocument": { + "http": { + "method": "GET", + "requestUri": "/api/v1/documents/{DocumentId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "IncludeCustomMetadata": { + "location": "querystring", + "locationName": "includeCustomMetadata", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Metadata": { + "shape": "S39" + }, + "CustomMetadata": { + "shape": "S16" + } + } + } + }, + "GetDocumentPath": { + "http": { + "method": "GET", + "requestUri": "/api/v1/documents/{DocumentId}/path", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Fields": { + "location": "querystring", + "locationName": "fields" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Path": { + "shape": "S42" + } + } + } + }, + "GetDocumentVersion": { + "http": { + "method": "GET", + "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId", + "VersionId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "VersionId": { + "location": "uri", + "locationName": "VersionId" + }, + "Fields": { + "location": "querystring", + "locationName": "fields" + }, + "IncludeCustomMetadata": { + "location": "querystring", + "locationName": "includeCustomMetadata", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Metadata": { + "shape": "S2u" + }, + "CustomMetadata": { + "shape": "S16" + } + } + } + }, + "GetFolder": { + "http": { + "method": "GET", + "requestUri": "/api/v1/folders/{FolderId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "FolderId": { + "location": "uri", + "locationName": "FolderId" + }, + "IncludeCustomMetadata": { + "location": "querystring", + "locationName": "includeCustomMetadata", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Metadata": { + "shape": "S1d" + }, + "CustomMetadata": { + "shape": "S16" + } + } + } + }, + "GetFolderPath": { + "http": { + "method": "GET", + "requestUri": "/api/v1/folders/{FolderId}/path", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "FolderId": { + "location": "uri", + "locationName": "FolderId" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Fields": { + "location": "querystring", + "locationName": "fields" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Path": { + "shape": "S42" + } + } + } + }, + "GetResources": { + "http": { + "method": "GET", + "requestUri": "/api/v1/resources", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "UserId": { + "location": "querystring", + "locationName": "userId" + }, + "CollectionType": { + "location": "querystring", + "locationName": "collectionType" + }, + "Limit": { + "location": "querystring", + "locationName": "limit", + "type": "integer" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Folders": { + "shape": "S37" + }, + "Documents": { + "shape": "S38" + }, + "Marker": {} + } + } + }, + "InitiateDocumentVersionUpload": { + "http": { + "requestUri": "/api/v1/documents", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "ParentFolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "Id": {}, + "Name": {}, + "ContentCreatedTimestamp": { + "type": "timestamp" + }, + "ContentModifiedTimestamp": { + "type": "timestamp" + }, + "ContentType": {}, + "DocumentSizeInBytes": { + "type": "long" + }, + "ParentFolderId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Metadata": { + "shape": "S39" + }, + "UploadMetadata": { + "type": "structure", + "members": { + "UploadUrl": { + "shape": "S2z" + }, + "SignedHeaders": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + }, + "RemoveAllResourcePermissions": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/resources/{ResourceId}/permissions", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + } + } + } + }, + "RemoveResourcePermission": { + "http": { + "method": "DELETE", + "requestUri": "/api/v1/resources/{ResourceId}/permissions/{PrincipalId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "ResourceId", + "PrincipalId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "PrincipalId": { + "location": "uri", + "locationName": "PrincipalId" + }, + "PrincipalType": { + "location": "querystring", + "locationName": "type" + } + } + } + }, + "UpdateDocument": { + "http": { + "method": "PATCH", + "requestUri": "/api/v1/documents/{DocumentId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "Name": {}, + "ParentFolderId": {}, + "ResourceState": {} + } + } + }, + "UpdateDocumentVersion": { + "http": { + "method": "PATCH", + "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "DocumentId", + "VersionId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "DocumentId": { + "location": "uri", + "locationName": "DocumentId" + }, + "VersionId": { + "location": "uri", + "locationName": "VersionId" + }, + "VersionStatus": {} + } + } + }, + "UpdateFolder": { + "http": { + "method": "PATCH", + "requestUri": "/api/v1/folders/{FolderId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "FolderId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "FolderId": { + "location": "uri", + "locationName": "FolderId" + }, + "Name": {}, + "ParentFolderId": {}, + "ResourceState": {} + } + } + }, + "UpdateUser": { + "http": { + "method": "PATCH", + "requestUri": "/api/v1/users/{UserId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "UserId" + ], + "members": { + "AuthenticationToken": { + "shape": "S2", + "location": "header", + "locationName": "Authentication" + }, + "UserId": { + "location": "uri", + "locationName": "UserId" + }, + "GivenName": {}, + "Surname": {}, + "Type": {}, + "StorageRule": { + "shape": "Sj" + }, + "TimeZoneId": {}, + "Locale": {}, + "GrantPoweruserPrivileges": {} + } + }, + "output": { + "type": "structure", + "members": { + "User": { + "shape": "S8" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "string", + "sensitive": true + }, + "S8": { + "type": "structure", + "members": { + "Id": {}, + "Username": {}, + "EmailAddress": {}, + "GivenName": {}, + "Surname": {}, + "OrganizationId": {}, + "RootFolderId": {}, + "RecycleBinFolderId": {}, + "Status": {}, + "Type": {}, + "CreatedTimestamp": { + "type": "timestamp" + }, + "ModifiedTimestamp": { + "type": "timestamp" + }, + "TimeZoneId": {}, + "Locale": {}, + "Storage": { + "type": "structure", + "members": { + "StorageUtilizedInBytes": { + "type": "long" + }, + "StorageRule": { + "shape": "Sj" + } + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "StorageAllocatedInBytes": { + "type": "long" + }, + "StorageType": {} + } + }, + "St": { + "type": "string", + "sensitive": true + }, + "S10": { + "type": "string", + "sensitive": true + }, + "S13": { + "type": "structure", + "required": [ + "CommentId" + ], + "members": { + "CommentId": {}, + "ParentId": {}, + "ThreadId": {}, + "Text": { + "shape": "S10" + }, + "Contributor": { + "shape": "S8" + }, + "CreatedTimestamp": { + "type": "timestamp" + }, + "Status": {}, + "Visibility": {}, + "RecipientId": {} + } + }, + "S16": { + "type": "map", + "key": {}, + "value": {} + }, + "S1d": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "CreatorId": {}, + "ParentFolderId": {}, + "CreatedTimestamp": { + "type": "timestamp" + }, + "ModifiedTimestamp": { + "type": "timestamp" + }, + "ResourceState": {}, + "Signature": {}, + "Labels": { + "shape": "S1g" + }, + "Size": { + "type": "long" + }, + "LatestVersionSize": { + "type": "long" + } + } + }, + "S1g": { + "type": "list", + "member": {} + }, + "S1p": { + "type": "structure", + "members": { + "SubscriptionId": {}, + "EndPoint": {}, + "Protocol": {} + } + }, + "S2d": { + "type": "structure", + "members": { + "Id": {}, + "Username": {}, + "GivenName": {}, + "Surname": {}, + "EmailAddress": {} + } + }, + "S2g": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {} + } + } + }, + "S2j": { + "type": "structure", + "members": { + "Type": {}, + "Name": {}, + "OriginalName": {}, + "Id": {}, + "VersionId": {}, + "Owner": { + "shape": "S2d" + }, + "ParentId": {} + } + }, + "S2u": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "ContentType": {}, + "Size": { + "type": "long" + }, + "Signature": {}, + "Status": {}, + "CreatedTimestamp": { + "type": "timestamp" + }, + "ModifiedTimestamp": { + "type": "timestamp" + }, + "ContentCreatedTimestamp": { + "type": "timestamp" + }, + "ContentModifiedTimestamp": { + "type": "timestamp" + }, + "CreatorId": {}, + "Thumbnail": { + "type": "map", + "key": {}, + "value": { + "shape": "S2z" + } + }, + "Source": { + "type": "map", + "key": {}, + "value": { + "shape": "S2z" + } + } + } + }, + "S2z": { + "type": "string", + "sensitive": true + }, + "S37": { + "type": "list", + "member": { + "shape": "S1d" + } + }, + "S38": { + "type": "list", + "member": { + "shape": "S39" + } + }, + "S39": { + "type": "structure", + "members": { + "Id": {}, + "CreatorId": {}, + "ParentFolderId": {}, + "CreatedTimestamp": { + "type": "timestamp" + }, + "ModifiedTimestamp": { + "type": "timestamp" + }, + "LatestVersionMetadata": { + "shape": "S2u" + }, + "ResourceState": {}, + "Labels": { + "shape": "S1g" + } + } + }, + "S3b": { + "type": "string", + "sensitive": true + }, + "S42": { + "type": "structure", + "members": { + "Components": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {} + } + } + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/workdocs-2016-05-01.paginators.json b/node_modules/aws-sdk/apis/workdocs-2016-05-01.paginators.json new file mode 100644 index 0000000..42c39b2 --- /dev/null +++ b/node_modules/aws-sdk/apis/workdocs-2016-05-01.paginators.json @@ -0,0 +1,25 @@ +{ + "pagination": { + "DescribeDocumentVersions": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "DocumentVersions" + }, + "DescribeFolderContents": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": [ + "Folders", + "Documents" + ] + }, + "DescribeUsers": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Users" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/worklink-2018-09-25.examples.json b/node_modules/aws-sdk/apis/worklink-2018-09-25.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/worklink-2018-09-25.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/worklink-2018-09-25.min.json b/node_modules/aws-sdk/apis/worklink-2018-09-25.min.json new file mode 100644 index 0000000..76da88b --- /dev/null +++ b/node_modules/aws-sdk/apis/worklink-2018-09-25.min.json @@ -0,0 +1,704 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-09-25", + "endpointPrefix": "worklink", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "WorkLink", + "serviceFullName": "Amazon WorkLink", + "serviceId": "WorkLink", + "signatureVersion": "v4", + "signingName": "worklink", + "uid": "worklink-2018-09-25" + }, + "operations": { + "AssociateDomain": { + "http": { + "requestUri": "/associateDomain" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "DomainName", + "AcmCertificateArn" + ], + "members": { + "FleetArn": {}, + "DomainName": {}, + "AcmCertificateArn": {}, + "DisplayName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AssociateWebsiteCertificateAuthority": { + "http": { + "requestUri": "/associateWebsiteCertificateAuthority" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "Certificate" + ], + "members": { + "FleetArn": {}, + "Certificate": {}, + "DisplayName": {} + } + }, + "output": { + "type": "structure", + "members": { + "WebsiteCaId": {} + } + } + }, + "CreateFleet": { + "http": { + "requestUri": "/createFleet" + }, + "input": { + "type": "structure", + "required": [ + "FleetName" + ], + "members": { + "FleetName": {}, + "DisplayName": {}, + "OptimizeForEndUserLocation": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "FleetArn": {} + } + } + }, + "DeleteFleet": { + "http": { + "requestUri": "/deleteFleet" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeAuditStreamConfiguration": { + "http": { + "requestUri": "/describeAuditStreamConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "AuditStreamArn": {} + } + } + }, + "DescribeCompanyNetworkConfiguration": { + "http": { + "requestUri": "/describeCompanyNetworkConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "VpcId": {}, + "SubnetIds": { + "shape": "Sn" + }, + "SecurityGroupIds": { + "shape": "Sp" + } + } + } + }, + "DescribeDevice": { + "http": { + "requestUri": "/describeDevice" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "DeviceId" + ], + "members": { + "FleetArn": {}, + "DeviceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Status": {}, + "Model": {}, + "Manufacturer": {}, + "OperatingSystem": {}, + "OperatingSystemVersion": {}, + "PatchLevel": {}, + "FirstAccessedTime": { + "type": "timestamp" + }, + "LastAccessedTime": { + "type": "timestamp" + }, + "Username": {} + } + } + }, + "DescribeDevicePolicyConfiguration": { + "http": { + "requestUri": "/describeDevicePolicyConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "DeviceCaCertificate": {} + } + } + }, + "DescribeDomain": { + "http": { + "requestUri": "/describeDomain" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "DomainName" + ], + "members": { + "FleetArn": {}, + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": { + "DisplayName": {}, + "CreatedTime": { + "type": "timestamp" + }, + "DomainStatus": {} + } + } + }, + "DescribeFleetMetadata": { + "http": { + "requestUri": "/describeFleetMetadata" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "CreatedTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + }, + "FleetName": {}, + "DisplayName": {}, + "OptimizeForEndUserLocation": { + "type": "boolean" + }, + "CompanyCode": {}, + "FleetStatus": {} + } + } + }, + "DescribeIdentityProviderConfiguration": { + "http": { + "requestUri": "/describeIdentityProviderConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityProviderType": {}, + "ServiceProviderSamlMetadata": {}, + "IdentityProviderSamlMetadata": {} + } + } + }, + "DescribeWebsiteCertificateAuthority": { + "http": { + "requestUri": "/describeWebsiteCertificateAuthority" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "WebsiteCaId" + ], + "members": { + "FleetArn": {}, + "WebsiteCaId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Certificate": {}, + "CreatedTime": { + "type": "timestamp" + }, + "DisplayName": {} + } + } + }, + "DisassociateDomain": { + "http": { + "requestUri": "/disassociateDomain" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "DomainName" + ], + "members": { + "FleetArn": {}, + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DisassociateWebsiteCertificateAuthority": { + "http": { + "requestUri": "/disassociateWebsiteCertificateAuthority" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "WebsiteCaId" + ], + "members": { + "FleetArn": {}, + "WebsiteCaId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListDevices": { + "http": { + "requestUri": "/listDevices" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Devices": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DeviceId": {}, + "DeviceStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListDomains": { + "http": { + "requestUri": "/listDomains" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Domains": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DomainName", + "CreatedTime", + "DomainStatus" + ], + "members": { + "DomainName": {}, + "CreatedTime": { + "type": "timestamp" + }, + "DomainStatus": {}, + "DisplayName": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListFleets": { + "http": { + "requestUri": "/listFleets" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "FleetSummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "FleetArn": {}, + "CreatedTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + }, + "FleetName": {}, + "DisplayName": {}, + "CompanyCode": {}, + "FleetStatus": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListWebsiteCertificateAuthorities": { + "http": { + "requestUri": "/listWebsiteCertificateAuthorities" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WebsiteCertificateAuthorities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WebsiteCaId": {}, + "CreatedTime": { + "type": "timestamp" + }, + "DisplayName": {} + } + } + }, + "NextToken": {} + } + } + }, + "RestoreDomainAccess": { + "http": { + "requestUri": "/restoreDomainAccess" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "DomainName" + ], + "members": { + "FleetArn": {}, + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RevokeDomainAccess": { + "http": { + "requestUri": "/revokeDomainAccess" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "DomainName" + ], + "members": { + "FleetArn": {}, + "DomainName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "SignOutUser": { + "http": { + "requestUri": "/signOutUser" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "Username" + ], + "members": { + "FleetArn": {}, + "Username": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateAuditStreamConfiguration": { + "http": { + "requestUri": "/updateAuditStreamConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {}, + "AuditStreamArn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateCompanyNetworkConfiguration": { + "http": { + "requestUri": "/updateCompanyNetworkConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "VpcId", + "SubnetIds", + "SecurityGroupIds" + ], + "members": { + "FleetArn": {}, + "VpcId": {}, + "SubnetIds": { + "shape": "Sn" + }, + "SecurityGroupIds": { + "shape": "Sp" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDevicePolicyConfiguration": { + "http": { + "requestUri": "/updateDevicePolicyConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {}, + "DeviceCaCertificate": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDomainMetadata": { + "http": { + "requestUri": "/updateDomainMetadata" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "DomainName" + ], + "members": { + "FleetArn": {}, + "DomainName": {}, + "DisplayName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateFleetMetadata": { + "http": { + "requestUri": "/UpdateFleetMetadata" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn" + ], + "members": { + "FleetArn": {}, + "DisplayName": {}, + "OptimizeForEndUserLocation": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateIdentityProviderConfiguration": { + "http": { + "requestUri": "/updateIdentityProviderConfiguration" + }, + "input": { + "type": "structure", + "required": [ + "FleetArn", + "IdentityProviderType" + ], + "members": { + "FleetArn": {}, + "IdentityProviderType": {}, + "IdentityProviderSamlMetadata": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sn": { + "type": "list", + "member": {} + }, + "Sp": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/worklink-2018-09-25.paginators.json b/node_modules/aws-sdk/apis/worklink-2018-09-25.paginators.json new file mode 100644 index 0000000..8ba9a71 --- /dev/null +++ b/node_modules/aws-sdk/apis/worklink-2018-09-25.paginators.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "ListDevices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDomains": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFleets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListWebsiteCertificateAuthorities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/workmail-2017-10-01.examples.json b/node_modules/aws-sdk/apis/workmail-2017-10-01.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/workmail-2017-10-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/workmail-2017-10-01.min.json b/node_modules/aws-sdk/apis/workmail-2017-10-01.min.json new file mode 100644 index 0000000..b416539 --- /dev/null +++ b/node_modules/aws-sdk/apis/workmail-2017-10-01.min.json @@ -0,0 +1,898 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2017-10-01", + "endpointPrefix": "workmail", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon WorkMail", + "serviceId": "WorkMail", + "signatureVersion": "v4", + "targetPrefix": "WorkMailService", + "uid": "workmail-2017-10-01" + }, + "operations": { + "AssociateDelegateToResource": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "ResourceId", + "EntityId" + ], + "members": { + "OrganizationId": {}, + "ResourceId": {}, + "EntityId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "AssociateMemberToGroup": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "GroupId", + "MemberId" + ], + "members": { + "OrganizationId": {}, + "GroupId": {}, + "MemberId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "CreateAlias": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId", + "Alias" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "Alias": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "CreateGroup": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "Name" + ], + "members": { + "OrganizationId": {}, + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "GroupId": {} + } + }, + "idempotent": true + }, + "CreateResource": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "Name", + "Type" + ], + "members": { + "OrganizationId": {}, + "Name": {}, + "Type": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceId": {} + } + }, + "idempotent": true + }, + "CreateUser": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "Name", + "DisplayName", + "Password" + ], + "members": { + "OrganizationId": {}, + "Name": {}, + "DisplayName": {}, + "Password": { + "shape": "Sl" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserId": {} + } + }, + "idempotent": true + }, + "DeleteAlias": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId", + "Alias" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "Alias": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteGroup": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "GroupId" + ], + "members": { + "OrganizationId": {}, + "GroupId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteMailboxPermissions": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId", + "GranteeId" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "GranteeId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteResource": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "ResourceId" + ], + "members": { + "OrganizationId": {}, + "ResourceId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeleteUser": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "UserId" + ], + "members": { + "OrganizationId": {}, + "UserId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DeregisterFromWorkMail": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId" + ], + "members": { + "OrganizationId": {}, + "EntityId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DescribeGroup": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "GroupId" + ], + "members": { + "OrganizationId": {}, + "GroupId": {} + } + }, + "output": { + "type": "structure", + "members": { + "GroupId": {}, + "Name": {}, + "Email": {}, + "State": {}, + "EnabledDate": { + "type": "timestamp" + }, + "DisabledDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DescribeOrganization": { + "input": { + "type": "structure", + "required": [ + "OrganizationId" + ], + "members": { + "OrganizationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "OrganizationId": {}, + "Alias": {}, + "State": {}, + "DirectoryId": {}, + "DirectoryType": {}, + "DefaultMailDomain": {}, + "CompletedDate": { + "type": "timestamp" + }, + "ErrorMessage": {} + } + }, + "idempotent": true + }, + "DescribeResource": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "ResourceId" + ], + "members": { + "OrganizationId": {}, + "ResourceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ResourceId": {}, + "Email": {}, + "Name": {}, + "Type": {}, + "BookingOptions": { + "shape": "S18" + }, + "State": {}, + "EnabledDate": { + "type": "timestamp" + }, + "DisabledDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DescribeUser": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "UserId" + ], + "members": { + "OrganizationId": {}, + "UserId": {} + } + }, + "output": { + "type": "structure", + "members": { + "UserId": {}, + "Name": {}, + "Email": {}, + "DisplayName": {}, + "State": {}, + "UserRole": {}, + "EnabledDate": { + "type": "timestamp" + }, + "DisabledDate": { + "type": "timestamp" + } + } + }, + "idempotent": true + }, + "DisassociateDelegateFromResource": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "ResourceId", + "EntityId" + ], + "members": { + "OrganizationId": {}, + "ResourceId": {}, + "EntityId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DisassociateMemberFromGroup": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "GroupId", + "MemberId" + ], + "members": { + "OrganizationId": {}, + "GroupId": {}, + "MemberId": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "GetMailboxDetails": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "UserId" + ], + "members": { + "OrganizationId": {}, + "UserId": {} + } + }, + "output": { + "type": "structure", + "members": { + "MailboxQuota": { + "type": "integer" + }, + "MailboxSize": { + "type": "double" + } + } + }, + "idempotent": true + }, + "ListAliases": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Aliases": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListGroupMembers": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "GroupId" + ], + "members": { + "OrganizationId": {}, + "GroupId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Members": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Type": {}, + "State": {}, + "EnabledDate": { + "type": "timestamp" + }, + "DisabledDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListGroups": { + "input": { + "type": "structure", + "required": [ + "OrganizationId" + ], + "members": { + "OrganizationId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Groups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Email": {}, + "Name": {}, + "State": {}, + "EnabledDate": { + "type": "timestamp" + }, + "DisabledDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListMailboxPermissions": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Permissions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "GranteeId", + "GranteeType", + "PermissionValues" + ], + "members": { + "GranteeId": {}, + "GranteeType": {}, + "PermissionValues": { + "shape": "S23" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListOrganizations": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "OrganizationSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "OrganizationId": {}, + "Alias": {}, + "ErrorMessage": {}, + "State": {} + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListResourceDelegates": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "ResourceId" + ], + "members": { + "OrganizationId": {}, + "ResourceId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Delegates": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id", + "Type" + ], + "members": { + "Id": {}, + "Type": {} + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListResources": { + "input": { + "type": "structure", + "required": [ + "OrganizationId" + ], + "members": { + "OrganizationId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Resources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Email": {}, + "Name": {}, + "Type": {}, + "State": {}, + "EnabledDate": { + "type": "timestamp" + }, + "DisabledDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "ListUsers": { + "input": { + "type": "structure", + "required": [ + "OrganizationId" + ], + "members": { + "OrganizationId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Users": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Email": {}, + "Name": {}, + "DisplayName": {}, + "State": {}, + "UserRole": {}, + "EnabledDate": { + "type": "timestamp" + }, + "DisabledDate": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + }, + "idempotent": true + }, + "PutMailboxPermissions": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId", + "GranteeId", + "PermissionValues" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "GranteeId": {}, + "PermissionValues": { + "shape": "S23" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "RegisterToWorkMail": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId", + "Email" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "Email": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "ResetPassword": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "UserId", + "Password" + ], + "members": { + "OrganizationId": {}, + "UserId": {}, + "Password": { + "shape": "Sl" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateMailboxQuota": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "UserId", + "MailboxQuota" + ], + "members": { + "OrganizationId": {}, + "UserId": {}, + "MailboxQuota": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdatePrimaryEmailAddress": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "EntityId", + "Email" + ], + "members": { + "OrganizationId": {}, + "EntityId": {}, + "Email": {} + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "UpdateResource": { + "input": { + "type": "structure", + "required": [ + "OrganizationId", + "ResourceId" + ], + "members": { + "OrganizationId": {}, + "ResourceId": {}, + "Name": {}, + "BookingOptions": { + "shape": "S18" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + } + }, + "shapes": { + "Sl": { + "type": "string", + "sensitive": true + }, + "S18": { + "type": "structure", + "members": { + "AutoAcceptRequests": { + "type": "boolean" + }, + "AutoDeclineRecurringRequests": { + "type": "boolean" + }, + "AutoDeclineConflictingRequests": { + "type": "boolean" + } + } + }, + "S23": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/workmail-2017-10-01.paginators.json b/node_modules/aws-sdk/apis/workmail-2017-10-01.paginators.json new file mode 100644 index 0000000..ce5e36b --- /dev/null +++ b/node_modules/aws-sdk/apis/workmail-2017-10-01.paginators.json @@ -0,0 +1,44 @@ +{ + "pagination": { + "ListAliases": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGroupMembers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListMailboxPermissions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListOrganizations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListResourceDelegates": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListUsers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/node_modules/aws-sdk/apis/workspaces-2015-04-08.examples.json b/node_modules/aws-sdk/apis/workspaces-2015-04-08.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/workspaces-2015-04-08.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json b/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json new file mode 100644 index 0000000..1e6606f --- /dev/null +++ b/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json @@ -0,0 +1,987 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2015-04-08", + "endpointPrefix": "workspaces", + "jsonVersion": "1.1", + "protocol": "json", + "serviceFullName": "Amazon WorkSpaces", + "serviceId": "WorkSpaces", + "signatureVersion": "v4", + "targetPrefix": "WorkspacesService", + "uid": "workspaces-2015-04-08" + }, + "operations": { + "AssociateIpGroups": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "GroupIds" + ], + "members": { + "DirectoryId": {}, + "GroupIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "AuthorizeIpRules": { + "input": { + "type": "structure", + "required": [ + "GroupId", + "UserRules" + ], + "members": { + "GroupId": {}, + "UserRules": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateIpGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "GroupDesc": {}, + "UserRules": { + "shape": "S7" + }, + "Tags": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupId": {} + } + } + }, + "CreateTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "Tags" + ], + "members": { + "ResourceId": {}, + "Tags": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateWorkspaces": { + "input": { + "type": "structure", + "required": [ + "Workspaces" + ], + "members": { + "Workspaces": { + "type": "list", + "member": { + "shape": "Sp" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedRequests": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WorkspaceRequest": { + "shape": "Sp" + }, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "PendingRequests": { + "shape": "S15" + } + } + } + }, + "DeleteIpGroup": { + "input": { + "type": "structure", + "required": [ + "GroupId" + ], + "members": { + "GroupId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagKeys" + ], + "members": { + "ResourceId": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteWorkspaceImage": { + "input": { + "type": "structure", + "required": [ + "ImageId" + ], + "members": { + "ImageId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeAccount": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "DedicatedTenancySupport": {}, + "DedicatedTenancyManagementCidrRange": {} + } + } + }, + "DescribeAccountModifications": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "AccountModifications": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ModificationState": {}, + "DedicatedTenancySupport": {}, + "DedicatedTenancyManagementCidrRange": {}, + "StartTime": { + "type": "timestamp" + }, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeClientProperties": { + "input": { + "type": "structure", + "required": [ + "ResourceIds" + ], + "members": { + "ResourceIds": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "ClientPropertiesList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceId": {}, + "ClientProperties": { + "shape": "S25" + } + } + } + } + } + } + }, + "DescribeIpGroups": { + "input": { + "type": "structure", + "members": { + "GroupIds": { + "shape": "S3" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Result": { + "type": "list", + "member": { + "type": "structure", + "members": { + "groupId": {}, + "groupName": {}, + "groupDesc": {}, + "userRules": { + "shape": "S7" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId" + ], + "members": { + "ResourceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "TagList": { + "shape": "Sf" + } + } + } + }, + "DescribeWorkspaceBundles": { + "input": { + "type": "structure", + "members": { + "BundleIds": { + "type": "list", + "member": {} + }, + "Owner": {}, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Bundles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BundleId": {}, + "Name": {}, + "Owner": {}, + "Description": {}, + "RootStorage": { + "type": "structure", + "members": { + "Capacity": {} + } + }, + "UserStorage": { + "type": "structure", + "members": { + "Capacity": {} + } + }, + "ComputeType": { + "type": "structure", + "members": { + "Name": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeWorkspaceDirectories": { + "input": { + "type": "structure", + "members": { + "DirectoryIds": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Directories": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DirectoryId": {}, + "Alias": {}, + "DirectoryName": {}, + "RegistrationCode": {}, + "SubnetIds": { + "type": "list", + "member": {} + }, + "DnsIpAddresses": { + "type": "list", + "member": {} + }, + "CustomerUserName": {}, + "IamRoleId": {}, + "DirectoryType": {}, + "WorkspaceSecurityGroupId": {}, + "State": {}, + "WorkspaceCreationProperties": { + "type": "structure", + "members": { + "EnableWorkDocs": { + "type": "boolean" + }, + "EnableInternetAccess": { + "type": "boolean" + }, + "DefaultOu": {}, + "CustomSecurityGroupId": {}, + "UserEnabledAsLocalAdministrator": { + "type": "boolean" + } + } + }, + "ipGroupIds": { + "shape": "S3" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeWorkspaceImages": { + "input": { + "type": "structure", + "members": { + "ImageIds": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Images": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ImageId": {}, + "Name": {}, + "Description": {}, + "OperatingSystem": { + "type": "structure", + "members": { + "Type": {} + } + }, + "State": {}, + "RequiredTenancy": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeWorkspaces": { + "input": { + "type": "structure", + "members": { + "WorkspaceIds": { + "shape": "S3g" + }, + "DirectoryId": {}, + "UserName": {}, + "BundleId": {}, + "Limit": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Workspaces": { + "shape": "S15" + }, + "NextToken": {} + } + } + }, + "DescribeWorkspacesConnectionStatus": { + "input": { + "type": "structure", + "members": { + "WorkspaceIds": { + "shape": "S3g" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "WorkspacesConnectionStatus": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WorkspaceId": {}, + "ConnectionState": {}, + "ConnectionStateCheckTimestamp": { + "type": "timestamp" + }, + "LastKnownUserConnectionTimestamp": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DisassociateIpGroups": { + "input": { + "type": "structure", + "required": [ + "DirectoryId", + "GroupIds" + ], + "members": { + "DirectoryId": {}, + "GroupIds": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ImportWorkspaceImage": { + "input": { + "type": "structure", + "required": [ + "Ec2ImageId", + "IngestionProcess", + "ImageName", + "ImageDescription" + ], + "members": { + "Ec2ImageId": {}, + "IngestionProcess": {}, + "ImageName": {}, + "ImageDescription": {}, + "Tags": { + "shape": "Sf" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageId": {} + } + } + }, + "ListAvailableManagementCidrRanges": { + "input": { + "type": "structure", + "required": [ + "ManagementCidrRangeConstraint" + ], + "members": { + "ManagementCidrRangeConstraint": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "ManagementCidrRanges": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "ModifyAccount": { + "input": { + "type": "structure", + "members": { + "DedicatedTenancySupport": {}, + "DedicatedTenancyManagementCidrRange": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ModifyClientProperties": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "ClientProperties" + ], + "members": { + "ResourceId": {}, + "ClientProperties": { + "shape": "S25" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ModifyWorkspaceProperties": { + "input": { + "type": "structure", + "required": [ + "WorkspaceId", + "WorkspaceProperties" + ], + "members": { + "WorkspaceId": {}, + "WorkspaceProperties": { + "shape": "Su" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ModifyWorkspaceState": { + "input": { + "type": "structure", + "required": [ + "WorkspaceId", + "WorkspaceState" + ], + "members": { + "WorkspaceId": {}, + "WorkspaceState": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RebootWorkspaces": { + "input": { + "type": "structure", + "required": [ + "RebootWorkspaceRequests" + ], + "members": { + "RebootWorkspaceRequests": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "WorkspaceId" + ], + "members": { + "WorkspaceId": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedRequests": { + "type": "list", + "member": { + "shape": "S4d" + } + } + } + } + }, + "RebuildWorkspaces": { + "input": { + "type": "structure", + "required": [ + "RebuildWorkspaceRequests" + ], + "members": { + "RebuildWorkspaceRequests": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "WorkspaceId" + ], + "members": { + "WorkspaceId": {} + } + } + }, + "AdditionalInfo": {} + } + }, + "output": { + "type": "structure", + "members": { + "FailedRequests": { + "type": "list", + "member": { + "shape": "S4d" + } + } + } + } + }, + "RevokeIpRules": { + "input": { + "type": "structure", + "required": [ + "GroupId", + "UserRules" + ], + "members": { + "GroupId": {}, + "UserRules": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StartWorkspaces": { + "input": { + "type": "structure", + "required": [ + "StartWorkspaceRequests" + ], + "members": { + "StartWorkspaceRequests": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WorkspaceId": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedRequests": { + "type": "list", + "member": { + "shape": "S4d" + } + } + } + } + }, + "StopWorkspaces": { + "input": { + "type": "structure", + "required": [ + "StopWorkspaceRequests" + ], + "members": { + "StopWorkspaceRequests": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WorkspaceId": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedRequests": { + "type": "list", + "member": { + "shape": "S4d" + } + } + } + } + }, + "TerminateWorkspaces": { + "input": { + "type": "structure", + "required": [ + "TerminateWorkspaceRequests" + ], + "members": { + "TerminateWorkspaceRequests": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "WorkspaceId" + ], + "members": { + "WorkspaceId": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedRequests": { + "type": "list", + "member": { + "shape": "S4d" + } + } + } + } + }, + "UpdateRulesOfIpGroup": { + "input": { + "type": "structure", + "required": [ + "GroupId", + "UserRules" + ], + "members": { + "GroupId": {}, + "UserRules": { + "shape": "S7" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S3": { + "type": "list", + "member": {} + }, + "S7": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ipRule": {}, + "ruleDesc": {} + } + } + }, + "Sf": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sp": { + "type": "structure", + "required": [ + "DirectoryId", + "UserName", + "BundleId" + ], + "members": { + "DirectoryId": {}, + "UserName": {}, + "BundleId": {}, + "VolumeEncryptionKey": {}, + "UserVolumeEncryptionEnabled": { + "type": "boolean" + }, + "RootVolumeEncryptionEnabled": { + "type": "boolean" + }, + "WorkspaceProperties": { + "shape": "Su" + }, + "Tags": { + "shape": "Sf" + } + } + }, + "Su": { + "type": "structure", + "members": { + "RunningMode": {}, + "RunningModeAutoStopTimeoutInMinutes": { + "type": "integer" + }, + "RootVolumeSizeGib": { + "type": "integer" + }, + "UserVolumeSizeGib": { + "type": "integer" + }, + "ComputeTypeName": {} + } + }, + "S15": { + "type": "list", + "member": { + "type": "structure", + "members": { + "WorkspaceId": {}, + "DirectoryId": {}, + "UserName": {}, + "IpAddress": {}, + "State": {}, + "BundleId": {}, + "SubnetId": {}, + "ErrorMessage": {}, + "ErrorCode": {}, + "ComputerName": {}, + "VolumeEncryptionKey": {}, + "UserVolumeEncryptionEnabled": { + "type": "boolean" + }, + "RootVolumeEncryptionEnabled": { + "type": "boolean" + }, + "WorkspaceProperties": { + "shape": "Su" + }, + "ModificationStates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Resource": {}, + "State": {} + } + } + } + } + } + }, + "S25": { + "type": "structure", + "members": { + "ReconnectEnabled": {} + } + }, + "S3g": { + "type": "list", + "member": {} + }, + "S4d": { + "type": "structure", + "members": { + "WorkspaceId": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/workspaces-2015-04-08.paginators.json b/node_modules/aws-sdk/apis/workspaces-2015-04-08.paginators.json new file mode 100644 index 0000000..cc7a0c6 --- /dev/null +++ b/node_modules/aws-sdk/apis/workspaces-2015-04-08.paginators.json @@ -0,0 +1,20 @@ +{ + "pagination": { + "DescribeWorkspaceBundles": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Bundles" + }, + "DescribeWorkspaceDirectories": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Directories" + }, + "DescribeWorkspaces": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Workspaces" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/xray-2016-04-12.examples.json b/node_modules/aws-sdk/apis/xray-2016-04-12.examples.json new file mode 100644 index 0000000..0ea7e3b --- /dev/null +++ b/node_modules/aws-sdk/apis/xray-2016-04-12.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/node_modules/aws-sdk/apis/xray-2016-04-12.min.json b/node_modules/aws-sdk/apis/xray-2016-04-12.min.json new file mode 100644 index 0000000..758f3f7 --- /dev/null +++ b/node_modules/aws-sdk/apis/xray-2016-04-12.min.json @@ -0,0 +1,1217 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-04-12", + "endpointPrefix": "xray", + "protocol": "rest-json", + "serviceFullName": "AWS X-Ray", + "serviceId": "XRay", + "signatureVersion": "v4", + "uid": "xray-2016-04-12" + }, + "operations": { + "BatchGetTraces": { + "http": { + "requestUri": "/Traces" + }, + "input": { + "type": "structure", + "required": [ + "TraceIds" + ], + "members": { + "TraceIds": { + "shape": "S2" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Traces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Duration": { + "type": "double" + }, + "Segments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Document": {} + } + } + } + } + } + }, + "UnprocessedTraceIds": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "CreateGroup": { + "http": { + "requestUri": "/CreateGroup" + }, + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "FilterExpression": {} + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "Si" + } + } + } + }, + "CreateSamplingRule": { + "http": { + "requestUri": "/CreateSamplingRule" + }, + "input": { + "type": "structure", + "required": [ + "SamplingRule" + ], + "members": { + "SamplingRule": { + "shape": "Sk" + } + } + }, + "output": { + "type": "structure", + "members": { + "SamplingRuleRecord": { + "shape": "S10" + } + } + } + }, + "DeleteGroup": { + "http": { + "requestUri": "/DeleteGroup" + }, + "input": { + "type": "structure", + "members": { + "GroupName": {}, + "GroupARN": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteSamplingRule": { + "http": { + "requestUri": "/DeleteSamplingRule" + }, + "input": { + "type": "structure", + "members": { + "RuleName": {}, + "RuleARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "SamplingRuleRecord": { + "shape": "S10" + } + } + } + }, + "GetEncryptionConfig": { + "http": { + "requestUri": "/EncryptionConfig" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "EncryptionConfig": { + "shape": "S19" + } + } + } + }, + "GetGroup": { + "http": { + "requestUri": "/GetGroup" + }, + "input": { + "type": "structure", + "members": { + "GroupName": {}, + "GroupARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "Si" + } + } + } + }, + "GetGroups": { + "http": { + "requestUri": "/Groups" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Groups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GroupName": {}, + "GroupARN": {}, + "FilterExpression": {} + } + } + }, + "NextToken": {} + } + } + }, + "GetSamplingRules": { + "http": { + "requestUri": "/GetSamplingRules" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SamplingRuleRecords": { + "type": "list", + "member": { + "shape": "S10" + } + }, + "NextToken": {} + } + } + }, + "GetSamplingStatisticSummaries": { + "http": { + "requestUri": "/SamplingStatisticSummaries" + }, + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "SamplingStatisticSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RuleName": {}, + "Timestamp": { + "type": "timestamp" + }, + "RequestCount": { + "type": "integer" + }, + "BorrowCount": { + "type": "integer" + }, + "SampledCount": { + "type": "integer" + } + } + } + }, + "NextToken": {} + } + } + }, + "GetSamplingTargets": { + "http": { + "requestUri": "/SamplingTargets" + }, + "input": { + "type": "structure", + "required": [ + "SamplingStatisticsDocuments" + ], + "members": { + "SamplingStatisticsDocuments": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RuleName", + "ClientID", + "Timestamp", + "RequestCount", + "SampledCount" + ], + "members": { + "RuleName": {}, + "ClientID": {}, + "Timestamp": { + "type": "timestamp" + }, + "RequestCount": { + "type": "integer" + }, + "SampledCount": { + "type": "integer" + }, + "BorrowCount": { + "type": "integer" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SamplingTargetDocuments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RuleName": {}, + "FixedRate": { + "type": "double" + }, + "ReservoirQuota": { + "type": "integer" + }, + "ReservoirQuotaTTL": { + "type": "timestamp" + }, + "Interval": { + "type": "integer" + } + } + } + }, + "LastRuleModification": { + "type": "timestamp" + }, + "UnprocessedStatistics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RuleName": {}, + "ErrorCode": {}, + "Message": {} + } + } + } + } + } + }, + "GetServiceGraph": { + "http": { + "requestUri": "/ServiceGraph" + }, + "input": { + "type": "structure", + "required": [ + "StartTime", + "EndTime" + ], + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "GroupName": {}, + "GroupARN": {}, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Services": { + "shape": "S27" + }, + "ContainsOldGroupVersions": { + "type": "boolean" + }, + "NextToken": {} + } + } + }, + "GetTimeSeriesServiceStatistics": { + "http": { + "requestUri": "/TimeSeriesServiceStatistics" + }, + "input": { + "type": "structure", + "required": [ + "StartTime", + "EndTime" + ], + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "GroupName": {}, + "GroupARN": {}, + "EntitySelectorExpression": {}, + "Period": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "TimeSeriesServiceStatistics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "timestamp" + }, + "EdgeSummaryStatistics": { + "shape": "S2d" + }, + "ServiceSummaryStatistics": { + "shape": "S2m" + }, + "ResponseTimeHistogram": { + "shape": "S2h" + } + } + } + }, + "ContainsOldGroupVersions": { + "type": "boolean" + }, + "NextToken": {} + } + } + }, + "GetTraceGraph": { + "http": { + "requestUri": "/TraceGraph" + }, + "input": { + "type": "structure", + "required": [ + "TraceIds" + ], + "members": { + "TraceIds": { + "shape": "S2" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "Services": { + "shape": "S27" + }, + "NextToken": {} + } + } + }, + "GetTraceSummaries": { + "http": { + "requestUri": "/TraceSummaries" + }, + "input": { + "type": "structure", + "required": [ + "StartTime", + "EndTime" + ], + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "TimeRangeType": {}, + "Sampling": { + "type": "boolean" + }, + "SamplingStrategy": { + "type": "structure", + "members": { + "Name": {}, + "Value": { + "type": "double" + } + } + }, + "FilterExpression": {}, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "TraceSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Duration": { + "type": "double" + }, + "ResponseTime": { + "type": "double" + }, + "HasFault": { + "type": "boolean" + }, + "HasError": { + "type": "boolean" + }, + "HasThrottle": { + "type": "boolean" + }, + "IsPartial": { + "type": "boolean" + }, + "Http": { + "type": "structure", + "members": { + "HttpURL": {}, + "HttpStatus": { + "type": "integer" + }, + "HttpMethod": {}, + "UserAgent": {}, + "ClientIp": {} + } + }, + "Annotations": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AnnotationValue": { + "type": "structure", + "members": { + "NumberValue": { + "type": "double" + }, + "BooleanValue": { + "type": "boolean" + }, + "StringValue": {} + } + }, + "ServiceIds": { + "shape": "S38" + } + } + } + } + }, + "Users": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UserName": {}, + "ServiceIds": { + "shape": "S38" + } + } + } + }, + "ServiceIds": { + "shape": "S38" + }, + "ResourceARNs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ARN": {} + } + } + }, + "InstanceIds": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {} + } + } + }, + "AvailabilityZones": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "EntryPoint": { + "shape": "S39" + }, + "FaultRootCauses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Services": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Names": { + "shape": "S29" + }, + "Type": {}, + "AccountId": {}, + "EntityPath": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Exceptions": { + "shape": "S3o" + }, + "Remote": { + "type": "boolean" + } + } + } + }, + "Inferred": { + "type": "boolean" + } + } + } + } + } + } + }, + "ErrorRootCauses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Services": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Names": { + "shape": "S29" + }, + "Type": {}, + "AccountId": {}, + "EntityPath": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Exceptions": { + "shape": "S3o" + }, + "Remote": { + "type": "boolean" + } + } + } + }, + "Inferred": { + "type": "boolean" + } + } + } + } + } + } + }, + "ResponseTimeRootCauses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Services": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Names": { + "shape": "S29" + }, + "Type": {}, + "AccountId": {}, + "EntityPath": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Coverage": { + "type": "double" + }, + "Remote": { + "type": "boolean" + } + } + } + }, + "Inferred": { + "type": "boolean" + } + } + } + } + } + } + }, + "Revision": { + "type": "integer" + }, + "MatchedEventTime": { + "type": "timestamp" + } + } + } + }, + "ApproximateTime": { + "type": "timestamp" + }, + "TracesProcessedCount": { + "type": "long" + }, + "NextToken": {} + } + } + }, + "PutEncryptionConfig": { + "http": { + "requestUri": "/PutEncryptionConfig" + }, + "input": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "KeyId": {}, + "Type": {} + } + }, + "output": { + "type": "structure", + "members": { + "EncryptionConfig": { + "shape": "S19" + } + } + } + }, + "PutTelemetryRecords": { + "http": { + "requestUri": "/TelemetryRecords" + }, + "input": { + "type": "structure", + "required": [ + "TelemetryRecords" + ], + "members": { + "TelemetryRecords": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Timestamp" + ], + "members": { + "Timestamp": { + "type": "timestamp" + }, + "SegmentsReceivedCount": { + "type": "integer" + }, + "SegmentsSentCount": { + "type": "integer" + }, + "SegmentsSpilloverCount": { + "type": "integer" + }, + "SegmentsRejectedCount": { + "type": "integer" + }, + "BackendConnectionErrors": { + "type": "structure", + "members": { + "TimeoutCount": { + "type": "integer" + }, + "ConnectionRefusedCount": { + "type": "integer" + }, + "HTTPCode4XXCount": { + "type": "integer" + }, + "HTTPCode5XXCount": { + "type": "integer" + }, + "UnknownHostCount": { + "type": "integer" + }, + "OtherCount": { + "type": "integer" + } + } + } + } + } + }, + "EC2InstanceId": {}, + "Hostname": {}, + "ResourceARN": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "PutTraceSegments": { + "http": { + "requestUri": "/TraceSegments" + }, + "input": { + "type": "structure", + "required": [ + "TraceSegmentDocuments" + ], + "members": { + "TraceSegmentDocuments": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedTraceSegments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "ErrorCode": {}, + "Message": {} + } + } + } + } + } + }, + "UpdateGroup": { + "http": { + "requestUri": "/UpdateGroup" + }, + "input": { + "type": "structure", + "members": { + "GroupName": {}, + "GroupARN": {}, + "FilterExpression": {} + } + }, + "output": { + "type": "structure", + "members": { + "Group": { + "shape": "Si" + } + } + } + }, + "UpdateSamplingRule": { + "http": { + "requestUri": "/UpdateSamplingRule" + }, + "input": { + "type": "structure", + "required": [ + "SamplingRuleUpdate" + ], + "members": { + "SamplingRuleUpdate": { + "type": "structure", + "members": { + "RuleName": {}, + "RuleARN": {}, + "ResourceARN": {}, + "Priority": { + "type": "integer" + }, + "FixedRate": { + "type": "double" + }, + "ReservoirSize": { + "type": "integer" + }, + "Host": {}, + "ServiceName": {}, + "ServiceType": {}, + "HTTPMethod": {}, + "URLPath": {}, + "Attributes": { + "shape": "Sw" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SamplingRuleRecord": { + "shape": "S10" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "Si": { + "type": "structure", + "members": { + "GroupName": {}, + "GroupARN": {}, + "FilterExpression": {} + } + }, + "Sk": { + "type": "structure", + "required": [ + "ResourceARN", + "Priority", + "FixedRate", + "ReservoirSize", + "ServiceName", + "ServiceType", + "Host", + "HTTPMethod", + "URLPath", + "Version" + ], + "members": { + "RuleName": {}, + "RuleARN": {}, + "ResourceARN": {}, + "Priority": { + "type": "integer" + }, + "FixedRate": { + "type": "double" + }, + "ReservoirSize": { + "type": "integer" + }, + "ServiceName": {}, + "ServiceType": {}, + "Host": {}, + "HTTPMethod": {}, + "URLPath": {}, + "Version": { + "type": "integer" + }, + "Attributes": { + "shape": "Sw" + } + } + }, + "Sw": { + "type": "map", + "key": {}, + "value": {} + }, + "S10": { + "type": "structure", + "members": { + "SamplingRule": { + "shape": "Sk" + }, + "CreatedAt": { + "type": "timestamp" + }, + "ModifiedAt": { + "type": "timestamp" + } + } + }, + "S19": { + "type": "structure", + "members": { + "KeyId": {}, + "Status": {}, + "Type": {} + } + }, + "S27": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ReferenceId": { + "type": "integer" + }, + "Name": {}, + "Names": { + "shape": "S29" + }, + "Root": { + "type": "boolean" + }, + "AccountId": {}, + "Type": {}, + "State": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Edges": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ReferenceId": { + "type": "integer" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "SummaryStatistics": { + "shape": "S2d" + }, + "ResponseTimeHistogram": { + "shape": "S2h" + }, + "Aliases": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Names": { + "type": "list", + "member": {} + }, + "Type": {} + } + } + } + } + } + }, + "SummaryStatistics": { + "shape": "S2m" + }, + "DurationHistogram": { + "shape": "S2h" + }, + "ResponseTimeHistogram": { + "shape": "S2h" + } + } + } + }, + "S29": { + "type": "list", + "member": {} + }, + "S2d": { + "type": "structure", + "members": { + "OkCount": { + "type": "long" + }, + "ErrorStatistics": { + "shape": "S2f" + }, + "FaultStatistics": { + "shape": "S2g" + }, + "TotalCount": { + "type": "long" + }, + "TotalResponseTime": { + "type": "double" + } + } + }, + "S2f": { + "type": "structure", + "members": { + "ThrottleCount": { + "type": "long" + }, + "OtherCount": { + "type": "long" + }, + "TotalCount": { + "type": "long" + } + } + }, + "S2g": { + "type": "structure", + "members": { + "OtherCount": { + "type": "long" + }, + "TotalCount": { + "type": "long" + } + } + }, + "S2h": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Value": { + "type": "double" + }, + "Count": { + "type": "integer" + } + } + } + }, + "S2m": { + "type": "structure", + "members": { + "OkCount": { + "type": "long" + }, + "ErrorStatistics": { + "shape": "S2f" + }, + "FaultStatistics": { + "shape": "S2g" + }, + "TotalCount": { + "type": "long" + }, + "TotalResponseTime": { + "type": "double" + } + } + }, + "S38": { + "type": "list", + "member": { + "shape": "S39" + } + }, + "S39": { + "type": "structure", + "members": { + "Name": {}, + "Names": { + "shape": "S29" + }, + "AccountId": {}, + "Type": {} + } + }, + "S3o": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Message": {} + } + } + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/apis/xray-2016-04-12.paginators.json b/node_modules/aws-sdk/apis/xray-2016-04-12.paginators.json new file mode 100644 index 0000000..0b4d3d8 --- /dev/null +++ b/node_modules/aws-sdk/apis/xray-2016-04-12.paginators.json @@ -0,0 +1,59 @@ +{ + "pagination": { + "BatchGetTraces": { + "input_token": "NextToken", + "non_aggregate_keys": [ + "UnprocessedTraceIds" + ], + "output_token": "NextToken", + "result_key": "Traces" + }, + "GetGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Groups" + }, + "GetSamplingRules": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "SamplingRuleRecords" + }, + "GetSamplingStatisticSummaries": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "SamplingStatisticSummaries" + }, + "GetServiceGraph": { + "input_token": "NextToken", + "non_aggregate_keys": [ + "StartTime", + "EndTime", + "ContainsOldGroupVersions" + ], + "output_token": "NextToken", + "result_key": "Services" + }, + "GetTimeSeriesServiceStatistics": { + "input_token": "NextToken", + "non_aggregate_keys": [ + "ContainsOldGroupVersions" + ], + "output_token": "NextToken", + "result_key": "TimeSeriesServiceStatistics" + }, + "GetTraceGraph": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Services" + }, + "GetTraceSummaries": { + "input_token": "NextToken", + "non_aggregate_keys": [ + "TracesProcessedCount", + "ApproximateTime" + ], + "output_token": "NextToken", + "result_key": "TraceSummaries" + } + } +} \ No newline at end of file diff --git a/node_modules/aws-sdk/browser.js b/node_modules/aws-sdk/browser.js new file mode 100644 index 0000000..7867151 --- /dev/null +++ b/node_modules/aws-sdk/browser.js @@ -0,0 +1,6 @@ +require('./lib/browser_loader'); + +var AWS = require('./lib/core'); +if (typeof window !== 'undefined') window.AWS = AWS; +if (typeof module !== 'undefined') module.exports = AWS; +if (typeof self !== 'undefined') self.AWS = AWS; \ No newline at end of file diff --git a/node_modules/aws-sdk/clients/acm.d.ts b/node_modules/aws-sdk/clients/acm.d.ts new file mode 100644 index 0000000..45e5e5a --- /dev/null +++ b/node_modules/aws-sdk/clients/acm.d.ts @@ -0,0 +1,625 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ACM extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ACM.Types.ClientConfiguration) + config: Config & ACM.Types.ClientConfiguration; + /** + * 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 key and an optional value. You specify the certificate 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 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 Tagging ACM certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action. + */ + addTagsToCertificate(params: ACM.Types.AddTagsToCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 key and an optional value. You specify the certificate 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 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 Tagging ACM certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action. + */ + addTagsToCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM. 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. + */ + deleteCertificate(params: ACM.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM. 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. + */ + deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns detailed metadata about the specified ACM certificate. + */ + describeCertificate(params: ACM.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request; + /** + * Returns detailed metadata about the specified ACM certificate. + */ + describeCertificate(callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request; + /** + * 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. openssl rsa -in encrypted_key.pem -out decrypted_key.pem + */ + exportCertificate(params: ACM.Types.ExportCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ExportCertificateResponse) => void): Request; + /** + * 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. openssl rsa -in encrypted_key.pem -out decrypted_key.pem + */ + exportCertificate(callback?: (err: AWSError, data: ACM.Types.ExportCertificateResponse) => void): Request; + /** + * 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. + */ + getCertificate(params: ACM.Types.GetCertificateRequest, callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request; + /** + * 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. + */ + getCertificate(callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request; + /** + * Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services 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 Importing Certificates in the AWS Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. If the certificate you are importing is not self-signed, you must enter its certificate chain. If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain. The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. 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 file://. For example, you can specify a certificate saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. 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. This operation returns the Amazon Resource Name (ARN) of the imported certificate. + */ + importCertificate(params: ACM.Types.ImportCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request; + /** + * Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services 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 Importing Certificates in the AWS Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. If the certificate you are importing is not self-signed, you must enter its certificate chain. If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain. The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. 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 file://. For example, you can specify a certificate saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. 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. This operation returns the Amazon Resource Name (ARN) of the imported certificate. + */ + importCertificate(callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request; + /** + * 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. + */ + listCertificates(params: ACM.Types.ListCertificatesRequest, callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request; + /** + * 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. + */ + listCertificates(callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request; + /** + * 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 AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action. + */ + listTagsForCertificate(params: ACM.Types.ListTagsForCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request; + /** + * 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 AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action. + */ + listTagsForCertificate(callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request; + /** + * 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. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action. + */ + removeTagsFromCertificate(params: ACM.Types.RemoveTagsFromCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action. + */ + removeTagsFromCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide. + */ + renewCertificate(params: ACM.Types.RenewCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide. + */ + renewCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. 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 DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. + */ + requestCertificate(params: ACM.Types.RequestCertificateRequest, callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request; + /** + * 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 DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. 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 DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. + */ + requestCertificate(callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request; + /** + * 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 I Approve. 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 Configure Email for your Domain. + */ + resendValidationEmail(params: ACM.Types.ResendValidationEmailRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 I Approve. 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 Configure Email for your Domain. + */ + resendValidationEmail(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 Opting Out of Certificate Transparency Logging. + */ + updateCertificateOptions(params: ACM.Types.UpdateCertificateOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 Opting Out of Certificate Transparency Logging. + */ + updateCertificateOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the certificateValidated state by periodically calling the underlying ACM.describeCertificateoperation every 60 seconds (at most 40 times). + */ + waitFor(state: "certificateValidated", params: ACM.Types.DescribeCertificateRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request; + /** + * Waits for the certificateValidated state by periodically calling the underlying ACM.describeCertificateoperation every 60 seconds (at most 40 times). + */ + waitFor(state: "certificateValidated", callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request; +} +declare namespace ACM { + export interface AddTagsToCertificateRequest { + /** + * String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn: Arn; + /** + * The key-value pair that defines the tag. The tag value is optional. + */ + Tags: TagList; + } + export type Arn = string; + export type CertificateBody = string; + export type CertificateBodyBlob = Buffer|Uint8Array|Blob|string; + export type CertificateChain = string; + export type CertificateChainBlob = Buffer|Uint8Array|Blob|string; + export interface CertificateDetail { + /** + * The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + CertificateArn?: Arn; + /** + * The fully qualified domain name for the certificate, such as www.example.com or example.com. + */ + DomainName?: DomainNameString; + /** + * 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. + */ + SubjectAlternativeNames?: DomainList; + /** + * Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED. + */ + DomainValidationOptions?: DomainValidationList; + /** + * The serial number of the certificate. + */ + Serial?: String; + /** + * The name of the entity that is associated with the public key contained in the certificate. + */ + Subject?: String; + /** + * The name of the certificate authority that issued and signed the certificate. + */ + Issuer?: String; + /** + * The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED. + */ + CreatedAt?: TStamp; + /** + * The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED. + */ + IssuedAt?: TStamp; + /** + * The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED. + */ + ImportedAt?: TStamp; + /** + * The status of the certificate. + */ + Status?: CertificateStatus; + /** + * The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED. + */ + RevokedAt?: TStamp; + /** + * The reason the certificate was revoked. This value exists only when the certificate status is REVOKED. + */ + RevocationReason?: RevocationReason; + /** + * The time before which the certificate is not valid. + */ + NotBefore?: TStamp; + /** + * The time after which the certificate is not valid. + */ + NotAfter?: TStamp; + /** + * The algorithm that was used to generate the public-private key pair. + */ + KeyAlgorithm?: KeyAlgorithm; + /** + * The algorithm that was used to sign the certificate. + */ + SignatureAlgorithm?: String; + /** + * A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources. + */ + InUseBy?: InUseList; + /** + * The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide. + */ + FailureReason?: FailureReason; + /** + * The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide. + */ + Type?: CertificateType; + /** + * Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED. + */ + RenewalSummary?: RenewalSummary; + /** + * A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more. + */ + KeyUsages?: KeyUsageList; + /** + * Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). + */ + ExtendedKeyUsages?: ExtendedKeyUsageList; + /** + * The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn?: Arn; + /** + * Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command. + */ + RenewalEligibility?: RenewalEligibility; + /** + * 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. + */ + Options?: CertificateOptions; + } + export interface CertificateOptions { + /** + * You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED. + */ + CertificateTransparencyLoggingPreference?: CertificateTransparencyLoggingPreference; + } + export type CertificateStatus = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"|string; + export type CertificateStatuses = CertificateStatus[]; + export interface CertificateSummary { + /** + * Amazon Resource Name (ARN) of the certificate. This is of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn?: Arn; + /** + * Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate. + */ + DomainName?: DomainNameString; + } + export type CertificateSummaryList = CertificateSummary[]; + export type CertificateTransparencyLoggingPreference = "ENABLED"|"DISABLED"|string; + export type CertificateType = "IMPORTED"|"AMAZON_ISSUED"|"PRIVATE"|string; + export interface DeleteCertificateRequest { + /** + * String that contains the ARN of the ACM certificate to be deleted. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn: Arn; + } + export interface DescribeCertificateRequest { + /** + * The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn: Arn; + } + export interface DescribeCertificateResponse { + /** + * Metadata about an ACM certificate. + */ + Certificate?: CertificateDetail; + } + export type DomainList = DomainNameString[]; + export type DomainNameString = string; + export type DomainStatus = "PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string; + export interface DomainValidation { + /** + * A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com. + */ + DomainName: DomainNameString; + /** + * A list of email addresses that ACM used to send domain validation emails. + */ + ValidationEmails?: ValidationEmailList; + /** + * The domain name that ACM used to send domain validation emails. + */ + ValidationDomain?: DomainNameString; + /** + * The validation status of the domain name. This can be one of the following values: PENDING_VALIDATION SUCCESS FAILED + */ + ValidationStatus?: DomainStatus; + /** + * Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership. + */ + ResourceRecord?: ResourceRecord; + /** + * Specifies the domain validation method. + */ + ValidationMethod?: ValidationMethod; + } + export type DomainValidationList = DomainValidation[]; + export interface DomainValidationOption { + /** + * A fully qualified domain name (FQDN) in the certificate request. + */ + DomainName: DomainNameString; + /** + * 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 DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses: admin@example.com administrator@example.com hostmaster@example.com postmaster@example.com webmaster@example.com + */ + ValidationDomain: DomainNameString; + } + export type DomainValidationOptionList = DomainValidationOption[]; + export interface ExportCertificateRequest { + /** + * An Amazon Resource Name (ARN) of the issued certificate. This must be of the form: arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 + */ + CertificateArn: Arn; + /** + * 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: openssl rsa -in encrypted_key.pem -out decrypted_key.pem + */ + Passphrase: PassphraseBlob; + } + export interface ExportCertificateResponse { + /** + * The base64 PEM-encoded certificate. + */ + Certificate?: CertificateBody; + /** + * The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting. + */ + CertificateChain?: CertificateChain; + /** + * The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded. + */ + PrivateKey?: PrivateKey; + } + export interface ExtendedKeyUsage { + /** + * The name of an Extended Key Usage value. + */ + Name?: ExtendedKeyUsageName; + /** + * An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280. 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION) 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION) 1.3.6.1.5.5.7.3.3 (CODE_SIGNING) 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION) 1.3.6.1.5.5.7.3.8 (TIME_STAMPING) 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING) 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM) 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL) 1.3.6.1.5.5.7.3.7 (IPSEC_USER) + */ + OID?: String; + } + export type ExtendedKeyUsageFilterList = ExtendedKeyUsageName[]; + export type ExtendedKeyUsageList = ExtendedKeyUsage[]; + export type ExtendedKeyUsageName = "TLS_WEB_SERVER_AUTHENTICATION"|"TLS_WEB_CLIENT_AUTHENTICATION"|"CODE_SIGNING"|"EMAIL_PROTECTION"|"TIME_STAMPING"|"OCSP_SIGNING"|"IPSEC_END_SYSTEM"|"IPSEC_TUNNEL"|"IPSEC_USER"|"ANY"|"NONE"|"CUSTOM"|string; + export type FailureReason = "NO_AVAILABLE_CONTACTS"|"ADDITIONAL_VERIFICATION_REQUIRED"|"DOMAIN_NOT_ALLOWED"|"INVALID_PUBLIC_DOMAIN"|"DOMAIN_VALIDATION_DENIED"|"CAA_ERROR"|"PCA_LIMIT_EXCEEDED"|"PCA_INVALID_ARN"|"PCA_INVALID_STATE"|"PCA_REQUEST_FAILED"|"PCA_RESOURCE_NOT_FOUND"|"PCA_INVALID_ARGS"|"PCA_INVALID_DURATION"|"PCA_ACCESS_DENIED"|"OTHER"|string; + export interface Filters { + /** + * Specify one or more ExtendedKeyUsage extension values. + */ + extendedKeyUsage?: ExtendedKeyUsageFilterList; + /** + * Specify one or more KeyUsage extension values. + */ + keyUsage?: KeyUsageFilterList; + /** + * Specify one or more algorithms that can be used to generate key pairs. + */ + keyTypes?: KeyAlgorithmList; + } + export interface GetCertificateRequest { + /** + * String that contains a certificate ARN in the following format: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn: Arn; + } + export interface GetCertificateResponse { + /** + * String that contains the ACM certificate represented by the ARN specified at input. + */ + Certificate?: CertificateBody; + /** + * The certificate chain that contains the root certificate issued by the certificate authority (CA). + */ + CertificateChain?: CertificateChain; + } + export type IdempotencyToken = string; + export interface ImportCertificateRequest { + /** + * The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field. + */ + CertificateArn?: Arn; + /** + * The certificate to import. + */ + Certificate: CertificateBodyBlob; + /** + * The private key that matches the public key in the certificate. + */ + PrivateKey: PrivateKeyBlob; + /** + * The PEM encoded certificate chain. + */ + CertificateChain?: CertificateChainBlob; + } + export interface ImportCertificateResponse { + /** + * The Amazon Resource Name (ARN) of the imported certificate. + */ + CertificateArn?: Arn; + } + export type InUseList = String[]; + export type KeyAlgorithm = "RSA_2048"|"RSA_1024"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|"EC_secp521r1"|string; + export type KeyAlgorithmList = KeyAlgorithm[]; + export interface KeyUsage { + /** + * A string value that contains a Key Usage extension name. + */ + Name?: KeyUsageName; + } + export type KeyUsageFilterList = KeyUsageName[]; + export type KeyUsageList = KeyUsage[]; + export type KeyUsageName = "DIGITAL_SIGNATURE"|"NON_REPUDIATION"|"KEY_ENCIPHERMENT"|"DATA_ENCIPHERMENT"|"KEY_AGREEMENT"|"CERTIFICATE_SIGNING"|"CRL_SIGNING"|"ENCIPHER_ONLY"|"DECIPHER_ONLY"|"ANY"|"CUSTOM"|string; + export interface ListCertificatesRequest { + /** + * Filter the certificate list by status value. + */ + CertificateStatuses?: CertificateStatuses; + /** + * Filter the certificate list. For more information, see the Filters structure. + */ + Includes?: Filters; + /** + * Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received. + */ + NextToken?: NextToken; + /** + * 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 NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items. + */ + MaxItems?: MaxItems; + } + export interface ListCertificatesResponse { + /** + * When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request. + */ + NextToken?: NextToken; + /** + * A list of ACM certificates. + */ + CertificateSummaryList?: CertificateSummaryList; + } + export interface ListTagsForCertificateRequest { + /** + * String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn: Arn; + } + export interface ListTagsForCertificateResponse { + /** + * The key-value pairs that define the applied tags. + */ + Tags?: TagList; + } + export type MaxItems = number; + export type NextToken = string; + export type PassphraseBlob = Buffer|Uint8Array|Blob|string; + export type PrivateKey = string; + export type PrivateKeyBlob = Buffer|Uint8Array|Blob|string; + export type RecordType = "CNAME"|string; + export interface RemoveTagsFromCertificateRequest { + /** + * 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: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn: Arn; + /** + * The key-value pair that defines the tag to remove. + */ + Tags: TagList; + } + export interface RenewCertificateRequest { + /** + * String that contains the ARN of the ACM certificate to be renewed. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + CertificateArn: Arn; + } + export type RenewalEligibility = "ELIGIBLE"|"INELIGIBLE"|string; + export type RenewalStatus = "PENDING_AUTO_RENEWAL"|"PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string; + export interface RenewalSummary { + /** + * The status of ACM's managed renewal of the certificate. + */ + RenewalStatus: RenewalStatus; + /** + * Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED. + */ + DomainValidationOptions: DomainValidationList; + /** + * The reason that a renewal request was unsuccessful. + */ + RenewalStatusReason?: FailureReason; + /** + * The time at which the renewal summary was last updated. + */ + UpdatedAt: TStamp; + } + export interface RequestCertificateRequest { + /** + * 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. 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. + */ + DomainName: DomainNameString; + /** + * The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation. + */ + ValidationMethod?: ValidationMethod; + /** + * 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 DomainName 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 Limits. 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: (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets. + */ + SubjectAlternativeNames?: DomainList; + /** + * Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates. + */ + IdempotencyToken?: IdempotencyToken; + /** + * The domain name that you want ACM to use to send you emails so that you can validate domain ownership. + */ + DomainValidationOptions?: DomainValidationOptionList; + /** + * 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 Opting Out of Certificate Transparency Logging. + */ + Options?: CertificateOptions; + /** + * 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 AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn?: Arn; + } + export interface RequestCertificateResponse { + /** + * String that contains the ARN of the issued certificate. This must be of the form: arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + */ + CertificateArn?: Arn; + } + export interface ResendValidationEmailRequest { + /** + * String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate 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: arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + */ + CertificateArn: Arn; + /** + * The fully qualified domain name (FQDN) of the certificate that needs to be validated. + */ + Domain: DomainNameString; + /** + * 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 Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses: admin@subdomain.example.com administrator@subdomain.example.com hostmaster@subdomain.example.com postmaster@subdomain.example.com webmaster@subdomain.example.com + */ + ValidationDomain: DomainNameString; + } + export interface ResourceRecord { + /** + * The name of the DNS record to create in your domain. This is supplied by ACM. + */ + Name: String; + /** + * The type of DNS record. Currently this can be CNAME. + */ + Type: RecordType; + /** + * The value of the CNAME record to add to your DNS database. This is supplied by ACM. + */ + Value: String; + } + export type RevocationReason = "UNSPECIFIED"|"KEY_COMPROMISE"|"CA_COMPROMISE"|"AFFILIATION_CHANGED"|"SUPERCEDED"|"CESSATION_OF_OPERATION"|"CERTIFICATE_HOLD"|"REMOVE_FROM_CRL"|"PRIVILEGE_WITHDRAWN"|"A_A_COMPROMISE"|string; + export type String = string; + export type TStamp = Date; + export interface Tag { + /** + * The key of the tag. + */ + Key: TagKey; + /** + * The value of the tag. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagList = Tag[]; + export type TagValue = string; + export interface UpdateCertificateOptionsRequest { + /** + * ARN of the requested certificate to update. This must be of the form: arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 + */ + CertificateArn: Arn; + /** + * 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. + */ + Options: CertificateOptions; + } + export type ValidationEmailList = String[]; + export type ValidationMethod = "EMAIL"|"DNS"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-12-08"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ACM client. + */ + export import Types = ACM; +} +export = ACM; diff --git a/node_modules/aws-sdk/clients/acm.js b/node_modules/aws-sdk/clients/acm.js new file mode 100644 index 0000000..db36a20 --- /dev/null +++ b/node_modules/aws-sdk/clients/acm.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['acm'] = {}; +AWS.ACM = Service.defineService('acm', ['2015-12-08']); +Object.defineProperty(apiLoader.services['acm'], '2015-12-08', { + get: function get() { + var model = require('../apis/acm-2015-12-08.min.json'); + model.paginators = require('../apis/acm-2015-12-08.paginators.json').pagination; + model.waiters = require('../apis/acm-2015-12-08.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ACM; diff --git a/node_modules/aws-sdk/clients/acmpca.d.ts b/node_modules/aws-sdk/clients/acmpca.d.ts new file mode 100644 index 0000000..191b47e --- /dev/null +++ b/node_modules/aws-sdk/clients/acmpca.d.ts @@ -0,0 +1,800 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ACMPCA extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ACMPCA.Types.ClientConfiguration) + config: Config & ACMPCA.Types.ClientConfiguration; + /** + * 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 operation returns the Amazon Resource Name (ARN) of the CA. + */ + createCertificateAuthority(params: ACMPCA.Types.CreateCertificateAuthorityRequest, callback?: (err: AWSError, data: ACMPCA.Types.CreateCertificateAuthorityResponse) => void): Request; + /** + * 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 operation returns the Amazon Resource Name (ARN) of the CA. + */ + createCertificateAuthority(callback?: (err: AWSError, data: ACMPCA.Types.CreateCertificateAuthorityResponse) => void): Request; + /** + * Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes. + */ + createCertificateAuthorityAuditReport(params: ACMPCA.Types.CreateCertificateAuthorityAuditReportRequest, callback?: (err: AWSError, data: ACMPCA.Types.CreateCertificateAuthorityAuditReportResponse) => void): Request; + /** + * Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes. + */ + createCertificateAuthorityAuditReport(callback?: (err: AWSError, data: ACMPCA.Types.CreateCertificateAuthorityAuditReportResponse) => void): Request; + /** + * Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal. At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission operation and listed with the ListPermissions operation. + */ + createPermission(params: ACMPCA.Types.CreatePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal. At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission operation and listed with the ListPermissions operation. + */ + createPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the CertificateAuthorityStatus parameter to DISABLED. Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the CertificateAuthority is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA. If the CA is in one of the previously mentioned states and you call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority operation returns the time remaining in the restoration window of a Private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority operation. + */ + deleteCertificateAuthority(params: ACMPCA.Types.DeleteCertificateAuthorityRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the CertificateAuthorityStatus parameter to DISABLED. Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the CertificateAuthority is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA. If the CA is in one of the previously mentioned states and you call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority operation returns the time remaining in the restoration window of a Private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority operation. + */ + deleteCertificateAuthority(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission operation and listed with the ListPermissions operation. + */ + deletePermission(params: ACMPCA.Types.DeletePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission operation and listed with the ListPermissions operation. + */ + deletePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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: CREATING - ACM PCA is creating your private certificate authority. PENDING_CERTIFICATE - 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. ACTIVE - Your private CA is active. DISABLED - Your private CA has been disabled. EXPIRED - Your private CA certificate has expired. FAILED - Your private CA has failed. Your CA can fail because of 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. DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this operation's output. + */ + describeCertificateAuthority(params: ACMPCA.Types.DescribeCertificateAuthorityRequest, callback?: (err: AWSError, data: ACMPCA.Types.DescribeCertificateAuthorityResponse) => void): Request; + /** + * 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: CREATING - ACM PCA is creating your private certificate authority. PENDING_CERTIFICATE - 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. ACTIVE - Your private CA is active. DISABLED - Your private CA has been disabled. EXPIRED - Your private CA certificate has expired. FAILED - Your private CA has failed. Your CA can fail because of 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. DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this operation's output. + */ + describeCertificateAuthority(callback?: (err: AWSError, data: ACMPCA.Types.DescribeCertificateAuthorityResponse) => void): Request; + /** + * Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate operation or the RevokeCertificate operation. + */ + describeCertificateAuthorityAuditReport(params: ACMPCA.Types.DescribeCertificateAuthorityAuditReportRequest, callback?: (err: AWSError, data: ACMPCA.Types.DescribeCertificateAuthorityAuditReportResponse) => void): Request; + /** + * Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate operation or the RevokeCertificate operation. + */ + describeCertificateAuthorityAuditReport(callback?: (err: AWSError, data: ACMPCA.Types.DescribeCertificateAuthorityAuditReportResponse) => void): Request; + /** + * Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation to create a report that contains information about all of the certificates issued and revoked by your private CA. + */ + getCertificate(params: ACMPCA.Types.GetCertificateRequest, callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateResponse) => void): Request; + /** + * Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation to create a report that contains information about all of the certificates issued and revoked by your private CA. + */ + getCertificate(callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateResponse) => void): Request; + /** + * 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. + */ + getCertificateAuthorityCertificate(params: ACMPCA.Types.GetCertificateAuthorityCertificateRequest, callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateAuthorityCertificateResponse) => void): Request; + /** + * 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. + */ + getCertificateAuthorityCertificate(callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateAuthorityCertificateResponse) => void): Request; + /** + * Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority operation. 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 ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64 PEM-encoded string. + */ + getCertificateAuthorityCsr(params: ACMPCA.Types.GetCertificateAuthorityCsrRequest, callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateAuthorityCsrResponse) => void): Request; + /** + * Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority operation. 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 ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64 PEM-encoded string. + */ + getCertificateAuthorityCsr(callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateAuthorityCsrResponse) => void): Request; + /** + * Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the CreateCertificateAuthority operation. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. 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. Your certificate chain must not include the private CA certificate that you are importing. 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. The chain must be PEM-encoded. + */ + importCertificateAuthorityCertificate(params: ACMPCA.Types.ImportCertificateAuthorityCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the CreateCertificateAuthority operation. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. 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. Your certificate chain must not include the private CA certificate that you are importing. 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. The chain must be PEM-encoded. + */ + importCertificateAuthorityCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate operation and specifying the ARN. You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that you issue by using ACM PCA. + */ + issueCertificate(params: ACMPCA.Types.IssueCertificateRequest, callback?: (err: AWSError, data: ACMPCA.Types.IssueCertificateResponse) => void): Request; + /** + * Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate operation and specifying the ARN. You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that you issue by using ACM PCA. + */ + issueCertificate(callback?: (err: AWSError, data: ACMPCA.Types.IssueCertificateResponse) => void): Request; + /** + * Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation. + */ + listCertificateAuthorities(params: ACMPCA.Types.ListCertificateAuthoritiesRequest, callback?: (err: AWSError, data: ACMPCA.Types.ListCertificateAuthoritiesResponse) => void): Request; + /** + * Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation. + */ + listCertificateAuthorities(callback?: (err: AWSError, data: ACMPCA.Types.ListCertificateAuthoritiesResponse) => void): Request; + /** + * Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission operation and revoked with the DeletePermission operation. + */ + listPermissions(params: ACMPCA.Types.ListPermissionsRequest, callback?: (err: AWSError, data: ACMPCA.Types.ListPermissionsResponse) => void): Request; + /** + * Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission operation and revoked with the DeletePermission operation. + */ + listPermissions(callback?: (err: AWSError, data: ACMPCA.Types.ListPermissionsResponse) => void): Request; + /** + * 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 TagCertificateAuthority operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags. + */ + listTags(params: ACMPCA.Types.ListTagsRequest, callback?: (err: AWSError, data: ACMPCA.Types.ListTagsResponse) => void): Request; + /** + * 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 TagCertificateAuthority operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags. + */ + listTags(callback?: (err: AWSError, data: ACMPCA.Types.ListTagsResponse) => void): Request; + /** + * Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority operation. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To change its status to ACTIVE, call the UpdateCertificateAuthority operation. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate operation to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended. + */ + restoreCertificateAuthority(params: ACMPCA.Types.RestoreCertificateAuthorityRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority operation. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To change its status to ACTIVE, call the UpdateCertificateAuthority operation. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate operation to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended. + */ + restoreCertificateAuthority(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes a certificate that you issued by calling the IssueCertificate operation. 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 CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport. + */ + revokeCertificate(params: ACMPCA.Types.RevokeCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes a certificate that you issued by calling the IssueCertificate operation. 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 CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport. + */ + revokeCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 UntagCertificateAuthority operation. Call the ListTags operation to see what tags are associated with your CA. + */ + tagCertificateAuthority(params: ACMPCA.Types.TagCertificateAuthorityRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 UntagCertificateAuthority operation. Call the ListTags operation to see what tags are associated with your CA. + */ + tagCertificateAuthority(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 operation, 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 TagCertificateAuthority. Call the ListTags operation to see what tags are associated with your CA. + */ + untagCertificateAuthority(params: ACMPCA.Types.UntagCertificateAuthorityRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 operation, 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 TagCertificateAuthority. Call the ListTags operation to see what tags are associated with your CA. + */ + untagCertificateAuthority(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again. + */ + updateCertificateAuthority(params: ACMPCA.Types.UpdateCertificateAuthorityRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again. + */ + updateCertificateAuthority(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the certificateAuthorityCSRCreated state by periodically calling the underlying ACMPCA.getCertificateAuthorityCsroperation every 3 seconds (at most 60 times). Wait until a Certificate Authority CSR is created + */ + waitFor(state: "certificateAuthorityCSRCreated", params: ACMPCA.Types.GetCertificateAuthorityCsrRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateAuthorityCsrResponse) => void): Request; + /** + * Waits for the certificateAuthorityCSRCreated state by periodically calling the underlying ACMPCA.getCertificateAuthorityCsroperation every 3 seconds (at most 60 times). Wait until a Certificate Authority CSR is created + */ + waitFor(state: "certificateAuthorityCSRCreated", callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateAuthorityCsrResponse) => void): Request; + /** + * Waits for the certificateIssued state by periodically calling the underlying ACMPCA.getCertificateoperation every 3 seconds (at most 60 times). Wait until a certificate is issued + */ + waitFor(state: "certificateIssued", params: ACMPCA.Types.GetCertificateRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateResponse) => void): Request; + /** + * Waits for the certificateIssued state by periodically calling the underlying ACMPCA.getCertificateoperation every 3 seconds (at most 60 times). Wait until a certificate is issued + */ + waitFor(state: "certificateIssued", callback?: (err: AWSError, data: ACMPCA.Types.GetCertificateResponse) => void): Request; + /** + * Waits for the auditReportCreated state by periodically calling the underlying ACMPCA.describeCertificateAuthorityAuditReportoperation every 3 seconds (at most 60 times). Wait until a Audit Report is created + */ + waitFor(state: "auditReportCreated", params: ACMPCA.Types.DescribeCertificateAuthorityAuditReportRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ACMPCA.Types.DescribeCertificateAuthorityAuditReportResponse) => void): Request; + /** + * Waits for the auditReportCreated state by periodically calling the underlying ACMPCA.describeCertificateAuthorityAuditReportoperation every 3 seconds (at most 60 times). Wait until a Audit Report is created + */ + waitFor(state: "auditReportCreated", callback?: (err: AWSError, data: ACMPCA.Types.DescribeCertificateAuthorityAuditReportResponse) => void): Request; +} +declare namespace ACMPCA { + export interface ASN1Subject { + /** + * Two-digit code that specifies the country in which the certificate subject located. + */ + Country?: CountryCodeString; + /** + * Legal name of the organization with which the certificate subject is affiliated. + */ + Organization?: String64; + /** + * A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated. + */ + OrganizationalUnit?: String64; + /** + * Disambiguating information for the certificate subject. + */ + DistinguishedNameQualifier?: DistinguishedNameQualifierString; + /** + * State in which the subject of the certificate is located. + */ + State?: String128; + /** + * Fully qualified domain name (FQDN) associated with the certificate subject. + */ + CommonName?: String64; + /** + * The certificate serial number. + */ + SerialNumber?: String64; + /** + * The locality (such as a city or town) in which the certificate subject is located. + */ + Locality?: String128; + /** + * A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject. + */ + Title?: String64; + /** + * 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. + */ + Surname?: String40; + /** + * First name. + */ + GivenName?: String16; + /** + * Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName. + */ + Initials?: String5; + /** + * Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. + */ + Pseudonym?: String128; + /** + * Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third. + */ + GenerationQualifier?: String3; + } + export type AccountId = string; + export type ActionList = ActionType[]; + export type ActionType = "IssueCertificate"|"GetCertificate"|"ListPermissions"|string; + export type Arn = string; + export type AuditReportId = string; + export type AuditReportResponseFormat = "JSON"|"CSV"|string; + export type AuditReportStatus = "CREATING"|"SUCCESS"|"FAILED"|string; + export type Boolean = boolean; + export type CertificateAuthorities = CertificateAuthority[]; + export interface CertificateAuthority { + /** + * Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 . + */ + Arn?: Arn; + /** + * Date and time at which your private CA was created. + */ + CreatedAt?: TStamp; + /** + * Date and time at which your private CA was last updated. + */ + LastStateChangeAt?: TStamp; + /** + * Type of your private CA. + */ + Type?: CertificateAuthorityType; + /** + * Serial number of your private CA. + */ + Serial?: String; + /** + * Status of your private CA. + */ + Status?: CertificateAuthorityStatus; + /** + * Date and time before which your private CA certificate is not valid. + */ + NotBefore?: TStamp; + /** + * Date and time after which your private CA certificate is not valid. + */ + NotAfter?: TStamp; + /** + * Reason the request to create your private CA failed. + */ + FailureReason?: FailureReason; + /** + * Your private CA configuration. + */ + CertificateAuthorityConfiguration?: CertificateAuthorityConfiguration; + /** + * Information about the certificate revocation list (CRL) created and maintained by your private CA. + */ + RevocationConfiguration?: RevocationConfiguration; + /** + * The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest operation. + */ + RestorableUntil?: TStamp; + } + export interface CertificateAuthorityConfiguration { + /** + * Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate. + */ + KeyAlgorithm: KeyAlgorithm; + /** + * Name of the algorithm your private CA uses to sign certificate requests. + */ + SigningAlgorithm: SigningAlgorithm; + /** + * Structure that contains X.500 distinguished name information for your private CA. + */ + Subject: ASN1Subject; + } + export type CertificateAuthorityStatus = "CREATING"|"PENDING_CERTIFICATE"|"ACTIVE"|"DELETED"|"DISABLED"|"EXPIRED"|"FAILED"|string; + export type CertificateAuthorityType = "SUBORDINATE"|string; + export type CertificateBody = string; + export type CertificateBodyBlob = Buffer|Uint8Array|Blob|string; + export type CertificateChain = string; + export type CertificateChainBlob = Buffer|Uint8Array|Blob|string; + export type CountryCodeString = string; + export interface CreateCertificateAuthorityAuditReportRequest { + /** + * The Amazon Resource Name (ARN) of the CA to be audited. This is of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + /** + * The name of the S3 bucket that will contain the audit report. + */ + S3BucketName: String; + /** + * The format in which to create the report. This can be either JSON or CSV. + */ + AuditReportResponseFormat: AuditReportResponseFormat; + } + export interface CreateCertificateAuthorityAuditReportResponse { + /** + * An alphanumeric string that contains a report identifier. + */ + AuditReportId?: AuditReportId; + /** + * The key that uniquely identifies the report file in your S3 bucket. + */ + S3Key?: String; + } + export interface CreateCertificateAuthorityRequest { + /** + * Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information. + */ + CertificateAuthorityConfiguration: CertificateAuthorityConfiguration; + /** + * 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 CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure. + */ + RevocationConfiguration?: RevocationConfiguration; + /** + * The type of the certificate authority. Currently, this must be SUBORDINATE. + */ + CertificateAuthorityType: CertificateAuthorityType; + /** + * Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate. As a result, ACM PCA issues only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates. + */ + IdempotencyToken?: IdempotencyToken; + /** + * Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. + */ + Tags?: TagList; + } + export interface CreateCertificateAuthorityResponse { + /** + * If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn?: Arn; + } + export interface CreatePermissionRequest { + /** + * The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities operation. This must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + /** + * The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com. + */ + Principal: Principal; + /** + * The ID of the calling account. + */ + SourceAccount?: AccountId; + /** + * The actions that the specified AWS service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions. + */ + Actions: ActionList; + } + export interface CrlConfiguration { + /** + * 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 CreateCertificateAuthority operation or for an existing CA when you call the UpdateCertificateAuthority operation. + */ + Enabled: Boolean; + /** + * Number of days until a certificate expires. + */ + ExpirationInDays?: Integer1To5000; + /** + * Name inserted into the certificate CRL Distribution Points 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. + */ + CustomCname?: String253; + /** + * Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket. + */ + S3BucketName?: String3To255; + } + export type CsrBlob = Buffer|Uint8Array|Blob|string; + export type CsrBody = string; + export interface DeleteCertificateAuthorityRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + /** + * The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default. + */ + PermanentDeletionTimeInDays?: PermanentDeletionTimeInDays; + } + export interface DeletePermissionRequest { + /** + * The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities operation. This must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + /** + * The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com + */ + Principal: Principal; + /** + * The AWS account that calls this operation. + */ + SourceAccount?: AccountId; + } + export interface DescribeCertificateAuthorityAuditReportRequest { + /** + * The Amazon Resource Name (ARN) of the private CA. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + /** + * The report ID returned by calling the CreateCertificateAuthorityAuditReport operation. + */ + AuditReportId: AuditReportId; + } + export interface DescribeCertificateAuthorityAuditReportResponse { + /** + * Specifies whether report creation is in progress, has succeeded, or has failed. + */ + AuditReportStatus?: AuditReportStatus; + /** + * Name of the S3 bucket that contains the report. + */ + S3BucketName?: String; + /** + * S3 key that uniquely identifies the report file in your S3 bucket. + */ + S3Key?: String; + /** + * The date and time at which the report was created. + */ + CreatedAt?: TStamp; + } + export interface DescribeCertificateAuthorityRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + } + export interface DescribeCertificateAuthorityResponse { + /** + * A CertificateAuthority structure that contains information about your private CA. + */ + CertificateAuthority?: CertificateAuthority; + } + export type DistinguishedNameQualifierString = string; + export type FailureReason = "REQUEST_TIMED_OUT"|"UNSUPPORTED_ALGORITHM"|"OTHER"|string; + export interface GetCertificateAuthorityCertificateRequest { + /** + * The Amazon Resource Name (ARN) of your private CA. This is of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + } + export interface GetCertificateAuthorityCertificateResponse { + /** + * Base64-encoded certificate authority (CA) certificate. + */ + Certificate?: CertificateBody; + /** + * 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. + */ + CertificateChain?: CertificateChain; + } + export interface GetCertificateAuthorityCsrRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + } + export interface GetCertificateAuthorityCsrResponse { + /** + * The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate. + */ + Csr?: CsrBody; + } + export interface GetCertificateRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . + */ + CertificateAuthorityArn: Arn; + /** + * The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245 + */ + CertificateArn: Arn; + } + export interface GetCertificateResponse { + /** + * The base64 PEM-encoded certificate specified by the CertificateArn parameter. + */ + Certificate?: CertificateBody; + /** + * 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. + */ + CertificateChain?: CertificateChain; + } + export type IdempotencyToken = string; + export interface ImportCertificateAuthorityCertificateRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + /** + * The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA. + */ + Certificate: CertificateBodyBlob; + /** + * 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. + */ + CertificateChain: CertificateChainBlob; + } + export type Integer1To5000 = number; + export interface IssueCertificateRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + /** + * 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. openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions. 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 + */ + Csr: CsrBlob; + /** + * The name of the algorithm that will be used to sign the certificate to be issued. + */ + SigningAlgorithm: SigningAlgorithm; + /** + * The type of the validity period. + */ + Validity: Validity; + /** + * Custom string that can be used to distinguish between calls to the IssueCertificate operation. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate 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. + */ + IdempotencyToken?: IdempotencyToken; + } + export interface IssueCertificateResponse { + /** + * The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245 + */ + CertificateArn?: Arn; + } + export type KeyAlgorithm = "RSA_2048"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|string; + export interface ListCertificateAuthoritiesRequest { + /** + * 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 NextToken parameter from the response you just received. + */ + NextToken?: NextToken; + /** + * 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 NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items. + */ + MaxResults?: MaxResults; + } + export interface ListCertificateAuthoritiesResponse { + /** + * Summary information about each certificate authority you have created. + */ + CertificateAuthorities?: CertificateAuthorities; + /** + * When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request. + */ + NextToken?: NextToken; + } + export interface ListPermissionsRequest { + /** + * The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities operation. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities operation. + */ + CertificateAuthorityArn: Arn; + /** + * When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received. + */ + NextToken?: NextToken; + /** + * When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items. + */ + MaxResults?: MaxResults; + } + export interface ListPermissionsResponse { + /** + * Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation. + */ + Permissions?: PermissionList; + /** + * When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request. + */ + NextToken?: NextToken; + } + export interface ListTagsRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + /** + * Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received. + */ + NextToken?: NextToken; + /** + * 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 NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items. + */ + MaxResults?: MaxResults; + } + export interface ListTagsResponse { + /** + * The tags associated with your private CA. + */ + Tags?: TagList; + /** + * When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request. + */ + NextToken?: NextToken; + } + export type MaxResults = number; + export type NextToken = string; + export type PermanentDeletionTimeInDays = number; + export interface Permission { + /** + * The Amazon Resource Number (ARN) of the private CA from which the permission was issued. + */ + CertificateAuthorityArn?: Arn; + /** + * The time at which the permission was created. + */ + CreatedAt?: TStamp; + /** + * The AWS service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com. + */ + Principal?: String; + /** + * The ID of the account that assigned the permission. + */ + SourceAccount?: String; + /** + * The private CA operations that can be performed by the designated AWS service. + */ + Actions?: ActionList; + /** + * The name of the policy that is associated with the permission. + */ + Policy?: String; + } + export type PermissionList = Permission[]; + export type PositiveLong = number; + export type Principal = string; + export interface RestoreCertificateAuthorityRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + } + export interface RevocationConfiguration { + /** + * Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. + */ + CrlConfiguration?: CrlConfiguration; + } + export type RevocationReason = "UNSPECIFIED"|"KEY_COMPROMISE"|"CERTIFICATE_AUTHORITY_COMPROMISE"|"AFFILIATION_CHANGED"|"SUPERSEDED"|"CESSATION_OF_OPERATION"|"PRIVILEGE_WITHDRAWN"|"A_A_COMPROMISE"|string; + export interface RevokeCertificateRequest { + /** + * Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + /** + * Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate operation 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. openssl x509 -in file_path -text -noout You can also copy the serial number from the console or use the DescribeCertificate operation in the AWS Certificate Manager API Reference. + */ + CertificateSerial: String128; + /** + * Specifies why you revoked the certificate. + */ + RevocationReason: RevocationReason; + } + export type SigningAlgorithm = "SHA256WITHECDSA"|"SHA384WITHECDSA"|"SHA512WITHECDSA"|"SHA256WITHRSA"|"SHA384WITHRSA"|"SHA512WITHRSA"|string; + export type String = string; + export type String128 = string; + export type String16 = string; + export type String253 = string; + export type String3 = string; + export type String3To255 = string; + export type String40 = string; + export type String5 = string; + export type String64 = string; + export type TStamp = Date; + export interface Tag { + /** + * Key (name) of the tag. + */ + Key: TagKey; + /** + * Value of the tag. + */ + Value?: TagValue; + } + export interface TagCertificateAuthorityRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + /** + * List of tags to be associated with the CA. + */ + Tags: TagList; + } + export type TagKey = string; + export type TagList = Tag[]; + export type TagValue = string; + export interface UntagCertificateAuthorityRequest { + /** + * The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + /** + * List of tags to be removed from the CA. + */ + Tags: TagList; + } + export interface UpdateCertificateAuthorityRequest { + /** + * Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + */ + CertificateAuthorityArn: Arn; + /** + * Revocation information for your private CA. + */ + RevocationConfiguration?: RevocationConfiguration; + /** + * Status of your private CA. + */ + Status?: CertificateAuthorityStatus; + } + export interface Validity { + /** + * Time period. + */ + Value: PositiveLong; + /** + * Specifies whether the Value parameter represents days, months, or years. + */ + Type: ValidityPeriodType; + } + export type ValidityPeriodType = "END_DATE"|"ABSOLUTE"|"DAYS"|"MONTHS"|"YEARS"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-08-22"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ACMPCA client. + */ + export import Types = ACMPCA; +} +export = ACMPCA; diff --git a/node_modules/aws-sdk/clients/acmpca.js b/node_modules/aws-sdk/clients/acmpca.js new file mode 100644 index 0000000..8da1431 --- /dev/null +++ b/node_modules/aws-sdk/clients/acmpca.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['acmpca'] = {}; +AWS.ACMPCA = Service.defineService('acmpca', ['2017-08-22']); +Object.defineProperty(apiLoader.services['acmpca'], '2017-08-22', { + get: function get() { + var model = require('../apis/acm-pca-2017-08-22.min.json'); + model.paginators = require('../apis/acm-pca-2017-08-22.paginators.json').pagination; + model.waiters = require('../apis/acm-pca-2017-08-22.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ACMPCA; diff --git a/node_modules/aws-sdk/clients/alexaforbusiness.d.ts b/node_modules/aws-sdk/clients/alexaforbusiness.d.ts new file mode 100644 index 0000000..427eaf5 --- /dev/null +++ b/node_modules/aws-sdk/clients/alexaforbusiness.d.ts @@ -0,0 +1,3243 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class AlexaForBusiness extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: AlexaForBusiness.Types.ClientConfiguration) + config: Config & AlexaForBusiness.Types.ClientConfiguration; + /** + * Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement. + */ + approveSkill(params: AlexaForBusiness.Types.ApproveSkillRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ApproveSkillResponse) => void): Request; + /** + * Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement. + */ + approveSkill(callback?: (err: AWSError, data: AlexaForBusiness.Types.ApproveSkillResponse) => void): Request; + /** + * Associates a contact with a given address book. + */ + associateContactWithAddressBook(params: AlexaForBusiness.Types.AssociateContactWithAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateContactWithAddressBookResponse) => void): Request; + /** + * Associates a contact with a given address book. + */ + associateContactWithAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateContactWithAddressBookResponse) => void): Request; + /** + * 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. + */ + associateDeviceWithRoom(params: AlexaForBusiness.Types.AssociateDeviceWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request; + /** + * 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. + */ + associateDeviceWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request; + /** + * Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room. + */ + associateSkillGroupWithRoom(params: AlexaForBusiness.Types.AssociateSkillGroupWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request; + /** + * Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room. + */ + associateSkillGroupWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request; + /** + * Associates a skill with a skill group. + */ + associateSkillWithSkillGroup(params: AlexaForBusiness.Types.AssociateSkillWithSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request; + /** + * Associates a skill with a skill group. + */ + associateSkillWithSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request; + /** + * Makes a private skill available for enrolled users to enable on their devices. + */ + associateSkillWithUsers(params: AlexaForBusiness.Types.AssociateSkillWithUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request; + /** + * Makes a private skill available for enrolled users to enable on their devices. + */ + associateSkillWithUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request; + /** + * Creates an address book with the specified details. + */ + createAddressBook(params: AlexaForBusiness.Types.CreateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request; + /** + * Creates an address book with the specified details. + */ + createAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request; + /** + * Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval. + */ + createBusinessReportSchedule(params: AlexaForBusiness.Types.CreateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request; + /** + * Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval. + */ + createBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request; + /** + * Adds a new conference provider under the user's AWS account. + */ + createConferenceProvider(params: AlexaForBusiness.Types.CreateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request; + /** + * Adds a new conference provider under the user's AWS account. + */ + createConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request; + /** + * Creates a contact with the specified details. + */ + createContact(params: AlexaForBusiness.Types.CreateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request; + /** + * Creates a contact with the specified details. + */ + createContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request; + /** + * Creates a gateway group with the specified details. + */ + createGatewayGroup(params: AlexaForBusiness.Types.CreateGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateGatewayGroupResponse) => void): Request; + /** + * Creates a gateway group with the specified details. + */ + createGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateGatewayGroupResponse) => void): Request; + /** + * Creates a new room profile with the specified details. + */ + createProfile(params: AlexaForBusiness.Types.CreateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request; + /** + * Creates a new room profile with the specified details. + */ + createProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request; + /** + * Creates a room with the specified details. + */ + createRoom(params: AlexaForBusiness.Types.CreateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request; + /** + * Creates a room with the specified details. + */ + createRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request; + /** + * Creates a skill group with a specified name and description. + */ + createSkillGroup(params: AlexaForBusiness.Types.CreateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request; + /** + * Creates a skill group with a specified name and description. + */ + createSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request; + /** + * Creates a user. + */ + createUser(params: AlexaForBusiness.Types.CreateUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request; + /** + * Creates a user. + */ + createUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request; + /** + * Deletes an address book by the address book ARN. + */ + deleteAddressBook(params: AlexaForBusiness.Types.DeleteAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request; + /** + * Deletes an address book by the address book ARN. + */ + deleteAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request; + /** + * Deletes the recurring report delivery schedule with the specified schedule ARN. + */ + deleteBusinessReportSchedule(params: AlexaForBusiness.Types.DeleteBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request; + /** + * Deletes the recurring report delivery schedule with the specified schedule ARN. + */ + deleteBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request; + /** + * Deletes a conference provider. + */ + deleteConferenceProvider(params: AlexaForBusiness.Types.DeleteConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request; + /** + * Deletes a conference provider. + */ + deleteConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request; + /** + * Deletes a contact by the contact ARN. + */ + deleteContact(params: AlexaForBusiness.Types.DeleteContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request; + /** + * Deletes a contact by the contact ARN. + */ + deleteContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request; + /** + * Removes a device from Alexa For Business. + */ + deleteDevice(params: AlexaForBusiness.Types.DeleteDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request; + /** + * Removes a device from Alexa For Business. + */ + deleteDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request; + /** + * When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device. + */ + deleteDeviceUsageData(params: AlexaForBusiness.Types.DeleteDeviceUsageDataRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceUsageDataResponse) => void): Request; + /** + * When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device. + */ + deleteDeviceUsageData(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceUsageDataResponse) => void): Request; + /** + * Deletes a gateway group. + */ + deleteGatewayGroup(params: AlexaForBusiness.Types.DeleteGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteGatewayGroupResponse) => void): Request; + /** + * Deletes a gateway group. + */ + deleteGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteGatewayGroupResponse) => void): Request; + /** + * Deletes a room profile by the profile ARN. + */ + deleteProfile(params: AlexaForBusiness.Types.DeleteProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request; + /** + * Deletes a room profile by the profile ARN. + */ + deleteProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request; + /** + * Deletes a room by the room ARN. + */ + deleteRoom(params: AlexaForBusiness.Types.DeleteRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request; + /** + * Deletes a room by the room ARN. + */ + deleteRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request; + /** + * Deletes room skill parameter details by room, skill, and parameter key ID. + */ + deleteRoomSkillParameter(params: AlexaForBusiness.Types.DeleteRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request; + /** + * Deletes room skill parameter details by room, skill, and parameter key ID. + */ + deleteRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request; + /** + * Unlinks a third-party account from a skill. + */ + deleteSkillAuthorization(params: AlexaForBusiness.Types.DeleteSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request; + /** + * Unlinks a third-party account from a skill. + */ + deleteSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request; + /** + * Deletes a skill group by skill group ARN. + */ + deleteSkillGroup(params: AlexaForBusiness.Types.DeleteSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request; + /** + * Deletes a skill group by skill group ARN. + */ + deleteSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request; + /** + * Deletes a specified user by user ARN and enrollment ARN. + */ + deleteUser(params: AlexaForBusiness.Types.DeleteUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request; + /** + * Deletes a specified user by user ARN and enrollment ARN. + */ + deleteUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request; + /** + * Disassociates a contact from a given address book. + */ + disassociateContactFromAddressBook(params: AlexaForBusiness.Types.DisassociateContactFromAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request; + /** + * Disassociates a contact from a given address book. + */ + disassociateContactFromAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request; + /** + * 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. + */ + disassociateDeviceFromRoom(params: AlexaForBusiness.Types.DisassociateDeviceFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request; + /** + * 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. + */ + disassociateDeviceFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request; + /** + * Disassociates a skill from a skill group. + */ + disassociateSkillFromSkillGroup(params: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request; + /** + * Disassociates a skill from a skill group. + */ + disassociateSkillFromSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request; + /** + * Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices. + */ + disassociateSkillFromUsers(params: AlexaForBusiness.Types.DisassociateSkillFromUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request; + /** + * Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices. + */ + disassociateSkillFromUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request; + /** + * Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room. + */ + disassociateSkillGroupFromRoom(params: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request; + /** + * Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room. + */ + disassociateSkillGroupFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request; + /** + * Forgets smart home appliances associated to a room. + */ + forgetSmartHomeAppliances(params: AlexaForBusiness.Types.ForgetSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request; + /** + * Forgets smart home appliances associated to a room. + */ + forgetSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request; + /** + * Gets address the book details by the address book ARN. + */ + getAddressBook(params: AlexaForBusiness.Types.GetAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request; + /** + * Gets address the book details by the address book ARN. + */ + getAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request; + /** + * Retrieves the existing conference preferences. + */ + getConferencePreference(params: AlexaForBusiness.Types.GetConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request; + /** + * Retrieves the existing conference preferences. + */ + getConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request; + /** + * Gets details about a specific conference provider. + */ + getConferenceProvider(params: AlexaForBusiness.Types.GetConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request; + /** + * Gets details about a specific conference provider. + */ + getConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request; + /** + * Gets the contact details by the contact ARN. + */ + getContact(params: AlexaForBusiness.Types.GetContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request; + /** + * Gets the contact details by the contact ARN. + */ + getContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request; + /** + * Gets the details of a device by device ARN. + */ + getDevice(params: AlexaForBusiness.Types.GetDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request; + /** + * Gets the details of a device by device ARN. + */ + getDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request; + /** + * Retrieves the details of a gateway. + */ + getGateway(params: AlexaForBusiness.Types.GetGatewayRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayResponse) => void): Request; + /** + * Retrieves the details of a gateway. + */ + getGateway(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayResponse) => void): Request; + /** + * Retrieves the details of a gateway group. + */ + getGatewayGroup(params: AlexaForBusiness.Types.GetGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayGroupResponse) => void): Request; + /** + * Retrieves the details of a gateway group. + */ + getGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayGroupResponse) => void): Request; + /** + * Retrieves the configured values for the user enrollment invitation email template. + */ + getInvitationConfiguration(params: AlexaForBusiness.Types.GetInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request; + /** + * Retrieves the configured values for the user enrollment invitation email template. + */ + getInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request; + /** + * Gets the details of a room profile by profile ARN. + */ + getProfile(params: AlexaForBusiness.Types.GetProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request; + /** + * Gets the details of a room profile by profile ARN. + */ + getProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request; + /** + * Gets room details by room ARN. + */ + getRoom(params: AlexaForBusiness.Types.GetRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request; + /** + * Gets room details by room ARN. + */ + getRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request; + /** + * Gets room skill parameter details by room, skill, and parameter key ARN. + */ + getRoomSkillParameter(params: AlexaForBusiness.Types.GetRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request; + /** + * Gets room skill parameter details by room, skill, and parameter key ARN. + */ + getRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request; + /** + * Gets skill group details by skill group ARN. + */ + getSkillGroup(params: AlexaForBusiness.Types.GetSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request; + /** + * Gets skill group details by skill group ARN. + */ + getSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request; + /** + * Lists the details of the schedules that a user configured. + */ + listBusinessReportSchedules(params: AlexaForBusiness.Types.ListBusinessReportSchedulesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request; + /** + * Lists the details of the schedules that a user configured. + */ + listBusinessReportSchedules(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request; + /** + * Lists conference providers under a specific AWS account. + */ + listConferenceProviders(params: AlexaForBusiness.Types.ListConferenceProvidersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request; + /** + * Lists conference providers under a specific AWS account. + */ + listConferenceProviders(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request; + /** + * Lists the device event history, including device connection status, for up to 30 days. + */ + listDeviceEvents(params: AlexaForBusiness.Types.ListDeviceEventsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request; + /** + * Lists the device event history, including device connection status, for up to 30 days. + */ + listDeviceEvents(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request; + /** + * Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group. + */ + listGatewayGroups(params: AlexaForBusiness.Types.ListGatewayGroupsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewayGroupsResponse) => void): Request; + /** + * Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group. + */ + listGatewayGroups(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewayGroupsResponse) => void): Request; + /** + * Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN. + */ + listGateways(params: AlexaForBusiness.Types.ListGatewaysRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewaysResponse) => void): Request; + /** + * Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN. + */ + listGateways(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewaysResponse) => void): Request; + /** + * Lists all enabled skills in a specific skill group. + */ + listSkills(params: AlexaForBusiness.Types.ListSkillsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request; + /** + * Lists all enabled skills in a specific skill group. + */ + listSkills(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request; + /** + * Lists all categories in the Alexa skill store. + */ + listSkillsStoreCategories(params: AlexaForBusiness.Types.ListSkillsStoreCategoriesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request; + /** + * Lists all categories in the Alexa skill store. + */ + listSkillsStoreCategories(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request; + /** + * Lists all skills in the Alexa skill store by category. + */ + listSkillsStoreSkillsByCategory(params: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request; + /** + * Lists all skills in the Alexa skill store by category. + */ + listSkillsStoreSkillsByCategory(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request; + /** + * Lists all of the smart home appliances associated with a room. + */ + listSmartHomeAppliances(params: AlexaForBusiness.Types.ListSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request; + /** + * Lists all of the smart home appliances associated with a room. + */ + listSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request; + /** + * Lists all tags for the specified resource. + */ + listTags(params: AlexaForBusiness.Types.ListTagsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request; + /** + * Lists all tags for the specified resource. + */ + listTags(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request; + /** + * Sets the conference preferences on a specific conference provider at the account level. + */ + putConferencePreference(params: AlexaForBusiness.Types.PutConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request; + /** + * Sets the conference preferences on a specific conference provider at the account level. + */ + putConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request; + /** + * Configures the email template for the user enrollment invitation with the specified attributes. + */ + putInvitationConfiguration(params: AlexaForBusiness.Types.PutInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request; + /** + * Configures the email template for the user enrollment invitation with the specified attributes. + */ + putInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request; + /** + * Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter. + */ + putRoomSkillParameter(params: AlexaForBusiness.Types.PutRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request; + /** + * Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter. + */ + putRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request; + /** + * Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role. + */ + putSkillAuthorization(params: AlexaForBusiness.Types.PutSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request; + /** + * Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role. + */ + putSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request; + /** + * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS). + */ + registerAVSDevice(params: AlexaForBusiness.Types.RegisterAVSDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request; + /** + * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS). + */ + registerAVSDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request; + /** + * Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API. + */ + rejectSkill(params: AlexaForBusiness.Types.RejectSkillRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request; + /** + * Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API. + */ + rejectSkill(callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request; + /** + * Determines the details for the room from which a skill request was invoked. This operation is used by skill developers. + */ + resolveRoom(params: AlexaForBusiness.Types.ResolveRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request; + /** + * Determines the details for the room from which a skill request was invoked. This operation is used by skill developers. + */ + resolveRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request; + /** + * Revokes an invitation and invalidates the enrollment URL. + */ + revokeInvitation(params: AlexaForBusiness.Types.RevokeInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request; + /** + * Revokes an invitation and invalidates the enrollment URL. + */ + revokeInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request; + /** + * Searches address books and lists the ones that meet a set of filter and sort criteria. + */ + searchAddressBooks(params: AlexaForBusiness.Types.SearchAddressBooksRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request; + /** + * Searches address books and lists the ones that meet a set of filter and sort criteria. + */ + searchAddressBooks(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request; + /** + * Searches contacts and lists the ones that meet a set of filter and sort criteria. + */ + searchContacts(params: AlexaForBusiness.Types.SearchContactsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request; + /** + * Searches contacts and lists the ones that meet a set of filter and sort criteria. + */ + searchContacts(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request; + /** + * Searches devices and lists the ones that meet a set of filter criteria. + */ + searchDevices(params: AlexaForBusiness.Types.SearchDevicesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request; + /** + * Searches devices and lists the ones that meet a set of filter criteria. + */ + searchDevices(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request; + /** + * Searches room profiles and lists the ones that meet a set of filter criteria. + */ + searchProfiles(params: AlexaForBusiness.Types.SearchProfilesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request; + /** + * Searches room profiles and lists the ones that meet a set of filter criteria. + */ + searchProfiles(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request; + /** + * Searches rooms and lists the ones that meet a set of filter and sort criteria. + */ + searchRooms(params: AlexaForBusiness.Types.SearchRoomsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request; + /** + * Searches rooms and lists the ones that meet a set of filter and sort criteria. + */ + searchRooms(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request; + /** + * Searches skill groups and lists the ones that meet a set of filter and sort criteria. + */ + searchSkillGroups(params: AlexaForBusiness.Types.SearchSkillGroupsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request; + /** + * Searches skill groups and lists the ones that meet a set of filter and sort criteria. + */ + searchSkillGroups(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request; + /** + * Searches users and lists the ones that meet a set of filter and sort criteria. + */ + searchUsers(params: AlexaForBusiness.Types.SearchUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request; + /** + * Searches users and lists the ones that meet a set of filter and sort criteria. + */ + searchUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request; + /** + * Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter. + */ + sendAnnouncement(params: AlexaForBusiness.Types.SendAnnouncementRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SendAnnouncementResponse) => void): Request; + /** + * Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter. + */ + sendAnnouncement(callback?: (err: AWSError, data: AlexaForBusiness.Types.SendAnnouncementResponse) => void): Request; + /** + * 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. + */ + sendInvitation(params: AlexaForBusiness.Types.SendInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request; + /** + * 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. + */ + sendInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request; + /** + * Resets a device and its account to the known default settings, by clearing all information and settings set by previous users. + */ + startDeviceSync(params: AlexaForBusiness.Types.StartDeviceSyncRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request; + /** + * Resets a device and its account to the known default settings, by clearing all information and settings set by previous users. + */ + startDeviceSync(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request; + /** + * Initiates the discovery of any smart home appliances associated with the room. + */ + startSmartHomeApplianceDiscovery(params: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request; + /** + * Initiates the discovery of any smart home appliances associated with the room. + */ + startSmartHomeApplianceDiscovery(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request; + /** + * Adds metadata tags to a specified resource. + */ + tagResource(params: AlexaForBusiness.Types.TagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request; + /** + * Adds metadata tags to a specified resource. + */ + tagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request; + /** + * Removes metadata tags from a specified resource. + */ + untagResource(params: AlexaForBusiness.Types.UntagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request; + /** + * Removes metadata tags from a specified resource. + */ + untagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request; + /** + * Updates address book details by the address book ARN. + */ + updateAddressBook(params: AlexaForBusiness.Types.UpdateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request; + /** + * Updates address book details by the address book ARN. + */ + updateAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request; + /** + * Updates the configuration of the report delivery schedule with the specified schedule ARN. + */ + updateBusinessReportSchedule(params: AlexaForBusiness.Types.UpdateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request; + /** + * Updates the configuration of the report delivery schedule with the specified schedule ARN. + */ + updateBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request; + /** + * Updates an existing conference provider's settings. + */ + updateConferenceProvider(params: AlexaForBusiness.Types.UpdateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request; + /** + * Updates an existing conference provider's settings. + */ + updateConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request; + /** + * Updates the contact details by the contact ARN. + */ + updateContact(params: AlexaForBusiness.Types.UpdateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request; + /** + * Updates the contact details by the contact ARN. + */ + updateContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request; + /** + * Updates the device name by device ARN. + */ + updateDevice(params: AlexaForBusiness.Types.UpdateDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request; + /** + * Updates the device name by device ARN. + */ + updateDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request; + /** + * Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified. + */ + updateGateway(params: AlexaForBusiness.Types.UpdateGatewayRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayResponse) => void): Request; + /** + * Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified. + */ + updateGateway(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayResponse) => void): Request; + /** + * Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified. + */ + updateGatewayGroup(params: AlexaForBusiness.Types.UpdateGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayGroupResponse) => void): Request; + /** + * Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified. + */ + updateGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayGroupResponse) => void): Request; + /** + * Updates an existing room profile by room profile ARN. + */ + updateProfile(params: AlexaForBusiness.Types.UpdateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request; + /** + * Updates an existing room profile by room profile ARN. + */ + updateProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request; + /** + * Updates room details by room ARN. + */ + updateRoom(params: AlexaForBusiness.Types.UpdateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request; + /** + * Updates room details by room ARN. + */ + updateRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request; + /** + * Updates skill group details by skill group ARN. + */ + updateSkillGroup(params: AlexaForBusiness.Types.UpdateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request; + /** + * Updates skill group details by skill group ARN. + */ + updateSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request; +} +declare namespace AlexaForBusiness { + export type Address = string; + export interface AddressBook { + /** + * The ARN of the address book. + */ + AddressBookArn?: Arn; + /** + * The name of the address book. + */ + Name?: AddressBookName; + /** + * The description of the address book. + */ + Description?: AddressBookDescription; + } + export interface AddressBookData { + /** + * The ARN of the address book. + */ + AddressBookArn?: Arn; + /** + * The name of the address book. + */ + Name?: AddressBookName; + /** + * The description of the address book. + */ + Description?: AddressBookDescription; + } + export type AddressBookDataList = AddressBookData[]; + export type AddressBookDescription = string; + export type AddressBookName = string; + export type AmazonId = string; + export type ApplianceDescription = string; + export type ApplianceFriendlyName = string; + export type ApplianceManufacturerName = string; + export interface ApproveSkillRequest { + /** + * The unique identifier of the skill. + */ + SkillId: SkillId; + } + export interface ApproveSkillResponse { + } + export type Arn = string; + export interface AssociateContactWithAddressBookRequest { + /** + * The ARN of the contact to associate with an address book. + */ + ContactArn: Arn; + /** + * The ARN of the address book with which to associate the contact. + */ + AddressBookArn: Arn; + } + export interface AssociateContactWithAddressBookResponse { + } + export interface AssociateDeviceWithRoomRequest { + /** + * The ARN of the device to associate to a room. Required. + */ + DeviceArn?: Arn; + /** + * The ARN of the room with which to associate the device. Required. + */ + RoomArn?: Arn; + } + export interface AssociateDeviceWithRoomResponse { + } + export interface AssociateSkillGroupWithRoomRequest { + /** + * The ARN of the skill group to associate with a room. Required. + */ + SkillGroupArn?: Arn; + /** + * The ARN of the room with which to associate the skill group. Required. + */ + RoomArn?: Arn; + } + export interface AssociateSkillGroupWithRoomResponse { + } + export interface AssociateSkillWithSkillGroupRequest { + /** + * The ARN of the skill group to associate the skill to. Required. + */ + SkillGroupArn?: Arn; + /** + * The unique identifier of the skill. + */ + SkillId: SkillId; + } + export interface AssociateSkillWithSkillGroupResponse { + } + export interface AssociateSkillWithUsersRequest { + /** + * The private skill ID you want to make available to enrolled users. + */ + SkillId: SkillId; + } + export interface AssociateSkillWithUsersResponse { + } + export interface Audio { + /** + * The locale of the audio message. Currently, en-US is supported. + */ + Locale: Locale; + /** + * The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters. + */ + Location: AudioLocation; + } + export type AudioList = Audio[]; + export type AudioLocation = string; + export type AuthorizationResult = {[key: string]: Value}; + export type Boolean = boolean; + export type BulletPoint = string; + export type BulletPoints = BulletPoint[]; + export interface BusinessReport { + /** + * The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED). + */ + Status?: BusinessReportStatus; + /** + * The failure code. + */ + FailureCode?: BusinessReportFailureCode; + /** + * The S3 location of the output reports. + */ + S3Location?: BusinessReportS3Location; + /** + * The time of report delivery. + */ + DeliveryTime?: BusinessReportDeliveryTime; + /** + * The download link where a user can download the report. + */ + DownloadUrl?: BusinessReportDownloadUrl; + } + export interface BusinessReportContentRange { + /** + * The interval of the content range. + */ + Interval?: BusinessReportInterval; + } + export type BusinessReportDeliveryTime = Date; + export type BusinessReportDownloadUrl = string; + export type BusinessReportFailureCode = "ACCESS_DENIED"|"NO_SUCH_BUCKET"|"INTERNAL_FAILURE"|string; + export type BusinessReportFormat = "CSV"|"CSV_ZIP"|string; + export type BusinessReportInterval = "ONE_DAY"|"ONE_WEEK"|string; + export interface BusinessReportRecurrence { + /** + * The start date. + */ + StartDate?: _Date; + } + export interface BusinessReportS3Location { + /** + * The path of the business report. + */ + Path?: BusinessReportS3Path; + /** + * The S3 bucket name of the output reports. + */ + BucketName?: CustomerS3BucketName; + } + export type BusinessReportS3Path = string; + export interface BusinessReportSchedule { + /** + * The ARN of the business report schedule. + */ + ScheduleArn?: Arn; + /** + * The name identifier of the schedule. + */ + ScheduleName?: BusinessReportScheduleName; + /** + * The S3 bucket name of the output reports. + */ + S3BucketName?: CustomerS3BucketName; + /** + * The S3 key where the report is delivered. + */ + S3KeyPrefix?: S3KeyPrefix; + /** + * The format of the generated report (individual CSV files or zipped files of individual files). + */ + Format?: BusinessReportFormat; + /** + * The content range of the reports. + */ + ContentRange?: BusinessReportContentRange; + /** + * The recurrence of the reports. + */ + Recurrence?: BusinessReportRecurrence; + /** + * The details of the last business report delivery for a specified time interval. + */ + LastBusinessReport?: BusinessReport; + } + export type BusinessReportScheduleList = BusinessReportSchedule[]; + export type BusinessReportScheduleName = string; + export type BusinessReportStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|string; + export interface Category { + /** + * The ID of the skill store category. + */ + CategoryId?: CategoryId; + /** + * The name of the skill store category. + */ + CategoryName?: CategoryName; + } + export type CategoryId = number; + export type CategoryList = Category[]; + export type CategoryName = string; + export type ClientId = string; + export type ClientRequestToken = string; + export type CommsProtocol = "SIP"|"SIPS"|"H323"|string; + export interface ConferencePreference { + /** + * The ARN of the default conference provider. + */ + DefaultConferenceProviderArn?: Arn; + } + export interface ConferenceProvider { + /** + * The ARN of the newly created conference provider. + */ + Arn?: Arn; + /** + * The name of the conference provider. + */ + Name?: ConferenceProviderName; + /** + * The type of conference providers. + */ + Type?: ConferenceProviderType; + /** + * The IP endpoint and protocol for calling. + */ + IPDialIn?: IPDialIn; + /** + * The information for PSTN conferencing. + */ + PSTNDialIn?: PSTNDialIn; + /** + * The meeting settings for the conference provider. + */ + MeetingSetting?: MeetingSetting; + } + export type ConferenceProviderName = string; + export type ConferenceProviderType = "CHIME"|"BLUEJEANS"|"FUZE"|"GOOGLE_HANGOUTS"|"POLYCOM"|"RINGCENTRAL"|"SKYPE_FOR_BUSINESS"|"WEBEX"|"ZOOM"|"CUSTOM"|string; + export type ConferenceProvidersList = ConferenceProvider[]; + export type ConnectionStatus = "ONLINE"|"OFFLINE"|string; + export interface Contact { + /** + * The ARN of the contact. + */ + ContactArn?: Arn; + /** + * The name of the contact to display on the console. + */ + DisplayName?: ContactName; + /** + * The first name of the contact, used to call the contact on the device. + */ + FirstName?: ContactName; + /** + * The last name of the contact, used to call the contact on the device. + */ + LastName?: ContactName; + /** + * The phone number of the contact. + */ + PhoneNumber?: E164PhoneNumber; + } + export interface ContactData { + /** + * The ARN of the contact. + */ + ContactArn?: Arn; + /** + * The name of the contact to display on the console. + */ + DisplayName?: ContactName; + /** + * The first name of the contact, used to call the contact on the device. + */ + FirstName?: ContactName; + /** + * The last name of the contact, used to call the contact on the device. + */ + LastName?: ContactName; + /** + * The phone number of the contact. + */ + PhoneNumber?: E164PhoneNumber; + } + export type ContactDataList = ContactData[]; + export type ContactName = string; + export interface Content { + /** + * The list of text messages. + */ + TextList?: TextList; + /** + * The list of SSML messages. + */ + SsmlList?: SsmlList; + /** + * The list of audio messages. + */ + AudioList?: AudioList; + } + export type CountryCode = string; + export interface CreateAddressBookRequest { + /** + * The name of the address book. + */ + Name: AddressBookName; + /** + * The description of the address book. + */ + Description?: AddressBookDescription; + /** + * A unique, user-specified identifier for the request that ensures idempotency. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface CreateAddressBookResponse { + /** + * The ARN of the newly created address book. + */ + AddressBookArn?: Arn; + } + export interface CreateBusinessReportScheduleRequest { + /** + * The name identifier of the schedule. + */ + ScheduleName?: BusinessReportScheduleName; + /** + * The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule. + */ + S3BucketName?: CustomerS3BucketName; + /** + * The S3 key where the report is delivered. + */ + S3KeyPrefix?: S3KeyPrefix; + /** + * The format of the generated report (individual CSV files or zipped files of individual files). + */ + Format: BusinessReportFormat; + /** + * The content range of the reports. + */ + ContentRange: BusinessReportContentRange; + /** + * The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called. + */ + Recurrence?: BusinessReportRecurrence; + /** + * The client request token. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface CreateBusinessReportScheduleResponse { + /** + * The ARN of the business report schedule. + */ + ScheduleArn?: Arn; + } + export interface CreateConferenceProviderRequest { + /** + * The name of the conference provider. + */ + ConferenceProviderName: ConferenceProviderName; + /** + * Represents a type within a list of predefined types. + */ + ConferenceProviderType: ConferenceProviderType; + /** + * The IP endpoint and protocol for calling. + */ + IPDialIn?: IPDialIn; + /** + * The information for PSTN conferencing. + */ + PSTNDialIn?: PSTNDialIn; + /** + * The meeting settings for the conference provider. + */ + MeetingSetting: MeetingSetting; + /** + * The request token of the client. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface CreateConferenceProviderResponse { + /** + * The ARN of the newly-created conference provider. + */ + ConferenceProviderArn?: Arn; + } + export interface CreateContactRequest { + /** + * The name of the contact to display on the console. + */ + DisplayName?: ContactName; + /** + * The first name of the contact that is used to call the contact on the device. + */ + FirstName: ContactName; + /** + * The last name of the contact that is used to call the contact on the device. + */ + LastName?: ContactName; + /** + * The phone number of the contact in E.164 format. + */ + PhoneNumber?: E164PhoneNumber; + /** + * A unique, user-specified identifier for this request that ensures idempotency. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface CreateContactResponse { + /** + * The ARN of the newly created address book. + */ + ContactArn?: Arn; + } + export interface CreateGatewayGroupRequest { + /** + * The name of the gateway group. + */ + Name: GatewayGroupName; + /** + * The description of the gateway group. + */ + Description?: GatewayGroupDescription; + /** + * A unique, user-specified identifier for the request that ensures idempotency. + */ + ClientRequestToken: ClientRequestToken; + } + export interface CreateGatewayGroupResponse { + /** + * The ARN of the created gateway group. + */ + GatewayGroupArn?: Arn; + } + export interface CreateProfileRequest { + /** + * The name of a room profile. + */ + ProfileName: ProfileName; + /** + * The time zone used by a room profile. + */ + Timezone: Timezone; + /** + * The valid address for the room. + */ + Address: Address; + /** + * The distance unit to be used by devices in the profile. + */ + DistanceUnit: DistanceUnit; + /** + * The temperature unit to be used by devices in the profile. + */ + TemperatureUnit: TemperatureUnit; + /** + * A wake word for Alexa, Echo, Amazon, or a computer. + */ + WakeWord: WakeWord; + /** + * The user-specified token that is used during the creation of a profile. + */ + ClientRequestToken?: ClientRequestToken; + /** + * Whether room profile setup is enabled. + */ + SetupModeDisabled?: Boolean; + /** + * The maximum volume limit for a room profile. + */ + MaxVolumeLimit?: MaxVolumeLimit; + /** + * Whether PSTN calling is enabled. + */ + PSTNEnabled?: Boolean; + } + export interface CreateProfileResponse { + /** + * The ARN of the newly created room profile in the response. + */ + ProfileArn?: Arn; + } + export interface CreateRoomRequest { + /** + * The name for the room. + */ + RoomName: RoomName; + /** + * The description for the room. + */ + Description?: RoomDescription; + /** + * The profile ARN for the room. + */ + ProfileArn?: Arn; + /** + * The calendar ARN for the room. + */ + ProviderCalendarId?: ProviderCalendarId; + /** + * A unique, user-specified identifier for this request that ensures idempotency. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The tags for the room. + */ + Tags?: TagList; + } + export interface CreateRoomResponse { + /** + * The ARN of the newly created room in the response. + */ + RoomArn?: Arn; + } + export interface CreateSkillGroupRequest { + /** + * The name for the skill group. + */ + SkillGroupName: SkillGroupName; + /** + * The description for the skill group. + */ + Description?: SkillGroupDescription; + /** + * A unique, user-specified identifier for this request that ensures idempotency. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface CreateSkillGroupResponse { + /** + * The ARN of the newly created skill group in the response. + */ + SkillGroupArn?: Arn; + } + export interface CreateUserRequest { + /** + * The ARN for the user. + */ + UserId: user_UserId; + /** + * The first name for the user. + */ + FirstName?: user_FirstName; + /** + * The last name for the user. + */ + LastName?: user_LastName; + /** + * The email address for the user. + */ + Email?: Email; + /** + * A unique, user-specified identifier for this request that ensures idempotency. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The tags for the user. + */ + Tags?: TagList; + } + export interface CreateUserResponse { + /** + * The ARN of the newly created user in the response. + */ + UserArn?: Arn; + } + export type CustomerS3BucketName = string; + export type _Date = string; + export interface DeleteAddressBookRequest { + /** + * The ARN of the address book to delete. + */ + AddressBookArn: Arn; + } + export interface DeleteAddressBookResponse { + } + export interface DeleteBusinessReportScheduleRequest { + /** + * The ARN of the business report schedule. + */ + ScheduleArn: Arn; + } + export interface DeleteBusinessReportScheduleResponse { + } + export interface DeleteConferenceProviderRequest { + /** + * The ARN of the conference provider. + */ + ConferenceProviderArn: Arn; + } + export interface DeleteConferenceProviderResponse { + } + export interface DeleteContactRequest { + /** + * The ARN of the contact to delete. + */ + ContactArn: Arn; + } + export interface DeleteContactResponse { + } + export interface DeleteDeviceRequest { + /** + * The ARN of the device for which to request details. + */ + DeviceArn: Arn; + } + export interface DeleteDeviceResponse { + } + export interface DeleteDeviceUsageDataRequest { + /** + * The ARN of the device. + */ + DeviceArn: Arn; + /** + * The type of usage data to delete. + */ + DeviceUsageType: DeviceUsageType; + } + export interface DeleteDeviceUsageDataResponse { + } + export interface DeleteGatewayGroupRequest { + /** + * The ARN of the gateway group to delete. + */ + GatewayGroupArn: Arn; + } + export interface DeleteGatewayGroupResponse { + } + export interface DeleteProfileRequest { + /** + * The ARN of the room profile to delete. Required. + */ + ProfileArn?: Arn; + } + export interface DeleteProfileResponse { + } + export interface DeleteRoomRequest { + /** + * The ARN of the room to delete. Required. + */ + RoomArn?: Arn; + } + export interface DeleteRoomResponse { + } + export interface DeleteRoomSkillParameterRequest { + /** + * The ARN of the room from which to remove the room skill parameter details. + */ + RoomArn?: Arn; + /** + * The ID of the skill from which to remove the room skill parameter details. + */ + SkillId: SkillId; + /** + * The room skill parameter key for which to remove details. + */ + ParameterKey: RoomSkillParameterKey; + } + export interface DeleteRoomSkillParameterResponse { + } + export interface DeleteSkillAuthorizationRequest { + /** + * The unique identifier of a skill. + */ + SkillId: SkillId; + /** + * The room that the skill is authorized for. + */ + RoomArn?: Arn; + } + export interface DeleteSkillAuthorizationResponse { + } + export interface DeleteSkillGroupRequest { + /** + * The ARN of the skill group to delete. Required. + */ + SkillGroupArn?: Arn; + } + export interface DeleteSkillGroupResponse { + } + export interface DeleteUserRequest { + /** + * The ARN of the user to delete in the organization. Required. + */ + UserArn?: Arn; + /** + * The ARN of the user's enrollment in the organization. Required. + */ + EnrollmentId: EnrollmentId; + } + export interface DeleteUserResponse { + } + export interface DeveloperInfo { + /** + * The name of the developer. + */ + DeveloperName?: DeveloperName; + /** + * The URL of the privacy policy. + */ + PrivacyPolicy?: PrivacyPolicy; + /** + * The email of the developer. + */ + Email?: Email; + /** + * The website of the developer. + */ + Url?: Url; + } + export type DeveloperName = string; + export interface Device { + /** + * The ARN of a device. + */ + DeviceArn?: Arn; + /** + * The serial number of a device. + */ + DeviceSerialNumber?: DeviceSerialNumber; + /** + * The type of a device. + */ + DeviceType?: DeviceType; + /** + * The name of a device. + */ + DeviceName?: DeviceName; + /** + * The software version of a device. + */ + SoftwareVersion?: SoftwareVersion; + /** + * The MAC address of a device. + */ + MacAddress?: MacAddress; + /** + * The room ARN of a device. + */ + RoomArn?: Arn; + /** + * The status of a device. If the status is not READY, check the DeviceStatusInfo value for details. + */ + DeviceStatus?: DeviceStatus; + /** + * Detailed information about a device's status. + */ + DeviceStatusInfo?: DeviceStatusInfo; + } + export interface DeviceData { + /** + * The ARN of a device. + */ + DeviceArn?: Arn; + /** + * The serial number of a device. + */ + DeviceSerialNumber?: DeviceSerialNumber; + /** + * The type of a device. + */ + DeviceType?: DeviceType; + /** + * The name of a device. + */ + DeviceName?: DeviceName; + /** + * The software version of a device. + */ + SoftwareVersion?: SoftwareVersion; + /** + * The MAC address of a device. + */ + MacAddress?: MacAddress; + /** + * The status of a device. + */ + DeviceStatus?: DeviceStatus; + /** + * The room ARN associated with a device. + */ + RoomArn?: Arn; + /** + * The name of the room associated with a device. + */ + RoomName?: RoomName; + /** + * Detailed information about a device's status. + */ + DeviceStatusInfo?: DeviceStatusInfo; + } + export type DeviceDataList = DeviceData[]; + export interface DeviceEvent { + /** + * The type of device event. + */ + Type?: DeviceEventType; + /** + * The value of the event. + */ + Value?: DeviceEventValue; + /** + * The time (in epoch) when the event occurred. + */ + Timestamp?: DeviceEventTime; + } + export type DeviceEventList = DeviceEvent[]; + export type DeviceEventTime = Date; + export type DeviceEventType = "CONNECTION_STATUS"|"DEVICE_STATUS"|string; + export type DeviceEventValue = string; + export type DeviceName = string; + export type DeviceSerialNumber = string; + export type DeviceSerialNumberForAVS = string; + export type DeviceStatus = "READY"|"PENDING"|"WAS_OFFLINE"|"DEREGISTERED"|string; + export interface DeviceStatusDetail { + /** + * The device status detail code. + */ + Code?: DeviceStatusDetailCode; + } + export type DeviceStatusDetailCode = "DEVICE_SOFTWARE_UPDATE_NEEDED"|"DEVICE_WAS_OFFLINE"|"CREDENTIALS_ACCESS_FAILURE"|"TLS_VERSION_MISMATCH"|"ASSOCIATION_REJECTION"|"AUTHENTICATION_FAILURE"|"DHCP_FAILURE"|"INTERNET_UNAVAILABLE"|"DNS_FAILURE"|"UNKNOWN_FAILURE"|"CERTIFICATE_ISSUING_LIMIT_EXCEEDED"|"INVALID_CERTIFICATE_AUTHORITY"|"NETWORK_PROFILE_NOT_FOUND"|"INVALID_PASSWORD_STATE"|"PASSWORD_NOT_FOUND"|string; + export type DeviceStatusDetails = DeviceStatusDetail[]; + export interface DeviceStatusInfo { + /** + * One or more device status detail descriptions. + */ + DeviceStatusDetails?: DeviceStatusDetails; + /** + * The latest available information about the connection status of a device. + */ + ConnectionStatus?: ConnectionStatus; + } + export type DeviceType = string; + export type DeviceUsageType = "VOICE"|string; + export interface DisassociateContactFromAddressBookRequest { + /** + * The ARN of the contact to disassociate from an address book. + */ + ContactArn: Arn; + /** + * The ARN of the address from which to disassociate the contact. + */ + AddressBookArn: Arn; + } + export interface DisassociateContactFromAddressBookResponse { + } + export interface DisassociateDeviceFromRoomRequest { + /** + * The ARN of the device to disassociate from a room. Required. + */ + DeviceArn?: Arn; + } + export interface DisassociateDeviceFromRoomResponse { + } + export interface DisassociateSkillFromSkillGroupRequest { + /** + * The unique identifier of a skill. Required. + */ + SkillGroupArn?: Arn; + /** + * The ARN of a skill group to associate to a skill. + */ + SkillId: SkillId; + } + export interface DisassociateSkillFromSkillGroupResponse { + } + export interface DisassociateSkillFromUsersRequest { + /** + * The private skill ID you want to make unavailable for enrolled users. + */ + SkillId: SkillId; + } + export interface DisassociateSkillFromUsersResponse { + } + export interface DisassociateSkillGroupFromRoomRequest { + /** + * The ARN of the skill group to disassociate from a room. Required. + */ + SkillGroupArn?: Arn; + /** + * The ARN of the room from which the skill group is to be disassociated. Required. + */ + RoomArn?: Arn; + } + export interface DisassociateSkillGroupFromRoomResponse { + } + export type DistanceUnit = "METRIC"|"IMPERIAL"|string; + export type E164PhoneNumber = string; + export type Email = string; + export type EnablementType = "ENABLED"|"PENDING"|string; + export type EnablementTypeFilter = "ENABLED"|"PENDING"|string; + export type EndUserLicenseAgreement = string; + export type Endpoint = string; + export type EnrollmentId = string; + export type EnrollmentStatus = "INITIALIZED"|"PENDING"|"REGISTERED"|"DISASSOCIATING"|"DEREGISTERING"|string; + export type Feature = "BLUETOOTH"|"VOLUME"|"NOTIFICATIONS"|"LISTS"|"SKILLS"|"ALL"|string; + export type Features = Feature[]; + export interface Filter { + /** + * The key of a filter. + */ + Key: FilterKey; + /** + * The values of a filter. + */ + Values: FilterValueList; + } + export type FilterKey = string; + export type FilterList = Filter[]; + export type FilterValue = string; + export type FilterValueList = FilterValue[]; + export interface ForgetSmartHomeAppliancesRequest { + /** + * The room that the appliances are associated with. + */ + RoomArn: Arn; + } + export interface ForgetSmartHomeAppliancesResponse { + } + export interface Gateway { + /** + * The ARN of the gateway. + */ + Arn?: Arn; + /** + * The name of the gateway. + */ + Name?: GatewayName; + /** + * The description of the gateway. + */ + Description?: GatewayDescription; + /** + * The ARN of the gateway group that the gateway is associated to. + */ + GatewayGroupArn?: Arn; + /** + * The software version of the gateway. The gateway automatically updates its software version during normal operation. + */ + SoftwareVersion?: GatewayVersion; + } + export type GatewayDescription = string; + export interface GatewayGroup { + /** + * The ARN of the gateway group. + */ + Arn?: Arn; + /** + * The name of the gateway group. + */ + Name?: GatewayGroupName; + /** + * The description of the gateway group. + */ + Description?: GatewayGroupDescription; + } + export type GatewayGroupDescription = string; + export type GatewayGroupName = string; + export type GatewayGroupSummaries = GatewayGroupSummary[]; + export interface GatewayGroupSummary { + /** + * The ARN of the gateway group. + */ + Arn?: Arn; + /** + * The name of the gateway group. + */ + Name?: GatewayGroupName; + /** + * The description of the gateway group. + */ + Description?: GatewayGroupDescription; + } + export type GatewayName = string; + export type GatewaySummaries = GatewaySummary[]; + export interface GatewaySummary { + /** + * The ARN of the gateway. + */ + Arn?: Arn; + /** + * The name of the gateway. + */ + Name?: GatewayName; + /** + * The description of the gateway. + */ + Description?: GatewayDescription; + /** + * The ARN of the gateway group that the gateway is associated to. + */ + GatewayGroupArn?: Arn; + /** + * The software version of the gateway. The gateway automatically updates its software version during normal operation. + */ + SoftwareVersion?: GatewayVersion; + } + export type GatewayVersion = string; + export type GenericKeyword = string; + export type GenericKeywords = GenericKeyword[]; + export interface GetAddressBookRequest { + /** + * The ARN of the address book for which to request details. + */ + AddressBookArn: Arn; + } + export interface GetAddressBookResponse { + /** + * The details of the requested address book. + */ + AddressBook?: AddressBook; + } + export interface GetConferencePreferenceRequest { + } + export interface GetConferencePreferenceResponse { + /** + * The conference preference. + */ + Preference?: ConferencePreference; + } + export interface GetConferenceProviderRequest { + /** + * The ARN of the newly created conference provider. + */ + ConferenceProviderArn: Arn; + } + export interface GetConferenceProviderResponse { + /** + * The conference provider. + */ + ConferenceProvider?: ConferenceProvider; + } + export interface GetContactRequest { + /** + * The ARN of the contact for which to request details. + */ + ContactArn: Arn; + } + export interface GetContactResponse { + /** + * The details of the requested contact. + */ + Contact?: Contact; + } + export interface GetDeviceRequest { + /** + * The ARN of the device for which to request details. Required. + */ + DeviceArn?: Arn; + } + export interface GetDeviceResponse { + /** + * The details of the device requested. Required. + */ + Device?: Device; + } + export interface GetGatewayGroupRequest { + /** + * The ARN of the gateway group to get. + */ + GatewayGroupArn: Arn; + } + export interface GetGatewayGroupResponse { + GatewayGroup?: GatewayGroup; + } + export interface GetGatewayRequest { + /** + * The ARN of the gateway to get. + */ + GatewayArn: Arn; + } + export interface GetGatewayResponse { + /** + * The details of the gateway. + */ + Gateway?: Gateway; + } + export interface GetInvitationConfigurationRequest { + } + export interface GetInvitationConfigurationResponse { + /** + * The name of the organization sending the enrollment invite to a user. + */ + OrganizationName?: OrganizationName; + /** + * The email ID of the organization or individual contact that the enrolled user can use. + */ + ContactEmail?: Email; + /** + * The list of private skill IDs that you want to recommend to the user to enable in the invitation. + */ + PrivateSkillIds?: ShortSkillIdList; + } + export interface GetProfileRequest { + /** + * The ARN of the room profile for which to request details. Required. + */ + ProfileArn?: Arn; + } + export interface GetProfileResponse { + /** + * The details of the room profile requested. Required. + */ + Profile?: Profile; + } + export interface GetRoomRequest { + /** + * The ARN of the room for which to request details. Required. + */ + RoomArn?: Arn; + } + export interface GetRoomResponse { + /** + * The details of the room requested. + */ + Room?: Room; + } + export interface GetRoomSkillParameterRequest { + /** + * The ARN of the room from which to get the room skill parameter details. + */ + RoomArn?: Arn; + /** + * The ARN of the skill from which to get the room skill parameter details. Required. + */ + SkillId: SkillId; + /** + * The room skill parameter key for which to get details. Required. + */ + ParameterKey: RoomSkillParameterKey; + } + export interface GetRoomSkillParameterResponse { + /** + * The details of the room skill parameter requested. Required. + */ + RoomSkillParameter?: RoomSkillParameter; + } + export interface GetSkillGroupRequest { + /** + * The ARN of the skill group for which to get details. Required. + */ + SkillGroupArn?: Arn; + } + export interface GetSkillGroupResponse { + /** + * The details of the skill group requested. Required. + */ + SkillGroup?: SkillGroup; + } + export interface IPDialIn { + /** + * The IP address. + */ + Endpoint: Endpoint; + /** + * The protocol, including SIP, SIPS, and H323. + */ + CommsProtocol: CommsProtocol; + } + export type IconUrl = string; + export type InvocationPhrase = string; + export type Key = string; + export interface ListBusinessReportSchedulesRequest { + /** + * The token used to list the remaining schedules from the previous API call. + */ + NextToken?: NextToken; + /** + * The maximum number of schedules listed in the call. + */ + MaxResults?: MaxResults; + } + export interface ListBusinessReportSchedulesResponse { + /** + * The schedule of the reports. + */ + BusinessReportSchedules?: BusinessReportScheduleList; + /** + * The token used to list the remaining schedules from the previous API call. + */ + NextToken?: NextToken; + } + export interface ListConferenceProvidersRequest { + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + /** + * The maximum number of conference providers to be returned, per paginated calls. + */ + MaxResults?: MaxResults; + } + export interface ListConferenceProvidersResponse { + /** + * The conference providers. + */ + ConferenceProviders?: ConferenceProvidersList; + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + } + export interface ListDeviceEventsRequest { + /** + * The ARN of a device. + */ + DeviceArn: Arn; + /** + * The event type to filter device events. If EventType isn't specified, 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. + */ + EventType?: DeviceEventType; + /** + * 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. When the end of results is reached, the response has a value of null. + */ + NextToken?: NextToken; + /** + * The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. + */ + MaxResults?: MaxResults; + } + export interface ListDeviceEventsResponse { + /** + * The device events requested for the device ARN. + */ + DeviceEvents?: DeviceEventList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + } + export interface ListGatewayGroupsRequest { + /** + * The token used to paginate though multiple pages of gateway group summaries. + */ + NextToken?: NextToken; + /** + * The maximum number of gateway group summaries to return. The default is 50. + */ + MaxResults?: MaxResults; + } + export interface ListGatewayGroupsResponse { + /** + * The gateway groups in the list. + */ + GatewayGroups?: GatewayGroupSummaries; + /** + * The token used to paginate though multiple pages of gateway group summaries. + */ + NextToken?: NextToken; + } + export interface ListGatewaysRequest { + /** + * The gateway group ARN for which to list gateways. + */ + GatewayGroupArn?: Arn; + /** + * The token used to paginate though multiple pages of gateway summaries. + */ + NextToken?: NextToken; + /** + * The maximum number of gateway summaries to return. The default is 50. + */ + MaxResults?: MaxResults; + } + export interface ListGatewaysResponse { + /** + * The gateways in the list. + */ + Gateways?: GatewaySummaries; + /** + * The token used to paginate though multiple pages of gateway summaries. + */ + NextToken?: NextToken; + } + export interface ListSkillsRequest { + /** + * The ARN of the skill group for which to list enabled skills. Required. + */ + SkillGroupArn?: Arn; + /** + * Whether the skill is enabled under the user's account, or if it requires linking to be used. + */ + EnablementType?: EnablementTypeFilter; + /** + * Whether the skill is publicly available or is a private skill. + */ + SkillType?: SkillTypeFilter; + /** + * 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 MaxResults. Required. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: SkillListMaxResults; + } + export interface ListSkillsResponse { + /** + * The list of enabled skills requested. Required. + */ + SkillSummaries?: SkillSummaryList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + } + export interface ListSkillsStoreCategoriesRequest { + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + /** + * The maximum number of categories returned, per paginated calls. + */ + MaxResults?: MaxResults; + } + export interface ListSkillsStoreCategoriesResponse { + /** + * The list of categories. + */ + CategoryList?: CategoryList; + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + } + export interface ListSkillsStoreSkillsByCategoryRequest { + /** + * The category ID for which the skills are being retrieved from the skill store. + */ + CategoryId: CategoryId; + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + /** + * The maximum number of skills returned per paginated calls. + */ + MaxResults?: SkillListMaxResults; + } + export interface ListSkillsStoreSkillsByCategoryResponse { + /** + * The skill store skills. + */ + SkillsStoreSkills?: SkillsStoreSkillList; + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + } + export interface ListSmartHomeAppliancesRequest { + /** + * The room that the appliances are associated with. + */ + RoomArn: Arn; + /** + * The maximum number of appliances to be returned, per paginated calls. + */ + MaxResults?: MaxResults; + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + } + export interface ListSmartHomeAppliancesResponse { + /** + * The smart home appliances. + */ + SmartHomeAppliances?: SmartHomeApplianceList; + /** + * The tokens used for pagination. + */ + NextToken?: NextToken; + } + export interface ListTagsRequest { + /** + * The ARN of the specified resource for which to list tags. + */ + Arn: Arn; + /** + * 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 MaxResults. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + } + export interface ListTagsResponse { + /** + * The tags requested for the specified resource. + */ + Tags?: TagList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + } + export type Locale = "en-US"|string; + export type MacAddress = string; + export type MaxResults = number; + export type MaxVolumeLimit = number; + export interface MeetingSetting { + /** + * The values that indicate whether the pin is always required. + */ + RequirePin: RequirePin; + } + export type NewInThisVersionBulletPoints = BulletPoint[]; + export type NextToken = string; + export type OneClickIdDelay = string; + export type OneClickPinDelay = string; + export type OrganizationName = string; + export type OutboundPhoneNumber = string; + export interface PSTNDialIn { + /** + * The zip code. + */ + CountryCode: CountryCode; + /** + * The phone number to call to join the conference. + */ + PhoneNumber: OutboundPhoneNumber; + /** + * The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network. + */ + OneClickIdDelay: OneClickIdDelay; + /** + * The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network. + */ + OneClickPinDelay: OneClickPinDelay; + } + export type PrivacyPolicy = string; + export type ProductDescription = string; + export type ProductId = string; + export interface Profile { + /** + * The ARN of a room profile. + */ + ProfileArn?: Arn; + /** + * The name of a room profile. + */ + ProfileName?: ProfileName; + /** + * Retrieves if the profile is default or not. + */ + IsDefault?: Boolean; + /** + * The address of a room profile. + */ + Address?: Address; + /** + * The time zone of a room profile. + */ + Timezone?: Timezone; + /** + * The distance unit of a room profile. + */ + DistanceUnit?: DistanceUnit; + /** + * The temperature unit of a room profile. + */ + TemperatureUnit?: TemperatureUnit; + /** + * The wake word of a room profile. + */ + WakeWord?: WakeWord; + /** + * The setup mode of a room profile. + */ + SetupModeDisabled?: Boolean; + /** + * The max volume limit of a room profile. + */ + MaxVolumeLimit?: MaxVolumeLimit; + /** + * The PSTN setting of a room profile. + */ + PSTNEnabled?: Boolean; + /** + * The ARN of the address book. + */ + AddressBookArn?: Arn; + } + export interface ProfileData { + /** + * The ARN of a room profile. + */ + ProfileArn?: Arn; + /** + * The name of a room profile. + */ + ProfileName?: ProfileName; + /** + * Retrieves if the profile data is default or not. + */ + IsDefault?: Boolean; + /** + * The address of a room profile. + */ + Address?: Address; + /** + * The timezone of a room profile. + */ + Timezone?: Timezone; + /** + * The distance unit of a room profile. + */ + DistanceUnit?: DistanceUnit; + /** + * The temperature unit of a room profile. + */ + TemperatureUnit?: TemperatureUnit; + /** + * The wake word of a room profile. + */ + WakeWord?: WakeWord; + } + export type ProfileDataList = ProfileData[]; + export type ProfileName = string; + export type ProviderCalendarId = string; + export interface PutConferencePreferenceRequest { + /** + * The conference preference of a specific conference provider. + */ + ConferencePreference: ConferencePreference; + } + export interface PutConferencePreferenceResponse { + } + export interface PutInvitationConfigurationRequest { + /** + * The name of the organization sending the enrollment invite to a user. + */ + OrganizationName: OrganizationName; + /** + * The email ID of the organization or individual contact that the enrolled user can use. + */ + ContactEmail?: Email; + /** + * The list of private skill IDs that you want to recommend to the user to enable in the invitation. + */ + PrivateSkillIds?: ShortSkillIdList; + } + export interface PutInvitationConfigurationResponse { + } + export interface PutRoomSkillParameterRequest { + /** + * The ARN of the room associated with the room skill parameter. Required. + */ + RoomArn?: Arn; + /** + * The ARN of the skill associated with the room skill parameter. Required. + */ + SkillId: SkillId; + /** + * The updated room skill parameter. Required. + */ + RoomSkillParameter: RoomSkillParameter; + } + export interface PutRoomSkillParameterResponse { + } + export interface PutSkillAuthorizationRequest { + /** + * The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization. + */ + AuthorizationResult: AuthorizationResult; + /** + * The unique identifier of a skill. + */ + SkillId: SkillId; + /** + * The room that the skill is authorized for. + */ + RoomArn?: Arn; + } + export interface PutSkillAuthorizationResponse { + } + export interface RegisterAVSDeviceRequest { + /** + * The client ID of the OEM used for code-based linking authorization on an AVS device. + */ + ClientId: ClientId; + /** + * The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification. + */ + UserCode: UserCode; + /** + * The product ID used to identify your AVS device during authorization. + */ + ProductId: ProductId; + /** + * The key generated by the OEM that uniquely identifies a specified instance of your AVS device. + */ + DeviceSerialNumber: DeviceSerialNumberForAVS; + /** + * The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console. + */ + AmazonId: AmazonId; + } + export interface RegisterAVSDeviceResponse { + /** + * The ARN of the device. + */ + DeviceArn?: Arn; + } + export interface RejectSkillRequest { + /** + * The unique identifier of the skill. + */ + SkillId: SkillId; + } + export interface RejectSkillResponse { + } + export type ReleaseDate = string; + export type RequirePin = "YES"|"NO"|"OPTIONAL"|string; + export interface ResolveRoomRequest { + /** + * The ARN of the user. Required. + */ + UserId: UserId; + /** + * The ARN of the skill that was requested. Required. + */ + SkillId: SkillId; + } + export interface ResolveRoomResponse { + /** + * The ARN of the room from which the skill request was invoked. + */ + RoomArn?: Arn; + /** + * The name of the room from which the skill request was invoked. + */ + RoomName?: RoomName; + /** + * Response to get the room profile request. Required. + */ + RoomSkillParameters?: RoomSkillParameters; + } + export type ReviewKey = string; + export type ReviewValue = string; + export type Reviews = {[key: string]: ReviewValue}; + export interface RevokeInvitationRequest { + /** + * The ARN of the user for whom to revoke an enrollment invitation. Required. + */ + UserArn?: Arn; + /** + * The ARN of the enrollment invitation to revoke. Required. + */ + EnrollmentId?: EnrollmentId; + } + export interface RevokeInvitationResponse { + } + export interface Room { + /** + * The ARN of a room. + */ + RoomArn?: Arn; + /** + * The name of a room. + */ + RoomName?: RoomName; + /** + * The description of a room. + */ + Description?: RoomDescription; + /** + * The provider calendar ARN of a room. + */ + ProviderCalendarId?: ProviderCalendarId; + /** + * The profile ARN of a room. + */ + ProfileArn?: Arn; + } + export interface RoomData { + /** + * The ARN of a room. + */ + RoomArn?: Arn; + /** + * The name of a room. + */ + RoomName?: RoomName; + /** + * The description of a room. + */ + Description?: RoomDescription; + /** + * The provider calendar ARN of a room. + */ + ProviderCalendarId?: ProviderCalendarId; + /** + * The profile ARN of a room. + */ + ProfileArn?: Arn; + /** + * The profile name of a room. + */ + ProfileName?: ProfileName; + } + export type RoomDataList = RoomData[]; + export type RoomDescription = string; + export type RoomName = string; + export interface RoomSkillParameter { + /** + * The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values. + */ + ParameterKey: RoomSkillParameterKey; + /** + * The parameter value of a room skill parameter. + */ + ParameterValue: RoomSkillParameterValue; + } + export type RoomSkillParameterKey = string; + export type RoomSkillParameterValue = string; + export type RoomSkillParameters = RoomSkillParameter[]; + export type S3KeyPrefix = string; + export type SampleUtterances = Utterance[]; + export interface SearchAddressBooksRequest { + /** + * The filters to use to list a specified set of address books. The supported filter key is AddressBookName. + */ + Filters?: FilterList; + /** + * The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName. + */ + SortCriteria?: SortList; + /** + * 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. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + } + export interface SearchAddressBooksResponse { + /** + * The address books that meet the specified set of filter criteria, in sort order. + */ + AddressBooks?: AddressBookDataList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + /** + * The total number of address books returned. + */ + TotalCount?: TotalCount; + } + export interface SearchContactsRequest { + /** + * The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns. + */ + Filters?: FilterList; + /** + * The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName. + */ + SortCriteria?: SortList; + /** + * 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. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + } + export interface SearchContactsResponse { + /** + * The contacts that meet the specified set of filter criteria, in sort order. + */ + Contacts?: ContactDataList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + /** + * The total number of contacts returned. + */ + TotalCount?: TotalCount; + } + export interface SearchDevicesRequest { + /** + * 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 MaxResults. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + /** + * 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). + */ + Filters?: FilterList; + /** + * The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus. + */ + SortCriteria?: SortList; + } + export interface SearchDevicesResponse { + /** + * The devices that meet the specified set of filter criteria, in sort order. + */ + Devices?: DeviceDataList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + /** + * The total number of devices returned. + */ + TotalCount?: TotalCount; + } + export interface SearchProfilesRequest { + /** + * 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 MaxResults. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + /** + * The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required. + */ + Filters?: FilterList; + /** + * The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address. + */ + SortCriteria?: SortList; + } + export interface SearchProfilesResponse { + /** + * The profiles that meet the specified set of filter criteria, in sort order. + */ + Profiles?: ProfileDataList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + /** + * The total number of room profiles returned. + */ + TotalCount?: TotalCount; + } + export interface SearchRoomsRequest { + /** + * 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 MaxResults. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + /** + * The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName. + */ + Filters?: FilterList; + /** + * The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName. + */ + SortCriteria?: SortList; + } + export interface SearchRoomsResponse { + /** + * The rooms that meet the specified set of filter criteria, in sort order. + */ + Rooms?: RoomDataList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + /** + * The total number of rooms returned. + */ + TotalCount?: TotalCount; + } + export interface SearchSkillGroupsRequest { + /** + * 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 MaxResults. Required. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + /** + * The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName. + */ + Filters?: FilterList; + /** + * The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName. + */ + SortCriteria?: SortList; + } + export interface SearchSkillGroupsResponse { + /** + * The skill groups that meet the filter criteria, in sort order. + */ + SkillGroups?: SkillGroupDataList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + /** + * The total number of skill groups returned. + */ + TotalCount?: TotalCount; + } + export interface SearchUsersRequest { + /** + * 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 MaxResults. Required. + */ + NextToken?: NextToken; + /** + * 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. + */ + MaxResults?: MaxResults; + /** + * The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus. + */ + Filters?: FilterList; + /** + * The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus. + */ + SortCriteria?: SortList; + } + export interface SearchUsersResponse { + /** + * The users that meet the specified set of filter criteria, in sort order. + */ + Users?: UserDataList; + /** + * The token returned to indicate that there is more data available. + */ + NextToken?: NextToken; + /** + * The total number of users returned. + */ + TotalCount?: TotalCount; + } + export interface SendAnnouncementRequest { + /** + * The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list. + */ + RoomFilters: FilterList; + /** + * The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio). + */ + Content: Content; + /** + * The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered. + */ + TimeToLiveInSeconds?: TimeToLiveInSeconds; + /** + * The unique, user-specified identifier for the request that ensures idempotency. + */ + ClientRequestToken: ClientRequestToken; + } + export interface SendAnnouncementResponse { + /** + * The identifier of the announcement. + */ + AnnouncementArn?: Arn; + } + export interface SendInvitationRequest { + /** + * The ARN of the user to whom to send an invitation. Required. + */ + UserArn?: Arn; + } + export interface SendInvitationResponse { + } + export type ShortDescription = string; + export type ShortSkillIdList = SkillId[]; + export interface SkillDetails { + /** + * The description of the product. + */ + ProductDescription?: ProductDescription; + /** + * The phrase used to trigger the skill. + */ + InvocationPhrase?: InvocationPhrase; + /** + * The date when the skill was released. + */ + ReleaseDate?: ReleaseDate; + /** + * The URL of the end user license agreement. + */ + EndUserLicenseAgreement?: EndUserLicenseAgreement; + /** + * The generic keywords associated with the skill that can be used to find a skill. + */ + GenericKeywords?: GenericKeywords; + /** + * The details about what the skill supports organized as bullet points. + */ + BulletPoints?: BulletPoints; + /** + * The updates added in bullet points. + */ + NewInThisVersionBulletPoints?: NewInThisVersionBulletPoints; + /** + * The types of skills. + */ + SkillTypes?: SkillTypes; + /** + * The list of reviews for the skill, including Key and Value pair. + */ + Reviews?: Reviews; + /** + * The details about the developer that published the skill. + */ + DeveloperInfo?: DeveloperInfo; + } + export interface SkillGroup { + /** + * The ARN of a skill group. + */ + SkillGroupArn?: Arn; + /** + * The name of a skill group. + */ + SkillGroupName?: SkillGroupName; + /** + * The description of a skill group. + */ + Description?: SkillGroupDescription; + } + export interface SkillGroupData { + /** + * The skill group ARN of a skill group. + */ + SkillGroupArn?: Arn; + /** + * The skill group name of a skill group. + */ + SkillGroupName?: SkillGroupName; + /** + * The description of a skill group. + */ + Description?: SkillGroupDescription; + } + export type SkillGroupDataList = SkillGroupData[]; + export type SkillGroupDescription = string; + export type SkillGroupName = string; + export type SkillId = string; + export type SkillListMaxResults = number; + export type SkillName = string; + export type SkillStoreType = string; + export interface SkillSummary { + /** + * The ARN of the skill summary. + */ + SkillId?: SkillId; + /** + * The name of the skill. + */ + SkillName?: SkillName; + /** + * Linking support for a skill. + */ + SupportsLinking?: boolean; + /** + * Whether the skill is enabled under the user's account, or if it requires linking to be used. + */ + EnablementType?: EnablementType; + /** + * Whether the skill is publicly available or is a private skill. + */ + SkillType?: SkillType; + } + export type SkillSummaryList = SkillSummary[]; + export type SkillType = "PUBLIC"|"PRIVATE"|string; + export type SkillTypeFilter = "PUBLIC"|"PRIVATE"|"ALL"|string; + export type SkillTypes = SkillStoreType[]; + export interface SkillsStoreSkill { + /** + * The ARN of the skill. + */ + SkillId?: SkillId; + /** + * The name of the skill. + */ + SkillName?: SkillName; + /** + * Short description about the skill. + */ + ShortDescription?: ShortDescription; + /** + * The URL where the skill icon resides. + */ + IconUrl?: IconUrl; + /** + * Sample utterances that interact with the skill. + */ + SampleUtterances?: SampleUtterances; + /** + * Information about the skill. + */ + SkillDetails?: SkillDetails; + /** + * Linking support for a skill. + */ + SupportsLinking?: boolean; + } + export type SkillsStoreSkillList = SkillsStoreSkill[]; + export interface SmartHomeAppliance { + /** + * The friendly name of the smart home appliance. + */ + FriendlyName?: ApplianceFriendlyName; + /** + * The description of the smart home appliance. + */ + Description?: ApplianceDescription; + /** + * The name of the manufacturer of the smart home appliance. + */ + ManufacturerName?: ApplianceManufacturerName; + } + export type SmartHomeApplianceList = SmartHomeAppliance[]; + export type SoftwareVersion = string; + export interface Sort { + /** + * The sort key of a sort object. + */ + Key: SortKey; + /** + * The sort value of a sort object. + */ + Value: SortValue; + } + export type SortKey = string; + export type SortList = Sort[]; + export type SortValue = "ASC"|"DESC"|string; + export interface Ssml { + /** + * The locale of the SSML message. Currently, en-US is supported. + */ + Locale: Locale; + /** + * The value of the SSML message in the correct SSML format. The audio tag is not supported. + */ + Value: SsmlValue; + } + export type SsmlList = Ssml[]; + export type SsmlValue = string; + export interface StartDeviceSyncRequest { + /** + * The ARN of the room with which the device to sync is associated. Required. + */ + RoomArn?: Arn; + /** + * The ARN of the device to sync. Required. + */ + DeviceArn?: Arn; + /** + * Request structure to start the device sync. Required. + */ + Features: Features; + } + export interface StartDeviceSyncResponse { + } + export interface StartSmartHomeApplianceDiscoveryRequest { + /** + * The room where smart home appliance discovery was initiated. + */ + RoomArn: Arn; + } + export interface StartSmartHomeApplianceDiscoveryResponse { + } + export interface Tag { + /** + * The key of a tag. Tag keys are case-sensitive. + */ + Key: TagKey; + /** + * The value of a tag. Tag values are case-sensitive and can be null. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The ARN of the resource to which to add metadata tags. Required. + */ + Arn: Arn; + /** + * The tags to be added to the specified resource. Do not provide system tags. Required. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type TemperatureUnit = "FAHRENHEIT"|"CELSIUS"|string; + export interface Text { + /** + * The locale of the text message. Currently, en-US is supported. + */ + Locale: Locale; + /** + * The value of the text message. + */ + Value: TextValue; + } + export type TextList = Text[]; + export type TextValue = string; + export type TimeToLiveInSeconds = number; + export type Timezone = string; + export type TotalCount = number; + export interface UntagResourceRequest { + /** + * The ARN of the resource from which to remove metadata tags. Required. + */ + Arn: Arn; + /** + * The tags to be removed from the specified resource. Do not provide system tags. Required. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateAddressBookRequest { + /** + * The ARN of the room to update. + */ + AddressBookArn: Arn; + /** + * The updated name of the room. + */ + Name?: AddressBookName; + /** + * The updated description of the room. + */ + Description?: AddressBookDescription; + } + export interface UpdateAddressBookResponse { + } + export interface UpdateBusinessReportScheduleRequest { + /** + * The ARN of the business report schedule. + */ + ScheduleArn: Arn; + /** + * The S3 location of the output reports. + */ + S3BucketName?: CustomerS3BucketName; + /** + * The S3 key where the report is delivered. + */ + S3KeyPrefix?: S3KeyPrefix; + /** + * The format of the generated report (individual CSV files or zipped files of individual files). + */ + Format?: BusinessReportFormat; + /** + * The name identifier of the schedule. + */ + ScheduleName?: BusinessReportScheduleName; + /** + * The recurrence of the reports. + */ + Recurrence?: BusinessReportRecurrence; + } + export interface UpdateBusinessReportScheduleResponse { + } + export interface UpdateConferenceProviderRequest { + /** + * The ARN of the conference provider. + */ + ConferenceProviderArn: Arn; + /** + * The type of the conference provider. + */ + ConferenceProviderType: ConferenceProviderType; + /** + * The IP endpoint and protocol for calling. + */ + IPDialIn?: IPDialIn; + /** + * The information for PSTN conferencing. + */ + PSTNDialIn?: PSTNDialIn; + /** + * The meeting settings for the conference provider. + */ + MeetingSetting: MeetingSetting; + } + export interface UpdateConferenceProviderResponse { + } + export interface UpdateContactRequest { + /** + * The ARN of the contact to update. + */ + ContactArn: Arn; + /** + * The updated display name of the contact. + */ + DisplayName?: ContactName; + /** + * The updated first name of the contact. + */ + FirstName?: ContactName; + /** + * The updated last name of the contact. + */ + LastName?: ContactName; + /** + * The updated phone number of the contact. + */ + PhoneNumber?: E164PhoneNumber; + } + export interface UpdateContactResponse { + } + export interface UpdateDeviceRequest { + /** + * The ARN of the device to update. Required. + */ + DeviceArn?: Arn; + /** + * The updated device name. Required. + */ + DeviceName?: DeviceName; + } + export interface UpdateDeviceResponse { + } + export interface UpdateGatewayGroupRequest { + /** + * The ARN of the gateway group to update. + */ + GatewayGroupArn: Arn; + /** + * The updated name of the gateway group. + */ + Name?: GatewayGroupName; + /** + * The updated description of the gateway group. + */ + Description?: GatewayGroupDescription; + } + export interface UpdateGatewayGroupResponse { + } + export interface UpdateGatewayRequest { + /** + * The ARN of the gateway to update. + */ + GatewayArn: Arn; + /** + * The updated name of the gateway. + */ + Name?: GatewayName; + /** + * The updated description of the gateway. + */ + Description?: GatewayDescription; + /** + * The updated software version of the gateway. The gateway automatically updates its software version during normal operation. + */ + SoftwareVersion?: GatewayVersion; + } + export interface UpdateGatewayResponse { + } + export interface UpdateProfileRequest { + /** + * The ARN of the room profile to update. Required. + */ + ProfileArn?: Arn; + /** + * The updated name for the room profile. + */ + ProfileName?: ProfileName; + /** + * Sets the profile as default if selected. If this is missing, no update is done to the default status. + */ + IsDefault?: Boolean; + /** + * The updated timezone for the room profile. + */ + Timezone?: Timezone; + /** + * The updated address for the room profile. + */ + Address?: Address; + /** + * The updated distance unit for the room profile. + */ + DistanceUnit?: DistanceUnit; + /** + * The updated temperature unit for the room profile. + */ + TemperatureUnit?: TemperatureUnit; + /** + * The updated wake word for the room profile. + */ + WakeWord?: WakeWord; + /** + * Whether the setup mode of the profile is enabled. + */ + SetupModeDisabled?: Boolean; + /** + * The updated maximum volume limit for the room profile. + */ + MaxVolumeLimit?: MaxVolumeLimit; + /** + * Whether the PSTN setting of the room profile is enabled. + */ + PSTNEnabled?: Boolean; + } + export interface UpdateProfileResponse { + } + export interface UpdateRoomRequest { + /** + * The ARN of the room to update. + */ + RoomArn?: Arn; + /** + * The updated name for the room. + */ + RoomName?: RoomName; + /** + * The updated description for the room. + */ + Description?: RoomDescription; + /** + * The updated provider calendar ARN for the room. + */ + ProviderCalendarId?: ProviderCalendarId; + /** + * The updated profile ARN for the room. + */ + ProfileArn?: Arn; + } + export interface UpdateRoomResponse { + } + export interface UpdateSkillGroupRequest { + /** + * The ARN of the skill group to update. + */ + SkillGroupArn?: Arn; + /** + * The updated name for the skill group. + */ + SkillGroupName?: SkillGroupName; + /** + * The updated description for the skill group. + */ + Description?: SkillGroupDescription; + } + export interface UpdateSkillGroupResponse { + } + export type Url = string; + export type UserCode = string; + export interface UserData { + /** + * The ARN of a user. + */ + UserArn?: Arn; + /** + * The first name of a user. + */ + FirstName?: user_FirstName; + /** + * The last name of a user. + */ + LastName?: user_LastName; + /** + * The email of a user. + */ + Email?: Email; + /** + * The enrollment status of a user. + */ + EnrollmentStatus?: EnrollmentStatus; + /** + * The enrollment ARN of a user. + */ + EnrollmentId?: EnrollmentId; + } + export type UserDataList = UserData[]; + export type UserId = string; + export type Utterance = string; + export type Value = string; + export type WakeWord = "ALEXA"|"AMAZON"|"ECHO"|"COMPUTER"|string; + export type user_FirstName = string; + export type user_LastName = string; + export type user_UserId = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-11-09"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the AlexaForBusiness client. + */ + export import Types = AlexaForBusiness; +} +export = AlexaForBusiness; diff --git a/node_modules/aws-sdk/clients/alexaforbusiness.js b/node_modules/aws-sdk/clients/alexaforbusiness.js new file mode 100644 index 0000000..b021f39 --- /dev/null +++ b/node_modules/aws-sdk/clients/alexaforbusiness.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['alexaforbusiness'] = {}; +AWS.AlexaForBusiness = Service.defineService('alexaforbusiness', ['2017-11-09']); +Object.defineProperty(apiLoader.services['alexaforbusiness'], '2017-11-09', { + get: function get() { + var model = require('../apis/alexaforbusiness-2017-11-09.min.json'); + model.paginators = require('../apis/alexaforbusiness-2017-11-09.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.AlexaForBusiness; diff --git a/node_modules/aws-sdk/clients/all.d.ts b/node_modules/aws-sdk/clients/all.d.ts new file mode 100644 index 0000000..4c47ab4 --- /dev/null +++ b/node_modules/aws-sdk/clients/all.d.ts @@ -0,0 +1,174 @@ +export import ACM = require('./acm'); +export import APIGateway = require('./apigateway'); +export import ApplicationAutoScaling = require('./applicationautoscaling'); +export import AppStream = require('./appstream'); +export import AutoScaling = require('./autoscaling'); +export import Batch = require('./batch'); +export import Budgets = require('./budgets'); +export import CloudDirectory = require('./clouddirectory'); +export import CloudFormation = require('./cloudformation'); +export import CloudFront = require('./cloudfront'); +export import CloudHSM = require('./cloudhsm'); +export import CloudSearch = require('./cloudsearch'); +export import CloudSearchDomain = require('./cloudsearchdomain'); +export import CloudTrail = require('./cloudtrail'); +export import CloudWatch = require('./cloudwatch'); +export import CloudWatchEvents = require('./cloudwatchevents'); +export import CloudWatchLogs = require('./cloudwatchlogs'); +export import CodeBuild = require('./codebuild'); +export import CodeCommit = require('./codecommit'); +export import CodeDeploy = require('./codedeploy'); +export import CodePipeline = require('./codepipeline'); +export import CognitoIdentity = require('./cognitoidentity'); +export import CognitoIdentityServiceProvider = require('./cognitoidentityserviceprovider'); +export import CognitoSync = require('./cognitosync'); +export import ConfigService = require('./configservice'); +export import CUR = require('./cur'); +export import DataPipeline = require('./datapipeline'); +export import DeviceFarm = require('./devicefarm'); +export import DirectConnect = require('./directconnect'); +export import DirectoryService = require('./directoryservice'); +export import Discovery = require('./discovery'); +export import DMS = require('./dms'); +export import DynamoDB = require('./dynamodb'); +export import DynamoDBStreams = require('./dynamodbstreams'); +export import EC2 = require('./ec2'); +export import ECR = require('./ecr'); +export import ECS = require('./ecs'); +export import EFS = require('./efs'); +export import ElastiCache = require('./elasticache'); +export import ElasticBeanstalk = require('./elasticbeanstalk'); +export import ELB = require('./elb'); +export import ELBv2 = require('./elbv2'); +export import EMR = require('./emr'); +export import ES = require('./es'); +export import ElasticTranscoder = require('./elastictranscoder'); +export import Firehose = require('./firehose'); +export import GameLift = require('./gamelift'); +export import Glacier = require('./glacier'); +export import Health = require('./health'); +export import IAM = require('./iam'); +export import ImportExport = require('./importexport'); +export import Inspector = require('./inspector'); +export import Iot = require('./iot'); +export import IotData = require('./iotdata'); +export import Kinesis = require('./kinesis'); +export import KinesisAnalytics = require('./kinesisanalytics'); +export import KMS = require('./kms'); +export import Lambda = require('./lambda'); +export import LexRuntime = require('./lexruntime'); +export import Lightsail = require('./lightsail'); +export import MachineLearning = require('./machinelearning'); +export import MarketplaceCommerceAnalytics = require('./marketplacecommerceanalytics'); +export import MarketplaceMetering = require('./marketplacemetering'); +export import MTurk = require('./mturk'); +export import MobileAnalytics = require('./mobileanalytics'); +export import OpsWorks = require('./opsworks'); +export import OpsWorksCM = require('./opsworkscm'); +export import Organizations = require('./organizations'); +export import Pinpoint = require('./pinpoint'); +export import Polly = require('./polly'); +export import RDS = require('./rds'); +export import Redshift = require('./redshift'); +export import Rekognition = require('./rekognition'); +export import ResourceGroupsTaggingAPI = require('./resourcegroupstaggingapi'); +export import Route53 = require('./route53'); +export import Route53Domains = require('./route53domains'); +export import S3 = require('./s3'); +export import S3Control = require('./s3control'); +export import ServiceCatalog = require('./servicecatalog'); +export import SES = require('./ses'); +export import Shield = require('./shield'); +export import SimpleDB = require('./simpledb'); +export import SMS = require('./sms'); +export import Snowball = require('./snowball'); +export import SNS = require('./sns'); +export import SQS = require('./sqs'); +export import SSM = require('./ssm'); +export import StorageGateway = require('./storagegateway'); +export import StepFunctions = require('./stepfunctions'); +export import STS = require('./sts'); +export import Support = require('./support'); +export import SWF = require('./swf'); +export import XRay = require('./xray'); +export import WAF = require('./waf'); +export import WAFRegional = require('./wafregional'); +export import WorkDocs = require('./workdocs'); +export import WorkSpaces = require('./workspaces'); +export import CodeStar = require('./codestar'); +export import LexModelBuildingService = require('./lexmodelbuildingservice'); +export import MarketplaceEntitlementService = require('./marketplaceentitlementservice'); +export import Athena = require('./athena'); +export import Greengrass = require('./greengrass'); +export import DAX = require('./dax'); +export import MigrationHub = require('./migrationhub'); +export import CloudHSMV2 = require('./cloudhsmv2'); +export import Glue = require('./glue'); +export import Mobile = require('./mobile'); +export import Pricing = require('./pricing'); +export import CostExplorer = require('./costexplorer'); +export import MediaConvert = require('./mediaconvert'); +export import MediaLive = require('./medialive'); +export import MediaPackage = require('./mediapackage'); +export import MediaStore = require('./mediastore'); +export import MediaStoreData = require('./mediastoredata'); +export import AppSync = require('./appsync'); +export import GuardDuty = require('./guardduty'); +export import MQ = require('./mq'); +export import Comprehend = require('./comprehend'); +export import IoTJobsDataPlane = require('./iotjobsdataplane'); +export import KinesisVideoArchivedMedia = require('./kinesisvideoarchivedmedia'); +export import KinesisVideoMedia = require('./kinesisvideomedia'); +export import KinesisVideo = require('./kinesisvideo'); +export import SageMakerRuntime = require('./sagemakerruntime'); +export import SageMaker = require('./sagemaker'); +export import Translate = require('./translate'); +export import ResourceGroups = require('./resourcegroups'); +export import AlexaForBusiness = require('./alexaforbusiness'); +export import Cloud9 = require('./cloud9'); +export import ServerlessApplicationRepository = require('./serverlessapplicationrepository'); +export import ServiceDiscovery = require('./servicediscovery'); +export import WorkMail = require('./workmail'); +export import AutoScalingPlans = require('./autoscalingplans'); +export import TranscribeService = require('./transcribeservice'); +export import Connect = require('./connect'); +export import ACMPCA = require('./acmpca'); +export import FMS = require('./fms'); +export import SecretsManager = require('./secretsmanager'); +export import IoTAnalytics = require('./iotanalytics'); +export import IoT1ClickDevicesService = require('./iot1clickdevicesservice'); +export import IoT1ClickProjects = require('./iot1clickprojects'); +export import PI = require('./pi'); +export import Neptune = require('./neptune'); +export import MediaTailor = require('./mediatailor'); +export import EKS = require('./eks'); +export import Macie = require('./macie'); +export import DLM = require('./dlm'); +export import Signer = require('./signer'); +export import Chime = require('./chime'); +export import PinpointEmail = require('./pinpointemail'); +export import RAM = require('./ram'); +export import Route53Resolver = require('./route53resolver'); +export import PinpointSMSVoice = require('./pinpointsmsvoice'); +export import QuickSight = require('./quicksight'); +export import RDSDataService = require('./rdsdataservice'); +export import Amplify = require('./amplify'); +export import DataSync = require('./datasync'); +export import RoboMaker = require('./robomaker'); +export import Transfer = require('./transfer'); +export import GlobalAccelerator = require('./globalaccelerator'); +export import ComprehendMedical = require('./comprehendmedical'); +export import KinesisAnalyticsV2 = require('./kinesisanalyticsv2'); +export import MediaConnect = require('./mediaconnect'); +export import FSx = require('./fsx'); +export import SecurityHub = require('./securityhub'); +export import AppMesh = require('./appmesh'); +export import LicenseManager = require('./licensemanager'); +export import Kafka = require('./kafka'); +export import ApiGatewayManagementApi = require('./apigatewaymanagementapi'); +export import ApiGatewayV2 = require('./apigatewayv2'); +export import DocDB = require('./docdb'); +export import Backup = require('./backup'); +export import WorkLink = require('./worklink'); +export import Textract = require('./textract'); +export import ManagedBlockchain = require('./managedblockchain'); diff --git a/node_modules/aws-sdk/clients/all.js b/node_modules/aws-sdk/clients/all.js new file mode 100644 index 0000000..a8d060d --- /dev/null +++ b/node_modules/aws-sdk/clients/all.js @@ -0,0 +1,177 @@ +require('../lib/node_loader'); +module.exports = { + ACM: require('./acm'), + APIGateway: require('./apigateway'), + ApplicationAutoScaling: require('./applicationautoscaling'), + AppStream: require('./appstream'), + AutoScaling: require('./autoscaling'), + Batch: require('./batch'), + Budgets: require('./budgets'), + CloudDirectory: require('./clouddirectory'), + CloudFormation: require('./cloudformation'), + CloudFront: require('./cloudfront'), + CloudHSM: require('./cloudhsm'), + CloudSearch: require('./cloudsearch'), + CloudSearchDomain: require('./cloudsearchdomain'), + CloudTrail: require('./cloudtrail'), + CloudWatch: require('./cloudwatch'), + CloudWatchEvents: require('./cloudwatchevents'), + CloudWatchLogs: require('./cloudwatchlogs'), + CodeBuild: require('./codebuild'), + CodeCommit: require('./codecommit'), + CodeDeploy: require('./codedeploy'), + CodePipeline: require('./codepipeline'), + CognitoIdentity: require('./cognitoidentity'), + CognitoIdentityServiceProvider: require('./cognitoidentityserviceprovider'), + CognitoSync: require('./cognitosync'), + ConfigService: require('./configservice'), + CUR: require('./cur'), + DataPipeline: require('./datapipeline'), + DeviceFarm: require('./devicefarm'), + DirectConnect: require('./directconnect'), + DirectoryService: require('./directoryservice'), + Discovery: require('./discovery'), + DMS: require('./dms'), + DynamoDB: require('./dynamodb'), + DynamoDBStreams: require('./dynamodbstreams'), + EC2: require('./ec2'), + ECR: require('./ecr'), + ECS: require('./ecs'), + EFS: require('./efs'), + ElastiCache: require('./elasticache'), + ElasticBeanstalk: require('./elasticbeanstalk'), + ELB: require('./elb'), + ELBv2: require('./elbv2'), + EMR: require('./emr'), + ES: require('./es'), + ElasticTranscoder: require('./elastictranscoder'), + Firehose: require('./firehose'), + GameLift: require('./gamelift'), + Glacier: require('./glacier'), + Health: require('./health'), + IAM: require('./iam'), + ImportExport: require('./importexport'), + Inspector: require('./inspector'), + Iot: require('./iot'), + IotData: require('./iotdata'), + Kinesis: require('./kinesis'), + KinesisAnalytics: require('./kinesisanalytics'), + KMS: require('./kms'), + Lambda: require('./lambda'), + LexRuntime: require('./lexruntime'), + Lightsail: require('./lightsail'), + MachineLearning: require('./machinelearning'), + MarketplaceCommerceAnalytics: require('./marketplacecommerceanalytics'), + MarketplaceMetering: require('./marketplacemetering'), + MTurk: require('./mturk'), + MobileAnalytics: require('./mobileanalytics'), + OpsWorks: require('./opsworks'), + OpsWorksCM: require('./opsworkscm'), + Organizations: require('./organizations'), + Pinpoint: require('./pinpoint'), + Polly: require('./polly'), + RDS: require('./rds'), + Redshift: require('./redshift'), + Rekognition: require('./rekognition'), + ResourceGroupsTaggingAPI: require('./resourcegroupstaggingapi'), + Route53: require('./route53'), + Route53Domains: require('./route53domains'), + S3: require('./s3'), + S3Control: require('./s3control'), + ServiceCatalog: require('./servicecatalog'), + SES: require('./ses'), + Shield: require('./shield'), + SimpleDB: require('./simpledb'), + SMS: require('./sms'), + Snowball: require('./snowball'), + SNS: require('./sns'), + SQS: require('./sqs'), + SSM: require('./ssm'), + StorageGateway: require('./storagegateway'), + StepFunctions: require('./stepfunctions'), + STS: require('./sts'), + Support: require('./support'), + SWF: require('./swf'), + XRay: require('./xray'), + WAF: require('./waf'), + WAFRegional: require('./wafregional'), + WorkDocs: require('./workdocs'), + WorkSpaces: require('./workspaces'), + CodeStar: require('./codestar'), + LexModelBuildingService: require('./lexmodelbuildingservice'), + MarketplaceEntitlementService: require('./marketplaceentitlementservice'), + Athena: require('./athena'), + Greengrass: require('./greengrass'), + DAX: require('./dax'), + MigrationHub: require('./migrationhub'), + CloudHSMV2: require('./cloudhsmv2'), + Glue: require('./glue'), + Mobile: require('./mobile'), + Pricing: require('./pricing'), + CostExplorer: require('./costexplorer'), + MediaConvert: require('./mediaconvert'), + MediaLive: require('./medialive'), + MediaPackage: require('./mediapackage'), + MediaStore: require('./mediastore'), + MediaStoreData: require('./mediastoredata'), + AppSync: require('./appsync'), + GuardDuty: require('./guardduty'), + MQ: require('./mq'), + Comprehend: require('./comprehend'), + IoTJobsDataPlane: require('./iotjobsdataplane'), + KinesisVideoArchivedMedia: require('./kinesisvideoarchivedmedia'), + KinesisVideoMedia: require('./kinesisvideomedia'), + KinesisVideo: require('./kinesisvideo'), + SageMakerRuntime: require('./sagemakerruntime'), + SageMaker: require('./sagemaker'), + Translate: require('./translate'), + ResourceGroups: require('./resourcegroups'), + AlexaForBusiness: require('./alexaforbusiness'), + Cloud9: require('./cloud9'), + ServerlessApplicationRepository: require('./serverlessapplicationrepository'), + ServiceDiscovery: require('./servicediscovery'), + WorkMail: require('./workmail'), + AutoScalingPlans: require('./autoscalingplans'), + TranscribeService: require('./transcribeservice'), + Connect: require('./connect'), + ACMPCA: require('./acmpca'), + FMS: require('./fms'), + SecretsManager: require('./secretsmanager'), + IoTAnalytics: require('./iotanalytics'), + IoT1ClickDevicesService: require('./iot1clickdevicesservice'), + IoT1ClickProjects: require('./iot1clickprojects'), + PI: require('./pi'), + Neptune: require('./neptune'), + MediaTailor: require('./mediatailor'), + EKS: require('./eks'), + Macie: require('./macie'), + DLM: require('./dlm'), + Signer: require('./signer'), + Chime: require('./chime'), + PinpointEmail: require('./pinpointemail'), + RAM: require('./ram'), + Route53Resolver: require('./route53resolver'), + PinpointSMSVoice: require('./pinpointsmsvoice'), + QuickSight: require('./quicksight'), + RDSDataService: require('./rdsdataservice'), + Amplify: require('./amplify'), + DataSync: require('./datasync'), + RoboMaker: require('./robomaker'), + Transfer: require('./transfer'), + GlobalAccelerator: require('./globalaccelerator'), + ComprehendMedical: require('./comprehendmedical'), + KinesisAnalyticsV2: require('./kinesisanalyticsv2'), + MediaConnect: require('./mediaconnect'), + FSx: require('./fsx'), + SecurityHub: require('./securityhub'), + AppMesh: require('./appmesh'), + LicenseManager: require('./licensemanager'), + Kafka: require('./kafka'), + ApiGatewayManagementApi: require('./apigatewaymanagementapi'), + ApiGatewayV2: require('./apigatewayv2'), + DocDB: require('./docdb'), + Backup: require('./backup'), + WorkLink: require('./worklink'), + Textract: require('./textract'), + ManagedBlockchain: require('./managedblockchain') +}; \ No newline at end of file diff --git a/node_modules/aws-sdk/clients/amplify.d.ts b/node_modules/aws-sdk/clients/amplify.d.ts new file mode 100644 index 0000000..e12f52f --- /dev/null +++ b/node_modules/aws-sdk/clients/amplify.d.ts @@ -0,0 +1,1128 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Amplify extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Amplify.Types.ClientConfiguration) + config: Config & Amplify.Types.ClientConfiguration; + /** + * Creates a new Amplify App. + */ + createApp(params: Amplify.Types.CreateAppRequest, callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request; + /** + * Creates a new Amplify App. + */ + createApp(callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request; + /** + * Creates a new Branch for an Amplify App. + */ + createBranch(params: Amplify.Types.CreateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request; + /** + * Creates a new Branch for an Amplify App. + */ + createBranch(callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request; + /** + * Create a new DomainAssociation on an App + */ + createDomainAssociation(params: Amplify.Types.CreateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request; + /** + * Create a new DomainAssociation on an App + */ + createDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request; + /** + * Delete an existing Amplify App by appId. + */ + deleteApp(params: Amplify.Types.DeleteAppRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request; + /** + * Delete an existing Amplify App by appId. + */ + deleteApp(callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request; + /** + * Deletes a branch for an Amplify App. + */ + deleteBranch(params: Amplify.Types.DeleteBranchRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request; + /** + * Deletes a branch for an Amplify App. + */ + deleteBranch(callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request; + /** + * Deletes a DomainAssociation. + */ + deleteDomainAssociation(params: Amplify.Types.DeleteDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request; + /** + * Deletes a DomainAssociation. + */ + deleteDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request; + /** + * Delete a job, for an Amplify branch, part of Amplify App. + */ + deleteJob(params: Amplify.Types.DeleteJobRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request; + /** + * Delete a job, for an Amplify branch, part of Amplify App. + */ + deleteJob(callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request; + /** + * Retrieves an existing Amplify App by appId. + */ + getApp(params: Amplify.Types.GetAppRequest, callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request; + /** + * Retrieves an existing Amplify App by appId. + */ + getApp(callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request; + /** + * Retrieves a branch for an Amplify App. + */ + getBranch(params: Amplify.Types.GetBranchRequest, callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request; + /** + * Retrieves a branch for an Amplify App. + */ + getBranch(callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request; + /** + * Retrieves domain info that corresponds to an appId and domainName. + */ + getDomainAssociation(params: Amplify.Types.GetDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request; + /** + * Retrieves domain info that corresponds to an appId and domainName. + */ + getDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request; + /** + * Get a job for a branch, part of an Amplify App. + */ + getJob(params: Amplify.Types.GetJobRequest, callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request; + /** + * Get a job for a branch, part of an Amplify App. + */ + getJob(callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request; + /** + * Lists existing Amplify Apps. + */ + listApps(params: Amplify.Types.ListAppsRequest, callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request; + /** + * Lists existing Amplify Apps. + */ + listApps(callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request; + /** + * Lists branches for an Amplify App. + */ + listBranches(params: Amplify.Types.ListBranchesRequest, callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request; + /** + * Lists branches for an Amplify App. + */ + listBranches(callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request; + /** + * List domains with an app + */ + listDomainAssociations(params: Amplify.Types.ListDomainAssociationsRequest, callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request; + /** + * List domains with an app + */ + listDomainAssociations(callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request; + /** + * List Jobs for a branch, part of an Amplify App. + */ + listJobs(params: Amplify.Types.ListJobsRequest, callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request; + /** + * List Jobs for a branch, part of an Amplify App. + */ + listJobs(callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request; + /** + * Starts a new job for a branch, part of an Amplify App. + */ + startJob(params: Amplify.Types.StartJobRequest, callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request; + /** + * Starts a new job for a branch, part of an Amplify App. + */ + startJob(callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request; + /** + * Stop a job that is in progress, for an Amplify branch, part of Amplify App. + */ + stopJob(params: Amplify.Types.StopJobRequest, callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request; + /** + * Stop a job that is in progress, for an Amplify branch, part of Amplify App. + */ + stopJob(callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request; + /** + * Updates an existing Amplify App. + */ + updateApp(params: Amplify.Types.UpdateAppRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request; + /** + * Updates an existing Amplify App. + */ + updateApp(callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request; + /** + * Updates a branch for an Amplify App. + */ + updateBranch(params: Amplify.Types.UpdateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request; + /** + * Updates a branch for an Amplify App. + */ + updateBranch(callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request; + /** + * Create a new DomainAssociation on an App + */ + updateDomainAssociation(params: Amplify.Types.UpdateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request; + /** + * Create a new DomainAssociation on an App + */ + updateDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request; +} +declare namespace Amplify { + export type ActiveJobId = string; + export interface App { + /** + * Unique Id for the Amplify App. + */ + appId: AppId; + /** + * ARN for the Amplify App. + */ + appArn: AppArn; + /** + * Name for the Amplify App. + */ + name: Name; + /** + * Tag for Amplify App. + */ + tags?: Tags; + /** + * Description for the Amplify App. + */ + description: Description; + /** + * Repository for the Amplify App. + */ + repository: Repository; + /** + * Platform for the Amplify App. + */ + platform: Platform; + /** + * Create date / time for the Amplify App. + */ + createTime: CreateTime; + /** + * Update date / time for the Amplify App. + */ + updateTime: UpdateTime; + /** + * IAM service role ARN for the Amplify App. + */ + iamServiceRoleArn?: ServiceRoleArn; + /** + * Environment Variables for the Amplify App. + */ + environmentVariables: EnvironmentVariables; + /** + * Default domain for the Amplify App. + */ + defaultDomain: DefaultDomain; + /** + * Enables auto-building of branches for the Amplify App. + */ + enableBranchAutoBuild: EnableBranchAutoBuild; + /** + * Enables Basic Authorization for branches for the Amplify App. + */ + enableBasicAuth: EnableBasicAuth; + /** + * Basic Authorization credentials for branches for the Amplify App. + */ + basicAuthCredentials?: BasicAuthCredentials; + /** + * Custom redirect / rewrite rules for the Amplify App. + */ + customRules?: CustomRules; + /** + * Structure with Production Branch information. + */ + productionBranch?: ProductionBranch; + /** + * BuildSpec content for Amplify App. + */ + buildSpec?: BuildSpec; + } + export type AppArn = string; + export type AppId = string; + export type Apps = App[]; + export type ArtifactsUrl = string; + export type BasicAuthCredentials = string; + export interface Branch { + /** + * ARN for a branch, part of an Amplify App. + */ + branchArn: BranchArn; + /** + * Name for a branch, part of an Amplify App. + */ + branchName: BranchName; + /** + * Description for a branch, part of an Amplify App. + */ + description: Description; + /** + * Tag for branch for Amplify App. + */ + tags?: Tags; + /** + * Stage for a branch, part of an Amplify App. + */ + stage: Stage; + /** + * Display name for a branch, part of an Amplify App. + */ + displayName?: DisplayName; + /** + * Enables notifications for a branch, part of an Amplify App. + */ + enableNotification: EnableNotification; + /** + * Creation date and time for a branch, part of an Amplify App. + */ + createTime: CreateTime; + /** + * Last updated date and time for a branch, part of an Amplify App. + */ + updateTime: UpdateTime; + /** + * Environment Variables specific to a branch, part of an Amplify App. + */ + environmentVariables: EnvironmentVariables; + /** + * Enables auto-building on push for a branch, part of an Amplify App. + */ + enableAutoBuild: EnableAutoBuild; + /** + * Custom domains for a branch, part of an Amplify App. + */ + customDomains: CustomDomains; + /** + * Framework for a branch, part of an Amplify App. + */ + framework: Framework; + /** + * Id of the active job for a branch, part of an Amplify App. + */ + activeJobId: ActiveJobId; + /** + * Total number of Jobs part of an Amplify App. + */ + totalNumberOfJobs: TotalNumberOfJobs; + /** + * Enables Basic Authorization for a branch, part of an Amplify App. + */ + enableBasicAuth: EnableBasicAuth; + /** + * Thumbnail Url for the branch. + */ + thumbnailUrl?: ThumbnailUrl; + /** + * Basic Authorization credentials for a branch, part of an Amplify App. + */ + basicAuthCredentials?: BasicAuthCredentials; + /** + * BuildSpec content for branch for Amplify App. + */ + buildSpec?: BuildSpec; + /** + * The content TTL for the website in seconds. + */ + ttl: TTL; + } + export type BranchArn = string; + export type BranchName = string; + export type Branches = Branch[]; + export type BuildSpec = string; + export type CertificateVerificationDNSRecord = string; + export type CommitId = string; + export type CommitMessage = string; + export type CommitTime = Date; + export type Condition = string; + export interface CreateAppRequest { + /** + * Name for the Amplify App + */ + name: Name; + /** + * Description for an Amplify App + */ + description?: Description; + /** + * Repository for an Amplify App + */ + repository: Repository; + /** + * Platform / framework for an Amplify App + */ + platform: Platform; + /** + * AWS IAM service role for an Amplify App + */ + iamServiceRoleArn?: ServiceRoleArn; + /** + * OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored. + */ + oauthToken: OauthToken; + /** + * Environment variables map for an Amplify App. + */ + environmentVariables?: EnvironmentVariables; + /** + * Enable the auto building of branches for an Amplify App. + */ + enableBranchAutoBuild?: EnableBranchAutoBuild; + /** + * Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App. + */ + enableBasicAuth?: EnableBasicAuth; + /** + * Credentials for Basic Authorization for an Amplify App. + */ + basicAuthCredentials?: BasicAuthCredentials; + /** + * Custom rewrite / redirect rules for an Amplify App. + */ + customRules?: CustomRules; + /** + * Tag for an Amplify App + */ + tags?: Tags; + /** + * BuildSpec for an Amplify App + */ + buildSpec?: BuildSpec; + } + export interface CreateAppResult { + app: App; + } + export interface CreateBranchRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch. + */ + branchName: BranchName; + /** + * Description for the branch. + */ + description?: Description; + /** + * Stage for the branch. + */ + stage?: Stage; + /** + * Framework for the branch. + */ + framework?: Framework; + /** + * Enables notifications for the branch. + */ + enableNotification?: EnableNotification; + /** + * Enables auto building for the branch. + */ + enableAutoBuild?: EnableAutoBuild; + /** + * Environment Variables for the branch. + */ + environmentVariables?: EnvironmentVariables; + /** + * Basic Authorization credentials for the branch. + */ + basicAuthCredentials?: BasicAuthCredentials; + /** + * Enables Basic Auth for the branch. + */ + enableBasicAuth?: EnableBasicAuth; + /** + * Tag for the branch. + */ + tags?: Tags; + /** + * BuildSpec for the branch. + */ + buildSpec?: BuildSpec; + /** + * The content TTL for the website in seconds. + */ + ttl?: TTL; + } + export interface CreateBranchResult { + /** + * Branch structure for an Amplify App. + */ + branch: Branch; + } + export interface CreateDomainAssociationRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Domain name for the Domain Association. + */ + domainName: DomainName; + /** + * Enables automated creation of Subdomains for branches. + */ + enableAutoSubDomain?: EnableAutoSubDomain; + /** + * Setting structure for the Subdomain. + */ + subDomainSettings: SubDomainSettings; + } + export interface CreateDomainAssociationResult { + /** + * Domain Association structure. + */ + domainAssociation: DomainAssociation; + } + export type CreateTime = Date; + export type CustomDomain = string; + export type CustomDomains = CustomDomain[]; + export interface CustomRule { + /** + * The source pattern for a URL rewrite or redirect rule. + */ + source: Source; + /** + * The target pattern for a URL rewrite or redirect rule. + */ + target: Target; + /** + * The status code for a URL rewrite or redirect rule. + */ + status?: Status; + /** + * The condition for a URL rewrite or redirect rule, e.g. country code. + */ + condition?: Condition; + } + export type CustomRules = CustomRule[]; + export type DNSRecord = string; + export type DefaultDomain = string; + export interface DeleteAppRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + } + export interface DeleteAppResult { + app: App; + } + export interface DeleteBranchRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch. + */ + branchName: BranchName; + } + export interface DeleteBranchResult { + /** + * Branch structure for an Amplify App. + */ + branch: Branch; + } + export interface DeleteDomainAssociationRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name of the domain. + */ + domainName: DomainName; + } + export interface DeleteDomainAssociationResult { + domainAssociation: DomainAssociation; + } + export interface DeleteJobRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch, for the Job. + */ + branchName: BranchName; + /** + * Unique Id for the Job. + */ + jobId: JobId; + } + export interface DeleteJobResult { + jobSummary: JobSummary; + } + export type Description = string; + export type DisplayName = string; + export interface DomainAssociation { + /** + * ARN for the Domain Association. + */ + domainAssociationArn: DomainAssociationArn; + /** + * Name of the domain. + */ + domainName: DomainName; + /** + * Enables automated creation of Subdomains for branches. + */ + enableAutoSubDomain: EnableAutoSubDomain; + /** + * Status fo the Domain Association. + */ + domainStatus: DomainStatus; + /** + * Reason for the current status of the Domain Association. + */ + statusReason: StatusReason; + /** + * DNS Record for certificate verification. + */ + certificateVerificationDNSRecord: CertificateVerificationDNSRecord; + /** + * Subdomains for the Domain Association. + */ + subDomains: SubDomains; + } + export type DomainAssociationArn = string; + export type DomainAssociations = DomainAssociation[]; + export type DomainName = string; + export type DomainPrefix = string; + export type DomainStatus = "PENDING_VERIFICATION"|"IN_PROGRESS"|"AVAILABLE"|"PENDING_DEPLOYMENT"|"FAILED"|string; + export type EnableAutoBuild = boolean; + export type EnableAutoSubDomain = boolean; + export type EnableBasicAuth = boolean; + export type EnableBranchAutoBuild = boolean; + export type EnableNotification = boolean; + export type EndTime = Date; + export type EnvKey = string; + export type EnvValue = string; + export type EnvironmentVariables = {[key: string]: EnvValue}; + export type Framework = string; + export interface GetAppRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + } + export interface GetAppResult { + app: App; + } + export interface GetBranchRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch. + */ + branchName: BranchName; + } + export interface GetBranchResult { + branch: Branch; + } + export interface GetDomainAssociationRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name of the domain. + */ + domainName: DomainName; + } + export interface GetDomainAssociationResult { + /** + * Domain Association structure. + */ + domainAssociation: DomainAssociation; + } + export interface GetJobRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch, for the Job. + */ + branchName: BranchName; + /** + * Unique Id for the Job. + */ + jobId: JobId; + } + export interface GetJobResult { + job: Job; + } + export interface Job { + /** + * Summary for an execution job for an Amplify App. + */ + summary: JobSummary; + /** + * Execution steps for an execution job, for an Amplify App. + */ + steps: Steps; + } + export type JobArn = string; + export type JobId = string; + export type JobReason = string; + export type JobStatus = "PENDING"|"PROVISIONING"|"RUNNING"|"FAILED"|"SUCCEED"|"CANCELLING"|"CANCELLED"|string; + export type JobSummaries = JobSummary[]; + export interface JobSummary { + /** + * Arn for the Job. + */ + jobArn: JobArn; + /** + * Unique Id for the Job. + */ + jobId: JobId; + /** + * Commit Id from 3rd party repository provider for the Job. + */ + commitId: CommitId; + /** + * Commit message from 3rd party repository provider for the Job. + */ + commitMessage: CommitMessage; + /** + * Commit date / time for the Job. + */ + commitTime: CommitTime; + /** + * Start date / time for the Job. + */ + startTime: StartTime; + /** + * Status for the Job. + */ + status: JobStatus; + /** + * End date / time for the Job. + */ + endTime?: EndTime; + /** + * Type for the Job. + */ + jobType: JobType; + } + export type JobType = "RELEASE"|"RETRY"|"WEB_HOOK"|string; + export type LastDeployTime = Date; + export interface ListAppsRequest { + /** + * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries. + */ + nextToken?: NextToken; + /** + * Maximum number of records to list in a single response. + */ + maxResults?: MaxResults; + } + export interface ListAppsResult { + /** + * List of Amplify Apps. + */ + apps: Apps; + /** + * Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects. + */ + nextToken?: NextToken; + } + export interface ListBranchesRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches. + */ + nextToken?: NextToken; + /** + * Maximum number of records to list in a single response. + */ + maxResults?: MaxResults; + } + export interface ListBranchesResult { + /** + * List of branches for an Amplify App. + */ + branches: Branches; + /** + * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries. + */ + nextToken?: NextToken; + } + export interface ListDomainAssociationsRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects. + */ + nextToken?: NextToken; + /** + * Maximum number of records to list in a single response. + */ + maxResults?: MaxResults; + } + export interface ListDomainAssociationsResult { + /** + * List of Domain Associations. + */ + domainAssociations: DomainAssociations; + /** + * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries. + */ + nextToken?: NextToken; + } + export interface ListJobsRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for a branch. + */ + branchName: BranchName; + /** + * Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps. + */ + nextToken?: NextToken; + /** + * Maximum number of records to list in a single response. + */ + maxResults?: MaxResults; + } + export interface ListJobsResult { + /** + * Result structure for list job result request. + */ + jobSummaries: JobSummaries; + /** + * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries. + */ + nextToken?: NextToken; + } + export type LogUrl = string; + export type MaxResults = number; + export type Name = string; + export type NextToken = string; + export type OauthToken = string; + export type Platform = "IOS"|"ANDROID"|"WEB"|"REACT_NATIVE"|string; + export interface ProductionBranch { + /** + * Last Deploy Time of Production Branch. + */ + lastDeployTime?: LastDeployTime; + /** + * Status of Production Branch. + */ + status?: Status; + /** + * Thumbnail Url for Production Branch. + */ + thumbnailUrl?: ThumbnailUrl; + /** + * Branch Name for Production Branch. + */ + branchName?: BranchName; + } + export type Repository = string; + export type Screenshots = {[key: string]: ThumbnailUrl}; + export type ServiceRoleArn = string; + export type Source = string; + export type Stage = "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|string; + export interface StartJobRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch, for the Job. + */ + branchName: BranchName; + /** + * Unique Id for the Job. + */ + jobId?: JobId; + /** + * Type for the Job. + */ + jobType: JobType; + /** + * Reason for the Job. + */ + jobReason?: JobReason; + /** + * Commit Id from 3rd party repository provider for the Job. + */ + commitId?: CommitId; + /** + * Commit message from 3rd party repository provider for the Job. + */ + commitMessage?: CommitMessage; + /** + * Commit date / time for the Job. + */ + commitTime?: CommitTime; + } + export interface StartJobResult { + /** + * Summary for the Job. + */ + jobSummary: JobSummary; + } + export type StartTime = Date; + export type Status = string; + export type StatusReason = string; + export interface Step { + /** + * Name of the execution step. + */ + stepName: StepName; + /** + * Start date/ time of the execution step. + */ + startTime: StartTime; + /** + * Status of the execution step. + */ + status: JobStatus; + /** + * End date/ time of the execution step. + */ + endTime: EndTime; + /** + * Url to the logs for the execution step. + */ + logUrl?: LogUrl; + /** + * Url to teh artifact for the execution step. + */ + artifactsUrl?: ArtifactsUrl; + /** + * List of screenshot Urls for the execution step, if relevant. + */ + screenshots?: Screenshots; + } + export type StepName = string; + export type Steps = Step[]; + export interface StopJobRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch, for the Job. + */ + branchName: BranchName; + /** + * Unique Id for the Job. + */ + jobId: JobId; + } + export interface StopJobResult { + /** + * Summary for the Job. + */ + jobSummary: JobSummary; + } + export interface SubDomain { + /** + * Setting structure for the Subdomain. + */ + subDomainSetting: SubDomainSetting; + /** + * Verified status of the Subdomain + */ + verified: Verified; + /** + * DNS record for the Subdomain. + */ + dnsRecord: DNSRecord; + } + export interface SubDomainSetting { + /** + * Prefix setting for the Subdomain. + */ + prefix: DomainPrefix; + /** + * Branch name setting for the Subdomain. + */ + branchName: BranchName; + } + export type SubDomainSettings = SubDomainSetting[]; + export type SubDomains = SubDomain[]; + export type TTL = string; + export type TagKey = string; + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export type Target = string; + export type ThumbnailName = string; + export type ThumbnailUrl = string; + export type TotalNumberOfJobs = string; + export interface UpdateAppRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for an Amplify App. + */ + name?: Name; + /** + * Description for an Amplify App. + */ + description?: Description; + /** + * Platform for an Amplify App. + */ + platform?: Platform; + /** + * IAM service role for an Amplify App. + */ + iamServiceRoleArn?: ServiceRoleArn; + /** + * Environment Variables for an Amplify App. + */ + environmentVariables?: EnvironmentVariables; + /** + * Enables branch auto-building for an Amplify App. + */ + enableBranchAutoBuild?: EnableAutoBuild; + /** + * Enables Basic Authorization for an Amplify App. + */ + enableBasicAuth?: EnableBasicAuth; + /** + * Basic Authorization credentials for an Amplify App. + */ + basicAuthCredentials?: BasicAuthCredentials; + /** + * Custom redirect / rewrite rules for an Amplify App. + */ + customRules?: CustomRules; + /** + * BuildSpec for an Amplify App. + */ + buildSpec?: BuildSpec; + } + export interface UpdateAppResult { + /** + * App structure for the updated App. + */ + app: App; + } + export interface UpdateBranchRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name for the branch. + */ + branchName: BranchName; + /** + * Description for the branch. + */ + description?: Description; + /** + * Framework for the branch. + */ + framework?: Framework; + /** + * Stage for the branch. + */ + stage?: Stage; + /** + * Enables notifications for the branch. + */ + enableNotification?: EnableNotification; + /** + * Enables auto building for the branch. + */ + enableAutoBuild?: EnableAutoBuild; + /** + * Environment Variables for the branch. + */ + environmentVariables?: EnvironmentVariables; + /** + * Basic Authorization credentials for the branch. + */ + basicAuthCredentials?: BasicAuthCredentials; + /** + * Enables Basic Auth for the branch. + */ + enableBasicAuth?: EnableBasicAuth; + /** + * BuildSpec for the branch. + */ + buildSpec?: BuildSpec; + /** + * The content TTL for the website in seconds. + */ + ttl?: TTL; + } + export interface UpdateBranchResult { + /** + * Branch structure for an Amplify App. + */ + branch: Branch; + } + export interface UpdateDomainAssociationRequest { + /** + * Unique Id for an Amplify App. + */ + appId: AppId; + /** + * Name of the domain. + */ + domainName: DomainName; + /** + * Enables automated creation of Subdomains for branches. + */ + enableAutoSubDomain?: EnableAutoSubDomain; + /** + * Setting structure for the Subdomain. + */ + subDomainSettings: SubDomainSettings; + } + export interface UpdateDomainAssociationResult { + /** + * Domain Association structure. + */ + domainAssociation: DomainAssociation; + } + export type UpdateTime = Date; + export type Verified = boolean; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-07-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Amplify client. + */ + export import Types = Amplify; +} +export = Amplify; diff --git a/node_modules/aws-sdk/clients/amplify.js b/node_modules/aws-sdk/clients/amplify.js new file mode 100644 index 0000000..93cf9f2 --- /dev/null +++ b/node_modules/aws-sdk/clients/amplify.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['amplify'] = {}; +AWS.Amplify = Service.defineService('amplify', ['2017-07-25']); +Object.defineProperty(apiLoader.services['amplify'], '2017-07-25', { + get: function get() { + var model = require('../apis/amplify-2017-07-25.min.json'); + model.paginators = require('../apis/amplify-2017-07-25.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Amplify; diff --git a/node_modules/aws-sdk/clients/apigateway.d.ts b/node_modules/aws-sdk/clients/apigateway.d.ts new file mode 100644 index 0000000..33f2e16 --- /dev/null +++ b/node_modules/aws-sdk/clients/apigateway.d.ts @@ -0,0 +1,4048 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class APIGateway extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: APIGateway.Types.ClientConfiguration) + config: Config & APIGateway.Types.ClientConfiguration; + /** + * Create an ApiKey resource. AWS CLI + */ + createApiKey(params: APIGateway.Types.CreateApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request; + /** + * Create an ApiKey resource. AWS CLI + */ + createApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request; + /** + * Adds a new Authorizer resource to an existing RestApi resource. AWS CLI + */ + createAuthorizer(params: APIGateway.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request; + /** + * Adds a new Authorizer resource to an existing RestApi resource. AWS CLI + */ + createAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request; + /** + * Creates a new BasePathMapping resource. + */ + createBasePathMapping(params: APIGateway.Types.CreateBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request; + /** + * Creates a new BasePathMapping resource. + */ + createBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request; + /** + * Creates a Deployment resource, which makes a specified RestApi callable over the internet. + */ + createDeployment(params: APIGateway.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request; + /** + * Creates a Deployment resource, which makes a specified RestApi callable over the internet. + */ + createDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request; + /** + * + */ + createDocumentationPart(params: APIGateway.Types.CreateDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request; + /** + * + */ + createDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request; + /** + * + */ + createDocumentationVersion(params: APIGateway.Types.CreateDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request; + /** + * + */ + createDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request; + /** + * Creates a new domain name. + */ + createDomainName(params: APIGateway.Types.CreateDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request; + /** + * Creates a new domain name. + */ + createDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request; + /** + * Adds a new Model resource to an existing RestApi resource. + */ + createModel(params: APIGateway.Types.CreateModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request; + /** + * Adds a new Model resource to an existing RestApi resource. + */ + createModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request; + /** + * Creates a ReqeustValidator of a given RestApi. + */ + createRequestValidator(params: APIGateway.Types.CreateRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request; + /** + * Creates a ReqeustValidator of a given RestApi. + */ + createRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request; + /** + * Creates a Resource resource. + */ + createResource(params: APIGateway.Types.CreateResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request; + /** + * Creates a Resource resource. + */ + createResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request; + /** + * Creates a new RestApi resource. + */ + createRestApi(params: APIGateway.Types.CreateRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Creates a new RestApi resource. + */ + createRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Creates a new Stage resource that references a pre-existing Deployment for the API. + */ + createStage(params: APIGateway.Types.CreateStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request; + /** + * Creates a new Stage resource that references a pre-existing Deployment for the API. + */ + createStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request; + /** + * Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. + */ + createUsagePlan(params: APIGateway.Types.CreateUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request; + /** + * Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. + */ + createUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request; + /** + * Creates a usage plan key for adding an existing API key to a usage plan. + */ + createUsagePlanKey(params: APIGateway.Types.CreateUsagePlanKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request; + /** + * Creates a usage plan key for adding an existing API key to a usage plan. + */ + createUsagePlanKey(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request; + /** + * Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services. + */ + createVpcLink(params: APIGateway.Types.CreateVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request; + /** + * Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services. + */ + createVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request; + /** + * Deletes the ApiKey resource. + */ + deleteApiKey(params: APIGateway.Types.DeleteApiKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the ApiKey resource. + */ + deleteApiKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing Authorizer resource. AWS CLI + */ + deleteAuthorizer(params: APIGateway.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing Authorizer resource. AWS CLI + */ + deleteAuthorizer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the BasePathMapping resource. + */ + deleteBasePathMapping(params: APIGateway.Types.DeleteBasePathMappingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the BasePathMapping resource. + */ + deleteBasePathMapping(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the ClientCertificate resource. + */ + deleteClientCertificate(params: APIGateway.Types.DeleteClientCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the ClientCertificate resource. + */ + deleteClientCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. + */ + deleteDeployment(params: APIGateway.Types.DeleteDeploymentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. + */ + deleteDeployment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + deleteDocumentationPart(params: APIGateway.Types.DeleteDocumentationPartRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + deleteDocumentationPart(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + deleteDocumentationVersion(params: APIGateway.Types.DeleteDocumentationVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + deleteDocumentationVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the DomainName resource. + */ + deleteDomainName(params: APIGateway.Types.DeleteDomainNameRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the DomainName resource. + */ + deleteDomainName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. + */ + deleteGatewayResponse(params: APIGateway.Types.DeleteGatewayResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. + */ + deleteGatewayResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents a delete integration. + */ + deleteIntegration(params: APIGateway.Types.DeleteIntegrationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents a delete integration. + */ + deleteIntegration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents a delete integration response. + */ + deleteIntegrationResponse(params: APIGateway.Types.DeleteIntegrationResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents a delete integration response. + */ + deleteIntegrationResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing Method resource. + */ + deleteMethod(params: APIGateway.Types.DeleteMethodRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing Method resource. + */ + deleteMethod(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing MethodResponse resource. + */ + deleteMethodResponse(params: APIGateway.Types.DeleteMethodResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing MethodResponse resource. + */ + deleteMethodResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a model. + */ + deleteModel(params: APIGateway.Types.DeleteModelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a model. + */ + deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a RequestValidator of a given RestApi. + */ + deleteRequestValidator(params: APIGateway.Types.DeleteRequestValidatorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a RequestValidator of a given RestApi. + */ + deleteRequestValidator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Resource resource. + */ + deleteResource(params: APIGateway.Types.DeleteResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Resource resource. + */ + deleteResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified API. + */ + deleteRestApi(params: APIGateway.Types.DeleteRestApiRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified API. + */ + deleteRestApi(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Stage resource. + */ + deleteStage(params: APIGateway.Types.DeleteStageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Stage resource. + */ + deleteStage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a usage plan of a given plan Id. + */ + deleteUsagePlan(params: APIGateway.Types.DeleteUsagePlanRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a usage plan of a given plan Id. + */ + deleteUsagePlan(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a usage plan key and remove the underlying API key from the associated usage plan. + */ + deleteUsagePlanKey(params: APIGateway.Types.DeleteUsagePlanKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a usage plan key and remove the underlying API key from the associated usage plan. + */ + deleteUsagePlanKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing VpcLink of a specified identifier. + */ + deleteVpcLink(params: APIGateway.Types.DeleteVpcLinkRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing VpcLink of a specified identifier. + */ + deleteVpcLink(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Flushes all authorizer cache entries on a stage. + */ + flushStageAuthorizersCache(params: APIGateway.Types.FlushStageAuthorizersCacheRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Flushes all authorizer cache entries on a stage. + */ + flushStageAuthorizersCache(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Flushes a stage's cache. + */ + flushStageCache(params: APIGateway.Types.FlushStageCacheRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Flushes a stage's cache. + */ + flushStageCache(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Generates a ClientCertificate resource. + */ + generateClientCertificate(params: APIGateway.Types.GenerateClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request; + /** + * Generates a ClientCertificate resource. + */ + generateClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request; + /** + * Gets information about the current Account resource. + */ + getAccount(params: APIGateway.Types.GetAccountRequest, callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request; + /** + * Gets information about the current Account resource. + */ + getAccount(callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request; + /** + * Gets information about the current ApiKey resource. + */ + getApiKey(params: APIGateway.Types.GetApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request; + /** + * Gets information about the current ApiKey resource. + */ + getApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request; + /** + * Gets information about the current ApiKeys resource. + */ + getApiKeys(params: APIGateway.Types.GetApiKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKeys) => void): Request; + /** + * Gets information about the current ApiKeys resource. + */ + getApiKeys(callback?: (err: AWSError, data: APIGateway.Types.ApiKeys) => void): Request; + /** + * Describe an existing Authorizer resource. AWS CLI + */ + getAuthorizer(params: APIGateway.Types.GetAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request; + /** + * Describe an existing Authorizer resource. AWS CLI + */ + getAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request; + /** + * Describe an existing Authorizers resource. AWS CLI + */ + getAuthorizers(params: APIGateway.Types.GetAuthorizersRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizers) => void): Request; + /** + * Describe an existing Authorizers resource. AWS CLI + */ + getAuthorizers(callback?: (err: AWSError, data: APIGateway.Types.Authorizers) => void): Request; + /** + * Describe a BasePathMapping resource. + */ + getBasePathMapping(params: APIGateway.Types.GetBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request; + /** + * Describe a BasePathMapping resource. + */ + getBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request; + /** + * Represents a collection of BasePathMapping resources. + */ + getBasePathMappings(params: APIGateway.Types.GetBasePathMappingsRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMappings) => void): Request; + /** + * Represents a collection of BasePathMapping resources. + */ + getBasePathMappings(callback?: (err: AWSError, data: APIGateway.Types.BasePathMappings) => void): Request; + /** + * Gets information about the current ClientCertificate resource. + */ + getClientCertificate(params: APIGateway.Types.GetClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request; + /** + * Gets information about the current ClientCertificate resource. + */ + getClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request; + /** + * Gets a collection of ClientCertificate resources. + */ + getClientCertificates(params: APIGateway.Types.GetClientCertificatesRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificates) => void): Request; + /** + * Gets a collection of ClientCertificate resources. + */ + getClientCertificates(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificates) => void): Request; + /** + * Gets information about a Deployment resource. + */ + getDeployment(params: APIGateway.Types.GetDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request; + /** + * Gets information about a Deployment resource. + */ + getDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request; + /** + * Gets information about a Deployments collection. + */ + getDeployments(params: APIGateway.Types.GetDeploymentsRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployments) => void): Request; + /** + * Gets information about a Deployments collection. + */ + getDeployments(callback?: (err: AWSError, data: APIGateway.Types.Deployments) => void): Request; + /** + * + */ + getDocumentationPart(params: APIGateway.Types.GetDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request; + /** + * + */ + getDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request; + /** + * + */ + getDocumentationParts(params: APIGateway.Types.GetDocumentationPartsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationParts) => void): Request; + /** + * + */ + getDocumentationParts(callback?: (err: AWSError, data: APIGateway.Types.DocumentationParts) => void): Request; + /** + * + */ + getDocumentationVersion(params: APIGateway.Types.GetDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request; + /** + * + */ + getDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request; + /** + * + */ + getDocumentationVersions(params: APIGateway.Types.GetDocumentationVersionsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersions) => void): Request; + /** + * + */ + getDocumentationVersions(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersions) => void): Request; + /** + * Represents a domain name that is contained in a simpler, more intuitive URL that can be called. + */ + getDomainName(params: APIGateway.Types.GetDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request; + /** + * Represents a domain name that is contained in a simpler, more intuitive URL that can be called. + */ + getDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request; + /** + * Represents a collection of DomainName resources. + */ + getDomainNames(params: APIGateway.Types.GetDomainNamesRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainNames) => void): Request; + /** + * Represents a collection of DomainName resources. + */ + getDomainNames(callback?: (err: AWSError, data: APIGateway.Types.DomainNames) => void): Request; + /** + * Exports a deployed version of a RestApi in a specified format. + */ + getExport(params: APIGateway.Types.GetExportRequest, callback?: (err: AWSError, data: APIGateway.Types.ExportResponse) => void): Request; + /** + * Exports a deployed version of a RestApi in a specified format. + */ + getExport(callback?: (err: AWSError, data: APIGateway.Types.ExportResponse) => void): Request; + /** + * Gets a GatewayResponse of a specified response type on the given RestApi. + */ + getGatewayResponse(params: APIGateway.Types.GetGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request; + /** + * Gets a GatewayResponse of a specified response type on the given RestApi. + */ + getGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request; + /** + * Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types. + */ + getGatewayResponses(params: APIGateway.Types.GetGatewayResponsesRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponses) => void): Request; + /** + * Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types. + */ + getGatewayResponses(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponses) => void): Request; + /** + * Get the integration settings. + */ + getIntegration(params: APIGateway.Types.GetIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request; + /** + * Get the integration settings. + */ + getIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request; + /** + * Represents a get integration response. + */ + getIntegrationResponse(params: APIGateway.Types.GetIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request; + /** + * Represents a get integration response. + */ + getIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request; + /** + * Describe an existing Method resource. + */ + getMethod(params: APIGateway.Types.GetMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request; + /** + * Describe an existing Method resource. + */ + getMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request; + /** + * Describes a MethodResponse resource. + */ + getMethodResponse(params: APIGateway.Types.GetMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request; + /** + * Describes a MethodResponse resource. + */ + getMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request; + /** + * Describes an existing model defined for a RestApi resource. + */ + getModel(params: APIGateway.Types.GetModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request; + /** + * Describes an existing model defined for a RestApi resource. + */ + getModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request; + /** + * Generates a sample mapping template that can be used to transform a payload into the structure of a model. + */ + getModelTemplate(params: APIGateway.Types.GetModelTemplateRequest, callback?: (err: AWSError, data: APIGateway.Types.Template) => void): Request; + /** + * Generates a sample mapping template that can be used to transform a payload into the structure of a model. + */ + getModelTemplate(callback?: (err: AWSError, data: APIGateway.Types.Template) => void): Request; + /** + * Describes existing Models defined for a RestApi resource. + */ + getModels(params: APIGateway.Types.GetModelsRequest, callback?: (err: AWSError, data: APIGateway.Types.Models) => void): Request; + /** + * Describes existing Models defined for a RestApi resource. + */ + getModels(callback?: (err: AWSError, data: APIGateway.Types.Models) => void): Request; + /** + * Gets a RequestValidator of a given RestApi. + */ + getRequestValidator(params: APIGateway.Types.GetRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request; + /** + * Gets a RequestValidator of a given RestApi. + */ + getRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request; + /** + * Gets the RequestValidators collection of a given RestApi. + */ + getRequestValidators(params: APIGateway.Types.GetRequestValidatorsRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidators) => void): Request; + /** + * Gets the RequestValidators collection of a given RestApi. + */ + getRequestValidators(callback?: (err: AWSError, data: APIGateway.Types.RequestValidators) => void): Request; + /** + * Lists information about a resource. + */ + getResource(params: APIGateway.Types.GetResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request; + /** + * Lists information about a resource. + */ + getResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request; + /** + * Lists information about a collection of Resource resources. + */ + getResources(params: APIGateway.Types.GetResourcesRequest, callback?: (err: AWSError, data: APIGateway.Types.Resources) => void): Request; + /** + * Lists information about a collection of Resource resources. + */ + getResources(callback?: (err: AWSError, data: APIGateway.Types.Resources) => void): Request; + /** + * Lists the RestApi resource in the collection. + */ + getRestApi(params: APIGateway.Types.GetRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Lists the RestApi resource in the collection. + */ + getRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Lists the RestApis resources for your collection. + */ + getRestApis(params: APIGateway.Types.GetRestApisRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApis) => void): Request; + /** + * Lists the RestApis resources for your collection. + */ + getRestApis(callback?: (err: AWSError, data: APIGateway.Types.RestApis) => void): Request; + /** + * Generates a client SDK for a RestApi and Stage. + */ + getSdk(params: APIGateway.Types.GetSdkRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkResponse) => void): Request; + /** + * Generates a client SDK for a RestApi and Stage. + */ + getSdk(callback?: (err: AWSError, data: APIGateway.Types.SdkResponse) => void): Request; + /** + * + */ + getSdkType(params: APIGateway.Types.GetSdkTypeRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkType) => void): Request; + /** + * + */ + getSdkType(callback?: (err: AWSError, data: APIGateway.Types.SdkType) => void): Request; + /** + * + */ + getSdkTypes(params: APIGateway.Types.GetSdkTypesRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkTypes) => void): Request; + /** + * + */ + getSdkTypes(callback?: (err: AWSError, data: APIGateway.Types.SdkTypes) => void): Request; + /** + * Gets information about a Stage resource. + */ + getStage(params: APIGateway.Types.GetStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request; + /** + * Gets information about a Stage resource. + */ + getStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request; + /** + * Gets information about one or more Stage resources. + */ + getStages(params: APIGateway.Types.GetStagesRequest, callback?: (err: AWSError, data: APIGateway.Types.Stages) => void): Request; + /** + * Gets information about one or more Stage resources. + */ + getStages(callback?: (err: AWSError, data: APIGateway.Types.Stages) => void): Request; + /** + * Gets the Tags collection for a given resource. + */ + getTags(params: APIGateway.Types.GetTagsRequest, callback?: (err: AWSError, data: APIGateway.Types.Tags) => void): Request; + /** + * Gets the Tags collection for a given resource. + */ + getTags(callback?: (err: AWSError, data: APIGateway.Types.Tags) => void): Request; + /** + * Gets the usage data of a usage plan in a specified time interval. + */ + getUsage(params: APIGateway.Types.GetUsageRequest, callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request; + /** + * Gets the usage data of a usage plan in a specified time interval. + */ + getUsage(callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request; + /** + * Gets a usage plan of a given plan identifier. + */ + getUsagePlan(params: APIGateway.Types.GetUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request; + /** + * Gets a usage plan of a given plan identifier. + */ + getUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request; + /** + * Gets a usage plan key of a given key identifier. + */ + getUsagePlanKey(params: APIGateway.Types.GetUsagePlanKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request; + /** + * Gets a usage plan key of a given key identifier. + */ + getUsagePlanKey(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request; + /** + * Gets all the usage plan keys representing the API keys added to a specified usage plan. + */ + getUsagePlanKeys(params: APIGateway.Types.GetUsagePlanKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKeys) => void): Request; + /** + * Gets all the usage plan keys representing the API keys added to a specified usage plan. + */ + getUsagePlanKeys(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKeys) => void): Request; + /** + * Gets all the usage plans of the caller's account. + */ + getUsagePlans(params: APIGateway.Types.GetUsagePlansRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlans) => void): Request; + /** + * Gets all the usage plans of the caller's account. + */ + getUsagePlans(callback?: (err: AWSError, data: APIGateway.Types.UsagePlans) => void): Request; + /** + * Gets a specified VPC link under the caller's account in a region. + */ + getVpcLink(params: APIGateway.Types.GetVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request; + /** + * Gets a specified VPC link under the caller's account in a region. + */ + getVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request; + /** + * Gets the VpcLinks collection under the caller's account in a selected region. + */ + getVpcLinks(params: APIGateway.Types.GetVpcLinksRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLinks) => void): Request; + /** + * Gets the VpcLinks collection under the caller's account in a selected region. + */ + getVpcLinks(callback?: (err: AWSError, data: APIGateway.Types.VpcLinks) => void): Request; + /** + * Import API keys from an external source, such as a CSV-formatted file. + */ + importApiKeys(params: APIGateway.Types.ImportApiKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKeyIds) => void): Request; + /** + * Import API keys from an external source, such as a CSV-formatted file. + */ + importApiKeys(callback?: (err: AWSError, data: APIGateway.Types.ApiKeyIds) => void): Request; + /** + * + */ + importDocumentationParts(params: APIGateway.Types.ImportDocumentationPartsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPartIds) => void): Request; + /** + * + */ + importDocumentationParts(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPartIds) => void): Request; + /** + * A feature of the API Gateway control service for creating a new API from an external API definition file. + */ + importRestApi(params: APIGateway.Types.ImportRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * A feature of the API Gateway control service for creating a new API from an external API definition file. + */ + importRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. + */ + putGatewayResponse(params: APIGateway.Types.PutGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request; + /** + * Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. + */ + putGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request; + /** + * Sets up a method's integration. + */ + putIntegration(params: APIGateway.Types.PutIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request; + /** + * Sets up a method's integration. + */ + putIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request; + /** + * Represents a put integration. + */ + putIntegrationResponse(params: APIGateway.Types.PutIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request; + /** + * Represents a put integration. + */ + putIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request; + /** + * Add a method to an existing Resource resource. + */ + putMethod(params: APIGateway.Types.PutMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request; + /** + * Add a method to an existing Resource resource. + */ + putMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request; + /** + * Adds a MethodResponse to an existing Method resource. + */ + putMethodResponse(params: APIGateway.Types.PutMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request; + /** + * Adds a MethodResponse to an existing Method resource. + */ + putMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request; + /** + * 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. + */ + putRestApi(params: APIGateway.Types.PutRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * 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. + */ + putRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Adds or updates a tag on a given resource. + */ + tagResource(params: APIGateway.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates a tag on a given resource. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Enable custom authorizers + */ + testInvokeAuthorizer(params: APIGateway.Types.TestInvokeAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.TestInvokeAuthorizerResponse) => void): Request; + /** + * Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Enable custom authorizers + */ + testInvokeAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.TestInvokeAuthorizerResponse) => void): Request; + /** + * Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body. + */ + testInvokeMethod(params: APIGateway.Types.TestInvokeMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.TestInvokeMethodResponse) => void): Request; + /** + * Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body. + */ + testInvokeMethod(callback?: (err: AWSError, data: APIGateway.Types.TestInvokeMethodResponse) => void): Request; + /** + * Removes a tag from a given resource. + */ + untagResource(params: APIGateway.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a tag from a given resource. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes information about the current Account resource. + */ + updateAccount(params: APIGateway.Types.UpdateAccountRequest, callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request; + /** + * Changes information about the current Account resource. + */ + updateAccount(callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request; + /** + * Changes information about an ApiKey resource. + */ + updateApiKey(params: APIGateway.Types.UpdateApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request; + /** + * Changes information about an ApiKey resource. + */ + updateApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request; + /** + * Updates an existing Authorizer resource. AWS CLI + */ + updateAuthorizer(params: APIGateway.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request; + /** + * Updates an existing Authorizer resource. AWS CLI + */ + updateAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request; + /** + * Changes information about the BasePathMapping resource. + */ + updateBasePathMapping(params: APIGateway.Types.UpdateBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request; + /** + * Changes information about the BasePathMapping resource. + */ + updateBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request; + /** + * Changes information about an ClientCertificate resource. + */ + updateClientCertificate(params: APIGateway.Types.UpdateClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request; + /** + * Changes information about an ClientCertificate resource. + */ + updateClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request; + /** + * Changes information about a Deployment resource. + */ + updateDeployment(params: APIGateway.Types.UpdateDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request; + /** + * Changes information about a Deployment resource. + */ + updateDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request; + /** + * + */ + updateDocumentationPart(params: APIGateway.Types.UpdateDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request; + /** + * + */ + updateDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request; + /** + * + */ + updateDocumentationVersion(params: APIGateway.Types.UpdateDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request; + /** + * + */ + updateDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request; + /** + * Changes information about the DomainName resource. + */ + updateDomainName(params: APIGateway.Types.UpdateDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request; + /** + * Changes information about the DomainName resource. + */ + updateDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request; + /** + * Updates a GatewayResponse of a specified response type on the given RestApi. + */ + updateGatewayResponse(params: APIGateway.Types.UpdateGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request; + /** + * Updates a GatewayResponse of a specified response type on the given RestApi. + */ + updateGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request; + /** + * Represents an update integration. + */ + updateIntegration(params: APIGateway.Types.UpdateIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request; + /** + * Represents an update integration. + */ + updateIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request; + /** + * Represents an update integration response. + */ + updateIntegrationResponse(params: APIGateway.Types.UpdateIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request; + /** + * Represents an update integration response. + */ + updateIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request; + /** + * Updates an existing Method resource. + */ + updateMethod(params: APIGateway.Types.UpdateMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request; + /** + * Updates an existing Method resource. + */ + updateMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request; + /** + * Updates an existing MethodResponse resource. + */ + updateMethodResponse(params: APIGateway.Types.UpdateMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request; + /** + * Updates an existing MethodResponse resource. + */ + updateMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request; + /** + * Changes information about a model. + */ + updateModel(params: APIGateway.Types.UpdateModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request; + /** + * Changes information about a model. + */ + updateModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request; + /** + * Updates a RequestValidator of a given RestApi. + */ + updateRequestValidator(params: APIGateway.Types.UpdateRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request; + /** + * Updates a RequestValidator of a given RestApi. + */ + updateRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request; + /** + * Changes information about a Resource resource. + */ + updateResource(params: APIGateway.Types.UpdateResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request; + /** + * Changes information about a Resource resource. + */ + updateResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request; + /** + * Changes information about the specified API. + */ + updateRestApi(params: APIGateway.Types.UpdateRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Changes information about the specified API. + */ + updateRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request; + /** + * Changes information about a Stage resource. + */ + updateStage(params: APIGateway.Types.UpdateStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request; + /** + * Changes information about a Stage resource. + */ + updateStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request; + /** + * Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. + */ + updateUsage(params: APIGateway.Types.UpdateUsageRequest, callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request; + /** + * Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. + */ + updateUsage(callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request; + /** + * Updates a usage plan of a given plan Id. + */ + updateUsagePlan(params: APIGateway.Types.UpdateUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request; + /** + * Updates a usage plan of a given plan Id. + */ + updateUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request; + /** + * Updates an existing VpcLink of a specified identifier. + */ + updateVpcLink(params: APIGateway.Types.UpdateVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request; + /** + * Updates an existing VpcLink of a specified identifier. + */ + updateVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request; +} +declare namespace APIGateway { + export interface AccessLogSettings { + /** + * A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. + */ + format?: String; + /** + * The ARN of the CloudWatch Logs log group to receive access logs. + */ + destinationArn?: String; + } + export interface Account { + /** + * The ARN of an Amazon CloudWatch role for the current Account. + */ + cloudwatchRoleArn?: String; + /** + * Specifies the API request limits configured for the current Account. + */ + throttleSettings?: ThrottleSettings; + /** + * A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans". + */ + features?: ListOfString; + /** + * The version of the API keys used for the account. + */ + apiKeyVersion?: String; + } + export interface ApiKey { + /** + * The identifier of the API Key. + */ + id?: String; + /** + * The value of the API Key. + */ + value?: String; + /** + * The name of the API Key. + */ + name?: String; + /** + * An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace. + */ + customerId?: String; + /** + * The description of the API Key. + */ + description?: String; + /** + * Specifies whether the API Key can be used by callers. + */ + enabled?: Boolean; + /** + * The timestamp when the API Key was created. + */ + createdDate?: Timestamp; + /** + * The timestamp when the API Key was last updated. + */ + lastUpdatedDate?: Timestamp; + /** + * A list of Stage resources that are associated with the ApiKey resource. + */ + stageKeys?: ListOfString; + } + export interface ApiKeyIds { + /** + * A list of all the ApiKey identifiers. + */ + ids?: ListOfString; + /** + * A list of warning messages. + */ + warnings?: ListOfString; + } + export type ApiKeySourceType = "HEADER"|"AUTHORIZER"|string; + export interface ApiKeys { + /** + * A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true. + */ + warnings?: ListOfString; + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfApiKey; + } + export type ApiKeysFormat = "csv"|string; + export interface ApiStage { + /** + * API Id of the associated API stage in a usage plan. + */ + apiId?: String; + /** + * API stage name of the associated API stage in a usage plan. + */ + stage?: String; + /** + * Map containing method level throttling information for API stage in a usage plan. + */ + throttle?: MapOfApiStageThrottleSettings; + } + export interface Authorizer { + /** + * The identifier for the authorizer resource. + */ + id?: String; + /** + * [Required] The name of the authorizer. + */ + name?: String; + /** + * The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. + */ + type?: AuthorizerType; + /** + * A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined. + */ + providerARNs?: ListOfARNs; + /** + * Optional customer-defined field, used in OpenAPI imports and exports without functional impact. + */ + authType?: String; + /** + * Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, 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. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. + */ + authorizerUri?: String; + /** + * 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. + */ + authorizerCredentials?: String; + /** + * The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS 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 Auth, the header mapping expression is method.request.header.Auth.For the REQUEST 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 Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST 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. + */ + identitySource?: String; + /** + * A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud 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 REQUEST authorizer. + */ + identityValidationExpression?: String; + /** + * 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. + */ + authorizerResultTtlInSeconds?: NullableInteger; + } + export type AuthorizerType = "TOKEN"|"REQUEST"|"COGNITO_USER_POOLS"|string; + export interface Authorizers { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfAuthorizer; + } + export interface BasePathMapping { + /** + * The base path name that callers of the API must provide as part of the URL after the domain name. + */ + basePath?: String; + /** + * The string identifier of the associated RestApi. + */ + restApiId?: String; + /** + * The name of the associated stage. + */ + stage?: String; + } + export interface BasePathMappings { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfBasePathMapping; + } + export type _Blob = Buffer|Uint8Array|Blob|string; + export type Boolean = boolean; + export type CacheClusterSize = "0.5"|"1.6"|"6.1"|"13.5"|"28.4"|"58.2"|"118"|"237"|string; + export type CacheClusterStatus = "CREATE_IN_PROGRESS"|"AVAILABLE"|"DELETE_IN_PROGRESS"|"NOT_AVAILABLE"|"FLUSH_IN_PROGRESS"|string; + export interface CanarySettings { + /** + * The percent (0-100) of traffic diverted to a canary deployment. + */ + percentTraffic?: Double; + /** + * The ID of the canary deployment. + */ + deploymentId?: String; + /** + * 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. + */ + stageVariableOverrides?: MapOfStringToString; + /** + * A Boolean flag to indicate whether the canary deployment uses the stage cache or not. + */ + useStageCache?: Boolean; + } + export interface ClientCertificate { + /** + * The identifier of the client certificate. + */ + clientCertificateId?: String; + /** + * The description of the client certificate. + */ + description?: String; + /** + * The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint . + */ + pemEncodedCertificate?: String; + /** + * The timestamp when the client certificate was created. + */ + createdDate?: Timestamp; + /** + * The timestamp when the client certificate will expire. + */ + expirationDate?: Timestamp; + } + export interface ClientCertificates { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfClientCertificate; + } + export type ConnectionType = "INTERNET"|"VPC_LINK"|string; + export type ContentHandlingStrategy = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"|string; + export interface CreateApiKeyRequest { + /** + * The name of the ApiKey. + */ + name?: String; + /** + * The description of the ApiKey. + */ + description?: String; + /** + * Specifies whether the ApiKey can be used by callers. + */ + enabled?: Boolean; + /** + * Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. + */ + generateDistinctId?: Boolean; + /** + * Specifies a value of the API key. + */ + value?: String; + /** + * DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. + */ + stageKeys?: ListOfStageKeys; + /** + * An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace. + */ + customerId?: String; + } + export interface CreateAuthorizerRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the authorizer. + */ + name: String; + /** + * [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. + */ + type: AuthorizerType; + /** + * A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined. + */ + providerARNs?: ListOfARNs; + /** + * Optional customer-defined field, used in OpenAPI imports and exports without functional impact. + */ + authType?: String; + /** + * Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, 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. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. + */ + authorizerUri?: String; + /** + * 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. + */ + authorizerCredentials?: String; + /** + * The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS 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 Auth, the header mapping expression is method.request.header.Auth.For the REQUEST 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 Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST 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. + */ + identitySource?: String; + /** + * A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud 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 REQUEST authorizer. + */ + identityValidationExpression?: String; + /** + * 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. + */ + authorizerResultTtlInSeconds?: NullableInteger; + } + export interface CreateBasePathMappingRequest { + /** + * [Required] The domain name of the BasePathMapping resource to create. + */ + domainName: String; + /** + * 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. + */ + basePath?: String; + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * 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. + */ + stage?: String; + } + export interface CreateDeploymentRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The name of the Stage resource for the Deployment resource to create. + */ + stageName?: String; + /** + * The description of the Stage resource for the Deployment resource to create. + */ + stageDescription?: String; + /** + * The description for the Deployment resource to create. + */ + description?: String; + /** + * Enables a cache cluster for the Stage resource specified in the input. + */ + cacheClusterEnabled?: NullableBoolean; + /** + * Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled. + */ + cacheClusterSize?: CacheClusterSize; + /** + * A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. + */ + variables?: MapOfStringToString; + /** + * The input configuration for the canary deployment when the deployment is a canary release deployment. + */ + canarySettings?: DeploymentCanarySettings; + /** + * Specifies whether active tracing with X-ray is enabled for the Stage. + */ + tracingEnabled?: NullableBoolean; + } + export interface CreateDocumentationPartRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The location of the targeted API entity of the to-be-created documentation part. + */ + location: DocumentationPartLocation; + /** + * [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published. + */ + properties: String; + } + export interface CreateDocumentationVersionRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The version identifier of the new snapshot. + */ + documentationVersion: String; + /** + * The stage name to be associated with the new documentation snapshot. + */ + stageName?: String; + /** + * A description about the new documentation snapshot. + */ + description?: String; + } + export interface CreateDomainNameRequest { + /** + * [Required] The name of the DomainName resource. + */ + domainName: String; + /** + * The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name. + */ + certificateName?: String; + /** + * [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority. + */ + certificateBody?: String; + /** + * [Deprecated] Your edge-optimized endpoint's domain name certificate's private key. + */ + certificatePrivateKey?: String; + /** + * [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path. + */ + certificateChain?: String; + /** + * 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. + */ + certificateArn?: String; + /** + * The user-friendly name of the certificate that will be used by regional endpoint for this domain name. + */ + regionalCertificateName?: String; + /** + * 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. + */ + regionalCertificateArn?: String; + /** + * The endpoint configuration of this DomainName showing the endpoint types of the domain name. + */ + endpointConfiguration?: EndpointConfiguration; + } + export interface CreateModelRequest { + /** + * [Required] The RestApi identifier under which the Model will be created. + */ + restApiId: String; + /** + * [Required] The name of the model. Must be alphanumeric. + */ + name: String; + /** + * The description of the model. + */ + description?: String; + /** + * The schema for the model. For application/json models, this should be JSON schema draft 4 model. + */ + schema?: String; + /** + * [Required] The content-type for the model. + */ + contentType: String; + } + export interface CreateRequestValidatorRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The name of the to-be-created RequestValidator. + */ + name?: String; + /** + * A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false). + */ + validateRequestBody?: Boolean; + /** + * A Boolean flag to indicate whether to validate request parameters, true, or not false. + */ + validateRequestParameters?: Boolean; + } + export interface CreateResourceRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The parent resource's identifier. + */ + parentId: String; + /** + * The last path segment for this resource. + */ + pathPart: String; + } + export interface CreateRestApiRequest { + /** + * [Required] The name of the RestApi. + */ + name: String; + /** + * The description of the RestApi. + */ + description?: String; + /** + * A version identifier for the API. + */ + version?: String; + /** + * The ID of the RestApi that you want to clone from. + */ + cloneFrom?: String; + /** + * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. + */ + binaryMediaTypes?: ListOfString; + /** + * 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. + */ + minimumCompressionSize?: NullableInteger; + /** + * The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer. + */ + apiKeySource?: ApiKeySourceType; + /** + * The endpoint configuration of this RestApi showing the endpoint types of the API. + */ + endpointConfiguration?: EndpointConfiguration; + /** + * A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration. + */ + policy?: String; + } + export interface CreateStageRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name for the Stage resource. + */ + stageName: String; + /** + * [Required] The identifier of the Deployment resource for the Stage resource. + */ + deploymentId: String; + /** + * The description of the Stage resource. + */ + description?: String; + /** + * Whether cache clustering is enabled for the stage. + */ + cacheClusterEnabled?: Boolean; + /** + * The stage's cache cluster size. + */ + cacheClusterSize?: CacheClusterSize; + /** + * A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. + */ + variables?: MapOfStringToString; + /** + * The version of the associated API documentation. + */ + documentationVersion?: String; + /** + * The canary deployment settings of this stage. + */ + canarySettings?: CanarySettings; + /** + * Specifies whether active tracing with X-ray is enabled for the Stage. + */ + tracingEnabled?: Boolean; + /** + * 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 aws:. The tag value can be up to 256 characters. + */ + tags?: MapOfStringToString; + } + export interface CreateUsagePlanKeyRequest { + /** + * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer. + */ + usagePlanId: String; + /** + * [Required] The identifier of a UsagePlanKey resource for a plan customer. + */ + keyId: String; + /** + * [Required] The type of a UsagePlanKey resource for a plan customer. + */ + keyType: String; + } + export interface CreateUsagePlanRequest { + /** + * [Required] The name of the usage plan. + */ + name: String; + /** + * The description of the usage plan. + */ + description?: String; + /** + * The associated API stages of the usage plan. + */ + apiStages?: ListOfApiStage; + /** + * The throttling limits of the usage plan. + */ + throttle?: ThrottleSettings; + /** + * The quota of the usage plan. + */ + quota?: QuotaSettings; + } + export interface CreateVpcLinkRequest { + /** + * [Required] The name used to label and identify the VPC link. + */ + name: String; + /** + * The description of the VPC link. + */ + description?: String; + /** + * [Required] 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. + */ + targetArns: ListOfString; + } + export interface DeleteApiKeyRequest { + /** + * [Required] The identifier of the ApiKey resource to be deleted. + */ + apiKey: String; + } + export interface DeleteAuthorizerRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the Authorizer resource. + */ + authorizerId: String; + } + export interface DeleteBasePathMappingRequest { + /** + * [Required] The domain name of the BasePathMapping resource to delete. + */ + domainName: String; + /** + * [Required] The base path name of the BasePathMapping resource to delete. + */ + basePath: String; + } + export interface DeleteClientCertificateRequest { + /** + * [Required] The identifier of the ClientCertificate resource to be deleted. + */ + clientCertificateId: String; + } + export interface DeleteDeploymentRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the Deployment resource to delete. + */ + deploymentId: String; + } + export interface DeleteDocumentationPartRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the to-be-deleted documentation part. + */ + documentationPartId: String; + } + export interface DeleteDocumentationVersionRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The version identifier of a to-be-deleted documentation snapshot. + */ + documentationVersion: String; + } + export interface DeleteDomainNameRequest { + /** + * [Required] The name of the DomainName resource to be deleted. + */ + domainName: String; + } + export interface DeleteGatewayResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE + */ + responseType: GatewayResponseType; + } + export interface DeleteIntegrationRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a delete integration request's resource identifier. + */ + resourceId: String; + /** + * [Required] Specifies a delete integration request's HTTP method. + */ + httpMethod: String; + } + export interface DeleteIntegrationResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a delete integration response request's resource identifier. + */ + resourceId: String; + /** + * [Required] Specifies a delete integration response request's HTTP method. + */ + httpMethod: String; + /** + * [Required] Specifies a delete integration response request's status code. + */ + statusCode: StatusCode; + } + export interface DeleteMethodRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the Method resource. + */ + resourceId: String; + /** + * [Required] The HTTP verb of the Method resource. + */ + httpMethod: String; + } + export interface DeleteMethodResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the MethodResponse resource. + */ + resourceId: String; + /** + * [Required] The HTTP verb of the Method resource. + */ + httpMethod: String; + /** + * [Required] The status code identifier for the MethodResponse resource. + */ + statusCode: StatusCode; + } + export interface DeleteModelRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the model to delete. + */ + modelName: String; + } + export interface DeleteRequestValidatorRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the RequestValidator to be deleted. + */ + requestValidatorId: String; + } + export interface DeleteResourceRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the Resource resource. + */ + resourceId: String; + } + export interface DeleteRestApiRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + } + export interface DeleteStageRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the Stage resource to delete. + */ + stageName: String; + } + export interface DeleteUsagePlanKeyRequest { + /** + * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer. + */ + usagePlanId: String; + /** + * [Required] The Id of the UsagePlanKey resource to be deleted. + */ + keyId: String; + } + export interface DeleteUsagePlanRequest { + /** + * [Required] The Id of the to-be-deleted usage plan. + */ + usagePlanId: String; + } + export interface DeleteVpcLinkRequest { + /** + * [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink. + */ + vpcLinkId: String; + } + export interface Deployment { + /** + * The identifier for the deployment resource. + */ + id?: String; + /** + * The description for the deployment resource. + */ + description?: String; + /** + * The date and time that the deployment resource was created. + */ + createdDate?: Timestamp; + /** + * A summary of the RestApi at the date and time that the deployment resource was created. + */ + apiSummary?: PathToMapOfMethodSnapshot; + } + export interface DeploymentCanarySettings { + /** + * The percentage (0.0-100.0) of traffic routed to the canary deployment. + */ + percentTraffic?: Double; + /** + * 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. + */ + stageVariableOverrides?: MapOfStringToString; + /** + * A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. + */ + useStageCache?: Boolean; + } + export interface Deployments { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfDeployment; + } + export interface DocumentationPart { + /** + * The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created. + */ + id?: String; + /** + * The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden. + */ + location?: DocumentationPartLocation; + /** + * A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation. + */ + properties?: String; + } + export interface DocumentationPartIds { + /** + * A list of the returned documentation part identifiers. + */ + ids?: ListOfString; + /** + * A list of warning messages reported during import of documentation parts. + */ + warnings?: ListOfString; + } + export interface DocumentationPartLocation { + /** + * [Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type. + */ + type: DocumentationPartType; + /** + * The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix. + */ + path?: String; + /** + * The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly. + */ + method?: String; + /** + * The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly. + */ + statusCode?: DocumentationPartLocationStatusCode; + /** + * The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type. + */ + name?: String; + } + export type DocumentationPartLocationStatusCode = string; + export type DocumentationPartType = "API"|"AUTHORIZER"|"MODEL"|"RESOURCE"|"METHOD"|"PATH_PARAMETER"|"QUERY_PARAMETER"|"REQUEST_HEADER"|"REQUEST_BODY"|"RESPONSE"|"RESPONSE_HEADER"|"RESPONSE_BODY"|string; + export interface DocumentationParts { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfDocumentationPart; + } + export interface DocumentationVersion { + /** + * The version identifier of the API documentation snapshot. + */ + version?: String; + /** + * The date when the API documentation snapshot is created. + */ + createdDate?: Timestamp; + /** + * The description of the API documentation snapshot. + */ + description?: String; + } + export interface DocumentationVersions { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfDocumentationVersion; + } + export interface DomainName { + /** + * The custom domain name as an API host name, for example, my-api.example.com. + */ + domainName?: String; + /** + * The name of the certificate that will be used by edge-optimized endpoint for this domain name. + */ + certificateName?: String; + /** + * 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. + */ + certificateArn?: String; + /** + * The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded. + */ + certificateUploadDate?: Timestamp; + /** + * 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. + */ + regionalDomainName?: String; + /** + * The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway. + */ + regionalHostedZoneId?: String; + /** + * The name of the certificate that will be used for validating the regional domain name. + */ + regionalCertificateName?: String; + /** + * The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source. + */ + regionalCertificateArn?: String; + /** + * The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation. + */ + distributionDomainName?: String; + /** + * The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway. + */ + distributionHostedZoneId?: String; + /** + * The endpoint configuration of this DomainName showing the endpoint types of the domain name. + */ + endpointConfiguration?: EndpointConfiguration; + } + export interface DomainNames { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfDomainName; + } + export type Double = number; + export interface EndpointConfiguration { + /** + * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. + */ + types?: ListOfEndpointType; + } + export type EndpointType = "REGIONAL"|"EDGE"|"PRIVATE"|string; + export interface ExportResponse { + /** + * The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request. + */ + contentType?: String; + /** + * The content-disposition header value in the HTTP response. + */ + contentDisposition?: String; + /** + * The binary blob response to GetExport, which contains the export. + */ + body?: _Blob; + } + export interface FlushStageAuthorizersCacheRequest { + /** + * The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The name of the stage to flush. + */ + stageName: String; + } + export interface FlushStageCacheRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the stage to flush its cache. + */ + stageName: String; + } + export interface GatewayResponse { + /** + * The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE + */ + responseType?: GatewayResponseType; + /** + * The HTTP status code for this GatewayResponse. + */ + statusCode?: StatusCode; + /** + * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. + */ + responseParameters?: MapOfStringToString; + /** + * Response templates of the GatewayResponse as a string-to-string map of key-value pairs. + */ + responseTemplates?: MapOfStringToString; + /** + * A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer. + */ + defaultResponse?: Boolean; + } + export type GatewayResponseType = "DEFAULT_4XX"|"DEFAULT_5XX"|"RESOURCE_NOT_FOUND"|"UNAUTHORIZED"|"INVALID_API_KEY"|"ACCESS_DENIED"|"AUTHORIZER_FAILURE"|"AUTHORIZER_CONFIGURATION_ERROR"|"INVALID_SIGNATURE"|"EXPIRED_TOKEN"|"MISSING_AUTHENTICATION_TOKEN"|"INTEGRATION_FAILURE"|"INTEGRATION_TIMEOUT"|"API_CONFIGURATION_ERROR"|"UNSUPPORTED_MEDIA_TYPE"|"BAD_REQUEST_PARAMETERS"|"BAD_REQUEST_BODY"|"REQUEST_TOO_LARGE"|"THROTTLED"|"QUOTA_EXCEEDED"|string; + export interface GatewayResponses { + position?: String; + /** + * Returns the entire collection, because of no pagination support. + */ + items?: ListOfGatewayResponse; + } + export interface GenerateClientCertificateRequest { + /** + * The description of the ClientCertificate. + */ + description?: String; + } + export interface GetAccountRequest { + } + export interface GetApiKeyRequest { + /** + * [Required] The identifier of the ApiKey resource. + */ + apiKey: String; + /** + * A boolean flag to specify whether (true) or not (false) the result contains the key value. + */ + includeValue?: NullableBoolean; + } + export interface GetApiKeysRequest { + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + /** + * The name of queried API keys. + */ + nameQuery?: String; + /** + * The identifier of a customer in AWS Marketplace or an external system, such as a developer portal. + */ + customerId?: String; + /** + * A boolean flag to specify whether (true) or not (false) the result contains key values. + */ + includeValues?: NullableBoolean; + } + export interface GetAuthorizerRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the Authorizer resource. + */ + authorizerId: String; + } + export interface GetAuthorizersRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetBasePathMappingRequest { + /** + * [Required] The domain name of the BasePathMapping resource to be described. + */ + domainName: String; + /** + * [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. + */ + basePath: String; + } + export interface GetBasePathMappingsRequest { + /** + * [Required] The domain name of a BasePathMapping resource. + */ + domainName: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetClientCertificateRequest { + /** + * [Required] The identifier of the ClientCertificate resource to be described. + */ + clientCertificateId: String; + } + export interface GetClientCertificatesRequest { + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetDeploymentRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the Deployment resource to get information about. + */ + deploymentId: String; + /** + * A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary. + */ + embed?: ListOfString; + } + export interface GetDeploymentsRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetDocumentationPartRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The string identifier of the associated RestApi. + */ + documentationPartId: String; + } + export interface GetDocumentationPartsRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The type of API entities of the to-be-retrieved documentation parts. + */ + type?: DocumentationPartType; + /** + * The name of API entities of the to-be-retrieved documentation parts. + */ + nameQuery?: String; + /** + * The path of API entities of the to-be-retrieved documentation parts. + */ + path?: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + /** + * The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content. + */ + locationStatus?: LocationStatusType; + } + export interface GetDocumentationVersionRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The version identifier of the to-be-retrieved documentation snapshot. + */ + documentationVersion: String; + } + export interface GetDocumentationVersionsRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetDomainNameRequest { + /** + * [Required] The name of the DomainName resource. + */ + domainName: String; + } + export interface GetDomainNamesRequest { + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetExportRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the Stage that will be exported. + */ + stageName: String; + /** + * [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0. + */ + exportType: String; + /** + * A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool + */ + parameters?: MapOfStringToString; + /** + * The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests. + */ + accepts?: String; + } + export interface GetGatewayResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE + */ + responseType: GatewayResponseType; + } + export interface GetGatewayResponsesRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here. + */ + limit?: NullableInteger; + } + export interface GetIntegrationRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a get integration request's resource identifier + */ + resourceId: String; + /** + * [Required] Specifies a get integration request's HTTP method. + */ + httpMethod: String; + } + export interface GetIntegrationResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a get integration response request's resource identifier. + */ + resourceId: String; + /** + * [Required] Specifies a get integration response request's HTTP method. + */ + httpMethod: String; + /** + * [Required] Specifies a get integration response request's status code. + */ + statusCode: StatusCode; + } + export interface GetMethodRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the Method resource. + */ + resourceId: String; + /** + * [Required] Specifies the method request's HTTP method type. + */ + httpMethod: String; + } + export interface GetMethodResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the MethodResponse resource. + */ + resourceId: String; + /** + * [Required] The HTTP verb of the Method resource. + */ + httpMethod: String; + /** + * [Required] The status code for the MethodResponse resource. + */ + statusCode: StatusCode; + } + export interface GetModelRequest { + /** + * [Required] The RestApi identifier under which the Model exists. + */ + restApiId: String; + /** + * [Required] The name of the model as an identifier. + */ + modelName: String; + /** + * A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false. + */ + flatten?: Boolean; + } + export interface GetModelTemplateRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the model for which to generate a template. + */ + modelName: String; + } + export interface GetModelsRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetRequestValidatorRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the RequestValidator to be retrieved. + */ + requestValidatorId: String; + } + export interface GetRequestValidatorsRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetResourceRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier for the Resource resource. + */ + resourceId: String; + /** + * A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods. + */ + embed?: ListOfString; + } + export interface GetResourcesRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + /** + * A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods. + */ + embed?: ListOfString; + } + export interface GetRestApiRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + } + export interface GetRestApisRequest { + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetSdkRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the Stage that the SDK will use. + */ + stageName: String; + /** + * [Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported. + */ + sdkType: String; + /** + * A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required. + */ + parameters?: MapOfStringToString; + } + export interface GetSdkTypeRequest { + /** + * [Required] The identifier of the queried SdkType instance. + */ + id: String; + } + export interface GetSdkTypesRequest { + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetStageRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the Stage resource to get information about. + */ + stageName: String; + } + export interface GetStagesRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The stages' deployment identifiers. + */ + deploymentId?: String; + } + export interface GetTagsRequest { + /** + * [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, Stage is the only taggable resource. + */ + resourceArn: String; + /** + * (Not currently supported) The current pagination position in the paged result set. + */ + position?: String; + /** + * (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetUsagePlanKeyRequest { + /** + * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer. + */ + usagePlanId: String; + /** + * [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer. + */ + keyId: String; + } + export interface GetUsagePlanKeysRequest { + /** + * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer. + */ + usagePlanId: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + /** + * A query parameter specifying the name of the to-be-returned usage plan keys. + */ + nameQuery?: String; + } + export interface GetUsagePlanRequest { + /** + * [Required] The identifier of the UsagePlan resource to be retrieved. + */ + usagePlanId: String; + } + export interface GetUsagePlansRequest { + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The identifier of the API key associated with the usage plans. + */ + keyId?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetUsageRequest { + /** + * [Required] The Id of the usage plan associated with the usage data. + */ + usagePlanId: String; + /** + * The Id of the API key associated with the resultant usage data. + */ + keyId?: String; + /** + * [Required] The starting date (e.g., 2016-01-01) of the usage data. + */ + startDate: String; + /** + * [Required] The ending date (e.g., 2016-12-31) of the usage data. + */ + endDate: String; + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface GetVpcLinkRequest { + /** + * [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink. + */ + vpcLinkId: String; + } + export interface GetVpcLinksRequest { + /** + * The current pagination position in the paged result set. + */ + position?: String; + /** + * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. + */ + limit?: NullableInteger; + } + export interface ImportApiKeysRequest { + /** + * The payload of the POST request to import API keys. For the payload format, see API Key File Format. + */ + body: _Blob; + /** + * A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported. + */ + format: ApiKeysFormat; + /** + * A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered. + */ + failOnWarnings?: Boolean; + } + export interface ImportDocumentationPartsRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE. + */ + mode?: PutMode; + /** + * A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false. + */ + failOnWarnings?: Boolean; + /** + * [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object. + */ + body: _Blob; + } + export interface ImportRestApiRequest { + /** + * A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false. + */ + failOnWarnings?: Boolean; + /** + * A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values. To exclude DocumentationParts from the import, set parameters as ignore=documentation. To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE. To handle imported basePath, set parameters as basePath=ignore, basePath=prepend or basePath=split. For example, the AWS CLI command to exclude documentation from the imported API is: aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' The AWS CLI command to set the regional endpoint on the imported API is: aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json' + */ + parameters?: MapOfStringToString; + /** + * [Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB. + */ + body: _Blob; + } + export type Integer = number; + export interface Integration { + /** + * Specifies an API method integration type. The valid value is one of the following: AWS: 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. AWS_PROXY: 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. HTTP: 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. HTTP_PROXY: 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. MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), 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 connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC. + */ + type?: IntegrationType; + /** + * Specifies the integration's HTTP method type. + */ + httpMethod?: String; + /** + * Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api 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 GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} + */ + uri?: String; + /** + * The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. + */ + connectionType?: ConnectionType; + /** + * The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise. + */ + connectionId?: String; + /** + * Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null. + */ + credentials?: String; + /** + * A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name. + */ + requestParameters?: MapOfStringToString; + /** + * Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. + */ + requestTemplates?: MapOfStringToString; + /** + * Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request. + */ + passthroughBehavior?: String; + /** + * Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through. + */ + contentHandling?: ContentHandlingStrategy; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. + */ + timeoutInMillis?: Integer; + /** + * Specifies the integration's cache namespace. + */ + cacheNamespace?: String; + /** + * Specifies the integration's cache key parameters. + */ + cacheKeyParameters?: ListOfString; + /** + * Specifies the integration's responses. Example: Get integration responses of a method Request GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns 200 OK status and a payload as follows: { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } Creating an API + */ + integrationResponses?: MapOfIntegrationResponse; + } + export interface IntegrationResponse { + /** + * Specifies the status code that is used to map the integration response to an existing MethodResponse. + */ + statusCode?: StatusCode; + /** + * Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched. + */ + selectionPattern?: String; + /** + * A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix. + */ + responseParameters?: MapOfStringToString; + /** + * Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. + */ + responseTemplates?: MapOfStringToString; + /** + * Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. + */ + contentHandling?: ContentHandlingStrategy; + } + export type IntegrationType = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY"|string; + export type ListOfARNs = ProviderARN[]; + export type ListOfApiKey = ApiKey[]; + export type ListOfApiStage = ApiStage[]; + export type ListOfAuthorizer = Authorizer[]; + export type ListOfBasePathMapping = BasePathMapping[]; + export type ListOfClientCertificate = ClientCertificate[]; + export type ListOfDeployment = Deployment[]; + export type ListOfDocumentationPart = DocumentationPart[]; + export type ListOfDocumentationVersion = DocumentationVersion[]; + export type ListOfDomainName = DomainName[]; + export type ListOfEndpointType = EndpointType[]; + export type ListOfGatewayResponse = GatewayResponse[]; + export type ListOfLong = Long[]; + export type ListOfModel = Model[]; + export type ListOfPatchOperation = PatchOperation[]; + export type ListOfRequestValidator = RequestValidator[]; + export type ListOfResource = Resource[]; + export type ListOfRestApi = RestApi[]; + export type ListOfSdkConfigurationProperty = SdkConfigurationProperty[]; + export type ListOfSdkType = SdkType[]; + export type ListOfStage = Stage[]; + export type ListOfStageKeys = StageKey[]; + export type ListOfString = String[]; + export type ListOfUsage = ListOfLong[]; + export type ListOfUsagePlan = UsagePlan[]; + export type ListOfUsagePlanKey = UsagePlanKey[]; + export type ListOfVpcLink = VpcLink[]; + export type LocationStatusType = "DOCUMENTED"|"UNDOCUMENTED"|string; + export type Long = number; + export type MapOfApiStageThrottleSettings = {[key: string]: ThrottleSettings}; + export type MapOfIntegrationResponse = {[key: string]: IntegrationResponse}; + export type MapOfKeyUsages = {[key: string]: ListOfUsage}; + export type MapOfMethod = {[key: string]: Method}; + export type MapOfMethodResponse = {[key: string]: MethodResponse}; + export type MapOfMethodSettings = {[key: string]: MethodSetting}; + export type MapOfMethodSnapshot = {[key: string]: MethodSnapshot}; + export type MapOfStringToBoolean = {[key: string]: NullableBoolean}; + export type MapOfStringToList = {[key: string]: ListOfString}; + export type MapOfStringToString = {[key: string]: String}; + export interface Method { + /** + * The method's HTTP verb. + */ + httpMethod?: String; + /** + * The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. + */ + authorizationType?: String; + /** + * The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM. + */ + authorizerId?: String; + /** + * A boolean flag specifying whether a valid ApiKey is required to invoke this method. + */ + apiKeyRequired?: NullableBoolean; + /** + * The identifier of a RequestValidator for request validation. + */ + requestValidatorId?: String; + /** + * A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example. + */ + operationName?: String; + /** + * A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates. + */ + requestParameters?: MapOfStringToBoolean; + /** + * A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). + */ + requestModels?: MapOfStringToString; + /** + * Gets a method response associated with a given HTTP status code. The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response. Example: Get a 200 OK response of a GET method Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" } AWS CLI + */ + methodResponses?: MapOfMethodResponse; + /** + * Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end. Example: Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } } AWS CLI + */ + methodIntegration?: Integration; + /** + * A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS 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. + */ + authorizationScopes?: ListOfString; + } + export interface MethodResponse { + /** + * The method response's status code. + */ + statusCode?: StatusCode; + /** + * A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) + */ + responseParameters?: MapOfStringToBoolean; + /** + * Specifies the Model 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 Model name as the value. + */ + responseModels?: MapOfStringToString; + } + export interface MethodSetting { + /** + * Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean. + */ + metricsEnabled?: Boolean; + /** + * Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. + */ + loggingLevel?: String; + /** + * Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean. + */ + dataTraceEnabled?: Boolean; + /** + * Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer. + */ + throttlingBurstLimit?: Integer; + /** + * Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double. + */ + throttlingRateLimit?: Double; + /** + * Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean. + */ + cachingEnabled?: Boolean; + /** + * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer. + */ + cacheTtlInSeconds?: Integer; + /** + * Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean. + */ + cacheDataEncrypted?: Boolean; + /** + * Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean. + */ + requireAuthorizationForCacheControl?: Boolean; + /** + * Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER. + */ + unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy; + } + export interface MethodSnapshot { + /** + * The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. + */ + authorizationType?: String; + /** + * Specifies whether the method requires a valid ApiKey. + */ + apiKeyRequired?: Boolean; + } + export interface Model { + /** + * The identifier for the model resource. + */ + id?: String; + /** + * The name of the model. Must be an alphanumeric string. + */ + name?: String; + /** + * The description of the model. + */ + description?: String; + /** + * The schema for the model. For application/json models, this should be JSON schema draft 4 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. + */ + schema?: String; + /** + * The content-type for the model. + */ + contentType?: String; + } + export interface Models { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfModel; + } + export type NullableBoolean = boolean; + export type NullableInteger = number; + export type Op = "add"|"remove"|"replace"|"move"|"copy"|"test"|string; + export interface PatchOperation { + /** + * An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message. + */ + op?: Op; + /** + * The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it. + */ + path?: String; + /** + * The new target value of the update operation. It is applicable for the add or replace 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 Using JSON for Parameters. + */ + value?: String; + /** + * The copy update operation's source as identified by a JSON-Pointer 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 Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId". + */ + from?: String; + } + export type PathToMapOfMethodSnapshot = {[key: string]: MapOfMethodSnapshot}; + export type ProviderARN = string; + export interface PutGatewayResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE + */ + responseType: GatewayResponseType; + /** + * The HTTP status code of the GatewayResponse. + */ + statusCode?: StatusCode; + /** + * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. + */ + responseParameters?: MapOfStringToString; + /** + * Response templates of the GatewayResponse as a string-to-string map of key-value pairs. + */ + responseTemplates?: MapOfStringToString; + } + export interface PutIntegrationRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a put integration request's resource ID. + */ + resourceId: String; + /** + * [Required] Specifies a put integration request's HTTP method. + */ + httpMethod: String; + /** + * [Required] Specifies a put integration input's type. + */ + type: IntegrationType; + /** + * Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required. + */ + integrationHttpMethod?: String; + /** + * Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api 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 GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} + */ + uri?: String; + /** + * The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. + */ + connectionType?: ConnectionType; + /** + * The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise. + */ + connectionId?: String; + /** + * Specifies whether credentials are required for a put integration. + */ + credentials?: String; + /** + * A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name. + */ + requestParameters?: MapOfStringToString; + /** + * Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. + */ + requestTemplates?: MapOfStringToString; + /** + * 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 requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation. NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response. WHEN_NO_TEMPLATES 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. + */ + passthroughBehavior?: String; + /** + * Specifies a put integration input's cache namespace. + */ + cacheNamespace?: String; + /** + * Specifies a put integration input's cache key parameters. + */ + cacheKeyParameters?: ListOfString; + /** + * Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through. + */ + contentHandling?: ContentHandlingStrategy; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. + */ + timeoutInMillis?: NullableInteger; + } + export interface PutIntegrationResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a put integration response request's resource identifier. + */ + resourceId: String; + /** + * [Required] Specifies a put integration response request's HTTP method. + */ + httpMethod: String; + /** + * [Required] Specifies the status code that is used to map the integration response to an existing MethodResponse. + */ + statusCode: StatusCode; + /** + * Specifies the selection pattern of a put integration response. + */ + selectionPattern?: String; + /** + * A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix. + */ + responseParameters?: MapOfStringToString; + /** + * Specifies a put integration response's templates. + */ + responseTemplates?: MapOfStringToString; + /** + * Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. + */ + contentHandling?: ContentHandlingStrategy; + } + export interface PutMethodRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the new Method resource. + */ + resourceId: String; + /** + * [Required] Specifies the method request's HTTP method type. + */ + httpMethod: String; + /** + * [Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. + */ + authorizationType: String; + /** + * Specifies the identifier of an Authorizer 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. + */ + authorizerId?: String; + /** + * Specifies whether the method required a valid ApiKey. + */ + apiKeyRequired?: Boolean; + /** + * A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example. + */ + operationName?: String; + /** + * A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates. + */ + requestParameters?: MapOfStringToBoolean; + /** + * Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value. + */ + requestModels?: MapOfStringToString; + /** + * The identifier of a RequestValidator for validating the method request. + */ + requestValidatorId?: String; + /** + * A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS 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. + */ + authorizationScopes?: ListOfString; + } + export interface PutMethodResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the Method resource. + */ + resourceId: String; + /** + * [Required] The HTTP verb of the Method resource. + */ + httpMethod: String; + /** + * [Required] The method response's status code. + */ + statusCode: StatusCode; + /** + * A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) + */ + responseParameters?: MapOfStringToBoolean; + /** + * Specifies the Model 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 Model name as the value. + */ + responseModels?: MapOfStringToString; + } + export type PutMode = "merge"|"overwrite"|string; + export interface PutRestApiRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge". + */ + mode?: PutMode; + /** + * A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false. + */ + failOnWarnings?: Boolean; + /** + * Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'. + */ + parameters?: MapOfStringToString; + /** + * [Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB. + */ + body: _Blob; + } + export type QuotaPeriodType = "DAY"|"WEEK"|"MONTH"|string; + export interface QuotaSettings { + /** + * The maximum number of requests that can be made in a given time period. + */ + limit?: Integer; + /** + * The number of requests subtracted from the given limit in the initial time period. + */ + offset?: Integer; + /** + * The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH". + */ + period?: QuotaPeriodType; + } + export interface RequestValidator { + /** + * The identifier of this RequestValidator. + */ + id?: String; + /** + * The name of this RequestValidator + */ + name?: String; + /** + * A Boolean flag to indicate whether to validate a request body according to the configured Model schema. + */ + validateRequestBody?: Boolean; + /** + * A Boolean flag to indicate whether to validate request parameters (true) or not (false). + */ + validateRequestParameters?: Boolean; + } + export interface RequestValidators { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfRequestValidator; + } + export interface Resource { + /** + * The resource's identifier. + */ + id?: String; + /** + * The parent resource's identifier. + */ + parentId?: String; + /** + * The last path segment for this resource. + */ + pathPart?: String; + /** + * The full path for this resource. + */ + path?: String; + /** + * Gets an API resource's method of a given HTTP verb. The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request. Example: Get the GET method of an API resource Request GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } } If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS. + */ + resourceMethods?: MapOfMethod; + } + export interface Resources { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfResource; + } + export interface RestApi { + /** + * The API's identifier. This identifier is unique across all of your APIs in API Gateway. + */ + id?: String; + /** + * The API's name. + */ + name?: String; + /** + * The API's description. + */ + description?: String; + /** + * The timestamp when the API was created. + */ + createdDate?: Timestamp; + /** + * A version identifier for the API. + */ + version?: String; + /** + * The warning messages reported when failonwarnings is turned on during API import. + */ + warnings?: ListOfString; + /** + * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. + */ + binaryMediaTypes?: ListOfString; + /** + * 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. + */ + minimumCompressionSize?: NullableInteger; + /** + * The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer. + */ + apiKeySource?: ApiKeySourceType; + /** + * The endpoint configuration of this RestApi showing the endpoint types of the API. + */ + endpointConfiguration?: EndpointConfiguration; + /** + * A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration. + */ + policy?: String; + } + export interface RestApis { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfRestApi; + } + export interface SdkConfigurationProperty { + /** + * The name of a an SdkType configuration property. + */ + name?: String; + /** + * The user-friendly name of an SdkType configuration property. + */ + friendlyName?: String; + /** + * The description of an SdkType configuration property. + */ + description?: String; + /** + * A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false). + */ + required?: Boolean; + /** + * The default value of an SdkType configuration property. + */ + defaultValue?: String; + } + export interface SdkResponse { + /** + * The content-type header value in the HTTP response. + */ + contentType?: String; + /** + * The content-disposition header value in the HTTP response. + */ + contentDisposition?: String; + /** + * The binary blob response to GetSdk, which contains the generated SDK. + */ + body?: _Blob; + } + export interface SdkType { + /** + * The identifier of an SdkType instance. + */ + id?: String; + /** + * The user-friendly name of an SdkType instance. + */ + friendlyName?: String; + /** + * The description of an SdkType. + */ + description?: String; + /** + * A list of configuration properties of an SdkType. + */ + configurationProperties?: ListOfSdkConfigurationProperty; + } + export interface SdkTypes { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfSdkType; + } + export interface Stage { + /** + * The identifier of the Deployment that the stage points to. + */ + deploymentId?: String; + /** + * The identifier of a client certificate for an API stage. + */ + clientCertificateId?: String; + /** + * The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. + */ + stageName?: String; + /** + * The stage's description. + */ + description?: String; + /** + * Specifies whether a cache cluster is enabled for the stage. + */ + cacheClusterEnabled?: Boolean; + /** + * The size of the cache cluster for the stage, if enabled. + */ + cacheClusterSize?: CacheClusterSize; + /** + * The status of the cache cluster for the stage, if enabled. + */ + cacheClusterStatus?: CacheClusterStatus; + /** + * A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*\* for overriding all methods in the stage. + */ + methodSettings?: MapOfMethodSettings; + /** + * A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. + */ + variables?: MapOfStringToString; + /** + * The version of the associated API documentation. + */ + documentationVersion?: String; + /** + * Settings for logging access in this stage. + */ + accessLogSettings?: AccessLogSettings; + /** + * Settings for the canary deployment in this stage. + */ + canarySettings?: CanarySettings; + /** + * Specifies whether active tracing with X-ray is enabled for the Stage. + */ + tracingEnabled?: Boolean; + /** + * The ARN of the WebAcl associated with the Stage. + */ + webAclArn?: String; + /** + * The collection of tags. Each tag element is associated with a given resource. + */ + tags?: MapOfStringToString; + /** + * The timestamp when the stage was created. + */ + createdDate?: Timestamp; + /** + * The timestamp when the stage last updated. + */ + lastUpdatedDate?: Timestamp; + } + export interface StageKey { + /** + * The string identifier of the associated RestApi. + */ + restApiId?: String; + /** + * The stage name associated with the stage key. + */ + stageName?: String; + } + export interface Stages { + /** + * The current page of elements from this collection. + */ + item?: ListOfStage; + } + export type StatusCode = string; + export type String = string; + export interface TagResourceRequest { + /** + * [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, Stage is the only taggable resource. + */ + resourceArn: String; + /** + * [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 aws:. The tag value can be up to 256 characters. + */ + tags: MapOfStringToString; + } + export interface Tags { + /** + * The collection of tags. Each tag element is associated with a given resource. + */ + tags?: MapOfStringToString; + } + export interface Template { + /** + * The Apache Velocity Template Language (VTL) template content used for the template resource. + */ + value?: String; + } + export interface TestInvokeAuthorizerRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a test invoke authorizer request's Authorizer ID. + */ + authorizerId: String; + /** + * [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified. + */ + headers?: MapOfStringToString; + /** + * [Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified. + */ + multiValueHeaders?: MapOfStringToList; + /** + * [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters. + */ + pathWithQueryString?: String; + /** + * [Optional] The simulated request body of an incoming invocation request. + */ + body?: String; + /** + * A key-value map of stage variables to simulate an invocation on a deployed Stage. + */ + stageVariables?: MapOfStringToString; + /** + * [Optional] A key-value map of additional context variables. + */ + additionalContext?: MapOfStringToString; + } + export interface TestInvokeAuthorizerResponse { + /** + * The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded. + */ + clientStatus?: Integer; + /** + * The API Gateway execution log for the test authorizer request. + */ + log?: String; + /** + * The execution latency of the test authorizer request. + */ + latency?: Long; + /** + * The principal identity returned by the Authorizer + */ + principalId?: String; + /** + * The JSON policy document returned by the Authorizer + */ + policy?: String; + authorization?: MapOfStringToList; + /** + * The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API. + */ + claims?: MapOfStringToString; + } + export interface TestInvokeMethodRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies a test invoke method request's resource ID. + */ + resourceId: String; + /** + * [Required] Specifies a test invoke method request's HTTP method. + */ + httpMethod: String; + /** + * The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters. + */ + pathWithQueryString?: String; + /** + * The simulated request body of an incoming invocation request. + */ + body?: String; + /** + * A key-value map of headers to simulate an incoming invocation request. + */ + headers?: MapOfStringToString; + /** + * The headers as a map from string to list of values to simulate an incoming invocation request. + */ + multiValueHeaders?: MapOfStringToList; + /** + * A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint. + */ + clientCertificateId?: String; + /** + * A key-value map of stage variables to simulate an invocation on a deployed Stage. + */ + stageVariables?: MapOfStringToString; + } + export interface TestInvokeMethodResponse { + /** + * The HTTP status code. + */ + status?: Integer; + /** + * The body of the HTTP response. + */ + body?: String; + /** + * The headers of the HTTP response. + */ + headers?: MapOfStringToString; + /** + * The headers of the HTTP response as a map from string to list of values. + */ + multiValueHeaders?: MapOfStringToList; + /** + * The API Gateway execution log for the test invoke request. + */ + log?: String; + /** + * The execution latency of the test invoke request. + */ + latency?: Long; + } + export interface ThrottleSettings { + /** + * The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity. + */ + burstLimit?: Integer; + /** + * The API request steady-state rate limit. + */ + rateLimit?: Double; + } + export type Timestamp = Date; + export type UnauthorizedCacheControlHeaderStrategy = "FAIL_WITH_403"|"SUCCEED_WITH_RESPONSE_HEADER"|"SUCCEED_WITHOUT_RESPONSE_HEADER"|string; + export interface UntagResourceRequest { + /** + * [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, Stage is the only taggable resource. + */ + resourceArn: String; + /** + * [Required] The Tag keys to delete. + */ + tagKeys: ListOfString; + } + export interface UpdateAccountRequest { + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateApiKeyRequest { + /** + * [Required] The identifier of the ApiKey resource to be updated. + */ + apiKey: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateAuthorizerRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the Authorizer resource. + */ + authorizerId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateBasePathMappingRequest { + /** + * [Required] The domain name of the BasePathMapping resource to change. + */ + domainName: String; + /** + * [Required] The base path of the BasePathMapping resource to change. + */ + basePath: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateClientCertificateRequest { + /** + * [Required] The identifier of the ClientCertificate resource to be updated. + */ + clientCertificateId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateDeploymentRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * The replacement identifier for the Deployment resource to change information about. + */ + deploymentId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateDocumentationPartRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the to-be-updated documentation part. + */ + documentationPartId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateDocumentationVersionRequest { + /** + * [Required] The string identifier of the associated RestApi.. + */ + restApiId: String; + /** + * [Required] The version identifier of the to-be-updated documentation version. + */ + documentationVersion: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateDomainNameRequest { + /** + * [Required] The name of the DomainName resource to be changed. + */ + domainName: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateGatewayResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE + */ + responseType: GatewayResponseType; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateIntegrationRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Represents an update integration request's resource identifier. + */ + resourceId: String; + /** + * [Required] Represents an update integration request's HTTP method. + */ + httpMethod: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateIntegrationResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] Specifies an update integration response request's resource identifier. + */ + resourceId: String; + /** + * [Required] Specifies an update integration response request's HTTP method. + */ + httpMethod: String; + /** + * [Required] Specifies an update integration response request's status code. + */ + statusCode: StatusCode; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateMethodRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the Method resource. + */ + resourceId: String; + /** + * [Required] The HTTP verb of the Method resource. + */ + httpMethod: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateMethodResponseRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The Resource identifier for the MethodResponse resource. + */ + resourceId: String; + /** + * [Required] The HTTP verb of the Method resource. + */ + httpMethod: String; + /** + * [Required] The status code for the MethodResponse resource. + */ + statusCode: StatusCode; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateModelRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the model to update. + */ + modelName: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateRequestValidatorRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of RequestValidator to be updated. + */ + requestValidatorId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateResourceRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The identifier of the Resource resource. + */ + resourceId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateRestApiRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateStageRequest { + /** + * [Required] The string identifier of the associated RestApi. + */ + restApiId: String; + /** + * [Required] The name of the Stage resource to change information about. + */ + stageName: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateUsagePlanRequest { + /** + * [Required] The Id of the to-be-updated usage plan. + */ + usagePlanId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateUsageRequest { + /** + * [Required] The Id of the usage plan associated with the usage data. + */ + usagePlanId: String; + /** + * [Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota. + */ + keyId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface UpdateVpcLinkRequest { + /** + * [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink. + */ + vpcLinkId: String; + /** + * A list of update operations to be applied to the specified resource and in the order specified in this list. + */ + patchOperations?: ListOfPatchOperation; + } + export interface Usage { + /** + * The plan Id associated with this usage data. + */ + usagePlanId?: String; + /** + * The starting date of the usage data. + */ + startDate?: String; + /** + * The ending date of the usage data. + */ + endDate?: String; + position?: String; + /** + * The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota]. + */ + items?: MapOfKeyUsages; + } + export interface UsagePlan { + /** + * The identifier of a UsagePlan resource. + */ + id?: String; + /** + * The name of a usage plan. + */ + name?: String; + /** + * The description of a usage plan. + */ + description?: String; + /** + * The associated API stages of a usage plan. + */ + apiStages?: ListOfApiStage; + /** + * The request throttle limits of a usage plan. + */ + throttle?: ThrottleSettings; + /** + * The maximum number of permitted requests per a given unit time interval. + */ + quota?: QuotaSettings; + /** + * The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace. + */ + productCode?: String; + } + export interface UsagePlanKey { + /** + * The Id of a usage plan key. + */ + id?: String; + /** + * The type of a usage plan key. Currently, the valid key type is API_KEY. + */ + type?: String; + /** + * The value of a usage plan key. + */ + value?: String; + /** + * The name of a usage plan key. + */ + name?: String; + } + export interface UsagePlanKeys { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfUsagePlanKey; + } + export interface UsagePlans { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfUsagePlan; + } + export interface VpcLink { + /** + * The identifier of the VpcLink. It is used in an Integration to reference this VpcLink. + */ + id?: String; + /** + * The name used to label and identify the VPC link. + */ + name?: String; + /** + * The description of the VPC link. + */ + description?: String; + /** + * 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. + */ + targetArns?: ListOfString; + /** + * The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING. + */ + status?: VpcLinkStatus; + /** + * A description about the VPC link status. + */ + statusMessage?: String; + } + export type VpcLinkStatus = "AVAILABLE"|"PENDING"|"DELETING"|"FAILED"|string; + export interface VpcLinks { + position?: String; + /** + * The current page of elements from this collection. + */ + items?: ListOfVpcLink; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-07-09"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the APIGateway client. + */ + export import Types = APIGateway; +} +export = APIGateway; diff --git a/node_modules/aws-sdk/clients/apigateway.js b/node_modules/aws-sdk/clients/apigateway.js new file mode 100644 index 0000000..f73296e --- /dev/null +++ b/node_modules/aws-sdk/clients/apigateway.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['apigateway'] = {}; +AWS.APIGateway = Service.defineService('apigateway', ['2015-07-09']); +require('../lib/services/apigateway'); +Object.defineProperty(apiLoader.services['apigateway'], '2015-07-09', { + get: function get() { + var model = require('../apis/apigateway-2015-07-09.min.json'); + model.paginators = require('../apis/apigateway-2015-07-09.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.APIGateway; diff --git a/node_modules/aws-sdk/clients/apigatewaymanagementapi.d.ts b/node_modules/aws-sdk/clients/apigatewaymanagementapi.d.ts new file mode 100644 index 0000000..9b62e0e --- /dev/null +++ b/node_modules/aws-sdk/clients/apigatewaymanagementapi.d.ts @@ -0,0 +1,52 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ApiGatewayManagementApi extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ApiGatewayManagementApi.Types.ClientConfiguration) + config: Config & ApiGatewayManagementApi.Types.ClientConfiguration; + /** + * Sends the provided data to the specified connection. + */ + postToConnection(params: ApiGatewayManagementApi.Types.PostToConnectionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sends the provided data to the specified connection. + */ + postToConnection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace ApiGatewayManagementApi { + export type Data = Buffer|Uint8Array|Blob|string; + export interface PostToConnectionRequest { + /** + * The data to be sent to the client specified by its connection id. + */ + Data: Data; + /** + * The identifier of the connection that a specific client is using. + */ + ConnectionId: __string; + } + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-11-29"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ApiGatewayManagementApi client. + */ + export import Types = ApiGatewayManagementApi; +} +export = ApiGatewayManagementApi; diff --git a/node_modules/aws-sdk/clients/apigatewaymanagementapi.js b/node_modules/aws-sdk/clients/apigatewaymanagementapi.js new file mode 100644 index 0000000..bee33fb --- /dev/null +++ b/node_modules/aws-sdk/clients/apigatewaymanagementapi.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['apigatewaymanagementapi'] = {}; +AWS.ApiGatewayManagementApi = Service.defineService('apigatewaymanagementapi', ['2018-11-29']); +Object.defineProperty(apiLoader.services['apigatewaymanagementapi'], '2018-11-29', { + get: function get() { + var model = require('../apis/apigatewaymanagementapi-2018-11-29.min.json'); + model.paginators = require('../apis/apigatewaymanagementapi-2018-11-29.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ApiGatewayManagementApi; diff --git a/node_modules/aws-sdk/clients/apigatewayv2.d.ts b/node_modules/aws-sdk/clients/apigatewayv2.d.ts new file mode 100644 index 0000000..282ab5d --- /dev/null +++ b/node_modules/aws-sdk/clients/apigatewayv2.d.ts @@ -0,0 +1,4025 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ApiGatewayV2 extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ApiGatewayV2.Types.ClientConfiguration) + config: Config & ApiGatewayV2.Types.ClientConfiguration; + /** + * Creates an Api resource. + */ + createApi(params: ApiGatewayV2.Types.CreateApiRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateApiResponse) => void): Request; + /** + * Creates an Api resource. + */ + createApi(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateApiResponse) => void): Request; + /** + * Creates an API mapping. + */ + createApiMapping(params: ApiGatewayV2.Types.CreateApiMappingRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateApiMappingResponse) => void): Request; + /** + * Creates an API mapping. + */ + createApiMapping(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateApiMappingResponse) => void): Request; + /** + * Creates an Authorizer for an API. + */ + createAuthorizer(params: ApiGatewayV2.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateAuthorizerResponse) => void): Request; + /** + * Creates an Authorizer for an API. + */ + createAuthorizer(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateAuthorizerResponse) => void): Request; + /** + * Creates a Deployment for an API. + */ + createDeployment(params: ApiGatewayV2.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateDeploymentResponse) => void): Request; + /** + * Creates a Deployment for an API. + */ + createDeployment(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateDeploymentResponse) => void): Request; + /** + * Creates a domain name. + */ + createDomainName(params: ApiGatewayV2.Types.CreateDomainNameRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateDomainNameResponse) => void): Request; + /** + * Creates a domain name. + */ + createDomainName(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateDomainNameResponse) => void): Request; + /** + * Creates an Integration. + */ + createIntegration(params: ApiGatewayV2.Types.CreateIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateIntegrationResponse) => void): Request; + /** + * Creates an Integration. + */ + createIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateIntegrationResponse) => void): Request; + /** + * Creates an IntegrationResponses. + */ + createIntegrationResponse(params: ApiGatewayV2.Types.CreateIntegrationResponseRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateIntegrationResponseResponse) => void): Request; + /** + * Creates an IntegrationResponses. + */ + createIntegrationResponse(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateIntegrationResponseResponse) => void): Request; + /** + * Creates a Model for an API. + */ + createModel(params: ApiGatewayV2.Types.CreateModelRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateModelResponse) => void): Request; + /** + * Creates a Model for an API. + */ + createModel(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateModelResponse) => void): Request; + /** + * Creates a Route for an API. + */ + createRoute(params: ApiGatewayV2.Types.CreateRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateRouteResponse) => void): Request; + /** + * Creates a Route for an API. + */ + createRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateRouteResponse) => void): Request; + /** + * Creates a RouteResponse for a Route. + */ + createRouteResponse(params: ApiGatewayV2.Types.CreateRouteResponseRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateRouteResponseResponse) => void): Request; + /** + * Creates a RouteResponse for a Route. + */ + createRouteResponse(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateRouteResponseResponse) => void): Request; + /** + * Creates a Stage for an API. + */ + createStage(params: ApiGatewayV2.Types.CreateStageRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateStageResponse) => void): Request; + /** + * Creates a Stage for an API. + */ + createStage(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateStageResponse) => void): Request; + /** + * Deletes an Api resource. + */ + deleteApi(params: ApiGatewayV2.Types.DeleteApiRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Api resource. + */ + deleteApi(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an API mapping. + */ + deleteApiMapping(params: ApiGatewayV2.Types.DeleteApiMappingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an API mapping. + */ + deleteApiMapping(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Authorizer. + */ + deleteAuthorizer(params: ApiGatewayV2.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Authorizer. + */ + deleteAuthorizer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Deployment. + */ + deleteDeployment(params: ApiGatewayV2.Types.DeleteDeploymentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Deployment. + */ + deleteDeployment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a domain name. + */ + deleteDomainName(params: ApiGatewayV2.Types.DeleteDomainNameRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a domain name. + */ + deleteDomainName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Integration. + */ + deleteIntegration(params: ApiGatewayV2.Types.DeleteIntegrationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Integration. + */ + deleteIntegration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an IntegrationResponses. + */ + deleteIntegrationResponse(params: ApiGatewayV2.Types.DeleteIntegrationResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an IntegrationResponses. + */ + deleteIntegrationResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Model. + */ + deleteModel(params: ApiGatewayV2.Types.DeleteModelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Model. + */ + deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Route. + */ + deleteRoute(params: ApiGatewayV2.Types.DeleteRouteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Route. + */ + deleteRoute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a RouteResponse. + */ + deleteRouteResponse(params: ApiGatewayV2.Types.DeleteRouteResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a RouteResponse. + */ + deleteRouteResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Stage. + */ + deleteStage(params: ApiGatewayV2.Types.DeleteStageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Stage. + */ + deleteStage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets an Api resource. + */ + getApi(params: ApiGatewayV2.Types.GetApiRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiResponse) => void): Request; + /** + * Gets an Api resource. + */ + getApi(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiResponse) => void): Request; + /** + * The API mapping. + */ + getApiMapping(params: ApiGatewayV2.Types.GetApiMappingRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingResponse) => void): Request; + /** + * The API mapping. + */ + getApiMapping(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingResponse) => void): Request; + /** + * The API mappings. + */ + getApiMappings(params: ApiGatewayV2.Types.GetApiMappingsRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingsResponse) => void): Request; + /** + * The API mappings. + */ + getApiMappings(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingsResponse) => void): Request; + /** + * Gets a collection of Api resources. + */ + getApis(params: ApiGatewayV2.Types.GetApisRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApisResponse) => void): Request; + /** + * Gets a collection of Api resources. + */ + getApis(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApisResponse) => void): Request; + /** + * Gets an Authorizer. + */ + getAuthorizer(params: ApiGatewayV2.Types.GetAuthorizerRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetAuthorizerResponse) => void): Request; + /** + * Gets an Authorizer. + */ + getAuthorizer(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetAuthorizerResponse) => void): Request; + /** + * Gets the Authorizers for an API. + */ + getAuthorizers(params: ApiGatewayV2.Types.GetAuthorizersRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetAuthorizersResponse) => void): Request; + /** + * Gets the Authorizers for an API. + */ + getAuthorizers(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetAuthorizersResponse) => void): Request; + /** + * Gets a Deployment. + */ + getDeployment(params: ApiGatewayV2.Types.GetDeploymentRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDeploymentResponse) => void): Request; + /** + * Gets a Deployment. + */ + getDeployment(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDeploymentResponse) => void): Request; + /** + * Gets the Deployments for an API. + */ + getDeployments(params: ApiGatewayV2.Types.GetDeploymentsRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDeploymentsResponse) => void): Request; + /** + * Gets the Deployments for an API. + */ + getDeployments(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDeploymentsResponse) => void): Request; + /** + * Gets a domain name. + */ + getDomainName(params: ApiGatewayV2.Types.GetDomainNameRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDomainNameResponse) => void): Request; + /** + * Gets a domain name. + */ + getDomainName(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDomainNameResponse) => void): Request; + /** + * Gets the domain names for an AWS account. + */ + getDomainNames(params: ApiGatewayV2.Types.GetDomainNamesRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDomainNamesResponse) => void): Request; + /** + * Gets the domain names for an AWS account. + */ + getDomainNames(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetDomainNamesResponse) => void): Request; + /** + * Gets an Integration. + */ + getIntegration(params: ApiGatewayV2.Types.GetIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResponse) => void): Request; + /** + * Gets an Integration. + */ + getIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResponse) => void): Request; + /** + * Gets an IntegrationResponses. + */ + getIntegrationResponse(params: ApiGatewayV2.Types.GetIntegrationResponseRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResponseResponse) => void): Request; + /** + * Gets an IntegrationResponses. + */ + getIntegrationResponse(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResponseResponse) => void): Request; + /** + * Gets the IntegrationResponses for an Integration. + */ + getIntegrationResponses(params: ApiGatewayV2.Types.GetIntegrationResponsesRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResponsesResponse) => void): Request; + /** + * Gets the IntegrationResponses for an Integration. + */ + getIntegrationResponses(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResponsesResponse) => void): Request; + /** + * Gets the Integrations for an API. + */ + getIntegrations(params: ApiGatewayV2.Types.GetIntegrationsRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationsResponse) => void): Request; + /** + * Gets the Integrations for an API. + */ + getIntegrations(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationsResponse) => void): Request; + /** + * Gets a Model. + */ + getModel(params: ApiGatewayV2.Types.GetModelRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetModelResponse) => void): Request; + /** + * Gets a Model. + */ + getModel(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetModelResponse) => void): Request; + /** + * Gets a model template. + */ + getModelTemplate(params: ApiGatewayV2.Types.GetModelTemplateRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetModelTemplateResponse) => void): Request; + /** + * Gets a model template. + */ + getModelTemplate(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetModelTemplateResponse) => void): Request; + /** + * Gets the Models for an API. + */ + getModels(params: ApiGatewayV2.Types.GetModelsRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetModelsResponse) => void): Request; + /** + * Gets the Models for an API. + */ + getModels(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetModelsResponse) => void): Request; + /** + * Gets a Route. + */ + getRoute(params: ApiGatewayV2.Types.GetRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResponse) => void): Request; + /** + * Gets a Route. + */ + getRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResponse) => void): Request; + /** + * Gets a RouteResponse. + */ + getRouteResponse(params: ApiGatewayV2.Types.GetRouteResponseRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResponseResponse) => void): Request; + /** + * Gets a RouteResponse. + */ + getRouteResponse(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResponseResponse) => void): Request; + /** + * Gets the RouteResponses for a Route. + */ + getRouteResponses(params: ApiGatewayV2.Types.GetRouteResponsesRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResponsesResponse) => void): Request; + /** + * Gets the RouteResponses for a Route. + */ + getRouteResponses(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResponsesResponse) => void): Request; + /** + * Gets the Routes for an API. + */ + getRoutes(params: ApiGatewayV2.Types.GetRoutesRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRoutesResponse) => void): Request; + /** + * Gets the Routes for an API. + */ + getRoutes(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRoutesResponse) => void): Request; + /** + * Gets a Stage. + */ + getStage(params: ApiGatewayV2.Types.GetStageRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetStageResponse) => void): Request; + /** + * Gets a Stage. + */ + getStage(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetStageResponse) => void): Request; + /** + * Gets the Stages for an API. + */ + getStages(params: ApiGatewayV2.Types.GetStagesRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetStagesResponse) => void): Request; + /** + * Gets the Stages for an API. + */ + getStages(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetStagesResponse) => void): Request; + /** + * Updates an Api resource. + */ + updateApi(params: ApiGatewayV2.Types.UpdateApiRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateApiResponse) => void): Request; + /** + * Updates an Api resource. + */ + updateApi(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateApiResponse) => void): Request; + /** + * The API mapping. + */ + updateApiMapping(params: ApiGatewayV2.Types.UpdateApiMappingRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateApiMappingResponse) => void): Request; + /** + * The API mapping. + */ + updateApiMapping(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateApiMappingResponse) => void): Request; + /** + * Updates an Authorizer. + */ + updateAuthorizer(params: ApiGatewayV2.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateAuthorizerResponse) => void): Request; + /** + * Updates an Authorizer. + */ + updateAuthorizer(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateAuthorizerResponse) => void): Request; + /** + * Updates a Deployment. + */ + updateDeployment(params: ApiGatewayV2.Types.UpdateDeploymentRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateDeploymentResponse) => void): Request; + /** + * Updates a Deployment. + */ + updateDeployment(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateDeploymentResponse) => void): Request; + /** + * Updates a domain name. + */ + updateDomainName(params: ApiGatewayV2.Types.UpdateDomainNameRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateDomainNameResponse) => void): Request; + /** + * Updates a domain name. + */ + updateDomainName(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateDomainNameResponse) => void): Request; + /** + * Updates an Integration. + */ + updateIntegration(params: ApiGatewayV2.Types.UpdateIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateIntegrationResponse) => void): Request; + /** + * Updates an Integration. + */ + updateIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateIntegrationResponse) => void): Request; + /** + * Updates an IntegrationResponses. + */ + updateIntegrationResponse(params: ApiGatewayV2.Types.UpdateIntegrationResponseRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateIntegrationResponseResponse) => void): Request; + /** + * Updates an IntegrationResponses. + */ + updateIntegrationResponse(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateIntegrationResponseResponse) => void): Request; + /** + * Updates a Model. + */ + updateModel(params: ApiGatewayV2.Types.UpdateModelRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateModelResponse) => void): Request; + /** + * Updates a Model. + */ + updateModel(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateModelResponse) => void): Request; + /** + * Updates a Route. + */ + updateRoute(params: ApiGatewayV2.Types.UpdateRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateRouteResponse) => void): Request; + /** + * Updates a Route. + */ + updateRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateRouteResponse) => void): Request; + /** + * Updates a RouteResponse. + */ + updateRouteResponse(params: ApiGatewayV2.Types.UpdateRouteResponseRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateRouteResponseResponse) => void): Request; + /** + * Updates a RouteResponse. + */ + updateRouteResponse(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateRouteResponseResponse) => void): Request; + /** + * Updates a Stage. + */ + updateStage(params: ApiGatewayV2.Types.UpdateStageRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateStageResponse) => void): Request; + /** + * Updates a Stage. + */ + updateStage(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateStageResponse) => void): Request; +} +declare namespace ApiGatewayV2 { + export interface AccessLogSettings { + /** + * The ARN of the CloudWatch Logs log group to receive access logs. + */ + DestinationArn?: Arn; + /** + * A single line format of the access logs of data, as specified by selected $context + variables. The format must include at least $context.requestId. + */ + Format?: StringWithLengthBetween1And1024; + } + export interface Api { + /** + * The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + stage name is typically appended to this URI to form a complete path to a deployed + API stage. + */ + ApiEndpoint?: __string; + /** + * The API ID. + */ + ApiId?: Id; + /** + * An API key selection expression. See API Key Selection Expressions. + */ + ApiKeySelectionExpression?: SelectionExpression; + /** + * The timestamp when the API was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The description of the API. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Avoid validating models when creating a deployment. + */ + DisableSchemaValidation?: __boolean; + /** + * The name of the API. + */ + Name: StringWithLengthBetween1And128; + /** + * The API protocol: Currently only WEBSOCKET is supported. + */ + ProtocolType: ProtocolType; + /** + * The route selection expression for the API. + */ + RouteSelectionExpression: SelectionExpression; + /** + * A version identifier for the API. + */ + Version?: StringWithLengthBetween1And64; + /** + * The warning messages reported when failonwarnings is turned on during + API import. + */ + Warnings?: __listOf__string; + } + export interface ApiMapping { + /** + * The API identifier. + */ + ApiId: Id; + /** + * The API mapping identifier. + */ + ApiMappingId?: Id; + /** + * The API mapping key. + */ + ApiMappingKey?: SelectionKey; + /** + * The API stage. + */ + Stage: StringWithLengthBetween1And128; + } + export type Arn = string; + export type AuthorizationScopes = StringWithLengthBetween1And64[]; + export type AuthorizationType = "NONE"|"AWS_IAM"|"CUSTOM"|string; + export interface Authorizer { + /** + * 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. + */ + AuthorizerCredentialsArn?: Arn; + /** + * The authorizer identifier. + */ + AuthorizerId?: Id; + /** + * The time to live (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. + */ + AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600; + /** + * The authorizer type. Currently the only valid value is REQUEST, for a + Lambda function using incoming request parameters. + */ + AuthorizerType?: AuthorizerType; + /** + * The authorizer's Uniform Resource Identifier (URI). + ForREQUEST authorizers, this must be a + well-formed Lambda function URI, for example, + 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. + In general, the URI has this form: + arn:aws:apigateway:{region}:lambda:path/{service_api} + , where {region} is the same as the region hosting the Lambda + function, path indicates that the remaining substring in the URI should be treated as + the path to the resource, including the initial /. For Lambda functions, + this is usually of the form + /2015-03-31/functions/[FunctionARN]/invocations. + */ + AuthorizerUri?: UriWithLengthBetween1And2048; + /** + * The identity source for which authorization is requested.For the REQUEST 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 Auth + header and a Name query string parameters are defined as identity + sources, this value is method.request.header.Auth, + method.request.querystring.Name. These parameters will be used to + derive the authorization caching key and to perform runtime validation of the + REQUEST 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. + */ + IdentitySource?: IdentitySourceList; + /** + * The + validation expression does not apply to the REQUEST authorizer. + */ + IdentityValidationExpression?: StringWithLengthBetween0And1024; + /** + * The name of the authorizer. + */ + Name: StringWithLengthBetween1And128; + /** + * For + REQUEST authorizer, this is not + defined. + */ + ProviderArns?: ProviderArnList; + } + export type AuthorizerType = "REQUEST"|string; + export type ConnectionType = "INTERNET"|"VPC_LINK"|string; + export type ContentHandlingStrategy = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"|string; + export interface CreateApiMappingRequest { + /** + * The API identifier. + */ + ApiId: Id; + ApiMappingKey?: SelectionKey; + /** + * The domain name. + */ + DomainName: __string; + /** + * The API stage. + */ + Stage: StringWithLengthBetween1And128; + } + export interface CreateApiMappingResponse { + /** + * The API identifier. + */ + ApiId?: Id; + /** + * The API mapping identifier. + */ + ApiMappingId?: Id; + /** + * The API mapping key. + */ + ApiMappingKey?: SelectionKey; + /** + * The API stage. + */ + Stage?: StringWithLengthBetween1And128; + } + export interface CreateApiRequest { + /** + * An API key selection expression. See API Key Selection Expressions. + */ + ApiKeySelectionExpression?: SelectionExpression; + /** + * The description of the API. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Avoid validating models when creating a deployment. + */ + DisableSchemaValidation?: __boolean; + /** + * The name of the API. + */ + Name: StringWithLengthBetween1And128; + /** + * The API protocol: Currently only WEBSOCKET is supported. + */ + ProtocolType: ProtocolType; + /** + * The route selection expression for the API. + */ + RouteSelectionExpression: SelectionExpression; + /** + * A version identifier for the API. + */ + Version?: StringWithLengthBetween1And64; + } + export interface CreateApiResponse { + /** + * The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + stage name is typically appended to this URI to form a complete path to a deployed + API stage. + */ + ApiEndpoint?: __string; + /** + * The API ID. + */ + ApiId?: Id; + /** + * An API key selection expression. See API Key Selection Expressions. + */ + ApiKeySelectionExpression?: SelectionExpression; + /** + * The timestamp when the API was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The description of the API. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Avoid validating models when creating a deployment. + */ + DisableSchemaValidation?: __boolean; + /** + * The name of the API. + */ + Name?: StringWithLengthBetween1And128; + /** + * The API protocol: Currently only WEBSOCKET is supported. + */ + ProtocolType?: ProtocolType; + /** + * The route selection expression for the API. + */ + RouteSelectionExpression?: SelectionExpression; + /** + * A version identifier for the API. + */ + Version?: StringWithLengthBetween1And64; + /** + * The warning messages reported when failonwarnings is turned on during + API import. + */ + Warnings?: __listOf__string; + } + export interface CreateAuthorizerRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * 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. + */ + AuthorizerCredentialsArn?: Arn; + /** + * The time to live (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. + */ + AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600; + /** + * The authorizer type. Currently the only valid value is REQUEST, for a + Lambda function using incoming request parameters. + */ + AuthorizerType: AuthorizerType; + /** + * The authorizer's Uniform Resource Identifier (URI). For + REQUEST authorizers, this must be a + well-formed Lambda function URI, for example, + 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. + In general, the URI has this form: + arn:aws:apigateway:{region}:lambda:path/{service_api} + , where {region} is the same as the region hosting the Lambda + function, path indicates that the remaining substring in the URI should be treated as + the path to the resource, including the initial /. For Lambda functions, + this is usually of the form + /2015-03-31/functions/[FunctionARN]/invocations. + */ + AuthorizerUri: UriWithLengthBetween1And2048; + /** + * The identity source for which authorization is requested.For the REQUEST 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 Auth + header and a Name query string parameters are defined as identity + sources, this value is method.request.header.Auth, + method.request.querystring.Name. These parameters will be used to + derive the authorization caching key and to perform runtime validation of the + REQUEST 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. + */ + IdentitySource: IdentitySourceList; + /** + * The + validation expression does not apply to the REQUEST authorizer. + */ + IdentityValidationExpression?: StringWithLengthBetween0And1024; + /** + * The name of the authorizer. + */ + Name: StringWithLengthBetween1And128; + /** + * For + REQUEST authorizer, this is not + defined. + */ + ProviderArns?: ProviderArnList; + } + export interface CreateAuthorizerResponse { + /** + * 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. + */ + AuthorizerCredentialsArn?: Arn; + /** + * The authorizer identifier. + */ + AuthorizerId?: Id; + /** + * The time to live (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. + */ + AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600; + /** + * The authorizer type. Currently the only valid value is REQUEST, for a + Lambda function using incoming request parameters. + */ + AuthorizerType?: AuthorizerType; + /** + * The authorizer's Uniform Resource Identifier (URI). + ForREQUEST authorizers, this must be a + well-formed Lambda function URI, for example, + 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. + In general, the URI has this form: + arn:aws:apigateway:{region}:lambda:path/{service_api} + , where {region} is the same as the region hosting the Lambda + function, path indicates that the remaining substring in the URI should be treated as + the path to the resource, including the initial /. For Lambda functions, + this is usually of the form + /2015-03-31/functions/[FunctionARN]/invocations. + */ + AuthorizerUri?: UriWithLengthBetween1And2048; + /** + * The identity source for which authorization is requested.For the REQUEST 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 Auth + header and a Name query string parameters are defined as identity + sources, this value is method.request.header.Auth, + method.request.querystring.Name. These parameters will be used to + derive the authorization caching key and to perform runtime validation of the + REQUEST 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. + */ + IdentitySource?: IdentitySourceList; + /** + * The + validation expression does not apply to the REQUEST authorizer. + */ + IdentityValidationExpression?: StringWithLengthBetween0And1024; + /** + * The name of the authorizer. + */ + Name?: StringWithLengthBetween1And128; + /** + * For + REQUEST authorizer, this is not + defined. + */ + ProviderArns?: ProviderArnList; + } + export interface CreateDeploymentRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The description for the deployment resource. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The name of the Stage resource for the Deployment + resource to create. + */ + StageName?: StringWithLengthBetween1And128; + } + export interface CreateDeploymentResponse { + /** + * The date and time when the Deployment resource was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The identifier for the deployment. + */ + DeploymentId?: Id; + /** + * The status of the deployment: PENDING, FAILED, or + SUCCEEDED. + */ + DeploymentStatus?: DeploymentStatus; + /** + * May contain additional feedback on the status of an API deployment. + */ + DeploymentStatusMessage?: __string; + /** + * The description for the deployment. + */ + Description?: StringWithLengthBetween0And1024; + } + export interface CreateDomainNameRequest { + /** + * The domain name. + */ + DomainName: StringWithLengthBetween1And512; + /** + * The domain name configurations. + */ + DomainNameConfigurations?: DomainNameConfigurations; + } + export interface CreateDomainNameResponse { + /** + * The API mapping selection expression. + */ + ApiMappingSelectionExpression?: SelectionExpression; + /** + * The name of the DomainName resource. + */ + DomainName?: StringWithLengthBetween1And512; + /** + * The domain name configurations. + */ + DomainNameConfigurations?: DomainNameConfigurations; + } + export interface CreateIntegrationRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The connection ID. + */ + ConnectionId?: StringWithLengthBetween1And1024; + /** + * The type of the network connection to the integration endpoint. Currently the only + valid value is INTERNET, for connections through the public routable + internet. + */ + ConnectionType?: ConnectionType; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * Specifies the credentials required for the integration, if any. For AWS + integrations, three options are available. To specify an IAM Role for API Gateway to + assume, use the role's Amazon Resource Name (ARN). To require that the caller's + identity be passed through from the request, specify the string + arn:aws:iam::*:user/*. To use resource-based permissions on supported + AWS services, specify null. + */ + CredentialsArn?: Arn; + /** + * The description of the integration. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Specifies the integration's HTTP method type. + */ + IntegrationMethod?: StringWithLengthBetween1And64; + /** + * The integration type of an integration. One of the following: + AWS: for integrating the route or 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. + AWS_PROXY: for integrating the route or method request with the Lambda + function-invoking action with the client request passed through as-is. This + integration is also referred to as Lambda proxy integration. + HTTP: for integrating the route or method request with an HTTP + endpoint. This + integration is also referred to as HTTP custom integration. + HTTP_PROXY: for integrating route or method request with an HTTP + endpoint, with the client + request passed through as-is. This is also referred to as HTTP proxy + integration. + MOCK: for integrating the route or method request with API Gateway as a + "loopback" endpoint without invoking any backend. + */ + IntegrationType: IntegrationType; + /** + * For a Lambda proxy integration, this is the URI of the Lambda function. + */ + IntegrationUri?: UriWithLengthBetween1And2048; + /** + * 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 requestTemplates property on the + Integration resource. There are three valid values: + WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and + NEVER. + WHEN_NO_MATCH passes the request body for unmapped content types through + to the integration backend without transformation. + NEVER rejects unmapped content types with an HTTP 415 Unsupported + Media Type response. + WHEN_NO_TEMPLATES 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 HTTP 415 + Unsupported Media Type response. + */ + PassthroughBehavior?: PassthroughBehavior; + /** + * A key-value map specifying request parameters that are passed from the method + request to the backend. The key is an integration request parameter name and the + associated value is a method request parameter value or static value that must be + enclosed within single quotes and pre-encoded as required by the backend. The method + request parameter value must match the pattern of + method.request.{location}.{name} + , where + {location} + is querystring, path, or header; and + {name} + must be a valid and unique method request parameter name. + */ + RequestParameters?: IntegrationParameters; + /** + * Represents a map of Velocity templates that are applied on the request payload + based on the value of the Content-Type header sent by the client. The content type + value is the key in this map, and the template (as a String) is the value. + */ + RequestTemplates?: TemplateMap; + /** + * The template selection expression for the integration. + */ + TemplateSelectionExpression?: SelectionExpression; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + milliseconds or 29 seconds. + */ + TimeoutInMillis?: IntegerWithLengthBetween50And29000; + } + export interface CreateIntegrationResponse { + /** + * The connection ID. + */ + ConnectionId?: StringWithLengthBetween1And1024; + /** + * The type of the network connection to the integration endpoint. Currently the only + valid value is INTERNET, for connections through the public routable + internet. + */ + ConnectionType?: ConnectionType; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * Specifies the credentials required for the integration, if any. For AWS + integrations, three options are available. To specify an IAM Role for API Gateway to + assume, use the role's Amazon Resource Name (ARN). To require that the caller's + identity be passed through from the request, specify the string + arn:aws:iam::*:user/*. To use resource-based permissions on supported + AWS services, specify null. + */ + CredentialsArn?: Arn; + /** + * Represents the description of an integration. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Represents the identifier of an integration. + */ + IntegrationId?: Id; + /** + * Specifies the integration's HTTP method type. + */ + IntegrationMethod?: StringWithLengthBetween1And64; + /** + * The integration response selection expression for the integration. See Integration Response Selection Expressions. + */ + IntegrationResponseSelectionExpression?: SelectionExpression; + /** + * The integration type of an integration. One of the following: + AWS: for integrating the route or 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. + AWS_PROXY: for integrating the route or method request with the Lambda + function-invoking action with the client request passed through as-is. This + integration is also referred to as Lambda proxy integration. + HTTP: for integrating the route or method request with an HTTP + endpoint. This + integration is also referred to as the HTTP custom integration. + HTTP_PROXY: for integrating route or method request with an HTTP + endpoint, with the client + request passed through as-is. This is also referred to as HTTP proxy + integration. + MOCK: for integrating the route or method request with API Gateway as a + "loopback" endpoint without invoking any backend. + */ + IntegrationType?: IntegrationType; + /** + * For a Lambda proxy integration, this is the URI of the Lambda function. + */ + IntegrationUri?: UriWithLengthBetween1And2048; + /** + * 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 requestTemplates property on the + Integration resource. There are three valid values: + WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and + NEVER. + WHEN_NO_MATCH passes the request body for unmapped content types through + to the integration backend without transformation. + NEVER rejects unmapped content types with an HTTP 415 Unsupported + Media Type response. + WHEN_NO_TEMPLATES 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 HTTP 415 + Unsupported Media Type response. + */ + PassthroughBehavior?: PassthroughBehavior; + /** + * A key-value map specifying request parameters that are passed from the method + request to the backend. The key is an integration request parameter name and the + associated value is a method request parameter value or static value that must be + enclosed within single quotes and pre-encoded as required by the backend. The method + request parameter value must match the pattern of + method.request.{location}.{name} + , where + {location} + is querystring, path, or header; and + {name} + must be a valid and unique method request parameter name. + */ + RequestParameters?: IntegrationParameters; + /** + * Represents a map of Velocity templates that are applied on the request payload + based on the value of the Content-Type header sent by the client. The content type + value is the key in this map, and the template (as a String) is the value. + */ + RequestTemplates?: TemplateMap; + /** + * The template selection expression for the integration. + */ + TemplateSelectionExpression?: SelectionExpression; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + milliseconds or 29 seconds. + */ + TimeoutInMillis?: IntegerWithLengthBetween50And29000; + } + export interface CreateIntegrationResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * The integration ID. + */ + IntegrationId: __string; + /** + * The integration response key. + */ + IntegrationResponseKey: SelectionKey; + /** + * A key-value map specifying response parameters that are passed to the method + response from the backend. The key is a method response header parameter name and the + mapped value is an integration response header value, a static value enclosed within + a pair of single quotes, or a JSON expression from the integration response body. The + mapping key must match the pattern of method.response.header.{name}, + where {name} is a valid and unique header name. The mapped non-static + value must match the pattern of integration.response.header.{name} or + integration.response.body.{JSON-expression}, where + {name} is a valid and unique response header name and + {JSON-expression} is a valid JSON expression without the $ + prefix. + */ + ResponseParameters?: IntegrationParameters; + /** + * The collection of response templates for the integration response as a + string-to-string map of key-value pairs. Response templates are represented as a + key/value map, with a content-type as the key and a template as the value. + */ + ResponseTemplates?: TemplateMap; + /** + * The template selection expression for the integration response. + */ + TemplateSelectionExpression?: SelectionExpression; + } + export interface CreateIntegrationResponseResponse { + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * The integration response ID. + */ + IntegrationResponseId?: Id; + /** + * The integration response key. + */ + IntegrationResponseKey?: SelectionKey; + /** + * A key-value map specifying response parameters that are passed to the method + response from the backend. The key is a method response header parameter name and the + mapped value is an integration response header value, a static value enclosed within + a pair of single quotes, or a JSON expression from the integration response body. The + mapping key must match the pattern of method.response.header.{name}, where name is a + valid and unique header name. The mapped non-static value must match the pattern of + integration.response.header.{name} or integration.response.body.{JSON-expression}, + where name is a valid and unique response header name and JSON-expression is a valid + JSON expression without the $ prefix. + */ + ResponseParameters?: IntegrationParameters; + /** + * The collection of response templates for the integration response as a + string-to-string map of key-value pairs. Response templates are represented as a + key/value map, with a content-type as the key and a template as the value. + */ + ResponseTemplates?: TemplateMap; + /** + * The template selection expressions for the integration response. + */ + TemplateSelectionExpression?: SelectionExpression; + } + export interface CreateModelRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The content-type for the model, for example, "application/json". + */ + ContentType?: StringWithLengthBetween1And256; + /** + * The description of the model. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The name of the model. Must be alphanumeric. + */ + Name: StringWithLengthBetween1And128; + /** + * The schema for the model. For application/json models, this should be JSON schema + draft 4 model. + */ + Schema: StringWithLengthBetween0And32K; + } + export interface CreateModelResponse { + /** + * The content-type for the model, for example, "application/json". + */ + ContentType?: StringWithLengthBetween1And256; + /** + * The description of the model. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The model identifier. + */ + ModelId?: Id; + /** + * The name of the model. Must be alphanumeric. + */ + Name?: StringWithLengthBetween1And128; + /** + * The schema for the model. For application/json models, this should be JSON schema + draft 4 model. + */ + Schema?: StringWithLengthBetween0And32K; + } + export interface CreateRouteRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * Specifies whether an API key is required for the route. + */ + ApiKeyRequired?: __boolean; + /** + * The authorization scopes supported by this + route. + */ + AuthorizationScopes?: AuthorizationScopes; + /** + * The authorization type for the route. Valid values are NONE for open + access, AWS_IAM for using AWS IAM permissions, and CUSTOM + for using a Lambda + authorizer. + */ + AuthorizationType?: AuthorizationType; + /** + * The identifier of the Authorizer resource to be associated with this + route, if the authorizationType is CUSTOM + . The authorizer identifier is generated by API Gateway + when you created the authorizer. + */ + AuthorizerId?: Id; + /** + * The model selection expression for the route. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The operation name for the route. + */ + OperationName?: StringWithLengthBetween1And64; + /** + * The request models for the route. + */ + RequestModels?: RouteModels; + /** + * The request parameters for the route. + */ + RequestParameters?: RouteParameters; + /** + * The route key for the route. + */ + RouteKey: SelectionKey; + /** + * The route response selection expression for the route. + */ + RouteResponseSelectionExpression?: SelectionExpression; + /** + * The target for the route. + */ + Target?: StringWithLengthBetween1And128; + } + export interface CreateRouteResponse { + /** + * Specifies whether an API key is required for this route. + */ + ApiKeyRequired?: __boolean; + /** + * A list of authorization scopes configured on a route. The scopes are used with a + COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization + works by matching the route scopes against the scopes parsed from the access token in + the incoming request. The method invocation is authorized if any route scope matches + a claimed scope in the access token. Otherwise, the invocation is not authorized. + When the route scope is configured, the client must provide an access token instead + of an identity token for authorization purposes. + */ + AuthorizationScopes?: AuthorizationScopes; + /** + * The authorization type for the route. Valid values are NONE for open + access, AWS_IAM for using AWS IAM permissions, and CUSTOM + for using a Lambda + authorizer + */ + AuthorizationType?: AuthorizationType; + /** + * The identifier of the Authorizer resource to be associated with this + route, if the authorizationType is CUSTOM + . The authorizer identifier is generated by API Gateway + when you created the authorizer. + */ + AuthorizerId?: Id; + /** + * The model selection expression for the route. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The operation name for the route. + */ + OperationName?: StringWithLengthBetween1And64; + /** + * The request models for the route. + */ + RequestModels?: RouteModels; + /** + * The request parameters for the route. + */ + RequestParameters?: RouteParameters; + /** + * The route ID. + */ + RouteId?: Id; + /** + * The route key for the route. + */ + RouteKey?: SelectionKey; + /** + * The route response selection expression for the route. + */ + RouteResponseSelectionExpression?: SelectionExpression; + /** + * The target for the route. + */ + Target?: StringWithLengthBetween1And128; + } + export interface CreateRouteResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The model selection expression for the route response. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The response models for the route response. + */ + ResponseModels?: RouteModels; + /** + * The route response parameters. + */ + ResponseParameters?: RouteParameters; + /** + * The route ID. + */ + RouteId: __string; + /** + * The route response key. + */ + RouteResponseKey: SelectionKey; + } + export interface CreateRouteResponseResponse { + /** + * Represents the model selection expression of a route response. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * Represents the response models of a route response. + */ + ResponseModels?: RouteModels; + /** + * Represents the response parameters of a route response. + */ + ResponseParameters?: RouteParameters; + /** + * Represents the identifier of a route response. + */ + RouteResponseId?: Id; + /** + * Represents the route response key of a route response. + */ + RouteResponseKey?: SelectionKey; + } + export interface CreateStageRequest { + /** + * Settings for logging access in this stage. + */ + AccessLogSettings?: AccessLogSettings; + /** + * The API identifier. + */ + ApiId: __string; + /** + * The identifier of a client certificate for a Stage. + */ + ClientCertificateId?: Id; + /** + * The default route settings for the stage. + */ + DefaultRouteSettings?: RouteSettings; + /** + * The deployment identifier of the API stage. + */ + DeploymentId?: Id; + /** + * The description for the API stage. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Route settings for the stage. + */ + RouteSettings?: RouteSettingsMap; + /** + * The name of the stage. + */ + StageName: StringWithLengthBetween1And128; + /** + * A map that defines the stage variables for a Stage. Variable names + can have alphanumeric and underscore characters, and the values must match + [A-Za-z0-9-._~:/?#&=,]+. + */ + StageVariables?: StageVariablesMap; + } + export interface CreateStageResponse { + /** + * Settings for logging access in this stage. + */ + AccessLogSettings?: AccessLogSettings; + /** + * The identifier of a client certificate for a Stage. + */ + ClientCertificateId?: Id; + /** + * The timestamp when the stage was created. + */ + CreatedDate?: __timestampIso8601; + /** + * Default route settings for the stage. + */ + DefaultRouteSettings?: RouteSettings; + /** + * The identifier of the Deployment that the Stage is + associated with. + */ + DeploymentId?: Id; + /** + * The description of the stage. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The timestamp when the stage was last updated. + */ + LastUpdatedDate?: __timestampIso8601; + /** + * Route settings for the stage. + */ + RouteSettings?: RouteSettingsMap; + /** + * The name of the stage. + */ + StageName?: StringWithLengthBetween1And128; + /** + * A map that defines the stage variables for a stage resource. Variable names can + have alphanumeric and underscore characters, and the values must match + [A-Za-z0-9-._~:/?#&=,]+. + */ + StageVariables?: StageVariablesMap; + } + export interface DeleteApiMappingRequest { + /** + * The API mapping identifier. + */ + ApiMappingId: __string; + /** + * The domain name. + */ + DomainName: __string; + } + export interface DeleteApiRequest { + /** + * The API identifier. + */ + ApiId: __string; + } + export interface DeleteAuthorizerRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The authorizer identifier. + */ + AuthorizerId: __string; + } + export interface DeleteDeploymentRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The deployment ID. + */ + DeploymentId: __string; + } + export interface DeleteDomainNameRequest { + /** + * The domain name. + */ + DomainName: __string; + } + export interface DeleteIntegrationRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The integration ID. + */ + IntegrationId: __string; + } + export interface DeleteIntegrationResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The integration ID. + */ + IntegrationId: __string; + /** + * The integration response ID. + */ + IntegrationResponseId: __string; + } + export interface DeleteModelRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The model ID. + */ + ModelId: __string; + } + export interface DeleteRouteRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The route ID. + */ + RouteId: __string; + } + export interface DeleteRouteResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The route ID. + */ + RouteId: __string; + /** + * The route response ID. + */ + RouteResponseId: __string; + } + export interface DeleteStageRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The stage name. + */ + StageName: __string; + } + export interface Deployment { + /** + * The date and time when the Deployment resource was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The identifier for the deployment. + */ + DeploymentId?: Id; + /** + * The status of the deployment: PENDING, FAILED, or + SUCCEEDED. + */ + DeploymentStatus?: DeploymentStatus; + /** + * May contain additional feedback on the status of an API deployment. + */ + DeploymentStatusMessage?: __string; + /** + * The description for the deployment. + */ + Description?: StringWithLengthBetween0And1024; + } + export type DeploymentStatus = "PENDING"|"FAILED"|"DEPLOYED"|string; + export interface DomainName { + /** + * The API mapping selection expression. + */ + ApiMappingSelectionExpression?: SelectionExpression; + /** + * The name of the DomainName resource. + */ + DomainName: StringWithLengthBetween1And512; + /** + * The domain name configurations. + */ + DomainNameConfigurations?: DomainNameConfigurations; + } + export interface DomainNameConfiguration { + /** + * A domain name for the WebSocket API. + */ + ApiGatewayDomainName?: __string; + /** + * An AWS-managed certificate that will be used by the edge-optimized endpoint for + this domain name. AWS Certificate Manager is the only supported source. + */ + CertificateArn?: Arn; + /** + * The user-friendly name of the certificate that will be used by the edge-optimized + endpoint for this domain name. + */ + CertificateName?: StringWithLengthBetween1And128; + /** + * The timestamp when the certificate that was used by edge-optimized endpoint for + this domain name was uploaded. + */ + CertificateUploadDate?: __timestampIso8601; + /** + * The endpoint type. + */ + EndpointType?: EndpointType; + /** + * The Amazon Route 53 Hosted Zone ID of the endpoint. + */ + HostedZoneId?: __string; + } + export type DomainNameConfigurations = DomainNameConfiguration[]; + export type EndpointType = "REGIONAL"|"EDGE"|string; + export interface GetApiMappingRequest { + /** + * The API mapping identifier. + */ + ApiMappingId: __string; + /** + * The domain name. + */ + DomainName: __string; + } + export interface GetApiMappingResponse { + /** + * The API identifier. + */ + ApiId?: Id; + /** + * The API mapping identifier. + */ + ApiMappingId?: Id; + /** + * The API mapping key. + */ + ApiMappingKey?: SelectionKey; + /** + * The API stage. + */ + Stage?: StringWithLengthBetween1And128; + } + export interface GetApiMappingsRequest { + /** + * The domain name. + */ + DomainName: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetApiMappingsResponse { + /** + * The elements from this collection. + */ + Items?: __listOfApiMapping; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetApiRequest { + /** + * The API identifier. + */ + ApiId: __string; + } + export interface GetApiResponse { + /** + * The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + stage name is typically appended to this URI to form a complete path to a deployed + API stage. + */ + ApiEndpoint?: __string; + /** + * The API ID. + */ + ApiId?: Id; + /** + * An API key selection expression. See API Key Selection Expressions. + */ + ApiKeySelectionExpression?: SelectionExpression; + /** + * The timestamp when the API was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The description of the API. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Avoid validating models when creating a deployment. + */ + DisableSchemaValidation?: __boolean; + /** + * The name of the API. + */ + Name?: StringWithLengthBetween1And128; + /** + * The API protocol: Currently only WEBSOCKET is supported. + */ + ProtocolType?: ProtocolType; + /** + * The route selection expression for the API. + */ + RouteSelectionExpression?: SelectionExpression; + /** + * A version identifier for the API. + */ + Version?: StringWithLengthBetween1And64; + /** + * The warning messages reported when failonwarnings is turned on during + API import. + */ + Warnings?: __listOf__string; + } + export interface GetApisRequest { + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetApisResponse { + /** + * The elements from this collection. + */ + Items?: __listOfApi; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetAuthorizerRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The authorizer identifier. + */ + AuthorizerId: __string; + } + export interface GetAuthorizerResponse { + /** + * 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. + */ + AuthorizerCredentialsArn?: Arn; + /** + * The authorizer identifier. + */ + AuthorizerId?: Id; + /** + * The time to live (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. + */ + AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600; + /** + * The authorizer type. Currently the only valid value is REQUEST, for a + Lambda function using incoming request parameters. + */ + AuthorizerType?: AuthorizerType; + /** + * The authorizer's Uniform Resource Identifier (URI). + ForREQUEST authorizers, this must be a + well-formed Lambda function URI, for example, + 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. + In general, the URI has this form: + arn:aws:apigateway:{region}:lambda:path/{service_api} + , where {region} is the same as the region hosting the Lambda + function, path indicates that the remaining substring in the URI should be treated as + the path to the resource, including the initial /. For Lambda functions, + this is usually of the form + /2015-03-31/functions/[FunctionARN]/invocations. + */ + AuthorizerUri?: UriWithLengthBetween1And2048; + /** + * The identity source for which authorization is requested.For the REQUEST 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 Auth + header and a Name query string parameters are defined as identity + sources, this value is method.request.header.Auth, + method.request.querystring.Name. These parameters will be used to + derive the authorization caching key and to perform runtime validation of the + REQUEST 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. + */ + IdentitySource?: IdentitySourceList; + /** + * The + validation expression does not apply to the REQUEST authorizer. + */ + IdentityValidationExpression?: StringWithLengthBetween0And1024; + /** + * The name of the authorizer. + */ + Name?: StringWithLengthBetween1And128; + /** + * For + REQUEST authorizer, this is not + defined. + */ + ProviderArns?: ProviderArnList; + } + export interface GetAuthorizersRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetAuthorizersResponse { + /** + * The elements from this collection. + */ + Items?: __listOfAuthorizer; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetDeploymentRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The deployment ID. + */ + DeploymentId: __string; + } + export interface GetDeploymentResponse { + /** + * The date and time when the Deployment resource was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The identifier for the deployment. + */ + DeploymentId?: Id; + /** + * The status of the deployment: PENDING, FAILED, or + SUCCEEDED. + */ + DeploymentStatus?: DeploymentStatus; + /** + * May contain additional feedback on the status of an API deployment. + */ + DeploymentStatusMessage?: __string; + /** + * The description for the deployment. + */ + Description?: StringWithLengthBetween0And1024; + } + export interface GetDeploymentsRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetDeploymentsResponse { + /** + * The elements from this collection. + */ + Items?: __listOfDeployment; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetDomainNameRequest { + /** + * The domain name. + */ + DomainName: __string; + } + export interface GetDomainNameResponse { + /** + * The API mapping selection expression. + */ + ApiMappingSelectionExpression?: SelectionExpression; + /** + * The name of the DomainName resource. + */ + DomainName?: StringWithLengthBetween1And512; + /** + * The domain name configurations. + */ + DomainNameConfigurations?: DomainNameConfigurations; + } + export interface GetDomainNamesRequest { + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetDomainNamesResponse { + /** + * The elements from this collection. + */ + Items?: __listOfDomainName; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetIntegrationRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The integration ID. + */ + IntegrationId: __string; + } + export interface GetIntegrationResponse { + /** + * The connection ID. + */ + ConnectionId?: StringWithLengthBetween1And1024; + /** + * The type of the network connection to the integration endpoint. Currently the only + valid value is INTERNET, for connections through the public routable + internet. + */ + ConnectionType?: ConnectionType; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * Specifies the credentials required for the integration, if any. For AWS + integrations, three options are available. To specify an IAM Role for API Gateway to + assume, use the role's Amazon Resource Name (ARN). To require that the caller's + identity be passed through from the request, specify the string + arn:aws:iam::*:user/*. To use resource-based permissions on supported + AWS services, specify null. + */ + CredentialsArn?: Arn; + /** + * Represents the description of an integration. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Represents the identifier of an integration. + */ + IntegrationId?: Id; + /** + * Specifies the integration's HTTP method type. + */ + IntegrationMethod?: StringWithLengthBetween1And64; + /** + * The integration response selection expression for the integration. See Integration Response Selection Expressions. + */ + IntegrationResponseSelectionExpression?: SelectionExpression; + /** + * The integration type of an integration. One of the following: + AWS: for integrating the route or 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. + AWS_PROXY: for integrating the route or method request with the Lambda + function-invoking action with the client request passed through as-is. This + integration is also referred to as Lambda proxy integration. + HTTP: for integrating the route or method request with an HTTP + endpoint. This + integration is also referred to as the HTTP custom integration. + HTTP_PROXY: for integrating route or method request with an HTTP + endpoint, with the client + request passed through as-is. This is also referred to as HTTP proxy + integration. + MOCK: for integrating the route or method request with API Gateway as a + "loopback" endpoint without invoking any backend. + */ + IntegrationType?: IntegrationType; + /** + * For a Lambda proxy integration, this is the URI of the Lambda function. + */ + IntegrationUri?: UriWithLengthBetween1And2048; + /** + * 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 requestTemplates property on the + Integration resource. There are three valid values: + WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and + NEVER. + WHEN_NO_MATCH passes the request body for unmapped content types through + to the integration backend without transformation. + NEVER rejects unmapped content types with an HTTP 415 Unsupported + Media Type response. + WHEN_NO_TEMPLATES 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 HTTP 415 + Unsupported Media Type response. + */ + PassthroughBehavior?: PassthroughBehavior; + /** + * A key-value map specifying request parameters that are passed from the method + request to the backend. The key is an integration request parameter name and the + associated value is a method request parameter value or static value that must be + enclosed within single quotes and pre-encoded as required by the backend. The method + request parameter value must match the pattern of + method.request.{location}.{name} + , where + {location} + is querystring, path, or header; and + {name} + must be a valid and unique method request parameter name. + */ + RequestParameters?: IntegrationParameters; + /** + * Represents a map of Velocity templates that are applied on the request payload + based on the value of the Content-Type header sent by the client. The content type + value is the key in this map, and the template (as a String) is the value. + */ + RequestTemplates?: TemplateMap; + /** + * The template selection expression for the integration. + */ + TemplateSelectionExpression?: SelectionExpression; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + milliseconds or 29 seconds. + */ + TimeoutInMillis?: IntegerWithLengthBetween50And29000; + } + export interface GetIntegrationResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The integration ID. + */ + IntegrationId: __string; + /** + * The integration response ID. + */ + IntegrationResponseId: __string; + } + export interface GetIntegrationResponseResponse { + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * The integration response ID. + */ + IntegrationResponseId?: Id; + /** + * The integration response key. + */ + IntegrationResponseKey?: SelectionKey; + /** + * A key-value map specifying response parameters that are passed to the method + response from the backend. The key is a method response header parameter name and the + mapped value is an integration response header value, a static value enclosed within + a pair of single quotes, or a JSON expression from the integration response body. The + mapping key must match the pattern of method.response.header.{name}, where name is a + valid and unique header name. The mapped non-static value must match the pattern of + integration.response.header.{name} or integration.response.body.{JSON-expression}, + where name is a valid and unique response header name and JSON-expression is a valid + JSON expression without the $ prefix. + */ + ResponseParameters?: IntegrationParameters; + /** + * The collection of response templates for the integration response as a + string-to-string map of key-value pairs. Response templates are represented as a + key/value map, with a content-type as the key and a template as the value. + */ + ResponseTemplates?: TemplateMap; + /** + * The template selection expressions for the integration response. + */ + TemplateSelectionExpression?: SelectionExpression; + } + export interface GetIntegrationResponsesRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The integration ID. + */ + IntegrationId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetIntegrationResponsesResponse { + /** + * The elements from this collection. + */ + Items?: __listOfIntegrationResponse; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetIntegrationsRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetIntegrationsResponse { + /** + * The elements from this collection. + */ + Items?: __listOfIntegration; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetModelRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The model ID. + */ + ModelId: __string; + } + export interface GetModelResponse { + /** + * The content-type for the model, for example, "application/json". + */ + ContentType?: StringWithLengthBetween1And256; + /** + * The description of the model. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The model identifier. + */ + ModelId?: Id; + /** + * The name of the model. Must be alphanumeric. + */ + Name?: StringWithLengthBetween1And128; + /** + * The schema for the model. For application/json models, this should be JSON schema + draft 4 model. + */ + Schema?: StringWithLengthBetween0And32K; + } + export interface GetModelTemplateRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The model ID. + */ + ModelId: __string; + } + export interface GetModelTemplateResponse { + /** + * The template value. + */ + Value?: __string; + } + export interface GetModelsRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetModelsResponse { + /** + * The elements from this collection. + */ + Items?: __listOfModel; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetRouteRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The route ID. + */ + RouteId: __string; + } + export interface GetRouteResponse { + /** + * Specifies whether an API key is required for this route. + */ + ApiKeyRequired?: __boolean; + /** + * A list of authorization scopes configured on a route. The scopes are used with a + COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization + works by matching the route scopes against the scopes parsed from the access token in + the incoming request. The method invocation is authorized if any route scope matches + a claimed scope in the access token. Otherwise, the invocation is not authorized. + When the route scope is configured, the client must provide an access token instead + of an identity token for authorization purposes. + */ + AuthorizationScopes?: AuthorizationScopes; + /** + * The authorization type for the route. Valid values are NONE for open + access, AWS_IAM for using AWS IAM permissions, and CUSTOM + for using a Lambda + authorizer + */ + AuthorizationType?: AuthorizationType; + /** + * The identifier of the Authorizer resource to be associated with this + route, if the authorizationType is CUSTOM + . The authorizer identifier is generated by API Gateway + when you created the authorizer. + */ + AuthorizerId?: Id; + /** + * The model selection expression for the route. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The operation name for the route. + */ + OperationName?: StringWithLengthBetween1And64; + /** + * The request models for the route. + */ + RequestModels?: RouteModels; + /** + * The request parameters for the route. + */ + RequestParameters?: RouteParameters; + /** + * The route ID. + */ + RouteId?: Id; + /** + * The route key for the route. + */ + RouteKey?: SelectionKey; + /** + * The route response selection expression for the route. + */ + RouteResponseSelectionExpression?: SelectionExpression; + /** + * The target for the route. + */ + Target?: StringWithLengthBetween1And128; + } + export interface GetRouteResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The route ID. + */ + RouteId: __string; + /** + * The route response ID. + */ + RouteResponseId: __string; + } + export interface GetRouteResponseResponse { + /** + * Represents the model selection expression of a route response. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * Represents the response models of a route response. + */ + ResponseModels?: RouteModels; + /** + * Represents the response parameters of a route response. + */ + ResponseParameters?: RouteParameters; + /** + * Represents the identifier of a route response. + */ + RouteResponseId?: Id; + /** + * Represents the route response key of a route response. + */ + RouteResponseKey?: SelectionKey; + } + export interface GetRouteResponsesRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + /** + * The route ID. + */ + RouteId: __string; + } + export interface GetRouteResponsesResponse { + /** + * The elements from this collection. + */ + Items?: __listOfRouteResponse; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetRoutesRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetRoutesResponse { + /** + * The elements from this collection. + */ + Items?: __listOfRoute; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export interface GetStageRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The stage name. + */ + StageName: __string; + } + export interface GetStageResponse { + /** + * Settings for logging access in this stage. + */ + AccessLogSettings?: AccessLogSettings; + /** + * The identifier of a client certificate for a Stage. + */ + ClientCertificateId?: Id; + /** + * The timestamp when the stage was created. + */ + CreatedDate?: __timestampIso8601; + /** + * Default route settings for the stage. + */ + DefaultRouteSettings?: RouteSettings; + /** + * The identifier of the Deployment that the Stage is + associated with. + */ + DeploymentId?: Id; + /** + * The description of the stage. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The timestamp when the stage was last updated. + */ + LastUpdatedDate?: __timestampIso8601; + /** + * Route settings for the stage. + */ + RouteSettings?: RouteSettingsMap; + /** + * The name of the stage. + */ + StageName?: StringWithLengthBetween1And128; + /** + * A map that defines the stage variables for a stage resource. Variable names can + have alphanumeric and underscore characters, and the values must match + [A-Za-z0-9-._~:/?#&=,]+. + */ + StageVariables?: StageVariablesMap; + } + export interface GetStagesRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The maximum number of elements to be returned for this resource. + */ + MaxResults?: __string; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: __string; + } + export interface GetStagesResponse { + /** + * The elements from this collection. + */ + Items?: __listOfStage; + /** + * The next page of elements from this collection. Not valid for the last element of + the collection. + */ + NextToken?: NextToken; + } + export type Id = string; + export type IdentitySourceList = __string[]; + export type IntegerWithLengthBetween0And3600 = number; + export type IntegerWithLengthBetween50And29000 = number; + export interface Integration { + /** + * The connection ID. + */ + ConnectionId?: StringWithLengthBetween1And1024; + /** + * The type of the network connection to the integration endpoint. Currently the only + valid value is INTERNET, for connections through the public routable + internet. + */ + ConnectionType?: ConnectionType; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * Specifies the credentials required for the integration, if any. For AWS + integrations, three options are available. To specify an IAM Role for API Gateway to + assume, use the role's Amazon Resource Name (ARN). To require that the caller's + identity be passed through from the request, specify the string + arn:aws:iam::*:user/*. To use resource-based permissions on supported + AWS services, specify null. + */ + CredentialsArn?: Arn; + /** + * Represents the description of an integration. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Represents the identifier of an integration. + */ + IntegrationId?: Id; + /** + * Specifies the integration's HTTP method type. + */ + IntegrationMethod?: StringWithLengthBetween1And64; + /** + * The integration response selection expression for the integration. See Integration Response Selection Expressions. + */ + IntegrationResponseSelectionExpression?: SelectionExpression; + /** + * The integration type of an integration. One of the following: + AWS: for integrating the route or 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. + AWS_PROXY: for integrating the route or method request with the Lambda + function-invoking action with the client request passed through as-is. This + integration is also referred to as Lambda proxy integration. + HTTP: for integrating the route or method request with an HTTP + endpoint. This + integration is also referred to as the HTTP custom integration. + HTTP_PROXY: for integrating route or method request with an HTTP + endpoint, with the client + request passed through as-is. This is also referred to as HTTP proxy + integration. + MOCK: for integrating the route or method request with API Gateway as a + "loopback" endpoint without invoking any backend. + */ + IntegrationType?: IntegrationType; + /** + * For a Lambda proxy integration, this is the URI of the Lambda function. + */ + IntegrationUri?: UriWithLengthBetween1And2048; + /** + * 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 requestTemplates property on the + Integration resource. There are three valid values: + WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and + NEVER. + WHEN_NO_MATCH passes the request body for unmapped content types through + to the integration backend without transformation. + NEVER rejects unmapped content types with an HTTP 415 Unsupported + Media Type response. + WHEN_NO_TEMPLATES 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 HTTP 415 + Unsupported Media Type response. + */ + PassthroughBehavior?: PassthroughBehavior; + /** + * A key-value map specifying request parameters that are passed from the method + request to the backend. The key is an integration request parameter name and the + associated value is a method request parameter value or static value that must be + enclosed within single quotes and pre-encoded as required by the backend. The method + request parameter value must match the pattern of + method.request.{location}.{name} + , where + {location} + is querystring, path, or header; and + {name} + must be a valid and unique method request parameter name. + */ + RequestParameters?: IntegrationParameters; + /** + * Represents a map of Velocity templates that are applied on the request payload + based on the value of the Content-Type header sent by the client. The content type + value is the key in this map, and the template (as a String) is the value. + */ + RequestTemplates?: TemplateMap; + /** + * The template selection expression for the integration. + */ + TemplateSelectionExpression?: SelectionExpression; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + milliseconds or 29 seconds. + */ + TimeoutInMillis?: IntegerWithLengthBetween50And29000; + } + export type IntegrationParameters = {[key: string]: StringWithLengthBetween1And512}; + export interface IntegrationResponse { + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * The integration response ID. + */ + IntegrationResponseId?: Id; + /** + * The integration response key. + */ + IntegrationResponseKey: SelectionKey; + /** + * A key-value map specifying response parameters that are passed to the method + response from the backend. The key is a method response header parameter name and the + mapped value is an integration response header value, a static value enclosed within + a pair of single quotes, or a JSON expression from the integration response body. The + mapping key must match the pattern of method.response.header.{name}, where name is a + valid and unique header name. The mapped non-static value must match the pattern of + integration.response.header.{name} or integration.response.body.{JSON-expression}, + where name is a valid and unique response header name and JSON-expression is a valid + JSON expression without the $ prefix. + */ + ResponseParameters?: IntegrationParameters; + /** + * The collection of response templates for the integration response as a + string-to-string map of key-value pairs. Response templates are represented as a + key/value map, with a content-type as the key and a template as the value. + */ + ResponseTemplates?: TemplateMap; + /** + * The template selection expressions for the integration response. + */ + TemplateSelectionExpression?: SelectionExpression; + } + export type IntegrationType = "AWS"|"HTTP"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY"|string; + export type LoggingLevel = "ERROR"|"INFO"|"false"|string; + export interface Model { + /** + * The content-type for the model, for example, "application/json". + */ + ContentType?: StringWithLengthBetween1And256; + /** + * The description of the model. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The model identifier. + */ + ModelId?: Id; + /** + * The name of the model. Must be alphanumeric. + */ + Name: StringWithLengthBetween1And128; + /** + * The schema for the model. For application/json models, this should be JSON schema + draft 4 model. + */ + Schema?: StringWithLengthBetween0And32K; + } + export type NextToken = string; + export interface ParameterConstraints { + /** + * Whether or not the parameter is required. + */ + Required?: __boolean; + } + export type PassthroughBehavior = "WHEN_NO_MATCH"|"NEVER"|"WHEN_NO_TEMPLATES"|string; + export type ProtocolType = "WEBSOCKET"|string; + export type ProviderArnList = Arn[]; + export interface Route { + /** + * Specifies whether an API key is required for this route. + */ + ApiKeyRequired?: __boolean; + /** + * A list of authorization scopes configured on a route. The scopes are used with a + COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization + works by matching the route scopes against the scopes parsed from the access token in + the incoming request. The method invocation is authorized if any route scope matches + a claimed scope in the access token. Otherwise, the invocation is not authorized. + When the route scope is configured, the client must provide an access token instead + of an identity token for authorization purposes. + */ + AuthorizationScopes?: AuthorizationScopes; + /** + * The authorization type for the route. Valid values are NONE for open + access, AWS_IAM for using AWS IAM permissions, and CUSTOM + for using a Lambda + authorizer + */ + AuthorizationType?: AuthorizationType; + /** + * The identifier of the Authorizer resource to be associated with this + route, if the authorizationType is CUSTOM + . The authorizer identifier is generated by API Gateway + when you created the authorizer. + */ + AuthorizerId?: Id; + /** + * The model selection expression for the route. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The operation name for the route. + */ + OperationName?: StringWithLengthBetween1And64; + /** + * The request models for the route. + */ + RequestModels?: RouteModels; + /** + * The request parameters for the route. + */ + RequestParameters?: RouteParameters; + /** + * The route ID. + */ + RouteId?: Id; + /** + * The route key for the route. + */ + RouteKey: SelectionKey; + /** + * The route response selection expression for the route. + */ + RouteResponseSelectionExpression?: SelectionExpression; + /** + * The target for the route. + */ + Target?: StringWithLengthBetween1And128; + } + export type RouteModels = {[key: string]: StringWithLengthBetween1And128}; + export type RouteParameters = {[key: string]: ParameterConstraints}; + export interface RouteResponse { + /** + * Represents the model selection expression of a route response. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * Represents the response models of a route response. + */ + ResponseModels?: RouteModels; + /** + * Represents the response parameters of a route response. + */ + ResponseParameters?: RouteParameters; + /** + * Represents the identifier of a route response. + */ + RouteResponseId?: Id; + /** + * Represents the route response key of a route response. + */ + RouteResponseKey: SelectionKey; + } + export interface RouteSettings { + /** + * Specifies whether (true) or not (false) data trace + logging is enabled for this route. This property affects the log entries pushed to + Amazon CloudWatch Logs. + */ + DataTraceEnabled?: __boolean; + /** + * Specifies whether detailed metrics are enabled. + */ + DetailedMetricsEnabled?: __boolean; + /** + * Specifies the logging level for this route: DEBUG, INFO, + or WARN. This property affects the log entries pushed to Amazon + CloudWatch Logs. + */ + LoggingLevel?: LoggingLevel; + /** + * Specifies the throttling burst limit. + */ + ThrottlingBurstLimit?: __integer; + /** + * Specifies the throttling rate limit. + */ + ThrottlingRateLimit?: __double; + } + export type RouteSettingsMap = {[key: string]: RouteSettings}; + export type SelectionExpression = string; + export type SelectionKey = string; + export interface Stage { + /** + * Settings for logging access in this stage. + */ + AccessLogSettings?: AccessLogSettings; + /** + * The identifier of a client certificate for a Stage. + */ + ClientCertificateId?: Id; + /** + * The timestamp when the stage was created. + */ + CreatedDate?: __timestampIso8601; + /** + * Default route settings for the stage. + */ + DefaultRouteSettings?: RouteSettings; + /** + * The identifier of the Deployment that the Stage is + associated with. + */ + DeploymentId?: Id; + /** + * The description of the stage. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The timestamp when the stage was last updated. + */ + LastUpdatedDate?: __timestampIso8601; + /** + * Route settings for the stage. + */ + RouteSettings?: RouteSettingsMap; + /** + * The name of the stage. + */ + StageName: StringWithLengthBetween1And128; + /** + * A map that defines the stage variables for a stage resource. Variable names can + have alphanumeric and underscore characters, and the values must match + [A-Za-z0-9-._~:/?#&=,]+. + */ + StageVariables?: StageVariablesMap; + } + export type StageVariablesMap = {[key: string]: StringWithLengthBetween0And2048}; + export type StringWithLengthBetween0And1024 = string; + export type StringWithLengthBetween0And2048 = string; + export type StringWithLengthBetween0And32K = string; + export type StringWithLengthBetween1And1024 = string; + export type StringWithLengthBetween1And128 = string; + export type StringWithLengthBetween1And256 = string; + export type StringWithLengthBetween1And512 = string; + export type StringWithLengthBetween1And64 = string; + export type TemplateMap = {[key: string]: StringWithLengthBetween0And32K}; + export interface UpdateApiMappingRequest { + /** + * The API identifier. + */ + ApiId: Id; + /** + * The API mapping identifier. + */ + ApiMappingId: __string; + /** + * The API mapping key. + */ + ApiMappingKey?: SelectionKey; + /** + * The domain name. + */ + DomainName: __string; + /** + * The API stage. + */ + Stage?: StringWithLengthBetween1And128; + } + export interface UpdateApiMappingResponse { + /** + * The API identifier. + */ + ApiId?: Id; + /** + * The API mapping identifier. + */ + ApiMappingId?: Id; + /** + * The API mapping key. + */ + ApiMappingKey?: SelectionKey; + /** + * The API stage. + */ + Stage?: StringWithLengthBetween1And128; + } + export interface UpdateApiRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * An API key selection expression. See API Key Selection Expressions. + */ + ApiKeySelectionExpression?: SelectionExpression; + /** + * The description of the API. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Avoid validating models when creating a deployment. + */ + DisableSchemaValidation?: __boolean; + /** + * The name of the API. + */ + Name?: StringWithLengthBetween1And128; + /** + * The route selection expression for the API. + */ + RouteSelectionExpression?: SelectionExpression; + /** + * A version identifier for the API. + */ + Version?: StringWithLengthBetween1And64; + } + export interface UpdateApiResponse { + /** + * The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The + stage name is typically appended to this URI to form a complete path to a deployed + API stage. + */ + ApiEndpoint?: __string; + /** + * The API ID. + */ + ApiId?: Id; + /** + * An API key selection expression. See API Key Selection Expressions. + */ + ApiKeySelectionExpression?: SelectionExpression; + /** + * The timestamp when the API was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The description of the API. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Avoid validating models when creating a deployment. + */ + DisableSchemaValidation?: __boolean; + /** + * The name of the API. + */ + Name?: StringWithLengthBetween1And128; + /** + * The API protocol: Currently only WEBSOCKET is supported. + */ + ProtocolType?: ProtocolType; + /** + * The route selection expression for the API. + */ + RouteSelectionExpression?: SelectionExpression; + /** + * A version identifier for the API. + */ + Version?: StringWithLengthBetween1And64; + /** + * The warning messages reported when failonwarnings is turned on during + API import. + */ + Warnings?: __listOf__string; + } + export interface UpdateAuthorizerRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * 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. + */ + AuthorizerCredentialsArn?: Arn; + /** + * The authorizer identifier. + */ + AuthorizerId: __string; + /** + * The time to live (TTL), in seconds, of cached authorizer results. If it is zero, + authorization caching is disabled. If it is greater than zero, 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. + */ + AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600; + /** + * The authorizer type. Currently the only valid value is REQUEST, for a + Lambda function using incoming request parameters. + */ + AuthorizerType?: AuthorizerType; + /** + * The authorizer's Uniform Resource Identifier (URI). For + REQUEST authorizers, this must be a + well-formed Lambda function URI, for example, + 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. + In general, the URI has this form: + arn:aws:apigateway:{region}:lambda:path/{service_api} + , where {region} is the same as the region hosting the Lambda + function, path indicates that the remaining substring in the URI should be treated as + the path to the resource, including the initial /. For Lambda functions, + this is usually of the form + /2015-03-31/functions/[FunctionARN]/invocations. + */ + AuthorizerUri?: UriWithLengthBetween1And2048; + /** + * The identity source for which authorization is requested.For the REQUEST 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 Auth header, a + Name query string parameter are defined as identity sources, this value is + $method.request.header.Auth, $method.request.querystring.Name. These + parameters will be used to derive the authorization caching key and to perform + runtime validation of the REQUEST 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. + */ + IdentitySource?: IdentitySourceList; + /** + * The + validation expression does not apply to the REQUEST authorizer. + */ + IdentityValidationExpression?: StringWithLengthBetween0And1024; + /** + * The name of the authorizer. + */ + Name?: StringWithLengthBetween1And128; + /** + * For + REQUEST authorizer, this is not + defined. + */ + ProviderArns?: ProviderArnList; + } + export interface UpdateAuthorizerResponse { + /** + * 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. + */ + AuthorizerCredentialsArn?: Arn; + /** + * The authorizer identifier. + */ + AuthorizerId?: Id; + /** + * The time to live (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. + */ + AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600; + /** + * The authorizer type. Currently the only valid value is REQUEST, for a + Lambda function using incoming request parameters. + */ + AuthorizerType?: AuthorizerType; + /** + * The authorizer's Uniform Resource Identifier (URI). + ForREQUEST authorizers, this must be a + well-formed Lambda function URI, for example, + 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. + In general, the URI has this form: + arn:aws:apigateway:{region}:lambda:path/{service_api} + , where {region} is the same as the region hosting the Lambda + function, path indicates that the remaining substring in the URI should be treated as + the path to the resource, including the initial /. For Lambda functions, + this is usually of the form + /2015-03-31/functions/[FunctionARN]/invocations. + */ + AuthorizerUri?: UriWithLengthBetween1And2048; + /** + * The identity source for which authorization is requested.For the REQUEST 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 Auth + header and a Name query string parameters are defined as identity + sources, this value is method.request.header.Auth, + method.request.querystring.Name. These parameters will be used to + derive the authorization caching key and to perform runtime validation of the + REQUEST 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. + */ + IdentitySource?: IdentitySourceList; + /** + * The + validation expression does not apply to the REQUEST authorizer. + */ + IdentityValidationExpression?: StringWithLengthBetween0And1024; + /** + * The name of the authorizer. + */ + Name?: StringWithLengthBetween1And128; + /** + * For + REQUEST authorizer, this is not + defined. + */ + ProviderArns?: ProviderArnList; + } + export interface UpdateDeploymentRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The deployment ID. + */ + DeploymentId: __string; + /** + * The description for the deployment resource. + */ + Description?: StringWithLengthBetween0And1024; + } + export interface UpdateDeploymentResponse { + /** + * The date and time when the Deployment resource was created. + */ + CreatedDate?: __timestampIso8601; + /** + * The identifier for the deployment. + */ + DeploymentId?: Id; + /** + * The status of the deployment: PENDING, FAILED, or + SUCCEEDED. + */ + DeploymentStatus?: DeploymentStatus; + /** + * May contain additional feedback on the status of an API deployment. + */ + DeploymentStatusMessage?: __string; + /** + * The description for the deployment. + */ + Description?: StringWithLengthBetween0And1024; + } + export interface UpdateDomainNameRequest { + /** + * The domain name. + */ + DomainName: __string; + /** + * The domain name configurations. + */ + DomainNameConfigurations?: DomainNameConfigurations; + } + export interface UpdateDomainNameResponse { + /** + * The API mapping selection expression. + */ + ApiMappingSelectionExpression?: SelectionExpression; + /** + * The name of the DomainName resource. + */ + DomainName?: StringWithLengthBetween1And512; + /** + * The domain name configurations. + */ + DomainNameConfigurations?: DomainNameConfigurations; + } + export interface UpdateIntegrationRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The connection ID. + */ + ConnectionId?: StringWithLengthBetween1And1024; + /** + * The type of the network connection to the integration endpoint. Currently the only + valid value is INTERNET, for connections through the public routable + internet. + */ + ConnectionType?: ConnectionType; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * Specifies the credentials required for the integration, if any. For AWS + integrations, three options are available. To specify an IAM Role for API Gateway to + assume, use the role's Amazon Resource Name (ARN). To require that the caller's + identity be passed through from the request, specify the string + arn:aws:iam::*:user/*. To use resource-based permissions on supported + AWS services, specify null. + */ + CredentialsArn?: Arn; + /** + * The description of the integration + */ + Description?: StringWithLengthBetween0And1024; + /** + * The integration ID. + */ + IntegrationId: __string; + /** + * Specifies the integration's HTTP method type. + */ + IntegrationMethod?: StringWithLengthBetween1And64; + /** + * The integration type of an integration. One of the following: + AWS: for integrating the route or 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. + AWS_PROXY: for integrating the route or method request with the Lambda + function-invoking action with the client request passed through as-is. This + integration is also referred to as Lambda proxy integration. + HTTP: for integrating the route or method request with an HTTP + endpoint. This + integration is also referred to as the HTTP custom integration. + HTTP_PROXY: for integrating route or method request with an HTTP + endpoint, with the client + request passed through as-is. This is also referred to as HTTP proxy + integration. + MOCK: for integrating the route or method request with API Gateway as a + "loopback" endpoint without invoking any backend. + */ + IntegrationType?: IntegrationType; + /** + * For a Lambda proxy integration, this is the URI of the Lambda function. + */ + IntegrationUri?: UriWithLengthBetween1And2048; + /** + * 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 requestTemplates property on the + Integration resource. There are three valid values: + WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and + NEVER. + WHEN_NO_MATCH passes the request body for unmapped content types through + to the integration backend without transformation. + NEVER rejects unmapped content types with an HTTP 415 Unsupported + Media Type response. + WHEN_NO_TEMPLATES 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 HTTP 415 + Unsupported Media Type response. + */ + PassthroughBehavior?: PassthroughBehavior; + /** + * A key-value map specifying request parameters that are passed from the method + request to the backend. The key is an integration request parameter name and the + associated value is a method request parameter value or static value that must be + enclosed within single quotes and pre-encoded as required by the backend. The method + request parameter value must match the pattern of + method.request.{location}.{name} + , where + {location} + is querystring, path, or header; and + {name} + must be a valid and unique method request parameter name. + */ + RequestParameters?: IntegrationParameters; + /** + * Represents a map of Velocity templates that are applied on the request payload + based on the value of the Content-Type header sent by the client. The content type + value is the key in this map, and the template (as a String) is the value. + */ + RequestTemplates?: TemplateMap; + /** + * The template selection expression for the integration. + */ + TemplateSelectionExpression?: SelectionExpression; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + milliseconds or 29 seconds. + */ + TimeoutInMillis?: IntegerWithLengthBetween50And29000; + } + export interface UpdateIntegrationResponse { + /** + * The connection ID. + */ + ConnectionId?: StringWithLengthBetween1And1024; + /** + * The type of the network connection to the integration endpoint. Currently the only + valid value is INTERNET, for connections through the public routable + internet. + */ + ConnectionType?: ConnectionType; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * Specifies the credentials required for the integration, if any. For AWS + integrations, three options are available. To specify an IAM Role for API Gateway to + assume, use the role's Amazon Resource Name (ARN). To require that the caller's + identity be passed through from the request, specify the string + arn:aws:iam::*:user/*. To use resource-based permissions on supported + AWS services, specify null. + */ + CredentialsArn?: Arn; + /** + * Represents the description of an integration. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Represents the identifier of an integration. + */ + IntegrationId?: Id; + /** + * Specifies the integration's HTTP method type. + */ + IntegrationMethod?: StringWithLengthBetween1And64; + /** + * The integration response selection expression for the integration. See Integration Response Selection Expressions. + */ + IntegrationResponseSelectionExpression?: SelectionExpression; + /** + * The integration type of an integration. One of the following: + AWS: for integrating the route or 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. + AWS_PROXY: for integrating the route or method request with the Lambda + function-invoking action with the client request passed through as-is. This + integration is also referred to as Lambda proxy integration. + HTTP: for integrating the route or method request with an HTTP + endpoint. This + integration is also referred to as the HTTP custom integration. + HTTP_PROXY: for integrating route or method request with an HTTP + endpoint, with the client + request passed through as-is. This is also referred to as HTTP proxy + integration. + MOCK: for integrating the route or method request with API Gateway as a + "loopback" endpoint without invoking any backend. + */ + IntegrationType?: IntegrationType; + /** + * For a Lambda proxy integration, this is the URI of the Lambda function. + */ + IntegrationUri?: UriWithLengthBetween1And2048; + /** + * 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 requestTemplates property on the + Integration resource. There are three valid values: + WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and + NEVER. + WHEN_NO_MATCH passes the request body for unmapped content types through + to the integration backend without transformation. + NEVER rejects unmapped content types with an HTTP 415 Unsupported + Media Type response. + WHEN_NO_TEMPLATES 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 HTTP 415 + Unsupported Media Type response. + */ + PassthroughBehavior?: PassthroughBehavior; + /** + * A key-value map specifying request parameters that are passed from the method + request to the backend. The key is an integration request parameter name and the + associated value is a method request parameter value or static value that must be + enclosed within single quotes and pre-encoded as required by the backend. The method + request parameter value must match the pattern of + method.request.{location}.{name} + , where + {location} + is querystring, path, or header; and + {name} + must be a valid and unique method request parameter name. + */ + RequestParameters?: IntegrationParameters; + /** + * Represents a map of Velocity templates that are applied on the request payload + based on the value of the Content-Type header sent by the client. The content type + value is the key in this map, and the template (as a String) is the value. + */ + RequestTemplates?: TemplateMap; + /** + * The template selection expression for the integration. + */ + TemplateSelectionExpression?: SelectionExpression; + /** + * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 + milliseconds or 29 seconds. + */ + TimeoutInMillis?: IntegerWithLengthBetween50And29000; + } + export interface UpdateIntegrationResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * The integration ID. + */ + IntegrationId: __string; + /** + * The integration response ID. + */ + IntegrationResponseId: __string; + /** + * The integration response key. + */ + IntegrationResponseKey?: SelectionKey; + /** + * A key-value map specifying response parameters that are passed to the method + response from the backend. The key is a method response header parameter name and the + mapped value is an integration response header value, a static value enclosed within + a pair of single quotes, or a JSON expression from the integration response body. The + mapping key must match the pattern of + method.response.header.{name} + , where name is a valid and unique header name. The mapped non-static value + must match the pattern of + integration.response.header.{name} + or + integration.response.body.{JSON-expression} + , where + {name} + is a valid and unique response header name and + {JSON-expression} + is a valid JSON expression without the $ prefix. + */ + ResponseParameters?: IntegrationParameters; + /** + * The collection of response templates for the integration response as a + string-to-string map of key-value pairs. Response templates are represented as a + key/value map, with a content-type as the key and a template as the value. + */ + ResponseTemplates?: TemplateMap; + /** + * The template selection expression for the integration response. + */ + TemplateSelectionExpression?: SelectionExpression; + } + export interface UpdateIntegrationResponseResponse { + /** + * Specifies how to handle response payload content type conversions. Supported + values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the + following behaviors: + CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded + string to the corresponding binary blob. + CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + Base64-encoded string.If this property is not defined, the response payload will be passed through from + the integration response to the route response or method response without + modification. + */ + ContentHandlingStrategy?: ContentHandlingStrategy; + /** + * The integration response ID. + */ + IntegrationResponseId?: Id; + /** + * The integration response key. + */ + IntegrationResponseKey?: SelectionKey; + /** + * A key-value map specifying response parameters that are passed to the method + response from the backend. The key is a method response header parameter name and the + mapped value is an integration response header value, a static value enclosed within + a pair of single quotes, or a JSON expression from the integration response body. The + mapping key must match the pattern of method.response.header.{name}, where name is a + valid and unique header name. The mapped non-static value must match the pattern of + integration.response.header.{name} or integration.response.body.{JSON-expression}, + where name is a valid and unique response header name and JSON-expression is a valid + JSON expression without the $ prefix. + */ + ResponseParameters?: IntegrationParameters; + /** + * The collection of response templates for the integration response as a + string-to-string map of key-value pairs. Response templates are represented as a + key/value map, with a content-type as the key and a template as the value. + */ + ResponseTemplates?: TemplateMap; + /** + * The template selection expressions for the integration response. + */ + TemplateSelectionExpression?: SelectionExpression; + } + export interface UpdateModelRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The content-type for the model, for example, "application/json". + */ + ContentType?: StringWithLengthBetween1And256; + /** + * The description of the model. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The model ID. + */ + ModelId: __string; + /** + * The name of the model. + */ + Name?: StringWithLengthBetween1And128; + /** + * The schema for the model. For application/json models, this should be JSON schema + draft 4 model. + */ + Schema?: StringWithLengthBetween0And32K; + } + export interface UpdateModelResponse { + /** + * The content-type for the model, for example, "application/json". + */ + ContentType?: StringWithLengthBetween1And256; + /** + * The description of the model. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The model identifier. + */ + ModelId?: Id; + /** + * The name of the model. Must be alphanumeric. + */ + Name?: StringWithLengthBetween1And128; + /** + * The schema for the model. For application/json models, this should be JSON schema + draft 4 model. + */ + Schema?: StringWithLengthBetween0And32K; + } + export interface UpdateRouteRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * Specifies whether an API key is required for the route. + */ + ApiKeyRequired?: __boolean; + /** + * The authorization scopes supported by this + route. + */ + AuthorizationScopes?: AuthorizationScopes; + /** + * The authorization type for the route. Valid values are NONE for open + access, AWS_IAM for using AWS IAM permissions, and CUSTOM + for using a Lambda + authorizer. + */ + AuthorizationType?: AuthorizationType; + /** + * The identifier of the Authorizer resource to be associated with this + route, if the authorizationType is CUSTOM + . The authorizer identifier is generated by API Gateway + when you created the authorizer. + */ + AuthorizerId?: Id; + /** + * The model selection expression for the route. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The operation name for the route. + */ + OperationName?: StringWithLengthBetween1And64; + /** + * The request models for the route. + */ + RequestModels?: RouteModels; + /** + * The request parameters for the route. + */ + RequestParameters?: RouteParameters; + /** + * The route ID. + */ + RouteId: __string; + /** + * The route key for the route. + */ + RouteKey?: SelectionKey; + /** + * The route response selection expression for the route. + */ + RouteResponseSelectionExpression?: SelectionExpression; + /** + * The target for the route. + */ + Target?: StringWithLengthBetween1And128; + } + export interface UpdateRouteResponse { + /** + * Specifies whether an API key is required for this route. + */ + ApiKeyRequired?: __boolean; + /** + * A list of authorization scopes configured on a route. The scopes are used with a + COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization + works by matching the route scopes against the scopes parsed from the access token in + the incoming request. The method invocation is authorized if any route scope matches + a claimed scope in the access token. Otherwise, the invocation is not authorized. + When the route scope is configured, the client must provide an access token instead + of an identity token for authorization purposes. + */ + AuthorizationScopes?: AuthorizationScopes; + /** + * The authorization type for the route. Valid values are NONE for open + access, AWS_IAM for using AWS IAM permissions, and CUSTOM + for using a Lambda + authorizer + */ + AuthorizationType?: AuthorizationType; + /** + * The identifier of the Authorizer resource to be associated with this + route, if the authorizationType is CUSTOM + . The authorizer identifier is generated by API Gateway + when you created the authorizer. + */ + AuthorizerId?: Id; + /** + * The model selection expression for the route. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The operation name for the route. + */ + OperationName?: StringWithLengthBetween1And64; + /** + * The request models for the route. + */ + RequestModels?: RouteModels; + /** + * The request parameters for the route. + */ + RequestParameters?: RouteParameters; + /** + * The route ID. + */ + RouteId?: Id; + /** + * The route key for the route. + */ + RouteKey?: SelectionKey; + /** + * The route response selection expression for the route. + */ + RouteResponseSelectionExpression?: SelectionExpression; + /** + * The target for the route. + */ + Target?: StringWithLengthBetween1And128; + } + export interface UpdateRouteResponseRequest { + /** + * The API identifier. + */ + ApiId: __string; + /** + * The model selection expression for the route response. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * The response models for the route response. + */ + ResponseModels?: RouteModels; + /** + * The route response parameters. + */ + ResponseParameters?: RouteParameters; + /** + * The route ID. + */ + RouteId: __string; + /** + * The route response ID. + */ + RouteResponseId: __string; + /** + * The route response key. + */ + RouteResponseKey?: SelectionKey; + } + export interface UpdateRouteResponseResponse { + /** + * Represents the model selection expression of a route response. + */ + ModelSelectionExpression?: SelectionExpression; + /** + * Represents the response models of a route response. + */ + ResponseModels?: RouteModels; + /** + * Represents the response parameters of a route response. + */ + ResponseParameters?: RouteParameters; + /** + * Represents the identifier of a route response. + */ + RouteResponseId?: Id; + /** + * Represents the route response key of a route response. + */ + RouteResponseKey?: SelectionKey; + } + export interface UpdateStageRequest { + /** + * Settings for logging access in this stage. + */ + AccessLogSettings?: AccessLogSettings; + /** + * The API identifier. + */ + ApiId: __string; + /** + * The identifier of a client certificate for a Stage. + */ + ClientCertificateId?: Id; + /** + * The default route settings for the stage. + */ + DefaultRouteSettings?: RouteSettings; + /** + * The deployment identifier for the API stage. + */ + DeploymentId?: Id; + /** + * The description for the API stage. + */ + Description?: StringWithLengthBetween0And1024; + /** + * Route settings for the stage. + */ + RouteSettings?: RouteSettingsMap; + /** + * The stage name. + */ + StageName: __string; + /** + * A map that defines the stage variables for a Stage. Variable names + can have alphanumeric and underscore characters, and the values must match + [A-Za-z0-9-._~:/?#&=,]+. + */ + StageVariables?: StageVariablesMap; + } + export interface UpdateStageResponse { + /** + * Settings for logging access in this stage. + */ + AccessLogSettings?: AccessLogSettings; + /** + * The identifier of a client certificate for a Stage. + */ + ClientCertificateId?: Id; + /** + * The timestamp when the stage was created. + */ + CreatedDate?: __timestampIso8601; + /** + * Default route settings for the stage. + */ + DefaultRouteSettings?: RouteSettings; + /** + * The identifier of the Deployment that the Stage is + associated with. + */ + DeploymentId?: Id; + /** + * The description of the stage. + */ + Description?: StringWithLengthBetween0And1024; + /** + * The timestamp when the stage was last updated. + */ + LastUpdatedDate?: __timestampIso8601; + /** + * Route settings for the stage. + */ + RouteSettings?: RouteSettingsMap; + /** + * The name of the stage. + */ + StageName?: StringWithLengthBetween1And128; + /** + * A map that defines the stage variables for a stage resource. Variable names can + have alphanumeric and underscore characters, and the values must match + [A-Za-z0-9-._~:/?#&=,]+. + */ + StageVariables?: StageVariablesMap; + } + export type UriWithLengthBetween1And2048 = string; + export type __boolean = boolean; + export type __double = number; + export type __integer = number; + export type __listOfApi = Api[]; + export type __listOfApiMapping = ApiMapping[]; + export type __listOfAuthorizer = Authorizer[]; + export type __listOfDeployment = Deployment[]; + export type __listOfDomainName = DomainName[]; + export type __listOfIntegration = Integration[]; + export type __listOfIntegrationResponse = IntegrationResponse[]; + export type __listOfModel = Model[]; + export type __listOfRoute = Route[]; + export type __listOfRouteResponse = RouteResponse[]; + export type __listOfStage = Stage[]; + export type __listOf__string = __string[]; + export type __string = string; + export type __timestampIso8601 = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-11-29"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ApiGatewayV2 client. + */ + export import Types = ApiGatewayV2; +} +export = ApiGatewayV2; diff --git a/node_modules/aws-sdk/clients/apigatewayv2.js b/node_modules/aws-sdk/clients/apigatewayv2.js new file mode 100644 index 0000000..7f19572 --- /dev/null +++ b/node_modules/aws-sdk/clients/apigatewayv2.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['apigatewayv2'] = {}; +AWS.ApiGatewayV2 = Service.defineService('apigatewayv2', ['2018-11-29']); +Object.defineProperty(apiLoader.services['apigatewayv2'], '2018-11-29', { + get: function get() { + var model = require('../apis/apigatewayv2-2018-11-29.min.json'); + model.paginators = require('../apis/apigatewayv2-2018-11-29.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ApiGatewayV2; diff --git a/node_modules/aws-sdk/clients/applicationautoscaling.d.ts b/node_modules/aws-sdk/clients/applicationautoscaling.d.ts new file mode 100644 index 0000000..79ffa8d --- /dev/null +++ b/node_modules/aws-sdk/clients/applicationautoscaling.d.ts @@ -0,0 +1,727 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ApplicationAutoScaling extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ApplicationAutoScaling.Types.ClientConfiguration) + config: Config & ApplicationAutoScaling.Types.ClientConfiguration; + /** + * Deletes the specified Application Auto Scaling scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action. To create a scaling policy or update an existing one, see PutScalingPolicy. + */ + deleteScalingPolicy(params: ApplicationAutoScaling.Types.DeleteScalingPolicyRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScalingPolicyResponse) => void): Request; + /** + * Deletes the specified Application Auto Scaling scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action. To create a scaling policy or update an existing one, see PutScalingPolicy. + */ + deleteScalingPolicy(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScalingPolicyResponse) => void): Request; + /** + * Deletes the specified Application Auto Scaling scheduled action. + */ + deleteScheduledAction(params: ApplicationAutoScaling.Types.DeleteScheduledActionRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScheduledActionResponse) => void): Request; + /** + * Deletes the specified Application Auto Scaling scheduled action. + */ + deleteScheduledAction(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScheduledActionResponse) => void): Request; + /** + * Deregisters a scalable target. Deregistering a scalable target deletes the scaling policies that are associated with it. To create a scalable target or update an existing one, see RegisterScalableTarget. + */ + deregisterScalableTarget(params: ApplicationAutoScaling.Types.DeregisterScalableTargetRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeregisterScalableTargetResponse) => void): Request; + /** + * Deregisters a scalable target. Deregistering a scalable target deletes the scaling policies that are associated with it. To create a scalable target or update an existing one, see RegisterScalableTarget. + */ + deregisterScalableTarget(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeregisterScalableTargetResponse) => void): Request; + /** + * Gets information about the scalable targets in the specified namespace. You can filter the results using the ResourceIds and ScalableDimension parameters. To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget. + */ + describeScalableTargets(params: ApplicationAutoScaling.Types.DescribeScalableTargetsRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalableTargetsResponse) => void): Request; + /** + * Gets information about the scalable targets in the specified namespace. You can filter the results using the ResourceIds and ScalableDimension parameters. To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget. + */ + describeScalableTargets(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalableTargetsResponse) => void): Request; + /** + * Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks. You can filter the results using the ResourceId and ScalableDimension parameters. Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy. + */ + describeScalingActivities(params: ApplicationAutoScaling.Types.DescribeScalingActivitiesRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse) => void): Request; + /** + * Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks. You can filter the results using the ResourceId and ScalableDimension parameters. Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy. + */ + describeScalingActivities(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse) => void): Request; + /** + * Describes the scaling policies for the specified service namespace. You can filter the results using the ResourceId, ScalableDimension, and PolicyNames parameters. To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. + */ + describeScalingPolicies(params: ApplicationAutoScaling.Types.DescribeScalingPoliciesRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse) => void): Request; + /** + * Describes the scaling policies for the specified service namespace. You can filter the results using the ResourceId, ScalableDimension, and PolicyNames parameters. To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. + */ + describeScalingPolicies(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse) => void): Request; + /** + * Describes the scheduled actions for the specified service namespace. You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters. To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction. + */ + describeScheduledActions(params: ApplicationAutoScaling.Types.DescribeScheduledActionsRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScheduledActionsResponse) => void): Request; + /** + * Describes the scheduled actions for the specified service namespace. You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters. To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction. + */ + describeScheduledActions(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScheduledActionsResponse) => void): Request; + /** + * Creates or updates a policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target using RegisterScalableTarget. To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request. You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale in and scale out. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. Learn more about how to work with scaling policies in the Application Auto Scaling User Guide. + */ + putScalingPolicy(params: ApplicationAutoScaling.Types.PutScalingPolicyRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request; + /** + * Creates or updates a policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target using RegisterScalableTarget. To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request. You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale in and scale out. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. Learn more about how to work with scaling policies in the Application Auto Scaling User Guide. + */ + putScalingPolicy(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request; + /** + * Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target using RegisterScalableTarget. To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request. You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction. Learn more about how to work with scheduled actions in the Application Auto Scaling User Guide. + */ + putScheduledAction(params: ApplicationAutoScaling.Types.PutScheduledActionRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScheduledActionResponse) => void): Request; + /** + * Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target using RegisterScalableTarget. To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request. You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction. Learn more about how to work with scheduled actions in the Application Auto Scaling User Guide. + */ + putScheduledAction(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScheduledActionResponse) => void): Request; + /** + * Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Each scalable target has a resource ID, scalable dimension, and namespace, as well as values for minimum and maximum capacity. After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it using DeregisterScalableTarget. + */ + registerScalableTarget(params: ApplicationAutoScaling.Types.RegisterScalableTargetRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request; + /** + * Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Each scalable target has a resource ID, scalable dimension, and namespace, as well as values for minimum and maximum capacity. After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it using DeregisterScalableTarget. + */ + registerScalableTarget(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request; +} +declare namespace ApplicationAutoScaling { + export type AdjustmentType = "ChangeInCapacity"|"PercentChangeInCapacity"|"ExactCapacity"|string; + export interface Alarm { + /** + * The name of the alarm. + */ + AlarmName: ResourceId; + /** + * The Amazon Resource Name (ARN) of the alarm. + */ + AlarmARN: ResourceId; + } + export type Alarms = Alarm[]; + export type Cooldown = number; + export interface CustomizedMetricSpecification { + /** + * The name of the metric. + */ + MetricName: MetricName; + /** + * The namespace of the metric. + */ + Namespace: MetricNamespace; + /** + * The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. + */ + Dimensions?: MetricDimensions; + /** + * The statistic of the metric. + */ + Statistic: MetricStatistic; + /** + * The unit of the metric. + */ + Unit?: MetricUnit; + } + export interface DeleteScalingPolicyRequest { + /** + * The name of the scaling policy. + */ + PolicyName: ResourceIdMaxLen1600; + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + } + export interface DeleteScalingPolicyResponse { + } + export interface DeleteScheduledActionRequest { + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The name of the scheduled action. + */ + ScheduledActionName: ResourceIdMaxLen1600; + /** + * The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + } + export interface DeleteScheduledActionResponse { + } + export interface DeregisterScalableTargetRequest { + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + } + export interface DeregisterScalableTargetResponse { + } + export interface DescribeScalableTargetsRequest { + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceIds?: ResourceIdsMaxLen1600; + /** + * The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension?: ScalableDimension; + /** + * The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. + */ + NextToken?: XmlString; + } + export interface DescribeScalableTargetsResponse { + /** + * The scalable targets that match the request parameters. + */ + ScalableTargets?: ScalableTargets; + /** + * The token required to get the next set of results. This value is null if there are no more results to return. + */ + NextToken?: XmlString; + } + export interface DescribeScalingActivitiesRequest { + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId?: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension?: ScalableDimension; + /** + * The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. + */ + NextToken?: XmlString; + } + export interface DescribeScalingActivitiesResponse { + /** + * A list of scaling activity objects. + */ + ScalingActivities?: ScalingActivities; + /** + * The token required to get the next set of results. This value is null if there are no more results to return. + */ + NextToken?: XmlString; + } + export interface DescribeScalingPoliciesRequest { + /** + * The names of the scaling policies to describe. + */ + PolicyNames?: ResourceIdsMaxLen1600; + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId?: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension?: ScalableDimension; + /** + * The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. + */ + NextToken?: XmlString; + } + export interface DescribeScalingPoliciesResponse { + /** + * Information about the scaling policies. + */ + ScalingPolicies?: ScalingPolicies; + /** + * The token required to get the next set of results. This value is null if there are no more results to return. + */ + NextToken?: XmlString; + } + export interface DescribeScheduledActionsRequest { + /** + * The names of the scheduled actions to describe. + */ + ScheduledActionNames?: ResourceIdsMaxLen1600; + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId?: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension?: ScalableDimension; + /** + * The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. + */ + NextToken?: XmlString; + } + export interface DescribeScheduledActionsResponse { + /** + * Information about the scheduled actions. + */ + ScheduledActions?: ScheduledActions; + /** + * The token required to get the next set of results. This value is null if there are no more results to return. + */ + NextToken?: XmlString; + } + export type DisableScaleIn = boolean; + export type MaxResults = number; + export type MetricAggregationType = "Average"|"Minimum"|"Maximum"|string; + export interface MetricDimension { + /** + * The name of the dimension. + */ + Name: MetricDimensionName; + /** + * The value of the dimension. + */ + Value: MetricDimensionValue; + } + export type MetricDimensionName = string; + export type MetricDimensionValue = string; + export type MetricDimensions = MetricDimension[]; + export type MetricName = string; + export type MetricNamespace = string; + export type MetricScale = number; + export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string; + export type MetricType = "DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|"SageMakerVariantInvocationsPerInstance"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|string; + export type MetricUnit = string; + export type MinAdjustmentMagnitude = number; + export type PolicyName = string; + export type PolicyType = "StepScaling"|"TargetTrackingScaling"|string; + export interface PredefinedMetricSpecification { + /** + * The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services. + */ + PredefinedMetricType: MetricType; + /** + * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot fleet request or ECS service. The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where: app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN. + */ + ResourceLabel?: ResourceLabel; + } + export interface PutScalingPolicyRequest { + /** + * The name of the scaling policy. + */ + PolicyName: PolicyName; + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + /** + * The policy type. This parameter is required if you are creating a scaling policy. For information on which services do not support StepScaling or TargetTrackingScaling, see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide. + */ + PolicyType?: PolicyType; + /** + * A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling. + */ + StepScalingPolicyConfiguration?: StepScalingPolicyConfiguration; + /** + * A target tracking scaling policy. Includes support for predefined or customized metrics. This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling. + */ + TargetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration; + } + export interface PutScalingPolicyResponse { + /** + * The Amazon Resource Name (ARN) of the resulting scaling policy. + */ + PolicyARN: ResourceIdMaxLen1600; + /** + * The CloudWatch alarms created for the target tracking scaling policy. + */ + Alarms?: Alarms; + } + export interface PutScheduledActionRequest { + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The schedule for this action. The following formats are supported: At expressions - "at(yyyy-mm-ddThh:mm:ss)" Rate expressions - "rate(value unit)" Cron expressions - "cron(fields)" At expressions are useful for one-time schedules. Specify the time, in UTC. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days. For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide. + */ + Schedule?: ResourceIdMaxLen1600; + /** + * The name of the scheduled action. + */ + ScheduledActionName: ScheduledActionName; + /** + * The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + /** + * The date and time for the scheduled action to start. + */ + StartTime?: TimestampType; + /** + * The date and time for the scheduled action to end. + */ + EndTime?: TimestampType; + /** + * The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. + */ + ScalableTargetAction?: ScalableTargetAction; + } + export interface PutScheduledActionResponse { + } + export interface RegisterScalableTargetRequest { + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + /** + * The minimum value to scale to in response to a scale-in event. This parameter is required to register a scalable target. + */ + MinCapacity?: ResourceCapacity; + /** + * The maximum value to scale to in response to a scale-out event. This parameter is required to register a scalable target. + */ + MaxCapacity?: ResourceCapacity; + /** + * Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling. For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. + */ + RoleARN?: ResourceIdMaxLen1600; + } + export interface RegisterScalableTargetResponse { + } + export type ResourceCapacity = number; + export type ResourceId = string; + export type ResourceIdMaxLen1600 = string; + export type ResourceIdsMaxLen1600 = ResourceIdMaxLen1600[]; + export type ResourceLabel = string; + export type ScalableDimension = "ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"elasticmapreduce:instancegroup:InstanceCount"|"appstream:fleet:DesiredCapacity"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|"rds:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredInstanceCount"|"custom-resource:ResourceType:Property"|string; + export interface ScalableTarget { + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + /** + * The minimum value to scale to in response to a scale-in event. + */ + MinCapacity: ResourceCapacity; + /** + * The maximum value to scale to in response to a scale-out event. + */ + MaxCapacity: ResourceCapacity; + /** + * The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. + */ + RoleARN: ResourceIdMaxLen1600; + /** + * The Unix timestamp for when the scalable target was created. + */ + CreationTime: TimestampType; + } + export interface ScalableTargetAction { + /** + * The minimum capacity. + */ + MinCapacity?: ResourceCapacity; + /** + * The maximum capacity. + */ + MaxCapacity?: ResourceCapacity; + } + export type ScalableTargets = ScalableTarget[]; + export type ScalingActivities = ScalingActivity[]; + export interface ScalingActivity { + /** + * The unique identifier of the scaling activity. + */ + ActivityId: ResourceId; + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + /** + * A simple description of what action the scaling activity intends to accomplish. + */ + Description: XmlString; + /** + * A simple description of what caused the scaling activity to happen. + */ + Cause: XmlString; + /** + * The Unix timestamp for when the scaling activity began. + */ + StartTime: TimestampType; + /** + * The Unix timestamp for when the scaling activity ended. + */ + EndTime?: TimestampType; + /** + * Indicates the status of the scaling activity. + */ + StatusCode: ScalingActivityStatusCode; + /** + * A simple message about the current status of the scaling activity. + */ + StatusMessage?: XmlString; + /** + * The details about the scaling activity. + */ + Details?: XmlString; + } + export type ScalingActivityStatusCode = "Pending"|"InProgress"|"Successful"|"Overridden"|"Unfulfilled"|"Failed"|string; + export type ScalingAdjustment = number; + export type ScalingPolicies = ScalingPolicy[]; + export interface ScalingPolicy { + /** + * The Amazon Resource Name (ARN) of the scaling policy. + */ + PolicyARN: ResourceIdMaxLen1600; + /** + * The name of the scaling policy. + */ + PolicyName: PolicyName; + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension: ScalableDimension; + /** + * The scaling policy type. + */ + PolicyType: PolicyType; + /** + * A step scaling policy. + */ + StepScalingPolicyConfiguration?: StepScalingPolicyConfiguration; + /** + * A target tracking scaling policy. + */ + TargetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration; + /** + * The CloudWatch alarms associated with the scaling policy. + */ + Alarms?: Alarms; + /** + * The Unix timestamp for when the scaling policy was created. + */ + CreationTime: TimestampType; + } + export interface ScheduledAction { + /** + * The name of the scheduled action. + */ + ScheduledActionName: ScheduledActionName; + /** + * The Amazon Resource Name (ARN) of the scheduled action. + */ + ScheduledActionARN: ResourceIdMaxLen1600; + /** + * The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. + */ + ServiceNamespace: ServiceNamespace; + /** + * The schedule for this action. The following formats are supported: At expressions - "at(yyyy-mm-ddThh:mm:ss)" Rate expressions - "rate(value unit)" Cron expressions - "cron(fields)" At expressions are useful for one-time schedules. Specify the time, in UTC. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days. For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide. + */ + Schedule: ResourceIdMaxLen1600; + /** + * The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. + */ + ScalableDimension?: ScalableDimension; + /** + * The date and time that the action is scheduled to begin. + */ + StartTime?: TimestampType; + /** + * The date and time that the action is scheduled to end. + */ + EndTime?: TimestampType; + /** + * The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. + */ + ScalableTargetAction?: ScalableTargetAction; + /** + * The date and time that the scheduled action was created. + */ + CreationTime: TimestampType; + } + export type ScheduledActionName = string; + export type ScheduledActions = ScheduledAction[]; + export type ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|string; + export interface StepAdjustment { + /** + * The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. + */ + MetricIntervalLowerBound?: MetricScale; + /** + * The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound. + */ + MetricIntervalUpperBound?: MetricScale; + /** + * The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension. + */ + ScalingAdjustment: ScalingAdjustment; + } + export type StepAdjustments = StepAdjustment[]; + export interface StepScalingPolicyConfiguration { + /** + * The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted. + */ + AdjustmentType?: AdjustmentType; + /** + * A set of adjustments that enable you to scale based on the size of the alarm breach. + */ + StepAdjustments?: StepAdjustments; + /** + * The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks. + */ + MinAdjustmentMagnitude?: MinAdjustmentMagnitude; + /** + * The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events. For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count. For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately. + */ + Cooldown?: Cooldown; + /** + * The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. + */ + MetricAggregationType?: MetricAggregationType; + } + export interface TargetTrackingScalingPolicyConfiguration { + /** + * The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). + */ + TargetValue: MetricScale; + /** + * A predefined metric. You can specify either a predefined metric or a customized metric. + */ + PredefinedMetricSpecification?: PredefinedMetricSpecification; + /** + * A customized metric. You can specify either a predefined metric or a customized metric. + */ + CustomizedMetricSpecification?: CustomizedMetricSpecification; + /** + * The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. + */ + ScaleOutCooldown?: Cooldown; + /** + * The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately. + */ + ScaleInCooldown?: Cooldown; + /** + * Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false. + */ + DisableScaleIn?: DisableScaleIn; + } + export type TimestampType = Date; + export type XmlString = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-02-06"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ApplicationAutoScaling client. + */ + export import Types = ApplicationAutoScaling; +} +export = ApplicationAutoScaling; diff --git a/node_modules/aws-sdk/clients/applicationautoscaling.js b/node_modules/aws-sdk/clients/applicationautoscaling.js new file mode 100644 index 0000000..4734e97 --- /dev/null +++ b/node_modules/aws-sdk/clients/applicationautoscaling.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['applicationautoscaling'] = {}; +AWS.ApplicationAutoScaling = Service.defineService('applicationautoscaling', ['2016-02-06']); +Object.defineProperty(apiLoader.services['applicationautoscaling'], '2016-02-06', { + get: function get() { + var model = require('../apis/application-autoscaling-2016-02-06.min.json'); + model.paginators = require('../apis/application-autoscaling-2016-02-06.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ApplicationAutoScaling; diff --git a/node_modules/aws-sdk/clients/appmesh.d.ts b/node_modules/aws-sdk/clients/appmesh.d.ts new file mode 100644 index 0000000..1eceefa --- /dev/null +++ b/node_modules/aws-sdk/clients/appmesh.d.ts @@ -0,0 +1,1572 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class AppMesh extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: AppMesh.Types.ClientConfiguration) + config: Config & AppMesh.Types.ClientConfiguration; + /** + * Creates a service mesh. A service mesh is a logical boundary for network traffic + between the services that reside within it. + After you create your service mesh, you can create virtual services, virtual nodes, + virtual routers, and routes to distribute traffic between the applications in your + mesh. + */ + createMesh(params: AppMesh.Types.CreateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request; + /** + * Creates a service mesh. A service mesh is a logical boundary for network traffic + between the services that reside within it. + After you create your service mesh, you can create virtual services, virtual nodes, + virtual routers, and routes to distribute traffic between the applications in your + mesh. + */ + createMesh(callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request; + /** + * Creates a route that is associated with a virtual router. + You can use the prefix parameter in your route specification for path-based + routing of requests. For example, if your virtual service name is + my-service.local and you want the route to match requests to + my-service.local/metrics, your prefix should be + /metrics. + If your route matches a request, you can distribute traffic to one or more target + virtual nodes with relative weighting. + */ + createRoute(params: AppMesh.Types.CreateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request; + /** + * Creates a route that is associated with a virtual router. + You can use the prefix parameter in your route specification for path-based + routing of requests. For example, if your virtual service name is + my-service.local and you want the route to match requests to + my-service.local/metrics, your prefix should be + /metrics. + If your route matches a request, you can distribute traffic to one or more target + virtual nodes with relative weighting. + */ + createRoute(callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request; + /** + * Creates a virtual node within a service mesh. + A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS + service or a Kubernetes deployment. When you create a virtual node, you must specify the + DNS service discovery hostname for your task group. + Any inbound traffic that your virtual node expects should be specified as a + listener. Any outbound traffic that your virtual node expects to reach + should be specified as a backend. + The response metadata for your new virtual node contains the arn that is + associated with the virtual node. Set this value (either the full ARN or the truncated + resource name: for example, mesh/default/virtualNode/simpleapp) as the + APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy + proxy container in your task definition or pod spec. This is then mapped to the + node.id and node.cluster Envoy parameters. + + If you require your Envoy stats or tracing to use a different name, you can override + the node.cluster value that is set by + APPMESH_VIRTUAL_NODE_NAME with the + APPMESH_VIRTUAL_NODE_CLUSTER environment variable. + + */ + createVirtualNode(params: AppMesh.Types.CreateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request; + /** + * Creates a virtual node within a service mesh. + A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS + service or a Kubernetes deployment. When you create a virtual node, you must specify the + DNS service discovery hostname for your task group. + Any inbound traffic that your virtual node expects should be specified as a + listener. Any outbound traffic that your virtual node expects to reach + should be specified as a backend. + The response metadata for your new virtual node contains the arn that is + associated with the virtual node. Set this value (either the full ARN or the truncated + resource name: for example, mesh/default/virtualNode/simpleapp) as the + APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy + proxy container in your task definition or pod spec. This is then mapped to the + node.id and node.cluster Envoy parameters. + + If you require your Envoy stats or tracing to use a different name, you can override + the node.cluster value that is set by + APPMESH_VIRTUAL_NODE_NAME with the + APPMESH_VIRTUAL_NODE_CLUSTER environment variable. + + */ + createVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request; + /** + * Creates a virtual router within a service mesh. + Any inbound traffic that your virtual router expects should be specified as a + listener. + Virtual routers handle traffic for one or more virtual services within your mesh. After + you create your virtual router, create and associate routes for your virtual router that + direct incoming requests to different virtual nodes. + */ + createVirtualRouter(params: AppMesh.Types.CreateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request; + /** + * Creates a virtual router within a service mesh. + Any inbound traffic that your virtual router expects should be specified as a + listener. + Virtual routers handle traffic for one or more virtual services within your mesh. After + you create your virtual router, create and associate routes for your virtual router that + direct incoming requests to different virtual nodes. + */ + createVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request; + /** + * Creates a virtual service within a service mesh. + A virtual service is an abstraction of a real service that is provided by a + virtual node directly or indirectly by means of a virtual router. Dependent services call + your virtual service by its virtualServiceName, and those requests are routed + to the virtual node or virtual router that is specified as the provider for the virtual + service. + */ + createVirtualService(params: AppMesh.Types.CreateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request; + /** + * Creates a virtual service within a service mesh. + A virtual service is an abstraction of a real service that is provided by a + virtual node directly or indirectly by means of a virtual router. Dependent services call + your virtual service by its virtualServiceName, and those requests are routed + to the virtual node or virtual router that is specified as the provider for the virtual + service. + */ + createVirtualService(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request; + /** + * Deletes an existing service mesh. + You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) + in the service mesh before you can delete the mesh itself. + */ + deleteMesh(params: AppMesh.Types.DeleteMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request; + /** + * Deletes an existing service mesh. + You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) + in the service mesh before you can delete the mesh itself. + */ + deleteMesh(callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request; + /** + * Deletes an existing route. + */ + deleteRoute(params: AppMesh.Types.DeleteRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request; + /** + * Deletes an existing route. + */ + deleteRoute(callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request; + /** + * Deletes an existing virtual node. + You must delete any virtual services that list a virtual node as a service provider + before you can delete the virtual node itself. + */ + deleteVirtualNode(params: AppMesh.Types.DeleteVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request; + /** + * Deletes an existing virtual node. + You must delete any virtual services that list a virtual node as a service provider + before you can delete the virtual node itself. + */ + deleteVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request; + /** + * Deletes an existing virtual router. + You must delete any routes associated with the virtual router before you can delete the + router itself. + */ + deleteVirtualRouter(params: AppMesh.Types.DeleteVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request; + /** + * Deletes an existing virtual router. + You must delete any routes associated with the virtual router before you can delete the + router itself. + */ + deleteVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request; + /** + * Deletes an existing virtual service. + */ + deleteVirtualService(params: AppMesh.Types.DeleteVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request; + /** + * Deletes an existing virtual service. + */ + deleteVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request; + /** + * Describes an existing service mesh. + */ + describeMesh(params: AppMesh.Types.DescribeMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request; + /** + * Describes an existing service mesh. + */ + describeMesh(callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request; + /** + * Describes an existing route. + */ + describeRoute(params: AppMesh.Types.DescribeRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request; + /** + * Describes an existing route. + */ + describeRoute(callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request; + /** + * Describes an existing virtual node. + */ + describeVirtualNode(params: AppMesh.Types.DescribeVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request; + /** + * Describes an existing virtual node. + */ + describeVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request; + /** + * Describes an existing virtual router. + */ + describeVirtualRouter(params: AppMesh.Types.DescribeVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request; + /** + * Describes an existing virtual router. + */ + describeVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request; + /** + * Describes an existing virtual service. + */ + describeVirtualService(params: AppMesh.Types.DescribeVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request; + /** + * Describes an existing virtual service. + */ + describeVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request; + /** + * Returns a list of existing service meshes. + */ + listMeshes(params: AppMesh.Types.ListMeshesInput, callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request; + /** + * Returns a list of existing service meshes. + */ + listMeshes(callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request; + /** + * Returns a list of existing routes in a service mesh. + */ + listRoutes(params: AppMesh.Types.ListRoutesInput, callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request; + /** + * Returns a list of existing routes in a service mesh. + */ + listRoutes(callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request; + /** + * List the tags for an App Mesh resource. + */ + listTagsForResource(params: AppMesh.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request; + /** + * List the tags for an App Mesh resource. + */ + listTagsForResource(callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request; + /** + * Returns a list of existing virtual nodes. + */ + listVirtualNodes(params: AppMesh.Types.ListVirtualNodesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request; + /** + * Returns a list of existing virtual nodes. + */ + listVirtualNodes(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request; + /** + * Returns a list of existing virtual routers in a service mesh. + */ + listVirtualRouters(params: AppMesh.Types.ListVirtualRoutersInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request; + /** + * Returns a list of existing virtual routers in a service mesh. + */ + listVirtualRouters(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request; + /** + * Returns a list of existing virtual services in a service mesh. + */ + listVirtualServices(params: AppMesh.Types.ListVirtualServicesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request; + /** + * Returns a list of existing virtual services in a service mesh. + */ + listVirtualServices(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request; + /** + * Associates the specified tags to a resource with the specified + resourceArn. If existing tags on a resource aren't specified in the + request parameters, they aren't changed. When a resource is deleted, the tags + associated with that resource are also deleted. + */ + tagResource(params: AppMesh.Types.TagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request; + /** + * Associates the specified tags to a resource with the specified + resourceArn. If existing tags on a resource aren't specified in the + request parameters, they aren't changed. When a resource is deleted, the tags + associated with that resource are also deleted. + */ + tagResource(callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request; + /** + * Deletes specified tags from a resource. + */ + untagResource(params: AppMesh.Types.UntagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request; + /** + * Deletes specified tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request; + /** + * Updates an existing service mesh. + */ + updateMesh(params: AppMesh.Types.UpdateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request; + /** + * Updates an existing service mesh. + */ + updateMesh(callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request; + /** + * Updates an existing route for a specified service mesh and virtual router. + */ + updateRoute(params: AppMesh.Types.UpdateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request; + /** + * Updates an existing route for a specified service mesh and virtual router. + */ + updateRoute(callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request; + /** + * Updates an existing virtual node in a specified service mesh. + */ + updateVirtualNode(params: AppMesh.Types.UpdateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request; + /** + * Updates an existing virtual node in a specified service mesh. + */ + updateVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request; + /** + * Updates an existing virtual router in a specified service mesh. + */ + updateVirtualRouter(params: AppMesh.Types.UpdateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request; + /** + * Updates an existing virtual router in a specified service mesh. + */ + updateVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request; + /** + * Updates an existing virtual service in a specified service mesh. + */ + updateVirtualService(params: AppMesh.Types.UpdateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request; + /** + * Updates an existing virtual service in a specified service mesh. + */ + updateVirtualService(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request; +} +declare namespace AppMesh { + export interface VirtualRouterListener { + portMapping: PortMapping; + } + export interface UpdateVirtualNodeInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh that the virtual node resides in. + */ + meshName: ResourceName; + /** + * The new virtual node specification to apply. This overwrites the existing data. + */ + spec: VirtualNodeSpec; + /** + * The name of the virtual node to update. + */ + virtualNodeName: ResourceName; + } + export interface DeleteMeshInput { + /** + * The name of the service mesh to delete. + */ + meshName: ResourceName; + } + export interface CreateVirtualServiceInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh to create the virtual service in. + */ + meshName: ResourceName; + /** + * The virtual service specification to apply. + */ + spec: VirtualServiceSpec; + /** + * Optional metadata that you can apply to the virtual service to assist with categorization and organization. + Each tag consists of a key and an optional value, both of which you define. + Tag keys can have a maximum character length of 128 characters, and tag values can have + a maximum length of 256 characters. + */ + tags?: TagList; + /** + * The name to use for the virtual service. + */ + virtualServiceName: ServiceName; + } + export type VirtualRouterStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string; + export interface UpdateVirtualRouterInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh that the virtual router resides in. + */ + meshName: ResourceName; + /** + * The new virtual router specification to apply. This overwrites the existing data. + */ + spec: VirtualRouterSpec; + /** + * The name of the virtual router to update. + */ + virtualRouterName: ResourceName; + } + export type TagKeyList = TagKey[]; + export interface ListTagsForResourceInput { + /** + * The maximum number of tag results returned by ListTagsForResource in + paginated output. When this parameter is used, ListTagsForResource returns only + limit results in a single page along with a nextToken + response element. You can see the remaining results of the initial request by sending + another ListTagsForResource request with the returned nextToken + value. This value can be between 1 and 100. If you don't use this + parameter, ListTagsForResource returns up to + 100 results and a nextToken value if applicable. + */ + limit?: TagsLimit; + /** + * The nextToken value returned from a previous paginated + ListTagsForResource request where limit was used and the + results exceeded the value of that parameter. Pagination continues from the end of the + previous results that returned the nextToken value. + */ + nextToken?: String; + /** + * The Amazon Resource Name (ARN) that identifies the resource to list the tags for. + */ + resourceArn: Arn; + } + export interface CreateVirtualNodeOutput { + /** + * The full description of your virtual node following the create call. + */ + virtualNode: VirtualNodeData; + } + export interface Logging { + /** + * The access log configuration for a virtual node. + */ + accessLog?: AccessLog; + } + export type Long = number; + export interface UpdateVirtualRouterOutput { + /** + * A full description of the virtual router that was updated. + */ + virtualRouter: VirtualRouterData; + } + export interface DescribeMeshOutput { + /** + * The full description of your service mesh. + */ + mesh: MeshData; + } + export interface DeleteVirtualRouterInput { + /** + * The name of the service mesh to delete the virtual router in. + */ + meshName: ResourceName; + /** + * The name of the virtual router to delete. + */ + virtualRouterName: ResourceName; + } + export interface ListVirtualRoutersOutput { + /** + * The nextToken value to include in a future ListVirtualRouters + request. When the results of a ListVirtualRouters request exceed + limit, you can use this value to retrieve the next page of + results. This value is null when there are no more results to + return. + */ + nextToken?: String; + /** + * The list of existing virtual routers for the specified service mesh. + */ + virtualRouters: VirtualRouterList; + } + export interface DescribeRouteInput { + /** + * The name of the service mesh that the route resides in. + */ + meshName: ResourceName; + /** + * The name of the route to describe. + */ + routeName: ResourceName; + /** + * The name of the virtual router that the route is associated with. + */ + virtualRouterName: ResourceName; + } + export interface DeleteRouteOutput { + /** + * The route that was deleted. + */ + route: RouteData; + } + export interface ResourceMetadata { + /** + * The full Amazon Resource Name (ARN) for the resource. + */ + arn: Arn; + /** + * The Unix epoch timestamp in seconds for when the resource was created. + */ + createdAt: Timestamp; + /** + * The Unix epoch timestamp in seconds for when the resource was last updated. + */ + lastUpdatedAt: Timestamp; + /** + * The unique identifier for the resource. + */ + uid: String; + /** + * The version of the resource. Resources are created at version 1, and this version is + incremented each time that they're updated. + */ + version: Long; + } + export type Listeners = Listener[]; + export type Backends = Backend[]; + export type PortProtocol = "http"|"tcp"|string; + export interface UpdateVirtualNodeOutput { + /** + * A full description of the virtual node that was updated. + */ + virtualNode: VirtualNodeData; + } + export interface ListRoutesOutput { + /** + * The nextToken value to include in a future ListRoutes + request. When the results of a ListRoutes request exceed + limit, you can use this value to retrieve the next page of + results. This value is null when there are no more results to + return. + */ + nextToken?: String; + /** + * The list of existing routes for the specified service mesh and virtual router. + */ + routes: RouteList; + } + export interface VirtualServiceBackend { + /** + * The name of the virtual service that is acting as a virtual node backend. + */ + virtualServiceName: ServiceName; + } + export type VirtualNodeStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string; + export type ServiceName = string; + export interface UpdateVirtualServiceInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh that the virtual service resides in. + */ + meshName: ResourceName; + /** + * The new virtual service specification to apply. This overwrites the existing + data. + */ + spec: VirtualServiceSpec; + /** + * The name of the virtual service to update. + */ + virtualServiceName: ServiceName; + } + export type HealthCheckThreshold = number; + export interface UpdateRouteOutput { + /** + * A full description of the route that was updated. + */ + route: RouteData; + } + export type PercentInt = number; + export type TagValue = string; + export interface HttpRouteAction { + /** + * The targets that traffic is routed to when a request matches the route. You can specify + one or more targets and their relative weights to distribute traffic with. + */ + weightedTargets: WeightedTargets; + } + export interface ListRoutesInput { + /** + * The maximum number of results returned by ListRoutes in paginated output. + When you use this parameter, ListRoutes returns only limit + results in a single page along with a nextToken response element. You can see the + remaining results of the initial request by sending another + ListRoutes request with the returned nextToken value. This + value can be between 1 and 100. If you don't use this parameter, + ListRoutes returns up to 100 results and a + nextToken value if applicable. + */ + limit?: ListRoutesLimit; + /** + * The name of the service mesh to list routes in. + */ + meshName: ResourceName; + /** + * The nextToken value returned from a previous paginated + ListRoutes request where limit was used and the + results exceeded the value of that parameter. Pagination continues from the end of the + previous results that returned the nextToken value. + */ + nextToken?: String; + /** + * The name of the virtual router to list routes in. + */ + virtualRouterName: ResourceName; + } + export interface HealthCheckPolicy { + /** + * The number of consecutive successful health checks that must occur before declaring + listener healthy. + */ + healthyThreshold: HealthCheckThreshold; + /** + * The time period in milliseconds between each health check execution. + */ + intervalMillis: HealthCheckIntervalMillis; + /** + * The destination path for the health check request. This is required only if the + specified protocol is HTTP. If the protocol is TCP, this parameter is ignored. + */ + path?: String; + /** + * The destination port for the health check request. This port must match the port defined + in the PortMapping for the listener. + */ + port?: PortNumber; + /** + * The protocol for the health check request. + */ + protocol: PortProtocol; + /** + * The amount of time to wait when receiving a response from the health check, in + milliseconds. + */ + timeoutMillis: HealthCheckTimeoutMillis; + /** + * The number of consecutive failed health checks that must occur before declaring a + virtual node unhealthy. + */ + unhealthyThreshold: HealthCheckThreshold; + } + export interface VirtualServiceRef { + /** + * The full Amazon Resource Name (ARN) for the virtual service. + */ + arn: Arn; + /** + * The name of the service mesh that the virtual service resides in. + */ + meshName: ResourceName; + /** + * The name of the virtual service. + */ + virtualServiceName: ServiceName; + } + export interface EgressFilter { + /** + * The egress filter type. By default, the type is DROP_ALL, which allows + egress only from virtual nodes to other defined resources in the service mesh (and any traffic + to *.amazonaws.com for AWS API calls). You can set the egress filter type to + ALLOW_ALL to allow egress to any endpoint inside or outside of the service + mesh. + */ + type: EgressFilterType; + } + export type VirtualServiceList = VirtualServiceRef[]; + export interface VirtualNodeStatus { + /** + * The current status of the virtual node. + */ + status: VirtualNodeStatusCode; + } + export interface VirtualRouterRef { + /** + * The full Amazon Resource Name (ARN) for the virtual router. + */ + arn: Arn; + /** + * The name of the service mesh that the virtual router resides in. + */ + meshName: ResourceName; + /** + * The name of the virtual router. + */ + virtualRouterName: ResourceName; + } + export interface VirtualServiceData { + /** + * The name of the service mesh that the virtual service resides in. + */ + meshName: ResourceName; + metadata: ResourceMetadata; + /** + * The specifications of the virtual service. + */ + spec: VirtualServiceSpec; + /** + * The current status of the virtual service. + */ + status: VirtualServiceStatus; + /** + * The name of the virtual service. + */ + virtualServiceName: ServiceName; + } + export interface DescribeVirtualServiceOutput { + /** + * The full description of your virtual service. + */ + virtualService: VirtualServiceData; + } + export type FilePath = string; + export interface VirtualNodeRef { + /** + * The full Amazon Resource Name (ARN) for the virtual node. + */ + arn: Arn; + /** + * The name of the service mesh that the virtual node resides in. + */ + meshName: ResourceName; + /** + * The name of the virtual node. + */ + virtualNodeName: ResourceName; + } + export interface CreateMeshInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name to use for the service mesh. + */ + meshName: ResourceName; + /** + * The service mesh specification to apply. + */ + spec?: MeshSpec; + /** + * Optional metadata that you can apply to the service mesh to assist with categorization and organization. + Each tag consists of a key and an optional value, both of which you define. + Tag keys can have a maximum character length of 128 characters, and tag values can have + a maximum length of 256 characters. + */ + tags?: TagList; + } + export interface DescribeVirtualNodeOutput { + /** + * The full description of your virtual node. + */ + virtualNode: VirtualNodeData; + } + export interface UpdateMeshOutput { + mesh: MeshData; + } + export interface CreateRouteOutput { + /** + * The full description of your mesh following the create call. + */ + route: RouteData; + } + export interface DnsServiceDiscovery { + /** + * Specifies the DNS service discovery hostname for the virtual node. + */ + hostname: Hostname; + } + export interface DescribeVirtualServiceInput { + /** + * The name of the service mesh that the virtual service resides in. + */ + meshName: ResourceName; + /** + * The name of the virtual service to describe. + */ + virtualServiceName: ServiceName; + } + export type ListVirtualServicesLimit = number; + export interface DeleteRouteInput { + /** + * The name of the service mesh to delete the route in. + */ + meshName: ResourceName; + /** + * The name of the route to delete. + */ + routeName: ResourceName; + /** + * The name of the virtual router to delete the route in. + */ + virtualRouterName: ResourceName; + } + export interface VirtualNodeData { + /** + * The name of the service mesh that the virtual node resides in. + */ + meshName: ResourceName; + /** + * The associated metadata for the virtual node. + */ + metadata: ResourceMetadata; + /** + * The specifications of the virtual node. + */ + spec: VirtualNodeSpec; + /** + * The current status for the virtual node. + */ + status: VirtualNodeStatus; + /** + * The name of the virtual node. + */ + virtualNodeName: ResourceName; + } + export interface UntagResourceOutput { + } + export interface VirtualServiceSpec { + /** + * The App Mesh object that is acting as the provider for a virtual service. You can specify + a single virtual node or virtual router. + */ + provider?: VirtualServiceProvider; + } + export interface Backend { + /** + * Specifies a virtual service to use as a backend for a virtual node. + */ + virtualService?: VirtualServiceBackend; + } + export type ListVirtualRoutersLimit = number; + export type HealthCheckIntervalMillis = number; + export type VirtualRouterList = VirtualRouterRef[]; + export interface ListMeshesInput { + /** + * The maximum number of results returned by ListMeshes in paginated output. + When you use this parameter, ListMeshes returns only limit + results in a single page along with a nextToken response element. You can see the + remaining results of the initial request by sending another + ListMeshes request with the returned nextToken value. This + value can be between 1 and 100. If you don't use this parameter, + ListMeshes returns up to 100 results and a + nextToken value if applicable. + */ + limit?: ListMeshesLimit; + /** + * The nextToken value returned from a previous paginated + ListMeshes request where limit was used and the + results exceeded the value of that parameter. Pagination continues from the end of the + previous results that returned the nextToken value. + + This token should be treated as an opaque identifier that is used only to + retrieve the next items in a list and not for other programmatic purposes. + + */ + nextToken?: String; + } + export type Arn = string; + export interface TcpRoute { + /** + * The action to take if a match is determined. + */ + action: TcpRouteAction; + } + export type VirtualNodeList = VirtualNodeRef[]; + export interface ListVirtualRoutersInput { + /** + * The maximum number of results returned by ListVirtualRouters in paginated + output. When you use this parameter, ListVirtualRouters returns only + limit results in a single page along with a nextToken response + element. You can see the remaining results of the initial request by sending another + ListVirtualRouters request with the returned nextToken value. + This value can be between 1 and 100. If you don't use this parameter, + ListVirtualRouters returns up to 100 results and + a nextToken value if applicable. + */ + limit?: ListVirtualRoutersLimit; + /** + * The name of the service mesh to list virtual routers in. + */ + meshName: ResourceName; + /** + * The nextToken value returned from a previous paginated + ListVirtualRouters request where limit was used and the + results exceeded the value of that parameter. Pagination continues from the end of the + previous results that returned the nextToken value. + */ + nextToken?: String; + } + export interface VirtualRouterData { + /** + * The name of the service mesh that the virtual router resides in. + */ + meshName: ResourceName; + /** + * The associated metadata for the virtual router. + */ + metadata: ResourceMetadata; + /** + * The specifications of the virtual router. + */ + spec: VirtualRouterSpec; + /** + * The current status of the virtual router. + */ + status: VirtualRouterStatus; + /** + * The name of the virtual router. + */ + virtualRouterName: ResourceName; + } + export interface UpdateMeshInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh to update. + */ + meshName: ResourceName; + /** + * The service mesh specification to apply. + */ + spec?: MeshSpec; + } + export interface ListVirtualServicesInput { + /** + * The maximum number of results returned by ListVirtualServices in paginated + output. When you use this parameter, ListVirtualServices returns only + limit results in a single page along with a nextToken response + element. You can see the remaining results of the initial request by sending another + ListVirtualServices request with the returned nextToken value. + This value can be between 1 and 100. If you don't use this parameter, + ListVirtualServices returns up to 100 results and + a nextToken value if applicable. + */ + limit?: ListVirtualServicesLimit; + /** + * The name of the service mesh to list virtual services in. + */ + meshName: ResourceName; + /** + * The nextToken value returned from a previous paginated + ListVirtualServices request where limit was used and the + results exceeded the value of that parameter. Pagination continues from the end of the + previous results that returned the nextToken value. + */ + nextToken?: String; + } + export interface CreateVirtualRouterInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh to create the virtual router in. + */ + meshName: ResourceName; + /** + * The virtual router specification to apply. + */ + spec: VirtualRouterSpec; + /** + * Optional metadata that you can apply to the virtual router to assist with categorization and organization. + Each tag consists of a key and an optional value, both of which you define. + Tag keys can have a maximum character length of 128 characters, and tag values can have + a maximum length of 256 characters. + */ + tags?: TagList; + /** + * The name to use for the virtual router. + */ + virtualRouterName: ResourceName; + } + export interface AccessLog { + /** + * The file object to send virtual node access logs to. + */ + file?: FileAccessLog; + } + export interface ListVirtualNodesInput { + /** + * The maximum number of results returned by ListVirtualNodes in paginated + output. When you use this parameter, ListVirtualNodes returns only + limit results in a single page along with a nextToken response + element. You can see the remaining results of the initial request by sending another + ListVirtualNodes request with the returned nextToken value. + This value can be between 1 and 100. If you don't use this parameter, + ListVirtualNodes returns up to 100 results and a + nextToken value if applicable. + */ + limit?: ListVirtualNodesLimit; + /** + * The name of the service mesh to list virtual nodes in. + */ + meshName: ResourceName; + /** + * The nextToken value returned from a previous paginated + ListVirtualNodes request where limit was used and the + results exceeded the value of that parameter. Pagination continues from the end of the + previous results that returned the nextToken value. + */ + nextToken?: String; + } + export interface DescribeVirtualRouterOutput { + /** + * The full description of your virtual router. + */ + virtualRouter: VirtualRouterData; + } + export interface CreateMeshOutput { + /** + * The full description of your service mesh following the create call. + */ + mesh: MeshData; + } + export interface CreateVirtualRouterOutput { + /** + * The full description of your virtual router following the create call. + */ + virtualRouter: VirtualRouterData; + } + export interface VirtualServiceStatus { + /** + * The current status of the virtual service. + */ + status: VirtualServiceStatusCode; + } + export type ListVirtualNodesLimit = number; + export type HealthCheckTimeoutMillis = number; + export type ListMeshesLimit = number; + export type ResourceName = string; + export interface VirtualRouterSpec { + /** + * The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router. + */ + listeners: VirtualRouterListeners; + } + export type Timestamp = Date; + export interface VirtualNodeSpec { + /** + * The backends that the virtual node is expected to send outbound traffic to. + */ + backends?: Backends; + /** + * The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node. + */ + listeners?: Listeners; + /** + * The inbound and outbound access logging information for the virtual node. + */ + logging?: Logging; + /** + * The service discovery information for the virtual node. If your virtual node does not + expect ingress traffic, you can omit this parameter. + */ + serviceDiscovery?: ServiceDiscovery; + } + export interface ListMeshesOutput { + /** + * The list of existing service meshes. + */ + meshes: MeshList; + /** + * The nextToken value to include in a future ListMeshes + request. When the results of a ListMeshes request exceed + limit, you can use this value to retrieve the next page of + results. This value is null when there are no more results to + return. + */ + nextToken?: String; + } + export type VirtualRouterListeners = VirtualRouterListener[]; + export interface DescribeRouteOutput { + /** + * The full description of your route. + */ + route: RouteData; + } + export interface HttpRouteMatch { + /** + * Specifies the path to match requests with. This parameter must always start with + /, which by itself matches all requests to the virtual service name. You + can also match for path-based routing of requests. For example, if your virtual service + name is my-service.local and you want the route to match requests to + my-service.local/metrics, your prefix should be + /metrics. + */ + prefix: String; + } + export type MeshList = MeshRef[]; + export interface TagRef { + /** + * One part of a key-value pair that make up a tag. A key is a general label + that acts like a category for more specific tag values. + */ + key: TagKey; + /** + * The optional part of a key-value pair that make up a tag. A value acts as + a descriptor within a tag category (key). + */ + value?: TagValue; + } + export interface MeshRef { + /** + * The full Amazon Resource Name (ARN) of the service mesh. + */ + arn: Arn; + /** + * The name of the service mesh. + */ + meshName: ResourceName; + } + export type MeshStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string; + export interface PortMapping { + /** + * The port used for the port mapping. + */ + port: PortNumber; + /** + * The protocol used for the port mapping. + */ + protocol: PortProtocol; + } + export interface MeshData { + /** + * The name of the service mesh. + */ + meshName: ResourceName; + /** + * The associated metadata for the service mesh. + */ + metadata: ResourceMetadata; + /** + * The associated specification for the service mesh. + */ + spec: MeshSpec; + /** + * The status of the service mesh. + */ + status: MeshStatus; + } + export interface VirtualRouterStatus { + /** + * The current status of the virtual router. + */ + status: VirtualRouterStatusCode; + } + export interface ListVirtualServicesOutput { + /** + * The nextToken value to include in a future ListVirtualServices + request. When the results of a ListVirtualServices request exceed + limit, you can use this value to retrieve the next page of results. This + value is null when there are no more results to return. + */ + nextToken?: String; + /** + * The list of existing virtual services for the specified service mesh. + */ + virtualServices: VirtualServiceList; + } + export interface WeightedTarget { + /** + * The virtual node to associate with the weighted target. + */ + virtualNode: ResourceName; + /** + * The relative weight of the weighted target. + */ + weight: PercentInt; + } + export interface TcpRouteAction { + /** + * The targets that traffic is routed to when a request matches the route. You can specify + one or more targets and their relative weights to distribute traffic with. + */ + weightedTargets: WeightedTargets; + } + export interface DescribeVirtualNodeInput { + /** + * The name of the service mesh that the virtual node resides in. + */ + meshName: ResourceName; + /** + * The name of the virtual node to describe. + */ + virtualNodeName: ResourceName; + } + export interface RouteStatus { + /** + * The current status for the route. + */ + status: RouteStatusCode; + } + export interface RouteRef { + /** + * The full Amazon Resource Name (ARN) for the route. + */ + arn: Arn; + /** + * The name of the service mesh that the route resides in. + */ + meshName: ResourceName; + /** + * The name of the route. + */ + routeName: ResourceName; + /** + * The virtual router that the route is associated with. + */ + virtualRouterName: ResourceName; + } + export interface Listener { + /** + * The health check information for the listener. + */ + healthCheck?: HealthCheckPolicy; + /** + * The port mapping information for the listener. + */ + portMapping: PortMapping; + } + export interface DeleteVirtualNodeInput { + /** + * The name of the service mesh to delete the virtual node in. + */ + meshName: ResourceName; + /** + * The name of the virtual node to delete. + */ + virtualNodeName: ResourceName; + } + export interface RouteData { + /** + * The name of the service mesh that the route resides in. + */ + meshName: ResourceName; + /** + * The associated metadata for the route. + */ + metadata: ResourceMetadata; + /** + * The name of the route. + */ + routeName: ResourceName; + /** + * The specifications of the route. + */ + spec: RouteSpec; + /** + * The status of the route. + */ + status: RouteStatus; + /** + * The virtual router that the route is associated with. + */ + virtualRouterName: ResourceName; + } + export type RouteStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string; + export type ListRoutesLimit = number; + export interface DeleteVirtualServiceOutput { + /** + * The virtual service that was deleted. + */ + virtualService: VirtualServiceData; + } + export interface VirtualNodeServiceProvider { + /** + * The name of the virtual node that is acting as a service provider. + */ + virtualNodeName: ResourceName; + } + export type TagList = TagRef[]; + export interface DescribeVirtualRouterInput { + /** + * The name of the service mesh that the virtual router resides in. + */ + meshName: ResourceName; + /** + * The name of the virtual router to describe. + */ + virtualRouterName: ResourceName; + } + export interface TagResourceOutput { + } + export type RouteList = RouteRef[]; + export interface DeleteMeshOutput { + /** + * The service mesh that was deleted. + */ + mesh: MeshData; + } + export type EgressFilterType = "ALLOW_ALL"|"DROP_ALL"|string; + export type Hostname = string; + export type PortNumber = number; + export interface TagResourceInput { + /** + * The Amazon Resource Name (ARN) of the resource to add tags to. + */ + resourceArn: Arn; + /** + * The tags to add to the resource. A tag is an array of key-value pairs. + Tag keys can have a maximum character length of 128 characters, and tag values can have + a maximum length of 256 characters. + */ + tags: TagList; + } + export interface CreateRouteInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh to create the route in. + */ + meshName: ResourceName; + /** + * The name to use for the route. + */ + routeName: ResourceName; + /** + * The route specification to apply. + */ + spec: RouteSpec; + /** + * Optional metadata that you can apply to the route to assist with categorization and organization. + Each tag consists of a key and an optional value, both of which you define. + Tag keys can have a maximum character length of 128 characters, and tag values can have + a maximum length of 256 characters. + */ + tags?: TagList; + /** + * The name of the virtual router in which to create the route. + */ + virtualRouterName: ResourceName; + } + export type WeightedTargets = WeightedTarget[]; + export interface VirtualServiceProvider { + /** + * The virtual node associated with a virtual service. + */ + virtualNode?: VirtualNodeServiceProvider; + /** + * The virtual router associated with a virtual service. + */ + virtualRouter?: VirtualRouterServiceProvider; + } + export type String = string; + export interface UpdateVirtualServiceOutput { + /** + * A full description of the virtual service that was updated. + */ + virtualService: VirtualServiceData; + } + export interface UpdateRouteInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh that the route resides in. + */ + meshName: ResourceName; + /** + * The name of the route to update. + */ + routeName: ResourceName; + /** + * The new route specification to apply. This overwrites the existing data. + */ + spec: RouteSpec; + /** + * The name of the virtual router that the route is associated with. + */ + virtualRouterName: ResourceName; + } + export interface MeshStatus { + /** + * The current mesh status. + */ + status?: MeshStatusCode; + } + export interface CreateVirtualNodeInput { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the +request. Up to 36 letters, numbers, hyphens, and underscores are allowed. + */ + clientToken?: String; + /** + * The name of the service mesh to create the virtual node in. + */ + meshName: ResourceName; + /** + * The virtual node specification to apply. + */ + spec: VirtualNodeSpec; + /** + * Optional metadata that you can apply to the virtual node to assist with categorization and organization. + Each tag consists of a key and an optional value, both of which you define. + Tag keys can have a maximum character length of 128 characters, and tag values can have + a maximum length of 256 characters. + */ + tags?: TagList; + /** + * The name to use for the virtual node. + */ + virtualNodeName: ResourceName; + } + export interface RouteSpec { + /** + * The HTTP routing information for the route. + */ + httpRoute?: HttpRoute; + /** + * The TCP routing information for the route. + */ + tcpRoute?: TcpRoute; + } + export interface HttpRoute { + /** + * The action to take if a match is determined. + */ + action: HttpRouteAction; + /** + * The criteria for determining an HTTP request match. + */ + match: HttpRouteMatch; + } + export interface DescribeMeshInput { + /** + * The name of the service mesh to describe. + */ + meshName: ResourceName; + } + export interface MeshSpec { + /** + * The egress filter rules for the service mesh. + */ + egressFilter?: EgressFilter; + } + export interface CreateVirtualServiceOutput { + /** + * The full description of your virtual service following the create call. + */ + virtualService: VirtualServiceData; + } + export interface FileAccessLog { + /** + * The file path to write access logs to. You can use /dev/stdout to send + access logs to standard out and configure your Envoy container to use a log driver, such as + awslogs, to export the access logs to a log storage service such as Amazon CloudWatch + Logs. You can also specify a path in the Envoy container's file system to write the files + to disk. + + The Envoy process must have write permissions to the path that you specify here. + Otherwise, Envoy fails to bootstrap properly. + + */ + path: FilePath; + } + export interface VirtualRouterServiceProvider { + /** + * The name of the virtual router that is acting as a service provider. + */ + virtualRouterName: ResourceName; + } + export interface DeleteVirtualServiceInput { + /** + * The name of the service mesh to delete the virtual service in. + */ + meshName: ResourceName; + /** + * The name of the virtual service to delete. + */ + virtualServiceName: ServiceName; + } + export interface ListTagsForResourceOutput { + /** + * The nextToken value to include in a future ListTagsForResource + request. When the results of a ListTagsForResource request exceed + limit, you can use this value to retrieve the next page of + results. This value is null when there are no more results to + return. + */ + nextToken?: String; + /** + * The tags for the resource. + */ + tags: TagList; + } + export interface ServiceDiscovery { + /** + * Specifies the DNS information for the virtual node. + */ + dns?: DnsServiceDiscovery; + } + export interface ListVirtualNodesOutput { + /** + * The nextToken value to include in a future ListVirtualNodes + request. When the results of a ListVirtualNodes request exceed + limit, you can use this value to retrieve the next page of + results. This value is null when there are no more results to + return. + */ + nextToken?: String; + /** + * The list of existing virtual nodes for the specified service mesh. + */ + virtualNodes: VirtualNodeList; + } + export interface UntagResourceInput { + /** + * The Amazon Resource Name (ARN) of the resource to delete tags from. + */ + resourceArn: Arn; + /** + * The keys of the tags to be removed. + */ + tagKeys: TagKeyList; + } + export interface DeleteVirtualRouterOutput { + /** + * The virtual router that was deleted. + */ + virtualRouter: VirtualRouterData; + } + export type TagsLimit = number; + export type TagKey = string; + export type VirtualServiceStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string; + export interface DeleteVirtualNodeOutput { + /** + * The virtual node that was deleted. + */ + virtualNode: VirtualNodeData; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-10-01"|"2018-10-01"|"2019-01-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the AppMesh client. + */ + export import Types = AppMesh; +} +export = AppMesh; diff --git a/node_modules/aws-sdk/clients/appmesh.js b/node_modules/aws-sdk/clients/appmesh.js new file mode 100644 index 0000000..6ef1c5e --- /dev/null +++ b/node_modules/aws-sdk/clients/appmesh.js @@ -0,0 +1,27 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['appmesh'] = {}; +AWS.AppMesh = Service.defineService('appmesh', ['2018-10-01', '2018-10-01*', '2019-01-25']); +Object.defineProperty(apiLoader.services['appmesh'], '2018-10-01', { + get: function get() { + var model = require('../apis/appmesh-2018-10-01.min.json'); + model.paginators = require('../apis/appmesh-2018-10-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['appmesh'], '2019-01-25', { + get: function get() { + var model = require('../apis/appmesh-2019-01-25.min.json'); + model.paginators = require('../apis/appmesh-2019-01-25.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.AppMesh; diff --git a/node_modules/aws-sdk/clients/appstream.d.ts b/node_modules/aws-sdk/clients/appstream.d.ts new file mode 100644 index 0000000..90b8d8f --- /dev/null +++ b/node_modules/aws-sdk/clients/appstream.d.ts @@ -0,0 +1,2010 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class AppStream extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: AppStream.Types.ClientConfiguration) + config: Config & AppStream.Types.ClientConfiguration; + /** + * Associates the specified fleet with the specified stack. + */ + associateFleet(params: AppStream.Types.AssociateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.AssociateFleetResult) => void): Request; + /** + * Associates the specified fleet with the specified stack. + */ + associateFleet(callback?: (err: AWSError, data: AppStream.Types.AssociateFleetResult) => void): Request; + /** + * Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain. + */ + batchAssociateUserStack(params: AppStream.Types.BatchAssociateUserStackRequest, callback?: (err: AWSError, data: AppStream.Types.BatchAssociateUserStackResult) => void): Request; + /** + * Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain. + */ + batchAssociateUserStack(callback?: (err: AWSError, data: AppStream.Types.BatchAssociateUserStackResult) => void): Request; + /** + * Disassociates the specified users from the specified stacks. + */ + batchDisassociateUserStack(params: AppStream.Types.BatchDisassociateUserStackRequest, callback?: (err: AWSError, data: AppStream.Types.BatchDisassociateUserStackResult) => void): Request; + /** + * Disassociates the specified users from the specified stacks. + */ + batchDisassociateUserStack(callback?: (err: AWSError, data: AppStream.Types.BatchDisassociateUserStackResult) => void): Request; + /** + * Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied. + */ + copyImage(params: AppStream.Types.CopyImageRequest, callback?: (err: AWSError, data: AppStream.Types.CopyImageResponse) => void): Request; + /** + * Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied. + */ + copyImage(callback?: (err: AWSError, data: AppStream.Types.CopyImageResponse) => void): Request; + /** + * Creates a Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. + */ + createDirectoryConfig(params: AppStream.Types.CreateDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.CreateDirectoryConfigResult) => void): Request; + /** + * Creates a Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. + */ + createDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.CreateDirectoryConfigResult) => void): Request; + /** + * Creates a fleet. A fleet consists of streaming instances that run a specified image. + */ + createFleet(params: AppStream.Types.CreateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.CreateFleetResult) => void): Request; + /** + * Creates a fleet. A fleet consists of streaming instances that run a specified image. + */ + createFleet(callback?: (err: AWSError, data: AppStream.Types.CreateFleetResult) => void): Request; + /** + * Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING. + */ + createImageBuilder(params: AppStream.Types.CreateImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderResult) => void): Request; + /** + * Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING. + */ + createImageBuilder(callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderResult) => void): Request; + /** + * Creates a URL to start an image builder streaming session. + */ + createImageBuilderStreamingURL(params: AppStream.Types.CreateImageBuilderStreamingURLRequest, callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderStreamingURLResult) => void): Request; + /** + * Creates a URL to start an image builder streaming session. + */ + createImageBuilderStreamingURL(callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderStreamingURLResult) => void): Request; + /** + * Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. + */ + createStack(params: AppStream.Types.CreateStackRequest, callback?: (err: AWSError, data: AppStream.Types.CreateStackResult) => void): Request; + /** + * Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. + */ + createStack(callback?: (err: AWSError, data: AppStream.Types.CreateStackResult) => void): Request; + /** + * Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. + */ + createStreamingURL(params: AppStream.Types.CreateStreamingURLRequest, callback?: (err: AWSError, data: AppStream.Types.CreateStreamingURLResult) => void): Request; + /** + * Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. + */ + createStreamingURL(callback?: (err: AWSError, data: AppStream.Types.CreateStreamingURLResult) => void): Request; + /** + * Creates a new user in the user pool. + */ + createUser(params: AppStream.Types.CreateUserRequest, callback?: (err: AWSError, data: AppStream.Types.CreateUserResult) => void): Request; + /** + * Creates a new user in the user pool. + */ + createUser(callback?: (err: AWSError, data: AppStream.Types.CreateUserResult) => void): Request; + /** + * Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. + */ + deleteDirectoryConfig(params: AppStream.Types.DeleteDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteDirectoryConfigResult) => void): Request; + /** + * Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. + */ + deleteDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.DeleteDirectoryConfigResult) => void): Request; + /** + * Deletes the specified fleet. + */ + deleteFleet(params: AppStream.Types.DeleteFleetRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteFleetResult) => void): Request; + /** + * Deletes the specified fleet. + */ + deleteFleet(callback?: (err: AWSError, data: AppStream.Types.DeleteFleetResult) => void): Request; + /** + * Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image. + */ + deleteImage(params: AppStream.Types.DeleteImageRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImageResult) => void): Request; + /** + * Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image. + */ + deleteImage(callback?: (err: AWSError, data: AppStream.Types.DeleteImageResult) => void): Request; + /** + * Deletes the specified image builder and releases the capacity. + */ + deleteImageBuilder(params: AppStream.Types.DeleteImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImageBuilderResult) => void): Request; + /** + * Deletes the specified image builder and releases the capacity. + */ + deleteImageBuilder(callback?: (err: AWSError, data: AppStream.Types.DeleteImageBuilderResult) => void): Request; + /** + * Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image. + */ + deleteImagePermissions(params: AppStream.Types.DeleteImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImagePermissionsResult) => void): Request; + /** + * Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image. + */ + deleteImagePermissions(callback?: (err: AWSError, data: AppStream.Types.DeleteImagePermissionsResult) => void): Request; + /** + * Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released. + */ + deleteStack(params: AppStream.Types.DeleteStackRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteStackResult) => void): Request; + /** + * Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released. + */ + deleteStack(callback?: (err: AWSError, data: AppStream.Types.DeleteStackResult) => void): Request; + /** + * Deletes a user from the user pool. + */ + deleteUser(params: AppStream.Types.DeleteUserRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteUserResult) => void): Request; + /** + * Deletes a user from the user pool. + */ + deleteUser(callback?: (err: AWSError, data: AppStream.Types.DeleteUserResult) => void): Request; + /** + * Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the information required to join streaming instances to an Active Directory domain. Although the response syntax in this topic includes the account password, this password is not returned in the actual response. + */ + describeDirectoryConfigs(params: AppStream.Types.DescribeDirectoryConfigsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeDirectoryConfigsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the information required to join streaming instances to an Active Directory domain. Although the response syntax in this topic includes the account password, this password is not returned in the actual response. + */ + describeDirectoryConfigs(callback?: (err: AWSError, data: AppStream.Types.DescribeDirectoryConfigsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described. + */ + describeFleets(params: AppStream.Types.DescribeFleetsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described. + */ + describeFleets(callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described. + */ + describeImageBuilders(params: AppStream.Types.DescribeImageBuildersRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImageBuildersResult) => void): Request; + /** + * Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described. + */ + describeImageBuilders(callback?: (err: AWSError, data: AppStream.Types.DescribeImageBuildersResult) => void): Request; + /** + * Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. + */ + describeImagePermissions(params: AppStream.Types.DescribeImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImagePermissionsResult) => void): Request; + /** + * Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. + */ + describeImagePermissions(callback?: (err: AWSError, data: AppStream.Types.DescribeImagePermissionsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described. + */ + describeImages(params: AppStream.Types.DescribeImagesRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImagesResult) => void): Request; + /** + * Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described. + */ + describeImages(callback?: (err: AWSError, data: AppStream.Types.DescribeImagesResult) => void): Request; + /** + * Retrieves a list that describes the active streaming sessions for a specified stack and fleet. If a value for UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL. + */ + describeSessions(params: AppStream.Types.DescribeSessionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeSessionsResult) => void): Request; + /** + * Retrieves a list that describes the active streaming sessions for a specified stack and fleet. If a value for UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL. + */ + describeSessions(callback?: (err: AWSError, data: AppStream.Types.DescribeSessionsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described. + */ + describeStacks(params: AppStream.Types.DescribeStacksRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeStacksResult) => void): Request; + /** + * Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described. + */ + describeStacks(callback?: (err: AWSError, data: AppStream.Types.DescribeStacksResult) => void): Request; + /** + * Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user + */ + describeUserStackAssociations(params: AppStream.Types.DescribeUserStackAssociationsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUserStackAssociationsResult) => void): Request; + /** + * Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user + */ + describeUserStackAssociations(callback?: (err: AWSError, data: AppStream.Types.DescribeUserStackAssociationsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified users in the user pool. + */ + describeUsers(params: AppStream.Types.DescribeUsersRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUsersResult) => void): Request; + /** + * Retrieves a list that describes one or more specified users in the user pool. + */ + describeUsers(callback?: (err: AWSError, data: AppStream.Types.DescribeUsersResult) => void): Request; + /** + * Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. + */ + disableUser(params: AppStream.Types.DisableUserRequest, callback?: (err: AWSError, data: AppStream.Types.DisableUserResult) => void): Request; + /** + * Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. + */ + disableUser(callback?: (err: AWSError, data: AppStream.Types.DisableUserResult) => void): Request; + /** + * Disassociates the specified fleet from the specified stack. + */ + disassociateFleet(params: AppStream.Types.DisassociateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.DisassociateFleetResult) => void): Request; + /** + * Disassociates the specified fleet from the specified stack. + */ + disassociateFleet(callback?: (err: AWSError, data: AppStream.Types.DisassociateFleetResult) => void): Request; + /** + * Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned. + */ + enableUser(params: AppStream.Types.EnableUserRequest, callback?: (err: AWSError, data: AppStream.Types.EnableUserResult) => void): Request; + /** + * Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned. + */ + enableUser(callback?: (err: AWSError, data: AppStream.Types.EnableUserResult) => void): Request; + /** + * Immediately stops the specified streaming session. + */ + expireSession(params: AppStream.Types.ExpireSessionRequest, callback?: (err: AWSError, data: AppStream.Types.ExpireSessionResult) => void): Request; + /** + * Immediately stops the specified streaming session. + */ + expireSession(callback?: (err: AWSError, data: AppStream.Types.ExpireSessionResult) => void): Request; + /** + * Retrieves the name of the fleet that is associated with the specified stack. + */ + listAssociatedFleets(params: AppStream.Types.ListAssociatedFleetsRequest, callback?: (err: AWSError, data: AppStream.Types.ListAssociatedFleetsResult) => void): Request; + /** + * Retrieves the name of the fleet that is associated with the specified stack. + */ + listAssociatedFleets(callback?: (err: AWSError, data: AppStream.Types.ListAssociatedFleetsResult) => void): Request; + /** + * Retrieves the name of the stack with which the specified fleet is associated. + */ + listAssociatedStacks(params: AppStream.Types.ListAssociatedStacksRequest, callback?: (err: AWSError, data: AppStream.Types.ListAssociatedStacksResult) => void): Request; + /** + * Retrieves the name of the stack with which the specified fleet is associated. + */ + listAssociatedStacks(callback?: (err: AWSError, data: AppStream.Types.ListAssociatedStacksResult) => void): Request; + /** + * Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + listTagsForResource(params: AppStream.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppStream.Types.ListTagsForResourceResponse) => void): Request; + /** + * Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + listTagsForResource(callback?: (err: AWSError, data: AppStream.Types.ListTagsForResourceResponse) => void): Request; + /** + * Starts the specified fleet. + */ + startFleet(params: AppStream.Types.StartFleetRequest, callback?: (err: AWSError, data: AppStream.Types.StartFleetResult) => void): Request; + /** + * Starts the specified fleet. + */ + startFleet(callback?: (err: AWSError, data: AppStream.Types.StartFleetResult) => void): Request; + /** + * Starts the specified image builder. + */ + startImageBuilder(params: AppStream.Types.StartImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StartImageBuilderResult) => void): Request; + /** + * Starts the specified image builder. + */ + startImageBuilder(callback?: (err: AWSError, data: AppStream.Types.StartImageBuilderResult) => void): Request; + /** + * Stops the specified fleet. + */ + stopFleet(params: AppStream.Types.StopFleetRequest, callback?: (err: AWSError, data: AppStream.Types.StopFleetResult) => void): Request; + /** + * Stops the specified fleet. + */ + stopFleet(callback?: (err: AWSError, data: AppStream.Types.StopFleetResult) => void): Request; + /** + * Stops the specified image builder. + */ + stopImageBuilder(params: AppStream.Types.StopImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StopImageBuilderResult) => void): Request; + /** + * Stops the specified image builder. + */ + stopImageBuilder(callback?: (err: AWSError, data: AppStream.Types.StopImageBuilderResult) => void): Request; + /** + * Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + tagResource(params: AppStream.Types.TagResourceRequest, callback?: (err: AWSError, data: AppStream.Types.TagResourceResponse) => void): Request; + /** + * Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + tagResource(callback?: (err: AWSError, data: AppStream.Types.TagResourceResponse) => void): Request; + /** + * Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + untagResource(params: AppStream.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppStream.Types.UntagResourceResponse) => void): Request; + /** + * Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + untagResource(callback?: (err: AWSError, data: AppStream.Types.UntagResourceResponse) => void): Request; + /** + * Updates the specified Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. + */ + updateDirectoryConfig(params: AppStream.Types.UpdateDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateDirectoryConfigResult) => void): Request; + /** + * Updates the specified Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. + */ + updateDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.UpdateDirectoryConfigResult) => void): Request; + /** + * Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it. + */ + updateFleet(params: AppStream.Types.UpdateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateFleetResult) => void): Request; + /** + * Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it. + */ + updateFleet(callback?: (err: AWSError, data: AppStream.Types.UpdateFleetResult) => void): Request; + /** + * Adds or updates permissions for the specified private image. + */ + updateImagePermissions(params: AppStream.Types.UpdateImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateImagePermissionsResult) => void): Request; + /** + * Adds or updates permissions for the specified private image. + */ + updateImagePermissions(callback?: (err: AWSError, data: AppStream.Types.UpdateImagePermissionsResult) => void): Request; + /** + * Updates the specified fields for the specified stack. + */ + updateStack(params: AppStream.Types.UpdateStackRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateStackResult) => void): Request; + /** + * Updates the specified fields for the specified stack. + */ + updateStack(callback?: (err: AWSError, data: AppStream.Types.UpdateStackResult) => void): Request; + /** + * Waits for the fleetStarted state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times). + */ + waitFor(state: "fleetStarted", params: AppStream.Types.DescribeFleetsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request; + /** + * Waits for the fleetStarted state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times). + */ + waitFor(state: "fleetStarted", callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request; + /** + * Waits for the fleetStopped state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times). + */ + waitFor(state: "fleetStopped", params: AppStream.Types.DescribeFleetsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request; + /** + * Waits for the fleetStopped state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times). + */ + waitFor(state: "fleetStopped", callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request; +} +declare namespace AppStream { + export type AccountName = string; + export type AccountPassword = string; + export type Action = "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"|"CLIPBOARD_COPY_TO_LOCAL_DEVICE"|"FILE_UPLOAD"|"FILE_DOWNLOAD"|"PRINTING_TO_LOCAL_DEVICE"|string; + export interface Application { + /** + * The name of the application. + */ + Name?: String; + /** + * The application name to display. + */ + DisplayName?: String; + /** + * The URL for the application icon. This URL might be time-limited. + */ + IconURL?: String; + /** + * The path to the application executable in the instance. + */ + LaunchPath?: String; + /** + * The arguments that are passed to the application at launch. + */ + LaunchParameters?: String; + /** + * If there is a problem, the application can be disabled after image creation. + */ + Enabled?: Boolean; + /** + * Additional attributes that describe the application. + */ + Metadata?: Metadata; + } + export interface ApplicationSettings { + /** + * Enables or disables persistent application settings for users during their streaming sessions. + */ + Enabled: Boolean; + /** + * The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack. + */ + SettingsGroup?: SettingsGroup; + } + export interface ApplicationSettingsResponse { + /** + * Specifies whether persistent application settings are enabled for users during their streaming sessions. + */ + Enabled?: Boolean; + /** + * The path prefix for the S3 bucket where users’ persistent application settings are stored. + */ + SettingsGroup?: SettingsGroup; + /** + * The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region. + */ + S3BucketName?: String; + } + export type Applications = Application[]; + export type AppstreamAgentVersion = string; + export type Arn = string; + export type ArnList = Arn[]; + export interface AssociateFleetRequest { + /** + * The name of the fleet. + */ + FleetName: String; + /** + * The name of the stack. + */ + StackName: String; + } + export interface AssociateFleetResult { + } + export type AuthenticationType = "API"|"SAML"|"USERPOOL"|string; + export type AwsAccountId = string; + export type AwsAccountIdList = AwsAccountId[]; + export interface BatchAssociateUserStackRequest { + /** + * The list of UserStackAssociation objects. + */ + UserStackAssociations: UserStackAssociationList; + } + export interface BatchAssociateUserStackResult { + /** + * The list of UserStackAssociationError objects. + */ + errors?: UserStackAssociationErrorList; + } + export interface BatchDisassociateUserStackRequest { + /** + * The list of UserStackAssociation objects. + */ + UserStackAssociations: UserStackAssociationList; + } + export interface BatchDisassociateUserStackResult { + /** + * The list of UserStackAssociationError objects. + */ + errors?: UserStackAssociationErrorList; + } + export type Boolean = boolean; + export type BooleanObject = boolean; + export interface ComputeCapacity { + /** + * The desired number of streaming instances. + */ + DesiredInstances: Integer; + } + export interface ComputeCapacityStatus { + /** + * The desired number of streaming instances. + */ + Desired: Integer; + /** + * The total number of simultaneous streaming instances that are running. + */ + Running?: Integer; + /** + * The number of instances in use for streaming. + */ + InUse?: Integer; + /** + * The number of currently available instances that can be used to stream sessions. + */ + Available?: Integer; + } + export interface CopyImageRequest { + /** + * The name of the image to copy. + */ + SourceImageName: Name; + /** + * The name that the image will have when it is copied to the destination. + */ + DestinationImageName: Name; + /** + * The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region. + */ + DestinationRegion: RegionName; + /** + * The description that the image will have when it is copied to the destination. + */ + DestinationImageDescription?: Description; + } + export interface CopyImageResponse { + /** + * The name of the destination image. + */ + DestinationImageName?: Name; + } + export interface CreateDirectoryConfigRequest { + /** + * The fully qualified name of the directory (for example, corp.example.com). + */ + DirectoryName: DirectoryName; + /** + * The distinguished names of the organizational units for computer accounts. + */ + OrganizationalUnitDistinguishedNames: OrganizationalUnitDistinguishedNamesList; + /** + * The credentials for the service account used by the streaming instance to connect to the directory. + */ + ServiceAccountCredentials: ServiceAccountCredentials; + } + export interface CreateDirectoryConfigResult { + /** + * Information about the directory configuration. + */ + DirectoryConfig?: DirectoryConfig; + } + export interface CreateFleetRequest { + /** + * A unique name for the fleet. + */ + Name: Name; + /** + * The name of the image used to create the fleet. + */ + ImageName?: String; + /** + * The ARN of the public, private, or shared image to use. + */ + ImageArn?: Arn; + /** + * The instance type to use when launching fleet instances. The following instance types are available: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge + */ + InstanceType: String; + /** + * The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps. ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps. + */ + FleetType?: FleetType; + /** + * The desired capacity for the fleet. + */ + ComputeCapacity: ComputeCapacity; + /** + * The VPC configuration for the fleet. + */ + VpcConfig?: VpcConfig; + /** + * The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 360000. + */ + MaxUserDurationInSeconds?: Integer; + /** + * 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 360000. + */ + DisconnectTimeoutInSeconds?: Integer; + /** + * The description to display. + */ + Description?: Description; + /** + * The fleet name to display. + */ + DisplayName?: DisplayName; + /** + * Enables or disables default internet access for the fleet. + */ + EnableDefaultInternetAccess?: BooleanObject; + /** + * The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. + */ + DomainJoinInfo?: DomainJoinInfo; + /** + * The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + Tags?: Tags; + } + export interface CreateFleetResult { + /** + * Information about the fleet. + */ + Fleet?: Fleet; + } + export interface CreateImageBuilderRequest { + /** + * A unique name for the image builder. + */ + Name: Name; + /** + * The name of the image used to create the image builder. + */ + ImageName?: String; + /** + * The ARN of the public, private, or shared image to use. + */ + ImageArn?: Arn; + /** + * The instance type to use when launching the image builder. + */ + InstanceType: String; + /** + * The description to display. + */ + Description?: Description; + /** + * The image builder name to display. + */ + DisplayName?: DisplayName; + /** + * The VPC configuration for the image builder. You can specify only one subnet. + */ + VpcConfig?: VpcConfig; + /** + * Enables or disables default internet access for the image builder. + */ + EnableDefaultInternetAccess?: BooleanObject; + /** + * The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. + */ + DomainJoinInfo?: DomainJoinInfo; + /** + * The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. + */ + AppstreamAgentVersion?: AppstreamAgentVersion; + /** + * The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + Tags?: Tags; + } + export interface CreateImageBuilderResult { + /** + * Information about the image builder. + */ + ImageBuilder?: ImageBuilder; + } + export interface CreateImageBuilderStreamingURLRequest { + /** + * The name of the image builder. + */ + Name: String; + /** + * The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds. + */ + Validity?: Long; + } + export interface CreateImageBuilderStreamingURLResult { + /** + * The URL to start the AppStream 2.0 streaming session. + */ + StreamingURL?: String; + /** + * The elapsed time, in seconds after the Unix epoch, when this URL expires. + */ + Expires?: Timestamp; + } + export interface CreateStackRequest { + /** + * The name of the stack. + */ + Name: Name; + /** + * The description to display. + */ + Description?: Description; + /** + * The stack name to display. + */ + DisplayName?: DisplayName; + /** + * The storage connectors to enable. + */ + StorageConnectors?: StorageConnectorList; + /** + * The URL that users are redirected to after their streaming session ends. + */ + RedirectURL?: RedirectURL; + /** + * 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. + */ + FeedbackURL?: FeedbackURL; + /** + * The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. + */ + UserSettings?: UserSettingList; + /** + * The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session. + */ + ApplicationSettings?: ApplicationSettings; + /** + * The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide. + */ + Tags?: Tags; + } + export interface CreateStackResult { + /** + * Information about the stack. + */ + Stack?: Stack; + } + export interface CreateStreamingURLRequest { + /** + * The name of the stack. + */ + StackName: String; + /** + * The name of the fleet. + */ + FleetName: String; + /** + * The identifier of the user. + */ + UserId: StreamingUrlUserId; + /** + * The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. + */ + ApplicationId?: String; + /** + * The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds. + */ + Validity?: Long; + /** + * The session context. For more information, see Session Context in the Amazon AppStream 2.0 Developer Guide. + */ + SessionContext?: String; + } + export interface CreateStreamingURLResult { + /** + * The URL to start the AppStream 2.0 streaming session. + */ + StreamingURL?: String; + /** + * The elapsed time, in seconds after the Unix epoch, when this URL expires. + */ + Expires?: Timestamp; + } + export interface CreateUserRequest { + /** + * The email address of the user. + */ + UserName: Username; + /** + * The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email. + */ + MessageAction?: MessageAction; + /** + * The first name, or given name, of the user. + */ + FirstName?: UserAttributeValue; + /** + * The last name, or surname, of the user. + */ + LastName?: UserAttributeValue; + /** + * The authentication type for the user. You must specify USERPOOL. + */ + AuthenticationType: AuthenticationType; + } + export interface CreateUserResult { + } + export interface DeleteDirectoryConfigRequest { + /** + * The name of the directory configuration. + */ + DirectoryName: DirectoryName; + } + export interface DeleteDirectoryConfigResult { + } + export interface DeleteFleetRequest { + /** + * The name of the fleet. + */ + Name: String; + } + export interface DeleteFleetResult { + } + export interface DeleteImageBuilderRequest { + /** + * The name of the image builder. + */ + Name: Name; + } + export interface DeleteImageBuilderResult { + /** + * Information about the image builder. + */ + ImageBuilder?: ImageBuilder; + } + export interface DeleteImagePermissionsRequest { + /** + * The name of the private image. + */ + Name: Name; + /** + * The 12-digit identifier of the AWS account for which to delete image permissions. + */ + SharedAccountId: AwsAccountId; + } + export interface DeleteImagePermissionsResult { + } + export interface DeleteImageRequest { + /** + * The name of the image. + */ + Name: Name; + } + export interface DeleteImageResult { + /** + * Information about the image. + */ + Image?: Image; + } + export interface DeleteStackRequest { + /** + * The name of the stack. + */ + Name: String; + } + export interface DeleteStackResult { + } + export interface DeleteUserRequest { + /** + * The email address of the user. + */ + UserName: Username; + /** + * The authentication type for the user. You must specify USERPOOL. + */ + AuthenticationType: AuthenticationType; + } + export interface DeleteUserResult { + } + export interface DescribeDirectoryConfigsRequest { + /** + * The directory names. + */ + DirectoryNames?: DirectoryNameList; + /** + * The maximum size of each page of results. + */ + MaxResults?: Integer; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface DescribeDirectoryConfigsResult { + /** + * Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response. + */ + DirectoryConfigs?: DirectoryConfigList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface DescribeFleetsRequest { + /** + * The names of the fleets to describe. + */ + Names?: StringList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface DescribeFleetsResult { + /** + * Information about the fleets. + */ + Fleets?: FleetList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface DescribeImageBuildersRequest { + /** + * The names of the image builders to describe. + */ + Names?: StringList; + /** + * The maximum size of each page of results. + */ + MaxResults?: Integer; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface DescribeImageBuildersResult { + /** + * Information about the image builders. + */ + ImageBuilders?: ImageBuilderList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface DescribeImagePermissionsRequest { + /** + * The name of the private image for which to describe permissions. The image must be one that you own. + */ + Name: Name; + /** + * The maximum size of each page of results. + */ + MaxResults?: MaxResults; + /** + * The 12-digit identifier of one or more AWS accounts with which the image is shared. + */ + SharedAwsAccountIds?: AwsAccountIdList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface DescribeImagePermissionsResult { + /** + * The name of the private image. + */ + Name?: Name; + /** + * The permissions for a private image that you own. + */ + SharedImagePermissionsList?: SharedImagePermissionsList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export type DescribeImagesMaxResults = number; + export interface DescribeImagesRequest { + /** + * The names of the public or private images to describe. + */ + Names?: StringList; + /** + * The ARNs of the public, private, and shared images to describe. + */ + Arns?: ArnList; + /** + * The type of image (public, private, or shared) to describe. + */ + Type?: VisibilityType; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + /** + * The maximum size of each page of results. + */ + MaxResults?: DescribeImagesMaxResults; + } + export interface DescribeImagesResult { + /** + * Information about the images. + */ + Images?: ImageList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface DescribeSessionsRequest { + /** + * The name of the stack. This value is case-sensitive. + */ + StackName: String; + /** + * The name of the fleet. This value is case-sensitive. + */ + FleetName: String; + /** + * The user identifier. + */ + UserId?: UserId; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + /** + * The size of each page of results. The default value is 20 and the maximum value is 50. + */ + Limit?: Integer; + /** + * The authentication method. Specify API for a user authenticated using a streaming URL, SAML for a SAML 2.0-federated user, or USERPOOL for a user in the AppStream 2.0 user pool. The default is to authenticate users using a streaming URL. + */ + AuthenticationType?: AuthenticationType; + } + export interface DescribeSessionsResult { + /** + * Information about the streaming sessions. + */ + Sessions?: SessionList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface DescribeStacksRequest { + /** + * The names of the stacks to describe. + */ + Names?: StringList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface DescribeStacksResult { + /** + * Information about the stacks. + */ + Stacks?: StackList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface DescribeUserStackAssociationsRequest { + /** + * The name of the stack that is associated with the user. + */ + StackName?: String; + /** + * The email address of the user who is associated with the stack. + */ + UserName?: Username; + /** + * The authentication type for the user who is associated with the stack. You must specify USERPOOL. + */ + AuthenticationType?: AuthenticationType; + /** + * The maximum size of each page of results. + */ + MaxResults?: MaxResults; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface DescribeUserStackAssociationsResult { + /** + * The UserStackAssociation objects. + */ + UserStackAssociations?: UserStackAssociationList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface DescribeUsersRequest { + /** + * The authentication type for the users in the user pool to describe. You must specify USERPOOL. + */ + AuthenticationType: AuthenticationType; + /** + * The maximum size of each page of results. + */ + MaxResults?: Integer; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface DescribeUsersResult { + /** + * Information about users in the user pool. + */ + Users?: UserList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export type Description = string; + export interface DirectoryConfig { + /** + * The fully qualified name of the directory (for example, corp.example.com). + */ + DirectoryName: DirectoryName; + /** + * The distinguished names of the organizational units for computer accounts. + */ + OrganizationalUnitDistinguishedNames?: OrganizationalUnitDistinguishedNamesList; + /** + * The credentials for the service account used by the streaming instance to connect to the directory. + */ + ServiceAccountCredentials?: ServiceAccountCredentials; + /** + * The time the directory configuration was created. + */ + CreatedTime?: Timestamp; + } + export type DirectoryConfigList = DirectoryConfig[]; + export type DirectoryName = string; + export type DirectoryNameList = DirectoryName[]; + export interface DisableUserRequest { + /** + * The email address of the user. + */ + UserName: Username; + /** + * The authentication type for the user. You must specify USERPOOL. + */ + AuthenticationType: AuthenticationType; + } + export interface DisableUserResult { + } + export interface DisassociateFleetRequest { + /** + * The name of the fleet. + */ + FleetName: String; + /** + * The name of the stack. + */ + StackName: String; + } + export interface DisassociateFleetResult { + } + export type DisplayName = string; + export type Domain = string; + export interface DomainJoinInfo { + /** + * The fully qualified name of the directory (for example, corp.example.com). + */ + DirectoryName?: DirectoryName; + /** + * The distinguished name of the organizational unit for computer accounts. + */ + OrganizationalUnitDistinguishedName?: OrganizationalUnitDistinguishedName; + } + export type DomainList = Domain[]; + export interface EnableUserRequest { + /** + * The email address of the user. + */ + UserName: Username; + /** + * The authentication type for the user. You must specify USERPOOL. + */ + AuthenticationType: AuthenticationType; + } + export interface EnableUserResult { + } + export interface ExpireSessionRequest { + /** + * The identifier of the streaming session. + */ + SessionId: String; + } + export interface ExpireSessionResult { + } + export type FeedbackURL = string; + export interface Fleet { + /** + * The ARN for the fleet. + */ + Arn: Arn; + /** + * The name of the fleet. + */ + Name: String; + /** + * The fleet name to display. + */ + DisplayName?: String; + /** + * The description to display. + */ + Description?: String; + /** + * The name of the image used to create the fleet. + */ + ImageName?: String; + /** + * The ARN for the public, private, or shared image. + */ + ImageArn?: Arn; + /** + * The instance type to use when launching fleet instances. + */ + InstanceType: String; + /** + * The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps. ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps. + */ + FleetType?: FleetType; + /** + * The capacity status for the fleet. + */ + ComputeCapacityStatus: ComputeCapacityStatus; + /** + * The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 360000. + */ + MaxUserDurationInSeconds?: Integer; + /** + * 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 360000. By default, this value is 900 seconds (15 minutes). + */ + DisconnectTimeoutInSeconds?: Integer; + /** + * The current state for the fleet. + */ + State: FleetState; + /** + * The VPC configuration for the fleet. + */ + VpcConfig?: VpcConfig; + /** + * The time the fleet was created. + */ + CreatedTime?: Timestamp; + /** + * The fleet errors. + */ + FleetErrors?: FleetErrors; + /** + * Indicates whether default internet access is enabled for the fleet. + */ + EnableDefaultInternetAccess?: BooleanObject; + /** + * The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. + */ + DomainJoinInfo?: DomainJoinInfo; + } + export type FleetAttribute = "VPC_CONFIGURATION"|"VPC_CONFIGURATION_SECURITY_GROUP_IDS"|"DOMAIN_JOIN_INFO"|string; + export type FleetAttributes = FleetAttribute[]; + export interface FleetError { + /** + * The error code. + */ + ErrorCode?: FleetErrorCode; + /** + * The error message. + */ + ErrorMessage?: String; + } + export type FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"|"NETWORK_INTERFACE_LIMIT_EXCEEDED"|"INTERNAL_SERVICE_ERROR"|"IAM_SERVICE_ROLE_IS_MISSING"|"SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"|"SUBNET_NOT_FOUND"|"IMAGE_NOT_FOUND"|"INVALID_SUBNET_CONFIGURATION"|"SECURITY_GROUPS_NOT_FOUND"|"IGW_NOT_ATTACHED"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"|"DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"|"DOMAIN_JOIN_ERROR_ACCESS_DENIED"|"DOMAIN_JOIN_ERROR_LOGON_FAILURE"|"DOMAIN_JOIN_ERROR_INVALID_PARAMETER"|"DOMAIN_JOIN_ERROR_MORE_DATA"|"DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"|"DOMAIN_JOIN_ERROR_NOT_SUPPORTED"|"DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"|"DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"|"DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"|"DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"|"DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"|string; + export type FleetErrors = FleetError[]; + export type FleetList = Fleet[]; + export type FleetState = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|string; + export type FleetType = "ALWAYS_ON"|"ON_DEMAND"|string; + export interface Image { + /** + * The name of the image. + */ + Name: String; + /** + * The ARN of the image. + */ + Arn?: Arn; + /** + * The ARN of the image from which this image was created. + */ + BaseImageArn?: Arn; + /** + * The image name to display. + */ + DisplayName?: String; + /** + * The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED. + */ + State?: ImageState; + /** + * Indicates whether the image is public or private. + */ + Visibility?: VisibilityType; + /** + * Indicates whether an image builder can be launched from this image. + */ + ImageBuilderSupported?: Boolean; + /** + * The operating system platform of the image. + */ + Platform?: PlatformType; + /** + * The description to display. + */ + Description?: String; + /** + * The reason why the last state change occurred. + */ + StateChangeReason?: ImageStateChangeReason; + /** + * The applications associated with the image. + */ + Applications?: Applications; + /** + * The time the image was created. + */ + CreatedTime?: Timestamp; + /** + * The release date of the public base image. For private images, this date is the release date of the base image from which the image was created. + */ + PublicBaseImageReleasedDate?: Timestamp; + /** + * The version of the AppStream 2.0 agent to use for instances that are launched from this image. + */ + AppstreamAgentVersion?: AppstreamAgentVersion; + /** + * The permissions to provide to the destination AWS account for the specified image. + */ + ImagePermissions?: ImagePermissions; + } + export interface ImageBuilder { + /** + * The name of the image builder. + */ + Name: String; + /** + * The ARN for the image builder. + */ + Arn?: Arn; + /** + * The ARN of the image from which this builder was created. + */ + ImageArn?: Arn; + /** + * The description to display. + */ + Description?: String; + /** + * The image builder name to display. + */ + DisplayName?: String; + /** + * The VPC configuration of the image builder. + */ + VpcConfig?: VpcConfig; + /** + * The instance type for the image builder. + */ + InstanceType?: String; + /** + * The operating system platform of the image builder. + */ + Platform?: PlatformType; + /** + * The state of the image builder. + */ + State?: ImageBuilderState; + /** + * The reason why the last state change occurred. + */ + StateChangeReason?: ImageBuilderStateChangeReason; + /** + * The time stamp when the image builder was created. + */ + CreatedTime?: Timestamp; + /** + * Enables or disables default internet access for the image builder. + */ + EnableDefaultInternetAccess?: BooleanObject; + /** + * The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. + */ + DomainJoinInfo?: DomainJoinInfo; + /** + * The image builder errors. + */ + ImageBuilderErrors?: ResourceErrors; + /** + * The version of the AppStream 2.0 agent that is currently being used by the image builder. + */ + AppstreamAgentVersion?: AppstreamAgentVersion; + } + export type ImageBuilderList = ImageBuilder[]; + export type ImageBuilderState = "PENDING"|"UPDATING_AGENT"|"RUNNING"|"STOPPING"|"STOPPED"|"REBOOTING"|"SNAPSHOTTING"|"DELETING"|"FAILED"|string; + export interface ImageBuilderStateChangeReason { + /** + * The state change reason code. + */ + Code?: ImageBuilderStateChangeReasonCode; + /** + * The state change reason message. + */ + Message?: String; + } + export type ImageBuilderStateChangeReasonCode = "INTERNAL_ERROR"|"IMAGE_UNAVAILABLE"|string; + export type ImageList = Image[]; + export interface ImagePermissions { + /** + * Indicates whether the image can be used for a fleet. + */ + allowFleet?: BooleanObject; + /** + * Indicates whether the image can be used for an image builder. + */ + allowImageBuilder?: BooleanObject; + } + export type ImageState = "PENDING"|"AVAILABLE"|"FAILED"|"COPYING"|"DELETING"|string; + export interface ImageStateChangeReason { + /** + * The state change reason code. + */ + Code?: ImageStateChangeReasonCode; + /** + * The state change reason message. + */ + Message?: String; + } + export type ImageStateChangeReasonCode = "INTERNAL_ERROR"|"IMAGE_BUILDER_NOT_AVAILABLE"|"IMAGE_COPY_FAILURE"|string; + export type Integer = number; + export interface ListAssociatedFleetsRequest { + /** + * The name of the stack. + */ + StackName: String; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface ListAssociatedFleetsResult { + /** + * The name of the fleet. + */ + Names?: StringList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface ListAssociatedStacksRequest { + /** + * The name of the fleet. + */ + FleetName: String; + /** + * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: String; + } + export interface ListAssociatedStacksResult { + /** + * The name of the stack. + */ + Names?: StringList; + /** + * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: String; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArn: Arn; + } + export interface ListTagsForResourceResponse { + /** + * The information about the tags. + */ + Tags?: Tags; + } + export type Long = number; + export type MaxResults = number; + export type MessageAction = "SUPPRESS"|"RESEND"|string; + export type Metadata = {[key: string]: String}; + export type Name = string; + export interface NetworkAccessConfiguration { + /** + * The private IP address of the elastic network interface that is attached to instances in your VPC. + */ + EniPrivateIpAddress?: String; + /** + * The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier. + */ + EniId?: String; + } + export type OrganizationalUnitDistinguishedName = string; + export type OrganizationalUnitDistinguishedNamesList = OrganizationalUnitDistinguishedName[]; + export type Permission = "ENABLED"|"DISABLED"|string; + export type PlatformType = "WINDOWS"|string; + export type RedirectURL = string; + export type RegionName = string; + export interface ResourceError { + /** + * The error code. + */ + ErrorCode?: FleetErrorCode; + /** + * The error message. + */ + ErrorMessage?: String; + /** + * The time the error occurred. + */ + ErrorTimestamp?: Timestamp; + } + export type ResourceErrors = ResourceError[]; + export type ResourceIdentifier = string; + export type SecurityGroupIdList = String[]; + export interface ServiceAccountCredentials { + /** + * The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified. + */ + AccountName: AccountName; + /** + * The password for the account. + */ + AccountPassword: AccountPassword; + } + export interface Session { + /** + * The identifier of the streaming session. + */ + Id: String; + /** + * The identifier of the user for whom the session was created. + */ + UserId: UserId; + /** + * The name of the stack for the streaming session. + */ + StackName: String; + /** + * The name of the fleet for the streaming session. + */ + FleetName: String; + /** + * The current state of the streaming session. + */ + State: SessionState; + /** + * Specifies whether a user is connected to the streaming session. + */ + ConnectionState?: SessionConnectionState; + /** + * The time when a streaming instance is dedicated for the user. + */ + StartTime?: Timestamp; + /** + * The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends. + */ + MaxExpirationTime?: Timestamp; + /** + * The authentication method. The user is authenticated using a streaming URL (API), SAML 2.0 federation (SAML), or the AppStream 2.0 user pool (USERPOOL). The default is to authenticate users using a streaming URL. + */ + AuthenticationType?: AuthenticationType; + /** + * The network details for the streaming session. + */ + NetworkAccessConfiguration?: NetworkAccessConfiguration; + } + export type SessionConnectionState = "CONNECTED"|"NOT_CONNECTED"|string; + export type SessionList = Session[]; + export type SessionState = "ACTIVE"|"PENDING"|"EXPIRED"|string; + export type SettingsGroup = string; + export interface SharedImagePermissions { + /** + * The 12-digit identifier of the AWS account with which the image is shared. + */ + sharedAccountId: AwsAccountId; + /** + * Describes the permissions for a shared image. + */ + imagePermissions: ImagePermissions; + } + export type SharedImagePermissionsList = SharedImagePermissions[]; + export interface Stack { + /** + * The ARN of the stack. + */ + Arn?: Arn; + /** + * The name of the stack. + */ + Name: String; + /** + * The description to display. + */ + Description?: String; + /** + * The stack name to display. + */ + DisplayName?: String; + /** + * The time the stack was created. + */ + CreatedTime?: Timestamp; + /** + * The storage connectors to enable. + */ + StorageConnectors?: StorageConnectorList; + /** + * The URL that users are redirected to after their streaming session ends. + */ + RedirectURL?: RedirectURL; + /** + * 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. + */ + FeedbackURL?: FeedbackURL; + /** + * The errors for the stack. + */ + StackErrors?: StackErrors; + /** + * The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled. + */ + UserSettings?: UserSettingList; + /** + * The persistent application settings for users of the stack. + */ + ApplicationSettings?: ApplicationSettingsResponse; + } + export type StackAttribute = "STORAGE_CONNECTORS"|"STORAGE_CONNECTOR_HOMEFOLDERS"|"STORAGE_CONNECTOR_GOOGLE_DRIVE"|"STORAGE_CONNECTOR_ONE_DRIVE"|"REDIRECT_URL"|"FEEDBACK_URL"|"THEME_NAME"|"USER_SETTINGS"|string; + export type StackAttributes = StackAttribute[]; + export interface StackError { + /** + * The error code. + */ + ErrorCode?: StackErrorCode; + /** + * The error message. + */ + ErrorMessage?: String; + } + export type StackErrorCode = "STORAGE_CONNECTOR_ERROR"|"INTERNAL_SERVICE_ERROR"|string; + export type StackErrors = StackError[]; + export type StackList = Stack[]; + export interface StartFleetRequest { + /** + * The name of the fleet. + */ + Name: String; + } + export interface StartFleetResult { + } + export interface StartImageBuilderRequest { + /** + * The name of the image builder. + */ + Name: String; + /** + * The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. + */ + AppstreamAgentVersion?: AppstreamAgentVersion; + } + export interface StartImageBuilderResult { + /** + * Information about the image builder. + */ + ImageBuilder?: ImageBuilder; + } + export interface StopFleetRequest { + /** + * The name of the fleet. + */ + Name: String; + } + export interface StopFleetResult { + } + export interface StopImageBuilderRequest { + /** + * The name of the image builder. + */ + Name: String; + } + export interface StopImageBuilderResult { + /** + * Information about the image builder. + */ + ImageBuilder?: ImageBuilder; + } + export interface StorageConnector { + /** + * The type of storage connector. + */ + ConnectorType: StorageConnectorType; + /** + * The ARN of the storage connector. + */ + ResourceIdentifier?: ResourceIdentifier; + /** + * The names of the domains for the account. + */ + Domains?: DomainList; + } + export type StorageConnectorList = StorageConnector[]; + export type StorageConnectorType = "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE"|string; + export type StreamingUrlUserId = string; + export type String = string; + export type StringList = String[]; + export type SubnetIdList = String[]; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArn: Arn; + /** + * The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. + */ + Tags: Tags; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export type Timestamp = Date; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArn: Arn; + /** + * The tag keys for the tags to disassociate. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateDirectoryConfigRequest { + /** + * The name of the Directory Config object. + */ + DirectoryName: DirectoryName; + /** + * The distinguished names of the organizational units for computer accounts. + */ + OrganizationalUnitDistinguishedNames?: OrganizationalUnitDistinguishedNamesList; + /** + * The credentials for the service account used by the streaming instance to connect to the directory. + */ + ServiceAccountCredentials?: ServiceAccountCredentials; + } + export interface UpdateDirectoryConfigResult { + /** + * Information about the Directory Config object. + */ + DirectoryConfig?: DirectoryConfig; + } + export interface UpdateFleetRequest { + /** + * The name of the image used to create the fleet. + */ + ImageName?: String; + /** + * The ARN of the public, private, or shared image to use. + */ + ImageArn?: Arn; + /** + * A unique name for the fleet. + */ + Name?: String; + /** + * The instance type to use when launching fleet instances. The following instance types are available: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge + */ + InstanceType?: String; + /** + * The desired capacity for the fleet. + */ + ComputeCapacity?: ComputeCapacity; + /** + * The VPC configuration for the fleet. + */ + VpcConfig?: VpcConfig; + /** + * The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 360000. By default, the value is 900 seconds (15 minutes). + */ + MaxUserDurationInSeconds?: Integer; + /** + * 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 360000. By default, the value is 900 seconds (15 minutes). + */ + DisconnectTimeoutInSeconds?: Integer; + /** + * Deletes the VPC association for the specified fleet. + */ + DeleteVpcConfig?: Boolean; + /** + * The description to display. + */ + Description?: Description; + /** + * The fleet name to display. + */ + DisplayName?: DisplayName; + /** + * Enables or disables default internet access for the fleet. + */ + EnableDefaultInternetAccess?: BooleanObject; + /** + * The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. + */ + DomainJoinInfo?: DomainJoinInfo; + /** + * The fleet attributes to delete. + */ + AttributesToDelete?: FleetAttributes; + } + export interface UpdateFleetResult { + /** + * Information about the fleet. + */ + Fleet?: Fleet; + } + export interface UpdateImagePermissionsRequest { + /** + * The name of the private image. + */ + Name: Name; + /** + * The 12-digit identifier of the AWS account for which you want add or update image permissions. + */ + SharedAccountId: AwsAccountId; + /** + * The permissions for the image. + */ + ImagePermissions: ImagePermissions; + } + export interface UpdateImagePermissionsResult { + } + export interface UpdateStackRequest { + /** + * The stack name to display. + */ + DisplayName?: DisplayName; + /** + * The description to display. + */ + Description?: Description; + /** + * The name of the stack. + */ + Name: String; + /** + * The storage connectors to enable. + */ + StorageConnectors?: StorageConnectorList; + /** + * Deletes the storage connectors currently enabled for the stack. + */ + DeleteStorageConnectors?: Boolean; + /** + * The URL that users are redirected to after their streaming session ends. + */ + RedirectURL?: RedirectURL; + /** + * The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed. + */ + FeedbackURL?: FeedbackURL; + /** + * The stack attributes to delete. + */ + AttributesToDelete?: StackAttributes; + /** + * The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. + */ + UserSettings?: UserSettingList; + /** + * The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session. + */ + ApplicationSettings?: ApplicationSettings; + } + export interface UpdateStackResult { + /** + * Information about the stack. + */ + Stack?: Stack; + } + export interface User { + /** + * The ARN of the user. + */ + Arn?: Arn; + /** + * The email address of the user. + */ + UserName?: Username; + /** + * Specifies whether the user in the user pool is enabled. + */ + Enabled?: Boolean; + /** + * The status of the user in the user pool. The status can be one of the following: UNCONFIRMED – The user is created but not confirmed. CONFIRMED – The user is confirmed. ARCHIVED – The user is no longer active. COMPROMISED – The user is disabled because of a potential security threat. UNKNOWN – The user status is not known. + */ + Status?: String; + /** + * The first name, or given name, of the user. + */ + FirstName?: UserAttributeValue; + /** + * The last name, or surname, of the user. + */ + LastName?: UserAttributeValue; + /** + * The date and time the user was created in the user pool. + */ + CreatedTime?: Timestamp; + /** + * The authentication type for the user. + */ + AuthenticationType: AuthenticationType; + } + export type UserAttributeValue = string; + export type UserId = string; + export type UserList = User[]; + export interface UserSetting { + /** + * The action that is enabled or disabled. + */ + Action: Action; + /** + * Indicates whether the action is enabled or disabled. + */ + Permission: Permission; + } + export type UserSettingList = UserSetting[]; + export interface UserStackAssociation { + /** + * The name of the stack that is associated with the user. + */ + StackName: String; + /** + * The email address of the user who is associated with the stack. + */ + UserName: Username; + /** + * The authentication type for the user. + */ + AuthenticationType: AuthenticationType; + /** + * Specifies whether a welcome email is sent to a user after the user is created in the user pool. + */ + SendEmailNotification?: Boolean; + } + export interface UserStackAssociationError { + /** + * Information about the user and associated stack. + */ + UserStackAssociation?: UserStackAssociation; + /** + * The error code for the error that is returned when a user can’t be associated with or disassociated from a stack. + */ + ErrorCode?: UserStackAssociationErrorCode; + /** + * The error message for the error that is returned when a user can’t be associated with or disassociated from a stack. + */ + ErrorMessage?: String; + } + export type UserStackAssociationErrorCode = "STACK_NOT_FOUND"|"USER_NAME_NOT_FOUND"|"INTERNAL_ERROR"|string; + export type UserStackAssociationErrorList = UserStackAssociationError[]; + export type UserStackAssociationList = UserStackAssociation[]; + export type Username = string; + export type VisibilityType = "PUBLIC"|"PRIVATE"|"SHARED"|string; + export interface VpcConfig { + /** + * The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet. + */ + SubnetIds?: SubnetIdList; + /** + * The identifiers of the security groups for the fleet or image builder. + */ + SecurityGroupIds?: SecurityGroupIdList; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-12-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the AppStream client. + */ + export import Types = AppStream; +} +export = AppStream; diff --git a/node_modules/aws-sdk/clients/appstream.js b/node_modules/aws-sdk/clients/appstream.js new file mode 100644 index 0000000..6313e40 --- /dev/null +++ b/node_modules/aws-sdk/clients/appstream.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['appstream'] = {}; +AWS.AppStream = Service.defineService('appstream', ['2016-12-01']); +Object.defineProperty(apiLoader.services['appstream'], '2016-12-01', { + get: function get() { + var model = require('../apis/appstream-2016-12-01.min.json'); + model.paginators = require('../apis/appstream-2016-12-01.paginators.json').pagination; + model.waiters = require('../apis/appstream-2016-12-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.AppStream; diff --git a/node_modules/aws-sdk/clients/appsync.d.ts b/node_modules/aws-sdk/clients/appsync.d.ts new file mode 100644 index 0000000..3125429 --- /dev/null +++ b/node_modules/aws-sdk/clients/appsync.d.ts @@ -0,0 +1,1545 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class AppSync extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: AppSync.Types.ClientConfiguration) + config: Config & AppSync.Types.ClientConfiguration; + /** + * Creates a unique key that you can distribute to clients who are executing your API. + */ + createApiKey(params: AppSync.Types.CreateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request; + /** + * Creates a unique key that you can distribute to clients who are executing your API. + */ + createApiKey(callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request; + /** + * Creates a DataSource object. + */ + createDataSource(params: AppSync.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request; + /** + * Creates a DataSource object. + */ + createDataSource(callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request; + /** + * Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic. + */ + createFunction(params: AppSync.Types.CreateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request; + /** + * Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic. + */ + createFunction(callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request; + /** + * Creates a GraphqlApi object. + */ + createGraphqlApi(params: AppSync.Types.CreateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request; + /** + * Creates a GraphqlApi object. + */ + createGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request; + /** + * Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL. + */ + createResolver(params: AppSync.Types.CreateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request; + /** + * Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL. + */ + createResolver(callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request; + /** + * Creates a Type object. + */ + createType(params: AppSync.Types.CreateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request; + /** + * Creates a Type object. + */ + createType(callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request; + /** + * Deletes an API key. + */ + deleteApiKey(params: AppSync.Types.DeleteApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request; + /** + * Deletes an API key. + */ + deleteApiKey(callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request; + /** + * Deletes a DataSource object. + */ + deleteDataSource(params: AppSync.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request; + /** + * Deletes a DataSource object. + */ + deleteDataSource(callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request; + /** + * Deletes a Function. + */ + deleteFunction(params: AppSync.Types.DeleteFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request; + /** + * Deletes a Function. + */ + deleteFunction(callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request; + /** + * Deletes a GraphqlApi object. + */ + deleteGraphqlApi(params: AppSync.Types.DeleteGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request; + /** + * Deletes a GraphqlApi object. + */ + deleteGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request; + /** + * Deletes a Resolver object. + */ + deleteResolver(params: AppSync.Types.DeleteResolverRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request; + /** + * Deletes a Resolver object. + */ + deleteResolver(callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request; + /** + * Deletes a Type object. + */ + deleteType(params: AppSync.Types.DeleteTypeRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request; + /** + * Deletes a Type object. + */ + deleteType(callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request; + /** + * Retrieves a DataSource object. + */ + getDataSource(params: AppSync.Types.GetDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request; + /** + * Retrieves a DataSource object. + */ + getDataSource(callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request; + /** + * Get a Function. + */ + getFunction(params: AppSync.Types.GetFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request; + /** + * Get a Function. + */ + getFunction(callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request; + /** + * Retrieves a GraphqlApi object. + */ + getGraphqlApi(params: AppSync.Types.GetGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request; + /** + * Retrieves a GraphqlApi object. + */ + getGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request; + /** + * Retrieves the introspection schema for a GraphQL API. + */ + getIntrospectionSchema(params: AppSync.Types.GetIntrospectionSchemaRequest, callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request; + /** + * Retrieves the introspection schema for a GraphQL API. + */ + getIntrospectionSchema(callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request; + /** + * Retrieves a Resolver object. + */ + getResolver(params: AppSync.Types.GetResolverRequest, callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request; + /** + * Retrieves a Resolver object. + */ + getResolver(callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request; + /** + * Retrieves the current status of a schema creation operation. + */ + getSchemaCreationStatus(params: AppSync.Types.GetSchemaCreationStatusRequest, callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request; + /** + * Retrieves the current status of a schema creation operation. + */ + getSchemaCreationStatus(callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request; + /** + * Retrieves a Type object. + */ + getType(params: AppSync.Types.GetTypeRequest, callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request; + /** + * Retrieves a Type object. + */ + getType(callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request; + /** + * Lists the API keys for a given API. 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 DeleteApiKey to manually delete a key before it's automatically deleted. + */ + listApiKeys(params: AppSync.Types.ListApiKeysRequest, callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request; + /** + * Lists the API keys for a given API. 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 DeleteApiKey to manually delete a key before it's automatically deleted. + */ + listApiKeys(callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request; + /** + * Lists the data sources for a given API. + */ + listDataSources(params: AppSync.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request; + /** + * Lists the data sources for a given API. + */ + listDataSources(callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request; + /** + * List multiple functions. + */ + listFunctions(params: AppSync.Types.ListFunctionsRequest, callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request; + /** + * List multiple functions. + */ + listFunctions(callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request; + /** + * Lists your GraphQL APIs. + */ + listGraphqlApis(params: AppSync.Types.ListGraphqlApisRequest, callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request; + /** + * Lists your GraphQL APIs. + */ + listGraphqlApis(callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request; + /** + * Lists the resolvers for a given API and type. + */ + listResolvers(params: AppSync.Types.ListResolversRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request; + /** + * Lists the resolvers for a given API and type. + */ + listResolvers(callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request; + /** + * List the resolvers that are associated with a specific function. + */ + listResolversByFunction(params: AppSync.Types.ListResolversByFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request; + /** + * List the resolvers that are associated with a specific function. + */ + listResolversByFunction(callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request; + /** + * Lists the tags for a resource. + */ + listTagsForResource(params: AppSync.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags for a resource. + */ + listTagsForResource(callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the types for a given API. + */ + listTypes(params: AppSync.Types.ListTypesRequest, callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request; + /** + * Lists the types for a given API. + */ + listTypes(callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request; + /** + * Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed. + */ + startSchemaCreation(params: AppSync.Types.StartSchemaCreationRequest, callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request; + /** + * Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed. + */ + startSchemaCreation(callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request; + /** + * Tags a resource with user-supplied tags. + */ + tagResource(params: AppSync.Types.TagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request; + /** + * Tags a resource with user-supplied tags. + */ + tagResource(callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request; + /** + * Untags a resource. + */ + untagResource(params: AppSync.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request; + /** + * Untags a resource. + */ + untagResource(callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request; + /** + * Updates an API key. + */ + updateApiKey(params: AppSync.Types.UpdateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request; + /** + * Updates an API key. + */ + updateApiKey(callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request; + /** + * Updates a DataSource object. + */ + updateDataSource(params: AppSync.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request; + /** + * Updates a DataSource object. + */ + updateDataSource(callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request; + /** + * Updates a Function object. + */ + updateFunction(params: AppSync.Types.UpdateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request; + /** + * Updates a Function object. + */ + updateFunction(callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request; + /** + * Updates a GraphqlApi object. + */ + updateGraphqlApi(params: AppSync.Types.UpdateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request; + /** + * Updates a GraphqlApi object. + */ + updateGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request; + /** + * Updates a Resolver object. + */ + updateResolver(params: AppSync.Types.UpdateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request; + /** + * Updates a Resolver object. + */ + updateResolver(callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request; + /** + * Updates a Type object. + */ + updateType(params: AppSync.Types.UpdateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request; + /** + * Updates a Type object. + */ + updateType(callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request; +} +declare namespace AppSync { + export interface AdditionalAuthenticationProvider { + /** + * The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools. + */ + authenticationType?: AuthenticationType; + /** + * The OpenID Connect configuration. + */ + openIDConnectConfig?: OpenIDConnectConfig; + /** + * The Amazon Cognito user pool configuration. + */ + userPoolConfig?: CognitoUserPoolConfig; + } + export type AdditionalAuthenticationProviders = AdditionalAuthenticationProvider[]; + export interface ApiKey { + /** + * The API key ID. + */ + id?: String; + /** + * A description of the purpose of the API key. + */ + description?: String; + /** + * The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. + */ + expires?: Long; + } + export type ApiKeys = ApiKey[]; + export type AuthenticationType = "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|string; + export interface AuthorizationConfig { + /** + * The authorization type required by the HTTP endpoint. AWS_IAM: The authorization type is Sigv4. + */ + authorizationType: AuthorizationType; + /** + * The AWS IAM settings. + */ + awsIamConfig?: AwsIamConfig; + } + export type AuthorizationType = "AWS_IAM"|string; + export interface AwsIamConfig { + /** + * The signing region for AWS IAM authorization. + */ + signingRegion?: String; + /** + * The signing service name for AWS IAM authorization. + */ + signingServiceName?: String; + } + export type _Blob = Buffer|Uint8Array|Blob|string; + export type Boolean = boolean; + export type BooleanValue = boolean; + export interface CognitoUserPoolConfig { + /** + * The user pool ID. + */ + userPoolId: String; + /** + * The AWS Region in which the user pool was created. + */ + awsRegion: String; + /** + * A regular expression for validating the incoming Amazon Cognito user pool app client ID. + */ + appIdClientRegex?: String; + } + export interface CreateApiKeyRequest { + /** + * The ID for your GraphQL API. + */ + apiId: String; + /** + * A description of the purpose of the API key. + */ + description?: String; + /** + * 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 . + */ + expires?: Long; + } + export interface CreateApiKeyResponse { + /** + * The API key. + */ + apiKey?: ApiKey; + } + export interface CreateDataSourceRequest { + /** + * The API ID for the GraphQL API for the DataSource. + */ + apiId: String; + /** + * A user-supplied name for the DataSource. + */ + name: ResourceName; + /** + * A description of the DataSource. + */ + description?: String; + /** + * The type of the DataSource. + */ + type: DataSourceType; + /** + * The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source. + */ + serviceRoleArn?: String; + /** + * Amazon DynamoDB settings. + */ + dynamodbConfig?: DynamodbDataSourceConfig; + /** + * AWS Lambda settings. + */ + lambdaConfig?: LambdaDataSourceConfig; + /** + * Amazon Elasticsearch Service settings. + */ + elasticsearchConfig?: ElasticsearchDataSourceConfig; + /** + * HTTP endpoint settings. + */ + httpConfig?: HttpDataSourceConfig; + /** + * Relational database settings. + */ + relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig; + } + export interface CreateDataSourceResponse { + /** + * The DataSource object. + */ + dataSource?: DataSource; + } + export interface CreateFunctionRequest { + /** + * The GraphQL API ID. + */ + apiId: String; + /** + * The Function name. The function name does not have to be unique. + */ + name: ResourceName; + /** + * The Function description. + */ + description?: String; + /** + * The Function DataSource name. + */ + dataSourceName: ResourceName; + /** + * The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. + */ + requestMappingTemplate: MappingTemplate; + /** + * The Function response mapping template. + */ + responseMappingTemplate?: MappingTemplate; + /** + * The version of the request mapping template. Currently the supported value is 2018-05-29. + */ + functionVersion: String; + } + export interface CreateFunctionResponse { + /** + * The Function object. + */ + functionConfiguration?: FunctionConfiguration; + } + export interface CreateGraphqlApiRequest { + /** + * A user-supplied name for the GraphqlApi. + */ + name: String; + /** + * The Amazon CloudWatch Logs configuration. + */ + logConfig?: LogConfig; + /** + * The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools. + */ + authenticationType: AuthenticationType; + /** + * The Amazon Cognito user pool configuration. + */ + userPoolConfig?: UserPoolConfig; + /** + * The OpenID Connect configuration. + */ + openIDConnectConfig?: OpenIDConnectConfig; + /** + * A TagMap object. + */ + tags?: TagMap; + /** + * A list of additional authentication providers for the GraphqlApi API. + */ + additionalAuthenticationProviders?: AdditionalAuthenticationProviders; + } + export interface CreateGraphqlApiResponse { + /** + * The GraphqlApi. + */ + graphqlApi?: GraphqlApi; + } + export interface CreateResolverRequest { + /** + * The ID for the GraphQL API for which the resolver is being created. + */ + apiId: String; + /** + * The name of the Type. + */ + typeName: ResourceName; + /** + * The name of the field to attach the resolver to. + */ + fieldName: ResourceName; + /** + * The name of the data source for which the resolver is being created. + */ + dataSourceName?: ResourceName; + /** + * The mapping template to be used for requests. A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL). + */ + requestMappingTemplate: MappingTemplate; + /** + * The mapping template to be used for responses from the data source. + */ + responseMappingTemplate?: MappingTemplate; + /** + * The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources. + */ + kind?: ResolverKind; + /** + * The PipelineConfig. + */ + pipelineConfig?: PipelineConfig; + } + export interface CreateResolverResponse { + /** + * The Resolver object. + */ + resolver?: Resolver; + } + export interface CreateTypeRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The type definition, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation. + */ + definition: String; + /** + * The type format: SDL or JSON. + */ + format: TypeDefinitionFormat; + } + export interface CreateTypeResponse { + /** + * The Type object. + */ + type?: Type; + } + export interface DataSource { + /** + * The data source ARN. + */ + dataSourceArn?: String; + /** + * The name of the data source. + */ + name?: ResourceName; + /** + * The description of the data source. + */ + description?: String; + /** + * The type of the data source. AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table. AMAZON_ELASTICSEARCH: The data source is an Amazon Elasticsearch Service domain. AWS_LAMBDA: The data source is an AWS Lambda function. NONE: There is no data source. This type is used 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. HTTP: The data source is an HTTP endpoint. RELATIONAL_DATABASE: The data source is a relational database. + */ + type?: DataSourceType; + /** + * The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source. + */ + serviceRoleArn?: String; + /** + * Amazon DynamoDB settings. + */ + dynamodbConfig?: DynamodbDataSourceConfig; + /** + * AWS Lambda settings. + */ + lambdaConfig?: LambdaDataSourceConfig; + /** + * Amazon Elasticsearch Service settings. + */ + elasticsearchConfig?: ElasticsearchDataSourceConfig; + /** + * HTTP endpoint settings. + */ + httpConfig?: HttpDataSourceConfig; + /** + * Relational database settings. + */ + relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig; + } + export type DataSourceType = "AWS_LAMBDA"|"AMAZON_DYNAMODB"|"AMAZON_ELASTICSEARCH"|"NONE"|"HTTP"|"RELATIONAL_DATABASE"|string; + export type DataSources = DataSource[]; + export type DefaultAction = "ALLOW"|"DENY"|string; + export interface DeleteApiKeyRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The ID for the API key. + */ + id: String; + } + export interface DeleteApiKeyResponse { + } + export interface DeleteDataSourceRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The name of the data source. + */ + name: ResourceName; + } + export interface DeleteDataSourceResponse { + } + export interface DeleteFunctionRequest { + /** + * The GraphQL API ID. + */ + apiId: String; + /** + * The Function ID. + */ + functionId: ResourceName; + } + export interface DeleteFunctionResponse { + } + export interface DeleteGraphqlApiRequest { + /** + * The API ID. + */ + apiId: String; + } + export interface DeleteGraphqlApiResponse { + } + export interface DeleteResolverRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The name of the resolver type. + */ + typeName: ResourceName; + /** + * The resolver field name. + */ + fieldName: ResourceName; + } + export interface DeleteResolverResponse { + } + export interface DeleteTypeRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The type name. + */ + typeName: ResourceName; + } + export interface DeleteTypeResponse { + } + export interface DynamodbDataSourceConfig { + /** + * The table name. + */ + tableName: String; + /** + * The AWS Region. + */ + awsRegion: String; + /** + * Set to TRUE to use Amazon Cognito credentials with this data source. + */ + useCallerCredentials?: Boolean; + } + export interface ElasticsearchDataSourceConfig { + /** + * The endpoint. + */ + endpoint: String; + /** + * The AWS Region. + */ + awsRegion: String; + } + export type FieldLogLevel = "NONE"|"ERROR"|"ALL"|string; + export interface FunctionConfiguration { + /** + * A unique ID representing the Function object. + */ + functionId?: String; + /** + * The ARN of the Function object. + */ + functionArn?: String; + /** + * The name of the Function object. + */ + name?: ResourceName; + /** + * The Function description. + */ + description?: String; + /** + * The name of the DataSource. + */ + dataSourceName?: ResourceName; + /** + * The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. + */ + requestMappingTemplate?: MappingTemplate; + /** + * The Function response mapping template. + */ + responseMappingTemplate?: MappingTemplate; + /** + * The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported. + */ + functionVersion?: String; + } + export type Functions = FunctionConfiguration[]; + export type FunctionsIds = String[]; + export interface GetDataSourceRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The name of the data source. + */ + name: ResourceName; + } + export interface GetDataSourceResponse { + /** + * The DataSource object. + */ + dataSource?: DataSource; + } + export interface GetFunctionRequest { + /** + * The GraphQL API ID. + */ + apiId: String; + /** + * The Function ID. + */ + functionId: ResourceName; + } + export interface GetFunctionResponse { + /** + * The Function object. + */ + functionConfiguration?: FunctionConfiguration; + } + export interface GetGraphqlApiRequest { + /** + * The API ID for the GraphQL API. + */ + apiId: String; + } + export interface GetGraphqlApiResponse { + /** + * The GraphqlApi object. + */ + graphqlApi?: GraphqlApi; + } + export interface GetIntrospectionSchemaRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The schema format: SDL or JSON. + */ + format: OutputType; + /** + * A flag that specifies whether the schema introspection should contain directives. + */ + includeDirectives?: BooleanValue; + } + export interface GetIntrospectionSchemaResponse { + /** + * The schema, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation. + */ + schema?: _Blob; + } + export interface GetResolverRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The resolver type name. + */ + typeName: ResourceName; + /** + * The resolver field name. + */ + fieldName: ResourceName; + } + export interface GetResolverResponse { + /** + * The Resolver object. + */ + resolver?: Resolver; + } + export interface GetSchemaCreationStatusRequest { + /** + * The API ID. + */ + apiId: String; + } + export interface GetSchemaCreationStatusResponse { + /** + * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data. + */ + status?: SchemaStatus; + /** + * Detailed information about the status of the schema creation operation. + */ + details?: String; + } + export interface GetTypeRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The type name. + */ + typeName: ResourceName; + /** + * The type format: SDL or JSON. + */ + format: TypeDefinitionFormat; + } + export interface GetTypeResponse { + /** + * The Type object. + */ + type?: Type; + } + export interface GraphqlApi { + /** + * The API name. + */ + name?: ResourceName; + /** + * The API ID. + */ + apiId?: String; + /** + * The authentication type. + */ + authenticationType?: AuthenticationType; + /** + * The Amazon CloudWatch Logs configuration. + */ + logConfig?: LogConfig; + /** + * The Amazon Cognito user pool configuration. + */ + userPoolConfig?: UserPoolConfig; + /** + * The OpenID Connect configuration. + */ + openIDConnectConfig?: OpenIDConnectConfig; + /** + * The ARN. + */ + arn?: String; + /** + * The URIs. + */ + uris?: MapOfStringToString; + /** + * The tags. + */ + tags?: TagMap; + /** + * A list of additional authentication providers for the GraphqlApi API. + */ + additionalAuthenticationProviders?: AdditionalAuthenticationProviders; + } + export type GraphqlApis = GraphqlApi[]; + export interface HttpDataSourceConfig { + /** + * The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints. + */ + endpoint?: String; + /** + * The authorization config in case the HTTP endpoint requires authorization. + */ + authorizationConfig?: AuthorizationConfig; + } + export interface LambdaDataSourceConfig { + /** + * The ARN for the Lambda function. + */ + lambdaFunctionArn: String; + } + export interface ListApiKeysRequest { + /** + * The API ID. + */ + apiId: String; + /** + * 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. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results you want the request to return. + */ + maxResults?: MaxResults; + } + export interface ListApiKeysResponse { + /** + * The ApiKey objects. + */ + apiKeys?: ApiKeys; + /** + * An identifier to be passed in the next request to this operation to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListDataSourcesRequest { + /** + * The API ID. + */ + apiId: String; + /** + * 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. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results you want the request to return. + */ + maxResults?: MaxResults; + } + export interface ListDataSourcesResponse { + /** + * The DataSource objects. + */ + dataSources?: DataSources; + /** + * An identifier to be passed in the next request to this operation to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListFunctionsRequest { + /** + * The GraphQL API ID. + */ + apiId: String; + /** + * 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. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results you want the request to return. + */ + maxResults?: MaxResults; + } + export interface ListFunctionsResponse { + /** + * A list of Function objects. + */ + functions?: Functions; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListGraphqlApisRequest { + /** + * 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. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results you want the request to return. + */ + maxResults?: MaxResults; + } + export interface ListGraphqlApisResponse { + /** + * The GraphqlApi objects. + */ + graphqlApis?: GraphqlApis; + /** + * An identifier to be passed in the next request to this operation to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListResolversByFunctionRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The Function ID. + */ + functionId: String; + /** + * An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results you want the request to return. + */ + maxResults?: MaxResults; + } + export interface ListResolversByFunctionResponse { + /** + * The list of resolvers. + */ + resolvers?: Resolvers; + /** + * An identifier that can be used to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListResolversRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The type name. + */ + typeName: String; + /** + * 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. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results you want the request to return. + */ + maxResults?: MaxResults; + } + export interface ListResolversResponse { + /** + * The Resolver objects. + */ + resolvers?: Resolvers; + /** + * An identifier to be passed in the next request to this operation to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListTagsForResourceRequest { + /** + * The GraphqlApi ARN. + */ + resourceArn: ResourceArn; + } + export interface ListTagsForResourceResponse { + /** + * A TagMap object. + */ + tags?: TagMap; + } + export interface ListTypesRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The type format: SDL or JSON. + */ + format: TypeDefinitionFormat; + /** + * 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. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results you want the request to return. + */ + maxResults?: MaxResults; + } + export interface ListTypesResponse { + /** + * The Type objects. + */ + types?: TypeList; + /** + * An identifier to be passed in the next request to this operation to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface LogConfig { + /** + * The field logging level. Values can be NONE, ERROR, or ALL. NONE: No field-level logs are captured. ERROR: Logs the following information only for the fields that are in error: The error section in the server response. Field-level errors. The generated request/response functions that got resolved for error fields. ALL: The following information is logged for all fields in the query: Field-level tracing information. The generated request/response functions that got resolved for each field. + */ + fieldLogLevel: FieldLogLevel; + /** + * The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account. + */ + cloudWatchLogsRoleArn: String; + } + export type Long = number; + export type MapOfStringToString = {[key: string]: String}; + export type MappingTemplate = string; + export type MaxResults = number; + export interface OpenIDConnectConfig { + /** + * The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token. + */ + issuer: String; + /** + * The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time. + */ + clientId?: String; + /** + * The number of milliseconds a token is valid after being issued to a user. + */ + iatTTL?: Long; + /** + * The number of milliseconds a token is valid after being authenticated. + */ + authTTL?: Long; + } + export type OutputType = "SDL"|"JSON"|string; + export type PaginationToken = string; + export interface PipelineConfig { + /** + * A list of Function objects. + */ + functions?: FunctionsIds; + } + export interface RdsHttpEndpointConfig { + /** + * AWS Region for RDS HTTP endpoint. + */ + awsRegion?: String; + /** + * Amazon RDS cluster identifier. + */ + dbClusterIdentifier?: String; + /** + * Logical database name. + */ + databaseName?: String; + /** + * Logical schema name. + */ + schema?: String; + /** + * AWS secret store ARN for database credentials. + */ + awsSecretStoreArn?: String; + } + export interface RelationalDatabaseDataSourceConfig { + /** + * Source type for the relational database. RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint. + */ + relationalDatabaseSourceType?: RelationalDatabaseSourceType; + /** + * Amazon RDS HTTP endpoint settings. + */ + rdsHttpEndpointConfig?: RdsHttpEndpointConfig; + } + export type RelationalDatabaseSourceType = "RDS_HTTP_ENDPOINT"|string; + export interface Resolver { + /** + * The resolver type name. + */ + typeName?: ResourceName; + /** + * The resolver field name. + */ + fieldName?: ResourceName; + /** + * The resolver data source name. + */ + dataSourceName?: ResourceName; + /** + * The resolver ARN. + */ + resolverArn?: String; + /** + * The request mapping template. + */ + requestMappingTemplate?: MappingTemplate; + /** + * The response mapping template. + */ + responseMappingTemplate?: MappingTemplate; + /** + * The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources. + */ + kind?: ResolverKind; + /** + * The PipelineConfig. + */ + pipelineConfig?: PipelineConfig; + } + export type ResolverKind = "UNIT"|"PIPELINE"|string; + export type Resolvers = Resolver[]; + export type ResourceArn = string; + export type ResourceName = string; + export type SchemaStatus = "PROCESSING"|"ACTIVE"|"DELETING"|"FAILED"|"SUCCESS"|"NOT_APPLICABLE"|string; + export interface StartSchemaCreationRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The schema definition, in GraphQL schema language format. + */ + definition: _Blob; + } + export interface StartSchemaCreationResponse { + /** + * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data. + */ + status?: SchemaStatus; + } + export type String = string; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagMap = {[key: string]: TagValue}; + export interface TagResourceRequest { + /** + * The GraphqlApi ARN. + */ + resourceArn: ResourceArn; + /** + * A TagMap object. + */ + tags: TagMap; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export interface Type { + /** + * The type name. + */ + name?: ResourceName; + /** + * The type description. + */ + description?: String; + /** + * The type ARN. + */ + arn?: String; + /** + * The type definition. + */ + definition?: String; + /** + * The type format: SDL or JSON. + */ + format?: TypeDefinitionFormat; + } + export type TypeDefinitionFormat = "SDL"|"JSON"|string; + export type TypeList = Type[]; + export interface UntagResourceRequest { + /** + * The GraphqlApi ARN. + */ + resourceArn: ResourceArn; + /** + * A list of TagKey objects. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateApiKeyRequest { + /** + * The ID for the GraphQL API. + */ + apiId: String; + /** + * The API key ID. + */ + id: String; + /** + * A description of the purpose of the API key. + */ + description?: String; + /** + * The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see . + */ + expires?: Long; + } + export interface UpdateApiKeyResponse { + /** + * The API key. + */ + apiKey?: ApiKey; + } + export interface UpdateDataSourceRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The new name for the data source. + */ + name: ResourceName; + /** + * The new description for the data source. + */ + description?: String; + /** + * The new data source type. + */ + type: DataSourceType; + /** + * The new service role ARN for the data source. + */ + serviceRoleArn?: String; + /** + * The new Amazon DynamoDB configuration. + */ + dynamodbConfig?: DynamodbDataSourceConfig; + /** + * The new AWS Lambda configuration. + */ + lambdaConfig?: LambdaDataSourceConfig; + /** + * The new Elasticsearch Service configuration. + */ + elasticsearchConfig?: ElasticsearchDataSourceConfig; + /** + * The new HTTP endpoint configuration. + */ + httpConfig?: HttpDataSourceConfig; + /** + * The new relational database configuration. + */ + relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig; + } + export interface UpdateDataSourceResponse { + /** + * The updated DataSource object. + */ + dataSource?: DataSource; + } + export interface UpdateFunctionRequest { + /** + * The GraphQL API ID. + */ + apiId: String; + /** + * The Function name. + */ + name: ResourceName; + /** + * The Function description. + */ + description?: String; + /** + * The function ID. + */ + functionId: ResourceName; + /** + * The Function DataSource name. + */ + dataSourceName: ResourceName; + /** + * The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. + */ + requestMappingTemplate: MappingTemplate; + /** + * The Function request mapping template. + */ + responseMappingTemplate?: MappingTemplate; + /** + * The version of the request mapping template. Currently the supported value is 2018-05-29. + */ + functionVersion: String; + } + export interface UpdateFunctionResponse { + /** + * The Function object. + */ + functionConfiguration?: FunctionConfiguration; + } + export interface UpdateGraphqlApiRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The new name for the GraphqlApi object. + */ + name: String; + /** + * The Amazon CloudWatch Logs configuration for the GraphqlApi object. + */ + logConfig?: LogConfig; + /** + * The new authentication type for the GraphqlApi object. + */ + authenticationType?: AuthenticationType; + /** + * The new Amazon Cognito user pool configuration for the GraphqlApi object. + */ + userPoolConfig?: UserPoolConfig; + /** + * The OpenID Connect configuration for the GraphqlApi object. + */ + openIDConnectConfig?: OpenIDConnectConfig; + /** + * A list of additional authentication providers for the GraphqlApi API. + */ + additionalAuthenticationProviders?: AdditionalAuthenticationProviders; + } + export interface UpdateGraphqlApiResponse { + /** + * The updated GraphqlApi object. + */ + graphqlApi?: GraphqlApi; + } + export interface UpdateResolverRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The new type name. + */ + typeName: ResourceName; + /** + * The new field name. + */ + fieldName: ResourceName; + /** + * The new data source name. + */ + dataSourceName?: ResourceName; + /** + * The new request mapping template. + */ + requestMappingTemplate: MappingTemplate; + /** + * The new response mapping template. + */ + responseMappingTemplate?: MappingTemplate; + /** + * The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources. + */ + kind?: ResolverKind; + /** + * The PipelineConfig. + */ + pipelineConfig?: PipelineConfig; + } + export interface UpdateResolverResponse { + /** + * The updated Resolver object. + */ + resolver?: Resolver; + } + export interface UpdateTypeRequest { + /** + * The API ID. + */ + apiId: String; + /** + * The new type name. + */ + typeName: ResourceName; + /** + * The new definition. + */ + definition?: String; + /** + * The new type format: SDL or JSON. + */ + format: TypeDefinitionFormat; + } + export interface UpdateTypeResponse { + /** + * The updated Type object. + */ + type?: Type; + } + export interface UserPoolConfig { + /** + * The user pool ID. + */ + userPoolId: String; + /** + * The AWS Region in which the user pool was created. + */ + awsRegion: String; + /** + * The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration. + */ + defaultAction: DefaultAction; + /** + * A regular expression for validating the incoming Amazon Cognito user pool app client ID. + */ + appIdClientRegex?: String; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-07-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the AppSync client. + */ + export import Types = AppSync; +} +export = AppSync; diff --git a/node_modules/aws-sdk/clients/appsync.js b/node_modules/aws-sdk/clients/appsync.js new file mode 100644 index 0000000..44f088f --- /dev/null +++ b/node_modules/aws-sdk/clients/appsync.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['appsync'] = {}; +AWS.AppSync = Service.defineService('appsync', ['2017-07-25']); +Object.defineProperty(apiLoader.services['appsync'], '2017-07-25', { + get: function get() { + var model = require('../apis/appsync-2017-07-25.min.json'); + model.paginators = require('../apis/appsync-2017-07-25.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.AppSync; diff --git a/node_modules/aws-sdk/clients/athena.d.ts b/node_modules/aws-sdk/clients/athena.d.ts new file mode 100644 index 0000000..112d0e0 --- /dev/null +++ b/node_modules/aws-sdk/clients/athena.d.ts @@ -0,0 +1,889 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Athena extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Athena.Types.ClientConfiguration) + config: Config & Athena.Types.ClientConfiguration; + /** + * Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs. + */ + batchGetNamedQuery(params: Athena.Types.BatchGetNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.BatchGetNamedQueryOutput) => void): Request; + /** + * Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs. + */ + batchGetNamedQuery(callback?: (err: AWSError, data: Athena.Types.BatchGetNamedQueryOutput) => void): Request; + /** + * Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries. + */ + batchGetQueryExecution(params: Athena.Types.BatchGetQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.BatchGetQueryExecutionOutput) => void): Request; + /** + * Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries. + */ + batchGetQueryExecution(callback?: (err: AWSError, data: Athena.Types.BatchGetQueryExecutionOutput) => void): Request; + /** + * Creates a named query in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + createNamedQuery(params: Athena.Types.CreateNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.CreateNamedQueryOutput) => void): Request; + /** + * Creates a named query in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + createNamedQuery(callback?: (err: AWSError, data: Athena.Types.CreateNamedQueryOutput) => void): Request; + /** + * Creates a workgroup with the specified name. + */ + createWorkGroup(params: Athena.Types.CreateWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.CreateWorkGroupOutput) => void): Request; + /** + * Creates a workgroup with the specified name. + */ + createWorkGroup(callback?: (err: AWSError, data: Athena.Types.CreateWorkGroupOutput) => void): Request; + /** + * Deletes the named query if you have access to the workgroup in which the query was saved. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + deleteNamedQuery(params: Athena.Types.DeleteNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.DeleteNamedQueryOutput) => void): Request; + /** + * Deletes the named query if you have access to the workgroup in which the query was saved. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + deleteNamedQuery(callback?: (err: AWSError, data: Athena.Types.DeleteNamedQueryOutput) => void): Request; + /** + * Deletes the workgroup with the specified name. The primary workgroup cannot be deleted. + */ + deleteWorkGroup(params: Athena.Types.DeleteWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.DeleteWorkGroupOutput) => void): Request; + /** + * Deletes the workgroup with the specified name. The primary workgroup cannot be deleted. + */ + deleteWorkGroup(callback?: (err: AWSError, data: Athena.Types.DeleteWorkGroupOutput) => void): Request; + /** + * Returns information about a single query. Requires that you have access to the workgroup in which the query was saved. + */ + getNamedQuery(params: Athena.Types.GetNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.GetNamedQueryOutput) => void): Request; + /** + * Returns information about a single query. Requires that you have access to the workgroup in which the query was saved. + */ + getNamedQuery(callback?: (err: AWSError, data: Athena.Types.GetNamedQueryOutput) => void): Request; + /** + * Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID. + */ + getQueryExecution(params: Athena.Types.GetQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.GetQueryExecutionOutput) => void): Request; + /** + * Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID. + */ + getQueryExecution(callback?: (err: AWSError, data: Athena.Types.GetQueryExecutionOutput) => void): Request; + /** + * Returns the results of a single query execution specified by QueryExecutionId if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use StartQueryExecution to run a query. + */ + getQueryResults(params: Athena.Types.GetQueryResultsInput, callback?: (err: AWSError, data: Athena.Types.GetQueryResultsOutput) => void): Request; + /** + * Returns the results of a single query execution specified by QueryExecutionId if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use StartQueryExecution to run a query. + */ + getQueryResults(callback?: (err: AWSError, data: Athena.Types.GetQueryResultsOutput) => void): Request; + /** + * Returns information about the workgroup with the specified name. + */ + getWorkGroup(params: Athena.Types.GetWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.GetWorkGroupOutput) => void): Request; + /** + * Returns information about the workgroup with the specified name. + */ + getWorkGroup(callback?: (err: AWSError, data: Athena.Types.GetWorkGroupOutput) => void): Request; + /** + * Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + listNamedQueries(params: Athena.Types.ListNamedQueriesInput, callback?: (err: AWSError, data: Athena.Types.ListNamedQueriesOutput) => void): Request; + /** + * Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + listNamedQueries(callback?: (err: AWSError, data: Athena.Types.ListNamedQueriesOutput) => void): Request; + /** + * Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + listQueryExecutions(params: Athena.Types.ListQueryExecutionsInput, callback?: (err: AWSError, data: Athena.Types.ListQueryExecutionsOutput) => void): Request; + /** + * Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + listQueryExecutions(callback?: (err: AWSError, data: Athena.Types.ListQueryExecutionsOutput) => void): Request; + /** + * Lists the tags associated with this workgroup. + */ + listTagsForResource(params: Athena.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: Athena.Types.ListTagsForResourceOutput) => void): Request; + /** + * Lists the tags associated with this workgroup. + */ + listTagsForResource(callback?: (err: AWSError, data: Athena.Types.ListTagsForResourceOutput) => void): Request; + /** + * Lists available workgroups for the account. + */ + listWorkGroups(params: Athena.Types.ListWorkGroupsInput, callback?: (err: AWSError, data: Athena.Types.ListWorkGroupsOutput) => void): Request; + /** + * Lists available workgroups for the account. + */ + listWorkGroups(callback?: (err: AWSError, data: Athena.Types.ListWorkGroupsOutput) => void): Request; + /** + * Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + startQueryExecution(params: Athena.Types.StartQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.StartQueryExecutionOutput) => void): Request; + /** + * Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + startQueryExecution(callback?: (err: AWSError, data: Athena.Types.StartQueryExecutionOutput) => void): Request; + /** + * Stops a query execution. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + stopQueryExecution(params: Athena.Types.StopQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.StopQueryExecutionOutput) => void): Request; + /** + * Stops a query execution. Requires you to have access to the workgroup in which the query ran. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. + */ + stopQueryExecution(callback?: (err: AWSError, data: Athena.Types.StopQueryExecutionOutput) => void): Request; + /** + * Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas. + */ + tagResource(params: Athena.Types.TagResourceInput, callback?: (err: AWSError, data: Athena.Types.TagResourceOutput) => void): Request; + /** + * Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas. + */ + tagResource(callback?: (err: AWSError, data: Athena.Types.TagResourceOutput) => void): Request; + /** + * Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time. + */ + untagResource(params: Athena.Types.UntagResourceInput, callback?: (err: AWSError, data: Athena.Types.UntagResourceOutput) => void): Request; + /** + * Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time. + */ + untagResource(callback?: (err: AWSError, data: Athena.Types.UntagResourceOutput) => void): Request; + /** + * Updates the workgroup with the specified name. The workgroup's name cannot be changed. + */ + updateWorkGroup(params: Athena.Types.UpdateWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.UpdateWorkGroupOutput) => void): Request; + /** + * Updates the workgroup with the specified name. The workgroup's name cannot be changed. + */ + updateWorkGroup(callback?: (err: AWSError, data: Athena.Types.UpdateWorkGroupOutput) => void): Request; +} +declare namespace Athena { + export type AmazonResourceName = string; + export interface BatchGetNamedQueryInput { + /** + * An array of query IDs. + */ + NamedQueryIds: NamedQueryIdList; + } + export interface BatchGetNamedQueryOutput { + /** + * Information about the named query IDs submitted. + */ + NamedQueries?: NamedQueryList; + /** + * Information about provided query IDs. + */ + UnprocessedNamedQueryIds?: UnprocessedNamedQueryIdList; + } + export interface BatchGetQueryExecutionInput { + /** + * An array of query execution IDs. + */ + QueryExecutionIds: QueryExecutionIdList; + } + export interface BatchGetQueryExecutionOutput { + /** + * Information about a query execution. + */ + QueryExecutions?: QueryExecutionList; + /** + * Information about the query executions that failed to run. + */ + UnprocessedQueryExecutionIds?: UnprocessedQueryExecutionIdList; + } + export type Boolean = boolean; + export type BoxedBoolean = boolean; + export type BytesScannedCutoffValue = number; + export interface ColumnInfo { + /** + * The catalog to which the query results belong. + */ + CatalogName?: String; + /** + * The schema name (database name) to which the query results belong. + */ + SchemaName?: String; + /** + * The table name for the query results. + */ + TableName?: String; + /** + * The name of the column. + */ + Name: String; + /** + * A column label. + */ + Label?: String; + /** + * The data type of the column. + */ + Type: String; + /** + * For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits. + */ + Precision?: Integer; + /** + * For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0. + */ + Scale?: Integer; + /** + * Indicates the column's nullable status. + */ + Nullable?: ColumnNullable; + /** + * Indicates whether values in the column are case-sensitive. + */ + CaseSensitive?: Boolean; + } + export type ColumnInfoList = ColumnInfo[]; + export type ColumnNullable = "NOT_NULL"|"NULLABLE"|"UNKNOWN"|string; + export interface CreateNamedQueryInput { + /** + * The query name. + */ + Name: NameString; + /** + * The query description. + */ + Description?: DescriptionString; + /** + * The database to which the query belongs. + */ + Database: DatabaseString; + /** + * The contents of the query with all query statements. + */ + QueryString: QueryString; + /** + * A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned. This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail. + */ + ClientRequestToken?: IdempotencyToken; + /** + * The name of the workgroup in which the named query is being created. + */ + WorkGroup?: WorkGroupName; + } + export interface CreateNamedQueryOutput { + /** + * The unique ID of the query. + */ + NamedQueryId?: NamedQueryId; + } + export interface CreateWorkGroupInput { + /** + * The workgroup name. + */ + Name: WorkGroupName; + /** + * The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. + */ + Configuration?: WorkGroupConfiguration; + /** + * The workgroup description. + */ + Description?: WorkGroupDescriptionString; + /** + * One or more tags, separated by commas, that you want to attach to the workgroup as you create it. + */ + Tags?: TagList; + } + export interface CreateWorkGroupOutput { + } + export type DatabaseString = string; + export type _Date = Date; + export interface Datum { + /** + * The value of the datum. + */ + VarCharValue?: datumString; + } + export interface DeleteNamedQueryInput { + /** + * The unique ID of the query to delete. + */ + NamedQueryId: NamedQueryId; + } + export interface DeleteNamedQueryOutput { + } + export interface DeleteWorkGroupInput { + /** + * The unique name of the workgroup to delete. + */ + WorkGroup: WorkGroupName; + /** + * The option to delete the workgroup and its contents even if the workgroup contains any named queries. + */ + RecursiveDeleteOption?: BoxedBoolean; + } + export interface DeleteWorkGroupOutput { + } + export type DescriptionString = string; + export interface EncryptionConfiguration { + /** + * Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. + */ + EncryptionOption: EncryptionOption; + /** + * For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. + */ + KmsKey?: String; + } + export type EncryptionOption = "SSE_S3"|"SSE_KMS"|"CSE_KMS"|string; + export type ErrorCode = string; + export type ErrorMessage = string; + export interface GetNamedQueryInput { + /** + * The unique ID of the query. Use ListNamedQueries to get query IDs. + */ + NamedQueryId: NamedQueryId; + } + export interface GetNamedQueryOutput { + /** + * Information about the query. + */ + NamedQuery?: NamedQuery; + } + export interface GetQueryExecutionInput { + /** + * The unique ID of the query execution. + */ + QueryExecutionId: QueryExecutionId; + } + export interface GetQueryExecutionOutput { + /** + * Information about the query execution. + */ + QueryExecution?: QueryExecution; + } + export interface GetQueryResultsInput { + /** + * The unique ID of the query execution. + */ + QueryExecutionId: QueryExecutionId; + /** + * The token that specifies where to start pagination if a previous request was truncated. + */ + NextToken?: Token; + /** + * The maximum number of results (rows) to return in this request. + */ + MaxResults?: MaxQueryResults; + } + export interface GetQueryResultsOutput { + /** + * The number of rows inserted with a CREATE TABLE AS SELECT statement. + */ + UpdateCount?: Long; + /** + * The results of the query execution. + */ + ResultSet?: ResultSet; + /** + * A token to be used by the next request if this request is truncated. + */ + NextToken?: Token; + } + export interface GetWorkGroupInput { + /** + * The name of the workgroup. + */ + WorkGroup: WorkGroupName; + } + export interface GetWorkGroupOutput { + /** + * Information about the workgroup. + */ + WorkGroup?: WorkGroup; + } + export type IdempotencyToken = string; + export type Integer = number; + export interface ListNamedQueriesInput { + /** + * The token that specifies where to start pagination if a previous request was truncated. + */ + NextToken?: Token; + /** + * The maximum number of queries to return in this request. + */ + MaxResults?: MaxNamedQueriesCount; + /** + * The name of the workgroup from which the named queries are being returned. + */ + WorkGroup?: WorkGroupName; + } + export interface ListNamedQueriesOutput { + /** + * The list of unique query IDs. + */ + NamedQueryIds?: NamedQueryIdList; + /** + * A token to be used by the next request if this request is truncated. + */ + NextToken?: Token; + } + export interface ListQueryExecutionsInput { + /** + * The token that specifies where to start pagination if a previous request was truncated. + */ + NextToken?: Token; + /** + * The maximum number of query executions to return in this request. + */ + MaxResults?: MaxQueryExecutionsCount; + /** + * The name of the workgroup from which queries are being returned. + */ + WorkGroup?: WorkGroupName; + } + export interface ListQueryExecutionsOutput { + /** + * The unique IDs of each query execution as an array of strings. + */ + QueryExecutionIds?: QueryExecutionIdList; + /** + * A token to be used by the next request if this request is truncated. + */ + NextToken?: Token; + } + export interface ListTagsForResourceInput { + /** + * Lists the tags for the workgroup resource with the specified ARN. + */ + ResourceARN: AmazonResourceName; + /** + * The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the workgroup resource with the specified ARN. + */ + NextToken?: Token; + /** + * The maximum number of results to be returned per request that lists the tags for the workgroup resource. + */ + MaxResults?: MaxTagsCount; + } + export interface ListTagsForResourceOutput { + /** + * The list of tags associated with this workgroup. + */ + Tags?: TagList; + /** + * A token to be used by the next request if this request is truncated. + */ + NextToken?: Token; + } + export interface ListWorkGroupsInput { + /** + * A token to be used by the next request if this request is truncated. + */ + NextToken?: Token; + /** + * The maximum number of workgroups to return in this request. + */ + MaxResults?: MaxWorkGroupsCount; + } + export interface ListWorkGroupsOutput { + /** + * The list of workgroups, including their names, descriptions, creation times, and states. + */ + WorkGroups?: WorkGroupsList; + /** + * A token to be used by the next request if this request is truncated. + */ + NextToken?: Token; + } + export type Long = number; + export type MaxNamedQueriesCount = number; + export type MaxQueryExecutionsCount = number; + export type MaxQueryResults = number; + export type MaxTagsCount = number; + export type MaxWorkGroupsCount = number; + export type NameString = string; + export interface NamedQuery { + /** + * The query name. + */ + Name: NameString; + /** + * The query description. + */ + Description?: DescriptionString; + /** + * The database to which the query belongs. + */ + Database: DatabaseString; + /** + * The SQL query statements that comprise the query. + */ + QueryString: QueryString; + /** + * The unique identifier of the query. + */ + NamedQueryId?: NamedQueryId; + /** + * The name of the workgroup that contains the named query. + */ + WorkGroup?: WorkGroupName; + } + export type NamedQueryId = string; + export type NamedQueryIdList = NamedQueryId[]; + export type NamedQueryList = NamedQuery[]; + export interface QueryExecution { + /** + * The unique identifier for each query execution. + */ + QueryExecutionId?: QueryExecutionId; + /** + * The SQL query statements which the query execution ran. + */ + Query?: QueryString; + /** + * The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE <table>. + */ + StatementType?: StatementType; + /** + * The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. + */ + ResultConfiguration?: ResultConfiguration; + /** + * The database in which the query execution occurred. + */ + QueryExecutionContext?: QueryExecutionContext; + /** + * The completion date, current state, submission time, and state change reason (if applicable) for the query execution. + */ + Status?: QueryExecutionStatus; + /** + * The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run. + */ + Statistics?: QueryExecutionStatistics; + /** + * The name of the workgroup in which the query ran. + */ + WorkGroup?: WorkGroupName; + } + export interface QueryExecutionContext { + /** + * The name of the database. + */ + Database?: DatabaseString; + } + export type QueryExecutionId = string; + export type QueryExecutionIdList = QueryExecutionId[]; + export type QueryExecutionList = QueryExecution[]; + export type QueryExecutionState = "QUEUED"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|string; + export interface QueryExecutionStatistics { + /** + * The number of milliseconds that the query took to execute. + */ + EngineExecutionTimeInMillis?: Long; + /** + * The number of bytes in the data that was queried. + */ + DataScannedInBytes?: Long; + } + export interface QueryExecutionStatus { + /** + * The state of query execution. QUEUED state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution. + */ + State?: QueryExecutionState; + /** + * Further detail about the status of the query. + */ + StateChangeReason?: String; + /** + * The date and time that the query was submitted. + */ + SubmissionDateTime?: _Date; + /** + * The date and time that the query completed. + */ + CompletionDateTime?: _Date; + } + export type QueryString = string; + export interface ResultConfiguration { + /** + * The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. For more information, see Queries and Query Result Files. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. + */ + OutputLocation?: String; + /** + * If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings. + */ + EncryptionConfiguration?: EncryptionConfiguration; + } + export interface ResultConfigurationUpdates { + /** + * The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. For more information, see Queries and Query Result Files. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. + */ + OutputLocation?: String; + /** + * If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings. + */ + RemoveOutputLocation?: BoxedBoolean; + /** + * The encryption configuration for the query results. + */ + EncryptionConfiguration?: EncryptionConfiguration; + /** + * If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings. + */ + RemoveEncryptionConfiguration?: BoxedBoolean; + } + export interface ResultSet { + /** + * The rows in the table. + */ + Rows?: RowList; + /** + * The metadata that describes the column structure and data types of a table of query results. + */ + ResultSetMetadata?: ResultSetMetadata; + } + export interface ResultSetMetadata { + /** + * Information about the columns returned in a query result metadata. + */ + ColumnInfo?: ColumnInfoList; + } + export interface Row { + /** + * The data that populates a row in a query result table. + */ + Data?: datumList; + } + export type RowList = Row[]; + export interface StartQueryExecutionInput { + /** + * The SQL query statements to be executed. + */ + QueryString: QueryString; + /** + * A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned. This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail. + */ + ClientRequestToken?: IdempotencyToken; + /** + * The database within which the query executes. + */ + QueryExecutionContext?: QueryExecutionContext; + /** + * Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. + */ + ResultConfiguration?: ResultConfiguration; + /** + * The name of the workgroup in which the query is being started. + */ + WorkGroup?: WorkGroupName; + } + export interface StartQueryExecutionOutput { + /** + * The unique ID of the query that ran as a result of this request. + */ + QueryExecutionId?: QueryExecutionId; + } + export type StatementType = "DDL"|"DML"|"UTILITY"|string; + export interface StopQueryExecutionInput { + /** + * The unique ID of the query execution to stop. + */ + QueryExecutionId: QueryExecutionId; + } + export interface StopQueryExecutionOutput { + } + export type String = string; + export interface Tag { + /** + * A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource. + */ + Key?: TagKey; + /** + * A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceInput { + /** + * Requests that one or more tags are added to the resource (such as a workgroup) for the specified ARN. + */ + ResourceARN: AmazonResourceName; + /** + * One or more tags, separated by commas, to be added to the resource, such as a workgroup. + */ + Tags: TagList; + } + export interface TagResourceOutput { + } + export type TagValue = string; + export type Token = string; + export interface UnprocessedNamedQueryId { + /** + * The unique identifier of the named query. + */ + NamedQueryId?: NamedQueryId; + /** + * The error code returned when the processing request for the named query failed, if applicable. + */ + ErrorCode?: ErrorCode; + /** + * The error message returned when the processing request for the named query failed, if applicable. + */ + ErrorMessage?: ErrorMessage; + } + export type UnprocessedNamedQueryIdList = UnprocessedNamedQueryId[]; + export interface UnprocessedQueryExecutionId { + /** + * The unique identifier of the query execution. + */ + QueryExecutionId?: QueryExecutionId; + /** + * The error code returned when the query execution failed to process, if applicable. + */ + ErrorCode?: ErrorCode; + /** + * The error message returned when the query execution failed to process, if applicable. + */ + ErrorMessage?: ErrorMessage; + } + export type UnprocessedQueryExecutionIdList = UnprocessedQueryExecutionId[]; + export interface UntagResourceInput { + /** + * Removes one or more tags from the workgroup resource for the specified ARN. + */ + ResourceARN: AmazonResourceName; + /** + * Removes the tags associated with one or more tag keys from the workgroup resource. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceOutput { + } + export interface UpdateWorkGroupInput { + /** + * The specified workgroup that will be updated. + */ + WorkGroup: WorkGroupName; + /** + * The workgroup description. + */ + Description?: WorkGroupDescriptionString; + /** + * The workgroup configuration that will be updated for the given workgroup. + */ + ConfigurationUpdates?: WorkGroupConfigurationUpdates; + /** + * The workgroup state that will be updated for the given workgroup. + */ + State?: WorkGroupState; + } + export interface UpdateWorkGroupOutput { + } + export interface WorkGroup { + /** + * The workgroup name. + */ + Name: WorkGroupName; + /** + * The state of the workgroup: ENABLED or DISABLED. + */ + State?: WorkGroupState; + /** + * The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. + */ + Configuration?: WorkGroupConfiguration; + /** + * The workgroup description. + */ + Description?: WorkGroupDescriptionString; + /** + * The date and time the workgroup was created. + */ + CreationTime?: _Date; + } + export interface WorkGroupConfiguration { + /** + * The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. + */ + ResultConfiguration?: ResultConfiguration; + /** + * If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings. + */ + EnforceWorkGroupConfiguration?: BoxedBoolean; + /** + * Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. + */ + PublishCloudWatchMetricsEnabled?: BoxedBoolean; + /** + * The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. + */ + BytesScannedCutoffPerQuery?: BytesScannedCutoffValue; + } + export interface WorkGroupConfigurationUpdates { + /** + * If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings. + */ + EnforceWorkGroupConfiguration?: BoxedBoolean; + /** + * The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results. + */ + ResultConfigurationUpdates?: ResultConfigurationUpdates; + /** + * Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch. + */ + PublishCloudWatchMetricsEnabled?: BoxedBoolean; + /** + * The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. + */ + BytesScannedCutoffPerQuery?: BytesScannedCutoffValue; + /** + * Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery + */ + RemoveBytesScannedCutoffPerQuery?: BoxedBoolean; + } + export type WorkGroupDescriptionString = string; + export type WorkGroupName = string; + export type WorkGroupState = "ENABLED"|"DISABLED"|string; + export interface WorkGroupSummary { + /** + * The name of the workgroup. + */ + Name?: WorkGroupName; + /** + * The state of the workgroup. + */ + State?: WorkGroupState; + /** + * The workgroup description. + */ + Description?: WorkGroupDescriptionString; + /** + * The workgroup creation date and time. + */ + CreationTime?: _Date; + } + export type WorkGroupsList = WorkGroupSummary[]; + export type datumList = Datum[]; + export type datumString = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-05-18"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Athena client. + */ + export import Types = Athena; +} +export = Athena; diff --git a/node_modules/aws-sdk/clients/athena.js b/node_modules/aws-sdk/clients/athena.js new file mode 100644 index 0000000..5291016 --- /dev/null +++ b/node_modules/aws-sdk/clients/athena.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['athena'] = {}; +AWS.Athena = Service.defineService('athena', ['2017-05-18']); +Object.defineProperty(apiLoader.services['athena'], '2017-05-18', { + get: function get() { + var model = require('../apis/athena-2017-05-18.min.json'); + model.paginators = require('../apis/athena-2017-05-18.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Athena; diff --git a/node_modules/aws-sdk/clients/autoscaling.d.ts b/node_modules/aws-sdk/clients/autoscaling.d.ts new file mode 100644 index 0000000..5d2a41f --- /dev/null +++ b/node_modules/aws-sdk/clients/autoscaling.d.ts @@ -0,0 +1,2469 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class AutoScaling extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: AutoScaling.Types.ClientConfiguration) + config: Config & AutoScaling.Types.ClientConfiguration; + /** + * Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + attachInstances(params: AutoScaling.Types.AttachInstancesQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + attachInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches one or more target groups to the specified Auto Scaling group. To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups. With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + attachLoadBalancerTargetGroups(params: AutoScaling.Types.AttachLoadBalancerTargetGroupsType, callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType) => void): Request; + /** + * Attaches one or more target groups to the specified Auto Scaling group. To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups. With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + attachLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType) => void): Request; + /** + * Attaches one or more Classic Load Balancers to the specified Auto Scaling group. To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups. To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + attachLoadBalancers(params: AutoScaling.Types.AttachLoadBalancersType, callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancersResultType) => void): Request; + /** + * Attaches one or more Classic Load Balancers to the specified Auto Scaling group. To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups. To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + attachLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancersResultType) => void): Request; + /** + * Deletes one or more scheduled actions for the specified Auto Scaling group. + */ + batchDeleteScheduledAction(params: AutoScaling.Types.BatchDeleteScheduledActionType, callback?: (err: AWSError, data: AutoScaling.Types.BatchDeleteScheduledActionAnswer) => void): Request; + /** + * Deletes one or more scheduled actions for the specified Auto Scaling group. + */ + batchDeleteScheduledAction(callback?: (err: AWSError, data: AutoScaling.Types.BatchDeleteScheduledActionAnswer) => void): Request; + /** + * Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. + */ + batchPutScheduledUpdateGroupAction(params: AutoScaling.Types.BatchPutScheduledUpdateGroupActionType, callback?: (err: AWSError, data: AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer) => void): Request; + /** + * Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. + */ + batchPutScheduledUpdateGroupAction(callback?: (err: AWSError, data: AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer) => void): Request; + /** + * Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. + */ + completeLifecycleAction(params: AutoScaling.Types.CompleteLifecycleActionType, callback?: (err: AWSError, data: AutoScaling.Types.CompleteLifecycleActionAnswer) => void): Request; + /** + * Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. + */ + completeLifecycleAction(callback?: (err: AWSError, data: AutoScaling.Types.CompleteLifecycleActionAnswer) => void): Request; + /** + * Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide. + */ + createAutoScalingGroup(params: AutoScaling.Types.CreateAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide. + */ + createAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide. + */ + createLaunchConfiguration(params: AutoScaling.Types.CreateLaunchConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide. + */ + createLaunchConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide. + */ + createOrUpdateTags(params: AutoScaling.Types.CreateOrUpdateTagsType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide. + */ + createOrUpdateTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero. + */ + deleteAutoScalingGroup(params: AutoScaling.Types.DeleteAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero. + */ + deleteAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. + */ + deleteLaunchConfiguration(params: AutoScaling.Types.LaunchConfigurationNameType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. + */ + deleteLaunchConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances). + */ + deleteLifecycleHook(params: AutoScaling.Types.DeleteLifecycleHookType, callback?: (err: AWSError, data: AutoScaling.Types.DeleteLifecycleHookAnswer) => void): Request; + /** + * Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances). + */ + deleteLifecycleHook(callback?: (err: AWSError, data: AutoScaling.Types.DeleteLifecycleHookAnswer) => void): Request; + /** + * Deletes the specified notification. + */ + deleteNotificationConfiguration(params: AutoScaling.Types.DeleteNotificationConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified notification. + */ + deleteNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. + */ + deletePolicy(params: AutoScaling.Types.DeletePolicyType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. + */ + deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified scheduled action. + */ + deleteScheduledAction(params: AutoScaling.Types.DeleteScheduledActionType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified scheduled action. + */ + deleteScheduledAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified tags. + */ + deleteTags(params: AutoScaling.Types.DeleteTagsType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified tags. + */ + deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describes the current Amazon EC2 Auto Scaling resource limits for your AWS account. For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide. + */ + describeAccountLimits(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAccountLimitsAnswer) => void): Request; + /** + * Describes the policy adjustment types for use with PutScalingPolicy. + */ + describeAdjustmentTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAdjustmentTypesAnswer) => void): Request; + /** + * Describes one or more Auto Scaling groups. + */ + describeAutoScalingGroups(params: AutoScaling.Types.AutoScalingGroupNamesType, callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingGroupsType) => void): Request; + /** + * Describes one or more Auto Scaling groups. + */ + describeAutoScalingGroups(callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingGroupsType) => void): Request; + /** + * Describes one or more Auto Scaling instances. + */ + describeAutoScalingInstances(params: AutoScaling.Types.DescribeAutoScalingInstancesType, callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingInstancesType) => void): Request; + /** + * Describes one or more Auto Scaling instances. + */ + describeAutoScalingInstances(callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingInstancesType) => void): Request; + /** + * Describes the notification types that are supported by Amazon EC2 Auto Scaling. + */ + describeAutoScalingNotificationTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAutoScalingNotificationTypesAnswer) => void): Request; + /** + * Describes one or more launch configurations. + */ + describeLaunchConfigurations(params: AutoScaling.Types.LaunchConfigurationNamesType, callback?: (err: AWSError, data: AutoScaling.Types.LaunchConfigurationsType) => void): Request; + /** + * Describes one or more launch configurations. + */ + describeLaunchConfigurations(callback?: (err: AWSError, data: AutoScaling.Types.LaunchConfigurationsType) => void): Request; + /** + * Describes the available types of lifecycle hooks. The following hook types are supported: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING + */ + describeLifecycleHookTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHookTypesAnswer) => void): Request; + /** + * Describes the lifecycle hooks for the specified Auto Scaling group. + */ + describeLifecycleHooks(params: AutoScaling.Types.DescribeLifecycleHooksType, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHooksAnswer) => void): Request; + /** + * Describes the lifecycle hooks for the specified Auto Scaling group. + */ + describeLifecycleHooks(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHooksAnswer) => void): Request; + /** + * Describes the target groups for the specified Auto Scaling group. + */ + describeLoadBalancerTargetGroups(params: AutoScaling.Types.DescribeLoadBalancerTargetGroupsRequest, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse) => void): Request; + /** + * Describes the target groups for the specified Auto Scaling group. + */ + describeLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse) => void): Request; + /** + * Describes the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead. + */ + describeLoadBalancers(params: AutoScaling.Types.DescribeLoadBalancersRequest, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancersResponse) => void): Request; + /** + * Describes the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead. + */ + describeLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancersResponse) => void): Request; + /** + * Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling. The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection. + */ + describeMetricCollectionTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeMetricCollectionTypesAnswer) => void): Request; + /** + * Describes the notification actions associated with the specified Auto Scaling group. + */ + describeNotificationConfigurations(params: AutoScaling.Types.DescribeNotificationConfigurationsType, callback?: (err: AWSError, data: AutoScaling.Types.DescribeNotificationConfigurationsAnswer) => void): Request; + /** + * Describes the notification actions associated with the specified Auto Scaling group. + */ + describeNotificationConfigurations(callback?: (err: AWSError, data: AutoScaling.Types.DescribeNotificationConfigurationsAnswer) => void): Request; + /** + * Describes the policies for the specified Auto Scaling group. + */ + describePolicies(params: AutoScaling.Types.DescribePoliciesType, callback?: (err: AWSError, data: AutoScaling.Types.PoliciesType) => void): Request; + /** + * Describes the policies for the specified Auto Scaling group. + */ + describePolicies(callback?: (err: AWSError, data: AutoScaling.Types.PoliciesType) => void): Request; + /** + * Describes one or more scaling activities for the specified Auto Scaling group. + */ + describeScalingActivities(params: AutoScaling.Types.DescribeScalingActivitiesType, callback?: (err: AWSError, data: AutoScaling.Types.ActivitiesType) => void): Request; + /** + * Describes one or more scaling activities for the specified Auto Scaling group. + */ + describeScalingActivities(callback?: (err: AWSError, data: AutoScaling.Types.ActivitiesType) => void): Request; + /** + * Describes the scaling process types for use with ResumeProcesses and SuspendProcesses. + */ + describeScalingProcessTypes(callback?: (err: AWSError, data: AutoScaling.Types.ProcessesType) => void): Request; + /** + * Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities. + */ + describeScheduledActions(params: AutoScaling.Types.DescribeScheduledActionsType, callback?: (err: AWSError, data: AutoScaling.Types.ScheduledActionsType) => void): Request; + /** + * Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities. + */ + describeScheduledActions(callback?: (err: AWSError, data: AutoScaling.Types.ScheduledActionsType) => void): Request; + /** + * Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. + */ + describeTags(params: AutoScaling.Types.DescribeTagsType, callback?: (err: AWSError, data: AutoScaling.Types.TagsType) => void): Request; + /** + * Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. + */ + describeTags(callback?: (err: AWSError, data: AutoScaling.Types.TagsType) => void): Request; + /** + * Describes the termination policies supported by Amazon EC2 Auto Scaling. For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide. + */ + describeTerminationPolicyTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeTerminationPolicyTypesAnswer) => void): Request; + /** + * Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + detachInstances(params: AutoScaling.Types.DetachInstancesQuery, callback?: (err: AWSError, data: AutoScaling.Types.DetachInstancesAnswer) => void): Request; + /** + * Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + detachInstances(callback?: (err: AWSError, data: AutoScaling.Types.DetachInstancesAnswer) => void): Request; + /** + * Detaches one or more target groups from the specified Auto Scaling group. + */ + detachLoadBalancerTargetGroups(params: AutoScaling.Types.DetachLoadBalancerTargetGroupsType, callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType) => void): Request; + /** + * Detaches one or more target groups from the specified Auto Scaling group. + */ + detachLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType) => void): Request; + /** + * Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running. + */ + detachLoadBalancers(params: AutoScaling.Types.DetachLoadBalancersType, callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancersResultType) => void): Request; + /** + * Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running. + */ + detachLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancersResultType) => void): Request; + /** + * Disables group metrics for the specified Auto Scaling group. + */ + disableMetricsCollection(params: AutoScaling.Types.DisableMetricsCollectionQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables group metrics for the specified Auto Scaling group. + */ + disableMetricsCollection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide. + */ + enableMetricsCollection(params: AutoScaling.Types.EnableMetricsCollectionQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide. + */ + enableMetricsCollection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Moves the specified instances into the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + enterStandby(params: AutoScaling.Types.EnterStandbyQuery, callback?: (err: AWSError, data: AutoScaling.Types.EnterStandbyAnswer) => void): Request; + /** + * Moves the specified instances into the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + enterStandby(callback?: (err: AWSError, data: AutoScaling.Types.EnterStandbyAnswer) => void): Request; + /** + * Executes the specified policy. + */ + executePolicy(params: AutoScaling.Types.ExecutePolicyType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Executes the specified policy. + */ + executePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Moves the specified instances out of the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + exitStandby(params: AutoScaling.Types.ExitStandbyQuery, callback?: (err: AWSError, data: AutoScaling.Types.ExitStandbyAnswer) => void): Request; + /** + * Moves the specified instances out of the standby state. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + exitStandby(callback?: (err: AWSError, data: AutoScaling.Types.ExitStandbyAnswer) => void): Request; + /** + * Creates or updates a lifecycle hook for the specified Auto Scaling group. A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated). This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook. + */ + putLifecycleHook(params: AutoScaling.Types.PutLifecycleHookType, callback?: (err: AWSError, data: AutoScaling.Types.PutLifecycleHookAnswer) => void): Request; + /** + * Creates or updates a lifecycle hook for the specified Auto Scaling group. A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated). This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook. + */ + putLifecycleHook(callback?: (err: AWSError, data: AutoScaling.Types.PutLifecycleHookAnswer) => void): Request; + /** + * Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide. + */ + putNotificationConfiguration(params: AutoScaling.Types.PutNotificationConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide. + */ + putNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. + */ + putScalingPolicy(params: AutoScaling.Types.PutScalingPolicyType, callback?: (err: AWSError, data: AutoScaling.Types.PolicyARNType) => void): Request; + /** + * Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. + */ + putScalingPolicy(callback?: (err: AWSError, data: AutoScaling.Types.PolicyARNType) => void): Request; + /** + * Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide. + */ + putScheduledUpdateGroupAction(params: AutoScaling.Types.PutScheduledUpdateGroupActionType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide. + */ + putScheduledUpdateGroupAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide. + */ + recordLifecycleActionHeartbeat(params: AutoScaling.Types.RecordLifecycleActionHeartbeatType, callback?: (err: AWSError, data: AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer) => void): Request; + /** + * Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide. + */ + recordLifecycleActionHeartbeat(callback?: (err: AWSError, data: AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer) => void): Request; + /** + * Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide. + */ + resumeProcesses(params: AutoScaling.Types.ScalingProcessQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide. + */ + resumeProcesses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the size of the specified Auto Scaling group. For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide. + */ + setDesiredCapacity(params: AutoScaling.Types.SetDesiredCapacityType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the size of the specified Auto Scaling group. For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide. + */ + setDesiredCapacity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the health status of the specified instance. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide. + */ + setInstanceHealth(params: AutoScaling.Types.SetInstanceHealthQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the health status of the specified instance. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide. + */ + setInstanceHealth(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the instance protection settings of the specified instances. For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide. + */ + setInstanceProtection(params: AutoScaling.Types.SetInstanceProtectionQuery, callback?: (err: AWSError, data: AutoScaling.Types.SetInstanceProtectionAnswer) => void): Request; + /** + * Updates the instance protection settings of the specified instances. For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide. + */ + setInstanceProtection(callback?: (err: AWSError, data: AutoScaling.Types.SetInstanceProtectionAnswer) => void): Request; + /** + * Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. To resume processes that have been suspended, use ResumeProcesses. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide. + */ + suspendProcesses(params: AutoScaling.Types.ScalingProcessQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. To resume processes that have been suspended, use ResumeProcesses. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide. + */ + suspendProcesses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately. + */ + terminateInstanceInAutoScalingGroup(params: AutoScaling.Types.TerminateInstanceInAutoScalingGroupType, callback?: (err: AWSError, data: AutoScaling.Types.ActivityType) => void): Request; + /** + * Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately. + */ + terminateInstanceInAutoScalingGroup(callback?: (err: AWSError, data: AutoScaling.Types.ActivityType) => void): Request; + /** + * Updates the configuration for the specified Auto Scaling group. The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected. To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection. Note the following: If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize. All other optional parameters are left unchanged if not specified. + */ + updateAutoScalingGroup(params: AutoScaling.Types.UpdateAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the configuration for the specified Auto Scaling group. The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected. To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection. Note the following: If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize. All other optional parameters are left unchanged if not specified. + */ + updateAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace AutoScaling { + export type Activities = Activity[]; + export interface ActivitiesType { + /** + * The scaling activities. Activities are sorted by start time. Activities still in progress are described first. + */ + Activities: Activities; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface Activity { + /** + * The ID of the activity. + */ + ActivityId: XmlString; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: XmlStringMaxLen255; + /** + * A friendly, more verbose description of the activity. + */ + Description?: XmlString; + /** + * The reason the activity began. + */ + Cause: XmlStringMaxLen1023; + /** + * The start time of the activity. + */ + StartTime: TimestampType; + /** + * The end time of the activity. + */ + EndTime?: TimestampType; + /** + * The current status of the activity. + */ + StatusCode: ScalingActivityStatusCode; + /** + * A friendly, more verbose description of the activity status. + */ + StatusMessage?: XmlStringMaxLen255; + /** + * A value between 0 and 100 that indicates the progress of the activity. + */ + Progress?: Progress; + /** + * The details about the activity. + */ + Details?: XmlString; + } + export type ActivityIds = XmlString[]; + export interface ActivityType { + /** + * A scaling activity. + */ + Activity?: Activity; + } + export interface AdjustmentType { + /** + * The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. + */ + AdjustmentType?: XmlStringMaxLen255; + } + export type AdjustmentTypes = AdjustmentType[]; + export interface Alarm { + /** + * The name of the alarm. + */ + AlarmName?: XmlStringMaxLen255; + /** + * The Amazon Resource Name (ARN) of the alarm. + */ + AlarmARN?: ResourceName; + } + export type Alarms = Alarm[]; + export type AsciiStringMaxLen255 = string; + export type AssociatePublicIpAddress = boolean; + export interface AttachInstancesQuery { + /** + * The IDs of the instances. You can specify up to 20 instances. + */ + InstanceIds?: InstanceIds; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + } + export interface AttachLoadBalancerTargetGroupsResultType { + } + export interface AttachLoadBalancerTargetGroupsType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups. + */ + TargetGroupARNs: TargetGroupARNs; + } + export interface AttachLoadBalancersResultType { + } + export interface AttachLoadBalancersType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The names of the load balancers. You can specify up to 10 load balancers. + */ + LoadBalancerNames: LoadBalancerNames; + } + export interface AutoScalingGroup { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: XmlStringMaxLen255; + /** + * The Amazon Resource Name (ARN) of the Auto Scaling group. + */ + AutoScalingGroupARN?: ResourceName; + /** + * The name of the associated launch configuration. + */ + LaunchConfigurationName?: XmlStringMaxLen255; + /** + * The launch template for the group. + */ + LaunchTemplate?: LaunchTemplateSpecification; + /** + * The mixed instances policy for the group. + */ + MixedInstancesPolicy?: MixedInstancesPolicy; + /** + * The minimum size of the group. + */ + MinSize: AutoScalingGroupMinSize; + /** + * The maximum size of the group. + */ + MaxSize: AutoScalingGroupMaxSize; + /** + * The desired size of the group. + */ + DesiredCapacity: AutoScalingGroupDesiredCapacity; + /** + * The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. + */ + DefaultCooldown: Cooldown; + /** + * One or more Availability Zones for the group. + */ + AvailabilityZones: AvailabilityZones; + /** + * One or more load balancers associated with the group. + */ + LoadBalancerNames?: LoadBalancerNames; + /** + * The Amazon Resource Names (ARN) of the target groups for your load balancer. + */ + TargetGroupARNs?: TargetGroupARNs; + /** + * The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. + */ + HealthCheckType: XmlStringMaxLen32; + /** + * The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. + */ + HealthCheckGracePeriod?: HealthCheckGracePeriod; + /** + * The EC2 instances associated with the group. + */ + Instances?: Instances; + /** + * The date and time the group was created. + */ + CreatedTime: TimestampType; + /** + * The suspended processes associated with the group. + */ + SuspendedProcesses?: SuspendedProcesses; + /** + * The name of the placement group into which to launch your instances, if any. + */ + PlacementGroup?: XmlStringMaxLen255; + /** + * One or more subnet IDs, if applicable, separated by commas. + */ + VPCZoneIdentifier?: XmlStringMaxLen2047; + /** + * The metrics enabled for the group. + */ + EnabledMetrics?: EnabledMetrics; + /** + * The current state of the group when DeleteAutoScalingGroup is in progress. + */ + Status?: XmlStringMaxLen255; + /** + * The tags for the group. + */ + Tags?: TagDescriptionList; + /** + * The termination policies for the group. + */ + TerminationPolicies?: TerminationPolicies; + /** + * Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. + */ + NewInstancesProtectedFromScaleIn?: InstanceProtected; + /** + * The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. + */ + ServiceLinkedRoleARN?: ResourceName; + } + export type AutoScalingGroupDesiredCapacity = number; + export type AutoScalingGroupMaxSize = number; + export type AutoScalingGroupMinSize = number; + export type AutoScalingGroupNames = ResourceName[]; + export interface AutoScalingGroupNamesType { + /** + * The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter. If you omit this parameter, all Auto Scaling groups are described. + */ + AutoScalingGroupNames?: AutoScalingGroupNames; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to return with this call. The default value is 50 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export type AutoScalingGroups = AutoScalingGroup[]; + export interface AutoScalingGroupsType { + /** + * The groups. + */ + AutoScalingGroups: AutoScalingGroups; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface AutoScalingInstanceDetails { + /** + * The ID of the instance. + */ + InstanceId: XmlStringMaxLen19; + /** + * The name of the Auto Scaling group for the instance. + */ + AutoScalingGroupName: XmlStringMaxLen255; + /** + * The Availability Zone for the instance. + */ + AvailabilityZone: XmlStringMaxLen255; + /** + * The lifecycle state for the instance. + */ + LifecycleState: XmlStringMaxLen32; + /** + * The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it. + */ + HealthStatus: XmlStringMaxLen32; + /** + * The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group. + */ + LaunchConfigurationName?: XmlStringMaxLen255; + /** + * The launch template for the instance. + */ + LaunchTemplate?: LaunchTemplateSpecification; + /** + * Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. + */ + ProtectedFromScaleIn: InstanceProtected; + } + export type AutoScalingInstances = AutoScalingInstanceDetails[]; + export interface AutoScalingInstancesType { + /** + * The instances. + */ + AutoScalingInstances?: AutoScalingInstances; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export type AutoScalingNotificationTypes = XmlStringMaxLen255[]; + export type AvailabilityZones = XmlStringMaxLen255[]; + export interface BatchDeleteScheduledActionAnswer { + /** + * The names of the scheduled actions that could not be deleted, including an error message. + */ + FailedScheduledActions?: FailedScheduledUpdateGroupActionRequests; + } + export interface BatchDeleteScheduledActionType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The names of the scheduled actions to delete. The maximum number allowed is 50. + */ + ScheduledActionNames: ScheduledActionNames; + } + export interface BatchPutScheduledUpdateGroupActionAnswer { + /** + * The names of the scheduled actions that could not be created or updated, including an error message. + */ + FailedScheduledUpdateGroupActions?: FailedScheduledUpdateGroupActionRequests; + } + export interface BatchPutScheduledUpdateGroupActionType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * One or more scheduled actions. The maximum number allowed is 50. + */ + ScheduledUpdateGroupActions: ScheduledUpdateGroupActionRequests; + } + export type BlockDeviceEbsDeleteOnTermination = boolean; + export type BlockDeviceEbsEncrypted = boolean; + export type BlockDeviceEbsIops = number; + export type BlockDeviceEbsVolumeSize = number; + export type BlockDeviceEbsVolumeType = string; + export interface BlockDeviceMapping { + /** + * The name of the virtual device (for example, ephemeral0). + */ + VirtualName?: XmlStringMaxLen255; + /** + * The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances. + */ + DeviceName: XmlStringMaxLen255; + /** + * The information about the Amazon EBS volume. + */ + Ebs?: Ebs; + /** + * Suppresses a device mapping. If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance. + */ + NoDevice?: NoDevice; + } + export type BlockDeviceMappings = BlockDeviceMapping[]; + export type ClassicLinkVPCSecurityGroups = XmlStringMaxLen255[]; + export interface CompleteLifecycleActionAnswer { + } + export interface CompleteLifecycleActionType { + /** + * The name of the lifecycle hook. + */ + LifecycleHookName: AsciiStringMaxLen255; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook. + */ + LifecycleActionToken?: LifecycleActionToken; + /** + * The action for the group to take. This parameter can be either CONTINUE or ABANDON. + */ + LifecycleActionResult: LifecycleActionResult; + /** + * The ID of the instance. + */ + InstanceId?: XmlStringMaxLen19; + } + export type Cooldown = number; + export interface CreateAutoScalingGroupType { + /** + * The name of the Auto Scaling group. This name must be unique within the scope of your AWS account. + */ + AutoScalingGroupName: XmlStringMaxLen255; + /** + * The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified. For more information, see Creating an Auto Scaling Group Using a Launch Configuration in the Amazon EC2 Auto Scaling User Guide. + */ + LaunchConfigurationName?: ResourceName; + /** + * The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified. For more information, see Creating an Auto Scaling Group Using a Launch Template in the Amazon EC2 Auto Scaling User Guide. + */ + LaunchTemplate?: LaunchTemplateSpecification; + /** + * The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide. + */ + MixedInstancesPolicy?: MixedInstancesPolicy; + /** + * The ID of the instance used to create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified. When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping. For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide. + */ + InstanceId?: XmlStringMaxLen19; + /** + * The minimum size of the group. + */ + MinSize: AutoScalingGroupMinSize; + /** + * The maximum size of the group. + */ + MaxSize: AutoScalingGroupMaxSize; + /** + * The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group. + */ + DesiredCapacity?: AutoScalingGroupDesiredCapacity; + /** + * The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide. + */ + DefaultCooldown?: Cooldown; + /** + * One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier. Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic. + */ + AvailabilityZones?: AvailabilityZones; + /** + * One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use TargetGroupARNs instead. For more information, see Using a Load Balancer With an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + LoadBalancerNames?: LoadBalancerNames; + /** + * The Amazon Resource Names (ARN) of the target groups. + */ + TargetGroupARNs?: TargetGroupARNs; + /** + * The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide. + */ + HealthCheckType?: XmlStringMaxLen32; + /** + * The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is 0. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you are adding an ELB health check. + */ + HealthCheckGracePeriod?: HealthCheckGracePeriod; + /** + * The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances. + */ + PlacementGroup?: XmlStringMaxLen255; + /** + * A comma-separated list of subnet IDs for your virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones. Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC. + */ + VPCZoneIdentifier?: XmlStringMaxLen2047; + /** + * One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed. For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide. + */ + TerminationPolicies?: TerminationPolicies; + /** + * Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide. + */ + NewInstancesProtectedFromScaleIn?: InstanceProtected; + /** + * One or more lifecycle hooks. + */ + LifecycleHookSpecificationList?: LifecycleHookSpecifications; + /** + * One or more tags. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide. + */ + Tags?: Tags; + /** + * The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide. + */ + ServiceLinkedRoleARN?: ResourceName; + } + export interface CreateLaunchConfigurationType { + /** + * The name of the launch configuration. This name must be unique within the scope of your AWS account. + */ + LaunchConfigurationName: XmlStringMaxLen255; + /** + * The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. If you do not specify InstanceId, you must specify ImageId. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances. + */ + ImageId?: XmlStringMaxLen255; + /** + * The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances. + */ + KeyName?: XmlStringMaxLen255; + /** + * One or more security groups with which to associate the instances. If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances. If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. + */ + SecurityGroups?: SecurityGroups; + /** + * The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. + */ + ClassicLinkVPCId?: XmlStringMaxLen255; + /** + * The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. + */ + ClassicLinkVPCSecurityGroups?: ClassicLinkVPCSecurityGroups; + /** + * The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances. + */ + UserData?: XmlStringUserData; + /** + * The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping. If you do not specify InstanceId, you must specify both ImageId and InstanceType. To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request. For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide. + */ + InstanceId?: XmlStringMaxLen19; + /** + * The instance type of the EC2 instance. If you do not specify InstanceId, you must specify InstanceType. For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances. + */ + InstanceType?: XmlStringMaxLen255; + /** + * The ID of the kernel associated with the AMI. + */ + KernelId?: XmlStringMaxLen255; + /** + * The ID of the RAM disk associated with the AMI. + */ + RamdiskId?: XmlStringMaxLen255; + /** + * One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances. + */ + BlockDeviceMappings?: BlockDeviceMappings; + /** + * Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances. The default value is true. + */ + InstanceMonitoring?: InstanceMonitoring; + /** + * The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. + */ + SpotPrice?: SpotPrice; + /** + * The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide. + */ + IamInstanceProfile?: XmlStringMaxLen1600; + /** + * Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances. + */ + EbsOptimized?: EbsOptimized; + /** + * Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide. If you specify this parameter, be sure to specify at least one subnet when you create your group. Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address. + */ + AssociatePublicIpAddress?: AssociatePublicIpAddress; + /** + * The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC. To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated. If you specify this parameter, be sure to specify at least one subnet when you create your group. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide. Valid values: default | dedicated + */ + PlacementTenancy?: XmlStringMaxLen64; + } + export interface CreateOrUpdateTagsType { + /** + * One or more tags. + */ + Tags: Tags; + } + export interface CustomizedMetricSpecification { + /** + * The name of the metric. + */ + MetricName: MetricName; + /** + * The namespace of the metric. + */ + Namespace: MetricNamespace; + /** + * The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. + */ + Dimensions?: MetricDimensions; + /** + * The statistic of the metric. + */ + Statistic: MetricStatistic; + /** + * The unit of the metric. + */ + Unit?: MetricUnit; + } + export interface DeleteAutoScalingGroupType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group. + */ + ForceDelete?: ForceDelete; + } + export interface DeleteLifecycleHookAnswer { + } + export interface DeleteLifecycleHookType { + /** + * The name of the lifecycle hook. + */ + LifecycleHookName: AsciiStringMaxLen255; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + } + export interface DeleteNotificationConfigurationType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic. + */ + TopicARN: ResourceName; + } + export interface DeletePolicyType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: ResourceName; + /** + * The name or Amazon Resource Name (ARN) of the policy. + */ + PolicyName: ResourceName; + } + export interface DeleteScheduledActionType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The name of the action to delete. + */ + ScheduledActionName: ResourceName; + } + export interface DeleteTagsType { + /** + * One or more tags. + */ + Tags: Tags; + } + export interface DescribeAccountLimitsAnswer { + /** + * The maximum number of groups allowed for your AWS account. The default limit is 200 per region. + */ + MaxNumberOfAutoScalingGroups?: MaxNumberOfAutoScalingGroups; + /** + * The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per region. + */ + MaxNumberOfLaunchConfigurations?: MaxNumberOfLaunchConfigurations; + /** + * The current number of groups for your AWS account. + */ + NumberOfAutoScalingGroups?: NumberOfAutoScalingGroups; + /** + * The current number of launch configurations for your AWS account. + */ + NumberOfLaunchConfigurations?: NumberOfLaunchConfigurations; + } + export interface DescribeAdjustmentTypesAnswer { + /** + * The policy adjustment types. + */ + AdjustmentTypes?: AdjustmentTypes; + } + export interface DescribeAutoScalingInstancesType { + /** + * The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error. + */ + InstanceIds?: InstanceIds; + /** + * The maximum number of items to return with this call. The default value is 50 and the maximum value is 50. + */ + MaxRecords?: MaxRecords; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + } + export interface DescribeAutoScalingNotificationTypesAnswer { + /** + * The notification types. + */ + AutoScalingNotificationTypes?: AutoScalingNotificationTypes; + } + export interface DescribeLifecycleHookTypesAnswer { + /** + * The lifecycle hook types. + */ + LifecycleHookTypes?: AutoScalingNotificationTypes; + } + export interface DescribeLifecycleHooksAnswer { + /** + * The lifecycle hooks for the specified group. + */ + LifecycleHooks?: LifecycleHooks; + } + export interface DescribeLifecycleHooksType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described. + */ + LifecycleHookNames?: LifecycleHookNames; + } + export interface DescribeLoadBalancerTargetGroupsRequest { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to return with this call. The default value is 100 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export interface DescribeLoadBalancerTargetGroupsResponse { + /** + * Information about the target groups. + */ + LoadBalancerTargetGroups?: LoadBalancerTargetGroupStates; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface DescribeLoadBalancersRequest { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to return with this call. The default value is 100 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export interface DescribeLoadBalancersResponse { + /** + * The load balancers. + */ + LoadBalancers?: LoadBalancerStates; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface DescribeMetricCollectionTypesAnswer { + /** + * One or more metrics. + */ + Metrics?: MetricCollectionTypes; + /** + * The granularities for the metrics. + */ + Granularities?: MetricGranularityTypes; + } + export interface DescribeNotificationConfigurationsAnswer { + /** + * The notification configurations. + */ + NotificationConfigurations: NotificationConfigurations; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface DescribeNotificationConfigurationsType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupNames?: AutoScalingGroupNames; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to return with this call. The default value is 50 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export interface DescribePoliciesType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: ResourceName; + /** + * The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error. + */ + PolicyNames?: PolicyNames; + /** + * One or more policy types. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. + */ + PolicyTypes?: PolicyTypes; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export interface DescribeScalingActivitiesType { + /** + * The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group. + */ + ActivityIds?: ActivityIds; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: ResourceName; + /** + * The maximum number of items to return with this call. The default value is 100 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + } + export interface DescribeScheduledActionsType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: ResourceName; + /** + * The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error. + */ + ScheduledActionNames?: ScheduledActionNames; + /** + * The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. + */ + StartTime?: TimestampType; + /** + * The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. + */ + EndTime?: TimestampType; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to return with this call. The default value is 50 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export interface DescribeTagsType { + /** + * One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000. + */ + Filters?: Filters; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to return with this call. The default value is 50 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export interface DescribeTerminationPolicyTypesAnswer { + /** + * The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy. + */ + TerminationPolicyTypes?: TerminationPolicies; + } + export interface DetachInstancesAnswer { + /** + * The activities related to detaching the instances from the Auto Scaling group. + */ + Activities?: Activities; + } + export interface DetachInstancesQuery { + /** + * The IDs of the instances. You can specify up to 20 instances. + */ + InstanceIds?: InstanceIds; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached. + */ + ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity; + } + export interface DetachLoadBalancerTargetGroupsResultType { + } + export interface DetachLoadBalancerTargetGroupsType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups. + */ + TargetGroupARNs: TargetGroupARNs; + } + export interface DetachLoadBalancersResultType { + } + export interface DetachLoadBalancersType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The names of the load balancers. You can specify up to 10 load balancers. + */ + LoadBalancerNames: LoadBalancerNames; + } + export interface DisableMetricsCollectionQuery { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * One or more of the following metrics. If you omit this parameter, all metrics are disabled. GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances + */ + Metrics?: Metrics; + } + export type DisableScaleIn = boolean; + export interface Ebs { + /** + * The ID of the snapshot. This parameter is optional if you specify a volume size. + */ + SnapshotId?: XmlStringMaxLen255; + /** + * The volume size, in GiB. Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size. At least one of VolumeSize or SnapshotId is required. + */ + VolumeSize?: BlockDeviceEbsVolumeSize; + /** + * The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances. Valid values: standard | io1 | gp2 | st1 | sc1 + */ + VolumeType?: BlockDeviceEbsVolumeType; + /** + * Indicates whether the volume is deleted on instance termination. The default value is true. + */ + DeleteOnTermination?: BlockDeviceEbsDeleteOnTermination; + /** + * The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances. Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.) + */ + Iops?: BlockDeviceEbsIops; + /** + * Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances. + */ + Encrypted?: BlockDeviceEbsEncrypted; + } + export type EbsOptimized = boolean; + export interface EnableMetricsCollectionQuery { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * One or more of the following metrics. If you omit this parameter, all metrics are enabled. GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances + */ + Metrics?: Metrics; + /** + * The granularity to associate with the metrics to collect. The only valid value is 1Minute. + */ + Granularity: XmlStringMaxLen255; + } + export interface EnabledMetric { + /** + * One of the following metrics: GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances + */ + Metric?: XmlStringMaxLen255; + /** + * The granularity of the metric. The only valid value is 1Minute. + */ + Granularity?: XmlStringMaxLen255; + } + export type EnabledMetrics = EnabledMetric[]; + export interface EnterStandbyAnswer { + /** + * The activities related to moving instances into Standby mode. + */ + Activities?: Activities; + } + export interface EnterStandbyQuery { + /** + * The IDs of the instances. You can specify up to 20 instances. + */ + InstanceIds?: InstanceIds; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode. + */ + ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity; + } + export type EstimatedInstanceWarmup = number; + export interface ExecutePolicyType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: ResourceName; + /** + * The name or ARN of the policy. + */ + PolicyName: ResourceName; + /** + * Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy. This parameter is not supported if the policy type is StepScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide. + */ + HonorCooldown?: HonorCooldown; + /** + * The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59. If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise. + */ + MetricValue?: MetricScale; + /** + * The breach threshold for the alarm. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise. + */ + BreachThreshold?: MetricScale; + } + export interface ExitStandbyAnswer { + /** + * The activities related to moving instances out of Standby mode. + */ + Activities?: Activities; + } + export interface ExitStandbyQuery { + /** + * The IDs of the instances. You can specify up to 20 instances. + */ + InstanceIds?: InstanceIds; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + } + export interface FailedScheduledUpdateGroupActionRequest { + /** + * The name of the scheduled action. + */ + ScheduledActionName: XmlStringMaxLen255; + /** + * The error code. + */ + ErrorCode?: XmlStringMaxLen64; + /** + * The error message accompanying the error code. + */ + ErrorMessage?: XmlString; + } + export type FailedScheduledUpdateGroupActionRequests = FailedScheduledUpdateGroupActionRequest[]; + export interface Filter { + /** + * The name of the filter. The valid values are: "auto-scaling-group", "key", "value", and "propagate-at-launch". + */ + Name?: XmlString; + /** + * The value of the filter. + */ + Values?: Values; + } + export type Filters = Filter[]; + export type ForceDelete = boolean; + export type GlobalTimeout = number; + export type HealthCheckGracePeriod = number; + export type HeartbeatTimeout = number; + export type HonorCooldown = boolean; + export interface Instance { + /** + * The ID of the instance. + */ + InstanceId: XmlStringMaxLen19; + /** + * The Availability Zone in which the instance is running. + */ + AvailabilityZone: XmlStringMaxLen255; + /** + * A description of the current lifecycle state. The Quarantined state is not used. + */ + LifecycleState: LifecycleState; + /** + * The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it. + */ + HealthStatus: XmlStringMaxLen32; + /** + * The launch configuration associated with the instance. + */ + LaunchConfigurationName?: XmlStringMaxLen255; + /** + * The launch template for the instance. + */ + LaunchTemplate?: LaunchTemplateSpecification; + /** + * Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. + */ + ProtectedFromScaleIn: InstanceProtected; + } + export type InstanceIds = XmlStringMaxLen19[]; + export interface InstanceMonitoring { + /** + * If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled. + */ + Enabled?: MonitoringEnabled; + } + export type InstanceProtected = boolean; + export type Instances = Instance[]; + export interface InstancesDistribution { + /** + * Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on. + */ + OnDemandAllocationStrategy?: XmlString; + /** + * The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales. The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting. + */ + OnDemandBaseCapacity?: OnDemandBaseCapacity; + /** + * Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. The range is 0–100. The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances. + */ + OnDemandPercentageAboveBaseCapacity?: OnDemandPercentageAboveBaseCapacity; + /** + * Indicates how to allocate Spot capacity across Spot pools. The only valid value is lowest-price, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify. + */ + SpotAllocationStrategy?: XmlString; + /** + * The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate. The range is 1–20 and the default is 2. + */ + SpotInstancePools?: SpotInstancePools; + /** + * The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price. To remove a value that you previously set, include the parameter but leave the value blank. + */ + SpotMaxPrice?: MixedInstanceSpotPrice; + } + export interface LaunchConfiguration { + /** + * The name of the launch configuration. + */ + LaunchConfigurationName: XmlStringMaxLen255; + /** + * The Amazon Resource Name (ARN) of the launch configuration. + */ + LaunchConfigurationARN?: ResourceName; + /** + * The ID of the Amazon Machine Image (AMI). + */ + ImageId: XmlStringMaxLen255; + /** + * The name of the key pair. + */ + KeyName?: XmlStringMaxLen255; + /** + * The security groups to associate with the instances. + */ + SecurityGroups?: SecurityGroups; + /** + * The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. + */ + ClassicLinkVPCId?: XmlStringMaxLen255; + /** + * The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. + */ + ClassicLinkVPCSecurityGroups?: ClassicLinkVPCSecurityGroups; + /** + * The user data available to the instances. + */ + UserData?: XmlStringUserData; + /** + * The instance type for the instances. + */ + InstanceType: XmlStringMaxLen255; + /** + * The ID of the kernel associated with the AMI. + */ + KernelId?: XmlStringMaxLen255; + /** + * The ID of the RAM disk associated with the AMI. + */ + RamdiskId?: XmlStringMaxLen255; + /** + * A block device mapping, which specifies the block devices for the instance. + */ + BlockDeviceMappings?: BlockDeviceMappings; + /** + * Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. + */ + InstanceMonitoring?: InstanceMonitoring; + /** + * The price to bid when launching Spot Instances. + */ + SpotPrice?: SpotPrice; + /** + * The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. + */ + IamInstanceProfile?: XmlStringMaxLen1600; + /** + * The creation date and time for the launch configuration. + */ + CreatedTime: TimestampType; + /** + * Controls whether the instance is optimized for EBS I/O (true) or not (false). + */ + EbsOptimized?: EbsOptimized; + /** + * [EC2-VPC] Indicates whether to assign a public IP address to each instance. + */ + AssociatePublicIpAddress?: AssociatePublicIpAddress; + /** + * The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC. + */ + PlacementTenancy?: XmlStringMaxLen64; + } + export interface LaunchConfigurationNameType { + /** + * The name of the launch configuration. + */ + LaunchConfigurationName: ResourceName; + } + export type LaunchConfigurationNames = ResourceName[]; + export interface LaunchConfigurationNamesType { + /** + * The launch configuration names. If you omit this parameter, all launch configurations are described. + */ + LaunchConfigurationNames?: LaunchConfigurationNames; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: XmlString; + /** + * The maximum number of items to return with this call. The default value is 50 and the maximum value is 100. + */ + MaxRecords?: MaxRecords; + } + export type LaunchConfigurations = LaunchConfiguration[]; + export interface LaunchConfigurationsType { + /** + * The launch configurations. + */ + LaunchConfigurations: LaunchConfigurations; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface LaunchTemplate { + /** + * The launch template to use. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateSpecification?: LaunchTemplateSpecification; + /** + * Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You must specify between 2 and 20 overrides. + */ + Overrides?: Overrides; + } + export type LaunchTemplateName = string; + export interface LaunchTemplateOverrides { + /** + * The instance type. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide. + */ + InstanceType?: XmlStringMaxLen255; + } + export interface LaunchTemplateSpecification { + /** + * The ID of the launch template. You must specify either a template ID or a template name. + */ + LaunchTemplateId?: XmlStringMaxLen255; + /** + * The name of the launch template. You must specify either a template name or a template ID. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default. + */ + Version?: XmlStringMaxLen255; + } + export type LifecycleActionResult = string; + export type LifecycleActionToken = string; + export interface LifecycleHook { + /** + * The name of the lifecycle hook. + */ + LifecycleHookName?: AsciiStringMaxLen255; + /** + * The name of the Auto Scaling group for the lifecycle hook. + */ + AutoScalingGroupName?: ResourceName; + /** + * The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING + */ + LifecycleTransition?: LifecycleTransition; + /** + * The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic. + */ + NotificationTargetARN?: ResourceName; + /** + * The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. + */ + RoleARN?: ResourceName; + /** + * Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target. + */ + NotificationMetadata?: XmlStringMaxLen1023; + /** + * The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. + */ + HeartbeatTimeout?: HeartbeatTimeout; + /** + * The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller. + */ + GlobalTimeout?: GlobalTimeout; + /** + * Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON. + */ + DefaultResult?: LifecycleActionResult; + } + export type LifecycleHookNames = AsciiStringMaxLen255[]; + export interface LifecycleHookSpecification { + /** + * The name of the lifecycle hook. + */ + LifecycleHookName: AsciiStringMaxLen255; + /** + * The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING + */ + LifecycleTransition: LifecycleTransition; + /** + * Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. + */ + NotificationMetadata?: XmlStringMaxLen1023; + /** + * The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. + */ + HeartbeatTimeout?: HeartbeatTimeout; + /** + * Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is ABANDON. + */ + DefaultResult?: LifecycleActionResult; + /** + * The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic. + */ + NotificationTargetARN?: NotificationTargetResourceName; + /** + * The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. + */ + RoleARN?: ResourceName; + } + export type LifecycleHookSpecifications = LifecycleHookSpecification[]; + export type LifecycleHooks = LifecycleHook[]; + export type LifecycleState = "Pending"|"Pending:Wait"|"Pending:Proceed"|"Quarantined"|"InService"|"Terminating"|"Terminating:Wait"|"Terminating:Proceed"|"Terminated"|"Detaching"|"Detached"|"EnteringStandby"|"Standby"|string; + export type LifecycleTransition = string; + export type LoadBalancerNames = XmlStringMaxLen255[]; + export interface LoadBalancerState { + /** + * The name of the load balancer. + */ + LoadBalancerName?: XmlStringMaxLen255; + /** + * One of the following load balancer states: Adding - The instances in the group are being registered with the load balancer. Added - All instances in the group are registered with the load balancer. InService - At least one instance in the group passed an ELB health check. Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances. Removed - All instances in the group are deregistered from the load balancer. + */ + State?: XmlStringMaxLen255; + } + export type LoadBalancerStates = LoadBalancerState[]; + export interface LoadBalancerTargetGroupState { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + LoadBalancerTargetGroupARN?: XmlStringMaxLen511; + /** + * The state of the target group. Adding - The Auto Scaling instances are being registered with the target group. Added - All Auto Scaling instances are registered with the target group. InService - At least one Auto Scaling instance passed an ELB health check. Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances. Removed - All Auto Scaling instances are deregistered from the target group. + */ + State?: XmlStringMaxLen255; + } + export type LoadBalancerTargetGroupStates = LoadBalancerTargetGroupState[]; + export type MaxNumberOfAutoScalingGroups = number; + export type MaxNumberOfLaunchConfigurations = number; + export type MaxRecords = number; + export interface MetricCollectionType { + /** + * One of the following metrics: GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances + */ + Metric?: XmlStringMaxLen255; + } + export type MetricCollectionTypes = MetricCollectionType[]; + export interface MetricDimension { + /** + * The name of the dimension. + */ + Name: MetricDimensionName; + /** + * The value of the dimension. + */ + Value: MetricDimensionValue; + } + export type MetricDimensionName = string; + export type MetricDimensionValue = string; + export type MetricDimensions = MetricDimension[]; + export interface MetricGranularityType { + /** + * The granularity. The only valid value is 1Minute. + */ + Granularity?: XmlStringMaxLen255; + } + export type MetricGranularityTypes = MetricGranularityType[]; + export type MetricName = string; + export type MetricNamespace = string; + export type MetricScale = number; + export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string; + export type MetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"ALBRequestCountPerTarget"|string; + export type MetricUnit = string; + export type Metrics = XmlStringMaxLen255[]; + export type MinAdjustmentMagnitude = number; + export type MinAdjustmentStep = number; + export type MixedInstanceSpotPrice = string; + export interface MixedInstancesPolicy { + /** + * The launch template and overrides. This parameter is required when creating an Auto Scaling group with a mixed instances policy, but is not required when updating the group. + */ + LaunchTemplate?: LaunchTemplate; + /** + * The instances distribution to use. If you leave this parameter unspecified when creating the group, the default values are used. + */ + InstancesDistribution?: InstancesDistribution; + } + export type MonitoringEnabled = boolean; + export type NoDevice = boolean; + export interface NotificationConfiguration { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic. + */ + TopicARN?: ResourceName; + /** + * One of the following event notification types: autoscaling:EC2_INSTANCE_LAUNCH autoscaling:EC2_INSTANCE_LAUNCH_ERROR autoscaling:EC2_INSTANCE_TERMINATE autoscaling:EC2_INSTANCE_TERMINATE_ERROR autoscaling:TEST_NOTIFICATION + */ + NotificationType?: XmlStringMaxLen255; + } + export type NotificationConfigurations = NotificationConfiguration[]; + export type NotificationTargetResourceName = string; + export type NumberOfAutoScalingGroups = number; + export type NumberOfLaunchConfigurations = number; + export type OnDemandBaseCapacity = number; + export type OnDemandPercentageAboveBaseCapacity = number; + export type Overrides = LaunchTemplateOverrides[]; + export interface PoliciesType { + /** + * The scaling policies. + */ + ScalingPolicies?: ScalingPolicies; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface PolicyARNType { + /** + * The Amazon Resource Name (ARN) of the policy. + */ + PolicyARN?: ResourceName; + /** + * The CloudWatch alarms created for the target tracking scaling policy. + */ + Alarms?: Alarms; + } + export type PolicyIncrement = number; + export type PolicyNames = ResourceName[]; + export type PolicyTypes = XmlStringMaxLen64[]; + export interface PredefinedMetricSpecification { + /** + * The metric type. + */ + PredefinedMetricType: MetricType; + /** + * Identifies the resource associated with the metric type. The following predefined metrics are available: ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group. ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group. ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group. ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer or a Network Load Balancer target group. For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group. + */ + ResourceLabel?: XmlStringMaxLen1023; + } + export type ProcessNames = XmlStringMaxLen255[]; + export interface ProcessType { + /** + * One of the following processes: Launch Terminate AddToLoadBalancer AlarmNotification AZRebalance HealthCheck ReplaceUnhealthy ScheduledActions + */ + ProcessName: XmlStringMaxLen255; + } + export type Processes = ProcessType[]; + export interface ProcessesType { + /** + * The names of the process types. + */ + Processes?: Processes; + } + export type Progress = number; + export type PropagateAtLaunch = boolean; + export type ProtectedFromScaleIn = boolean; + export interface PutLifecycleHookAnswer { + } + export interface PutLifecycleHookType { + /** + * The name of the lifecycle hook. + */ + LifecycleHookName: AsciiStringMaxLen255; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The instance state to which you want to attach the lifecycle hook. The valid values are: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks. + */ + LifecycleTransition?: LifecycleTransition; + /** + * The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks. + */ + RoleARN?: ResourceName; + /** + * The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN. This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic. When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION". + */ + NotificationTargetARN?: NotificationTargetResourceName; + /** + * Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. + */ + NotificationMetadata?: XmlStringMaxLen1023; + /** + * The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. + */ + HeartbeatTimeout?: HeartbeatTimeout; + /** + * Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON. + */ + DefaultResult?: LifecycleActionResult; + } + export interface PutNotificationConfigurationType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic. + */ + TopicARN: ResourceName; + /** + * The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes. + */ + NotificationTypes: AutoScalingNotificationTypes; + } + export interface PutScalingPolicyType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The name of the policy. + */ + PolicyName: XmlStringMaxLen255; + /** + * The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling. + */ + PolicyType?: XmlStringMaxLen64; + /** + * The adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. This parameter is supported if the policy type is SimpleScaling or StepScaling. For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide. + */ + AdjustmentType?: XmlStringMaxLen255; + /** + * Available for backward compatibility. Use MinAdjustmentMagnitude instead. + */ + MinAdjustmentStep?: MinAdjustmentStep; + /** + * The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError. This parameter is supported if the policy type is SimpleScaling or StepScaling. + */ + MinAdjustmentMagnitude?: MinAdjustmentMagnitude; + /** + * The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. Conditional: This parameter is required if the policy type is SimpleScaling and not supported otherwise. + */ + ScalingAdjustment?: PolicyIncrement; + /** + * The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies. This parameter is supported if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide. + */ + Cooldown?: Cooldown; + /** + * The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. This parameter is supported if the policy type is StepScaling. + */ + MetricAggregationType?: XmlStringMaxLen32; + /** + * A set of adjustments that enable you to scale based on the size of the alarm breach. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise. + */ + StepAdjustments?: StepAdjustments; + /** + * The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group. This parameter is supported if the policy type is StepScaling or TargetTrackingScaling. + */ + EstimatedInstanceWarmup?: EstimatedInstanceWarmup; + /** + * A target tracking scaling policy. Includes support for predefined or customized metrics. Conditional: This parameter is required if the policy type is TargetTrackingScaling and not supported otherwise. + */ + TargetTrackingConfiguration?: TargetTrackingConfiguration; + } + export interface PutScheduledUpdateGroupActionType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The name of this scaling action. + */ + ScheduledActionName: XmlStringMaxLen255; + /** + * This parameter is deprecated. + */ + Time?: TimestampType; + /** + * The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence. If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message. + */ + StartTime?: TimestampType; + /** + * The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time. + */ + EndTime?: TimestampType; + /** + * The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab. + */ + Recurrence?: XmlStringMaxLen255; + /** + * The minimum size for the Auto Scaling group. + */ + MinSize?: AutoScalingGroupMinSize; + /** + * The maximum size for the Auto Scaling group. + */ + MaxSize?: AutoScalingGroupMaxSize; + /** + * The number of EC2 instances that should be running in the group. + */ + DesiredCapacity?: AutoScalingGroupDesiredCapacity; + } + export interface RecordLifecycleActionHeartbeatAnswer { + } + export interface RecordLifecycleActionHeartbeatType { + /** + * The name of the lifecycle hook. + */ + LifecycleHookName: AsciiStringMaxLen255; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook. + */ + LifecycleActionToken?: LifecycleActionToken; + /** + * The ID of the instance. + */ + InstanceId?: XmlStringMaxLen19; + } + export type ResourceName = string; + export type ScalingActivityStatusCode = "PendingSpotBidPlacement"|"WaitingForSpotInstanceRequestId"|"WaitingForSpotInstanceId"|"WaitingForInstanceId"|"PreInService"|"InProgress"|"WaitingForELBConnectionDraining"|"MidLifecycleAction"|"WaitingForInstanceWarmup"|"Successful"|"Failed"|"Cancelled"|string; + export type ScalingPolicies = ScalingPolicy[]; + export interface ScalingPolicy { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: XmlStringMaxLen255; + /** + * The name of the scaling policy. + */ + PolicyName?: XmlStringMaxLen255; + /** + * The Amazon Resource Name (ARN) of the policy. + */ + PolicyARN?: ResourceName; + /** + * The policy type. The valid values are SimpleScaling and StepScaling. + */ + PolicyType?: XmlStringMaxLen64; + /** + * The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. + */ + AdjustmentType?: XmlStringMaxLen255; + /** + * Available for backward compatibility. Use MinAdjustmentMagnitude instead. + */ + MinAdjustmentStep?: MinAdjustmentStep; + /** + * The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError. + */ + MinAdjustmentMagnitude?: MinAdjustmentMagnitude; + /** + * The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. + */ + ScalingAdjustment?: PolicyIncrement; + /** + * The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. + */ + Cooldown?: Cooldown; + /** + * A set of adjustments that enable you to scale based on the size of the alarm breach. + */ + StepAdjustments?: StepAdjustments; + /** + * The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. + */ + MetricAggregationType?: XmlStringMaxLen32; + /** + * The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. + */ + EstimatedInstanceWarmup?: EstimatedInstanceWarmup; + /** + * The CloudWatch alarms related to the policy. + */ + Alarms?: Alarms; + /** + * A target tracking scaling policy. + */ + TargetTrackingConfiguration?: TargetTrackingConfiguration; + } + export interface ScalingProcessQuery { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * One or more of the following processes. If you omit this parameter, all processes are specified. Launch Terminate HealthCheck ReplaceUnhealthy AZRebalance AlarmNotification ScheduledActions AddToLoadBalancer + */ + ScalingProcesses?: ProcessNames; + } + export type ScheduledActionNames = ResourceName[]; + export interface ScheduledActionsType { + /** + * The scheduled actions. + */ + ScheduledUpdateGroupActions?: ScheduledUpdateGroupActions; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export interface ScheduledUpdateGroupAction { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName?: XmlStringMaxLen255; + /** + * The name of the scheduled action. + */ + ScheduledActionName?: XmlStringMaxLen255; + /** + * The Amazon Resource Name (ARN) of the scheduled action. + */ + ScheduledActionARN?: ResourceName; + /** + * This parameter is deprecated. + */ + Time?: TimestampType; + /** + * The date and time that the action is scheduled to begin. When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops. + */ + StartTime?: TimestampType; + /** + * The date and time that the action is scheduled to end. + */ + EndTime?: TimestampType; + /** + * The recurring schedule for the action. + */ + Recurrence?: XmlStringMaxLen255; + /** + * The minimum size of the group. + */ + MinSize?: AutoScalingGroupMinSize; + /** + * The maximum size of the group. + */ + MaxSize?: AutoScalingGroupMaxSize; + /** + * The number of instances you prefer to maintain in the group. + */ + DesiredCapacity?: AutoScalingGroupDesiredCapacity; + } + export interface ScheduledUpdateGroupActionRequest { + /** + * The name of the scaling action. + */ + ScheduledActionName: XmlStringMaxLen255; + /** + * The time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence. If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message. + */ + StartTime?: TimestampType; + /** + * The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time. + */ + EndTime?: TimestampType; + /** + * The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab. + */ + Recurrence?: XmlStringMaxLen255; + /** + * The minimum size of the group. + */ + MinSize?: AutoScalingGroupMinSize; + /** + * The maximum size of the group. + */ + MaxSize?: AutoScalingGroupMaxSize; + /** + * The number of EC2 instances that should be running in the group. + */ + DesiredCapacity?: AutoScalingGroupDesiredCapacity; + } + export type ScheduledUpdateGroupActionRequests = ScheduledUpdateGroupActionRequest[]; + export type ScheduledUpdateGroupActions = ScheduledUpdateGroupAction[]; + export type SecurityGroups = XmlString[]; + export interface SetDesiredCapacityType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The number of EC2 instances that should be running in the Auto Scaling group. + */ + DesiredCapacity: AutoScalingGroupDesiredCapacity; + /** + * Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities. + */ + HonorCooldown?: HonorCooldown; + } + export interface SetInstanceHealthQuery { + /** + * The ID of the instance. + */ + InstanceId: XmlStringMaxLen19; + /** + * The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance. + */ + HealthStatus: XmlStringMaxLen32; + /** + * If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group. For more information about the health check grace period, see CreateAutoScalingGroup. + */ + ShouldRespectGracePeriod?: ShouldRespectGracePeriod; + } + export interface SetInstanceProtectionAnswer { + } + export interface SetInstanceProtectionQuery { + /** + * One or more instance IDs. + */ + InstanceIds: InstanceIds; + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. + */ + ProtectedFromScaleIn: ProtectedFromScaleIn; + } + export type ShouldDecrementDesiredCapacity = boolean; + export type ShouldRespectGracePeriod = boolean; + export type SpotInstancePools = number; + export type SpotPrice = string; + export interface StepAdjustment { + /** + * The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. + */ + MetricIntervalLowerBound?: MetricScale; + /** + * The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound. + */ + MetricIntervalUpperBound?: MetricScale; + /** + * The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. + */ + ScalingAdjustment: PolicyIncrement; + } + export type StepAdjustments = StepAdjustment[]; + export interface SuspendedProcess { + /** + * The name of the suspended process. + */ + ProcessName?: XmlStringMaxLen255; + /** + * The reason that the process was suspended. + */ + SuspensionReason?: XmlStringMaxLen255; + } + export type SuspendedProcesses = SuspendedProcess[]; + export interface Tag { + /** + * The name of the group. + */ + ResourceId?: XmlString; + /** + * The type of resource. The only supported value is auto-scaling-group. + */ + ResourceType?: XmlString; + /** + * The tag key. + */ + Key: TagKey; + /** + * The tag value. + */ + Value?: TagValue; + /** + * Determines whether the tag is added to new instances as they are launched in the group. + */ + PropagateAtLaunch?: PropagateAtLaunch; + } + export interface TagDescription { + /** + * The name of the group. + */ + ResourceId?: XmlString; + /** + * The type of resource. The only supported value is auto-scaling-group. + */ + ResourceType?: XmlString; + /** + * The tag key. + */ + Key?: TagKey; + /** + * The tag value. + */ + Value?: TagValue; + /** + * Determines whether the tag is added to new instances as they are launched in the group. + */ + PropagateAtLaunch?: PropagateAtLaunch; + } + export type TagDescriptionList = TagDescription[]; + export type TagKey = string; + export type TagValue = string; + export type Tags = Tag[]; + export interface TagsType { + /** + * One or more tags. + */ + Tags?: TagDescriptionList; + /** + * A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return. + */ + NextToken?: XmlString; + } + export type TargetGroupARNs = XmlStringMaxLen511[]; + export interface TargetTrackingConfiguration { + /** + * A predefined metric. You can specify either a predefined metric or a customized metric. + */ + PredefinedMetricSpecification?: PredefinedMetricSpecification; + /** + * A customized metric. You can specify either a predefined metric or a customized metric. + */ + CustomizedMetricSpecification?: CustomizedMetricSpecification; + /** + * The target value for the metric. + */ + TargetValue: MetricScale; + /** + * Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is disabled. + */ + DisableScaleIn?: DisableScaleIn; + } + export interface TerminateInstanceInAutoScalingGroupType { + /** + * The ID of the instance. + */ + InstanceId: XmlStringMaxLen19; + /** + * Indicates whether terminating the instance also decrements the size of the Auto Scaling group. + */ + ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity; + } + export type TerminationPolicies = XmlStringMaxLen1600[]; + export type TimestampType = Date; + export interface UpdateAutoScalingGroupType { + /** + * The name of the Auto Scaling group. + */ + AutoScalingGroupName: ResourceName; + /** + * The name of the launch configuration. If you specify this parameter, you can't specify a launch template or a mixed instances policy. + */ + LaunchConfigurationName?: ResourceName; + /** + * The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy. + */ + LaunchTemplate?: LaunchTemplateSpecification; + /** + * The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide. + */ + MixedInstancesPolicy?: MixedInstancesPolicy; + /** + * The minimum size of the Auto Scaling group. + */ + MinSize?: AutoScalingGroupMinSize; + /** + * The maximum size of the Auto Scaling group. + */ + MaxSize?: AutoScalingGroupMaxSize; + /** + * The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. + */ + DesiredCapacity?: AutoScalingGroupDesiredCapacity; + /** + * The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide. + */ + DefaultCooldown?: Cooldown; + /** + * One or more Availability Zones for the group. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. + */ + HealthCheckType?: XmlStringMaxLen32; + /** + * The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you are adding an ELB health check. + */ + HealthCheckGracePeriod?: HealthCheckGracePeriod; + /** + * The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances. + */ + PlacementGroup?: XmlStringMaxLen255; + /** + * A comma-separated list of subnet IDs, if you are launching into a VPC. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones. + */ + VPCZoneIdentifier?: XmlStringMaxLen2047; + /** + * A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed. For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide. + */ + TerminationPolicies?: TerminationPolicies; + /** + * Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide. + */ + NewInstancesProtectedFromScaleIn?: InstanceProtected; + /** + * The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide. + */ + ServiceLinkedRoleARN?: ResourceName; + } + export type Values = XmlString[]; + export type XmlString = string; + export type XmlStringMaxLen1023 = string; + export type XmlStringMaxLen1600 = string; + export type XmlStringMaxLen19 = string; + export type XmlStringMaxLen2047 = string; + export type XmlStringMaxLen255 = string; + export type XmlStringMaxLen32 = string; + export type XmlStringMaxLen511 = string; + export type XmlStringMaxLen64 = string; + export type XmlStringUserData = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2011-01-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the AutoScaling client. + */ + export import Types = AutoScaling; +} +export = AutoScaling; diff --git a/node_modules/aws-sdk/clients/autoscaling.js b/node_modules/aws-sdk/clients/autoscaling.js new file mode 100644 index 0000000..fd09216 --- /dev/null +++ b/node_modules/aws-sdk/clients/autoscaling.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['autoscaling'] = {}; +AWS.AutoScaling = Service.defineService('autoscaling', ['2011-01-01']); +Object.defineProperty(apiLoader.services['autoscaling'], '2011-01-01', { + get: function get() { + var model = require('../apis/autoscaling-2011-01-01.min.json'); + model.paginators = require('../apis/autoscaling-2011-01-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.AutoScaling; diff --git a/node_modules/aws-sdk/clients/autoscalingplans.d.ts b/node_modules/aws-sdk/clients/autoscalingplans.d.ts new file mode 100644 index 0000000..0a8d072 --- /dev/null +++ b/node_modules/aws-sdk/clients/autoscalingplans.d.ts @@ -0,0 +1,551 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class AutoScalingPlans extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: AutoScalingPlans.Types.ClientConfiguration) + config: Config & AutoScalingPlans.Types.ClientConfiguration; + /** + * Creates a scaling plan. + */ + createScalingPlan(params: AutoScalingPlans.Types.CreateScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.CreateScalingPlanResponse) => void): Request; + /** + * Creates a scaling plan. + */ + createScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.CreateScalingPlanResponse) => void): Request; + /** + * Deletes the specified scaling plan. Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan. If the plan has launched resources or has scaling activities in progress, you must delete those resources separately. + */ + deleteScalingPlan(params: AutoScalingPlans.Types.DeleteScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DeleteScalingPlanResponse) => void): Request; + /** + * Deletes the specified scaling plan. Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan. If the plan has launched resources or has scaling activities in progress, you must delete those resources separately. + */ + deleteScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.DeleteScalingPlanResponse) => void): Request; + /** + * Describes the scalable resources in the specified scaling plan. + */ + describeScalingPlanResources(params: AutoScalingPlans.Types.DescribeScalingPlanResourcesRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse) => void): Request; + /** + * Describes the scalable resources in the specified scaling plan. + */ + describeScalingPlanResources(callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse) => void): Request; + /** + * Describes one or more of your scaling plans. + */ + describeScalingPlans(params: AutoScalingPlans.Types.DescribeScalingPlansRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlansResponse) => void): Request; + /** + * Describes one or more of your scaling plans. + */ + describeScalingPlans(callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlansResponse) => void): Request; + /** + * Retrieves the forecast data for a scalable resource. Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days. + */ + getScalingPlanResourceForecastData(params: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse) => void): Request; + /** + * Retrieves the forecast data for a scalable resource. Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days. + */ + getScalingPlanResourceForecastData(callback?: (err: AWSError, data: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse) => void): Request; + /** + * Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted. + */ + updateScalingPlan(params: AutoScalingPlans.Types.UpdateScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.UpdateScalingPlanResponse) => void): Request; + /** + * Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted. + */ + updateScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.UpdateScalingPlanResponse) => void): Request; +} +declare namespace AutoScalingPlans { + export interface ApplicationSource { + /** + * The Amazon Resource Name (ARN) of a AWS CloudFormation stack. + */ + CloudFormationStackARN?: XmlString; + /** + * A set of tags (up to 50). + */ + TagFilters?: TagFilters; + } + export type ApplicationSources = ApplicationSource[]; + export type Cooldown = number; + export interface CreateScalingPlanRequest { + /** + * The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes. + */ + ScalingPlanName: ScalingPlanName; + /** + * A CloudFormation stack or set of tags. You can create one scaling plan per application source. + */ + ApplicationSource: ApplicationSource; + /** + * The scaling instructions. + */ + ScalingInstructions: ScalingInstructions; + } + export interface CreateScalingPlanResponse { + /** + * The version number of the scaling plan. This value is always 1. Currently, you cannot specify multiple scaling plan versions. + */ + ScalingPlanVersion: ScalingPlanVersion; + } + export interface CustomizedLoadMetricSpecification { + /** + * The name of the metric. + */ + MetricName: MetricName; + /** + * The namespace of the metric. + */ + Namespace: MetricNamespace; + /** + * The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification. + */ + Dimensions?: MetricDimensions; + /** + * The statistic of the metric. Currently, the value must always be Sum. + */ + Statistic: MetricStatistic; + /** + * The unit of the metric. + */ + Unit?: MetricUnit; + } + export interface CustomizedScalingMetricSpecification { + /** + * The name of the metric. + */ + MetricName: MetricName; + /** + * The namespace of the metric. + */ + Namespace: MetricNamespace; + /** + * The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification. + */ + Dimensions?: MetricDimensions; + /** + * The statistic of the metric. + */ + Statistic: MetricStatistic; + /** + * The unit of the metric. + */ + Unit?: MetricUnit; + } + export interface Datapoint { + /** + * The time stamp for the data point in UTC format. + */ + Timestamp?: TimestampType; + /** + * The value of the data point. + */ + Value?: MetricScale; + } + export type Datapoints = Datapoint[]; + export interface DeleteScalingPlanRequest { + /** + * The name of the scaling plan. + */ + ScalingPlanName: ScalingPlanName; + /** + * The version number of the scaling plan. + */ + ScalingPlanVersion: ScalingPlanVersion; + } + export interface DeleteScalingPlanResponse { + } + export interface DescribeScalingPlanResourcesRequest { + /** + * The name of the scaling plan. + */ + ScalingPlanName: ScalingPlanName; + /** + * The version number of the scaling plan. + */ + ScalingPlanVersion: ScalingPlanVersion; + /** + * The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeScalingPlanResourcesResponse { + /** + * Information about the scalable resources. + */ + ScalingPlanResources?: ScalingPlanResources; + /** + * The token required to get the next set of results. This value is null if there are no more results to return. + */ + NextToken?: NextToken; + } + export interface DescribeScalingPlansRequest { + /** + * The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names. + */ + ScalingPlanNames?: ScalingPlanNames; + /** + * The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name. + */ + ScalingPlanVersion?: ScalingPlanVersion; + /** + * The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources. + */ + ApplicationSources?: ApplicationSources; + /** + * The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeScalingPlansResponse { + /** + * Information about the scaling plans. + */ + ScalingPlans?: ScalingPlans; + /** + * The token required to get the next set of results. This value is null if there are no more results to return. + */ + NextToken?: NextToken; + } + export type DisableDynamicScaling = boolean; + export type DisableScaleIn = boolean; + export type ForecastDataType = "CapacityForecast"|"LoadForecast"|"ScheduledActionMinCapacity"|"ScheduledActionMaxCapacity"|string; + export interface GetScalingPlanResourceForecastDataRequest { + /** + * The name of the scaling plan. + */ + ScalingPlanName: ScalingPlanName; + /** + * The version number of the scaling plan. + */ + ScalingPlanVersion: ScalingPlanVersion; + /** + * The namespace of the AWS service. + */ + ServiceNamespace: ServiceNamespace; + /** + * The ID of the resource. This string consists of the resource type and unique identifier. Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. + */ + ResourceId: XmlString; + /** + * The scalable dimension for the resource. + */ + ScalableDimension: ScalableDimension; + /** + * The type of forecast data to get. LoadForecast: The load metric forecast. CapacityForecast: The capacity forecast. ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction. ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction. + */ + ForecastDataType: ForecastDataType; + /** + * The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time. + */ + StartTime: TimestampType; + /** + * The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days. Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance. + */ + EndTime: TimestampType; + } + export interface GetScalingPlanResourceForecastDataResponse { + /** + * The data points to return. + */ + Datapoints: Datapoints; + } + export type LoadMetricType = "ASGTotalCPUUtilization"|"ASGTotalNetworkIn"|"ASGTotalNetworkOut"|"ALBTargetGroupRequestCount"|string; + export type MaxResults = number; + export interface MetricDimension { + /** + * The name of the dimension. + */ + Name: MetricDimensionName; + /** + * The value of the dimension. + */ + Value: MetricDimensionValue; + } + export type MetricDimensionName = string; + export type MetricDimensionValue = string; + export type MetricDimensions = MetricDimension[]; + export type MetricName = string; + export type MetricNamespace = string; + export type MetricScale = number; + export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string; + export type MetricUnit = string; + export type NextToken = string; + export type PolicyName = string; + export type PolicyType = "TargetTrackingScaling"|string; + export interface PredefinedLoadMetricSpecification { + /** + * The metric type. + */ + PredefinedLoadMetricType: LoadMetricType; + /** + * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group. The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where: app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN. targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN. + */ + ResourceLabel?: ResourceLabel; + } + export interface PredefinedScalingMetricSpecification { + /** + * The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services. + */ + PredefinedScalingMetricType: ScalingMetricType; + /** + * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service. The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where: app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN. targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN. + */ + ResourceLabel?: ResourceLabel; + } + export type PredictiveScalingMaxCapacityBehavior = "SetForecastCapacityToMaxCapacity"|"SetMaxCapacityToForecastCapacity"|"SetMaxCapacityAboveForecastCapacity"|string; + export type PredictiveScalingMode = "ForecastAndScale"|"ForecastOnly"|string; + export type ResourceCapacity = number; + export type ResourceIdMaxLen1600 = string; + export type ResourceLabel = string; + export type ScalableDimension = "autoscaling:autoScalingGroup:DesiredCapacity"|"ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"rds:cluster:ReadReplicaCount"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|string; + export interface ScalingInstruction { + /** + * The namespace of the AWS service. + */ + ServiceNamespace: ServiceNamespace; + /** + * The ID of the resource. This string consists of the resource type and unique identifier. Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension associated with the resource. autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + */ + ScalableDimension: ScalableDimension; + /** + * The minimum capacity of the resource. + */ + MinCapacity: ResourceCapacity; + /** + * The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior. + */ + MaxCapacity: ResourceCapacity; + /** + * The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out. Condition: The scaling metric must be unique across target tracking configurations. + */ + TargetTrackingConfigurations: TargetTrackingConfigurations; + /** + * The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise. + */ + PredefinedLoadMetricSpecification?: PredefinedLoadMetricSpecification; + /** + * The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise. + */ + CustomizedLoadMetricSpecification?: CustomizedLoadMetricSpecification; + /** + * The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Only valid when configuring predictive scaling. + */ + ScheduledActionBufferTime?: ScheduledActionBufferTime; + /** + * Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity. The following are possible values: SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit. SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity. SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs. Only valid when configuring predictive scaling. + */ + PredictiveScalingMaxCapacityBehavior?: PredictiveScalingMaxCapacityBehavior; + /** + * The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise. The range is 1-100. + */ + PredictiveScalingMaxCapacityBuffer?: ResourceCapacity; + /** + * The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast. + */ + PredictiveScalingMode?: PredictiveScalingMode; + /** + * Controls whether a resource's externally created scaling policies are kept or replaced. The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created. Only valid when configuring dynamic scaling. Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones. + */ + ScalingPolicyUpdateBehavior?: ScalingPolicyUpdateBehavior; + /** + * Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false). + */ + DisableDynamicScaling?: DisableDynamicScaling; + } + export type ScalingInstructions = ScalingInstruction[]; + export type ScalingMetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|string; + export interface ScalingPlan { + /** + * The name of the scaling plan. + */ + ScalingPlanName: ScalingPlanName; + /** + * The version number of the scaling plan. + */ + ScalingPlanVersion: ScalingPlanVersion; + /** + * The application source. + */ + ApplicationSource: ApplicationSource; + /** + * The scaling instructions. + */ + ScalingInstructions: ScalingInstructions; + /** + * The status of the scaling plan. Active - The scaling plan is active. ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied. CreationInProgress - The scaling plan is being created. CreationFailed - The scaling plan could not be created. DeletionInProgress - The scaling plan is being deleted. DeletionFailed - The scaling plan could not be deleted. UpdateInProgress - The scaling plan is being updated. UpdateFailed - The scaling plan could not be updated. + */ + StatusCode: ScalingPlanStatusCode; + /** + * A simple message about the current status of the scaling plan. + */ + StatusMessage?: XmlString; + /** + * The Unix time stamp when the scaling plan entered the current status. + */ + StatusStartTime?: TimestampType; + /** + * The Unix time stamp when the scaling plan was created. + */ + CreationTime?: TimestampType; + } + export type ScalingPlanName = string; + export type ScalingPlanNames = ScalingPlanName[]; + export interface ScalingPlanResource { + /** + * The name of the scaling plan. + */ + ScalingPlanName: ScalingPlanName; + /** + * The version number of the scaling plan. + */ + ScalingPlanVersion: ScalingPlanVersion; + /** + * The namespace of the AWS service. + */ + ServiceNamespace: ServiceNamespace; + /** + * The ID of the resource. This string consists of the resource type and unique identifier. Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. + */ + ResourceId: ResourceIdMaxLen1600; + /** + * The scalable dimension for the resource. autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + */ + ScalableDimension: ScalableDimension; + /** + * The scaling policies. + */ + ScalingPolicies?: ScalingPolicies; + /** + * The scaling status of the resource. Active - The scaling configuration is active. Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information. + */ + ScalingStatusCode: ScalingStatusCode; + /** + * A simple message about the current scaling status of the resource. + */ + ScalingStatusMessage?: XmlString; + } + export type ScalingPlanResources = ScalingPlanResource[]; + export type ScalingPlanStatusCode = "Active"|"ActiveWithProblems"|"CreationInProgress"|"CreationFailed"|"DeletionInProgress"|"DeletionFailed"|"UpdateInProgress"|"UpdateFailed"|string; + export type ScalingPlanVersion = number; + export type ScalingPlans = ScalingPlan[]; + export type ScalingPolicies = ScalingPolicy[]; + export interface ScalingPolicy { + /** + * The name of the scaling policy. + */ + PolicyName: PolicyName; + /** + * The type of scaling policy. + */ + PolicyType: PolicyType; + /** + * The target tracking scaling policy. Includes support for predefined or customized metrics. + */ + TargetTrackingConfiguration?: TargetTrackingConfiguration; + } + export type ScalingPolicyUpdateBehavior = "KeepExternalPolicies"|"ReplaceExternalPolicies"|string; + export type ScalingStatusCode = "Inactive"|"PartiallyActive"|"Active"|string; + export type ScheduledActionBufferTime = number; + export type ServiceNamespace = "autoscaling"|"ecs"|"ec2"|"rds"|"dynamodb"|string; + export interface TagFilter { + /** + * The tag key. + */ + Key?: XmlStringMaxLen128; + /** + * The tag values (0 to 20). + */ + Values?: TagValues; + } + export type TagFilters = TagFilter[]; + export type TagValues = XmlStringMaxLen256[]; + export interface TargetTrackingConfiguration { + /** + * A predefined metric. You can specify either a predefined metric or a customized metric. + */ + PredefinedScalingMetricSpecification?: PredefinedScalingMetricSpecification; + /** + * A customized metric. You can specify either a predefined metric or a customized metric. + */ + CustomizedScalingMetricSpecification?: CustomizedScalingMetricSpecification; + /** + * The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). + */ + TargetValue: MetricScale; + /** + * Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false. + */ + DisableScaleIn?: DisableScaleIn; + /** + * The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group. While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. + */ + ScaleOutCooldown?: Cooldown; + /** + * The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group. The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately. + */ + ScaleInCooldown?: Cooldown; + /** + * The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group. + */ + EstimatedInstanceWarmup?: Cooldown; + } + export type TargetTrackingConfigurations = TargetTrackingConfiguration[]; + export type TimestampType = Date; + export interface UpdateScalingPlanRequest { + /** + * The name of the scaling plan. + */ + ScalingPlanName: ScalingPlanName; + /** + * The version number of the scaling plan. + */ + ScalingPlanVersion: ScalingPlanVersion; + /** + * A CloudFormation stack or set of tags. + */ + ApplicationSource?: ApplicationSource; + /** + * The scaling instructions. + */ + ScalingInstructions?: ScalingInstructions; + } + export interface UpdateScalingPlanResponse { + } + export type XmlString = string; + export type XmlStringMaxLen128 = string; + export type XmlStringMaxLen256 = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-01-06"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the AutoScalingPlans client. + */ + export import Types = AutoScalingPlans; +} +export = AutoScalingPlans; diff --git a/node_modules/aws-sdk/clients/autoscalingplans.js b/node_modules/aws-sdk/clients/autoscalingplans.js new file mode 100644 index 0000000..aaf48eb --- /dev/null +++ b/node_modules/aws-sdk/clients/autoscalingplans.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['autoscalingplans'] = {}; +AWS.AutoScalingPlans = Service.defineService('autoscalingplans', ['2018-01-06']); +Object.defineProperty(apiLoader.services['autoscalingplans'], '2018-01-06', { + get: function get() { + var model = require('../apis/autoscaling-plans-2018-01-06.min.json'); + model.paginators = require('../apis/autoscaling-plans-2018-01-06.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.AutoScalingPlans; diff --git a/node_modules/aws-sdk/clients/backup.d.ts b/node_modules/aws-sdk/clients/backup.d.ts new file mode 100644 index 0000000..79b4f8c --- /dev/null +++ b/node_modules/aws-sdk/clients/backup.d.ts @@ -0,0 +1,1965 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Backup extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Backup.Types.ClientConfiguration) + config: Config & Backup.Types.ClientConfiguration; + /** + * Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources. If you call CreateBackupPlan with a plan that already exists, the existing backupPlanId is returned. + */ + createBackupPlan(params: Backup.Types.CreateBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.CreateBackupPlanOutput) => void): Request; + /** + * Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources. If you call CreateBackupPlan with a plan that already exists, the existing backupPlanId is returned. + */ + createBackupPlan(callback?: (err: AWSError, data: Backup.Types.CreateBackupPlanOutput) => void): Request; + /** + * Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources. For example, consider the following patterns: Resources: "arn:aws:ec2:region:account-id:volume/volume-id" ConditionKey:"department" ConditionValue:"finance" ConditionType:"StringEquals" ConditionKey:"importance" ConditionValue:"critical" ConditionType:"StringEquals" Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id. Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup. + */ + createBackupSelection(params: Backup.Types.CreateBackupSelectionInput, callback?: (err: AWSError, data: Backup.Types.CreateBackupSelectionOutput) => void): Request; + /** + * Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources. For example, consider the following patterns: Resources: "arn:aws:ec2:region:account-id:volume/volume-id" ConditionKey:"department" ConditionValue:"finance" ConditionType:"StringEquals" ConditionKey:"importance" ConditionValue:"critical" ConditionType:"StringEquals" Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id. Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup. + */ + createBackupSelection(callback?: (err: AWSError, data: Backup.Types.CreateBackupSelectionOutput) => void): Request; + /** + * Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Sensitive data, such as passport numbers, should not be included the name of a backup vault. + */ + createBackupVault(params: Backup.Types.CreateBackupVaultInput, callback?: (err: AWSError, data: Backup.Types.CreateBackupVaultOutput) => void): Request; + /** + * Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Sensitive data, such as passport numbers, should not be included the name of a backup vault. + */ + createBackupVault(callback?: (err: AWSError, data: Backup.Types.CreateBackupVaultOutput) => void): Request; + /** + * Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist. + */ + deleteBackupPlan(params: Backup.Types.DeleteBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.DeleteBackupPlanOutput) => void): Request; + /** + * Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist. + */ + deleteBackupPlan(callback?: (err: AWSError, data: Backup.Types.DeleteBackupPlanOutput) => void): Request; + /** + * Deletes the resource selection associated with a backup plan that is specified by the SelectionId. + */ + deleteBackupSelection(params: Backup.Types.DeleteBackupSelectionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the resource selection associated with a backup plan that is specified by the SelectionId. + */ + deleteBackupSelection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. + */ + deleteBackupVault(params: Backup.Types.DeleteBackupVaultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. + */ + deleteBackupVault(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the policy document that manages permissions on a backup vault. + */ + deleteBackupVaultAccessPolicy(params: Backup.Types.DeleteBackupVaultAccessPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the policy document that manages permissions on a backup vault. + */ + deleteBackupVaultAccessPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes event notifications for the specified backup vault. + */ + deleteBackupVaultNotifications(params: Backup.Types.DeleteBackupVaultNotificationsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes event notifications for the specified backup vault. + */ + deleteBackupVaultNotifications(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the recovery point specified by a recovery point ID. + */ + deleteRecoveryPoint(params: Backup.Types.DeleteRecoveryPointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the recovery point specified by a recovery point ID. + */ + deleteRecoveryPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns metadata associated with creating a backup of a resource. + */ + describeBackupJob(params: Backup.Types.DescribeBackupJobInput, callback?: (err: AWSError, data: Backup.Types.DescribeBackupJobOutput) => void): Request; + /** + * Returns metadata associated with creating a backup of a resource. + */ + describeBackupJob(callback?: (err: AWSError, data: Backup.Types.DescribeBackupJobOutput) => void): Request; + /** + * Returns metadata about a backup vault specified by its name. + */ + describeBackupVault(params: Backup.Types.DescribeBackupVaultInput, callback?: (err: AWSError, data: Backup.Types.DescribeBackupVaultOutput) => void): Request; + /** + * Returns metadata about a backup vault specified by its name. + */ + describeBackupVault(callback?: (err: AWSError, data: Backup.Types.DescribeBackupVaultOutput) => void): Request; + /** + * Returns information about a saved resource, including the last time it was backed-up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource. + */ + describeProtectedResource(params: Backup.Types.DescribeProtectedResourceInput, callback?: (err: AWSError, data: Backup.Types.DescribeProtectedResourceOutput) => void): Request; + /** + * Returns information about a saved resource, including the last time it was backed-up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource. + */ + describeProtectedResource(callback?: (err: AWSError, data: Backup.Types.DescribeProtectedResourceOutput) => void): Request; + /** + * Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. + */ + describeRecoveryPoint(params: Backup.Types.DescribeRecoveryPointInput, callback?: (err: AWSError, data: Backup.Types.DescribeRecoveryPointOutput) => void): Request; + /** + * Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. + */ + describeRecoveryPoint(callback?: (err: AWSError, data: Backup.Types.DescribeRecoveryPointOutput) => void): Request; + /** + * Returns metadata associated with a restore job that is specified by a job ID. + */ + describeRestoreJob(params: Backup.Types.DescribeRestoreJobInput, callback?: (err: AWSError, data: Backup.Types.DescribeRestoreJobOutput) => void): Request; + /** + * Returns metadata associated with a restore job that is specified by a job ID. + */ + describeRestoreJob(callback?: (err: AWSError, data: Backup.Types.DescribeRestoreJobOutput) => void): Request; + /** + * Returns the backup plan that is specified by the plan ID as a backup template. + */ + exportBackupPlanTemplate(params: Backup.Types.ExportBackupPlanTemplateInput, callback?: (err: AWSError, data: Backup.Types.ExportBackupPlanTemplateOutput) => void): Request; + /** + * Returns the backup plan that is specified by the plan ID as a backup template. + */ + exportBackupPlanTemplate(callback?: (err: AWSError, data: Backup.Types.ExportBackupPlanTemplateOutput) => void): Request; + /** + * Returns the body of a backup plan in JSON format, in addition to plan metadata. + */ + getBackupPlan(params: Backup.Types.GetBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.GetBackupPlanOutput) => void): Request; + /** + * Returns the body of a backup plan in JSON format, in addition to plan metadata. + */ + getBackupPlan(callback?: (err: AWSError, data: Backup.Types.GetBackupPlanOutput) => void): Request; + /** + * Returns a valid JSON document specifying a backup plan or an error. + */ + getBackupPlanFromJSON(params: Backup.Types.GetBackupPlanFromJSONInput, callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromJSONOutput) => void): Request; + /** + * Returns a valid JSON document specifying a backup plan or an error. + */ + getBackupPlanFromJSON(callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromJSONOutput) => void): Request; + /** + * Returns the template specified by its templateId as a backup plan. + */ + getBackupPlanFromTemplate(params: Backup.Types.GetBackupPlanFromTemplateInput, callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromTemplateOutput) => void): Request; + /** + * Returns the template specified by its templateId as a backup plan. + */ + getBackupPlanFromTemplate(callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromTemplateOutput) => void): Request; + /** + * Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. + */ + getBackupSelection(params: Backup.Types.GetBackupSelectionInput, callback?: (err: AWSError, data: Backup.Types.GetBackupSelectionOutput) => void): Request; + /** + * Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. + */ + getBackupSelection(callback?: (err: AWSError, data: Backup.Types.GetBackupSelectionOutput) => void): Request; + /** + * Returns the access policy document that is associated with the named backup vault. + */ + getBackupVaultAccessPolicy(params: Backup.Types.GetBackupVaultAccessPolicyInput, callback?: (err: AWSError, data: Backup.Types.GetBackupVaultAccessPolicyOutput) => void): Request; + /** + * Returns the access policy document that is associated with the named backup vault. + */ + getBackupVaultAccessPolicy(callback?: (err: AWSError, data: Backup.Types.GetBackupVaultAccessPolicyOutput) => void): Request; + /** + * Returns event notifications for the specified backup vault. + */ + getBackupVaultNotifications(params: Backup.Types.GetBackupVaultNotificationsInput, callback?: (err: AWSError, data: Backup.Types.GetBackupVaultNotificationsOutput) => void): Request; + /** + * Returns event notifications for the specified backup vault. + */ + getBackupVaultNotifications(callback?: (err: AWSError, data: Backup.Types.GetBackupVaultNotificationsOutput) => void): Request; + /** + * Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was created with. The second set lists the metadata key-value pairs that are required to restore the recovery point. These sets can be the same, or the restore metadata set can contain different values if the target service to be restored has changed since the recovery point was created and now requires additional or different information in order to be restored. + */ + getRecoveryPointRestoreMetadata(params: Backup.Types.GetRecoveryPointRestoreMetadataInput, callback?: (err: AWSError, data: Backup.Types.GetRecoveryPointRestoreMetadataOutput) => void): Request; + /** + * Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was created with. The second set lists the metadata key-value pairs that are required to restore the recovery point. These sets can be the same, or the restore metadata set can contain different values if the target service to be restored has changed since the recovery point was created and now requires additional or different information in order to be restored. + */ + getRecoveryPointRestoreMetadata(callback?: (err: AWSError, data: Backup.Types.GetRecoveryPointRestoreMetadataOutput) => void): Request; + /** + * Returns the AWS resource types supported by AWS Backup. + */ + getSupportedResourceTypes(callback?: (err: AWSError, data: Backup.Types.GetSupportedResourceTypesOutput) => void): Request; + /** + * Returns metadata about your backup jobs. + */ + listBackupJobs(params: Backup.Types.ListBackupJobsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupJobsOutput) => void): Request; + /** + * Returns metadata about your backup jobs. + */ + listBackupJobs(callback?: (err: AWSError, data: Backup.Types.ListBackupJobsOutput) => void): Request; + /** + * Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates. + */ + listBackupPlanTemplates(params: Backup.Types.ListBackupPlanTemplatesInput, callback?: (err: AWSError, data: Backup.Types.ListBackupPlanTemplatesOutput) => void): Request; + /** + * Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates. + */ + listBackupPlanTemplates(callback?: (err: AWSError, data: Backup.Types.ListBackupPlanTemplatesOutput) => void): Request; + /** + * Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. + */ + listBackupPlanVersions(params: Backup.Types.ListBackupPlanVersionsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupPlanVersionsOutput) => void): Request; + /** + * Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. + */ + listBackupPlanVersions(callback?: (err: AWSError, data: Backup.Types.ListBackupPlanVersionsOutput) => void): Request; + /** + * Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs. + */ + listBackupPlans(params: Backup.Types.ListBackupPlansInput, callback?: (err: AWSError, data: Backup.Types.ListBackupPlansOutput) => void): Request; + /** + * Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs. + */ + listBackupPlans(callback?: (err: AWSError, data: Backup.Types.ListBackupPlansOutput) => void): Request; + /** + * Returns an array containing metadata of the resources associated with the target backup plan. + */ + listBackupSelections(params: Backup.Types.ListBackupSelectionsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupSelectionsOutput) => void): Request; + /** + * Returns an array containing metadata of the resources associated with the target backup plan. + */ + listBackupSelections(callback?: (err: AWSError, data: Backup.Types.ListBackupSelectionsOutput) => void): Request; + /** + * Returns a list of recovery point storage containers along with information about them. + */ + listBackupVaults(params: Backup.Types.ListBackupVaultsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupVaultsOutput) => void): Request; + /** + * Returns a list of recovery point storage containers along with information about them. + */ + listBackupVaults(callback?: (err: AWSError, data: Backup.Types.ListBackupVaultsOutput) => void): Request; + /** + * Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type. + */ + listProtectedResources(params: Backup.Types.ListProtectedResourcesInput, callback?: (err: AWSError, data: Backup.Types.ListProtectedResourcesOutput) => void): Request; + /** + * Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type. + */ + listProtectedResources(callback?: (err: AWSError, data: Backup.Types.ListProtectedResourcesOutput) => void): Request; + /** + * Returns detailed information about the recovery points stored in a backup vault. + */ + listRecoveryPointsByBackupVault(params: Backup.Types.ListRecoveryPointsByBackupVaultInput, callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByBackupVaultOutput) => void): Request; + /** + * Returns detailed information about the recovery points stored in a backup vault. + */ + listRecoveryPointsByBackupVault(callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByBackupVaultOutput) => void): Request; + /** + * Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN). + */ + listRecoveryPointsByResource(params: Backup.Types.ListRecoveryPointsByResourceInput, callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByResourceOutput) => void): Request; + /** + * Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN). + */ + listRecoveryPointsByResource(callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByResourceOutput) => void): Request; + /** + * Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process. + */ + listRestoreJobs(params: Backup.Types.ListRestoreJobsInput, callback?: (err: AWSError, data: Backup.Types.ListRestoreJobsOutput) => void): Request; + /** + * Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process. + */ + listRestoreJobs(callback?: (err: AWSError, data: Backup.Types.ListRestoreJobsOutput) => void): Request; + /** + * Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. + */ + listTags(params: Backup.Types.ListTagsInput, callback?: (err: AWSError, data: Backup.Types.ListTagsOutput) => void): Request; + /** + * Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. + */ + listTags(callback?: (err: AWSError, data: Backup.Types.ListTagsOutput) => void): Request; + /** + * Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format. + */ + putBackupVaultAccessPolicy(params: Backup.Types.PutBackupVaultAccessPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format. + */ + putBackupVaultAccessPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Turns on notifications on a backup vault for the specified topic and events. + */ + putBackupVaultNotifications(params: Backup.Types.PutBackupVaultNotificationsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Turns on notifications on a backup vault for the specified topic and events. + */ + putBackupVaultNotifications(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts a job to create a one-time backup of the specified resource. + */ + startBackupJob(params: Backup.Types.StartBackupJobInput, callback?: (err: AWSError, data: Backup.Types.StartBackupJobOutput) => void): Request; + /** + * Starts a job to create a one-time backup of the specified resource. + */ + startBackupJob(callback?: (err: AWSError, data: Backup.Types.StartBackupJobOutput) => void): Request; + /** + * Recovers the saved resource identified by an Amazon Resource Name (ARN). If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored. + */ + startRestoreJob(params: Backup.Types.StartRestoreJobInput, callback?: (err: AWSError, data: Backup.Types.StartRestoreJobOutput) => void): Request; + /** + * Recovers the saved resource identified by an Amazon Resource Name (ARN). If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored. + */ + startRestoreJob(callback?: (err: AWSError, data: Backup.Types.StartRestoreJobOutput) => void): Request; + /** + * Attempts to cancel a job to create a one-time backup of a resource. + */ + stopBackupJob(params: Backup.Types.StopBackupJobInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attempts to cancel a job to create a one-time backup of a resource. + */ + stopBackupJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN). + */ + tagResource(params: Backup.Types.TagResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN). + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) + */ + untagResource(params: Backup.Types.UntagResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId. + */ + updateBackupPlan(params: Backup.Types.UpdateBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.UpdateBackupPlanOutput) => void): Request; + /** + * Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId. + */ + updateBackupPlan(callback?: (err: AWSError, data: Backup.Types.UpdateBackupPlanOutput) => void): Request; + /** + * Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + updateRecoveryPointLifecycle(params: Backup.Types.UpdateRecoveryPointLifecycleInput, callback?: (err: AWSError, data: Backup.Types.UpdateRecoveryPointLifecycleOutput) => void): Request; + /** + * Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + updateRecoveryPointLifecycle(callback?: (err: AWSError, data: Backup.Types.UpdateRecoveryPointLifecycleOutput) => void): Request; +} +declare namespace Backup { + export type ARN = string; + export interface BackupJob { + /** + * Uniquely identifies a request to AWS Backup to back up a resource. + */ + BackupJobId?: string; + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + ResourceArn?: ARN; + /** + * The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CompletionDate?: timestamp; + /** + * The current state of a resource recovery point. + */ + State?: BackupJobState; + /** + * A detailed message explaining the status of the job to back up a resource. + */ + StatusMessage?: string; + /** + * Contains an estimated percentage complete of a job at the time the job status was queried. + */ + PercentDone?: string; + /** + * The size, in bytes, of a backup. + */ + BackupSizeInBytes?: Long; + /** + * Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn?: IAMRoleArn; + /** + * Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it. + */ + CreatedBy?: RecoveryPointCreator; + /** + * The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + ExpectedCompletionDate?: timestamp; + /** + * Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + StartBy?: timestamp; + /** + * The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. + */ + ResourceType?: ResourceType; + /** + * The size in bytes transferred to a backup vault at the time that the job status was queried. + */ + BytesTransferred?: Long; + } + export type BackupJobState = "CREATED"|"PENDING"|"RUNNING"|"ABORTING"|"ABORTED"|"COMPLETED"|"FAILED"|"EXPIRED"|string; + export type BackupJobsList = BackupJob[]; + export interface BackupPlan { + /** + * The display name of a backup plan. + */ + BackupPlanName: BackupPlanName; + /** + * An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources. + */ + Rules: BackupRules; + } + export interface BackupPlanInput { + /** + * The display name of a backup plan. + */ + BackupPlanName: BackupPlanName; + /** + * An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources. + */ + Rules: BackupRulesInput; + } + export type BackupPlanName = string; + export type BackupPlanTemplatesList = BackupPlanTemplatesListMember[]; + export interface BackupPlanTemplatesListMember { + /** + * Uniquely identifies a stored backup plan template. + */ + BackupPlanTemplateId?: string; + /** + * The optional display name of a backup plan template. + */ + BackupPlanTemplateName?: string; + } + export type BackupPlanVersionsList = BackupPlansListMember[]; + export type BackupPlansList = BackupPlansListMember[]; + export interface BackupPlansListMember { + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + */ + BackupPlanArn?: ARN; + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + DeletionDate?: timestamp; + /** + * Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. + */ + VersionId?: string; + /** + * The display name of a saved backup plan. + */ + BackupPlanName?: BackupPlanName; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + /** + * The last time a job to back up resources was executed with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + LastExecutionDate?: timestamp; + } + export interface BackupRule { + /** + * An optional display name for a backup rule. + */ + RuleName: BackupRuleName; + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + TargetBackupVaultName: BackupVaultName; + /** + * A CRON expression specifying when AWS Backup initiates a backup job. + */ + ScheduleExpression?: CronExpression; + /** + * An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully. + */ + StartWindowMinutes?: WindowMinutes; + /** + * A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional. + */ + CompletionWindowMinutes?: WindowMinutes; + /** + * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + Lifecycle?: Lifecycle; + /** + * An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup. + */ + RecoveryPointTags?: Tags; + /** + * Uniquely identifies a rule that is used to schedule the backup of a selection of resources. + */ + RuleId?: string; + } + export interface BackupRuleInput { + /** + * >An optional display name for a backup rule. + */ + RuleName: BackupRuleName; + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + TargetBackupVaultName: BackupVaultName; + /** + * A CRON expression specifying when AWS Backup initiates a backup job. + */ + ScheduleExpression?: CronExpression; + /** + * The amount of time in minutes before beginning a backup. + */ + StartWindowMinutes?: WindowMinutes; + /** + * The amount of time AWS Backup attempts a backup before canceling the job and returning an error. + */ + CompletionWindowMinutes?: WindowMinutes; + /** + * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + Lifecycle?: Lifecycle; + /** + * To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. + */ + RecoveryPointTags?: Tags; + } + export type BackupRuleName = string; + export type BackupRules = BackupRule[]; + export type BackupRulesInput = BackupRuleInput[]; + export interface BackupSelection { + /** + * The display name of a resource selection document. + */ + SelectionName: BackupSelectionName; + /** + * The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn: IAMRoleArn; + /** + * An array of strings that either contain Amazon Resource Names (ARNs) or match patterns such as "arn:aws:ec2:us-east-1:123456789012:volume/*" of resources to assign to a backup plan. + */ + Resources?: ResourceArns; + /** + * An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting". + */ + ListOfTags?: ListOfTags; + } + export type BackupSelectionName = string; + export type BackupSelectionsList = BackupSelectionsListMember[]; + export interface BackupSelectionsListMember { + /** + * Uniquely identifies a request to assign a set of resources to a backup plan. + */ + SelectionId?: string; + /** + * The display name of a resource selection document. + */ + SelectionName?: BackupSelectionName; + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + /** + * Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn?: IAMRoleArn; + } + export type BackupVaultEvent = "BACKUP_JOB_STARTED"|"BACKUP_JOB_COMPLETED"|"RESTORE_JOB_STARTED"|"RESTORE_JOB_COMPLETED"|"RECOVERY_POINT_MODIFIED"|"BACKUP_PLAN_CREATED"|"BACKUP_PLAN_MODIFIED"|string; + export type BackupVaultEvents = BackupVaultEvent[]; + export type BackupVaultList = BackupVaultListMember[]; + export interface BackupVaultListMember { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + */ + EncryptionKeyArn?: ARN; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + /** + * The number of recovery points that are stored in a backup vault. + */ + NumberOfRecoveryPoints?: long; + } + export type BackupVaultName = string; + export type Boolean = boolean; + export interface CalculatedLifecycle { + /** + * A timestamp that specifies when to transition a recovery point to cold storage. + */ + MoveToColdStorageAt?: timestamp; + /** + * A timestamp that specifies when to delete a recovery point. + */ + DeleteAt?: timestamp; + } + export interface Condition { + /** + * An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection. + */ + ConditionType: ConditionType; + /** + * The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key. + */ + ConditionKey: ConditionKey; + /** + * The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value. + */ + ConditionValue: ConditionValue; + } + export type ConditionKey = string; + export type ConditionType = "STRINGEQUALS"|string; + export type ConditionValue = string; + export interface CreateBackupPlanInput { + /** + * Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules. + */ + BackupPlan: BackupPlanInput; + /** + * To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan. + */ + BackupPlanTags?: Tags; + /** + * Identifies the request and allows failed requests to be retried without the risk of executing the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional. + */ + CreatorRequestId?: string; + } + export interface CreateBackupPlanOutput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + */ + BackupPlanArn?: ARN; + /** + * The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1024 bytes long. They cannot be edited. + */ + VersionId?: string; + } + export interface CreateBackupSelectionInput { + /** + * Uniquely identifies the backup plan to be associated with the selection of resources. + */ + BackupPlanId: string; + /** + * Specifies the body of a request to assign a set of resources to a backup plan. It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources. + */ + BackupSelection: BackupSelection; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + } + export interface CreateBackupSelectionOutput { + /** + * Uniquely identifies the body of a request to assign a set of resources to a backup plan. + */ + SelectionId?: string; + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + } + export interface CreateBackupVaultInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair. + */ + BackupVaultTags?: Tags; + /** + * The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + */ + EncryptionKeyArn?: ARN; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + } + export interface CreateBackupVaultOutput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + } + export type CronExpression = string; + export interface DeleteBackupPlanInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + } + export interface DeleteBackupPlanOutput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + */ + BackupPlanArn?: ARN; + /** + * The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + DeletionDate?: timestamp; + /** + * Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited. + */ + VersionId?: string; + } + export interface DeleteBackupSelectionInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + /** + * Uniquely identifies the body of a request to assign a set of resources to a backup plan. + */ + SelectionId: string; + } + export interface DeleteBackupVaultAccessPolicyInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + } + export interface DeleteBackupVaultInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and theAWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: string; + } + export interface DeleteBackupVaultNotificationsInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + } + export interface DeleteRecoveryPointInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn: ARN; + } + export interface DescribeBackupJobInput { + /** + * Uniquely identifies a request to AWS Backup to back up a resource. + */ + BackupJobId: string; + } + export interface DescribeBackupJobOutput { + /** + * Uniquely identifies a request to AWS Backup to back up a resource. + */ + BackupJobId?: string; + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type. + */ + ResourceArn?: ARN; + /** + * The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CompletionDate?: timestamp; + /** + * The current state of a resource recovery point. + */ + State?: BackupJobState; + /** + * A detailed message explaining the status of the job to back up a resource. + */ + StatusMessage?: string; + /** + * Contains an estimated percentage that is complete of a job at the time the job status was queried. + */ + PercentDone?: string; + /** + * The size, in bytes, of a backup. + */ + BackupSizeInBytes?: Long; + /** + * Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn?: IAMRoleArn; + /** + * Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it. + */ + CreatedBy?: RecoveryPointCreator; + /** + * The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. + */ + ResourceType?: ResourceType; + /** + * The size in bytes transferred to a backup vault at the time that the job status was queried. + */ + BytesTransferred?: Long; + /** + * The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + ExpectedCompletionDate?: timestamp; + /** + * Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + StartBy?: timestamp; + } + export interface DescribeBackupVaultInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: string; + } + export interface DescribeBackupVaultOutput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: string; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + */ + EncryptionKeyArn?: ARN; + /** + * The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + /** + * The number of recovery points that are stored in a backup vault. + */ + NumberOfRecoveryPoints?: long; + } + export interface DescribeProtectedResourceInput { + /** + * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + ResourceArn: ARN; + } + export interface DescribeProtectedResourceOutput { + /** + * An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + ResourceArn?: ARN; + /** + * The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDS database. + */ + ResourceType?: ResourceType; + /** + * The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + LastBackupTime?: timestamp; + } + export interface DescribeRecoveryPointInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn: ARN; + } + export interface DescribeRecoveryPointOutput { + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type. + */ + ResourceArn?: ARN; + /** + * The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. + */ + ResourceType?: ResourceType; + /** + * Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it. + */ + CreatedBy?: RecoveryPointCreator; + /** + * Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn?: IAMRoleArn; + /** + * A status code specifying the state of the recovery point. A partial status indicates that the recovery point was not successfully re-created and must be retried. + */ + Status?: RecoveryPointStatus; + /** + * The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CompletionDate?: timestamp; + /** + * The size, in bytes, of a backup. + */ + BackupSizeInBytes?: Long; + /** + * A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps. + */ + CalculatedLifecycle?: CalculatedLifecycle; + /** + * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + Lifecycle?: Lifecycle; + /** + * The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + */ + EncryptionKeyArn?: ARN; + /** + * A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted. + */ + IsEncrypted?: boolean; + /** + * Specifies the storage class of the recovery point. Valid values are WARM or COLD. + */ + StorageClass?: StorageClass; + /** + * The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + LastRestoreTime?: timestamp; + } + export interface DescribeRestoreJobInput { + /** + * Uniquely identifies the job that restores a recovery point. + */ + RestoreJobId: RestoreJobId; + } + export interface DescribeRestoreJobOutput { + /** + * Uniquely identifies the job that restores a recovery point. + */ + RestoreJobId?: string; + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CompletionDate?: timestamp; + /** + * Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point. + */ + Status?: RestoreJobStatus; + /** + * A detailed message explaining the status of a job to restore a recovery point. + */ + StatusMessage?: string; + /** + * Contains an estimated percentage that is complete of a job at the time the job status was queried. + */ + PercentDone?: string; + /** + * The size, in bytes, of the restored resource. + */ + BackupSizeInBytes?: Long; + /** + * Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn?: IAMRoleArn; + /** + * The amount of time in minutes that a job restoring a recovery point is expected to take. + */ + ExpectedCompletionTimeMinutes?: Long; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource. + */ + CreatedResourceArn?: ARN; + } + export interface ExportBackupPlanTemplateInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + } + export interface ExportBackupPlanTemplateOutput { + /** + * The body of a backup plan template in JSON format. This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON. + */ + BackupPlanTemplateJson?: string; + } + export interface GetBackupPlanFromJSONInput { + /** + * A customer-supplied backup plan document in JSON format. + */ + BackupPlanTemplateJson: string; + } + export interface GetBackupPlanFromJSONOutput { + /** + * Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules. + */ + BackupPlan?: BackupPlan; + } + export interface GetBackupPlanFromTemplateInput { + /** + * Uniquely identifies a stored backup plan template. + */ + BackupPlanTemplateId: string; + } + export interface GetBackupPlanFromTemplateOutput { + /** + * Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan. + */ + BackupPlanDocument?: BackupPlan; + } + export interface GetBackupPlanInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + /** + * Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. + */ + VersionId?: string; + } + export interface GetBackupPlanOutput { + /** + * Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules. + */ + BackupPlan?: BackupPlan; + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + */ + BackupPlanArn?: ARN; + /** + * Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. + */ + VersionId?: string; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + /** + * The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + DeletionDate?: timestamp; + /** + * The last time a job to back up resources was executed with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + LastExecutionDate?: timestamp; + } + export interface GetBackupSelectionInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + /** + * Uniquely identifies the body of a request to assign a set of resources to a backup plan. + */ + SelectionId: string; + } + export interface GetBackupSelectionOutput { + /** + * Specifies the body of a request to assign a set of resources to a backup plan. It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service that the resource belongs to, and an optional array of tags used to identify a set of resources. + */ + BackupSelection?: BackupSelection; + /** + * Uniquely identifies the body of a request to assign a set of resources to a backup plan. + */ + SelectionId?: string; + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: string; + } + export interface GetBackupVaultAccessPolicyInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + } + export interface GetBackupVaultAccessPolicyOutput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * The backup vault access policy document in JSON format. + */ + Policy?: IAMPolicy; + } + export interface GetBackupVaultNotificationsInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + } + export interface GetBackupVaultNotificationsOutput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic. + */ + SNSTopicArn?: ARN; + /** + * An array of events that indicate the status of jobs to back up resources to the backup vault. + */ + BackupVaultEvents?: BackupVaultEvents; + } + export interface GetRecoveryPointRestoreMetadataInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn: ARN; + } + export interface GetRecoveryPointRestoreMetadataOutput { + /** + * An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * A set of metadata key-value pairs that lists the metadata key-value pairs that are required to restore the recovery point. + */ + RestoreMetadata?: Metadata; + } + export interface GetSupportedResourceTypesOutput { + /** + * Contains a string with the supported AWS resource types: EBS for Amazon Elastic Block Store SGW for AWS Storage Gateway RDS for Amazon Relational Database Service DDB for Amazon DynamoDB EFS for Amazon Elastic File System + */ + ResourceTypes?: ResourceTypes; + } + export type IAMPolicy = string; + export type IAMRoleArn = string; + export interface Lifecycle { + /** + * Specifies the number of days after creation that a recovery point is moved to cold storage. + */ + MoveToColdStorageAfterDays?: Long; + /** + * Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays. + */ + DeleteAfterDays?: Long; + } + export interface ListBackupJobsInput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + /** + * Returns only backup jobs that match the specified resource Amazon Resource Name (ARN). + */ + ByResourceArn?: ARN; + /** + * Returns only backup jobs that are in the specified state. + */ + ByState?: BackupJobState; + /** + * Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + ByBackupVaultName?: BackupVaultName; + /** + * Returns only backup jobs that were created before the specified date. + */ + ByCreatedBefore?: timestamp; + /** + * Returns only backup jobs that were created after the specified date. + */ + ByCreatedAfter?: timestamp; + /** + * Returns only backup jobs for the specified resources: EBS for Amazon Elastic Block Store SGW for AWS Storage Gateway RDS for Amazon Relational Database Service DDB for Amazon DynamoDB EFS for Amazon Elastic File System + */ + ByResourceType?: ResourceType; + } + export interface ListBackupJobsOutput { + /** + * An array of structures containing metadata about your backup jobs returned in JSON format. + */ + BackupJobs?: BackupJobsList; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + } + export interface ListBackupPlanTemplatesInput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListBackupPlanTemplatesOutput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * An array of template list items containing metadata about your saved templates. + */ + BackupPlanTemplatesList?: BackupPlanTemplatesList; + } + export interface ListBackupPlanVersionsInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListBackupPlanVersionsOutput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * An array of version list items containing metadata about your backup plans. + */ + BackupPlanVersionsList?: BackupPlanVersionsList; + } + export interface ListBackupPlansInput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + /** + * A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE. + */ + IncludeDeleted?: Boolean; + } + export interface ListBackupPlansOutput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * An array of backup plan list items containing metadata about your saved backup plans. + */ + BackupPlansList?: BackupPlansList; + } + export interface ListBackupSelectionsInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListBackupSelectionsOutput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * An array of backup selection list items containing metadata about each resource in the list. + */ + BackupSelectionsList?: BackupSelectionsList; + } + export interface ListBackupVaultsInput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListBackupVaultsOutput { + /** + * An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted. + */ + BackupVaultList?: BackupVaultList; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + } + export type ListOfTags = Condition[]; + export interface ListProtectedResourcesInput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListProtectedResourcesOutput { + /** + * An array of resources successfully backed up by AWS Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type. + */ + Results?: ProtectedResourcesList; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + } + export interface ListRecoveryPointsByBackupVaultInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + /** + * Returns only recovery points that match the specified resource Amazon Resource Name (ARN). + */ + ByResourceArn?: ARN; + /** + * Returns only recovery points that match the specified resource type. + */ + ByResourceType?: ResourceType; + /** + * Returns only recovery points that match the specified backup plan ID. + */ + ByBackupPlanId?: string; + /** + * Returns only recovery points that were created before the specified timestamp. + */ + ByCreatedBefore?: timestamp; + /** + * Returns only recovery points that were created after the specified timestamp. + */ + ByCreatedAfter?: timestamp; + } + export interface ListRecoveryPointsByBackupVaultOutput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * An array of objects that contain detailed information about recovery points saved in a backup vault. + */ + RecoveryPoints?: RecoveryPointByBackupVaultList; + } + export interface ListRecoveryPointsByResourceInput { + /** + * An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + ResourceArn: ARN; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListRecoveryPointsByResourceOutput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * An array of objects that contain detailed information about recovery points of the specified resource type. + */ + RecoveryPoints?: RecoveryPointByResourceList; + } + export interface ListRestoreJobsInput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListRestoreJobsOutput { + /** + * An array of objects that contain detailed information about jobs to restore saved resources. + */ + RestoreJobs?: RestoreJobsList; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + } + export interface ListTagsInput { + /** + * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults. + */ + ResourceArn: ARN; + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * The maximum number of items to be returned. + */ + MaxResults?: MaxResults; + } + export interface ListTagsOutput { + /** + * The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. + */ + NextToken?: string; + /** + * To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair. + */ + Tags?: Tags; + } + export type Long = number; + export type MaxResults = number; + export type Metadata = {[key: string]: MetadataValue}; + export type MetadataKey = string; + export type MetadataValue = string; + export interface ProtectedResource { + /** + * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + ResourceArn?: ARN; + /** + * The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. + */ + ResourceType?: ResourceType; + /** + * The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + LastBackupTime?: timestamp; + } + export type ProtectedResourcesList = ProtectedResource[]; + export interface PutBackupVaultAccessPolicyInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * The backup vault access policy document in JSON format. + */ + Policy?: IAMPolicy; + } + export interface PutBackupVaultNotificationsInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic. + */ + SNSTopicArn: ARN; + /** + * An array of events that indicate the status of jobs to back up resources to the backup vault. + */ + BackupVaultEvents: BackupVaultEvents; + } + export interface RecoveryPointByBackupVault { + /** + * An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + /** + * An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + ResourceArn?: ARN; + /** + * The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. + */ + ResourceType?: ResourceType; + /** + * Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it. + */ + CreatedBy?: RecoveryPointCreator; + /** + * Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn?: IAMRoleArn; + /** + * A status code specifying the state of the recovery point. + */ + Status?: RecoveryPointStatus; + /** + * The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CompletionDate?: timestamp; + /** + * The size, in bytes, of a backup. + */ + BackupSizeInBytes?: Long; + /** + * A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps. + */ + CalculatedLifecycle?: CalculatedLifecycle; + /** + * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + Lifecycle?: Lifecycle; + /** + * The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + */ + EncryptionKeyArn?: ARN; + /** + * A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted. + */ + IsEncrypted?: boolean; + /** + * The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + LastRestoreTime?: timestamp; + } + export type RecoveryPointByBackupVaultList = RecoveryPointByBackupVault[]; + export interface RecoveryPointByResource { + /** + * An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * A status code specifying the state of the recovery point. + */ + Status?: RecoveryPointStatus; + /** + * The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + */ + EncryptionKeyArn?: ARN; + /** + * The size, in bytes, of a backup. + */ + BackupSizeBytes?: Long; + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName?: BackupVaultName; + } + export type RecoveryPointByResourceList = RecoveryPointByResource[]; + export interface RecoveryPointCreator { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + */ + BackupPlanArn?: ARN; + /** + * Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. + */ + BackupPlanVersion?: string; + /** + * Uniquely identifies a rule used to schedule the backup of a selection of resources. + */ + BackupRuleId?: string; + } + export type RecoveryPointStatus = "COMPLETED"|"PARTIAL"|"DELETING"|"EXPIRED"|string; + export type ResourceArns = ARN[]; + export type ResourceType = string; + export type ResourceTypes = ResourceType[]; + export type RestoreJobId = string; + export type RestoreJobStatus = "PENDING"|"RUNNING"|"COMPLETED"|"ABORTED"|"FAILED"|string; + export type RestoreJobsList = RestoreJobsListMember[]; + export interface RestoreJobsListMember { + /** + * Uniquely identifies the job that restores a recovery point. + */ + RestoreJobId?: string; + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CompletionDate?: timestamp; + /** + * A status code specifying the state of the job initiated by AWS Backup to restore a recovery point. + */ + Status?: RestoreJobStatus; + /** + * A detailed message explaining the status of the job to restore a recovery point. + */ + StatusMessage?: string; + /** + * Contains an estimated percentage complete of a job at the time the job status was queried. + */ + PercentDone?: string; + /** + * The size, in bytes, of the restored resource. + */ + BackupSizeInBytes?: Long; + /** + * Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn?: IAMRoleArn; + /** + * The amount of time in minutes that a job restoring a recovery point is expected to take. + */ + ExpectedCompletionTimeMinutes?: Long; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + CreatedResourceArn?: ARN; + } + export interface StartBackupJobInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. + */ + ResourceArn: ARN; + /** + * Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn: IAMRoleArn; + /** + * A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups. + */ + IdempotencyToken?: string; + /** + * The amount of time in minutes before beginning a backup. + */ + StartWindowMinutes?: WindowMinutes; + /** + * The amount of time AWS Backup attempts a backup before canceling the job and returning an error. + */ + CompleteWindowMinutes?: WindowMinutes; + /** + * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + Lifecycle?: Lifecycle; + /** + * To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. + */ + RecoveryPointTags?: Tags; + } + export interface StartBackupJobOutput { + /** + * Uniquely identifies a request to AWS Backup to back up a resource. + */ + BackupJobId?: string; + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + } + export interface StartRestoreJobInput { + /** + * An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn: ARN; + /** + * A set of metadata key-value pairs. Lists the metadata that the recovery point was created with. + */ + Metadata: Metadata; + /** + * The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. + */ + IamRoleArn: IAMRoleArn; + /** + * A customer chosen string that can be used to distinguish between calls to StartRestoreJob. Idempotency tokens time out after one hour. Therefore, if you call StartRestoreJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one restore job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple restores. + */ + IdempotencyToken?: string; + /** + * Starts a job to restore a recovery point for one of the following resources: EBS for Amazon Elastic Block Store SGW for AWS Storage Gateway RDS for Amazon Relational Database Service DDB for Amazon DynamoDB EFS for Amazon Elastic File System + */ + ResourceType?: ResourceType; + } + export interface StartRestoreJobOutput { + /** + * Uniquely identifies the job that restores a recovery point. + */ + RestoreJobId?: RestoreJobId; + } + export interface StopBackupJobInput { + /** + * Uniquely identifies a request to AWS Backup to back up a resource. + */ + BackupJobId: string; + } + export type StorageClass = "WARM"|"COLD"|"DELETED"|string; + export type TagKey = string; + export type TagKeyList = string[]; + export interface TagResourceInput { + /** + * An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource. + */ + ResourceArn: ARN; + /** + * Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. + */ + Tags: Tags; + } + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export interface UntagResourceInput { + /** + * An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource. + */ + ResourceArn: ARN; + /** + * A list of keys to identify which key-value tags to remove from a resource. + */ + TagKeyList: TagKeyList; + } + export interface UpdateBackupPlanInput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId: string; + /** + * Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules. + */ + BackupPlan: BackupPlanInput; + } + export interface UpdateBackupPlanOutput { + /** + * Uniquely identifies a backup plan. + */ + BackupPlanId?: string; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + */ + BackupPlanArn?: ARN; + /** + * The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreationDate?: timestamp; + /** + * Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited. + */ + VersionId?: string; + } + export interface UpdateRecoveryPointLifecycleInput { + /** + * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. + */ + BackupVaultName: BackupVaultName; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn: ARN; + /** + * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + Lifecycle?: Lifecycle; + } + export interface UpdateRecoveryPointLifecycleOutput { + /** + * An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + */ + BackupVaultArn?: ARN; + /** + * An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + */ + RecoveryPointArn?: ARN; + /** + * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. + */ + Lifecycle?: Lifecycle; + /** + * A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps. + */ + CalculatedLifecycle?: CalculatedLifecycle; + } + export type WindowMinutes = number; + export type long = number; + export type timestamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-11-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Backup client. + */ + export import Types = Backup; +} +export = Backup; diff --git a/node_modules/aws-sdk/clients/backup.js b/node_modules/aws-sdk/clients/backup.js new file mode 100644 index 0000000..9ddcf36 --- /dev/null +++ b/node_modules/aws-sdk/clients/backup.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['backup'] = {}; +AWS.Backup = Service.defineService('backup', ['2018-11-15']); +Object.defineProperty(apiLoader.services['backup'], '2018-11-15', { + get: function get() { + var model = require('../apis/backup-2018-11-15.min.json'); + model.paginators = require('../apis/backup-2018-11-15.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Backup; diff --git a/node_modules/aws-sdk/clients/batch.d.ts b/node_modules/aws-sdk/clients/batch.d.ts new file mode 100644 index 0000000..88ac642 --- /dev/null +++ b/node_modules/aws-sdk/clients/batch.d.ts @@ -0,0 +1,1326 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Batch extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Batch.Types.ClientConfiguration) + config: Config & Batch.Types.ClientConfiguration; + /** + * Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the TerminateJob operation. + */ + cancelJob(params: Batch.Types.CancelJobRequest, callback?: (err: AWSError, data: Batch.Types.CancelJobResponse) => void): Request; + /** + * Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the TerminateJob operation. + */ + cancelJob(callback?: (err: AWSError, data: Batch.Types.CancelJobResponse) => void): Request; + /** + * Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price. Multi-node parallel jobs are not supported on Spot Instances. In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon Elastic Container Service Developer Guide. AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the old compute environment from your job queue. Delete the old compute environment. + */ + createComputeEnvironment(params: Batch.Types.CreateComputeEnvironmentRequest, callback?: (err: AWSError, data: Batch.Types.CreateComputeEnvironmentResponse) => void): Request; + /** + * Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price. Multi-node parallel jobs are not supported on Spot Instances. In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon Elastic Container Service Developer Guide. AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the old compute environment from your job queue. Delete the old compute environment. + */ + createComputeEnvironment(callback?: (err: AWSError, data: Batch.Types.CreateComputeEnvironmentResponse) => void): Request; + /** + * Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments. You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment. + */ + createJobQueue(params: Batch.Types.CreateJobQueueRequest, callback?: (err: AWSError, data: Batch.Types.CreateJobQueueResponse) => void): Request; + /** + * Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments. You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment. + */ + createJobQueue(callback?: (err: AWSError, data: Batch.Types.CreateJobQueueResponse) => void): Request; + /** + * Deletes an AWS Batch compute environment. Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. + */ + deleteComputeEnvironment(params: Batch.Types.DeleteComputeEnvironmentRequest, callback?: (err: AWSError, data: Batch.Types.DeleteComputeEnvironmentResponse) => void): Request; + /** + * Deletes an AWS Batch compute environment. Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. + */ + deleteComputeEnvironment(callback?: (err: AWSError, data: Batch.Types.DeleteComputeEnvironmentResponse) => void): Request; + /** + * Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue. It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request. + */ + deleteJobQueue(params: Batch.Types.DeleteJobQueueRequest, callback?: (err: AWSError, data: Batch.Types.DeleteJobQueueResponse) => void): Request; + /** + * Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue. It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request. + */ + deleteJobQueue(callback?: (err: AWSError, data: Batch.Types.DeleteJobQueueResponse) => void): Request; + /** + * Deregisters an AWS Batch job definition. + */ + deregisterJobDefinition(params: Batch.Types.DeregisterJobDefinitionRequest, callback?: (err: AWSError, data: Batch.Types.DeregisterJobDefinitionResponse) => void): Request; + /** + * Deregisters an AWS Batch job definition. + */ + deregisterJobDefinition(callback?: (err: AWSError, data: Batch.Types.DeregisterJobDefinitionResponse) => void): Request; + /** + * Describes one or more of your compute environments. If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into. + */ + describeComputeEnvironments(params: Batch.Types.DescribeComputeEnvironmentsRequest, callback?: (err: AWSError, data: Batch.Types.DescribeComputeEnvironmentsResponse) => void): Request; + /** + * Describes one or more of your compute environments. If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into. + */ + describeComputeEnvironments(callback?: (err: AWSError, data: Batch.Types.DescribeComputeEnvironmentsResponse) => void): Request; + /** + * Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status. + */ + describeJobDefinitions(params: Batch.Types.DescribeJobDefinitionsRequest, callback?: (err: AWSError, data: Batch.Types.DescribeJobDefinitionsResponse) => void): Request; + /** + * Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status. + */ + describeJobDefinitions(callback?: (err: AWSError, data: Batch.Types.DescribeJobDefinitionsResponse) => void): Request; + /** + * Describes one or more of your job queues. + */ + describeJobQueues(params: Batch.Types.DescribeJobQueuesRequest, callback?: (err: AWSError, data: Batch.Types.DescribeJobQueuesResponse) => void): Request; + /** + * Describes one or more of your job queues. + */ + describeJobQueues(callback?: (err: AWSError, data: Batch.Types.DescribeJobQueuesResponse) => void): Request; + /** + * Describes a list of AWS Batch jobs. + */ + describeJobs(params: Batch.Types.DescribeJobsRequest, callback?: (err: AWSError, data: Batch.Types.DescribeJobsResponse) => void): Request; + /** + * Describes a list of AWS Batch jobs. + */ + describeJobs(callback?: (err: AWSError, data: Batch.Types.DescribeJobsResponse) => void): Request; + /** + * Returns a list of AWS Batch jobs. You must specify only one of the following: a job queue ID to return a list of jobs in that job queue a multi-node parallel job ID to return a list of that job's nodes an array job ID to return a list of that job's children You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned. + */ + listJobs(params: Batch.Types.ListJobsRequest, callback?: (err: AWSError, data: Batch.Types.ListJobsResponse) => void): Request; + /** + * Returns a list of AWS Batch jobs. You must specify only one of the following: a job queue ID to return a list of jobs in that job queue a multi-node parallel job ID to return a list of that job's nodes an array job ID to return a list of that job's children You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned. + */ + listJobs(callback?: (err: AWSError, data: Batch.Types.ListJobsResponse) => void): Request; + /** + * Registers an AWS Batch job definition. + */ + registerJobDefinition(params: Batch.Types.RegisterJobDefinitionRequest, callback?: (err: AWSError, data: Batch.Types.RegisterJobDefinitionResponse) => void): Request; + /** + * Registers an AWS Batch job definition. + */ + registerJobDefinition(callback?: (err: AWSError, data: Batch.Types.RegisterJobDefinitionResponse) => void): Request; + /** + * Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition. + */ + submitJob(params: Batch.Types.SubmitJobRequest, callback?: (err: AWSError, data: Batch.Types.SubmitJobResponse) => void): Request; + /** + * Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition. + */ + submitJob(callback?: (err: AWSError, data: Batch.Types.SubmitJobResponse) => void): Request; + /** + * Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled. + */ + terminateJob(params: Batch.Types.TerminateJobRequest, callback?: (err: AWSError, data: Batch.Types.TerminateJobResponse) => void): Request; + /** + * Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled. + */ + terminateJob(callback?: (err: AWSError, data: Batch.Types.TerminateJobResponse) => void): Request; + /** + * Updates an AWS Batch compute environment. + */ + updateComputeEnvironment(params: Batch.Types.UpdateComputeEnvironmentRequest, callback?: (err: AWSError, data: Batch.Types.UpdateComputeEnvironmentResponse) => void): Request; + /** + * Updates an AWS Batch compute environment. + */ + updateComputeEnvironment(callback?: (err: AWSError, data: Batch.Types.UpdateComputeEnvironmentResponse) => void): Request; + /** + * Updates a job queue. + */ + updateJobQueue(params: Batch.Types.UpdateJobQueueRequest, callback?: (err: AWSError, data: Batch.Types.UpdateJobQueueResponse) => void): Request; + /** + * Updates a job queue. + */ + updateJobQueue(callback?: (err: AWSError, data: Batch.Types.UpdateJobQueueResponse) => void): Request; +} +declare namespace Batch { + export type ArrayJobDependency = "N_TO_N"|"SEQUENTIAL"|string; + export type ArrayJobStatusSummary = {[key: string]: Integer}; + export interface ArrayProperties { + /** + * The size of the array job. + */ + size?: Integer; + } + export interface ArrayPropertiesDetail { + /** + * A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs. + */ + statusSummary?: ArrayJobStatusSummary; + /** + * The size of the array job. This parameter is returned for parent array jobs. + */ + size?: Integer; + /** + * The job index within the array that is associated with this job. This parameter is returned for array job children. + */ + index?: Integer; + } + export interface ArrayPropertiesSummary { + /** + * The size of the array job. This parameter is returned for parent array jobs. + */ + size?: Integer; + /** + * The job index within the array that is associated with this job. This parameter is returned for children of array jobs. + */ + index?: Integer; + } + export interface AttemptContainerDetail { + /** + * The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt. + */ + containerInstanceArn?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status. + */ + taskArn?: String; + /** + * The exit code for the job attempt. A non-zero exit code is considered a failure. + */ + exitCode?: Integer; + /** + * A short (255 max characters) human-readable string to provide additional details about a running or stopped container. + */ + reason?: String; + /** + * The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status. + */ + logStreamName?: String; + /** + * The network interfaces associated with the job attempt. + */ + networkInterfaces?: NetworkInterfaceList; + } + export interface AttemptDetail { + /** + * Details about the container in this job attempt. + */ + container?: AttemptContainerDetail; + /** + * The Unix timestamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state). + */ + startedAt?: Long; + /** + * The Unix timestamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED). + */ + stoppedAt?: Long; + /** + * A short, human-readable string to provide additional details about the current status of the job attempt. + */ + statusReason?: String; + } + export type AttemptDetails = AttemptDetail[]; + export type Boolean = boolean; + export type CEState = "ENABLED"|"DISABLED"|string; + export type CEStatus = "CREATING"|"UPDATING"|"DELETING"|"DELETED"|"VALID"|"INVALID"|string; + export type CEType = "MANAGED"|"UNMANAGED"|string; + export type CRType = "EC2"|"SPOT"|string; + export interface CancelJobRequest { + /** + * The AWS Batch job ID of the job to cancel. + */ + jobId: String; + /** + * A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs. + */ + reason: String; + } + export interface CancelJobResponse { + } + export interface ComputeEnvironmentDetail { + /** + * The name of the compute environment. + */ + computeEnvironmentName: String; + /** + * The Amazon Resource Name (ARN) of the compute environment. + */ + computeEnvironmentArn: String; + /** + * The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment. + */ + ecsClusterArn: String; + /** + * The type of the compute environment. + */ + type?: CEType; + /** + * The state of the compute environment. The valid values are ENABLED or DISABLED. If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand. If the state is DISABLED, then the AWS Batch scheduler does not attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state do not scale out. However, they scale in to minvCpus value after instances become idle. + */ + state?: CEState; + /** + * The current status of the compute environment (for example, CREATING or VALID). + */ + status?: CEStatus; + /** + * A short, human-readable string to provide additional details about the current status of the compute environment. + */ + statusReason?: String; + /** + * The compute resources defined for the compute environment. + */ + computeResources?: ComputeResource; + /** + * The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. + */ + serviceRole?: String; + } + export type ComputeEnvironmentDetailList = ComputeEnvironmentDetail[]; + export interface ComputeEnvironmentOrder { + /** + * The order of the compute environment. + */ + order: Integer; + /** + * The Amazon Resource Name (ARN) of the compute environment. + */ + computeEnvironment: String; + } + export type ComputeEnvironmentOrders = ComputeEnvironmentOrder[]; + export interface ComputeResource { + /** + * The type of compute environment: EC2 or SPOT. + */ + type: CRType; + /** + * The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED). + */ + minvCpus: Integer; + /** + * The maximum number of EC2 vCPUs that an environment can reach. + */ + maxvCpus: Integer; + /** + * The desired number of EC2 vCPUS in the compute environment. + */ + desiredvCpus?: Integer; + /** + * The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c4 or p3), or you can specify specific sizes within a family (such as c4.8xlarge). You can also choose optimal to pick instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues. + */ + instanceTypes: StringList; + /** + * The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. + */ + imageId?: String; + /** + * The VPC subnets into which the compute resources are launched. + */ + subnets: StringList; + /** + * The EC2 security group that is associated with instances launched in the compute environment. + */ + securityGroupIds?: StringList; + /** + * The EC2 key pair that is used for instances launched in the compute environment. + */ + ec2KeyPair?: String; + /** + * The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide. + */ + instanceRole: String; + /** + * Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }. + */ + tags?: TagsMap; + /** + * The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances. + */ + placementGroup?: String; + /** + * The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. + */ + bidPercentage?: Integer; + /** + * The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide. + */ + spotIamFleetRole?: String; + /** + * The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide. + */ + launchTemplate?: LaunchTemplateSpecification; + } + export interface ComputeResourceUpdate { + /** + * The minimum number of EC2 vCPUs that an environment should maintain. + */ + minvCpus?: Integer; + /** + * The maximum number of EC2 vCPUs that an environment can reach. + */ + maxvCpus?: Integer; + /** + * The desired number of EC2 vCPUS in the compute environment. + */ + desiredvCpus?: Integer; + } + export interface ContainerDetail { + /** + * The image used to start the container. + */ + image?: String; + /** + * The number of VCPUs allocated for the job. + */ + vcpus?: Integer; + /** + * The number of MiB of memory reserved for the job. + */ + memory?: Integer; + /** + * The command that is passed to the container. + */ + command?: StringList; + /** + * The Amazon Resource Name (ARN) associated with the job upon execution. + */ + jobRoleArn?: String; + /** + * A list of volumes associated with the job. + */ + volumes?: Volumes; + /** + * The environment variables to pass to a container. Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service. + */ + environment?: EnvironmentVariables; + /** + * The mount points for data volumes in your container. + */ + mountPoints?: MountPoints; + /** + * When this parameter is true, the container is given read-only access to its root file system. + */ + readonlyRootFilesystem?: Boolean; + /** + * A list of ulimit values to set in the container. + */ + ulimits?: Ulimits; + /** + * When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). + */ + privileged?: Boolean; + /** + * The user name to use inside the container. + */ + user?: String; + /** + * The exit code to return upon completion. + */ + exitCode?: Integer; + /** + * A short (255 max characters) human-readable string to provide additional details about a running or stopped container. + */ + reason?: String; + /** + * The Amazon Resource Name (ARN) of the container instance on which the container is running. + */ + containerInstanceArn?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status. + */ + taskArn?: String; + /** + * The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status. + */ + logStreamName?: String; + /** + * The instance type of the underlying host infrastructure of a multi-node parallel job. + */ + instanceType?: String; + /** + * The network interfaces associated with the job. + */ + networkInterfaces?: NetworkInterfaceList; + /** + * The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU. + */ + resourceRequirements?: ResourceRequirements; + } + export interface ContainerOverrides { + /** + * The number of vCPUs to reserve for the container. This value overrides the value set in the job definition. + */ + vcpus?: Integer; + /** + * The number of MiB of memory reserved for the job. This value overrides the value set in the job definition. + */ + memory?: Integer; + /** + * The command to send to the container that overrides the default command from the Docker image or the job definition. + */ + command?: StringList; + /** + * The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs. + */ + instanceType?: String; + /** + * The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition. Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service. + */ + environment?: EnvironmentVariables; + /** + * The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU. + */ + resourceRequirements?: ResourceRequirements; + } + export interface ContainerProperties { + /** + * The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>). Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo). Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent). Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu). + */ + image?: String; + /** + * The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. + */ + vcpus?: Integer; + /** + * 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 Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide. + */ + memory?: Integer; + /** + * The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. + */ + command?: StringList; + /** + * The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. + */ + jobRoleArn?: String; + /** + * A list of data volumes used in a job. + */ + volumes?: Volumes; + /** + * The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. We do not recommend using plaintext environment variables for sensitive information, such as credential data. Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service. + */ + environment?: EnvironmentVariables; + /** + * The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run. + */ + mountPoints?: MountPoints; + /** + * When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run. + */ + readonlyRootFilesystem?: Boolean; + /** + * When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. + */ + privileged?: Boolean; + /** + * A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. + */ + ulimits?: Ulimits; + /** + * The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run. + */ + user?: String; + /** + * The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs. + */ + instanceType?: String; + /** + * The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU. + */ + resourceRequirements?: ResourceRequirements; + } + export interface ContainerSummary { + /** + * The exit code to return upon completion. + */ + exitCode?: Integer; + /** + * A short (255 max characters) human-readable string to provide additional details about a running or stopped container. + */ + reason?: String; + } + export interface CreateComputeEnvironmentRequest { + /** + * The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + */ + computeEnvironmentName: String; + /** + * The type of the compute environment. For more information, see Compute Environments in the AWS Batch User Guide. + */ + type: CEType; + /** + * The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues. + */ + state?: CEState; + /** + * Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide. + */ + computeResources?: ComputeResource; + /** + * The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments. + */ + serviceRole: String; + } + export interface CreateComputeEnvironmentResponse { + /** + * The name of the compute environment. + */ + computeEnvironmentName?: String; + /** + * The Amazon Resource Name (ARN) of the compute environment. + */ + computeEnvironmentArn?: String; + } + export interface CreateJobQueueRequest { + /** + * The name of the job queue. + */ + jobQueueName: String; + /** + * The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. + */ + state?: JQState; + /** + * The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. + */ + priority: Integer; + /** + * The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. + */ + computeEnvironmentOrder: ComputeEnvironmentOrders; + } + export interface CreateJobQueueResponse { + /** + * The name of the job queue. + */ + jobQueueName: String; + /** + * The Amazon Resource Name (ARN) of the job queue. + */ + jobQueueArn: String; + } + export interface DeleteComputeEnvironmentRequest { + /** + * The name or Amazon Resource Name (ARN) of the compute environment to delete. + */ + computeEnvironment: String; + } + export interface DeleteComputeEnvironmentResponse { + } + export interface DeleteJobQueueRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the queue to delete. + */ + jobQueue: String; + } + export interface DeleteJobQueueResponse { + } + export interface DeregisterJobDefinitionRequest { + /** + * The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister. + */ + jobDefinition: String; + } + export interface DeregisterJobDefinitionResponse { + } + export interface DescribeComputeEnvironmentsRequest { + /** + * A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries. + */ + computeEnvironments?: StringList; + /** + * The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: Integer; + /** + * The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + } + export interface DescribeComputeEnvironmentsResponse { + /** + * The list of compute environments. + */ + computeEnvironments?: ComputeEnvironmentDetailList; + /** + * The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface DescribeJobDefinitionsRequest { + /** + * A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries. + */ + jobDefinitions?: StringList; + /** + * The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: Integer; + /** + * The name of the job definition to describe. + */ + jobDefinitionName?: String; + /** + * The status with which to filter job definitions. + */ + status?: String; + /** + * The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + } + export interface DescribeJobDefinitionsResponse { + /** + * The list of job definitions. + */ + jobDefinitions?: JobDefinitionList; + /** + * The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface DescribeJobQueuesRequest { + /** + * A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries. + */ + jobQueues?: StringList; + /** + * The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: Integer; + /** + * The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + } + export interface DescribeJobQueuesResponse { + /** + * The list of job queues. + */ + jobQueues?: JobQueueDetailList; + /** + * The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface DescribeJobsRequest { + /** + * A list of up to 100 job IDs. + */ + jobs: StringList; + } + export interface DescribeJobsResponse { + /** + * The list of jobs. + */ + jobs?: JobDetailList; + } + export type EnvironmentVariables = KeyValuePair[]; + export interface Host { + /** + * The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. + */ + sourcePath?: String; + } + export type Integer = number; + export type JQState = "ENABLED"|"DISABLED"|string; + export type JQStatus = "CREATING"|"UPDATING"|"DELETING"|"DELETED"|"VALID"|"INVALID"|string; + export interface JobDefinition { + /** + * The name of the job definition. + */ + jobDefinitionName: String; + /** + * The Amazon Resource Name (ARN) for the job definition. + */ + jobDefinitionArn: String; + /** + * The revision of the job definition. + */ + revision: Integer; + /** + * The status of the job definition. + */ + status?: String; + /** + * The type of job definition. + */ + type: String; + /** + * Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide. + */ + parameters?: ParametersMap; + /** + * The retry strategy to use for failed jobs that are submitted with this job definition. + */ + retryStrategy?: RetryStrategy; + /** + * An object with various properties specific to container-based jobs. + */ + containerProperties?: ContainerProperties; + /** + * 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. + */ + timeout?: JobTimeout; + /** + * An object with various properties specific to multi-node parallel jobs. + */ + nodeProperties?: NodeProperties; + } + export type JobDefinitionList = JobDefinition[]; + export type JobDefinitionType = "container"|"multinode"|string; + export interface JobDependency { + /** + * The job ID of the AWS Batch job associated with this dependency. + */ + jobId?: String; + /** + * The type of the job dependency. + */ + type?: ArrayJobDependency; + } + export type JobDependencyList = JobDependency[]; + export interface JobDetail { + /** + * The name of the job. + */ + jobName: String; + /** + * The ID for the job. + */ + jobId: String; + /** + * The Amazon Resource Name (ARN) of the job queue with which the job is associated. + */ + jobQueue: String; + /** + * The current status for the job. If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide. + */ + status: JobStatus; + /** + * A list of job attempts associated with this job. + */ + attempts?: AttemptDetails; + /** + * A short, human-readable string to provide additional details about the current status of the job. + */ + statusReason?: String; + /** + * The Unix timestamp (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 SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state. + */ + createdAt?: Long; + /** + * The retry strategy to use for this job if an attempt fails. + */ + retryStrategy?: RetryStrategy; + /** + * The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). + */ + startedAt: Long; + /** + * The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED). + */ + stoppedAt?: Long; + /** + * A list of job names or IDs on which this job depends. + */ + dependsOn?: JobDependencyList; + /** + * The job definition that is used by this job. + */ + jobDefinition: String; + /** + * Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition. + */ + parameters?: ParametersMap; + /** + * An object representing the details of the container that is associated with the job. + */ + container?: ContainerDetail; + /** + * An object representing the details of a node that is associated with a multi-node parallel job. + */ + nodeDetails?: NodeDetails; + /** + * An object representing the node properties of a multi-node parallel job. + */ + nodeProperties?: NodeProperties; + /** + * The array properties of the job, if it is an array job. + */ + arrayProperties?: ArrayPropertiesDetail; + /** + * The timeout configuration for the job. + */ + timeout?: JobTimeout; + } + export type JobDetailList = JobDetail[]; + export interface JobQueueDetail { + /** + * The name of the job queue. + */ + jobQueueName: String; + /** + * The Amazon Resource Name (ARN) of the job queue. + */ + jobQueueArn: String; + /** + * Describes the ability of the queue to accept new jobs. + */ + state: JQState; + /** + * The status of the job queue (for example, CREATING or VALID). + */ + status?: JQStatus; + /** + * A short, human-readable string to provide additional details about the current status of the job queue. + */ + statusReason?: String; + /** + * The priority of the job queue. + */ + priority: Integer; + /** + * The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order. + */ + computeEnvironmentOrder: ComputeEnvironmentOrders; + } + export type JobQueueDetailList = JobQueueDetail[]; + export type JobStatus = "SUBMITTED"|"PENDING"|"RUNNABLE"|"STARTING"|"RUNNING"|"SUCCEEDED"|"FAILED"|string; + export interface JobSummary { + /** + * The ID of the job. + */ + jobId: String; + /** + * The name of the job. + */ + jobName: String; + /** + * The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state. + */ + createdAt?: Long; + /** + * The current status for the job. + */ + status?: JobStatus; + /** + * A short, human-readable string to provide additional details about the current status of the job. + */ + statusReason?: String; + /** + * The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). + */ + startedAt?: Long; + /** + * The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED). + */ + stoppedAt?: Long; + /** + * An object representing the details of the container that is associated with the job. + */ + container?: ContainerSummary; + /** + * The array properties of the job, if it is an array job. + */ + arrayProperties?: ArrayPropertiesSummary; + /** + * The node properties for a single node in a job summary list. + */ + nodeProperties?: NodePropertiesSummary; + } + export type JobSummaryList = JobSummary[]; + export interface JobTimeout { + /** + * The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished. + */ + attemptDurationSeconds?: Integer; + } + export interface KeyValuePair { + /** + * The name of the key-value pair. For environment variables, this is the name of the environment variable. + */ + name?: String; + /** + * The value of the key-value pair. For environment variables, this is the value of the environment variable. + */ + value?: String; + } + export interface LaunchTemplateSpecification { + /** + * The ID of the launch template. + */ + launchTemplateId?: String; + /** + * The name of the launch template. + */ + launchTemplateName?: String; + /** + * The version number of the launch template. Default: The default version of the launch template. + */ + version?: String; + } + export interface ListJobsRequest { + /** + * The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs. + */ + jobQueue?: String; + /** + * The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array. + */ + arrayJobId?: String; + /** + * The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job. + */ + multiNodeJobId?: String; + /** + * The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned. + */ + jobStatus?: JobStatus; + /** + * The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: Integer; + /** + * The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + } + export interface ListJobsResponse { + /** + * A list of job summaries that match the request. + */ + jobSummaryList: JobSummaryList; + /** + * The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export type Long = number; + export interface MountPoint { + /** + * The path on the container at which to mount the host volume. + */ + containerPath?: String; + /** + * If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false. + */ + readOnly?: Boolean; + /** + * The name of the volume to mount. + */ + sourceVolume?: String; + } + export type MountPoints = MountPoint[]; + export interface NetworkInterface { + /** + * The attachment ID for the network interface. + */ + attachmentId?: String; + /** + * The private IPv6 address for the network interface. + */ + ipv6Address?: String; + /** + * The private IPv4 address for the network interface. + */ + privateIpv4Address?: String; + } + export type NetworkInterfaceList = NetworkInterface[]; + export interface NodeDetails { + /** + * The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable. + */ + nodeIndex?: Integer; + /** + * Specifies whether the current node is the main node for a multi-node parallel job. + */ + isMainNode?: Boolean; + } + export interface NodeOverrides { + /** + * The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override: There must be at least one node range in your job definition that has an open upper boundary (such as : or n:). The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override. The main node index specified in the job definition must be fewer than the number of nodes specified in the override. + */ + numNodes?: Integer; + /** + * The node property overrides for the job. + */ + nodePropertyOverrides?: NodePropertyOverrides; + } + export interface NodeProperties { + /** + * The number of nodes associated with a multi-node parallel job. + */ + numNodes: Integer; + /** + * Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes. + */ + mainNode: Integer; + /** + * A list of node ranges and their properties associated with a multi-node parallel job. + */ + nodeRangeProperties: NodeRangeProperties; + } + export interface NodePropertiesSummary { + /** + * Specifies whether the current node is the main node for a multi-node parallel job. + */ + isMainNode?: Boolean; + /** + * The number of nodes associated with a multi-node parallel job. + */ + numNodes?: Integer; + /** + * The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable. + */ + nodeIndex?: Integer; + } + export interface NodePropertyOverride { + /** + * The range of nodes, using node index values, with which to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. + */ + targetNodes: String; + /** + * The overrides that should be sent to a node range. + */ + containerOverrides?: ContainerOverrides; + } + export type NodePropertyOverrides = NodePropertyOverride[]; + export type NodeRangeProperties = NodeRangeProperty[]; + export interface NodeRangeProperty { + /** + * The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties. + */ + targetNodes: String; + /** + * The container details for the node range. + */ + container?: ContainerProperties; + } + export type ParametersMap = {[key: string]: String}; + export interface RegisterJobDefinitionRequest { + /** + * The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + */ + jobDefinitionName: String; + /** + * The type of job definition. + */ + type: JobDefinitionType; + /** + * Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. + */ + parameters?: ParametersMap; + /** + * An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. + */ + containerProperties?: ContainerProperties; + /** + * An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. + */ + nodeProperties?: NodeProperties; + /** + * The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried. + */ + retryStrategy?: RetryStrategy; + /** + * 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 SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide. + */ + timeout?: JobTimeout; + } + export interface RegisterJobDefinitionResponse { + /** + * The name of the job definition. + */ + jobDefinitionName: String; + /** + * The Amazon Resource Name (ARN) of the job definition. + */ + jobDefinitionArn: String; + /** + * The revision of the job definition. + */ + revision: Integer; + } + export interface ResourceRequirement { + /** + * The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on. + */ + value: String; + /** + * The type of resource to assign to a container. Currently, the only supported resource type is GPU. + */ + type: ResourceType; + } + export type ResourceRequirements = ResourceRequirement[]; + export type ResourceType = "GPU"|string; + export interface RetryStrategy { + /** + * The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value. + */ + attempts?: Integer; + } + export type String = string; + export type StringList = String[]; + export interface SubmitJobRequest { + /** + * The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + */ + jobName: String; + /** + * The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue. + */ + jobQueue: String; + /** + * The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide. + */ + arrayProperties?: ArrayProperties; + /** + * A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin. + */ + dependsOn?: JobDependencyList; + /** + * The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition. + */ + jobDefinition: String; + /** + * Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. + */ + parameters?: ParametersMap; + /** + * A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override. + */ + containerOverrides?: ContainerOverrides; + /** + * A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range. + */ + nodeOverrides?: NodeOverrides; + /** + * The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition. + */ + retryStrategy?: RetryStrategy; + /** + * The timeout configuration for this SubmitJob 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 Job Timeouts in the Amazon Elastic Container Service Developer Guide. + */ + timeout?: JobTimeout; + } + export interface SubmitJobResponse { + /** + * The name of the job. + */ + jobName: String; + /** + * The unique identifier for the job. + */ + jobId: String; + } + export type TagsMap = {[key: string]: String}; + export interface TerminateJobRequest { + /** + * The AWS Batch job ID of the job to terminate. + */ + jobId: String; + /** + * A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs. + */ + reason: String; + } + export interface TerminateJobResponse { + } + export interface Ulimit { + /** + * The hard limit for the ulimit type. + */ + hardLimit: Integer; + /** + * The type of the ulimit. + */ + name: String; + /** + * The soft limit for the ulimit type. + */ + softLimit: Integer; + } + export type Ulimits = Ulimit[]; + export interface UpdateComputeEnvironmentRequest { + /** + * The name or full Amazon Resource Name (ARN) of the compute environment to update. + */ + computeEnvironment: String; + /** + * The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues. + */ + state?: CEState; + /** + * Details of the compute resources managed by the compute environment. Required for a managed compute environment. + */ + computeResources?: ComputeResourceUpdate; + /** + * The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments. + */ + serviceRole?: String; + } + export interface UpdateComputeEnvironmentResponse { + /** + * The name of the compute environment. + */ + computeEnvironmentName?: String; + /** + * The Amazon Resource Name (ARN) of the compute environment. + */ + computeEnvironmentArn?: String; + } + export interface UpdateJobQueueRequest { + /** + * The name or the Amazon Resource Name (ARN) of the job queue. + */ + jobQueue: String; + /** + * Describes the queue's ability to accept new jobs. + */ + state?: JQState; + /** + * The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. + */ + priority?: Integer; + /** + * Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job. + */ + computeEnvironmentOrder?: ComputeEnvironmentOrders; + } + export interface UpdateJobQueueResponse { + /** + * The name of the job queue. + */ + jobQueueName?: String; + /** + * The Amazon Resource Name (ARN) of the job queue. + */ + jobQueueArn?: String; + } + export interface Volume { + /** + * The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running. + */ + host?: Host; + /** + * The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints. + */ + name?: String; + } + export type Volumes = Volume[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-08-10"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Batch client. + */ + export import Types = Batch; +} +export = Batch; diff --git a/node_modules/aws-sdk/clients/batch.js b/node_modules/aws-sdk/clients/batch.js new file mode 100644 index 0000000..76dda26 --- /dev/null +++ b/node_modules/aws-sdk/clients/batch.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['batch'] = {}; +AWS.Batch = Service.defineService('batch', ['2016-08-10']); +Object.defineProperty(apiLoader.services['batch'], '2016-08-10', { + get: function get() { + var model = require('../apis/batch-2016-08-10.min.json'); + model.paginators = require('../apis/batch-2016-08-10.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Batch; diff --git a/node_modules/aws-sdk/clients/browser_default.d.ts b/node_modules/aws-sdk/clients/browser_default.d.ts new file mode 100644 index 0000000..9a0b285 --- /dev/null +++ b/node_modules/aws-sdk/clients/browser_default.d.ts @@ -0,0 +1,77 @@ +export import ACM = require('./acm'); +export import APIGateway = require('./apigateway'); +export import ApplicationAutoScaling = require('./applicationautoscaling'); +export import AutoScaling = require('./autoscaling'); +export import CloudFormation = require('./cloudformation'); +export import CloudFront = require('./cloudfront'); +export import CloudHSM = require('./cloudhsm'); +export import CloudTrail = require('./cloudtrail'); +export import CloudWatch = require('./cloudwatch'); +export import CloudWatchEvents = require('./cloudwatchevents'); +export import CloudWatchLogs = require('./cloudwatchlogs'); +export import CodeBuild = require('./codebuild'); +export import CodeCommit = require('./codecommit'); +export import CodeDeploy = require('./codedeploy'); +export import CodePipeline = require('./codepipeline'); +export import CognitoIdentity = require('./cognitoidentity'); +export import CognitoIdentityServiceProvider = require('./cognitoidentityserviceprovider'); +export import CognitoSync = require('./cognitosync'); +export import ConfigService = require('./configservice'); +export import CUR = require('./cur'); +export import DeviceFarm = require('./devicefarm'); +export import DirectConnect = require('./directconnect'); +export import DynamoDB = require('./dynamodb'); +export import DynamoDBStreams = require('./dynamodbstreams'); +export import EC2 = require('./ec2'); +export import ECR = require('./ecr'); +export import ECS = require('./ecs'); +export import EFS = require('./efs'); +export import ElastiCache = require('./elasticache'); +export import ElasticBeanstalk = require('./elasticbeanstalk'); +export import ELB = require('./elb'); +export import ELBv2 = require('./elbv2'); +export import EMR = require('./emr'); +export import ElasticTranscoder = require('./elastictranscoder'); +export import Firehose = require('./firehose'); +export import GameLift = require('./gamelift'); +export import IAM = require('./iam'); +export import Inspector = require('./inspector'); +export import Iot = require('./iot'); +export import IotData = require('./iotdata'); +export import Kinesis = require('./kinesis'); +export import KMS = require('./kms'); +export import Lambda = require('./lambda'); +export import LexRuntime = require('./lexruntime'); +export import MachineLearning = require('./machinelearning'); +export import MarketplaceCommerceAnalytics = require('./marketplacecommerceanalytics'); +export import MTurk = require('./mturk'); +export import MobileAnalytics = require('./mobileanalytics'); +export import OpsWorks = require('./opsworks'); +export import Polly = require('./polly'); +export import RDS = require('./rds'); +export import Redshift = require('./redshift'); +export import Rekognition = require('./rekognition'); +export import Route53 = require('./route53'); +export import Route53Domains = require('./route53domains'); +export import S3 = require('./s3'); +export import ServiceCatalog = require('./servicecatalog'); +export import SES = require('./ses'); +export import SNS = require('./sns'); +export import SQS = require('./sqs'); +export import SSM = require('./ssm'); +export import StorageGateway = require('./storagegateway'); +export import STS = require('./sts'); +export import WAF = require('./waf'); +export import WorkDocs = require('./workdocs'); +export import LexModelBuildingService = require('./lexmodelbuildingservice'); +export import Pricing = require('./pricing'); +export import CostExplorer = require('./costexplorer'); +export import MediaStoreData = require('./mediastoredata'); +export import Comprehend = require('./comprehend'); +export import KinesisVideoArchivedMedia = require('./kinesisvideoarchivedmedia'); +export import KinesisVideoMedia = require('./kinesisvideomedia'); +export import KinesisVideo = require('./kinesisvideo'); +export import Translate = require('./translate'); +export import ResourceGroups = require('./resourcegroups'); +export import SecretsManager = require('./secretsmanager'); +export import ComprehendMedical = require('./comprehendmedical'); diff --git a/node_modules/aws-sdk/clients/browser_default.js b/node_modules/aws-sdk/clients/browser_default.js new file mode 100644 index 0000000..e1f52bc --- /dev/null +++ b/node_modules/aws-sdk/clients/browser_default.js @@ -0,0 +1,80 @@ +require('../lib/node_loader'); +module.exports = { + ACM: require('./acm'), + APIGateway: require('./apigateway'), + ApplicationAutoScaling: require('./applicationautoscaling'), + AutoScaling: require('./autoscaling'), + CloudFormation: require('./cloudformation'), + CloudFront: require('./cloudfront'), + CloudHSM: require('./cloudhsm'), + CloudTrail: require('./cloudtrail'), + CloudWatch: require('./cloudwatch'), + CloudWatchEvents: require('./cloudwatchevents'), + CloudWatchLogs: require('./cloudwatchlogs'), + CodeBuild: require('./codebuild'), + CodeCommit: require('./codecommit'), + CodeDeploy: require('./codedeploy'), + CodePipeline: require('./codepipeline'), + CognitoIdentity: require('./cognitoidentity'), + CognitoIdentityServiceProvider: require('./cognitoidentityserviceprovider'), + CognitoSync: require('./cognitosync'), + ConfigService: require('./configservice'), + CUR: require('./cur'), + DeviceFarm: require('./devicefarm'), + DirectConnect: require('./directconnect'), + DynamoDB: require('./dynamodb'), + DynamoDBStreams: require('./dynamodbstreams'), + EC2: require('./ec2'), + ECR: require('./ecr'), + ECS: require('./ecs'), + EFS: require('./efs'), + ElastiCache: require('./elasticache'), + ElasticBeanstalk: require('./elasticbeanstalk'), + ELB: require('./elb'), + ELBv2: require('./elbv2'), + EMR: require('./emr'), + ElasticTranscoder: require('./elastictranscoder'), + Firehose: require('./firehose'), + GameLift: require('./gamelift'), + IAM: require('./iam'), + Inspector: require('./inspector'), + Iot: require('./iot'), + IotData: require('./iotdata'), + Kinesis: require('./kinesis'), + KMS: require('./kms'), + Lambda: require('./lambda'), + LexRuntime: require('./lexruntime'), + MachineLearning: require('./machinelearning'), + MarketplaceCommerceAnalytics: require('./marketplacecommerceanalytics'), + MTurk: require('./mturk'), + MobileAnalytics: require('./mobileanalytics'), + OpsWorks: require('./opsworks'), + Polly: require('./polly'), + RDS: require('./rds'), + Redshift: require('./redshift'), + Rekognition: require('./rekognition'), + Route53: require('./route53'), + Route53Domains: require('./route53domains'), + S3: require('./s3'), + ServiceCatalog: require('./servicecatalog'), + SES: require('./ses'), + SNS: require('./sns'), + SQS: require('./sqs'), + SSM: require('./ssm'), + StorageGateway: require('./storagegateway'), + STS: require('./sts'), + WAF: require('./waf'), + WorkDocs: require('./workdocs'), + LexModelBuildingService: require('./lexmodelbuildingservice'), + Pricing: require('./pricing'), + CostExplorer: require('./costexplorer'), + MediaStoreData: require('./mediastoredata'), + Comprehend: require('./comprehend'), + KinesisVideoArchivedMedia: require('./kinesisvideoarchivedmedia'), + KinesisVideoMedia: require('./kinesisvideomedia'), + KinesisVideo: require('./kinesisvideo'), + Translate: require('./translate'), + ResourceGroups: require('./resourcegroups'), + SecretsManager: require('./secretsmanager'), + ComprehendMedical: require('./comprehendmedical') +}; \ No newline at end of file diff --git a/node_modules/aws-sdk/clients/budgets.d.ts b/node_modules/aws-sdk/clients/budgets.d.ts new file mode 100644 index 0000000..8081721 --- /dev/null +++ b/node_modules/aws-sdk/clients/budgets.d.ts @@ -0,0 +1,632 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Budgets extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Budgets.Types.ClientConfiguration) + config: Config & Budgets.Types.ClientConfiguration; + /** + * Creates a budget and, if included, notifications and subscribers. + */ + createBudget(params: Budgets.Types.CreateBudgetRequest, callback?: (err: AWSError, data: Budgets.Types.CreateBudgetResponse) => void): Request; + /** + * Creates a budget and, if included, notifications and subscribers. + */ + createBudget(callback?: (err: AWSError, data: Budgets.Types.CreateBudgetResponse) => void): Request; + /** + * Creates a notification. You must create the budget before you create the associated notification. + */ + createNotification(params: Budgets.Types.CreateNotificationRequest, callback?: (err: AWSError, data: Budgets.Types.CreateNotificationResponse) => void): Request; + /** + * Creates a notification. You must create the budget before you create the associated notification. + */ + createNotification(callback?: (err: AWSError, data: Budgets.Types.CreateNotificationResponse) => void): Request; + /** + * Creates a subscriber. You must create the associated budget and notification before you create the subscriber. + */ + createSubscriber(params: Budgets.Types.CreateSubscriberRequest, callback?: (err: AWSError, data: Budgets.Types.CreateSubscriberResponse) => void): Request; + /** + * Creates a subscriber. You must create the associated budget and notification before you create the subscriber. + */ + createSubscriber(callback?: (err: AWSError, data: Budgets.Types.CreateSubscriberResponse) => void): Request; + /** + * Deletes a budget. You can delete your budget at any time. Deleting a budget also deletes the notifications and subscribers that are associated with that budget. + */ + deleteBudget(params: Budgets.Types.DeleteBudgetRequest, callback?: (err: AWSError, data: Budgets.Types.DeleteBudgetResponse) => void): Request; + /** + * Deletes a budget. You can delete your budget at any time. Deleting a budget also deletes the notifications and subscribers that are associated with that budget. + */ + deleteBudget(callback?: (err: AWSError, data: Budgets.Types.DeleteBudgetResponse) => void): Request; + /** + * Deletes a notification. Deleting a notification also deletes the subscribers that are associated with the notification. + */ + deleteNotification(params: Budgets.Types.DeleteNotificationRequest, callback?: (err: AWSError, data: Budgets.Types.DeleteNotificationResponse) => void): Request; + /** + * Deletes a notification. Deleting a notification also deletes the subscribers that are associated with the notification. + */ + deleteNotification(callback?: (err: AWSError, data: Budgets.Types.DeleteNotificationResponse) => void): Request; + /** + * Deletes a subscriber. Deleting the last subscriber to a notification also deletes the notification. + */ + deleteSubscriber(params: Budgets.Types.DeleteSubscriberRequest, callback?: (err: AWSError, data: Budgets.Types.DeleteSubscriberResponse) => void): Request; + /** + * Deletes a subscriber. Deleting the last subscriber to a notification also deletes the notification. + */ + deleteSubscriber(callback?: (err: AWSError, data: Budgets.Types.DeleteSubscriberResponse) => void): Request; + /** + * Describes a budget. + */ + describeBudget(params: Budgets.Types.DescribeBudgetRequest, callback?: (err: AWSError, data: Budgets.Types.DescribeBudgetResponse) => void): Request; + /** + * Describes a budget. + */ + describeBudget(callback?: (err: AWSError, data: Budgets.Types.DescribeBudgetResponse) => void): Request; + /** + * Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets. + */ + describeBudgetPerformanceHistory(params: Budgets.Types.DescribeBudgetPerformanceHistoryRequest, callback?: (err: AWSError, data: Budgets.Types.DescribeBudgetPerformanceHistoryResponse) => void): Request; + /** + * Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets. + */ + describeBudgetPerformanceHistory(callback?: (err: AWSError, data: Budgets.Types.DescribeBudgetPerformanceHistoryResponse) => void): Request; + /** + * Lists the budgets that are associated with an account. + */ + describeBudgets(params: Budgets.Types.DescribeBudgetsRequest, callback?: (err: AWSError, data: Budgets.Types.DescribeBudgetsResponse) => void): Request; + /** + * Lists the budgets that are associated with an account. + */ + describeBudgets(callback?: (err: AWSError, data: Budgets.Types.DescribeBudgetsResponse) => void): Request; + /** + * Lists the notifications that are associated with a budget. + */ + describeNotificationsForBudget(params: Budgets.Types.DescribeNotificationsForBudgetRequest, callback?: (err: AWSError, data: Budgets.Types.DescribeNotificationsForBudgetResponse) => void): Request; + /** + * Lists the notifications that are associated with a budget. + */ + describeNotificationsForBudget(callback?: (err: AWSError, data: Budgets.Types.DescribeNotificationsForBudgetResponse) => void): Request; + /** + * Lists the subscribers that are associated with a notification. + */ + describeSubscribersForNotification(params: Budgets.Types.DescribeSubscribersForNotificationRequest, callback?: (err: AWSError, data: Budgets.Types.DescribeSubscribersForNotificationResponse) => void): Request; + /** + * Lists the subscribers that are associated with a notification. + */ + describeSubscribersForNotification(callback?: (err: AWSError, data: Budgets.Types.DescribeSubscribersForNotificationResponse) => void): Request; + /** + * Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting. + */ + updateBudget(params: Budgets.Types.UpdateBudgetRequest, callback?: (err: AWSError, data: Budgets.Types.UpdateBudgetResponse) => void): Request; + /** + * Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting. + */ + updateBudget(callback?: (err: AWSError, data: Budgets.Types.UpdateBudgetResponse) => void): Request; + /** + * Updates a notification. + */ + updateNotification(params: Budgets.Types.UpdateNotificationRequest, callback?: (err: AWSError, data: Budgets.Types.UpdateNotificationResponse) => void): Request; + /** + * Updates a notification. + */ + updateNotification(callback?: (err: AWSError, data: Budgets.Types.UpdateNotificationResponse) => void): Request; + /** + * Updates a subscriber. + */ + updateSubscriber(params: Budgets.Types.UpdateSubscriberRequest, callback?: (err: AWSError, data: Budgets.Types.UpdateSubscriberResponse) => void): Request; + /** + * Updates a subscriber. + */ + updateSubscriber(callback?: (err: AWSError, data: Budgets.Types.UpdateSubscriberResponse) => void): Request; +} +declare namespace Budgets { + export type AccountId = string; + export interface Budget { + /** + * The name of a budget. The name must be unique within accounts. The : and \ characters aren't allowed in BudgetName. + */ + BudgetName: BudgetName; + /** + * The total amount of cost, usage, RI utilization, or RI coverage that you want to track with your budget. BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets. + */ + BudgetLimit?: Spend; + /** + * The cost filters, such as service or region, that are applied to a budget. AWS Budgets supports the following services as a filter for RI budgets: Amazon Elastic Compute Cloud - Compute Amazon Redshift Amazon Relational Database Service Amazon ElastiCache Amazon Elasticsearch Service + */ + CostFilters?: CostFilters; + /** + * The types of costs that are included in this COST budget. USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes. + */ + CostTypes?: CostTypes; + /** + * The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets. + */ + TimeUnit: TimeUnit; + /** + * The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC. If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API. You can change either date with the UpdateBudget operation. After the end date, AWS deletes the budget and all associated notifications and subscribers. + */ + TimePeriod?: TimePeriod; + /** + * The actual and forecasted cost or usage that the budget tracks. + */ + CalculatedSpend?: CalculatedSpend; + /** + * Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage. + */ + BudgetType: BudgetType; + /** + * The last time that you updated this budget. + */ + LastUpdatedTime?: GenericTimestamp; + } + export type BudgetName = string; + export interface BudgetPerformanceHistory { + BudgetName?: BudgetName; + BudgetType?: BudgetType; + /** + * The history of the cost filters for a budget during the specified time period. + */ + CostFilters?: CostFilters; + /** + * The history of the cost types for a budget during the specified time period. + */ + CostTypes?: CostTypes; + TimeUnit?: TimeUnit; + /** + * A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage. + */ + BudgetedAndActualAmountsList?: BudgetedAndActualAmountsList; + } + export type BudgetType = "USAGE"|"COST"|"RI_UTILIZATION"|"RI_COVERAGE"|string; + export interface BudgetedAndActualAmounts { + /** + * The amount of cost or usage that you created the budget for. + */ + BudgetedAmount?: Spend; + /** + * Your actual costs or usage for a budget period. + */ + ActualAmount?: Spend; + /** + * The time period covered by this budget comparison. + */ + TimePeriod?: TimePeriod; + } + export type BudgetedAndActualAmountsList = BudgetedAndActualAmounts[]; + export type Budgets = Budget[]; + export interface CalculatedSpend { + /** + * The amount of cost, usage, or RI units that you have used. + */ + ActualSpend: Spend; + /** + * The amount of cost, usage, or RI units that you are forecasted to use. + */ + ForecastedSpend?: Spend; + } + export type ComparisonOperator = "GREATER_THAN"|"LESS_THAN"|"EQUAL_TO"|string; + export type CostFilters = {[key: string]: DimensionValues}; + export interface CostTypes { + /** + * Specifies whether a budget includes taxes. The default value is true. + */ + IncludeTax?: NullableBoolean; + /** + * Specifies whether a budget includes subscriptions. The default value is true. + */ + IncludeSubscription?: NullableBoolean; + /** + * Specifies whether a budget uses a blended rate. The default value is false. + */ + UseBlended?: NullableBoolean; + /** + * Specifies whether a budget includes refunds. The default value is true. + */ + IncludeRefund?: NullableBoolean; + /** + * Specifies whether a budget includes credits. The default value is true. + */ + IncludeCredit?: NullableBoolean; + /** + * Specifies whether a budget includes upfront RI costs. The default value is true. + */ + IncludeUpfront?: NullableBoolean; + /** + * Specifies whether a budget includes recurring fees such as monthly RI fees. The default value is true. + */ + IncludeRecurring?: NullableBoolean; + /** + * Specifies whether a budget includes non-RI subscription costs. The default value is true. + */ + IncludeOtherSubscription?: NullableBoolean; + /** + * Specifies whether a budget includes support subscription fees. The default value is true. + */ + IncludeSupport?: NullableBoolean; + /** + * Specifies whether a budget includes discounts. The default value is true. + */ + IncludeDiscount?: NullableBoolean; + /** + * Specifies whether a budget uses the amortized rate. The default value is false. + */ + UseAmortized?: NullableBoolean; + } + export interface CreateBudgetRequest { + /** + * The accountId that is associated with the budget. + */ + AccountId: AccountId; + /** + * The budget object that you want to create. + */ + Budget: Budget; + /** + * A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you. + */ + NotificationsWithSubscribers?: NotificationWithSubscribersList; + } + export interface CreateBudgetResponse { + } + export interface CreateNotificationRequest { + /** + * The accountId that is associated with the budget that you want to create a notification for. + */ + AccountId: AccountId; + /** + * The name of the budget that you want AWS to notify you about. Budget names must be unique within an account. + */ + BudgetName: BudgetName; + /** + * The notification that you want to create. + */ + Notification: Notification; + /** + * A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers. + */ + Subscribers: Subscribers; + } + export interface CreateNotificationResponse { + } + export interface CreateSubscriberRequest { + /** + * The accountId that is associated with the budget that you want to create a subscriber for. + */ + AccountId: AccountId; + /** + * The name of the budget that you want to subscribe to. Budget names must be unique within an account. + */ + BudgetName: BudgetName; + /** + * The notification that you want to create a subscriber for. + */ + Notification: Notification; + /** + * The subscriber that you want to associate with a budget notification. + */ + Subscriber: Subscriber; + } + export interface CreateSubscriberResponse { + } + export interface DeleteBudgetRequest { + /** + * The accountId that is associated with the budget that you want to delete. + */ + AccountId: AccountId; + /** + * The name of the budget that you want to delete. + */ + BudgetName: BudgetName; + } + export interface DeleteBudgetResponse { + } + export interface DeleteNotificationRequest { + /** + * The accountId that is associated with the budget whose notification you want to delete. + */ + AccountId: AccountId; + /** + * The name of the budget whose notification you want to delete. + */ + BudgetName: BudgetName; + /** + * The notification that you want to delete. + */ + Notification: Notification; + } + export interface DeleteNotificationResponse { + } + export interface DeleteSubscriberRequest { + /** + * The accountId that is associated with the budget whose subscriber you want to delete. + */ + AccountId: AccountId; + /** + * The name of the budget whose subscriber you want to delete. + */ + BudgetName: BudgetName; + /** + * The notification whose subscriber you want to delete. + */ + Notification: Notification; + /** + * The subscriber that you want to delete. + */ + Subscriber: Subscriber; + } + export interface DeleteSubscriberResponse { + } + export interface DescribeBudgetPerformanceHistoryRequest { + AccountId: AccountId; + BudgetName: BudgetName; + /** + * Retrieves how often the budget went into an ALARM state for the specified time period. + */ + TimePeriod?: TimePeriod; + MaxResults?: MaxResults; + NextToken?: GenericString; + } + export interface DescribeBudgetPerformanceHistoryResponse { + /** + * The history of how often the budget has gone into an ALARM state. For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters. + */ + BudgetPerformanceHistory?: BudgetPerformanceHistory; + NextToken?: GenericString; + } + export interface DescribeBudgetRequest { + /** + * The accountId that is associated with the budget that you want a description of. + */ + AccountId: AccountId; + /** + * The name of the budget that you want a description of. + */ + BudgetName: BudgetName; + } + export interface DescribeBudgetResponse { + /** + * The description of the budget. + */ + Budget?: Budget; + } + export interface DescribeBudgetsRequest { + /** + * The accountId that is associated with the budgets that you want descriptions of. + */ + AccountId: AccountId; + /** + * An optional integer that represents how many entries a paginated response contains. The maximum is 100. + */ + MaxResults?: MaxResults; + /** + * The pagination token that you include in your request to indicate the next set of results that you want to retrieve. + */ + NextToken?: GenericString; + } + export interface DescribeBudgetsResponse { + /** + * A list of budgets. + */ + Budgets?: Budgets; + /** + * The pagination token in the service response that indicates the next set of results that you can retrieve. + */ + NextToken?: GenericString; + } + export interface DescribeNotificationsForBudgetRequest { + /** + * The accountId that is associated with the budget whose notifications you want descriptions of. + */ + AccountId: AccountId; + /** + * The name of the budget whose notifications you want descriptions of. + */ + BudgetName: BudgetName; + /** + * An optional integer that represents how many entries a paginated response contains. The maximum is 100. + */ + MaxResults?: MaxResults; + /** + * The pagination token that you include in your request to indicate the next set of results that you want to retrieve. + */ + NextToken?: GenericString; + } + export interface DescribeNotificationsForBudgetResponse { + /** + * A list of notifications that are associated with a budget. + */ + Notifications?: Notifications; + /** + * The pagination token in the service response that indicates the next set of results that you can retrieve. + */ + NextToken?: GenericString; + } + export interface DescribeSubscribersForNotificationRequest { + /** + * The accountId that is associated with the budget whose subscribers you want descriptions of. + */ + AccountId: AccountId; + /** + * The name of the budget whose subscribers you want descriptions of. + */ + BudgetName: BudgetName; + /** + * The notification whose subscribers you want to list. + */ + Notification: Notification; + /** + * An optional integer that represents how many entries a paginated response contains. The maximum is 100. + */ + MaxResults?: MaxResults; + /** + * The pagination token that you include in your request to indicate the next set of results that you want to retrieve. + */ + NextToken?: GenericString; + } + export interface DescribeSubscribersForNotificationResponse { + /** + * A list of subscribers that are associated with a notification. + */ + Subscribers?: Subscribers; + /** + * The pagination token in the service response that indicates the next set of results that you can retrieve. + */ + NextToken?: GenericString; + } + export type DimensionValues = GenericString[]; + export type GenericString = string; + export type GenericTimestamp = Date; + export type MaxResults = number; + export interface Notification { + /** + * Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED). + */ + NotificationType: NotificationType; + /** + * The comparison that is used for this notification. + */ + ComparisonOperator: ComparisonOperator; + /** + * The threshold that is associated with a notification. Thresholds are always a percentage. + */ + Threshold: NotificationThreshold; + /** + * The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars. + */ + ThresholdType?: ThresholdType; + /** + * Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget. + */ + NotificationState?: NotificationState; + } + export type NotificationState = "OK"|"ALARM"|string; + export type NotificationThreshold = number; + export type NotificationType = "ACTUAL"|"FORECASTED"|string; + export interface NotificationWithSubscribers { + /** + * The notification that is associated with a budget. + */ + Notification: Notification; + /** + * A list of subscribers who are subscribed to this notification. + */ + Subscribers: Subscribers; + } + export type NotificationWithSubscribersList = NotificationWithSubscribers[]; + export type Notifications = Notification[]; + export type NullableBoolean = boolean; + export type NumericValue = string; + export interface Spend { + /** + * The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold. + */ + Amount: NumericValue; + /** + * The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. + */ + Unit: UnitValue; + } + export interface Subscriber { + /** + * The type of notification that AWS sends to a subscriber. + */ + SubscriptionType: SubscriptionType; + /** + * The address that AWS sends budget notifications to, either an SNS topic or an email. + */ + Address: SubscriberAddress; + } + export type SubscriberAddress = string; + export type Subscribers = Subscriber[]; + export type SubscriptionType = "SNS"|"EMAIL"|string; + export type ThresholdType = "PERCENTAGE"|"ABSOLUTE_VALUE"|string; + export interface TimePeriod { + /** + * The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API. You can change your start date with the UpdateBudget operation. + */ + Start?: GenericTimestamp; + /** + * The end date for a budget. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API. After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget operation. + */ + End?: GenericTimestamp; + } + export type TimeUnit = "DAILY"|"MONTHLY"|"QUARTERLY"|"ANNUALLY"|string; + export type UnitValue = string; + export interface UpdateBudgetRequest { + /** + * The accountId that is associated with the budget that you want to update. + */ + AccountId: AccountId; + /** + * The budget that you want to update your budget to. + */ + NewBudget: Budget; + } + export interface UpdateBudgetResponse { + } + export interface UpdateNotificationRequest { + /** + * The accountId that is associated with the budget whose notification you want to update. + */ + AccountId: AccountId; + /** + * The name of the budget whose notification you want to update. + */ + BudgetName: BudgetName; + /** + * The previous notification that is associated with a budget. + */ + OldNotification: Notification; + /** + * The updated notification to be associated with a budget. + */ + NewNotification: Notification; + } + export interface UpdateNotificationResponse { + } + export interface UpdateSubscriberRequest { + /** + * The accountId that is associated with the budget whose subscriber you want to update. + */ + AccountId: AccountId; + /** + * The name of the budget whose subscriber you want to update. + */ + BudgetName: BudgetName; + /** + * The notification whose subscriber you want to update. + */ + Notification: Notification; + /** + * The previous subscriber that is associated with a budget notification. + */ + OldSubscriber: Subscriber; + /** + * The updated subscriber that is associated with a budget notification. + */ + NewSubscriber: Subscriber; + } + export interface UpdateSubscriberResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-10-20"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Budgets client. + */ + export import Types = Budgets; +} +export = Budgets; diff --git a/node_modules/aws-sdk/clients/budgets.js b/node_modules/aws-sdk/clients/budgets.js new file mode 100644 index 0000000..2cd5680 --- /dev/null +++ b/node_modules/aws-sdk/clients/budgets.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['budgets'] = {}; +AWS.Budgets = Service.defineService('budgets', ['2016-10-20']); +Object.defineProperty(apiLoader.services['budgets'], '2016-10-20', { + get: function get() { + var model = require('../apis/budgets-2016-10-20.min.json'); + model.paginators = require('../apis/budgets-2016-10-20.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Budgets; diff --git a/node_modules/aws-sdk/clients/chime.d.ts b/node_modules/aws-sdk/clients/chime.d.ts new file mode 100644 index 0000000..960b7f6 --- /dev/null +++ b/node_modules/aws-sdk/clients/chime.d.ts @@ -0,0 +1,1617 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Chime extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Chime.Types.ClientConfiguration) + config: Config & Chime.Types.ClientConfiguration; + /** + * Associates a phone number with the specified Amazon Chime user. + */ + associatePhoneNumberWithUser(params: Chime.Types.AssociatePhoneNumberWithUserRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumberWithUserResponse) => void): Request; + /** + * Associates a phone number with the specified Amazon Chime user. + */ + associatePhoneNumberWithUser(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumberWithUserResponse) => void): Request; + /** + * Associates a phone number with the specified Amazon Chime Voice Connector. + */ + associatePhoneNumbersWithVoiceConnector(params: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse) => void): Request; + /** + * Associates a phone number with the specified Amazon Chime Voice Connector. + */ + associatePhoneNumbersWithVoiceConnector(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse) => void): Request; + /** + * Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. + */ + batchDeletePhoneNumber(params: Chime.Types.BatchDeletePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.BatchDeletePhoneNumberResponse) => void): Request; + /** + * Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. + */ + batchDeletePhoneNumber(callback?: (err: AWSError, data: Chime.Types.BatchDeletePhoneNumberResponse) => void): Request; + /** + * Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are dissociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action. + */ + batchSuspendUser(params: Chime.Types.BatchSuspendUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchSuspendUserResponse) => void): Request; + /** + * Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are dissociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action. + */ + batchSuspendUser(callback?: (err: AWSError, data: Chime.Types.BatchSuspendUserResponse) => void): Request; + /** + * Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored. + */ + batchUnsuspendUser(params: Chime.Types.BatchUnsuspendUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchUnsuspendUserResponse) => void): Request; + /** + * Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored. + */ + batchUnsuspendUser(callback?: (err: AWSError, data: Chime.Types.BatchUnsuspendUserResponse) => void): Request; + /** + * Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. + */ + batchUpdatePhoneNumber(params: Chime.Types.BatchUpdatePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.BatchUpdatePhoneNumberResponse) => void): Request; + /** + * Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. + */ + batchUpdatePhoneNumber(callback?: (err: AWSError, data: Chime.Types.BatchUpdatePhoneNumberResponse) => void): Request; + /** + * Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action. + */ + batchUpdateUser(params: Chime.Types.BatchUpdateUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchUpdateUserResponse) => void): Request; + /** + * Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action. + */ + batchUpdateUser(callback?: (err: AWSError, data: Chime.Types.BatchUpdateUserResponse) => void): Request; + /** + * Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. + */ + createAccount(params: Chime.Types.CreateAccountRequest, callback?: (err: AWSError, data: Chime.Types.CreateAccountResponse) => void): Request; + /** + * Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. + */ + createAccount(callback?: (err: AWSError, data: Chime.Types.CreateAccountResponse) => void): Request; + /** + * Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. + */ + createPhoneNumberOrder(params: Chime.Types.CreatePhoneNumberOrderRequest, callback?: (err: AWSError, data: Chime.Types.CreatePhoneNumberOrderResponse) => void): Request; + /** + * Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. + */ + createPhoneNumberOrder(callback?: (err: AWSError, data: Chime.Types.CreatePhoneNumberOrderResponse) => void): Request; + /** + * Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked. + */ + createVoiceConnector(params: Chime.Types.CreateVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorResponse) => void): Request; + /** + * Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked. + */ + createVoiceConnector(callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorResponse) => void): Request; + /** + * Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list. + */ + deleteAccount(params: Chime.Types.DeleteAccountRequest, callback?: (err: AWSError, data: Chime.Types.DeleteAccountResponse) => void): Request; + /** + * Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list. + */ + deleteAccount(callback?: (err: AWSError, data: Chime.Types.DeleteAccountResponse) => void): Request; + /** + * Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. + */ + deletePhoneNumber(params: Chime.Types.DeletePhoneNumberRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. + */ + deletePhoneNumber(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned from it before it can be deleted. + */ + deleteVoiceConnector(params: Chime.Types.DeleteVoiceConnectorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned from it before it can be deleted. + */ + deleteVoiceConnector(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the origination settings for the specified Amazon Chime Voice Connector. + */ + deleteVoiceConnectorOrigination(params: Chime.Types.DeleteVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the origination settings for the specified Amazon Chime Voice Connector. + */ + deleteVoiceConnectorOrigination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the termination settings for the specified Amazon Chime Voice Connector. + */ + deleteVoiceConnectorTermination(params: Chime.Types.DeleteVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the termination settings for the specified Amazon Chime Voice Connector. + */ + deleteVoiceConnectorTermination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified SIP credentials used by your equipment to authenticate during call termination. + */ + deleteVoiceConnectorTerminationCredentials(params: Chime.Types.DeleteVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified SIP credentials used by your equipment to authenticate during call termination. + */ + deleteVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates the primary provisioned phone number from the specified Amazon Chime user. + */ + disassociatePhoneNumberFromUser(params: Chime.Types.DisassociatePhoneNumberFromUserRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumberFromUserResponse) => void): Request; + /** + * Disassociates the primary provisioned phone number from the specified Amazon Chime user. + */ + disassociatePhoneNumberFromUser(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumberFromUserResponse) => void): Request; + /** + * Disassociates the specified phone number from the specified Amazon Chime Voice Connector. + */ + disassociatePhoneNumbersFromVoiceConnector(params: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse) => void): Request; + /** + * Disassociates the specified phone number from the specified Amazon Chime Voice Connector. + */ + disassociatePhoneNumbersFromVoiceConnector(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse) => void): Request; + /** + * Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. + */ + getAccount(params: Chime.Types.GetAccountRequest, callback?: (err: AWSError, data: Chime.Types.GetAccountResponse) => void): Request; + /** + * Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. + */ + getAccount(callback?: (err: AWSError, data: Chime.Types.GetAccountResponse) => void): Request; + /** + * Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide. + */ + getAccountSettings(params: Chime.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: Chime.Types.GetAccountSettingsResponse) => void): Request; + /** + * Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide. + */ + getAccountSettings(callback?: (err: AWSError, data: Chime.Types.GetAccountSettingsResponse) => void): Request; + /** + * Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. + */ + getGlobalSettings(callback?: (err: AWSError, data: Chime.Types.GetGlobalSettingsResponse) => void): Request; + /** + * Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. + */ + getPhoneNumber(params: Chime.Types.GetPhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberResponse) => void): Request; + /** + * Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. + */ + getPhoneNumber(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberResponse) => void): Request; + /** + * Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status. + */ + getPhoneNumberOrder(params: Chime.Types.GetPhoneNumberOrderRequest, callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberOrderResponse) => void): Request; + /** + * Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status. + */ + getPhoneNumberOrder(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberOrderResponse) => void): Request; + /** + * Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN. To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address. + */ + getUser(params: Chime.Types.GetUserRequest, callback?: (err: AWSError, data: Chime.Types.GetUserResponse) => void): Request; + /** + * Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN. To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address. + */ + getUser(callback?: (err: AWSError, data: Chime.Types.GetUserResponse) => void): Request; + /** + * Retrieves settings for the specified user ID, such as any associated phone number settings. + */ + getUserSettings(params: Chime.Types.GetUserSettingsRequest, callback?: (err: AWSError, data: Chime.Types.GetUserSettingsResponse) => void): Request; + /** + * Retrieves settings for the specified user ID, such as any associated phone number settings. + */ + getUserSettings(callback?: (err: AWSError, data: Chime.Types.GetUserSettingsResponse) => void): Request; + /** + * Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements. + */ + getVoiceConnector(params: Chime.Types.GetVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorResponse) => void): Request; + /** + * Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements. + */ + getVoiceConnector(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorResponse) => void): Request; + /** + * Retrieves origination setting details for the specified Amazon Chime Voice Connector. + */ + getVoiceConnectorOrigination(params: Chime.Types.GetVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorOriginationResponse) => void): Request; + /** + * Retrieves origination setting details for the specified Amazon Chime Voice Connector. + */ + getVoiceConnectorOrigination(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorOriginationResponse) => void): Request; + /** + * Retrieves termination setting details for the specified Amazon Chime Voice Connector. + */ + getVoiceConnectorTermination(params: Chime.Types.GetVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationResponse) => void): Request; + /** + * Retrieves termination setting details for the specified Amazon Chime Voice Connector. + */ + getVoiceConnectorTermination(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationResponse) => void): Request; + /** + * Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector. + */ + getVoiceConnectorTerminationHealth(params: Chime.Types.GetVoiceConnectorTerminationHealthRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationHealthResponse) => void): Request; + /** + * Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector. + */ + getVoiceConnectorTerminationHealth(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationHealthResponse) => void): Request; + /** + * Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action. + */ + inviteUsers(params: Chime.Types.InviteUsersRequest, callback?: (err: AWSError, data: Chime.Types.InviteUsersResponse) => void): Request; + /** + * Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action. + */ + inviteUsers(callback?: (err: AWSError, data: Chime.Types.InviteUsersResponse) => void): Request; + /** + * Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result. + */ + listAccounts(params: Chime.Types.ListAccountsRequest, callback?: (err: AWSError, data: Chime.Types.ListAccountsResponse) => void): Request; + /** + * Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result. + */ + listAccounts(callback?: (err: AWSError, data: Chime.Types.ListAccountsResponse) => void): Request; + /** + * Lists the phone number orders for the administrator's Amazon Chime account. + */ + listPhoneNumberOrders(params: Chime.Types.ListPhoneNumberOrdersRequest, callback?: (err: AWSError, data: Chime.Types.ListPhoneNumberOrdersResponse) => void): Request; + /** + * Lists the phone number orders for the administrator's Amazon Chime account. + */ + listPhoneNumberOrders(callback?: (err: AWSError, data: Chime.Types.ListPhoneNumberOrdersResponse) => void): Request; + /** + * Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector. + */ + listPhoneNumbers(params: Chime.Types.ListPhoneNumbersRequest, callback?: (err: AWSError, data: Chime.Types.ListPhoneNumbersResponse) => void): Request; + /** + * Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector. + */ + listPhoneNumbers(callback?: (err: AWSError, data: Chime.Types.ListPhoneNumbersResponse) => void): Request; + /** + * Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to. + */ + listUsers(params: Chime.Types.ListUsersRequest, callback?: (err: AWSError, data: Chime.Types.ListUsersResponse) => void): Request; + /** + * Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to. + */ + listUsers(callback?: (err: AWSError, data: Chime.Types.ListUsersResponse) => void): Request; + /** + * Lists the SIP credentials for the specified Amazon Chime Voice Connector. + */ + listVoiceConnectorTerminationCredentials(params: Chime.Types.ListVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorTerminationCredentialsResponse) => void): Request; + /** + * Lists the SIP credentials for the specified Amazon Chime Voice Connector. + */ + listVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorTerminationCredentialsResponse) => void): Request; + /** + * Lists the Amazon Chime Voice Connectors for the administrator's AWS account. + */ + listVoiceConnectors(params: Chime.Types.ListVoiceConnectorsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorsResponse) => void): Request; + /** + * Lists the Amazon Chime Voice Connectors for the administrator's AWS account. + */ + listVoiceConnectors(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorsResponse) => void): Request; + /** + * Logs out the specified user from all of the devices they are currently logged into. + */ + logoutUser(params: Chime.Types.LogoutUserRequest, callback?: (err: AWSError, data: Chime.Types.LogoutUserResponse) => void): Request; + /** + * Logs out the specified user from all of the devices they are currently logged into. + */ + logoutUser(callback?: (err: AWSError, data: Chime.Types.LogoutUserResponse) => void): Request; + /** + * Adds origination settings for the specified Amazon Chime Voice Connector. + */ + putVoiceConnectorOrigination(params: Chime.Types.PutVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorOriginationResponse) => void): Request; + /** + * Adds origination settings for the specified Amazon Chime Voice Connector. + */ + putVoiceConnectorOrigination(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorOriginationResponse) => void): Request; + /** + * Adds termination settings for the specified Amazon Chime Voice Connector. + */ + putVoiceConnectorTermination(params: Chime.Types.PutVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorTerminationResponse) => void): Request; + /** + * Adds termination settings for the specified Amazon Chime Voice Connector. + */ + putVoiceConnectorTermination(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorTerminationResponse) => void): Request; + /** + * Adds termination SIP credentials for the specified Amazon Chime Voice Connector. + */ + putVoiceConnectorTerminationCredentials(params: Chime.Types.PutVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds termination SIP credentials for the specified Amazon Chime Voice Connector. + */ + putVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN. + */ + resetPersonalPIN(params: Chime.Types.ResetPersonalPINRequest, callback?: (err: AWSError, data: Chime.Types.ResetPersonalPINResponse) => void): Request; + /** + * Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN. + */ + resetPersonalPIN(callback?: (err: AWSError, data: Chime.Types.ResetPersonalPINResponse) => void): Request; + /** + * Moves a phone number from the Deletion queue back into the phone number Inventory. + */ + restorePhoneNumber(params: Chime.Types.RestorePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.RestorePhoneNumberResponse) => void): Request; + /** + * Moves a phone number from the Deletion queue back into the phone number Inventory. + */ + restorePhoneNumber(callback?: (err: AWSError, data: Chime.Types.RestorePhoneNumberResponse) => void): Request; + /** + * Searches phone numbers that can be ordered. + */ + searchAvailablePhoneNumbers(params: Chime.Types.SearchAvailablePhoneNumbersRequest, callback?: (err: AWSError, data: Chime.Types.SearchAvailablePhoneNumbersResponse) => void): Request; + /** + * Searches phone numbers that can be ordered. + */ + searchAvailablePhoneNumbers(callback?: (err: AWSError, data: Chime.Types.SearchAvailablePhoneNumbersResponse) => void): Request; + /** + * Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action. + */ + updateAccount(params: Chime.Types.UpdateAccountRequest, callback?: (err: AWSError, data: Chime.Types.UpdateAccountResponse) => void): Request; + /** + * Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action. + */ + updateAccount(callback?: (err: AWSError, data: Chime.Types.UpdateAccountResponse) => void): Request; + /** + * Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide. + */ + updateAccountSettings(params: Chime.Types.UpdateAccountSettingsRequest, callback?: (err: AWSError, data: Chime.Types.UpdateAccountSettingsResponse) => void): Request; + /** + * Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide. + */ + updateAccountSettings(callback?: (err: AWSError, data: Chime.Types.UpdateAccountSettingsResponse) => void): Request; + /** + * Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. + */ + updateGlobalSettings(params: Chime.Types.UpdateGlobalSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. + */ + updateGlobalSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates phone number details, such as product type, for the specified phone number ID. + */ + updatePhoneNumber(params: Chime.Types.UpdatePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.UpdatePhoneNumberResponse) => void): Request; + /** + * Updates phone number details, such as product type, for the specified phone number ID. + */ + updatePhoneNumber(callback?: (err: AWSError, data: Chime.Types.UpdatePhoneNumberResponse) => void): Request; + /** + * Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action. + */ + updateUser(params: Chime.Types.UpdateUserRequest, callback?: (err: AWSError, data: Chime.Types.UpdateUserResponse) => void): Request; + /** + * Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action. + */ + updateUser(callback?: (err: AWSError, data: Chime.Types.UpdateUserResponse) => void): Request; + /** + * Updates the settings for the specified user, such as phone number settings. + */ + updateUserSettings(params: Chime.Types.UpdateUserSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings for the specified user, such as phone number settings. + */ + updateUserSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates details for the specified Amazon Chime Voice Connector. + */ + updateVoiceConnector(params: Chime.Types.UpdateVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorResponse) => void): Request; + /** + * Updates details for the specified Amazon Chime Voice Connector. + */ + updateVoiceConnector(callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorResponse) => void): Request; +} +declare namespace Chime { + export interface Account { + /** + * The AWS account ID. + */ + AwsAccountId: String; + /** + * The Amazon Chime account ID. + */ + AccountId: String; + /** + * The Amazon Chime account name. + */ + Name: String; + /** + * The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. + */ + AccountType?: AccountType; + /** + * The Amazon Chime account creation timestamp, in ISO 8601 format. + */ + CreatedTimestamp?: Iso8601Timestamp; + /** + * The default license for the Amazon Chime account. + */ + DefaultLicense?: License; + /** + * Supported licenses for the Amazon Chime account. + */ + SupportedLicenses?: LicenseList; + } + export type AccountList = Account[]; + export type AccountName = string; + export interface AccountSettings { + /** + * Setting that stops or starts remote control of shared screens during meetings. + */ + DisableRemoteControl?: Boolean; + /** + * Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App. + */ + EnableDialOut?: Boolean; + } + export type AccountType = "Team"|"EnterpriseDirectory"|"EnterpriseLWA"|"EnterpriseOIDC"|string; + export interface AssociatePhoneNumberWithUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: String; + /** + * The user ID. + */ + UserId: String; + /** + * The phone number, in E.164 format. + */ + E164PhoneNumber: E164PhoneNumber; + } + export interface AssociatePhoneNumberWithUserResponse { + } + export interface AssociatePhoneNumbersWithVoiceConnectorRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + /** + * List of phone numbers, in E.164 format. + */ + E164PhoneNumbers?: E164PhoneNumberList; + } + export interface AssociatePhoneNumbersWithVoiceConnectorResponse { + /** + * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. + */ + PhoneNumberErrors?: PhoneNumberErrorList; + } + export interface BatchDeletePhoneNumberRequest { + /** + * List of phone number IDs. + */ + PhoneNumberIds: NonEmptyStringList; + } + export interface BatchDeletePhoneNumberResponse { + /** + * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. + */ + PhoneNumberErrors?: PhoneNumberErrorList; + } + export interface BatchSuspendUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The request containing the user IDs to suspend. + */ + UserIdList: UserIdList; + } + export interface BatchSuspendUserResponse { + /** + * If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages. + */ + UserErrors?: UserErrorList; + } + export interface BatchUnsuspendUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The request containing the user IDs to unsuspend. + */ + UserIdList: UserIdList; + } + export interface BatchUnsuspendUserResponse { + /** + * If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages. + */ + UserErrors?: UserErrorList; + } + export interface BatchUpdatePhoneNumberRequest { + /** + * The request containing the phone number IDs and product types to update. + */ + UpdatePhoneNumberRequestItems: UpdatePhoneNumberRequestItemList; + } + export interface BatchUpdatePhoneNumberResponse { + /** + * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. + */ + PhoneNumberErrors?: PhoneNumberErrorList; + } + export interface BatchUpdateUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The request containing the user IDs and details to update. + */ + UpdateUserRequestItems: UpdateUserRequestItemList; + } + export interface BatchUpdateUserResponse { + /** + * If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages. + */ + UserErrors?: UserErrorList; + } + export type Boolean = boolean; + export interface BusinessCallingSettings { + /** + * The Amazon S3 bucket designated for call detail record storage. + */ + CdrBucket?: String; + } + export type CallingRegion = string; + export type CallingRegionList = CallingRegion[]; + export type CpsLimit = number; + export interface CreateAccountRequest { + /** + * The name of the Amazon Chime account. + */ + Name: AccountName; + } + export interface CreateAccountResponse { + /** + * The Amazon Chime account details. + */ + Account?: Account; + } + export interface CreatePhoneNumberOrderRequest { + /** + * The phone number product type. + */ + ProductType: PhoneNumberProductType; + /** + * List of phone numbers, in E.164 format. + */ + E164PhoneNumbers: E164PhoneNumberList; + } + export interface CreatePhoneNumberOrderResponse { + /** + * The phone number order details. + */ + PhoneNumberOrder?: PhoneNumberOrder; + } + export interface CreateVoiceConnectorRequest { + /** + * The name of the Amazon Chime Voice Connector. + */ + Name: VoiceConnectorName; + /** + * When enabled, requires encryption for the Amazon Chime Voice Connector. + */ + RequireEncryption: Boolean; + } + export interface CreateVoiceConnectorResponse { + /** + * The Amazon Chime Voice Connector details. + */ + VoiceConnector?: VoiceConnector; + } + export interface Credential { + /** + * The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format. + */ + Username?: SensitiveString; + /** + * The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format. + */ + Password?: SensitiveString; + } + export type CredentialList = Credential[]; + export interface DeleteAccountRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + } + export interface DeleteAccountResponse { + } + export interface DeletePhoneNumberRequest { + /** + * The phone number ID. + */ + PhoneNumberId: String; + } + export interface DeleteVoiceConnectorOriginationRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface DeleteVoiceConnectorRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface DeleteVoiceConnectorTerminationCredentialsRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + /** + * The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format. + */ + Usernames?: SensitiveStringList; + } + export interface DeleteVoiceConnectorTerminationRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface DisassociatePhoneNumberFromUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: String; + /** + * The user ID. + */ + UserId: String; + } + export interface DisassociatePhoneNumberFromUserResponse { + } + export interface DisassociatePhoneNumbersFromVoiceConnectorRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + /** + * List of phone numbers, in E.164 format. + */ + E164PhoneNumbers?: E164PhoneNumberList; + } + export interface DisassociatePhoneNumbersFromVoiceConnectorResponse { + /** + * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. + */ + PhoneNumberErrors?: PhoneNumberErrorList; + } + export type E164PhoneNumber = string; + export type E164PhoneNumberList = E164PhoneNumber[]; + export type EmailAddress = string; + export type EmailStatus = "NotSent"|"Sent"|"Failed"|string; + export type ErrorCode = "Unauthorized"|"Forbidden"|"NotFound"|"BadRequest"|"Conflict"|"ServiceFailure"|"ServiceUnavailable"|"Unprocessable"|"Throttled"|"PreconditionFailed"|string; + export interface GetAccountRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + } + export interface GetAccountResponse { + /** + * The Amazon Chime account details. + */ + Account?: Account; + } + export interface GetAccountSettingsRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + } + export interface GetAccountSettingsResponse { + /** + * The Amazon Chime account settings. + */ + AccountSettings?: AccountSettings; + } + export interface GetGlobalSettingsResponse { + /** + * The Amazon Chime Business Calling settings. + */ + BusinessCalling?: BusinessCallingSettings; + /** + * The Amazon Chime Voice Connector settings. + */ + VoiceConnector?: VoiceConnectorSettings; + } + export interface GetPhoneNumberOrderRequest { + /** + * The ID for the phone number order. + */ + PhoneNumberOrderId: GuidString; + } + export interface GetPhoneNumberOrderResponse { + /** + * The phone number order details. + */ + PhoneNumberOrder?: PhoneNumberOrder; + } + export interface GetPhoneNumberRequest { + /** + * The phone number ID. + */ + PhoneNumberId: String; + } + export interface GetPhoneNumberResponse { + /** + * The phone number details. + */ + PhoneNumber?: PhoneNumber; + } + export interface GetUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The user ID. + */ + UserId: NonEmptyString; + } + export interface GetUserResponse { + /** + * The user details. + */ + User?: User; + } + export interface GetUserSettingsRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: String; + /** + * The user ID. + */ + UserId: String; + } + export interface GetUserSettingsResponse { + /** + * The user settings. + */ + UserSettings?: UserSettings; + } + export interface GetVoiceConnectorOriginationRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface GetVoiceConnectorOriginationResponse { + /** + * The origination setting details. + */ + Origination?: Origination; + } + export interface GetVoiceConnectorRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface GetVoiceConnectorResponse { + /** + * The Amazon Chime Voice Connector details. + */ + VoiceConnector?: VoiceConnector; + } + export interface GetVoiceConnectorTerminationHealthRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface GetVoiceConnectorTerminationHealthResponse { + /** + * The termination health details. + */ + TerminationHealth?: TerminationHealth; + } + export interface GetVoiceConnectorTerminationRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface GetVoiceConnectorTerminationResponse { + /** + * The termination setting details. + */ + Termination?: Termination; + } + export type GuidString = string; + export interface Invite { + /** + * The invite ID. + */ + InviteId?: String; + /** + * The status of the invite. + */ + Status?: InviteStatus; + /** + * The email address to which the invite is sent. + */ + EmailAddress?: EmailAddress; + /** + * The status of the invite email. + */ + EmailStatus?: EmailStatus; + } + export type InviteList = Invite[]; + export type InviteStatus = "Pending"|"Accepted"|"Failed"|string; + export interface InviteUsersRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The user email addresses to which to send the invite. + */ + UserEmailList: UserEmailList; + } + export interface InviteUsersResponse { + /** + * The invite details. + */ + Invites?: InviteList; + } + export type Iso8601Timestamp = Date; + export type License = "Basic"|"Plus"|"Pro"|"ProTrial"|string; + export type LicenseList = License[]; + export interface ListAccountsRequest { + /** + * Amazon Chime account name prefix with which to filter results. + */ + Name?: AccountName; + /** + * User email address with which to filter results. + */ + UserEmail?: EmailAddress; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. Defaults to 100. + */ + MaxResults?: ProfileServiceMaxResults; + } + export interface ListAccountsResponse { + /** + * List of Amazon Chime accounts and account details. + */ + Accounts?: AccountList; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface ListPhoneNumberOrdersRequest { + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: ResultMax; + } + export interface ListPhoneNumberOrdersResponse { + /** + * The phone number order details. + */ + PhoneNumberOrders?: PhoneNumberOrderList; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface ListPhoneNumbersRequest { + /** + * The phone number status. + */ + Status?: PhoneNumberStatus; + /** + * The phone number product type. + */ + ProductType?: PhoneNumberProductType; + /** + * The filter to use to limit the number of results. + */ + FilterName?: PhoneNumberAssociationName; + /** + * The value to use for the filter. + */ + FilterValue?: String; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: ResultMax; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface ListPhoneNumbersResponse { + /** + * The phone number details. + */ + PhoneNumbers?: PhoneNumberList; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface ListUsersRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * Optional. The user email address used to filter results. Maximum 1. + */ + UserEmail?: EmailAddress; + /** + * The maximum number of results to return in a single call. Defaults to 100. + */ + MaxResults?: ProfileServiceMaxResults; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface ListUsersResponse { + /** + * List of users and user details. + */ + Users?: UserList; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface ListVoiceConnectorTerminationCredentialsRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + } + export interface ListVoiceConnectorTerminationCredentialsResponse { + /** + * A list of user names. + */ + Usernames?: SensitiveStringList; + } + export interface ListVoiceConnectorsRequest { + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: ResultMax; + } + export interface ListVoiceConnectorsResponse { + /** + * The details of the Amazon Chime Voice Connectors. + */ + VoiceConnectors?: VoiceConnectorList; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface LogoutUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The user ID. + */ + UserId: NonEmptyString; + } + export interface LogoutUserResponse { + } + export type NonEmptyString = string; + export type NonEmptyStringList = String[]; + export type NullableBoolean = boolean; + export interface OrderedPhoneNumber { + /** + * The phone number, in E.164 format. + */ + E164PhoneNumber?: E164PhoneNumber; + /** + * The phone number status. + */ + Status?: OrderedPhoneNumberStatus; + } + export type OrderedPhoneNumberList = OrderedPhoneNumber[]; + export type OrderedPhoneNumberStatus = "Processing"|"Acquired"|"Failed"|string; + export interface Origination { + /** + * The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. + */ + Routes?: OriginationRouteList; + /** + * When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. + */ + Disabled?: Boolean; + } + export interface OriginationRoute { + /** + * The FODN or IP address to contact for origination traffic. + */ + Host?: String; + /** + * The designated origination route port. Defaults to 5060. + */ + Port?: Port; + /** + * The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default. + */ + Protocol?: OriginationRouteProtocol; + /** + * The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first. + */ + Priority?: OriginationRoutePriority; + /** + * The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight. + */ + Weight?: OriginationRouteWeight; + } + export type OriginationRouteList = OriginationRoute[]; + export type OriginationRoutePriority = number; + export type OriginationRouteProtocol = "TCP"|"UDP"|string; + export type OriginationRouteWeight = number; + export interface PhoneNumber { + /** + * The phone number ID. + */ + PhoneNumberId?: String; + /** + * The phone number, in E.164 format. + */ + E164PhoneNumber?: E164PhoneNumber; + /** + * The phone number product type. + */ + ProductType?: PhoneNumberProductType; + /** + * The phone number status. + */ + Status?: PhoneNumberStatus; + /** + * The phone number capabilities. + */ + Capabilities?: PhoneNumberCapabilities; + /** + * The phone number associations. + */ + Associations?: PhoneNumberAssociationList; + /** + * The phone number creation timestamp, in ISO 8601 format. + */ + CreatedTimestamp?: Iso8601Timestamp; + /** + * The updated phone number timestamp, in ISO 8601 format. + */ + UpdatedTimestamp?: Iso8601Timestamp; + /** + * The deleted phone number timestamp, in ISO 8601 format. + */ + DeletionTimestamp?: Iso8601Timestamp; + } + export interface PhoneNumberAssociation { + /** + * Contains the ID for the entity specified in Name. + */ + Value?: String; + /** + * Defines the association with an Amazon Chime account ID, user ID, or Amazon Chime Voice Connector ID. + */ + Name?: PhoneNumberAssociationName; + /** + * The timestamp of the phone number association, in ISO 8601 format. + */ + AssociatedTimestamp?: Iso8601Timestamp; + } + export type PhoneNumberAssociationList = PhoneNumberAssociation[]; + export type PhoneNumberAssociationName = "AccountId"|"UserId"|"VoiceConnectorId"|string; + export interface PhoneNumberCapabilities { + /** + * Allows or denies inbound calling for the specified phone number. + */ + InboundCall?: NullableBoolean; + /** + * Allows or denies outbound calling for the specified phone number. + */ + OutboundCall?: NullableBoolean; + /** + * Allows or denies inbound SMS messaging for the specified phone number. + */ + InboundSMS?: NullableBoolean; + /** + * Allows or denies outbound SMS messaging for the specified phone number. + */ + OutboundSMS?: NullableBoolean; + /** + * Allows or denies inbound MMS messaging for the specified phone number. + */ + InboundMMS?: NullableBoolean; + /** + * Allows or denies outbound MMS messaging for the specified phone number. + */ + OutboundMMS?: NullableBoolean; + } + export interface PhoneNumberError { + /** + * The phone number ID for which the action failed. + */ + PhoneNumberId?: NonEmptyString; + /** + * The error code. + */ + ErrorCode?: ErrorCode; + /** + * The error message. + */ + ErrorMessage?: String; + } + export type PhoneNumberErrorList = PhoneNumberError[]; + export type PhoneNumberList = PhoneNumber[]; + export type PhoneNumberMaxResults = number; + export interface PhoneNumberOrder { + /** + * The phone number order ID. + */ + PhoneNumberOrderId?: GuidString; + /** + * The phone number order product type. + */ + ProductType?: PhoneNumberProductType; + /** + * The status of the phone number order. + */ + Status?: PhoneNumberOrderStatus; + /** + * The ordered phone number details, such as the phone number in E.164 format and the phone number status. + */ + OrderedPhoneNumbers?: OrderedPhoneNumberList; + /** + * The phone number order creation timestamp, in ISO 8601 format. + */ + CreatedTimestamp?: Iso8601Timestamp; + /** + * The updated phone number order timestamp, in ISO 8601 format. + */ + UpdatedTimestamp?: Iso8601Timestamp; + } + export type PhoneNumberOrderList = PhoneNumberOrder[]; + export type PhoneNumberOrderStatus = "Processing"|"Successful"|"Failed"|"Partial"|string; + export type PhoneNumberProductType = "BusinessCalling"|"VoiceConnector"|string; + export type PhoneNumberStatus = "AcquireInProgress"|"AcquireFailed"|"Unassigned"|"Assigned"|"ReleaseInProgress"|"DeleteInProgress"|"ReleaseFailed"|"DeleteFailed"|string; + export type Port = number; + export type ProfileServiceMaxResults = number; + export interface PutVoiceConnectorOriginationRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + /** + * The origination setting details to add. + */ + Origination: Origination; + } + export interface PutVoiceConnectorOriginationResponse { + /** + * The updated origination setting details. + */ + Origination?: Origination; + } + export interface PutVoiceConnectorTerminationCredentialsRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + /** + * The termination SIP credentials. + */ + Credentials?: CredentialList; + } + export interface PutVoiceConnectorTerminationRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + /** + * The termination setting details to add. + */ + Termination: Termination; + } + export interface PutVoiceConnectorTerminationResponse { + /** + * The updated termination setting details. + */ + Termination?: Termination; + } + export type RegistrationStatus = "Unregistered"|"Registered"|"Suspended"|string; + export interface ResetPersonalPINRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The user ID. + */ + UserId: NonEmptyString; + } + export interface ResetPersonalPINResponse { + /** + * The user details and new personal meeting PIN. + */ + User?: User; + } + export interface RestorePhoneNumberRequest { + /** + * The phone number. + */ + PhoneNumberId: NonEmptyString; + } + export interface RestorePhoneNumberResponse { + /** + * The phone number details. + */ + PhoneNumber?: PhoneNumber; + } + export type ResultMax = number; + export interface SearchAvailablePhoneNumbersRequest { + /** + * The area code used to filter results. + */ + AreaCode?: String; + /** + * The city used to filter results. + */ + City?: String; + /** + * The country used to filter results. + */ + Country?: String; + /** + * The state used to filter results. + */ + State?: String; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: PhoneNumberMaxResults; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface SearchAvailablePhoneNumbersResponse { + /** + * List of phone numbers, in E.164 format. + */ + E164PhoneNumbers?: E164PhoneNumberList; + } + export type SensitiveString = string; + export type SensitiveStringList = SensitiveString[]; + export type String = string; + export type StringList = String[]; + export interface TelephonySettings { + /** + * Allows or denies inbound calling. + */ + InboundCalling: Boolean; + /** + * Allows or denies outbound calling. + */ + OutboundCalling: Boolean; + /** + * Allows or denies SMS messaging. + */ + SMS: Boolean; + } + export interface Termination { + /** + * The limit on calls per second. Max value based on account service limit. Default value of 1. + */ + CpsLimit?: CpsLimit; + /** + * The default caller ID phone number. + */ + DefaultPhoneNumber?: E164PhoneNumber; + /** + * The countries to which calls are allowed. + */ + CallingRegions?: CallingRegionList; + /** + * The IP addresses allowed to make calls, in CIDR format. + */ + CidrAllowedList?: StringList; + /** + * When termination settings are disabled, outbound calls can not be made. + */ + Disabled?: Boolean; + } + export interface TerminationHealth { + /** + * The timestamp, in ISO 8601 format. + */ + Timestamp?: Iso8601Timestamp; + /** + * The source IP address. + */ + Source?: String; + } + export interface UpdateAccountRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The new name for the specified Amazon Chime account. + */ + Name?: AccountName; + } + export interface UpdateAccountResponse { + /** + * The updated Amazon Chime account details. + */ + Account?: Account; + } + export interface UpdateAccountSettingsRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The Amazon Chime account settings to update. + */ + AccountSettings: AccountSettings; + } + export interface UpdateAccountSettingsResponse { + } + export interface UpdateGlobalSettingsRequest { + /** + * The Amazon Chime Business Calling settings. + */ + BusinessCalling: BusinessCallingSettings; + /** + * The Amazon Chime Voice Connector settings. + */ + VoiceConnector: VoiceConnectorSettings; + } + export interface UpdatePhoneNumberRequest { + /** + * The phone number ID. + */ + PhoneNumberId: String; + /** + * The product type. + */ + ProductType?: PhoneNumberProductType; + } + export interface UpdatePhoneNumberRequestItem { + /** + * The phone number ID to update. + */ + PhoneNumberId: NonEmptyString; + /** + * The product type to update. + */ + ProductType?: PhoneNumberProductType; + } + export type UpdatePhoneNumberRequestItemList = UpdatePhoneNumberRequestItem[]; + export interface UpdatePhoneNumberResponse { + /** + * The updated phone number details. + */ + PhoneNumber?: PhoneNumber; + } + export interface UpdateUserRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: NonEmptyString; + /** + * The user ID. + */ + UserId: NonEmptyString; + /** + * The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to. + */ + LicenseType?: License; + } + export interface UpdateUserRequestItem { + /** + * The user ID. + */ + UserId: NonEmptyString; + /** + * The user license type. + */ + LicenseType?: License; + } + export type UpdateUserRequestItemList = UpdateUserRequestItem[]; + export interface UpdateUserResponse { + /** + * The updated user details. + */ + User?: User; + } + export interface UpdateUserSettingsRequest { + /** + * The Amazon Chime account ID. + */ + AccountId: String; + /** + * The user ID. + */ + UserId: String; + /** + * The user settings to update. + */ + UserSettings: UserSettings; + } + export interface UpdateVoiceConnectorRequest { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId: NonEmptyString; + /** + * The name of the Amazon Chime Voice Connector. + */ + Name: VoiceConnectorName; + /** + * When enabled, requires encryption for the Amazon Chime Voice Connector. + */ + RequireEncryption: Boolean; + } + export interface UpdateVoiceConnectorResponse { + /** + * The Amazon Chime Voice Connector details. + */ + VoiceConnector?: VoiceConnector; + } + export interface User { + /** + * The user ID. + */ + UserId: String; + /** + * The Amazon Chime account ID. + */ + AccountId?: String; + /** + * The primary email address of the user. + */ + PrimaryEmail?: EmailAddress; + /** + * The primary phone number associated with the user. + */ + PrimaryProvisionedNumber?: SensitiveString; + /** + * The display name of the user. + */ + DisplayName?: SensitiveString; + /** + * The license type for the user. + */ + LicenseType?: License; + /** + * The user registration status. + */ + UserRegistrationStatus?: RegistrationStatus; + /** + * The user invite status. + */ + UserInvitationStatus?: InviteStatus; + /** + * Date and time when the user is registered, in ISO 8601 format. + */ + RegisteredOn?: Iso8601Timestamp; + /** + * Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format. + */ + InvitedOn?: Iso8601Timestamp; + /** + * The user's personal meeting PIN. + */ + PersonalPIN?: String; + } + export type UserEmailList = EmailAddress[]; + export interface UserError { + /** + * The user ID for which the action failed. + */ + UserId?: NonEmptyString; + /** + * The error code. + */ + ErrorCode?: ErrorCode; + /** + * The error message. + */ + ErrorMessage?: String; + } + export type UserErrorList = UserError[]; + export type UserIdList = NonEmptyString[]; + export type UserList = User[]; + export interface UserSettings { + /** + * The telephony settings associated with the user. + */ + Telephony: TelephonySettings; + } + export interface VoiceConnector { + /** + * The Amazon Chime Voice Connector ID. + */ + VoiceConnectorId?: NonEmptyString; + /** + * The name of the Amazon Chime Voice Connector. + */ + Name?: VoiceConnectorName; + /** + * The outbound host name for the Amazon Chime Voice Connector. + */ + OutboundHostName?: String; + /** + * Designates whether encryption is required for the Amazon Chime Voice Connector. + */ + RequireEncryption?: Boolean; + /** + * The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format. + */ + CreatedTimestamp?: Iso8601Timestamp; + /** + * The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format. + */ + UpdatedTimestamp?: Iso8601Timestamp; + } + export type VoiceConnectorList = VoiceConnector[]; + export type VoiceConnectorName = string; + export interface VoiceConnectorSettings { + /** + * The Amazon S3 bucket designated for call detail record storage. + */ + CdrBucket?: String; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-05-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Chime client. + */ + export import Types = Chime; +} +export = Chime; diff --git a/node_modules/aws-sdk/clients/chime.js b/node_modules/aws-sdk/clients/chime.js new file mode 100644 index 0000000..7790c54 --- /dev/null +++ b/node_modules/aws-sdk/clients/chime.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['chime'] = {}; +AWS.Chime = Service.defineService('chime', ['2018-05-01']); +Object.defineProperty(apiLoader.services['chime'], '2018-05-01', { + get: function get() { + var model = require('../apis/chime-2018-05-01.min.json'); + model.paginators = require('../apis/chime-2018-05-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Chime; diff --git a/node_modules/aws-sdk/clients/cloud9.d.ts b/node_modules/aws-sdk/clients/cloud9.d.ts new file mode 100644 index 0000000..c8d1f89 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloud9.d.ts @@ -0,0 +1,391 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Cloud9 extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Cloud9.Types.ClientConfiguration) + config: Config & Cloud9.Types.ClientConfiguration; + /** + * Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment. + */ + createEnvironmentEC2(params: Cloud9.Types.CreateEnvironmentEC2Request, callback?: (err: AWSError, data: Cloud9.Types.CreateEnvironmentEC2Result) => void): Request; + /** + * Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment. + */ + createEnvironmentEC2(callback?: (err: AWSError, data: Cloud9.Types.CreateEnvironmentEC2Result) => void): Request; + /** + * Adds an environment member to an AWS Cloud9 development environment. + */ + createEnvironmentMembership(params: Cloud9.Types.CreateEnvironmentMembershipRequest, callback?: (err: AWSError, data: Cloud9.Types.CreateEnvironmentMembershipResult) => void): Request; + /** + * Adds an environment member to an AWS Cloud9 development environment. + */ + createEnvironmentMembership(callback?: (err: AWSError, data: Cloud9.Types.CreateEnvironmentMembershipResult) => void): Request; + /** + * Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. + */ + deleteEnvironment(params: Cloud9.Types.DeleteEnvironmentRequest, callback?: (err: AWSError, data: Cloud9.Types.DeleteEnvironmentResult) => void): Request; + /** + * Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. + */ + deleteEnvironment(callback?: (err: AWSError, data: Cloud9.Types.DeleteEnvironmentResult) => void): Request; + /** + * Deletes an environment member from an AWS Cloud9 development environment. + */ + deleteEnvironmentMembership(params: Cloud9.Types.DeleteEnvironmentMembershipRequest, callback?: (err: AWSError, data: Cloud9.Types.DeleteEnvironmentMembershipResult) => void): Request; + /** + * Deletes an environment member from an AWS Cloud9 development environment. + */ + deleteEnvironmentMembership(callback?: (err: AWSError, data: Cloud9.Types.DeleteEnvironmentMembershipResult) => void): Request; + /** + * Gets information about environment members for an AWS Cloud9 development environment. + */ + describeEnvironmentMemberships(params: Cloud9.Types.DescribeEnvironmentMembershipsRequest, callback?: (err: AWSError, data: Cloud9.Types.DescribeEnvironmentMembershipsResult) => void): Request; + /** + * Gets information about environment members for an AWS Cloud9 development environment. + */ + describeEnvironmentMemberships(callback?: (err: AWSError, data: Cloud9.Types.DescribeEnvironmentMembershipsResult) => void): Request; + /** + * Gets status information for an AWS Cloud9 development environment. + */ + describeEnvironmentStatus(params: Cloud9.Types.DescribeEnvironmentStatusRequest, callback?: (err: AWSError, data: Cloud9.Types.DescribeEnvironmentStatusResult) => void): Request; + /** + * Gets status information for an AWS Cloud9 development environment. + */ + describeEnvironmentStatus(callback?: (err: AWSError, data: Cloud9.Types.DescribeEnvironmentStatusResult) => void): Request; + /** + * Gets information about AWS Cloud9 development environments. + */ + describeEnvironments(params: Cloud9.Types.DescribeEnvironmentsRequest, callback?: (err: AWSError, data: Cloud9.Types.DescribeEnvironmentsResult) => void): Request; + /** + * Gets information about AWS Cloud9 development environments. + */ + describeEnvironments(callback?: (err: AWSError, data: Cloud9.Types.DescribeEnvironmentsResult) => void): Request; + /** + * Gets a list of AWS Cloud9 development environment identifiers. + */ + listEnvironments(params: Cloud9.Types.ListEnvironmentsRequest, callback?: (err: AWSError, data: Cloud9.Types.ListEnvironmentsResult) => void): Request; + /** + * Gets a list of AWS Cloud9 development environment identifiers. + */ + listEnvironments(callback?: (err: AWSError, data: Cloud9.Types.ListEnvironmentsResult) => void): Request; + /** + * Changes the settings of an existing AWS Cloud9 development environment. + */ + updateEnvironment(params: Cloud9.Types.UpdateEnvironmentRequest, callback?: (err: AWSError, data: Cloud9.Types.UpdateEnvironmentResult) => void): Request; + /** + * Changes the settings of an existing AWS Cloud9 development environment. + */ + updateEnvironment(callback?: (err: AWSError, data: Cloud9.Types.UpdateEnvironmentResult) => void): Request; + /** + * Changes the settings of an existing environment member for an AWS Cloud9 development environment. + */ + updateEnvironmentMembership(params: Cloud9.Types.UpdateEnvironmentMembershipRequest, callback?: (err: AWSError, data: Cloud9.Types.UpdateEnvironmentMembershipResult) => void): Request; + /** + * Changes the settings of an existing environment member for an AWS Cloud9 development environment. + */ + updateEnvironmentMembership(callback?: (err: AWSError, data: Cloud9.Types.UpdateEnvironmentMembershipResult) => void): Request; +} +declare namespace Cloud9 { + export type AutomaticStopTimeMinutes = number; + export type BoundedEnvironmentIdList = EnvironmentId[]; + export type ClientRequestToken = string; + export interface CreateEnvironmentEC2Request { + /** + * The name of the environment to create. This name is visible to other AWS IAM users in the same AWS account. + */ + name: EnvironmentName; + /** + * The description of the environment to create. + */ + description?: EnvironmentDescription; + /** + * A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time. For more information, see Client Tokens in the Amazon EC2 API Reference. + */ + clientRequestToken?: ClientRequestToken; + /** + * The type of instance to connect to the environment (for example, t2.micro). + */ + instanceType: InstanceType; + /** + * The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance. + */ + subnetId?: SubnetId; + /** + * The number of minutes until the running instance is shut down after the environment has last been used. + */ + automaticStopTimeMinutes?: AutomaticStopTimeMinutes; + /** + * The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator. + */ + ownerArn?: UserArn; + } + export interface CreateEnvironmentEC2Result { + /** + * The ID of the environment that was created. + */ + environmentId?: EnvironmentId; + } + export interface CreateEnvironmentMembershipRequest { + /** + * The ID of the environment that contains the environment member you want to add. + */ + environmentId: EnvironmentId; + /** + * The Amazon Resource Name (ARN) of the environment member you want to add. + */ + userArn: UserArn; + /** + * The type of environment member permissions you want to associate with this environment member. Available values include: read-only: Has read-only access to the environment. read-write: Has read-write access to the environment. + */ + permissions: MemberPermissions; + } + export interface CreateEnvironmentMembershipResult { + /** + * Information about the environment member that was added. + */ + membership?: EnvironmentMember; + } + export interface DeleteEnvironmentMembershipRequest { + /** + * The ID of the environment to delete the environment member from. + */ + environmentId: EnvironmentId; + /** + * The Amazon Resource Name (ARN) of the environment member to delete from the environment. + */ + userArn: UserArn; + } + export interface DeleteEnvironmentMembershipResult { + } + export interface DeleteEnvironmentRequest { + /** + * The ID of the environment to delete. + */ + environmentId: EnvironmentId; + } + export interface DeleteEnvironmentResult { + } + export interface DescribeEnvironmentMembershipsRequest { + /** + * The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned. + */ + userArn?: UserArn; + /** + * The ID of the environment to get environment member information about. + */ + environmentId?: EnvironmentId; + /** + * The type of environment member permissions to get information about. Available values include: owner: Owns the environment. read-only: Has read-only access to the environment. read-write: Has read-write access to the environment. If no value is specified, information about all environment members are returned. + */ + permissions?: PermissionsList; + /** + * During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. 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. + */ + nextToken?: String; + /** + * The maximum number of environment members to get information about. + */ + maxResults?: MaxResults; + } + export interface DescribeEnvironmentMembershipsResult { + /** + * Information about the environment members for the environment. + */ + memberships?: EnvironmentMembersList; + /** + * If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. + */ + nextToken?: String; + } + export interface DescribeEnvironmentStatusRequest { + /** + * The ID of the environment to get status information about. + */ + environmentId: EnvironmentId; + } + export interface DescribeEnvironmentStatusResult { + /** + * The status of the environment. Available values include: connecting: The environment is connecting. creating: The environment is being created. deleting: The environment is being deleted. error: The environment is in an error state. ready: The environment is ready. stopped: The environment is stopped. stopping: The environment is stopping. + */ + status?: EnvironmentStatus; + /** + * Any informational message about the status of the environment. + */ + message?: String; + } + export interface DescribeEnvironmentsRequest { + /** + * The IDs of individual environments to get information about. + */ + environmentIds: BoundedEnvironmentIdList; + } + export interface DescribeEnvironmentsResult { + /** + * Information about the environments that are returned. + */ + environments?: EnvironmentList; + } + export interface Environment { + /** + * The ID of the environment. + */ + id?: EnvironmentId; + /** + * The name of the environment. + */ + name?: EnvironmentName; + /** + * The description for the environment. + */ + description?: EnvironmentDescription; + /** + * The type of environment. Valid values include the following: ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. ssh: Your own server connects to the environment. + */ + type?: EnvironmentType; + /** + * The Amazon Resource Name (ARN) of the environment. + */ + arn?: String; + /** + * The Amazon Resource Name (ARN) of the environment owner. + */ + ownerArn?: String; + /** + * The state of the environment in its creation or deletion lifecycle. + */ + lifecycle?: EnvironmentLifecycle; + } + export type EnvironmentDescription = string; + export type EnvironmentId = string; + export type EnvironmentIdList = EnvironmentId[]; + export interface EnvironmentLifecycle { + /** + * The current creation or deletion lifecycle state of the environment. CREATED: The environment was successfully created. DELETE_FAILED: The environment failed to delete. DELETING: The environment is in the process of being deleted. + */ + status?: EnvironmentLifecycleStatus; + /** + * Any informational message about the lifecycle state of the environment. + */ + reason?: String; + /** + * If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource. + */ + failureResource?: String; + } + export type EnvironmentLifecycleStatus = "CREATED"|"DELETING"|"DELETE_FAILED"|string; + export type EnvironmentList = Environment[]; + export interface EnvironmentMember { + /** + * The type of environment member permissions associated with this environment member. Available values include: owner: Owns the environment. read-only: Has read-only access to the environment. read-write: Has read-write access to the environment. + */ + permissions?: Permissions; + /** + * The user ID in AWS Identity and Access Management (AWS IAM) of the environment member. + */ + userId?: String; + /** + * The Amazon Resource Name (ARN) of the environment member. + */ + userArn?: UserArn; + /** + * The ID of the environment for the environment member. + */ + environmentId?: EnvironmentId; + /** + * The time, expressed in epoch time format, when the environment member last opened the environment. + */ + lastAccess?: Timestamp; + } + export type EnvironmentMembersList = EnvironmentMember[]; + export type EnvironmentName = string; + export type EnvironmentStatus = "error"|"creating"|"connecting"|"ready"|"stopping"|"stopped"|"deleting"|string; + export type EnvironmentType = "ssh"|"ec2"|string; + export type InstanceType = string; + export interface ListEnvironmentsRequest { + /** + * During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. 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. + */ + nextToken?: String; + /** + * The maximum number of environments to get identifiers for. + */ + maxResults?: MaxResults; + } + export interface ListEnvironmentsResult { + /** + * If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. + */ + nextToken?: String; + /** + * The list of environment identifiers. + */ + environmentIds?: EnvironmentIdList; + } + export type MaxResults = number; + export type MemberPermissions = "read-write"|"read-only"|string; + export type Permissions = "owner"|"read-write"|"read-only"|string; + export type PermissionsList = Permissions[]; + export type String = string; + export type SubnetId = string; + export type Timestamp = Date; + export interface UpdateEnvironmentMembershipRequest { + /** + * The ID of the environment for the environment member whose settings you want to change. + */ + environmentId: EnvironmentId; + /** + * The Amazon Resource Name (ARN) of the environment member whose settings you want to change. + */ + userArn: UserArn; + /** + * The replacement type of environment member permissions you want to associate with this environment member. Available values include: read-only: Has read-only access to the environment. read-write: Has read-write access to the environment. + */ + permissions: MemberPermissions; + } + export interface UpdateEnvironmentMembershipResult { + /** + * Information about the environment member whose settings were changed. + */ + membership?: EnvironmentMember; + } + export interface UpdateEnvironmentRequest { + /** + * The ID of the environment to change settings. + */ + environmentId: EnvironmentId; + /** + * A replacement name for the environment. + */ + name?: EnvironmentName; + /** + * Any new or replacement description for the environment. + */ + description?: EnvironmentDescription; + } + export interface UpdateEnvironmentResult { + } + export type UserArn = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-23"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Cloud9 client. + */ + export import Types = Cloud9; +} +export = Cloud9; diff --git a/node_modules/aws-sdk/clients/cloud9.js b/node_modules/aws-sdk/clients/cloud9.js new file mode 100644 index 0000000..be607cd --- /dev/null +++ b/node_modules/aws-sdk/clients/cloud9.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloud9'] = {}; +AWS.Cloud9 = Service.defineService('cloud9', ['2017-09-23']); +Object.defineProperty(apiLoader.services['cloud9'], '2017-09-23', { + get: function get() { + var model = require('../apis/cloud9-2017-09-23.min.json'); + model.paginators = require('../apis/cloud9-2017-09-23.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Cloud9; diff --git a/node_modules/aws-sdk/clients/clouddirectory.d.ts b/node_modules/aws-sdk/clients/clouddirectory.d.ts new file mode 100644 index 0000000..14313f8 --- /dev/null +++ b/node_modules/aws-sdk/clients/clouddirectory.d.ts @@ -0,0 +1,3290 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudDirectory extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudDirectory.Types.ClientConfiguration) + config: Config & CloudDirectory.Types.ClientConfiguration; + /** + * Adds a new Facet to an object. An object can have more than one facet applied on it. + */ + addFacetToObject(params: CloudDirectory.Types.AddFacetToObjectRequest, callback?: (err: AWSError, data: CloudDirectory.Types.AddFacetToObjectResponse) => void): Request; + /** + * Adds a new Facet to an object. An object can have more than one facet applied on it. + */ + addFacetToObject(callback?: (err: AWSError, data: CloudDirectory.Types.AddFacetToObjectResponse) => void): Request; + /** + * Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema. + */ + applySchema(params: CloudDirectory.Types.ApplySchemaRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ApplySchemaResponse) => void): Request; + /** + * Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema. + */ + applySchema(callback?: (err: AWSError, data: CloudDirectory.Types.ApplySchemaResponse) => void): Request; + /** + * Attaches an existing object to another object. An object can be accessed in two ways: Using the path Using ObjectIdentifier + */ + attachObject(params: CloudDirectory.Types.AttachObjectRequest, callback?: (err: AWSError, data: CloudDirectory.Types.AttachObjectResponse) => void): Request; + /** + * Attaches an existing object to another object. An object can be accessed in two ways: Using the path Using ObjectIdentifier + */ + attachObject(callback?: (err: AWSError, data: CloudDirectory.Types.AttachObjectResponse) => void): Request; + /** + * Attaches a policy object to a regular object. An object can have a limited number of attached policies. + */ + attachPolicy(params: CloudDirectory.Types.AttachPolicyRequest, callback?: (err: AWSError, data: CloudDirectory.Types.AttachPolicyResponse) => void): Request; + /** + * Attaches a policy object to a regular object. An object can have a limited number of attached policies. + */ + attachPolicy(callback?: (err: AWSError, data: CloudDirectory.Types.AttachPolicyResponse) => void): Request; + /** + * Attaches the specified object to the specified index. + */ + attachToIndex(params: CloudDirectory.Types.AttachToIndexRequest, callback?: (err: AWSError, data: CloudDirectory.Types.AttachToIndexResponse) => void): Request; + /** + * Attaches the specified object to the specified index. + */ + attachToIndex(callback?: (err: AWSError, data: CloudDirectory.Types.AttachToIndexResponse) => void): Request; + /** + * Attaches a typed link to a specified source and target object. For more information, see Typed Links. + */ + attachTypedLink(params: CloudDirectory.Types.AttachTypedLinkRequest, callback?: (err: AWSError, data: CloudDirectory.Types.AttachTypedLinkResponse) => void): Request; + /** + * Attaches a typed link to a specified source and target object. For more information, see Typed Links. + */ + attachTypedLink(callback?: (err: AWSError, data: CloudDirectory.Types.AttachTypedLinkResponse) => void): Request; + /** + * Performs all the read operations in a batch. + */ + batchRead(params: CloudDirectory.Types.BatchReadRequest, callback?: (err: AWSError, data: CloudDirectory.Types.BatchReadResponse) => void): Request; + /** + * Performs all the read operations in a batch. + */ + batchRead(callback?: (err: AWSError, data: CloudDirectory.Types.BatchReadResponse) => void): Request; + /** + * Performs all the write operations in a batch. Either all the operations succeed or none. + */ + batchWrite(params: CloudDirectory.Types.BatchWriteRequest, callback?: (err: AWSError, data: CloudDirectory.Types.BatchWriteResponse) => void): Request; + /** + * Performs all the write operations in a batch. Either all the operations succeed or none. + */ + batchWrite(callback?: (err: AWSError, data: CloudDirectory.Types.BatchWriteResponse) => void): Request; + /** + * Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema. You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide. + */ + createDirectory(params: CloudDirectory.Types.CreateDirectoryRequest, callback?: (err: AWSError, data: CloudDirectory.Types.CreateDirectoryResponse) => void): Request; + /** + * Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema. You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide. + */ + createDirectory(callback?: (err: AWSError, data: CloudDirectory.Types.CreateDirectoryResponse) => void): Request; + /** + * Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas. + */ + createFacet(params: CloudDirectory.Types.CreateFacetRequest, callback?: (err: AWSError, data: CloudDirectory.Types.CreateFacetResponse) => void): Request; + /** + * Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas. + */ + createFacet(callback?: (err: AWSError, data: CloudDirectory.Types.CreateFacetResponse) => void): Request; + /** + * Creates an index object. See Indexing and search for more information. + */ + createIndex(params: CloudDirectory.Types.CreateIndexRequest, callback?: (err: AWSError, data: CloudDirectory.Types.CreateIndexResponse) => void): Request; + /** + * Creates an index object. See Indexing and search for more information. + */ + createIndex(callback?: (err: AWSError, data: CloudDirectory.Types.CreateIndexResponse) => void): Request; + /** + * Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. + */ + createObject(params: CloudDirectory.Types.CreateObjectRequest, callback?: (err: AWSError, data: CloudDirectory.Types.CreateObjectResponse) => void): Request; + /** + * Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. + */ + createObject(callback?: (err: AWSError, data: CloudDirectory.Types.CreateObjectResponse) => void): Request; + /** + * Creates a new schema in a development state. A schema can exist in three phases: Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published. Published: Published schemas are immutable and have a version associated with them. Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. + */ + createSchema(params: CloudDirectory.Types.CreateSchemaRequest, callback?: (err: AWSError, data: CloudDirectory.Types.CreateSchemaResponse) => void): Request; + /** + * Creates a new schema in a development state. A schema can exist in three phases: Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published. Published: Published schemas are immutable and have a version associated with them. Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. + */ + createSchema(callback?: (err: AWSError, data: CloudDirectory.Types.CreateSchemaResponse) => void): Request; + /** + * Creates a TypedLinkFacet. For more information, see Typed Links. + */ + createTypedLinkFacet(params: CloudDirectory.Types.CreateTypedLinkFacetRequest, callback?: (err: AWSError, data: CloudDirectory.Types.CreateTypedLinkFacetResponse) => void): Request; + /** + * Creates a TypedLinkFacet. For more information, see Typed Links. + */ + createTypedLinkFacet(callback?: (err: AWSError, data: CloudDirectory.Types.CreateTypedLinkFacetResponse) => void): Request; + /** + * Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories. + */ + deleteDirectory(params: CloudDirectory.Types.DeleteDirectoryRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DeleteDirectoryResponse) => void): Request; + /** + * Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories. + */ + deleteDirectory(callback?: (err: AWSError, data: CloudDirectory.Types.DeleteDirectoryResponse) => void): Request; + /** + * Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion. + */ + deleteFacet(params: CloudDirectory.Types.DeleteFacetRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DeleteFacetResponse) => void): Request; + /** + * Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion. + */ + deleteFacet(callback?: (err: AWSError, data: CloudDirectory.Types.DeleteFacetResponse) => void): Request; + /** + * Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits. + */ + deleteObject(params: CloudDirectory.Types.DeleteObjectRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DeleteObjectResponse) => void): Request; + /** + * Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits. + */ + deleteObject(callback?: (err: AWSError, data: CloudDirectory.Types.DeleteObjectResponse) => void): Request; + /** + * Deletes a given schema. Schemas in a development and published state can only be deleted. + */ + deleteSchema(params: CloudDirectory.Types.DeleteSchemaRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DeleteSchemaResponse) => void): Request; + /** + * Deletes a given schema. Schemas in a development and published state can only be deleted. + */ + deleteSchema(callback?: (err: AWSError, data: CloudDirectory.Types.DeleteSchemaResponse) => void): Request; + /** + * Deletes a TypedLinkFacet. For more information, see Typed Links. + */ + deleteTypedLinkFacet(params: CloudDirectory.Types.DeleteTypedLinkFacetRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DeleteTypedLinkFacetResponse) => void): Request; + /** + * Deletes a TypedLinkFacet. For more information, see Typed Links. + */ + deleteTypedLinkFacet(callback?: (err: AWSError, data: CloudDirectory.Types.DeleteTypedLinkFacetResponse) => void): Request; + /** + * Detaches the specified object from the specified index. + */ + detachFromIndex(params: CloudDirectory.Types.DetachFromIndexRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DetachFromIndexResponse) => void): Request; + /** + * Detaches the specified object from the specified index. + */ + detachFromIndex(callback?: (err: AWSError, data: CloudDirectory.Types.DetachFromIndexResponse) => void): Request; + /** + * Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name. + */ + detachObject(params: CloudDirectory.Types.DetachObjectRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DetachObjectResponse) => void): Request; + /** + * Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name. + */ + detachObject(callback?: (err: AWSError, data: CloudDirectory.Types.DetachObjectResponse) => void): Request; + /** + * Detaches a policy from an object. + */ + detachPolicy(params: CloudDirectory.Types.DetachPolicyRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DetachPolicyResponse) => void): Request; + /** + * Detaches a policy from an object. + */ + detachPolicy(callback?: (err: AWSError, data: CloudDirectory.Types.DetachPolicyResponse) => void): Request; + /** + * Detaches a typed link from a specified source and target object. For more information, see Typed Links. + */ + detachTypedLink(params: CloudDirectory.Types.DetachTypedLinkRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a typed link from a specified source and target object. For more information, see Typed Links. + */ + detachTypedLink(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled. + */ + disableDirectory(params: CloudDirectory.Types.DisableDirectoryRequest, callback?: (err: AWSError, data: CloudDirectory.Types.DisableDirectoryResponse) => void): Request; + /** + * Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled. + */ + disableDirectory(callback?: (err: AWSError, data: CloudDirectory.Types.DisableDirectoryResponse) => void): Request; + /** + * Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to. + */ + enableDirectory(params: CloudDirectory.Types.EnableDirectoryRequest, callback?: (err: AWSError, data: CloudDirectory.Types.EnableDirectoryResponse) => void): Request; + /** + * Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to. + */ + enableDirectory(callback?: (err: AWSError, data: CloudDirectory.Types.EnableDirectoryResponse) => void): Request; + /** + * Returns current applied schema version ARN, including the minor version in use. + */ + getAppliedSchemaVersion(params: CloudDirectory.Types.GetAppliedSchemaVersionRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetAppliedSchemaVersionResponse) => void): Request; + /** + * Returns current applied schema version ARN, including the minor version in use. + */ + getAppliedSchemaVersion(callback?: (err: AWSError, data: CloudDirectory.Types.GetAppliedSchemaVersionResponse) => void): Request; + /** + * Retrieves metadata about a directory. + */ + getDirectory(params: CloudDirectory.Types.GetDirectoryRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetDirectoryResponse) => void): Request; + /** + * Retrieves metadata about a directory. + */ + getDirectory(callback?: (err: AWSError, data: CloudDirectory.Types.GetDirectoryResponse) => void): Request; + /** + * Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied. + */ + getFacet(params: CloudDirectory.Types.GetFacetRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetFacetResponse) => void): Request; + /** + * Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied. + */ + getFacet(callback?: (err: AWSError, data: CloudDirectory.Types.GetFacetResponse) => void): Request; + /** + * Retrieves attributes that are associated with a typed link. + */ + getLinkAttributes(params: CloudDirectory.Types.GetLinkAttributesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetLinkAttributesResponse) => void): Request; + /** + * Retrieves attributes that are associated with a typed link. + */ + getLinkAttributes(callback?: (err: AWSError, data: CloudDirectory.Types.GetLinkAttributesResponse) => void): Request; + /** + * Retrieves attributes within a facet that are associated with an object. + */ + getObjectAttributes(params: CloudDirectory.Types.GetObjectAttributesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetObjectAttributesResponse) => void): Request; + /** + * Retrieves attributes within a facet that are associated with an object. + */ + getObjectAttributes(callback?: (err: AWSError, data: CloudDirectory.Types.GetObjectAttributesResponse) => void): Request; + /** + * Retrieves metadata about an object. + */ + getObjectInformation(params: CloudDirectory.Types.GetObjectInformationRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetObjectInformationResponse) => void): Request; + /** + * Retrieves metadata about an object. + */ + getObjectInformation(callback?: (err: AWSError, data: CloudDirectory.Types.GetObjectInformationResponse) => void): Request; + /** + * Retrieves a JSON representation of the schema. See JSON Schema Format for more information. + */ + getSchemaAsJson(params: CloudDirectory.Types.GetSchemaAsJsonRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetSchemaAsJsonResponse) => void): Request; + /** + * Retrieves a JSON representation of the schema. See JSON Schema Format for more information. + */ + getSchemaAsJson(callback?: (err: AWSError, data: CloudDirectory.Types.GetSchemaAsJsonResponse) => void): Request; + /** + * Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links. + */ + getTypedLinkFacetInformation(params: CloudDirectory.Types.GetTypedLinkFacetInformationRequest, callback?: (err: AWSError, data: CloudDirectory.Types.GetTypedLinkFacetInformationResponse) => void): Request; + /** + * Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links. + */ + getTypedLinkFacetInformation(callback?: (err: AWSError, data: CloudDirectory.Types.GetTypedLinkFacetInformationResponse) => void): Request; + /** + * Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version. + */ + listAppliedSchemaArns(params: CloudDirectory.Types.ListAppliedSchemaArnsRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListAppliedSchemaArnsResponse) => void): Request; + /** + * Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version. + */ + listAppliedSchemaArns(callback?: (err: AWSError, data: CloudDirectory.Types.ListAppliedSchemaArnsResponse) => void): Request; + /** + * Lists indices attached to the specified object. + */ + listAttachedIndices(params: CloudDirectory.Types.ListAttachedIndicesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListAttachedIndicesResponse) => void): Request; + /** + * Lists indices attached to the specified object. + */ + listAttachedIndices(callback?: (err: AWSError, data: CloudDirectory.Types.ListAttachedIndicesResponse) => void): Request; + /** + * Retrieves each Amazon Resource Name (ARN) of schemas in the development state. + */ + listDevelopmentSchemaArns(params: CloudDirectory.Types.ListDevelopmentSchemaArnsRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListDevelopmentSchemaArnsResponse) => void): Request; + /** + * Retrieves each Amazon Resource Name (ARN) of schemas in the development state. + */ + listDevelopmentSchemaArns(callback?: (err: AWSError, data: CloudDirectory.Types.ListDevelopmentSchemaArnsResponse) => void): Request; + /** + * Lists directories created within an account. + */ + listDirectories(params: CloudDirectory.Types.ListDirectoriesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListDirectoriesResponse) => void): Request; + /** + * Lists directories created within an account. + */ + listDirectories(callback?: (err: AWSError, data: CloudDirectory.Types.ListDirectoriesResponse) => void): Request; + /** + * Retrieves attributes attached to the facet. + */ + listFacetAttributes(params: CloudDirectory.Types.ListFacetAttributesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListFacetAttributesResponse) => void): Request; + /** + * Retrieves attributes attached to the facet. + */ + listFacetAttributes(callback?: (err: AWSError, data: CloudDirectory.Types.ListFacetAttributesResponse) => void): Request; + /** + * Retrieves the names of facets that exist in a schema. + */ + listFacetNames(params: CloudDirectory.Types.ListFacetNamesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListFacetNamesResponse) => void): Request; + /** + * Retrieves the names of facets that exist in a schema. + */ + listFacetNames(callback?: (err: AWSError, data: CloudDirectory.Types.ListFacetNamesResponse) => void): Request; + /** + * Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + listIncomingTypedLinks(params: CloudDirectory.Types.ListIncomingTypedLinksRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListIncomingTypedLinksResponse) => void): Request; + /** + * Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + listIncomingTypedLinks(callback?: (err: AWSError, data: CloudDirectory.Types.ListIncomingTypedLinksResponse) => void): Request; + /** + * Lists objects attached to the specified index. + */ + listIndex(params: CloudDirectory.Types.ListIndexRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListIndexResponse) => void): Request; + /** + * Lists objects attached to the specified index. + */ + listIndex(callback?: (err: AWSError, data: CloudDirectory.Types.ListIndexResponse) => void): Request; + /** + * Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead. + */ + listManagedSchemaArns(params: CloudDirectory.Types.ListManagedSchemaArnsRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListManagedSchemaArnsResponse) => void): Request; + /** + * Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead. + */ + listManagedSchemaArns(callback?: (err: AWSError, data: CloudDirectory.Types.ListManagedSchemaArnsResponse) => void): Request; + /** + * Lists all attributes that are associated with an object. + */ + listObjectAttributes(params: CloudDirectory.Types.ListObjectAttributesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectAttributesResponse) => void): Request; + /** + * Lists all attributes that are associated with an object. + */ + listObjectAttributes(callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectAttributesResponse) => void): Request; + /** + * Returns a paginated list of child objects that are associated with a given object. + */ + listObjectChildren(params: CloudDirectory.Types.ListObjectChildrenRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectChildrenResponse) => void): Request; + /** + * Returns a paginated list of child objects that are associated with a given object. + */ + listObjectChildren(callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectChildrenResponse) => void): Request; + /** + * 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 Directory Structure. 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 MaxResults, 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. + */ + listObjectParentPaths(params: CloudDirectory.Types.ListObjectParentPathsRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectParentPathsResponse) => void): Request; + /** + * 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 Directory Structure. 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 MaxResults, 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. + */ + listObjectParentPaths(callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectParentPathsResponse) => void): Request; + /** + * Lists parent objects that are associated with a given object in pagination fashion. + */ + listObjectParents(params: CloudDirectory.Types.ListObjectParentsRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectParentsResponse) => void): Request; + /** + * Lists parent objects that are associated with a given object in pagination fashion. + */ + listObjectParents(callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectParentsResponse) => void): Request; + /** + * Returns policies attached to an object in pagination fashion. + */ + listObjectPolicies(params: CloudDirectory.Types.ListObjectPoliciesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectPoliciesResponse) => void): Request; + /** + * Returns policies attached to an object in pagination fashion. + */ + listObjectPolicies(callback?: (err: AWSError, data: CloudDirectory.Types.ListObjectPoliciesResponse) => void): Request; + /** + * Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + listOutgoingTypedLinks(params: CloudDirectory.Types.ListOutgoingTypedLinksRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListOutgoingTypedLinksResponse) => void): Request; + /** + * Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + listOutgoingTypedLinks(callback?: (err: AWSError, data: CloudDirectory.Types.ListOutgoingTypedLinksResponse) => void): Request; + /** + * Returns all of the ObjectIdentifiers to which a given policy is attached. + */ + listPolicyAttachments(params: CloudDirectory.Types.ListPolicyAttachmentsRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListPolicyAttachmentsResponse) => void): Request; + /** + * Returns all of the ObjectIdentifiers to which a given policy is attached. + */ + listPolicyAttachments(callback?: (err: AWSError, data: CloudDirectory.Types.ListPolicyAttachmentsResponse) => void): Request; + /** + * Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead. + */ + listPublishedSchemaArns(params: CloudDirectory.Types.ListPublishedSchemaArnsRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListPublishedSchemaArnsResponse) => void): Request; + /** + * Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead. + */ + listPublishedSchemaArns(callback?: (err: AWSError, data: CloudDirectory.Types.ListPublishedSchemaArnsResponse) => void): Request; + /** + * 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. + */ + listTagsForResource(params: CloudDirectory.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListTagsForResourceResponse) => void): Request; + /** + * 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. + */ + listTagsForResource(callback?: (err: AWSError, data: CloudDirectory.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links. + */ + listTypedLinkFacetAttributes(params: CloudDirectory.Types.ListTypedLinkFacetAttributesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListTypedLinkFacetAttributesResponse) => void): Request; + /** + * Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links. + */ + listTypedLinkFacetAttributes(callback?: (err: AWSError, data: CloudDirectory.Types.ListTypedLinkFacetAttributesResponse) => void): Request; + /** + * Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links. + */ + listTypedLinkFacetNames(params: CloudDirectory.Types.ListTypedLinkFacetNamesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.ListTypedLinkFacetNamesResponse) => void): Request; + /** + * Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links. + */ + listTypedLinkFacetNames(callback?: (err: AWSError, data: CloudDirectory.Types.ListTypedLinkFacetNamesResponse) => void): Request; + /** + * Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies. + */ + lookupPolicy(params: CloudDirectory.Types.LookupPolicyRequest, callback?: (err: AWSError, data: CloudDirectory.Types.LookupPolicyResponse) => void): Request; + /** + * Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies. + */ + lookupPolicy(callback?: (err: AWSError, data: CloudDirectory.Types.LookupPolicyResponse) => void): Request; + /** + * Publishes a development schema with a major version and a recommended minor version. + */ + publishSchema(params: CloudDirectory.Types.PublishSchemaRequest, callback?: (err: AWSError, data: CloudDirectory.Types.PublishSchemaResponse) => void): Request; + /** + * Publishes a development schema with a major version and a recommended minor version. + */ + publishSchema(callback?: (err: AWSError, data: CloudDirectory.Types.PublishSchemaResponse) => void): Request; + /** + * Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information. + */ + putSchemaFromJson(params: CloudDirectory.Types.PutSchemaFromJsonRequest, callback?: (err: AWSError, data: CloudDirectory.Types.PutSchemaFromJsonResponse) => void): Request; + /** + * Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information. + */ + putSchemaFromJson(callback?: (err: AWSError, data: CloudDirectory.Types.PutSchemaFromJsonResponse) => void): Request; + /** + * Removes the specified facet from the specified object. + */ + removeFacetFromObject(params: CloudDirectory.Types.RemoveFacetFromObjectRequest, callback?: (err: AWSError, data: CloudDirectory.Types.RemoveFacetFromObjectResponse) => void): Request; + /** + * Removes the specified facet from the specified object. + */ + removeFacetFromObject(callback?: (err: AWSError, data: CloudDirectory.Types.RemoveFacetFromObjectResponse) => void): Request; + /** + * An API operation for adding tags to a resource. + */ + tagResource(params: CloudDirectory.Types.TagResourceRequest, callback?: (err: AWSError, data: CloudDirectory.Types.TagResourceResponse) => void): Request; + /** + * An API operation for adding tags to a resource. + */ + tagResource(callback?: (err: AWSError, data: CloudDirectory.Types.TagResourceResponse) => void): Request; + /** + * An API operation for removing tags from a resource. + */ + untagResource(params: CloudDirectory.Types.UntagResourceRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UntagResourceResponse) => void): Request; + /** + * An API operation for removing tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: CloudDirectory.Types.UntagResourceResponse) => void): Request; + /** + * Does the following: Adds new Attributes, Rules, or ObjectTypes. Updates existing Attributes, Rules, or ObjectTypes. Deletes existing Attributes, Rules, or ObjectTypes. + */ + updateFacet(params: CloudDirectory.Types.UpdateFacetRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UpdateFacetResponse) => void): Request; + /** + * Does the following: Adds new Attributes, Rules, or ObjectTypes. Updates existing Attributes, Rules, or ObjectTypes. Deletes existing Attributes, Rules, or ObjectTypes. + */ + updateFacet(callback?: (err: AWSError, data: CloudDirectory.Types.UpdateFacetResponse) => void): Request; + /** + * Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. + */ + updateLinkAttributes(params: CloudDirectory.Types.UpdateLinkAttributesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UpdateLinkAttributesResponse) => void): Request; + /** + * Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. + */ + updateLinkAttributes(callback?: (err: AWSError, data: CloudDirectory.Types.UpdateLinkAttributesResponse) => void): Request; + /** + * Updates a given object's attributes. + */ + updateObjectAttributes(params: CloudDirectory.Types.UpdateObjectAttributesRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UpdateObjectAttributesResponse) => void): Request; + /** + * Updates a given object's attributes. + */ + updateObjectAttributes(callback?: (err: AWSError, data: CloudDirectory.Types.UpdateObjectAttributesResponse) => void): Request; + /** + * Updates the schema name with a new name. Only development schema names can be updated. + */ + updateSchema(params: CloudDirectory.Types.UpdateSchemaRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UpdateSchemaResponse) => void): Request; + /** + * Updates the schema name with a new name. Only development schema names can be updated. + */ + updateSchema(callback?: (err: AWSError, data: CloudDirectory.Types.UpdateSchemaResponse) => void): Request; + /** + * Updates a TypedLinkFacet. For more information, see Typed Links. + */ + updateTypedLinkFacet(params: CloudDirectory.Types.UpdateTypedLinkFacetRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UpdateTypedLinkFacetResponse) => void): Request; + /** + * Updates a TypedLinkFacet. For more information, see Typed Links. + */ + updateTypedLinkFacet(callback?: (err: AWSError, data: CloudDirectory.Types.UpdateTypedLinkFacetResponse) => void): Request; + /** + * Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory. + */ + upgradeAppliedSchema(params: CloudDirectory.Types.UpgradeAppliedSchemaRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UpgradeAppliedSchemaResponse) => void): Request; + /** + * Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory. + */ + upgradeAppliedSchema(callback?: (err: AWSError, data: CloudDirectory.Types.UpgradeAppliedSchemaResponse) => void): Request; + /** + * Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn. + */ + upgradePublishedSchema(params: CloudDirectory.Types.UpgradePublishedSchemaRequest, callback?: (err: AWSError, data: CloudDirectory.Types.UpgradePublishedSchemaResponse) => void): Request; + /** + * Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn. + */ + upgradePublishedSchema(callback?: (err: AWSError, data: CloudDirectory.Types.UpgradePublishedSchemaResponse) => void): Request; +} +declare namespace CloudDirectory { + export interface AddFacetToObjectRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * Identifiers for the facet that you are adding to the object. See SchemaFacet for details. + */ + SchemaFacet: SchemaFacet; + /** + * Attributes on the facet that you are adding to the object. + */ + ObjectAttributeList?: AttributeKeyAndValueList; + /** + * A reference to the object you are adding the specified facet to. + */ + ObjectReference: ObjectReference; + } + export interface AddFacetToObjectResponse { + } + export interface ApplySchemaRequest { + /** + * Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns. + */ + PublishedSchemaArn: Arn; + /** + * The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns. + */ + DirectoryArn: Arn; + } + export interface ApplySchemaResponse { + /** + * The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns. + */ + AppliedSchemaArn?: Arn; + /** + * The ARN that is associated with the Directory. For more information, see arns. + */ + DirectoryArn?: Arn; + } + export type Arn = string; + export type Arns = Arn[]; + export interface AttachObjectRequest { + /** + * Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The parent object reference. + */ + ParentReference: ObjectReference; + /** + * The child object reference to be attached to the object. + */ + ChildReference: ObjectReference; + /** + * The link name with which the child object is attached to the parent. + */ + LinkName: LinkName; + } + export interface AttachObjectResponse { + /** + * The attached ObjectIdentifier, which is the child ObjectIdentifier. + */ + AttachedObjectIdentifier?: ObjectIdentifier; + } + export interface AttachPolicyRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The reference that is associated with the policy object. + */ + PolicyReference: ObjectReference; + /** + * The reference that identifies the object to which the policy will be attached. + */ + ObjectReference: ObjectReference; + } + export interface AttachPolicyResponse { + } + export interface AttachToIndexRequest { + /** + * The Amazon Resource Name (ARN) of the directory where the object and index exist. + */ + DirectoryArn: Arn; + /** + * A reference to the index that you are attaching the object to. + */ + IndexReference: ObjectReference; + /** + * A reference to the object that you are attaching to the index. + */ + TargetReference: ObjectReference; + } + export interface AttachToIndexResponse { + /** + * The ObjectIdentifier of the object that was attached to the index. + */ + AttachedObjectIdentifier?: ObjectIdentifier; + } + export interface AttachTypedLinkRequest { + /** + * The Amazon Resource Name (ARN) of the directory where you want to attach the typed link. + */ + DirectoryArn: Arn; + /** + * Identifies the source object that the typed link will attach to. + */ + SourceObjectReference: ObjectReference; + /** + * Identifies the target object that the typed link will attach to. + */ + TargetObjectReference: ObjectReference; + /** + * Identifies the typed link facet that is associated with the typed link. + */ + TypedLinkFacet: TypedLinkSchemaAndFacetName; + /** + * A set of attributes that are associated with the typed link. + */ + Attributes: AttributeNameAndValueList; + } + export interface AttachTypedLinkResponse { + /** + * Returns a typed link specifier as output. + */ + TypedLinkSpecifier?: TypedLinkSpecifier; + } + export interface AttributeKey { + /** + * The Amazon Resource Name (ARN) of the schema that contains the facet and attribute. + */ + SchemaArn: Arn; + /** + * The name of the facet that the attribute exists within. + */ + FacetName: FacetName; + /** + * The name of the attribute. + */ + Name: AttributeName; + } + export interface AttributeKeyAndValue { + /** + * The key of the attribute. + */ + Key: AttributeKey; + /** + * The value of the attribute. + */ + Value: TypedAttributeValue; + } + export type AttributeKeyAndValueList = AttributeKeyAndValue[]; + export type AttributeKeyList = AttributeKey[]; + export type AttributeName = string; + export interface AttributeNameAndValue { + /** + * The attribute name of the typed link. + */ + AttributeName: AttributeName; + /** + * The value for the typed link. + */ + Value: TypedAttributeValue; + } + export type AttributeNameAndValueList = AttributeNameAndValue[]; + export type AttributeNameList = AttributeName[]; + export interface BatchAddFacetToObject { + /** + * Represents the facet being added to the object. + */ + SchemaFacet: SchemaFacet; + /** + * The attributes to set on the object. + */ + ObjectAttributeList: AttributeKeyAndValueList; + /** + * A reference to the object being mutated. + */ + ObjectReference: ObjectReference; + } + export interface BatchAddFacetToObjectResponse { + } + export interface BatchAttachObject { + /** + * The parent object reference. + */ + ParentReference: ObjectReference; + /** + * The child object reference that is to be attached to the object. + */ + ChildReference: ObjectReference; + /** + * The name of the link. + */ + LinkName: LinkName; + } + export interface BatchAttachObjectResponse { + /** + * The ObjectIdentifier of the object that has been attached. + */ + attachedObjectIdentifier?: ObjectIdentifier; + } + export interface BatchAttachPolicy { + /** + * The reference that is associated with the policy object. + */ + PolicyReference: ObjectReference; + /** + * The reference that identifies the object to which the policy will be attached. + */ + ObjectReference: ObjectReference; + } + export interface BatchAttachPolicyResponse { + } + export interface BatchAttachToIndex { + /** + * A reference to the index that you are attaching the object to. + */ + IndexReference: ObjectReference; + /** + * A reference to the object that you are attaching to the index. + */ + TargetReference: ObjectReference; + } + export interface BatchAttachToIndexResponse { + /** + * The ObjectIdentifier of the object that was attached to the index. + */ + AttachedObjectIdentifier?: ObjectIdentifier; + } + export interface BatchAttachTypedLink { + /** + * Identifies the source object that the typed link will attach to. + */ + SourceObjectReference: ObjectReference; + /** + * Identifies the target object that the typed link will attach to. + */ + TargetObjectReference: ObjectReference; + /** + * Identifies the typed link facet that is associated with the typed link. + */ + TypedLinkFacet: TypedLinkSchemaAndFacetName; + /** + * A set of attributes that are associated with the typed link. + */ + Attributes: AttributeNameAndValueList; + } + export interface BatchAttachTypedLinkResponse { + /** + * Returns a typed link specifier as output. + */ + TypedLinkSpecifier?: TypedLinkSpecifier; + } + export interface BatchCreateIndex { + /** + * Specifies the attributes that should be indexed on. Currently only a single attribute is supported. + */ + OrderedIndexedAttributeList: AttributeKeyList; + /** + * Indicates whether the attribute that is being indexed has unique values or not. + */ + IsUnique: Bool; + /** + * A reference to the parent object that contains the index object. + */ + ParentReference?: ObjectReference; + /** + * The name of the link between the parent object and the index object. + */ + LinkName?: LinkName; + /** + * The batch reference name. See Transaction Support for more information. + */ + BatchReferenceName?: BatchReferenceName; + } + export interface BatchCreateIndexResponse { + /** + * The ObjectIdentifier of the index created by this operation. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface BatchCreateObject { + /** + * A list of FacetArns that will be associated with the object. For more information, see arns. + */ + SchemaFacet: SchemaFacetList; + /** + * An attribute map, which contains an attribute ARN as the key and attribute value as the map value. + */ + ObjectAttributeList: AttributeKeyAndValueList; + /** + * If specified, the parent reference to which this object will be attached. + */ + ParentReference?: ObjectReference; + /** + * The name of the link. + */ + LinkName?: LinkName; + /** + * The batch reference name. See Transaction Support for more information. + */ + BatchReferenceName?: BatchReferenceName; + } + export interface BatchCreateObjectResponse { + /** + * The ID that is associated with the object. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface BatchDeleteObject { + /** + * The reference that identifies the object. + */ + ObjectReference: ObjectReference; + } + export interface BatchDeleteObjectResponse { + } + export interface BatchDetachFromIndex { + /** + * A reference to the index object. + */ + IndexReference: ObjectReference; + /** + * A reference to the object being detached from the index. + */ + TargetReference: ObjectReference; + } + export interface BatchDetachFromIndexResponse { + /** + * The ObjectIdentifier of the object that was detached from the index. + */ + DetachedObjectIdentifier?: ObjectIdentifier; + } + export interface BatchDetachObject { + /** + * Parent reference from which the object with the specified link name is detached. + */ + ParentReference: ObjectReference; + /** + * The name of the link. + */ + LinkName: LinkName; + /** + * The batch reference name. See Transaction Support for more information. + */ + BatchReferenceName?: BatchReferenceName; + } + export interface BatchDetachObjectResponse { + /** + * The ObjectIdentifier of the detached object. + */ + detachedObjectIdentifier?: ObjectIdentifier; + } + export interface BatchDetachPolicy { + /** + * Reference that identifies the policy object. + */ + PolicyReference: ObjectReference; + /** + * Reference that identifies the object whose policy object will be detached. + */ + ObjectReference: ObjectReference; + } + export interface BatchDetachPolicyResponse { + } + export interface BatchDetachTypedLink { + /** + * Used to accept a typed link specifier as input. + */ + TypedLinkSpecifier: TypedLinkSpecifier; + } + export interface BatchDetachTypedLinkResponse { + } + export interface BatchGetLinkAttributes { + /** + * Allows a typed link specifier to be accepted as input. + */ + TypedLinkSpecifier: TypedLinkSpecifier; + /** + * A list of attribute names whose values will be retrieved. + */ + AttributeNames: AttributeNameList; + } + export interface BatchGetLinkAttributesResponse { + /** + * The attributes that are associated with the typed link. + */ + Attributes?: AttributeKeyAndValueList; + } + export interface BatchGetObjectAttributes { + /** + * Reference that identifies the object whose attributes will be retrieved. + */ + ObjectReference: ObjectReference; + /** + * Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details. + */ + SchemaFacet: SchemaFacet; + /** + * List of attribute names whose values will be retrieved. + */ + AttributeNames: AttributeNameList; + } + export interface BatchGetObjectAttributesResponse { + /** + * The attribute values that are associated with an object. + */ + Attributes?: AttributeKeyAndValueList; + } + export interface BatchGetObjectInformation { + /** + * A reference to the object. + */ + ObjectReference: ObjectReference; + } + export interface BatchGetObjectInformationResponse { + /** + * The facets attached to the specified object. + */ + SchemaFacets?: SchemaFacetList; + /** + * The ObjectIdentifier of the specified object. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface BatchListAttachedIndices { + /** + * A reference to the object that has indices attached. + */ + TargetReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface BatchListAttachedIndicesResponse { + /** + * The indices attached to the specified object. + */ + IndexAttachments?: IndexAttachmentList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListIncomingTypedLinks { + /** + * The reference that identifies the object whose attributes will be listed. + */ + ObjectReference: ObjectReference; + /** + * Provides range filters for multiple attributes. 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. + */ + FilterAttributeRanges?: TypedLinkAttributeRangeList; + /** + * 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. + */ + FilterTypedLink?: TypedLinkSchemaAndFacetName; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface BatchListIncomingTypedLinksResponse { + /** + * Returns one or more typed link specifiers as output. + */ + LinkSpecifiers?: TypedLinkSpecifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListIndex { + /** + * Specifies the ranges of indexed values that you want to query. + */ + RangesOnIndexedValues?: ObjectAttributeRangeList; + /** + * The reference to the index to list. + */ + IndexReference: ObjectReference; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListIndexResponse { + /** + * The objects and indexed values attached to the index. + */ + IndexAttachments?: IndexAttachmentList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListObjectAttributes { + /** + * Reference of the object whose attributes need to be listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + /** + * Used to filter the list of object attributes that are associated with a certain facet. + */ + FacetFilter?: SchemaFacet; + } + export interface BatchListObjectAttributesResponse { + /** + * The attributes map that is associated with the object. AttributeArn is the key; attribute value is the value. + */ + Attributes?: AttributeKeyAndValueList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListObjectChildren { + /** + * Reference of the object for which child objects are being listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * Maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + } + export interface BatchListObjectChildrenResponse { + /** + * The children structure, which is a map with the key as the LinkName and ObjectIdentifier as the value. + */ + Children?: LinkNameToObjectIdentifierMap; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListObjectParentPaths { + /** + * The reference that identifies the object whose attributes will be listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface BatchListObjectParentPathsResponse { + /** + * Returns the path to the ObjectIdentifiers that are associated with the directory. + */ + PathToObjectIdentifiersList?: PathToObjectIdentifiersList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListObjectParents { + ObjectReference: ObjectReference; + NextToken?: NextToken; + MaxResults?: NumberResults; + } + export interface BatchListObjectParentsResponse { + ParentLinks?: ObjectIdentifierAndLinkNameList; + NextToken?: NextToken; + } + export interface BatchListObjectPolicies { + /** + * The reference that identifies the object whose attributes will be listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface BatchListObjectPoliciesResponse { + /** + * A list of policy ObjectIdentifiers, that are attached to the object. + */ + AttachedPolicyIds?: ObjectIdentifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListOutgoingTypedLinks { + /** + * The reference that identifies the object whose attributes will be listed. + */ + ObjectReference: ObjectReference; + /** + * Provides range filters for multiple attributes. 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. + */ + FilterAttributeRanges?: TypedLinkAttributeRangeList; + /** + * Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls. + */ + FilterTypedLink?: TypedLinkSchemaAndFacetName; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface BatchListOutgoingTypedLinksResponse { + /** + * Returns a typed link specifier as output. + */ + TypedLinkSpecifiers?: TypedLinkSpecifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchListPolicyAttachments { + /** + * The reference that identifies the policy object. + */ + PolicyReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface BatchListPolicyAttachmentsResponse { + /** + * A list of ObjectIdentifiers to which the policy is attached. + */ + ObjectIdentifiers?: ObjectIdentifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchLookupPolicy { + /** + * Reference that identifies the object whose policies will be looked up. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface BatchLookupPolicyResponse { + /** + * Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies. + */ + PolicyToPathList?: PolicyToPathList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface BatchReadException { + /** + * A type of exception, such as InvalidArnException. + */ + Type?: BatchReadExceptionType; + /** + * An exception message that is associated with the failure. + */ + Message?: ExceptionMessage; + } + export type BatchReadExceptionType = "ValidationException"|"InvalidArnException"|"ResourceNotFoundException"|"InvalidNextTokenException"|"AccessDeniedException"|"NotNodeException"|"FacetValidationException"|"CannotListParentOfRootException"|"NotIndexException"|"NotPolicyException"|"DirectoryNotEnabledException"|"LimitExceededException"|"InternalServiceException"|string; + export interface BatchReadOperation { + /** + * Lists all attributes that are associated with an object. + */ + ListObjectAttributes?: BatchListObjectAttributes; + /** + * Returns a paginated list of child objects that are associated with a given object. + */ + ListObjectChildren?: BatchListObjectChildren; + /** + * Lists indices attached to an object. + */ + ListAttachedIndices?: BatchListAttachedIndices; + /** + * 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 Directory Structure. + */ + ListObjectParentPaths?: BatchListObjectParentPaths; + /** + * Retrieves metadata about an object. + */ + GetObjectInformation?: BatchGetObjectInformation; + /** + * Retrieves attributes within a facet that are associated with an object. + */ + GetObjectAttributes?: BatchGetObjectAttributes; + ListObjectParents?: BatchListObjectParents; + /** + * Returns policies attached to an object in pagination fashion. + */ + ListObjectPolicies?: BatchListObjectPolicies; + /** + * Returns all of the ObjectIdentifiers to which a given policy is attached. + */ + ListPolicyAttachments?: BatchListPolicyAttachments; + /** + * Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies. + */ + LookupPolicy?: BatchLookupPolicy; + /** + * Lists objects attached to the specified index. + */ + ListIndex?: BatchListIndex; + /** + * Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + ListOutgoingTypedLinks?: BatchListOutgoingTypedLinks; + /** + * Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + ListIncomingTypedLinks?: BatchListIncomingTypedLinks; + /** + * Retrieves attributes that are associated with a typed link. + */ + GetLinkAttributes?: BatchGetLinkAttributes; + } + export type BatchReadOperationList = BatchReadOperation[]; + export interface BatchReadOperationResponse { + /** + * Identifies which operation in a batch has succeeded. + */ + SuccessfulResponse?: BatchReadSuccessfulResponse; + /** + * Identifies which operation in a batch has failed. + */ + ExceptionResponse?: BatchReadException; + } + export type BatchReadOperationResponseList = BatchReadOperationResponse[]; + export interface BatchReadRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * A list of operations that are part of the batch. + */ + Operations: BatchReadOperationList; + /** + * 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. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface BatchReadResponse { + /** + * A list of all the responses for each batch read. + */ + Responses?: BatchReadOperationResponseList; + } + export interface BatchReadSuccessfulResponse { + /** + * Lists all attributes that are associated with an object. + */ + ListObjectAttributes?: BatchListObjectAttributesResponse; + /** + * Returns a paginated list of child objects that are associated with a given object. + */ + ListObjectChildren?: BatchListObjectChildrenResponse; + /** + * Retrieves metadata about an object. + */ + GetObjectInformation?: BatchGetObjectInformationResponse; + /** + * Retrieves attributes within a facet that are associated with an object. + */ + GetObjectAttributes?: BatchGetObjectAttributesResponse; + /** + * Lists indices attached to an object. + */ + ListAttachedIndices?: BatchListAttachedIndicesResponse; + /** + * 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 Directory Structure. + */ + ListObjectParentPaths?: BatchListObjectParentPathsResponse; + /** + * Returns policies attached to an object in pagination fashion. + */ + ListObjectPolicies?: BatchListObjectPoliciesResponse; + /** + * Returns all of the ObjectIdentifiers to which a given policy is attached. + */ + ListPolicyAttachments?: BatchListPolicyAttachmentsResponse; + /** + * Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies. + */ + LookupPolicy?: BatchLookupPolicyResponse; + /** + * Lists objects attached to the specified index. + */ + ListIndex?: BatchListIndexResponse; + /** + * Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + ListOutgoingTypedLinks?: BatchListOutgoingTypedLinksResponse; + /** + * Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. + */ + ListIncomingTypedLinks?: BatchListIncomingTypedLinksResponse; + /** + * The list of attributes to retrieve from the typed link. + */ + GetLinkAttributes?: BatchGetLinkAttributesResponse; + ListObjectParents?: BatchListObjectParentsResponse; + } + export type BatchReferenceName = string; + export interface BatchRemoveFacetFromObject { + /** + * The facet to remove from the object. + */ + SchemaFacet: SchemaFacet; + /** + * A reference to the object whose facet will be removed. + */ + ObjectReference: ObjectReference; + } + export interface BatchRemoveFacetFromObjectResponse { + } + export interface BatchUpdateLinkAttributes { + /** + * Allows a typed link specifier to be accepted as input. + */ + TypedLinkSpecifier: TypedLinkSpecifier; + /** + * The attributes update structure. + */ + AttributeUpdates: LinkAttributeUpdateList; + } + export interface BatchUpdateLinkAttributesResponse { + } + export interface BatchUpdateObjectAttributes { + /** + * Reference that identifies the object. + */ + ObjectReference: ObjectReference; + /** + * Attributes update structure. + */ + AttributeUpdates: ObjectAttributeUpdateList; + } + export interface BatchUpdateObjectAttributesResponse { + /** + * ID that is associated with the object. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface BatchWriteOperation { + /** + * Creates an object. + */ + CreateObject?: BatchCreateObject; + /** + * Attaches an object to a Directory. + */ + AttachObject?: BatchAttachObject; + /** + * Detaches an object from a Directory. + */ + DetachObject?: BatchDetachObject; + /** + * Updates a given object's attributes. + */ + UpdateObjectAttributes?: BatchUpdateObjectAttributes; + /** + * Deletes an object in a Directory. + */ + DeleteObject?: BatchDeleteObject; + /** + * A batch operation that adds a facet to an object. + */ + AddFacetToObject?: BatchAddFacetToObject; + /** + * A batch operation that removes a facet from an object. + */ + RemoveFacetFromObject?: BatchRemoveFacetFromObject; + /** + * Attaches a policy object to a regular object. An object can have a limited number of attached policies. + */ + AttachPolicy?: BatchAttachPolicy; + /** + * Detaches a policy from a Directory. + */ + DetachPolicy?: BatchDetachPolicy; + /** + * Creates an index object. See Indexing and search for more information. + */ + CreateIndex?: BatchCreateIndex; + /** + * Attaches the specified object to the specified index. + */ + AttachToIndex?: BatchAttachToIndex; + /** + * Detaches the specified object from the specified index. + */ + DetachFromIndex?: BatchDetachFromIndex; + /** + * Attaches a typed link to a specified source and target object. For more information, see Typed Links. + */ + AttachTypedLink?: BatchAttachTypedLink; + /** + * Detaches a typed link from a specified source and target object. For more information, see Typed Links. + */ + DetachTypedLink?: BatchDetachTypedLink; + /** + * Updates a given object's attributes. + */ + UpdateLinkAttributes?: BatchUpdateLinkAttributes; + } + export type BatchWriteOperationList = BatchWriteOperation[]; + export interface BatchWriteOperationResponse { + /** + * Creates an object in a Directory. + */ + CreateObject?: BatchCreateObjectResponse; + /** + * Attaches an object to a Directory. + */ + AttachObject?: BatchAttachObjectResponse; + /** + * Detaches an object from a Directory. + */ + DetachObject?: BatchDetachObjectResponse; + /** + * Updates a given object’s attributes. + */ + UpdateObjectAttributes?: BatchUpdateObjectAttributesResponse; + /** + * Deletes an object in a Directory. + */ + DeleteObject?: BatchDeleteObjectResponse; + /** + * The result of an add facet to object batch operation. + */ + AddFacetToObject?: BatchAddFacetToObjectResponse; + /** + * The result of a batch remove facet from object operation. + */ + RemoveFacetFromObject?: BatchRemoveFacetFromObjectResponse; + /** + * Attaches a policy object to a regular object. An object can have a limited number of attached policies. + */ + AttachPolicy?: BatchAttachPolicyResponse; + /** + * Detaches a policy from a Directory. + */ + DetachPolicy?: BatchDetachPolicyResponse; + /** + * Creates an index object. See Indexing and search for more information. + */ + CreateIndex?: BatchCreateIndexResponse; + /** + * Attaches the specified object to the specified index. + */ + AttachToIndex?: BatchAttachToIndexResponse; + /** + * Detaches the specified object from the specified index. + */ + DetachFromIndex?: BatchDetachFromIndexResponse; + /** + * Attaches a typed link to a specified source and target object. For more information, see Typed Links. + */ + AttachTypedLink?: BatchAttachTypedLinkResponse; + /** + * Detaches a typed link from a specified source and target object. For more information, see Typed Links. + */ + DetachTypedLink?: BatchDetachTypedLinkResponse; + /** + * Represents the output of a BatchWrite response operation. + */ + UpdateLinkAttributes?: BatchUpdateLinkAttributesResponse; + } + export type BatchWriteOperationResponseList = BatchWriteOperationResponse[]; + export interface BatchWriteRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * A list of operations that are part of the batch. + */ + Operations: BatchWriteOperationList; + } + export interface BatchWriteResponse { + /** + * A list of all the responses for each batch write. + */ + Responses?: BatchWriteOperationResponseList; + } + export type BinaryAttributeValue = Buffer|Uint8Array|Blob|string; + export type Bool = boolean; + export type BooleanAttributeValue = boolean; + export type ConsistencyLevel = "SERIALIZABLE"|"EVENTUAL"|string; + export interface CreateDirectoryRequest { + /** + * The name of the Directory. Should be unique per account, per region. + */ + Name: DirectoryName; + /** + * The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns. + */ + SchemaArn: Arn; + } + export interface CreateDirectoryResponse { + /** + * The ARN that is associated with the Directory. For more information, see arns. + */ + DirectoryArn: DirectoryArn; + /** + * The name of the Directory. + */ + Name: DirectoryName; + /** + * The root object node of the created directory. + */ + ObjectIdentifier: ObjectIdentifier; + /** + * The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns. + */ + AppliedSchemaArn: Arn; + } + export interface CreateFacetRequest { + /** + * The schema ARN in which the new Facet will be created. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The name of the Facet, which is unique for a given schema. + */ + Name: FacetName; + /** + * The attributes that are associated with the Facet. + */ + Attributes?: FacetAttributeList; + /** + * Specifies whether a given object created from this facet is of type node, leaf node, policy or index. Node: Can have multiple children but one parent. Leaf node: Cannot have children but can have multiple parents. Policy: Allows you to store a policy document and policy type. For more information, see Policies. Index: Can be created with the Index API. + */ + ObjectType?: ObjectType; + /** + * There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations. + */ + FacetStyle?: FacetStyle; + } + export interface CreateFacetResponse { + } + export interface CreateIndexRequest { + /** + * The ARN of the directory where the index should be created. + */ + DirectoryArn: Arn; + /** + * Specifies the attributes that should be indexed on. Currently only a single attribute is supported. + */ + OrderedIndexedAttributeList: AttributeKeyList; + /** + * Indicates whether the attribute that is being indexed has unique values or not. + */ + IsUnique: Bool; + /** + * A reference to the parent object that contains the index object. + */ + ParentReference?: ObjectReference; + /** + * The name of the link between the parent object and the index object. + */ + LinkName?: LinkName; + } + export interface CreateIndexResponse { + /** + * The ObjectIdentifier of the index created by this operation. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface CreateObjectRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details. + */ + SchemaFacets: SchemaFacetList; + /** + * The attribute map whose attribute ARN contains the key and attribute value as the map value. + */ + ObjectAttributeList?: AttributeKeyAndValueList; + /** + * If specified, the parent reference to which this object will be attached. + */ + ParentReference?: ObjectReference; + /** + * The name of link that is used to attach this object to a parent. + */ + LinkName?: LinkName; + } + export interface CreateObjectResponse { + /** + * The identifier that is associated with the object. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface CreateSchemaRequest { + /** + * The name that is associated with the schema. This is unique to each account and in each region. + */ + Name: SchemaName; + } + export interface CreateSchemaResponse { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn?: Arn; + } + export interface CreateTypedLinkFacetRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * Facet structure that is associated with the typed link facet. + */ + Facet: TypedLinkFacet; + } + export interface CreateTypedLinkFacetResponse { + } + export type _Date = Date; + export type DatetimeAttributeValue = Date; + export interface DeleteDirectoryRequest { + /** + * The ARN of the directory to delete. + */ + DirectoryArn: Arn; + } + export interface DeleteDirectoryResponse { + /** + * The ARN of the deleted directory. + */ + DirectoryArn: Arn; + } + export interface DeleteFacetRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The name of the facet to delete. + */ + Name: FacetName; + } + export interface DeleteFacetResponse { + } + export interface DeleteObjectRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * A reference that identifies the object. + */ + ObjectReference: ObjectReference; + } + export interface DeleteObjectResponse { + } + export interface DeleteSchemaRequest { + /** + * The Amazon Resource Name (ARN) of the development schema. For more information, see arns. + */ + SchemaArn: Arn; + } + export interface DeleteSchemaResponse { + /** + * The input ARN that is returned as part of the response. For more information, see arns. + */ + SchemaArn?: Arn; + } + export interface DeleteTypedLinkFacetRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The unique name of the typed link facet. + */ + Name: TypedLinkName; + } + export interface DeleteTypedLinkFacetResponse { + } + export interface DetachFromIndexRequest { + /** + * The Amazon Resource Name (ARN) of the directory the index and object exist in. + */ + DirectoryArn: Arn; + /** + * A reference to the index object. + */ + IndexReference: ObjectReference; + /** + * A reference to the object being detached from the index. + */ + TargetReference: ObjectReference; + } + export interface DetachFromIndexResponse { + /** + * The ObjectIdentifier of the object that was detached from the index. + */ + DetachedObjectIdentifier?: ObjectIdentifier; + } + export interface DetachObjectRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The parent reference from which the object with the specified link name is detached. + */ + ParentReference: ObjectReference; + /** + * The link name associated with the object that needs to be detached. + */ + LinkName: LinkName; + } + export interface DetachObjectResponse { + /** + * The ObjectIdentifier that was detached from the object. + */ + DetachedObjectIdentifier?: ObjectIdentifier; + } + export interface DetachPolicyRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * Reference that identifies the policy object. + */ + PolicyReference: ObjectReference; + /** + * Reference that identifies the object whose policy object will be detached. + */ + ObjectReference: ObjectReference; + } + export interface DetachPolicyResponse { + } + export interface DetachTypedLinkRequest { + /** + * The Amazon Resource Name (ARN) of the directory where you want to detach the typed link. + */ + DirectoryArn: Arn; + /** + * Used to accept a typed link specifier as input. + */ + TypedLinkSpecifier: TypedLinkSpecifier; + } + export interface Directory { + /** + * The name of the directory. + */ + Name?: DirectoryName; + /** + * The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns. + */ + DirectoryArn?: DirectoryArn; + /** + * The state of the directory. Can be either Enabled, Disabled, or Deleted. + */ + State?: DirectoryState; + /** + * The date and time when the directory was created. + */ + CreationDateTime?: _Date; + } + export type DirectoryArn = string; + export type DirectoryList = Directory[]; + export type DirectoryName = string; + export type DirectoryState = "ENABLED"|"DISABLED"|"DELETED"|string; + export interface DisableDirectoryRequest { + /** + * The ARN of the directory to disable. + */ + DirectoryArn: Arn; + } + export interface DisableDirectoryResponse { + /** + * The ARN of the directory that has been disabled. + */ + DirectoryArn: Arn; + } + export interface EnableDirectoryRequest { + /** + * The ARN of the directory to enable. + */ + DirectoryArn: Arn; + } + export interface EnableDirectoryResponse { + /** + * The ARN of the enabled directory. + */ + DirectoryArn: Arn; + } + export type ExceptionMessage = string; + export interface Facet { + /** + * The name of the Facet. + */ + Name?: FacetName; + /** + * The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details. + */ + ObjectType?: ObjectType; + /** + * There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations. + */ + FacetStyle?: FacetStyle; + } + export interface FacetAttribute { + /** + * The name of the facet attribute. + */ + Name: AttributeName; + /** + * A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information. + */ + AttributeDefinition?: FacetAttributeDefinition; + /** + * An attribute reference that is associated with the attribute. See Attribute References for more information. + */ + AttributeReference?: FacetAttributeReference; + /** + * The required behavior of the FacetAttribute. + */ + RequiredBehavior?: RequiredAttributeBehavior; + } + export interface FacetAttributeDefinition { + /** + * The type of the attribute. + */ + Type: FacetAttributeType; + /** + * The default value of the attribute (if configured). + */ + DefaultValue?: TypedAttributeValue; + /** + * Whether the attribute is mutable or not. + */ + IsImmutable?: Bool; + /** + * Validation rules attached to the attribute definition. + */ + Rules?: RuleMap; + } + export type FacetAttributeList = FacetAttribute[]; + export interface FacetAttributeReference { + /** + * The target facet name that is associated with the facet reference. See Attribute References for more information. + */ + TargetFacetName: FacetName; + /** + * The target attribute name that is associated with the facet reference. See Attribute References for more information. + */ + TargetAttributeName: AttributeName; + } + export type FacetAttributeType = "STRING"|"BINARY"|"BOOLEAN"|"NUMBER"|"DATETIME"|"VARIANT"|string; + export interface FacetAttributeUpdate { + /** + * The attribute to update. + */ + Attribute?: FacetAttribute; + /** + * The action to perform when updating the attribute. + */ + Action?: UpdateActionType; + } + export type FacetAttributeUpdateList = FacetAttributeUpdate[]; + export type FacetName = string; + export type FacetNameList = FacetName[]; + export type FacetStyle = "STATIC"|"DYNAMIC"|string; + export interface GetAppliedSchemaVersionRequest { + /** + * The ARN of the applied schema. + */ + SchemaArn: Arn; + } + export interface GetAppliedSchemaVersionResponse { + /** + * Current applied schema ARN, including the minor version in use if one was provided. + */ + AppliedSchemaArn?: Arn; + } + export interface GetDirectoryRequest { + /** + * The ARN of the directory. + */ + DirectoryArn: DirectoryArn; + } + export interface GetDirectoryResponse { + /** + * Metadata about the directory. + */ + Directory: Directory; + } + export interface GetFacetRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The name of the facet to retrieve. + */ + Name: FacetName; + } + export interface GetFacetResponse { + /** + * The Facet structure that is associated with the facet. + */ + Facet?: Facet; + } + export interface GetLinkAttributesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links. + */ + DirectoryArn: Arn; + /** + * Allows a typed link specifier to be accepted as input. + */ + TypedLinkSpecifier: TypedLinkSpecifier; + /** + * A list of attribute names whose values will be retrieved. + */ + AttributeNames: AttributeNameList; + /** + * The consistency level at which to retrieve the attributes on a typed link. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface GetLinkAttributesResponse { + /** + * The attributes that are associated with the typed link. + */ + Attributes?: AttributeKeyAndValueList; + } + export interface GetObjectAttributesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. + */ + DirectoryArn: Arn; + /** + * Reference that identifies the object whose attributes will be retrieved. + */ + ObjectReference: ObjectReference; + /** + * The consistency level at which to retrieve the attributes on an object. + */ + ConsistencyLevel?: ConsistencyLevel; + /** + * Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details. + */ + SchemaFacet: SchemaFacet; + /** + * List of attribute names whose values will be retrieved. + */ + AttributeNames: AttributeNameList; + } + export interface GetObjectAttributesResponse { + /** + * The attributes that are associated with the object. + */ + Attributes?: AttributeKeyAndValueList; + } + export interface GetObjectInformationRequest { + /** + * The ARN of the directory being retrieved. + */ + DirectoryArn: Arn; + /** + * A reference to the object. + */ + ObjectReference: ObjectReference; + /** + * The consistency level at which to retrieve the object information. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface GetObjectInformationResponse { + /** + * The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details. + */ + SchemaFacets?: SchemaFacetList; + /** + * The ObjectIdentifier of the specified object. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface GetSchemaAsJsonRequest { + /** + * The ARN of the schema to retrieve. + */ + SchemaArn: Arn; + } + export interface GetSchemaAsJsonResponse { + /** + * The name of the retrieved schema. + */ + Name?: SchemaName; + /** + * The JSON representation of the schema document. + */ + Document?: SchemaJsonDocument; + } + export interface GetTypedLinkFacetInformationRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The unique name of the typed link facet. + */ + Name: TypedLinkName; + } + export interface GetTypedLinkFacetInformationResponse { + /** + * 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 Typed Links. + */ + IdentityAttributeOrder?: AttributeNameList; + } + export interface IndexAttachment { + /** + * The indexed attribute values. + */ + IndexedAttributes?: AttributeKeyAndValueList; + /** + * In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export type IndexAttachmentList = IndexAttachment[]; + export interface LinkAttributeAction { + /** + * A type that can be either UPDATE_OR_CREATE or DELETE. + */ + AttributeActionType?: UpdateActionType; + /** + * The value that you want to update to. + */ + AttributeUpdateValue?: TypedAttributeValue; + } + export interface LinkAttributeUpdate { + /** + * The key of the attribute being updated. + */ + AttributeKey?: AttributeKey; + /** + * The action to perform as part of the attribute update. + */ + AttributeAction?: LinkAttributeAction; + } + export type LinkAttributeUpdateList = LinkAttributeUpdate[]; + export type LinkName = string; + export type LinkNameToObjectIdentifierMap = {[key: string]: ObjectIdentifier}; + export interface ListAppliedSchemaArnsRequest { + /** + * The ARN of the directory you are listing. + */ + DirectoryArn: Arn; + /** + * The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version. + */ + SchemaArn?: Arn; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListAppliedSchemaArnsResponse { + /** + * The ARNs of schemas that are applied to the directory. + */ + SchemaArns?: Arns; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListAttachedIndicesRequest { + /** + * The ARN of the directory. + */ + DirectoryArn: Arn; + /** + * A reference to the object that has indices attached. + */ + TargetReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + /** + * The consistency level to use for this operation. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface ListAttachedIndicesResponse { + /** + * The indices attached to the specified object. + */ + IndexAttachments?: IndexAttachmentList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListDevelopmentSchemaArnsRequest { + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListDevelopmentSchemaArnsResponse { + /** + * The ARNs of retrieved development schemas. + */ + SchemaArns?: Arns; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListDirectoriesRequest { + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + /** + * The state of the directories in the list. Can be either Enabled, Disabled, or Deleted. + */ + state?: DirectoryState; + } + export interface ListDirectoriesResponse { + /** + * Lists all directories that are associated with your account in pagination fashion. + */ + Directories: DirectoryList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListFacetAttributesRequest { + /** + * The ARN of the schema where the facet resides. + */ + SchemaArn: Arn; + /** + * The name of the facet whose attributes will be retrieved. + */ + Name: FacetName; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListFacetAttributesResponse { + /** + * The attributes attached to the facet. + */ + Attributes?: FacetAttributeList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListFacetNamesRequest { + /** + * The Amazon Resource Name (ARN) to retrieve facet names from. + */ + SchemaArn: Arn; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListFacetNamesResponse { + /** + * The names of facets that exist within the schema. + */ + FacetNames?: FacetNameList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListIncomingTypedLinksRequest { + /** + * The Amazon Resource Name (ARN) of the directory where you want to list the typed links. + */ + DirectoryArn: Arn; + /** + * Reference that identifies the object whose attributes will be listed. + */ + ObjectReference: ObjectReference; + /** + * Provides range filters for multiple attributes. 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. + */ + FilterAttributeRanges?: TypedLinkAttributeRangeList; + /** + * 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. + */ + FilterTypedLink?: TypedLinkSchemaAndFacetName; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + /** + * The consistency level to execute the request at. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface ListIncomingTypedLinksResponse { + /** + * Returns one or more typed link specifiers as output. + */ + LinkSpecifiers?: TypedLinkSpecifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListIndexRequest { + /** + * The ARN of the directory that the index exists in. + */ + DirectoryArn: Arn; + /** + * Specifies the ranges of indexed values that you want to query. + */ + RangesOnIndexedValues?: ObjectAttributeRangeList; + /** + * The reference to the index to list. + */ + IndexReference: ObjectReference; + /** + * The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits. + */ + MaxResults?: NumberResults; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The consistency level to execute the request at. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface ListIndexResponse { + /** + * The objects and indexed values attached to the index. + */ + IndexAttachments?: IndexAttachmentList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListManagedSchemaArnsRequest { + /** + * The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed. + */ + SchemaArn?: Arn; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListManagedSchemaArnsResponse { + /** + * The ARNs for all AWS managed schemas. + */ + SchemaArns?: Arns; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListObjectAttributesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The reference that identifies the object whose attributes will be listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + /** + * 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. + */ + ConsistencyLevel?: ConsistencyLevel; + /** + * Used to filter the list of object attributes that are associated with a certain facet. + */ + FacetFilter?: SchemaFacet; + } + export interface ListObjectAttributesResponse { + /** + * Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value. + */ + Attributes?: AttributeKeyAndValueList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListObjectChildrenRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The reference that identifies the object for which child objects are being listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + /** + * 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. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface ListObjectChildrenResponse { + /** + * Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value. + */ + Children?: LinkNameToObjectIdentifierMap; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListObjectParentPathsRequest { + /** + * The ARN of the directory to which the parent path applies. + */ + DirectoryArn: Arn; + /** + * The reference that identifies the object whose parent paths are listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + } + export interface ListObjectParentPathsResponse { + /** + * Returns the path to the ObjectIdentifiers that are associated with the directory. + */ + PathToObjectIdentifiersList?: PathToObjectIdentifiersList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListObjectParentsRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The reference that identifies the object for which parent objects are being listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + /** + * 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. + */ + ConsistencyLevel?: ConsistencyLevel; + /** + * When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair. + */ + IncludeAllLinksToEachParent?: Bool; + } + export interface ListObjectParentsResponse { + /** + * The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value. + */ + Parents?: ObjectIdentifierToLinkNameMap; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * Returns a list of parent reference and LinkName Tuples. + */ + ParentLinks?: ObjectIdentifierAndLinkNameList; + } + export interface ListObjectPoliciesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * Reference that identifies the object for which policies will be listed. + */ + ObjectReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + /** + * 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. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface ListObjectPoliciesResponse { + /** + * A list of policy ObjectIdentifiers, that are attached to the object. + */ + AttachedPolicyIds?: ObjectIdentifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListOutgoingTypedLinksRequest { + /** + * The Amazon Resource Name (ARN) of the directory where you want to list the typed links. + */ + DirectoryArn: Arn; + /** + * A reference that identifies the object whose attributes will be listed. + */ + ObjectReference: ObjectReference; + /** + * Provides range filters for multiple attributes. 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. + */ + FilterAttributeRanges?: TypedLinkAttributeRangeList; + /** + * Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls. + */ + FilterTypedLink?: TypedLinkSchemaAndFacetName; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + /** + * The consistency level to execute the request at. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface ListOutgoingTypedLinksResponse { + /** + * Returns a typed link specifier as output. + */ + TypedLinkSpecifiers?: TypedLinkSpecifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListPolicyAttachmentsRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The reference that identifies the policy object. + */ + PolicyReference: ObjectReference; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + /** + * 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. + */ + ConsistencyLevel?: ConsistencyLevel; + } + export interface ListPolicyAttachmentsResponse { + /** + * A list of ObjectIdentifiers to which the policy is attached. + */ + ObjectIdentifiers?: ObjectIdentifierList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListPublishedSchemaArnsRequest { + /** + * The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version. + */ + SchemaArn?: Arn; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListPublishedSchemaArnsResponse { + /** + * The ARNs of published schemas. + */ + SchemaArns?: Arns; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories. + */ + ResourceArn: Arn; + /** + * The pagination token. This is for future use. Currently pagination is not supported for tagging. + */ + NextToken?: NextToken; + /** + * The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently. + */ + MaxResults?: TagsNumberResults; + } + export interface ListTagsForResourceResponse { + /** + * A list of tag key value pairs that are associated with the response. + */ + Tags?: TagList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface ListTypedLinkFacetAttributesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The unique name of the typed link facet. + */ + Name: TypedLinkName; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListTypedLinkFacetAttributesResponse { + /** + * An ordered set of attributes associate with the typed link. + */ + Attributes?: TypedLinkAttributeDefinitionList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface ListTypedLinkFacetNamesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The pagination token. + */ + NextToken?: NextToken; + /** + * The maximum number of results to retrieve. + */ + MaxResults?: NumberResults; + } + export interface ListTypedLinkFacetNamesResponse { + /** + * The names of typed link facets that exist within the schema. + */ + FacetNames?: TypedLinkNameList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export interface LookupPolicyRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * Reference that identifies the object whose policies will be looked up. + */ + ObjectReference: ObjectReference; + /** + * The token to request the next page of results. + */ + NextToken?: NextToken; + /** + * The maximum number of items to be retrieved in a single call. This is an approximate number. + */ + MaxResults?: NumberResults; + } + export interface LookupPolicyResponse { + /** + * Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies. + */ + PolicyToPathList?: PolicyToPathList; + /** + * The pagination token. + */ + NextToken?: NextToken; + } + export type NextToken = string; + export type NumberAttributeValue = string; + export type NumberResults = number; + export interface ObjectAttributeAction { + /** + * A type that can be either Update or Delete. + */ + ObjectAttributeActionType?: UpdateActionType; + /** + * The value that you want to update to. + */ + ObjectAttributeUpdateValue?: TypedAttributeValue; + } + export interface ObjectAttributeRange { + /** + * The key of the attribute that the attribute range covers. + */ + AttributeKey?: AttributeKey; + /** + * The range of attribute values being selected. + */ + Range?: TypedAttributeValueRange; + } + export type ObjectAttributeRangeList = ObjectAttributeRange[]; + export interface ObjectAttributeUpdate { + /** + * The key of the attribute being updated. + */ + ObjectAttributeKey?: AttributeKey; + /** + * The action to perform as part of the attribute update. + */ + ObjectAttributeAction?: ObjectAttributeAction; + } + export type ObjectAttributeUpdateList = ObjectAttributeUpdate[]; + export type ObjectIdentifier = string; + export type ObjectIdentifierAndLinkNameList = ObjectIdentifierAndLinkNameTuple[]; + export interface ObjectIdentifierAndLinkNameTuple { + /** + * The ID that is associated with the object. + */ + ObjectIdentifier?: ObjectIdentifier; + /** + * The name of the link between the parent and the child object. + */ + LinkName?: LinkName; + } + export type ObjectIdentifierList = ObjectIdentifier[]; + export type ObjectIdentifierToLinkNameMap = {[key: string]: LinkName}; + export interface ObjectReference { + /** + * A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways: $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier /some/path - Identifies the object based on path #SomeBatchReference - Identifies the object in a batch call + */ + Selector?: SelectorObjectReference; + } + export type ObjectType = "NODE"|"LEAF_NODE"|"POLICY"|"INDEX"|string; + export type PathString = string; + export interface PathToObjectIdentifiers { + /** + * The path that is used to identify the object starting from directory root. + */ + Path?: PathString; + /** + * Lists ObjectIdentifiers starting from directory root to the object in the request. + */ + ObjectIdentifiers?: ObjectIdentifierList; + } + export type PathToObjectIdentifiersList = PathToObjectIdentifiers[]; + export interface PolicyAttachment { + /** + * The ID of PolicyAttachment. + */ + PolicyId?: ObjectIdentifier; + /** + * The ObjectIdentifier that is associated with PolicyAttachment. + */ + ObjectIdentifier?: ObjectIdentifier; + /** + * The type of policy that can be associated with PolicyAttachment. + */ + PolicyType?: PolicyType; + } + export type PolicyAttachmentList = PolicyAttachment[]; + export interface PolicyToPath { + /** + * The path that is referenced from the root. + */ + Path?: PathString; + /** + * List of policy objects. + */ + Policies?: PolicyAttachmentList; + } + export type PolicyToPathList = PolicyToPath[]; + export type PolicyType = string; + export interface PublishSchemaRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns. + */ + DevelopmentSchemaArn: Arn; + /** + * The major version under which the schema will be published. Schemas have both a major and minor version associated with them. + */ + Version: Version; + /** + * The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them. + */ + MinorVersion?: Version; + /** + * The new name under which the schema will be published. If this is not provided, the development schema is considered. + */ + Name?: SchemaName; + } + export interface PublishSchemaResponse { + /** + * The ARN that is associated with the published schema. For more information, see arns. + */ + PublishedSchemaArn?: Arn; + } + export interface PutSchemaFromJsonRequest { + /** + * The ARN of the schema to update. + */ + SchemaArn: Arn; + /** + * The replacement JSON schema. + */ + Document: SchemaJsonDocument; + } + export interface PutSchemaFromJsonResponse { + /** + * The ARN of the schema to update. + */ + Arn?: Arn; + } + export type RangeMode = "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE"|string; + export interface RemoveFacetFromObjectRequest { + /** + * The ARN of the directory in which the object resides. + */ + DirectoryArn: Arn; + /** + * The facet to remove. See SchemaFacet for details. + */ + SchemaFacet: SchemaFacet; + /** + * A reference to the object to remove the facet from. + */ + ObjectReference: ObjectReference; + } + export interface RemoveFacetFromObjectResponse { + } + export type RequiredAttributeBehavior = "REQUIRED_ALWAYS"|"NOT_REQUIRED"|string; + export interface Rule { + /** + * The type of attribute validation rule. + */ + Type?: RuleType; + /** + * The minimum and maximum parameters that are associated with the rule. + */ + Parameters?: RuleParameterMap; + } + export type RuleKey = string; + export type RuleMap = {[key: string]: Rule}; + export type RuleParameterKey = string; + export type RuleParameterMap = {[key: string]: RuleParameterValue}; + export type RuleParameterValue = string; + export type RuleType = "BINARY_LENGTH"|"NUMBER_COMPARISON"|"STRING_FROM_SET"|"STRING_LENGTH"|string; + export interface SchemaFacet { + /** + * The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. + */ + SchemaArn?: Arn; + /** + * The name of the facet. + */ + FacetName?: FacetName; + } + export type SchemaFacetList = SchemaFacet[]; + export type SchemaJsonDocument = string; + export type SchemaName = string; + export type SelectorObjectReference = string; + export type StringAttributeValue = string; + export interface Tag { + /** + * The key that is associated with the tag. + */ + Key?: TagKey; + /** + * The value that is associated with the tag. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories. + */ + ResourceArn: Arn; + /** + * A list of tag key-value pairs. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type TagsNumberResults = number; + export interface TypedAttributeValue { + /** + * A string data value. + */ + StringValue?: StringAttributeValue; + /** + * A binary data value. + */ + BinaryValue?: BinaryAttributeValue; + /** + * A Boolean data value. + */ + BooleanValue?: BooleanAttributeValue; + /** + * A number data value. + */ + NumberValue?: NumberAttributeValue; + /** + * A date and time value. + */ + DatetimeValue?: DatetimeAttributeValue; + } + export interface TypedAttributeValueRange { + /** + * The inclusive or exclusive range start. + */ + StartMode: RangeMode; + /** + * The value to start the range at. + */ + StartValue?: TypedAttributeValue; + /** + * The inclusive or exclusive range end. + */ + EndMode: RangeMode; + /** + * The attribute value to terminate the range at. + */ + EndValue?: TypedAttributeValue; + } + export interface TypedLinkAttributeDefinition { + /** + * The unique name of the typed link attribute. + */ + Name: AttributeName; + /** + * The type of the attribute. + */ + Type: FacetAttributeType; + /** + * The default value of the attribute (if configured). + */ + DefaultValue?: TypedAttributeValue; + /** + * Whether the attribute is mutable or not. + */ + IsImmutable?: Bool; + /** + * Validation rules that are attached to the attribute definition. + */ + Rules?: RuleMap; + /** + * The required behavior of the TypedLinkAttributeDefinition. + */ + RequiredBehavior: RequiredAttributeBehavior; + } + export type TypedLinkAttributeDefinitionList = TypedLinkAttributeDefinition[]; + export interface TypedLinkAttributeRange { + /** + * The unique name of the typed link attribute. + */ + AttributeName?: AttributeName; + /** + * The range of attribute values that are being selected. + */ + Range: TypedAttributeValueRange; + } + export type TypedLinkAttributeRangeList = TypedLinkAttributeRange[]; + export interface TypedLinkFacet { + /** + * The unique name of the typed link facet. + */ + Name: TypedLinkName; + /** + * A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects. + */ + Attributes: TypedLinkAttributeDefinitionList; + /** + * 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 ListOutgoingTypedLinks and ListIncomingTypedLinks for details. + */ + IdentityAttributeOrder: AttributeNameList; + } + export interface TypedLinkFacetAttributeUpdate { + /** + * The attribute to update. + */ + Attribute: TypedLinkAttributeDefinition; + /** + * The action to perform when updating the attribute. + */ + Action: UpdateActionType; + } + export type TypedLinkFacetAttributeUpdateList = TypedLinkFacetAttributeUpdate[]; + export type TypedLinkName = string; + export type TypedLinkNameList = TypedLinkName[]; + export interface TypedLinkSchemaAndFacetName { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The unique name of the typed link facet. + */ + TypedLinkName: TypedLinkName; + } + export interface TypedLinkSpecifier { + /** + * Identifies the typed link facet that is associated with the typed link. + */ + TypedLinkFacet: TypedLinkSchemaAndFacetName; + /** + * Identifies the source object that the typed link will attach to. + */ + SourceObjectReference: ObjectReference; + /** + * Identifies the target object that the typed link will attach to. + */ + TargetObjectReference: ObjectReference; + /** + * Identifies the attribute value to update. + */ + IdentityAttributeValues: AttributeNameAndValueList; + } + export type TypedLinkSpecifierList = TypedLinkSpecifier[]; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories. + */ + ResourceArn: Arn; + /** + * Keys of the tag that need to be removed from the resource. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export type UpdateActionType = "CREATE_OR_UPDATE"|"DELETE"|string; + export interface UpdateFacetRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The name of the facet. + */ + Name: FacetName; + /** + * List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform. + */ + AttributeUpdates?: FacetAttributeUpdateList; + /** + * The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details. + */ + ObjectType?: ObjectType; + } + export interface UpdateFacetResponse { + } + export interface UpdateLinkAttributesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed Links. + */ + DirectoryArn: Arn; + /** + * Allows a typed link specifier to be accepted as input. + */ + TypedLinkSpecifier: TypedLinkSpecifier; + /** + * The attributes update structure. + */ + AttributeUpdates: LinkAttributeUpdateList; + } + export interface UpdateLinkAttributesResponse { + } + export interface UpdateObjectAttributesRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns. + */ + DirectoryArn: Arn; + /** + * The reference that identifies the object. + */ + ObjectReference: ObjectReference; + /** + * The attributes update structure. + */ + AttributeUpdates: ObjectAttributeUpdateList; + } + export interface UpdateObjectAttributesResponse { + /** + * The ObjectIdentifier of the updated object. + */ + ObjectIdentifier?: ObjectIdentifier; + } + export interface UpdateSchemaRequest { + /** + * The Amazon Resource Name (ARN) of the development schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The name of the schema. + */ + Name: SchemaName; + } + export interface UpdateSchemaResponse { + /** + * The ARN that is associated with the updated schema. For more information, see arns. + */ + SchemaArn?: Arn; + } + export interface UpdateTypedLinkFacetRequest { + /** + * The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns. + */ + SchemaArn: Arn; + /** + * The unique name of the typed link facet. + */ + Name: TypedLinkName; + /** + * Attributes update structure. + */ + AttributeUpdates: TypedLinkFacetAttributeUpdateList; + /** + * 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 Typed Links. + */ + IdentityAttributeOrder: AttributeNameList; + } + export interface UpdateTypedLinkFacetResponse { + } + export interface UpgradeAppliedSchemaRequest { + /** + * The revision of the published schema to upgrade the directory to. + */ + PublishedSchemaArn: Arn; + /** + * The ARN for the directory to which the upgraded schema will be applied. + */ + DirectoryArn: Arn; + /** + * Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional. + */ + DryRun?: Bool; + } + export interface UpgradeAppliedSchemaResponse { + /** + * The ARN of the upgraded schema that is returned as part of the response. + */ + UpgradedSchemaArn?: Arn; + /** + * The ARN of the directory that is returned as part of the response. + */ + DirectoryArn?: Arn; + } + export interface UpgradePublishedSchemaRequest { + /** + * The ARN of the development schema with the changes used for the upgrade. + */ + DevelopmentSchemaArn: Arn; + /** + * The ARN of the published schema to be upgraded. + */ + PublishedSchemaArn: Arn; + /** + * Identifies the minor version of the published schema that will be created. This parameter is NOT optional. + */ + MinorVersion: Version; + /** + * Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false. + */ + DryRun?: Bool; + } + export interface UpgradePublishedSchemaResponse { + /** + * The ARN of the upgraded schema that is returned as part of the response. + */ + UpgradedSchemaArn?: Arn; + } + export type Version = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-05-10"|"2016-05-10"|"2017-01-11"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudDirectory client. + */ + export import Types = CloudDirectory; +} +export = CloudDirectory; diff --git a/node_modules/aws-sdk/clients/clouddirectory.js b/node_modules/aws-sdk/clients/clouddirectory.js new file mode 100644 index 0000000..e764f6d --- /dev/null +++ b/node_modules/aws-sdk/clients/clouddirectory.js @@ -0,0 +1,27 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['clouddirectory'] = {}; +AWS.CloudDirectory = Service.defineService('clouddirectory', ['2016-05-10', '2016-05-10*', '2017-01-11']); +Object.defineProperty(apiLoader.services['clouddirectory'], '2016-05-10', { + get: function get() { + var model = require('../apis/clouddirectory-2016-05-10.min.json'); + model.paginators = require('../apis/clouddirectory-2016-05-10.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['clouddirectory'], '2017-01-11', { + get: function get() { + var model = require('../apis/clouddirectory-2017-01-11.min.json'); + model.paginators = require('../apis/clouddirectory-2017-01-11.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudDirectory; diff --git a/node_modules/aws-sdk/clients/cloudformation.d.ts b/node_modules/aws-sdk/clients/cloudformation.d.ts new file mode 100644 index 0000000..5d80e27 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudformation.d.ts @@ -0,0 +1,2713 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudFormation extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudFormation.Types.ClientConfiguration) + config: Config & CloudFormation.Types.ClientConfiguration; + /** + * Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. + */ + cancelUpdateStack(params: CloudFormation.Types.CancelUpdateStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. + */ + cancelUpdateStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. + */ + continueUpdateRollback(params: CloudFormation.Types.ContinueUpdateRollbackInput, callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request; + /** + * For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. + */ + continueUpdateRollback(callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request; + /** + * Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set. + */ + createChangeSet(params: CloudFormation.Types.CreateChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request; + /** + * Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set. + */ + createChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request; + /** + * Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API. + */ + createStack(params: CloudFormation.Types.CreateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request; + /** + * Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API. + */ + createStack(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request; + /** + * Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region. + */ + createStackInstances(params: CloudFormation.Types.CreateStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackInstancesOutput) => void): Request; + /** + * Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region. + */ + createStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackInstancesOutput) => void): Request; + /** + * Creates a stack set. + */ + createStackSet(params: CloudFormation.Types.CreateStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackSetOutput) => void): Request; + /** + * Creates a stack set. + */ + createStackSet(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackSetOutput) => void): Request; + /** + * Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set. + */ + deleteChangeSet(params: CloudFormation.Types.DeleteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request; + /** + * Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set. + */ + deleteChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request; + /** + * Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully. + */ + deleteStack(params: CloudFormation.Types.DeleteStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully. + */ + deleteStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes stack instances for the specified accounts, in the specified regions. + */ + deleteStackInstances(params: CloudFormation.Types.DeleteStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackInstancesOutput) => void): Request; + /** + * Deletes stack instances for the specified accounts, in the specified regions. + */ + deleteStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackInstancesOutput) => void): Request; + /** + * Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances. + */ + deleteStackSet(params: CloudFormation.Types.DeleteStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackSetOutput) => void): Request; + /** + * Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances. + */ + deleteStackSet(callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackSetOutput) => void): Request; + /** + * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide. + */ + describeAccountLimits(params: CloudFormation.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request; + /** + * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide. + */ + describeAccountLimits(callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request; + /** + * Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide. + */ + describeChangeSet(params: CloudFormation.Types.DescribeChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request; + /** + * Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide. + */ + describeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request; + /** + * Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. + */ + describeStackDriftDetectionStatus(params: CloudFormation.Types.DescribeStackDriftDetectionStatusInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request; + /** + * Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. + */ + describeStackDriftDetectionStatus(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request; + /** + * Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID). + */ + describeStackEvents(params: CloudFormation.Types.DescribeStackEventsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request; + /** + * Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID). + */ + describeStackEvents(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request; + /** + * Returns the stack instance that's associated with the specified stack set, AWS account, and region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances. + */ + describeStackInstance(params: CloudFormation.Types.DescribeStackInstanceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request; + /** + * Returns the stack instance that's associated with the specified stack set, AWS account, and region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances. + */ + describeStackInstance(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request; + /** + * Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. + */ + describeStackResource(params: CloudFormation.Types.DescribeStackResourceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request; + /** + * Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. + */ + describeStackResource(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request; + /** + * Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack. + */ + describeStackResourceDrifts(params: CloudFormation.Types.DescribeStackResourceDriftsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request; + /** + * Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack. + */ + describeStackResourceDrifts(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request; + /** + * Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request. + */ + describeStackResources(params: CloudFormation.Types.DescribeStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request; + /** + * Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request. + */ + describeStackResources(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request; + /** + * Returns the description of the specified stack set. + */ + describeStackSet(params: CloudFormation.Types.DescribeStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request; + /** + * Returns the description of the specified stack set. + */ + describeStackSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request; + /** + * Returns the description of the specified stack set operation. + */ + describeStackSetOperation(params: CloudFormation.Types.DescribeStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request; + /** + * Returns the description of the specified stack set operation. + */ + describeStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request; + /** + * Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack does not exist, an AmazonCloudFormationException is returned. + */ + describeStacks(params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack does not exist, an AmazonCloudFormationException is returned. + */ + describeStacks(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself. + */ + detectStackDrift(params: CloudFormation.Types.DetectStackDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request; + /** + * Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself. + */ + detectStackDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request; + /** + * Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection. + */ + detectStackResourceDrift(params: CloudFormation.Types.DetectStackResourceDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request; + /** + * Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection. + */ + detectStackResourceDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request; + /** + * Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. + */ + estimateTemplateCost(params: CloudFormation.Types.EstimateTemplateCostInput, callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request; + /** + * Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. + */ + estimateTemplateCost(callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request; + /** + * Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy. + */ + executeChangeSet(params: CloudFormation.Types.ExecuteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request; + /** + * Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy. + */ + executeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request; + /** + * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. + */ + getStackPolicy(params: CloudFormation.Types.GetStackPolicyInput, callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request; + /** + * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. + */ + getStackPolicy(callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request; + /** + * Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned. + */ + getTemplate(params: CloudFormation.Types.GetTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request; + /** + * Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned. + */ + getTemplate(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request; + /** + * Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned. + */ + getTemplateSummary(params: CloudFormation.Types.GetTemplateSummaryInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request; + /** + * Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned. + */ + getTemplateSummary(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request; + /** + * Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state. + */ + listChangeSets(params: CloudFormation.Types.ListChangeSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request; + /** + * Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state. + */ + listChangeSets(callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request; + /** + * Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function. For more information, see AWS CloudFormation Export Stack Output Values. + */ + listExports(params: CloudFormation.Types.ListExportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request; + /** + * Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function. For more information, see AWS CloudFormation Export Stack Output Values. + */ + listExports(callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request; + /** + * Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Fn::ImportValue function. + */ + listImports(params: CloudFormation.Types.ListImportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request; + /** + * Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Fn::ImportValue function. + */ + listImports(callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request; + /** + * Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region. + */ + listStackInstances(params: CloudFormation.Types.ListStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request; + /** + * Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region. + */ + listStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request; + /** + * Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. + */ + listStackResources(params: CloudFormation.Types.ListStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request; + /** + * Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. + */ + listStackResources(callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request; + /** + * Returns summary information about the results of a stack set operation. + */ + listStackSetOperationResults(params: CloudFormation.Types.ListStackSetOperationResultsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request; + /** + * Returns summary information about the results of a stack set operation. + */ + listStackSetOperationResults(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request; + /** + * Returns summary information about operations performed on a stack set. + */ + listStackSetOperations(params: CloudFormation.Types.ListStackSetOperationsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request; + /** + * Returns summary information about operations performed on a stack set. + */ + listStackSetOperations(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request; + /** + * Returns summary information about stack sets that are associated with the user. + */ + listStackSets(params: CloudFormation.Types.ListStackSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request; + /** + * Returns summary information about stack sets that are associated with the user. + */ + listStackSets(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request; + /** + * Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). + */ + listStacks(params: CloudFormation.Types.ListStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request; + /** + * Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). + */ + listStacks(callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request; + /** + * Sets a stack policy for a specified stack. + */ + setStackPolicy(params: CloudFormation.Types.SetStackPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets a stack policy for a specified stack. + */ + setStackPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. + */ + signalResource(params: CloudFormation.Types.SignalResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. + */ + signalResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops an in-progress operation on a stack set and its associated stack instances. + */ + stopStackSetOperation(params: CloudFormation.Types.StopStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request; + /** + * Stops an in-progress operation on a stack set and its associated stack instances. + */ + stopStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request; + /** + * Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack. + */ + updateStack(params: CloudFormation.Types.UpdateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request; + /** + * Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack. + */ + updateStack(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request; + /** + * Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances. During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances. + */ + updateStackInstances(params: CloudFormation.Types.UpdateStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request; + /** + * Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances. During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances. + */ + updateStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request; + /** + * Updates the stack set, and associated stack instances in the specified accounts and regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set. + */ + updateStackSet(params: CloudFormation.Types.UpdateStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request; + /** + * Updates the stack set, and associated stack instances in the specified accounts and regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set. + */ + updateStackSet(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request; + /** + * Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. + */ + updateTerminationProtection(params: CloudFormation.Types.UpdateTerminationProtectionInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request; + /** + * Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. + */ + updateTerminationProtection(callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request; + /** + * Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error. + */ + validateTemplate(params: CloudFormation.Types.ValidateTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request; + /** + * Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error. + */ + validateTemplate(callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request; + /** + * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "stackExists", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "stackExists", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the stackCreateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is CREATE_COMPLETE. + */ + waitFor(state: "stackCreateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the stackCreateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is CREATE_COMPLETE. + */ + waitFor(state: "stackCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the stackDeleteComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is DELETE_COMPLETE. + */ + waitFor(state: "stackDeleteComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the stackDeleteComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is DELETE_COMPLETE. + */ + waitFor(state: "stackDeleteComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the stackUpdateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_COMPLETE. + */ + waitFor(state: "stackUpdateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the stackUpdateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_COMPLETE. + */ + waitFor(state: "stackUpdateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request; + /** + * Waits for the changeSetCreateComplete state by periodically calling the underlying CloudFormation.describeChangeSetoperation every 30 seconds (at most 120 times). Wait until change set status is CREATE_COMPLETE. + */ + waitFor(state: "changeSetCreateComplete", params: CloudFormation.Types.DescribeChangeSetInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request; + /** + * Waits for the changeSetCreateComplete state by periodically calling the underlying CloudFormation.describeChangeSetoperation every 30 seconds (at most 120 times). Wait until change set status is CREATE_COMPLETE. + */ + waitFor(state: "changeSetCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request; +} +declare namespace CloudFormation { + export type Account = string; + export interface AccountGateResult { + /** + * The status of the account gate function. SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region. FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED. SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons: An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region. The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region. Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region. + */ + Status?: AccountGateStatus; + /** + * The reason for the account gate status assigned to this account and region for the stack set operation. + */ + StatusReason?: AccountGateStatusReason; + } + export type AccountGateStatus = "SUCCEEDED"|"FAILED"|"SKIPPED"|string; + export type AccountGateStatusReason = string; + export interface AccountLimit { + /** + * The name of the account limit. + */ + Name?: LimitName; + /** + * The value that is associated with the account limit name. + */ + Value?: LimitValue; + } + export type AccountLimitList = AccountLimit[]; + export type AccountList = Account[]; + export type AllowedValue = string; + export type AllowedValues = AllowedValue[]; + export type Arn = string; + export type BoxedInteger = number; + export type BoxedMaxResults = number; + export interface CancelUpdateStackInput { + /** + * The name or the unique stack ID that is associated with the stack. + */ + StackName: StackName; + /** + * A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully received them. + */ + ClientRequestToken?: ClientRequestToken; + } + export type Capabilities = Capability[]; + export type CapabilitiesReason = string; + export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|string; + export type CausingEntity = string; + export interface Change { + /** + * The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource. + */ + Type?: ChangeType; + /** + * A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform. + */ + ResourceChange?: ResourceChange; + } + export type ChangeAction = "Add"|"Modify"|"Remove"|string; + export type ChangeSetId = string; + export type ChangeSetName = string; + export type ChangeSetNameOrId = string; + export type ChangeSetStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"DELETE_COMPLETE"|"FAILED"|string; + export type ChangeSetStatusReason = string; + export type ChangeSetSummaries = ChangeSetSummary[]; + export interface ChangeSetSummary { + /** + * The ID of the stack with which the change set is associated. + */ + StackId?: StackId; + /** + * The name of the stack with which the change set is associated. + */ + StackName?: StackName; + /** + * The ID of the change set. + */ + ChangeSetId?: ChangeSetId; + /** + * The name of the change set. + */ + ChangeSetName?: ChangeSetName; + /** + * If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated. + */ + ExecutionStatus?: ExecutionStatus; + /** + * The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED. + */ + Status?: ChangeSetStatus; + /** + * A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message. + */ + StatusReason?: ChangeSetStatusReason; + /** + * The start time when the change set was created, in UTC. + */ + CreationTime?: CreationTime; + /** + * Descriptive information about the change set. + */ + Description?: Description; + } + export type ChangeSetType = "CREATE"|"UPDATE"|string; + export type ChangeSource = "ResourceReference"|"ParameterReference"|"ResourceAttribute"|"DirectModification"|"Automatic"|string; + export type ChangeType = "Resource"|string; + export type Changes = Change[]; + export type ClientRequestToken = string; + export type ClientToken = string; + export interface ContinueUpdateRollbackInput { + /** + * The name or the unique ID of the stack that you want to continue rolling back. Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource). + */ + StackName: StackNameOrId; + /** + * 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. 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. + */ + RoleARN?: RoleARN; + /** + * A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason. Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy. + */ + ResourcesToSkip?: ResourcesToSkip; + /** + * A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully received them. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface ContinueUpdateRollbackOutput { + } + export interface CreateChangeSetInput { + /** + * The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values. + */ + StackName: StackNameOrId; + /** + * A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL. + */ + TemplateBody?: TemplateBody; + /** + * The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL. + */ + TemplateURL?: TemplateURL; + /** + * Whether to reuse the template that is associated with the stack to create the change set. + */ + UsePreviousTemplate?: UsePreviousTemplate; + /** + * A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type. + */ + Parameters?: Parameters; + /** + * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect. Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability. For more information on macros, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. + */ + Capabilities?: Capabilities; + /** + * The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide. + */ + ResourceTypes?: ResourceTypes; + /** + * 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. 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. + */ + RoleARN?: RoleARN; + /** + * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. + */ + RollbackConfiguration?: RollbackConfiguration; + /** + * The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list. + */ + NotificationARNs?: NotificationARNs; + /** + * Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags. + */ + Tags?: Tags; + /** + * The name of the change set. The name must be unique among all change sets that are associated with the specified stack. A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters. + */ + ChangeSetName: ChangeSetName; + /** + * A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them. + */ + ClientToken?: ClientToken; + /** + * A description to help you identify this change set. + */ + Description?: Description; + /** + * The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set. By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack. + */ + ChangeSetType?: ChangeSetType; + } + export interface CreateChangeSetOutput { + /** + * The Amazon Resource Name (ARN) of the change set. + */ + Id?: ChangeSetId; + /** + * The unique ID of the stack. + */ + StackId?: StackId; + } + export interface CreateStackInput { + /** + * The name that is associated with the stack. The name must be unique in the region in which you are creating the stack. A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters. + */ + StackName: StackName; + /** + * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. + */ + TemplateBody?: TemplateBody; + /** + * Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. + */ + TemplateURL?: TemplateURL; + /** + * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type. + */ + Parameters?: Parameters; + /** + * Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both. Default: false + */ + DisableRollback?: DisableRollback; + /** + * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. + */ + RollbackConfiguration?: RollbackConfiguration; + /** + * The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back. + */ + TimeoutInMinutes?: TimeoutMinutes; + /** + * The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI). + */ + NotificationARNs?: NotificationARNs; + /** + * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability. You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs. Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. + */ + Capabilities?: Capabilities; + /** + * The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource). If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management. + */ + ResourceTypes?: ResourceTypes; + /** + * 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. 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. + */ + RoleARN?: RoleARN; + /** + * Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both. Default: ROLLBACK + */ + OnFailure?: OnFailure; + /** + * Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. + */ + StackPolicyBody?: StackPolicyBody; + /** + * Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. + */ + StackPolicyURL?: StackPolicyURL; + /** + * Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified. + */ + Tags?: Tags; + /** + * A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + */ + ClientRequestToken?: ClientRequestToken; + /** + * Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. + */ + EnableTerminationProtection?: EnableTerminationProtection; + } + export interface CreateStackInstancesInput { + /** + * The name or unique ID of the stack set that you want to create stack instances from. + */ + StackSetName: StackSetName; + /** + * The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for. + */ + Accounts: AccountList; + /** + * The names of one or more regions where you want to create stack instances using the specified AWS account(s). + */ + Regions: RegionList; + /** + * A list of stack set parameters whose values you want to override in the selected stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations: To override the current value for a parameter, include the parameter and specify its value. To leave a parameter set to its present value, you can do one of the following: Do not include the parameter in the list. Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.) To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters. To leave all parameters set to their present values, do not specify this property at all. During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value. You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. + */ + ParameterOverrides?: Parameters; + /** + * Preferences for how AWS CloudFormation performs this stack set operation. + */ + OperationPreferences?: StackSetOperationPreferences; + /** + * The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED. + */ + OperationId?: ClientRequestToken; + } + export interface CreateStackInstancesOutput { + /** + * The unique identifier for this stack set operation. + */ + OperationId?: ClientRequestToken; + } + export interface CreateStackOutput { + /** + * Unique identifier of the stack. + */ + StackId?: StackId; + } + export interface CreateStackSetInput { + /** + * The name to associate with the stack set. The name must be unique in the region where you create your stack set. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. + */ + StackSetName: StackSetName; + /** + * A description of the stack set. You can use the description to identify the stack set's purpose or other important information. + */ + Description?: Description; + /** + * The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. + */ + TemplateBody?: TemplateBody; + /** + * The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. + */ + TemplateURL?: TemplateURL; + /** + * The input parameters for the stack set template. + */ + Parameters?: Parameters; + /** + * In some cases, you must explicity acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail. + */ + Capabilities?: Capabilities; + /** + * The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified. If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created. + */ + Tags?: Tags; + /** + * The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide. + */ + AdministrationRoleARN?: RoleARN; + /** + * The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. + */ + ExecutionRoleName?: ExecutionRoleName; + /** + * A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface CreateStackSetOutput { + /** + * The ID of the stack set that you're creating. + */ + StackSetId?: StackSetId; + } + export type CreationTime = Date; + export interface DeleteChangeSetInput { + /** + * The name or Amazon Resource Name (ARN) of the change set that you want to delete. + */ + ChangeSetName: ChangeSetNameOrId; + /** + * If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it. + */ + StackName?: StackNameOrId; + } + export interface DeleteChangeSetOutput { + } + export interface DeleteStackInput { + /** + * The name or the unique stack ID that is associated with the stack. + */ + StackName: StackName; + /** + * For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources. Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack. + */ + RetainResources?: RetainResources; + /** + * 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. 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. + */ + RoleARN?: RoleARN; + /** + * A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface DeleteStackInstancesInput { + /** + * The name or unique ID of the stack set that you want to delete stack instances for. + */ + StackSetName: StackSetName; + /** + * The names of the AWS accounts that you want to delete stack instances for. + */ + Accounts: AccountList; + /** + * The regions where you want to delete stack set instances. + */ + Regions: RegionList; + /** + * Preferences for how AWS CloudFormation performs this stack set operation. + */ + OperationPreferences?: StackSetOperationPreferences; + /** + * Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. For more information, see Stack set operation options. + */ + RetainStacks: RetainStacks; + /** + * The unique identifier for this stack set operation. If you don't specify an operation ID, the SDK generates one automatically. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED. + */ + OperationId?: ClientRequestToken; + } + export interface DeleteStackInstancesOutput { + /** + * The unique identifier for this stack set operation. + */ + OperationId?: ClientRequestToken; + } + export interface DeleteStackSetInput { + /** + * The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets. + */ + StackSetName: StackSetName; + } + export interface DeleteStackSetOutput { + } + export type DeletionTime = Date; + export interface DescribeAccountLimitsInput { + /** + * A string that identifies the next page of limits that you want to retrieve. + */ + NextToken?: NextToken; + } + export interface DescribeAccountLimitsOutput { + /** + * An account limit structure that contain a list of AWS CloudFormation account limits and their values. + */ + AccountLimits?: AccountLimitList; + /** + * If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null. + */ + NextToken?: NextToken; + } + export interface DescribeChangeSetInput { + /** + * The name or Amazon Resource Name (ARN) of the change set that you want to describe. + */ + ChangeSetName: ChangeSetNameOrId; + /** + * If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe. + */ + StackName?: StackNameOrId; + /** + * A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve. + */ + NextToken?: NextToken; + } + export interface DescribeChangeSetOutput { + /** + * The name of the change set. + */ + ChangeSetName?: ChangeSetName; + /** + * The ARN of the change set. + */ + ChangeSetId?: ChangeSetId; + /** + * The ARN of the stack that is associated with the change set. + */ + StackId?: StackId; + /** + * The name of the stack that is associated with the change set. + */ + StackName?: StackName; + /** + * Information about the change set. + */ + Description?: Description; + /** + * A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type. + */ + Parameters?: Parameters; + /** + * The start time when the change set was created, in UTC. + */ + CreationTime?: CreationTime; + /** + * If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated. + */ + ExecutionStatus?: ExecutionStatus; + /** + * The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED. + */ + Status?: ChangeSetStatus; + /** + * A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message. + */ + StatusReason?: ChangeSetStatusReason; + /** + * The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set. + */ + NotificationARNs?: NotificationARNs; + /** + * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. + */ + RollbackConfiguration?: RollbackConfiguration; + /** + * If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created. + */ + Capabilities?: Capabilities; + /** + * If you execute the change set, the tags that will be associated with the stack. + */ + Tags?: Tags; + /** + * A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set. + */ + Changes?: Changes; + /** + * If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null. + */ + NextToken?: NextToken; + } + export interface DescribeStackDriftDetectionStatusInput { + /** + * The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary. + */ + StackDriftDetectionId: StackDriftDetectionId; + } + export interface DescribeStackDriftDetectionStatusOutput { + /** + * The ID of the stack. + */ + StackId: StackId; + /** + * The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary. + */ + StackDriftDetectionId: StackDriftDetectionId; + /** + * Status of the stack's actual configuration compared to its expected configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use. + */ + StackDriftStatus?: StackDriftStatus; + /** + * The status of the stack drift detection operation. DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.) If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift. DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection. DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress. + */ + DetectionStatus: StackDriftDetectionStatus; + /** + * The reason the stack drift detection operation has its current status. + */ + DetectionStatusReason?: StackDriftDetectionStatusReason; + /** + * Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC. + */ + DriftedStackResourceCount?: BoxedInteger; + /** + * Time at which the stack drift detection operation was initiated. + */ + Timestamp: Timestamp; + } + export interface DescribeStackEventsInput { + /** + * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. + */ + StackName?: StackName; + /** + * A string that identifies the next page of events that you want to retrieve. + */ + NextToken?: NextToken; + } + export interface DescribeStackEventsOutput { + /** + * A list of StackEvents structures. + */ + StackEvents?: StackEvents; + /** + * If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null. + */ + NextToken?: NextToken; + } + export interface DescribeStackInstanceInput { + /** + * The name or the unique stack ID of the stack set that you want to get stack instance information for. + */ + StackSetName: StackSetName; + /** + * The ID of an AWS account that's associated with this stack instance. + */ + StackInstanceAccount: Account; + /** + * The name of a region that's associated with this stack instance. + */ + StackInstanceRegion: Region; + } + export interface DescribeStackInstanceOutput { + /** + * The stack instance that matches the specified request parameters. + */ + StackInstance?: StackInstance; + } + export interface DescribeStackResourceDriftsInput { + /** + * The name of the stack for which you want drift information. + */ + StackName: StackNameOrId; + /** + * The resource drift status values to use as filters for the resource drift results returned. DELETED: The resource differs from its expected template configuration in that the resource has been deleted. MODIFIED: One or more resource properties differ from their expected template values. IN_SYNC: The resources's actual configuration matches its expected template configuration. NOT_CHECKED: AWS CloudFormation does not currently return this value. + */ + StackResourceDriftStatusFilters?: StackResourceDriftStatusFilters; + /** + * A string that identifies the next page of stack resource drift results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. + */ + MaxResults?: BoxedMaxResults; + } + export interface DescribeStackResourceDriftsOutput { + /** + * Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. + */ + StackResourceDrifts: StackResourceDrifts; + /** + * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null. + */ + NextToken?: NextToken; + } + export interface DescribeStackResourceInput { + /** + * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. + */ + StackName: StackName; + /** + * The logical name of the resource as specified in the template. Default: There is no default value. + */ + LogicalResourceId: LogicalResourceId; + } + export interface DescribeStackResourceOutput { + /** + * A StackResourceDetail structure containing the description of the specified resource in the specified stack. + */ + StackResourceDetail?: StackResourceDetail; + } + export interface DescribeStackResourcesInput { + /** + * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId. + */ + StackName?: StackName; + /** + * The logical name of the resource as specified in the template. Default: There is no default value. + */ + LogicalResourceId?: LogicalResourceId; + /** + * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack. Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName. Default: There is no default value. + */ + PhysicalResourceId?: PhysicalResourceId; + } + export interface DescribeStackResourcesOutput { + /** + * A list of StackResource structures. + */ + StackResources?: StackResources; + } + export interface DescribeStackSetInput { + /** + * The name or unique ID of the stack set whose description you want. + */ + StackSetName: StackSetName; + } + export interface DescribeStackSetOperationInput { + /** + * The name or the unique stack ID of the stack set for the stack operation. + */ + StackSetName: StackSetName; + /** + * The unique ID of the stack set operation. + */ + OperationId: ClientRequestToken; + } + export interface DescribeStackSetOperationOutput { + /** + * The specified stack set operation. + */ + StackSetOperation?: StackSetOperation; + } + export interface DescribeStackSetOutput { + /** + * The specified stack set. + */ + StackSet?: StackSet; + } + export interface DescribeStacksInput { + /** + * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. + */ + StackName?: StackName; + /** + * A string that identifies the next page of stacks that you want to retrieve. + */ + NextToken?: NextToken; + } + export interface DescribeStacksOutput { + /** + * A list of stack structures. + */ + Stacks?: Stacks; + /** + * If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null. + */ + NextToken?: NextToken; + } + export type Description = string; + export interface DetectStackDriftInput { + /** + * The name of the stack for which you want to detect drift. + */ + StackName: StackNameOrId; + /** + * The logical names of any resources you want to use as filters. + */ + LogicalResourceIds?: LogicalResourceIds; + } + export interface DetectStackDriftOutput { + /** + * The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary. + */ + StackDriftDetectionId: StackDriftDetectionId; + } + export interface DetectStackResourceDriftInput { + /** + * The name of the stack to which the resource belongs. + */ + StackName: StackNameOrId; + /** + * The logical name of the resource for which to return drift information. + */ + LogicalResourceId: LogicalResourceId; + } + export interface DetectStackResourceDriftOutput { + /** + * Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected. + */ + StackResourceDrift: StackResourceDrift; + } + export type DifferenceType = "ADD"|"REMOVE"|"NOT_EQUAL"|string; + export type DisableRollback = boolean; + export type EnableTerminationProtection = boolean; + export interface EstimateTemplateCostInput { + /** + * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used. + */ + TemplateBody?: TemplateBody; + /** + * Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used. + */ + TemplateURL?: TemplateURL; + /** + * A list of Parameter structures that specify input parameters. + */ + Parameters?: Parameters; + } + export interface EstimateTemplateCostOutput { + /** + * An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. + */ + Url?: Url; + } + export type EvaluationType = "Static"|"Dynamic"|string; + export type EventId = string; + export interface ExecuteChangeSetInput { + /** + * The name or ARN of the change set that you want use to update the specified stack. + */ + ChangeSetName: ChangeSetNameOrId; + /** + * If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute. + */ + StackName?: StackNameOrId; + /** + * A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface ExecuteChangeSetOutput { + } + export type ExecutionRoleName = string; + export type ExecutionStatus = "UNAVAILABLE"|"AVAILABLE"|"EXECUTE_IN_PROGRESS"|"EXECUTE_COMPLETE"|"EXECUTE_FAILED"|"OBSOLETE"|string; + export interface Export { + /** + * The stack that contains the exported output name and value. + */ + ExportingStackId?: StackId; + /** + * The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section. + */ + Name?: ExportName; + /** + * The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section. + */ + Value?: ExportValue; + } + export type ExportName = string; + export type ExportValue = string; + export type Exports = Export[]; + export type FailureToleranceCount = number; + export type FailureTolerancePercentage = number; + export interface GetStackPolicyInput { + /** + * The name or unique stack ID that is associated with the stack whose policy you want to get. + */ + StackName: StackName; + } + export interface GetStackPolicyOutput { + /** + * Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.) + */ + StackPolicyBody?: StackPolicyBody; + } + export interface GetTemplateInput { + /** + * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. + */ + StackName?: StackName; + /** + * The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName. + */ + ChangeSetName?: ChangeSetNameOrId; + /** + * For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed. If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original. + */ + TemplateStage?: TemplateStage; + } + export interface GetTemplateOutput { + /** + * Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) AWS CloudFormation returns the same template that was used when the stack was created. + */ + TemplateBody?: TemplateBody; + /** + * The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available. + */ + StagesAvailable?: StageList; + } + export interface GetTemplateSummaryInput { + /** + * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL. + */ + TemplateBody?: TemplateBody; + /** + * Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL. + */ + TemplateURL?: TemplateURL; + /** + * The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL. + */ + StackName?: StackNameOrId; + /** + * The name or unique ID of the stack set from which the stack was created. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL. + */ + StackSetName?: StackSetNameOrId; + } + export interface GetTemplateSummaryOutput { + /** + * A list of parameter declarations that describe various properties for each parameter. + */ + Parameters?: ParameterDeclarations; + /** + * The value that is defined in the Description property of the template. + */ + Description?: Description; + /** + * The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. + */ + Capabilities?: Capabilities; + /** + * The list of resources that generated the values in the Capabilities response element. + */ + CapabilitiesReason?: CapabilitiesReason; + /** + * A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance. + */ + ResourceTypes?: ResourceTypes; + /** + * The AWS template format version, which identifies the capabilities of the template. + */ + Version?: Version; + /** + * The value that is defined for the Metadata property of the template. + */ + Metadata?: Metadata; + /** + * A list of the transforms that are declared in the template. + */ + DeclaredTransforms?: TransformsList; + } + export type Imports = StackName[]; + export type Key = string; + export type LastUpdatedTime = Date; + export type LimitName = string; + export type LimitValue = number; + export interface ListChangeSetsInput { + /** + * The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets. + */ + StackName: StackNameOrId; + /** + * A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve. + */ + NextToken?: NextToken; + } + export interface ListChangeSetsOutput { + /** + * A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack. + */ + Summaries?: ChangeSetSummaries; + /** + * If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null. + */ + NextToken?: NextToken; + } + export interface ListExportsInput { + /** + * A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve. + */ + NextToken?: NextToken; + } + export interface ListExportsOutput { + /** + * The output for the ListExports action. + */ + Exports?: Exports; + /** + * If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null. + */ + NextToken?: NextToken; + } + export interface ListImportsInput { + /** + * The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value. + */ + ExportName: ExportName; + /** + * A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value. + */ + NextToken?: NextToken; + } + export interface ListImportsOutput { + /** + * A list of stack names that are importing the specified exported output value. + */ + Imports?: Imports; + /** + * A string that identifies the next page of exports. If there is no additional page, this value is null. + */ + NextToken?: NextToken; + } + export interface ListStackInstancesInput { + /** + * The name or unique ID of the stack set that you want to list stack instances for. + */ + StackSetName: StackSetName; + /** + * If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The name of the AWS account that you want to list stack instances for. + */ + StackInstanceAccount?: Account; + /** + * The name of the region where you want to list stack instances. + */ + StackInstanceRegion?: Region; + } + export interface ListStackInstancesOutput { + /** + * A list of StackInstanceSummary structures that contain information about the specified stack instances. + */ + Summaries?: StackInstanceSummaries; + /** + * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null. + */ + NextToken?: NextToken; + } + export interface ListStackResourcesInput { + /** + * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. + */ + StackName: StackName; + /** + * A string that identifies the next page of stack resources that you want to retrieve. + */ + NextToken?: NextToken; + } + export interface ListStackResourcesOutput { + /** + * A list of StackResourceSummary structures. + */ + StackResourceSummaries?: StackResourceSummaries; + /** + * If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null. + */ + NextToken?: NextToken; + } + export interface ListStackSetOperationResultsInput { + /** + * The name or unique ID of the stack set that you want to get operation results for. + */ + StackSetName: StackSetName; + /** + * The ID of the stack set operation. + */ + OperationId: ClientRequestToken; + /** + * If the previous request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface ListStackSetOperationResultsOutput { + /** + * A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and regions that are included in the operation. + */ + Summaries?: StackSetOperationResultSummaries; + /** + * If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null. + */ + NextToken?: NextToken; + } + export interface ListStackSetOperationsInput { + /** + * The name or unique ID of the stack set that you want to get operation summaries for. + */ + StackSetName: StackSetName; + /** + * If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface ListStackSetOperationsOutput { + /** + * A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set. + */ + Summaries?: StackSetOperationSummaries; + /** + * If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null. + */ + NextToken?: NextToken; + } + export interface ListStackSetsInput { + /** + * If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The status of the stack sets that you want to get summary information about. + */ + Status?: StackSetStatus; + } + export interface ListStackSetsOutput { + /** + * A list of StackSetSummary structures that contain information about the user's stack sets. + */ + Summaries?: StackSetSummaries; + /** + * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null. + */ + NextToken?: NextToken; + } + export interface ListStacksInput { + /** + * A string that identifies the next page of stacks that you want to retrieve. + */ + NextToken?: NextToken; + /** + * Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type. + */ + StackStatusFilter?: StackStatusFilter; + } + export interface ListStacksOutput { + /** + * A list of StackSummary structures containing information about the specified stacks. + */ + StackSummaries?: StackSummaries; + /** + * If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null. + */ + NextToken?: NextToken; + } + export type LogicalResourceId = string; + export type LogicalResourceIds = LogicalResourceId[]; + export type MaxConcurrentCount = number; + export type MaxConcurrentPercentage = number; + export type MaxResults = number; + export type Metadata = string; + export type MonitoringTimeInMinutes = number; + export type NextToken = string; + export type NoEcho = boolean; + export type NotificationARN = string; + export type NotificationARNs = NotificationARN[]; + export type OnFailure = "DO_NOTHING"|"ROLLBACK"|"DELETE"|string; + export interface Output { + /** + * The key associated with the output. + */ + OutputKey?: OutputKey; + /** + * The value associated with the output. + */ + OutputValue?: OutputValue; + /** + * User defined description associated with the output. + */ + Description?: Description; + /** + * The name of the export associated with the output. + */ + ExportName?: ExportName; + } + export type OutputKey = string; + export type OutputValue = string; + export type Outputs = Output[]; + export interface Parameter { + /** + * The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template. + */ + ParameterKey?: ParameterKey; + /** + * The input value associated with the parameter. + */ + ParameterValue?: ParameterValue; + /** + * During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value. + */ + UsePreviousValue?: UsePreviousValue; + /** + * Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template. + */ + ResolvedValue?: ParameterValue; + } + export interface ParameterConstraints { + /** + * A list of values that are permitted for a parameter. + */ + AllowedValues?: AllowedValues; + } + export interface ParameterDeclaration { + /** + * The name that is associated with the parameter. + */ + ParameterKey?: ParameterKey; + /** + * The default value of the parameter. + */ + DefaultValue?: ParameterValue; + /** + * The type of parameter. + */ + ParameterType?: ParameterType; + /** + * Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console. + */ + NoEcho?: NoEcho; + /** + * The description that is associate with the parameter. + */ + Description?: Description; + /** + * The criteria that AWS CloudFormation uses to validate parameter values. + */ + ParameterConstraints?: ParameterConstraints; + } + export type ParameterDeclarations = ParameterDeclaration[]; + export type ParameterKey = string; + export type ParameterType = string; + export type ParameterValue = string; + export type Parameters = Parameter[]; + export type PhysicalResourceId = string; + export type PhysicalResourceIdContext = PhysicalResourceIdContextKeyValuePair[]; + export interface PhysicalResourceIdContextKeyValuePair { + /** + * The resource context key. + */ + Key: Key; + /** + * The resource context value. + */ + Value: Value; + } + export type Properties = string; + export interface PropertyDifference { + /** + * The fully-qualified path to the resource property. + */ + PropertyPath: PropertyPath; + /** + * The expected property value of the resource property, as defined in the stack template and any values specified as template parameters. + */ + ExpectedValue: PropertyValue; + /** + * The actual property value of the resource property. + */ + ActualValue: PropertyValue; + /** + * The type of property difference. ADD: A value has been added to a resource property that is an array or list data type. REMOVE: The property has been removed from the current resource configuration. NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters). + */ + DifferenceType: DifferenceType; + } + export type PropertyDifferences = PropertyDifference[]; + export type PropertyName = string; + export type PropertyPath = string; + export type PropertyValue = string; + export type Reason = string; + export type Region = string; + export type RegionList = Region[]; + export type Replacement = "True"|"False"|"Conditional"|string; + export type RequiresRecreation = "Never"|"Conditionally"|"Always"|string; + export type ResourceAttribute = "Properties"|"Metadata"|"CreationPolicy"|"UpdatePolicy"|"DeletionPolicy"|"Tags"|string; + export interface ResourceChange { + /** + * The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource). + */ + Action?: ChangeAction; + /** + * The resource's logical ID, which is defined in the stack's template. + */ + LogicalResourceId?: LogicalResourceId; + /** + * The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created. + */ + PhysicalResourceId?: PhysicalResourceId; + /** + * The type of AWS CloudFormation resource, such as AWS::S3::Bucket. + */ + ResourceType?: ResourceType; + /** + * For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally. If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never. + */ + Replacement?: Replacement; + /** + * For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags. + */ + Scope?: Scope; + /** + * For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource. + */ + Details?: ResourceChangeDetails; + } + export interface ResourceChangeDetail { + /** + * A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated. + */ + Target?: ResourceTargetDefinition; + /** + * Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set. For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation. For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated. + */ + Evaluation?: EvaluationType; + /** + * The group to which the CausingEntity value belongs. There are five entity groups: ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }. ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }. ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }. DirectModification entities are changes that are made directly to the template. Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack. + */ + ChangeSource?: ChangeSource; + /** + * The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName). If the ChangeSource value is DirectModification, no value is given for CausingEntity. + */ + CausingEntity?: CausingEntity; + } + export type ResourceChangeDetails = ResourceChangeDetail[]; + export type ResourceProperties = string; + export type ResourceSignalStatus = "SUCCESS"|"FAILURE"|string; + export type ResourceSignalUniqueId = string; + export type ResourceStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"DELETE_SKIPPED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"UPDATE_COMPLETE"|string; + export type ResourceStatusReason = string; + export interface ResourceTargetDefinition { + /** + * Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags. + */ + Attribute?: ResourceAttribute; + /** + * If the Attribute value is Properties, the name of the property. For all other attributes, the value is null. + */ + Name?: PropertyName; + /** + * If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide. + */ + RequiresRecreation?: RequiresRecreation; + } + export type ResourceToSkip = string; + export type ResourceType = string; + export type ResourceTypes = ResourceType[]; + export type ResourcesToSkip = ResourceToSkip[]; + export type RetainResources = LogicalResourceId[]; + export type RetainStacks = boolean; + export type RetainStacksNullable = boolean; + export type RoleARN = string; + export interface RollbackConfiguration { + /** + * The triggers to monitor during stack creation or update actions. 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: To use the rollback triggers previously specified for this stack, if any, don't specify this parameter. To specify new or updated rollback triggers, 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. To remove all currently specified triggers, specify an empty list for this parameter. If a specified trigger is missing, the entire stack operation fails and is rolled back. + */ + RollbackTriggers?: RollbackTriggers; + /** + * 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. The default is 0 minutes. 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 CancelUpdateStack, for example) as necessary. 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. + */ + MonitoringTimeInMinutes?: MonitoringTimeInMinutes; + } + export interface RollbackTrigger { + /** + * The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger is missing, the entire stack operation fails and is rolled back. + */ + Arn: Arn; + /** + * The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type. + */ + Type: Type; + } + export type RollbackTriggers = RollbackTrigger[]; + export type Scope = ResourceAttribute[]; + export interface SetStackPolicyInput { + /** + * The name or unique stack ID that you want to associate a policy with. + */ + StackName: StackName; + /** + * Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. + */ + StackPolicyBody?: StackPolicyBody; + /** + * Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. + */ + StackPolicyURL?: StackPolicyURL; + } + export interface SignalResourceInput { + /** + * The stack name or unique stack ID that includes the resource that you want to signal. + */ + StackName: StackNameOrId; + /** + * The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template. + */ + LogicalResourceId: LogicalResourceId; + /** + * A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. + */ + UniqueId: ResourceSignalUniqueId; + /** + * The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update. + */ + Status: ResourceSignalStatus; + } + export interface Stack { + /** + * Unique identifier of the stack. + */ + StackId?: StackId; + /** + * The name associated with the stack. + */ + StackName: StackName; + /** + * The unique ID of the change set. + */ + ChangeSetId?: ChangeSetId; + /** + * A user-defined description associated with the stack. + */ + Description?: Description; + /** + * A list of Parameter structures. + */ + Parameters?: Parameters; + /** + * The time at which the stack was created. + */ + CreationTime: CreationTime; + /** + * The time the stack was deleted. + */ + DeletionTime?: DeletionTime; + /** + * The time the stack was last updated. This field will only be returned if the stack has been updated at least once. + */ + LastUpdatedTime?: LastUpdatedTime; + /** + * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. + */ + RollbackConfiguration?: RollbackConfiguration; + /** + * Current status of the stack. + */ + StackStatus: StackStatus; + /** + * Success/failure message associated with the stack status. + */ + StackStatusReason?: StackStatusReason; + /** + * Boolean to enable or disable rollback on stack creation failures: true: disable rollback false: enable rollback + */ + DisableRollback?: DisableRollback; + /** + * SNS topic ARNs to which stack related events are published. + */ + NotificationARNs?: NotificationARNs; + /** + * The amount of time within which stack creation should complete. + */ + TimeoutInMinutes?: TimeoutMinutes; + /** + * The capabilities allowed in the stack. + */ + Capabilities?: Capabilities; + /** + * A list of output structures. + */ + Outputs?: Outputs; + /** + * 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. + */ + RoleARN?: RoleARN; + /** + * A list of Tags that specify information about the stack. + */ + Tags?: Tags; + /** + * Whether termination protection is enabled for the stack. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. + */ + EnableTerminationProtection?: EnableTerminationProtection; + /** + * For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide. + */ + ParentId?: StackId; + /** + * For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide. + */ + RootId?: StackId; + /** + * Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. + */ + DriftInformation?: StackDriftInformation; + } + export type StackDriftDetectionId = string; + export type StackDriftDetectionStatus = "DETECTION_IN_PROGRESS"|"DETECTION_FAILED"|"DETECTION_COMPLETE"|string; + export type StackDriftDetectionStatusReason = string; + export interface StackDriftInformation { + /** + * Status of the stack's actual configuration compared to its expected template configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use. + */ + StackDriftStatus: StackDriftStatus; + /** + * Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection. + */ + LastCheckTimestamp?: Timestamp; + } + export interface StackDriftInformationSummary { + /** + * Status of the stack's actual configuration compared to its expected template configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use. + */ + StackDriftStatus: StackDriftStatus; + /** + * Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection. + */ + LastCheckTimestamp?: Timestamp; + } + export type StackDriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED"|string; + export interface StackEvent { + /** + * The unique ID name of the instance of the stack. + */ + StackId: StackId; + /** + * The unique ID of this event. + */ + EventId: EventId; + /** + * The name associated with a stack. + */ + StackName: StackName; + /** + * The logical name of the resource specified in the template. + */ + LogicalResourceId?: LogicalResourceId; + /** + * The name or unique identifier associated with the physical instance of the resource. + */ + PhysicalResourceId?: PhysicalResourceId; + /** + * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) + */ + ResourceType?: ResourceType; + /** + * Time the status was updated. + */ + Timestamp: Timestamp; + /** + * Current status of the resource. + */ + ResourceStatus?: ResourceStatus; + /** + * Success/failure message associated with the resource. + */ + ResourceStatusReason?: ResourceStatusReason; + /** + * BLOB of the properties used to create the resource. + */ + ResourceProperties?: ResourceProperties; + /** + * The token passed to the operation that generated this event. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + */ + ClientRequestToken?: ClientRequestToken; + } + export type StackEvents = StackEvent[]; + export type StackId = string; + export interface StackInstance { + /** + * The name or unique ID of the stack set that the stack instance is associated with. + */ + StackSetId?: StackSetId; + /** + * The name of the AWS region that the stack instance is associated with. + */ + Region?: Region; + /** + * The name of the AWS account that the stack instance is associated with. + */ + Account?: Account; + /** + * The ID of the stack instance. + */ + StackId?: StackId; + /** + * A list of parameters from the stack set template whose values have been overridden in this stack instance. + */ + ParameterOverrides?: Parameters; + /** + * The status of the stack instance, in terms of its synchronization with its associated stack set. INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. OUTDATED: The stack isn't currently up to date with the stack set because: The associated stack failed during a CreateStackSet or UpdateStackSet operation. The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set. + */ + Status?: StackInstanceStatus; + /** + * The explanation for the specific status code that is assigned to this stack instance. + */ + StatusReason?: Reason; + } + export type StackInstanceStatus = "CURRENT"|"OUTDATED"|"INOPERABLE"|string; + export type StackInstanceSummaries = StackInstanceSummary[]; + export interface StackInstanceSummary { + /** + * The name or unique ID of the stack set that the stack instance is associated with. + */ + StackSetId?: StackSetId; + /** + * The name of the AWS region that the stack instance is associated with. + */ + Region?: Region; + /** + * The name of the AWS account that the stack instance is associated with. + */ + Account?: Account; + /** + * The ID of the stack instance. + */ + StackId?: StackId; + /** + * The status of the stack instance, in terms of its synchronization with its associated stack set. INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. OUTDATED: The stack isn't currently up to date with the stack set because: The associated stack failed during a CreateStackSet or UpdateStackSet operation. The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set. + */ + Status?: StackInstanceStatus; + /** + * The explanation for the specific status code assigned to this stack instance. + */ + StatusReason?: Reason; + } + export type StackName = string; + export type StackNameOrId = string; + export type StackPolicyBody = string; + export type StackPolicyDuringUpdateBody = string; + export type StackPolicyDuringUpdateURL = string; + export type StackPolicyURL = string; + export interface StackResource { + /** + * The name associated with the stack. + */ + StackName?: StackName; + /** + * Unique identifier of the stack. + */ + StackId?: StackId; + /** + * The logical name of the resource specified in the template. + */ + LogicalResourceId: LogicalResourceId; + /** + * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. + */ + PhysicalResourceId?: PhysicalResourceId; + /** + * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) + */ + ResourceType: ResourceType; + /** + * Time the status was updated. + */ + Timestamp: Timestamp; + /** + * Current status of the resource. + */ + ResourceStatus: ResourceStatus; + /** + * Success/failure message associated with the resource. + */ + ResourceStatusReason?: ResourceStatusReason; + /** + * User defined description associated with the resource. + */ + Description?: Description; + /** + * Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. + */ + DriftInformation?: StackResourceDriftInformation; + } + export interface StackResourceDetail { + /** + * The name associated with the stack. + */ + StackName?: StackName; + /** + * Unique identifier of the stack. + */ + StackId?: StackId; + /** + * The logical name of the resource specified in the template. + */ + LogicalResourceId: LogicalResourceId; + /** + * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. + */ + PhysicalResourceId?: PhysicalResourceId; + /** + * Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) + */ + ResourceType: ResourceType; + /** + * Time the status was updated. + */ + LastUpdatedTimestamp: Timestamp; + /** + * Current status of the resource. + */ + ResourceStatus: ResourceStatus; + /** + * Success/failure message associated with the resource. + */ + ResourceStatusReason?: ResourceStatusReason; + /** + * User defined description associated with the resource. + */ + Description?: Description; + /** + * The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide. + */ + Metadata?: Metadata; + /** + * Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. + */ + DriftInformation?: StackResourceDriftInformation; + } + export interface StackResourceDrift { + /** + * The ID of the stack. + */ + StackId: StackId; + /** + * The logical name of the resource specified in the template. + */ + LogicalResourceId: LogicalResourceId; + /** + * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. + */ + PhysicalResourceId?: PhysicalResourceId; + /** + * Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource. + */ + PhysicalResourceIdContext?: PhysicalResourceIdContext; + /** + * The type of the resource. + */ + ResourceType: ResourceType; + /** + * A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters. For resources whose StackResourceDriftStatus is DELETED, this structure will not be present. + */ + ExpectedProperties?: Properties; + /** + * A JSON structure containing the actual property values of the stack resource. For resources whose StackResourceDriftStatus is DELETED, this structure will not be present. + */ + ActualProperties?: Properties; + /** + * A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. + */ + PropertyDifferences?: PropertyDifferences; + /** + * Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected template configuration because the resource has been deleted. MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters). IN_SYNC: The resources's actual configuration matches its expected template configuration. NOT_CHECKED: AWS CloudFormation does not currently return this value. + */ + StackResourceDriftStatus: StackResourceDriftStatus; + /** + * Time at which AWS CloudFormation performed drift detection on the stack resource. + */ + Timestamp: Timestamp; + } + export interface StackResourceDriftInformation { + /** + * Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. IN_SYNC: The resources's actual configuration matches its expected configuration. + */ + StackResourceDriftStatus: StackResourceDriftStatus; + /** + * When AWS CloudFormation last checked if the resource had drifted from its expected configuration. + */ + LastCheckTimestamp?: Timestamp; + } + export interface StackResourceDriftInformationSummary { + /** + * Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the AWS CloudFormation User Guide. IN_SYNC: The resources's actual configuration matches its expected configuration. + */ + StackResourceDriftStatus: StackResourceDriftStatus; + /** + * When AWS CloudFormation last checked if the resource had drifted from its expected configuration. + */ + LastCheckTimestamp?: Timestamp; + } + export type StackResourceDriftStatus = "IN_SYNC"|"MODIFIED"|"DELETED"|"NOT_CHECKED"|string; + export type StackResourceDriftStatusFilters = StackResourceDriftStatus[]; + export type StackResourceDrifts = StackResourceDrift[]; + export type StackResourceSummaries = StackResourceSummary[]; + export interface StackResourceSummary { + /** + * The logical name of the resource specified in the template. + */ + LogicalResourceId: LogicalResourceId; + /** + * The name or unique identifier that corresponds to a physical instance ID of the resource. + */ + PhysicalResourceId?: PhysicalResourceId; + /** + * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) + */ + ResourceType: ResourceType; + /** + * Time the status was updated. + */ + LastUpdatedTimestamp: Timestamp; + /** + * Current status of the resource. + */ + ResourceStatus: ResourceStatus; + /** + * Success/failure message associated with the resource. + */ + ResourceStatusReason?: ResourceStatusReason; + /** + * Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. + */ + DriftInformation?: StackResourceDriftInformationSummary; + } + export type StackResources = StackResource[]; + export interface StackSet { + /** + * The name that's associated with the stack set. + */ + StackSetName?: StackSetName; + /** + * The ID of the stack set. + */ + StackSetId?: StackSetId; + /** + * A description of the stack set that you specify when the stack set is created or updated. + */ + Description?: Description; + /** + * The status of the stack set. + */ + Status?: StackSetStatus; + /** + * The structure that contains the body of the template that was used to create or update the stack set. + */ + TemplateBody?: TemplateBody; + /** + * A list of input parameters for a stack set. + */ + Parameters?: Parameters; + /** + * The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. + */ + Capabilities?: Capabilities; + /** + * A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified. + */ + Tags?: Tags; + /** + * The Amazon Resource Number (ARN) of the stack set. + */ + StackSetARN?: StackSetARN; + /** + * The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide. + */ + AdministrationRoleARN?: RoleARN; + /** + * The name of the IAM execution role used to create or update the stack set. Use customized execution roles to control which stack resources users and groups can include in their stack sets. + */ + ExecutionRoleName?: ExecutionRoleName; + } + export type StackSetARN = string; + export type StackSetId = string; + export type StackSetName = string; + export type StackSetNameOrId = string; + export interface StackSetOperation { + /** + * The unique ID of a stack set operation. + */ + OperationId?: ClientRequestToken; + /** + * The ID of the stack set. + */ + StackSetId?: StackSetId; + /** + * The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances. + */ + Action?: StackSetOperationAction; + /** + * The status of the operation. FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions. RUNNING: The operation is currently being performed. STOPPED: The user has cancelled the operation. STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation. + */ + Status?: StackSetOperationStatus; + /** + * The preferences for how AWS CloudFormation performs this stack set operation. + */ + OperationPreferences?: StackSetOperationPreferences; + /** + * For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set. + */ + RetainStacks?: RetainStacksNullable; + /** + * The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide. + */ + AdministrationRoleARN?: RoleARN; + /** + * The name of the IAM execution role used to create or update the stack set. Use customized execution roles to control which stack resources users and groups can include in their stack sets. + */ + ExecutionRoleName?: ExecutionRoleName; + /** + * The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks. + */ + CreationTimestamp?: Timestamp; + /** + * The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region. + */ + EndTimestamp?: Timestamp; + } + export type StackSetOperationAction = "CREATE"|"UPDATE"|"DELETE"|string; + export interface StackSetOperationPreferences { + /** + * The order of the regions in where you want to perform the stack operation. + */ + RegionOrder?: RegionList; + /** + * The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both). + */ + FailureToleranceCount?: FailureToleranceCount; + /** + * The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both. + */ + FailureTolerancePercentage?: FailureTolerancePercentage; + /** + * The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount . Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both. + */ + MaxConcurrentCount?: MaxConcurrentCount; + /** + * The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both. + */ + MaxConcurrentPercentage?: MaxConcurrentPercentage; + } + export type StackSetOperationResultStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|string; + export type StackSetOperationResultSummaries = StackSetOperationResultSummary[]; + export interface StackSetOperationResultSummary { + /** + * The name of the AWS account for this operation result. + */ + Account?: Account; + /** + * The name of the AWS region for this operation result. + */ + Region?: Region; + /** + * The result status of the stack set operation for the given account in the given region. CANCELLED: The operation in the specified account and region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. FAILED: The operation in the specified account and region failed. If the stack set operation fails in enough accounts within a region, the failure tolerance for the stack set operation as a whole might be exceeded. RUNNING: The operation in the specified account and region is currently in progress. PENDING: The operation in the specified account and region has yet to start. SUCCEEDED: The operation in the specified account and region completed successfully. + */ + Status?: StackSetOperationResultStatus; + /** + * The reason for the assigned result status. + */ + StatusReason?: Reason; + /** + * The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account + */ + AccountGateResult?: AccountGateResult; + } + export type StackSetOperationStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"STOPPING"|"STOPPED"|string; + export type StackSetOperationSummaries = StackSetOperationSummary[]; + export interface StackSetOperationSummary { + /** + * The unique ID of the stack set operation. + */ + OperationId?: ClientRequestToken; + /** + * The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances. + */ + Action?: StackSetOperationAction; + /** + * The overall status of the operation. FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions. RUNNING: The operation is currently being performed. STOPPED: The user has cancelled the operation. STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation. + */ + Status?: StackSetOperationStatus; + /** + * The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks. + */ + CreationTimestamp?: Timestamp; + /** + * The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region. + */ + EndTimestamp?: Timestamp; + } + export type StackSetStatus = "ACTIVE"|"DELETED"|string; + export type StackSetSummaries = StackSetSummary[]; + export interface StackSetSummary { + /** + * The name of the stack set. + */ + StackSetName?: StackSetName; + /** + * The ID of the stack set. + */ + StackSetId?: StackSetId; + /** + * A description of the stack set that you specify when the stack set is created or updated. + */ + Description?: Description; + /** + * The status of the stack set. + */ + Status?: StackSetStatus; + } + export type StackStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_FAILED"|"ROLLBACK_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_ROLLBACK_IN_PROGRESS"|"UPDATE_ROLLBACK_FAILED"|"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_ROLLBACK_COMPLETE"|"REVIEW_IN_PROGRESS"|string; + export type StackStatusFilter = StackStatus[]; + export type StackStatusReason = string; + export type StackSummaries = StackSummary[]; + export interface StackSummary { + /** + * Unique stack identifier. + */ + StackId?: StackId; + /** + * The name associated with the stack. + */ + StackName: StackName; + /** + * The template description of the template used to create the stack. + */ + TemplateDescription?: TemplateDescription; + /** + * The time the stack was created. + */ + CreationTime: CreationTime; + /** + * The time the stack was last updated. This field will only be returned if the stack has been updated at least once. + */ + LastUpdatedTime?: LastUpdatedTime; + /** + * The time the stack was deleted. + */ + DeletionTime?: DeletionTime; + /** + * The current status of the stack. + */ + StackStatus: StackStatus; + /** + * Success/Failure message associated with the stack status. + */ + StackStatusReason?: StackStatusReason; + /** + * For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide. + */ + ParentId?: StackId; + /** + * For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide. + */ + RootId?: StackId; + /** + * Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. + */ + DriftInformation?: StackDriftInformationSummary; + } + export type Stacks = Stack[]; + export type StageList = TemplateStage[]; + export interface StopStackSetOperationInput { + /** + * The name or unique ID of the stack set that you want to stop the operation for. + */ + StackSetName: StackSetName; + /** + * The ID of the stack operation. + */ + OperationId: ClientRequestToken; + } + export interface StopStackSetOperationOutput { + } + export interface Tag { + /** + * Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:. + */ + Key: TagKey; + /** + * Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagValue = string; + export type Tags = Tag[]; + export type TemplateBody = string; + export type TemplateDescription = string; + export interface TemplateParameter { + /** + * The name associated with the parameter. + */ + ParameterKey?: ParameterKey; + /** + * The default value associated with the parameter. + */ + DefaultValue?: ParameterValue; + /** + * Flag indicating whether the parameter should be displayed as plain text in logs and UIs. + */ + NoEcho?: NoEcho; + /** + * User defined description associated with the parameter. + */ + Description?: Description; + } + export type TemplateParameters = TemplateParameter[]; + export type TemplateStage = "Original"|"Processed"|string; + export type TemplateURL = string; + export type TimeoutMinutes = number; + export type Timestamp = Date; + export type TransformName = string; + export type TransformsList = TransformName[]; + export type Type = string; + export interface UpdateStackInput { + /** + * The name or unique stack ID of the stack to update. + */ + StackName: StackName; + /** + * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true. + */ + TemplateBody?: TemplateBody; + /** + * Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true. + */ + TemplateURL?: TemplateURL; + /** + * Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true. + */ + UsePreviousTemplate?: UsePreviousTemplate; + /** + * Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used. + */ + StackPolicyDuringUpdateBody?: StackPolicyDuringUpdateBody; + /** + * Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used. + */ + StackPolicyDuringUpdateURL?: StackPolicyDuringUpdateURL; + /** + * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type. + */ + Parameters?: Parameters; + /** + * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. Change sets do not currently support nested stacks. If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability. You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs. Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. + */ + Capabilities?: Capabilities; + /** + * The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management. + */ + ResourceTypes?: ResourceTypes; + /** + * 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. 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. + */ + RoleARN?: RoleARN; + /** + * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. + */ + RollbackConfiguration?: RollbackConfiguration; + /** + * Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged. + */ + StackPolicyBody?: StackPolicyBody; + /** + * Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged. + */ + StackPolicyURL?: StackPolicyURL; + /** + * Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics. + */ + NotificationARNs?: NotificationARNs; + /** + * Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags. + */ + Tags?: Tags; + /** + * A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface UpdateStackInstancesInput { + /** + * The name or unique ID of the stack set associated with the stack instances. + */ + StackSetName: StackSetNameOrId; + /** + * The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions. + */ + Accounts: AccountList; + /** + * The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions. + */ + Regions: RegionList; + /** + * A list of input parameters whose values you want to update for the specified stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations: To override the current value for a parameter, include the parameter and specify its value. To leave a parameter set to its present value, you can do one of the following: Do not include the parameter in the list. Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.) To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters. To leave all parameters set to their present values, do not specify this property at all. During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value. You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances. + */ + ParameterOverrides?: Parameters; + /** + * Preferences for how AWS CloudFormation performs this stack set operation. + */ + OperationPreferences?: StackSetOperationPreferences; + /** + * The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. + */ + OperationId?: ClientRequestToken; + } + export interface UpdateStackInstancesOutput { + /** + * The unique identifier for this stack set operation. + */ + OperationId?: ClientRequestToken; + } + export interface UpdateStackOutput { + /** + * Unique identifier of the stack. + */ + StackId?: StackId; + } + export interface UpdateStackSetInput { + /** + * The name or unique ID of the stack set that you want to update. + */ + StackSetName: StackSetName; + /** + * A brief description of updates that you are making. + */ + Description?: Description; + /** + * The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true. + */ + TemplateBody?: TemplateBody; + /** + * The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true. + */ + TemplateURL?: TemplateURL; + /** + * Use the existing template that's associated with the stack set that you're updating. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true. + */ + UsePreviousTemplate?: UsePreviousTemplate; + /** + * A list of input parameters for the stack set template. + */ + Parameters?: Parameters; + /** + * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail. + */ + Capabilities?: Capabilities; + /** + * The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags. If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means: If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well. If you specify an empty value, AWS CloudFormation removes all currently associated tags. If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated. + */ + Tags?: Tags; + /** + * Preferences for how AWS CloudFormation performs this stack set operation. + */ + OperationPreferences?: StackSetOperationPreferences; + /** + * The Amazon Resource Number (ARN) of the IAM role to use to update this stack set. 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 Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide. If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously. + */ + AdministrationRoleARN?: RoleARN; + /** + * The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution 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. + */ + ExecutionRoleName?: ExecutionRoleName; + /** + * The unique ID for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, AWS CloudFormation generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED. + */ + OperationId?: ClientRequestToken; + /** + * The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances. To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties. If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. + */ + Accounts?: AccountList; + /** + * The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances. To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties. If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. + */ + Regions?: RegionList; + } + export interface UpdateStackSetOutput { + /** + * The unique ID for this stack set operation. + */ + OperationId?: ClientRequestToken; + } + export interface UpdateTerminationProtectionInput { + /** + * Whether to enable termination protection on the specified stack. + */ + EnableTerminationProtection: EnableTerminationProtection; + /** + * The name or unique ID of the stack for which you want to set termination protection. + */ + StackName: StackNameOrId; + } + export interface UpdateTerminationProtectionOutput { + /** + * The unique ID of the stack. + */ + StackId?: StackId; + } + export type Url = string; + export type UsePreviousTemplate = boolean; + export type UsePreviousValue = boolean; + export interface ValidateTemplateInput { + /** + * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used. + */ + TemplateBody?: TemplateBody; + /** + * Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used. + */ + TemplateURL?: TemplateURL; + } + export interface ValidateTemplateOutput { + /** + * A list of TemplateParameter structures. + */ + Parameters?: TemplateParameters; + /** + * The description found within the template. + */ + Description?: Description; + /** + * The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. + */ + Capabilities?: Capabilities; + /** + * The list of resources that generated the values in the Capabilities response element. + */ + CapabilitiesReason?: CapabilitiesReason; + /** + * A list of the transforms that are declared in the template. + */ + DeclaredTransforms?: TransformsList; + } + export type Value = string; + export type Version = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2010-05-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudFormation client. + */ + export import Types = CloudFormation; +} +export = CloudFormation; diff --git a/node_modules/aws-sdk/clients/cloudformation.js b/node_modules/aws-sdk/clients/cloudformation.js new file mode 100644 index 0000000..2ab79f2 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudformation.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudformation'] = {}; +AWS.CloudFormation = Service.defineService('cloudformation', ['2010-05-15']); +Object.defineProperty(apiLoader.services['cloudformation'], '2010-05-15', { + get: function get() { + var model = require('../apis/cloudformation-2010-05-15.min.json'); + model.paginators = require('../apis/cloudformation-2010-05-15.paginators.json').pagination; + model.waiters = require('../apis/cloudformation-2010-05-15.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudFormation; diff --git a/node_modules/aws-sdk/clients/cloudfront.d.ts b/node_modules/aws-sdk/clients/cloudfront.d.ts new file mode 100644 index 0000000..56b8f13 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudfront.d.ts @@ -0,0 +1,2612 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {CloudFrontCustomizations} from '../lib/services/cloudfront'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Signer as signer} from '../lib/cloudfront/signer'; +interface Blob {} +declare class CloudFront extends CloudFrontCustomizations { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudFront.Types.ClientConfiguration) + config: Config & CloudFront.Types.ClientConfiguration; + /** + * Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide. + */ + createCloudFrontOriginAccessIdentity(params: CloudFront.Types.CreateCloudFrontOriginAccessIdentityRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateCloudFrontOriginAccessIdentityResult) => void): Request; + /** + * Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide. + */ + createCloudFrontOriginAccessIdentity(callback?: (err: AWSError, data: CloudFront.Types.CreateCloudFrontOriginAccessIdentityResult) => void): Request; + /** + * Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide. If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution. + */ + createDistribution(params: CloudFront.Types.CreateDistributionRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateDistributionResult) => void): Request; + /** + * Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide. If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution. + */ + createDistribution(callback?: (err: AWSError, data: CloudFront.Types.CreateDistributionResult) => void): Request; + /** + * Create a new distribution with tags. + */ + createDistributionWithTags(params: CloudFront.Types.CreateDistributionWithTagsRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateDistributionWithTagsResult) => void): Request; + /** + * Create a new distribution with tags. + */ + createDistributionWithTags(callback?: (err: AWSError, data: CloudFront.Types.CreateDistributionWithTagsResult) => void): Request; + /** + * Create a new field-level encryption configuration. + */ + createFieldLevelEncryptionConfig(params: CloudFront.Types.CreateFieldLevelEncryptionConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateFieldLevelEncryptionConfigResult) => void): Request; + /** + * Create a new field-level encryption configuration. + */ + createFieldLevelEncryptionConfig(callback?: (err: AWSError, data: CloudFront.Types.CreateFieldLevelEncryptionConfigResult) => void): Request; + /** + * Create a field-level encryption profile. + */ + createFieldLevelEncryptionProfile(params: CloudFront.Types.CreateFieldLevelEncryptionProfileRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateFieldLevelEncryptionProfileResult) => void): Request; + /** + * Create a field-level encryption profile. + */ + createFieldLevelEncryptionProfile(callback?: (err: AWSError, data: CloudFront.Types.CreateFieldLevelEncryptionProfileResult) => void): Request; + /** + * Create a new invalidation. + */ + createInvalidation(params: CloudFront.Types.CreateInvalidationRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateInvalidationResult) => void): Request; + /** + * Create a new invalidation. + */ + createInvalidation(callback?: (err: AWSError, data: CloudFront.Types.CreateInvalidationResult) => void): Request; + /** + * Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account. + */ + createPublicKey(params: CloudFront.Types.CreatePublicKeyRequest, callback?: (err: AWSError, data: CloudFront.Types.CreatePublicKeyResult) => void): Request; + /** + * Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account. + */ + createPublicKey(callback?: (err: AWSError, data: CloudFront.Types.CreatePublicKeyResult) => void): Request; + /** + * Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP. To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution. To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes. For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide. Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified. + */ + createStreamingDistribution(params: CloudFront.Types.CreateStreamingDistributionRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateStreamingDistributionResult) => void): Request; + /** + * Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP. To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution. To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes. For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide. Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified. + */ + createStreamingDistribution(callback?: (err: AWSError, data: CloudFront.Types.CreateStreamingDistributionResult) => void): Request; + /** + * Create a new streaming distribution with tags. + */ + createStreamingDistributionWithTags(params: CloudFront.Types.CreateStreamingDistributionWithTagsRequest, callback?: (err: AWSError, data: CloudFront.Types.CreateStreamingDistributionWithTagsResult) => void): Request; + /** + * Create a new streaming distribution with tags. + */ + createStreamingDistributionWithTags(callback?: (err: AWSError, data: CloudFront.Types.CreateStreamingDistributionWithTagsResult) => void): Request; + /** + * Delete an origin access identity. + */ + deleteCloudFrontOriginAccessIdentity(params: CloudFront.Types.DeleteCloudFrontOriginAccessIdentityRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete an origin access identity. + */ + deleteCloudFrontOriginAccessIdentity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete a distribution. + */ + deleteDistribution(params: CloudFront.Types.DeleteDistributionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete a distribution. + */ + deleteDistribution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove a field-level encryption configuration. + */ + deleteFieldLevelEncryptionConfig(params: CloudFront.Types.DeleteFieldLevelEncryptionConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove a field-level encryption configuration. + */ + deleteFieldLevelEncryptionConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove a field-level encryption profile. + */ + deleteFieldLevelEncryptionProfile(params: CloudFront.Types.DeleteFieldLevelEncryptionProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove a field-level encryption profile. + */ + deleteFieldLevelEncryptionProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove a public key you previously added to CloudFront. + */ + deletePublicKey(params: CloudFront.Types.DeletePublicKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove a public key you previously added to CloudFront. + */ + deletePublicKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps. To delete an RTMP distribution using the CloudFront API: Disable the RTMP distribution. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted. For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide. + */ + deleteStreamingDistribution(params: CloudFront.Types.DeleteStreamingDistributionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps. To delete an RTMP distribution using the CloudFront API: Disable the RTMP distribution. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted. For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide. + */ + deleteStreamingDistribution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Get the information about an origin access identity. + */ + getCloudFrontOriginAccessIdentity(params: CloudFront.Types.GetCloudFrontOriginAccessIdentityRequest, callback?: (err: AWSError, data: CloudFront.Types.GetCloudFrontOriginAccessIdentityResult) => void): Request; + /** + * Get the information about an origin access identity. + */ + getCloudFrontOriginAccessIdentity(callback?: (err: AWSError, data: CloudFront.Types.GetCloudFrontOriginAccessIdentityResult) => void): Request; + /** + * Get the configuration information about an origin access identity. + */ + getCloudFrontOriginAccessIdentityConfig(params: CloudFront.Types.GetCloudFrontOriginAccessIdentityConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.GetCloudFrontOriginAccessIdentityConfigResult) => void): Request; + /** + * Get the configuration information about an origin access identity. + */ + getCloudFrontOriginAccessIdentityConfig(callback?: (err: AWSError, data: CloudFront.Types.GetCloudFrontOriginAccessIdentityConfigResult) => void): Request; + /** + * Get the information about a distribution. + */ + getDistribution(params: CloudFront.Types.GetDistributionRequest, callback?: (err: AWSError, data: CloudFront.Types.GetDistributionResult) => void): Request; + /** + * Get the information about a distribution. + */ + getDistribution(callback?: (err: AWSError, data: CloudFront.Types.GetDistributionResult) => void): Request; + /** + * Get the configuration information about a distribution. + */ + getDistributionConfig(params: CloudFront.Types.GetDistributionConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.GetDistributionConfigResult) => void): Request; + /** + * Get the configuration information about a distribution. + */ + getDistributionConfig(callback?: (err: AWSError, data: CloudFront.Types.GetDistributionConfigResult) => void): Request; + /** + * Get the field-level encryption configuration information. + */ + getFieldLevelEncryption(params: CloudFront.Types.GetFieldLevelEncryptionRequest, callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionResult) => void): Request; + /** + * Get the field-level encryption configuration information. + */ + getFieldLevelEncryption(callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionResult) => void): Request; + /** + * Get the field-level encryption configuration information. + */ + getFieldLevelEncryptionConfig(params: CloudFront.Types.GetFieldLevelEncryptionConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionConfigResult) => void): Request; + /** + * Get the field-level encryption configuration information. + */ + getFieldLevelEncryptionConfig(callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionConfigResult) => void): Request; + /** + * Get the field-level encryption profile information. + */ + getFieldLevelEncryptionProfile(params: CloudFront.Types.GetFieldLevelEncryptionProfileRequest, callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionProfileResult) => void): Request; + /** + * Get the field-level encryption profile information. + */ + getFieldLevelEncryptionProfile(callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionProfileResult) => void): Request; + /** + * Get the field-level encryption profile configuration information. + */ + getFieldLevelEncryptionProfileConfig(params: CloudFront.Types.GetFieldLevelEncryptionProfileConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionProfileConfigResult) => void): Request; + /** + * Get the field-level encryption profile configuration information. + */ + getFieldLevelEncryptionProfileConfig(callback?: (err: AWSError, data: CloudFront.Types.GetFieldLevelEncryptionProfileConfigResult) => void): Request; + /** + * Get the information about an invalidation. + */ + getInvalidation(params: CloudFront.Types.GetInvalidationRequest, callback?: (err: AWSError, data: CloudFront.Types.GetInvalidationResult) => void): Request; + /** + * Get the information about an invalidation. + */ + getInvalidation(callback?: (err: AWSError, data: CloudFront.Types.GetInvalidationResult) => void): Request; + /** + * Get the public key information. + */ + getPublicKey(params: CloudFront.Types.GetPublicKeyRequest, callback?: (err: AWSError, data: CloudFront.Types.GetPublicKeyResult) => void): Request; + /** + * Get the public key information. + */ + getPublicKey(callback?: (err: AWSError, data: CloudFront.Types.GetPublicKeyResult) => void): Request; + /** + * Return public key configuration informaation + */ + getPublicKeyConfig(params: CloudFront.Types.GetPublicKeyConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.GetPublicKeyConfigResult) => void): Request; + /** + * Return public key configuration informaation + */ + getPublicKeyConfig(callback?: (err: AWSError, data: CloudFront.Types.GetPublicKeyConfigResult) => void): Request; + /** + * Gets information about a specified RTMP distribution, including the distribution configuration. + */ + getStreamingDistribution(params: CloudFront.Types.GetStreamingDistributionRequest, callback?: (err: AWSError, data: CloudFront.Types.GetStreamingDistributionResult) => void): Request; + /** + * Gets information about a specified RTMP distribution, including the distribution configuration. + */ + getStreamingDistribution(callback?: (err: AWSError, data: CloudFront.Types.GetStreamingDistributionResult) => void): Request; + /** + * Get the configuration information about a streaming distribution. + */ + getStreamingDistributionConfig(params: CloudFront.Types.GetStreamingDistributionConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.GetStreamingDistributionConfigResult) => void): Request; + /** + * Get the configuration information about a streaming distribution. + */ + getStreamingDistributionConfig(callback?: (err: AWSError, data: CloudFront.Types.GetStreamingDistributionConfigResult) => void): Request; + /** + * Lists origin access identities. + */ + listCloudFrontOriginAccessIdentities(params: CloudFront.Types.ListCloudFrontOriginAccessIdentitiesRequest, callback?: (err: AWSError, data: CloudFront.Types.ListCloudFrontOriginAccessIdentitiesResult) => void): Request; + /** + * Lists origin access identities. + */ + listCloudFrontOriginAccessIdentities(callback?: (err: AWSError, data: CloudFront.Types.ListCloudFrontOriginAccessIdentitiesResult) => void): Request; + /** + * List distributions. + */ + listDistributions(params: CloudFront.Types.ListDistributionsRequest, callback?: (err: AWSError, data: CloudFront.Types.ListDistributionsResult) => void): Request; + /** + * List distributions. + */ + listDistributions(callback?: (err: AWSError, data: CloudFront.Types.ListDistributionsResult) => void): Request; + /** + * List the distributions that are associated with a specified AWS WAF web ACL. + */ + listDistributionsByWebACLId(params: CloudFront.Types.ListDistributionsByWebACLIdRequest, callback?: (err: AWSError, data: CloudFront.Types.ListDistributionsByWebACLIdResult) => void): Request; + /** + * List the distributions that are associated with a specified AWS WAF web ACL. + */ + listDistributionsByWebACLId(callback?: (err: AWSError, data: CloudFront.Types.ListDistributionsByWebACLIdResult) => void): Request; + /** + * List all field-level encryption configurations that have been created in CloudFront for this account. + */ + listFieldLevelEncryptionConfigs(params: CloudFront.Types.ListFieldLevelEncryptionConfigsRequest, callback?: (err: AWSError, data: CloudFront.Types.ListFieldLevelEncryptionConfigsResult) => void): Request; + /** + * List all field-level encryption configurations that have been created in CloudFront for this account. + */ + listFieldLevelEncryptionConfigs(callback?: (err: AWSError, data: CloudFront.Types.ListFieldLevelEncryptionConfigsResult) => void): Request; + /** + * Request a list of field-level encryption profiles that have been created in CloudFront for this account. + */ + listFieldLevelEncryptionProfiles(params: CloudFront.Types.ListFieldLevelEncryptionProfilesRequest, callback?: (err: AWSError, data: CloudFront.Types.ListFieldLevelEncryptionProfilesResult) => void): Request; + /** + * Request a list of field-level encryption profiles that have been created in CloudFront for this account. + */ + listFieldLevelEncryptionProfiles(callback?: (err: AWSError, data: CloudFront.Types.ListFieldLevelEncryptionProfilesResult) => void): Request; + /** + * Lists invalidation batches. + */ + listInvalidations(params: CloudFront.Types.ListInvalidationsRequest, callback?: (err: AWSError, data: CloudFront.Types.ListInvalidationsResult) => void): Request; + /** + * Lists invalidation batches. + */ + listInvalidations(callback?: (err: AWSError, data: CloudFront.Types.ListInvalidationsResult) => void): Request; + /** + * List all public keys that have been added to CloudFront for this account. + */ + listPublicKeys(params: CloudFront.Types.ListPublicKeysRequest, callback?: (err: AWSError, data: CloudFront.Types.ListPublicKeysResult) => void): Request; + /** + * List all public keys that have been added to CloudFront for this account. + */ + listPublicKeys(callback?: (err: AWSError, data: CloudFront.Types.ListPublicKeysResult) => void): Request; + /** + * List streaming distributions. + */ + listStreamingDistributions(params: CloudFront.Types.ListStreamingDistributionsRequest, callback?: (err: AWSError, data: CloudFront.Types.ListStreamingDistributionsResult) => void): Request; + /** + * List streaming distributions. + */ + listStreamingDistributions(callback?: (err: AWSError, data: CloudFront.Types.ListStreamingDistributionsResult) => void): Request; + /** + * List tags for a CloudFront resource. + */ + listTagsForResource(params: CloudFront.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CloudFront.Types.ListTagsForResourceResult) => void): Request; + /** + * List tags for a CloudFront resource. + */ + listTagsForResource(callback?: (err: AWSError, data: CloudFront.Types.ListTagsForResourceResult) => void): Request; + /** + * Add tags to a CloudFront resource. + */ + tagResource(params: CloudFront.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Add tags to a CloudFront resource. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove tags from a CloudFront resource. + */ + untagResource(params: CloudFront.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove tags from a CloudFront resource. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Update an origin access identity. + */ + updateCloudFrontOriginAccessIdentity(params: CloudFront.Types.UpdateCloudFrontOriginAccessIdentityRequest, callback?: (err: AWSError, data: CloudFront.Types.UpdateCloudFrontOriginAccessIdentityResult) => void): Request; + /** + * Update an origin access identity. + */ + updateCloudFrontOriginAccessIdentity(callback?: (err: AWSError, data: CloudFront.Types.UpdateCloudFrontOriginAccessIdentityResult) => void): Request; + /** + * Updates the configuration for a web distribution. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide. The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates. For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide. To update a web distribution using the CloudFront API Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution. If you update the distribution again, you must get a new Etag header. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes. When you edit the XML file, be aware of the following: You must strip out the ETag parameter that is returned. Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution. You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error. The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element. Submit an UpdateDistribution request to update the configuration for your distribution: In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed. + */ + updateDistribution(params: CloudFront.Types.UpdateDistributionRequest, callback?: (err: AWSError, data: CloudFront.Types.UpdateDistributionResult) => void): Request; + /** + * Updates the configuration for a web distribution. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide. The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates. For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide. To update a web distribution using the CloudFront API Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution. If you update the distribution again, you must get a new Etag header. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes. When you edit the XML file, be aware of the following: You must strip out the ETag parameter that is returned. Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution. You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error. The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element. Submit an UpdateDistribution request to update the configuration for your distribution: In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed. + */ + updateDistribution(callback?: (err: AWSError, data: CloudFront.Types.UpdateDistributionResult) => void): Request; + /** + * Update a field-level encryption configuration. + */ + updateFieldLevelEncryptionConfig(params: CloudFront.Types.UpdateFieldLevelEncryptionConfigRequest, callback?: (err: AWSError, data: CloudFront.Types.UpdateFieldLevelEncryptionConfigResult) => void): Request; + /** + * Update a field-level encryption configuration. + */ + updateFieldLevelEncryptionConfig(callback?: (err: AWSError, data: CloudFront.Types.UpdateFieldLevelEncryptionConfigResult) => void): Request; + /** + * Update a field-level encryption profile. + */ + updateFieldLevelEncryptionProfile(params: CloudFront.Types.UpdateFieldLevelEncryptionProfileRequest, callback?: (err: AWSError, data: CloudFront.Types.UpdateFieldLevelEncryptionProfileResult) => void): Request; + /** + * Update a field-level encryption profile. + */ + updateFieldLevelEncryptionProfile(callback?: (err: AWSError, data: CloudFront.Types.UpdateFieldLevelEncryptionProfileResult) => void): Request; + /** + * Update public key information. Note that the only value you can change is the comment. + */ + updatePublicKey(params: CloudFront.Types.UpdatePublicKeyRequest, callback?: (err: AWSError, data: CloudFront.Types.UpdatePublicKeyResult) => void): Request; + /** + * Update public key information. Note that the only value you can change is the comment. + */ + updatePublicKey(callback?: (err: AWSError, data: CloudFront.Types.UpdatePublicKeyResult) => void): Request; + /** + * Update a streaming distribution. + */ + updateStreamingDistribution(params: CloudFront.Types.UpdateStreamingDistributionRequest, callback?: (err: AWSError, data: CloudFront.Types.UpdateStreamingDistributionResult) => void): Request; + /** + * Update a streaming distribution. + */ + updateStreamingDistribution(callback?: (err: AWSError, data: CloudFront.Types.UpdateStreamingDistributionResult) => void): Request; + /** + * Waits for the distributionDeployed state by periodically calling the underlying CloudFront.getDistributionoperation every 60 seconds (at most 25 times). Wait until a distribution is deployed. + */ + waitFor(state: "distributionDeployed", params: CloudFront.Types.GetDistributionRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFront.Types.GetDistributionResult) => void): Request; + /** + * Waits for the distributionDeployed state by periodically calling the underlying CloudFront.getDistributionoperation every 60 seconds (at most 25 times). Wait until a distribution is deployed. + */ + waitFor(state: "distributionDeployed", callback?: (err: AWSError, data: CloudFront.Types.GetDistributionResult) => void): Request; + /** + * Waits for the invalidationCompleted state by periodically calling the underlying CloudFront.getInvalidationoperation every 20 seconds (at most 30 times). Wait until an invalidation has completed. + */ + waitFor(state: "invalidationCompleted", params: CloudFront.Types.GetInvalidationRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFront.Types.GetInvalidationResult) => void): Request; + /** + * Waits for the invalidationCompleted state by periodically calling the underlying CloudFront.getInvalidationoperation every 20 seconds (at most 30 times). Wait until an invalidation has completed. + */ + waitFor(state: "invalidationCompleted", callback?: (err: AWSError, data: CloudFront.Types.GetInvalidationResult) => void): Request; + /** + * Waits for the streamingDistributionDeployed state by periodically calling the underlying CloudFront.getStreamingDistributionoperation every 60 seconds (at most 25 times). Wait until a streaming distribution is deployed. + */ + waitFor(state: "streamingDistributionDeployed", params: CloudFront.Types.GetStreamingDistributionRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFront.Types.GetStreamingDistributionResult) => void): Request; + /** + * Waits for the streamingDistributionDeployed state by periodically calling the underlying CloudFront.getStreamingDistributionoperation every 60 seconds (at most 25 times). Wait until a streaming distribution is deployed. + */ + waitFor(state: "streamingDistributionDeployed", callback?: (err: AWSError, data: CloudFront.Types.GetStreamingDistributionResult) => void): Request; +} +declare namespace CloudFront { + export import Signer = signer; +} +declare namespace CloudFront { + export interface ActiveTrustedSigners { + /** + * Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false. For more information, see ActiveTrustedSigners. + */ + Enabled: boolean; + /** + * A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type. For more information, see ActiveTrustedSigners. + */ + Quantity: integer; + /** + * A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type. For more information, see ActiveTrustedSigners. + */ + Items?: SignerList; + } + export type AliasList = string[]; + export interface Aliases { + /** + * The number of CNAME aliases, if any, that you want to associate with this distribution. + */ + Quantity: integer; + /** + * A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution. + */ + Items?: AliasList; + } + export interface AllowedMethods { + /** + * The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests). + */ + Quantity: integer; + /** + * A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. + */ + Items: MethodsList; + CachedMethods?: CachedMethods; + } + export type AwsAccountNumberList = string[]; + export interface CacheBehavior { + /** + * The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see Path Pattern in the Amazon CloudFront Developer Guide. + */ + PathPattern: string; + /** + * The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution. + */ + TargetOriginId: string; + /** + * A complex type that specifies how CloudFront handles query strings and cookies. + */ + ForwardedValues: ForwardedValues; + /** + * A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + */ + TrustedSigners: TrustedSigners; + /** + * The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options: allow-all: Viewers can use HTTP or HTTPS. redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. + */ + ViewerProtocolPolicy: ViewerProtocolPolicy; + /** + * The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name). + */ + MinTTL: long; + AllowedMethods?: AllowedMethods; + /** + * Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern. + */ + SmoothStreaming?: boolean; + /** + * The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. + */ + DefaultTTL?: long; + /** + * The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. + */ + MaxTTL?: long; + /** + * Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. + */ + Compress?: boolean; + /** + * A complex type that contains zero or more Lambda function associations for a cache behavior. + */ + LambdaFunctionAssociations?: LambdaFunctionAssociations; + /** + * The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution. + */ + FieldLevelEncryptionId?: string; + } + export type CacheBehaviorList = CacheBehavior[]; + export interface CacheBehaviors { + /** + * The number of cache behaviors for this distribution. + */ + Quantity: integer; + /** + * Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items. + */ + Items?: CacheBehaviorList; + } + export interface CachedMethods { + /** + * The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests). + */ + Quantity: integer; + /** + * A complex type that contains the HTTP methods that you want CloudFront to cache responses to. + */ + Items: MethodsList; + } + export type CertificateSource = "cloudfront"|"iam"|"acm"|string; + export interface CloudFrontOriginAccessIdentity { + /** + * The ID for the origin access identity, for example, E74FTE3AJFJ256A. + */ + Id: string; + /** + * The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. + */ + S3CanonicalUserId: string; + /** + * The current configuration information for the identity. + */ + CloudFrontOriginAccessIdentityConfig?: CloudFrontOriginAccessIdentityConfig; + } + export interface CloudFrontOriginAccessIdentityConfig { + /** + * A unique value (for example, a date-time stamp) that ensures that the request can't be replayed. If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. + */ + CallerReference: string; + /** + * Any comments you want to include about the origin access identity. + */ + Comment: string; + } + export interface CloudFrontOriginAccessIdentityList { + /** + * Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page). + */ + Marker: string; + /** + * If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off. + */ + NextMarker?: string; + /** + * The maximum number of origin access identities you want in the response body. + */ + MaxItems: integer; + /** + * A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list. + */ + IsTruncated: boolean; + /** + * The number of CloudFront origin access identities that were created by the current AWS account. + */ + Quantity: integer; + /** + * A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account. + */ + Items?: CloudFrontOriginAccessIdentitySummaryList; + } + export interface CloudFrontOriginAccessIdentitySummary { + /** + * The ID for the origin access identity. For example: E74FTE3AJFJ256A. + */ + Id: string; + /** + * The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3. + */ + S3CanonicalUserId: string; + /** + * The comment for this origin access identity, as originally specified when created. + */ + Comment: string; + } + export type CloudFrontOriginAccessIdentitySummaryList = CloudFrontOriginAccessIdentitySummary[]; + export interface ContentTypeProfile { + /** + * The format for a field-level encryption content type-profile mapping. + */ + Format: Format; + /** + * The profile ID for a field-level encryption content type-profile mapping. + */ + ProfileId?: string; + /** + * The content type for a field-level encryption content type-profile mapping. + */ + ContentType: string; + } + export interface ContentTypeProfileConfig { + /** + * The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown. + */ + ForwardWhenContentTypeIsUnknown: boolean; + /** + * The configuration for a field-level encryption content type-profile. + */ + ContentTypeProfiles?: ContentTypeProfiles; + } + export type ContentTypeProfileList = ContentTypeProfile[]; + export interface ContentTypeProfiles { + /** + * The number of field-level encryption content type-profile mappings. + */ + Quantity: integer; + /** + * Items in a field-level encryption content type-profile mapping. + */ + Items?: ContentTypeProfileList; + } + export type CookieNameList = string[]; + export interface CookieNames { + /** + * The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. + */ + Quantity: integer; + /** + * A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior. + */ + Items?: CookieNameList; + } + export interface CookiePreference { + /** + * Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element. + */ + Forward: ItemSelection; + /** + * Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically. For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference. + */ + WhitelistedNames?: CookieNames; + } + export interface CreateCloudFrontOriginAccessIdentityRequest { + /** + * The current configuration information for the identity. + */ + CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfig; + } + export interface CreateCloudFrontOriginAccessIdentityResult { + /** + * The origin access identity's information. + */ + CloudFrontOriginAccessIdentity?: CloudFrontOriginAccessIdentity; + /** + * The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A. + */ + Location?: string; + /** + * The current version of the origin access identity created. + */ + ETag?: string; + } + export interface CreateDistributionRequest { + /** + * The distribution's configuration information. + */ + DistributionConfig: DistributionConfig; + } + export interface CreateDistributionResult { + /** + * The distribution's information. + */ + Distribution?: Distribution; + /** + * The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5. + */ + Location?: string; + /** + * The current version of the distribution created. + */ + ETag?: string; + } + export interface CreateDistributionWithTagsRequest { + /** + * The distribution's configuration information. + */ + DistributionConfigWithTags: DistributionConfigWithTags; + } + export interface CreateDistributionWithTagsResult { + /** + * The distribution's information. + */ + Distribution?: Distribution; + /** + * The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5. + */ + Location?: string; + /** + * The current version of the distribution created. + */ + ETag?: string; + } + export interface CreateFieldLevelEncryptionConfigRequest { + /** + * The request to create a new field-level encryption configuration. + */ + FieldLevelEncryptionConfig: FieldLevelEncryptionConfig; + } + export interface CreateFieldLevelEncryptionConfigResult { + /** + * Returned when you create a new field-level encryption configuration. + */ + FieldLevelEncryption?: FieldLevelEncryption; + /** + * The fully qualified URI of the new configuration resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5. + */ + Location?: string; + /** + * The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface CreateFieldLevelEncryptionProfileRequest { + /** + * The request to create a field-level encryption profile. + */ + FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfig; + } + export interface CreateFieldLevelEncryptionProfileResult { + /** + * Returned when you create a new field-level encryption profile. + */ + FieldLevelEncryptionProfile?: FieldLevelEncryptionProfile; + /** + * The fully qualified URI of the new profile resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5. + */ + Location?: string; + /** + * The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface CreateInvalidationRequest { + /** + * The distribution's id. + */ + DistributionId: string; + /** + * The batch information for the invalidation. + */ + InvalidationBatch: InvalidationBatch; + } + export interface CreateInvalidationResult { + /** + * The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID. + */ + Location?: string; + /** + * The invalidation's information. + */ + Invalidation?: Invalidation; + } + export interface CreatePublicKeyRequest { + /** + * The request to add a public key to CloudFront. + */ + PublicKeyConfig: PublicKeyConfig; + } + export interface CreatePublicKeyResult { + /** + * Returned when you add a public key. + */ + PublicKey?: PublicKey; + /** + * The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5. + */ + Location?: string; + /** + * The current version of the public key. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface CreateStreamingDistributionRequest { + /** + * The streaming distribution's configuration information. + */ + StreamingDistributionConfig: StreamingDistributionConfig; + } + export interface CreateStreamingDistributionResult { + /** + * The streaming distribution's information. + */ + StreamingDistribution?: StreamingDistribution; + /** + * The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8. + */ + Location?: string; + /** + * The current version of the streaming distribution created. + */ + ETag?: string; + } + export interface CreateStreamingDistributionWithTagsRequest { + /** + * The streaming distribution's configuration information. + */ + StreamingDistributionConfigWithTags: StreamingDistributionConfigWithTags; + } + export interface CreateStreamingDistributionWithTagsResult { + /** + * The streaming distribution's information. + */ + StreamingDistribution?: StreamingDistribution; + /** + * The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8. + */ + Location?: string; + /** + * The current version of the distribution created. + */ + ETag?: string; + } + export interface CustomErrorResponse { + /** + * The HTTP status code for which you want to specify a custom error page and/or a caching duration. + */ + ErrorCode: integer; + /** + * The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*. The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages. If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable. + */ + ResponsePagePath?: string; + /** + * The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted. If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors. You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down. If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document. + */ + ResponseCode?: string; + /** + * The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document. For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide. + */ + ErrorCachingMinTTL?: long; + } + export type CustomErrorResponseList = CustomErrorResponse[]; + export interface CustomErrorResponses { + /** + * The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items. + */ + Quantity: integer; + /** + * A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. + */ + Items?: CustomErrorResponseList; + } + export interface CustomHeaders { + /** + * The number of custom headers, if any, for this distribution. + */ + Quantity: integer; + /** + * Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items. + */ + Items?: OriginCustomHeadersList; + } + export interface CustomOriginConfig { + /** + * The HTTP port the custom origin listens on. + */ + HTTPPort: integer; + /** + * The HTTPS port the custom origin listens on. + */ + HTTPSPort: integer; + /** + * The origin protocol policy to apply to your origin. + */ + OriginProtocolPolicy: OriginProtocolPolicy; + /** + * The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS. + */ + OriginSslProtocols?: OriginSslProtocols; + /** + * You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds. If you need to increase the maximum time limit, contact the AWS Support Center. + */ + OriginReadTimeout?: integer; + /** + * You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds. If you need to increase the maximum time limit, contact the AWS Support Center. + */ + OriginKeepaliveTimeout?: integer; + } + export interface DefaultCacheBehavior { + /** + * The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution. + */ + TargetOriginId: string; + /** + * A complex type that specifies how CloudFront handles query strings and cookies. + */ + ForwardedValues: ForwardedValues; + /** + * A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + */ + TrustedSigners: TrustedSigners; + /** + * The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options: allow-all: Viewers can use HTTP or HTTPS. redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. + */ + ViewerProtocolPolicy: ViewerProtocolPolicy; + /** + * The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name). + */ + MinTTL: long; + AllowedMethods?: AllowedMethods; + /** + * Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern. + */ + SmoothStreaming?: boolean; + /** + * The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. + */ + DefaultTTL?: long; + MaxTTL?: long; + /** + * Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. + */ + Compress?: boolean; + /** + * A complex type that contains zero or more Lambda function associations for a cache behavior. + */ + LambdaFunctionAssociations?: LambdaFunctionAssociations; + /** + * The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution. + */ + FieldLevelEncryptionId?: string; + } + export interface DeleteCloudFrontOriginAccessIdentityRequest { + /** + * The origin access identity's ID. + */ + Id: string; + /** + * The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface DeleteDistributionRequest { + /** + * The distribution ID. + */ + Id: string; + /** + * The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface DeleteFieldLevelEncryptionConfigRequest { + /** + * The ID of the configuration you want to delete from CloudFront. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface DeleteFieldLevelEncryptionProfileRequest { + /** + * Request the ID of the profile you want to delete from CloudFront. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface DeletePublicKeyRequest { + /** + * The ID of the public key you want to remove from CloudFront. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface DeleteStreamingDistributionRequest { + /** + * The distribution ID. + */ + Id: string; + /** + * The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface Distribution { + /** + * The identifier for the distribution. For example: EDFDVBD632BHDS5. + */ + Id: string; + /** + * The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. + */ + ARN: string; + /** + * This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations. + */ + Status: string; + /** + * The date and time the distribution was last modified. + */ + LastModifiedTime: timestamp; + /** + * The number of invalidation batches currently in progress. + */ + InProgressInvalidationBatches: integer; + /** + * The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net. + */ + DomainName: string; + /** + * CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs. + */ + ActiveTrustedSigners: ActiveTrustedSigners; + /** + * The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource. + */ + DistributionConfig: DistributionConfig; + } + export interface DistributionConfig { + /** + * A unique value (for example, a date-time stamp) that ensures that the request can't be replayed. If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution. If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error. + */ + CallerReference: string; + /** + * A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. + */ + Aliases?: Aliases; + /** + * The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example, index.html. Don't add a / before the object name. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide. + */ + DefaultRootObject?: string; + /** + * A complex type that contains information about origins for this distribution. + */ + Origins: Origins; + /** + * A complex type that contains information about origin groups for this distribution. + */ + OriginGroups?: OriginGroups; + /** + * A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior. + */ + DefaultCacheBehavior: DefaultCacheBehavior; + /** + * A complex type that contains zero or more CacheBehavior elements. + */ + CacheBehaviors?: CacheBehaviors; + /** + * A complex type that controls the following: Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide. + */ + CustomErrorResponses?: CustomErrorResponses; + /** + * Any comments you want to include about the distribution. If you don't want to specify a comment, include an empty Comment element. To delete an existing comment, update the distribution configuration and include an empty Comment element. To add or change a comment, update the distribution configuration and specify the new comment. + */ + Comment: string; + /** + * A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide. + */ + Logging?: LoggingConfig; + /** + * The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page. + */ + PriceClass?: PriceClass; + /** + * From this field, you can enable or disable the selected distribution. + */ + Enabled: boolean; + /** + * + */ + ViewerCertificate?: ViewerCertificate; + /** + * + */ + Restrictions?: Restrictions; + /** + * A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide. + */ + WebACLId?: string; + /** + * (Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version. For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI). In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization." + */ + HttpVersion?: HttpVersion; + /** + * If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: You enable IPv6 for the distribution You're using alternate domain names in the URLs for your objects For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide. If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. + */ + IsIPV6Enabled?: boolean; + } + export interface DistributionConfigWithTags { + /** + * A distribution configuration. + */ + DistributionConfig: DistributionConfig; + /** + * A complex type that contains zero or more Tag elements. + */ + Tags: Tags; + } + export interface DistributionList { + /** + * The value you provided for the Marker request parameter. + */ + Marker: string; + /** + * If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off. + */ + NextMarker?: string; + /** + * The value you provided for the MaxItems request parameter. + */ + MaxItems: integer; + /** + * A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list. + */ + IsTruncated: boolean; + /** + * The number of distributions that were created by the current AWS account. + */ + Quantity: integer; + /** + * A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account. + */ + Items?: DistributionSummaryList; + } + export interface DistributionSummary { + /** + * The identifier for the distribution. For example: EDFDVBD632BHDS5. + */ + Id: string; + /** + * The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. + */ + ARN: string; + /** + * The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations. + */ + Status: string; + /** + * The date and time the distribution was last modified. + */ + LastModifiedTime: timestamp; + /** + * The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net. + */ + DomainName: string; + /** + * A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. + */ + Aliases: Aliases; + /** + * A complex type that contains information about origins for this distribution. + */ + Origins: Origins; + /** + * A complex type that contains information about origin groups for this distribution. + */ + OriginGroups?: OriginGroups; + /** + * A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior. + */ + DefaultCacheBehavior: DefaultCacheBehavior; + /** + * A complex type that contains zero or more CacheBehavior elements. + */ + CacheBehaviors: CacheBehaviors; + /** + * A complex type that contains zero or more CustomErrorResponses elements. + */ + CustomErrorResponses: CustomErrorResponses; + /** + * The comment originally specified when this distribution was created. + */ + Comment: string; + /** + * A complex type that contains information about price class for this streaming distribution. + */ + PriceClass: PriceClass; + /** + * Whether the distribution is enabled to accept user requests for content. + */ + Enabled: boolean; + /** + * + */ + ViewerCertificate: ViewerCertificate; + /** + * + */ + Restrictions: Restrictions; + /** + * The Web ACL Id (if any) associated with the distribution. + */ + WebACLId: string; + /** + * Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version. + */ + HttpVersion: HttpVersion; + /** + * Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution. + */ + IsIPV6Enabled: boolean; + } + export type DistributionSummaryList = DistributionSummary[]; + export interface EncryptionEntities { + /** + * Number of field pattern items in a field-level encryption content type-profile mapping. + */ + Quantity: integer; + /** + * An array of field patterns in a field-level encryption content type-profile mapping. + */ + Items?: EncryptionEntityList; + } + export interface EncryptionEntity { + /** + * The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns. + */ + PublicKeyId: string; + /** + * The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data. + */ + ProviderId: string; + /** + * Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive. + */ + FieldPatterns: FieldPatterns; + } + export type EncryptionEntityList = EncryptionEntity[]; + export type EventType = "viewer-request"|"viewer-response"|"origin-request"|"origin-response"|string; + export interface FieldLevelEncryption { + /** + * The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys. + */ + Id: string; + /** + * The last time the field-level encryption configuration was changed. + */ + LastModifiedTime: timestamp; + /** + * A complex data type that includes the profile configurations specified for field-level encryption. + */ + FieldLevelEncryptionConfig: FieldLevelEncryptionConfig; + } + export interface FieldLevelEncryptionConfig { + /** + * A unique number that ensures the request can't be replayed. + */ + CallerReference: string; + /** + * An optional comment about the configuration. + */ + Comment?: string; + /** + * A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request. + */ + QueryArgProfileConfig?: QueryArgProfileConfig; + /** + * A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use. + */ + ContentTypeProfileConfig?: ContentTypeProfileConfig; + } + export interface FieldLevelEncryptionList { + /** + * If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off. + */ + NextMarker?: string; + /** + * The maximum number of elements you want in the response body. + */ + MaxItems: integer; + /** + * The number of field-level encryption items. + */ + Quantity: integer; + /** + * An array of field-level encryption items. + */ + Items?: FieldLevelEncryptionSummaryList; + } + export interface FieldLevelEncryptionProfile { + /** + * The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys. + */ + Id: string; + /** + * The last time the field-level encryption profile was updated. + */ + LastModifiedTime: timestamp; + /** + * A complex data type that includes the profile name and the encryption entities for the field-level encryption profile. + */ + FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfig; + } + export interface FieldLevelEncryptionProfileConfig { + /** + * Profile name for the field-level encryption profile. + */ + Name: string; + /** + * A unique number that ensures that the request can't be replayed. + */ + CallerReference: string; + /** + * An optional comment for the field-level encryption profile. + */ + Comment?: string; + /** + * A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key. + */ + EncryptionEntities: EncryptionEntities; + } + export interface FieldLevelEncryptionProfileList { + /** + * If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off. + */ + NextMarker?: string; + /** + * The maximum number of field-level encryption profiles you want in the response body. + */ + MaxItems: integer; + /** + * The number of field-level encryption profiles. + */ + Quantity: integer; + /** + * The field-level encryption profile items. + */ + Items?: FieldLevelEncryptionProfileSummaryList; + } + export interface FieldLevelEncryptionProfileSummary { + /** + * ID for the field-level encryption profile summary. + */ + Id: string; + /** + * The time when the the field-level encryption profile summary was last updated. + */ + LastModifiedTime: timestamp; + /** + * Name for the field-level encryption profile summary. + */ + Name: string; + /** + * A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key. + */ + EncryptionEntities: EncryptionEntities; + /** + * An optional comment for the field-level encryption profile summary. + */ + Comment?: string; + } + export type FieldLevelEncryptionProfileSummaryList = FieldLevelEncryptionProfileSummary[]; + export interface FieldLevelEncryptionSummary { + /** + * The unique ID of a field-level encryption item. + */ + Id: string; + /** + * The last time that the summary of field-level encryption items was modified. + */ + LastModifiedTime: timestamp; + /** + * An optional comment about the field-level encryption item. + */ + Comment?: string; + /** + * A summary of a query argument-profile mapping. + */ + QueryArgProfileConfig?: QueryArgProfileConfig; + /** + * A summary of a content type-profile mapping. + */ + ContentTypeProfileConfig?: ContentTypeProfileConfig; + } + export type FieldLevelEncryptionSummaryList = FieldLevelEncryptionSummary[]; + export type FieldPatternList = string[]; + export interface FieldPatterns { + /** + * The number of field-level encryption field patterns. + */ + Quantity: integer; + /** + * An array of the field-level encryption field patterns. + */ + Items?: FieldPatternList; + } + export type Format = "URLEncoded"|string; + export interface ForwardedValues { + /** + * Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any: If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide. + */ + QueryString: boolean; + /** + * A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide. + */ + Cookies: CookiePreference; + /** + * A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior. + */ + Headers?: Headers; + /** + * A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior. + */ + QueryStringCacheKeys?: QueryStringCacheKeys; + } + export interface GeoRestriction { + /** + * The method that you want to use to restrict distribution of your content by country: none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content. whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content. + */ + RestrictionType: GeoRestrictionType; + /** + * When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items. + */ + Quantity: integer; + /** + * A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes. + */ + Items?: LocationList; + } + export type GeoRestrictionType = "blacklist"|"whitelist"|"none"|string; + export interface GetCloudFrontOriginAccessIdentityConfigRequest { + /** + * The identity's ID. + */ + Id: string; + } + export interface GetCloudFrontOriginAccessIdentityConfigResult { + /** + * The origin access identity's configuration information. + */ + CloudFrontOriginAccessIdentityConfig?: CloudFrontOriginAccessIdentityConfig; + /** + * The current version of the configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetCloudFrontOriginAccessIdentityRequest { + /** + * The identity's ID. + */ + Id: string; + } + export interface GetCloudFrontOriginAccessIdentityResult { + /** + * The origin access identity's information. + */ + CloudFrontOriginAccessIdentity?: CloudFrontOriginAccessIdentity; + /** + * The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetDistributionConfigRequest { + /** + * The distribution's ID. + */ + Id: string; + } + export interface GetDistributionConfigResult { + /** + * The distribution's configuration information. + */ + DistributionConfig?: DistributionConfig; + /** + * The current version of the configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetDistributionRequest { + /** + * The distribution's ID. + */ + Id: string; + } + export interface GetDistributionResult { + /** + * The distribution's information. + */ + Distribution?: Distribution; + /** + * The current version of the distribution's information. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetFieldLevelEncryptionConfigRequest { + /** + * Request the ID for the field-level encryption configuration information. + */ + Id: string; + } + export interface GetFieldLevelEncryptionConfigResult { + /** + * Return the field-level encryption configuration information. + */ + FieldLevelEncryptionConfig?: FieldLevelEncryptionConfig; + /** + * The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetFieldLevelEncryptionProfileConfigRequest { + /** + * Get the ID for the field-level encryption profile configuration information. + */ + Id: string; + } + export interface GetFieldLevelEncryptionProfileConfigResult { + /** + * Return the field-level encryption profile configuration information. + */ + FieldLevelEncryptionProfileConfig?: FieldLevelEncryptionProfileConfig; + /** + * The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetFieldLevelEncryptionProfileRequest { + /** + * Get the ID for the field-level encryption profile information. + */ + Id: string; + } + export interface GetFieldLevelEncryptionProfileResult { + /** + * Return the field-level encryption profile information. + */ + FieldLevelEncryptionProfile?: FieldLevelEncryptionProfile; + /** + * The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetFieldLevelEncryptionRequest { + /** + * Request the ID for the field-level encryption configuration information. + */ + Id: string; + } + export interface GetFieldLevelEncryptionResult { + /** + * Return the field-level encryption configuration information. + */ + FieldLevelEncryption?: FieldLevelEncryption; + /** + * The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetInvalidationRequest { + /** + * The distribution's ID. + */ + DistributionId: string; + /** + * The identifier for the invalidation request, for example, IDFDVBD632BHDS5. + */ + Id: string; + } + export interface GetInvalidationResult { + /** + * The invalidation's information. For more information, see Invalidation Complex Type. + */ + Invalidation?: Invalidation; + } + export interface GetPublicKeyConfigRequest { + /** + * Request the ID for the public key configuration. + */ + Id: string; + } + export interface GetPublicKeyConfigResult { + /** + * Return the result for the public key configuration. + */ + PublicKeyConfig?: PublicKeyConfig; + /** + * The current version of the public key configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetPublicKeyRequest { + /** + * Request the ID for the public key. + */ + Id: string; + } + export interface GetPublicKeyResult { + /** + * Return the public key. + */ + PublicKey?: PublicKey; + /** + * The current version of the public key. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetStreamingDistributionConfigRequest { + /** + * The streaming distribution's ID. + */ + Id: string; + } + export interface GetStreamingDistributionConfigResult { + /** + * The streaming distribution's configuration information. + */ + StreamingDistributionConfig?: StreamingDistributionConfig; + /** + * The current version of the configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface GetStreamingDistributionRequest { + /** + * The streaming distribution's ID. + */ + Id: string; + } + export interface GetStreamingDistributionResult { + /** + * The streaming distribution's information. + */ + StreamingDistribution?: StreamingDistribution; + /** + * The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export type HeaderList = string[]; + export interface Headers { + /** + * The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following: Forward all headers to your origin: Specify 1 for Quantity and * for Name. CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin. Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers. Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers. Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation: S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates Custom origin: See HTTP Request Headers and CloudFront Behavior + */ + Quantity: integer; + /** + * A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items. + */ + Items?: HeaderList; + } + export type HttpVersion = "http1.1"|"http2"|string; + export interface Invalidation { + /** + * The identifier for the invalidation request. For example: IDFDVBD632BHDS5. + */ + Id: string; + /** + * The status of the invalidation request. When the invalidation batch is finished, the status is Completed. + */ + Status: string; + /** + * The date and time the invalidation request was first made. + */ + CreateTime: timestamp; + /** + * The current invalidation information for the batch request. + */ + InvalidationBatch: InvalidationBatch; + } + export interface InvalidationBatch { + /** + * A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide. + */ + Paths: Paths; + /** + * A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000. If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference. If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error. + */ + CallerReference: string; + } + export interface InvalidationList { + /** + * The value that you provided for the Marker request parameter. + */ + Marker: string; + /** + * If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off. + */ + NextMarker?: string; + /** + * The value that you provided for the MaxItems request parameter. + */ + MaxItems: integer; + /** + * A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list. + */ + IsTruncated: boolean; + /** + * The number of invalidation batches that were created by the current AWS account. + */ + Quantity: integer; + /** + * A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account. + */ + Items?: InvalidationSummaryList; + } + export interface InvalidationSummary { + /** + * The unique ID for an invalidation request. + */ + Id: string; + /** + * The time that an invalidation request was created. + */ + CreateTime: timestamp; + /** + * The status of an invalidation request. + */ + Status: string; + } + export type InvalidationSummaryList = InvalidationSummary[]; + export type ItemSelection = "none"|"whitelist"|"all"|string; + export type KeyPairIdList = string[]; + export interface KeyPairIds { + /** + * The number of active CloudFront key pairs for AwsAccountNumber. For more information, see ActiveTrustedSigners. + */ + Quantity: integer; + /** + * A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber. For more information, see ActiveTrustedSigners. + */ + Items?: KeyPairIdList; + } + export type LambdaFunctionARN = string; + export interface LambdaFunctionAssociation { + /** + * The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST. + */ + LambdaFunctionARN: LambdaFunctionARN; + /** + * Specifies the event type that triggers a Lambda function invocation. You can specify the following values: viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute. origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute. + */ + EventType: EventType; + /** + * A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide. + */ + IncludeBody?: boolean; + } + export type LambdaFunctionAssociationList = LambdaFunctionAssociation[]; + export interface LambdaFunctionAssociations { + /** + * The number of Lambda function associations for this cache behavior. + */ + Quantity: integer; + /** + * Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items. + */ + Items?: LambdaFunctionAssociationList; + } + export interface ListCloudFrontOriginAccessIdentitiesRequest { + /** + * Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page). + */ + Marker?: string; + /** + * The maximum number of origin access identities you want in the response body. + */ + MaxItems?: string; + } + export interface ListCloudFrontOriginAccessIdentitiesResult { + /** + * The CloudFrontOriginAccessIdentityList type. + */ + CloudFrontOriginAccessIdentityList?: CloudFrontOriginAccessIdentityList; + } + export interface ListDistributionsByWebACLIdRequest { + /** + * Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.) + */ + Marker?: string; + /** + * The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100. + */ + MaxItems?: string; + /** + * The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL. + */ + WebACLId: string; + } + export interface ListDistributionsByWebACLIdResult { + /** + * The DistributionList type. + */ + DistributionList?: DistributionList; + } + export interface ListDistributionsRequest { + /** + * Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page). + */ + Marker?: string; + /** + * The maximum number of distributions you want in the response body. + */ + MaxItems?: string; + } + export interface ListDistributionsResult { + /** + * The DistributionList type. + */ + DistributionList?: DistributionList; + } + export interface ListFieldLevelEncryptionConfigsRequest { + /** + * Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page). + */ + Marker?: string; + /** + * The maximum number of field-level encryption configurations you want in the response body. + */ + MaxItems?: string; + } + export interface ListFieldLevelEncryptionConfigsResult { + /** + * Returns a list of all field-level encryption configurations that have been created in CloudFront for this account. + */ + FieldLevelEncryptionList?: FieldLevelEncryptionList; + } + export interface ListFieldLevelEncryptionProfilesRequest { + /** + * Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page). + */ + Marker?: string; + /** + * The maximum number of field-level encryption profiles you want in the response body. + */ + MaxItems?: string; + } + export interface ListFieldLevelEncryptionProfilesResult { + /** + * Returns a list of the field-level encryption profiles that have been created in CloudFront for this account. + */ + FieldLevelEncryptionProfileList?: FieldLevelEncryptionProfileList; + } + export interface ListInvalidationsRequest { + /** + * The distribution's ID. + */ + DistributionId: string; + /** + * Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page. + */ + Marker?: string; + /** + * The maximum number of invalidation batches that you want in the response body. + */ + MaxItems?: string; + } + export interface ListInvalidationsResult { + /** + * Information about invalidation batches. + */ + InvalidationList?: InvalidationList; + } + export interface ListPublicKeysRequest { + /** + * Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page). + */ + Marker?: string; + /** + * The maximum number of public keys you want in the response body. + */ + MaxItems?: string; + } + export interface ListPublicKeysResult { + /** + * Returns a list of all public keys that have been added to CloudFront for this account. + */ + PublicKeyList?: PublicKeyList; + } + export interface ListStreamingDistributionsRequest { + /** + * The value that you provided for the Marker request parameter. + */ + Marker?: string; + /** + * The value that you provided for the MaxItems request parameter. + */ + MaxItems?: string; + } + export interface ListStreamingDistributionsResult { + /** + * The StreamingDistributionList type. + */ + StreamingDistributionList?: StreamingDistributionList; + } + export interface ListTagsForResourceRequest { + /** + * An ARN of a CloudFront resource. + */ + Resource: ResourceARN; + } + export interface ListTagsForResourceResult { + /** + * A complex type that contains zero or more Tag elements. + */ + Tags: Tags; + } + export type LocationList = string[]; + export interface LoggingConfig { + /** + * Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted. + */ + Enabled: boolean; + /** + * Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies. + */ + IncludeCookies: boolean; + /** + * The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. + */ + Bucket: string; + /** + * An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element. + */ + Prefix: string; + } + export type Method = "GET"|"HEAD"|"POST"|"PUT"|"PATCH"|"OPTIONS"|"DELETE"|string; + export type MethodsList = Method[]; + export type MinimumProtocolVersion = "SSLv3"|"TLSv1"|"TLSv1_2016"|"TLSv1.1_2016"|"TLSv1.2_2018"|string; + export interface Origin { + /** + * A unique identifier for the origin or origin group. The value of Id must be unique within the distribution. When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide. + */ + Id: string; + /** + * Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket. For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide. Constraints for Amazon S3 origins: If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName. The bucket name must be between 3 and 63 characters long (inclusive). The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes. The bucket name must not contain adjacent periods. Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com. Constraints for custom origins: DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters. The name cannot exceed 128 characters. + */ + DomainName: string; + /** + * An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name. For example, suppose you've specified the following values for your distribution: DomainName: An Amazon S3 bucket named myawsbucket. OriginPath: /production CNAME: example.com When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html. When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html. + */ + OriginPath?: string; + /** + * A complex type that contains names and values for the custom headers that you want. + */ + CustomHeaders?: CustomHeaders; + /** + * A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead. + */ + S3OriginConfig?: S3OriginConfig; + /** + * A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead. + */ + CustomOriginConfig?: CustomOriginConfig; + } + export interface OriginCustomHeader { + /** + * The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide. + */ + HeaderName: string; + /** + * The value for the header that you specified in the HeaderName field. + */ + HeaderValue: string; + } + export type OriginCustomHeadersList = OriginCustomHeader[]; + export interface OriginGroup { + /** + * The origin group's ID. + */ + Id: string; + /** + * A complex type that contains information about the failover criteria for an origin group. + */ + FailoverCriteria: OriginGroupFailoverCriteria; + /** + * A complex type that contains information about the origins in an origin group. + */ + Members: OriginGroupMembers; + } + export interface OriginGroupFailoverCriteria { + /** + * The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. + */ + StatusCodes: StatusCodes; + } + export type OriginGroupList = OriginGroup[]; + export interface OriginGroupMember { + /** + * The ID for an origin in an origin group. + */ + OriginId: string; + } + export type OriginGroupMemberList = OriginGroupMember[]; + export interface OriginGroupMembers { + /** + * The number of origins in an origin group. + */ + Quantity: integer; + /** + * Items (origins) in an origin group. + */ + Items: OriginGroupMemberList; + } + export interface OriginGroups { + /** + * The number of origin groups. + */ + Quantity: integer; + /** + * The items (origin groups) in a distribution. + */ + Items?: OriginGroupList; + } + export type OriginList = Origin[]; + export type OriginProtocolPolicy = "http-only"|"match-viewer"|"https-only"|string; + export interface OriginSslProtocols { + /** + * The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. + */ + Quantity: integer; + /** + * A list that contains allowed SSL/TLS protocols for this distribution. + */ + Items: SslProtocolsList; + } + export interface Origins { + /** + * The number of origins or origin groups for this distribution. + */ + Quantity: integer; + /** + * A complex type that contains origins or origin groups for this distribution. + */ + Items: OriginList; + } + export type PathList = string[]; + export interface Paths { + /** + * The number of objects that you want to invalidate. + */ + Quantity: integer; + /** + * A complex type that contains a list of the paths that you want to invalidate. + */ + Items?: PathList; + } + export type PriceClass = "PriceClass_100"|"PriceClass_200"|"PriceClass_All"|string; + export interface PublicKey { + /** + * A unique ID assigned to a public key you've added to CloudFront. + */ + Id: string; + /** + * A time you added a public key to CloudFront. + */ + CreatedTime: timestamp; + /** + * A complex data type for a public key you add to CloudFront to use with features like field-level encryption. + */ + PublicKeyConfig: PublicKeyConfig; + } + export interface PublicKeyConfig { + /** + * A unique number that ensures that the request can't be replayed. + */ + CallerReference: string; + /** + * The name for a public key you add to CloudFront to use with features like field-level encryption. + */ + Name: string; + /** + * The encoded public key that you want to add to CloudFront to use with features like field-level encryption. + */ + EncodedKey: string; + /** + * An optional comment about a public key. + */ + Comment?: string; + } + export interface PublicKeyList { + /** + * If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off. + */ + NextMarker?: string; + /** + * The maximum number of public keys you want in the response body. + */ + MaxItems: integer; + /** + * The number of public keys you added to CloudFront to use with features like field-level encryption. + */ + Quantity: integer; + /** + * An array of information about a public key you add to CloudFront to use with features like field-level encryption. + */ + Items?: PublicKeySummaryList; + } + export interface PublicKeySummary { + /** + * ID for public key information summary. + */ + Id: string; + /** + * Name for public key information summary. + */ + Name: string; + /** + * Creation time for public key information summary. + */ + CreatedTime: timestamp; + /** + * Encoded key for public key information summary. + */ + EncodedKey: string; + /** + * Comment for public key information summary. + */ + Comment?: string; + } + export type PublicKeySummaryList = PublicKeySummary[]; + export interface QueryArgProfile { + /** + * Query argument for field-level encryption query argument-profile mapping. + */ + QueryArg: string; + /** + * ID of profile to use for field-level encryption query argument-profile mapping + */ + ProfileId: string; + } + export interface QueryArgProfileConfig { + /** + * Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown. + */ + ForwardWhenQueryArgProfileIsUnknown: boolean; + /** + * Profiles specified for query argument-profile mapping for field-level encryption. + */ + QueryArgProfiles?: QueryArgProfiles; + } + export type QueryArgProfileList = QueryArgProfile[]; + export interface QueryArgProfiles { + /** + * Number of profiles for query argument-profile mapping for field-level encryption. + */ + Quantity: integer; + /** + * Number of items for query argument-profile mapping for field-level encryption. + */ + Items?: QueryArgProfileList; + } + export interface QueryStringCacheKeys { + /** + * The number of whitelisted query string parameters for this cache behavior. + */ + Quantity: integer; + /** + * (Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items. + */ + Items?: QueryStringCacheKeysList; + } + export type QueryStringCacheKeysList = string[]; + export type ResourceARN = string; + export interface Restrictions { + GeoRestriction: GeoRestriction; + } + export interface S3Origin { + /** + * The DNS name of the Amazon S3 origin. + */ + DomainName: string; + /** + * The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide. + */ + OriginAccessIdentity: string; + } + export interface S3OriginConfig { + /** + * The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is: origin-access-identity/cloudfront/ID-of-origin-access-identity where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide. + */ + OriginAccessIdentity: string; + } + export type SSLSupportMethod = "sni-only"|"vip"|string; + export interface _Signer { + /** + * An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include: self, which is the AWS account used to create the distribution. An AWS account number. + */ + AwsAccountNumber?: string; + /** + * A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber. + */ + KeyPairIds?: KeyPairIds; + } + export type SignerList = _Signer[]; + export type SslProtocol = "SSLv3"|"TLSv1"|"TLSv1.1"|"TLSv1.2"|string; + export type SslProtocolsList = SslProtocol[]; + export type StatusCodeList = integer[]; + export interface StatusCodes { + /** + * The number of status codes. + */ + Quantity: integer; + /** + * The items (status codes) for an origin group. + */ + Items: StatusCodeList; + } + export interface StreamingDistribution { + /** + * The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE. + */ + Id: string; + /** + * The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. + */ + ARN: string; + /** + * The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations. + */ + Status: string; + /** + * The date and time that the distribution was last modified. + */ + LastModifiedTime?: timestamp; + /** + * The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net. + */ + DomainName: string; + /** + * A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content. The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide. + */ + ActiveTrustedSigners: ActiveTrustedSigners; + /** + * The current configuration information for the RTMP distribution. + */ + StreamingDistributionConfig: StreamingDistributionConfig; + } + export interface StreamingDistributionConfig { + /** + * A unique value (for example, a date-time stamp) that ensures that the request can't be replayed. If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution. If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error. + */ + CallerReference: string; + /** + * A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. + */ + S3Origin: S3Origin; + /** + * A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. + */ + Aliases?: Aliases; + /** + * Any comments you want to include about the streaming distribution. + */ + Comment: string; + /** + * A complex type that controls whether access logs are written for the streaming distribution. + */ + Logging?: StreamingLoggingConfig; + /** + * A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide. + */ + TrustedSigners: TrustedSigners; + /** + * A complex type that contains information about price class for this streaming distribution. + */ + PriceClass?: PriceClass; + /** + * Whether the streaming distribution is enabled to accept user requests for content. + */ + Enabled: boolean; + } + export interface StreamingDistributionConfigWithTags { + /** + * A streaming distribution Configuration. + */ + StreamingDistributionConfig: StreamingDistributionConfig; + /** + * A complex type that contains zero or more Tag elements. + */ + Tags: Tags; + } + export interface StreamingDistributionList { + /** + * The value you provided for the Marker request parameter. + */ + Marker: string; + /** + * If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off. + */ + NextMarker?: string; + /** + * The value you provided for the MaxItems request parameter. + */ + MaxItems: integer; + /** + * A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list. + */ + IsTruncated: boolean; + /** + * The number of streaming distributions that were created by the current AWS account. + */ + Quantity: integer; + /** + * A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account. + */ + Items?: StreamingDistributionSummaryList; + } + export interface StreamingDistributionSummary { + /** + * The identifier for the distribution, for example, EDFDVBD632BHDS5. + */ + Id: string; + /** + * The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. + */ + ARN: string; + /** + * Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system. + */ + Status: string; + /** + * The date and time the distribution was last modified. + */ + LastModifiedTime: timestamp; + /** + * The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net. + */ + DomainName: string; + /** + * A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. + */ + S3Origin: S3Origin; + /** + * A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. + */ + Aliases: Aliases; + /** + * A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. + */ + TrustedSigners: TrustedSigners; + /** + * The comment originally specified when this distribution was created. + */ + Comment: string; + /** + * + */ + PriceClass: PriceClass; + /** + * Whether the distribution is enabled to accept end user requests for content. + */ + Enabled: boolean; + } + export type StreamingDistributionSummaryList = StreamingDistributionSummary[]; + export interface StreamingLoggingConfig { + /** + * Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted. + */ + Enabled: boolean; + /** + * The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. + */ + Bucket: string; + /** + * An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element. + */ + Prefix: string; + } + export interface Tag { + /** + * A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @. + */ + Key: TagKey; + /** + * A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export interface TagKeys { + /** + * A complex type that contains Tag key elements. + */ + Items?: TagKeyList; + } + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * An ARN of a CloudFront resource. + */ + Resource: ResourceARN; + /** + * A complex type that contains zero or more Tag elements. + */ + Tags: Tags; + } + export type TagValue = string; + export interface Tags { + /** + * A complex type that contains Tag elements. + */ + Items?: TagList; + } + export interface TrustedSigners { + /** + * Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId. + */ + Enabled: boolean; + /** + * The number of trusted signers for this cache behavior. + */ + Quantity: integer; + /** + * Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items. + */ + Items?: AwsAccountNumberList; + } + export interface UntagResourceRequest { + /** + * An ARN of a CloudFront resource. + */ + Resource: ResourceARN; + /** + * A complex type that contains zero or more Tag key elements. + */ + TagKeys: TagKeys; + } + export interface UpdateCloudFrontOriginAccessIdentityRequest { + /** + * The identity's configuration information. + */ + CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfig; + /** + * The identity's id. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface UpdateCloudFrontOriginAccessIdentityResult { + /** + * The origin access identity's information. + */ + CloudFrontOriginAccessIdentity?: CloudFrontOriginAccessIdentity; + /** + * The current version of the configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface UpdateDistributionRequest { + /** + * The distribution's configuration information. + */ + DistributionConfig: DistributionConfig; + /** + * The distribution's id. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface UpdateDistributionResult { + /** + * The distribution's information. + */ + Distribution?: Distribution; + /** + * The current version of the configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface UpdateFieldLevelEncryptionConfigRequest { + /** + * Request to update a field-level encryption configuration. + */ + FieldLevelEncryptionConfig: FieldLevelEncryptionConfig; + /** + * The ID of the configuration you want to update. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface UpdateFieldLevelEncryptionConfigResult { + /** + * Return the results of updating the configuration. + */ + FieldLevelEncryption?: FieldLevelEncryption; + /** + * The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface UpdateFieldLevelEncryptionProfileRequest { + /** + * Request to update a field-level encryption profile. + */ + FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfig; + /** + * The ID of the field-level encryption profile request. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface UpdateFieldLevelEncryptionProfileResult { + /** + * Return the results of updating the profile. + */ + FieldLevelEncryptionProfile?: FieldLevelEncryptionProfile; + /** + * The result of the field-level encryption profile request. + */ + ETag?: string; + } + export interface UpdatePublicKeyRequest { + /** + * Request to update public key information. + */ + PublicKeyConfig: PublicKeyConfig; + /** + * ID of the public key to be updated. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface UpdatePublicKeyResult { + /** + * Return the results of updating the public key. + */ + PublicKey?: PublicKey; + /** + * The current version of the update public key result. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface UpdateStreamingDistributionRequest { + /** + * The streaming distribution's configuration information. + */ + StreamingDistributionConfig: StreamingDistributionConfig; + /** + * The streaming distribution's id. + */ + Id: string; + /** + * The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL. + */ + IfMatch?: string; + } + export interface UpdateStreamingDistributionResult { + /** + * The streaming distribution's information. + */ + StreamingDistribution?: StreamingDistribution; + /** + * The current version of the configuration. For example: E2QWRUHAPOMQZL. + */ + ETag?: string; + } + export interface ViewerCertificate { + /** + * For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate. + */ + CloudFrontDefaultCertificate?: boolean; + /** + * For information about how and when to use IAMCertificateId, see ViewerCertificate. + */ + IAMCertificateId?: string; + /** + * For information about how and when to use ACMCertificateArn, see ViewerCertificate. + */ + ACMCertificateArn?: string; + /** + * If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients: vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges. sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following: Use the vip option (dedicated IP addresses) instead of sni-only. Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png. If you can control which browser your users use, upgrade the browser to one that supports SNI. Use HTTP instead of HTTPS. Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>. For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide. + */ + SSLSupportMethod?: SSLSupportMethod; + /** + * Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings: The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers The cipher that CloudFront uses to encrypt the content that it returns to viewers On the CloudFront console, this setting is called Security policy. We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later. When both of the following are true, you must specify TLSv1 or later for the security policy: You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId You're using SNI: you specified sni-only for SSLSupportMethod If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion. For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide. + */ + MinimumProtocolVersion?: MinimumProtocolVersion; + /** + * This field has been deprecated. Use one of the following fields instead: ViewerCertificate$ACMCertificateArn ViewerCertificate$IAMCertificateId ViewerCertificate$CloudFrontDefaultCertificate + */ + Certificate?: string; + /** + * This field has been deprecated. Use one of the following fields instead: ViewerCertificate$ACMCertificateArn ViewerCertificate$IAMCertificateId ViewerCertificate$CloudFrontDefaultCertificate + */ + CertificateSource?: CertificateSource; + } + export type ViewerProtocolPolicy = "allow-all"|"https-only"|"redirect-to-https"|string; + export type integer = number; + export type long = number; + export type timestamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-05-12"|"2013-11-11"|"2014-05-31"|"2014-10-21"|"2014-11-06"|"2015-04-17"|"2015-07-27"|"2015-09-17"|"2016-01-13"|"2016-01-28"|"2016-08-01"|"2016-08-20"|"2016-09-07"|"2016-09-29"|"2016-11-25"|"2016-11-25"|"2017-03-25"|"2017-03-25"|"2017-10-30"|"2017-10-30"|"2018-06-18"|"2018-06-18"|"2018-11-05"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudFront client. + */ + export import Types = CloudFront; +} +export = CloudFront; diff --git a/node_modules/aws-sdk/clients/cloudfront.js b/node_modules/aws-sdk/clients/cloudfront.js new file mode 100644 index 0000000..f21fed6 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudfront.js @@ -0,0 +1,60 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudfront'] = {}; +AWS.CloudFront = Service.defineService('cloudfront', ['2013-05-12*', '2013-11-11*', '2014-05-31*', '2014-10-21*', '2014-11-06*', '2015-04-17*', '2015-07-27*', '2015-09-17*', '2016-01-13*', '2016-01-28*', '2016-08-01*', '2016-08-20*', '2016-09-07*', '2016-09-29*', '2016-11-25', '2016-11-25*', '2017-03-25', '2017-03-25*', '2017-10-30', '2017-10-30*', '2018-06-18', '2018-06-18*', '2018-11-05']); +require('../lib/services/cloudfront'); +Object.defineProperty(apiLoader.services['cloudfront'], '2016-11-25', { + get: function get() { + var model = require('../apis/cloudfront-2016-11-25.min.json'); + model.paginators = require('../apis/cloudfront-2016-11-25.paginators.json').pagination; + model.waiters = require('../apis/cloudfront-2016-11-25.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['cloudfront'], '2017-03-25', { + get: function get() { + var model = require('../apis/cloudfront-2017-03-25.min.json'); + model.paginators = require('../apis/cloudfront-2017-03-25.paginators.json').pagination; + model.waiters = require('../apis/cloudfront-2017-03-25.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['cloudfront'], '2017-10-30', { + get: function get() { + var model = require('../apis/cloudfront-2017-10-30.min.json'); + model.paginators = require('../apis/cloudfront-2017-10-30.paginators.json').pagination; + model.waiters = require('../apis/cloudfront-2017-10-30.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['cloudfront'], '2018-06-18', { + get: function get() { + var model = require('../apis/cloudfront-2018-06-18.min.json'); + model.paginators = require('../apis/cloudfront-2018-06-18.paginators.json').pagination; + model.waiters = require('../apis/cloudfront-2018-06-18.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['cloudfront'], '2018-11-05', { + get: function get() { + var model = require('../apis/cloudfront-2018-11-05.min.json'); + model.paginators = require('../apis/cloudfront-2018-11-05.paginators.json').pagination; + model.waiters = require('../apis/cloudfront-2018-11-05.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudFront; diff --git a/node_modules/aws-sdk/clients/cloudhsm.d.ts b/node_modules/aws-sdk/clients/cloudhsm.d.ts new file mode 100644 index 0000000..a280c7d --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudhsm.d.ts @@ -0,0 +1,704 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudHSM extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudHSM.Types.ClientConfiguration) + config: Config & CloudHSM.Types.ClientConfiguration; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Adds or overwrites one or more tags for the specified AWS CloudHSM resource. Each tag consists of a key and a value. Tag keys must be unique to each resource. + */ + addTagsToResource(params: CloudHSM.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: CloudHSM.Types.AddTagsToResourceResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Adds or overwrites one or more tags for the specified AWS CloudHSM resource. Each tag consists of a key and a value. Tag keys must be unique to each resource. + */ + addTagsToResource(callback?: (err: AWSError, data: CloudHSM.Types.AddTagsToResourceResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. + */ + createHapg(params: CloudHSM.Types.CreateHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.CreateHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. + */ + createHapg(callback?: (err: AWSError, data: CloudHSM.Types.CreateHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an uninitialized HSM instance. There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support. It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING. + */ + createHsm(params: CloudHSM.Types.CreateHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.CreateHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an uninitialized HSM instance. There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support. It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING. + */ + createHsm(callback?: (err: AWSError, data: CloudHSM.Types.CreateHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an HSM client. + */ + createLunaClient(params: CloudHSM.Types.CreateLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.CreateLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an HSM client. + */ + createLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.CreateLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a high-availability partition group. + */ + deleteHapg(params: CloudHSM.Types.DeleteHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.DeleteHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a high-availability partition group. + */ + deleteHapg(callback?: (err: AWSError, data: CloudHSM.Types.DeleteHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered. + */ + deleteHsm(params: CloudHSM.Types.DeleteHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.DeleteHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered. + */ + deleteHsm(callback?: (err: AWSError, data: CloudHSM.Types.DeleteHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a client. + */ + deleteLunaClient(params: CloudHSM.Types.DeleteLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.DeleteLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a client. + */ + deleteLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.DeleteLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about a high-availability partition group. + */ + describeHapg(params: CloudHSM.Types.DescribeHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.DescribeHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about a high-availability partition group. + */ + describeHapg(callback?: (err: AWSError, data: CloudHSM.Types.DescribeHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. + */ + describeHsm(params: CloudHSM.Types.DescribeHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.DescribeHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. + */ + describeHsm(callback?: (err: AWSError, data: CloudHSM.Types.DescribeHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM client. + */ + describeLunaClient(params: CloudHSM.Types.DescribeLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.DescribeLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM client. + */ + describeLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.DescribeLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. + */ + getConfig(params: CloudHSM.Types.GetConfigRequest, callback?: (err: AWSError, data: CloudHSM.Types.GetConfigResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. + */ + getConfig(callback?: (err: AWSError, data: CloudHSM.Types.GetConfigResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the Availability Zones that have available AWS CloudHSM capacity. + */ + listAvailableZones(params: CloudHSM.Types.ListAvailableZonesRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListAvailableZonesResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the Availability Zones that have available AWS CloudHSM capacity. + */ + listAvailableZones(callback?: (err: AWSError, data: CloudHSM.Types.ListAvailableZonesResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the high-availability partition groups for the account. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items. + */ + listHapgs(params: CloudHSM.Types.ListHapgsRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListHapgsResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the high-availability partition groups for the account. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items. + */ + listHapgs(callback?: (err: AWSError, data: CloudHSM.Types.ListHapgsResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves the identifiers of all of the HSMs provisioned for the current customer. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items. + */ + listHsms(params: CloudHSM.Types.ListHsmsRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListHsmsResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves the identifiers of all of the HSMs provisioned for the current customer. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items. + */ + listHsms(callback?: (err: AWSError, data: CloudHSM.Types.ListHsmsResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists all of the clients. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items. + */ + listLunaClients(params: CloudHSM.Types.ListLunaClientsRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListLunaClientsResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists all of the clients. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items. + */ + listLunaClients(callback?: (err: AWSError, data: CloudHSM.Types.ListLunaClientsResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Returns a list of all tags for the specified AWS CloudHSM resource. + */ + listTagsForResource(params: CloudHSM.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListTagsForResourceResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Returns a list of all tags for the specified AWS CloudHSM resource. + */ + listTagsForResource(callback?: (err: AWSError, data: CloudHSM.Types.ListTagsForResourceResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an existing high-availability partition group. + */ + modifyHapg(params: CloudHSM.Types.ModifyHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.ModifyHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an existing high-availability partition group. + */ + modifyHapg(callback?: (err: AWSError, data: CloudHSM.Types.ModifyHapgResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an HSM. This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window. + */ + modifyHsm(params: CloudHSM.Types.ModifyHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.ModifyHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an HSM. This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window. + */ + modifyHsm(callback?: (err: AWSError, data: CloudHSM.Types.ModifyHsmResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies the certificate used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs. + */ + modifyLunaClient(params: CloudHSM.Types.ModifyLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.ModifyLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies the certificate used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs. + */ + modifyLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.ModifyLunaClientResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Removes one or more tags from the specified AWS CloudHSM resource. To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource. + */ + removeTagsFromResource(params: CloudHSM.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: CloudHSM.Types.RemoveTagsFromResourceResponse) => void): Request; + /** + * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Removes one or more tags from the specified AWS CloudHSM resource. To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource. + */ + removeTagsFromResource(callback?: (err: AWSError, data: CloudHSM.Types.RemoveTagsFromResourceResponse) => void): Request; +} +declare namespace CloudHSM { + export type AZ = string; + export type AZList = AZ[]; + export interface AddTagsToResourceRequest { + /** + * The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag. + */ + ResourceArn: String; + /** + * One or more tags. + */ + TagList: TagList; + } + export interface AddTagsToResourceResponse { + /** + * The status of the operation. + */ + Status: String; + } + export type Certificate = string; + export type CertificateFingerprint = string; + export type ClientArn = string; + export type ClientLabel = string; + export type ClientList = ClientArn[]; + export type ClientToken = string; + export type ClientVersion = "5.1"|"5.3"|string; + export type CloudHsmObjectState = "READY"|"UPDATING"|"DEGRADED"|string; + export interface CreateHapgRequest { + /** + * The label of the new high-availability partition group. + */ + Label: Label; + } + export interface CreateHapgResponse { + /** + * The ARN of the high-availability partition group. + */ + HapgArn?: HapgArn; + } + export interface CreateHsmRequest { + /** + * The identifier of the subnet in your VPC in which to place the HSM. + */ + SubnetId: SubnetId; + /** + * The SSH public key to install on the HSM. + */ + SshKey: SshKey; + /** + * The IP address to assign to the HSM's ENI. If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet. + */ + EniIp?: IpAddress; + /** + * The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf. + */ + IamRoleArn: IamRoleArn; + /** + * The external ID from IamRoleArn, if present. + */ + ExternalId?: ExternalId; + SubscriptionType: SubscriptionType; + /** + * A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored. + */ + ClientToken?: ClientToken; + /** + * The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server. + */ + SyslogIp?: IpAddress; + } + export interface CreateHsmResponse { + /** + * The ARN of the HSM. + */ + HsmArn?: HsmArn; + } + export interface CreateLunaClientRequest { + /** + * The label for the client. + */ + Label?: ClientLabel; + /** + * The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client. + */ + Certificate: Certificate; + } + export interface CreateLunaClientResponse { + /** + * The ARN of the client. + */ + ClientArn?: ClientArn; + } + export interface DeleteHapgRequest { + /** + * The ARN of the high-availability partition group to delete. + */ + HapgArn: HapgArn; + } + export interface DeleteHapgResponse { + /** + * The status of the action. + */ + Status: String; + } + export interface DeleteHsmRequest { + /** + * The ARN of the HSM to delete. + */ + HsmArn: HsmArn; + } + export interface DeleteHsmResponse { + /** + * The status of the operation. + */ + Status: String; + } + export interface DeleteLunaClientRequest { + /** + * The ARN of the client to delete. + */ + ClientArn: ClientArn; + } + export interface DeleteLunaClientResponse { + /** + * The status of the action. + */ + Status: String; + } + export interface DescribeHapgRequest { + /** + * The ARN of the high-availability partition group to describe. + */ + HapgArn: HapgArn; + } + export interface DescribeHapgResponse { + /** + * The ARN of the high-availability partition group. + */ + HapgArn?: HapgArn; + /** + * The serial number of the high-availability partition group. + */ + HapgSerial?: String; + /** + * + */ + HsmsLastActionFailed?: HsmList; + /** + * + */ + HsmsPendingDeletion?: HsmList; + /** + * + */ + HsmsPendingRegistration?: HsmList; + /** + * The label for the high-availability partition group. + */ + Label?: Label; + /** + * The date and time the high-availability partition group was last modified. + */ + LastModifiedTimestamp?: Timestamp; + /** + * The list of partition serial numbers that belong to the high-availability partition group. + */ + PartitionSerialList?: PartitionSerialList; + /** + * The state of the high-availability partition group. + */ + State?: CloudHsmObjectState; + } + export interface DescribeHsmRequest { + /** + * The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified. + */ + HsmArn?: HsmArn; + /** + * The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified. + */ + HsmSerialNumber?: HsmSerialNumber; + } + export interface DescribeHsmResponse { + /** + * The ARN of the HSM. + */ + HsmArn?: HsmArn; + /** + * The status of the HSM. + */ + Status?: HsmStatus; + /** + * Contains additional information about the status of the HSM. + */ + StatusDetails?: String; + /** + * The Availability Zone that the HSM is in. + */ + AvailabilityZone?: AZ; + /** + * The identifier of the elastic network interface (ENI) attached to the HSM. + */ + EniId?: EniId; + /** + * The IP address assigned to the HSM's ENI. + */ + EniIp?: IpAddress; + SubscriptionType?: SubscriptionType; + /** + * The subscription start date. + */ + SubscriptionStartDate?: Timestamp; + /** + * The subscription end date. + */ + SubscriptionEndDate?: Timestamp; + /** + * The identifier of the VPC that the HSM is in. + */ + VpcId?: VpcId; + /** + * The identifier of the subnet that the HSM is in. + */ + SubnetId?: SubnetId; + /** + * The ARN of the IAM role assigned to the HSM. + */ + IamRoleArn?: IamRoleArn; + /** + * The serial number of the HSM. + */ + SerialNumber?: HsmSerialNumber; + /** + * The name of the HSM vendor. + */ + VendorName?: String; + /** + * The HSM model type. + */ + HsmType?: String; + /** + * The HSM software version. + */ + SoftwareVersion?: String; + /** + * The public SSH key. + */ + SshPublicKey?: SshKey; + /** + * The date and time that the SSH key was last updated. + */ + SshKeyLastUpdated?: Timestamp; + /** + * The URI of the certificate server. + */ + ServerCertUri?: String; + /** + * The date and time that the server certificate was last updated. + */ + ServerCertLastUpdated?: Timestamp; + /** + * The list of partitions on the HSM. + */ + Partitions?: PartitionList; + } + export interface DescribeLunaClientRequest { + /** + * The ARN of the client. + */ + ClientArn?: ClientArn; + /** + * The certificate fingerprint. + */ + CertificateFingerprint?: CertificateFingerprint; + } + export interface DescribeLunaClientResponse { + /** + * The ARN of the client. + */ + ClientArn?: ClientArn; + /** + * The certificate installed on the HSMs used by this client. + */ + Certificate?: Certificate; + /** + * The certificate fingerprint. + */ + CertificateFingerprint?: CertificateFingerprint; + /** + * The date and time the client was last modified. + */ + LastModifiedTimestamp?: Timestamp; + /** + * The label of the client. + */ + Label?: Label; + } + export type EniId = string; + export type ExternalId = string; + export interface GetConfigRequest { + /** + * The ARN of the client. + */ + ClientArn: ClientArn; + /** + * The client version. + */ + ClientVersion: ClientVersion; + /** + * A list of ARNs that identify the high-availability partition groups that are associated with the client. + */ + HapgList: HapgList; + } + export interface GetConfigResponse { + /** + * The type of credentials. + */ + ConfigType?: String; + /** + * The chrystoki.conf configuration file. + */ + ConfigFile?: String; + /** + * The certificate file containing the server.pem files of the HSMs. + */ + ConfigCred?: String; + } + export type HapgArn = string; + export type HapgList = HapgArn[]; + export type HsmArn = string; + export type HsmList = HsmArn[]; + export type HsmSerialNumber = string; + export type HsmStatus = "PENDING"|"RUNNING"|"UPDATING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|"DEGRADED"|string; + export type IamRoleArn = string; + export type IpAddress = string; + export type Label = string; + export interface ListAvailableZonesRequest { + } + export interface ListAvailableZonesResponse { + /** + * The list of Availability Zones that have available AWS CloudHSM capacity. + */ + AZList?: AZList; + } + export interface ListHapgsRequest { + /** + * The NextToken value from a previous call to ListHapgs. Pass null if this is the first call. + */ + NextToken?: PaginationToken; + } + export interface ListHapgsResponse { + /** + * The list of high-availability partition groups. + */ + HapgList: HapgList; + /** + * If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items. + */ + NextToken?: PaginationToken; + } + export interface ListHsmsRequest { + /** + * The NextToken value from a previous call to ListHsms. Pass null if this is the first call. + */ + NextToken?: PaginationToken; + } + export interface ListHsmsResponse { + /** + * The list of ARNs that identify the HSMs. + */ + HsmList?: HsmList; + /** + * If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items. + */ + NextToken?: PaginationToken; + } + export interface ListLunaClientsRequest { + /** + * The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call. + */ + NextToken?: PaginationToken; + } + export interface ListLunaClientsResponse { + /** + * The list of clients. + */ + ClientList: ClientList; + /** + * If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items. + */ + NextToken?: PaginationToken; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the AWS CloudHSM resource. + */ + ResourceArn: String; + } + export interface ListTagsForResourceResponse { + /** + * One or more tags. + */ + TagList: TagList; + } + export interface ModifyHapgRequest { + /** + * The ARN of the high-availability partition group to modify. + */ + HapgArn: HapgArn; + /** + * The new label for the high-availability partition group. + */ + Label?: Label; + /** + * The list of partition serial numbers to make members of the high-availability partition group. + */ + PartitionSerialList?: PartitionSerialList; + } + export interface ModifyHapgResponse { + /** + * The ARN of the high-availability partition group. + */ + HapgArn?: HapgArn; + } + export interface ModifyHsmRequest { + /** + * The ARN of the HSM to modify. + */ + HsmArn: HsmArn; + /** + * The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet. + */ + SubnetId?: SubnetId; + /** + * The new IP address for the elastic network interface (ENI) attached to the HSM. If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet. + */ + EniIp?: IpAddress; + /** + * The new IAM role ARN. + */ + IamRoleArn?: IamRoleArn; + /** + * The new external ID. + */ + ExternalId?: ExternalId; + /** + * The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server. + */ + SyslogIp?: IpAddress; + } + export interface ModifyHsmResponse { + /** + * The ARN of the HSM. + */ + HsmArn?: HsmArn; + } + export interface ModifyLunaClientRequest { + /** + * The ARN of the client. + */ + ClientArn: ClientArn; + /** + * The new certificate for the client. + */ + Certificate: Certificate; + } + export interface ModifyLunaClientResponse { + /** + * The ARN of the client. + */ + ClientArn?: ClientArn; + } + export type PaginationToken = string; + export type PartitionArn = string; + export type PartitionList = PartitionArn[]; + export type PartitionSerial = string; + export type PartitionSerialList = PartitionSerial[]; + export interface RemoveTagsFromResourceRequest { + /** + * The Amazon Resource Name (ARN) of the AWS CloudHSM resource. + */ + ResourceArn: String; + /** + * The tag key or keys to remove. Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource. + */ + TagKeyList: TagKeyList; + } + export interface RemoveTagsFromResourceResponse { + /** + * The status of the operation. + */ + Status: String; + } + export type SshKey = string; + export type String = string; + export type SubnetId = string; + export type SubscriptionType = "PRODUCTION"|string; + export interface Tag { + /** + * The key of the tag. + */ + Key: TagKey; + /** + * The value of the tag. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export type TagValue = string; + export type Timestamp = string; + export type VpcId = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-05-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudHSM client. + */ + export import Types = CloudHSM; +} +export = CloudHSM; diff --git a/node_modules/aws-sdk/clients/cloudhsm.js b/node_modules/aws-sdk/clients/cloudhsm.js new file mode 100644 index 0000000..9ab842b --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudhsm.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudhsm'] = {}; +AWS.CloudHSM = Service.defineService('cloudhsm', ['2014-05-30']); +Object.defineProperty(apiLoader.services['cloudhsm'], '2014-05-30', { + get: function get() { + var model = require('../apis/cloudhsm-2014-05-30.min.json'); + model.paginators = require('../apis/cloudhsm-2014-05-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudHSM; diff --git a/node_modules/aws-sdk/clients/cloudhsmv2.d.ts b/node_modules/aws-sdk/clients/cloudhsmv2.d.ts new file mode 100644 index 0000000..4f1eedc --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudhsmv2.d.ts @@ -0,0 +1,560 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudHSMV2 extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudHSMV2.Types.ClientConfiguration) + config: Config & CloudHSMV2.Types.ClientConfiguration; + /** + * Copy an AWS CloudHSM cluster backup to a different region. + */ + copyBackupToRegion(params: CloudHSMV2.Types.CopyBackupToRegionRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CopyBackupToRegionResponse) => void): Request; + /** + * Copy an AWS CloudHSM cluster backup to a different region. + */ + copyBackupToRegion(callback?: (err: AWSError, data: CloudHSMV2.Types.CopyBackupToRegionResponse) => void): Request; + /** + * Creates a new AWS CloudHSM cluster. + */ + createCluster(params: CloudHSMV2.Types.CreateClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CreateClusterResponse) => void): Request; + /** + * Creates a new AWS CloudHSM cluster. + */ + createCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.CreateClusterResponse) => void): Request; + /** + * Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. + */ + createHsm(params: CloudHSMV2.Types.CreateHsmRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CreateHsmResponse) => void): Request; + /** + * Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. + */ + createHsm(callback?: (err: AWSError, data: CloudHSMV2.Types.CreateHsmResponse) => void): Request; + /** + * Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup + */ + deleteBackup(params: CloudHSMV2.Types.DeleteBackupRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteBackupResponse) => void): Request; + /** + * Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup + */ + deleteBackup(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteBackupResponse) => void): Request; + /** + * Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm. + */ + deleteCluster(params: CloudHSMV2.Types.DeleteClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm. + */ + deleteCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters. + */ + deleteHsm(params: CloudHSMV2.Types.DeleteHsmRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteHsmResponse) => void): Request; + /** + * Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters. + */ + deleteHsm(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteHsmResponse) => void): Request; + /** + * Gets information about backups of AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get. + */ + describeBackups(params: CloudHSMV2.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeBackupsResponse) => void): Request; + /** + * Gets information about backups of AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get. + */ + describeBackups(callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeBackupsResponse) => void): Request; + /** + * Gets information about AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get. + */ + describeClusters(params: CloudHSMV2.Types.DescribeClustersRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeClustersResponse) => void): Request; + /** + * Gets information about AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get. + */ + describeClusters(callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeClustersResponse) => void): Request; + /** + * Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters. + */ + initializeCluster(params: CloudHSMV2.Types.InitializeClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.InitializeClusterResponse) => void): Request; + /** + * Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters. + */ + initializeCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.InitializeClusterResponse) => void): Request; + /** + * Gets a list of tags for the specified AWS CloudHSM cluster. This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get. + */ + listTags(params: CloudHSMV2.Types.ListTagsRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.ListTagsResponse) => void): Request; + /** + * Gets a list of tags for the specified AWS CloudHSM cluster. This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get. + */ + listTags(callback?: (err: AWSError, data: CloudHSMV2.Types.ListTagsResponse) => void): Request; + /** + * Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup. + */ + restoreBackup(params: CloudHSMV2.Types.RestoreBackupRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.RestoreBackupResponse) => void): Request; + /** + * Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup. + */ + restoreBackup(callback?: (err: AWSError, data: CloudHSMV2.Types.RestoreBackupResponse) => void): Request; + /** + * Adds or overwrites one or more tags for the specified AWS CloudHSM cluster. + */ + tagResource(params: CloudHSMV2.Types.TagResourceRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.TagResourceResponse) => void): Request; + /** + * Adds or overwrites one or more tags for the specified AWS CloudHSM cluster. + */ + tagResource(callback?: (err: AWSError, data: CloudHSMV2.Types.TagResourceResponse) => void): Request; + /** + * Removes the specified tag or tags from the specified AWS CloudHSM cluster. + */ + untagResource(params: CloudHSMV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.UntagResourceResponse) => void): Request; + /** + * Removes the specified tag or tags from the specified AWS CloudHSM cluster. + */ + untagResource(callback?: (err: AWSError, data: CloudHSMV2.Types.UntagResourceResponse) => void): Request; +} +declare namespace CloudHSMV2 { + export interface Backup { + /** + * The identifier (ID) of the backup. + */ + BackupId: BackupId; + /** + * The state of the backup. + */ + BackupState?: BackupState; + /** + * The identifier (ID) of the cluster that was backed up. + */ + ClusterId?: ClusterId; + /** + * The date and time when the backup was created. + */ + CreateTimestamp?: Timestamp; + CopyTimestamp?: Timestamp; + SourceRegion?: Region; + SourceBackup?: BackupId; + SourceCluster?: ClusterId; + /** + * The date and time when the backup will be permanently deleted. + */ + DeleteTimestamp?: Timestamp; + } + export type BackupId = string; + export type BackupPolicy = "DEFAULT"|string; + export type BackupState = "CREATE_IN_PROGRESS"|"READY"|"DELETED"|"PENDING_DELETION"|string; + export type Backups = Backup[]; + export type Boolean = boolean; + export type Cert = string; + export interface Certificates { + /** + * The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED. + */ + ClusterCsr?: Cert; + /** + * The HSM certificate issued (signed) by the HSM hardware. + */ + HsmCertificate?: Cert; + /** + * The HSM hardware certificate issued (signed) by AWS CloudHSM. + */ + AwsHardwareCertificate?: Cert; + /** + * The HSM hardware certificate issued (signed) by the hardware manufacturer. + */ + ManufacturerHardwareCertificate?: Cert; + /** + * The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner. + */ + ClusterCertificate?: Cert; + } + export interface Cluster { + /** + * The cluster's backup policy. + */ + BackupPolicy?: BackupPolicy; + /** + * The cluster's identifier (ID). + */ + ClusterId?: ClusterId; + /** + * The date and time when the cluster was created. + */ + CreateTimestamp?: Timestamp; + /** + * Contains information about the HSMs in the cluster. + */ + Hsms?: Hsms; + /** + * The type of HSM that the cluster contains. + */ + HsmType?: HsmType; + /** + * The default password for the cluster's Pre-Crypto Officer (PRECO) user. + */ + PreCoPassword?: PreCoPassword; + /** + * The identifier (ID) of the cluster's security group. + */ + SecurityGroup?: SecurityGroup; + /** + * The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup. + */ + SourceBackupId?: BackupId; + /** + * The cluster's state. + */ + State?: ClusterState; + /** + * A description of the cluster's state. + */ + StateMessage?: StateMessage; + /** + * A map of the cluster's subnets and their corresponding Availability Zones. + */ + SubnetMapping?: ExternalSubnetMapping; + /** + * The identifier (ID) of the virtual private cloud (VPC) that contains the cluster. + */ + VpcId?: VpcId; + /** + * Contains one or more certificates or a certificate signing request (CSR). + */ + Certificates?: Certificates; + } + export type ClusterId = string; + export type ClusterState = "CREATE_IN_PROGRESS"|"UNINITIALIZED"|"INITIALIZE_IN_PROGRESS"|"INITIALIZED"|"ACTIVE"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DEGRADED"|string; + export type Clusters = Cluster[]; + export interface CopyBackupToRegionRequest { + /** + * The AWS region that will contain your copied CloudHSM cluster backup. + */ + DestinationRegion: Region; + /** + * The ID of the backup that will be copied to the destination region. + */ + BackupId: BackupId; + } + export interface CopyBackupToRegionResponse { + /** + * Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup. You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region. + */ + DestinationBackup?: DestinationBackup; + } + export interface CreateClusterRequest { + /** + * The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria: All subnets must be in the same virtual private cloud (VPC). You can specify only one subnet per Availability Zone. + */ + SubnetIds: SubnetIds; + /** + * The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium. + */ + HsmType: HsmType; + /** + * The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups. + */ + SourceBackupId?: BackupId; + } + export interface CreateClusterResponse { + /** + * Information about the cluster that was created. + */ + Cluster?: Cluster; + } + export interface CreateHsmRequest { + /** + * The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters. + */ + ClusterId: ClusterId; + /** + * The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters. + */ + AvailabilityZone: ExternalAz; + /** + * The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet. + */ + IpAddress?: IpAddress; + } + export interface CreateHsmResponse { + /** + * Information about the HSM that was created. + */ + Hsm?: Hsm; + } + export interface DeleteBackupRequest { + /** + * The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation. + */ + BackupId: BackupId; + } + export interface DeleteBackupResponse { + /** + * Information on the Backup object deleted. + */ + Backup?: Backup; + } + export interface DeleteClusterRequest { + /** + * The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters. + */ + ClusterId: ClusterId; + } + export interface DeleteClusterResponse { + /** + * Information about the cluster that was deleted. + */ + Cluster?: Cluster; + } + export interface DeleteHsmRequest { + /** + * The identifier (ID) of the cluster that contains the HSM that you are deleting. + */ + ClusterId: ClusterId; + /** + * The identifier (ID) of the HSM that you are deleting. + */ + HsmId?: HsmId; + /** + * The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting. + */ + EniId?: EniId; + /** + * The IP address of the elastic network interface (ENI) of the HSM that you are deleting. + */ + EniIp?: IpAddress; + } + export interface DeleteHsmResponse { + /** + * The identifier (ID) of the HSM that was deleted. + */ + HsmId?: HsmId; + } + export interface DescribeBackupsRequest { + /** + * The NextToken value that you received in the previous response. Use this value to get more backups. + */ + NextToken?: NextToken; + /** + * The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value. + */ + MaxResults?: MaxSize; + /** + * One or more filters to limit the items returned in the response. Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID). Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID). Use the states filter to return only backups that match the specified state. + */ + Filters?: Filters; + SortAscending?: Boolean; + } + export interface DescribeBackupsResponse { + /** + * A list of backups. + */ + Backups?: Backups; + /** + * An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups. + */ + NextToken?: NextToken; + } + export interface DescribeClustersRequest { + /** + * One or more filters to limit the items returned in the response. Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID). Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID). Use the states filter to return only clusters that match the specified state. + */ + Filters?: Filters; + /** + * The NextToken value that you received in the previous response. Use this value to get more clusters. + */ + NextToken?: NextToken; + /** + * The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value. + */ + MaxResults?: MaxSize; + } + export interface DescribeClustersResponse { + /** + * A list of clusters. + */ + Clusters?: Clusters; + /** + * An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters. + */ + NextToken?: NextToken; + } + export interface DestinationBackup { + CreateTimestamp?: Timestamp; + SourceRegion?: Region; + SourceBackup?: BackupId; + SourceCluster?: ClusterId; + } + export type EniId = string; + export type ExternalAz = string; + export type ExternalSubnetMapping = {[key: string]: SubnetId}; + export type Field = string; + export type Filters = {[key: string]: Strings}; + export interface Hsm { + /** + * The Availability Zone that contains the HSM. + */ + AvailabilityZone?: ExternalAz; + /** + * The identifier (ID) of the cluster that contains the HSM. + */ + ClusterId?: ClusterId; + /** + * The subnet that contains the HSM's elastic network interface (ENI). + */ + SubnetId?: SubnetId; + /** + * The identifier (ID) of the HSM's elastic network interface (ENI). + */ + EniId?: EniId; + /** + * The IP address of the HSM's elastic network interface (ENI). + */ + EniIp?: IpAddress; + /** + * The HSM's identifier (ID). + */ + HsmId: HsmId; + /** + * The HSM's state. + */ + State?: HsmState; + /** + * A description of the HSM's state. + */ + StateMessage?: String; + } + export type HsmId = string; + export type HsmState = "CREATE_IN_PROGRESS"|"ACTIVE"|"DEGRADED"|"DELETE_IN_PROGRESS"|"DELETED"|string; + export type HsmType = string; + export type Hsms = Hsm[]; + export interface InitializeClusterRequest { + /** + * The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters. + */ + ClusterId: ClusterId; + /** + * The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters. + */ + SignedCert: Cert; + /** + * The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters. + */ + TrustAnchor: Cert; + } + export interface InitializeClusterResponse { + /** + * The cluster's state. + */ + State?: ClusterState; + /** + * A description of the cluster's state. + */ + StateMessage?: StateMessage; + } + export type IpAddress = string; + export interface ListTagsRequest { + /** + * The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters. + */ + ResourceId: ClusterId; + /** + * The NextToken value that you received in the previous response. Use this value to get more tags. + */ + NextToken?: NextToken; + /** + * The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value. + */ + MaxResults?: MaxSize; + } + export interface ListTagsResponse { + /** + * A list of tags. + */ + TagList: TagList; + /** + * An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags. + */ + NextToken?: NextToken; + } + export type MaxSize = number; + export type NextToken = string; + export type PreCoPassword = string; + export type Region = string; + export interface RestoreBackupRequest { + /** + * The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation. + */ + BackupId: BackupId; + } + export interface RestoreBackupResponse { + /** + * Information on the Backup object created. + */ + Backup?: Backup; + } + export type SecurityGroup = string; + export type StateMessage = string; + export type String = string; + export type Strings = String[]; + export type SubnetId = string; + export type SubnetIds = SubnetId[]; + export interface Tag { + /** + * The key of the tag. + */ + Key: TagKey; + /** + * The value of the tag. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters. + */ + ResourceId: ClusterId; + /** + * A list of one or more tags. + */ + TagList: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Timestamp = Date; + export interface UntagResourceRequest { + /** + * The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters. + */ + ResourceId: ClusterId; + /** + * A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values. + */ + TagKeyList: TagKeyList; + } + export interface UntagResourceResponse { + } + export type VpcId = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-04-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudHSMV2 client. + */ + export import Types = CloudHSMV2; +} +export = CloudHSMV2; diff --git a/node_modules/aws-sdk/clients/cloudhsmv2.js b/node_modules/aws-sdk/clients/cloudhsmv2.js new file mode 100644 index 0000000..bc607ed --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudhsmv2.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudhsmv2'] = {}; +AWS.CloudHSMV2 = Service.defineService('cloudhsmv2', ['2017-04-28']); +Object.defineProperty(apiLoader.services['cloudhsmv2'], '2017-04-28', { + get: function get() { + var model = require('../apis/cloudhsmv2-2017-04-28.min.json'); + model.paginators = require('../apis/cloudhsmv2-2017-04-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudHSMV2; diff --git a/node_modules/aws-sdk/clients/cloudsearch.d.ts b/node_modules/aws-sdk/clients/cloudsearch.d.ts new file mode 100644 index 0000000..850e9e6 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudsearch.d.ts @@ -0,0 +1,983 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudSearch extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudSearch.Types.ClientConfiguration) + config: Config & CloudSearch.Types.ClientConfiguration; + /** + * Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide. + */ + buildSuggesters(params: CloudSearch.Types.BuildSuggestersRequest, callback?: (err: AWSError, data: CloudSearch.Types.BuildSuggestersResponse) => void): Request; + /** + * Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide. + */ + buildSuggesters(callback?: (err: AWSError, data: CloudSearch.Types.BuildSuggestersResponse) => void): Request; + /** + * Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide. + */ + createDomain(params: CloudSearch.Types.CreateDomainRequest, callback?: (err: AWSError, data: CloudSearch.Types.CreateDomainResponse) => void): Request; + /** + * Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide. + */ + createDomain(callback?: (err: AWSError, data: CloudSearch.Types.CreateDomainResponse) => void): Request; + /** + * Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. + */ + defineAnalysisScheme(params: CloudSearch.Types.DefineAnalysisSchemeRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineAnalysisSchemeResponse) => void): Request; + /** + * Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. + */ + defineAnalysisScheme(callback?: (err: AWSError, data: CloudSearch.Types.DefineAnalysisSchemeResponse) => void): Request; + /** + * Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. + */ + defineExpression(params: CloudSearch.Types.DefineExpressionRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineExpressionResponse) => void): Request; + /** + * Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. + */ + defineExpression(callback?: (err: AWSError, data: CloudSearch.Types.DefineExpressionResponse) => void): Request; + /** + * Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide. + */ + defineIndexField(params: CloudSearch.Types.DefineIndexFieldRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineIndexFieldResponse) => void): Request; + /** + * Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide. + */ + defineIndexField(callback?: (err: AWSError, data: CloudSearch.Types.DefineIndexFieldResponse) => void): Request; + /** + * Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. + */ + defineSuggester(params: CloudSearch.Types.DefineSuggesterRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineSuggesterResponse) => void): Request; + /** + * Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. + */ + defineSuggester(callback?: (err: AWSError, data: CloudSearch.Types.DefineSuggesterResponse) => void): Request; + /** + * Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. + */ + deleteAnalysisScheme(params: CloudSearch.Types.DeleteAnalysisSchemeRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteAnalysisSchemeResponse) => void): Request; + /** + * Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. + */ + deleteAnalysisScheme(callback?: (err: AWSError, data: CloudSearch.Types.DeleteAnalysisSchemeResponse) => void): Request; + /** + * Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide. + */ + deleteDomain(params: CloudSearch.Types.DeleteDomainRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteDomainResponse) => void): Request; + /** + * Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide. + */ + deleteDomain(callback?: (err: AWSError, data: CloudSearch.Types.DeleteDomainResponse) => void): Request; + /** + * Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. + */ + deleteExpression(params: CloudSearch.Types.DeleteExpressionRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteExpressionResponse) => void): Request; + /** + * Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. + */ + deleteExpression(callback?: (err: AWSError, data: CloudSearch.Types.DeleteExpressionResponse) => void): Request; + /** + * Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide. + */ + deleteIndexField(params: CloudSearch.Types.DeleteIndexFieldRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteIndexFieldResponse) => void): Request; + /** + * Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide. + */ + deleteIndexField(callback?: (err: AWSError, data: CloudSearch.Types.DeleteIndexFieldResponse) => void): Request; + /** + * Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. + */ + deleteSuggester(params: CloudSearch.Types.DeleteSuggesterRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteSuggesterResponse) => void): Request; + /** + * Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. + */ + deleteSuggester(callback?: (err: AWSError, data: CloudSearch.Types.DeleteSuggesterResponse) => void): Request; + /** + * Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. + */ + describeAnalysisSchemes(params: CloudSearch.Types.DescribeAnalysisSchemesRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeAnalysisSchemesResponse) => void): Request; + /** + * Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. + */ + describeAnalysisSchemes(callback?: (err: AWSError, data: CloudSearch.Types.DescribeAnalysisSchemesResponse) => void): Request; + /** + * Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide. + */ + describeAvailabilityOptions(params: CloudSearch.Types.DescribeAvailabilityOptionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeAvailabilityOptionsResponse) => void): Request; + /** + * Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide. + */ + describeAvailabilityOptions(callback?: (err: AWSError, data: CloudSearch.Types.DescribeAvailabilityOptionsResponse) => void): Request; + /** + * Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide. + */ + describeDomains(params: CloudSearch.Types.DescribeDomainsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainsResponse) => void): Request; + /** + * Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide. + */ + describeDomains(callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainsResponse) => void): Request; + /** + * Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. + */ + describeExpressions(params: CloudSearch.Types.DescribeExpressionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeExpressionsResponse) => void): Request; + /** + * Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. + */ + describeExpressions(callback?: (err: AWSError, data: CloudSearch.Types.DescribeExpressionsResponse) => void): Request; + /** + * Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide. + */ + describeIndexFields(params: CloudSearch.Types.DescribeIndexFieldsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeIndexFieldsResponse) => void): Request; + /** + * Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide. + */ + describeIndexFields(callback?: (err: AWSError, data: CloudSearch.Types.DescribeIndexFieldsResponse) => void): Request; + /** + * Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. + */ + describeScalingParameters(params: CloudSearch.Types.DescribeScalingParametersRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeScalingParametersResponse) => void): Request; + /** + * Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. + */ + describeScalingParameters(callback?: (err: AWSError, data: CloudSearch.Types.DescribeScalingParametersResponse) => void): Request; + /** + * Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. + */ + describeServiceAccessPolicies(params: CloudSearch.Types.DescribeServiceAccessPoliciesRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeServiceAccessPoliciesResponse) => void): Request; + /** + * Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. + */ + describeServiceAccessPolicies(callback?: (err: AWSError, data: CloudSearch.Types.DescribeServiceAccessPoliciesResponse) => void): Request; + /** + * Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. + */ + describeSuggesters(params: CloudSearch.Types.DescribeSuggestersRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeSuggestersResponse) => void): Request; + /** + * Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. + */ + describeSuggesters(callback?: (err: AWSError, data: CloudSearch.Types.DescribeSuggestersResponse) => void): Request; + /** + * Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments. + */ + indexDocuments(params: CloudSearch.Types.IndexDocumentsRequest, callback?: (err: AWSError, data: CloudSearch.Types.IndexDocumentsResponse) => void): Request; + /** + * Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments. + */ + indexDocuments(callback?: (err: AWSError, data: CloudSearch.Types.IndexDocumentsResponse) => void): Request; + /** + * Lists all search domains owned by an account. + */ + listDomainNames(callback?: (err: AWSError, data: CloudSearch.Types.ListDomainNamesResponse) => void): Request; + /** + * Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide. + */ + updateAvailabilityOptions(params: CloudSearch.Types.UpdateAvailabilityOptionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateAvailabilityOptionsResponse) => void): Request; + /** + * Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide. + */ + updateAvailabilityOptions(callback?: (err: AWSError, data: CloudSearch.Types.UpdateAvailabilityOptionsResponse) => void): Request; + /** + * Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. + */ + updateScalingParameters(params: CloudSearch.Types.UpdateScalingParametersRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateScalingParametersResponse) => void): Request; + /** + * Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. + */ + updateScalingParameters(callback?: (err: AWSError, data: CloudSearch.Types.UpdateScalingParametersResponse) => void): Request; + /** + * Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain. + */ + updateServiceAccessPolicies(params: CloudSearch.Types.UpdateServiceAccessPoliciesRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateServiceAccessPoliciesResponse) => void): Request; + /** + * Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain. + */ + updateServiceAccessPolicies(callback?: (err: AWSError, data: CloudSearch.Types.UpdateServiceAccessPoliciesResponse) => void): Request; +} +declare namespace CloudSearch { + export type APIVersion = string; + export type ARN = string; + export interface AccessPoliciesStatus { + Options: PolicyDocument; + Status: OptionStatus; + } + export type AlgorithmicStemming = "none"|"minimal"|"light"|"full"|string; + export interface AnalysisOptions { + /** + * A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide. + */ + Synonyms?: String; + /** + * A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. + */ + Stopwords?: String; + /** + * A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB. + */ + StemmingDictionary?: String; + /** + * A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields. + */ + JapaneseTokenizationDictionary?: String; + /** + * The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide + */ + AlgorithmicStemming?: AlgorithmicStemming; + } + export interface AnalysisScheme { + AnalysisSchemeName: StandardName; + AnalysisSchemeLanguage: AnalysisSchemeLanguage; + AnalysisOptions?: AnalysisOptions; + } + export type AnalysisSchemeLanguage = "ar"|"bg"|"ca"|"cs"|"da"|"de"|"el"|"en"|"es"|"eu"|"fa"|"fi"|"fr"|"ga"|"gl"|"he"|"hi"|"hu"|"hy"|"id"|"it"|"ja"|"ko"|"lv"|"mul"|"nl"|"no"|"pt"|"ro"|"ru"|"sv"|"th"|"tr"|"zh-Hans"|"zh-Hant"|string; + export interface AnalysisSchemeStatus { + Options: AnalysisScheme; + Status: OptionStatus; + } + export type AnalysisSchemeStatusList = AnalysisSchemeStatus[]; + export interface AvailabilityOptionsStatus { + /** + * The availability options configured for the domain. + */ + Options: MultiAZ; + Status: OptionStatus; + } + export type Boolean = boolean; + export interface BuildSuggestersRequest { + DomainName: DomainName; + } + export interface BuildSuggestersResponse { + FieldNames?: FieldNameList; + } + export interface CreateDomainRequest { + /** + * A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long. + */ + DomainName: DomainName; + } + export interface CreateDomainResponse { + DomainStatus?: DomainStatus; + } + export interface DateArrayOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: FieldValue; + /** + * A list of source fields to map to the field. + */ + SourceFields?: FieldNameCommaList; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + } + export interface DateOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: FieldValue; + SourceField?: FieldName; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + /** + * Whether the field can be used to sort the search results. + */ + SortEnabled?: Boolean; + } + export interface DefineAnalysisSchemeRequest { + DomainName: DomainName; + AnalysisScheme: AnalysisScheme; + } + export interface DefineAnalysisSchemeResponse { + AnalysisScheme: AnalysisSchemeStatus; + } + export interface DefineExpressionRequest { + DomainName: DomainName; + Expression: Expression; + } + export interface DefineExpressionResponse { + Expression: ExpressionStatus; + } + export interface DefineIndexFieldRequest { + DomainName: DomainName; + /** + * The index field and field options you want to configure. + */ + IndexField: IndexField; + } + export interface DefineIndexFieldResponse { + IndexField: IndexFieldStatus; + } + export interface DefineSuggesterRequest { + DomainName: DomainName; + Suggester: Suggester; + } + export interface DefineSuggesterResponse { + Suggester: SuggesterStatus; + } + export interface DeleteAnalysisSchemeRequest { + DomainName: DomainName; + /** + * The name of the analysis scheme you want to delete. + */ + AnalysisSchemeName: StandardName; + } + export interface DeleteAnalysisSchemeResponse { + /** + * The status of the analysis scheme being deleted. + */ + AnalysisScheme: AnalysisSchemeStatus; + } + export interface DeleteDomainRequest { + /** + * The name of the domain you want to permanently delete. + */ + DomainName: DomainName; + } + export interface DeleteDomainResponse { + DomainStatus?: DomainStatus; + } + export interface DeleteExpressionRequest { + DomainName: DomainName; + /** + * The name of the Expression to delete. + */ + ExpressionName: StandardName; + } + export interface DeleteExpressionResponse { + /** + * The status of the expression being deleted. + */ + Expression: ExpressionStatus; + } + export interface DeleteIndexFieldRequest { + DomainName: DomainName; + /** + * The name of the index field your want to remove from the domain's indexing options. + */ + IndexFieldName: DynamicFieldName; + } + export interface DeleteIndexFieldResponse { + /** + * The status of the index field being deleted. + */ + IndexField: IndexFieldStatus; + } + export interface DeleteSuggesterRequest { + DomainName: DomainName; + /** + * Specifies the name of the suggester you want to delete. + */ + SuggesterName: StandardName; + } + export interface DeleteSuggesterResponse { + /** + * The status of the suggester being deleted. + */ + Suggester: SuggesterStatus; + } + export interface DescribeAnalysisSchemesRequest { + /** + * The name of the domain you want to describe. + */ + DomainName: DomainName; + /** + * The analysis schemes you want to describe. + */ + AnalysisSchemeNames?: StandardNameList; + /** + * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. + */ + Deployed?: Boolean; + } + export interface DescribeAnalysisSchemesResponse { + /** + * The analysis scheme descriptions. + */ + AnalysisSchemes: AnalysisSchemeStatusList; + } + export interface DescribeAvailabilityOptionsRequest { + /** + * The name of the domain you want to describe. + */ + DomainName: DomainName; + /** + * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. + */ + Deployed?: Boolean; + } + export interface DescribeAvailabilityOptionsResponse { + /** + * The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. + */ + AvailabilityOptions?: AvailabilityOptionsStatus; + } + export interface DescribeDomainsRequest { + /** + * The names of the domains you want to include in the response. + */ + DomainNames?: DomainNameList; + } + export interface DescribeDomainsResponse { + DomainStatusList: DomainStatusList; + } + export interface DescribeExpressionsRequest { + /** + * The name of the domain you want to describe. + */ + DomainName: DomainName; + /** + * Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown. + */ + ExpressionNames?: StandardNameList; + /** + * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. + */ + Deployed?: Boolean; + } + export interface DescribeExpressionsResponse { + /** + * The expressions configured for the domain. + */ + Expressions: ExpressionStatusList; + } + export interface DescribeIndexFieldsRequest { + /** + * The name of the domain you want to describe. + */ + DomainName: DomainName; + /** + * A list of the index fields you want to describe. If not specified, information is returned for all configured index fields. + */ + FieldNames?: DynamicFieldNameList; + /** + * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. + */ + Deployed?: Boolean; + } + export interface DescribeIndexFieldsResponse { + /** + * The index fields configured for the domain. + */ + IndexFields: IndexFieldStatusList; + } + export interface DescribeScalingParametersRequest { + DomainName: DomainName; + } + export interface DescribeScalingParametersResponse { + ScalingParameters: ScalingParametersStatus; + } + export interface DescribeServiceAccessPoliciesRequest { + /** + * The name of the domain you want to describe. + */ + DomainName: DomainName; + /** + * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. + */ + Deployed?: Boolean; + } + export interface DescribeServiceAccessPoliciesResponse { + /** + * The access rules configured for the domain specified in the request. + */ + AccessPolicies: AccessPoliciesStatus; + } + export interface DescribeSuggestersRequest { + /** + * The name of the domain you want to describe. + */ + DomainName: DomainName; + /** + * The suggesters you want to describe. + */ + SuggesterNames?: StandardNameList; + /** + * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. + */ + Deployed?: Boolean; + } + export interface DescribeSuggestersResponse { + /** + * The suggesters configured for the domain specified in the request. + */ + Suggesters: SuggesterStatusList; + } + export interface DocumentSuggesterOptions { + /** + * The name of the index field you want to use for suggestions. + */ + SourceField: FieldName; + /** + * The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. + */ + FuzzyMatching?: SuggesterFuzzyMatching; + /** + * An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first. + */ + SortExpression?: String; + } + export type DomainId = string; + export type DomainName = string; + export type DomainNameList = DomainName[]; + export type DomainNameMap = {[key: string]: APIVersion}; + export interface DomainStatus { + DomainId: DomainId; + DomainName: DomainName; + ARN?: ARN; + /** + * True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete. + */ + Created?: Boolean; + /** + * True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete. + */ + Deleted?: Boolean; + /** + * The service endpoint for updating documents in a search domain. + */ + DocService?: ServiceEndpoint; + /** + * The service endpoint for requesting search results from a search domain. + */ + SearchService?: ServiceEndpoint; + /** + * True if IndexDocuments needs to be called to activate the current domain configuration. + */ + RequiresIndexDocuments: Boolean; + /** + * True if processing is being done to activate the current domain configuration. + */ + Processing?: Boolean; + /** + * The instance type that is being used to process search requests. + */ + SearchInstanceType?: SearchInstanceType; + /** + * The number of partitions across which the search index is spread. + */ + SearchPartitionCount?: PartitionCount; + /** + * The number of search instances that are available to process search requests. + */ + SearchInstanceCount?: InstanceCount; + Limits?: Limits; + } + export type DomainStatusList = DomainStatus[]; + export type Double = number; + export interface DoubleArrayOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: Double; + /** + * A list of source fields to map to the field. + */ + SourceFields?: FieldNameCommaList; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + } + export interface DoubleOptions { + /** + * A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document. + */ + DefaultValue?: Double; + /** + * The name of the source field to map to the field. + */ + SourceField?: FieldName; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + /** + * Whether the field can be used to sort the search results. + */ + SortEnabled?: Boolean; + } + export type DynamicFieldName = string; + export type DynamicFieldNameList = DynamicFieldName[]; + export interface Expression { + ExpressionName: StandardName; + ExpressionValue: ExpressionValue; + } + export interface ExpressionStatus { + /** + * The expression that is evaluated for sorting while processing a search request. + */ + Options: Expression; + Status: OptionStatus; + } + export type ExpressionStatusList = ExpressionStatus[]; + export type ExpressionValue = string; + export type FieldName = string; + export type FieldNameCommaList = string; + export type FieldNameList = FieldName[]; + export type FieldValue = string; + export interface IndexDocumentsRequest { + DomainName: DomainName; + } + export interface IndexDocumentsResponse { + /** + * The names of the fields that are currently being indexed. + */ + FieldNames?: FieldNameList; + } + export interface IndexField { + /** + * A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id. + */ + IndexFieldName: DynamicFieldName; + IndexFieldType: IndexFieldType; + IntOptions?: IntOptions; + DoubleOptions?: DoubleOptions; + LiteralOptions?: LiteralOptions; + TextOptions?: TextOptions; + DateOptions?: DateOptions; + LatLonOptions?: LatLonOptions; + IntArrayOptions?: IntArrayOptions; + DoubleArrayOptions?: DoubleArrayOptions; + LiteralArrayOptions?: LiteralArrayOptions; + TextArrayOptions?: TextArrayOptions; + DateArrayOptions?: DateArrayOptions; + } + export interface IndexFieldStatus { + Options: IndexField; + Status: OptionStatus; + } + export type IndexFieldStatusList = IndexFieldStatus[]; + export type IndexFieldType = "int"|"double"|"literal"|"text"|"date"|"latlon"|"int-array"|"double-array"|"literal-array"|"text-array"|"date-array"|string; + export type InstanceCount = number; + export interface IntArrayOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: Long; + /** + * A list of source fields to map to the field. + */ + SourceFields?: FieldNameCommaList; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + } + export interface IntOptions { + /** + * A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document. + */ + DefaultValue?: Long; + /** + * The name of the source field to map to the field. + */ + SourceField?: FieldName; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + /** + * Whether the field can be used to sort the search results. + */ + SortEnabled?: Boolean; + } + export interface LatLonOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: FieldValue; + SourceField?: FieldName; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + /** + * Whether the field can be used to sort the search results. + */ + SortEnabled?: Boolean; + } + export interface Limits { + MaximumReplicationCount: MaximumReplicationCount; + MaximumPartitionCount: MaximumPartitionCount; + } + export interface ListDomainNamesResponse { + /** + * The names of the search domains owned by an account. + */ + DomainNames?: DomainNameMap; + } + export interface LiteralArrayOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: FieldValue; + /** + * A list of source fields to map to the field. + */ + SourceFields?: FieldNameCommaList; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + } + export interface LiteralOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: FieldValue; + SourceField?: FieldName; + /** + * Whether facet information can be returned for the field. + */ + FacetEnabled?: Boolean; + /** + * Whether the contents of the field are searchable. + */ + SearchEnabled?: Boolean; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + /** + * Whether the field can be used to sort the search results. + */ + SortEnabled?: Boolean; + } + export type Long = number; + export type MaximumPartitionCount = number; + export type MaximumReplicationCount = number; + export type MultiAZ = boolean; + export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|"FailedToValidate"|string; + export interface OptionStatus { + /** + * A timestamp for when this option was created. + */ + CreationDate: UpdateTimestamp; + /** + * A timestamp for when this option was last updated. + */ + UpdateDate: UpdateTimestamp; + /** + * A unique integer that indicates when this option was last updated. + */ + UpdateVersion?: UIntValue; + /** + * The state of processing a change to an option. Possible values: RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete. Processing: the option's latest value is in the process of being activated. Active: the option's latest value is completely deployed. FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents. + */ + State: OptionState; + /** + * Indicates that the option will be deleted once processing is complete. + */ + PendingDeletion?: Boolean; + } + export type PartitionCount = number; + export type PartitionInstanceType = "search.m1.small"|"search.m1.large"|"search.m2.xlarge"|"search.m2.2xlarge"|"search.m3.medium"|"search.m3.large"|"search.m3.xlarge"|"search.m3.2xlarge"|string; + export type PolicyDocument = string; + export interface ScalingParameters { + /** + * The instance type that you want to preconfigure for your domain. For example, search.m1.small. + */ + DesiredInstanceType?: PartitionInstanceType; + /** + * The number of replicas you want to preconfigure for each index partition. + */ + DesiredReplicationCount?: UIntValue; + /** + * The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type. + */ + DesiredPartitionCount?: UIntValue; + } + export interface ScalingParametersStatus { + Options: ScalingParameters; + Status: OptionStatus; + } + export type SearchInstanceType = string; + export interface ServiceEndpoint { + Endpoint?: ServiceUrl; + } + export type ServiceUrl = string; + export type StandardName = string; + export type StandardNameList = StandardName[]; + export type String = string; + export interface Suggester { + SuggesterName: StandardName; + DocumentSuggesterOptions: DocumentSuggesterOptions; + } + export type SuggesterFuzzyMatching = "none"|"low"|"high"|string; + export interface SuggesterStatus { + Options: Suggester; + Status: OptionStatus; + } + export type SuggesterStatusList = SuggesterStatus[]; + export interface TextArrayOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: FieldValue; + /** + * A list of source fields to map to the field. + */ + SourceFields?: FieldNameCommaList; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + /** + * Whether highlights can be returned for the field. + */ + HighlightEnabled?: Boolean; + /** + * The name of an analysis scheme for a text-array field. + */ + AnalysisScheme?: Word; + } + export interface TextOptions { + /** + * A value to use for the field if the field isn't specified for a document. + */ + DefaultValue?: FieldValue; + SourceField?: FieldName; + /** + * Whether the contents of the field can be returned in the search results. + */ + ReturnEnabled?: Boolean; + /** + * Whether the field can be used to sort the search results. + */ + SortEnabled?: Boolean; + /** + * Whether highlights can be returned for the field. + */ + HighlightEnabled?: Boolean; + /** + * The name of an analysis scheme for a text field. + */ + AnalysisScheme?: Word; + } + export type UIntValue = number; + export interface UpdateAvailabilityOptionsRequest { + DomainName: DomainName; + /** + * You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false. + */ + MultiAZ: Boolean; + } + export interface UpdateAvailabilityOptionsResponse { + /** + * The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. + */ + AvailabilityOptions?: AvailabilityOptionsStatus; + } + export interface UpdateScalingParametersRequest { + DomainName: DomainName; + ScalingParameters: ScalingParameters; + } + export interface UpdateScalingParametersResponse { + ScalingParameters: ScalingParametersStatus; + } + export interface UpdateServiceAccessPoliciesRequest { + DomainName: DomainName; + /** + * The access rules you want to configure. These rules replace any existing rules. + */ + AccessPolicies: PolicyDocument; + } + export interface UpdateServiceAccessPoliciesResponse { + /** + * The access rules configured for the domain. + */ + AccessPolicies: AccessPoliciesStatus; + } + export type UpdateTimestamp = Date; + export type Word = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2011-02-01"|"2013-01-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudSearch client. + */ + export import Types = CloudSearch; +} +export = CloudSearch; diff --git a/node_modules/aws-sdk/clients/cloudsearch.js b/node_modules/aws-sdk/clients/cloudsearch.js new file mode 100644 index 0000000..3bd2fde --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudsearch.js @@ -0,0 +1,27 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudsearch'] = {}; +AWS.CloudSearch = Service.defineService('cloudsearch', ['2011-02-01', '2013-01-01']); +Object.defineProperty(apiLoader.services['cloudsearch'], '2011-02-01', { + get: function get() { + var model = require('../apis/cloudsearch-2011-02-01.min.json'); + model.paginators = require('../apis/cloudsearch-2011-02-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['cloudsearch'], '2013-01-01', { + get: function get() { + var model = require('../apis/cloudsearch-2013-01-01.min.json'); + model.paginators = require('../apis/cloudsearch-2013-01-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudSearch; diff --git a/node_modules/aws-sdk/clients/cloudsearchdomain.d.ts b/node_modules/aws-sdk/clients/cloudsearchdomain.d.ts new file mode 100644 index 0000000..d673549 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudsearchdomain.d.ts @@ -0,0 +1,358 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Readable} from 'stream'; +interface Blob {} +declare class CloudSearchDomain extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudSearchDomain.Types.ClientConfiguration) + config: Config & CloudSearchDomain.Types.ClientConfiguration; + /** + * Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes. structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching. lucene: specify search criteria using the Apache Lucene query parser syntax. dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide. The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. + */ + search(params: CloudSearchDomain.Types.SearchRequest, callback?: (err: AWSError, data: CloudSearchDomain.Types.SearchResponse) => void): Request; + /** + * Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes. structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching. lucene: specify search criteria using the Apache Lucene query parser syntax. dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide. The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. + */ + search(callback?: (err: AWSError, data: CloudSearchDomain.Types.SearchResponse) => void): Request; + /** + * Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide. The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. + */ + suggest(params: CloudSearchDomain.Types.SuggestRequest, callback?: (err: AWSError, data: CloudSearchDomain.Types.SuggestResponse) => void): Request; + /** + * Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide. The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. + */ + suggest(callback?: (err: AWSError, data: CloudSearchDomain.Types.SuggestResponse) => void): Request; + /** + * Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide. + */ + uploadDocuments(params: CloudSearchDomain.Types.UploadDocumentsRequest, callback?: (err: AWSError, data: CloudSearchDomain.Types.UploadDocumentsResponse) => void): Request; + /** + * Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide. + */ + uploadDocuments(callback?: (err: AWSError, data: CloudSearchDomain.Types.UploadDocumentsResponse) => void): Request; +} +declare namespace CloudSearchDomain { + export type Adds = number; + export type _Blob = Buffer|Uint8Array|Blob|string|Readable; + export interface Bucket { + /** + * The facet value being counted. + */ + value?: String; + /** + * The number of hits that contain the facet value in the specified facet field. + */ + count?: Long; + } + export interface BucketInfo { + /** + * A list of the calculated facet values and counts. + */ + buckets?: BucketList; + } + export type BucketList = Bucket[]; + export type ContentType = "application/json"|"application/xml"|string; + export type Cursor = string; + export type Deletes = number; + export interface DocumentServiceWarning { + /** + * The description for a warning returned by the document service. + */ + message?: String; + } + export type DocumentServiceWarnings = DocumentServiceWarning[]; + export type Double = number; + export type Expr = string; + export type Exprs = {[key: string]: String}; + export type Facet = string; + export type Facets = {[key: string]: BucketInfo}; + export interface FieldStats { + /** + * The minimum value found in the specified field in the result set. If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ. + */ + min?: String; + /** + * The maximum value found in the specified field in the result set. If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ. + */ + max?: String; + /** + * The number of documents that contain a value in the specified field in the result set. + */ + count?: Long; + /** + * The number of documents that do not contain a value in the specified field in the result set. + */ + missing?: Long; + /** + * The sum of the field values across the documents in the result set. null for date fields. + */ + sum?: Double; + /** + * The sum of all field values in the result set squared. + */ + sumOfSquares?: Double; + /** + * The average of the values found in the specified field in the result set. If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ. + */ + mean?: String; + /** + * The standard deviation of the values in the specified field in the result set. + */ + stddev?: Double; + } + export type FieldValue = String[]; + export type Fields = {[key: string]: FieldValue}; + export type FilterQuery = string; + export type Highlight = string; + export type Highlights = {[key: string]: String}; + export interface Hit { + /** + * The document ID of a document that matches the search request. + */ + id?: String; + /** + * The fields returned from a document that matches the search request. + */ + fields?: Fields; + /** + * The expressions returned from a document that matches the search request. + */ + exprs?: Exprs; + /** + * The highlights returned from a document that matches the search request. + */ + highlights?: Highlights; + } + export type HitList = Hit[]; + export interface Hits { + /** + * The total number of documents that match the search request. + */ + found?: Long; + /** + * The index of the first matching document. + */ + start?: Long; + /** + * A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set. + */ + cursor?: String; + /** + * A document that matches the search request. + */ + hit?: HitList; + } + export type Long = number; + export type Partial = boolean; + export type Query = string; + export type QueryOptions = string; + export type QueryParser = "simple"|"structured"|"lucene"|"dismax"|string; + export type Return = string; + export interface SearchRequest { + /** + * Retrieves a cursor value you can use to page through large result sets. Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response. For more information, see Paginating Results in the Amazon CloudSearch Developer Guide. + */ + cursor?: Cursor; + /** + * Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields. You specify the expressions in JSON using the form {"EXPRESSIONNAME":"EXPRESSION"}. You can define and use multiple expressions in a search request. For example: {"expression1":"_score*rating", "expression2":"(1/rank)*year"} For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide. + */ + expr?: Expr; + /** + * Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. You can specify the following faceting options: buckets specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see Searching for a Range of Values in the Amazon CloudSearch Developer Guide. Buckets are returned in the order they are specified in the request. The sort and size options are not valid if you specify buckets. size specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The size parameter is only valid when you specify the sort option; it cannot be used in conjunction with buckets. sort specifies how you want to sort the facets in the results: bucket or count. Specify bucket to sort alphabetically or numerically by facet value (in ascending order). Specify count to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the buckets option instead of sort. If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results. To count particular buckets of values, use the buckets option. For example, the following request uses the buckets option to calculate and return facet counts by decade. {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} To sort facets by facet count, use the count option. For example, the following request sets the sort option to count to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the size option to 3 returns only the top three facet values. {"year":{"sort":"count","size":3}} To sort the facets by value, use the bucket option. For example, the following request sets the sort option to bucket to sort the facet values numerically by year, with earliest year listed first. {"year":{"sort":"bucket"}} For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide. + */ + facet?: Facet; + /** + * Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax. For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide. + */ + filterQuery?: FilterQuery; + /** + * Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. You can specify the following highlight options: format: specifies the format of the data in the text field: text or html. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is html. max_phrases: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted. pre_tag: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is &lt;em&gt;. The default for text highlights is *. post_tag: specifies the string to append to an occurrence of a search term. The default for HTML highlights is &lt;/em&gt;. The default for text highlights is *. If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: &lt;em>search-term&lt;/em&gt;. For example, the following request retrieves highlights for the actors and title fields. { "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "","post_tag": ""} } + */ + highlight?: Highlight; + /** + * Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage. + */ + partial?: Partial; + /** + * Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the queryOptions parameter. By default, the simple query parser is used to process requests. To use the structured, lucene, or dismax query parser, you must also specify the queryParser parameter. For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide. + */ + query: Query; + /** + * Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form {"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}. The options you can configure vary according to which parser you use: defaultOperator: The default operator used to combine individual terms in the search string. For example: defaultOperator: 'or'. For the dismax parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of 0% is the equivalent to OR, and a value of 100% is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, defaultOperator: 50%. Valid values: and, or, a percentage in the range 0%-100% (dismax). Default: and (simple, structured, lucene) or 100 (dismax). Valid for: simple, structured, lucene, and dismax. fields: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost the importance of the title field over the description field you could specify: "fields":["title^5","description"]. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All text and text-array fields. Valid for: simple, structured, lucene, and dismax. operators: An array of the operators or special characters you want to disable for the simple query parser. If you disable the and, or, or not operators, the corresponding operators (+, |, -) have no special meaning and are dropped from the search string. Similarly, disabling prefix disables the wildcard operator (*) and disabling phrase disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling near disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the fuzzy operator disables the ability to use the ~ operator to perform a fuzzy search. escape disables the ability to use a backslash (\) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: "operators":["and","not","or", "prefix"]. Valid values: and, escape, fuzzy, near, not, or, phrase, precedence, prefix, whitespace. Default: All operators and special characters are enabled. Valid for: simple. phraseFields: An array of the text or text-array fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The phraseSlop option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost phrase matches in the title field over the abstract field, you could specify: "phraseFields":["title^3", "plot"] Valid values: The name of any text or text-array field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with phraseFields, proximity scoring is disabled even if phraseSlop is specified. Valid for: dismax. phraseSlop: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the phraseFields option; for example, phraseSlop: 2. You must also specify phraseFields to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: dismax. explicitPhraseSlop: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify "explicitPhraseSlop":3. Valid values: positive integers. Default: 0. Valid for: dismax. tieBreaker: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a tieBreaker value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is (max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields). Set tieBreaker to 0 to disregard all but the highest scoring field (pure max): "tieBreaker":0. Set to 1 to sum the scores from all fields (pure sum): "tieBreaker":1. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: dismax. + */ + queryOptions?: QueryOptions; + /** + * Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query parser. Amazon CloudSearch supports four query parsers: simple: perform simple searches of text and text-array fields. By default, the simple query parser searches all text and text-array fields. You can specify which fields to search by with the queryOptions parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the queryOptions parameter.) You can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see Searching for Text in the Amazon CloudSearch Developer Guide. structured: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, matchall, and near. For more information, see Constructing Compound Queries in the Amazon CloudSearch Developer Guide. lucene: search using the Apache Lucene query parser syntax. For more information, see Apache Lucene Query Parser Syntax. dismax: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see DisMax Query Parser Syntax. + */ + queryParser?: QueryParser; + /** + * Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (_all_fields). To return only the document IDs for the matching documents, specify _no_fields. To retrieve the relevance score calculated for each document, specify _score. + */ + return?: Return; + /** + * Specifies the maximum number of search hits to include in the response. + */ + size?: Size; + /** + * Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (asc or desc) for each field; for example, year desc,title asc. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no sort parameter is specified, results are sorted by their default relevance scores in descending order: _score desc. You can also sort by document ID (_id asc) and version (_version desc). For more information, see Sorting Results in the Amazon CloudSearch Developer Guide. + */ + sort?: Sort; + /** + * Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive. For more information, see Paginating Results in the Amazon CloudSearch Developer Guide. + */ + start?: Start; + /** + * Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form: {"FIELD-A":{},"FIELD-B":{}} There are currently no options supported for statistics. + */ + stats?: Stat; + } + export interface SearchResponse { + /** + * The status information returned for the search request. + */ + status?: SearchStatus; + /** + * The documents that match the search criteria. + */ + hits?: Hits; + /** + * The requested facet information. + */ + facets?: Facets; + /** + * The requested field statistics information. + */ + stats?: Stats; + } + export interface SearchStatus { + /** + * How long it took to process the request, in milliseconds. + */ + timems?: Long; + /** + * The encrypted resource ID for the request. + */ + rid?: String; + } + export type Size = number; + export type Sort = string; + export type Start = number; + export type Stat = string; + export type Stats = {[key: string]: FieldStats}; + export type String = string; + export interface SuggestModel { + /** + * The query string specified in the suggest request. + */ + query?: String; + /** + * The number of documents that were found to match the query string. + */ + found?: Long; + /** + * The documents that match the query string. + */ + suggestions?: Suggestions; + } + export interface SuggestRequest { + /** + * Specifies the string for which you want to get suggestions. + */ + query: Query; + /** + * Specifies the name of the suggester to use to find suggested matches. + */ + suggester: Suggester; + /** + * Specifies the maximum number of suggestions to return. + */ + size?: SuggestionsSize; + } + export interface SuggestResponse { + /** + * The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems). + */ + status?: SuggestStatus; + /** + * Container for the matching search suggestion information. + */ + suggest?: SuggestModel; + } + export interface SuggestStatus { + /** + * How long it took to process the request, in milliseconds. + */ + timems?: Long; + /** + * The encrypted resource ID for the request. + */ + rid?: String; + } + export type Suggester = string; + export interface SuggestionMatch { + /** + * The string that matches the query string specified in the SuggestRequest. + */ + suggestion?: String; + /** + * The relevance score of a suggested match. + */ + score?: Long; + /** + * The document ID of the suggested document. + */ + id?: String; + } + export type Suggestions = SuggestionMatch[]; + export type SuggestionsSize = number; + export interface UploadDocumentsRequest { + /** + * A batch of documents formatted in JSON or HTML. + */ + documents: _Blob; + /** + * The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: application/json application/xml + */ + contentType: ContentType; + } + export interface UploadDocumentsResponse { + /** + * The status of an UploadDocumentsRequest. + */ + status?: String; + /** + * The number of documents that were added to the search domain. + */ + adds?: Adds; + /** + * The number of documents that were deleted from the search domain. + */ + deletes?: Deletes; + /** + * Any warnings returned by the document service about the documents being uploaded. + */ + warnings?: DocumentServiceWarnings; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-01-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudSearchDomain client. + */ + export import Types = CloudSearchDomain; +} +export = CloudSearchDomain; diff --git a/node_modules/aws-sdk/clients/cloudsearchdomain.js b/node_modules/aws-sdk/clients/cloudsearchdomain.js new file mode 100644 index 0000000..78c1e3a --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudsearchdomain.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudsearchdomain'] = {}; +AWS.CloudSearchDomain = Service.defineService('cloudsearchdomain', ['2013-01-01']); +require('../lib/services/cloudsearchdomain'); +Object.defineProperty(apiLoader.services['cloudsearchdomain'], '2013-01-01', { + get: function get() { + var model = require('../apis/cloudsearchdomain-2013-01-01.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudSearchDomain; diff --git a/node_modules/aws-sdk/clients/cloudtrail.d.ts b/node_modules/aws-sdk/clients/cloudtrail.d.ts new file mode 100644 index 0000000..cadbaf8 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudtrail.d.ts @@ -0,0 +1,798 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudTrail extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudTrail.Types.ClientConfiguration) + config: Config & CloudTrail.Types.ClientConfiguration; + /** + * Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region). + */ + addTags(params: CloudTrail.Types.AddTagsRequest, callback?: (err: AWSError, data: CloudTrail.Types.AddTagsResponse) => void): Request; + /** + * Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region). + */ + addTags(callback?: (err: AWSError, data: CloudTrail.Types.AddTagsResponse) => void): Request; + /** + * Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. + */ + createTrail(params: CloudTrail.Types.CreateTrailRequest, callback?: (err: AWSError, data: CloudTrail.Types.CreateTrailResponse) => void): Request; + /** + * Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. + */ + createTrail(callback?: (err: AWSError, data: CloudTrail.Types.CreateTrailResponse) => void): Request; + /** + * Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. + */ + deleteTrail(params: CloudTrail.Types.DeleteTrailRequest, callback?: (err: AWSError, data: CloudTrail.Types.DeleteTrailResponse) => void): Request; + /** + * Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. + */ + deleteTrail(callback?: (err: AWSError, data: CloudTrail.Types.DeleteTrailResponse) => void): Request; + /** + * Retrieves settings for the trail associated with the current region for your account. + */ + describeTrails(params: CloudTrail.Types.DescribeTrailsRequest, callback?: (err: AWSError, data: CloudTrail.Types.DescribeTrailsResponse) => void): Request; + /** + * Retrieves settings for the trail associated with the current region for your account. + */ + describeTrails(callback?: (err: AWSError, data: CloudTrail.Types.DescribeTrailsResponse) => void): Request; + /** + * Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following: If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events. If your event selector includes management events. If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide. + */ + getEventSelectors(params: CloudTrail.Types.GetEventSelectorsRequest, callback?: (err: AWSError, data: CloudTrail.Types.GetEventSelectorsResponse) => void): Request; + /** + * Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following: If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events. If your event selector includes management events. If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide. + */ + getEventSelectors(callback?: (err: AWSError, data: CloudTrail.Types.GetEventSelectorsResponse) => void): Request; + /** + * Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. + */ + getTrailStatus(params: CloudTrail.Types.GetTrailStatusRequest, callback?: (err: AWSError, data: CloudTrail.Types.GetTrailStatusResponse) => void): Request; + /** + * Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. + */ + getTrailStatus(callback?: (err: AWSError, data: CloudTrail.Types.GetTrailStatusResponse) => void): Request; + /** + * Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key. + */ + listPublicKeys(params: CloudTrail.Types.ListPublicKeysRequest, callback?: (err: AWSError, data: CloudTrail.Types.ListPublicKeysResponse) => void): Request; + /** + * Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key. + */ + listPublicKeys(callback?: (err: AWSError, data: CloudTrail.Types.ListPublicKeysResponse) => void): Request; + /** + * Lists the tags for the trail in the current region. + */ + listTags(params: CloudTrail.Types.ListTagsRequest, callback?: (err: AWSError, data: CloudTrail.Types.ListTagsResponse) => void): Request; + /** + * Lists the tags for the trail in the current region. + */ + listTags(callback?: (err: AWSError, data: CloudTrail.Types.ListTagsResponse) => void): Request; + /** + * Looks up management events captured by CloudTrail. Events for a region can be looked up in that region during the last 90 days. Lookup supports the following attributes: AWS access key Event ID Event name Event source Read only Resource name Resource type User name All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred. + */ + lookupEvents(params: CloudTrail.Types.LookupEventsRequest, callback?: (err: AWSError, data: CloudTrail.Types.LookupEventsResponse) => void): Request; + /** + * Looks up management events captured by CloudTrail. Events for a region can be looked up in that region during the last 90 days. Lookup supports the following attributes: AWS access key Event ID Event name Event source Read only Resource name Resource type User name All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred. + */ + lookupEvents(callback?: (err: AWSError, data: CloudTrail.Types.LookupEventsResponse) => void): Request; + /** + * Configures an event selector for your trail. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. Example You create an event selector for a trail and specify that you want write-only events. The EC2 GetConsoleOutput and RunInstances API operations occur in your account. CloudTrail evaluates whether the events match your event selectors. The RunInstances is a write-only event and it matches your event selector. The trail logs the event. The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event. The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown. You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails and Limits in AWS CloudTrail in the AWS CloudTrail User Guide. + */ + putEventSelectors(params: CloudTrail.Types.PutEventSelectorsRequest, callback?: (err: AWSError, data: CloudTrail.Types.PutEventSelectorsResponse) => void): Request; + /** + * Configures an event selector for your trail. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. Example You create an event selector for a trail and specify that you want write-only events. The EC2 GetConsoleOutput and RunInstances API operations occur in your account. CloudTrail evaluates whether the events match your event selectors. The RunInstances is a write-only event and it matches your event selector. The trail logs the event. The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event. The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown. You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails and Limits in AWS CloudTrail in the AWS CloudTrail User Guide. + */ + putEventSelectors(callback?: (err: AWSError, data: CloudTrail.Types.PutEventSelectorsResponse) => void): Request; + /** + * Removes the specified tags from a trail. + */ + removeTags(params: CloudTrail.Types.RemoveTagsRequest, callback?: (err: AWSError, data: CloudTrail.Types.RemoveTagsResponse) => void): Request; + /** + * Removes the specified tags from a trail. + */ + removeTags(callback?: (err: AWSError, data: CloudTrail.Types.RemoveTagsResponse) => void): Request; + /** + * Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. + */ + startLogging(params: CloudTrail.Types.StartLoggingRequest, callback?: (err: AWSError, data: CloudTrail.Types.StartLoggingResponse) => void): Request; + /** + * Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. + */ + startLogging(callback?: (err: AWSError, data: CloudTrail.Types.StartLoggingResponse) => void): Request; + /** + * Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. + */ + stopLogging(params: CloudTrail.Types.StopLoggingRequest, callback?: (err: AWSError, data: CloudTrail.Types.StopLoggingResponse) => void): Request; + /** + * Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. + */ + stopLogging(callback?: (err: AWSError, data: CloudTrail.Types.StopLoggingResponse) => void): Request; + /** + * Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown. + */ + updateTrail(params: CloudTrail.Types.UpdateTrailRequest, callback?: (err: AWSError, data: CloudTrail.Types.UpdateTrailResponse) => void): Request; + /** + * Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown. + */ + updateTrail(callback?: (err: AWSError, data: CloudTrail.Types.UpdateTrailResponse) => void): Request; +} +declare namespace CloudTrail { + export interface AddTagsRequest { + /** + * Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + ResourceId: String; + /** + * Contains a list of CloudTrail tags, up to a limit of 50 + */ + TagsList?: TagsList; + } + export interface AddTagsResponse { + } + export type Boolean = boolean; + export type ByteBuffer = Buffer|Uint8Array|Blob|string; + export interface CreateTrailRequest { + /** + * Specifies the name of the trail. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4) + */ + Name: String; + /** + * Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements. + */ + S3BucketName: String; + /** + * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. + */ + S3KeyPrefix?: String; + /** + * Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. + */ + SnsTopicName?: String; + /** + * Specifies whether the trail is publishing events from global services such as IAM to the log files. + */ + IncludeGlobalServiceEvents?: Boolean; + /** + * Specifies whether the trail is created in the current region or in all regions. The default is false. + */ + IsMultiRegionTrail?: Boolean; + /** + * Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail. + */ + EnableLogFileValidation?: Boolean; + /** + * Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. + */ + CloudWatchLogsLogGroupArn?: String; + /** + * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. + */ + CloudWatchLogsRoleArn?: String; + /** + * Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. Examples: alias/MyAliasName arn:aws:kms:us-east-2:123456789012:alias/MyAliasName arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 12345678-1234-1234-1234-123456789012 + */ + KmsKeyId?: String; + /** + * Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. + */ + IsOrganizationTrail?: Boolean; + } + export interface CreateTrailResponse { + /** + * Specifies the name of the trail. + */ + Name?: String; + /** + * Specifies the name of the Amazon S3 bucket designated for publishing log files. + */ + S3BucketName?: String; + /** + * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. + */ + S3KeyPrefix?: String; + /** + * This field is deprecated. Use SnsTopicARN. + */ + SnsTopicName?: String; + /** + * Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is: arn:aws:sns:us-east-2:123456789012:MyTopic + */ + SnsTopicARN?: String; + /** + * Specifies whether the trail is publishing events from global services such as IAM to the log files. + */ + IncludeGlobalServiceEvents?: Boolean; + /** + * Specifies whether the trail exists in one region or in all regions. + */ + IsMultiRegionTrail?: Boolean; + /** + * Specifies the ARN of the trail that was created. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + TrailARN?: String; + /** + * Specifies whether log file integrity validation is enabled. + */ + LogFileValidationEnabled?: Boolean; + /** + * Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered. + */ + CloudWatchLogsLogGroupArn?: String; + /** + * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. + */ + CloudWatchLogsRoleArn?: String; + /** + * Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + */ + KmsKeyId?: String; + /** + * Specifies whether the trail is an organization trail. + */ + IsOrganizationTrail?: Boolean; + } + export interface DataResource { + /** + * The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources. + */ + Type?: String; + /** + * An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as arn:aws:s3:::. This will also enable logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account. To log data events for all objects in all S3 buckets that include my-bucket in their names, specify the prefix as aws:s3:::my-bucket. The trail logs data events for all objects in all buckets whose name contains a match for my-bucket. To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket. To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix. To log data events for all functions in your AWS account, specify the prefix as arn:aws:lambda. This will also enable logging of Invoke activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account. To log data eents for a specific Lambda function, specify the function ARN. Lambda function ARNs are exact. Unlike S3, you cannot use matching. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2. + */ + Values?: DataResourceValues; + } + export type DataResourceValues = String[]; + export type DataResources = DataResource[]; + export type _Date = Date; + export interface DeleteTrailRequest { + /** + * Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + Name: String; + } + export interface DeleteTrailResponse { + } + export interface DescribeTrailsRequest { + /** + * Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail If an empty list is specified, information for the trail in the current region is returned. If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned. If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned. If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN. + */ + trailNameList?: TrailNameList; + /** + * Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true. + */ + includeShadowTrails?: Boolean; + } + export interface DescribeTrailsResponse { + /** + * The list of trail objects. + */ + trailList?: TrailList; + } + export interface Event { + /** + * The CloudTrail ID of the event returned. + */ + EventId?: String; + /** + * The name of the event returned. + */ + EventName?: String; + /** + * Information about whether the event is a write event or a read event. + */ + ReadOnly?: String; + /** + * The AWS access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials. + */ + AccessKeyId?: String; + /** + * The date and time of the event returned. + */ + EventTime?: _Date; + /** + * The AWS service that the request was made to. + */ + EventSource?: String; + /** + * A user name or role name of the requester that called the API in the event returned. + */ + Username?: String; + /** + * A list of resources referenced by the event returned. + */ + Resources?: ResourceList; + /** + * A JSON string that contains a representation of the event returned. + */ + CloudTrailEvent?: String; + } + export interface EventSelector { + /** + * Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation. By default, the value is All. + */ + ReadWriteType?: ReadWriteType; + /** + * Specify if you want your event selector to include management events for your trail. For more information, see Management Events in the AWS CloudTrail User Guide. By default, the value is true. + */ + IncludeManagementEvents?: Boolean; + /** + * CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide. + */ + DataResources?: DataResources; + } + export type EventSelectors = EventSelector[]; + export type EventsList = Event[]; + export interface GetEventSelectorsRequest { + /** + * Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid. Not be in IP address format (for example, 192.168.5.4) If you specify a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + TrailName: String; + } + export interface GetEventSelectorsResponse { + /** + * The specified trail ARN that has the event selectors. + */ + TrailARN?: String; + /** + * The event selectors that are configured for the trail. + */ + EventSelectors?: EventSelectors; + } + export interface GetTrailStatusRequest { + /** + * Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + Name: String; + } + export interface GetTrailStatusResponse { + /** + * Whether the CloudTrail is currently logging AWS API calls. + */ + IsLogging?: Boolean; + /** + * Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference. This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket. + */ + LatestDeliveryError?: String; + /** + * Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide. + */ + LatestNotificationError?: String; + /** + * Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket. + */ + LatestDeliveryTime?: _Date; + /** + * Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket. + */ + LatestNotificationTime?: _Date; + /** + * Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account. + */ + StartLoggingTime?: _Date; + /** + * Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account. + */ + StopLoggingTime?: _Date; + /** + * Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs. + */ + LatestCloudWatchLogsDeliveryError?: String; + /** + * Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs. + */ + LatestCloudWatchLogsDeliveryTime?: _Date; + /** + * Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket. + */ + LatestDigestDeliveryTime?: _Date; + /** + * Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference. This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket. + */ + LatestDigestDeliveryError?: String; + /** + * This field is deprecated. + */ + LatestDeliveryAttemptTime?: String; + /** + * This field is deprecated. + */ + LatestNotificationAttemptTime?: String; + /** + * This field is deprecated. + */ + LatestNotificationAttemptSucceeded?: String; + /** + * This field is deprecated. + */ + LatestDeliveryAttemptSucceeded?: String; + /** + * This field is deprecated. + */ + TimeLoggingStarted?: String; + /** + * This field is deprecated. + */ + TimeLoggingStopped?: String; + } + export interface ListPublicKeysRequest { + /** + * Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned. + */ + StartTime?: _Date; + /** + * Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used. + */ + EndTime?: _Date; + /** + * Reserved for future use. + */ + NextToken?: String; + } + export interface ListPublicKeysResponse { + /** + * Contains an array of PublicKey objects. The returned public keys may have validity time ranges that overlap. + */ + PublicKeyList?: PublicKeyList; + /** + * Reserved for future use. + */ + NextToken?: String; + } + export interface ListTagsRequest { + /** + * Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + ResourceIdList: ResourceIdList; + /** + * Reserved for future use. + */ + NextToken?: String; + } + export interface ListTagsResponse { + /** + * A list of resource tags. + */ + ResourceTagList?: ResourceTagList; + /** + * Reserved for future use. + */ + NextToken?: String; + } + export interface LookupAttribute { + /** + * Specifies an attribute on which to filter the events returned. + */ + AttributeKey: LookupAttributeKey; + /** + * Specifies a value for the specified AttributeKey. + */ + AttributeValue: String; + } + export type LookupAttributeKey = "EventId"|"EventName"|"ReadOnly"|"Username"|"ResourceType"|"ResourceName"|"EventSource"|"AccessKeyId"|string; + export type LookupAttributesList = LookupAttribute[]; + export interface LookupEventsRequest { + /** + * Contains a list of lookup attributes. Currently the list can contain only one item. + */ + LookupAttributes?: LookupAttributesList; + /** + * Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned. + */ + StartTime?: _Date; + /** + * Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned. + */ + EndTime?: _Date; + /** + * The number of events to return. Possible values are 1 through 50. The default is 50. + */ + MaxResults?: MaxResults; + /** + * The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters. + */ + NextToken?: NextToken; + } + export interface LookupEventsResponse { + /** + * A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first. + */ + Events?: EventsList; + /** + * The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters. + */ + NextToken?: NextToken; + } + export type MaxResults = number; + export type NextToken = string; + export interface PublicKey { + /** + * The DER encoded public key value in PKCS#1 format. + */ + Value?: ByteBuffer; + /** + * The starting time of validity of the public key. + */ + ValidityStartTime?: _Date; + /** + * The ending time of validity of the public key. + */ + ValidityEndTime?: _Date; + /** + * The fingerprint of the public key. + */ + Fingerprint?: String; + } + export type PublicKeyList = PublicKey[]; + export interface PutEventSelectorsRequest { + /** + * Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4) If you specify a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + TrailName: String; + /** + * Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. + */ + EventSelectors: EventSelectors; + } + export interface PutEventSelectorsResponse { + /** + * Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + TrailARN?: String; + /** + * Specifies the event selectors configured for your trail. + */ + EventSelectors?: EventSelectors; + } + export type ReadWriteType = "ReadOnly"|"WriteOnly"|"All"|string; + export interface RemoveTagsRequest { + /** + * Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + ResourceId: String; + /** + * Specifies a list of tags to be removed. + */ + TagsList?: TagsList; + } + export interface RemoveTagsResponse { + } + export interface Resource { + /** + * The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for RDS, and AccessKey for IAM. For a list of resource types supported for event lookup, see Resource Types Supported for Event Lookup. + */ + ResourceType?: String; + /** + * The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance. + */ + ResourceName?: String; + } + export type ResourceIdList = String[]; + export type ResourceList = Resource[]; + export interface ResourceTag { + /** + * Specifies the ARN of the resource. + */ + ResourceId?: String; + /** + * A list of tags. + */ + TagsList?: TagsList; + } + export type ResourceTagList = ResourceTag[]; + export interface StartLoggingRequest { + /** + * Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + Name: String; + } + export interface StartLoggingResponse { + } + export interface StopLoggingRequest { + /** + * Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + Name: String; + } + export interface StopLoggingResponse { + } + export type String = string; + export interface Tag { + /** + * The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies. + */ + Key: String; + /** + * The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters. + */ + Value?: String; + } + export type TagsList = Tag[]; + export interface Trail { + /** + * Name of the trail set by calling CreateTrail. The maximum length is 128 characters. + */ + Name?: String; + /** + * Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements. + */ + S3BucketName?: String; + /** + * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters. + */ + S3KeyPrefix?: String; + /** + * This field is deprecated. Use SnsTopicARN. + */ + SnsTopicName?: String; + /** + * Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is: arn:aws:sns:us-east-2:123456789012:MyTopic + */ + SnsTopicARN?: String; + /** + * Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False. + */ + IncludeGlobalServiceEvents?: Boolean; + /** + * Specifies whether the trail belongs only to one region or exists in all regions. + */ + IsMultiRegionTrail?: Boolean; + /** + * The region in which the trail was created. + */ + HomeRegion?: String; + /** + * Specifies the ARN of the trail. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + TrailARN?: String; + /** + * Specifies whether log file validation is enabled. + */ + LogFileValidationEnabled?: Boolean; + /** + * Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. + */ + CloudWatchLogsLogGroupArn?: String; + /** + * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. + */ + CloudWatchLogsRoleArn?: String; + /** + * Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + */ + KmsKeyId?: String; + /** + * Specifies if the trail has custom event selectors. + */ + HasCustomEventSelectors?: Boolean; + /** + * Specifies whether the trail is an organization trail. + */ + IsOrganizationTrail?: Boolean; + } + export type TrailList = Trail[]; + export type TrailNameList = String[]; + export interface UpdateTrailRequest { + /** + * Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4) If Name is a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + Name: String; + /** + * Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements. + */ + S3BucketName?: String; + /** + * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. + */ + S3KeyPrefix?: String; + /** + * Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. + */ + SnsTopicName?: String; + /** + * Specifies whether the trail is publishing events from global services such as IAM to the log files. + */ + IncludeGlobalServiceEvents?: Boolean; + /** + * Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. + */ + IsMultiRegionTrail?: Boolean; + /** + * Specifies whether log file validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail. + */ + EnableLogFileValidation?: Boolean; + /** + * Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. + */ + CloudWatchLogsLogGroupArn?: String; + /** + * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. + */ + CloudWatchLogsRoleArn?: String; + /** + * Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. Examples: alias/MyAliasName arn:aws:kms:us-east-2:123456789012:alias/MyAliasName arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 12345678-1234-1234-1234-123456789012 + */ + KmsKeyId?: String; + /** + * Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization. + */ + IsOrganizationTrail?: Boolean; + } + export interface UpdateTrailResponse { + /** + * Specifies the name of the trail. + */ + Name?: String; + /** + * Specifies the name of the Amazon S3 bucket designated for publishing log files. + */ + S3BucketName?: String; + /** + * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. + */ + S3KeyPrefix?: String; + /** + * This field is deprecated. Use SnsTopicARN. + */ + SnsTopicName?: String; + /** + * Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is: arn:aws:sns:us-east-2:123456789012:MyTopic + */ + SnsTopicARN?: String; + /** + * Specifies whether the trail is publishing events from global services such as IAM to the log files. + */ + IncludeGlobalServiceEvents?: Boolean; + /** + * Specifies whether the trail exists in one region or in all regions. + */ + IsMultiRegionTrail?: Boolean; + /** + * Specifies the ARN of the trail that was updated. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + */ + TrailARN?: String; + /** + * Specifies whether log file integrity validation is enabled. + */ + LogFileValidationEnabled?: Boolean; + /** + * Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered. + */ + CloudWatchLogsLogGroupArn?: String; + /** + * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. + */ + CloudWatchLogsRoleArn?: String; + /** + * Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + */ + KmsKeyId?: String; + /** + * Specifies whether the trail is an organization trail. + */ + IsOrganizationTrail?: Boolean; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-11-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudTrail client. + */ + export import Types = CloudTrail; +} +export = CloudTrail; diff --git a/node_modules/aws-sdk/clients/cloudtrail.js b/node_modules/aws-sdk/clients/cloudtrail.js new file mode 100644 index 0000000..3135c70 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudtrail.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudtrail'] = {}; +AWS.CloudTrail = Service.defineService('cloudtrail', ['2013-11-01']); +Object.defineProperty(apiLoader.services['cloudtrail'], '2013-11-01', { + get: function get() { + var model = require('../apis/cloudtrail-2013-11-01.min.json'); + model.paginators = require('../apis/cloudtrail-2013-11-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudTrail; diff --git a/node_modules/aws-sdk/clients/cloudwatch.d.ts b/node_modules/aws-sdk/clients/cloudwatch.d.ts new file mode 100644 index 0000000..9cefd20 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudwatch.d.ts @@ -0,0 +1,1119 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudWatch extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudWatch.Types.ClientConfiguration) + config: Config & CloudWatch.Types.ClientConfiguration; + /** + * Deletes the specified alarms. In the event of an error, no alarms are deleted. + */ + deleteAlarms(params: CloudWatch.Types.DeleteAlarmsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified alarms. In the event of an error, no alarms are deleted. + */ + deleteAlarms(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted. + */ + deleteDashboards(params: CloudWatch.Types.DeleteDashboardsInput, callback?: (err: AWSError, data: CloudWatch.Types.DeleteDashboardsOutput) => void): Request; + /** + * Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted. + */ + deleteDashboards(callback?: (err: AWSError, data: CloudWatch.Types.DeleteDashboardsOutput) => void): Request; + /** + * Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned. CloudWatch retains the history of an alarm even if you delete the alarm. + */ + describeAlarmHistory(params: CloudWatch.Types.DescribeAlarmHistoryInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmHistoryOutput) => void): Request; + /** + * Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned. CloudWatch retains the history of an alarm even if you delete the alarm. + */ + describeAlarmHistory(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmHistoryOutput) => void): Request; + /** + * Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. + */ + describeAlarms(params: CloudWatch.Types.DescribeAlarmsInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request; + /** + * Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. + */ + describeAlarms(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request; + /** + * Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit. + */ + describeAlarmsForMetric(params: CloudWatch.Types.DescribeAlarmsForMetricInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsForMetricOutput) => void): Request; + /** + * Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit. + */ + describeAlarmsForMetric(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsForMetricOutput) => void): Request; + /** + * Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes. + */ + disableAlarmActions(params: CloudWatch.Types.DisableAlarmActionsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes. + */ + disableAlarmActions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the actions for the specified alarms. + */ + enableAlarmActions(params: CloudWatch.Types.EnableAlarmActionsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the actions for the specified alarms. + */ + enableAlarmActions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Displays the details of the dashboard that you specify. To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy. + */ + getDashboard(params: CloudWatch.Types.GetDashboardInput, callback?: (err: AWSError, data: CloudWatch.Types.GetDashboardOutput) => void): Request; + /** + * Displays the details of the dashboard that you specify. To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy. + */ + getDashboard(callback?: (err: AWSError, data: CloudWatch.Types.GetDashboardOutput) => void): Request; + /** + * You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide. Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing. Amazon CloudWatch retains metric data as follows: Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1. Data points with a period of 60 seconds (1-minute) are available for 15 days. Data points with a period of 300 seconds (5-minute) are available for 63 days. Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months). Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. + */ + getMetricData(params: CloudWatch.Types.GetMetricDataInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricDataOutput) => void): Request; + /** + * You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide. Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing. Amazon CloudWatch retains metric data as follows: Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1. Data points with a period of 60 seconds (1-minute) are available for 15 days. Data points with a period of 300 seconds (5-minute) are available for 63 days. Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months). Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. + */ + getMetricData(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricDataOutput) => void): Request; + /** + * Gets statistics for the specified metric. The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order. CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned. CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true: The SampleCount value of the statistic set is 1. The Min and the Max values of the statistic set are equal. Percentile statistics are not available for metrics when any of the metric values are negative numbers. Amazon CloudWatch retains metric data as follows: Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1. Data points with a period of 60 seconds (1-minute) are available for 15 days. Data points with a period of 300 seconds (5-minute) are available for 63 days. Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months). Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016. For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide. + */ + getMetricStatistics(params: CloudWatch.Types.GetMetricStatisticsInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricStatisticsOutput) => void): Request; + /** + * Gets statistics for the specified metric. The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order. CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned. CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true: The SampleCount value of the statistic set is 1. The Min and the Max values of the statistic set are equal. Percentile statistics are not available for metrics when any of the metric values are negative numbers. Amazon CloudWatch retains metric data as follows: Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1. Data points with a period of 60 seconds (1-minute) are available for 15 days. Data points with a period of 300 seconds (5-minute) are available for 63 days. Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months). Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016. For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide. + */ + getMetricStatistics(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricStatisticsOutput) => void): Request; + /** + * You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard. The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations. There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits: As many as 100 metrics in the graph. Up to 100 KB uncompressed payload. + */ + getMetricWidgetImage(params: CloudWatch.Types.GetMetricWidgetImageInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricWidgetImageOutput) => void): Request; + /** + * You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard. The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations. There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits: As many as 100 metrics in the graph. Up to 100 KB uncompressed payload. + */ + getMetricWidgetImage(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricWidgetImageOutput) => void): Request; + /** + * Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results. + */ + listDashboards(params: CloudWatch.Types.ListDashboardsInput, callback?: (err: AWSError, data: CloudWatch.Types.ListDashboardsOutput) => void): Request; + /** + * Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results. + */ + listDashboards(callback?: (err: AWSError, data: CloudWatch.Types.ListDashboardsOutput) => void): Request; + /** + * List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data. Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls. After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics. + */ + listMetrics(params: CloudWatch.Types.ListMetricsInput, callback?: (err: AWSError, data: CloudWatch.Types.ListMetricsOutput) => void): Request; + /** + * List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data. Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls. After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics. + */ + listMetrics(callback?: (err: AWSError, data: CloudWatch.Types.ListMetricsOutput) => void): Request; + /** + * Displays the tags associated with a CloudWatch resource. Alarms support tagging. + */ + listTagsForResource(params: CloudWatch.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.ListTagsForResourceOutput) => void): Request; + /** + * Displays the tags associated with a CloudWatch resource. Alarms support tagging. + */ + listTagsForResource(callback?: (err: AWSError, data: CloudWatch.Types.ListTagsForResourceOutput) => void): Request; + /** + * Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here. There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific. A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard. When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard. + */ + putDashboard(params: CloudWatch.Types.PutDashboardInput, callback?: (err: AWSError, data: CloudWatch.Types.PutDashboardOutput) => void): Request; + /** + * Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here. There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific. A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard. When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard. + */ + putDashboard(callback?: (err: AWSError, data: CloudWatch.Types.PutDashboardOutput) => void): Request; + /** + * Creates or updates an alarm and associates it with the specified metric or metric math expression. When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations: iam:CreateServiceLinkedRole for all alarms with EC2 actions ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics ec2:StopInstances for alarms with stop actions ec2:TerminateInstances for alarms with terminate actions No specific permissions are needed for alarms with recover actions If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed. If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions. The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role. + */ + putMetricAlarm(params: CloudWatch.Types.PutMetricAlarmInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates an alarm and associates it with the specified metric or metric math expression. When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations: iam:CreateServiceLinkedRole for all alarms with EC2 actions ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics ec2:StopInstances for alarms with stop actions ec2:TerminateInstances for alarms with terminate actions No specific permissions are needed for alarms with recover actions If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed. If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions. The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role. + */ + putMetricAlarm(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics. You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data. Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics. Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported. You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide. Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true: The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal. The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount. + */ + putMetricData(params: CloudWatch.Types.PutMetricDataInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics. You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data. Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics. Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported. You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide. Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true: The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal. The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount. + */ + putMetricData(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory. + */ + setAlarmState(params: CloudWatch.Types.SetAlarmStateInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory. + */ + setAlarmState(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. In CloudWatch, alarms can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. + */ + tagResource(params: CloudWatch.Types.TagResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.TagResourceOutput) => void): Request; + /** + * Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. In CloudWatch, alarms can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. + */ + tagResource(callback?: (err: AWSError, data: CloudWatch.Types.TagResourceOutput) => void): Request; + /** + * Removes one or more tags from the specified resource. + */ + untagResource(params: CloudWatch.Types.UntagResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.UntagResourceOutput) => void): Request; + /** + * Removes one or more tags from the specified resource. + */ + untagResource(callback?: (err: AWSError, data: CloudWatch.Types.UntagResourceOutput) => void): Request; + /** + * Waits for the alarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times). + */ + waitFor(state: "alarmExists", params: CloudWatch.Types.DescribeAlarmsInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request; + /** + * Waits for the alarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times). + */ + waitFor(state: "alarmExists", callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request; +} +declare namespace CloudWatch { + export type ActionPrefix = string; + export type ActionsEnabled = boolean; + export type AlarmArn = string; + export type AlarmDescription = string; + export interface AlarmHistoryItem { + /** + * The descriptive name for the alarm. + */ + AlarmName?: AlarmName; + /** + * The time stamp for the alarm history item. + */ + Timestamp?: Timestamp; + /** + * The type of alarm history item. + */ + HistoryItemType?: HistoryItemType; + /** + * A summary of the alarm history, in text format. + */ + HistorySummary?: HistorySummary; + /** + * Data about the alarm, in JSON format. + */ + HistoryData?: HistoryData; + } + export type AlarmHistoryItems = AlarmHistoryItem[]; + export type AlarmName = string; + export type AlarmNamePrefix = string; + export type AlarmNames = AlarmName[]; + export type AmazonResourceName = string; + export type ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|string; + export type Counts = DatapointValue[]; + export type DashboardArn = string; + export type DashboardBody = string; + export type DashboardEntries = DashboardEntry[]; + export interface DashboardEntry { + /** + * The name of the dashboard. + */ + DashboardName?: DashboardName; + /** + * The Amazon Resource Name (ARN) of the dashboard. + */ + DashboardArn?: DashboardArn; + /** + * The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. + */ + LastModified?: LastModified; + /** + * The size of the dashboard, in bytes. + */ + Size?: Size; + } + export type DashboardName = string; + export type DashboardNamePrefix = string; + export type DashboardNames = DashboardName[]; + export interface DashboardValidationMessage { + /** + * The data path related to the message. + */ + DataPath?: DataPath; + /** + * A message describing the error or warning. + */ + Message?: Message; + } + export type DashboardValidationMessages = DashboardValidationMessage[]; + export type DataPath = string; + export interface Datapoint { + /** + * The time stamp used for the data point. + */ + Timestamp?: Timestamp; + /** + * The number of metric values that contributed to the aggregate value of this data point. + */ + SampleCount?: DatapointValue; + /** + * The average of the metric values that correspond to the data point. + */ + Average?: DatapointValue; + /** + * The sum of the metric values for the data point. + */ + Sum?: DatapointValue; + /** + * The minimum metric value for the data point. + */ + Minimum?: DatapointValue; + /** + * The maximum metric value for the data point. + */ + Maximum?: DatapointValue; + /** + * The standard unit for the data point. + */ + Unit?: StandardUnit; + /** + * The percentile statistic for the data point. + */ + ExtendedStatistics?: DatapointValueMap; + } + export type DatapointValue = number; + export type DatapointValueMap = {[key: string]: DatapointValue}; + export type DatapointValues = DatapointValue[]; + export type Datapoints = Datapoint[]; + export type DatapointsToAlarm = number; + export interface DeleteAlarmsInput { + /** + * The alarms to be deleted. + */ + AlarmNames: AlarmNames; + } + export interface DeleteDashboardsInput { + /** + * The dashboards to be deleted. This parameter is required. + */ + DashboardNames: DashboardNames; + } + export interface DeleteDashboardsOutput { + } + export interface DescribeAlarmHistoryInput { + /** + * The name of the alarm. + */ + AlarmName?: AlarmName; + /** + * The type of alarm histories to retrieve. + */ + HistoryItemType?: HistoryItemType; + /** + * The starting date to retrieve alarm history. + */ + StartDate?: Timestamp; + /** + * The ending date to retrieve alarm history. + */ + EndDate?: Timestamp; + /** + * The maximum number of alarm history records to retrieve. + */ + MaxRecords?: MaxRecords; + /** + * The token returned by a previous call to indicate that there is more data available. + */ + NextToken?: NextToken; + } + export interface DescribeAlarmHistoryOutput { + /** + * The alarm histories, in JSON format. + */ + AlarmHistoryItems?: AlarmHistoryItems; + /** + * The token that marks the start of the next batch of returned results. + */ + NextToken?: NextToken; + } + export interface DescribeAlarmsForMetricInput { + /** + * The name of the metric. + */ + MetricName: MetricName; + /** + * The namespace of the metric. + */ + Namespace: Namespace; + /** + * The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics. + */ + Statistic?: Statistic; + /** + * The percentile statistic for the metric. Specify a value between p0.0 and p100. + */ + ExtendedStatistic?: ExtendedStatistic; + /** + * The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed. + */ + Dimensions?: Dimensions; + /** + * The period, in seconds, over which the statistic is applied. + */ + Period?: Period; + /** + * The unit for the metric. + */ + Unit?: StandardUnit; + } + export interface DescribeAlarmsForMetricOutput { + /** + * The information for each alarm with the specified metric. + */ + MetricAlarms?: MetricAlarms; + } + export interface DescribeAlarmsInput { + /** + * The names of the alarms. + */ + AlarmNames?: AlarmNames; + /** + * The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames. + */ + AlarmNamePrefix?: AlarmNamePrefix; + /** + * The state value to be used in matching alarms. + */ + StateValue?: StateValue; + /** + * The action name prefix. + */ + ActionPrefix?: ActionPrefix; + /** + * The maximum number of alarm descriptions to retrieve. + */ + MaxRecords?: MaxRecords; + /** + * The token returned by a previous call to indicate that there is more data available. + */ + NextToken?: NextToken; + } + export interface DescribeAlarmsOutput { + /** + * The information for the specified alarms. + */ + MetricAlarms?: MetricAlarms; + /** + * The token that marks the start of the next batch of returned results. + */ + NextToken?: NextToken; + } + export interface Dimension { + /** + * The name of the dimension. + */ + Name: DimensionName; + /** + * The value representing the dimension measurement. + */ + Value: DimensionValue; + } + export interface DimensionFilter { + /** + * The dimension name to be matched. + */ + Name: DimensionName; + /** + * The value of the dimension to be matched. + */ + Value?: DimensionValue; + } + export type DimensionFilters = DimensionFilter[]; + export type DimensionName = string; + export type DimensionValue = string; + export type Dimensions = Dimension[]; + export interface DisableAlarmActionsInput { + /** + * The names of the alarms. + */ + AlarmNames: AlarmNames; + } + export interface EnableAlarmActionsInput { + /** + * The names of the alarms. + */ + AlarmNames: AlarmNames; + } + export type EvaluateLowSampleCountPercentile = string; + export type EvaluationPeriods = number; + export type ExtendedStatistic = string; + export type ExtendedStatistics = ExtendedStatistic[]; + export interface GetDashboardInput { + /** + * The name of the dashboard to be described. + */ + DashboardName: DashboardName; + } + export interface GetDashboardOutput { + /** + * The Amazon Resource Name (ARN) of the dashboard. + */ + DashboardArn?: DashboardArn; + /** + * The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see CloudWatch-Dashboard-Body-Structure. + */ + DashboardBody?: DashboardBody; + /** + * The name of the dashboard. + */ + DashboardName?: DashboardName; + } + export interface GetMetricDataInput { + /** + * The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data. + */ + MetricDataQueries: MetricDataQueries; + /** + * The time stamp indicating the earliest data to be returned. For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime. + */ + StartTime: Timestamp; + /** + * The time stamp indicating the latest data to be returned. For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime. + */ + EndTime: Timestamp; + /** + * Include this value, if it was returned by the previous call, to get the next set of data points. + */ + NextToken?: NextToken; + /** + * The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached. + */ + ScanBy?: ScanBy; + /** + * The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used. + */ + MaxDatapoints?: GetMetricDataMaxDatapoints; + } + export type GetMetricDataMaxDatapoints = number; + export interface GetMetricDataOutput { + /** + * The metrics that are returned, including the metric name, namespace, and dimensions. + */ + MetricDataResults?: MetricDataResults; + /** + * A token that marks the next batch of returned results. + */ + NextToken?: NextToken; + /** + * Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that may be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as possible is still executed. A message appears here only if it is related to the global GetMetricData operation. Any message about a specific metric returned by the operation appears in the MetricDataResult object returned for that metric. + */ + Messages?: MetricDataResultMessages; + } + export interface GetMetricStatisticsInput { + /** + * The namespace of the metric, with or without spaces. + */ + Namespace: Namespace; + /** + * The name of the metric, with or without spaces. + */ + MetricName: MetricName; + /** + * The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide. + */ + Dimensions?: Dimensions; + /** + * The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request. The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z). CloudWatch rounds the specified time stamp as follows: Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00. Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00. Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00. If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15. + */ + StartTime: Timestamp; + /** + * The time stamp that determines the last data point to return. The value specified is exclusive; results include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z). + */ + EndTime: Timestamp; + /** + * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second. If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour). + */ + Period: Period; + /** + * The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. + */ + Statistics?: Statistics; + /** + * The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers. + */ + ExtendedStatistics?: ExtendedStatistics; + /** + * The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If you specify only a unit that the metric does not report, the results of the call are null. + */ + Unit?: StandardUnit; + } + export interface GetMetricStatisticsOutput { + /** + * A label for the specified metric. + */ + Label?: MetricLabel; + /** + * The data points for the specified metric. + */ + Datapoints?: Datapoints; + } + export interface GetMetricWidgetImageInput { + /** + * A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget parameter in each GetMetricWidgetImage call. For more information about the syntax of MetricWidget see CloudWatch-Metric-Widget-Structure. If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend. + */ + MetricWidget: MetricWidget; + /** + * The format of the resulting image. Only PNG images are supported. The default is png. If you specify png, the API returns an HTTP response with the content-type set to text/xml. The image data is in a MetricWidgetImage field. For example: <GetMetricWidgetImageResponse xmlns=<URLstring>> <GetMetricWidgetImageResult> <MetricWidgetImage> iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip... </MetricWidgetImage> </GetMetricWidgetImageResult> <ResponseMetadata> <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId> </ResponseMetadata> </GetMetricWidgetImageResponse> The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS SDK, you should use png. If you specify image/png, the HTTP response has a content-type set to image/png, and the body of the response is a PNG image. + */ + OutputFormat?: OutputFormat; + } + export interface GetMetricWidgetImageOutput { + /** + * The image of the graph, in the output format specified. + */ + MetricWidgetImage?: MetricWidgetImage; + } + export type HistoryData = string; + export type HistoryItemType = "ConfigurationUpdate"|"StateUpdate"|"Action"|string; + export type HistorySummary = string; + export type LastModified = Date; + export interface ListDashboardsInput { + /** + * If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_". + */ + DashboardNamePrefix?: DashboardNamePrefix; + /** + * The token returned by a previous call to indicate that there is more data available. + */ + NextToken?: NextToken; + } + export interface ListDashboardsOutput { + /** + * The list of matching dashboards. + */ + DashboardEntries?: DashboardEntries; + /** + * The token that marks the start of the next batch of returned results. + */ + NextToken?: NextToken; + } + export interface ListMetricsInput { + /** + * The namespace to filter against. + */ + Namespace?: Namespace; + /** + * The name of the metric to filter against. + */ + MetricName?: MetricName; + /** + * The dimensions to filter against. + */ + Dimensions?: DimensionFilters; + /** + * The token returned by a previous call to indicate that there is more data available. + */ + NextToken?: NextToken; + } + export interface ListMetricsOutput { + /** + * The metrics. + */ + Metrics?: Metrics; + /** + * The token that marks the start of the next batch of returned results. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceInput { + /** + * The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference. + */ + ResourceARN: AmazonResourceName; + } + export interface ListTagsForResourceOutput { + /** + * The list of tag keys and values associated with the resource you specified. + */ + Tags?: TagList; + } + export type MaxRecords = number; + export type Message = string; + export interface MessageData { + /** + * The error code or status code associated with the message. + */ + Code?: MessageDataCode; + /** + * The message text. + */ + Value?: MessageDataValue; + } + export type MessageDataCode = string; + export type MessageDataValue = string; + export interface Metric { + /** + * The namespace of the metric. + */ + Namespace?: Namespace; + /** + * The name of the metric. This is a required field. + */ + MetricName?: MetricName; + /** + * The dimensions for the metric. + */ + Dimensions?: Dimensions; + } + export interface MetricAlarm { + /** + * The name of the alarm. + */ + AlarmName?: AlarmName; + /** + * The Amazon Resource Name (ARN) of the alarm. + */ + AlarmArn?: AlarmArn; + /** + * The description of the alarm. + */ + AlarmDescription?: AlarmDescription; + /** + * The time stamp of the last update to the alarm configuration. + */ + AlarmConfigurationUpdatedTimestamp?: Timestamp; + /** + * Indicates whether actions should be executed during any changes to the alarm state. + */ + ActionsEnabled?: ActionsEnabled; + /** + * The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). + */ + OKActions?: ResourceList; + /** + * The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). + */ + AlarmActions?: ResourceList; + /** + * The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). + */ + InsufficientDataActions?: ResourceList; + /** + * The state value for the alarm. + */ + StateValue?: StateValue; + /** + * An explanation for the alarm state, in text format. + */ + StateReason?: StateReason; + /** + * An explanation for the alarm state, in JSON format. + */ + StateReasonData?: StateReasonData; + /** + * The time stamp of the last update to the alarm state. + */ + StateUpdatedTimestamp?: Timestamp; + /** + * The name of the metric associated with the alarm. + */ + MetricName?: MetricName; + /** + * The namespace of the metric associated with the alarm. + */ + Namespace?: Namespace; + /** + * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic. + */ + Statistic?: Statistic; + /** + * The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. + */ + ExtendedStatistic?: ExtendedStatistic; + /** + * The dimensions for the metric associated with the alarm. + */ + Dimensions?: Dimensions; + /** + * The period, in seconds, over which the statistic is applied. + */ + Period?: Period; + /** + * The unit of the metric associated with the alarm. + */ + Unit?: StandardUnit; + /** + * The number of periods over which data is compared to the specified threshold. + */ + EvaluationPeriods?: EvaluationPeriods; + /** + * The number of datapoints that must be breaching to trigger the alarm. + */ + DatapointsToAlarm?: DatapointsToAlarm; + /** + * The value to compare with the specified statistic. + */ + Threshold?: Threshold; + /** + * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. + */ + ComparisonOperator?: ComparisonOperator; + /** + * Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used. + */ + TreatMissingData?: TreatMissingData; + /** + * Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available. + */ + EvaluateLowSampleCountPercentile?: EvaluateLowSampleCountPercentile; + /** + * + */ + Metrics?: MetricDataQueries; + } + export type MetricAlarms = MetricAlarm[]; + export type MetricData = MetricDatum[]; + export type MetricDataQueries = MetricDataQuery[]; + export interface MetricDataQuery { + /** + * A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter. + */ + Id: MetricId; + /** + * The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both. + */ + MetricStat?: MetricStat; + /** + * The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide. Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both. + */ + Expression?: MetricExpression; + /** + * A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default. + */ + Label?: MetricLabel; + /** + * When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used. When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False. + */ + ReturnData?: ReturnData; + } + export interface MetricDataResult { + /** + * The short name you specified to represent this metric. + */ + Id?: MetricId; + /** + * The human-readable label associated with the data. + */ + Label?: MetricLabel; + /** + * The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x]. + */ + Timestamps?: Timestamps; + /** + * The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x]. + */ + Values?: DatapointValues; + /** + * The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present. + */ + StatusCode?: StatusCode; + /** + * A list of messages with additional information about the data returned. + */ + Messages?: MetricDataResultMessages; + } + export type MetricDataResultMessages = MessageData[]; + export type MetricDataResults = MetricDataResult[]; + export interface MetricDatum { + /** + * The name of the metric. + */ + MetricName: MetricName; + /** + * The dimensions associated with the metric. + */ + Dimensions?: Dimensions; + /** + * The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. + */ + Timestamp?: Timestamp; + /** + * The value for the metric. Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported. + */ + Value?: DatapointValue; + /** + * The statistical values for the metric. + */ + StatisticValues?: StatisticSet; + /** + * Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array. Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported. + */ + Values?: Values; + /** + * Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period. If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array. + */ + Counts?: Counts; + /** + * The unit of the metric. + */ + Unit?: StandardUnit; + /** + * Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide. This field is optional, if you do not specify it the default of 60 is used. + */ + StorageResolution?: StorageResolution; + } + export type MetricExpression = string; + export type MetricId = string; + export type MetricLabel = string; + export type MetricName = string; + export interface MetricStat { + /** + * The metric to return, including the metric name, namespace, and dimensions. + */ + Metric: Metric; + /** + * The period, in seconds, to use when retrieving the metric. + */ + Period: Period; + /** + * The statistic to return. It can include any CloudWatch statistic or extended statistic. + */ + Stat: Stat; + /** + * The unit to use for the returned data points. + */ + Unit?: StandardUnit; + } + export type MetricWidget = string; + export type MetricWidgetImage = Buffer|Uint8Array|Blob|string; + export type Metrics = Metric[]; + export type Namespace = string; + export type NextToken = string; + export type OutputFormat = string; + export type Period = number; + export interface PutDashboardInput { + /** + * The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required. + */ + DashboardName: DashboardName; + /** + * The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required. For more information about the syntax, see CloudWatch-Dashboard-Body-Structure. + */ + DashboardBody: DashboardBody; + } + export interface PutDashboardOutput { + /** + * If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty. If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard may not render. If this result includes error messages, the input was not valid and the operation failed. + */ + DashboardValidationMessages?: DashboardValidationMessages; + } + export interface PutMetricAlarmInput { + /** + * The name for the alarm. This name must be unique within your AWS account. + */ + AlarmName: AlarmName; + /** + * The description for the alarm. + */ + AlarmDescription?: AlarmDescription; + /** + * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. + */ + ActionsEnabled?: ActionsEnabled; + /** + * The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 + */ + OKActions?: ResourceList; + /** + * The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 + */ + AlarmActions?: ResourceList; + /** + * The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 + */ + InsufficientDataActions?: ResourceList; + /** + * The name for the metric associated with the alarm. If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array. + */ + MetricName?: MetricName; + /** + * The namespace for the metric associated specified in MetricName. + */ + Namespace?: Namespace; + /** + * The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both. + */ + Statistic?: Statistic; + /** + * The percentile statistic for the metric specified in MetricName. Specify a value between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both. + */ + ExtendedStatistic?: ExtendedStatistic; + /** + * The dimensions for the metric specified in MetricName. + */ + Dimensions?: Dimensions; + /** + * The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60. Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing. An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds. + */ + Period?: Period; + /** + * The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm can get stuck in the INSUFFICIENT DATA state. + */ + Unit?: StandardUnit; + /** + * The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N. An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds. + */ + EvaluationPeriods: EvaluationPeriods; + /** + * The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide. + */ + DatapointsToAlarm?: DatapointsToAlarm; + /** + * The value against which the specified statistic is compared. + */ + Threshold: Threshold; + /** + * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. + */ + ComparisonOperator: ComparisonOperator; + /** + * Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data. Valid Values: breaching | notBreaching | ignore | missing + */ + TreatMissingData?: TreatMissingData; + /** + * Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples. Valid Values: evaluate | ignore + */ + EvaluateLowSampleCountPercentile?: EvaluateLowSampleCountPercentile; + /** + * An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. Each item in the Metrics array either retrieves a metric or performs a math expression. One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnValue to true for this object in the array. For more information, see MetricDataQuery. If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array. + */ + Metrics?: MetricDataQueries; + /** + * A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. + */ + Tags?: TagList; + } + export interface PutMetricDataInput { + /** + * The namespace for the metric data. You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for use by Amazon Web Services products. + */ + Namespace: Namespace; + /** + * The data for the metric. The array can include no more than 20 metrics per call. + */ + MetricData: MetricData; + } + export type ResourceList = ResourceName[]; + export type ResourceName = string; + export type ReturnData = boolean; + export type ScanBy = "TimestampDescending"|"TimestampAscending"|string; + export interface SetAlarmStateInput { + /** + * The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters. + */ + AlarmName: AlarmName; + /** + * The value of the state. + */ + StateValue: StateValue; + /** + * The reason that this alarm is set to this specific state, in text format. + */ + StateReason: StateReason; + /** + * The reason that this alarm is set to this specific state, in JSON format. + */ + StateReasonData?: StateReasonData; + } + export type Size = number; + export type StandardUnit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"|string; + export type Stat = string; + export type StateReason = string; + export type StateReasonData = string; + export type StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA"|string; + export type Statistic = "SampleCount"|"Average"|"Sum"|"Minimum"|"Maximum"|string; + export interface StatisticSet { + /** + * The number of samples used for the statistic set. + */ + SampleCount: DatapointValue; + /** + * The sum of values for the sample set. + */ + Sum: DatapointValue; + /** + * The minimum value of the sample set. + */ + Minimum: DatapointValue; + /** + * The maximum value of the sample set. + */ + Maximum: DatapointValue; + } + export type Statistics = Statistic[]; + export type StatusCode = "Complete"|"InternalError"|"PartialData"|string; + export type StorageResolution = number; + export interface Tag { + /** + * A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. + */ + Key: TagKey; + /** + * The value for the specified tag key. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceInput { + /** + * The ARN of the CloudWatch resource that you're adding tags to. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference. + */ + ResourceARN: AmazonResourceName; + /** + * The list of key-value pairs to associate with the resource. + */ + Tags: TagList; + } + export interface TagResourceOutput { + } + export type TagValue = string; + export type Threshold = number; + export type Timestamp = Date; + export type Timestamps = Timestamp[]; + export type TreatMissingData = string; + export interface UntagResourceInput { + /** + * The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference. + */ + ResourceARN: AmazonResourceName; + /** + * The list of tag keys to remove from the resource. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceOutput { + } + export type Values = DatapointValue[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2010-08-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudWatch client. + */ + export import Types = CloudWatch; +} +export = CloudWatch; diff --git a/node_modules/aws-sdk/clients/cloudwatch.js b/node_modules/aws-sdk/clients/cloudwatch.js new file mode 100644 index 0000000..f831637 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudwatch.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudwatch'] = {}; +AWS.CloudWatch = Service.defineService('cloudwatch', ['2010-08-01']); +Object.defineProperty(apiLoader.services['cloudwatch'], '2010-08-01', { + get: function get() { + var model = require('../apis/monitoring-2010-08-01.min.json'); + model.paginators = require('../apis/monitoring-2010-08-01.paginators.json').pagination; + model.waiters = require('../apis/monitoring-2010-08-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudWatch; diff --git a/node_modules/aws-sdk/clients/cloudwatchevents.d.ts b/node_modules/aws-sdk/clients/cloudwatchevents.d.ts new file mode 100644 index 0000000..a05e557 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudwatchevents.d.ts @@ -0,0 +1,832 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudWatchEvents extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudWatchEvents.Types.ClientConfiguration) + config: Config & CloudWatchEvents.Types.ClientConfiguration; + /** + * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule. + */ + deleteRule(params: CloudWatchEvents.Types.DeleteRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule. + */ + deleteRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy. To enable your account to receive events from other accounts, use PutPermission. + */ + describeEventBus(params: CloudWatchEvents.Types.DescribeEventBusRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventBusResponse) => void): Request; + /** + * Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy. To enable your account to receive events from other accounts, use PutPermission. + */ + describeEventBus(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeEventBusResponse) => void): Request; + /** + * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. + */ + describeRule(params: CloudWatchEvents.Types.DescribeRuleRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeRuleResponse) => void): Request; + /** + * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. + */ + describeRule(callback?: (err: AWSError, data: CloudWatchEvents.Types.DescribeRuleResponse) => void): Request; + /** + * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect. + */ + disableRule(params: CloudWatchEvents.Types.DisableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect. + */ + disableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect. + */ + enableRule(params: CloudWatchEvents.Types.EnableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect. + */ + enableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. + */ + listRuleNamesByTarget(params: CloudWatchEvents.Types.ListRuleNamesByTargetRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRuleNamesByTargetResponse) => void): Request; + /** + * Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. + */ + listRuleNamesByTarget(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRuleNamesByTargetResponse) => void): Request; + /** + * Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. + */ + listRules(params: CloudWatchEvents.Types.ListRulesRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRulesResponse) => void): Request; + /** + * Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. + */ + listRules(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListRulesResponse) => void): Request; + /** + * Displays the tags associated with a CloudWatch Events resource. In CloudWatch Events, rules can be tagged. + */ + listTagsForResource(params: CloudWatchEvents.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListTagsForResourceResponse) => void): Request; + /** + * Displays the tags associated with a CloudWatch Events resource. In CloudWatch Events, rules can be tagged. + */ + listTagsForResource(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the targets assigned to the specified rule. + */ + listTargetsByRule(params: CloudWatchEvents.Types.ListTargetsByRuleRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.ListTargetsByRuleResponse) => void): Request; + /** + * Lists the targets assigned to the specified rule. + */ + listTargetsByRule(callback?: (err: AWSError, data: CloudWatchEvents.Types.ListTargetsByRuleResponse) => void): Request; + /** + * Sends custom events to Amazon CloudWatch Events so that they can be matched to rules. + */ + putEvents(params: CloudWatchEvents.Types.PutEventsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutEventsResponse) => void): Request; + /** + * Sends custom events to Amazon CloudWatch Events so that they can be matched to rules. + */ + putEvents(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutEventsResponse) => void): Request; + /** + * Running PutPermission permits the specified AWS account or AWS organization to put events to your account's default event bus. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus. 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. To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide. The permission policy on the default event bus cannot exceed 10 KB in size. + */ + putPermission(params: CloudWatchEvents.Types.PutPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Running PutPermission permits the specified AWS account or AWS organization to put events to your account's default event bus. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus. 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. To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide. The permission policy on the default event bus cannot exceed 10 KB in size. + */ + putPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. 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. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. 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. In CloudWatch Events, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets. + */ + putRule(params: CloudWatchEvents.Types.PutRuleRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutRuleResponse) => void): Request; + /** + * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. 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. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. 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. In CloudWatch Events, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets. + */ + putRule(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutRuleResponse) => void): Request; + /** + * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets for CloudWatch Events: EC2 instances SSM Run Command SSM Automation AWS Lambda functions Data streams in Amazon Kinesis Data Streams Data delivery streams in Amazon Kinesis Data Firehose Amazon ECS tasks AWS Step Functions state machines AWS Batch jobs AWS CodeBuild projects Pipelines in AWS CodePipeline Amazon Inspector assessment templates Amazon SNS topics Amazon SQS queues, including FIFO queues The default event bus of another AWS account Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. 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, Kinesis data streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide. If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set 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 Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon CloudWatch Pricing. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), 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). If InputTransformer 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. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. + */ + putTargets(params: CloudWatchEvents.Types.PutTargetsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.PutTargetsResponse) => void): Request; + /** + * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets for CloudWatch Events: EC2 instances SSM Run Command SSM Automation AWS Lambda functions Data streams in Amazon Kinesis Data Streams Data delivery streams in Amazon Kinesis Data Firehose Amazon ECS tasks AWS Step Functions state machines AWS Batch jobs AWS CodeBuild projects Pipelines in AWS CodePipeline Amazon Inspector assessment templates Amazon SNS topics Amazon SQS queues, including FIFO queues The default event bus of another AWS account Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. 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, Kinesis data streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide. If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set 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 Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon CloudWatch Pricing. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), 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). If InputTransformer 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. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. + */ + putTargets(callback?: (err: AWSError, data: CloudWatchEvents.Types.PutTargetsResponse) => void): Request; + /** + * 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 StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus. + */ + removePermission(params: CloudWatchEvents.Types.RemovePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus. + */ + removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. + */ + removeTargets(params: CloudWatchEvents.Types.RemoveTargetsRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.RemoveTargetsResponse) => void): Request; + /** + * Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. + */ + removeTargets(callback?: (err: AWSError, data: CloudWatchEvents.Types.RemoveTargetsResponse) => void): Request; + /** + * Assigns one or more tags (key-value pairs) to the specified CloudWatch Events resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In CloudWatch Events, rules can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. + */ + tagResource(params: CloudWatchEvents.Types.TagResourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.TagResourceResponse) => void): Request; + /** + * Assigns one or more tags (key-value pairs) to the specified CloudWatch Events resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In CloudWatch Events, rules can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. + */ + tagResource(callback?: (err: AWSError, data: CloudWatchEvents.Types.TagResourceResponse) => void): Request; + /** + * Tests whether the specified event pattern matches the provided event. 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. + */ + testEventPattern(params: CloudWatchEvents.Types.TestEventPatternRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.TestEventPatternResponse) => void): Request; + /** + * Tests whether the specified event pattern matches the provided event. 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. + */ + testEventPattern(callback?: (err: AWSError, data: CloudWatchEvents.Types.TestEventPatternResponse) => void): Request; + /** + * Removes one or more tags from the specified CloudWatch Events resource. In CloudWatch Events, rules can be tagged. + */ + untagResource(params: CloudWatchEvents.Types.UntagResourceRequest, callback?: (err: AWSError, data: CloudWatchEvents.Types.UntagResourceResponse) => void): Request; + /** + * Removes one or more tags from the specified CloudWatch Events resource. In CloudWatch Events, rules can be tagged. + */ + untagResource(callback?: (err: AWSError, data: CloudWatchEvents.Types.UntagResourceResponse) => void): Request; +} +declare namespace CloudWatchEvents { + export type Action = string; + export type Arn = string; + export type AssignPublicIp = "ENABLED"|"DISABLED"|string; + export interface AwsVpcConfiguration { + /** + * Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets. + */ + Subnets: StringList; + /** + * Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used. + */ + SecurityGroups?: StringList; + /** + * Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE. + */ + AssignPublicIp?: AssignPublicIp; + } + export interface BatchArrayProperties { + /** + * The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000. + */ + Size?: Integer; + } + export interface BatchParameters { + /** + * The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist. + */ + JobDefinition: String; + /** + * The name to use for this execution of the job, if the target is an AWS Batch job. + */ + JobName: String; + /** + * The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job. + */ + ArrayProperties?: BatchArrayProperties; + /** + * The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition. + */ + RetryStrategy?: BatchRetryStrategy; + } + export interface BatchRetryStrategy { + /** + * The number of times to attempt to retry, if the job fails. Valid values are 1–10. + */ + Attempts?: Integer; + } + export type Boolean = boolean; + export interface Condition { + /** + * Specifies the type of condition. Currently the only supported value is StringEquals. + */ + Type: String; + /** + * Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID. + */ + Key: String; + /** + * Specifies the value for the key. Currently, this must be the ID of the organization. + */ + Value: String; + } + export interface DeleteRuleRequest { + /** + * The name of the rule. + */ + Name: RuleName; + /** + * If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response. + */ + Force?: Boolean; + } + export interface DescribeEventBusRequest { + } + export interface DescribeEventBusResponse { + /** + * The name of the event bus. Currently, this is always default. + */ + Name?: String; + /** + * The Amazon Resource Name (ARN) of the account permitted to write events to the current account. + */ + Arn?: String; + /** + * The policy that enables the external account to send events to your account. + */ + Policy?: String; + } + export interface DescribeRuleRequest { + /** + * The name of the rule. + */ + Name: RuleName; + } + export interface DescribeRuleResponse { + /** + * The name of the rule. + */ + Name?: RuleName; + /** + * The Amazon Resource Name (ARN) of the rule. + */ + Arn?: RuleArn; + /** + * The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide. + */ + EventPattern?: EventPattern; + /** + * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". + */ + ScheduleExpression?: ScheduleExpression; + /** + * Specifies whether the rule is enabled or disabled. + */ + State?: RuleState; + /** + * The description of the rule. + */ + Description?: RuleDescription; + /** + * The Amazon Resource Name (ARN) of the IAM role associated with the rule. + */ + RoleArn?: RoleArn; + /** + * If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule. + */ + ManagedBy?: ManagedBy; + } + export interface DisableRuleRequest { + /** + * The name of the rule. + */ + Name: RuleName; + } + export interface EcsParameters { + /** + * The ARN of the task definition to use if the event target is an Amazon ECS task. + */ + TaskDefinitionArn: Arn; + /** + * The number of tasks to create based on TaskDefinition. The default is 1. + */ + TaskCount?: LimitMin1; + /** + * Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide. + */ + LaunchType?: LaunchType; + /** + * Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails. + */ + NetworkConfiguration?: NetworkConfiguration; + /** + * Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + PlatformVersion?: String; + /** + * Specifies an ECS task group for the task. The maximum length is 255 characters. + */ + Group?: String; + } + export interface EnableRuleRequest { + /** + * The name of the rule. + */ + Name: RuleName; + } + export type ErrorCode = string; + export type ErrorMessage = string; + export type EventId = string; + export type EventPattern = string; + export type EventResource = string; + export type EventResourceList = EventResource[]; + export type EventTime = Date; + export interface InputTransformer { + /** + * Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target. InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation. The keys cannot start with "AWS." + */ + InputPathsMap?: TransformerPaths; + /** + * Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON. If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply: The placeholder cannot be used as an object key. Object values cannot include quote marks. The following example shows the syntax for using InputPathsMap and InputTemplate. "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "<instance> is in state <status>" } To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "<instance> is in state \"<status>\"" } + */ + InputTemplate: TransformerInput; + } + export type InputTransformerPathKey = string; + export type Integer = number; + export interface KinesisParameters { + /** + * The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide. + */ + PartitionKeyPath: TargetPartitionKeyPath; + } + export type LaunchType = "EC2"|"FARGATE"|string; + export type LimitMax100 = number; + export type LimitMin1 = number; + export interface ListRuleNamesByTargetRequest { + /** + * The Amazon Resource Name (ARN) of the target resource. + */ + TargetArn: TargetArn; + /** + * The token returned by a previous call to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return. + */ + Limit?: LimitMax100; + } + export interface ListRuleNamesByTargetResponse { + /** + * The names of the rules that can invoke the given target. + */ + RuleNames?: RuleNameList; + /** + * Indicates whether there are additional results to retrieve. If there are no more results, the value is null. + */ + NextToken?: NextToken; + } + export interface ListRulesRequest { + /** + * The prefix matching the rule name. + */ + NamePrefix?: RuleName; + /** + * The token returned by a previous call to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return. + */ + Limit?: LimitMax100; + } + export interface ListRulesResponse { + /** + * The rules that match the specified criteria. + */ + Rules?: RuleResponseList; + /** + * Indicates whether there are additional results to retrieve. If there are no more results, the value is null. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The ARN of the CloudWatch Events rule for which you want to view tags. + */ + ResourceARN: Arn; + } + export interface ListTagsForResourceResponse { + /** + * The list of tag keys and values associated with the rule you specified + */ + Tags?: TagList; + } + export interface ListTargetsByRuleRequest { + /** + * The name of the rule. + */ + Rule: RuleName; + /** + * The token returned by a previous call to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return. + */ + Limit?: LimitMax100; + } + export interface ListTargetsByRuleResponse { + /** + * The targets assigned to the rule. + */ + Targets?: TargetList; + /** + * Indicates whether there are additional results to retrieve. If there are no more results, the value is null. + */ + NextToken?: NextToken; + } + export type ManagedBy = string; + export type MessageGroupId = string; + export interface NetworkConfiguration { + /** + * Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. + */ + awsvpcConfiguration?: AwsVpcConfiguration; + } + export type NextToken = string; + export type Principal = string; + export interface PutEventsRequest { + /** + * The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on. + */ + Entries: PutEventsRequestEntryList; + } + export interface PutEventsRequestEntry { + /** + * The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used. + */ + Time?: EventTime; + /** + * The source of the event. This field is required. + */ + Source?: String; + /** + * AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. + */ + Resources?: EventResourceList; + /** + * Free-form string used to decide what fields to expect in the event detail. + */ + DetailType?: String; + /** + * A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects. + */ + Detail?: String; + } + export type PutEventsRequestEntryList = PutEventsRequestEntry[]; + export interface PutEventsResponse { + /** + * The number of failed entries. + */ + FailedEntryCount?: Integer; + /** + * The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry. + */ + Entries?: PutEventsResultEntryList; + } + export interface PutEventsResultEntry { + /** + * The ID of the event. + */ + EventId?: EventId; + /** + * The error code that indicates why the event submission failed. + */ + ErrorCode?: ErrorCode; + /** + * The error message that explains why the event submission failed. + */ + ErrorMessage?: ErrorMessage; + } + export type PutEventsResultEntryList = PutEventsResultEntry[]; + export interface PutPermissionRequest { + /** + * The action that you are enabling the other account to perform. Currently, this must be events:PutEvents. + */ + Action: Action; + /** + * The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus. If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts. + */ + Principal: Principal; + /** + * An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission. + */ + StatementId: StatementId; + /** + * This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide. If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization. The Condition is a JSON string which must contain Type, Key, and Value fields. + */ + Condition?: Condition; + } + export interface PutRuleRequest { + /** + * The name of the rule that you are creating or updating. + */ + Name: RuleName; + /** + * The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)". + */ + ScheduleExpression?: ScheduleExpression; + /** + * The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide. + */ + EventPattern?: EventPattern; + /** + * Indicates whether the rule is enabled or disabled. + */ + State?: RuleState; + /** + * A description of the rule. + */ + Description?: RuleDescription; + /** + * The Amazon Resource Name (ARN) of the IAM role associated with the rule. + */ + RoleArn?: RoleArn; + /** + * The list of key-value pairs to associate with the rule. + */ + Tags?: TagList; + } + export interface PutRuleResponse { + /** + * The Amazon Resource Name (ARN) of the rule. + */ + RuleArn?: RuleArn; + } + export interface PutTargetsRequest { + /** + * The name of the rule. + */ + Rule: RuleName; + /** + * The targets to update or add to the rule. + */ + Targets: TargetList; + } + export interface PutTargetsResponse { + /** + * The number of failed entries. + */ + FailedEntryCount?: Integer; + /** + * The failed target entries. + */ + FailedEntries?: PutTargetsResultEntryList; + } + export interface PutTargetsResultEntry { + /** + * The ID of the target. + */ + TargetId?: TargetId; + /** + * The error code that indicates why the target addition failed. If the value is ConcurrentModificationException, too many requests were made at the same time. + */ + ErrorCode?: ErrorCode; + /** + * The error message that explains why the target addition failed. + */ + ErrorMessage?: ErrorMessage; + } + export type PutTargetsResultEntryList = PutTargetsResultEntry[]; + export interface RemovePermissionRequest { + /** + * The statement ID corresponding to the account that is no longer allowed to put events to the default event bus. + */ + StatementId: StatementId; + } + export interface RemoveTargetsRequest { + /** + * The name of the rule. + */ + Rule: RuleName; + /** + * The IDs of the targets to remove from the rule. + */ + Ids: TargetIdList; + /** + * If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response. + */ + Force?: Boolean; + } + export interface RemoveTargetsResponse { + /** + * The number of failed entries. + */ + FailedEntryCount?: Integer; + /** + * The failed target entries. + */ + FailedEntries?: RemoveTargetsResultEntryList; + } + export interface RemoveTargetsResultEntry { + /** + * The ID of the target. + */ + TargetId?: TargetId; + /** + * The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time. + */ + ErrorCode?: ErrorCode; + /** + * The error message that explains why the target removal failed. + */ + ErrorMessage?: ErrorMessage; + } + export type RemoveTargetsResultEntryList = RemoveTargetsResultEntry[]; + export type RoleArn = string; + export interface Rule { + /** + * The name of the rule. + */ + Name?: RuleName; + /** + * The Amazon Resource Name (ARN) of the rule. + */ + Arn?: RuleArn; + /** + * The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide. + */ + EventPattern?: EventPattern; + /** + * The state of the rule. + */ + State?: RuleState; + /** + * The description of the rule. + */ + Description?: RuleDescription; + /** + * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". + */ + ScheduleExpression?: ScheduleExpression; + /** + * The Amazon Resource Name (ARN) of the role that is used for target invocation. + */ + RoleArn?: RoleArn; + /** + * If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule. + */ + ManagedBy?: ManagedBy; + } + export type RuleArn = string; + export type RuleDescription = string; + export type RuleName = string; + export type RuleNameList = RuleName[]; + export type RuleResponseList = Rule[]; + export type RuleState = "ENABLED"|"DISABLED"|string; + export interface RunCommandParameters { + /** + * Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag. + */ + RunCommandTargets: RunCommandTargets; + } + export interface RunCommandTarget { + /** + * Can be either tag: tag-key or InstanceIds. + */ + Key: RunCommandTargetKey; + /** + * If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs. + */ + Values: RunCommandTargetValues; + } + export type RunCommandTargetKey = string; + export type RunCommandTargetValue = string; + export type RunCommandTargetValues = RunCommandTargetValue[]; + export type RunCommandTargets = RunCommandTarget[]; + export type ScheduleExpression = string; + export interface SqsParameters { + /** + * The FIFO message group ID to use as the target. + */ + MessageGroupId?: MessageGroupId; + } + export type StatementId = string; + export type String = string; + export type StringList = String[]; + export interface Tag { + /** + * A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. + */ + Key: TagKey; + /** + * The value for the specified tag key. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The ARN of the CloudWatch Events rule that you're adding tags to. + */ + ResourceARN: Arn; + /** + * The list of key-value pairs to associate with the rule. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export interface Target { + /** + * The ID of the target. + */ + Id: TargetId; + /** + * The Amazon Resource Name (ARN) of the target. + */ + Arn: TargetArn; + /** + * The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target. + */ + RoleArn?: RoleArn; + /** + * Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format. + */ + Input?: TargetInput; + /** + * The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath. + */ + InputPath?: TargetInputPath; + /** + * Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target. + */ + InputTransformer?: InputTransformer; + /** + * The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key. + */ + KinesisParameters?: KinesisParameters; + /** + * Parameters used when you are using the rule to invoke Amazon EC2 Run Command. + */ + RunCommandParameters?: RunCommandParameters; + /** + * Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide. + */ + EcsParameters?: EcsParameters; + /** + * If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide. + */ + BatchParameters?: BatchParameters; + /** + * Contains the message group ID to use when the target is a FIFO queue. If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled. + */ + SqsParameters?: SqsParameters; + } + export type TargetArn = string; + export type TargetId = string; + export type TargetIdList = TargetId[]; + export type TargetInput = string; + export type TargetInputPath = string; + export type TargetList = Target[]; + export type TargetPartitionKeyPath = string; + export interface TestEventPatternRequest { + /** + * The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide. + */ + EventPattern: EventPattern; + /** + * The event, in JSON format, to test against the event pattern. + */ + Event: String; + } + export interface TestEventPatternResponse { + /** + * Indicates whether the event matches the event pattern. + */ + Result?: Boolean; + } + export type TransformerInput = string; + export type TransformerPaths = {[key: string]: TargetInputPath}; + export interface UntagResourceRequest { + /** + * The ARN of the CloudWatch Events rule from which you are removing tags. + */ + ResourceARN: Arn; + /** + * The list of tag keys to remove from the resource. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-02-03"|"2015-10-07"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudWatchEvents client. + */ + export import Types = CloudWatchEvents; +} +export = CloudWatchEvents; diff --git a/node_modules/aws-sdk/clients/cloudwatchevents.js b/node_modules/aws-sdk/clients/cloudwatchevents.js new file mode 100644 index 0000000..72ea0c7 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudwatchevents.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudwatchevents'] = {}; +AWS.CloudWatchEvents = Service.defineService('cloudwatchevents', ['2014-02-03*', '2015-10-07']); +Object.defineProperty(apiLoader.services['cloudwatchevents'], '2015-10-07', { + get: function get() { + var model = require('../apis/events-2015-10-07.min.json'); + model.paginators = require('../apis/events-2015-10-07.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudWatchEvents; diff --git a/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts b/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts new file mode 100644 index 0000000..ea14985 --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts @@ -0,0 +1,1465 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CloudWatchLogs extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CloudWatchLogs.Types.ClientConfiguration) + config: Config & CloudWatchLogs.Types.ClientConfiguration; + /** + * Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group. Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested. Note that it can take up to 5 minutes for this operation to take effect. If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error. + */ + associateKmsKey(params: CloudWatchLogs.Types.AssociateKmsKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group. Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested. Note that it can take up to 5 minutes for this operation to take effect. If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error. + */ + associateKmsKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels the specified export task. The task must be in the PENDING or RUNNING state. + */ + cancelExportTask(params: CloudWatchLogs.Types.CancelExportTaskRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels the specified export task. The task must be in the PENDING or RUNNING state. + */ + cancelExportTask(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket. This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects. + */ + createExportTask(params: CloudWatchLogs.Types.CreateExportTaskRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.CreateExportTaskResponse) => void): Request; + /** + * Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket. This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects. + */ + createExportTask(callback?: (err: AWSError, data: CloudWatchLogs.Types.CreateExportTaskResponse) => void): Request; + /** + * Creates a log group with the specified name. You can create up to 5000 log groups per account. You must use the following guidelines when naming a log group: Log group names must be unique within a region for an AWS account. Log group names can be between 1 and 512 characters long. Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error. + */ + createLogGroup(params: CloudWatchLogs.Types.CreateLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a log group with the specified name. You can create up to 5000 log groups per account. You must use the following guidelines when naming a log group: Log group names must be unique within a region for an AWS account. Log group names can be between 1 and 512 characters long. Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error. + */ + createLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a log stream for the specified log group. There is no limit on the number of log streams that you can create for a log group. You must use the following guidelines when naming a log stream: Log stream names must be unique within the log group. Log stream names can be between 1 and 512 characters long. The ':' (colon) and '*' (asterisk) characters are not allowed. + */ + createLogStream(params: CloudWatchLogs.Types.CreateLogStreamRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a log stream for the specified log group. There is no limit on the number of log streams that you can create for a log group. You must use the following guidelines when naming a log stream: Log stream names must be unique within the log group. Log stream names can be between 1 and 512 characters long. The ':' (colon) and '*' (asterisk) characters are not allowed. + */ + createLogStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination. + */ + deleteDestination(params: CloudWatchLogs.Types.DeleteDestinationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination. + */ + deleteDestination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified log group and permanently deletes all the archived log events associated with the log group. + */ + deleteLogGroup(params: CloudWatchLogs.Types.DeleteLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified log group and permanently deletes all the archived log events associated with the log group. + */ + deleteLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. + */ + deleteLogStream(params: CloudWatchLogs.Types.DeleteLogStreamRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. + */ + deleteLogStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified metric filter. + */ + deleteMetricFilter(params: CloudWatchLogs.Types.DeleteMetricFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified metric filter. + */ + deleteMetricFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. + */ + deleteResourcePolicy(params: CloudWatchLogs.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. + */ + deleteResourcePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy. + */ + deleteRetentionPolicy(params: CloudWatchLogs.Types.DeleteRetentionPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy. + */ + deleteRetentionPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified subscription filter. + */ + deleteSubscriptionFilter(params: CloudWatchLogs.Types.DeleteSubscriptionFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified subscription filter. + */ + deleteSubscriptionFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Lists all your destinations. The results are ASCII-sorted by destination name. + */ + describeDestinations(params: CloudWatchLogs.Types.DescribeDestinationsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeDestinationsResponse) => void): Request; + /** + * Lists all your destinations. The results are ASCII-sorted by destination name. + */ + describeDestinations(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeDestinationsResponse) => void): Request; + /** + * Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. + */ + describeExportTasks(params: CloudWatchLogs.Types.DescribeExportTasksRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeExportTasksResponse) => void): Request; + /** + * Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. + */ + describeExportTasks(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeExportTasksResponse) => void): Request; + /** + * Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. + */ + describeLogGroups(params: CloudWatchLogs.Types.DescribeLogGroupsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogGroupsResponse) => void): Request; + /** + * Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. + */ + describeLogGroups(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogGroupsResponse) => void): Request; + /** + * Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. This operation has a limit of five transactions per second, after which transactions are throttled. + */ + describeLogStreams(params: CloudWatchLogs.Types.DescribeLogStreamsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogStreamsResponse) => void): Request; + /** + * Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. This operation has a limit of five transactions per second, after which transactions are throttled. + */ + describeLogStreams(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogStreamsResponse) => void): Request; + /** + * Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name. + */ + describeMetricFilters(params: CloudWatchLogs.Types.DescribeMetricFiltersRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeMetricFiltersResponse) => void): Request; + /** + * Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name. + */ + describeMetricFilters(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeMetricFiltersResponse) => void): Request; + /** + * Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status. + */ + describeQueries(params: CloudWatchLogs.Types.DescribeQueriesRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueriesResponse) => void): Request; + /** + * Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status. + */ + describeQueries(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueriesResponse) => void): Request; + /** + * Lists the resource policies in this account. + */ + describeResourcePolicies(params: CloudWatchLogs.Types.DescribeResourcePoliciesRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeResourcePoliciesResponse) => void): Request; + /** + * Lists the resource policies in this account. + */ + describeResourcePolicies(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeResourcePoliciesResponse) => void): Request; + /** + * Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name. + */ + describeSubscriptionFilters(params: CloudWatchLogs.Types.DescribeSubscriptionFiltersRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse) => void): Request; + /** + * Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name. + */ + describeSubscriptionFilters(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse) => void): Request; + /** + * Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group. After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect. + */ + disassociateKmsKey(params: CloudWatchLogs.Types.DisassociateKmsKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group. After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect. + */ + disassociateKmsKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call. + */ + filterLogEvents(params: CloudWatchLogs.Types.FilterLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.FilterLogEventsResponse) => void): Request; + /** + * Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call. + */ + filterLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.FilterLogEventsResponse) => void): Request; + /** + * Lists log events from the specified log stream. You can list all the log events or filter using a time range. By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. + */ + getLogEvents(params: CloudWatchLogs.Types.GetLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogEventsResponse) => void): Request; + /** + * Lists log events from the specified log stream. You can list all the log events or filter using a time range. By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. + */ + getLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogEventsResponse) => void): Request; + /** + * Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify. In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. The response results are sorted by the frequency percentage, starting with the highest percentage. + */ + getLogGroupFields(params: CloudWatchLogs.Types.GetLogGroupFieldsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogGroupFieldsResponse) => void): Request; + /** + * Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify. In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. The response results are sorted by the frequency percentage, starting with the highest percentage. + */ + getLogGroupFields(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogGroupFieldsResponse) => void): Request; + /** + * Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs. Additionally, the entire unparsed log event is returned within @message. + */ + getLogRecord(params: CloudWatchLogs.Types.GetLogRecordRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogRecordResponse) => void): Request; + /** + * Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs. Additionally, the entire unparsed log event is returned within @message. + */ + getLogRecord(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogRecordResponse) => void): Request; + /** + * Returns the results from the specified query. If the query is in progress, partial results of that current execution are returned. Only the fields requested in the query are returned. GetQueryResults does not start a query execution. To run a query, use . + */ + getQueryResults(params: CloudWatchLogs.Types.GetQueryResultsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetQueryResultsResponse) => void): Request; + /** + * Returns the results from the specified query. If the query is in progress, partial results of that current execution are returned. Only the fields requested in the query are returned. GetQueryResults does not start a query execution. To run a query, use . + */ + getQueryResults(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetQueryResultsResponse) => void): Request; + /** + * Lists the tags for the specified log group. + */ + listTagsLogGroup(params: CloudWatchLogs.Types.ListTagsLogGroupRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.ListTagsLogGroupResponse) => void): Request; + /** + * Lists the tags for the specified log group. + */ + listTagsLogGroup(callback?: (err: AWSError, data: CloudWatchLogs.Types.ListTagsLogGroupResponse) => void): Request; + /** + * Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination. Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination. + */ + putDestination(params: CloudWatchLogs.Types.PutDestinationRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDestinationResponse) => void): Request; + /** + * Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination. Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination. + */ + putDestination(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDestinationResponse) => void): Request; + /** + * Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination. + */ + putDestinationPolicy(params: CloudWatchLogs.Types.PutDestinationPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination. + */ + putDestinationPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Uploads a batch of log events to the specified log stream. You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected. The batch of events must satisfy the following constraints: The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. None of the log events in the batch can be more than 2 hours in the future. None of the log events in the batch can be older than 14 days or the retention period of the log group. The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) The maximum number of log events in a batch is 10,000. A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails. If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key. + */ + putLogEvents(params: CloudWatchLogs.Types.PutLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutLogEventsResponse) => void): Request; + /** + * Uploads a batch of log events to the specified log stream. You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected. The batch of events must satisfy the following constraints: The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. None of the log events in the batch can be more than 2 hours in the future. None of the log events in the batch can be older than 14 days or the retention period of the log group. The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) The maximum number of log events in a batch is 10,000. A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails. If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key. + */ + putLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutLogEventsResponse) => void): Request; + /** + * Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents. The maximum number of metric filters that can be associated with a log group is 100. + */ + putMetricFilter(params: CloudWatchLogs.Types.PutMetricFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents. The maximum number of metric filters that can be associated with a log group is 100. + */ + putMetricFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region. + */ + putResourcePolicy(params: CloudWatchLogs.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutResourcePolicyResponse) => void): Request; + /** + * Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region. + */ + putResourcePolicy(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutResourcePolicyResponse) => void): Request; + /** + * Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group. + */ + putRetentionPolicy(params: CloudWatchLogs.Types.PutRetentionPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group. + */ + putRetentionPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are: An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination that belongs to a different account, for cross-account delivery. An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery. There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. + */ + putSubscriptionFilter(params: CloudWatchLogs.Types.PutSubscriptionFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are: An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination that belongs to a different account, for cross-account delivery. An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery. There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. + */ + putSubscriptionFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query, and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax. + */ + startQuery(params: CloudWatchLogs.Types.StartQueryRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.StartQueryResponse) => void): Request; + /** + * Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query, and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax. + */ + startQuery(callback?: (err: AWSError, data: CloudWatchLogs.Types.StartQueryResponse) => void): Request; + /** + * Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running. + */ + stopQuery(params: CloudWatchLogs.Types.StopQueryRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.StopQueryResponse) => void): Request; + /** + * Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running. + */ + stopQuery(callback?: (err: AWSError, data: CloudWatchLogs.Types.StopQueryResponse) => void): Request; + /** + * Adds or updates the specified tags for the specified log group. To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup. For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide. + */ + tagLogGroup(params: CloudWatchLogs.Types.TagLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates the specified tags for the specified log group. To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup. For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide. + */ + tagLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. + */ + testMetricFilter(params: CloudWatchLogs.Types.TestMetricFilterRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.TestMetricFilterResponse) => void): Request; + /** + * Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. + */ + testMetricFilter(callback?: (err: AWSError, data: CloudWatchLogs.Types.TestMetricFilterResponse) => void): Request; + /** + * Removes the specified tags from the specified log group. To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup. + */ + untagLogGroup(params: CloudWatchLogs.Types.UntagLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from the specified log group. To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup. + */ + untagLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace CloudWatchLogs { + export type AccessPolicy = string; + export type Arn = string; + export interface AssociateKmsKeyRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS). + */ + kmsKeyId: KmsKeyId; + } + export interface CancelExportTaskRequest { + /** + * The ID of the export task. + */ + taskId: ExportTaskId; + } + export interface CreateExportTaskRequest { + /** + * The name of the export task. + */ + taskName?: ExportTaskName; + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied. + */ + logStreamNamePrefix?: LogStreamName; + /** + * The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported. + */ + from: Timestamp; + /** + * The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported. + */ + to: Timestamp; + /** + * The name of S3 bucket for the exported log data. The bucket must be in the same AWS region. + */ + destination: ExportDestinationBucket; + /** + * The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs. + */ + destinationPrefix?: ExportDestinationPrefix; + } + export interface CreateExportTaskResponse { + /** + * The ID of the export task. + */ + taskId?: ExportTaskId; + } + export interface CreateLogGroupRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS). + */ + kmsKeyId?: KmsKeyId; + /** + * The key-value pairs to use for the tags. + */ + tags?: Tags; + } + export interface CreateLogStreamRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The name of the log stream. + */ + logStreamName: LogStreamName; + } + export type Days = number; + export type DefaultValue = number; + export interface DeleteDestinationRequest { + /** + * The name of the destination. + */ + destinationName: DestinationName; + } + export interface DeleteLogGroupRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + } + export interface DeleteLogStreamRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The name of the log stream. + */ + logStreamName: LogStreamName; + } + export interface DeleteMetricFilterRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The name of the metric filter. + */ + filterName: FilterName; + } + export interface DeleteResourcePolicyRequest { + /** + * The name of the policy to be revoked. This parameter is required. + */ + policyName?: PolicyName; + } + export interface DeleteRetentionPolicyRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + } + export interface DeleteSubscriptionFilterRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The name of the subscription filter. + */ + filterName: FilterName; + } + export type Descending = boolean; + export interface DescribeDestinationsRequest { + /** + * The prefix to match. If you don't specify a value, no prefix filter is applied. + */ + DestinationNamePrefix?: DestinationName; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + */ + limit?: DescribeLimit; + } + export interface DescribeDestinationsResponse { + /** + * The destinations. + */ + destinations?: Destinations; + nextToken?: NextToken; + } + export interface DescribeExportTasksRequest { + /** + * The ID of the export task. Specifying a task ID filters the results to zero or one export tasks. + */ + taskId?: ExportTaskId; + /** + * The status code of the export task. Specifying a status code filters the results to zero or more export tasks. + */ + statusCode?: ExportTaskStatusCode; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + */ + limit?: DescribeLimit; + } + export interface DescribeExportTasksResponse { + /** + * The export tasks. + */ + exportTasks?: ExportTasks; + nextToken?: NextToken; + } + export type DescribeLimit = number; + export interface DescribeLogGroupsRequest { + /** + * The prefix to match. + */ + logGroupNamePrefix?: LogGroupName; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + */ + limit?: DescribeLimit; + } + export interface DescribeLogGroupsResponse { + /** + * The log groups. + */ + logGroups?: LogGroups; + nextToken?: NextToken; + } + export interface DescribeLogStreamsRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The prefix to match. If orderBy is LastEventTime,you cannot specify this parameter. + */ + logStreamNamePrefix?: LogStreamName; + /** + * If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName. If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations. + */ + orderBy?: OrderBy; + /** + * If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false. + */ + descending?: Descending; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + */ + limit?: DescribeLimit; + } + export interface DescribeLogStreamsResponse { + /** + * The log streams. + */ + logStreams?: LogStreams; + nextToken?: NextToken; + } + export interface DescribeMetricFiltersRequest { + /** + * The name of the log group. + */ + logGroupName?: LogGroupName; + /** + * The prefix to match. + */ + filterNamePrefix?: FilterName; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + */ + limit?: DescribeLimit; + /** + * Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter. + */ + metricName?: MetricName; + /** + * Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter. + */ + metricNamespace?: MetricNamespace; + } + export interface DescribeMetricFiltersResponse { + /** + * The metric filters. + */ + metricFilters?: MetricFilters; + nextToken?: NextToken; + } + export type DescribeQueriesMaxResults = number; + export interface DescribeQueriesRequest { + /** + * Limits the returned queries to only those for the specified log group. + */ + logGroupName?: LogGroupName; + /** + * Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled. + */ + status?: QueryStatus; + /** + * Limits the number of returned queries to the specified number. + */ + maxResults?: DescribeQueriesMaxResults; + nextToken?: NextToken; + } + export interface DescribeQueriesResponse { + /** + * The list of queries that match the request. + */ + queries?: QueryInfoList; + nextToken?: NextToken; + } + export interface DescribeResourcePoliciesRequest { + nextToken?: NextToken; + /** + * The maximum number of resource policies to be displayed with one call of this API. + */ + limit?: DescribeLimit; + } + export interface DescribeResourcePoliciesResponse { + /** + * The resource policies that exist in this account. + */ + resourcePolicies?: ResourcePolicies; + nextToken?: NextToken; + } + export interface DescribeSubscriptionFiltersRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The prefix to match. If you don't specify a value, no prefix filter is applied. + */ + filterNamePrefix?: FilterName; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + */ + limit?: DescribeLimit; + } + export interface DescribeSubscriptionFiltersResponse { + /** + * The subscription filters. + */ + subscriptionFilters?: SubscriptionFilters; + nextToken?: NextToken; + } + export interface Destination { + /** + * The name of the destination. + */ + destinationName?: DestinationName; + /** + * The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream). + */ + targetArn?: TargetArn; + /** + * A role for impersonation, used when delivering log events to the target. + */ + roleArn?: RoleArn; + /** + * An IAM policy document that governs which AWS accounts can create subscription filters against this destination. + */ + accessPolicy?: AccessPolicy; + /** + * The ARN of this destination. + */ + arn?: Arn; + /** + * The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + creationTime?: Timestamp; + } + export type DestinationArn = string; + export type DestinationName = string; + export type Destinations = Destination[]; + export interface DisassociateKmsKeyRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + } + export type Distribution = "Random"|"ByLogStream"|string; + export type EventId = string; + export type EventMessage = string; + export type EventNumber = number; + export type EventsLimit = number; + export type ExportDestinationBucket = string; + export type ExportDestinationPrefix = string; + export interface ExportTask { + /** + * The ID of the export task. + */ + taskId?: ExportTaskId; + /** + * The name of the export task. + */ + taskName?: ExportTaskName; + /** + * The name of the log group from which logs data was exported. + */ + logGroupName?: LogGroupName; + /** + * The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported. + */ + from?: Timestamp; + /** + * The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported. + */ + to?: Timestamp; + /** + * The name of Amazon S3 bucket to which the log data was exported. + */ + destination?: ExportDestinationBucket; + /** + * The prefix that was used as the start of Amazon S3 key for every object exported. + */ + destinationPrefix?: ExportDestinationPrefix; + /** + * The status of the export task. + */ + status?: ExportTaskStatus; + /** + * Execution info about the export task. + */ + executionInfo?: ExportTaskExecutionInfo; + } + export interface ExportTaskExecutionInfo { + /** + * The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + creationTime?: Timestamp; + /** + * The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + completionTime?: Timestamp; + } + export type ExportTaskId = string; + export type ExportTaskName = string; + export interface ExportTaskStatus { + /** + * The status code of the export task. + */ + code?: ExportTaskStatusCode; + /** + * The status message related to the status code. + */ + message?: ExportTaskStatusMessage; + } + export type ExportTaskStatusCode = "CANCELLED"|"COMPLETED"|"FAILED"|"PENDING"|"PENDING_CANCEL"|"RUNNING"|string; + export type ExportTaskStatusMessage = string; + export type ExportTasks = ExportTask[]; + export type ExtractedValues = {[key: string]: Value}; + export type Field = string; + export type FilterCount = number; + export interface FilterLogEventsRequest { + /** + * The name of the log group to search. + */ + logGroupName: LogGroupName; + /** + * Filters the results to only logs from the log streams in this list. If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error. + */ + logStreamNames?: InputLogStreamNames; + /** + * Filters the results to include only events from log streams that have names starting with this prefix. If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error. + */ + logStreamNamePrefix?: LogStreamName; + /** + * The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned. + */ + startTime?: Timestamp; + /** + * The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned. + */ + endTime?: Timestamp; + /** + * The filter pattern to use. For more information, see Filter and Pattern Syntax. If not provided, all the events are matched. + */ + filterPattern?: FilterPattern; + /** + * The token for the next set of events to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of events to return. The default is 10,000 events. + */ + limit?: EventsLimit; + /** + * If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false. + */ + interleaved?: Interleaved; + } + export interface FilterLogEventsResponse { + /** + * The matched events. + */ + events?: FilteredLogEvents; + /** + * Indicates which log streams have been searched and whether each has been searched completely. + */ + searchedLogStreams?: SearchedLogStreams; + /** + * The token to use when requesting the next set of items. The token expires after 24 hours. + */ + nextToken?: NextToken; + } + export type FilterName = string; + export type FilterPattern = string; + export interface FilteredLogEvent { + /** + * The name of the log stream to which this event belongs. + */ + logStreamName?: LogStreamName; + /** + * The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + timestamp?: Timestamp; + /** + * The data contained in the log event. + */ + message?: EventMessage; + /** + * The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + ingestionTime?: Timestamp; + /** + * The ID of the event. + */ + eventId?: EventId; + } + export type FilteredLogEvents = FilteredLogEvent[]; + export interface GetLogEventsRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The name of the log stream. + */ + logStreamName: LogStreamName; + /** + * The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included. + */ + startTime?: Timestamp; + /** + * The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included. + */ + endTime?: Timestamp; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + nextToken?: NextToken; + /** + * The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events. + */ + limit?: EventsLimit; + /** + * If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false. + */ + startFromHead?: StartFromHead; + } + export interface GetLogEventsResponse { + /** + * The events. + */ + events?: OutputLogEvents; + /** + * The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it will return the same token you passed in. + */ + nextForwardToken?: NextToken; + /** + * The token for the next set of items in the backward direction. The token expires after 24 hours. This token will never be null. If you have reached the end of the stream, it will return the same token you passed in. + */ + nextBackwardToken?: NextToken; + } + export interface GetLogGroupFieldsRequest { + /** + * The name of the log group to search. + */ + logGroupName: LogGroupName; + /** + * The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the past 15 minutes are queried. The time value is specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC. + */ + time?: Timestamp; + } + export interface GetLogGroupFieldsResponse { + /** + * The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried. + */ + logGroupFields?: LogGroupFieldList; + } + export interface GetLogRecordRequest { + /** + * The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record. + */ + logRecordPointer: LogRecordPointer; + } + export interface GetLogRecordResponse { + /** + * The requested log event, as a JSON string. + */ + logRecord?: LogRecord; + } + export interface GetQueryResultsRequest { + /** + * The ID number of the query. + */ + queryId: QueryId; + } + export interface GetQueryResultsResponse { + /** + * The log events that matched the query criteria during the most recent time it ran. The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs. + */ + results?: QueryResults; + /** + * Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. + */ + statistics?: QueryStatistics; + /** + * The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown. + */ + status?: QueryStatus; + } + export interface InputLogEvent { + /** + * The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + timestamp: Timestamp; + /** + * The raw event message. + */ + message: EventMessage; + } + export type InputLogEvents = InputLogEvent[]; + export type InputLogStreamNames = LogStreamName[]; + export type Interleaved = boolean; + export type KmsKeyId = string; + export interface ListTagsLogGroupRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + } + export interface ListTagsLogGroupResponse { + /** + * The tags for the log group. + */ + tags?: Tags; + } + export type LogEventIndex = number; + export interface LogGroup { + /** + * The name of the log group. + */ + logGroupName?: LogGroupName; + /** + * The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + creationTime?: Timestamp; + retentionInDays?: Days; + /** + * The number of metric filters. + */ + metricFilterCount?: FilterCount; + /** + * The Amazon Resource Name (ARN) of the log group. + */ + arn?: Arn; + /** + * The number of bytes stored. + */ + storedBytes?: StoredBytes; + /** + * The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. + */ + kmsKeyId?: KmsKeyId; + } + export interface LogGroupField { + /** + * The name of a log field. + */ + name?: Field; + /** + * The percentage of log events queried that contained the field. + */ + percent?: Percentage; + } + export type LogGroupFieldList = LogGroupField[]; + export type LogGroupName = string; + export type LogGroups = LogGroup[]; + export type LogRecord = {[key: string]: Value}; + export type LogRecordPointer = string; + export interface LogStream { + /** + * The name of the log stream. + */ + logStreamName?: LogStreamName; + /** + * The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + creationTime?: Timestamp; + /** + * The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + firstEventTimestamp?: Timestamp; + /** + * The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations. + */ + lastEventTimestamp?: Timestamp; + /** + * The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + lastIngestionTime?: Timestamp; + /** + * The sequence token. + */ + uploadSequenceToken?: SequenceToken; + /** + * The Amazon Resource Name (ARN) of the log stream. + */ + arn?: Arn; + /** + * The number of bytes stored. + */ + storedBytes?: StoredBytes; + } + export type LogStreamName = string; + export type LogStreamSearchedCompletely = boolean; + export type LogStreams = LogStream[]; + export interface MetricFilter { + /** + * The name of the metric filter. + */ + filterName?: FilterName; + filterPattern?: FilterPattern; + /** + * The metric transformations. + */ + metricTransformations?: MetricTransformations; + /** + * The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + creationTime?: Timestamp; + /** + * The name of the log group. + */ + logGroupName?: LogGroupName; + } + export interface MetricFilterMatchRecord { + /** + * The event number. + */ + eventNumber?: EventNumber; + /** + * The raw event data. + */ + eventMessage?: EventMessage; + /** + * The values extracted from the event data by the filter. + */ + extractedValues?: ExtractedValues; + } + export type MetricFilterMatches = MetricFilterMatchRecord[]; + export type MetricFilters = MetricFilter[]; + export type MetricName = string; + export type MetricNamespace = string; + export interface MetricTransformation { + /** + * The name of the CloudWatch metric. + */ + metricName: MetricName; + /** + * The namespace of the CloudWatch metric. + */ + metricNamespace: MetricNamespace; + /** + * The value to publish to the CloudWatch metric when a filter pattern matches a log event. + */ + metricValue: MetricValue; + /** + * (Optional) The value to emit when a filter pattern does not match a log event. This value can be null. + */ + defaultValue?: DefaultValue; + } + export type MetricTransformations = MetricTransformation[]; + export type MetricValue = string; + export type NextToken = string; + export type OrderBy = "LogStreamName"|"LastEventTime"|string; + export interface OutputLogEvent { + /** + * The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + timestamp?: Timestamp; + /** + * The data contained in the log event. + */ + message?: EventMessage; + /** + * The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + ingestionTime?: Timestamp; + } + export type OutputLogEvents = OutputLogEvent[]; + export type Percentage = number; + export type PolicyDocument = string; + export type PolicyName = string; + export interface PutDestinationPolicyRequest { + /** + * A name for an existing destination. + */ + destinationName: DestinationName; + /** + * An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. + */ + accessPolicy: AccessPolicy; + } + export interface PutDestinationRequest { + /** + * A name for the destination. + */ + destinationName: DestinationName; + /** + * The ARN of an Amazon Kinesis stream to which to deliver matching log events. + */ + targetArn: TargetArn; + /** + * The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream. + */ + roleArn: RoleArn; + } + export interface PutDestinationResponse { + /** + * The destination. + */ + destination?: Destination; + } + export interface PutLogEventsRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The name of the log stream. + */ + logStreamName: LogStreamName; + /** + * The log events. + */ + logEvents: InputLogEvents; + /** + * The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected. + */ + sequenceToken?: SequenceToken; + } + export interface PutLogEventsResponse { + /** + * The next sequence token. + */ + nextSequenceToken?: SequenceToken; + /** + * The rejected events. + */ + rejectedLogEventsInfo?: RejectedLogEventsInfo; + } + export interface PutMetricFilterRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * A name for the metric filter. + */ + filterName: FilterName; + /** + * A filter pattern for extracting metric data out of ingested log events. + */ + filterPattern: FilterPattern; + /** + * A collection of information that defines how metric data gets emitted. + */ + metricTransformations: MetricTransformations; + } + export interface PutResourcePolicyRequest { + /** + * Name of the new policy. This parameter is required. + */ + policyName?: PolicyName; + /** + * Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream. { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] } + */ + policyDocument?: PolicyDocument; + } + export interface PutResourcePolicyResponse { + /** + * The new policy. + */ + resourcePolicy?: ResourcePolicy; + } + export interface PutRetentionPolicyRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + retentionInDays: Days; + } + export interface PutSubscriptionFilterRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters. + */ + filterName: FilterName; + /** + * A filter pattern for subscribing to a filtered stream of log events. + */ + filterPattern: FilterPattern; + /** + * The ARN of the destination to deliver matching log events to. Currently, the supported destinations are: An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery. An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery. An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery. + */ + destinationArn: DestinationArn; + /** + * The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. + */ + roleArn?: RoleArn; + /** + * The method used to distribute log data to the destination. By default log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream. + */ + distribution?: Distribution; + } + export type QueryId = string; + export interface QueryInfo { + /** + * The unique ID number of this query. + */ + queryId?: QueryId; + /** + * The query string used in this query. + */ + queryString?: QueryString; + /** + * The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown. + */ + status?: QueryStatus; + /** + * The date and time that this query was created. + */ + createTime?: Timestamp; + /** + * The name of the log group scanned by this query. + */ + logGroupName?: LogGroupName; + } + export type QueryInfoList = QueryInfo[]; + export type QueryResults = ResultRows[]; + export interface QueryStatistics { + /** + * The number of log events that matched the query string. + */ + recordsMatched?: StatsValue; + /** + * The total number of log events scanned during the query. + */ + recordsScanned?: StatsValue; + /** + * The total number of bytes in the log events scanned during the query. + */ + bytesScanned?: StatsValue; + } + export type QueryStatus = "Scheduled"|"Running"|"Complete"|"Failed"|"Cancelled"|string; + export type QueryString = string; + export interface RejectedLogEventsInfo { + /** + * The log events that are too new. + */ + tooNewLogEventStartIndex?: LogEventIndex; + /** + * The log events that are too old. + */ + tooOldLogEventEndIndex?: LogEventIndex; + /** + * The expired log events. + */ + expiredLogEventEndIndex?: LogEventIndex; + } + export type ResourcePolicies = ResourcePolicy[]; + export interface ResourcePolicy { + /** + * The name of the resource policy. + */ + policyName?: PolicyName; + /** + * The details of the policy. + */ + policyDocument?: PolicyDocument; + /** + * Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + lastUpdatedTime?: Timestamp; + } + export interface ResultField { + /** + * The log event field. + */ + field?: Field; + /** + * The value of this field. + */ + value?: Value; + } + export type ResultRows = ResultField[]; + export type RoleArn = string; + export interface SearchedLogStream { + /** + * The name of the log stream. + */ + logStreamName?: LogStreamName; + /** + * Indicates whether all the events in this log stream were searched. + */ + searchedCompletely?: LogStreamSearchedCompletely; + } + export type SearchedLogStreams = SearchedLogStream[]; + export type SequenceToken = string; + export type StartFromHead = boolean; + export interface StartQueryRequest { + /** + * The log group on which to perform the query. + */ + logGroupName: LogGroupName; + /** + * The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC. + */ + startTime: Timestamp; + /** + * The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC. + */ + endTime: Timestamp; + /** + * The query string to use. For more information, see CloudWatch Logs Insights Query Syntax. + */ + queryString: QueryString; + /** + * The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. + */ + limit?: EventsLimit; + } + export interface StartQueryResponse { + /** + * The unique ID of the query. + */ + queryId?: QueryId; + } + export type StatsValue = number; + export interface StopQueryRequest { + /** + * The ID number of the query to stop. If necessary, you can use DescribeQueries to find this ID number. + */ + queryId: QueryId; + } + export interface StopQueryResponse { + /** + * This is true if the query was stopped by the StopQuery operation. + */ + success?: Success; + } + export type StoredBytes = number; + export interface SubscriptionFilter { + /** + * The name of the subscription filter. + */ + filterName?: FilterName; + /** + * The name of the log group. + */ + logGroupName?: LogGroupName; + filterPattern?: FilterPattern; + /** + * The Amazon Resource Name (ARN) of the destination. + */ + destinationArn?: DestinationArn; + /** + * + */ + roleArn?: RoleArn; + distribution?: Distribution; + /** + * The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + */ + creationTime?: Timestamp; + } + export type SubscriptionFilters = SubscriptionFilter[]; + export type Success = boolean; + export type TagKey = string; + export type TagList = TagKey[]; + export interface TagLogGroupRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The key-value pairs to use for the tags. + */ + tags: Tags; + } + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export type TargetArn = string; + export type TestEventMessages = EventMessage[]; + export interface TestMetricFilterRequest { + filterPattern: FilterPattern; + /** + * The log event messages to test. + */ + logEventMessages: TestEventMessages; + } + export interface TestMetricFilterResponse { + /** + * The matched events. + */ + matches?: MetricFilterMatches; + } + export type Timestamp = number; + export type Token = string; + export interface UntagLogGroupRequest { + /** + * The name of the log group. + */ + logGroupName: LogGroupName; + /** + * The tag keys. The corresponding tags are removed from the log group. + */ + tags: TagList; + } + export type Value = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-03-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CloudWatchLogs client. + */ + export import Types = CloudWatchLogs; +} +export = CloudWatchLogs; diff --git a/node_modules/aws-sdk/clients/cloudwatchlogs.js b/node_modules/aws-sdk/clients/cloudwatchlogs.js new file mode 100644 index 0000000..d79a8dd --- /dev/null +++ b/node_modules/aws-sdk/clients/cloudwatchlogs.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cloudwatchlogs'] = {}; +AWS.CloudWatchLogs = Service.defineService('cloudwatchlogs', ['2014-03-28']); +Object.defineProperty(apiLoader.services['cloudwatchlogs'], '2014-03-28', { + get: function get() { + var model = require('../apis/logs-2014-03-28.min.json'); + model.paginators = require('../apis/logs-2014-03-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CloudWatchLogs; diff --git a/node_modules/aws-sdk/clients/codebuild.d.ts b/node_modules/aws-sdk/clients/codebuild.d.ts new file mode 100644 index 0000000..23c3968 --- /dev/null +++ b/node_modules/aws-sdk/clients/codebuild.d.ts @@ -0,0 +1,1385 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CodeBuild extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CodeBuild.Types.ClientConfiguration) + config: Config & CodeBuild.Types.ClientConfiguration; + /** + * Deletes one or more builds. + */ + batchDeleteBuilds(params: CodeBuild.Types.BatchDeleteBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request; + /** + * Deletes one or more builds. + */ + batchDeleteBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request; + /** + * Gets information about builds. + */ + batchGetBuilds(params: CodeBuild.Types.BatchGetBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request; + /** + * Gets information about builds. + */ + batchGetBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request; + /** + * Gets information about build projects. + */ + batchGetProjects(params: CodeBuild.Types.BatchGetProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request; + /** + * Gets information about build projects. + */ + batchGetProjects(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request; + /** + * Creates a build project. + */ + createProject(params: CodeBuild.Types.CreateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request; + /** + * Creates a build project. + */ + createProject(callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request; + /** + * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings. + */ + createWebhook(params: CodeBuild.Types.CreateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request; + /** + * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings. + */ + createWebhook(callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request; + /** + * Deletes a build project. + */ + deleteProject(params: CodeBuild.Types.DeleteProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request; + /** + * Deletes a build project. + */ + deleteProject(callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request; + /** + * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. + */ + deleteSourceCredentials(params: CodeBuild.Types.DeleteSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request; + /** + * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. + */ + deleteSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request; + /** + * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository. + */ + deleteWebhook(params: CodeBuild.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request; + /** + * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository. + */ + deleteWebhook(callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request; + /** + * Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. + */ + importSourceCredentials(params: CodeBuild.Types.ImportSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request; + /** + * Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. + */ + importSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request; + /** + * Resets the cache for a project. + */ + invalidateProjectCache(params: CodeBuild.Types.InvalidateProjectCacheInput, callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request; + /** + * Resets the cache for a project. + */ + invalidateProjectCache(callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request; + /** + * Gets a list of build IDs, with each build ID representing a single build. + */ + listBuilds(params: CodeBuild.Types.ListBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request; + /** + * Gets a list of build IDs, with each build ID representing a single build. + */ + listBuilds(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request; + /** + * Gets a list of build IDs for the specified build project, with each build ID representing a single build. + */ + listBuildsForProject(params: CodeBuild.Types.ListBuildsForProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request; + /** + * Gets a list of build IDs for the specified build project, with each build ID representing a single build. + */ + listBuildsForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request; + /** + * Gets information about Docker images that are managed by AWS CodeBuild. + */ + listCuratedEnvironmentImages(params: CodeBuild.Types.ListCuratedEnvironmentImagesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request; + /** + * Gets information about Docker images that are managed by AWS CodeBuild. + */ + listCuratedEnvironmentImages(callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request; + /** + * Gets a list of build project names, with each build project name representing a single build project. + */ + listProjects(params: CodeBuild.Types.ListProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request; + /** + * Gets a list of build project names, with each build project name representing a single build project. + */ + listProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request; + /** + * Returns a list of SourceCredentialsInfo objects. + */ + listSourceCredentials(params: CodeBuild.Types.ListSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request; + /** + * Returns a list of SourceCredentialsInfo objects. + */ + listSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request; + /** + * Starts running a build. + */ + startBuild(params: CodeBuild.Types.StartBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request; + /** + * Starts running a build. + */ + startBuild(callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request; + /** + * Attempts to stop running a build. + */ + stopBuild(params: CodeBuild.Types.StopBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request; + /** + * Attempts to stop running a build. + */ + stopBuild(callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request; + /** + * Changes the settings of a build project. + */ + updateProject(params: CodeBuild.Types.UpdateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request; + /** + * Changes the settings of a build project. + */ + updateProject(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request; + /** + * Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored. + */ + updateWebhook(params: CodeBuild.Types.UpdateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request; + /** + * Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored. + */ + updateWebhook(callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request; +} +declare namespace CodeBuild { + export type ArtifactNamespace = "NONE"|"BUILD_ID"|string; + export type ArtifactPackaging = "NONE"|"ZIP"|string; + export type ArtifactsType = "CODEPIPELINE"|"S3"|"NO_ARTIFACTS"|string; + export type AuthType = "OAUTH"|"BASIC_AUTH"|"PERSONAL_ACCESS_TOKEN"|string; + export interface BatchDeleteBuildsInput { + /** + * The IDs of the builds to delete. + */ + ids: BuildIds; + } + export interface BatchDeleteBuildsOutput { + /** + * The IDs of the builds that were successfully deleted. + */ + buildsDeleted?: BuildIds; + /** + * Information about any builds that could not be successfully deleted. + */ + buildsNotDeleted?: BuildsNotDeleted; + } + export interface BatchGetBuildsInput { + /** + * The IDs of the builds. + */ + ids: BuildIds; + } + export interface BatchGetBuildsOutput { + /** + * Information about the requested builds. + */ + builds?: Builds; + /** + * The IDs of builds for which information could not be found. + */ + buildsNotFound?: BuildIds; + } + export interface BatchGetProjectsInput { + /** + * The names of the build projects. + */ + names: ProjectNames; + } + export interface BatchGetProjectsOutput { + /** + * Information about the requested build projects. + */ + projects?: Projects; + /** + * The names of build projects for which information could not be found. + */ + projectsNotFound?: ProjectNames; + } + export type Boolean = boolean; + export interface Build { + /** + * The unique ID for the build. + */ + id?: NonEmptyString; + /** + * The Amazon Resource Name (ARN) of the build. + */ + arn?: NonEmptyString; + /** + * When the build process started, expressed in Unix time format. + */ + startTime?: Timestamp; + /** + * When the build process ended, expressed in Unix time format. + */ + endTime?: Timestamp; + /** + * The current build phase. + */ + currentPhase?: String; + /** + * The current status of the build. Valid values include: FAILED: The build failed. FAULT: The build faulted. IN_PROGRESS: The build is still in progress. STOPPED: The build stopped. SUCCEEDED: The build succeeded. TIMED_OUT: The build timed out. + */ + buildStatus?: StatusType; + /** + * Any version identifier for the version of the source code to be built. + */ + sourceVersion?: NonEmptyString; + /** + * An identifier for the version of this build's source code. For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For AWS CodePipeline, the source revision provided by AWS CodePipeline. For Amazon Simple Storage Service (Amazon S3), this does not apply. + */ + resolvedSourceVersion?: NonEmptyString; + /** + * The name of the AWS CodeBuild project. + */ + projectName?: NonEmptyString; + /** + * Information about all previous build phases that are complete and information about any current build phase that is not yet complete. + */ + phases?: BuildPhases; + /** + * Information about the source code to be built. + */ + source?: ProjectSource; + /** + * An array of ProjectSource objects. + */ + secondarySources?: ProjectSources; + /** + * An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For AWS CodeCommit: the commit ID to use. 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 pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. 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 is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. + */ + secondarySourceVersions?: ProjectSecondarySourceVersions; + /** + * Information about the output artifacts for the build. + */ + artifacts?: BuildArtifacts; + /** + * An array of ProjectArtifacts objects. + */ + secondaryArtifacts?: BuildArtifactsList; + /** + * Information about the cache for the build. + */ + cache?: ProjectCache; + /** + * Information about the build environment for this build. + */ + environment?: ProjectEnvironment; + /** + * The name of a service role used for this build. + */ + serviceRole?: NonEmptyString; + /** + * Information about the build's logs in Amazon CloudWatch Logs. + */ + logs?: LogsLocation; + /** + * How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed. + */ + timeoutInMinutes?: WrapperInt; + /** + * The number of minutes a build is allowed to be queued before it times out. + */ + queuedTimeoutInMinutes?: WrapperInt; + /** + * Whether the build is complete. True if complete; otherwise, false. + */ + buildComplete?: Boolean; + /** + * The entity that started the build. Valid values include: If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example, MyUserName). If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin. + */ + initiator?: String; + /** + * If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID. + */ + vpcConfig?: VpcConfig; + /** + * Describes a network interface. + */ + networkInterface?: NetworkInterface; + /** + * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ). + */ + encryptionKey?: NonEmptyString; + } + export interface BuildArtifacts { + /** + * Information about the location of the build artifacts. + */ + location?: String; + /** + * The SHA-256 hash of the build artifact. You can use this hash along with a checksum tool to confirm file integrity and authenticity. This value is available only if the build project's packaging value is set to ZIP. + */ + sha256sum?: String; + /** + * The MD5 hash of the build artifact. You can use this hash along with a checksum tool to confirm file integrity and authenticity. This value is available only if the build project's packaging value is set to ZIP. + */ + md5sum?: String; + /** + * If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. + */ + overrideArtifactName?: WrapperBoolean; + /** + * Information that tells you if encryption for build artifacts is disabled. + */ + encryptionDisabled?: WrapperBoolean; + /** + * An identifier for this artifact definition. + */ + artifactIdentifier?: String; + } + export type BuildArtifactsList = BuildArtifacts[]; + export type BuildIds = NonEmptyString[]; + export interface BuildNotDeleted { + /** + * The ID of the build that could not be successfully deleted. + */ + id?: NonEmptyString; + /** + * Additional information about the build that could not be successfully deleted. + */ + statusCode?: String; + } + export interface BuildPhase { + /** + * The name of the build phase. Valid values include: BUILD: Core build activities typically occur in this build phase. COMPLETED: The build has been completed. DOWNLOAD_SOURCE: Source code is being downloaded in this build phase. FINALIZING: The build process is completing in this build phase. INSTALL: Installation activities typically occur in this build phase. POST_BUILD: Post-build activities typically occur in this build phase. PRE_BUILD: Pre-build activities typically occur in this build phase. PROVISIONING: The build environment is being set up. QUEUED: The build has been submitted and is queued behind other submitted builds. SUBMITTED: The build has been submitted. UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to the output location. + */ + phaseType?: BuildPhaseType; + /** + * The current status of the build phase. Valid values include: FAILED: The build phase failed. FAULT: The build phase faulted. IN_PROGRESS: The build phase is still in progress. QUEUED: The build has been submitted and is queued behind other submitted builds. STOPPED: The build phase stopped. SUCCEEDED: The build phase succeeded. TIMED_OUT: The build phase timed out. + */ + phaseStatus?: StatusType; + /** + * When the build phase started, expressed in Unix time format. + */ + startTime?: Timestamp; + /** + * When the build phase ended, expressed in Unix time format. + */ + endTime?: Timestamp; + /** + * How long, in seconds, between the starting and ending times of the build's phase. + */ + durationInSeconds?: WrapperLong; + /** + * Additional information about a build phase, especially to help troubleshoot a failed build. + */ + contexts?: PhaseContexts; + } + export type BuildPhaseType = "SUBMITTED"|"QUEUED"|"PROVISIONING"|"DOWNLOAD_SOURCE"|"INSTALL"|"PRE_BUILD"|"BUILD"|"POST_BUILD"|"UPLOAD_ARTIFACTS"|"FINALIZING"|"COMPLETED"|string; + export type BuildPhases = BuildPhase[]; + export type Builds = Build[]; + export type BuildsNotDeleted = BuildNotDeleted[]; + export type CacheMode = "LOCAL_DOCKER_LAYER_CACHE"|"LOCAL_SOURCE_CACHE"|"LOCAL_CUSTOM_CACHE"|string; + export type CacheType = "NO_CACHE"|"S3"|"LOCAL"|string; + export interface CloudWatchLogsConfig { + /** + * The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: ENABLED: Amazon CloudWatch Logs are enabled for this build project. DISABLED: Amazon CloudWatch Logs are not enabled for this build project. + */ + status: LogsConfigStatusType; + /** + * The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. + */ + groupName?: String; + /** + * The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams. + */ + streamName?: String; + } + export type ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|string; + export interface CreateProjectInput { + /** + * The name of the build project. + */ + name: ProjectName; + /** + * A description that makes the build project easy to identify. + */ + description?: ProjectDescription; + /** + * Information about the build input source code for the build project. + */ + source: ProjectSource; + /** + * An array of ProjectSource objects. + */ + secondarySources?: ProjectSources; + /** + * Information about the build output artifacts for the build project. + */ + artifacts: ProjectArtifacts; + /** + * An array of ProjectArtifacts objects. + */ + secondaryArtifacts?: ProjectArtifactsList; + /** + * Stores recently used information so that it can be quickly accessed at a later time. + */ + cache?: ProjectCache; + /** + * Information about the build environment for the build project. + */ + environment: ProjectEnvironment; + /** + * 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. + */ + serviceRole: NonEmptyString; + /** + * How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes. + */ + timeoutInMinutes?: TimeOut; + /** + * The number of minutes a build is allowed to be queued before it times out. + */ + queuedTimeoutInMinutes?: TimeOut; + /** + * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ). + */ + encryptionKey?: NonEmptyString; + /** + * A set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags. + */ + tags?: TagList; + /** + * VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC. + */ + vpcConfig?: VpcConfig; + /** + * Set this to true to generate a publicly accessible URL for your project's build badge. + */ + badgeEnabled?: WrapperBoolean; + /** + * Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both. + */ + logsConfig?: LogsConfig; + } + export interface CreateProjectOutput { + /** + * Information about the build project that was created. + */ + project?: Project; + } + export interface CreateWebhookInput { + /** + * The name of the AWS CodeBuild project. + */ + projectName: ProjectName; + /** + * A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built. It is recommended that you use filterGroups instead of branchFilter. + */ + branchFilter?: String; + /** + * An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type. For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass. + */ + filterGroups?: FilterGroups; + } + export interface CreateWebhookOutput { + /** + * Information about a webhook that connects repository events to a build project in AWS CodeBuild. + */ + webhook?: Webhook; + } + export type CredentialProviderType = "SECRETS_MANAGER"|string; + export interface DeleteProjectInput { + /** + * The name of the build project. + */ + name: NonEmptyString; + } + export interface DeleteProjectOutput { + } + export interface DeleteSourceCredentialsInput { + /** + * The Amazon Resource Name (ARN) of the token. + */ + arn: NonEmptyString; + } + export interface DeleteSourceCredentialsOutput { + /** + * The Amazon Resource Name (ARN) of the token. + */ + arn?: NonEmptyString; + } + export interface DeleteWebhookInput { + /** + * The name of the AWS CodeBuild project. + */ + projectName: ProjectName; + } + export interface DeleteWebhookOutput { + } + export interface EnvironmentImage { + /** + * The name of the Docker image. + */ + name?: String; + /** + * The description of the Docker image. + */ + description?: String; + /** + * A list of environment image versions. + */ + versions?: ImageVersions; + } + export type EnvironmentImages = EnvironmentImage[]; + export interface EnvironmentLanguage { + /** + * The programming language for the Docker images. + */ + language?: LanguageType; + /** + * The list of Docker images that are related by the specified programming language. + */ + images?: EnvironmentImages; + } + export type EnvironmentLanguages = EnvironmentLanguage[]; + export interface EnvironmentPlatform { + /** + * The platform's name. + */ + platform?: PlatformType; + /** + * The list of programming languages that are available for the specified platform. + */ + languages?: EnvironmentLanguages; + } + export type EnvironmentPlatforms = EnvironmentPlatform[]; + export type EnvironmentType = "WINDOWS_CONTAINER"|"LINUX_CONTAINER"|string; + export interface EnvironmentVariable { + /** + * The name or key of the environment variable. + */ + name: NonEmptyString; + /** + * The value of the environment variable. We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). + */ + value: String; + /** + * The type of environment variable. Valid values include: PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. PLAINTEXT: An environment variable in plaintext format. + */ + type?: EnvironmentVariableType; + } + export type EnvironmentVariableType = "PLAINTEXT"|"PARAMETER_STORE"|string; + export type EnvironmentVariables = EnvironmentVariable[]; + export type FilterGroup = WebhookFilter[]; + export type FilterGroups = FilterGroup[]; + export type GitCloneDepth = number; + export interface GitSubmodulesConfig { + /** + * Set to true to fetch Git submodules for your AWS CodeBuild build project. + */ + fetchSubmodules: WrapperBoolean; + } + export type ImagePullCredentialsType = "CODEBUILD"|"SERVICE_ROLE"|string; + export type ImageVersions = String[]; + export interface ImportSourceCredentialsInput { + /** + * The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. + */ + username?: NonEmptyString; + /** + * For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. + */ + token: SensitiveNonEmptyString; + /** + * The source provider used for this project. + */ + serverType: ServerType; + /** + * The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console. + */ + authType: AuthType; + } + export interface ImportSourceCredentialsOutput { + /** + * The Amazon Resource Name (ARN) of the token. + */ + arn?: NonEmptyString; + } + export interface InvalidateProjectCacheInput { + /** + * The name of the AWS CodeBuild build project that the cache is reset for. + */ + projectName: NonEmptyString; + } + export interface InvalidateProjectCacheOutput { + } + export type KeyInput = string; + export type LanguageType = "JAVA"|"PYTHON"|"NODE_JS"|"RUBY"|"GOLANG"|"DOCKER"|"ANDROID"|"DOTNET"|"BASE"|"PHP"|string; + export interface ListBuildsForProjectInput { + /** + * The name of the AWS CodeBuild project. + */ + projectName: NonEmptyString; + /** + * The order to list build IDs. Valid values include: ASCENDING: List the build IDs in ascending order by build ID. DESCENDING: List the build IDs in descending order by build ID. + */ + sortOrder?: SortOrderType; + /** + * 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 next token. 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. + */ + nextToken?: String; + } + export interface ListBuildsForProjectOutput { + /** + * A list of build IDs for the specified build project, with each build ID representing a single build. + */ + ids?: BuildIds; + /** + * If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. + */ + nextToken?: String; + } + export interface ListBuildsInput { + /** + * The order to list build IDs. Valid values include: ASCENDING: List the build IDs in ascending order by build ID. DESCENDING: List the build IDs in descending order by build ID. + */ + sortOrder?: SortOrderType; + /** + * 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 next token. 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. + */ + nextToken?: String; + } + export interface ListBuildsOutput { + /** + * A list of build IDs, with each build ID representing a single build. + */ + ids?: BuildIds; + /** + * If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. + */ + nextToken?: String; + } + export interface ListCuratedEnvironmentImagesInput { + } + export interface ListCuratedEnvironmentImagesOutput { + /** + * Information about supported platforms for Docker images that are managed by AWS CodeBuild. + */ + platforms?: EnvironmentPlatforms; + } + export interface ListProjectsInput { + /** + * The criterion to be used to list build project names. Valid values include: CREATED_TIME: List based on when each build project was created. LAST_MODIFIED_TIME: List based on when information about each build project was last changed. NAME: List based on each build project's name. Use sortOrder to specify in what order to list the build project names based on the preceding criteria. + */ + sortBy?: ProjectSortByType; + /** + * The order in which to list build projects. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order. Use sortBy to specify the criterion to be used to list build project names. + */ + sortOrder?: SortOrderType; + /** + * 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 next token. 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. + */ + nextToken?: NonEmptyString; + } + export interface ListProjectsOutput { + /** + * If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. + */ + nextToken?: String; + /** + * The list of build project names, with each build project name representing a single build project. + */ + projects?: ProjectNames; + } + export interface ListSourceCredentialsInput { + } + export interface ListSourceCredentialsOutput { + /** + * A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials. + */ + sourceCredentialsInfos?: SourceCredentialsInfos; + } + export interface LogsConfig { + /** + * Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default. + */ + cloudWatchLogs?: CloudWatchLogsConfig; + /** + * Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. + */ + s3Logs?: S3LogsConfig; + } + export type LogsConfigStatusType = "ENABLED"|"DISABLED"|string; + export interface LogsLocation { + /** + * The name of the Amazon CloudWatch Logs group for the build logs. + */ + groupName?: String; + /** + * The name of the Amazon CloudWatch Logs stream for the build logs. + */ + streamName?: String; + /** + * The URL to an individual build log in Amazon CloudWatch Logs. + */ + deepLink?: String; + /** + * The URL to a build log in an S3 bucket. + */ + s3DeepLink?: String; + /** + * Information about Amazon CloudWatch Logs for a build project. + */ + cloudWatchLogs?: CloudWatchLogsConfig; + /** + * Information about S3 logs for a build project. + */ + s3Logs?: S3LogsConfig; + } + export interface NetworkInterface { + /** + * The ID of the subnet. + */ + subnetId?: NonEmptyString; + /** + * The ID of the network interface. + */ + networkInterfaceId?: NonEmptyString; + } + export type NonEmptyString = string; + export interface PhaseContext { + /** + * The status code for the context of the build phase. + */ + statusCode?: String; + /** + * An explanation of the build phase's context. This might include a command ID and an exit code. + */ + message?: String; + } + export type PhaseContexts = PhaseContext[]; + export type PlatformType = "DEBIAN"|"AMAZON_LINUX"|"UBUNTU"|"WINDOWS_SERVER"|string; + export interface Project { + /** + * The name of the build project. + */ + name?: ProjectName; + /** + * The Amazon Resource Name (ARN) of the build project. + */ + arn?: String; + /** + * A description that makes the build project easy to identify. + */ + description?: ProjectDescription; + /** + * Information about the build input source code for this build project. + */ + source?: ProjectSource; + /** + * An array of ProjectSource objects. + */ + secondarySources?: ProjectSources; + /** + * Information about the build output artifacts for the build project. + */ + artifacts?: ProjectArtifacts; + /** + * An array of ProjectArtifacts objects. + */ + secondaryArtifacts?: ProjectArtifactsList; + /** + * Information about the cache for the build project. + */ + cache?: ProjectCache; + /** + * Information about the build environment for this build project. + */ + environment?: ProjectEnvironment; + /** + * 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. + */ + serviceRole?: NonEmptyString; + /** + * How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes. + */ + timeoutInMinutes?: TimeOut; + /** + * The number of minutes a build is allowed to be queued before it times out. + */ + queuedTimeoutInMinutes?: TimeOut; + /** + * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ). + */ + encryptionKey?: NonEmptyString; + /** + * The tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags. + */ + tags?: TagList; + /** + * When the build project was created, expressed in Unix time format. + */ + created?: Timestamp; + /** + * When the build project's settings were last modified, expressed in Unix time format. + */ + lastModified?: Timestamp; + /** + * Information about a webhook that connects repository events to a build project in AWS CodeBuild. + */ + webhook?: Webhook; + /** + * Information about the VPC configuration that AWS CodeBuild accesses. + */ + vpcConfig?: VpcConfig; + /** + * Information about the build badge for the build project. + */ + badge?: ProjectBadge; + /** + * Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both. + */ + logsConfig?: LogsConfig; + } + export interface ProjectArtifacts { + /** + * The type of build output artifact. Valid values include: CODEPIPELINE: The build project has build output generated through AWS CodePipeline. NO_ARTIFACTS: The build project does not produce any build output. S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3). + */ + type: ArtifactsType; + /** + * Information about the build output artifact location: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the name of the output bucket. + */ + location?: String; + /** + * Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used. For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip. + */ + path?: String; + /** + * Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, valid values include: BUILD_ID: Include the build ID in the location of the build output artifact. NONE: Do not include the build ID. This is the default if namespaceType is not specified. For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip. + */ + namespaceType?: ArtifactNamespace; + /** + * Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket. For example: If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip. If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket. If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/build-ID . + */ + name?: String; + /** + * The type of build output artifact to create: If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, valid values include: NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified. ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. + */ + packaging?: ArtifactPackaging; + /** + * If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. + */ + overrideArtifactName?: WrapperBoolean; + /** + * Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown. + */ + encryptionDisabled?: WrapperBoolean; + /** + * An identifier for this artifact definition. + */ + artifactIdentifier?: String; + } + export type ProjectArtifactsList = ProjectArtifacts[]; + export interface ProjectBadge { + /** + * Set this to true to generate a publicly accessible URL for your project's build badge. + */ + badgeEnabled?: Boolean; + /** + * The publicly-accessible URL through which you can access the build badge for your project. The publicly accessible URL through which you can access the build badge for your project. + */ + badgeRequestUrl?: String; + } + export interface ProjectCache { + /** + * The type of cache used by the build project. Valid values include: NO_CACHE: The build project does not use any cache. S3: The build project reads and writes from and to S3. LOCAL: The build project stores a cache locally on a build host that is only available to that build host. + */ + type: CacheType; + /** + * Information about the cache location: NO_CACHE or LOCAL: This value is ignored. S3: This is the S3 bucket name/prefix. + */ + location?: String; + /** + * If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time. LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. You can use a Docker layer cache in the Linux enviornment only. The privileged flag must be set so that your project has the required Docker permissions. You should consider the security implications before you use a Docker layer cache. LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: Only directories can be specified for caching. You cannot specify individual files. Symlinks are used to reference cached directories. Cached directories are linked to your build before it downloads its project sources. Cached items are overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. + */ + modes?: ProjectCacheModes; + } + export type ProjectCacheModes = CacheMode[]; + export type ProjectDescription = string; + export interface ProjectEnvironment { + /** + * The type of build environment to use for related builds. + */ + type: EnvironmentType; + /** + * The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats: For an image tag: registry/repository:tag. For example, to specify an image with the tag "latest," use registry/repository:latest. For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. + */ + image: NonEmptyString; + /** + * Information about the compute resources the build project uses. Available values include: BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds. BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds. BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds. + */ + computeType: ComputeType; + /** + * A set of environment variables to make available to builds for this build project. + */ + environmentVariables?: EnvironmentVariables; + /** + * 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 fail. 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 these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.) If the operating system's base image is Ubuntu Linux: - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout 15 sh -c "until docker info; do echo .; sleep 1; done" If the operating system's base image is Alpine Linux, add the -t argument to timeout: - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout 15 -t sh -c "until docker info; do echo .; sleep 1; done" + */ + privilegedMode?: WrapperBoolean; + /** + * The certificate to use with this build project. + */ + certificate?: String; + /** + * The credentials for access to a private registry. + */ + registryCredential?: RegistryCredential; + /** + * The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. + */ + imagePullCredentialsType?: ImagePullCredentialsType; + } + export type ProjectName = string; + export type ProjectNames = NonEmptyString[]; + export type ProjectSecondarySourceVersions = ProjectSourceVersion[]; + export type ProjectSortByType = "NAME"|"CREATED_TIME"|"LAST_MODIFIED_TIME"|string; + export interface ProjectSource { + /** + * The type of repository that contains the source code to be built. Valid values include: BITBUCKET: The source code is in a Bitbucket repository. CODECOMMIT: The source code is in an AWS CodeCommit repository. CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. GITHUB: The source code is in a GitHub repository. NO_SOURCE: The project does not have input source code. S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. + */ + type: SourceType; + /** + * Information about the location of the source code to be built. Valid values include: For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ). For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following. The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip). The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/). For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. + */ + location?: String; + /** + * Information about the Git clone depth for the build project. + */ + gitCloneDepth?: GitCloneDepth; + /** + * Information about the Git submodules configuration for the build project. + */ + gitSubmodulesConfig?: GitSubmodulesConfig; + /** + * The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built. + */ + buildspec?: String; + /** + * Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly. + */ + auth?: SourceAuth; + /** + * Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. + */ + reportBuildStatus?: WrapperBoolean; + /** + * Enable this flag to ignore SSL warnings while connecting to the project source code. + */ + insecureSsl?: WrapperBoolean; + /** + * An identifier for this project source. + */ + sourceIdentifier?: String; + } + export interface ProjectSourceVersion { + /** + * An identifier for a source in the build project. + */ + sourceIdentifier: String; + /** + * The source version for the corresponding source identifier. If specified, must be one of: For AWS CodeCommit: the commit ID to use. 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 pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. 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 is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. + */ + sourceVersion: String; + } + export type ProjectSources = ProjectSource[]; + export type Projects = Project[]; + export interface RegistryCredential { + /** + * The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The credential can use the name of the credentials only if they exist in your current region. + */ + credential: NonEmptyString; + /** + * The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. + */ + credentialProvider: CredentialProviderType; + } + export interface S3LogsConfig { + /** + * The current status of the S3 build logs. Valid values are: ENABLED: S3 build logs are enabled for this build project. DISABLED: S3 build logs are not enabled for this build project. + */ + status: LogsConfigStatusType; + /** + * The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. + */ + location?: String; + /** + * Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. + */ + encryptionDisabled?: WrapperBoolean; + } + export type SecurityGroupIds = NonEmptyString[]; + export type SensitiveNonEmptyString = string; + export type ServerType = "GITHUB"|"BITBUCKET"|"GITHUB_ENTERPRISE"|string; + export type SortOrderType = "ASCENDING"|"DESCENDING"|string; + export interface SourceAuth { + /** + * This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type. + */ + type: SourceAuthType; + /** + * The resource value that applies to the specified authorization type. + */ + resource?: String; + } + export type SourceAuthType = "OAUTH"|string; + export interface SourceCredentialsInfo { + /** + * The Amazon Resource Name (ARN) of the token. + */ + arn?: NonEmptyString; + /** + * The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. + */ + serverType?: ServerType; + /** + * The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN. + */ + authType?: AuthType; + } + export type SourceCredentialsInfos = SourceCredentialsInfo[]; + export type SourceType = "CODECOMMIT"|"CODEPIPELINE"|"GITHUB"|"S3"|"BITBUCKET"|"GITHUB_ENTERPRISE"|"NO_SOURCE"|string; + export interface StartBuildInput { + /** + * The name of the AWS CodeBuild build project to start running a build. + */ + projectName: NonEmptyString; + /** + * An array of ProjectSource objects. + */ + secondarySourcesOverride?: ProjectSources; + /** + * An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only. + */ + secondarySourcesVersionOverride?: ProjectSecondarySourceVersions; + /** + * A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of: For AWS CodeCommit: the commit ID to use. 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 pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. 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 is used. If not specified, the default branch's HEAD commit ID is used. For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. + */ + sourceVersion?: String; + /** + * Build output artifact settings that override, for this build only, the latest ones already defined in the build project. + */ + artifactsOverride?: ProjectArtifacts; + /** + * An array of ProjectArtifacts objects. + */ + secondaryArtifactsOverride?: ProjectArtifactsList; + /** + * A set of environment variables that overrides, for this build only, the latest ones already defined in the build project. + */ + environmentVariablesOverride?: EnvironmentVariables; + /** + * A source input type, for this build, that overrides the source input defined in the build project. + */ + sourceTypeOverride?: SourceType; + /** + * A location that overrides, for this build, the source location for the one defined in the build project. + */ + sourceLocationOverride?: String; + /** + * An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub. + */ + sourceAuthOverride?: SourceAuth; + /** + * The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project. + */ + gitCloneDepthOverride?: GitCloneDepth; + /** + * Information about the Git submodules configuration for this build of an AWS CodeBuild build project. + */ + gitSubmodulesConfigOverride?: GitSubmodulesConfig; + /** + * A build spec declaration that overrides, for this build only, the latest one already defined in the build project. + */ + buildspecOverride?: String; + /** + * Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise. + */ + insecureSslOverride?: WrapperBoolean; + /** + * Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. + */ + reportBuildStatusOverride?: WrapperBoolean; + /** + * A container type for this build that overrides the one specified in the build project. + */ + environmentTypeOverride?: EnvironmentType; + /** + * The name of an image for this build that overrides the one specified in the build project. + */ + imageOverride?: NonEmptyString; + /** + * The name of a compute type for this build that overrides the one specified in the build project. + */ + computeTypeOverride?: ComputeType; + /** + * The name of a certificate for this build that overrides the one specified in the build project. + */ + certificateOverride?: String; + /** + * A ProjectCache object specified for this build that overrides the one defined in the build project. + */ + cacheOverride?: ProjectCache; + /** + * The name of a service role for this build that overrides the one specified in the build project. + */ + serviceRoleOverride?: NonEmptyString; + /** + * Enable this flag to override privileged mode in the build project. + */ + privilegedModeOverride?: WrapperBoolean; + /** + * The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project. + */ + timeoutInMinutesOverride?: TimeOut; + /** + * The number of minutes a build is allowed to be queued before it times out. + */ + queuedTimeoutInMinutesOverride?: TimeOut; + /** + * A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error. + */ + idempotencyToken?: String; + /** + * Log settings for this build that override the log settings defined in the build project. + */ + logsConfigOverride?: LogsConfig; + /** + * The credentials for access to a private registry. + */ + registryCredentialOverride?: RegistryCredential; + /** + * The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials. + */ + imagePullCredentialsTypeOverride?: ImagePullCredentialsType; + } + export interface StartBuildOutput { + /** + * Information about the build to be run. + */ + build?: Build; + } + export type StatusType = "SUCCEEDED"|"FAILED"|"FAULT"|"TIMED_OUT"|"IN_PROGRESS"|"STOPPED"|string; + export interface StopBuildInput { + /** + * The ID of the build. + */ + id: NonEmptyString; + } + export interface StopBuildOutput { + /** + * Information about the build. + */ + build?: Build; + } + export type String = string; + export type Subnets = NonEmptyString[]; + export interface Tag { + /** + * The tag's key. + */ + key?: KeyInput; + /** + * The tag's value. + */ + value?: ValueInput; + } + export type TagList = Tag[]; + export type TimeOut = number; + export type Timestamp = Date; + export interface UpdateProjectInput { + /** + * The name of the build project. You cannot change a build project's name. + */ + name: NonEmptyString; + /** + * A new or replacement description of the build project. + */ + description?: ProjectDescription; + /** + * Information to be changed about the build input source code for the build project. + */ + source?: ProjectSource; + /** + * An array of ProjectSource objects. + */ + secondarySources?: ProjectSources; + /** + * Information to be changed about the build output artifacts for the build project. + */ + artifacts?: ProjectArtifacts; + /** + * An array of ProjectSource objects. + */ + secondaryArtifacts?: ProjectArtifactsList; + /** + * Stores recently used information so that it can be quickly accessed at a later time. + */ + cache?: ProjectCache; + /** + * Information to be changed about the build environment for the build project. + */ + environment?: ProjectEnvironment; + /** + * The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. + */ + serviceRole?: NonEmptyString; + /** + * The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. + */ + timeoutInMinutes?: TimeOut; + /** + * The number of minutes a build is allowed to be queued before it times out. + */ + queuedTimeoutInMinutes?: TimeOut; + /** + * The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ). + */ + encryptionKey?: NonEmptyString; + /** + * The replacement set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags. + */ + tags?: TagList; + /** + * VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC. + */ + vpcConfig?: VpcConfig; + /** + * Set this to true to generate a publicly accessible URL for your project's build badge. + */ + badgeEnabled?: WrapperBoolean; + /** + * Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both. + */ + logsConfig?: LogsConfig; + } + export interface UpdateProjectOutput { + /** + * Information about the build project that was changed. + */ + project?: Project; + } + export interface UpdateWebhookInput { + /** + * The name of the AWS CodeBuild project. + */ + projectName: ProjectName; + /** + * A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built. It is recommended that you use filterGroups instead of branchFilter. + */ + branchFilter?: String; + /** + * A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored. + */ + rotateSecret?: Boolean; + /** + * An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must pcontain at least one EVENT WebhookFilter. + */ + filterGroups?: FilterGroups; + } + export interface UpdateWebhookOutput { + /** + * Information about a repository's webhook that is associated with a project in AWS CodeBuild. + */ + webhook?: Webhook; + } + export type ValueInput = string; + export interface VpcConfig { + /** + * The ID of the Amazon VPC. + */ + vpcId?: NonEmptyString; + /** + * A list of one or more subnet IDs in your Amazon VPC. + */ + subnets?: Subnets; + /** + * A list of one or more security groups IDs in your Amazon VPC. + */ + securityGroupIds?: SecurityGroupIds; + } + export interface Webhook { + /** + * The URL to the webhook. + */ + url?: NonEmptyString; + /** + * The AWS CodeBuild endpoint where webhook events are sent. + */ + payloadUrl?: NonEmptyString; + /** + * The secret token of the associated repository. A Bitbucket webhook does not support secret. + */ + secret?: NonEmptyString; + /** + * A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built. It is recommended that you use filterGroups instead of branchFilter. + */ + branchFilter?: String; + /** + * An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type. For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass. + */ + filterGroups?: FilterGroups; + /** + * A timestamp that indicates the last time a repository's secret token was modified. + */ + lastModifiedSecret?: Timestamp; + } + export interface WebhookFilter { + /** + * The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH. EVENT A webhook event triggers a build when the provided pattern matches one of four event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and PULL_REQUEST_REOPENED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events. The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. ACTOR_ACCOUNT_ID A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern. HEAD_REF A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name. Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events. BASE_REF A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name. Works with pull request events only. FILE_PATH A webhook triggers a build when the path of a changed file matches the regular expression pattern. Works with GitHub and GitHub Enterprise push events only. + */ + type: WebhookFilterType; + /** + * For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build. For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name. + */ + pattern: String; + /** + * Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build. + */ + excludeMatchedPattern?: WrapperBoolean; + } + export type WebhookFilterType = "EVENT"|"BASE_REF"|"HEAD_REF"|"ACTOR_ACCOUNT_ID"|"FILE_PATH"|string; + export type WrapperBoolean = boolean; + export type WrapperInt = number; + export type WrapperLong = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-10-06"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CodeBuild client. + */ + export import Types = CodeBuild; +} +export = CodeBuild; diff --git a/node_modules/aws-sdk/clients/codebuild.js b/node_modules/aws-sdk/clients/codebuild.js new file mode 100644 index 0000000..e5f190d --- /dev/null +++ b/node_modules/aws-sdk/clients/codebuild.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['codebuild'] = {}; +AWS.CodeBuild = Service.defineService('codebuild', ['2016-10-06']); +Object.defineProperty(apiLoader.services['codebuild'], '2016-10-06', { + get: function get() { + var model = require('../apis/codebuild-2016-10-06.min.json'); + model.paginators = require('../apis/codebuild-2016-10-06.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CodeBuild; diff --git a/node_modules/aws-sdk/clients/codecommit.d.ts b/node_modules/aws-sdk/clients/codecommit.d.ts new file mode 100644 index 0000000..04fa092 --- /dev/null +++ b/node_modules/aws-sdk/clients/codecommit.d.ts @@ -0,0 +1,2013 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CodeCommit extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CodeCommit.Types.ClientConfiguration) + config: Config & CodeCommit.Types.ClientConfiguration; + /** + * Returns information about one or more repositories. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + */ + batchGetRepositories(params: CodeCommit.Types.BatchGetRepositoriesInput, callback?: (err: AWSError, data: CodeCommit.Types.BatchGetRepositoriesOutput) => void): Request; + /** + * Returns information about one or more repositories. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + */ + batchGetRepositories(callback?: (err: AWSError, data: CodeCommit.Types.BatchGetRepositoriesOutput) => void): Request; + /** + * Creates a new branch in a repository and points the branch to a commit. Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation. + */ + createBranch(params: CodeCommit.Types.CreateBranchInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new branch in a repository and points the branch to a commit. Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation. + */ + createBranch(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a commit for a repository on the tip of a specified branch. + */ + createCommit(params: CodeCommit.Types.CreateCommitInput, callback?: (err: AWSError, data: CodeCommit.Types.CreateCommitOutput) => void): Request; + /** + * Creates a commit for a repository on the tip of a specified branch. + */ + createCommit(callback?: (err: AWSError, data: CodeCommit.Types.CreateCommitOutput) => void): Request; + /** + * Creates a pull request in the specified repository. + */ + createPullRequest(params: CodeCommit.Types.CreatePullRequestInput, callback?: (err: AWSError, data: CodeCommit.Types.CreatePullRequestOutput) => void): Request; + /** + * Creates a pull request in the specified repository. + */ + createPullRequest(callback?: (err: AWSError, data: CodeCommit.Types.CreatePullRequestOutput) => void): Request; + /** + * Creates a new, empty repository. + */ + createRepository(params: CodeCommit.Types.CreateRepositoryInput, callback?: (err: AWSError, data: CodeCommit.Types.CreateRepositoryOutput) => void): Request; + /** + * Creates a new, empty repository. + */ + createRepository(callback?: (err: AWSError, data: CodeCommit.Types.CreateRepositoryOutput) => void): Request; + /** + * Deletes a branch from a repository, unless that branch is the default branch for the repository. + */ + deleteBranch(params: CodeCommit.Types.DeleteBranchInput, callback?: (err: AWSError, data: CodeCommit.Types.DeleteBranchOutput) => void): Request; + /** + * Deletes a branch from a repository, unless that branch is the default branch for the repository. + */ + deleteBranch(callback?: (err: AWSError, data: CodeCommit.Types.DeleteBranchOutput) => void): Request; + /** + * Deletes the content of a comment made on a change, file, or commit in a repository. + */ + deleteCommentContent(params: CodeCommit.Types.DeleteCommentContentInput, callback?: (err: AWSError, data: CodeCommit.Types.DeleteCommentContentOutput) => void): Request; + /** + * Deletes the content of a comment made on a change, file, or commit in a repository. + */ + deleteCommentContent(callback?: (err: AWSError, data: CodeCommit.Types.DeleteCommentContentOutput) => void): Request; + /** + * Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file will still exist in the commits prior to the commit that contains the deletion. + */ + deleteFile(params: CodeCommit.Types.DeleteFileInput, callback?: (err: AWSError, data: CodeCommit.Types.DeleteFileOutput) => void): Request; + /** + * Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file will still exist in the commits prior to the commit that contains the deletion. + */ + deleteFile(callback?: (err: AWSError, data: CodeCommit.Types.DeleteFileOutput) => void): Request; + /** + * Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail. + */ + deleteRepository(params: CodeCommit.Types.DeleteRepositoryInput, callback?: (err: AWSError, data: CodeCommit.Types.DeleteRepositoryOutput) => void): Request; + /** + * Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail. + */ + deleteRepository(callback?: (err: AWSError, data: CodeCommit.Types.DeleteRepositoryOutput) => void): Request; + /** + * Returns information about one or more pull request events. + */ + describePullRequestEvents(params: CodeCommit.Types.DescribePullRequestEventsInput, callback?: (err: AWSError, data: CodeCommit.Types.DescribePullRequestEventsOutput) => void): Request; + /** + * Returns information about one or more pull request events. + */ + describePullRequestEvents(callback?: (err: AWSError, data: CodeCommit.Types.DescribePullRequestEventsOutput) => void): Request; + /** + * Returns the base-64 encoded content of an individual blob within a repository. + */ + getBlob(params: CodeCommit.Types.GetBlobInput, callback?: (err: AWSError, data: CodeCommit.Types.GetBlobOutput) => void): Request; + /** + * Returns the base-64 encoded content of an individual blob within a repository. + */ + getBlob(callback?: (err: AWSError, data: CodeCommit.Types.GetBlobOutput) => void): Request; + /** + * Returns information about a repository branch, including its name and the last commit ID. + */ + getBranch(params: CodeCommit.Types.GetBranchInput, callback?: (err: AWSError, data: CodeCommit.Types.GetBranchOutput) => void): Request; + /** + * Returns information about a repository branch, including its name and the last commit ID. + */ + getBranch(callback?: (err: AWSError, data: CodeCommit.Types.GetBranchOutput) => void): Request; + /** + * Returns the content of a comment made on a change, file, or commit in a repository. + */ + getComment(params: CodeCommit.Types.GetCommentInput, callback?: (err: AWSError, data: CodeCommit.Types.GetCommentOutput) => void): Request; + /** + * Returns the content of a comment made on a change, file, or commit in a repository. + */ + getComment(callback?: (err: AWSError, data: CodeCommit.Types.GetCommentOutput) => void): Request; + /** + * Returns information about comments made on the comparison between two commits. + */ + getCommentsForComparedCommit(params: CodeCommit.Types.GetCommentsForComparedCommitInput, callback?: (err: AWSError, data: CodeCommit.Types.GetCommentsForComparedCommitOutput) => void): Request; + /** + * Returns information about comments made on the comparison between two commits. + */ + getCommentsForComparedCommit(callback?: (err: AWSError, data: CodeCommit.Types.GetCommentsForComparedCommitOutput) => void): Request; + /** + * Returns comments made on a pull request. + */ + getCommentsForPullRequest(params: CodeCommit.Types.GetCommentsForPullRequestInput, callback?: (err: AWSError, data: CodeCommit.Types.GetCommentsForPullRequestOutput) => void): Request; + /** + * Returns comments made on a pull request. + */ + getCommentsForPullRequest(callback?: (err: AWSError, data: CodeCommit.Types.GetCommentsForPullRequestOutput) => void): Request; + /** + * Returns information about a commit, including commit message and committer information. + */ + getCommit(params: CodeCommit.Types.GetCommitInput, callback?: (err: AWSError, data: CodeCommit.Types.GetCommitOutput) => void): Request; + /** + * Returns information about a commit, including commit message and committer information. + */ + getCommit(callback?: (err: AWSError, data: CodeCommit.Types.GetCommitOutput) => void): Request; + /** + * Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path. + */ + getDifferences(params: CodeCommit.Types.GetDifferencesInput, callback?: (err: AWSError, data: CodeCommit.Types.GetDifferencesOutput) => void): Request; + /** + * Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path. + */ + getDifferences(callback?: (err: AWSError, data: CodeCommit.Types.GetDifferencesOutput) => void): Request; + /** + * Returns the base-64 encoded contents of a specified file and its metadata. + */ + getFile(params: CodeCommit.Types.GetFileInput, callback?: (err: AWSError, data: CodeCommit.Types.GetFileOutput) => void): Request; + /** + * Returns the base-64 encoded contents of a specified file and its metadata. + */ + getFile(callback?: (err: AWSError, data: CodeCommit.Types.GetFileOutput) => void): Request; + /** + * Returns the contents of a specified folder in a repository. + */ + getFolder(params: CodeCommit.Types.GetFolderInput, callback?: (err: AWSError, data: CodeCommit.Types.GetFolderOutput) => void): Request; + /** + * Returns the contents of a specified folder in a repository. + */ + getFolder(callback?: (err: AWSError, data: CodeCommit.Types.GetFolderOutput) => void): Request; + /** + * Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository. + */ + getMergeConflicts(params: CodeCommit.Types.GetMergeConflictsInput, callback?: (err: AWSError, data: CodeCommit.Types.GetMergeConflictsOutput) => void): Request; + /** + * Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository. + */ + getMergeConflicts(callback?: (err: AWSError, data: CodeCommit.Types.GetMergeConflictsOutput) => void): Request; + /** + * Gets information about a pull request in a specified repository. + */ + getPullRequest(params: CodeCommit.Types.GetPullRequestInput, callback?: (err: AWSError, data: CodeCommit.Types.GetPullRequestOutput) => void): Request; + /** + * Gets information about a pull request in a specified repository. + */ + getPullRequest(callback?: (err: AWSError, data: CodeCommit.Types.GetPullRequestOutput) => void): Request; + /** + * Returns information about a repository. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + */ + getRepository(params: CodeCommit.Types.GetRepositoryInput, callback?: (err: AWSError, data: CodeCommit.Types.GetRepositoryOutput) => void): Request; + /** + * Returns information about a repository. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + */ + getRepository(callback?: (err: AWSError, data: CodeCommit.Types.GetRepositoryOutput) => void): Request; + /** + * Gets information about triggers configured for a repository. + */ + getRepositoryTriggers(params: CodeCommit.Types.GetRepositoryTriggersInput, callback?: (err: AWSError, data: CodeCommit.Types.GetRepositoryTriggersOutput) => void): Request; + /** + * Gets information about triggers configured for a repository. + */ + getRepositoryTriggers(callback?: (err: AWSError, data: CodeCommit.Types.GetRepositoryTriggersOutput) => void): Request; + /** + * Gets information about one or more branches in a repository. + */ + listBranches(params: CodeCommit.Types.ListBranchesInput, callback?: (err: AWSError, data: CodeCommit.Types.ListBranchesOutput) => void): Request; + /** + * Gets information about one or more branches in a repository. + */ + listBranches(callback?: (err: AWSError, data: CodeCommit.Types.ListBranchesOutput) => void): Request; + /** + * Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN. + */ + listPullRequests(params: CodeCommit.Types.ListPullRequestsInput, callback?: (err: AWSError, data: CodeCommit.Types.ListPullRequestsOutput) => void): Request; + /** + * Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN. + */ + listPullRequests(callback?: (err: AWSError, data: CodeCommit.Types.ListPullRequestsOutput) => void): Request; + /** + * Gets information about one or more repositories. + */ + listRepositories(params: CodeCommit.Types.ListRepositoriesInput, callback?: (err: AWSError, data: CodeCommit.Types.ListRepositoriesOutput) => void): Request; + /** + * Gets information about one or more repositories. + */ + listRepositories(callback?: (err: AWSError, data: CodeCommit.Types.ListRepositoriesOutput) => void): Request; + /** + * Closes a pull request and attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge option. + */ + mergePullRequestByFastForward(params: CodeCommit.Types.MergePullRequestByFastForwardInput, callback?: (err: AWSError, data: CodeCommit.Types.MergePullRequestByFastForwardOutput) => void): Request; + /** + * Closes a pull request and attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge option. + */ + mergePullRequestByFastForward(callback?: (err: AWSError, data: CodeCommit.Types.MergePullRequestByFastForwardOutput) => void): Request; + /** + * Posts a comment on the comparison between two commits. + */ + postCommentForComparedCommit(params: CodeCommit.Types.PostCommentForComparedCommitInput, callback?: (err: AWSError, data: CodeCommit.Types.PostCommentForComparedCommitOutput) => void): Request; + /** + * Posts a comment on the comparison between two commits. + */ + postCommentForComparedCommit(callback?: (err: AWSError, data: CodeCommit.Types.PostCommentForComparedCommitOutput) => void): Request; + /** + * Posts a comment on a pull request. + */ + postCommentForPullRequest(params: CodeCommit.Types.PostCommentForPullRequestInput, callback?: (err: AWSError, data: CodeCommit.Types.PostCommentForPullRequestOutput) => void): Request; + /** + * Posts a comment on a pull request. + */ + postCommentForPullRequest(callback?: (err: AWSError, data: CodeCommit.Types.PostCommentForPullRequestOutput) => void): Request; + /** + * Posts a comment in reply to an existing comment on a comparison between commits or a pull request. + */ + postCommentReply(params: CodeCommit.Types.PostCommentReplyInput, callback?: (err: AWSError, data: CodeCommit.Types.PostCommentReplyOutput) => void): Request; + /** + * Posts a comment in reply to an existing comment on a comparison between commits or a pull request. + */ + postCommentReply(callback?: (err: AWSError, data: CodeCommit.Types.PostCommentReplyOutput) => void): Request; + /** + * Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch. + */ + putFile(params: CodeCommit.Types.PutFileInput, callback?: (err: AWSError, data: CodeCommit.Types.PutFileOutput) => void): Request; + /** + * Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch. + */ + putFile(callback?: (err: AWSError, data: CodeCommit.Types.PutFileOutput) => void): Request; + /** + * Replaces all triggers for a repository. This can be used to create or delete triggers. + */ + putRepositoryTriggers(params: CodeCommit.Types.PutRepositoryTriggersInput, callback?: (err: AWSError, data: CodeCommit.Types.PutRepositoryTriggersOutput) => void): Request; + /** + * Replaces all triggers for a repository. This can be used to create or delete triggers. + */ + putRepositoryTriggers(callback?: (err: AWSError, data: CodeCommit.Types.PutRepositoryTriggersOutput) => void): Request; + /** + * Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated. + */ + testRepositoryTriggers(params: CodeCommit.Types.TestRepositoryTriggersInput, callback?: (err: AWSError, data: CodeCommit.Types.TestRepositoryTriggersOutput) => void): Request; + /** + * Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated. + */ + testRepositoryTriggers(callback?: (err: AWSError, data: CodeCommit.Types.TestRepositoryTriggersOutput) => void): Request; + /** + * Replaces the contents of a comment. + */ + updateComment(params: CodeCommit.Types.UpdateCommentInput, callback?: (err: AWSError, data: CodeCommit.Types.UpdateCommentOutput) => void): Request; + /** + * Replaces the contents of a comment. + */ + updateComment(callback?: (err: AWSError, data: CodeCommit.Types.UpdateCommentOutput) => void): Request; + /** + * Sets or changes the default branch name for the specified repository. If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change. + */ + updateDefaultBranch(params: CodeCommit.Types.UpdateDefaultBranchInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets or changes the default branch name for the specified repository. If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change. + */ + updateDefaultBranch(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces the contents of the description of a pull request. + */ + updatePullRequestDescription(params: CodeCommit.Types.UpdatePullRequestDescriptionInput, callback?: (err: AWSError, data: CodeCommit.Types.UpdatePullRequestDescriptionOutput) => void): Request; + /** + * Replaces the contents of the description of a pull request. + */ + updatePullRequestDescription(callback?: (err: AWSError, data: CodeCommit.Types.UpdatePullRequestDescriptionOutput) => void): Request; + /** + * Updates the status of a pull request. + */ + updatePullRequestStatus(params: CodeCommit.Types.UpdatePullRequestStatusInput, callback?: (err: AWSError, data: CodeCommit.Types.UpdatePullRequestStatusOutput) => void): Request; + /** + * Updates the status of a pull request. + */ + updatePullRequestStatus(callback?: (err: AWSError, data: CodeCommit.Types.UpdatePullRequestStatusOutput) => void): Request; + /** + * Replaces the title of a pull request. + */ + updatePullRequestTitle(params: CodeCommit.Types.UpdatePullRequestTitleInput, callback?: (err: AWSError, data: CodeCommit.Types.UpdatePullRequestTitleOutput) => void): Request; + /** + * Replaces the title of a pull request. + */ + updatePullRequestTitle(callback?: (err: AWSError, data: CodeCommit.Types.UpdatePullRequestTitleOutput) => void): Request; + /** + * Sets or changes the comment or description for a repository. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + */ + updateRepositoryDescription(params: CodeCommit.Types.UpdateRepositoryDescriptionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets or changes the comment or description for a repository. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + */ + updateRepositoryDescription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix ".git" is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide. + */ + updateRepositoryName(params: CodeCommit.Types.UpdateRepositoryNameInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix ".git" is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide. + */ + updateRepositoryName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace CodeCommit { + export type AccountId = string; + export type AdditionalData = string; + export type Arn = string; + export interface BatchGetRepositoriesInput { + /** + * The names of the repositories to get information about. + */ + repositoryNames: RepositoryNameList; + } + export interface BatchGetRepositoriesOutput { + /** + * A list of repositories returned by the batch get repositories operation. + */ + repositories?: RepositoryMetadataList; + /** + * Returns a list of repository names for which information could not be found. + */ + repositoriesNotFound?: RepositoryNotFoundList; + } + export interface BlobMetadata { + /** + * The full ID of the blob. + */ + blobId?: ObjectId; + /** + * The path to the blob and any associated file name, if any. + */ + path?: Path; + /** + * The file mode permissions of the blob. File mode permission codes include: 100644 indicates read/write 100755 indicates read/write/execute 160000 indicates a submodule 120000 indicates a symlink + */ + mode?: Mode; + } + export interface BranchInfo { + /** + * The name of the branch. + */ + branchName?: BranchName; + /** + * The ID of the last commit made to the branch. + */ + commitId?: CommitId; + } + export type BranchName = string; + export type BranchNameList = BranchName[]; + export type ChangeTypeEnum = "A"|"M"|"D"|string; + export type ClientRequestToken = string; + export type CloneUrlHttp = string; + export type CloneUrlSsh = string; + export interface Comment { + /** + * The system-generated comment ID. + */ + commentId?: CommentId; + /** + * The content of the comment. + */ + content?: Content; + /** + * The ID of the comment for which this comment is a reply, if any. + */ + inReplyTo?: CommentId; + /** + * The date and time the comment was created, in timestamp format. + */ + creationDate?: CreationDate; + /** + * The date and time the comment was most recently modified, in timestamp format. + */ + lastModifiedDate?: LastModifiedDate; + /** + * The Amazon Resource Name (ARN) of the person who posted the comment. + */ + authorArn?: Arn; + /** + * A Boolean value indicating whether the comment has been deleted. + */ + deleted?: IsCommentDeleted; + /** + * A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token. + */ + clientRequestToken?: ClientRequestToken; + } + export type CommentId = string; + export type Comments = Comment[]; + export interface CommentsForComparedCommit { + /** + * The name of the repository that contains the compared commits. + */ + repositoryName?: RepositoryName; + /** + * The full commit ID of the commit used to establish the 'before' of the comparison. + */ + beforeCommitId?: CommitId; + /** + * The full commit ID of the commit used to establish the 'after' of the comparison. + */ + afterCommitId?: CommitId; + /** + * The full blob ID of the commit used to establish the 'before' of the comparison. + */ + beforeBlobId?: ObjectId; + /** + * The full blob ID of the commit used to establish the 'after' of the comparison. + */ + afterBlobId?: ObjectId; + /** + * Location information about the comment on the comparison, including the file name, line number, and whether the version of the file where the comment was made is 'BEFORE' or 'AFTER'. + */ + location?: Location; + /** + * An array of comment objects. Each comment object contains information about a comment on the comparison between commits. + */ + comments?: Comments; + } + export type CommentsForComparedCommitData = CommentsForComparedCommit[]; + export interface CommentsForPullRequest { + /** + * The system-generated ID of the pull request. + */ + pullRequestId?: PullRequestId; + /** + * The name of the repository that contains the pull request. + */ + repositoryName?: RepositoryName; + /** + * The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit will be superceded by the after commit in the source branch when and if you merge the source branch into the destination branch. + */ + beforeCommitId?: CommitId; + /** + * he full commit ID of the commit that was the tip of the source branch at the time the comment was made. + */ + afterCommitId?: CommitId; + /** + * The full blob ID of the file on which you want to comment on the destination commit. + */ + beforeBlobId?: ObjectId; + /** + * The full blob ID of the file on which you want to comment on the source commit. + */ + afterBlobId?: ObjectId; + /** + * Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is 'BEFORE' (destination branch) or 'AFTER' (source branch). + */ + location?: Location; + /** + * An array of comment objects. Each comment object contains information about a comment on the pull request. + */ + comments?: Comments; + } + export type CommentsForPullRequestData = CommentsForPullRequest[]; + export interface Commit { + /** + * The full SHA of the specified commit. + */ + commitId?: ObjectId; + /** + * Tree information for the specified commit. + */ + treeId?: ObjectId; + /** + * A list of parent commits for the specified commit. Each parent commit ID is the full commit ID. + */ + parents?: ParentList; + /** + * The commit message associated with the specified commit. + */ + message?: Message; + /** + * Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git. + */ + author?: UserInfo; + /** + * Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git. For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub. + */ + committer?: UserInfo; + /** + * Any additional data associated with the specified commit. + */ + additionalData?: AdditionalData; + } + export type CommitId = string; + export type CommitName = string; + export type Content = string; + export interface CreateBranchInput { + /** + * The name of the repository in which you want to create the new branch. + */ + repositoryName: RepositoryName; + /** + * The name of the new branch to create. + */ + branchName: BranchName; + /** + * The ID of the commit to point the new branch to. + */ + commitId: CommitId; + } + export interface CreateCommitInput { + /** + * The name of the repository where you will create the commit. + */ + repositoryName: RepositoryName; + /** + * The name of the branch where you will create the commit. + */ + branchName: BranchName; + /** + * The ID of the commit that is the parent of the commit you will create. If this is an empty repository, this is not required. + */ + parentCommitId?: CommitId; + /** + * The name of the author who created the commit. This information will be used as both the author and committer for the commit. + */ + authorName?: Name; + /** + * The email address of the person who created the commit. + */ + email?: Email; + /** + * The commit message you want to include as part of creating the commit. Commit messages are limited to 256 KB. If no message is specified, a default message will be used. + */ + commitMessage?: Message; + /** + * If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. + */ + keepEmptyFolders?: KeepEmptyFolders; + /** + * The files to add or update in this commit. + */ + putFiles?: PutFileEntries; + /** + * The files to delete in this commit. These files will still exist in prior commits. + */ + deleteFiles?: DeleteFileEntries; + /** + * The file modes to update for files in this commit. + */ + setFileModes?: SetFileModeEntries; + } + export interface CreateCommitOutput { + /** + * The full commit ID of the commit that contains your committed file changes. + */ + commitId?: ObjectId; + /** + * The full SHA-1 pointer of the tree information for the commit that contains the commited file changes. + */ + treeId?: ObjectId; + /** + * The files added as part of the committed file changes. + */ + filesAdded?: FilesMetadata; + /** + * The files updated as part of the commited file changes. + */ + filesUpdated?: FilesMetadata; + /** + * The files deleted as part of the committed file changes. + */ + filesDeleted?: FilesMetadata; + } + export interface CreatePullRequestInput { + /** + * The title of the pull request. This title will be used to identify the pull request to other users in the repository. + */ + title: Title; + /** + * A description of the pull request. + */ + description?: Description; + /** + * The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch). + */ + targets: TargetList; + /** + * A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token. The AWS SDKs prepopulate client request tokens. If using an AWS SDK, you do not have to generate an idempotency token, as this will be done for you. + */ + clientRequestToken?: ClientRequestToken; + } + export interface CreatePullRequestOutput { + /** + * Information about the newly created pull request. + */ + pullRequest: PullRequest; + } + export interface CreateRepositoryInput { + /** + * The name of the new repository to be created. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide. The suffix ".git" is prohibited. + */ + repositoryName: RepositoryName; + /** + * A comment or description about the new repository. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. + */ + repositoryDescription?: RepositoryDescription; + } + export interface CreateRepositoryOutput { + /** + * Information about the newly created repository. + */ + repositoryMetadata?: RepositoryMetadata; + } + export type CreationDate = Date; + export type _Date = string; + export interface DeleteBranchInput { + /** + * The name of the repository that contains the branch to be deleted. + */ + repositoryName: RepositoryName; + /** + * The name of the branch to delete. + */ + branchName: BranchName; + } + export interface DeleteBranchOutput { + /** + * Information about the branch deleted by the operation, including the branch name and the commit ID that was the tip of the branch. + */ + deletedBranch?: BranchInfo; + } + export interface DeleteCommentContentInput { + /** + * The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. + */ + commentId: CommentId; + } + export interface DeleteCommentContentOutput { + /** + * Information about the comment you just deleted. + */ + comment?: Comment; + } + export type DeleteFileEntries = DeleteFileEntry[]; + export interface DeleteFileEntry { + /** + * The full path of the file that will be deleted, including the name of the file. + */ + filePath: Path; + } + export interface DeleteFileInput { + /** + * The name of the repository that contains the file to delete. + */ + repositoryName: RepositoryName; + /** + * The name of the branch where the commit will be made deleting the file. + */ + branchName: BranchName; + /** + * The fully-qualified path to the file that will be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples. + */ + filePath: Path; + /** + * The ID of the commit that is the tip of the branch where you want to create the commit that will delete the file. This must be the HEAD commit for the branch. The commit that deletes the file will be created from this commit ID. + */ + parentCommitId: CommitId; + /** + * Specifies whether to delete the folder or directory that contains the file you want to delete if that file is the only object in the folder or directory. By default, empty folders will be deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 will also delete the empty folders dir4, dir3, and dir2. + */ + keepEmptyFolders?: KeepEmptyFolders; + /** + * The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message will be used. + */ + commitMessage?: Message; + /** + * The name of the author of the commit that deletes the file. If no name is specified, the user's ARN will be used as the author name and committer name. + */ + name?: Name; + /** + * The email address for the commit that deletes the file. If no email address is specified, the email address will be left blank. + */ + email?: Email; + } + export interface DeleteFileOutput { + /** + * The full commit ID of the commit that contains the change that deletes the file. + */ + commitId: ObjectId; + /** + * The blob ID removed from the tree as part of deleting the file. + */ + blobId: ObjectId; + /** + * The full SHA-1 pointer of the tree information for the commit that contains the delete file change. + */ + treeId: ObjectId; + /** + * The fully-qualified path to the file that will be deleted, including the full name and extension of that file. + */ + filePath: Path; + } + export interface DeleteRepositoryInput { + /** + * The name of the repository to delete. + */ + repositoryName: RepositoryName; + } + export interface DeleteRepositoryOutput { + /** + * The ID of the repository that was deleted. + */ + repositoryId?: RepositoryId; + } + export interface DescribePullRequestEventsInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + /** + * Optional. The pull request event type about which you want to return information. + */ + pullRequestEventType?: PullRequestEventType; + /** + * The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request. + */ + actorArn?: Arn; + /** + * An enumeration token that when provided in a request, returns the next batch of the results. + */ + nextToken?: NextToken; + /** + * A non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result. + */ + maxResults?: MaxResults; + } + export interface DescribePullRequestEventsOutput { + /** + * Information about the pull request events. + */ + pullRequestEvents: PullRequestEventList; + /** + * An enumeration token that can be used in a request to return the next batch of the results. + */ + nextToken?: NextToken; + } + export type Description = string; + export interface Difference { + /** + * Information about a beforeBlob data type object, including the ID, the file mode permission code, and the path. + */ + beforeBlob?: BlobMetadata; + /** + * Information about an afterBlob data type object, including the ID, the file mode permission code, and the path. + */ + afterBlob?: BlobMetadata; + /** + * Whether the change type of the difference is an addition (A), deletion (D), or modification (M). + */ + changeType?: ChangeTypeEnum; + } + export type DifferenceList = Difference[]; + export type Email = string; + export type EventDate = Date; + export interface File { + /** + * The blob ID that contains the file information. + */ + blobId?: ObjectId; + /** + * The fully-qualified path to the file in the repository. + */ + absolutePath?: Path; + /** + * The relative path of the file from the folder where the query originated. + */ + relativePath?: Path; + /** + * The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL. + */ + fileMode?: FileModeTypeEnum; + } + export type FileContent = Buffer|Uint8Array|Blob|string; + export type FileList = File[]; + export interface FileMetadata { + /** + * The full path to the file that will be added or updated, including the name of the file. + */ + absolutePath?: Path; + /** + * The blob ID that contains the file information. + */ + blobId?: ObjectId; + /** + * The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL. + */ + fileMode?: FileModeTypeEnum; + } + export type FileModeTypeEnum = "EXECUTABLE"|"NORMAL"|"SYMLINK"|string; + export type FilesMetadata = FileMetadata[]; + export interface Folder { + /** + * The full SHA-1 pointer of the tree information for the commit that contains the folder. + */ + treeId?: ObjectId; + /** + * The fully-qualified path of the folder in the repository. + */ + absolutePath?: Path; + /** + * The relative path of the specified folder from the folder where the query originated. + */ + relativePath?: Path; + } + export type FolderList = Folder[]; + export interface GetBlobInput { + /** + * The name of the repository that contains the blob. + */ + repositoryName: RepositoryName; + /** + * The ID of the blob, which is its SHA-1 pointer. + */ + blobId: ObjectId; + } + export interface GetBlobOutput { + /** + * The content of the blob, usually a file. + */ + content: blob; + } + export interface GetBranchInput { + /** + * The name of the repository that contains the branch for which you want to retrieve information. + */ + repositoryName?: RepositoryName; + /** + * The name of the branch for which you want to retrieve information. + */ + branchName?: BranchName; + } + export interface GetBranchOutput { + /** + * The name of the branch. + */ + branch?: BranchInfo; + } + export interface GetCommentInput { + /** + * The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. + */ + commentId: CommentId; + } + export interface GetCommentOutput { + /** + * The contents of the comment. + */ + comment?: Comment; + } + export interface GetCommentsForComparedCommitInput { + /** + * The name of the repository where you want to compare commits. + */ + repositoryName: RepositoryName; + /** + * To establish the directionality of the comparison, the full commit ID of the 'before' commit. + */ + beforeCommitId?: CommitId; + /** + * To establish the directionality of the comparison, the full commit ID of the 'after' commit. + */ + afterCommitId: CommitId; + /** + * An enumeration token that when provided in a request, returns the next batch of the results. + */ + nextToken?: NextToken; + /** + * A non-negative integer used to limit the number of returned results. The default is 100 comments, and is configurable up to 500. + */ + maxResults?: MaxResults; + } + export interface GetCommentsForComparedCommitOutput { + /** + * A list of comment objects on the compared commit. + */ + commentsForComparedCommitData?: CommentsForComparedCommitData; + /** + * An enumeration token that can be used in a request to return the next batch of the results. + */ + nextToken?: NextToken; + } + export interface GetCommentsForPullRequestInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + /** + * The name of the repository that contains the pull request. + */ + repositoryName?: RepositoryName; + /** + * The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created. + */ + beforeCommitId?: CommitId; + /** + * The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made. + */ + afterCommitId?: CommitId; + /** + * An enumeration token that when provided in a request, returns the next batch of the results. + */ + nextToken?: NextToken; + /** + * A non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request. + */ + maxResults?: MaxResults; + } + export interface GetCommentsForPullRequestOutput { + /** + * An array of comment objects on the pull request. + */ + commentsForPullRequestData?: CommentsForPullRequestData; + /** + * An enumeration token that can be used in a request to return the next batch of the results. + */ + nextToken?: NextToken; + } + export interface GetCommitInput { + /** + * The name of the repository to which the commit was made. + */ + repositoryName: RepositoryName; + /** + * The commit ID. Commit IDs are the full SHA of the commit. + */ + commitId: ObjectId; + } + export interface GetCommitOutput { + /** + * A commit data type object that contains information about the specified commit. + */ + commit: Commit; + } + export interface GetDifferencesInput { + /** + * The name of the repository where you want to get differences. + */ + repositoryName: RepositoryName; + /** + * The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, the full commit ID. Optional. If not specified, all changes prior to the afterCommitSpecifier value will be shown. If you do not use beforeCommitSpecifier in your request, consider limiting the results with maxResults. + */ + beforeCommitSpecifier?: CommitName; + /** + * The branch, tag, HEAD, or other fully qualified reference used to identify a commit. + */ + afterCommitSpecifier: CommitName; + /** + * The file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. If beforePath and afterPath are not specified, differences will be shown for all paths. + */ + beforePath?: Path; + /** + * The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences will be shown for all paths. + */ + afterPath?: Path; + /** + * A non-negative integer used to limit the number of returned results. + */ + MaxResults?: Limit; + /** + * An enumeration token that when provided in a request, returns the next batch of the results. + */ + NextToken?: NextToken; + } + export interface GetDifferencesOutput { + /** + * A differences data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M). + */ + differences?: DifferenceList; + /** + * An enumeration token that can be used in a request to return the next batch of the results. + */ + NextToken?: NextToken; + } + export interface GetFileInput { + /** + * The name of the repository that contains the file. + */ + repositoryName: RepositoryName; + /** + * The fully-quaified reference that identifies the commit that contains the file. For example, you could specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/master. If none is provided, then the head commit will be used. + */ + commitSpecifier?: CommitName; + /** + * The fully-qualified path to the file, including the full name and extension of the file. For example, /examples/file.md is the fully-qualified path to a file named file.md in a folder named examples. + */ + filePath: Path; + } + export interface GetFileOutput { + /** + * The full commit ID of the commit that contains the content returned by GetFile. + */ + commitId: ObjectId; + /** + * The blob ID of the object that represents the file content. + */ + blobId: ObjectId; + /** + * The fully qualified path to the specified file. This returns the name and extension of the file. + */ + filePath: Path; + /** + * The extrapolated file mode permissions of the blob. Valid values include strings such as EXECUTABLE and not numeric values. The file mode permissions returned by this API are not the standard file mode permission values, such as 100644, but rather extrapolated values. See below for a full list of supported return values. + */ + fileMode: FileModeTypeEnum; + /** + * The size of the contents of the file, in bytes. + */ + fileSize: ObjectSize; + /** + * The base-64 encoded binary data object that represents the content of the file. + */ + fileContent: FileContent; + } + export interface GetFolderInput { + /** + * The name of the repository. + */ + repositoryName: RepositoryName; + /** + * A fully-qualified reference used to identify a commit that contains the version of the folder's content to return. A fully-qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content will be returned as it exists in the HEAD commit. + */ + commitSpecifier?: CommitName; + /** + * The fully-qualified path to the folder whose contents will be returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository. + */ + folderPath: Path; + } + export interface GetFolderOutput { + /** + * The full commit ID used as a reference for which version of the folder content is returned. + */ + commitId: ObjectId; + /** + * The fully-qualified path of the folder whose contents are returned. + */ + folderPath: Path; + /** + * The full SHA-1 pointer of the tree information for the commit that contains the folder. + */ + treeId?: ObjectId; + /** + * The list of folders that exist beneath the specified folder, if any. + */ + subFolders?: FolderList; + /** + * The list of files that exist in the specified folder, if any. + */ + files?: FileList; + /** + * The list of symbolic links to other files and folders that exist in the specified folder, if any. + */ + symbolicLinks?: SymbolicLinkList; + /** + * The list of submodules that exist in the specified folder, if any. + */ + subModules?: SubModuleList; + } + export interface GetMergeConflictsInput { + /** + * The name of the repository where the pull request was created. + */ + repositoryName: RepositoryName; + /** + * The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID. + */ + destinationCommitSpecifier: CommitName; + /** + * The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID. + */ + sourceCommitSpecifier: CommitName; + /** + * The merge option or strategy you want to use to merge the code. The only valid value is FAST_FORWARD_MERGE. + */ + mergeOption: MergeOptionTypeEnum; + } + export interface GetMergeConflictsOutput { + /** + * A Boolean value that indicates whether the code is mergable by the specified merge option. + */ + mergeable: IsMergeable; + /** + * The commit ID of the destination commit specifier that was used in the merge evaluation. + */ + destinationCommitId: CommitId; + /** + * The commit ID of the source commit specifier that was used in the merge evaluation. + */ + sourceCommitId: CommitId; + } + export interface GetPullRequestInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + } + export interface GetPullRequestOutput { + /** + * Information about the specified pull request. + */ + pullRequest: PullRequest; + } + export interface GetRepositoryInput { + /** + * The name of the repository to get information about. + */ + repositoryName: RepositoryName; + } + export interface GetRepositoryOutput { + /** + * Information about the repository. + */ + repositoryMetadata?: RepositoryMetadata; + } + export interface GetRepositoryTriggersInput { + /** + * The name of the repository for which the trigger is configured. + */ + repositoryName: RepositoryName; + } + export interface GetRepositoryTriggersOutput { + /** + * The system-generated unique ID for the trigger. + */ + configurationId?: RepositoryTriggersConfigurationId; + /** + * The JSON block of configuration information for each trigger. + */ + triggers?: RepositoryTriggersList; + } + export type IsCommentDeleted = boolean; + export type IsMergeable = boolean; + export type IsMerged = boolean; + export type IsMove = boolean; + export type KeepEmptyFolders = boolean; + export type LastModifiedDate = Date; + export type Limit = number; + export interface ListBranchesInput { + /** + * The name of the repository that contains the branches. + */ + repositoryName: RepositoryName; + /** + * An enumeration token that allows the operation to batch the results. + */ + nextToken?: NextToken; + } + export interface ListBranchesOutput { + /** + * The list of branch names. + */ + branches?: BranchNameList; + /** + * An enumeration token that returns the batch of the results. + */ + nextToken?: NextToken; + } + export interface ListPullRequestsInput { + /** + * The name of the repository for which you want to list pull requests. + */ + repositoryName: RepositoryName; + /** + * Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user. + */ + authorArn?: Arn; + /** + * Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status. + */ + pullRequestStatus?: PullRequestStatusEnum; + /** + * An enumeration token that when provided in a request, returns the next batch of the results. + */ + nextToken?: NextToken; + /** + * A non-negative integer used to limit the number of returned results. + */ + maxResults?: MaxResults; + } + export interface ListPullRequestsOutput { + /** + * The system-generated IDs of the pull requests. + */ + pullRequestIds: PullRequestIdList; + /** + * An enumeration token that when provided in a request, returns the next batch of the results. + */ + nextToken?: NextToken; + } + export interface ListRepositoriesInput { + /** + * An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved. + */ + nextToken?: NextToken; + /** + * The criteria used to sort the results of a list repositories operation. + */ + sortBy?: SortByEnum; + /** + * The order in which to sort the results of a list repositories operation. + */ + order?: OrderEnum; + } + export interface ListRepositoriesOutput { + /** + * Lists the repositories called by the list repositories operation. + */ + repositories?: RepositoryNameIdPairList; + /** + * An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved. + */ + nextToken?: NextToken; + } + export interface Location { + /** + * The name of the file being compared, including its extension and subdirectory, if any. + */ + filePath?: Path; + /** + * The position of a change within a compared file, in line number format. + */ + filePosition?: Position; + /** + * In a comparison of commits or a pull request, whether the change is in the 'before' or 'after' of that comparison. + */ + relativeFileVersion?: RelativeFileVersionEnum; + } + export type MaxResults = number; + export interface MergeMetadata { + /** + * A Boolean value indicating whether the merge has been made. + */ + isMerged?: IsMerged; + /** + * The Amazon Resource Name (ARN) of the user who merged the branches. + */ + mergedBy?: Arn; + } + export type MergeOptionTypeEnum = "FAST_FORWARD_MERGE"|string; + export interface MergePullRequestByFastForwardInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + /** + * The name of the repository where the pull request was created. + */ + repositoryName: RepositoryName; + /** + * The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID. + */ + sourceCommitId?: CommitId; + } + export interface MergePullRequestByFastForwardOutput { + /** + * Information about the specified pull request, including information about the merge. + */ + pullRequest?: PullRequest; + } + export type Message = string; + export type Mode = string; + export type Name = string; + export type NextToken = string; + export type ObjectId = string; + export type ObjectSize = number; + export type OrderEnum = "ascending"|"descending"|string; + export type ParentList = ObjectId[]; + export type Path = string; + export type Position = number; + export interface PostCommentForComparedCommitInput { + /** + * The name of the repository where you want to post a comment on the comparison between commits. + */ + repositoryName: RepositoryName; + /** + * To establish the directionality of the comparison, the full commit ID of the 'before' commit. + */ + beforeCommitId?: CommitId; + /** + * To establish the directionality of the comparison, the full commit ID of the 'after' commit. + */ + afterCommitId: CommitId; + /** + * The location of the comparison where you want to comment. + */ + location?: Location; + /** + * The content of the comment you want to make. + */ + content: Content; + /** + * A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token. + */ + clientRequestToken?: ClientRequestToken; + } + export interface PostCommentForComparedCommitOutput { + /** + * The name of the repository where you posted a comment on the comparison between commits. + */ + repositoryName?: RepositoryName; + /** + * In the directionality you established, the full commit ID of the 'before' commit. + */ + beforeCommitId?: CommitId; + /** + * In the directionality you established, the full commit ID of the 'after' commit. + */ + afterCommitId?: CommitId; + /** + * In the directionality you established, the blob ID of the 'before' blob. + */ + beforeBlobId?: ObjectId; + /** + * In the directionality you established, the blob ID of the 'after' blob. + */ + afterBlobId?: ObjectId; + /** + * The location of the comment in the comparison between the two commits. + */ + location?: Location; + /** + * The content of the comment you posted. + */ + comment?: Comment; + } + export interface PostCommentForPullRequestInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + /** + * The name of the repository where you want to post a comment on a pull request. + */ + repositoryName: RepositoryName; + /** + * The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created. + */ + beforeCommitId: CommitId; + /** + * The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment. + */ + afterCommitId: CommitId; + /** + * The location of the change where you want to post your comment. If no location is provided, the comment will be posted as a general comment on the pull request difference between the before commit ID and the after commit ID. + */ + location?: Location; + /** + * The content of your comment on the change. + */ + content: Content; + /** + * A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token. + */ + clientRequestToken?: ClientRequestToken; + } + export interface PostCommentForPullRequestOutput { + /** + * The name of the repository where you posted a comment on a pull request. + */ + repositoryName?: RepositoryName; + /** + * The system-generated ID of the pull request. + */ + pullRequestId?: PullRequestId; + /** + * The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request. + */ + beforeCommitId?: CommitId; + /** + * The full commit ID of the commit in the destination branch where the pull request will be merged. + */ + afterCommitId?: CommitId; + /** + * In the directionality of the pull request, the blob ID of the 'before' blob. + */ + beforeBlobId?: ObjectId; + /** + * In the directionality of the pull request, the blob ID of the 'after' blob. + */ + afterBlobId?: ObjectId; + /** + * The location of the change where you posted your comment. + */ + location?: Location; + /** + * The content of the comment you posted. + */ + comment?: Comment; + } + export interface PostCommentReplyInput { + /** + * The system-generated ID of the comment to which you want to reply. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. + */ + inReplyTo: CommentId; + /** + * A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token. + */ + clientRequestToken?: ClientRequestToken; + /** + * The contents of your reply to a comment. + */ + content: Content; + } + export interface PostCommentReplyOutput { + /** + * Information about the reply to a comment. + */ + comment?: Comment; + } + export interface PullRequest { + /** + * The system-generated ID of the pull request. + */ + pullRequestId?: PullRequestId; + /** + * The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository. + */ + title?: Title; + /** + * The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request. + */ + description?: Description; + /** + * The day and time of the last user or system activity on the pull request, in timestamp format. + */ + lastActivityDate?: LastModifiedDate; + /** + * The date and time the pull request was originally created, in timestamp format. + */ + creationDate?: CreationDate; + /** + * The status of the pull request. Pull request status can only change from OPEN to CLOSED. + */ + pullRequestStatus?: PullRequestStatusEnum; + /** + * The Amazon Resource Name (ARN) of the user who created the pull request. + */ + authorArn?: Arn; + /** + * The targets of the pull request, including the source branch and destination branch for the pull request. + */ + pullRequestTargets?: PullRequestTargetList; + /** + * A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token. + */ + clientRequestToken?: ClientRequestToken; + } + export interface PullRequestCreatedEventMetadata { + /** + * The name of the repository where the pull request was created. + */ + repositoryName?: RepositoryName; + /** + * The commit ID on the source branch used when the pull request was created. + */ + sourceCommitId?: CommitId; + /** + * The commit ID of the tip of the branch specified as the destination branch when the pull request was created. + */ + destinationCommitId?: CommitId; + /** + * The commit ID of the most recent commit that the source branch and the destination branch have in common. + */ + mergeBase?: CommitId; + } + export interface PullRequestEvent { + /** + * The system-generated ID of the pull request. + */ + pullRequestId?: PullRequestId; + /** + * The day and time of the pull request event, in timestamp format. + */ + eventDate?: EventDate; + /** + * The type of the pull request event, for example a status change event (PULL_REQUEST_STATUS_CHANGED) or update event (PULL_REQUEST_SOURCE_REFERENCE_UPDATED). + */ + pullRequestEventType?: PullRequestEventType; + /** + * The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request. + */ + actorArn?: Arn; + /** + * Information about the source and destination branches for the pull request. + */ + pullRequestCreatedEventMetadata?: PullRequestCreatedEventMetadata; + /** + * Information about the change in status for the pull request event. + */ + pullRequestStatusChangedEventMetadata?: PullRequestStatusChangedEventMetadata; + /** + * Information about the updated source branch for the pull request event. + */ + pullRequestSourceReferenceUpdatedEventMetadata?: PullRequestSourceReferenceUpdatedEventMetadata; + /** + * Information about the change in mergability state for the pull request event. + */ + pullRequestMergedStateChangedEventMetadata?: PullRequestMergedStateChangedEventMetadata; + } + export type PullRequestEventList = PullRequestEvent[]; + export type PullRequestEventType = "PULL_REQUEST_CREATED"|"PULL_REQUEST_STATUS_CHANGED"|"PULL_REQUEST_SOURCE_REFERENCE_UPDATED"|"PULL_REQUEST_MERGE_STATE_CHANGED"|string; + export type PullRequestId = string; + export type PullRequestIdList = PullRequestId[]; + export interface PullRequestMergedStateChangedEventMetadata { + /** + * The name of the repository where the pull request was created. + */ + repositoryName?: RepositoryName; + /** + * The name of the branch that the pull request will be merged into. + */ + destinationReference?: ReferenceName; + /** + * Information about the merge state change event. + */ + mergeMetadata?: MergeMetadata; + } + export interface PullRequestSourceReferenceUpdatedEventMetadata { + /** + * The name of the repository where the pull request was updated. + */ + repositoryName?: RepositoryName; + /** + * The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was updated. + */ + beforeCommitId?: CommitId; + /** + * The full commit ID of the commit in the source branch that was the tip of the branch at the time the pull request was updated. + */ + afterCommitId?: CommitId; + /** + * The commit ID of the most recent commit that the source branch and the destination branch have in common. + */ + mergeBase?: CommitId; + } + export interface PullRequestStatusChangedEventMetadata { + /** + * The changed status of the pull request. + */ + pullRequestStatus?: PullRequestStatusEnum; + } + export type PullRequestStatusEnum = "OPEN"|"CLOSED"|string; + export interface PullRequestTarget { + /** + * The name of the repository that contains the pull request source and destination branches. + */ + repositoryName?: RepositoryName; + /** + * The branch of the repository that contains the changes for the pull request. Also known as the source branch. + */ + sourceReference?: ReferenceName; + /** + * The branch of the repository where the pull request changes will be merged into. Also known as the destination branch. + */ + destinationReference?: ReferenceName; + /** + * The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged. + */ + destinationCommit?: CommitId; + /** + * The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch. + */ + sourceCommit?: CommitId; + /** + * The commit ID of the most recent commit that the source branch and the destination branch have in common. + */ + mergeBase?: CommitId; + /** + * Returns metadata about the state of the merge, including whether the merge has been made. + */ + mergeMetadata?: MergeMetadata; + } + export type PullRequestTargetList = PullRequestTarget[]; + export type PutFileEntries = PutFileEntry[]; + export interface PutFileEntry { + /** + * The full path to the file in the repository, including the name of the file. + */ + filePath: Path; + /** + * The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL. + */ + fileMode?: FileModeTypeEnum; + /** + * The content of the file, if a source file is not specified. + */ + fileContent?: FileContent; + /** + * The name and full path of the file that contains the changes you want to make as part of the commit, if you are not providing the file content directly. + */ + sourceFile?: SourceFileSpecifier; + } + export interface PutFileInput { + /** + * The name of the repository where you want to add or update the file. + */ + repositoryName: RepositoryName; + /** + * The name of the branch where you want to add or update the file. If this is an empty repository, this branch will be created. + */ + branchName: BranchName; + /** + * The content of the file, in binary object format. + */ + fileContent: FileContent; + /** + * The name of the file you want to add or update, including the relative path to the file in the repository. If the path does not currently exist in the repository, the path will be created as part of adding the file. + */ + filePath: Path; + /** + * The file mode permissions of the blob. Valid file mode permissions are listed below. + */ + fileMode?: FileModeTypeEnum; + /** + * The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required. The commit ID must match the ID of the head commit at the time of the operation, or an error will occur, and the file will not be added or updated. + */ + parentCommitId?: CommitId; + /** + * A message about why this file was added or updated. While optional, adding a message is strongly encouraged in order to provide a more useful commit history for your repository. + */ + commitMessage?: Message; + /** + * The name of the person adding or updating the file. While optional, adding a name is strongly encouraged in order to provide a more useful commit history for your repository. + */ + name?: Name; + /** + * An email address for the person adding or updating the file. + */ + email?: Email; + } + export interface PutFileOutput { + /** + * The full SHA of the commit that contains this file change. + */ + commitId: ObjectId; + /** + * The ID of the blob, which is its SHA-1 pointer. + */ + blobId: ObjectId; + /** + * The full SHA-1 pointer of the tree information for the commit that contains this file change. + */ + treeId: ObjectId; + } + export interface PutRepositoryTriggersInput { + /** + * The name of the repository where you want to create or update the trigger. + */ + repositoryName: RepositoryName; + /** + * The JSON block of configuration information for each trigger. + */ + triggers: RepositoryTriggersList; + } + export interface PutRepositoryTriggersOutput { + /** + * The system-generated unique ID for the create or update operation. + */ + configurationId?: RepositoryTriggersConfigurationId; + } + export type ReferenceName = string; + export type RelativeFileVersionEnum = "BEFORE"|"AFTER"|string; + export type RepositoryDescription = string; + export type RepositoryId = string; + export interface RepositoryMetadata { + /** + * The ID of the AWS account associated with the repository. + */ + accountId?: AccountId; + /** + * The ID of the repository. + */ + repositoryId?: RepositoryId; + /** + * The repository's name. + */ + repositoryName?: RepositoryName; + /** + * A comment or description about the repository. + */ + repositoryDescription?: RepositoryDescription; + /** + * The repository's default branch name. + */ + defaultBranch?: BranchName; + /** + * The date and time the repository was last modified, in timestamp format. + */ + lastModifiedDate?: LastModifiedDate; + /** + * The date and time the repository was created, in timestamp format. + */ + creationDate?: CreationDate; + /** + * The URL to use for cloning the repository over HTTPS. + */ + cloneUrlHttp?: CloneUrlHttp; + /** + * The URL to use for cloning the repository over SSH. + */ + cloneUrlSsh?: CloneUrlSsh; + /** + * The Amazon Resource Name (ARN) of the repository. + */ + Arn?: Arn; + } + export type RepositoryMetadataList = RepositoryMetadata[]; + export type RepositoryName = string; + export interface RepositoryNameIdPair { + /** + * The name associated with the repository. + */ + repositoryName?: RepositoryName; + /** + * The ID associated with the repository. + */ + repositoryId?: RepositoryId; + } + export type RepositoryNameIdPairList = RepositoryNameIdPair[]; + export type RepositoryNameList = RepositoryName[]; + export type RepositoryNotFoundList = RepositoryName[]; + export interface RepositoryTrigger { + /** + * The name of the trigger. + */ + name: RepositoryTriggerName; + /** + * The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon Simple Notification Service (SNS). + */ + destinationArn: Arn; + /** + * Any custom data associated with the trigger that will be included in the information sent to the target of the trigger. + */ + customData?: RepositoryTriggerCustomData; + /** + * The branches that will be included in the trigger configuration. If you specify an empty array, the trigger will apply to all branches. While no content is required in the array, you must include the array itself. + */ + branches?: BranchNameList; + /** + * The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon Simple Notification Service (SNS). The valid value "all" cannot be used with any other values. + */ + events: RepositoryTriggerEventList; + } + export type RepositoryTriggerCustomData = string; + export type RepositoryTriggerEventEnum = "all"|"updateReference"|"createReference"|"deleteReference"|string; + export type RepositoryTriggerEventList = RepositoryTriggerEventEnum[]; + export interface RepositoryTriggerExecutionFailure { + /** + * The name of the trigger that did not run. + */ + trigger?: RepositoryTriggerName; + /** + * Additional message information about the trigger that did not run. + */ + failureMessage?: RepositoryTriggerExecutionFailureMessage; + } + export type RepositoryTriggerExecutionFailureList = RepositoryTriggerExecutionFailure[]; + export type RepositoryTriggerExecutionFailureMessage = string; + export type RepositoryTriggerName = string; + export type RepositoryTriggerNameList = RepositoryTriggerName[]; + export type RepositoryTriggersConfigurationId = string; + export type RepositoryTriggersList = RepositoryTrigger[]; + export type SetFileModeEntries = SetFileModeEntry[]; + export interface SetFileModeEntry { + /** + * The full path to the file, including the name of the file. + */ + filePath: Path; + /** + * The file mode for the file. + */ + fileMode: FileModeTypeEnum; + } + export type SortByEnum = "repositoryName"|"lastModifiedDate"|string; + export interface SourceFileSpecifier { + /** + * The full path to the file, including the name of the file. + */ + filePath: Path; + /** + * Whether to remove the source file from the parent commit. + */ + isMove?: IsMove; + } + export interface SubModule { + /** + * The commit ID that contains the reference to the submodule. + */ + commitId?: ObjectId; + /** + * The fully qualified path to the folder that contains the reference to the submodule. + */ + absolutePath?: Path; + /** + * The relative path of the submodule from the folder where the query originated. + */ + relativePath?: Path; + } + export type SubModuleList = SubModule[]; + export interface SymbolicLink { + /** + * The blob ID that contains the information about the symbolic link. + */ + blobId?: ObjectId; + /** + * The fully-qualified path to the folder that contains the symbolic link. + */ + absolutePath?: Path; + /** + * The relative path of the symbolic link from the folder where the query originated. + */ + relativePath?: Path; + /** + * The file mode permissions of the blob that cotains information about the symbolic link. + */ + fileMode?: FileModeTypeEnum; + } + export type SymbolicLinkList = SymbolicLink[]; + export interface Target { + /** + * The name of the repository that contains the pull request. + */ + repositoryName: RepositoryName; + /** + * The branch of the repository that contains the changes for the pull request. Also known as the source branch. + */ + sourceReference: ReferenceName; + /** + * The branch of the repository where the pull request changes will be merged into. Also known as the destination branch. + */ + destinationReference?: ReferenceName; + } + export type TargetList = Target[]; + export interface TestRepositoryTriggersInput { + /** + * The name of the repository in which to test the triggers. + */ + repositoryName: RepositoryName; + /** + * The list of triggers to test. + */ + triggers: RepositoryTriggersList; + } + export interface TestRepositoryTriggersOutput { + /** + * The list of triggers that were successfully tested. This list provides the names of the triggers that were successfully tested, separated by commas. + */ + successfulExecutions?: RepositoryTriggerNameList; + /** + * The list of triggers that were not able to be tested. This list provides the names of the triggers that could not be tested, separated by commas. + */ + failedExecutions?: RepositoryTriggerExecutionFailureList; + } + export type Title = string; + export interface UpdateCommentInput { + /** + * The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. + */ + commentId: CommentId; + /** + * The updated content with which you want to replace the existing content of the comment. + */ + content: Content; + } + export interface UpdateCommentOutput { + /** + * Information about the updated comment. + */ + comment?: Comment; + } + export interface UpdateDefaultBranchInput { + /** + * The name of the repository to set or change the default branch for. + */ + repositoryName: RepositoryName; + /** + * The name of the branch to set as the default. + */ + defaultBranchName: BranchName; + } + export interface UpdatePullRequestDescriptionInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + /** + * The updated content of the description for the pull request. This content will replace the existing description. + */ + description: Description; + } + export interface UpdatePullRequestDescriptionOutput { + /** + * Information about the updated pull request. + */ + pullRequest: PullRequest; + } + export interface UpdatePullRequestStatusInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + /** + * The status of the pull request. The only valid operations are to update the status from OPEN to OPEN, OPEN to CLOSED or from from CLOSED to CLOSED. + */ + pullRequestStatus: PullRequestStatusEnum; + } + export interface UpdatePullRequestStatusOutput { + /** + * Information about the pull request. + */ + pullRequest: PullRequest; + } + export interface UpdatePullRequestTitleInput { + /** + * The system-generated ID of the pull request. To get this ID, use ListPullRequests. + */ + pullRequestId: PullRequestId; + /** + * The updated title of the pull request. This will replace the existing title. + */ + title: Title; + } + export interface UpdatePullRequestTitleOutput { + /** + * Information about the updated pull request. + */ + pullRequest: PullRequest; + } + export interface UpdateRepositoryDescriptionInput { + /** + * The name of the repository to set or change the comment or description for. + */ + repositoryName: RepositoryName; + /** + * The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters. + */ + repositoryDescription?: RepositoryDescription; + } + export interface UpdateRepositoryNameInput { + /** + * The existing name of the repository. + */ + oldName: RepositoryName; + /** + * The new name for the repository. + */ + newName: RepositoryName; + } + export interface UserInfo { + /** + * The name of the user who made the specified commit. + */ + name?: Name; + /** + * The email address associated with the user who made the commit, if any. + */ + email?: Email; + /** + * The date when the specified commit was commited, in timestamp format with GMT offset. + */ + date?: _Date; + } + export type blob = Buffer|Uint8Array|Blob|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-04-13"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CodeCommit client. + */ + export import Types = CodeCommit; +} +export = CodeCommit; diff --git a/node_modules/aws-sdk/clients/codecommit.js b/node_modules/aws-sdk/clients/codecommit.js new file mode 100644 index 0000000..04081c4 --- /dev/null +++ b/node_modules/aws-sdk/clients/codecommit.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['codecommit'] = {}; +AWS.CodeCommit = Service.defineService('codecommit', ['2015-04-13']); +Object.defineProperty(apiLoader.services['codecommit'], '2015-04-13', { + get: function get() { + var model = require('../apis/codecommit-2015-04-13.min.json'); + model.paginators = require('../apis/codecommit-2015-04-13.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CodeCommit; diff --git a/node_modules/aws-sdk/clients/codedeploy.d.ts b/node_modules/aws-sdk/clients/codedeploy.d.ts new file mode 100644 index 0000000..afb5b21 --- /dev/null +++ b/node_modules/aws-sdk/clients/codedeploy.d.ts @@ -0,0 +1,2303 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CodeDeploy extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CodeDeploy.Types.ClientConfiguration) + config: Config & CodeDeploy.Types.ClientConfiguration; + /** + * Adds tags to on-premises instances. + */ + addTagsToOnPremisesInstances(params: CodeDeploy.Types.AddTagsToOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds tags to on-premises instances. + */ + addTagsToOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets information about one or more application revisions. + */ + batchGetApplicationRevisions(params: CodeDeploy.Types.BatchGetApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request; + /** + * Gets information about one or more application revisions. + */ + batchGetApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationRevisionsOutput) => void): Request; + /** + * Gets information about one or more applications. + */ + batchGetApplications(params: CodeDeploy.Types.BatchGetApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request; + /** + * Gets information about one or more applications. + */ + batchGetApplications(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetApplicationsOutput) => void): Request; + /** + * Gets information about one or more deployment groups. + */ + batchGetDeploymentGroups(params: CodeDeploy.Types.BatchGetDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request; + /** + * Gets information about one or more deployment groups. + */ + batchGetDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentGroupsOutput) => void): Request; + /** + * This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. + */ + batchGetDeploymentInstances(params: CodeDeploy.Types.BatchGetDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request; + /** + * This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. + */ + batchGetDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentInstancesOutput) => void): Request; + /** + * Returns an array of targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The type of targets returned depends on the deployment's compute platform: EC2/On-premises: Information about EC2 instance targets. AWS Lambda: Information about Lambda functions targets. Amazon ECS: Information about Amazon ECS service targets. + */ + batchGetDeploymentTargets(params: CodeDeploy.Types.BatchGetDeploymentTargetsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentTargetsOutput) => void): Request; + /** + * Returns an array of targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The type of targets returned depends on the deployment's compute platform: EC2/On-premises: Information about EC2 instance targets. AWS Lambda: Information about Lambda functions targets. Amazon ECS: Information about Amazon ECS service targets. + */ + batchGetDeploymentTargets(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentTargetsOutput) => void): Request; + /** + * Gets information about one or more deployments. + */ + batchGetDeployments(params: CodeDeploy.Types.BatchGetDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request; + /** + * Gets information about one or more deployments. + */ + batchGetDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetDeploymentsOutput) => void): Request; + /** + * Gets information about one or more on-premises instances. + */ + batchGetOnPremisesInstances(params: CodeDeploy.Types.BatchGetOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request; + /** + * Gets information about one or more on-premises instances. + */ + batchGetOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.BatchGetOnPremisesInstancesOutput) => void): Request; + /** + * For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.) + */ + continueDeployment(params: CodeDeploy.Types.ContinueDeploymentInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.) + */ + continueDeployment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates an application. + */ + createApplication(params: CodeDeploy.Types.CreateApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request; + /** + * Creates an application. + */ + createApplication(callback?: (err: AWSError, data: CodeDeploy.Types.CreateApplicationOutput) => void): Request; + /** + * Deploys an application revision through the specified deployment group. + */ + createDeployment(params: CodeDeploy.Types.CreateDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request; + /** + * Deploys an application revision through the specified deployment group. + */ + createDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentOutput) => void): Request; + /** + * Creates a deployment configuration. + */ + createDeploymentConfig(params: CodeDeploy.Types.CreateDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request; + /** + * Creates a deployment configuration. + */ + createDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentConfigOutput) => void): Request; + /** + * Creates a deployment group to which application revisions are deployed. + */ + createDeploymentGroup(params: CodeDeploy.Types.CreateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request; + /** + * Creates a deployment group to which application revisions are deployed. + */ + createDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.CreateDeploymentGroupOutput) => void): Request; + /** + * Deletes an application. + */ + deleteApplication(params: CodeDeploy.Types.DeleteApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an application. + */ + deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. + */ + deleteDeploymentConfig(params: CodeDeploy.Types.DeleteDeploymentConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. + */ + deleteDeploymentConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a deployment group. + */ + deleteDeploymentGroup(params: CodeDeploy.Types.DeleteDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request; + /** + * Deletes a deployment group. + */ + deleteDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.DeleteDeploymentGroupOutput) => void): Request; + /** + * Deletes a GitHub account connection. + */ + deleteGitHubAccountToken(params: CodeDeploy.Types.DeleteGitHubAccountTokenInput, callback?: (err: AWSError, data: CodeDeploy.Types.DeleteGitHubAccountTokenOutput) => void): Request; + /** + * Deletes a GitHub account connection. + */ + deleteGitHubAccountToken(callback?: (err: AWSError, data: CodeDeploy.Types.DeleteGitHubAccountTokenOutput) => void): Request; + /** + * Deregisters an on-premises instance. + */ + deregisterOnPremisesInstance(params: CodeDeploy.Types.DeregisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters an on-premises instance. + */ + deregisterOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets information about an application. + */ + getApplication(params: CodeDeploy.Types.GetApplicationInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request; + /** + * Gets information about an application. + */ + getApplication(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationOutput) => void): Request; + /** + * Gets information about an application revision. + */ + getApplicationRevision(params: CodeDeploy.Types.GetApplicationRevisionInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request; + /** + * Gets information about an application revision. + */ + getApplicationRevision(callback?: (err: AWSError, data: CodeDeploy.Types.GetApplicationRevisionOutput) => void): Request; + /** + * Gets information about a deployment. The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file. + */ + getDeployment(params: CodeDeploy.Types.GetDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request; + /** + * Gets information about a deployment. The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file. + */ + getDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request; + /** + * Gets information about a deployment configuration. + */ + getDeploymentConfig(params: CodeDeploy.Types.GetDeploymentConfigInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request; + /** + * Gets information about a deployment configuration. + */ + getDeploymentConfig(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentConfigOutput) => void): Request; + /** + * Gets information about a deployment group. + */ + getDeploymentGroup(params: CodeDeploy.Types.GetDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request; + /** + * Gets information about a deployment group. + */ + getDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentGroupOutput) => void): Request; + /** + * Gets information about an instance as part of a deployment. + */ + getDeploymentInstance(params: CodeDeploy.Types.GetDeploymentInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request; + /** + * Gets information about an instance as part of a deployment. + */ + getDeploymentInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentInstanceOutput) => void): Request; + /** + * Returns information about a deployment target. + */ + getDeploymentTarget(params: CodeDeploy.Types.GetDeploymentTargetInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentTargetOutput) => void): Request; + /** + * Returns information about a deployment target. + */ + getDeploymentTarget(callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentTargetOutput) => void): Request; + /** + * Gets information about an on-premises instance. + */ + getOnPremisesInstance(params: CodeDeploy.Types.GetOnPremisesInstanceInput, callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request; + /** + * Gets information about an on-premises instance. + */ + getOnPremisesInstance(callback?: (err: AWSError, data: CodeDeploy.Types.GetOnPremisesInstanceOutput) => void): Request; + /** + * Lists information about revisions for an application. + */ + listApplicationRevisions(params: CodeDeploy.Types.ListApplicationRevisionsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request; + /** + * Lists information about revisions for an application. + */ + listApplicationRevisions(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationRevisionsOutput) => void): Request; + /** + * Lists the applications registered with the IAM user or AWS account. + */ + listApplications(params: CodeDeploy.Types.ListApplicationsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request; + /** + * Lists the applications registered with the IAM user or AWS account. + */ + listApplications(callback?: (err: AWSError, data: CodeDeploy.Types.ListApplicationsOutput) => void): Request; + /** + * Lists the deployment configurations with the IAM user or AWS account. + */ + listDeploymentConfigs(params: CodeDeploy.Types.ListDeploymentConfigsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request; + /** + * Lists the deployment configurations with the IAM user or AWS account. + */ + listDeploymentConfigs(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentConfigsOutput) => void): Request; + /** + * Lists the deployment groups for an application registered with the IAM user or AWS account. + */ + listDeploymentGroups(params: CodeDeploy.Types.ListDeploymentGroupsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request; + /** + * Lists the deployment groups for an application registered with the IAM user or AWS account. + */ + listDeploymentGroups(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentGroupsOutput) => void): Request; + /** + * The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda. Lists the instance for a deployment associated with the IAM user or AWS account. + */ + listDeploymentInstances(params: CodeDeploy.Types.ListDeploymentInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request; + /** + * The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda. Lists the instance for a deployment associated with the IAM user or AWS account. + */ + listDeploymentInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentInstancesOutput) => void): Request; + /** + * Returns an array of target IDs that are associated a deployment. + */ + listDeploymentTargets(params: CodeDeploy.Types.ListDeploymentTargetsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentTargetsOutput) => void): Request; + /** + * Returns an array of target IDs that are associated a deployment. + */ + listDeploymentTargets(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentTargetsOutput) => void): Request; + /** + * Lists the deployments in a deployment group for an application registered with the IAM user or AWS account. + */ + listDeployments(params: CodeDeploy.Types.ListDeploymentsInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request; + /** + * Lists the deployments in a deployment group for an application registered with the IAM user or AWS account. + */ + listDeployments(callback?: (err: AWSError, data: CodeDeploy.Types.ListDeploymentsOutput) => void): Request; + /** + * Lists the names of stored connections to GitHub accounts. + */ + listGitHubAccountTokenNames(params: CodeDeploy.Types.ListGitHubAccountTokenNamesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListGitHubAccountTokenNamesOutput) => void): Request; + /** + * Lists the names of stored connections to GitHub accounts. + */ + listGitHubAccountTokenNames(callback?: (err: AWSError, data: CodeDeploy.Types.ListGitHubAccountTokenNamesOutput) => void): Request; + /** + * Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. + */ + listOnPremisesInstances(params: CodeDeploy.Types.ListOnPremisesInstancesInput, callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request; + /** + * Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. + */ + listOnPremisesInstances(callback?: (err: AWSError, data: CodeDeploy.Types.ListOnPremisesInstancesOutput) => void): Request; + /** + * Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed. + */ + putLifecycleEventHookExecutionStatus(params: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusInput, callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request; + /** + * Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed. + */ + putLifecycleEventHookExecutionStatus(callback?: (err: AWSError, data: CodeDeploy.Types.PutLifecycleEventHookExecutionStatusOutput) => void): Request; + /** + * Registers with AWS CodeDeploy a revision for the specified application. + */ + registerApplicationRevision(params: CodeDeploy.Types.RegisterApplicationRevisionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers with AWS CodeDeploy a revision for the specified application. + */ + registerApplicationRevision(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both. + */ + registerOnPremisesInstance(params: CodeDeploy.Types.RegisterOnPremisesInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both. + */ + registerOnPremisesInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes one or more tags from one or more on-premises instances. + */ + removeTagsFromOnPremisesInstances(params: CodeDeploy.Types.RemoveTagsFromOnPremisesInstancesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes one or more tags from one or more on-premises instances. + */ + removeTagsFromOnPremisesInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete. + */ + skipWaitTimeForInstanceTermination(params: CodeDeploy.Types.SkipWaitTimeForInstanceTerminationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete. + */ + skipWaitTimeForInstanceTermination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attempts to stop an ongoing deployment. + */ + stopDeployment(params: CodeDeploy.Types.StopDeploymentInput, callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request; + /** + * Attempts to stop an ongoing deployment. + */ + stopDeployment(callback?: (err: AWSError, data: CodeDeploy.Types.StopDeploymentOutput) => void): Request; + /** + * Changes the name of an application. + */ + updateApplication(params: CodeDeploy.Types.UpdateApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the name of an application. + */ + updateApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes information about a deployment group. + */ + updateDeploymentGroup(params: CodeDeploy.Types.UpdateDeploymentGroupInput, callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request; + /** + * Changes information about a deployment group. + */ + updateDeploymentGroup(callback?: (err: AWSError, data: CodeDeploy.Types.UpdateDeploymentGroupOutput) => void): Request; + /** + * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times). + */ + waitFor(state: "deploymentSuccessful", params: CodeDeploy.Types.GetDeploymentInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request; + /** + * Waits for the deploymentSuccessful state by periodically calling the underlying CodeDeploy.getDeploymentoperation every 15 seconds (at most 120 times). + */ + waitFor(state: "deploymentSuccessful", callback?: (err: AWSError, data: CodeDeploy.Types.GetDeploymentOutput) => void): Request; +} +declare namespace CodeDeploy { + export interface AddTagsToOnPremisesInstancesInput { + /** + * The tag key-value pairs to add to the on-premises instances. Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed. + */ + tags: TagList; + /** + * The names of the on-premises instances to which to add tags. + */ + instanceNames: InstanceNameList; + } + export type AdditionalDeploymentStatusInfo = string; + export interface Alarm { + /** + * The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms. + */ + name?: AlarmName; + } + export interface AlarmConfiguration { + /** + * Indicates whether the alarm configuration is enabled. + */ + enabled?: Boolean; + /** + * Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false. true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch. false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch. + */ + ignorePollAlarmFailure?: Boolean; + /** + * A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group. + */ + alarms?: AlarmList; + } + export type AlarmList = Alarm[]; + export type AlarmName = string; + export interface AppSpecContent { + /** + * The YAML-formatted or JSON-formatted revision string. For an AWS Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment. + */ + content?: RawStringContent; + /** + * The SHA256 hash value of the revision content. + */ + sha256?: RawStringSha256; + } + export type ApplicationId = string; + export interface ApplicationInfo { + /** + * The application ID. + */ + applicationId?: ApplicationId; + /** + * The application name. + */ + applicationName?: ApplicationName; + /** + * The time at which the application was created. + */ + createTime?: Timestamp; + /** + * True if the user has authenticated with GitHub for the specified application. Otherwise, false. + */ + linkedToGitHub?: Boolean; + /** + * The name for a connection to a GitHub account. + */ + gitHubAccountName?: GitHubAccountTokenName; + /** + * The destination platform type for deployment of the application (Lambda or Server). + */ + computePlatform?: ComputePlatform; + } + export type ApplicationName = string; + export type ApplicationRevisionSortBy = "registerTime"|"firstUsedTime"|"lastUsedTime"|string; + export type ApplicationsInfoList = ApplicationInfo[]; + export type ApplicationsList = ApplicationName[]; + export interface AutoRollbackConfiguration { + /** + * Indicates whether a defined automatic rollback configuration is currently enabled. + */ + enabled?: Boolean; + /** + * The event type or types that trigger a rollback. + */ + events?: AutoRollbackEventsList; + } + export type AutoRollbackEvent = "DEPLOYMENT_FAILURE"|"DEPLOYMENT_STOP_ON_ALARM"|"DEPLOYMENT_STOP_ON_REQUEST"|string; + export type AutoRollbackEventsList = AutoRollbackEvent[]; + export interface AutoScalingGroup { + /** + * The Auto Scaling group name. + */ + name?: AutoScalingGroupName; + /** + * An Auto Scaling lifecycle event hook name. + */ + hook?: AutoScalingGroupHook; + } + export type AutoScalingGroupHook = string; + export type AutoScalingGroupList = AutoScalingGroup[]; + export type AutoScalingGroupName = string; + export type AutoScalingGroupNameList = AutoScalingGroupName[]; + export interface BatchGetApplicationRevisionsInput { + /** + * The name of an AWS CodeDeploy application about which to get revision information. + */ + applicationName: ApplicationName; + /** + * Information to get about the application revisions, including type and location. + */ + revisions: RevisionLocationList; + } + export interface BatchGetApplicationRevisionsOutput { + /** + * The name of the application that corresponds to the revisions. + */ + applicationName?: ApplicationName; + /** + * Information about errors that might have occurred during the API call. + */ + errorMessage?: ErrorMessage; + /** + * Additional information about the revisions, including the type and location. + */ + revisions?: RevisionInfoList; + } + export interface BatchGetApplicationsInput { + /** + * A list of application names separated by spaces. + */ + applicationNames: ApplicationsList; + } + export interface BatchGetApplicationsOutput { + /** + * Information about the applications. + */ + applicationsInfo?: ApplicationsInfoList; + } + export interface BatchGetDeploymentGroupsInput { + /** + * The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * The names of the deployment groups. + */ + deploymentGroupNames: DeploymentGroupsList; + } + export interface BatchGetDeploymentGroupsOutput { + /** + * Information about the deployment groups. + */ + deploymentGroupsInfo?: DeploymentGroupInfoList; + /** + * Information about errors that might have occurred during the API call. + */ + errorMessage?: ErrorMessage; + } + export interface BatchGetDeploymentInstancesInput { + /** + * The unique ID of a deployment. + */ + deploymentId: DeploymentId; + /** + * The unique IDs of instances used in the deployment. + */ + instanceIds: InstancesList; + } + export interface BatchGetDeploymentInstancesOutput { + /** + * Information about the instance. + */ + instancesSummary?: InstanceSummaryList; + /** + * Information about errors that might have occurred during the API call. + */ + errorMessage?: ErrorMessage; + } + export interface BatchGetDeploymentTargetsInput { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs, and their target type is instanceTarget. For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget. For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget. + */ + targetIds?: TargetIdList; + } + export interface BatchGetDeploymentTargetsOutput { + /** + * A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform. EC2/On-premises: Each target object is an EC2 or on-premises instance. AWS Lambda: The target object is a specific version of an AWS Lambda function. Amazon ECS: The target object is an Amazon ECS service. + */ + deploymentTargets?: DeploymentTargetList; + } + export interface BatchGetDeploymentsInput { + /** + * A list of deployment IDs, separated by spaces. + */ + deploymentIds: DeploymentsList; + } + export interface BatchGetDeploymentsOutput { + /** + * Information about the deployments. + */ + deploymentsInfo?: DeploymentsInfoList; + } + export interface BatchGetOnPremisesInstancesInput { + /** + * The names of the on-premises instances about which to get information. + */ + instanceNames: InstanceNameList; + } + export interface BatchGetOnPremisesInstancesOutput { + /** + * Information about the on-premises instances. + */ + instanceInfos?: InstanceInfoList; + } + export interface BlueGreenDeploymentConfiguration { + /** + * Information about whether to terminate instances in the original fleet during a blue/green deployment. + */ + terminateBlueInstancesOnDeploymentSuccess?: BlueInstanceTerminationOption; + /** + * Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment. + */ + deploymentReadyOption?: DeploymentReadyOption; + /** + * Information about how instances are provisioned for a replacement environment in a blue/green deployment. + */ + greenFleetProvisioningOption?: GreenFleetProvisioningOption; + } + export interface BlueInstanceTerminationOption { + /** + * The action to take on instances in the original environment after a successful blue/green deployment. TERMINATE: Instances are terminated after a specified wait time. KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group. + */ + action?: InstanceAction; + /** + * The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment. The maximum setting is 2880 minutes (2 days). + */ + terminationWaitTimeInMinutes?: Duration; + } + export type Boolean = boolean; + export type BundleType = "tar"|"tgz"|"zip"|"YAML"|"JSON"|string; + export type CommitId = string; + export type ComputePlatform = "Server"|"Lambda"|"ECS"|string; + export interface ContinueDeploymentInput { + /** + * The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment. + */ + deploymentId?: DeploymentId; + /** + * The status of the deployment's waiting period. READY_WAIT indicates the deployment is ready to start shifting traffic. TERMINATION_WAIT indicates the traffic is shifted, but the original target is not terminated. + */ + deploymentWaitType?: DeploymentWaitType; + } + export interface CreateApplicationInput { + /** + * The name of the application. This name must be unique with the applicable IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * The destination platform type for the deployment (Lambda or Server). + */ + computePlatform?: ComputePlatform; + } + export interface CreateApplicationOutput { + /** + * A unique application ID. + */ + applicationId?: ApplicationId; + } + export interface CreateDeploymentConfigInput { + /** + * The name of the deployment configuration to create. + */ + deploymentConfigName: DeploymentConfigName; + /** + * The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value. The type parameter takes either of the following values: HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value. FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances. The value parameter takes an integer. For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95. + */ + minimumHealthyHosts?: MinimumHealthyHosts; + /** + * The configuration that specifies how the deployment traffic is routed. + */ + trafficRoutingConfig?: TrafficRoutingConfig; + /** + * The destination platform type for the deployment (Lambda or Server>). + */ + computePlatform?: ComputePlatform; + } + export interface CreateDeploymentConfigOutput { + /** + * A unique deployment configuration ID. + */ + deploymentConfigId?: DeploymentConfigId; + } + export interface CreateDeploymentGroupInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * The name of a new deployment group for the specified application. + */ + deploymentGroupName: DeploymentGroupName; + /** + * If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation. CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group. For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide. + */ + deploymentConfigName?: DeploymentConfigName; + /** + * The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet. + */ + ec2TagFilters?: EC2TagFilterList; + /** + * The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet. + */ + onPremisesInstanceTagFilters?: TagFilterList; + /** + * A list of associated Amazon EC2 Auto Scaling groups. + */ + autoScalingGroups?: AutoScalingGroupNameList; + /** + * A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services. + */ + serviceRoleArn: Role; + /** + * Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS CodeDeploy User Guide. + */ + triggerConfigurations?: TriggerConfigList; + /** + * Information to add about Amazon CloudWatch alarms when the deployment group is created. + */ + alarmConfiguration?: AlarmConfiguration; + /** + * Configuration information for an automatic rollback that is added when a deployment group is created. + */ + autoRollbackConfiguration?: AutoRollbackConfiguration; + /** + * Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer. + */ + deploymentStyle?: DeploymentStyle; + /** + * Information about blue/green deployment options for a deployment group. + */ + blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration; + /** + * Information about the load balancer used in a deployment. + */ + loadBalancerInfo?: LoadBalancerInfo; + /** + * Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters. + */ + ec2TagSet?: EC2TagSet; + /** + * The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>. + */ + ecsServices?: ECSServiceList; + /** + * Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters. + */ + onPremisesTagSet?: OnPremisesTagSet; + } + export interface CreateDeploymentGroupOutput { + /** + * A unique deployment group ID. + */ + deploymentGroupId?: DeploymentGroupId; + } + export interface CreateDeploymentInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * The name of the deployment group. + */ + deploymentGroupName?: DeploymentGroupName; + /** + * The type and location of the revision to deploy. + */ + revision?: RevisionLocation; + /** + * The name of a deployment configuration associated with the IAM user or AWS account. If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default. + */ + deploymentConfigName?: DeploymentConfigName; + /** + * A comment about the deployment. + */ + description?: Description; + /** + * If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop. If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored. + */ + ignoreApplicationStopFailures?: Boolean; + /** + * Information about the instances that belong to the replacement environment in a blue/green deployment. + */ + targetInstances?: TargetInstances; + /** + * Configuration information for an automatic rollback that is added when a deployment is created. + */ + autoRollbackConfiguration?: AutoRollbackConfiguration; + /** + * Indicates whether to deploy to all instances or only to instances that are not running the latest application revision. + */ + updateOutdatedInstancesOnly?: Boolean; + /** + * Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment. The fileExistsBehavior parameter takes any of the following values: DISALLOW: The deployment fails. This is also the default behavior if no option is specified. OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance. RETAIN: The version of the file already on the instance is kept and used as part of the new deployment. + */ + fileExistsBehavior?: FileExistsBehavior; + } + export interface CreateDeploymentOutput { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + } + export interface DeleteApplicationInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + } + export interface DeleteDeploymentConfigInput { + /** + * The name of a deployment configuration associated with the IAM user or AWS account. + */ + deploymentConfigName: DeploymentConfigName; + } + export interface DeleteDeploymentGroupInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * The name of a deployment group for the specified application. + */ + deploymentGroupName: DeploymentGroupName; + } + export interface DeleteDeploymentGroupOutput { + /** + * If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. + */ + hooksNotCleanedUp?: AutoScalingGroupList; + } + export interface DeleteGitHubAccountTokenInput { + /** + * The name of the GitHub account connection to delete. + */ + tokenName?: GitHubAccountTokenName; + } + export interface DeleteGitHubAccountTokenOutput { + /** + * The name of the GitHub account connection that was deleted. + */ + tokenName?: GitHubAccountTokenName; + } + export type DeploymentConfigId = string; + export interface DeploymentConfigInfo { + /** + * The deployment configuration ID. + */ + deploymentConfigId?: DeploymentConfigId; + /** + * The deployment configuration name. + */ + deploymentConfigName?: DeploymentConfigName; + /** + * Information about the number or percentage of minimum healthy instance. + */ + minimumHealthyHosts?: MinimumHealthyHosts; + /** + * The time at which the deployment configuration was created. + */ + createTime?: Timestamp; + /** + * The destination platform type for the deployment (Lambda or Server). + */ + computePlatform?: ComputePlatform; + /** + * The configuration that specifies how the deployment traffic is routed. Only deployments with a Lambda compute platform can specify this. + */ + trafficRoutingConfig?: TrafficRoutingConfig; + } + export type DeploymentConfigName = string; + export type DeploymentConfigsList = DeploymentConfigName[]; + export type DeploymentCreator = "user"|"autoscaling"|"codeDeployRollback"|string; + export type DeploymentGroupId = string; + export interface DeploymentGroupInfo { + /** + * The application name. + */ + applicationName?: ApplicationName; + /** + * The deployment group ID. + */ + deploymentGroupId?: DeploymentGroupId; + /** + * The deployment group name. + */ + deploymentGroupName?: DeploymentGroupName; + /** + * The deployment configuration name. + */ + deploymentConfigName?: DeploymentConfigName; + /** + * The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. + */ + ec2TagFilters?: EC2TagFilterList; + /** + * The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. + */ + onPremisesInstanceTagFilters?: TagFilterList; + /** + * A list of associated Auto Scaling groups. + */ + autoScalingGroups?: AutoScalingGroupList; + /** + * A service role ARN. + */ + serviceRoleArn?: Role; + /** + * Information about the deployment group's target revision, including type and location. + */ + targetRevision?: RevisionLocation; + /** + * Information about triggers associated with the deployment group. + */ + triggerConfigurations?: TriggerConfigList; + /** + * A list of alarms associated with the deployment group. + */ + alarmConfiguration?: AlarmConfiguration; + /** + * Information about the automatic rollback configuration associated with the deployment group. + */ + autoRollbackConfiguration?: AutoRollbackConfiguration; + /** + * Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer. + */ + deploymentStyle?: DeploymentStyle; + /** + * Information about blue/green deployment options for a deployment group. + */ + blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration; + /** + * Information about the load balancer to use in a deployment. + */ + loadBalancerInfo?: LoadBalancerInfo; + /** + * Information about the most recent successful deployment to the deployment group. + */ + lastSuccessfulDeployment?: LastDeploymentInfo; + /** + * Information about the most recent attempted deployment to the deployment group. + */ + lastAttemptedDeployment?: LastDeploymentInfo; + /** + * Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters. + */ + ec2TagSet?: EC2TagSet; + /** + * Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters. + */ + onPremisesTagSet?: OnPremisesTagSet; + /** + * The destination platform type for the deployment group (Lambda or Server). + */ + computePlatform?: ComputePlatform; + /** + * The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>. + */ + ecsServices?: ECSServiceList; + } + export type DeploymentGroupInfoList = DeploymentGroupInfo[]; + export type DeploymentGroupName = string; + export type DeploymentGroupsList = DeploymentGroupName[]; + export type DeploymentId = string; + export interface DeploymentInfo { + /** + * The application name. + */ + applicationName?: ApplicationName; + /** + * The deployment group name. + */ + deploymentGroupName?: DeploymentGroupName; + /** + * The deployment configuration name. + */ + deploymentConfigName?: DeploymentConfigName; + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * Information about the application revision that was deployed to the deployment group before the most recent successful deployment. + */ + previousRevision?: RevisionLocation; + /** + * Information about the location of stored application artifacts and the service from which to retrieve them. + */ + revision?: RevisionLocation; + /** + * The current state of the deployment as a whole. + */ + status?: DeploymentStatus; + /** + * Information about any error associated with this deployment. + */ + errorInformation?: ErrorInformation; + /** + * A timestamp that indicates when the deployment was created. + */ + createTime?: Timestamp; + /** + * A timestamp that indicates when the deployment was deployed to the deployment group. In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process. + */ + startTime?: Timestamp; + /** + * A timestamp that indicates when the deployment was complete. + */ + completeTime?: Timestamp; + /** + * A summary of the deployment status of the instances in the deployment. + */ + deploymentOverview?: DeploymentOverview; + /** + * A comment about the deployment. + */ + description?: Description; + /** + * The means by which the deployment was created: user: A user created the deployment. autoscaling: Amazon EC2 Auto Scaling created the deployment. codeDeployRollback: A rollback process created the deployment. + */ + creator?: DeploymentCreator; + /** + * If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop. If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored. + */ + ignoreApplicationStopFailures?: Boolean; + /** + * Information about the automatic rollback configuration associated with the deployment. + */ + autoRollbackConfiguration?: AutoRollbackConfiguration; + /** + * Indicates whether only instances that are not running the latest application revision are to be deployed to. + */ + updateOutdatedInstancesOnly?: Boolean; + /** + * Information about a deployment rollback. + */ + rollbackInfo?: RollbackInfo; + /** + * Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer. + */ + deploymentStyle?: DeploymentStyle; + /** + * Information about the instances that belong to the replacement environment in a blue/green deployment. + */ + targetInstances?: TargetInstances; + /** + * Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts. + */ + instanceTerminationWaitTimeStarted?: Boolean; + /** + * Information about blue/green deployment options for this deployment. + */ + blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration; + /** + * Information about the load balancer used in the deployment. + */ + loadBalancerInfo?: LoadBalancerInfo; + /** + * Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated. + */ + additionalDeploymentStatusInfo?: AdditionalDeploymentStatusInfo; + /** + * Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment. DISALLOW: The deployment fails. This is also the default behavior if no option is specified. OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance. RETAIN: The version of the file already on the instance is kept and used as part of the new deployment. + */ + fileExistsBehavior?: FileExistsBehavior; + /** + * Messages that contain information about the status of a deployment. + */ + deploymentStatusMessages?: DeploymentStatusMessageList; + /** + * The destination platform type for the deployment (Lambda or Server). + */ + computePlatform?: ComputePlatform; + } + export type DeploymentOption = "WITH_TRAFFIC_CONTROL"|"WITHOUT_TRAFFIC_CONTROL"|string; + export interface DeploymentOverview { + /** + * The number of instances in the deployment in a pending state. + */ + Pending?: InstanceCount; + /** + * The number of instances in which the deployment is in progress. + */ + InProgress?: InstanceCount; + /** + * The number of instances in the deployment to which revisions have been successfully deployed. + */ + Succeeded?: InstanceCount; + /** + * The number of instances in the deployment in a failed state. + */ + Failed?: InstanceCount; + /** + * The number of instances in the deployment in a skipped state. + */ + Skipped?: InstanceCount; + /** + * The number of instances in a replacement environment ready to receive traffic in a blue/green deployment. + */ + Ready?: InstanceCount; + } + export type DeploymentReadyAction = "CONTINUE_DEPLOYMENT"|"STOP_DEPLOYMENT"|string; + export interface DeploymentReadyOption { + /** + * Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment. CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment. STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped. + */ + actionOnTimeout?: DeploymentReadyAction; + /** + * The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout + */ + waitTimeInMinutes?: Duration; + } + export type DeploymentStatus = "Created"|"Queued"|"InProgress"|"Succeeded"|"Failed"|"Stopped"|"Ready"|string; + export type DeploymentStatusList = DeploymentStatus[]; + export type DeploymentStatusMessageList = ErrorMessage[]; + export interface DeploymentStyle { + /** + * Indicates whether to run an in-place deployment or a blue/green deployment. + */ + deploymentType?: DeploymentType; + /** + * Indicates whether to route deployment traffic behind a load balancer. + */ + deploymentOption?: DeploymentOption; + } + export interface DeploymentTarget { + /** + * The deployment type that is specific to the deployment's compute platform. + */ + deploymentTargetType?: DeploymentTargetType; + /** + * Information about the target for a deployment that uses the EC2/On-premises compute platform. + */ + instanceTarget?: InstanceTarget; + /** + * Information about the target for a deployment that uses the AWS Lambda compute platform. + */ + lambdaTarget?: LambdaTarget; + /** + * Information about the target for a deployment that uses the Amazon ECS compute platform. + */ + ecsTarget?: ECSTarget; + } + export type DeploymentTargetList = DeploymentTarget[]; + export type DeploymentTargetType = "InstanceTarget"|"LambdaTarget"|"ECSTarget"|string; + export type DeploymentType = "IN_PLACE"|"BLUE_GREEN"|string; + export type DeploymentWaitType = "READY_WAIT"|"TERMINATION_WAIT"|string; + export type DeploymentsInfoList = DeploymentInfo[]; + export type DeploymentsList = DeploymentId[]; + export interface DeregisterOnPremisesInstanceInput { + /** + * The name of the on-premises instance to deregister. + */ + instanceName: InstanceName; + } + export type Description = string; + export interface Diagnostics { + /** + * The associated error code: Success: The specified script ran. ScriptMissing: The specified script was not found in the specified location. ScriptNotExecutable: The specified script is not a recognized executable file type. ScriptTimedOut: The specified script did not finish running in the specified time period. ScriptFailed: The specified script failed to run as expected. UnknownError: The specified script did not run for an unknown reason. + */ + errorCode?: LifecycleErrorCode; + /** + * The name of the script. + */ + scriptName?: ScriptName; + /** + * The message associated with the error. + */ + message?: LifecycleMessage; + /** + * The last portion of the diagnostic log. If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log. + */ + logTail?: LogTail; + } + export type Duration = number; + export interface EC2TagFilter { + /** + * The tag filter key. + */ + Key?: Key; + /** + * The tag filter value. + */ + Value?: Value; + /** + * The tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value. + */ + Type?: EC2TagFilterType; + } + export type EC2TagFilterList = EC2TagFilter[]; + export type EC2TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string; + export interface EC2TagSet { + /** + * A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list. + */ + ec2TagSetList?: EC2TagSetList; + } + export type EC2TagSetList = EC2TagFilterList[]; + export type ECSClusterName = string; + export interface ECSService { + /** + * The name of the target Amazon ECS service. + */ + serviceName?: ECSServiceName; + /** + * The name of the cluster that the Amazon ECS service is associated with. + */ + clusterName?: ECSClusterName; + } + export type ECSServiceList = ECSService[]; + export type ECSServiceName = string; + export interface ECSTarget { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * The unique ID of a deployment target that has a type of ecsTarget. + */ + targetId?: TargetId; + /** + * The ARN of the target. + */ + targetArn?: TargetArn; + /** + * The date and time when the target Amazon ECS application was updated by a deployment. + */ + lastUpdatedAt?: Time; + /** + * The lifecycle events of the deployment to this target Amazon ECS application. + */ + lifecycleEvents?: LifecycleEventList; + /** + * The status an Amazon ECS deployment's target ECS application. + */ + status?: TargetStatus; + /** + * The ECSTaskSet objects associated with the ECS target. + */ + taskSetsInfo?: ECSTaskSetList; + } + export interface ECSTaskSet { + /** + * A unique ID of an ECSTaskSet. + */ + identifer?: ECSTaskSetIdentifier; + /** + * The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set. + */ + desiredCount?: ECSTaskSetCount; + /** + * The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state. + */ + pendingCount?: ECSTaskSetCount; + /** + * The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use. + */ + runningCount?: ECSTaskSetCount; + /** + * The status of the task set. There are three valid task set statuses: PRIMARY: Indicates the task set is serving production traffic. ACTIVE: Indicates the task set is not serving production traffic. DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. + */ + status?: ECSTaskSetStatus; + /** + * The percentage of traffic served by this task set. + */ + trafficWeight?: TrafficWeight; + /** + * The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a task set. + */ + targetGroup?: TargetGroupInfo; + /** + * A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN). + */ + taskSetLabel?: TargetLabel; + } + export type ECSTaskSetCount = number; + export type ECSTaskSetIdentifier = string; + export type ECSTaskSetList = ECSTaskSet[]; + export type ECSTaskSetStatus = string; + export interface ELBInfo { + /** + * For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. + */ + name?: ELBName; + } + export type ELBInfoList = ELBInfo[]; + export type ELBName = string; + export type ETag = string; + export type ErrorCode = "DEPLOYMENT_GROUP_MISSING"|"APPLICATION_MISSING"|"REVISION_MISSING"|"IAM_ROLE_MISSING"|"IAM_ROLE_PERMISSIONS"|"NO_EC2_SUBSCRIPTION"|"OVER_MAX_INSTANCES"|"NO_INSTANCES"|"TIMEOUT"|"HEALTH_CONSTRAINTS_INVALID"|"HEALTH_CONSTRAINTS"|"INTERNAL_ERROR"|"THROTTLED"|"ALARM_ACTIVE"|"AGENT_ISSUE"|"AUTO_SCALING_IAM_ROLE_PERMISSIONS"|"AUTO_SCALING_CONFIGURATION"|"MANUAL_STOP"|"MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION"|"MISSING_ELB_INFORMATION"|"MISSING_GITHUB_TOKEN"|"ELASTIC_LOAD_BALANCING_INVALID"|"ELB_INVALID_INSTANCE"|"INVALID_LAMBDA_CONFIGURATION"|"INVALID_LAMBDA_FUNCTION"|"HOOK_EXECUTION_FAILURE"|"AUTOSCALING_VALIDATION_ERROR"|"INVALID_ECS_SERVICE"|"ECS_UPDATE_ERROR"|"INVALID_REVISION"|string; + export interface ErrorInformation { + /** + * For more information, see Error Codes for AWS CodeDeploy in the AWS CodeDeploy User Guide. The error code: APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started. DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started. HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified. HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified. IAM_ROLE_MISSING: The service role cannot be accessed. IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions. INTERNAL_ERROR: There was an internal error. NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2. NO_INSTANCES: No instances were specified, or no instances can be found. OVER_MAX_INSTANCES: The maximum number of instances was exceeded. THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services. TIMEOUT: The deployment has timed out. REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started. + */ + code?: ErrorCode; + /** + * An accompanying error message. + */ + message?: ErrorMessage; + } + export type ErrorMessage = string; + export type FileExistsBehavior = "DISALLOW"|"OVERWRITE"|"RETAIN"|string; + export type FilterValue = string; + export type FilterValueList = FilterValue[]; + export interface GenericRevisionInfo { + /** + * A comment about the revision. + */ + description?: Description; + /** + * The deployment groups for which this is the current target revision. + */ + deploymentGroups?: DeploymentGroupsList; + /** + * When the revision was first used by AWS CodeDeploy. + */ + firstUsedTime?: Timestamp; + /** + * When the revision was last used by AWS CodeDeploy. + */ + lastUsedTime?: Timestamp; + /** + * When the revision was registered with AWS CodeDeploy. + */ + registerTime?: Timestamp; + } + export interface GetApplicationInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + } + export interface GetApplicationOutput { + /** + * Information about the application. + */ + application?: ApplicationInfo; + } + export interface GetApplicationRevisionInput { + /** + * The name of the application that corresponds to the revision. + */ + applicationName: ApplicationName; + /** + * Information about the application revision to get, including type and location. + */ + revision: RevisionLocation; + } + export interface GetApplicationRevisionOutput { + /** + * The name of the application that corresponds to the revision. + */ + applicationName?: ApplicationName; + /** + * Additional information about the revision, including type and location. + */ + revision?: RevisionLocation; + /** + * General information about the revision. + */ + revisionInfo?: GenericRevisionInfo; + } + export interface GetDeploymentConfigInput { + /** + * The name of a deployment configuration associated with the IAM user or AWS account. + */ + deploymentConfigName: DeploymentConfigName; + } + export interface GetDeploymentConfigOutput { + /** + * Information about the deployment configuration. + */ + deploymentConfigInfo?: DeploymentConfigInfo; + } + export interface GetDeploymentGroupInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * The name of a deployment group for the specified application. + */ + deploymentGroupName: DeploymentGroupName; + } + export interface GetDeploymentGroupOutput { + /** + * Information about the deployment group. + */ + deploymentGroupInfo?: DeploymentGroupInfo; + } + export interface GetDeploymentInput { + /** + * The unique ID of a deployment associated with the IAM user or AWS account. + */ + deploymentId: DeploymentId; + } + export interface GetDeploymentInstanceInput { + /** + * The unique ID of a deployment. + */ + deploymentId: DeploymentId; + /** + * The unique ID of an instance in the deployment group. + */ + instanceId: InstanceId; + } + export interface GetDeploymentInstanceOutput { + /** + * Information about the instance. + */ + instanceSummary?: InstanceSummary; + } + export interface GetDeploymentOutput { + /** + * Information about the deployment. + */ + deploymentInfo?: DeploymentInfo; + } + export interface GetDeploymentTargetInput { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * The unique ID of a deployment target. + */ + targetId?: TargetId; + } + export interface GetDeploymentTargetOutput { + /** + * A deployment target that contains information about a deployment such as its status, lifecyle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target's type (instanceTarget, lambdaTarget, or ecsTarget). + */ + deploymentTarget?: DeploymentTarget; + } + export interface GetOnPremisesInstanceInput { + /** + * The name of the on-premises instance about which to get information. + */ + instanceName: InstanceName; + } + export interface GetOnPremisesInstanceOutput { + /** + * Information about the on-premises instance. + */ + instanceInfo?: InstanceInfo; + } + export type GitHubAccountTokenName = string; + export type GitHubAccountTokenNameList = GitHubAccountTokenName[]; + export interface GitHubLocation { + /** + * The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. Specified as account/repository. + */ + repository?: Repository; + /** + * The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision. + */ + commitId?: CommitId; + } + export type GreenFleetProvisioningAction = "DISCOVER_EXISTING"|"COPY_AUTO_SCALING_GROUP"|string; + export interface GreenFleetProvisioningOption { + /** + * The method used to add instances to a replacement environment. DISCOVER_EXISTING: Use instances that already exist or will be created manually. COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group. + */ + action?: GreenFleetProvisioningAction; + } + export type IamSessionArn = string; + export type IamUserArn = string; + export type InstanceAction = "TERMINATE"|"KEEP_ALIVE"|string; + export type InstanceArn = string; + export type InstanceCount = number; + export type InstanceId = string; + export interface InstanceInfo { + /** + * The name of the on-premises instance. + */ + instanceName?: InstanceName; + /** + * The ARN of the IAM session associated with the on-premises instance. + */ + iamSessionArn?: IamSessionArn; + /** + * The IAM user ARN associated with the on-premises instance. + */ + iamUserArn?: IamUserArn; + /** + * The ARN of the on-premises instance. + */ + instanceArn?: InstanceArn; + /** + * The time at which the on-premises instance was registered. + */ + registerTime?: Timestamp; + /** + * If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered. + */ + deregisterTime?: Timestamp; + /** + * The tags currently associated with the on-premises instance. + */ + tags?: TagList; + } + export type InstanceInfoList = InstanceInfo[]; + export type InstanceName = string; + export type InstanceNameList = InstanceName[]; + export type InstanceStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|"Ready"|string; + export type InstanceStatusList = InstanceStatus[]; + export interface InstanceSummary { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * The instance ID. + */ + instanceId?: InstanceId; + /** + * The deployment status for this instance: Pending: The deployment is pending for this instance. In Progress: The deployment is in progress for this instance. Succeeded: The deployment has succeeded for this instance. Failed: The deployment has failed for this instance. Skipped: The deployment has been skipped for this instance. Unknown: The deployment status is unknown for this instance. + */ + status?: InstanceStatus; + /** + * A timestamp that indicaties when the instance information was last updated. + */ + lastUpdatedAt?: Timestamp; + /** + * A list of lifecycle events for this instance. + */ + lifecycleEvents?: LifecycleEventList; + /** + * Information about which environment an instance belongs to in a blue/green deployment. BLUE: The instance is part of the original environment. GREEN: The instance is part of the replacement environment. + */ + instanceType?: InstanceType; + } + export type InstanceSummaryList = InstanceSummary[]; + export interface InstanceTarget { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * The unique ID of a deployment target that has a type of instanceTarget. + */ + targetId?: TargetId; + /** + * The ARN of the target. + */ + targetArn?: TargetArn; + /** + * The status an EC2/On-premises deployment's target instance. + */ + status?: TargetStatus; + /** + * The date and time when the target instance was updated by a deployment. + */ + lastUpdatedAt?: Time; + /** + * The lifecycle events of the deployment to this target instance. + */ + lifecycleEvents?: LifecycleEventList; + /** + * A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN). + */ + instanceLabel?: TargetLabel; + } + export type InstanceType = "Blue"|"Green"|string; + export type InstanceTypeList = InstanceType[]; + export type InstancesList = InstanceId[]; + export type Key = string; + export interface LambdaTarget { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * The unique ID of a deployment target that has a type of lambdaTarget. + */ + targetId?: TargetId; + /** + * The ARN of the target. + */ + targetArn?: TargetArn; + /** + * The status an AWS Lambda deployment's target Lambda function. + */ + status?: TargetStatus; + /** + * The date and time when the target Lambda function was updated by a deployment. + */ + lastUpdatedAt?: Time; + /** + * The lifecycle events of the deployment to this target Lambda function. + */ + lifecycleEvents?: LifecycleEventList; + } + export interface LastDeploymentInfo { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * The status of the most recent deployment. + */ + status?: DeploymentStatus; + /** + * A timestamp that indicates when the most recent deployment to the deployment group was complete. + */ + endTime?: Timestamp; + /** + * A timestamp that indicates when the most recent deployment to the deployment group started. + */ + createTime?: Timestamp; + } + export type LifecycleErrorCode = "Success"|"ScriptMissing"|"ScriptNotExecutable"|"ScriptTimedOut"|"ScriptFailed"|"UnknownError"|string; + export interface LifecycleEvent { + /** + * The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService. + */ + lifecycleEventName?: LifecycleEventName; + /** + * Diagnostic information about the deployment lifecycle event. + */ + diagnostics?: Diagnostics; + /** + * A timestamp that indicates when the deployment lifecycle event started. + */ + startTime?: Timestamp; + /** + * A timestamp that indicates when the deployment lifecycle event ended. + */ + endTime?: Timestamp; + /** + * The deployment lifecycle event status: Pending: The deployment lifecycle event is pending. InProgress: The deployment lifecycle event is in progress. Succeeded: The deployment lifecycle event ran successfully. Failed: The deployment lifecycle event has failed. Skipped: The deployment lifecycle event has been skipped. Unknown: The deployment lifecycle event is unknown. + */ + status?: LifecycleEventStatus; + } + export type LifecycleEventHookExecutionId = string; + export type LifecycleEventList = LifecycleEvent[]; + export type LifecycleEventName = string; + export type LifecycleEventStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|string; + export type LifecycleMessage = string; + export interface ListApplicationRevisionsInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * The column name to use to sort the list results: registerTime: Sort by the time the revisions were registered with AWS CodeDeploy. firstUsedTime: Sort by the time the revisions were first used in a deployment. lastUsedTime: Sort by the time the revisions were last used in a deployment. If not specified or set to null, the results are returned in an arbitrary order. + */ + sortBy?: ApplicationRevisionSortBy; + /** + * The order in which to sort the list results: ascending: ascending order. descending: descending order. If not specified, the results are sorted in ascending order. If set to null, the results are sorted in an arbitrary order. + */ + sortOrder?: SortOrder; + /** + * An Amazon S3 bucket name to limit the search for revisions. If set to null, all of the user's buckets are searched. + */ + s3Bucket?: S3Bucket; + /** + * A key prefix for the set of Amazon S3 objects to limit the search for revisions. + */ + s3KeyPrefix?: S3Key; + /** + * Whether to list revisions based on whether the revision is the target revision of an deployment group: include: List revisions that are target revisions of a deployment group. exclude: Do not list revisions that are target revisions of a deployment group. ignore: List all revisions. + */ + deployed?: ListStateFilterAction; + /** + * An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list. + */ + nextToken?: NextToken; + } + export interface ListApplicationRevisionsOutput { + /** + * A list of locations that contain the matching revisions. + */ + revisions?: RevisionLocationList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list. + */ + nextToken?: NextToken; + } + export interface ListApplicationsInput { + /** + * An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list. + */ + nextToken?: NextToken; + } + export interface ListApplicationsOutput { + /** + * A list of application names. + */ + applications?: ApplicationsList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentConfigsInput { + /** + * An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentConfigsOutput { + /** + * A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime. + */ + deploymentConfigsList?: DeploymentConfigsList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentGroupsInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentGroupsOutput { + /** + * The application name. + */ + applicationName?: ApplicationName; + /** + * A list of deployment group names. + */ + deploymentGroups?: DeploymentGroupsList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentInstancesInput { + /** + * The unique ID of a deployment. + */ + deploymentId: DeploymentId; + /** + * An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list. + */ + nextToken?: NextToken; + /** + * A subset of instances to list by status: Pending: Include those instances with pending deployments. InProgress: Include those instances where deployments are still in progress. Succeeded: Include those instances with successful deployments. Failed: Include those instances with failed deployments. Skipped: Include those instances with skipped deployments. Unknown: Include those instances with deployments in an unknown state. + */ + instanceStatusFilter?: InstanceStatusList; + /** + * The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in the replacement environment ("GREEN"), for which you want to view instance information. + */ + instanceTypeFilter?: InstanceTypeList; + } + export interface ListDeploymentInstancesOutput { + /** + * A list of instance IDs. + */ + instancesList?: InstancesList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentTargetsInput { + /** + * The unique ID of a deployment. + */ + deploymentId?: DeploymentId; + /** + * A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list. + */ + nextToken?: NextToken; + /** + * A key used to filter the returned targets. + */ + targetFilters?: TargetFilters; + } + export interface ListDeploymentTargetsOutput { + /** + * The unique IDs of deployment targets. + */ + targetIds?: TargetIdList; + /** + * If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentsInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName?: ApplicationName; + /** + * The name of a deployment group for the specified application. + */ + deploymentGroupName?: DeploymentGroupName; + /** + * A subset of deployments to list by status: Created: Include created deployments in the resulting list. Queued: Include queued deployments in the resulting list. In Progress: Include in-progress deployments in the resulting list. Succeeded: Include successful deployments in the resulting list. Failed: Include failed deployments in the resulting list. Stopped: Include stopped deployments in the resulting list. + */ + includeOnlyStatuses?: DeploymentStatusList; + /** + * A time range (start and end) for returning a subset of the list of deployments. + */ + createTimeRange?: TimeRange; + /** + * An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list. + */ + nextToken?: NextToken; + } + export interface ListDeploymentsOutput { + /** + * A list of deployment IDs. + */ + deployments?: DeploymentsList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list. + */ + nextToken?: NextToken; + } + export interface ListGitHubAccountTokenNamesInput { + /** + * An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list. + */ + nextToken?: NextToken; + } + export interface ListGitHubAccountTokenNamesOutput { + /** + * A list of names of connections to GitHub accounts. + */ + tokenNameList?: GitHubAccountTokenNameList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames call to return the next set of names in the list. + */ + nextToken?: NextToken; + } + export interface ListOnPremisesInstancesInput { + /** + * The registration status of the on-premises instances: Deregistered: Include deregistered on-premises instances in the resulting list. Registered: Include registered on-premises instances in the resulting list. + */ + registrationStatus?: RegistrationStatus; + /** + * The on-premises instance tags that are used to restrict the on-premises instance names returned. + */ + tagFilters?: TagFilterList; + /** + * An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list. + */ + nextToken?: NextToken; + } + export interface ListOnPremisesInstancesOutput { + /** + * The list of matching on-premises instance names. + */ + instanceNames?: InstanceNameList; + /** + * If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list. + */ + nextToken?: NextToken; + } + export type ListStateFilterAction = "include"|"exclude"|"ignore"|string; + export type ListenerArn = string; + export type ListenerArnList = ListenerArn[]; + export interface LoadBalancerInfo { + /** + * An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers. Adding more than one load balancer to the array is not supported. + */ + elbInfoList?: ELBInfoList; + /** + * An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers. Adding more than one target group to the array is not supported. + */ + targetGroupInfoList?: TargetGroupInfoList; + /** + * The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one. + */ + targetGroupPairInfoList?: TargetGroupPairInfoList; + } + export type LogTail = string; + export type Message = string; + export interface MinimumHealthyHosts { + /** + * The minimum healthy instance value. + */ + value?: MinimumHealthyHostsValue; + /** + * The minimum healthy instance type: HOST_COUNT: The minimum number of healthy instance as an absolute value. FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment. In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails. In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful. For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide. + */ + type?: MinimumHealthyHostsType; + } + export type MinimumHealthyHostsType = "HOST_COUNT"|"FLEET_PERCENT"|string; + export type MinimumHealthyHostsValue = number; + export type NextToken = string; + export type NullableBoolean = boolean; + export interface OnPremisesTagSet { + /** + * A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list. + */ + onPremisesTagSetList?: OnPremisesTagSetList; + } + export type OnPremisesTagSetList = TagFilterList[]; + export type Percentage = number; + export interface PutLifecycleEventHookExecutionStatusInput { + /** + * The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event. + */ + deploymentId?: DeploymentId; + /** + * The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file. + */ + lifecycleEventHookExecutionId?: LifecycleEventHookExecutionId; + /** + * The result of a Lambda function that validates a deployment lifecycle event (Succeeded or Failed). + */ + status?: LifecycleEventStatus; + } + export interface PutLifecycleEventHookExecutionStatusOutput { + /** + * The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file. + */ + lifecycleEventHookExecutionId?: LifecycleEventHookExecutionId; + } + export interface RawString { + /** + * The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events. + */ + content?: RawStringContent; + /** + * The SHA256 hash value of the revision content. + */ + sha256?: RawStringSha256; + } + export type RawStringContent = string; + export type RawStringSha256 = string; + export interface RegisterApplicationRevisionInput { + /** + * The name of an AWS CodeDeploy application associated with the IAM user or AWS account. + */ + applicationName: ApplicationName; + /** + * A comment about the revision. + */ + description?: Description; + /** + * Information about the application revision to register, including type and location. + */ + revision: RevisionLocation; + } + export interface RegisterOnPremisesInstanceInput { + /** + * The name of the on-premises instance to register. + */ + instanceName: InstanceName; + /** + * The ARN of the IAM session to associate with the on-premises instance. + */ + iamSessionArn?: IamSessionArn; + /** + * The ARN of the IAM user to associate with the on-premises instance. + */ + iamUserArn?: IamUserArn; + } + export type RegistrationStatus = "Registered"|"Deregistered"|string; + export interface RemoveTagsFromOnPremisesInstancesInput { + /** + * The tag key-value pairs to remove from the on-premises instances. + */ + tags: TagList; + /** + * The names of the on-premises instances from which to remove tags. + */ + instanceNames: InstanceNameList; + } + export type Repository = string; + export interface RevisionInfo { + /** + * Information about the location and type of an application revision. + */ + revisionLocation?: RevisionLocation; + /** + * Information about an application revision, including usage details and associated deployment groups. + */ + genericRevisionInfo?: GenericRevisionInfo; + } + export type RevisionInfoList = RevisionInfo[]; + export interface RevisionLocation { + /** + * The type of application revision: S3: An application revision stored in Amazon S3. GitHub: An application revision stored in GitHub (EC2/On-premises deployments only). String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only). + */ + revisionType?: RevisionLocationType; + /** + * Information about the location of a revision stored in Amazon S3. + */ + s3Location?: S3Location; + /** + * Information about the location of application artifacts stored in GitHub. + */ + gitHubLocation?: GitHubLocation; + /** + * Information about the location of an AWS Lambda deployment revision stored as a RawString. + */ + string?: RawString; + /** + * The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString. + */ + appSpecContent?: AppSpecContent; + } + export type RevisionLocationList = RevisionLocation[]; + export type RevisionLocationType = "S3"|"GitHub"|"String"|"AppSpecContent"|string; + export type Role = string; + export interface RollbackInfo { + /** + * The ID of the deployment rollback. + */ + rollbackDeploymentId?: DeploymentId; + /** + * The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped. + */ + rollbackTriggeringDeploymentId?: DeploymentId; + /** + * Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded). + */ + rollbackMessage?: Description; + } + export type S3Bucket = string; + export type S3Key = string; + export interface S3Location { + /** + * The name of the Amazon S3 bucket where the application revision is stored. + */ + bucket?: S3Bucket; + /** + * The name of the Amazon S3 object that represents the bundled artifacts for the application revision. + */ + key?: S3Key; + /** + * The file type of the application revision. Must be one of the following: tar: A tar archive file. tgz: A compressed tar archive file. zip: A zip archive file. + */ + bundleType?: BundleType; + /** + * A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. If the version is not specified, the system uses the most recent version by default. + */ + version?: VersionId; + /** + * The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. If the ETag is not specified as an input parameter, ETag validation of the object is skipped. + */ + eTag?: ETag; + } + export type ScriptName = string; + export interface SkipWaitTimeForInstanceTerminationInput { + /** + * The unique ID of a blue/green deployment for which you want to skip the instance termination wait time. + */ + deploymentId?: DeploymentId; + } + export type SortOrder = "ascending"|"descending"|string; + export interface StopDeploymentInput { + /** + * The unique ID of a deployment. + */ + deploymentId: DeploymentId; + /** + * Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision. + */ + autoRollbackEnabled?: NullableBoolean; + } + export interface StopDeploymentOutput { + /** + * The status of the stop deployment operation: Pending: The stop operation is pending. Succeeded: The stop operation was successful. + */ + status?: StopStatus; + /** + * An accompanying status message. + */ + statusMessage?: Message; + } + export type StopStatus = "Pending"|"Succeeded"|string; + export interface Tag { + /** + * The tag's key. + */ + Key?: Key; + /** + * The tag's value. + */ + Value?: Value; + } + export interface TagFilter { + /** + * The on-premises instance tag filter key. + */ + Key?: Key; + /** + * The on-premises instance tag filter value. + */ + Value?: Value; + /** + * The on-premises instance tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value. + */ + Type?: TagFilterType; + } + export type TagFilterList = TagFilter[]; + export type TagFilterType = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"|string; + export type TagList = Tag[]; + export type TargetArn = string; + export type TargetFilterName = "TargetStatus"|"ServerInstanceLabel"|string; + export type TargetFilters = {[key: string]: FilterValueList}; + export interface TargetGroupInfo { + /** + * For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. + */ + name?: TargetGroupName; + } + export type TargetGroupInfoList = TargetGroupInfo[]; + export type TargetGroupName = string; + export interface TargetGroupPairInfo { + /** + * One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete. + */ + targetGroups?: TargetGroupInfoList; + /** + * The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete. + */ + prodTrafficRoute?: TrafficRoute; + /** + * An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment. + */ + testTrafficRoute?: TrafficRoute; + } + export type TargetGroupPairInfoList = TargetGroupPairInfo[]; + export type TargetId = string; + export type TargetIdList = TargetId[]; + export interface TargetInstances { + /** + * The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as ec2TagSet. + */ + tagFilters?: EC2TagFilterList; + /** + * The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment. + */ + autoScalingGroups?: AutoScalingGroupNameList; + /** + * Information about the groups of EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters. + */ + ec2TagSet?: EC2TagSet; + } + export type TargetLabel = "Blue"|"Green"|string; + export type TargetStatus = "Pending"|"InProgress"|"Succeeded"|"Failed"|"Skipped"|"Unknown"|"Ready"|string; + export type Time = Date; + export interface TimeBasedCanary { + /** + * The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment. + */ + canaryPercentage?: Percentage; + /** + * The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment. + */ + canaryInterval?: WaitTimeInMins; + } + export interface TimeBasedLinear { + /** + * The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment. + */ + linearPercentage?: Percentage; + /** + * The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment. + */ + linearInterval?: WaitTimeInMins; + } + export interface TimeRange { + /** + * The start time of the time range. Specify null to leave the start time open-ended. + */ + start?: Timestamp; + /** + * The end time of the time range. Specify null to leave the end time open-ended. + */ + end?: Timestamp; + } + export type Timestamp = Date; + export interface TrafficRoute { + /** + * The ARN of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one. + */ + listenerArns?: ListenerArnList; + } + export interface TrafficRoutingConfig { + /** + * The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration . + */ + type?: TrafficRoutingType; + /** + * A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file. + */ + timeBasedCanary?: TimeBasedCanary; + /** + * A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file. + */ + timeBasedLinear?: TimeBasedLinear; + } + export type TrafficRoutingType = "TimeBasedCanary"|"TimeBasedLinear"|"AllAtOnce"|string; + export type TrafficWeight = number; + export interface TriggerConfig { + /** + * The name of the notification trigger. + */ + triggerName?: TriggerName; + /** + * The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent. + */ + triggerTargetArn?: TriggerTargetArn; + /** + * The event type or types for which notifications are triggered. + */ + triggerEvents?: TriggerEventTypeList; + } + export type TriggerConfigList = TriggerConfig[]; + export type TriggerEventType = "DeploymentStart"|"DeploymentSuccess"|"DeploymentFailure"|"DeploymentStop"|"DeploymentRollback"|"DeploymentReady"|"InstanceStart"|"InstanceSuccess"|"InstanceFailure"|"InstanceReady"|string; + export type TriggerEventTypeList = TriggerEventType[]; + export type TriggerName = string; + export type TriggerTargetArn = string; + export interface UpdateApplicationInput { + /** + * The current name of the application you want to change. + */ + applicationName?: ApplicationName; + /** + * The new name to give the application. + */ + newApplicationName?: ApplicationName; + } + export interface UpdateDeploymentGroupInput { + /** + * The application name that corresponds to the deployment group to update. + */ + applicationName: ApplicationName; + /** + * The current name of the deployment group. + */ + currentDeploymentGroupName: DeploymentGroupName; + /** + * The new name of the deployment group, if you want to change it. + */ + newDeploymentGroupName?: DeploymentGroupName; + /** + * The replacement deployment configuration name to use, if you want to change it. + */ + deploymentConfigName?: DeploymentConfigName; + /** + * The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names. + */ + ec2TagFilters?: EC2TagFilterList; + /** + * The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names. + */ + onPremisesInstanceTagFilters?: TagFilterList; + /** + * The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names. + */ + autoScalingGroups?: AutoScalingGroupNameList; + /** + * A replacement ARN for the service role, if you want to change it. + */ + serviceRoleArn?: Role; + /** + * Information about triggers to change when the deployment group is updated. For examples, see Modify Triggers in an AWS CodeDeploy Deployment Group in the AWS CodeDeploy User Guide. + */ + triggerConfigurations?: TriggerConfigList; + /** + * Information to add or change about Amazon CloudWatch alarms when the deployment group is updated. + */ + alarmConfiguration?: AlarmConfiguration; + /** + * Information for an automatic rollback configuration that is added or changed when a deployment group is updated. + */ + autoRollbackConfiguration?: AutoRollbackConfiguration; + /** + * Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer. + */ + deploymentStyle?: DeploymentStyle; + /** + * Information about blue/green deployment options for a deployment group. + */ + blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration; + /** + * Information about the load balancer used in a deployment. + */ + loadBalancerInfo?: LoadBalancerInfo; + /** + * Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups. + */ + ec2TagSet?: EC2TagSet; + /** + * The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>. + */ + ecsServices?: ECSServiceList; + /** + * Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups. + */ + onPremisesTagSet?: OnPremisesTagSet; + } + export interface UpdateDeploymentGroupOutput { + /** + * If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account. + */ + hooksNotCleanedUp?: AutoScalingGroupList; + } + export type Value = string; + export type VersionId = string; + export type WaitTimeInMins = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-10-06"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CodeDeploy client. + */ + export import Types = CodeDeploy; +} +export = CodeDeploy; diff --git a/node_modules/aws-sdk/clients/codedeploy.js b/node_modules/aws-sdk/clients/codedeploy.js new file mode 100644 index 0000000..4aed9dc --- /dev/null +++ b/node_modules/aws-sdk/clients/codedeploy.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['codedeploy'] = {}; +AWS.CodeDeploy = Service.defineService('codedeploy', ['2014-10-06']); +Object.defineProperty(apiLoader.services['codedeploy'], '2014-10-06', { + get: function get() { + var model = require('../apis/codedeploy-2014-10-06.min.json'); + model.paginators = require('../apis/codedeploy-2014-10-06.paginators.json').pagination; + model.waiters = require('../apis/codedeploy-2014-10-06.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CodeDeploy; diff --git a/node_modules/aws-sdk/clients/codepipeline.d.ts b/node_modules/aws-sdk/clients/codepipeline.d.ts new file mode 100644 index 0000000..1a40414 --- /dev/null +++ b/node_modules/aws-sdk/clients/codepipeline.d.ts @@ -0,0 +1,1911 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CodePipeline extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CodePipeline.Types.ClientConfiguration) + config: Config & CodePipeline.Types.ClientConfiguration; + /** + * Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. + */ + acknowledgeJob(params: CodePipeline.Types.AcknowledgeJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request; + /** + * Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. + */ + acknowledgeJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request; + /** + * Confirms a job worker has received the specified job. Only used for partner actions. + */ + acknowledgeThirdPartyJob(params: CodePipeline.Types.AcknowledgeThirdPartyJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request; + /** + * Confirms a job worker has received the specified job. Only used for partner actions. + */ + acknowledgeThirdPartyJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request; + /** + * Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. + */ + createCustomActionType(params: CodePipeline.Types.CreateCustomActionTypeInput, callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request; + /** + * Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. + */ + createCustomActionType(callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request; + /** + * Creates a pipeline. + */ + createPipeline(params: CodePipeline.Types.CreatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request; + /** + * Creates a pipeline. + */ + createPipeline(callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request; + /** + * Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field. + */ + deleteCustomActionType(params: CodePipeline.Types.DeleteCustomActionTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field. + */ + deleteCustomActionType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified pipeline. + */ + deletePipeline(params: CodePipeline.Types.DeletePipelineInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified pipeline. + */ + deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL. + */ + deleteWebhook(params: CodePipeline.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request; + /** + * Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL. + */ + deleteWebhook(callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request; + /** + * Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently only supported for webhooks that target an action type of GitHub. + */ + deregisterWebhookWithThirdParty(params: CodePipeline.Types.DeregisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request; + /** + * Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently only supported for webhooks that target an action type of GitHub. + */ + deregisterWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request; + /** + * Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. + */ + disableStageTransition(params: CodePipeline.Types.DisableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. + */ + disableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables artifacts in a pipeline to transition to a stage in a pipeline. + */ + enableStageTransition(params: CodePipeline.Types.EnableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables artifacts in a pipeline to transition to a stage in a pipeline. + */ + enableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns information about a job. Only used for custom actions. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. + */ + getJobDetails(params: CodePipeline.Types.GetJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request; + /** + * Returns information about a job. Only used for custom actions. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. + */ + getJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request; + /** + * Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline. + */ + getPipeline(params: CodePipeline.Types.GetPipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request; + /** + * Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline. + */ + getPipeline(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request; + /** + * Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline. + */ + getPipelineExecution(params: CodePipeline.Types.GetPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request; + /** + * Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline. + */ + getPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request; + /** + * Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state. + */ + getPipelineState(params: CodePipeline.Types.GetPipelineStateInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request; + /** + * Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state. + */ + getPipelineState(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request; + /** + * Requests the details of a job for a third party action. Only used for partner actions. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. + */ + getThirdPartyJobDetails(params: CodePipeline.Types.GetThirdPartyJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request; + /** + * Requests the details of a job for a third party action. Only used for partner actions. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. + */ + getThirdPartyJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request; + /** + * Lists the action executions that have occurred in a pipeline. + */ + listActionExecutions(params: CodePipeline.Types.ListActionExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request; + /** + * Lists the action executions that have occurred in a pipeline. + */ + listActionExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request; + /** + * Gets a summary of all AWS CodePipeline action types associated with your account. + */ + listActionTypes(params: CodePipeline.Types.ListActionTypesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request; + /** + * Gets a summary of all AWS CodePipeline action types associated with your account. + */ + listActionTypes(callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request; + /** + * Gets a summary of the most recent executions for a pipeline. + */ + listPipelineExecutions(params: CodePipeline.Types.ListPipelineExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request; + /** + * Gets a summary of the most recent executions for a pipeline. + */ + listPipelineExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request; + /** + * Gets a summary of all of the pipelines associated with your account. + */ + listPipelines(params: CodePipeline.Types.ListPipelinesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request; + /** + * Gets a summary of all of the pipelines associated with your account. + */ + listPipelines(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request; + /** + * Gets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook. + */ + listWebhooks(params: CodePipeline.Types.ListWebhooksInput, callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request; + /** + * Gets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook. + */ + listWebhooks(callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request; + /** + * Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. + */ + pollForJobs(params: CodePipeline.Types.PollForJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request; + /** + * Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. + */ + pollForJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request; + /** + * Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. + */ + pollForThirdPartyJobs(params: CodePipeline.Types.PollForThirdPartyJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request; + /** + * Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. + */ + pollForThirdPartyJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request; + /** + * Provides information to AWS CodePipeline about new revisions to a source. + */ + putActionRevision(params: CodePipeline.Types.PutActionRevisionInput, callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request; + /** + * Provides information to AWS CodePipeline about new revisions to a source. + */ + putActionRevision(callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request; + /** + * Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected. + */ + putApprovalResult(params: CodePipeline.Types.PutApprovalResultInput, callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request; + /** + * Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected. + */ + putApprovalResult(callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request; + /** + * Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. + */ + putJobFailureResult(params: CodePipeline.Types.PutJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. + */ + putJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. + */ + putJobSuccessResult(params: CodePipeline.Types.PutJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. + */ + putJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. + */ + putThirdPartyJobFailureResult(params: CodePipeline.Types.PutThirdPartyJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. + */ + putThirdPartyJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. + */ + putThirdPartyJobSuccessResult(params: CodePipeline.Types.PutThirdPartyJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. + */ + putThirdPartyJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL. + */ + putWebhook(params: CodePipeline.Types.PutWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request; + /** + * Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL. + */ + putWebhook(callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request; + /** + * Configures a connection between the webhook that was created and the external tool with events to be detected. + */ + registerWebhookWithThirdParty(params: CodePipeline.Types.RegisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request; + /** + * Configures a connection between the webhook that was created and the external tool with events to be detected. + */ + registerWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request; + /** + * Resumes the pipeline execution by retrying the last failed actions in a stage. + */ + retryStageExecution(params: CodePipeline.Types.RetryStageExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request; + /** + * Resumes the pipeline execution by retrying the last failed actions in a stage. + */ + retryStageExecution(callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request; + /** + * Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. + */ + startPipelineExecution(params: CodePipeline.Types.StartPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request; + /** + * Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. + */ + startPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request; + /** + * Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. + */ + updatePipeline(params: CodePipeline.Types.UpdatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request; + /** + * Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. + */ + updatePipeline(callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request; +} +declare namespace CodePipeline { + export type AWSRegionName = string; + export interface AWSSessionCredentials { + /** + * The access key for the session. + */ + accessKeyId: AccessKeyId; + /** + * The secret access key for the session. + */ + secretAccessKey: SecretAccessKey; + /** + * The token for the session. + */ + sessionToken: SessionToken; + } + export type AccessKeyId = string; + export type AccountId = string; + export interface AcknowledgeJobInput { + /** + * The unique system-generated ID of the job for which you want to confirm receipt. + */ + jobId: JobId; + /** + * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job. + */ + nonce: Nonce; + } + export interface AcknowledgeJobOutput { + /** + * Whether the job worker has received the specified job. + */ + status?: JobStatus; + } + export interface AcknowledgeThirdPartyJobInput { + /** + * The unique system-generated ID of the job. + */ + jobId: ThirdPartyJobId; + /** + * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request. + */ + nonce: Nonce; + /** + * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. + */ + clientToken: ClientToken; + } + export interface AcknowledgeThirdPartyJobOutput { + /** + * The status information for the third party job, if any. + */ + status?: JobStatus; + } + export type ActionCategory = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval"|string; + export interface ActionConfiguration { + /** + * The configuration data for the action. + */ + configuration?: ActionConfigurationMap; + } + export type ActionConfigurationKey = string; + export type ActionConfigurationMap = {[key: string]: ActionConfigurationValue}; + export interface ActionConfigurationProperty { + /** + * The name of the action configuration property. + */ + name: ActionConfigurationKey; + /** + * Whether the configuration property is a required value. + */ + required: Boolean; + /** + * Whether the configuration property is a key. + */ + key: Boolean; + /** + * Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret. + */ + secret: Boolean; + /** + * Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens. + */ + queryable?: Boolean; + /** + * The description of the action configuration property that will be displayed to users. + */ + description?: Description; + /** + * The type of the configuration property. + */ + type?: ActionConfigurationPropertyType; + } + export type ActionConfigurationPropertyList = ActionConfigurationProperty[]; + export type ActionConfigurationPropertyType = "String"|"Number"|"Boolean"|string; + export type ActionConfigurationQueryableValue = string; + export type ActionConfigurationValue = string; + export interface ActionContext { + /** + * The name of the action within the context of a job. + */ + name?: ActionName; + /** + * The system-generated unique ID that corresponds to an action's execution. + */ + actionExecutionId?: ActionExecutionId; + } + export interface ActionDeclaration { + /** + * The action declaration's name. + */ + name: ActionName; + /** + * The configuration information for the action type. + */ + actionTypeId: ActionTypeId; + /** + * The order in which actions are run. + */ + runOrder?: ActionRunOrder; + /** + * The action declaration's configuration. + */ + configuration?: ActionConfigurationMap; + /** + * The name or ID of the result of the action declaration, such as a test or build artifact. + */ + outputArtifacts?: OutputArtifactList; + /** + * The name or ID of the artifact consumed by the action, such as a test or build artifact. + */ + inputArtifacts?: InputArtifactList; + /** + * The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline. + */ + roleArn?: RoleArn; + /** + * The action declaration's AWS Region, such as us-east-1. + */ + region?: AWSRegionName; + } + export interface ActionExecution { + /** + * The status of the action, or for a completed action, the last status of the action. + */ + status?: ActionExecutionStatus; + /** + * A summary of the run of the action. + */ + summary?: ExecutionSummary; + /** + * The last status change of the action. + */ + lastStatusChange?: Timestamp; + /** + * The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid. + */ + token?: ActionExecutionToken; + /** + * The ARN of the user who last changed the pipeline. + */ + lastUpdatedBy?: LastUpdatedBy; + /** + * The external ID of the run of the action. + */ + externalExecutionId?: ExecutionId; + /** + * The URL of a resource external to AWS that will be used when running the action, for example an external repository URL. + */ + externalExecutionUrl?: Url; + /** + * A percentage of completeness of the action as it runs. + */ + percentComplete?: Percentage; + /** + * The details of an error returned by a URL external to AWS. + */ + errorDetails?: ErrorDetails; + } + export interface ActionExecutionDetail { + /** + * The pipeline execution ID for the action execution. + */ + pipelineExecutionId?: PipelineExecutionId; + /** + * The action execution ID. + */ + actionExecutionId?: ActionExecutionId; + /** + * The version of the pipeline where the action was run. + */ + pipelineVersion?: PipelineVersion; + /** + * The name of the stage that contains the action. + */ + stageName?: StageName; + /** + * The name of the action. + */ + actionName?: ActionName; + /** + * The start time of the action execution. + */ + startTime?: Timestamp; + /** + * The last update time of the action execution. + */ + lastUpdateTime?: Timestamp; + /** + * The status of the action execution. Status categories are InProgress, Succeeded, and Failed. + */ + status?: ActionExecutionStatus; + /** + * Input details for the action execution, such as role ARN, Region, and input artifacts. + */ + input?: ActionExecutionInput; + /** + * Output details for the action execution, such as the action execution result. + */ + output?: ActionExecutionOutput; + } + export type ActionExecutionDetailList = ActionExecutionDetail[]; + export interface ActionExecutionFilter { + /** + * The pipeline execution ID used to filter action execution history. + */ + pipelineExecutionId?: PipelineExecutionId; + } + export type ActionExecutionId = string; + export interface ActionExecutionInput { + actionTypeId?: ActionTypeId; + /** + * Configuration data for an action execution. + */ + configuration?: ActionConfigurationMap; + /** + * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline. + */ + roleArn?: RoleArn; + /** + * The AWS Region for the action, such as us-east-1. + */ + region?: AWSRegionName; + /** + * Details of input artifacts of the action that correspond to the action execution. + */ + inputArtifacts?: ArtifactDetailList; + } + export interface ActionExecutionOutput { + /** + * Details of output artifacts of the action that correspond to the action execution. + */ + outputArtifacts?: ArtifactDetailList; + /** + * Execution result information listed in the output details for an action execution. + */ + executionResult?: ActionExecutionResult; + } + export interface ActionExecutionResult { + /** + * The action provider's external ID for the action execution. + */ + externalExecutionId?: ExternalExecutionId; + /** + * The action provider's summary for the action execution. + */ + externalExecutionSummary?: ExternalExecutionSummary; + /** + * The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action. + */ + externalExecutionUrl?: Url; + } + export type ActionExecutionStatus = "InProgress"|"Succeeded"|"Failed"|string; + export type ActionExecutionToken = string; + export type ActionName = string; + export type ActionOwner = "AWS"|"ThirdParty"|"Custom"|string; + export type ActionProvider = string; + export interface ActionRevision { + /** + * The system-generated unique ID that identifies the revision number of the action. + */ + revisionId: Revision; + /** + * The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp. + */ + revisionChangeId: RevisionChangeIdentifier; + /** + * The date and time when the most recent version of the action was created, in timestamp format. + */ + created: Timestamp; + } + export type ActionRunOrder = number; + export interface ActionState { + /** + * The name of the action. + */ + actionName?: ActionName; + /** + * Represents information about the version (or revision) of an action. + */ + currentRevision?: ActionRevision; + /** + * Represents information about the run of an action. + */ + latestExecution?: ActionExecution; + /** + * A URL link for more information about the state of the action, such as a deployment group details page. + */ + entityUrl?: Url; + /** + * A URL link for more information about the revision, such as a commit details page. + */ + revisionUrl?: Url; + } + export type ActionStateList = ActionState[]; + export interface ActionType { + /** + * Represents information about an action type. + */ + id: ActionTypeId; + /** + * The settings for the action type. + */ + settings?: ActionTypeSettings; + /** + * The configuration properties for the action type. + */ + actionConfigurationProperties?: ActionConfigurationPropertyList; + /** + * The details of the input artifact for the action, such as its commit ID. + */ + inputArtifactDetails: ArtifactDetails; + /** + * The details of the output artifact of the action, such as its commit ID. + */ + outputArtifactDetails: ArtifactDetails; + } + export interface ActionTypeId { + /** + * A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. + */ + category: ActionCategory; + /** + * The creator of the action being called. + */ + owner: ActionOwner; + /** + * The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline. + */ + provider: ActionProvider; + /** + * A string that describes the action version. + */ + version: Version; + } + export type ActionTypeList = ActionType[]; + export interface ActionTypeSettings { + /** + * The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service. + */ + thirdPartyConfigurationUrl?: Url; + /** + * The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline. + */ + entityUrlTemplate?: UrlTemplate; + /** + * The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. + */ + executionUrlTemplate?: UrlTemplate; + /** + * The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. + */ + revisionUrlTemplate?: UrlTemplate; + } + export interface ApprovalResult { + /** + * The summary of the current status of the approval request. + */ + summary: ApprovalSummary; + /** + * The response submitted by a reviewer assigned to an approval action request. + */ + status: ApprovalStatus; + } + export type ApprovalStatus = "Approved"|"Rejected"|string; + export type ApprovalSummary = string; + export type ApprovalToken = string; + export interface Artifact { + /** + * The artifact's name. + */ + name?: ArtifactName; + /** + * The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3). + */ + revision?: Revision; + /** + * The location of an artifact. + */ + location?: ArtifactLocation; + } + export interface ArtifactDetail { + /** + * The artifact object name for the action execution. + */ + name?: ArtifactName; + /** + * The Amazon S3 artifact location for the action execution. + */ + s3location?: S3Location; + } + export type ArtifactDetailList = ArtifactDetail[]; + export interface ArtifactDetails { + /** + * The minimum number of artifacts allowed for the action type. + */ + minimumCount: MinimumArtifactCount; + /** + * The maximum number of artifacts allowed for the action type. + */ + maximumCount: MaximumArtifactCount; + } + export type ArtifactList = Artifact[]; + export interface ArtifactLocation { + /** + * The type of artifact in the location. + */ + type?: ArtifactLocationType; + /** + * The Amazon S3 bucket that contains the artifact. + */ + s3Location?: S3ArtifactLocation; + } + export type ArtifactLocationType = "S3"|string; + export type ArtifactName = string; + export interface ArtifactRevision { + /** + * The name of an artifact. This name might be system-generated, such as "MyApp", or might be defined by the user when an action is created. + */ + name?: ArtifactName; + /** + * The revision ID of the artifact. + */ + revisionId?: Revision; + /** + * An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value. + */ + revisionChangeIdentifier?: RevisionChangeIdentifier; + /** + * Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata. + */ + revisionSummary?: RevisionSummary; + /** + * The date and time when the most recent revision of the artifact was created, in timestamp format. + */ + created?: Timestamp; + /** + * The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page. + */ + revisionUrl?: Url; + } + export type ArtifactRevisionList = ArtifactRevision[]; + export interface ArtifactStore { + /** + * The type of the artifact store, such as S3. + */ + type: ArtifactStoreType; + /** + * The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts. + */ + location: ArtifactStoreLocation; + /** + * The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used. + */ + encryptionKey?: EncryptionKey; + } + export type ArtifactStoreLocation = string; + export type ArtifactStoreMap = {[key: string]: ArtifactStore}; + export type ArtifactStoreType = "S3"|string; + export interface BlockerDeclaration { + /** + * Reserved for future use. + */ + name: BlockerName; + /** + * Reserved for future use. + */ + type: BlockerType; + } + export type BlockerName = string; + export type BlockerType = "Schedule"|string; + export type Boolean = boolean; + export type ClientId = string; + export type ClientRequestToken = string; + export type ClientToken = string; + export type Code = string; + export type ContinuationToken = string; + export interface CreateCustomActionTypeInput { + /** + * The category of the custom action, such as a build action or a test action. Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use. + */ + category: ActionCategory; + /** + * The provider of the service used in the custom action, such as AWS CodeDeploy. + */ + provider: ActionProvider; + /** + * The version identifier of the custom action. + */ + version: Version; + /** + * URLs that provide users information about this custom action. + */ + settings?: ActionTypeSettings; + /** + * The configuration properties for the custom action. You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline. + */ + configurationProperties?: ActionConfigurationPropertyList; + /** + * The details of the input artifact for the action, such as its commit ID. + */ + inputArtifactDetails: ArtifactDetails; + /** + * The details of the output artifact of the action, such as its commit ID. + */ + outputArtifactDetails: ArtifactDetails; + } + export interface CreateCustomActionTypeOutput { + /** + * Returns information about the details of an action type. + */ + actionType: ActionType; + } + export interface CreatePipelineInput { + /** + * Represents the structure of actions and stages to be performed in the pipeline. + */ + pipeline: PipelineDeclaration; + } + export interface CreatePipelineOutput { + /** + * Represents the structure of actions and stages to be performed in the pipeline. + */ + pipeline?: PipelineDeclaration; + } + export interface CurrentRevision { + /** + * The revision ID of the current version of an artifact. + */ + revision: Revision; + /** + * The change identifier for the current revision. + */ + changeIdentifier: RevisionChangeIdentifier; + /** + * The date and time when the most recent revision of the artifact was created, in timestamp format. + */ + created?: Time; + /** + * The summary of the most recent revision of the artifact. + */ + revisionSummary?: RevisionSummary; + } + export interface DeleteCustomActionTypeInput { + /** + * The category of the custom action that you want to delete, such as source or deploy. + */ + category: ActionCategory; + /** + * The provider of the service used in the custom action, such as AWS CodeDeploy. + */ + provider: ActionProvider; + /** + * The version of the custom action to delete. + */ + version: Version; + } + export interface DeletePipelineInput { + /** + * The name of the pipeline to be deleted. + */ + name: PipelineName; + } + export interface DeleteWebhookInput { + /** + * The name of the webhook you want to delete. + */ + name: WebhookName; + } + export interface DeleteWebhookOutput { + } + export interface DeregisterWebhookWithThirdPartyInput { + /** + * The name of the webhook you want to deregister. + */ + webhookName?: WebhookName; + } + export interface DeregisterWebhookWithThirdPartyOutput { + } + export type Description = string; + export interface DisableStageTransitionInput { + /** + * The name of the pipeline in which you want to disable the flow of artifacts from one stage to another. + */ + pipelineName: PipelineName; + /** + * The name of the stage where you want to disable the inbound or outbound transition of artifacts. + */ + stageName: StageName; + /** + * Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound). + */ + transitionType: StageTransitionType; + /** + * The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI. + */ + reason: DisabledReason; + } + export type DisabledReason = string; + export interface EnableStageTransitionInput { + /** + * The name of the pipeline in which you want to enable the flow of artifacts from one stage to another. + */ + pipelineName: PipelineName; + /** + * The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound). + */ + stageName: StageName; + /** + * Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound). + */ + transitionType: StageTransitionType; + } + export type Enabled = boolean; + export interface EncryptionKey { + /** + * The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN. + */ + id: EncryptionKeyId; + /** + * The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'. + */ + type: EncryptionKeyType; + } + export type EncryptionKeyId = string; + export type EncryptionKeyType = "KMS"|string; + export interface ErrorDetails { + /** + * The system ID or error number code of the error. + */ + code?: Code; + /** + * The text of the error message. + */ + message?: Message; + } + export interface ExecutionDetails { + /** + * The summary of the current status of the actions. + */ + summary?: ExecutionSummary; + /** + * The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy. + */ + externalExecutionId?: ExecutionId; + /** + * The percentage of work completed on the action, represented on a scale of zero to one hundred percent. + */ + percentComplete?: Percentage; + } + export type ExecutionId = string; + export type ExecutionSummary = string; + export type ExternalExecutionId = string; + export type ExternalExecutionSummary = string; + export interface FailureDetails { + /** + * The type of the failure. + */ + type: FailureType; + /** + * The message about the failure. + */ + message: Message; + /** + * The external ID of the run of the action that failed. + */ + externalExecutionId?: ExecutionId; + } + export type FailureType = "JobFailed"|"ConfigurationError"|"PermissionError"|"RevisionOutOfSync"|"RevisionUnavailable"|"SystemUnavailable"|string; + export interface GetJobDetailsInput { + /** + * The unique system-generated ID for the job. + */ + jobId: JobId; + } + export interface GetJobDetailsOutput { + /** + * The details of the job. If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials. + */ + jobDetails?: JobDetails; + } + export interface GetPipelineExecutionInput { + /** + * The name of the pipeline about which you want to get execution details. + */ + pipelineName: PipelineName; + /** + * The ID of the pipeline execution about which you want to get execution details. + */ + pipelineExecutionId: PipelineExecutionId; + } + export interface GetPipelineExecutionOutput { + /** + * Represents information about the execution of a pipeline. + */ + pipelineExecution?: PipelineExecution; + } + export interface GetPipelineInput { + /** + * The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account. + */ + name: PipelineName; + /** + * The version number of the pipeline. If you do not specify a version, defaults to the most current version. + */ + version?: PipelineVersion; + } + export interface GetPipelineOutput { + /** + * Represents the structure of actions and stages to be performed in the pipeline. + */ + pipeline?: PipelineDeclaration; + /** + * Represents the pipeline metadata information returned as part of the output of a GetPipeline action. + */ + metadata?: PipelineMetadata; + } + export interface GetPipelineStateInput { + /** + * The name of the pipeline about which you want to get information. + */ + name: PipelineName; + } + export interface GetPipelineStateOutput { + /** + * The name of the pipeline for which you want to get the state. + */ + pipelineName?: PipelineName; + /** + * The version number of the pipeline. A newly-created pipeline is always assigned a version number of 1. + */ + pipelineVersion?: PipelineVersion; + /** + * A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data. + */ + stageStates?: StageStateList; + /** + * The date and time the pipeline was created, in timestamp format. + */ + created?: Timestamp; + /** + * The date and time the pipeline was last updated, in timestamp format. + */ + updated?: Timestamp; + } + export interface GetThirdPartyJobDetailsInput { + /** + * The unique system-generated ID used for identifying the job. + */ + jobId: ThirdPartyJobId; + /** + * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. + */ + clientToken: ClientToken; + } + export interface GetThirdPartyJobDetailsOutput { + /** + * The details of the job, including any protected values defined for the job. + */ + jobDetails?: ThirdPartyJobDetails; + } + export interface InputArtifact { + /** + * The name of the artifact to be worked on, for example, "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. + */ + name: ArtifactName; + } + export type InputArtifactList = InputArtifact[]; + export interface Job { + /** + * The unique system-generated ID of the job. + */ + id?: JobId; + /** + * Additional data about a job. + */ + data?: JobData; + /** + * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request. + */ + nonce?: Nonce; + /** + * The ID of the AWS account to use when performing the job. + */ + accountId?: AccountId; + } + export interface JobData { + /** + * Represents information about an action type. + */ + actionTypeId?: ActionTypeId; + /** + * Represents information about an action configuration. + */ + actionConfiguration?: ActionConfiguration; + /** + * Represents information about a pipeline to a job worker. Includes pipelineArn and pipelineExecutionId for Custom jobs. + */ + pipelineContext?: PipelineContext; + /** + * The artifact supplied to the job. + */ + inputArtifacts?: ArtifactList; + /** + * The output of the job. + */ + outputArtifacts?: ArtifactList; + /** + * Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifacts for the pipeline in AWS CodePipeline. + */ + artifactCredentials?: AWSSessionCredentials; + /** + * A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously. + */ + continuationToken?: ContinuationToken; + /** + * Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. + */ + encryptionKey?: EncryptionKey; + } + export interface JobDetails { + /** + * The unique system-generated ID of the job. + */ + id?: JobId; + /** + * Represents additional information about a job required for a job worker to complete the job. + */ + data?: JobData; + /** + * The AWS account ID associated with the job. + */ + accountId?: AccountId; + } + export type JobId = string; + export type JobList = Job[]; + export type JobStatus = "Created"|"Queued"|"Dispatched"|"InProgress"|"TimedOut"|"Succeeded"|"Failed"|string; + export type JsonPath = string; + export type LastChangedAt = Date; + export type LastChangedBy = string; + export type LastUpdatedBy = string; + export interface ListActionExecutionsInput { + /** + * The name of the pipeline for which you want to list action execution history. + */ + pipelineName: PipelineName; + /** + * Input information used to filter action execution history. + */ + filter?: ActionExecutionFilter; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100. Detailed execution history is available for executions run on or after February 21, 2019. + */ + maxResults?: MaxResults; + /** + * The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list. + */ + nextToken?: NextToken; + } + export interface ListActionExecutionsOutput { + /** + * The details for a list of recent executions, such as action execution ID. + */ + actionExecutionDetails?: ActionExecutionDetailList; + /** + * If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list. + */ + nextToken?: NextToken; + } + export interface ListActionTypesInput { + /** + * Filters the list of action types to those created by a specified entity. + */ + actionOwnerFilter?: ActionOwner; + /** + * An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list. + */ + nextToken?: NextToken; + } + export interface ListActionTypesOutput { + /** + * Provides details of the action types. + */ + actionTypes: ActionTypeList; + /** + * If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list action types call to return the next set of action types in the list. + */ + nextToken?: NextToken; + } + export interface ListPipelineExecutionsInput { + /** + * The name of the pipeline for which you want to get execution summary information. + */ + pipelineName: PipelineName; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100. + */ + maxResults?: MaxResults; + /** + * The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list. + */ + nextToken?: NextToken; + } + export interface ListPipelineExecutionsOutput { + /** + * A list of executions in the history of a pipeline. + */ + pipelineExecutionSummaries?: PipelineExecutionSummaryList; + /** + * A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned. + */ + nextToken?: NextToken; + } + export interface ListPipelinesInput { + /** + * An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list. + */ + nextToken?: NextToken; + } + export interface ListPipelinesOutput { + /** + * The list of pipelines. + */ + pipelines?: PipelineList; + /** + * If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list pipelines call to return the next set of pipelines in the list. + */ + nextToken?: NextToken; + } + export interface ListWebhookItem { + /** + * The detail returned for each webhook, such as the webhook authentication type and filter rules. + */ + definition: WebhookDefinition; + /** + * A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook will make the old URL invalid and generate a new URL. + */ + url: WebhookUrl; + /** + * The text of the error message about the webhook. + */ + errorMessage?: WebhookErrorMessage; + /** + * The number code of the error. + */ + errorCode?: WebhookErrorCode; + /** + * The date and time a webhook was last successfully triggered, in timestamp format. + */ + lastTriggered?: WebhookLastTriggered; + /** + * The Amazon Resource Name (ARN) of the webhook. + */ + arn?: WebhookArn; + } + export interface ListWebhooksInput { + /** + * The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: MaxResults; + } + export interface ListWebhooksOutput { + /** + * The JSON detail returned for each webhook in the list output for the ListWebhooks call. + */ + webhooks?: WebhookList; + /** + * If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list. + */ + NextToken?: NextToken; + } + export type MatchEquals = string; + export type MaxBatchSize = number; + export type MaxResults = number; + export type MaximumArtifactCount = number; + export type Message = string; + export type MinimumArtifactCount = number; + export type NextToken = string; + export type Nonce = string; + export interface OutputArtifact { + /** + * The name of the output of an artifact, such as "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline. + */ + name: ArtifactName; + } + export type OutputArtifactList = OutputArtifact[]; + export type Percentage = number; + export type PipelineArn = string; + export interface PipelineContext { + /** + * The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account. + */ + pipelineName?: PipelineName; + /** + * The stage of the pipeline. + */ + stage?: StageContext; + /** + * The context of an action to a job worker within the stage of a pipeline. + */ + action?: ActionContext; + /** + * The Amazon Resource Name (ARN) of the pipeline. + */ + pipelineArn?: PipelineArn; + /** + * The execution ID of the pipeline. + */ + pipelineExecutionId?: PipelineExecutionId; + } + export interface PipelineDeclaration { + /** + * The name of the action to be performed. + */ + name: PipelineName; + /** + * The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn. + */ + roleArn: RoleArn; + /** + * Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline. + */ + artifactStore?: ArtifactStore; + /** + * A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both. If you create a cross-region action in your pipeline, you must use artifactStores. + */ + artifactStores?: ArtifactStoreMap; + /** + * The stage in which to perform the action. + */ + stages: PipelineStageDeclarationList; + /** + * The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated. + */ + version?: PipelineVersion; + } + export interface PipelineExecution { + /** + * The name of the pipeline that was executed. + */ + pipelineName?: PipelineName; + /** + * The version number of the pipeline that was executed. + */ + pipelineVersion?: PipelineVersion; + /** + * The ID of the pipeline execution. + */ + pipelineExecutionId?: PipelineExecutionId; + /** + * The status of the pipeline execution. InProgress: The pipeline execution is currently running. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. Failed: The pipeline execution was not completed successfully. + */ + status?: PipelineExecutionStatus; + /** + * A list of ArtifactRevision objects included in a pipeline execution. + */ + artifactRevisions?: ArtifactRevisionList; + } + export type PipelineExecutionId = string; + export type PipelineExecutionStatus = "InProgress"|"Succeeded"|"Superseded"|"Failed"|string; + export interface PipelineExecutionSummary { + /** + * The ID of the pipeline execution. + */ + pipelineExecutionId?: PipelineExecutionId; + /** + * The status of the pipeline execution. InProgress: The pipeline execution is currently running. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. Failed: The pipeline execution was not completed successfully. + */ + status?: PipelineExecutionStatus; + /** + * The date and time when the pipeline execution began, in timestamp format. + */ + startTime?: Timestamp; + /** + * The date and time of the last change to the pipeline execution, in timestamp format. + */ + lastUpdateTime?: Timestamp; + /** + * A list of the source artifact revisions that initiated a pipeline execution. + */ + sourceRevisions?: SourceRevisionList; + } + export type PipelineExecutionSummaryList = PipelineExecutionSummary[]; + export type PipelineList = PipelineSummary[]; + export interface PipelineMetadata { + /** + * The Amazon Resource Name (ARN) of the pipeline. + */ + pipelineArn?: PipelineArn; + /** + * The date and time the pipeline was created, in timestamp format. + */ + created?: Timestamp; + /** + * The date and time the pipeline was last updated, in timestamp format. + */ + updated?: Timestamp; + } + export type PipelineName = string; + export type PipelineStageDeclarationList = StageDeclaration[]; + export interface PipelineSummary { + /** + * The name of the pipeline. + */ + name?: PipelineName; + /** + * The version number of the pipeline. + */ + version?: PipelineVersion; + /** + * The date and time the pipeline was created, in timestamp format. + */ + created?: Timestamp; + /** + * The date and time of the last update to the pipeline, in timestamp format. + */ + updated?: Timestamp; + } + export type PipelineVersion = number; + export interface PollForJobsInput { + /** + * Represents information about an action type. + */ + actionTypeId: ActionTypeId; + /** + * The maximum number of jobs to return in a poll for jobs call. + */ + maxBatchSize?: MaxBatchSize; + /** + * A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned. + */ + queryParam?: QueryParamMap; + } + export interface PollForJobsOutput { + /** + * Information about the jobs to take action on. + */ + jobs?: JobList; + } + export interface PollForThirdPartyJobsInput { + /** + * Represents information about an action type. + */ + actionTypeId: ActionTypeId; + /** + * The maximum number of jobs to return in a poll for jobs call. + */ + maxBatchSize?: MaxBatchSize; + } + export interface PollForThirdPartyJobsOutput { + /** + * Information about the jobs to take action on. + */ + jobs?: ThirdPartyJobList; + } + export interface PutActionRevisionInput { + /** + * The name of the pipeline that will start processing the revision to the source. + */ + pipelineName: PipelineName; + /** + * The name of the stage that contains the action that will act upon the revision. + */ + stageName: StageName; + /** + * The name of the action that will process the revision. + */ + actionName: ActionName; + /** + * Represents information about the version (or revision) of an action. + */ + actionRevision: ActionRevision; + } + export interface PutActionRevisionOutput { + /** + * Indicates whether the artifact revision was previously used in an execution of the specified pipeline. + */ + newRevision?: Boolean; + /** + * The ID of the current workflow state of the pipeline. + */ + pipelineExecutionId?: PipelineExecutionId; + } + export interface PutApprovalResultInput { + /** + * The name of the pipeline that contains the action. + */ + pipelineName: PipelineName; + /** + * The name of the stage that contains the action. + */ + stageName: StageName; + /** + * The name of the action for which approval is requested. + */ + actionName: ActionName; + /** + * Represents information about the result of the approval request. + */ + result: ApprovalResult; + /** + * The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action and is used to validate that the approval request corresponding to this token is still valid. + */ + token: ApprovalToken; + } + export interface PutApprovalResultOutput { + /** + * The timestamp showing when the approval or rejection was submitted. + */ + approvedAt?: Timestamp; + } + export interface PutJobFailureResultInput { + /** + * The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs. + */ + jobId: JobId; + /** + * The details about the failure of a job. + */ + failureDetails: FailureDetails; + } + export interface PutJobSuccessResultInput { + /** + * The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs. + */ + jobId: JobId; + /** + * The ID of the current revision of the artifact successfully worked upon by the job. + */ + currentRevision?: CurrentRevision; + /** + * A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied. + */ + continuationToken?: ContinuationToken; + /** + * The execution details of the successful job, such as the actions taken by the job worker. + */ + executionDetails?: ExecutionDetails; + } + export interface PutThirdPartyJobFailureResultInput { + /** + * The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs. + */ + jobId: ThirdPartyJobId; + /** + * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. + */ + clientToken: ClientToken; + /** + * Represents information about failure details. + */ + failureDetails: FailureDetails; + } + export interface PutThirdPartyJobSuccessResultInput { + /** + * The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs. + */ + jobId: ThirdPartyJobId; + /** + * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. + */ + clientToken: ClientToken; + /** + * Represents information about a current revision. + */ + currentRevision?: CurrentRevision; + /** + * A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied. + */ + continuationToken?: ContinuationToken; + /** + * The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline. + */ + executionDetails?: ExecutionDetails; + } + export interface PutWebhookInput { + /** + * The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name which identifies the webhook being defined. You may choose to name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later. + */ + webhook: WebhookDefinition; + } + export interface PutWebhookOutput { + /** + * The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN. + */ + webhook?: ListWebhookItem; + } + export type QueryParamMap = {[key: string]: ActionConfigurationQueryableValue}; + export interface RegisterWebhookWithThirdPartyInput { + /** + * The name of an existing webhook created with PutWebhook to register with a supported third party. + */ + webhookName?: WebhookName; + } + export interface RegisterWebhookWithThirdPartyOutput { + } + export interface RetryStageExecutionInput { + /** + * The name of the pipeline that contains the failed stage. + */ + pipelineName: PipelineName; + /** + * The name of the failed stage to be retried. + */ + stageName: StageName; + /** + * The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage + */ + pipelineExecutionId: PipelineExecutionId; + /** + * The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS. + */ + retryMode: StageRetryMode; + } + export interface RetryStageExecutionOutput { + /** + * The ID of the current workflow execution in the failed stage. + */ + pipelineExecutionId?: PipelineExecutionId; + } + export type Revision = string; + export type RevisionChangeIdentifier = string; + export type RevisionSummary = string; + export type RoleArn = string; + export interface S3ArtifactLocation { + /** + * The name of the Amazon S3 bucket. + */ + bucketName: S3BucketName; + /** + * The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket. + */ + objectKey: S3ObjectKey; + } + export type S3Bucket = string; + export type S3BucketName = string; + export type S3Key = string; + export interface S3Location { + /** + * The Amazon S3 artifact bucket for an action's artifacts. + */ + bucket?: S3Bucket; + /** + * The artifact name. + */ + key?: S3Key; + } + export type S3ObjectKey = string; + export type SecretAccessKey = string; + export type SessionToken = string; + export interface SourceRevision { + /** + * The name of the action that processed the revision to the source artifact. + */ + actionName: ActionName; + /** + * The system-generated unique ID that identifies the revision number of the artifact. + */ + revisionId?: Revision; + /** + * Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata. + */ + revisionSummary?: RevisionSummary; + /** + * The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page. + */ + revisionUrl?: Url; + } + export type SourceRevisionList = SourceRevision[]; + export type StageActionDeclarationList = ActionDeclaration[]; + export type StageBlockerDeclarationList = BlockerDeclaration[]; + export interface StageContext { + /** + * The name of the stage. + */ + name?: StageName; + } + export interface StageDeclaration { + /** + * The name of the stage. + */ + name: StageName; + /** + * Reserved for future use. + */ + blockers?: StageBlockerDeclarationList; + /** + * The actions included in a stage. + */ + actions: StageActionDeclarationList; + } + export interface StageExecution { + /** + * The ID of the pipeline execution associated with the stage. + */ + pipelineExecutionId: PipelineExecutionId; + /** + * The status of the stage, or for a completed stage, the last status of the stage. + */ + status: StageExecutionStatus; + } + export type StageExecutionStatus = "InProgress"|"Failed"|"Succeeded"|string; + export type StageName = string; + export type StageRetryMode = "FAILED_ACTIONS"|string; + export interface StageState { + /** + * The name of the stage. + */ + stageName?: StageName; + /** + * The state of the inbound transition, which is either enabled or disabled. + */ + inboundTransitionState?: TransitionState; + /** + * The state of the stage. + */ + actionStates?: ActionStateList; + /** + * Information about the latest execution in the stage, including its ID and status. + */ + latestExecution?: StageExecution; + } + export type StageStateList = StageState[]; + export type StageTransitionType = "Inbound"|"Outbound"|string; + export interface StartPipelineExecutionInput { + /** + * The name of the pipeline to start. + */ + name: PipelineName; + /** + * The system-generated unique ID used to identify a unique execution request. + */ + clientRequestToken?: ClientRequestToken; + } + export interface StartPipelineExecutionOutput { + /** + * The unique system-generated ID of the pipeline execution that was started. + */ + pipelineExecutionId?: PipelineExecutionId; + } + export interface ThirdPartyJob { + /** + * The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. + */ + clientId?: ClientId; + /** + * The identifier used to identify the job in AWS CodePipeline. + */ + jobId?: JobId; + } + export interface ThirdPartyJobData { + /** + * Represents information about an action type. + */ + actionTypeId?: ActionTypeId; + /** + * Represents information about an action configuration. + */ + actionConfiguration?: ActionConfiguration; + /** + * Represents information about a pipeline to a job worker. Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs. + */ + pipelineContext?: PipelineContext; + /** + * The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline. + */ + inputArtifacts?: ArtifactList; + /** + * The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created. + */ + outputArtifacts?: ArtifactList; + /** + * Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline. + */ + artifactCredentials?: AWSSessionCredentials; + /** + * A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously. + */ + continuationToken?: ContinuationToken; + /** + * The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present. + */ + encryptionKey?: EncryptionKey; + } + export interface ThirdPartyJobDetails { + /** + * The identifier used to identify the job details in AWS CodePipeline. + */ + id?: ThirdPartyJobId; + /** + * The data to be returned by the third party job worker. + */ + data?: ThirdPartyJobData; + /** + * A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request. + */ + nonce?: Nonce; + } + export type ThirdPartyJobId = string; + export type ThirdPartyJobList = ThirdPartyJob[]; + export type Time = Date; + export type Timestamp = Date; + export interface TransitionState { + /** + * Whether the transition between stages is enabled (true) or disabled (false). + */ + enabled?: Enabled; + /** + * The ID of the user who last changed the transition state. + */ + lastChangedBy?: LastChangedBy; + /** + * The timestamp when the transition state was last changed. + */ + lastChangedAt?: LastChangedAt; + /** + * The user-specified reason why the transition between two stages of a pipeline was disabled. + */ + disabledReason?: DisabledReason; + } + export interface UpdatePipelineInput { + /** + * The name of the pipeline to be updated. + */ + pipeline: PipelineDeclaration; + } + export interface UpdatePipelineOutput { + /** + * The structure of the updated pipeline. + */ + pipeline?: PipelineDeclaration; + } + export type Url = string; + export type UrlTemplate = string; + export type Version = string; + export type WebhookArn = string; + export interface WebhookAuthConfiguration { + /** + * The property used to configure acceptance of webhooks within a specific IP range. For IP, only the AllowedIPRange property must be set, and this property must be set to a valid CIDR range. + */ + AllowedIPRange?: WebhookAuthConfigurationAllowedIPRange; + /** + * The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set. + */ + SecretToken?: WebhookAuthConfigurationSecretToken; + } + export type WebhookAuthConfigurationAllowedIPRange = string; + export type WebhookAuthConfigurationSecretToken = string; + export type WebhookAuthenticationType = "GITHUB_HMAC"|"IP"|"UNAUTHENTICATED"|string; + export interface WebhookDefinition { + /** + * The name of the webhook. + */ + name: WebhookName; + /** + * The name of the pipeline you want to connect to the webhook. + */ + targetPipeline: PipelineName; + /** + * The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline. + */ + targetAction: ActionName; + /** + * A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started. + */ + filters: WebhookFilters; + /** + * Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED. For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website. IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration. UNAUTHENTICATED will accept all webhook trigger requests regardless of origin. + */ + authentication: WebhookAuthenticationType; + /** + * Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set. + */ + authenticationConfiguration: WebhookAuthConfiguration; + } + export type WebhookErrorCode = string; + export type WebhookErrorMessage = string; + export interface WebhookFilterRule { + /** + * A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field, otherwise the request will be ignored. For more information about JsonPath expressions, see Java JsonPath implementation in GitHub. + */ + jsonPath: JsonPath; + /** + * The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements. + */ + matchEquals?: MatchEquals; + } + export type WebhookFilters = WebhookFilterRule[]; + export type WebhookLastTriggered = Date; + export type WebhookList = ListWebhookItem[]; + export type WebhookName = string; + export type WebhookUrl = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-07-09"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CodePipeline client. + */ + export import Types = CodePipeline; +} +export = CodePipeline; diff --git a/node_modules/aws-sdk/clients/codepipeline.js b/node_modules/aws-sdk/clients/codepipeline.js new file mode 100644 index 0000000..5cd27e8 --- /dev/null +++ b/node_modules/aws-sdk/clients/codepipeline.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['codepipeline'] = {}; +AWS.CodePipeline = Service.defineService('codepipeline', ['2015-07-09']); +Object.defineProperty(apiLoader.services['codepipeline'], '2015-07-09', { + get: function get() { + var model = require('../apis/codepipeline-2015-07-09.min.json'); + model.paginators = require('../apis/codepipeline-2015-07-09.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CodePipeline; diff --git a/node_modules/aws-sdk/clients/codestar.d.ts b/node_modules/aws-sdk/clients/codestar.d.ts new file mode 100644 index 0000000..2f5e16a --- /dev/null +++ b/node_modules/aws-sdk/clients/codestar.d.ts @@ -0,0 +1,845 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CodeStar extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CodeStar.Types.ClientConfiguration) + config: Config & CodeStar.Types.ClientConfiguration; + /** + * Adds an IAM user to the team for an AWS CodeStar project. + */ + associateTeamMember(params: CodeStar.Types.AssociateTeamMemberRequest, callback?: (err: AWSError, data: CodeStar.Types.AssociateTeamMemberResult) => void): Request; + /** + * Adds an IAM user to the team for an AWS CodeStar project. + */ + associateTeamMember(callback?: (err: AWSError, data: CodeStar.Types.AssociateTeamMemberResult) => void): Request; + /** + * Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created. + */ + createProject(params: CodeStar.Types.CreateProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.CreateProjectResult) => void): Request; + /** + * Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created. + */ + createProject(callback?: (err: AWSError, data: CodeStar.Types.CreateProjectResult) => void): Request; + /** + * Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. + */ + createUserProfile(params: CodeStar.Types.CreateUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.CreateUserProfileResult) => void): Request; + /** + * Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. + */ + createUserProfile(callback?: (err: AWSError, data: CodeStar.Types.CreateUserProfileResult) => void): Request; + /** + * Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project. + */ + deleteProject(params: CodeStar.Types.DeleteProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.DeleteProjectResult) => void): Request; + /** + * Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project. + */ + deleteProject(callback?: (err: AWSError, data: CodeStar.Types.DeleteProjectResult) => void): Request; + /** + * Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user. + */ + deleteUserProfile(params: CodeStar.Types.DeleteUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.DeleteUserProfileResult) => void): Request; + /** + * Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user. + */ + deleteUserProfile(callback?: (err: AWSError, data: CodeStar.Types.DeleteUserProfileResult) => void): Request; + /** + * Describes a project and its resources. + */ + describeProject(params: CodeStar.Types.DescribeProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.DescribeProjectResult) => void): Request; + /** + * Describes a project and its resources. + */ + describeProject(callback?: (err: AWSError, data: CodeStar.Types.DescribeProjectResult) => void): Request; + /** + * Describes a user in AWS CodeStar and the user attributes across all projects. + */ + describeUserProfile(params: CodeStar.Types.DescribeUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.DescribeUserProfileResult) => void): Request; + /** + * Describes a user in AWS CodeStar and the user attributes across all projects. + */ + describeUserProfile(callback?: (err: AWSError, data: CodeStar.Types.DescribeUserProfileResult) => void): Request; + /** + * Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM. + */ + disassociateTeamMember(params: CodeStar.Types.DisassociateTeamMemberRequest, callback?: (err: AWSError, data: CodeStar.Types.DisassociateTeamMemberResult) => void): Request; + /** + * Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM. + */ + disassociateTeamMember(callback?: (err: AWSError, data: CodeStar.Types.DisassociateTeamMemberResult) => void): Request; + /** + * Lists all projects in AWS CodeStar associated with your AWS account. + */ + listProjects(params: CodeStar.Types.ListProjectsRequest, callback?: (err: AWSError, data: CodeStar.Types.ListProjectsResult) => void): Request; + /** + * Lists all projects in AWS CodeStar associated with your AWS account. + */ + listProjects(callback?: (err: AWSError, data: CodeStar.Types.ListProjectsResult) => void): Request; + /** + * Lists resources associated with a project in AWS CodeStar. + */ + listResources(params: CodeStar.Types.ListResourcesRequest, callback?: (err: AWSError, data: CodeStar.Types.ListResourcesResult) => void): Request; + /** + * Lists resources associated with a project in AWS CodeStar. + */ + listResources(callback?: (err: AWSError, data: CodeStar.Types.ListResourcesResult) => void): Request; + /** + * Gets the tags for a project. + */ + listTagsForProject(params: CodeStar.Types.ListTagsForProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.ListTagsForProjectResult) => void): Request; + /** + * Gets the tags for a project. + */ + listTagsForProject(callback?: (err: AWSError, data: CodeStar.Types.ListTagsForProjectResult) => void): Request; + /** + * Lists all team members associated with a project. + */ + listTeamMembers(params: CodeStar.Types.ListTeamMembersRequest, callback?: (err: AWSError, data: CodeStar.Types.ListTeamMembersResult) => void): Request; + /** + * Lists all team members associated with a project. + */ + listTeamMembers(callback?: (err: AWSError, data: CodeStar.Types.ListTeamMembersResult) => void): Request; + /** + * Lists all the user profiles configured for your AWS account in AWS CodeStar. + */ + listUserProfiles(params: CodeStar.Types.ListUserProfilesRequest, callback?: (err: AWSError, data: CodeStar.Types.ListUserProfilesResult) => void): Request; + /** + * Lists all the user profiles configured for your AWS account in AWS CodeStar. + */ + listUserProfiles(callback?: (err: AWSError, data: CodeStar.Types.ListUserProfilesResult) => void): Request; + /** + * Adds tags to a project. + */ + tagProject(params: CodeStar.Types.TagProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.TagProjectResult) => void): Request; + /** + * Adds tags to a project. + */ + tagProject(callback?: (err: AWSError, data: CodeStar.Types.TagProjectResult) => void): Request; + /** + * Removes tags from a project. + */ + untagProject(params: CodeStar.Types.UntagProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.UntagProjectResult) => void): Request; + /** + * Removes tags from a project. + */ + untagProject(callback?: (err: AWSError, data: CodeStar.Types.UntagProjectResult) => void): Request; + /** + * Updates a project in AWS CodeStar. + */ + updateProject(params: CodeStar.Types.UpdateProjectRequest, callback?: (err: AWSError, data: CodeStar.Types.UpdateProjectResult) => void): Request; + /** + * Updates a project in AWS CodeStar. + */ + updateProject(callback?: (err: AWSError, data: CodeStar.Types.UpdateProjectResult) => void): Request; + /** + * Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources. + */ + updateTeamMember(params: CodeStar.Types.UpdateTeamMemberRequest, callback?: (err: AWSError, data: CodeStar.Types.UpdateTeamMemberResult) => void): Request; + /** + * Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources. + */ + updateTeamMember(callback?: (err: AWSError, data: CodeStar.Types.UpdateTeamMemberResult) => void): Request; + /** + * Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. + */ + updateUserProfile(params: CodeStar.Types.UpdateUserProfileRequest, callback?: (err: AWSError, data: CodeStar.Types.UpdateUserProfileResult) => void): Request; + /** + * Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. + */ + updateUserProfile(callback?: (err: AWSError, data: CodeStar.Types.UpdateUserProfileResult) => void): Request; +} +declare namespace CodeStar { + export interface AssociateTeamMemberRequest { + /** + * The ID of the project to which you will add the IAM user. + */ + projectId: ProjectId; + /** + * A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request. + */ + clientRequestToken?: ClientRequestToken; + /** + * The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project. + */ + userArn: UserArn; + /** + * The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project. + */ + projectRole: Role; + /** + * Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances. + */ + remoteAccessAllowed?: RemoteAccessAllowed; + } + export interface AssociateTeamMemberResult { + /** + * The user- or system-generated token from the initial request that can be used to repeat the request. + */ + clientRequestToken?: ClientRequestToken; + } + export type BucketKey = string; + export type BucketName = string; + export type ClientRequestToken = string; + export interface Code { + /** + * The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation. + */ + source: CodeSource; + /** + * The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository. + */ + destination: CodeDestination; + } + export interface CodeCommitCodeDestination { + /** + * The name of the AWS CodeCommit repository to be created in AWS CodeStar. + */ + name: RepositoryName; + } + export interface CodeDestination { + /** + * Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation. + */ + codeCommit?: CodeCommitCodeDestination; + /** + * Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation. + */ + gitHub?: GitHubCodeDestination; + } + export interface CodeSource { + /** + * Information about the Amazon S3 location where the source code files provided with the project request are stored. + */ + s3: S3Location; + } + export interface CreateProjectRequest { + /** + * The display name for the project to be created in AWS CodeStar. + */ + name: ProjectName; + /** + * The ID of the project to be created in AWS CodeStar. + */ + id: ProjectId; + /** + * The description of the project, if any. + */ + description?: ProjectDescription; + /** + * A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request. + */ + clientRequestToken?: ClientRequestToken; + /** + * A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter. + */ + sourceCode?: SourceCode; + /** + * The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter. + */ + toolchain?: Toolchain; + /** + * The tags created for the project. + */ + tags?: Tags; + } + export interface CreateProjectResult { + /** + * The ID of the project. + */ + id: ProjectId; + /** + * The Amazon Resource Name (ARN) of the created project. + */ + arn: ProjectArn; + /** + * A user- or system-generated token that identifies the entity that requested project creation. + */ + clientRequestToken?: ClientRequestToken; + /** + * Reserved for future use. + */ + projectTemplateId?: ProjectTemplateId; + } + export interface CreateUserProfileRequest { + /** + * The Amazon Resource Name (ARN) of the user in IAM. + */ + userArn: UserArn; + /** + * The name that will be displayed as the friendly name for the user in AWS CodeStar. + */ + displayName: UserProfileDisplayName; + /** + * The email address that will be displayed as part of the user's profile in AWS CodeStar. + */ + emailAddress: Email; + /** + * The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access. + */ + sshPublicKey?: SshPublicKey; + } + export interface CreateUserProfileResult { + /** + * The Amazon Resource Name (ARN) of the user in IAM. + */ + userArn: UserArn; + /** + * The name that is displayed as the friendly name for the user in AWS CodeStar. + */ + displayName?: UserProfileDisplayName; + /** + * The email address that is displayed as part of the user's profile in AWS CodeStar. + */ + emailAddress?: Email; + /** + * The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources. + */ + sshPublicKey?: SshPublicKey; + /** + * The date the user profile was created, in timestamp format. + */ + createdTimestamp?: CreatedTimestamp; + /** + * The date the user profile was last modified, in timestamp format. + */ + lastModifiedTimestamp?: LastModifiedTimestamp; + } + export type CreatedTimestamp = Date; + export interface DeleteProjectRequest { + /** + * The ID of the project to be deleted in AWS CodeStar. + */ + id: ProjectId; + /** + * A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request. + */ + clientRequestToken?: ClientRequestToken; + /** + * Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases. + */ + deleteStack?: DeleteStack; + } + export interface DeleteProjectResult { + /** + * The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources. + */ + stackId?: StackId; + /** + * The Amazon Resource Name (ARN) of the deleted project. + */ + projectArn?: ProjectArn; + } + export type DeleteStack = boolean; + export interface DeleteUserProfileRequest { + /** + * The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar. + */ + userArn: UserArn; + } + export interface DeleteUserProfileResult { + /** + * The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar. + */ + userArn: UserArn; + } + export interface DescribeProjectRequest { + /** + * The ID of the project. + */ + id: ProjectId; + } + export interface DescribeProjectResult { + /** + * The display name for the project. + */ + name?: ProjectName; + /** + * The ID of the project. + */ + id?: ProjectId; + /** + * The Amazon Resource Name (ARN) for the project. + */ + arn?: ProjectArn; + /** + * The description of the project, if any. + */ + description?: ProjectDescription; + /** + * A user- or system-generated token that identifies the entity that requested project creation. + */ + clientRequestToken?: ClientRequestToken; + /** + * The date and time the project was created, in timestamp format. + */ + createdTimeStamp?: CreatedTimestamp; + /** + * The ID of the primary stack in AWS CloudFormation used to generate resources for the project. + */ + stackId?: StackId; + /** + * The ID for the AWS CodeStar project template used to create the project. + */ + projectTemplateId?: ProjectTemplateId; + /** + * The project creation or deletion status. + */ + status?: ProjectStatus; + } + export interface DescribeUserProfileRequest { + /** + * The Amazon Resource Name (ARN) of the user. + */ + userArn: UserArn; + } + export interface DescribeUserProfileResult { + /** + * The Amazon Resource Name (ARN) of the user. + */ + userArn: UserArn; + /** + * The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM"). + */ + displayName?: UserProfileDisplayName; + /** + * The email address for the user. Optional. + */ + emailAddress?: Email; + /** + * The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources. + */ + sshPublicKey?: SshPublicKey; + /** + * The date and time when the user profile was created in AWS CodeStar, in timestamp format. + */ + createdTimestamp: CreatedTimestamp; + /** + * The date and time when the user profile was last modified, in timestamp format. + */ + lastModifiedTimestamp: LastModifiedTimestamp; + } + export interface DisassociateTeamMemberRequest { + /** + * The ID of the AWS CodeStar project from which you want to remove a team member. + */ + projectId: ProjectId; + /** + * The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project. + */ + userArn: UserArn; + } + export interface DisassociateTeamMemberResult { + } + export type Email = string; + export interface GitHubCodeDestination { + /** + * Name of the GitHub repository to be created in AWS CodeStar. + */ + name: RepositoryName; + /** + * Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created. + */ + description?: RepositoryDescription; + /** + * The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization. + */ + type: RepositoryType; + /** + * The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name. + */ + owner: RepositoryOwner; + /** + * Whether the GitHub repository is to be a private repository. + */ + privateRepository: RepositoryIsPrivate; + /** + * Whether to enable issues for the GitHub repository. + */ + issuesEnabled: RepositoryEnableIssues; + /** + * The GitHub user's personal access token for the GitHub repository. + */ + token: GitHubPersonalToken; + } + export type GitHubPersonalToken = string; + export type LastModifiedTimestamp = Date; + export interface ListProjectsRequest { + /** + * The continuation token to be used to return the next set of results, if the results cannot be returned in one response. + */ + nextToken?: PaginationToken; + /** + * The maximum amount of data that can be contained in a single set of results. + */ + maxResults?: MaxResults; + } + export interface ListProjectsResult { + /** + * A list of projects. + */ + projects: ProjectsList; + /** + * The continuation token to use when requesting the next set of results, if there are more results to be returned. + */ + nextToken?: PaginationToken; + } + export interface ListResourcesRequest { + /** + * The ID of the project. + */ + projectId: ProjectId; + /** + * The continuation token for the next set of results, if the results cannot be returned in one response. + */ + nextToken?: PaginationToken; + /** + * The maximum amount of data that can be contained in a single set of results. + */ + maxResults?: MaxResults; + } + export interface ListResourcesResult { + /** + * An array of resources associated with the project. + */ + resources?: ResourcesResult; + /** + * The continuation token to use when requesting the next set of results, if there are more results to be returned. + */ + nextToken?: PaginationToken; + } + export interface ListTagsForProjectRequest { + /** + * The ID of the project to get tags for. + */ + id: ProjectId; + /** + * Reserved for future use. + */ + nextToken?: PaginationToken; + /** + * Reserved for future use. + */ + maxResults?: MaxResults; + } + export interface ListTagsForProjectResult { + /** + * The tags for the project. + */ + tags?: Tags; + /** + * Reserved for future use. + */ + nextToken?: PaginationToken; + } + export interface ListTeamMembersRequest { + /** + * The ID of the project for which you want to list team members. + */ + projectId: ProjectId; + /** + * The continuation token for the next set of results, if the results cannot be returned in one response. + */ + nextToken?: PaginationToken; + /** + * The maximum number of team members you want returned in a response. + */ + maxResults?: MaxResults; + } + export interface ListTeamMembersResult { + /** + * A list of team member objects for the project. + */ + teamMembers: TeamMemberResult; + /** + * The continuation token to use when requesting the next set of results, if there are more results to be returned. + */ + nextToken?: PaginationToken; + } + export interface ListUserProfilesRequest { + /** + * The continuation token for the next set of results, if the results cannot be returned in one response. + */ + nextToken?: PaginationToken; + /** + * The maximum number of results to return in a response. + */ + maxResults?: MaxResults; + } + export interface ListUserProfilesResult { + /** + * All the user profiles configured in AWS CodeStar for an AWS account. + */ + userProfiles: UserProfilesList; + /** + * The continuation token to use when requesting the next set of results, if there are more results to be returned. + */ + nextToken?: PaginationToken; + } + export type MaxResults = number; + export type PaginationToken = string; + export type ProjectArn = string; + export type ProjectDescription = string; + export type ProjectId = string; + export type ProjectName = string; + export interface ProjectStatus { + /** + * The phase of completion for a project creation or deletion. + */ + state: State; + /** + * In the case of a project creation or deletion failure, a reason for the failure. + */ + reason?: Reason; + } + export interface ProjectSummary { + /** + * The ID of the project. + */ + projectId?: ProjectId; + /** + * The Amazon Resource Name (ARN) of the project. + */ + projectArn?: ProjectArn; + } + export type ProjectTemplateId = string; + export type ProjectsList = ProjectSummary[]; + export type Reason = string; + export type RemoteAccessAllowed = boolean; + export type RepositoryDescription = string; + export type RepositoryEnableIssues = boolean; + export type RepositoryIsPrivate = boolean; + export type RepositoryName = string; + export type RepositoryOwner = string; + export type RepositoryType = string; + export interface Resource { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + id: ResourceId; + } + export type ResourceId = string; + export type ResourcesResult = Resource[]; + export type Role = string; + export type RoleArn = string; + export interface S3Location { + /** + * The Amazon S3 bucket name where the source code files provided with the project request are stored. + */ + bucketName?: BucketName; + /** + * The Amazon S3 object key where the source code files provided with the project request are stored. + */ + bucketKey?: BucketKey; + } + export type SourceCode = Code[]; + export type SshPublicKey = string; + export type StackId = string; + export type State = string; + export type TagKey = string; + export type TagKeys = TagKey[]; + export interface TagProjectRequest { + /** + * The ID of the project you want to add a tag to. + */ + id: ProjectId; + /** + * The tags you want to add to the project. + */ + tags: Tags; + } + export interface TagProjectResult { + /** + * The tags for the project. + */ + tags?: Tags; + } + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export interface TeamMember { + /** + * The Amazon Resource Name (ARN) of the user in IAM. + */ + userArn: UserArn; + /** + * The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide. + */ + projectRole: Role; + /** + * Whether the user is allowed to remotely access project resources using an SSH public/private key pair. + */ + remoteAccessAllowed?: RemoteAccessAllowed; + } + export type TeamMemberResult = TeamMember[]; + export type TemplateParameterKey = string; + export type TemplateParameterMap = {[key: string]: TemplateParameterValue}; + export type TemplateParameterValue = string; + export interface Toolchain { + /** + * The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation. + */ + source: ToolchainSource; + /** + * The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning. + */ + roleArn?: RoleArn; + /** + * The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any. + */ + stackParameters?: TemplateParameterMap; + } + export interface ToolchainSource { + /** + * The Amazon S3 bucket where the toolchain template file provided with the project request is stored. + */ + s3: S3Location; + } + export interface UntagProjectRequest { + /** + * The ID of the project to remove tags from. + */ + id: ProjectId; + /** + * The tags to remove from the project. + */ + tags: TagKeys; + } + export interface UntagProjectResult { + } + export interface UpdateProjectRequest { + /** + * The ID of the project you want to update. + */ + id: ProjectId; + /** + * The name of the project you want to update. + */ + name?: ProjectName; + /** + * The description of the project, if any. + */ + description?: ProjectDescription; + } + export interface UpdateProjectResult { + } + export interface UpdateTeamMemberRequest { + /** + * The ID of the project. + */ + projectId: ProjectId; + /** + * The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes. + */ + userArn: UserArn; + /** + * The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide. + */ + projectRole?: Role; + /** + * Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources. + */ + remoteAccessAllowed?: RemoteAccessAllowed; + } + export interface UpdateTeamMemberResult { + /** + * The Amazon Resource Name (ARN) of the user whose team membership attributes were updated. + */ + userArn?: UserArn; + /** + * The project role granted to the user. + */ + projectRole?: Role; + /** + * Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. + */ + remoteAccessAllowed?: RemoteAccessAllowed; + } + export interface UpdateUserProfileRequest { + /** + * The name that will be displayed as the friendly name for the user in AWS CodeStar. + */ + userArn: UserArn; + /** + * The name that is displayed as the friendly name for the user in AWS CodeStar. + */ + displayName?: UserProfileDisplayName; + /** + * The email address that is displayed as part of the user's profile in AWS CodeStar. + */ + emailAddress?: Email; + /** + * The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access. + */ + sshPublicKey?: SshPublicKey; + } + export interface UpdateUserProfileResult { + /** + * The Amazon Resource Name (ARN) of the user in IAM. + */ + userArn: UserArn; + /** + * The name that is displayed as the friendly name for the user in AWS CodeStar. + */ + displayName?: UserProfileDisplayName; + /** + * The email address that is displayed as part of the user's profile in AWS CodeStar. + */ + emailAddress?: Email; + /** + * The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources. + */ + sshPublicKey?: SshPublicKey; + /** + * The date the user profile was created, in timestamp format. + */ + createdTimestamp?: CreatedTimestamp; + /** + * The date the user profile was last modified, in timestamp format. + */ + lastModifiedTimestamp?: LastModifiedTimestamp; + } + export type UserArn = string; + export type UserProfileDisplayName = string; + export interface UserProfileSummary { + /** + * The Amazon Resource Name (ARN) of the user in IAM. + */ + userArn?: UserArn; + /** + * The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM"). + */ + displayName?: UserProfileDisplayName; + /** + * The email address associated with the user. + */ + emailAddress?: Email; + /** + * The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access. + */ + sshPublicKey?: SshPublicKey; + } + export type UserProfilesList = UserProfileSummary[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-04-19"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CodeStar client. + */ + export import Types = CodeStar; +} +export = CodeStar; diff --git a/node_modules/aws-sdk/clients/codestar.js b/node_modules/aws-sdk/clients/codestar.js new file mode 100644 index 0000000..066d8e5 --- /dev/null +++ b/node_modules/aws-sdk/clients/codestar.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['codestar'] = {}; +AWS.CodeStar = Service.defineService('codestar', ['2017-04-19']); +Object.defineProperty(apiLoader.services['codestar'], '2017-04-19', { + get: function get() { + var model = require('../apis/codestar-2017-04-19.min.json'); + model.paginators = require('../apis/codestar-2017-04-19.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CodeStar; diff --git a/node_modules/aws-sdk/clients/cognitoidentity.d.ts b/node_modules/aws-sdk/clients/cognitoidentity.d.ts new file mode 100644 index 0000000..d25a2ee --- /dev/null +++ b/node_modules/aws-sdk/clients/cognitoidentity.d.ts @@ -0,0 +1,764 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CognitoIdentity extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CognitoIdentity.Types.ClientConfiguration) + config: Config & CognitoIdentity.Types.ClientConfiguration; + /** + * Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com You must use AWS Developer credentials to call this API. + */ + createIdentityPool(params: CognitoIdentity.Types.CreateIdentityPoolInput, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request; + /** + * Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com You must use AWS Developer credentials to call this API. + */ + createIdentityPool(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request; + /** + * Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. You must use AWS Developer credentials to call this API. + */ + deleteIdentities(params: CognitoIdentity.Types.DeleteIdentitiesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.DeleteIdentitiesResponse) => void): Request; + /** + * Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. You must use AWS Developer credentials to call this API. + */ + deleteIdentities(callback?: (err: AWSError, data: CognitoIdentity.Types.DeleteIdentitiesResponse) => void): Request; + /** + * Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use AWS Developer credentials to call this API. + */ + deleteIdentityPool(params: CognitoIdentity.Types.DeleteIdentityPoolInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use AWS Developer credentials to call this API. + */ + deleteIdentityPool(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns metadata related to the given identity, including when the identity was created and any associated linked logins. You must use AWS Developer credentials to call this API. + */ + describeIdentity(params: CognitoIdentity.Types.DescribeIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityDescription) => void): Request; + /** + * Returns metadata related to the given identity, including when the identity was created and any associated linked logins. You must use AWS Developer credentials to call this API. + */ + describeIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityDescription) => void): Request; + /** + * Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. You must use AWS Developer credentials to call this API. + */ + describeIdentityPool(params: CognitoIdentity.Types.DescribeIdentityPoolInput, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request; + /** + * Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. You must use AWS Developer credentials to call this API. + */ + describeIdentityPool(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request; + /** + * Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. This is a public API. You do not need any credentials to call this API. + */ + getCredentialsForIdentity(params: CognitoIdentity.Types.GetCredentialsForIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetCredentialsForIdentityResponse) => void): Request; + /** + * Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. This is a public API. You do not need any credentials to call this API. + */ + getCredentialsForIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.GetCredentialsForIdentityResponse) => void): Request; + /** + * Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. This is a public API. You do not need any credentials to call this API. + */ + getId(params: CognitoIdentity.Types.GetIdInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdResponse) => void): Request; + /** + * Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. This is a public API. You do not need any credentials to call this API. + */ + getId(callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdResponse) => void): Request; + /** + * Gets the roles for an identity pool. You must use AWS Developer credentials to call this API. + */ + getIdentityPoolRoles(params: CognitoIdentity.Types.GetIdentityPoolRolesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdentityPoolRolesResponse) => void): Request; + /** + * Gets the roles for an identity pool. You must use AWS Developer credentials to call this API. + */ + getIdentityPoolRoles(callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdentityPoolRolesResponse) => void): Request; + /** + * Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. The OpenId token is valid for 10 minutes. This is a public API. You do not need any credentials to call this API. + */ + getOpenIdToken(params: CognitoIdentity.Types.GetOpenIdTokenInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenResponse) => void): Request; + /** + * Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. The OpenId token is valid for 10 minutes. This is a public API. You do not need any credentials to call this API. + */ + getOpenIdToken(callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenResponse) => void): Request; + /** + * Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId. You must use AWS Developer credentials to call this API. + */ + getOpenIdTokenForDeveloperIdentity(params: CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityResponse) => void): Request; + /** + * Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId. You must use AWS Developer credentials to call this API. + */ + getOpenIdTokenForDeveloperIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityResponse) => void): Request; + /** + * Lists the identities in an identity pool. You must use AWS Developer credentials to call this API. + */ + listIdentities(params: CognitoIdentity.Types.ListIdentitiesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentitiesResponse) => void): Request; + /** + * Lists the identities in an identity pool. You must use AWS Developer credentials to call this API. + */ + listIdentities(callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentitiesResponse) => void): Request; + /** + * Lists all of the Cognito identity pools registered for your account. You must use AWS Developer credentials to call this API. + */ + listIdentityPools(params: CognitoIdentity.Types.ListIdentityPoolsInput, callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentityPoolsResponse) => void): Request; + /** + * Lists all of the Cognito identity pools registered for your account. You must use AWS Developer credentials to call this API. + */ + listIdentityPools(callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentityPoolsResponse) => void): Request; + /** + * Lists the tags that are assigned to an Amazon Cognito identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. + */ + listTagsForResource(params: CognitoIdentity.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CognitoIdentity.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags that are assigned to an Amazon Cognito identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. + */ + listTagsForResource(callback?: (err: AWSError, data: CognitoIdentity.Types.ListTagsForResourceResponse) => void): Request; + /** + * Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown. LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication. You must use AWS Developer credentials to call this API. + */ + lookupDeveloperIdentity(params: CognitoIdentity.Types.LookupDeveloperIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.LookupDeveloperIdentityResponse) => void): Request; + /** + * Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown. LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication. You must use AWS Developer credentials to call this API. + */ + lookupDeveloperIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.LookupDeveloperIdentityResponse) => void): Request; + /** + * Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown. You must use AWS Developer credentials to call this API. + */ + mergeDeveloperIdentities(params: CognitoIdentity.Types.MergeDeveloperIdentitiesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.MergeDeveloperIdentitiesResponse) => void): Request; + /** + * Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown. You must use AWS Developer credentials to call this API. + */ + mergeDeveloperIdentities(callback?: (err: AWSError, data: CognitoIdentity.Types.MergeDeveloperIdentitiesResponse) => void): Request; + /** + * Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action. You must use AWS Developer credentials to call this API. + */ + setIdentityPoolRoles(params: CognitoIdentity.Types.SetIdentityPoolRolesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action. You must use AWS Developer credentials to call this API. + */ + setIdentityPoolRoles(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns a set of tags to an Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. + */ + tagResource(params: CognitoIdentity.Types.TagResourceInput, callback?: (err: AWSError, data: CognitoIdentity.Types.TagResourceResponse) => void): Request; + /** + * Assigns a set of tags to an Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. + */ + tagResource(callback?: (err: AWSError, data: CognitoIdentity.Types.TagResourceResponse) => void): Request; + /** + * Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. You must use AWS Developer credentials to call this API. + */ + unlinkDeveloperIdentity(params: CognitoIdentity.Types.UnlinkDeveloperIdentityInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. You must use AWS Developer credentials to call this API. + */ + unlinkDeveloperIdentity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. This is a public API. You do not need any credentials to call this API. + */ + unlinkIdentity(params: CognitoIdentity.Types.UnlinkIdentityInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. This is a public API. You do not need any credentials to call this API. + */ + unlinkIdentity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account + */ + untagResource(params: CognitoIdentity.Types.UntagResourceInput, callback?: (err: AWSError, data: CognitoIdentity.Types.UntagResourceResponse) => void): Request; + /** + * Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account + */ + untagResource(callback?: (err: AWSError, data: CognitoIdentity.Types.UntagResourceResponse) => void): Request; + /** + * Updates an identity pool. You must use AWS Developer credentials to call this API. + */ + updateIdentityPool(params: CognitoIdentity.Types.IdentityPool, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request; + /** + * Updates an identity pool. You must use AWS Developer credentials to call this API. + */ + updateIdentityPool(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request; +} +declare namespace CognitoIdentity { + export type ARNString = string; + export type AccessKeyString = string; + export type AccountId = string; + export type AmbiguousRoleResolutionType = "AuthenticatedRole"|"Deny"|string; + export type ClaimName = string; + export type ClaimValue = string; + export interface CognitoIdentityProvider { + /** + * The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. + */ + ProviderName?: CognitoIdentityProviderName; + /** + * The client ID for the Amazon Cognito user pool. + */ + ClientId?: CognitoIdentityProviderClientId; + /** + * TRUE if server-side token validation is enabled for the identity provider’s token. Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user. If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error. + */ + ServerSideTokenCheck?: CognitoIdentityProviderTokenCheck; + } + export type CognitoIdentityProviderClientId = string; + export type CognitoIdentityProviderList = CognitoIdentityProvider[]; + export type CognitoIdentityProviderName = string; + export type CognitoIdentityProviderTokenCheck = boolean; + export interface CreateIdentityPoolInput { + /** + * A string that you provide. + */ + IdentityPoolName: IdentityPoolName; + /** + * TRUE if the identity pool supports unauthenticated logins. + */ + AllowUnauthenticatedIdentities: IdentityPoolUnauthenticated; + /** + * Optional key:value pairs mapping provider names to provider app IDs. + */ + SupportedLoginProviders?: IdentityProviders; + /** + * The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. + */ + DeveloperProviderName?: DeveloperProviderName; + /** + * A list of OpendID Connect provider ARNs. + */ + OpenIdConnectProviderARNs?: OIDCProviderList; + /** + * An array of Amazon Cognito user pools and their client IDs. + */ + CognitoIdentityProviders?: CognitoIdentityProviderList; + /** + * An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. + */ + SamlProviderARNs?: SAMLProviderList; + /** + * Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. + */ + IdentityPoolTags?: IdentityPoolTagsType; + } + export interface Credentials { + /** + * The Access Key portion of the credentials. + */ + AccessKeyId?: AccessKeyString; + /** + * The Secret Access Key portion of the credentials + */ + SecretKey?: SecretKeyString; + /** + * The Session Token portion of the credentials + */ + SessionToken?: SessionTokenString; + /** + * The date at which these credentials will expire. + */ + Expiration?: DateType; + } + export type DateType = Date; + export interface DeleteIdentitiesInput { + /** + * A list of 1-60 identities that you want to delete. + */ + IdentityIdsToDelete: IdentityIdList; + } + export interface DeleteIdentitiesResponse { + /** + * An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. + */ + UnprocessedIdentityIds?: UnprocessedIdentityIdList; + } + export interface DeleteIdentityPoolInput { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + } + export interface DescribeIdentityInput { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId: IdentityId; + } + export interface DescribeIdentityPoolInput { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + } + export type DeveloperProviderName = string; + export type DeveloperUserIdentifier = string; + export type DeveloperUserIdentifierList = DeveloperUserIdentifier[]; + export type ErrorCode = "AccessDenied"|"InternalServerError"|string; + export interface GetCredentialsForIdentityInput { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId: IdentityId; + /** + * A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier". Logins should not be specified when trying to get credentials for an unauthenticated identity. The Logins parameter is required when using identities associated with external identity providers such as FaceBook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide. + */ + Logins?: LoginsMap; + /** + * The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization. + */ + CustomRoleArn?: ARNString; + } + export interface GetCredentialsForIdentityResponse { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + /** + * Credentials for the provided identity ID. + */ + Credentials?: Credentials; + } + export interface GetIdInput { + /** + * A standard AWS account ID (9+ digits). + */ + AccountId?: AccountId; + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + /** + * A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows: Facebook: graph.facebook.com Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com + */ + Logins?: LoginsMap; + } + export interface GetIdResponse { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + } + export interface GetIdentityPoolRolesInput { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + } + export interface GetIdentityPoolRolesResponse { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId?: IdentityPoolId; + /** + * The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported. + */ + Roles?: RolesMap; + /** + * How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". + */ + RoleMappings?: RoleMappingMap; + } + export interface GetOpenIdTokenForDeveloperIdentityInput { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + /** + * A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins. + */ + Logins: LoginsMap; + /** + * The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration. + */ + TokenDuration?: TokenDuration; + } + export interface GetOpenIdTokenForDeveloperIdentityResponse { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + /** + * An OpenID token. + */ + Token?: OIDCToken; + } + export interface GetOpenIdTokenInput { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId: IdentityId; + /** + * A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenId Connect provider, always include the id_token. + */ + Logins?: LoginsMap; + } + export interface GetOpenIdTokenResponse { + /** + * A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input. + */ + IdentityId?: IdentityId; + /** + * An OpenID token, valid for 10 minutes. + */ + Token?: OIDCToken; + } + export type HideDisabled = boolean; + export type IdentitiesList = IdentityDescription[]; + export interface IdentityDescription { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + /** + * The provider names. + */ + Logins?: LoginsList; + /** + * Date on which the identity was created. + */ + CreationDate?: DateType; + /** + * Date on which the identity was last modified. + */ + LastModifiedDate?: DateType; + } + export type IdentityId = string; + export type IdentityIdList = IdentityId[]; + export interface IdentityPool { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + /** + * A string that you provide. + */ + IdentityPoolName: IdentityPoolName; + /** + * TRUE if the identity pool supports unauthenticated logins. + */ + AllowUnauthenticatedIdentities: IdentityPoolUnauthenticated; + /** + * Optional key:value pairs mapping provider names to provider app IDs. + */ + SupportedLoginProviders?: IdentityProviders; + /** + * The "domain" by which Cognito will refer to your users. + */ + DeveloperProviderName?: DeveloperProviderName; + /** + * A list of OpendID Connect provider ARNs. + */ + OpenIdConnectProviderARNs?: OIDCProviderList; + /** + * A list representing an Amazon Cognito user pool and its client ID. + */ + CognitoIdentityProviders?: CognitoIdentityProviderList; + /** + * An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. + */ + SamlProviderARNs?: SAMLProviderList; + /** + * The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. + */ + IdentityPoolTags?: IdentityPoolTagsType; + } + export type IdentityPoolId = string; + export type IdentityPoolName = string; + export interface IdentityPoolShortDescription { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId?: IdentityPoolId; + /** + * A string that you provide. + */ + IdentityPoolName?: IdentityPoolName; + } + export type IdentityPoolTagsListType = TagKeysType[]; + export type IdentityPoolTagsType = {[key: string]: TagValueType}; + export type IdentityPoolUnauthenticated = boolean; + export type IdentityPoolsList = IdentityPoolShortDescription[]; + export type IdentityProviderId = string; + export type IdentityProviderName = string; + export type IdentityProviderToken = string; + export type IdentityProviders = {[key: string]: IdentityProviderId}; + export interface ListIdentitiesInput { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + /** + * The maximum number of identities to return. + */ + MaxResults: QueryLimit; + /** + * A pagination token. + */ + NextToken?: PaginationKey; + /** + * An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response. + */ + HideDisabled?: HideDisabled; + } + export interface ListIdentitiesResponse { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId?: IdentityPoolId; + /** + * An object containing a set of identities and associated mappings. + */ + Identities?: IdentitiesList; + /** + * A pagination token. + */ + NextToken?: PaginationKey; + } + export interface ListIdentityPoolsInput { + /** + * The maximum number of identities to return. + */ + MaxResults: QueryLimit; + /** + * A pagination token. + */ + NextToken?: PaginationKey; + } + export interface ListIdentityPoolsResponse { + /** + * The identity pools returned by the ListIdentityPools action. + */ + IdentityPools?: IdentityPoolsList; + /** + * A pagination token. + */ + NextToken?: PaginationKey; + } + export interface ListTagsForResourceInput { + /** + * The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to. + */ + ResourceArn: ARNString; + } + export interface ListTagsForResourceResponse { + /** + * The tags that are assigned to the identity pool. + */ + Tags?: IdentityPoolTagsType; + } + export type LoginsList = IdentityProviderName[]; + export type LoginsMap = {[key: string]: IdentityProviderToken}; + export interface LookupDeveloperIdentityInput { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + /** + * A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users. + */ + DeveloperUserIdentifier?: DeveloperUserIdentifier; + /** + * The maximum number of identities to return. + */ + MaxResults?: QueryLimit; + /** + * A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match. + */ + NextToken?: PaginationKey; + } + export interface LookupDeveloperIdentityResponse { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + /** + * This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID. + */ + DeveloperUserIdentifierList?: DeveloperUserIdentifierList; + /** + * A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match. + */ + NextToken?: PaginationKey; + } + export interface MappingRule { + /** + * The claim name that must be present in the token, for example, "isAdmin" or "paid". + */ + Claim: ClaimName; + /** + * The match condition that specifies how closely the claim value in the IdP token must match Value. + */ + MatchType: MappingRuleMatchType; + /** + * A brief string that the claim must match, for example, "paid" or "yes". + */ + Value: ClaimValue; + /** + * The role ARN. + */ + RoleARN: ARNString; + } + export type MappingRuleMatchType = "Equals"|"Contains"|"StartsWith"|"NotEqual"|string; + export type MappingRulesList = MappingRule[]; + export interface MergeDeveloperIdentitiesInput { + /** + * User identifier for the source user. The value should be a DeveloperUserIdentifier. + */ + SourceUserIdentifier: DeveloperUserIdentifier; + /** + * User identifier for the destination user. The value should be a DeveloperUserIdentifier. + */ + DestinationUserIdentifier: DeveloperUserIdentifier; + /** + * The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-). + */ + DeveloperProviderName: DeveloperProviderName; + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + } + export interface MergeDeveloperIdentitiesResponse { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + } + export type OIDCProviderList = ARNString[]; + export type OIDCToken = string; + export type PaginationKey = string; + export type QueryLimit = number; + export interface RoleMapping { + /** + * The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role. + */ + Type: RoleMappingType; + /** + * If you specify Token or Rules as the Type, AmbiguousRoleResolution is required. Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type. + */ + AmbiguousRoleResolution?: AmbiguousRoleResolutionType; + /** + * The rules to be used for mapping users to roles. If you specify Rules as the role mapping type, RulesConfiguration is required. + */ + RulesConfiguration?: RulesConfigurationType; + } + export type RoleMappingMap = {[key: string]: RoleMapping}; + export type RoleMappingType = "Token"|"Rules"|string; + export type RoleType = string; + export type RolesMap = {[key: string]: ARNString}; + export interface RulesConfigurationType { + /** + * An array of rules. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role. + */ + Rules: MappingRulesList; + } + export type SAMLProviderList = ARNString[]; + export type SecretKeyString = string; + export type SessionTokenString = string; + export interface SetIdentityPoolRolesInput { + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + /** + * The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. + */ + Roles: RolesMap; + /** + * How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". Up to 25 rules can be specified per identity provider. + */ + RoleMappings?: RoleMappingMap; + } + export type TagKeysType = string; + export interface TagResourceInput { + /** + * The Amazon Resource Name (ARN) of the identity pool to assign the tags to. + */ + ResourceArn: ARNString; + /** + * The tags to assign to the identity pool. + */ + Tags?: IdentityPoolTagsType; + } + export interface TagResourceResponse { + } + export type TagValueType = string; + export type TokenDuration = number; + export interface UnlinkDeveloperIdentityInput { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId: IdentityId; + /** + * An identity pool ID in the format REGION:GUID. + */ + IdentityPoolId: IdentityPoolId; + /** + * The "domain" by which Cognito will refer to your users. + */ + DeveloperProviderName: DeveloperProviderName; + /** + * A unique ID used by your backend authentication process to identify a user. + */ + DeveloperUserIdentifier: DeveloperUserIdentifier; + } + export interface UnlinkIdentityInput { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId: IdentityId; + /** + * A set of optional name-value pairs that map provider names to provider tokens. + */ + Logins: LoginsMap; + /** + * Provider names to unlink from this identity. + */ + LoginsToRemove: LoginsList; + } + export interface UnprocessedIdentityId { + /** + * A unique identifier in the format REGION:GUID. + */ + IdentityId?: IdentityId; + /** + * The error code indicating the type of error that occurred. + */ + ErrorCode?: ErrorCode; + } + export type UnprocessedIdentityIdList = UnprocessedIdentityId[]; + export interface UntagResourceInput { + /** + * The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to. + */ + ResourceArn: ARNString; + /** + * The keys of the tags to remove from the user pool. + */ + TagKeys?: IdentityPoolTagsListType; + } + export interface UntagResourceResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-06-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CognitoIdentity client. + */ + export import Types = CognitoIdentity; +} +export = CognitoIdentity; diff --git a/node_modules/aws-sdk/clients/cognitoidentity.js b/node_modules/aws-sdk/clients/cognitoidentity.js new file mode 100644 index 0000000..62add4c --- /dev/null +++ b/node_modules/aws-sdk/clients/cognitoidentity.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cognitoidentity'] = {}; +AWS.CognitoIdentity = Service.defineService('cognitoidentity', ['2014-06-30']); +require('../lib/services/cognitoidentity'); +Object.defineProperty(apiLoader.services['cognitoidentity'], '2014-06-30', { + get: function get() { + var model = require('../apis/cognito-identity-2014-06-30.min.json'); + model.paginators = require('../apis/cognito-identity-2014-06-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CognitoIdentity; diff --git a/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts b/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts new file mode 100644 index 0000000..a7bb660 --- /dev/null +++ b/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts @@ -0,0 +1,4368 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CognitoIdentityServiceProvider extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CognitoIdentityServiceProvider.Types.ClientConfiguration) + config: Config & CognitoIdentityServiceProvider.Types.ClientConfiguration; + /** + * Adds additional user attributes to the user pool schema. + */ + addCustomAttributes(params: CognitoIdentityServiceProvider.Types.AddCustomAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse) => void): Request; + /** + * Adds additional user attributes to the user pool schema. + */ + addCustomAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse) => void): Request; + /** + * Adds the specified user to the specified group. Requires developer credentials. + */ + adminAddUserToGroup(params: CognitoIdentityServiceProvider.Types.AdminAddUserToGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds the specified user to the specified group. Requires developer credentials. + */ + adminAddUserToGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Confirms user registration as an admin without using a confirmation code. Works on any user. Requires developer credentials. + */ + adminConfirmSignUp(params: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse) => void): Request; + /** + * Confirms user registration as an admin without using a confirmation code. Works on any user. Requires developer credentials. + */ + adminConfirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse) => void): Request; + /** + * Creates a new user in the specified user pool. If MessageAction is not set, the default is to send a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials. + */ + adminCreateUser(params: CognitoIdentityServiceProvider.Types.AdminCreateUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request; + /** + * Creates a new user in the specified user pool. If MessageAction is not set, the default is to send a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials. + */ + adminCreateUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request; + /** + * Deletes a user as an administrator. Works on any user. Requires developer credentials. + */ + adminDeleteUser(params: CognitoIdentityServiceProvider.Types.AdminDeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a user as an administrator. Works on any user. Requires developer credentials. + */ + adminDeleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the user attributes in a user pool as an administrator. Works on any user. Requires developer credentials. + */ + adminDeleteUserAttributes(params: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse) => void): Request; + /** + * Deletes the user attributes in a user pool as an administrator. Works on any user. Requires developer credentials. + */ + adminDeleteUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse) => void): Request; + /** + * Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See . This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion. + */ + adminDisableProviderForUser(params: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse) => void): Request; + /** + * Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See . This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion. + */ + adminDisableProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse) => void): Request; + /** + * Disables the specified user as an administrator. Works on any user. Requires developer credentials. + */ + adminDisableUser(params: CognitoIdentityServiceProvider.Types.AdminDisableUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableUserResponse) => void): Request; + /** + * Disables the specified user as an administrator. Works on any user. Requires developer credentials. + */ + adminDisableUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableUserResponse) => void): Request; + /** + * Enables the specified user as an administrator. Works on any user. Requires developer credentials. + */ + adminEnableUser(params: CognitoIdentityServiceProvider.Types.AdminEnableUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminEnableUserResponse) => void): Request; + /** + * Enables the specified user as an administrator. Works on any user. Requires developer credentials. + */ + adminEnableUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminEnableUserResponse) => void): Request; + /** + * Forgets the device, as an administrator. Requires developer credentials. + */ + adminForgetDevice(params: CognitoIdentityServiceProvider.Types.AdminForgetDeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Forgets the device, as an administrator. Requires developer credentials. + */ + adminForgetDevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets the device, as an administrator. Requires developer credentials. + */ + adminGetDevice(params: CognitoIdentityServiceProvider.Types.AdminGetDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse) => void): Request; + /** + * Gets the device, as an administrator. Requires developer credentials. + */ + adminGetDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse) => void): Request; + /** + * Gets the specified user by user name in a user pool as an administrator. Works on any user. Requires developer credentials. + */ + adminGetUser(params: CognitoIdentityServiceProvider.Types.AdminGetUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetUserResponse) => void): Request; + /** + * Gets the specified user by user name in a user pool as an administrator. Works on any user. Requires developer credentials. + */ + adminGetUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetUserResponse) => void): Request; + /** + * Initiates the authentication flow, as an administrator. Requires developer credentials. + */ + adminInitiateAuth(params: CognitoIdentityServiceProvider.Types.AdminInitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request; + /** + * Initiates the authentication flow, as an administrator. Requires developer credentials. + */ + adminInitiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request; + /** + * Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. See also . This action is enabled only for admin access and requires developer credentials. + */ + adminLinkProviderForUser(params: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse) => void): Request; + /** + * Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. See also . This action is enabled only for admin access and requires developer credentials. + */ + adminLinkProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse) => void): Request; + /** + * Lists devices, as an administrator. Requires developer credentials. + */ + adminListDevices(params: CognitoIdentityServiceProvider.Types.AdminListDevicesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListDevicesResponse) => void): Request; + /** + * Lists devices, as an administrator. Requires developer credentials. + */ + adminListDevices(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListDevicesResponse) => void): Request; + /** + * Lists the groups that the user belongs to. Requires developer credentials. + */ + adminListGroupsForUser(params: CognitoIdentityServiceProvider.Types.AdminListGroupsForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse) => void): Request; + /** + * Lists the groups that the user belongs to. Requires developer credentials. + */ + adminListGroupsForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse) => void): Request; + /** + * Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security. + */ + adminListUserAuthEvents(params: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse) => void): Request; + /** + * Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security. + */ + adminListUserAuthEvents(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse) => void): Request; + /** + * Removes the specified user from the specified group. Requires developer credentials. + */ + adminRemoveUserFromGroup(params: CognitoIdentityServiceProvider.Types.AdminRemoveUserFromGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified user from the specified group. Requires developer credentials. + */ + adminRemoveUserFromGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. Requires developer credentials. + */ + adminResetUserPassword(params: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request; + /** + * Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. Requires developer credentials. + */ + adminResetUserPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request; + /** + * Responds to an authentication challenge, as an administrator. Requires developer credentials. + */ + adminRespondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request; + /** + * Responds to an authentication challenge, as an administrator. Requires developer credentials. + */ + adminRespondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request; + /** + * Sets the user's multi-factor authentication (MFA) preference. + */ + adminSetUserMFAPreference(params: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse) => void): Request; + /** + * Sets the user's multi-factor authentication (MFA) preference. + */ + adminSetUserMFAPreference(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse) => void): Request; + /** + * + */ + adminSetUserPassword(params: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse) => void): Request; + /** + * + */ + adminSetUserPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse) => void): Request; + /** + * Sets all the user settings for a specified user name. Works on any user. Requires developer credentials. + */ + adminSetUserSettings(params: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request; + /** + * Sets all the user settings for a specified user name. Works on any user. Requires developer credentials. + */ + adminSetUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request; + /** + * Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. + */ + adminUpdateAuthEventFeedback(params: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse) => void): Request; + /** + * Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. + */ + adminUpdateAuthEventFeedback(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse) => void): Request; + /** + * Updates the device status as an administrator. Requires developer credentials. + */ + adminUpdateDeviceStatus(params: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse) => void): Request; + /** + * Updates the device status as an administrator. Requires developer credentials. + */ + adminUpdateDeviceStatus(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse) => void): Request; + /** + * Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. Requires developer credentials. + */ + adminUpdateUserAttributes(params: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request; + /** + * Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. Requires developer credentials. + */ + adminUpdateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request; + /** + * Signs out users from all devices, as an administrator. Requires developer credentials. + */ + adminUserGlobalSignOut(params: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request; + /** + * Signs out users from all devices, as an administrator. Requires developer credentials. + */ + adminUserGlobalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request; + /** + * Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both. + */ + associateSoftwareToken(params: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse) => void): Request; + /** + * Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both. + */ + associateSoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse) => void): Request; + /** + * Changes the password for a specified user in a user pool. + */ + changePassword(params: CognitoIdentityServiceProvider.Types.ChangePasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ChangePasswordResponse) => void): Request; + /** + * Changes the password for a specified user in a user pool. + */ + changePassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ChangePasswordResponse) => void): Request; + /** + * Confirms tracking of the device. This API call is the call that begins device tracking. + */ + confirmDevice(params: CognitoIdentityServiceProvider.Types.ConfirmDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse) => void): Request; + /** + * Confirms tracking of the device. This API call is the call that begins device tracking. + */ + confirmDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse) => void): Request; + /** + * Allows a user to enter a confirmation code to reset a forgotten password. + */ + confirmForgotPassword(params: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse) => void): Request; + /** + * Allows a user to enter a confirmation code to reset a forgotten password. + */ + confirmForgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse) => void): Request; + /** + * Confirms registration of a user and handles the existing alias from a previous user. + */ + confirmSignUp(params: CognitoIdentityServiceProvider.Types.ConfirmSignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request; + /** + * Confirms registration of a user and handles the existing alias from a previous user. + */ + confirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request; + /** + * Creates a new group in the specified user pool. Requires developer credentials. + */ + createGroup(params: CognitoIdentityServiceProvider.Types.CreateGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateGroupResponse) => void): Request; + /** + * Creates a new group in the specified user pool. Requires developer credentials. + */ + createGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateGroupResponse) => void): Request; + /** + * Creates an identity provider for a user pool. + */ + createIdentityProvider(params: CognitoIdentityServiceProvider.Types.CreateIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse) => void): Request; + /** + * Creates an identity provider for a user pool. + */ + createIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse) => void): Request; + /** + * Creates a new OAuth2.0 resource server and defines custom scopes in it. + */ + createResourceServer(params: CognitoIdentityServiceProvider.Types.CreateResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateResourceServerResponse) => void): Request; + /** + * Creates a new OAuth2.0 resource server and defines custom scopes in it. + */ + createResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateResourceServerResponse) => void): Request; + /** + * Creates the user import job. + */ + createUserImportJob(params: CognitoIdentityServiceProvider.Types.CreateUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse) => void): Request; + /** + * Creates the user import job. + */ + createUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse) => void): Request; + /** + * Creates a new Amazon Cognito user pool and sets the password policy for the pool. + */ + createUserPool(params: CognitoIdentityServiceProvider.Types.CreateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request; + /** + * Creates a new Amazon Cognito user pool and sets the password policy for the pool. + */ + createUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request; + /** + * Creates the user pool client. + */ + createUserPoolClient(params: CognitoIdentityServiceProvider.Types.CreateUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request; + /** + * Creates the user pool client. + */ + createUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request; + /** + * Creates a new domain for a user pool. + */ + createUserPoolDomain(params: CognitoIdentityServiceProvider.Types.CreateUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolDomainResponse) => void): Request; + /** + * Creates a new domain for a user pool. + */ + createUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolDomainResponse) => void): Request; + /** + * Deletes a group. Currently only groups with no members can be deleted. Requires developer credentials. + */ + deleteGroup(params: CognitoIdentityServiceProvider.Types.DeleteGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a group. Currently only groups with no members can be deleted. Requires developer credentials. + */ + deleteGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an identity provider for a user pool. + */ + deleteIdentityProvider(params: CognitoIdentityServiceProvider.Types.DeleteIdentityProviderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an identity provider for a user pool. + */ + deleteIdentityProvider(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a resource server. + */ + deleteResourceServer(params: CognitoIdentityServiceProvider.Types.DeleteResourceServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a resource server. + */ + deleteResourceServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Allows a user to delete himself or herself. + */ + deleteUser(params: CognitoIdentityServiceProvider.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Allows a user to delete himself or herself. + */ + deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the attributes for a user. + */ + deleteUserAttributes(params: CognitoIdentityServiceProvider.Types.DeleteUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse) => void): Request; + /** + * Deletes the attributes for a user. + */ + deleteUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse) => void): Request; + /** + * Deletes the specified Amazon Cognito user pool. + */ + deleteUserPool(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Amazon Cognito user pool. + */ + deleteUserPool(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Allows the developer to delete the user pool client. + */ + deleteUserPoolClient(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolClientRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Allows the developer to delete the user pool client. + */ + deleteUserPoolClient(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a domain for a user pool. + */ + deleteUserPoolDomain(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse) => void): Request; + /** + * Deletes a domain for a user pool. + */ + deleteUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse) => void): Request; + /** + * Gets information about a specific identity provider. + */ + describeIdentityProvider(params: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse) => void): Request; + /** + * Gets information about a specific identity provider. + */ + describeIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse) => void): Request; + /** + * Describes a resource server. + */ + describeResourceServer(params: CognitoIdentityServiceProvider.Types.DescribeResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeResourceServerResponse) => void): Request; + /** + * Describes a resource server. + */ + describeResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeResourceServerResponse) => void): Request; + /** + * Describes the risk configuration. + */ + describeRiskConfiguration(params: CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationResponse) => void): Request; + /** + * Describes the risk configuration. + */ + describeRiskConfiguration(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationResponse) => void): Request; + /** + * Describes the user import job. + */ + describeUserImportJob(params: CognitoIdentityServiceProvider.Types.DescribeUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse) => void): Request; + /** + * Describes the user import job. + */ + describeUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse) => void): Request; + /** + * Returns the configuration information and metadata of the specified user pool. + */ + describeUserPool(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse) => void): Request; + /** + * Returns the configuration information and metadata of the specified user pool. + */ + describeUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse) => void): Request; + /** + * Client method for returning the configuration information and metadata of the specified user pool app client. + */ + describeUserPoolClient(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse) => void): Request; + /** + * Client method for returning the configuration information and metadata of the specified user pool app client. + */ + describeUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse) => void): Request; + /** + * Gets information about a domain. + */ + describeUserPoolDomain(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainResponse) => void): Request; + /** + * Gets information about a domain. + */ + describeUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainResponse) => void): Request; + /** + * Forgets the specified device. + */ + forgetDevice(params: CognitoIdentityServiceProvider.Types.ForgetDeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Forgets the specified device. + */ + forgetDevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call . + */ + forgotPassword(params: CognitoIdentityServiceProvider.Types.ForgotPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request; + /** + * Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call . + */ + forgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request; + /** + * Gets the header information for the .csv file to be used as input for the user import job. + */ + getCSVHeader(params: CognitoIdentityServiceProvider.Types.GetCSVHeaderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request; + /** + * Gets the header information for the .csv file to be used as input for the user import job. + */ + getCSVHeader(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request; + /** + * Gets the device. + */ + getDevice(params: CognitoIdentityServiceProvider.Types.GetDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetDeviceResponse) => void): Request; + /** + * Gets the device. + */ + getDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetDeviceResponse) => void): Request; + /** + * Gets a group. Requires developer credentials. + */ + getGroup(params: CognitoIdentityServiceProvider.Types.GetGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetGroupResponse) => void): Request; + /** + * Gets a group. Requires developer credentials. + */ + getGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetGroupResponse) => void): Request; + /** + * Gets the specified identity provider. + */ + getIdentityProviderByIdentifier(params: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse) => void): Request; + /** + * Gets the specified identity provider. + */ + getIdentityProviderByIdentifier(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse) => void): Request; + /** + * This method takes a user pool ID, and returns the signing certificate. + */ + getSigningCertificate(params: CognitoIdentityServiceProvider.Types.GetSigningCertificateRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse) => void): Request; + /** + * This method takes a user pool ID, and returns the signing certificate. + */ + getSigningCertificate(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse) => void): Request; + /** + * Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned. + */ + getUICustomization(params: CognitoIdentityServiceProvider.Types.GetUICustomizationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUICustomizationResponse) => void): Request; + /** + * Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned. + */ + getUICustomization(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUICustomizationResponse) => void): Request; + /** + * Gets the user attributes and metadata for a user. + */ + getUser(params: CognitoIdentityServiceProvider.Types.GetUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserResponse) => void): Request; + /** + * Gets the user attributes and metadata for a user. + */ + getUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserResponse) => void): Request; + /** + * Gets the user attribute verification code for the specified attribute name. + */ + getUserAttributeVerificationCode(params: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request; + /** + * Gets the user attribute verification code for the specified attribute name. + */ + getUserAttributeVerificationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request; + /** + * Gets the user pool multi-factor authentication (MFA) configuration. + */ + getUserPoolMfaConfig(params: CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse) => void): Request; + /** + * Gets the user pool multi-factor authentication (MFA) configuration. + */ + getUserPoolMfaConfig(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse) => void): Request; + /** + * Signs out users from all devices. + */ + globalSignOut(params: CognitoIdentityServiceProvider.Types.GlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request; + /** + * Signs out users from all devices. + */ + globalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request; + /** + * Initiates the authentication flow. + */ + initiateAuth(params: CognitoIdentityServiceProvider.Types.InitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request; + /** + * Initiates the authentication flow. + */ + initiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request; + /** + * Lists the devices. + */ + listDevices(params: CognitoIdentityServiceProvider.Types.ListDevicesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request; + /** + * Lists the devices. + */ + listDevices(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request; + /** + * Lists the groups associated with a user pool. Requires developer credentials. + */ + listGroups(params: CognitoIdentityServiceProvider.Types.ListGroupsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListGroupsResponse) => void): Request; + /** + * Lists the groups associated with a user pool. Requires developer credentials. + */ + listGroups(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListGroupsResponse) => void): Request; + /** + * Lists information about all identity providers for a user pool. + */ + listIdentityProviders(params: CognitoIdentityServiceProvider.Types.ListIdentityProvidersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse) => void): Request; + /** + * Lists information about all identity providers for a user pool. + */ + listIdentityProviders(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse) => void): Request; + /** + * Lists the resource servers for a user pool. + */ + listResourceServers(params: CognitoIdentityServiceProvider.Types.ListResourceServersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListResourceServersResponse) => void): Request; + /** + * Lists the resource servers for a user pool. + */ + listResourceServers(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListResourceServersResponse) => void): Request; + /** + * Lists the tags that are assigned to an Amazon Cognito user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. + */ + listTagsForResource(params: CognitoIdentityServiceProvider.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags that are assigned to an Amazon Cognito user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. + */ + listTagsForResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the user import jobs. + */ + listUserImportJobs(params: CognitoIdentityServiceProvider.Types.ListUserImportJobsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse) => void): Request; + /** + * Lists the user import jobs. + */ + listUserImportJobs(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse) => void): Request; + /** + * Lists the clients that have been created for the specified user pool. + */ + listUserPoolClients(params: CognitoIdentityServiceProvider.Types.ListUserPoolClientsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse) => void): Request; + /** + * Lists the clients that have been created for the specified user pool. + */ + listUserPoolClients(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse) => void): Request; + /** + * Lists the user pools associated with an AWS account. + */ + listUserPools(params: CognitoIdentityServiceProvider.Types.ListUserPoolsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request; + /** + * Lists the user pools associated with an AWS account. + */ + listUserPools(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request; + /** + * Lists the users in the Amazon Cognito user pool. + */ + listUsers(params: CognitoIdentityServiceProvider.Types.ListUsersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersResponse) => void): Request; + /** + * Lists the users in the Amazon Cognito user pool. + */ + listUsers(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersResponse) => void): Request; + /** + * Lists the users in the specified group. Requires developer credentials. + */ + listUsersInGroup(params: CognitoIdentityServiceProvider.Types.ListUsersInGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse) => void): Request; + /** + * Lists the users in the specified group. Requires developer credentials. + */ + listUsersInGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse) => void): Request; + /** + * Resends the confirmation (for confirmation of registration) to a specific user in the user pool. + */ + resendConfirmationCode(params: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request; + /** + * Resends the confirmation (for confirmation of registration) to a specific user in the user pool. + */ + resendConfirmationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request; + /** + * Responds to the authentication challenge. + */ + respondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request; + /** + * Responds to the authentication challenge. + */ + respondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request; + /** + * Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode. See . + */ + setRiskConfiguration(params: CognitoIdentityServiceProvider.Types.SetRiskConfigurationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse) => void): Request; + /** + * Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode. See . + */ + setRiskConfiguration(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse) => void): Request; + /** + * Sets the UI customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error. + */ + setUICustomization(params: CognitoIdentityServiceProvider.Types.SetUICustomizationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUICustomizationResponse) => void): Request; + /** + * Sets the UI customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error. + */ + setUICustomization(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUICustomizationResponse) => void): Request; + /** + * Set the user's multi-factor authentication (MFA) method preference. + */ + setUserMFAPreference(params: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse) => void): Request; + /** + * Set the user's multi-factor authentication (MFA) method preference. + */ + setUserMFAPreference(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse) => void): Request; + /** + * Set the user pool MFA configuration. + */ + setUserPoolMfaConfig(params: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse) => void): Request; + /** + * Set the user pool MFA configuration. + */ + setUserPoolMfaConfig(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse) => void): Request; + /** + * Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed. + */ + setUserSettings(params: CognitoIdentityServiceProvider.Types.SetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request; + /** + * Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed. + */ + setUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request; + /** + * Registers the user in the specified user pool and creates a user name, password, and user attributes. + */ + signUp(params: CognitoIdentityServiceProvider.Types.SignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request; + /** + * Registers the user in the specified user pool and creates a user name, password, and user attributes. + */ + signUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request; + /** + * Starts the user import. + */ + startUserImportJob(params: CognitoIdentityServiceProvider.Types.StartUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StartUserImportJobResponse) => void): Request; + /** + * Starts the user import. + */ + startUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StartUserImportJobResponse) => void): Request; + /** + * Stops the user import job. + */ + stopUserImportJob(params: CognitoIdentityServiceProvider.Types.StopUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StopUserImportJobResponse) => void): Request; + /** + * Stops the user import job. + */ + stopUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StopUserImportJobResponse) => void): Request; + /** + * Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags. + */ + tagResource(params: CognitoIdentityServiceProvider.Types.TagResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.TagResourceResponse) => void): Request; + /** + * Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags. + */ + tagResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.TagResourceResponse) => void): Request; + /** + * Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account + */ + untagResource(params: CognitoIdentityServiceProvider.Types.UntagResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UntagResourceResponse) => void): Request; + /** + * Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account + */ + untagResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UntagResourceResponse) => void): Request; + /** + * Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. + */ + updateAuthEventFeedback(params: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse) => void): Request; + /** + * Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. + */ + updateAuthEventFeedback(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse) => void): Request; + /** + * Updates the device status. + */ + updateDeviceStatus(params: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse) => void): Request; + /** + * Updates the device status. + */ + updateDeviceStatus(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse) => void): Request; + /** + * Updates the specified group with the specified attributes. Requires developer credentials. + */ + updateGroup(params: CognitoIdentityServiceProvider.Types.UpdateGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateGroupResponse) => void): Request; + /** + * Updates the specified group with the specified attributes. Requires developer credentials. + */ + updateGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateGroupResponse) => void): Request; + /** + * Updates identity provider information for a user pool. + */ + updateIdentityProvider(params: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse) => void): Request; + /** + * Updates identity provider information for a user pool. + */ + updateIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse) => void): Request; + /** + * Updates the name and scopes of resource server. All other fields are read-only. + */ + updateResourceServer(params: CognitoIdentityServiceProvider.Types.UpdateResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse) => void): Request; + /** + * Updates the name and scopes of resource server. All other fields are read-only. + */ + updateResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse) => void): Request; + /** + * Allows a user to update a specific attribute (one at a time). + */ + updateUserAttributes(params: CognitoIdentityServiceProvider.Types.UpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request; + /** + * Allows a user to update a specific attribute (one at a time). + */ + updateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request; + /** + * Updates the specified user pool with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool settings with . + */ + updateUserPool(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request; + /** + * Updates the specified user pool with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool settings with . + */ + updateUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request; + /** + * Updates the specified user pool app client with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool app client settings with . + */ + updateUserPoolClient(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse) => void): Request; + /** + * Updates the specified user pool app client with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool app client settings with . + */ + updateUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse) => void): Request; + /** + * Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI. + */ + updateUserPoolDomain(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse) => void): Request; + /** + * Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI. + */ + updateUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse) => void): Request; + /** + * Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both. + */ + verifySoftwareToken(params: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse) => void): Request; + /** + * Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both. + */ + verifySoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse) => void): Request; + /** + * Verifies the specified user attributes in the user pool. + */ + verifyUserAttribute(params: CognitoIdentityServiceProvider.Types.VerifyUserAttributeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request; + /** + * Verifies the specified user attributes in the user pool. + */ + verifyUserAttribute(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request; +} +declare namespace CognitoIdentityServiceProvider { + export type AWSAccountIdType = string; + export type AccountTakeoverActionNotifyType = boolean; + export interface AccountTakeoverActionType { + /** + * Flag specifying whether to send a notification. + */ + Notify: AccountTakeoverActionNotifyType; + /** + * The event action. BLOCK Choosing this action will block the request. MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request. MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request. NO_ACTION Allow the user sign-in. + */ + EventAction: AccountTakeoverEventActionType; + } + export interface AccountTakeoverActionsType { + /** + * Action to take for a low risk. + */ + LowAction?: AccountTakeoverActionType; + /** + * Action to take for a medium risk. + */ + MediumAction?: AccountTakeoverActionType; + /** + * Action to take for a high risk. + */ + HighAction?: AccountTakeoverActionType; + } + export type AccountTakeoverEventActionType = "BLOCK"|"MFA_IF_CONFIGURED"|"MFA_REQUIRED"|"NO_ACTION"|string; + export interface AccountTakeoverRiskConfigurationType { + /** + * The notify configuration used to construct email notifications. + */ + NotifyConfiguration?: NotifyConfigurationType; + /** + * Account takeover risk configuration actions + */ + Actions: AccountTakeoverActionsType; + } + export interface AddCustomAttributesRequest { + /** + * The user pool ID for the user pool where you want to add custom attributes. + */ + UserPoolId: UserPoolIdType; + /** + * An array of custom attributes, such as Mutable and Name. + */ + CustomAttributes: CustomAttributesListType; + } + export interface AddCustomAttributesResponse { + } + export interface AdminAddUserToGroupRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The username for the user. + */ + Username: UsernameType; + /** + * The group name. + */ + GroupName: GroupNameType; + } + export interface AdminConfirmSignUpRequest { + /** + * The user pool ID for which you want to confirm user registration. + */ + UserPoolId: UserPoolIdType; + /** + * The user name for which you want to confirm user registration. + */ + Username: UsernameType; + } + export interface AdminConfirmSignUpResponse { + } + export interface AdminCreateUserConfigType { + /** + * Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app. + */ + AllowAdminCreateUserOnly?: BooleanType; + /** + * The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7. If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool. + */ + UnusedAccountValidityDays?: AdminCreateUserUnusedAccountValidityDaysType; + /** + * The message template to be used for the welcome message to new users. See also Customizing User Invitation Messages. + */ + InviteMessageTemplate?: MessageTemplateType; + } + export interface AdminCreateUserRequest { + /** + * The user pool ID for the user pool where the user will be created. + */ + UserPoolId: UserPoolIdType; + /** + * The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed. + */ + Username: UsernameType; + /** + * An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). For custom attributes, you must prepend the custom: prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools. In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling .) email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter. + */ + UserAttributes?: AttributeListType; + /** + * The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user's validation data is not persisted. + */ + ValidationData?: AttributeListType; + /** + * The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins. This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you. The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. + */ + TemporaryPassword?: PasswordType; + /** + * This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False. + */ + ForceAliasCreation?: ForceAliasCreation; + /** + * Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified. + */ + MessageAction?: MessageActionType; + /** + * Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified. + */ + DesiredDeliveryMediums?: DeliveryMediumListType; + } + export interface AdminCreateUserResponse { + /** + * The newly created user. + */ + User?: UserType; + } + export type AdminCreateUserUnusedAccountValidityDaysType = number; + export interface AdminDeleteUserAttributesRequest { + /** + * The user pool ID for the user pool where you want to delete user attributes. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user from which you would like to delete attributes. + */ + Username: UsernameType; + /** + * An array of strings representing the user attribute names you wish to delete. For custom attributes, you must prepend the custom: prefix to the attribute name. + */ + UserAttributeNames: AttributeNameListType; + } + export interface AdminDeleteUserAttributesResponse { + } + export interface AdminDeleteUserRequest { + /** + * The user pool ID for the user pool where you want to delete the user. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user you wish to delete. + */ + Username: UsernameType; + } + export interface AdminDisableProviderForUserRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: StringType; + /** + * The user to be disabled. + */ + User: ProviderUserIdentifierType; + } + export interface AdminDisableProviderForUserResponse { + } + export interface AdminDisableUserRequest { + /** + * The user pool ID for the user pool where you want to disable the user. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user you wish to disable. + */ + Username: UsernameType; + } + export interface AdminDisableUserResponse { + } + export interface AdminEnableUserRequest { + /** + * The user pool ID for the user pool where you want to enable the user. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user you wish to enable. + */ + Username: UsernameType; + } + export interface AdminEnableUserResponse { + } + export interface AdminForgetDeviceRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user name. + */ + Username: UsernameType; + /** + * The device key. + */ + DeviceKey: DeviceKeyType; + } + export interface AdminGetDeviceRequest { + /** + * The device key. + */ + DeviceKey: DeviceKeyType; + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user name. + */ + Username: UsernameType; + } + export interface AdminGetDeviceResponse { + /** + * The device. + */ + Device: DeviceType; + } + export interface AdminGetUserRequest { + /** + * The user pool ID for the user pool where you want to get information about the user. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user you wish to retrieve. + */ + Username: UsernameType; + } + export interface AdminGetUserResponse { + /** + * The user name of the user about whom you are receiving information. + */ + Username: UsernameType; + /** + * An array of name-value pairs representing user attributes. + */ + UserAttributes?: AttributeListType; + /** + * The date the user was created. + */ + UserCreateDate?: DateType; + /** + * The date the user was last modified. + */ + UserLastModifiedDate?: DateType; + /** + * Indicates that the status is enabled. + */ + Enabled?: BooleanType; + /** + * The user status. Can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. ARCHIVED - User is no longer active. COMPROMISED - User is disabled due to a potential security threat. UNKNOWN - User status is not known. RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in. FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else. + */ + UserStatus?: UserStatusType; + /** + * Specifies the options for MFA (e.g., email or phone number). + */ + MFAOptions?: MFAOptionListType; + /** + * The user's preferred MFA setting. + */ + PreferredMfaSetting?: StringType; + /** + * The list of the user's MFA settings. + */ + UserMFASettingList?: UserMFASettingListType; + } + export interface AdminInitiateAuthRequest { + /** + * The ID of the Amazon Cognito user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The app client ID. + */ + ClientId: ClientIdType; + /** + * The authentication flow for this call to execute. The API action will depend on this value. For example: REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens. USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution. USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens. Valid values include: USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol. REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. CUSTOM_AUTH: Custom authentication flow. ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client. USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool. + */ + AuthFlow: AuthFlowType; + /** + * The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow: For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY + */ + AuthParameters?: AuthParametersType; + /** + * This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication. + */ + ClientMetadata?: ClientMetadataType; + /** + * The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + ContextData?: ContextDataType; + } + export interface AdminInitiateAuthResponse { + /** + * The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge. MFA_SETUP: If MFA is required, users who do not have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate. SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for TOTP software token MFA. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow. NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes. + */ + ChallengeName?: ChallengeNameType; + /** + * The session which should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call. + */ + Session?: SessionType; + /** + * The challenge parameters. These are returned to you in the AdminInitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge). All challenges require USERNAME and SECRET_HASH (if applicable). The value of the USER_ID_FOR_SRP attribute will be the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This is because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute cannot be an alias. + */ + ChallengeParameters?: ChallengeParametersType; + /** + * The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned. + */ + AuthenticationResult?: AuthenticationResultType; + } + export interface AdminLinkProviderForUserRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: StringType; + /** + * The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in. For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id. The ProviderAttributeName of the DestinationUser is ignored. The ProviderName should be set to Cognito for users in Cognito user pools. + */ + DestinationUser: ProviderUserIdentifierType; + /** + * An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user. If the SourceUser is a federated social identity provider user (Facebook, Google, or Login with Amazon), you must set the ProviderAttributeName to Cognito_Subject. For social identity providers, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social identity provider token. For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Cognito will automatically parse the default unique identifier found in the subject from the SAML token. + */ + SourceUser: ProviderUserIdentifierType; + } + export interface AdminLinkProviderForUserResponse { + } + export interface AdminListDevicesRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user name. + */ + Username: UsernameType; + /** + * The limit of the devices request. + */ + Limit?: QueryLimitType; + /** + * The pagination token. + */ + PaginationToken?: SearchPaginationTokenType; + } + export interface AdminListDevicesResponse { + /** + * The devices in the list of devices response. + */ + Devices?: DeviceListType; + /** + * The pagination token. + */ + PaginationToken?: SearchPaginationTokenType; + } + export interface AdminListGroupsForUserRequest { + /** + * The username for the user. + */ + Username: UsernameType; + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The limit of the request to list groups. + */ + Limit?: QueryLimitType; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface AdminListGroupsForUserResponse { + /** + * The groups that the user belongs to. + */ + Groups?: GroupListType; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface AdminListUserAuthEventsRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user pool username or an alias. + */ + Username: UsernameType; + /** + * The maximum number of authentication events to return. + */ + MaxResults?: QueryLimitType; + /** + * A pagination token. + */ + NextToken?: PaginationKey; + } + export interface AdminListUserAuthEventsResponse { + /** + * The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse. + */ + AuthEvents?: AuthEventsType; + /** + * A pagination token. + */ + NextToken?: PaginationKey; + } + export interface AdminRemoveUserFromGroupRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The username for the user. + */ + Username: UsernameType; + /** + * The group name. + */ + GroupName: GroupNameType; + } + export interface AdminResetUserPasswordRequest { + /** + * The user pool ID for the user pool where you want to reset the user's password. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user whose password you wish to reset. + */ + Username: UsernameType; + } + export interface AdminResetUserPasswordResponse { + } + export interface AdminRespondToAuthChallengeRequest { + /** + * The ID of the Amazon Cognito user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The app client ID. + */ + ClientId: ClientIdType; + /** + * The challenge name. For more information, see . + */ + ChallengeName: ChallengeNameType; + /** + * The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret). ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret). The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth. + */ + ChallengeResponses?: ChallengeResponsesType; + /** + * The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call. + */ + Session?: SessionType; + /** + * The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + ContextData?: ContextDataType; + } + export interface AdminRespondToAuthChallengeResponse { + /** + * The name of the challenge. For more information, see . + */ + ChallengeName?: ChallengeNameType; + /** + * The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call. + */ + Session?: SessionType; + /** + * The challenge parameters. For more information, see . + */ + ChallengeParameters?: ChallengeParametersType; + /** + * The result returned by the server in response to the authentication request. + */ + AuthenticationResult?: AuthenticationResultType; + } + export interface AdminSetUserMFAPreferenceRequest { + /** + * The SMS text message MFA settings. + */ + SMSMfaSettings?: SMSMfaSettingsType; + /** + * The time-based one-time password software token MFA settings. + */ + SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType; + /** + * The user pool username or alias. + */ + Username: UsernameType; + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + } + export interface AdminSetUserMFAPreferenceResponse { + } + export interface AdminSetUserPasswordRequest { + UserPoolId: UserPoolIdType; + Username: UsernameType; + Password: PasswordType; + Permanent?: BooleanType; + } + export interface AdminSetUserPasswordResponse { + } + export interface AdminSetUserSettingsRequest { + /** + * The user pool ID for the user pool where you want to set the user's settings, such as MFA options. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user for whom you wish to set user settings. + */ + Username: UsernameType; + /** + * Specifies the options for MFA (e.g., email or phone number). + */ + MFAOptions: MFAOptionListType; + } + export interface AdminSetUserSettingsResponse { + } + export interface AdminUpdateAuthEventFeedbackRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user pool username. + */ + Username: UsernameType; + /** + * The authentication event ID. + */ + EventId: EventIdType; + /** + * The authentication event feedback value. + */ + FeedbackValue: FeedbackValueType; + } + export interface AdminUpdateAuthEventFeedbackResponse { + } + export interface AdminUpdateDeviceStatusRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user name. + */ + Username: UsernameType; + /** + * The device key. + */ + DeviceKey: DeviceKeyType; + /** + * The status indicating whether a device has been remembered or not. + */ + DeviceRememberedStatus?: DeviceRememberedStatusType; + } + export interface AdminUpdateDeviceStatusResponse { + } + export interface AdminUpdateUserAttributesRequest { + /** + * The user pool ID for the user pool where you want to update user attributes. + */ + UserPoolId: UserPoolIdType; + /** + * The user name of the user for whom you want to update user attributes. + */ + Username: UsernameType; + /** + * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name. + */ + UserAttributes: AttributeListType; + } + export interface AdminUpdateUserAttributesResponse { + } + export interface AdminUserGlobalSignOutRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user name. + */ + Username: UsernameType; + } + export interface AdminUserGlobalSignOutResponse { + } + export type AdvancedSecurityModeType = "OFF"|"AUDIT"|"ENFORCED"|string; + export type AliasAttributeType = "phone_number"|"email"|"preferred_username"|string; + export type AliasAttributesListType = AliasAttributeType[]; + export interface AnalyticsConfigurationType { + /** + * The application ID for an Amazon Pinpoint application. + */ + ApplicationId: HexStringType; + /** + * The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. + */ + RoleArn: ArnType; + /** + * The external ID. + */ + ExternalId: StringType; + /** + * If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics. + */ + UserDataShared?: BooleanType; + } + export interface AnalyticsMetadataType { + /** + * The endpoint ID. + */ + AnalyticsEndpointId?: StringType; + } + export type ArnType = string; + export interface AssociateSoftwareTokenRequest { + /** + * The access token. + */ + AccessToken?: TokenModelType; + /** + * The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process. + */ + Session?: SessionType; + } + export interface AssociateSoftwareTokenResponse { + /** + * A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code. + */ + SecretCode?: SecretCodeType; + /** + * The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process. + */ + Session?: SessionType; + } + export type AttributeDataType = "String"|"Number"|"DateTime"|"Boolean"|string; + export type AttributeListType = AttributeType[]; + export type AttributeMappingKeyType = string; + export type AttributeMappingType = {[key: string]: StringType}; + export type AttributeNameListType = AttributeNameType[]; + export type AttributeNameType = string; + export interface AttributeType { + /** + * The name of the attribute. + */ + Name: AttributeNameType; + /** + * The value of the attribute. + */ + Value?: AttributeValueType; + } + export type AttributeValueType = string; + export interface AuthEventType { + /** + * The event ID. + */ + EventId?: StringType; + /** + * The event type. + */ + EventType?: EventType; + /** + * The creation date + */ + CreationDate?: DateType; + /** + * The event response. + */ + EventResponse?: EventResponseType; + /** + * The event risk. + */ + EventRisk?: EventRiskType; + /** + * The challenge responses. + */ + ChallengeResponses?: ChallengeResponseListType; + /** + * The user context data captured at the time of an event request. It provides additional information about the client from which event the request is received. + */ + EventContextData?: EventContextDataType; + /** + * A flag specifying the user feedback captured at the time of an event request is good or bad. + */ + EventFeedback?: EventFeedbackType; + } + export type AuthEventsType = AuthEventType[]; + export type AuthFlowType = "USER_SRP_AUTH"|"REFRESH_TOKEN_AUTH"|"REFRESH_TOKEN"|"CUSTOM_AUTH"|"ADMIN_NO_SRP_AUTH"|"USER_PASSWORD_AUTH"|string; + export type AuthParametersType = {[key: string]: StringType}; + export interface AuthenticationResultType { + /** + * The access token. + */ + AccessToken?: TokenModelType; + /** + * The expiration period of the authentication result in seconds. + */ + ExpiresIn?: IntegerType; + /** + * The token type. + */ + TokenType?: StringType; + /** + * The refresh token. + */ + RefreshToken?: TokenModelType; + /** + * The ID token. + */ + IdToken?: TokenModelType; + /** + * The new device metadata from an authentication result. + */ + NewDeviceMetadata?: NewDeviceMetadataType; + } + export type BlockedIPRangeListType = StringType[]; + export type BooleanType = boolean; + export type CSSType = string; + export type CSSVersionType = string; + export type CallbackURLsListType = RedirectUrlType[]; + export type ChallengeName = "Password"|"Mfa"|string; + export type ChallengeNameType = "SMS_MFA"|"SOFTWARE_TOKEN_MFA"|"SELECT_MFA_TYPE"|"MFA_SETUP"|"PASSWORD_VERIFIER"|"CUSTOM_CHALLENGE"|"DEVICE_SRP_AUTH"|"DEVICE_PASSWORD_VERIFIER"|"ADMIN_NO_SRP_AUTH"|"NEW_PASSWORD_REQUIRED"|string; + export type ChallengeParametersType = {[key: string]: StringType}; + export type ChallengeResponse = "Success"|"Failure"|string; + export type ChallengeResponseListType = ChallengeResponseType[]; + export interface ChallengeResponseType { + /** + * The challenge name + */ + ChallengeName?: ChallengeName; + /** + * The challenge response. + */ + ChallengeResponse?: ChallengeResponse; + } + export type ChallengeResponsesType = {[key: string]: StringType}; + export interface ChangePasswordRequest { + /** + * The old password. + */ + PreviousPassword: PasswordType; + /** + * The new password. + */ + ProposedPassword: PasswordType; + /** + * The access token. + */ + AccessToken: TokenModelType; + } + export interface ChangePasswordResponse { + } + export type ClientIdType = string; + export type ClientMetadataType = {[key: string]: StringType}; + export type ClientNameType = string; + export type ClientPermissionListType = ClientPermissionType[]; + export type ClientPermissionType = string; + export type ClientSecretType = string; + export type CodeDeliveryDetailsListType = CodeDeliveryDetailsType[]; + export interface CodeDeliveryDetailsType { + /** + * The destination for the code delivery details. + */ + Destination?: StringType; + /** + * The delivery medium (email message or phone number). + */ + DeliveryMedium?: DeliveryMediumType; + /** + * The attribute name. + */ + AttributeName?: AttributeNameType; + } + export type CompletionMessageType = string; + export interface CompromisedCredentialsActionsType { + /** + * The event action. + */ + EventAction: CompromisedCredentialsEventActionType; + } + export type CompromisedCredentialsEventActionType = "BLOCK"|"NO_ACTION"|string; + export interface CompromisedCredentialsRiskConfigurationType { + /** + * Perform the action for these events. The default is to perform all events if no event filter is specified. + */ + EventFilter?: EventFiltersType; + /** + * The compromised credentials risk configuration actions. + */ + Actions: CompromisedCredentialsActionsType; + } + export interface ConfirmDeviceRequest { + /** + * The access token. + */ + AccessToken: TokenModelType; + /** + * The device key. + */ + DeviceKey: DeviceKeyType; + /** + * The configuration of the device secret verifier. + */ + DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType; + /** + * The device name. + */ + DeviceName?: DeviceNameType; + } + export interface ConfirmDeviceResponse { + /** + * Indicates whether the user confirmation is necessary to confirm the device response. + */ + UserConfirmationNecessary?: BooleanType; + } + export interface ConfirmForgotPasswordRequest { + /** + * The app client ID of the app associated with the user pool. + */ + ClientId: ClientIdType; + /** + * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. + */ + SecretHash?: SecretHashType; + /** + * The user name of the user for whom you want to enter a code to retrieve a forgotten password. + */ + Username: UsernameType; + /** + * The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see + */ + ConfirmationCode: ConfirmationCodeType; + /** + * The password sent by a user's request to retrieve a forgotten password. + */ + Password: PasswordType; + /** + * The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + UserContextData?: UserContextDataType; + } + export interface ConfirmForgotPasswordResponse { + } + export interface ConfirmSignUpRequest { + /** + * The ID of the app client associated with the user pool. + */ + ClientId: ClientIdType; + /** + * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. + */ + SecretHash?: SecretHashType; + /** + * The user name of the user whose registration you wish to confirm. + */ + Username: UsernameType; + /** + * The confirmation code sent by a user's request to confirm registration. + */ + ConfirmationCode: ConfirmationCodeType; + /** + * Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error. + */ + ForceAliasCreation?: ForceAliasCreation; + /** + * The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + UserContextData?: UserContextDataType; + } + export interface ConfirmSignUpResponse { + } + export type ConfirmationCodeType = string; + export interface ContextDataType { + /** + * Source IP address of your user. + */ + IpAddress: StringType; + /** + * Your server endpoint where this API is invoked. + */ + ServerName: StringType; + /** + * Your server path where this API is invoked. + */ + ServerPath: StringType; + /** + * HttpHeaders received on your server in same order. + */ + HttpHeaders: HttpHeaderList; + /** + * Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library. + */ + EncodedData?: StringType; + } + export interface CreateGroupRequest { + /** + * The name of the group. Must be unique. + */ + GroupName: GroupNameType; + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * A string containing the description of the group. + */ + Description?: DescriptionType; + /** + * The role ARN for the group. + */ + RoleArn?: ArnType; + /** + * A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens. The default Precedence value is null. + */ + Precedence?: PrecedenceType; + } + export interface CreateGroupResponse { + /** + * The group object for the group. + */ + Group?: GroupType; + } + export interface CreateIdentityProviderRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The identity provider name. + */ + ProviderName: ProviderNameTypeV1; + /** + * The identity provider type. + */ + ProviderType: IdentityProviderTypeType; + /** + * The identity provider details, such as MetadataURL and MetadataFile. + */ + ProviderDetails: ProviderDetailsType; + /** + * A mapping of identity provider attributes to standard and custom user pool attributes. + */ + AttributeMapping?: AttributeMappingType; + /** + * A list of identity provider identifiers. + */ + IdpIdentifiers?: IdpIdentifiersListType; + } + export interface CreateIdentityProviderResponse { + /** + * The newly created identity provider object. + */ + IdentityProvider: IdentityProviderType; + } + export interface CreateResourceServerRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com. + */ + Identifier: ResourceServerIdentifierType; + /** + * A friendly name for the resource server. + */ + Name: ResourceServerNameType; + /** + * A list of scopes. Each scope is map, where the keys are name and description. + */ + Scopes?: ResourceServerScopeListType; + } + export interface CreateResourceServerResponse { + /** + * The newly created resource server. + */ + ResourceServer: ResourceServerType; + } + export interface CreateUserImportJobRequest { + /** + * The job name for the user import job. + */ + JobName: UserImportJobNameType; + /** + * The user pool ID for the user pool that the users are being imported into. + */ + UserPoolId: UserPoolIdType; + /** + * The role ARN for the Amazon CloudWatch Logging role for the user import job. + */ + CloudWatchLogsRoleArn: ArnType; + } + export interface CreateUserImportJobResponse { + /** + * The job object that represents the user import job. + */ + UserImportJob?: UserImportJobType; + } + export interface CreateUserPoolClientRequest { + /** + * The user pool ID for the user pool where you want to create a user pool client. + */ + UserPoolId: UserPoolIdType; + /** + * The client name for the user pool client you would like to create. + */ + ClientName: ClientNameType; + /** + * Boolean to specify whether you want to generate a secret for the user pool client being created. + */ + GenerateSecret?: GenerateSecret; + /** + * The time limit, in days, after which the refresh token is no longer valid and cannot be used. + */ + RefreshTokenValidity?: RefreshTokenValidityType; + /** + * The read attributes. + */ + ReadAttributes?: ClientPermissionListType; + /** + * The user pool attributes that the app client can write to. If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool. + */ + WriteAttributes?: ClientPermissionListType; + /** + * The explicit authentication flows. + */ + ExplicitAuthFlows?: ExplicitAuthFlowsListType; + /** + * A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon. + */ + SupportedIdentityProviders?: SupportedIdentityProvidersListType; + /** + * A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. + */ + CallbackURLs?: CallbackURLsListType; + /** + * A list of allowed logout URLs for the identity providers. + */ + LogoutURLs?: LogoutURLsListType; + /** + * The default redirect URI. Must be in the CallbackURLs list. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. + */ + DefaultRedirectURI?: RedirectUrlType; + /** + * Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly. + */ + AllowedOAuthFlows?: OAuthFlowsType; + /** + * A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". + */ + AllowedOAuthScopes?: ScopeListType; + /** + * Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. + */ + AllowedOAuthFlowsUserPoolClient?: BooleanType; + /** + * The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. + */ + AnalyticsConfiguration?: AnalyticsConfigurationType; + } + export interface CreateUserPoolClientResponse { + /** + * The user pool client that was just created. + */ + UserPoolClient?: UserPoolClientType; + } + export interface CreateUserPoolDomainRequest { + /** + * The domain string. + */ + Domain: DomainType; + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application. Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead. For more information about the hosted domain and custom domains, see Configuring a User Pool Domain. + */ + CustomDomainConfig?: CustomDomainConfigType; + } + export interface CreateUserPoolDomainResponse { + /** + * The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider. + */ + CloudFrontDomain?: DomainType; + } + export interface CreateUserPoolRequest { + /** + * A string used to name the user pool. + */ + PoolName: UserPoolNameType; + /** + * The policies associated with the new user pool. + */ + Policies?: UserPoolPolicyType; + /** + * The Lambda trigger configuration information for the new user pool. In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function. For more information on using the Lambda API to add permission, see AddPermission . For adding permission using the AWS CLI, see add-permission . + */ + LambdaConfig?: LambdaConfigType; + /** + * The attributes to be auto-verified. Possible values: email, phone_number. + */ + AutoVerifiedAttributes?: VerifiedAttributesListType; + /** + * Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. + */ + AliasAttributes?: AliasAttributesListType; + /** + * Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. + */ + UsernameAttributes?: UsernameAttributesListType; + /** + * A string representing the SMS verification message. + */ + SmsVerificationMessage?: SmsVerificationMessageType; + /** + * A string representing the email verification message. + */ + EmailVerificationMessage?: EmailVerificationMessageType; + /** + * A string representing the email verification subject. + */ + EmailVerificationSubject?: EmailVerificationSubjectType; + /** + * The template for the verification message that the user sees when the app requests permission to access the user's information. + */ + VerificationMessageTemplate?: VerificationMessageTemplateType; + /** + * A string representing the SMS authentication message. + */ + SmsAuthenticationMessage?: SmsVerificationMessageType; + /** + * Specifies MFA configuration details. + */ + MfaConfiguration?: UserPoolMfaType; + /** + * The device configuration. + */ + DeviceConfiguration?: DeviceConfigurationType; + /** + * The email configuration. + */ + EmailConfiguration?: EmailConfigurationType; + /** + * The SMS configuration. + */ + SmsConfiguration?: SmsConfigurationType; + /** + * The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. + */ + UserPoolTags?: UserPoolTagsType; + /** + * The configuration for AdminCreateUser requests. + */ + AdminCreateUserConfig?: AdminCreateUserConfigType; + /** + * An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + */ + Schema?: SchemaAttributesListType; + /** + * Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT". + */ + UserPoolAddOns?: UserPoolAddOnsType; + } + export interface CreateUserPoolResponse { + /** + * A container for the user pool details. + */ + UserPool?: UserPoolType; + } + export type CustomAttributeNameType = string; + export type CustomAttributesListType = SchemaAttributeType[]; + export interface CustomDomainConfigType { + /** + * The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain. + */ + CertificateArn: ArnType; + } + export type DateType = Date; + export type DefaultEmailOptionType = "CONFIRM_WITH_LINK"|"CONFIRM_WITH_CODE"|string; + export interface DeleteGroupRequest { + /** + * The name of the group. + */ + GroupName: GroupNameType; + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + } + export interface DeleteIdentityProviderRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The identity provider name. + */ + ProviderName: ProviderNameType; + } + export interface DeleteResourceServerRequest { + /** + * The user pool ID for the user pool that hosts the resource server. + */ + UserPoolId: UserPoolIdType; + /** + * The identifier for the resource server. + */ + Identifier: ResourceServerIdentifierType; + } + export interface DeleteUserAttributesRequest { + /** + * An array of strings representing the user attribute names you wish to delete. For custom attributes, you must prepend the custom: prefix to the attribute name. + */ + UserAttributeNames: AttributeNameListType; + /** + * The access token used in the request to delete user attributes. + */ + AccessToken: TokenModelType; + } + export interface DeleteUserAttributesResponse { + } + export interface DeleteUserPoolClientRequest { + /** + * The user pool ID for the user pool where you want to delete the client. + */ + UserPoolId: UserPoolIdType; + /** + * The app client ID of the app associated with the user pool. + */ + ClientId: ClientIdType; + } + export interface DeleteUserPoolDomainRequest { + /** + * The domain string. + */ + Domain: DomainType; + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + } + export interface DeleteUserPoolDomainResponse { + } + export interface DeleteUserPoolRequest { + /** + * The user pool ID for the user pool you want to delete. + */ + UserPoolId: UserPoolIdType; + } + export interface DeleteUserRequest { + /** + * The access token from a request to delete a user. + */ + AccessToken: TokenModelType; + } + export type DeliveryMediumListType = DeliveryMediumType[]; + export type DeliveryMediumType = "SMS"|"EMAIL"|string; + export interface DescribeIdentityProviderRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The identity provider name. + */ + ProviderName: ProviderNameType; + } + export interface DescribeIdentityProviderResponse { + /** + * The identity provider that was deleted. + */ + IdentityProvider: IdentityProviderType; + } + export interface DescribeResourceServerRequest { + /** + * The user pool ID for the user pool that hosts the resource server. + */ + UserPoolId: UserPoolIdType; + /** + * The identifier for the resource server + */ + Identifier: ResourceServerIdentifierType; + } + export interface DescribeResourceServerResponse { + /** + * The resource server. + */ + ResourceServer: ResourceServerType; + } + export interface DescribeRiskConfigurationRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The app client ID. + */ + ClientId?: ClientIdType; + } + export interface DescribeRiskConfigurationResponse { + /** + * The risk configuration. + */ + RiskConfiguration: RiskConfigurationType; + } + export interface DescribeUserImportJobRequest { + /** + * The user pool ID for the user pool that the users are being imported into. + */ + UserPoolId: UserPoolIdType; + /** + * The job ID for the user import job. + */ + JobId: UserImportJobIdType; + } + export interface DescribeUserImportJobResponse { + /** + * The job object that represents the user import job. + */ + UserImportJob?: UserImportJobType; + } + export interface DescribeUserPoolClientRequest { + /** + * The user pool ID for the user pool you want to describe. + */ + UserPoolId: UserPoolIdType; + /** + * The app client ID of the app associated with the user pool. + */ + ClientId: ClientIdType; + } + export interface DescribeUserPoolClientResponse { + /** + * The user pool client from a server response to describe the user pool client. + */ + UserPoolClient?: UserPoolClientType; + } + export interface DescribeUserPoolDomainRequest { + /** + * The domain string. + */ + Domain: DomainType; + } + export interface DescribeUserPoolDomainResponse { + /** + * A domain description object containing information about the domain. + */ + DomainDescription?: DomainDescriptionType; + } + export interface DescribeUserPoolRequest { + /** + * The user pool ID for the user pool you want to describe. + */ + UserPoolId: UserPoolIdType; + } + export interface DescribeUserPoolResponse { + /** + * The container of metadata returned by the server to describe the pool. + */ + UserPool?: UserPoolType; + } + export type DescriptionType = string; + export interface DeviceConfigurationType { + /** + * Indicates whether a challenge is required on a new device. Only applicable to a new device. + */ + ChallengeRequiredOnNewDevice?: BooleanType; + /** + * If true, a device is only remembered on user prompt. + */ + DeviceOnlyRememberedOnUserPrompt?: BooleanType; + } + export type DeviceKeyType = string; + export type DeviceListType = DeviceType[]; + export type DeviceNameType = string; + export type DeviceRememberedStatusType = "remembered"|"not_remembered"|string; + export interface DeviceSecretVerifierConfigType { + /** + * The password verifier. + */ + PasswordVerifier?: StringType; + /** + * The salt. + */ + Salt?: StringType; + } + export interface DeviceType { + /** + * The device key. + */ + DeviceKey?: DeviceKeyType; + /** + * The device attributes. + */ + DeviceAttributes?: AttributeListType; + /** + * The creation date of the device. + */ + DeviceCreateDate?: DateType; + /** + * The last modified date of the device. + */ + DeviceLastModifiedDate?: DateType; + /** + * The date in which the device was last authenticated. + */ + DeviceLastAuthenticatedDate?: DateType; + } + export interface DomainDescriptionType { + /** + * The user pool ID. + */ + UserPoolId?: UserPoolIdType; + /** + * The AWS account ID for the user pool owner. + */ + AWSAccountId?: AWSAccountIdType; + /** + * The domain string. + */ + Domain?: DomainType; + /** + * The S3 bucket where the static files for this domain are stored. + */ + S3Bucket?: S3BucketType; + /** + * The ARN of the CloudFront distribution. + */ + CloudFrontDistribution?: StringType; + /** + * The app version. + */ + Version?: DomainVersionType; + /** + * The domain status. + */ + Status?: DomainStatusType; + /** + * The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application. + */ + CustomDomainConfig?: CustomDomainConfigType; + } + export type DomainStatusType = "CREATING"|"DELETING"|"UPDATING"|"ACTIVE"|"FAILED"|string; + export type DomainType = string; + export type DomainVersionType = string; + export type EmailAddressType = string; + export interface EmailConfigurationType { + /** + * The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email address is used in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter: If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account. If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf. + */ + SourceArn?: ArnType; + /** + * The destination to which the receiver of the email should reply to. + */ + ReplyToEmailAddress?: EmailAddressType; + /** + * Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values: COGNITO_DEFAULT When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration. To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide. The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the SourceArn parameter. DEVELOPER When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account. If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter. Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide. + */ + EmailSendingAccount?: EmailSendingAccountType; + } + export type EmailNotificationBodyType = string; + export type EmailNotificationSubjectType = string; + export type EmailSendingAccountType = "COGNITO_DEFAULT"|"DEVELOPER"|string; + export type EmailVerificationMessageByLinkType = string; + export type EmailVerificationMessageType = string; + export type EmailVerificationSubjectByLinkType = string; + export type EmailVerificationSubjectType = string; + export interface EventContextDataType { + /** + * The user's IP address. + */ + IpAddress?: StringType; + /** + * The user's device name. + */ + DeviceName?: StringType; + /** + * The user's time zone. + */ + Timezone?: StringType; + /** + * The user's city. + */ + City?: StringType; + /** + * The user's country. + */ + Country?: StringType; + } + export interface EventFeedbackType { + /** + * The event feedback value. + */ + FeedbackValue: FeedbackValueType; + /** + * The provider. + */ + Provider: StringType; + /** + * The event feedback date. + */ + FeedbackDate?: DateType; + } + export type EventFilterType = "SIGN_IN"|"PASSWORD_CHANGE"|"SIGN_UP"|string; + export type EventFiltersType = EventFilterType[]; + export type EventIdType = string; + export type EventResponseType = "Success"|"Failure"|string; + export interface EventRiskType { + /** + * The risk decision. + */ + RiskDecision?: RiskDecisionType; + /** + * The risk level. + */ + RiskLevel?: RiskLevelType; + } + export type EventType = "SignIn"|"SignUp"|"ForgotPassword"|string; + export type ExplicitAuthFlowsListType = ExplicitAuthFlowsType[]; + export type ExplicitAuthFlowsType = "ADMIN_NO_SRP_AUTH"|"CUSTOM_AUTH_FLOW_ONLY"|"USER_PASSWORD_AUTH"|string; + export type FeedbackValueType = "Valid"|"Invalid"|string; + export type ForceAliasCreation = boolean; + export interface ForgetDeviceRequest { + /** + * The access token for the forgotten device request. + */ + AccessToken?: TokenModelType; + /** + * The device key. + */ + DeviceKey: DeviceKeyType; + } + export interface ForgotPasswordRequest { + /** + * The ID of the client associated with the user pool. + */ + ClientId: ClientIdType; + /** + * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. + */ + SecretHash?: SecretHashType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + UserContextData?: UserContextDataType; + /** + * The user name of the user for whom you want to enter a code to reset a forgotten password. + */ + Username: UsernameType; + /** + * The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + } + export interface ForgotPasswordResponse { + /** + * The code delivery details returned by the server in response to the request to reset a password. + */ + CodeDeliveryDetails?: CodeDeliveryDetailsType; + } + export type GenerateSecret = boolean; + export interface GetCSVHeaderRequest { + /** + * The user pool ID for the user pool that the users are to be imported into. + */ + UserPoolId: UserPoolIdType; + } + export interface GetCSVHeaderResponse { + /** + * The user pool ID for the user pool that the users are to be imported into. + */ + UserPoolId?: UserPoolIdType; + /** + * The header information for the .csv file for the user import job. + */ + CSVHeader?: ListOfStringTypes; + } + export interface GetDeviceRequest { + /** + * The device key. + */ + DeviceKey: DeviceKeyType; + /** + * The access token. + */ + AccessToken?: TokenModelType; + } + export interface GetDeviceResponse { + /** + * The device. + */ + Device: DeviceType; + } + export interface GetGroupRequest { + /** + * The name of the group. + */ + GroupName: GroupNameType; + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + } + export interface GetGroupResponse { + /** + * The group object for the group. + */ + Group?: GroupType; + } + export interface GetIdentityProviderByIdentifierRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The identity provider ID. + */ + IdpIdentifier: IdpIdentifierType; + } + export interface GetIdentityProviderByIdentifierResponse { + /** + * The identity provider object. + */ + IdentityProvider: IdentityProviderType; + } + export interface GetSigningCertificateRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + } + export interface GetSigningCertificateResponse { + /** + * The signing certificate. + */ + Certificate?: StringType; + } + export interface GetUICustomizationRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The client ID for the client app. + */ + ClientId?: ClientIdType; + } + export interface GetUICustomizationResponse { + /** + * The UI customization information. + */ + UICustomization: UICustomizationType; + } + export interface GetUserAttributeVerificationCodeRequest { + /** + * The access token returned by the server response to get the user attribute verification code. + */ + AccessToken: TokenModelType; + /** + * The attribute name returned by the server response to get the user attribute verification code. + */ + AttributeName: AttributeNameType; + } + export interface GetUserAttributeVerificationCodeResponse { + /** + * The code delivery details returned by the server in response to the request to get the user attribute verification code. + */ + CodeDeliveryDetails?: CodeDeliveryDetailsType; + } + export interface GetUserPoolMfaConfigRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + } + export interface GetUserPoolMfaConfigResponse { + /** + * The SMS text message multi-factor (MFA) configuration. + */ + SmsMfaConfiguration?: SmsMfaConfigType; + /** + * The software token multi-factor (MFA) configuration. + */ + SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType; + /** + * The multi-factor (MFA) configuration. + */ + MfaConfiguration?: UserPoolMfaType; + } + export interface GetUserRequest { + /** + * The access token returned by the server response to get information about the user. + */ + AccessToken: TokenModelType; + } + export interface GetUserResponse { + /** + * The user name of the user you wish to retrieve from the get user request. + */ + Username: UsernameType; + /** + * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name. + */ + UserAttributes: AttributeListType; + /** + * Specifies the options for MFA (e.g., email or phone number). + */ + MFAOptions?: MFAOptionListType; + /** + * The user's preferred MFA setting. + */ + PreferredMfaSetting?: StringType; + /** + * The list of the user's MFA settings. + */ + UserMFASettingList?: UserMFASettingListType; + } + export interface GlobalSignOutRequest { + /** + * The access token. + */ + AccessToken: TokenModelType; + } + export interface GlobalSignOutResponse { + } + export type GroupListType = GroupType[]; + export type GroupNameType = string; + export interface GroupType { + /** + * The name of the group. + */ + GroupName?: GroupNameType; + /** + * The user pool ID for the user pool. + */ + UserPoolId?: UserPoolIdType; + /** + * A string containing the description of the group. + */ + Description?: DescriptionType; + /** + * The role ARN for the group. + */ + RoleArn?: ArnType; + /** + * A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values. Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens. The default Precedence value is null. + */ + Precedence?: PrecedenceType; + /** + * The date the group was last modified. + */ + LastModifiedDate?: DateType; + /** + * The date the group was created. + */ + CreationDate?: DateType; + } + export type HexStringType = string; + export interface HttpHeader { + /** + * The header name + */ + headerName?: StringType; + /** + * The header value. + */ + headerValue?: StringType; + } + export type HttpHeaderList = HttpHeader[]; + export interface IdentityProviderType { + /** + * The user pool ID. + */ + UserPoolId?: UserPoolIdType; + /** + * The identity provider name. + */ + ProviderName?: ProviderNameType; + /** + * The identity provider type. + */ + ProviderType?: IdentityProviderTypeType; + /** + * The identity provider details, such as MetadataURL and MetadataFile. + */ + ProviderDetails?: ProviderDetailsType; + /** + * A mapping of identity provider attributes to standard and custom user pool attributes. + */ + AttributeMapping?: AttributeMappingType; + /** + * A list of identity provider identifiers. + */ + IdpIdentifiers?: IdpIdentifiersListType; + /** + * The date the identity provider was last modified. + */ + LastModifiedDate?: DateType; + /** + * The date the identity provider was created. + */ + CreationDate?: DateType; + } + export type IdentityProviderTypeType = "SAML"|"Facebook"|"Google"|"LoginWithAmazon"|"OIDC"|string; + export type IdpIdentifierType = string; + export type IdpIdentifiersListType = IdpIdentifierType[]; + export type ImageFileType = Buffer|Uint8Array|Blob|string; + export type ImageUrlType = string; + export interface InitiateAuthRequest { + /** + * The authentication flow for this call to execute. The API action will depend on this value. For example: REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens. USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution. USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens. Valid values include: USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol. REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. CUSTOM_AUTH: Custom authentication flow. USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool. ADMIN_NO_SRP_AUTH is not a valid value. + */ + AuthFlow: AuthFlowType; + /** + * The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow: For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY + */ + AuthParameters?: AuthParametersType; + /** + * This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication. + */ + ClientMetadata?: ClientMetadataType; + /** + * The app client ID. + */ + ClientId: ClientIdType; + /** + * The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + UserContextData?: UserContextDataType; + } + export interface InitiateAuthResponse { + /** + * The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge. Valid values include the following. Note that all of these challenges require USERNAME and SECRET_HASH (if applicable) in the parameters. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes. + */ + ChallengeName?: ChallengeNameType; + /** + * The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call. + */ + Session?: SessionType; + /** + * The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge). All challenges require USERNAME and SECRET_HASH (if applicable). + */ + ChallengeParameters?: ChallengeParametersType; + /** + * The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned. + */ + AuthenticationResult?: AuthenticationResultType; + } + export type IntegerType = number; + export interface LambdaConfigType { + /** + * A pre-registration AWS Lambda trigger. + */ + PreSignUp?: ArnType; + /** + * A custom Message AWS Lambda trigger. + */ + CustomMessage?: ArnType; + /** + * A post-confirmation AWS Lambda trigger. + */ + PostConfirmation?: ArnType; + /** + * A pre-authentication AWS Lambda trigger. + */ + PreAuthentication?: ArnType; + /** + * A post-authentication AWS Lambda trigger. + */ + PostAuthentication?: ArnType; + /** + * Defines the authentication challenge. + */ + DefineAuthChallenge?: ArnType; + /** + * Creates an authentication challenge. + */ + CreateAuthChallenge?: ArnType; + /** + * Verifies the authentication challenge response. + */ + VerifyAuthChallengeResponse?: ArnType; + /** + * A Lambda trigger that is invoked before token generation. + */ + PreTokenGeneration?: ArnType; + /** + * The user migration Lambda config type. + */ + UserMigration?: ArnType; + } + export interface ListDevicesRequest { + /** + * The access tokens for the request to list devices. + */ + AccessToken: TokenModelType; + /** + * The limit of the device request. + */ + Limit?: QueryLimitType; + /** + * The pagination token for the list request. + */ + PaginationToken?: SearchPaginationTokenType; + } + export interface ListDevicesResponse { + /** + * The devices returned in the list devices response. + */ + Devices?: DeviceListType; + /** + * The pagination token for the list device response. + */ + PaginationToken?: SearchPaginationTokenType; + } + export interface ListGroupsRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The limit of the request to list groups. + */ + Limit?: QueryLimitType; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface ListGroupsResponse { + /** + * The group objects for the groups. + */ + Groups?: GroupListType; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface ListIdentityProvidersRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The maximum number of identity providers to return. + */ + MaxResults?: ListProvidersLimitType; + /** + * A pagination token. + */ + NextToken?: PaginationKeyType; + } + export interface ListIdentityProvidersResponse { + /** + * A list of identity provider objects. + */ + Providers: ProvidersListType; + /** + * A pagination token. + */ + NextToken?: PaginationKeyType; + } + export type ListOfStringTypes = StringType[]; + export type ListProvidersLimitType = number; + export type ListResourceServersLimitType = number; + export interface ListResourceServersRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The maximum number of resource servers to return. + */ + MaxResults?: ListResourceServersLimitType; + /** + * A pagination token. + */ + NextToken?: PaginationKeyType; + } + export interface ListResourceServersResponse { + /** + * The resource servers. + */ + ResourceServers: ResourceServersListType; + /** + * A pagination token. + */ + NextToken?: PaginationKeyType; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the user pool that the tags are assigned to. + */ + ResourceArn: ArnType; + } + export interface ListTagsForResourceResponse { + /** + * The tags that are assigned to the user pool. + */ + Tags?: UserPoolTagsType; + } + export interface ListUserImportJobsRequest { + /** + * The user pool ID for the user pool that the users are being imported into. + */ + UserPoolId: UserPoolIdType; + /** + * The maximum number of import jobs you want the request to return. + */ + MaxResults: PoolQueryLimitType; + /** + * An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list. + */ + PaginationToken?: PaginationKeyType; + } + export interface ListUserImportJobsResponse { + /** + * The user import jobs. + */ + UserImportJobs?: UserImportJobsListType; + /** + * An identifier that can be used to return the next set of user import jobs in the list. + */ + PaginationToken?: PaginationKeyType; + } + export interface ListUserPoolClientsRequest { + /** + * The user pool ID for the user pool where you want to list user pool clients. + */ + UserPoolId: UserPoolIdType; + /** + * The maximum number of results you want the request to return when listing the user pool clients. + */ + MaxResults?: QueryLimit; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface ListUserPoolClientsResponse { + /** + * The user pool clients in the response that lists user pool clients. + */ + UserPoolClients?: UserPoolClientListType; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface ListUserPoolsRequest { + /** + * 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. + */ + NextToken?: PaginationKeyType; + /** + * The maximum number of results you want the request to return when listing the user pools. + */ + MaxResults: PoolQueryLimitType; + } + export interface ListUserPoolsResponse { + /** + * The user pools from the response to list users. + */ + UserPools?: UserPoolListType; + /** + * 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. + */ + NextToken?: PaginationKeyType; + } + export interface ListUsersInGroupRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The name of the group. + */ + GroupName: GroupNameType; + /** + * The limit of the request to list users. + */ + Limit?: QueryLimitType; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface ListUsersInGroupResponse { + /** + * The users returned in the request to list users. + */ + Users?: UsersListType; + /** + * 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. + */ + NextToken?: PaginationKey; + } + export interface ListUsersRequest { + /** + * The user pool ID for the user pool on which the search should be performed. + */ + UserPoolId: UserPoolIdType; + /** + * An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned. + */ + AttributesToGet?: SearchedAttributeNamesListType; + /** + * Maximum number of users to be returned. + */ + Limit?: QueryLimitType; + /** + * 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. + */ + PaginationToken?: SearchPaginationTokenType; + /** + * A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"". AttributeName: The name of the attribute to search for. You can only search for one attribute at a time. Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"". AttributeValue: The attribute value that must be matched for each user. If the filter string is empty, ListUsers returns all users in the user pool. You can only search for the following standard attributes: username (case-sensitive) email phone_number name given_name family_name preferred_username cognito:user_status (called Status in the Console) (case-insensitive) status (called Enabled in the Console) (case-sensitive) sub Custom attributes are not searchable. For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide. + */ + Filter?: UserFilterType; + } + export interface ListUsersResponse { + /** + * The users returned in the request to list users. + */ + Users?: UsersListType; + /** + * 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. + */ + PaginationToken?: SearchPaginationTokenType; + } + export type LogoutURLsListType = RedirectUrlType[]; + export type LongType = number; + export type MFAOptionListType = MFAOptionType[]; + export interface MFAOptionType { + /** + * The delivery medium (email message or SMS message) to send the MFA code. + */ + DeliveryMedium?: DeliveryMediumType; + /** + * The attribute name of the MFA option type. + */ + AttributeName?: AttributeNameType; + } + export type MessageActionType = "RESEND"|"SUPPRESS"|string; + export interface MessageTemplateType { + /** + * The message template for SMS messages. + */ + SMSMessage?: SmsVerificationMessageType; + /** + * The message template for email messages. + */ + EmailMessage?: EmailVerificationMessageType; + /** + * The subject line for email messages. + */ + EmailSubject?: EmailVerificationSubjectType; + } + export interface NewDeviceMetadataType { + /** + * The device key. + */ + DeviceKey?: DeviceKeyType; + /** + * The device group key. + */ + DeviceGroupKey?: StringType; + } + export interface NotifyConfigurationType { + /** + * The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. + */ + From?: StringType; + /** + * The destination to which the receiver of an email should reply to. + */ + ReplyTo?: StringType; + /** + * The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the From parameter. + */ + SourceArn: ArnType; + /** + * Email template used when a detected risk event is blocked. + */ + BlockEmail?: NotifyEmailType; + /** + * The email template used when a detected risk event is allowed. + */ + NoActionEmail?: NotifyEmailType; + /** + * The MFA email template used when MFA is challenged as part of a detected risk. + */ + MfaEmail?: NotifyEmailType; + } + export interface NotifyEmailType { + /** + * The subject. + */ + Subject: EmailNotificationSubjectType; + /** + * The HTML body. + */ + HtmlBody?: EmailNotificationBodyType; + /** + * The text body. + */ + TextBody?: EmailNotificationBodyType; + } + export interface NumberAttributeConstraintsType { + /** + * The minimum value of an attribute that is of the number data type. + */ + MinValue?: StringType; + /** + * The maximum value of an attribute that is of the number data type. + */ + MaxValue?: StringType; + } + export type OAuthFlowType = "code"|"implicit"|"client_credentials"|string; + export type OAuthFlowsType = OAuthFlowType[]; + export type PaginationKey = string; + export type PaginationKeyType = string; + export type PasswordPolicyMinLengthType = number; + export interface PasswordPolicyType { + /** + * The minimum length of the password policy that you have set. Cannot be less than 6. + */ + MinimumLength?: PasswordPolicyMinLengthType; + /** + * In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password. + */ + RequireUppercase?: BooleanType; + /** + * In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password. + */ + RequireLowercase?: BooleanType; + /** + * In the password policy that you have set, refers to whether you have required users to use at least one number in their password. + */ + RequireNumbers?: BooleanType; + /** + * In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password. + */ + RequireSymbols?: BooleanType; + TemporaryPasswordValidityDays?: TemporaryPasswordValidityDaysType; + } + export type PasswordType = string; + export type PoolQueryLimitType = number; + export type PreSignedUrlType = string; + export type PrecedenceType = number; + export interface ProviderDescription { + /** + * The identity provider name. + */ + ProviderName?: ProviderNameType; + /** + * The identity provider type. + */ + ProviderType?: IdentityProviderTypeType; + /** + * The date the provider was last modified. + */ + LastModifiedDate?: DateType; + /** + * The date the provider was added to the user pool. + */ + CreationDate?: DateType; + } + export type ProviderDetailsType = {[key: string]: StringType}; + export type ProviderNameType = string; + export type ProviderNameTypeV1 = string; + export interface ProviderUserIdentifierType { + /** + * The name of the provider, for example, Facebook, Google, or Login with Amazon. + */ + ProviderName?: ProviderNameType; + /** + * The name of the provider attribute to link to, for example, NameID. + */ + ProviderAttributeName?: StringType; + /** + * The value of the provider attribute to link to, for example, xxxxx_account. + */ + ProviderAttributeValue?: StringType; + } + export type ProvidersListType = ProviderDescription[]; + export type QueryLimit = number; + export type QueryLimitType = number; + export type RedirectUrlType = string; + export type RefreshTokenValidityType = number; + export interface ResendConfirmationCodeRequest { + /** + * The ID of the client associated with the user pool. + */ + ClientId: ClientIdType; + /** + * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. + */ + SecretHash?: SecretHashType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + UserContextData?: UserContextDataType; + /** + * The user name of the user to whom you wish to resend a confirmation code. + */ + Username: UsernameType; + /** + * The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + } + export interface ResendConfirmationCodeResponse { + /** + * The code delivery details returned by the server in response to the request to resend the confirmation code. + */ + CodeDeliveryDetails?: CodeDeliveryDetailsType; + } + export type ResourceServerIdentifierType = string; + export type ResourceServerNameType = string; + export type ResourceServerScopeDescriptionType = string; + export type ResourceServerScopeListType = ResourceServerScopeType[]; + export type ResourceServerScopeNameType = string; + export interface ResourceServerScopeType { + /** + * The name of the scope. + */ + ScopeName: ResourceServerScopeNameType; + /** + * A description of the scope. + */ + ScopeDescription: ResourceServerScopeDescriptionType; + } + export interface ResourceServerType { + /** + * The user pool ID for the user pool that hosts the resource server. + */ + UserPoolId?: UserPoolIdType; + /** + * The identifier for the resource server. + */ + Identifier?: ResourceServerIdentifierType; + /** + * The name of the resource server. + */ + Name?: ResourceServerNameType; + /** + * A list of scopes that are defined for the resource server. + */ + Scopes?: ResourceServerScopeListType; + } + export type ResourceServersListType = ResourceServerType[]; + export interface RespondToAuthChallengeRequest { + /** + * The app client ID. + */ + ClientId: ClientIdType; + /** + * The challenge name. For more information, see . ADMIN_NO_SRP_AUTH is not a valid value. + */ + ChallengeName: ChallengeNameType; + /** + * The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call. + */ + Session?: SessionType; + /** + * The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret). NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret). + */ + ChallengeResponses?: ChallengeResponsesType; + /** + * The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + UserContextData?: UserContextDataType; + } + export interface RespondToAuthChallengeResponse { + /** + * The challenge name. For more information, see . + */ + ChallengeName?: ChallengeNameType; + /** + * The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call. + */ + Session?: SessionType; + /** + * The challenge parameters. For more information, see . + */ + ChallengeParameters?: ChallengeParametersType; + /** + * The result returned by the server in response to the request to respond to the authentication challenge. + */ + AuthenticationResult?: AuthenticationResultType; + } + export interface RiskConfigurationType { + /** + * The user pool ID. + */ + UserPoolId?: UserPoolIdType; + /** + * The app client ID. + */ + ClientId?: ClientIdType; + /** + * The compromised credentials risk configuration object including the EventFilter and the EventAction + */ + CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType; + /** + * The account takeover risk configuration object including the NotifyConfiguration object and Actions to take in the case of an account takeover. + */ + AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType; + /** + * The configuration to override the risk decision. + */ + RiskExceptionConfiguration?: RiskExceptionConfigurationType; + /** + * The last modified date. + */ + LastModifiedDate?: DateType; + } + export type RiskDecisionType = "NoRisk"|"AccountTakeover"|"Block"|string; + export interface RiskExceptionConfigurationType { + /** + * Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix. + */ + BlockedIPRangeList?: BlockedIPRangeListType; + /** + * Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation. + */ + SkippedIPRangeList?: SkippedIPRangeListType; + } + export type RiskLevelType = "Low"|"Medium"|"High"|string; + export type S3BucketType = string; + export interface SMSMfaSettingsType { + /** + * Specifies whether SMS text message MFA is enabled. + */ + Enabled?: BooleanType; + /** + * The preferred MFA method. + */ + PreferredMfa?: BooleanType; + } + export interface SchemaAttributeType { + /** + * A schema attribute of the name type. + */ + Name?: CustomAttributeNameType; + /** + * The attribute data type. + */ + AttributeDataType?: AttributeDataType; + /** + * Specifies whether the attribute type is developer only. + */ + DeveloperOnlyAttribute?: BooleanType; + /** + * Specifies whether the value of the attribute can be changed. For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool. + */ + Mutable?: BooleanType; + /** + * Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail. + */ + Required?: BooleanType; + /** + * Specifies the constraints for an attribute of the number type. + */ + NumberAttributeConstraints?: NumberAttributeConstraintsType; + /** + * Specifies the constraints for an attribute of the string type. + */ + StringAttributeConstraints?: StringAttributeConstraintsType; + } + export type SchemaAttributesListType = SchemaAttributeType[]; + export type ScopeListType = ScopeType[]; + export type ScopeType = string; + export type SearchPaginationTokenType = string; + export type SearchedAttributeNamesListType = AttributeNameType[]; + export type SecretCodeType = string; + export type SecretHashType = string; + export type SessionType = string; + export interface SetRiskConfigurationRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. Otherwise, ClientId is mapped to the client. When the client ID is not null, the user pool configuration is overridden and the risk configuration for the client is used instead. + */ + ClientId?: ClientIdType; + /** + * The compromised credentials risk configuration. + */ + CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType; + /** + * The account takeover risk configuration. + */ + AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType; + /** + * The configuration to override the risk decision. + */ + RiskExceptionConfiguration?: RiskExceptionConfigurationType; + } + export interface SetRiskConfigurationResponse { + /** + * The risk configuration. + */ + RiskConfiguration: RiskConfigurationType; + } + export interface SetUICustomizationRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The client ID for the client app. + */ + ClientId?: ClientIdType; + /** + * The CSS values in the UI customization. + */ + CSS?: CSSType; + /** + * The uploaded logo image for the UI customization. + */ + ImageFile?: ImageFileType; + } + export interface SetUICustomizationResponse { + /** + * The UI customization information. + */ + UICustomization: UICustomizationType; + } + export interface SetUserMFAPreferenceRequest { + /** + * The SMS text message multi-factor authentication (MFA) settings. + */ + SMSMfaSettings?: SMSMfaSettingsType; + /** + * The time-based one-time password software token MFA settings. + */ + SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType; + /** + * The access token. + */ + AccessToken: TokenModelType; + } + export interface SetUserMFAPreferenceResponse { + } + export interface SetUserPoolMfaConfigRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The SMS text message MFA configuration. + */ + SmsMfaConfiguration?: SmsMfaConfigType; + /** + * The software token MFA configuration. + */ + SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType; + /** + * The MFA configuration. + */ + MfaConfiguration?: UserPoolMfaType; + } + export interface SetUserPoolMfaConfigResponse { + /** + * The SMS text message MFA configuration. + */ + SmsMfaConfiguration?: SmsMfaConfigType; + /** + * The software token MFA configuration. + */ + SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType; + /** + * The MFA configuration. + */ + MfaConfiguration?: UserPoolMfaType; + } + export interface SetUserSettingsRequest { + /** + * The access token for the set user settings request. + */ + AccessToken: TokenModelType; + /** + * Specifies the options for MFA (e.g., email or phone number). + */ + MFAOptions: MFAOptionListType; + } + export interface SetUserSettingsResponse { + } + export interface SignUpRequest { + /** + * The ID of the client associated with the user pool. + */ + ClientId: ClientIdType; + /** + * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. + */ + SecretHash?: SecretHashType; + /** + * The user name of the user you wish to register. + */ + Username: UsernameType; + /** + * The password of the user you wish to register. + */ + Password: PasswordType; + /** + * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name. + */ + UserAttributes?: AttributeListType; + /** + * The validation data in the request to register a user. + */ + ValidationData?: AttributeListType; + /** + * The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls. + */ + AnalyticsMetadata?: AnalyticsMetadataType; + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + UserContextData?: UserContextDataType; + } + export interface SignUpResponse { + /** + * A response from the server indicating that a user registration has been confirmed. + */ + UserConfirmed: BooleanType; + /** + * The code delivery details returned by the server response to the user registration request. + */ + CodeDeliveryDetails?: CodeDeliveryDetailsType; + /** + * The UUID of the authenticated user. This is not the same as username. + */ + UserSub: StringType; + } + export type SkippedIPRangeListType = StringType[]; + export interface SmsConfigurationType { + /** + * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. + */ + SnsCallerArn: ArnType; + /** + * The external ID. + */ + ExternalId?: StringType; + } + export interface SmsMfaConfigType { + /** + * The SMS authentication message. + */ + SmsAuthenticationMessage?: SmsVerificationMessageType; + /** + * The SMS configuration. + */ + SmsConfiguration?: SmsConfigurationType; + } + export type SmsVerificationMessageType = string; + export type SoftwareTokenMFAUserCodeType = string; + export interface SoftwareTokenMfaConfigType { + /** + * Specifies whether software token MFA is enabled. + */ + Enabled?: BooleanType; + } + export interface SoftwareTokenMfaSettingsType { + /** + * Specifies whether software token MFA is enabled. + */ + Enabled?: BooleanType; + /** + * The preferred MFA method. + */ + PreferredMfa?: BooleanType; + } + export interface StartUserImportJobRequest { + /** + * The user pool ID for the user pool that the users are being imported into. + */ + UserPoolId: UserPoolIdType; + /** + * The job ID for the user import job. + */ + JobId: UserImportJobIdType; + } + export interface StartUserImportJobResponse { + /** + * The job object that represents the user import job. + */ + UserImportJob?: UserImportJobType; + } + export type StatusType = "Enabled"|"Disabled"|string; + export interface StopUserImportJobRequest { + /** + * The user pool ID for the user pool that the users are being imported into. + */ + UserPoolId: UserPoolIdType; + /** + * The job ID for the user import job. + */ + JobId: UserImportJobIdType; + } + export interface StopUserImportJobResponse { + /** + * The job object that represents the user import job. + */ + UserImportJob?: UserImportJobType; + } + export interface StringAttributeConstraintsType { + /** + * The minimum length. + */ + MinLength?: StringType; + /** + * The maximum length. + */ + MaxLength?: StringType; + } + export type StringType = string; + export type SupportedIdentityProvidersListType = ProviderNameType[]; + export type TagKeysType = string; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the user pool to assign the tags to. + */ + ResourceArn: ArnType; + /** + * The tags to assign to the user pool. + */ + Tags?: UserPoolTagsType; + } + export interface TagResourceResponse { + } + export type TagValueType = string; + export type TemporaryPasswordValidityDaysType = number; + export type TokenModelType = string; + export interface UICustomizationType { + /** + * The user pool ID for the user pool. + */ + UserPoolId?: UserPoolIdType; + /** + * The client ID for the client app. + */ + ClientId?: ClientIdType; + /** + * The logo image for the UI customization. + */ + ImageUrl?: ImageUrlType; + /** + * The CSS values in the UI customization. + */ + CSS?: CSSType; + /** + * The CSS version number. + */ + CSSVersion?: CSSVersionType; + /** + * The last-modified date for the UI customization. + */ + LastModifiedDate?: DateType; + /** + * The creation date for the UI customization. + */ + CreationDate?: DateType; + } + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the user pool that the tags are assigned to. + */ + ResourceArn: ArnType; + /** + * The keys of the tags to remove from the user pool. + */ + TagKeys?: UserPoolTagsListType; + } + export interface UntagResourceResponse { + } + export interface UpdateAuthEventFeedbackRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The user pool username. + */ + Username: UsernameType; + /** + * The event ID. + */ + EventId: EventIdType; + /** + * The feedback token. + */ + FeedbackToken: TokenModelType; + /** + * The authentication event feedback value. + */ + FeedbackValue: FeedbackValueType; + } + export interface UpdateAuthEventFeedbackResponse { + } + export interface UpdateDeviceStatusRequest { + /** + * The access token. + */ + AccessToken: TokenModelType; + /** + * The device key. + */ + DeviceKey: DeviceKeyType; + /** + * The status of whether a device is remembered. + */ + DeviceRememberedStatus?: DeviceRememberedStatusType; + } + export interface UpdateDeviceStatusResponse { + } + export interface UpdateGroupRequest { + /** + * The name of the group. + */ + GroupName: GroupNameType; + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * A string containing the new description of the group. + */ + Description?: DescriptionType; + /** + * The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token. + */ + RoleArn?: ArnType; + /** + * The new precedence value for the group. For more information about this parameter, see . + */ + Precedence?: PrecedenceType; + } + export interface UpdateGroupResponse { + /** + * The group object for the group. + */ + Group?: GroupType; + } + export interface UpdateIdentityProviderRequest { + /** + * The user pool ID. + */ + UserPoolId: UserPoolIdType; + /** + * The identity provider name. + */ + ProviderName: ProviderNameType; + /** + * The identity provider details to be updated, such as MetadataURL and MetadataFile. + */ + ProviderDetails?: ProviderDetailsType; + /** + * The identity provider attribute mapping to be changed. + */ + AttributeMapping?: AttributeMappingType; + /** + * A list of identity provider identifiers. + */ + IdpIdentifiers?: IdpIdentifiersListType; + } + export interface UpdateIdentityProviderResponse { + /** + * The identity provider object. + */ + IdentityProvider: IdentityProviderType; + } + export interface UpdateResourceServerRequest { + /** + * The user pool ID for the user pool. + */ + UserPoolId: UserPoolIdType; + /** + * The identifier for the resource server. + */ + Identifier: ResourceServerIdentifierType; + /** + * The name of the resource server. + */ + Name: ResourceServerNameType; + /** + * The scope values to be set for the resource server. + */ + Scopes?: ResourceServerScopeListType; + } + export interface UpdateResourceServerResponse { + /** + * The resource server. + */ + ResourceServer: ResourceServerType; + } + export interface UpdateUserAttributesRequest { + /** + * An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name. + */ + UserAttributes: AttributeListType; + /** + * The access token for the request to update user attributes. + */ + AccessToken: TokenModelType; + } + export interface UpdateUserAttributesResponse { + /** + * The code delivery details list from the server for the request to update user attributes. + */ + CodeDeliveryDetailsList?: CodeDeliveryDetailsListType; + } + export interface UpdateUserPoolClientRequest { + /** + * The user pool ID for the user pool where you want to update the user pool client. + */ + UserPoolId: UserPoolIdType; + /** + * The ID of the client associated with the user pool. + */ + ClientId: ClientIdType; + /** + * The client name from the update user pool client request. + */ + ClientName?: ClientNameType; + /** + * The time limit, in days, after which the refresh token is no longer valid and cannot be used. + */ + RefreshTokenValidity?: RefreshTokenValidityType; + /** + * The read-only attributes of the user pool. + */ + ReadAttributes?: ClientPermissionListType; + /** + * The writeable attributes of the user pool. + */ + WriteAttributes?: ClientPermissionListType; + /** + * Explicit authentication flows. + */ + ExplicitAuthFlows?: ExplicitAuthFlowsListType; + /** + * A list of provider names for the identity providers that are supported on this client. + */ + SupportedIdentityProviders?: SupportedIdentityProvidersListType; + /** + * A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. + */ + CallbackURLs?: CallbackURLsListType; + /** + * A list of allowed logout URLs for the identity providers. + */ + LogoutURLs?: LogoutURLsListType; + /** + * The default redirect URI. Must be in the CallbackURLs list. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. + */ + DefaultRedirectURI?: RedirectUrlType; + /** + * Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. + */ + AllowedOAuthFlows?: OAuthFlowsType; + /** + * A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". + */ + AllowedOAuthScopes?: ScopeListType; + /** + * Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. + */ + AllowedOAuthFlowsUserPoolClient?: BooleanType; + /** + * The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. + */ + AnalyticsConfiguration?: AnalyticsConfigurationType; + } + export interface UpdateUserPoolClientResponse { + /** + * The user pool client value from the response from the server when an update user pool client request is made. + */ + UserPoolClient?: UserPoolClientType; + } + export interface UpdateUserPoolDomainRequest { + /** + * The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example: auth.example.com. This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last character. Use periods to separate subdomain names. + */ + Domain: DomainType; + /** + * The ID of the user pool that is associated with the custom domain that you are updating the certificate for. + */ + UserPoolId: UserPoolIdType; + /** + * The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. + */ + CustomDomainConfig: CustomDomainConfigType; + } + export interface UpdateUserPoolDomainResponse { + /** + * The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool. + */ + CloudFrontDomain?: DomainType; + } + export interface UpdateUserPoolRequest { + /** + * The user pool ID for the user pool you want to update. + */ + UserPoolId: UserPoolIdType; + /** + * A container with the policies you wish to update in a user pool. + */ + Policies?: UserPoolPolicyType; + /** + * The AWS Lambda configuration information from the request to update the user pool. + */ + LambdaConfig?: LambdaConfigType; + /** + * The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools. + */ + AutoVerifiedAttributes?: VerifiedAttributesListType; + /** + * A container with information about the SMS verification message. + */ + SmsVerificationMessage?: SmsVerificationMessageType; + /** + * The contents of the email verification message. + */ + EmailVerificationMessage?: EmailVerificationMessageType; + /** + * The subject of the email verification message. + */ + EmailVerificationSubject?: EmailVerificationSubjectType; + /** + * The template for verification messages. + */ + VerificationMessageTemplate?: VerificationMessageTemplateType; + /** + * The contents of the SMS authentication message. + */ + SmsAuthenticationMessage?: SmsVerificationMessageType; + /** + * Can be one of the following values: OFF - MFA tokens are not required and cannot be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token. + */ + MfaConfiguration?: UserPoolMfaType; + /** + * Device configuration. + */ + DeviceConfiguration?: DeviceConfigurationType; + /** + * Email configuration. + */ + EmailConfiguration?: EmailConfigurationType; + /** + * SMS configuration. + */ + SmsConfiguration?: SmsConfigurationType; + /** + * The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. + */ + UserPoolTags?: UserPoolTagsType; + /** + * The configuration for AdminCreateUser requests. + */ + AdminCreateUserConfig?: AdminCreateUserConfigType; + /** + * Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT". + */ + UserPoolAddOns?: UserPoolAddOnsType; + } + export interface UpdateUserPoolResponse { + } + export interface UserContextDataType { + /** + * Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. + */ + EncodedData?: StringType; + } + export type UserFilterType = string; + export type UserImportJobIdType = string; + export type UserImportJobNameType = string; + export type UserImportJobStatusType = "Created"|"Pending"|"InProgress"|"Stopping"|"Expired"|"Stopped"|"Failed"|"Succeeded"|string; + export interface UserImportJobType { + /** + * The job name for the user import job. + */ + JobName?: UserImportJobNameType; + /** + * The job ID for the user import job. + */ + JobId?: UserImportJobIdType; + /** + * The user pool ID for the user pool that the users are being imported into. + */ + UserPoolId?: UserPoolIdType; + /** + * The pre-signed URL to be used to upload the .csv file. + */ + PreSignedUrl?: PreSignedUrlType; + /** + * The date the user import job was created. + */ + CreationDate?: DateType; + /** + * The date when the user import job was started. + */ + StartDate?: DateType; + /** + * The date when the user import job was completed. + */ + CompletionDate?: DateType; + /** + * The status of the user import job. One of the following: Created - The job was created but not started. Pending - A transition state. You have started the job, but it has not begun importing users yet. InProgress - The job has started, and users are being imported. Stopping - You have stopped the job, but the job has not stopped importing users yet. Stopped - You have stopped the job, and the job has stopped importing users. Succeeded - The job has completed successfully. Failed - The job has stopped due to an error. Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started. + */ + Status?: UserImportJobStatusType; + /** + * The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide. + */ + CloudWatchLogsRoleArn?: ArnType; + /** + * The number of users that were successfully imported. + */ + ImportedUsers?: LongType; + /** + * The number of users that were skipped. + */ + SkippedUsers?: LongType; + /** + * The number of users that could not be imported. + */ + FailedUsers?: LongType; + /** + * The message returned when the user import job is completed. + */ + CompletionMessage?: CompletionMessageType; + } + export type UserImportJobsListType = UserImportJobType[]; + export type UserMFASettingListType = StringType[]; + export interface UserPoolAddOnsType { + /** + * The advanced security mode. + */ + AdvancedSecurityMode: AdvancedSecurityModeType; + } + export interface UserPoolClientDescription { + /** + * The ID of the client associated with the user pool. + */ + ClientId?: ClientIdType; + /** + * The user pool ID for the user pool where you want to describe the user pool client. + */ + UserPoolId?: UserPoolIdType; + /** + * The client name from the user pool client description. + */ + ClientName?: ClientNameType; + } + export type UserPoolClientListType = UserPoolClientDescription[]; + export interface UserPoolClientType { + /** + * The user pool ID for the user pool client. + */ + UserPoolId?: UserPoolIdType; + /** + * The client name from the user pool request of the client type. + */ + ClientName?: ClientNameType; + /** + * The ID of the client associated with the user pool. + */ + ClientId?: ClientIdType; + /** + * The client secret from the user pool request of the client type. + */ + ClientSecret?: ClientSecretType; + /** + * The date the user pool client was last modified. + */ + LastModifiedDate?: DateType; + /** + * The date the user pool client was created. + */ + CreationDate?: DateType; + /** + * The time limit, in days, after which the refresh token is no longer valid and cannot be used. + */ + RefreshTokenValidity?: RefreshTokenValidityType; + /** + * The Read-only attributes. + */ + ReadAttributes?: ClientPermissionListType; + /** + * The writeable attributes. + */ + WriteAttributes?: ClientPermissionListType; + /** + * The explicit authentication flows. + */ + ExplicitAuthFlows?: ExplicitAuthFlowsListType; + /** + * A list of provider names for the identity providers that are supported on this client. + */ + SupportedIdentityProviders?: SupportedIdentityProvidersListType; + /** + * A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. + */ + CallbackURLs?: CallbackURLsListType; + /** + * A list of allowed logout URLs for the identity providers. + */ + LogoutURLs?: LogoutURLsListType; + /** + * The default redirect URI. Must be in the CallbackURLs list. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. + */ + DefaultRedirectURI?: RedirectUrlType; + /** + * Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly. + */ + AllowedOAuthFlows?: OAuthFlowsType; + /** + * A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". + */ + AllowedOAuthScopes?: ScopeListType; + /** + * Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools. + */ + AllowedOAuthFlowsUserPoolClient?: BooleanType; + /** + * The Amazon Pinpoint analytics configuration for the user pool client. + */ + AnalyticsConfiguration?: AnalyticsConfigurationType; + } + export interface UserPoolDescriptionType { + /** + * The ID in a user pool description. + */ + Id?: UserPoolIdType; + /** + * The name in a user pool description. + */ + Name?: UserPoolNameType; + /** + * The AWS Lambda configuration information in a user pool description. + */ + LambdaConfig?: LambdaConfigType; + /** + * The user pool status in a user pool description. + */ + Status?: StatusType; + /** + * The date the user pool description was last modified. + */ + LastModifiedDate?: DateType; + /** + * The date the user pool description was created. + */ + CreationDate?: DateType; + } + export type UserPoolIdType = string; + export type UserPoolListType = UserPoolDescriptionType[]; + export type UserPoolMfaType = "OFF"|"ON"|"OPTIONAL"|string; + export type UserPoolNameType = string; + export interface UserPoolPolicyType { + /** + * The password policy. + */ + PasswordPolicy?: PasswordPolicyType; + } + export type UserPoolTagsListType = TagKeysType[]; + export type UserPoolTagsType = {[key: string]: TagValueType}; + export interface UserPoolType { + /** + * The ID of the user pool. + */ + Id?: UserPoolIdType; + /** + * The name of the user pool. + */ + Name?: UserPoolNameType; + /** + * The policies associated with the user pool. + */ + Policies?: UserPoolPolicyType; + /** + * The AWS Lambda triggers associated with the user pool. + */ + LambdaConfig?: LambdaConfigType; + /** + * The status of a user pool. + */ + Status?: StatusType; + /** + * The date the user pool was last modified. + */ + LastModifiedDate?: DateType; + /** + * The date the user pool was created. + */ + CreationDate?: DateType; + /** + * A container with the schema attributes of a user pool. + */ + SchemaAttributes?: SchemaAttributesListType; + /** + * Specifies the attributes that are auto-verified in a user pool. + */ + AutoVerifiedAttributes?: VerifiedAttributesListType; + /** + * Specifies the attributes that are aliased in a user pool. + */ + AliasAttributes?: AliasAttributesListType; + /** + * Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up. + */ + UsernameAttributes?: UsernameAttributesListType; + /** + * The contents of the SMS verification message. + */ + SmsVerificationMessage?: SmsVerificationMessageType; + /** + * The contents of the email verification message. + */ + EmailVerificationMessage?: EmailVerificationMessageType; + /** + * The subject of the email verification message. + */ + EmailVerificationSubject?: EmailVerificationSubjectType; + /** + * The template for verification messages. + */ + VerificationMessageTemplate?: VerificationMessageTemplateType; + /** + * The contents of the SMS authentication message. + */ + SmsAuthenticationMessage?: SmsVerificationMessageType; + /** + * Can be one of the following values: OFF - MFA tokens are not required and cannot be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token. + */ + MfaConfiguration?: UserPoolMfaType; + /** + * The device configuration. + */ + DeviceConfiguration?: DeviceConfigurationType; + /** + * A number estimating the size of the user pool. + */ + EstimatedNumberOfUsers?: IntegerType; + /** + * The email configuration. + */ + EmailConfiguration?: EmailConfigurationType; + /** + * The SMS configuration. + */ + SmsConfiguration?: SmsConfigurationType; + /** + * The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. + */ + UserPoolTags?: UserPoolTagsType; + /** + * The reason why the SMS configuration cannot send the messages to your users. + */ + SmsConfigurationFailure?: StringType; + /** + * The reason why the email configuration cannot send the messages to your users. + */ + EmailConfigurationFailure?: StringType; + /** + * Holds the domain prefix if the user pool has a domain associated with it. + */ + Domain?: DomainType; + /** + * A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI. + */ + CustomDomain?: DomainType; + /** + * The configuration for AdminCreateUser requests. + */ + AdminCreateUserConfig?: AdminCreateUserConfigType; + /** + * The user pool add-ons. + */ + UserPoolAddOns?: UserPoolAddOnsType; + /** + * The Amazon Resource Name (ARN) for the user pool. + */ + Arn?: ArnType; + } + export type UserStatusType = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|string; + export interface UserType { + /** + * The user name of the user you wish to describe. + */ + Username?: UsernameType; + /** + * A container with information about the user type attributes. + */ + Attributes?: AttributeListType; + /** + * The creation date of the user. + */ + UserCreateDate?: DateType; + /** + * The last modified date of the user. + */ + UserLastModifiedDate?: DateType; + /** + * Specifies whether the user is enabled. + */ + Enabled?: BooleanType; + /** + * The user status. Can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. ARCHIVED - User is no longer active. COMPROMISED - User is disabled due to a potential security threat. UNKNOWN - User status is not known. RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in. FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else. + */ + UserStatus?: UserStatusType; + /** + * The MFA options for the user. + */ + MFAOptions?: MFAOptionListType; + } + export type UsernameAttributeType = "phone_number"|"email"|string; + export type UsernameAttributesListType = UsernameAttributeType[]; + export type UsernameType = string; + export type UsersListType = UserType[]; + export interface VerificationMessageTemplateType { + /** + * The SMS message template. + */ + SmsMessage?: SmsVerificationMessageType; + /** + * The email message template. + */ + EmailMessage?: EmailVerificationMessageType; + /** + * The subject line for the email message template. + */ + EmailSubject?: EmailVerificationSubjectType; + /** + * The email message template for sending a confirmation link to the user. + */ + EmailMessageByLink?: EmailVerificationMessageByLinkType; + /** + * The subject line for the email message template for sending a confirmation link to the user. + */ + EmailSubjectByLink?: EmailVerificationSubjectByLinkType; + /** + * The default email option. + */ + DefaultEmailOption?: DefaultEmailOptionType; + } + export type VerifiedAttributeType = "phone_number"|"email"|string; + export type VerifiedAttributesListType = VerifiedAttributeType[]; + export interface VerifySoftwareTokenRequest { + /** + * The access token. + */ + AccessToken?: TokenModelType; + /** + * The session which should be passed both ways in challenge-response calls to the service. + */ + Session?: SessionType; + /** + * The one time password computed using the secret code returned by + */ + UserCode: SoftwareTokenMFAUserCodeType; + /** + * The friendly device name. + */ + FriendlyDeviceName?: StringType; + } + export interface VerifySoftwareTokenResponse { + /** + * The status of the verify software token. + */ + Status?: VerifySoftwareTokenResponseType; + /** + * The session which should be passed both ways in challenge-response calls to the service. + */ + Session?: SessionType; + } + export type VerifySoftwareTokenResponseType = "SUCCESS"|"ERROR"|string; + export interface VerifyUserAttributeRequest { + /** + * Represents the access token of the request to verify user attributes. + */ + AccessToken: TokenModelType; + /** + * The attribute name in the request to verify user attributes. + */ + AttributeName: AttributeNameType; + /** + * The verification code in the request to verify user attributes. + */ + Code: ConfirmationCodeType; + } + export interface VerifyUserAttributeResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-04-18"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CognitoIdentityServiceProvider client. + */ + export import Types = CognitoIdentityServiceProvider; +} +export = CognitoIdentityServiceProvider; diff --git a/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.js b/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.js new file mode 100644 index 0000000..900fe1f --- /dev/null +++ b/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cognitoidentityserviceprovider'] = {}; +AWS.CognitoIdentityServiceProvider = Service.defineService('cognitoidentityserviceprovider', ['2016-04-18']); +Object.defineProperty(apiLoader.services['cognitoidentityserviceprovider'], '2016-04-18', { + get: function get() { + var model = require('../apis/cognito-idp-2016-04-18.min.json'); + model.paginators = require('../apis/cognito-idp-2016-04-18.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CognitoIdentityServiceProvider; diff --git a/node_modules/aws-sdk/clients/cognitosync.d.ts b/node_modules/aws-sdk/clients/cognitosync.d.ts new file mode 100644 index 0000000..18acb27 --- /dev/null +++ b/node_modules/aws-sdk/clients/cognitosync.d.ts @@ -0,0 +1,747 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CognitoSync extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CognitoSync.Types.ClientConfiguration) + config: Config & CognitoSync.Types.ClientConfiguration; + /** + * Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + bulkPublish(params: CognitoSync.Types.BulkPublishRequest, callback?: (err: AWSError, data: CognitoSync.Types.BulkPublishResponse) => void): Request; + /** + * Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + bulkPublish(callback?: (err: AWSError, data: CognitoSync.Types.BulkPublishResponse) => void): Request; + /** + * Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. + */ + deleteDataset(params: CognitoSync.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.DeleteDatasetResponse) => void): Request; + /** + * Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. + */ + deleteDataset(callback?: (err: AWSError, data: CognitoSync.Types.DeleteDatasetResponse) => void): Request; + /** + * Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. + */ + describeDataset(params: CognitoSync.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.DescribeDatasetResponse) => void): Request; + /** + * Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. + */ + describeDataset(callback?: (err: AWSError, data: CognitoSync.Types.DescribeDatasetResponse) => void): Request; + /** + * Gets usage details (for example, data storage) about a particular identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + describeIdentityPoolUsage(params: CognitoSync.Types.DescribeIdentityPoolUsageRequest, callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityPoolUsageResponse) => void): Request; + /** + * Gets usage details (for example, data storage) about a particular identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + describeIdentityPoolUsage(callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityPoolUsageResponse) => void): Request; + /** + * Gets usage information for an identity, including number of datasets and data usage. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. + */ + describeIdentityUsage(params: CognitoSync.Types.DescribeIdentityUsageRequest, callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityUsageResponse) => void): Request; + /** + * Gets usage information for an identity, including number of datasets and data usage. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. + */ + describeIdentityUsage(callback?: (err: AWSError, data: CognitoSync.Types.DescribeIdentityUsageResponse) => void): Request; + /** + * Get the status of the last BulkPublish operation for an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + getBulkPublishDetails(params: CognitoSync.Types.GetBulkPublishDetailsRequest, callback?: (err: AWSError, data: CognitoSync.Types.GetBulkPublishDetailsResponse) => void): Request; + /** + * Get the status of the last BulkPublish operation for an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + getBulkPublishDetails(callback?: (err: AWSError, data: CognitoSync.Types.GetBulkPublishDetailsResponse) => void): Request; + /** + * Gets the events and the corresponding Lambda functions associated with an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + getCognitoEvents(params: CognitoSync.Types.GetCognitoEventsRequest, callback?: (err: AWSError, data: CognitoSync.Types.GetCognitoEventsResponse) => void): Request; + /** + * Gets the events and the corresponding Lambda functions associated with an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + getCognitoEvents(callback?: (err: AWSError, data: CognitoSync.Types.GetCognitoEventsResponse) => void): Request; + /** + * Gets the configuration settings of an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + getIdentityPoolConfiguration(params: CognitoSync.Types.GetIdentityPoolConfigurationRequest, callback?: (err: AWSError, data: CognitoSync.Types.GetIdentityPoolConfigurationResponse) => void): Request; + /** + * Gets the configuration settings of an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + getIdentityPoolConfiguration(callback?: (err: AWSError, data: CognitoSync.Types.GetIdentityPoolConfigurationResponse) => void): Request; + /** + * Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. + */ + listDatasets(params: CognitoSync.Types.ListDatasetsRequest, callback?: (err: AWSError, data: CognitoSync.Types.ListDatasetsResponse) => void): Request; + /** + * Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. + */ + listDatasets(callback?: (err: AWSError, data: CognitoSync.Types.ListDatasetsResponse) => void): Request; + /** + * Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. + */ + listIdentityPoolUsage(params: CognitoSync.Types.ListIdentityPoolUsageRequest, callback?: (err: AWSError, data: CognitoSync.Types.ListIdentityPoolUsageResponse) => void): Request; + /** + * Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. + */ + listIdentityPoolUsage(callback?: (err: AWSError, data: CognitoSync.Types.ListIdentityPoolUsageResponse) => void): Request; + /** + * Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. + */ + listRecords(params: CognitoSync.Types.ListRecordsRequest, callback?: (err: AWSError, data: CognitoSync.Types.ListRecordsResponse) => void): Request; + /** + * Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. + */ + listRecords(callback?: (err: AWSError, data: CognitoSync.Types.ListRecordsResponse) => void): Request; + /** + * Registers a device to receive push sync notifications. This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. + */ + registerDevice(params: CognitoSync.Types.RegisterDeviceRequest, callback?: (err: AWSError, data: CognitoSync.Types.RegisterDeviceResponse) => void): Request; + /** + * Registers a device to receive push sync notifications. This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. + */ + registerDevice(callback?: (err: AWSError, data: CognitoSync.Types.RegisterDeviceResponse) => void): Request; + /** + * Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + setCognitoEvents(params: CognitoSync.Types.SetCognitoEventsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + setCognitoEvents(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the necessary configuration for push sync. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + setIdentityPoolConfiguration(params: CognitoSync.Types.SetIdentityPoolConfigurationRequest, callback?: (err: AWSError, data: CognitoSync.Types.SetIdentityPoolConfigurationResponse) => void): Request; + /** + * Sets the necessary configuration for push sync. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. + */ + setIdentityPoolConfiguration(callback?: (err: AWSError, data: CognitoSync.Types.SetIdentityPoolConfigurationResponse) => void): Request; + /** + * Subscribes to receive notifications when a dataset is modified by another device. This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. + */ + subscribeToDataset(params: CognitoSync.Types.SubscribeToDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.SubscribeToDatasetResponse) => void): Request; + /** + * Subscribes to receive notifications when a dataset is modified by another device. This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. + */ + subscribeToDataset(callback?: (err: AWSError, data: CognitoSync.Types.SubscribeToDatasetResponse) => void): Request; + /** + * Unsubscribes from receiving notifications when a dataset is modified by another device. This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. + */ + unsubscribeFromDataset(params: CognitoSync.Types.UnsubscribeFromDatasetRequest, callback?: (err: AWSError, data: CognitoSync.Types.UnsubscribeFromDatasetResponse) => void): Request; + /** + * Unsubscribes from receiving notifications when a dataset is modified by another device. This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. + */ + unsubscribeFromDataset(callback?: (err: AWSError, data: CognitoSync.Types.UnsubscribeFromDatasetResponse) => void): Request; + /** + * Posts updates to records and adds and deletes records for a dataset and user. The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. + */ + updateRecords(params: CognitoSync.Types.UpdateRecordsRequest, callback?: (err: AWSError, data: CognitoSync.Types.UpdateRecordsResponse) => void): Request; + /** + * Posts updates to records and adds and deletes records for a dataset and user. The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. + */ + updateRecords(callback?: (err: AWSError, data: CognitoSync.Types.UpdateRecordsResponse) => void): Request; +} +declare namespace CognitoSync { + export type ApplicationArn = string; + export type ApplicationArnList = ApplicationArn[]; + export type AssumeRoleArn = string; + export type Boolean = boolean; + export interface BulkPublishRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + } + export interface BulkPublishResponse { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId?: IdentityPoolId; + } + export type BulkPublishStatus = "NOT_STARTED"|"IN_PROGRESS"|"FAILED"|"SUCCEEDED"|string; + export type ClientContext = string; + export type CognitoEventType = string; + export interface CognitoStreams { + /** + * The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool. + */ + StreamName?: StreamName; + /** + * The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream. + */ + RoleArn?: AssumeRoleArn; + /** + * Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled. DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED. + */ + StreamingStatus?: StreamingStatus; + } + export interface Dataset { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId?: IdentityId; + /** + * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). + */ + DatasetName?: DatasetName; + /** + * Date on which the dataset was created. + */ + CreationDate?: _Date; + /** + * Date when the dataset was last modified. + */ + LastModifiedDate?: _Date; + /** + * The device that made the last change to this dataset. + */ + LastModifiedBy?: String; + /** + * Total size in bytes of the records in this dataset. + */ + DataStorage?: Long; + /** + * Number of records in this dataset. + */ + NumRecords?: Long; + } + export type DatasetList = Dataset[]; + export type DatasetName = string; + export type _Date = Date; + export interface DeleteDatasetRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId: IdentityId; + /** + * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). + */ + DatasetName: DatasetName; + } + export interface DeleteDatasetResponse { + /** + * A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs. + */ + Dataset?: Dataset; + } + export interface DescribeDatasetRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId: IdentityId; + /** + * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). + */ + DatasetName: DatasetName; + } + export interface DescribeDatasetResponse { + /** + * Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs. + */ + Dataset?: Dataset; + } + export interface DescribeIdentityPoolUsageRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + } + export interface DescribeIdentityPoolUsageResponse { + /** + * Information about the usage of the identity pool. + */ + IdentityPoolUsage?: IdentityPoolUsage; + } + export interface DescribeIdentityUsageRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId: IdentityId; + } + export interface DescribeIdentityUsageResponse { + /** + * Usage information for the identity. + */ + IdentityUsage?: IdentityUsage; + } + export type DeviceId = string; + export type Events = {[key: string]: LambdaFunctionArn}; + export interface GetBulkPublishDetailsRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + } + export interface GetBulkPublishDetailsResponse { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId?: IdentityPoolId; + /** + * The date/time at which the last bulk publish was initiated. + */ + BulkPublishStartTime?: _Date; + /** + * If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed. + */ + BulkPublishCompleteTime?: _Date; + /** + * Status of the last bulk publish operation, valid values are: NOT_STARTED - No bulk publish has been requested for this identity pool IN_PROGRESS - Data is being published to the configured stream SUCCEEDED - All data for the identity pool has been published to the configured stream FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause. + */ + BulkPublishStatus?: BulkPublishStatus; + /** + * If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail. + */ + FailureMessage?: String; + } + export interface GetCognitoEventsRequest { + /** + * The Cognito Identity Pool ID for the request + */ + IdentityPoolId: IdentityPoolId; + } + export interface GetCognitoEventsResponse { + /** + * The Cognito Events returned from the GetCognitoEvents request + */ + Events?: Events; + } + export interface GetIdentityPoolConfigurationRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration. + */ + IdentityPoolId: IdentityPoolId; + } + export interface GetIdentityPoolConfigurationResponse { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. + */ + IdentityPoolId?: IdentityPoolId; + /** + * Options to apply to this identity pool for push synchronization. + */ + PushSync?: PushSync; + /** + * Options to apply to this identity pool for Amazon Cognito streams. + */ + CognitoStreams?: CognitoStreams; + } + export type IdentityId = string; + export type IdentityPoolId = string; + export interface IdentityPoolUsage { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId?: IdentityPoolId; + /** + * Number of sync sessions for the identity pool. + */ + SyncSessionsCount?: Long; + /** + * Data storage information for the identity pool. + */ + DataStorage?: Long; + /** + * Date on which the identity pool was last modified. + */ + LastModifiedDate?: _Date; + } + export type IdentityPoolUsageList = IdentityPoolUsage[]; + export interface IdentityUsage { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId?: IdentityId; + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId?: IdentityPoolId; + /** + * Date on which the identity was last modified. + */ + LastModifiedDate?: _Date; + /** + * Number of datasets for the identity. + */ + DatasetCount?: Integer; + /** + * Total data storage for this identity. + */ + DataStorage?: Long; + } + export type Integer = number; + export type IntegerString = number; + export type LambdaFunctionArn = string; + export interface ListDatasetsRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId: IdentityId; + /** + * A pagination token for obtaining the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to be returned. + */ + MaxResults?: IntegerString; + } + export interface ListDatasetsResponse { + /** + * A set of datasets. + */ + Datasets?: DatasetList; + /** + * Number of datasets returned. + */ + Count?: Integer; + /** + * A pagination token for obtaining the next page of results. + */ + NextToken?: String; + } + export interface ListIdentityPoolUsageRequest { + /** + * A pagination token for obtaining the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to be returned. + */ + MaxResults?: IntegerString; + } + export interface ListIdentityPoolUsageResponse { + /** + * Usage information for the identity pools. + */ + IdentityPoolUsages?: IdentityPoolUsageList; + /** + * The maximum number of results to be returned. + */ + MaxResults?: Integer; + /** + * Total number of identities for the identity pool. + */ + Count?: Integer; + /** + * A pagination token for obtaining the next page of results. + */ + NextToken?: String; + } + export interface ListRecordsRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId: IdentityId; + /** + * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). + */ + DatasetName: DatasetName; + /** + * The last server sync count for this record. + */ + LastSyncCount?: Long; + /** + * A pagination token for obtaining the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to be returned. + */ + MaxResults?: IntegerString; + /** + * A token containing a session ID, identity ID, and expiration. + */ + SyncSessionToken?: SyncSessionToken; + } + export interface ListRecordsResponse { + /** + * A list of all records. + */ + Records?: RecordList; + /** + * A pagination token for obtaining the next page of results. + */ + NextToken?: String; + /** + * Total number of records. + */ + Count?: Integer; + /** + * Server sync count for this dataset. + */ + DatasetSyncCount?: Long; + /** + * The user/device that made the last change to this record. + */ + LastModifiedBy?: String; + /** + * Names of merged datasets. + */ + MergedDatasetNames?: MergedDatasetNameList; + /** + * Indicates whether the dataset exists. + */ + DatasetExists?: Boolean; + /** + * A boolean value specifying whether to delete the dataset locally. + */ + DatasetDeletedAfterRequestedSyncCount?: Boolean; + /** + * A token containing a session ID, identity ID, and expiration. + */ + SyncSessionToken?: String; + } + export type Long = number; + export type MergedDatasetNameList = String[]; + export type Operation = "replace"|"remove"|string; + export type Platform = "APNS"|"APNS_SANDBOX"|"GCM"|"ADM"|string; + export interface PushSync { + /** + * List of SNS platform application ARNs that could be used by clients. + */ + ApplicationArns?: ApplicationArnList; + /** + * A role configured to allow Cognito to call SNS on behalf of the developer. + */ + RoleArn?: AssumeRoleArn; + } + export type PushToken = string; + export interface Record { + /** + * The key for the record. + */ + Key?: RecordKey; + /** + * The value for the record. + */ + Value?: RecordValue; + /** + * The server sync count for this record. + */ + SyncCount?: Long; + /** + * The date on which the record was last modified. + */ + LastModifiedDate?: _Date; + /** + * The user/device that made the last change to this record. + */ + LastModifiedBy?: String; + /** + * The last modified date of the client device. + */ + DeviceLastModifiedDate?: _Date; + } + export type RecordKey = string; + export type RecordList = Record[]; + export interface RecordPatch { + /** + * An operation, either replace or remove. + */ + Op: Operation; + /** + * The key associated with the record patch. + */ + Key: RecordKey; + /** + * The value associated with the record patch. + */ + Value?: RecordValue; + /** + * Last known server sync count for this record. Set to 0 if unknown. + */ + SyncCount: Long; + /** + * The last modified date of the client device. + */ + DeviceLastModifiedDate?: _Date; + } + export type RecordPatchList = RecordPatch[]; + export type RecordValue = string; + export interface RegisterDeviceRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to. + */ + IdentityPoolId: IdentityPoolId; + /** + * The unique ID for this identity. + */ + IdentityId: IdentityId; + /** + * The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX). + */ + Platform: Platform; + /** + * The push token. + */ + Token: PushToken; + } + export interface RegisterDeviceResponse { + /** + * The unique ID generated for this device by Cognito. + */ + DeviceId?: DeviceId; + } + export interface SetCognitoEventsRequest { + /** + * The Cognito Identity Pool to use when configuring Cognito Events + */ + IdentityPoolId: IdentityPoolId; + /** + * The events to configure + */ + Events: Events; + } + export interface SetIdentityPoolConfigurationRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify. + */ + IdentityPoolId: IdentityPoolId; + /** + * Options to apply to this identity pool for push synchronization. + */ + PushSync?: PushSync; + /** + * Options to apply to this identity pool for Amazon Cognito streams. + */ + CognitoStreams?: CognitoStreams; + } + export interface SetIdentityPoolConfigurationResponse { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. + */ + IdentityPoolId?: IdentityPoolId; + /** + * Options to apply to this identity pool for push synchronization. + */ + PushSync?: PushSync; + /** + * Options to apply to this identity pool for Amazon Cognito streams. + */ + CognitoStreams?: CognitoStreams; + } + export type StreamName = string; + export type StreamingStatus = "ENABLED"|"DISABLED"|string; + export type String = string; + export interface SubscribeToDatasetRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs. + */ + IdentityPoolId: IdentityPoolId; + /** + * Unique ID for this identity. + */ + IdentityId: IdentityId; + /** + * The name of the dataset to subcribe to. + */ + DatasetName: DatasetName; + /** + * The unique ID generated for this device by Cognito. + */ + DeviceId: DeviceId; + } + export interface SubscribeToDatasetResponse { + } + export type SyncSessionToken = string; + export interface UnsubscribeFromDatasetRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs. + */ + IdentityPoolId: IdentityPoolId; + /** + * Unique ID for this identity. + */ + IdentityId: IdentityId; + /** + * The name of the dataset from which to unsubcribe. + */ + DatasetName: DatasetName; + /** + * The unique ID generated for this device by Cognito. + */ + DeviceId: DeviceId; + } + export interface UnsubscribeFromDatasetResponse { + } + export interface UpdateRecordsRequest { + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityPoolId: IdentityPoolId; + /** + * A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. + */ + IdentityId: IdentityId; + /** + * A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). + */ + DatasetName: DatasetName; + /** + * The unique ID generated for this device by Cognito. + */ + DeviceId?: DeviceId; + /** + * A list of patch operations. + */ + RecordPatches?: RecordPatchList; + /** + * The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity. + */ + SyncSessionToken: SyncSessionToken; + /** + * Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented. + */ + ClientContext?: ClientContext; + } + export interface UpdateRecordsResponse { + /** + * A list of records that have been updated. + */ + Records?: RecordList; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-06-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CognitoSync client. + */ + export import Types = CognitoSync; +} +export = CognitoSync; diff --git a/node_modules/aws-sdk/clients/cognitosync.js b/node_modules/aws-sdk/clients/cognitosync.js new file mode 100644 index 0000000..d1e4e6f --- /dev/null +++ b/node_modules/aws-sdk/clients/cognitosync.js @@ -0,0 +1,17 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cognitosync'] = {}; +AWS.CognitoSync = Service.defineService('cognitosync', ['2014-06-30']); +Object.defineProperty(apiLoader.services['cognitosync'], '2014-06-30', { + get: function get() { + var model = require('../apis/cognito-sync-2014-06-30.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CognitoSync; diff --git a/node_modules/aws-sdk/clients/comprehend.d.ts b/node_modules/aws-sdk/clients/comprehend.d.ts new file mode 100644 index 0000000..bbdc050 --- /dev/null +++ b/node_modules/aws-sdk/clients/comprehend.d.ts @@ -0,0 +1,2206 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Comprehend extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Comprehend.Types.ClientConfiguration) + config: Config & Comprehend.Types.ClientConfiguration; + /** + * Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. + */ + batchDetectDominantLanguage(params: Comprehend.Types.BatchDetectDominantLanguageRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectDominantLanguageResponse) => void): Request; + /** + * Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. + */ + batchDetectDominantLanguage(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectDominantLanguageResponse) => void): Request; + /** + * Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities + */ + batchDetectEntities(params: Comprehend.Types.BatchDetectEntitiesRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectEntitiesResponse) => void): Request; + /** + * Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities + */ + batchDetectEntities(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectEntitiesResponse) => void): Request; + /** + * Detects the key noun phrases found in a batch of documents. + */ + batchDetectKeyPhrases(params: Comprehend.Types.BatchDetectKeyPhrasesRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectKeyPhrasesResponse) => void): Request; + /** + * Detects the key noun phrases found in a batch of documents. + */ + batchDetectKeyPhrases(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectKeyPhrasesResponse) => void): Request; + /** + * Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one. + */ + batchDetectSentiment(params: Comprehend.Types.BatchDetectSentimentRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSentimentResponse) => void): Request; + /** + * Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one. + */ + batchDetectSentiment(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSentimentResponse) => void): Request; + /** + * Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax. + */ + batchDetectSyntax(params: Comprehend.Types.BatchDetectSyntaxRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSyntaxResponse) => void): Request; + /** + * Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax. + */ + batchDetectSyntax(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSyntaxResponse) => void): Request; + /** + * Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification. + */ + createDocumentClassifier(params: Comprehend.Types.CreateDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateDocumentClassifierResponse) => void): Request; + /** + * Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification. + */ + createDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.CreateDocumentClassifierResponse) => void): Request; + /** + * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API. + */ + createEntityRecognizer(params: Comprehend.Types.CreateEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateEntityRecognizerResponse) => void): Request; + /** + * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API. + */ + createEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.CreateEntityRecognizerResponse) => void): Request; + /** + * Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use. + */ + deleteDocumentClassifier(params: Comprehend.Types.DeleteDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.DeleteDocumentClassifierResponse) => void): Request; + /** + * Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use. + */ + deleteDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.DeleteDocumentClassifierResponse) => void): Request; + /** + * Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use. + */ + deleteEntityRecognizer(params: Comprehend.Types.DeleteEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.DeleteEntityRecognizerResponse) => void): Request; + /** + * Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use. + */ + deleteEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.DeleteEntityRecognizerResponse) => void): Request; + /** + * Gets the properties associated with a document classification job. Use this operation to get the status of a classification job. + */ + describeDocumentClassificationJob(params: Comprehend.Types.DescribeDocumentClassificationJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassificationJobResponse) => void): Request; + /** + * Gets the properties associated with a document classification job. Use this operation to get the status of a classification job. + */ + describeDocumentClassificationJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassificationJobResponse) => void): Request; + /** + * Gets the properties associated with a document classifier. + */ + describeDocumentClassifier(params: Comprehend.Types.DescribeDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassifierResponse) => void): Request; + /** + * Gets the properties associated with a document classifier. + */ + describeDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassifierResponse) => void): Request; + /** + * Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job. + */ + describeDominantLanguageDetectionJob(params: Comprehend.Types.DescribeDominantLanguageDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeDominantLanguageDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job. + */ + describeDominantLanguageDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeDominantLanguageDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job. + */ + describeEntitiesDetectionJob(params: Comprehend.Types.DescribeEntitiesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeEntitiesDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job. + */ + describeEntitiesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeEntitiesDetectionJobResponse) => void): Request; + /** + * Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on. + */ + describeEntityRecognizer(params: Comprehend.Types.DescribeEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeEntityRecognizerResponse) => void): Request; + /** + * Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on. + */ + describeEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.DescribeEntityRecognizerResponse) => void): Request; + /** + * Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job. + */ + describeKeyPhrasesDetectionJob(params: Comprehend.Types.DescribeKeyPhrasesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeKeyPhrasesDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job. + */ + describeKeyPhrasesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeKeyPhrasesDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job. + */ + describeSentimentDetectionJob(params: Comprehend.Types.DescribeSentimentDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeSentimentDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job. + */ + describeSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeSentimentDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job. + */ + describeTopicsDetectionJob(params: Comprehend.Types.DescribeTopicsDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeTopicsDetectionJobResponse) => void): Request; + /** + * Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job. + */ + describeTopicsDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeTopicsDetectionJobResponse) => void): Request; + /** + * Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. + */ + detectDominantLanguage(params: Comprehend.Types.DetectDominantLanguageRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectDominantLanguageResponse) => void): Request; + /** + * Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. + */ + detectDominantLanguage(callback?: (err: AWSError, data: Comprehend.Types.DetectDominantLanguageResponse) => void): Request; + /** + * Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities. + */ + detectEntities(params: Comprehend.Types.DetectEntitiesRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectEntitiesResponse) => void): Request; + /** + * Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities. + */ + detectEntities(callback?: (err: AWSError, data: Comprehend.Types.DetectEntitiesResponse) => void): Request; + /** + * Detects the key noun phrases found in the text. + */ + detectKeyPhrases(params: Comprehend.Types.DetectKeyPhrasesRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectKeyPhrasesResponse) => void): Request; + /** + * Detects the key noun phrases found in the text. + */ + detectKeyPhrases(callback?: (err: AWSError, data: Comprehend.Types.DetectKeyPhrasesResponse) => void): Request; + /** + * Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE). + */ + detectSentiment(params: Comprehend.Types.DetectSentimentRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectSentimentResponse) => void): Request; + /** + * Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE). + */ + detectSentiment(callback?: (err: AWSError, data: Comprehend.Types.DetectSentimentResponse) => void): Request; + /** + * Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax. + */ + detectSyntax(params: Comprehend.Types.DetectSyntaxRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectSyntaxResponse) => void): Request; + /** + * Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax. + */ + detectSyntax(callback?: (err: AWSError, data: Comprehend.Types.DetectSyntaxResponse) => void): Request; + /** + * Gets a list of the documentation classification jobs that you have submitted. + */ + listDocumentClassificationJobs(params: Comprehend.Types.ListDocumentClassificationJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassificationJobsResponse) => void): Request; + /** + * Gets a list of the documentation classification jobs that you have submitted. + */ + listDocumentClassificationJobs(callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassificationJobsResponse) => void): Request; + /** + * Gets a list of the document classifiers that you have created. + */ + listDocumentClassifiers(params: Comprehend.Types.ListDocumentClassifiersRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassifiersResponse) => void): Request; + /** + * Gets a list of the document classifiers that you have created. + */ + listDocumentClassifiers(callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassifiersResponse) => void): Request; + /** + * Gets a list of the dominant language detection jobs that you have submitted. + */ + listDominantLanguageDetectionJobs(params: Comprehend.Types.ListDominantLanguageDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDominantLanguageDetectionJobsResponse) => void): Request; + /** + * Gets a list of the dominant language detection jobs that you have submitted. + */ + listDominantLanguageDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListDominantLanguageDetectionJobsResponse) => void): Request; + /** + * Gets a list of the entity detection jobs that you have submitted. + */ + listEntitiesDetectionJobs(params: Comprehend.Types.ListEntitiesDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListEntitiesDetectionJobsResponse) => void): Request; + /** + * Gets a list of the entity detection jobs that you have submitted. + */ + listEntitiesDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListEntitiesDetectionJobsResponse) => void): Request; + /** + * Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed. + */ + listEntityRecognizers(params: Comprehend.Types.ListEntityRecognizersRequest, callback?: (err: AWSError, data: Comprehend.Types.ListEntityRecognizersResponse) => void): Request; + /** + * Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed. + */ + listEntityRecognizers(callback?: (err: AWSError, data: Comprehend.Types.ListEntityRecognizersResponse) => void): Request; + /** + * Get a list of key phrase detection jobs that you have submitted. + */ + listKeyPhrasesDetectionJobs(params: Comprehend.Types.ListKeyPhrasesDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListKeyPhrasesDetectionJobsResponse) => void): Request; + /** + * Get a list of key phrase detection jobs that you have submitted. + */ + listKeyPhrasesDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListKeyPhrasesDetectionJobsResponse) => void): Request; + /** + * Gets a list of sentiment detection jobs that you have submitted. + */ + listSentimentDetectionJobs(params: Comprehend.Types.ListSentimentDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListSentimentDetectionJobsResponse) => void): Request; + /** + * Gets a list of sentiment detection jobs that you have submitted. + */ + listSentimentDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListSentimentDetectionJobsResponse) => void): Request; + /** + * Lists all tags associated with a given Amazon Comprehend resource. + */ + listTagsForResource(params: Comprehend.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Comprehend.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists all tags associated with a given Amazon Comprehend resource. + */ + listTagsForResource(callback?: (err: AWSError, data: Comprehend.Types.ListTagsForResourceResponse) => void): Request; + /** + * Gets a list of the topic detection jobs that you have submitted. + */ + listTopicsDetectionJobs(params: Comprehend.Types.ListTopicsDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListTopicsDetectionJobsResponse) => void): Request; + /** + * Gets a list of the topic detection jobs that you have submitted. + */ + listTopicsDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListTopicsDetectionJobsResponse) => void): Request; + /** + * Starts an asynchronous document classification job. Use the operation to track the progress of the job. + */ + startDocumentClassificationJob(params: Comprehend.Types.StartDocumentClassificationJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartDocumentClassificationJobResponse) => void): Request; + /** + * Starts an asynchronous document classification job. Use the operation to track the progress of the job. + */ + startDocumentClassificationJob(callback?: (err: AWSError, data: Comprehend.Types.StartDocumentClassificationJobResponse) => void): Request; + /** + * Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job. + */ + startDominantLanguageDetectionJob(params: Comprehend.Types.StartDominantLanguageDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartDominantLanguageDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job. + */ + startDominantLanguageDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartDominantLanguageDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity. + */ + startEntitiesDetectionJob(params: Comprehend.Types.StartEntitiesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartEntitiesDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity. + */ + startEntitiesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartEntitiesDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job. + */ + startKeyPhrasesDetectionJob(params: Comprehend.Types.StartKeyPhrasesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartKeyPhrasesDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job. + */ + startKeyPhrasesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartKeyPhrasesDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job. + */ + startSentimentDetectionJob(params: Comprehend.Types.StartSentimentDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartSentimentDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job. + */ + startSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartSentimentDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job. + */ + startTopicsDetectionJob(params: Comprehend.Types.StartTopicsDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartTopicsDetectionJobResponse) => void): Request; + /** + * Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job. + */ + startTopicsDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartTopicsDetectionJobResponse) => void): Request; + /** + * Stops a dominant language detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopDominantLanguageDetectionJob(params: Comprehend.Types.StopDominantLanguageDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopDominantLanguageDetectionJobResponse) => void): Request; + /** + * Stops a dominant language detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopDominantLanguageDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopDominantLanguageDetectionJobResponse) => void): Request; + /** + * Stops an entities detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopEntitiesDetectionJob(params: Comprehend.Types.StopEntitiesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopEntitiesDetectionJobResponse) => void): Request; + /** + * Stops an entities detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopEntitiesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopEntitiesDetectionJobResponse) => void): Request; + /** + * Stops a key phrases detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopKeyPhrasesDetectionJob(params: Comprehend.Types.StopKeyPhrasesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopKeyPhrasesDetectionJobResponse) => void): Request; + /** + * Stops a key phrases detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopKeyPhrasesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopKeyPhrasesDetectionJobResponse) => void): Request; + /** + * Stops a sentiment detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopSentimentDetectionJob(params: Comprehend.Types.StopSentimentDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopSentimentDetectionJobResponse) => void): Request; + /** + * Stops a sentiment detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. + */ + stopSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopSentimentDetectionJobResponse) => void): Request; + /** + * Stops a document classifier training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body. + */ + stopTrainingDocumentClassifier(params: Comprehend.Types.StopTrainingDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.StopTrainingDocumentClassifierResponse) => void): Request; + /** + * Stops a document classifier training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body. + */ + stopTrainingDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.StopTrainingDocumentClassifierResponse) => void): Request; + /** + * Stops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body. + */ + stopTrainingEntityRecognizer(params: Comprehend.Types.StopTrainingEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.StopTrainingEntityRecognizerResponse) => void): Request; + /** + * Stops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body. + */ + stopTrainingEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.StopTrainingEntityRecognizerResponse) => void): Request; + /** + * Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. + */ + tagResource(params: Comprehend.Types.TagResourceRequest, callback?: (err: AWSError, data: Comprehend.Types.TagResourceResponse) => void): Request; + /** + * Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. + */ + tagResource(callback?: (err: AWSError, data: Comprehend.Types.TagResourceResponse) => void): Request; + /** + * Removes a specific tag associated with an Amazon Comprehend resource. + */ + untagResource(params: Comprehend.Types.UntagResourceRequest, callback?: (err: AWSError, data: Comprehend.Types.UntagResourceResponse) => void): Request; + /** + * Removes a specific tag associated with an Amazon Comprehend resource. + */ + untagResource(callback?: (err: AWSError, data: Comprehend.Types.UntagResourceResponse) => void): Request; +} +declare namespace Comprehend { + export type AnyLengthString = string; + export interface BatchDetectDominantLanguageItemResult { + /** + * The zero-based index of the document in the input list. + */ + Index?: Integer; + /** + * One or more DominantLanguage objects describing the dominant languages in the document. + */ + Languages?: ListOfDominantLanguages; + } + export interface BatchDetectDominantLanguageRequest { + /** + * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters. + */ + TextList: StringList; + } + export interface BatchDetectDominantLanguageResponse { + /** + * A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty. + */ + ResultList: ListOfDetectDominantLanguageResult; + /** + * A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty. + */ + ErrorList: BatchItemErrorList; + } + export interface BatchDetectEntitiesItemResult { + /** + * The zero-based index of the document in the input list. + */ + Index?: Integer; + /** + * One or more Entity objects, one for each entity detected in the document. + */ + Entities?: ListOfEntities; + } + export interface BatchDetectEntitiesRequest { + /** + * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters. + */ + TextList: StringList; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + } + export interface BatchDetectEntitiesResponse { + /** + * A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty. + */ + ResultList: ListOfDetectEntitiesResult; + /** + * A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty. + */ + ErrorList: BatchItemErrorList; + } + export interface BatchDetectKeyPhrasesItemResult { + /** + * The zero-based index of the document in the input list. + */ + Index?: Integer; + /** + * One or more KeyPhrase objects, one for each key phrase detected in the document. + */ + KeyPhrases?: ListOfKeyPhrases; + } + export interface BatchDetectKeyPhrasesRequest { + /** + * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters. + */ + TextList: StringList; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + } + export interface BatchDetectKeyPhrasesResponse { + /** + * A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty. + */ + ResultList: ListOfDetectKeyPhrasesResult; + /** + * A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty. + */ + ErrorList: BatchItemErrorList; + } + export interface BatchDetectSentimentItemResult { + /** + * The zero-based index of the document in the input list. + */ + Index?: Integer; + /** + * The sentiment detected in the document. + */ + Sentiment?: SentimentType; + /** + * The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection. + */ + SentimentScore?: SentimentScore; + } + export interface BatchDetectSentimentRequest { + /** + * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters. + */ + TextList: StringList; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + } + export interface BatchDetectSentimentResponse { + /** + * A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty. + */ + ResultList: ListOfDetectSentimentResult; + /** + * A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty. + */ + ErrorList: BatchItemErrorList; + } + export interface BatchDetectSyntaxItemResult { + /** + * The zero-based index of the document in the input list. + */ + Index?: Integer; + /** + * The syntax tokens for the words in the document, one token for each word. + */ + SyntaxTokens?: ListOfSyntaxTokens; + } + export interface BatchDetectSyntaxRequest { + /** + * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters. + */ + TextList: StringList; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: SyntaxLanguageCode; + } + export interface BatchDetectSyntaxResponse { + /** + * A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty. + */ + ResultList: ListOfDetectSyntaxResult; + /** + * A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty. + */ + ErrorList: BatchItemErrorList; + } + export interface BatchItemError { + /** + * The zero-based index of the document in the input list. + */ + Index?: Integer; + /** + * The numeric error code of the error. + */ + ErrorCode?: String; + /** + * A text description of the error. + */ + ErrorMessage?: String; + } + export type BatchItemErrorList = BatchItemError[]; + export interface ClassifierEvaluationMetrics { + /** + * The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents. + */ + Accuracy?: Double; + /** + * A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones. + */ + Precision?: Double; + /** + * A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. + */ + Recall?: Double; + /** + * A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. + */ + F1Score?: Double; + } + export interface ClassifierMetadata { + /** + * The number of labels in the input data. + */ + NumberOfLabels?: Integer; + /** + * The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents. + */ + NumberOfTrainedDocuments?: Integer; + /** + * The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents. + */ + NumberOfTestDocuments?: Integer; + /** + * Describes the result metrics for the test data associated with an documentation classifier. + */ + EvaluationMetrics?: ClassifierEvaluationMetrics; + } + export type ClientRequestTokenString = string; + export type ComprehendArn = string; + export type ComprehendArnName = string; + export interface CreateDocumentClassifierRequest { + /** + * The name of the document classifier. + */ + DocumentClassifierName: ComprehendArnName; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn: IamRoleArn; + /** + * Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. + */ + Tags?: TagList; + /** + * Specifies the format and location of the input data for the job. + */ + InputDataConfig: DocumentClassifierInputDataConfig; + /** + * Enables the addition of output results configuration parameters for custom classifier jobs. + */ + OutputDataConfig?: DocumentClassifierOutputDataConfig; + /** + * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface CreateDocumentClassifierResponse { + /** + * The Amazon Resource Name (ARN) that identifies the document classifier. + */ + DocumentClassifierArn?: DocumentClassifierArn; + } + export interface CreateEntityRecognizerRequest { + /** + * The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region. + */ + RecognizerName: ComprehendArnName; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn: IamRoleArn; + /** + * Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. + */ + Tags?: TagList; + /** + * Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created. + */ + InputDataConfig: EntityRecognizerInputDataConfig; + /** + * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported. + */ + LanguageCode: LanguageCode; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface CreateEntityRecognizerResponse { + /** + * The Amazon Resource Name (ARN) that identifies the entity recognizer. + */ + EntityRecognizerArn?: EntityRecognizerArn; + } + export interface DeleteDocumentClassifierRequest { + /** + * The Amazon Resource Name (ARN) that identifies the document classifier. + */ + DocumentClassifierArn: DocumentClassifierArn; + } + export interface DeleteDocumentClassifierResponse { + } + export interface DeleteEntityRecognizerRequest { + /** + * The Amazon Resource Name (ARN) that identifies the entity recognizer. + */ + EntityRecognizerArn: EntityRecognizerArn; + } + export interface DeleteEntityRecognizerResponse { + } + export interface DescribeDocumentClassificationJobRequest { + /** + * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response. + */ + JobId: JobId; + } + export interface DescribeDocumentClassificationJobResponse { + /** + * An object that describes the properties associated with the document classification job. + */ + DocumentClassificationJobProperties?: DocumentClassificationJobProperties; + } + export interface DescribeDocumentClassifierRequest { + /** + * The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response. + */ + DocumentClassifierArn: DocumentClassifierArn; + } + export interface DescribeDocumentClassifierResponse { + /** + * An object that contains the properties associated with a document classifier. + */ + DocumentClassifierProperties?: DocumentClassifierProperties; + } + export interface DescribeDominantLanguageDetectionJobRequest { + /** + * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response. + */ + JobId: JobId; + } + export interface DescribeDominantLanguageDetectionJobResponse { + /** + * An object that contains the properties associated with a dominant language detection job. + */ + DominantLanguageDetectionJobProperties?: DominantLanguageDetectionJobProperties; + } + export interface DescribeEntitiesDetectionJobRequest { + /** + * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response. + */ + JobId: JobId; + } + export interface DescribeEntitiesDetectionJobResponse { + /** + * An object that contains the properties associated with an entities detection job. + */ + EntitiesDetectionJobProperties?: EntitiesDetectionJobProperties; + } + export interface DescribeEntityRecognizerRequest { + /** + * The Amazon Resource Name (ARN) that identifies the entity recognizer. + */ + EntityRecognizerArn: EntityRecognizerArn; + } + export interface DescribeEntityRecognizerResponse { + /** + * Describes information associated with an entity recognizer. + */ + EntityRecognizerProperties?: EntityRecognizerProperties; + } + export interface DescribeKeyPhrasesDetectionJobRequest { + /** + * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response. + */ + JobId: JobId; + } + export interface DescribeKeyPhrasesDetectionJobResponse { + /** + * An object that contains the properties associated with a key phrases detection job. + */ + KeyPhrasesDetectionJobProperties?: KeyPhrasesDetectionJobProperties; + } + export interface DescribeSentimentDetectionJobRequest { + /** + * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response. + */ + JobId: JobId; + } + export interface DescribeSentimentDetectionJobResponse { + /** + * An object that contains the properties associated with a sentiment detection job. + */ + SentimentDetectionJobProperties?: SentimentDetectionJobProperties; + } + export interface DescribeTopicsDetectionJobRequest { + /** + * The identifier assigned by the user to the detection job. + */ + JobId: JobId; + } + export interface DescribeTopicsDetectionJobResponse { + /** + * The list of properties for the requested job. + */ + TopicsDetectionJobProperties?: TopicsDetectionJobProperties; + } + export interface DetectDominantLanguageRequest { + /** + * A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters. + */ + Text: String; + } + export interface DetectDominantLanguageResponse { + /** + * The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site. + */ + Languages?: ListOfDominantLanguages; + } + export interface DetectEntitiesRequest { + /** + * A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters. + */ + Text: String; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + } + export interface DetectEntitiesResponse { + /** + * A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see how-entities. + */ + Entities?: ListOfEntities; + } + export interface DetectKeyPhrasesRequest { + /** + * A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters. + */ + Text: String; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + } + export interface DetectKeyPhrasesResponse { + /** + * A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection. + */ + KeyPhrases?: ListOfKeyPhrases; + } + export interface DetectSentimentRequest { + /** + * A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters. + */ + Text: String; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + } + export interface DetectSentimentResponse { + /** + * The inferred sentiment that Amazon Comprehend has the highest level of confidence in. + */ + Sentiment?: SentimentType; + /** + * An object that lists the sentiments, and their corresponding confidence levels. + */ + SentimentScore?: SentimentScore; + } + export interface DetectSyntaxRequest { + /** + * A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters. + */ + Text: String; + /** + * The language code of the input documents. You can specify English ("en") or Spanish ("es"). + */ + LanguageCode: SyntaxLanguageCode; + } + export interface DetectSyntaxResponse { + /** + * A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax. + */ + SyntaxTokens?: ListOfSyntaxTokens; + } + export interface DocumentClassificationJobFilter { + /** + * Filters on the name of the job. + */ + JobName?: JobName; + /** + * Filters the list based on job status. Returns only jobs with the specified status. + */ + JobStatus?: JobStatus; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface DocumentClassificationJobProperties { + /** + * The identifier assigned to the document classification job. + */ + JobId?: JobId; + /** + * The name that you assigned to the document classification job. + */ + JobName?: JobName; + /** + * The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure. + */ + JobStatus?: JobStatus; + /** + * A description of the status of the job. + */ + Message?: AnyLengthString; + /** + * The time that the document classification job was submitted for processing. + */ + SubmitTime?: Timestamp; + /** + * The time that the document classification job completed. + */ + EndTime?: Timestamp; + /** + * The Amazon Resource Name (ARN) that identifies the document classifier. + */ + DocumentClassifierArn?: DocumentClassifierArn; + /** + * The input data configuration that you supplied when you created the document classification job. + */ + InputDataConfig?: InputDataConfig; + /** + * The output data configuration that you supplied when you created the document classification job. + */ + OutputDataConfig?: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type DocumentClassificationJobPropertiesList = DocumentClassificationJobProperties[]; + export type DocumentClassifierArn = string; + export interface DocumentClassifierFilter { + /** + * Filters the list of classifiers based on status. + */ + Status?: ModelStatus; + /** + * Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface DocumentClassifierInputDataConfig { + /** + * The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files. For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input. + */ + S3Uri: S3Uri; + } + export interface DocumentClassifierOutputDataConfig { + /** + * When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file. When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix. + */ + S3Uri?: S3Uri; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" KMS Key Alias: "alias/ExampleAlias" ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + */ + KmsKeyId?: KmsKeyId; + } + export interface DocumentClassifierProperties { + /** + * The Amazon Resource Name (ARN) that identifies the document classifier. + */ + DocumentClassifierArn?: DocumentClassifierArn; + /** + * The language code for the language of the documents that the classifier was trained on. + */ + LanguageCode?: LanguageCode; + /** + * The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field. + */ + Status?: ModelStatus; + /** + * Additional information about the status of the classifier. + */ + Message?: AnyLengthString; + /** + * The time that the document classifier was submitted for training. + */ + SubmitTime?: Timestamp; + /** + * The time that training the document classifier completed. + */ + EndTime?: Timestamp; + /** + * Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime. + */ + TrainingStartTime?: Timestamp; + /** + * The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime. + */ + TrainingEndTime?: Timestamp; + /** + * The input data configuration that you supplied when you created the document classifier for training. + */ + InputDataConfig?: DocumentClassifierInputDataConfig; + /** + * Provides output results configuration parameters for custom classifier jobs. + */ + OutputDataConfig?: DocumentClassifierOutputDataConfig; + /** + * Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating. + */ + ClassifierMetadata?: ClassifierMetadata; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type DocumentClassifierPropertiesList = DocumentClassifierProperties[]; + export interface DominantLanguage { + /** + * The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site. + */ + LanguageCode?: String; + /** + * The level of confidence that Amazon Comprehend has in the accuracy of the detection. + */ + Score?: Float; + } + export interface DominantLanguageDetectionJobFilter { + /** + * Filters on the name of the job. + */ + JobName?: JobName; + /** + * Filters the list of jobs based on job status. Returns only jobs with the specified status. + */ + JobStatus?: JobStatus; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface DominantLanguageDetectionJobProperties { + /** + * The identifier assigned to the dominant language detection job. + */ + JobId?: JobId; + /** + * The name that you assigned to the dominant language detection job. + */ + JobName?: JobName; + /** + * The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure. + */ + JobStatus?: JobStatus; + /** + * A description for the status of a job. + */ + Message?: AnyLengthString; + /** + * The time that the dominant language detection job was submitted for processing. + */ + SubmitTime?: Timestamp; + /** + * The time that the dominant language detection job completed. + */ + EndTime?: Timestamp; + /** + * The input data configuration that you supplied when you created the dominant language detection job. + */ + InputDataConfig?: InputDataConfig; + /** + * The output data configuration that you supplied when you created the dominant language detection job. + */ + OutputDataConfig?: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type DominantLanguageDetectionJobPropertiesList = DominantLanguageDetectionJobProperties[]; + export type Double = number; + export interface EntitiesDetectionJobFilter { + /** + * Filters on the name of the job. + */ + JobName?: JobName; + /** + * Filters the list of jobs based on job status. Returns only jobs with the specified status. + */ + JobStatus?: JobStatus; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface EntitiesDetectionJobProperties { + /** + * The identifier assigned to the entities detection job. + */ + JobId?: JobId; + /** + * The name that you assigned the entities detection job. + */ + JobName?: JobName; + /** + * The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure. + */ + JobStatus?: JobStatus; + /** + * A description of the status of a job. + */ + Message?: AnyLengthString; + /** + * The time that the entities detection job was submitted for processing. + */ + SubmitTime?: Timestamp; + /** + * The time that the entities detection job completed + */ + EndTime?: Timestamp; + /** + * The Amazon Resource Name (ARN) that identifies the entity recognizer. + */ + EntityRecognizerArn?: EntityRecognizerArn; + /** + * The input data configuration that you supplied when you created the entities detection job. + */ + InputDataConfig?: InputDataConfig; + /** + * The output data configuration that you supplied when you created the entities detection job. + */ + OutputDataConfig?: OutputDataConfig; + /** + * The language code of the input documents. + */ + LanguageCode?: LanguageCode; + /** + * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type EntitiesDetectionJobPropertiesList = EntitiesDetectionJobProperties[]; + export interface Entity { + /** + * The level of confidence that Amazon Comprehend has in the accuracy of the detection. + */ + Score?: Float; + /** + * The entity's type. + */ + Type?: EntityType; + /** + * The text of the entity. + */ + Text?: String; + /** + * A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point. + */ + BeginOffset?: Integer; + /** + * A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point. + */ + EndOffset?: Integer; + } + export interface EntityRecognizerAnnotations { + /** + * Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling. + */ + S3Uri: S3Uri; + } + export type EntityRecognizerArn = string; + export interface EntityRecognizerDocuments { + /** + * Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling. + */ + S3Uri: S3Uri; + } + export interface EntityRecognizerEntityList { + /** + * Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling. + */ + S3Uri: S3Uri; + } + export interface EntityRecognizerEvaluationMetrics { + /** + * A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. + */ + Precision?: Double; + /** + * A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results. + */ + Recall?: Double; + /** + * A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. + */ + F1Score?: Double; + } + export interface EntityRecognizerFilter { + /** + * The status of an entity recognizer. + */ + Status?: ModelStatus; + /** + * Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface EntityRecognizerInputDataConfig { + /** + * The entity types in the input data for an entity recognizer. + */ + EntityTypes: EntityTypesList; + /** + * S3 location of the documents folder for an entity recognizer + */ + Documents: EntityRecognizerDocuments; + /** + * S3 location of the annotations file for an entity recognizer. + */ + Annotations?: EntityRecognizerAnnotations; + /** + * S3 location of the entity list for an entity recognizer. + */ + EntityList?: EntityRecognizerEntityList; + } + export interface EntityRecognizerMetadata { + /** + * The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents. + */ + NumberOfTrainedDocuments?: Integer; + /** + * The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents. + */ + NumberOfTestDocuments?: Integer; + /** + * Detailed information about the accuracy of an entity recognizer. + */ + EvaluationMetrics?: EntityRecognizerEvaluationMetrics; + /** + * Entity types from the metadata of an entity recognizer. + */ + EntityTypes?: EntityRecognizerMetadataEntityTypesList; + } + export type EntityRecognizerMetadataEntityTypesList = EntityRecognizerMetadataEntityTypesListItem[]; + export interface EntityRecognizerMetadataEntityTypesListItem { + /** + * Type of entity from the list of entity types in the metadata of an entity recognizer. + */ + Type?: AnyLengthString; + } + export interface EntityRecognizerProperties { + /** + * The Amazon Resource Name (ARN) that identifies the entity recognizer. + */ + EntityRecognizerArn?: EntityRecognizerArn; + /** + * The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported. + */ + LanguageCode?: LanguageCode; + /** + * Provides the status of the entity recognizer. + */ + Status?: ModelStatus; + /** + * A description of the status of the recognizer. + */ + Message?: AnyLengthString; + /** + * The time that the recognizer was submitted for processing. + */ + SubmitTime?: Timestamp; + /** + * The time that the recognizer creation completed. + */ + EndTime?: Timestamp; + /** + * The time that training of the entity recognizer started. + */ + TrainingStartTime?: Timestamp; + /** + * The time that training of the entity recognizer was completed. + */ + TrainingEndTime?: Timestamp; + /** + * The input data properties of an entity recognizer. + */ + InputDataConfig?: EntityRecognizerInputDataConfig; + /** + * Provides information about an entity recognizer. + */ + RecognizerMetadata?: EntityRecognizerMetadata; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type EntityRecognizerPropertiesList = EntityRecognizerProperties[]; + export type EntityType = "PERSON"|"LOCATION"|"ORGANIZATION"|"COMMERCIAL_ITEM"|"EVENT"|"DATE"|"QUANTITY"|"TITLE"|"OTHER"|string; + export type EntityTypeName = string; + export type EntityTypesList = EntityTypesListItem[]; + export interface EntityTypesListItem { + /** + * Entity type of an item on an entity type list. + */ + Type: EntityTypeName; + } + export type Float = number; + export type IamRoleArn = string; + export interface InputDataConfig { + /** + * The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files. For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input. + */ + S3Uri: S3Uri; + /** + * Specifies how the text in an input file should be processed: ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages. + */ + InputFormat?: InputFormat; + } + export type InputFormat = "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE"|string; + export type Integer = number; + export type JobId = string; + export type JobName = string; + export type JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED"|string; + export interface KeyPhrase { + /** + * The level of confidence that Amazon Comprehend has in the accuracy of the detection. + */ + Score?: Float; + /** + * The text of a key noun phrase. + */ + Text?: String; + /** + * A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point. + */ + BeginOffset?: Integer; + /** + * A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point. + */ + EndOffset?: Integer; + } + export interface KeyPhrasesDetectionJobFilter { + /** + * Filters on the name of the job. + */ + JobName?: JobName; + /** + * Filters the list of jobs based on job status. Returns only jobs with the specified status. + */ + JobStatus?: JobStatus; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface KeyPhrasesDetectionJobProperties { + /** + * The identifier assigned to the key phrases detection job. + */ + JobId?: JobId; + /** + * The name that you assigned the key phrases detection job. + */ + JobName?: JobName; + /** + * The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure. + */ + JobStatus?: JobStatus; + /** + * A description of the status of a job. + */ + Message?: AnyLengthString; + /** + * The time that the key phrases detection job was submitted for processing. + */ + SubmitTime?: Timestamp; + /** + * The time that the key phrases detection job completed. + */ + EndTime?: Timestamp; + /** + * The input data configuration that you supplied when you created the key phrases detection job. + */ + InputDataConfig?: InputDataConfig; + /** + * The output data configuration that you supplied when you created the key phrases detection job. + */ + OutputDataConfig?: OutputDataConfig; + /** + * The language code of the input documents. + */ + LanguageCode?: LanguageCode; + /** + * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type KeyPhrasesDetectionJobPropertiesList = KeyPhrasesDetectionJobProperties[]; + export type KmsKeyId = string; + export type LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|string; + export interface ListDocumentClassificationJobsRequest { + /** + * Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time. + */ + Filter?: DocumentClassificationJobFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListDocumentClassificationJobsResponse { + /** + * A list containing the properties of each job returned. + */ + DocumentClassificationJobPropertiesList?: DocumentClassificationJobPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export interface ListDocumentClassifiersRequest { + /** + * Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time. + */ + Filter?: DocumentClassifierFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListDocumentClassifiersResponse { + /** + * A list containing the properties of each job returned. + */ + DocumentClassifierPropertiesList?: DocumentClassifierPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export interface ListDominantLanguageDetectionJobsRequest { + /** + * Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time. + */ + Filter?: DominantLanguageDetectionJobFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListDominantLanguageDetectionJobsResponse { + /** + * A list containing the properties of each job that is returned. + */ + DominantLanguageDetectionJobPropertiesList?: DominantLanguageDetectionJobPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export interface ListEntitiesDetectionJobsRequest { + /** + * Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time. + */ + Filter?: EntitiesDetectionJobFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListEntitiesDetectionJobsResponse { + /** + * A list containing the properties of each job that is returned. + */ + EntitiesDetectionJobPropertiesList?: EntitiesDetectionJobPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export interface ListEntityRecognizersRequest { + /** + * Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time. + */ + Filter?: EntityRecognizerFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return on each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListEntityRecognizersResponse { + /** + * The list of properties of an entity recognizer. + */ + EntityRecognizerPropertiesList?: EntityRecognizerPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export interface ListKeyPhrasesDetectionJobsRequest { + /** + * Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time. + */ + Filter?: KeyPhrasesDetectionJobFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListKeyPhrasesDetectionJobsResponse { + /** + * A list containing the properties of each job that is returned. + */ + KeyPhrasesDetectionJobPropertiesList?: KeyPhrasesDetectionJobPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export type ListOfDetectDominantLanguageResult = BatchDetectDominantLanguageItemResult[]; + export type ListOfDetectEntitiesResult = BatchDetectEntitiesItemResult[]; + export type ListOfDetectKeyPhrasesResult = BatchDetectKeyPhrasesItemResult[]; + export type ListOfDetectSentimentResult = BatchDetectSentimentItemResult[]; + export type ListOfDetectSyntaxResult = BatchDetectSyntaxItemResult[]; + export type ListOfDominantLanguages = DominantLanguage[]; + export type ListOfEntities = Entity[]; + export type ListOfKeyPhrases = KeyPhrase[]; + export type ListOfSyntaxTokens = SyntaxToken[]; + export interface ListSentimentDetectionJobsRequest { + /** + * Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time. + */ + Filter?: SentimentDetectionJobFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListSentimentDetectionJobsResponse { + /** + * A list containing the properties of each job that is returned. + */ + SentimentDetectionJobPropertiesList?: SentimentDetectionJobPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying. + */ + ResourceArn: ComprehendArn; + } + export interface ListTagsForResourceResponse { + /** + * The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying. + */ + ResourceArn?: ComprehendArn; + /** + * Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. + */ + Tags?: TagList; + } + export interface ListTopicsDetectionJobsRequest { + /** + * Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time. + */ + Filter?: TopicsDetectionJobFilter; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in each page. The default is 100. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListTopicsDetectionJobsResponse { + /** + * A list containing the properties of each job that is returned. + */ + TopicsDetectionJobPropertiesList?: TopicsDetectionJobPropertiesList; + /** + * Identifies the next page of results to return. + */ + NextToken?: String; + } + export type MaxResultsInteger = number; + export type ModelStatus = "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED"|string; + export type NumberOfTopicsInteger = number; + export interface OutputDataConfig { + /** + * When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file. When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation. + */ + S3Uri: S3Uri; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" KMS Key Alias: "alias/ExampleAlias" ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + */ + KmsKeyId?: KmsKeyId; + } + export interface PartOfSpeechTag { + /** + * Identifies the part of speech that the token represents. + */ + Tag?: PartOfSpeechTagType; + /** + * The confidence that Amazon Comprehend has that the part of speech was correctly identified. + */ + Score?: Float; + } + export type PartOfSpeechTagType = "ADJ"|"ADP"|"ADV"|"AUX"|"CONJ"|"CCONJ"|"DET"|"INTJ"|"NOUN"|"NUM"|"O"|"PART"|"PRON"|"PROPN"|"PUNCT"|"SCONJ"|"SYM"|"VERB"|string; + export type S3Uri = string; + export interface SentimentDetectionJobFilter { + /** + * Filters on the name of the job. + */ + JobName?: JobName; + /** + * Filters the list of jobs based on job status. Returns only jobs with the specified status. + */ + JobStatus?: JobStatus; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface SentimentDetectionJobProperties { + /** + * The identifier assigned to the sentiment detection job. + */ + JobId?: JobId; + /** + * The name that you assigned to the sentiment detection job + */ + JobName?: JobName; + /** + * The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure. + */ + JobStatus?: JobStatus; + /** + * A description of the status of a job. + */ + Message?: AnyLengthString; + /** + * The time that the sentiment detection job was submitted for processing. + */ + SubmitTime?: Timestamp; + /** + * The time that the sentiment detection job ended. + */ + EndTime?: Timestamp; + /** + * The input data configuration that you supplied when you created the sentiment detection job. + */ + InputDataConfig?: InputDataConfig; + /** + * The output data configuration that you supplied when you created the sentiment detection job. + */ + OutputDataConfig?: OutputDataConfig; + /** + * The language code of the input documents. + */ + LanguageCode?: LanguageCode; + /** + * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type SentimentDetectionJobPropertiesList = SentimentDetectionJobProperties[]; + export interface SentimentScore { + /** + * The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment. + */ + Positive?: Float; + /** + * The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment. + */ + Negative?: Float; + /** + * The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment. + */ + Neutral?: Float; + /** + * The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment. + */ + Mixed?: Float; + } + export type SentimentType = "POSITIVE"|"NEGATIVE"|"NEUTRAL"|"MIXED"|string; + export interface StartDocumentClassificationJobRequest { + /** + * The identifier of the job. + */ + JobName?: JobName; + /** + * The Amazon Resource Name (ARN) of the document classifier to use to process the job. + */ + DocumentClassifierArn: DocumentClassifierArn; + /** + * Specifies the format and location of the input data for the job. + */ + InputDataConfig: InputDataConfig; + /** + * Specifies where to send the output files. + */ + OutputDataConfig: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. + */ + DataAccessRoleArn: IamRoleArn; + /** + * A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface StartDocumentClassificationJobResponse { + /** + * The identifier generated for the job. To get the status of the job, use this identifier with the operation. + */ + JobId?: JobId; + /** + * The status of the job: SUBMITTED - The job has been received and queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. For details, use the operation. STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. STOPPED - The job was successfully stopped without completing. + */ + JobStatus?: JobStatus; + } + export interface StartDominantLanguageDetectionJobRequest { + /** + * Specifies the format and location of the input data for the job. + */ + InputDataConfig: InputDataConfig; + /** + * Specifies where to send the output files. + */ + OutputDataConfig: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions. + */ + DataAccessRoleArn: IamRoleArn; + /** + * An identifier for the job. + */ + JobName?: JobName; + /** + * A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface StartDominantLanguageDetectionJobResponse { + /** + * The identifier generated for the job. To get the status of a job, use this identifier with the operation. + */ + JobId?: JobId; + /** + * The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the operation. + */ + JobStatus?: JobStatus; + } + export interface StartEntitiesDetectionJobRequest { + /** + * Specifies the format and location of the input data for the job. + */ + InputDataConfig: InputDataConfig; + /** + * Specifies where to send the output files. + */ + OutputDataConfig: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions. + */ + DataAccessRoleArn: IamRoleArn; + /** + * The identifier of the job. + */ + JobName?: JobName; + /** + * The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job. + */ + EntityRecognizerArn?: EntityRecognizerArn; + /** + * The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), German ("de"), Italian ("it"), or Portuguese ("pt"). If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead. + */ + LanguageCode: LanguageCode; + /** + * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface StartEntitiesDetectionJobResponse { + /** + * The identifier generated for the job. To get the status of job, use this identifier with the operation. + */ + JobId?: JobId; + /** + * The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the operation. STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. STOPPED - The job was successfully stopped without completing. + */ + JobStatus?: JobStatus; + } + export interface StartKeyPhrasesDetectionJobRequest { + /** + * Specifies the format and location of the input data for the job. + */ + InputDataConfig: InputDataConfig; + /** + * Specifies where to send the output files. + */ + OutputDataConfig: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions. + */ + DataAccessRoleArn: IamRoleArn; + /** + * The identifier of the job. + */ + JobName?: JobName; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + /** + * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface StartKeyPhrasesDetectionJobResponse { + /** + * The identifier generated for the job. To get the status of a job, use this identifier with the operation. + */ + JobId?: JobId; + /** + * The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the operation. + */ + JobStatus?: JobStatus; + } + export interface StartSentimentDetectionJobRequest { + /** + * Specifies the format and location of the input data for the job. + */ + InputDataConfig: InputDataConfig; + /** + * Specifies where to send the output files. + */ + OutputDataConfig: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions. + */ + DataAccessRoleArn: IamRoleArn; + /** + * The identifier of the job. + */ + JobName?: JobName; + /** + * The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language. + */ + LanguageCode: LanguageCode; + /** + * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface StartSentimentDetectionJobResponse { + /** + * The identifier generated for the job. To get the status of a job, use this identifier with the operation. + */ + JobId?: JobId; + /** + * The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the operation. + */ + JobStatus?: JobStatus; + } + export interface StartTopicsDetectionJobRequest { + /** + * Specifies the format and location of the input data for the job. + */ + InputDataConfig: InputDataConfig; + /** + * Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic + */ + OutputDataConfig: OutputDataConfig; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions. + */ + DataAccessRoleArn: IamRoleArn; + /** + * The identifier of the job. + */ + JobName?: JobName; + /** + * The number of topics to detect. + */ + NumberOfTopics?: NumberOfTopicsInteger; + /** + * A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one. + */ + ClientRequestToken?: ClientRequestTokenString; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface StartTopicsDetectionJobResponse { + /** + * The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation. + */ + JobId?: JobId; + /** + * The status of the job: SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation. + */ + JobStatus?: JobStatus; + } + export interface StopDominantLanguageDetectionJobRequest { + /** + * The identifier of the dominant language detection job to stop. + */ + JobId: JobId; + } + export interface StopDominantLanguageDetectionJobResponse { + /** + * The identifier of the dominant language detection job to stop. + */ + JobId?: JobId; + /** + * Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation. + */ + JobStatus?: JobStatus; + } + export interface StopEntitiesDetectionJobRequest { + /** + * The identifier of the entities detection job to stop. + */ + JobId: JobId; + } + export interface StopEntitiesDetectionJobResponse { + /** + * The identifier of the entities detection job to stop. + */ + JobId?: JobId; + /** + * Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation. + */ + JobStatus?: JobStatus; + } + export interface StopKeyPhrasesDetectionJobRequest { + /** + * The identifier of the key phrases detection job to stop. + */ + JobId: JobId; + } + export interface StopKeyPhrasesDetectionJobResponse { + /** + * The identifier of the key phrases detection job to stop. + */ + JobId?: JobId; + /** + * Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation. + */ + JobStatus?: JobStatus; + } + export interface StopSentimentDetectionJobRequest { + /** + * The identifier of the sentiment detection job to stop. + */ + JobId: JobId; + } + export interface StopSentimentDetectionJobResponse { + /** + * The identifier of the sentiment detection job to stop. + */ + JobId?: JobId; + /** + * Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation. + */ + JobStatus?: JobStatus; + } + export interface StopTrainingDocumentClassifierRequest { + /** + * The Amazon Resource Name (ARN) that identifies the document classifier currently being trained. + */ + DocumentClassifierArn: DocumentClassifierArn; + } + export interface StopTrainingDocumentClassifierResponse { + } + export interface StopTrainingEntityRecognizerRequest { + /** + * The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained. + */ + EntityRecognizerArn: EntityRecognizerArn; + } + export interface StopTrainingEntityRecognizerResponse { + } + export type String = string; + export type StringList = String[]; + export type SyntaxLanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|string; + export interface SyntaxToken { + /** + * A unique identifier for a token. + */ + TokenId?: Integer; + /** + * The word that was recognized in the source text. + */ + Text?: String; + /** + * The zero-based offset from the beginning of the source text to the first character in the word. + */ + BeginOffset?: Integer; + /** + * The zero-based offset from the beginning of the source text to the last character in the word. + */ + EndOffset?: Integer; + /** + * Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax. + */ + PartOfSpeech?: PartOfSpeechTag; + } + export interface Tag { + /** + * The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.” + */ + Key: TagKey; + /** + * The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags. + */ + ResourceArn: ComprehendArn; + /** + * Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Timestamp = Date; + export interface TopicsDetectionJobFilter { + /** + * + */ + JobName?: JobName; + /** + * Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status. + */ + JobStatus?: JobStatus; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest. + */ + SubmitTimeBefore?: Timestamp; + /** + * Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest. + */ + SubmitTimeAfter?: Timestamp; + } + export interface TopicsDetectionJobProperties { + /** + * The identifier assigned to the topic detection job. + */ + JobId?: JobId; + /** + * The name of the topic detection job. + */ + JobName?: JobName; + /** + * The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field. + */ + JobStatus?: JobStatus; + /** + * A description for the status of a job. + */ + Message?: AnyLengthString; + /** + * The time that the topic detection job was submitted for processing. + */ + SubmitTime?: Timestamp; + /** + * The time that the topic detection job was completed. + */ + EndTime?: Timestamp; + /** + * The input data configuration supplied when you created the topic detection job. + */ + InputDataConfig?: InputDataConfig; + /** + * The output data configuration supplied when you created the topic detection job. + */ + OutputDataConfig?: OutputDataConfig; + /** + * The number of topics to detect supplied when you created the topic detection job. The default is 10. + */ + NumberOfTopics?: Integer; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data. + */ + DataAccessRoleArn?: IamRoleArn; + /** + * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export type TopicsDetectionJobPropertiesList = TopicsDetectionJobProperties[]; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags. + */ + ResourceArn: ComprehendArn; + /** + * The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-11-27"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Comprehend client. + */ + export import Types = Comprehend; +} +export = Comprehend; diff --git a/node_modules/aws-sdk/clients/comprehend.js b/node_modules/aws-sdk/clients/comprehend.js new file mode 100644 index 0000000..2b9f52e --- /dev/null +++ b/node_modules/aws-sdk/clients/comprehend.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['comprehend'] = {}; +AWS.Comprehend = Service.defineService('comprehend', ['2017-11-27']); +Object.defineProperty(apiLoader.services['comprehend'], '2017-11-27', { + get: function get() { + var model = require('../apis/comprehend-2017-11-27.min.json'); + model.paginators = require('../apis/comprehend-2017-11-27.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Comprehend; diff --git a/node_modules/aws-sdk/clients/comprehendmedical.d.ts b/node_modules/aws-sdk/clients/comprehendmedical.d.ts new file mode 100644 index 0000000..42383b2 --- /dev/null +++ b/node_modules/aws-sdk/clients/comprehendmedical.d.ts @@ -0,0 +1,187 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ComprehendMedical extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ComprehendMedical.Types.ClientConfiguration) + config: Config & ComprehendMedical.Types.ClientConfiguration; + /** + * Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information . + */ + detectEntities(params: ComprehendMedical.Types.DetectEntitiesRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesResponse) => void): Request; + /** + * Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information . + */ + detectEntities(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectEntitiesResponse) => void): Request; + /** + * Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information. + */ + detectPHI(params: ComprehendMedical.Types.DetectPHIRequest, callback?: (err: AWSError, data: ComprehendMedical.Types.DetectPHIResponse) => void): Request; + /** + * Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information. + */ + detectPHI(callback?: (err: AWSError, data: ComprehendMedical.Types.DetectPHIResponse) => void): Request; +} +declare namespace ComprehendMedical { + export interface Attribute { + /** + * The type of attribute. + */ + Type?: EntitySubType; + /** + * The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute. + */ + Score?: Float; + /** + * The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity. + */ + RelationshipScore?: Float; + /** + * The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier. + */ + Id?: Integer; + /** + * The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string. + */ + BeginOffset?: Integer; + /** + * The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string. + */ + EndOffset?: Integer; + /** + * The segment of input text extracted as this attribute. + */ + Text?: String; + /** + * Contextual information for this attribute. + */ + Traits?: TraitList; + } + export type AttributeList = Attribute[]; + export type AttributeName = "SIGN"|"SYMPTOM"|"DIAGNOSIS"|"NEGATION"|string; + export type BoundedLengthString = string; + export interface DetectEntitiesRequest { + /** + * A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters. + */ + Text: BoundedLengthString; + } + export interface DetectEntitiesResponse { + /** + * The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned. + */ + Entities: EntityList; + /** + * Attributes extracted from the input text that we were unable to relate to an entity. + */ + UnmappedAttributes?: UnmappedAttributeList; + /** + * If the result of the previous request to DetectEntities was truncated, include the Paginationtoken to fetch the next page of entities. + */ + PaginationToken?: String; + } + export interface DetectPHIRequest { + /** + * A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters. + */ + Text: BoundedLengthString; + } + export interface DetectPHIResponse { + /** + * The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in its detection. + */ + Entities: EntityList; + /** + * If the result of the previous request to DetectPHI was truncated, include the Paginationtoken to fetch the next page of PHI entities. + */ + PaginationToken?: String; + } + export interface Entity { + /** + * The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier. + */ + Id?: Integer; + /** + * The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string. + */ + BeginOffset?: Integer; + /** + * The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string. + */ + EndOffset?: Integer; + /** + * The level of confidence that Comprehend Medical has in the accuracy of the detection. + */ + Score?: Float; + /** + * The segment of input text extracted as this entity. + */ + Text?: String; + /** + * The category of the entity. + */ + Category?: EntityType; + /** + * Describes the specific type of entity with category of entities. + */ + Type?: EntitySubType; + /** + * Contextual information for the entity + */ + Traits?: TraitList; + /** + * The extracted attributes that relate to this entity. + */ + Attributes?: AttributeList; + } + export type EntityList = Entity[]; + export type EntitySubType = "NAME"|"DOSAGE"|"ROUTE_OR_MODE"|"FORM"|"FREQUENCY"|"DURATION"|"GENERIC_NAME"|"BRAND_NAME"|"STRENGTH"|"RATE"|"ACUITY"|"TEST_NAME"|"TEST_VALUE"|"TEST_UNITS"|"PROCEDURE_NAME"|"TREATMENT_NAME"|"DATE"|"AGE"|"CONTACT_POINT"|"EMAIL"|"IDENTIFIER"|"URL"|"ADDRESS"|"PROFESSION"|"SYSTEM_ORGAN_SITE"|"DIRECTION"|"QUALITY"|"QUANTITY"|string; + export type EntityType = "MEDICATION"|"MEDICAL_CONDITION"|"PROTECTED_HEALTH_INFORMATION"|"TEST_TREATMENT_PROCEDURE"|"ANATOMY"|string; + export type Float = number; + export type Integer = number; + export type String = string; + export interface Trait { + /** + * Provides a name or contextual description about the trait. + */ + Name?: AttributeName; + /** + * The level of confidence that Comprehend Medical has in the accuracy of this trait. + */ + Score?: Float; + } + export type TraitList = Trait[]; + export interface UnmappedAttribute { + /** + * The type of the attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PERSONAL_HEALTH_INFORMATION". + */ + Type?: EntityType; + /** + * The specific attribute that has been extracted but not mapped to an entity. + */ + Attribute?: Attribute; + } + export type UnmappedAttributeList = UnmappedAttribute[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-10-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ComprehendMedical client. + */ + export import Types = ComprehendMedical; +} +export = ComprehendMedical; diff --git a/node_modules/aws-sdk/clients/comprehendmedical.js b/node_modules/aws-sdk/clients/comprehendmedical.js new file mode 100644 index 0000000..8292f16 --- /dev/null +++ b/node_modules/aws-sdk/clients/comprehendmedical.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['comprehendmedical'] = {}; +AWS.ComprehendMedical = Service.defineService('comprehendmedical', ['2018-10-30']); +Object.defineProperty(apiLoader.services['comprehendmedical'], '2018-10-30', { + get: function get() { + var model = require('../apis/comprehendmedical-2018-10-30.min.json'); + model.paginators = require('../apis/comprehendmedical-2018-10-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ComprehendMedical; diff --git a/node_modules/aws-sdk/clients/configservice.d.ts b/node_modules/aws-sdk/clients/configservice.d.ts new file mode 100644 index 0000000..a0e32c5 --- /dev/null +++ b/node_modules/aws-sdk/clients/configservice.d.ts @@ -0,0 +1,2614 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ConfigService extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ConfigService.Types.ClientConfiguration) + config: Config & ConfigService.Types.ClientConfiguration; + /** + * Returns the current configuration items for resources that are present in your AWS Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list. The API does not return results for deleted resources. The API does not return tags and relationships. + */ + batchGetAggregateResourceConfig(params: ConfigService.Types.BatchGetAggregateResourceConfigRequest, callback?: (err: AWSError, data: ConfigService.Types.BatchGetAggregateResourceConfigResponse) => void): Request; + /** + * Returns the current configuration items for resources that are present in your AWS Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list. The API does not return results for deleted resources. The API does not return tags and relationships. + */ + batchGetAggregateResourceConfig(callback?: (err: AWSError, data: ConfigService.Types.BatchGetAggregateResourceConfigResponse) => void): Request; + /** + * Returns the current configuration for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list. The API does not return results for deleted resources. The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response. + */ + batchGetResourceConfig(params: ConfigService.Types.BatchGetResourceConfigRequest, callback?: (err: AWSError, data: ConfigService.Types.BatchGetResourceConfigResponse) => void): Request; + /** + * Returns the current configuration for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list. The API does not return results for deleted resources. The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response. + */ + batchGetResourceConfig(callback?: (err: AWSError, data: ConfigService.Types.BatchGetResourceConfigResponse) => void): Request; + /** + * Deletes the authorization granted to the specified configuration aggregator account in a specified region. + */ + deleteAggregationAuthorization(params: ConfigService.Types.DeleteAggregationAuthorizationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the authorization granted to the specified configuration aggregator account in a specified region. + */ + deleteAggregationAuthorization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified AWS Config rule and all of its evaluation results. AWS Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException. You can check the state of a rule by using the DescribeConfigRules request. + */ + deleteConfigRule(params: ConfigService.Types.DeleteConfigRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified AWS Config rule and all of its evaluation results. AWS Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException. You can check the state of a rule by using the DescribeConfigRules request. + */ + deleteConfigRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified configuration aggregator and the aggregated data associated with the aggregator. + */ + deleteConfigurationAggregator(params: ConfigService.Types.DeleteConfigurationAggregatorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified configuration aggregator and the aggregated data associated with the aggregator. + */ + deleteConfigurationAggregator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the configuration recorder. After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder. This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder. + */ + deleteConfigurationRecorder(params: ConfigService.Types.DeleteConfigurationRecorderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the configuration recorder. After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder. This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder. + */ + deleteConfigurationRecorder(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the delivery channel. Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action. + */ + deleteDeliveryChannel(params: ConfigService.Types.DeleteDeliveryChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the delivery channel. Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action. + */ + deleteDeliveryChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule. + */ + deleteEvaluationResults(params: ConfigService.Types.DeleteEvaluationResultsRequest, callback?: (err: AWSError, data: ConfigService.Types.DeleteEvaluationResultsResponse) => void): Request; + /** + * Deletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule. + */ + deleteEvaluationResults(callback?: (err: AWSError, data: ConfigService.Types.DeleteEvaluationResultsResponse) => void): Request; + /** + * Deletes pending authorization requests for a specified aggregator account in a specified region. + */ + deletePendingAggregationRequest(params: ConfigService.Types.DeletePendingAggregationRequestRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes pending authorization requests for a specified aggregator account in a specified region. + */ + deletePendingAggregationRequest(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the remediation configuration. + */ + deleteRemediationConfiguration(params: ConfigService.Types.DeleteRemediationConfigurationRequest, callback?: (err: AWSError, data: ConfigService.Types.DeleteRemediationConfigurationResponse) => void): Request; + /** + * Deletes the remediation configuration. + */ + deleteRemediationConfiguration(callback?: (err: AWSError, data: ConfigService.Types.DeleteRemediationConfigurationResponse) => void): Request; + /** + * Deletes the retention configuration. + */ + deleteRetentionConfiguration(params: ConfigService.Types.DeleteRetentionConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the retention configuration. + */ + deleteRetentionConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified. Notification of the start of the delivery. Notification of the completion of the delivery, if the delivery was successfully completed. Notification of delivery failure, if the delivery failed. + */ + deliverConfigSnapshot(params: ConfigService.Types.DeliverConfigSnapshotRequest, callback?: (err: AWSError, data: ConfigService.Types.DeliverConfigSnapshotResponse) => void): Request; + /** + * Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified. Notification of the start of the delivery. Notification of the completion of the delivery, if the delivery was successfully completed. Notification of delivery failure, if the delivery failed. + */ + deliverConfigSnapshot(callback?: (err: AWSError, data: ConfigService.Types.DeliverConfigSnapshotResponse) => void): Request; + /** + * Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. + */ + describeAggregateComplianceByConfigRules(params: ConfigService.Types.DescribeAggregateComplianceByConfigRulesRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeAggregateComplianceByConfigRulesResponse) => void): Request; + /** + * Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. + */ + describeAggregateComplianceByConfigRules(callback?: (err: AWSError, data: ConfigService.Types.DescribeAggregateComplianceByConfigRulesResponse) => void): Request; + /** + * Returns a list of authorizations granted to various aggregator accounts and regions. + */ + describeAggregationAuthorizations(params: ConfigService.Types.DescribeAggregationAuthorizationsRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeAggregationAuthorizationsResponse) => void): Request; + /** + * Returns a list of authorizations granted to various aggregator accounts and regions. + */ + describeAggregationAuthorizations(callback?: (err: AWSError, data: ConfigService.Types.DescribeAggregationAuthorizationsResponse) => void): Request; + /** + * Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply. If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions: AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission. The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. + */ + describeComplianceByConfigRule(params: ConfigService.Types.DescribeComplianceByConfigRuleRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeComplianceByConfigRuleResponse) => void): Request; + /** + * Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply. If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions: AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission. The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. + */ + describeComplianceByConfigRule(callback?: (err: AWSError, data: ConfigService.Types.DescribeComplianceByConfigRuleResponse) => void): Request; + /** + * Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. If AWS Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource: AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission. The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. + */ + describeComplianceByResource(params: ConfigService.Types.DescribeComplianceByResourceRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeComplianceByResourceResponse) => void): Request; + /** + * Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. If AWS Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource: AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission. The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. + */ + describeComplianceByResource(callback?: (err: AWSError, data: ConfigService.Types.DescribeComplianceByResourceResponse) => void): Request; + /** + * Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. + */ + describeConfigRuleEvaluationStatus(params: ConfigService.Types.DescribeConfigRuleEvaluationStatusRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigRuleEvaluationStatusResponse) => void): Request; + /** + * Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. + */ + describeConfigRuleEvaluationStatus(callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigRuleEvaluationStatusResponse) => void): Request; + /** + * Returns details about your AWS Config rules. + */ + describeConfigRules(params: ConfigService.Types.DescribeConfigRulesRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigRulesResponse) => void): Request; + /** + * Returns details about your AWS Config rules. + */ + describeConfigRules(callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigRulesResponse) => void): Request; + /** + * Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message. + */ + describeConfigurationAggregatorSourcesStatus(params: ConfigService.Types.DescribeConfigurationAggregatorSourcesStatusRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationAggregatorSourcesStatusResponse) => void): Request; + /** + * Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message. + */ + describeConfigurationAggregatorSourcesStatus(callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationAggregatorSourcesStatusResponse) => void): Request; + /** + * Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account. + */ + describeConfigurationAggregators(params: ConfigService.Types.DescribeConfigurationAggregatorsRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationAggregatorsResponse) => void): Request; + /** + * Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account. + */ + describeConfigurationAggregators(callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationAggregatorsResponse) => void): Request; + /** + * Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account. + */ + describeConfigurationRecorderStatus(params: ConfigService.Types.DescribeConfigurationRecorderStatusRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationRecorderStatusResponse) => void): Request; + /** + * Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account. + */ + describeConfigurationRecorderStatus(callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationRecorderStatusResponse) => void): Request; + /** + * Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account. + */ + describeConfigurationRecorders(params: ConfigService.Types.DescribeConfigurationRecordersRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationRecordersResponse) => void): Request; + /** + * Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account. + */ + describeConfigurationRecorders(callback?: (err: AWSError, data: ConfigService.Types.DescribeConfigurationRecordersResponse) => void): Request; + /** + * Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. + */ + describeDeliveryChannelStatus(params: ConfigService.Types.DescribeDeliveryChannelStatusRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeDeliveryChannelStatusResponse) => void): Request; + /** + * Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. + */ + describeDeliveryChannelStatus(callback?: (err: AWSError, data: ConfigService.Types.DescribeDeliveryChannelStatusResponse) => void): Request; + /** + * Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. + */ + describeDeliveryChannels(params: ConfigService.Types.DescribeDeliveryChannelsRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeDeliveryChannelsResponse) => void): Request; + /** + * Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. + */ + describeDeliveryChannels(callback?: (err: AWSError, data: ConfigService.Types.DescribeDeliveryChannelsResponse) => void): Request; + /** + * Returns a list of all pending aggregation requests. + */ + describePendingAggregationRequests(params: ConfigService.Types.DescribePendingAggregationRequestsRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribePendingAggregationRequestsResponse) => void): Request; + /** + * Returns a list of all pending aggregation requests. + */ + describePendingAggregationRequests(callback?: (err: AWSError, data: ConfigService.Types.DescribePendingAggregationRequestsResponse) => void): Request; + /** + * Returns the details of one or more remediation configurations. + */ + describeRemediationConfigurations(params: ConfigService.Types.DescribeRemediationConfigurationsRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeRemediationConfigurationsResponse) => void): Request; + /** + * Returns the details of one or more remediation configurations. + */ + describeRemediationConfigurations(callback?: (err: AWSError, data: ConfigService.Types.DescribeRemediationConfigurationsResponse) => void): Request; + /** + * Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response. + */ + describeRemediationExecutionStatus(params: ConfigService.Types.DescribeRemediationExecutionStatusRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeRemediationExecutionStatusResponse) => void): Request; + /** + * Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response. + */ + describeRemediationExecutionStatus(callback?: (err: AWSError, data: ConfigService.Types.DescribeRemediationExecutionStatusResponse) => void): Request; + /** + * Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account. Currently, AWS Config supports only one retention configuration per region in your account. + */ + describeRetentionConfigurations(params: ConfigService.Types.DescribeRetentionConfigurationsRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeRetentionConfigurationsResponse) => void): Request; + /** + * Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account. Currently, AWS Config supports only one retention configuration per region in your account. + */ + describeRetentionConfigurations(callback?: (err: AWSError, data: ConfigService.Types.DescribeRetentionConfigurationsResponse) => void): Request; + /** + * Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page. + */ + getAggregateComplianceDetailsByConfigRule(params: ConfigService.Types.GetAggregateComplianceDetailsByConfigRuleRequest, callback?: (err: AWSError, data: ConfigService.Types.GetAggregateComplianceDetailsByConfigRuleResponse) => void): Request; + /** + * Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page. + */ + getAggregateComplianceDetailsByConfigRule(callback?: (err: AWSError, data: ConfigService.Types.GetAggregateComplianceDetailsByConfigRuleResponse) => void): Request; + /** + * Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. + */ + getAggregateConfigRuleComplianceSummary(params: ConfigService.Types.GetAggregateConfigRuleComplianceSummaryRequest, callback?: (err: AWSError, data: ConfigService.Types.GetAggregateConfigRuleComplianceSummaryResponse) => void): Request; + /** + * Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. + */ + getAggregateConfigRuleComplianceSummary(callback?: (err: AWSError, data: ConfigService.Types.GetAggregateConfigRuleComplianceSummaryResponse) => void): Request; + /** + * Returns the resource counts across accounts and regions that are present in your AWS Config aggregator. You can request the resource counts by providing filters and GroupByKey. For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator. + */ + getAggregateDiscoveredResourceCounts(params: ConfigService.Types.GetAggregateDiscoveredResourceCountsRequest, callback?: (err: AWSError, data: ConfigService.Types.GetAggregateDiscoveredResourceCountsResponse) => void): Request; + /** + * Returns the resource counts across accounts and regions that are present in your AWS Config aggregator. You can request the resource counts by providing filters and GroupByKey. For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator. + */ + getAggregateDiscoveredResourceCounts(callback?: (err: AWSError, data: ConfigService.Types.GetAggregateDiscoveredResourceCountsResponse) => void): Request; + /** + * Returns configuration item that is aggregated for your specific resource in a specific source account and region. + */ + getAggregateResourceConfig(params: ConfigService.Types.GetAggregateResourceConfigRequest, callback?: (err: AWSError, data: ConfigService.Types.GetAggregateResourceConfigResponse) => void): Request; + /** + * Returns configuration item that is aggregated for your specific resource in a specific source account and region. + */ + getAggregateResourceConfig(callback?: (err: AWSError, data: ConfigService.Types.GetAggregateResourceConfigResponse) => void): Request; + /** + * Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. + */ + getComplianceDetailsByConfigRule(params: ConfigService.Types.GetComplianceDetailsByConfigRuleRequest, callback?: (err: AWSError, data: ConfigService.Types.GetComplianceDetailsByConfigRuleResponse) => void): Request; + /** + * Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. + */ + getComplianceDetailsByConfigRule(callback?: (err: AWSError, data: ConfigService.Types.GetComplianceDetailsByConfigRuleResponse) => void): Request; + /** + * Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. + */ + getComplianceDetailsByResource(params: ConfigService.Types.GetComplianceDetailsByResourceRequest, callback?: (err: AWSError, data: ConfigService.Types.GetComplianceDetailsByResourceResponse) => void): Request; + /** + * Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. + */ + getComplianceDetailsByResource(callback?: (err: AWSError, data: ConfigService.Types.GetComplianceDetailsByResourceResponse) => void): Request; + /** + * Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. + */ + getComplianceSummaryByConfigRule(callback?: (err: AWSError, data: ConfigService.Types.GetComplianceSummaryByConfigRuleResponse) => void): Request; + /** + * Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. + */ + getComplianceSummaryByResourceType(params: ConfigService.Types.GetComplianceSummaryByResourceTypeRequest, callback?: (err: AWSError, data: ConfigService.Types.GetComplianceSummaryByResourceTypeResponse) => void): Request; + /** + * Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. + */ + getComplianceSummaryByResourceType(callback?: (err: AWSError, data: ConfigService.Types.GetComplianceSummaryByResourceTypeResponse) => void): Request; + /** + * Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account. Example AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types. AWS Config returns the following: The resource types (EC2 instances, IAM users, and S3 buckets). The number of each resource type (25, 20, and 15). The total number of all resources (60). The response is paginated. By default, AWS Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations: You are a new AWS Config customer. You just enabled resource recording. It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action. + */ + getDiscoveredResourceCounts(params: ConfigService.Types.GetDiscoveredResourceCountsRequest, callback?: (err: AWSError, data: ConfigService.Types.GetDiscoveredResourceCountsResponse) => void): Request; + /** + * Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account. Example AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types. AWS Config returns the following: The resource types (EC2 instances, IAM users, and S3 buckets). The number of each resource type (25, 20, and 15). The total number of all resources (60). The response is paginated. By default, AWS Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations: You are a new AWS Config customer. You just enabled resource recording. It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action. + */ + getDiscoveredResourceCounts(callback?: (err: AWSError, data: ConfigService.Types.GetDiscoveredResourceCountsResponse) => void): Request; + /** + * Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config returns the ConfigurationItems for the specified retention period. The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken. + */ + getResourceConfigHistory(params: ConfigService.Types.GetResourceConfigHistoryRequest, callback?: (err: AWSError, data: ConfigService.Types.GetResourceConfigHistoryResponse) => void): Request; + /** + * Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config returns the ConfigurationItems for the specified retention period. The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken. + */ + getResourceConfigHistory(callback?: (err: AWSError, data: ConfigService.Types.GetResourceConfigHistoryResponse) => void): Request; + /** + * Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region. For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1. + */ + listAggregateDiscoveredResources(params: ConfigService.Types.ListAggregateDiscoveredResourcesRequest, callback?: (err: AWSError, data: ConfigService.Types.ListAggregateDiscoveredResourcesResponse) => void): Request; + /** + * Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region. For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1. + */ + listAggregateDiscoveredResources(callback?: (err: AWSError, data: ConfigService.Types.ListAggregateDiscoveredResourcesResponse) => void): Request; + /** + * Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. You can specify either resource IDs or a resource name, but not both, in the same request. The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. + */ + listDiscoveredResources(params: ConfigService.Types.ListDiscoveredResourcesRequest, callback?: (err: AWSError, data: ConfigService.Types.ListDiscoveredResourcesResponse) => void): Request; + /** + * Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. You can specify either resource IDs or a resource name, but not both, in the same request. The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. + */ + listDiscoveredResources(callback?: (err: AWSError, data: ConfigService.Types.ListDiscoveredResourcesResponse) => void): Request; + /** + * List the tags for AWS Config resource. + */ + listTagsForResource(params: ConfigService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ConfigService.Types.ListTagsForResourceResponse) => void): Request; + /** + * List the tags for AWS Config resource. + */ + listTagsForResource(callback?: (err: AWSError, data: ConfigService.Types.ListTagsForResourceResponse) => void): Request; + /** + * Authorizes the aggregator account and region to collect data from the source account and region. + */ + putAggregationAuthorization(params: ConfigService.Types.PutAggregationAuthorizationRequest, callback?: (err: AWSError, data: ConfigService.Types.PutAggregationAuthorizationResponse) => void): Request; + /** + * Authorizes the aggregator account and region to collect data from the source account and region. + */ + putAggregationAuthorization(callback?: (err: AWSError, data: ConfigService.Types.PutAggregationAuthorizationResponse) => void): Request; + /** + * Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides. If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object. If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules. For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules. If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request. The maximum number of rules that AWS Config supports is 150. For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide. For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide. + */ + putConfigRule(params: ConfigService.Types.PutConfigRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides. If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object. If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules. For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules. If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request. The maximum number of rules that AWS Config supports is 150. For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide. For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide. + */ + putConfigRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. AWS Config should be enabled in source accounts and regions you want to aggregate. If your source type is an organization, you must be signed in to the master account and all features must be enabled in your organization. AWS Config calls EnableAwsServiceAccess API to enable integration between AWS Config and AWS Organizations. + */ + putConfigurationAggregator(params: ConfigService.Types.PutConfigurationAggregatorRequest, callback?: (err: AWSError, data: ConfigService.Types.PutConfigurationAggregatorResponse) => void): Request; + /** + * Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. AWS Config should be enabled in source accounts and regions you want to aggregate. If your source type is an organization, you must be signed in to the master account and all features must be enabled in your organization. AWS Config calls EnableAwsServiceAccess API to enable integration between AWS Config and AWS Organizations. + */ + putConfigurationAggregator(callback?: (err: AWSError, data: ConfigService.Types.PutConfigurationAggregatorResponse) => void): Request; + /** + * Creates a new configuration recorder to record the selected resource configurations. You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. Currently, you can specify only one configuration recorder per region in your account. If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types. + */ + putConfigurationRecorder(params: ConfigService.Types.PutConfigurationRecorderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new configuration recorder to record the selected resource configurations. You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. Currently, you can specify only one configuration recorder per region in your account. If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types. + */ + putConfigurationRecorder(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. You can have only one delivery channel per region in your account. + */ + putDeliveryChannel(params: ConfigService.Types.PutDeliveryChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. You can have only one delivery channel per region in your account. + */ + putDeliveryChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. + */ + putEvaluations(params: ConfigService.Types.PutEvaluationsRequest, callback?: (err: AWSError, data: ConfigService.Types.PutEvaluationsResponse) => void): Request; + /** + * Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. + */ + putEvaluations(callback?: (err: AWSError, data: ConfigService.Types.PutEvaluationsResponse) => void): Request; + /** + * Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. + */ + putRemediationConfigurations(params: ConfigService.Types.PutRemediationConfigurationsRequest, callback?: (err: AWSError, data: ConfigService.Types.PutRemediationConfigurationsResponse) => void): Request; + /** + * Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. + */ + putRemediationConfigurations(callback?: (err: AWSError, data: ConfigService.Types.PutRemediationConfigurationsResponse) => void): Request; + /** + * Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object. Currently, AWS Config supports only one retention configuration per region in your account. + */ + putRetentionConfiguration(params: ConfigService.Types.PutRetentionConfigurationRequest, callback?: (err: AWSError, data: ConfigService.Types.PutRetentionConfigurationResponse) => void): Request; + /** + * Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object. Currently, AWS Config supports only one retention configuration per region in your account. + */ + putRetentionConfiguration(callback?: (err: AWSError, data: ConfigService.Types.PutRetentionConfigurationResponse) => void): Request; + /** + * Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the AWS Config Developer Guide. + */ + selectResourceConfig(params: ConfigService.Types.SelectResourceConfigRequest, callback?: (err: AWSError, data: ConfigService.Types.SelectResourceConfigResponse) => void): Request; + /** + * Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the AWS Config Developer Guide. + */ + selectResourceConfig(callback?: (err: AWSError, data: ConfigService.Types.SelectResourceConfigResponse) => void): Request; + /** + * Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources. You can specify up to 25 AWS Config rules per request. An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts. You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically. The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example: You have a custom rule that evaluates your IAM resources every 24 hours. You update your Lambda function to add additional conditions to your rule. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API. AWS Config invokes your Lambda function and evaluates your IAM resources. Your custom rule will still run periodic evaluations every 24 hours. + */ + startConfigRulesEvaluation(params: ConfigService.Types.StartConfigRulesEvaluationRequest, callback?: (err: AWSError, data: ConfigService.Types.StartConfigRulesEvaluationResponse) => void): Request; + /** + * Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources. You can specify up to 25 AWS Config rules per request. An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts. You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically. The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example: You have a custom rule that evaluates your IAM resources every 24 hours. You update your Lambda function to add additional conditions to your rule. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API. AWS Config invokes your Lambda function and evaluates your IAM resources. Your custom rule will still run periodic evaluations every 24 hours. + */ + startConfigRulesEvaluation(callback?: (err: AWSError, data: ConfigService.Types.StartConfigRulesEvaluationResponse) => void): Request; + /** + * Starts recording configurations of the AWS resources you have selected to record in your AWS account. You must have created at least one delivery channel to successfully start the configuration recorder. + */ + startConfigurationRecorder(params: ConfigService.Types.StartConfigurationRecorderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts recording configurations of the AWS resources you have selected to record in your AWS account. You must have created at least one delivery channel to successfully start the configuration recorder. + */ + startConfigurationRecorder(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous. You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again. + */ + startRemediationExecution(params: ConfigService.Types.StartRemediationExecutionRequest, callback?: (err: AWSError, data: ConfigService.Types.StartRemediationExecutionResponse) => void): Request; + /** + * Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous. You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again. + */ + startRemediationExecution(callback?: (err: AWSError, data: ConfigService.Types.StartRemediationExecutionResponse) => void): Request; + /** + * Stops recording configurations of the AWS resources you have selected to record in your AWS account. + */ + stopConfigurationRecorder(params: ConfigService.Types.StopConfigurationRecorderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops recording configurations of the AWS resources you have selected to record in your AWS account. + */ + stopConfigurationRecorder(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. + */ + tagResource(params: ConfigService.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes specified tags from a resource. + */ + untagResource(params: ConfigService.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes specified tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace ConfigService { + export type ARN = string; + export interface AccountAggregationSource { + /** + * The 12-digit account ID of the account being aggregated. + */ + AccountIds: AccountAggregationSourceAccountList; + /** + * If true, aggregate existing AWS Config regions and future regions. + */ + AllAwsRegions?: Boolean; + /** + * The source regions being aggregated. + */ + AwsRegions?: AggregatorRegionList; + } + export type AccountAggregationSourceAccountList = AccountId[]; + export type AccountAggregationSourceList = AccountAggregationSource[]; + export type AccountId = string; + export interface AggregateComplianceByConfigRule { + /** + * The name of the AWS Config rule. + */ + ConfigRuleName?: ConfigRuleName; + /** + * Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance. + */ + Compliance?: Compliance; + /** + * The 12-digit account ID of the source account. + */ + AccountId?: AccountId; + /** + * The source region from where the data is aggregated. + */ + AwsRegion?: AwsRegion; + } + export type AggregateComplianceByConfigRuleList = AggregateComplianceByConfigRule[]; + export interface AggregateComplianceCount { + /** + * The 12-digit account ID or region based on the GroupByKey value. + */ + GroupName?: StringWithCharLimit256; + /** + * The number of compliant and noncompliant AWS Config rules. + */ + ComplianceSummary?: ComplianceSummary; + } + export type AggregateComplianceCountList = AggregateComplianceCount[]; + export interface AggregateEvaluationResult { + /** + * Uniquely identifies the evaluation result. + */ + EvaluationResultIdentifier?: EvaluationResultIdentifier; + /** + * The resource compliance status. For the AggregationEvaluationResult data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value. + */ + ComplianceType?: ComplianceType; + /** + * The time when AWS Config recorded the aggregate evaluation result. + */ + ResultRecordedTime?: _Date; + /** + * The time when the AWS Config rule evaluated the AWS resource. + */ + ConfigRuleInvokedTime?: _Date; + /** + * Supplementary information about how the agrregate evaluation determined the compliance. + */ + Annotation?: StringWithCharLimit256; + /** + * The 12-digit account ID of the source account. + */ + AccountId?: AccountId; + /** + * The source region from where the data is aggregated. + */ + AwsRegion?: AwsRegion; + } + export type AggregateEvaluationResultList = AggregateEvaluationResult[]; + export interface AggregateResourceIdentifier { + /** + * The 12-digit account ID of the source account. + */ + SourceAccountId: AccountId; + /** + * The source region where data is aggregated. + */ + SourceRegion: AwsRegion; + /** + * The ID of the AWS resource. + */ + ResourceId: ResourceId; + /** + * The type of the AWS resource. + */ + ResourceType: ResourceType; + /** + * The name of the AWS resource. + */ + ResourceName?: ResourceName; + } + export interface AggregatedSourceStatus { + /** + * The source account ID or an organization. + */ + SourceId?: String; + /** + * The source account or an organization. + */ + SourceType?: AggregatedSourceType; + /** + * The region authorized to collect aggregated data. + */ + AwsRegion?: AwsRegion; + /** + * Filters the last updated status type. Valid value FAILED indicates errors while moving data. Valid value SUCCEEDED indicates the data was successfully moved. Valid value OUTDATED indicates the data is not the most recent. + */ + LastUpdateStatus?: AggregatedSourceStatusType; + /** + * The time of the last update. + */ + LastUpdateTime?: _Date; + /** + * The error code that AWS Config returned when the source account aggregation last failed. + */ + LastErrorCode?: String; + /** + * The message indicating that the source account aggregation failed due to an error. + */ + LastErrorMessage?: String; + } + export type AggregatedSourceStatusList = AggregatedSourceStatus[]; + export type AggregatedSourceStatusType = "FAILED"|"SUCCEEDED"|"OUTDATED"|string; + export type AggregatedSourceStatusTypeList = AggregatedSourceStatusType[]; + export type AggregatedSourceType = "ACCOUNT"|"ORGANIZATION"|string; + export interface AggregationAuthorization { + /** + * The Amazon Resource Name (ARN) of the aggregation object. + */ + AggregationAuthorizationArn?: String; + /** + * The 12-digit account ID of the account authorized to aggregate data. + */ + AuthorizedAccountId?: AccountId; + /** + * The region authorized to collect aggregated data. + */ + AuthorizedAwsRegion?: AwsRegion; + /** + * The time stamp when the aggregation authorization was created. + */ + CreationTime?: _Date; + } + export type AggregationAuthorizationList = AggregationAuthorization[]; + export type AggregatorRegionList = String[]; + export type AllSupported = boolean; + export type AmazonResourceName = string; + export type AvailabilityZone = string; + export type AwsRegion = string; + export interface BaseConfigurationItem { + /** + * The version number of the resource configuration. + */ + version?: Version; + /** + * The 12-digit AWS account ID associated with the resource. + */ + accountId?: AccountId; + /** + * The time when the configuration recording was initiated. + */ + configurationItemCaptureTime?: ConfigurationItemCaptureTime; + /** + * The configuration item status. + */ + configurationItemStatus?: ConfigurationItemStatus; + /** + * An identifier that indicates the ordering of the configuration items of a resource. + */ + configurationStateId?: ConfigurationStateId; + /** + * The Amazon Resource Name (ARN) of the resource. + */ + arn?: ARN; + /** + * The type of AWS resource. + */ + resourceType?: ResourceType; + /** + * The ID of the resource (for example., sg-xxxxxx). + */ + resourceId?: ResourceId; + /** + * The custom name of the resource, if available. + */ + resourceName?: ResourceName; + /** + * The region where the resource resides. + */ + awsRegion?: AwsRegion; + /** + * The Availability Zone associated with the resource. + */ + availabilityZone?: AvailabilityZone; + /** + * The time stamp when the resource was created. + */ + resourceCreationTime?: ResourceCreationTime; + /** + * The description of the resource configuration. + */ + configuration?: Configuration; + /** + * Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the configuration parameter. + */ + supplementaryConfiguration?: SupplementaryConfiguration; + } + export type BaseConfigurationItems = BaseConfigurationItem[]; + export type BaseResourceId = string; + export interface BatchGetAggregateResourceConfigRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * A list of aggregate ResourceIdentifiers objects. + */ + ResourceIdentifiers: ResourceIdentifiersList; + } + export interface BatchGetAggregateResourceConfigResponse { + /** + * A list that contains the current configuration of one or more resources. + */ + BaseConfigurationItems?: BaseConfigurationItems; + /** + * A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed. + */ + UnprocessedResourceIdentifiers?: UnprocessedResourceIdentifierList; + } + export interface BatchGetResourceConfigRequest { + /** + * A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. + */ + resourceKeys: ResourceKeys; + } + export interface BatchGetResourceConfigResponse { + /** + * A list that contains the current configuration of one or more resources. + */ + baseConfigurationItems?: BaseConfigurationItems; + /** + * A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list. + */ + unprocessedResourceKeys?: ResourceKeys; + } + export type Boolean = boolean; + export type ChannelName = string; + export type ChronologicalOrder = "Reverse"|"Forward"|string; + export interface Compliance { + /** + * Indicates whether an AWS resource or AWS Config rule is compliant. A resource is compliant if it complies with all of the AWS Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules. A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply. AWS Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the AWS resource or AWS Config rule. For the Compliance data type, AWS Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. AWS Config does not support the NOT_APPLICABLE value for the Compliance data type. + */ + ComplianceType?: ComplianceType; + /** + * The number of AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a maximum number. + */ + ComplianceContributorCount?: ComplianceContributorCount; + } + export interface ComplianceByConfigRule { + /** + * The name of the AWS Config rule. + */ + ConfigRuleName?: StringWithCharLimit64; + /** + * Indicates whether the AWS Config rule is compliant. + */ + Compliance?: Compliance; + } + export type ComplianceByConfigRules = ComplianceByConfigRule[]; + export interface ComplianceByResource { + /** + * The type of the AWS resource that was evaluated. + */ + ResourceType?: StringWithCharLimit256; + /** + * The ID of the AWS resource that was evaluated. + */ + ResourceId?: BaseResourceId; + /** + * Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it. + */ + Compliance?: Compliance; + } + export type ComplianceByResources = ComplianceByResource[]; + export interface ComplianceContributorCount { + /** + * The number of AWS resources or AWS Config rules responsible for the current compliance of the item. + */ + CappedCount?: Integer; + /** + * Indicates whether the maximum count is reached. + */ + CapExceeded?: Boolean; + } + export type ComplianceResourceTypes = StringWithCharLimit256[]; + export type ComplianceSummariesByResourceType = ComplianceSummaryByResourceType[]; + export interface ComplianceSummary { + /** + * The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources. + */ + CompliantResourceCount?: ComplianceContributorCount; + /** + * The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources. + */ + NonCompliantResourceCount?: ComplianceContributorCount; + /** + * The time that AWS Config created the compliance summary. + */ + ComplianceSummaryTimestamp?: _Date; + } + export interface ComplianceSummaryByResourceType { + /** + * The type of AWS resource. + */ + ResourceType?: StringWithCharLimit256; + /** + * The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each. + */ + ComplianceSummary?: ComplianceSummary; + } + export type ComplianceType = "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA"|string; + export type ComplianceTypes = ComplianceType[]; + export interface ConfigExportDeliveryInfo { + /** + * Status of the last attempted delivery. + */ + lastStatus?: DeliveryStatus; + /** + * The error code from the last attempted delivery. + */ + lastErrorCode?: String; + /** + * The error message from the last attempted delivery. + */ + lastErrorMessage?: String; + /** + * The time of the last attempted delivery. + */ + lastAttemptTime?: _Date; + /** + * The time of the last successful delivery. + */ + lastSuccessfulTime?: _Date; + /** + * The time that the next delivery occurs. + */ + nextDeliveryTime?: _Date; + } + export interface ConfigRule { + /** + * The name that you assign to the AWS Config rule. The name is required if you are adding a new rule. + */ + ConfigRuleName?: StringWithCharLimit64; + /** + * The Amazon Resource Name (ARN) of the AWS Config rule. + */ + ConfigRuleArn?: String; + /** + * The ID of the AWS Config rule. + */ + ConfigRuleId?: String; + /** + * The description that you provide for the AWS Config rule. + */ + Description?: EmptiableStringWithCharLimit256; + /** + * Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes. + */ + Scope?: Scope; + /** + * Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources. + */ + Source: Source; + /** + * A string, in JSON format, that is passed to the AWS Config rule Lambda function. + */ + InputParameters?: StringWithCharLimit1024; + /** + * The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when: You are using an AWS managed rule that is triggered at a periodic frequency. Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. + */ + MaximumExecutionFrequency?: MaximumExecutionFrequency; + /** + * Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule. AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule. AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule. AWS Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available. + */ + ConfigRuleState?: ConfigRuleState; + /** + * Service principal name of the service that created the rule. The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule. + */ + CreatedBy?: StringWithCharLimit256; + } + export interface ConfigRuleComplianceFilters { + /** + * The name of the AWS Config rule. + */ + ConfigRuleName?: ConfigRuleName; + /** + * The rule compliance status. For the ConfigRuleComplianceFilters data type, AWS Config supports only COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values. + */ + ComplianceType?: ComplianceType; + /** + * The 12-digit account ID of the source account. + */ + AccountId?: AccountId; + /** + * The source region where the data is aggregated. + */ + AwsRegion?: AwsRegion; + } + export interface ConfigRuleComplianceSummaryFilters { + /** + * The 12-digit account ID of the source account. + */ + AccountId?: AccountId; + /** + * The source region where the data is aggregated. + */ + AwsRegion?: AwsRegion; + } + export type ConfigRuleComplianceSummaryGroupKey = "ACCOUNT_ID"|"AWS_REGION"|string; + export interface ConfigRuleEvaluationStatus { + /** + * The name of the AWS Config rule. + */ + ConfigRuleName?: StringWithCharLimit64; + /** + * The Amazon Resource Name (ARN) of the AWS Config rule. + */ + ConfigRuleArn?: String; + /** + * The ID of the AWS Config rule. + */ + ConfigRuleId?: String; + /** + * The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources. + */ + LastSuccessfulInvocationTime?: _Date; + /** + * The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources. + */ + LastFailedInvocationTime?: _Date; + /** + * The time that AWS Config last successfully evaluated your AWS resources against the rule. + */ + LastSuccessfulEvaluationTime?: _Date; + /** + * The time that AWS Config last failed to evaluate your AWS resources against the rule. + */ + LastFailedEvaluationTime?: _Date; + /** + * The time that you first activated the AWS Config rule. + */ + FirstActivatedTime?: _Date; + /** + * The error code that AWS Config returned when the rule last failed. + */ + LastErrorCode?: String; + /** + * The error message that AWS Config returned when the rule last failed. + */ + LastErrorMessage?: String; + /** + * Indicates whether AWS Config has evaluated your resources against the rule at least once. true - AWS Config has evaluated your AWS resources against the rule at least once. false - AWS Config has not once finished evaluating your AWS resources against the rule. + */ + FirstEvaluationStarted?: Boolean; + } + export type ConfigRuleEvaluationStatusList = ConfigRuleEvaluationStatus[]; + export type ConfigRuleName = string; + export type ConfigRuleNames = StringWithCharLimit64[]; + export type ConfigRuleState = "ACTIVE"|"DELETING"|"DELETING_RESULTS"|"EVALUATING"|string; + export type ConfigRules = ConfigRule[]; + export interface ConfigSnapshotDeliveryProperties { + /** + * The frequency with which AWS Config delivers configuration snapshots. + */ + deliveryFrequency?: MaximumExecutionFrequency; + } + export interface ConfigStreamDeliveryInfo { + /** + * Status of the last attempted delivery. Note Providing an SNS topic on a DeliveryChannel for AWS Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable. + */ + lastStatus?: DeliveryStatus; + /** + * The error code from the last attempted delivery. + */ + lastErrorCode?: String; + /** + * The error message from the last attempted delivery. + */ + lastErrorMessage?: String; + /** + * The time from the last status change. + */ + lastStatusChangeTime?: _Date; + } + export type Configuration = string; + export interface ConfigurationAggregator { + /** + * The name of the aggregator. + */ + ConfigurationAggregatorName?: ConfigurationAggregatorName; + /** + * The Amazon Resource Name (ARN) of the aggregator. + */ + ConfigurationAggregatorArn?: ConfigurationAggregatorArn; + /** + * Provides a list of source accounts and regions to be aggregated. + */ + AccountAggregationSources?: AccountAggregationSourceList; + /** + * Provides an organization and list of regions to be aggregated. + */ + OrganizationAggregationSource?: OrganizationAggregationSource; + /** + * The time stamp when the configuration aggregator was created. + */ + CreationTime?: _Date; + /** + * The time of the last update. + */ + LastUpdatedTime?: _Date; + } + export type ConfigurationAggregatorArn = string; + export type ConfigurationAggregatorList = ConfigurationAggregator[]; + export type ConfigurationAggregatorName = string; + export type ConfigurationAggregatorNameList = ConfigurationAggregatorName[]; + export interface ConfigurationItem { + /** + * The version number of the resource configuration. + */ + version?: Version; + /** + * The 12-digit AWS account ID associated with the resource. + */ + accountId?: AccountId; + /** + * The time when the configuration recording was initiated. + */ + configurationItemCaptureTime?: ConfigurationItemCaptureTime; + /** + * The configuration item status. + */ + configurationItemStatus?: ConfigurationItemStatus; + /** + * An identifier that indicates the ordering of the configuration items of a resource. + */ + configurationStateId?: ConfigurationStateId; + /** + * Unique MD5 hash that represents the configuration item's state. You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource. + */ + configurationItemMD5Hash?: ConfigurationItemMD5Hash; + /** + * accoun + */ + arn?: ARN; + /** + * The type of AWS resource. + */ + resourceType?: ResourceType; + /** + * The ID of the resource (for example, sg-xxxxxx). + */ + resourceId?: ResourceId; + /** + * The custom name of the resource, if available. + */ + resourceName?: ResourceName; + /** + * The region where the resource resides. + */ + awsRegion?: AwsRegion; + /** + * The Availability Zone associated with the resource. + */ + availabilityZone?: AvailabilityZone; + /** + * The time stamp when the resource was created. + */ + resourceCreationTime?: ResourceCreationTime; + /** + * A mapping of key value tags associated with the resource. + */ + tags?: Tags; + /** + * A list of CloudTrail event IDs. A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is AWS CloudTrail. An empty field indicates that the current configuration was not initiated by any event. + */ + relatedEvents?: RelatedEventList; + /** + * A list of related AWS resources. + */ + relationships?: RelationshipList; + /** + * The description of the resource configuration. + */ + configuration?: Configuration; + /** + * Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the configuration parameter. + */ + supplementaryConfiguration?: SupplementaryConfiguration; + } + export type ConfigurationItemCaptureTime = Date; + export type ConfigurationItemList = ConfigurationItem[]; + export type ConfigurationItemMD5Hash = string; + export type ConfigurationItemStatus = "OK"|"ResourceDiscovered"|"ResourceNotRecorded"|"ResourceDeleted"|"ResourceDeletedNotRecorded"|string; + export interface ConfigurationRecorder { + /** + * The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name. + */ + name?: RecorderName; + /** + * Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account. + */ + roleARN?: String; + /** + * Specifies the types of AWS resources for which AWS Config records configuration changes. + */ + recordingGroup?: RecordingGroup; + } + export type ConfigurationRecorderList = ConfigurationRecorder[]; + export type ConfigurationRecorderNameList = RecorderName[]; + export interface ConfigurationRecorderStatus { + /** + * The name of the configuration recorder. + */ + name?: String; + /** + * The time the recorder was last started. + */ + lastStartTime?: _Date; + /** + * The time the recorder was last stopped. + */ + lastStopTime?: _Date; + /** + * Specifies whether or not the recorder is currently recording. + */ + recording?: Boolean; + /** + * The last (previous) status of the recorder. + */ + lastStatus?: RecorderStatus; + /** + * The error code indicating that the recording failed. + */ + lastErrorCode?: String; + /** + * The message indicating that the recording failed due to an error. + */ + lastErrorMessage?: String; + /** + * The time when the status was last changed. + */ + lastStatusChangeTime?: _Date; + } + export type ConfigurationRecorderStatusList = ConfigurationRecorderStatus[]; + export type ConfigurationStateId = string; + export type _Date = Date; + export interface DeleteAggregationAuthorizationRequest { + /** + * The 12-digit account ID of the account authorized to aggregate data. + */ + AuthorizedAccountId: AccountId; + /** + * The region authorized to collect aggregated data. + */ + AuthorizedAwsRegion: AwsRegion; + } + export interface DeleteConfigRuleRequest { + /** + * The name of the AWS Config rule that you want to delete. + */ + ConfigRuleName: StringWithCharLimit64; + } + export interface DeleteConfigurationAggregatorRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + } + export interface DeleteConfigurationRecorderRequest { + /** + * The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action. + */ + ConfigurationRecorderName: RecorderName; + } + export interface DeleteDeliveryChannelRequest { + /** + * The name of the delivery channel to delete. + */ + DeliveryChannelName: ChannelName; + } + export interface DeleteEvaluationResultsRequest { + /** + * The name of the AWS Config rule for which you want to delete the evaluation results. + */ + ConfigRuleName: StringWithCharLimit64; + } + export interface DeleteEvaluationResultsResponse { + } + export interface DeletePendingAggregationRequestRequest { + /** + * The 12-digit account ID of the account requesting to aggregate data. + */ + RequesterAccountId: AccountId; + /** + * The region requesting to aggregate data. + */ + RequesterAwsRegion: AwsRegion; + } + export interface DeleteRemediationConfigurationRequest { + /** + * The name of the AWS Config rule for which you want to delete remediation configuration. + */ + ConfigRuleName: StringWithCharLimit64; + /** + * The type of a resource. + */ + ResourceType?: String; + } + export interface DeleteRemediationConfigurationResponse { + } + export interface DeleteRetentionConfigurationRequest { + /** + * The name of the retention configuration to delete. + */ + RetentionConfigurationName: RetentionConfigurationName; + } + export interface DeliverConfigSnapshotRequest { + /** + * The name of the delivery channel through which the snapshot is delivered. + */ + deliveryChannelName: ChannelName; + } + export interface DeliverConfigSnapshotResponse { + /** + * The ID of the snapshot that is being created. + */ + configSnapshotId?: String; + } + export interface DeliveryChannel { + /** + * The name of the delivery channel. By default, AWS Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name. + */ + name?: ChannelName; + /** + * The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket in the AWS Config Developer Guide. + */ + s3BucketName?: String; + /** + * The prefix for the specified Amazon S3 bucket. + */ + s3KeyPrefix?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic in the AWS Config Developer Guide. + */ + snsTopicARN?: String; + /** + * The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket. + */ + configSnapshotDeliveryProperties?: ConfigSnapshotDeliveryProperties; + } + export type DeliveryChannelList = DeliveryChannel[]; + export type DeliveryChannelNameList = ChannelName[]; + export interface DeliveryChannelStatus { + /** + * The name of the delivery channel. + */ + name?: String; + /** + * A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket. + */ + configSnapshotDeliveryInfo?: ConfigExportDeliveryInfo; + /** + * A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket. + */ + configHistoryDeliveryInfo?: ConfigExportDeliveryInfo; + /** + * A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic. + */ + configStreamDeliveryInfo?: ConfigStreamDeliveryInfo; + } + export type DeliveryChannelStatusList = DeliveryChannelStatus[]; + export type DeliveryStatus = "Success"|"Failure"|"Not_Applicable"|string; + export interface DescribeAggregateComplianceByConfigRulesRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * Filters the results by ConfigRuleComplianceFilters object. + */ + Filters?: ConfigRuleComplianceFilters; + /** + * The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. + */ + Limit?: GroupByAPILimit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface DescribeAggregateComplianceByConfigRulesResponse { + /** + * Returns a list of AggregateComplianceByConfigRule object. + */ + AggregateComplianceByConfigRules?: AggregateComplianceByConfigRuleList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface DescribeAggregationAuthorizationsRequest { + /** + * The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeAggregationAuthorizationsResponse { + /** + * Returns a list of authorizations granted to various aggregator accounts and regions. + */ + AggregationAuthorizations?: AggregationAuthorizationList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeComplianceByConfigRuleRequest { + /** + * Specify one or more AWS Config rule names to filter the results by rule. + */ + ConfigRuleNames?: ConfigRuleNames; + /** + * Filters the results by compliance. The allowed values are COMPLIANT and NON_COMPLIANT. + */ + ComplianceTypes?: ComplianceTypes; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeComplianceByConfigRuleResponse { + /** + * Indicates whether each of the specified AWS Config rules is compliant. + */ + ComplianceByConfigRules?: ComplianceByConfigRules; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeComplianceByResourceRequest { + /** + * The types of AWS resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an AWS account by specifying AWS::::Account. + */ + ResourceType?: StringWithCharLimit256; + /** + * The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType. + */ + ResourceId?: BaseResourceId; + /** + * Filters the results by compliance. The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA. + */ + ComplianceTypes?: ComplianceTypes; + /** + * The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface DescribeComplianceByResourceResponse { + /** + * Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it. + */ + ComplianceByResources?: ComplianceByResources; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface DescribeConfigRuleEvaluationStatusRequest { + /** + * The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use. + */ + ConfigRuleNames?: ConfigRuleNames; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + /** + * The number of rule evaluation results that you want returned. This parameter is required if the rule limit for your account is more than the default of 150 rules. For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide. + */ + Limit?: RuleLimit; + } + export interface DescribeConfigRuleEvaluationStatusResponse { + /** + * Status information about your AWS managed Config rules. + */ + ConfigRulesEvaluationStatus?: ConfigRuleEvaluationStatusList; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeConfigRulesRequest { + /** + * The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules. + */ + ConfigRuleNames?: ConfigRuleNames; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeConfigRulesResponse { + /** + * The details about your AWS Config rules. + */ + ConfigRules?: ConfigRules; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeConfigurationAggregatorSourcesStatusRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * Filters the status type. Valid value FAILED indicates errors while moving data. Valid value SUCCEEDED indicates the data was successfully moved. Valid value OUTDATED indicates the data is not the most recent. + */ + UpdateStatus?: AggregatedSourceStatusTypeList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + /** + * The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + } + export interface DescribeConfigurationAggregatorSourcesStatusResponse { + /** + * Returns an AggregatedSourceStatus object. + */ + AggregatedSourceStatusList?: AggregatedSourceStatusList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeConfigurationAggregatorsRequest { + /** + * The name of the configuration aggregators. + */ + ConfigurationAggregatorNames?: ConfigurationAggregatorNameList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + /** + * The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + } + export interface DescribeConfigurationAggregatorsResponse { + /** + * Returns a ConfigurationAggregators object. + */ + ConfigurationAggregators?: ConfigurationAggregatorList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeConfigurationRecorderStatusRequest { + /** + * The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account. + */ + ConfigurationRecorderNames?: ConfigurationRecorderNameList; + } + export interface DescribeConfigurationRecorderStatusResponse { + /** + * A list that contains status of the specified recorders. + */ + ConfigurationRecordersStatus?: ConfigurationRecorderStatusList; + } + export interface DescribeConfigurationRecordersRequest { + /** + * A list of configuration recorder names. + */ + ConfigurationRecorderNames?: ConfigurationRecorderNameList; + } + export interface DescribeConfigurationRecordersResponse { + /** + * A list that contains the descriptions of the specified configuration recorders. + */ + ConfigurationRecorders?: ConfigurationRecorderList; + } + export interface DescribeDeliveryChannelStatusRequest { + /** + * A list of delivery channel names. + */ + DeliveryChannelNames?: DeliveryChannelNameList; + } + export interface DescribeDeliveryChannelStatusResponse { + /** + * A list that contains the status of a specified delivery channel. + */ + DeliveryChannelsStatus?: DeliveryChannelStatusList; + } + export interface DescribeDeliveryChannelsRequest { + /** + * A list of delivery channel names. + */ + DeliveryChannelNames?: DeliveryChannelNameList; + } + export interface DescribeDeliveryChannelsResponse { + /** + * A list that contains the descriptions of the specified delivery channel. + */ + DeliveryChannels?: DeliveryChannelList; + } + export type DescribePendingAggregationRequestsLimit = number; + export interface DescribePendingAggregationRequestsRequest { + /** + * The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. + */ + Limit?: DescribePendingAggregationRequestsLimit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribePendingAggregationRequestsResponse { + /** + * Returns a PendingAggregationRequests object. + */ + PendingAggregationRequests?: PendingAggregationRequestList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface DescribeRemediationConfigurationsRequest { + /** + * A list of AWS Config rule names of remediation configurations for which you want details. + */ + ConfigRuleNames: ConfigRuleNames; + } + export interface DescribeRemediationConfigurationsResponse { + /** + * Returns a remediation configuration object. + */ + RemediationConfigurations?: RemediationConfigurations; + } + export interface DescribeRemediationExecutionStatusRequest { + /** + * A list of AWS Config rule names. + */ + ConfigRuleName: StringWithCharLimit64; + /** + * A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. + */ + ResourceKeys?: ResourceKeys; + /** + * The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: StringWithCharLimit256; + } + export interface DescribeRemediationExecutionStatusResponse { + /** + * Returns a list of remediation execution statuses objects. + */ + RemediationExecutionStatuses?: RemediationExecutionStatuses; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: StringWithCharLimit256; + } + export interface DescribeRetentionConfigurationsRequest { + /** + * A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config returns details for all the retention configurations for that account. Currently, AWS Config supports only one retention configuration per region in your account. + */ + RetentionConfigurationNames?: RetentionConfigurationNameList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface DescribeRetentionConfigurationsResponse { + /** + * Returns a retention configuration object. + */ + RetentionConfigurations?: RetentionConfigurationList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export type DiscoveredResourceIdentifierList = AggregateResourceIdentifier[]; + export type EarlierTime = Date; + export type EmptiableStringWithCharLimit256 = string; + export interface Evaluation { + /** + * The type of AWS resource that was evaluated. + */ + ComplianceResourceType: StringWithCharLimit256; + /** + * The ID of the AWS resource that was evaluated. + */ + ComplianceResourceId: BaseResourceId; + /** + * Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against. For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type. Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom AWS Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config. + */ + ComplianceType: ComplianceType; + /** + * Supplementary information about how the evaluation determined the compliance. + */ + Annotation?: StringWithCharLimit256; + /** + * The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours). + */ + OrderingTimestamp: OrderingTimestamp; + } + export interface EvaluationResult { + /** + * Uniquely identifies the evaluation result. + */ + EvaluationResultIdentifier?: EvaluationResultIdentifier; + /** + * Indicates whether the AWS resource complies with the AWS Config rule that evaluated it. For the EvaluationResult data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type. + */ + ComplianceType?: ComplianceType; + /** + * The time when AWS Config recorded the evaluation result. + */ + ResultRecordedTime?: _Date; + /** + * The time when the AWS Config rule evaluated the AWS resource. + */ + ConfigRuleInvokedTime?: _Date; + /** + * Supplementary information about how the evaluation determined the compliance. + */ + Annotation?: StringWithCharLimit256; + /** + * An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation. + */ + ResultToken?: String; + } + export interface EvaluationResultIdentifier { + /** + * Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated resource. + */ + EvaluationResultQualifier?: EvaluationResultQualifier; + /** + * The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation. + */ + OrderingTimestamp?: _Date; + } + export interface EvaluationResultQualifier { + /** + * The name of the AWS Config rule that was used in the evaluation. + */ + ConfigRuleName?: StringWithCharLimit64; + /** + * The type of AWS resource that was evaluated. + */ + ResourceType?: StringWithCharLimit256; + /** + * The ID of the evaluated AWS resource. + */ + ResourceId?: BaseResourceId; + } + export type EvaluationResults = EvaluationResult[]; + export type Evaluations = Evaluation[]; + export type EventSource = "aws.config"|string; + export type Expression = string; + export interface FailedRemediationBatch { + /** + * Returns a failure message. For example, the resource is already compliant. + */ + FailureMessage?: String; + /** + * Returns remediation configurations of the failed items. + */ + FailedItems?: RemediationConfigurations; + } + export type FailedRemediationBatches = FailedRemediationBatch[]; + export interface FieldInfo { + /** + * Name of the field. + */ + Name?: FieldName; + } + export type FieldInfoList = FieldInfo[]; + export type FieldName = string; + export interface GetAggregateComplianceDetailsByConfigRuleRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * The name of the AWS Config rule for which you want compliance information. + */ + ConfigRuleName: ConfigRuleName; + /** + * The 12-digit account ID of the source account. + */ + AccountId: AccountId; + /** + * The source region from where the data is aggregated. + */ + AwsRegion: AwsRegion; + /** + * The resource compliance status. For the GetAggregateComplianceDetailsByConfigRuleRequest data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values. + */ + ComplianceType?: ComplianceType; + /** + * The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetAggregateComplianceDetailsByConfigRuleResponse { + /** + * Returns an AggregateEvaluationResults object. + */ + AggregateEvaluationResults?: AggregateEvaluationResultList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetAggregateConfigRuleComplianceSummaryRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * Filters the results based on the ConfigRuleComplianceSummaryFilters object. + */ + Filters?: ConfigRuleComplianceSummaryFilters; + /** + * Groups the result based on ACCOUNT_ID or AWS_REGION. + */ + GroupByKey?: ConfigRuleComplianceSummaryGroupKey; + /** + * The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default. + */ + Limit?: GroupByAPILimit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetAggregateConfigRuleComplianceSummaryResponse { + /** + * Groups the result based on ACCOUNT_ID or AWS_REGION. + */ + GroupByKey?: StringWithCharLimit256; + /** + * Returns a list of AggregateComplianceCounts object. + */ + AggregateComplianceCounts?: AggregateComplianceCountList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetAggregateDiscoveredResourceCountsRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * Filters the results based on the ResourceCountFilters object. + */ + Filters?: ResourceCountFilters; + /** + * The key to group the resource counts. + */ + GroupByKey?: ResourceCountGroupKey; + /** + * The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default. + */ + Limit?: GroupByAPILimit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetAggregateDiscoveredResourceCountsResponse { + /** + * The total number of resources that are present in an aggregator with the filters that you provide. + */ + TotalDiscoveredResources: Long; + /** + * The key passed into the request object. If GroupByKey is not provided, the result will be empty. + */ + GroupByKey?: StringWithCharLimit256; + /** + * Returns a list of GroupedResourceCount objects. + */ + GroupedResourceCounts?: GroupedResourceCountList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetAggregateResourceConfigRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * An object that identifies aggregate resource. + */ + ResourceIdentifier: AggregateResourceIdentifier; + } + export interface GetAggregateResourceConfigResponse { + /** + * Returns a ConfigurationItem object. + */ + ConfigurationItem?: ConfigurationItem; + } + export interface GetComplianceDetailsByConfigRuleRequest { + /** + * The name of the AWS Config rule for which you want compliance information. + */ + ConfigRuleName: StringWithCharLimit64; + /** + * Filters the results by compliance. The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE. + */ + ComplianceTypes?: ComplianceTypes; + /** + * The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetComplianceDetailsByConfigRuleResponse { + /** + * Indicates whether the AWS resource complies with the specified AWS Config rule. + */ + EvaluationResults?: EvaluationResults; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface GetComplianceDetailsByResourceRequest { + /** + * The type of the AWS resource for which you want compliance information. + */ + ResourceType: StringWithCharLimit256; + /** + * The ID of the AWS resource for which you want compliance information. + */ + ResourceId: BaseResourceId; + /** + * Filters the results by compliance. The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE. + */ + ComplianceTypes?: ComplianceTypes; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface GetComplianceDetailsByResourceResponse { + /** + * Indicates whether the specified AWS resource complies each AWS Config rule. + */ + EvaluationResults?: EvaluationResults; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: String; + } + export interface GetComplianceSummaryByConfigRuleResponse { + /** + * The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each. + */ + ComplianceSummary?: ComplianceSummary; + } + export interface GetComplianceSummaryByResourceTypeRequest { + /** + * Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type. For this request, you can specify an AWS resource type such as AWS::EC2::Instance. You can specify that the resource type is an AWS account by specifying AWS::::Account. + */ + ResourceTypes?: ResourceTypes; + } + export interface GetComplianceSummaryByResourceTypeResponse { + /** + * The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100. + */ + ComplianceSummariesByResourceType?: ComplianceSummariesByResourceType; + } + export interface GetDiscoveredResourceCountsRequest { + /** + * The comma-separated list that specifies the resource types that you want AWS Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User"). If a value for resourceTypes is not specified, AWS Config returns all resource types that AWS Config is recording in the region for your account. If the configuration recorder is turned off, AWS Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects. + */ + resourceTypes?: ResourceTypes; + /** + * The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default. + */ + limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + nextToken?: NextToken; + } + export interface GetDiscoveredResourceCountsResponse { + /** + * The total number of resources that AWS Config is recording in the region for your account. If you specify resource types in the request, AWS Config returns only the total number of resources for those resource types. Example AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request. AWS Config returns 25 for totalDiscoveredResources. + */ + totalDiscoveredResources?: Long; + /** + * The list of ResourceCount objects. Each object is listed in descending order by the number of resources. + */ + resourceCounts?: ResourceCounts; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + nextToken?: NextToken; + } + export interface GetResourceConfigHistoryRequest { + /** + * The resource type. + */ + resourceType: ResourceType; + /** + * The ID of the resource (for example., sg-xxxxxx). + */ + resourceId: ResourceId; + /** + * The time stamp that indicates a later time. If not specified, current time is taken. + */ + laterTime?: LaterTime; + /** + * The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded. + */ + earlierTime?: EarlierTime; + /** + * The chronological order for configuration items listed. By default, the results are listed in reverse chronological order. + */ + chronologicalOrder?: ChronologicalOrder; + /** + * The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default. + */ + limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + nextToken?: NextToken; + } + export interface GetResourceConfigHistoryResponse { + /** + * A list that contains the configuration history of one or more resources. + */ + configurationItems?: ConfigurationItemList; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + nextToken?: NextToken; + } + export type GroupByAPILimit = number; + export interface GroupedResourceCount { + /** + * The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey. + */ + GroupName: StringWithCharLimit256; + /** + * The number of resources in the group. + */ + ResourceCount: Long; + } + export type GroupedResourceCountList = GroupedResourceCount[]; + export type IncludeGlobalResourceTypes = boolean; + export type Integer = number; + export type LaterTime = Date; + export type Limit = number; + export interface ListAggregateDiscoveredResourcesRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * The type of resources that you want AWS Config to list in the response. + */ + ResourceType: ResourceType; + /** + * Filters the results based on the ResourceFilters object. + */ + Filters?: ResourceFilters; + /** + * The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface ListAggregateDiscoveredResourcesResponse { + /** + * Returns a list of ResourceIdentifiers objects. + */ + ResourceIdentifiers?: DiscoveredResourceIdentifierList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface ListDiscoveredResourcesRequest { + /** + * The type of resources that you want AWS Config to list in the response. + */ + resourceType: ResourceType; + /** + * The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered. + */ + resourceIds?: ResourceIdList; + /** + * The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered. + */ + resourceName?: ResourceName; + /** + * The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default. + */ + limit?: Limit; + /** + * Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included. + */ + includeDeletedResources?: Boolean; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + nextToken?: NextToken; + } + export interface ListDiscoveredResourcesResponse { + /** + * The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name. + */ + resourceIdentifiers?: ResourceIdentifierList; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + nextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization. + */ + ResourceArn: AmazonResourceName; + /** + * The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default. + */ + Limit?: Limit; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceResponse { + /** + * The tags for the resource. + */ + Tags?: TagList; + /** + * The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export type Long = number; + export type MaximumExecutionFrequency = "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours"|string; + export type MessageType = "ConfigurationItemChangeNotification"|"ConfigurationSnapshotDeliveryCompleted"|"ScheduledNotification"|"OversizedConfigurationItemChangeNotification"|string; + export type Name = string; + export type NextToken = string; + export type OrderingTimestamp = Date; + export interface OrganizationAggregationSource { + /** + * ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account. + */ + RoleArn: String; + /** + * The source regions being aggregated. + */ + AwsRegions?: AggregatorRegionList; + /** + * If true, aggregate existing AWS Config regions and future regions. + */ + AllAwsRegions?: Boolean; + } + export type Owner = "CUSTOM_LAMBDA"|"AWS"|string; + export interface PendingAggregationRequest { + /** + * The 12-digit account ID of the account requesting to aggregate data. + */ + RequesterAccountId?: AccountId; + /** + * The region requesting to aggregate data. + */ + RequesterAwsRegion?: AwsRegion; + } + export type PendingAggregationRequestList = PendingAggregationRequest[]; + export interface PutAggregationAuthorizationRequest { + /** + * The 12-digit account ID of the account authorized to aggregate data. + */ + AuthorizedAccountId: AccountId; + /** + * The region authorized to collect aggregated data. + */ + AuthorizedAwsRegion: AwsRegion; + Tags?: TagsList; + } + export interface PutAggregationAuthorizationResponse { + /** + * Returns an AggregationAuthorization object. + */ + AggregationAuthorization?: AggregationAuthorization; + } + export interface PutConfigRuleRequest { + /** + * The rule that you want to add to your account. + */ + ConfigRule: ConfigRule; + Tags?: TagsList; + } + export interface PutConfigurationAggregatorRequest { + /** + * The name of the configuration aggregator. + */ + ConfigurationAggregatorName: ConfigurationAggregatorName; + /** + * A list of AccountAggregationSource object. + */ + AccountAggregationSources?: AccountAggregationSourceList; + /** + * An OrganizationAggregationSource object. + */ + OrganizationAggregationSource?: OrganizationAggregationSource; + Tags?: TagsList; + } + export interface PutConfigurationAggregatorResponse { + /** + * Returns a ConfigurationAggregator object. + */ + ConfigurationAggregator?: ConfigurationAggregator; + } + export interface PutConfigurationRecorderRequest { + /** + * The configuration recorder object that records each configuration change made to the resources. + */ + ConfigurationRecorder: ConfigurationRecorder; + } + export interface PutDeliveryChannelRequest { + /** + * The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic. + */ + DeliveryChannel: DeliveryChannel; + } + export interface PutEvaluationsRequest { + /** + * The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function. + */ + Evaluations?: Evaluations; + /** + * An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation. + */ + ResultToken: String; + /** + * Use this parameter to specify a test run for PutEvaluations. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config. When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null. + */ + TestMode?: Boolean; + } + export interface PutEvaluationsResponse { + /** + * Requests that failed because of a client or server error. + */ + FailedEvaluations?: Evaluations; + } + export interface PutRemediationConfigurationsRequest { + /** + * A list of remediation configuration objects. + */ + RemediationConfigurations: RemediationConfigurations; + } + export interface PutRemediationConfigurationsResponse { + /** + * Returns a list of failed remediation batch objects. + */ + FailedBatches?: FailedRemediationBatches; + } + export interface PutRetentionConfigurationRequest { + /** + * Number of days AWS Config stores your historical information. Currently, only applicable to the configuration item history. + */ + RetentionPeriodInDays: RetentionPeriodInDays; + } + export interface PutRetentionConfigurationResponse { + /** + * Returns a retention configuration object. + */ + RetentionConfiguration?: RetentionConfiguration; + } + export interface QueryInfo { + /** + * Returns a FieldInfo object. + */ + SelectFields?: FieldInfoList; + } + export type RecorderName = string; + export type RecorderStatus = "Pending"|"Success"|"Failure"|string; + export interface RecordingGroup { + /** + * Specifies whether AWS Config records configuration changes for every supported type of regional resource. If you set this option to true, when AWS Config adds support for a new type of regional resource, it starts recording resources of that type automatically. If you set this option to true, you cannot enumerate a list of resourceTypes. + */ + allSupported?: AllSupported; + /** + * Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records. Before you can set this option to true, you must set the allSupported option to true. If you set this option to true, when AWS Config adds support for a new type of global resource, it starts recording resources of that type automatically. The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources. + */ + includeGlobalResourceTypes?: IncludeGlobalResourceTypes; + /** + * A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail). Before you can set this option to true, you must set the allSupported option to false. If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group. For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types. + */ + resourceTypes?: ResourceTypeList; + } + export type ReevaluateConfigRuleNames = StringWithCharLimit64[]; + export type RelatedEvent = string; + export type RelatedEventList = RelatedEvent[]; + export interface Relationship { + /** + * The resource type of the related resource. + */ + resourceType?: ResourceType; + /** + * The ID of the related resource (for example, sg-xxxxxx). + */ + resourceId?: ResourceId; + /** + * The custom name of the related resource, if available. + */ + resourceName?: ResourceName; + /** + * The type of relationship with the related resource. + */ + relationshipName?: RelationshipName; + } + export type RelationshipList = Relationship[]; + export type RelationshipName = string; + export interface RemediationConfiguration { + /** + * The name of the AWS Config rule. + */ + ConfigRuleName: StringWithCharLimit64; + /** + * The type of the target. Target executes remediation. For example, SSM document. + */ + TargetType: RemediationTargetType; + /** + * Target ID is the name of the public document. + */ + TargetId: StringWithCharLimit256; + /** + * Version of the target. For example, version of the SSM document. + */ + TargetVersion?: String; + /** + * An object of the RemediationParameterValue. + */ + Parameters?: RemediationParameters; + /** + * The type of a resource. + */ + ResourceType?: String; + } + export type RemediationConfigurations = RemediationConfiguration[]; + export type RemediationExecutionState = "QUEUED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string; + export interface RemediationExecutionStatus { + ResourceKey?: ResourceKey; + /** + * ENUM of the values. + */ + State?: RemediationExecutionState; + /** + * Details of every step. + */ + StepDetails?: RemediationExecutionSteps; + /** + * Start time when the remediation was executed. + */ + InvocationTime?: _Date; + /** + * The time when the remediation execution was last updated. + */ + LastUpdatedTime?: _Date; + } + export type RemediationExecutionStatuses = RemediationExecutionStatus[]; + export interface RemediationExecutionStep { + /** + * The details of the step. + */ + Name?: String; + /** + * The valid status of the step. + */ + State?: RemediationExecutionStepState; + /** + * An error message if the step was interrupted during execution. + */ + ErrorMessage?: String; + /** + * The time when the step started. + */ + StartTime?: _Date; + /** + * The time when the step stopped. + */ + StopTime?: _Date; + } + export type RemediationExecutionStepState = "SUCCEEDED"|"PENDING"|"FAILED"|string; + export type RemediationExecutionSteps = RemediationExecutionStep[]; + export interface RemediationParameterValue { + /** + * The value is dynamic and changes at run-time. + */ + ResourceValue?: ResourceValue; + /** + * The value is static and does not change at run-time. + */ + StaticValue?: StaticValue; + } + export type RemediationParameters = {[key: string]: RemediationParameterValue}; + export type RemediationTargetType = "SSM_DOCUMENT"|string; + export interface ResourceCount { + /** + * The resource type (for example, "AWS::EC2::Instance"). + */ + resourceType?: ResourceType; + /** + * The number of resources. + */ + count?: Long; + } + export interface ResourceCountFilters { + /** + * The type of the AWS resource. + */ + ResourceType?: ResourceType; + /** + * The 12-digit ID of the account. + */ + AccountId?: AccountId; + /** + * The region where the account is located. + */ + Region?: AwsRegion; + } + export type ResourceCountGroupKey = "RESOURCE_TYPE"|"ACCOUNT_ID"|"AWS_REGION"|string; + export type ResourceCounts = ResourceCount[]; + export type ResourceCreationTime = Date; + export type ResourceDeletionTime = Date; + export interface ResourceFilters { + /** + * The 12-digit source account ID. + */ + AccountId?: AccountId; + /** + * The ID of the resource. + */ + ResourceId?: ResourceId; + /** + * The name of the resource. + */ + ResourceName?: ResourceName; + /** + * The source region. + */ + Region?: AwsRegion; + } + export type ResourceId = string; + export type ResourceIdList = ResourceId[]; + export interface ResourceIdentifier { + /** + * The type of resource. + */ + resourceType?: ResourceType; + /** + * The ID of the resource (for example, sg-xxxxxx). + */ + resourceId?: ResourceId; + /** + * The custom name of the resource (if available). + */ + resourceName?: ResourceName; + /** + * The time that the resource was deleted. + */ + resourceDeletionTime?: ResourceDeletionTime; + } + export type ResourceIdentifierList = ResourceIdentifier[]; + export type ResourceIdentifiersList = AggregateResourceIdentifier[]; + export interface ResourceKey { + /** + * The resource type. + */ + resourceType: ResourceType; + /** + * The ID of the resource (for example., sg-xxxxxx). + */ + resourceId: ResourceId; + } + export type ResourceKeys = ResourceKey[]; + export type ResourceName = string; + export type ResourceType = "AWS::EC2::CustomerGateway"|"AWS::EC2::EIP"|"AWS::EC2::Host"|"AWS::EC2::Instance"|"AWS::EC2::InternetGateway"|"AWS::EC2::NetworkAcl"|"AWS::EC2::NetworkInterface"|"AWS::EC2::RouteTable"|"AWS::EC2::SecurityGroup"|"AWS::EC2::Subnet"|"AWS::CloudTrail::Trail"|"AWS::EC2::Volume"|"AWS::EC2::VPC"|"AWS::EC2::VPNConnection"|"AWS::EC2::VPNGateway"|"AWS::IAM::Group"|"AWS::IAM::Policy"|"AWS::IAM::Role"|"AWS::IAM::User"|"AWS::ACM::Certificate"|"AWS::RDS::DBInstance"|"AWS::RDS::DBSubnetGroup"|"AWS::RDS::DBSecurityGroup"|"AWS::RDS::DBSnapshot"|"AWS::RDS::EventSubscription"|"AWS::ElasticLoadBalancingV2::LoadBalancer"|"AWS::S3::Bucket"|"AWS::SSM::ManagedInstanceInventory"|"AWS::Redshift::Cluster"|"AWS::Redshift::ClusterSnapshot"|"AWS::Redshift::ClusterParameterGroup"|"AWS::Redshift::ClusterSecurityGroup"|"AWS::Redshift::ClusterSubnetGroup"|"AWS::Redshift::EventSubscription"|"AWS::CloudWatch::Alarm"|"AWS::CloudFormation::Stack"|"AWS::DynamoDB::Table"|"AWS::AutoScaling::AutoScalingGroup"|"AWS::AutoScaling::LaunchConfiguration"|"AWS::AutoScaling::ScalingPolicy"|"AWS::AutoScaling::ScheduledAction"|"AWS::CodeBuild::Project"|"AWS::WAF::RateBasedRule"|"AWS::WAF::Rule"|"AWS::WAF::WebACL"|"AWS::WAFRegional::RateBasedRule"|"AWS::WAFRegional::Rule"|"AWS::WAFRegional::WebACL"|"AWS::CloudFront::Distribution"|"AWS::CloudFront::StreamingDistribution"|"AWS::WAF::RuleGroup"|"AWS::WAFRegional::RuleGroup"|"AWS::Lambda::Function"|"AWS::ElasticBeanstalk::Application"|"AWS::ElasticBeanstalk::ApplicationVersion"|"AWS::ElasticBeanstalk::Environment"|"AWS::ElasticLoadBalancing::LoadBalancer"|"AWS::XRay::EncryptionConfig"|"AWS::SSM::AssociationCompliance"|"AWS::SSM::PatchCompliance"|"AWS::Shield::Protection"|"AWS::ShieldRegional::Protection"|"AWS::Config::ResourceCompliance"|"AWS::CodePipeline::Pipeline"|string; + export type ResourceTypeList = ResourceType[]; + export type ResourceTypes = StringWithCharLimit256[]; + export interface ResourceValue { + /** + * The value is a resource ID. + */ + Value?: ResourceValueType; + } + export type ResourceValueType = "RESOURCE_ID"|string; + export type Results = String[]; + export interface RetentionConfiguration { + /** + * The name of the retention configuration object. + */ + Name: RetentionConfigurationName; + /** + * Number of days AWS Config stores your historical information. Currently, only applicable to the configuration item history. + */ + RetentionPeriodInDays: RetentionPeriodInDays; + } + export type RetentionConfigurationList = RetentionConfiguration[]; + export type RetentionConfigurationName = string; + export type RetentionConfigurationNameList = RetentionConfigurationName[]; + export type RetentionPeriodInDays = number; + export type RuleLimit = number; + export interface Scope { + /** + * The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId. + */ + ComplianceResourceTypes?: ComplianceResourceTypes; + /** + * The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule. + */ + TagKey?: StringWithCharLimit128; + /** + * The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey. + */ + TagValue?: StringWithCharLimit256; + /** + * The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes. + */ + ComplianceResourceId?: BaseResourceId; + } + export interface SelectResourceConfigRequest { + /** + * The SQL query SELECT command. + */ + Expression: Expression; + /** + * The maximum number of query results returned on each page. + */ + Limit?: Limit; + /** + * The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface SelectResourceConfigResponse { + /** + * Returns the results for the SQL query. + */ + Results?: Results; + /** + * Returns the QueryInfo object. + */ + QueryInfo?: QueryInfo; + /** + * The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. + */ + NextToken?: NextToken; + } + export interface Source { + /** + * Indicates whether AWS or the customer owns and manages the AWS Config rule. + */ + Owner: Owner; + /** + * For AWS Config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Managed Config Rules. For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name. + */ + SourceIdentifier: StringWithCharLimit256; + /** + * Provides the source and type of the event that causes AWS Config to evaluate your AWS resources. + */ + SourceDetails?: SourceDetails; + } + export interface SourceDetail { + /** + * The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources. + */ + EventSource?: EventSource; + /** + * The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types: ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change. OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency. ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot. If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification. + */ + MessageType?: MessageType; + /** + * The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value. By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you choose Three_Hours, AWS Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule. + */ + MaximumExecutionFrequency?: MaximumExecutionFrequency; + } + export type SourceDetails = SourceDetail[]; + export interface StartConfigRulesEvaluationRequest { + /** + * The list of names of AWS Config rules that you want to run evaluations for. + */ + ConfigRuleNames?: ReevaluateConfigRuleNames; + } + export interface StartConfigRulesEvaluationResponse { + } + export interface StartConfigurationRecorderRequest { + /** + * The name of the recorder object that records each configuration change made to the resources. + */ + ConfigurationRecorderName: RecorderName; + } + export interface StartRemediationExecutionRequest { + /** + * The list of names of AWS Config rules that you want to run remediation execution for. + */ + ConfigRuleName: StringWithCharLimit64; + /** + * A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. + */ + ResourceKeys: ResourceKeys; + } + export interface StartRemediationExecutionResponse { + /** + * Returns a failure message. For example, the resource is already compliant. + */ + FailureMessage?: String; + /** + * For resources that have failed to start execution, the API returns a resource key object. + */ + FailedItems?: ResourceKeys; + } + export type StaticParameterValues = StringWithCharLimit256[]; + export interface StaticValue { + /** + * A list of values. For example, the ARN of the assumed role. + */ + Values?: StaticParameterValues; + } + export interface StopConfigurationRecorderRequest { + /** + * The name of the recorder object that records each configuration change made to the resources. + */ + ConfigurationRecorderName: RecorderName; + } + export type String = string; + export type StringWithCharLimit1024 = string; + export type StringWithCharLimit128 = string; + export type StringWithCharLimit256 = string; + export type StringWithCharLimit64 = string; + export type SupplementaryConfiguration = {[key: string]: SupplementaryConfigurationValue}; + export type SupplementaryConfigurationName = string; + export type SupplementaryConfigurationValue = string; + export interface Tag { + /** + * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. + */ + Key?: TagKey; + /** + * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization. + */ + ResourceArn: AmazonResourceName; + /** + * An array of tag object. + */ + Tags: TagList; + } + export type TagValue = string; + export type Tags = {[key: string]: Value}; + export type TagsList = Tag[]; + export type UnprocessedResourceIdentifierList = AggregateResourceIdentifier[]; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization. + */ + ResourceArn: AmazonResourceName; + /** + * The keys of the tags to be removed. + */ + TagKeys: TagKeyList; + } + export type Value = string; + export type Version = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-11-12"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ConfigService client. + */ + export import Types = ConfigService; +} +export = ConfigService; diff --git a/node_modules/aws-sdk/clients/configservice.js b/node_modules/aws-sdk/clients/configservice.js new file mode 100644 index 0000000..108b238 --- /dev/null +++ b/node_modules/aws-sdk/clients/configservice.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['configservice'] = {}; +AWS.ConfigService = Service.defineService('configservice', ['2014-11-12']); +Object.defineProperty(apiLoader.services['configservice'], '2014-11-12', { + get: function get() { + var model = require('../apis/config-2014-11-12.min.json'); + model.paginators = require('../apis/config-2014-11-12.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ConfigService; diff --git a/node_modules/aws-sdk/clients/connect.d.ts b/node_modules/aws-sdk/clients/connect.d.ts new file mode 100644 index 0000000..6bb42c9 --- /dev/null +++ b/node_modules/aws-sdk/clients/connect.d.ts @@ -0,0 +1,1032 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Connect extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Connect.Types.ClientConfiguration) + config: Config & Connect.Types.ClientConfiguration; + /** + * Creates a new user account in your Amazon Connect instance. + */ + createUser(params: Connect.Types.CreateUserRequest, callback?: (err: AWSError, data: Connect.Types.CreateUserResponse) => void): Request; + /** + * Creates a new user account in your Amazon Connect instance. + */ + createUser(callback?: (err: AWSError, data: Connect.Types.CreateUserResponse) => void): Request; + /** + * Deletes a user account from Amazon Connect. + */ + deleteUser(params: Connect.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a user account from Amazon Connect. + */ + deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns a User object that contains information about the user account specified by the UserId. + */ + describeUser(params: Connect.Types.DescribeUserRequest, callback?: (err: AWSError, data: Connect.Types.DescribeUserResponse) => void): Request; + /** + * Returns a User object that contains information about the user account specified by the UserId. + */ + describeUser(callback?: (err: AWSError, data: Connect.Types.DescribeUserResponse) => void): Request; + /** + * Returns a HierarchyGroup object that includes information about a hierarchy group in your instance. + */ + describeUserHierarchyGroup(params: Connect.Types.DescribeUserHierarchyGroupRequest, callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyGroupResponse) => void): Request; + /** + * Returns a HierarchyGroup object that includes information about a hierarchy group in your instance. + */ + describeUserHierarchyGroup(callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyGroupResponse) => void): Request; + /** + * Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy. + */ + describeUserHierarchyStructure(params: Connect.Types.DescribeUserHierarchyStructureRequest, callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyStructureResponse) => void): Request; + /** + * Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy. + */ + describeUserHierarchyStructure(callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyStructureResponse) => void): Request; + /** + * Retrieves the contact attributes associated with a contact. + */ + getContactAttributes(params: Connect.Types.GetContactAttributesRequest, callback?: (err: AWSError, data: Connect.Types.GetContactAttributesResponse) => void): Request; + /** + * Retrieves the contact attributes associated with a contact. + */ + getContactAttributes(callback?: (err: AWSError, data: Connect.Types.GetContactAttributesResponse) => void): Request; + /** + * The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action. + */ + getCurrentMetricData(params: Connect.Types.GetCurrentMetricDataRequest, callback?: (err: AWSError, data: Connect.Types.GetCurrentMetricDataResponse) => void): Request; + /** + * The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance. If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action. + */ + getCurrentMetricData(callback?: (err: AWSError, data: Connect.Types.GetCurrentMetricDataResponse) => void): Request; + /** + * Retrieves a token for federation. + */ + getFederationToken(params: Connect.Types.GetFederationTokenRequest, callback?: (err: AWSError, data: Connect.Types.GetFederationTokenResponse) => void): Request; + /** + * Retrieves a token for federation. + */ + getFederationToken(callback?: (err: AWSError, data: Connect.Types.GetFederationTokenResponse) => void): Request; + /** + * The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. If you are using an IAM account, it must have permission to the connect:GetMetricData action. + */ + getMetricData(params: Connect.Types.GetMetricDataRequest, callback?: (err: AWSError, data: Connect.Types.GetMetricDataResponse) => void): Request; + /** + * The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. If you are using an IAM account, it must have permission to the connect:GetMetricData action. + */ + getMetricData(callback?: (err: AWSError, data: Connect.Types.GetMetricDataResponse) => void): Request; + /** + * Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance. + */ + listRoutingProfiles(params: Connect.Types.ListRoutingProfilesRequest, callback?: (err: AWSError, data: Connect.Types.ListRoutingProfilesResponse) => void): Request; + /** + * Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance. + */ + listRoutingProfiles(callback?: (err: AWSError, data: Connect.Types.ListRoutingProfilesResponse) => void): Request; + /** + * Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile. + */ + listSecurityProfiles(params: Connect.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilesResponse) => void): Request; + /** + * Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile. + */ + listSecurityProfiles(callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilesResponse) => void): Request; + /** + * Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance. + */ + listUserHierarchyGroups(params: Connect.Types.ListUserHierarchyGroupsRequest, callback?: (err: AWSError, data: Connect.Types.ListUserHierarchyGroupsResponse) => void): Request; + /** + * Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance. + */ + listUserHierarchyGroups(callback?: (err: AWSError, data: Connect.Types.ListUserHierarchyGroupsResponse) => void): Request; + /** + * Returns a UserSummaryList, which is an array of UserSummary objects. + */ + listUsers(params: Connect.Types.ListUsersRequest, callback?: (err: AWSError, data: Connect.Types.ListUsersResponse) => void): Request; + /** + * Returns a UserSummaryList, which is an array of UserSummary objects. + */ + listUsers(callback?: (err: AWSError, data: Connect.Types.ListUsersResponse) => void): Request; + /** + * The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer. If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action. There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails. + */ + startOutboundVoiceContact(params: Connect.Types.StartOutboundVoiceContactRequest, callback?: (err: AWSError, data: Connect.Types.StartOutboundVoiceContactResponse) => void): Request; + /** + * The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer. If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action. There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails. + */ + startOutboundVoiceContact(callback?: (err: AWSError, data: Connect.Types.StartOutboundVoiceContactResponse) => void): Request; + /** + * Ends the contact initiated by the StartOutboundVoiceContact operation. If you are using an IAM account, it must have permission to the connect:StopContact action. + */ + stopContact(params: Connect.Types.StopContactRequest, callback?: (err: AWSError, data: Connect.Types.StopContactResponse) => void): Request; + /** + * Ends the contact initiated by the StartOutboundVoiceContact operation. If you are using an IAM account, it must have permission to the connect:StopContact action. + */ + stopContact(callback?: (err: AWSError, data: Connect.Types.StopContactResponse) => void): Request; + /** + * The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance. + */ + updateContactAttributes(params: Connect.Types.UpdateContactAttributesRequest, callback?: (err: AWSError, data: Connect.Types.UpdateContactAttributesResponse) => void): Request; + /** + * The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance. + */ + updateContactAttributes(callback?: (err: AWSError, data: Connect.Types.UpdateContactAttributesResponse) => void): Request; + /** + * Assigns the specified hierarchy group to the user. + */ + updateUserHierarchy(params: Connect.Types.UpdateUserHierarchyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns the specified hierarchy group to the user. + */ + updateUserHierarchy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name. + */ + updateUserIdentityInfo(params: Connect.Types.UpdateUserIdentityInfoRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name. + */ + updateUserIdentityInfo(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the phone configuration settings in the UserPhoneConfig object for the specified user. + */ + updateUserPhoneConfig(params: Connect.Types.UpdateUserPhoneConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the phone configuration settings in the UserPhoneConfig object for the specified user. + */ + updateUserPhoneConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns the specified routing profile to a user. + */ + updateUserRoutingProfile(params: Connect.Types.UpdateUserRoutingProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns the specified routing profile to a user. + */ + updateUserRoutingProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the security profiles assigned to the user. + */ + updateUserSecurityProfiles(params: Connect.Types.UpdateUserSecurityProfilesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the security profiles assigned to the user. + */ + updateUserSecurityProfiles(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace Connect { + export type ARN = string; + export type AfterContactWorkTimeLimit = number; + export type AgentFirstName = string; + export type AgentLastName = string; + export type AgentUsername = string; + export type AttributeName = string; + export type AttributeValue = string; + export type Attributes = {[key: string]: AttributeValue}; + export type AutoAccept = boolean; + export type Channel = "VOICE"|string; + export type Channels = Channel[]; + export type ClientToken = string; + export type Comparison = "LT"|string; + export type ContactFlowId = string; + export type ContactId = string; + export interface CreateUserRequest { + /** + * The user name in Amazon Connect for the account to create. If you are using SAML for identity management in your Amazon Connect, the value for Username can include up to 64 characters from [a-zA-Z0-9_-.\@]+. + */ + Username: AgentUsername; + /** + * The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned. + */ + Password?: Password; + /** + * Information about the user, including email address, first name, and last name. + */ + IdentityInfo?: UserIdentityInfo; + /** + * Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType. + */ + PhoneConfig: UserPhoneConfig; + /** + * The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned. + */ + DirectoryUserId?: DirectoryUserId; + /** + * The unique identifier of the security profile to assign to the user created. + */ + SecurityProfileIds: SecurityProfileIds; + /** + * The unique identifier for the routing profile to assign to the user created. + */ + RoutingProfileId: RoutingProfileId; + /** + * The unique identifier for the hierarchy group to assign to the user created. + */ + HierarchyGroupId?: HierarchyGroupId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface CreateUserResponse { + /** + * The unique identifier for the user account in Amazon Connect + */ + UserId?: UserId; + /** + * The Amazon Resource Name (ARN) of the user account created. + */ + UserArn?: ARN; + } + export interface Credentials { + /** + * An access token generated for a federated user to access Amazon Connect + */ + AccessToken?: SecurityToken; + /** + * A token generated with an expiration time for the session a user is logged in to Amazon Connect + */ + AccessTokenExpiration?: timestamp; + /** + * Renews a token generated for a user to access the Amazon Connect instance. + */ + RefreshToken?: SecurityToken; + /** + * Renews the expiration timer for a generated token. + */ + RefreshTokenExpiration?: timestamp; + } + export interface CurrentMetric { + /** + * The name of the metric. + */ + Name?: CurrentMetricName; + /** + * The unit for the metric. + */ + Unit?: Unit; + } + export interface CurrentMetricData { + /** + * The metric in a CurrentMetricData object. + */ + Metric?: CurrentMetric; + /** + * The value of the metric in the CurrentMetricData object. + */ + Value?: Value; + } + export type CurrentMetricDataCollections = CurrentMetricData[]; + export type CurrentMetricName = "AGENTS_ONLINE"|"AGENTS_AVAILABLE"|"AGENTS_ON_CALL"|"AGENTS_NON_PRODUCTIVE"|"AGENTS_AFTER_CONTACT_WORK"|"AGENTS_ERROR"|"AGENTS_STAFFED"|"CONTACTS_IN_QUEUE"|"OLDEST_CONTACT_AGE"|"CONTACTS_SCHEDULED"|string; + export interface CurrentMetricResult { + /** + * The Dimensions for the CurrentMetricResult object. + */ + Dimensions?: Dimensions; + /** + * The Collections for the CurrentMetricResult object. + */ + Collections?: CurrentMetricDataCollections; + } + export type CurrentMetricResults = CurrentMetricResult[]; + export type CurrentMetrics = CurrentMetric[]; + export interface DeleteUserRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * The unique identifier of the user to delete. + */ + UserId: UserId; + } + export interface DescribeUserHierarchyGroupRequest { + /** + * The identifier for the hierarchy group to return. + */ + HierarchyGroupId: HierarchyGroupId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface DescribeUserHierarchyGroupResponse { + /** + * Returns a HierarchyGroup object. + */ + HierarchyGroup?: HierarchyGroup; + } + export interface DescribeUserHierarchyStructureRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface DescribeUserHierarchyStructureResponse { + /** + * A HierarchyStructure object. + */ + HierarchyStructure?: HierarchyStructure; + } + export interface DescribeUserRequest { + /** + * Unique identifier for the user account to return. + */ + UserId: UserId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface DescribeUserResponse { + /** + * A User object that contains information about the user account and configuration settings. + */ + User?: User; + } + export interface Dimensions { + /** + * A QueueReference object used as one part of dimension for the metrics results. + */ + Queue?: QueueReference; + /** + * The channel used for grouping and filters. Only VOICE is supported. + */ + Channel?: Channel; + } + export type DirectoryUserId = string; + export type Email = string; + export interface Filters { + /** + * A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request. + */ + Queues?: Queues; + /** + * The Channel to use as a filter for the metrics returned. Only VOICE is supported. + */ + Channels?: Channels; + } + export interface GetContactAttributesRequest { + /** + * The instance ID for the instance from which to retrieve contact attributes. + */ + InstanceId: InstanceId; + /** + * The ID for the initial contact in Amazon Connect associated with the attributes to update. + */ + InitialContactId: ContactId; + } + export interface GetContactAttributesResponse { + /** + * The attributes to update. + */ + Attributes?: Attributes; + } + export interface GetCurrentMetricDataRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels. To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'. + */ + Filters: Filters; + /** + * The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE. If no Grouping is included in the request, a summary of CurrentMetrics is returned. + */ + Groupings?: Groupings; + /** + * A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data for in the request. The following metrics are available: AGENTS_AVAILABLE Unit: COUNT AGENTS_ONLINE Unit: COUNT AGENTS_ON_CALL Unit: COUNT AGENTS_STAFFED Unit: COUNT AGENTS_AFTER_CONTACT_WORK Unit: COUNT AGENTS_NON_PRODUCTIVE Unit: COUNT AGENTS_ERROR Unit: COUNT CONTACTS_IN_QUEUE Unit: COUNT OLDEST_CONTACT_AGE Unit: SECONDS CONTACTS_SCHEDULED Unit: COUNT + */ + CurrentMetrics: CurrentMetrics; + /** + * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token. + */ + NextToken?: NextToken; + /** + * MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100. + */ + MaxResults?: MaxResult100; + } + export interface GetCurrentMetricDataResponse { + /** + * A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results. The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token. + */ + NextToken?: NextToken; + /** + * A list of CurrentMetricResult objects organized by Dimensions combining with CurrentMetricDataCollections. Dimensions is the resourceId specified in the Filters of the request. Collections is a list of CurrentMetricData objects with corresponding values to the CurrentMetrics specified in the request. If no Grouping is specified in the request, Collections is a summary for the CurrentMetric returned. + */ + MetricResults?: CurrentMetricResults; + /** + * The time at which CurrentMetricData was retrieved and cached for pagination. + */ + DataSnapshotTime?: timestamp; + } + export interface GetFederationTokenRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface GetFederationTokenResponse { + /** + * The credentials to use for federation. + */ + Credentials?: Credentials; + } + export interface GetMetricDataRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15. StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours. + */ + StartTime: timestamp; + /** + * The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the StartTime timestamp. The time range between StartTime and EndTime must be less than 24 hours. + */ + EndTime: timestamp; + /** + * A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel. To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'. + */ + Filters: Filters; + /** + * The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues. The current version supports grouping by Queue If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned. + */ + Groupings?: Groupings; + /** + * A list of HistoricalMetric objects that contain the metrics to retrieve with the request. A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit. You must list each metric to retrieve data for in the request. For each historical metric you include in the request, you must include a Unit and a Statistic. The following historical metrics are available: CONTACTS_QUEUED Unit: COUNT Statistic: SUM CONTACTS_HANDLED Unit: COUNT Statistics: SUM CONTACTS_ABANDONED Unit: COUNT Statistics: SUM CONTACTS_CONSULTED Unit: COUNT Statistics: SUM CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistics: SUM CONTACTS_HANDLED_INCOMING Unit: COUNT Statistics: SUM CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistics: SUM CONTACTS_HOLD_ABANDONS Unit: COUNT Statistics: SUM CONTACTS_TRANSFERRED_IN Unit: COUNT Statistics: SUM CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistics: SUM CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistics: SUM CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistics: SUM CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistics: SUM CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistics: SUM API_CONTACTS_HANDLED Unit: COUNT Statistics: SUM CONTACTS_MISSED Unit: COUNT Statistics: SUM OCCUPANCY Unit: PERCENT Statistics: AVG HANDLE_TIME Unit: SECONDS Statistics: AVG AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistics: AVG QUEUED_TIME Unit: SECONDS Statistics: MAX ABANDON_TIME Unit: COUNT Statistics: SUM QUEUE_ANSWER_TIME Unit: SECONDS Statistics: AVG HOLD_TIME Unit: SECONDS Statistics: AVG INTERACTION_TIME Unit: SECONDS Statistics: AVG INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistics: AVG SERVICE_LEVEL Unit: PERCENT Statistics: AVG Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600 + */ + HistoricalMetrics: HistoricalMetrics; + /** + * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * Indicates the maximum number of results to return per page in the response, between 1-100. + */ + MaxResults?: MaxResult100; + } + export interface GetMetricDataResponse { + /** + * A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results. The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token. + */ + NextToken?: NextToken; + /** + * A list of HistoricalMetricResult objects, organized by Dimensions, which is the ID of the resource specified in the Filters used for the request. The metrics are combined with the metrics included in Collections, which is a list of HisotricalMetricData objects. If no Grouping is specified in the request, Collections includes summary data for the HistoricalMetrics. + */ + MetricResults?: HistoricalMetricResults; + } + export type Grouping = "QUEUE"|"CHANNEL"|string; + export type Groupings = Grouping[]; + export interface HierarchyGroup { + /** + * The identifier for the hierarchy group. + */ + Id?: HierarchyGroupId; + /** + * The Amazon Resource Name (ARN) for the hierarchy group. + */ + Arn?: ARN; + /** + * The name of the hierarchy group in your instance. + */ + Name?: HierarchyGroupName; + /** + * The identifier for the level in the hierarchy group. + */ + LevelId?: HierarchyLevelId; + /** + * A HierarchyPath object that contains information about the levels in the hierarchy group. + */ + HierarchyPath?: HierarchyPath; + } + export type HierarchyGroupId = string; + export type HierarchyGroupName = string; + export interface HierarchyGroupSummary { + /** + * The identifier of the hierarchy group. + */ + Id?: HierarchyGroupId; + /** + * The ARN for the hierarchy group. + */ + Arn?: ARN; + /** + * The name of the hierarchy group. + */ + Name?: HierarchyGroupName; + } + export type HierarchyGroupSummaryList = HierarchyGroupSummary[]; + export interface HierarchyLevel { + /** + * The identifier for the hierarchy group level. + */ + Id?: HierarchyLevelId; + /** + * The ARN for the hierarchy group level. + */ + Arn?: ARN; + /** + * The name of the hierarchy group level. + */ + Name?: HierarchyLevelName; + } + export type HierarchyLevelId = string; + export type HierarchyLevelName = string; + export interface HierarchyPath { + /** + * A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name. + */ + LevelOne?: HierarchyGroupSummary; + /** + * A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name. + */ + LevelTwo?: HierarchyGroupSummary; + /** + * A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name. + */ + LevelThree?: HierarchyGroupSummary; + /** + * A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name. + */ + LevelFour?: HierarchyGroupSummary; + /** + * A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name. + */ + LevelFive?: HierarchyGroupSummary; + } + export interface HierarchyStructure { + /** + * A HierarchyLevel object that contains information about the hierarchy group level. + */ + LevelOne?: HierarchyLevel; + /** + * A HierarchyLevel object that contains information about the hierarchy group level. + */ + LevelTwo?: HierarchyLevel; + /** + * A HierarchyLevel object that contains information about the hierarchy group level. + */ + LevelThree?: HierarchyLevel; + /** + * A HierarchyLevel object that contains information about the hierarchy group level. + */ + LevelFour?: HierarchyLevel; + /** + * A HierarchyLevel object that contains information about the hierarchy group level. + */ + LevelFive?: HierarchyLevel; + } + export interface HistoricalMetric { + /** + * The name of the historical metric. + */ + Name?: HistoricalMetricName; + /** + * The threshold for the metric, used with service level metrics. + */ + Threshold?: Threshold; + /** + * The statistic for the metric. + */ + Statistic?: Statistic; + /** + * The unit for the metric. + */ + Unit?: Unit; + } + export interface HistoricalMetricData { + /** + * A HistoricalMetric object. + */ + Metric?: HistoricalMetric; + /** + * The Value of the metric. + */ + Value?: Value; + } + export type HistoricalMetricDataCollections = HistoricalMetricData[]; + export type HistoricalMetricName = "CONTACTS_QUEUED"|"CONTACTS_HANDLED"|"CONTACTS_ABANDONED"|"CONTACTS_CONSULTED"|"CONTACTS_AGENT_HUNG_UP_FIRST"|"CONTACTS_HANDLED_INCOMING"|"CONTACTS_HANDLED_OUTBOUND"|"CONTACTS_HOLD_ABANDONS"|"CONTACTS_TRANSFERRED_IN"|"CONTACTS_TRANSFERRED_OUT"|"CONTACTS_TRANSFERRED_IN_FROM_QUEUE"|"CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"|"CONTACTS_MISSED"|"CALLBACK_CONTACTS_HANDLED"|"API_CONTACTS_HANDLED"|"OCCUPANCY"|"HANDLE_TIME"|"AFTER_CONTACT_WORK_TIME"|"QUEUED_TIME"|"ABANDON_TIME"|"QUEUE_ANSWER_TIME"|"HOLD_TIME"|"INTERACTION_TIME"|"INTERACTION_AND_HOLD_TIME"|"SERVICE_LEVEL"|string; + export interface HistoricalMetricResult { + /** + * The Dimensions for the metrics. + */ + Dimensions?: Dimensions; + /** + * A list of HistoricalMetricData objects. + */ + Collections?: HistoricalMetricDataCollections; + } + export type HistoricalMetricResults = HistoricalMetricResult[]; + export type HistoricalMetrics = HistoricalMetric[]; + export type InstanceId = string; + export interface ListRoutingProfilesRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of routing profiles to return in the response. + */ + MaxResults?: MaxResult1000; + } + export interface ListRoutingProfilesResponse { + /** + * An array of RoutingProfileSummary objects that include the ARN, Id, and Name of the routing profile. + */ + RoutingProfileSummaryList?: RoutingProfileSummaryList; + /** + * A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results. + */ + NextToken?: NextToken; + } + export interface ListSecurityProfilesRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of security profiles to return. + */ + MaxResults?: MaxResult1000; + } + export interface ListSecurityProfilesResponse { + /** + * An array of SecurityProfileSummary objects. + */ + SecurityProfileSummaryList?: SecurityProfileSummaryList; + /** + * A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results. + */ + NextToken?: NextToken; + } + export interface ListUserHierarchyGroupsRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of hierarchy groups to return. + */ + MaxResults?: MaxResult1000; + } + export interface ListUserHierarchyGroupsResponse { + /** + * An array of HierarchyGroupSummary objects. + */ + UserHierarchyGroupSummaryList?: HierarchyGroupSummaryList; + /** + * A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results. + */ + NextToken?: NextToken; + } + export interface ListUsersRequest { + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in the response. + */ + MaxResults?: MaxResult1000; + } + export interface ListUsersResponse { + /** + * An array of UserSummary objects that contain information about the users in your instance. + */ + UserSummaryList?: UserSummaryList; + /** + * A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results. + */ + NextToken?: NextToken; + } + export type MaxResult100 = number; + export type MaxResult1000 = number; + export type NextToken = string; + export type Password = string; + export type PhoneNumber = string; + export type PhoneType = "SOFT_PHONE"|"DESK_PHONE"|string; + export type QueueId = string; + export interface QueueReference { + /** + * The ID of the queue associated with the metrics returned. + */ + Id?: QueueId; + /** + * The Amazon Resource Name (ARN) of queue. + */ + Arn?: ARN; + } + export type Queues = QueueId[]; + export type RoutingProfileId = string; + export type RoutingProfileName = string; + export interface RoutingProfileSummary { + /** + * The identifier of the routing profile. + */ + Id?: RoutingProfileId; + /** + * The ARN of the routing profile. + */ + Arn?: ARN; + /** + * The name of the routing profile. + */ + Name?: RoutingProfileName; + } + export type RoutingProfileSummaryList = RoutingProfileSummary[]; + export type SecurityProfileId = string; + export type SecurityProfileIds = SecurityProfileId[]; + export type SecurityProfileName = string; + export interface SecurityProfileSummary { + /** + * The identifier of the security profile. + */ + Id?: SecurityProfileId; + /** + * The ARN of the security profile. + */ + Arn?: ARN; + /** + * The name of the security profile. + */ + Name?: SecurityProfileName; + } + export type SecurityProfileSummaryList = SecurityProfileSummary[]; + export type SecurityToken = string; + export interface StartOutboundVoiceContactRequest { + /** + * The phone number of the customer in E.164 format. + */ + DestinationPhoneNumber: PhoneNumber; + /** + * The identifier for the contact flow to connect the outbound call to. To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b. + */ + ContactFlowId: ContactFlowId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * 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. + */ + ClientToken?: ClientToken; + /** + * The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call. + */ + SourcePhoneNumber?: PhoneNumber; + /** + * The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow. To find the QueueId, open the queue you want 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 queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c. + */ + QueueId?: QueueId; + /** + * 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. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters. For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following: + */ + Attributes?: Attributes; + } + export interface StartOutboundVoiceContactResponse { + /** + * The unique identifier of this contact within your Amazon Connect instance. + */ + ContactId?: ContactId; + } + export type Statistic = "SUM"|"MAX"|"AVG"|string; + export interface StopContactRequest { + /** + * The unique identifier of the contact to end. + */ + ContactId: ContactId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface StopContactResponse { + } + export interface Threshold { + /** + * The Threshold to use to compare service level metrics to. Only "Less than" (LT) comparisons are supported. + */ + Comparison?: Comparison; + /** + * The value of the threshold to compare the metric to. Only "Less than" (LT) comparisons are supported. + */ + ThresholdValue?: ThresholdValue; + } + export type ThresholdValue = number; + export type Unit = "SECONDS"|"COUNT"|"PERCENT"|string; + export interface UpdateContactAttributesRequest { + /** + * The unique identifier of the contact for which to update attributes. This is the identifier for the contact associated with the first interaction with the contact center. + */ + InitialContactId: ContactId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + /** + * 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. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters. + */ + Attributes: Attributes; + } + export interface UpdateContactAttributesResponse { + } + export interface UpdateUserHierarchyRequest { + /** + * The identifier for the hierarchy group to assign to the user. + */ + HierarchyGroupId?: HierarchyGroupId; + /** + * The identifier of the user account to assign the hierarchy group to. + */ + UserId: UserId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface UpdateUserIdentityInfoRequest { + /** + * A UserIdentityInfo object. + */ + IdentityInfo: UserIdentityInfo; + /** + * The identifier for the user account to update identity information for. + */ + UserId: UserId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface UpdateUserPhoneConfigRequest { + /** + * A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user. + */ + PhoneConfig: UserPhoneConfig; + /** + * The identifier for the user account to change phone settings for. + */ + UserId: UserId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface UpdateUserRoutingProfileRequest { + /** + * The identifier of the routing profile to assign to the user. + */ + RoutingProfileId: RoutingProfileId; + /** + * The identifier for the user account to assign the routing profile to. + */ + UserId: UserId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface UpdateUserSecurityProfilesRequest { + /** + * The identifiers for the security profiles to assign to the user. + */ + SecurityProfileIds: SecurityProfileIds; + /** + * The identifier of the user account to assign the security profiles. + */ + UserId: UserId; + /** + * The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. 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. + */ + InstanceId: InstanceId; + } + export interface User { + /** + * The identifier of the user account. + */ + Id?: UserId; + /** + * The ARN of the user account. + */ + Arn?: ARN; + /** + * The user name assigned to the user account. + */ + Username?: AgentUsername; + /** + * A UserIdentityInfo object. + */ + IdentityInfo?: UserIdentityInfo; + /** + * A UserPhoneConfig object. + */ + PhoneConfig?: UserPhoneConfig; + /** + * The directory Id for the user account in the existing directory used for identity management. + */ + DirectoryUserId?: DirectoryUserId; + /** + * The identifier(s) for the security profile assigned to the user. + */ + SecurityProfileIds?: SecurityProfileIds; + /** + * The identifier of the routing profile assigned to the user. + */ + RoutingProfileId?: RoutingProfileId; + /** + * The identifier for the hierarchy group assigned to the user. + */ + HierarchyGroupId?: HierarchyGroupId; + } + export type UserId = string; + export interface UserIdentityInfo { + /** + * The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management. + */ + FirstName?: AgentFirstName; + /** + * The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management. + */ + LastName?: AgentLastName; + /** + * The email address added to the user account. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned. + */ + Email?: Email; + } + export interface UserPhoneConfig { + /** + * The phone type selected for the user, either Soft phone or Desk phone. + */ + PhoneType: PhoneType; + /** + * The Auto accept setting for the user, Yes or No. + */ + AutoAccept?: AutoAccept; + /** + * The After Call Work (ACW) timeout setting, in seconds, for the user. + */ + AfterContactWorkTimeLimit?: AfterContactWorkTimeLimit; + /** + * The phone number for the user's desk phone. + */ + DeskPhoneNumber?: PhoneNumber; + } + export interface UserSummary { + /** + * The identifier for the user account. + */ + Id?: UserId; + /** + * The ARN for the user account. + */ + Arn?: ARN; + /** + * The Amazon Connect user name for the user account. + */ + Username?: AgentUsername; + } + export type UserSummaryList = UserSummary[]; + export type Value = number; + export type timestamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-08-08"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Connect client. + */ + export import Types = Connect; +} +export = Connect; diff --git a/node_modules/aws-sdk/clients/connect.js b/node_modules/aws-sdk/clients/connect.js new file mode 100644 index 0000000..43ffbc0 --- /dev/null +++ b/node_modules/aws-sdk/clients/connect.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['connect'] = {}; +AWS.Connect = Service.defineService('connect', ['2017-08-08']); +Object.defineProperty(apiLoader.services['connect'], '2017-08-08', { + get: function get() { + var model = require('../apis/connect-2017-08-08.min.json'); + model.paginators = require('../apis/connect-2017-08-08.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Connect; diff --git a/node_modules/aws-sdk/clients/costexplorer.d.ts b/node_modules/aws-sdk/clients/costexplorer.d.ts new file mode 100644 index 0000000..3c8fd3a --- /dev/null +++ b/node_modules/aws-sdk/clients/costexplorer.d.ts @@ -0,0 +1,1042 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CostExplorer extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CostExplorer.Types.ClientConfiguration) + config: Config & CostExplorer.Types.ClientConfiguration; + /** + * Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts. + */ + getCostAndUsage(params: CostExplorer.Types.GetCostAndUsageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageResponse) => void): Request; + /** + * Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts. + */ + getCostAndUsage(callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageResponse) => void): Request; + /** + * Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs. + */ + getCostForecast(params: CostExplorer.Types.GetCostForecastRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostForecastResponse) => void): Request; + /** + * Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs. + */ + getCostForecast(callback?: (err: AWSError, data: CostExplorer.Types.GetCostForecastResponse) => void): Request; + /** + * Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. + */ + getDimensionValues(params: CostExplorer.Types.GetDimensionValuesRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetDimensionValuesResponse) => void): Request; + /** + * Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. + */ + getDimensionValues(callback?: (err: AWSError, data: CostExplorer.Types.GetDimensionValuesResponse) => void): Request; + /** + * Retrieves the reservation coverage for your account. This enables 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: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation. + */ + getReservationCoverage(params: CostExplorer.Types.GetReservationCoverageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationCoverageResponse) => void): Request; + /** + * Retrieves the reservation coverage for your account. This enables 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: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation. + */ + getReservationCoverage(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationCoverageResponse) => void): Request; + /** + * 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. 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. For example, AWS automatically aggregates your Amazon 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 c4.large because that is the smallest size instance in the c4 instance family. + */ + getReservationPurchaseRecommendation(params: CostExplorer.Types.GetReservationPurchaseRecommendationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationPurchaseRecommendationResponse) => void): Request; + /** + * 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. 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. For example, AWS automatically aggregates your Amazon 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 c4.large because that is the smallest size instance in the c4 instance family. + */ + getReservationPurchaseRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationPurchaseRecommendationResponse) => void): Request; + /** + * 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 GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID. + */ + getReservationUtilization(params: CostExplorer.Types.GetReservationUtilizationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationUtilizationResponse) => void): Request; + /** + * 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 GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID. + */ + getReservationUtilization(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationUtilizationResponse) => void): Request; + /** + * Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. + */ + getTags(params: CostExplorer.Types.GetTagsRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetTagsResponse) => void): Request; + /** + * Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. + */ + getTags(callback?: (err: AWSError, data: CostExplorer.Types.GetTagsResponse) => void): Request; +} +declare namespace CostExplorer { + export type AccountScope = "PAYER"|"LINKED"|string; + export type AmortizedRecurringFee = string; + export type AmortizedUpfrontFee = string; + export type AttributeType = string; + export type AttributeValue = string; + export type Attributes = {[key: string]: AttributeValue}; + export type Context = "COST_AND_USAGE"|"RESERVATIONS"|string; + export interface Coverage { + /** + * The amount of instance usage that the reservation covered, in hours. + */ + CoverageHours?: CoverageHours; + /** + * The amount of instance usage that the reservation covered, in normalized units. + */ + CoverageNormalizedUnits?: CoverageNormalizedUnits; + /** + * The amount of cost that the reservation covered. + */ + CoverageCost?: CoverageCost; + } + export interface CoverageByTime { + /** + * The period that this coverage was used over. + */ + TimePeriod?: DateInterval; + /** + * The groups of instances that the reservation covered. + */ + Groups?: ReservationCoverageGroups; + /** + * The total reservation coverage, in hours. + */ + Total?: Coverage; + } + export interface CoverageCost { + /** + * How much an On-Demand instance cost. + */ + OnDemandCost?: OnDemandCost; + } + export interface CoverageHours { + /** + * The number of instance running hours that On-Demand Instances covered. + */ + OnDemandHours?: OnDemandHours; + /** + * The number of instance running hours that reservations covered. + */ + ReservedHours?: ReservedHours; + /** + * The total instance usage, in hours. + */ + TotalRunningHours?: TotalRunningHours; + /** + * The percentage of instance hours that a reservation covered. + */ + CoverageHoursPercentage?: CoverageHoursPercentage; + } + export type CoverageHoursPercentage = string; + export interface CoverageNormalizedUnits { + /** + * The number of normalized units that are covered by On-Demand Instances instead of a reservation. + */ + OnDemandNormalizedUnits?: OnDemandNormalizedUnits; + /** + * The number of normalized units that a reservation covers. + */ + ReservedNormalizedUnits?: ReservedNormalizedUnits; + /** + * The total number of normalized units that you used. + */ + TotalRunningNormalizedUnits?: TotalRunningNormalizedUnits; + /** + * The percentage of your used instance normalized units that a reservation covers. + */ + CoverageNormalizedUnitsPercentage?: CoverageNormalizedUnitsPercentage; + } + export type CoverageNormalizedUnitsPercentage = string; + export type CoveragesByTime = CoverageByTime[]; + export interface DateInterval { + /** + * The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01, AWS retrieves cost and usage data starting at 2017-01-01 up to the end date. + */ + Start: YearMonthDay; + /** + * The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01, AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01. + */ + End: YearMonthDay; + } + export type Dimension = "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|string; + export interface DimensionValues { + /** + * The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones. + */ + Key?: Dimension; + /** + * The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values. Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute, Amazon Elasticsearch Service, Amazon ElastiCache, Amazon Redshift, and Amazon Relational Database Service. + */ + Values?: Values; + } + export interface DimensionValuesWithAttributes { + /** + * The value of a dimension with a specific attribute. + */ + Value?: Value; + /** + * The attribute that applies to a specific Dimension. + */ + Attributes?: Attributes; + } + export type DimensionValuesWithAttributesList = DimensionValuesWithAttributes[]; + export interface EC2InstanceDetails { + /** + * The instance family of the recommended reservation. + */ + Family?: GenericString; + /** + * The type of instance that AWS recommends. + */ + InstanceType?: GenericString; + /** + * The AWS Region of the recommended reservation. + */ + Region?: GenericString; + /** + * The Availability Zone of the recommended reservation. + */ + AvailabilityZone?: GenericString; + /** + * The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance. + */ + Platform?: GenericString; + /** + * Whether the recommended reservation is dedicated or shared. + */ + Tenancy?: GenericString; + /** + * Whether the recommendation is for a current-generation instance. + */ + CurrentGeneration?: GenericBoolean; + /** + * Whether the recommended reservation is size flexible. + */ + SizeFlexEligible?: GenericBoolean; + } + export interface EC2Specification { + /** + * Whether you want a recommendation for standard or convertible reservations. + */ + OfferingClass?: OfferingClass; + } + export interface ESInstanceDetails { + /** + * The class of instance that AWS recommends. + */ + InstanceClass?: GenericString; + /** + * The size of instance that AWS recommends. + */ + InstanceSize?: GenericString; + /** + * The AWS Region of the recommended reservation. + */ + Region?: GenericString; + /** + * Whether the recommendation is for a current-generation instance. + */ + CurrentGeneration?: GenericBoolean; + /** + * Whether the recommended reservation is size flexible. + */ + SizeFlexEligible?: GenericBoolean; + } + export interface ElastiCacheInstanceDetails { + /** + * The instance family of the recommended reservation. + */ + Family?: GenericString; + /** + * The type of node that AWS recommends. + */ + NodeType?: GenericString; + /** + * The AWS Region of the recommended reservation. + */ + Region?: GenericString; + /** + * The description of the recommended reservation. + */ + ProductDescription?: GenericString; + /** + * Whether the recommendation is for a current generation instance. + */ + CurrentGeneration?: GenericBoolean; + /** + * Whether the recommended reservation is size flexible. + */ + SizeFlexEligible?: GenericBoolean; + } + export type Entity = string; + export type Estimated = boolean; + export interface Expression { + /** + * Return results that match either Dimension object. + */ + Or?: Expressions; + /** + * Return results that match both Dimension objects. + */ + And?: Expressions; + /** + * Return results that don't match a Dimension object. + */ + Not?: Expression; + /** + * The specific Dimension to use for Expression. + */ + Dimensions?: DimensionValues; + /** + * The specific Tag to use for Expression. + */ + Tags?: TagValues; + } + export type Expressions = Expression[]; + export interface ForecastResult { + /** + * The period of time that the forecast covers. + */ + TimePeriod?: DateInterval; + /** + * The mean value of the forecast. + */ + MeanValue?: GenericString; + /** + * The lower limit for the prediction interval. + */ + PredictionIntervalLowerBound?: GenericString; + /** + * The upper limit for the prediction interval. + */ + PredictionIntervalUpperBound?: GenericString; + } + export type ForecastResultsByTime = ForecastResult[]; + export type GenericBoolean = boolean; + export type GenericString = string; + export interface GetCostAndUsageRequest { + /** + * Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. + */ + TimePeriod: DateInterval; + /** + * Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY. The GetCostAndUsageRequest operation supports only DAILY and MONTHLY granularities. + */ + Granularity?: Granularity; + /** + * Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression. + */ + Filter?: Expression; + /** + * Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups. Metrics is required for GetCostAndUsage requests. + */ + Metrics?: MetricNames; + /** + * You can group AWS costs using up to two different groups, either dimensions, tag keys, or both. When you group by tag key, you get all tag values, including empty strings. Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE. + */ + GroupBy?: GroupDefinitions; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetCostAndUsageResponse { + /** + * 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. + */ + NextPageToken?: NextPageToken; + /** + * The groups that are specified by the Filter or GroupBy parameters in the request. + */ + GroupDefinitions?: GroupDefinitions; + /** + * The time period that is covered by the results in the response. + */ + ResultsByTime?: ResultsByTime; + } + export interface GetCostForecastRequest { + /** + * The period of time that you want the forecast to cover. + */ + TimePeriod: DateInterval; + /** + * Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values for a GetCostForecast call are the following: AmortizedCost BlendedCost NetAmortizedCost NetUnblendedCost UnblendedCost + */ + Metric: Metric; + /** + * How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts. The GetCostForecast operation supports only DAILY and MONTHLY granularities. + */ + Granularity: Granularity; + /** + * The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters. + */ + Filter?: Expression; + /** + * Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals. + */ + PredictionIntervalLevel?: PredictionIntervalLevel; + } + export interface GetCostForecastResponse { + /** + * How much you are forecasted to spend over the forecast period, in USD. + */ + Total?: MetricValue; + /** + * The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months. + */ + ForecastResultsByTime?: ForecastResultsByTime; + } + export interface GetDimensionValuesRequest { + /** + * The value that you want to search the filter values for. + */ + SearchString?: SearchString; + /** + * The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. + */ + TimePeriod: DateInterval; + /** + * The name of the dimension. Each Dimension is available for a different Context. For more information, see Context. + */ + Dimension: Dimension; + /** + * The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation. If you set the context to COST_AND_USAGE, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services. 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. OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The action performed. Examples include RunInstance and CreateBucket. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances. SERVICE - The AWS service such as Amazon DynamoDB. USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs. USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute. RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits. If you set the context to RESERVATIONS, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. 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. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. REGION - The AWS Region. SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone. TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI). TENANCY - The tenancy of a resource. Examples are shared or dedicated. + */ + Context?: Context; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetDimensionValuesResponse { + /** + * The filters that you used to filter your request. Some dimensions are available only for a specific context. If you set the context to COST_AND_USAGE, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services. 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. OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The action performed. Examples include RunInstance and CreateBucket. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances. SERVICE - The AWS service such as Amazon DynamoDB. USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs. USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute. RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits. If you set the context to RESERVATIONS, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. 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. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. REGION - The AWS Region. SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone. TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI). TENANCY - The tenancy of a resource. Examples are shared or dedicated. + */ + DimensionValues: DimensionValuesWithAttributesList; + /** + * The number of results that AWS returned at one time. + */ + ReturnSize: PageSize; + /** + * The total number of search results. + */ + TotalSize: PageSize; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetReservationCoverageRequest { + /** + * The start and end dates of the period that you want to retrieve data about reservation coverage for. 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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. + */ + TimePeriod: DateInterval; + /** + * You can group the data by the following attributes: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION TENANCY + */ + GroupBy?: GroupDefinitions; + /** + * The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY. If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. The GetReservationCoverage operation supports only DAILY and MONTHLY granularities. + */ + Granularity?: Granularity; + /** + * Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY GetReservationCoverage uses the same Expression object as the other operations, but only AND 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. If you don't provide a SERVICE filter, Cost Explorer defaults to EC2. + */ + Filter?: Expression; + /** + * The measurement that you want your reservation coverage reported in. Valid values are Hour, Unit, and Cost. You can use multiple values in a request. + */ + Metrics?: MetricNames; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetReservationCoverageResponse { + /** + * The amount of time that your reservations covered. + */ + CoveragesByTime: CoveragesByTime; + /** + * The total amount of instance usage that a reservation covered. + */ + Total?: Coverage; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetReservationPurchaseRecommendationRequest { + /** + * The account ID that is associated with the recommendation. + */ + AccountId?: GenericString; + /** + * The specific service that you want recommendations for. + */ + Service: GenericString; + /** + * The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations. Valid values are PAYER and LINKED. + */ + AccountScope?: AccountScope; + /** + * The number of previous days that you want AWS to consider when it calculates your recommendations. + */ + LookbackPeriodInDays?: LookbackPeriodInDays; + /** + * The reservation term that you want recommendations for. + */ + TermInYears?: TermInYears; + /** + * The reservation purchase option that you want recommendations for. + */ + PaymentOption?: PaymentOption; + /** + * The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances. + */ + ServiceSpecification?: ServiceSpecification; + /** + * The number of recommendations that you want returned in a single response object. + */ + PageSize?: NonNegativeInteger; + /** + * The pagination token that indicates the next set of results that you want to retrieve. + */ + NextPageToken?: NextPageToken; + } + export interface GetReservationPurchaseRecommendationResponse { + /** + * Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation. + */ + Metadata?: ReservationPurchaseRecommendationMetadata; + /** + * Recommendations for reservations to purchase. + */ + Recommendations?: ReservationPurchaseRecommendations; + /** + * The pagination token for the next set of retrievable results. + */ + NextPageToken?: NextPageToken; + } + export interface GetReservationUtilizationRequest { + /** + * Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. + */ + TimePeriod: DateInterval; + /** + * Groups only by SUBSCRIPTION_ID. Metadata is included. + */ + GroupBy?: GroupDefinitions; + /** + * If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY. The GetReservationUtilization operation supports only DAILY and MONTHLY granularities. + */ + Granularity?: Granularity; + /** + * Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE SCOPE TENANCY GetReservationUtilization uses the same Expression object as the other operations, but only AND 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. + */ + Filter?: Expression; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetReservationUtilizationResponse { + /** + * The amount of time that you used your RIs. + */ + UtilizationsByTime: UtilizationsByTime; + /** + * The total amount of time that you used your RIs. + */ + Total?: ReservationAggregates; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetTagsRequest { + /** + * The value that you want to search for. + */ + SearchString?: SearchString; + /** + * The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. + */ + TimePeriod: DateInterval; + /** + * The key of the tag that you want to return values for. + */ + TagKey?: TagKey; + /** + * 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. + */ + NextPageToken?: NextPageToken; + } + export interface GetTagsResponse { + /** + * 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. + */ + NextPageToken?: NextPageToken; + /** + * The tags that match your request. + */ + Tags: TagList; + /** + * The number of query results that AWS returns at a time. + */ + ReturnSize: PageSize; + /** + * The total number of query results. + */ + TotalSize: PageSize; + } + export type Granularity = "DAILY"|"MONTHLY"|"HOURLY"|string; + export interface Group { + /** + * The keys that are included in this group. + */ + Keys?: Keys; + /** + * The metrics that are included in this group. + */ + Metrics?: Metrics; + } + export interface GroupDefinition { + /** + * The string that represents the type of group. + */ + Type?: GroupDefinitionType; + /** + * The string that represents a key for a specified group. + */ + Key?: GroupDefinitionKey; + } + export type GroupDefinitionKey = string; + export type GroupDefinitionType = "DIMENSION"|"TAG"|string; + export type GroupDefinitions = GroupDefinition[]; + export type Groups = Group[]; + export interface InstanceDetails { + /** + * The Amazon EC2 instances that AWS recommends that you purchase. + */ + EC2InstanceDetails?: EC2InstanceDetails; + /** + * The Amazon RDS instances that AWS recommends that you purchase. + */ + RDSInstanceDetails?: RDSInstanceDetails; + /** + * The Amazon Redshift instances that AWS recommends that you purchase. + */ + RedshiftInstanceDetails?: RedshiftInstanceDetails; + /** + * The ElastiCache instances that AWS recommends that you purchase. + */ + ElastiCacheInstanceDetails?: ElastiCacheInstanceDetails; + /** + * The Amazon ES instances that AWS recommends that you purchase. + */ + ESInstanceDetails?: ESInstanceDetails; + } + export type Key = string; + export type Keys = Key[]; + export type LookbackPeriodInDays = "SEVEN_DAYS"|"THIRTY_DAYS"|"SIXTY_DAYS"|string; + export type Metric = "BLENDED_COST"|"UNBLENDED_COST"|"AMORTIZED_COST"|"NET_UNBLENDED_COST"|"NET_AMORTIZED_COST"|"USAGE_QUANTITY"|"NORMALIZED_USAGE_AMOUNT"|string; + export type MetricAmount = string; + export type MetricName = string; + export type MetricNames = MetricName[]; + export type MetricUnit = string; + export interface MetricValue { + /** + * The actual number that represents the metric. + */ + Amount?: MetricAmount; + /** + * The unit that the metric is given in. + */ + Unit?: MetricUnit; + } + export type Metrics = {[key: string]: MetricValue}; + export type NetRISavings = string; + export type NextPageToken = string; + export type NonNegativeInteger = number; + export type OfferingClass = "STANDARD"|"CONVERTIBLE"|string; + export type OnDemandCost = string; + export type OnDemandCostOfRIHoursUsed = string; + export type OnDemandHours = string; + export type OnDemandNormalizedUnits = string; + export type PageSize = number; + export type PaymentOption = "NO_UPFRONT"|"PARTIAL_UPFRONT"|"ALL_UPFRONT"|"LIGHT_UTILIZATION"|"MEDIUM_UTILIZATION"|"HEAVY_UTILIZATION"|string; + export type PredictionIntervalLevel = number; + export type PurchasedHours = string; + export type PurchasedUnits = string; + export interface RDSInstanceDetails { + /** + * The instance family of the recommended reservation. + */ + Family?: GenericString; + /** + * The type of instance that AWS recommends. + */ + InstanceType?: GenericString; + /** + * The AWS Region of the recommended reservation. + */ + Region?: GenericString; + /** + * The database engine that the recommended reservation supports. + */ + DatabaseEngine?: GenericString; + /** + * The database edition that the recommended reservation supports. + */ + DatabaseEdition?: GenericString; + /** + * Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone. + */ + DeploymentOption?: GenericString; + /** + * The license model that the recommended reservation supports. + */ + LicenseModel?: GenericString; + /** + * Whether the recommendation is for a current-generation instance. + */ + CurrentGeneration?: GenericBoolean; + /** + * Whether the recommended reservation is size flexible. + */ + SizeFlexEligible?: GenericBoolean; + } + export interface RedshiftInstanceDetails { + /** + * The instance family of the recommended reservation. + */ + Family?: GenericString; + /** + * The type of node that AWS recommends. + */ + NodeType?: GenericString; + /** + * The AWS Region of the recommended reservation. + */ + Region?: GenericString; + /** + * Whether the recommendation is for a current-generation instance. + */ + CurrentGeneration?: GenericBoolean; + /** + * Whether the recommended reservation is size flexible. + */ + SizeFlexEligible?: GenericBoolean; + } + export interface ReservationAggregates { + /** + * The percentage of reservation time that you used. + */ + UtilizationPercentage?: UtilizationPercentage; + /** + * The percentage of Amazon EC2 reservation time that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017. + */ + UtilizationPercentageInUnits?: UtilizationPercentageInUnits; + /** + * How many reservation hours that you purchased. + */ + PurchasedHours?: PurchasedHours; + /** + * How many Amazon EC2 reservation hours that you purchased, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017. + */ + PurchasedUnits?: PurchasedUnits; + /** + * The total number of reservation hours that you used. + */ + TotalActualHours?: TotalActualHours; + /** + * The total number of Amazon EC2 reservation hours that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017. + */ + TotalActualUnits?: TotalActualUnits; + /** + * The number of reservation hours that you didn't use. + */ + UnusedHours?: UnusedHours; + /** + * The number of Amazon EC2 reservation hours that you didn't use, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017. + */ + UnusedUnits?: UnusedUnits; + /** + * How much your reservation would cost if charged On-Demand rates. + */ + OnDemandCostOfRIHoursUsed?: OnDemandCostOfRIHoursUsed; + /** + * How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed. + */ + NetRISavings?: NetRISavings; + /** + * How much you could save if you use your entire reservation. + */ + TotalPotentialRISavings?: TotalPotentialRISavings; + /** + * The upfront cost of your reservation, amortized over the reservation period. + */ + AmortizedUpfrontFee?: AmortizedUpfrontFee; + /** + * The monthly cost of your reservation, amortized over the reservation period. + */ + AmortizedRecurringFee?: AmortizedRecurringFee; + /** + * The total cost of your reservation, amortized over the reservation period. + */ + TotalAmortizedFee?: TotalAmortizedFee; + } + export interface ReservationCoverageGroup { + /** + * The attributes for this group of reservations. + */ + Attributes?: Attributes; + /** + * How much instance usage this group of reservations covered. + */ + Coverage?: Coverage; + } + export type ReservationCoverageGroups = ReservationCoverageGroup[]; + export type ReservationGroupKey = string; + export type ReservationGroupValue = string; + export interface ReservationPurchaseRecommendation { + /** + * 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. + */ + AccountScope?: AccountScope; + /** + * How many days of previous usage that AWS considers when making this recommendation. + */ + LookbackPeriodInDays?: LookbackPeriodInDays; + /** + * The term of the reservation that you want recommendations for, in years. + */ + TermInYears?: TermInYears; + /** + * The payment option for the reservation. For example, AllUpfront or NoUpfront. + */ + PaymentOption?: PaymentOption; + /** + * Hardware specifications for the service that you want recommendations for. + */ + ServiceSpecification?: ServiceSpecification; + /** + * Details about the recommended purchases. + */ + RecommendationDetails?: ReservationPurchaseRecommendationDetails; + /** + * A summary about the recommended purchase. + */ + RecommendationSummary?: ReservationPurchaseRecommendationSummary; + } + export interface ReservationPurchaseRecommendationDetail { + /** + * The account that this RI recommendation is for. + */ + AccountId?: GenericString; + /** + * Details about the instances that AWS recommends that you purchase. + */ + InstanceDetails?: InstanceDetails; + /** + * The number of instances that AWS recommends that you purchase. + */ + RecommendedNumberOfInstancesToPurchase?: GenericString; + /** + * The number of normalized units that AWS recommends that you purchase. + */ + RecommendedNormalizedUnitsToPurchase?: GenericString; + /** + * The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases. + */ + MinimumNumberOfInstancesUsedPerHour?: GenericString; + /** + * The minimum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases. + */ + MinimumNormalizedUnitsUsedPerHour?: GenericString; + /** + * The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases. + */ + MaximumNumberOfInstancesUsedPerHour?: GenericString; + /** + * 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. + */ + MaximumNormalizedUnitsUsedPerHour?: GenericString; + /** + * The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases. + */ + AverageNumberOfInstancesUsedPerHour?: GenericString; + /** + * 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. + */ + AverageNormalizedUnitsUsedPerHour?: GenericString; + /** + * The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases. + */ + AverageUtilization?: GenericString; + /** + * How long AWS estimates that it takes for this instance to start saving you money, in months. + */ + EstimatedBreakEvenInMonths?: GenericString; + /** + * The currency code that AWS used to calculate the costs for this instance. + */ + CurrencyCode?: GenericString; + /** + * How much AWS estimates that this specific recommendation could save you in a month. + */ + EstimatedMonthlySavingsAmount?: GenericString; + /** + * How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs. + */ + EstimatedMonthlySavingsPercentage?: GenericString; + /** + * How much AWS estimates that you spend on On-Demand Instances in a month. + */ + EstimatedMonthlyOnDemandCost?: GenericString; + /** + * How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation. + */ + EstimatedReservationCostForLookbackPeriod?: GenericString; + /** + * How much purchasing this instance costs you upfront. + */ + UpfrontCost?: GenericString; + /** + * How much purchasing this instance costs you on a monthly basis. + */ + RecurringStandardMonthlyCost?: GenericString; + } + export type ReservationPurchaseRecommendationDetails = ReservationPurchaseRecommendationDetail[]; + export interface ReservationPurchaseRecommendationMetadata { + /** + * The ID for this specific recommendation. + */ + RecommendationId?: GenericString; + /** + * The time stamp for when AWS made this recommendation. + */ + GenerationTimestamp?: GenericString; + } + export interface ReservationPurchaseRecommendationSummary { + /** + * The total amount that AWS estimates that this recommendation could save you in a month. + */ + TotalEstimatedMonthlySavingsAmount?: GenericString; + /** + * The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs. + */ + TotalEstimatedMonthlySavingsPercentage?: GenericString; + /** + * The currency code used for this recommendation. + */ + CurrencyCode?: GenericString; + } + export type ReservationPurchaseRecommendations = ReservationPurchaseRecommendation[]; + export interface ReservationUtilizationGroup { + /** + * The key for a specific reservation attribute. + */ + Key?: ReservationGroupKey; + /** + * The value of a specific reservation attribute. + */ + Value?: ReservationGroupValue; + /** + * The attributes for this group of reservations. + */ + Attributes?: Attributes; + /** + * How much you used this group of reservations. + */ + Utilization?: ReservationAggregates; + } + export type ReservationUtilizationGroups = ReservationUtilizationGroup[]; + export type ReservedHours = string; + export type ReservedNormalizedUnits = string; + export interface ResultByTime { + /** + * The time period that the result covers. + */ + TimePeriod?: DateInterval; + /** + * The total amount of cost or usage accrued during the time period. + */ + Total?: Metrics; + /** + * The groups that this time period includes. + */ + Groups?: Groups; + /** + * Whether the result is estimated. + */ + Estimated?: Estimated; + } + export type ResultsByTime = ResultByTime[]; + export type SearchString = string; + export interface ServiceSpecification { + /** + * The Amazon EC2 hardware specifications that you want AWS to provide recommendations for. + */ + EC2Specification?: EC2Specification; + } + export type TagKey = string; + export type TagList = Entity[]; + export interface TagValues { + /** + * The key for the tag. + */ + Key?: TagKey; + /** + * The specific value of the tag. + */ + Values?: Values; + } + export type TermInYears = "ONE_YEAR"|"THREE_YEARS"|string; + export type TotalActualHours = string; + export type TotalActualUnits = string; + export type TotalAmortizedFee = string; + export type TotalPotentialRISavings = string; + export type TotalRunningHours = string; + export type TotalRunningNormalizedUnits = string; + export type UnusedHours = string; + export type UnusedUnits = string; + export interface UtilizationByTime { + /** + * The period of time that this utilization was used for. + */ + TimePeriod?: DateInterval; + /** + * The groups that this utilization result uses. + */ + Groups?: ReservationUtilizationGroups; + /** + * The total number of reservation hours that were used. + */ + Total?: ReservationAggregates; + } + export type UtilizationPercentage = string; + export type UtilizationPercentageInUnits = string; + export type UtilizationsByTime = UtilizationByTime[]; + export type Value = string; + export type Values = Value[]; + export type YearMonthDay = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-10-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CostExplorer client. + */ + export import Types = CostExplorer; +} +export = CostExplorer; diff --git a/node_modules/aws-sdk/clients/costexplorer.js b/node_modules/aws-sdk/clients/costexplorer.js new file mode 100644 index 0000000..c3fcec5 --- /dev/null +++ b/node_modules/aws-sdk/clients/costexplorer.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['costexplorer'] = {}; +AWS.CostExplorer = Service.defineService('costexplorer', ['2017-10-25']); +Object.defineProperty(apiLoader.services['costexplorer'], '2017-10-25', { + get: function get() { + var model = require('../apis/ce-2017-10-25.min.json'); + model.paginators = require('../apis/ce-2017-10-25.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CostExplorer; diff --git a/node_modules/aws-sdk/clients/cur.d.ts b/node_modules/aws-sdk/clients/cur.d.ts new file mode 100644 index 0000000..039a8a4 --- /dev/null +++ b/node_modules/aws-sdk/clients/cur.d.ts @@ -0,0 +1,123 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class CUR extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: CUR.Types.ClientConfiguration) + config: Config & CUR.Types.ClientConfiguration; + /** + * Deletes the specified report. + */ + deleteReportDefinition(params: CUR.Types.DeleteReportDefinitionRequest, callback?: (err: AWSError, data: CUR.Types.DeleteReportDefinitionResponse) => void): Request; + /** + * Deletes the specified report. + */ + deleteReportDefinition(callback?: (err: AWSError, data: CUR.Types.DeleteReportDefinitionResponse) => void): Request; + /** + * Lists the AWS Cost and Usage reports available to this account. + */ + describeReportDefinitions(params: CUR.Types.DescribeReportDefinitionsRequest, callback?: (err: AWSError, data: CUR.Types.DescribeReportDefinitionsResponse) => void): Request; + /** + * Lists the AWS Cost and Usage reports available to this account. + */ + describeReportDefinitions(callback?: (err: AWSError, data: CUR.Types.DescribeReportDefinitionsResponse) => void): Request; + /** + * Creates a new report using the description that you provide. + */ + putReportDefinition(params: CUR.Types.PutReportDefinitionRequest, callback?: (err: AWSError, data: CUR.Types.PutReportDefinitionResponse) => void): Request; + /** + * Creates a new report using the description that you provide. + */ + putReportDefinition(callback?: (err: AWSError, data: CUR.Types.PutReportDefinitionResponse) => void): Request; +} +declare namespace CUR { + export type AWSRegion = "us-east-1"|"us-west-1"|"us-west-2"|"eu-central-1"|"eu-west-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"eu-north-1"|"ap-northeast-3"|string; + export type AdditionalArtifact = "REDSHIFT"|"QUICKSIGHT"|"ATHENA"|string; + export type AdditionalArtifactList = AdditionalArtifact[]; + export type CompressionFormat = "ZIP"|"GZIP"|"Parquet"|string; + export interface DeleteReportDefinitionRequest { + ReportName?: ReportName; + } + export interface DeleteReportDefinitionResponse { + ResponseMessage?: DeleteResponseMessage; + } + export type DeleteResponseMessage = string; + export interface DescribeReportDefinitionsRequest { + MaxResults?: MaxResults; + NextToken?: GenericString; + } + export interface DescribeReportDefinitionsResponse { + /** + * A list of AWS Cost and Usage reports owned by the account. + */ + ReportDefinitions?: ReportDefinitionList; + NextToken?: GenericString; + } + export type GenericString = string; + export type MaxResults = number; + export interface PutReportDefinitionRequest { + /** + * Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information. + */ + ReportDefinition: ReportDefinition; + } + export interface PutReportDefinitionResponse { + } + export type RefreshClosedReports = boolean; + export interface ReportDefinition { + ReportName: ReportName; + TimeUnit: TimeUnit; + Format: ReportFormat; + Compression: CompressionFormat; + /** + * A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs. + */ + AdditionalSchemaElements: SchemaElementList; + S3Bucket: S3Bucket; + S3Prefix: S3Prefix; + S3Region: AWSRegion; + /** + * A list of manifests that you want Amazon Web Services to create for this report. + */ + AdditionalArtifacts?: AdditionalArtifactList; + /** + * Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees. + */ + RefreshClosedReports?: RefreshClosedReports; + /** + * Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions. + */ + ReportVersioning?: ReportVersioning; + } + export type ReportDefinitionList = ReportDefinition[]; + export type ReportFormat = "textORcsv"|"Parquet"|string; + export type ReportName = string; + export type ReportVersioning = "CREATE_NEW_REPORT"|"OVERWRITE_REPORT"|string; + export type S3Bucket = string; + export type S3Prefix = string; + export type SchemaElement = "RESOURCES"|string; + export type SchemaElementList = SchemaElement[]; + export type TimeUnit = "HOURLY"|"DAILY"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-01-06"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the CUR client. + */ + export import Types = CUR; +} +export = CUR; diff --git a/node_modules/aws-sdk/clients/cur.js b/node_modules/aws-sdk/clients/cur.js new file mode 100644 index 0000000..76101bb --- /dev/null +++ b/node_modules/aws-sdk/clients/cur.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['cur'] = {}; +AWS.CUR = Service.defineService('cur', ['2017-01-06']); +Object.defineProperty(apiLoader.services['cur'], '2017-01-06', { + get: function get() { + var model = require('../apis/cur-2017-01-06.min.json'); + model.paginators = require('../apis/cur-2017-01-06.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.CUR; diff --git a/node_modules/aws-sdk/clients/datapipeline.d.ts b/node_modules/aws-sdk/clients/datapipeline.d.ts new file mode 100644 index 0000000..6ebdfcc --- /dev/null +++ b/node_modules/aws-sdk/clients/datapipeline.d.ts @@ -0,0 +1,770 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DataPipeline extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DataPipeline.Types.ClientConfiguration) + config: Config & DataPipeline.Types.ClientConfiguration; + /** + * Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline. To activate a finished pipeline, modify the end date for the pipeline and then activate it. + */ + activatePipeline(params: DataPipeline.Types.ActivatePipelineInput, callback?: (err: AWSError, data: DataPipeline.Types.ActivatePipelineOutput) => void): Request; + /** + * Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline. To activate a finished pipeline, modify the end date for the pipeline and then activate it. + */ + activatePipeline(callback?: (err: AWSError, data: DataPipeline.Types.ActivatePipelineOutput) => void): Request; + /** + * Adds or modifies tags for the specified pipeline. + */ + addTags(params: DataPipeline.Types.AddTagsInput, callback?: (err: AWSError, data: DataPipeline.Types.AddTagsOutput) => void): Request; + /** + * Adds or modifies tags for the specified pipeline. + */ + addTags(callback?: (err: AWSError, data: DataPipeline.Types.AddTagsOutput) => void): Request; + /** + * Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. + */ + createPipeline(params: DataPipeline.Types.CreatePipelineInput, callback?: (err: AWSError, data: DataPipeline.Types.CreatePipelineOutput) => void): Request; + /** + * Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. + */ + createPipeline(callback?: (err: AWSError, data: DataPipeline.Types.CreatePipelineOutput) => void): Request; + /** + * Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes. To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. + */ + deactivatePipeline(params: DataPipeline.Types.DeactivatePipelineInput, callback?: (err: AWSError, data: DataPipeline.Types.DeactivatePipelineOutput) => void): Request; + /** + * Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes. To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. + */ + deactivatePipeline(callback?: (err: AWSError, data: DataPipeline.Types.DeactivatePipelineOutput) => void): Request; + /** + * Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed. + */ + deletePipeline(params: DataPipeline.Types.DeletePipelineInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed. + */ + deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. + */ + describeObjects(params: DataPipeline.Types.DescribeObjectsInput, callback?: (err: AWSError, data: DataPipeline.Types.DescribeObjectsOutput) => void): Request; + /** + * Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. + */ + describeObjects(callback?: (err: AWSError, data: DataPipeline.Types.DescribeObjectsOutput) => void): Request; + /** + * Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition. + */ + describePipelines(params: DataPipeline.Types.DescribePipelinesInput, callback?: (err: AWSError, data: DataPipeline.Types.DescribePipelinesOutput) => void): Request; + /** + * Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition. + */ + describePipelines(callback?: (err: AWSError, data: DataPipeline.Types.DescribePipelinesOutput) => void): Request; + /** + * Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. + */ + evaluateExpression(params: DataPipeline.Types.EvaluateExpressionInput, callback?: (err: AWSError, data: DataPipeline.Types.EvaluateExpressionOutput) => void): Request; + /** + * Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. + */ + evaluateExpression(callback?: (err: AWSError, data: DataPipeline.Types.EvaluateExpressionOutput) => void): Request; + /** + * Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition. + */ + getPipelineDefinition(params: DataPipeline.Types.GetPipelineDefinitionInput, callback?: (err: AWSError, data: DataPipeline.Types.GetPipelineDefinitionOutput) => void): Request; + /** + * Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition. + */ + getPipelineDefinition(callback?: (err: AWSError, data: DataPipeline.Types.GetPipelineDefinitionOutput) => void): Request; + /** + * Lists the pipeline identifiers for all active pipelines that you have permission to access. + */ + listPipelines(params: DataPipeline.Types.ListPipelinesInput, callback?: (err: AWSError, data: DataPipeline.Types.ListPipelinesOutput) => void): Request; + /** + * Lists the pipeline identifiers for all active pipelines that you have permission to access. + */ + listPipelines(callback?: (err: AWSError, data: DataPipeline.Types.ListPipelinesOutput) => void): Request; + /** + * Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds. + */ + pollForTask(params: DataPipeline.Types.PollForTaskInput, callback?: (err: AWSError, data: DataPipeline.Types.PollForTaskOutput) => void): Request; + /** + * Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds. + */ + pollForTask(callback?: (err: AWSError, data: DataPipeline.Types.PollForTaskOutput) => void): Request; + /** + * Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. + */ + putPipelineDefinition(params: DataPipeline.Types.PutPipelineDefinitionInput, callback?: (err: AWSError, data: DataPipeline.Types.PutPipelineDefinitionOutput) => void): Request; + /** + * Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. + */ + putPipelineDefinition(callback?: (err: AWSError, data: DataPipeline.Types.PutPipelineDefinitionOutput) => void): Request; + /** + * Queries the specified pipeline for the names of objects that match the specified set of conditions. + */ + queryObjects(params: DataPipeline.Types.QueryObjectsInput, callback?: (err: AWSError, data: DataPipeline.Types.QueryObjectsOutput) => void): Request; + /** + * Queries the specified pipeline for the names of objects that match the specified set of conditions. + */ + queryObjects(callback?: (err: AWSError, data: DataPipeline.Types.QueryObjectsOutput) => void): Request; + /** + * Removes existing tags from the specified pipeline. + */ + removeTags(params: DataPipeline.Types.RemoveTagsInput, callback?: (err: AWSError, data: DataPipeline.Types.RemoveTagsOutput) => void): Request; + /** + * Removes existing tags from the specified pipeline. + */ + removeTags(callback?: (err: AWSError, data: DataPipeline.Types.RemoveTagsOutput) => void): Request; + /** + * Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds. + */ + reportTaskProgress(params: DataPipeline.Types.ReportTaskProgressInput, callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskProgressOutput) => void): Request; + /** + * Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds. + */ + reportTaskProgress(callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskProgressOutput) => void): Request; + /** + * Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. + */ + reportTaskRunnerHeartbeat(params: DataPipeline.Types.ReportTaskRunnerHeartbeatInput, callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskRunnerHeartbeatOutput) => void): Request; + /** + * Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. + */ + reportTaskRunnerHeartbeat(callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskRunnerHeartbeatOutput) => void): Request; + /** + * Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException. + */ + setStatus(params: DataPipeline.Types.SetStatusInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException. + */ + setStatus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. + */ + setTaskStatus(params: DataPipeline.Types.SetTaskStatusInput, callback?: (err: AWSError, data: DataPipeline.Types.SetTaskStatusOutput) => void): Request; + /** + * Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. + */ + setTaskStatus(callback?: (err: AWSError, data: DataPipeline.Types.SetTaskStatusOutput) => void): Request; + /** + * Validates the specified pipeline definition to ensure that it is well formed and can be run without error. + */ + validatePipelineDefinition(params: DataPipeline.Types.ValidatePipelineDefinitionInput, callback?: (err: AWSError, data: DataPipeline.Types.ValidatePipelineDefinitionOutput) => void): Request; + /** + * Validates the specified pipeline definition to ensure that it is well formed and can be run without error. + */ + validatePipelineDefinition(callback?: (err: AWSError, data: DataPipeline.Types.ValidatePipelineDefinitionOutput) => void): Request; +} +declare namespace DataPipeline { + export interface ActivatePipelineInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * A list of parameter values to pass to the pipeline at activation. + */ + parameterValues?: ParameterValueList; + /** + * The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution. + */ + startTimestamp?: timestamp; + } + export interface ActivatePipelineOutput { + } + export interface AddTagsInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * The tags to add, as key/value pairs. + */ + tags: tagList; + } + export interface AddTagsOutput { + } + export interface CreatePipelineInput { + /** + * The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier. + */ + name: id; + /** + * A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials. + */ + uniqueId: id; + /** + * The description for the pipeline. + */ + description?: string; + /** + * A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide. + */ + tags?: tagList; + } + export interface CreatePipelineOutput { + /** + * The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE. + */ + pipelineId: id; + } + export interface DeactivatePipelineInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish. + */ + cancelActive?: cancelActive; + } + export interface DeactivatePipelineOutput { + } + export interface DeletePipelineInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + } + export interface DescribeObjectsInput { + /** + * The ID of the pipeline that contains the object definitions. + */ + pipelineId: id; + /** + * The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects. + */ + objectIds: idList; + /** + * Indicates whether any expressions in the object should be evaluated when the object descriptions are returned. + */ + evaluateExpressions?: boolean; + /** + * The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results. + */ + marker?: string; + } + export interface DescribeObjectsOutput { + /** + * An array of object definitions. + */ + pipelineObjects: PipelineObjectList; + /** + * The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value. If the value is null, there are no more results. + */ + marker?: string; + /** + * Indicates whether there are more results to return. + */ + hasMoreResults?: boolean; + } + export interface DescribePipelinesInput { + /** + * The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines. + */ + pipelineIds: idList; + } + export interface DescribePipelinesOutput { + /** + * An array of descriptions for the specified pipelines. + */ + pipelineDescriptionList: PipelineDescriptionList; + } + export interface EvaluateExpressionInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * The ID of the object. + */ + objectId: id; + /** + * The expression to evaluate. + */ + expression: longString; + } + export interface EvaluateExpressionOutput { + /** + * The evaluated expression. + */ + evaluatedExpression: longString; + } + export interface Field { + /** + * The field identifier. + */ + key: fieldNameString; + /** + * The field value, expressed as a String. + */ + stringValue?: fieldStringValue; + /** + * The field value, expressed as the identifier of another object. + */ + refValue?: fieldNameString; + } + export interface GetPipelineDefinitionInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated. + */ + version?: string; + } + export interface GetPipelineDefinitionOutput { + /** + * The objects defined in the pipeline. + */ + pipelineObjects?: PipelineObjectList; + /** + * The parameter objects used in the pipeline definition. + */ + parameterObjects?: ParameterObjectList; + /** + * The parameter values used in the pipeline definition. + */ + parameterValues?: ParameterValueList; + } + export interface InstanceIdentity { + /** + * A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object. + */ + document?: string; + /** + * A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document. + */ + signature?: string; + } + export interface ListPipelinesInput { + /** + * The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call ListPipelines with the marker value from the previous call to retrieve the next set of results. + */ + marker?: string; + } + export interface ListPipelinesOutput { + /** + * The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition. + */ + pipelineIdList: pipelineList; + /** + * The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput again with this marker value. If the value is null, there are no more results. + */ + marker?: string; + /** + * Indicates whether there are more results that can be obtained by a subsequent call. + */ + hasMoreResults?: boolean; + } + export interface Operator { + /** + * The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. The comparison operators EQ and REF_EQ act on the following fields: name @sphere parent @componentParent @instanceParent @status @scheduledStartTime @scheduledEndTime @actualStartTime @actualEndTime The comparison operators GE, LE, and BETWEEN act on the following fields: @scheduledStartTime @scheduledEndTime @actualStartTime @actualEndTime Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my". + */ + type?: OperatorType; + /** + * The value that the actual field value will be compared with. + */ + values?: stringList; + } + export type OperatorType = "EQ"|"REF_EQ"|"LE"|"GE"|"BETWEEN"|string; + export interface ParameterAttribute { + /** + * The field identifier. + */ + key: attributeNameString; + /** + * The field value, expressed as a String. + */ + stringValue: attributeValueString; + } + export type ParameterAttributeList = ParameterAttribute[]; + export interface ParameterObject { + /** + * The ID of the parameter object. + */ + id: fieldNameString; + /** + * The attributes of the parameter object. + */ + attributes: ParameterAttributeList; + } + export type ParameterObjectList = ParameterObject[]; + export interface ParameterValue { + /** + * The ID of the parameter value. + */ + id: fieldNameString; + /** + * The field value, expressed as a String. + */ + stringValue: fieldStringValue; + } + export type ParameterValueList = ParameterValue[]; + export interface PipelineDescription { + /** + * The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE. + */ + pipelineId: id; + /** + * The name of the pipeline. + */ + name: id; + /** + * A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState. + */ + fields: fieldList; + /** + * Description of the pipeline. + */ + description?: string; + /** + * A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide. + */ + tags?: tagList; + } + export type PipelineDescriptionList = PipelineDescription[]; + export interface PipelineIdName { + /** + * The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE. + */ + id?: id; + /** + * The name of the pipeline. + */ + name?: id; + } + export interface PipelineObject { + /** + * The ID of the object. + */ + id: id; + /** + * The name of the object. + */ + name: id; + /** + * Key-value pairs that define the properties of the object. + */ + fields: fieldList; + } + export type PipelineObjectList = PipelineObject[]; + export type PipelineObjectMap = {[key: string]: PipelineObject}; + export interface PollForTaskInput { + /** + * The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match. + */ + workerGroup: string; + /** + * The public DNS name of the calling task runner. + */ + hostname?: id; + /** + * Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline. + */ + instanceIdentity?: InstanceIdentity; + } + export interface PollForTaskOutput { + /** + * The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus. + */ + taskObject?: TaskObject; + } + export interface PutPipelineDefinitionInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * The objects that define the pipeline. These objects overwrite the existing pipeline definition. + */ + pipelineObjects: PipelineObjectList; + /** + * The parameter objects used with the pipeline. + */ + parameterObjects?: ParameterObjectList; + /** + * The parameter values used with the pipeline. + */ + parameterValues?: ParameterValueList; + } + export interface PutPipelineDefinitionOutput { + /** + * The validation errors that are associated with the objects defined in pipelineObjects. + */ + validationErrors?: ValidationErrors; + /** + * The validation warnings that are associated with the objects defined in pipelineObjects. + */ + validationWarnings?: ValidationWarnings; + /** + * Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline. + */ + errored: boolean; + } + export interface Query { + /** + * List of selectors that define the query. An object must satisfy all of the selectors to match the query. + */ + selectors?: SelectorList; + } + export interface QueryObjectsInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts. + */ + query?: Query; + /** + * Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT. + */ + sphere: string; + /** + * The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results. + */ + marker?: string; + /** + * The maximum number of object names that QueryObjects will return in a single call. The default value is 100. + */ + limit?: int; + } + export interface QueryObjectsOutput { + /** + * The identifiers that match the query selectors. + */ + ids?: idList; + /** + * The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results. + */ + marker?: string; + /** + * Indicates whether there are more results that can be obtained by a subsequent call. + */ + hasMoreResults?: boolean; + } + export interface RemoveTagsInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * The keys of the tags to remove. + */ + tagKeys: stringList; + } + export interface RemoveTagsOutput { + } + export interface ReportTaskProgressInput { + /** + * The ID of the task assigned to the task runner. This value is provided in the response for PollForTask. + */ + taskId: taskId; + /** + * Key-value pairs that define the properties of the ReportTaskProgressInput object. + */ + fields?: fieldList; + } + export interface ReportTaskProgressOutput { + /** + * If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks. + */ + canceled: boolean; + } + export interface ReportTaskRunnerHeartbeatInput { + /** + * The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner. + */ + taskrunnerId: id; + /** + * The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match. + */ + workerGroup?: string; + /** + * The public DNS name of the task runner. + */ + hostname?: id; + } + export interface ReportTaskRunnerHeartbeatOutput { + /** + * Indicates whether the calling task runner should terminate. + */ + terminate: boolean; + } + export interface Selector { + /** + * The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails. + */ + fieldName?: string; + operator?: Operator; + } + export type SelectorList = Selector[]; + export interface SetStatusInput { + /** + * The ID of the pipeline that contains the objects. + */ + pipelineId: id; + /** + * The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types. + */ + objectIds: idList; + /** + * The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED. + */ + status: string; + } + export interface SetTaskStatusInput { + /** + * The ID of the task assigned to the task runner. This value is provided in the response for PollForTask. + */ + taskId: taskId; + /** + * If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false. + */ + taskStatus: TaskStatus; + /** + * If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system. + */ + errorId?: string; + /** + * If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value. + */ + errorMessage?: errorMessage; + /** + * If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value. + */ + errorStackTrace?: string; + } + export interface SetTaskStatusOutput { + } + export interface Tag { + /** + * The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide. + */ + key: tagKey; + /** + * The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide. + */ + value: tagValue; + } + export interface TaskObject { + /** + * An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions. + */ + taskId?: taskId; + /** + * The ID of the pipeline that provided the task. + */ + pipelineId?: id; + /** + * The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted. + */ + attemptId?: id; + /** + * Connection information for the location where the task runner will publish the output of the task. + */ + objects?: PipelineObjectMap; + } + export type TaskStatus = "FINISHED"|"FAILED"|"FALSE"|string; + export interface ValidatePipelineDefinitionInput { + /** + * The ID of the pipeline. + */ + pipelineId: id; + /** + * The objects that define the pipeline changes to validate against the pipeline. + */ + pipelineObjects: PipelineObjectList; + /** + * The parameter objects used with the pipeline. + */ + parameterObjects?: ParameterObjectList; + /** + * The parameter values used with the pipeline. + */ + parameterValues?: ParameterValueList; + } + export interface ValidatePipelineDefinitionOutput { + /** + * Any validation errors that were found. + */ + validationErrors?: ValidationErrors; + /** + * Any validation warnings that were found. + */ + validationWarnings?: ValidationWarnings; + /** + * Indicates whether there were validation errors. + */ + errored: boolean; + } + export interface ValidationError { + /** + * The identifier of the object that contains the validation error. + */ + id?: id; + /** + * A description of the validation error. + */ + errors?: validationMessages; + } + export type ValidationErrors = ValidationError[]; + export interface ValidationWarning { + /** + * The identifier of the object that contains the validation warning. + */ + id?: id; + /** + * A description of the validation warning. + */ + warnings?: validationMessages; + } + export type ValidationWarnings = ValidationWarning[]; + export type attributeNameString = string; + export type attributeValueString = string; + export type cancelActive = boolean; + export type errorMessage = string; + export type fieldList = Field[]; + export type fieldNameString = string; + export type fieldStringValue = string; + export type id = string; + export type idList = id[]; + export type int = number; + export type longString = string; + export type pipelineList = PipelineIdName[]; + export type stringList = string[]; + export type tagKey = string; + export type tagList = Tag[]; + export type tagValue = string; + export type taskId = string; + export type timestamp = Date; + export type validationMessage = string; + export type validationMessages = validationMessage[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-10-29"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DataPipeline client. + */ + export import Types = DataPipeline; +} +export = DataPipeline; diff --git a/node_modules/aws-sdk/clients/datapipeline.js b/node_modules/aws-sdk/clients/datapipeline.js new file mode 100644 index 0000000..a55e1fa --- /dev/null +++ b/node_modules/aws-sdk/clients/datapipeline.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['datapipeline'] = {}; +AWS.DataPipeline = Service.defineService('datapipeline', ['2012-10-29']); +Object.defineProperty(apiLoader.services['datapipeline'], '2012-10-29', { + get: function get() { + var model = require('../apis/datapipeline-2012-10-29.min.json'); + model.paginators = require('../apis/datapipeline-2012-10-29.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DataPipeline; diff --git a/node_modules/aws-sdk/clients/datasync.d.ts b/node_modules/aws-sdk/clients/datasync.d.ts new file mode 100644 index 0000000..d736a77 --- /dev/null +++ b/node_modules/aws-sdk/clients/datasync.d.ts @@ -0,0 +1,938 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DataSync extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DataSync.Types.ClientConfiguration) + config: Config & DataSync.Types.ClientConfiguration; + /** + * Cancels execution of a task. When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution. + */ + cancelTaskExecution(params: DataSync.Types.CancelTaskExecutionRequest, callback?: (err: AWSError, data: DataSync.Types.CancelTaskExecutionResponse) => void): Request; + /** + * Cancels execution of a task. When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution. + */ + cancelTaskExecution(callback?: (err: AWSError, data: DataSync.Types.CancelTaskExecutionResponse) => void): Request; + /** + * Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region. You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. For more information, see Activating a Sync Agent in the AWS DataSync User Guide. Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks. + */ + createAgent(params: DataSync.Types.CreateAgentRequest, callback?: (err: AWSError, data: DataSync.Types.CreateAgentResponse) => void): Request; + /** + * Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region. You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. For more information, see Activating a Sync Agent in the AWS DataSync User Guide. Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks. + */ + createAgent(callback?: (err: AWSError, data: DataSync.Types.CreateAgentResponse) => void): Request; + /** + * Creates an endpoint for an Amazon EFS file system. + */ + createLocationEfs(params: DataSync.Types.CreateLocationEfsRequest, callback?: (err: AWSError, data: DataSync.Types.CreateLocationEfsResponse) => void): Request; + /** + * Creates an endpoint for an Amazon EFS file system. + */ + createLocationEfs(callback?: (err: AWSError, data: DataSync.Types.CreateLocationEfsResponse) => void): Request; + /** + * Creates an endpoint for a Network File System (NFS) file system. + */ + createLocationNfs(params: DataSync.Types.CreateLocationNfsRequest, callback?: (err: AWSError, data: DataSync.Types.CreateLocationNfsResponse) => void): Request; + /** + * Creates an endpoint for a Network File System (NFS) file system. + */ + createLocationNfs(callback?: (err: AWSError, data: DataSync.Types.CreateLocationNfsResponse) => void): Request; + /** + * Creates an endpoint for an Amazon S3 bucket. For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section. For more information, see Configuring Amazon S3 Location Settings in the AWS DataSync User Guide. + */ + createLocationS3(params: DataSync.Types.CreateLocationS3Request, callback?: (err: AWSError, data: DataSync.Types.CreateLocationS3Response) => void): Request; + /** + * Creates an endpoint for an Amazon S3 bucket. For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section. For more information, see Configuring Amazon S3 Location Settings in the AWS DataSync User Guide. + */ + createLocationS3(callback?: (err: AWSError, data: DataSync.Types.CreateLocationS3Response) => void): Request; + /** + * Creates a task. A task is a set of two locations (source and destination) and a set of default OverrideOptions that you use to control the behavior of a task. If you don't specify default values for Options when you create a task, AWS DataSync populates them with safe service defaults. When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every task execution. If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name. + */ + createTask(params: DataSync.Types.CreateTaskRequest, callback?: (err: AWSError, data: DataSync.Types.CreateTaskResponse) => void): Request; + /** + * Creates a task. A task is a set of two locations (source and destination) and a set of default OverrideOptions that you use to control the behavior of a task. If you don't specify default values for Options when you create a task, AWS DataSync populates them with safe service defaults. When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every task execution. If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name. + */ + createTask(callback?: (err: AWSError, data: DataSync.Types.CreateTaskResponse) => void): Request; + /** + * Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment. After you delete an agent, you can't reactivate it and you longer pay software charges for it. + */ + deleteAgent(params: DataSync.Types.DeleteAgentRequest, callback?: (err: AWSError, data: DataSync.Types.DeleteAgentResponse) => void): Request; + /** + * Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment. After you delete an agent, you can't reactivate it and you longer pay software charges for it. + */ + deleteAgent(callback?: (err: AWSError, data: DataSync.Types.DeleteAgentResponse) => void): Request; + /** + * Deletes the configuration of a location used by AWS DataSync. + */ + deleteLocation(params: DataSync.Types.DeleteLocationRequest, callback?: (err: AWSError, data: DataSync.Types.DeleteLocationResponse) => void): Request; + /** + * Deletes the configuration of a location used by AWS DataSync. + */ + deleteLocation(callback?: (err: AWSError, data: DataSync.Types.DeleteLocationResponse) => void): Request; + /** + * Deletes a task. + */ + deleteTask(params: DataSync.Types.DeleteTaskRequest, callback?: (err: AWSError, data: DataSync.Types.DeleteTaskResponse) => void): Request; + /** + * Deletes a task. + */ + deleteTask(callback?: (err: AWSError, data: DataSync.Types.DeleteTaskResponse) => void): Request; + /** + * Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request. + */ + describeAgent(params: DataSync.Types.DescribeAgentRequest, callback?: (err: AWSError, data: DataSync.Types.DescribeAgentResponse) => void): Request; + /** + * Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request. + */ + describeAgent(callback?: (err: AWSError, data: DataSync.Types.DescribeAgentResponse) => void): Request; + /** + * Returns metadata, such as the path information about an Amazon EFS location. + */ + describeLocationEfs(params: DataSync.Types.DescribeLocationEfsRequest, callback?: (err: AWSError, data: DataSync.Types.DescribeLocationEfsResponse) => void): Request; + /** + * Returns metadata, such as the path information about an Amazon EFS location. + */ + describeLocationEfs(callback?: (err: AWSError, data: DataSync.Types.DescribeLocationEfsResponse) => void): Request; + /** + * Returns metadata, such as the path information, about a NFS location. + */ + describeLocationNfs(params: DataSync.Types.DescribeLocationNfsRequest, callback?: (err: AWSError, data: DataSync.Types.DescribeLocationNfsResponse) => void): Request; + /** + * Returns metadata, such as the path information, about a NFS location. + */ + describeLocationNfs(callback?: (err: AWSError, data: DataSync.Types.DescribeLocationNfsResponse) => void): Request; + /** + * Returns metadata, such as bucket name, about an Amazon S3 bucket location. + */ + describeLocationS3(params: DataSync.Types.DescribeLocationS3Request, callback?: (err: AWSError, data: DataSync.Types.DescribeLocationS3Response) => void): Request; + /** + * Returns metadata, such as bucket name, about an Amazon S3 bucket location. + */ + describeLocationS3(callback?: (err: AWSError, data: DataSync.Types.DescribeLocationS3Response) => void): Request; + /** + * Returns metadata about a task. + */ + describeTask(params: DataSync.Types.DescribeTaskRequest, callback?: (err: AWSError, data: DataSync.Types.DescribeTaskResponse) => void): Request; + /** + * Returns metadata about a task. + */ + describeTask(callback?: (err: AWSError, data: DataSync.Types.DescribeTaskResponse) => void): Request; + /** + * Returns detailed metadata about a task that is being executed. + */ + describeTaskExecution(params: DataSync.Types.DescribeTaskExecutionRequest, callback?: (err: AWSError, data: DataSync.Types.DescribeTaskExecutionResponse) => void): Request; + /** + * Returns detailed metadata about a task that is being executed. + */ + describeTaskExecution(callback?: (err: AWSError, data: DataSync.Types.DescribeTaskExecutionResponse) => void): Request; + /** + * Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN). By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response. If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents. + */ + listAgents(params: DataSync.Types.ListAgentsRequest, callback?: (err: AWSError, data: DataSync.Types.ListAgentsResponse) => void): Request; + /** + * Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN). By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response. If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents. + */ + listAgents(callback?: (err: AWSError, data: DataSync.Types.ListAgentsResponse) => void): Request; + /** + * Returns a lists of source and destination locations. If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations. + */ + listLocations(params: DataSync.Types.ListLocationsRequest, callback?: (err: AWSError, data: DataSync.Types.ListLocationsResponse) => void): Request; + /** + * Returns a lists of source and destination locations. If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations. + */ + listLocations(callback?: (err: AWSError, data: DataSync.Types.ListLocationsResponse) => void): Request; + /** + * Returns all the tags associated with a specified resources. + */ + listTagsForResource(params: DataSync.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DataSync.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns all the tags associated with a specified resources. + */ + listTagsForResource(callback?: (err: AWSError, data: DataSync.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns a list of executed tasks. + */ + listTaskExecutions(params: DataSync.Types.ListTaskExecutionsRequest, callback?: (err: AWSError, data: DataSync.Types.ListTaskExecutionsResponse) => void): Request; + /** + * Returns a list of executed tasks. + */ + listTaskExecutions(callback?: (err: AWSError, data: DataSync.Types.ListTaskExecutionsResponse) => void): Request; + /** + * Returns a list of all the tasks. + */ + listTasks(params: DataSync.Types.ListTasksRequest, callback?: (err: AWSError, data: DataSync.Types.ListTasksResponse) => void): Request; + /** + * Returns a list of all the tasks. + */ + listTasks(callback?: (err: AWSError, data: DataSync.Types.ListTasksResponse) => void): Request; + /** + * Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. For detailed information, see Task Execution in Components and Terminology in the AWS DataSync User Guide. + */ + startTaskExecution(params: DataSync.Types.StartTaskExecutionRequest, callback?: (err: AWSError, data: DataSync.Types.StartTaskExecutionResponse) => void): Request; + /** + * Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. For detailed information, see Task Execution in Components and Terminology in the AWS DataSync User Guide. + */ + startTaskExecution(callback?: (err: AWSError, data: DataSync.Types.StartTaskExecutionResponse) => void): Request; + /** + * Applies a key-value pair to an AWS resource. + */ + tagResource(params: DataSync.Types.TagResourceRequest, callback?: (err: AWSError, data: DataSync.Types.TagResourceResponse) => void): Request; + /** + * Applies a key-value pair to an AWS resource. + */ + tagResource(callback?: (err: AWSError, data: DataSync.Types.TagResourceResponse) => void): Request; + /** + * Removes a tag from an AWS resource. + */ + untagResource(params: DataSync.Types.UntagResourceRequest, callback?: (err: AWSError, data: DataSync.Types.UntagResourceResponse) => void): Request; + /** + * Removes a tag from an AWS resource. + */ + untagResource(callback?: (err: AWSError, data: DataSync.Types.UntagResourceResponse) => void): Request; + /** + * Updates the name of an agent. + */ + updateAgent(params: DataSync.Types.UpdateAgentRequest, callback?: (err: AWSError, data: DataSync.Types.UpdateAgentResponse) => void): Request; + /** + * Updates the name of an agent. + */ + updateAgent(callback?: (err: AWSError, data: DataSync.Types.UpdateAgentResponse) => void): Request; + /** + * Updates the metadata associated with a task. + */ + updateTask(params: DataSync.Types.UpdateTaskRequest, callback?: (err: AWSError, data: DataSync.Types.UpdateTaskResponse) => void): Request; + /** + * Updates the metadata associated with a task. + */ + updateTask(callback?: (err: AWSError, data: DataSync.Types.UpdateTaskResponse) => void): Request; +} +declare namespace DataSync { + export type ActivationKey = string; + export type AgentArn = string; + export type AgentArnList = AgentArn[]; + export type AgentList = AgentListEntry[]; + export interface AgentListEntry { + /** + * The Amazon Resource Name (ARN) of the agent. + */ + AgentArn?: AgentArn; + /** + * The name of the agent. + */ + Name?: TagValue; + /** + * The status of the agent. + */ + Status?: AgentStatus; + } + export type AgentStatus = "ONLINE"|"OFFLINE"|string; + export type Atime = "NONE"|"BEST_EFFORT"|string; + export type BytesPerSecond = number; + export interface CancelTaskExecutionRequest { + /** + * The Amazon Resource Name (ARN) of the task execution to cancel. + */ + TaskExecutionArn: TaskExecutionArn; + } + export interface CancelTaskExecutionResponse { + } + export interface CreateAgentRequest { + /** + * Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console. The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent. For more information, see Activating a Sync Agent in the AWS DataSync User Guide. + */ + ActivationKey: ActivationKey; + /** + * The name you configured for your agent. This value is a text reference that is used to identify the agent in the console. + */ + AgentName?: TagValue; + /** + * The key-value pair that represents the tag you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. + */ + Tags?: TagList; + } + export interface CreateAgentResponse { + /** + * The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and AWS Region. + */ + AgentArn?: AgentArn; + } + export interface CreateLocationEfsRequest { + /** + * A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory. + */ + Subdirectory: Subdirectory; + /** + * The Amazon Resource Name (ARN) for the Amazon EFS file system. + */ + EfsFilesystemArn: EfsFilesystemArn; + /** + * The subnet and security group that the Amazon EFS file system uses. + */ + Ec2Config: Ec2Config; + /** + * The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location. + */ + Tags?: TagList; + } + export interface CreateLocationEfsResponse { + /** + * The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created. + */ + LocationArn?: LocationArn; + } + export interface CreateLocationNfsRequest { + /** + * The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. To see all the paths exported by your NFS server. run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want sync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access. For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Centos documentation. + */ + Subdirectory: Subdirectory; + /** + * The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network. This name must either be DNS-compliant or must be an IP version 4 (IPv4) address. + */ + ServerHostname: ServerHostname; + /** + * Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. + */ + OnPremConfig: OnPremConfig; + /** + * The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources. + */ + Tags?: TagList; + } + export interface CreateLocationNfsResponse { + /** + * The Amazon Resource Name (ARN) of the source NFS file system location that is created. + */ + LocationArn?: LocationArn; + } + export interface CreateLocationS3Request { + /** + * A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination. + */ + Subdirectory: Subdirectory; + /** + * The Amazon Resource Name (ARN) of the Amazon S3 bucket. + */ + S3BucketArn: S3BucketArn; + S3Config: S3Config; + /** + * The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources. + */ + Tags?: TagList; + } + export interface CreateLocationS3Response { + /** + * The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created. + */ + LocationArn?: LocationArn; + } + export interface CreateTaskRequest { + /** + * The Amazon Resource Name (ARN) of the source location for the task. + */ + SourceLocationArn: LocationArn; + /** + * The Amazon Resource Name (ARN) of an AWS storage resource's location. + */ + DestinationLocationArn: LocationArn; + /** + * The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide. For more information about how to useCloudWatchLogs with DataSync, see Monitoring Your Task. + */ + CloudWatchLogGroupArn?: LogGroupArn; + /** + * The name of a task. This value is a text reference that is used to identify the task in the console. + */ + Name?: TagValue; + /** + * The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on. For each individual task execution, you can override these options by specifying the OverrideOptions before starting a the task execution. For more information, see the operation. + */ + Options?: Options; + /** + * The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string. + */ + Tags?: TagList; + } + export interface CreateTaskResponse { + /** + * The Amazon Resource Name (ARN) of the task. + */ + TaskArn?: TaskArn; + } + export interface DeleteAgentRequest { + /** + * The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and AWS Region. + */ + AgentArn: AgentArn; + } + export interface DeleteAgentResponse { + } + export interface DeleteLocationRequest { + /** + * The Amazon Resource Name (ARN) of the location to delete. + */ + LocationArn: LocationArn; + } + export interface DeleteLocationResponse { + } + export interface DeleteTaskRequest { + /** + * The Amazon Resource Name (ARN) of the task to delete. + */ + TaskArn: TaskArn; + } + export interface DeleteTaskResponse { + } + export interface DescribeAgentRequest { + /** + * The Amazon Resource Name (ARN) of the agent to describe. + */ + AgentArn: AgentArn; + } + export interface DescribeAgentResponse { + /** + * The Amazon Resource Name (ARN) of the agent. + */ + AgentArn?: AgentArn; + /** + * The name of the agent. + */ + Name?: TagValue; + /** + * The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status. + */ + Status?: AgentStatus; + /** + * The time that the agent was last connected. + */ + LastConnectionTime?: Time; + /** + * The time that the agent was activated (that is, created in your account). + */ + CreationTime?: Time; + } + export interface DescribeLocationEfsRequest { + /** + * The Amazon Resource Name (ARN) of the EFS location to describe. + */ + LocationArn: LocationArn; + } + export interface DescribeLocationEfsResponse { + /** + * The Amazon resource Name (ARN) of the EFS location that was described. + */ + LocationArn?: LocationArn; + /** + * The URL of the EFS location that was described. + */ + LocationUri?: LocationUri; + Ec2Config?: Ec2Config; + /** + * The time that the EFS location was created. + */ + CreationTime?: Time; + } + export interface DescribeLocationNfsRequest { + /** + * The Amazon resource Name (ARN) of the NFS location to describe. + */ + LocationArn: LocationArn; + } + export interface DescribeLocationNfsResponse { + /** + * The Amazon resource Name (ARN) of the NFS location that was described. + */ + LocationArn?: LocationArn; + /** + * The URL of the source NFS location that was described. + */ + LocationUri?: LocationUri; + OnPremConfig?: OnPremConfig; + /** + * The time that the NFS location was created. + */ + CreationTime?: Time; + } + export interface DescribeLocationS3Request { + /** + * The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe. + */ + LocationArn: LocationArn; + } + export interface DescribeLocationS3Response { + /** + * The Amazon Resource Name (ARN) of the Amazon S3 bucket location. + */ + LocationArn?: LocationArn; + /** + * The URL of the Amazon S3 location that was described. + */ + LocationUri?: LocationUri; + S3Config?: S3Config; + /** + * The time that the Amazon S3 bucket location was created. + */ + CreationTime?: Time; + } + export interface DescribeTaskExecutionRequest { + /** + * The Amazon Resource Name (ARN) of the task that is being executed. + */ + TaskExecutionArn: TaskExecutionArn; + } + export interface DescribeTaskExecutionResponse { + /** + * The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed. For example, a TaskExecution value with the ARN arn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2. + */ + TaskExecutionArn?: TaskExecutionArn; + /** + * The status of the task. For detailed information about sync statuses, see Understanding Sync Task Statuses. + */ + Status?: TaskExecutionStatus; + Options?: Options; + /** + * The time that the task execution was started. + */ + StartTime?: Time; + /** + * The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred. + */ + EstimatedFilesToTransfer?: long; + /** + * The estimated physical number of bytes that is to be transferred over the network. + */ + EstimatedBytesToTransfer?: long; + /** + * The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network. If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution. + */ + FilesTransferred?: long; + /** + * The number of logical bytes written to the destination AWS storage resource. + */ + BytesWritten?: long; + /** + * The physical number of bytes transferred over the network. + */ + BytesTransferred?: long; + /** + * The result of the task execution. + */ + Result?: TaskExecutionResultDetail; + } + export interface DescribeTaskRequest { + /** + * The Amazon Resource Name (ARN) of the task to describe. + */ + TaskArn: TaskArn; + } + export interface DescribeTaskResponse { + /** + * The Amazon Resource Name (ARN) of the task that was described. + */ + TaskArn?: TaskArn; + /** + * The status of the task that was described. For detailed information about sync statuses, see Understanding Sync Task Statuses. + */ + Status?: TaskStatus; + /** + * The name of the task that was described. + */ + Name?: TagValue; + /** + * The Amazon Resource Name (ARN) of the task execution that is syncing files. + */ + CurrentTaskExecutionArn?: TaskExecutionArn; + /** + * The Amazon Resource Name (ARN) of the source file system's location. + */ + SourceLocationArn?: LocationArn; + /** + * The Amazon Resource Name (ARN) of the AWS storage resource's location. + */ + DestinationLocationArn?: LocationArn; + /** + * The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task. For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide. + */ + CloudWatchLogGroupArn?: LogGroupArn; + /** + * The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on. For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation. + */ + Options?: Options; + /** + * Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues. + */ + ErrorCode?: string; + /** + * Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues. + */ + ErrorDetail?: string; + /** + * The time that the task was created. + */ + CreationTime?: Time; + } + export type Duration = number; + export interface Ec2Config { + /** + * The ARN of the subnet that the Amazon EC2 resource belongs in. + */ + SubnetArn: Ec2SubnetArn; + /** + * The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource. + */ + SecurityGroupArns: Ec2SecurityGroupArnList; + } + export type Ec2SecurityGroupArn = string; + export type Ec2SecurityGroupArnList = Ec2SecurityGroupArn[]; + export type Ec2SubnetArn = string; + export type EfsFilesystemArn = string; + export type Gid = "NONE"|"INT_VALUE"|"NAME"|"BOTH"|string; + export type IamRoleArn = string; + export interface ListAgentsRequest { + /** + * The maximum number of agents to list. + */ + MaxResults?: MaxResults; + /** + * An opaque string that indicates the position at which to begin the next list of agents. + */ + NextToken?: NextToken; + } + export interface ListAgentsResponse { + /** + * A list of agents in your account. + */ + Agents?: AgentList; + /** + * An opaque string that indicates the position at which to begin returning the next list of agents. + */ + NextToken?: NextToken; + } + export interface ListLocationsRequest { + /** + * The maximum number of locations to return. + */ + MaxResults?: MaxResults; + /** + * An opaque string that indicates the position at which to begin the next list of locations. + */ + NextToken?: NextToken; + } + export interface ListLocationsResponse { + /** + * An array that contains a list of locations. + */ + Locations?: LocationList; + /** + * An opaque string that indicates the position at which to begin returning the next list of locations. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource whose tags to list. + */ + ResourceArn: TaggableResourceArn; + /** + * The maximum number of locations to return. + */ + MaxResults?: MaxResults; + /** + * An opaque string that indicates the position at which to begin the next list of locations. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceResponse { + /** + * Array of resource tags. + */ + Tags?: TagList; + /** + * An opaque string that indicates the position at which to begin returning the next list of resource tags. + */ + NextToken?: NextToken; + } + export interface ListTaskExecutionsRequest { + /** + * The Amazon Resource Name (ARN) of the task whose tasks you want to list. + */ + TaskArn?: TaskArn; + /** + * The maximum number of executed tasks to list. + */ + MaxResults?: MaxResults; + /** + * An opaque string that indicates the position at which to begin the next list of the executed tasks. + */ + NextToken?: NextToken; + } + export interface ListTaskExecutionsResponse { + /** + * A list of executed tasks. + */ + TaskExecutions?: TaskExecutionList; + /** + * An opaque string that indicates the position at which to begin returning the next list of executed tasks. + */ + NextToken?: NextToken; + } + export interface ListTasksRequest { + /** + * The maximum number of tasks to return. + */ + MaxResults?: MaxResults; + /** + * An opaque string that indicates the position at which to begin the next list of tasks. + */ + NextToken?: NextToken; + } + export interface ListTasksResponse { + /** + * A list of all the tasks that are returned. + */ + Tasks?: TaskList; + /** + * An opaque string that indicates the position at which to begin returning the next list of tasks. + */ + NextToken?: NextToken; + } + export type LocationArn = string; + export type LocationList = LocationListEntry[]; + export interface LocationListEntry { + /** + * The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location. + */ + LocationArn?: LocationArn; + /** + * Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called. Format: TYPE://GLOBAL_ID/SUBDIR. TYPE designates the type of location. Valid values: NFS | EFS | S3. GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS). SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location. + */ + LocationUri?: LocationUri; + } + export type LocationUri = string; + export type LogGroupArn = string; + export type MaxResults = number; + export type Mtime = "NONE"|"PRESERVE"|string; + export type NextToken = string; + export interface OnPremConfig { + /** + * ARNs)of the agents to use for an NFS location. + */ + AgentArns: AgentArnList; + } + export interface Options { + /** + * A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Default value: POINT_IN_TIME_CONSISTENT. POINT_IN_TIME_CONSISTENT: Perform verification (recommended). NONE: Skip verification. + */ + VerifyMode?: VerifyMode; + /** + * A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis. Default value: BEST_EFFORT. BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended). NONE: Ignore Atime. If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE. + */ + Atime?: Atime; + /** + * A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. Default value: PRESERVE. PRESERVE: Preserve original Mtime (recommended) NONE: Ignore Mtime. If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE. + */ + Mtime?: Mtime; + /** + * The user ID (UID) of the file's owner. Default value: INT_VALUE. This preserves the integer value of the ID. INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended). NONE: Ignore UID and GID. + */ + Uid?: Uid; + /** + * The group ID (GID) of the file's owners. Default value: INT_VALUE. This preserves the integer value of the ID. INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended). NONE: Ignore UID and GID. + */ + Gid?: Gid; + /** + * A value that specifies whether files in the destination that don't exist in the source file system should be preserved. Default value: PRESERVE. PRESERVE: Ignore such destination files (recommended). REMOVE: Delete destination files that aren’t present in the source. + */ + PreserveDeletedFiles?: PreserveDeletedFiles; + /** + * A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination. AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker. Default value: NONE. NONE: Ignore special devices (recommended). PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS. + */ + PreserveDevices?: PreserveDevices; + /** + * A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Default value: PRESERVE. PRESERVE: Preserve POSIX-style permissions (recommended). NONE: Ignore permissions. AWS DataSync can preserve extant permissions of a source location. + */ + PosixPermissions?: PosixPermissions; + /** + * A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024). + */ + BytesPerSecond?: BytesPerSecond; + } + export type PhaseStatus = "PENDING"|"SUCCESS"|"ERROR"|string; + export type PosixPermissions = "NONE"|"BEST_EFFORT"|"PRESERVE"|string; + export type PreserveDeletedFiles = "PRESERVE"|"REMOVE"|string; + export type PreserveDevices = "NONE"|"PRESERVE"|string; + export type S3BucketArn = string; + export interface S3Config { + /** + * The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation. + */ + BucketAccessRoleArn: IamRoleArn; + } + export type ServerHostname = string; + export interface StartTaskExecutionRequest { + /** + * The Amazon Resource Name (ARN) of the task to start. + */ + TaskArn: TaskArn; + OverrideOptions?: Options; + } + export interface StartTaskExecutionResponse { + /** + * The Amazon Resource Name (ARN) of the specific task execution that was started. + */ + TaskExecutionArn?: TaskExecutionArn; + } + export type Subdirectory = string; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = TagListEntry[]; + export interface TagListEntry { + /** + * The key for an AWS resource tag. + */ + Key?: TagKey; + /** + * The value for an AWS resource tag. + */ + Value?: TagValue; + } + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource to apply the tag to. + */ + ResourceArn: TaggableResourceArn; + /** + * The tags to apply. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type TaggableResourceArn = string; + export type TaskArn = string; + export type TaskExecutionArn = string; + export type TaskExecutionList = TaskExecutionListEntry[]; + export interface TaskExecutionListEntry { + /** + * The Amazon Resource Name (ARN) of the task that was executed. + */ + TaskExecutionArn?: TaskExecutionArn; + /** + * The status of a task execution. + */ + Status?: TaskExecutionStatus; + } + export interface TaskExecutionResultDetail { + /** + * The total time in milliseconds that AWS DataSync spent in the PREPARING phase. + */ + PrepareDuration?: Duration; + /** + * The status of the PREPARING phase. + */ + PrepareStatus?: PhaseStatus; + /** + * The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase. + */ + TransferDuration?: Duration; + /** + * The status of the TRANSFERRING Phase. + */ + TransferStatus?: PhaseStatus; + /** + * The total time in milliseconds that AWS DataSync spent in the VERIFYING phase. + */ + VerifyDuration?: Duration; + /** + * The status of the VERIFYING Phase. + */ + VerifyStatus?: PhaseStatus; + /** + * Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues. + */ + ErrorCode?: string; + /** + * Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues. + */ + ErrorDetail?: string; + } + export type TaskExecutionStatus = "LAUNCHING"|"PREPARING"|"TRANSFERRING"|"VERIFYING"|"SUCCESS"|"ERROR"|string; + export type TaskList = TaskListEntry[]; + export interface TaskListEntry { + /** + * The Amazon Resource Name (ARN) of the task. + */ + TaskArn?: TaskArn; + /** + * The status of the task. + */ + Status?: TaskStatus; + /** + * The name of the task. + */ + Name?: TagValue; + } + export type TaskStatus = "AVAILABLE"|"CREATING"|"RUNNING"|"UNAVAILABLE"|string; + export type Time = Date; + export type Uid = "NONE"|"INT_VALUE"|"NAME"|"BOTH"|string; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource to remove the tag from. + */ + ResourceArn: TaggableResourceArn; + /** + * The keys in the key-value pair in the tag to remove. + */ + Keys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateAgentRequest { + /** + * The Amazon Resource Name (ARN) of the agent to update. + */ + AgentArn: AgentArn; + /** + * The name that you want to use to configure the agent. + */ + Name?: TagValue; + } + export interface UpdateAgentResponse { + } + export interface UpdateTaskRequest { + /** + * The Amazon Resource Name (ARN) of the resource name of the task to update. + */ + TaskArn: TaskArn; + Options?: Options; + /** + * The name of the task to update. + */ + Name?: TagValue; + } + export interface UpdateTaskResponse { + } + export type VerifyMode = "POINT_IN_TIME_CONSISTENT"|"NONE"|string; + export type long = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-11-09"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DataSync client. + */ + export import Types = DataSync; +} +export = DataSync; diff --git a/node_modules/aws-sdk/clients/datasync.js b/node_modules/aws-sdk/clients/datasync.js new file mode 100644 index 0000000..2c15d11 --- /dev/null +++ b/node_modules/aws-sdk/clients/datasync.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['datasync'] = {}; +AWS.DataSync = Service.defineService('datasync', ['2018-11-09']); +Object.defineProperty(apiLoader.services['datasync'], '2018-11-09', { + get: function get() { + var model = require('../apis/datasync-2018-11-09.min.json'); + model.paginators = require('../apis/datasync-2018-11-09.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DataSync; diff --git a/node_modules/aws-sdk/clients/dax.d.ts b/node_modules/aws-sdk/clients/dax.d.ts new file mode 100644 index 0000000..5ead1f4 --- /dev/null +++ b/node_modules/aws-sdk/clients/dax.d.ts @@ -0,0 +1,985 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DAX extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DAX.Types.ClientConfiguration) + config: Config & DAX.Types.ClientConfiguration; + /** + * Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. + */ + createCluster(params: DAX.Types.CreateClusterRequest, callback?: (err: AWSError, data: DAX.Types.CreateClusterResponse) => void): Request; + /** + * Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. + */ + createCluster(callback?: (err: AWSError, data: DAX.Types.CreateClusterResponse) => void): Request; + /** + * Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster. + */ + createParameterGroup(params: DAX.Types.CreateParameterGroupRequest, callback?: (err: AWSError, data: DAX.Types.CreateParameterGroupResponse) => void): Request; + /** + * Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster. + */ + createParameterGroup(callback?: (err: AWSError, data: DAX.Types.CreateParameterGroupResponse) => void): Request; + /** + * Creates a new subnet group. + */ + createSubnetGroup(params: DAX.Types.CreateSubnetGroupRequest, callback?: (err: AWSError, data: DAX.Types.CreateSubnetGroupResponse) => void): Request; + /** + * Creates a new subnet group. + */ + createSubnetGroup(callback?: (err: AWSError, data: DAX.Types.CreateSubnetGroupResponse) => void): Request; + /** + * Removes one or more nodes from a DAX cluster. You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead. + */ + decreaseReplicationFactor(params: DAX.Types.DecreaseReplicationFactorRequest, callback?: (err: AWSError, data: DAX.Types.DecreaseReplicationFactorResponse) => void): Request; + /** + * Removes one or more nodes from a DAX cluster. You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead. + */ + decreaseReplicationFactor(callback?: (err: AWSError, data: DAX.Types.DecreaseReplicationFactorResponse) => void): Request; + /** + * Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action. + */ + deleteCluster(params: DAX.Types.DeleteClusterRequest, callback?: (err: AWSError, data: DAX.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action. + */ + deleteCluster(callback?: (err: AWSError, data: DAX.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters. + */ + deleteParameterGroup(params: DAX.Types.DeleteParameterGroupRequest, callback?: (err: AWSError, data: DAX.Types.DeleteParameterGroupResponse) => void): Request; + /** + * Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters. + */ + deleteParameterGroup(callback?: (err: AWSError, data: DAX.Types.DeleteParameterGroupResponse) => void): Request; + /** + * Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters. + */ + deleteSubnetGroup(params: DAX.Types.DeleteSubnetGroupRequest, callback?: (err: AWSError, data: DAX.Types.DeleteSubnetGroupResponse) => void): Request; + /** + * Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters. + */ + deleteSubnetGroup(callback?: (err: AWSError, data: DAX.Types.DeleteSubnetGroupResponse) => void): Request; + /** + * Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied. If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. If the cluster is in the DELETING state, only cluster level information will be displayed. If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use. If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed. + */ + describeClusters(params: DAX.Types.DescribeClustersRequest, callback?: (err: AWSError, data: DAX.Types.DescribeClustersResponse) => void): Request; + /** + * Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied. If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. If the cluster is in the DELETING state, only cluster level information will be displayed. If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use. If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed. + */ + describeClusters(callback?: (err: AWSError, data: DAX.Types.DescribeClustersResponse) => void): Request; + /** + * Returns the default system parameter information for the DAX caching software. + */ + describeDefaultParameters(params: DAX.Types.DescribeDefaultParametersRequest, callback?: (err: AWSError, data: DAX.Types.DescribeDefaultParametersResponse) => void): Request; + /** + * Returns the default system parameter information for the DAX caching software. + */ + describeDefaultParameters(callback?: (err: AWSError, data: DAX.Types.DescribeDefaultParametersResponse) => void): Request; + /** + * Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. + */ + describeEvents(params: DAX.Types.DescribeEventsRequest, callback?: (err: AWSError, data: DAX.Types.DescribeEventsResponse) => void): Request; + /** + * Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. + */ + describeEvents(callback?: (err: AWSError, data: DAX.Types.DescribeEventsResponse) => void): Request; + /** + * Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group. + */ + describeParameterGroups(params: DAX.Types.DescribeParameterGroupsRequest, callback?: (err: AWSError, data: DAX.Types.DescribeParameterGroupsResponse) => void): Request; + /** + * Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group. + */ + describeParameterGroups(callback?: (err: AWSError, data: DAX.Types.DescribeParameterGroupsResponse) => void): Request; + /** + * Returns the detailed parameter list for a particular parameter group. + */ + describeParameters(params: DAX.Types.DescribeParametersRequest, callback?: (err: AWSError, data: DAX.Types.DescribeParametersResponse) => void): Request; + /** + * Returns the detailed parameter list for a particular parameter group. + */ + describeParameters(callback?: (err: AWSError, data: DAX.Types.DescribeParametersResponse) => void): Request; + /** + * Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. + */ + describeSubnetGroups(params: DAX.Types.DescribeSubnetGroupsRequest, callback?: (err: AWSError, data: DAX.Types.DescribeSubnetGroupsResponse) => void): Request; + /** + * Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. + */ + describeSubnetGroups(callback?: (err: AWSError, data: DAX.Types.DescribeSubnetGroupsResponse) => void): Request; + /** + * Adds one or more nodes to a DAX cluster. + */ + increaseReplicationFactor(params: DAX.Types.IncreaseReplicationFactorRequest, callback?: (err: AWSError, data: DAX.Types.IncreaseReplicationFactorResponse) => void): Request; + /** + * Adds one or more nodes to a DAX cluster. + */ + increaseReplicationFactor(callback?: (err: AWSError, data: DAX.Types.IncreaseReplicationFactorResponse) => void): Request; + /** + * List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account. + */ + listTags(params: DAX.Types.ListTagsRequest, callback?: (err: AWSError, data: DAX.Types.ListTagsResponse) => void): Request; + /** + * List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account. + */ + listTags(callback?: (err: AWSError, data: DAX.Types.ListTagsResponse) => void): Request; + /** + * Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING. + */ + rebootNode(params: DAX.Types.RebootNodeRequest, callback?: (err: AWSError, data: DAX.Types.RebootNodeResponse) => void): Request; + /** + * Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING. + */ + rebootNode(callback?: (err: AWSError, data: DAX.Types.RebootNodeResponse) => void): Request; + /** + * Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account. + */ + tagResource(params: DAX.Types.TagResourceRequest, callback?: (err: AWSError, data: DAX.Types.TagResourceResponse) => void): Request; + /** + * Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account. + */ + tagResource(callback?: (err: AWSError, data: DAX.Types.TagResourceResponse) => void): Request; + /** + * Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account. + */ + untagResource(params: DAX.Types.UntagResourceRequest, callback?: (err: AWSError, data: DAX.Types.UntagResourceResponse) => void): Request; + /** + * Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account. + */ + untagResource(callback?: (err: AWSError, data: DAX.Types.UntagResourceResponse) => void): Request; + /** + * Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. + */ + updateCluster(params: DAX.Types.UpdateClusterRequest, callback?: (err: AWSError, data: DAX.Types.UpdateClusterResponse) => void): Request; + /** + * Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. + */ + updateCluster(callback?: (err: AWSError, data: DAX.Types.UpdateClusterResponse) => void): Request; + /** + * Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. + */ + updateParameterGroup(params: DAX.Types.UpdateParameterGroupRequest, callback?: (err: AWSError, data: DAX.Types.UpdateParameterGroupResponse) => void): Request; + /** + * Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. + */ + updateParameterGroup(callback?: (err: AWSError, data: DAX.Types.UpdateParameterGroupResponse) => void): Request; + /** + * Modifies an existing subnet group. + */ + updateSubnetGroup(params: DAX.Types.UpdateSubnetGroupRequest, callback?: (err: AWSError, data: DAX.Types.UpdateSubnetGroupResponse) => void): Request; + /** + * Modifies an existing subnet group. + */ + updateSubnetGroup(callback?: (err: AWSError, data: DAX.Types.UpdateSubnetGroupResponse) => void): Request; +} +declare namespace DAX { + export type AvailabilityZoneList = String[]; + export type ChangeType = "IMMEDIATE"|"REQUIRES_REBOOT"|string; + export interface Cluster { + /** + * The name of the DAX cluster. + */ + ClusterName?: String; + /** + * The description of the cluster. + */ + Description?: String; + /** + * The Amazon Resource Name (ARN) that uniquely identifies the cluster. + */ + ClusterArn?: String; + /** + * The total number of nodes in the cluster. + */ + TotalNodes?: IntegerOptional; + /** + * The number of nodes in the cluster that are active (i.e., capable of serving requests). + */ + ActiveNodes?: IntegerOptional; + /** + * The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.) + */ + NodeType?: String; + /** + * The current status of the cluster. + */ + Status?: String; + /** + * The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster. + */ + ClusterDiscoveryEndpoint?: Endpoint; + /** + * A list of nodes to be removed from the cluster. + */ + NodeIdsToRemove?: NodeIdentifierList; + /** + * A list of nodes that are currently in the cluster. + */ + Nodes?: NodeList; + /** + * A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window. + */ + PreferredMaintenanceWindow?: String; + /** + * Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS). + */ + NotificationConfiguration?: NotificationConfiguration; + /** + * The subnet group where the DAX cluster is running. + */ + SubnetGroup?: String; + /** + * A list of security groups, and the status of each, for the nodes in the cluster. + */ + SecurityGroups?: SecurityGroupMembershipList; + /** + * A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf. + */ + IamRoleArn?: String; + /** + * The parameter group being used by nodes in the cluster. + */ + ParameterGroup?: ParameterGroupStatus; + /** + * The description of the server-side encryption status on the specified DAX cluster. + */ + SSEDescription?: SSEDescription; + } + export type ClusterList = Cluster[]; + export type ClusterNameList = String[]; + export interface CreateClusterRequest { + /** + * The cluster identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens. + */ + ClusterName: String; + /** + * The compute and memory capacity of the nodes in the cluster. + */ + NodeType: String; + /** + * A description of the cluster. + */ + Description?: String; + /** + * The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to 2 or more. AWS recommends that you have at least two read replicas per cluster. + */ + ReplicationFactor: Integer; + /** + * The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs. + */ + AvailabilityZones?: AvailabilityZoneList; + /** + * The name of the subnet group to be used for the replication group. DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC. + */ + SubnetGroupName?: String; + /** + * A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.) If this parameter is not specified, DAX assigns the default VPC security group to each node. + */ + SecurityGroupIds?: SecurityGroupIdentifierList; + /** + * Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:05:00-sun:09:00 If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week. + */ + PreferredMaintenanceWindow?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. The Amazon SNS topic owner must be same as the DAX cluster owner. + */ + NotificationTopicArn?: String; + /** + * A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf. + */ + IamRoleArn: String; + /** + * The parameter group to be associated with the DAX cluster. + */ + ParameterGroupName?: String; + /** + * A set of tags to associate with the DAX cluster. + */ + Tags?: TagList; + /** + * Represents the settings used to enable server-side encryption on the cluster. + */ + SSESpecification?: SSESpecification; + } + export interface CreateClusterResponse { + /** + * A description of the DAX cluster that you have created. + */ + Cluster?: Cluster; + } + export interface CreateParameterGroupRequest { + /** + * The name of the parameter group to apply to all of the clusters in this replication group. + */ + ParameterGroupName: String; + /** + * A description of the parameter group. + */ + Description?: String; + } + export interface CreateParameterGroupResponse { + /** + * Represents the output of a CreateParameterGroup action. + */ + ParameterGroup?: ParameterGroup; + } + export interface CreateSubnetGroupRequest { + /** + * A name for the subnet group. This value is stored as a lowercase string. + */ + SubnetGroupName: String; + /** + * A description for the subnet group + */ + Description?: String; + /** + * A list of VPC subnet IDs for the subnet group. + */ + SubnetIds: SubnetIdentifierList; + } + export interface CreateSubnetGroupResponse { + /** + * Represents the output of a CreateSubnetGroup operation. + */ + SubnetGroup?: SubnetGroup; + } + export interface DecreaseReplicationFactorRequest { + /** + * The name of the DAX cluster from which you want to remove nodes. + */ + ClusterName: String; + /** + * The new number of nodes for the DAX cluster. + */ + NewReplicationFactor: Integer; + /** + * The Availability Zone(s) from which to remove nodes. + */ + AvailabilityZones?: AvailabilityZoneList; + /** + * The unique identifiers of the nodes to be removed from the cluster. + */ + NodeIdsToRemove?: NodeIdentifierList; + } + export interface DecreaseReplicationFactorResponse { + /** + * A description of the DAX cluster, after you have decreased its replication factor. + */ + Cluster?: Cluster; + } + export interface DeleteClusterRequest { + /** + * The name of the cluster to be deleted. + */ + ClusterName: String; + } + export interface DeleteClusterResponse { + /** + * A description of the DAX cluster that is being deleted. + */ + Cluster?: Cluster; + } + export interface DeleteParameterGroupRequest { + /** + * The name of the parameter group to delete. + */ + ParameterGroupName: String; + } + export interface DeleteParameterGroupResponse { + /** + * A user-specified message for this action (i.e., a reason for deleting the parameter group). + */ + DeletionMessage?: String; + } + export interface DeleteSubnetGroupRequest { + /** + * The name of the subnet group to delete. + */ + SubnetGroupName: String; + } + export interface DeleteSubnetGroupResponse { + /** + * A user-specified message for this action (i.e., a reason for deleting the subnet group). + */ + DeletionMessage?: String; + } + export interface DescribeClustersRequest { + /** + * The names of the DAX clusters being described. + */ + ClusterNames?: ClusterNameList; + /** + * 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. The value for MaxResults must be between 20 and 100. + */ + MaxResults?: IntegerOptional; + /** + * 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 MaxResults. + */ + NextToken?: String; + } + export interface DescribeClustersResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: String; + /** + * The descriptions of your DAX clusters, in response to a DescribeClusters request. + */ + Clusters?: ClusterList; + } + export interface DescribeDefaultParametersRequest { + /** + * 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. The value for MaxResults must be between 20 and 100. + */ + MaxResults?: IntegerOptional; + /** + * 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 MaxResults. + */ + NextToken?: String; + } + export interface DescribeDefaultParametersResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: String; + /** + * A list of parameters. Each element in the list represents one parameter. + */ + Parameters?: ParameterList; + } + export interface DescribeEventsRequest { + /** + * The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response. + */ + SourceName?: String; + /** + * The event source to retrieve events for. If no value is specified, all events are returned. + */ + SourceType?: SourceType; + /** + * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. + */ + StartTime?: TStamp; + /** + * The end of the time interval for which to retrieve events, specified in ISO 8601 format. + */ + EndTime?: TStamp; + /** + * The number of minutes' worth of events to retrieve. + */ + Duration?: IntegerOptional; + /** + * 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. The value for MaxResults must be between 20 and 100. + */ + MaxResults?: IntegerOptional; + /** + * 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 MaxResults. + */ + NextToken?: String; + } + export interface DescribeEventsResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: String; + /** + * An array of events. Each element in the array represents one event. + */ + Events?: EventList; + } + export interface DescribeParameterGroupsRequest { + /** + * The names of the parameter groups. + */ + ParameterGroupNames?: ParameterGroupNameList; + /** + * 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. The value for MaxResults must be between 20 and 100. + */ + MaxResults?: IntegerOptional; + /** + * 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 MaxResults. + */ + NextToken?: String; + } + export interface DescribeParameterGroupsResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: String; + /** + * An array of parameter groups. Each element in the array represents one parameter group. + */ + ParameterGroups?: ParameterGroupList; + } + export interface DescribeParametersRequest { + /** + * The name of the parameter group. + */ + ParameterGroupName: String; + /** + * How the parameter is defined. For example, system denotes a system-defined parameter. + */ + Source?: String; + /** + * 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. The value for MaxResults must be between 20 and 100. + */ + MaxResults?: IntegerOptional; + /** + * 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 MaxResults. + */ + NextToken?: String; + } + export interface DescribeParametersResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: String; + /** + * A list of parameters within a parameter group. Each element in the list represents one parameter. + */ + Parameters?: ParameterList; + } + export interface DescribeSubnetGroupsRequest { + /** + * The name of the subnet group. + */ + SubnetGroupNames?: SubnetGroupNameList; + /** + * 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. The value for MaxResults must be between 20 and 100. + */ + MaxResults?: IntegerOptional; + /** + * 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 MaxResults. + */ + NextToken?: String; + } + export interface DescribeSubnetGroupsResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: String; + /** + * An array of subnet groups. Each element in the array represents a single subnet group. + */ + SubnetGroups?: SubnetGroupList; + } + export interface Endpoint { + /** + * The DNS hostname of the endpoint. + */ + Address?: String; + /** + * The port number that applications should use to connect to the endpoint. + */ + Port?: Integer; + } + export interface Event { + /** + * The source of the event. For example, if the event occurred at the node level, the source would be the node ID. + */ + SourceName?: String; + /** + * Specifies the origin of this event - a cluster, a parameter group, a node ID, etc. + */ + SourceType?: SourceType; + /** + * A user-defined message associated with the event. + */ + Message?: String; + /** + * The date and time when the event occurred. + */ + Date?: TStamp; + } + export type EventList = Event[]; + export interface IncreaseReplicationFactorRequest { + /** + * The name of the DAX cluster that will receive additional nodes. + */ + ClusterName: String; + /** + * The new number of nodes for the DAX cluster. + */ + NewReplicationFactor: Integer; + /** + * The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs. + */ + AvailabilityZones?: AvailabilityZoneList; + } + export interface IncreaseReplicationFactorResponse { + /** + * A description of the DAX cluster. with its new replication factor. + */ + Cluster?: Cluster; + } + export type Integer = number; + export type IntegerOptional = number; + export type IsModifiable = "TRUE"|"FALSE"|"CONDITIONAL"|string; + export type KeyList = String[]; + export interface ListTagsRequest { + /** + * The name of the DAX resource to which the tags belong. + */ + ResourceName: String; + /** + * 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. + */ + NextToken?: String; + } + export interface ListTagsResponse { + /** + * A list of tags currently associated with the DAX cluster. + */ + Tags?: TagList; + /** + * If this value is present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value. + */ + NextToken?: String; + } + export interface Node { + /** + * A system-generated identifier for the node. + */ + NodeId?: String; + /** + * The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster. + */ + Endpoint?: Endpoint; + /** + * The date and time (in UNIX epoch format) when the node was launched. + */ + NodeCreateTime?: TStamp; + /** + * The Availability Zone (AZ) in which the node has been deployed. + */ + AvailabilityZone?: String; + /** + * The current status of the node. For example: available. + */ + NodeStatus?: String; + /** + * The status of the parameter group associated with this node. For example, in-sync. + */ + ParameterGroupStatus?: String; + } + export type NodeIdentifierList = String[]; + export type NodeList = Node[]; + export interface NodeTypeSpecificValue { + /** + * A node type to which the parameter value applies. + */ + NodeType?: String; + /** + * The parameter value for this node type. + */ + Value?: String; + } + export type NodeTypeSpecificValueList = NodeTypeSpecificValue[]; + export interface NotificationConfiguration { + /** + * The Amazon Resource Name (ARN) that identifies the topic. + */ + TopicArn?: String; + /** + * The current state of the topic. + */ + TopicStatus?: String; + } + export interface Parameter { + /** + * The name of the parameter. + */ + ParameterName?: String; + /** + * Determines whether the parameter can be applied to any nodes, or only nodes of a particular type. + */ + ParameterType?: ParameterType; + /** + * The value for the parameter. + */ + ParameterValue?: String; + /** + * A list of node types, and specific parameter values for each node. + */ + NodeTypeSpecificValues?: NodeTypeSpecificValueList; + /** + * A description of the parameter + */ + Description?: String; + /** + * How the parameter is defined. For example, system denotes a system-defined parameter. + */ + Source?: String; + /** + * The data type of the parameter. For example, integer: + */ + DataType?: String; + /** + * A range of values within which the parameter can be set. + */ + AllowedValues?: String; + /** + * Whether the customer is allowed to modify the parameter. + */ + IsModifiable?: IsModifiable; + /** + * The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted. + */ + ChangeType?: ChangeType; + } + export interface ParameterGroup { + /** + * The name of the parameter group. + */ + ParameterGroupName?: String; + /** + * A description of the parameter group. + */ + Description?: String; + } + export type ParameterGroupList = ParameterGroup[]; + export type ParameterGroupNameList = String[]; + export interface ParameterGroupStatus { + /** + * The name of the parameter group. + */ + ParameterGroupName?: String; + /** + * The status of parameter updates. + */ + ParameterApplyStatus?: String; + /** + * The node IDs of one or more nodes to be rebooted. + */ + NodeIdsToReboot?: NodeIdentifierList; + } + export type ParameterList = Parameter[]; + export interface ParameterNameValue { + /** + * The name of the parameter. + */ + ParameterName?: String; + /** + * The value of the parameter. + */ + ParameterValue?: String; + } + export type ParameterNameValueList = ParameterNameValue[]; + export type ParameterType = "DEFAULT"|"NODE_TYPE_SPECIFIC"|string; + export interface RebootNodeRequest { + /** + * The name of the DAX cluster containing the node to be rebooted. + */ + ClusterName: String; + /** + * The system-assigned ID of the node to be rebooted. + */ + NodeId: String; + } + export interface RebootNodeResponse { + /** + * A description of the DAX cluster after a node has been rebooted. + */ + Cluster?: Cluster; + } + export interface SSEDescription { + /** + * The current state of server-side encryption: ENABLING - Server-side encryption is being enabled. ENABLED - Server-side encryption is enabled. DISABLING - Server-side encryption is being disabled. DISABLED - Server-side encryption is disabled. + */ + Status?: SSEStatus; + } + export type SSEEnabled = boolean; + export interface SSESpecification { + /** + * Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster. + */ + Enabled: SSEEnabled; + } + export type SSEStatus = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"|string; + export type SecurityGroupIdentifierList = String[]; + export interface SecurityGroupMembership { + /** + * The unique ID for this security group. + */ + SecurityGroupIdentifier?: String; + /** + * The status of this security group. + */ + Status?: String; + } + export type SecurityGroupMembershipList = SecurityGroupMembership[]; + export type SourceType = "CLUSTER"|"PARAMETER_GROUP"|"SUBNET_GROUP"|string; + export type String = string; + export interface Subnet { + /** + * The system-assigned identifier for the subnet. + */ + SubnetIdentifier?: String; + /** + * The Availability Zone (AZ) for subnet subnet. + */ + SubnetAvailabilityZone?: String; + } + export interface SubnetGroup { + /** + * The name of the subnet group. + */ + SubnetGroupName?: String; + /** + * The description of the subnet group. + */ + Description?: String; + /** + * The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group. + */ + VpcId?: String; + /** + * A list of subnets associated with the subnet group. + */ + Subnets?: SubnetList; + } + export type SubnetGroupList = SubnetGroup[]; + export type SubnetGroupNameList = String[]; + export type SubnetIdentifierList = String[]; + export type SubnetList = Subnet[]; + export type TStamp = Date; + export interface Tag { + /** + * The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. + */ + Key?: String; + /** + * The value of the tag. Tag values are case-sensitive and can be null. + */ + Value?: String; + } + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The name of the DAX resource to which tags should be added. + */ + ResourceName: String; + /** + * The tags to be assigned to the DAX resource. + */ + Tags: TagList; + } + export interface TagResourceResponse { + /** + * The list of tags that are associated with the DAX resource. + */ + Tags?: TagList; + } + export interface UntagResourceRequest { + /** + * The name of the DAX resource from which the tags should be removed. + */ + ResourceName: String; + /** + * A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster. + */ + TagKeys: KeyList; + } + export interface UntagResourceResponse { + /** + * The tag keys that have been removed from the cluster. + */ + Tags?: TagList; + } + export interface UpdateClusterRequest { + /** + * The name of the DAX cluster to be modified. + */ + ClusterName: String; + /** + * A description of the changes being made to the cluster. + */ + Description?: String; + /** + * A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window. + */ + PreferredMaintenanceWindow?: String; + /** + * The Amazon Resource Name (ARN) that identifies the topic. + */ + NotificationTopicArn?: String; + /** + * The current state of the topic. + */ + NotificationTopicStatus?: String; + /** + * The name of a parameter group for this cluster. + */ + ParameterGroupName?: String; + /** + * A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node. + */ + SecurityGroupIds?: SecurityGroupIdentifierList; + } + export interface UpdateClusterResponse { + /** + * A description of the DAX cluster, after it has been modified. + */ + Cluster?: Cluster; + } + export interface UpdateParameterGroupRequest { + /** + * The name of the parameter group. + */ + ParameterGroupName: String; + /** + * An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter. + */ + ParameterNameValues: ParameterNameValueList; + } + export interface UpdateParameterGroupResponse { + /** + * The parameter group that has been modified. + */ + ParameterGroup?: ParameterGroup; + } + export interface UpdateSubnetGroupRequest { + /** + * The name of the subnet group. + */ + SubnetGroupName: String; + /** + * A description of the subnet group. + */ + Description?: String; + /** + * A list of subnet IDs in the subnet group. + */ + SubnetIds?: SubnetIdentifierList; + } + export interface UpdateSubnetGroupResponse { + /** + * The subnet group that has been modified. + */ + SubnetGroup?: SubnetGroup; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-04-19"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DAX client. + */ + export import Types = DAX; +} +export = DAX; diff --git a/node_modules/aws-sdk/clients/dax.js b/node_modules/aws-sdk/clients/dax.js new file mode 100644 index 0000000..4984caa --- /dev/null +++ b/node_modules/aws-sdk/clients/dax.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['dax'] = {}; +AWS.DAX = Service.defineService('dax', ['2017-04-19']); +Object.defineProperty(apiLoader.services['dax'], '2017-04-19', { + get: function get() { + var model = require('../apis/dax-2017-04-19.min.json'); + model.paginators = require('../apis/dax-2017-04-19.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DAX; diff --git a/node_modules/aws-sdk/clients/devicefarm.d.ts b/node_modules/aws-sdk/clients/devicefarm.d.ts new file mode 100644 index 0000000..6800333 --- /dev/null +++ b/node_modules/aws-sdk/clients/devicefarm.d.ts @@ -0,0 +1,3039 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DeviceFarm extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DeviceFarm.Types.ClientConfiguration) + config: Config & DeviceFarm.Types.ClientConfiguration; + /** + * Creates a device pool. + */ + createDevicePool(params: DeviceFarm.Types.CreateDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateDevicePoolResult) => void): Request; + /** + * Creates a device pool. + */ + createDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.CreateDevicePoolResult) => void): Request; + /** + * Creates a profile that can be applied to one or more private fleet device instances. + */ + createInstanceProfile(params: DeviceFarm.Types.CreateInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateInstanceProfileResult) => void): Request; + /** + * Creates a profile that can be applied to one or more private fleet device instances. + */ + createInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.CreateInstanceProfileResult) => void): Request; + /** + * Creates a network profile. + */ + createNetworkProfile(params: DeviceFarm.Types.CreateNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateNetworkProfileResult) => void): Request; + /** + * Creates a network profile. + */ + createNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.CreateNetworkProfileResult) => void): Request; + /** + * Creates a new project. + */ + createProject(params: DeviceFarm.Types.CreateProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateProjectResult) => void): Request; + /** + * Creates a new project. + */ + createProject(callback?: (err: AWSError, data: DeviceFarm.Types.CreateProjectResult) => void): Request; + /** + * Specifies and starts a remote access session. + */ + createRemoteAccessSession(params: DeviceFarm.Types.CreateRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateRemoteAccessSessionResult) => void): Request; + /** + * Specifies and starts a remote access session. + */ + createRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.CreateRemoteAccessSessionResult) => void): Request; + /** + * Uploads an app or test scripts. + */ + createUpload(params: DeviceFarm.Types.CreateUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateUploadResult) => void): Request; + /** + * Uploads an app or test scripts. + */ + createUpload(callback?: (err: AWSError, data: DeviceFarm.Types.CreateUploadResult) => void): Request; + /** + * Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint. + */ + createVPCEConfiguration(params: DeviceFarm.Types.CreateVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateVPCEConfigurationResult) => void): Request; + /** + * Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint. + */ + createVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.CreateVPCEConfigurationResult) => void): Request; + /** + * Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. + */ + deleteDevicePool(params: DeviceFarm.Types.DeleteDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteDevicePoolResult) => void): Request; + /** + * Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. + */ + deleteDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteDevicePoolResult) => void): Request; + /** + * Deletes a profile that can be applied to one or more private device instances. + */ + deleteInstanceProfile(params: DeviceFarm.Types.DeleteInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteInstanceProfileResult) => void): Request; + /** + * Deletes a profile that can be applied to one or more private device instances. + */ + deleteInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteInstanceProfileResult) => void): Request; + /** + * Deletes a network profile. + */ + deleteNetworkProfile(params: DeviceFarm.Types.DeleteNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteNetworkProfileResult) => void): Request; + /** + * Deletes a network profile. + */ + deleteNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteNetworkProfileResult) => void): Request; + /** + * Deletes an AWS Device Farm project, given the project ARN. Note Deleting this resource does not stop an in-progress run. + */ + deleteProject(params: DeviceFarm.Types.DeleteProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteProjectResult) => void): Request; + /** + * Deletes an AWS Device Farm project, given the project ARN. Note Deleting this resource does not stop an in-progress run. + */ + deleteProject(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteProjectResult) => void): Request; + /** + * Deletes a completed remote access session and its results. + */ + deleteRemoteAccessSession(params: DeviceFarm.Types.DeleteRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRemoteAccessSessionResult) => void): Request; + /** + * Deletes a completed remote access session and its results. + */ + deleteRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRemoteAccessSessionResult) => void): Request; + /** + * Deletes the run, given the run ARN. Note Deleting this resource does not stop an in-progress run. + */ + deleteRun(params: DeviceFarm.Types.DeleteRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRunResult) => void): Request; + /** + * Deletes the run, given the run ARN. Note Deleting this resource does not stop an in-progress run. + */ + deleteRun(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRunResult) => void): Request; + /** + * Deletes an upload given the upload ARN. + */ + deleteUpload(params: DeviceFarm.Types.DeleteUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteUploadResult) => void): Request; + /** + * Deletes an upload given the upload ARN. + */ + deleteUpload(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteUploadResult) => void): Request; + /** + * Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint. + */ + deleteVPCEConfiguration(params: DeviceFarm.Types.DeleteVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteVPCEConfigurationResult) => void): Request; + /** + * Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint. + */ + deleteVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteVPCEConfigurationResult) => void): Request; + /** + * Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. + */ + getAccountSettings(params: DeviceFarm.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetAccountSettingsResult) => void): Request; + /** + * Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. + */ + getAccountSettings(callback?: (err: AWSError, data: DeviceFarm.Types.GetAccountSettingsResult) => void): Request; + /** + * Gets information about a unique device type. + */ + getDevice(params: DeviceFarm.Types.GetDeviceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceResult) => void): Request; + /** + * Gets information about a unique device type. + */ + getDevice(callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceResult) => void): Request; + /** + * Returns information about a device instance belonging to a private device fleet. + */ + getDeviceInstance(params: DeviceFarm.Types.GetDeviceInstanceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceInstanceResult) => void): Request; + /** + * Returns information about a device instance belonging to a private device fleet. + */ + getDeviceInstance(callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceInstanceResult) => void): Request; + /** + * Gets information about a device pool. + */ + getDevicePool(params: DeviceFarm.Types.GetDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolResult) => void): Request; + /** + * Gets information about a device pool. + */ + getDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolResult) => void): Request; + /** + * Gets information about compatibility with a device pool. + */ + getDevicePoolCompatibility(params: DeviceFarm.Types.GetDevicePoolCompatibilityRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolCompatibilityResult) => void): Request; + /** + * Gets information about compatibility with a device pool. + */ + getDevicePoolCompatibility(callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolCompatibilityResult) => void): Request; + /** + * Returns information about the specified instance profile. + */ + getInstanceProfile(params: DeviceFarm.Types.GetInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetInstanceProfileResult) => void): Request; + /** + * Returns information about the specified instance profile. + */ + getInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.GetInstanceProfileResult) => void): Request; + /** + * Gets information about a job. + */ + getJob(params: DeviceFarm.Types.GetJobRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetJobResult) => void): Request; + /** + * Gets information about a job. + */ + getJob(callback?: (err: AWSError, data: DeviceFarm.Types.GetJobResult) => void): Request; + /** + * Returns information about a network profile. + */ + getNetworkProfile(params: DeviceFarm.Types.GetNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetNetworkProfileResult) => void): Request; + /** + * Returns information about a network profile. + */ + getNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.GetNetworkProfileResult) => void): Request; + /** + * 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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + getOfferingStatus(params: DeviceFarm.Types.GetOfferingStatusRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetOfferingStatusResult) => void): Request; + /** + * 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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + getOfferingStatus(callback?: (err: AWSError, data: DeviceFarm.Types.GetOfferingStatusResult) => void): Request; + /** + * Gets information about a project. + */ + getProject(params: DeviceFarm.Types.GetProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetProjectResult) => void): Request; + /** + * Gets information about a project. + */ + getProject(callback?: (err: AWSError, data: DeviceFarm.Types.GetProjectResult) => void): Request; + /** + * Returns a link to a currently running remote access session. + */ + getRemoteAccessSession(params: DeviceFarm.Types.GetRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetRemoteAccessSessionResult) => void): Request; + /** + * Returns a link to a currently running remote access session. + */ + getRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.GetRemoteAccessSessionResult) => void): Request; + /** + * Gets information about a run. + */ + getRun(params: DeviceFarm.Types.GetRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetRunResult) => void): Request; + /** + * Gets information about a run. + */ + getRun(callback?: (err: AWSError, data: DeviceFarm.Types.GetRunResult) => void): Request; + /** + * Gets information about a suite. + */ + getSuite(params: DeviceFarm.Types.GetSuiteRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetSuiteResult) => void): Request; + /** + * Gets information about a suite. + */ + getSuite(callback?: (err: AWSError, data: DeviceFarm.Types.GetSuiteResult) => void): Request; + /** + * Gets information about a test. + */ + getTest(params: DeviceFarm.Types.GetTestRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetTestResult) => void): Request; + /** + * Gets information about a test. + */ + getTest(callback?: (err: AWSError, data: DeviceFarm.Types.GetTestResult) => void): Request; + /** + * Gets information about an upload. + */ + getUpload(params: DeviceFarm.Types.GetUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetUploadResult) => void): Request; + /** + * Gets information about an upload. + */ + getUpload(callback?: (err: AWSError, data: DeviceFarm.Types.GetUploadResult) => void): Request; + /** + * Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint. + */ + getVPCEConfiguration(params: DeviceFarm.Types.GetVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetVPCEConfigurationResult) => void): Request; + /** + * Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint. + */ + getVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.GetVPCEConfigurationResult) => void): Request; + /** + * 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. + */ + installToRemoteAccessSession(params: DeviceFarm.Types.InstallToRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.InstallToRemoteAccessSessionResult) => void): Request; + /** + * 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. + */ + installToRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.InstallToRemoteAccessSessionResult) => void): Request; + /** + * Gets information about artifacts. + */ + listArtifacts(params: DeviceFarm.Types.ListArtifactsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListArtifactsResult) => void): Request; + /** + * Gets information about artifacts. + */ + listArtifacts(callback?: (err: AWSError, data: DeviceFarm.Types.ListArtifactsResult) => void): Request; + /** + * Returns information about the private device instances associated with one or more AWS accounts. + */ + listDeviceInstances(params: DeviceFarm.Types.ListDeviceInstancesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDeviceInstancesResult) => void): Request; + /** + * Returns information about the private device instances associated with one or more AWS accounts. + */ + listDeviceInstances(callback?: (err: AWSError, data: DeviceFarm.Types.ListDeviceInstancesResult) => void): Request; + /** + * Gets information about device pools. + */ + listDevicePools(params: DeviceFarm.Types.ListDevicePoolsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicePoolsResult) => void): Request; + /** + * Gets information about device pools. + */ + listDevicePools(callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicePoolsResult) => void): Request; + /** + * Gets information about unique device types. + */ + listDevices(params: DeviceFarm.Types.ListDevicesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicesResult) => void): Request; + /** + * Gets information about unique device types. + */ + listDevices(callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicesResult) => void): Request; + /** + * Returns information about all the instance profiles in an AWS account. + */ + listInstanceProfiles(params: DeviceFarm.Types.ListInstanceProfilesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListInstanceProfilesResult) => void): Request; + /** + * Returns information about all the instance profiles in an AWS account. + */ + listInstanceProfiles(callback?: (err: AWSError, data: DeviceFarm.Types.ListInstanceProfilesResult) => void): Request; + /** + * Gets information about jobs for a given test run. + */ + listJobs(params: DeviceFarm.Types.ListJobsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListJobsResult) => void): Request; + /** + * Gets information about jobs for a given test run. + */ + listJobs(callback?: (err: AWSError, data: DeviceFarm.Types.ListJobsResult) => void): Request; + /** + * Returns the list of available network profiles. + */ + listNetworkProfiles(params: DeviceFarm.Types.ListNetworkProfilesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListNetworkProfilesResult) => void): Request; + /** + * Returns the list of available network profiles. + */ + listNetworkProfiles(callback?: (err: AWSError, data: DeviceFarm.Types.ListNetworkProfilesResult) => void): Request; + /** + * Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + listOfferingPromotions(params: DeviceFarm.Types.ListOfferingPromotionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingPromotionsResult) => void): Request; + /** + * Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + listOfferingPromotions(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingPromotionsResult) => void): Request; + /** + * Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + listOfferingTransactions(params: DeviceFarm.Types.ListOfferingTransactionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingTransactionsResult) => void): Request; + /** + * Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + listOfferingTransactions(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingTransactionsResult) => void): Request; + /** + * Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + listOfferings(params: DeviceFarm.Types.ListOfferingsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingsResult) => void): Request; + /** + * Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + listOfferings(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingsResult) => void): Request; + /** + * Gets information about projects. + */ + listProjects(params: DeviceFarm.Types.ListProjectsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListProjectsResult) => void): Request; + /** + * Gets information about projects. + */ + listProjects(callback?: (err: AWSError, data: DeviceFarm.Types.ListProjectsResult) => void): Request; + /** + * Returns a list of all currently running remote access sessions. + */ + listRemoteAccessSessions(params: DeviceFarm.Types.ListRemoteAccessSessionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListRemoteAccessSessionsResult) => void): Request; + /** + * Returns a list of all currently running remote access sessions. + */ + listRemoteAccessSessions(callback?: (err: AWSError, data: DeviceFarm.Types.ListRemoteAccessSessionsResult) => void): Request; + /** + * Gets information about runs, given an AWS Device Farm project ARN. + */ + listRuns(params: DeviceFarm.Types.ListRunsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListRunsResult) => void): Request; + /** + * Gets information about runs, given an AWS Device Farm project ARN. + */ + listRuns(callback?: (err: AWSError, data: DeviceFarm.Types.ListRunsResult) => void): Request; + /** + * Gets information about samples, given an AWS Device Farm job ARN. + */ + listSamples(params: DeviceFarm.Types.ListSamplesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListSamplesResult) => void): Request; + /** + * Gets information about samples, given an AWS Device Farm job ARN. + */ + listSamples(callback?: (err: AWSError, data: DeviceFarm.Types.ListSamplesResult) => void): Request; + /** + * Gets information about test suites for a given job. + */ + listSuites(params: DeviceFarm.Types.ListSuitesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListSuitesResult) => void): Request; + /** + * Gets information about test suites for a given job. + */ + listSuites(callback?: (err: AWSError, data: DeviceFarm.Types.ListSuitesResult) => void): Request; + /** + * Gets information about tests in a given test suite. + */ + listTests(params: DeviceFarm.Types.ListTestsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListTestsResult) => void): Request; + /** + * Gets information about tests in a given test suite. + */ + listTests(callback?: (err: AWSError, data: DeviceFarm.Types.ListTestsResult) => void): Request; + /** + * Gets information about unique problems. + */ + listUniqueProblems(params: DeviceFarm.Types.ListUniqueProblemsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListUniqueProblemsResult) => void): Request; + /** + * Gets information about unique problems. + */ + listUniqueProblems(callback?: (err: AWSError, data: DeviceFarm.Types.ListUniqueProblemsResult) => void): Request; + /** + * Gets information about uploads, given an AWS Device Farm project ARN. + */ + listUploads(params: DeviceFarm.Types.ListUploadsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListUploadsResult) => void): Request; + /** + * Gets information about uploads, given an AWS Device Farm project ARN. + */ + listUploads(callback?: (err: AWSError, data: DeviceFarm.Types.ListUploadsResult) => void): Request; + /** + * Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account. + */ + listVPCEConfigurations(params: DeviceFarm.Types.ListVPCEConfigurationsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListVPCEConfigurationsResult) => void): Request; + /** + * Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account. + */ + listVPCEConfigurations(callback?: (err: AWSError, data: DeviceFarm.Types.ListVPCEConfigurationsResult) => void): Request; + /** + * 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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + purchaseOffering(params: DeviceFarm.Types.PurchaseOfferingRequest, callback?: (err: AWSError, data: DeviceFarm.Types.PurchaseOfferingResult) => void): Request; + /** + * 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 NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + purchaseOffering(callback?: (err: AWSError, data: DeviceFarm.Types.PurchaseOfferingResult) => void): Request; + /** + * Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + renewOffering(params: DeviceFarm.Types.RenewOfferingRequest, callback?: (err: AWSError, data: DeviceFarm.Types.RenewOfferingResult) => void): Request; + /** + * Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation. + */ + renewOffering(callback?: (err: AWSError, data: DeviceFarm.Types.RenewOfferingResult) => void): Request; + /** + * Schedules a run. + */ + scheduleRun(params: DeviceFarm.Types.ScheduleRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ScheduleRunResult) => void): Request; + /** + * Schedules a run. + */ + scheduleRun(callback?: (err: AWSError, data: DeviceFarm.Types.ScheduleRunResult) => void): Request; + /** + * Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed. + */ + stopJob(params: DeviceFarm.Types.StopJobRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopJobResult) => void): Request; + /** + * Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed. + */ + stopJob(callback?: (err: AWSError, data: DeviceFarm.Types.StopJobResult) => void): Request; + /** + * Ends a specified remote access session. + */ + stopRemoteAccessSession(params: DeviceFarm.Types.StopRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopRemoteAccessSessionResult) => void): Request; + /** + * Ends a specified remote access session. + */ + stopRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.StopRemoteAccessSessionResult) => void): Request; + /** + * 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. + */ + stopRun(params: DeviceFarm.Types.StopRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopRunResult) => void): Request; + /** + * 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. + */ + stopRun(callback?: (err: AWSError, data: DeviceFarm.Types.StopRunResult) => void): Request; + /** + * Updates information about an existing private device instance. + */ + updateDeviceInstance(params: DeviceFarm.Types.UpdateDeviceInstanceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDeviceInstanceResult) => void): Request; + /** + * Updates information about an existing private device instance. + */ + updateDeviceInstance(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDeviceInstanceResult) => void): Request; + /** + * 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). + */ + updateDevicePool(params: DeviceFarm.Types.UpdateDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDevicePoolResult) => void): Request; + /** + * 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). + */ + updateDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDevicePoolResult) => void): Request; + /** + * Updates information about an existing private device instance profile. + */ + updateInstanceProfile(params: DeviceFarm.Types.UpdateInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateInstanceProfileResult) => void): Request; + /** + * Updates information about an existing private device instance profile. + */ + updateInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateInstanceProfileResult) => void): Request; + /** + * Updates the network profile with specific settings. + */ + updateNetworkProfile(params: DeviceFarm.Types.UpdateNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateNetworkProfileResult) => void): Request; + /** + * Updates the network profile with specific settings. + */ + updateNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateNetworkProfileResult) => void): Request; + /** + * Modifies the specified project name, given the project ARN and a new name. + */ + updateProject(params: DeviceFarm.Types.UpdateProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateProjectResult) => void): Request; + /** + * Modifies the specified project name, given the project ARN and a new name. + */ + updateProject(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateProjectResult) => void): Request; + /** + * Update an uploaded test specification (test spec). + */ + updateUpload(params: DeviceFarm.Types.UpdateUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateUploadResult) => void): Request; + /** + * Update an uploaded test specification (test spec). + */ + updateUpload(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateUploadResult) => void): Request; + /** + * Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration. + */ + updateVPCEConfiguration(params: DeviceFarm.Types.UpdateVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateVPCEConfigurationResult) => void): Request; + /** + * Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration. + */ + updateVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateVPCEConfigurationResult) => void): Request; +} +declare namespace DeviceFarm { + export type AWSAccountNumber = string; + export interface AccountSettings { + /** + * The AWS account number specified in the AccountSettings container. + */ + awsAccountNumber?: AWSAccountNumber; + /** + * Returns the unmetered devices you have purchased or want to purchase. + */ + unmeteredDevices?: PurchasedDevicesMap; + /** + * Returns the unmetered remote access devices you have purchased or want to purchase. + */ + unmeteredRemoteAccessDevices?: PurchasedDevicesMap; + /** + * The maximum number of minutes a test run will execute before it times out. + */ + maxJobTimeoutMinutes?: JobTimeoutMinutes; + /** + * Information about an AWS account's usage of free trial device minutes. + */ + trialMinutes?: TrialMinutes; + /** + * The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command. + */ + maxSlots?: MaxSlotMap; + /** + * The default number of minutes (at the account level) a test run will execute before it times out. Default value is 60 minutes. + */ + defaultJobTimeoutMinutes?: JobTimeoutMinutes; + /** + * When set to true, 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. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs. + */ + skipAppResign?: SkipAppResign; + } + export type AccountsCleanup = boolean; + export type AmazonResourceName = string; + export type AmazonResourceNames = AmazonResourceName[]; + export type AndroidPaths = String[]; + export type AppPackagesCleanup = boolean; + export interface Artifact { + /** + * The artifact's ARN. + */ + arn?: AmazonResourceName; + /** + * The artifact's name. + */ + name?: Name; + /** + * The artifact's type. Allowed values include the following: UNKNOWN: An unknown type. SCREENSHOT: The screenshot type. DEVICE_LOG: The device log type. MESSAGE_LOG: The message log type. VIDEO_LOG: The video log type. RESULT_LOG: The result log type. SERVICE_LOG: The service log type. WEBKIT_LOG: The web kit log type. INSTRUMENTATION_OUTPUT: The instrumentation type. EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test. CALABASH_JSON_OUTPUT: The Calabash JSON output type. CALABASH_PRETTY_OUTPUT: The Calabash pretty output type. CALABASH_STANDARD_OUTPUT: The Calabash standard output type. CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type. AUTOMATION_OUTPUT: The automation output type. APPIUM_SERVER_OUTPUT: The Appium server output type. APPIUM_JAVA_OUTPUT: The Appium Java output type. APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type. APPIUM_PYTHON_OUTPUT: The Appium Python output type. APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type. EXPLORER_EVENT_LOG: The Explorer event log output type. EXPLORER_SUMMARY_LOG: The Explorer summary log output type. APPLICATION_CRASH_REPORT: The application crash report output type. XCTEST_LOG: The XCode test output type. VIDEO: The Video output type. CUSTOMER_ARTIFACT:The Customer Artifact output type. CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type. TESTSPEC_OUTPUT: The Test Spec Output type. + */ + type?: ArtifactType; + /** + * The artifact's file extension. + */ + extension?: String; + /** + * The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file. + */ + url?: URL; + } + export type ArtifactCategory = "SCREENSHOT"|"FILE"|"LOG"|string; + export type ArtifactType = "UNKNOWN"|"SCREENSHOT"|"DEVICE_LOG"|"MESSAGE_LOG"|"VIDEO_LOG"|"RESULT_LOG"|"SERVICE_LOG"|"WEBKIT_LOG"|"INSTRUMENTATION_OUTPUT"|"EXERCISER_MONKEY_OUTPUT"|"CALABASH_JSON_OUTPUT"|"CALABASH_PRETTY_OUTPUT"|"CALABASH_STANDARD_OUTPUT"|"CALABASH_JAVA_XML_OUTPUT"|"AUTOMATION_OUTPUT"|"APPIUM_SERVER_OUTPUT"|"APPIUM_JAVA_OUTPUT"|"APPIUM_JAVA_XML_OUTPUT"|"APPIUM_PYTHON_OUTPUT"|"APPIUM_PYTHON_XML_OUTPUT"|"EXPLORER_EVENT_LOG"|"EXPLORER_SUMMARY_LOG"|"APPLICATION_CRASH_REPORT"|"XCTEST_LOG"|"VIDEO"|"CUSTOMER_ARTIFACT"|"CUSTOMER_ARTIFACT_LOG"|"TESTSPEC_OUTPUT"|string; + export type Artifacts = Artifact[]; + export type BillingMethod = "METERED"|"UNMETERED"|string; + export type Boolean = boolean; + export interface CPU { + /** + * The CPU's frequency. + */ + frequency?: String; + /** + * The CPU's architecture, for example x86 or ARM. + */ + architecture?: String; + /** + * The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000. + */ + clock?: Double; + } + export type ClientId = string; + export type ContentType = string; + export interface Counters { + /** + * The total number of entities. + */ + total?: Integer; + /** + * The number of passed entities. + */ + passed?: Integer; + /** + * The number of failed entities. + */ + failed?: Integer; + /** + * The number of warned entities. + */ + warned?: Integer; + /** + * The number of errored entities. + */ + errored?: Integer; + /** + * The number of stopped entities. + */ + stopped?: Integer; + /** + * The number of skipped entities. + */ + skipped?: Integer; + } + export interface CreateDevicePoolRequest { + /** + * The ARN of the project for the device pool. + */ + projectArn: AmazonResourceName; + /** + * The device pool's name. + */ + name: Name; + /** + * The device pool's description. + */ + description?: Message; + /** + * The device pool's rules. + */ + rules: Rules; + /** + * The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests. + */ + maxDevices?: Integer; + } + export interface CreateDevicePoolResult { + /** + * The newly created device pool. + */ + devicePool?: DevicePool; + } + export interface CreateInstanceProfileRequest { + /** + * The name of your instance profile. + */ + name: Name; + /** + * The description of your instance profile. + */ + description?: Message; + /** + * When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices. + */ + packageCleanup?: Boolean; + /** + * 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. The list of packages is only considered if you set packageCleanup to true. + */ + excludeAppPackagesFromCleanup?: PackageIds; + /** + * When set to true, Device Farm will reboot the instance after a test run. The default value is true. + */ + rebootAfterUse?: Boolean; + } + export interface CreateInstanceProfileResult { + /** + * An object containing information about your instance profile. + */ + instanceProfile?: InstanceProfile; + } + export interface CreateNetworkProfileRequest { + /** + * The Amazon Resource Name (ARN) of the project for which you want to create a network profile. + */ + projectArn: AmazonResourceName; + /** + * The name you wish to specify for the new network profile. + */ + name: Name; + /** + * The description of the network profile. + */ + description?: Message; + /** + * The type of network profile you wish to create. Valid values are listed below. + */ + type?: NetworkProfileType; + /** + * The data throughput rate in bits per second, as an integer from 0 to 104857600. + */ + uplinkBandwidthBits?: Long; + /** + * The data throughput rate in bits per second, as an integer from 0 to 104857600. + */ + downlinkBandwidthBits?: Long; + /** + * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. + */ + uplinkDelayMs?: Long; + /** + * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. + */ + downlinkDelayMs?: Long; + /** + * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. + */ + uplinkJitterMs?: Long; + /** + * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. + */ + downlinkJitterMs?: Long; + /** + * Proportion of transmitted packets that fail to arrive from 0 to 100 percent. + */ + uplinkLossPercent?: PercentInteger; + /** + * Proportion of received packets that fail to arrive from 0 to 100 percent. + */ + downlinkLossPercent?: PercentInteger; + } + export interface CreateNetworkProfileResult { + /** + * The network profile that is returned by the create network profile request. + */ + networkProfile?: NetworkProfile; + } + export interface CreateProjectRequest { + /** + * The project's name. + */ + name: Name; + /** + * Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run. + */ + defaultJobTimeoutMinutes?: JobTimeoutMinutes; + } + export interface CreateProjectResult { + /** + * The newly created project. + */ + project?: Project; + } + export interface CreateRemoteAccessSessionConfiguration { + /** + * The billing method for the remote access session. + */ + billingMethod?: BillingMethod; + /** + * An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration. + */ + vpceConfigurationArns?: AmazonResourceNames; + } + export interface CreateRemoteAccessSessionRequest { + /** + * The Amazon Resource Name (ARN) of the project for which you want to create a remote access session. + */ + projectArn: AmazonResourceName; + /** + * The Amazon Resource Name (ARN) of the device for which you want to create a remote access session. + */ + deviceArn: AmazonResourceName; + /** + * The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session. + */ + instanceArn?: AmazonResourceName; + /** + * The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true. + */ + sshPublicKey?: SshPublicKey; + /** + * Set to true if you want to access devices remotely for debugging in your remote access session. + */ + remoteDebugEnabled?: Boolean; + /** + * Set to true to enable remote recording for the remote access session. + */ + remoteRecordEnabled?: Boolean; + /** + * The Amazon Resource Name (ARN) for the app to be recorded in the remote access session. + */ + remoteRecordAppArn?: AmazonResourceName; + /** + * The name of the remote access session that you wish to create. + */ + name?: Name; + /** + * Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This is required only if remoteDebugEnabled is set to true. + */ + clientId?: ClientId; + /** + * The configuration information for the remote access session request. + */ + configuration?: CreateRemoteAccessSessionConfiguration; + /** + * The interaction mode of the remote access session. Valid values are: INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode. 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 can run XCUITest framework-based tests in this mode. VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode. + */ + interactionMode?: InteractionMode; + /** + * When set to true, 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. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs. + */ + skipAppResign?: Boolean; + } + export interface CreateRemoteAccessSessionResult { + /** + * A container that describes the remote access session when the request to create a remote access session is sent. + */ + remoteAccessSession?: RemoteAccessSession; + } + export interface CreateUploadRequest { + /** + * The ARN of the project for the upload. + */ + projectArn: AmazonResourceName; + /** + * 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 .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension. + */ + name: Name; + /** + * The upload's upload type. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web application upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An XCode test package upload. XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An XCode UI test spec upload. Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error. + */ + type: UploadType; + /** + * The upload's content type (for example, "application/octet-stream"). + */ + contentType?: ContentType; + } + export interface CreateUploadResult { + /** + * The newly created upload. + */ + upload?: Upload; + } + export interface CreateVPCEConfigurationRequest { + /** + * The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily. + */ + vpceConfigurationName: VPCEConfigurationName; + /** + * The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test. + */ + vpceServiceName: VPCEServiceName; + /** + * The DNS name of the service running in your VPC that you want Device Farm to test. + */ + serviceDnsName: ServiceDnsName; + /** + * An optional description, providing more details about your VPC endpoint configuration. + */ + vpceConfigurationDescription?: VPCEConfigurationDescription; + } + export interface CreateVPCEConfigurationResult { + /** + * An object containing information about your VPC endpoint configuration. + */ + vpceConfiguration?: VPCEConfiguration; + } + export type CurrencyCode = "USD"|string; + export interface CustomerArtifactPaths { + /** + * Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from. + */ + iosPaths?: IosPaths; + /** + * Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from. + */ + androidPaths?: AndroidPaths; + /** + * Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from. + */ + deviceHostPaths?: DeviceHostPaths; + } + export type DateTime = Date; + export interface DeleteDevicePoolRequest { + /** + * Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete. + */ + arn: AmazonResourceName; + } + export interface DeleteDevicePoolResult { + } + export interface DeleteInstanceProfileRequest { + /** + * The Amazon Resource Name (ARN) of the instance profile you are requesting to delete. + */ + arn: AmazonResourceName; + } + export interface DeleteInstanceProfileResult { + } + export interface DeleteNetworkProfileRequest { + /** + * The Amazon Resource Name (ARN) of the network profile you want to delete. + */ + arn: AmazonResourceName; + } + export interface DeleteNetworkProfileResult { + } + export interface DeleteProjectRequest { + /** + * Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete. + */ + arn: AmazonResourceName; + } + export interface DeleteProjectResult { + } + export interface DeleteRemoteAccessSessionRequest { + /** + * The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access. + */ + arn: AmazonResourceName; + } + export interface DeleteRemoteAccessSessionResult { + } + export interface DeleteRunRequest { + /** + * The Amazon Resource Name (ARN) for the run you wish to delete. + */ + arn: AmazonResourceName; + } + export interface DeleteRunResult { + } + export interface DeleteUploadRequest { + /** + * Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete. + */ + arn: AmazonResourceName; + } + export interface DeleteUploadResult { + } + export interface DeleteVPCEConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete. + */ + arn: AmazonResourceName; + } + export interface DeleteVPCEConfigurationResult { + } + export interface Device { + /** + * The device's ARN. + */ + arn?: AmazonResourceName; + /** + * The device's display name. + */ + name?: Name; + /** + * The device's manufacturer name. + */ + manufacturer?: String; + /** + * The device's model name. + */ + model?: String; + /** + * The device's model ID. + */ + modelId?: String; + /** + * The device's form factor. Allowed values include: PHONE: The phone form factor. TABLET: The tablet form factor. + */ + formFactor?: DeviceFormFactor; + /** + * The device's platform. Allowed values include: ANDROID: The Android platform. IOS: The iOS platform. + */ + platform?: DevicePlatform; + /** + * The device's operating system type. + */ + os?: String; + /** + * Information about the device's CPU. + */ + cpu?: CPU; + /** + * The resolution of the device. + */ + resolution?: Resolution; + /** + * The device's heap size, expressed in bytes. + */ + heapSize?: Long; + /** + * The device's total memory size, expressed in bytes. + */ + memory?: Long; + /** + * The device's image name. + */ + image?: String; + /** + * The device's carrier. + */ + carrier?: String; + /** + * The device's radio. + */ + radio?: String; + /** + * Specifies whether remote access has been enabled for the specified device. + */ + remoteAccessEnabled?: Boolean; + /** + * This flag is set to true if remote debugging is enabled for the device. + */ + remoteDebugEnabled?: Boolean; + /** + * The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC. + */ + fleetType?: String; + /** + * The name of the fleet to which this device belongs. + */ + fleetName?: String; + /** + * The instances belonging to this device. + */ + instances?: DeviceInstances; + /** + * Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods. + */ + availability?: DeviceAvailability; + } + export type DeviceAttribute = "ARN"|"PLATFORM"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED"|"REMOTE_DEBUG_ENABLED"|"APPIUM_VERSION"|"INSTANCE_ARN"|"INSTANCE_LABELS"|"FLEET_TYPE"|"OS_VERSION"|"MODEL"|"AVAILABILITY"|string; + export type DeviceAvailability = "TEMPORARY_NOT_AVAILABLE"|"BUSY"|"AVAILABLE"|"HIGHLY_AVAILABLE"|string; + export interface DeviceFilter { + /** + * The aspect of a device such as platform or model used as the selection criteria in a device filter. The supported operators for each attribute are provided in the following list. ARN The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". Supported operators: EQUALS, IN, NOT_IN PLATFORM The device platform. Valid values are "ANDROID" or "IOS". Supported operators: EQUALS OS_VERSION The operating system version. For example, "10.3.2". Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN MODEL The device model. For example, "iPad 5th Gen". Supported operators: CONTAINS, EQUALS, IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values are "PHONE" or "TABLET". Supported operators: EQUALS MANUFACTURER The device manufacturer. For example, "Apple". Supported operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS INSTANCE_ARN The Amazon Resource Name (ARN) of the device instance. Supported operators: EQUALS, IN, NOT_IN INSTANCE_LABELS The label of the device instance. Supported operators: CONTAINS FLEET_TYPE The fleet type. Valid values are "PUBLIC" or "PRIVATE". Supported operators: EQUALS + */ + attribute?: DeviceFilterAttribute; + /** + * Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions. + */ + operator?: RuleOperator; + /** + * An array of one or more filter values used in a device filter. Operator Values The IN and NOT_IN operators can take a values array that has more than one element. The other operators require an array with a single element. Attribute Values The PLATFORM attribute can be set to "ANDROID" or "IOS". The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". The FORM_FACTOR attribute can be set to "PHONE" or "TABLET". The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE". + */ + values?: DeviceFilterValues; + } + export type DeviceFilterAttribute = "ARN"|"PLATFORM"|"OS_VERSION"|"MODEL"|"AVAILABILITY"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED"|"REMOTE_DEBUG_ENABLED"|"INSTANCE_ARN"|"INSTANCE_LABELS"|"FLEET_TYPE"|string; + export type DeviceFilterValues = String[]; + export type DeviceFilters = DeviceFilter[]; + export type DeviceFormFactor = "PHONE"|"TABLET"|string; + export type DeviceHostPaths = String[]; + export interface DeviceInstance { + /** + * The Amazon Resource Name (ARN) of the device instance. + */ + arn?: AmazonResourceName; + /** + * The Amazon Resource Name (ARN) of the device. + */ + deviceArn?: AmazonResourceName; + /** + * An array of strings describing the device instance. + */ + labels?: InstanceLabels; + /** + * The status of the device instance. Valid values are listed below. + */ + status?: InstanceStatus; + /** + * Unique device identifier for the device instance. + */ + udid?: String; + /** + * A object containing information about the instance profile. + */ + instanceProfile?: InstanceProfile; + } + export type DeviceInstances = DeviceInstance[]; + export interface DeviceMinutes { + /** + * When specified, represents the total minutes used by the resource to run tests. + */ + total?: Double; + /** + * When specified, represents only the sum of metered minutes used by the resource to run tests. + */ + metered?: Double; + /** + * When specified, represents only the sum of unmetered minutes used by the resource to run tests. + */ + unmetered?: Double; + } + export type DevicePlatform = "ANDROID"|"IOS"|string; + export interface DevicePool { + /** + * The device pool's ARN. + */ + arn?: AmazonResourceName; + /** + * The device pool's name. + */ + name?: Name; + /** + * The device pool's description. + */ + description?: Message; + /** + * The device pool's type. Allowed values include: CURATED: A device pool that is created and managed by AWS Device Farm. PRIVATE: A device pool that is created and managed by the device pool developer. + */ + type?: DevicePoolType; + /** + * Information about the device pool's rules. + */ + rules?: Rules; + /** + * The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests. + */ + maxDevices?: Integer; + } + export interface DevicePoolCompatibilityResult { + /** + * The device (phone or tablet) that you wish to return information about. + */ + device?: Device; + /** + * Whether the result was compatible with the device pool. + */ + compatible?: Boolean; + /** + * Information about the compatibility. + */ + incompatibilityMessages?: IncompatibilityMessages; + } + export type DevicePoolCompatibilityResults = DevicePoolCompatibilityResult[]; + export type DevicePoolType = "CURATED"|"PRIVATE"|string; + export type DevicePools = DevicePool[]; + export interface DeviceSelectionConfiguration { + /** + * Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values. Attribute The aspect of a device such as platform or model used as the selection criteria in a device filter. Allowed values include: ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". PLATFORM: The device platform. Valid values are "ANDROID" or "IOS". OS_VERSION: The operating system version. For example, "10.3.2". MODEL: The device model. For example, "iPad 5th Gen". AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET". MANUFACTURER: The device manufacturer. For example, "Apple". REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE". Operator The filter operator. The EQUALS operator is available for every attribute except INSTANCE_LABELS. The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute. Values An array of one or more filter values. Operator Values The IN and NOT_IN operators can take a values array that has more than one element. The other operators require an array with a single element. Attribute Values The PLATFORM attribute can be set to "ANDROID" or "IOS". The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". The FORM_FACTOR attribute can be set to "PHONE" or "TABLET". The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE". + */ + filters: DeviceFilters; + /** + * The maximum number of devices to be included in a test run. + */ + maxDevices: Integer; + } + export interface DeviceSelectionResult { + /** + * The filters in a device selection result. + */ + filters?: DeviceFilters; + /** + * The number of devices that matched the device filter selection criteria. + */ + matchedDevicesCount?: Integer; + /** + * The maximum number of devices to be selected by a device filter and included in a test run. + */ + maxDevices?: Integer; + } + export type Devices = Device[]; + export type Double = number; + export interface ExecutionConfiguration { + /** + * The number of minutes a test run will execute before it times out. + */ + jobTimeoutMinutes?: JobTimeoutMinutes; + /** + * True if account cleanup is enabled at the beginning of the test; otherwise, false. + */ + accountsCleanup?: AccountsCleanup; + /** + * True if app package cleanup is enabled at the beginning of the test; otherwise, false. + */ + appPackagesCleanup?: AppPackagesCleanup; + /** + * Set to true to enable video capture; otherwise, set to false. The default is true. + */ + videoCapture?: VideoCapture; + /** + * When set to true, 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. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs. + */ + skipAppResign?: SkipAppResign; + } + export type ExecutionResult = "PENDING"|"PASSED"|"WARNED"|"FAILED"|"SKIPPED"|"ERRORED"|"STOPPED"|string; + export type ExecutionResultCode = "PARSING_FAILED"|"VPC_ENDPOINT_SETUP_FAILED"|string; + export type ExecutionStatus = "PENDING"|"PENDING_CONCURRENCY"|"PENDING_DEVICE"|"PROCESSING"|"SCHEDULING"|"PREPARING"|"RUNNING"|"COMPLETED"|"STOPPING"|string; + export type Filter = string; + export interface GetAccountSettingsRequest { + } + export interface GetAccountSettingsResult { + /** + * The account settings. + */ + accountSettings?: AccountSettings; + } + export interface GetDeviceInstanceRequest { + /** + * The Amazon Resource Name (ARN) of the instance you're requesting information about. + */ + arn: AmazonResourceName; + } + export interface GetDeviceInstanceResult { + /** + * An object containing information about your device instance. + */ + deviceInstance?: DeviceInstance; + } + export interface GetDevicePoolCompatibilityRequest { + /** + * The device pool's ARN. + */ + devicePoolArn: AmazonResourceName; + /** + * The ARN of the app that is associated with the specified device pool. + */ + appArn?: AmazonResourceName; + /** + * The test type for the specified device pool. Allowed values include the following: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type. + */ + testType?: TestType; + /** + * Information about the uploaded test to be run against the device pool. + */ + test?: ScheduleRunTest; + /** + * An object containing information about the settings for a run. + */ + configuration?: ScheduleRunConfiguration; + } + export interface GetDevicePoolCompatibilityResult { + /** + * Information about compatible devices. + */ + compatibleDevices?: DevicePoolCompatibilityResults; + /** + * Information about incompatible devices. + */ + incompatibleDevices?: DevicePoolCompatibilityResults; + } + export interface GetDevicePoolRequest { + /** + * The device pool's ARN. + */ + arn: AmazonResourceName; + } + export interface GetDevicePoolResult { + /** + * An object containing information about the requested device pool. + */ + devicePool?: DevicePool; + } + export interface GetDeviceRequest { + /** + * The device type's ARN. + */ + arn: AmazonResourceName; + } + export interface GetDeviceResult { + /** + * An object containing information about the requested device. + */ + device?: Device; + } + export interface GetInstanceProfileRequest { + /** + * The Amazon Resource Name (ARN) of your instance profile. + */ + arn: AmazonResourceName; + } + export interface GetInstanceProfileResult { + /** + * An object containing information about your instance profile. + */ + instanceProfile?: InstanceProfile; + } + export interface GetJobRequest { + /** + * The job's ARN. + */ + arn: AmazonResourceName; + } + export interface GetJobResult { + /** + * An object containing information about the requested job. + */ + job?: Job; + } + export interface GetNetworkProfileRequest { + /** + * The Amazon Resource Name (ARN) of the network profile you want to return information about. + */ + arn: AmazonResourceName; + } + export interface GetNetworkProfileResult { + /** + * The network profile. + */ + networkProfile?: NetworkProfile; + } + export interface GetOfferingStatusRequest { + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface GetOfferingStatusResult { + /** + * When specified, gets the offering status for the current period. + */ + current?: OfferingStatusMap; + /** + * When specified, gets the offering status for the next period. + */ + nextPeriod?: OfferingStatusMap; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface GetProjectRequest { + /** + * The project's ARN. + */ + arn: AmazonResourceName; + } + export interface GetProjectResult { + /** + * The project you wish to get information about. + */ + project?: Project; + } + export interface GetRemoteAccessSessionRequest { + /** + * The Amazon Resource Name (ARN) of the remote access session about which you want to get session information. + */ + arn: AmazonResourceName; + } + export interface GetRemoteAccessSessionResult { + /** + * A container that lists detailed information about the remote access session. + */ + remoteAccessSession?: RemoteAccessSession; + } + export interface GetRunRequest { + /** + * The run's ARN. + */ + arn: AmazonResourceName; + } + export interface GetRunResult { + /** + * The run you wish to get results from. + */ + run?: Run; + } + export interface GetSuiteRequest { + /** + * The suite's ARN. + */ + arn: AmazonResourceName; + } + export interface GetSuiteResult { + /** + * A collection of one or more tests. + */ + suite?: Suite; + } + export interface GetTestRequest { + /** + * The test's ARN. + */ + arn: AmazonResourceName; + } + export interface GetTestResult { + /** + * A test condition that is evaluated. + */ + test?: Test; + } + export interface GetUploadRequest { + /** + * The upload's ARN. + */ + arn: AmazonResourceName; + } + export interface GetUploadResult { + /** + * An app or a set of one or more tests to upload or that have been uploaded. + */ + upload?: Upload; + } + export interface GetVPCEConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe. + */ + arn: AmazonResourceName; + } + export interface GetVPCEConfigurationResult { + /** + * An object containing information about your VPC endpoint configuration. + */ + vpceConfiguration?: VPCEConfiguration; + } + export type HostAddress = string; + export interface IncompatibilityMessage { + /** + * A message about the incompatibility. + */ + message?: Message; + /** + * The type of incompatibility. Allowed values include: ARN: The ARN. FORM_FACTOR: The form factor (for example, phone or tablet). MANUFACTURER: The manufacturer. PLATFORM: The platform (for example, Android or iOS). REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. APPIUM_VERSION: The Appium version for the test. + */ + type?: DeviceAttribute; + } + export type IncompatibilityMessages = IncompatibilityMessage[]; + export interface InstallToRemoteAccessSessionRequest { + /** + * The Amazon Resource Name (ARN) of the remote access session about which you are requesting information. + */ + remoteAccessSessionArn: AmazonResourceName; + /** + * The Amazon Resource Name (ARN) of the app about which you are requesting information. + */ + appArn: AmazonResourceName; + } + export interface InstallToRemoteAccessSessionResult { + /** + * An app to upload or that has been uploaded. + */ + appUpload?: Upload; + } + export type InstanceLabels = String[]; + export interface InstanceProfile { + /** + * The Amazon Resource Name (ARN) of the instance profile. + */ + arn?: AmazonResourceName; + /** + * When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices. + */ + packageCleanup?: Boolean; + /** + * 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. The list of packages is only considered if you set packageCleanup to true. + */ + excludeAppPackagesFromCleanup?: PackageIds; + /** + * When set to true, Device Farm will reboot the instance after a test run. The default value is true. + */ + rebootAfterUse?: Boolean; + /** + * The name of the instance profile. + */ + name?: Name; + /** + * The description of the instance profile. + */ + description?: Message; + } + export type InstanceProfiles = InstanceProfile[]; + export type InstanceStatus = "IN_USE"|"PREPARING"|"AVAILABLE"|"NOT_AVAILABLE"|string; + export type Integer = number; + export type InteractionMode = "INTERACTIVE"|"NO_VIDEO"|"VIDEO_ONLY"|string; + export type IosPaths = String[]; + export interface Job { + /** + * The job's ARN. + */ + arn?: AmazonResourceName; + /** + * The job's name. + */ + name?: Name; + /** + * The job's type. Allowed values include the following: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby test type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type. + */ + type?: TestType; + /** + * When the job was created. + */ + created?: DateTime; + /** + * The job's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status. + */ + status?: ExecutionStatus; + /** + * The job's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition. + */ + result?: ExecutionResult; + /** + * The job's start time. + */ + started?: DateTime; + /** + * The job's stop time. + */ + stopped?: DateTime; + /** + * The job's result counters. + */ + counters?: Counters; + /** + * A message about the job's result. + */ + message?: Message; + /** + * The device (phone or tablet). + */ + device?: Device; + /** + * The Amazon Resource Name (ARN) of the instance. + */ + instanceArn?: AmazonResourceName; + /** + * Represents the total (metered or unmetered) minutes used by the job. + */ + deviceMinutes?: DeviceMinutes; + /** + * The endpoint for streaming device video. + */ + videoEndpoint?: String; + /** + * This value is set to true if video capture is enabled; otherwise, it is set to false. + */ + videoCapture?: VideoCapture; + } + export type JobTimeoutMinutes = number; + export type Jobs = Job[]; + export interface ListArtifactsRequest { + /** + * The Run, Job, Suite, or Test ARN. + */ + arn: AmazonResourceName; + /** + * The artifacts' type. Allowed values include: FILE: The artifacts are files. LOG: The artifacts are logs. SCREENSHOT: The artifacts are screenshots. + */ + type: ArtifactCategory; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListArtifactsResult { + /** + * Information about the artifacts. + */ + artifacts?: Artifacts; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListDeviceInstancesRequest { + /** + * An integer specifying the maximum number of items you want to return in the API response. + */ + maxResults?: Integer; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListDeviceInstancesResult { + /** + * An object containing information about your device instances. + */ + deviceInstances?: DeviceInstances; + /** + * An identifier that can be used in the next call to this operation to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListDevicePoolsRequest { + /** + * The project ARN. + */ + arn: AmazonResourceName; + /** + * The device pools' type. Allowed values include: CURATED: A device pool that is created and managed by AWS Device Farm. PRIVATE: A device pool that is created and managed by the device pool developer. + */ + type?: DevicePoolType; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListDevicePoolsResult { + /** + * Information about the device pools. + */ + devicePools?: DevicePools; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListDevicesRequest { + /** + * The Amazon Resource Name (ARN) of the project. + */ + arn?: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + /** + * Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values. Attribute: The aspect of a device such as platform or model used as the selction criteria in a device filter. Allowed values include: ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". PLATFORM: The device platform. Valid values are "ANDROID" or "IOS". OS_VERSION: The operating system version. For example, "10.3.2". MODEL: The device model. For example, "iPad 5th Gen". AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET". MANUFACTURER: The device manufacturer. For example, "Apple". REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE". Operator: The filter operator. The EQUALS operator is available for every attribute except INSTANCE_LABELS. The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute. Values: An array of one or more filter values. The IN and NOT_IN operators take a values array that has one or more elements. The other operators require an array with a single element. In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values. + */ + filters?: DeviceFilters; + } + export interface ListDevicesResult { + /** + * Information about the devices. + */ + devices?: Devices; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListInstanceProfilesRequest { + /** + * An integer specifying the maximum number of items you want to return in the API response. + */ + maxResults?: Integer; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListInstanceProfilesResult { + /** + * An object containing information about your instance profiles. + */ + instanceProfiles?: InstanceProfiles; + /** + * An identifier that can be used in the next call to this operation to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListJobsRequest { + /** + * The run's Amazon Resource Name (ARN). + */ + arn: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListJobsResult { + /** + * Information about the jobs. + */ + jobs?: Jobs; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListNetworkProfilesRequest { + /** + * The Amazon Resource Name (ARN) of the project for which you want to list network profiles. + */ + arn: AmazonResourceName; + /** + * The type of network profile you wish to return information about. Valid values are listed below. + */ + type?: NetworkProfileType; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListNetworkProfilesResult { + /** + * A list of the available network profiles. + */ + networkProfiles?: NetworkProfiles; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListOfferingPromotionsRequest { + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListOfferingPromotionsResult { + /** + * Information about the offering promotions. + */ + offeringPromotions?: OfferingPromotions; + /** + * An identifier to be used in the next call to this operation, to return the next set of items in the list. + */ + nextToken?: PaginationToken; + } + export interface ListOfferingTransactionsRequest { + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListOfferingTransactionsResult { + /** + * The audit log of subscriptions you have purchased and modified through AWS Device Farm. + */ + offeringTransactions?: OfferingTransactions; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListOfferingsRequest { + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListOfferingsResult { + /** + * A value representing the list offering results. + */ + offerings?: Offerings; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListProjectsRequest { + /** + * Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN. + */ + arn?: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListProjectsResult { + /** + * Information about the projects. + */ + projects?: Projects; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListRemoteAccessSessionsRequest { + /** + * The Amazon Resource Name (ARN) of the remote access session about which you are requesting information. + */ + arn: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListRemoteAccessSessionsResult { + /** + * A container representing the metadata from the service about each remote access session you are requesting. + */ + remoteAccessSessions?: RemoteAccessSessions; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListRunsRequest { + /** + * The Amazon Resource Name (ARN) of the project for which you want to list runs. + */ + arn: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListRunsResult { + /** + * Information about the runs. + */ + runs?: Runs; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListSamplesRequest { + /** + * The Amazon Resource Name (ARN) of the job used to list samples. + */ + arn: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListSamplesResult { + /** + * Information about the samples. + */ + samples?: Samples; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListSuitesRequest { + /** + * The job's Amazon Resource Name (ARN). + */ + arn: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListSuitesResult { + /** + * Information about the suites. + */ + suites?: Suites; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListTestsRequest { + /** + * The test suite's Amazon Resource Name (ARN). + */ + arn: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListTestsResult { + /** + * Information about the tests. + */ + tests?: Tests; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListUniqueProblemsRequest { + /** + * The unique problems' ARNs. + */ + arn: AmazonResourceName; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListUniqueProblemsResult { + /** + * Information about the unique problems. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition. + */ + uniqueProblems?: UniqueProblemsByExecutionResultMap; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListUploadsRequest { + /** + * The Amazon Resource Name (ARN) of the project for which you want to list uploads. + */ + arn: AmazonResourceName; + /** + * The type of upload. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web appliction upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An XCode test package upload. XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An XCode UI test spec upload. + */ + type?: UploadType; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListUploadsResult { + /** + * Information about the uploads. + */ + uploads?: Uploads; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListVPCEConfigurationsRequest { + /** + * An integer specifying the maximum number of items you want to return in the API response. + */ + maxResults?: Integer; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface ListVPCEConfigurationsResult { + /** + * An array of VPCEConfiguration objects containing information about your VPC endpoint configuration. + */ + vpceConfigurations?: VPCEConfigurations; + /** + * 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. + */ + nextToken?: PaginationToken; + } + export interface Location { + /** + * The latitude. + */ + latitude: Double; + /** + * The longitude. + */ + longitude: Double; + } + export type Long = number; + export type MaxSlotMap = {[key: string]: Integer}; + export type Message = string; + export type Metadata = string; + export interface MonetaryAmount { + /** + * The numerical amount of an offering or transaction. + */ + amount?: Double; + /** + * The currency code of a monetary amount. For example, USD means "U.S. dollars." + */ + currencyCode?: CurrencyCode; + } + export type Name = string; + export interface NetworkProfile { + /** + * The Amazon Resource Name (ARN) of the network profile. + */ + arn?: AmazonResourceName; + /** + * The name of the network profile. + */ + name?: Name; + /** + * The description of the network profile. + */ + description?: Message; + /** + * The type of network profile. Valid values are listed below. + */ + type?: NetworkProfileType; + /** + * The data throughput rate in bits per second, as an integer from 0 to 104857600. + */ + uplinkBandwidthBits?: Long; + /** + * The data throughput rate in bits per second, as an integer from 0 to 104857600. + */ + downlinkBandwidthBits?: Long; + /** + * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. + */ + uplinkDelayMs?: Long; + /** + * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. + */ + downlinkDelayMs?: Long; + /** + * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. + */ + uplinkJitterMs?: Long; + /** + * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. + */ + downlinkJitterMs?: Long; + /** + * Proportion of transmitted packets that fail to arrive from 0 to 100 percent. + */ + uplinkLossPercent?: PercentInteger; + /** + * Proportion of received packets that fail to arrive from 0 to 100 percent. + */ + downlinkLossPercent?: PercentInteger; + } + export type NetworkProfileType = "CURATED"|"PRIVATE"|string; + export type NetworkProfiles = NetworkProfile[]; + export interface Offering { + /** + * The ID that corresponds to a device offering. + */ + id?: OfferingIdentifier; + /** + * A string describing the offering. + */ + description?: Message; + /** + * The type of offering (e.g., "RECURRING") for a device. + */ + type?: OfferingType; + /** + * The platform of the device (e.g., ANDROID or IOS). + */ + platform?: DevicePlatform; + /** + * Specifies whether there are recurring charges for the offering. + */ + recurringCharges?: RecurringCharges; + } + export type OfferingIdentifier = string; + export interface OfferingPromotion { + /** + * The ID of the offering promotion. + */ + id?: OfferingPromotionIdentifier; + /** + * A string describing the offering promotion. + */ + description?: Message; + } + export type OfferingPromotionIdentifier = string; + export type OfferingPromotions = OfferingPromotion[]; + export interface OfferingStatus { + /** + * The type specified for the offering status. + */ + type?: OfferingTransactionType; + /** + * Represents the metadata of an offering status. + */ + offering?: Offering; + /** + * The number of available devices in the offering. + */ + quantity?: Integer; + /** + * The date on which the offering is effective. + */ + effectiveOn?: DateTime; + } + export type OfferingStatusMap = {[key: string]: OfferingStatus}; + export interface OfferingTransaction { + /** + * The status of an offering transaction. + */ + offeringStatus?: OfferingStatus; + /** + * The transaction ID of the offering transaction. + */ + transactionId?: TransactionIdentifier; + /** + * The ID that corresponds to a device offering promotion. + */ + offeringPromotionId?: OfferingPromotionIdentifier; + /** + * The date on which an offering transaction was created. + */ + createdOn?: DateTime; + /** + * The cost of an offering transaction. + */ + cost?: MonetaryAmount; + } + export type OfferingTransactionType = "PURCHASE"|"RENEW"|"SYSTEM"|string; + export type OfferingTransactions = OfferingTransaction[]; + export type OfferingType = "RECURRING"|string; + export type Offerings = Offering[]; + export type PackageIds = String[]; + export type PaginationToken = string; + export type PercentInteger = number; + export interface Problem { + /** + * Information about the associated run. + */ + run?: ProblemDetail; + /** + * Information about the associated job. + */ + job?: ProblemDetail; + /** + * Information about the associated suite. + */ + suite?: ProblemDetail; + /** + * Information about the associated test. + */ + test?: ProblemDetail; + /** + * Information about the associated device. + */ + device?: Device; + /** + * The problem's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition. + */ + result?: ExecutionResult; + /** + * A message about the problem's result. + */ + message?: Message; + } + export interface ProblemDetail { + /** + * The problem detail's ARN. + */ + arn?: AmazonResourceName; + /** + * The problem detail's name. + */ + name?: Name; + } + export type Problems = Problem[]; + export interface Project { + /** + * The project's ARN. + */ + arn?: AmazonResourceName; + /** + * The project's name. + */ + name?: Name; + /** + * The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes. + */ + defaultJobTimeoutMinutes?: JobTimeoutMinutes; + /** + * When the project was created. + */ + created?: DateTime; + } + export type Projects = Project[]; + export interface PurchaseOfferingRequest { + /** + * The ID of the offering. + */ + offeringId?: OfferingIdentifier; + /** + * The number of device slots you wish to purchase in an offering request. + */ + quantity?: Integer; + /** + * The ID of the offering promotion to be applied to the purchase. + */ + offeringPromotionId?: OfferingPromotionIdentifier; + } + export interface PurchaseOfferingResult { + /** + * Represents the offering transaction for the purchase result. + */ + offeringTransaction?: OfferingTransaction; + } + export type PurchasedDevicesMap = {[key: string]: Integer}; + export interface Radios { + /** + * True if Wi-Fi is enabled at the beginning of the test; otherwise, false. + */ + wifi?: Boolean; + /** + * True if Bluetooth is enabled at the beginning of the test; otherwise, false. + */ + bluetooth?: Boolean; + /** + * True if NFC is enabled at the beginning of the test; otherwise, false. + */ + nfc?: Boolean; + /** + * True if GPS is enabled at the beginning of the test; otherwise, false. + */ + gps?: Boolean; + } + export interface RecurringCharge { + /** + * The cost of the recurring charge. + */ + cost?: MonetaryAmount; + /** + * The frequency in which charges will recur. + */ + frequency?: RecurringChargeFrequency; + } + export type RecurringChargeFrequency = "MONTHLY"|string; + export type RecurringCharges = RecurringCharge[]; + export interface RemoteAccessSession { + /** + * The Amazon Resource Name (ARN) of the remote access session. + */ + arn?: AmazonResourceName; + /** + * The name of the remote access session. + */ + name?: Name; + /** + * The date and time the remote access session was created. + */ + created?: DateTime; + /** + * The status of the remote access session. Can be any of the following: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status. + */ + status?: ExecutionStatus; + /** + * The result of the remote access session. Can be any of the following: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition. + */ + result?: ExecutionResult; + /** + * A message about the remote access session. + */ + message?: Message; + /** + * The date and time the remote access session was started. + */ + started?: DateTime; + /** + * The date and time the remote access session was stopped. + */ + stopped?: DateTime; + /** + * The device (phone or tablet) used in the remote access session. + */ + device?: Device; + /** + * The Amazon Resource Name (ARN) of the instance. + */ + instanceArn?: AmazonResourceName; + /** + * This flag is set to true if remote debugging is enabled for the remote access session. + */ + remoteDebugEnabled?: Boolean; + /** + * This flag is set to true if remote recording is enabled for the remote access session. + */ + remoteRecordEnabled?: Boolean; + /** + * The Amazon Resource Name (ARN) for the app to be recorded in the remote access session. + */ + remoteRecordAppArn?: AmazonResourceName; + /** + * IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session. + */ + hostAddress?: HostAddress; + /** + * Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session. + */ + clientId?: ClientId; + /** + * The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology." + */ + billingMethod?: BillingMethod; + /** + * The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes). + */ + deviceMinutes?: DeviceMinutes; + /** + * The endpoint for the remote access sesssion. + */ + endpoint?: String; + /** + * Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session. + */ + deviceUdid?: String; + /** + * The interaction mode of the remote access session. Valid values are: INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode. 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 can run XCUITest framework-based tests in this mode. VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode. + */ + interactionMode?: InteractionMode; + /** + * When set to true, 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. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs. + */ + skipAppResign?: SkipAppResign; + } + export type RemoteAccessSessions = RemoteAccessSession[]; + export interface RenewOfferingRequest { + /** + * The ID of a request to renew an offering. + */ + offeringId?: OfferingIdentifier; + /** + * The quantity requested in an offering renewal. + */ + quantity?: Integer; + } + export interface RenewOfferingResult { + /** + * Represents the status of the offering transaction for the renewal. + */ + offeringTransaction?: OfferingTransaction; + } + export interface Resolution { + /** + * The screen resolution's width, expressed in pixels. + */ + width?: Integer; + /** + * The screen resolution's height, expressed in pixels. + */ + height?: Integer; + } + export interface Rule { + /** + * The rule's stringified attribute. For example, specify the value as "\"abc\"". The supported operators for each attribute are provided in the following list. APPIUM_VERSION The Appium version for the test. Supported operators: CONTAINS ARN The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". Supported operators: EQUALS, IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". Supported operators: EQUALS FLEET_TYPE The fleet type. Valid values are "PUBLIC" or "PRIVATE". Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values are "PHONE" or "TABLET". Supported operators: EQUALS, IN, NOT_IN INSTANCE_ARN The Amazon Resource Name (ARN) of the device instance. Supported operators: IN, NOT_IN INSTANCE_LABELS The label of the device instance. Supported operators: CONTAINS MANUFACTURER The device manufacturer. For example, "Apple". Supported operators: EQUALS, IN, NOT_IN MODEL The device model, such as "Apple iPad Air 2" or "Google Pixel". Supported operators: CONTAINS, EQUALS, IN, NOT_IN OS_VERSION The operating system version. For example, "10.3.2". Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN PLATFORM The device platform. Valid values are "ANDROID" or "IOS". Supported operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS + */ + attribute?: DeviceAttribute; + /** + * Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions. + */ + operator?: RuleOperator; + /** + * The rule's value. + */ + value?: String; + } + export type RuleOperator = "EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"IN"|"NOT_IN"|"CONTAINS"|string; + export type Rules = Rule[]; + export interface Run { + /** + * The run's ARN. + */ + arn?: AmazonResourceName; + /** + * The run's name. + */ + name?: Name; + /** + * The run's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type. + */ + type?: TestType; + /** + * The run's platform. Allowed values include: ANDROID: The Android platform. IOS: The iOS platform. + */ + platform?: DevicePlatform; + /** + * When the run was created. + */ + created?: DateTime; + /** + * The run's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status. + */ + status?: ExecutionStatus; + /** + * The run's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition. + */ + result?: ExecutionResult; + /** + * The run's start time. + */ + started?: DateTime; + /** + * The run's stop time. + */ + stopped?: DateTime; + /** + * The run's result counters. + */ + counters?: Counters; + /** + * A message about the run's result. + */ + message?: Message; + /** + * The total number of jobs for the run. + */ + totalJobs?: Integer; + /** + * The total number of completed jobs. + */ + completedJobs?: Integer; + /** + * Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered. + */ + billingMethod?: BillingMethod; + /** + * Represents the total (metered or unmetered) minutes used by the test run. + */ + deviceMinutes?: DeviceMinutes; + /** + * The network profile being used for a test run. + */ + networkProfile?: NetworkProfile; + /** + * 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. + */ + parsingResultUrl?: String; + /** + * Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure. + */ + resultCode?: ExecutionResultCode; + /** + * For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences. + */ + seed?: Integer; + /** + * An app to upload or that has been uploaded. + */ + appUpload?: AmazonResourceName; + /** + * For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform. + */ + eventCount?: Integer; + /** + * The number of minutes the job will execute before it times out. + */ + jobTimeoutMinutes?: JobTimeoutMinutes; + /** + * The ARN of the device pool for the run. + */ + devicePoolArn?: AmazonResourceName; + /** + * Information about the locale that is used for the run. + */ + locale?: String; + /** + * Information about the radio states for the run. + */ + radios?: Radios; + /** + * Information about the location that is used for the run. + */ + location?: Location; + /** + * Output CustomerArtifactPaths object for the test run. + */ + customerArtifactPaths?: CustomerArtifactPaths; + /** + * The Device Farm console URL for the recording of the run. + */ + webUrl?: String; + /** + * When set to true, 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. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs. + */ + skipAppResign?: SkipAppResign; + /** + * The ARN of the YAML-formatted test specification for the run. + */ + testSpecArn?: AmazonResourceName; + /** + * The results of a device filter used to select the devices for a test run. + */ + deviceSelectionResult?: DeviceSelectionResult; + } + export type Runs = Run[]; + export interface Sample { + /** + * The sample's ARN. + */ + arn?: AmazonResourceName; + /** + * The sample's type. Must be one of the following values: CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage. MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes. NATIVE_AVG_DRAWTIME NATIVE_FPS NATIVE_FRAMES NATIVE_MAX_DRAWTIME NATIVE_MIN_DRAWTIME OPENGL_AVG_DRAWTIME OPENGL_FPS OPENGL_FRAMES OPENGL_MAX_DRAWTIME OPENGL_MIN_DRAWTIME RX RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process. THREADS: A threads sample type. This is expressed as the total number of threads per app process. TX TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process. + */ + type?: SampleType; + /** + * The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file. + */ + url?: URL; + } + export type SampleType = "CPU"|"MEMORY"|"THREADS"|"RX_RATE"|"TX_RATE"|"RX"|"TX"|"NATIVE_FRAMES"|"NATIVE_FPS"|"NATIVE_MIN_DRAWTIME"|"NATIVE_AVG_DRAWTIME"|"NATIVE_MAX_DRAWTIME"|"OPENGL_FRAMES"|"OPENGL_FPS"|"OPENGL_MIN_DRAWTIME"|"OPENGL_AVG_DRAWTIME"|"OPENGL_MAX_DRAWTIME"|string; + export type Samples = Sample[]; + export interface ScheduleRunConfiguration { + /** + * The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS. + */ + extraDataPackageArn?: AmazonResourceName; + /** + * Reserved for internal use. + */ + networkProfileArn?: AmazonResourceName; + /** + * Information about the locale that is used for the run. + */ + locale?: String; + /** + * Information about the location that is used for the run. + */ + location?: Location; + /** + * An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations. + */ + vpceConfigurationArns?: AmazonResourceNames; + /** + * Input CustomerArtifactPaths object for the scheduled run configuration. + */ + customerArtifactPaths?: CustomerArtifactPaths; + /** + * Information about the radio states for the run. + */ + radios?: Radios; + /** + * A list of auxiliary apps for the run. + */ + auxiliaryApps?: AmazonResourceNames; + /** + * Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered. + */ + billingMethod?: BillingMethod; + } + export interface ScheduleRunRequest { + /** + * The ARN of the project for the run to be scheduled. + */ + projectArn: AmazonResourceName; + /** + * The ARN of the app to schedule a run. + */ + appArn?: AmazonResourceName; + /** + * The ARN of the device pool for the run to be scheduled. + */ + devicePoolArn?: AmazonResourceName; + /** + * The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run. Either devicePoolArn or deviceSelectionConfiguration is required in a request. + */ + deviceSelectionConfiguration?: DeviceSelectionConfiguration; + /** + * The name for the run to be scheduled. + */ + name?: Name; + /** + * Information about the test for the run to be scheduled. + */ + test: ScheduleRunTest; + /** + * Information about the settings for the run to be scheduled. + */ + configuration?: ScheduleRunConfiguration; + /** + * Specifies configuration information about a test run, such as the execution timeout (in minutes). + */ + executionConfiguration?: ExecutionConfiguration; + } + export interface ScheduleRunResult { + /** + * Information about the scheduled run. + */ + run?: Run; + } + export interface ScheduleRunTest { + /** + * The test's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type. + */ + type: TestType; + /** + * The ARN of the uploaded test that will be run. + */ + testPackageArn?: AmazonResourceName; + /** + * The ARN of the YAML-formatted test specification. + */ + testSpecArn?: AmazonResourceName; + /** + * The test's filter. + */ + filter?: Filter; + /** + * The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings. For all tests: app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to "false" to disable it. For Calabash tests: profile: A cucumber profile, for example, "my_profile_name". tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, "@smoke" or "@smoke,~@wip". For Appium tests (all types): appium_version: The Appium version. Currently supported values are "1.6.5" (and higher), "latest", and "default". “latest” will run the latest Appium version supported by Device Farm (1.9.1). For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later. This behavior is subject to change. For Fuzz tests (Android only): event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform. throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events. seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences. For Explorer tests: username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted. password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted. For Instrumentation: filter: A test filter string. Examples: Running a single test case: "com.android.abc.Test1" Running a single test: "com.android.abc.Test1#smoke" Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2" For XCTest and XCTestUI: filter: A test filter string. Examples: Running a single test class: "LoginTests" Running a multiple test classes: "LoginTests,SmokeTests" Running a single test: "LoginTests/testValid" Running multiple tests: "LoginTests/testValid,LoginTests/testInvalid" For UIAutomator: filter: A test filter string. Examples: Running a single test case: "com.android.abc.Test1" Running a single test: "com.android.abc.Test1#smoke" Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2" + */ + parameters?: TestParameters; + } + export type ServiceDnsName = string; + export type SkipAppResign = boolean; + export type SshPublicKey = string; + export interface StopJobRequest { + /** + * Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop. + */ + arn: AmazonResourceName; + } + export interface StopJobResult { + /** + * The job that was stopped. + */ + job?: Job; + } + export interface StopRemoteAccessSessionRequest { + /** + * The Amazon Resource Name (ARN) of the remote access session you wish to stop. + */ + arn: AmazonResourceName; + } + export interface StopRemoteAccessSessionResult { + /** + * A container representing the metadata from the service about the remote access session you are stopping. + */ + remoteAccessSession?: RemoteAccessSession; + } + export interface StopRunRequest { + /** + * Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop. + */ + arn: AmazonResourceName; + } + export interface StopRunResult { + /** + * The run that was stopped. + */ + run?: Run; + } + export type String = string; + export interface Suite { + /** + * The suite's ARN. + */ + arn?: AmazonResourceName; + /** + * The suite's name. + */ + name?: Name; + /** + * The suite's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type. + */ + type?: TestType; + /** + * When the suite was created. + */ + created?: DateTime; + /** + * The suite's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status. + */ + status?: ExecutionStatus; + /** + * The suite's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition. + */ + result?: ExecutionResult; + /** + * The suite's start time. + */ + started?: DateTime; + /** + * The suite's stop time. + */ + stopped?: DateTime; + /** + * The suite's result counters. + */ + counters?: Counters; + /** + * A message about the suite's result. + */ + message?: Message; + /** + * Represents the total (metered or unmetered) minutes used by the test suite. + */ + deviceMinutes?: DeviceMinutes; + } + export type Suites = Suite[]; + export interface Test { + /** + * The test's ARN. + */ + arn?: AmazonResourceName; + /** + * The test's name. + */ + name?: Name; + /** + * The test's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type. + */ + type?: TestType; + /** + * When the test was created. + */ + created?: DateTime; + /** + * The test's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status. + */ + status?: ExecutionStatus; + /** + * The test's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition. + */ + result?: ExecutionResult; + /** + * The test's start time. + */ + started?: DateTime; + /** + * The test's stop time. + */ + stopped?: DateTime; + /** + * The test's result counters. + */ + counters?: Counters; + /** + * A message about the test's result. + */ + message?: Message; + /** + * Represents the total (metered or unmetered) minutes used by the test. + */ + deviceMinutes?: DeviceMinutes; + } + export type TestParameters = {[key: string]: String}; + export type TestType = "BUILTIN_FUZZ"|"BUILTIN_EXPLORER"|"WEB_PERFORMANCE_PROFILE"|"APPIUM_JAVA_JUNIT"|"APPIUM_JAVA_TESTNG"|"APPIUM_PYTHON"|"APPIUM_NODE"|"APPIUM_RUBY"|"APPIUM_WEB_JAVA_JUNIT"|"APPIUM_WEB_JAVA_TESTNG"|"APPIUM_WEB_PYTHON"|"APPIUM_WEB_NODE"|"APPIUM_WEB_RUBY"|"CALABASH"|"INSTRUMENTATION"|"UIAUTOMATION"|"UIAUTOMATOR"|"XCTEST"|"XCTEST_UI"|"REMOTE_ACCESS_RECORD"|"REMOTE_ACCESS_REPLAY"|string; + export type Tests = Test[]; + export type TransactionIdentifier = string; + export interface TrialMinutes { + /** + * The total number of free trial minutes that the account started with. + */ + total?: Double; + /** + * The number of free trial minutes remaining in the account. + */ + remaining?: Double; + } + export type URL = string; + export interface UniqueProblem { + /** + * A message about the unique problems' result. + */ + message?: Message; + /** + * Information about the problems. + */ + problems?: Problems; + } + export type UniqueProblems = UniqueProblem[]; + export type UniqueProblemsByExecutionResultMap = {[key: string]: UniqueProblems}; + export interface UpdateDeviceInstanceRequest { + /** + * The Amazon Resource Name (ARN) of the device instance. + */ + arn: AmazonResourceName; + /** + * The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance. + */ + profileArn?: AmazonResourceName; + /** + * An array of strings that you want to associate with the device instance. + */ + labels?: InstanceLabels; + } + export interface UpdateDeviceInstanceResult { + /** + * An object containing information about your device instance. + */ + deviceInstance?: DeviceInstance; + } + export interface UpdateDevicePoolRequest { + /** + * The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update. + */ + arn: AmazonResourceName; + /** + * A string representing the name of the device pool you wish to update. + */ + name?: Name; + /** + * A description of the device pool you wish to update. + */ + description?: Message; + /** + * Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules. + */ + rules?: Rules; + /** + * The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests. If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request. + */ + maxDevices?: Integer; + /** + * Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the rules parameter. If you use this parameter in your request, you cannot use the maxDevices parameter in the same request. + */ + clearMaxDevices?: Boolean; + } + export interface UpdateDevicePoolResult { + /** + * The device pool you just updated. + */ + devicePool?: DevicePool; + } + export interface UpdateInstanceProfileRequest { + /** + * The Amazon Resource Name (ARN) of the instance profile. + */ + arn: AmazonResourceName; + /** + * The updated name for your instance profile. + */ + name?: Name; + /** + * The updated description for your instance profile. + */ + description?: Message; + /** + * The updated choice for whether you want to specify package cleanup. The default value is false for private devices. + */ + packageCleanup?: Boolean; + /** + * 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. The list of packages is only considered if you set packageCleanup to true. + */ + excludeAppPackagesFromCleanup?: PackageIds; + /** + * The updated choice for whether you want to reboot the device after use. The default value is true. + */ + rebootAfterUse?: Boolean; + } + export interface UpdateInstanceProfileResult { + /** + * An object containing information about your instance profile. + */ + instanceProfile?: InstanceProfile; + } + export interface UpdateNetworkProfileRequest { + /** + * The Amazon Resource Name (ARN) of the project for which you want to update network profile settings. + */ + arn: AmazonResourceName; + /** + * The name of the network profile about which you are returning information. + */ + name?: Name; + /** + * The descriptoin of the network profile about which you are returning information. + */ + description?: Message; + /** + * The type of network profile you wish to return information about. Valid values are listed below. + */ + type?: NetworkProfileType; + /** + * The data throughput rate in bits per second, as an integer from 0 to 104857600. + */ + uplinkBandwidthBits?: Long; + /** + * The data throughput rate in bits per second, as an integer from 0 to 104857600. + */ + downlinkBandwidthBits?: Long; + /** + * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. + */ + uplinkDelayMs?: Long; + /** + * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. + */ + downlinkDelayMs?: Long; + /** + * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. + */ + uplinkJitterMs?: Long; + /** + * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. + */ + downlinkJitterMs?: Long; + /** + * Proportion of transmitted packets that fail to arrive from 0 to 100 percent. + */ + uplinkLossPercent?: PercentInteger; + /** + * Proportion of received packets that fail to arrive from 0 to 100 percent. + */ + downlinkLossPercent?: PercentInteger; + } + export interface UpdateNetworkProfileResult { + /** + * A list of the available network profiles. + */ + networkProfile?: NetworkProfile; + } + export interface UpdateProjectRequest { + /** + * The Amazon Resource Name (ARN) of the project whose name you wish to update. + */ + arn: AmazonResourceName; + /** + * A string representing the new name of the project that you are updating. + */ + name?: Name; + /** + * The number of minutes a test run in the project will execute before it times out. + */ + defaultJobTimeoutMinutes?: JobTimeoutMinutes; + } + export interface UpdateProjectResult { + /** + * The project you wish to update. + */ + project?: Project; + } + export interface UpdateUploadRequest { + /** + * The Amazon Resource Name (ARN) of the uploaded test spec. + */ + arn: AmazonResourceName; + /** + * The upload's test spec file name. The name should not contain the '/' character. The test spec file name must end with the .yaml or .yml file extension. + */ + name?: Name; + /** + * The upload's content type (for example, "application/x-yaml"). + */ + contentType?: ContentType; + /** + * Set to true if the YAML file has changed and needs to be updated; otherwise, set to false. + */ + editContent?: Boolean; + } + export interface UpdateUploadResult { + /** + * A test spec uploaded to Device Farm. + */ + upload?: Upload; + } + export interface UpdateVPCEConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update. + */ + arn: AmazonResourceName; + /** + * The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily. + */ + vpceConfigurationName?: VPCEConfigurationName; + /** + * The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test. + */ + vpceServiceName?: VPCEServiceName; + /** + * 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. + */ + serviceDnsName?: ServiceDnsName; + /** + * An optional description, providing more details about your VPC endpoint configuration. + */ + vpceConfigurationDescription?: VPCEConfigurationDescription; + } + export interface UpdateVPCEConfigurationResult { + /** + * An object containing information about your VPC endpoint configuration. + */ + vpceConfiguration?: VPCEConfiguration; + } + export interface Upload { + /** + * The upload's ARN. + */ + arn?: AmazonResourceName; + /** + * The upload's file name. + */ + name?: Name; + /** + * When the upload was created. + */ + created?: DateTime; + /** + * The upload's type. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web appliction upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An XCode test package upload. XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An XCode UI test spec upload. + */ + type?: UploadType; + /** + * The upload's status. Must be one of the following values: FAILED: A failed status. INITIALIZED: An initialized status. PROCESSING: A processing status. SUCCEEDED: A succeeded status. + */ + status?: UploadStatus; + /** + * The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request. + */ + url?: URL; + /** + * The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded. + */ + metadata?: Metadata; + /** + * The upload's content type (for example, "application/octet-stream"). + */ + contentType?: ContentType; + /** + * A message about the upload's result. + */ + message?: Message; + /** + * The upload's category. Allowed values include: CURATED: An upload managed by AWS Device Farm. PRIVATE: An upload managed by the AWS Device Farm customer. + */ + category?: UploadCategory; + } + export type UploadCategory = "CURATED"|"PRIVATE"|string; + export type UploadStatus = "INITIALIZED"|"PROCESSING"|"SUCCEEDED"|"FAILED"|string; + export type UploadType = "ANDROID_APP"|"IOS_APP"|"WEB_APP"|"EXTERNAL_DATA"|"APPIUM_JAVA_JUNIT_TEST_PACKAGE"|"APPIUM_JAVA_TESTNG_TEST_PACKAGE"|"APPIUM_PYTHON_TEST_PACKAGE"|"APPIUM_NODE_TEST_PACKAGE"|"APPIUM_RUBY_TEST_PACKAGE"|"APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE"|"APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE"|"APPIUM_WEB_PYTHON_TEST_PACKAGE"|"APPIUM_WEB_NODE_TEST_PACKAGE"|"APPIUM_WEB_RUBY_TEST_PACKAGE"|"CALABASH_TEST_PACKAGE"|"INSTRUMENTATION_TEST_PACKAGE"|"UIAUTOMATION_TEST_PACKAGE"|"UIAUTOMATOR_TEST_PACKAGE"|"XCTEST_TEST_PACKAGE"|"XCTEST_UI_TEST_PACKAGE"|"APPIUM_JAVA_JUNIT_TEST_SPEC"|"APPIUM_JAVA_TESTNG_TEST_SPEC"|"APPIUM_PYTHON_TEST_SPEC"|"APPIUM_NODE_TEST_SPEC"|"APPIUM_RUBY_TEST_SPEC"|"APPIUM_WEB_JAVA_JUNIT_TEST_SPEC"|"APPIUM_WEB_JAVA_TESTNG_TEST_SPEC"|"APPIUM_WEB_PYTHON_TEST_SPEC"|"APPIUM_WEB_NODE_TEST_SPEC"|"APPIUM_WEB_RUBY_TEST_SPEC"|"INSTRUMENTATION_TEST_SPEC"|"XCTEST_UI_TEST_SPEC"|string; + export type Uploads = Upload[]; + export interface VPCEConfiguration { + /** + * The Amazon Resource Name (ARN) of the VPC endpoint configuration. + */ + arn?: AmazonResourceName; + /** + * The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily. + */ + vpceConfigurationName?: VPCEConfigurationName; + /** + * The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test. + */ + vpceServiceName?: VPCEServiceName; + /** + * The DNS name that maps to the private IP address of the service you want to access. + */ + serviceDnsName?: ServiceDnsName; + /** + * An optional description, providing more details about your VPC endpoint configuration. + */ + vpceConfigurationDescription?: VPCEConfigurationDescription; + } + export type VPCEConfigurationDescription = string; + export type VPCEConfigurationName = string; + export type VPCEConfigurations = VPCEConfiguration[]; + export type VPCEServiceName = string; + export type VideoCapture = boolean; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-06-23"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DeviceFarm client. + */ + export import Types = DeviceFarm; +} +export = DeviceFarm; diff --git a/node_modules/aws-sdk/clients/devicefarm.js b/node_modules/aws-sdk/clients/devicefarm.js new file mode 100644 index 0000000..8b828a1 --- /dev/null +++ b/node_modules/aws-sdk/clients/devicefarm.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['devicefarm'] = {}; +AWS.DeviceFarm = Service.defineService('devicefarm', ['2015-06-23']); +Object.defineProperty(apiLoader.services['devicefarm'], '2015-06-23', { + get: function get() { + var model = require('../apis/devicefarm-2015-06-23.min.json'); + model.paginators = require('../apis/devicefarm-2015-06-23.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DeviceFarm; diff --git a/node_modules/aws-sdk/clients/directconnect.d.ts b/node_modules/aws-sdk/clients/directconnect.d.ts new file mode 100644 index 0000000..8adf3ca --- /dev/null +++ b/node_modules/aws-sdk/clients/directconnect.d.ts @@ -0,0 +1,2101 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DirectConnect extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DirectConnect.Types.ClientConfiguration) + config: Config & DirectConnect.Types.ClientConfiguration; + /** + * Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway. + */ + acceptDirectConnectGatewayAssociationProposal(params: DirectConnect.Types.AcceptDirectConnectGatewayAssociationProposalRequest, callback?: (err: AWSError, data: DirectConnect.Types.AcceptDirectConnectGatewayAssociationProposalResult) => void): Request; + /** + * Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway. + */ + acceptDirectConnectGatewayAssociationProposal(callback?: (err: AWSError, data: DirectConnect.Types.AcceptDirectConnectGatewayAssociationProposalResult) => void): Request; + /** + * Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on an interconnect. Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect. Intended for use by AWS Direct Connect Partners only. + */ + allocateConnectionOnInterconnect(params: DirectConnect.Types.AllocateConnectionOnInterconnectRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on an interconnect. Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect. Intended for use by AWS Direct Connect Partners only. + */ + allocateConnectionOnInterconnect(callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects. Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity. Intended for use by AWS Direct Connect Partners only. + */ + allocateHostedConnection(params: DirectConnect.Types.AllocateHostedConnectionRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects. Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity. Intended for use by AWS Direct Connect Partners only. + */ + allocateHostedConnection(callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Provisions a private virtual interface to be owned by the specified AWS account. Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic. + */ + allocatePrivateVirtualInterface(params: DirectConnect.Types.AllocatePrivateVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Provisions a private virtual interface to be owned by the specified AWS account. Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic. + */ + allocatePrivateVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Provisions a public virtual interface to be owned by the specified AWS account. The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account. Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic. When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. + */ + allocatePublicVirtualInterface(params: DirectConnect.Types.AllocatePublicVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Provisions a public virtual interface to be owned by the specified AWS account. The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account. Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic. When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. + */ + allocatePublicVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway. The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account. After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic. + */ + allocateTransitVirtualInterface(params: DirectConnect.Types.AllocateTransitVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.AllocateTransitVirtualInterfaceResult) => void): Request; + /** + * Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway. The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account. After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic. + */ + allocateTransitVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.AllocateTransitVirtualInterfaceResult) => void): Request; + /** + * Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails. Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG. For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG. + */ + associateConnectionWithLag(params: DirectConnect.Types.AssociateConnectionWithLagRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails. Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG. For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG. + */ + associateConnectionWithLag(callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated. Intended for use by AWS Direct Connect Partners only. + */ + associateHostedConnection(params: DirectConnect.Types.AssociateHostedConnectionRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated. Intended for use by AWS Direct Connect Partners only. + */ + associateHostedConnection(callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection. To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association. + */ + associateVirtualInterface(params: DirectConnect.Types.AssociateVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection. To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association. + */ + associateVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Confirms the creation of the specified hosted connection on an interconnect. Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection. + */ + confirmConnection(params: DirectConnect.Types.ConfirmConnectionRequest, callback?: (err: AWSError, data: DirectConnect.Types.ConfirmConnectionResponse) => void): Request; + /** + * Confirms the creation of the specified hosted connection on an interconnect. Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection. + */ + confirmConnection(callback?: (err: AWSError, data: DirectConnect.Types.ConfirmConnectionResponse) => void): Request; + /** + * Accepts ownership of a private virtual interface created by another AWS account. After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic. + */ + confirmPrivateVirtualInterface(params: DirectConnect.Types.ConfirmPrivateVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.ConfirmPrivateVirtualInterfaceResponse) => void): Request; + /** + * Accepts ownership of a private virtual interface created by another AWS account. After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic. + */ + confirmPrivateVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.ConfirmPrivateVirtualInterfaceResponse) => void): Request; + /** + * Accepts ownership of a public virtual interface created by another AWS account. After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic. + */ + confirmPublicVirtualInterface(params: DirectConnect.Types.ConfirmPublicVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.ConfirmPublicVirtualInterfaceResponse) => void): Request; + /** + * Accepts ownership of a public virtual interface created by another AWS account. After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic. + */ + confirmPublicVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.ConfirmPublicVirtualInterfaceResponse) => void): Request; + /** + * Accepts ownership of a transit virtual interface created by another AWS account. After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic. + */ + confirmTransitVirtualInterface(params: DirectConnect.Types.ConfirmTransitVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.ConfirmTransitVirtualInterfaceResponse) => void): Request; + /** + * Accepts ownership of a transit virtual interface created by another AWS account. After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic. + */ + confirmTransitVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.ConfirmTransitVirtualInterfaceResponse) => void): Request; + /** + * Creates a BGP peer on the specified virtual interface. You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family. If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface. When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface. + */ + createBGPPeer(params: DirectConnect.Types.CreateBGPPeerRequest, callback?: (err: AWSError, data: DirectConnect.Types.CreateBGPPeerResponse) => void): Request; + /** + * Creates a BGP peer on the specified virtual interface. You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family. If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface. When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface. + */ + createBGPPeer(callback?: (err: AWSError, data: DirectConnect.Types.CreateBGPPeerResponse) => void): Request; + /** + * Creates a connection between a customer network and a specific AWS Direct Connect location. A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. To find the locations for your Region, use DescribeLocations. You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created. + */ + createConnection(params: DirectConnect.Types.CreateConnectionRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Creates a connection between a customer network and a specific AWS Direct Connect location. A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. To find the locations for your Region, use DescribeLocations. You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created. + */ + createConnection(callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them. + */ + createDirectConnectGateway(params: DirectConnect.Types.CreateDirectConnectGatewayRequest, callback?: (err: AWSError, data: DirectConnect.Types.CreateDirectConnectGatewayResult) => void): Request; + /** + * Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them. + */ + createDirectConnectGateway(callback?: (err: AWSError, data: DirectConnect.Types.CreateDirectConnectGatewayResult) => void): Request; + /** + * Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway. + */ + createDirectConnectGatewayAssociation(params: DirectConnect.Types.CreateDirectConnectGatewayAssociationRequest, callback?: (err: AWSError, data: DirectConnect.Types.CreateDirectConnectGatewayAssociationResult) => void): Request; + /** + * Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway. + */ + createDirectConnectGatewayAssociation(callback?: (err: AWSError, data: DirectConnect.Types.CreateDirectConnectGatewayAssociationResult) => void): Request; + /** + * Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway. You can only associate a Direct Connect gateway and virtual private gateway or transit gateway when the account that owns the Direct Connect gateway and the account that owns the virtual private gateway or transit gateway have the same AWS Payer ID. + */ + createDirectConnectGatewayAssociationProposal(params: DirectConnect.Types.CreateDirectConnectGatewayAssociationProposalRequest, callback?: (err: AWSError, data: DirectConnect.Types.CreateDirectConnectGatewayAssociationProposalResult) => void): Request; + /** + * Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway. You can only associate a Direct Connect gateway and virtual private gateway or transit gateway when the account that owns the Direct Connect gateway and the account that owns the virtual private gateway or transit gateway have the same AWS Payer ID. + */ + createDirectConnectGatewayAssociationProposal(callback?: (err: AWSError, data: DirectConnect.Types.CreateDirectConnectGatewayAssociationProposalResult) => void): Request; + /** + * Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location. An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created. For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner. Intended for use by AWS Direct Connect Partners only. + */ + createInterconnect(params: DirectConnect.Types.CreateInterconnectRequest, callback?: (err: AWSError, data: DirectConnect.Types.Interconnect) => void): Request; + /** + * Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location. An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created. For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner. Intended for use by AWS Direct Connect Partners only. + */ + createInterconnect(callback?: (err: AWSError, data: DirectConnect.Types.Interconnect) => void): Request; + /** + * Creates a link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface. All connections in a LAG must use the same bandwidth and must terminate at the same AWS Direct Connect endpoint. You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created. You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change. If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured. + */ + createLag(params: DirectConnect.Types.CreateLagRequest, callback?: (err: AWSError, data: DirectConnect.Types.Lag) => void): Request; + /** + * Creates a link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface. All connections in a LAG must use the same bandwidth and must terminate at the same AWS Direct Connect endpoint. You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created. You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change. If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured. + */ + createLag(callback?: (err: AWSError, data: DirectConnect.Types.Lag) => void): Request; + /** + * Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region. + */ + createPrivateVirtualInterface(params: DirectConnect.Types.CreatePrivateVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region. + */ + createPrivateVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon S3. When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported. + */ + createPublicVirtualInterface(params: DirectConnect.Types.CreatePublicVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon S3. When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported. + */ + createPublicVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Creates a transit virtual interface. A transit virtual interface is a VLAN that transports traffic from a Direct Connect gateway to one or more transit gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway. + */ + createTransitVirtualInterface(params: DirectConnect.Types.CreateTransitVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.CreateTransitVirtualInterfaceResult) => void): Request; + /** + * Creates a transit virtual interface. A transit virtual interface is a VLAN that transports traffic from a Direct Connect gateway to one or more transit gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway. + */ + createTransitVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.CreateTransitVirtualInterfaceResult) => void): Request; + /** + * Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface. + */ + deleteBGPPeer(params: DirectConnect.Types.DeleteBGPPeerRequest, callback?: (err: AWSError, data: DirectConnect.Types.DeleteBGPPeerResponse) => void): Request; + /** + * Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface. + */ + deleteBGPPeer(callback?: (err: AWSError, data: DirectConnect.Types.DeleteBGPPeerResponse) => void): Request; + /** + * Deletes the specified connection. Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately. + */ + deleteConnection(params: DirectConnect.Types.DeleteConnectionRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Deletes the specified connection. Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately. + */ + deleteConnection(callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways that are associated with the Direct Connect gateway. + */ + deleteDirectConnectGateway(params: DirectConnect.Types.DeleteDirectConnectGatewayRequest, callback?: (err: AWSError, data: DirectConnect.Types.DeleteDirectConnectGatewayResult) => void): Request; + /** + * Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways that are associated with the Direct Connect gateway. + */ + deleteDirectConnectGateway(callback?: (err: AWSError, data: DirectConnect.Types.DeleteDirectConnectGatewayResult) => void): Request; + /** + * Deletes the association between the specified Direct Connect gateway and virtual private gateway. + */ + deleteDirectConnectGatewayAssociation(params: DirectConnect.Types.DeleteDirectConnectGatewayAssociationRequest, callback?: (err: AWSError, data: DirectConnect.Types.DeleteDirectConnectGatewayAssociationResult) => void): Request; + /** + * Deletes the association between the specified Direct Connect gateway and virtual private gateway. + */ + deleteDirectConnectGatewayAssociation(callback?: (err: AWSError, data: DirectConnect.Types.DeleteDirectConnectGatewayAssociationResult) => void): Request; + /** + * Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway. + */ + deleteDirectConnectGatewayAssociationProposal(params: DirectConnect.Types.DeleteDirectConnectGatewayAssociationProposalRequest, callback?: (err: AWSError, data: DirectConnect.Types.DeleteDirectConnectGatewayAssociationProposalResult) => void): Request; + /** + * Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway. + */ + deleteDirectConnectGatewayAssociationProposal(callback?: (err: AWSError, data: DirectConnect.Types.DeleteDirectConnectGatewayAssociationProposalResult) => void): Request; + /** + * Deletes the specified interconnect. Intended for use by AWS Direct Connect Partners only. + */ + deleteInterconnect(params: DirectConnect.Types.DeleteInterconnectRequest, callback?: (err: AWSError, data: DirectConnect.Types.DeleteInterconnectResponse) => void): Request; + /** + * Deletes the specified interconnect. Intended for use by AWS Direct Connect Partners only. + */ + deleteInterconnect(callback?: (err: AWSError, data: DirectConnect.Types.DeleteInterconnectResponse) => void): Request; + /** + * Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections. + */ + deleteLag(params: DirectConnect.Types.DeleteLagRequest, callback?: (err: AWSError, data: DirectConnect.Types.Lag) => void): Request; + /** + * Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections. + */ + deleteLag(callback?: (err: AWSError, data: DirectConnect.Types.Lag) => void): Request; + /** + * Deletes a virtual interface. + */ + deleteVirtualInterface(params: DirectConnect.Types.DeleteVirtualInterfaceRequest, callback?: (err: AWSError, data: DirectConnect.Types.DeleteVirtualInterfaceResponse) => void): Request; + /** + * Deletes a virtual interface. + */ + deleteVirtualInterface(callback?: (err: AWSError, data: DirectConnect.Types.DeleteVirtualInterfaceResponse) => void): Request; + /** + * Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for a connection. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide. + */ + describeConnectionLoa(params: DirectConnect.Types.DescribeConnectionLoaRequest, callback?: (err: AWSError, data: DirectConnect.Types.DescribeConnectionLoaResponse) => void): Request; + /** + * Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for a connection. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide. + */ + describeConnectionLoa(callback?: (err: AWSError, data: DirectConnect.Types.DescribeConnectionLoaResponse) => void): Request; + /** + * Displays the specified connection or all connections in this Region. + */ + describeConnections(params: DirectConnect.Types.DescribeConnectionsRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connections) => void): Request; + /** + * Displays the specified connection or all connections in this Region. + */ + describeConnections(callback?: (err: AWSError, data: DirectConnect.Types.Connections) => void): Request; + /** + * Deprecated. Use DescribeHostedConnections instead. Lists the connections that have been provisioned on the specified interconnect. Intended for use by AWS Direct Connect Partners only. + */ + describeConnectionsOnInterconnect(params: DirectConnect.Types.DescribeConnectionsOnInterconnectRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connections) => void): Request; + /** + * Deprecated. Use DescribeHostedConnections instead. Lists the connections that have been provisioned on the specified interconnect. Intended for use by AWS Direct Connect Partners only. + */ + describeConnectionsOnInterconnect(callback?: (err: AWSError, data: DirectConnect.Types.Connections) => void): Request; + /** + * Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway. + */ + describeDirectConnectGatewayAssociationProposals(params: DirectConnect.Types.DescribeDirectConnectGatewayAssociationProposalsRequest, callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewayAssociationProposalsResult) => void): Request; + /** + * Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway. + */ + describeDirectConnectGatewayAssociationProposals(callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewayAssociationProposalsResult) => void): Request; + /** + * Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway. + */ + describeDirectConnectGatewayAssociations(params: DirectConnect.Types.DescribeDirectConnectGatewayAssociationsRequest, callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewayAssociationsResult) => void): Request; + /** + * Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway. + */ + describeDirectConnectGatewayAssociations(callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewayAssociationsResult) => void): Request; + /** + * Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface. + */ + describeDirectConnectGatewayAttachments(params: DirectConnect.Types.DescribeDirectConnectGatewayAttachmentsRequest, callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewayAttachmentsResult) => void): Request; + /** + * Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface. + */ + describeDirectConnectGatewayAttachments(callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewayAttachmentsResult) => void): Request; + /** + * Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned. + */ + describeDirectConnectGateways(params: DirectConnect.Types.DescribeDirectConnectGatewaysRequest, callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewaysResult) => void): Request; + /** + * Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned. + */ + describeDirectConnectGateways(callback?: (err: AWSError, data: DirectConnect.Types.DescribeDirectConnectGatewaysResult) => void): Request; + /** + * Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG). Intended for use by AWS Direct Connect Partners only. + */ + describeHostedConnections(params: DirectConnect.Types.DescribeHostedConnectionsRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connections) => void): Request; + /** + * Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG). Intended for use by AWS Direct Connect Partners only. + */ + describeHostedConnections(callback?: (err: AWSError, data: DirectConnect.Types.Connections) => void): Request; + /** + * Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for the specified interconnect. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide. + */ + describeInterconnectLoa(params: DirectConnect.Types.DescribeInterconnectLoaRequest, callback?: (err: AWSError, data: DirectConnect.Types.DescribeInterconnectLoaResponse) => void): Request; + /** + * Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for the specified interconnect. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide. + */ + describeInterconnectLoa(callback?: (err: AWSError, data: DirectConnect.Types.DescribeInterconnectLoaResponse) => void): Request; + /** + * Lists the interconnects owned by the AWS account or only the specified interconnect. + */ + describeInterconnects(params: DirectConnect.Types.DescribeInterconnectsRequest, callback?: (err: AWSError, data: DirectConnect.Types.Interconnects) => void): Request; + /** + * Lists the interconnects owned by the AWS account or only the specified interconnect. + */ + describeInterconnects(callback?: (err: AWSError, data: DirectConnect.Types.Interconnects) => void): Request; + /** + * Describes all your link aggregation groups (LAG) or the specified LAG. + */ + describeLags(params: DirectConnect.Types.DescribeLagsRequest, callback?: (err: AWSError, data: DirectConnect.Types.Lags) => void): Request; + /** + * Describes all your link aggregation groups (LAG) or the specified LAG. + */ + describeLags(callback?: (err: AWSError, data: DirectConnect.Types.Lags) => void): Request; + /** + * Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG). The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide. + */ + describeLoa(params: DirectConnect.Types.DescribeLoaRequest, callback?: (err: AWSError, data: DirectConnect.Types.Loa) => void): Request; + /** + * Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG). The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide. + */ + describeLoa(callback?: (err: AWSError, data: DirectConnect.Types.Loa) => void): Request; + /** + * Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect. + */ + describeLocations(callback?: (err: AWSError, data: DirectConnect.Types.Locations) => void): Request; + /** + * Describes the tags associated with the specified AWS Direct Connect resources. + */ + describeTags(params: DirectConnect.Types.DescribeTagsRequest, callback?: (err: AWSError, data: DirectConnect.Types.DescribeTagsResponse) => void): Request; + /** + * Describes the tags associated with the specified AWS Direct Connect resources. + */ + describeTags(callback?: (err: AWSError, data: DirectConnect.Types.DescribeTagsResponse) => void): Request; + /** + * Lists the virtual private gateways owned by the AWS account. You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway. + */ + describeVirtualGateways(callback?: (err: AWSError, data: DirectConnect.Types.VirtualGateways) => void): Request; + /** + * Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned. A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network. + */ + describeVirtualInterfaces(params: DirectConnect.Types.DescribeVirtualInterfacesRequest, callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterfaces) => void): Request; + /** + * Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned. A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network. + */ + describeVirtualInterfaces(callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterfaces) => void): Request; + /** + * Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect. If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections. + */ + disassociateConnectionFromLag(params: DirectConnect.Types.DisassociateConnectionFromLagRequest, callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect. If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections. + */ + disassociateConnectionFromLag(callback?: (err: AWSError, data: DirectConnect.Types.Connection) => void): Request; + /** + * Adds the specified tags to the specified AWS Direct Connect resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value. + */ + tagResource(params: DirectConnect.Types.TagResourceRequest, callback?: (err: AWSError, data: DirectConnect.Types.TagResourceResponse) => void): Request; + /** + * Adds the specified tags to the specified AWS Direct Connect resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value. + */ + tagResource(callback?: (err: AWSError, data: DirectConnect.Types.TagResourceResponse) => void): Request; + /** + * Removes one or more tags from the specified AWS Direct Connect resource. + */ + untagResource(params: DirectConnect.Types.UntagResourceRequest, callback?: (err: AWSError, data: DirectConnect.Types.UntagResourceResponse) => void): Request; + /** + * Removes one or more tags from the specified AWS Direct Connect resource. + */ + untagResource(callback?: (err: AWSError, data: DirectConnect.Types.UntagResourceResponse) => void): Request; + /** + * Updates the specified attributes of the Direct Connect gateway association. Add or remove prefixes from the association. + */ + updateDirectConnectGatewayAssociation(params: DirectConnect.Types.UpdateDirectConnectGatewayAssociationRequest, callback?: (err: AWSError, data: DirectConnect.Types.UpdateDirectConnectGatewayAssociationResult) => void): Request; + /** + * Updates the specified attributes of the Direct Connect gateway association. Add or remove prefixes from the association. + */ + updateDirectConnectGatewayAssociation(callback?: (err: AWSError, data: DirectConnect.Types.UpdateDirectConnectGatewayAssociationResult) => void): Request; + /** + * Updates the attributes of the specified link aggregation group (LAG). You can update the following attributes: The name of the LAG. The value for the minimum number of connections that must be operational for the LAG itself to be operational. When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections. + */ + updateLag(params: DirectConnect.Types.UpdateLagRequest, callback?: (err: AWSError, data: DirectConnect.Types.Lag) => void): Request; + /** + * Updates the attributes of the specified link aggregation group (LAG). You can update the following attributes: The name of the LAG. The value for the minimum number of connections that must be operational for the LAG itself to be operational. When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections. + */ + updateLag(callback?: (err: AWSError, data: DirectConnect.Types.Lag) => void): Request; + /** + * Updates the specified attributes of the specified virtual private interface. Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces. + */ + updateVirtualInterfaceAttributes(params: DirectConnect.Types.UpdateVirtualInterfaceAttributesRequest, callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; + /** + * Updates the specified attributes of the specified virtual private interface. Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces. + */ + updateVirtualInterfaceAttributes(callback?: (err: AWSError, data: DirectConnect.Types.VirtualInterface) => void): Request; +} +declare namespace DirectConnect { + export type ASN = number; + export interface AcceptDirectConnectGatewayAssociationProposalRequest { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId: DirectConnectGatewayId; + /** + * The ID of the request proposal. + */ + proposalId: DirectConnectGatewayAssociationProposalId; + /** + * The ID of the AWS account that owns the virtual private gateway or transit gateway. + */ + associatedGatewayOwnerAccount: OwnerAccount; + /** + * Overrides the existing Amazon VPC prefixes advertised to the Direct Connect gateway. + */ + overrideAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + } + export interface AcceptDirectConnectGatewayAssociationProposalResult { + directConnectGatewayAssociation?: DirectConnectGatewayAssociation; + } + export type AddressFamily = "ipv4"|"ipv6"|string; + export interface AllocateConnectionOnInterconnectRequest { + /** + * The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. + */ + bandwidth: Bandwidth; + /** + * The name of the provisioned connection. + */ + connectionName: ConnectionName; + /** + * The ID of the AWS account of the customer for whom the connection will be provisioned. + */ + ownerAccount: OwnerAccount; + /** + * The ID of the interconnect on which the connection will be provisioned. + */ + interconnectId: InterconnectId; + /** + * The dedicated VLAN provisioned to the connection. + */ + vlan: VLAN; + } + export interface AllocateHostedConnectionRequest { + /** + * The ID of the interconnect or LAG. + */ + connectionId: ConnectionId; + /** + * The ID of the AWS account ID of the customer for the connection. + */ + ownerAccount: OwnerAccount; + /** + * The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. + */ + bandwidth: Bandwidth; + /** + * The name of the hosted connection. + */ + connectionName: ConnectionName; + /** + * The dedicated VLAN provisioned to the hosted connection. + */ + vlan: VLAN; + } + export interface AllocatePrivateVirtualInterfaceRequest { + /** + * The ID of the connection on which the private virtual interface is provisioned. + */ + connectionId: ConnectionId; + /** + * The ID of the AWS account that owns the virtual private interface. + */ + ownerAccount: OwnerAccount; + /** + * Information about the private virtual interface. + */ + newPrivateVirtualInterfaceAllocation: NewPrivateVirtualInterfaceAllocation; + } + export interface AllocatePublicVirtualInterfaceRequest { + /** + * The ID of the connection on which the public virtual interface is provisioned. + */ + connectionId: ConnectionId; + /** + * The ID of the AWS account that owns the public virtual interface. + */ + ownerAccount: OwnerAccount; + /** + * Information about the public virtual interface. + */ + newPublicVirtualInterfaceAllocation: NewPublicVirtualInterfaceAllocation; + } + export interface AllocateTransitVirtualInterfaceRequest { + /** + * The ID of the connection on which the transit virtual interface is provisioned. + */ + connectionId: ConnectionId; + /** + * The ID of the AWS account that owns the transit virtual interface. + */ + ownerAccount: OwnerAccount; + /** + * Information about the transit virtual interface. + */ + newTransitVirtualInterfaceAllocation: NewTransitVirtualInterfaceAllocation; + } + export interface AllocateTransitVirtualInterfaceResult { + virtualInterface?: VirtualInterface; + } + export type AmazonAddress = string; + export interface AssociateConnectionWithLagRequest { + /** + * The ID of the connection. + */ + connectionId: ConnectionId; + /** + * The ID of the LAG with which to associate the connection. + */ + lagId: LagId; + } + export interface AssociateHostedConnectionRequest { + /** + * The ID of the hosted connection. + */ + connectionId: ConnectionId; + /** + * The ID of the interconnect or the LAG. + */ + parentConnectionId: ConnectionId; + } + export interface AssociateVirtualInterfaceRequest { + /** + * The ID of the virtual interface. + */ + virtualInterfaceId: VirtualInterfaceId; + /** + * The ID of the LAG or connection. + */ + connectionId: ConnectionId; + } + export interface AssociatedGateway { + /** + * The ID of the associated gateway. + */ + id?: GatewayIdentifier; + /** + * The type of associated gateway. + */ + type?: GatewayType; + /** + * The ID of the AWS account that owns the associated virtual private gateway or transit gateway. + */ + ownerAccount?: OwnerAccount; + /** + * The Region where the associated gateway is located. + */ + region?: Region; + } + export type AssociatedGatewayId = string; + export type AvailablePortSpeeds = PortSpeed[]; + export type AwsDevice = string; + export type AwsDeviceV2 = string; + export type BGPAuthKey = string; + export interface BGPPeer { + /** + * The ID of the BGP peer. + */ + bgpPeerId?: BGPPeerId; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn?: ASN; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The state of the BGP peer. The following are the possible values: verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces. pending: The BGP peer is created, and remains in this state until it is ready to be established. available: The BGP peer is ready to be established. deleting: The BGP peer is being deleted. deleted: The BGP peer is deleted and cannot be established. + */ + bgpPeerState?: BGPPeerState; + /** + * The status of the BGP peer. The following are the possible values: up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session. down: The BGP peer is down. unknown: The BGP peer status is not available. + */ + bgpStatus?: BGPStatus; + /** + * The Direct Connect endpoint on which the BGP peer terminates. + */ + awsDeviceV2?: AwsDeviceV2; + } + export type BGPPeerId = string; + export type BGPPeerList = BGPPeer[]; + export type BGPPeerState = "verifying"|"pending"|"available"|"deleting"|"deleted"|string; + export type BGPStatus = "up"|"down"|"unknown"|string; + export type Bandwidth = string; + export type BooleanFlag = boolean; + export type CIDR = string; + export interface ConfirmConnectionRequest { + /** + * The ID of the hosted connection. + */ + connectionId: ConnectionId; + } + export interface ConfirmConnectionResponse { + /** + * The state of the connection. The following are the possible values: ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order. requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer. pending: The connection has been approved and is being initialized. available: The network link is up and the connection is ready for use. down: The network link is down. deleting: The connection is being deleted. deleted: The connection has been deleted. rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer. unknown: The state of the connection is not available. + */ + connectionState?: ConnectionState; + } + export interface ConfirmPrivateVirtualInterfaceRequest { + /** + * The ID of the virtual interface. + */ + virtualInterfaceId: VirtualInterfaceId; + /** + * The ID of the virtual private gateway. + */ + virtualGatewayId?: VirtualGatewayId; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + } + export interface ConfirmPrivateVirtualInterfaceResponse { + /** + * The state of the virtual interface. The following are the possible values: confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. available: A virtual interface that is able to forward traffic. down: A virtual interface that is BGP down. deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. deleted: A virtual interface that cannot forward traffic. rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state. unknown: The state of the virtual interface is not available. + */ + virtualInterfaceState?: VirtualInterfaceState; + } + export interface ConfirmPublicVirtualInterfaceRequest { + /** + * The ID of the virtual interface. + */ + virtualInterfaceId: VirtualInterfaceId; + } + export interface ConfirmPublicVirtualInterfaceResponse { + /** + * The state of the virtual interface. The following are the possible values: confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. available: A virtual interface that is able to forward traffic. down: A virtual interface that is BGP down. deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. deleted: A virtual interface that cannot forward traffic. rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state. unknown: The state of the virtual interface is not available. + */ + virtualInterfaceState?: VirtualInterfaceState; + } + export interface ConfirmTransitVirtualInterfaceRequest { + /** + * The ID of the virtual interface. + */ + virtualInterfaceId: VirtualInterfaceId; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId: DirectConnectGatewayId; + } + export interface ConfirmTransitVirtualInterfaceResponse { + /** + * The state of the virtual interface. The following are the possible values: confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. available: A virtual interface that is able to forward traffic. down: A virtual interface that is BGP down. deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. deleted: A virtual interface that cannot forward traffic. rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state. unknown: The state of the virtual interface is not available. + */ + virtualInterfaceState?: VirtualInterfaceState; + } + export interface Connection { + /** + * The ID of the AWS account that owns the connection. + */ + ownerAccount?: OwnerAccount; + /** + * The ID of the connection. + */ + connectionId?: ConnectionId; + /** + * The name of the connection. + */ + connectionName?: ConnectionName; + /** + * The state of the connection. The following are the possible values: ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order. requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer. pending: The connection has been approved and is being initialized. available: The network link is up and the connection is ready for use. down: The network link is down. deleting: The connection is being deleted. deleted: The connection has been deleted. rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer. unknown: The state of the connection is not available. + */ + connectionState?: ConnectionState; + /** + * The AWS Region where the connection is located. + */ + region?: Region; + /** + * The location of the connection. + */ + location?: LocationCode; + /** + * The bandwidth of the connection. + */ + bandwidth?: Bandwidth; + /** + * The ID of the VLAN. + */ + vlan?: VLAN; + /** + * The name of the AWS Direct Connect service provider associated with the connection. + */ + partnerName?: PartnerName; + /** + * The time of the most recent call to DescribeLoa for this connection. + */ + loaIssueTime?: LoaIssueTime; + /** + * The ID of the LAG. + */ + lagId?: LagId; + /** + * The Direct Connect endpoint on which the physical connection terminates. + */ + awsDevice?: AwsDevice; + /** + * Indicates whether jumbo frames (9001 MTU) are supported. + */ + jumboFrameCapable?: JumboFrameCapable; + /** + * The Direct Connect endpoint on which the physical connection terminates. + */ + awsDeviceV2?: AwsDeviceV2; + /** + * Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6). + */ + hasLogicalRedundancy?: HasLogicalRedundancy; + } + export type ConnectionId = string; + export type ConnectionList = Connection[]; + export type ConnectionName = string; + export type ConnectionState = "ordering"|"requested"|"pending"|"available"|"down"|"deleting"|"deleted"|"rejected"|"unknown"|string; + export interface Connections { + /** + * The connections. + */ + connections?: ConnectionList; + } + export type Count = number; + export interface CreateBGPPeerRequest { + /** + * The ID of the virtual interface. + */ + virtualInterfaceId?: VirtualInterfaceId; + /** + * Information about the BGP peer. + */ + newBGPPeer?: NewBGPPeer; + } + export interface CreateBGPPeerResponse { + /** + * The virtual interface. + */ + virtualInterface?: VirtualInterface; + } + export interface CreateConnectionRequest { + /** + * The location of the connection. + */ + location: LocationCode; + /** + * The bandwidth of the connection. + */ + bandwidth: Bandwidth; + /** + * The name of the connection. + */ + connectionName: ConnectionName; + /** + * The ID of the LAG. + */ + lagId?: LagId; + } + export interface CreateDirectConnectGatewayAssociationProposalRequest { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId: DirectConnectGatewayId; + /** + * The ID of the AWS account that owns the Direct Connect gateway. + */ + directConnectGatewayOwnerAccount: OwnerAccount; + /** + * The ID of the virtual private gateway or transit gateway. + */ + gatewayId: GatewayIdToAssociate; + /** + * The Amazon VPC prefixes to advertise to the Direct Connect gateway. + */ + addAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + /** + * The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. + */ + removeAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + } + export interface CreateDirectConnectGatewayAssociationProposalResult { + /** + * Information about the Direct Connect gateway proposal. + */ + directConnectGatewayAssociationProposal?: DirectConnectGatewayAssociationProposal; + } + export interface CreateDirectConnectGatewayAssociationRequest { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId: DirectConnectGatewayId; + /** + * The ID of the virtual private gateway or transit gateway. + */ + gatewayId?: GatewayIdToAssociate; + /** + * The Amazon VPC prefixes to advertise to the Direct Connect gateway + */ + addAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + /** + * The ID of the virtual private gateway. + */ + virtualGatewayId?: VirtualGatewayId; + } + export interface CreateDirectConnectGatewayAssociationResult { + /** + * The association to be created. + */ + directConnectGatewayAssociation?: DirectConnectGatewayAssociation; + } + export interface CreateDirectConnectGatewayRequest { + /** + * The name of the Direct Connect gateway. + */ + directConnectGatewayName: DirectConnectGatewayName; + /** + * The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512. + */ + amazonSideAsn?: LongAsn; + } + export interface CreateDirectConnectGatewayResult { + /** + * The Direct Connect gateway. + */ + directConnectGateway?: DirectConnectGateway; + } + export interface CreateInterconnectRequest { + /** + * The name of the interconnect. + */ + interconnectName: InterconnectName; + /** + * The port bandwidth, in Gbps. The possible values are 1 and 10. + */ + bandwidth: Bandwidth; + /** + * The location of the interconnect. + */ + location: LocationCode; + /** + * The ID of the LAG. + */ + lagId?: LagId; + } + export interface CreateLagRequest { + /** + * The number of physical connections initially provisioned and bundled by the LAG. + */ + numberOfConnections: Count; + /** + * The location for the LAG. + */ + location: LocationCode; + /** + * The bandwidth of the individual physical connections bundled by the LAG. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. + */ + connectionsBandwidth: Bandwidth; + /** + * The name of the LAG. + */ + lagName: LagName; + /** + * The ID of an existing connection to migrate to the LAG. + */ + connectionId?: ConnectionId; + } + export interface CreatePrivateVirtualInterfaceRequest { + /** + * The ID of the connection. + */ + connectionId: ConnectionId; + /** + * Information about the private virtual interface. + */ + newPrivateVirtualInterface: NewPrivateVirtualInterface; + } + export interface CreatePublicVirtualInterfaceRequest { + /** + * The ID of the connection. + */ + connectionId: ConnectionId; + /** + * Information about the public virtual interface. + */ + newPublicVirtualInterface: NewPublicVirtualInterface; + } + export interface CreateTransitVirtualInterfaceRequest { + /** + * The ID of the connection. + */ + connectionId: ConnectionId; + /** + * Information about the transit virtual interface. + */ + newTransitVirtualInterface: NewTransitVirtualInterface; + } + export interface CreateTransitVirtualInterfaceResult { + virtualInterface?: VirtualInterface; + } + export type CustomerAddress = string; + export interface DeleteBGPPeerRequest { + /** + * The ID of the virtual interface. + */ + virtualInterfaceId?: VirtualInterfaceId; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn?: ASN; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The ID of the BGP peer. + */ + bgpPeerId?: BGPPeerId; + } + export interface DeleteBGPPeerResponse { + /** + * The virtual interface. + */ + virtualInterface?: VirtualInterface; + } + export interface DeleteConnectionRequest { + /** + * The ID of the connection. + */ + connectionId: ConnectionId; + } + export interface DeleteDirectConnectGatewayAssociationProposalRequest { + /** + * The ID of the proposal. + */ + proposalId: DirectConnectGatewayAssociationProposalId; + } + export interface DeleteDirectConnectGatewayAssociationProposalResult { + /** + * The ID of the associated gateway. + */ + directConnectGatewayAssociationProposal?: DirectConnectGatewayAssociationProposal; + } + export interface DeleteDirectConnectGatewayAssociationRequest { + /** + * The ID of the Direct Connect gateway association. + */ + associationId?: DirectConnectGatewayAssociationId; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The ID of the virtual private gateway. + */ + virtualGatewayId?: VirtualGatewayId; + } + export interface DeleteDirectConnectGatewayAssociationResult { + /** + * Information about the deleted association. + */ + directConnectGatewayAssociation?: DirectConnectGatewayAssociation; + } + export interface DeleteDirectConnectGatewayRequest { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId: DirectConnectGatewayId; + } + export interface DeleteDirectConnectGatewayResult { + /** + * The Direct Connect gateway. + */ + directConnectGateway?: DirectConnectGateway; + } + export interface DeleteInterconnectRequest { + /** + * The ID of the interconnect. + */ + interconnectId: InterconnectId; + } + export interface DeleteInterconnectResponse { + /** + * The state of the interconnect. The following are the possible values: requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer. pending: The interconnect is approved, and is being initialized. available: The network link is up, and the interconnect is ready for use. down: The network link is down. deleting: The interconnect is being deleted. deleted: The interconnect is deleted. unknown: The state of the interconnect is not available. + */ + interconnectState?: InterconnectState; + } + export interface DeleteLagRequest { + /** + * The ID of the LAG. + */ + lagId: LagId; + } + export interface DeleteVirtualInterfaceRequest { + /** + * The ID of the virtual interface. + */ + virtualInterfaceId: VirtualInterfaceId; + } + export interface DeleteVirtualInterfaceResponse { + /** + * The state of the virtual interface. The following are the possible values: confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. available: A virtual interface that is able to forward traffic. down: A virtual interface that is BGP down. deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. deleted: A virtual interface that cannot forward traffic. rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state. unknown: The state of the virtual interface is not available. + */ + virtualInterfaceState?: VirtualInterfaceState; + } + export interface DescribeConnectionLoaRequest { + /** + * The ID of the connection. + */ + connectionId: ConnectionId; + /** + * The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. + */ + providerName?: ProviderName; + /** + * The standard media type for the LOA-CFA document. The only supported value is application/pdf. + */ + loaContentType?: LoaContentType; + } + export interface DescribeConnectionLoaResponse { + /** + * The Letter of Authorization - Connecting Facility Assignment (LOA-CFA). + */ + loa?: Loa; + } + export interface DescribeConnectionsOnInterconnectRequest { + /** + * The ID of the interconnect. + */ + interconnectId: InterconnectId; + } + export interface DescribeConnectionsRequest { + /** + * The ID of the connection. + */ + connectionId?: ConnectionId; + } + export interface DescribeDirectConnectGatewayAssociationProposalsRequest { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The ID of the proposal. + */ + proposalId?: DirectConnectGatewayAssociationProposalId; + /** + * The ID of the associated gateway. + */ + associatedGatewayId?: AssociatedGatewayId; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If MaxResults is given a value larger than 100, only 100 results are returned. + */ + maxResults?: MaxResultSetSize; + /** + * The token for the next page of results. + */ + nextToken?: PaginationToken; + } + export interface DescribeDirectConnectGatewayAssociationProposalsResult { + /** + * Describes the Direct Connect gateway association proposals. + */ + directConnectGatewayAssociationProposals?: DirectConnectGatewayAssociationProposalList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: PaginationToken; + } + export interface DescribeDirectConnectGatewayAssociationsRequest { + /** + * The ID of the Direct Connect gateway association. + */ + associationId?: DirectConnectGatewayAssociationId; + /** + * The ID of the associated gateway. + */ + associatedGatewayId?: AssociatedGatewayId; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If MaxResults is given a value larger than 100, only 100 results are returned. + */ + maxResults?: MaxResultSetSize; + /** + * The token provided in the previous call to retrieve the next page. + */ + nextToken?: PaginationToken; + /** + * The ID of the virtual private gateway. + */ + virtualGatewayId?: VirtualGatewayId; + } + export interface DescribeDirectConnectGatewayAssociationsResult { + /** + * Information about the associations. + */ + directConnectGatewayAssociations?: DirectConnectGatewayAssociationList; + /** + * The token to retrieve the next page. + */ + nextToken?: PaginationToken; + } + export interface DescribeDirectConnectGatewayAttachmentsRequest { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The ID of the virtual interface. + */ + virtualInterfaceId?: VirtualInterfaceId; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If MaxResults is given a value larger than 100, only 100 results are returned. + */ + maxResults?: MaxResultSetSize; + /** + * The token provided in the previous call to retrieve the next page. + */ + nextToken?: PaginationToken; + } + export interface DescribeDirectConnectGatewayAttachmentsResult { + /** + * The attachments. + */ + directConnectGatewayAttachments?: DirectConnectGatewayAttachmentList; + /** + * The token to retrieve the next page. + */ + nextToken?: PaginationToken; + } + export interface DescribeDirectConnectGatewaysRequest { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If MaxResults is given a value larger than 100, only 100 results are returned. + */ + maxResults?: MaxResultSetSize; + /** + * The token provided in the previous call to retrieve the next page. + */ + nextToken?: PaginationToken; + } + export interface DescribeDirectConnectGatewaysResult { + /** + * The Direct Connect gateways. + */ + directConnectGateways?: DirectConnectGatewayList; + /** + * The token to retrieve the next page. + */ + nextToken?: PaginationToken; + } + export interface DescribeHostedConnectionsRequest { + /** + * The ID of the interconnect or LAG. + */ + connectionId: ConnectionId; + } + export interface DescribeInterconnectLoaRequest { + /** + * The ID of the interconnect. + */ + interconnectId: InterconnectId; + /** + * The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. + */ + providerName?: ProviderName; + /** + * The standard media type for the LOA-CFA document. The only supported value is application/pdf. + */ + loaContentType?: LoaContentType; + } + export interface DescribeInterconnectLoaResponse { + /** + * The Letter of Authorization - Connecting Facility Assignment (LOA-CFA). + */ + loa?: Loa; + } + export interface DescribeInterconnectsRequest { + /** + * The ID of the interconnect. + */ + interconnectId?: InterconnectId; + } + export interface DescribeLagsRequest { + /** + * The ID of the LAG. + */ + lagId?: LagId; + } + export interface DescribeLoaRequest { + /** + * The ID of a connection, LAG, or interconnect. + */ + connectionId: ConnectionId; + /** + * The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect. + */ + providerName?: ProviderName; + /** + * The standard media type for the LOA-CFA document. The only supported value is application/pdf. + */ + loaContentType?: LoaContentType; + } + export interface DescribeTagsRequest { + /** + * The Amazon Resource Names (ARNs) of the resources. + */ + resourceArns: ResourceArnList; + } + export interface DescribeTagsResponse { + /** + * Information about the tags. + */ + resourceTags?: ResourceTagList; + } + export interface DescribeVirtualInterfacesRequest { + /** + * The ID of the connection. + */ + connectionId?: ConnectionId; + /** + * The ID of the virtual interface. + */ + virtualInterfaceId?: VirtualInterfaceId; + } + export interface DirectConnectGateway { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The name of the Direct Connect gateway. + */ + directConnectGatewayName?: DirectConnectGatewayName; + /** + * The autonomous system number (ASN) for the Amazon side of the connection. + */ + amazonSideAsn?: LongAsn; + /** + * The ID of the AWS account that owns the Direct Connect gateway. + */ + ownerAccount?: OwnerAccount; + /** + * The state of the Direct Connect gateway. The following are the possible values: pending: The initial state after calling CreateDirectConnectGateway. available: The Direct Connect gateway is ready for use. deleting: The initial state after calling DeleteDirectConnectGateway. deleted: The Direct Connect gateway is deleted and cannot pass traffic. + */ + directConnectGatewayState?: DirectConnectGatewayState; + /** + * The error message if the state of an object failed to advance. + */ + stateChangeError?: StateChangeError; + } + export interface DirectConnectGatewayAssociation { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The ID of the AWS account that owns the associated gateway. + */ + directConnectGatewayOwnerAccount?: OwnerAccount; + /** + * The state of the association. The following are the possible values: associating: The initial state after calling CreateDirectConnectGatewayAssociation. associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic. disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation. disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped. + */ + associationState?: DirectConnectGatewayAssociationState; + /** + * The error message if the state of an object failed to advance. + */ + stateChangeError?: StateChangeError; + /** + * Information about the associated gateway. + */ + associatedGateway?: AssociatedGateway; + /** + * The ID of the Direct Connect gateway association. + */ + associationId?: DirectConnectGatewayAssociationId; + /** + * The Amazon VPC prefixes to advertise to the Direct Connect gateway. + */ + allowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + /** + * The ID of the virtual private gateway. Applies only to private virtual interfaces. + */ + virtualGatewayId?: VirtualGatewayId; + /** + * The AWS Region where the virtual private gateway is located. + */ + virtualGatewayRegion?: VirtualGatewayRegion; + /** + * The ID of the AWS account that owns the virtual private gateway. + */ + virtualGatewayOwnerAccount?: OwnerAccount; + } + export type DirectConnectGatewayAssociationId = string; + export type DirectConnectGatewayAssociationList = DirectConnectGatewayAssociation[]; + export interface DirectConnectGatewayAssociationProposal { + /** + * The ID of the association proposal. + */ + proposalId?: DirectConnectGatewayAssociationProposalId; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The ID of the AWS account that owns the Direct Connect gateway. + */ + directConnectGatewayOwnerAccount?: OwnerAccount; + /** + * The state of the proposal. The following are possible values: accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state. deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state. requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state. + */ + proposalState?: DirectConnectGatewayAssociationProposalState; + /** + * Information about the associated gateway. + */ + associatedGateway?: AssociatedGateway; + /** + * The existing Amazon VPC prefixes advertised to the Direct Connect gateway. + */ + existingAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + /** + * The Amazon VPC prefixes to advertise to the Direct Connect gateway. + */ + requestedAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + } + export type DirectConnectGatewayAssociationProposalId = string; + export type DirectConnectGatewayAssociationProposalList = DirectConnectGatewayAssociationProposal[]; + export type DirectConnectGatewayAssociationProposalState = "requested"|"accepted"|"deleted"|string; + export type DirectConnectGatewayAssociationState = "associating"|"associated"|"disassociating"|"disassociated"|"updating"|string; + export interface DirectConnectGatewayAttachment { + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The ID of the virtual interface. + */ + virtualInterfaceId?: VirtualInterfaceId; + /** + * The AWS Region where the virtual interface is located. + */ + virtualInterfaceRegion?: VirtualInterfaceRegion; + /** + * The ID of the AWS account that owns the virtual interface. + */ + virtualInterfaceOwnerAccount?: OwnerAccount; + /** + * The state of the attachment. The following are the possible values: attaching: The initial state after a virtual interface is created using the Direct Connect gateway. attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic. detaching: The initial state after calling DeleteVirtualInterface. detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped. + */ + attachmentState?: DirectConnectGatewayAttachmentState; + /** + * The type of attachment. + */ + attachmentType?: DirectConnectGatewayAttachmentType; + /** + * The error message if the state of an object failed to advance. + */ + stateChangeError?: StateChangeError; + } + export type DirectConnectGatewayAttachmentList = DirectConnectGatewayAttachment[]; + export type DirectConnectGatewayAttachmentState = "attaching"|"attached"|"detaching"|"detached"|string; + export type DirectConnectGatewayAttachmentType = "TransitVirtualInterface"|"PrivateVirtualInterface"|string; + export type DirectConnectGatewayId = string; + export type DirectConnectGatewayList = DirectConnectGateway[]; + export type DirectConnectGatewayName = string; + export type DirectConnectGatewayState = "pending"|"available"|"deleting"|"deleted"|string; + export interface DisassociateConnectionFromLagRequest { + /** + * The ID of the connection. + */ + connectionId: ConnectionId; + /** + * The ID of the LAG. + */ + lagId: LagId; + } + export type GatewayIdToAssociate = string; + export type GatewayIdentifier = string; + export type GatewayType = "virtualPrivateGateway"|"transitGateway"|string; + export type HasLogicalRedundancy = "unknown"|"yes"|"no"|string; + export interface Interconnect { + /** + * The ID of the interconnect. + */ + interconnectId?: InterconnectId; + /** + * The name of the interconnect. + */ + interconnectName?: InterconnectName; + /** + * The state of the interconnect. The following are the possible values: requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer. pending: The interconnect is approved, and is being initialized. available: The network link is up, and the interconnect is ready for use. down: The network link is down. deleting: The interconnect is being deleted. deleted: The interconnect is deleted. unknown: The state of the interconnect is not available. + */ + interconnectState?: InterconnectState; + /** + * The AWS Region where the connection is located. + */ + region?: Region; + /** + * The location of the connection. + */ + location?: LocationCode; + /** + * The bandwidth of the connection. + */ + bandwidth?: Bandwidth; + /** + * The time of the most recent call to DescribeLoa for this connection. + */ + loaIssueTime?: LoaIssueTime; + /** + * The ID of the LAG. + */ + lagId?: LagId; + /** + * The Direct Connect endpoint on which the physical connection terminates. + */ + awsDevice?: AwsDevice; + /** + * Indicates whether jumbo frames (9001 MTU) are supported. + */ + jumboFrameCapable?: JumboFrameCapable; + /** + * The Direct Connect endpoint on which the physical connection terminates. + */ + awsDeviceV2?: AwsDeviceV2; + /** + * Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6). + */ + hasLogicalRedundancy?: HasLogicalRedundancy; + } + export type InterconnectId = string; + export type InterconnectList = Interconnect[]; + export type InterconnectName = string; + export type InterconnectState = "requested"|"pending"|"available"|"down"|"deleting"|"deleted"|"unknown"|string; + export interface Interconnects { + /** + * The interconnects. + */ + interconnects?: InterconnectList; + } + export type JumboFrameCapable = boolean; + export interface Lag { + /** + * The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps. + */ + connectionsBandwidth?: Bandwidth; + /** + * The number of physical connections bundled by the LAG, up to a maximum of 10. + */ + numberOfConnections?: Count; + /** + * The ID of the LAG. + */ + lagId?: LagId; + /** + * The ID of the AWS account that owns the LAG. + */ + ownerAccount?: OwnerAccount; + /** + * The name of the LAG. + */ + lagName?: LagName; + /** + * The state of the LAG. The following are the possible values: requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available. pending: The LAG has been approved and is being initialized. available: The network link is established and the LAG is ready for use. down: The network link is down. deleting: The LAG is being deleted. deleted: The LAG is deleted. unknown: The state of the LAG is not available. + */ + lagState?: LagState; + /** + * The location of the LAG. + */ + location?: LocationCode; + /** + * The AWS Region where the connection is located. + */ + region?: Region; + /** + * The minimum number of physical connections that must be operational for the LAG itself to be operational. + */ + minimumLinks?: Count; + /** + * The AWS Direct Connect endpoint that hosts the LAG. + */ + awsDevice?: AwsDevice; + /** + * The AWS Direct Connect endpoint that hosts the LAG. + */ + awsDeviceV2?: AwsDeviceV2; + /** + * The connections bundled by the LAG. + */ + connections?: ConnectionList; + /** + * Indicates whether the LAG can host other connections. + */ + allowsHostedConnections?: BooleanFlag; + /** + * Indicates whether jumbo frames (9001 MTU) are supported. + */ + jumboFrameCapable?: JumboFrameCapable; + /** + * Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6). + */ + hasLogicalRedundancy?: HasLogicalRedundancy; + } + export type LagId = string; + export type LagList = Lag[]; + export type LagName = string; + export type LagState = "requested"|"pending"|"available"|"down"|"deleting"|"deleted"|"unknown"|string; + export interface Lags { + /** + * The LAGs. + */ + lags?: LagList; + } + export interface Loa { + /** + * The binary contents of the LOA-CFA document. + */ + loaContent?: LoaContent; + /** + * The standard media type for the LOA-CFA document. The only supported value is application/pdf. + */ + loaContentType?: LoaContentType; + } + export type LoaContent = Buffer|Uint8Array|Blob|string; + export type LoaContentType = "application/pdf"|string; + export type LoaIssueTime = Date; + export interface Location { + /** + * The code for the location. + */ + locationCode?: LocationCode; + /** + * The name of the location. This includes the name of the colocation partner and the physical site of the building. + */ + locationName?: LocationName; + /** + * The AWS Region for the location. + */ + region?: Region; + /** + * The available port speeds for the location. + */ + availablePortSpeeds?: AvailablePortSpeeds; + } + export type LocationCode = string; + export type LocationList = Location[]; + export type LocationName = string; + export interface Locations { + /** + * The locations. + */ + locations?: LocationList; + } + export type LongAsn = number; + export type MTU = number; + export type MaxResultSetSize = number; + export interface NewBGPPeer { + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn?: ASN; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + } + export interface NewPrivateVirtualInterface { + /** + * The name of the virtual interface assigned by the customer network. + */ + virtualInterfaceName: VirtualInterfaceName; + /** + * The ID of the VLAN. + */ + vlan: VLAN; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn: ASN; + /** + * The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. + */ + mtu?: MTU; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The ID of the virtual private gateway. + */ + virtualGatewayId?: VirtualGatewayId; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + } + export interface NewPrivateVirtualInterfaceAllocation { + /** + * The name of the virtual interface assigned by the customer network. + */ + virtualInterfaceName: VirtualInterfaceName; + /** + * The ID of the VLAN. + */ + vlan: VLAN; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn: ASN; + /** + * The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. + */ + mtu?: MTU; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + } + export interface NewPublicVirtualInterface { + /** + * The name of the virtual interface assigned by the customer network. + */ + virtualInterfaceName: VirtualInterfaceName; + /** + * The ID of the VLAN. + */ + vlan: VLAN; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn: ASN; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces. + */ + routeFilterPrefixes?: RouteFilterPrefixList; + } + export interface NewPublicVirtualInterfaceAllocation { + /** + * The name of the virtual interface assigned by the customer network. + */ + virtualInterfaceName: VirtualInterfaceName; + /** + * The ID of the VLAN. + */ + vlan: VLAN; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn: ASN; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces. + */ + routeFilterPrefixes?: RouteFilterPrefixList; + } + export interface NewTransitVirtualInterface { + /** + * The name of the virtual interface assigned by the customer network. + */ + virtualInterfaceName?: VirtualInterfaceName; + /** + * The ID of the VLAN. + */ + vlan?: VLAN; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn?: ASN; + /** + * The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. + */ + mtu?: MTU; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + } + export interface NewTransitVirtualInterfaceAllocation { + /** + * The name of the virtual interface assigned by the customer network. + */ + virtualInterfaceName?: VirtualInterfaceName; + /** + * The ID of the VLAN. + */ + vlan?: VLAN; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn?: ASN; + /** + * The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. + */ + mtu?: MTU; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + } + export type OwnerAccount = string; + export type PaginationToken = string; + export type PartnerName = string; + export type PortSpeed = string; + export type ProviderName = string; + export type Region = string; + export type ResourceArn = string; + export type ResourceArnList = ResourceArn[]; + export interface ResourceTag { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + resourceArn?: ResourceArn; + /** + * The tags. + */ + tags?: TagList; + } + export type ResourceTagList = ResourceTag[]; + export interface RouteFilterPrefix { + /** + * The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter. + */ + cidr?: CIDR; + } + export type RouteFilterPrefixList = RouteFilterPrefix[]; + export type RouterConfig = string; + export type StateChangeError = string; + export interface Tag { + /** + * The key. + */ + key: TagKey; + /** + * The value. + */ + value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + resourceArn: ResourceArn; + /** + * The tags to add. + */ + tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + resourceArn: ResourceArn; + /** + * The tag keys of the tags to remove. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateDirectConnectGatewayAssociationRequest { + /** + * The ID of the Direct Connect gateway association. + */ + associationId?: DirectConnectGatewayAssociationId; + /** + * The Amazon VPC prefixes to advertise to the Direct Connect gateway. + */ + addAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + /** + * The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway. + */ + removeAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefixList; + } + export interface UpdateDirectConnectGatewayAssociationResult { + directConnectGatewayAssociation?: DirectConnectGatewayAssociation; + } + export interface UpdateLagRequest { + /** + * The ID of the LAG. + */ + lagId: LagId; + /** + * The name of the LAG. + */ + lagName?: LagName; + /** + * The minimum number of physical connections that must be operational for the LAG itself to be operational. + */ + minimumLinks?: Count; + } + export interface UpdateVirtualInterfaceAttributesRequest { + /** + * The ID of the virtual private interface. + */ + virtualInterfaceId: VirtualInterfaceId; + /** + * The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. + */ + mtu?: MTU; + } + export type VLAN = number; + export interface VirtualGateway { + /** + * The ID of the virtual private gateway. + */ + virtualGatewayId?: VirtualGatewayId; + /** + * The state of the virtual private gateway. The following are the possible values: pending: Initial state after creating the virtual private gateway. available: Ready for use by a private virtual interface. deleting: Initial state after deleting the virtual private gateway. deleted: The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway. + */ + virtualGatewayState?: VirtualGatewayState; + } + export type VirtualGatewayId = string; + export type VirtualGatewayList = VirtualGateway[]; + export type VirtualGatewayRegion = string; + export type VirtualGatewayState = string; + export interface VirtualGateways { + /** + * The virtual private gateways. + */ + virtualGateways?: VirtualGatewayList; + } + export interface VirtualInterface { + /** + * The ID of the AWS account that owns the virtual interface. + */ + ownerAccount?: OwnerAccount; + /** + * The ID of the virtual interface. + */ + virtualInterfaceId?: VirtualInterfaceId; + /** + * The location of the connection. + */ + location?: LocationCode; + /** + * The ID of the connection. + */ + connectionId?: ConnectionId; + /** + * The type of virtual interface. The possible values are private and public. + */ + virtualInterfaceType?: VirtualInterfaceType; + /** + * The name of the virtual interface assigned by the customer network. + */ + virtualInterfaceName?: VirtualInterfaceName; + /** + * The ID of the VLAN. + */ + vlan?: VLAN; + /** + * The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. + */ + asn?: ASN; + /** + * The autonomous system number (ASN) for the Amazon side of the connection. + */ + amazonSideAsn?: LongAsn; + /** + * The authentication key for BGP configuration. + */ + authKey?: BGPAuthKey; + /** + * The IP address assigned to the Amazon interface. + */ + amazonAddress?: AmazonAddress; + /** + * The IP address assigned to the customer interface. + */ + customerAddress?: CustomerAddress; + /** + * The address family for the BGP peer. + */ + addressFamily?: AddressFamily; + /** + * The state of the virtual interface. The following are the possible values: confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. available: A virtual interface that is able to forward traffic. down: A virtual interface that is BGP down. deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. deleted: A virtual interface that cannot forward traffic. rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state. unknown: The state of the virtual interface is not available. + */ + virtualInterfaceState?: VirtualInterfaceState; + /** + * The customer router configuration. + */ + customerRouterConfig?: RouterConfig; + /** + * The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. + */ + mtu?: MTU; + /** + * Indicates whether jumbo frames (9001 MTU) are supported. + */ + jumboFrameCapable?: JumboFrameCapable; + /** + * The ID of the virtual private gateway. Applies only to private virtual interfaces. + */ + virtualGatewayId?: VirtualGatewayId; + /** + * The ID of the Direct Connect gateway. + */ + directConnectGatewayId?: DirectConnectGatewayId; + /** + * The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces. + */ + routeFilterPrefixes?: RouteFilterPrefixList; + /** + * The BGP peers configured on this virtual interface. + */ + bgpPeers?: BGPPeerList; + /** + * The AWS Region where the virtual interface is located. + */ + region?: Region; + /** + * The Direct Connect endpoint on which the virtual interface terminates. + */ + awsDeviceV2?: AwsDeviceV2; + } + export type VirtualInterfaceId = string; + export type VirtualInterfaceList = VirtualInterface[]; + export type VirtualInterfaceName = string; + export type VirtualInterfaceRegion = string; + export type VirtualInterfaceState = "confirming"|"verifying"|"pending"|"available"|"down"|"deleting"|"deleted"|"rejected"|"unknown"|string; + export type VirtualInterfaceType = string; + export interface VirtualInterfaces { + /** + * The virtual interfaces + */ + virtualInterfaces?: VirtualInterfaceList; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-10-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DirectConnect client. + */ + export import Types = DirectConnect; +} +export = DirectConnect; diff --git a/node_modules/aws-sdk/clients/directconnect.js b/node_modules/aws-sdk/clients/directconnect.js new file mode 100644 index 0000000..426b00d --- /dev/null +++ b/node_modules/aws-sdk/clients/directconnect.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['directconnect'] = {}; +AWS.DirectConnect = Service.defineService('directconnect', ['2012-10-25']); +Object.defineProperty(apiLoader.services['directconnect'], '2012-10-25', { + get: function get() { + var model = require('../apis/directconnect-2012-10-25.min.json'); + model.paginators = require('../apis/directconnect-2012-10-25.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DirectConnect; diff --git a/node_modules/aws-sdk/clients/directoryservice.d.ts b/node_modules/aws-sdk/clients/directoryservice.d.ts new file mode 100644 index 0000000..fc2bb33 --- /dev/null +++ b/node_modules/aws-sdk/clients/directoryservice.d.ts @@ -0,0 +1,2055 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DirectoryService extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DirectoryService.Types.ClientConfiguration) + config: Config & DirectoryService.Types.ClientConfiguration; + /** + * Accepts a directory sharing request that was sent from the directory owner account. + */ + acceptSharedDirectory(params: DirectoryService.Types.AcceptSharedDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.AcceptSharedDirectoryResult) => void): Request; + /** + * Accepts a directory sharing request that was sent from the directory owner account. + */ + acceptSharedDirectory(callback?: (err: AWSError, data: DirectoryService.Types.AcceptSharedDirectoryResult) => void): Request; + /** + * If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + addIpRoutes(params: DirectoryService.Types.AddIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.AddIpRoutesResult) => void): Request; + /** + * If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + addIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.AddIpRoutesResult) => void): Request; + /** + * Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource. + */ + addTagsToResource(params: DirectoryService.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.AddTagsToResourceResult) => void): Request; + /** + * Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource. + */ + addTagsToResource(callback?: (err: AWSError, data: DirectoryService.Types.AddTagsToResourceResult) => void): Request; + /** + * Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema. + */ + cancelSchemaExtension(params: DirectoryService.Types.CancelSchemaExtensionRequest, callback?: (err: AWSError, data: DirectoryService.Types.CancelSchemaExtensionResult) => void): Request; + /** + * Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema. + */ + cancelSchemaExtension(callback?: (err: AWSError, data: DirectoryService.Types.CancelSchemaExtensionResult) => void): Request; + /** + * Creates an AD Connector to connect to an on-premises directory. Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + connectDirectory(params: DirectoryService.Types.ConnectDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.ConnectDirectoryResult) => void): Request; + /** + * Creates an AD Connector to connect to an on-premises directory. Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + connectDirectory(callback?: (err: AWSError, data: DirectoryService.Types.ConnectDirectoryResult) => void): Request; + /** + * Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. + */ + createAlias(params: DirectoryService.Types.CreateAliasRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateAliasResult) => void): Request; + /** + * Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. + */ + createAlias(callback?: (err: AWSError, data: DirectoryService.Types.CreateAliasResult) => void): Request; + /** + * Creates a computer account in the specified directory, and joins the computer to the directory. + */ + createComputer(params: DirectoryService.Types.CreateComputerRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateComputerResult) => void): Request; + /** + * Creates a computer account in the specified directory, and joins the computer to the directory. + */ + createComputer(callback?: (err: AWSError, data: DirectoryService.Types.CreateComputerResult) => void): Request; + /** + * Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain. + */ + createConditionalForwarder(params: DirectoryService.Types.CreateConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateConditionalForwarderResult) => void): Request; + /** + * Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain. + */ + createConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.CreateConditionalForwarderResult) => void): Request; + /** + * Creates a Simple AD directory. Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + createDirectory(params: DirectoryService.Types.CreateDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateDirectoryResult) => void): Request; + /** + * Creates a Simple AD directory. Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + createDirectory(callback?: (err: AWSError, data: DirectoryService.Types.CreateDirectoryResult) => void): Request; + /** + * Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account. + */ + createLogSubscription(params: DirectoryService.Types.CreateLogSubscriptionRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateLogSubscriptionResult) => void): Request; + /** + * Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account. + */ + createLogSubscription(callback?: (err: AWSError, data: DirectoryService.Types.CreateLogSubscriptionResult) => void): Request; + /** + * Creates an AWS Managed Microsoft AD directory. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + createMicrosoftAD(params: DirectoryService.Types.CreateMicrosoftADRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateMicrosoftADResult) => void): Request; + /** + * Creates an AWS Managed Microsoft AD directory. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + createMicrosoftAD(callback?: (err: AWSError, data: DirectoryService.Types.CreateMicrosoftADResult) => void): Request; + /** + * Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. You cannot take snapshots of AD Connector directories. + */ + createSnapshot(params: DirectoryService.Types.CreateSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateSnapshotResult) => void): Request; + /** + * Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. You cannot take snapshots of AD Connector directories. + */ + createSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.CreateSnapshotResult) => void): Request; + /** + * AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust. + */ + createTrust(params: DirectoryService.Types.CreateTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateTrustResult) => void): Request; + /** + * AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust. + */ + createTrust(callback?: (err: AWSError, data: DirectoryService.Types.CreateTrustResult) => void): Request; + /** + * Deletes a conditional forwarder that has been set up for your AWS directory. + */ + deleteConditionalForwarder(params: DirectoryService.Types.DeleteConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteConditionalForwarderResult) => void): Request; + /** + * Deletes a conditional forwarder that has been set up for your AWS directory. + */ + deleteConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.DeleteConditionalForwarderResult) => void): Request; + /** + * Deletes an AWS Directory Service directory. Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + deleteDirectory(params: DirectoryService.Types.DeleteDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteDirectoryResult) => void): Request; + /** + * Deletes an AWS Directory Service directory. Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference. + */ + deleteDirectory(callback?: (err: AWSError, data: DirectoryService.Types.DeleteDirectoryResult) => void): Request; + /** + * Deletes the specified log subscription. + */ + deleteLogSubscription(params: DirectoryService.Types.DeleteLogSubscriptionRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteLogSubscriptionResult) => void): Request; + /** + * Deletes the specified log subscription. + */ + deleteLogSubscription(callback?: (err: AWSError, data: DirectoryService.Types.DeleteLogSubscriptionResult) => void): Request; + /** + * Deletes a directory snapshot. + */ + deleteSnapshot(params: DirectoryService.Types.DeleteSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteSnapshotResult) => void): Request; + /** + * Deletes a directory snapshot. + */ + deleteSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.DeleteSnapshotResult) => void): Request; + /** + * Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain. + */ + deleteTrust(params: DirectoryService.Types.DeleteTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteTrustResult) => void): Request; + /** + * Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain. + */ + deleteTrust(callback?: (err: AWSError, data: DirectoryService.Types.DeleteTrustResult) => void): Request; + /** + * Removes the specified directory as a publisher to the specified SNS topic. + */ + deregisterEventTopic(params: DirectoryService.Types.DeregisterEventTopicRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeregisterEventTopicResult) => void): Request; + /** + * Removes the specified directory as a publisher to the specified SNS topic. + */ + deregisterEventTopic(callback?: (err: AWSError, data: DirectoryService.Types.DeregisterEventTopicResult) => void): Request; + /** + * Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID. + */ + describeConditionalForwarders(params: DirectoryService.Types.DescribeConditionalForwardersRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeConditionalForwardersResult) => void): Request; + /** + * Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID. + */ + describeConditionalForwarders(callback?: (err: AWSError, data: DirectoryService.Types.DescribeConditionalForwardersResult) => void): Request; + /** + * Obtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter. + */ + describeDirectories(params: DirectoryService.Types.DescribeDirectoriesRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeDirectoriesResult) => void): Request; + /** + * Obtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter. + */ + describeDirectories(callback?: (err: AWSError, data: DirectoryService.Types.DescribeDirectoriesResult) => void): Request; + /** + * Provides information about any domain controllers in your directory. + */ + describeDomainControllers(params: DirectoryService.Types.DescribeDomainControllersRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeDomainControllersResult) => void): Request; + /** + * Provides information about any domain controllers in your directory. + */ + describeDomainControllers(callback?: (err: AWSError, data: DirectoryService.Types.DescribeDomainControllersResult) => void): Request; + /** + * Obtains information about which SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. + */ + describeEventTopics(params: DirectoryService.Types.DescribeEventTopicsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeEventTopicsResult) => void): Request; + /** + * Obtains information about which SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. + */ + describeEventTopics(callback?: (err: AWSError, data: DirectoryService.Types.DescribeEventTopicsResult) => void): Request; + /** + * Returns the shared directories in your account. + */ + describeSharedDirectories(params: DirectoryService.Types.DescribeSharedDirectoriesRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeSharedDirectoriesResult) => void): Request; + /** + * Returns the shared directories in your account. + */ + describeSharedDirectories(callback?: (err: AWSError, data: DirectoryService.Types.DescribeSharedDirectoriesResult) => void): Request; + /** + * Obtains information about the directory snapshots that belong to this account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter. + */ + describeSnapshots(params: DirectoryService.Types.DescribeSnapshotsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeSnapshotsResult) => void): Request; + /** + * Obtains information about the directory snapshots that belong to this account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter. + */ + describeSnapshots(callback?: (err: AWSError, data: DirectoryService.Types.DescribeSnapshotsResult) => void): Request; + /** + * Obtains information about the trust relationships for this account. If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. + */ + describeTrusts(params: DirectoryService.Types.DescribeTrustsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeTrustsResult) => void): Request; + /** + * Obtains information about the trust relationships for this account. If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. + */ + describeTrusts(callback?: (err: AWSError, data: DirectoryService.Types.DescribeTrustsResult) => void): Request; + /** + * Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. + */ + disableRadius(params: DirectoryService.Types.DisableRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.DisableRadiusResult) => void): Request; + /** + * Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. + */ + disableRadius(callback?: (err: AWSError, data: DirectoryService.Types.DisableRadiusResult) => void): Request; + /** + * Disables single-sign on for a directory. + */ + disableSso(params: DirectoryService.Types.DisableSsoRequest, callback?: (err: AWSError, data: DirectoryService.Types.DisableSsoResult) => void): Request; + /** + * Disables single-sign on for a directory. + */ + disableSso(callback?: (err: AWSError, data: DirectoryService.Types.DisableSsoResult) => void): Request; + /** + * Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. + */ + enableRadius(params: DirectoryService.Types.EnableRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.EnableRadiusResult) => void): Request; + /** + * Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. + */ + enableRadius(callback?: (err: AWSError, data: DirectoryService.Types.EnableRadiusResult) => void): Request; + /** + * Enables single sign-on for a directory. + */ + enableSso(params: DirectoryService.Types.EnableSsoRequest, callback?: (err: AWSError, data: DirectoryService.Types.EnableSsoResult) => void): Request; + /** + * Enables single sign-on for a directory. + */ + enableSso(callback?: (err: AWSError, data: DirectoryService.Types.EnableSsoResult) => void): Request; + /** + * Obtains directory limit information for the current region. + */ + getDirectoryLimits(params: DirectoryService.Types.GetDirectoryLimitsRequest, callback?: (err: AWSError, data: DirectoryService.Types.GetDirectoryLimitsResult) => void): Request; + /** + * Obtains directory limit information for the current region. + */ + getDirectoryLimits(callback?: (err: AWSError, data: DirectoryService.Types.GetDirectoryLimitsResult) => void): Request; + /** + * Obtains the manual snapshot limits for a directory. + */ + getSnapshotLimits(params: DirectoryService.Types.GetSnapshotLimitsRequest, callback?: (err: AWSError, data: DirectoryService.Types.GetSnapshotLimitsResult) => void): Request; + /** + * Obtains the manual snapshot limits for a directory. + */ + getSnapshotLimits(callback?: (err: AWSError, data: DirectoryService.Types.GetSnapshotLimitsResult) => void): Request; + /** + * Lists the address blocks that you have added to a directory. + */ + listIpRoutes(params: DirectoryService.Types.ListIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListIpRoutesResult) => void): Request; + /** + * Lists the address blocks that you have added to a directory. + */ + listIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.ListIpRoutesResult) => void): Request; + /** + * Lists the active log subscriptions for the AWS account. + */ + listLogSubscriptions(params: DirectoryService.Types.ListLogSubscriptionsRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListLogSubscriptionsResult) => void): Request; + /** + * Lists the active log subscriptions for the AWS account. + */ + listLogSubscriptions(callback?: (err: AWSError, data: DirectoryService.Types.ListLogSubscriptionsResult) => void): Request; + /** + * Lists all schema extensions applied to a Microsoft AD Directory. + */ + listSchemaExtensions(params: DirectoryService.Types.ListSchemaExtensionsRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListSchemaExtensionsResult) => void): Request; + /** + * Lists all schema extensions applied to a Microsoft AD Directory. + */ + listSchemaExtensions(callback?: (err: AWSError, data: DirectoryService.Types.ListSchemaExtensionsResult) => void): Request; + /** + * Lists all tags on a directory. + */ + listTagsForResource(params: DirectoryService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListTagsForResourceResult) => void): Request; + /** + * Lists all tags on a directory. + */ + listTagsForResource(callback?: (err: AWSError, data: DirectoryService.Types.ListTagsForResourceResult) => void): Request; + /** + * Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. + */ + registerEventTopic(params: DirectoryService.Types.RegisterEventTopicRequest, callback?: (err: AWSError, data: DirectoryService.Types.RegisterEventTopicResult) => void): Request; + /** + * Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. + */ + registerEventTopic(callback?: (err: AWSError, data: DirectoryService.Types.RegisterEventTopicResult) => void): Request; + /** + * Rejects a directory sharing request that was sent from the directory owner account. + */ + rejectSharedDirectory(params: DirectoryService.Types.RejectSharedDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.RejectSharedDirectoryResult) => void): Request; + /** + * Rejects a directory sharing request that was sent from the directory owner account. + */ + rejectSharedDirectory(callback?: (err: AWSError, data: DirectoryService.Types.RejectSharedDirectoryResult) => void): Request; + /** + * Removes IP address blocks from a directory. + */ + removeIpRoutes(params: DirectoryService.Types.RemoveIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.RemoveIpRoutesResult) => void): Request; + /** + * Removes IP address blocks from a directory. + */ + removeIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.RemoveIpRoutesResult) => void): Request; + /** + * Removes tags from a directory. + */ + removeTagsFromResource(params: DirectoryService.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.RemoveTagsFromResourceResult) => void): Request; + /** + * Removes tags from a directory. + */ + removeTagsFromResource(callback?: (err: AWSError, data: DirectoryService.Types.RemoveTagsFromResourceResult) => void): Request; + /** + * Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory. + */ + resetUserPassword(params: DirectoryService.Types.ResetUserPasswordRequest, callback?: (err: AWSError, data: DirectoryService.Types.ResetUserPasswordResult) => void): Request; + /** + * Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory. + */ + resetUserPassword(callback?: (err: AWSError, data: DirectoryService.Types.ResetUserPasswordResult) => void): Request; + /** + * Restores a directory using an existing directory snapshot. When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete. + */ + restoreFromSnapshot(params: DirectoryService.Types.RestoreFromSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.RestoreFromSnapshotResult) => void): Request; + /** + * Restores a directory using an existing directory snapshot. When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete. + */ + restoreFromSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.RestoreFromSnapshotResult) => void): Request; + /** + * Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region. When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account. The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE). The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer. + */ + shareDirectory(params: DirectoryService.Types.ShareDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.ShareDirectoryResult) => void): Request; + /** + * Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region. When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account. The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE). The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer. + */ + shareDirectory(callback?: (err: AWSError, data: DirectoryService.Types.ShareDirectoryResult) => void): Request; + /** + * Applies a schema extension to a Microsoft AD directory. + */ + startSchemaExtension(params: DirectoryService.Types.StartSchemaExtensionRequest, callback?: (err: AWSError, data: DirectoryService.Types.StartSchemaExtensionResult) => void): Request; + /** + * Applies a schema extension to a Microsoft AD directory. + */ + startSchemaExtension(callback?: (err: AWSError, data: DirectoryService.Types.StartSchemaExtensionResult) => void): Request; + /** + * Stops the directory sharing between the directory owner and consumer accounts. + */ + unshareDirectory(params: DirectoryService.Types.UnshareDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.UnshareDirectoryResult) => void): Request; + /** + * Stops the directory sharing between the directory owner and consumer accounts. + */ + unshareDirectory(callback?: (err: AWSError, data: DirectoryService.Types.UnshareDirectoryResult) => void): Request; + /** + * Updates a conditional forwarder that has been set up for your AWS directory. + */ + updateConditionalForwarder(params: DirectoryService.Types.UpdateConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateConditionalForwarderResult) => void): Request; + /** + * Updates a conditional forwarder that has been set up for your AWS directory. + */ + updateConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.UpdateConditionalForwarderResult) => void): Request; + /** + * Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request. + */ + updateNumberOfDomainControllers(params: DirectoryService.Types.UpdateNumberOfDomainControllersRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateNumberOfDomainControllersResult) => void): Request; + /** + * Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request. + */ + updateNumberOfDomainControllers(callback?: (err: AWSError, data: DirectoryService.Types.UpdateNumberOfDomainControllersResult) => void): Request; + /** + * Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory. + */ + updateRadius(params: DirectoryService.Types.UpdateRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateRadiusResult) => void): Request; + /** + * Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory. + */ + updateRadius(callback?: (err: AWSError, data: DirectoryService.Types.UpdateRadiusResult) => void): Request; + /** + * Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory. + */ + updateTrust(params: DirectoryService.Types.UpdateTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateTrustResult) => void): Request; + /** + * Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory. + */ + updateTrust(callback?: (err: AWSError, data: DirectoryService.Types.UpdateTrustResult) => void): Request; + /** + * AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain. + */ + verifyTrust(params: DirectoryService.Types.VerifyTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.VerifyTrustResult) => void): Request; + /** + * AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain. + */ + verifyTrust(callback?: (err: AWSError, data: DirectoryService.Types.VerifyTrustResult) => void): Request; +} +declare namespace DirectoryService { + export interface AcceptSharedDirectoryRequest { + /** + * Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account. + */ + SharedDirectoryId: DirectoryId; + } + export interface AcceptSharedDirectoryResult { + /** + * The shared directory in the directory consumer account. + */ + SharedDirectory?: SharedDirectory; + } + export type AccessUrl = string; + export interface AddIpRoutesRequest { + /** + * Identifier (ID) of the directory to which to add the address block. + */ + DirectoryId: DirectoryId; + /** + * IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain. + */ + IpRoutes: IpRoutes; + /** + * If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." Following are the new rules: Inbound: Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0 Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0 Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0 Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0 Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0 Outbound: Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0 These security rules impact an internal network interface that is not exposed publicly. + */ + UpdateSecurityGroupForDirectoryControllers?: UpdateSecurityGroupForDirectoryControllers; + } + export interface AddIpRoutesResult { + } + export interface AddTagsToResourceRequest { + /** + * Identifier (ID) for the directory to which to add the tag. + */ + ResourceId: ResourceId; + /** + * The tags to be assigned to the directory. + */ + Tags: Tags; + } + export interface AddTagsToResourceResult { + } + export type AddedDateTime = Date; + export type AliasName = string; + export interface Attribute { + /** + * The name of the attribute. + */ + Name?: AttributeName; + /** + * The value of the attribute. + */ + Value?: AttributeValue; + } + export type AttributeName = string; + export type AttributeValue = string; + export type Attributes = Attribute[]; + export type AvailabilityZone = string; + export type AvailabilityZones = AvailabilityZone[]; + export interface CancelSchemaExtensionRequest { + /** + * The identifier of the directory whose schema extension will be canceled. + */ + DirectoryId: DirectoryId; + /** + * The identifier of the schema extension that will be canceled. + */ + SchemaExtensionId: SchemaExtensionId; + } + export interface CancelSchemaExtensionResult { + } + export type CidrIp = string; + export type CidrIps = CidrIp[]; + export type CloudOnlyDirectoriesLimitReached = boolean; + export interface Computer { + /** + * The identifier of the computer. + */ + ComputerId?: SID; + /** + * The computer name. + */ + ComputerName?: ComputerName; + /** + * An array of Attribute objects containing the LDAP attributes that belong to the computer account. + */ + ComputerAttributes?: Attributes; + } + export type ComputerName = string; + export type ComputerPassword = string; + export interface ConditionalForwarder { + /** + * The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder. + */ + RemoteDomainName?: RemoteDomainName; + /** + * The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to. + */ + DnsIpAddrs?: DnsIpAddrs; + /** + * The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your AWS directory. + */ + ReplicationScope?: ReplicationScope; + } + export type ConditionalForwarders = ConditionalForwarder[]; + export interface ConnectDirectoryRequest { + /** + * The fully qualified name of the on-premises directory, such as corp.example.com. + */ + Name: DirectoryName; + /** + * The NetBIOS name of the on-premises directory, such as CORP. + */ + ShortName?: DirectoryShortName; + /** + * The password for the on-premises user account. + */ + Password: ConnectPassword; + /** + * A textual description for the directory. + */ + Description?: Description; + /** + * The size of the directory. + */ + Size: DirectorySize; + /** + * A DirectoryConnectSettings object that contains additional information for the operation. + */ + ConnectSettings: DirectoryConnectSettings; + /** + * The tags to be assigned to AD Connector. + */ + Tags?: Tags; + } + export interface ConnectDirectoryResult { + /** + * The identifier of the new directory. + */ + DirectoryId?: DirectoryId; + } + export type ConnectPassword = string; + export type ConnectedDirectoriesLimitReached = boolean; + export interface CreateAliasRequest { + /** + * The identifier of the directory for which to create the alias. + */ + DirectoryId: DirectoryId; + /** + * The requested alias. The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists. + */ + Alias: AliasName; + } + export interface CreateAliasResult { + /** + * The identifier of the directory. + */ + DirectoryId?: DirectoryId; + /** + * The alias for the directory. + */ + Alias?: AliasName; + } + export interface CreateComputerRequest { + /** + * The identifier of the directory in which to create the computer account. + */ + DirectoryId: DirectoryId; + /** + * The name of the computer account. + */ + ComputerName: ComputerName; + /** + * A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter. + */ + Password: ComputerPassword; + /** + * The fully-qualified distinguished name of the organizational unit to place the computer account in. + */ + OrganizationalUnitDistinguishedName?: OrganizationalUnitDN; + /** + * An array of Attribute objects that contain any LDAP attributes to apply to the computer account. + */ + ComputerAttributes?: Attributes; + } + export interface CreateComputerResult { + /** + * A Computer object that represents the computer account. + */ + Computer?: Computer; + } + export interface CreateConditionalForwarderRequest { + /** + * The directory ID of the AWS directory for which you are creating the conditional forwarder. + */ + DirectoryId: DirectoryId; + /** + * The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship. + */ + RemoteDomainName: RemoteDomainName; + /** + * The IP addresses of the remote DNS server associated with RemoteDomainName. + */ + DnsIpAddrs: DnsIpAddrs; + } + export interface CreateConditionalForwarderResult { + } + export interface CreateDirectoryRequest { + /** + * The fully qualified name for the directory, such as corp.example.com. + */ + Name: DirectoryName; + /** + * The short name of the directory, such as CORP. + */ + ShortName?: DirectoryShortName; + /** + * The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password. + */ + Password: Password; + /** + * A textual description for the directory. + */ + Description?: Description; + /** + * The size of the directory. + */ + Size: DirectorySize; + /** + * A DirectoryVpcSettings object that contains additional information for the operation. + */ + VpcSettings?: DirectoryVpcSettings; + /** + * The tags to be assigned to the Simple AD directory. + */ + Tags?: Tags; + } + export interface CreateDirectoryResult { + /** + * The identifier of the directory that was created. + */ + DirectoryId?: DirectoryId; + } + export interface CreateLogSubscriptionRequest { + /** + * Identifier (ID) of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group. + */ + DirectoryId: DirectoryId; + /** + * The name of the CloudWatch log group where the real-time domain controller logs are forwarded. + */ + LogGroupName: LogGroupName; + } + export interface CreateLogSubscriptionResult { + } + export interface CreateMicrosoftADRequest { + /** + * The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable. + */ + Name: DirectoryName; + /** + * The NetBIOS name for your domain. A short identifier for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com. + */ + ShortName?: DirectoryShortName; + /** + * The password for the default administrative user named Admin. + */ + Password: Password; + /** + * A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created. + */ + Description?: Description; + /** + * Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation. + */ + VpcSettings: DirectoryVpcSettings; + /** + * AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default. + */ + Edition?: DirectoryEdition; + /** + * The tags to be assigned to the AWS Managed Microsoft AD directory. + */ + Tags?: Tags; + } + export interface CreateMicrosoftADResult { + /** + * The identifier of the directory that was created. + */ + DirectoryId?: DirectoryId; + } + export type CreateSnapshotBeforeSchemaExtension = boolean; + export interface CreateSnapshotRequest { + /** + * The identifier of the directory of which to take a snapshot. + */ + DirectoryId: DirectoryId; + /** + * The descriptive name to apply to the snapshot. + */ + Name?: SnapshotName; + } + export interface CreateSnapshotResult { + /** + * The identifier of the snapshot that was created. + */ + SnapshotId?: SnapshotId; + } + export interface CreateTrustRequest { + /** + * The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship. + */ + DirectoryId: DirectoryId; + /** + * The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship. + */ + RemoteDomainName: RemoteDomainName; + /** + * The trust password. The must be the same password that was used when creating the trust relationship on the external domain. + */ + TrustPassword: TrustPassword; + /** + * The direction of the trust relationship. + */ + TrustDirection: TrustDirection; + /** + * The trust relationship type. Forest is the default. + */ + TrustType?: TrustType; + /** + * The IP addresses of the remote DNS server associated with RemoteDomainName. + */ + ConditionalForwarderIpAddrs?: DnsIpAddrs; + /** + * Optional parameter to enable selective authentication for the trust. + */ + SelectiveAuth?: SelectiveAuth; + } + export interface CreateTrustResult { + /** + * A unique identifier for the trust relationship that was created. + */ + TrustId?: TrustId; + } + export type CreatedDateTime = Date; + export type CustomerId = string; + export type CustomerUserName = string; + export type DeleteAssociatedConditionalForwarder = boolean; + export interface DeleteConditionalForwarderRequest { + /** + * The directory ID for which you are deleting the conditional forwarder. + */ + DirectoryId: DirectoryId; + /** + * The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder. + */ + RemoteDomainName: RemoteDomainName; + } + export interface DeleteConditionalForwarderResult { + } + export interface DeleteDirectoryRequest { + /** + * The identifier of the directory to delete. + */ + DirectoryId: DirectoryId; + } + export interface DeleteDirectoryResult { + /** + * The directory identifier. + */ + DirectoryId?: DirectoryId; + } + export interface DeleteLogSubscriptionRequest { + /** + * Identifier (ID) of the directory whose log subscription you want to delete. + */ + DirectoryId: DirectoryId; + } + export interface DeleteLogSubscriptionResult { + } + export interface DeleteSnapshotRequest { + /** + * The identifier of the directory snapshot to be deleted. + */ + SnapshotId: SnapshotId; + } + export interface DeleteSnapshotResult { + /** + * The identifier of the directory snapshot that was deleted. + */ + SnapshotId?: SnapshotId; + } + export interface DeleteTrustRequest { + /** + * The Trust ID of the trust relationship to be deleted. + */ + TrustId: TrustId; + /** + * Delete a conditional forwarder as part of a DeleteTrustRequest. + */ + DeleteAssociatedConditionalForwarder?: DeleteAssociatedConditionalForwarder; + } + export interface DeleteTrustResult { + /** + * The Trust ID of the trust relationship that was deleted. + */ + TrustId?: TrustId; + } + export interface DeregisterEventTopicRequest { + /** + * The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic. + */ + DirectoryId: DirectoryId; + /** + * The name of the SNS topic from which to remove the directory as a publisher. + */ + TopicName: TopicName; + } + export interface DeregisterEventTopicResult { + } + export interface DescribeConditionalForwardersRequest { + /** + * The directory ID for which to get the list of associated conditional forwarders. + */ + DirectoryId: DirectoryId; + /** + * The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned. + */ + RemoteDomainNames?: RemoteDomainNames; + } + export interface DescribeConditionalForwardersResult { + /** + * The list of conditional forwarders that have been created. + */ + ConditionalForwarders?: ConditionalForwarders; + } + export interface DescribeDirectoriesRequest { + /** + * A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned. An empty list results in an InvalidParameterException being thrown. + */ + DirectoryIds?: DirectoryIds; + /** + * The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. + */ + Limit?: Limit; + } + export interface DescribeDirectoriesResult { + /** + * The list of DirectoryDescription objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. + */ + DirectoryDescriptions?: DirectoryDescriptions; + /** + * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items. + */ + NextToken?: NextToken; + } + export interface DescribeDomainControllersRequest { + /** + * Identifier of the directory for which to retrieve the domain controller information. + */ + DirectoryId: DirectoryId; + /** + * A list of identifiers for the domain controllers whose information will be provided. + */ + DomainControllerIds?: DomainControllerIds; + /** + * The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return. + */ + Limit?: Limit; + } + export interface DescribeDomainControllersResult { + /** + * List of the DomainController objects that were retrieved. + */ + DomainControllers?: DomainControllers; + /** + * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items. + */ + NextToken?: NextToken; + } + export interface DescribeEventTopicsRequest { + /** + * The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned. + */ + DirectoryId?: DirectoryId; + /** + * A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned. An empty list results in an InvalidParameterException being thrown. + */ + TopicNames?: TopicNames; + } + export interface DescribeEventTopicsResult { + /** + * A list of SNS topic names that receive status messages from the specified Directory ID. + */ + EventTopics?: EventTopics; + } + export interface DescribeSharedDirectoriesRequest { + /** + * Returns the identifier of the directory in the directory owner account. + */ + OwnerDirectoryId: DirectoryId; + /** + * A list of identifiers of all shared directories in your account. + */ + SharedDirectoryIds?: DirectoryIds; + /** + * The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call. + */ + NextToken?: NextToken; + /** + * The number of shared directories to return in the response object. + */ + Limit?: Limit; + } + export interface DescribeSharedDirectoriesResult { + /** + * A list of all shared directories in your account. + */ + SharedDirectories?: SharedDirectories; + /** + * If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items. + */ + NextToken?: NextToken; + } + export interface DescribeSnapshotsRequest { + /** + * The identifier of the directory for which to retrieve snapshot information. + */ + DirectoryId?: DirectoryId; + /** + * A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members. + */ + SnapshotIds?: SnapshotIds; + /** + * The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call. + */ + NextToken?: NextToken; + /** + * The maximum number of objects to return. + */ + Limit?: Limit; + } + export interface DescribeSnapshotsResult { + /** + * The list of Snapshot objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. + */ + Snapshots?: Snapshots; + /** + * If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots. + */ + NextToken?: NextToken; + } + export interface DescribeTrustsRequest { + /** + * The Directory ID of the AWS directory that is a part of the requested trust relationship. + */ + DirectoryId?: DirectoryId; + /** + * A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. An empty list results in an InvalidParameterException being thrown. + */ + TrustIds?: TrustIds; + /** + * The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call. + */ + NextToken?: NextToken; + /** + * The maximum number of objects to return. + */ + Limit?: Limit; + } + export interface DescribeTrustsResult { + /** + * The list of Trust objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. + */ + Trusts?: Trusts; + /** + * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items. + */ + NextToken?: NextToken; + } + export type Description = string; + export type DesiredNumberOfDomainControllers = number; + export interface DirectoryConnectSettings { + /** + * The identifier of the VPC in which the AD Connector is created. + */ + VpcId: VpcId; + /** + * A list of subnet identifiers in the VPC in which the AD Connector is created. + */ + SubnetIds: SubnetIds; + /** + * A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory. + */ + CustomerDnsIps: DnsIpAddrs; + /** + * The user name of an account in the on-premises directory that is used to connect to the directory. This account must have the following permissions: Read users and groups Create computer objects Join computers to the domain + */ + CustomerUserName: UserName; + } + export interface DirectoryConnectSettingsDescription { + /** + * The identifier of the VPC that the AD Connector is in. + */ + VpcId?: VpcId; + /** + * A list of subnet identifiers in the VPC that the AD connector is in. + */ + SubnetIds?: SubnetIds; + /** + * The user name of the service account in the on-premises directory. + */ + CustomerUserName?: UserName; + /** + * The security group identifier for the AD Connector directory. + */ + SecurityGroupId?: SecurityGroupId; + /** + * A list of the Availability Zones that the directory is in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The IP addresses of the AD Connector servers. + */ + ConnectIps?: IpAddrs; + } + export interface DirectoryDescription { + /** + * The directory identifier. + */ + DirectoryId?: DirectoryId; + /** + * The fully qualified name of the directory. + */ + Name?: DirectoryName; + /** + * The short name of the directory. + */ + ShortName?: DirectoryShortName; + /** + * The directory size. + */ + Size?: DirectorySize; + /** + * The edition associated with this directory. + */ + Edition?: DirectoryEdition; + /** + * The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX. + */ + Alias?: AliasName; + /** + * The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX. + */ + AccessUrl?: AccessUrl; + /** + * The textual description for the directory. + */ + Description?: Description; + /** + * The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected. + */ + DnsIpAddrs?: DnsIpAddrs; + /** + * The current stage of the directory. + */ + Stage?: DirectoryStage; + /** + * Current directory status of the shared AWS Managed Microsoft AD directory. + */ + ShareStatus?: ShareStatus; + /** + * The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE). + */ + ShareMethod?: ShareMethod; + /** + * A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation. + */ + ShareNotes?: Notes; + /** + * Specifies when the directory was created. + */ + LaunchTime?: LaunchTime; + /** + * The date and time that the stage was last updated. + */ + StageLastUpdatedDateTime?: LastUpdatedDateTime; + /** + * The directory size. + */ + Type?: DirectoryType; + /** + * A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory. + */ + VpcSettings?: DirectoryVpcSettingsDescription; + /** + * A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory. + */ + ConnectSettings?: DirectoryConnectSettingsDescription; + /** + * A RadiusSettings object that contains information about the RADIUS server configured for this directory. + */ + RadiusSettings?: RadiusSettings; + /** + * The status of the RADIUS MFA server connection. + */ + RadiusStatus?: RadiusStatus; + /** + * Additional information about the directory stage. + */ + StageReason?: StageReason; + /** + * Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso. + */ + SsoEnabled?: SsoEnabled; + /** + * The desired number of domain controllers in the directory if the directory is Microsoft AD. + */ + DesiredNumberOfDomainControllers?: DesiredNumberOfDomainControllers; + /** + * Describes the AWS Managed Microsoft AD directory in the directory owner account. + */ + OwnerDirectoryDescription?: OwnerDirectoryDescription; + } + export type DirectoryDescriptions = DirectoryDescription[]; + export type DirectoryEdition = "Enterprise"|"Standard"|string; + export type DirectoryId = string; + export type DirectoryIds = DirectoryId[]; + export interface DirectoryLimits { + /** + * The maximum number of cloud directories allowed in the region. + */ + CloudOnlyDirectoriesLimit?: Limit; + /** + * The current number of cloud directories in the region. + */ + CloudOnlyDirectoriesCurrentCount?: Limit; + /** + * Indicates if the cloud directory limit has been reached. + */ + CloudOnlyDirectoriesLimitReached?: CloudOnlyDirectoriesLimitReached; + /** + * The maximum number of AWS Managed Microsoft AD directories allowed in the region. + */ + CloudOnlyMicrosoftADLimit?: Limit; + /** + * The current number of AWS Managed Microsoft AD directories in the region. + */ + CloudOnlyMicrosoftADCurrentCount?: Limit; + /** + * Indicates if the AWS Managed Microsoft AD directory limit has been reached. + */ + CloudOnlyMicrosoftADLimitReached?: CloudOnlyDirectoriesLimitReached; + /** + * The maximum number of connected directories allowed in the region. + */ + ConnectedDirectoriesLimit?: Limit; + /** + * The current number of connected directories in the region. + */ + ConnectedDirectoriesCurrentCount?: Limit; + /** + * Indicates if the connected directory limit has been reached. + */ + ConnectedDirectoriesLimitReached?: ConnectedDirectoriesLimitReached; + } + export type DirectoryName = string; + export type DirectoryShortName = string; + export type DirectorySize = "Small"|"Large"|string; + export type DirectoryStage = "Requested"|"Creating"|"Created"|"Active"|"Inoperable"|"Impaired"|"Restoring"|"RestoreFailed"|"Deleting"|"Deleted"|"Failed"|string; + export type DirectoryType = "SimpleAD"|"ADConnector"|"MicrosoftAD"|"SharedMicrosoftAD"|string; + export interface DirectoryVpcSettings { + /** + * The identifier of the VPC in which to create the directory. + */ + VpcId: VpcId; + /** + * The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets. + */ + SubnetIds: SubnetIds; + } + export interface DirectoryVpcSettingsDescription { + /** + * The identifier of the VPC that the directory is in. + */ + VpcId?: VpcId; + /** + * The identifiers of the subnets for the directory servers. + */ + SubnetIds?: SubnetIds; + /** + * The domain controller security group identifier for the directory. + */ + SecurityGroupId?: SecurityGroupId; + /** + * The list of Availability Zones that the directory is in. + */ + AvailabilityZones?: AvailabilityZones; + } + export interface DisableRadiusRequest { + /** + * The identifier of the directory for which to disable MFA. + */ + DirectoryId: DirectoryId; + } + export interface DisableRadiusResult { + } + export interface DisableSsoRequest { + /** + * The identifier of the directory for which to disable single-sign on. + */ + DirectoryId: DirectoryId; + /** + * The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name. If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed. + */ + UserName?: UserName; + /** + * The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter. + */ + Password?: ConnectPassword; + } + export interface DisableSsoResult { + } + export type DnsIpAddrs = IpAddr[]; + export interface DomainController { + /** + * Identifier of the directory where the domain controller resides. + */ + DirectoryId?: DirectoryId; + /** + * Identifies a specific domain controller in the directory. + */ + DomainControllerId?: DomainControllerId; + /** + * The IP address of the domain controller. + */ + DnsIpAddr?: IpAddr; + /** + * The identifier of the VPC that contains the domain controller. + */ + VpcId?: VpcId; + /** + * Identifier of the subnet in the VPC that contains the domain controller. + */ + SubnetId?: SubnetId; + /** + * The Availability Zone where the domain controller is located. + */ + AvailabilityZone?: AvailabilityZone; + /** + * The status of the domain controller. + */ + Status?: DomainControllerStatus; + /** + * A description of the domain controller state. + */ + StatusReason?: DomainControllerStatusReason; + /** + * Specifies when the domain controller was created. + */ + LaunchTime?: LaunchTime; + /** + * The date and time that the status was last updated. + */ + StatusLastUpdatedDateTime?: LastUpdatedDateTime; + } + export type DomainControllerId = string; + export type DomainControllerIds = DomainControllerId[]; + export type DomainControllerStatus = "Creating"|"Active"|"Impaired"|"Restoring"|"Deleting"|"Deleted"|"Failed"|string; + export type DomainControllerStatusReason = string; + export type DomainControllers = DomainController[]; + export interface EnableRadiusRequest { + /** + * The identifier of the directory for which to enable MFA. + */ + DirectoryId: DirectoryId; + /** + * A RadiusSettings object that contains information about the RADIUS server. + */ + RadiusSettings: RadiusSettings; + } + export interface EnableRadiusResult { + } + export interface EnableSsoRequest { + /** + * The identifier of the directory for which to enable single-sign on. + */ + DirectoryId: DirectoryId; + /** + * The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name. If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed. + */ + UserName?: UserName; + /** + * The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter. + */ + Password?: ConnectPassword; + } + export interface EnableSsoResult { + } + export type EndDateTime = Date; + export interface EventTopic { + /** + * The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic. + */ + DirectoryId?: DirectoryId; + /** + * The name of an AWS SNS topic the receives status messages from the directory. + */ + TopicName?: TopicName; + /** + * The SNS topic ARN (Amazon Resource Name). + */ + TopicArn?: TopicArn; + /** + * The date and time of when you associated your directory with the SNS topic. + */ + CreatedDateTime?: CreatedDateTime; + /** + * The topic registration status. + */ + Status?: TopicStatus; + } + export type EventTopics = EventTopic[]; + export interface GetDirectoryLimitsRequest { + } + export interface GetDirectoryLimitsResult { + /** + * A DirectoryLimits object that contains the directory limits for the current region. + */ + DirectoryLimits?: DirectoryLimits; + } + export interface GetSnapshotLimitsRequest { + /** + * Contains the identifier of the directory to obtain the limits for. + */ + DirectoryId: DirectoryId; + } + export interface GetSnapshotLimitsResult { + /** + * A SnapshotLimits object that contains the manual snapshot limits for the specified directory. + */ + SnapshotLimits?: SnapshotLimits; + } + export type IpAddr = string; + export type IpAddrs = IpAddr[]; + export interface IpRoute { + /** + * IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32. + */ + CidrIp?: CidrIp; + /** + * Description of the address block. + */ + Description?: Description; + } + export interface IpRouteInfo { + /** + * Identifier (ID) of the directory associated with the IP addresses. + */ + DirectoryId?: DirectoryId; + /** + * IP address block in the IpRoute. + */ + CidrIp?: CidrIp; + /** + * The status of the IP address block. + */ + IpRouteStatusMsg?: IpRouteStatusMsg; + /** + * The date and time the address block was added to the directory. + */ + AddedDateTime?: AddedDateTime; + /** + * The reason for the IpRouteStatusMsg. + */ + IpRouteStatusReason?: IpRouteStatusReason; + /** + * Description of the IpRouteInfo. + */ + Description?: Description; + } + export type IpRouteStatusMsg = "Adding"|"Added"|"Removing"|"Removed"|"AddFailed"|"RemoveFailed"|string; + export type IpRouteStatusReason = string; + export type IpRoutes = IpRoute[]; + export type IpRoutesInfo = IpRouteInfo[]; + export type LastUpdatedDateTime = Date; + export type LaunchTime = Date; + export type LdifContent = string; + export type Limit = number; + export interface ListIpRoutesRequest { + /** + * Identifier (ID) of the directory for which you want to retrieve the IP addresses. + */ + DirectoryId: DirectoryId; + /** + * The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call. + */ + NextToken?: NextToken; + /** + * Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. + */ + Limit?: Limit; + } + export interface ListIpRoutesResult { + /** + * A list of IpRoutes. + */ + IpRoutesInfo?: IpRoutesInfo; + /** + * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items. + */ + NextToken?: NextToken; + } + export interface ListLogSubscriptionsRequest { + /** + * If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned. + */ + DirectoryId?: DirectoryId; + /** + * The token for the next set of items to return. + */ + NextToken?: NextToken; + /** + * The maximum number of items returned. + */ + Limit?: Limit; + } + export interface ListLogSubscriptionsResult { + /** + * A list of active LogSubscription objects for calling the AWS account. + */ + LogSubscriptions?: LogSubscriptions; + /** + * The token for the next set of items to return. + */ + NextToken?: NextToken; + } + export interface ListSchemaExtensionsRequest { + /** + * The identifier of the directory from which to retrieve the schema extension information. + */ + DirectoryId: DirectoryId; + /** + * The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return. + */ + Limit?: Limit; + } + export interface ListSchemaExtensionsResult { + /** + * Information about the schema extensions applied to the directory. + */ + SchemaExtensionsInfo?: SchemaExtensionsInfo; + /** + * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * Identifier (ID) of the directory for which you want to retrieve tags. + */ + ResourceId: ResourceId; + /** + * Reserved for future use. + */ + NextToken?: NextToken; + /** + * Reserved for future use. + */ + Limit?: Limit; + } + export interface ListTagsForResourceResult { + /** + * List of tags returned by the ListTagsForResource operation. + */ + Tags?: Tags; + /** + * Reserved for future use. + */ + NextToken?: NextToken; + } + export type LogGroupName = string; + export interface LogSubscription { + /** + * Identifier (ID) of the directory that you want to associate with the log subscription. + */ + DirectoryId?: DirectoryId; + /** + * The name of the log group. + */ + LogGroupName?: LogGroupName; + /** + * The date and time that the log subscription was created. + */ + SubscriptionCreatedDateTime?: SubscriptionCreatedDateTime; + } + export type LogSubscriptions = LogSubscription[]; + export type ManualSnapshotsLimitReached = boolean; + export type NextToken = string; + export type Notes = string; + export type OrganizationalUnitDN = string; + export interface OwnerDirectoryDescription { + /** + * Identifier of the AWS Managed Microsoft AD directory in the directory owner account. + */ + DirectoryId?: DirectoryId; + /** + * Identifier of the directory owner account. + */ + AccountId?: CustomerId; + /** + * IP address of the directory’s domain controllers. + */ + DnsIpAddrs?: DnsIpAddrs; + /** + * Information about the VPC settings for the directory. + */ + VpcSettings?: DirectoryVpcSettingsDescription; + /** + * A RadiusSettings object that contains information about the RADIUS server. + */ + RadiusSettings?: RadiusSettings; + /** + * Information about the status of the RADIUS server. + */ + RadiusStatus?: RadiusStatus; + } + export type Password = string; + export type PortNumber = number; + export type RadiusAuthenticationProtocol = "PAP"|"CHAP"|"MS-CHAPv1"|"MS-CHAPv2"|string; + export type RadiusDisplayLabel = string; + export type RadiusRetries = number; + export interface RadiusSettings { + /** + * An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer. + */ + RadiusServers?: Servers; + /** + * The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers. + */ + RadiusPort?: PortNumber; + /** + * The amount of time, in seconds, to wait for the RADIUS server to respond. + */ + RadiusTimeout?: RadiusTimeout; + /** + * The maximum number of times that communication with the RADIUS server is attempted. + */ + RadiusRetries?: RadiusRetries; + /** + * Required for enabling RADIUS on the directory. + */ + SharedSecret?: RadiusSharedSecret; + /** + * The protocol specified for your RADIUS endpoints. + */ + AuthenticationProtocol?: RadiusAuthenticationProtocol; + /** + * Not currently used. + */ + DisplayLabel?: RadiusDisplayLabel; + /** + * Not currently used. + */ + UseSameUsername?: UseSameUsername; + } + export type RadiusSharedSecret = string; + export type RadiusStatus = "Creating"|"Completed"|"Failed"|string; + export type RadiusTimeout = number; + export interface RegisterEventTopicRequest { + /** + * The Directory ID that will publish status messages to the SNS topic. + */ + DirectoryId: DirectoryId; + /** + * The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID. + */ + TopicName: TopicName; + } + export interface RegisterEventTopicResult { + } + export interface RejectSharedDirectoryRequest { + /** + * Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account. + */ + SharedDirectoryId: DirectoryId; + } + export interface RejectSharedDirectoryResult { + /** + * Identifier of the shared directory in the directory consumer account. + */ + SharedDirectoryId?: DirectoryId; + } + export type RemoteDomainName = string; + export type RemoteDomainNames = RemoteDomainName[]; + export interface RemoveIpRoutesRequest { + /** + * Identifier (ID) of the directory from which you want to remove the IP addresses. + */ + DirectoryId: DirectoryId; + /** + * IP address blocks that you want to remove. + */ + CidrIps: CidrIps; + } + export interface RemoveIpRoutesResult { + } + export interface RemoveTagsFromResourceRequest { + /** + * Identifier (ID) of the directory from which to remove the tag. + */ + ResourceId: ResourceId; + /** + * The tag key (name) of the tag to be removed. + */ + TagKeys: TagKeys; + } + export interface RemoveTagsFromResourceResult { + } + export type ReplicationScope = "Domain"|string; + export type RequestId = string; + export interface ResetUserPasswordRequest { + /** + * Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides. + */ + DirectoryId: DirectoryId; + /** + * The user name of the user whose password will be reset. + */ + UserName: CustomerUserName; + /** + * The new password that will be reset. + */ + NewPassword: UserPassword; + } + export interface ResetUserPasswordResult { + } + export type ResourceId = string; + export interface RestoreFromSnapshotRequest { + /** + * The identifier of the snapshot to restore from. + */ + SnapshotId: SnapshotId; + } + export interface RestoreFromSnapshotResult { + } + export type SID = string; + export type SchemaExtensionId = string; + export interface SchemaExtensionInfo { + /** + * The identifier of the directory to which the schema extension is applied. + */ + DirectoryId?: DirectoryId; + /** + * The identifier of the schema extension. + */ + SchemaExtensionId?: SchemaExtensionId; + /** + * A description of the schema extension. + */ + Description?: Description; + /** + * The current status of the schema extension. + */ + SchemaExtensionStatus?: SchemaExtensionStatus; + /** + * The reason for the SchemaExtensionStatus. + */ + SchemaExtensionStatusReason?: SchemaExtensionStatusReason; + /** + * The date and time that the schema extension started being applied to the directory. + */ + StartDateTime?: StartDateTime; + /** + * The date and time that the schema extension was completed. + */ + EndDateTime?: EndDateTime; + } + export type SchemaExtensionStatus = "Initializing"|"CreatingSnapshot"|"UpdatingSchema"|"Replicating"|"CancelInProgress"|"RollbackInProgress"|"Cancelled"|"Failed"|"Completed"|string; + export type SchemaExtensionStatusReason = string; + export type SchemaExtensionsInfo = SchemaExtensionInfo[]; + export type SecurityGroupId = string; + export type SelectiveAuth = "Enabled"|"Disabled"|string; + export type Server = string; + export type Servers = Server[]; + export interface ShareDirectoryRequest { + /** + * Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts. + */ + DirectoryId: DirectoryId; + /** + * A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation. + */ + ShareNotes?: Notes; + /** + * Identifier for the directory consumer account with whom the directory is to be shared. + */ + ShareTarget: ShareTarget; + /** + * The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE). + */ + ShareMethod: ShareMethod; + } + export interface ShareDirectoryResult { + /** + * Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId). + */ + SharedDirectoryId?: DirectoryId; + } + export type ShareMethod = "ORGANIZATIONS"|"HANDSHAKE"|string; + export type ShareStatus = "Shared"|"PendingAcceptance"|"Rejected"|"Rejecting"|"RejectFailed"|"Sharing"|"ShareFailed"|"Deleted"|"Deleting"|string; + export interface ShareTarget { + /** + * Identifier of the directory consumer account. + */ + Id: TargetId; + /** + * Type of identifier to be used in the Id field. + */ + Type: TargetType; + } + export type SharedDirectories = SharedDirectory[]; + export interface SharedDirectory { + /** + * Identifier of the directory owner account, which contains the directory that has been shared to the consumer account. + */ + OwnerAccountId?: CustomerId; + /** + * Identifier of the directory in the directory owner account. + */ + OwnerDirectoryId?: DirectoryId; + /** + * The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE). + */ + ShareMethod?: ShareMethod; + /** + * Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account. + */ + SharedAccountId?: CustomerId; + /** + * Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account. + */ + SharedDirectoryId?: DirectoryId; + /** + * Current directory status of the shared AWS Managed Microsoft AD directory. + */ + ShareStatus?: ShareStatus; + /** + * A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation. + */ + ShareNotes?: Notes; + /** + * The date and time that the shared directory was created. + */ + CreatedDateTime?: CreatedDateTime; + /** + * The date and time that the shared directory was last updated. + */ + LastUpdatedDateTime?: LastUpdatedDateTime; + } + export interface Snapshot { + /** + * The directory identifier. + */ + DirectoryId?: DirectoryId; + /** + * The snapshot identifier. + */ + SnapshotId?: SnapshotId; + /** + * The snapshot type. + */ + Type?: SnapshotType; + /** + * The descriptive name of the snapshot. + */ + Name?: SnapshotName; + /** + * The snapshot status. + */ + Status?: SnapshotStatus; + /** + * The date and time that the snapshot was taken. + */ + StartTime?: StartTime; + } + export type SnapshotId = string; + export type SnapshotIds = SnapshotId[]; + export interface SnapshotLimits { + /** + * The maximum number of manual snapshots allowed. + */ + ManualSnapshotsLimit?: Limit; + /** + * The current number of manual snapshots of the directory. + */ + ManualSnapshotsCurrentCount?: Limit; + /** + * Indicates if the manual snapshot limit has been reached. + */ + ManualSnapshotsLimitReached?: ManualSnapshotsLimitReached; + } + export type SnapshotName = string; + export type SnapshotStatus = "Creating"|"Completed"|"Failed"|string; + export type SnapshotType = "Auto"|"Manual"|string; + export type Snapshots = Snapshot[]; + export type SsoEnabled = boolean; + export type StageReason = string; + export type StartDateTime = Date; + export interface StartSchemaExtensionRequest { + /** + * The identifier of the directory for which the schema extension will be applied to. + */ + DirectoryId: DirectoryId; + /** + * If true, creates a snapshot of the directory before applying the schema extension. + */ + CreateSnapshotBeforeSchemaExtension: CreateSnapshotBeforeSchemaExtension; + /** + * The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB. + */ + LdifContent: LdifContent; + /** + * A description of the schema extension. + */ + Description: Description; + } + export interface StartSchemaExtensionResult { + /** + * The identifier of the schema extension that will be applied. + */ + SchemaExtensionId?: SchemaExtensionId; + } + export type StartTime = Date; + export type StateLastUpdatedDateTime = Date; + export type SubnetId = string; + export type SubnetIds = SubnetId[]; + export type SubscriptionCreatedDateTime = Date; + export interface Tag { + /** + * Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Key: TagKey; + /** + * The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeys = TagKey[]; + export type TagValue = string; + export type Tags = Tag[]; + export type TargetId = string; + export type TargetType = "ACCOUNT"|string; + export type TopicArn = string; + export type TopicName = string; + export type TopicNames = TopicName[]; + export type TopicStatus = "Registered"|"Topic not found"|"Failed"|"Deleted"|string; + export interface Trust { + /** + * The Directory ID of the AWS directory involved in the trust relationship. + */ + DirectoryId?: DirectoryId; + /** + * The unique ID of the trust relationship. + */ + TrustId?: TrustId; + /** + * The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship. + */ + RemoteDomainName?: RemoteDomainName; + /** + * The trust relationship type. Forest is the default. + */ + TrustType?: TrustType; + /** + * The trust relationship direction. + */ + TrustDirection?: TrustDirection; + /** + * The trust relationship state. + */ + TrustState?: TrustState; + /** + * The date and time that the trust relationship was created. + */ + CreatedDateTime?: CreatedDateTime; + /** + * The date and time that the trust relationship was last updated. + */ + LastUpdatedDateTime?: LastUpdatedDateTime; + /** + * The date and time that the TrustState was last updated. + */ + StateLastUpdatedDateTime?: StateLastUpdatedDateTime; + /** + * The reason for the TrustState. + */ + TrustStateReason?: TrustStateReason; + /** + * Current state of selective authentication for the trust. + */ + SelectiveAuth?: SelectiveAuth; + } + export type TrustDirection = "One-Way: Outgoing"|"One-Way: Incoming"|"Two-Way"|string; + export type TrustId = string; + export type TrustIds = TrustId[]; + export type TrustPassword = string; + export type TrustState = "Creating"|"Created"|"Verifying"|"VerifyFailed"|"Verified"|"Updating"|"UpdateFailed"|"Updated"|"Deleting"|"Deleted"|"Failed"|string; + export type TrustStateReason = string; + export type TrustType = "Forest"|"External"|string; + export type Trusts = Trust[]; + export interface UnshareDirectoryRequest { + /** + * The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing. + */ + DirectoryId: DirectoryId; + /** + * Identifier for the directory consumer account with whom the directory has to be unshared. + */ + UnshareTarget: UnshareTarget; + } + export interface UnshareDirectoryResult { + /** + * Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId). + */ + SharedDirectoryId?: DirectoryId; + } + export interface UnshareTarget { + /** + * Identifier of the directory consumer account. + */ + Id: TargetId; + /** + * Type of identifier to be used in the Id field. + */ + Type: TargetType; + } + export interface UpdateConditionalForwarderRequest { + /** + * The directory ID of the AWS directory for which to update the conditional forwarder. + */ + DirectoryId: DirectoryId; + /** + * The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship. + */ + RemoteDomainName: RemoteDomainName; + /** + * The updated IP addresses of the remote DNS server associated with the conditional forwarder. + */ + DnsIpAddrs: DnsIpAddrs; + } + export interface UpdateConditionalForwarderResult { + } + export interface UpdateNumberOfDomainControllersRequest { + /** + * Identifier of the directory to which the domain controllers will be added or removed. + */ + DirectoryId: DirectoryId; + /** + * The number of domain controllers desired in the directory. + */ + DesiredNumber: DesiredNumberOfDomainControllers; + } + export interface UpdateNumberOfDomainControllersResult { + } + export interface UpdateRadiusRequest { + /** + * The identifier of the directory for which to update the RADIUS server information. + */ + DirectoryId: DirectoryId; + /** + * A RadiusSettings object that contains information about the RADIUS server. + */ + RadiusSettings: RadiusSettings; + } + export interface UpdateRadiusResult { + } + export type UpdateSecurityGroupForDirectoryControllers = boolean; + export interface UpdateTrustRequest { + /** + * Identifier of the trust relationship. + */ + TrustId: TrustId; + /** + * Updates selective authentication for the trust. + */ + SelectiveAuth?: SelectiveAuth; + } + export interface UpdateTrustResult { + RequestId?: RequestId; + /** + * Identifier of the trust relationship. + */ + TrustId?: TrustId; + } + export type UseSameUsername = boolean; + export type UserName = string; + export type UserPassword = string; + export interface VerifyTrustRequest { + /** + * The unique Trust ID of the trust relationship to verify. + */ + TrustId: TrustId; + } + export interface VerifyTrustResult { + /** + * The unique Trust ID of the trust relationship that was verified. + */ + TrustId?: TrustId; + } + export type VpcId = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-04-16"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DirectoryService client. + */ + export import Types = DirectoryService; +} +export = DirectoryService; diff --git a/node_modules/aws-sdk/clients/directoryservice.js b/node_modules/aws-sdk/clients/directoryservice.js new file mode 100644 index 0000000..cab8f52 --- /dev/null +++ b/node_modules/aws-sdk/clients/directoryservice.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['directoryservice'] = {}; +AWS.DirectoryService = Service.defineService('directoryservice', ['2015-04-16']); +Object.defineProperty(apiLoader.services['directoryservice'], '2015-04-16', { + get: function get() { + var model = require('../apis/ds-2015-04-16.min.json'); + model.paginators = require('../apis/ds-2015-04-16.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DirectoryService; diff --git a/node_modules/aws-sdk/clients/discovery.d.ts b/node_modules/aws-sdk/clients/discovery.d.ts new file mode 100644 index 0000000..5e12a33 --- /dev/null +++ b/node_modules/aws-sdk/clients/discovery.d.ts @@ -0,0 +1,1146 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Discovery extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Discovery.Types.ClientConfiguration) + config: Config & Discovery.Types.ClientConfiguration; + /** + * Associates one or more configuration items with an application. + */ + associateConfigurationItemsToApplication(params: Discovery.Types.AssociateConfigurationItemsToApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.AssociateConfigurationItemsToApplicationResponse) => void): Request; + /** + * Associates one or more configuration items with an application. + */ + associateConfigurationItemsToApplication(callback?: (err: AWSError, data: Discovery.Types.AssociateConfigurationItemsToApplicationResponse) => void): Request; + /** + * Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications. AWS Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted. + */ + batchDeleteImportData(params: Discovery.Types.BatchDeleteImportDataRequest, callback?: (err: AWSError, data: Discovery.Types.BatchDeleteImportDataResponse) => void): Request; + /** + * Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications. AWS Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted. + */ + batchDeleteImportData(callback?: (err: AWSError, data: Discovery.Types.BatchDeleteImportDataResponse) => void): Request; + /** + * Creates an application with the given name and description. + */ + createApplication(params: Discovery.Types.CreateApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.CreateApplicationResponse) => void): Request; + /** + * Creates an application with the given name and description. + */ + createApplication(callback?: (err: AWSError, data: Discovery.Types.CreateApplicationResponse) => void): Request; + /** + * Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items. + */ + createTags(params: Discovery.Types.CreateTagsRequest, callback?: (err: AWSError, data: Discovery.Types.CreateTagsResponse) => void): Request; + /** + * Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items. + */ + createTags(callback?: (err: AWSError, data: Discovery.Types.CreateTagsResponse) => void): Request; + /** + * Deletes a list of applications and their associations with configuration items. + */ + deleteApplications(params: Discovery.Types.DeleteApplicationsRequest, callback?: (err: AWSError, data: Discovery.Types.DeleteApplicationsResponse) => void): Request; + /** + * Deletes a list of applications and their associations with configuration items. + */ + deleteApplications(callback?: (err: AWSError, data: Discovery.Types.DeleteApplicationsResponse) => void): Request; + /** + * Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items. + */ + deleteTags(params: Discovery.Types.DeleteTagsRequest, callback?: (err: AWSError, data: Discovery.Types.DeleteTagsResponse) => void): Request; + /** + * Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items. + */ + deleteTags(callback?: (err: AWSError, data: Discovery.Types.DeleteTagsResponse) => void): Request; + /** + * Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters. + */ + describeAgents(params: Discovery.Types.DescribeAgentsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeAgentsResponse) => void): Request; + /** + * Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters. + */ + describeAgents(callback?: (err: AWSError, data: Discovery.Types.DescribeAgentsResponse) => void): Request; + /** + * Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type from one of the following: server application process connection Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc. For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action. + */ + describeConfigurations(params: Discovery.Types.DescribeConfigurationsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeConfigurationsResponse) => void): Request; + /** + * Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type from one of the following: server application process connection Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc. For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action. + */ + describeConfigurations(callback?: (err: AWSError, data: Discovery.Types.DescribeConfigurationsResponse) => void): Request; + /** + * Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters. + */ + describeContinuousExports(params: Discovery.Types.DescribeContinuousExportsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeContinuousExportsResponse) => void): Request; + /** + * Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters. + */ + describeContinuousExports(callback?: (err: AWSError, data: Discovery.Types.DescribeContinuousExportsResponse) => void): Request; + /** + * DescribeExportConfigurations is deprecated. Use DescribeImportTasks, instead. + */ + describeExportConfigurations(params: Discovery.Types.DescribeExportConfigurationsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeExportConfigurationsResponse) => void): Request; + /** + * DescribeExportConfigurations is deprecated. Use DescribeImportTasks, instead. + */ + describeExportConfigurations(callback?: (err: AWSError, data: Discovery.Types.DescribeExportConfigurationsResponse) => void): Request; + /** + * Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks. + */ + describeExportTasks(params: Discovery.Types.DescribeExportTasksRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeExportTasksResponse) => void): Request; + /** + * Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks. + */ + describeExportTasks(callback?: (err: AWSError, data: Discovery.Types.DescribeExportTasksResponse) => void): Request; + /** + * Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more. + */ + describeImportTasks(params: Discovery.Types.DescribeImportTasksRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeImportTasksResponse) => void): Request; + /** + * Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more. + */ + describeImportTasks(callback?: (err: AWSError, data: Discovery.Types.DescribeImportTasksResponse) => void): Request; + /** + * Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters. There are three valid tag filter names: tagKey tagValue configurationId Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters. + */ + describeTags(params: Discovery.Types.DescribeTagsRequest, callback?: (err: AWSError, data: Discovery.Types.DescribeTagsResponse) => void): Request; + /** + * Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters. There are three valid tag filter names: tagKey tagValue configurationId Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters. + */ + describeTags(callback?: (err: AWSError, data: Discovery.Types.DescribeTagsResponse) => void): Request; + /** + * Disassociates one or more configuration items from an application. + */ + disassociateConfigurationItemsFromApplication(params: Discovery.Types.DisassociateConfigurationItemsFromApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.DisassociateConfigurationItemsFromApplicationResponse) => void): Request; + /** + * Disassociates one or more configuration items from an application. + */ + disassociateConfigurationItemsFromApplication(callback?: (err: AWSError, data: Discovery.Types.DisassociateConfigurationItemsFromApplicationResponse) => void): Request; + /** + * Deprecated. Use StartExportTask instead. Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours. + */ + exportConfigurations(callback?: (err: AWSError, data: Discovery.Types.ExportConfigurationsResponse) => void): Request; + /** + * Retrieves a short summary of discovered assets. This API operation takes no request parameters and is called as is at the command prompt as shown in the example. + */ + getDiscoverySummary(params: Discovery.Types.GetDiscoverySummaryRequest, callback?: (err: AWSError, data: Discovery.Types.GetDiscoverySummaryResponse) => void): Request; + /** + * Retrieves a short summary of discovered assets. This API operation takes no request parameters and is called as is at the command prompt as shown in the example. + */ + getDiscoverySummary(callback?: (err: AWSError, data: Discovery.Types.GetDiscoverySummaryResponse) => void): Request; + /** + * Retrieves a list of configuration items as specified by the value passed to the required paramater configurationType. Optional filtering may be applied to refine search results. + */ + listConfigurations(params: Discovery.Types.ListConfigurationsRequest, callback?: (err: AWSError, data: Discovery.Types.ListConfigurationsResponse) => void): Request; + /** + * Retrieves a list of configuration items as specified by the value passed to the required paramater configurationType. Optional filtering may be applied to refine search results. + */ + listConfigurations(callback?: (err: AWSError, data: Discovery.Types.ListConfigurationsResponse) => void): Request; + /** + * Retrieves a list of servers that are one network hop away from a specified server. + */ + listServerNeighbors(params: Discovery.Types.ListServerNeighborsRequest, callback?: (err: AWSError, data: Discovery.Types.ListServerNeighborsResponse) => void): Request; + /** + * Retrieves a list of servers that are one network hop away from a specified server. + */ + listServerNeighbors(callback?: (err: AWSError, data: Discovery.Types.ListServerNeighborsResponse) => void): Request; + /** + * Start the continuous flow of agent's discovered data into Amazon Athena. + */ + startContinuousExport(params: Discovery.Types.StartContinuousExportRequest, callback?: (err: AWSError, data: Discovery.Types.StartContinuousExportResponse) => void): Request; + /** + * Start the continuous flow of agent's discovered data into Amazon Athena. + */ + startContinuousExport(callback?: (err: AWSError, data: Discovery.Types.StartContinuousExportResponse) => void): Request; + /** + * Instructs the specified agents or connectors to start collecting data. + */ + startDataCollectionByAgentIds(params: Discovery.Types.StartDataCollectionByAgentIdsRequest, callback?: (err: AWSError, data: Discovery.Types.StartDataCollectionByAgentIdsResponse) => void): Request; + /** + * Instructs the specified agents or connectors to start collecting data. + */ + startDataCollectionByAgentIds(callback?: (err: AWSError, data: Discovery.Types.StartDataCollectionByAgentIdsResponse) => void): Request; + /** + * Begins the export of discovered data to an S3 bucket. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports. If you do not include an agentIds filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day. + */ + startExportTask(params: Discovery.Types.StartExportTaskRequest, callback?: (err: AWSError, data: Discovery.Types.StartExportTaskResponse) => void): Request; + /** + * Begins the export of discovered data to an S3 bucket. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports. If you do not include an agentIds filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day. + */ + startExportTask(callback?: (err: AWSError, data: Discovery.Types.StartExportTaskResponse) => void): Request; + /** + * Starts an import task, which allows you to import details of your on-premises environment directly into AWS without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status. To start an import request, do this: Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv. Fill out the template with your server and application data. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format. Use the console or the StartImportTask command with the AWS CLI or one of the AWS SDKs to import the records from your file. For more information, including step-by-step procedures, see Migration Hub Import in the AWS Application Discovery Service User Guide. There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see AWS Application Discovery Service Limits in the AWS Application Discovery Service User Guide. + */ + startImportTask(params: Discovery.Types.StartImportTaskRequest, callback?: (err: AWSError, data: Discovery.Types.StartImportTaskResponse) => void): Request; + /** + * Starts an import task, which allows you to import details of your on-premises environment directly into AWS without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status. To start an import request, do this: Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv. Fill out the template with your server and application data. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format. Use the console or the StartImportTask command with the AWS CLI or one of the AWS SDKs to import the records from your file. For more information, including step-by-step procedures, see Migration Hub Import in the AWS Application Discovery Service User Guide. There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see AWS Application Discovery Service Limits in the AWS Application Discovery Service User Guide. + */ + startImportTask(callback?: (err: AWSError, data: Discovery.Types.StartImportTaskResponse) => void): Request; + /** + * Stop the continuous flow of agent's discovered data into Amazon Athena. + */ + stopContinuousExport(params: Discovery.Types.StopContinuousExportRequest, callback?: (err: AWSError, data: Discovery.Types.StopContinuousExportResponse) => void): Request; + /** + * Stop the continuous flow of agent's discovered data into Amazon Athena. + */ + stopContinuousExport(callback?: (err: AWSError, data: Discovery.Types.StopContinuousExportResponse) => void): Request; + /** + * Instructs the specified agents or connectors to stop collecting data. + */ + stopDataCollectionByAgentIds(params: Discovery.Types.StopDataCollectionByAgentIdsRequest, callback?: (err: AWSError, data: Discovery.Types.StopDataCollectionByAgentIdsResponse) => void): Request; + /** + * Instructs the specified agents or connectors to stop collecting data. + */ + stopDataCollectionByAgentIds(callback?: (err: AWSError, data: Discovery.Types.StopDataCollectionByAgentIdsResponse) => void): Request; + /** + * Updates metadata about an application. + */ + updateApplication(params: Discovery.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: Discovery.Types.UpdateApplicationResponse) => void): Request; + /** + * Updates metadata about an application. + */ + updateApplication(callback?: (err: AWSError, data: Discovery.Types.UpdateApplicationResponse) => void): Request; +} +declare namespace Discovery { + export interface AgentConfigurationStatus { + /** + * The agent/connector ID. + */ + agentId?: String; + /** + * Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command. + */ + operationSucceeded?: Boolean; + /** + * A description of the operation performed. + */ + description?: String; + } + export type AgentConfigurationStatusList = AgentConfigurationStatus[]; + export type AgentId = string; + export type AgentIds = AgentId[]; + export interface AgentInfo { + /** + * The agent or connector ID. + */ + agentId?: AgentId; + /** + * The name of the host where the agent or connector resides. The host can be a server or virtual machine. + */ + hostName?: String; + /** + * Network details about the host where the agent or connector resides. + */ + agentNetworkInfoList?: AgentNetworkInfoList; + /** + * The ID of the connector. + */ + connectorId?: String; + /** + * The agent or connector version. + */ + version?: String; + /** + * The health of the agent or connector. + */ + health?: AgentStatus; + /** + * Time since agent or connector health was reported. + */ + lastHealthPingTime?: String; + /** + * Status of the collection process for an agent or connector. + */ + collectionStatus?: String; + /** + * Type of agent. + */ + agentType?: String; + /** + * Agent's first registration timestamp in UTC. + */ + registeredTime?: String; + } + export interface AgentNetworkInfo { + /** + * The IP address for the host where the agent/connector resides. + */ + ipAddress?: String; + /** + * The MAC address for the host where the agent/connector resides. + */ + macAddress?: String; + } + export type AgentNetworkInfoList = AgentNetworkInfo[]; + export type AgentStatus = "HEALTHY"|"UNHEALTHY"|"RUNNING"|"UNKNOWN"|"BLACKLISTED"|"SHUTDOWN"|string; + export type AgentsInfo = AgentInfo[]; + export type ApplicationId = string; + export type ApplicationIdsList = ApplicationId[]; + export interface AssociateConfigurationItemsToApplicationRequest { + /** + * The configuration ID of an application with which items are to be associated. + */ + applicationConfigurationId: ApplicationId; + /** + * The ID of each configuration item to be associated with an application. + */ + configurationIds: ConfigurationIdList; + } + export interface AssociateConfigurationItemsToApplicationResponse { + } + export interface BatchDeleteImportDataError { + /** + * The unique import ID associated with the error that occurred. + */ + importTaskId?: ImportTaskIdentifier; + /** + * The type of error that occurred for a specific import task. + */ + errorCode?: BatchDeleteImportDataErrorCode; + /** + * The description of the error that occurred for a specific import task. + */ + errorDescription?: BatchDeleteImportDataErrorDescription; + } + export type BatchDeleteImportDataErrorCode = "NOT_FOUND"|"INTERNAL_SERVER_ERROR"|"OVER_LIMIT"|string; + export type BatchDeleteImportDataErrorDescription = string; + export type BatchDeleteImportDataErrorList = BatchDeleteImportDataError[]; + export interface BatchDeleteImportDataRequest { + /** + * The IDs for the import tasks that you want to delete. + */ + importTaskIds: ToDeleteIdentifierList; + } + export interface BatchDeleteImportDataResponse { + /** + * Error messages returned for each import task that you deleted as a response for this command. + */ + errors?: BatchDeleteImportDataErrorList; + } + export type Boolean = boolean; + export type BoxedInteger = number; + export type ClientRequestToken = string; + export type Condition = string; + export type Configuration = {[key: string]: String}; + export type ConfigurationId = string; + export type ConfigurationIdList = ConfigurationId[]; + export type ConfigurationItemType = "SERVER"|"PROCESS"|"CONNECTION"|"APPLICATION"|string; + export interface ConfigurationTag { + /** + * A type of IT asset to tag. + */ + configurationType?: ConfigurationItemType; + /** + * The configuration ID for the item to tag. You can specify a list of keys and values. + */ + configurationId?: ConfigurationId; + /** + * A type of tag on which to filter. For example, serverType. + */ + key?: TagKey; + /** + * A value on which to filter. For example key = serverType and value = web server. + */ + value?: TagValue; + /** + * The time the configuration tag was created in Coordinated Universal Time (UTC). + */ + timeOfCreation?: TimeStamp; + } + export type ConfigurationTagSet = ConfigurationTag[]; + export type Configurations = Configuration[]; + export type ConfigurationsDownloadUrl = string; + export type ConfigurationsExportId = string; + export interface ContinuousExportDescription { + /** + * The unique ID assigned to this export. + */ + exportId?: ConfigurationsExportId; + /** + * Describes the status of the export. Can be one of the following values: START_IN_PROGRESS - setting up resources to start continuous export. START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again. ACTIVE - data is being exported to the customer bucket. ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export. STOP_IN_PROGRESS - stopping the export. STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again. INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket. + */ + status?: ContinuousExportStatus; + /** + * Contains information about any errors that have occurred. This data type can have the following values: ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your AWS administrator for help. For more information, see Setting Up AWS Application Discovery Service in the Application Discovery Service User Guide. DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies in the Application Discovery Service User Guide. FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM User is missing one or more of the Kinesis data delivery streams. INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact AWS Support. S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of Amazon S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide. S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3. + */ + statusDetail?: StringMax255; + /** + * The name of the s3 bucket where the export data parquet files are stored. + */ + s3Bucket?: S3Bucket; + /** + * The timestamp representing when the continuous export was started. + */ + startTime?: TimeStamp; + /** + * The timestamp that represents when this continuous export was stopped. + */ + stopTime?: TimeStamp; + /** + * The type of data collector used to gather this data (currently only offered for AGENT). + */ + dataSource?: DataSource; + /** + * An object which describes how the data is stored. databaseName - the name of the Glue database used to store the schema. + */ + schemaStorageConfig?: SchemaStorageConfig; + } + export type ContinuousExportDescriptions = ContinuousExportDescription[]; + export type ContinuousExportIds = ConfigurationsExportId[]; + export type ContinuousExportStatus = "START_IN_PROGRESS"|"START_FAILED"|"ACTIVE"|"ERROR"|"STOP_IN_PROGRESS"|"STOP_FAILED"|"INACTIVE"|string; + export interface CreateApplicationRequest { + /** + * Name of the application to be created. + */ + name: String; + /** + * Description of the application to be created. + */ + description?: String; + } + export interface CreateApplicationResponse { + /** + * Configuration ID of an application to be created. + */ + configurationId?: String; + } + export interface CreateTagsRequest { + /** + * A list of configuration items that you want to tag. + */ + configurationIds: ConfigurationIdList; + /** + * Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example: {"key": "serverType", "value": "webServer"} + */ + tags: TagSet; + } + export interface CreateTagsResponse { + } + export interface CustomerAgentInfo { + /** + * Number of active discovery agents. + */ + activeAgents: Integer; + /** + * Number of healthy discovery agents + */ + healthyAgents: Integer; + /** + * Number of blacklisted discovery agents. + */ + blackListedAgents: Integer; + /** + * Number of discovery agents with status SHUTDOWN. + */ + shutdownAgents: Integer; + /** + * Number of unhealthy discovery agents. + */ + unhealthyAgents: Integer; + /** + * Total number of discovery agents. + */ + totalAgents: Integer; + /** + * Number of unknown discovery agents. + */ + unknownAgents: Integer; + } + export interface CustomerConnectorInfo { + /** + * Number of active discovery connectors. + */ + activeConnectors: Integer; + /** + * Number of healthy discovery connectors. + */ + healthyConnectors: Integer; + /** + * Number of blacklisted discovery connectors. + */ + blackListedConnectors: Integer; + /** + * Number of discovery connectors with status SHUTDOWN, + */ + shutdownConnectors: Integer; + /** + * Number of unhealthy discovery connectors. + */ + unhealthyConnectors: Integer; + /** + * Total number of discovery connectors. + */ + totalConnectors: Integer; + /** + * Number of unknown discovery connectors. + */ + unknownConnectors: Integer; + } + export type DataSource = "AGENT"|string; + export type DatabaseName = string; + export interface DeleteApplicationsRequest { + /** + * Configuration ID of an application to be deleted. + */ + configurationIds: ApplicationIdsList; + } + export interface DeleteApplicationsResponse { + } + export interface DeleteTagsRequest { + /** + * A list of configuration items with tags that you want to delete. + */ + configurationIds: ConfigurationIdList; + /** + * Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example: {"key": "serverType", "value": "webServer"} + */ + tags?: TagSet; + } + export interface DeleteTagsResponse { + } + export interface DescribeAgentsRequest { + /** + * The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account. + */ + agentIds?: AgentIds; + /** + * You can filter the request using various logical operators and a key-value format. For example: {"key": "collectionStatus", "value": "STARTED"} + */ + filters?: Filters; + /** + * The total number of agents/Connectors to return in a single page of output. The maximum value is 100. + */ + maxResults?: Integer; + /** + * Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10. + */ + nextToken?: NextToken; + } + export interface DescribeAgentsResponse { + /** + * Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector. + */ + agentsInfo?: AgentsInfo; + /** + * Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10. + */ + nextToken?: NextToken; + } + export type DescribeConfigurationsAttribute = {[key: string]: String}; + export type DescribeConfigurationsAttributes = DescribeConfigurationsAttribute[]; + export interface DescribeConfigurationsRequest { + /** + * One or more configuration IDs. + */ + configurationIds: ConfigurationIdList; + } + export interface DescribeConfigurationsResponse { + /** + * A key in the response map. The value is an array of data. + */ + configurations?: DescribeConfigurationsAttributes; + } + export type DescribeContinuousExportsMaxResults = number; + export interface DescribeContinuousExportsRequest { + /** + * The unique IDs assigned to the exports. + */ + exportIds?: ContinuousExportIds; + /** + * A number between 1 and 100 specifying the maximum number of continuous export descriptions returned. + */ + maxResults?: DescribeContinuousExportsMaxResults; + /** + * The token from the previous call to DescribeExportTasks. + */ + nextToken?: NextToken; + } + export interface DescribeContinuousExportsResponse { + /** + * A list of continuous export descriptions. + */ + descriptions?: ContinuousExportDescriptions; + /** + * The token from the previous call to DescribeExportTasks. + */ + nextToken?: NextToken; + } + export interface DescribeExportConfigurationsRequest { + /** + * A list of continuous export ids to search for. + */ + exportIds?: ExportIds; + /** + * A number between 1 and 100 specifying the maximum number of continuous export descriptions returned. + */ + maxResults?: Integer; + /** + * The token from the previous call to describe-export-tasks. + */ + nextToken?: NextToken; + } + export interface DescribeExportConfigurationsResponse { + /** + * + */ + exportsInfo?: ExportsInfo; + /** + * The token from the previous call to describe-export-tasks. + */ + nextToken?: NextToken; + } + export interface DescribeExportTasksRequest { + /** + * One or more unique identifiers used to query the status of an export request. + */ + exportIds?: ExportIds; + /** + * One or more filters. AgentId - ID of the agent whose collected data will be exported + */ + filters?: ExportFilters; + /** + * The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element. + */ + maxResults?: Integer; + /** + * The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export interface DescribeExportTasksResponse { + /** + * Contains one or more sets of export request details. When the status of a request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file. + */ + exportsInfo?: ExportsInfo; + /** + * The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export type DescribeImportTasksFilterList = ImportTaskFilter[]; + export type DescribeImportTasksMaxResults = number; + export interface DescribeImportTasksRequest { + /** + * An array of name-value pairs that you provide to filter the results for the DescribeImportTask request to a specific subset of results. Currently, wildcard values aren't supported for filters. + */ + filters?: DescribeImportTasksFilterList; + /** + * The maximum number of results that you want this request to return, up to 100. + */ + maxResults?: DescribeImportTasksMaxResults; + /** + * The token to request a specific page of results. + */ + nextToken?: NextToken; + } + export interface DescribeImportTasksResponse { + /** + * The token to request the next page of results. + */ + nextToken?: NextToken; + /** + * A returned array of import tasks that match any applied filters, up to the specified number of maximum results. + */ + tasks?: ImportTaskList; + } + export interface DescribeTagsRequest { + /** + * You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId. + */ + filters?: TagFilters; + /** + * The total number of items to return in a single page of output. The maximum value is 100. + */ + maxResults?: Integer; + /** + * A token to start the list. Use this token to get the next set of results. + */ + nextToken?: NextToken; + } + export interface DescribeTagsResponse { + /** + * Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item. + */ + tags?: ConfigurationTagSet; + /** + * The call returns a token. Use this token to get the next set of results. + */ + nextToken?: NextToken; + } + export interface DisassociateConfigurationItemsFromApplicationRequest { + /** + * Configuration ID of an application from which each item is disassociated. + */ + applicationConfigurationId: ApplicationId; + /** + * Configuration ID of each item to be disassociated from an application. + */ + configurationIds: ConfigurationIdList; + } + export interface DisassociateConfigurationItemsFromApplicationResponse { + } + export interface ExportConfigurationsResponse { + /** + * A unique identifier that you can use to query the export status. + */ + exportId?: ConfigurationsExportId; + } + export type ExportDataFormat = "CSV"|"GRAPHML"|string; + export type ExportDataFormats = ExportDataFormat[]; + export interface ExportFilter { + /** + * A single ExportFilter name. Supported filters: agentId. + */ + name: FilterName; + /** + * A single agentId for a Discovery Agent. An agentId can be found using the DescribeAgents action. Typically an ADS agentId is in the form o-0123456789abcdef0. + */ + values: FilterValues; + /** + * Supported condition: EQUALS + */ + condition: Condition; + } + export type ExportFilters = ExportFilter[]; + export type ExportIds = ConfigurationsExportId[]; + export interface ExportInfo { + /** + * A unique identifier used to query an export. + */ + exportId: ConfigurationsExportId; + /** + * The status of the data export job. + */ + exportStatus: ExportStatus; + /** + * A status message provided for API callers. + */ + statusMessage: ExportStatusMessage; + /** + * A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded. + */ + configurationsDownloadUrl?: ConfigurationsDownloadUrl; + /** + * The time that the data export was initiated. + */ + exportRequestTime: ExportRequestTime; + /** + * If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate. + */ + isTruncated?: Boolean; + /** + * The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo. + */ + requestedStartTime?: TimeStamp; + /** + * The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo. + */ + requestedEndTime?: TimeStamp; + } + export type ExportRequestTime = Date; + export type ExportStatus = "FAILED"|"SUCCEEDED"|"IN_PROGRESS"|string; + export type ExportStatusMessage = string; + export type ExportsInfo = ExportInfo[]; + export interface Filter { + /** + * The name of the filter. + */ + name: String; + /** + * A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value. + */ + values: FilterValues; + /** + * A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items. + */ + condition: Condition; + } + export type FilterName = string; + export type FilterValue = string; + export type FilterValues = FilterValue[]; + export type Filters = Filter[]; + export interface GetDiscoverySummaryRequest { + } + export interface GetDiscoverySummaryResponse { + /** + * The number of servers discovered. + */ + servers?: Long; + /** + * The number of applications discovered. + */ + applications?: Long; + /** + * The number of servers mapped to applications. + */ + serversMappedToApplications?: Long; + /** + * The number of servers mapped to tags. + */ + serversMappedtoTags?: Long; + /** + * Details about discovered agents, including agent status and health. + */ + agentSummary?: CustomerAgentInfo; + /** + * Details about discovered connectors, including connector status and health. + */ + connectorSummary?: CustomerConnectorInfo; + } + export type ImportStatus = "IMPORT_IN_PROGRESS"|"IMPORT_COMPLETE"|"IMPORT_COMPLETE_WITH_ERRORS"|"IMPORT_FAILED"|"IMPORT_FAILED_SERVER_LIMIT_EXCEEDED"|"IMPORT_FAILED_RECORD_LIMIT_EXCEEDED"|"DELETE_IN_PROGRESS"|"DELETE_COMPLETE"|"DELETE_FAILED"|"DELETE_FAILED_LIMIT_EXCEEDED"|"INTERNAL_ERROR"|string; + export interface ImportTask { + /** + * The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an AWS account. + */ + importTaskId?: ImportTaskIdentifier; + /** + * A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent. + */ + clientRequestToken?: ClientRequestToken; + /** + * A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task. + */ + name?: ImportTaskName; + /** + * The URL for your import file that you've uploaded to Amazon S3. + */ + importUrl?: ImportURL; + /** + * The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console. + */ + status?: ImportStatus; + /** + * The time that the import task request was made, presented in the Unix time stamp format. + */ + importRequestTime?: TimeStamp; + /** + * The time that the import task request finished, presented in the Unix time stamp format. + */ + importCompletionTime?: TimeStamp; + /** + * The time that the import task request was deleted, presented in the Unix time stamp format. + */ + importDeletedTime?: TimeStamp; + /** + * The total number of server records in the import file that were successfully imported. + */ + serverImportSuccess?: Integer; + /** + * The total number of server records in the import file that failed to be imported. + */ + serverImportFailure?: Integer; + /** + * The total number of application records in the import file that were successfully imported. + */ + applicationImportSuccess?: Integer; + /** + * The total number of application records in the import file that failed to be imported. + */ + applicationImportFailure?: Integer; + /** + * A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request. This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it. If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again. + */ + errorsAndFailedEntriesZip?: S3PresignedUrl; + } + export interface ImportTaskFilter { + /** + * The name, status, or import task ID for a specific import task. + */ + name?: ImportTaskFilterName; + /** + * An array of strings that you can provide to match against a specific name, status, or import task ID to filter the results for your import task queries. + */ + values?: ImportTaskFilterValueList; + } + export type ImportTaskFilterName = "IMPORT_TASK_ID"|"STATUS"|"NAME"|string; + export type ImportTaskFilterValue = string; + export type ImportTaskFilterValueList = ImportTaskFilterValue[]; + export type ImportTaskIdentifier = string; + export type ImportTaskList = ImportTask[]; + export type ImportTaskName = string; + export type ImportURL = string; + export type Integer = number; + export interface ListConfigurationsRequest { + /** + * A valid configuration identified by Application Discovery Service. + */ + configurationType: ConfigurationItemType; + /** + * You can filter the request using various logical operators and a key-value format. For example: {"key": "serverType", "value": "webServer"} For a complete list of filter options and guidance about using them with this action, see Querying Discovered Configuration Items. + */ + filters?: Filters; + /** + * The total number of items to return. The maximum value is 100. + */ + maxResults?: Integer; + /** + * Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10. + */ + nextToken?: NextToken; + /** + * Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action. + */ + orderBy?: OrderByList; + } + export interface ListConfigurationsResponse { + /** + * Returns configuration details, including the configuration ID, attribute names, and attribute values. + */ + configurations?: Configurations; + /** + * Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10. + */ + nextToken?: NextToken; + } + export interface ListServerNeighborsRequest { + /** + * Configuration ID of the server for which neighbors are being listed. + */ + configurationId: ConfigurationId; + /** + * Flag to indicate if port and protocol information is needed as part of the response. + */ + portInformationNeeded?: Boolean; + /** + * List of configuration IDs to test for one-hop-away. + */ + neighborConfigurationIds?: ConfigurationIdList; + /** + * Maximum number of results to return in a single page of output. + */ + maxResults?: Integer; + /** + * Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10. + */ + nextToken?: String; + } + export interface ListServerNeighborsResponse { + /** + * List of distinct servers that are one hop away from the given server. + */ + neighbors: NeighborDetailsList; + /** + * Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10. + */ + nextToken?: String; + /** + * Count of distinct servers that are one hop away from the given server. + */ + knownDependencyCount?: Long; + } + export type Long = number; + export interface NeighborConnectionDetail { + /** + * The ID of the server that opened the network connection. + */ + sourceServerId: ConfigurationId; + /** + * The ID of the server that accepted the network connection. + */ + destinationServerId: ConfigurationId; + /** + * The destination network port for the connection. + */ + destinationPort?: BoxedInteger; + /** + * The network protocol used for the connection. + */ + transportProtocol?: String; + /** + * The number of open network connections with the neighboring server. + */ + connectionsCount: Long; + } + export type NeighborDetailsList = NeighborConnectionDetail[]; + export type NextToken = string; + export interface OrderByElement { + /** + * The field on which to order. + */ + fieldName: String; + /** + * Ordering direction. + */ + sortOrder?: orderString; + } + export type OrderByList = OrderByElement[]; + export type S3Bucket = string; + export type S3PresignedUrl = string; + export type SchemaStorageConfig = {[key: string]: String}; + export interface StartContinuousExportRequest { + } + export interface StartContinuousExportResponse { + /** + * The unique ID assigned to this export. + */ + exportId?: ConfigurationsExportId; + /** + * The name of the s3 bucket where the export data parquet files are stored. + */ + s3Bucket?: S3Bucket; + /** + * The timestamp representing when the continuous export was started. + */ + startTime?: TimeStamp; + /** + * The type of data collector used to gather this data (currently only offered for AGENT). + */ + dataSource?: DataSource; + /** + * A dictionary which describes how the data is stored. databaseName - the name of the Glue database used to store the schema. + */ + schemaStorageConfig?: SchemaStorageConfig; + } + export interface StartDataCollectionByAgentIdsRequest { + /** + * The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field. + */ + agentIds: AgentIds; + } + export interface StartDataCollectionByAgentIdsResponse { + /** + * Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated. + */ + agentsConfigurationStatus?: AgentConfigurationStatusList; + } + export interface StartExportTaskRequest { + /** + * The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated. + */ + exportDataFormat?: ExportDataFormats; + /** + * If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents. + */ + filters?: ExportFilters; + /** + * The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent. + */ + startTime?: TimeStamp; + /** + * The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent. + */ + endTime?: TimeStamp; + } + export interface StartExportTaskResponse { + /** + * A unique identifier used to query the status of an export request. + */ + exportId?: ConfigurationsExportId; + } + export interface StartImportTaskRequest { + /** + * Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated. Sending more than one StartImportTask request with the same client request token will return information about the original import task with that client request token. + */ + clientRequestToken?: ClientRequestToken; + /** + * A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task. + */ + name: ImportTaskName; + /** + * The URL for your import file that you've uploaded to Amazon S3. If you're using the AWS CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV + */ + importUrl: ImportURL; + } + export interface StartImportTaskResponse { + /** + * An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more. + */ + task?: ImportTask; + } + export interface StopContinuousExportRequest { + /** + * The unique ID assigned to this export. + */ + exportId: ConfigurationsExportId; + } + export interface StopContinuousExportResponse { + /** + * Timestamp that represents when this continuous export started collecting data. + */ + startTime?: TimeStamp; + /** + * Timestamp that represents when this continuous export was stopped. + */ + stopTime?: TimeStamp; + } + export interface StopDataCollectionByAgentIdsRequest { + /** + * The IDs of the agents or connectors from which to stop collecting data. + */ + agentIds: AgentIds; + } + export interface StopDataCollectionByAgentIdsResponse { + /** + * Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated. + */ + agentsConfigurationStatus?: AgentConfigurationStatusList; + } + export type String = string; + export type StringMax255 = string; + export interface Tag { + /** + * The type of tag on which to filter. + */ + key: TagKey; + /** + * A value for a tag key on which to filter. + */ + value: TagValue; + } + export interface TagFilter { + /** + * A name of the tag filter. + */ + name: FilterName; + /** + * Values for the tag filter. + */ + values: FilterValues; + } + export type TagFilters = TagFilter[]; + export type TagKey = string; + export type TagSet = Tag[]; + export type TagValue = string; + export type TimeStamp = Date; + export type ToDeleteIdentifierList = ImportTaskIdentifier[]; + export interface UpdateApplicationRequest { + /** + * Configuration ID of the application to be updated. + */ + configurationId: ApplicationId; + /** + * New name of the application to be updated. + */ + name?: String; + /** + * New description of the application to be updated. + */ + description?: String; + } + export interface UpdateApplicationResponse { + } + export type orderString = "ASC"|"DESC"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-11-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Discovery client. + */ + export import Types = Discovery; +} +export = Discovery; diff --git a/node_modules/aws-sdk/clients/discovery.js b/node_modules/aws-sdk/clients/discovery.js new file mode 100644 index 0000000..92fa4ea --- /dev/null +++ b/node_modules/aws-sdk/clients/discovery.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['discovery'] = {}; +AWS.Discovery = Service.defineService('discovery', ['2015-11-01']); +Object.defineProperty(apiLoader.services['discovery'], '2015-11-01', { + get: function get() { + var model = require('../apis/discovery-2015-11-01.min.json'); + model.paginators = require('../apis/discovery-2015-11-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Discovery; diff --git a/node_modules/aws-sdk/clients/dlm.d.ts b/node_modules/aws-sdk/clients/dlm.d.ts new file mode 100644 index 0000000..153fa68 --- /dev/null +++ b/node_modules/aws-sdk/clients/dlm.d.ts @@ -0,0 +1,299 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DLM extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DLM.Types.ClientConfiguration) + config: Config & DLM.Types.ClientConfiguration; + /** + * Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies. + */ + createLifecyclePolicy(params: DLM.Types.CreateLifecyclePolicyRequest, callback?: (err: AWSError, data: DLM.Types.CreateLifecyclePolicyResponse) => void): Request; + /** + * Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies. + */ + createLifecyclePolicy(callback?: (err: AWSError, data: DLM.Types.CreateLifecyclePolicyResponse) => void): Request; + /** + * Deletes the specified lifecycle policy and halts the automated operations that the policy specified. + */ + deleteLifecyclePolicy(params: DLM.Types.DeleteLifecyclePolicyRequest, callback?: (err: AWSError, data: DLM.Types.DeleteLifecyclePolicyResponse) => void): Request; + /** + * Deletes the specified lifecycle policy and halts the automated operations that the policy specified. + */ + deleteLifecyclePolicy(callback?: (err: AWSError, data: DLM.Types.DeleteLifecyclePolicyResponse) => void): Request; + /** + * Gets summary information about all or the specified data lifecycle policies. To get complete information about a policy, use GetLifecyclePolicy. + */ + getLifecyclePolicies(params: DLM.Types.GetLifecyclePoliciesRequest, callback?: (err: AWSError, data: DLM.Types.GetLifecyclePoliciesResponse) => void): Request; + /** + * Gets summary information about all or the specified data lifecycle policies. To get complete information about a policy, use GetLifecyclePolicy. + */ + getLifecyclePolicies(callback?: (err: AWSError, data: DLM.Types.GetLifecyclePoliciesResponse) => void): Request; + /** + * Gets detailed information about the specified lifecycle policy. + */ + getLifecyclePolicy(params: DLM.Types.GetLifecyclePolicyRequest, callback?: (err: AWSError, data: DLM.Types.GetLifecyclePolicyResponse) => void): Request; + /** + * Gets detailed information about the specified lifecycle policy. + */ + getLifecyclePolicy(callback?: (err: AWSError, data: DLM.Types.GetLifecyclePolicyResponse) => void): Request; + /** + * Updates the specified lifecycle policy. + */ + updateLifecyclePolicy(params: DLM.Types.UpdateLifecyclePolicyRequest, callback?: (err: AWSError, data: DLM.Types.UpdateLifecyclePolicyResponse) => void): Request; + /** + * Updates the specified lifecycle policy. + */ + updateLifecyclePolicy(callback?: (err: AWSError, data: DLM.Types.UpdateLifecyclePolicyResponse) => void): Request; +} +declare namespace DLM { + export type CopyTags = boolean; + export type Count = number; + export interface CreateLifecyclePolicyRequest { + /** + * The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. + */ + ExecutionRoleArn: ExecutionRoleArn; + /** + * A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported. + */ + Description: PolicyDescription; + /** + * The desired activation state of the lifecycle policy after creation. + */ + State: SettablePolicyStateValues; + /** + * The configuration details of the lifecycle policy. Target tags cannot be re-used across lifecycle policies. + */ + PolicyDetails: PolicyDetails; + } + export interface CreateLifecyclePolicyResponse { + /** + * The identifier of the lifecycle policy. + */ + PolicyId?: PolicyId; + } + export interface CreateRule { + /** + * The interval. The supported values are 12 and 24. + */ + Interval: Interval; + /** + * The interval unit. + */ + IntervalUnit: IntervalUnitValues; + /** + * The time, in UTC, to start the operation. The operation occurs within a one-hour window following the specified time. + */ + Times?: TimesList; + } + export interface DeleteLifecyclePolicyRequest { + /** + * The identifier of the lifecycle policy. + */ + PolicyId: PolicyId; + } + export interface DeleteLifecyclePolicyResponse { + } + export type ExecutionRoleArn = string; + export interface GetLifecyclePoliciesRequest { + /** + * The identifiers of the data lifecycle policies. + */ + PolicyIds?: PolicyIdList; + /** + * The activation state. + */ + State?: GettablePolicyStateValues; + /** + * The resource type. + */ + ResourceTypes?: ResourceTypeValuesList; + /** + * The target tag for a policy. Tags are strings in the format key=value. + */ + TargetTags?: TargetTagsFilterList; + /** + * The tags to add to objects created by the policy. Tags are strings in the format key=value. These user-defined tags are added in addition to the AWS-added lifecycle tags. + */ + TagsToAdd?: TagsToAddFilterList; + } + export interface GetLifecyclePoliciesResponse { + /** + * Summary information about the lifecycle policies. + */ + Policies?: LifecyclePolicySummaryList; + } + export interface GetLifecyclePolicyRequest { + /** + * The identifier of the lifecycle policy. + */ + PolicyId: PolicyId; + } + export interface GetLifecyclePolicyResponse { + /** + * Detailed information about the lifecycle policy. + */ + Policy?: LifecyclePolicy; + } + export type GettablePolicyStateValues = "ENABLED"|"DISABLED"|"ERROR"|string; + export type Interval = number; + export type IntervalUnitValues = "HOURS"|string; + export interface LifecyclePolicy { + /** + * The identifier of the lifecycle policy. + */ + PolicyId?: PolicyId; + /** + * The description of the lifecycle policy. + */ + Description?: PolicyDescription; + /** + * The activation state of the lifecycle policy. + */ + State?: GettablePolicyStateValues; + /** + * The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. + */ + ExecutionRoleArn?: ExecutionRoleArn; + /** + * The local date and time when the lifecycle policy was created. + */ + DateCreated?: Timestamp; + /** + * The local date and time when the lifecycle policy was last modified. + */ + DateModified?: Timestamp; + /** + * The configuration of the lifecycle policy + */ + PolicyDetails?: PolicyDetails; + } + export interface LifecyclePolicySummary { + /** + * The identifier of the lifecycle policy. + */ + PolicyId?: PolicyId; + /** + * The description of the lifecycle policy. + */ + Description?: PolicyDescription; + /** + * The activation state of the lifecycle policy. + */ + State?: GettablePolicyStateValues; + } + export type LifecyclePolicySummaryList = LifecyclePolicySummary[]; + export type PolicyDescription = string; + export interface PolicyDetails { + /** + * The resource type. + */ + ResourceTypes?: ResourceTypeValuesList; + /** + * The single tag that identifies targeted resources for this policy. + */ + TargetTags?: TargetTagList; + /** + * The schedule of policy-defined actions. + */ + Schedules?: ScheduleList; + } + export type PolicyId = string; + export type PolicyIdList = PolicyId[]; + export type ResourceTypeValues = "VOLUME"|string; + export type ResourceTypeValuesList = ResourceTypeValues[]; + export interface RetainRule { + /** + * The number of snapshots to keep for each volume, up to a maximum of 1000. + */ + Count: Count; + } + export interface Schedule { + /** + * The name of the schedule. + */ + Name?: ScheduleName; + CopyTags?: CopyTags; + /** + * The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags. + */ + TagsToAdd?: TagsToAddList; + /** + * The create rule. + */ + CreateRule?: CreateRule; + /** + * The retain rule. + */ + RetainRule?: RetainRule; + } + export type ScheduleList = Schedule[]; + export type ScheduleName = string; + export type SettablePolicyStateValues = "ENABLED"|"DISABLED"|string; + export type String = string; + export interface Tag { + /** + * The tag key. + */ + Key: String; + /** + * The tag value. + */ + Value: String; + } + export type TagFilter = string; + export type TagsToAddFilterList = TagFilter[]; + export type TagsToAddList = Tag[]; + export type TargetTagList = Tag[]; + export type TargetTagsFilterList = TagFilter[]; + export type Time = string; + export type TimesList = Time[]; + export type Timestamp = Date; + export interface UpdateLifecyclePolicyRequest { + /** + * The identifier of the lifecycle policy. + */ + PolicyId: PolicyId; + /** + * The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. + */ + ExecutionRoleArn?: ExecutionRoleArn; + /** + * The desired activation state of the lifecycle policy after creation. + */ + State?: SettablePolicyStateValues; + /** + * A description of the lifecycle policy. + */ + Description?: PolicyDescription; + /** + * The configuration of the lifecycle policy. Target tags cannot be re-used across policies. + */ + PolicyDetails?: PolicyDetails; + } + export interface UpdateLifecyclePolicyResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-01-12"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DLM client. + */ + export import Types = DLM; +} +export = DLM; diff --git a/node_modules/aws-sdk/clients/dlm.js b/node_modules/aws-sdk/clients/dlm.js new file mode 100644 index 0000000..0c588f3 --- /dev/null +++ b/node_modules/aws-sdk/clients/dlm.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['dlm'] = {}; +AWS.DLM = Service.defineService('dlm', ['2018-01-12']); +Object.defineProperty(apiLoader.services['dlm'], '2018-01-12', { + get: function get() { + var model = require('../apis/dlm-2018-01-12.min.json'); + model.paginators = require('../apis/dlm-2018-01-12.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DLM; diff --git a/node_modules/aws-sdk/clients/dms.d.ts b/node_modules/aws-sdk/clients/dms.d.ts new file mode 100644 index 0000000..32e8243 --- /dev/null +++ b/node_modules/aws-sdk/clients/dms.d.ts @@ -0,0 +1,2762 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DMS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DMS.Types.ClientConfiguration) + config: Config & DMS.Types.ClientConfiguration; + /** + * 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. + */ + addTagsToResource(params: DMS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request; + /** + * 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. + */ + addTagsToResource(callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request; + /** + * Applies a pending maintenance action to a resource (for example, to a replication instance). + */ + applyPendingMaintenanceAction(params: DMS.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: DMS.Types.ApplyPendingMaintenanceActionResponse) => void): Request; + /** + * Applies a pending maintenance action to a resource (for example, to a replication instance). + */ + applyPendingMaintenanceAction(callback?: (err: AWSError, data: DMS.Types.ApplyPendingMaintenanceActionResponse) => void): Request; + /** + * Creates an endpoint using the provided settings. + */ + createEndpoint(params: DMS.Types.CreateEndpointMessage, callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request; + /** + * Creates an endpoint using the provided settings. + */ + createEndpoint(callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request; + /** + * Creates an AWS DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account. For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide. + */ + createEventSubscription(params: DMS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request; + /** + * Creates an AWS DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account. For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide. + */ + createEventSubscription(callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request; + /** + * Creates the replication instance using the specified parameters. + */ + createReplicationInstance(params: DMS.Types.CreateReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request; + /** + * Creates the replication instance using the specified parameters. + */ + createReplicationInstance(callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request; + /** + * Creates a replication subnet group given a list of the subnet IDs in a VPC. + */ + createReplicationSubnetGroup(params: DMS.Types.CreateReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request; + /** + * Creates a replication subnet group given a list of the subnet IDs in a VPC. + */ + createReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request; + /** + * Creates a replication task using the specified parameters. + */ + createReplicationTask(params: DMS.Types.CreateReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request; + /** + * Creates a replication task using the specified parameters. + */ + createReplicationTask(callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request; + /** + * Deletes the specified certificate. + */ + deleteCertificate(params: DMS.Types.DeleteCertificateMessage, callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request; + /** + * Deletes the specified certificate. + */ + deleteCertificate(callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request; + /** + * Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint. + */ + deleteEndpoint(params: DMS.Types.DeleteEndpointMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request; + /** + * Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint. + */ + deleteEndpoint(callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request; + /** + * Deletes an AWS DMS event subscription. + */ + deleteEventSubscription(params: DMS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request; + /** + * Deletes an AWS DMS event subscription. + */ + deleteEventSubscription(callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request; + /** + * Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it. + */ + deleteReplicationInstance(params: DMS.Types.DeleteReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request; + /** + * Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it. + */ + deleteReplicationInstance(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request; + /** + * Deletes a subnet group. + */ + deleteReplicationSubnetGroup(params: DMS.Types.DeleteReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request; + /** + * Deletes a subnet group. + */ + deleteReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request; + /** + * Deletes the specified replication task. + */ + deleteReplicationTask(params: DMS.Types.DeleteReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request; + /** + * Deletes the specified replication task. + */ + deleteReplicationTask(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request; + /** + * Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command does not take any parameters. + */ + describeAccountAttributes(params: DMS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request; + /** + * Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command does not take any parameters. + */ + describeAccountAttributes(callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request; + /** + * Provides a description of the certificate. + */ + describeCertificates(params: DMS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request; + /** + * Provides a description of the certificate. + */ + describeCertificates(callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request; + /** + * Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint. + */ + describeConnections(params: DMS.Types.DescribeConnectionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request; + /** + * Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint. + */ + describeConnections(callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request; + /** + * Returns information about the type of endpoints available. + */ + describeEndpointTypes(params: DMS.Types.DescribeEndpointTypesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request; + /** + * Returns information about the type of endpoints available. + */ + describeEndpointTypes(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request; + /** + * Returns information about the endpoints for your account in the current region. + */ + describeEndpoints(params: DMS.Types.DescribeEndpointsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request; + /** + * Returns information about the endpoints for your account in the current region. + */ + describeEndpoints(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request; + /** + * Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide. + */ + describeEventCategories(params: DMS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request; + /** + * Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide. + */ + describeEventCategories(callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request; + /** + * Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify SubscriptionName, this action lists the description for that subscription. + */ + describeEventSubscriptions(params: DMS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventSubscriptionsResponse) => void): Request; + /** + * Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify SubscriptionName, this action lists the description for that subscription. + */ + describeEventSubscriptions(callback?: (err: AWSError, data: DMS.Types.DescribeEventSubscriptionsResponse) => void): Request; + /** + * Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide. + */ + describeEvents(params: DMS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request; + /** + * Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide. + */ + describeEvents(callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request; + /** + * Returns information about the replication instance types that can be created in the specified region. + */ + describeOrderableReplicationInstances(params: DMS.Types.DescribeOrderableReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request; + /** + * Returns information about the replication instance types that can be created in the specified region. + */ + describeOrderableReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request; + /** + * For internal use only + */ + describePendingMaintenanceActions(params: DMS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribePendingMaintenanceActionsResponse) => void): Request; + /** + * For internal use only + */ + describePendingMaintenanceActions(callback?: (err: AWSError, data: DMS.Types.DescribePendingMaintenanceActionsResponse) => void): Request; + /** + * Returns the status of the RefreshSchemas operation. + */ + describeRefreshSchemasStatus(params: DMS.Types.DescribeRefreshSchemasStatusMessage, callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request; + /** + * Returns the status of the RefreshSchemas operation. + */ + describeRefreshSchemasStatus(callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request; + /** + * Returns information about the task logs for the specified task. + */ + describeReplicationInstanceTaskLogs(params: DMS.Types.DescribeReplicationInstanceTaskLogsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstanceTaskLogsResponse) => void): Request; + /** + * Returns information about the task logs for the specified task. + */ + describeReplicationInstanceTaskLogs(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstanceTaskLogsResponse) => void): Request; + /** + * Returns information about replication instances for your account in the current region. + */ + describeReplicationInstances(params: DMS.Types.DescribeReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request; + /** + * Returns information about replication instances for your account in the current region. + */ + describeReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request; + /** + * Returns information about the replication subnet groups. + */ + describeReplicationSubnetGroups(params: DMS.Types.DescribeReplicationSubnetGroupsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request; + /** + * Returns information about the replication subnet groups. + */ + describeReplicationSubnetGroups(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request; + /** + * Returns the task assessment results from Amazon S3. This action always returns the latest results. + */ + describeReplicationTaskAssessmentResults(params: DMS.Types.DescribeReplicationTaskAssessmentResultsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request; + /** + * Returns the task assessment results from Amazon S3. This action always returns the latest results. + */ + describeReplicationTaskAssessmentResults(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request; + /** + * Returns information about replication tasks for your account in the current region. + */ + describeReplicationTasks(params: DMS.Types.DescribeReplicationTasksMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Returns information about replication tasks for your account in the current region. + */ + describeReplicationTasks(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Returns information about the schema for the specified endpoint. + */ + describeSchemas(params: DMS.Types.DescribeSchemasMessage, callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request; + /** + * Returns information about the schema for the specified endpoint. + */ + describeSchemas(callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request; + /** + * Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table. + */ + describeTableStatistics(params: DMS.Types.DescribeTableStatisticsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request; + /** + * Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table. + */ + describeTableStatistics(callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request; + /** + * Uploads the specified certificate. + */ + importCertificate(params: DMS.Types.ImportCertificateMessage, callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request; + /** + * Uploads the specified certificate. + */ + importCertificate(callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request; + /** + * Lists all tags for an AWS DMS resource. + */ + listTagsForResource(params: DMS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists all tags for an AWS DMS resource. + */ + listTagsForResource(callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request; + /** + * Modifies the specified endpoint. + */ + modifyEndpoint(params: DMS.Types.ModifyEndpointMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request; + /** + * Modifies the specified endpoint. + */ + modifyEndpoint(callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request; + /** + * Modifies an existing AWS DMS event notification subscription. + */ + modifyEventSubscription(params: DMS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request; + /** + * Modifies an existing AWS DMS event notification subscription. + */ + modifyEventSubscription(callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request; + /** + * Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window. + */ + modifyReplicationInstance(params: DMS.Types.ModifyReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request; + /** + * Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window. + */ + modifyReplicationInstance(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request; + /** + * Modifies the settings for the specified replication subnet group. + */ + modifyReplicationSubnetGroup(params: DMS.Types.ModifyReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request; + /** + * Modifies the settings for the specified replication subnet group. + */ + modifyReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request; + /** + * Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide. + */ + modifyReplicationTask(params: DMS.Types.ModifyReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request; + /** + * Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide. + */ + modifyReplicationTask(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request; + /** + * Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again. + */ + rebootReplicationInstance(params: DMS.Types.RebootReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.RebootReplicationInstanceResponse) => void): Request; + /** + * Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again. + */ + rebootReplicationInstance(callback?: (err: AWSError, data: DMS.Types.RebootReplicationInstanceResponse) => void): Request; + /** + * Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation. + */ + refreshSchemas(params: DMS.Types.RefreshSchemasMessage, callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request; + /** + * Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation. + */ + refreshSchemas(callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request; + /** + * Reloads the target database table with the source data. + */ + reloadTables(params: DMS.Types.ReloadTablesMessage, callback?: (err: AWSError, data: DMS.Types.ReloadTablesResponse) => void): Request; + /** + * Reloads the target database table with the source data. + */ + reloadTables(callback?: (err: AWSError, data: DMS.Types.ReloadTablesResponse) => void): Request; + /** + * Removes metadata tags from a DMS resource. + */ + removeTagsFromResource(params: DMS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request; + /** + * Removes metadata tags from a DMS resource. + */ + removeTagsFromResource(callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request; + /** + * Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide. + */ + startReplicationTask(params: DMS.Types.StartReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request; + /** + * Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide. + */ + startReplicationTask(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request; + /** + * Starts the replication task assessment for unsupported data types in the source database. + */ + startReplicationTaskAssessment(params: DMS.Types.StartReplicationTaskAssessmentMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentResponse) => void): Request; + /** + * Starts the replication task assessment for unsupported data types in the source database. + */ + startReplicationTaskAssessment(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentResponse) => void): Request; + /** + * Stops the replication task. + */ + stopReplicationTask(params: DMS.Types.StopReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request; + /** + * Stops the replication task. + */ + stopReplicationTask(callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request; + /** + * Tests the connection between the replication instance and the endpoint. + */ + testConnection(params: DMS.Types.TestConnectionMessage, callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request; + /** + * Tests the connection between the replication instance and the endpoint. + */ + testConnection(callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request; + /** + * Waits for the testConnectionSucceeds state by periodically calling the underlying DMS.describeConnectionsoperation every 5 seconds (at most 60 times). Wait until testing connection succeeds. + */ + waitFor(state: "testConnectionSucceeds", params: DMS.Types.DescribeConnectionsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request; + /** + * Waits for the testConnectionSucceeds state by periodically calling the underlying DMS.describeConnectionsoperation every 5 seconds (at most 60 times). Wait until testing connection succeeds. + */ + waitFor(state: "testConnectionSucceeds", callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request; + /** + * Waits for the endpointDeleted state by periodically calling the underlying DMS.describeEndpointsoperation every 5 seconds (at most 60 times). Wait until testing endpoint is deleted. + */ + waitFor(state: "endpointDeleted", params: DMS.Types.DescribeEndpointsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request; + /** + * Waits for the endpointDeleted state by periodically calling the underlying DMS.describeEndpointsoperation every 5 seconds (at most 60 times). Wait until testing endpoint is deleted. + */ + waitFor(state: "endpointDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request; + /** + * Waits for the replicationInstanceAvailable state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 60 seconds (at most 60 times). Wait until DMS replication instance is available. + */ + waitFor(state: "replicationInstanceAvailable", params: DMS.Types.DescribeReplicationInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request; + /** + * Waits for the replicationInstanceAvailable state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 60 seconds (at most 60 times). Wait until DMS replication instance is available. + */ + waitFor(state: "replicationInstanceAvailable", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request; + /** + * Waits for the replicationInstanceDeleted state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 15 seconds (at most 60 times). Wait until DMS replication instance is deleted. + */ + waitFor(state: "replicationInstanceDeleted", params: DMS.Types.DescribeReplicationInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request; + /** + * Waits for the replicationInstanceDeleted state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 15 seconds (at most 60 times). Wait until DMS replication instance is deleted. + */ + waitFor(state: "replicationInstanceDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request; + /** + * Waits for the replicationTaskReady state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is ready. + */ + waitFor(state: "replicationTaskReady", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Waits for the replicationTaskReady state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is ready. + */ + waitFor(state: "replicationTaskReady", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Waits for the replicationTaskStopped state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is stopped. + */ + waitFor(state: "replicationTaskStopped", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Waits for the replicationTaskStopped state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is stopped. + */ + waitFor(state: "replicationTaskStopped", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Waits for the replicationTaskRunning state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is running. + */ + waitFor(state: "replicationTaskRunning", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Waits for the replicationTaskRunning state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is running. + */ + waitFor(state: "replicationTaskRunning", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Waits for the replicationTaskDeleted state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is deleted. + */ + waitFor(state: "replicationTaskDeleted", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; + /** + * Waits for the replicationTaskDeleted state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is deleted. + */ + waitFor(state: "replicationTaskDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request; +} +declare namespace DMS { + export interface AccountQuota { + /** + * The name of the AWS DMS quota for this AWS account. + */ + AccountQuotaName?: String; + /** + * The amount currently used toward the quota maximum. + */ + Used?: Long; + /** + * The maximum allowed value for the quota. + */ + Max?: Long; + } + export type AccountQuotaList = AccountQuota[]; + export interface AddTagsToResourceMessage { + /** + * The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be added to. AWS DMS resources include a replication instance, endpoint, and a replication task. + */ + ResourceArn: String; + /** + * The tag to be assigned to the DMS resource. + */ + Tags: TagList; + } + export interface AddTagsToResourceResponse { + } + export interface ApplyPendingMaintenanceActionMessage { + /** + * The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance action applies to. + */ + ReplicationInstanceArn: String; + /** + * The pending maintenance action to apply to this resource. + */ + ApplyAction: String; + /** + * A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests. + */ + OptInType: String; + } + export interface ApplyPendingMaintenanceActionResponse { + /** + * The AWS DMS resource that the pending maintenance action will be applied to. + */ + ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions; + } + export type AuthMechanismValue = "default"|"mongodb_cr"|"scram_sha_1"|string; + export type AuthTypeValue = "no"|"password"|string; + export interface AvailabilityZone { + /** + * The name of the availability zone. + */ + Name?: String; + } + export type AvailabilityZonesList = String[]; + export type Boolean = boolean; + export type BooleanOptional = boolean; + export interface Certificate { + /** + * The customer-assigned name of the certificate. Valid characters are A-z and 0-9. + */ + CertificateIdentifier?: String; + /** + * The date that the certificate was created. + */ + CertificateCreationDate?: TStamp; + /** + * The contents of the .pem X.509 certificate file for the certificate. + */ + CertificatePem?: String; + /** + * The location of the imported Oracle Wallet certificate for use with SSL. + */ + CertificateWallet?: CertificateWallet; + /** + * The Amazon Resource Name (ARN) for the certificate. + */ + CertificateArn?: String; + /** + * The owner of the certificate. + */ + CertificateOwner?: String; + /** + * The beginning date that the certificate is valid. + */ + ValidFromDate?: TStamp; + /** + * The final date that the certificate is valid. + */ + ValidToDate?: TStamp; + /** + * The signing algorithm for the certificate. + */ + SigningAlgorithm?: String; + /** + * The key length of the cryptographic algorithm being used. + */ + KeyLength?: IntegerOptional; + } + export type CertificateList = Certificate[]; + export type CertificateWallet = Buffer|Uint8Array|Blob|string; + export type CompressionTypeValue = "none"|"gzip"|string; + export interface Connection { + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn?: String; + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn?: String; + /** + * The connection status. + */ + Status?: String; + /** + * The error message when the connection last failed. + */ + LastFailureMessage?: String; + /** + * 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. + */ + EndpointIdentifier?: String; + /** + * The replication instance identifier. This parameter is stored as a lowercase string. + */ + ReplicationInstanceIdentifier?: String; + } + export type ConnectionList = Connection[]; + export interface CreateEndpointMessage { + /** + * 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. + */ + EndpointIdentifier: String; + /** + * The type of endpoint. + */ + EndpointType: ReplicationEndpointTypeValue; + /** + * The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver. + */ + EngineName: String; + /** + * The user name to be used to log in to the endpoint database. + */ + Username?: String; + /** + * The password to be used to log in to the endpoint database. + */ + Password?: SecretString; + /** + * The name of the server where the endpoint database resides. + */ + ServerName?: String; + /** + * The port used by the endpoint database. + */ + Port?: IntegerOptional; + /** + * The name of the endpoint database. + */ + DatabaseName?: String; + /** + * Additional attributes associated with the connection. + */ + ExtraConnectionAttributes?: String; + /** + * The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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. + */ + KmsKeyId?: String; + /** + * Tags to be added to the endpoint. + */ + Tags?: TagList; + /** + * The Amazon Resource Name (ARN) for the certificate. + */ + CertificateArn?: String; + /** + * The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none. + */ + SslMode?: DmsSslModeValue; + /** + * The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. + */ + ServiceAccessRoleArn?: String; + /** + * The external table definition. + */ + ExternalTableDefinition?: String; + /** + * Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide. + */ + DynamoDbSettings?: DynamoDbSettings; + /** + * Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide. + */ + S3Settings?: S3Settings; + /** + * The settings in JSON format for the DMS transfer type of source endpoint. Possible attributes include the following: serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. bucketName - The name of the S3 bucket to use. compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value. Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" } + */ + DmsTransferSettings?: DmsTransferSettings; + /** + * Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide. + */ + MongoDbSettings?: MongoDbSettings; + /** + * Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide. + */ + KinesisSettings?: KinesisSettings; + /** + * Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide. + */ + ElasticsearchSettings?: ElasticsearchSettings; + RedshiftSettings?: RedshiftSettings; + } + export interface CreateEndpointResponse { + /** + * The endpoint that was created. + */ + Endpoint?: Endpoint; + } + export interface CreateEventSubscriptionMessage { + /** + * The name of the AWS DMS event notification subscription. Constraints: The name must be less than 255 characters. + */ + SubscriptionName: String; + /** + * 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. + */ + SnsTopicArn: String; + /** + * 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 replication-instance. If this value is not specified, all events are returned. Valid values: replication-instance | migration-task + */ + SourceType?: String; + /** + * A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide. + */ + EventCategories?: EventCategoriesList; + /** + * The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. 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. + */ + SourceIds?: SourceIdsList; + /** + * A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it. + */ + Enabled?: BooleanOptional; + /** + * A tag to be attached to the event subscription. + */ + Tags?: TagList; + } + export interface CreateEventSubscriptionResponse { + /** + * The event subscription that was created. + */ + EventSubscription?: EventSubscription; + } + export interface CreateReplicationInstanceMessage { + /** + * The replication instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myrepinstance + */ + ReplicationInstanceIdentifier: String; + /** + * The amount of storage (in gigabytes) to be initially allocated for the replication instance. + */ + AllocatedStorage?: IntegerOptional; + /** + * The compute and memory capacity of the replication instance as specified by the replication instance class. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge + */ + ReplicationInstanceClass: String; + /** + * Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The EC2 Availability Zone that the replication instance will be created in. Default: A random, system-chosen Availability Zone in the endpoint's region. Example: us-east-1d + */ + AvailabilityZone?: String; + /** + * A subnet group to associate with the replication instance. + */ + ReplicationSubnetGroupIdentifier?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + */ + MultiAZ?: BooleanOptional; + /** + * The engine version number of the replication instance. + */ + EngineVersion?: String; + /** + * Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. Default: true + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * Tags to be associated with the replication instance. + */ + Tags?: TagList; + /** + * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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. + */ + KmsKeyId?: String; + /** + * Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true. + */ + PubliclyAccessible?: BooleanOptional; + /** + * A list of DNS name servers supported for the replication instance. + */ + DnsNameServers?: String; + } + export interface CreateReplicationInstanceResponse { + /** + * The replication instance that was created. + */ + ReplicationInstance?: ReplicationInstance; + } + export interface CreateReplicationSubnetGroupMessage { + /** + * The name for the replication subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default". Example: mySubnetgroup + */ + ReplicationSubnetGroupIdentifier: String; + /** + * The description for the subnet group. + */ + ReplicationSubnetGroupDescription: String; + /** + * The EC2 subnet IDs for the subnet group. + */ + SubnetIds: SubnetIdentifierList; + /** + * The tag to be assigned to the subnet group. + */ + Tags?: TagList; + } + export interface CreateReplicationSubnetGroupResponse { + /** + * The replication subnet group that was created. + */ + ReplicationSubnetGroup?: ReplicationSubnetGroup; + } + export interface CreateReplicationTaskMessage { + /** + * The replication task identifier. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + ReplicationTaskIdentifier: String; + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + SourceEndpointArn: String; + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + TargetEndpointArn: String; + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn: String; + /** + * The migration type. + */ + MigrationType: MigrationTypeValue; + /** + * 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. For example, --table-mappings file://mappingfile.json + */ + TableMappings: String; + /** + * Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide. + */ + ReplicationTaskSettings?: String; + /** + * 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. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12” + */ + CdcStartTime?: TStamp; + /** + * 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. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + */ + CdcStartPosition?: String; + /** + * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “ + */ + CdcStopPosition?: String; + /** + * Tags to be added to the replication instance. + */ + Tags?: TagList; + } + export interface CreateReplicationTaskResponse { + /** + * The replication task that was created. + */ + ReplicationTask?: ReplicationTask; + } + export type DataFormatValue = "csv"|"parquet"|string; + export interface DeleteCertificateMessage { + /** + * The Amazon Resource Name (ARN) of the deleted certificate. + */ + CertificateArn: String; + } + export interface DeleteCertificateResponse { + /** + * The Secure Sockets Layer (SSL) certificate. + */ + Certificate?: Certificate; + } + export interface DeleteEndpointMessage { + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn: String; + } + export interface DeleteEndpointResponse { + /** + * The endpoint that was deleted. + */ + Endpoint?: Endpoint; + } + export interface DeleteEventSubscriptionMessage { + /** + * The name of the DMS event notification subscription to be deleted. + */ + SubscriptionName: String; + } + export interface DeleteEventSubscriptionResponse { + /** + * The event subscription that was deleted. + */ + EventSubscription?: EventSubscription; + } + export interface DeleteReplicationInstanceMessage { + /** + * The Amazon Resource Name (ARN) of the replication instance to be deleted. + */ + ReplicationInstanceArn: String; + } + export interface DeleteReplicationInstanceResponse { + /** + * The replication instance that was deleted. + */ + ReplicationInstance?: ReplicationInstance; + } + export interface DeleteReplicationSubnetGroupMessage { + /** + * The subnet group name of the replication instance. + */ + ReplicationSubnetGroupIdentifier: String; + } + export interface DeleteReplicationSubnetGroupResponse { + } + export interface DeleteReplicationTaskMessage { + /** + * The Amazon Resource Name (ARN) of the replication task to be deleted. + */ + ReplicationTaskArn: String; + } + export interface DeleteReplicationTaskResponse { + /** + * The deleted replication task. + */ + ReplicationTask?: ReplicationTask; + } + export interface DescribeAccountAttributesMessage { + } + export interface DescribeAccountAttributesResponse { + /** + * Account quota information. + */ + AccountQuotas?: AccountQuotaList; + } + export interface DescribeCertificatesMessage { + /** + * Filters applied to the certificate described in the form of key-value pairs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 10 + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeCertificatesResponse { + /** + * The pagination token. + */ + Marker?: String; + /** + * The Secure Sockets Layer (SSL) certificates associated with the replication instance. + */ + Certificates?: CertificateList; + } + export interface DescribeConnectionsMessage { + /** + * The filters applied to the connection. Valid filter names: endpoint-arn | replication-instance-arn + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeConnectionsResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A description of the connections. + */ + Connections?: ConnectionList; + } + export interface DescribeEndpointTypesMessage { + /** + * Filters applied to the describe action. Valid filter names: engine-name | endpoint-type + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeEndpointTypesResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * The type of endpoints that are supported. + */ + SupportedEndpointTypes?: SupportedEndpointTypeList; + } + export interface DescribeEndpointsMessage { + /** + * Filters applied to the describe action. Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeEndpointsResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Endpoint description. + */ + Endpoints?: EndpointList; + } + export interface DescribeEventCategoriesMessage { + /** + * The type of AWS DMS resource that generates events. Valid values: replication-instance | migration-task + */ + SourceType?: String; + /** + * Filters applied to the action. + */ + Filters?: FilterList; + } + export interface DescribeEventCategoriesResponse { + /** + * A list of event categories. + */ + EventCategoryGroupList?: EventCategoryGroupList; + } + export interface DescribeEventSubscriptionsMessage { + /** + * The name of the AWS DMS event subscription to be described. + */ + SubscriptionName?: String; + /** + * Filters applied to the action. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeEventSubscriptionsResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of event subscriptions. + */ + EventSubscriptionsList?: EventSubscriptionsList; + } + export interface DescribeEventsMessage { + /** + * 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. + */ + SourceIdentifier?: String; + /** + * The type of AWS DMS resource that generates events. Valid values: replication-instance | migration-task + */ + SourceType?: SourceType; + /** + * The start time for the events to be listed. + */ + StartTime?: TStamp; + /** + * The end time for the events to be listed. + */ + EndTime?: TStamp; + /** + * The duration of the events to be listed. + */ + Duration?: IntegerOptional; + /** + * A list of event categories for a source type that you want to subscribe to. + */ + EventCategories?: EventCategoriesList; + /** + * Filters applied to the action. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeEventsResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * The events described. + */ + Events?: EventList; + } + export interface DescribeOrderableReplicationInstancesMessage { + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeOrderableReplicationInstancesResponse { + /** + * The order-able replication instances available. + */ + OrderableReplicationInstances?: OrderableReplicationInstanceList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribePendingMaintenanceActionsMessage { + /** + * The ARN of the replication instance. + */ + ReplicationInstanceArn?: String; + /** + * + */ + Filters?: FilterList; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + } + export interface DescribePendingMaintenanceActionsResponse { + /** + * The pending maintenance action. + */ + PendingMaintenanceActions?: PendingMaintenanceActions; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeRefreshSchemasStatusMessage { + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn: String; + } + export interface DescribeRefreshSchemasStatusResponse { + /** + * The status of the schema. + */ + RefreshSchemasStatus?: RefreshSchemasStatus; + } + export interface DescribeReplicationInstanceTaskLogsMessage { + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeReplicationInstanceTaskLogsResponse { + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn?: String; + /** + * An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes). + */ + ReplicationInstanceTaskLogs?: ReplicationInstanceTaskLogsList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeReplicationInstancesMessage { + /** + * Filters applied to the describe action. Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeReplicationInstancesResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * The replication instances described. + */ + ReplicationInstances?: ReplicationInstanceList; + } + export interface DescribeReplicationSubnetGroupsMessage { + /** + * Filters applied to the describe action. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeReplicationSubnetGroupsResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A description of the replication subnet groups. + */ + ReplicationSubnetGroups?: ReplicationSubnetGroups; + } + export interface DescribeReplicationTaskAssessmentResultsMessage { + /** + * - The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters. + */ + ReplicationTaskArn?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeReplicationTaskAssessmentResultsResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * - The Amazon S3 bucket where the task assessment report is located. + */ + BucketName?: String; + /** + * The task assessment report. + */ + ReplicationTaskAssessmentResults?: ReplicationTaskAssessmentResultList; + } + export interface DescribeReplicationTasksMessage { + /** + * Filters applied to the describe action. Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Set this flag to avoid returning setting information. Use this to reduce overhead when settings are too large. Choose TRUE to use this flag, otherwise choose FALSE (default). + */ + WithoutSettings?: BooleanOptional; + } + export interface DescribeReplicationTasksResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A description of the replication tasks. + */ + ReplicationTasks?: ReplicationTaskList; + } + export interface DescribeSchemasMessage { + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeSchemasResponse { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * The described schema. + */ + Schemas?: SchemaList; + } + export interface DescribeTableStatisticsMessage { + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 500. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Filters applied to the describe table statistics action. Valid filter names: schema-name | table-name | table-state A combination of filters creates an AND condition where each record matches all specified filters. + */ + Filters?: FilterList; + } + export interface DescribeTableStatisticsResponse { + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn?: String; + /** + * The table statistics. + */ + TableStatistics?: TableStatisticsList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export type DmsSslModeValue = "none"|"require"|"verify-ca"|"verify-full"|string; + export interface DmsTransferSettings { + /** + * The IAM role that has permission to access the Amazon S3 bucket. + */ + ServiceAccessRoleArn?: String; + /** + * The name of the S3 bucket to use. + */ + BucketName?: String; + } + export interface DynamoDbSettings { + /** + * The Amazon Resource Name (ARN) used by the service access IAM role. + */ + ServiceAccessRoleArn: String; + } + export interface ElasticsearchSettings { + /** + * The Amazon Resource Name (ARN) used by service to access the IAM role. + */ + ServiceAccessRoleArn: String; + /** + * The endpoint for the ElasticSearch cluster. + */ + EndpointUri: String; + /** + * The maximum percentage of records that can fail to be written before a full load operation stops. + */ + FullLoadErrorPercentage?: IntegerOptional; + /** + * The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster. + */ + ErrorRetryDuration?: IntegerOptional; + } + export type EncodingTypeValue = "plain"|"plain-dictionary"|"rle-dictionary"|string; + export type EncryptionModeValue = "sse-s3"|"sse-kms"|string; + export interface Endpoint { + /** + * 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. + */ + EndpointIdentifier?: String; + /** + * The type of endpoint. + */ + EndpointType?: ReplicationEndpointTypeValue; + /** + * 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. + */ + EngineName?: String; + /** + * The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL." + */ + EngineDisplayName?: String; + /** + * The user name used to connect to the endpoint. + */ + Username?: String; + /** + * The name of the server at the endpoint. + */ + ServerName?: String; + /** + * The port value used to access the endpoint. + */ + Port?: IntegerOptional; + /** + * The name of the database at the endpoint. + */ + DatabaseName?: String; + /** + * Additional connection attributes used to connect to the endpoint. + */ + ExtraConnectionAttributes?: String; + /** + * The status of the endpoint. + */ + Status?: String; + /** + * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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. + */ + KmsKeyId?: String; + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn?: String; + /** + * The Amazon Resource Name (ARN) used for SSL connection to the endpoint. + */ + CertificateArn?: String; + /** + * The SSL mode used to connect to the endpoint. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none. + */ + SslMode?: DmsSslModeValue; + /** + * The Amazon Resource Name (ARN) used by the service access IAM role. + */ + ServiceAccessRoleArn?: String; + /** + * The external table definition. + */ + ExternalTableDefinition?: String; + /** + * 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. + */ + ExternalId?: String; + /** + * The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure. + */ + DynamoDbSettings?: DynamoDbSettings; + /** + * The settings for the S3 target endpoint. For more information, see the S3Settings structure. + */ + S3Settings?: S3Settings; + /** + * The settings in JSON format for the DMS transfer type of source endpoint. Possible attributes include the following: serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. bucketName - The name of the S3 bucket to use. compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value. Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" } + */ + DmsTransferSettings?: DmsTransferSettings; + /** + * The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure. + */ + MongoDbSettings?: MongoDbSettings; + /** + * The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure. + */ + KinesisSettings?: KinesisSettings; + /** + * The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure. + */ + ElasticsearchSettings?: ElasticsearchSettings; + /** + * Settings for the Amazon Redshift endpoint + */ + RedshiftSettings?: RedshiftSettings; + } + export type EndpointList = Endpoint[]; + export interface Event { + /** + * 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. Constraints:replication instance, endpoint, migration task + */ + SourceIdentifier?: String; + /** + * The type of AWS DMS resource that generates events. Valid values: replication-instance | endpoint | migration-task + */ + SourceType?: SourceType; + /** + * The event message. + */ + Message?: String; + /** + * The event categories available for the specified source type. + */ + EventCategories?: EventCategoriesList; + /** + * The date of the event. + */ + Date?: TStamp; + } + export type EventCategoriesList = String[]; + export interface EventCategoryGroup { + /** + * The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | migration-task + */ + SourceType?: String; + /** + * A list of event categories for a SourceType that you want to subscribe to. + */ + EventCategories?: EventCategoriesList; + } + export type EventCategoryGroupList = EventCategoryGroup[]; + export type EventList = Event[]; + export interface EventSubscription { + /** + * The AWS customer account associated with the AWS DMS event notification subscription. + */ + CustomerAwsId?: String; + /** + * The AWS DMS event notification subscription Id. + */ + CustSubscriptionId?: String; + /** + * The topic ARN of the AWS DMS event notification subscription. + */ + SnsTopicArn?: String; + /** + * The status of the AWS DMS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. + */ + Status?: String; + /** + * The time the RDS event notification subscription was created. + */ + SubscriptionCreationTime?: String; + /** + * The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | migration-task + */ + SourceType?: String; + /** + * A list of source Ids for the event subscription. + */ + SourceIdsList?: SourceIdsList; + /** + * A lists of event categories. + */ + EventCategoriesList?: EventCategoriesList; + /** + * Boolean value that indicates if the event subscription is enabled. + */ + Enabled?: Boolean; + } + export type EventSubscriptionsList = EventSubscription[]; + export interface Filter { + /** + * The name of the filter. + */ + Name: String; + /** + * The filter value. + */ + Values: FilterValueList; + } + export type FilterList = Filter[]; + export type FilterValueList = String[]; + export interface ImportCertificateMessage { + /** + * The customer-assigned name of the certificate. Valid characters are A-z and 0-9. + */ + CertificateIdentifier: String; + /** + * The contents of the .pem X.509 certificate file for the certificate. + */ + CertificatePem?: String; + /** + * The location of the imported Oracle Wallet certificate for use with SSL. + */ + CertificateWallet?: CertificateWallet; + /** + * The tags associated with the certificate. + */ + Tags?: TagList; + } + export interface ImportCertificateResponse { + /** + * The certificate to be uploaded. + */ + Certificate?: Certificate; + } + export type Integer = number; + export type IntegerOptional = number; + export type KeyList = String[]; + export interface KinesisSettings { + /** + * The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint. + */ + StreamArn?: String; + /** + * The output format for the records created on the endpoint. The message format is JSON. + */ + MessageFormat?: MessageFormatValue; + /** + * The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream. + */ + ServiceAccessRoleArn?: String; + } + export interface ListTagsForResourceMessage { + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource. + */ + ResourceArn: String; + } + export interface ListTagsForResourceResponse { + /** + * A list of tags for the resource. + */ + TagList?: TagList; + } + export type Long = number; + export type MessageFormatValue = "json"|string; + export type MigrationTypeValue = "full-load"|"cdc"|"full-load-and-cdc"|string; + export interface ModifyEndpointMessage { + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn: String; + /** + * 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. + */ + EndpointIdentifier?: String; + /** + * The type of endpoint. + */ + EndpointType?: ReplicationEndpointTypeValue; + /** + * 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. + */ + EngineName?: String; + /** + * The user name to be used to login to the endpoint database. + */ + Username?: String; + /** + * The password to be used to login to the endpoint database. + */ + Password?: SecretString; + /** + * The name of the server where the endpoint database resides. + */ + ServerName?: String; + /** + * The port used by the endpoint database. + */ + Port?: IntegerOptional; + /** + * The name of the endpoint database. + */ + DatabaseName?: String; + /** + * Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument. + */ + ExtraConnectionAttributes?: String; + /** + * The Amazon Resource Name (ARN) of the certificate used for SSL connection. + */ + CertificateArn?: String; + /** + * The SSL mode to be used. SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none. + */ + SslMode?: DmsSslModeValue; + /** + * The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint. + */ + ServiceAccessRoleArn?: String; + /** + * The external table definition. + */ + ExternalTableDefinition?: String; + /** + * Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide. + */ + DynamoDbSettings?: DynamoDbSettings; + /** + * Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide. + */ + S3Settings?: S3Settings; + /** + * The settings in JSON format for the DMS transfer type of source endpoint. Attributes include the following: serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. BucketName - The name of the S3 bucket to use. compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string JSON syntax: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" } + */ + DmsTransferSettings?: DmsTransferSettings; + /** + * Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide. + */ + MongoDbSettings?: MongoDbSettings; + /** + * Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide. + */ + KinesisSettings?: KinesisSettings; + /** + * Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide. + */ + ElasticsearchSettings?: ElasticsearchSettings; + RedshiftSettings?: RedshiftSettings; + } + export interface ModifyEndpointResponse { + /** + * The modified endpoint. + */ + Endpoint?: Endpoint; + } + export interface ModifyEventSubscriptionMessage { + /** + * The name of the AWS DMS event notification subscription to be modified. + */ + SubscriptionName: String; + /** + * 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. + */ + SnsTopicArn?: String; + /** + * The type of AWS DMS resource that generates the events you want to subscribe to. Valid values: replication-instance | migration-task + */ + SourceType?: String; + /** + * A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories. + */ + EventCategories?: EventCategoriesList; + /** + * A Boolean value; set to true to activate the subscription. + */ + Enabled?: BooleanOptional; + } + export interface ModifyEventSubscriptionResponse { + /** + * The modified event subscription. + */ + EventSubscription?: EventSubscription; + } + export interface ModifyReplicationInstanceMessage { + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn: String; + /** + * The amount of storage (in gigabytes) to be allocated for the replication instance. + */ + AllocatedStorage?: IntegerOptional; + /** + * Indicates whether the changes should be applied immediately or during the next maintenance window. + */ + ApplyImmediately?: Boolean; + /** + * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge + */ + ReplicationInstanceClass?: String; + /** + * Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes + */ + PreferredMaintenanceWindow?: String; + /** + * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + */ + MultiAZ?: BooleanOptional; + /** + * The engine version number of the replication instance. + */ + EngineVersion?: String; + /** + * Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version. + */ + AllowMajorVersionUpgrade?: Boolean; + /** + * Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The replication instance identifier. This parameter is stored as a lowercase string. + */ + ReplicationInstanceIdentifier?: String; + } + export interface ModifyReplicationInstanceResponse { + /** + * The modified replication instance. + */ + ReplicationInstance?: ReplicationInstance; + } + export interface ModifyReplicationSubnetGroupMessage { + /** + * The name of the replication instance subnet group. + */ + ReplicationSubnetGroupIdentifier: String; + /** + * The description of the replication instance subnet group. + */ + ReplicationSubnetGroupDescription?: String; + /** + * A list of subnet IDs. + */ + SubnetIds: SubnetIdentifierList; + } + export interface ModifyReplicationSubnetGroupResponse { + /** + * The modified replication subnet group. + */ + ReplicationSubnetGroup?: ReplicationSubnetGroup; + } + export interface ModifyReplicationTaskMessage { + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn: String; + /** + * The replication task identifier. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + ReplicationTaskIdentifier?: String; + /** + * The migration type. Valid values: full-load | cdc | full-load-and-cdc + */ + MigrationType?: MigrationTypeValue; + /** + * 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. For example, --table-mappings file://mappingfile.json + */ + TableMappings?: String; + /** + * JSON file that contains settings for the task, such as target metadata settings. + */ + ReplicationTaskSettings?: String; + /** + * 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. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12” + */ + CdcStartTime?: TStamp; + /** + * 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. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + */ + CdcStartPosition?: String; + /** + * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “ + */ + CdcStopPosition?: String; + } + export interface ModifyReplicationTaskResponse { + /** + * The replication task that was modified. + */ + ReplicationTask?: ReplicationTask; + } + export interface MongoDbSettings { + /** + * The user name you use to access the MongoDB source endpoint. + */ + Username?: String; + /** + * The password for the user account you use to access the MongoDB source endpoint. + */ + Password?: SecretString; + /** + * The name of the server on the MongoDB source endpoint. + */ + ServerName?: String; + /** + * The port value for the MongoDB source endpoint. + */ + Port?: IntegerOptional; + /** + * The database name on the MongoDB source endpoint. + */ + DatabaseName?: String; + /** + * The authentication type you use to access the MongoDB source endpoint. Valid values: NO, PASSWORD When NO is selected, user name and password parameters are not used and can be empty. + */ + AuthType?: AuthTypeValue; + /** + * The authentication mechanism you use to access the MongoDB source endpoint. Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No. + */ + AuthMechanism?: AuthMechanismValue; + /** + * Specifies either document or table mode. Valid values: NONE, ONE Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode. + */ + NestingLevel?: NestingLevelValue; + /** + * Specifies the document ID. Use this attribute when NestingLevel is set to NONE. Default value is false. + */ + ExtractDocId?: String; + /** + * Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE. Must be a positive value greater than 0. Default value is 1000. + */ + DocsToInvestigate?: String; + /** + * The MongoDB database name. This attribute is not used when authType=NO. The default is admin. + */ + AuthSource?: String; + /** + * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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. + */ + KmsKeyId?: String; + } + export type NestingLevelValue = "none"|"one"|string; + export interface OrderableReplicationInstance { + /** + * The version of the replication engine. + */ + EngineVersion?: String; + /** + * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge + */ + ReplicationInstanceClass?: String; + /** + * The type of storage used by the replication instance. + */ + StorageType?: String; + /** + * The minimum amount of storage (in gigabytes) that can be allocated for the replication instance. + */ + MinAllocatedStorage?: Integer; + /** + * The minimum amount of storage (in gigabytes) that can be allocated for the replication instance. + */ + MaxAllocatedStorage?: Integer; + /** + * The default amount of storage (in gigabytes) that is allocated for the replication instance. + */ + DefaultAllocatedStorage?: Integer; + /** + * The amount of storage (in gigabytes) that is allocated for the replication instance. + */ + IncludedAllocatedStorage?: Integer; + /** + * List of availability zones for this replication instance. + */ + AvailabilityZones?: AvailabilityZonesList; + } + export type OrderableReplicationInstanceList = OrderableReplicationInstance[]; + export type ParquetVersionValue = "parquet-1-0"|"parquet-2-0"|string; + export interface PendingMaintenanceAction { + /** + * The type of pending maintenance action that is available for the resource. + */ + Action?: String; + /** + * The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored. + */ + AutoAppliedAfterDate?: TStamp; + /** + * The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored. + */ + ForcedApplyDate?: TStamp; + /** + * Indicates the type of opt-in request that has been received for the resource. + */ + OptInStatus?: String; + /** + * The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate. + */ + CurrentApplyDate?: TStamp; + /** + * A description providing more detail about the maintenance action. + */ + Description?: String; + } + export type PendingMaintenanceActionDetails = PendingMaintenanceAction[]; + export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[]; + export interface RebootReplicationInstanceMessage { + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn: String; + /** + * If this parameter is true, the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify true.) + */ + ForceFailover?: BooleanOptional; + } + export interface RebootReplicationInstanceResponse { + /** + * The replication instance that is being rebooted. + */ + ReplicationInstance?: ReplicationInstance; + } + export interface RedshiftSettings { + /** + * Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default). This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field. + */ + AcceptAnyDate?: BooleanOptional; + /** + * Code to run after connecting. This should be the code, not a filename. + */ + AfterConnectScript?: String; + /** + * The location where the CSV files are stored before being uploaded to the S3 bucket. + */ + BucketFolder?: String; + /** + * The name of the S3 bucket you want to use + */ + BucketName?: String; + /** + * Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection. + */ + ConnectionTimeout?: IntegerOptional; + /** + * The name of the Amazon Redshift data warehouse (service) you are working with. + */ + DatabaseName?: String; + /** + * The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string. If your date and time values use formats different from each other, set this to auto. + */ + DateFormat?: String; + /** + * Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE. + */ + EmptyAsNull?: BooleanOptional; + /** + * The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket". + */ + EncryptionMode?: EncryptionModeValue; + /** + * Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10. + */ + FileTransferUploadStreams?: IntegerOptional; + /** + * Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading. + */ + LoadTimeout?: IntegerOptional; + /** + * Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB). + */ + MaxFileSize?: IntegerOptional; + /** + * The password for the user named in the username property. + */ + Password?: SecretString; + /** + * The port number for Amazon Redshift. The default value is 5439. + */ + Port?: IntegerOptional; + /** + * Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE. + */ + RemoveQuotes?: BooleanOptional; + /** + * A list of chars you want to replace. Use with ReplaceChars. + */ + ReplaceInvalidChars?: String; + /** + * Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?". + */ + ReplaceChars?: String; + /** + * The name of the Amazon Redshift cluster you are using. + */ + ServerName?: String; + /** + * The ARN of the role that has access to the Redshift service. + */ + ServiceAccessRoleArn?: String; + /** + * If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key. + */ + ServerSideEncryptionKmsKeyId?: String; + /** + * The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string. If your date and time values use formats different from each other, set this to auto. + */ + TimeFormat?: String; + /** + * Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE. + */ + TrimBlanks?: BooleanOptional; + /** + * Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE. + */ + TruncateColumns?: BooleanOptional; + /** + * An Amazon Redshift user name for a registered user. + */ + Username?: String; + /** + * The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance. + */ + WriteBufferSize?: IntegerOptional; + } + export interface RefreshSchemasMessage { + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn: String; + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn: String; + } + export interface RefreshSchemasResponse { + /** + * The status of the refreshed schema. + */ + RefreshSchemasStatus?: RefreshSchemasStatus; + } + export interface RefreshSchemasStatus { + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn?: String; + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn?: String; + /** + * The status of the schema. + */ + Status?: RefreshSchemasStatusTypeValue; + /** + * The date the schema was last refreshed. + */ + LastRefreshDate?: TStamp; + /** + * The last failure message for the schema. + */ + LastFailureMessage?: String; + } + export type RefreshSchemasStatusTypeValue = "successful"|"failed"|"refreshing"|string; + export type ReloadOptionValue = "data-reload"|"validate-only"|string; + export interface ReloadTablesMessage { + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn: String; + /** + * The name and schema of the table to be reloaded. + */ + TablesToReload: TableListToReload; + /** + * Options for reload. Specify data-reload to reload the data and re-validate it if validation is enabled. Specify validate-only to re-validate the table. This option applies only when validation is enabled for the task. Valid values: data-reload, validate-only Default value is data-reload. + */ + ReloadOption?: ReloadOptionValue; + } + export interface ReloadTablesResponse { + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn?: String; + } + export interface RemoveTagsFromResourceMessage { + /** + * >The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from. + */ + ResourceArn: String; + /** + * The tag key (name) of the tag to be removed. + */ + TagKeys: KeyList; + } + export interface RemoveTagsFromResourceResponse { + } + export type ReplicationEndpointTypeValue = "source"|"target"|string; + export interface ReplicationInstance { + /** + * The replication instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myrepinstance + */ + ReplicationInstanceIdentifier?: String; + /** + * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge + */ + ReplicationInstanceClass?: String; + /** + * The status of the replication instance. + */ + ReplicationInstanceStatus?: String; + /** + * The amount of storage (in gigabytes) that is allocated for the replication instance. + */ + AllocatedStorage?: Integer; + /** + * The time the replication instance was created. + */ + InstanceCreateTime?: TStamp; + /** + * The VPC security group for the instance. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * The Availability Zone for the instance. + */ + AvailabilityZone?: String; + /** + * The subnet group for the replication instance. + */ + ReplicationSubnetGroup?: ReplicationSubnetGroup; + /** + * The maintenance window times for the replication instance. + */ + PreferredMaintenanceWindow?: String; + /** + * The pending modification values. + */ + PendingModifiedValues?: ReplicationPendingModifiedValues; + /** + * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + */ + MultiAZ?: Boolean; + /** + * The engine version number of the replication instance. + */ + EngineVersion?: String; + /** + * Boolean value indicating if minor version upgrades will be automatically applied to the instance. + */ + AutoMinorVersionUpgrade?: Boolean; + /** + * The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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. + */ + KmsKeyId?: String; + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn?: String; + /** + * The public IP address of the replication instance. + */ + ReplicationInstancePublicIpAddress?: String; + /** + * The private IP address of the replication instance. + */ + ReplicationInstancePrivateIpAddress?: String; + /** + * The public IP address of the replication instance. + */ + ReplicationInstancePublicIpAddresses?: ReplicationInstancePublicIpAddressList; + /** + * The private IP address of the replication instance. + */ + ReplicationInstancePrivateIpAddresses?: ReplicationInstancePrivateIpAddressList; + /** + * Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true. + */ + PubliclyAccessible?: Boolean; + /** + * The availability zone of the standby replication instance in a Multi-AZ deployment. + */ + SecondaryAvailabilityZone?: String; + /** + * The expiration date of the free replication instance that is part of the Free DMS program. + */ + FreeUntil?: TStamp; + /** + * The DNS name servers for the replication instance. + */ + DnsNameServers?: String; + } + export type ReplicationInstanceList = ReplicationInstance[]; + export type ReplicationInstancePrivateIpAddressList = String[]; + export type ReplicationInstancePublicIpAddressList = String[]; + export interface ReplicationInstanceTaskLog { + /** + * The name of the replication task. + */ + ReplicationTaskName?: String; + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn?: String; + /** + * The size, in bytes, of the replication task log. + */ + ReplicationInstanceTaskLogSize?: Long; + } + export type ReplicationInstanceTaskLogsList = ReplicationInstanceTaskLog[]; + export interface ReplicationPendingModifiedValues { + /** + * The compute and memory capacity of the replication instance. Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge + */ + ReplicationInstanceClass?: String; + /** + * The amount of storage (in gigabytes) that is allocated for the replication instance. + */ + AllocatedStorage?: IntegerOptional; + /** + * Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + */ + MultiAZ?: BooleanOptional; + /** + * The engine version number of the replication instance. + */ + EngineVersion?: String; + } + export interface ReplicationSubnetGroup { + /** + * The identifier of the replication instance subnet group. + */ + ReplicationSubnetGroupIdentifier?: String; + /** + * The description of the replication subnet group. + */ + ReplicationSubnetGroupDescription?: String; + /** + * The ID of the VPC. + */ + VpcId?: String; + /** + * The status of the subnet group. + */ + SubnetGroupStatus?: String; + /** + * The subnets that are in the subnet group. + */ + Subnets?: SubnetList; + } + export type ReplicationSubnetGroups = ReplicationSubnetGroup[]; + export interface ReplicationTask { + /** + * The user-assigned replication task identifier or name. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + ReplicationTaskIdentifier?: String; + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + SourceEndpointArn?: String; + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + TargetEndpointArn?: String; + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn?: String; + /** + * The type of migration. + */ + MigrationType?: MigrationTypeValue; + /** + * Table mappings specified in the task. + */ + TableMappings?: String; + /** + * The settings for the replication task. + */ + ReplicationTaskSettings?: String; + /** + * The status of the replication task. + */ + Status?: String; + /** + * The last error (failure) message generated for the replication instance. + */ + LastFailureMessage?: String; + /** + * The reason the replication task was stopped. + */ + StopReason?: String; + /** + * The date the replication task was created. + */ + ReplicationTaskCreationDate?: TStamp; + /** + * The date the replication task is scheduled to start. + */ + ReplicationTaskStartDate?: TStamp; + /** + * 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. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + */ + CdcStartPosition?: String; + /** + * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “ + */ + CdcStopPosition?: String; + /** + * Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint. + */ + RecoveryCheckpoint?: String; + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn?: String; + /** + * The statistics for the task, including elapsed time, tables loaded, and table errors. + */ + ReplicationTaskStats?: ReplicationTaskStats; + } + export interface ReplicationTaskAssessmentResult { + /** + * The replication task identifier of the task on which the task assessment was run. + */ + ReplicationTaskIdentifier?: String; + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn?: String; + /** + * The date the task assessment was completed. + */ + ReplicationTaskLastAssessmentDate?: TStamp; + /** + * The status of the task assessment. + */ + AssessmentStatus?: String; + /** + * The file containing the results of the task assessment. + */ + AssessmentResultsFile?: String; + /** + * The task assessment results in JSON format. + */ + AssessmentResults?: String; + /** + * The URL of the S3 object containing the task assessment results. + */ + S3ObjectUrl?: String; + } + export type ReplicationTaskAssessmentResultList = ReplicationTaskAssessmentResult[]; + export type ReplicationTaskList = ReplicationTask[]; + export interface ReplicationTaskStats { + /** + * The percent complete for the full load migration task. + */ + FullLoadProgressPercent?: Integer; + /** + * The elapsed time of the task, in milliseconds. + */ + ElapsedTimeMillis?: Long; + /** + * The number of tables loaded for this task. + */ + TablesLoaded?: Integer; + /** + * The number of tables currently loading for this task. + */ + TablesLoading?: Integer; + /** + * The number of tables queued for this task. + */ + TablesQueued?: Integer; + /** + * The number of errors that have occurred during this task. + */ + TablesErrored?: Integer; + } + export interface ResourcePendingMaintenanceActions { + /** + * The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) in the DMS documentation. + */ + ResourceIdentifier?: String; + /** + * Detailed information about the pending maintenance action. + */ + PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails; + } + export interface S3Settings { + /** + * The Amazon Resource Name (ARN) used by the service access IAM role. + */ + ServiceAccessRoleArn?: String; + /** + * The external table definition. + */ + ExternalTableDefinition?: String; + /** + * The delimiter used to separate rows in the source files. The default is a carriage return (\n). + */ + CsvRowDelimiter?: String; + /** + * The delimiter used to separate columns in the source files. The default is a comma. + */ + CsvDelimiter?: String; + /** + * An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/. + */ + BucketFolder?: String; + /** + * The name of the S3 bucket. + */ + BucketName?: String; + /** + * An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats. + */ + CompressionType?: CompressionTypeValue; + /** + * The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions: s3:CreateBucket s3:ListBucket s3:DeleteBucket s3:GetBucketLocation s3:GetObject s3:PutObject s3:DeleteObject s3:GetObjectVersion s3:GetBucketPolicy s3:PutBucketPolicy s3:DeleteBucketPolicy + */ + EncryptionMode?: EncryptionModeValue; + /** + * If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key. Here is a CLI example: aws dms create-endpoint --endpoint-identifier <value> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<value>,BucketFolder=<value>,BucketName=<value>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<value> + */ + ServerSideEncryptionKmsKeyId?: String; + /** + * The format of the data which you want to use for output. You can choose one of the following: CSV : This is a row-based format with comma-separated values. PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response. + */ + DataFormat?: DataFormatValue; + /** + * The type of encoding you are using: RLE_DICTIONARY (default), PLAIN, or PLAIN_DICTIONARY. RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. PLAIN does not use encoding at all. Values are stored as they are. PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk. + */ + EncodingType?: EncodingTypeValue; + /** + * The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN. Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only. + */ + DictPageSizeLimit?: IntegerOptional; + /** + * The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only. If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024). + */ + RowGroupLength?: IntegerOptional; + /** + * The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only. + */ + DataPageSize?: IntegerOptional; + /** + * The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0. + */ + ParquetVersion?: ParquetVersionValue; + /** + * Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL, DISTINCT, MAX, and MIN values. Defaults to TRUE. For PARQUET format only. + */ + EnableStatistics?: BooleanOptional; + /** + * Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERTs are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE. + */ + CdcInsertsOnly?: BooleanOptional; + } + export type SchemaList = String[]; + export type SecretString = string; + export type SourceIdsList = String[]; + export type SourceType = "replication-instance"|string; + export interface StartReplicationTaskAssessmentMessage { + /** + * The Amazon Resource Name (ARN) of the replication task. + */ + ReplicationTaskArn: String; + } + export interface StartReplicationTaskAssessmentResponse { + /** + * The assessed replication task. + */ + ReplicationTask?: ReplicationTask; + } + export interface StartReplicationTaskMessage { + /** + * The Amazon Resource Name (ARN) of the replication task to be started. + */ + ReplicationTaskArn: String; + /** + * The type of replication task. + */ + StartReplicationTaskType: StartReplicationTaskTypeValue; + /** + * 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. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12” + */ + CdcStartTime?: TStamp; + /** + * 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. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” 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" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + */ + CdcStartPosition?: String; + /** + * Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “ + */ + CdcStopPosition?: String; + } + export interface StartReplicationTaskResponse { + /** + * The replication task started. + */ + ReplicationTask?: ReplicationTask; + } + export type StartReplicationTaskTypeValue = "start-replication"|"resume-processing"|"reload-target"|string; + export interface StopReplicationTaskMessage { + /** + * The Amazon Resource Name(ARN) of the replication task to be stopped. + */ + ReplicationTaskArn: String; + } + export interface StopReplicationTaskResponse { + /** + * The replication task stopped. + */ + ReplicationTask?: ReplicationTask; + } + export type String = string; + export interface Subnet { + /** + * The subnet identifier. + */ + SubnetIdentifier?: String; + /** + * The Availability Zone of the subnet. + */ + SubnetAvailabilityZone?: AvailabilityZone; + /** + * The status of the subnet. + */ + SubnetStatus?: String; + } + export type SubnetIdentifierList = String[]; + export type SubnetList = Subnet[]; + export interface SupportedEndpointType { + /** + * 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. + */ + EngineName?: String; + /** + * Indicates if Change Data Capture (CDC) is supported. + */ + SupportsCDC?: Boolean; + /** + * The type of endpoint. + */ + EndpointType?: ReplicationEndpointTypeValue; + /** + * The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL." + */ + EngineDisplayName?: String; + } + export type SupportedEndpointTypeList = SupportedEndpointType[]; + export type TStamp = Date; + export type TableListToReload = TableToReload[]; + export interface TableStatistics { + /** + * The schema name. + */ + SchemaName?: String; + /** + * The name of the table. + */ + TableName?: String; + /** + * The number of insert actions performed on a table. + */ + Inserts?: Long; + /** + * The number of delete actions performed on a table. + */ + Deletes?: Long; + /** + * The number of update actions performed on a table. + */ + Updates?: Long; + /** + * The Data Definition Language (DDL) used to build and modify the structure of your tables. + */ + Ddls?: Long; + /** + * The number of rows added during the Full Load operation. + */ + FullLoadRows?: Long; + /** + * The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations). + */ + FullLoadCondtnlChkFailedRows?: Long; + /** + * The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations). + */ + FullLoadErrorRows?: Long; + /** + * The last time the table was updated. + */ + LastUpdateTime?: TStamp; + /** + * The state of the tables described. Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded + */ + TableState?: String; + /** + * The number of records that have yet to be validated. + */ + ValidationPendingRecords?: Long; + /** + * The number of records that failed validation. + */ + ValidationFailedRecords?: Long; + /** + * The number of records that could not be validated. + */ + ValidationSuspendedRecords?: Long; + /** + * The validation state of the table. The parameter can have the following values Not enabled—Validation is not enabled for the table in the migration task. Pending records—Some records in the table are waiting for validation. Mismatched records—Some records in the table do not match between the source and target. Suspended records—Some records in the table could not be validated. No primary key—The table could not be validated because it had no primary key. Table error—The table was not validated because it was in an error state and some data was not migrated. Validated—All rows in the table were validated. If the table is updated, the status can change from Validated. Error—The table could not be validated because of an unexpected error. + */ + ValidationState?: String; + /** + * Additional details about the state of validation. + */ + ValidationStateDetails?: String; + } + export type TableStatisticsList = TableStatistics[]; + export interface TableToReload { + /** + * The schema name of the table to be reloaded. + */ + SchemaName?: String; + /** + * The table name of the table to be reloaded. + */ + TableName?: String; + } + export interface Tag { + /** + * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Key?: String; + /** + * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Value?: String; + } + export type TagList = Tag[]; + export interface TestConnectionMessage { + /** + * The Amazon Resource Name (ARN) of the replication instance. + */ + ReplicationInstanceArn: String; + /** + * The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. + */ + EndpointArn: String; + } + export interface TestConnectionResponse { + /** + * The connection tested. + */ + Connection?: Connection; + } + export type VpcSecurityGroupIdList = String[]; + export interface VpcSecurityGroupMembership { + /** + * The VPC security group Id. + */ + VpcSecurityGroupId?: String; + /** + * The status of the VPC security group. + */ + Status?: String; + } + export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-01-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DMS client. + */ + export import Types = DMS; +} +export = DMS; diff --git a/node_modules/aws-sdk/clients/dms.js b/node_modules/aws-sdk/clients/dms.js new file mode 100644 index 0000000..dd21c64 --- /dev/null +++ b/node_modules/aws-sdk/clients/dms.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['dms'] = {}; +AWS.DMS = Service.defineService('dms', ['2016-01-01']); +Object.defineProperty(apiLoader.services['dms'], '2016-01-01', { + get: function get() { + var model = require('../apis/dms-2016-01-01.min.json'); + model.paginators = require('../apis/dms-2016-01-01.paginators.json').pagination; + model.waiters = require('../apis/dms-2016-01-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DMS; diff --git a/node_modules/aws-sdk/clients/docdb.d.ts b/node_modules/aws-sdk/clients/docdb.d.ts new file mode 100644 index 0000000..eef94f8 --- /dev/null +++ b/node_modules/aws-sdk/clients/docdb.d.ts @@ -0,0 +1,2146 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DocDB extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DocDB.Types.ClientConfiguration) + config: Config & DocDB.Types.ClientConfiguration; + /** + * Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB. + */ + addTagsToResource(params: DocDB.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB. + */ + addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Applies a pending maintenance action to a resource (for example, to a DB instance). + */ + applyPendingMaintenanceAction(params: DocDB.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: DocDB.Types.ApplyPendingMaintenanceActionResult) => void): Request; + /** + * Applies a pending maintenance action to a resource (for example, to a DB instance). + */ + applyPendingMaintenanceAction(callback?: (err: AWSError, data: DocDB.Types.ApplyPendingMaintenanceActionResult) => void): Request; + /** + * Copies the specified DB cluster parameter group. + */ + copyDBClusterParameterGroup(params: DocDB.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterParameterGroupResult) => void): Request; + /** + * Copies the specified DB cluster parameter group. + */ + copyDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterParameterGroupResult) => void): Request; + /** + * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in the copying status. + */ + copyDBClusterSnapshot(params: DocDB.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterSnapshotResult) => void): Request; + /** + * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in the copying status. + */ + copyDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterSnapshotResult) => void): Request; + /** + * Creates a new Amazon DocumentDB DB cluster. + */ + createDBCluster(params: DocDB.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterResult) => void): Request; + /** + * Creates a new Amazon DocumentDB DB cluster. + */ + createDBCluster(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterResult) => void): Request; + /** + * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. + */ + createDBClusterParameterGroup(params: DocDB.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterParameterGroupResult) => void): Request; + /** + * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. + */ + createDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterParameterGroupResult) => void): Request; + /** + * Creates a snapshot of a DB cluster. + */ + createDBClusterSnapshot(params: DocDB.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterSnapshotResult) => void): Request; + /** + * Creates a snapshot of a DB cluster. + */ + createDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterSnapshotResult) => void): Request; + /** + * Creates a new DB instance. + */ + createDBInstance(params: DocDB.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBInstanceResult) => void): Request; + /** + * Creates a new DB instance. + */ + createDBInstance(callback?: (err: AWSError, data: DocDB.Types.CreateDBInstanceResult) => void): Request; + /** + * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. + */ + createDBSubnetGroup(params: DocDB.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBSubnetGroupResult) => void): Request; + /** + * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. + */ + createDBSubnetGroup(callback?: (err: AWSError, data: DocDB.Types.CreateDBSubnetGroupResult) => void): Request; + /** + * Deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. + */ + deleteDBCluster(params: DocDB.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterResult) => void): Request; + /** + * Deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. + */ + deleteDBCluster(callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterResult) => void): Request; + /** + * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. + */ + deleteDBClusterParameterGroup(params: DocDB.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. + */ + deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. + */ + deleteDBClusterSnapshot(params: DocDB.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterSnapshotResult) => void): Request; + /** + * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. + */ + deleteDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterSnapshotResult) => void): Request; + /** + * Deletes a previously provisioned DB instance. + */ + deleteDBInstance(params: DocDB.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBInstanceResult) => void): Request; + /** + * Deletes a previously provisioned DB instance. + */ + deleteDBInstance(callback?: (err: AWSError, data: DocDB.Types.DeleteDBInstanceResult) => void): Request; + /** + * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. + */ + deleteDBSubnetGroup(params: DocDB.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. + */ + deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified DB cluster parameter group. + */ + describeDBClusterParameterGroups(params: DocDB.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupsMessage) => void): Request; + /** + * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified DB cluster parameter group. + */ + describeDBClusterParameterGroups(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupsMessage) => void): Request; + /** + * Returns the detailed parameter list for a particular DB cluster parameter group. + */ + describeDBClusterParameters(params: DocDB.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupDetails) => void): Request; + /** + * Returns the detailed parameter list for a particular DB cluster parameter group. + */ + describeDBClusterParameters(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupDetails) => void): Request; + /** + * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. + */ + describeDBClusterSnapshotAttributes(params: DocDB.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: DocDB.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request; + /** + * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. + */ + describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: DocDB.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request; + /** + * Returns information about DB cluster snapshots. This API operation supports pagination. + */ + describeDBClusterSnapshots(params: DocDB.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterSnapshotMessage) => void): Request; + /** + * Returns information about DB cluster snapshots. This API operation supports pagination. + */ + describeDBClusterSnapshots(callback?: (err: AWSError, data: DocDB.Types.DBClusterSnapshotMessage) => void): Request; + /** + * Returns information about provisioned Amazon DocumentDB DB clusters. This API operation supports pagination. + */ + describeDBClusters(params: DocDB.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterMessage) => void): Request; + /** + * Returns information about provisioned Amazon DocumentDB DB clusters. This API operation supports pagination. + */ + describeDBClusters(callback?: (err: AWSError, data: DocDB.Types.DBClusterMessage) => void): Request; + /** + * Returns a list of the available DB engines. + */ + describeDBEngineVersions(params: DocDB.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: DocDB.Types.DBEngineVersionMessage) => void): Request; + /** + * Returns a list of the available DB engines. + */ + describeDBEngineVersions(callback?: (err: AWSError, data: DocDB.Types.DBEngineVersionMessage) => void): Request; + /** + * Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. + */ + describeDBInstances(params: DocDB.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request; + /** + * Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. + */ + describeDBInstances(callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request; + /** + * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. + */ + describeDBSubnetGroups(params: DocDB.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: DocDB.Types.DBSubnetGroupMessage) => void): Request; + /** + * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. + */ + describeDBSubnetGroups(callback?: (err: AWSError, data: DocDB.Types.DBSubnetGroupMessage) => void): Request; + /** + * Returns the default engine and system parameter information for the cluster database engine. + */ + describeEngineDefaultClusterParameters(params: DocDB.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: DocDB.Types.DescribeEngineDefaultClusterParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the cluster database engine. + */ + describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: DocDB.Types.DescribeEngineDefaultClusterParametersResult) => void): Request; + /** + * Displays a list of categories for all event source types, or, if specified, for a specified source type. + */ + describeEventCategories(params: DocDB.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: DocDB.Types.EventCategoriesMessage) => void): Request; + /** + * Displays a list of categories for all event source types, or, if specified, for a specified source type. + */ + describeEventCategories(callback?: (err: AWSError, data: DocDB.Types.EventCategoriesMessage) => void): Request; + /** + * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB parameter group by providing the name as a parameter. By default, the events of the past hour are returned. + */ + describeEvents(params: DocDB.Types.DescribeEventsMessage, callback?: (err: AWSError, data: DocDB.Types.EventsMessage) => void): Request; + /** + * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB parameter group by providing the name as a parameter. By default, the events of the past hour are returned. + */ + describeEvents(callback?: (err: AWSError, data: DocDB.Types.EventsMessage) => void): Request; + /** + * Returns a list of orderable DB instance options for the specified engine. + */ + describeOrderableDBInstanceOptions(params: DocDB.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: DocDB.Types.OrderableDBInstanceOptionsMessage) => void): Request; + /** + * Returns a list of orderable DB instance options for the specified engine. + */ + describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: DocDB.Types.OrderableDBInstanceOptionsMessage) => void): Request; + /** + * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. + */ + describePendingMaintenanceActions(params: DocDB.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: DocDB.Types.PendingMaintenanceActionsMessage) => void): Request; + /** + * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. + */ + describePendingMaintenanceActions(callback?: (err: AWSError, data: DocDB.Types.PendingMaintenanceActionsMessage) => void): Request; + /** + * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing. + */ + failoverDBCluster(params: DocDB.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.FailoverDBClusterResult) => void): Request; + /** + * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing. + */ + failoverDBCluster(callback?: (err: AWSError, data: DocDB.Types.FailoverDBClusterResult) => void): Request; + /** + * Lists all tags on an Amazon DocumentDB resource. + */ + listTagsForResource(params: DocDB.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DocDB.Types.TagListMessage) => void): Request; + /** + * Lists all tags on an Amazon DocumentDB resource. + */ + listTagsForResource(callback?: (err: AWSError, data: DocDB.Types.TagListMessage) => void): Request; + /** + * Modifies a setting for an Amazon DocumentDB DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. + */ + modifyDBCluster(params: DocDB.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterResult) => void): Request; + /** + * Modifies a setting for an Amazon DocumentDB DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. + */ + modifyDBCluster(callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterResult) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. + */ + modifyDBClusterParameterGroup(params: DocDB.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. + */ + modifyDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. + */ + modifyDBClusterSnapshotAttribute(params: DocDB.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. + */ + modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request; + /** + * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. + */ + modifyDBInstance(params: DocDB.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBInstanceResult) => void): Request; + /** + * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. + */ + modifyDBInstance(callback?: (err: AWSError, data: DocDB.Types.ModifyDBInstanceResult) => void): Request; + /** + * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. + */ + modifyDBSubnetGroup(params: DocDB.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBSubnetGroupResult) => void): Request; + /** + * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. + */ + modifyDBSubnetGroup(callback?: (err: AWSError, data: DocDB.Types.ModifyDBSubnetGroupResult) => void): Request; + /** + * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. + */ + rebootDBInstance(params: DocDB.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.RebootDBInstanceResult) => void): Request; + /** + * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. + */ + rebootDBInstance(callback?: (err: AWSError, data: DocDB.Types.RebootDBInstanceResult) => void): Request; + /** + * Removes metadata tags from an Amazon DocumentDB resource. + */ + removeTagsFromResource(params: DocDB.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes metadata tags from an Amazon DocumentDB resource. + */ + removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot. + */ + resetDBClusterParameterGroup(params: DocDB.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot. + */ + resetDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + */ + restoreDBClusterFromSnapshot(params: DocDB.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterFromSnapshotResult) => void): Request; + /** + * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + */ + restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterFromSnapshotResult) => void): Request; + /** + * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. + */ + restoreDBClusterToPointInTime(params: DocDB.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterToPointInTimeResult) => void): Request; + /** + * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. + */ + restoreDBClusterToPointInTime(callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterToPointInTimeResult) => void): Request; + /** + * Waits for the dBInstanceAvailable state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceAvailable", params: DocDB.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceAvailable state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceDeleted state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceDeleted", params: DocDB.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceDeleted state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request; +} +declare namespace DocDB { + export interface AddTagsToResourceMessage { + /** + * The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name (ARN). + */ + ResourceName: String; + /** + * The tags to be assigned to the Amazon DocumentDB resource. + */ + Tags: TagList; + } + export type ApplyMethod = "immediate"|"pending-reboot"|string; + export interface ApplyPendingMaintenanceActionMessage { + /** + * The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. + */ + ResourceIdentifier: String; + /** + * The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade + */ + ApplyAction: String; + /** + * A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests. + */ + OptInType: String; + } + export interface ApplyPendingMaintenanceActionResult { + ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions; + } + export type AttributeValueList = String[]; + export interface AvailabilityZone { + /** + * The name of the Availability Zone. + */ + Name?: String; + } + export type AvailabilityZoneList = AvailabilityZone[]; + export type AvailabilityZones = String[]; + export type Boolean = boolean; + export type BooleanOptional = boolean; + export interface CloudwatchLogsExportConfiguration { + /** + * The list of log types to enable. + */ + EnableLogTypes?: LogTypeList; + /** + * The list of log types to disable. + */ + DisableLogTypes?: LogTypeList; + } + export interface CopyDBClusterParameterGroupMessage { + /** + * The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1. + */ + SourceDBClusterParameterGroupIdentifier: String; + /** + * The identifier for the copied DB cluster parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-param-group1 + */ + TargetDBClusterParameterGroupIdentifier: String; + /** + * A description for the copied DB cluster parameter group. + */ + TargetDBClusterParameterGroupDescription: String; + /** + * The tags that are to be assigned to the parameter group. + */ + Tags?: TagList; + } + export interface CopyDBClusterParameterGroupResult { + DBClusterParameterGroup?: DBClusterParameterGroup; + } + export interface CopyDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot to copy. This parameter is not case sensitive. You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: Must specify a valid system snapshot in the "available" state. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. Example: my-cluster-snapshot1 + */ + SourceDBClusterSnapshotIdentifier: String; + /** + * The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2 + */ + TargetDBClusterSnapshotIdentifier: String; + /** + * The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the DB cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned. + */ + KmsKeyId?: String; + /** + * The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. You must use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another AWS Region. The presigned URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115. + */ + PreSignedUrl?: String; + /** + * Set to true to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false. + */ + CopyTags?: BooleanOptional; + /** + * The tags to be assigned to the DB cluster snapshot. + */ + Tags?: TagList; + } + export interface CopyDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface CreateDBClusterMessage { + /** + * A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster + */ + DBClusterIdentifier: String; + /** + * The name of the DB cluster parameter group to associate with this DB cluster. + */ + DBClusterParameterGroupName?: String; + /** + * A list of EC2 VPC security groups to associate with this DB cluster. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * The name of the database engine to be used for this DB cluster. Valid values: docdb + */ + Engine: String; + /** + * The version number of the database engine to use. + */ + EngineVersion?: String; + /** + * The port number on which the instances in the DB cluster accept connections. + */ + Port?: IntegerOptional; + /** + * The name of the master user for the DB cluster. Constraints: Must be from 1 to 16 letters or numbers. The first character must be a letter. Cannot be a reserved word for the chosen database engine. + */ + MasterUsername?: String; + /** + * The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword?: String; + /** + * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The tags to be assigned to the DB cluster. + */ + Tags?: TagList; + /** + * Specifies whether the DB cluster is encrypted. + */ + StorageEncrypted?: BooleanOptional; + /** + * The AWS KMS key identifier for an encrypted DB cluster. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. If an encryption key is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses 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. If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region. + */ + KmsKeyId?: String; + /** + * A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. + */ + EnableCloudwatchLogsExports?: LogTypeList; + } + export interface CreateDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string. + */ + DBClusterParameterGroupName: String; + /** + * The DB cluster parameter group family name. + */ + DBParameterGroupFamily: String; + /** + * The description for the DB cluster parameter group. + */ + Description: String; + /** + * The tags to be assigned to the DB cluster parameter group. + */ + Tags?: TagList; + } + export interface CreateDBClusterParameterGroupResult { + DBClusterParameterGroup?: DBClusterParameterGroup; + } + export interface CreateDBClusterResult { + DBCluster?: DBCluster; + } + export interface CreateDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot1 + */ + DBClusterSnapshotIdentifier: String; + /** + * The identifier of the DB cluster to create a snapshot for. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster + */ + DBClusterIdentifier: String; + /** + * The tags to be assigned to the DB cluster snapshot. + */ + Tags?: TagList; + } + export interface CreateDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface CreateDBInstanceMessage { + /** + * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance + */ + DBInstanceIdentifier: String; + /** + * The compute and memory capacity of the DB instance; for example, db.m4.large. + */ + DBInstanceClass: String; + /** + * The name of the database engine to be used for this instance. Valid value: docdb + */ + Engine: String; + /** + * The Amazon EC2 Availability Zone that the DB instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint. + */ + AvailabilityZone?: String; + /** + * The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The tags to be assigned to the DB instance. + */ + Tags?: TagList; + /** + * The identifier of the DB cluster that the instance will belong to. + */ + DBClusterIdentifier: String; + /** + * A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid values: 0-15 + */ + PromotionTier?: IntegerOptional; + } + export interface CreateDBInstanceResult { + DBInstance?: DBInstance; + } + export interface CreateDBSubnetGroupMessage { + /** + * The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + /** + * The description for the DB subnet group. + */ + DBSubnetGroupDescription: String; + /** + * The Amazon EC2 subnet IDs for the DB subnet group. + */ + SubnetIds: SubnetIdentifierList; + /** + * The tags to be assigned to the DB subnet group. + */ + Tags?: TagList; + } + export interface CreateDBSubnetGroupResult { + DBSubnetGroup?: DBSubnetGroup; + } + export interface DBCluster { + /** + * Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * Specifies the number of days for which automatic DB snapshots are retained. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. + */ + DBClusterIdentifier?: String; + /** + * Specifies the name of the DB cluster parameter group for the DB cluster. + */ + DBClusterParameterGroup?: String; + /** + * Specifies information on the subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group. + */ + DBSubnetGroup?: String; + /** + * Specifies the current state of this DB cluster. + */ + Status?: String; + /** + * Specifies the progress of the operation as a percentage. + */ + PercentProgress?: String; + /** + * The earliest time to which a database can be restored with point-in-time restore. + */ + EarliestRestorableTime?: TStamp; + /** + * Specifies the connection endpoint for the primary instance of the DB cluster. + */ + Endpoint?: String; + /** + * The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load balances connections across the Amazon DocumentDB replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the DB cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your DB cluster. If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint. + */ + ReaderEndpoint?: String; + /** + * Specifies whether the DB cluster has instances in multiple Availability Zones. + */ + MultiAZ?: Boolean; + /** + * Provides the name of the database engine to be used for this DB cluster. + */ + Engine?: String; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * Specifies the latest time to which a database can be restored with point-in-time restore. + */ + LatestRestorableTime?: TStamp; + /** + * Specifies the port that the database engine is listening on. + */ + Port?: IntegerOptional; + /** + * Contains the master user name for the DB cluster. + */ + MasterUsername?: String; + /** + * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. + */ + PreferredBackupWindow?: String; + /** + * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + */ + PreferredMaintenanceWindow?: String; + /** + * Provides the list of instances that make up the DB cluster. + */ + DBClusterMembers?: DBClusterMemberList; + /** + * Provides a list of virtual private cloud (VPC) security groups that the DB cluster belongs to. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + */ + HostedZoneId?: String; + /** + * Specifies whether the DB cluster is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster. + */ + KmsKeyId?: String; + /** + * The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. + */ + DbClusterResourceId?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster. + */ + DBClusterArn?: String; + /** + * Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + */ + AssociatedRoles?: DBClusterRoles; + /** + * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). + */ + ClusterCreateTime?: TStamp; + /** + * A list of log types that this DB cluster is configured to export to Amazon CloudWatch Logs. + */ + EnabledCloudwatchLogsExports?: LogTypeList; + } + export type DBClusterList = DBCluster[]; + export interface DBClusterMember { + /** + * Specifies the instance identifier for this member of the DB cluster. + */ + DBInstanceIdentifier?: String; + /** + * A value that is true if the cluster member is the primary instance for the DB cluster and false otherwise. + */ + IsClusterWriter?: Boolean; + /** + * Specifies the status of the DB cluster parameter group for this member of the DB cluster. + */ + DBClusterParameterGroupStatus?: String; + /** + * A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. + */ + PromotionTier?: IntegerOptional; + } + export type DBClusterMemberList = DBClusterMember[]; + export interface DBClusterMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DB clusters. + */ + DBClusters?: DBClusterList; + } + export interface DBClusterParameterGroup { + /** + * Provides the name of the DB cluster parameter group. + */ + DBClusterParameterGroupName?: String; + /** + * Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with. + */ + DBParameterGroupFamily?: String; + /** + * Provides the customer-specified description for this DB cluster parameter group. + */ + Description?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster parameter group. + */ + DBClusterParameterGroupArn?: String; + } + export interface DBClusterParameterGroupDetails { + /** + * Provides a list of parameters for the DB cluster parameter group. + */ + Parameters?: ParametersList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export type DBClusterParameterGroupList = DBClusterParameterGroup[]; + export interface DBClusterParameterGroupNameMessage { + /** + * The name of a DB cluster parameter group. Constraints: Must be from 1 to 255 letters or numbers. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. This value is stored as a lowercase string. + */ + DBClusterParameterGroupName?: String; + } + export interface DBClusterParameterGroupsMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DB cluster parameter groups. + */ + DBClusterParameterGroups?: DBClusterParameterGroupList; + } + export interface DBClusterRole { + /** + * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. + */ + RoleArn?: String; + /** + * Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: ACTIVE - The IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf. PENDING - The IAM role ARN is being associated with the DB cluster. INVALID - The IAM role ARN is associated with the DB cluster, but the DB cluster cannot assume the IAM role to access other AWS services on your behalf. + */ + Status?: String; + } + export type DBClusterRoles = DBClusterRole[]; + export interface DBClusterSnapshot { + /** + * Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster snapshot can be restored in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * Specifies the identifier for the DB cluster snapshot. + */ + DBClusterSnapshotIdentifier?: String; + /** + * Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. + */ + DBClusterIdentifier?: String; + /** + * Provides the time when the snapshot was taken, in UTC. + */ + SnapshotCreateTime?: TStamp; + /** + * Specifies the name of the database engine. + */ + Engine?: String; + /** + * Specifies the status of this DB cluster snapshot. + */ + Status?: String; + /** + * Specifies the port that the DB cluster was listening on at the time of the snapshot. + */ + Port?: Integer; + /** + * Provides the virtual private cloud (VPC) ID that is associated with the DB cluster snapshot. + */ + VpcId?: String; + /** + * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). + */ + ClusterCreateTime?: TStamp; + /** + * Provides the master user name for the DB cluster snapshot. + */ + MasterUsername?: String; + /** + * Provides the version of the database engine for this DB cluster snapshot. + */ + EngineVersion?: String; + /** + * Provides the type of the DB cluster snapshot. + */ + SnapshotType?: String; + /** + * Specifies the percentage of the estimated data that has been transferred. + */ + PercentProgress?: Integer; + /** + * Specifies whether the DB cluster snapshot is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. + */ + KmsKeyId?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster snapshot. + */ + DBClusterSnapshotArn?: String; + /** + * If the DB cluster snapshot was copied from a source DB cluster snapshot, the ARN for the source DB cluster snapshot; otherwise, a null value. + */ + SourceDBClusterSnapshotArn?: String; + } + export interface DBClusterSnapshotAttribute { + /** + * The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. + */ + AttributeName?: String; + /** + * The values for the manual DB cluster snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore. + */ + AttributeValues?: AttributeValueList; + } + export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[]; + export interface DBClusterSnapshotAttributesResult { + /** + * The identifier of the DB cluster snapshot that the attributes apply to. + */ + DBClusterSnapshotIdentifier?: String; + /** + * The list of attributes and values for the DB cluster snapshot. + */ + DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList; + } + export type DBClusterSnapshotList = DBClusterSnapshot[]; + export interface DBClusterSnapshotMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Provides a list of DB cluster snapshots. + */ + DBClusterSnapshots?: DBClusterSnapshotList; + } + export interface DBEngineVersion { + /** + * The name of the database engine. + */ + Engine?: String; + /** + * The version number of the database engine. + */ + EngineVersion?: String; + /** + * The name of the DB parameter group family for the database engine. + */ + DBParameterGroupFamily?: String; + /** + * The description of the database engine. + */ + DBEngineDescription?: String; + /** + * The description of the database engine version. + */ + DBEngineVersionDescription?: String; + /** + * A list of engine versions that this database engine version can be upgraded to. + */ + ValidUpgradeTarget?: ValidUpgradeTargetList; + /** + * The types of logs that the database engine has available for export to Amazon CloudWatch Logs. + */ + ExportableLogTypes?: LogTypeList; + /** + * A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. + */ + SupportsLogExportsToCloudwatchLogs?: Boolean; + } + export type DBEngineVersionList = DBEngineVersion[]; + export interface DBEngineVersionMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Detailed information about one or more DB engine versions. + */ + DBEngineVersions?: DBEngineVersionList; + } + export interface DBInstance { + /** + * Contains a user-provided database identifier. This identifier is the unique key that identifies a DB instance. + */ + DBInstanceIdentifier?: String; + /** + * Contains the name of the compute and memory capacity class of the DB instance. + */ + DBInstanceClass?: String; + /** + * Provides the name of the database engine to be used for this DB instance. + */ + Engine?: String; + /** + * Specifies the current state of this database. + */ + DBInstanceStatus?: String; + /** + * Specifies the connection endpoint. + */ + Endpoint?: Endpoint; + /** + * Provides the date and time that the DB instance was created. + */ + InstanceCreateTime?: TStamp; + /** + * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. + */ + PreferredBackupWindow?: String; + /** + * Specifies the number of days for which automatic DB snapshots are retained. + */ + BackupRetentionPeriod?: Integer; + /** + * Provides a list of VPC security group elements that the DB instance belongs to. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * Specifies the name of the Availability Zone that the DB instance is located in. + */ + AvailabilityZone?: String; + /** + * Specifies information on the subnet group that is associated with the DB instance, including the name, description, and subnets in the subnet group. + */ + DBSubnetGroup?: DBSubnetGroup; + /** + * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + */ + PreferredMaintenanceWindow?: String; + /** + * Specifies that changes to the DB instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements. + */ + PendingModifiedValues?: PendingModifiedValues; + /** + * Specifies the latest time to which a database can be restored with point-in-time restore. + */ + LatestRestorableTime?: TStamp; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * Indicates that minor version patches are applied automatically. + */ + AutoMinorVersionUpgrade?: Boolean; + /** + * Specifies the availability options for the DB instance. A value of true specifies an internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. + */ + PubliclyAccessible?: Boolean; + /** + * The status of a read replica. If the instance is not a read replica, this is blank. + */ + StatusInfos?: DBInstanceStatusInfoList; + /** + * Contains the name of the DB cluster that the DB instance is a member of if the DB instance is a member of a DB cluster. + */ + DBClusterIdentifier?: String; + /** + * Specifies whether the DB instance is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance. + */ + KmsKeyId?: String; + /** + * The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. + */ + DbiResourceId?: String; + /** + * A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. + */ + PromotionTier?: IntegerOptional; + /** + * The Amazon Resource Name (ARN) for the DB instance. + */ + DBInstanceArn?: String; + /** + * A list of log types that this DB instance is configured to export to Amazon CloudWatch Logs. + */ + EnabledCloudwatchLogsExports?: LogTypeList; + } + export type DBInstanceList = DBInstance[]; + export interface DBInstanceMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Detailed information about one or more DB instances. + */ + DBInstances?: DBInstanceList; + } + export interface DBInstanceStatusInfo { + /** + * This value is currently "read replication." + */ + StatusType?: String; + /** + * A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. + */ + Normal?: Boolean; + /** + * Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated. + */ + Status?: String; + /** + * Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank. + */ + Message?: String; + } + export type DBInstanceStatusInfoList = DBInstanceStatusInfo[]; + export interface DBSubnetGroup { + /** + * The name of the DB subnet group. + */ + DBSubnetGroupName?: String; + /** + * Provides the description of the DB subnet group. + */ + DBSubnetGroupDescription?: String; + /** + * Provides the virtual private cloud (VPC) ID of the DB subnet group. + */ + VpcId?: String; + /** + * Provides the status of the DB subnet group. + */ + SubnetGroupStatus?: String; + /** + * Detailed information about one or more subnets within a DB subnet group. + */ + Subnets?: SubnetList; + /** + * The Amazon Resource Identifier (ARN) for the DB subnet group. + */ + DBSubnetGroupArn?: String; + } + export interface DBSubnetGroupMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Detailed information about one or more DB subnet groups. + */ + DBSubnetGroups?: DBSubnetGroups; + } + export type DBSubnetGroups = DBSubnetGroup[]; + export interface DeleteDBClusterMessage { + /** + * The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case sensitive. Constraints: Must match an existing DBClusterIdentifier. + */ + DBClusterIdentifier: String; + /** + * Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted. If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter. Default: false + */ + SkipFinalSnapshot?: Boolean; + /** + * The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be from 1 to 255 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + FinalDBSnapshotIdentifier?: String; + } + export interface DeleteDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You can't delete a default DB cluster parameter group. Cannot be associated with any DB clusters. + */ + DBClusterParameterGroupName: String; + } + export interface DeleteDBClusterResult { + DBCluster?: DBCluster; + } + export interface DeleteDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state. + */ + DBClusterSnapshotIdentifier: String; + } + export interface DeleteDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface DeleteDBInstanceMessage { + /** + * The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive. Constraints: Must match the name of an existing DB instance. + */ + DBInstanceIdentifier: String; + } + export interface DeleteDBInstanceResult { + DBInstance?: DBInstance; + } + export interface DeleteDBSubnetGroupMessage { + /** + * The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + } + export interface DescribeDBClusterParameterGroupsMessage { + /** + * The name of a specific DB cluster parameter group to return details for. Constraints: If provided, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterParametersMessage { + /** + * The name of a specific DB cluster parameter group to return parameter details for. Constraints: If provided, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName: String; + /** + * A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer. + */ + Source?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterSnapshotAttributesMessage { + /** + * The identifier for the DB cluster snapshot to describe the attributes for. + */ + DBClusterSnapshotIdentifier: String; + } + export interface DescribeDBClusterSnapshotAttributesResult { + DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; + } + export interface DescribeDBClusterSnapshotsMessage { + /** + * The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive. Constraints: If provided, must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier?: String; + /** + * A specific DB cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If provided, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified. + */ + DBClusterSnapshotIdentifier?: String; + /** + * The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that Amazon DocumentDB has automatically created for your AWS account. manual - Return all DB cluster snapshots that you have manually created for your AWS account. shared - Return all manual DB cluster snapshots that have been shared to your AWS account. public - Return all DB cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public. + */ + SnapshotType?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Set to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false. + */ + IncludeShared?: Boolean; + /** + * Set to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. + */ + IncludePublic?: Boolean; + } + export interface DescribeDBClustersMessage { + /** + * The user-provided DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case sensitive. Constraints: If provided, must match an existing DBClusterIdentifier. + */ + DBClusterIdentifier?: String; + /** + * A filter that specifies one or more DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBEngineVersionsMessage { + /** + * The database engine to return. + */ + Engine?: String; + /** + * The database engine version to return. Example: 5.1.49 + */ + EngineVersion?: String; + /** + * The name of a specific DB parameter group family to return details for. Constraints: If provided, must match an existing DBParameterGroupFamily. + */ + DBParameterGroupFamily?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Indicates that only the default version of the specified engine or engine and major version combination is returned. + */ + DefaultOnly?: Boolean; + /** + * If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version. + */ + ListSupportedCharacterSets?: BooleanOptional; + /** + * If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version. + */ + ListSupportedTimezones?: BooleanOptional; + } + export interface DescribeDBInstancesMessage { + /** + * The user-provided instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive. Constraints: If provided, must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier?: String; + /** + * A filter that specifies one or more DB instances to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only the information about the DB instances that are associated with the DB clusters that are identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list includes only the information about the DB instances that are identified by these ARNs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBSubnetGroupsMessage { + /** + * The name of the DB subnet group to return details for. + */ + DBSubnetGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultClusterParametersMessage { + /** + * The name of the DB cluster parameter group family to return the engine parameter information for. + */ + DBParameterGroupFamily: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultClusterParametersResult { + EngineDefaults?: EngineDefaults; + } + export interface DescribeEventCategoriesMessage { + /** + * The type of source that is generating the events. Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot + */ + SourceType?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + } + export interface DescribeEventsMessage { + /** + * The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is provided, SourceType must also be provided. If the source type is DBInstance, a DBInstanceIdentifier must be provided. If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided. If the source type is DBParameterGroup, a DBParameterGroupName must be provided. If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided. Cannot end with a hyphen or contain two consecutive hyphens. + */ + SourceIdentifier?: String; + /** + * The event source to retrieve events for. If no value is specified, all events are returned. + */ + SourceType?: SourceType; + /** + * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2009-07-08T18:00Z + */ + StartTime?: TStamp; + /** + * The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2009-07-08T18:00Z + */ + EndTime?: TStamp; + /** + * The number of minutes to retrieve events for. Default: 60 + */ + Duration?: IntegerOptional; + /** + * A list of event categories that trigger notifications for an event notification subscription. + */ + EventCategories?: EventCategoriesList; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeOrderableDBInstanceOptionsMessage { + /** + * The name of the engine to retrieve DB instance options for. + */ + Engine: String; + /** + * The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version. + */ + EngineVersion?: String; + /** + * The DB instance class filter value. Specify this parameter to show only the available offerings that match the specified DB instance class. + */ + DBInstanceClass?: String; + /** + * The license model filter value. Specify this parameter to show only the available offerings that match the specified license model. + */ + LicenseModel?: String; + /** + * The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings. + */ + Vpc?: BooleanOptional; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribePendingMaintenanceActionsMessage { + /** + * The ARN of a resource to return pending maintenance actions for. + */ + ResourceIdentifier?: String; + /** + * A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs. + */ + Filters?: FilterList; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + } + export interface Endpoint { + /** + * Specifies the DNS address of the DB instance. + */ + Address?: String; + /** + * Specifies the port that the database engine is listening on. + */ + Port?: Integer; + /** + * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + */ + HostedZoneId?: String; + } + export interface EngineDefaults { + /** + * The name of the DB cluster parameter group family to return the engine parameter information for. + */ + DBParameterGroupFamily?: String; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * The parameters of a particular DB cluster parameter group family. + */ + Parameters?: ParametersList; + } + export interface Event { + /** + * Provides the identifier for the source of the event. + */ + SourceIdentifier?: String; + /** + * Specifies the source type for this event. + */ + SourceType?: SourceType; + /** + * Provides the text of this event. + */ + Message?: String; + /** + * Specifies the category for the event. + */ + EventCategories?: EventCategoriesList; + /** + * Specifies the date and time of the event. + */ + Date?: TStamp; + /** + * The Amazon Resource Name (ARN) for the event. + */ + SourceArn?: String; + } + export type EventCategoriesList = String[]; + export interface EventCategoriesMap { + /** + * The source type that the returned categories belong to. + */ + SourceType?: String; + /** + * The event categories for the specified source type. + */ + EventCategories?: EventCategoriesList; + } + export type EventCategoriesMapList = EventCategoriesMap[]; + export interface EventCategoriesMessage { + /** + * A list of event category maps. + */ + EventCategoriesMapList?: EventCategoriesMapList; + } + export type EventList = Event[]; + export interface EventsMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Detailed information about one or more events. + */ + Events?: EventList; + } + export interface FailoverDBClusterMessage { + /** + * A DB cluster identifier to force a failover for. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier?: String; + /** + * The name of the instance to promote to the primary instance. You must specify the instance identifier for an Amazon DocumentDB replica in the DB cluster. For example, mydbcluster-replica1. + */ + TargetDBInstanceIdentifier?: String; + } + export interface FailoverDBClusterResult { + DBCluster?: DBCluster; + } + export interface Filter { + /** + * The name of the filter. Filter names are case sensitive. + */ + Name: String; + /** + * One or more filter values. Filter values are case sensitive. + */ + Values: FilterValueList; + } + export type FilterList = Filter[]; + export type FilterValueList = String[]; + export type Integer = number; + export type IntegerOptional = number; + export type KeyList = String[]; + export interface ListTagsForResourceMessage { + /** + * The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN). + */ + ResourceName: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + } + export type LogTypeList = String[]; + export interface ModifyDBClusterMessage { + /** + * The DB cluster identifier for the cluster that is being modified. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier: String; + /** + * The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster2 + */ + NewDBClusterIdentifier?: String; + /** + * A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. Default: false + */ + ApplyImmediately?: Boolean; + /** + * The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The name of the DB cluster parameter group to use for the DB cluster. + */ + DBClusterParameterGroupName?: String; + /** + * A list of virtual private cloud (VPC) security groups that the DB cluster will belong to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The port number on which the DB cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The same port as the original DB cluster. + */ + Port?: IntegerOptional; + /** + * The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword?: String; + /** + * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. + */ + CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration; + /** + * The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true. + */ + EngineVersion?: String; + } + export interface ModifyDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group to modify. + */ + DBClusterParameterGroupName: String; + /** + * A list of parameters in the DB cluster parameter group to modify. + */ + Parameters: ParametersList; + } + export interface ModifyDBClusterResult { + DBCluster?: DBCluster; + } + export interface ModifyDBClusterSnapshotAttributeMessage { + /** + * The identifier for the DB cluster snapshot to modify the attributes for. + */ + DBClusterSnapshotIdentifier: String; + /** + * The name of the DB cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore. + */ + AttributeName: String; + /** + * A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs. To make the manual DB cluster snapshot restorable by any AWS account, set it to all. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want to be available to all AWS accounts. + */ + ValuesToAdd?: AttributeValueList; + /** + * A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the DB cluster snapshot, set it to all . If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot. + */ + ValuesToRemove?: AttributeValueList; + } + export interface ModifyDBClusterSnapshotAttributeResult { + DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; + } + export interface ModifyDBInstanceMessage { + /** + * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * The new compute and memory capacity of the DB instance; for example, db.m4.large. Not all DB instance classes are available in all AWS Regions. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request. Default: Uses existing setting. + */ + DBInstanceClass?: String; + /** + * Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot. Default: false + */ + ApplyImmediately?: Boolean; + /** + * The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the DB instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied. Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Must be at least 30 minutes. + */ + PreferredMaintenanceWindow?: String; + /** + * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case, and the change is asynchronously applied as soon as possible. An outage results if this parameter is set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance + */ + NewDBInstanceIdentifier?: String; + /** + * A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid values: 0-15 + */ + PromotionTier?: IntegerOptional; + } + export interface ModifyDBInstanceResult { + DBInstance?: DBInstance; + } + export interface ModifyDBSubnetGroupMessage { + /** + * The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + /** + * The description for the DB subnet group. + */ + DBSubnetGroupDescription?: String; + /** + * The Amazon EC2 subnet IDs for the DB subnet group. + */ + SubnetIds: SubnetIdentifierList; + } + export interface ModifyDBSubnetGroupResult { + DBSubnetGroup?: DBSubnetGroup; + } + export interface OrderableDBInstanceOption { + /** + * The engine type of a DB instance. + */ + Engine?: String; + /** + * The engine version of a DB instance. + */ + EngineVersion?: String; + /** + * The DB instance class for a DB instance. + */ + DBInstanceClass?: String; + /** + * The license model for a DB instance. + */ + LicenseModel?: String; + /** + * A list of Availability Zones for a DB instance. + */ + AvailabilityZones?: AvailabilityZoneList; + /** + * Indicates whether a DB instance is in a virtual private cloud (VPC). + */ + Vpc?: Boolean; + } + export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[]; + export interface OrderableDBInstanceOptionsMessage { + /** + * The options that are available for a particular orderable DB instance. + */ + OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface Parameter { + /** + * Specifies the name of the parameter. + */ + ParameterName?: String; + /** + * Specifies the value of the parameter. + */ + ParameterValue?: String; + /** + * Provides a description of the parameter. + */ + Description?: String; + /** + * Indicates the source of the parameter value. + */ + Source?: String; + /** + * Specifies the engine-specific parameters type. + */ + ApplyType?: String; + /** + * Specifies the valid data type for the parameter. + */ + DataType?: String; + /** + * Specifies the valid range of values for the parameter. + */ + AllowedValues?: String; + /** + * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. + */ + IsModifiable?: Boolean; + /** + * The earliest engine version to which the parameter can apply. + */ + MinimumEngineVersion?: String; + /** + * Indicates when to apply parameter updates. + */ + ApplyMethod?: ApplyMethod; + } + export type ParametersList = Parameter[]; + export interface PendingCloudwatchLogsExports { + /** + * Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. + */ + LogTypesToEnable?: LogTypeList; + /** + * Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs. + */ + LogTypesToDisable?: LogTypeList; + } + export interface PendingMaintenanceAction { + /** + * The type of pending maintenance action that is available for the resource. + */ + Action?: String; + /** + * The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored. + */ + AutoAppliedAfterDate?: TStamp; + /** + * The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored. + */ + ForcedApplyDate?: TStamp; + /** + * Indicates the type of opt-in request that has been received for the resource. + */ + OptInStatus?: String; + /** + * The effective date when the pending maintenance action is applied to the resource. + */ + CurrentApplyDate?: TStamp; + /** + * A description providing more detail about the maintenance action. + */ + Description?: String; + } + export type PendingMaintenanceActionDetails = PendingMaintenanceAction[]; + export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[]; + export interface PendingMaintenanceActionsMessage { + /** + * The maintenance actions to be applied. + */ + PendingMaintenanceActions?: PendingMaintenanceActions; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface PendingModifiedValues { + /** + * Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied. + */ + DBInstanceClass?: String; + /** + * Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied. + */ + AllocatedStorage?: IntegerOptional; + /** + * Contains the pending or currently in-progress change of the master credentials for the DB instance. + */ + MasterUserPassword?: String; + /** + * Specifies the pending port for the DB instance. + */ + Port?: IntegerOptional; + /** + * Specifies the pending number of days for which automated backups are retained. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. + */ + MultiAZ?: BooleanOptional; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * The license model for the DB instance. Valid values: license-included, bring-your-own-license, general-public-license + */ + LicenseModel?: String; + /** + * Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied. + */ + Iops?: IntegerOptional; + /** + * Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied. + */ + DBInstanceIdentifier?: String; + /** + * Specifies the storage type to be associated with the DB instance. + */ + StorageType?: String; + /** + * Specifies the identifier of the certificate authority (CA) certificate for the DB instance. + */ + CACertificateIdentifier?: String; + /** + * The new DB subnet group for the DB instance. + */ + DBSubnetGroupName?: String; + /** + * A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated. + */ + PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports; + } + export interface RebootDBInstanceMessage { + /** + * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * When true, the reboot is conducted through a Multi-AZ failover. Constraint: You can't specify true if the instance is not configured for Multi-AZ. + */ + ForceFailover?: BooleanOptional; + } + export interface RebootDBInstanceResult { + DBInstance?: DBInstance; + } + export interface RemoveTagsFromResourceMessage { + /** + * The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN). + */ + ResourceName: String; + /** + * The tag key (name) of the tag to be removed. + */ + TagKeys: KeyList; + } + export interface ResetDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group to reset. + */ + DBClusterParameterGroupName: String; + /** + * A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter. + */ + ResetAllParameters?: Boolean; + /** + * A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true. + */ + Parameters?: ParametersList; + } + export interface ResourcePendingMaintenanceActions { + /** + * The Amazon Resource Name (ARN) of the resource that has pending maintenance actions. + */ + ResourceIdentifier?: String; + /** + * A list that provides details about the pending maintenance actions for the resource. + */ + PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails; + } + export interface RestoreDBClusterFromSnapshotMessage { + /** + * Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-snapshot-id + */ + DBClusterIdentifier: String; + /** + * The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing snapshot. + */ + SnapshotIdentifier: String; + /** + * The database engine to use for the new DB cluster. Default: The same as source. Constraint: Must be compatible with the engine of the source. + */ + Engine: String; + /** + * The version of the database engine to use for the new DB cluster. + */ + EngineVersion?: String; + /** + * The port number on which the new DB cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The same port as the original DB cluster. + */ + Port?: IntegerOptional; + /** + * The name of the DB subnet group to use for the new DB cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * A list of virtual private cloud (VPC) security groups that the new DB cluster will belong to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The tags to be assigned to the restored DB cluster. + */ + Tags?: TagList; + /** + * The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. If you do not specify a value for the KmsKeyId parameter, then the following occurs: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the DB snapshot or the DB cluster snapshot. If the DB snapshot or the DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted. + */ + KmsKeyId?: String; + /** + * A list of log types that must be enabled for exporting to Amazon CloudWatch Logs. + */ + EnableCloudwatchLogsExports?: LogTypeList; + } + export interface RestoreDBClusterFromSnapshotResult { + DBCluster?: DBCluster; + } + export interface RestoreDBClusterToPointInTimeMessage { + /** + * The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + DBClusterIdentifier: String; + /** + * The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster. + */ + SourceDBClusterIdentifier: String; + /** + * The date and time to restore the DB cluster to. Valid values: A time in Universal Coordinated Time (UTC) format. Constraints: Must be before the latest restorable time for the DB instance. Must be specified if the UseLatestRestorableTime parameter is not provided. Cannot be specified if the UseLatestRestorableTime parameter is true. Cannot be specified if the RestoreType parameter is copy-on-write. Example: 2015-03-07T23:45:00Z + */ + RestoreToTime?: TStamp; + /** + * A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be specified if the RestoreToTime parameter is provided. + */ + UseLatestRestorableTime?: Boolean; + /** + * The port number on which the new DB cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The default port for the engine. + */ + Port?: IntegerOptional; + /** + * The DB subnet group name to use for the new DB cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * A list of VPC security groups that the new DB cluster belongs to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The tags to be assigned to the restored DB cluster. + */ + Tags?: TagList; + /** + * The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS key identified by the KmsKeyId parameter. If you do not specify a value for the KmsKeyId parameter, then the following occurs: If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the source DB cluster. If the DB cluster is not encrypted, then the restored DB cluster is not encrypted. If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected. + */ + KmsKeyId?: String; + /** + * A list of log types that must be enabled for exporting to Amazon CloudWatch Logs. + */ + EnableCloudwatchLogsExports?: LogTypeList; + } + export interface RestoreDBClusterToPointInTimeResult { + DBCluster?: DBCluster; + } + export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string; + export type String = string; + export interface Subnet { + /** + * Specifies the identifier of the subnet. + */ + SubnetIdentifier?: String; + /** + * Specifies the Availability Zone for the subnet. + */ + SubnetAvailabilityZone?: AvailabilityZone; + /** + * Specifies the status of the subnet. + */ + SubnetStatus?: String; + } + export type SubnetIdentifierList = String[]; + export type SubnetList = Subnet[]; + export type TStamp = Date; + export interface Tag { + /** + * The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Key?: String; + /** + * The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Value?: String; + } + export type TagList = Tag[]; + export interface TagListMessage { + /** + * A list of one or more tags. + */ + TagList?: TagList; + } + export interface UpgradeTarget { + /** + * The name of the upgrade target database engine. + */ + Engine?: String; + /** + * The version number of the upgrade target database engine. + */ + EngineVersion?: String; + /** + * The version of the database engine that a DB instance can be upgraded to. + */ + Description?: String; + /** + * A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true. + */ + AutoUpgrade?: Boolean; + /** + * A value that indicates whether a database engine is upgraded to a major version. + */ + IsMajorVersionUpgrade?: Boolean; + } + export type ValidUpgradeTargetList = UpgradeTarget[]; + export type VpcSecurityGroupIdList = String[]; + export interface VpcSecurityGroupMembership { + /** + * The name of the VPC security group. + */ + VpcSecurityGroupId?: String; + /** + * The status of the VPC security group. + */ + Status?: String; + } + export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-10-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DocDB client. + */ + export import Types = DocDB; +} +export = DocDB; diff --git a/node_modules/aws-sdk/clients/docdb.js b/node_modules/aws-sdk/clients/docdb.js new file mode 100644 index 0000000..ac16f10 --- /dev/null +++ b/node_modules/aws-sdk/clients/docdb.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['docdb'] = {}; +AWS.DocDB = Service.defineService('docdb', ['2014-10-31']); +Object.defineProperty(apiLoader.services['docdb'], '2014-10-31', { + get: function get() { + var model = require('../apis/docdb-2014-10-31.min.json'); + model.paginators = require('../apis/docdb-2014-10-31.paginators.json').pagination; + model.waiters = require('../apis/docdb-2014-10-31.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DocDB; diff --git a/node_modules/aws-sdk/clients/dynamodb.d.ts b/node_modules/aws-sdk/clients/dynamodb.d.ts new file mode 100644 index 0000000..1a33c94 --- /dev/null +++ b/node_modules/aws-sdk/clients/dynamodb.d.ts @@ -0,0 +1,2642 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {DynamoDBCustomizations} from '../lib/services/dynamodb'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {DocumentClient as document_client} from '../lib/dynamodb/document_client'; +import {Converter as converter} from '../lib/dynamodb/converter'; +interface Blob {} +declare class DynamoDB extends DynamoDBCustomizations { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DynamoDB.Types.ClientConfiguration) + config: Config & DynamoDB.Types.ClientConfiguration; + /** + * The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem 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 UnprocessedKeys. You can use this value to retry the operation starting with the next item to get. If you request more than 100 items BatchGetItem will return a ValidationException with the message "Too many items requested for the BatchGetItem call". 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 UnprocessedKeys 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. If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. 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. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables. In order to minimize response latency, BatchGetItem retrieves items in parallel. 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 ProjectionExpression parameter. 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 Capacity Units Calculations in the Amazon DynamoDB Developer Guide. + */ + batchGetItem(params: DynamoDB.Types.BatchGetItemInput, callback?: (err: AWSError, data: DynamoDB.Types.BatchGetItemOutput) => void): Request; + /** + * The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem 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 UnprocessedKeys. You can use this value to retry the operation starting with the next item to get. If you request more than 100 items BatchGetItem will return a ValidationException with the message "Too many items requested for the BatchGetItem call". 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 UnprocessedKeys 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. If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. 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. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables. In order to minimize response latency, BatchGetItem retrieves items in parallel. 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 ProjectionExpression parameter. 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 Capacity Units Calculations in the Amazon DynamoDB Developer Guide. + */ + batchGetItem(callback?: (err: AWSError, data: DynamoDB.Types.BatchGetItemOutput) => void): Request; + /** + * The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem 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. BatchWriteItem cannot update items. To update items, use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem 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 UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. 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. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, 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, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. 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, BatchWriteItem 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. 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. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB. + */ + batchWriteItem(params: DynamoDB.Types.BatchWriteItemInput, callback?: (err: AWSError, data: DynamoDB.Types.BatchWriteItemOutput) => void): Request; + /** + * The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem 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. BatchWriteItem cannot update items. To update items, use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem 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 UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. 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. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, 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, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. 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, BatchWriteItem 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. 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. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB. + */ + batchWriteItem(callback?: (err: AWSError, data: DynamoDB.Types.BatchWriteItemOutput) => void): Request; + /** + * Creates a backup for an existing table. 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. 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. You can call CreateBackup at a maximum rate of 50 times per second. All backups in DynamoDB work without consuming any provisioned throughput on the table. 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. Along with data, the following are also included on the backups: Global secondary indexes (GSIs) Local secondary indexes (LSIs) Streams Provisioned read and write capacity + */ + createBackup(params: DynamoDB.Types.CreateBackupInput, callback?: (err: AWSError, data: DynamoDB.Types.CreateBackupOutput) => void): Request; + /** + * Creates a backup for an existing table. 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. 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. You can call CreateBackup at a maximum rate of 50 times per second. All backups in DynamoDB work without consuming any provisioned throughput on the table. 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. Along with data, the following are also included on the backups: Global secondary indexes (GSIs) Local secondary indexes (LSIs) Streams Provisioned read and write capacity + */ + createBackup(callback?: (err: AWSError, data: DynamoDB.Types.CreateBackupOutput) => void): Request; + /** + * 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. If you want to add a new replica table to a global table, each of the following conditions must be true: The table must have the same primary key as all of the other replicas. The table must have the same name as all of the other replicas. The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item. None of the replica tables in the global table can contain any data. If global secondary indexes are specified, then the following conditions must also be met: The global secondary indexes must have the same name. The global secondary indexes must have the same hash key and sort key (if present). Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes. If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table. + */ + createGlobalTable(params: DynamoDB.Types.CreateGlobalTableInput, callback?: (err: AWSError, data: DynamoDB.Types.CreateGlobalTableOutput) => void): Request; + /** + * 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. If you want to add a new replica table to a global table, each of the following conditions must be true: The table must have the same primary key as all of the other replicas. The table must have the same name as all of the other replicas. The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item. None of the replica tables in the global table can contain any data. If global secondary indexes are specified, then the following conditions must also be met: The global secondary indexes must have the same name. The global secondary indexes must have the same hash key and sort key (if present). Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes. If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table. + */ + createGlobalTable(callback?: (err: AWSError, data: DynamoDB.Types.CreateGlobalTableOutput) => void): Request; + /** + * The CreateTable 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. CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table. You can optionally define secondary indexes on the new table, as part of the CreateTable 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 CREATING state at any given time. You can use the DescribeTable action to check the table status. + */ + createTable(params: DynamoDB.Types.CreateTableInput, callback?: (err: AWSError, data: DynamoDB.Types.CreateTableOutput) => void): Request; + /** + * The CreateTable 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. CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table. You can optionally define secondary indexes on the new table, as part of the CreateTable 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 CREATING state at any given time. You can use the DescribeTable action to check the table status. + */ + createTable(callback?: (err: AWSError, data: DynamoDB.Types.CreateTableOutput) => void): Request; + /** + * Deletes an existing backup of a table. You can call DeleteBackup at a maximum rate of 10 times per second. + */ + deleteBackup(params: DynamoDB.Types.DeleteBackupInput, callback?: (err: AWSError, data: DynamoDB.Types.DeleteBackupOutput) => void): Request; + /** + * Deletes an existing backup of a table. You can call DeleteBackup at a maximum rate of 10 times per second. + */ + deleteBackup(callback?: (err: AWSError, data: DynamoDB.Types.DeleteBackupOutput) => void): Request; + /** + * 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. In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter. Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. 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. + */ + deleteItem(params: DynamoDB.Types.DeleteItemInput, callback?: (err: AWSError, data: DynamoDB.Types.DeleteItemOutput) => void): Request; + /** + * 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. In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter. Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. 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. + */ + deleteItem(callback?: (err: AWSError, data: DynamoDB.Types.DeleteItemOutput) => void): Request; + /** + * The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned. DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. When you delete a table, any indexes on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours. Use the DescribeTable action to check the status of the table. + */ + deleteTable(params: DynamoDB.Types.DeleteTableInput, callback?: (err: AWSError, data: DynamoDB.Types.DeleteTableOutput) => void): Request; + /** + * The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned. DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. When you delete a table, any indexes on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours. Use the DescribeTable action to check the status of the table. + */ + deleteTable(callback?: (err: AWSError, data: DynamoDB.Types.DeleteTableOutput) => void): Request; + /** + * Describes an existing backup of a table. You can call DescribeBackup at a maximum rate of 10 times per second. + */ + describeBackup(params: DynamoDB.Types.DescribeBackupInput, callback?: (err: AWSError, data: DynamoDB.Types.DescribeBackupOutput) => void): Request; + /** + * Describes an existing backup of a table. You can call DescribeBackup at a maximum rate of 10 times per second. + */ + describeBackup(callback?: (err: AWSError, data: DynamoDB.Types.DescribeBackupOutput) => void): Request; + /** + * Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED. Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days. You can call DescribeContinuousBackups at a maximum rate of 10 times per second. + */ + describeContinuousBackups(params: DynamoDB.Types.DescribeContinuousBackupsInput, callback?: (err: AWSError, data: DynamoDB.Types.DescribeContinuousBackupsOutput) => void): Request; + /** + * Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED. Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days. You can call DescribeContinuousBackups at a maximum rate of 10 times per second. + */ + describeContinuousBackups(callback?: (err: AWSError, data: DynamoDB.Types.DescribeContinuousBackupsOutput) => void): Request; + /** + * Returns the regional endpoint information. + */ + describeEndpoints(params: DynamoDB.Types.DescribeEndpointsRequest, callback?: (err: AWSError, data: DynamoDB.Types.DescribeEndpointsResponse) => void): Request; + /** + * Returns the regional endpoint information. + */ + describeEndpoints(callback?: (err: AWSError, data: DynamoDB.Types.DescribeEndpointsResponse) => void): Request; + /** + * Returns information about the specified global table. + */ + describeGlobalTable(params: DynamoDB.Types.DescribeGlobalTableInput, callback?: (err: AWSError, data: DynamoDB.Types.DescribeGlobalTableOutput) => void): Request; + /** + * Returns information about the specified global table. + */ + describeGlobalTable(callback?: (err: AWSError, data: DynamoDB.Types.DescribeGlobalTableOutput) => void): Request; + /** + * Describes region specific settings for a global table. + */ + describeGlobalTableSettings(params: DynamoDB.Types.DescribeGlobalTableSettingsInput, callback?: (err: AWSError, data: DynamoDB.Types.DescribeGlobalTableSettingsOutput) => void): Request; + /** + * Describes region specific settings for a global table. + */ + describeGlobalTableSettings(callback?: (err: AWSError, data: DynamoDB.Types.DescribeGlobalTableSettingsOutput) => void): Request; + /** + * 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. 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 Limits page in the Amazon DynamoDB Developer Guide. Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits 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. For example, you could use one of the AWS SDKs to do the following: Call DescribeLimits for a particular region to obtain your current account limits on provisioned capacity there. 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. Call ListTables to obtain a list of all your DynamoDB tables. For each table name listed by ListTables, do the following: Call DescribeTable with the table name. Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables. 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. Report the account limits for that region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated. This will let you see whether you are getting close to your account-level limits. 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. 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. DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute. The DescribeLimits Request element has no content. + */ + describeLimits(params: DynamoDB.Types.DescribeLimitsInput, callback?: (err: AWSError, data: DynamoDB.Types.DescribeLimitsOutput) => void): Request; + /** + * 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. 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 Limits page in the Amazon DynamoDB Developer Guide. Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits 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. For example, you could use one of the AWS SDKs to do the following: Call DescribeLimits for a particular region to obtain your current account limits on provisioned capacity there. 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. Call ListTables to obtain a list of all your DynamoDB tables. For each table name listed by ListTables, do the following: Call DescribeTable with the table name. Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables. 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. Report the account limits for that region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated. This will let you see whether you are getting close to your account-level limits. 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. 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. DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute. The DescribeLimits Request element has no content. + */ + describeLimits(callback?: (err: AWSError, data: DynamoDB.Types.DescribeLimitsOutput) => void): Request; + /** + * 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. If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable 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 DescribeTable request again. + */ + describeTable(params: DynamoDB.Types.DescribeTableInput, callback?: (err: AWSError, data: DynamoDB.Types.DescribeTableOutput) => void): Request; + /** + * 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. If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable 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 DescribeTable request again. + */ + describeTable(callback?: (err: AWSError, data: DynamoDB.Types.DescribeTableOutput) => void): Request; + /** + * Gives a description of the Time to Live (TTL) status on the specified table. + */ + describeTimeToLive(params: DynamoDB.Types.DescribeTimeToLiveInput, callback?: (err: AWSError, data: DynamoDB.Types.DescribeTimeToLiveOutput) => void): Request; + /** + * Gives a description of the Time to Live (TTL) status on the specified table. + */ + describeTimeToLive(callback?: (err: AWSError, data: DynamoDB.Types.DescribeTimeToLiveOutput) => void): Request; + /** + * The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response. GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. + */ + getItem(params: DynamoDB.Types.GetItemInput, callback?: (err: AWSError, data: DynamoDB.Types.GetItemOutput) => void): Request; + /** + * The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response. GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. + */ + getItem(callback?: (err: AWSError, data: DynamoDB.Types.GetItemOutput) => void): Request; + /** + * List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page. In the request, start time is inclusive but end time is exclusive. Note that these limits are for the time at which the original backup was requested. You can call ListBackups a maximum of 5 times per second. + */ + listBackups(params: DynamoDB.Types.ListBackupsInput, callback?: (err: AWSError, data: DynamoDB.Types.ListBackupsOutput) => void): Request; + /** + * List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page. In the request, start time is inclusive but end time is exclusive. Note that these limits are for the time at which the original backup was requested. You can call ListBackups a maximum of 5 times per second. + */ + listBackups(callback?: (err: AWSError, data: DynamoDB.Types.ListBackupsOutput) => void): Request; + /** + * Lists all global tables that have a replica in the specified region. + */ + listGlobalTables(params: DynamoDB.Types.ListGlobalTablesInput, callback?: (err: AWSError, data: DynamoDB.Types.ListGlobalTablesOutput) => void): Request; + /** + * Lists all global tables that have a replica in the specified region. + */ + listGlobalTables(callback?: (err: AWSError, data: DynamoDB.Types.ListGlobalTablesOutput) => void): Request; + /** + * Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names. + */ + listTables(params: DynamoDB.Types.ListTablesInput, callback?: (err: AWSError, data: DynamoDB.Types.ListTablesOutput) => void): Request; + /** + * Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names. + */ + listTables(callback?: (err: AWSError, data: DynamoDB.Types.ListTablesOutput) => void): Request; + /** + * List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. + */ + listTagsOfResource(params: DynamoDB.Types.ListTagsOfResourceInput, callback?: (err: AWSError, data: DynamoDB.Types.ListTagsOfResourceOutput) => void): Request; + /** + * List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. + */ + listTagsOfResource(callback?: (err: AWSError, data: DynamoDB.Types.ListTagsOfResourceOutput) => void): Request; + /** + * 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 ReturnValues parameter. This topic provides general information about the PutItem API. For information on how to call the PutItem API using the AWS SDK in specific languages, see the following: PutItem in the AWS Command Line Interface PutItem in the AWS SDK for .NET PutItem in the AWS SDK for C++ PutItem in the AWS SDK for Go PutItem in the AWS SDK for Java PutItem in the AWS SDK for JavaScript PutItem in the AWS SDK for PHP V3 PutItem in the AWS SDK for Python PutItem in the AWS SDK for Ruby V2 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 ValidationException exception. To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists. For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide. + */ + putItem(params: DynamoDB.Types.PutItemInput, callback?: (err: AWSError, data: DynamoDB.Types.PutItemOutput) => void): Request; + /** + * 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 ReturnValues parameter. This topic provides general information about the PutItem API. For information on how to call the PutItem API using the AWS SDK in specific languages, see the following: PutItem in the AWS Command Line Interface PutItem in the AWS SDK for .NET PutItem in the AWS SDK for C++ PutItem in the AWS SDK for Go PutItem in the AWS SDK for Java PutItem in the AWS SDK for JavaScript PutItem in the AWS SDK for PHP V3 PutItem in the AWS SDK for Python PutItem in the AWS SDK for Ruby V2 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 ValidationException exception. To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists. For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide. + */ + putItem(callback?: (err: AWSError, data: DynamoDB.Types.PutItemOutput) => void): Request; + /** + * The Query 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). Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query 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 Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded. A Query 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. 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 FilterExpression. Query 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 ScanIndexForward parameter to false. A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide. FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression. A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out. 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 ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index. + */ + query(params: DynamoDB.Types.QueryInput, callback?: (err: AWSError, data: DynamoDB.Types.QueryOutput) => void): Request; + /** + * The Query 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). Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query 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 Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded. A Query 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. 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 FilterExpression. Query 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 ScanIndexForward parameter to false. A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide. FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression. A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out. 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 ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index. + */ + query(callback?: (err: AWSError, data: DynamoDB.Types.QueryOutput) => void): Request; + /** + * 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. You can call RestoreTableFromBackup at a maximum rate of 10 times per second. You must manually set up the following on the restored table: Auto scaling policies IAM policies Cloudwatch metrics and alarms Tags Stream settings Time to Live (TTL) settings + */ + restoreTableFromBackup(params: DynamoDB.Types.RestoreTableFromBackupInput, callback?: (err: AWSError, data: DynamoDB.Types.RestoreTableFromBackupOutput) => void): Request; + /** + * 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. You can call RestoreTableFromBackup at a maximum rate of 10 times per second. You must manually set up the following on the restored table: Auto scaling policies IAM policies Cloudwatch metrics and alarms Tags Stream settings Time to Live (TTL) settings + */ + restoreTableFromBackup(callback?: (err: AWSError, data: DynamoDB.Types.RestoreTableFromBackupOutput) => void): Request; + /** + * Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. 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. 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. Along with data, the following are also included on the new restored table using point in time recovery: Global secondary indexes (GSIs) Local secondary indexes (LSIs) Provisioned read and write capacity Encryption settings All these settings come from the current settings of the source table at the time of restore. You must manually set up the following on the restored table: Auto scaling policies IAM policies Cloudwatch metrics and alarms Tags Stream settings Time to Live (TTL) settings Point in time recovery settings + */ + restoreTableToPointInTime(params: DynamoDB.Types.RestoreTableToPointInTimeInput, callback?: (err: AWSError, data: DynamoDB.Types.RestoreTableToPointInTimeOutput) => void): Request; + /** + * Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. 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. 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. Along with data, the following are also included on the new restored table using point in time recovery: Global secondary indexes (GSIs) Local secondary indexes (LSIs) Provisioned read and write capacity Encryption settings All these settings come from the current settings of the source table at the time of restore. You must manually set up the following on the restored table: Auto scaling policies IAM policies Cloudwatch metrics and alarms Tags Stream settings Time to Live (TTL) settings Point in time recovery settings + */ + restoreTableToPointInTime(callback?: (err: AWSError, data: DynamoDB.Types.RestoreTableToPointInTimeOutput) => void): Request; + /** + * The Scan 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 FilterExpression operation. 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 LastEvaluatedKey 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. A single Scan operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide. Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide. Scan 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 Scan begins, you can set the ConsistentRead parameter to true. + */ + scan(params: DynamoDB.Types.ScanInput, callback?: (err: AWSError, data: DynamoDB.Types.ScanOutput) => void): Request; + /** + * The Scan 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 FilterExpression operation. 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 LastEvaluatedKey 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. A single Scan operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide. Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide. Scan 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 Scan begins, you can set the ConsistentRead parameter to true. + */ + scan(callback?: (err: AWSError, data: DynamoDB.Types.ScanOutput) => void): Request; + /** + * 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. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. + */ + tagResource(params: DynamoDB.Types.TagResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and region. A TransactGetItems call can contain up to 10 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or region. DynamoDB rejects the entire TransactGetItems request if any of the following is true: A conflicting operation is in the process of updating an item to be read. There is insufficient provisioned capacity for the transaction to be completed. There is a user error, such as an invalid data format. + */ + transactGetItems(params: DynamoDB.Types.TransactGetItemsInput, callback?: (err: AWSError, data: DynamoDB.Types.TransactGetItemsOutput) => void): Request; + /** + * TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and region. A TransactGetItems call can contain up to 10 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or region. DynamoDB rejects the entire TransactGetItems request if any of the following is true: A conflicting operation is in the process of updating an item to be read. There is insufficient provisioned capacity for the transaction to be completed. There is a user error, such as an invalid data format. + */ + transactGetItems(callback?: (err: AWSError, data: DynamoDB.Types.TransactGetItemsOutput) => void): Request; + /** + * TransactWriteItems is a synchronous write operation that groups up to 10 action requests. These actions can target items in different tables, but not in different AWS accounts or regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects: Put  —   Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. Update  —   Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. Delete  —   Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. ConditionCheck  —   Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. DynamoDB rejects the entire TransactWriteItems request if any of the following is true: A condition in one of the condition expressions is not met. A conflicting operation is in the process of updating the same item. There is insufficient provisioned capacity for the transaction to be completed. An item size becomes too large (bigger than 400 KB), a Local Secondary Index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction. There is a user error, such as an invalid data format. + */ + transactWriteItems(params: DynamoDB.Types.TransactWriteItemsInput, callback?: (err: AWSError, data: DynamoDB.Types.TransactWriteItemsOutput) => void): Request; + /** + * TransactWriteItems is a synchronous write operation that groups up to 10 action requests. These actions can target items in different tables, but not in different AWS accounts or regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects: Put  —   Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. Update  —   Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. Delete  —   Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. ConditionCheck  —   Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether or not to retrieve the item's attributes if the condition is not met. DynamoDB rejects the entire TransactWriteItems request if any of the following is true: A condition in one of the condition expressions is not met. A conflicting operation is in the process of updating the same item. There is insufficient provisioned capacity for the transaction to be completed. An item size becomes too large (bigger than 400 KB), a Local Secondary Index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction. There is a user error, such as an invalid data format. + */ + transactWriteItems(callback?: (err: AWSError, data: DynamoDB.Types.TransactWriteItemsOutput) => void): Request; + /** + * Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. + */ + untagResource(params: DynamoDB.Types.UntagResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED. Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.. + */ + updateContinuousBackups(params: DynamoDB.Types.UpdateContinuousBackupsInput, callback?: (err: AWSError, data: DynamoDB.Types.UpdateContinuousBackupsOutput) => void): Request; + /** + * UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED. Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.. + */ + updateContinuousBackups(callback?: (err: AWSError, data: DynamoDB.Types.UpdateContinuousBackupsOutput) => void): Request; + /** + * 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. Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas. If global secondary indexes are specified, then the following conditions must also be met: The global secondary indexes must have the same name. The global secondary indexes must have the same hash key and sort key (if present). The global secondary indexes must have the same provisioned and maximum write capacity units. + */ + updateGlobalTable(params: DynamoDB.Types.UpdateGlobalTableInput, callback?: (err: AWSError, data: DynamoDB.Types.UpdateGlobalTableOutput) => void): Request; + /** + * 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. Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas. If global secondary indexes are specified, then the following conditions must also be met: The global secondary indexes must have the same name. The global secondary indexes must have the same hash key and sort key (if present). The global secondary indexes must have the same provisioned and maximum write capacity units. + */ + updateGlobalTable(callback?: (err: AWSError, data: DynamoDB.Types.UpdateGlobalTableOutput) => void): Request; + /** + * Updates settings for a global table. + */ + updateGlobalTableSettings(params: DynamoDB.Types.UpdateGlobalTableSettingsInput, callback?: (err: AWSError, data: DynamoDB.Types.UpdateGlobalTableSettingsOutput) => void): Request; + /** + * Updates settings for a global table. + */ + updateGlobalTableSettings(callback?: (err: AWSError, data: DynamoDB.Types.UpdateGlobalTableSettingsOutput) => void): Request; + /** + * 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). You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter. + */ + updateItem(params: DynamoDB.Types.UpdateItemInput, callback?: (err: AWSError, data: DynamoDB.Types.UpdateItemOutput) => void): Request; + /** + * 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). You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter. + */ + updateItem(callback?: (err: AWSError, data: DynamoDB.Types.UpdateItemOutput) => void): Request; + /** + * Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. You can only perform one of the following operations at once: Modify the provisioned throughput settings of the table. Enable or disable Streams on the table. Remove a global secondary index from the table. Create a new global secondary index on the table. Once the index begins backfilling, you can use UpdateTable to perform other operations. UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete. + */ + updateTable(params: DynamoDB.Types.UpdateTableInput, callback?: (err: AWSError, data: DynamoDB.Types.UpdateTableOutput) => void): Request; + /** + * Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. You can only perform one of the following operations at once: Modify the provisioned throughput settings of the table. Enable or disable Streams on the table. Remove a global secondary index from the table. Create a new global secondary index on the table. Once the index begins backfilling, you can use UpdateTable to perform other operations. UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete. + */ + updateTable(callback?: (err: AWSError, data: DynamoDB.Types.UpdateTableOutput) => void): Request; + /** + * The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification; it may take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException. 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. The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC. DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. 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. 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. For more information, see Time To Live in the Amazon DynamoDB Developer Guide. + */ + updateTimeToLive(params: DynamoDB.Types.UpdateTimeToLiveInput, callback?: (err: AWSError, data: DynamoDB.Types.UpdateTimeToLiveOutput) => void): Request; + /** + * The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification; it may take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException. 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. The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC. DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. 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. 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. For more information, see Time To Live in the Amazon DynamoDB Developer Guide. + */ + updateTimeToLive(callback?: (err: AWSError, data: DynamoDB.Types.UpdateTimeToLiveOutput) => void): Request; + /** + * Waits for the tableExists state by periodically calling the underlying DynamoDB.describeTableoperation every 20 seconds (at most 25 times). + */ + waitFor(state: "tableExists", params: DynamoDB.Types.DescribeTableInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DynamoDB.Types.DescribeTableOutput) => void): Request; + /** + * Waits for the tableExists state by periodically calling the underlying DynamoDB.describeTableoperation every 20 seconds (at most 25 times). + */ + waitFor(state: "tableExists", callback?: (err: AWSError, data: DynamoDB.Types.DescribeTableOutput) => void): Request; + /** + * Waits for the tableNotExists state by periodically calling the underlying DynamoDB.describeTableoperation every 20 seconds (at most 25 times). + */ + waitFor(state: "tableNotExists", params: DynamoDB.Types.DescribeTableInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DynamoDB.Types.DescribeTableOutput) => void): Request; + /** + * Waits for the tableNotExists state by periodically calling the underlying DynamoDB.describeTableoperation every 20 seconds (at most 25 times). + */ + waitFor(state: "tableNotExists", callback?: (err: AWSError, data: DynamoDB.Types.DescribeTableOutput) => void): Request; +} +declare namespace DynamoDB { + export import DocumentClient = document_client; + export import Converter = converter; +} +declare namespace DynamoDB { + export type AttributeAction = "ADD"|"PUT"|"DELETE"|string; + export interface AttributeDefinition { + /** + * A name for the attribute. + */ + AttributeName: KeySchemaAttributeName; + /** + * The data type for the attribute, where: S - the attribute is of type String N - the attribute is of type Number B - the attribute is of type Binary + */ + AttributeType: ScalarAttributeType; + } + export type AttributeDefinitions = AttributeDefinition[]; + export type AttributeMap = {[key: string]: AttributeValue}; + export type AttributeName = string; + export type AttributeNameList = AttributeName[]; + export type AttributeUpdates = {[key: string]: AttributeValueUpdate}; + export interface AttributeValue { + /** + * An attribute of type String. For example: "S": "Hello" + */ + S?: StringAttributeValue; + /** + * An attribute of type Number. For example: "N": "123.45" 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. + */ + N?: NumberAttributeValue; + /** + * An attribute of type Binary. For example: "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" + */ + B?: BinaryAttributeValue; + /** + * An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo" ,"Zebra"] + */ + SS?: StringSetAttributeValue; + /** + * An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5", "3.14"] 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. + */ + NS?: NumberSetAttributeValue; + /** + * An attribute of type Binary Set. For example: "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="] + */ + BS?: BinarySetAttributeValue; + /** + * An attribute of type Map. For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}} + */ + M?: MapAttributeValue; + /** + * An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}] + */ + L?: ListAttributeValue; + /** + * An attribute of type Null. For example: "NULL": true + */ + NULL?: NullAttributeValue; + /** + * An attribute of type Boolean. For example: "BOOL": true + */ + BOOL?: BooleanAttributeValue; + } + export type AttributeValueList = AttributeValue[]; + export interface AttributeValueUpdate { + /** + * Represents the data for an attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide. + */ + Value?: AttributeValue; + /** + * Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table. If an item with the specified Key is found in the table: PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error. ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute: If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute. If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3. If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types. If no item with the specified Key is found: PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute. DELETE - Nothing happens; there is no attribute to delete. ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified. + */ + Action?: AttributeAction; + } + export interface AutoScalingPolicyDescription { + /** + * The name of the scaling policy. + */ + PolicyName?: AutoScalingPolicyName; + /** + * Represents a target tracking scaling policy configuration. + */ + TargetTrackingScalingPolicyConfiguration?: AutoScalingTargetTrackingScalingPolicyConfigurationDescription; + } + export type AutoScalingPolicyDescriptionList = AutoScalingPolicyDescription[]; + export type AutoScalingPolicyName = string; + export interface AutoScalingPolicyUpdate { + /** + * The name of the scaling policy. + */ + PolicyName?: AutoScalingPolicyName; + /** + * Represents a target tracking scaling policy configuration. + */ + TargetTrackingScalingPolicyConfiguration: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate; + } + export type AutoScalingRoleArn = string; + export interface AutoScalingSettingsDescription { + /** + * The minimum capacity units that a global table or global secondary index should be scaled down to. + */ + MinimumUnits?: PositiveLongObject; + /** + * The maximum capacity units that a global table or global secondary index should be scaled up to. + */ + MaximumUnits?: PositiveLongObject; + /** + * Disabled autoscaling for this global table or global secondary index. + */ + AutoScalingDisabled?: BooleanObject; + /** + * Role ARN used for configuring autoScaling policy. + */ + AutoScalingRoleArn?: String; + /** + * Information about the scaling policies. + */ + ScalingPolicies?: AutoScalingPolicyDescriptionList; + } + export interface AutoScalingSettingsUpdate { + /** + * The minimum capacity units that a global table or global secondary index should be scaled down to. + */ + MinimumUnits?: PositiveLongObject; + /** + * The maximum capacity units that a global table or global secondary index should be scaled up to. + */ + MaximumUnits?: PositiveLongObject; + /** + * Disabled autoscaling for this global table or global secondary index. + */ + AutoScalingDisabled?: BooleanObject; + /** + * Role ARN used for configuring autoscaling policy. + */ + AutoScalingRoleArn?: AutoScalingRoleArn; + /** + * The scaling policy to apply for scaling target global table or global secondary index capacity units. + */ + ScalingPolicyUpdate?: AutoScalingPolicyUpdate; + } + export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription { + /** + * Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false. + */ + DisableScaleIn?: BooleanObject; + /** + * The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately. + */ + ScaleInCooldown?: IntegerObject; + /** + * The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out. + */ + ScaleOutCooldown?: IntegerObject; + /** + * The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). + */ + TargetValue: Double; + } + export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate { + /** + * Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false. + */ + DisableScaleIn?: BooleanObject; + /** + * The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately. + */ + ScaleInCooldown?: IntegerObject; + /** + * The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out. + */ + ScaleOutCooldown?: IntegerObject; + /** + * The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). + */ + TargetValue: Double; + } + export type Backfilling = boolean; + export type BackupArn = string; + export type BackupCreationDateTime = Date; + export interface BackupDescription { + /** + * Contains the details of the backup created for the table. + */ + BackupDetails?: BackupDetails; + /** + * Contains the details of the table when the backup was created. + */ + SourceTableDetails?: SourceTableDetails; + /** + * Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL. + */ + SourceTableFeatureDetails?: SourceTableFeatureDetails; + } + export interface BackupDetails { + /** + * ARN associated with the backup. + */ + BackupArn: BackupArn; + /** + * Name of the requested backup. + */ + BackupName: BackupName; + /** + * Size of the backup in bytes. + */ + BackupSizeBytes?: BackupSizeBytes; + /** + * Backup can be in one of the following states: CREATING, ACTIVE, DELETED. + */ + BackupStatus: BackupStatus; + /** + * BackupType: USER - You create and manage these using the on-demand backup feature. SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. AWS_BACKUP - On-demand backup created by you from AWS Backup service. + */ + BackupType: BackupType; + /** + * Time at which the backup was created. This is the request time of the backup. + */ + BackupCreationDateTime: BackupCreationDateTime; + /** + * Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation. + */ + BackupExpiryDateTime?: _Date; + } + export type BackupName = string; + export type BackupSizeBytes = number; + export type BackupStatus = "CREATING"|"DELETED"|"AVAILABLE"|string; + export type BackupSummaries = BackupSummary[]; + export interface BackupSummary { + /** + * Name of the table. + */ + TableName?: TableName; + /** + * Unique identifier for the table. + */ + TableId?: TableId; + /** + * ARN associated with the table. + */ + TableArn?: TableArn; + /** + * ARN associated with the backup. + */ + BackupArn?: BackupArn; + /** + * Name of the specified backup. + */ + BackupName?: BackupName; + /** + * Time at which the backup was created. + */ + BackupCreationDateTime?: BackupCreationDateTime; + /** + * Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation. + */ + BackupExpiryDateTime?: _Date; + /** + * Backup can be in one of the following states: CREATING, ACTIVE, DELETED. + */ + BackupStatus?: BackupStatus; + /** + * BackupType: USER - You create and manage these using the on-demand backup feature. SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. AWS_BACKUP - On-demand backup created by you from AWS Backup service. + */ + BackupType?: BackupType; + /** + * Size of the backup in bytes. + */ + BackupSizeBytes?: BackupSizeBytes; + } + export type BackupType = "USER"|"SYSTEM"|"AWS_BACKUP"|string; + export type BackupTypeFilter = "USER"|"SYSTEM"|"AWS_BACKUP"|"ALL"|string; + export type BackupsInputLimit = number; + export interface BatchGetItemInput { + /** + * A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request. Each element in the map of items to retrieve consists of the following: ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used. ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value. ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. + */ + RequestItems: BatchGetRequestMap; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + } + export interface BatchGetItemOutput { + /** + * A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value. + */ + Responses?: BatchGetResponseMap; + /** + * A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section. Each element consists of: Keys - An array of primary key attribute values that define specific items in the table. ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result. ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used. If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map. + */ + UnprocessedKeys?: BatchGetRequestMap; + /** + * The read capacity units consumed by the entire BatchGetItem operation. Each element consists of: TableName - The table that consumed the provisioned throughput. CapacityUnits - The total number of capacity units consumed. + */ + ConsumedCapacity?: ConsumedCapacityMultiple; + } + export type BatchGetRequestMap = {[key: string]: KeysAndAttributes}; + export type BatchGetResponseMap = {[key: string]: ItemList}; + export interface BatchWriteItemInput { + /** + * A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following: DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement: Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement: Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. + */ + RequestItems: BatchWriteItemRequestMap; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned. + */ + ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics; + } + export interface BatchWriteItemOutput { + /** + * A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section. Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest). DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement: Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement: Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map. + */ + UnprocessedItems?: BatchWriteItemRequestMap; + /** + * A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations. Each entry consists of the following subelements: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item. SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + */ + ItemCollectionMetrics?: ItemCollectionMetricsPerTable; + /** + * The capacity units consumed by the entire BatchWriteItem operation. Each element consists of: TableName - The table that consumed the provisioned throughput. CapacityUnits - The total number of capacity units consumed. + */ + ConsumedCapacity?: ConsumedCapacityMultiple; + } + export type BatchWriteItemRequestMap = {[key: string]: WriteRequests}; + export type BillingMode = "PROVISIONED"|"PAY_PER_REQUEST"|string; + export interface BillingModeSummary { + /** + * Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. + */ + BillingMode?: BillingMode; + /** + * Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode. + */ + LastUpdateToPayPerRequestDateTime?: _Date; + } + export type BinaryAttributeValue = Buffer|Uint8Array|Blob|string; + export type BinarySetAttributeValue = BinaryAttributeValue[]; + export type BooleanAttributeValue = boolean; + export type BooleanObject = boolean; + export interface Capacity { + /** + * The total number of read capacity units consumed on a table or an index. + */ + ReadCapacityUnits?: ConsumedCapacityUnits; + /** + * The total number of write capacity units consumed on a table or an index. + */ + WriteCapacityUnits?: ConsumedCapacityUnits; + /** + * The total number of capacity units consumed on a table or an index. + */ + CapacityUnits?: ConsumedCapacityUnits; + } + export type ClientRequestToken = string; + export type ComparisonOperator = "EQ"|"NE"|"IN"|"LE"|"LT"|"GE"|"GT"|"BETWEEN"|"NOT_NULL"|"NULL"|"CONTAINS"|"NOT_CONTAINS"|"BEGINS_WITH"|string; + export interface Condition { + /** + * One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. + */ + AttributeValueList?: AttributeValueList; + /** + * A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. EQ : Equal. EQ is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. NE : Not equal. NE is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps. This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator. NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps. This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator. CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). IN : Checks for matching elements in a list. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide. + */ + ComparisonOperator: ComparisonOperator; + } + export interface ConditionCheck { + /** + * The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute. + */ + Key: Key; + /** + * Name of the table for the check item request. + */ + TableName: TableName; + /** + * A condition that must be satisfied in order for a conditional update to succeed. + */ + ConditionExpression: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + /** + * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD. + */ + ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure; + } + export type ConditionExpression = string; + export type ConditionalOperator = "AND"|"OR"|string; + export type ConsistentRead = boolean; + export interface ConsumedCapacity { + /** + * The name of the table that was affected by the operation. + */ + TableName?: TableName; + /** + * The total number of capacity units consumed by the operation. + */ + CapacityUnits?: ConsumedCapacityUnits; + /** + * The total number of read capacity units consumed by the operation. + */ + ReadCapacityUnits?: ConsumedCapacityUnits; + /** + * The total number of write capacity units consumed by the operation. + */ + WriteCapacityUnits?: ConsumedCapacityUnits; + /** + * The amount of throughput consumed on the table affected by the operation. + */ + Table?: Capacity; + /** + * The amount of throughput consumed on each local index affected by the operation. + */ + LocalSecondaryIndexes?: SecondaryIndexesCapacityMap; + /** + * The amount of throughput consumed on each global index affected by the operation. + */ + GlobalSecondaryIndexes?: SecondaryIndexesCapacityMap; + } + export type ConsumedCapacityMultiple = ConsumedCapacity[]; + export type ConsumedCapacityUnits = number; + export interface ContinuousBackupsDescription { + /** + * ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED + */ + ContinuousBackupsStatus: ContinuousBackupsStatus; + /** + * The description of the point in time recovery settings applied to the table. + */ + PointInTimeRecoveryDescription?: PointInTimeRecoveryDescription; + } + export type ContinuousBackupsStatus = "ENABLED"|"DISABLED"|string; + export interface CreateBackupInput { + /** + * The name of the table. + */ + TableName: TableName; + /** + * Specified name for the backup. + */ + BackupName: BackupName; + } + export interface CreateBackupOutput { + /** + * Contains the details of the backup created for the table. + */ + BackupDetails?: BackupDetails; + } + export interface CreateGlobalSecondaryIndexAction { + /** + * The name of the global secondary index to be created. + */ + IndexName: IndexName; + /** + * The key schema for the global secondary index. + */ + KeySchema: KeySchema; + /** + * Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + */ + Projection: Projection; + /** + * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide. + */ + ProvisionedThroughput?: ProvisionedThroughput; + } + export interface CreateGlobalTableInput { + /** + * The global table name. + */ + GlobalTableName: TableName; + /** + * The regions where the global table needs to be created. + */ + ReplicationGroup: ReplicaList; + } + export interface CreateGlobalTableOutput { + /** + * Contains the details of the global table. + */ + GlobalTableDescription?: GlobalTableDescription; + } + export interface CreateReplicaAction { + /** + * The region of the replica to be added. + */ + RegionName: RegionName; + } + export interface CreateTableInput { + /** + * An array of attributes that describe the key schema for the table and indexes. + */ + AttributeDefinitions: AttributeDefinitions; + /** + * The name of the table to create. + */ + TableName: TableName; + /** + * Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide. Each KeySchemaElement in the array is composed of: AttributeName - The name of this key attribute. KeyType - The role that the key attribute will assume: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE. For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide. + */ + KeySchema: KeySchema; + /** + * One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following: IndexName - The name of the local secondary index. Must be unique only for this table. KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. + */ + LocalSecondaryIndexes?: LocalSecondaryIndexList; + /** + * One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following: IndexName - The name of the global secondary index. Must be unique only for this table. KeySchema - Specifies the key schema for the global secondary index. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. + */ + GlobalSecondaryIndexes?: GlobalSecondaryIndexList; + /** + * Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. + */ + BillingMode?: BillingMode; + /** + * Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide. + */ + ProvisionedThroughput?: ProvisionedThroughput; + /** + * The settings for DynamoDB Streams on the table. These settings consist of: StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false). StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified item are written to the stream. NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream. + */ + StreamSpecification?: StreamSpecification; + /** + * Represents the settings used to enable server-side encryption. + */ + SSESpecification?: SSESpecification; + /** + * A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB. + */ + Tags?: TagList; + } + export interface CreateTableOutput { + /** + * Represents the properties of the table. + */ + TableDescription?: TableDescription; + } + export type _Date = Date; + export interface Delete { + /** + * The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute. + */ + Key: Key; + /** + * Name of the table in which the item to be deleted resides. + */ + TableName: TableName; + /** + * A condition that must be satisfied in order for a conditional delete to succeed. + */ + ConditionExpression?: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + /** + * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD. + */ + ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure; + } + export interface DeleteBackupInput { + /** + * The ARN associated with the backup. + */ + BackupArn: BackupArn; + } + export interface DeleteBackupOutput { + /** + * Contains the description of the backup created for the table. + */ + BackupDescription?: BackupDescription; + } + export interface DeleteGlobalSecondaryIndexAction { + /** + * The name of the global secondary index to be deleted. + */ + IndexName: IndexName; + } + export interface DeleteItemInput { + /** + * The name of the table from which to delete the item. + */ + TableName: TableName; + /** + * A map of attribute names to AttributeValue objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. + */ + Key: Key; + /** + * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. + */ + Expected?: ExpectedAttributeMap; + /** + * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. + */ + ConditionalOperator?: ConditionalOperator; + /** + * Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.) ALL_OLD - The content of the old item is returned. The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD. + */ + ReturnValues?: ReturnValue; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned. + */ + ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics; + /** + * A condition that must be satisfied in order for a conditional DeleteItem to succeed. An expression can contain any of the following: Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size These function names are case-sensitive. Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN Logical operators: AND | OR | NOT For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ConditionExpression?: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + } + export interface DeleteItemOutput { + /** + * A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request. + */ + Attributes?: AttributeMap; + /** + * The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide. + */ + ConsumedCapacity?: ConsumedCapacity; + /** + * Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + */ + ItemCollectionMetrics?: ItemCollectionMetrics; + } + export interface DeleteReplicaAction { + /** + * The region of the replica to be removed. + */ + RegionName: RegionName; + } + export interface DeleteRequest { + /** + * A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. + */ + Key: Key; + } + export interface DeleteTableInput { + /** + * The name of the table to delete. + */ + TableName: TableName; + } + export interface DeleteTableOutput { + /** + * Represents the properties of a table. + */ + TableDescription?: TableDescription; + } + export interface DescribeBackupInput { + /** + * The ARN associated with the backup. + */ + BackupArn: BackupArn; + } + export interface DescribeBackupOutput { + /** + * Contains the description of the backup created for the table. + */ + BackupDescription?: BackupDescription; + } + export interface DescribeContinuousBackupsInput { + /** + * Name of the table for which the customer wants to check the continuous backups and point in time recovery settings. + */ + TableName: TableName; + } + export interface DescribeContinuousBackupsOutput { + /** + * Represents the continuous backups and point in time recovery settings on the table. + */ + ContinuousBackupsDescription?: ContinuousBackupsDescription; + } + export interface DescribeEndpointsRequest { + } + export interface DescribeEndpointsResponse { + /** + * List of endpoints. + */ + Endpoints: Endpoints; + } + export interface DescribeGlobalTableInput { + /** + * The name of the global table. + */ + GlobalTableName: TableName; + } + export interface DescribeGlobalTableOutput { + /** + * Contains the details of the global table. + */ + GlobalTableDescription?: GlobalTableDescription; + } + export interface DescribeGlobalTableSettingsInput { + /** + * The name of the global table to describe. + */ + GlobalTableName: TableName; + } + export interface DescribeGlobalTableSettingsOutput { + /** + * The name of the global table. + */ + GlobalTableName?: TableName; + /** + * The region specific settings for the global table. + */ + ReplicaSettings?: ReplicaSettingsDescriptionList; + } + export interface DescribeLimitsInput { + } + export interface DescribeLimitsOutput { + /** + * The maximum total read capacity units that your account allows you to provision across all of your tables in this region. + */ + AccountMaxReadCapacityUnits?: PositiveLongObject; + /** + * The maximum total write capacity units that your account allows you to provision across all of your tables in this region. + */ + AccountMaxWriteCapacityUnits?: PositiveLongObject; + /** + * 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). + */ + TableMaxReadCapacityUnits?: PositiveLongObject; + /** + * 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). + */ + TableMaxWriteCapacityUnits?: PositiveLongObject; + } + export interface DescribeTableInput { + /** + * The name of the table to describe. + */ + TableName: TableName; + } + export interface DescribeTableOutput { + /** + * The properties of the table. + */ + Table?: TableDescription; + } + export interface DescribeTimeToLiveInput { + /** + * The name of the table to be described. + */ + TableName: TableName; + } + export interface DescribeTimeToLiveOutput { + /** + * + */ + TimeToLiveDescription?: TimeToLiveDescription; + } + export type Double = number; + export interface Endpoint { + /** + * IP address of the endpoint. + */ + Address: String; + /** + * Endpoint cache time to live (TTL) value. + */ + CachePeriodInMinutes: Long; + } + export type Endpoints = Endpoint[]; + export type ExpectedAttributeMap = {[key: string]: ExpectedAttributeValue}; + export interface ExpectedAttributeValue { + /** + * Represents the data for the expected attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide. + */ + Value?: AttributeValue; + /** + * Causes DynamoDB to evaluate the value before attempting a conditional operation: If Exists is true, 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 ConditionCheckFailedException. If Exists is false, 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 ConditionCheckFailedException. The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied. DynamoDB returns a ValidationException if: Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.) Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.) + */ + Exists?: BooleanObject; + /** + * A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. EQ : Equal. EQ is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. NE : Not equal. NE is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps. This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator. NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps. This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator. CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). IN : Checks for matching elements in a list. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} + */ + ComparisonOperator?: ComparisonOperator; + /** + * One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide. + */ + AttributeValueList?: AttributeValueList; + } + export type ExpressionAttributeNameMap = {[key: string]: AttributeName}; + export type ExpressionAttributeNameVariable = string; + export type ExpressionAttributeValueMap = {[key: string]: AttributeValue}; + export type ExpressionAttributeValueVariable = string; + export type FilterConditionMap = {[key: string]: Condition}; + export interface Get { + /** + * A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve. + */ + Key: Key; + /** + * The name of the table from which to retrieve the specified item. + */ + TableName: TableName; + /** + * A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result. + */ + ProjectionExpression?: ProjectionExpression; + /** + * One or more substitution tokens for attribute names in the ProjectionExpression parameter. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + } + export interface GetItemInput { + /** + * The name of the table containing the requested item. + */ + TableName: TableName; + /** + * A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. + */ + Key: Key; + /** + * This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. + */ + AttributesToGet?: AttributeNameList; + /** + * Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. + */ + ConsistentRead?: ConsistentRead; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ProjectionExpression?: ProjectionExpression; + /** + * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + } + export interface GetItemOutput { + /** + * A map of attribute names to AttributeValue objects, as specified by ProjectionExpression. + */ + Item?: AttributeMap; + /** + * The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide. + */ + ConsumedCapacity?: ConsumedCapacity; + } + export interface GlobalSecondaryIndex { + /** + * The name of the global secondary index. The name must be unique among all other indexes on this table. + */ + IndexName: IndexName; + /** + * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + */ + KeySchema: KeySchema; + /** + * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + */ + Projection: Projection; + /** + * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide. + */ + ProvisionedThroughput?: ProvisionedThroughput; + } + export interface GlobalSecondaryIndexDescription { + /** + * The name of the global secondary index. + */ + IndexName?: IndexName; + /** + * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + */ + KeySchema?: KeySchema; + /** + * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + */ + Projection?: Projection; + /** + * The current state of the global secondary index: CREATING - The index is being created. UPDATING - The index is being updated. DELETING - The index is being deleted. ACTIVE - The index is ready for use. + */ + IndexStatus?: IndexStatus; + /** + * Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false. For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output. + */ + Backfilling?: Backfilling; + /** + * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide. + */ + ProvisionedThroughput?: ProvisionedThroughputDescription; + /** + * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + */ + IndexSizeBytes?: Long; + /** + * The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + */ + ItemCount?: Long; + /** + * The Amazon Resource Name (ARN) that uniquely identifies the index. + */ + IndexArn?: String; + } + export type GlobalSecondaryIndexDescriptionList = GlobalSecondaryIndexDescription[]; + export interface GlobalSecondaryIndexInfo { + /** + * The name of the global secondary index. + */ + IndexName?: IndexName; + /** + * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + */ + KeySchema?: KeySchema; + /** + * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + */ + Projection?: Projection; + /** + * Represents the provisioned throughput settings for the specified global secondary index. + */ + ProvisionedThroughput?: ProvisionedThroughput; + } + export type GlobalSecondaryIndexList = GlobalSecondaryIndex[]; + export interface GlobalSecondaryIndexUpdate { + /** + * The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index. + */ + Update?: UpdateGlobalSecondaryIndexAction; + /** + * The parameters required for creating a global secondary index on an existing table: IndexName KeySchema AttributeDefinitions Projection ProvisionedThroughput + */ + Create?: CreateGlobalSecondaryIndexAction; + /** + * The name of an existing global secondary index to be removed. + */ + Delete?: DeleteGlobalSecondaryIndexAction; + } + export type GlobalSecondaryIndexUpdateList = GlobalSecondaryIndexUpdate[]; + export type GlobalSecondaryIndexes = GlobalSecondaryIndexInfo[]; + export interface GlobalTable { + /** + * The global table name. + */ + GlobalTableName?: TableName; + /** + * The regions where the global table has replicas. + */ + ReplicationGroup?: ReplicaList; + } + export type GlobalTableArnString = string; + export interface GlobalTableDescription { + /** + * The regions where the global table has replicas. + */ + ReplicationGroup?: ReplicaDescriptionList; + /** + * The unique identifier of the global table. + */ + GlobalTableArn?: GlobalTableArnString; + /** + * The creation time of the global table. + */ + CreationDateTime?: _Date; + /** + * The current state of the global table: CREATING - The global table is being created. UPDATING - The global table is being updated. DELETING - The global table is being deleted. ACTIVE - The global table is ready for use. + */ + GlobalTableStatus?: GlobalTableStatus; + /** + * The global table name. + */ + GlobalTableName?: TableName; + } + export interface GlobalTableGlobalSecondaryIndexSettingsUpdate { + /** + * The name of the global secondary index. The name must be unique among all other indexes on this table. + */ + IndexName: IndexName; + /** + * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. + */ + ProvisionedWriteCapacityUnits?: PositiveLongObject; + /** + * AutoScaling settings for managing a global secondary index's write capacity units. + */ + ProvisionedWriteCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate; + } + export type GlobalTableGlobalSecondaryIndexSettingsUpdateList = GlobalTableGlobalSecondaryIndexSettingsUpdate[]; + export type GlobalTableList = GlobalTable[]; + export type GlobalTableStatus = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|string; + export type IndexName = string; + export type IndexStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|string; + export type Integer = number; + export type IntegerObject = number; + export type ItemCollectionKeyAttributeMap = {[key: string]: AttributeValue}; + export interface ItemCollectionMetrics { + /** + * The partition key value of the item collection. This value is the same as the partition key value of the item. + */ + ItemCollectionKey?: ItemCollectionKeyAttributeMap; + /** + * An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + */ + SizeEstimateRangeGB?: ItemCollectionSizeEstimateRange; + } + export type ItemCollectionMetricsMultiple = ItemCollectionMetrics[]; + export type ItemCollectionMetricsPerTable = {[key: string]: ItemCollectionMetricsMultiple}; + export type ItemCollectionSizeEstimateBound = number; + export type ItemCollectionSizeEstimateRange = ItemCollectionSizeEstimateBound[]; + export type ItemCount = number; + export type ItemList = AttributeMap[]; + export interface ItemResponse { + /** + * Map of attribute data consisting of the data type and attribute value. + */ + Item?: AttributeMap; + } + export type ItemResponseList = ItemResponse[]; + export type KMSMasterKeyArn = string; + export type KMSMasterKeyId = string; + export type Key = {[key: string]: AttributeValue}; + export type KeyConditions = {[key: string]: Condition}; + export type KeyExpression = string; + export type KeyList = Key[]; + export type KeySchema = KeySchemaElement[]; + export type KeySchemaAttributeName = string; + export interface KeySchemaElement { + /** + * The name of a key attribute. + */ + AttributeName: KeySchemaAttributeName; + /** + * The role that this key attribute will assume: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + */ + KeyType: KeyType; + } + export type KeyType = "HASH"|"RANGE"|string; + export interface KeysAndAttributes { + /** + * The primary key attribute values that define the items and the attributes associated with the items. + */ + Keys: KeyList; + /** + * This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide. + */ + AttributesToGet?: AttributeNameList; + /** + * The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used. + */ + ConsistentRead?: ConsistentRead; + /** + * A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ProjectionExpression?: ProjectionExpression; + /** + * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + } + export type ListAttributeValue = AttributeValue[]; + export interface ListBackupsInput { + /** + * The backups from the table specified by TableName are listed. + */ + TableName?: TableName; + /** + * Maximum number of backups to return at once. + */ + Limit?: BackupsInputLimit; + /** + * Only backups created after this time are listed. TimeRangeLowerBound is inclusive. + */ + TimeRangeLowerBound?: TimeRangeLowerBound; + /** + * Only backups created before this time are listed. TimeRangeUpperBound is exclusive. + */ + TimeRangeUpperBound?: TimeRangeUpperBound; + /** + * LastEvaluatedBackupArn is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results. + */ + ExclusiveStartBackupArn?: BackupArn; + /** + * The backups from the table specified by BackupType are listed. Where BackupType can be: USER - On-demand backup created by you. SYSTEM - On-demand backup automatically created by DynamoDB. ALL - All types of on-demand backups (USER and SYSTEM). + */ + BackupType?: BackupTypeFilter; + } + export interface ListBackupsOutput { + /** + * List of BackupSummary objects. + */ + BackupSummaries?: BackupSummaries; + /** + * The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results. If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved. If LastEvaluatedBackupArn is not empty, this may or may not indicate there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned. + */ + LastEvaluatedBackupArn?: BackupArn; + } + export interface ListGlobalTablesInput { + /** + * The first global table name that this operation will evaluate. + */ + ExclusiveStartGlobalTableName?: TableName; + /** + * The maximum number of table names to return. + */ + Limit?: PositiveIntegerObject; + /** + * Lists the global tables in a specific region. + */ + RegionName?: RegionName; + } + export interface ListGlobalTablesOutput { + /** + * List of global table names. + */ + GlobalTables?: GlobalTableList; + /** + * Last evaluated global table name. + */ + LastEvaluatedGlobalTableName?: TableName; + } + export interface ListTablesInput { + /** + * The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results. + */ + ExclusiveStartTableName?: TableName; + /** + * A maximum number of table names to return. If this parameter is not specified, the limit is 100. + */ + Limit?: ListTablesInputLimit; + } + export type ListTablesInputLimit = number; + export interface ListTablesOutput { + /** + * The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results. + */ + TableNames?: TableNameList; + /** + * The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned. If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved. + */ + LastEvaluatedTableName?: TableName; + } + export interface ListTagsOfResourceInput { + /** + * The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN). + */ + ResourceArn: ResourceArnString; + /** + * An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results. + */ + NextToken?: NextTokenString; + } + export interface ListTagsOfResourceOutput { + /** + * The tags currently associated with the Amazon DynamoDB resource. + */ + Tags?: TagList; + /** + * If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value. + */ + NextToken?: NextTokenString; + } + export interface LocalSecondaryIndex { + /** + * The name of the local secondary index. The name must be unique among all other indexes on this table. + */ + IndexName: IndexName; + /** + * The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + */ + KeySchema: KeySchema; + /** + * Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + */ + Projection: Projection; + } + export interface LocalSecondaryIndexDescription { + /** + * Represents the name of the local secondary index. + */ + IndexName?: IndexName; + /** + * The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + */ + KeySchema?: KeySchema; + /** + * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + */ + Projection?: Projection; + /** + * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + */ + IndexSizeBytes?: Long; + /** + * The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + */ + ItemCount?: Long; + /** + * The Amazon Resource Name (ARN) that uniquely identifies the index. + */ + IndexArn?: String; + } + export type LocalSecondaryIndexDescriptionList = LocalSecondaryIndexDescription[]; + export interface LocalSecondaryIndexInfo { + /** + * Represents the name of the local secondary index. + */ + IndexName?: IndexName; + /** + * The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + */ + KeySchema?: KeySchema; + /** + * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + */ + Projection?: Projection; + } + export type LocalSecondaryIndexList = LocalSecondaryIndex[]; + export type LocalSecondaryIndexes = LocalSecondaryIndexInfo[]; + export type Long = number; + export type MapAttributeValue = {[key: string]: AttributeValue}; + export type NextTokenString = string; + export type NonKeyAttributeName = string; + export type NonKeyAttributeNameList = NonKeyAttributeName[]; + export type NonNegativeLongObject = number; + export type NullAttributeValue = boolean; + export type NumberAttributeValue = string; + export type NumberSetAttributeValue = NumberAttributeValue[]; + export interface PointInTimeRecoveryDescription { + /** + * The current state of point in time recovery: ENABLING - Point in time recovery is being enabled. ENABLED - Point in time recovery is enabled. DISABLED - Point in time recovery is disabled. + */ + PointInTimeRecoveryStatus?: PointInTimeRecoveryStatus; + /** + * 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. + */ + EarliestRestorableDateTime?: _Date; + /** + * LatestRestorableDateTime is typically 5 minutes before the current time. + */ + LatestRestorableDateTime?: _Date; + } + export interface PointInTimeRecoverySpecification { + /** + * Indicates whether point in time recovery is enabled (true) or disabled (false) on the table. + */ + PointInTimeRecoveryEnabled: BooleanObject; + } + export type PointInTimeRecoveryStatus = "ENABLED"|"DISABLED"|string; + export type PositiveIntegerObject = number; + export type PositiveLongObject = number; + export interface Projection { + /** + * The set of attributes that are projected into the index: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. + */ + ProjectionType?: ProjectionType; + /** + * Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. + */ + NonKeyAttributes?: NonKeyAttributeNameList; + } + export type ProjectionExpression = string; + export type ProjectionType = "ALL"|"KEYS_ONLY"|"INCLUDE"|string; + export interface ProvisionedThroughput { + /** + * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. + */ + ReadCapacityUnits: PositiveLongObject; + /** + * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. + */ + WriteCapacityUnits: PositiveLongObject; + } + export interface ProvisionedThroughputDescription { + /** + * The date and time of the last provisioned throughput increase for this table. + */ + LastIncreaseDateTime?: _Date; + /** + * The date and time of the last provisioned throughput decrease for this table. + */ + LastDecreaseDateTime?: _Date; + /** + * The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide. + */ + NumberOfDecreasesToday?: PositiveLongObject; + /** + * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second. + */ + ReadCapacityUnits?: NonNegativeLongObject; + /** + * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. + */ + WriteCapacityUnits?: NonNegativeLongObject; + } + export interface Put { + /** + * A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema. + */ + Item: PutItemInputAttributeMap; + /** + * Name of the table in which to write the item. + */ + TableName: TableName; + /** + * A condition that must be satisfied in order for a conditional update to succeed. + */ + ConditionExpression?: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + /** + * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD. + */ + ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure; + } + export interface PutItemInput { + /** + * The name of the table to contain the item. + */ + TableName: TableName; + /** + * A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. Each element in the Item map is an AttributeValue object. + */ + Item: PutItemInputAttributeMap; + /** + * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. + */ + Expected?: ExpectedAttributeMap; + /** + * Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.) ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned. The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD. + */ + ReturnValues?: ReturnValue; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned. + */ + ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics; + /** + * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. + */ + ConditionalOperator?: ConditionalOperator; + /** + * A condition that must be satisfied in order for a conditional PutItem operation to succeed. An expression can contain any of the following: Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size These function names are case-sensitive. Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN Logical operators: AND | OR | NOT For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ConditionExpression?: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + } + export type PutItemInputAttributeMap = {[key: string]: AttributeValue}; + export interface PutItemOutput { + /** + * The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value. + */ + Attributes?: AttributeMap; + /** + * The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide. + */ + ConsumedCapacity?: ConsumedCapacity; + /** + * Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + */ + ItemCollectionMetrics?: ItemCollectionMetrics; + } + export interface PutRequest { + /** + * A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema. + */ + Item: PutItemInputAttributeMap; + } + export interface QueryInput { + /** + * The name of the table containing the requested items. + */ + TableName: TableName; + /** + * 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 IndexName parameter, you must also provide TableName. + */ + IndexName?: IndexName; + /** + * The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES. COUNT - Returns the number of matching items, rather than the matching items themselves. SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select. If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.) If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error. + */ + Select?: Select; + /** + * This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. + */ + AttributesToGet?: AttributeNameList; + /** + * The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide. + */ + Limit?: PositiveIntegerObject; + /** + * Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException. + */ + ConsistentRead?: ConsistentRead; + /** + * This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide. + */ + KeyConditions?: KeyConditions; + /** + * This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide. + */ + QueryFilter?: FilterConditionMap; + /** + * This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. + */ + ConditionalOperator?: ConditionalOperator; + /** + * Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order. 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. If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client. + */ + ScanIndexForward?: BooleanObject; + /** + * The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed. + */ + ExclusiveStartKey?: Key; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ProjectionExpression?: ProjectionExpression; + /** + * A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned. A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key. A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide. + */ + FilterExpression?: ConditionExpression; + /** + * The condition that specifies the key value(s) for items to be retrieved by the Query action. The condition must perform an equality test on a single partition key value. The condition can optionally perform one of several comparison tests on a single sort key value. This allows Query to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values. The partition key equality test is required, and must be specified in the following format: partitionKeyName = :partitionkeyval If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key: partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval Valid comparisons for the sort key condition are as follows: sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval. sortKeyName < :sortkeyval - true if the sort key value is less than :sortkeyval. sortKeyName <= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval. sortKeyName > :sortkeyval - true if the sort key value is greater than :sortkeyval. sortKeyName >= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval. sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2. begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive. Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime. You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word: Size = :myval To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows: #S = :myval For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide. For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide. + */ + KeyConditionExpression?: KeyExpression; + /** + * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + } + export interface QueryOutput { + /** + * An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute. + */ + Items?: ItemList; + /** + * The number of items in the response. If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied. If you did not use a filter in the request, then Count and ScannedCount are the same. + */ + Count?: Integer; + /** + * The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide. If you did not use a filter in the request, then ScannedCount is the same as Count. + */ + ScannedCount?: Integer; + /** + * The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty. + */ + LastEvaluatedKey?: Key; + /** + * The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide. + */ + ConsumedCapacity?: ConsumedCapacity; + } + export type RegionName = string; + export interface Replica { + /** + * The region where the replica needs to be created. + */ + RegionName?: RegionName; + } + export interface ReplicaDescription { + /** + * The name of the region. + */ + RegionName?: RegionName; + } + export type ReplicaDescriptionList = ReplicaDescription[]; + export interface ReplicaGlobalSecondaryIndexSettingsDescription { + /** + * The name of the global secondary index. The name must be unique among all other indexes on this table. + */ + IndexName: IndexName; + /** + * The current status of the global secondary index: CREATING - The global secondary index is being created. UPDATING - The global secondary index is being updated. DELETING - The global secondary index is being deleted. ACTIVE - The global secondary index is ready for use. + */ + IndexStatus?: IndexStatus; + /** + * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. + */ + ProvisionedReadCapacityUnits?: PositiveLongObject; + /** + * Autoscaling settings for a global secondary index replica's read capacity units. + */ + ProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription; + /** + * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. + */ + ProvisionedWriteCapacityUnits?: PositiveLongObject; + /** + * AutoScaling settings for a global secondary index replica's write capacity units. + */ + ProvisionedWriteCapacityAutoScalingSettings?: AutoScalingSettingsDescription; + } + export type ReplicaGlobalSecondaryIndexSettingsDescriptionList = ReplicaGlobalSecondaryIndexSettingsDescription[]; + export interface ReplicaGlobalSecondaryIndexSettingsUpdate { + /** + * The name of the global secondary index. The name must be unique among all other indexes on this table. + */ + IndexName: IndexName; + /** + * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. + */ + ProvisionedReadCapacityUnits?: PositiveLongObject; + /** + * Autoscaling settings for managing a global secondary index replica's read capacity units. + */ + ProvisionedReadCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate; + } + export type ReplicaGlobalSecondaryIndexSettingsUpdateList = ReplicaGlobalSecondaryIndexSettingsUpdate[]; + export type ReplicaList = Replica[]; + export interface ReplicaSettingsDescription { + /** + * The region name of the replica. + */ + RegionName: RegionName; + /** + * The current state of the region: CREATING - The region is being created. UPDATING - The region is being updated. DELETING - The region is being deleted. ACTIVE - The region is ready for use. + */ + ReplicaStatus?: ReplicaStatus; + /** + * The read/write capacity mode of the replica. + */ + ReplicaBillingModeSummary?: BillingModeSummary; + /** + * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. + */ + ReplicaProvisionedReadCapacityUnits?: NonNegativeLongObject; + /** + * Autoscaling settings for a global table replica's read capacity units. + */ + ReplicaProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription; + /** + * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. + */ + ReplicaProvisionedWriteCapacityUnits?: NonNegativeLongObject; + /** + * AutoScaling settings for a global table replica's write capacity units. + */ + ReplicaProvisionedWriteCapacityAutoScalingSettings?: AutoScalingSettingsDescription; + /** + * Replica global secondary index settings for the global table. + */ + ReplicaGlobalSecondaryIndexSettings?: ReplicaGlobalSecondaryIndexSettingsDescriptionList; + } + export type ReplicaSettingsDescriptionList = ReplicaSettingsDescription[]; + export interface ReplicaSettingsUpdate { + /** + * The region of the replica to be added. + */ + RegionName: RegionName; + /** + * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. + */ + ReplicaProvisionedReadCapacityUnits?: PositiveLongObject; + /** + * Autoscaling settings for managing a global table replica's read capacity units. + */ + ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate; + /** + * Represents the settings of a global secondary index for a global table that will be modified. + */ + ReplicaGlobalSecondaryIndexSettingsUpdate?: ReplicaGlobalSecondaryIndexSettingsUpdateList; + } + export type ReplicaSettingsUpdateList = ReplicaSettingsUpdate[]; + export type ReplicaStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|string; + export interface ReplicaUpdate { + /** + * The parameters required for creating a replica on an existing global table. + */ + Create?: CreateReplicaAction; + /** + * The name of the existing replica to be removed. + */ + Delete?: DeleteReplicaAction; + } + export type ReplicaUpdateList = ReplicaUpdate[]; + export type ResourceArnString = string; + export type RestoreInProgress = boolean; + export interface RestoreSummary { + /** + * ARN of the backup from which the table was restored. + */ + SourceBackupArn?: BackupArn; + /** + * ARN of the source table of the backup that is being restored. + */ + SourceTableArn?: TableArn; + /** + * Point in time or source backup time. + */ + RestoreDateTime: _Date; + /** + * Indicates if a restore is in progress or not. + */ + RestoreInProgress: RestoreInProgress; + } + export interface RestoreTableFromBackupInput { + /** + * The name of the new table to which the backup must be restored. + */ + TargetTableName: TableName; + /** + * The ARN associated with the backup. + */ + BackupArn: BackupArn; + } + export interface RestoreTableFromBackupOutput { + /** + * The description of the table created from an existing backup. + */ + TableDescription?: TableDescription; + } + export interface RestoreTableToPointInTimeInput { + /** + * Name of the source table that is being restored. + */ + SourceTableName: TableName; + /** + * The name of the new table to which it must be restored to. + */ + TargetTableName: TableName; + /** + * Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time. + */ + UseLatestRestorableTime?: BooleanObject; + /** + * Time in the past to restore the table to. + */ + RestoreDateTime?: _Date; + } + export interface RestoreTableToPointInTimeOutput { + /** + * Represents the properties of a table. + */ + TableDescription?: TableDescription; + } + export type ReturnConsumedCapacity = "INDEXES"|"TOTAL"|"NONE"|string; + export type ReturnItemCollectionMetrics = "SIZE"|"NONE"|string; + export type ReturnValue = "NONE"|"ALL_OLD"|"UPDATED_OLD"|"ALL_NEW"|"UPDATED_NEW"|string; + export type ReturnValuesOnConditionCheckFailure = "ALL_OLD"|"NONE"|string; + export interface SSEDescription { + /** + * The current state of server-side encryption: ENABLING - Server-side encryption is being enabled. ENABLED - Server-side encryption is enabled. DISABLING - Server-side encryption is being disabled. DISABLED - Server-side encryption is disabled. UPDATING - Server-side encryption is being updated. + */ + Status?: SSEStatus; + /** + * Server-side encryption type: AES256 - Server-side encryption which uses the AES256 algorithm (not applicable). KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply). + */ + SSEType?: SSEType; + /** + * The KMS master key ARN used for the KMS encryption. + */ + KMSMasterKeyArn?: KMSMasterKeyArn; + } + export type SSEEnabled = boolean; + export interface SSESpecification { + /** + * Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK. + */ + Enabled?: SSEEnabled; + /** + * Server-side encryption type: AES256 - Server-side encryption which uses the AES256 algorithm (not applicable). KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply). + */ + SSEType?: SSEType; + /** + * The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS Master Key alias/aws/dynamodb. + */ + KMSMasterKeyId?: KMSMasterKeyId; + } + export type SSEStatus = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"|"UPDATING"|string; + export type SSEType = "AES256"|"KMS"|string; + export type ScalarAttributeType = "S"|"N"|"B"|string; + export interface ScanInput { + /** + * The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs. + */ + TableName: TableName; + /** + * 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 IndexName parameter, you must also provide TableName. + */ + IndexName?: IndexName; + /** + * This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. + */ + AttributesToGet?: AttributeNameList; + /** + * The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide. + */ + Limit?: PositiveIntegerObject; + /** + * The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES. COUNT - Returns the number of matching items, rather than the matching items themselves. SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select. If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.) If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error. + */ + Select?: Select; + /** + * This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. + */ + ScanFilter?: FilterConditionMap; + /** + * This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. + */ + ConditionalOperator?: ConditionalOperator; + /** + * The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey. + */ + ExclusiveStartKey?: Key; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel. If you specify TotalSegments, you must also specify Segment. + */ + TotalSegments?: ScanTotalSegments; + /** + * For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on. The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation. The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments. If you provide Segment, you must also provide TotalSegments. + */ + Segment?: ScanSegment; + /** + * A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ProjectionExpression?: ProjectionExpression; + /** + * A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned. A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide. + */ + FilterExpression?: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + /** + * A Boolean value that determines the read consistency model during the scan: If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response. The default setting for ConsistentRead is false. The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException. + */ + ConsistentRead?: ConsistentRead; + } + export interface ScanOutput { + /** + * An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute. + */ + Items?: ItemList; + /** + * The number of items in the response. If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied. If you did not use a filter in the request, then Count is the same as ScannedCount. + */ + Count?: Integer; + /** + * The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide. If you did not use a filter in the request, then ScannedCount is the same as Count. + */ + ScannedCount?: Integer; + /** + * The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty. + */ + LastEvaluatedKey?: Key; + /** + * The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide. + */ + ConsumedCapacity?: ConsumedCapacity; + } + export type ScanSegment = number; + export type ScanTotalSegments = number; + export type SecondaryIndexesCapacityMap = {[key: string]: Capacity}; + export type Select = "ALL_ATTRIBUTES"|"ALL_PROJECTED_ATTRIBUTES"|"SPECIFIC_ATTRIBUTES"|"COUNT"|string; + export interface SourceTableDetails { + /** + * The name of the table for which the backup was created. + */ + TableName: TableName; + /** + * Unique identifier for the table for which the backup was created. + */ + TableId: TableId; + /** + * ARN of the table for which backup was created. + */ + TableArn?: TableArn; + /** + * Size of the table in bytes. Please note this is an approximate value. + */ + TableSizeBytes?: Long; + /** + * Schema of the table. + */ + KeySchema: KeySchema; + /** + * Time when the source table was created. + */ + TableCreationDateTime: TableCreationDateTime; + /** + * Read IOPs and Write IOPS on the table when the backup was created. + */ + ProvisionedThroughput: ProvisionedThroughput; + /** + * Number of items in the table. Please note this is an approximate value. + */ + ItemCount?: ItemCount; + /** + * Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. + */ + BillingMode?: BillingMode; + } + export interface SourceTableFeatureDetails { + /** + * Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup. + */ + LocalSecondaryIndexes?: LocalSecondaryIndexes; + /** + * Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup. + */ + GlobalSecondaryIndexes?: GlobalSecondaryIndexes; + /** + * Stream settings on the table when the backup was created. + */ + StreamDescription?: StreamSpecification; + /** + * Time to Live settings on the table when the backup was created. + */ + TimeToLiveDescription?: TimeToLiveDescription; + /** + * The description of the server-side encryption status on the table when the backup was created. + */ + SSEDescription?: SSEDescription; + } + export type StreamArn = string; + export type StreamEnabled = boolean; + export interface StreamSpecification { + /** + * Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. + */ + StreamEnabled?: StreamEnabled; + /** + * When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified item are written to the stream. NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream. + */ + StreamViewType?: StreamViewType; + } + export type StreamViewType = "NEW_IMAGE"|"OLD_IMAGE"|"NEW_AND_OLD_IMAGES"|"KEYS_ONLY"|string; + export type String = string; + export type StringAttributeValue = string; + export type StringSetAttributeValue = StringAttributeValue[]; + export type TableArn = string; + export type TableCreationDateTime = Date; + export interface TableDescription { + /** + * An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of: AttributeName - The name of the attribute. AttributeType - The data type for the attribute. + */ + AttributeDefinitions?: AttributeDefinitions; + /** + * The name of the table. + */ + TableName?: TableName; + /** + * The primary key structure for the table. Each KeySchemaElement consists of: AttributeName - The name of the attribute. KeyType - The role of the attribute: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. + */ + KeySchema?: KeySchema; + /** + * The current state of the table: CREATING - The table is being created. UPDATING - The table is being updated. DELETING - The table is being deleted. ACTIVE - The table is ready for use. + */ + TableStatus?: TableStatus; + /** + * The date and time when the table was created, in UNIX epoch time format. + */ + CreationDateTime?: _Date; + /** + * The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. + */ + ProvisionedThroughput?: ProvisionedThroughputDescription; + /** + * The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + */ + TableSizeBytes?: Long; + /** + * The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. + */ + ItemCount?: Long; + /** + * The Amazon Resource Name (ARN) that uniquely identifies the table. + */ + TableArn?: String; + /** + * Unique identifier for the table for which the backup was created. + */ + TableId?: TableId; + /** + * Contains the details for the read/write capacity mode. + */ + BillingModeSummary?: BillingModeSummary; + /** + * Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: IndexName - The name of the local secondary index. KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the DELETING state, no information about indexes will be returned. + */ + LocalSecondaryIndexes?: LocalSecondaryIndexDescriptionList; + /** + * The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.) IndexName - The name of the global secondary index. IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. IndexStatus - The current status of the global secondary index: CREATING - The index is being created. UPDATING - The index is being updated. DELETING - The index is being deleted. ACTIVE - The index is ready for use. ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the DELETING state, no information about indexes will be returned. + */ + GlobalSecondaryIndexes?: GlobalSecondaryIndexDescriptionList; + /** + * The current DynamoDB Streams configuration for the table. + */ + StreamSpecification?: StreamSpecification; + /** + * A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: the AWS customer ID. the table name. the StreamLabel. + */ + LatestStreamLabel?: String; + /** + * The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. + */ + LatestStreamArn?: StreamArn; + /** + * Contains details for the restore. + */ + RestoreSummary?: RestoreSummary; + /** + * The description of the server-side encryption status on the specified table. + */ + SSEDescription?: SSEDescription; + } + export type TableId = string; + export type TableName = string; + export type TableNameList = TableName[]; + export type TableStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|string; + export interface Tag { + /** + * The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. + */ + Key: TagKeyString; + /** + * The value of the tag. Tag values are case-sensitive and can be null. + */ + Value: TagValueString; + } + export type TagKeyList = TagKeyString[]; + export type TagKeyString = string; + export type TagList = Tag[]; + export interface TagResourceInput { + /** + * Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN). + */ + ResourceArn: ResourceArnString; + /** + * The tags to be assigned to the Amazon DynamoDB resource. + */ + Tags: TagList; + } + export type TagValueString = string; + export type TimeRangeLowerBound = Date; + export type TimeRangeUpperBound = Date; + export type TimeToLiveAttributeName = string; + export interface TimeToLiveDescription { + /** + * The Time to Live status for the table. + */ + TimeToLiveStatus?: TimeToLiveStatus; + /** + * The name of the Time to Live attribute for items in the table. + */ + AttributeName?: TimeToLiveAttributeName; + } + export type TimeToLiveEnabled = boolean; + export interface TimeToLiveSpecification { + /** + * Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table. + */ + Enabled: TimeToLiveEnabled; + /** + * The name of the Time to Live attribute used to store the expiration time for items in the table. + */ + AttributeName: TimeToLiveAttributeName; + } + export type TimeToLiveStatus = "ENABLING"|"DISABLING"|"ENABLED"|"DISABLED"|string; + export interface TransactGetItem { + /** + * Contains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve. + */ + Get: Get; + } + export type TransactGetItemList = TransactGetItem[]; + export interface TransactGetItemsInput { + /** + * An ordered array of up to 10 TransactGetItem objects, each of which contains a Get structure. + */ + TransactItems: TransactGetItemList; + /** + * A value of TOTAL causes consumed capacity information to be returned, and a value of NONE prevents that information from being returned. No other value is valid. + */ + ReturnConsumedCapacity?: ReturnConsumedCapacity; + } + export interface TransactGetItemsOutput { + /** + * If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table. + */ + ConsumedCapacity?: ConsumedCapacityMultiple; + /** + * An ordered array of up to 10 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item. If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map. + */ + Responses?: ItemResponseList; + } + export interface TransactWriteItem { + /** + * A request to perform a check item operation. + */ + ConditionCheck?: ConditionCheck; + /** + * A request to perform a PutItem operation. + */ + Put?: Put; + /** + * A request to perform a DeleteItem operation. + */ + Delete?: Delete; + /** + * A request to perform an UpdateItem operation. + */ + Update?: Update; + } + export type TransactWriteItemList = TransactWriteItem[]; + export interface TransactWriteItemsInput { + /** + * An ordered array of up to 10 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and region, and no two of them can operate on the same item. + */ + TransactItems: TransactWriteItemList; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to NONE (the default), no statistics are returned. + */ + ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics; + /** + * Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call. Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls may not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes, and subsequent TransactWriteItems calls with the same client token return the amount of read capacity units consumed in reading the item. A client request token is valid for 10 minutes after the first request that uses it completes. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes or the result may not be idempotent. If you submit a request with the same client token but a change in other parameters within the 10 minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface TransactWriteItemsOutput { + /** + * The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter. + */ + ConsumedCapacity?: ConsumedCapacityMultiple; + /** + * A list of tables that were processed by TransactWriteItems and, for each table, information about any item collections that were affected by individual UpdateItem, PutItem or DeleteItem operations. + */ + ItemCollectionMetrics?: ItemCollectionMetricsPerTable; + } + export interface UntagResourceInput { + /** + * The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN). + */ + ResourceArn: ResourceArnString; + /** + * A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource. + */ + TagKeys: TagKeyList; + } + export interface Update { + /** + * The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. + */ + Key: Key; + /** + * An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. + */ + UpdateExpression: UpdateExpression; + /** + * Name of the table for the UpdateItem request. + */ + TableName: TableName; + /** + * A condition that must be satisfied in order for a conditional update to succeed. + */ + ConditionExpression?: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + /** + * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW. + */ + ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure; + } + export interface UpdateContinuousBackupsInput { + /** + * The name of the table. + */ + TableName: TableName; + /** + * Represents the settings used to enable point in time recovery. + */ + PointInTimeRecoverySpecification: PointInTimeRecoverySpecification; + } + export interface UpdateContinuousBackupsOutput { + /** + * Represents the continuous backups and point in time recovery settings on the table. + */ + ContinuousBackupsDescription?: ContinuousBackupsDescription; + } + export type UpdateExpression = string; + export interface UpdateGlobalSecondaryIndexAction { + /** + * The name of the global secondary index to be updated. + */ + IndexName: IndexName; + /** + * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide. + */ + ProvisionedThroughput: ProvisionedThroughput; + } + export interface UpdateGlobalTableInput { + /** + * The global table name. + */ + GlobalTableName: TableName; + /** + * A list of regions that should be added or removed from the global table. + */ + ReplicaUpdates: ReplicaUpdateList; + } + export interface UpdateGlobalTableOutput { + /** + * Contains the details of the global table. + */ + GlobalTableDescription?: GlobalTableDescription; + } + export interface UpdateGlobalTableSettingsInput { + /** + * The name of the global table + */ + GlobalTableName: TableName; + /** + * The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode. + */ + GlobalTableBillingMode?: BillingMode; + /** + * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. + */ + GlobalTableProvisionedWriteCapacityUnits?: PositiveLongObject; + /** + * AutoScaling settings for managing provisioned write capacity for the global table. + */ + GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate; + /** + * Represents the settings of a global secondary index for a global table that will be modified. + */ + GlobalTableGlobalSecondaryIndexSettingsUpdate?: GlobalTableGlobalSecondaryIndexSettingsUpdateList; + /** + * Represents the settings for a global table in a region that will be modified. + */ + ReplicaSettingsUpdate?: ReplicaSettingsUpdateList; + } + export interface UpdateGlobalTableSettingsOutput { + /** + * The name of the global table. + */ + GlobalTableName?: TableName; + /** + * The region specific settings for the global table. + */ + ReplicaSettings?: ReplicaSettingsDescriptionList; + } + export interface UpdateItemInput { + /** + * The name of the table containing the item to update. + */ + TableName: TableName; + /** + * The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. + */ + Key: Key; + /** + * This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide. + */ + AttributeUpdates?: AttributeUpdates; + /** + * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. + */ + Expected?: ExpectedAttributeMap; + /** + * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. + */ + ConditionalOperator?: ConditionalOperator; + /** + * Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.) ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation. UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation. ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation. UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The values returned are strongly consistent. + */ + ReturnValues?: ReturnValue; + ReturnConsumedCapacity?: ReturnConsumedCapacity; + /** + * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned. + */ + ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics; + /** + * An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for UpdateExpression. SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val SET supports the following functions: if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item. list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. These function names are case-sensitive. REMOVE - Removes one or more attributes from an item. ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute: If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute. If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3. If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes. DELETE - Deletes an element from a set. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error. The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes. You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5 For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide. + */ + UpdateExpression?: UpdateExpression; + /** + * A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following: Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size These function names are case-sensitive. Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN Logical operators: AND | OR | NOT For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ConditionExpression?: ConditionExpression; + /** + * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeNames?: ExpressionAttributeNameMap; + /** + * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide. + */ + ExpressionAttributeValues?: ExpressionAttributeValueMap; + } + export interface UpdateItemOutput { + /** + * A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter. The Attributes map is only present if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute. + */ + Attributes?: AttributeMap; + /** + * The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide. + */ + ConsumedCapacity?: ConsumedCapacity; + /** + * Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + */ + ItemCollectionMetrics?: ItemCollectionMetrics; + } + export interface UpdateTableInput { + /** + * An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index. + */ + AttributeDefinitions?: AttributeDefinitions; + /** + * The name of the table to be updated. + */ + TableName: TableName; + /** + * Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes. PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. + */ + BillingMode?: BillingMode; + /** + * The new provisioned throughput settings for the specified table or index. + */ + ProvisionedThroughput?: ProvisionedThroughput; + /** + * An array of one or more global secondary indexes for the table. For each index in the array, you can request one action: Create - add a new global secondary index to the table. Update - modify the provisioned throughput settings of an existing global secondary index. Delete - remove a global secondary index from the table. For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide. + */ + GlobalSecondaryIndexUpdates?: GlobalSecondaryIndexUpdateList; + /** + * Represents the DynamoDB Streams configuration for the table. You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream. + */ + StreamSpecification?: StreamSpecification; + /** + * The new server-side encryption settings for the specified table. + */ + SSESpecification?: SSESpecification; + } + export interface UpdateTableOutput { + /** + * Represents the properties of the table. + */ + TableDescription?: TableDescription; + } + export interface UpdateTimeToLiveInput { + /** + * The name of the table to be configured. + */ + TableName: TableName; + /** + * Represents the settings used to enable or disable Time to Live for the specified table. + */ + TimeToLiveSpecification: TimeToLiveSpecification; + } + export interface UpdateTimeToLiveOutput { + /** + * Represents the output of an UpdateTimeToLive operation. + */ + TimeToLiveSpecification?: TimeToLiveSpecification; + } + export interface WriteRequest { + /** + * A request to perform a PutItem operation. + */ + PutRequest?: PutRequest; + /** + * A request to perform a DeleteItem operation. + */ + DeleteRequest?: DeleteRequest; + } + export type WriteRequests = WriteRequest[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2011-12-05"|"2012-08-10"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DynamoDB client. + */ + export import Types = DynamoDB; +} +export = DynamoDB; diff --git a/node_modules/aws-sdk/clients/dynamodb.js b/node_modules/aws-sdk/clients/dynamodb.js new file mode 100644 index 0000000..e18ce52 --- /dev/null +++ b/node_modules/aws-sdk/clients/dynamodb.js @@ -0,0 +1,30 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['dynamodb'] = {}; +AWS.DynamoDB = Service.defineService('dynamodb', ['2011-12-05', '2012-08-10']); +require('../lib/services/dynamodb'); +Object.defineProperty(apiLoader.services['dynamodb'], '2011-12-05', { + get: function get() { + var model = require('../apis/dynamodb-2011-12-05.min.json'); + model.paginators = require('../apis/dynamodb-2011-12-05.paginators.json').pagination; + model.waiters = require('../apis/dynamodb-2011-12-05.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['dynamodb'], '2012-08-10', { + get: function get() { + var model = require('../apis/dynamodb-2012-08-10.min.json'); + model.paginators = require('../apis/dynamodb-2012-08-10.paginators.json').pagination; + model.waiters = require('../apis/dynamodb-2012-08-10.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DynamoDB; diff --git a/node_modules/aws-sdk/clients/dynamodbstreams.d.ts b/node_modules/aws-sdk/clients/dynamodbstreams.d.ts new file mode 100644 index 0000000..0f2079a --- /dev/null +++ b/node_modules/aws-sdk/clients/dynamodbstreams.d.ts @@ -0,0 +1,381 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class DynamoDBStreams extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: DynamoDBStreams.Types.ClientConfiguration) + config: Config & DynamoDBStreams.Types.ClientConfiguration; + /** + * Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. You can call DescribeStream at a maximum rate of 10 times per second. Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data. + */ + describeStream(params: DynamoDBStreams.Types.DescribeStreamInput, callback?: (err: AWSError, data: DynamoDBStreams.Types.DescribeStreamOutput) => void): Request; + /** + * Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. You can call DescribeStream at a maximum rate of 10 times per second. Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data. + */ + describeStream(callback?: (err: AWSError, data: DynamoDBStreams.Types.DescribeStreamOutput) => void): Request; + /** + * Retrieves the stream records from a given shard. Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first. + */ + getRecords(params: DynamoDBStreams.Types.GetRecordsInput, callback?: (err: AWSError, data: DynamoDBStreams.Types.GetRecordsOutput) => void): Request; + /** + * Retrieves the stream records from a given shard. Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first. + */ + getRecords(callback?: (err: AWSError, data: DynamoDBStreams.Types.GetRecordsOutput) => void): Request; + /** + * Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard. A shard iterator expires 15 minutes after it is returned to the requester. + */ + getShardIterator(params: DynamoDBStreams.Types.GetShardIteratorInput, callback?: (err: AWSError, data: DynamoDBStreams.Types.GetShardIteratorOutput) => void): Request; + /** + * Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard. A shard iterator expires 15 minutes after it is returned to the requester. + */ + getShardIterator(callback?: (err: AWSError, data: DynamoDBStreams.Types.GetShardIteratorOutput) => void): Request; + /** + * Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table. You can call ListStreams at a maximum rate of 5 times per second. + */ + listStreams(params: DynamoDBStreams.Types.ListStreamsInput, callback?: (err: AWSError, data: DynamoDBStreams.Types.ListStreamsOutput) => void): Request; + /** + * Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table. You can call ListStreams at a maximum rate of 5 times per second. + */ + listStreams(callback?: (err: AWSError, data: DynamoDBStreams.Types.ListStreamsOutput) => void): Request; +} +declare namespace DynamoDBStreams { + export type AttributeMap = {[key: string]: AttributeValue}; + export type AttributeName = string; + export interface AttributeValue { + /** + * A String data type. + */ + S?: StringAttributeValue; + /** + * A Number data type. + */ + N?: NumberAttributeValue; + /** + * A Binary data type. + */ + B?: BinaryAttributeValue; + /** + * A String Set data type. + */ + SS?: StringSetAttributeValue; + /** + * A Number Set data type. + */ + NS?: NumberSetAttributeValue; + /** + * A Binary Set data type. + */ + BS?: BinarySetAttributeValue; + /** + * A Map data type. + */ + M?: MapAttributeValue; + /** + * A List data type. + */ + L?: ListAttributeValue; + /** + * A Null data type. + */ + NULL?: NullAttributeValue; + /** + * A Boolean data type. + */ + BOOL?: BooleanAttributeValue; + } + export type BinaryAttributeValue = Buffer|Uint8Array|Blob|string; + export type BinarySetAttributeValue = BinaryAttributeValue[]; + export type BooleanAttributeValue = boolean; + export type _Date = Date; + export interface DescribeStreamInput { + /** + * The Amazon Resource Name (ARN) for the stream. + */ + StreamArn: StreamArn; + /** + * The maximum number of shard objects to return. The upper limit is 100. + */ + Limit?: PositiveIntegerObject; + /** + * The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation. + */ + ExclusiveStartShardId?: ShardId; + } + export interface DescribeStreamOutput { + /** + * A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards. + */ + StreamDescription?: StreamDescription; + } + export interface GetRecordsInput { + /** + * A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard. + */ + ShardIterator: ShardIterator; + /** + * The maximum number of records to return from the shard. The upper limit is 1000. + */ + Limit?: PositiveIntegerObject; + } + export interface GetRecordsOutput { + /** + * The stream records from the shard, which were retrieved using the shard iterator. + */ + Records?: RecordList; + /** + * The next position in the shard from which to start sequentially reading stream records. If set to null, the shard has been closed and the requested iterator will not return any more data. + */ + NextShardIterator?: ShardIterator; + } + export interface GetShardIteratorInput { + /** + * The Amazon Resource Name (ARN) for the stream. + */ + StreamArn: StreamArn; + /** + * The identifier of the shard. The iterator will be returned for this shard ID. + */ + ShardId: ShardId; + /** + * Determines how the shard iterator is used to start reading stream records from the shard: AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number. AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number. TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard. + */ + ShardIteratorType: ShardIteratorType; + /** + * The sequence number of a stream record in the shard from which to start reading. + */ + SequenceNumber?: SequenceNumber; + } + export interface GetShardIteratorOutput { + /** + * The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard. + */ + ShardIterator?: ShardIterator; + } + export interface Identity { + /** + * A unique identifier for the entity that made the call. For Time To Live, the principalId is "dynamodb.amazonaws.com". + */ + PrincipalId?: String; + /** + * The type of the identity. For Time To Live, the type is "Service". + */ + Type?: String; + } + export type KeySchema = KeySchemaElement[]; + export type KeySchemaAttributeName = string; + export interface KeySchemaElement { + /** + * The name of a key attribute. + */ + AttributeName: KeySchemaAttributeName; + /** + * The attribute data, consisting of the data type and the attribute value itself. + */ + KeyType: KeyType; + } + export type KeyType = "HASH"|"RANGE"|string; + export type ListAttributeValue = AttributeValue[]; + export interface ListStreamsInput { + /** + * If this parameter is provided, then only the streams associated with this table name are returned. + */ + TableName?: TableName; + /** + * The maximum number of streams to return. The upper limit is 100. + */ + Limit?: PositiveIntegerObject; + /** + * The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation. + */ + ExclusiveStartStreamArn?: StreamArn; + } + export interface ListStreamsOutput { + /** + * A list of stream descriptors associated with the current account and endpoint. + */ + Streams?: StreamList; + /** + * The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty. + */ + LastEvaluatedStreamArn?: StreamArn; + } + export type MapAttributeValue = {[key: string]: AttributeValue}; + export type NullAttributeValue = boolean; + export type NumberAttributeValue = string; + export type NumberSetAttributeValue = NumberAttributeValue[]; + export type OperationType = "INSERT"|"MODIFY"|"REMOVE"|string; + export type PositiveIntegerObject = number; + export type PositiveLongObject = number; + export interface Record { + /** + * A globally unique identifier for the event that was recorded in this stream record. + */ + eventID?: String; + /** + * The type of data modification that was performed on the DynamoDB table: INSERT - a new item was added to the table. MODIFY - one or more of an existing item's attributes were modified. REMOVE - the item was deleted from the table + */ + eventName?: OperationType; + /** + * The version number of the stream record format. This number is updated whenever the structure of Record is modified. Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves. + */ + eventVersion?: String; + /** + * The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb. + */ + eventSource?: String; + /** + * The region in which the GetRecords request was received. + */ + awsRegion?: String; + /** + * The main body of the stream record, containing all of the DynamoDB-specific fields. + */ + dynamodb?: StreamRecord; + /** + * Items that are deleted by the Time to Live process after expiration have the following fields: Records[].userIdentity.type "Service" Records[].userIdentity.principalId "dynamodb.amazonaws.com" + */ + userIdentity?: Identity; + } + export type RecordList = Record[]; + export type SequenceNumber = string; + export interface SequenceNumberRange { + /** + * The first sequence number. + */ + StartingSequenceNumber?: SequenceNumber; + /** + * The last sequence number. + */ + EndingSequenceNumber?: SequenceNumber; + } + export interface Shard { + /** + * The system-generated identifier for this shard. + */ + ShardId?: ShardId; + /** + * The range of possible sequence numbers for the shard. + */ + SequenceNumberRange?: SequenceNumberRange; + /** + * The shard ID of the current shard's parent. + */ + ParentShardId?: ShardId; + } + export type ShardDescriptionList = Shard[]; + export type ShardId = string; + export type ShardIterator = string; + export type ShardIteratorType = "TRIM_HORIZON"|"LATEST"|"AT_SEQUENCE_NUMBER"|"AFTER_SEQUENCE_NUMBER"|string; + export interface Stream { + /** + * The Amazon Resource Name (ARN) for the stream. + */ + StreamArn?: StreamArn; + /** + * The DynamoDB table with which the stream is associated. + */ + TableName?: TableName; + /** + * A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: the AWS customer ID. the table name the StreamLabel + */ + StreamLabel?: String; + } + export type StreamArn = string; + export interface StreamDescription { + /** + * The Amazon Resource Name (ARN) for the stream. + */ + StreamArn?: StreamArn; + /** + * A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: the AWS customer ID. the table name the StreamLabel + */ + StreamLabel?: String; + /** + * Indicates the current status of the stream: ENABLING - Streams is currently being enabled on the DynamoDB table. ENABLED - the stream is enabled. DISABLING - Streams is currently being disabled on the DynamoDB table. DISABLED - the stream is disabled. + */ + StreamStatus?: StreamStatus; + /** + * Indicates the format of the records within this stream: KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table. NEW_IMAGE - entire items from the table, as they appeared after they were modified. OLD_IMAGE - entire items from the table, as they appeared before they were modified. NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table. + */ + StreamViewType?: StreamViewType; + /** + * The date and time when the request to create this stream was issued. + */ + CreationRequestDateTime?: _Date; + /** + * The DynamoDB table with which the stream is associated. + */ + TableName?: TableName; + /** + * The key attribute(s) of the stream's DynamoDB table. + */ + KeySchema?: KeySchema; + /** + * The shards that comprise the stream. + */ + Shards?: ShardDescriptionList; + /** + * The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved. If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty. + */ + LastEvaluatedShardId?: ShardId; + } + export type StreamList = Stream[]; + export interface StreamRecord { + /** + * The approximate date and time when the stream record was created, in UNIX epoch time format. + */ + ApproximateCreationDateTime?: _Date; + /** + * The primary key attribute(s) for the DynamoDB item that was modified. + */ + Keys?: AttributeMap; + /** + * The item in the DynamoDB table as it appeared after it was modified. + */ + NewImage?: AttributeMap; + /** + * The item in the DynamoDB table as it appeared before it was modified. + */ + OldImage?: AttributeMap; + /** + * The sequence number of the stream record. + */ + SequenceNumber?: SequenceNumber; + /** + * The size of the stream record, in bytes. + */ + SizeBytes?: PositiveLongObject; + /** + * The type of data from the modified DynamoDB item that was captured in this stream record: KEYS_ONLY - only the key attributes of the modified item. NEW_IMAGE - the entire item, as it appeared after it was modified. OLD_IMAGE - the entire item, as it appeared before it was modified. NEW_AND_OLD_IMAGES - both the new and the old item images of the item. + */ + StreamViewType?: StreamViewType; + } + export type StreamStatus = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"|string; + export type StreamViewType = "NEW_IMAGE"|"OLD_IMAGE"|"NEW_AND_OLD_IMAGES"|"KEYS_ONLY"|string; + export type String = string; + export type StringAttributeValue = string; + export type StringSetAttributeValue = StringAttributeValue[]; + export type TableName = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-08-10"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the DynamoDBStreams client. + */ + export import Types = DynamoDBStreams; +} +export = DynamoDBStreams; diff --git a/node_modules/aws-sdk/clients/dynamodbstreams.js b/node_modules/aws-sdk/clients/dynamodbstreams.js new file mode 100644 index 0000000..5bf52c7 --- /dev/null +++ b/node_modules/aws-sdk/clients/dynamodbstreams.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['dynamodbstreams'] = {}; +AWS.DynamoDBStreams = Service.defineService('dynamodbstreams', ['2012-08-10']); +Object.defineProperty(apiLoader.services['dynamodbstreams'], '2012-08-10', { + get: function get() { + var model = require('../apis/streams.dynamodb-2012-08-10.min.json'); + model.paginators = require('../apis/streams.dynamodb-2012-08-10.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.DynamoDBStreams; diff --git a/node_modules/aws-sdk/clients/ec2.d.ts b/node_modules/aws-sdk/clients/ec2.d.ts new file mode 100644 index 0000000..f31d696 --- /dev/null +++ b/node_modules/aws-sdk/clients/ec2.d.ts @@ -0,0 +1,19572 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class EC2 extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: EC2.Types.ClientConfiguration) + config: Config & EC2.Types.ClientConfiguration; + /** + * Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call. + */ + acceptReservedInstancesExchangeQuote(params: EC2.Types.AcceptReservedInstancesExchangeQuoteRequest, callback?: (err: AWSError, data: EC2.Types.AcceptReservedInstancesExchangeQuoteResult) => void): Request; + /** + * Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call. + */ + acceptReservedInstancesExchangeQuote(callback?: (err: AWSError, data: EC2.Types.AcceptReservedInstancesExchangeQuoteResult) => void): Request; + /** + * Accepts a request to attach a VPC to a transit gateway. The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request. + */ + acceptTransitGatewayVpcAttachment(params: EC2.Types.AcceptTransitGatewayVpcAttachmentRequest, callback?: (err: AWSError, data: EC2.Types.AcceptTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Accepts a request to attach a VPC to a transit gateway. The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request. + */ + acceptTransitGatewayVpcAttachment(callback?: (err: AWSError, data: EC2.Types.AcceptTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service. + */ + acceptVpcEndpointConnections(params: EC2.Types.AcceptVpcEndpointConnectionsRequest, callback?: (err: AWSError, data: EC2.Types.AcceptVpcEndpointConnectionsResult) => void): Request; + /** + * Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service. + */ + acceptVpcEndpointConnections(callback?: (err: AWSError, data: EC2.Types.AcceptVpcEndpointConnectionsResult) => void): Request; + /** + * Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests. For an inter-region VPC peering connection request, you must accept the VPC peering connection in the region of the accepter VPC. + */ + acceptVpcPeeringConnection(params: EC2.Types.AcceptVpcPeeringConnectionRequest, callback?: (err: AWSError, data: EC2.Types.AcceptVpcPeeringConnectionResult) => void): Request; + /** + * Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests. For an inter-region VPC peering connection request, you must accept the VPC peering connection in the region of the accepter VPC. + */ + acceptVpcPeeringConnection(callback?: (err: AWSError, data: EC2.Types.AcceptVpcPeeringConnectionResult) => void): Request; + /** + * Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS. It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays. To stop advertising the BYOIP CIDR, use WithdrawByoipCidr. + */ + advertiseByoipCidr(params: EC2.Types.AdvertiseByoipCidrRequest, callback?: (err: AWSError, data: EC2.Types.AdvertiseByoipCidrResult) => void): Request; + /** + * Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS. It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays. To stop advertising the BYOIP CIDR, use WithdrawByoipCidr. + */ + advertiseByoipCidr(callback?: (err: AWSError, data: EC2.Types.AdvertiseByoipCidrResult) => void): Request; + /** + * Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account. You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. [EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation. An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per region and 5 Elastic IP addresses for EC2-VPC per region. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. + */ + allocateAddress(params: EC2.Types.AllocateAddressRequest, callback?: (err: AWSError, data: EC2.Types.AllocateAddressResult) => void): Request; + /** + * Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account. You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. [EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation. An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per region and 5 Elastic IP addresses for EC2-VPC per region. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. + */ + allocateAddress(callback?: (err: AWSError, data: EC2.Types.AllocateAddressResult) => void): Request; + /** + * Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate. + */ + allocateHosts(params: EC2.Types.AllocateHostsRequest, callback?: (err: AWSError, data: EC2.Types.AllocateHostsResult) => void): Request; + /** + * Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate. + */ + allocateHosts(callback?: (err: AWSError, data: EC2.Types.AllocateHostsResult) => void): Request; + /** + * Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups. + */ + applySecurityGroupsToClientVpnTargetNetwork(params: EC2.Types.ApplySecurityGroupsToClientVpnTargetNetworkRequest, callback?: (err: AWSError, data: EC2.Types.ApplySecurityGroupsToClientVpnTargetNetworkResult) => void): Request; + /** + * Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups. + */ + applySecurityGroupsToClientVpnTargetNetwork(callback?: (err: AWSError, data: EC2.Types.ApplySecurityGroupsToClientVpnTargetNetworkResult) => void): Request; + /** + * Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide. + */ + assignIpv6Addresses(params: EC2.Types.AssignIpv6AddressesRequest, callback?: (err: AWSError, data: EC2.Types.AssignIpv6AddressesResult) => void): Request; + /** + * Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide. + */ + assignIpv6Addresses(callback?: (err: AWSError, data: EC2.Types.AssignIpv6AddressesResult) => void): Request; + /** + * Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved. Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete. + */ + assignPrivateIpAddresses(params: EC2.Types.AssignPrivateIpAddressesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved. Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete. + */ + assignPrivateIpAddresses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing. + */ + associateAddress(params: EC2.Types.AssociateAddressRequest, callback?: (err: AWSError, data: EC2.Types.AssociateAddressResult) => void): Request; + /** + * Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing. + */ + associateAddress(callback?: (err: AWSError, data: EC2.Types.AssociateAddressResult) => void): Request; + /** + * Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy. + */ + associateClientVpnTargetNetwork(params: EC2.Types.AssociateClientVpnTargetNetworkRequest, callback?: (err: AWSError, data: EC2.Types.AssociateClientVpnTargetNetworkResult) => void): Request; + /** + * Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy. + */ + associateClientVpnTargetNetwork(callback?: (err: AWSError, data: EC2.Types.AssociateClientVpnTargetNetworkResult) => void): Request; + /** + * Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. + */ + associateDhcpOptions(params: EC2.Types.AssociateDhcpOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. + */ + associateDhcpOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. + */ + associateIamInstanceProfile(params: EC2.Types.AssociateIamInstanceProfileRequest, callback?: (err: AWSError, data: EC2.Types.AssociateIamInstanceProfileResult) => void): Request; + /** + * Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. + */ + associateIamInstanceProfile(callback?: (err: AWSError, data: EC2.Types.AssociateIamInstanceProfileResult) => void): Request; + /** + * Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + associateRouteTable(params: EC2.Types.AssociateRouteTableRequest, callback?: (err: AWSError, data: EC2.Types.AssociateRouteTableResult) => void): Request; + /** + * Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + associateRouteTable(callback?: (err: AWSError, data: EC2.Types.AssociateRouteTableResult) => void): Request; + /** + * Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. + */ + associateSubnetCidrBlock(params: EC2.Types.AssociateSubnetCidrBlockRequest, callback?: (err: AWSError, data: EC2.Types.AssociateSubnetCidrBlockResult) => void): Request; + /** + * Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. + */ + associateSubnetCidrBlock(callback?: (err: AWSError, data: EC2.Types.AssociateSubnetCidrBlockResult) => void): Request; + /** + * Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. + */ + associateTransitGatewayRouteTable(params: EC2.Types.AssociateTransitGatewayRouteTableRequest, callback?: (err: AWSError, data: EC2.Types.AssociateTransitGatewayRouteTableResult) => void): Request; + /** + * Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. + */ + associateTransitGatewayRouteTable(callback?: (err: AWSError, data: EC2.Types.AssociateTransitGatewayRouteTableResult) => void): Request; + /** + * Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, or you can associate an Amazon-provided IPv6 CIDR block. The IPv6 CIDR block size is fixed at /56. For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide. + */ + associateVpcCidrBlock(params: EC2.Types.AssociateVpcCidrBlockRequest, callback?: (err: AWSError, data: EC2.Types.AssociateVpcCidrBlockResult) => void): Request; + /** + * Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, or you can associate an Amazon-provided IPv6 CIDR block. The IPv6 CIDR block size is fixed at /56. For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide. + */ + associateVpcCidrBlock(callback?: (err: AWSError, data: EC2.Types.AssociateVpcCidrBlockResult) => void): Request; + /** + * Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. Linking your instance to a VPC is sometimes referred to as attaching your instance. + */ + attachClassicLinkVpc(params: EC2.Types.AttachClassicLinkVpcRequest, callback?: (err: AWSError, data: EC2.Types.AttachClassicLinkVpcResult) => void): Request; + /** + * Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. Linking your instance to a VPC is sometimes referred to as attaching your instance. + */ + attachClassicLinkVpc(callback?: (err: AWSError, data: EC2.Types.AttachClassicLinkVpcResult) => void): Request; + /** + * Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide. + */ + attachInternetGateway(params: EC2.Types.AttachInternetGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide. + */ + attachInternetGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches a network interface to an instance. + */ + attachNetworkInterface(params: EC2.Types.AttachNetworkInterfaceRequest, callback?: (err: AWSError, data: EC2.Types.AttachNetworkInterfaceResult) => void): Request; + /** + * Attaches a network interface to an instance. + */ + attachNetworkInterface(callback?: (err: AWSError, data: EC2.Types.AttachNetworkInterfaceResult) => void): Request; + /** + * Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide. If a volume has an AWS Marketplace product code: The volume can be attached only to a stopped instance. AWS Marketplace product codes are copied from the volume to the instance. You must be subscribed to the product. The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance. For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + attachVolume(params: EC2.Types.AttachVolumeRequest, callback?: (err: AWSError, data: EC2.Types.VolumeAttachment) => void): Request; + /** + * Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide. If a volume has an AWS Marketplace product code: The volume can be attached only to a stopped instance. AWS Marketplace product codes are copied from the volume to the instance. You must be subscribed to the product. The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance. For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + attachVolume(callback?: (err: AWSError, data: EC2.Types.VolumeAttachment) => void): Request; + /** + * Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + attachVpnGateway(params: EC2.Types.AttachVpnGatewayRequest, callback?: (err: AWSError, data: EC2.Types.AttachVpnGatewayResult) => void): Request; + /** + * Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + attachVpnGateway(callback?: (err: AWSError, data: EC2.Types.AttachVpnGatewayResult) => void): Request; + /** + * Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks. + */ + authorizeClientVpnIngress(params: EC2.Types.AuthorizeClientVpnIngressRequest, callback?: (err: AWSError, data: EC2.Types.AuthorizeClientVpnIngressResult) => void): Request; + /** + * Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks. + */ + authorizeClientVpnIngress(callback?: (err: AWSError, data: EC2.Types.AuthorizeClientVpnIngressResult) => void): Request; + /** + * [VPC only] Adds the specified egress rules to a security group for use with a VPC. An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC. You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. For more information about VPC security group limits, see Amazon VPC Limits. + */ + authorizeSecurityGroupEgress(params: EC2.Types.AuthorizeSecurityGroupEgressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * [VPC only] Adds the specified egress rules to a security group for use with a VPC. An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC. You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. For more information about VPC security group limits, see Amazon VPC Limits. + */ + authorizeSecurityGroupEgress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from the specified destination security groups. You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. For more information about VPC security group limits, see Amazon VPC Limits. + */ + authorizeSecurityGroupIngress(params: EC2.Types.AuthorizeSecurityGroupIngressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from the specified destination security groups. You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. For more information about VPC security group limits, see Amazon VPC Limits. + */ + authorizeSecurityGroupIngress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. + */ + bundleInstance(params: EC2.Types.BundleInstanceRequest, callback?: (err: AWSError, data: EC2.Types.BundleInstanceResult) => void): Request; + /** + * Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. + */ + bundleInstance(callback?: (err: AWSError, data: EC2.Types.BundleInstanceResult) => void): Request; + /** + * Cancels a bundling operation for an instance store-backed Windows instance. + */ + cancelBundleTask(params: EC2.Types.CancelBundleTaskRequest, callback?: (err: AWSError, data: EC2.Types.CancelBundleTaskResult) => void): Request; + /** + * Cancels a bundling operation for an instance store-backed Windows instance. + */ + cancelBundleTask(callback?: (err: AWSError, data: EC2.Types.CancelBundleTaskResult) => void): Request; + /** + * Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity. + */ + cancelCapacityReservation(params: EC2.Types.CancelCapacityReservationRequest, callback?: (err: AWSError, data: EC2.Types.CancelCapacityReservationResult) => void): Request; + /** + * Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity. + */ + cancelCapacityReservation(callback?: (err: AWSError, data: EC2.Types.CancelCapacityReservationResult) => void): Request; + /** + * Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI. + */ + cancelConversionTask(params: EC2.Types.CancelConversionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI. + */ + cancelConversionTask(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. + */ + cancelExportTask(params: EC2.Types.CancelExportTaskRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. + */ + cancelExportTask(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels an in-process import virtual machine or import snapshot task. + */ + cancelImportTask(params: EC2.Types.CancelImportTaskRequest, callback?: (err: AWSError, data: EC2.Types.CancelImportTaskResult) => void): Request; + /** + * Cancels an in-process import virtual machine or import snapshot task. + */ + cancelImportTask(callback?: (err: AWSError, data: EC2.Types.CancelImportTaskResult) => void): Request; + /** + * Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + cancelReservedInstancesListing(params: EC2.Types.CancelReservedInstancesListingRequest, callback?: (err: AWSError, data: EC2.Types.CancelReservedInstancesListingResult) => void): Request; + /** + * Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + cancelReservedInstancesListing(callback?: (err: AWSError, data: EC2.Types.CancelReservedInstancesListingResult) => void): Request; + /** + * Cancels the specified Spot Fleet requests. After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually. + */ + cancelSpotFleetRequests(params: EC2.Types.CancelSpotFleetRequestsRequest, callback?: (err: AWSError, data: EC2.Types.CancelSpotFleetRequestsResponse) => void): Request; + /** + * Cancels the specified Spot Fleet requests. After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually. + */ + cancelSpotFleetRequests(callback?: (err: AWSError, data: EC2.Types.CancelSpotFleetRequestsResponse) => void): Request; + /** + * Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request. + */ + cancelSpotInstanceRequests(params: EC2.Types.CancelSpotInstanceRequestsRequest, callback?: (err: AWSError, data: EC2.Types.CancelSpotInstanceRequestsResult) => void): Request; + /** + * Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request. + */ + cancelSpotInstanceRequests(callback?: (err: AWSError, data: EC2.Types.CancelSpotInstanceRequestsResult) => void): Request; + /** + * Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support. + */ + confirmProductInstance(params: EC2.Types.ConfirmProductInstanceRequest, callback?: (err: AWSError, data: EC2.Types.ConfirmProductInstanceResult) => void): Request; + /** + * Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support. + */ + confirmProductInstance(callback?: (err: AWSError, data: EC2.Types.ConfirmProductInstanceResult) => void): Request; + /** + * Copies the specified Amazon FPGA Image (AFI) to the current region. + */ + copyFpgaImage(params: EC2.Types.CopyFpgaImageRequest, callback?: (err: AWSError, data: EC2.Types.CopyFpgaImageResult) => void): Request; + /** + * Copies the specified Amazon FPGA Image (AFI) to the current region. + */ + copyFpgaImage(callback?: (err: AWSError, data: EC2.Types.CopyFpgaImageResult) => void): Request; + /** + * Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot. For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide. + */ + copyImage(params: EC2.Types.CopyImageRequest, callback?: (err: AWSError, data: EC2.Types.CopyImageResult) => void): Request; + /** + * Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot. For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide. + */ + copyImage(callback?: (err: AWSError, data: EC2.Types.CopyImageResult) => void): Request; + /** + * Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot. Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose. For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. + */ + copySnapshot(params: EC2.Types.CopySnapshotRequest, callback?: (err: AWSError, data: EC2.Types.CopySnapshotResult) => void): Request; + /** + * Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot. Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose. For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. + */ + copySnapshot(callback?: (err: AWSError, data: EC2.Types.CopySnapshotResult) => void): Request; + /** + * Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide. Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes. Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide. + */ + createCapacityReservation(params: EC2.Types.CreateCapacityReservationRequest, callback?: (err: AWSError, data: EC2.Types.CreateCapacityReservationResult) => void): Request; + /** + * Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide. Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes. Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide. + */ + createCapacityReservation(callback?: (err: AWSError, data: EC2.Types.CreateCapacityReservationResult) => void): Request; + /** + * Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. + */ + createClientVpnEndpoint(params: EC2.Types.CreateClientVpnEndpointRequest, callback?: (err: AWSError, data: EC2.Types.CreateClientVpnEndpointResult) => void): Request; + /** + * Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. + */ + createClientVpnEndpoint(callback?: (err: AWSError, data: EC2.Types.CreateClientVpnEndpointResult) => void): Request; + /** + * Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. + */ + createClientVpnRoute(params: EC2.Types.CreateClientVpnRouteRequest, callback?: (err: AWSError, data: EC2.Types.CreateClientVpnRouteResult) => void): Request; + /** + * Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. + */ + createClientVpnRoute(callback?: (err: AWSError, data: EC2.Types.CreateClientVpnRouteResult) => void): Request; + /** + * Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT). For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. + */ + createCustomerGateway(params: EC2.Types.CreateCustomerGatewayRequest, callback?: (err: AWSError, data: EC2.Types.CreateCustomerGatewayResult) => void): Request; + /** + * Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT). For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. + */ + createCustomerGateway(callback?: (err: AWSError, data: EC2.Types.CreateCustomerGatewayResult) => void): Request; + /** + * Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide. + */ + createDefaultSubnet(params: EC2.Types.CreateDefaultSubnetRequest, callback?: (err: AWSError, data: EC2.Types.CreateDefaultSubnetResult) => void): Request; + /** + * Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide. + */ + createDefaultSubnet(callback?: (err: AWSError, data: EC2.Types.CreateDefaultSubnetResult) => void): Request; + /** + * Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself. If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region. If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ. + */ + createDefaultVpc(params: EC2.Types.CreateDefaultVpcRequest, callback?: (err: AWSError, data: EC2.Types.CreateDefaultVpcResult) => void): Request; + /** + * Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself. If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region. If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ. + */ + createDefaultVpc(callback?: (err: AWSError, data: EC2.Types.CreateDefaultVpcResult) => void): Request; + /** + * Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132. domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. ITo have your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server. domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers. netbios-name-servers - The IP addresses of up to four NetBIOS name servers. netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132. Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. + */ + createDhcpOptions(params: EC2.Types.CreateDhcpOptionsRequest, callback?: (err: AWSError, data: EC2.Types.CreateDhcpOptionsResult) => void): Request; + /** + * Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132. domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. ITo have your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server. domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers. netbios-name-servers - The IP addresses of up to four NetBIOS name servers. netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132. Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. + */ + createDhcpOptions(callback?: (err: AWSError, data: EC2.Types.CreateDhcpOptionsResult) => void): Request; + /** + * [IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. + */ + createEgressOnlyInternetGateway(params: EC2.Types.CreateEgressOnlyInternetGatewayRequest, callback?: (err: AWSError, data: EC2.Types.CreateEgressOnlyInternetGatewayResult) => void): Request; + /** + * [IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. + */ + createEgressOnlyInternetGateway(callback?: (err: AWSError, data: EC2.Types.CreateEgressOnlyInternetGatewayResult) => void): Request; + /** + * Launches an EC2 Fleet. You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide. + */ + createFleet(params: EC2.Types.CreateFleetRequest, callback?: (err: AWSError, data: EC2.Types.CreateFleetResult) => void): Request; + /** + * Launches an EC2 Fleet. You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide. + */ + createFleet(callback?: (err: AWSError, data: EC2.Types.CreateFleetResult) => void): Request; + /** + * Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide. When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket. For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide. + */ + createFlowLogs(params: EC2.Types.CreateFlowLogsRequest, callback?: (err: AWSError, data: EC2.Types.CreateFlowLogsResult) => void): Request; + /** + * Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide. When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket. For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide. + */ + createFlowLogs(callback?: (err: AWSError, data: EC2.Types.CreateFlowLogsResult) => void): Request; + /** + * Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit. + */ + createFpgaImage(params: EC2.Types.CreateFpgaImageRequest, callback?: (err: AWSError, data: EC2.Types.CreateFpgaImageResult) => void): Request; + /** + * Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit. + */ + createFpgaImage(callback?: (err: AWSError, data: EC2.Types.CreateFpgaImageResult) => void): Request; + /** + * Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide. + */ + createImage(params: EC2.Types.CreateImageRequest, callback?: (err: AWSError, data: EC2.Types.CreateImageResult) => void): Request; + /** + * Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide. + */ + createImage(callback?: (err: AWSError, data: EC2.Types.CreateImageResult) => void): Request; + /** + * Exports a running or stopped instance to an S3 bucket. For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide. + */ + createInstanceExportTask(params: EC2.Types.CreateInstanceExportTaskRequest, callback?: (err: AWSError, data: EC2.Types.CreateInstanceExportTaskResult) => void): Request; + /** + * Exports a running or stopped instance to an S3 bucket. For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide. + */ + createInstanceExportTask(callback?: (err: AWSError, data: EC2.Types.CreateInstanceExportTaskResult) => void): Request; + /** + * Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide. + */ + createInternetGateway(params: EC2.Types.CreateInternetGatewayRequest, callback?: (err: AWSError, data: EC2.Types.CreateInternetGatewayResult) => void): Request; + /** + * Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide. + */ + createInternetGateway(callback?: (err: AWSError, data: EC2.Types.CreateInternetGatewayResult) => void): Request; + /** + * Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error. You can have up to five thousand key pairs per region. The key pair returned to you is available only in the region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any region using ImportKeyPair. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. + */ + createKeyPair(params: EC2.Types.CreateKeyPairRequest, callback?: (err: AWSError, data: EC2.Types.KeyPair) => void): Request; + /** + * Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error. You can have up to five thousand key pairs per region. The key pair returned to you is available only in the region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any region using ImportKeyPair. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. + */ + createKeyPair(callback?: (err: AWSError, data: EC2.Types.KeyPair) => void): Request; + /** + * Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. + */ + createLaunchTemplate(params: EC2.Types.CreateLaunchTemplateRequest, callback?: (err: AWSError, data: EC2.Types.CreateLaunchTemplateResult) => void): Request; + /** + * Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. + */ + createLaunchTemplate(callback?: (err: AWSError, data: EC2.Types.CreateLaunchTemplateResult) => void): Request; + /** + * Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version. Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions. + */ + createLaunchTemplateVersion(params: EC2.Types.CreateLaunchTemplateVersionRequest, callback?: (err: AWSError, data: EC2.Types.CreateLaunchTemplateVersionResult) => void): Request; + /** + * Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version. Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions. + */ + createLaunchTemplateVersion(callback?: (err: AWSError, data: EC2.Types.CreateLaunchTemplateVersionResult) => void): Request; + /** + * Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide. + */ + createNatGateway(params: EC2.Types.CreateNatGatewayRequest, callback?: (err: AWSError, data: EC2.Types.CreateNatGatewayResult) => void): Request; + /** + * Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide. + */ + createNatGateway(callback?: (err: AWSError, data: EC2.Types.CreateNatGatewayResult) => void): Request; + /** + * Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + createNetworkAcl(params: EC2.Types.CreateNetworkAclRequest, callback?: (err: AWSError, data: EC2.Types.CreateNetworkAclResult) => void): Request; + /** + * Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + createNetworkAcl(callback?: (err: AWSError, data: EC2.Types.CreateNetworkAclResult) => void): Request; + /** + * Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + createNetworkAclEntry(params: EC2.Types.CreateNetworkAclEntryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + createNetworkAclEntry(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a network interface in the specified subnet. For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide. + */ + createNetworkInterface(params: EC2.Types.CreateNetworkInterfaceRequest, callback?: (err: AWSError, data: EC2.Types.CreateNetworkInterfaceResult) => void): Request; + /** + * Creates a network interface in the specified subnet. For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide. + */ + createNetworkInterface(callback?: (err: AWSError, data: EC2.Types.CreateNetworkInterfaceResult) => void): Request; + /** + * Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account. You can grant permission to a single AWS account only, and only one account at a time. + */ + createNetworkInterfacePermission(params: EC2.Types.CreateNetworkInterfacePermissionRequest, callback?: (err: AWSError, data: EC2.Types.CreateNetworkInterfacePermissionResult) => void): Request; + /** + * Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account. You can grant permission to a single AWS account only, and only one account at a time. + */ + createNetworkInterfacePermission(callback?: (err: AWSError, data: EC2.Types.CreateNetworkInterfacePermissionResult) => void): Request; + /** + * Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. + */ + createPlacementGroup(params: EC2.Types.CreatePlacementGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. + */ + createPlacementGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation. Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold. The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + createReservedInstancesListing(params: EC2.Types.CreateReservedInstancesListingRequest, callback?: (err: AWSError, data: EC2.Types.CreateReservedInstancesListingResult) => void): Request; + /** + * Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation. Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold. The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + createReservedInstancesListing(callback?: (err: AWSError, data: EC2.Types.CreateReservedInstancesListingResult) => void): Request; + /** + * Creates a route in a route table within a VPC. You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes: 192.0.2.0/24 (goes to some target A) 192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + createRoute(params: EC2.Types.CreateRouteRequest, callback?: (err: AWSError, data: EC2.Types.CreateRouteResult) => void): Request; + /** + * Creates a route in a route table within a VPC. You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes: 192.0.2.0/24 (goes to some target A) 192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + createRoute(callback?: (err: AWSError, data: EC2.Types.CreateRouteResult) => void): Request; + /** + * Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + createRouteTable(params: EC2.Types.CreateRouteTableRequest, callback?: (err: AWSError, data: EC2.Types.CreateRouteTableResult) => void): Request; + /** + * Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + createRouteTable(callback?: (err: AWSError, data: EC2.Types.CreateRouteTableResult) => void): Request; + /** + * Creates a security group. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress. For more information about VPC security group limits, see Amazon VPC Limits. + */ + createSecurityGroup(params: EC2.Types.CreateSecurityGroupRequest, callback?: (err: AWSError, data: EC2.Types.CreateSecurityGroupResult) => void): Request; + /** + * Creates a security group. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress. For more information about VPC security group limits, see Amazon VPC Limits. + */ + createSecurityGroup(callback?: (err: AWSError, data: EC2.Types.CreateSecurityGroupResult) => void): Request; + /** + * Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending. To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. You can tag your snapshots during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. + */ + createSnapshot(params: EC2.Types.CreateSnapshotRequest, callback?: (err: AWSError, data: EC2.Types.Snapshot) => void): Request; + /** + * Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending. To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. You can tag your snapshots during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. + */ + createSnapshot(callback?: (err: AWSError, data: EC2.Types.Snapshot) => void): Request; + /** + * Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances. + */ + createSpotDatafeedSubscription(params: EC2.Types.CreateSpotDatafeedSubscriptionRequest, callback?: (err: AWSError, data: EC2.Types.CreateSpotDatafeedSubscriptionResult) => void): Request; + /** + * Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances. + */ + createSpotDatafeedSubscription(callback?: (err: AWSError, data: EC2.Types.CreateSpotDatafeedSubscriptionResult) => void): Request; + /** + * Creates a subnet in an existing VPC. When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length. AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use. If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide. + */ + createSubnet(params: EC2.Types.CreateSubnetRequest, callback?: (err: AWSError, data: EC2.Types.CreateSubnetResult) => void): Request; + /** + * Creates a subnet in an existing VPC. When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length. AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use. If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide. + */ + createSubnet(callback?: (err: AWSError, data: EC2.Types.CreateSubnetResult) => void): Request; + /** + * Adds or overwrites the specified tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide. + */ + createTags(params: EC2.Types.CreateTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or overwrites the specified tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide. + */ + createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a transit gateway. You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway. To attach your VPCs, use CreateTransitGatewayVpcAttachment. To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection. When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table. + */ + createTransitGateway(params: EC2.Types.CreateTransitGatewayRequest, callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayResult) => void): Request; + /** + * Creates a transit gateway. You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway. To attach your VPCs, use CreateTransitGatewayVpcAttachment. To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection. When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table. + */ + createTransitGateway(callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayResult) => void): Request; + /** + * Creates a static route for the specified transit gateway route table. + */ + createTransitGatewayRoute(params: EC2.Types.CreateTransitGatewayRouteRequest, callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayRouteResult) => void): Request; + /** + * Creates a static route for the specified transit gateway route table. + */ + createTransitGatewayRoute(callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayRouteResult) => void): Request; + /** + * Creates a route table for the specified transit gateway. + */ + createTransitGatewayRouteTable(params: EC2.Types.CreateTransitGatewayRouteTableRequest, callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayRouteTableResult) => void): Request; + /** + * Creates a route table for the specified transit gateway. + */ + createTransitGatewayRouteTable(callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayRouteTableResult) => void): Request; + /** + * Attaches the specified VPC to the specified transit gateway. If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table. To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute. + */ + createTransitGatewayVpcAttachment(params: EC2.Types.CreateTransitGatewayVpcAttachmentRequest, callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Attaches the specified VPC to the specified transit gateway. If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table. To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute. + */ + createTransitGatewayVpcAttachment(callback?: (err: AWSError, data: EC2.Types.CreateTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints. You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide. + */ + createVolume(params: EC2.Types.CreateVolumeRequest, callback?: (err: AWSError, data: EC2.Types.Volume) => void): Request; + /** + * Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints. You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide. + */ + createVolume(callback?: (err: AWSError, data: EC2.Types.Volume) => void): Request; + /** + * Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide. You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC. By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide. + */ + createVpc(params: EC2.Types.CreateVpcRequest, callback?: (err: AWSError, data: EC2.Types.CreateVpcResult) => void): Request; + /** + * Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide. You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC. By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide. + */ + createVpc(callback?: (err: AWSError, data: EC2.Types.CreateVpcResult) => void): Request; + /** + * Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide. A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface. Use DescribeVpcEndpointServices to get a list of supported services. + */ + createVpcEndpoint(params: EC2.Types.CreateVpcEndpointRequest, callback?: (err: AWSError, data: EC2.Types.CreateVpcEndpointResult) => void): Request; + /** + * Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide. A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface. Use DescribeVpcEndpointServices to get a list of supported services. + */ + createVpcEndpoint(callback?: (err: AWSError, data: EC2.Types.CreateVpcEndpointResult) => void): Request; + /** + * Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide. You can create a connection notification for interface endpoints only. + */ + createVpcEndpointConnectionNotification(params: EC2.Types.CreateVpcEndpointConnectionNotificationRequest, callback?: (err: AWSError, data: EC2.Types.CreateVpcEndpointConnectionNotificationResult) => void): Request; + /** + * Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide. You can create a connection notification for interface endpoints only. + */ + createVpcEndpointConnectionNotification(callback?: (err: AWSError, data: EC2.Types.CreateVpcEndpointConnectionNotificationResult) => void): Request; + /** + * Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service. To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide. + */ + createVpcEndpointServiceConfiguration(params: EC2.Types.CreateVpcEndpointServiceConfigurationRequest, callback?: (err: AWSError, data: EC2.Types.CreateVpcEndpointServiceConfigurationResult) => void): Request; + /** + * Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service. To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide. + */ + createVpcEndpointServiceConfiguration(callback?: (err: AWSError, data: EC2.Types.CreateVpcEndpointServiceConfigurationResult) => void): Request; + /** + * Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide. The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed. + */ + createVpcPeeringConnection(params: EC2.Types.CreateVpcPeeringConnectionRequest, callback?: (err: AWSError, data: EC2.Types.CreateVpcPeeringConnectionResult) => void): Request; + /** + * Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide. The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed. + */ + createVpcPeeringConnection(callback?: (err: AWSError, data: EC2.Types.CreateVpcPeeringConnectionResult) => void): Request; + /** + * Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1. The response includes information that you need to give to your network administrator to configure your customer gateway. We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + createVpnConnection(params: EC2.Types.CreateVpnConnectionRequest, callback?: (err: AWSError, data: EC2.Types.CreateVpnConnectionResult) => void): Request; + /** + * Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1. The response includes information that you need to give to your network administrator to configure your customer gateway. We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + createVpnConnection(callback?: (err: AWSError, data: EC2.Types.CreateVpnConnectionResult) => void): Request; + /** + * Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + createVpnConnectionRoute(params: EC2.Types.CreateVpnConnectionRouteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + createVpnConnectionRoute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + createVpnGateway(params: EC2.Types.CreateVpnGatewayRequest, callback?: (err: AWSError, data: EC2.Types.CreateVpnGatewayResult) => void): Request; + /** + * Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + createVpnGateway(callback?: (err: AWSError, data: EC2.Types.CreateVpnGatewayResult) => void): Request; + /** + * Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. + */ + deleteClientVpnEndpoint(params: EC2.Types.DeleteClientVpnEndpointRequest, callback?: (err: AWSError, data: EC2.Types.DeleteClientVpnEndpointResult) => void): Request; + /** + * Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. + */ + deleteClientVpnEndpoint(callback?: (err: AWSError, data: EC2.Types.DeleteClientVpnEndpointResult) => void): Request; + /** + * Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint. + */ + deleteClientVpnRoute(params: EC2.Types.DeleteClientVpnRouteRequest, callback?: (err: AWSError, data: EC2.Types.DeleteClientVpnRouteResult) => void): Request; + /** + * Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint. + */ + deleteClientVpnRoute(callback?: (err: AWSError, data: EC2.Types.DeleteClientVpnRouteResult) => void): Request; + /** + * Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. + */ + deleteCustomerGateway(params: EC2.Types.DeleteCustomerGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. + */ + deleteCustomerGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. + */ + deleteDhcpOptions(params: EC2.Types.DeleteDhcpOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. + */ + deleteDhcpOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an egress-only internet gateway. + */ + deleteEgressOnlyInternetGateway(params: EC2.Types.DeleteEgressOnlyInternetGatewayRequest, callback?: (err: AWSError, data: EC2.Types.DeleteEgressOnlyInternetGatewayResult) => void): Request; + /** + * Deletes an egress-only internet gateway. + */ + deleteEgressOnlyInternetGateway(callback?: (err: AWSError, data: EC2.Types.DeleteEgressOnlyInternetGatewayResult) => void): Request; + /** + * Deletes the specified EC2 Fleet. After you delete an EC2 Fleet, it launches no new instances. You must specify whether an EC2 Fleet should also terminate its instances. If you terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually. + */ + deleteFleets(params: EC2.Types.DeleteFleetsRequest, callback?: (err: AWSError, data: EC2.Types.DeleteFleetsResult) => void): Request; + /** + * Deletes the specified EC2 Fleet. After you delete an EC2 Fleet, it launches no new instances. You must specify whether an EC2 Fleet should also terminate its instances. If you terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually. + */ + deleteFleets(callback?: (err: AWSError, data: EC2.Types.DeleteFleetsResult) => void): Request; + /** + * Deletes one or more flow logs. + */ + deleteFlowLogs(params: EC2.Types.DeleteFlowLogsRequest, callback?: (err: AWSError, data: EC2.Types.DeleteFlowLogsResult) => void): Request; + /** + * Deletes one or more flow logs. + */ + deleteFlowLogs(callback?: (err: AWSError, data: EC2.Types.DeleteFlowLogsResult) => void): Request; + /** + * Deletes the specified Amazon FPGA Image (AFI). + */ + deleteFpgaImage(params: EC2.Types.DeleteFpgaImageRequest, callback?: (err: AWSError, data: EC2.Types.DeleteFpgaImageResult) => void): Request; + /** + * Deletes the specified Amazon FPGA Image (AFI). + */ + deleteFpgaImage(callback?: (err: AWSError, data: EC2.Types.DeleteFpgaImageResult) => void): Request; + /** + * Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. + */ + deleteInternetGateway(params: EC2.Types.DeleteInternetGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. + */ + deleteInternetGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified key pair, by removing the public key from Amazon EC2. + */ + deleteKeyPair(params: EC2.Types.DeleteKeyPairRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified key pair, by removing the public key from Amazon EC2. + */ + deleteKeyPair(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a launch template. Deleting a launch template deletes all of its versions. + */ + deleteLaunchTemplate(params: EC2.Types.DeleteLaunchTemplateRequest, callback?: (err: AWSError, data: EC2.Types.DeleteLaunchTemplateResult) => void): Request; + /** + * Deletes a launch template. Deleting a launch template deletes all of its versions. + */ + deleteLaunchTemplate(callback?: (err: AWSError, data: EC2.Types.DeleteLaunchTemplateResult) => void): Request; + /** + * Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate. + */ + deleteLaunchTemplateVersions(params: EC2.Types.DeleteLaunchTemplateVersionsRequest, callback?: (err: AWSError, data: EC2.Types.DeleteLaunchTemplateVersionsResult) => void): Request; + /** + * Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate. + */ + deleteLaunchTemplateVersions(callback?: (err: AWSError, data: EC2.Types.DeleteLaunchTemplateVersionsResult) => void): Request; + /** + * Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables. + */ + deleteNatGateway(params: EC2.Types.DeleteNatGatewayRequest, callback?: (err: AWSError, data: EC2.Types.DeleteNatGatewayResult) => void): Request; + /** + * Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables. + */ + deleteNatGateway(callback?: (err: AWSError, data: EC2.Types.DeleteNatGatewayResult) => void): Request; + /** + * Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. + */ + deleteNetworkAcl(params: EC2.Types.DeleteNetworkAclRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. + */ + deleteNetworkAcl(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified ingress or egress entry (rule) from the specified network ACL. + */ + deleteNetworkAclEntry(params: EC2.Types.DeleteNetworkAclEntryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified ingress or egress entry (rule) from the specified network ACL. + */ + deleteNetworkAclEntry(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified network interface. You must detach the network interface before you can delete it. + */ + deleteNetworkInterface(params: EC2.Types.DeleteNetworkInterfaceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified network interface. You must detach the network interface before you can delete it. + */ + deleteNetworkInterface(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment. + */ + deleteNetworkInterfacePermission(params: EC2.Types.DeleteNetworkInterfacePermissionRequest, callback?: (err: AWSError, data: EC2.Types.DeleteNetworkInterfacePermissionResult) => void): Request; + /** + * Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment. + */ + deleteNetworkInterfacePermission(callback?: (err: AWSError, data: EC2.Types.DeleteNetworkInterfacePermissionResult) => void): Request; + /** + * Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. + */ + deletePlacementGroup(params: EC2.Types.DeletePlacementGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. + */ + deletePlacementGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified route from the specified route table. + */ + deleteRoute(params: EC2.Types.DeleteRouteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified route from the specified route table. + */ + deleteRoute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. + */ + deleteRouteTable(params: EC2.Types.DeleteRouteTableRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. + */ + deleteRouteTable(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a security group. If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC. + */ + deleteSecurityGroup(params: EC2.Types.DeleteSecurityGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a security group. If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC. + */ + deleteSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. + */ + deleteSnapshot(params: EC2.Types.DeleteSnapshotRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. + */ + deleteSnapshot(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the data feed for Spot Instances. + */ + deleteSpotDatafeedSubscription(params: EC2.Types.DeleteSpotDatafeedSubscriptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the data feed for Spot Instances. + */ + deleteSpotDatafeedSubscription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. + */ + deleteSubnet(params: EC2.Types.DeleteSubnetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. + */ + deleteSubnet(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified set of tags from the specified set of resources. To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. + */ + deleteTags(params: EC2.Types.DeleteTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified set of tags from the specified set of resources. To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. + */ + deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified transit gateway. + */ + deleteTransitGateway(params: EC2.Types.DeleteTransitGatewayRequest, callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayResult) => void): Request; + /** + * Deletes the specified transit gateway. + */ + deleteTransitGateway(callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayResult) => void): Request; + /** + * Deletes the specified route from the specified transit gateway route table. + */ + deleteTransitGatewayRoute(params: EC2.Types.DeleteTransitGatewayRouteRequest, callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayRouteResult) => void): Request; + /** + * Deletes the specified route from the specified transit gateway route table. + */ + deleteTransitGatewayRoute(callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayRouteResult) => void): Request; + /** + * Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it. + */ + deleteTransitGatewayRouteTable(params: EC2.Types.DeleteTransitGatewayRouteTableRequest, callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayRouteTableResult) => void): Request; + /** + * Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it. + */ + deleteTransitGatewayRouteTable(callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayRouteTableResult) => void): Request; + /** + * Deletes the specified VPC attachment. + */ + deleteTransitGatewayVpcAttachment(params: EC2.Types.DeleteTransitGatewayVpcAttachmentRequest, callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Deletes the specified VPC attachment. + */ + deleteTransitGatewayVpcAttachment(callback?: (err: AWSError, data: EC2.Types.DeleteTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance). The volume can remain in the deleting state for several minutes. For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide. + */ + deleteVolume(params: EC2.Types.DeleteVolumeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance). The volume can remain in the deleting state for several minutes. For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide. + */ + deleteVolume(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. + */ + deleteVpc(params: EC2.Types.DeleteVpcRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. + */ + deleteVpc(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes one or more VPC endpoint connection notifications. + */ + deleteVpcEndpointConnectionNotifications(params: EC2.Types.DeleteVpcEndpointConnectionNotificationsRequest, callback?: (err: AWSError, data: EC2.Types.DeleteVpcEndpointConnectionNotificationsResult) => void): Request; + /** + * Deletes one or more VPC endpoint connection notifications. + */ + deleteVpcEndpointConnectionNotifications(callback?: (err: AWSError, data: EC2.Types.DeleteVpcEndpointConnectionNotificationsResult) => void): Request; + /** + * Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service. + */ + deleteVpcEndpointServiceConfigurations(params: EC2.Types.DeleteVpcEndpointServiceConfigurationsRequest, callback?: (err: AWSError, data: EC2.Types.DeleteVpcEndpointServiceConfigurationsResult) => void): Request; + /** + * Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service. + */ + deleteVpcEndpointServiceConfigurations(callback?: (err: AWSError, data: EC2.Types.DeleteVpcEndpointServiceConfigurationsResult) => void): Request; + /** + * Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes the endpoint network interfaces. + */ + deleteVpcEndpoints(params: EC2.Types.DeleteVpcEndpointsRequest, callback?: (err: AWSError, data: EC2.Types.DeleteVpcEndpointsResult) => void): Request; + /** + * Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes the endpoint network interfaces. + */ + deleteVpcEndpoints(callback?: (err: AWSError, data: EC2.Types.DeleteVpcEndpointsResult) => void): Request; + /** + * Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state. + */ + deleteVpcPeeringConnection(params: EC2.Types.DeleteVpcPeeringConnectionRequest, callback?: (err: AWSError, data: EC2.Types.DeleteVpcPeeringConnectionResult) => void): Request; + /** + * Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state. + */ + deleteVpcPeeringConnection(callback?: (err: AWSError, data: EC2.Types.DeleteVpcPeeringConnectionResult) => void): Request; + /** + * Deletes the specified VPN connection. If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. + */ + deleteVpnConnection(params: EC2.Types.DeleteVpnConnectionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified VPN connection. If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. + */ + deleteVpnConnection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. + */ + deleteVpnConnectionRoute(params: EC2.Types.DeleteVpnConnectionRouteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. + */ + deleteVpnConnectionRoute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. + */ + deleteVpnGateway(params: EC2.Types.DeleteVpnGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. + */ + deleteVpnGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range. + */ + deprovisionByoipCidr(params: EC2.Types.DeprovisionByoipCidrRequest, callback?: (err: AWSError, data: EC2.Types.DeprovisionByoipCidrResult) => void): Request; + /** + * Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range. + */ + deprovisionByoipCidr(callback?: (err: AWSError, data: EC2.Types.DeprovisionByoipCidrResult) => void): Request; + /** + * Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them. When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI. + */ + deregisterImage(params: EC2.Types.DeregisterImageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them. When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI. + */ + deregisterImage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describes attributes of your AWS account. The following are the supported account attributes: supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. default-vpc: The ID of the default VPC for your account, or none. max-instances: The maximum number of On-Demand Instances that you can run. vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface. max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. + */ + describeAccountAttributes(params: EC2.Types.DescribeAccountAttributesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeAccountAttributesResult) => void): Request; + /** + * Describes attributes of your AWS account. The following are the supported account attributes: supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. default-vpc: The ID of the default VPC for your account, or none. max-instances: The maximum number of On-Demand Instances that you can run. vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface. max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. + */ + describeAccountAttributes(callback?: (err: AWSError, data: EC2.Types.DescribeAccountAttributesResult) => void): Request; + /** + * Describes the specified Elastic IP addresses or all of your Elastic IP addresses. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. + */ + describeAddresses(params: EC2.Types.DescribeAddressesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeAddressesResult) => void): Request; + /** + * Describes the specified Elastic IP addresses or all of your Elastic IP addresses. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. + */ + describeAddresses(callback?: (err: AWSError, data: EC2.Types.DescribeAddressesResult) => void): Request; + /** + * Describes the longer ID format settings for all resource types in a specific region. This request is useful for performing a quick audit to determine whether a specific region is fully opted in for longer IDs (17-character IDs). This request only returns information about resource types that support longer IDs. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. + */ + describeAggregateIdFormat(params: EC2.Types.DescribeAggregateIdFormatRequest, callback?: (err: AWSError, data: EC2.Types.DescribeAggregateIdFormatResult) => void): Request; + /** + * Describes the longer ID format settings for all resource types in a specific region. This request is useful for performing a quick audit to determine whether a specific region is fully opted in for longer IDs (17-character IDs). This request only returns information about resource types that support longer IDs. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. + */ + describeAggregateIdFormat(callback?: (err: AWSError, data: EC2.Types.DescribeAggregateIdFormatResult) => void): Request; + /** + * Describes the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide. + */ + describeAvailabilityZones(params: EC2.Types.DescribeAvailabilityZonesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeAvailabilityZonesResult) => void): Request; + /** + * Describes the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide. + */ + describeAvailabilityZones(callback?: (err: AWSError, data: EC2.Types.DescribeAvailabilityZonesResult) => void): Request; + /** + * Describes the specified bundle tasks or all of your bundle tasks. Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task. + */ + describeBundleTasks(params: EC2.Types.DescribeBundleTasksRequest, callback?: (err: AWSError, data: EC2.Types.DescribeBundleTasksResult) => void): Request; + /** + * Describes the specified bundle tasks or all of your bundle tasks. Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task. + */ + describeBundleTasks(callback?: (err: AWSError, data: EC2.Types.DescribeBundleTasksResult) => void): Request; + /** + * Describes the IP address ranges that were specified in calls to ProvisionByoipCidr. To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools. + */ + describeByoipCidrs(params: EC2.Types.DescribeByoipCidrsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeByoipCidrsResult) => void): Request; + /** + * Describes the IP address ranges that were specified in calls to ProvisionByoipCidr. To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools. + */ + describeByoipCidrs(callback?: (err: AWSError, data: EC2.Types.DescribeByoipCidrsResult) => void): Request; + /** + * Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using. + */ + describeCapacityReservations(params: EC2.Types.DescribeCapacityReservationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeCapacityReservationsResult) => void): Request; + /** + * Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using. + */ + describeCapacityReservations(callback?: (err: AWSError, data: EC2.Types.DescribeCapacityReservationsResult) => void): Request; + /** + * Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. + */ + describeClassicLinkInstances(params: EC2.Types.DescribeClassicLinkInstancesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeClassicLinkInstancesResult) => void): Request; + /** + * Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. + */ + describeClassicLinkInstances(callback?: (err: AWSError, data: EC2.Types.DescribeClassicLinkInstancesResult) => void): Request; + /** + * Describes the authorization rules for a specified Client VPN endpoint. + */ + describeClientVpnAuthorizationRules(params: EC2.Types.DescribeClientVpnAuthorizationRulesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnAuthorizationRulesResult) => void): Request; + /** + * Describes the authorization rules for a specified Client VPN endpoint. + */ + describeClientVpnAuthorizationRules(callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnAuthorizationRulesResult) => void): Request; + /** + * Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. + */ + describeClientVpnConnections(params: EC2.Types.DescribeClientVpnConnectionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnConnectionsResult) => void): Request; + /** + * Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. + */ + describeClientVpnConnections(callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnConnectionsResult) => void): Request; + /** + * Describes one or more Client VPN endpoints in the account. + */ + describeClientVpnEndpoints(params: EC2.Types.DescribeClientVpnEndpointsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnEndpointsResult) => void): Request; + /** + * Describes one or more Client VPN endpoints in the account. + */ + describeClientVpnEndpoints(callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnEndpointsResult) => void): Request; + /** + * Describes the routes for the specified Client VPN endpoint. + */ + describeClientVpnRoutes(params: EC2.Types.DescribeClientVpnRoutesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnRoutesResult) => void): Request; + /** + * Describes the routes for the specified Client VPN endpoint. + */ + describeClientVpnRoutes(callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnRoutesResult) => void): Request; + /** + * Describes the target networks associated with the specified Client VPN endpoint. + */ + describeClientVpnTargetNetworks(params: EC2.Types.DescribeClientVpnTargetNetworksRequest, callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnTargetNetworksResult) => void): Request; + /** + * Describes the target networks associated with the specified Client VPN endpoint. + */ + describeClientVpnTargetNetworks(callback?: (err: AWSError, data: EC2.Types.DescribeClientVpnTargetNetworksResult) => void): Request; + /** + * Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + describeConversionTasks(params: EC2.Types.DescribeConversionTasksRequest, callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + describeConversionTasks(callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Describes one or more of your VPN customer gateways. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + describeCustomerGateways(params: EC2.Types.DescribeCustomerGatewaysRequest, callback?: (err: AWSError, data: EC2.Types.DescribeCustomerGatewaysResult) => void): Request; + /** + * Describes one or more of your VPN customer gateways. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + describeCustomerGateways(callback?: (err: AWSError, data: EC2.Types.DescribeCustomerGatewaysResult) => void): Request; + /** + * Describes one or more of your DHCP options sets. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. + */ + describeDhcpOptions(params: EC2.Types.DescribeDhcpOptionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeDhcpOptionsResult) => void): Request; + /** + * Describes one or more of your DHCP options sets. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide. + */ + describeDhcpOptions(callback?: (err: AWSError, data: EC2.Types.DescribeDhcpOptionsResult) => void): Request; + /** + * Describes one or more of your egress-only internet gateways. + */ + describeEgressOnlyInternetGateways(params: EC2.Types.DescribeEgressOnlyInternetGatewaysRequest, callback?: (err: AWSError, data: EC2.Types.DescribeEgressOnlyInternetGatewaysResult) => void): Request; + /** + * Describes one or more of your egress-only internet gateways. + */ + describeEgressOnlyInternetGateways(callback?: (err: AWSError, data: EC2.Types.DescribeEgressOnlyInternetGatewaysResult) => void): Request; + /** + * Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics. + */ + describeElasticGpus(params: EC2.Types.DescribeElasticGpusRequest, callback?: (err: AWSError, data: EC2.Types.DescribeElasticGpusResult) => void): Request; + /** + * Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics. + */ + describeElasticGpus(callback?: (err: AWSError, data: EC2.Types.DescribeElasticGpusResult) => void): Request; + /** + * Describes the specified export tasks or all your export tasks. + */ + describeExportTasks(params: EC2.Types.DescribeExportTasksRequest, callback?: (err: AWSError, data: EC2.Types.DescribeExportTasksResult) => void): Request; + /** + * Describes the specified export tasks or all your export tasks. + */ + describeExportTasks(callback?: (err: AWSError, data: EC2.Types.DescribeExportTasksResult) => void): Request; + /** + * Describes the events for the specified EC2 Fleet during the specified time. + */ + describeFleetHistory(params: EC2.Types.DescribeFleetHistoryRequest, callback?: (err: AWSError, data: EC2.Types.DescribeFleetHistoryResult) => void): Request; + /** + * Describes the events for the specified EC2 Fleet during the specified time. + */ + describeFleetHistory(callback?: (err: AWSError, data: EC2.Types.DescribeFleetHistoryResult) => void): Request; + /** + * Describes the running instances for the specified EC2 Fleet. + */ + describeFleetInstances(params: EC2.Types.DescribeFleetInstancesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeFleetInstancesResult) => void): Request; + /** + * Describes the running instances for the specified EC2 Fleet. + */ + describeFleetInstances(callback?: (err: AWSError, data: EC2.Types.DescribeFleetInstancesResult) => void): Request; + /** + * Describes the specified EC2 Fleets or all your EC2 Fleets. + */ + describeFleets(params: EC2.Types.DescribeFleetsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeFleetsResult) => void): Request; + /** + * Describes the specified EC2 Fleets or all your EC2 Fleets. + */ + describeFleets(callback?: (err: AWSError, data: EC2.Types.DescribeFleetsResult) => void): Request; + /** + * Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. + */ + describeFlowLogs(params: EC2.Types.DescribeFlowLogsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeFlowLogsResult) => void): Request; + /** + * Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. + */ + describeFlowLogs(callback?: (err: AWSError, data: EC2.Types.DescribeFlowLogsResult) => void): Request; + /** + * Describes the specified attribute of the specified Amazon FPGA Image (AFI). + */ + describeFpgaImageAttribute(params: EC2.Types.DescribeFpgaImageAttributeRequest, callback?: (err: AWSError, data: EC2.Types.DescribeFpgaImageAttributeResult) => void): Request; + /** + * Describes the specified attribute of the specified Amazon FPGA Image (AFI). + */ + describeFpgaImageAttribute(callback?: (err: AWSError, data: EC2.Types.DescribeFpgaImageAttributeResult) => void): Request; + /** + * Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions. + */ + describeFpgaImages(params: EC2.Types.DescribeFpgaImagesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeFpgaImagesResult) => void): Request; + /** + * Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions. + */ + describeFpgaImages(callback?: (err: AWSError, data: EC2.Types.DescribeFpgaImagesResult) => void): Request; + /** + * Describes the Dedicated Host reservations that are available to purchase. The results describe all the Dedicated Host reservation offerings, including offerings that may not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide. + */ + describeHostReservationOfferings(params: EC2.Types.DescribeHostReservationOfferingsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeHostReservationOfferingsResult) => void): Request; + /** + * Describes the Dedicated Host reservations that are available to purchase. The results describe all the Dedicated Host reservation offerings, including offerings that may not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide. + */ + describeHostReservationOfferings(callback?: (err: AWSError, data: EC2.Types.DescribeHostReservationOfferingsResult) => void): Request; + /** + * Describes reservations that are associated with Dedicated Hosts in your account. + */ + describeHostReservations(params: EC2.Types.DescribeHostReservationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeHostReservationsResult) => void): Request; + /** + * Describes reservations that are associated with Dedicated Hosts in your account. + */ + describeHostReservations(callback?: (err: AWSError, data: EC2.Types.DescribeHostReservationsResult) => void): Request; + /** + * Describes the specified Dedicated Hosts or all your Dedicated Hosts. The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released. + */ + describeHosts(params: EC2.Types.DescribeHostsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeHostsResult) => void): Request; + /** + * Describes the specified Dedicated Hosts or all your Dedicated Hosts. The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released. + */ + describeHosts(callback?: (err: AWSError, data: EC2.Types.DescribeHostsResult) => void): Request; + /** + * Describes your IAM instance profile associations. + */ + describeIamInstanceProfileAssociations(params: EC2.Types.DescribeIamInstanceProfileAssociationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeIamInstanceProfileAssociationsResult) => void): Request; + /** + * Describes your IAM instance profile associations. + */ + describeIamInstanceProfileAssociations(callback?: (err: AWSError, data: EC2.Types.DescribeIamInstanceProfileAssociationsResult) => void): Request; + /** + * Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. + */ + describeIdFormat(params: EC2.Types.DescribeIdFormatRequest, callback?: (err: AWSError, data: EC2.Types.DescribeIdFormatResult) => void): Request; + /** + * Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. + */ + describeIdFormat(callback?: (err: AWSError, data: EC2.Types.DescribeIdFormatResult) => void): Request; + /** + * Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the principal specified in the request. They do not apply to the principal that makes the request. + */ + describeIdentityIdFormat(params: EC2.Types.DescribeIdentityIdFormatRequest, callback?: (err: AWSError, data: EC2.Types.DescribeIdentityIdFormatResult) => void): Request; + /** + * Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the principal specified in the request. They do not apply to the principal that makes the request. + */ + describeIdentityIdFormat(callback?: (err: AWSError, data: EC2.Types.DescribeIdentityIdFormatResult) => void): Request; + /** + * Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. + */ + describeImageAttribute(params: EC2.Types.DescribeImageAttributeRequest, callback?: (err: AWSError, data: EC2.Types.ImageAttribute) => void): Request; + /** + * Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. + */ + describeImageAttribute(callback?: (err: AWSError, data: EC2.Types.ImageAttribute) => void): Request; + /** + * Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you. The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions. Recently deregistered images might appear in the returned results for a short interval. + */ + describeImages(params: EC2.Types.DescribeImagesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeImagesResult) => void): Request; + /** + * Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you. The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions. Recently deregistered images might appear in the returned results for a short interval. + */ + describeImages(callback?: (err: AWSError, data: EC2.Types.DescribeImagesResult) => void): Request; + /** + * Displays details about an import virtual machine or import snapshot tasks that are already created. + */ + describeImportImageTasks(params: EC2.Types.DescribeImportImageTasksRequest, callback?: (err: AWSError, data: EC2.Types.DescribeImportImageTasksResult) => void): Request; + /** + * Displays details about an import virtual machine or import snapshot tasks that are already created. + */ + describeImportImageTasks(callback?: (err: AWSError, data: EC2.Types.DescribeImportImageTasksResult) => void): Request; + /** + * Describes your import snapshot tasks. + */ + describeImportSnapshotTasks(params: EC2.Types.DescribeImportSnapshotTasksRequest, callback?: (err: AWSError, data: EC2.Types.DescribeImportSnapshotTasksResult) => void): Request; + /** + * Describes your import snapshot tasks. + */ + describeImportSnapshotTasks(callback?: (err: AWSError, data: EC2.Types.DescribeImportSnapshotTasksResult) => void): Request; + /** + * Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport + */ + describeInstanceAttribute(params: EC2.Types.DescribeInstanceAttributeRequest, callback?: (err: AWSError, data: EC2.Types.InstanceAttribute) => void): Request; + /** + * Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport + */ + describeInstanceAttribute(callback?: (err: AWSError, data: EC2.Types.InstanceAttribute) => void): Request; + /** + * Describes the credit option for CPU usage of the specified T2 or T3 instances. The credit options are standard and unlimited. If you do not specify an instance ID, Amazon EC2 returns T2 and T3 instances with the unlimited credit option, as well as instances that were previously configured as T2 or T3 with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance. If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a T2 or T3 instance, an error is returned. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide. + */ + describeInstanceCreditSpecifications(params: EC2.Types.DescribeInstanceCreditSpecificationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeInstanceCreditSpecificationsResult) => void): Request; + /** + * Describes the credit option for CPU usage of the specified T2 or T3 instances. The credit options are standard and unlimited. If you do not specify an instance ID, Amazon EC2 returns T2 and T3 instances with the unlimited credit option, as well as instances that were previously configured as T2 or T3 with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance. If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a T2 or T3 instance, an error is returned. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide. + */ + describeInstanceCreditSpecifications(callback?: (err: AWSError, data: EC2.Types.DescribeInstanceCreditSpecificationsResult) => void): Request; + /** + * Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide. + */ + describeInstanceStatus(params: EC2.Types.DescribeInstanceStatusRequest, callback?: (err: AWSError, data: EC2.Types.DescribeInstanceStatusResult) => void): Request; + /** + * Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide. + */ + describeInstanceStatus(callback?: (err: AWSError, data: EC2.Types.DescribeInstanceStatusResult) => void): Request; + /** + * Describes the specified instances or all of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally. + */ + describeInstances(params: EC2.Types.DescribeInstancesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Describes the specified instances or all of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally. + */ + describeInstances(callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Describes one or more of your internet gateways. + */ + describeInternetGateways(params: EC2.Types.DescribeInternetGatewaysRequest, callback?: (err: AWSError, data: EC2.Types.DescribeInternetGatewaysResult) => void): Request; + /** + * Describes one or more of your internet gateways. + */ + describeInternetGateways(callback?: (err: AWSError, data: EC2.Types.DescribeInternetGatewaysResult) => void): Request; + /** + * Describes the specified key pairs or all of your key pairs. For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. + */ + describeKeyPairs(params: EC2.Types.DescribeKeyPairsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeKeyPairsResult) => void): Request; + /** + * Describes the specified key pairs or all of your key pairs. For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. + */ + describeKeyPairs(callback?: (err: AWSError, data: EC2.Types.DescribeKeyPairsResult) => void): Request; + /** + * Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. + */ + describeLaunchTemplateVersions(params: EC2.Types.DescribeLaunchTemplateVersionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeLaunchTemplateVersionsResult) => void): Request; + /** + * Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. + */ + describeLaunchTemplateVersions(callback?: (err: AWSError, data: EC2.Types.DescribeLaunchTemplateVersionsResult) => void): Request; + /** + * Describes one or more launch templates. + */ + describeLaunchTemplates(params: EC2.Types.DescribeLaunchTemplatesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeLaunchTemplatesResult) => void): Request; + /** + * Describes one or more launch templates. + */ + describeLaunchTemplates(callback?: (err: AWSError, data: EC2.Types.DescribeLaunchTemplatesResult) => void): Request; + /** + * Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. + */ + describeMovingAddresses(params: EC2.Types.DescribeMovingAddressesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeMovingAddressesResult) => void): Request; + /** + * Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. + */ + describeMovingAddresses(callback?: (err: AWSError, data: EC2.Types.DescribeMovingAddressesResult) => void): Request; + /** + * Describes one or more of your NAT gateways. + */ + describeNatGateways(params: EC2.Types.DescribeNatGatewaysRequest, callback?: (err: AWSError, data: EC2.Types.DescribeNatGatewaysResult) => void): Request; + /** + * Describes one or more of your NAT gateways. + */ + describeNatGateways(callback?: (err: AWSError, data: EC2.Types.DescribeNatGatewaysResult) => void): Request; + /** + * Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + describeNetworkAcls(params: EC2.Types.DescribeNetworkAclsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeNetworkAclsResult) => void): Request; + /** + * Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + describeNetworkAcls(callback?: (err: AWSError, data: EC2.Types.DescribeNetworkAclsResult) => void): Request; + /** + * Describes a network interface attribute. You can specify only one attribute at a time. + */ + describeNetworkInterfaceAttribute(params: EC2.Types.DescribeNetworkInterfaceAttributeRequest, callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfaceAttributeResult) => void): Request; + /** + * Describes a network interface attribute. You can specify only one attribute at a time. + */ + describeNetworkInterfaceAttribute(callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfaceAttributeResult) => void): Request; + /** + * Describes the permissions for your network interfaces. + */ + describeNetworkInterfacePermissions(params: EC2.Types.DescribeNetworkInterfacePermissionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfacePermissionsResult) => void): Request; + /** + * Describes the permissions for your network interfaces. + */ + describeNetworkInterfacePermissions(callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfacePermissionsResult) => void): Request; + /** + * Describes one or more of your network interfaces. + */ + describeNetworkInterfaces(params: EC2.Types.DescribeNetworkInterfacesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfacesResult) => void): Request; + /** + * Describes one or more of your network interfaces. + */ + describeNetworkInterfaces(callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfacesResult) => void): Request; + /** + * Describes the specified placement groups or all of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. + */ + describePlacementGroups(params: EC2.Types.DescribePlacementGroupsRequest, callback?: (err: AWSError, data: EC2.Types.DescribePlacementGroupsResult) => void): Request; + /** + * Describes the specified placement groups or all of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. + */ + describePlacementGroups(callback?: (err: AWSError, data: EC2.Types.DescribePlacementGroupsResult) => void): Request; + /** + * Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint. Currently, the services that support this action are Amazon S3 and Amazon DynamoDB. + */ + describePrefixLists(params: EC2.Types.DescribePrefixListsRequest, callback?: (err: AWSError, data: EC2.Types.DescribePrefixListsResult) => void): Request; + /** + * Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint. Currently, the services that support this action are Amazon S3 and Amazon DynamoDB. + */ + describePrefixLists(callback?: (err: AWSError, data: EC2.Types.DescribePrefixListsResult) => void): Request; + /** + * Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference. By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. + */ + describePrincipalIdFormat(params: EC2.Types.DescribePrincipalIdFormatRequest, callback?: (err: AWSError, data: EC2.Types.DescribePrincipalIdFormatResult) => void): Request; + /** + * Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference. By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. + */ + describePrincipalIdFormat(callback?: (err: AWSError, data: EC2.Types.DescribePrincipalIdFormatResult) => void): Request; + /** + * Describes the specified IPv4 address pools. + */ + describePublicIpv4Pools(params: EC2.Types.DescribePublicIpv4PoolsRequest, callback?: (err: AWSError, data: EC2.Types.DescribePublicIpv4PoolsResult) => void): Request; + /** + * Describes the specified IPv4 address pools. + */ + describePublicIpv4Pools(callback?: (err: AWSError, data: EC2.Types.DescribePublicIpv4PoolsResult) => void): Request; + /** + * Describes the regions that are currently available to you. For a list of the regions supported by Amazon EC2, see Regions and Endpoints. + */ + describeRegions(params: EC2.Types.DescribeRegionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeRegionsResult) => void): Request; + /** + * Describes the regions that are currently available to you. For a list of the regions supported by Amazon EC2, see Regions and Endpoints. + */ + describeRegions(callback?: (err: AWSError, data: EC2.Types.DescribeRegionsResult) => void): Request; + /** + * Describes one or more of the Reserved Instances that you purchased. For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstances(params: EC2.Types.DescribeReservedInstancesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesResult) => void): Request; + /** + * Describes one or more of the Reserved Instances that you purchased. For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstances(callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesResult) => void): Request; + /** + * Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstancesListings(params: EC2.Types.DescribeReservedInstancesListingsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesListingsResult) => void): Request; + /** + * Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstancesListings(callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesListingsResult) => void): Request; + /** + * Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstancesModifications(params: EC2.Types.DescribeReservedInstancesModificationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesModificationsResult) => void): Request; + /** + * Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstancesModifications(callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesModificationsResult) => void): Request; + /** + * Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstancesOfferings(params: EC2.Types.DescribeReservedInstancesOfferingsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesOfferingsResult) => void): Request; + /** + * Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances. For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + describeReservedInstancesOfferings(callback?: (err: AWSError, data: EC2.Types.DescribeReservedInstancesOfferingsResult) => void): Request; + /** + * Describes one or more of your route tables. Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + describeRouteTables(params: EC2.Types.DescribeRouteTablesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeRouteTablesResult) => void): Request; + /** + * Describes one or more of your route tables. Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + describeRouteTables(callback?: (err: AWSError, data: EC2.Types.DescribeRouteTablesResult) => void): Request; + /** + * Finds available schedules that meet the specified criteria. You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule. + */ + describeScheduledInstanceAvailability(params: EC2.Types.DescribeScheduledInstanceAvailabilityRequest, callback?: (err: AWSError, data: EC2.Types.DescribeScheduledInstanceAvailabilityResult) => void): Request; + /** + * Finds available schedules that meet the specified criteria. You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule. + */ + describeScheduledInstanceAvailability(callback?: (err: AWSError, data: EC2.Types.DescribeScheduledInstanceAvailabilityResult) => void): Request; + /** + * Describes the specified Scheduled Instances or all your Scheduled Instances. + */ + describeScheduledInstances(params: EC2.Types.DescribeScheduledInstancesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeScheduledInstancesResult) => void): Request; + /** + * Describes the specified Scheduled Instances or all your Scheduled Instances. + */ + describeScheduledInstances(callback?: (err: AWSError, data: EC2.Types.DescribeScheduledInstancesResult) => void): Request; + /** + * [VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request. + */ + describeSecurityGroupReferences(params: EC2.Types.DescribeSecurityGroupReferencesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSecurityGroupReferencesResult) => void): Request; + /** + * [VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request. + */ + describeSecurityGroupReferences(callback?: (err: AWSError, data: EC2.Types.DescribeSecurityGroupReferencesResult) => void): Request; + /** + * Describes the specified security groups or all of your security groups. A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. + */ + describeSecurityGroups(params: EC2.Types.DescribeSecurityGroupsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSecurityGroupsResult) => void): Request; + /** + * Describes the specified security groups or all of your security groups. A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. + */ + describeSecurityGroups(callback?: (err: AWSError, data: EC2.Types.DescribeSecurityGroupsResult) => void): Request; + /** + * Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + describeSnapshotAttribute(params: EC2.Types.DescribeSnapshotAttributeRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSnapshotAttributeResult) => void): Request; + /** + * Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + describeSnapshotAttribute(callback?: (err: AWSError, data: EC2.Types.DescribeSnapshotAttributeResult) => void): Request; + /** + * Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you. The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have explicit create volume permissions. The create volume permissions fall into the following categories: public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots. explicit: The owner of the snapshot granted create volume permissions to a specific AWS account. implicit: An AWS account has implicit create volume permissions for all snapshots it owns. The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own. If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots. If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results. For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + describeSnapshots(params: EC2.Types.DescribeSnapshotsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSnapshotsResult) => void): Request; + /** + * Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you. The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have explicit create volume permissions. The create volume permissions fall into the following categories: public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots. explicit: The owner of the snapshot granted create volume permissions to a specific AWS account. implicit: An AWS account has implicit create volume permissions for all snapshots it owns. The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own. If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots. If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results. For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + describeSnapshots(callback?: (err: AWSError, data: EC2.Types.DescribeSnapshotsResult) => void): Request; + /** + * Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances. + */ + describeSpotDatafeedSubscription(params: EC2.Types.DescribeSpotDatafeedSubscriptionRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSpotDatafeedSubscriptionResult) => void): Request; + /** + * Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances. + */ + describeSpotDatafeedSubscription(callback?: (err: AWSError, data: EC2.Types.DescribeSpotDatafeedSubscriptionResult) => void): Request; + /** + * Describes the running instances for the specified Spot Fleet. + */ + describeSpotFleetInstances(params: EC2.Types.DescribeSpotFleetInstancesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSpotFleetInstancesResponse) => void): Request; + /** + * Describes the running instances for the specified Spot Fleet. + */ + describeSpotFleetInstances(callback?: (err: AWSError, data: EC2.Types.DescribeSpotFleetInstancesResponse) => void): Request; + /** + * Describes the events for the specified Spot Fleet request during the specified time. Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours. + */ + describeSpotFleetRequestHistory(params: EC2.Types.DescribeSpotFleetRequestHistoryRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSpotFleetRequestHistoryResponse) => void): Request; + /** + * Describes the events for the specified Spot Fleet request during the specified time. Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours. + */ + describeSpotFleetRequestHistory(callback?: (err: AWSError, data: EC2.Types.DescribeSpotFleetRequestHistoryResponse) => void): Request; + /** + * Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated. + */ + describeSpotFleetRequests(params: EC2.Types.DescribeSpotFleetRequestsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSpotFleetRequestsResponse) => void): Request; + /** + * Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated. + */ + describeSpotFleetRequests(callback?: (err: AWSError, data: EC2.Types.DescribeSpotFleetRequestsResponse) => void): Request; + /** + * Describes the specified Spot Instance requests. You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot. We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results. Spot Instance requests are deleted four hours after they are canceled and their instances are terminated. + */ + describeSpotInstanceRequests(params: EC2.Types.DescribeSpotInstanceRequestsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSpotInstanceRequestsResult) => void): Request; + /** + * Describes the specified Spot Instance requests. You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot. We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results. Spot Instance requests are deleted four hours after they are canceled and their instances are terminated. + */ + describeSpotInstanceRequests(callback?: (err: AWSError, data: EC2.Types.DescribeSpotInstanceRequestsResult) => void): Request; + /** + * Describes the Spot price history. For more information, see Spot Instance Pricing History in the Amazon EC2 User Guide for Linux Instances. When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. + */ + describeSpotPriceHistory(params: EC2.Types.DescribeSpotPriceHistoryRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSpotPriceHistoryResult) => void): Request; + /** + * Describes the Spot price history. For more information, see Spot Instance Pricing History in the Amazon EC2 User Guide for Linux Instances. When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. + */ + describeSpotPriceHistory(callback?: (err: AWSError, data: EC2.Types.DescribeSpotPriceHistoryResult) => void): Request; + /** + * [VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted. + */ + describeStaleSecurityGroups(params: EC2.Types.DescribeStaleSecurityGroupsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeStaleSecurityGroupsResult) => void): Request; + /** + * [VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted. + */ + describeStaleSecurityGroups(callback?: (err: AWSError, data: EC2.Types.DescribeStaleSecurityGroupsResult) => void): Request; + /** + * Describes one or more of your subnets. For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide. + */ + describeSubnets(params: EC2.Types.DescribeSubnetsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeSubnetsResult) => void): Request; + /** + * Describes one or more of your subnets. For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide. + */ + describeSubnets(callback?: (err: AWSError, data: EC2.Types.DescribeSubnetsResult) => void): Request; + /** + * Describes the specified tags for your EC2 resources. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. + */ + describeTags(params: EC2.Types.DescribeTagsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeTagsResult) => void): Request; + /** + * Describes the specified tags for your EC2 resources. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. + */ + describeTags(callback?: (err: AWSError, data: EC2.Types.DescribeTagsResult) => void): Request; + /** + * Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner. + */ + describeTransitGatewayAttachments(params: EC2.Types.DescribeTransitGatewayAttachmentsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewayAttachmentsResult) => void): Request; + /** + * Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner. + */ + describeTransitGatewayAttachments(callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewayAttachmentsResult) => void): Request; + /** + * Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results. + */ + describeTransitGatewayRouteTables(params: EC2.Types.DescribeTransitGatewayRouteTablesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewayRouteTablesResult) => void): Request; + /** + * Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results. + */ + describeTransitGatewayRouteTables(callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewayRouteTablesResult) => void): Request; + /** + * Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results. + */ + describeTransitGatewayVpcAttachments(params: EC2.Types.DescribeTransitGatewayVpcAttachmentsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewayVpcAttachmentsResult) => void): Request; + /** + * Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results. + */ + describeTransitGatewayVpcAttachments(callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewayVpcAttachmentsResult) => void): Request; + /** + * Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results. + */ + describeTransitGateways(params: EC2.Types.DescribeTransitGatewaysRequest, callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewaysResult) => void): Request; + /** + * Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results. + */ + describeTransitGateways(callback?: (err: AWSError, data: EC2.Types.DescribeTransitGatewaysResult) => void): Request; + /** + * Describes the specified attribute of the specified volume. You can specify only one attribute at a time. For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + describeVolumeAttribute(params: EC2.Types.DescribeVolumeAttributeRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVolumeAttributeResult) => void): Request; + /** + * Describes the specified attribute of the specified volume. You can specify only one attribute at a time. For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + describeVolumeAttribute(callback?: (err: AWSError, data: EC2.Types.DescribeVolumeAttributeResult) => void): Request; + /** + * Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. The DescribeVolumeStatus operation provides the following information about the specified volumes: Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the Status of Your Volumes in the Amazon Elastic Compute Cloud User Guide. Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency. Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.) + */ + describeVolumeStatus(params: EC2.Types.DescribeVolumeStatusRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVolumeStatusResult) => void): Request; + /** + * Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. The DescribeVolumeStatus operation provides the following information about the specified volumes: Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the Status of Your Volumes in the Amazon Elastic Compute Cloud User Guide. Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency. Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.) + */ + describeVolumeStatus(callback?: (err: AWSError, data: EC2.Types.DescribeVolumeStatusResult) => void): Request; + /** + * Describes the specified EBS volumes or all of your EBS volumes. If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results. For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + describeVolumes(params: EC2.Types.DescribeVolumesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Describes the specified EBS volumes or all of your EBS volumes. If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results. For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + describeVolumes(callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Reports the current modification status of EBS volumes. Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null. You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring Volume Modifications" in the Amazon Elastic Compute Cloud User Guide. + */ + describeVolumesModifications(params: EC2.Types.DescribeVolumesModificationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVolumesModificationsResult) => void): Request; + /** + * Reports the current modification status of EBS volumes. Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null. You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring Volume Modifications" in the Amazon Elastic Compute Cloud User Guide. + */ + describeVolumesModifications(callback?: (err: AWSError, data: EC2.Types.DescribeVolumesModificationsResult) => void): Request; + /** + * Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. + */ + describeVpcAttribute(params: EC2.Types.DescribeVpcAttributeRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcAttributeResult) => void): Request; + /** + * Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. + */ + describeVpcAttribute(callback?: (err: AWSError, data: EC2.Types.DescribeVpcAttributeResult) => void): Request; + /** + * Describes the ClassicLink status of one or more VPCs. + */ + describeVpcClassicLink(params: EC2.Types.DescribeVpcClassicLinkRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcClassicLinkResult) => void): Request; + /** + * Describes the ClassicLink status of one or more VPCs. + */ + describeVpcClassicLink(callback?: (err: AWSError, data: EC2.Types.DescribeVpcClassicLinkResult) => void): Request; + /** + * Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + describeVpcClassicLinkDnsSupport(params: EC2.Types.DescribeVpcClassicLinkDnsSupportRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcClassicLinkDnsSupportResult) => void): Request; + /** + * Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + describeVpcClassicLinkDnsSupport(callback?: (err: AWSError, data: EC2.Types.DescribeVpcClassicLinkDnsSupportResult) => void): Request; + /** + * Describes the connection notifications for VPC endpoints and VPC endpoint services. + */ + describeVpcEndpointConnectionNotifications(params: EC2.Types.DescribeVpcEndpointConnectionNotificationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointConnectionNotificationsResult) => void): Request; + /** + * Describes the connection notifications for VPC endpoints and VPC endpoint services. + */ + describeVpcEndpointConnectionNotifications(callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointConnectionNotificationsResult) => void): Request; + /** + * Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance. + */ + describeVpcEndpointConnections(params: EC2.Types.DescribeVpcEndpointConnectionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointConnectionsResult) => void): Request; + /** + * Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance. + */ + describeVpcEndpointConnections(callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointConnectionsResult) => void): Request; + /** + * Describes the VPC endpoint service configurations in your account (your services). + */ + describeVpcEndpointServiceConfigurations(params: EC2.Types.DescribeVpcEndpointServiceConfigurationsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointServiceConfigurationsResult) => void): Request; + /** + * Describes the VPC endpoint service configurations in your account (your services). + */ + describeVpcEndpointServiceConfigurations(callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointServiceConfigurationsResult) => void): Request; + /** + * Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. + */ + describeVpcEndpointServicePermissions(params: EC2.Types.DescribeVpcEndpointServicePermissionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointServicePermissionsResult) => void): Request; + /** + * Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. + */ + describeVpcEndpointServicePermissions(callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointServicePermissionsResult) => void): Request; + /** + * Describes available services to which you can create a VPC endpoint. + */ + describeVpcEndpointServices(params: EC2.Types.DescribeVpcEndpointServicesRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointServicesResult) => void): Request; + /** + * Describes available services to which you can create a VPC endpoint. + */ + describeVpcEndpointServices(callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointServicesResult) => void): Request; + /** + * Describes one or more of your VPC endpoints. + */ + describeVpcEndpoints(params: EC2.Types.DescribeVpcEndpointsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointsResult) => void): Request; + /** + * Describes one or more of your VPC endpoints. + */ + describeVpcEndpoints(callback?: (err: AWSError, data: EC2.Types.DescribeVpcEndpointsResult) => void): Request; + /** + * Describes one or more of your VPC peering connections. + */ + describeVpcPeeringConnections(params: EC2.Types.DescribeVpcPeeringConnectionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcPeeringConnectionsResult) => void): Request; + /** + * Describes one or more of your VPC peering connections. + */ + describeVpcPeeringConnections(callback?: (err: AWSError, data: EC2.Types.DescribeVpcPeeringConnectionsResult) => void): Request; + /** + * Describes one or more of your VPCs. + */ + describeVpcs(params: EC2.Types.DescribeVpcsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpcsResult) => void): Request; + /** + * Describes one or more of your VPCs. + */ + describeVpcs(callback?: (err: AWSError, data: EC2.Types.DescribeVpcsResult) => void): Request; + /** + * Describes one or more of your VPN connections. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + describeVpnConnections(params: EC2.Types.DescribeVpnConnectionsRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpnConnectionsResult) => void): Request; + /** + * Describes one or more of your VPN connections. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + describeVpnConnections(callback?: (err: AWSError, data: EC2.Types.DescribeVpnConnectionsResult) => void): Request; + /** + * Describes one or more of your virtual private gateways. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + describeVpnGateways(params: EC2.Types.DescribeVpnGatewaysRequest, callback?: (err: AWSError, data: EC2.Types.DescribeVpnGatewaysResult) => void): Request; + /** + * Describes one or more of your virtual private gateways. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide. + */ + describeVpnGateways(callback?: (err: AWSError, data: EC2.Types.DescribeVpnGatewaysResult) => void): Request; + /** + * Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. + */ + detachClassicLinkVpc(params: EC2.Types.DetachClassicLinkVpcRequest, callback?: (err: AWSError, data: EC2.Types.DetachClassicLinkVpcResult) => void): Request; + /** + * Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. + */ + detachClassicLinkVpc(callback?: (err: AWSError, data: EC2.Types.DetachClassicLinkVpcResult) => void): Request; + /** + * Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses. + */ + detachInternetGateway(params: EC2.Types.DetachInternetGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses. + */ + detachInternetGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a network interface from an instance. + */ + detachNetworkInterface(params: EC2.Types.DetachNetworkInterfaceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a network interface from an instance. + */ + detachNetworkInterface(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide. + */ + detachVolume(params: EC2.Types.DetachVolumeRequest, callback?: (err: AWSError, data: EC2.Types.VolumeAttachment) => void): Request; + /** + * Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide. + */ + detachVolume(callback?: (err: AWSError, data: EC2.Types.VolumeAttachment) => void): Request; + /** + * Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway. + */ + detachVpnGateway(params: EC2.Types.DetachVpnGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway. + */ + detachVpnGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the specified resource attachment from propagating routes to the specified propagation route table. + */ + disableTransitGatewayRouteTablePropagation(params: EC2.Types.DisableTransitGatewayRouteTablePropagationRequest, callback?: (err: AWSError, data: EC2.Types.DisableTransitGatewayRouteTablePropagationResult) => void): Request; + /** + * Disables the specified resource attachment from propagating routes to the specified propagation route table. + */ + disableTransitGatewayRouteTablePropagation(callback?: (err: AWSError, data: EC2.Types.DisableTransitGatewayRouteTablePropagationResult) => void): Request; + /** + * Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. + */ + disableVgwRoutePropagation(params: EC2.Types.DisableVgwRoutePropagationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. + */ + disableVgwRoutePropagation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. + */ + disableVpcClassicLink(params: EC2.Types.DisableVpcClassicLinkRequest, callback?: (err: AWSError, data: EC2.Types.DisableVpcClassicLinkResult) => void): Request; + /** + * Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. + */ + disableVpcClassicLink(callback?: (err: AWSError, data: EC2.Types.DisableVpcClassicLinkResult) => void): Request; + /** + * Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + disableVpcClassicLinkDnsSupport(params: EC2.Types.DisableVpcClassicLinkDnsSupportRequest, callback?: (err: AWSError, data: EC2.Types.DisableVpcClassicLinkDnsSupportResult) => void): Request; + /** + * Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + disableVpcClassicLinkDnsSupport(callback?: (err: AWSError, data: EC2.Types.DisableVpcClassicLinkDnsSupportResult) => void): Request; + /** + * Disassociates an Elastic IP address from the instance or network interface it's associated with. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. + */ + disassociateAddress(params: EC2.Types.DisassociateAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates an Elastic IP address from the instance or network interface it's associated with. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. + */ + disassociateAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens: The route that was automatically added for the VPC is deleted All active client connections are terminated New client connections are disallowed The Client VPN endpoint's status changes to pending-associate + */ + disassociateClientVpnTargetNetwork(params: EC2.Types.DisassociateClientVpnTargetNetworkRequest, callback?: (err: AWSError, data: EC2.Types.DisassociateClientVpnTargetNetworkResult) => void): Request; + /** + * Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens: The route that was automatically added for the VPC is deleted All active client connections are terminated New client connections are disallowed The Client VPN endpoint's status changes to pending-associate + */ + disassociateClientVpnTargetNetwork(callback?: (err: AWSError, data: EC2.Types.DisassociateClientVpnTargetNetworkResult) => void): Request; + /** + * Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID. + */ + disassociateIamInstanceProfile(params: EC2.Types.DisassociateIamInstanceProfileRequest, callback?: (err: AWSError, data: EC2.Types.DisassociateIamInstanceProfileResult) => void): Request; + /** + * Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID. + */ + disassociateIamInstanceProfile(callback?: (err: AWSError, data: EC2.Types.DisassociateIamInstanceProfileResult) => void): Request; + /** + * Disassociates a subnet from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + disassociateRouteTable(params: EC2.Types.DisassociateRouteTableRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates a subnet from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + disassociateRouteTable(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. + */ + disassociateSubnetCidrBlock(params: EC2.Types.DisassociateSubnetCidrBlockRequest, callback?: (err: AWSError, data: EC2.Types.DisassociateSubnetCidrBlockResult) => void): Request; + /** + * Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. + */ + disassociateSubnetCidrBlock(callback?: (err: AWSError, data: EC2.Types.DisassociateSubnetCidrBlockResult) => void): Request; + /** + * Disassociates a resource attachment from a transit gateway route table. + */ + disassociateTransitGatewayRouteTable(params: EC2.Types.DisassociateTransitGatewayRouteTableRequest, callback?: (err: AWSError, data: EC2.Types.DisassociateTransitGatewayRouteTableResult) => void): Request; + /** + * Disassociates a resource attachment from a transit gateway route table. + */ + disassociateTransitGatewayRouteTable(callback?: (err: AWSError, data: EC2.Types.DisassociateTransitGatewayRouteTableResult) => void): Request; + /** + * Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block). + */ + disassociateVpcCidrBlock(params: EC2.Types.DisassociateVpcCidrBlockRequest, callback?: (err: AWSError, data: EC2.Types.DisassociateVpcCidrBlockResult) => void): Request; + /** + * Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block). + */ + disassociateVpcCidrBlock(callback?: (err: AWSError, data: EC2.Types.DisassociateVpcCidrBlockResult) => void): Request; + /** + * Enables the specified attachment to propagate routes to the specified propagation route table. + */ + enableTransitGatewayRouteTablePropagation(params: EC2.Types.EnableTransitGatewayRouteTablePropagationRequest, callback?: (err: AWSError, data: EC2.Types.EnableTransitGatewayRouteTablePropagationResult) => void): Request; + /** + * Enables the specified attachment to propagate routes to the specified propagation route table. + */ + enableTransitGatewayRouteTablePropagation(callback?: (err: AWSError, data: EC2.Types.EnableTransitGatewayRouteTablePropagationResult) => void): Request; + /** + * Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. + */ + enableVgwRoutePropagation(params: EC2.Types.EnableVgwRoutePropagationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. + */ + enableVgwRoutePropagation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. + */ + enableVolumeIO(params: EC2.Types.EnableVolumeIORequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. + */ + enableVolumeIO(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + enableVpcClassicLink(params: EC2.Types.EnableVpcClassicLinkRequest, callback?: (err: AWSError, data: EC2.Types.EnableVpcClassicLinkResult) => void): Request; + /** + * Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + enableVpcClassicLink(callback?: (err: AWSError, data: EC2.Types.EnableVpcClassicLinkResult) => void): Request; + /** + * Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + enableVpcClassicLinkDnsSupport(params: EC2.Types.EnableVpcClassicLinkDnsSupportRequest, callback?: (err: AWSError, data: EC2.Types.EnableVpcClassicLinkDnsSupportResult) => void): Request; + /** + * Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. + */ + enableVpcClassicLinkDnsSupport(callback?: (err: AWSError, data: EC2.Types.EnableVpcClassicLinkDnsSupportResult) => void): Request; + /** + * Downloads the client certificate revocation list for the specified Client VPN endpoint. + */ + exportClientVpnClientCertificateRevocationList(params: EC2.Types.ExportClientVpnClientCertificateRevocationListRequest, callback?: (err: AWSError, data: EC2.Types.ExportClientVpnClientCertificateRevocationListResult) => void): Request; + /** + * Downloads the client certificate revocation list for the specified Client VPN endpoint. + */ + exportClientVpnClientCertificateRevocationList(callback?: (err: AWSError, data: EC2.Types.ExportClientVpnClientCertificateRevocationListResult) => void): Request; + /** + * Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint. + */ + exportClientVpnClientConfiguration(params: EC2.Types.ExportClientVpnClientConfigurationRequest, callback?: (err: AWSError, data: EC2.Types.ExportClientVpnClientConfigurationResult) => void): Request; + /** + * Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint. + */ + exportClientVpnClientConfiguration(callback?: (err: AWSError, data: EC2.Types.ExportClientVpnClientConfigurationResult) => void): Request; + /** + * Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range. + */ + exportTransitGatewayRoutes(params: EC2.Types.ExportTransitGatewayRoutesRequest, callback?: (err: AWSError, data: EC2.Types.ExportTransitGatewayRoutesResult) => void): Request; + /** + * Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range. + */ + exportTransitGatewayRoutes(callback?: (err: AWSError, data: EC2.Types.ExportTransitGatewayRoutesResult) => void): Request; + /** + * Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors. By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available. You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor. For more information, see Instance Console Output in the Amazon Elastic Compute Cloud User Guide. + */ + getConsoleOutput(params: EC2.Types.GetConsoleOutputRequest, callback?: (err: AWSError, data: EC2.Types.GetConsoleOutputResult) => void): Request; + /** + * Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors. By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available. You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor. For more information, see Instance Console Output in the Amazon Elastic Compute Cloud User Guide. + */ + getConsoleOutput(callback?: (err: AWSError, data: EC2.Types.GetConsoleOutputResult) => void): Request; + /** + * Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded. + */ + getConsoleScreenshot(params: EC2.Types.GetConsoleScreenshotRequest, callback?: (err: AWSError, data: EC2.Types.GetConsoleScreenshotResult) => void): Request; + /** + * Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded. + */ + getConsoleScreenshot(callback?: (err: AWSError, data: EC2.Types.GetConsoleScreenshotResult) => void): Request; + /** + * Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased. + */ + getHostReservationPurchasePreview(params: EC2.Types.GetHostReservationPurchasePreviewRequest, callback?: (err: AWSError, data: EC2.Types.GetHostReservationPurchasePreviewResult) => void): Request; + /** + * Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased. + */ + getHostReservationPurchasePreview(callback?: (err: AWSError, data: EC2.Types.GetHostReservationPurchasePreviewResult) => void): Request; + /** + * Retrieves the configuration data of the specified instance. You can use this data to create a launch template. + */ + getLaunchTemplateData(params: EC2.Types.GetLaunchTemplateDataRequest, callback?: (err: AWSError, data: EC2.Types.GetLaunchTemplateDataResult) => void): Request; + /** + * Retrieves the configuration data of the specified instance. You can use this data to create a launch template. + */ + getLaunchTemplateData(callback?: (err: AWSError, data: EC2.Types.GetLaunchTemplateDataResult) => void): Request; + /** + * Retrieves the encrypted administrator password for a running Windows instance. The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon Elastic Compute Cloud User Guide. For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling. The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. + */ + getPasswordData(params: EC2.Types.GetPasswordDataRequest, callback?: (err: AWSError, data: EC2.Types.GetPasswordDataResult) => void): Request; + /** + * Retrieves the encrypted administrator password for a running Windows instance. The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon Elastic Compute Cloud User Guide. For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling. The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. + */ + getPasswordData(callback?: (err: AWSError, data: EC2.Types.GetPasswordDataResult) => void): Request; + /** + * Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange. + */ + getReservedInstancesExchangeQuote(params: EC2.Types.GetReservedInstancesExchangeQuoteRequest, callback?: (err: AWSError, data: EC2.Types.GetReservedInstancesExchangeQuoteResult) => void): Request; + /** + * Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange. + */ + getReservedInstancesExchangeQuote(callback?: (err: AWSError, data: EC2.Types.GetReservedInstancesExchangeQuoteResult) => void): Request; + /** + * Lists the route tables to which the specified resource attachment propagates routes. + */ + getTransitGatewayAttachmentPropagations(params: EC2.Types.GetTransitGatewayAttachmentPropagationsRequest, callback?: (err: AWSError, data: EC2.Types.GetTransitGatewayAttachmentPropagationsResult) => void): Request; + /** + * Lists the route tables to which the specified resource attachment propagates routes. + */ + getTransitGatewayAttachmentPropagations(callback?: (err: AWSError, data: EC2.Types.GetTransitGatewayAttachmentPropagationsResult) => void): Request; + /** + * Gets information about the associations for the specified transit gateway route table. + */ + getTransitGatewayRouteTableAssociations(params: EC2.Types.GetTransitGatewayRouteTableAssociationsRequest, callback?: (err: AWSError, data: EC2.Types.GetTransitGatewayRouteTableAssociationsResult) => void): Request; + /** + * Gets information about the associations for the specified transit gateway route table. + */ + getTransitGatewayRouteTableAssociations(callback?: (err: AWSError, data: EC2.Types.GetTransitGatewayRouteTableAssociationsResult) => void): Request; + /** + * Gets information about the route table propagations for the specified transit gateway route table. + */ + getTransitGatewayRouteTablePropagations(params: EC2.Types.GetTransitGatewayRouteTablePropagationsRequest, callback?: (err: AWSError, data: EC2.Types.GetTransitGatewayRouteTablePropagationsResult) => void): Request; + /** + * Gets information about the route table propagations for the specified transit gateway route table. + */ + getTransitGatewayRouteTablePropagations(callback?: (err: AWSError, data: EC2.Types.GetTransitGatewayRouteTablePropagationsResult) => void): Request; + /** + * Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list. Uploading a client certificate revocation list resets existing client connections. + */ + importClientVpnClientCertificateRevocationList(params: EC2.Types.ImportClientVpnClientCertificateRevocationListRequest, callback?: (err: AWSError, data: EC2.Types.ImportClientVpnClientCertificateRevocationListResult) => void): Request; + /** + * Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list. Uploading a client certificate revocation list resets existing client connections. + */ + importClientVpnClientCertificateRevocationList(callback?: (err: AWSError, data: EC2.Types.ImportClientVpnClientCertificateRevocationListResult) => void): Request; + /** + * Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide. + */ + importImage(params: EC2.Types.ImportImageRequest, callback?: (err: AWSError, data: EC2.Types.ImportImageResult) => void): Request; + /** + * Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide. + */ + importImage(callback?: (err: AWSError, data: EC2.Types.ImportImageResult) => void): Request; + /** + * Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + importInstance(params: EC2.Types.ImportInstanceRequest, callback?: (err: AWSError, data: EC2.Types.ImportInstanceResult) => void): Request; + /** + * Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + importInstance(callback?: (err: AWSError, data: EC2.Types.ImportInstanceResult) => void): Request; + /** + * Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. + */ + importKeyPair(params: EC2.Types.ImportKeyPairRequest, callback?: (err: AWSError, data: EC2.Types.ImportKeyPairResult) => void): Request; + /** + * Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. + */ + importKeyPair(callback?: (err: AWSError, data: EC2.Types.ImportKeyPairResult) => void): Request; + /** + * Imports a disk into an EBS snapshot. + */ + importSnapshot(params: EC2.Types.ImportSnapshotRequest, callback?: (err: AWSError, data: EC2.Types.ImportSnapshotResult) => void): Request; + /** + * Imports a disk into an EBS snapshot. + */ + importSnapshot(callback?: (err: AWSError, data: EC2.Types.ImportSnapshotResult) => void): Request; + /** + * Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + importVolume(params: EC2.Types.ImportVolumeRequest, callback?: (err: AWSError, data: EC2.Types.ImportVolumeResult) => void): Request; + /** + * Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + importVolume(callback?: (err: AWSError, data: EC2.Types.ImportVolumeResult) => void): Request; + /** + * Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. + */ + modifyCapacityReservation(params: EC2.Types.ModifyCapacityReservationRequest, callback?: (err: AWSError, data: EC2.Types.ModifyCapacityReservationResult) => void): Request; + /** + * Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. + */ + modifyCapacityReservation(callback?: (err: AWSError, data: EC2.Types.ModifyCapacityReservationResult) => void): Request; + /** + * Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections. + */ + modifyClientVpnEndpoint(params: EC2.Types.ModifyClientVpnEndpointRequest, callback?: (err: AWSError, data: EC2.Types.ModifyClientVpnEndpointResult) => void): Request; + /** + * Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections. + */ + modifyClientVpnEndpoint(callback?: (err: AWSError, data: EC2.Types.ModifyClientVpnEndpointResult) => void): Request; + /** + * Modifies the specified EC2 Fleet. While the EC2 Fleet is being modified, it is in the modifying state. + */ + modifyFleet(params: EC2.Types.ModifyFleetRequest, callback?: (err: AWSError, data: EC2.Types.ModifyFleetResult) => void): Request; + /** + * Modifies the specified EC2 Fleet. While the EC2 Fleet is being modified, it is in the modifying state. + */ + modifyFleet(callback?: (err: AWSError, data: EC2.Types.ModifyFleetResult) => void): Request; + /** + * Modifies the specified attribute of the specified Amazon FPGA Image (AFI). + */ + modifyFpgaImageAttribute(params: EC2.Types.ModifyFpgaImageAttributeRequest, callback?: (err: AWSError, data: EC2.Types.ModifyFpgaImageAttributeResult) => void): Request; + /** + * Modifies the specified attribute of the specified Amazon FPGA Image (AFI). + */ + modifyFpgaImageAttribute(callback?: (err: AWSError, data: EC2.Types.ModifyFpgaImageAttributeResult) => void): Request; + /** + * Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled. + */ + modifyHosts(params: EC2.Types.ModifyHostsRequest, callback?: (err: AWSError, data: EC2.Types.ModifyHostsResult) => void): Request; + /** + * Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled. + */ + modifyHosts(callback?: (err: AWSError, data: EC2.Types.ModifyHostsResult) => void): Request; + /** + * Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. + */ + modifyIdFormat(params: EC2.Types.ModifyIdFormatRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. + */ + modifyIdFormat(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. + */ + modifyIdentityIdFormat(params: EC2.Types.ModifyIdentityIdFormatRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. + */ + modifyIdentityIdFormat(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description, LaunchPermission, or ProductCode. AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance. + */ + modifyImageAttribute(params: EC2.Types.ModifyImageAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description, LaunchPermission, or ProductCode. AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance. + */ + modifyImageAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action. To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide. + */ + modifyInstanceAttribute(params: EC2.Types.ModifyInstanceAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action. To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide. + */ + modifyInstanceAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity. + */ + modifyInstanceCapacityReservationAttributes(params: EC2.Types.ModifyInstanceCapacityReservationAttributesRequest, callback?: (err: AWSError, data: EC2.Types.ModifyInstanceCapacityReservationAttributesResult) => void): Request; + /** + * Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity. + */ + modifyInstanceCapacityReservationAttributes(callback?: (err: AWSError, data: EC2.Types.ModifyInstanceCapacityReservationAttributesResult) => void): Request; + /** + * Modifies the credit option for CPU usage on a running or stopped T2 or T3 instance. The credit options are standard and unlimited. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide. + */ + modifyInstanceCreditSpecification(params: EC2.Types.ModifyInstanceCreditSpecificationRequest, callback?: (err: AWSError, data: EC2.Types.ModifyInstanceCreditSpecificationResult) => void): Request; + /** + * Modifies the credit option for CPU usage on a running or stopped T2 or T3 instance. The credit options are standard and unlimited. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide. + */ + modifyInstanceCreditSpecification(callback?: (err: AWSError, data: EC2.Types.ModifyInstanceCreditSpecificationResult) => void): Request; + /** + * Modifies the start time for a scheduled Amazon EC2 instance event. + */ + modifyInstanceEventStartTime(params: EC2.Types.ModifyInstanceEventStartTimeRequest, callback?: (err: AWSError, data: EC2.Types.ModifyInstanceEventStartTimeResult) => void): Request; + /** + * Modifies the start time for a scheduled Amazon EC2 instance event. + */ + modifyInstanceEventStartTime(callback?: (err: AWSError, data: EC2.Types.ModifyInstanceEventStartTimeResult) => void): Request; + /** + * Modifies the placement attributes for a specified instance. You can do the following: Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists. Change the Dedicated Host with which an instance is associated. Change the instance tenancy of an instance from host to dedicated, or from dedicated to host. Move an instance to or from a placement group. At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request. To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state. + */ + modifyInstancePlacement(params: EC2.Types.ModifyInstancePlacementRequest, callback?: (err: AWSError, data: EC2.Types.ModifyInstancePlacementResult) => void): Request; + /** + * Modifies the placement attributes for a specified instance. You can do the following: Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists. Change the Dedicated Host with which an instance is associated. Change the instance tenancy of an instance from host to dedicated, or from dedicated to host. Move an instance to or from a placement group. At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request. To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state. + */ + modifyInstancePlacement(callback?: (err: AWSError, data: EC2.Types.ModifyInstancePlacementResult) => void): Request; + /** + * Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified. + */ + modifyLaunchTemplate(params: EC2.Types.ModifyLaunchTemplateRequest, callback?: (err: AWSError, data: EC2.Types.ModifyLaunchTemplateResult) => void): Request; + /** + * Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified. + */ + modifyLaunchTemplate(callback?: (err: AWSError, data: EC2.Types.ModifyLaunchTemplateResult) => void): Request; + /** + * Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. + */ + modifyNetworkInterfaceAttribute(params: EC2.Types.ModifyNetworkInterfaceAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. + */ + modifyNetworkInterfaceAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide. + */ + modifyReservedInstances(params: EC2.Types.ModifyReservedInstancesRequest, callback?: (err: AWSError, data: EC2.Types.ModifyReservedInstancesResult) => void): Request; + /** + * Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide. + */ + modifyReservedInstances(callback?: (err: AWSError, data: EC2.Types.ModifyReservedInstancesResult) => void): Request; + /** + * Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts. For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + modifySnapshotAttribute(params: EC2.Types.ModifySnapshotAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts. For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + modifySnapshotAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified Spot Fleet request. While the Spot Fleet request is being modified, it is in the modifying state. To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot pools. To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually. If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0. + */ + modifySpotFleetRequest(params: EC2.Types.ModifySpotFleetRequestRequest, callback?: (err: AWSError, data: EC2.Types.ModifySpotFleetRequestResponse) => void): Request; + /** + * Modifies the specified Spot Fleet request. While the Spot Fleet request is being modified, it is in the modifying state. To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot pools. To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually. If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0. + */ + modifySpotFleetRequest(callback?: (err: AWSError, data: EC2.Types.ModifySpotFleetRequestResponse) => void): Request; + /** + * Modifies a subnet attribute. You can only modify one attribute at a time. + */ + modifySubnetAttribute(params: EC2.Types.ModifySubnetAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies a subnet attribute. You can only modify one attribute at a time. + */ + modifySubnetAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified VPC attachment. + */ + modifyTransitGatewayVpcAttachment(params: EC2.Types.ModifyTransitGatewayVpcAttachmentRequest, callback?: (err: AWSError, data: EC2.Types.ModifyTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Modifies the specified VPC attachment. + */ + modifyTransitGatewayVpcAttachment(callback?: (err: AWSError, data: EC2.Types.ModifyTransitGatewayVpcAttachmentResult) => void): Request; + /** + * You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows. When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending a Windows File System. You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using the DescribeVolumesModifications API. For information about tracking status changes using either method, see Monitoring Volume Modifications. With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux and Modifying the Size, IOPS, or Type of an EBS Volume on Windows. If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume. + */ + modifyVolume(params: EC2.Types.ModifyVolumeRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVolumeResult) => void): Request; + /** + * You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows. When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending a Windows File System. You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using the DescribeVolumesModifications API. For information about tracking status changes using either method, see Monitoring Volume Modifications. With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux and Modifying the Size, IOPS, or Type of an EBS Volume on Windows. If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume. + */ + modifyVolume(callback?: (err: AWSError, data: EC2.Types.ModifyVolumeResult) => void): Request; + /** + * Modifies a volume attribute. By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. + */ + modifyVolumeAttribute(params: EC2.Types.ModifyVolumeAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies a volume attribute. By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. + */ + modifyVolumeAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified attribute of the specified VPC. + */ + modifyVpcAttribute(params: EC2.Types.ModifyVpcAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the specified attribute of the specified VPC. + */ + modifyVpcAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface or gateway). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide. + */ + modifyVpcEndpoint(params: EC2.Types.ModifyVpcEndpointRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointResult) => void): Request; + /** + * Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface or gateway). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide. + */ + modifyVpcEndpoint(callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointResult) => void): Request; + /** + * Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. + */ + modifyVpcEndpointConnectionNotification(params: EC2.Types.ModifyVpcEndpointConnectionNotificationRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointConnectionNotificationResult) => void): Request; + /** + * Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. + */ + modifyVpcEndpointConnectionNotification(callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointConnectionNotificationResult) => void): Request; + /** + * Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint. + */ + modifyVpcEndpointServiceConfiguration(params: EC2.Types.ModifyVpcEndpointServiceConfigurationRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointServiceConfigurationResult) => void): Request; + /** + * Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint. + */ + modifyVpcEndpointServiceConfiguration(callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointServiceConfigurationResult) => void): Request; + /** + * Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service. If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved. + */ + modifyVpcEndpointServicePermissions(params: EC2.Types.ModifyVpcEndpointServicePermissionsRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointServicePermissionsResult) => void): Request; + /** + * Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service. If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved. + */ + modifyVpcEndpointServicePermissions(callback?: (err: AWSError, data: EC2.Types.ModifyVpcEndpointServicePermissionsResult) => void): Request; + /** + * Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following: Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC. Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC. Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the region for the requester VPC to modify the requester VPC peering options and the region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command. + */ + modifyVpcPeeringConnectionOptions(params: EC2.Types.ModifyVpcPeeringConnectionOptionsRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVpcPeeringConnectionOptionsResult) => void): Request; + /** + * Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following: Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC. Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC. Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the region for the requester VPC to modify the requester VPC peering options and the region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command. + */ + modifyVpcPeeringConnectionOptions(callback?: (err: AWSError, data: EC2.Types.ModifyVpcPeeringConnectionOptionsResult) => void): Request; + /** + * Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated. After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide. + */ + modifyVpcTenancy(params: EC2.Types.ModifyVpcTenancyRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVpcTenancyResult) => void): Request; + /** + * Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated. After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide. + */ + modifyVpcTenancy(callback?: (err: AWSError, data: EC2.Types.ModifyVpcTenancyResult) => void): Request; + /** + * + */ + modifyVpnConnection(params: EC2.Types.ModifyVpnConnectionRequest, callback?: (err: AWSError, data: EC2.Types.ModifyVpnConnectionResult) => void): Request; + /** + * + */ + modifyVpnConnection(callback?: (err: AWSError, data: EC2.Types.ModifyVpnConnectionResult) => void): Request; + /** + * Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide. To disable detailed monitoring, see . + */ + monitorInstances(params: EC2.Types.MonitorInstancesRequest, callback?: (err: AWSError, data: EC2.Types.MonitorInstancesResult) => void): Request; + /** + * Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide. To disable detailed monitoring, see . + */ + monitorInstances(callback?: (err: AWSError, data: EC2.Types.MonitorInstancesResult) => void): Request; + /** + * Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. + */ + moveAddressToVpc(params: EC2.Types.MoveAddressToVpcRequest, callback?: (err: AWSError, data: EC2.Types.MoveAddressToVpcResult) => void): Request; + /** + * Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. + */ + moveAddressToVpc(callback?: (err: AWSError, data: EC2.Types.MoveAddressToVpcResult) => void): Request; + /** + * Provisions an address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. AWS verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool. + */ + provisionByoipCidr(params: EC2.Types.ProvisionByoipCidrRequest, callback?: (err: AWSError, data: EC2.Types.ProvisionByoipCidrResult) => void): Request; + /** + * Provisions an address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. AWS verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool. + */ + provisionByoipCidr(callback?: (err: AWSError, data: EC2.Types.ProvisionByoipCidrResult) => void): Request; + /** + * Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. + */ + purchaseHostReservation(params: EC2.Types.PurchaseHostReservationRequest, callback?: (err: AWSError, data: EC2.Types.PurchaseHostReservationResult) => void): Request; + /** + * Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. + */ + purchaseHostReservation(callback?: (err: AWSError, data: EC2.Types.PurchaseHostReservationResult) => void): Request; + /** + * Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing. Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances. For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + purchaseReservedInstancesOffering(params: EC2.Types.PurchaseReservedInstancesOfferingRequest, callback?: (err: AWSError, data: EC2.Types.PurchaseReservedInstancesOfferingResult) => void): Request; + /** + * Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing. Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances. For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide. + */ + purchaseReservedInstancesOffering(callback?: (err: AWSError, data: EC2.Types.PurchaseReservedInstancesOfferingResult) => void): Request; + /** + * Purchases the Scheduled Instances with the specified schedule. Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period. After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase. + */ + purchaseScheduledInstances(params: EC2.Types.PurchaseScheduledInstancesRequest, callback?: (err: AWSError, data: EC2.Types.PurchaseScheduledInstancesResult) => void): Request; + /** + * Purchases the Scheduled Instances with the specified schedule. Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period. After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase. + */ + purchaseScheduledInstances(callback?: (err: AWSError, data: EC2.Types.PurchaseScheduledInstancesResult) => void): Request; + /** + * Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide. + */ + rebootInstances(params: EC2.Types.RebootInstancesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide. + */ + rebootInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide. You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and instances launched from such an AMI are not able to connect to package update infrastructure. If you purchase a Reserved Instance offering for one of these Linux distributions and launch instances using an AMI that does not contain the required billing code, your Reserved Instance is not applied to these instances. To create an AMI for operating systems that require a billing code, see CreateImage. If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. + */ + registerImage(params: EC2.Types.RegisterImageRequest, callback?: (err: AWSError, data: EC2.Types.RegisterImageResult) => void): Request; + /** + * Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide. You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and instances launched from such an AMI are not able to connect to package update infrastructure. If you purchase a Reserved Instance offering for one of these Linux distributions and launch instances using an AMI that does not contain the required billing code, your Reserved Instance is not applied to these instances. To create an AMI for operating systems that require a billing code, see CreateImage. If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. + */ + registerImage(callback?: (err: AWSError, data: EC2.Types.RegisterImageResult) => void): Request; + /** + * Rejects a request to attach a VPC to a transit gateway. The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request. + */ + rejectTransitGatewayVpcAttachment(params: EC2.Types.RejectTransitGatewayVpcAttachmentRequest, callback?: (err: AWSError, data: EC2.Types.RejectTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Rejects a request to attach a VPC to a transit gateway. The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request. + */ + rejectTransitGatewayVpcAttachment(callback?: (err: AWSError, data: EC2.Types.RejectTransitGatewayVpcAttachmentResult) => void): Request; + /** + * Rejects one or more VPC endpoint connection requests to your VPC endpoint service. + */ + rejectVpcEndpointConnections(params: EC2.Types.RejectVpcEndpointConnectionsRequest, callback?: (err: AWSError, data: EC2.Types.RejectVpcEndpointConnectionsResult) => void): Request; + /** + * Rejects one or more VPC endpoint connection requests to your VPC endpoint service. + */ + rejectVpcEndpointConnections(callback?: (err: AWSError, data: EC2.Types.RejectVpcEndpointConnectionsResult) => void): Request; + /** + * Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection. + */ + rejectVpcPeeringConnection(params: EC2.Types.RejectVpcPeeringConnectionRequest, callback?: (err: AWSError, data: EC2.Types.RejectVpcPeeringConnectionResult) => void): Request; + /** + * Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection. + */ + rejectVpcPeeringConnection(callback?: (err: AWSError, data: EC2.Types.RejectVpcPeeringConnectionResult) => void): Request; + /** + * Releases the specified Elastic IP address. [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress. [Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account. [EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress. + */ + releaseAddress(params: EC2.Types.ReleaseAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Releases the specified Elastic IP address. [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress. [Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account. [EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress. + */ + releaseAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released. When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again. Released hosts still appear in a DescribeHosts response. + */ + releaseHosts(params: EC2.Types.ReleaseHostsRequest, callback?: (err: AWSError, data: EC2.Types.ReleaseHostsResult) => void): Request; + /** + * When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released. When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again. Released hosts still appear in a DescribeHosts response. + */ + releaseHosts(callback?: (err: AWSError, data: EC2.Types.ReleaseHostsResult) => void): Request; + /** + * Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first. Use DescribeIamInstanceProfileAssociations to get the association ID. + */ + replaceIamInstanceProfileAssociation(params: EC2.Types.ReplaceIamInstanceProfileAssociationRequest, callback?: (err: AWSError, data: EC2.Types.ReplaceIamInstanceProfileAssociationResult) => void): Request; + /** + * Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first. Use DescribeIamInstanceProfileAssociations to get the association ID. + */ + replaceIamInstanceProfileAssociation(callback?: (err: AWSError, data: EC2.Types.ReplaceIamInstanceProfileAssociationResult) => void): Request; + /** + * Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. This is an idempotent operation. + */ + replaceNetworkAclAssociation(params: EC2.Types.ReplaceNetworkAclAssociationRequest, callback?: (err: AWSError, data: EC2.Types.ReplaceNetworkAclAssociationResult) => void): Request; + /** + * Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. This is an idempotent operation. + */ + replaceNetworkAclAssociation(callback?: (err: AWSError, data: EC2.Types.ReplaceNetworkAclAssociationResult) => void): Request; + /** + * Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + replaceNetworkAclEntry(params: EC2.Types.ReplaceNetworkAclEntryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. + */ + replaceNetworkAclEntry(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + replaceRoute(params: EC2.Types.ReplaceRouteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide. + */ + replaceRoute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide. You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. + */ + replaceRouteTableAssociation(params: EC2.Types.ReplaceRouteTableAssociationRequest, callback?: (err: AWSError, data: EC2.Types.ReplaceRouteTableAssociationResult) => void): Request; + /** + * Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide. You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. + */ + replaceRouteTableAssociation(callback?: (err: AWSError, data: EC2.Types.ReplaceRouteTableAssociationResult) => void): Request; + /** + * Replaces the specified route in the specified transit gateway route table. + */ + replaceTransitGatewayRoute(params: EC2.Types.ReplaceTransitGatewayRouteRequest, callback?: (err: AWSError, data: EC2.Types.ReplaceTransitGatewayRouteResult) => void): Request; + /** + * Replaces the specified route in the specified transit gateway route table. + */ + replaceTransitGatewayRoute(callback?: (err: AWSError, data: EC2.Types.ReplaceTransitGatewayRouteResult) => void): Request; + /** + * Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. + */ + reportInstanceStatus(params: EC2.Types.ReportInstanceStatusRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. + */ + reportInstanceStatus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a Spot Fleet request. The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity. You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. By default, the Spot Fleet requests Spot Instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet. You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request because only the instance resource type is supported. For more information, see Spot Fleet Requests in the Amazon EC2 User Guide for Linux Instances. + */ + requestSpotFleet(params: EC2.Types.RequestSpotFleetRequest, callback?: (err: AWSError, data: EC2.Types.RequestSpotFleetResponse) => void): Request; + /** + * Creates a Spot Fleet request. The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity. You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. By default, the Spot Fleet requests Spot Instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet. You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request because only the instance resource type is supported. For more information, see Spot Fleet Requests in the Amazon EC2 User Guide for Linux Instances. + */ + requestSpotFleet(callback?: (err: AWSError, data: EC2.Types.RequestSpotFleetResponse) => void): Request; + /** + * Creates a Spot Instance request. For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances. + */ + requestSpotInstances(params: EC2.Types.RequestSpotInstancesRequest, callback?: (err: AWSError, data: EC2.Types.RequestSpotInstancesResult) => void): Request; + /** + * Creates a Spot Instance request. For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances. + */ + requestSpotInstances(callback?: (err: AWSError, data: EC2.Types.RequestSpotInstancesResult) => void): Request; + /** + * Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. + */ + resetFpgaImageAttribute(params: EC2.Types.ResetFpgaImageAttributeRequest, callback?: (err: AWSError, data: EC2.Types.ResetFpgaImageAttributeResult) => void): Request; + /** + * Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. + */ + resetFpgaImageAttribute(callback?: (err: AWSError, data: EC2.Types.ResetFpgaImageAttributeResult) => void): Request; + /** + * Resets an attribute of an AMI to its default value. The productCodes attribute can't be reset. + */ + resetImageAttribute(params: EC2.Types.ResetImageAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets an attribute of an AMI to its default value. The productCodes attribute can't be reset. + */ + resetImageAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped. The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide. + */ + resetInstanceAttribute(params: EC2.Types.ResetInstanceAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped. The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide. + */ + resetInstanceAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets a network interface attribute. You can specify only one attribute at a time. + */ + resetNetworkInterfaceAttribute(params: EC2.Types.ResetNetworkInterfaceAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets a network interface attribute. You can specify only one attribute at a time. + */ + resetNetworkInterfaceAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets permission settings for the specified snapshot. For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + resetSnapshotAttribute(params: EC2.Types.ResetSnapshotAttributeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets permission settings for the specified snapshot. For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide. + */ + resetSnapshotAttribute(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. + */ + restoreAddressToClassic(params: EC2.Types.RestoreAddressToClassicRequest, callback?: (err: AWSError, data: EC2.Types.RestoreAddressToClassicResult) => void): Request; + /** + * Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. + */ + restoreAddressToClassic(callback?: (err: AWSError, data: EC2.Types.RestoreAddressToClassicResult) => void): Request; + /** + * Removes an ingress authorization rule from a Client VPN endpoint. + */ + revokeClientVpnIngress(params: EC2.Types.RevokeClientVpnIngressRequest, callback?: (err: AWSError, data: EC2.Types.RevokeClientVpnIngressResult) => void): Request; + /** + * Removes an ingress authorization rule from a Client VPN endpoint. + */ + revokeClientVpnIngress(callback?: (err: AWSError, data: EC2.Types.RevokeClientVpnIngressResult) => void): Request; + /** + * [VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. + */ + revokeSecurityGroupEgress(params: EC2.Types.RevokeSecurityGroupEgressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * [VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. + */ + revokeSecurityGroupEgress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly. [EC2-Classic only] If the values you specify do not match the existing rule's values, no error is returned. Use DescribeSecurityGroups to verify that the rule has been removed. Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. + */ + revokeSecurityGroupIngress(params: EC2.Types.RevokeSecurityGroupIngressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly. [EC2-Classic only] If the values you specify do not match the existing rule's values, no error is returned. Use DescribeSecurityGroups to verify that the rule has been removed. Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. + */ + revokeSecurityGroupIngress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Launches the specified number of instances using an AMI for which you have permissions. You can specify a number of options, or leave the default options. The following rules apply: [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request. [EC2-Classic] If don't specify an Availability Zone, we choose one for you. Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC. [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet. Not all instance types support IPv6 addresses. For more information, see Instance Types. If you don't specify a security group ID, we use the default security group. For more information, see Security Groups. If any of the AMIs have a product code attached for which the user has not subscribed, the request fails. You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters. To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances. An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources. Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + runInstances(params: EC2.Types.RunInstancesRequest, callback?: (err: AWSError, data: EC2.Types.Reservation) => void): Request; + /** + * Launches the specified number of instances using an AMI for which you have permissions. You can specify a number of options, or leave the default options. The following rules apply: [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request. [EC2-Classic] If don't specify an Availability Zone, we choose one for you. Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC. [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet. Not all instance types support IPv6 addresses. For more information, see Instance Types. If you don't specify a security group ID, we use the default security group. For more information, see Security Groups. If any of the AMIs have a product code attached for which the user has not subscribed, the request fails. You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters. To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances. An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources. Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide. For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + runInstances(callback?: (err: AWSError, data: EC2.Types.Reservation) => void): Request; + /** + * Launches the specified Scheduled Instances. Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances. You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide. + */ + runScheduledInstances(params: EC2.Types.RunScheduledInstancesRequest, callback?: (err: AWSError, data: EC2.Types.RunScheduledInstancesResult) => void): Request; + /** + * Launches the specified Scheduled Instances. Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances. You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide. + */ + runScheduledInstances(callback?: (err: AWSError, data: EC2.Types.RunScheduledInstancesResult) => void): Request; + /** + * Searches for routes in the specified transit gateway route table. + */ + searchTransitGatewayRoutes(params: EC2.Types.SearchTransitGatewayRoutesRequest, callback?: (err: AWSError, data: EC2.Types.SearchTransitGatewayRoutesResult) => void): Request; + /** + * Searches for routes in the specified transit gateway route table. + */ + searchTransitGatewayRoutes(callback?: (err: AWSError, data: EC2.Types.SearchTransitGatewayRoutesResult) => void): Request; + /** + * Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide. + */ + startInstances(params: EC2.Types.StartInstancesRequest, callback?: (err: AWSError, data: EC2.Types.StartInstancesResult) => void): Request; + /** + * Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide. + */ + startInstances(callback?: (err: AWSError, data: EC2.Types.StartInstancesResult) => void): Request; + /** + * Stops an Amazon EBS-backed instance. You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide. We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. You can't start, stop, or hibernate Spot Instances, and you can't stop or hibernate instance store-backed instances. For information about using hibernation for Spot Instances, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide. When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs. Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide. When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + stopInstances(params: EC2.Types.StopInstancesRequest, callback?: (err: AWSError, data: EC2.Types.StopInstancesResult) => void): Request; + /** + * Stops an Amazon EBS-backed instance. You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide. We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. You can't start, stop, or hibernate Spot Instances, and you can't stop or hibernate instance store-backed instances. For information about using hibernation for Spot Instances, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide. When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs. Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide. When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + stopInstances(callback?: (err: AWSError, data: EC2.Types.StopInstancesResult) => void): Request; + /** + * Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user. + */ + terminateClientVpnConnections(params: EC2.Types.TerminateClientVpnConnectionsRequest, callback?: (err: AWSError, data: EC2.Types.TerminateClientVpnConnectionsResult) => void): Request; + /** + * Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user. + */ + terminateClientVpnConnections(callback?: (err: AWSError, data: EC2.Types.TerminateClientVpnConnectionsResult) => void): Request; + /** + * Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide. For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + terminateInstances(params: EC2.Types.TerminateInstancesRequest, callback?: (err: AWSError, data: EC2.Types.TerminateInstancesResult) => void): Request; + /** + * Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide. For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + terminateInstances(callback?: (err: AWSError, data: EC2.Types.TerminateInstancesResult) => void): Request; + /** + * Unassigns one or more IPv6 addresses from a network interface. + */ + unassignIpv6Addresses(params: EC2.Types.UnassignIpv6AddressesRequest, callback?: (err: AWSError, data: EC2.Types.UnassignIpv6AddressesResult) => void): Request; + /** + * Unassigns one or more IPv6 addresses from a network interface. + */ + unassignIpv6Addresses(callback?: (err: AWSError, data: EC2.Types.UnassignIpv6AddressesResult) => void): Request; + /** + * Unassigns one or more secondary private IP addresses from a network interface. + */ + unassignPrivateIpAddresses(params: EC2.Types.UnassignPrivateIpAddressesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unassigns one or more secondary private IP addresses from a network interface. + */ + unassignPrivateIpAddresses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + unmonitorInstances(params: EC2.Types.UnmonitorInstancesRequest, callback?: (err: AWSError, data: EC2.Types.UnmonitorInstancesResult) => void): Request; + /** + * Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide. + */ + unmonitorInstances(callback?: (err: AWSError, data: EC2.Types.UnmonitorInstancesResult) => void): Request; + /** + * [VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request. + */ + updateSecurityGroupRuleDescriptionsEgress(params: EC2.Types.UpdateSecurityGroupRuleDescriptionsEgressRequest, callback?: (err: AWSError, data: EC2.Types.UpdateSecurityGroupRuleDescriptionsEgressResult) => void): Request; + /** + * [VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request. + */ + updateSecurityGroupRuleDescriptionsEgress(callback?: (err: AWSError, data: EC2.Types.UpdateSecurityGroupRuleDescriptionsEgressResult) => void): Request; + /** + * Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request. + */ + updateSecurityGroupRuleDescriptionsIngress(params: EC2.Types.UpdateSecurityGroupRuleDescriptionsIngressRequest, callback?: (err: AWSError, data: EC2.Types.UpdateSecurityGroupRuleDescriptionsIngressResult) => void): Request; + /** + * Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request. + */ + updateSecurityGroupRuleDescriptionsIngress(callback?: (err: AWSError, data: EC2.Types.UpdateSecurityGroupRuleDescriptionsIngressResult) => void): Request; + /** + * Stops advertising an IPv4 address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to AWS because of BGP propagation delays. + */ + withdrawByoipCidr(params: EC2.Types.WithdrawByoipCidrRequest, callback?: (err: AWSError, data: EC2.Types.WithdrawByoipCidrResult) => void): Request; + /** + * Stops advertising an IPv4 address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to AWS because of BGP propagation delays. + */ + withdrawByoipCidr(callback?: (err: AWSError, data: EC2.Types.WithdrawByoipCidrResult) => void): Request; + /** + * Waits for the instanceExists state by periodically calling the underlying EC2.describeInstancesoperation every 5 seconds (at most 40 times). + */ + waitFor(state: "instanceExists", params: EC2.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceExists state by periodically calling the underlying EC2.describeInstancesoperation every 5 seconds (at most 40 times). + */ + waitFor(state: "instanceExists", callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the bundleTaskComplete state by periodically calling the underlying EC2.describeBundleTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "bundleTaskComplete", params: EC2.Types.DescribeBundleTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeBundleTasksResult) => void): Request; + /** + * Waits for the bundleTaskComplete state by periodically calling the underlying EC2.describeBundleTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "bundleTaskComplete", callback?: (err: AWSError, data: EC2.Types.DescribeBundleTasksResult) => void): Request; + /** + * Waits for the conversionTaskCancelled state by periodically calling the underlying EC2.describeConversionTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "conversionTaskCancelled", params: EC2.Types.DescribeConversionTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Waits for the conversionTaskCancelled state by periodically calling the underlying EC2.describeConversionTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "conversionTaskCancelled", callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Waits for the conversionTaskCompleted state by periodically calling the underlying EC2.describeConversionTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "conversionTaskCompleted", params: EC2.Types.DescribeConversionTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Waits for the conversionTaskCompleted state by periodically calling the underlying EC2.describeConversionTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "conversionTaskCompleted", callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Waits for the conversionTaskDeleted state by periodically calling the underlying EC2.describeConversionTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "conversionTaskDeleted", params: EC2.Types.DescribeConversionTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Waits for the conversionTaskDeleted state by periodically calling the underlying EC2.describeConversionTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "conversionTaskDeleted", callback?: (err: AWSError, data: EC2.Types.DescribeConversionTasksResult) => void): Request; + /** + * Waits for the customerGatewayAvailable state by periodically calling the underlying EC2.describeCustomerGatewaysoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "customerGatewayAvailable", params: EC2.Types.DescribeCustomerGatewaysRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeCustomerGatewaysResult) => void): Request; + /** + * Waits for the customerGatewayAvailable state by periodically calling the underlying EC2.describeCustomerGatewaysoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "customerGatewayAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeCustomerGatewaysResult) => void): Request; + /** + * Waits for the exportTaskCancelled state by periodically calling the underlying EC2.describeExportTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "exportTaskCancelled", params: EC2.Types.DescribeExportTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeExportTasksResult) => void): Request; + /** + * Waits for the exportTaskCancelled state by periodically calling the underlying EC2.describeExportTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "exportTaskCancelled", callback?: (err: AWSError, data: EC2.Types.DescribeExportTasksResult) => void): Request; + /** + * Waits for the exportTaskCompleted state by periodically calling the underlying EC2.describeExportTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "exportTaskCompleted", params: EC2.Types.DescribeExportTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeExportTasksResult) => void): Request; + /** + * Waits for the exportTaskCompleted state by periodically calling the underlying EC2.describeExportTasksoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "exportTaskCompleted", callback?: (err: AWSError, data: EC2.Types.DescribeExportTasksResult) => void): Request; + /** + * Waits for the imageExists state by periodically calling the underlying EC2.describeImagesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "imageExists", params: EC2.Types.DescribeImagesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeImagesResult) => void): Request; + /** + * Waits for the imageExists state by periodically calling the underlying EC2.describeImagesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "imageExists", callback?: (err: AWSError, data: EC2.Types.DescribeImagesResult) => void): Request; + /** + * Waits for the imageAvailable state by periodically calling the underlying EC2.describeImagesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "imageAvailable", params: EC2.Types.DescribeImagesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeImagesResult) => void): Request; + /** + * Waits for the imageAvailable state by periodically calling the underlying EC2.describeImagesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "imageAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeImagesResult) => void): Request; + /** + * Waits for the instanceRunning state by periodically calling the underlying EC2.describeInstancesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceRunning", params: EC2.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceRunning state by periodically calling the underlying EC2.describeInstancesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceRunning", callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceStatusOk state by periodically calling the underlying EC2.describeInstanceStatusoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceStatusOk", params: EC2.Types.DescribeInstanceStatusRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeInstanceStatusResult) => void): Request; + /** + * Waits for the instanceStatusOk state by periodically calling the underlying EC2.describeInstanceStatusoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceStatusOk", callback?: (err: AWSError, data: EC2.Types.DescribeInstanceStatusResult) => void): Request; + /** + * Waits for the instanceStopped state by periodically calling the underlying EC2.describeInstancesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceStopped", params: EC2.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceStopped state by periodically calling the underlying EC2.describeInstancesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceStopped", callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceTerminated state by periodically calling the underlying EC2.describeInstancesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceTerminated", params: EC2.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceTerminated state by periodically calling the underlying EC2.describeInstancesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceTerminated", callback?: (err: AWSError, data: EC2.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the keyPairExists state by periodically calling the underlying EC2.describeKeyPairsoperation every 5 seconds (at most 6 times). + */ + waitFor(state: "keyPairExists", params: EC2.Types.DescribeKeyPairsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeKeyPairsResult) => void): Request; + /** + * Waits for the keyPairExists state by periodically calling the underlying EC2.describeKeyPairsoperation every 5 seconds (at most 6 times). + */ + waitFor(state: "keyPairExists", callback?: (err: AWSError, data: EC2.Types.DescribeKeyPairsResult) => void): Request; + /** + * Waits for the natGatewayAvailable state by periodically calling the underlying EC2.describeNatGatewaysoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "natGatewayAvailable", params: EC2.Types.DescribeNatGatewaysRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeNatGatewaysResult) => void): Request; + /** + * Waits for the natGatewayAvailable state by periodically calling the underlying EC2.describeNatGatewaysoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "natGatewayAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeNatGatewaysResult) => void): Request; + /** + * Waits for the networkInterfaceAvailable state by periodically calling the underlying EC2.describeNetworkInterfacesoperation every 20 seconds (at most 10 times). + */ + waitFor(state: "networkInterfaceAvailable", params: EC2.Types.DescribeNetworkInterfacesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfacesResult) => void): Request; + /** + * Waits for the networkInterfaceAvailable state by periodically calling the underlying EC2.describeNetworkInterfacesoperation every 20 seconds (at most 10 times). + */ + waitFor(state: "networkInterfaceAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeNetworkInterfacesResult) => void): Request; + /** + * Waits for the passwordDataAvailable state by periodically calling the underlying EC2.getPasswordDataoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "passwordDataAvailable", params: EC2.Types.GetPasswordDataRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.GetPasswordDataResult) => void): Request; + /** + * Waits for the passwordDataAvailable state by periodically calling the underlying EC2.getPasswordDataoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "passwordDataAvailable", callback?: (err: AWSError, data: EC2.Types.GetPasswordDataResult) => void): Request; + /** + * Waits for the snapshotCompleted state by periodically calling the underlying EC2.describeSnapshotsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "snapshotCompleted", params: EC2.Types.DescribeSnapshotsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeSnapshotsResult) => void): Request; + /** + * Waits for the snapshotCompleted state by periodically calling the underlying EC2.describeSnapshotsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "snapshotCompleted", callback?: (err: AWSError, data: EC2.Types.DescribeSnapshotsResult) => void): Request; + /** + * Waits for the spotInstanceRequestFulfilled state by periodically calling the underlying EC2.describeSpotInstanceRequestsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "spotInstanceRequestFulfilled", params: EC2.Types.DescribeSpotInstanceRequestsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeSpotInstanceRequestsResult) => void): Request; + /** + * Waits for the spotInstanceRequestFulfilled state by periodically calling the underlying EC2.describeSpotInstanceRequestsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "spotInstanceRequestFulfilled", callback?: (err: AWSError, data: EC2.Types.DescribeSpotInstanceRequestsResult) => void): Request; + /** + * Waits for the subnetAvailable state by periodically calling the underlying EC2.describeSubnetsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "subnetAvailable", params: EC2.Types.DescribeSubnetsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeSubnetsResult) => void): Request; + /** + * Waits for the subnetAvailable state by periodically calling the underlying EC2.describeSubnetsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "subnetAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeSubnetsResult) => void): Request; + /** + * Waits for the systemStatusOk state by periodically calling the underlying EC2.describeInstanceStatusoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "systemStatusOk", params: EC2.Types.DescribeInstanceStatusRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeInstanceStatusResult) => void): Request; + /** + * Waits for the systemStatusOk state by periodically calling the underlying EC2.describeInstanceStatusoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "systemStatusOk", callback?: (err: AWSError, data: EC2.Types.DescribeInstanceStatusResult) => void): Request; + /** + * Waits for the volumeAvailable state by periodically calling the underlying EC2.describeVolumesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "volumeAvailable", params: EC2.Types.DescribeVolumesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Waits for the volumeAvailable state by periodically calling the underlying EC2.describeVolumesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "volumeAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Waits for the volumeDeleted state by periodically calling the underlying EC2.describeVolumesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "volumeDeleted", params: EC2.Types.DescribeVolumesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Waits for the volumeDeleted state by periodically calling the underlying EC2.describeVolumesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "volumeDeleted", callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Waits for the volumeInUse state by periodically calling the underlying EC2.describeVolumesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "volumeInUse", params: EC2.Types.DescribeVolumesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Waits for the volumeInUse state by periodically calling the underlying EC2.describeVolumesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "volumeInUse", callback?: (err: AWSError, data: EC2.Types.DescribeVolumesResult) => void): Request; + /** + * Waits for the vpcAvailable state by periodically calling the underlying EC2.describeVpcsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpcAvailable", params: EC2.Types.DescribeVpcsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVpcsResult) => void): Request; + /** + * Waits for the vpcAvailable state by periodically calling the underlying EC2.describeVpcsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpcAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeVpcsResult) => void): Request; + /** + * Waits for the vpcExists state by periodically calling the underlying EC2.describeVpcsoperation every 1 seconds (at most 5 times). + */ + waitFor(state: "vpcExists", params: EC2.Types.DescribeVpcsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVpcsResult) => void): Request; + /** + * Waits for the vpcExists state by periodically calling the underlying EC2.describeVpcsoperation every 1 seconds (at most 5 times). + */ + waitFor(state: "vpcExists", callback?: (err: AWSError, data: EC2.Types.DescribeVpcsResult) => void): Request; + /** + * Waits for the vpnConnectionAvailable state by periodically calling the underlying EC2.describeVpnConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpnConnectionAvailable", params: EC2.Types.DescribeVpnConnectionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVpnConnectionsResult) => void): Request; + /** + * Waits for the vpnConnectionAvailable state by periodically calling the underlying EC2.describeVpnConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpnConnectionAvailable", callback?: (err: AWSError, data: EC2.Types.DescribeVpnConnectionsResult) => void): Request; + /** + * Waits for the vpnConnectionDeleted state by periodically calling the underlying EC2.describeVpnConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpnConnectionDeleted", params: EC2.Types.DescribeVpnConnectionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVpnConnectionsResult) => void): Request; + /** + * Waits for the vpnConnectionDeleted state by periodically calling the underlying EC2.describeVpnConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpnConnectionDeleted", callback?: (err: AWSError, data: EC2.Types.DescribeVpnConnectionsResult) => void): Request; + /** + * Waits for the vpcPeeringConnectionExists state by periodically calling the underlying EC2.describeVpcPeeringConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpcPeeringConnectionExists", params: EC2.Types.DescribeVpcPeeringConnectionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVpcPeeringConnectionsResult) => void): Request; + /** + * Waits for the vpcPeeringConnectionExists state by periodically calling the underlying EC2.describeVpcPeeringConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpcPeeringConnectionExists", callback?: (err: AWSError, data: EC2.Types.DescribeVpcPeeringConnectionsResult) => void): Request; + /** + * Waits for the vpcPeeringConnectionDeleted state by periodically calling the underlying EC2.describeVpcPeeringConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpcPeeringConnectionDeleted", params: EC2.Types.DescribeVpcPeeringConnectionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EC2.Types.DescribeVpcPeeringConnectionsResult) => void): Request; + /** + * Waits for the vpcPeeringConnectionDeleted state by periodically calling the underlying EC2.describeVpcPeeringConnectionsoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "vpcPeeringConnectionDeleted", callback?: (err: AWSError, data: EC2.Types.DescribeVpcPeeringConnectionsResult) => void): Request; +} +declare namespace EC2 { + export interface AcceptReservedInstancesExchangeQuoteRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value. + */ + ReservedInstanceIds: ReservedInstanceIdSet; + /** + * The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. + */ + TargetConfigurations?: TargetConfigurationRequestSet; + } + export interface AcceptReservedInstancesExchangeQuoteResult { + /** + * The ID of the successful exchange. + */ + ExchangeId?: String; + } + export interface AcceptTransitGatewayVpcAttachmentRequest { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AcceptTransitGatewayVpcAttachmentResult { + /** + * The VPC attachment. + */ + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + } + export interface AcceptVpcEndpointConnectionsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the endpoint service. + */ + ServiceId: String; + /** + * The IDs of one or more interface VPC endpoints. + */ + VpcEndpointIds: ValueStringList; + } + export interface AcceptVpcEndpointConnectionsResult { + /** + * Information about the interface endpoints that were not accepted, if applicable. + */ + Unsuccessful?: UnsuccessfulItemSet; + } + export interface AcceptVpcPeeringConnectionRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC peering connection. You must specify this parameter in the request. + */ + VpcPeeringConnectionId?: String; + } + export interface AcceptVpcPeeringConnectionResult { + /** + * Information about the VPC peering connection. + */ + VpcPeeringConnection?: VpcPeeringConnection; + } + export interface AccountAttribute { + /** + * The name of the account attribute. + */ + AttributeName?: String; + /** + * The values for the account attribute. + */ + AttributeValues?: AccountAttributeValueList; + } + export type AccountAttributeList = AccountAttribute[]; + export type AccountAttributeName = "supported-platforms"|"default-vpc"|string; + export type AccountAttributeNameStringList = AccountAttributeName[]; + export interface AccountAttributeValue { + /** + * The value of the attribute. + */ + AttributeValue?: String; + } + export type AccountAttributeValueList = AccountAttributeValue[]; + export interface ActiveInstance { + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The instance type. + */ + InstanceType?: String; + /** + * The ID of the Spot Instance request. + */ + SpotInstanceRequestId?: String; + /** + * The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy. + */ + InstanceHealth?: InstanceHealthStatus; + } + export type ActiveInstanceSet = ActiveInstance[]; + export type ActivityStatus = "error"|"pending_fulfillment"|"pending_termination"|"fulfilled"|string; + export interface Address { + /** + * The ID of the instance that the address is associated with (if any). + */ + InstanceId?: String; + /** + * The Elastic IP address. + */ + PublicIp?: String; + /** + * The ID representing the allocation of the address for use with EC2-VPC. + */ + AllocationId?: String; + /** + * The ID representing the association of the address with an instance in a VPC. + */ + AssociationId?: String; + /** + * Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc). + */ + Domain?: DomainType; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The ID of the AWS account that owns the network interface. + */ + NetworkInterfaceOwnerId?: String; + /** + * The private IP address associated with the Elastic IP address. + */ + PrivateIpAddress?: String; + /** + * Any tags assigned to the Elastic IP address. + */ + Tags?: TagList; + /** + * The ID of an address pool. + */ + PublicIpv4Pool?: String; + } + export type AddressList = Address[]; + export interface AdvertiseByoipCidrRequest { + /** + * The IPv4 address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range. + */ + Cidr: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AdvertiseByoipCidrResult { + /** + * Information about the address range. + */ + ByoipCidr?: ByoipCidr; + } + export type Affinity = "default"|"host"|string; + export interface AllocateAddressRequest { + /** + * Set to vpc to allocate the address for use with instances in a VPC. Default: The address is for use with instances in EC2-Classic. + */ + Domain?: DomainType; + /** + * [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool. + */ + Address?: String; + /** + * The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead. + */ + PublicIpv4Pool?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AllocateAddressResult { + /** + * The Elastic IP address. + */ + PublicIp?: String; + /** + * [EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC. + */ + AllocationId?: String; + /** + * The ID of an address pool. + */ + PublicIpv4Pool?: String; + /** + * Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc). + */ + Domain?: DomainType; + } + export interface AllocateHostsRequest { + /** + * Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances. Default: on + */ + AutoPlacement?: AutoPlacement; + /** + * The Availability Zone in which to allocate the Dedicated Host. + */ + AvailabilityZone: String; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. + */ + ClientToken?: String; + /** + * Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host. + */ + InstanceType: String; + /** + * The number of Dedicated Hosts to allocate to your account with these parameters. + */ + Quantity: Integer; + /** + * The tags to apply to the Dedicated Host during creation. + */ + TagSpecifications?: TagSpecificationList; + } + export interface AllocateHostsResult { + /** + * The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host. + */ + HostIds?: ResponseHostIdList; + } + export type AllocationIdList = String[]; + export type AllocationState = "available"|"under-assessment"|"permanent-failure"|"released"|"released-permanent-failure"|string; + export type AllocationStrategy = "lowestPrice"|"diversified"|string; + export interface AllowedPrincipal { + /** + * The type of principal. + */ + PrincipalType?: PrincipalType; + /** + * The Amazon Resource Name (ARN) of the principal. + */ + Principal?: String; + } + export type AllowedPrincipalSet = AllowedPrincipal[]; + export interface ApplySecurityGroupsToClientVpnTargetNetworkRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * The ID of the VPC in which the associated target network is located. + */ + VpcId: String; + /** + * The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network. + */ + SecurityGroupIds: ClientVpnSecurityGroupIdSet; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ApplySecurityGroupsToClientVpnTargetNetworkResult { + /** + * The IDs of the applied security groups. + */ + SecurityGroupIds?: ClientVpnSecurityGroupIdSet; + } + export type ArchitectureValues = "i386"|"x86_64"|"arm64"|string; + export interface AssignIpv6AddressesRequest { + /** + * The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. + */ + Ipv6AddressCount?: Integer; + /** + * One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses. + */ + Ipv6Addresses?: Ipv6AddressList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + } + export interface AssignIpv6AddressesResult { + /** + * The IPv6 addresses assigned to the network interface. + */ + AssignedIpv6Addresses?: Ipv6AddressList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + } + export interface AssignPrivateIpAddressesRequest { + /** + * Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. + */ + AllowReassignment?: Boolean; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + /** + * One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses. If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range. + */ + PrivateIpAddresses?: PrivateIpAddressStringList; + /** + * The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. + */ + SecondaryPrivateIpAddressCount?: Integer; + } + export interface AssociateAddressRequest { + /** + * [EC2-VPC] The allocation ID. This is required for EC2-VPC. + */ + AllocationId?: String; + /** + * The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached. + */ + InstanceId?: String; + /** + * The Elastic IP address to associate with the instance. This is required for EC2-Classic. + */ + PublicIp?: String; + /** + * [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. + */ + AllowReassociation?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. + */ + NetworkInterfaceId?: String; + /** + * [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address. + */ + PrivateIpAddress?: String; + } + export interface AssociateAddressResult { + /** + * [EC2-VPC] The ID that represents the association of the Elastic IP address with an instance. + */ + AssociationId?: String; + } + export interface AssociateClientVpnTargetNetworkRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * The ID of the subnet to associate with the Client VPN endpoint. + */ + SubnetId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AssociateClientVpnTargetNetworkResult { + /** + * The unique ID of the target network association. + */ + AssociationId?: String; + /** + * The current state of the target network association. + */ + Status?: AssociationStatus; + } + export interface AssociateDhcpOptionsRequest { + /** + * The ID of the DHCP options set, or default to associate no DHCP options with the VPC. + */ + DhcpOptionsId: String; + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AssociateIamInstanceProfileRequest { + /** + * The IAM instance profile. + */ + IamInstanceProfile: IamInstanceProfileSpecification; + /** + * The ID of the instance. + */ + InstanceId: String; + } + export interface AssociateIamInstanceProfileResult { + /** + * Information about the IAM instance profile association. + */ + IamInstanceProfileAssociation?: IamInstanceProfileAssociation; + } + export interface AssociateRouteTableRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the route table. + */ + RouteTableId: String; + /** + * The ID of the subnet. + */ + SubnetId: String; + } + export interface AssociateRouteTableResult { + /** + * The route table association ID. This ID is required for disassociating the route table. + */ + AssociationId?: String; + } + export interface AssociateSubnetCidrBlockRequest { + /** + * The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. + */ + Ipv6CidrBlock: String; + /** + * The ID of your subnet. + */ + SubnetId: String; + } + export interface AssociateSubnetCidrBlockResult { + /** + * Information about the IPv6 CIDR block association. + */ + Ipv6CidrBlockAssociation?: SubnetIpv6CidrBlockAssociation; + /** + * The ID of the subnet. + */ + SubnetId?: String; + } + export interface AssociateTransitGatewayRouteTableRequest { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AssociateTransitGatewayRouteTableResult { + /** + * The ID of the association. + */ + Association?: TransitGatewayAssociation; + } + export interface AssociateVpcCidrBlockRequest { + /** + * Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block. + */ + AmazonProvidedIpv6CidrBlock?: Boolean; + /** + * An IPv4 CIDR block to associate with the VPC. + */ + CidrBlock?: String; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface AssociateVpcCidrBlockResult { + /** + * Information about the IPv6 CIDR block association. + */ + Ipv6CidrBlockAssociation?: VpcIpv6CidrBlockAssociation; + /** + * Information about the IPv4 CIDR block association. + */ + CidrBlockAssociation?: VpcCidrBlockAssociation; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export type AssociatedNetworkType = "vpc"|string; + export interface AssociatedTargetNetwork { + /** + * The ID of the subnet. + */ + NetworkId?: String; + /** + * The target network type. + */ + NetworkType?: AssociatedNetworkType; + } + export type AssociatedTargetNetworkSet = AssociatedTargetNetwork[]; + export type AssociationIdList = String[]; + export interface AssociationStatus { + /** + * The state of the target network association. + */ + Code?: AssociationStatusCode; + /** + * A message about the status of the target network association, if applicable. + */ + Message?: String; + } + export type AssociationStatusCode = "associating"|"associated"|"association-failed"|"disassociating"|"disassociated"|string; + export interface AttachClassicLinkVpcRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC. + */ + Groups: GroupIdStringList; + /** + * The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC. + */ + InstanceId: String; + /** + * The ID of a ClassicLink-enabled VPC. + */ + VpcId: String; + } + export interface AttachClassicLinkVpcResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface AttachInternetGatewayRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the internet gateway. + */ + InternetGatewayId: String; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface AttachNetworkInterfaceRequest { + /** + * The index of the device for the network interface attachment. + */ + DeviceIndex: Integer; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + } + export interface AttachNetworkInterfaceResult { + /** + * The ID of the network interface attachment. + */ + AttachmentId?: String; + } + export interface AttachVolumeRequest { + /** + * The device name (for example, /dev/sdh or xvdh). + */ + Device: String; + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * The ID of the EBS volume. The volume and instance must be within the same Availability Zone. + */ + VolumeId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AttachVpnGatewayRequest { + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * The ID of the virtual private gateway. + */ + VpnGatewayId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AttachVpnGatewayResult { + /** + * Information about the attachment. + */ + VpcAttachment?: VpcAttachment; + } + export type AttachmentStatus = "attaching"|"attached"|"detaching"|"detached"|string; + export interface AttributeBooleanValue { + /** + * The attribute value. The valid values are true or false. + */ + Value?: Boolean; + } + export interface AttributeValue { + /** + * The attribute value. The value is case-sensitive. + */ + Value?: String; + } + export interface AuthorizationRule { + /** + * The ID of the Client VPN endpoint with which the authorization rule is associated. + */ + ClientVpnEndpointId?: String; + /** + * A brief description of the authorization rule. + */ + Description?: String; + /** + * The ID of the Active Directory group to which the authorization rule grants access. + */ + GroupId?: String; + /** + * Indicates whether the authorization rule grants access to all clients. + */ + AccessAll?: Boolean; + /** + * The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. + */ + DestinationCidr?: String; + /** + * The current state of the authorization rule. + */ + Status?: ClientVpnAuthorizationRuleStatus; + } + export type AuthorizationRuleSet = AuthorizationRule[]; + export interface AuthorizeClientVpnIngressRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * The IPv4 address range, in CIDR notation, of the network for which access is being authorized. + */ + TargetNetworkCidr: String; + /** + * The ID of the Active Directory group to grant access. + */ + AccessGroupId?: String; + /** + * Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network. + */ + AuthorizeAllGroups?: Boolean; + /** + * A brief description of the authorization rule. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface AuthorizeClientVpnIngressResult { + /** + * The current state of the authorization rule. + */ + Status?: ClientVpnAuthorizationRuleStatus; + } + export interface AuthorizeSecurityGroupEgressRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the security group. + */ + GroupId: String; + /** + * The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions. + */ + IpPermissions?: IpPermissionList; + /** + * Not supported. Use a set of IP permissions to specify the CIDR. + */ + CidrIp?: String; + /** + * Not supported. Use a set of IP permissions to specify the port. + */ + FromPort?: Integer; + /** + * Not supported. Use a set of IP permissions to specify the protocol name or number. + */ + IpProtocol?: String; + /** + * Not supported. Use a set of IP permissions to specify the port. + */ + ToPort?: Integer; + /** + * Not supported. Use a set of IP permissions to specify a destination security group. + */ + SourceSecurityGroupName?: String; + /** + * Not supported. Use a set of IP permissions to specify a destination security group. + */ + SourceSecurityGroupOwnerId?: String; + } + export interface AuthorizeSecurityGroupIngressRequest { + /** + * The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule. + */ + CidrIp?: String; + /** + * The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule. + */ + FromPort?: Integer; + /** + * The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + */ + GroupId?: String; + /** + * [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. + */ + GroupName?: String; + /** + * The sets of IP permissions. + */ + IpPermissions?: IpPermissionList; + /** + * The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions. [VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule. + */ + IpProtocol?: String; + /** + * [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC. + */ + SourceSecurityGroupName?: String; + /** + * [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. + */ + SourceSecurityGroupOwnerId?: String; + /** + * The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule. + */ + ToPort?: Integer; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export type AutoAcceptSharedAttachmentsValue = "enable"|"disable"|string; + export type AutoPlacement = "on"|"off"|string; + export interface AvailabilityZone { + /** + * The state of the Availability Zone. + */ + State?: AvailabilityZoneState; + /** + * Any messages about the Availability Zone. + */ + Messages?: AvailabilityZoneMessageList; + /** + * The name of the region. + */ + RegionName?: String; + /** + * The name of the Availability Zone. + */ + ZoneName?: String; + /** + * The ID of the Availability Zone. + */ + ZoneId?: String; + } + export type AvailabilityZoneList = AvailabilityZone[]; + export interface AvailabilityZoneMessage { + /** + * The message about the Availability Zone. + */ + Message?: String; + } + export type AvailabilityZoneMessageList = AvailabilityZoneMessage[]; + export type AvailabilityZoneState = "available"|"information"|"impaired"|"unavailable"|string; + export interface AvailableCapacity { + /** + * The total number of instances supported by the Dedicated Host. + */ + AvailableInstanceCapacity?: AvailableInstanceCapacityList; + /** + * The number of vCPUs available on the Dedicated Host. + */ + AvailableVCpus?: Integer; + } + export type AvailableInstanceCapacityList = InstanceCapacity[]; + export type BatchState = "submitted"|"active"|"cancelled"|"failed"|"cancelled_running"|"cancelled_terminating"|"modifying"|string; + export type BillingProductList = String[]; + export type _Blob = Buffer|Uint8Array|Blob|string; + export interface BlobAttributeValue { + Value?: _Blob; + } + export interface BlockDeviceMapping { + /** + * The device name (for example, /dev/sdh or xvdh). + */ + DeviceName?: String; + /** + * The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. + */ + VirtualName?: String; + /** + * Parameters used to automatically set up EBS volumes when the instance is launched. + */ + Ebs?: EbsBlockDevice; + /** + * Suppresses the specified device included in the block device mapping of the AMI. + */ + NoDevice?: String; + } + export type BlockDeviceMappingList = BlockDeviceMapping[]; + export type BlockDeviceMappingRequestList = BlockDeviceMapping[]; + export type Boolean = boolean; + export type BundleIdStringList = String[]; + export interface BundleInstanceRequest { + /** + * The ID of the instance to bundle. Type: String Default: None Required: Yes + */ + InstanceId: String; + /** + * The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error. + */ + Storage: Storage; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface BundleInstanceResult { + /** + * Information about the bundle task. + */ + BundleTask?: BundleTask; + } + export interface BundleTask { + /** + * The ID of the bundle task. + */ + BundleId?: String; + /** + * If the task fails, a description of the error. + */ + BundleTaskError?: BundleTaskError; + /** + * The ID of the instance associated with this bundle task. + */ + InstanceId?: String; + /** + * The level of task completion, as a percent (for example, 20%). + */ + Progress?: String; + /** + * The time this task started. + */ + StartTime?: DateTime; + /** + * The state of the task. + */ + State?: BundleTaskState; + /** + * The Amazon S3 storage locations. + */ + Storage?: Storage; + /** + * The time of the most recent update for the task. + */ + UpdateTime?: DateTime; + } + export interface BundleTaskError { + /** + * The error code. + */ + Code?: String; + /** + * The error message. + */ + Message?: String; + } + export type BundleTaskList = BundleTask[]; + export type BundleTaskState = "pending"|"waiting-for-shutdown"|"bundling"|"storing"|"cancelling"|"complete"|"failed"|string; + export interface ByoipCidr { + /** + * The public IPv4 address range, in CIDR notation. + */ + Cidr?: String; + /** + * The description of the address range. + */ + Description?: String; + /** + * Upon success, contains the ID of the address pool. Otherwise, contains an error message. + */ + StatusMessage?: String; + /** + * The state of the address pool. + */ + State?: ByoipCidrState; + } + export type ByoipCidrSet = ByoipCidr[]; + export type ByoipCidrState = "advertised"|"deprovisioned"|"failed-deprovision"|"failed-provision"|"pending-deprovision"|"pending-provision"|"provisioned"|string; + export type CancelBatchErrorCode = "fleetRequestIdDoesNotExist"|"fleetRequestIdMalformed"|"fleetRequestNotInCancellableState"|"unexpectedError"|string; + export interface CancelBundleTaskRequest { + /** + * The ID of the bundle task. + */ + BundleId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CancelBundleTaskResult { + /** + * Information about the bundle task. + */ + BundleTask?: BundleTask; + } + export interface CancelCapacityReservationRequest { + /** + * The ID of the Capacity Reservation to be cancelled. + */ + CapacityReservationId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CancelCapacityReservationResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface CancelConversionRequest { + /** + * The ID of the conversion task. + */ + ConversionTaskId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The reason for canceling the conversion task. + */ + ReasonMessage?: String; + } + export interface CancelExportTaskRequest { + /** + * The ID of the export task. This is the ID returned by CreateInstanceExportTask. + */ + ExportTaskId: String; + } + export interface CancelImportTaskRequest { + /** + * The reason for canceling the task. + */ + CancelReason?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the import image or import snapshot task to be canceled. + */ + ImportTaskId?: String; + } + export interface CancelImportTaskResult { + /** + * The ID of the task being canceled. + */ + ImportTaskId?: String; + /** + * The current state of the task being canceled. + */ + PreviousState?: String; + /** + * The current state of the task being canceled. + */ + State?: String; + } + export interface CancelReservedInstancesListingRequest { + /** + * The ID of the Reserved Instance listing. + */ + ReservedInstancesListingId: String; + } + export interface CancelReservedInstancesListingResult { + /** + * The Reserved Instance listing. + */ + ReservedInstancesListings?: ReservedInstancesListingList; + } + export interface CancelSpotFleetRequestsError { + /** + * The error code. + */ + Code?: CancelBatchErrorCode; + /** + * The description for the error code. + */ + Message?: String; + } + export interface CancelSpotFleetRequestsErrorItem { + /** + * The error. + */ + Error?: CancelSpotFleetRequestsError; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId?: String; + } + export type CancelSpotFleetRequestsErrorSet = CancelSpotFleetRequestsErrorItem[]; + export interface CancelSpotFleetRequestsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the Spot Fleet requests. + */ + SpotFleetRequestIds: ValueStringList; + /** + * Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully. + */ + TerminateInstances: Boolean; + } + export interface CancelSpotFleetRequestsResponse { + /** + * Information about the Spot Fleet requests that are successfully canceled. + */ + SuccessfulFleetRequests?: CancelSpotFleetRequestsSuccessSet; + /** + * Information about the Spot Fleet requests that are not successfully canceled. + */ + UnsuccessfulFleetRequests?: CancelSpotFleetRequestsErrorSet; + } + export interface CancelSpotFleetRequestsSuccessItem { + /** + * The current state of the Spot Fleet request. + */ + CurrentSpotFleetRequestState?: BatchState; + /** + * The previous state of the Spot Fleet request. + */ + PreviousSpotFleetRequestState?: BatchState; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId?: String; + } + export type CancelSpotFleetRequestsSuccessSet = CancelSpotFleetRequestsSuccessItem[]; + export type CancelSpotInstanceRequestState = "active"|"open"|"closed"|"cancelled"|"completed"|string; + export interface CancelSpotInstanceRequestsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more Spot Instance request IDs. + */ + SpotInstanceRequestIds: SpotInstanceRequestIdList; + } + export interface CancelSpotInstanceRequestsResult { + /** + * One or more Spot Instance requests. + */ + CancelledSpotInstanceRequests?: CancelledSpotInstanceRequestList; + } + export interface CancelledSpotInstanceRequest { + /** + * The ID of the Spot Instance request. + */ + SpotInstanceRequestId?: String; + /** + * The state of the Spot Instance request. + */ + State?: CancelSpotInstanceRequestState; + } + export type CancelledSpotInstanceRequestList = CancelledSpotInstanceRequest[]; + export interface CapacityReservation { + /** + * The ID of the Capacity Reservation. + */ + CapacityReservationId?: String; + /** + * The type of instance for which the Capacity Reservation reserves capacity. + */ + InstanceType?: String; + /** + * The type of operating system for which the Capacity Reservation reserves capacity. + */ + InstancePlatform?: CapacityReservationInstancePlatform; + /** + * The Availability Zone in which the capacity is reserved. + */ + AvailabilityZone?: String; + /** + * Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: default - The Capacity Reservation is created on hardware that is shared with other AWS accounts. dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account. + */ + Tenancy?: CapacityReservationTenancy; + /** + * The number of instances for which the Capacity Reservation reserves capacity. + */ + TotalInstanceCount?: Integer; + /** + * The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. + */ + AvailableInstanceCount?: Integer; + /** + * Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. + */ + EbsOptimized?: Boolean; + /** + * Indicates whether the Capacity Reservation supports instances with temporary, block-level storage. + */ + EphemeralStorage?: Boolean; + /** + * The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: active - The Capacity Reservation is active and the capacity is available for your use. cancelled - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use. expired - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use. pending - The Capacity Reservation request was successful but the capacity provisioning is still pending. failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes. + */ + State?: CapacityReservationState; + /** + * The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. + */ + EndDate?: DateTime; + /** + * Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation remains active until you explicitly cancel it. limited - The Capacity Reservation expires automatically at a specified date and time. + */ + EndDateType?: EndDateType; + /** + * Indicates the type of instance launches that the Capacity Reservation accepts. The options include: open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters. targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. + */ + InstanceMatchCriteria?: InstanceMatchCriteria; + /** + * The date and time at which the Capacity Reservation was created. + */ + CreateDate?: DateTime; + /** + * Any tags assigned to the Capacity Reservation. + */ + Tags?: TagList; + } + export type CapacityReservationIdSet = String[]; + export type CapacityReservationInstancePlatform = "Linux/UNIX"|"Red Hat Enterprise Linux"|"SUSE Linux"|"Windows"|"Windows with SQL Server"|"Windows with SQL Server Enterprise"|"Windows with SQL Server Standard"|"Windows with SQL Server Web"|"Linux with SQL Server Standard"|"Linux with SQL Server Web"|"Linux with SQL Server Enterprise"|string; + export type CapacityReservationPreference = "open"|"none"|string; + export type CapacityReservationSet = CapacityReservation[]; + export interface CapacityReservationSpecification { + /** + * Indicates the instance's Capacity Reservation preferences. Possible preferences include: open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance. + */ + CapacityReservationPreference?: CapacityReservationPreference; + /** + * Information about the target Capacity Reservation. + */ + CapacityReservationTarget?: CapacityReservationTarget; + } + export interface CapacityReservationSpecificationResponse { + /** + * Describes the instance's Capacity Reservation preferences. Possible preferences include: open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. + */ + CapacityReservationPreference?: CapacityReservationPreference; + /** + * Information about the targeted Capacity Reservation. + */ + CapacityReservationTarget?: CapacityReservationTargetResponse; + } + export type CapacityReservationState = "active"|"expired"|"cancelled"|"pending"|"failed"|string; + export interface CapacityReservationTarget { + /** + * The ID of the Capacity Reservation. + */ + CapacityReservationId?: String; + } + export interface CapacityReservationTargetResponse { + /** + * The ID of the Capacity Reservation. + */ + CapacityReservationId?: String; + } + export type CapacityReservationTenancy = "default"|"dedicated"|string; + export interface CertificateAuthentication { + /** + * The ARN of the client certificate. + */ + ClientRootCertificateChain?: String; + } + export interface CertificateAuthenticationRequest { + /** + * The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM). + */ + ClientRootCertificateChainArn?: String; + } + export interface CidrAuthorizationContext { + /** + * The plain-text authorization message for the prefix and account. + */ + Message: String; + /** + * The signed authorization message for the prefix and account. + */ + Signature: String; + } + export interface CidrBlock { + /** + * The IPv4 CIDR block. + */ + CidrBlock?: String; + } + export type CidrBlockSet = CidrBlock[]; + export interface ClassicLinkDnsSupport { + /** + * Indicates whether ClassicLink DNS support is enabled for the VPC. + */ + ClassicLinkDnsSupported?: Boolean; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export type ClassicLinkDnsSupportList = ClassicLinkDnsSupport[]; + export interface ClassicLinkInstance { + /** + * A list of security groups. + */ + Groups?: GroupIdentifierList; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * Any tags assigned to the instance. + */ + Tags?: TagList; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export type ClassicLinkInstanceList = ClassicLinkInstance[]; + export interface ClassicLoadBalancer { + /** + * The name of the load balancer. + */ + Name?: String; + } + export type ClassicLoadBalancers = ClassicLoadBalancer[]; + export interface ClassicLoadBalancersConfig { + /** + * One or more Classic Load Balancers. + */ + ClassicLoadBalancers?: ClassicLoadBalancers; + } + export interface ClientCertificateRevocationListStatus { + /** + * The state of the client certificate revocation list. + */ + Code?: ClientCertificateRevocationListStatusCode; + /** + * A message about the status of the client certificate revocation list, if applicable. + */ + Message?: String; + } + export type ClientCertificateRevocationListStatusCode = "pending"|"active"|string; + export interface ClientData { + /** + * A user-defined comment about the disk upload. + */ + Comment?: String; + /** + * The time that the disk upload ends. + */ + UploadEnd?: DateTime; + /** + * The size of the uploaded disk image, in GiB. + */ + UploadSize?: Double; + /** + * The time that the disk upload starts. + */ + UploadStart?: DateTime; + } + export interface ClientVpnAuthentication { + /** + * The authentication type used. + */ + Type?: ClientVpnAuthenticationType; + /** + * Information about the Active Directory, if applicable. + */ + ActiveDirectory?: DirectoryServiceAuthentication; + /** + * Information about the authentication certificates, if applicable. + */ + MutualAuthentication?: CertificateAuthentication; + } + export type ClientVpnAuthenticationList = ClientVpnAuthentication[]; + export interface ClientVpnAuthenticationRequest { + /** + * The type of client authentication to be used. Specify certificate-authentication to use certificate-based authentication, or directory-service-authentication to use Active Directory authentication. + */ + Type?: ClientVpnAuthenticationType; + /** + * Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication. + */ + ActiveDirectory?: DirectoryServiceAuthenticationRequest; + /** + * Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication. + */ + MutualAuthentication?: CertificateAuthenticationRequest; + } + export type ClientVpnAuthenticationRequestList = ClientVpnAuthenticationRequest[]; + export type ClientVpnAuthenticationType = "certificate-authentication"|"directory-service-authentication"|string; + export interface ClientVpnAuthorizationRuleStatus { + /** + * The state of the authorization rule. + */ + Code?: ClientVpnAuthorizationRuleStatusCode; + /** + * A message about the status of the authorization rule, if applicable. + */ + Message?: String; + } + export type ClientVpnAuthorizationRuleStatusCode = "authorizing"|"active"|"failed"|"revoking"|string; + export interface ClientVpnConnection { + /** + * The ID of the Client VPN endpoint to which the client is connected. + */ + ClientVpnEndpointId?: String; + /** + * The current date and time. + */ + Timestamp?: String; + /** + * The ID of the client connection. + */ + ConnectionId?: String; + /** + * The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used. + */ + Username?: String; + /** + * The date and time the client connection was established. + */ + ConnectionEstablishedTime?: String; + /** + * The number of bytes sent by the client. + */ + IngressBytes?: String; + /** + * The number of bytes received by the client. + */ + EgressBytes?: String; + /** + * The number of packets sent by the client. + */ + IngressPackets?: String; + /** + * The number of packets received by the client. + */ + EgressPackets?: String; + /** + * The IP address of the client. + */ + ClientIp?: String; + /** + * The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name. + */ + CommonName?: String; + /** + * The current state of the client connection. + */ + Status?: ClientVpnConnectionStatus; + /** + * The date and time the client connection was terminated. + */ + ConnectionEndTime?: String; + } + export type ClientVpnConnectionSet = ClientVpnConnection[]; + export interface ClientVpnConnectionStatus { + /** + * The state of the client connection. + */ + Code?: ClientVpnConnectionStatusCode; + /** + * A message about the status of the client connection, if applicable. + */ + Message?: String; + } + export type ClientVpnConnectionStatusCode = "active"|"failed-to-terminate"|"terminating"|"terminated"|string; + export interface ClientVpnEndpoint { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId?: String; + /** + * A brief description of the endpoint. + */ + Description?: String; + /** + * The current state of the Client VPN endpoint. + */ + Status?: ClientVpnEndpointStatus; + /** + * The date and time the Client VPN endpoint was created. + */ + CreationTime?: String; + /** + * The date and time the Client VPN endpoint was deleted, if applicable. + */ + DeletionTime?: String; + /** + * The DNS name to be used by clients when connecting to the Client VPN endpoint. + */ + DnsName?: String; + /** + * The IPv4 address range, in CIDR notation, from which client IP addresses are assigned. + */ + ClientCidrBlock?: String; + /** + * Information about the DNS servers to be used for DNS resolution. + */ + DnsServers?: ValueStringList; + /** + * Indicates whether VPN split tunneling is supported. + */ + SplitTunnel?: Boolean; + /** + * The protocol used by the VPN session. + */ + VpnProtocol?: VpnProtocol; + /** + * The transport protocol used by the Client VPN endpoint. + */ + TransportProtocol?: TransportProtocol; + /** + * Information about the associated target networks. A target network is a subnet in a VPC. + */ + AssociatedTargetNetworks?: AssociatedTargetNetworkSet; + /** + * The ARN of the server certificate. + */ + ServerCertificateArn?: String; + /** + * Information about the authentication method used by the Client VPN endpoint. + */ + AuthenticationOptions?: ClientVpnAuthenticationList; + /** + * Information about the client connection logging options for the Client VPN endpoint. + */ + ConnectionLogOptions?: ConnectionLogResponseOptions; + /** + * Any tags assigned to the Client VPN endpoint. + */ + Tags?: TagList; + } + export interface ClientVpnEndpointStatus { + /** + * The state of the Client VPN endpoint. Possible states include: pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections. available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections. deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections. deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections. + */ + Code?: ClientVpnEndpointStatusCode; + /** + * A message about the status of the Client VPN endpoint. + */ + Message?: String; + } + export type ClientVpnEndpointStatusCode = "pending-associate"|"available"|"deleting"|"deleted"|string; + export interface ClientVpnRoute { + /** + * The ID of the Client VPN endpoint with which the route is associated. + */ + ClientVpnEndpointId?: String; + /** + * The IPv4 address range, in CIDR notation, of the route destination. + */ + DestinationCidr?: String; + /** + * The ID of the subnet through which traffic is routed. + */ + TargetSubnet?: String; + /** + * The route type. + */ + Type?: String; + /** + * Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action. + */ + Origin?: String; + /** + * The current state of the route. + */ + Status?: ClientVpnRouteStatus; + /** + * A brief description of the route. + */ + Description?: String; + } + export type ClientVpnRouteSet = ClientVpnRoute[]; + export interface ClientVpnRouteStatus { + /** + * The state of the Client VPN endpoint route. + */ + Code?: ClientVpnRouteStatusCode; + /** + * A message about the status of the Client VPN endpoint route, if applicable. + */ + Message?: String; + } + export type ClientVpnRouteStatusCode = "creating"|"active"|"failed"|"deleting"|string; + export type ClientVpnSecurityGroupIdSet = String[]; + export interface ConfirmProductInstanceRequest { + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * The product code. This must be a product code that you own. + */ + ProductCode: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ConfirmProductInstanceResult { + /** + * The AWS account ID of the instance owner. This is only present if the product code is attached to the instance. + */ + OwnerId?: String; + /** + * The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance. + */ + Return?: Boolean; + } + export interface ConnectionLogOptions { + /** + * Indicates whether connection logging is enabled. + */ + Enabled?: Boolean; + /** + * The name of the CloudWatch Logs log group. + */ + CloudwatchLogGroup?: String; + /** + * The name of the CloudWatch Logs log stream to which the connection data is published. + */ + CloudwatchLogStream?: String; + } + export interface ConnectionLogResponseOptions { + /** + * Indicates whether client connection logging is enabled for the Client VPN endpoint. + */ + Enabled?: Boolean; + /** + * The name of the Amazon CloudWatch Logs log group to which connection logging data is published. + */ + CloudwatchLogGroup?: String; + /** + * The name of the Amazon CloudWatch Logs log stream to which connection logging data is published. + */ + CloudwatchLogStream?: String; + } + export interface ConnectionNotification { + /** + * The ID of the notification. + */ + ConnectionNotificationId?: String; + /** + * The ID of the endpoint service. + */ + ServiceId?: String; + /** + * The ID of the VPC endpoint. + */ + VpcEndpointId?: String; + /** + * The type of notification. + */ + ConnectionNotificationType?: ConnectionNotificationType; + /** + * The ARN of the SNS topic for the notification. + */ + ConnectionNotificationArn?: String; + /** + * The events for the notification. Valid values are Accept, Connect, Delete, and Reject. + */ + ConnectionEvents?: ValueStringList; + /** + * The state of the notification. + */ + ConnectionNotificationState?: ConnectionNotificationState; + } + export type ConnectionNotificationSet = ConnectionNotification[]; + export type ConnectionNotificationState = "Enabled"|"Disabled"|string; + export type ConnectionNotificationType = "Topic"|string; + export type ContainerFormat = "ova"|string; + export type ConversionIdStringList = String[]; + export interface ConversionTask { + /** + * The ID of the conversion task. + */ + ConversionTaskId?: String; + /** + * The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task. + */ + ExpirationTime?: String; + /** + * If the task is for importing an instance, this contains information about the import instance task. + */ + ImportInstance?: ImportInstanceTaskDetails; + /** + * If the task is for importing a volume, this contains information about the import volume task. + */ + ImportVolume?: ImportVolumeTaskDetails; + /** + * The state of the conversion task. + */ + State?: ConversionTaskState; + /** + * The status message related to the conversion task. + */ + StatusMessage?: String; + /** + * Any tags assigned to the task. + */ + Tags?: TagList; + } + export type ConversionTaskState = "active"|"cancelling"|"cancelled"|"completed"|string; + export interface CopyFpgaImageRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the source AFI. + */ + SourceFpgaImageId: String; + /** + * The description for the new AFI. + */ + Description?: String; + /** + * The name for the new AFI. The default is the name of the source AFI. + */ + Name?: String; + /** + * The region that contains the source AFI. + */ + SourceRegion: String; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + } + export interface CopyFpgaImageResult { + /** + * The ID of the new AFI. + */ + FpgaImageId?: String; + } + export interface CopyImageRequest { + /** + * Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. + */ + ClientToken?: String; + /** + * A description for the new AMI in the destination region. + */ + Description?: String; + /** + * Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. + */ + Encrypted?: Boolean; + /** + * An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: Key ID Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified CMK must exist in the region that the snapshot is being copied to. + */ + KmsKeyId?: String; + /** + * The name of the new AMI in the destination region. + */ + Name: String; + /** + * The ID of the AMI to copy. + */ + SourceImageId: String; + /** + * The name of the region that contains the AMI to copy. + */ + SourceRegion: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CopyImageResult { + /** + * The ID of the new AMI. + */ + ImageId?: String; + } + export interface CopySnapshotRequest { + /** + * A description for the EBS snapshot. + */ + Description?: String; + /** + * The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required. The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file. + */ + DestinationRegion?: String; + /** + * Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot use it to create an unencrypted copy of an encrypted snapshot. Your default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. + */ + Encrypted?: Boolean; + /** + * An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: Key ID Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail. + */ + KmsKeyId?: String; + /** + * When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state. + */ + PresignedUrl?: String; + /** + * The ID of the Region that contains the snapshot to be copied. + */ + SourceRegion: String; + /** + * The ID of the EBS snapshot to copy. + */ + SourceSnapshotId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CopySnapshotResult { + /** + * The ID of the new snapshot. + */ + SnapshotId?: String; + } + export interface CpuOptions { + /** + * The number of CPU cores for the instance. + */ + CoreCount?: Integer; + /** + * The number of threads per CPU core. + */ + ThreadsPerCore?: Integer; + } + export interface CpuOptionsRequest { + /** + * The number of CPU cores for the instance. + */ + CoreCount?: Integer; + /** + * The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2. + */ + ThreadsPerCore?: Integer; + } + export interface CreateCapacityReservationRequest { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. Constraint: Maximum 64 ASCII characters. + */ + ClientToken?: String; + /** + * The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. + */ + InstanceType: String; + /** + * The type of operating system for which to reserve capacity. + */ + InstancePlatform: CapacityReservationInstancePlatform; + /** + * The Availability Zone in which to create the Capacity Reservation. + */ + AvailabilityZone: String; + /** + * Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: default - The Capacity Reservation is created on hardware that is shared with other AWS accounts. dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account. + */ + Tenancy?: CapacityReservationTenancy; + /** + * The number of instances for which to reserve capacity. + */ + InstanceCount: Integer; + /** + * Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. + */ + EbsOptimized?: Boolean; + /** + * Indicates whether the Capacity Reservation supports instances with temporary, block-level storage. + */ + EphemeralStorage?: Boolean; + /** + * The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited. If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019. + */ + EndDate?: DateTime; + /** + * Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited. limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited. + */ + EndDateType?: EndDateType; + /** + * Indicates the type of instance launches that the Capacity Reservation accepts. The options include: open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. Default: open + */ + InstanceMatchCriteria?: InstanceMatchCriteria; + /** + * The tags to apply to the Capacity Reservation during launch. + */ + TagSpecifications?: TagSpecificationList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateCapacityReservationResult { + /** + * Information about the Capacity Reservation. + */ + CapacityReservation?: CapacityReservation; + } + export interface CreateClientVpnEndpointRequest { + /** + * The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. + */ + ClientCidrBlock: String; + /** + * The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide. + */ + ServerCertificateArn: String; + /** + * Information about the authentication method to be used to authenticate clients. + */ + AuthenticationOptions: ClientVpnAuthenticationRequestList; + /** + * Information about the client connection logging options. If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: Client connection requests Client connection results (successful and unsuccessful) Reasons for unsuccessful client connection requests Client connection termination time + */ + ConnectionLogOptions: ConnectionLogOptions; + /** + * Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server. + */ + DnsServers?: ValueStringList; + /** + * The transport protocol to be used by the VPN session. Default value: udp + */ + TransportProtocol?: TransportProtocol; + /** + * A brief description of the Client VPN endpoint. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. + */ + ClientToken?: String; + /** + * The tags to apply to the Client VPN endpoint during creation. + */ + TagSpecifications?: TagSpecificationList; + } + export interface CreateClientVpnEndpointResult { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId?: String; + /** + * The current state of the Client VPN endpoint. + */ + Status?: ClientVpnEndpointStatus; + /** + * The DNS name to be used by clients when establishing their VPN session. + */ + DnsName?: String; + } + export interface CreateClientVpnRouteRequest { + /** + * The ID of the Client VPN endpoint to which to add the route. + */ + ClientVpnEndpointId: String; + /** + * The IPv4 address range, in CIDR notation, of the route destination. For example: To add a route for Internet access, enter 0.0.0.0/0 To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range Route address ranges cannot overlap with the CIDR range specified for client allocation. + */ + DestinationCidrBlock: String; + /** + * The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint. + */ + TargetVpcSubnetId: String; + /** + * A brief description of the route. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateClientVpnRouteResult { + /** + * The current state of the route. + */ + Status?: ClientVpnRouteStatus; + } + export interface CreateCustomerGatewayRequest { + /** + * For devices that support BGP, the customer gateway's BGP ASN. Default: 65000 + */ + BgpAsn: Integer; + /** + * The Internet-routable IP address for the customer gateway's outside interface. The address must be static. + */ + PublicIp: String; + /** + * The type of VPN connection that this customer gateway supports (ipsec.1). + */ + Type: GatewayType; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateCustomerGatewayResult { + /** + * Information about the customer gateway. + */ + CustomerGateway?: CustomerGateway; + } + export interface CreateDefaultSubnetRequest { + /** + * The Availability Zone in which to create the default subnet. + */ + AvailabilityZone: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateDefaultSubnetResult { + /** + * Information about the subnet. + */ + Subnet?: Subnet; + } + export interface CreateDefaultVpcRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateDefaultVpcResult { + /** + * Information about the VPC. + */ + Vpc?: Vpc; + } + export interface CreateDhcpOptionsRequest { + /** + * A DHCP configuration option. + */ + DhcpConfigurations: NewDhcpConfigurationList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateDhcpOptionsResult { + /** + * A set of DHCP options. + */ + DhcpOptions?: DhcpOptions; + } + export interface CreateEgressOnlyInternetGatewayRequest { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. + */ + ClientToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC for which to create the egress-only internet gateway. + */ + VpcId: String; + } + export interface CreateEgressOnlyInternetGatewayResult { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + ClientToken?: String; + /** + * Information about the egress-only internet gateway. + */ + EgressOnlyInternetGateway?: EgressOnlyInternetGateway; + } + export interface CreateFleetError { + /** + * The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template. + */ + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; + /** + * Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance. + */ + Lifecycle?: InstanceLifecycle; + /** + * The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes. + */ + ErrorCode?: String; + /** + * The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes. + */ + ErrorMessage?: String; + } + export type CreateFleetErrorsSet = CreateFleetError[]; + export interface CreateFleetInstance { + /** + * The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template. + */ + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; + /** + * Indicates if the instance that was launched is a Spot Instance or On-Demand Instance. + */ + Lifecycle?: InstanceLifecycle; + /** + * The IDs of the instances. + */ + InstanceIds?: InstanceIdsSet; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The value is Windows for Windows instances; otherwise blank. + */ + Platform?: PlatformValues; + } + export type CreateFleetInstancesSet = CreateFleetInstance[]; + export interface CreateFleetRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * Describes the configuration of Spot Instances in an EC2 Fleet. + */ + SpotOptions?: SpotOptionsRequest; + /** + * The allocation strategy of On-Demand Instances in an EC2 Fleet. + */ + OnDemandOptions?: OnDemandOptionsRequest; + /** + * Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + */ + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy; + /** + * The configuration for the EC2 Fleet. + */ + LaunchTemplateConfigs: FleetLaunchTemplateConfigListRequest; + /** + * The TotalTargetCapacity, OnDemandTargetCapacity, SpotTargetCapacity, and DefaultCapacityType structure. + */ + TargetCapacitySpecification: TargetCapacitySpecificationRequest; + /** + * Indicates whether running instances should be terminated when the EC2 Fleet expires. + */ + TerminateInstancesWithExpiration?: Boolean; + /** + * The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide. + */ + Type?: FleetType; + /** + * The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. + */ + ValidFrom?: DateTime; + /** + * The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it. + */ + ValidUntil?: DateTime; + /** + * Indicates whether EC2 Fleet should replace unhealthy instances. + */ + ReplaceUnhealthyInstances?: Boolean; + /** + * The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources. + */ + TagSpecifications?: TagSpecificationList; + } + export interface CreateFleetResult { + /** + * The ID of the EC2 Fleet. + */ + FleetId?: FleetIdentifier; + /** + * Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant. + */ + Errors?: CreateFleetErrorsSet; + /** + * Information about the instances that were launched by the fleet. Valid only when Type is set to instant. + */ + Instances?: CreateFleetInstancesSet; + } + export interface CreateFlowLogsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. + */ + ClientToken?: String; + /** + * The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName. + */ + DeliverLogsPermissionArn?: String; + /** + * The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName. + */ + LogGroupName?: String; + /** + * The ID of the subnet, network interface, or VPC for which you want to create a flow log. Constraints: Maximum of 1000 resources + */ + ResourceIds: ValueStringList; + /** + * The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property. + */ + ResourceType: FlowLogsResourceType; + /** + * The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. + */ + TrafficType: TrafficType; + /** + * Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3. If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName. Default: cloud-watch-logs + */ + LogDestinationType?: LogDestinationType; + /** + * Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType. If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term. + */ + LogDestination?: String; + } + export interface CreateFlowLogsResult { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + ClientToken?: String; + /** + * The IDs of the flow logs. + */ + FlowLogIds?: ValueStringList; + /** + * Information about the flow logs that could not be created successfully. + */ + Unsuccessful?: UnsuccessfulItemSet; + } + export interface CreateFpgaImageRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball. + */ + InputStorageLocation: StorageLocation; + /** + * The location in Amazon S3 for the output logs. + */ + LogsStorageLocation?: StorageLocation; + /** + * A description for the AFI. + */ + Description?: String; + /** + * A name for the AFI. + */ + Name?: String; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + } + export interface CreateFpgaImageResult { + /** + * The FPGA image identifier (AFI ID). + */ + FpgaImageId?: String; + /** + * The global FPGA image identifier (AGFI ID). + */ + FpgaImageGlobalId?: String; + } + export interface CreateImageRequest { + /** + * Tthe block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action. + */ + BlockDeviceMappings?: BlockDeviceMappingRequestList; + /** + * A description for the new image. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_) + */ + Name: String; + /** + * By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed. + */ + NoReboot?: Boolean; + } + export interface CreateImageResult { + /** + * The ID of the new AMI. + */ + ImageId?: String; + } + export interface CreateInstanceExportTaskRequest { + /** + * A description for the conversion task or the resource being exported. The maximum length is 255 bytes. + */ + Description?: String; + /** + * The format and location for an instance export task. + */ + ExportToS3Task?: ExportToS3TaskSpecification; + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * The target virtualization environment. + */ + TargetEnvironment?: ExportEnvironment; + } + export interface CreateInstanceExportTaskResult { + /** + * Information about the instance export task. + */ + ExportTask?: ExportTask; + } + export interface CreateInternetGatewayRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateInternetGatewayResult { + /** + * Information about the internet gateway. + */ + InternetGateway?: InternetGateway; + } + export interface CreateKeyPairRequest { + /** + * A unique name for the key pair. Constraints: Up to 255 ASCII characters + */ + KeyName: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateLaunchTemplateRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraint: Maximum 128 ASCII characters. + */ + ClientToken?: String; + /** + * A name for the launch template. + */ + LaunchTemplateName: LaunchTemplateName; + /** + * A description for the first version of the launch template. + */ + VersionDescription?: VersionDescription; + /** + * The information for the launch template. + */ + LaunchTemplateData: RequestLaunchTemplateData; + } + export interface CreateLaunchTemplateResult { + /** + * Information about the launch template. + */ + LaunchTemplate?: LaunchTemplate; + } + export interface CreateLaunchTemplateVersionRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraint: Maximum 128 ASCII characters. + */ + ClientToken?: String; + /** + * The ID of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. + */ + SourceVersion?: String; + /** + * A description for the version of the launch template. + */ + VersionDescription?: VersionDescription; + /** + * The information for the launch template. + */ + LaunchTemplateData: RequestLaunchTemplateData; + } + export interface CreateLaunchTemplateVersionResult { + /** + * Information about the launch template version. + */ + LaunchTemplateVersion?: LaunchTemplateVersion; + } + export interface CreateNatGatewayRequest { + /** + * The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it. + */ + AllocationId: String; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. Constraint: Maximum 64 ASCII characters. + */ + ClientToken?: String; + /** + * The subnet in which to create the NAT gateway. + */ + SubnetId: String; + } + export interface CreateNatGatewayResult { + /** + * Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. + */ + ClientToken?: String; + /** + * Information about the NAT gateway. + */ + NatGateway?: NatGateway; + } + export interface CreateNetworkAclEntryRequest { + /** + * The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). + */ + CidrBlock?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). + */ + Egress: Boolean; + /** + * ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. + */ + IcmpTypeCode?: IcmpTypeCode; + /** + * The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64). + */ + Ipv6CidrBlock?: String; + /** + * The ID of the network ACL. + */ + NetworkAclId: String; + /** + * TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP). + */ + PortRange?: PortRange; + /** + * The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code. + */ + Protocol: String; + /** + * Indicates whether to allow or deny the traffic that matches the rule. + */ + RuleAction: RuleAction; + /** + * The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number. Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use. + */ + RuleNumber: Integer; + } + export interface CreateNetworkAclRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface CreateNetworkAclResult { + /** + * Information about the network ACL. + */ + NetworkAcl?: NetworkAcl; + } + export interface CreateNetworkInterfacePermissionRequest { + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + /** + * The AWS account ID. + */ + AwsAccountId?: String; + /** + * The AWS service. Currently not supported. + */ + AwsService?: String; + /** + * The type of permission to grant. + */ + Permission: InterfacePermissionType; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateNetworkInterfacePermissionResult { + /** + * Information about the permission for the network interface. + */ + InterfacePermission?: NetworkInterfacePermission; + } + export interface CreateNetworkInterfaceRequest { + /** + * A description for the network interface. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of one or more security groups. + */ + Groups?: SecurityGroupIdStringList; + /** + * The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting. + */ + Ipv6AddressCount?: Integer; + /** + * One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. + */ + Ipv6Addresses?: InstanceIpv6AddressList; + /** + * The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary). + */ + PrivateIpAddress?: String; + /** + * One or more private IPv4 addresses. + */ + PrivateIpAddresses?: PrivateIpAddressSpecificationList; + /** + * The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide. + */ + SecondaryPrivateIpAddressCount?: Integer; + /** + * Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide. If you are not creating an EFA ENI, omit this parameter. + */ + InterfaceType?: NetworkInterfaceCreationType; + /** + * The ID of the subnet to associate with the network interface. + */ + SubnetId: String; + } + export interface CreateNetworkInterfaceResult { + /** + * Information about the network interface. + */ + NetworkInterface?: NetworkInterface; + } + export interface CreatePlacementGroupRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * A name for the placement group. Must be unique within the scope of your account for the Region. Constraints: Up to 255 ASCII characters + */ + GroupName?: String; + /** + * The placement strategy. + */ + Strategy?: PlacementStrategy; + /** + * The number of partitions. Valid only when Strategy is set to partition. + */ + PartitionCount?: Integer; + } + export interface CreateReservedInstancesListingRequest { + /** + * Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency. + */ + ClientToken: String; + /** + * The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call. + */ + InstanceCount: Integer; + /** + * A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. + */ + PriceSchedules: PriceScheduleSpecificationList; + /** + * The ID of the active Standard Reserved Instance. + */ + ReservedInstancesId: String; + } + export interface CreateReservedInstancesListingResult { + /** + * Information about the Standard Reserved Instance listing. + */ + ReservedInstancesListings?: ReservedInstancesListingList; + } + export interface CreateRouteRequest { + /** + * The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. + */ + DestinationCidrBlock?: String; + /** + * The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. + */ + DestinationIpv6CidrBlock?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * [IPv6 traffic only] The ID of an egress-only internet gateway. + */ + EgressOnlyInternetGatewayId?: String; + /** + * The ID of an internet gateway or virtual private gateway attached to your VPC. + */ + GatewayId?: String; + /** + * The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. + */ + InstanceId?: String; + /** + * [IPv4 traffic only] The ID of a NAT gateway. + */ + NatGatewayId?: String; + /** + * The ID of a transit gateway. + */ + TransitGatewayId?: String; + /** + * The ID of a network interface. + */ + NetworkInterfaceId?: String; + /** + * The ID of the route table for the route. + */ + RouteTableId: String; + /** + * The ID of a VPC peering connection. + */ + VpcPeeringConnectionId?: String; + } + export interface CreateRouteResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface CreateRouteTableRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface CreateRouteTableResult { + /** + * Information about the route table. + */ + RouteTable?: RouteTable; + } + export interface CreateSecurityGroupRequest { + /** + * A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + */ + Description: String; + /** + * The name of the security group. Constraints: Up to 255 characters in length. Cannot start with sg-. Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + */ + GroupName: String; + /** + * [EC2-VPC] The ID of the VPC. Required for EC2-VPC. + */ + VpcId?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateSecurityGroupResult { + /** + * The ID of the security group. + */ + GroupId?: String; + } + export interface CreateSnapshotRequest { + /** + * A description for the snapshot. + */ + Description?: String; + /** + * The ID of the EBS volume. + */ + VolumeId: String; + /** + * The tags to apply to the snapshot during creation. + */ + TagSpecifications?: TagSpecificationList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateSpotDatafeedSubscriptionRequest { + /** + * The Amazon S3 bucket in which to store the Spot Instance data feed. + */ + Bucket: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * A prefix for the data feed file names. + */ + Prefix?: String; + } + export interface CreateSpotDatafeedSubscriptionResult { + /** + * The Spot Instance data feed subscription. + */ + SpotDatafeedSubscription?: SpotDatafeedSubscription; + } + export interface CreateSubnetRequest { + /** + * The Availability Zone for the subnet. Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet. + */ + AvailabilityZone?: String; + /** + * The AZ ID of the subnet. + */ + AvailabilityZoneId?: String; + /** + * The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. + */ + CidrBlock: String; + /** + * The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length. + */ + Ipv6CidrBlock?: String; + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateSubnetResult { + /** + * Information about the subnet. + */ + Subnet?: Subnet; + } + export interface CreateTagsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches. + */ + Resources: ResourceIdList; + /** + * The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. + */ + Tags: TagList; + } + export interface CreateTransitGatewayRequest { + /** + * A description of the transit gateway. + */ + Description?: String; + /** + * The transit gateway options. + */ + Options?: TransitGatewayRequestOptions; + /** + * The tags to apply to the transit gateway. + */ + TagSpecifications?: TagSpecificationList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateTransitGatewayResult { + /** + * Information about the transit gateway. + */ + TransitGateway?: TransitGateway; + } + export interface CreateTransitGatewayRouteRequest { + /** + * The CIDR range used for destination matches. Routing decisions are based on the most specific match. + */ + DestinationCidrBlock: String; + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * Indicates whether to drop traffic if the target isn't available. + */ + Blackhole?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateTransitGatewayRouteResult { + /** + * Information about the route. + */ + Route?: TransitGatewayRoute; + } + export interface CreateTransitGatewayRouteTableRequest { + /** + * The ID of the transit gateway. + */ + TransitGatewayId: String; + /** + * The tags to apply to the transit gateway route table. + */ + TagSpecifications?: TagSpecificationList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateTransitGatewayRouteTableResult { + /** + * Information about the transit gateway route table. + */ + TransitGatewayRouteTable?: TransitGatewayRouteTable; + } + export interface CreateTransitGatewayVpcAttachmentRequest { + /** + * The ID of the transit gateway. + */ + TransitGatewayId: String; + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet. + */ + SubnetIds: ValueStringList; + /** + * The VPC attachment options. + */ + Options?: CreateTransitGatewayVpcAttachmentRequestOptions; + /** + * The tags to apply to the VPC attachment. + */ + TagSpecifications?: TagSpecificationList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateTransitGatewayVpcAttachmentRequestOptions { + /** + * Enable or disable DNS support. The default is enable. + */ + DnsSupport?: DnsSupportValue; + /** + * Enable or disable IPv6 support. The default is enable. + */ + Ipv6Support?: Ipv6SupportValue; + } + export interface CreateTransitGatewayVpcAttachmentResult { + /** + * Information about the VPC attachment. + */ + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + } + export interface CreateVolumePermission { + /** + * The group to be added or removed. The possible value is all. + */ + Group?: PermissionGroup; + /** + * The AWS account ID to be added or removed. + */ + UserId?: String; + } + export type CreateVolumePermissionList = CreateVolumePermission[]; + export interface CreateVolumePermissionModifications { + /** + * Adds the specified AWS account ID or group to the list. + */ + Add?: CreateVolumePermissionList; + /** + * Removes the specified AWS account ID or group from the list. + */ + Remove?: CreateVolumePermissionList; + } + export interface CreateVolumeRequest { + /** + * The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you. + */ + AvailabilityZone: String; + /** + * Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. + */ + Encrypted?: Boolean; + /** + * The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. This parameter is valid only for Provisioned IOPS SSD (io1) volumes. + */ + Iops?: Integer; + /** + * An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: Key ID Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail. + */ + KmsKeyId?: String; + /** + * The size of the volume, in GiBs. Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. At least one of Size or SnapshotId are required. + */ + Size?: Integer; + /** + * The snapshot from which to create the volume. At least one of Size or SnapshotId are required. + */ + SnapshotId?: String; + /** + * The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes. Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2. + */ + VolumeType?: VolumeType; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The tags to apply to the volume during creation. + */ + TagSpecifications?: TagSpecificationList; + } + export interface CreateVpcEndpointConnectionNotificationRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the endpoint service. + */ + ServiceId?: String; + /** + * The ID of the endpoint. + */ + VpcEndpointId?: String; + /** + * The ARN of the SNS topic for the notifications. + */ + ConnectionNotificationArn: String; + /** + * One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject. + */ + ConnectionEvents: ValueStringList; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. + */ + ClientToken?: String; + } + export interface CreateVpcEndpointConnectionNotificationResult { + /** + * Information about the notification. + */ + ConnectionNotification?: ConnectionNotification; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. + */ + ClientToken?: String; + } + export interface CreateVpcEndpointRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The type of endpoint. Default: Gateway + */ + VpcEndpointType?: VpcEndpointType; + /** + * The ID of the VPC in which the endpoint will be used. + */ + VpcId: String; + /** + * The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider. + */ + ServiceName: String; + /** + * A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service. + */ + PolicyDocument?: String; + /** + * (Gateway endpoint) One or more route table IDs. + */ + RouteTableIds?: ValueStringList; + /** + * (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface. + */ + SubnetIds?: ValueStringList; + /** + * (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface. + */ + SecurityGroupIds?: ValueStringList; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. + */ + ClientToken?: String; + /** + * (Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the region (for example, kinesis.us-east-1.amazonaws.com) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes. Default: false + */ + PrivateDnsEnabled?: Boolean; + } + export interface CreateVpcEndpointResult { + /** + * Information about the endpoint. + */ + VpcEndpoint?: VpcEndpoint; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. + */ + ClientToken?: String; + } + export interface CreateVpcEndpointServiceConfigurationRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections. + */ + AcceptanceRequired?: Boolean; + /** + * The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service. + */ + NetworkLoadBalancerArns: ValueStringList; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. + */ + ClientToken?: String; + } + export interface CreateVpcEndpointServiceConfigurationResult { + /** + * Information about the service configuration. + */ + ServiceConfiguration?: ServiceConfiguration; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. + */ + ClientToken?: String; + } + export interface CreateVpcPeeringConnectionRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The AWS account ID of the owner of the accepter VPC. Default: Your AWS account ID + */ + PeerOwnerId?: String; + /** + * The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. + */ + PeerVpcId?: String; + /** + * The ID of the requester VPC. You must specify this parameter in the request. + */ + VpcId?: String; + /** + * The region code for the accepter VPC, if the accepter VPC is located in a region other than the region in which you make the request. Default: The region in which you make the request. + */ + PeerRegion?: String; + } + export interface CreateVpcPeeringConnectionResult { + /** + * Information about the VPC peering connection. + */ + VpcPeeringConnection?: VpcPeeringConnection; + } + export interface CreateVpcRequest { + /** + * The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. + */ + CidrBlock: String; + /** + * Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. + */ + AmazonProvidedIpv6CidrBlock?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC. Important: The host value cannot be used with this parameter. Use the default or dedicated values only. Default: default + */ + InstanceTenancy?: Tenancy; + } + export interface CreateVpcResult { + /** + * Information about the VPC. + */ + Vpc?: Vpc; + } + export interface CreateVpnConnectionRequest { + /** + * The ID of the customer gateway. + */ + CustomerGatewayId: String; + /** + * The type of VPN connection (ipsec.1). + */ + Type: String; + /** + * The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway. + */ + VpnGatewayId?: String; + /** + * The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway. + */ + TransitGatewayId?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The options for the VPN connection. + */ + Options?: VpnConnectionOptionsSpecification; + } + export interface CreateVpnConnectionResult { + /** + * Information about the VPN connection. + */ + VpnConnection?: VpnConnection; + } + export interface CreateVpnConnectionRouteRequest { + /** + * The CIDR block associated with the local subnet of the customer network. + */ + DestinationCidrBlock: String; + /** + * The ID of the VPN connection. + */ + VpnConnectionId: String; + } + export interface CreateVpnGatewayRequest { + /** + * The Availability Zone for the virtual private gateway. + */ + AvailabilityZone?: String; + /** + * The type of VPN connection this virtual private gateway supports. + */ + Type: GatewayType; + /** + * A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range. Default: 64512 + */ + AmazonSideAsn?: Long; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface CreateVpnGatewayResult { + /** + * Information about the virtual private gateway. + */ + VpnGateway?: VpnGateway; + } + export interface CreditSpecification { + /** + * The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited. + */ + CpuCredits?: String; + } + export interface CreditSpecificationRequest { + /** + * The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited. + */ + CpuCredits: String; + } + export type CurrencyCodeValues = "USD"|string; + export interface CustomerGateway { + /** + * The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). + */ + BgpAsn?: String; + /** + * The ID of the customer gateway. + */ + CustomerGatewayId?: String; + /** + * The Internet-routable IP address of the customer gateway's outside interface. + */ + IpAddress?: String; + /** + * The current state of the customer gateway (pending | available | deleting | deleted). + */ + State?: String; + /** + * The type of VPN connection the customer gateway supports (ipsec.1). + */ + Type?: String; + /** + * Any tags assigned to the customer gateway. + */ + Tags?: TagList; + } + export type CustomerGatewayIdStringList = String[]; + export type CustomerGatewayList = CustomerGateway[]; + export type DatafeedSubscriptionState = "Active"|"Inactive"|string; + export type DateTime = Date; + export type DefaultRouteTableAssociationValue = "enable"|"disable"|string; + export type DefaultRouteTablePropagationValue = "enable"|"disable"|string; + export type DefaultTargetCapacityType = "spot"|"on-demand"|string; + export interface DeleteClientVpnEndpointRequest { + /** + * The ID of the Client VPN to be deleted. + */ + ClientVpnEndpointId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteClientVpnEndpointResult { + /** + * The current state of the Client VPN endpoint. + */ + Status?: ClientVpnEndpointStatus; + } + export interface DeleteClientVpnRouteRequest { + /** + * The ID of the Client VPN endpoint from which the route is to be deleted. + */ + ClientVpnEndpointId: String; + /** + * The ID of the target subnet used by the route. + */ + TargetVpcSubnetId?: String; + /** + * The IPv4 address range, in CIDR notation, of the route to be deleted. + */ + DestinationCidrBlock: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteClientVpnRouteResult { + /** + * The current state of the route. + */ + Status?: ClientVpnRouteStatus; + } + export interface DeleteCustomerGatewayRequest { + /** + * The ID of the customer gateway. + */ + CustomerGatewayId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteDhcpOptionsRequest { + /** + * The ID of the DHCP options set. + */ + DhcpOptionsId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteEgressOnlyInternetGatewayRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the egress-only internet gateway. + */ + EgressOnlyInternetGatewayId: EgressOnlyInternetGatewayId; + } + export interface DeleteEgressOnlyInternetGatewayResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + ReturnCode?: Boolean; + } + export interface DeleteFleetError { + /** + * The error code. + */ + Code?: DeleteFleetErrorCode; + /** + * The description for the error code. + */ + Message?: String; + } + export type DeleteFleetErrorCode = "fleetIdDoesNotExist"|"fleetIdMalformed"|"fleetNotInDeletableState"|"unexpectedError"|string; + export interface DeleteFleetErrorItem { + /** + * The error. + */ + Error?: DeleteFleetError; + /** + * The ID of the EC2 Fleet. + */ + FleetId?: FleetIdentifier; + } + export type DeleteFleetErrorSet = DeleteFleetErrorItem[]; + export interface DeleteFleetSuccessItem { + /** + * The current state of the EC2 Fleet. + */ + CurrentFleetState?: FleetStateCode; + /** + * The previous state of the EC2 Fleet. + */ + PreviousFleetState?: FleetStateCode; + /** + * The ID of the EC2 Fleet. + */ + FleetId?: FleetIdentifier; + } + export type DeleteFleetSuccessSet = DeleteFleetSuccessItem[]; + export interface DeleteFleetsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the EC2 Fleets. + */ + FleetIds: FleetIdSet; + /** + * Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully. + */ + TerminateInstances: Boolean; + } + export interface DeleteFleetsResult { + /** + * Information about the EC2 Fleets that are successfully deleted. + */ + SuccessfulFleetDeletions?: DeleteFleetSuccessSet; + /** + * Information about the EC2 Fleets that are not successfully deleted. + */ + UnsuccessfulFleetDeletions?: DeleteFleetErrorSet; + } + export interface DeleteFlowLogsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more flow log IDs. + */ + FlowLogIds: ValueStringList; + } + export interface DeleteFlowLogsResult { + /** + * Information about the flow logs that could not be deleted successfully. + */ + Unsuccessful?: UnsuccessfulItemSet; + } + export interface DeleteFpgaImageRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the AFI. + */ + FpgaImageId: String; + } + export interface DeleteFpgaImageResult { + /** + * Is true if the request succeeds, and an error otherwise. + */ + Return?: Boolean; + } + export interface DeleteInternetGatewayRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the internet gateway. + */ + InternetGatewayId: String; + } + export interface DeleteKeyPairRequest { + /** + * The name of the key pair. + */ + KeyName: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteLaunchTemplateRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateName?: LaunchTemplateName; + } + export interface DeleteLaunchTemplateResult { + /** + * Information about the launch template. + */ + LaunchTemplate?: LaunchTemplate; + } + export interface DeleteLaunchTemplateVersionsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The version numbers of one or more launch template versions to delete. + */ + Versions: VersionStringList; + } + export interface DeleteLaunchTemplateVersionsResponseErrorItem { + /** + * The ID of the launch template. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. + */ + LaunchTemplateName?: String; + /** + * The version number of the launch template. + */ + VersionNumber?: Long; + /** + * Information about the error. + */ + ResponseError?: ResponseError; + } + export type DeleteLaunchTemplateVersionsResponseErrorSet = DeleteLaunchTemplateVersionsResponseErrorItem[]; + export interface DeleteLaunchTemplateVersionsResponseSuccessItem { + /** + * The ID of the launch template. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. + */ + LaunchTemplateName?: String; + /** + * The version number of the launch template. + */ + VersionNumber?: Long; + } + export type DeleteLaunchTemplateVersionsResponseSuccessSet = DeleteLaunchTemplateVersionsResponseSuccessItem[]; + export interface DeleteLaunchTemplateVersionsResult { + /** + * Information about the launch template versions that were successfully deleted. + */ + SuccessfullyDeletedLaunchTemplateVersions?: DeleteLaunchTemplateVersionsResponseSuccessSet; + /** + * Information about the launch template versions that could not be deleted. + */ + UnsuccessfullyDeletedLaunchTemplateVersions?: DeleteLaunchTemplateVersionsResponseErrorSet; + } + export interface DeleteNatGatewayRequest { + /** + * The ID of the NAT gateway. + */ + NatGatewayId: String; + } + export interface DeleteNatGatewayResult { + /** + * The ID of the NAT gateway. + */ + NatGatewayId?: String; + } + export interface DeleteNetworkAclEntryRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Indicates whether the rule is an egress rule. + */ + Egress: Boolean; + /** + * The ID of the network ACL. + */ + NetworkAclId: String; + /** + * The rule number of the entry to delete. + */ + RuleNumber: Integer; + } + export interface DeleteNetworkAclRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the network ACL. + */ + NetworkAclId: String; + } + export interface DeleteNetworkInterfacePermissionRequest { + /** + * The ID of the network interface permission. + */ + NetworkInterfacePermissionId: String; + /** + * Specify true to remove the permission even if the network interface is attached to an instance. + */ + Force?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteNetworkInterfacePermissionResult { + /** + * Returns true if the request succeeds, otherwise returns an error. + */ + Return?: Boolean; + } + export interface DeleteNetworkInterfaceRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + } + export interface DeletePlacementGroupRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The name of the placement group. + */ + GroupName: String; + } + export interface DeleteRouteRequest { + /** + * The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly. + */ + DestinationCidrBlock?: String; + /** + * The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly. + */ + DestinationIpv6CidrBlock?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the route table. + */ + RouteTableId: String; + } + export interface DeleteRouteTableRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the route table. + */ + RouteTableId: String; + } + export interface DeleteSecurityGroupRequest { + /** + * The ID of the security group. Required for a nondefault VPC. + */ + GroupId?: String; + /** + * [EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID. + */ + GroupName?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteSnapshotRequest { + /** + * The ID of the EBS snapshot. + */ + SnapshotId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteSpotDatafeedSubscriptionRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteSubnetRequest { + /** + * The ID of the subnet. + */ + SubnetId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteTagsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches. + */ + Resources: ResourceIdList; + /** + * The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string. If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix). + */ + Tags?: TagList; + } + export interface DeleteTransitGatewayRequest { + /** + * The ID of the transit gateway. + */ + TransitGatewayId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteTransitGatewayResult { + /** + * Information about the deleted transit gateway. + */ + TransitGateway?: TransitGateway; + } + export interface DeleteTransitGatewayRouteRequest { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * The CIDR range for the route. This must match the CIDR for the route exactly. + */ + DestinationCidrBlock: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteTransitGatewayRouteResult { + /** + * Information about the route. + */ + Route?: TransitGatewayRoute; + } + export interface DeleteTransitGatewayRouteTableRequest { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteTransitGatewayRouteTableResult { + /** + * Information about the deleted transit gateway route table. + */ + TransitGatewayRouteTable?: TransitGatewayRouteTable; + } + export interface DeleteTransitGatewayVpcAttachmentRequest { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteTransitGatewayVpcAttachmentResult { + /** + * Information about the deleted VPC attachment. + */ + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + } + export interface DeleteVolumeRequest { + /** + * The ID of the volume. + */ + VolumeId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteVpcEndpointConnectionNotificationsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more notification IDs. + */ + ConnectionNotificationIds: ValueStringList; + } + export interface DeleteVpcEndpointConnectionNotificationsResult { + /** + * Information about the notifications that could not be deleted successfully. + */ + Unsuccessful?: UnsuccessfulItemSet; + } + export interface DeleteVpcEndpointServiceConfigurationsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of one or more services. + */ + ServiceIds: ValueStringList; + } + export interface DeleteVpcEndpointServiceConfigurationsResult { + /** + * Information about the service configurations that were not deleted, if applicable. + */ + Unsuccessful?: UnsuccessfulItemSet; + } + export interface DeleteVpcEndpointsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more VPC endpoint IDs. + */ + VpcEndpointIds: ValueStringList; + } + export interface DeleteVpcEndpointsResult { + /** + * Information about the VPC endpoints that were not successfully deleted. + */ + Unsuccessful?: UnsuccessfulItemSet; + } + export interface DeleteVpcPeeringConnectionRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC peering connection. + */ + VpcPeeringConnectionId: String; + } + export interface DeleteVpcPeeringConnectionResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface DeleteVpcRequest { + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteVpnConnectionRequest { + /** + * The ID of the VPN connection. + */ + VpnConnectionId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeleteVpnConnectionRouteRequest { + /** + * The CIDR block associated with the local subnet of the customer network. + */ + DestinationCidrBlock: String; + /** + * The ID of the VPN connection. + */ + VpnConnectionId: String; + } + export interface DeleteVpnGatewayRequest { + /** + * The ID of the virtual private gateway. + */ + VpnGatewayId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeprovisionByoipCidrRequest { + /** + * The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range. + */ + Cidr: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DeprovisionByoipCidrResult { + /** + * Information about the address range. + */ + ByoipCidr?: ByoipCidr; + } + export interface DeregisterImageRequest { + /** + * The ID of the AMI. + */ + ImageId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeAccountAttributesRequest { + /** + * The account attribute names. + */ + AttributeNames?: AccountAttributeNameStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeAccountAttributesResult { + /** + * Information about the account attributes. + */ + AccountAttributes?: AccountAttributeList; + } + export interface DescribeAddressesRequest { + /** + * One or more filters. Filter names and values are case-sensitive. allocation-id - [EC2-VPC] The allocation ID for the address. association-id - [EC2-VPC] The association ID for the address. domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc). instance-id - The ID of the instance the address is associated with, if any. network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any. network-interface-owner-id - The AWS account ID of the owner. private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address. public-ip - The Elastic IP address. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filters?: FilterList; + /** + * One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses. + */ + PublicIps?: PublicIpStringList; + /** + * [EC2-VPC] Information about the allocation IDs. + */ + AllocationIds?: AllocationIdList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeAddressesResult { + /** + * Information about the Elastic IP addresses. + */ + Addresses?: AddressList; + } + export interface DescribeAggregateIdFormatRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeAggregateIdFormatResult { + /** + * Indicates whether all resource types in the region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the region. + */ + UseLongIdsAggregated?: Boolean; + /** + * Information about each resource's ID format. + */ + Statuses?: IdFormatList; + } + export interface DescribeAvailabilityZonesRequest { + /** + * The filters. message - Information about the Availability Zone. region-name - The name of the region for the Availability Zone (for example, us-east-1). state - The state of the Availability Zone (available | information | impaired | unavailable). zone-id - The ID of the Availability Zone (for example, use1-az1). zone-name - The name of the Availability Zone (for example, us-east-1a). + */ + Filters?: FilterList; + /** + * The names of the Availability Zones. + */ + ZoneNames?: ZoneNameStringList; + /** + * The IDs of the Availability Zones. + */ + ZoneIds?: ZoneIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeAvailabilityZonesResult { + /** + * Information about the Availability Zones. + */ + AvailabilityZones?: AvailabilityZoneList; + } + export interface DescribeBundleTasksRequest { + /** + * The bundle task IDs. Default: Describes all your bundle tasks. + */ + BundleIds?: BundleIdStringList; + /** + * The filters. bundle-id - The ID of the bundle task. error-code - If the task failed, the error code returned. error-message - If the task failed, the error message returned. instance-id - The ID of the instance. progress - The level of task completion, as a percentage (for example, 20%). s3-bucket - The Amazon S3 bucket to store the AMI. s3-prefix - The beginning of the AMI name. start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z). state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed). update-time - The time of the most recent update for the task. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeBundleTasksResult { + /** + * Information about the bundle tasks. + */ + BundleTasks?: BundleTaskList; + } + export interface DescribeByoipCidrsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults: MaxResults; + /** + * The token for the next page of results. + */ + NextToken?: NextToken; + } + export interface DescribeByoipCidrsResult { + /** + * Information about your address ranges. + */ + ByoipCidrs?: ByoipCidrSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeCapacityReservationsRequest { + /** + * The ID of the Capacity Reservation. + */ + CapacityReservationIds?: CapacityReservationIdSet; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. + */ + MaxResults?: Integer; + /** + * One or more filters. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeCapacityReservationsResult { + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * Information about the Capacity Reservations. + */ + CapacityReservations?: CapacityReservationSet; + } + export interface DescribeClassicLinkInstancesRequest { + /** + * One or more filters. group-id - The ID of a VPC security group that's associated with the instance. instance-id - The ID of the instance. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC to which the instance is linked. vpc-id - The ID of the VPC that the instance is linked to. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more instance IDs. Must be instances linked to a VPC through ClassicLink. + */ + InstanceIds?: InstanceIdStringList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. Constraint: If the value is greater than 1000, we return only 1000 items. + */ + MaxResults?: Integer; + /** + * The token for the next page of results. + */ + NextToken?: String; + } + export interface DescribeClassicLinkInstancesResult { + /** + * Information about one or more linked EC2-Classic instances. + */ + Instances?: ClassicLinkInstanceList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeClientVpnAuthorizationRulesRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The token to retrieve the next page of results. + */ + NextToken?: NextToken; + /** + * One or more filters. Filter names and values are case-sensitive. + */ + Filters?: FilterList; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. + */ + MaxResults?: MaxResults; + } + export interface DescribeClientVpnAuthorizationRulesResult { + /** + * Information about the authorization rules. + */ + AuthorizationRules?: AuthorizationRuleSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface DescribeClientVpnConnectionsRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * One or more filters. Filter names and values are case-sensitive. + */ + Filters?: FilterList; + /** + * The token to retrieve the next page of results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. + */ + MaxResults?: MaxResults; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeClientVpnConnectionsResult { + /** + * Information about the active and terminated client connections. + */ + Connections?: ClientVpnConnectionSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface DescribeClientVpnEndpointsRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointIds?: ValueStringList; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. + */ + MaxResults?: MaxResults; + /** + * The token to retrieve the next page of results. + */ + NextToken?: NextToken; + /** + * One or more filters. Filter names and values are case-sensitive. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeClientVpnEndpointsResult { + /** + * Information about the Client VPN endpoints. + */ + ClientVpnEndpoints?: EndpointSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface DescribeClientVpnRoutesRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * One or more filters. Filter names and values are case-sensitive. + */ + Filters?: FilterList; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. + */ + MaxResults?: MaxResults; + /** + * The token to retrieve the next page of results. + */ + NextToken?: NextToken; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeClientVpnRoutesResult { + /** + * Information about the Client VPN endpoint routes. + */ + Routes?: ClientVpnRouteSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface DescribeClientVpnTargetNetworksRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * The IDs of the target network associations. + */ + AssociationIds?: ValueStringList; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. + */ + MaxResults?: MaxResults; + /** + * The token to retrieve the next page of results. + */ + NextToken?: NextToken; + /** + * One or more filters. Filter names and values are case-sensitive. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeClientVpnTargetNetworksResult { + /** + * Information about the associated target networks. + */ + ClientVpnTargetNetworks?: TargetNetworkSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export type DescribeConversionTaskList = ConversionTask[]; + export interface DescribeConversionTasksRequest { + /** + * The conversion task IDs. + */ + ConversionTaskIds?: ConversionIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeConversionTasksResult { + /** + * Information about the conversion tasks. + */ + ConversionTasks?: DescribeConversionTaskList; + } + export interface DescribeCustomerGatewaysRequest { + /** + * One or more customer gateway IDs. Default: Describes all your customer gateways. + */ + CustomerGatewayIds?: CustomerGatewayIdStringList; + /** + * One or more filters. bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). customer-gateway-id - The ID of the customer gateway. ip-address - The IP address of the customer gateway's Internet-routable external interface. state - The state of the customer gateway (pending | available | deleting | deleted). type - The type of customer gateway. Currently, the only supported type is ipsec.1. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeCustomerGatewaysResult { + /** + * Information about one or more customer gateways. + */ + CustomerGateways?: CustomerGatewayList; + } + export interface DescribeDhcpOptionsRequest { + /** + * The IDs of one or more DHCP options sets. Default: Describes all your DHCP options sets. + */ + DhcpOptionsIds?: DhcpOptionsIdStringList; + /** + * One or more filters. dhcp-options-id - The ID of a DHCP options set. key - The key for one of the options (for example, domain-name). value - The value for one of the options. owner-id - The ID of the AWS account that owns the DHCP options set. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeDhcpOptionsResult { + /** + * Information about one or more DHCP options sets. + */ + DhcpOptions?: DhcpOptionsList; + } + export interface DescribeEgressOnlyInternetGatewaysRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more egress-only internet gateway IDs. + */ + EgressOnlyInternetGatewayIds?: EgressOnlyInternetGatewayIdList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next page of results. + */ + NextToken?: String; + } + export interface DescribeEgressOnlyInternetGatewaysResult { + /** + * Information about the egress-only internet gateways. + */ + EgressOnlyInternetGateways?: EgressOnlyInternetGatewayList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeElasticGpusRequest { + /** + * The Elastic Graphics accelerator IDs. + */ + ElasticGpuIds?: ElasticGpuIdSet; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The filters. availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides. elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED). elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED). elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium. instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated. + */ + Filters?: FilterList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. + */ + MaxResults?: Integer; + /** + * The token to request the next page of results. + */ + NextToken?: String; + } + export interface DescribeElasticGpusResult { + /** + * Information about the Elastic Graphics accelerators. + */ + ElasticGpuSet?: ElasticGpuSet; + /** + * The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination. + */ + MaxResults?: Integer; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeExportTasksRequest { + /** + * The export task IDs. + */ + ExportTaskIds?: ExportTaskIdStringList; + } + export interface DescribeExportTasksResult { + /** + * Information about the export tasks. + */ + ExportTasks?: ExportTaskList; + } + export interface DescribeFleetError { + /** + * The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template. + */ + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; + /** + * Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance. + */ + Lifecycle?: InstanceLifecycle; + /** + * The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes. + */ + ErrorCode?: String; + /** + * The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes. + */ + ErrorMessage?: String; + } + export interface DescribeFleetHistoryRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The type of events to describe. By default, all events are described. + */ + EventType?: FleetEventType; + /** + * The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The ID of the EC2 Fleet. + */ + FleetId: FleetIdentifier; + /** + * The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + StartTime: DateTime; + } + export interface DescribeFleetHistoryResult { + /** + * Information about the events in the history of the EC2 Fleet. + */ + HistoryRecords?: HistoryRecordSet; + /** + * The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. If nextToken indicates that there are more results, this value is not present. + */ + LastEvaluatedTime?: DateTime; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The ID of the EC Fleet. + */ + FleetId?: FleetIdentifier; + /** + * The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + StartTime?: DateTime; + } + export interface DescribeFleetInstancesRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The ID of the EC2 Fleet. + */ + FleetId: FleetIdentifier; + /** + * The filters. instance-type - The instance type. + */ + Filters?: FilterList; + } + export interface DescribeFleetInstancesResult { + /** + * The running instances. This list is refreshed periodically and might be out of date. + */ + ActiveInstances?: ActiveInstanceSet; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The ID of the EC2 Fleet. + */ + FleetId?: FleetIdentifier; + } + export type DescribeFleetsErrorSet = DescribeFleetError[]; + export interface DescribeFleetsInstances { + /** + * The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template. + */ + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; + /** + * Indicates if the instance that was launched is a Spot Instance or On-Demand Instance. + */ + Lifecycle?: InstanceLifecycle; + /** + * The IDs of the instances. + */ + InstanceIds?: InstanceIdsSet; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The value is Windows for Windows instances; otherwise blank. + */ + Platform?: PlatformValues; + } + export type DescribeFleetsInstancesSet = DescribeFleetsInstances[]; + export interface DescribeFleetsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The ID of the EC2 Fleets. + */ + FleetIds?: FleetIdSet; + /** + * The filters. activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled). excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false). fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying). replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false). type - The type of request (instant | request | maintain). + */ + Filters?: FilterList; + } + export interface DescribeFleetsResult { + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * Information about the EC2 Fleets. + */ + Fleets?: FleetSet; + } + export interface DescribeFlowLogsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more filters. deliver-log-status - The status of the logs delivery (SUCCESS | FAILED). log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and S3. flow-log-id - The ID of the flow log. log-group-name - The name of the log group. resource-id - The ID of the VPC, subnet, or network interface. traffic-type - The type of traffic (ACCEPT | REJECT | ALL). + */ + Filter?: FilterList; + /** + * One or more flow log IDs. + */ + FlowLogIds?: ValueStringList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next page of results. + */ + NextToken?: String; + } + export interface DescribeFlowLogsResult { + /** + * Information about the flow logs. + */ + FlowLogs?: FlowLogSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeFpgaImageAttributeRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the AFI. + */ + FpgaImageId: String; + /** + * The AFI attribute. + */ + Attribute: FpgaImageAttributeName; + } + export interface DescribeFpgaImageAttributeResult { + /** + * Information about the attribute. + */ + FpgaImageAttribute?: FpgaImageAttribute; + } + export interface DescribeFpgaImagesRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The AFI IDs. + */ + FpgaImageIds?: FpgaImageIdList; + /** + * Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace). + */ + Owners?: OwnerStringList; + /** + * The filters. create-time - The creation time of the AFI. fpga-image-id - The FPGA image identifier (AFI ID). fpga-image-global-id - The global FPGA image identifier (AGFI ID). name - The name of the AFI. owner-id - The AWS account ID of the AFI owner. product-code - The product code. shell-version - The version of the AWS Shell that was used to create the bitstream. state - The state of the AFI (pending | failed | available | unavailable). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. update-time - The time of the most recent update. + */ + Filters?: FilterList; + /** + * The token to retrieve the next page of results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface DescribeFpgaImagesResult { + /** + * Information about the FPGA images. + */ + FpgaImages?: FpgaImageList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface DescribeHostReservationOfferingsRequest { + /** + * The filters. instance-family - The instance family of the offering (for example, m4). payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront). + */ + Filter?: FilterList; + /** + * This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years. + */ + MaxDuration?: Integer; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error. + */ + MaxResults?: DescribeHostReservationsMaxResults; + /** + * This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year. + */ + MinDuration?: Integer; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + /** + * The ID of the reservation offering. + */ + OfferingId?: String; + } + export interface DescribeHostReservationOfferingsResult { + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * Information about the offerings. + */ + OfferingSet?: HostOfferingSet; + } + export type DescribeHostReservationsMaxResults = number; + export interface DescribeHostReservationsRequest { + /** + * The filters. instance-family - The instance family (for example, m4). payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront). state - The state of the reservation (payment-pending | payment-failed | active | retired). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filter?: FilterList; + /** + * The host reservation IDs. + */ + HostReservationIdSet?: HostReservationIdSet; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error. + */ + MaxResults?: Integer; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeHostReservationsResult { + /** + * Details about the reservation's configuration. + */ + HostReservationSet?: HostReservationSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeHostsRequest { + /** + * The filters. auto-placement - Whether auto-placement is enabled or disabled (on | off). availability-zone - The Availability Zone of the host. client-token - The idempotency token that you provided when you allocated the host. host-reservation-id - The ID of the reservation assigned to this host. instance-type - The instance type size that the Dedicated Host is configured to support. state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure). tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filter?: FilterList; + /** + * The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches. + */ + HostIds?: RequestHostIdList; + /** + * The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error. You cannot specify this parameter and the host IDs parameter in the same request. + */ + MaxResults?: Integer; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeHostsResult { + /** + * Information about the Dedicated Hosts. + */ + Hosts?: HostList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeIamInstanceProfileAssociationsRequest { + /** + * The IAM instance profile associations. + */ + AssociationIds?: AssociationIdList; + /** + * The filters. instance-id - The ID of the instance. state - The state of the association (associating | associated | disassociating | disassociated). + */ + Filters?: FilterList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: MaxResults; + /** + * The token to request the next page of results. + */ + NextToken?: NextToken; + } + export interface DescribeIamInstanceProfileAssociationsResult { + /** + * Information about the IAM instance profile associations. + */ + IamInstanceProfileAssociations?: IamInstanceProfileAssociationSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface DescribeIdFormatRequest { + /** + * The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway + */ + Resource?: String; + } + export interface DescribeIdFormatResult { + /** + * Information about the ID format for the resource. + */ + Statuses?: IdFormatList; + } + export interface DescribeIdentityIdFormatRequest { + /** + * The ARN of the principal, which can be an IAM role, IAM user, or the root user. + */ + PrincipalArn: String; + /** + * The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway + */ + Resource?: String; + } + export interface DescribeIdentityIdFormatResult { + /** + * Information about the ID format for the resources. + */ + Statuses?: IdFormatList; + } + export interface DescribeImageAttributeRequest { + /** + * The AMI attribute. Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI. + */ + Attribute: ImageAttributeName; + /** + * The ID of the AMI. + */ + ImageId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeImagesRequest { + /** + * Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs). + */ + ExecutableUsers?: ExecutableByStringList; + /** + * The filters. architecture - The image architecture (i386 | x86_64). block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume. block-device-mapping.volume-size - The volume size of the EBS volume, in GiB. block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard). block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted. description - The description of the image (provided during image creation). ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. hypervisor - The hypervisor type (ovm | xen). image-id - The ID of the image. image-type - The image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether the image is public. kernel-id - The kernel ID. manifest-location - The location of the image manifest. name - The name of the AMI (provided during image creation). owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console. owner-id - The AWS account ID of the image owner. platform - The platform. To only list Windows-based AMIs, use windows. product-code - The product code. product-code.type - The type of the product code (devpay | marketplace). ramdisk-id - The RAM disk ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). state - The state of the image (available | pending | failed). state-reason-code - The reason code for the state change. state-reason-message - The message for the state change. sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. virtualization-type - The virtualization type (paravirtual | hvm). + */ + Filters?: FilterList; + /** + * The image IDs. Default: Describes all images available to you. + */ + ImageIds?: ImageIdStringList; + /** + * Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership. + */ + Owners?: OwnerStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeImagesResult { + /** + * Information about the images. + */ + Images?: ImageList; + } + export interface DescribeImportImageTasksRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted. + */ + Filters?: FilterList; + /** + * A list of import image task IDs. + */ + ImportTaskIds?: ImportTaskIdList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * A token that indicates the next page of results. + */ + NextToken?: String; + } + export interface DescribeImportImageTasksResult { + /** + * A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days. + */ + ImportImageTasks?: ImportImageTaskList; + /** + * The token to use to get the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeImportSnapshotTasksRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The filters. + */ + Filters?: FilterList; + /** + * A list of import snapshot task IDs. + */ + ImportTaskIds?: ImportTaskIdList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * A token that indicates the next page of results. + */ + NextToken?: String; + } + export interface DescribeImportSnapshotTasksResult { + /** + * A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days. + */ + ImportSnapshotTasks?: ImportSnapshotTaskList; + /** + * The token to use to get the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeInstanceAttributeRequest { + /** + * The instance attribute. Note: The enaSupport attribute is not supported at this time. + */ + Attribute: InstanceAttributeName; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance. + */ + InstanceId: String; + } + export type DescribeInstanceCreditSpecificationsMaxResults = number; + export interface DescribeInstanceCreditSpecificationsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The filters. instance-id - The ID of the instance. + */ + Filters?: FilterList; + /** + * The instance IDs. Default: Describes all your instances. Constraints: Maximum 1000 explicitly specified instance IDs. + */ + InstanceIds?: InstanceIdStringList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. + */ + MaxResults?: DescribeInstanceCreditSpecificationsMaxResults; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeInstanceCreditSpecificationsResult { + /** + * Information about the credit option for CPU usage of an instance. + */ + InstanceCreditSpecifications?: InstanceCreditSpecificationList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeInstanceStatusRequest { + /** + * The filters. availability-zone - The Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). + */ + Filters?: FilterList; + /** + * The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. + */ + InstanceIds?: InstanceIdStringList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. + */ + MaxResults?: Integer; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * When true, includes the health status for all instances. When false, includes the health status for running instances only. Default: false + */ + IncludeAllInstances?: Boolean; + } + export interface DescribeInstanceStatusResult { + /** + * Information about the status of the instances. + */ + InstanceStatuses?: InstanceStatusList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeInstancesRequest { + /** + * The filters. affinity - The affinity setting for an instance running on a Dedicated Host (default | host). architecture - The instance architecture (i386 | x86_64). availability-zone - The Availability Zone of the instance. block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z. block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached). block-device-mapping.volume-id - The volume ID of the EBS volume. client-token - The idempotency token you provided when you launched the instance. dns-name - The public DNS name of the instance. group-id - The ID of the security group for the instance. EC2-Classic only. group-name - The name of the security group for the instance. EC2-Classic only. hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation. host-id - The ID of the Dedicated Host on which the instance is running, if applicable. hypervisor - The hypervisor type of the instance (ovm | xen). iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN. image-id - The ID of the image used to launch the instance. instance-id - The ID of the instance. instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled). instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-type - The type of instance (for example, t2.micro). instance.group-id - The ID of the security group for the instance. instance.group-name - The name of the security group for the instance. ip-address - The public IPv4 address of the instance. kernel-id - The kernel ID. key-name - The name of the key pair used when the instance was launched. launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). launch-time - The time when the instance was launched. monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled). network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface. network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface. network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface. network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface. network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface. network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address. network-interface.attachment.attachment-id - The ID of the interface attachment. network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached. network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. network-interface.attachment.device-index - The device index to which the network interface is attached. network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached). network-interface.attachment.attach-time - The time that the network interface was attached to an instance. network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated. network-interface.availability-zone - The Availability Zone for the network interface. network-interface.description - The description of the network interface. network-interface.group-id - The ID of a security group associated with the network interface. network-interface.group-name - The name of a security group associated with the network interface. network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface. network-interface.mac-address - The MAC address of the network interface. network-interface.network-interface-id - The ID of the network interface. network-interface.owner-id - The ID of the owner of the network interface. network-interface.private-dns-name - The private DNS name of the network interface. network-interface.requester-id - The requester ID for the network interface. network-interface.requester-managed - Indicates whether the network interface is being managed by AWS. network-interface.status - The status of the network interface (available) | in-use). network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC. network-interface.subnet-id - The ID of the subnet for the network interface. network-interface.vpc-id - The ID of the VPC for the network interface. owner-id - The AWS account ID of the instance owner. placement-group-name - The name of the placement group for the instance. placement-partition-number - The partition in which the instance is located. platform - The platform. To list only Windows instances, use windows. private-dns-name - The private IPv4 DNS name of the instance. private-ip-address - The private IPv4 address of the instance. product-code - The product code associated with the AMI used to launch the instance. product-code.type - The type of product code (devpay | marketplace). ramdisk-id - The RAM disk ID. reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC. spot-instance-request-id - The ID of the Spot Instance request. state-reason-code - The reason code for the state change. state-reason-message - A message that describes the state change. subnet-id - The ID of the subnet for the instance. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. tenancy - The tenancy of an instance (dedicated | default | host). virtualization-type - The virtualization type of the instance (paravirtual | hvm). vpc-id - The ID of the VPC that the instance is running in. + */ + Filters?: FilterList; + /** + * The instance IDs. Default: Describes all your instances. + */ + InstanceIds?: InstanceIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. + */ + MaxResults?: Integer; + /** + * The token to request the next page of results. + */ + NextToken?: String; + } + export interface DescribeInstancesResult { + /** + * Information about the reservations. + */ + Reservations?: ReservationList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export type DescribeInternetGatewaysMaxResults = number; + export interface DescribeInternetGatewaysRequest { + /** + * One or more filters. attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached. attachment.vpc-id - The ID of an attached VPC. internet-gateway-id - The ID of the Internet gateway. owner-id - The ID of the AWS account that owns the internet gateway. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more internet gateway IDs. Default: Describes all your internet gateways. + */ + InternetGatewayIds?: ValueStringList; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: DescribeInternetGatewaysMaxResults; + } + export interface DescribeInternetGatewaysResult { + /** + * Information about one or more internet gateways. + */ + InternetGateways?: InternetGatewayList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeKeyPairsRequest { + /** + * The filters. fingerprint - The fingerprint of the key pair. key-name - The name of the key pair. + */ + Filters?: FilterList; + /** + * The key pair names. Default: Describes all your key pairs. + */ + KeyNames?: KeyNameStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeKeyPairsResult { + /** + * Information about the key pairs. + */ + KeyPairs?: KeyPairList; + } + export interface DescribeLaunchTemplateVersionsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * One or more versions of the launch template. + */ + Versions?: VersionStringList; + /** + * The version number after which to describe launch template versions. + */ + MinVersion?: String; + /** + * The version number up to which to describe launch template versions. + */ + MaxVersion?: String; + /** + * The token to request the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. + */ + MaxResults?: Integer; + /** + * One or more filters. create-time - The time the launch template version was created. ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O. iam-instance-profile - The ARN of the IAM instance profile. image-id - The ID of the AMI. instance-type - The instance type. is-default-version - A boolean that indicates whether the launch template version is the default version. kernel-id - The kernel ID. ram-disk-id - The RAM disk ID. + */ + Filters?: FilterList; + } + export interface DescribeLaunchTemplateVersionsResult { + /** + * Information about the launch template versions. + */ + LaunchTemplateVersions?: LaunchTemplateVersionSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeLaunchTemplatesRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more launch template IDs. + */ + LaunchTemplateIds?: ValueStringList; + /** + * One or more launch template names. + */ + LaunchTemplateNames?: LaunchTemplateNameStringList; + /** + * One or more filters. create-time - The time the launch template was created. launch-template-name - The name of the launch template. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filters?: FilterList; + /** + * The token to request the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. + */ + MaxResults?: Integer; + } + export interface DescribeLaunchTemplatesResult { + /** + * Information about the launch templates. + */ + LaunchTemplates?: LaunchTemplateSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeMovingAddressesRequest { + /** + * One or more filters. moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic). + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned. Default: If no value is provided, the default is 1000. + */ + MaxResults?: Integer; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * One or more Elastic IP addresses. + */ + PublicIps?: ValueStringList; + } + export interface DescribeMovingAddressesResult { + /** + * The status for each Elastic IP address. + */ + MovingAddressStatuses?: MovingAddressStatusSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeNatGatewaysRequest { + /** + * One or more filters. nat-gateway-id - The ID of the NAT gateway. state - The state of the NAT gateway (pending | failed | available | deleting | deleted). subnet-id - The ID of the subnet in which the NAT gateway resides. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC in which the NAT gateway resides. + */ + Filter?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: Integer; + /** + * One or more NAT gateway IDs. + */ + NatGatewayIds?: ValueStringList; + /** + * The token for the next page of results. + */ + NextToken?: String; + } + export interface DescribeNatGatewaysResult { + /** + * Information about the NAT gateways. + */ + NatGateways?: NatGatewayList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export type DescribeNetworkAclsMaxResults = number; + export interface DescribeNetworkAclsRequest { + /** + * One or more filters. association.association-id - The ID of an association ID for the ACL. association.network-acl-id - The ID of the network ACL involved in the association. association.subnet-id - The ID of the subnet involved in the association. default - Indicates whether the ACL is the default network ACL for the VPC. entry.cidr - The IPv4 CIDR range specified in the entry. entry.icmp.code - The ICMP code specified in the entry, if any. entry.icmp.type - The ICMP type specified in the entry, if any. entry.ipv6-cidr - The IPv6 CIDR range specified in the entry. entry.port-range.from - The start of the port range specified in the entry. entry.port-range.to - The end of the port range specified in the entry. entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number). entry.rule-action - Allows or denies the matching traffic (allow | deny). entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries. network-acl-id - The ID of the network ACL. owner-id - The ID of the AWS account that owns the network ACL. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the network ACL. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more network ACL IDs. Default: Describes all your network ACLs. + */ + NetworkAclIds?: ValueStringList; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: DescribeNetworkAclsMaxResults; + } + export interface DescribeNetworkAclsResult { + /** + * Information about one or more network ACLs. + */ + NetworkAcls?: NetworkAclList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeNetworkInterfaceAttributeRequest { + /** + * The attribute of the network interface. This parameter is required. + */ + Attribute?: NetworkInterfaceAttribute; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + } + export interface DescribeNetworkInterfaceAttributeResult { + /** + * The attachment (if any) of the network interface. + */ + Attachment?: NetworkInterfaceAttachment; + /** + * The description of the network interface. + */ + Description?: AttributeValue; + /** + * The security groups associated with the network interface. + */ + Groups?: GroupIdentifierList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * Indicates whether source/destination checking is enabled. + */ + SourceDestCheck?: AttributeBooleanValue; + } + export interface DescribeNetworkInterfacePermissionsRequest { + /** + * One or more network interface permission IDs. + */ + NetworkInterfacePermissionIds?: NetworkInterfacePermissionIdList; + /** + * One or more filters. network-interface-permission.network-interface-permission-id - The ID of the permission. network-interface-permission.network-interface-id - The ID of the network interface. network-interface-permission.aws-account-id - The AWS account ID. network-interface-permission.aws-service - The AWS service. network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE). + */ + Filters?: FilterList; + /** + * The token to request the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default. + */ + MaxResults?: Integer; + } + export interface DescribeNetworkInterfacePermissionsResult { + /** + * The network interface permissions. + */ + NetworkInterfacePermissions?: NetworkInterfacePermissionList; + /** + * The token to use to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeNetworkInterfacesRequest { + /** + * One or more filters. addresses.private-ip-address - The private IPv4 addresses associated with the network interface. addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface. addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4). addresses.association.owner-id - The owner ID of the addresses associated with the network interface. association.association-id - The association ID returned when the network interface was associated with an IPv4 address. association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface. association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface. association.public-dns-name - The public DNS name for the network interface (IPv4). attachment.attachment-id - The ID of the interface attachment. attachment.attach.time - The time that the network interface was attached to an instance. attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated. attachment.device-index - The device index to which the network interface is attached. attachment.instance-id - The ID of the instance to which the network interface is attached. attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached. attachment.status - The status of the attachment (attaching | attached | detaching | detached). availability-zone - The Availability Zone of the network interface. description - The description of the network interface. group-id - The ID of a security group associated with the network interface. group-name - The name of a security group associated with the network interface. ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface. mac-address - The MAC address of the network interface. network-interface-id - The ID of the network interface. owner-id - The AWS account ID of the network interface owner. private-ip-address - The private IPv4 address or addresses of the network interface. private-dns-name - The private DNS name of the network interface (IPv4). requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on). source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC. status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use. subnet-id - The ID of the subnet for the network interface. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the network interface. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more network interface IDs. Default: Describes all your network interfaces. + */ + NetworkInterfaceIds?: NetworkInterfaceIdList; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + /** + * The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: Integer; + } + export interface DescribeNetworkInterfacesResult { + /** + * Information about one or more network interfaces. + */ + NetworkInterfaces?: NetworkInterfaceList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribePlacementGroupsRequest { + /** + * The filters. group-name - The name of the placement group. state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition). + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The names of the placement groups. Default: Describes all your placement groups, or only those otherwise specified. + */ + GroupNames?: PlacementGroupStringList; + } + export interface DescribePlacementGroupsResult { + /** + * Information about the placement groups. + */ + PlacementGroups?: PlacementGroupList; + } + export interface DescribePrefixListsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more filters. prefix-list-id: The ID of a prefix list. prefix-list-name: The name of a prefix list. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * One or more prefix list IDs. + */ + PrefixListIds?: ValueStringList; + } + export interface DescribePrefixListsResult { + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * All available prefix lists. + */ + PrefixLists?: PrefixListSet; + } + export interface DescribePrincipalIdFormatRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway + */ + Resources?: ResourceList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token to request the next page of results. + */ + NextToken?: String; + } + export interface DescribePrincipalIdFormatResult { + /** + * Information about the ID format settings for the ARN. + */ + Principals?: PrincipalIdFormatList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribePublicIpv4PoolsRequest { + /** + * The IDs of the address pools. + */ + PoolIds?: ValueStringList; + /** + * The token for the next page of results. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: PoolMaxResults; + } + export interface DescribePublicIpv4PoolsResult { + /** + * Information about the address pools. + */ + PublicIpv4Pools?: PublicIpv4PoolSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeRegionsRequest { + /** + * The filters. endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com). region-name - The name of the region (for example, us-east-1). + */ + Filters?: FilterList; + /** + * The names of the regions. + */ + RegionNames?: RegionNameStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeRegionsResult { + /** + * Information about the regions. + */ + Regions?: RegionList; + } + export interface DescribeReservedInstancesListingsRequest { + /** + * One or more filters. reserved-instances-id - The ID of the Reserved Instances. reserved-instances-listing-id - The ID of the Reserved Instances listing. status - The status of the Reserved Instance listing (pending | active | cancelled | closed). status-message - The reason for the status. + */ + Filters?: FilterList; + /** + * One or more Reserved Instance IDs. + */ + ReservedInstancesId?: String; + /** + * One or more Reserved Instance listing IDs. + */ + ReservedInstancesListingId?: String; + } + export interface DescribeReservedInstancesListingsResult { + /** + * Information about the Reserved Instance listing. + */ + ReservedInstancesListings?: ReservedInstancesListingList; + } + export interface DescribeReservedInstancesModificationsRequest { + /** + * One or more filters. client-token - The idempotency token for the modification request. create-date - The time when the modification request was created. effective-date - The time when the modification becomes effective. modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled. modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances. modification-result.target-configuration.instance-count - The number of new Reserved Instances. modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances. modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC). reserved-instances-id - The ID of the Reserved Instances modified. reserved-instances-modification-id - The ID of the modification request. status - The status of the Reserved Instances modification request (processing | fulfilled | failed). status-message - The reason for the status. update-date - The time when the modification request was last updated. + */ + Filters?: FilterList; + /** + * IDs for the submitted modification request. + */ + ReservedInstancesModificationIds?: ReservedInstancesModificationIdStringList; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeReservedInstancesModificationsResult { + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * The Reserved Instance modification information. + */ + ReservedInstancesModifications?: ReservedInstancesModificationList; + } + export interface DescribeReservedInstancesOfferingsRequest { + /** + * The Availability Zone in which the Reserved Instance can be used. + */ + AvailabilityZone?: String; + /** + * One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000). fixed-price - The purchase price of the Reserved Instance (for example, 9800.0). instance-type - The instance type that is covered by the reservation. marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed. product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)) reserved-instances-offering-id - The Reserved Instances offering ID. scope - The scope of the Reserved Instance (Availability Zone or Region). usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84). + */ + Filters?: FilterList; + /** + * Include Reserved Instance Marketplace offerings in the response. + */ + IncludeMarketplace?: Boolean; + /** + * The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. + */ + InstanceType?: InstanceType; + /** + * The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years) + */ + MaxDuration?: Long; + /** + * The maximum number of instances to filter when searching for offerings. Default: 20 + */ + MaxInstanceCount?: Integer; + /** + * The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month) + */ + MinDuration?: Long; + /** + * The offering class of the Reserved Instance. Can be standard or convertible. + */ + OfferingClass?: OfferingClassType; + /** + * The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC. + */ + ProductDescription?: RIProductDescription; + /** + * One or more Reserved Instances offering IDs. + */ + ReservedInstancesOfferingIds?: ReservedInstancesOfferingIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances). Important: The host value cannot be used with this parameter. Use the default or dedicated values only. Default: default + */ + InstanceTenancy?: Tenancy; + /** + * The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100. Default: 100 + */ + MaxResults?: Integer; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + /** + * The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type. + */ + OfferingType?: OfferingTypeValues; + } + export interface DescribeReservedInstancesOfferingsResult { + /** + * A list of Reserved Instances offerings. + */ + ReservedInstancesOfferings?: ReservedInstancesOfferingList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeReservedInstancesRequest { + /** + * One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000). end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). fixed-price - The purchase price of the Reserved Instance (for example, 9800.0). instance-type - The instance type that is covered by the reservation. scope - The scope of the Reserved Instance (Region or Availability Zone). product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)). reserved-instances-id - The ID of the Reserved Instance. start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84). + */ + Filters?: FilterList; + /** + * Describes whether the Reserved Instance is Standard or Convertible. + */ + OfferingClass?: OfferingClassType; + /** + * One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified. + */ + ReservedInstancesIds?: ReservedInstancesIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type. + */ + OfferingType?: OfferingTypeValues; + } + export interface DescribeReservedInstancesResult { + /** + * A list of Reserved Instances. + */ + ReservedInstances?: ReservedInstancesList; + } + export interface DescribeRouteTablesRequest { + /** + * One or more filters. association.route-table-association-id - The ID of an association ID for the route table. association.route-table-id - The ID of the route table involved in the association. association.subnet-id - The ID of the subnet involved in the association. association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response. owner-id - The ID of the AWS account that owns the route table. route-table-id - The ID of the route table. route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table. route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table. route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table. route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table. route.gateway-id - The ID of a gateway specified in a route in the table. route.instance-id - The ID of an instance specified in a route in the table. route.nat-gateway-id - The ID of a NAT gateway. route.transit-gateway-id - The ID of a transit gateway. route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation. route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. transit-gateway-id - The ID of a transit gateway. vpc-id - The ID of the VPC for the route table. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more route table IDs. Default: Describes all your route tables. + */ + RouteTableIds?: ValueStringList; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: Integer; + } + export interface DescribeRouteTablesResult { + /** + * Information about one or more route tables. + */ + RouteTables?: RouteTableList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeScheduledInstanceAvailabilityRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The filters. availability-zone - The Availability Zone (for example, us-west-2a). instance-type - The instance type (for example, c4.large). network-platform - The network platform (EC2-Classic or EC2-VPC). platform - The platform (Linux/UNIX or Windows). + */ + Filters?: FilterList; + /** + * The time period for the first schedule to start. + */ + FirstSlotStartTimeRange: SlotDateTimeRangeRequest; + /** + * The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720. + */ + MaxSlotDurationInHours?: Integer; + /** + * The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. + */ + MinSlotDurationInHours?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The schedule recurrence. + */ + Recurrence: ScheduledInstanceRecurrenceRequest; + } + export interface DescribeScheduledInstanceAvailabilityResult { + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * Information about the available Scheduled Instances. + */ + ScheduledInstanceAvailabilitySet?: ScheduledInstanceAvailabilitySet; + } + export interface DescribeScheduledInstancesRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The filters. availability-zone - The Availability Zone (for example, us-west-2a). instance-type - The instance type (for example, c4.large). network-platform - The network platform (EC2-Classic or EC2-VPC). platform - The platform (Linux/UNIX or Windows). + */ + Filters?: FilterList; + /** + * The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The Scheduled Instance IDs. + */ + ScheduledInstanceIds?: ScheduledInstanceIdRequestSet; + /** + * The time period for the first schedule to start. + */ + SlotStartTimeRange?: SlotStartTimeRangeRequest; + } + export interface DescribeScheduledInstancesResult { + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * Information about the Scheduled Instances. + */ + ScheduledInstanceSet?: ScheduledInstanceSet; + } + export interface DescribeSecurityGroupReferencesRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the security groups in your account. + */ + GroupId: GroupIds; + } + export interface DescribeSecurityGroupReferencesResult { + /** + * Information about the VPCs with the referencing security groups. + */ + SecurityGroupReferenceSet?: SecurityGroupReferences; + } + export interface DescribeSecurityGroupsRequest { + /** + * The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters. description - The description of the security group. egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule. egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule. egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule. egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule. egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which a security group rule allows outbound access. egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number). egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule. group-id - The ID of the security group. group-name - The name of the security group. ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule. ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule. ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule. ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule. ip-permission.prefix-list-id - The ID (prefix) of the AWS service from which a security group rule allows inbound access. ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number). ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule. owner-id - The AWS account ID of the owner of the security group. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC specified when the security group was created. + */ + Filters?: FilterList; + /** + * The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all your security groups. + */ + GroupIds?: GroupIdStringList; + /** + * [EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name. Default: Describes all your security groups. + */ + GroupNames?: GroupNameStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The token to request the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned. + */ + MaxResults?: Integer; + } + export interface DescribeSecurityGroupsResult { + /** + * Information about the security groups. + */ + SecurityGroups?: SecurityGroupList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeSnapshotAttributeRequest { + /** + * The snapshot attribute you would like to view. + */ + Attribute: SnapshotAttributeName; + /** + * The ID of the EBS snapshot. + */ + SnapshotId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeSnapshotAttributeResult { + /** + * The users and groups that have the permissions for creating volumes from the snapshot. + */ + CreateVolumePermissions?: CreateVolumePermissionList; + /** + * The product codes. + */ + ProductCodes?: ProductCodeList; + /** + * The ID of the EBS snapshot. + */ + SnapshotId?: String; + } + export interface DescribeSnapshotsRequest { + /** + * The filters. description - A description of the snapshot. encrypted - Indicates whether the snapshot is encrypted (true | false) owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console. owner-id - The ID of the AWS account that owns the snapshot. progress - The progress of the snapshot, as a percentage (for example, 80%). snapshot-id - The snapshot ID. start-time - The time stamp when the snapshot was initiated. status - The status of the snapshot (pending | completed | error). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. volume-id - The ID of the volume the snapshot is for. volume-size - The size of the volume, in GiB. + */ + Filters?: FilterList; + /** + * The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request. + */ + MaxResults?: Integer; + /** + * The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * Describes the snapshots owned by these owners. + */ + OwnerIds?: OwnerStringList; + /** + * The IDs of the AWS accounts that can create volumes from the snapshot. + */ + RestorableByUserIds?: RestorableByStringList; + /** + * The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions. + */ + SnapshotIds?: SnapshotIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeSnapshotsResult { + /** + * Information about the snapshots. + */ + Snapshots?: SnapshotList; + /** + * The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeSpotDatafeedSubscriptionRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeSpotDatafeedSubscriptionResult { + /** + * The Spot Instance data feed subscription. + */ + SpotDatafeedSubscription?: SpotDatafeedSubscription; + } + export interface DescribeSpotFleetInstancesRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId: String; + } + export interface DescribeSpotFleetInstancesResponse { + /** + * The running instances. This list is refreshed periodically and might be out of date. + */ + ActiveInstances?: ActiveInstanceSet; + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId?: String; + } + export interface DescribeSpotFleetRequestHistoryRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The type of events to describe. By default, all events are described. + */ + EventType?: EventType; + /** + * The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId: String; + /** + * The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + StartTime: DateTime; + } + export interface DescribeSpotFleetRequestHistoryResponse { + /** + * Information about the events in the history of the Spot Fleet request. + */ + HistoryRecords?: HistoryRecords; + /** + * The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. If nextToken indicates that there are more results, this value is not present. + */ + LastEvaluatedTime?: DateTime; + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId?: String; + /** + * The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + StartTime?: DateTime; + } + export interface DescribeSpotFleetRequestsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * The IDs of the Spot Fleet requests. + */ + SpotFleetRequestIds?: ValueStringList; + } + export interface DescribeSpotFleetRequestsResponse { + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * Information about the configuration of your Spot Fleet. + */ + SpotFleetRequestConfigs?: SpotFleetRequestConfigSet; + } + export interface DescribeSpotInstanceRequestsRequest { + /** + * One or more filters. availability-zone-group - The Availability Zone group. create-time - The time stamp when the Spot Instance request was created. fault-code - The fault code related to the request. fault-message - The fault message related to the request. instance-id - The ID of the instance that fulfilled the request. launch-group - The Spot Instance launch group. launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination. launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh). launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume. launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB. launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic. launch.group-id - The ID of the security group for the instance. launch.group-name - The name of the security group for the instance. launch.image-id - The ID of the AMI. launch.instance-type - The type of instance (for example, m3.medium). launch.kernel-id - The kernel ID. launch.key-name - The name of the key pair the instance launched with. launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance. launch.ramdisk-id - The RAM disk ID. launched-availability-zone - The Availability Zone in which the request is launched. network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address. network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated. network-interface.description - A description of the network interface. network-interface.device-index - The index of the device for the network interface attachment on the instance. network-interface.group-id - The ID of the security group associated with the network interface. network-interface.network-interface-id - The ID of the network interface. network-interface.private-ip-address - The primary private IP address of the network interface. network-interface.subnet-id - The ID of the subnet for the instance. product-description - The product description associated with the instance (Linux/UNIX | Windows). spot-instance-request-id - The Spot Instance request ID. spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request. state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Request Status in the Amazon EC2 User Guide for Linux Instances. status-code - The short code describing the most recent evaluation of your Spot Instance request. status-message - The message explaining the status of the Spot Instance request. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. type - The type of Spot Instance request (one-time | persistent). valid-from - The start date of the request. valid-until - The end date of the request. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more Spot Instance request IDs. + */ + SpotInstanceRequestIds?: SpotInstanceRequestIdList; + /** + * The token to request the next set of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + } + export interface DescribeSpotInstanceRequestsResult { + /** + * One or more Spot Instance requests. + */ + SpotInstanceRequests?: SpotInstanceRequestList; + /** + * The token to use to retrieve the next set of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeSpotPriceHistoryRequest { + /** + * One or more filters. availability-zone - The Availability Zone for which prices should be returned. instance-type - The type of instance (for example, m3.medium). product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)). spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported). timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported. + */ + Filters?: FilterList; + /** + * Filters the results by the specified Availability Zone. + */ + AvailabilityZone?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + EndTime?: DateTime; + /** + * Filters the results by the specified instance types. + */ + InstanceTypes?: InstanceTypeList; + /** + * The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token for the next set of results. + */ + NextToken?: String; + /** + * Filters the results by the specified basic product descriptions. + */ + ProductDescriptions?: ProductDescriptionList; + /** + * The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + StartTime?: DateTime; + } + export interface DescribeSpotPriceHistoryResult { + /** + * The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return. + */ + NextToken?: String; + /** + * The historical Spot prices. + */ + SpotPriceHistory?: SpotPriceHistoryList; + } + export interface DescribeStaleSecurityGroupsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a prior call.) + */ + NextToken?: NextToken; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface DescribeStaleSecurityGroupsResult { + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: String; + /** + * Information about the stale security groups. + */ + StaleSecurityGroupSet?: StaleSecurityGroupSet; + } + export interface DescribeSubnetsRequest { + /** + * One or more filters. availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name. availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name. available-ip-address-count - The number of IPv4 addresses in the subnet that are available. cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names. default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name. ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet. ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet. ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet. owner-id - The ID of the AWS account that owns the subnet. state - The state of the subnet (pending | available). subnet-arn - The Amazon Resource Name (ARN) of the subnet. subnet-id - The ID of the subnet. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the subnet. + */ + Filters?: FilterList; + /** + * One or more subnet IDs. Default: Describes all your subnets. + */ + SubnetIds?: SubnetIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeSubnetsResult { + /** + * Information about one or more subnets. + */ + Subnets?: SubnetList; + } + export interface DescribeTagsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The filters. key - The tag key. resource-id - The ID of the resource. resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | image | instance | host-reservation | internet-gateway | launch-template | natgateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway). tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". value - The tag value. + */ + Filters?: FilterList; + /** + * The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeTagsResult { + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * The tags. + */ + Tags?: TagDescriptionList; + } + export interface DescribeTransitGatewayAttachmentsRequest { + /** + * The IDs of the attachments. + */ + TransitGatewayAttachmentIds?: TransitGatewayAttachmentIdStringList; + /** + * One or more filters. The possible values are: association.state - The state of the association (associating | associated | disassociating). association.transit-gateway-route-table-id - The ID of the route table for the transit gateway. resource-id - The ID of the resource. resource-owner-id - The ID of the AWS account that owns the resource. resource-type - The resource type (vpc | vpn). state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting). transit-gateway-attachment-id - The ID of the attachment. transit-gateway-id - The ID of the transit gateway. transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeTransitGatewayAttachmentsResult { + /** + * Information about the attachments. + */ + TransitGatewayAttachments?: TransitGatewayAttachmentList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeTransitGatewayRouteTablesRequest { + /** + * The IDs of the transit gateway route tables. + */ + TransitGatewayRouteTableIds?: TransitGatewayRouteTableIdStringList; + /** + * One or more filters. The possible values are: default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false). default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false). state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting). transit-gateway-id - The ID of the transit gateway. transit-gateway-route-table-id - The ID of the transit gateway route table. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeTransitGatewayRouteTablesResult { + /** + * Information about the transit gateway route tables. + */ + TransitGatewayRouteTables?: TransitGatewayRouteTableList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeTransitGatewayVpcAttachmentsRequest { + /** + * The IDs of the attachments. + */ + TransitGatewayAttachmentIds?: TransitGatewayAttachmentIdStringList; + /** + * One or more filters. The possible values are: state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting). transit-gateway-attachment-id - The ID of the attachment. transit-gateway-id - The ID of the transit gateway. vpc-id - The ID of the VPC. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeTransitGatewayVpcAttachmentsResult { + /** + * Information about the VPC attachments. + */ + TransitGatewayVpcAttachments?: TransitGatewayVpcAttachmentList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeTransitGatewaysRequest { + /** + * The IDs of the transit gateways. + */ + TransitGatewayIds?: TransitGatewayIdStringList; + /** + * One or more filters. The possible values are: options.propagation-default-route-table-id - The ID of the default propagation route table. options.amazon-side-asn - The private ASN for the Amazon side of a BGP session. options.association-default-route-table-id - The ID of the default association route table. options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable). options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable). options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable). options.dns-support - Indicates whether DNS support is enabled (enable | disable). options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable). owner-id - The ID of the AWS account that owns the transit gateway. state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting). transit-gateway-id - The ID of the transit gateway. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeTransitGatewaysResult { + /** + * Information about the transit gateways. + */ + TransitGateways?: TransitGatewayList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVolumeAttributeRequest { + /** + * The attribute of the volume. This parameter is required. + */ + Attribute: VolumeAttributeName; + /** + * The ID of the volume. + */ + VolumeId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeVolumeAttributeResult { + /** + * The state of autoEnableIO attribute. + */ + AutoEnableIO?: AttributeBooleanValue; + /** + * A list of product codes. + */ + ProductCodes?: ProductCodeList; + /** + * The ID of the volume. + */ + VolumeId?: String; + } + export interface DescribeVolumeStatusRequest { + /** + * The filters. action.code - The action code for the event (for example, enable-volume-io). action.description - A description of the action. action.event-id - The event ID associated with the action. availability-zone - The Availability Zone of the instance. event.description - A description of the event. event.event-id - The event ID. event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled). event.not-after - The latest end time for the event. event.not-before - The earliest start time for the event. volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance). volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled). volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data). + */ + Filters?: FilterList; + /** + * The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request. + */ + MaxResults?: Integer; + /** + * The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * The IDs of the volumes. Default: Describes all your volumes. + */ + VolumeIds?: VolumeIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeVolumeStatusResult { + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + /** + * Information about the status of the volumes. + */ + VolumeStatuses?: VolumeStatusList; + } + export interface DescribeVolumesModificationsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the volumes for which in-progress modifications will be described. + */ + VolumeIds?: VolumeIdStringList; + /** + * The filters. Supported filters: volume-id, modification-state, target-size, target-iops, target-volume-type, original-size, original-iops, original-volume-type, start-time. + */ + Filters?: FilterList; + /** + * The nextToken value returned by a previous paginated request. + */ + NextToken?: String; + /** + * The maximum number of results (up to a limit of 500) to be returned in a paginated request. + */ + MaxResults?: Integer; + } + export interface DescribeVolumesModificationsResult { + /** + * Information about the volume modifications. + */ + VolumesModifications?: VolumeModificationList; + /** + * Token for pagination, null if there are no more results + */ + NextToken?: String; + } + export interface DescribeVolumesRequest { + /** + * The filters. attachment.attach-time - The time stamp when the attachment initiated. attachment.delete-on-termination - Whether the volume is deleted on instance termination. attachment.device - The device name specified in the block device mapping (for example, /dev/sda1). attachment.instance-id - The ID of the instance the volume is attached to. attachment.status - The attachment state (attaching | attached | detaching). availability-zone - The Availability Zone in which the volume was created. create-time - The time stamp when the volume was created. encrypted - Indicates whether the volume is encrypted (true | false) size - The size of the volume, in GiB. snapshot-id - The snapshot from which the volume was created. status - The status of the volume (creating | available | in-use | deleting | deleted | error). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. volume-id - The volume ID. volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes. + */ + Filters?: FilterList; + /** + * The volume IDs. + */ + VolumeIds?: VolumeIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request. + */ + MaxResults?: Integer; + /** + * The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVolumesResult { + /** + * Information about the volumes. + */ + Volumes?: VolumeList; + /** + * The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVpcAttributeRequest { + /** + * The VPC attribute. + */ + Attribute: VpcAttributeName; + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeVpcAttributeResult { + /** + * The ID of the VPC. + */ + VpcId?: String; + /** + * Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not. + */ + EnableDnsHostnames?: AttributeBooleanValue; + /** + * Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not. + */ + EnableDnsSupport?: AttributeBooleanValue; + } + export interface DescribeVpcClassicLinkDnsSupportRequest { + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: MaxResults; + /** + * The token for the next page of results. + */ + NextToken?: NextToken; + /** + * One or more VPC IDs. + */ + VpcIds?: VpcClassicLinkIdList; + } + export interface DescribeVpcClassicLinkDnsSupportResult { + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: NextToken; + /** + * Information about the ClassicLink DNS support status of the VPCs. + */ + Vpcs?: ClassicLinkDnsSupportList; + } + export interface DescribeVpcClassicLinkRequest { + /** + * One or more filters. is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more VPCs for which you want to describe the ClassicLink status. + */ + VpcIds?: VpcClassicLinkIdList; + } + export interface DescribeVpcClassicLinkResult { + /** + * The ClassicLink status of one or more VPCs. + */ + Vpcs?: VpcClassicLinkList; + } + export interface DescribeVpcEndpointConnectionNotificationsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the notification. + */ + ConnectionNotificationId?: String; + /** + * One or more filters. connection-notification-arn - The ARN of SNS topic for the notification. connection-notification-id - The ID of the notification. connection-notification-state - The state of the notification (Enabled | Disabled). connection-notification-type - The type of notification (Topic). service-id - The ID of the endpoint service. vpc-endpoint-id - The ID of the VPC endpoint. + */ + Filters?: FilterList; + /** + * The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. + */ + MaxResults?: Integer; + /** + * The token to request the next page of results. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointConnectionNotificationsResult { + /** + * One or more notifications. + */ + ConnectionNotificationSet?: ConnectionNotificationSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointConnectionsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more filters. service-id - The ID of the service. vpc-endpoint-owner - The AWS account number of the owner of the endpoint. vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed). vpc-endpoint-id - The ID of the endpoint. + */ + Filters?: FilterList; + /** + * The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. + */ + MaxResults?: Integer; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointConnectionsResult { + /** + * Information about one or more VPC endpoint connections. + */ + VpcEndpointConnections?: VpcEndpointConnectionSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointServiceConfigurationsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of one or more services. + */ + ServiceIds?: ValueStringList; + /** + * One or more filters. service-name - The name of the service. service-id - The ID of the service. service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed). + */ + Filters?: FilterList; + /** + * The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. + */ + MaxResults?: Integer; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointServiceConfigurationsResult { + /** + * Information about one or more services. + */ + ServiceConfigurations?: ServiceConfigurationSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointServicePermissionsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the service. + */ + ServiceId: String; + /** + * One or more filters. principal - The ARN of the principal. principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role). + */ + Filters?: FilterList; + /** + * The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. + */ + MaxResults?: Integer; + /** + * The token to retrieve the next page of results. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointServicePermissionsResult { + /** + * Information about one or more allowed principals. + */ + AllowedPrincipals?: AllowedPrincipalSet; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointServicesRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more service names. + */ + ServiceNames?: ValueStringList; + /** + * One or more filters. service-name: The name of the service. + */ + Filters?: FilterList; + /** + * The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1000, we return only 1000 items. + */ + MaxResults?: Integer; + /** + * The token for the next set of items to return. (You received this token from a prior call.) + */ + NextToken?: String; + } + export interface DescribeVpcEndpointServicesResult { + /** + * A list of supported services. + */ + ServiceNames?: ValueStringList; + /** + * Information about the service. + */ + ServiceDetails?: ServiceDetailSet; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: String; + } + export interface DescribeVpcEndpointsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more endpoint IDs. + */ + VpcEndpointIds?: ValueStringList; + /** + * One or more filters. service-name: The name of the service. vpc-id: The ID of the VPC in which the endpoint resides. vpc-endpoint-id: The ID of the endpoint. vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted) + */ + Filters?: FilterList; + /** + * The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1000, we return only 1000 items. + */ + MaxResults?: Integer; + /** + * The token for the next set of items to return. (You received this token from a prior call.) + */ + NextToken?: String; + } + export interface DescribeVpcEndpointsResult { + /** + * Information about the endpoints. + */ + VpcEndpoints?: VpcEndpointSet; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: String; + } + export type DescribeVpcPeeringConnectionsMaxResults = number; + export interface DescribeVpcPeeringConnectionsRequest { + /** + * One or more filters. accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC. accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC. accepter-vpc-info.vpc-id - The ID of the accepter VPC. expiration-time - The expiration date and time for the VPC peering connection. requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC. requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC. requester-vpc-info.vpc-id - The ID of the requester VPC. status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected). status-message - A message that provides more information about the status of the VPC peering connection, if applicable. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-peering-connection-id - The ID of the VPC peering connection. + */ + Filters?: FilterList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * One or more VPC peering connection IDs. Default: Describes all your VPC peering connections. + */ + VpcPeeringConnectionIds?: ValueStringList; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: DescribeVpcPeeringConnectionsMaxResults; + } + export interface DescribeVpcPeeringConnectionsResult { + /** + * Information about the VPC peering connections. + */ + VpcPeeringConnections?: VpcPeeringConnectionList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export type DescribeVpcsMaxResults = number; + export interface DescribeVpcsRequest { + /** + * One or more filters. cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28). cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC. cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. dhcp-options-id - The ID of a set of DHCP options. ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC. ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. isDefault - Indicates whether the VPC is the default VPC. owner-id - The ID of the AWS account that owns the VPC. state - The state of the VPC (pending | available). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC. + */ + Filters?: FilterList; + /** + * One or more VPC IDs. Default: Describes all your VPCs. + */ + VpcIds?: VpcIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: DescribeVpcsMaxResults; + } + export interface DescribeVpcsResult { + /** + * Information about one or more VPCs. + */ + Vpcs?: VpcList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface DescribeVpnConnectionsRequest { + /** + * One or more filters. customer-gateway-configuration - The configuration information for the customer gateway. customer-gateway-id - The ID of a customer gateway associated with the VPN connection. state - The state of the VPN connection (pending | available | deleting | deleted). option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center. bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. type - The type of VPN connection. Currently the only supported type is ipsec.1. vpn-connection-id - The ID of the VPN connection. vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection. + */ + Filters?: FilterList; + /** + * One or more VPN connection IDs. Default: Describes your VPN connections. + */ + VpnConnectionIds?: VpnConnectionIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeVpnConnectionsResult { + /** + * Information about one or more VPN connections. + */ + VpnConnections?: VpnConnectionList; + } + export interface DescribeVpnGatewaysRequest { + /** + * One or more filters. amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway. attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached). attachment.vpc-id - The ID of an attached VPC. availability-zone - The Availability Zone for the virtual private gateway (if applicable). state - The state of the virtual private gateway (pending | available | deleting | deleted). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. type - The type of virtual private gateway. Currently the only supported type is ipsec.1. vpn-gateway-id - The ID of the virtual private gateway. + */ + Filters?: FilterList; + /** + * One or more virtual private gateway IDs. Default: Describes all your virtual private gateways. + */ + VpnGatewayIds?: VpnGatewayIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DescribeVpnGatewaysResult { + /** + * Information about one or more virtual private gateways. + */ + VpnGateways?: VpnGatewayList; + } + export interface DetachClassicLinkVpcRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance to unlink from the VPC. + */ + InstanceId: String; + /** + * The ID of the VPC to which the instance is linked. + */ + VpcId: String; + } + export interface DetachClassicLinkVpcResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface DetachInternetGatewayRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the internet gateway. + */ + InternetGatewayId: String; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface DetachNetworkInterfaceRequest { + /** + * The ID of the attachment. + */ + AttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Specifies whether to force a detachment. + */ + Force?: Boolean; + } + export interface DetachVolumeRequest { + /** + * The device name. + */ + Device?: String; + /** + * Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. + */ + Force?: Boolean; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The ID of the volume. + */ + VolumeId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DetachVpnGatewayRequest { + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * The ID of the virtual private gateway. + */ + VpnGatewayId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export type DeviceType = "ebs"|"instance-store"|string; + export interface DhcpConfiguration { + /** + * The name of a DHCP option. + */ + Key?: String; + /** + * One or more values for the DHCP option. + */ + Values?: DhcpConfigurationValueList; + } + export type DhcpConfigurationList = DhcpConfiguration[]; + export type DhcpConfigurationValueList = AttributeValue[]; + export interface DhcpOptions { + /** + * One or more DHCP options in the set. + */ + DhcpConfigurations?: DhcpConfigurationList; + /** + * The ID of the set of DHCP options. + */ + DhcpOptionsId?: String; + /** + * The ID of the AWS account that owns the DHCP options set. + */ + OwnerId?: String; + /** + * Any tags assigned to the DHCP options set. + */ + Tags?: TagList; + } + export type DhcpOptionsIdStringList = String[]; + export type DhcpOptionsList = DhcpOptions[]; + export interface DirectoryServiceAuthentication { + /** + * The ID of the Active Directory used for authentication. + */ + DirectoryId?: String; + } + export interface DirectoryServiceAuthenticationRequest { + /** + * The ID of the Active Directory to be used for authentication. + */ + DirectoryId?: String; + } + export interface DisableTransitGatewayRouteTablePropagationRequest { + /** + * The ID of the propagation route table. + */ + TransitGatewayRouteTableId: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DisableTransitGatewayRouteTablePropagationResult { + /** + * Information about route propagation. + */ + Propagation?: TransitGatewayPropagation; + } + export interface DisableVgwRoutePropagationRequest { + /** + * The ID of the virtual private gateway. + */ + GatewayId: String; + /** + * The ID of the route table. + */ + RouteTableId: String; + } + export interface DisableVpcClassicLinkDnsSupportRequest { + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export interface DisableVpcClassicLinkDnsSupportResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface DisableVpcClassicLinkRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface DisableVpcClassicLinkResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface DisassociateAddressRequest { + /** + * [EC2-VPC] The association ID. Required for EC2-VPC. + */ + AssociationId?: String; + /** + * [EC2-Classic] The Elastic IP address. Required for EC2-Classic. + */ + PublicIp?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DisassociateClientVpnTargetNetworkRequest { + /** + * The ID of the Client VPN endpoint from which to disassociate the target network. + */ + ClientVpnEndpointId: String; + /** + * The ID of the target network association. + */ + AssociationId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DisassociateClientVpnTargetNetworkResult { + /** + * The ID of the target network association. + */ + AssociationId?: String; + /** + * The current state of the target network association. + */ + Status?: AssociationStatus; + } + export interface DisassociateIamInstanceProfileRequest { + /** + * The ID of the IAM instance profile association. + */ + AssociationId: String; + } + export interface DisassociateIamInstanceProfileResult { + /** + * Information about the IAM instance profile association. + */ + IamInstanceProfileAssociation?: IamInstanceProfileAssociation; + } + export interface DisassociateRouteTableRequest { + /** + * The association ID representing the current association between the route table and subnet. + */ + AssociationId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DisassociateSubnetCidrBlockRequest { + /** + * The association ID for the CIDR block. + */ + AssociationId: String; + } + export interface DisassociateSubnetCidrBlockResult { + /** + * Information about the IPv6 CIDR block association. + */ + Ipv6CidrBlockAssociation?: SubnetIpv6CidrBlockAssociation; + /** + * The ID of the subnet. + */ + SubnetId?: String; + } + export interface DisassociateTransitGatewayRouteTableRequest { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface DisassociateTransitGatewayRouteTableResult { + /** + * Information about the association. + */ + Association?: TransitGatewayAssociation; + } + export interface DisassociateVpcCidrBlockRequest { + /** + * The association ID for the CIDR block. + */ + AssociationId: String; + } + export interface DisassociateVpcCidrBlockResult { + /** + * Information about the IPv6 CIDR block association. + */ + Ipv6CidrBlockAssociation?: VpcIpv6CidrBlockAssociation; + /** + * Information about the IPv4 CIDR block association. + */ + CidrBlockAssociation?: VpcCidrBlockAssociation; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export interface DiskImage { + /** + * A description of the disk image. + */ + Description?: String; + /** + * Information about the disk image. + */ + Image?: DiskImageDetail; + /** + * Information about the volume. + */ + Volume?: VolumeDetail; + } + export interface DiskImageDescription { + /** + * The checksum computed for the disk image. + */ + Checksum?: String; + /** + * The disk image format. + */ + Format?: DiskImageFormat; + /** + * A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + ImportManifestUrl?: String; + /** + * The size of the disk image, in GiB. + */ + Size?: Long; + } + export interface DiskImageDetail { + /** + * The size of the disk image, in GiB. + */ + Bytes: Long; + /** + * The disk image format. + */ + Format: DiskImageFormat; + /** + * A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide. For information about the import manifest referenced by this API action, see VM Import Manifest. + */ + ImportManifestUrl: String; + } + export type DiskImageFormat = "VMDK"|"RAW"|"VHD"|string; + export type DiskImageList = DiskImage[]; + export interface DiskImageVolumeDescription { + /** + * The volume identifier. + */ + Id?: String; + /** + * The size of the volume, in GiB. + */ + Size?: Long; + } + export interface DnsEntry { + /** + * The DNS name. + */ + DnsName?: String; + /** + * The ID of the private hosted zone. + */ + HostedZoneId?: String; + } + export type DnsEntrySet = DnsEntry[]; + export interface DnsServersOptionsModifyStructure { + /** + * The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values. + */ + CustomDnsServers?: ValueStringList; + /** + * Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers. + */ + Enabled?: Boolean; + } + export type DnsSupportValue = "enable"|"disable"|string; + export type DomainType = "vpc"|"standard"|string; + export type Double = number; + export interface EbsBlockDevice { + /** + * Indicates whether the EBS volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + /** + * The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes, in most Regions. The maximum IOPS for io1 of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. + */ + Iops?: Integer; + /** + * The ID of the snapshot. + */ + SnapshotId?: String; + /** + * The size of the volume, in GiB. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. + */ + VolumeSize?: Integer; + /** + * The volume type. If you set the type to io1, you must also set the Iops property. Default: standard + */ + VolumeType?: VolumeType; + /** + * Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you cannot specify an encryption value. This is because only blank volumes can be encrypted on creation. If you are creating a snapshot from an existing EBS volume, you cannot specify an encryption value that differs from that of the EBS volume. We recommend that you omit the encryption value from the block device mappings when creating an image from an instance. + */ + Encrypted?: Boolean; + /** + * Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted. This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. + */ + KmsKeyId?: String; + } + export interface EbsInstanceBlockDevice { + /** + * The time stamp when the attachment initiated. + */ + AttachTime?: DateTime; + /** + * Indicates whether the volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + /** + * The attachment state. + */ + Status?: AttachmentStatus; + /** + * The ID of the EBS volume. + */ + VolumeId?: String; + } + export interface EbsInstanceBlockDeviceSpecification { + /** + * Indicates whether the volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + /** + * The ID of the EBS volume. + */ + VolumeId?: String; + } + export interface EgressOnlyInternetGateway { + /** + * Information about the attachment of the egress-only internet gateway. + */ + Attachments?: InternetGatewayAttachmentList; + /** + * The ID of the egress-only internet gateway. + */ + EgressOnlyInternetGatewayId?: EgressOnlyInternetGatewayId; + } + export type EgressOnlyInternetGatewayId = string; + export type EgressOnlyInternetGatewayIdList = EgressOnlyInternetGatewayId[]; + export type EgressOnlyInternetGatewayList = EgressOnlyInternetGateway[]; + export interface ElasticGpuAssociation { + /** + * The ID of the Elastic Graphics accelerator. + */ + ElasticGpuId?: String; + /** + * The ID of the association. + */ + ElasticGpuAssociationId?: String; + /** + * The state of the association between the instance and the Elastic Graphics accelerator. + */ + ElasticGpuAssociationState?: String; + /** + * The time the Elastic Graphics accelerator was associated with the instance. + */ + ElasticGpuAssociationTime?: String; + } + export type ElasticGpuAssociationList = ElasticGpuAssociation[]; + export interface ElasticGpuHealth { + /** + * The health status. + */ + Status?: ElasticGpuStatus; + } + export type ElasticGpuIdSet = String[]; + export type ElasticGpuSet = ElasticGpus[]; + export interface ElasticGpuSpecification { + /** + * The type of Elastic Graphics accelerator. + */ + Type: String; + } + export type ElasticGpuSpecificationList = ElasticGpuSpecification[]; + export interface ElasticGpuSpecificationResponse { + /** + * The elastic GPU type. + */ + Type?: String; + } + export type ElasticGpuSpecificationResponseList = ElasticGpuSpecificationResponse[]; + export type ElasticGpuSpecifications = ElasticGpuSpecification[]; + export type ElasticGpuState = "ATTACHED"|string; + export type ElasticGpuStatus = "OK"|"IMPAIRED"|string; + export interface ElasticGpus { + /** + * The ID of the Elastic Graphics accelerator. + */ + ElasticGpuId?: String; + /** + * The Availability Zone in the which the Elastic Graphics accelerator resides. + */ + AvailabilityZone?: String; + /** + * The type of Elastic Graphics accelerator. + */ + ElasticGpuType?: String; + /** + * The status of the Elastic Graphics accelerator. + */ + ElasticGpuHealth?: ElasticGpuHealth; + /** + * The state of the Elastic Graphics accelerator. + */ + ElasticGpuState?: ElasticGpuState; + /** + * The ID of the instance to which the Elastic Graphics accelerator is attached. + */ + InstanceId?: String; + } + export interface ElasticInferenceAccelerator { + /** + * The type of elastic inference accelerator. The possible values are eia1.small, eia1.medium, and eia1.large. + */ + Type: String; + } + export interface ElasticInferenceAcceleratorAssociation { + /** + * The Amazon Resource Name (ARN) of the elastic inference accelerator. + */ + ElasticInferenceAcceleratorArn?: String; + /** + * The ID of the association. + */ + ElasticInferenceAcceleratorAssociationId?: String; + /** + * The state of the elastic inference accelerator. + */ + ElasticInferenceAcceleratorAssociationState?: String; + /** + * The time at which the elastic inference accelerator is associated with an instance. + */ + ElasticInferenceAcceleratorAssociationTime?: DateTime; + } + export type ElasticInferenceAcceleratorAssociationList = ElasticInferenceAcceleratorAssociation[]; + export type ElasticInferenceAccelerators = ElasticInferenceAccelerator[]; + export interface EnableTransitGatewayRouteTablePropagationRequest { + /** + * The ID of the propagation route table. + */ + TransitGatewayRouteTableId: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface EnableTransitGatewayRouteTablePropagationResult { + /** + * Information about route propagation. + */ + Propagation?: TransitGatewayPropagation; + } + export interface EnableVgwRoutePropagationRequest { + /** + * The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. + */ + GatewayId: String; + /** + * The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. + */ + RouteTableId: String; + } + export interface EnableVolumeIORequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the volume. + */ + VolumeId: String; + } + export interface EnableVpcClassicLinkDnsSupportRequest { + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export interface EnableVpcClassicLinkDnsSupportResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface EnableVpcClassicLinkRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface EnableVpcClassicLinkResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export type EndDateType = "unlimited"|"limited"|string; + export type EndpointSet = ClientVpnEndpoint[]; + export type EventCode = "instance-reboot"|"system-reboot"|"system-maintenance"|"instance-retirement"|"instance-stop"|string; + export interface EventInformation { + /** + * The description of the event. + */ + EventDescription?: String; + /** + * The event. The following are the error events: iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet did not have the required permissions either to launch or terminate an instance. spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event. spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch. The following are the fleetRequestChange events: active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running Spot Instances. cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running Spot Instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances were terminated. cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional Spot Instances. Existing Spot Instances continue to run until they are interrupted or terminated. cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its Spot Instances are terminating. expired - The EC2 Fleet or Spot Fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set. modify_in_progress - A request to modify the EC2 Fleet or Spot Fleet request was accepted and is in progress. modify_successful - The EC2 Fleet or Spot Fleet request was modified. price_update - The price for a launch configuration was adjusted because it was too high. This change is permanent. submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot Instances. The following are the instanceChange events: launched - A request was fulfilled and a new instance was launched. terminated - An instance was terminated by the user. The following are the Information events: launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event. launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price or the Spot price is above the On-Demand price. fleetProgressHalted - The price in every launch specification is not valid. A launch specification might become valid if the Spot price changes. + */ + EventSubType?: String; + /** + * The ID of the instance. This information is available only for instanceChange events. + */ + InstanceId?: String; + } + export type EventType = "instanceChange"|"fleetRequestChange"|"error"|string; + export type ExcessCapacityTerminationPolicy = "noTermination"|"default"|string; + export type ExecutableByStringList = String[]; + export interface ExportClientVpnClientCertificateRevocationListRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ExportClientVpnClientCertificateRevocationListResult { + /** + * Information about the client certificate revocation list. + */ + CertificateRevocationList?: String; + /** + * The current state of the client certificate revocation list. + */ + Status?: ClientCertificateRevocationListStatus; + } + export interface ExportClientVpnClientConfigurationRequest { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ExportClientVpnClientConfigurationResult { + /** + * The contents of the Client VPN endpoint configuration file. + */ + ClientConfiguration?: String; + } + export type ExportEnvironment = "citrix"|"vmware"|"microsoft"|string; + export interface ExportTask { + /** + * A description of the resource being exported. + */ + Description?: String; + /** + * The ID of the export task. + */ + ExportTaskId?: String; + /** + * Information about the export task. + */ + ExportToS3Task?: ExportToS3Task; + /** + * Information about the instance to export. + */ + InstanceExportDetails?: InstanceExportDetails; + /** + * The state of the export task. + */ + State?: ExportTaskState; + /** + * The status message related to the export task. + */ + StatusMessage?: String; + } + export type ExportTaskIdStringList = String[]; + export type ExportTaskList = ExportTask[]; + export type ExportTaskState = "active"|"cancelling"|"cancelled"|"completed"|string; + export interface ExportToS3Task { + /** + * The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. + */ + ContainerFormat?: ContainerFormat; + /** + * The format for the exported image. + */ + DiskImageFormat?: DiskImageFormat; + /** + * The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. + */ + S3Bucket?: String; + /** + * The encryption key for your S3 bucket. + */ + S3Key?: String; + } + export interface ExportToS3TaskSpecification { + /** + * The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. + */ + ContainerFormat?: ContainerFormat; + /** + * The format for the exported image. + */ + DiskImageFormat?: DiskImageFormat; + /** + * The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com. + */ + S3Bucket?: String; + /** + * The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat. + */ + S3Prefix?: String; + } + export interface ExportTransitGatewayRoutesRequest { + /** + * The ID of the route table. + */ + TransitGatewayRouteTableId: String; + /** + * One or more filters. The possible values are: attachment.transit-gateway-attachment-id- The id of the transit gateway attachment. attachment.resource-id - The resource id of the transit gateway attachment. route-search.exact-match - The exact match of the specified filter. route-search.longest-prefix-match - The longest prefix that matches the route. route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter. route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting). transit-gateway-route-destination-cidr-block - The CIDR range. type - The type of roue (active | blackhole). + */ + Filters?: FilterList; + /** + * The name of the S3 bucket. + */ + S3Bucket: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ExportTransitGatewayRoutesResult { + /** + * The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name. + */ + S3Location?: String; + } + export interface Filter { + /** + * The name of the filter. Filter names are case-sensitive. + */ + Name?: String; + /** + * The filter values. Filter values are case-sensitive. + */ + Values?: ValueStringList; + } + export type FilterList = Filter[]; + export type FleetActivityStatus = "error"|"pending-fulfillment"|"pending-termination"|"fulfilled"|string; + export interface FleetData { + /** + * The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating. + */ + ActivityStatus?: FleetActivityStatus; + /** + * The creation date and time of the EC2 Fleet. + */ + CreateTime?: DateTime; + /** + * The ID of the EC2 Fleet. + */ + FleetId?: FleetIdentifier; + /** + * The state of the EC2 Fleet. + */ + FleetState?: FleetStateCode; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraints: Maximum 64 ASCII characters + */ + ClientToken?: String; + /** + * Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + */ + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy; + /** + * The number of units fulfilled by this request compared to the set target capacity. + */ + FulfilledCapacity?: Double; + /** + * The number of units fulfilled by this request compared to the set target On-Demand capacity. + */ + FulfilledOnDemandCapacity?: Double; + /** + * The launch template and overrides. + */ + LaunchTemplateConfigs?: FleetLaunchTemplateConfigList; + /** + * The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later. + */ + TargetCapacitySpecification?: TargetCapacitySpecification; + /** + * Indicates whether running instances should be terminated when the EC2 Fleet expires. + */ + TerminateInstancesWithExpiration?: Boolean; + /** + * The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain. + */ + Type?: FleetType; + /** + * The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. + */ + ValidFrom?: DateTime; + /** + * The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. + */ + ValidUntil?: DateTime; + /** + * Indicates whether EC2 Fleet should replace unhealthy instances. + */ + ReplaceUnhealthyInstances?: Boolean; + /** + * The configuration of Spot Instances in an EC2 Fleet. + */ + SpotOptions?: SpotOptions; + /** + * The allocation strategy of On-Demand Instances in an EC2 Fleet. + */ + OnDemandOptions?: OnDemandOptions; + /** + * The tags for an EC2 Fleet resource. + */ + Tags?: TagList; + /** + * Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant. + */ + Errors?: DescribeFleetsErrorSet; + /** + * Information about the instances that were launched by the fleet. Valid only when Type is set to instant. + */ + Instances?: DescribeFleetsInstancesSet; + } + export type FleetEventType = "instance-change"|"fleet-change"|"service-error"|string; + export type FleetExcessCapacityTerminationPolicy = "no-termination"|"termination"|string; + export type FleetIdSet = FleetIdentifier[]; + export type FleetIdentifier = string; + export interface FleetLaunchTemplateConfig { + /** + * The launch template. + */ + LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + /** + * Any parameters that you specify override the same parameters in the launch template. + */ + Overrides?: FleetLaunchTemplateOverridesList; + } + export type FleetLaunchTemplateConfigList = FleetLaunchTemplateConfig[]; + export type FleetLaunchTemplateConfigListRequest = FleetLaunchTemplateConfigRequest[]; + export interface FleetLaunchTemplateConfigRequest { + /** + * The launch template to use. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateSpecification?: FleetLaunchTemplateSpecificationRequest; + /** + * Any parameters that you specify override the same parameters in the launch template. + */ + Overrides?: FleetLaunchTemplateOverridesListRequest; + } + export interface FleetLaunchTemplateOverrides { + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The maximum price per unit hour that you are willing to pay for a Spot Instance. + */ + MaxPrice?: String; + /** + * The ID of the subnet in which to launch the instances. + */ + SubnetId?: String; + /** + * The Availability Zone in which to launch the instances. + */ + AvailabilityZone?: String; + /** + * The number of units provided by the specified instance type. + */ + WeightedCapacity?: Double; + /** + * The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. + */ + Priority?: Double; + /** + * The location where the instance launched, if applicable. + */ + Placement?: PlacementResponse; + } + export type FleetLaunchTemplateOverridesList = FleetLaunchTemplateOverrides[]; + export type FleetLaunchTemplateOverridesListRequest = FleetLaunchTemplateOverridesRequest[]; + export interface FleetLaunchTemplateOverridesRequest { + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The maximum price per unit hour that you are willing to pay for a Spot Instance. + */ + MaxPrice?: String; + /** + * The ID of the subnet in which to launch the instances. + */ + SubnetId?: String; + /** + * The Availability Zone in which to launch the instances. + */ + AvailabilityZone?: String; + /** + * The number of units provided by the specified instance type. + */ + WeightedCapacity?: Double; + /** + * The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. + */ + Priority?: Double; + /** + * The location where the instance launched, if applicable. + */ + Placement?: Placement; + } + export interface FleetLaunchTemplateSpecification { + /** + * The ID of the launch template. You must specify either a template ID or a template name. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. You must specify either a template name or a template ID. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The version number of the launch template. You must specify a version number. + */ + Version?: String; + } + export interface FleetLaunchTemplateSpecificationRequest { + /** + * The ID of the launch template. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The version number of the launch template. + */ + Version?: String; + } + export type FleetOnDemandAllocationStrategy = "lowest-price"|"prioritized"|string; + export type FleetSet = FleetData[]; + export type FleetStateCode = "submitted"|"active"|"deleted"|"failed"|"deleted-running"|"deleted-terminating"|"modifying"|string; + export type FleetType = "request"|"maintain"|"instant"|string; + export type Float = number; + export interface FlowLog { + /** + * The date and time the flow log was created. + */ + CreationTime?: DateTime; + /** + * Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error. + */ + DeliverLogsErrorMessage?: String; + /** + * The ARN of the IAM role that posts logs to CloudWatch Logs. + */ + DeliverLogsPermissionArn?: String; + /** + * The status of the logs delivery (SUCCESS | FAILED). + */ + DeliverLogsStatus?: String; + /** + * The flow log ID. + */ + FlowLogId?: String; + /** + * The status of the flow log (ACTIVE). + */ + FlowLogStatus?: String; + /** + * The name of the flow log group. + */ + LogGroupName?: String; + /** + * The ID of the resource on which the flow log was created. + */ + ResourceId?: String; + /** + * The type of traffic captured for the flow log. + */ + TrafficType?: TrafficType; + /** + * Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3. + */ + LogDestinationType?: LogDestinationType; + /** + * Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published. + */ + LogDestination?: String; + } + export type FlowLogSet = FlowLog[]; + export type FlowLogsResourceType = "VPC"|"Subnet"|"NetworkInterface"|string; + export interface FpgaImage { + /** + * The FPGA image identifier (AFI ID). + */ + FpgaImageId?: String; + /** + * The global FPGA image identifier (AGFI ID). + */ + FpgaImageGlobalId?: String; + /** + * The name of the AFI. + */ + Name?: String; + /** + * The description of the AFI. + */ + Description?: String; + /** + * The version of the AWS Shell that was used to create the bitstream. + */ + ShellVersion?: String; + /** + * Information about the PCI bus. + */ + PciId?: PciId; + /** + * Information about the state of the AFI. + */ + State?: FpgaImageState; + /** + * The date and time the AFI was created. + */ + CreateTime?: DateTime; + /** + * The time of the most recent update to the AFI. + */ + UpdateTime?: DateTime; + /** + * The AWS account ID of the AFI owner. + */ + OwnerId?: String; + /** + * The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace. + */ + OwnerAlias?: String; + /** + * The product codes for the AFI. + */ + ProductCodes?: ProductCodeList; + /** + * Any tags assigned to the AFI. + */ + Tags?: TagList; + /** + * Indicates whether the AFI is public. + */ + Public?: Boolean; + /** + * Indicates whether data retention support is enabled for the AFI. + */ + DataRetentionSupport?: Boolean; + } + export interface FpgaImageAttribute { + /** + * The ID of the AFI. + */ + FpgaImageId?: String; + /** + * The name of the AFI. + */ + Name?: String; + /** + * The description of the AFI. + */ + Description?: String; + /** + * The load permissions. + */ + LoadPermissions?: LoadPermissionList; + /** + * The product codes. + */ + ProductCodes?: ProductCodeList; + } + export type FpgaImageAttributeName = "description"|"name"|"loadPermission"|"productCodes"|string; + export type FpgaImageIdList = String[]; + export type FpgaImageList = FpgaImage[]; + export interface FpgaImageState { + /** + * The state. The following are the possible values: pending - AFI bitstream generation is in progress. available - The AFI is available for use. failed - AFI bitstream generation failed. unavailable - The AFI is no longer available for use. + */ + Code?: FpgaImageStateCode; + /** + * If the state is failed, this is the error message. + */ + Message?: String; + } + export type FpgaImageStateCode = "pending"|"failed"|"available"|"unavailable"|string; + export type GatewayType = "ipsec.1"|string; + export interface GetConsoleOutputRequest { + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * When enabled, retrieves the latest console output for the instance. Default: disabled (false) + */ + Latest?: Boolean; + } + export interface GetConsoleOutputResult { + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you. + */ + Output?: String; + /** + * The time at which the output was last updated. + */ + Timestamp?: DateTime; + } + export interface GetConsoleScreenshotRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode. + */ + WakeUp?: Boolean; + } + export interface GetConsoleScreenshotResult { + /** + * The data that comprises the image. + */ + ImageData?: String; + /** + * The ID of the instance. + */ + InstanceId?: String; + } + export interface GetHostReservationPurchasePreviewRequest { + /** + * The IDs of the Dedicated Hosts with which the reservation is associated. + */ + HostIdSet: RequestHostIdSet; + /** + * The offering ID of the reservation. + */ + OfferingId: String; + } + export interface GetHostReservationPurchasePreviewResult { + /** + * The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it. + */ + Purchase?: PurchaseSet; + /** + * The potential total hourly price of the reservation per hour. + */ + TotalHourlyPrice?: String; + /** + * The potential total upfront price. This is billed immediately. + */ + TotalUpfrontPrice?: String; + } + export interface GetLaunchTemplateDataRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance. + */ + InstanceId: String; + } + export interface GetLaunchTemplateDataResult { + /** + * The instance data. + */ + LaunchTemplateData?: ResponseLaunchTemplateData; + } + export interface GetPasswordDataRequest { + /** + * The ID of the Windows instance. + */ + InstanceId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface GetPasswordDataResult { + /** + * The ID of the Windows instance. + */ + InstanceId?: String; + /** + * The password of the instance. Returns an empty string if the password is not available. + */ + PasswordData?: String; + /** + * The time the data was last updated. + */ + Timestamp?: DateTime; + } + export interface GetReservedInstancesExchangeQuoteRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The IDs of the Convertible Reserved Instances to exchange. + */ + ReservedInstanceIds: ReservedInstanceIdSet; + /** + * The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. + */ + TargetConfigurations?: TargetConfigurationRequestSet; + } + export interface GetReservedInstancesExchangeQuoteResult { + /** + * The currency of the transaction. + */ + CurrencyCode?: String; + /** + * If true, the exchange is valid. If false, the exchange cannot be completed. + */ + IsValidExchange?: Boolean; + /** + * The new end date of the reservation term. + */ + OutputReservedInstancesWillExpireAt?: DateTime; + /** + * The total true upfront charge for the exchange. + */ + PaymentDue?: String; + /** + * The cost associated with the Reserved Instance. + */ + ReservedInstanceValueRollup?: ReservationValue; + /** + * The configuration of your Convertible Reserved Instances. + */ + ReservedInstanceValueSet?: ReservedInstanceReservationValueSet; + /** + * The cost associated with the Reserved Instance. + */ + TargetConfigurationValueRollup?: ReservationValue; + /** + * The values of the target Convertible Reserved Instances. + */ + TargetConfigurationValueSet?: TargetReservationValueSet; + /** + * Describes the reason why the exchange cannot be completed. + */ + ValidationFailureReason?: String; + } + export interface GetTransitGatewayAttachmentPropagationsRequest { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * One or more filters. The possible values are: transit-gateway-route-table-id - The ID of the transit gateway route table. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface GetTransitGatewayAttachmentPropagationsResult { + /** + * Information about the propagation route tables. + */ + TransitGatewayAttachmentPropagations?: TransitGatewayAttachmentPropagationList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface GetTransitGatewayRouteTableAssociationsRequest { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type (vpc | vpn). transit-gateway-attachment-id - The ID of the attachment. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface GetTransitGatewayRouteTableAssociationsResult { + /** + * Information about the associations. + */ + Associations?: TransitGatewayRouteTableAssociationList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export interface GetTransitGatewayRouteTablePropagationsRequest { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type (vpc | vpn). transit-gateway-attachment-id - The ID of the attachment. + */ + Filters?: FilterList; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * The token for the next page of results. + */ + NextToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface GetTransitGatewayRouteTablePropagationsResult { + /** + * Information about the route table propagations. + */ + TransitGatewayRouteTablePropagations?: TransitGatewayRouteTablePropagationList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export type GroupIdStringList = String[]; + export interface GroupIdentifier { + /** + * The name of the security group. + */ + GroupName?: String; + /** + * The ID of the security group. + */ + GroupId?: String; + } + export type GroupIdentifierList = GroupIdentifier[]; + export type GroupIdentifierSet = SecurityGroupIdentifier[]; + export type GroupIds = String[]; + export type GroupNameStringList = String[]; + export interface HibernationOptions { + /** + * If this parameter is set to true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation. + */ + Configured?: Boolean; + } + export interface HibernationOptionsRequest { + /** + * If you set this parameter to true, your instance is enabled for hibernation. Default: false + */ + Configured?: Boolean; + } + export interface HistoryRecord { + /** + * Information about the event. + */ + EventInformation?: EventInformation; + /** + * The event type. error - An error with the Spot Fleet request. fleetRequestChange - A change in the status or configuration of the Spot Fleet request. instanceChange - An instance was launched or terminated. Information - An informational event. + */ + EventType?: EventType; + /** + * The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + Timestamp?: DateTime; + } + export interface HistoryRecordEntry { + /** + * Information about the event. + */ + EventInformation?: EventInformation; + /** + * The event type. + */ + EventType?: FleetEventType; + /** + * The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + Timestamp?: DateTime; + } + export type HistoryRecordSet = HistoryRecordEntry[]; + export type HistoryRecords = HistoryRecord[]; + export interface Host { + /** + * Whether auto-placement is on or off. + */ + AutoPlacement?: AutoPlacement; + /** + * The Availability Zone of the Dedicated Host. + */ + AvailabilityZone?: String; + /** + * The number of new instances that can be launched onto the Dedicated Host. + */ + AvailableCapacity?: AvailableCapacity; + /** + * Unique, case-sensitive identifier that you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. + */ + ClientToken?: String; + /** + * The ID of the Dedicated Host. + */ + HostId?: String; + /** + * The hardware specifications of the Dedicated Host. + */ + HostProperties?: HostProperties; + /** + * The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation. + */ + HostReservationId?: String; + /** + * The IDs and instance type that are currently running on the Dedicated Host. + */ + Instances?: HostInstanceList; + /** + * The Dedicated Host's state. + */ + State?: AllocationState; + /** + * The time that the Dedicated Host was allocated. + */ + AllocationTime?: DateTime; + /** + * The time that the Dedicated Host was released. + */ + ReleaseTime?: DateTime; + /** + * Any tags assigned to the Dedicated Host. + */ + Tags?: TagList; + } + export interface HostInstance { + /** + * the IDs of instances that are running on the Dedicated Host. + */ + InstanceId?: String; + /** + * The instance type size (for example, m3.medium) of the running instance. + */ + InstanceType?: String; + } + export type HostInstanceList = HostInstance[]; + export type HostList = Host[]; + export interface HostOffering { + /** + * The currency of the offering. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The duration of the offering (in seconds). + */ + Duration?: Integer; + /** + * The hourly price of the offering. + */ + HourlyPrice?: String; + /** + * The instance family of the offering. + */ + InstanceFamily?: String; + /** + * The ID of the offering. + */ + OfferingId?: String; + /** + * The available payment option. + */ + PaymentOption?: PaymentOption; + /** + * The upfront price of the offering. Does not apply to No Upfront offerings. + */ + UpfrontPrice?: String; + } + export type HostOfferingSet = HostOffering[]; + export interface HostProperties { + /** + * The number of cores on the Dedicated Host. + */ + Cores?: Integer; + /** + * The instance type size that the Dedicated Host supports (for example, m3.medium). + */ + InstanceType?: String; + /** + * The number of sockets on the Dedicated Host. + */ + Sockets?: Integer; + /** + * The number of vCPUs on the Dedicated Host. + */ + TotalVCpus?: Integer; + } + export interface HostReservation { + /** + * The number of Dedicated Hosts the reservation is associated with. + */ + Count?: Integer; + /** + * The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years). + */ + Duration?: Integer; + /** + * The date and time that the reservation ends. + */ + End?: DateTime; + /** + * The IDs of the Dedicated Hosts associated with the reservation. + */ + HostIdSet?: ResponseHostIdSet; + /** + * The ID of the reservation that specifies the associated Dedicated Hosts. + */ + HostReservationId?: String; + /** + * The hourly price of the reservation. + */ + HourlyPrice?: String; + /** + * The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation. + */ + InstanceFamily?: String; + /** + * The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it. + */ + OfferingId?: String; + /** + * The payment option selected for this reservation. + */ + PaymentOption?: PaymentOption; + /** + * The date and time that the reservation started. + */ + Start?: DateTime; + /** + * The state of the reservation. + */ + State?: ReservationState; + /** + * The upfront price of the reservation. + */ + UpfrontPrice?: String; + /** + * Any tags assigned to the Dedicated Host Reservation. + */ + Tags?: TagList; + } + export type HostReservationIdSet = String[]; + export type HostReservationSet = HostReservation[]; + export type HostTenancy = "dedicated"|"host"|string; + export type HypervisorType = "ovm"|"xen"|string; + export interface IamInstanceProfile { + /** + * The Amazon Resource Name (ARN) of the instance profile. + */ + Arn?: String; + /** + * The ID of the instance profile. + */ + Id?: String; + } + export interface IamInstanceProfileAssociation { + /** + * The ID of the association. + */ + AssociationId?: String; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: IamInstanceProfile; + /** + * The state of the association. + */ + State?: IamInstanceProfileAssociationState; + /** + * The time the IAM instance profile was associated with the instance. + */ + Timestamp?: DateTime; + } + export type IamInstanceProfileAssociationSet = IamInstanceProfileAssociation[]; + export type IamInstanceProfileAssociationState = "associating"|"associated"|"disassociating"|"disassociated"|string; + export interface IamInstanceProfileSpecification { + /** + * The Amazon Resource Name (ARN) of the instance profile. + */ + Arn?: String; + /** + * The name of the instance profile. + */ + Name?: String; + } + export interface IcmpTypeCode { + /** + * The ICMP code. A value of -1 means all codes for the specified ICMP type. + */ + Code?: Integer; + /** + * The ICMP type. A value of -1 means all types. + */ + Type?: Integer; + } + export interface IdFormat { + /** + * The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. + */ + Deadline?: DateTime; + /** + * The type of resource. + */ + Resource?: String; + /** + * Indicates whether longer IDs (17-character IDs) are enabled for the resource. + */ + UseLongIds?: Boolean; + } + export type IdFormatList = IdFormat[]; + export interface Image { + /** + * The architecture of the image. + */ + Architecture?: ArchitectureValues; + /** + * The date and time the image was created. + */ + CreationDate?: String; + /** + * The ID of the AMI. + */ + ImageId?: String; + /** + * The location of the AMI. + */ + ImageLocation?: String; + /** + * The type of image. + */ + ImageType?: ImageTypeValues; + /** + * Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions. + */ + Public?: Boolean; + /** + * The kernel associated with the image, if any. Only applicable for machine images. + */ + KernelId?: String; + /** + * The AWS account ID of the image owner. + */ + OwnerId?: String; + /** + * The value is Windows for Windows AMIs; otherwise blank. + */ + Platform?: PlatformValues; + /** + * Any product codes associated with the AMI. + */ + ProductCodes?: ProductCodeList; + /** + * The RAM disk associated with the image, if any. Only applicable for machine images. + */ + RamdiskId?: String; + /** + * The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance. + */ + State?: ImageState; + /** + * Any block device mapping entries. + */ + BlockDeviceMappings?: BlockDeviceMappingList; + /** + * The description of the AMI that was provided during image creation. + */ + Description?: String; + /** + * Specifies whether enhanced networking with ENA is enabled. + */ + EnaSupport?: Boolean; + /** + * The hypervisor type of the image. + */ + Hypervisor?: HypervisorType; + /** + * The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner. + */ + ImageOwnerAlias?: String; + /** + * The name of the AMI that was provided during image creation. + */ + Name?: String; + /** + * The device name of the root device volume (for example, /dev/sda1). + */ + RootDeviceName?: String; + /** + * The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume. + */ + RootDeviceType?: DeviceType; + /** + * Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. + */ + SriovNetSupport?: String; + /** + * The reason for the state change. + */ + StateReason?: StateReason; + /** + * Any tags assigned to the image. + */ + Tags?: TagList; + /** + * The type of virtualization of the AMI. + */ + VirtualizationType?: VirtualizationType; + } + export interface ImageAttribute { + /** + * The block device mapping entries. + */ + BlockDeviceMappings?: BlockDeviceMappingList; + /** + * The ID of the AMI. + */ + ImageId?: String; + /** + * The launch permissions. + */ + LaunchPermissions?: LaunchPermissionList; + /** + * The product codes. + */ + ProductCodes?: ProductCodeList; + /** + * A description for the AMI. + */ + Description?: AttributeValue; + /** + * The kernel ID. + */ + KernelId?: AttributeValue; + /** + * The RAM disk ID. + */ + RamdiskId?: AttributeValue; + /** + * Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. + */ + SriovNetSupport?: AttributeValue; + } + export type ImageAttributeName = "description"|"kernel"|"ramdisk"|"launchPermission"|"productCodes"|"blockDeviceMapping"|"sriovNetSupport"|string; + export interface ImageDiskContainer { + /** + * The description of the disk image. + */ + Description?: String; + /** + * The block device mapping for the disk. + */ + DeviceName?: String; + /** + * The format of the disk image being imported. Valid values: VHD | VMDK | OVA + */ + Format?: String; + /** + * The ID of the EBS snapshot to be used for importing the snapshot. + */ + SnapshotId?: String; + /** + * The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..) + */ + Url?: String; + /** + * The S3 bucket for the disk image. + */ + UserBucket?: UserBucket; + } + export type ImageDiskContainerList = ImageDiskContainer[]; + export type ImageIdStringList = String[]; + export type ImageList = Image[]; + export type ImageState = "pending"|"available"|"invalid"|"deregistered"|"transient"|"failed"|"error"|string; + export type ImageTypeValues = "machine"|"kernel"|"ramdisk"|string; + export interface ImportClientVpnClientCertificateRevocationListRequest { + /** + * The ID of the Client VPN endpoint to which the client certificate revocation list applies. + */ + ClientVpnEndpointId: String; + /** + * The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide. + */ + CertificateRevocationList: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ImportClientVpnClientCertificateRevocationListResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface ImportImageRequest { + /** + * The architecture of the virtual machine. Valid values: i386 | x86_64 + */ + Architecture?: String; + /** + * The client-specific data. + */ + ClientData?: ClientData; + /** + * The token to enable idempotency for VM import requests. + */ + ClientToken?: String; + /** + * A description string for the import image task. + */ + Description?: String; + /** + * Information about the disk containers. + */ + DiskContainers?: ImageDiskContainerList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. + */ + Encrypted?: Boolean; + /** + * The target hypervisor platform. Valid values: xen + */ + Hypervisor?: String; + /** + * An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: Key ID Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified CMK must exist in the region that the AMI is being copied to. + */ + KmsKeyId?: String; + /** + * The license type to be used for the Amazon Machine Image (AMI) after importing. Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide. Valid values include: Auto - Detects the source-system operating system (OS) and applies the appropriate license. AWS - Replaces the source-system license with an AWS license, if appropriate. BYOL - Retains the source-system license, if appropriate. Default value: Auto + */ + LicenseType?: String; + /** + * The operating system of the virtual machine. Valid values: Windows | Linux + */ + Platform?: String; + /** + * The name of the role to use when not using the default role, 'vmimport'. + */ + RoleName?: String; + } + export interface ImportImageResult { + /** + * The architecture of the virtual machine. + */ + Architecture?: String; + /** + * A description of the import task. + */ + Description?: String; + /** + * Indicates whether the AMI is encypted. + */ + Encrypted?: Boolean; + /** + * The target hypervisor of the import task. + */ + Hypervisor?: String; + /** + * The ID of the Amazon Machine Image (AMI) created by the import task. + */ + ImageId?: String; + /** + * The task ID of the import image task. + */ + ImportTaskId?: String; + /** + * The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted AMI. + */ + KmsKeyId?: String; + /** + * The license type of the virtual machine. + */ + LicenseType?: String; + /** + * The operating system of the virtual machine. + */ + Platform?: String; + /** + * The progress of the task. + */ + Progress?: String; + /** + * Information about the snapshots. + */ + SnapshotDetails?: SnapshotDetailList; + /** + * A brief status of the task. + */ + Status?: String; + /** + * A detailed status message of the import task. + */ + StatusMessage?: String; + } + export interface ImportImageTask { + /** + * The architecture of the virtual machine. Valid values: i386 | x86_64 + */ + Architecture?: String; + /** + * A description of the import task. + */ + Description?: String; + /** + * Indicates whether the image is encrypted. + */ + Encrypted?: Boolean; + /** + * The target hypervisor for the import task. Valid values: xen + */ + Hypervisor?: String; + /** + * The ID of the Amazon Machine Image (AMI) of the imported virtual machine. + */ + ImageId?: String; + /** + * The ID of the import image task. + */ + ImportTaskId?: String; + /** + * The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted image. + */ + KmsKeyId?: String; + /** + * The license type of the virtual machine. + */ + LicenseType?: String; + /** + * The description string for the import image task. + */ + Platform?: String; + /** + * The percentage of progress of the import image task. + */ + Progress?: String; + /** + * Information about the snapshots. + */ + SnapshotDetails?: SnapshotDetailList; + /** + * A brief status for the import image task. + */ + Status?: String; + /** + * A descriptive status message for the import image task. + */ + StatusMessage?: String; + } + export type ImportImageTaskList = ImportImageTask[]; + export interface ImportInstanceLaunchSpecification { + /** + * Reserved. + */ + AdditionalInfo?: String; + /** + * The architecture of the instance. + */ + Architecture?: ArchitectureValues; + /** + * The security group IDs. + */ + GroupIds?: SecurityGroupIdStringList; + /** + * The security group names. + */ + GroupNames?: SecurityGroupStringList; + /** + * Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + */ + InstanceInitiatedShutdownBehavior?: ShutdownBehavior; + /** + * The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide. + */ + InstanceType?: InstanceType; + /** + * Indicates whether monitoring is enabled. + */ + Monitoring?: Boolean; + /** + * The placement information for the instance. + */ + Placement?: Placement; + /** + * [EC2-VPC] An available IP address from the IP address range of the subnet. + */ + PrivateIpAddress?: String; + /** + * [EC2-VPC] The ID of the subnet in which to launch the instance. + */ + SubnetId?: String; + /** + * The Base64-encoded user data to make available to the instance. + */ + UserData?: UserData; + } + export interface ImportInstanceRequest { + /** + * A description for the instance being imported. + */ + Description?: String; + /** + * The disk image. + */ + DiskImages?: DiskImageList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The launch specification. + */ + LaunchSpecification?: ImportInstanceLaunchSpecification; + /** + * The instance operating system. + */ + Platform: PlatformValues; + } + export interface ImportInstanceResult { + /** + * Information about the conversion task. + */ + ConversionTask?: ConversionTask; + } + export interface ImportInstanceTaskDetails { + /** + * A description of the task. + */ + Description?: String; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The instance operating system. + */ + Platform?: PlatformValues; + /** + * The volumes. + */ + Volumes?: ImportInstanceVolumeDetailSet; + } + export interface ImportInstanceVolumeDetailItem { + /** + * The Availability Zone where the resulting instance will reside. + */ + AvailabilityZone?: String; + /** + * The number of bytes converted so far. + */ + BytesConverted?: Long; + /** + * A description of the task. + */ + Description?: String; + /** + * The image. + */ + Image?: DiskImageDescription; + /** + * The status of the import of this particular disk image. + */ + Status?: String; + /** + * The status information or errors related to the disk image. + */ + StatusMessage?: String; + /** + * The volume. + */ + Volume?: DiskImageVolumeDescription; + } + export type ImportInstanceVolumeDetailSet = ImportInstanceVolumeDetailItem[]; + export interface ImportKeyPairRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * A unique name for the key pair. + */ + KeyName: String; + /** + * The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you. + */ + PublicKeyMaterial: _Blob; + } + export interface ImportKeyPairResult { + /** + * The MD5 public key fingerprint as specified in section 4 of RFC 4716. + */ + KeyFingerprint?: String; + /** + * The key pair name you provided. + */ + KeyName?: String; + } + export interface ImportSnapshotRequest { + /** + * The client-specific data. + */ + ClientData?: ClientData; + /** + * Token to enable idempotency for VM import requests. + */ + ClientToken?: String; + /** + * The description string for the import snapshot task. + */ + Description?: String; + /** + * Information about the disk container. + */ + DiskContainer?: SnapshotDiskContainer; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. + */ + Encrypted?: Boolean; + /** + * An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: Key ID Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified CMK must exist in the region that the snapshot is being copied to. + */ + KmsKeyId?: String; + /** + * The name of the role to use when not using the default role, 'vmimport'. + */ + RoleName?: String; + } + export interface ImportSnapshotResult { + /** + * A description of the import snapshot task. + */ + Description?: String; + /** + * The ID of the import snapshot task. + */ + ImportTaskId?: String; + /** + * Information about the import snapshot task. + */ + SnapshotTaskDetail?: SnapshotTaskDetail; + } + export interface ImportSnapshotTask { + /** + * A description of the import snapshot task. + */ + Description?: String; + /** + * The ID of the import snapshot task. + */ + ImportTaskId?: String; + /** + * Describes an import snapshot task. + */ + SnapshotTaskDetail?: SnapshotTaskDetail; + } + export type ImportSnapshotTaskList = ImportSnapshotTask[]; + export type ImportTaskIdList = String[]; + export interface ImportVolumeRequest { + /** + * The Availability Zone for the resulting EBS volume. + */ + AvailabilityZone: String; + /** + * A description of the volume. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The disk image. + */ + Image: DiskImageDetail; + /** + * The volume size. + */ + Volume: VolumeDetail; + } + export interface ImportVolumeResult { + /** + * Information about the conversion task. + */ + ConversionTask?: ConversionTask; + } + export interface ImportVolumeTaskDetails { + /** + * The Availability Zone where the resulting volume will reside. + */ + AvailabilityZone?: String; + /** + * The number of bytes converted so far. + */ + BytesConverted?: Long; + /** + * The description you provided when starting the import volume task. + */ + Description?: String; + /** + * The image. + */ + Image?: DiskImageDescription; + /** + * The volume. + */ + Volume?: DiskImageVolumeDescription; + } + export interface Instance { + /** + * The AMI launch index, which can be used to find this instance in the launch group. + */ + AmiLaunchIndex?: Integer; + /** + * The ID of the AMI used to launch the instance. + */ + ImageId?: String; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The kernel associated with this instance, if applicable. + */ + KernelId?: String; + /** + * The name of the key pair, if this instance was launched with an associated key pair. + */ + KeyName?: String; + /** + * The time the instance was launched. + */ + LaunchTime?: DateTime; + /** + * The monitoring for the instance. + */ + Monitoring?: Monitoring; + /** + * The location where the instance launched, if applicable. + */ + Placement?: Placement; + /** + * The value is Windows for Windows instances; otherwise blank. + */ + Platform?: PlatformValues; + /** + * (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. [EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate. + */ + PrivateDnsName?: String; + /** + * The private IPv4 address assigned to the instance. + */ + PrivateIpAddress?: String; + /** + * The product codes attached to this instance, if applicable. + */ + ProductCodes?: ProductCodeList; + /** + * (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC. + */ + PublicDnsName?: String; + /** + * The public IPv4 address assigned to the instance, if applicable. + */ + PublicIpAddress?: String; + /** + * The RAM disk associated with this instance, if applicable. + */ + RamdiskId?: String; + /** + * The current state of the instance. + */ + State?: InstanceState; + /** + * The reason for the most recent state transition. This might be an empty string. + */ + StateTransitionReason?: String; + /** + * [EC2-VPC] The ID of the subnet in which the instance is running. + */ + SubnetId?: String; + /** + * [EC2-VPC] The ID of the VPC in which the instance is running. + */ + VpcId?: String; + /** + * The architecture of the image. + */ + Architecture?: ArchitectureValues; + /** + * Any block device mapping entries for the instance. + */ + BlockDeviceMappings?: InstanceBlockDeviceMappingList; + /** + * The idempotency token you provided when you launched the instance, if applicable. + */ + ClientToken?: String; + /** + * Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. + */ + EbsOptimized?: Boolean; + /** + * Specifies whether enhanced networking with ENA is enabled. + */ + EnaSupport?: Boolean; + /** + * The hypervisor type of the instance. + */ + Hypervisor?: HypervisorType; + /** + * The IAM instance profile associated with the instance, if applicable. + */ + IamInstanceProfile?: IamInstanceProfile; + /** + * Indicates whether this is a Spot Instance or a Scheduled Instance. + */ + InstanceLifecycle?: InstanceLifecycleType; + /** + * The Elastic GPU associated with the instance. + */ + ElasticGpuAssociations?: ElasticGpuAssociationList; + /** + * The elastic inference accelerator associated with the instance. + */ + ElasticInferenceAcceleratorAssociations?: ElasticInferenceAcceleratorAssociationList; + /** + * [EC2-VPC] The network interfaces for the instance. + */ + NetworkInterfaces?: InstanceNetworkInterfaceList; + /** + * The device name of the root device volume (for example, /dev/sda1). + */ + RootDeviceName?: String; + /** + * The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. + */ + RootDeviceType?: DeviceType; + /** + * The security groups for the instance. + */ + SecurityGroups?: GroupIdentifierList; + /** + * Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide. + */ + SourceDestCheck?: Boolean; + /** + * If the request is a Spot Instance request, the ID of the request. + */ + SpotInstanceRequestId?: String; + /** + * Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. + */ + SriovNetSupport?: String; + /** + * The reason for the most recent state transition. + */ + StateReason?: StateReason; + /** + * Any tags assigned to the instance. + */ + Tags?: TagList; + /** + * The virtualization type of the instance. + */ + VirtualizationType?: VirtualizationType; + /** + * The CPU options for the instance. + */ + CpuOptions?: CpuOptions; + /** + * The ID of the Capacity Reservation. + */ + CapacityReservationId?: String; + /** + * Information about the Capacity Reservation targeting option. + */ + CapacityReservationSpecification?: CapacityReservationSpecificationResponse; + /** + * Indicates whether the instance is enabled for hibernation. + */ + HibernationOptions?: HibernationOptions; + /** + * The license configurations. + */ + Licenses?: LicenseList; + } + export interface InstanceAttribute { + /** + * The security groups associated with the instance. + */ + Groups?: GroupIdentifierList; + /** + * The block device mapping of the instance. + */ + BlockDeviceMappings?: InstanceBlockDeviceMappingList; + /** + * If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can. + */ + DisableApiTermination?: AttributeBooleanValue; + /** + * Indicates whether enhanced networking with ENA is enabled. + */ + EnaSupport?: AttributeBooleanValue; + /** + * Indicates whether the instance is optimized for Amazon EBS I/O. + */ + EbsOptimized?: AttributeBooleanValue; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + */ + InstanceInitiatedShutdownBehavior?: AttributeValue; + /** + * The instance type. + */ + InstanceType?: AttributeValue; + /** + * The kernel ID. + */ + KernelId?: AttributeValue; + /** + * A list of product codes. + */ + ProductCodes?: ProductCodeList; + /** + * The RAM disk ID. + */ + RamdiskId?: AttributeValue; + /** + * The device name of the root device volume (for example, /dev/sda1). + */ + RootDeviceName?: AttributeValue; + /** + * Indicates whether source/destination checking is enabled. A value of true means that checking is enabled, and false means that checking is disabled. This value must be false for a NAT instance to perform NAT. + */ + SourceDestCheck?: AttributeBooleanValue; + /** + * Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. + */ + SriovNetSupport?: AttributeValue; + /** + * The user data. + */ + UserData?: AttributeValue; + } + export type InstanceAttributeName = "instanceType"|"kernel"|"ramdisk"|"userData"|"disableApiTermination"|"instanceInitiatedShutdownBehavior"|"rootDeviceName"|"blockDeviceMapping"|"productCodes"|"sourceDestCheck"|"groupSet"|"ebsOptimized"|"sriovNetSupport"|"enaSupport"|string; + export interface InstanceBlockDeviceMapping { + /** + * The device name (for example, /dev/sdh or xvdh). + */ + DeviceName?: String; + /** + * Parameters used to automatically set up EBS volumes when the instance is launched. + */ + Ebs?: EbsInstanceBlockDevice; + } + export type InstanceBlockDeviceMappingList = InstanceBlockDeviceMapping[]; + export interface InstanceBlockDeviceMappingSpecification { + /** + * The device name (for example, /dev/sdh or xvdh). + */ + DeviceName?: String; + /** + * Parameters used to automatically set up EBS volumes when the instance is launched. + */ + Ebs?: EbsInstanceBlockDeviceSpecification; + /** + * suppress the specified device included in the block device mapping. + */ + NoDevice?: String; + /** + * The virtual device name. + */ + VirtualName?: String; + } + export type InstanceBlockDeviceMappingSpecificationList = InstanceBlockDeviceMappingSpecification[]; + export interface InstanceCapacity { + /** + * The number of instances that can still be launched onto the Dedicated Host. + */ + AvailableCapacity?: Integer; + /** + * The instance type size supported by the Dedicated Host. + */ + InstanceType?: String; + /** + * The total number of instances that can be launched onto the Dedicated Host. + */ + TotalCapacity?: Integer; + } + export interface InstanceCount { + /** + * The number of listed Reserved Instances in the state specified by the state. + */ + InstanceCount?: Integer; + /** + * The states of the listed Reserved Instances. + */ + State?: ListingState; + } + export type InstanceCountList = InstanceCount[]; + export interface InstanceCreditSpecification { + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The credit option for CPU usage of the instance. Valid values are standard and unlimited. + */ + CpuCredits?: String; + } + export type InstanceCreditSpecificationList = InstanceCreditSpecification[]; + export type InstanceCreditSpecificationListRequest = InstanceCreditSpecificationRequest[]; + export interface InstanceCreditSpecificationRequest { + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The credit option for CPU usage of the instance. Valid values are standard and unlimited. + */ + CpuCredits?: String; + } + export type InstanceEventId = string; + export interface InstanceExportDetails { + /** + * The ID of the resource being exported. + */ + InstanceId?: String; + /** + * The target virtualization environment. + */ + TargetEnvironment?: ExportEnvironment; + } + export type InstanceHealthStatus = "healthy"|"unhealthy"|string; + export type InstanceId = string; + export type InstanceIdSet = String[]; + export type InstanceIdStringList = String[]; + export type InstanceIdsSet = InstanceId[]; + export type InstanceInterruptionBehavior = "hibernate"|"stop"|"terminate"|string; + export interface InstanceIpv6Address { + /** + * The IPv6 address. + */ + Ipv6Address?: String; + } + export type InstanceIpv6AddressList = InstanceIpv6Address[]; + export type InstanceIpv6AddressListRequest = InstanceIpv6AddressRequest[]; + export interface InstanceIpv6AddressRequest { + /** + * The IPv6 address. + */ + Ipv6Address?: String; + } + export type InstanceLifecycle = "spot"|"on-demand"|string; + export type InstanceLifecycleType = "spot"|"scheduled"|string; + export type InstanceList = Instance[]; + export interface InstanceMarketOptionsRequest { + /** + * The market type. + */ + MarketType?: MarketType; + /** + * The options for Spot Instances. + */ + SpotOptions?: SpotMarketOptions; + } + export type InstanceMatchCriteria = "open"|"targeted"|string; + export interface InstanceMonitoring { + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The monitoring for the instance. + */ + Monitoring?: Monitoring; + } + export type InstanceMonitoringList = InstanceMonitoring[]; + export interface InstanceNetworkInterface { + /** + * The association information for an Elastic IPv4 associated with the network interface. + */ + Association?: InstanceNetworkInterfaceAssociation; + /** + * The network interface attachment. + */ + Attachment?: InstanceNetworkInterfaceAttachment; + /** + * The description. + */ + Description?: String; + /** + * One or more security groups. + */ + Groups?: GroupIdentifierList; + /** + * One or more IPv6 addresses associated with the network interface. + */ + Ipv6Addresses?: InstanceIpv6AddressList; + /** + * The MAC address. + */ + MacAddress?: String; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The ID of the AWS account that created the network interface. + */ + OwnerId?: String; + /** + * The private DNS name. + */ + PrivateDnsName?: String; + /** + * The IPv4 address of the network interface within the subnet. + */ + PrivateIpAddress?: String; + /** + * One or more private IPv4 addresses associated with the network interface. + */ + PrivateIpAddresses?: InstancePrivateIpAddressList; + /** + * Indicates whether to validate network traffic to or from this network interface. + */ + SourceDestCheck?: Boolean; + /** + * The status of the network interface. + */ + Status?: NetworkInterfaceStatus; + /** + * The ID of the subnet. + */ + SubnetId?: String; + /** + * The ID of the VPC. + */ + VpcId?: String; + /** + * Describes the type of network interface. + */ + InterfaceType?: String; + } + export interface InstanceNetworkInterfaceAssociation { + /** + * The ID of the owner of the Elastic IP address. + */ + IpOwnerId?: String; + /** + * The public DNS name. + */ + PublicDnsName?: String; + /** + * The public IP address or Elastic IP address bound to the network interface. + */ + PublicIp?: String; + } + export interface InstanceNetworkInterfaceAttachment { + /** + * The time stamp when the attachment initiated. + */ + AttachTime?: DateTime; + /** + * The ID of the network interface attachment. + */ + AttachmentId?: String; + /** + * Indicates whether the network interface is deleted when the instance is terminated. + */ + DeleteOnTermination?: Boolean; + /** + * The index of the device on the instance for the network interface attachment. + */ + DeviceIndex?: Integer; + /** + * The attachment state. + */ + Status?: AttachmentStatus; + } + export type InstanceNetworkInterfaceList = InstanceNetworkInterface[]; + export interface InstanceNetworkInterfaceSpecification { + /** + * Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true. + */ + AssociatePublicIpAddress?: Boolean; + /** + * If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance. + */ + DeleteOnTermination?: Boolean; + /** + * The description of the network interface. Applies only if creating a network interface when launching an instance. + */ + Description?: String; + /** + * The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index. + */ + DeviceIndex?: Integer; + /** + * The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. + */ + Groups?: SecurityGroupIdStringList; + /** + * A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. + */ + Ipv6AddressCount?: Integer; + /** + * One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. + */ + Ipv6Addresses?: InstanceIpv6AddressList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request. + */ + PrivateIpAddress?: String; + /** + * One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request. + */ + PrivateIpAddresses?: PrivateIpAddressSpecificationList; + /** + * The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request. + */ + SecondaryPrivateIpAddressCount?: Integer; + /** + * The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance. + */ + SubnetId?: String; + /** + * The type of interface. + */ + InterfaceType?: String; + } + export type InstanceNetworkInterfaceSpecificationList = InstanceNetworkInterfaceSpecification[]; + export interface InstancePrivateIpAddress { + /** + * The association information for an Elastic IP address for the network interface. + */ + Association?: InstanceNetworkInterfaceAssociation; + /** + * Indicates whether this IPv4 address is the primary private IP address of the network interface. + */ + Primary?: Boolean; + /** + * The private IPv4 DNS name. + */ + PrivateDnsName?: String; + /** + * The private IPv4 address of the network interface. + */ + PrivateIpAddress?: String; + } + export type InstancePrivateIpAddressList = InstancePrivateIpAddress[]; + export interface InstanceState { + /** + * The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: 0 : pending 16 : running 32 : shutting-down 48 : terminated 64 : stopping 80 : stopped You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. + */ + Code?: Integer; + /** + * The current state of the instance. + */ + Name?: InstanceStateName; + } + export interface InstanceStateChange { + /** + * The current state of the instance. + */ + CurrentState?: InstanceState; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The previous state of the instance. + */ + PreviousState?: InstanceState; + } + export type InstanceStateChangeList = InstanceStateChange[]; + export type InstanceStateName = "pending"|"running"|"shutting-down"|"terminated"|"stopping"|"stopped"|string; + export interface InstanceStatus { + /** + * The Availability Zone of the instance. + */ + AvailabilityZone?: String; + /** + * Any scheduled events associated with the instance. + */ + Events?: InstanceStatusEventList; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state. + */ + InstanceState?: InstanceState; + /** + * Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability. + */ + InstanceStatus?: InstanceStatusSummary; + /** + * Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems. + */ + SystemStatus?: InstanceStatusSummary; + } + export interface InstanceStatusDetails { + /** + * The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched. + */ + ImpairedSince?: DateTime; + /** + * The type of instance status. + */ + Name?: StatusName; + /** + * The status. + */ + Status?: StatusType; + } + export type InstanceStatusDetailsList = InstanceStatusDetails[]; + export interface InstanceStatusEvent { + /** + * The ID of the event. + */ + InstanceEventId?: InstanceEventId; + /** + * The event code. + */ + Code?: EventCode; + /** + * A description of the event. After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed]. + */ + Description?: String; + /** + * The latest scheduled end time for the event. + */ + NotAfter?: DateTime; + /** + * The earliest scheduled start time for the event. + */ + NotBefore?: DateTime; + /** + * The deadline for starting the event. + */ + NotBeforeDeadline?: DateTime; + } + export type InstanceStatusEventList = InstanceStatusEvent[]; + export type InstanceStatusList = InstanceStatus[]; + export interface InstanceStatusSummary { + /** + * The system instance health or application instance health. + */ + Details?: InstanceStatusDetailsList; + /** + * The status. + */ + Status?: SummaryStatus; + } + export type InstanceType = "t1.micro"|"t2.nano"|"t2.micro"|"t2.small"|"t2.medium"|"t2.large"|"t2.xlarge"|"t2.2xlarge"|"t3.nano"|"t3.micro"|"t3.small"|"t3.medium"|"t3.large"|"t3.xlarge"|"t3.2xlarge"|"t3a.nano"|"t3a.micro"|"t3a.small"|"t3a.medium"|"t3a.large"|"t3a.xlarge"|"t3a.2xlarge"|"m1.small"|"m1.medium"|"m1.large"|"m1.xlarge"|"m3.medium"|"m3.large"|"m3.xlarge"|"m3.2xlarge"|"m4.large"|"m4.xlarge"|"m4.2xlarge"|"m4.4xlarge"|"m4.10xlarge"|"m4.16xlarge"|"m2.xlarge"|"m2.2xlarge"|"m2.4xlarge"|"cr1.8xlarge"|"r3.large"|"r3.xlarge"|"r3.2xlarge"|"r3.4xlarge"|"r3.8xlarge"|"r4.large"|"r4.xlarge"|"r4.2xlarge"|"r4.4xlarge"|"r4.8xlarge"|"r4.16xlarge"|"r5.large"|"r5.xlarge"|"r5.2xlarge"|"r5.4xlarge"|"r5.12xlarge"|"r5.24xlarge"|"r5.metal"|"r5a.large"|"r5a.xlarge"|"r5a.2xlarge"|"r5a.4xlarge"|"r5a.12xlarge"|"r5a.24xlarge"|"r5d.large"|"r5d.xlarge"|"r5d.2xlarge"|"r5d.4xlarge"|"r5d.12xlarge"|"r5d.24xlarge"|"r5d.metal"|"r5ad.large"|"r5ad.xlarge"|"r5ad.2xlarge"|"r5ad.4xlarge"|"r5ad.8xlarge"|"r5ad.12xlarge"|"r5ad.16xlarge"|"r5ad.24xlarge"|"x1.16xlarge"|"x1.32xlarge"|"x1e.xlarge"|"x1e.2xlarge"|"x1e.4xlarge"|"x1e.8xlarge"|"x1e.16xlarge"|"x1e.32xlarge"|"i2.xlarge"|"i2.2xlarge"|"i2.4xlarge"|"i2.8xlarge"|"i3.large"|"i3.xlarge"|"i3.2xlarge"|"i3.4xlarge"|"i3.8xlarge"|"i3.16xlarge"|"i3.metal"|"hi1.4xlarge"|"hs1.8xlarge"|"c1.medium"|"c1.xlarge"|"c3.large"|"c3.xlarge"|"c3.2xlarge"|"c3.4xlarge"|"c3.8xlarge"|"c4.large"|"c4.xlarge"|"c4.2xlarge"|"c4.4xlarge"|"c4.8xlarge"|"c5.large"|"c5.xlarge"|"c5.2xlarge"|"c5.4xlarge"|"c5.9xlarge"|"c5.18xlarge"|"c5d.large"|"c5d.xlarge"|"c5d.2xlarge"|"c5d.4xlarge"|"c5d.9xlarge"|"c5d.18xlarge"|"c5n.large"|"c5n.xlarge"|"c5n.2xlarge"|"c5n.4xlarge"|"c5n.9xlarge"|"c5n.18xlarge"|"cc1.4xlarge"|"cc2.8xlarge"|"g2.2xlarge"|"g2.8xlarge"|"g3.4xlarge"|"g3.8xlarge"|"g3.16xlarge"|"g3s.xlarge"|"cg1.4xlarge"|"p2.xlarge"|"p2.8xlarge"|"p2.16xlarge"|"p3.2xlarge"|"p3.8xlarge"|"p3.16xlarge"|"p3dn.24xlarge"|"d2.xlarge"|"d2.2xlarge"|"d2.4xlarge"|"d2.8xlarge"|"f1.2xlarge"|"f1.4xlarge"|"f1.16xlarge"|"m5.large"|"m5.xlarge"|"m5.2xlarge"|"m5.4xlarge"|"m5.12xlarge"|"m5.24xlarge"|"m5.metal"|"m5a.large"|"m5a.xlarge"|"m5a.2xlarge"|"m5a.4xlarge"|"m5a.12xlarge"|"m5a.24xlarge"|"m5d.large"|"m5d.xlarge"|"m5d.2xlarge"|"m5d.4xlarge"|"m5d.12xlarge"|"m5d.24xlarge"|"m5d.metal"|"m5ad.large"|"m5ad.xlarge"|"m5ad.2xlarge"|"m5ad.4xlarge"|"m5ad.8xlarge"|"m5ad.12xlarge"|"m5ad.16xlarge"|"m5ad.24xlarge"|"h1.2xlarge"|"h1.4xlarge"|"h1.8xlarge"|"h1.16xlarge"|"z1d.large"|"z1d.xlarge"|"z1d.2xlarge"|"z1d.3xlarge"|"z1d.6xlarge"|"z1d.12xlarge"|"z1d.metal"|"u-6tb1.metal"|"u-9tb1.metal"|"u-12tb1.metal"|"a1.medium"|"a1.large"|"a1.xlarge"|"a1.2xlarge"|"a1.4xlarge"|string; + export type InstanceTypeList = InstanceType[]; + export type Integer = number; + export type InterfacePermissionType = "INSTANCE-ATTACH"|"EIP-ASSOCIATE"|string; + export interface InternetGateway { + /** + * Any VPCs attached to the internet gateway. + */ + Attachments?: InternetGatewayAttachmentList; + /** + * The ID of the internet gateway. + */ + InternetGatewayId?: String; + /** + * The ID of the AWS account that owns the internet gateway. + */ + OwnerId?: String; + /** + * Any tags assigned to the internet gateway. + */ + Tags?: TagList; + } + export interface InternetGatewayAttachment { + /** + * The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned. + */ + State?: AttachmentStatus; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export type InternetGatewayAttachmentList = InternetGatewayAttachment[]; + export type InternetGatewayList = InternetGateway[]; + export interface IpPermission { + /** + * The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. + */ + FromPort?: Integer; + /** + * The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers). [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + */ + IpProtocol?: String; + /** + * The IPv4 ranges. + */ + IpRanges?: IpRangeList; + /** + * [VPC only] The IPv6 ranges. + */ + Ipv6Ranges?: Ipv6RangeList; + /** + * [VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group. + */ + PrefixListIds?: PrefixListIdList; + /** + * The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. + */ + ToPort?: Integer; + /** + * The security group and AWS account ID pairs. + */ + UserIdGroupPairs?: UserIdGroupPairList; + } + export type IpPermissionList = IpPermission[]; + export interface IpRange { + /** + * The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. + */ + CidrIp?: String; + /** + * A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* + */ + Description?: String; + } + export type IpRangeList = IpRange[]; + export type IpRanges = String[]; + export type Ipv6Address = string; + export type Ipv6AddressList = String[]; + export interface Ipv6CidrBlock { + /** + * The IPv6 CIDR block. + */ + Ipv6CidrBlock?: String; + } + export type Ipv6CidrBlockSet = Ipv6CidrBlock[]; + export interface Ipv6Range { + /** + * The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. + */ + CidrIpv6?: String; + /** + * A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* + */ + Description?: String; + } + export type Ipv6RangeList = Ipv6Range[]; + export type Ipv6SupportValue = "enable"|"disable"|string; + export type KeyNameStringList = String[]; + export interface KeyPair { + /** + * The SHA-1 digest of the DER encoded private key. + */ + KeyFingerprint?: String; + /** + * An unencrypted PEM encoded RSA private key. + */ + KeyMaterial?: String; + /** + * The name of the key pair. + */ + KeyName?: String; + } + export interface KeyPairInfo { + /** + * If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716. + */ + KeyFingerprint?: String; + /** + * The name of the key pair. + */ + KeyName?: String; + } + export type KeyPairList = KeyPairInfo[]; + export interface LaunchPermission { + /** + * The name of the group. + */ + Group?: PermissionGroup; + /** + * The AWS account ID. + */ + UserId?: String; + } + export type LaunchPermissionList = LaunchPermission[]; + export interface LaunchPermissionModifications { + /** + * The AWS account ID to add to the list of launch permissions for the AMI. + */ + Add?: LaunchPermissionList; + /** + * The AWS account ID to remove from the list of launch permissions for the AMI. + */ + Remove?: LaunchPermissionList; + } + export interface LaunchSpecification { + /** + * The Base64-encoded user data for the instance. + */ + UserData?: String; + /** + * One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups. + */ + SecurityGroups?: GroupIdentifierList; + /** + * Deprecated. + */ + AddressingType?: String; + /** + * One or more block device mapping entries. + */ + BlockDeviceMappings?: BlockDeviceMappingList; + /** + * Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. Default: false + */ + EbsOptimized?: Boolean; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: IamInstanceProfileSpecification; + /** + * The ID of the AMI. + */ + ImageId?: String; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The ID of the kernel. + */ + KernelId?: String; + /** + * The name of the key pair. + */ + KeyName?: String; + /** + * One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface. + */ + NetworkInterfaces?: InstanceNetworkInterfaceSpecificationList; + /** + * The placement information for the instance. + */ + Placement?: SpotPlacement; + /** + * The ID of the RAM disk. + */ + RamdiskId?: String; + /** + * The ID of the subnet in which to launch the instance. + */ + SubnetId?: String; + Monitoring?: RunInstancesMonitoringEnabled; + } + export type LaunchSpecsList = SpotFleetLaunchSpecification[]; + export interface LaunchTemplate { + /** + * The ID of the launch template. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The time launch template was created. + */ + CreateTime?: DateTime; + /** + * The principal that created the launch template. + */ + CreatedBy?: String; + /** + * The version number of the default version of the launch template. + */ + DefaultVersionNumber?: Long; + /** + * The version number of the latest version of the launch template. + */ + LatestVersionNumber?: Long; + /** + * The tags for the launch template. + */ + Tags?: TagList; + } + export interface LaunchTemplateAndOverridesResponse { + /** + * The launch template. + */ + LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + /** + * Any parameters that you specify override the same parameters in the launch template. + */ + Overrides?: FleetLaunchTemplateOverrides; + } + export interface LaunchTemplateBlockDeviceMapping { + /** + * The device name. + */ + DeviceName?: String; + /** + * The virtual device name (ephemeralN). + */ + VirtualName?: String; + /** + * Information about the block device for an EBS volume. + */ + Ebs?: LaunchTemplateEbsBlockDevice; + /** + * Suppresses the specified device included in the block device mapping of the AMI. + */ + NoDevice?: String; + } + export type LaunchTemplateBlockDeviceMappingList = LaunchTemplateBlockDeviceMapping[]; + export interface LaunchTemplateBlockDeviceMappingRequest { + /** + * The device name (for example, /dev/sdh or xvdh). + */ + DeviceName?: String; + /** + * The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. + */ + VirtualName?: String; + /** + * Parameters used to automatically set up EBS volumes when the instance is launched. + */ + Ebs?: LaunchTemplateEbsBlockDeviceRequest; + /** + * Suppresses the specified device included in the block device mapping of the AMI. + */ + NoDevice?: String; + } + export type LaunchTemplateBlockDeviceMappingRequestList = LaunchTemplateBlockDeviceMappingRequest[]; + export interface LaunchTemplateCapacityReservationSpecificationRequest { + /** + * Indicates the instance's Capacity Reservation preferences. Possible preferences include: open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. + */ + CapacityReservationPreference?: CapacityReservationPreference; + /** + * Information about the target Capacity Reservation. + */ + CapacityReservationTarget?: CapacityReservationTarget; + } + export interface LaunchTemplateCapacityReservationSpecificationResponse { + /** + * Indicates the instance's Capacity Reservation preferences. Possible preferences include: open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. + */ + CapacityReservationPreference?: CapacityReservationPreference; + /** + * Information about the target Capacity Reservation. + */ + CapacityReservationTarget?: CapacityReservationTargetResponse; + } + export interface LaunchTemplateConfig { + /** + * The launch template. + */ + LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + /** + * Any parameters that you specify override the same parameters in the launch template. + */ + Overrides?: LaunchTemplateOverridesList; + } + export type LaunchTemplateConfigList = LaunchTemplateConfig[]; + export interface LaunchTemplateCpuOptions { + /** + * The number of CPU cores for the instance. + */ + CoreCount?: Integer; + /** + * The number of threads per CPU core. + */ + ThreadsPerCore?: Integer; + } + export interface LaunchTemplateCpuOptionsRequest { + /** + * The number of CPU cores for the instance. + */ + CoreCount?: Integer; + /** + * The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2. + */ + ThreadsPerCore?: Integer; + } + export interface LaunchTemplateEbsBlockDevice { + /** + * Indicates whether the EBS volume is encrypted. + */ + Encrypted?: Boolean; + /** + * Indicates whether the EBS volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + /** + * The number of I/O operations per second (IOPS) that the volume supports. + */ + Iops?: Integer; + /** + * The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. + */ + KmsKeyId?: String; + /** + * The ID of the snapshot. + */ + SnapshotId?: String; + /** + * The size of the volume, in GiB. + */ + VolumeSize?: Integer; + /** + * The volume type. + */ + VolumeType?: VolumeType; + } + export interface LaunchTemplateEbsBlockDeviceRequest { + /** + * Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. + */ + Encrypted?: Boolean; + /** + * Indicates whether the EBS volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + /** + * The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. + */ + Iops?: Integer; + /** + * The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. + */ + KmsKeyId?: String; + /** + * The ID of the snapshot. + */ + SnapshotId?: String; + /** + * The size of the volume, in GiB. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. + */ + VolumeSize?: Integer; + /** + * The volume type. + */ + VolumeType?: VolumeType; + } + export interface LaunchTemplateElasticInferenceAccelerator { + /** + * The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. + */ + Type: String; + } + export type LaunchTemplateElasticInferenceAcceleratorList = LaunchTemplateElasticInferenceAccelerator[]; + export interface LaunchTemplateElasticInferenceAcceleratorResponse { + /** + * The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. + */ + Type?: String; + } + export type LaunchTemplateElasticInferenceAcceleratorResponseList = LaunchTemplateElasticInferenceAcceleratorResponse[]; + export type LaunchTemplateErrorCode = "launchTemplateIdDoesNotExist"|"launchTemplateIdMalformed"|"launchTemplateNameDoesNotExist"|"launchTemplateNameMalformed"|"launchTemplateVersionDoesNotExist"|"unexpectedError"|string; + export interface LaunchTemplateHibernationOptions { + /** + * If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation. + */ + Configured?: Boolean; + } + export interface LaunchTemplateHibernationOptionsRequest { + /** + * If you set this parameter to true, the instance is enabled for hibernation. Default: false + */ + Configured?: Boolean; + } + export interface LaunchTemplateIamInstanceProfileSpecification { + /** + * The Amazon Resource Name (ARN) of the instance profile. + */ + Arn?: String; + /** + * The name of the instance profile. + */ + Name?: String; + } + export interface LaunchTemplateIamInstanceProfileSpecificationRequest { + /** + * The Amazon Resource Name (ARN) of the instance profile. + */ + Arn?: String; + /** + * The name of the instance profile. + */ + Name?: String; + } + export interface LaunchTemplateInstanceMarketOptions { + /** + * The market type. + */ + MarketType?: MarketType; + /** + * The options for Spot Instances. + */ + SpotOptions?: LaunchTemplateSpotMarketOptions; + } + export interface LaunchTemplateInstanceMarketOptionsRequest { + /** + * The market type. + */ + MarketType?: MarketType; + /** + * The options for Spot Instances. + */ + SpotOptions?: LaunchTemplateSpotMarketOptionsRequest; + } + export interface LaunchTemplateInstanceNetworkInterfaceSpecification { + /** + * Indicates whether to associate a public IPv4 address with eth0 for a new network interface. + */ + AssociatePublicIpAddress?: Boolean; + /** + * Indicates whether the network interface is deleted when the instance is terminated. + */ + DeleteOnTermination?: Boolean; + /** + * A description for the network interface. + */ + Description?: String; + /** + * The device index for the network interface attachment. + */ + DeviceIndex?: Integer; + /** + * The IDs of one or more security groups. + */ + Groups?: GroupIdStringList; + /** + * The type of network interface. + */ + InterfaceType?: String; + /** + * The number of IPv6 addresses for the network interface. + */ + Ipv6AddressCount?: Integer; + /** + * The IPv6 addresses for the network interface. + */ + Ipv6Addresses?: InstanceIpv6AddressList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The primary private IPv4 address of the network interface. + */ + PrivateIpAddress?: String; + /** + * One or more private IPv4 addresses. + */ + PrivateIpAddresses?: PrivateIpAddressSpecificationList; + /** + * The number of secondary private IPv4 addresses for the network interface. + */ + SecondaryPrivateIpAddressCount?: Integer; + /** + * The ID of the subnet for the network interface. + */ + SubnetId?: String; + } + export type LaunchTemplateInstanceNetworkInterfaceSpecificationList = LaunchTemplateInstanceNetworkInterfaceSpecification[]; + export interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest { + /** + * Associates a public IPv4 address with eth0 for a new network interface. + */ + AssociatePublicIpAddress?: Boolean; + /** + * Indicates whether the network interface is deleted when the instance is terminated. + */ + DeleteOnTermination?: Boolean; + /** + * A description for the network interface. + */ + Description?: String; + /** + * The device index for the network interface attachment. + */ + DeviceIndex?: Integer; + /** + * The IDs of one or more security groups. + */ + Groups?: SecurityGroupIdStringList; + /** + * The type of networking interface. + */ + InterfaceType?: String; + /** + * The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. + */ + Ipv6AddressCount?: Integer; + /** + * One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. + */ + Ipv6Addresses?: InstanceIpv6AddressListRequest; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The primary private IPv4 address of the network interface. + */ + PrivateIpAddress?: String; + /** + * One or more private IPv4 addresses. + */ + PrivateIpAddresses?: PrivateIpAddressSpecificationList; + /** + * The number of secondary private IPv4 addresses to assign to a network interface. + */ + SecondaryPrivateIpAddressCount?: Integer; + /** + * The ID of the subnet for the network interface. + */ + SubnetId?: String; + } + export type LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList = LaunchTemplateInstanceNetworkInterfaceSpecificationRequest[]; + export interface LaunchTemplateLicenseConfiguration { + /** + * The Amazon Resource Name (ARN) of the license configuration. + */ + LicenseConfigurationArn?: String; + } + export interface LaunchTemplateLicenseConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the license configuration. + */ + LicenseConfigurationArn?: String; + } + export type LaunchTemplateLicenseList = LaunchTemplateLicenseConfiguration[]; + export type LaunchTemplateLicenseSpecificationListRequest = LaunchTemplateLicenseConfigurationRequest[]; + export type LaunchTemplateName = string; + export type LaunchTemplateNameStringList = LaunchTemplateName[]; + export interface LaunchTemplateOverrides { + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The maximum price per unit hour that you are willing to pay for a Spot Instance. + */ + SpotPrice?: String; + /** + * The ID of the subnet in which to launch the instances. + */ + SubnetId?: String; + /** + * The Availability Zone in which to launch the instances. + */ + AvailabilityZone?: String; + /** + * The number of units provided by the specified instance type. + */ + WeightedCapacity?: Double; + /** + * The priority for the launch template override. If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. + */ + Priority?: Double; + } + export type LaunchTemplateOverridesList = LaunchTemplateOverrides[]; + export interface LaunchTemplatePlacement { + /** + * The Availability Zone of the instance. + */ + AvailabilityZone?: String; + /** + * The affinity setting for the instance on the Dedicated Host. + */ + Affinity?: String; + /** + * The name of the placement group for the instance. + */ + GroupName?: String; + /** + * The ID of the Dedicated Host for the instance. + */ + HostId?: String; + /** + * The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. + */ + Tenancy?: Tenancy; + /** + * Reserved for future use. + */ + SpreadDomain?: String; + } + export interface LaunchTemplatePlacementRequest { + /** + * The Availability Zone for the instance. + */ + AvailabilityZone?: String; + /** + * The affinity setting for an instance on a Dedicated Host. + */ + Affinity?: String; + /** + * The name of the placement group for the instance. + */ + GroupName?: String; + /** + * The ID of the Dedicated Host for the instance. + */ + HostId?: String; + /** + * The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. + */ + Tenancy?: Tenancy; + /** + * Reserved for future use. + */ + SpreadDomain?: String; + } + export type LaunchTemplateSet = LaunchTemplate[]; + export interface LaunchTemplateSpecification { + /** + * The ID of the launch template. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. + */ + LaunchTemplateName?: String; + /** + * The version number of the launch template. Default: The default version for the launch template. + */ + Version?: String; + } + export interface LaunchTemplateSpotMarketOptions { + /** + * The maximum hourly price you're willing to pay for the Spot Instances. + */ + MaxPrice?: String; + /** + * The Spot Instance request type. + */ + SpotInstanceType?: SpotInstanceType; + /** + * The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). + */ + BlockDurationMinutes?: Integer; + /** + * The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. + */ + ValidUntil?: DateTime; + /** + * The behavior when a Spot Instance is interrupted. + */ + InstanceInterruptionBehavior?: InstanceInterruptionBehavior; + } + export interface LaunchTemplateSpotMarketOptionsRequest { + /** + * The maximum hourly price you're willing to pay for the Spot Instances. + */ + MaxPrice?: String; + /** + * The Spot Instance request type. + */ + SpotInstanceType?: SpotInstanceType; + /** + * The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). + */ + BlockDurationMinutes?: Integer; + /** + * The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date. + */ + ValidUntil?: DateTime; + /** + * The behavior when a Spot Instance is interrupted. The default is terminate. + */ + InstanceInterruptionBehavior?: InstanceInterruptionBehavior; + } + export interface LaunchTemplateTagSpecification { + /** + * The type of resource. + */ + ResourceType?: ResourceType; + /** + * The tags for the resource. + */ + Tags?: TagList; + } + export type LaunchTemplateTagSpecificationList = LaunchTemplateTagSpecification[]; + export interface LaunchTemplateTagSpecificationRequest { + /** + * The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags. + */ + ResourceType?: ResourceType; + /** + * The tags to apply to the resource. + */ + Tags?: TagList; + } + export type LaunchTemplateTagSpecificationRequestList = LaunchTemplateTagSpecificationRequest[]; + export interface LaunchTemplateVersion { + /** + * The ID of the launch template. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The version number. + */ + VersionNumber?: Long; + /** + * The description for the version. + */ + VersionDescription?: VersionDescription; + /** + * The time the version was created. + */ + CreateTime?: DateTime; + /** + * The principal that created the version. + */ + CreatedBy?: String; + /** + * Indicates whether the version is the default version. + */ + DefaultVersion?: Boolean; + /** + * Information about the launch template. + */ + LaunchTemplateData?: ResponseLaunchTemplateData; + } + export type LaunchTemplateVersionSet = LaunchTemplateVersion[]; + export interface LaunchTemplatesMonitoring { + /** + * Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. + */ + Enabled?: Boolean; + } + export interface LaunchTemplatesMonitoringRequest { + /** + * Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled. + */ + Enabled?: Boolean; + } + export interface LicenseConfiguration { + /** + * The Amazon Resource Name (ARN) of the license configuration. + */ + LicenseConfigurationArn?: String; + } + export interface LicenseConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the license configuration. + */ + LicenseConfigurationArn?: String; + } + export type LicenseList = LicenseConfiguration[]; + export type LicenseSpecificationListRequest = LicenseConfigurationRequest[]; + export type ListingState = "available"|"sold"|"cancelled"|"pending"|string; + export type ListingStatus = "active"|"pending"|"cancelled"|"closed"|string; + export interface LoadBalancersConfig { + /** + * The Classic Load Balancers. + */ + ClassicLoadBalancersConfig?: ClassicLoadBalancersConfig; + /** + * The target groups. + */ + TargetGroupsConfig?: TargetGroupsConfig; + } + export interface LoadPermission { + /** + * The AWS account ID. + */ + UserId?: String; + /** + * The name of the group. + */ + Group?: PermissionGroup; + } + export type LoadPermissionList = LoadPermission[]; + export type LoadPermissionListRequest = LoadPermissionRequest[]; + export interface LoadPermissionModifications { + /** + * The load permissions to add. + */ + Add?: LoadPermissionListRequest; + /** + * The load permissions to remove. + */ + Remove?: LoadPermissionListRequest; + } + export interface LoadPermissionRequest { + /** + * The name of the group. + */ + Group?: PermissionGroup; + /** + * The AWS account ID. + */ + UserId?: String; + } + export type LogDestinationType = "cloud-watch-logs"|"s3"|string; + export type Long = number; + export type MarketType = "spot"|string; + export type MaxResults = number; + export type MillisecondDateTime = Date; + export interface ModifyCapacityReservationRequest { + /** + * The ID of the Capacity Reservation. + */ + CapacityReservationId: String; + /** + * The number of instances for which to reserve capacity. + */ + InstanceCount?: Integer; + /** + * The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019. You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited. + */ + EndDate?: DateTime; + /** + * Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited. limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited. + */ + EndDateType?: EndDateType; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifyCapacityReservationResult { + /** + * Information about the Capacity Reservation. + */ + Return?: Boolean; + } + export interface ModifyClientVpnEndpointRequest { + /** + * The ID of the Client VPN endpoint to modify. + */ + ClientVpnEndpointId: String; + /** + * The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM). + */ + ServerCertificateArn?: String; + /** + * Information about the client connection logging options. If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: Client connection requests Client connection results (successful and unsuccessful) Reasons for unsuccessful client connection requests Client connection termination time + */ + ConnectionLogOptions?: ConnectionLogOptions; + /** + * Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers. + */ + DnsServers?: DnsServersOptionsModifyStructure; + /** + * A brief description of the Client VPN endpoint. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifyClientVpnEndpointResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface ModifyFleetRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + */ + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy; + /** + * The ID of the EC2 Fleet. + */ + FleetId: FleetIdentifier; + /** + * The size of the EC2 Fleet. + */ + TargetCapacitySpecification: TargetCapacitySpecificationRequest; + } + export interface ModifyFleetResult { + /** + * Is true if the request succeeds, and an error otherwise. + */ + Return?: Boolean; + } + export interface ModifyFpgaImageAttributeRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the AFI. + */ + FpgaImageId: String; + /** + * The name of the attribute. + */ + Attribute?: FpgaImageAttributeName; + /** + * The operation type. + */ + OperationType?: OperationType; + /** + * The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute. + */ + UserIds?: UserIdStringList; + /** + * The user groups. This parameter is valid only when modifying the loadPermission attribute. + */ + UserGroups?: UserGroupStringList; + /** + * The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute. + */ + ProductCodes?: ProductCodeStringList; + /** + * The load permission for the AFI. + */ + LoadPermission?: LoadPermissionModifications; + /** + * A description for the AFI. + */ + Description?: String; + /** + * A name for the AFI. + */ + Name?: String; + } + export interface ModifyFpgaImageAttributeResult { + /** + * Information about the attribute. + */ + FpgaImageAttribute?: FpgaImageAttribute; + } + export interface ModifyHostsRequest { + /** + * Specify whether to enable or disable auto-placement. + */ + AutoPlacement: AutoPlacement; + /** + * The IDs of the Dedicated Hosts to modify. + */ + HostIds: RequestHostIdList; + } + export interface ModifyHostsResult { + /** + * The IDs of the Dedicated Hosts that were successfully modified. + */ + Successful?: ResponseHostIdList; + /** + * The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used. + */ + Unsuccessful?: UnsuccessfulItemList; + } + export interface ModifyIdFormatRequest { + /** + * The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs. + */ + Resource: String; + /** + * Indicate whether the resource should use longer IDs (17-character IDs). + */ + UseLongIds: Boolean; + } + export interface ModifyIdentityIdFormatRequest { + /** + * The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account. + */ + PrincipalArn: String; + /** + * The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs. + */ + Resource: String; + /** + * Indicates whether the resource should use longer IDs (17-character IDs) + */ + UseLongIds: Boolean; + } + export interface ModifyImageAttributeRequest { + /** + * The name of the attribute to modify. The valid values are description, launchPermission, and productCodes. + */ + Attribute?: String; + /** + * A new description for the AMI. + */ + Description?: AttributeValue; + /** + * The ID of the AMI. + */ + ImageId: String; + /** + * A new launch permission for the AMI. + */ + LaunchPermission?: LaunchPermissionModifications; + /** + * The operation type. This parameter can be used only when the Attribute parameter is launchPermission. + */ + OperationType?: OperationType; + /** + * The DevPay product codes. After you add a product code to an AMI, it can't be removed. + */ + ProductCodes?: ProductCodeStringList; + /** + * The user groups. This parameter can be used only when the Attribute parameter is launchPermission. + */ + UserGroups?: UserGroupStringList; + /** + * The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission. + */ + UserIds?: UserIdStringList; + /** + * The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes. + */ + Value?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifyInstanceAttributeRequest { + /** + * Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means that checking is disabled. This value must be false for a NAT instance to perform NAT. + */ + SourceDestCheck?: AttributeBooleanValue; + /** + * The name of the attribute. + */ + Attribute?: InstanceAttributeName; + /** + * Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide. + */ + BlockDeviceMappings?: InstanceBlockDeviceMappingSpecificationList; + /** + * If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances. + */ + DisableApiTermination?: AttributeBooleanValue; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. + */ + EbsOptimized?: AttributeBooleanValue; + /** + * Set to true to enable enhanced networking with ENA for the instance. This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable. + */ + EnaSupport?: AttributeBooleanValue; + /** + * [EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name. + */ + Groups?: GroupIdStringList; + /** + * The ID of the instance. + */ + InstanceId: String; + /** + * Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + */ + InstanceInitiatedShutdownBehavior?: AttributeValue; + /** + * Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue. + */ + InstanceType?: AttributeValue; + /** + * Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB. + */ + Kernel?: AttributeValue; + /** + * Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB. + */ + Ramdisk?: AttributeValue; + /** + * Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance. There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time. This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable. + */ + SriovNetSupport?: AttributeValue; + /** + * Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. + */ + UserData?: BlobAttributeValue; + /** + * A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute. + */ + Value?: String; + } + export interface ModifyInstanceCapacityReservationAttributesRequest { + /** + * The ID of the instance to be modified. + */ + InstanceId: String; + /** + * Information about the Capacity Reservation targeting option. + */ + CapacityReservationSpecification: CapacityReservationSpecification; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifyInstanceCapacityReservationAttributesResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface ModifyInstanceCreditSpecificationRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * Information about the credit option for CPU usage. + */ + InstanceCreditSpecifications: InstanceCreditSpecificationListRequest; + } + export interface ModifyInstanceCreditSpecificationResult { + /** + * Information about the instances whose credit option for CPU usage was successfully modified. + */ + SuccessfulInstanceCreditSpecifications?: SuccessfulInstanceCreditSpecificationSet; + /** + * Information about the instances whose credit option for CPU usage was not modified. + */ + UnsuccessfulInstanceCreditSpecifications?: UnsuccessfulInstanceCreditSpecificationSet; + } + export interface ModifyInstanceEventStartTimeRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance with the scheduled event. + */ + InstanceId: String; + /** + * The ID of the event whose date and time you are modifying. + */ + InstanceEventId: String; + /** + * The new date and time when the event will take place. + */ + NotBefore: DateTime; + } + export interface ModifyInstanceEventStartTimeResult { + Event?: InstanceStatusEvent; + } + export interface ModifyInstancePlacementRequest { + /** + * The affinity setting for the instance. + */ + Affinity?: Affinity; + /** + * The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated. To remove an instance from a placement group, specify an empty string (""). + */ + GroupName?: String; + /** + * The ID of the Dedicated Host with which to associate the instance. + */ + HostId?: String; + /** + * The ID of the instance that you are modifying. + */ + InstanceId: String; + /** + * The tenancy for the instance. + */ + Tenancy?: HostTenancy; + /** + * Reserved for future use. + */ + PartitionNumber?: Integer; + } + export interface ModifyInstancePlacementResult { + /** + * Is true if the request succeeds, and an error otherwise. + */ + Return?: Boolean; + } + export interface ModifyLaunchTemplateRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraint: Maximum 128 ASCII characters. + */ + ClientToken?: String; + /** + * The ID of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateId?: String; + /** + * The name of the launch template. You must specify either the launch template ID or launch template name in the request. + */ + LaunchTemplateName?: LaunchTemplateName; + /** + * The version number of the launch template to set as the default version. + */ + DefaultVersion?: String; + } + export interface ModifyLaunchTemplateResult { + /** + * Information about the launch template. + */ + LaunchTemplate?: LaunchTemplate; + } + export interface ModifyNetworkInterfaceAttributeRequest { + /** + * Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment. + */ + Attachment?: NetworkInterfaceAttachmentChanges; + /** + * A description for the network interface. + */ + Description?: AttributeValue; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name. + */ + Groups?: SecurityGroupIdStringList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + /** + * Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide. + */ + SourceDestCheck?: AttributeBooleanValue; + } + export interface ModifyReservedInstancesRequest { + /** + * The IDs of the Reserved Instances to modify. + */ + ReservedInstancesIds: ReservedInstancesIdStringList; + /** + * A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * The configuration settings for the Reserved Instances to modify. + */ + TargetConfigurations: ReservedInstancesConfigurationList; + } + export interface ModifyReservedInstancesResult { + /** + * The ID for the modification. + */ + ReservedInstancesModificationId?: String; + } + export interface ModifySnapshotAttributeRequest { + /** + * The snapshot attribute to modify. Only volume creation permissions can be modified. + */ + Attribute?: SnapshotAttributeName; + /** + * A JSON representation of the snapshot attribute modification. + */ + CreateVolumePermission?: CreateVolumePermissionModifications; + /** + * The group to modify for the snapshot. + */ + GroupNames?: GroupNameStringList; + /** + * The type of operation to perform to the attribute. + */ + OperationType?: OperationType; + /** + * The ID of the snapshot. + */ + SnapshotId: String; + /** + * The account ID to modify for the snapshot. + */ + UserIds?: UserIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifySpotFleetRequestRequest { + /** + * Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. + */ + ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId: String; + /** + * The size of the fleet. + */ + TargetCapacity?: Integer; + } + export interface ModifySpotFleetRequestResponse { + /** + * Is true if the request succeeds, and an error otherwise. + */ + Return?: Boolean; + } + export interface ModifySubnetAttributeRequest { + /** + * Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address). If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API. + */ + AssignIpv6AddressOnCreation?: AttributeBooleanValue; + /** + * Specify true to indicate that network interfaces created in the specified subnet should be assigned a public IPv4 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives a public IPv4 address). + */ + MapPublicIpOnLaunch?: AttributeBooleanValue; + /** + * The ID of the subnet. + */ + SubnetId: String; + } + export interface ModifyTransitGatewayVpcAttachmentRequest { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone. + */ + AddSubnetIds?: ValueStringList; + /** + * The IDs of one or more subnets to remove. + */ + RemoveSubnetIds?: ValueStringList; + /** + * The new VPC attachment options. + */ + Options?: ModifyTransitGatewayVpcAttachmentRequestOptions; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifyTransitGatewayVpcAttachmentRequestOptions { + /** + * Enable or disable DNS support. The default is enable. + */ + DnsSupport?: DnsSupportValue; + /** + * Enable or disable IPv6 support. The default is enable. + */ + Ipv6Support?: Ipv6SupportValue; + } + export interface ModifyTransitGatewayVpcAttachmentResult { + /** + * Information about the modified attachment. + */ + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + } + export interface ModifyVolumeAttributeRequest { + /** + * Indicates whether the volume should be auto-enabled for I/O operations. + */ + AutoEnableIO?: AttributeBooleanValue; + /** + * The ID of the volume. + */ + VolumeId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifyVolumeRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the volume. + */ + VolumeId: String; + /** + * The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see Amazon EBS Volume Types. Default: If no size is specified, the existing size is retained. + */ + Size?: Integer; + /** + * The target EBS volume type of the volume. Default: If no type is specified, the existing type is retained. + */ + VolumeType?: VolumeType; + /** + * The target IOPS rate of the volume. This is only valid for Provisioned IOPS SSD (io1) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes. Default: If no IOPS value is specified, the existing value is retained. + */ + Iops?: Integer; + } + export interface ModifyVolumeResult { + /** + * Information about the volume modification. + */ + VolumeModification?: VolumeModification; + } + export interface ModifyVpcAttributeRequest { + /** + * Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support. + */ + EnableDnsHostnames?: AttributeBooleanValue; + /** + * Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. + */ + EnableDnsSupport?: AttributeBooleanValue; + /** + * The ID of the VPC. + */ + VpcId: String; + } + export interface ModifyVpcEndpointConnectionNotificationRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the notification. + */ + ConnectionNotificationId: String; + /** + * The ARN for the SNS topic for the notification. + */ + ConnectionNotificationArn?: String; + /** + * One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject. + */ + ConnectionEvents?: ValueStringList; + } + export interface ModifyVpcEndpointConnectionNotificationResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + ReturnValue?: Boolean; + } + export interface ModifyVpcEndpointRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the endpoint. + */ + VpcEndpointId: String; + /** + * (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service. + */ + ResetPolicy?: Boolean; + /** + * A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service. + */ + PolicyDocument?: String; + /** + * (Gateway endpoint) One or more route tables IDs to associate with the endpoint. + */ + AddRouteTableIds?: ValueStringList; + /** + * (Gateway endpoint) One or more route table IDs to disassociate from the endpoint. + */ + RemoveRouteTableIds?: ValueStringList; + /** + * (Interface endpoint) One or more subnet IDs in which to serve the endpoint. + */ + AddSubnetIds?: ValueStringList; + /** + * (Interface endpoint) One or more subnets IDs in which to remove the endpoint. + */ + RemoveSubnetIds?: ValueStringList; + /** + * (Interface endpoint) One or more security group IDs to associate with the network interface. + */ + AddSecurityGroupIds?: ValueStringList; + /** + * (Interface endpoint) One or more security group IDs to disassociate from the network interface. + */ + RemoveSecurityGroupIds?: ValueStringList; + /** + * (Interface endpoint) Indicate whether a private hosted zone is associated with the VPC. + */ + PrivateDnsEnabled?: Boolean; + } + export interface ModifyVpcEndpointResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface ModifyVpcEndpointServiceConfigurationRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the service. + */ + ServiceId: String; + /** + * Indicate whether requests to create an endpoint to your service must be accepted. + */ + AcceptanceRequired?: Boolean; + /** + * The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration. + */ + AddNetworkLoadBalancerArns?: ValueStringList; + /** + * The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration. + */ + RemoveNetworkLoadBalancerArns?: ValueStringList; + } + export interface ModifyVpcEndpointServiceConfigurationResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface ModifyVpcEndpointServicePermissionsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the service. + */ + ServiceId: String; + /** + * The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). + */ + AddAllowedPrincipals?: ValueStringList; + /** + * The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list. + */ + RemoveAllowedPrincipals?: ValueStringList; + } + export interface ModifyVpcEndpointServicePermissionsResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + ReturnValue?: Boolean; + } + export interface ModifyVpcPeeringConnectionOptionsRequest { + /** + * The VPC peering connection options for the accepter VPC. + */ + AccepterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The VPC peering connection options for the requester VPC. + */ + RequesterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; + /** + * The ID of the VPC peering connection. + */ + VpcPeeringConnectionId: String; + } + export interface ModifyVpcPeeringConnectionOptionsResult { + /** + * Information about the VPC peering connection options for the accepter VPC. + */ + AccepterPeeringConnectionOptions?: PeeringConnectionOptions; + /** + * Information about the VPC peering connection options for the requester VPC. + */ + RequesterPeeringConnectionOptions?: PeeringConnectionOptions; + } + export interface ModifyVpcTenancyRequest { + /** + * The ID of the VPC. + */ + VpcId: String; + /** + * The instance tenancy attribute for the VPC. + */ + InstanceTenancy: VpcTenancy; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ModifyVpcTenancyResult { + /** + * Returns true if the request succeeds; otherwise, returns an error. + */ + ReturnValue?: Boolean; + } + export interface ModifyVpnConnectionRequest { + VpnConnectionId: String; + TransitGatewayId?: String; + VpnGatewayId?: String; + DryRun?: Boolean; + } + export interface ModifyVpnConnectionResult { + VpnConnection?: VpnConnection; + } + export interface MonitorInstancesRequest { + /** + * The IDs of the instances. + */ + InstanceIds: InstanceIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface MonitorInstancesResult { + /** + * The monitoring information. + */ + InstanceMonitorings?: InstanceMonitoringList; + } + export interface Monitoring { + /** + * Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. + */ + State?: MonitoringState; + } + export type MonitoringState = "disabled"|"disabling"|"enabled"|"pending"|string; + export interface MoveAddressToVpcRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The Elastic IP address. + */ + PublicIp: String; + } + export interface MoveAddressToVpcResult { + /** + * The allocation ID for the Elastic IP address. + */ + AllocationId?: String; + /** + * The status of the move of the IP address. + */ + Status?: Status; + } + export type MoveStatus = "movingToVpc"|"restoringToClassic"|string; + export interface MovingAddressStatus { + /** + * The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform. + */ + MoveStatus?: MoveStatus; + /** + * The Elastic IP address. + */ + PublicIp?: String; + } + export type MovingAddressStatusSet = MovingAddressStatus[]; + export interface NatGateway { + /** + * The date and time the NAT gateway was created. + */ + CreateTime?: DateTime; + /** + * The date and time the NAT gateway was deleted, if applicable. + */ + DeleteTime?: DateTime; + /** + * If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound) + */ + FailureCode?: String; + /** + * If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code. For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway" For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached" For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway" For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated" For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again." For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found." + */ + FailureMessage?: String; + /** + * Information about the IP addresses and network interface associated with the NAT gateway. + */ + NatGatewayAddresses?: NatGatewayAddressList; + /** + * The ID of the NAT gateway. + */ + NatGatewayId?: String; + /** + * Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center. + */ + ProvisionedBandwidth?: ProvisionedBandwidth; + /** + * The state of the NAT gateway. pending: The NAT gateway is being created and is not ready to process traffic. failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason. available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. deleting: The NAT gateway is in the process of being terminated and may still be processing traffic. deleted: The NAT gateway has been terminated and is no longer processing traffic. + */ + State?: NatGatewayState; + /** + * The ID of the subnet in which the NAT gateway is located. + */ + SubnetId?: String; + /** + * The ID of the VPC in which the NAT gateway is located. + */ + VpcId?: String; + /** + * The tags for the NAT gateway. + */ + Tags?: TagList; + } + export interface NatGatewayAddress { + /** + * The allocation ID of the Elastic IP address that's associated with the NAT gateway. + */ + AllocationId?: String; + /** + * The ID of the network interface associated with the NAT gateway. + */ + NetworkInterfaceId?: String; + /** + * The private IP address associated with the Elastic IP address. + */ + PrivateIp?: String; + /** + * The Elastic IP address associated with the NAT gateway. + */ + PublicIp?: String; + } + export type NatGatewayAddressList = NatGatewayAddress[]; + export type NatGatewayList = NatGateway[]; + export type NatGatewayState = "pending"|"failed"|"available"|"deleting"|"deleted"|string; + export interface NetworkAcl { + /** + * Any associations between the network ACL and one or more subnets + */ + Associations?: NetworkAclAssociationList; + /** + * One or more entries (rules) in the network ACL. + */ + Entries?: NetworkAclEntryList; + /** + * Indicates whether this is the default network ACL for the VPC. + */ + IsDefault?: Boolean; + /** + * The ID of the network ACL. + */ + NetworkAclId?: String; + /** + * Any tags assigned to the network ACL. + */ + Tags?: TagList; + /** + * The ID of the VPC for the network ACL. + */ + VpcId?: String; + /** + * The ID of the AWS account that owns the network ACL. + */ + OwnerId?: String; + } + export interface NetworkAclAssociation { + /** + * The ID of the association between a network ACL and a subnet. + */ + NetworkAclAssociationId?: String; + /** + * The ID of the network ACL. + */ + NetworkAclId?: String; + /** + * The ID of the subnet. + */ + SubnetId?: String; + } + export type NetworkAclAssociationList = NetworkAclAssociation[]; + export interface NetworkAclEntry { + /** + * The IPv4 network range to allow or deny, in CIDR notation. + */ + CidrBlock?: String; + /** + * Indicates whether the rule is an egress rule (applied to traffic leaving the subnet). + */ + Egress?: Boolean; + /** + * ICMP protocol: The ICMP type and code. + */ + IcmpTypeCode?: IcmpTypeCode; + /** + * The IPv6 network range to allow or deny, in CIDR notation. + */ + Ipv6CidrBlock?: String; + /** + * TCP or UDP protocols: The range of ports the rule applies to. + */ + PortRange?: PortRange; + /** + * The protocol number. A value of "-1" means all protocols. + */ + Protocol?: String; + /** + * Indicates whether to allow or deny the traffic that matches the rule. + */ + RuleAction?: RuleAction; + /** + * The rule number for the entry. ACL entries are processed in ascending order by rule number. + */ + RuleNumber?: Integer; + } + export type NetworkAclEntryList = NetworkAclEntry[]; + export type NetworkAclList = NetworkAcl[]; + export interface NetworkInterface { + /** + * The association information for an Elastic IP address (IPv4) associated with the network interface. + */ + Association?: NetworkInterfaceAssociation; + /** + * The network interface attachment. + */ + Attachment?: NetworkInterfaceAttachment; + /** + * The Availability Zone. + */ + AvailabilityZone?: String; + /** + * A description. + */ + Description?: String; + /** + * Any security groups for the network interface. + */ + Groups?: GroupIdentifierList; + /** + * The type of network interface. + */ + InterfaceType?: NetworkInterfaceType; + /** + * The IPv6 addresses associated with the network interface. + */ + Ipv6Addresses?: NetworkInterfaceIpv6AddressesList; + /** + * The MAC address. + */ + MacAddress?: String; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The AWS account ID of the owner of the network interface. + */ + OwnerId?: String; + /** + * The private DNS name. + */ + PrivateDnsName?: String; + /** + * The IPv4 address of the network interface within the subnet. + */ + PrivateIpAddress?: String; + /** + * The private IPv4 addresses associated with the network interface. + */ + PrivateIpAddresses?: NetworkInterfacePrivateIpAddressList; + /** + * The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling). + */ + RequesterId?: String; + /** + * Indicates whether the network interface is being managed by AWS. + */ + RequesterManaged?: Boolean; + /** + * Indicates whether traffic to or from the instance is validated. + */ + SourceDestCheck?: Boolean; + /** + * The status of the network interface. + */ + Status?: NetworkInterfaceStatus; + /** + * The ID of the subnet. + */ + SubnetId?: String; + /** + * Any tags assigned to the network interface. + */ + TagSet?: TagList; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export interface NetworkInterfaceAssociation { + /** + * The allocation ID. + */ + AllocationId?: String; + /** + * The association ID. + */ + AssociationId?: String; + /** + * The ID of the Elastic IP address owner. + */ + IpOwnerId?: String; + /** + * The public DNS name. + */ + PublicDnsName?: String; + /** + * The address of the Elastic IP address bound to the network interface. + */ + PublicIp?: String; + } + export interface NetworkInterfaceAttachment { + /** + * The timestamp indicating when the attachment initiated. + */ + AttachTime?: DateTime; + /** + * The ID of the network interface attachment. + */ + AttachmentId?: String; + /** + * Indicates whether the network interface is deleted when the instance is terminated. + */ + DeleteOnTermination?: Boolean; + /** + * The device index of the network interface attachment on the instance. + */ + DeviceIndex?: Integer; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The AWS account ID of the owner of the instance. + */ + InstanceOwnerId?: String; + /** + * The attachment state. + */ + Status?: AttachmentStatus; + } + export interface NetworkInterfaceAttachmentChanges { + /** + * The ID of the network interface attachment. + */ + AttachmentId?: String; + /** + * Indicates whether the network interface is deleted when the instance is terminated. + */ + DeleteOnTermination?: Boolean; + } + export type NetworkInterfaceAttribute = "description"|"groupSet"|"sourceDestCheck"|"attachment"|string; + export type NetworkInterfaceCreationType = "efa"|string; + export type NetworkInterfaceIdList = String[]; + export interface NetworkInterfaceIpv6Address { + /** + * The IPv6 address. + */ + Ipv6Address?: String; + } + export type NetworkInterfaceIpv6AddressesList = NetworkInterfaceIpv6Address[]; + export type NetworkInterfaceList = NetworkInterface[]; + export interface NetworkInterfacePermission { + /** + * The ID of the network interface permission. + */ + NetworkInterfacePermissionId?: String; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The AWS account ID. + */ + AwsAccountId?: String; + /** + * The AWS service. + */ + AwsService?: String; + /** + * The type of permission. + */ + Permission?: InterfacePermissionType; + /** + * Information about the state of the permission. + */ + PermissionState?: NetworkInterfacePermissionState; + } + export type NetworkInterfacePermissionIdList = String[]; + export type NetworkInterfacePermissionList = NetworkInterfacePermission[]; + export interface NetworkInterfacePermissionState { + /** + * The state of the permission. + */ + State?: NetworkInterfacePermissionStateCode; + /** + * A status message, if applicable. + */ + StatusMessage?: String; + } + export type NetworkInterfacePermissionStateCode = "pending"|"granted"|"revoking"|"revoked"|string; + export interface NetworkInterfacePrivateIpAddress { + /** + * The association information for an Elastic IP address (IPv4) associated with the network interface. + */ + Association?: NetworkInterfaceAssociation; + /** + * Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. + */ + Primary?: Boolean; + /** + * The private DNS name. + */ + PrivateDnsName?: String; + /** + * The private IPv4 address. + */ + PrivateIpAddress?: String; + } + export type NetworkInterfacePrivateIpAddressList = NetworkInterfacePrivateIpAddress[]; + export type NetworkInterfaceStatus = "available"|"associated"|"attaching"|"in-use"|"detaching"|string; + export type NetworkInterfaceType = "interface"|"natGateway"|"efa"|string; + export interface NewDhcpConfiguration { + Key?: String; + Values?: ValueStringList; + } + export type NewDhcpConfigurationList = NewDhcpConfiguration[]; + export type NextToken = string; + export type OccurrenceDayRequestSet = Integer[]; + export type OccurrenceDaySet = Integer[]; + export type OfferingClassType = "standard"|"convertible"|string; + export type OfferingTypeValues = "Heavy Utilization"|"Medium Utilization"|"Light Utilization"|"No Upfront"|"Partial Upfront"|"All Upfront"|string; + export type OnDemandAllocationStrategy = "lowestPrice"|"prioritized"|string; + export interface OnDemandOptions { + /** + * The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price. + */ + AllocationStrategy?: FleetOnDemandAllocationStrategy; + /** + * Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. + */ + SingleInstanceType?: Boolean; + /** + * Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. + */ + SingleAvailabilityZone?: Boolean; + /** + * The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances. + */ + MinTargetCapacity?: Integer; + } + export interface OnDemandOptionsRequest { + /** + * The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price. + */ + AllocationStrategy?: FleetOnDemandAllocationStrategy; + /** + * Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. + */ + SingleInstanceType?: Boolean; + /** + * Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. + */ + SingleAvailabilityZone?: Boolean; + /** + * The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances. + */ + MinTargetCapacity?: Integer; + } + export type OperationType = "add"|"remove"|string; + export type OwnerStringList = String[]; + export type PaymentOption = "AllUpfront"|"PartialUpfront"|"NoUpfront"|string; + export interface PciId { + /** + * The ID of the device. + */ + DeviceId?: String; + /** + * The ID of the vendor. + */ + VendorId?: String; + /** + * The ID of the subsystem. + */ + SubsystemId?: String; + /** + * The ID of the vendor for the subsystem. + */ + SubsystemVendorId?: String; + } + export interface PeeringConnectionOptions { + /** + * If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC. + */ + AllowDnsResolutionFromRemoteVpc?: Boolean; + /** + * If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC. + */ + AllowEgressFromLocalClassicLinkToRemoteVpc?: Boolean; + /** + * If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink. + */ + AllowEgressFromLocalVpcToRemoteClassicLink?: Boolean; + } + export interface PeeringConnectionOptionsRequest { + /** + * If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. + */ + AllowDnsResolutionFromRemoteVpc?: Boolean; + /** + * If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC. + */ + AllowEgressFromLocalClassicLinkToRemoteVpc?: Boolean; + /** + * If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink. + */ + AllowEgressFromLocalVpcToRemoteClassicLink?: Boolean; + } + export type PermissionGroup = "all"|string; + export interface Placement { + /** + * The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the region. + */ + AvailabilityZone?: String; + /** + * The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command. + */ + Affinity?: String; + /** + * The name of the placement group the instance is in. + */ + GroupName?: String; + /** + * The number of the partition the instance is in. Valid only if the placement group strategy is set to partition. + */ + PartitionNumber?: Integer; + /** + * The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command. + */ + HostId?: String; + /** + * The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command. + */ + Tenancy?: Tenancy; + /** + * Reserved for future use. + */ + SpreadDomain?: String; + } + export interface PlacementGroup { + /** + * The name of the placement group. + */ + GroupName?: String; + /** + * The state of the placement group. + */ + State?: PlacementGroupState; + /** + * The placement strategy. + */ + Strategy?: PlacementStrategy; + /** + * The number of partitions. Valid only if strategy is set to partition. + */ + PartitionCount?: Integer; + } + export type PlacementGroupList = PlacementGroup[]; + export type PlacementGroupState = "pending"|"available"|"deleting"|"deleted"|string; + export type PlacementGroupStringList = String[]; + export interface PlacementResponse { + /** + * The name of the placement group the instance is in. + */ + GroupName?: String; + } + export type PlacementStrategy = "cluster"|"spread"|"partition"|string; + export type PlatformValues = "Windows"|string; + export type PoolMaxResults = number; + export interface PortRange { + /** + * The first port in the range. + */ + From?: Integer; + /** + * The last port in the range. + */ + To?: Integer; + } + export interface PrefixList { + /** + * The IP address range of the AWS service. + */ + Cidrs?: ValueStringList; + /** + * The ID of the prefix. + */ + PrefixListId?: String; + /** + * The name of the prefix. + */ + PrefixListName?: String; + } + export interface PrefixListId { + /** + * A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* + */ + Description?: String; + /** + * The ID of the prefix. + */ + PrefixListId?: String; + } + export type PrefixListIdList = PrefixListId[]; + export type PrefixListIdSet = String[]; + export type PrefixListSet = PrefixList[]; + export interface PriceSchedule { + /** + * The current price schedule, as determined by the term remaining for the Reserved Instance in the listing. A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1. + */ + Active?: Boolean; + /** + * The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The fixed price for the term. + */ + Price?: Double; + /** + * The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires. + */ + Term?: Long; + } + export type PriceScheduleList = PriceSchedule[]; + export interface PriceScheduleSpecification { + /** + * The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The fixed price for the term. + */ + Price?: Double; + /** + * The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires. + */ + Term?: Long; + } + export type PriceScheduleSpecificationList = PriceScheduleSpecification[]; + export interface PricingDetail { + /** + * The number of reservations available for the price. + */ + Count?: Integer; + /** + * The price per instance. + */ + Price?: Double; + } + export type PricingDetailsList = PricingDetail[]; + export interface PrincipalIdFormat { + /** + * PrincipalIdFormatARN description + */ + Arn?: String; + /** + * PrincipalIdFormatStatuses description + */ + Statuses?: IdFormatList; + } + export type PrincipalIdFormatList = PrincipalIdFormat[]; + export type PrincipalType = "All"|"Service"|"OrganizationUnit"|"Account"|"User"|"Role"|string; + export type PrivateIpAddressConfigSet = ScheduledInstancesPrivateIpAddressConfig[]; + export interface PrivateIpAddressSpecification { + /** + * Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. + */ + Primary?: Boolean; + /** + * The private IPv4 addresses. + */ + PrivateIpAddress?: String; + } + export type PrivateIpAddressSpecificationList = PrivateIpAddressSpecification[]; + export type PrivateIpAddressStringList = String[]; + export interface ProductCode { + /** + * The product code. + */ + ProductCodeId?: String; + /** + * The type of product code. + */ + ProductCodeType?: ProductCodeValues; + } + export type ProductCodeList = ProductCode[]; + export type ProductCodeStringList = String[]; + export type ProductCodeValues = "devpay"|"marketplace"|string; + export type ProductDescriptionList = String[]; + export interface PropagatingVgw { + /** + * The ID of the virtual private gateway. + */ + GatewayId?: String; + } + export type PropagatingVgwList = PropagatingVgw[]; + export interface ProvisionByoipCidrRequest { + /** + * The public IPv4 address range, in CIDR notation. The most specific prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another region. + */ + Cidr: String; + /** + * A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. + */ + CidrAuthorizationContext?: CidrAuthorizationContext; + /** + * A description for the address range and the address pool. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ProvisionByoipCidrResult { + /** + * Information about the address pool. + */ + ByoipCidr?: ByoipCidr; + } + export interface ProvisionedBandwidth { + /** + * Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center. + */ + ProvisionTime?: DateTime; + /** + * Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center. + */ + Provisioned?: String; + /** + * Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center. + */ + RequestTime?: DateTime; + /** + * Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center. + */ + Requested?: String; + /** + * Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center. + */ + Status?: String; + } + export type PublicIpStringList = String[]; + export interface PublicIpv4Pool { + /** + * The ID of the IPv4 address pool. + */ + PoolId?: String; + /** + * A description of the address pool. + */ + Description?: String; + /** + * The address ranges. + */ + PoolAddressRanges?: PublicIpv4PoolRangeSet; + /** + * The total number of addresses. + */ + TotalAddressCount?: Integer; + /** + * The total number of available addresses. + */ + TotalAvailableAddressCount?: Integer; + } + export interface PublicIpv4PoolRange { + /** + * The first IP address in the range. + */ + FirstAddress?: String; + /** + * The last IP address in the range. + */ + LastAddress?: String; + /** + * The number of addresses in the range. + */ + AddressCount?: Integer; + /** + * The number of available addresses in the range. + */ + AvailableAddressCount?: Integer; + } + export type PublicIpv4PoolRangeSet = PublicIpv4PoolRange[]; + export type PublicIpv4PoolSet = PublicIpv4Pool[]; + export interface Purchase { + /** + * The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The duration of the reservation's term in seconds. + */ + Duration?: Integer; + /** + * The IDs of the Dedicated Hosts associated with the reservation. + */ + HostIdSet?: ResponseHostIdSet; + /** + * The ID of the reservation. + */ + HostReservationId?: String; + /** + * The hourly price of the reservation per hour. + */ + HourlyPrice?: String; + /** + * The instance family on the Dedicated Host that the reservation can be associated with. + */ + InstanceFamily?: String; + /** + * The payment option for the reservation. + */ + PaymentOption?: PaymentOption; + /** + * The upfront price of the reservation. + */ + UpfrontPrice?: String; + } + export interface PurchaseHostReservationRequest { + /** + * Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. + */ + ClientToken?: String; + /** + * The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The IDs of the Dedicated Hosts with which the reservation will be associated. + */ + HostIdSet: RequestHostIdSet; + /** + * The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00. + */ + LimitPrice?: String; + /** + * The ID of the offering. + */ + OfferingId: String; + } + export interface PurchaseHostReservationResult { + /** + * Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. + */ + ClientToken?: String; + /** + * The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * Describes the details of the purchase. + */ + Purchase?: PurchaseSet; + /** + * The total hourly price of the reservation calculated per hour. + */ + TotalHourlyPrice?: String; + /** + * The total amount charged to your account when you purchase the reservation. + */ + TotalUpfrontPrice?: String; + } + export interface PurchaseRequest { + /** + * The number of instances. + */ + InstanceCount: Integer; + /** + * The purchase token. + */ + PurchaseToken: String; + } + export type PurchaseRequestSet = PurchaseRequest[]; + export interface PurchaseReservedInstancesOfferingRequest { + /** + * The number of Reserved Instances to purchase. + */ + InstanceCount: Integer; + /** + * The ID of the Reserved Instance offering to purchase. + */ + ReservedInstancesOfferingId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices. + */ + LimitPrice?: ReservedInstanceLimitPrice; + } + export interface PurchaseReservedInstancesOfferingResult { + /** + * The IDs of the purchased Reserved Instances. + */ + ReservedInstancesId?: String; + } + export interface PurchaseScheduledInstancesRequest { + /** + * Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The purchase requests. + */ + PurchaseRequests: PurchaseRequestSet; + } + export interface PurchaseScheduledInstancesResult { + /** + * Information about the Scheduled Instances. + */ + ScheduledInstanceSet?: PurchasedScheduledInstanceSet; + } + export type PurchaseSet = Purchase[]; + export type PurchasedScheduledInstanceSet = ScheduledInstance[]; + export type RIProductDescription = "Linux/UNIX"|"Linux/UNIX (Amazon VPC)"|"Windows"|"Windows (Amazon VPC)"|string; + export type ReasonCodesList = ReportInstanceReasonCodes[]; + export interface RebootInstancesRequest { + /** + * The instance IDs. + */ + InstanceIds: InstanceIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface RecurringCharge { + /** + * The amount of the recurring charge. + */ + Amount?: Double; + /** + * The frequency of the recurring charge. + */ + Frequency?: RecurringChargeFrequency; + } + export type RecurringChargeFrequency = "Hourly"|string; + export type RecurringChargesList = RecurringCharge[]; + export interface Region { + /** + * The region service endpoint. + */ + Endpoint?: String; + /** + * The name of the region. + */ + RegionName?: String; + } + export type RegionList = Region[]; + export type RegionNameStringList = String[]; + export interface RegisterImageRequest { + /** + * The full path to your AMI manifest in Amazon S3 storage. + */ + ImageLocation?: String; + /** + * The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file. + */ + Architecture?: ArchitectureValues; + /** + * The block device mapping entries. + */ + BlockDeviceMappings?: BlockDeviceMappingRequestList; + /** + * A description for your AMI. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI. This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable. + */ + EnaSupport?: Boolean; + /** + * The ID of the kernel. + */ + KernelId?: String; + /** + * A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_) + */ + Name: String; + /** + * The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI. + */ + BillingProducts?: BillingProductList; + /** + * The ID of the RAM disk. + */ + RamdiskId?: String; + /** + * The device name of the root device volume (for example, /dev/sda1). + */ + RootDeviceName?: String; + /** + * Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI. There is no way to disable sriovNetSupport at this time. This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable. + */ + SriovNetSupport?: String; + /** + * The type of virtualization (hvm | paravirtual). Default: paravirtual + */ + VirtualizationType?: String; + } + export interface RegisterImageResult { + /** + * The ID of the newly registered AMI. + */ + ImageId?: String; + } + export interface RejectTransitGatewayVpcAttachmentRequest { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface RejectTransitGatewayVpcAttachmentResult { + /** + * Information about the attachment. + */ + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + } + export interface RejectVpcEndpointConnectionsRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the service. + */ + ServiceId: String; + /** + * The IDs of one or more VPC endpoints. + */ + VpcEndpointIds: ValueStringList; + } + export interface RejectVpcEndpointConnectionsResult { + /** + * Information about the endpoints that were not rejected, if applicable. + */ + Unsuccessful?: UnsuccessfulItemSet; + } + export interface RejectVpcPeeringConnectionRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the VPC peering connection. + */ + VpcPeeringConnectionId: String; + } + export interface RejectVpcPeeringConnectionResult { + /** + * Returns true if the request succeeds; otherwise, it returns an error. + */ + Return?: Boolean; + } + export interface ReleaseAddressRequest { + /** + * [EC2-VPC] The allocation ID. Required for EC2-VPC. + */ + AllocationId?: String; + /** + * [EC2-Classic] The Elastic IP address. Required for EC2-Classic. + */ + PublicIp?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ReleaseHostsRequest { + /** + * The IDs of the Dedicated Hosts to release. + */ + HostIds: RequestHostIdList; + } + export interface ReleaseHostsResult { + /** + * The IDs of the Dedicated Hosts that were successfully released. + */ + Successful?: ResponseHostIdList; + /** + * The IDs of the Dedicated Hosts that could not be released, including an error message. + */ + Unsuccessful?: UnsuccessfulItemList; + } + export interface ReplaceIamInstanceProfileAssociationRequest { + /** + * The IAM instance profile. + */ + IamInstanceProfile: IamInstanceProfileSpecification; + /** + * The ID of the existing IAM instance profile association. + */ + AssociationId: String; + } + export interface ReplaceIamInstanceProfileAssociationResult { + /** + * Information about the IAM instance profile association. + */ + IamInstanceProfileAssociation?: IamInstanceProfileAssociation; + } + export interface ReplaceNetworkAclAssociationRequest { + /** + * The ID of the current association between the original network ACL and the subnet. + */ + AssociationId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the new network ACL to associate with the subnet. + */ + NetworkAclId: String; + } + export interface ReplaceNetworkAclAssociationResult { + /** + * The ID of the new association. + */ + NewAssociationId?: String; + } + export interface ReplaceNetworkAclEntryRequest { + /** + * The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). + */ + CidrBlock?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Indicates whether to replace the egress rule. Default: If no value is specified, we replace the ingress rule. + */ + Egress: Boolean; + /** + * ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. + */ + IcmpTypeCode?: IcmpTypeCode; + /** + * The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64). + */ + Ipv6CidrBlock?: String; + /** + * The ID of the ACL. + */ + NetworkAclId: String; + /** + * TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP). + */ + PortRange?: PortRange; + /** + * The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code. + */ + Protocol: String; + /** + * Indicates whether to allow or deny the traffic that matches the rule. + */ + RuleAction: RuleAction; + /** + * The rule number of the entry to replace. + */ + RuleNumber: Integer; + } + export interface ReplaceRouteRequest { + /** + * The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. + */ + DestinationCidrBlock?: String; + /** + * The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. + */ + DestinationIpv6CidrBlock?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * [IPv6 traffic only] The ID of an egress-only internet gateway. + */ + EgressOnlyInternetGatewayId?: String; + /** + * The ID of an internet gateway or virtual private gateway. + */ + GatewayId?: String; + /** + * The ID of a NAT instance in your VPC. + */ + InstanceId?: String; + /** + * [IPv4 traffic only] The ID of a NAT gateway. + */ + NatGatewayId?: String; + /** + * The ID of a transit gateway. + */ + TransitGatewayId?: String; + /** + * The ID of a network interface. + */ + NetworkInterfaceId?: String; + /** + * The ID of the route table. + */ + RouteTableId: String; + /** + * The ID of a VPC peering connection. + */ + VpcPeeringConnectionId?: String; + } + export interface ReplaceRouteTableAssociationRequest { + /** + * The association ID. + */ + AssociationId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the new route table to associate with the subnet. + */ + RouteTableId: String; + } + export interface ReplaceRouteTableAssociationResult { + /** + * The ID of the new association. + */ + NewAssociationId?: String; + } + export interface ReplaceTransitGatewayRouteRequest { + /** + * The CIDR range used for the destination match. Routing decisions are based on the most specific match. + */ + DestinationCidrBlock: String; + /** + * The ID of the route table. + */ + TransitGatewayRouteTableId: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * Indicates whether traffic matching this route is to be dropped. + */ + Blackhole?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ReplaceTransitGatewayRouteResult { + /** + * Information about the modified route. + */ + Route?: TransitGatewayRoute; + } + export type ReportInstanceReasonCodes = "instance-stuck-in-state"|"unresponsive"|"not-accepting-credentials"|"password-not-available"|"performance-network"|"performance-instance-store"|"performance-ebs-volume"|"performance-other"|"other"|string; + export interface ReportInstanceStatusRequest { + /** + * Descriptive text about the health state of your instance. + */ + Description?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The time at which the reported instance health state ended. + */ + EndTime?: DateTime; + /** + * The instances. + */ + Instances: InstanceIdStringList; + /** + * The reason codes that describe the health state of your instance. instance-stuck-in-state: My instance is stuck in a state. unresponsive: My instance is unresponsive. not-accepting-credentials: My instance is not accepting my credentials. password-not-available: A password is not available for my instance. performance-network: My instance is experiencing performance problems that I believe are network related. performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores. performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume. performance-other: My instance is experiencing performance problems. other: [explain using the description parameter] + */ + ReasonCodes: ReasonCodesList; + /** + * The time at which the reported instance health state began. + */ + StartTime?: DateTime; + /** + * The status of all instances listed. + */ + Status: ReportStatusType; + } + export type ReportStatusType = "ok"|"impaired"|string; + export type RequestHostIdList = String[]; + export type RequestHostIdSet = String[]; + export interface RequestLaunchTemplateData { + /** + * The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide. + */ + KernelId?: String; + /** + * Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. + */ + EbsOptimized?: Boolean; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: LaunchTemplateIamInstanceProfileSpecificationRequest; + /** + * The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action. + */ + BlockDeviceMappings?: LaunchTemplateBlockDeviceMappingRequestList; + /** + * One or more network interfaces. + */ + NetworkInterfaces?: LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList; + /** + * The ID of the AMI, which you can get by using DescribeImages. + */ + ImageId?: String; + /** + * The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. + */ + InstanceType?: InstanceType; + /** + * The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair. If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. + */ + KeyName?: String; + /** + * The monitoring for the instance. + */ + Monitoring?: LaunchTemplatesMonitoringRequest; + /** + * The placement for the instance. + */ + Placement?: LaunchTemplatePlacementRequest; + /** + * The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide. + */ + RamDiskId?: String; + /** + * If set to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute. + */ + DisableApiTermination?: Boolean; + /** + * Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop + */ + InstanceInitiatedShutdownBehavior?: ShutdownBehavior; + /** + * The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). + */ + UserData?: String; + /** + * The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags. + */ + TagSpecifications?: LaunchTemplateTagSpecificationRequestList; + /** + * An elastic GPU to associate with the instance. + */ + ElasticGpuSpecifications?: ElasticGpuSpecificationList; + /** + * The elastic inference accelerator for the instance. + */ + ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAcceleratorList; + /** + * One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request. + */ + SecurityGroupIds?: SecurityGroupIdStringList; + /** + * [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request. + */ + SecurityGroups?: SecurityGroupStringList; + /** + * The market (purchasing) option for the instances. + */ + InstanceMarketOptions?: LaunchTemplateInstanceMarketOptionsRequest; + /** + * The credit option for CPU usage of the instance. Valid for T2 or T3 instances only. + */ + CreditSpecification?: CreditSpecificationRequest; + /** + * The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide. + */ + CpuOptions?: LaunchTemplateCpuOptionsRequest; + /** + * The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + */ + CapacityReservationSpecification?: LaunchTemplateCapacityReservationSpecificationRequest; + /** + * The license configurations. + */ + LicenseSpecifications?: LaunchTemplateLicenseSpecificationListRequest; + /** + * Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + HibernationOptions?: LaunchTemplateHibernationOptionsRequest; + } + export interface RequestSpotFleetRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The configuration for the Spot Fleet request. + */ + SpotFleetRequestConfig: SpotFleetRequestConfigData; + } + export interface RequestSpotFleetResponse { + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId?: String; + } + export interface RequestSpotInstancesRequest { + /** + * The user-specified name for a logical grouping of requests. When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active. If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group. Default: Instances are launched in any available Availability Zone. + */ + AvailabilityZoneGroup?: String; + /** + * The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates. You can't specify an Availability Zone group or a launch group if you specify a duration. + */ + BlockDurationMinutes?: Integer; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances. + */ + ClientToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The maximum number of Spot Instances to launch. Default: 1 + */ + InstanceCount?: Integer; + /** + * The instance launch group. Launch groups are Spot Instances that launch together and terminate together. Default: Instances are launched and terminated individually + */ + LaunchGroup?: String; + /** + * The launch specification. + */ + LaunchSpecification?: RequestSpotLaunchSpecification; + /** + * The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. + */ + SpotPrice?: String; + /** + * The Spot Instance request type. Default: one-time + */ + Type?: SpotInstanceType; + /** + * The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled. + */ + ValidFrom?: DateTime; + /** + * The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date. + */ + ValidUntil?: DateTime; + /** + * The behavior when a Spot Instance is interrupted. The default is terminate. + */ + InstanceInterruptionBehavior?: InstanceInterruptionBehavior; + } + export interface RequestSpotInstancesResult { + /** + * One or more Spot Instance requests. + */ + SpotInstanceRequests?: SpotInstanceRequestList; + } + export interface RequestSpotLaunchSpecification { + /** + * One or more security group IDs. + */ + SecurityGroupIds?: ValueStringList; + /** + * One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups. + */ + SecurityGroups?: ValueStringList; + /** + * Deprecated. + */ + AddressingType?: String; + /** + * One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. + */ + BlockDeviceMappings?: BlockDeviceMappingList; + /** + * Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. Default: false + */ + EbsOptimized?: Boolean; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: IamInstanceProfileSpecification; + /** + * The ID of the AMI. + */ + ImageId?: String; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The ID of the kernel. + */ + KernelId?: String; + /** + * The name of the key pair. + */ + KeyName?: String; + /** + * Indicates whether basic or detailed monitoring is enabled for the instance. Default: Disabled + */ + Monitoring?: RunInstancesMonitoringEnabled; + /** + * One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface. + */ + NetworkInterfaces?: InstanceNetworkInterfaceSpecificationList; + /** + * The placement information for the instance. + */ + Placement?: SpotPlacement; + /** + * The ID of the RAM disk. + */ + RamdiskId?: String; + /** + * The ID of the subnet in which to launch the instance. + */ + SubnetId?: String; + /** + * The Base64-encoded user data for the instance. User data is limited to 16 KB. + */ + UserData?: String; + } + export interface Reservation { + /** + * [EC2-Classic only] The security groups. + */ + Groups?: GroupIdentifierList; + /** + * The instances. + */ + Instances?: InstanceList; + /** + * The ID of the AWS account that owns the reservation. + */ + OwnerId?: String; + /** + * The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling). + */ + RequesterId?: String; + /** + * The ID of the reservation. + */ + ReservationId?: String; + } + export type ReservationList = Reservation[]; + export type ReservationState = "payment-pending"|"payment-failed"|"active"|"retired"|string; + export interface ReservationValue { + /** + * The hourly rate of the reservation. + */ + HourlyPrice?: String; + /** + * The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining). + */ + RemainingTotalValue?: String; + /** + * The remaining upfront cost of the reservation. + */ + RemainingUpfrontValue?: String; + } + export type ReservedInstanceIdSet = String[]; + export interface ReservedInstanceLimitPrice { + /** + * Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price). + */ + Amount?: Double; + /** + * The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + } + export interface ReservedInstanceReservationValue { + /** + * The total value of the Convertible Reserved Instance that you are exchanging. + */ + ReservationValue?: ReservationValue; + /** + * The ID of the Convertible Reserved Instance that you are exchanging. + */ + ReservedInstanceId?: String; + } + export type ReservedInstanceReservationValueSet = ReservedInstanceReservationValue[]; + export type ReservedInstanceState = "payment-pending"|"active"|"payment-failed"|"retired"|string; + export interface ReservedInstances { + /** + * The Availability Zone in which the Reserved Instance can be used. + */ + AvailabilityZone?: String; + /** + * The duration of the Reserved Instance, in seconds. + */ + Duration?: Long; + /** + * The time when the Reserved Instance expires. + */ + End?: DateTime; + /** + * The purchase price of the Reserved Instance. + */ + FixedPrice?: Float; + /** + * The number of reservations purchased. + */ + InstanceCount?: Integer; + /** + * The instance type on which the Reserved Instance can be used. + */ + InstanceType?: InstanceType; + /** + * The Reserved Instance product platform description. + */ + ProductDescription?: RIProductDescription; + /** + * The ID of the Reserved Instance. + */ + ReservedInstancesId?: String; + /** + * The date and time the Reserved Instance started. + */ + Start?: DateTime; + /** + * The state of the Reserved Instance purchase. + */ + State?: ReservedInstanceState; + /** + * The usage price of the Reserved Instance, per hour. + */ + UsagePrice?: Float; + /** + * The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The tenancy of the instance. + */ + InstanceTenancy?: Tenancy; + /** + * The offering class of the Reserved Instance. + */ + OfferingClass?: OfferingClassType; + /** + * The Reserved Instance offering type. + */ + OfferingType?: OfferingTypeValues; + /** + * The recurring charge tag assigned to the resource. + */ + RecurringCharges?: RecurringChargesList; + /** + * The scope of the Reserved Instance. + */ + Scope?: scope; + /** + * Any tags assigned to the resource. + */ + Tags?: TagList; + } + export interface ReservedInstancesConfiguration { + /** + * The Availability Zone for the modified Reserved Instances. + */ + AvailabilityZone?: String; + /** + * The number of modified Reserved Instances. This is a required field for a request. + */ + InstanceCount?: Integer; + /** + * The instance type for the modified Reserved Instances. + */ + InstanceType?: InstanceType; + /** + * The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC. + */ + Platform?: String; + /** + * Whether the Reserved Instance is applied to instances in a region or instances in a specific Availability Zone. + */ + Scope?: scope; + } + export type ReservedInstancesConfigurationList = ReservedInstancesConfiguration[]; + export interface ReservedInstancesId { + /** + * The ID of the Reserved Instance. + */ + ReservedInstancesId?: String; + } + export type ReservedInstancesIdStringList = String[]; + export type ReservedInstancesList = ReservedInstances[]; + export interface ReservedInstancesListing { + /** + * A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * The time the listing was created. + */ + CreateDate?: DateTime; + /** + * The number of instances in this state. + */ + InstanceCounts?: InstanceCountList; + /** + * The price of the Reserved Instance listing. + */ + PriceSchedules?: PriceScheduleList; + /** + * The ID of the Reserved Instance. + */ + ReservedInstancesId?: String; + /** + * The ID of the Reserved Instance listing. + */ + ReservedInstancesListingId?: String; + /** + * The status of the Reserved Instance listing. + */ + Status?: ListingStatus; + /** + * The reason for the current status of the Reserved Instance listing. The response can be blank. + */ + StatusMessage?: String; + /** + * Any tags assigned to the resource. + */ + Tags?: TagList; + /** + * The last modified timestamp of the listing. + */ + UpdateDate?: DateTime; + } + export type ReservedInstancesListingList = ReservedInstancesListing[]; + export interface ReservedInstancesModification { + /** + * A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * The time when the modification request was created. + */ + CreateDate?: DateTime; + /** + * The time for the modification to become effective. + */ + EffectiveDate?: DateTime; + /** + * Contains target configurations along with their corresponding new Reserved Instance IDs. + */ + ModificationResults?: ReservedInstancesModificationResultList; + /** + * The IDs of one or more Reserved Instances. + */ + ReservedInstancesIds?: ReservedIntancesIds; + /** + * A unique ID for the Reserved Instance modification. + */ + ReservedInstancesModificationId?: String; + /** + * The status of the Reserved Instances modification request. + */ + Status?: String; + /** + * The reason for the status. + */ + StatusMessage?: String; + /** + * The time when the modification request was last updated. + */ + UpdateDate?: DateTime; + } + export type ReservedInstancesModificationIdStringList = String[]; + export type ReservedInstancesModificationList = ReservedInstancesModification[]; + export interface ReservedInstancesModificationResult { + /** + * The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled. + */ + ReservedInstancesId?: String; + /** + * The target Reserved Instances configurations supplied as part of the modification request. + */ + TargetConfiguration?: ReservedInstancesConfiguration; + } + export type ReservedInstancesModificationResultList = ReservedInstancesModificationResult[]; + export interface ReservedInstancesOffering { + /** + * The Availability Zone in which the Reserved Instance can be used. + */ + AvailabilityZone?: String; + /** + * The duration of the Reserved Instance, in seconds. + */ + Duration?: Long; + /** + * The purchase price of the Reserved Instance. + */ + FixedPrice?: Float; + /** + * The instance type on which the Reserved Instance can be used. + */ + InstanceType?: InstanceType; + /** + * The Reserved Instance product platform description. + */ + ProductDescription?: RIProductDescription; + /** + * The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made. + */ + ReservedInstancesOfferingId?: String; + /** + * The usage price of the Reserved Instance, per hour. + */ + UsagePrice?: Float; + /** + * The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD. + */ + CurrencyCode?: CurrencyCodeValues; + /** + * The tenancy of the instance. + */ + InstanceTenancy?: Tenancy; + /** + * Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true. + */ + Marketplace?: Boolean; + /** + * If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange. + */ + OfferingClass?: OfferingClassType; + /** + * The Reserved Instance offering type. + */ + OfferingType?: OfferingTypeValues; + /** + * The pricing details of the Reserved Instance offering. + */ + PricingDetails?: PricingDetailsList; + /** + * The recurring charge tag assigned to the resource. + */ + RecurringCharges?: RecurringChargesList; + /** + * Whether the Reserved Instance is applied to instances in a region or an Availability Zone. + */ + Scope?: scope; + } + export type ReservedInstancesOfferingIdStringList = String[]; + export type ReservedInstancesOfferingList = ReservedInstancesOffering[]; + export type ReservedIntancesIds = ReservedInstancesId[]; + export type ResetFpgaImageAttributeName = "loadPermission"|string; + export interface ResetFpgaImageAttributeRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the AFI. + */ + FpgaImageId: String; + /** + * The attribute. + */ + Attribute?: ResetFpgaImageAttributeName; + } + export interface ResetFpgaImageAttributeResult { + /** + * Is true if the request succeeds, and an error otherwise. + */ + Return?: Boolean; + } + export type ResetImageAttributeName = "launchPermission"|string; + export interface ResetImageAttributeRequest { + /** + * The attribute to reset (currently you can only reset the launch permission attribute). + */ + Attribute: ResetImageAttributeName; + /** + * The ID of the AMI. + */ + ImageId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface ResetInstanceAttributeRequest { + /** + * The attribute to reset. You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute. + */ + Attribute: InstanceAttributeName; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the instance. + */ + InstanceId: String; + } + export interface ResetNetworkInterfaceAttributeRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + /** + * The source/destination checking attribute. Resets the value to true. + */ + SourceDestCheck?: String; + } + export interface ResetSnapshotAttributeRequest { + /** + * The attribute to reset. Currently, only the attribute for permission to create volumes can be reset. + */ + Attribute: SnapshotAttributeName; + /** + * The ID of the snapshot. + */ + SnapshotId: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export type ResourceIdList = String[]; + export type ResourceList = String[]; + export type ResourceType = "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"elastic-ip"|"fleet"|"fpga-image"|"host-reservation"|"image"|"instance"|"internet-gateway"|"launch-template"|"natgateway"|"network-acl"|"network-interface"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-instances-request"|"subnet"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|string; + export interface ResponseError { + /** + * The error code. + */ + Code?: LaunchTemplateErrorCode; + /** + * The error message, if applicable. + */ + Message?: String; + } + export type ResponseHostIdList = String[]; + export type ResponseHostIdSet = String[]; + export interface ResponseLaunchTemplateData { + /** + * The ID of the kernel, if applicable. + */ + KernelId?: String; + /** + * Indicates whether the instance is optimized for Amazon EBS I/O. + */ + EbsOptimized?: Boolean; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: LaunchTemplateIamInstanceProfileSpecification; + /** + * The block device mappings. + */ + BlockDeviceMappings?: LaunchTemplateBlockDeviceMappingList; + /** + * The network interfaces. + */ + NetworkInterfaces?: LaunchTemplateInstanceNetworkInterfaceSpecificationList; + /** + * The ID of the AMI that was used to launch the instance. + */ + ImageId?: String; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The name of the key pair. + */ + KeyName?: String; + /** + * The monitoring for the instance. + */ + Monitoring?: LaunchTemplatesMonitoring; + /** + * The placement of the instance. + */ + Placement?: LaunchTemplatePlacement; + /** + * The ID of the RAM disk, if applicable. + */ + RamDiskId?: String; + /** + * If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API. + */ + DisableApiTermination?: Boolean; + /** + * Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + */ + InstanceInitiatedShutdownBehavior?: ShutdownBehavior; + /** + * The user data for the instance. + */ + UserData?: String; + /** + * The tags. + */ + TagSpecifications?: LaunchTemplateTagSpecificationList; + /** + * The elastic GPU specification. + */ + ElasticGpuSpecifications?: ElasticGpuSpecificationResponseList; + /** + * The elastic inference accelerator for the instance. + */ + ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAcceleratorResponseList; + /** + * The security group IDs. + */ + SecurityGroupIds?: ValueStringList; + /** + * The security group names. + */ + SecurityGroups?: ValueStringList; + /** + * The market (purchasing) option for the instances. + */ + InstanceMarketOptions?: LaunchTemplateInstanceMarketOptions; + /** + * The credit option for CPU usage of the instance. + */ + CreditSpecification?: CreditSpecification; + /** + * The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide. + */ + CpuOptions?: LaunchTemplateCpuOptions; + /** + * Information about the Capacity Reservation targeting option. + */ + CapacityReservationSpecification?: LaunchTemplateCapacityReservationSpecificationResponse; + /** + * The license configurations. + */ + LicenseSpecifications?: LaunchTemplateLicenseList; + /** + * Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + HibernationOptions?: LaunchTemplateHibernationOptions; + } + export type RestorableByStringList = String[]; + export interface RestoreAddressToClassicRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The Elastic IP address. + */ + PublicIp: String; + } + export interface RestoreAddressToClassicResult { + /** + * The Elastic IP address. + */ + PublicIp?: String; + /** + * The move status for the IP address. + */ + Status?: Status; + } + export interface RevokeClientVpnIngressRequest { + /** + * The ID of the Client VPN endpoint with which the authorization rule is associated. + */ + ClientVpnEndpointId: String; + /** + * The IPv4 address range, in CIDR notation, of the network for which access is being removed. + */ + TargetNetworkCidr: String; + /** + * The ID of the Active Directory group for which to revoke access. + */ + AccessGroupId?: String; + /** + * Indicates whether access should be revoked for all clients. + */ + RevokeAllGroups?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface RevokeClientVpnIngressResult { + /** + * The current state of the authorization rule. + */ + Status?: ClientVpnAuthorizationRuleStatus; + } + export interface RevokeSecurityGroupEgressRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the security group. + */ + GroupId: String; + /** + * The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions. + */ + IpPermissions?: IpPermissionList; + /** + * Not supported. Use a set of IP permissions to specify the CIDR. + */ + CidrIp?: String; + /** + * Not supported. Use a set of IP permissions to specify the port. + */ + FromPort?: Integer; + /** + * Not supported. Use a set of IP permissions to specify the protocol name or number. + */ + IpProtocol?: String; + /** + * Not supported. Use a set of IP permissions to specify the port. + */ + ToPort?: Integer; + /** + * Not supported. Use a set of IP permissions to specify a destination security group. + */ + SourceSecurityGroupName?: String; + /** + * Not supported. Use a set of IP permissions to specify a destination security group. + */ + SourceSecurityGroupOwnerId?: String; + } + export interface RevokeSecurityGroupIngressRequest { + /** + * The CIDR IP address range. You can't specify this parameter when specifying a source security group. + */ + CidrIp?: String; + /** + * The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types. + */ + FromPort?: Integer; + /** + * The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + */ + GroupId?: String; + /** + * [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. + */ + GroupName?: String; + /** + * The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions. + */ + IpPermissions?: IpPermissionList; + /** + * The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all. + */ + IpProtocol?: String; + /** + * [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead. + */ + SourceSecurityGroupName?: String; + /** + * [EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead. + */ + SourceSecurityGroupOwnerId?: String; + /** + * The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type. + */ + ToPort?: Integer; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface Route { + /** + * The IPv4 CIDR block used for the destination match. + */ + DestinationCidrBlock?: String; + /** + * The IPv6 CIDR block used for the destination match. + */ + DestinationIpv6CidrBlock?: String; + /** + * The prefix of the AWS service. + */ + DestinationPrefixListId?: String; + /** + * The ID of the egress-only internet gateway. + */ + EgressOnlyInternetGatewayId?: String; + /** + * The ID of a gateway attached to your VPC. + */ + GatewayId?: String; + /** + * The ID of a NAT instance in your VPC. + */ + InstanceId?: String; + /** + * The AWS account ID of the owner of the instance. + */ + InstanceOwnerId?: String; + /** + * The ID of a NAT gateway. + */ + NatGatewayId?: String; + /** + * The ID of a transit gateway. + */ + TransitGatewayId?: String; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * Describes how the route was created. CreateRouteTable - The route was automatically created when the route table was created. CreateRoute - The route was manually added to the route table. EnableVgwRoutePropagation - The route was propagated by route propagation. + */ + Origin?: RouteOrigin; + /** + * The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated). + */ + State?: RouteState; + /** + * The ID of a VPC peering connection. + */ + VpcPeeringConnectionId?: String; + } + export type RouteList = Route[]; + export type RouteOrigin = "CreateRouteTable"|"CreateRoute"|"EnableVgwRoutePropagation"|string; + export type RouteState = "active"|"blackhole"|string; + export interface RouteTable { + /** + * The associations between the route table and one or more subnets. + */ + Associations?: RouteTableAssociationList; + /** + * Any virtual private gateway (VGW) propagating routes. + */ + PropagatingVgws?: PropagatingVgwList; + /** + * The ID of the route table. + */ + RouteTableId?: String; + /** + * The routes in the route table. + */ + Routes?: RouteList; + /** + * Any tags assigned to the route table. + */ + Tags?: TagList; + /** + * The ID of the VPC. + */ + VpcId?: String; + /** + * The ID of the AWS account that owns the route table. + */ + OwnerId?: String; + } + export interface RouteTableAssociation { + /** + * Indicates whether this is the main route table. + */ + Main?: Boolean; + /** + * The ID of the association between a route table and a subnet. + */ + RouteTableAssociationId?: String; + /** + * The ID of the route table. + */ + RouteTableId?: String; + /** + * The ID of the subnet. A subnet ID is not returned for an implicit association. + */ + SubnetId?: String; + } + export type RouteTableAssociationList = RouteTableAssociation[]; + export type RouteTableList = RouteTable[]; + export type RuleAction = "allow"|"deny"|string; + export interface RunInstancesMonitoringEnabled { + /** + * Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. + */ + Enabled: Boolean; + } + export interface RunInstancesRequest { + /** + * The block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. + */ + BlockDeviceMappings?: BlockDeviceMappingRequestList; + /** + * The ID of the AMI. An AMI is required to launch an instance and must be specified here or in a launch template. + */ + ImageId?: String; + /** + * The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. Default: m1.small + */ + InstanceType?: InstanceType; + /** + * [EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. You cannot specify this option and the network interfaces option in the same request. + */ + Ipv6AddressCount?: Integer; + /** + * [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. You cannot specify this option and the network interfaces option in the same request. + */ + Ipv6Addresses?: InstanceIpv6AddressList; + /** + * The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide. + */ + KernelId?: String; + /** + * The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair. If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. + */ + KeyName?: String; + /** + * The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ. + */ + MaxCount: Integer; + /** + * The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ. + */ + MinCount: Integer; + /** + * Specifies whether detailed monitoring is enabled for the instance. + */ + Monitoring?: RunInstancesMonitoringEnabled; + /** + * The placement for the instance. + */ + Placement?: Placement; + /** + * The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide. + */ + RamdiskId?: String; + /** + * The IDs of the security groups. You can create a security group using CreateSecurityGroup. Default: Amazon EC2 uses the default security group. You cannot specify this option and the network interfaces option in the same request. + */ + SecurityGroupIds?: SecurityGroupIdStringList; + /** + * [EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead. You cannot specify this option and the network interfaces option in the same request. Default: Amazon EC2 uses the default security group. + */ + SecurityGroups?: SecurityGroupStringList; + /** + * [EC2-VPC] The ID of the subnet to launch the instance into. You cannot specify this option and the network interfaces option in the same request. + */ + SubnetId?: String; + /** + * The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB. + */ + UserData?: String; + /** + * Reserved. + */ + AdditionalInfo?: String; + /** + * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraints: Maximum 64 ASCII characters + */ + ClientToken?: String; + /** + * If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance. Default: false + */ + DisableApiTermination?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. Default: false + */ + EbsOptimized?: Boolean; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: IamInstanceProfileSpecification; + /** + * Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop + */ + InstanceInitiatedShutdownBehavior?: ShutdownBehavior; + /** + * The network interfaces to associate with the instance. + */ + NetworkInterfaces?: InstanceNetworkInterfaceSpecificationList; + /** + * [EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request. You cannot specify this option and the network interfaces option in the same request. + */ + PrivateIpAddress?: String; + /** + * An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide. + */ + ElasticGpuSpecification?: ElasticGpuSpecifications; + /** + * An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + */ + ElasticInferenceAccelerators?: ElasticInferenceAccelerators; + /** + * The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags. + */ + TagSpecifications?: TagSpecificationList; + /** + * The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both. + */ + LaunchTemplate?: LaunchTemplateSpecification; + /** + * The market (purchasing) option for the instances. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop. + */ + InstanceMarketOptions?: InstanceMarketOptionsRequest; + /** + * The credit option for CPU usage of the T2 or T3 instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide. Default: standard (T2 instances) or unlimited (T3 instances) + */ + CreditSpecification?: CreditSpecificationRequest; + /** + * The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide. + */ + CpuOptions?: CpuOptionsRequest; + /** + * Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + */ + CapacityReservationSpecification?: CapacityReservationSpecification; + /** + * Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide. + */ + HibernationOptions?: HibernationOptionsRequest; + /** + * The license configurations. + */ + LicenseSpecifications?: LicenseSpecificationListRequest; + } + export interface RunScheduledInstancesRequest { + /** + * Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The number of instances. Default: 1 + */ + InstanceCount?: Integer; + /** + * The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased. + */ + LaunchSpecification: ScheduledInstancesLaunchSpecification; + /** + * The Scheduled Instance ID. + */ + ScheduledInstanceId: String; + } + export interface RunScheduledInstancesResult { + /** + * The IDs of the newly launched instances. + */ + InstanceIdSet?: InstanceIdSet; + } + export interface S3Storage { + /** + * The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys. + */ + AWSAccessKeyId?: String; + /** + * The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error. + */ + Bucket?: String; + /** + * The beginning of the file name of the AMI. + */ + Prefix?: String; + /** + * An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. + */ + UploadPolicy?: _Blob; + /** + * The signature of the JSON document. + */ + UploadPolicySignature?: String; + } + export interface ScheduledInstance { + /** + * The Availability Zone. + */ + AvailabilityZone?: String; + /** + * The date when the Scheduled Instance was purchased. + */ + CreateDate?: DateTime; + /** + * The hourly price for a single instance. + */ + HourlyPrice?: String; + /** + * The number of instances. + */ + InstanceCount?: Integer; + /** + * The instance type. + */ + InstanceType?: String; + /** + * The network platform (EC2-Classic or EC2-VPC). + */ + NetworkPlatform?: String; + /** + * The time for the next schedule to start. + */ + NextSlotStartTime?: DateTime; + /** + * The platform (Linux/UNIX or Windows). + */ + Platform?: String; + /** + * The time that the previous schedule ended or will end. + */ + PreviousSlotEndTime?: DateTime; + /** + * The schedule recurrence. + */ + Recurrence?: ScheduledInstanceRecurrence; + /** + * The Scheduled Instance ID. + */ + ScheduledInstanceId?: String; + /** + * The number of hours in the schedule. + */ + SlotDurationInHours?: Integer; + /** + * The end date for the Scheduled Instance. + */ + TermEndDate?: DateTime; + /** + * The start date for the Scheduled Instance. + */ + TermStartDate?: DateTime; + /** + * The total number of hours for a single instance for the entire term. + */ + TotalScheduledInstanceHours?: Integer; + } + export interface ScheduledInstanceAvailability { + /** + * The Availability Zone. + */ + AvailabilityZone?: String; + /** + * The number of available instances. + */ + AvailableInstanceCount?: Integer; + /** + * The time period for the first schedule to start. + */ + FirstSlotStartTime?: DateTime; + /** + * The hourly price for a single instance. + */ + HourlyPrice?: String; + /** + * The instance type. You can specify one of the C3, C4, M4, or R3 instance types. + */ + InstanceType?: String; + /** + * The maximum term. The only possible value is 365 days. + */ + MaxTermDurationInDays?: Integer; + /** + * The minimum term. The only possible value is 365 days. + */ + MinTermDurationInDays?: Integer; + /** + * The network platform (EC2-Classic or EC2-VPC). + */ + NetworkPlatform?: String; + /** + * The platform (Linux/UNIX or Windows). + */ + Platform?: String; + /** + * The purchase token. This token expires in two hours. + */ + PurchaseToken?: String; + /** + * The schedule recurrence. + */ + Recurrence?: ScheduledInstanceRecurrence; + /** + * The number of hours in the schedule. + */ + SlotDurationInHours?: Integer; + /** + * The total number of hours for a single instance for the entire term. + */ + TotalScheduledInstanceHours?: Integer; + } + export type ScheduledInstanceAvailabilitySet = ScheduledInstanceAvailability[]; + export type ScheduledInstanceIdRequestSet = String[]; + export interface ScheduledInstanceRecurrence { + /** + * The frequency (Daily, Weekly, or Monthly). + */ + Frequency?: String; + /** + * The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months. + */ + Interval?: Integer; + /** + * The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). + */ + OccurrenceDaySet?: OccurrenceDaySet; + /** + * Indicates whether the occurrence is relative to the end of the specified week or month. + */ + OccurrenceRelativeToEnd?: Boolean; + /** + * The unit for occurrenceDaySet (DayOfWeek or DayOfMonth). + */ + OccurrenceUnit?: String; + } + export interface ScheduledInstanceRecurrenceRequest { + /** + * The frequency (Daily, Weekly, or Monthly). + */ + Frequency?: String; + /** + * The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months. + */ + Interval?: Integer; + /** + * The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day. + */ + OccurrenceDays?: OccurrenceDayRequestSet; + /** + * Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule. + */ + OccurrenceRelativeToEnd?: Boolean; + /** + * The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule. + */ + OccurrenceUnit?: String; + } + export type ScheduledInstanceSet = ScheduledInstance[]; + export interface ScheduledInstancesBlockDeviceMapping { + /** + * The device name (for example, /dev/sdh or xvdh). + */ + DeviceName?: String; + /** + * Parameters used to set up EBS volumes automatically when the instance is launched. + */ + Ebs?: ScheduledInstancesEbs; + /** + * Suppresses the specified device included in the block device mapping of the AMI. + */ + NoDevice?: String; + /** + * The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. + */ + VirtualName?: String; + } + export type ScheduledInstancesBlockDeviceMappingSet = ScheduledInstancesBlockDeviceMapping[]; + export interface ScheduledInstancesEbs { + /** + * Indicates whether the volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + /** + * Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them. + */ + Encrypted?: Boolean; + /** + * The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes. Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. + */ + Iops?: Integer; + /** + * The ID of the snapshot. + */ + SnapshotId?: String; + /** + * The size of the volume, in GiB. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. + */ + VolumeSize?: Integer; + /** + * The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic. Default: standard + */ + VolumeType?: String; + } + export interface ScheduledInstancesIamInstanceProfile { + /** + * The Amazon Resource Name (ARN). + */ + Arn?: String; + /** + * The name. + */ + Name?: String; + } + export interface ScheduledInstancesIpv6Address { + /** + * The IPv6 address. + */ + Ipv6Address?: Ipv6Address; + } + export type ScheduledInstancesIpv6AddressList = ScheduledInstancesIpv6Address[]; + export interface ScheduledInstancesLaunchSpecification { + /** + * The block device mapping entries. + */ + BlockDeviceMappings?: ScheduledInstancesBlockDeviceMappingSet; + /** + * Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. Default: false + */ + EbsOptimized?: Boolean; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: ScheduledInstancesIamInstanceProfile; + /** + * The ID of the Amazon Machine Image (AMI). + */ + ImageId: String; + /** + * The instance type. + */ + InstanceType?: String; + /** + * The ID of the kernel. + */ + KernelId?: String; + /** + * The name of the key pair. + */ + KeyName?: String; + /** + * Enable or disable monitoring for the instances. + */ + Monitoring?: ScheduledInstancesMonitoring; + /** + * The network interfaces. + */ + NetworkInterfaces?: ScheduledInstancesNetworkInterfaceSet; + /** + * The placement information. + */ + Placement?: ScheduledInstancesPlacement; + /** + * The ID of the RAM disk. + */ + RamdiskId?: String; + /** + * The IDs of the security groups. + */ + SecurityGroupIds?: ScheduledInstancesSecurityGroupIdSet; + /** + * The ID of the subnet in which to launch the instances. + */ + SubnetId?: String; + /** + * The base64-encoded MIME user data. + */ + UserData?: String; + } + export interface ScheduledInstancesMonitoring { + /** + * Indicates whether monitoring is enabled. + */ + Enabled?: Boolean; + } + export interface ScheduledInstancesNetworkInterface { + /** + * Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true. + */ + AssociatePublicIpAddress?: Boolean; + /** + * Indicates whether to delete the interface when the instance is terminated. + */ + DeleteOnTermination?: Boolean; + /** + * The description. + */ + Description?: String; + /** + * The index of the device for the network interface attachment. + */ + DeviceIndex?: Integer; + /** + * The IDs of the security groups. + */ + Groups?: ScheduledInstancesSecurityGroupIdSet; + /** + * The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range. + */ + Ipv6AddressCount?: Integer; + /** + * The specific IPv6 addresses from the subnet range. + */ + Ipv6Addresses?: ScheduledInstancesIpv6AddressList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The IPv4 address of the network interface within the subnet. + */ + PrivateIpAddress?: String; + /** + * The private IPv4 addresses. + */ + PrivateIpAddressConfigs?: PrivateIpAddressConfigSet; + /** + * The number of secondary private IPv4 addresses. + */ + SecondaryPrivateIpAddressCount?: Integer; + /** + * The ID of the subnet. + */ + SubnetId?: String; + } + export type ScheduledInstancesNetworkInterfaceSet = ScheduledInstancesNetworkInterface[]; + export interface ScheduledInstancesPlacement { + /** + * The Availability Zone. + */ + AvailabilityZone?: String; + /** + * The name of the placement group. + */ + GroupName?: String; + } + export interface ScheduledInstancesPrivateIpAddressConfig { + /** + * Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address. + */ + Primary?: Boolean; + /** + * The IPv4 address. + */ + PrivateIpAddress?: String; + } + export type ScheduledInstancesSecurityGroupIdSet = String[]; + export interface SearchTransitGatewayRoutesRequest { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId: String; + /** + * One or more filters. The possible values are: attachment.transit-gateway-attachment-id- The id of the transit gateway attachment. attachment.resource-id - The resource id of the transit gateway attachment. attachment.resource-type - The attachment resource type (vpc | vpn). route-search.exact-match - The exact match of the specified filter. route-search.longest-prefix-match - The longest prefix that matches the route. route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter. route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting). type - The type of roue (active | blackhole). + */ + Filters: FilterList; + /** + * The maximum number of routes to return. + */ + MaxResults?: TransitGatewayMaxResults; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface SearchTransitGatewayRoutesResult { + /** + * Information about the routes. + */ + Routes?: TransitGatewayRouteList; + /** + * Indicates whether there are additional routes available. + */ + AdditionalRoutesAvailable?: Boolean; + } + export interface SecurityGroup { + /** + * A description of the security group. + */ + Description?: String; + /** + * The name of the security group. + */ + GroupName?: String; + /** + * The inbound rules associated with the security group. + */ + IpPermissions?: IpPermissionList; + /** + * The AWS account ID of the owner of the security group. + */ + OwnerId?: String; + /** + * The ID of the security group. + */ + GroupId?: String; + /** + * [VPC only] The outbound rules associated with the security group. + */ + IpPermissionsEgress?: IpPermissionList; + /** + * Any tags assigned to the security group. + */ + Tags?: TagList; + /** + * [VPC only] The ID of the VPC for the security group. + */ + VpcId?: String; + } + export type SecurityGroupIdStringList = String[]; + export interface SecurityGroupIdentifier { + /** + * The ID of the security group. + */ + GroupId?: String; + /** + * The name of the security group. + */ + GroupName?: String; + } + export type SecurityGroupList = SecurityGroup[]; + export interface SecurityGroupReference { + /** + * The ID of your security group. + */ + GroupId?: String; + /** + * The ID of the VPC with the referencing security group. + */ + ReferencingVpcId?: String; + /** + * The ID of the VPC peering connection. + */ + VpcPeeringConnectionId?: String; + } + export type SecurityGroupReferences = SecurityGroupReference[]; + export type SecurityGroupStringList = String[]; + export interface ServiceConfiguration { + /** + * The type of service. + */ + ServiceType?: ServiceTypeDetailSet; + /** + * The ID of the service. + */ + ServiceId?: String; + /** + * The name of the service. + */ + ServiceName?: String; + /** + * The service state. + */ + ServiceState?: ServiceState; + /** + * In the Availability Zones in which the service is available. + */ + AvailabilityZones?: ValueStringList; + /** + * Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted. + */ + AcceptanceRequired?: Boolean; + /** + * Indicates whether the service manages it's VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. + */ + ManagesVpcEndpoints?: Boolean; + /** + * The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. + */ + NetworkLoadBalancerArns?: ValueStringList; + /** + * The DNS names for the service. + */ + BaseEndpointDnsNames?: ValueStringList; + /** + * The private DNS name for the service. + */ + PrivateDnsName?: String; + } + export type ServiceConfigurationSet = ServiceConfiguration[]; + export interface ServiceDetail { + /** + * The Amazon Resource Name (ARN) of the service. + */ + ServiceName?: String; + /** + * The type of service. + */ + ServiceType?: ServiceTypeDetailSet; + /** + * The Availability Zones in which the service is available. + */ + AvailabilityZones?: ValueStringList; + /** + * The AWS account ID of the service owner. + */ + Owner?: String; + /** + * The DNS names for the service. + */ + BaseEndpointDnsNames?: ValueStringList; + /** + * The private DNS name for the service. + */ + PrivateDnsName?: String; + /** + * Indicates whether the service supports endpoint policies. + */ + VpcEndpointPolicySupported?: Boolean; + /** + * Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner. + */ + AcceptanceRequired?: Boolean; + /** + * Indicates whether the service manages it's VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. + */ + ManagesVpcEndpoints?: Boolean; + } + export type ServiceDetailSet = ServiceDetail[]; + export type ServiceState = "Pending"|"Available"|"Deleting"|"Deleted"|"Failed"|string; + export type ServiceType = "Interface"|"Gateway"|string; + export interface ServiceTypeDetail { + /** + * The type of service. + */ + ServiceType?: ServiceType; + } + export type ServiceTypeDetailSet = ServiceTypeDetail[]; + export type ShutdownBehavior = "stop"|"terminate"|string; + export interface SlotDateTimeRangeRequest { + /** + * The earliest date and time, in UTC, for the Scheduled Instance to start. + */ + EarliestTime: DateTime; + /** + * The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future. + */ + LatestTime: DateTime; + } + export interface SlotStartTimeRangeRequest { + /** + * The earliest date and time, in UTC, for the Scheduled Instance to start. + */ + EarliestTime?: DateTime; + /** + * The latest date and time, in UTC, for the Scheduled Instance to start. + */ + LatestTime?: DateTime; + } + export interface Snapshot { + /** + * The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation. + */ + DataEncryptionKeyId?: String; + /** + * The description for the snapshot. + */ + Description?: String; + /** + * Indicates whether the snapshot is encrypted. + */ + Encrypted?: Boolean; + /** + * The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume. + */ + KmsKeyId?: String; + /** + * The AWS account ID of the EBS snapshot owner. + */ + OwnerId?: String; + /** + * The progress of the snapshot, as a percentage. + */ + Progress?: String; + /** + * The ID of the snapshot. Each snapshot receives a unique identifier when it is created. + */ + SnapshotId?: String; + /** + * The time stamp when the snapshot was initiated. + */ + StartTime?: DateTime; + /** + * The snapshot state. + */ + State?: SnapshotState; + /** + * Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation. + */ + StateMessage?: String; + /** + * The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose. + */ + VolumeId?: String; + /** + * The size of the volume, in GiB. + */ + VolumeSize?: Integer; + /** + * Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console. + */ + OwnerAlias?: String; + /** + * Any tags assigned to the snapshot. + */ + Tags?: TagList; + } + export type SnapshotAttributeName = "productCodes"|"createVolumePermission"|string; + export interface SnapshotDetail { + /** + * A description for the snapshot. + */ + Description?: String; + /** + * The block device mapping for the snapshot. + */ + DeviceName?: String; + /** + * The size of the disk in the snapshot, in GiB. + */ + DiskImageSize?: Double; + /** + * The format of the disk image from which the snapshot is created. + */ + Format?: String; + /** + * The percentage of progress for the task. + */ + Progress?: String; + /** + * The snapshot ID of the disk being imported. + */ + SnapshotId?: String; + /** + * A brief status of the snapshot creation. + */ + Status?: String; + /** + * A detailed status message for the snapshot creation. + */ + StatusMessage?: String; + /** + * The URL used to access the disk image. + */ + Url?: String; + /** + * The S3 bucket for the disk image. + */ + UserBucket?: UserBucketDetails; + } + export type SnapshotDetailList = SnapshotDetail[]; + export interface SnapshotDiskContainer { + /** + * The description of the disk image being imported. + */ + Description?: String; + /** + * The format of the disk image being imported. Valid values: VHD | VMDK + */ + Format?: String; + /** + * The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). + */ + Url?: String; + /** + * The S3 bucket for the disk image. + */ + UserBucket?: UserBucket; + } + export type SnapshotIdStringList = String[]; + export type SnapshotList = Snapshot[]; + export type SnapshotState = "pending"|"completed"|"error"|string; + export interface SnapshotTaskDetail { + /** + * The description of the snapshot. + */ + Description?: String; + /** + * The size of the disk in the snapshot, in GiB. + */ + DiskImageSize?: Double; + /** + * Indicates whether the snapshot is encrypted. + */ + Encrypted?: Boolean; + /** + * The format of the disk image from which the snapshot is created. + */ + Format?: String; + /** + * The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted snapshot. + */ + KmsKeyId?: String; + /** + * The percentage of completion for the import snapshot task. + */ + Progress?: String; + /** + * The snapshot ID of the disk being imported. + */ + SnapshotId?: String; + /** + * A brief status for the import snapshot task. + */ + Status?: String; + /** + * A detailed status message for the import snapshot task. + */ + StatusMessage?: String; + /** + * The URL of the disk image from which the snapshot is created. + */ + Url?: String; + /** + * The S3 bucket for the disk image. + */ + UserBucket?: UserBucketDetails; + } + export type SpotAllocationStrategy = "lowest-price"|"diversified"|string; + export interface SpotDatafeedSubscription { + /** + * The Amazon S3 bucket where the Spot Instance data feed is located. + */ + Bucket?: String; + /** + * The fault codes for the Spot Instance request, if any. + */ + Fault?: SpotInstanceStateFault; + /** + * The AWS account ID of the account. + */ + OwnerId?: String; + /** + * The prefix that is prepended to data feed files. + */ + Prefix?: String; + /** + * The state of the Spot Instance data feed subscription. + */ + State?: DatafeedSubscriptionState; + } + export interface SpotFleetLaunchSpecification { + /** + * One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups. + */ + SecurityGroups?: GroupIdentifierList; + /** + * Deprecated. + */ + AddressingType?: String; + /** + * One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. + */ + BlockDeviceMappings?: BlockDeviceMappingList; + /** + * Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. Default: false + */ + EbsOptimized?: Boolean; + /** + * The IAM instance profile. + */ + IamInstanceProfile?: IamInstanceProfileSpecification; + /** + * The ID of the AMI. + */ + ImageId?: String; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * The ID of the kernel. + */ + KernelId?: String; + /** + * The name of the key pair. + */ + KeyName?: String; + /** + * Enable or disable monitoring for the instances. + */ + Monitoring?: SpotFleetMonitoring; + /** + * One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface. + */ + NetworkInterfaces?: InstanceNetworkInterfaceSpecificationList; + /** + * The placement information. + */ + Placement?: SpotPlacement; + /** + * The ID of the RAM disk. + */ + RamdiskId?: String; + /** + * The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity. + */ + SpotPrice?: String; + /** + * The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08". + */ + SubnetId?: String; + /** + * The Base64-encoded user data to make available to the instances. + */ + UserData?: String; + /** + * The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O). If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1. + */ + WeightedCapacity?: Double; + /** + * The tags to apply during creation. + */ + TagSpecifications?: SpotFleetTagSpecificationList; + } + export interface SpotFleetMonitoring { + /** + * Enables monitoring for the instance. Default: false + */ + Enabled?: Boolean; + } + export interface SpotFleetRequestConfig { + /** + * The progress of the Spot Fleet request. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating. + */ + ActivityStatus?: ActivityStatus; + /** + * The creation date and time of the request. + */ + CreateTime?: DateTime; + /** + * The configuration of the Spot Fleet request. + */ + SpotFleetRequestConfig?: SpotFleetRequestConfigData; + /** + * The ID of the Spot Fleet request. + */ + SpotFleetRequestId?: String; + /** + * The state of the Spot Fleet request. + */ + SpotFleetRequestState?: BatchState; + } + export interface SpotFleetRequestConfigData { + /** + * Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice. + */ + AllocationStrategy?: AllocationStrategy; + /** + * The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice. + */ + OnDemandAllocationStrategy?: OnDemandAllocationStrategy; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency. + */ + ClientToken?: String; + /** + * Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. + */ + ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy; + /** + * The number of units fulfilled by this request compared to the set target capacity. You cannot set this value. + */ + FulfilledCapacity?: Double; + /** + * The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity. + */ + OnDemandFulfilledCapacity?: Double; + /** + * Grants the Spot Fleet permission to terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set terminateInstancesWithExpiration. + */ + IamFleetRole: String; + /** + * The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. + */ + LaunchSpecifications?: LaunchSpecsList; + /** + * The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. + */ + LaunchTemplateConfigs?: LaunchTemplateConfigList; + /** + * The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. + */ + SpotPrice?: String; + /** + * The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later. + */ + TargetCapacity: Integer; + /** + * The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later. + */ + OnDemandTargetCapacity?: Integer; + /** + * Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires. + */ + TerminateInstancesWithExpiration?: Boolean; + /** + * The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet. + */ + Type?: FleetType; + /** + * The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. + */ + ValidFrom?: DateTime; + /** + * The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it. + */ + ValidUntil?: DateTime; + /** + * Indicates whether Spot Fleet should replace unhealthy instances. + */ + ReplaceUnhealthyInstances?: Boolean; + /** + * The behavior when a Spot Instance is interrupted. The default is terminate. + */ + InstanceInterruptionBehavior?: InstanceInterruptionBehavior; + /** + * One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups. With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. + */ + LoadBalancersConfig?: LoadBalancersConfig; + /** + * The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify. + */ + InstancePoolsToUseCount?: Integer; + } + export type SpotFleetRequestConfigSet = SpotFleetRequestConfig[]; + export interface SpotFleetTagSpecification { + /** + * The type of resource. Currently, the only resource type that is supported is instance. + */ + ResourceType?: ResourceType; + /** + * The tags. + */ + Tags?: TagList; + } + export type SpotFleetTagSpecificationList = SpotFleetTagSpecification[]; + export type SpotInstanceInterruptionBehavior = "hibernate"|"stop"|"terminate"|string; + export interface SpotInstanceRequest { + /** + * If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs. + */ + ActualBlockHourlyPrice?: String; + /** + * The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. + */ + AvailabilityZoneGroup?: String; + /** + * The duration for the Spot Instance, in minutes. + */ + BlockDurationMinutes?: Integer; + /** + * The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + CreateTime?: DateTime; + /** + * The fault codes for the Spot Instance request, if any. + */ + Fault?: SpotInstanceStateFault; + /** + * The instance ID, if an instance has been launched to fulfill the Spot Instance request. + */ + InstanceId?: String; + /** + * The instance launch group. Launch groups are Spot Instances that launch together and terminate together. + */ + LaunchGroup?: String; + /** + * Additional information for launching instances. + */ + LaunchSpecification?: LaunchSpecification; + /** + * The Availability Zone in which the request is launched. + */ + LaunchedAvailabilityZone?: String; + /** + * The product description associated with the Spot Instance. + */ + ProductDescription?: RIProductDescription; + /** + * The ID of the Spot Instance request. + */ + SpotInstanceRequestId?: String; + /** + * The maximum price per hour that you are willing to pay for a Spot Instance. + */ + SpotPrice?: String; + /** + * The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances. + */ + State?: SpotInstanceState; + /** + * The status code and status message describing the Spot Instance request. + */ + Status?: SpotInstanceStatus; + /** + * Any tags assigned to the resource. + */ + Tags?: TagList; + /** + * The Spot Instance request type. + */ + Type?: SpotInstanceType; + /** + * The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time. + */ + ValidFrom?: DateTime; + /** + * The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date. + */ + ValidUntil?: DateTime; + /** + * The behavior when a Spot Instance is interrupted. + */ + InstanceInterruptionBehavior?: InstanceInterruptionBehavior; + } + export type SpotInstanceRequestIdList = String[]; + export type SpotInstanceRequestList = SpotInstanceRequest[]; + export type SpotInstanceState = "open"|"active"|"closed"|"cancelled"|"failed"|string; + export interface SpotInstanceStateFault { + /** + * The reason code for the Spot Instance state change. + */ + Code?: String; + /** + * The message for the Spot Instance state change. + */ + Message?: String; + } + export interface SpotInstanceStatus { + /** + * The status code. For a list of status codes, see Spot Status Codes in the Amazon EC2 User Guide for Linux Instances. + */ + Code?: String; + /** + * The description for the status code. + */ + Message?: String; + /** + * The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + UpdateTime?: DateTime; + } + export type SpotInstanceType = "one-time"|"persistent"|string; + export interface SpotMarketOptions { + /** + * The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price. + */ + MaxPrice?: String; + /** + * The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop. + */ + SpotInstanceType?: SpotInstanceType; + /** + * The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). + */ + BlockDurationMinutes?: Integer; + /** + * The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date. + */ + ValidUntil?: DateTime; + /** + * The behavior when a Spot Instance is interrupted. The default is terminate. + */ + InstanceInterruptionBehavior?: InstanceInterruptionBehavior; + } + export interface SpotOptions { + /** + * Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowest-price. + */ + AllocationStrategy?: SpotAllocationStrategy; + /** + * The behavior when a Spot Instance is interrupted. The default is terminate. + */ + InstanceInterruptionBehavior?: SpotInstanceInterruptionBehavior; + /** + * The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowestPrice. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify. + */ + InstancePoolsToUseCount?: Integer; + /** + * Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. + */ + SingleInstanceType?: Boolean; + /** + * Indicates that the fleet launches all Spot Instances into a single Availability Zone. + */ + SingleAvailabilityZone?: Boolean; + /** + * The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances. + */ + MinTargetCapacity?: Integer; + } + export interface SpotOptionsRequest { + /** + * Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice. + */ + AllocationStrategy?: SpotAllocationStrategy; + /** + * The behavior when a Spot Instance is interrupted. The default is terminate. + */ + InstanceInterruptionBehavior?: SpotInstanceInterruptionBehavior; + /** + * The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify. + */ + InstancePoolsToUseCount?: Integer; + /** + * Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. + */ + SingleInstanceType?: Boolean; + /** + * Indicates that the fleet launches all Spot Instances into a single Availability Zone. + */ + SingleAvailabilityZone?: Boolean; + /** + * The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances. + */ + MinTargetCapacity?: Integer; + } + export interface SpotPlacement { + /** + * The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b". + */ + AvailabilityZone?: String; + /** + * The name of the placement group. + */ + GroupName?: String; + /** + * The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances. + */ + Tenancy?: Tenancy; + } + export interface SpotPrice { + /** + * The Availability Zone. + */ + AvailabilityZone?: String; + /** + * The instance type. + */ + InstanceType?: InstanceType; + /** + * A general description of the AMI. + */ + ProductDescription?: RIProductDescription; + /** + * The maximum price per hour that you are willing to pay for a Spot Instance. + */ + SpotPrice?: String; + /** + * The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). + */ + Timestamp?: DateTime; + } + export type SpotPriceHistoryList = SpotPrice[]; + export interface StaleIpPermission { + /** + * The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. + */ + FromPort?: Integer; + /** + * The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers). + */ + IpProtocol?: String; + /** + * The IP ranges. Not applicable for stale security group rules. + */ + IpRanges?: IpRanges; + /** + * The prefix list IDs for an AWS service. Not applicable for stale security group rules. + */ + PrefixListIds?: PrefixListIdSet; + /** + * The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. + */ + ToPort?: Integer; + /** + * The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection. + */ + UserIdGroupPairs?: UserIdGroupPairSet; + } + export type StaleIpPermissionSet = StaleIpPermission[]; + export interface StaleSecurityGroup { + /** + * The description of the security group. + */ + Description?: String; + /** + * The ID of the security group. + */ + GroupId?: String; + /** + * The name of the security group. + */ + GroupName?: String; + /** + * Information about the stale inbound rules in the security group. + */ + StaleIpPermissions?: StaleIpPermissionSet; + /** + * Information about the stale outbound rules in the security group. + */ + StaleIpPermissionsEgress?: StaleIpPermissionSet; + /** + * The ID of the VPC for the security group. + */ + VpcId?: String; + } + export type StaleSecurityGroupSet = StaleSecurityGroup[]; + export interface StartInstancesRequest { + /** + * The IDs of the instances. + */ + InstanceIds: InstanceIdStringList; + /** + * Reserved. + */ + AdditionalInfo?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface StartInstancesResult { + /** + * Information about the started instances. + */ + StartingInstances?: InstanceStateChangeList; + } + export type State = "PendingAcceptance"|"Pending"|"Available"|"Deleting"|"Deleted"|"Rejected"|"Failed"|"Expired"|string; + export interface StateReason { + /** + * The reason code for the state change. + */ + Code?: String; + /** + * The message for the state change. Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request. Server.InternalError: An internal error caused the instance to terminate during launch. Server.ScheduledStop: The instance was stopped due to a scheduled retirement. Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance. Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation. Client.InternalError: A client error caused the instance to terminate during launch. Client.InvalidSnapshot.NotFound: The specified snapshot was not found. Client.UserInitiatedHibernate: Hibernation was initiated on the instance. Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API. Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. + */ + Message?: String; + } + export type Status = "MoveInProgress"|"InVpc"|"InClassic"|string; + export type StatusName = "reachability"|string; + export type StatusType = "passed"|"failed"|"insufficient-data"|"initializing"|string; + export interface StopInstancesRequest { + /** + * The IDs of the instances. + */ + InstanceIds: InstanceIdStringList; + /** + * Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide. Default: false + */ + Hibernate?: Boolean; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. Default: false + */ + Force?: Boolean; + } + export interface StopInstancesResult { + /** + * Information about the stopped instances. + */ + StoppingInstances?: InstanceStateChangeList; + } + export interface Storage { + /** + * An Amazon S3 storage location. + */ + S3?: S3Storage; + } + export interface StorageLocation { + /** + * The name of the S3 bucket. + */ + Bucket?: String; + /** + * The key. + */ + Key?: String; + } + export type String = string; + export interface Subnet { + /** + * The Availability Zone of the subnet. + */ + AvailabilityZone?: String; + /** + * The AZ ID of the subnet. + */ + AvailabilityZoneId?: String; + /** + * The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable. + */ + AvailableIpAddressCount?: Integer; + /** + * The IPv4 CIDR block assigned to the subnet. + */ + CidrBlock?: String; + /** + * Indicates whether this is the default subnet for the Availability Zone. + */ + DefaultForAz?: Boolean; + /** + * Indicates whether instances launched in this subnet receive a public IPv4 address. + */ + MapPublicIpOnLaunch?: Boolean; + /** + * The current state of the subnet. + */ + State?: SubnetState; + /** + * The ID of the subnet. + */ + SubnetId?: String; + /** + * The ID of the VPC the subnet is in. + */ + VpcId?: String; + /** + * The ID of the AWS account that owns the subnet. + */ + OwnerId?: String; + /** + * Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address. + */ + AssignIpv6AddressOnCreation?: Boolean; + /** + * Information about the IPv6 CIDR blocks associated with the subnet. + */ + Ipv6CidrBlockAssociationSet?: SubnetIpv6CidrBlockAssociationSet; + /** + * Any tags assigned to the subnet. + */ + Tags?: TagList; + /** + * The Amazon Resource Name (ARN) of the subnet. + */ + SubnetArn?: String; + } + export interface SubnetCidrBlockState { + /** + * The state of a CIDR block. + */ + State?: SubnetCidrBlockStateCode; + /** + * A message about the status of the CIDR block, if applicable. + */ + StatusMessage?: String; + } + export type SubnetCidrBlockStateCode = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed"|string; + export type SubnetIdStringList = String[]; + export interface SubnetIpv6CidrBlockAssociation { + /** + * The association ID for the CIDR block. + */ + AssociationId?: String; + /** + * The IPv6 CIDR block. + */ + Ipv6CidrBlock?: String; + /** + * Information about the state of the CIDR block. + */ + Ipv6CidrBlockState?: SubnetCidrBlockState; + } + export type SubnetIpv6CidrBlockAssociationSet = SubnetIpv6CidrBlockAssociation[]; + export type SubnetList = Subnet[]; + export type SubnetState = "pending"|"available"|string; + export interface SuccessfulInstanceCreditSpecificationItem { + /** + * The ID of the instance. + */ + InstanceId?: String; + } + export type SuccessfulInstanceCreditSpecificationSet = SuccessfulInstanceCreditSpecificationItem[]; + export type SummaryStatus = "ok"|"impaired"|"insufficient-data"|"not-applicable"|"initializing"|string; + export interface Tag { + /** + * The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:. + */ + Key?: String; + /** + * The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. + */ + Value?: String; + } + export interface TagDescription { + /** + * The tag key. + */ + Key?: String; + /** + * The ID of the resource. + */ + ResourceId?: String; + /** + * The resource type. + */ + ResourceType?: ResourceType; + /** + * The tag value. + */ + Value?: String; + } + export type TagDescriptionList = TagDescription[]; + export type TagList = Tag[]; + export interface TagSpecification { + /** + * The type of resource to tag. Currently, the resource types that support tagging on creation are fleet, dedicated-host, instance, snapshot, and volume. To tag a resource after it has been created, see CreateTags. + */ + ResourceType?: ResourceType; + /** + * The tags to apply to the resource. + */ + Tags?: TagList; + } + export type TagSpecificationList = TagSpecification[]; + export interface TargetCapacitySpecification { + /** + * The number of units to request, filled using DefaultTargetCapacityType. + */ + TotalTargetCapacity?: Integer; + /** + * The number of On-Demand units to request. + */ + OnDemandTargetCapacity?: Integer; + /** + * The maximum number of Spot units to launch. + */ + SpotTargetCapacity?: Integer; + /** + * The default TotalTargetCapacity, which is either Spot or On-Demand. + */ + DefaultTargetCapacityType?: DefaultTargetCapacityType; + } + export interface TargetCapacitySpecificationRequest { + /** + * The number of units to request, filled using DefaultTargetCapacityType. + */ + TotalTargetCapacity: Integer; + /** + * The number of On-Demand units to request. + */ + OnDemandTargetCapacity?: Integer; + /** + * The number of Spot units to request. + */ + SpotTargetCapacity?: Integer; + /** + * The default TotalTargetCapacity, which is either Spot or On-Demand. + */ + DefaultTargetCapacityType?: DefaultTargetCapacityType; + } + export interface TargetConfiguration { + /** + * The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request + */ + InstanceCount?: Integer; + /** + * The ID of the Convertible Reserved Instance offering. + */ + OfferingId?: String; + } + export interface TargetConfigurationRequest { + /** + * The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request + */ + InstanceCount?: Integer; + /** + * The Convertible Reserved Instance offering ID. + */ + OfferingId: String; + } + export type TargetConfigurationRequestSet = TargetConfigurationRequest[]; + export interface TargetGroup { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + Arn?: String; + } + export type TargetGroups = TargetGroup[]; + export interface TargetGroupsConfig { + /** + * One or more target groups. + */ + TargetGroups?: TargetGroups; + } + export interface TargetNetwork { + /** + * The ID of the association. + */ + AssociationId?: String; + /** + * The ID of the VPC in which the target network (subnet) is located. + */ + VpcId?: String; + /** + * The ID of the subnet specified as the target network. + */ + TargetNetworkId?: String; + /** + * The ID of the Client VPN endpoint with which the target network is associated. + */ + ClientVpnEndpointId?: String; + /** + * The current state of the target network association. + */ + Status?: AssociationStatus; + /** + * The IDs of the security groups applied to the target network association. + */ + SecurityGroups?: ValueStringList; + } + export type TargetNetworkSet = TargetNetwork[]; + export interface TargetReservationValue { + /** + * The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange. + */ + ReservationValue?: ReservationValue; + /** + * The configuration of the Convertible Reserved Instances that make up the exchange. + */ + TargetConfiguration?: TargetConfiguration; + } + export type TargetReservationValueSet = TargetReservationValue[]; + export type TelemetryStatus = "UP"|"DOWN"|string; + export type Tenancy = "default"|"dedicated"|"host"|string; + export interface TerminateClientVpnConnectionsRequest { + /** + * The ID of the Client VPN endpoint to which the client is connected. + */ + ClientVpnEndpointId: String; + /** + * The ID of the client connection to be terminated. + */ + ConnectionId?: String; + /** + * The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections. + */ + Username?: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface TerminateClientVpnConnectionsResult { + /** + * The ID of the Client VPN endpoint. + */ + ClientVpnEndpointId?: String; + /** + * The user who established the terminated client connections. + */ + Username?: String; + /** + * The current state of the client connections. + */ + ConnectionStatuses?: TerminateConnectionStatusSet; + } + export interface TerminateConnectionStatus { + /** + * The ID of the client connection. + */ + ConnectionId?: String; + /** + * The state of the client connection. + */ + PreviousStatus?: ClientVpnConnectionStatus; + /** + * A message about the status of the client connection, if applicable. + */ + CurrentStatus?: ClientVpnConnectionStatus; + } + export type TerminateConnectionStatusSet = TerminateConnectionStatus[]; + export interface TerminateInstancesRequest { + /** + * The IDs of the instances. Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches. + */ + InstanceIds: InstanceIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface TerminateInstancesResult { + /** + * Information about the terminated instances. + */ + TerminatingInstances?: InstanceStateChangeList; + } + export type TrafficType = "ACCEPT"|"REJECT"|"ALL"|string; + export interface TransitGateway { + /** + * The ID of the transit gateway. + */ + TransitGatewayId?: String; + /** + * The Amazon Resource Name (ARN) of the transit gateway. + */ + TransitGatewayArn?: String; + /** + * The state of the transit gateway. + */ + State?: TransitGatewayState; + /** + * The ID of the AWS account ID that owns the transit gateway. + */ + OwnerId?: String; + /** + * The description of the transit gateway. + */ + Description?: String; + /** + * The creation time. + */ + CreationTime?: DateTime; + /** + * The transit gateway options. + */ + Options?: TransitGatewayOptions; + /** + * The tags for the transit gateway. + */ + Tags?: TagList; + } + export interface TransitGatewayAssociation { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId?: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * The ID of the resource. + */ + ResourceId?: String; + /** + * The resource type. + */ + ResourceType?: TransitGatewayAttachmentResourceType; + /** + * The state of the association. + */ + State?: TransitGatewayAssociationState; + } + export type TransitGatewayAssociationState = "associating"|"associated"|"disassociating"|"disassociated"|string; + export interface TransitGatewayAttachment { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * The ID of the transit gateway. + */ + TransitGatewayId?: String; + /** + * The ID of the AWS account that owns the transit gateway. + */ + TransitGatewayOwnerId?: String; + /** + * The ID of the AWS account that owns the resource. + */ + ResourceOwnerId?: String; + /** + * The resource type. + */ + ResourceType?: TransitGatewayAttachmentResourceType; + /** + * The ID of the resource. + */ + ResourceId?: String; + /** + * The attachment state. + */ + State?: TransitGatewayAttachmentState; + /** + * The association. + */ + Association?: TransitGatewayAttachmentAssociation; + /** + * The creation time. + */ + CreationTime?: DateTime; + /** + * The tags for the attachment. + */ + Tags?: TagList; + } + export interface TransitGatewayAttachmentAssociation { + /** + * The ID of the route table for the transit gateway. + */ + TransitGatewayRouteTableId?: String; + /** + * The state of the association. + */ + State?: TransitGatewayAssociationState; + } + export type TransitGatewayAttachmentIdStringList = String[]; + export type TransitGatewayAttachmentList = TransitGatewayAttachment[]; + export interface TransitGatewayAttachmentPropagation { + /** + * The ID of the propagation route table. + */ + TransitGatewayRouteTableId?: String; + /** + * The state of the propagation route table. + */ + State?: TransitGatewayPropagationState; + } + export type TransitGatewayAttachmentPropagationList = TransitGatewayAttachmentPropagation[]; + export type TransitGatewayAttachmentResourceType = "vpc"|"vpn"|string; + export type TransitGatewayAttachmentState = "pendingAcceptance"|"rollingBack"|"pending"|"available"|"modifying"|"deleting"|"deleted"|"failed"|"rejected"|"rejecting"|"failing"|string; + export type TransitGatewayIdStringList = String[]; + export type TransitGatewayList = TransitGateway[]; + export type TransitGatewayMaxResults = number; + export interface TransitGatewayOptions { + /** + * A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. + */ + AmazonSideAsn?: Long; + /** + * Indicates whether attachment requests are automatically accepted. + */ + AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue; + /** + * Indicates whether resource attachments are automatically associated with the default association route table. + */ + DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue; + /** + * The ID of the default association route table. + */ + AssociationDefaultRouteTableId?: String; + /** + * Indicates whether resource attachments automatically propagate routes to the default propagation route table. + */ + DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue; + /** + * The ID of the default propagation route table. + */ + PropagationDefaultRouteTableId?: String; + /** + * Indicates whether Equal Cost Multipath Protocol support is enabled. + */ + VpnEcmpSupport?: VpnEcmpSupportValue; + /** + * Indicates whether DNS support is enabled. + */ + DnsSupport?: DnsSupportValue; + } + export interface TransitGatewayPropagation { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * The ID of the resource. + */ + ResourceId?: String; + /** + * The resource type. + */ + ResourceType?: TransitGatewayAttachmentResourceType; + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId?: String; + /** + * The state. + */ + State?: TransitGatewayPropagationState; + } + export type TransitGatewayPropagationState = "enabling"|"enabled"|"disabling"|"disabled"|string; + export interface TransitGatewayRequestOptions { + /** + * A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. + */ + AmazonSideAsn?: Long; + /** + * Enable or disable automatic acceptance of attachment requests. The default is disable. + */ + AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue; + /** + * Enable or disable automatic association with the default association route table. The default is enable. + */ + DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue; + /** + * Enable or disable automatic propagation of routes to the default propagation route table. The default is enable. + */ + DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue; + /** + * Enable or disable Equal Cost Multipath Protocol support. + */ + VpnEcmpSupport?: VpnEcmpSupportValue; + /** + * Enable or disable DNS support. + */ + DnsSupport?: DnsSupportValue; + } + export interface TransitGatewayRoute { + /** + * The CIDR block used for destination matches. + */ + DestinationCidrBlock?: String; + /** + * The attachments. + */ + TransitGatewayAttachments?: TransitGatewayRouteAttachmentList; + /** + * The route type. + */ + Type?: TransitGatewayRouteType; + /** + * The state of the route. + */ + State?: TransitGatewayRouteState; + } + export interface TransitGatewayRouteAttachment { + /** + * The ID of the resource. + */ + ResourceId?: String; + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * The resource type. + */ + ResourceType?: TransitGatewayAttachmentResourceType; + } + export type TransitGatewayRouteAttachmentList = TransitGatewayRouteAttachment[]; + export type TransitGatewayRouteList = TransitGatewayRoute[]; + export type TransitGatewayRouteState = "pending"|"active"|"blackhole"|"deleting"|"deleted"|string; + export interface TransitGatewayRouteTable { + /** + * The ID of the transit gateway route table. + */ + TransitGatewayRouteTableId?: String; + /** + * The ID of the transit gateway. + */ + TransitGatewayId?: String; + /** + * The state of the transit gateway route table. + */ + State?: TransitGatewayRouteTableState; + /** + * Indicates whether this is the default association route table for the transit gateway. + */ + DefaultAssociationRouteTable?: Boolean; + /** + * Indicates whether this is the default propagation route table for the transit gateway. + */ + DefaultPropagationRouteTable?: Boolean; + /** + * The creation time. + */ + CreationTime?: DateTime; + /** + * Any tags assigned to the route table. + */ + Tags?: TagList; + } + export interface TransitGatewayRouteTableAssociation { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * The ID of the resource. + */ + ResourceId?: String; + /** + * The resource type. + */ + ResourceType?: TransitGatewayAttachmentResourceType; + /** + * The state of the association. + */ + State?: TransitGatewayAssociationState; + } + export type TransitGatewayRouteTableAssociationList = TransitGatewayRouteTableAssociation[]; + export type TransitGatewayRouteTableIdStringList = String[]; + export type TransitGatewayRouteTableList = TransitGatewayRouteTable[]; + export interface TransitGatewayRouteTablePropagation { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * The ID of the resource. + */ + ResourceId?: String; + /** + * The type of resource. + */ + ResourceType?: TransitGatewayAttachmentResourceType; + /** + * The state of the resource. + */ + State?: TransitGatewayPropagationState; + } + export type TransitGatewayRouteTablePropagationList = TransitGatewayRouteTablePropagation[]; + export type TransitGatewayRouteTableState = "pending"|"available"|"deleting"|"deleted"|string; + export type TransitGatewayRouteType = "static"|"propagated"|string; + export type TransitGatewayState = "pending"|"available"|"modifying"|"deleting"|"deleted"|string; + export interface TransitGatewayVpcAttachment { + /** + * The ID of the attachment. + */ + TransitGatewayAttachmentId?: String; + /** + * The ID of the transit gateway. + */ + TransitGatewayId?: String; + /** + * The ID of the VPC. + */ + VpcId?: String; + /** + * The ID of the AWS account that owns the VPC. + */ + VpcOwnerId?: String; + /** + * The state of the VPC attachment. + */ + State?: TransitGatewayAttachmentState; + /** + * The IDs of the subnets. + */ + SubnetIds?: ValueStringList; + /** + * The creation time. + */ + CreationTime?: DateTime; + /** + * The VPC attachment options. + */ + Options?: TransitGatewayVpcAttachmentOptions; + /** + * The tags for the VPC attachment. + */ + Tags?: TagList; + } + export type TransitGatewayVpcAttachmentList = TransitGatewayVpcAttachment[]; + export interface TransitGatewayVpcAttachmentOptions { + /** + * Indicates whether DNS support is enabled. + */ + DnsSupport?: DnsSupportValue; + /** + * Indicates whether IPv6 support is enabled. + */ + Ipv6Support?: Ipv6SupportValue; + } + export type TransportProtocol = "tcp"|"udp"|string; + export type TunnelOptionsList = VpnTunnelOptionsSpecification[]; + export interface UnassignIpv6AddressesRequest { + /** + * The IPv6 addresses to unassign from the network interface. + */ + Ipv6Addresses: Ipv6AddressList; + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + } + export interface UnassignIpv6AddressesResult { + /** + * The ID of the network interface. + */ + NetworkInterfaceId?: String; + /** + * The IPv6 addresses that have been unassigned from the network interface. + */ + UnassignedIpv6Addresses?: Ipv6AddressList; + } + export interface UnassignPrivateIpAddressesRequest { + /** + * The ID of the network interface. + */ + NetworkInterfaceId: String; + /** + * The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address. + */ + PrivateIpAddresses: PrivateIpAddressStringList; + } + export interface UnmonitorInstancesRequest { + /** + * The IDs of the instances. + */ + InstanceIds: InstanceIdStringList; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface UnmonitorInstancesResult { + /** + * The monitoring information. + */ + InstanceMonitorings?: InstanceMonitoringList; + } + export type UnsuccessfulInstanceCreditSpecificationErrorCode = "InvalidInstanceID.Malformed"|"InvalidInstanceID.NotFound"|"IncorrectInstanceState"|"InstanceCreditSpecification.NotSupported"|string; + export interface UnsuccessfulInstanceCreditSpecificationItem { + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The applicable error for the T2 or T3 instance whose credit option for CPU usage was not modified. + */ + Error?: UnsuccessfulInstanceCreditSpecificationItemError; + } + export interface UnsuccessfulInstanceCreditSpecificationItemError { + /** + * The error code. + */ + Code?: UnsuccessfulInstanceCreditSpecificationErrorCode; + /** + * The applicable error message. + */ + Message?: String; + } + export type UnsuccessfulInstanceCreditSpecificationSet = UnsuccessfulInstanceCreditSpecificationItem[]; + export interface UnsuccessfulItem { + /** + * Information about the error. + */ + Error?: UnsuccessfulItemError; + /** + * The ID of the resource. + */ + ResourceId?: String; + } + export interface UnsuccessfulItemError { + /** + * The error code. + */ + Code?: String; + /** + * The error message accompanying the error code. + */ + Message?: String; + } + export type UnsuccessfulItemList = UnsuccessfulItem[]; + export type UnsuccessfulItemSet = UnsuccessfulItem[]; + export interface UpdateSecurityGroupRuleDescriptionsEgressRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + */ + GroupId?: String; + /** + * [Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. + */ + GroupName?: String; + /** + * The IP permissions for the security group rule. + */ + IpPermissions: IpPermissionList; + } + export interface UpdateSecurityGroupRuleDescriptionsEgressResult { + /** + * Returns true if the request succeeds; otherwise, returns an error. + */ + Return?: Boolean; + } + export interface UpdateSecurityGroupRuleDescriptionsIngressRequest { + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + /** + * The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + */ + GroupId?: String; + /** + * [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. + */ + GroupName?: String; + /** + * The IP permissions for the security group rule. + */ + IpPermissions: IpPermissionList; + } + export interface UpdateSecurityGroupRuleDescriptionsIngressResult { + /** + * Returns true if the request succeeds; otherwise, returns an error. + */ + Return?: Boolean; + } + export interface UserBucket { + /** + * The name of the S3 bucket where the disk image is located. + */ + S3Bucket?: String; + /** + * The file name of the disk image. + */ + S3Key?: String; + } + export interface UserBucketDetails { + /** + * The S3 bucket from which the disk image was created. + */ + S3Bucket?: String; + /** + * The file name of the disk image. + */ + S3Key?: String; + } + export interface UserData { + /** + * The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text. + */ + Data?: String; + } + export type UserGroupStringList = String[]; + export interface UserIdGroupPair { + /** + * A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* + */ + Description?: String; + /** + * The ID of the security group. + */ + GroupId?: String; + /** + * The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. + */ + GroupName?: String; + /** + * The status of a VPC peering connection, if applicable. + */ + PeeringStatus?: String; + /** + * The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. [EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account. + */ + UserId?: String; + /** + * The ID of the VPC for the referenced security group, if applicable. + */ + VpcId?: String; + /** + * The ID of the VPC peering connection, if applicable. + */ + VpcPeeringConnectionId?: String; + } + export type UserIdGroupPairList = UserIdGroupPair[]; + export type UserIdGroupPairSet = UserIdGroupPair[]; + export type UserIdStringList = String[]; + export type ValueStringList = String[]; + export type VersionDescription = string; + export type VersionStringList = String[]; + export interface VgwTelemetry { + /** + * The number of accepted routes. + */ + AcceptedRouteCount?: Integer; + /** + * The date and time of the last change in status. + */ + LastStatusChange?: DateTime; + /** + * The Internet-routable IP address of the virtual private gateway's outside interface. + */ + OutsideIpAddress?: String; + /** + * The status of the VPN tunnel. + */ + Status?: TelemetryStatus; + /** + * If an error occurs, a description of the error. + */ + StatusMessage?: String; + } + export type VgwTelemetryList = VgwTelemetry[]; + export type VirtualizationType = "hvm"|"paravirtual"|string; + export interface Volume { + /** + * Information about the volume attachments. + */ + Attachments?: VolumeAttachmentList; + /** + * The Availability Zone for the volume. + */ + AvailabilityZone?: String; + /** + * The time stamp when volume creation was initiated. + */ + CreateTime?: DateTime; + /** + * Indicates whether the volume will be encrypted. + */ + Encrypted?: Boolean; + /** + * The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume. + */ + KmsKeyId?: String; + /** + * The size of the volume, in GiBs. + */ + Size?: Integer; + /** + * The snapshot from which the volume was created, if applicable. + */ + SnapshotId?: String; + /** + * The volume state. + */ + State?: VolumeState; + /** + * The ID of the volume. + */ + VolumeId?: String; + /** + * The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes, in most Regions. The maximum IOPS for io1 of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. + */ + Iops?: Integer; + /** + * Any tags assigned to the volume. + */ + Tags?: TagList; + /** + * The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes. + */ + VolumeType?: VolumeType; + } + export interface VolumeAttachment { + /** + * The time stamp when the attachment initiated. + */ + AttachTime?: DateTime; + /** + * The device name. + */ + Device?: String; + /** + * The ID of the instance. + */ + InstanceId?: String; + /** + * The attachment state of the volume. + */ + State?: VolumeAttachmentState; + /** + * The ID of the volume. + */ + VolumeId?: String; + /** + * Indicates whether the EBS volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + } + export type VolumeAttachmentList = VolumeAttachment[]; + export type VolumeAttachmentState = "attaching"|"attached"|"detaching"|"detached"|"busy"|string; + export type VolumeAttributeName = "autoEnableIO"|"productCodes"|string; + export interface VolumeDetail { + /** + * The size of the volume, in GiB. + */ + Size: Long; + } + export type VolumeIdStringList = String[]; + export type VolumeList = Volume[]; + export interface VolumeModification { + /** + * The ID of the volume. + */ + VolumeId?: String; + /** + * The current modification state. The modification state is null for unmodified volumes. + */ + ModificationState?: VolumeModificationState; + /** + * A status message about the modification progress or failure. + */ + StatusMessage?: String; + /** + * The target size of the volume, in GiB. + */ + TargetSize?: Integer; + /** + * The target IOPS rate of the volume. + */ + TargetIops?: Integer; + /** + * The target EBS volume type of the volume. + */ + TargetVolumeType?: VolumeType; + /** + * The original size of the volume. + */ + OriginalSize?: Integer; + /** + * The original IOPS rate of the volume. + */ + OriginalIops?: Integer; + /** + * The original EBS volume type of the volume. + */ + OriginalVolumeType?: VolumeType; + /** + * The modification progress, from 0 to 100 percent complete. + */ + Progress?: Long; + /** + * The modification start time. + */ + StartTime?: DateTime; + /** + * The modification completion or failure time. + */ + EndTime?: DateTime; + } + export type VolumeModificationList = VolumeModification[]; + export type VolumeModificationState = "modifying"|"optimizing"|"completed"|"failed"|string; + export type VolumeState = "creating"|"available"|"in-use"|"deleting"|"deleted"|"error"|string; + export interface VolumeStatusAction { + /** + * The code identifying the operation, for example, enable-volume-io. + */ + Code?: String; + /** + * A description of the operation. + */ + Description?: String; + /** + * The ID of the event associated with this operation. + */ + EventId?: String; + /** + * The event type associated with this operation. + */ + EventType?: String; + } + export type VolumeStatusActionsList = VolumeStatusAction[]; + export interface VolumeStatusDetails { + /** + * The name of the volume status. + */ + Name?: VolumeStatusName; + /** + * The intended status of the volume status. + */ + Status?: String; + } + export type VolumeStatusDetailsList = VolumeStatusDetails[]; + export interface VolumeStatusEvent { + /** + * A description of the event. + */ + Description?: String; + /** + * The ID of this event. + */ + EventId?: String; + /** + * The type of this event. + */ + EventType?: String; + /** + * The latest end time of the event. + */ + NotAfter?: DateTime; + /** + * The earliest start time of the event. + */ + NotBefore?: DateTime; + } + export type VolumeStatusEventsList = VolumeStatusEvent[]; + export interface VolumeStatusInfo { + /** + * The details of the volume status. + */ + Details?: VolumeStatusDetailsList; + /** + * The status of the volume. + */ + Status?: VolumeStatusInfoStatus; + } + export type VolumeStatusInfoStatus = "ok"|"impaired"|"insufficient-data"|string; + export interface VolumeStatusItem { + /** + * The details of the operation. + */ + Actions?: VolumeStatusActionsList; + /** + * The Availability Zone of the volume. + */ + AvailabilityZone?: String; + /** + * A list of events associated with the volume. + */ + Events?: VolumeStatusEventsList; + /** + * The volume ID. + */ + VolumeId?: String; + /** + * The volume status. + */ + VolumeStatus?: VolumeStatusInfo; + } + export type VolumeStatusList = VolumeStatusItem[]; + export type VolumeStatusName = "io-enabled"|"io-performance"|string; + export type VolumeType = "standard"|"io1"|"gp2"|"sc1"|"st1"|string; + export interface Vpc { + /** + * The primary IPv4 CIDR block for the VPC. + */ + CidrBlock?: String; + /** + * The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC). + */ + DhcpOptionsId?: String; + /** + * The current state of the VPC. + */ + State?: VpcState; + /** + * The ID of the VPC. + */ + VpcId?: String; + /** + * The ID of the AWS account that owns the VPC. + */ + OwnerId?: String; + /** + * The allowed tenancy of instances launched into the VPC. + */ + InstanceTenancy?: Tenancy; + /** + * Information about the IPv6 CIDR blocks associated with the VPC. + */ + Ipv6CidrBlockAssociationSet?: VpcIpv6CidrBlockAssociationSet; + /** + * Information about the IPv4 CIDR blocks associated with the VPC. + */ + CidrBlockAssociationSet?: VpcCidrBlockAssociationSet; + /** + * Indicates whether the VPC is the default VPC. + */ + IsDefault?: Boolean; + /** + * Any tags assigned to the VPC. + */ + Tags?: TagList; + } + export interface VpcAttachment { + /** + * The current state of the attachment. + */ + State?: AttachmentStatus; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export type VpcAttachmentList = VpcAttachment[]; + export type VpcAttributeName = "enableDnsSupport"|"enableDnsHostnames"|string; + export interface VpcCidrBlockAssociation { + /** + * The association ID for the IPv4 CIDR block. + */ + AssociationId?: String; + /** + * The IPv4 CIDR block. + */ + CidrBlock?: String; + /** + * Information about the state of the CIDR block. + */ + CidrBlockState?: VpcCidrBlockState; + } + export type VpcCidrBlockAssociationSet = VpcCidrBlockAssociation[]; + export interface VpcCidrBlockState { + /** + * The state of the CIDR block. + */ + State?: VpcCidrBlockStateCode; + /** + * A message about the status of the CIDR block, if applicable. + */ + StatusMessage?: String; + } + export type VpcCidrBlockStateCode = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed"|string; + export interface VpcClassicLink { + /** + * Indicates whether the VPC is enabled for ClassicLink. + */ + ClassicLinkEnabled?: Boolean; + /** + * Any tags assigned to the VPC. + */ + Tags?: TagList; + /** + * The ID of the VPC. + */ + VpcId?: String; + } + export type VpcClassicLinkIdList = String[]; + export type VpcClassicLinkList = VpcClassicLink[]; + export interface VpcEndpoint { + /** + * The ID of the VPC endpoint. + */ + VpcEndpointId?: String; + /** + * The type of endpoint. + */ + VpcEndpointType?: VpcEndpointType; + /** + * The ID of the VPC to which the endpoint is associated. + */ + VpcId?: String; + /** + * The name of the service to which the endpoint is associated. + */ + ServiceName?: String; + /** + * The state of the VPC endpoint. + */ + State?: State; + /** + * The policy document associated with the endpoint, if applicable. + */ + PolicyDocument?: String; + /** + * (Gateway endpoint) One or more route tables associated with the endpoint. + */ + RouteTableIds?: ValueStringList; + /** + * (Interface endpoint) One or more subnets in which the endpoint is located. + */ + SubnetIds?: ValueStringList; + /** + * (Interface endpoint) Information about the security groups associated with the network interface. + */ + Groups?: GroupIdentifierSet; + /** + * (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone. + */ + PrivateDnsEnabled?: Boolean; + /** + * Indicates whether the VPC endpoint is being managed by its service. + */ + RequesterManaged?: Boolean; + /** + * (Interface endpoint) One or more network interfaces for the endpoint. + */ + NetworkInterfaceIds?: ValueStringList; + /** + * (Interface endpoint) The DNS entries for the endpoint. + */ + DnsEntries?: DnsEntrySet; + /** + * The date and time the VPC endpoint was created. + */ + CreationTimestamp?: MillisecondDateTime; + } + export interface VpcEndpointConnection { + /** + * The ID of the service to which the endpoint is connected. + */ + ServiceId?: String; + /** + * The ID of the VPC endpoint. + */ + VpcEndpointId?: String; + /** + * The AWS account ID of the owner of the VPC endpoint. + */ + VpcEndpointOwner?: String; + /** + * The state of the VPC endpoint. + */ + VpcEndpointState?: State; + /** + * The date and time the VPC endpoint was created. + */ + CreationTimestamp?: MillisecondDateTime; + } + export type VpcEndpointConnectionSet = VpcEndpointConnection[]; + export type VpcEndpointSet = VpcEndpoint[]; + export type VpcEndpointType = "Interface"|"Gateway"|string; + export type VpcIdStringList = String[]; + export interface VpcIpv6CidrBlockAssociation { + /** + * The association ID for the IPv6 CIDR block. + */ + AssociationId?: String; + /** + * The IPv6 CIDR block. + */ + Ipv6CidrBlock?: String; + /** + * Information about the state of the CIDR block. + */ + Ipv6CidrBlockState?: VpcCidrBlockState; + } + export type VpcIpv6CidrBlockAssociationSet = VpcIpv6CidrBlockAssociation[]; + export type VpcList = Vpc[]; + export interface VpcPeeringConnection { + /** + * Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection. + */ + AccepterVpcInfo?: VpcPeeringConnectionVpcInfo; + /** + * The time that an unaccepted VPC peering connection will expire. + */ + ExpirationTime?: DateTime; + /** + * Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection. + */ + RequesterVpcInfo?: VpcPeeringConnectionVpcInfo; + /** + * The status of the VPC peering connection. + */ + Status?: VpcPeeringConnectionStateReason; + /** + * Any tags assigned to the resource. + */ + Tags?: TagList; + /** + * The ID of the VPC peering connection. + */ + VpcPeeringConnectionId?: String; + } + export type VpcPeeringConnectionList = VpcPeeringConnection[]; + export interface VpcPeeringConnectionOptionsDescription { + /** + * Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. + */ + AllowDnsResolutionFromRemoteVpc?: Boolean; + /** + * Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. + */ + AllowEgressFromLocalClassicLinkToRemoteVpc?: Boolean; + /** + * Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. + */ + AllowEgressFromLocalVpcToRemoteClassicLink?: Boolean; + } + export interface VpcPeeringConnectionStateReason { + /** + * The status of the VPC peering connection. + */ + Code?: VpcPeeringConnectionStateReasonCode; + /** + * A message that provides more information about the status, if applicable. + */ + Message?: String; + } + export type VpcPeeringConnectionStateReasonCode = "initiating-request"|"pending-acceptance"|"active"|"deleted"|"rejected"|"failed"|"expired"|"provisioning"|"deleting"|string; + export interface VpcPeeringConnectionVpcInfo { + /** + * The IPv4 CIDR block for the VPC. + */ + CidrBlock?: String; + /** + * The IPv6 CIDR block for the VPC. + */ + Ipv6CidrBlockSet?: Ipv6CidrBlockSet; + /** + * Information about the IPv4 CIDR blocks for the VPC. + */ + CidrBlockSet?: CidrBlockSet; + /** + * The AWS account ID of the VPC owner. + */ + OwnerId?: String; + /** + * Information about the VPC peering connection options for the accepter or requester VPC. + */ + PeeringOptions?: VpcPeeringConnectionOptionsDescription; + /** + * The ID of the VPC. + */ + VpcId?: String; + /** + * The region in which the VPC is located. + */ + Region?: String; + } + export type VpcState = "pending"|"available"|string; + export type VpcTenancy = "default"|string; + export interface VpnConnection { + /** + * The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state. + */ + CustomerGatewayConfiguration?: String; + /** + * The ID of the customer gateway at your end of the VPN connection. + */ + CustomerGatewayId?: String; + /** + * The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. + */ + Category?: String; + /** + * The current state of the VPN connection. + */ + State?: VpnState; + /** + * The type of VPN connection. + */ + Type?: GatewayType; + /** + * The ID of the VPN connection. + */ + VpnConnectionId?: String; + /** + * The ID of the virtual private gateway at the AWS side of the VPN connection. + */ + VpnGatewayId?: String; + /** + * The ID of the transit gateway associated with the VPN connection. + */ + TransitGatewayId?: String; + /** + * The VPN connection options. + */ + Options?: VpnConnectionOptions; + /** + * The static routes associated with the VPN connection. + */ + Routes?: VpnStaticRouteList; + /** + * Any tags assigned to the VPN connection. + */ + Tags?: TagList; + /** + * Information about the VPN tunnel. + */ + VgwTelemetry?: VgwTelemetryList; + } + export type VpnConnectionIdStringList = String[]; + export type VpnConnectionList = VpnConnection[]; + export interface VpnConnectionOptions { + /** + * Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. + */ + StaticRoutesOnly?: Boolean; + } + export interface VpnConnectionOptionsSpecification { + /** + * Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route. Default: false + */ + StaticRoutesOnly?: Boolean; + /** + * The tunnel options for the VPN connection. + */ + TunnelOptions?: TunnelOptionsList; + } + export type VpnEcmpSupportValue = "enable"|"disable"|string; + export interface VpnGateway { + /** + * The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned. + */ + AvailabilityZone?: String; + /** + * The current state of the virtual private gateway. + */ + State?: VpnState; + /** + * The type of VPN connection the virtual private gateway supports. + */ + Type?: GatewayType; + /** + * Any VPCs attached to the virtual private gateway. + */ + VpcAttachments?: VpcAttachmentList; + /** + * The ID of the virtual private gateway. + */ + VpnGatewayId?: String; + /** + * The private Autonomous System Number (ASN) for the Amazon side of a BGP session. + */ + AmazonSideAsn?: Long; + /** + * Any tags assigned to the virtual private gateway. + */ + Tags?: TagList; + } + export type VpnGatewayIdStringList = String[]; + export type VpnGatewayList = VpnGateway[]; + export type VpnProtocol = "openvpn"|string; + export type VpnState = "pending"|"available"|"deleting"|"deleted"|string; + export interface VpnStaticRoute { + /** + * The CIDR block associated with the local subnet of the customer data center. + */ + DestinationCidrBlock?: String; + /** + * Indicates how the routes were provided. + */ + Source?: VpnStaticRouteSource; + /** + * The current state of the static route. + */ + State?: VpnState; + } + export type VpnStaticRouteList = VpnStaticRoute[]; + export type VpnStaticRouteSource = "Static"|string; + export interface VpnTunnelOptionsSpecification { + /** + * The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used: 169.254.0.0/30 169.254.1.0/30 169.254.2.0/30 169.254.3.0/30 169.254.4.0/30 169.254.5.0/30 169.254.169.252/30 + */ + TunnelInsideCidr?: String; + /** + * The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway. Constraints: Allowed characters are alphanumeric characters and ._. Must be between 8 and 64 characters in length and cannot start with zero (0). + */ + PreSharedKey?: String; + } + export interface WithdrawByoipCidrRequest { + /** + * The public IPv4 address range, in CIDR notation. + */ + Cidr: String; + /** + * Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. + */ + DryRun?: Boolean; + } + export interface WithdrawByoipCidrResult { + /** + * Information about the address pool. + */ + ByoipCidr?: ByoipCidr; + } + export type ZoneIdStringList = String[]; + export type ZoneNameStringList = String[]; + export type scope = "Availability Zone"|"Region"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-06-15"|"2013-10-15"|"2014-02-01"|"2014-05-01"|"2014-06-15"|"2014-09-01"|"2014-10-01"|"2015-03-01"|"2015-04-15"|"2015-10-01"|"2016-04-01"|"2016-09-15"|"2016-11-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the EC2 client. + */ + export import Types = EC2; +} +export = EC2; diff --git a/node_modules/aws-sdk/clients/ec2.js b/node_modules/aws-sdk/clients/ec2.js new file mode 100644 index 0000000..a102db8 --- /dev/null +++ b/node_modules/aws-sdk/clients/ec2.js @@ -0,0 +1,20 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['ec2'] = {}; +AWS.EC2 = Service.defineService('ec2', ['2013-06-15*', '2013-10-15*', '2014-02-01*', '2014-05-01*', '2014-06-15*', '2014-09-01*', '2014-10-01*', '2015-03-01*', '2015-04-15*', '2015-10-01*', '2016-04-01*', '2016-09-15*', '2016-11-15']); +require('../lib/services/ec2'); +Object.defineProperty(apiLoader.services['ec2'], '2016-11-15', { + get: function get() { + var model = require('../apis/ec2-2016-11-15.min.json'); + model.paginators = require('../apis/ec2-2016-11-15.paginators.json').pagination; + model.waiters = require('../apis/ec2-2016-11-15.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.EC2; diff --git a/node_modules/aws-sdk/clients/ecr.d.ts b/node_modules/aws-sdk/clients/ecr.d.ts new file mode 100644 index 0000000..3ae6e16 --- /dev/null +++ b/node_modules/aws-sdk/clients/ecr.d.ts @@ -0,0 +1,1142 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ECR extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ECR.Types.ClientConfiguration) + config: Config & ECR.Types.ClientConfiguration; + /** + * Check the availability of multiple image layers in a specified registry and repository. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + batchCheckLayerAvailability(params: ECR.Types.BatchCheckLayerAvailabilityRequest, callback?: (err: AWSError, data: ECR.Types.BatchCheckLayerAvailabilityResponse) => void): Request; + /** + * Check the availability of multiple image layers in a specified registry and repository. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + batchCheckLayerAvailability(callback?: (err: AWSError, data: ECR.Types.BatchCheckLayerAvailabilityResponse) => void): Request; + /** + * Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request. + */ + batchDeleteImage(params: ECR.Types.BatchDeleteImageRequest, callback?: (err: AWSError, data: ECR.Types.BatchDeleteImageResponse) => void): Request; + /** + * Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request. + */ + batchDeleteImage(callback?: (err: AWSError, data: ECR.Types.BatchDeleteImageResponse) => void): Request; + /** + * Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest. + */ + batchGetImage(params: ECR.Types.BatchGetImageRequest, callback?: (err: AWSError, data: ECR.Types.BatchGetImageResponse) => void): Request; + /** + * Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest. + */ + batchGetImage(callback?: (err: AWSError, data: ECR.Types.BatchGetImageResponse) => void): Request; + /** + * Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + completeLayerUpload(params: ECR.Types.CompleteLayerUploadRequest, callback?: (err: AWSError, data: ECR.Types.CompleteLayerUploadResponse) => void): Request; + /** + * Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + completeLayerUpload(callback?: (err: AWSError, data: ECR.Types.CompleteLayerUploadResponse) => void): Request; + /** + * Creates an image repository. + */ + createRepository(params: ECR.Types.CreateRepositoryRequest, callback?: (err: AWSError, data: ECR.Types.CreateRepositoryResponse) => void): Request; + /** + * Creates an image repository. + */ + createRepository(callback?: (err: AWSError, data: ECR.Types.CreateRepositoryResponse) => void): Request; + /** + * Deletes the specified lifecycle policy. + */ + deleteLifecyclePolicy(params: ECR.Types.DeleteLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.DeleteLifecyclePolicyResponse) => void): Request; + /** + * Deletes the specified lifecycle policy. + */ + deleteLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.DeleteLifecyclePolicyResponse) => void): Request; + /** + * Deletes an existing image repository. If a repository contains images, you must use the force option to delete it. + */ + deleteRepository(params: ECR.Types.DeleteRepositoryRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request; + /** + * Deletes an existing image repository. If a repository contains images, you must use the force option to delete it. + */ + deleteRepository(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request; + /** + * Deletes the repository policy from a specified repository. + */ + deleteRepositoryPolicy(params: ECR.Types.DeleteRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request; + /** + * Deletes the repository policy from a specified repository. + */ + deleteRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request; + /** + * Returns metadata about the images in a repository, including image size, image tags, and creation date. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages. + */ + describeImages(params: ECR.Types.DescribeImagesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request; + /** + * Returns metadata about the images in a repository, including image size, image tags, and creation date. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages. + */ + describeImages(callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request; + /** + * Describes image repositories in a registry. + */ + describeRepositories(params: ECR.Types.DescribeRepositoriesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request; + /** + * Describes image repositories in a registry. + */ + describeRepositories(callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request; + /** + * Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed. The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process. + */ + getAuthorizationToken(params: ECR.Types.GetAuthorizationTokenRequest, callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request; + /** + * Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed. The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process. + */ + getAuthorizationToken(callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request; + /** + * Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + getDownloadUrlForLayer(params: ECR.Types.GetDownloadUrlForLayerRequest, callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request; + /** + * Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + getDownloadUrlForLayer(callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request; + /** + * Retrieves the specified lifecycle policy. + */ + getLifecyclePolicy(params: ECR.Types.GetLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyResponse) => void): Request; + /** + * Retrieves the specified lifecycle policy. + */ + getLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyResponse) => void): Request; + /** + * Retrieves the results of the specified lifecycle policy preview request. + */ + getLifecyclePolicyPreview(params: ECR.Types.GetLifecyclePolicyPreviewRequest, callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request; + /** + * Retrieves the results of the specified lifecycle policy preview request. + */ + getLifecyclePolicyPreview(callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request; + /** + * Retrieves the repository policy for a specified repository. + */ + getRepositoryPolicy(params: ECR.Types.GetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request; + /** + * Retrieves the repository policy for a specified repository. + */ + getRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request; + /** + * Notify Amazon ECR that you intend to upload an image layer. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + initiateLayerUpload(params: ECR.Types.InitiateLayerUploadRequest, callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request; + /** + * Notify Amazon ECR that you intend to upload an image layer. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + initiateLayerUpload(callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request; + /** + * Lists all the image IDs for a given repository. You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository. + */ + listImages(params: ECR.Types.ListImagesRequest, callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request; + /** + * Lists all the image IDs for a given repository. You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository. + */ + listImages(callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request; + /** + * List the tags for an Amazon ECR resource. + */ + listTagsForResource(params: ECR.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ECR.Types.ListTagsForResourceResponse) => void): Request; + /** + * List the tags for an Amazon ECR resource. + */ + listTagsForResource(callback?: (err: AWSError, data: ECR.Types.ListTagsForResourceResponse) => void): Request; + /** + * Creates or updates the image manifest and tags associated with an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + putImage(params: ECR.Types.PutImageRequest, callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request; + /** + * Creates or updates the image manifest and tags associated with an image. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + putImage(callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request; + /** + * Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template. + */ + putLifecyclePolicy(params: ECR.Types.PutLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.PutLifecyclePolicyResponse) => void): Request; + /** + * Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template. + */ + putLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.PutLifecyclePolicyResponse) => void): Request; + /** + * Applies a repository policy on a specified repository to control access permissions. + */ + setRepositoryPolicy(params: ECR.Types.SetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request; + /** + * Applies a repository policy on a specified repository to control access permissions. + */ + setRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request; + /** + * Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy. + */ + startLifecyclePolicyPreview(params: ECR.Types.StartLifecyclePolicyPreviewRequest, callback?: (err: AWSError, data: ECR.Types.StartLifecyclePolicyPreviewResponse) => void): Request; + /** + * Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy. + */ + startLifecyclePolicyPreview(callback?: (err: AWSError, data: ECR.Types.StartLifecyclePolicyPreviewResponse) => void): Request; + /** + * Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters. + */ + tagResource(params: ECR.Types.TagResourceRequest, callback?: (err: AWSError, data: ECR.Types.TagResourceResponse) => void): Request; + /** + * Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters. + */ + tagResource(callback?: (err: AWSError, data: ECR.Types.TagResourceResponse) => void): Request; + /** + * Deletes specified tags from a resource. + */ + untagResource(params: ECR.Types.UntagResourceRequest, callback?: (err: AWSError, data: ECR.Types.UntagResourceResponse) => void): Request; + /** + * Deletes specified tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: ECR.Types.UntagResourceResponse) => void): Request; + /** + * Uploads an image layer part to Amazon ECR. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + uploadLayerPart(params: ECR.Types.UploadLayerPartRequest, callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request; + /** + * Uploads an image layer part to Amazon ECR. This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. + */ + uploadLayerPart(callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request; +} +declare namespace ECR { + export type Arn = string; + export interface AuthorizationData { + /** + * A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format user:password for private registry authentication using docker login. + */ + authorizationToken?: Base64; + /** + * The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours. + */ + expiresAt?: ExpirationTimestamp; + /** + * The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com.. + */ + proxyEndpoint?: ProxyEndpoint; + } + export type AuthorizationDataList = AuthorizationData[]; + export type Base64 = string; + export interface BatchCheckLayerAvailabilityRequest { + /** + * The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository that is associated with the image layers to check. + */ + repositoryName: RepositoryName; + /** + * The digests of the image layers to check. + */ + layerDigests: BatchedOperationLayerDigestList; + } + export interface BatchCheckLayerAvailabilityResponse { + /** + * A list of image layer objects corresponding to the image layer references in the request. + */ + layers?: LayerList; + /** + * Any failures associated with the call. + */ + failures?: LayerFailureList; + } + export interface BatchDeleteImageRequest { + /** + * The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The repository that contains the image to delete. + */ + repositoryName: RepositoryName; + /** + * A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest. + */ + imageIds: ImageIdentifierList; + } + export interface BatchDeleteImageResponse { + /** + * The image IDs of the deleted images. + */ + imageIds?: ImageIdentifierList; + /** + * Any failures associated with the call. + */ + failures?: ImageFailureList; + } + export interface BatchGetImageRequest { + /** + * The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The repository that contains the images to describe. + */ + repositoryName: RepositoryName; + /** + * A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest. + */ + imageIds: ImageIdentifierList; + /** + * The accepted media types for the request. Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json + */ + acceptedMediaTypes?: MediaTypeList; + } + export interface BatchGetImageResponse { + /** + * A list of image objects corresponding to the image references in the request. + */ + images?: ImageList; + /** + * Any failures associated with the call. + */ + failures?: ImageFailureList; + } + export type BatchedOperationLayerDigest = string; + export type BatchedOperationLayerDigestList = BatchedOperationLayerDigest[]; + export interface CompleteLayerUploadRequest { + /** + * The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository to associate with the image layer. + */ + repositoryName: RepositoryName; + /** + * The upload ID from a previous InitiateLayerUpload operation to associate with the image layer. + */ + uploadId: UploadId; + /** + * The sha256 digest of the image layer. + */ + layerDigests: LayerDigestList; + } + export interface CompleteLayerUploadResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The upload ID associated with the layer. + */ + uploadId?: UploadId; + /** + * The sha256 digest of the image layer. + */ + layerDigest?: LayerDigest; + } + export interface CreateRepositoryRequest { + /** + * The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). + */ + repositoryName: RepositoryName; + /** + * + */ + tags?: TagList; + } + export interface CreateRepositoryResponse { + /** + * The repository that was created. + */ + repository?: Repository; + } + export type CreationTimestamp = Date; + export interface DeleteLifecyclePolicyRequest { + /** + * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository. + */ + repositoryName: RepositoryName; + } + export interface DeleteLifecyclePolicyResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON lifecycle policy text. + */ + lifecyclePolicyText?: LifecyclePolicyText; + /** + * The time stamp of the last time that the lifecycle policy was run. + */ + lastEvaluatedAt?: EvaluationTimestamp; + } + export interface DeleteRepositoryPolicyRequest { + /** + * The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository that is associated with the repository policy to delete. + */ + repositoryName: RepositoryName; + } + export interface DeleteRepositoryPolicyResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON repository policy that was deleted from the repository. + */ + policyText?: RepositoryPolicyText; + } + export interface DeleteRepositoryRequest { + /** + * The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository to delete. + */ + repositoryName: RepositoryName; + /** + * If a repository contains images, forces the deletion. + */ + force?: ForceFlag; + } + export interface DeleteRepositoryResponse { + /** + * The repository that was deleted. + */ + repository?: Repository; + } + export interface DescribeImagesFilter { + /** + * The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED. + */ + tagStatus?: TagStatus; + } + export interface DescribeImagesRequest { + /** + * The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * A list of repositories to describe. + */ + repositoryName: RepositoryName; + /** + * The list of image IDs for the requested repository. + */ + imageIds?: ImageIdentifierList; + /** + * The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds. + */ + nextToken?: NextToken; + /** + * The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds. + */ + maxResults?: MaxResults; + /** + * The filter key and value with which to filter your DescribeImages results. + */ + filter?: DescribeImagesFilter; + } + export interface DescribeImagesResponse { + /** + * A list of ImageDetail objects that contain data about the image. + */ + imageDetails?: ImageDetailList; + /** + * The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export interface DescribeRepositoriesRequest { + /** + * The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described. + */ + repositoryNames?: RepositoryNameList; + /** + * The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify repositories with repositoryNames. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: NextToken; + /** + * The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames. + */ + maxResults?: MaxResults; + } + export interface DescribeRepositoriesResponse { + /** + * A list of repository objects corresponding to valid repositories. + */ + repositories?: RepositoryList; + /** + * The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export type EvaluationTimestamp = Date; + export type ExpirationTimestamp = Date; + export type ForceFlag = boolean; + export type GetAuthorizationTokenRegistryIdList = RegistryId[]; + export interface GetAuthorizationTokenRequest { + /** + * A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed. + */ + registryIds?: GetAuthorizationTokenRegistryIdList; + } + export interface GetAuthorizationTokenResponse { + /** + * A list of authorization token data objects that correspond to the registryIds values in the request. + */ + authorizationData?: AuthorizationDataList; + } + export interface GetDownloadUrlForLayerRequest { + /** + * The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository that is associated with the image layer to download. + */ + repositoryName: RepositoryName; + /** + * The digest of the image layer to download. + */ + layerDigest: LayerDigest; + } + export interface GetDownloadUrlForLayerResponse { + /** + * The pre-signed Amazon S3 download URL for the requested layer. + */ + downloadUrl?: Url; + /** + * The digest of the image layer to download. + */ + layerDigest?: LayerDigest; + } + export interface GetLifecyclePolicyPreviewRequest { + /** + * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository. + */ + repositoryName: RepositoryName; + /** + * The list of imageIDs to be included. + */ + imageIds?: ImageIdentifierList; + /** + * The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the nextToken value. This value is
 null when there are no more results to return. This option cannot be used when you specify images with imageIds. + */ + nextToken?: NextToken; + /** + * The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page along with a nextToken
 response element. The remaining results of the initial request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 1000. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds. + */ + maxResults?: LifecyclePreviewMaxResults; + /** + * An optional parameter that filters results based on image tag status and all tags, if tagged. + */ + filter?: LifecyclePolicyPreviewFilter; + } + export interface GetLifecyclePolicyPreviewResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON lifecycle policy text. + */ + lifecyclePolicyText?: LifecyclePolicyText; + /** + * The status of the lifecycle policy preview request. + */ + status?: LifecyclePolicyPreviewStatus; + /** + * The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + /** + * The results of the lifecycle policy preview request. + */ + previewResults?: LifecyclePolicyPreviewResultList; + /** + * The list of images that is returned as a result of the action. + */ + summary?: LifecyclePolicyPreviewSummary; + } + export interface GetLifecyclePolicyRequest { + /** + * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository. + */ + repositoryName: RepositoryName; + } + export interface GetLifecyclePolicyResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON lifecycle policy text. + */ + lifecyclePolicyText?: LifecyclePolicyText; + /** + * The time stamp of the last time that the lifecycle policy was run. + */ + lastEvaluatedAt?: EvaluationTimestamp; + } + export interface GetRepositoryPolicyRequest { + /** + * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository with the policy to retrieve. + */ + repositoryName: RepositoryName; + } + export interface GetRepositoryPolicyResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON repository policy text associated with the repository. + */ + policyText?: RepositoryPolicyText; + } + export interface Image { + /** + * The AWS account ID associated with the registry containing the image. + */ + registryId?: RegistryId; + /** + * The name of the repository associated with the image. + */ + repositoryName?: RepositoryName; + /** + * An object containing the image tag and image digest associated with an image. + */ + imageId?: ImageIdentifier; + /** + * The image manifest associated with the image. + */ + imageManifest?: ImageManifest; + } + export type ImageActionType = "EXPIRE"|string; + export type ImageCount = number; + export interface ImageDetail { + /** + * The AWS account ID associated with the registry to which this image belongs. + */ + registryId?: RegistryId; + /** + * The name of the repository to which this image belongs. + */ + repositoryName?: RepositoryName; + /** + * The sha256 digest of the image manifest. + */ + imageDigest?: ImageDigest; + /** + * The list of tags associated with this image. + */ + imageTags?: ImageTagList; + /** + * The size, in bytes, of the image in the repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages. + */ + imageSizeInBytes?: ImageSizeInBytes; + /** + * The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. + */ + imagePushedAt?: PushTimestamp; + } + export type ImageDetailList = ImageDetail[]; + export type ImageDigest = string; + export interface ImageFailure { + /** + * The image ID associated with the failure. + */ + imageId?: ImageIdentifier; + /** + * The code associated with the failure. + */ + failureCode?: ImageFailureCode; + /** + * The reason for the failure. + */ + failureReason?: ImageFailureReason; + } + export type ImageFailureCode = "InvalidImageDigest"|"InvalidImageTag"|"ImageTagDoesNotMatchDigest"|"ImageNotFound"|"MissingDigestAndTag"|string; + export type ImageFailureList = ImageFailure[]; + export type ImageFailureReason = string; + export interface ImageIdentifier { + /** + * The sha256 digest of the image manifest. + */ + imageDigest?: ImageDigest; + /** + * The tag used for the image. + */ + imageTag?: ImageTag; + } + export type ImageIdentifierList = ImageIdentifier[]; + export type ImageList = Image[]; + export type ImageManifest = string; + export type ImageSizeInBytes = number; + export type ImageTag = string; + export type ImageTagList = ImageTag[]; + export interface InitiateLayerUploadRequest { + /** + * The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository to which you intend to upload layers. + */ + repositoryName: RepositoryName; + } + export interface InitiateLayerUploadResponse { + /** + * The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations. + */ + uploadId?: UploadId; + /** + * The size, in bytes, that Amazon ECR expects future layer part uploads to be. + */ + partSize?: PartSize; + } + export interface Layer { + /** + * The sha256 digest of the image layer. + */ + layerDigest?: LayerDigest; + /** + * The availability status of the image layer. + */ + layerAvailability?: LayerAvailability; + /** + * The size, in bytes, of the image layer. + */ + layerSize?: LayerSizeInBytes; + /** + * The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip. + */ + mediaType?: MediaType; + } + export type LayerAvailability = "AVAILABLE"|"UNAVAILABLE"|string; + export type LayerDigest = string; + export type LayerDigestList = LayerDigest[]; + export interface LayerFailure { + /** + * The layer digest associated with the failure. + */ + layerDigest?: BatchedOperationLayerDigest; + /** + * The failure code associated with the failure. + */ + failureCode?: LayerFailureCode; + /** + * The reason for the failure. + */ + failureReason?: LayerFailureReason; + } + export type LayerFailureCode = "InvalidLayerDigest"|"MissingLayerDigest"|string; + export type LayerFailureList = LayerFailure[]; + export type LayerFailureReason = string; + export type LayerList = Layer[]; + export type LayerPartBlob = Buffer|Uint8Array|Blob|string; + export type LayerSizeInBytes = number; + export interface LifecyclePolicyPreviewFilter { + /** + * The tag status of the image. + */ + tagStatus?: TagStatus; + } + export interface LifecyclePolicyPreviewResult { + /** + * The list of tags associated with this image. + */ + imageTags?: ImageTagList; + /** + * The sha256 digest of the image manifest. + */ + imageDigest?: ImageDigest; + /** + * The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. + */ + imagePushedAt?: PushTimestamp; + /** + * The type of action to be taken. + */ + action?: LifecyclePolicyRuleAction; + /** + * The priority of the applied rule. + */ + appliedRulePriority?: LifecyclePolicyRulePriority; + } + export type LifecyclePolicyPreviewResultList = LifecyclePolicyPreviewResult[]; + export type LifecyclePolicyPreviewStatus = "IN_PROGRESS"|"COMPLETE"|"EXPIRED"|"FAILED"|string; + export interface LifecyclePolicyPreviewSummary { + /** + * The number of expiring images. + */ + expiringImageTotalCount?: ImageCount; + } + export interface LifecyclePolicyRuleAction { + /** + * The type of action to be taken. + */ + type?: ImageActionType; + } + export type LifecyclePolicyRulePriority = number; + export type LifecyclePolicyText = string; + export type LifecyclePreviewMaxResults = number; + export interface ListImagesFilter { + /** + * The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED. + */ + tagStatus?: TagStatus; + } + export interface ListImagesRequest { + /** + * The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The repository with image IDs to be listed. + */ + repositoryName: RepositoryName; + /** + * The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: NextToken; + /** + * The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable. + */ + maxResults?: MaxResults; + /** + * The filter key and value with which to filter your ListImages results. + */ + filter?: ListImagesFilter; + } + export interface ListImagesResponse { + /** + * The list of image IDs for the requested repository. + */ + imageIds?: ImageIdentifierList; + /** + * The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository. + */ + resourceArn: Arn; + } + export interface ListTagsForResourceResponse { + /** + * The tags for the resource. + */ + tags?: TagList; + } + export type MaxResults = number; + export type MediaType = string; + export type MediaTypeList = MediaType[]; + export type NextToken = string; + export type PartSize = number; + export type ProxyEndpoint = string; + export type PushTimestamp = Date; + export interface PutImageRequest { + /** + * The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository in which to put the image. + */ + repositoryName: RepositoryName; + /** + * The image manifest corresponding to the image to be uploaded. + */ + imageManifest: ImageManifest; + /** + * The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats. + */ + imageTag?: ImageTag; + } + export interface PutImageResponse { + /** + * Details of the image uploaded. + */ + image?: Image; + } + export interface PutLifecyclePolicyRequest { + /** + * The AWS account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository to receive the policy. + */ + repositoryName: RepositoryName; + /** + * The JSON repository policy text to apply to the repository. + */ + lifecyclePolicyText: LifecyclePolicyText; + } + export interface PutLifecyclePolicyResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON repository policy text. + */ + lifecyclePolicyText?: LifecyclePolicyText; + } + export type RegistryId = string; + export interface Repository { + /** + * The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test. + */ + repositoryArn?: Arn; + /** + * The AWS account ID associated with the registry that contains the repository. + */ + registryId?: RegistryId; + /** + * The name of the repository. + */ + repositoryName?: RepositoryName; + /** + * The URI for the repository. You can use this URI for Docker push or pull operations. + */ + repositoryUri?: Url; + /** + * The date and time, in JavaScript date format, when the repository was created. + */ + createdAt?: CreationTimestamp; + } + export type RepositoryList = Repository[]; + export type RepositoryName = string; + export type RepositoryNameList = RepositoryName[]; + export type RepositoryPolicyText = string; + export interface SetRepositoryPolicyRequest { + /** + * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository to receive the policy. + */ + repositoryName: RepositoryName; + /** + * The JSON repository policy text to apply to the repository. + */ + policyText: RepositoryPolicyText; + /** + * If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs. + */ + force?: ForceFlag; + } + export interface SetRepositoryPolicyResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON repository policy text applied to the repository. + */ + policyText?: RepositoryPolicyText; + } + export interface StartLifecyclePolicyPreviewRequest { + /** + * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository to be evaluated. + */ + repositoryName: RepositoryName; + /** + * The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used. + */ + lifecyclePolicyText?: LifecyclePolicyText; + } + export interface StartLifecyclePolicyPreviewResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The JSON repository policy text. + */ + lifecyclePolicyText?: LifecyclePolicyText; + /** + * The status of the lifecycle policy preview request. + */ + status?: LifecyclePolicyPreviewStatus; + } + export interface Tag { + /** + * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. + */ + Key?: TagKey; + /** + * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository. + */ + resourceArn: Arn; + /** + * The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags: TagList; + } + export interface TagResourceResponse { + } + export type TagStatus = "TAGGED"|"UNTAGGED"|"ANY"|string; + export type TagValue = string; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository. + */ + resourceArn: Arn; + /** + * The keys of the tags to be removed. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export type UploadId = string; + export interface UploadLayerPartRequest { + /** + * The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed. + */ + registryId?: RegistryId; + /** + * The name of the repository to which you are uploading layer parts. + */ + repositoryName: RepositoryName; + /** + * The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload. + */ + uploadId: UploadId; + /** + * The integer value of the first byte of the layer part. + */ + partFirstByte: PartSize; + /** + * The integer value of the last byte of the layer part. + */ + partLastByte: PartSize; + /** + * The base64-encoded layer part payload. + */ + layerPartBlob: LayerPartBlob; + } + export interface UploadLayerPartResponse { + /** + * The registry ID associated with the request. + */ + registryId?: RegistryId; + /** + * The repository name associated with the request. + */ + repositoryName?: RepositoryName; + /** + * The upload ID associated with the request. + */ + uploadId?: UploadId; + /** + * The integer value of the last byte received in the request. + */ + lastByteReceived?: PartSize; + } + export type Url = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-09-21"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ECR client. + */ + export import Types = ECR; +} +export = ECR; diff --git a/node_modules/aws-sdk/clients/ecr.js b/node_modules/aws-sdk/clients/ecr.js new file mode 100644 index 0000000..6683d13 --- /dev/null +++ b/node_modules/aws-sdk/clients/ecr.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['ecr'] = {}; +AWS.ECR = Service.defineService('ecr', ['2015-09-21']); +Object.defineProperty(apiLoader.services['ecr'], '2015-09-21', { + get: function get() { + var model = require('../apis/ecr-2015-09-21.min.json'); + model.paginators = require('../apis/ecr-2015-09-21.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ECR; diff --git a/node_modules/aws-sdk/clients/ecs.d.ts b/node_modules/aws-sdk/clients/ecs.d.ts new file mode 100644 index 0000000..4f4a4b0 --- /dev/null +++ b/node_modules/aws-sdk/clients/ecs.d.ts @@ -0,0 +1,3097 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ECS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ECS.Types.ClientConfiguration) + config: Config & ECS.Types.ClientConfiguration; + /** + * Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action. When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide. + */ + createCluster(params: ECS.Types.CreateClusterRequest, callback?: (err: AWSError, data: ECS.Types.CreateClusterResponse) => void): Request; + /** + * Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action. When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide. + */ + createCluster(callback?: (err: AWSError, data: ECS.Types.CreateClusterResponse) => void): Request; + /** + * Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer. There are two service scheduler strategies available: REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide. DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide. You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%. If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%. If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%. If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service. When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic: 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). By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter): Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. 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. 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. + */ + createService(params: ECS.Types.CreateServiceRequest, callback?: (err: AWSError, data: ECS.Types.CreateServiceResponse) => void): Request; + /** + * Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer. There are two service scheduler strategies available: REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide. DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide. You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%. If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%. If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%. If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service. When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic: 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). By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter): Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. 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. 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. + */ + createService(callback?: (err: AWSError, data: ECS.Types.CreateServiceResponse) => void): Request; + /** + * Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + createTaskSet(params: ECS.Types.CreateTaskSetRequest, callback?: (err: AWSError, data: ECS.Types.CreateTaskSetResponse) => void): Request; + /** + * Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + createTaskSet(callback?: (err: AWSError, data: ECS.Types.CreateTaskSetResponse) => void): Request; + /** + * Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created. + */ + deleteAccountSetting(params: ECS.Types.DeleteAccountSettingRequest, callback?: (err: AWSError, data: ECS.Types.DeleteAccountSettingResponse) => void): Request; + /** + * Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created. + */ + deleteAccountSetting(callback?: (err: AWSError, data: ECS.Types.DeleteAccountSettingResponse) => void): Request; + /** + * Deletes one or more custom attributes from an Amazon ECS resource. + */ + deleteAttributes(params: ECS.Types.DeleteAttributesRequest, callback?: (err: AWSError, data: ECS.Types.DeleteAttributesResponse) => void): Request; + /** + * Deletes one or more custom attributes from an Amazon ECS resource. + */ + deleteAttributes(callback?: (err: AWSError, data: ECS.Types.DeleteAttributesResponse) => void): Request; + /** + * Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance. + */ + deleteCluster(params: ECS.Types.DeleteClusterRequest, callback?: (err: AWSError, data: ECS.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance. + */ + deleteCluster(callback?: (err: AWSError, data: ECS.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService. When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error. If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error. + */ + deleteService(params: ECS.Types.DeleteServiceRequest, callback?: (err: AWSError, data: ECS.Types.DeleteServiceResponse) => void): Request; + /** + * Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService. When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error. If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error. + */ + deleteService(callback?: (err: AWSError, data: ECS.Types.DeleteServiceResponse) => void): Request; + /** + * Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + deleteTaskSet(params: ECS.Types.DeleteTaskSetRequest, callback?: (err: AWSError, data: ECS.Types.DeleteTaskSetResponse) => void): Request; + /** + * Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + deleteTaskSet(callback?: (err: AWSError, data: ECS.Types.DeleteTaskSetResponse) => void): Request; + /** + * Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources. Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated). + */ + deregisterContainerInstance(params: ECS.Types.DeregisterContainerInstanceRequest, callback?: (err: AWSError, data: ECS.Types.DeregisterContainerInstanceResponse) => void): Request; + /** + * Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources. Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated). + */ + deregisterContainerInstance(callback?: (err: AWSError, data: ECS.Types.DeregisterContainerInstanceResponse) => void): Request; + /** + * Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect. At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services. + */ + deregisterTaskDefinition(params: ECS.Types.DeregisterTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.DeregisterTaskDefinitionResponse) => void): Request; + /** + * Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect. At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services. + */ + deregisterTaskDefinition(callback?: (err: AWSError, data: ECS.Types.DeregisterTaskDefinitionResponse) => void): Request; + /** + * Describes one or more of your clusters. + */ + describeClusters(params: ECS.Types.DescribeClustersRequest, callback?: (err: AWSError, data: ECS.Types.DescribeClustersResponse) => void): Request; + /** + * Describes one or more of your clusters. + */ + describeClusters(callback?: (err: AWSError, data: ECS.Types.DescribeClustersResponse) => void): Request; + /** + * Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. + */ + describeContainerInstances(params: ECS.Types.DescribeContainerInstancesRequest, callback?: (err: AWSError, data: ECS.Types.DescribeContainerInstancesResponse) => void): Request; + /** + * Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. + */ + describeContainerInstances(callback?: (err: AWSError, data: ECS.Types.DescribeContainerInstancesResponse) => void): Request; + /** + * Describes the specified services running in your cluster. + */ + describeServices(params: ECS.Types.DescribeServicesRequest, callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request; + /** + * Describes the specified services running in your cluster. + */ + describeServices(callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request; + /** + * Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family. You can only describe INACTIVE task definitions while an active task or service references them. + */ + describeTaskDefinition(params: ECS.Types.DescribeTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.DescribeTaskDefinitionResponse) => void): Request; + /** + * Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family. You can only describe INACTIVE task definitions while an active task or service references them. + */ + describeTaskDefinition(callback?: (err: AWSError, data: ECS.Types.DescribeTaskDefinitionResponse) => void): Request; + /** + * Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + describeTaskSets(params: ECS.Types.DescribeTaskSetsRequest, callback?: (err: AWSError, data: ECS.Types.DescribeTaskSetsResponse) => void): Request; + /** + * Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + describeTaskSets(callback?: (err: AWSError, data: ECS.Types.DescribeTaskSetsResponse) => void): Request; + /** + * Describes a specified task or tasks. + */ + describeTasks(params: ECS.Types.DescribeTasksRequest, callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request; + /** + * Describes a specified task or tasks. + */ + describeTasks(callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Returns an endpoint for the Amazon ECS agent to poll for updates. + */ + discoverPollEndpoint(params: ECS.Types.DiscoverPollEndpointRequest, callback?: (err: AWSError, data: ECS.Types.DiscoverPollEndpointResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Returns an endpoint for the Amazon ECS agent to poll for updates. + */ + discoverPollEndpoint(callback?: (err: AWSError, data: ECS.Types.DiscoverPollEndpointResponse) => void): Request; + /** + * Lists the account settings for an Amazon ECS resource for a specified principal. + */ + listAccountSettings(params: ECS.Types.ListAccountSettingsRequest, callback?: (err: AWSError, data: ECS.Types.ListAccountSettingsResponse) => void): Request; + /** + * Lists the account settings for an Amazon ECS resource for a specified principal. + */ + listAccountSettings(callback?: (err: AWSError, data: ECS.Types.ListAccountSettingsResponse) => void): Request; + /** + * Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux). + */ + listAttributes(params: ECS.Types.ListAttributesRequest, callback?: (err: AWSError, data: ECS.Types.ListAttributesResponse) => void): Request; + /** + * Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux). + */ + listAttributes(callback?: (err: AWSError, data: ECS.Types.ListAttributesResponse) => void): Request; + /** + * Returns a list of existing clusters. + */ + listClusters(params: ECS.Types.ListClustersRequest, callback?: (err: AWSError, data: ECS.Types.ListClustersResponse) => void): Request; + /** + * Returns a list of existing clusters. + */ + listClusters(callback?: (err: AWSError, data: ECS.Types.ListClustersResponse) => void): Request; + /** + * Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. + */ + listContainerInstances(params: ECS.Types.ListContainerInstancesRequest, callback?: (err: AWSError, data: ECS.Types.ListContainerInstancesResponse) => void): Request; + /** + * Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. + */ + listContainerInstances(callback?: (err: AWSError, data: ECS.Types.ListContainerInstancesResponse) => void): Request; + /** + * Lists the services that are running in a specified cluster. + */ + listServices(params: ECS.Types.ListServicesRequest, callback?: (err: AWSError, data: ECS.Types.ListServicesResponse) => void): Request; + /** + * Lists the services that are running in a specified cluster. + */ + listServices(callback?: (err: AWSError, data: ECS.Types.ListServicesResponse) => void): Request; + /** + * List the tags for an Amazon ECS resource. + */ + listTagsForResource(params: ECS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ECS.Types.ListTagsForResourceResponse) => void): Request; + /** + * List the tags for an Amazon ECS resource. + */ + listTagsForResource(callback?: (err: AWSError, data: ECS.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions). You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter. + */ + listTaskDefinitionFamilies(params: ECS.Types.ListTaskDefinitionFamiliesRequest, callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionFamiliesResponse) => void): Request; + /** + * Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions). You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter. + */ + listTaskDefinitionFamilies(callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionFamiliesResponse) => void): Request; + /** + * Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter. + */ + listTaskDefinitions(params: ECS.Types.ListTaskDefinitionsRequest, callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionsResponse) => void): Request; + /** + * Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter. + */ + listTaskDefinitions(callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionsResponse) => void): Request; + /** + * Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters. Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour. + */ + listTasks(params: ECS.Types.ListTasksRequest, callback?: (err: AWSError, data: ECS.Types.ListTasksResponse) => void): Request; + /** + * Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters. Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour. + */ + listTasks(callback?: (err: AWSError, data: ECS.Types.ListTasksResponse) => void): Request; + /** + * Modifies the ARN and resource ID format of a resource type for a specified IAM user, IAM role, or the root user for an account. If the account setting for the root user is changed, it sets the default setting for all of the IAM users and roles for which no individual account setting has been set. The opt-in and opt-out account setting can be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. Enabling this setting is required to use new Amazon ECS features such as resource tagging. For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon Elastic Container Service Developer Guide. + */ + putAccountSetting(params: ECS.Types.PutAccountSettingRequest, callback?: (err: AWSError, data: ECS.Types.PutAccountSettingResponse) => void): Request; + /** + * Modifies the ARN and resource ID format of a resource type for a specified IAM user, IAM role, or the root user for an account. If the account setting for the root user is changed, it sets the default setting for all of the IAM users and roles for which no individual account setting has been set. The opt-in and opt-out account setting can be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. Enabling this setting is required to use new Amazon ECS features such as resource tagging. For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon Elastic Container Service Developer Guide. + */ + putAccountSetting(callback?: (err: AWSError, data: ECS.Types.PutAccountSettingResponse) => void): Request; + /** + * Modifies the ARN and resource ID format of a resource type for all IAM users on an account for which no individual account setting has been set. Enabling this setting is required to use new Amazon ECS features such as resource tagging. + */ + putAccountSettingDefault(params: ECS.Types.PutAccountSettingDefaultRequest, callback?: (err: AWSError, data: ECS.Types.PutAccountSettingDefaultResponse) => void): Request; + /** + * Modifies the ARN and resource ID format of a resource type for all IAM users on an account for which no individual account setting has been set. Enabling this setting is required to use new Amazon ECS features such as resource tagging. + */ + putAccountSettingDefault(callback?: (err: AWSError, data: ECS.Types.PutAccountSettingDefaultResponse) => void): Request; + /** + * Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide. + */ + putAttributes(params: ECS.Types.PutAttributesRequest, callback?: (err: AWSError, data: ECS.Types.PutAttributesResponse) => void): Request; + /** + * Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide. + */ + putAttributes(callback?: (err: AWSError, data: ECS.Types.PutAttributesResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on. + */ + registerContainerInstance(params: ECS.Types.RegisterContainerInstanceRequest, callback?: (err: AWSError, data: ECS.Types.RegisterContainerInstanceResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on. + */ + registerContainerInstance(callback?: (err: AWSError, data: ECS.Types.RegisterContainerInstanceResponse) => void): Request; + /** + * Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. + */ + registerTaskDefinition(params: ECS.Types.RegisterTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.RegisterTaskDefinitionResponse) => void): Request; + /** + * Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. + */ + registerTaskDefinition(callback?: (err: AWSError, data: ECS.Types.RegisterTaskDefinitionResponse) => void): Request; + /** + * Starts a new task using the specified task definition. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command. To manage eventual consistency, you can do the following: Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time. Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time. + */ + runTask(params: ECS.Types.RunTaskRequest, callback?: (err: AWSError, data: ECS.Types.RunTaskResponse) => void): Request; + /** + * Starts a new task using the specified task definition. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command. To manage eventual consistency, you can do the following: Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time. Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time. + */ + runTask(callback?: (err: AWSError, data: ECS.Types.RunTaskResponse) => void): Request; + /** + * Starts a new task from the specified task definition on the specified container instance or instances. Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. + */ + startTask(params: ECS.Types.StartTaskRequest, callback?: (err: AWSError, data: ECS.Types.StartTaskResponse) => void): Request; + /** + * Starts a new task from the specified task definition on the specified container instance or instances. Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. + */ + startTask(callback?: (err: AWSError, data: ECS.Types.StartTaskResponse) => void): Request; + /** + * Stops a running task. Any tags associated with the task will be deleted. When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent. The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. + */ + stopTask(params: ECS.Types.StopTaskRequest, callback?: (err: AWSError, data: ECS.Types.StopTaskResponse) => void): Request; + /** + * Stops a running task. Any tags associated with the task will be deleted. When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent. The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. + */ + stopTask(callback?: (err: AWSError, data: ECS.Types.StopTaskResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a container changed states. + */ + submitContainerStateChange(params: ECS.Types.SubmitContainerStateChangeRequest, callback?: (err: AWSError, data: ECS.Types.SubmitContainerStateChangeResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a container changed states. + */ + submitContainerStateChange(callback?: (err: AWSError, data: ECS.Types.SubmitContainerStateChangeResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a task changed states. + */ + submitTaskStateChange(params: ECS.Types.SubmitTaskStateChangeRequest, callback?: (err: AWSError, data: ECS.Types.SubmitTaskStateChangeResponse) => void): Request; + /** + * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a task changed states. + */ + submitTaskStateChange(callback?: (err: AWSError, data: ECS.Types.SubmitTaskStateChangeResponse) => void): Request; + /** + * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. + */ + tagResource(params: ECS.Types.TagResourceRequest, callback?: (err: AWSError, data: ECS.Types.TagResourceResponse) => void): Request; + /** + * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. + */ + tagResource(callback?: (err: AWSError, data: ECS.Types.TagResourceResponse) => void): Request; + /** + * Deletes specified tags from a resource. + */ + untagResource(params: ECS.Types.UntagResourceRequest, callback?: (err: AWSError, data: ECS.Types.UntagResourceResponse) => void): Request; + /** + * Deletes specified tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: ECS.Types.UntagResourceResponse) => void): Request; + /** + * 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. UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. + */ + updateContainerAgent(params: ECS.Types.UpdateContainerAgentRequest, callback?: (err: AWSError, data: ECS.Types.UpdateContainerAgentResponse) => void): Request; + /** + * 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. UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. + */ + updateContainerAgent(callback?: (err: AWSError, data: ECS.Types.UpdateContainerAgentResponse) => void): Request; + /** + * Modifies the status of an Amazon ECS container instance. You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size. When you set a container instance to DRAINING, 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 PENDING state are stopped immediately. Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService. If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount 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 RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The maximumPercent 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 desiredCount is 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. Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually. A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks. When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again. + */ + updateContainerInstancesState(params: ECS.Types.UpdateContainerInstancesStateRequest, callback?: (err: AWSError, data: ECS.Types.UpdateContainerInstancesStateResponse) => void): Request; + /** + * Modifies the status of an Amazon ECS container instance. You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size. When you set a container instance to DRAINING, 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 PENDING state are stopped immediately. Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService. If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount 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 RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The maximumPercent 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 desiredCount is 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. Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually. A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks. When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again. + */ + updateContainerInstancesState(callback?: (err: AWSError, data: ECS.Types.UpdateContainerInstancesStateResponse) => void): Request; + /** + * Modifies the parameters of a service. For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference. For services using an external deployment controller, you can update only the desired count and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet. 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 desiredCount parameter. 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. If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start. 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, minimumHealthyPercent and maximumPercent, to determine the deployment strategy. If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount 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 RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The maximumPercent 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 desiredCount 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). When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent. When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic: 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). By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy): 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. 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. When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: 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. 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. + */ + updateService(params: ECS.Types.UpdateServiceRequest, callback?: (err: AWSError, data: ECS.Types.UpdateServiceResponse) => void): Request; + /** + * Modifies the parameters of a service. For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference. For services using an external deployment controller, you can update only the desired count and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet. 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 desiredCount parameter. 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. If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start. 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, minimumHealthyPercent and maximumPercent, to determine the deployment strategy. If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount 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 RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The maximumPercent 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 desiredCount 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). When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent. When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic: 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). By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy): 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. 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. When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: 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. 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. + */ + updateService(callback?: (err: AWSError, data: ECS.Types.UpdateServiceResponse) => void): Request; + /** + * Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + updateServicePrimaryTaskSet(params: ECS.Types.UpdateServicePrimaryTaskSetRequest, callback?: (err: AWSError, data: ECS.Types.UpdateServicePrimaryTaskSetResponse) => void): Request; + /** + * Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + updateServicePrimaryTaskSet(callback?: (err: AWSError, data: ECS.Types.UpdateServicePrimaryTaskSetResponse) => void): Request; + /** + * Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + updateTaskSet(params: ECS.Types.UpdateTaskSetRequest, callback?: (err: AWSError, data: ECS.Types.UpdateTaskSetResponse) => void): Request; + /** + * Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. + */ + updateTaskSet(callback?: (err: AWSError, data: ECS.Types.UpdateTaskSetResponse) => void): Request; + /** + * Waits for the tasksRunning state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times). + */ + waitFor(state: "tasksRunning", params: ECS.Types.DescribeTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request; + /** + * Waits for the tasksRunning state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times). + */ + waitFor(state: "tasksRunning", callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request; + /** + * Waits for the tasksStopped state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times). + */ + waitFor(state: "tasksStopped", params: ECS.Types.DescribeTasksRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request; + /** + * Waits for the tasksStopped state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times). + */ + waitFor(state: "tasksStopped", callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request; + /** + * Waits for the servicesStable state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "servicesStable", params: ECS.Types.DescribeServicesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request; + /** + * Waits for the servicesStable state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "servicesStable", callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request; + /** + * Waits for the servicesInactive state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "servicesInactive", params: ECS.Types.DescribeServicesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request; + /** + * Waits for the servicesInactive state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "servicesInactive", callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request; +} +declare namespace ECS { + export type AgentUpdateStatus = "PENDING"|"STAGING"|"STAGED"|"UPDATING"|"UPDATED"|"FAILED"|string; + export type AssignPublicIp = "ENABLED"|"DISABLED"|string; + export interface Attachment { + /** + * The unique identifier for the attachment. + */ + id?: String; + /** + * The type of the attachment, such as ElasticNetworkInterface. + */ + type?: String; + /** + * The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED. + */ + status?: String; + /** + * Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address. + */ + details?: AttachmentDetails; + } + export type AttachmentDetails = KeyValuePair[]; + export interface AttachmentStateChange { + /** + * The Amazon Resource Name (ARN) of the attachment. + */ + attachmentArn: String; + /** + * The status of the attachment. + */ + status: String; + } + export type AttachmentStateChanges = AttachmentStateChange[]; + export type Attachments = Attachment[]; + export interface Attribute { + /** + * The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed. + */ + name: String; + /** + * The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed. + */ + value?: String; + /** + * The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN. + */ + targetType?: TargetType; + /** + * The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN). + */ + targetId?: String; + } + export type Attributes = Attribute[]; + export interface AwsVpcConfiguration { + /** + * The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. All specified subnets must be from the same VPC. + */ + subnets: StringList; + /** + * 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 that can be specified per AwsVpcConfiguration. All specified security groups must be from the same VPC. + */ + securityGroups?: StringList; + /** + * Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. + */ + assignPublicIp?: AssignPublicIp; + } + export type Boolean = boolean; + export type BoxedBoolean = boolean; + export type BoxedInteger = number; + export interface Cluster { + /** + * The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test .. + */ + clusterArn?: String; + /** + * A user-generated string that you use to identify your cluster. + */ + clusterName?: String; + /** + * The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks. + */ + status?: String; + /** + * The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status. + */ + registeredContainerInstancesCount?: Integer; + /** + * The number of tasks in the cluster that are in the RUNNING state. + */ + runningTasksCount?: Integer; + /** + * The number of tasks in the cluster that are in the PENDING state. + */ + pendingTasksCount?: Integer; + /** + * The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices. + */ + activeServicesCount?: Integer; + /** + * Additional information about your clusters that are separated by launch type, including: runningEC2TasksCount RunningFargateTasksCount pendingEC2TasksCount pendingFargateTasksCount activeEC2ServiceCount activeFargateServiceCount drainingEC2ServiceCount drainingFargateServiceCount + */ + statistics?: Statistics; + /** + * The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + } + export type ClusterField = "STATISTICS"|"TAGS"|string; + export type ClusterFieldList = ClusterField[]; + export type Clusters = Cluster[]; + export type Compatibility = "EC2"|"FARGATE"|string; + export type CompatibilityList = Compatibility[]; + export type Connectivity = "CONNECTED"|"DISCONNECTED"|string; + export interface Container { + /** + * The Amazon Resource Name (ARN) of the container. + */ + containerArn?: String; + /** + * The ARN of the task. + */ + taskArn?: String; + /** + * The name of the container. + */ + name?: String; + /** + * The last known status of the container. + */ + lastStatus?: String; + /** + * The exit code returned from the container. + */ + exitCode?: BoxedInteger; + /** + * A short (255 max characters) human-readable string to provide additional details about a running or stopped container. + */ + reason?: String; + /** + * The network bindings associated with the container. + */ + networkBindings?: NetworkBindings; + /** + * The network interfaces associated with the container. + */ + networkInterfaces?: NetworkInterfaces; + /** + * The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN. + */ + healthStatus?: HealthStatus; + /** + * The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered. + */ + cpu?: String; + /** + * The hard limit (in MiB) of memory set for the container. + */ + memory?: String; + /** + * The soft limit (in MiB) of memory set for the container. + */ + memoryReservation?: String; + /** + * The IDs of each GPU assigned to the container. + */ + gpuIds?: GpuIds; + } + export type ContainerCondition = "START"|"COMPLETE"|"SUCCESS"|"HEALTHY"|string; + export interface ContainerDefinition { + /** + * The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run. + */ + name?: String; + /** + * The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks. Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo). Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent). Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu). + */ + image?: String; + /** + * The private repository authentication credentials to use. + */ + repositoryCredentials?: RepositoryCredentials; + /** + * The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition. + */ + cpu?: Integer; + /** + * 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 Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value. For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used. The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. + */ + memory?: BoxedInteger; + /** + * The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run. You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. + */ + memoryReservation?: BoxedInteger; + /** + * The link 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 bridge. The name:internalName construct is analogous to name:alias 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 https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run . This parameter is not supported for Windows containers. 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. + */ + links?: StringList; + /** + * The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort. Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses. + */ + portMappings?: PortMappingList; + /** + * If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. + */ + essential?: BoxedBoolean; + /** + * Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead. The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. + */ + entryPoint?: StringList; + /** + * The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array. + */ + command?: StringList; + /** + * The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. We do not recommend using plaintext environment variables for sensitive information, such as credential data. + */ + environment?: EnvironmentVariables; + /** + * The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run. Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. + */ + mountPoints?: MountPointList; + /** + * Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run. + */ + volumesFrom?: VolumeFromList; + /** + * Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities. This parameter is not supported for Windows containers. + */ + linuxParameters?: LinuxParameters; + /** + * The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide. + */ + secrets?: SecretList; + /** + * The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide. This parameter is available for tasks using the Fargate launch type in the Ohio (us-east-2) region only and the task or service requires platform version 1.3.0 or later. + */ + dependsOn?: ContainerDependencies; + /** + * Time duration to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide. This parameter is available for tasks using the Fargate launch type in the Ohio (us-east-2) region only and the task or service requires platform version 1.3.0 or later. + */ + startTimeout?: BoxedInteger; + /** + * Time duration to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the max stopTimeout value is 2 minutes. This parameter is available for tasks using the Fargate launch type in the Ohio (us-east-2) region only and the task or service requires platform version 1.3.0 or later. For tasks using the EC2 launch type, the stop timeout value for the container takes precedence over the ECS_CONTAINER_STOP_TIMEOUT container agent configuration parameter, if used. Container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide. + */ + stopTimeout?: BoxedInteger; + /** + * The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run. The hostname parameter is not supported if you are using the awsvpc network mode. + */ + hostname?: String; + /** + * The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run. You can use the following formats. If specifying a UID or GID, you must specify it as a positive integer. user user:group uid uid:gid user:gid uid:group This parameter is not supported for Windows containers. + */ + user?: String; + /** + * The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run. + */ + workingDirectory?: String; + /** + * When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. + */ + disableNetworking?: BoxedBoolean; + /** + * When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. This parameter is not supported for Windows containers or tasks using the Fargate launch type. + */ + privileged?: BoxedBoolean; + /** + * When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run. This parameter is not supported for Windows containers. + */ + readonlyRootFilesystem?: BoxedBoolean; + /** + * A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run. This parameter is not supported for Windows containers. + */ + dnsServers?: StringList; + /** + * A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run. This parameter is not supported for Windows containers. + */ + dnsSearchDomains?: StringList; + /** + * A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run. This parameter is not supported for Windows containers or tasks that use the awsvpc network mode. + */ + extraHosts?: HostEntryList; + /** + * A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run. The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. This parameter is not supported for Windows containers. + */ + dockerSecurityOptions?: StringList; + /** + * When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run. + */ + interactive?: BoxedBoolean; + /** + * When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run. + */ + pseudoTerminal?: BoxedBoolean; + /** + * A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + */ + dockerLabels?: DockerLabelsMap; + /** + * A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' This parameter is not supported for Windows containers. + */ + ulimits?: UlimitList; + /** + * The log configuration specification for the container. For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk. For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. + */ + logConfiguration?: LogConfiguration; + /** + * The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run. + */ + healthCheck?: HealthCheck; + /** + * A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run. It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers. + */ + systemControls?: SystemControls; + /** + * The type and amount of a resource to assign to a container. The only supported resource is a GPU. + */ + resourceRequirements?: ResourceRequirements; + } + export type ContainerDefinitions = ContainerDefinition[]; + export type ContainerDependencies = ContainerDependency[]; + export interface ContainerDependency { + /** + * The name of a container. + */ + containerName: String; + /** + * The dependency condition of the container. The following are the available conditions and their behavior: START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. + */ + condition: ContainerCondition; + } + export interface ContainerInstance { + /** + * The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID . + */ + containerInstanceArn?: String; + /** + * The EC2 instance ID of the container instance. + */ + ec2InstanceId?: String; + /** + * The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current. + */ + version?: Long; + /** + * The version information for the Amazon ECS container agent and Docker daemon running on the container instance. + */ + versionInfo?: VersionInfo; + /** + * For CPU and memory resource types, this parameter describes the remaining CPU and memory 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 host or bridge network mode). Any port that is not specified here is available for new tasks. + */ + remainingResources?: Resources; + /** + * 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. + */ + registeredResources?: Resources; + /** + * The status of the container instance. The valid values are ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide. + */ + status?: String; + /** + * This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests. + */ + agentConnected?: Boolean; + /** + * The number of tasks on the container instance that are in the RUNNING status. + */ + runningTasksCount?: Integer; + /** + * The number of tasks on the container instance that are in the PENDING status. + */ + pendingTasksCount?: Integer; + /** + * The status of the most recent agent update. If an update has never been requested, this value is NULL. + */ + agentUpdateStatus?: AgentUpdateStatus; + /** + * The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation. + */ + attributes?: Attributes; + /** + * The Unix timestamp for when the container instance was registered. + */ + registeredAt?: Timestamp; + /** + * The elastic network interfaces associated with the container instance. + */ + attachments?: Attachments; + /** + * The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + } + export type ContainerInstanceField = "TAGS"|string; + export type ContainerInstanceFieldList = ContainerInstanceField[]; + export type ContainerInstanceStatus = "ACTIVE"|"DRAINING"|string; + export type ContainerInstances = ContainerInstance[]; + export interface ContainerOverride { + /** + * The name of the container that receives the override. This parameter is required if any override is specified. + */ + name?: String; + /** + * The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name. + */ + command?: StringList; + /** + * The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name. + */ + environment?: EnvironmentVariables; + /** + * The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name. + */ + cpu?: BoxedInteger; + /** + * The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name. + */ + memory?: BoxedInteger; + /** + * The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name. + */ + memoryReservation?: BoxedInteger; + /** + * The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU. + */ + resourceRequirements?: ResourceRequirements; + } + export type ContainerOverrides = ContainerOverride[]; + export interface ContainerStateChange { + /** + * The name of the container. + */ + containerName?: String; + /** + * The exit code for the container, if the state change is a result of the container exiting. + */ + exitCode?: BoxedInteger; + /** + * Any network bindings associated with the container. + */ + networkBindings?: NetworkBindings; + /** + * The reason for the state change. + */ + reason?: String; + /** + * The status of the container. + */ + status?: String; + } + export type ContainerStateChanges = ContainerStateChange[]; + export type Containers = Container[]; + export interface CreateClusterRequest { + /** + * The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + */ + clusterName?: String; + /** + * The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + } + export interface CreateClusterResponse { + /** + * The full description of your new cluster. + */ + cluster?: Cluster; + } + export interface CreateServiceRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. + */ + serviceName: String; + /** + * The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. A task definition must be specified if the service is using the ECS deployment controller. + */ + taskDefinition?: String; + /** + * A load balancer object representing the load balancer to use with your service. If the service is using the ECS deployment controller, you are limited to one load balancer or target group. If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it. After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service. For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here. For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here. Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. + */ + loadBalancers?: LoadBalancers; + /** + * The details of the service discovery registries to assign to this service. For more information, see Service Discovery. Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions. + */ + serviceRegistries?: ServiceRegistries; + /** + * The number of instantiations of the specified task definition to place and keep running on your cluster. + */ + desiredCount?: BoxedInteger; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed. + */ + clientToken?: String; + /** + * The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + launchType?: LaunchType; + /** + * The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + platformVersion?: String; + /** + * The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter. If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide. + */ + role?: String; + /** + * Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. + */ + deploymentConfiguration?: DeploymentConfiguration; + /** + * An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime). + */ + placementConstraints?: PlacementConstraints; + /** + * The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service. + */ + placementStrategy?: PlacementStrategies; + /** + * The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. + */ + networkConfiguration?: NetworkConfiguration; + /** + * 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 2,147,483,647 seconds. During that time, the ECS service scheduler ignores 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. + */ + healthCheckGracePeriodSeconds?: BoxedInteger; + /** + * The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available: REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types. DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy. + */ + schedulingStrategy?: SchedulingStrategy; + /** + * The deployment controller to use for the service. + */ + deploymentController?: DeploymentController; + /** + * The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + /** + * Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. + */ + enableECSManagedTags?: Boolean; + /** + * Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action. + */ + propagateTags?: PropagateTags; + } + export interface CreateServiceResponse { + /** + * The full description of your service following the create call. If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned. If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list. + */ + service?: Service; + } + export interface CreateTaskSetRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the service to create the task set in. + */ + service: String; + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. + */ + cluster: String; + /** + * An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. + */ + externalId?: String; + /** + * The task definition for the tasks in the task set to use. + */ + taskDefinition: String; + networkConfiguration?: NetworkConfiguration; + /** + * A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. + */ + loadBalancers?: LoadBalancers; + /** + * The details of the service discovery registries to assign to this task set. For more information, see Service Discovery. + */ + serviceRegistries?: ServiceRegistries; + /** + * The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + launchType?: LaunchType; + /** + * The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. + */ + platformVersion?: String; + scale?: Scale; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed. + */ + clientToken?: String; + } + export interface CreateTaskSetResponse { + taskSet?: TaskSet; + } + export interface DeleteAccountSettingRequest { + /** + * The resource name for which to disable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. + */ + name: SettingName; + /** + * The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user. + */ + principalArn?: String; + } + export interface DeleteAccountSettingResponse { + /** + * The account setting for the specified principal ARN. + */ + setting?: Setting; + } + export interface DeleteAttributesRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type. + */ + attributes: Attributes; + } + export interface DeleteAttributesResponse { + /** + * A list of attribute objects that were successfully deleted from your resource. + */ + attributes?: Attributes; + } + export interface DeleteClusterRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster to delete. + */ + cluster: String; + } + export interface DeleteClusterResponse { + /** + * The full description of the deleted cluster. + */ + cluster?: Cluster; + } + export interface DeleteServiceRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The name of the service to delete. + */ + service: String; + /** + * If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy. + */ + force?: BoxedBoolean; + } + export interface DeleteServiceResponse { + /** + * The full description of the deleted service. + */ + service?: Service; + } + export interface DeleteTaskSetRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete. + */ + cluster: String; + /** + * The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete. + */ + service: String; + /** + * The task set ID or full Amazon Resource Name (ARN) of the task set to delete. + */ + taskSet: String; + /** + * If true, this allows you to delete a task set even if it hasn't been scaled down to zero. + */ + force?: BoxedBoolean; + } + export interface DeleteTaskSetResponse { + taskSet?: TaskSet; + } + export interface Deployment { + /** + * The ID of the deployment. + */ + id?: String; + /** + * The status of the deployment. The following describes each state: PRIMARY The most recent deployment of a service. ACTIVE A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment. INACTIVE A deployment that has been completely replaced. + */ + status?: String; + /** + * The most recent task definition that was specified for the tasks in the service to use. + */ + taskDefinition?: String; + /** + * The most recent desired count of tasks that was specified for the service to deploy or maintain. + */ + desiredCount?: Integer; + /** + * The number of tasks in the deployment that are in the PENDING status. + */ + pendingCount?: Integer; + /** + * The number of tasks in the deployment that are in the RUNNING status. + */ + runningCount?: Integer; + /** + * The Unix timestamp for when the service deployment was created. + */ + createdAt?: Timestamp; + /** + * The Unix timestamp for when the service deployment was last updated. + */ + updatedAt?: Timestamp; + /** + * The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + launchType?: LaunchType; + /** + * The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + platformVersion?: String; + /** + * The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode. + */ + networkConfiguration?: NetworkConfiguration; + } + export interface DeploymentConfiguration { + /** + * If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%. If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service. + */ + maximumPercent?: BoxedInteger; + /** + * If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%. If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. + */ + minimumHealthyPercent?: BoxedInteger; + } + export interface DeploymentController { + /** + * The deployment controller type to use. There are three deployment controller types available: ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service. + */ + type: DeploymentControllerType; + } + export type DeploymentControllerType = "ECS"|"CODE_DEPLOY"|"EXTERNAL"|string; + export type Deployments = Deployment[]; + export interface DeregisterContainerInstanceRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID . + */ + containerInstance: String; + /** + * Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group. + */ + force?: BoxedBoolean; + } + export interface DeregisterContainerInstanceResponse { + /** + * The container instance that was deregistered. + */ + containerInstance?: ContainerInstance; + } + export interface DeregisterTaskDefinitionRequest { + /** + * The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision. + */ + taskDefinition: String; + } + export interface DeregisterTaskDefinitionResponse { + /** + * The full description of the deregistered task. + */ + taskDefinition?: TaskDefinition; + } + export interface DescribeClustersRequest { + /** + * A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed. + */ + clusters?: StringList; + /** + * Additional information about your clusters to be separated by launch type, including: runningEC2TasksCount runningFargateTasksCount pendingEC2TasksCount pendingFargateTasksCount activeEC2ServiceCount activeFargateServiceCount drainingEC2ServiceCount drainingFargateServiceCount + */ + include?: ClusterFieldList; + } + export interface DescribeClustersResponse { + /** + * The list of clusters. + */ + clusters?: Clusters; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export interface DescribeContainerInstancesRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries. + */ + containerInstances: StringList; + /** + * Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. + */ + include?: ContainerInstanceFieldList; + } + export interface DescribeContainerInstancesResponse { + /** + * The list of container instances. + */ + containerInstances?: ContainerInstances; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export interface DescribeServicesRequest { + /** + * The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * A list of services to describe. You may specify up to 10 services to describe in a single operation. + */ + services: StringList; + /** + * Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. + */ + include?: ServiceFieldList; + } + export interface DescribeServicesResponse { + /** + * The list of services described. + */ + services?: Services; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export interface DescribeTaskDefinitionRequest { + /** + * The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe. + */ + taskDefinition: String; + /** + * Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. + */ + include?: TaskDefinitionFieldList; + } + export interface DescribeTaskDefinitionResponse { + /** + * The full task definition description. + */ + taskDefinition?: TaskDefinition; + /** + * The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + } + export interface DescribeTaskSetsRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in. + */ + cluster: String; + /** + * The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in. + */ + service: String; + /** + * The ID or full Amazon Resource Name (ARN) of task sets to describe. + */ + taskSets?: StringList; + } + export interface DescribeTaskSetsResponse { + /** + * The list of task sets described. + */ + taskSets?: TaskSets; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export interface DescribeTasksRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * A list of up to 100 task IDs or full ARN entries. + */ + tasks: StringList; + /** + * Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. + */ + include?: TaskFieldList; + } + export interface DescribeTasksResponse { + /** + * The list of tasks. + */ + tasks?: Tasks; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export type DesiredStatus = "RUNNING"|"PENDING"|"STOPPED"|string; + export interface Device { + /** + * The path for the device on the host container instance. + */ + hostPath: String; + /** + * The path inside the container at which to expose the host device. + */ + containerPath?: String; + /** + * The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device. + */ + permissions?: DeviceCgroupPermissions; + } + export type DeviceCgroupPermission = "read"|"write"|"mknod"|string; + export type DeviceCgroupPermissions = DeviceCgroupPermission[]; + export type DevicesList = Device[]; + export interface DiscoverPollEndpointRequest { + /** + * The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID . + */ + containerInstance?: String; + /** + * The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs. + */ + cluster?: String; + } + export interface DiscoverPollEndpointResponse { + /** + * The endpoint for the Amazon ECS agent to poll. + */ + endpoint?: String; + /** + * The telemetry endpoint for the Amazon ECS agent. + */ + telemetryEndpoint?: String; + } + export type DockerLabelsMap = {[key: string]: String}; + export interface DockerVolumeConfiguration { + /** + * The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops. + */ + scope?: Scope; + /** + * If this value is true, the Docker volume is created if it does not already exist. This field is only used if the scope is shared. + */ + autoprovision?: BoxedBoolean; + /** + * The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create . + */ + driver?: String; + /** + * A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create . + */ + driverOpts?: StringMap; + /** + * Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create . + */ + labels?: StringMap; + } + export type Double = number; + export type EnvironmentVariables = KeyValuePair[]; + export interface Failure { + /** + * The Amazon Resource Name (ARN) of the failed resource. + */ + arn?: String; + /** + * The reason for the failure. + */ + reason?: String; + } + export type Failures = Failure[]; + export type GpuIds = String[]; + export interface HealthCheck { + /** + * A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example: [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API. + */ + command: StringList; + /** + * The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. + */ + interval?: BoxedInteger; + /** + * 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. + */ + timeout?: BoxedInteger; + /** + * 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?: BoxedInteger; + /** + * 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 startPeriod is disabled by default. If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. + */ + startPeriod?: BoxedInteger; + } + export type HealthStatus = "HEALTHY"|"UNHEALTHY"|"UNKNOWN"|string; + export interface HostEntry { + /** + * The hostname to use in the /etc/hosts entry. + */ + hostname: String; + /** + * The IP address to use in the /etc/hosts entry. + */ + ipAddress: String; + } + export type HostEntryList = HostEntry[]; + export interface HostVolumeProperties { + /** + * When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you are using the Fargate launch type, the sourcePath parameter is not supported. + */ + sourcePath?: String; + } + export type Integer = number; + export type IpcMode = "host"|"task"|"none"|string; + export interface KernelCapabilities { + /** + * The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run. If you are using tasks that use the Fargate launch type, the add parameter is not supported. Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" + */ + add?: StringList; + /** + * The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run. Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" + */ + drop?: StringList; + } + export interface KeyValuePair { + /** + * The name of the key-value pair. For environment variables, this is the name of the environment variable. + */ + name?: String; + /** + * The value of the key-value pair. For environment variables, this is the value of the environment variable. + */ + value?: String; + } + export type LaunchType = "EC2"|"FARGATE"|string; + export interface LinuxParameters { + /** + * The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported. + */ + capabilities?: KernelCapabilities; + /** + * Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run. If you are using tasks that use the Fargate launch type, the devices parameter is not supported. + */ + devices?: DevicesList; + /** + * Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + */ + initProcessEnabled?: BoxedBoolean; + /** + * The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run. If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported. + */ + sharedMemorySize?: BoxedInteger; + /** + * The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run. If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported. + */ + tmpfs?: TmpfsList; + } + export interface ListAccountSettingsRequest { + /** + * The resource name you want to list the account settings for. + */ + name?: SettingName; + /** + * The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter. + */ + value?: String; + /** + * The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user. + */ + principalArn?: String; + /** + * Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned. + */ + effectiveSettings?: Boolean; + /** + * The nextToken value returned from a previous paginated ListAccountSettings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable. + */ + maxResults?: Integer; + } + export interface ListAccountSettingsResponse { + /** + * The account settings for the resource. + */ + settings?: Settings; + /** + * The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListAttributesRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The type of the target with which to list attributes. + */ + targetType: TargetType; + /** + * The name of the attribute with which to filter the results. + */ + attributeName?: String; + /** + * The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter. + */ + attributeValue?: String; + /** + * The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: BoxedInteger; + } + export interface ListAttributesResponse { + /** + * A list of attribute objects that meet the criteria of the request. + */ + attributes?: Attributes; + /** + * The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListClustersRequest { + /** + * The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: BoxedInteger; + } + export interface ListClustersResponse { + /** + * The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account. + */ + clusterArns?: StringList; + /** + * The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListContainerInstancesRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. + */ + filter?: String; + /** + * The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: BoxedInteger; + /** + * Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING. + */ + status?: ContainerInstanceStatus; + } + export interface ListContainerInstancesResponse { + /** + * The list of container instances with full ARN entries for each container instance associated with the specified cluster. + */ + containerInstanceArns?: StringList; + /** + * The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListServicesRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable. + */ + maxResults?: BoxedInteger; + /** + * The launch type for the services to list. + */ + launchType?: LaunchType; + /** + * The scheduling strategy for services to list. + */ + schedulingStrategy?: SchedulingStrategy; + } + export interface ListServicesResponse { + /** + * The list of full ARN entries for each service associated with the specified cluster. + */ + serviceArns?: StringList; + /** + * The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances. + */ + resourceArn: String; + } + export interface ListTagsForResourceResponse { + /** + * The tags for the resource. + */ + tags?: Tags; + } + export interface ListTaskDefinitionFamiliesRequest { + /** + * The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned. + */ + familyPrefix?: String; + /** + * The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request. + */ + status?: TaskDefinitionFamilyStatus; + /** + * The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: BoxedInteger; + } + export interface ListTaskDefinitionFamiliesResponse { + /** + * The list of task definition family names that match the ListTaskDefinitionFamilies request. + */ + families?: StringList; + /** + * The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListTaskDefinitionsRequest { + /** + * The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family. + */ + familyPrefix?: String; + /** + * The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request. + */ + status?: TaskDefinitionStatus; + /** + * The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first. + */ + sort?: SortOrder; + /** + * The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: BoxedInteger; + } + export interface ListTaskDefinitionsResponse { + /** + * The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request. + */ + taskDefinitionArns?: StringList; + /** + * The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListTasksRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance. + */ + containerInstance?: String; + /** + * The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family. + */ + family?: String; + /** + * The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + /** + * The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: BoxedInteger; + /** + * The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value. + */ + startedBy?: String; + /** + * The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service. + */ + serviceName?: String; + /** + * The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING. Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING). + */ + desiredStatus?: DesiredStatus; + /** + * The launch type for services to list. + */ + launchType?: LaunchType; + } + export interface ListTasksResponse { + /** + * The list of task ARN entries for the ListTasks request. + */ + taskArns?: StringList; + /** + * The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface LoadBalancer { + /** + * The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. + */ + targetGroupArn?: String; + /** + * The name of a load balancer. + */ + loadBalancerName?: String; + /** + * The name of the container (as it appears in a container definition) to associate with the load balancer. + */ + containerName?: String; + /** + * The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping. + */ + containerPort?: BoxedInteger; + } + export type LoadBalancers = LoadBalancer[]; + export interface LogConfiguration { + /** + * The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk. For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file. For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + */ + logDriver: LogDriver; + /** + * The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' + */ + options?: LogConfigurationOptionsMap; + /** + * The secrets to pass to the log configuration. + */ + secretOptions?: SecretList; + } + export type LogConfigurationOptionsMap = {[key: string]: String}; + export type LogDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk"|string; + export type Long = number; + export interface MountPoint { + /** + * The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume. + */ + sourceVolume?: String; + /** + * The path on the container to mount the host volume at. + */ + containerPath?: String; + /** + * If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false. + */ + readOnly?: BoxedBoolean; + } + export type MountPointList = MountPoint[]; + export interface NetworkBinding { + /** + * The IP address that the container is bound to on the container instance. + */ + bindIP?: String; + /** + * The port number on the container that is used with the network binding. + */ + containerPort?: BoxedInteger; + /** + * The port number on the host that is used with the network binding. + */ + hostPort?: BoxedInteger; + /** + * The protocol used for the network binding. + */ + protocol?: TransportProtocol; + } + export type NetworkBindings = NetworkBinding[]; + export interface NetworkConfiguration { + /** + * The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC. + */ + awsvpcConfiguration?: AwsVpcConfiguration; + } + export interface NetworkInterface { + /** + * The attachment ID for the network interface. + */ + attachmentId?: String; + /** + * The private IPv4 address for the network interface. + */ + privateIpv4Address?: String; + /** + * The private IPv6 address for the network interface. + */ + ipv6Address?: String; + } + export type NetworkInterfaces = NetworkInterface[]; + export type NetworkMode = "bridge"|"host"|"awsvpc"|"none"|string; + export type PidMode = "host"|"task"|string; + export interface PlacementConstraint { + /** + * The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions. + */ + type?: PlacementConstraintType; + /** + * A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. + */ + expression?: String; + } + export type PlacementConstraintType = "distinctInstance"|"memberOf"|string; + export type PlacementConstraints = PlacementConstraint[]; + export type PlacementStrategies = PlacementStrategy[]; + export interface PlacementStrategy { + /** + * The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task). + */ + type?: PlacementStrategyType; + /** + * The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. + */ + field?: String; + } + export type PlacementStrategyType = "random"|"spread"|"binpack"|string; + export interface PlatformDevice { + /** + * The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file. + */ + id: String; + /** + * The type of device that is available on the container instance. The only supported value is GPU. + */ + type: PlatformDeviceType; + } + export type PlatformDeviceType = "GPU"|string; + export type PlatformDevices = PlatformDevice[]; + export interface PortMapping { + /** + * The port number on the container that is bound to the user-specified or automatically assigned host port. If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. + */ + containerPort?: BoxedInteger; + /** + * The port number on the container instance to reserve for your container. If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort. If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do 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. The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. 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 remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit. + */ + hostPort?: BoxedInteger; + /** + * The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp. + */ + protocol?: TransportProtocol; + } + export type PortMappingList = PortMapping[]; + export type PropagateTags = "TASK_DEFINITION"|"SERVICE"|string; + export interface ProxyConfiguration { + /** + * The proxy type. The only supported value is APPMESH. + */ + type?: ProxyConfigurationType; + /** + * The name of the container that will serve as the App Mesh proxy. + */ + containerName: String; + /** + * The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty. IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty. AppPorts - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort. ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to. ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to. EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list. EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list. + */ + properties?: ProxyConfigurationProperties; + } + export type ProxyConfigurationProperties = KeyValuePair[]; + export type ProxyConfigurationType = "APPMESH"|string; + export interface PutAccountSettingDefaultRequest { + /** + * The resource type to enable the new format for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks are affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances are affected. + */ + name: SettingName; + /** + * The account setting value for the specified principal ARN. Accepted values are enabled and disabled. + */ + value: String; + } + export interface PutAccountSettingDefaultResponse { + setting?: Setting; + } + export interface PutAccountSettingRequest { + /** + * The resource name for which to enable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. + */ + name: SettingName; + /** + * The account setting value for the specified principal ARN. Accepted values are enabled and disabled. + */ + value: String; + /** + * The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the settings are changed only for the authenticated user. + */ + principalArn?: String; + } + export interface PutAccountSettingResponse { + /** + * The current account setting for a resource. + */ + setting?: Setting; + } + export interface PutAttributesRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call. + */ + attributes: Attributes; + } + export interface PutAttributesResponse { + /** + * The attributes applied to your resource. + */ + attributes?: Attributes; + } + export interface RegisterContainerInstanceRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/ + */ + instanceIdentityDocument?: String; + /** + * The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/ + */ + instanceIdentityDocumentSignature?: String; + /** + * The resources available on the instance. + */ + totalResources?: Resources; + /** + * The version information for the Amazon ECS container agent and Docker daemon running on the container instance. + */ + versionInfo?: VersionInfo; + /** + * The ARN of the container instance (if it was previously registered). + */ + containerInstanceArn?: String; + /** + * The container instance attributes that this container instance supports. + */ + attributes?: Attributes; + /** + * The devices that are available on the container instance. The only supported device type is a GPU. + */ + platformDevices?: PlatformDevices; + /** + * The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + } + export interface RegisterContainerInstanceResponse { + /** + * The container instance that was registered. + */ + containerInstance?: ContainerInstance; + } + export interface RegisterTaskDefinitionRequest { + /** + * You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + */ + family: String; + /** + * The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. + */ + taskRoleArn?: String; + /** + * The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. + */ + executionRoleArn?: String; + /** + * The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode. With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings. If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode. If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object. For more information, see Network settings in the Docker run reference. + */ + networkMode?: NetworkMode; + /** + * A list of container definitions in JSON format that describe the different containers that make up your task. + */ + containerDefinitions: ContainerDefinitions; + /** + * A list of volume definitions in JSON format that containers in your task may use. + */ + volumes?: VolumeList; + /** + * An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime). + */ + placementConstraints?: TaskDefinitionPlacementConstraints; + /** + * The launch type required by the task. If no value is specified, it defaults to EC2. + */ + requiresCompatibilities?: CompatibilityList; + /** + * The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers. If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter: 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + */ + cpu?: String; + /** + * The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers. If using the EC2 launch type, this field is optional. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) + */ + memory?: String; + /** + * The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + /** + * The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference. If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security. This parameter is not supported for Windows containers or tasks using the Fargate launch type. + */ + pidMode?: PidMode; + /** + * The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference. If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security. If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide. For tasks that use the host IPC mode, IPC namespace related systemControls are not supported. For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task. This parameter is not supported for Windows containers or tasks using the Fargate launch type. + */ + ipcMode?: IpcMode; + proxyConfiguration?: ProxyConfiguration; + } + export interface RegisterTaskDefinitionResponse { + /** + * The full description of the registered task definition. + */ + taskDefinition?: TaskDefinition; + /** + * The list of tags associated with the task definition. + */ + tags?: Tags; + } + export interface RepositoryCredentials { + /** + * The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret. + */ + credentialsParameter: String; + } + export type RequiresAttributes = Attribute[]; + export interface Resource { + /** + * The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource. + */ + name?: String; + /** + * The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET. + */ + type?: String; + /** + * When the doubleValue type is set, the value of the resource must be a double precision floating-point type. + */ + doubleValue?: Double; + /** + * When the longValue type is set, the value of the resource must be an extended precision floating-point type. + */ + longValue?: Long; + /** + * When the integerValue type is set, the value of the resource must be an integer. + */ + integerValue?: Integer; + /** + * When the stringSetValue type is set, the value of the resource must be a string type. + */ + stringSetValue?: StringList; + } + export interface ResourceRequirement { + /** + * The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on. + */ + value: String; + /** + * The type of resource to assign to a container. The only supported value is GPU. + */ + type: ResourceType; + } + export type ResourceRequirements = ResourceRequirement[]; + export type ResourceType = "GPU"|string; + export type Resources = Resource[]; + export interface RunTaskRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used. + */ + taskDefinition: String; + /** + * A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure. + */ + overrides?: TaskOverride; + /** + * The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call. + */ + count?: BoxedInteger; + /** + * 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 startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it. + */ + startedBy?: String; + /** + * The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name). + */ + group?: String; + /** + * An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). + */ + placementConstraints?: PlacementConstraints; + /** + * The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task. + */ + placementStrategy?: PlacementStrategies; + /** + * The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + launchType?: LaunchType; + /** + * The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + platformVersion?: String; + /** + * The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. + */ + networkConfiguration?: NetworkConfiguration; + /** + * The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + /** + * Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. + */ + enableECSManagedTags?: Boolean; + /** + * Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action. An error will be received if you specify the SERVICE option when running a task. + */ + propagateTags?: PropagateTags; + } + export interface RunTaskResponse { + /** + * A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here. + */ + tasks?: Tasks; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export interface Scale { + /** + * The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100. + */ + value?: Double; + /** + * The unit of measure for the scale value. + */ + unit?: ScaleUnit; + } + export type ScaleUnit = "PERCENT"|string; + export type SchedulingStrategy = "REPLICA"|"DAEMON"|string; + export type Scope = "task"|"shared"|string; + export interface Secret { + /** + * The name of the secret. + */ + name: String; + /** + * The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. + */ + valueFrom: String; + } + export type SecretList = Secret[]; + export interface Service { + /** + * The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service . + */ + serviceArn?: String; + /** + * The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. + */ + serviceName?: String; + /** + * The Amazon Resource Name (ARN) of the cluster that hosts the service. + */ + clusterArn?: String; + /** + * A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. + */ + loadBalancers?: LoadBalancers; + /** + * The details of the service discovery registries to assign to this service. For more information, see Service Discovery. + */ + serviceRegistries?: ServiceRegistries; + /** + * The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE. + */ + status?: String; + /** + * The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService. + */ + desiredCount?: Integer; + /** + * The number of tasks in the cluster that are in the RUNNING state. + */ + runningCount?: Integer; + /** + * The number of tasks in the cluster that are in the PENDING state. + */ + pendingCount?: Integer; + /** + * The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + launchType?: LaunchType; + /** + * The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + platformVersion?: String; + /** + * The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService. + */ + taskDefinition?: String; + /** + * Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. + */ + deploymentConfiguration?: DeploymentConfiguration; + /** + * Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. + */ + taskSets?: TaskSets; + /** + * The current state of deployments for the service. + */ + deployments?: Deployments; + /** + * 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. + */ + roleArn?: String; + /** + * The event stream for your service. A maximum of 100 of the latest events are displayed. + */ + events?: ServiceEvents; + /** + * The Unix timestamp for when the service was created. + */ + createdAt?: Timestamp; + /** + * The placement constraints for the tasks in the service. + */ + placementConstraints?: PlacementConstraints; + /** + * The placement strategy that determines how tasks for the service are placed. + */ + placementStrategy?: PlacementStrategies; + /** + * The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode. + */ + networkConfiguration?: NetworkConfiguration; + /** + * 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. + */ + healthCheckGracePeriodSeconds?: BoxedInteger; + /** + * The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available: REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. DAEMON-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies. Fargate tasks do not support the DAEMON scheduling strategy. + */ + schedulingStrategy?: SchedulingStrategy; + /** + * The deployment controller type the service is using. + */ + deploymentController?: DeploymentController; + /** + * The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + /** + * The principal that created the service. + */ + createdBy?: String; + /** + * Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. + */ + enableECSManagedTags?: Boolean; + /** + * Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated. + */ + propagateTags?: PropagateTags; + } + export interface ServiceEvent { + /** + * The ID string of the event. + */ + id?: String; + /** + * The Unix timestamp for when the event was triggered. + */ + createdAt?: Timestamp; + /** + * The event message. + */ + message?: String; + } + export type ServiceEvents = ServiceEvent[]; + export type ServiceField = "TAGS"|string; + export type ServiceFieldList = ServiceField[]; + export type ServiceRegistries = ServiceRegistry[]; + export interface ServiceRegistry { + /** + * The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService. + */ + registryArn?: String; + /** + * The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. + */ + port?: BoxedInteger; + /** + * The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. + */ + containerName?: String; + /** + * The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. + */ + containerPort?: BoxedInteger; + } + export type Services = Service[]; + export interface Setting { + /** + * The account resource name. + */ + name?: SettingName; + /** + * The current account setting for the resource name. If enabled, the resource receives the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled, the resource receives the old Amazon Resource Name (ARN) and resource identifier (ID) format. + */ + value?: String; + /** + * The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed. + */ + principalArn?: String; + } + export type SettingName = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|string; + export type Settings = Setting[]; + export type SortOrder = "ASC"|"DESC"|string; + export type StabilityStatus = "STEADY_STATE"|"STABILIZING"|string; + export interface StartTaskRequest { + /** + * 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. + */ + cluster?: String; + /** + * The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used. + */ + taskDefinition: String; + /** + * A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure. + */ + overrides?: TaskOverride; + /** + * 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. + */ + containerInstances: StringList; + /** + * 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 startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it. + */ + startedBy?: String; + /** + * The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name). + */ + group?: String; + /** + * The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode. + */ + networkConfiguration?: NetworkConfiguration; + /** + * The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + /** + * Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. + */ + enableECSManagedTags?: Boolean; + /** + * Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated. + */ + propagateTags?: PropagateTags; + } + export interface StartTaskResponse { + /** + * A full description of the tasks that were started. Each task that was successfully placed on your container instances is described. + */ + tasks?: Tasks; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export type Statistics = KeyValuePair[]; + export interface StopTaskRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The task ID or full Amazon Resource Name (ARN) of the task to stop. + */ + task: String; + /** + * An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message. + */ + reason?: String; + } + export interface StopTaskResponse { + /** + * The task that was stopped. + */ + task?: Task; + } + export type String = string; + export type StringList = String[]; + export type StringMap = {[key: string]: String}; + export interface SubmitContainerStateChangeRequest { + /** + * The short name or full ARN of the cluster that hosts the container. + */ + cluster?: String; + /** + * The task ID or full Amazon Resource Name (ARN) of the task that hosts the container. + */ + task?: String; + /** + * The name of the container. + */ + containerName?: String; + /** + * The status of the state change request. + */ + status?: String; + /** + * The exit code returned for the state change request. + */ + exitCode?: BoxedInteger; + /** + * The reason for the state change request. + */ + reason?: String; + /** + * The network bindings of the container. + */ + networkBindings?: NetworkBindings; + } + export interface SubmitContainerStateChangeResponse { + /** + * Acknowledgement of the state change. + */ + acknowledgment?: String; + } + export interface SubmitTaskStateChangeRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task. + */ + cluster?: String; + /** + * The task ID or full ARN of the task in the state change request. + */ + task?: String; + /** + * The status of the state change request. + */ + status?: String; + /** + * The reason for the state change request. + */ + reason?: String; + /** + * Any containers associated with the state change request. + */ + containers?: ContainerStateChanges; + /** + * Any attachments associated with the state change request. + */ + attachments?: AttachmentStateChanges; + /** + * The Unix timestamp for when the container image pull began. + */ + pullStartedAt?: Timestamp; + /** + * The Unix timestamp for when the container image pull completed. + */ + pullStoppedAt?: Timestamp; + /** + * The Unix timestamp for when the task execution stopped. + */ + executionStoppedAt?: Timestamp; + } + export interface SubmitTaskStateChangeResponse { + /** + * Acknowledgement of the state change. + */ + acknowledgment?: String; + } + export interface SystemControl { + /** + * The namespaced kernel parameter for which to set a value. + */ + namespace?: String; + /** + * The value for the namespaced kernel parameter specified in namespace. + */ + value?: String; + } + export type SystemControls = SystemControl[]; + export interface Tag { + /** + * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. + */ + key?: TagKey; + /** + * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). + */ + value?: TagValue; + } + export type TagKey = string; + export type TagKeys = TagKey[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances. + */ + resourceArn: String; + /** + * The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags: Tags; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Tags = Tag[]; + export type TargetType = "container-instance"|string; + export interface Task { + /** + * The Amazon Resource Name (ARN) of the task. + */ + taskArn?: String; + /** + * The ARN of the cluster that hosts the task. + */ + clusterArn?: String; + /** + * The ARN of the task definition that creates the task. + */ + taskDefinitionArn?: String; + /** + * The ARN of the container instances that host the task. + */ + containerInstanceArn?: String; + /** + * One or more container overrides. + */ + overrides?: TaskOverride; + /** + * The last known status of the task. For more information, see Task Lifecycle. + */ + lastStatus?: String; + /** + * The desired status of the task. For more information, see Task Lifecycle. + */ + desiredStatus?: String; + /** + * The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered. If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter: 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + */ + cpu?: String; + /** + * The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered. If you are using the EC2 launch type, this field is optional. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) + */ + memory?: String; + /** + * The containers associated with the task. + */ + containers?: Containers; + /** + * The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it. + */ + startedBy?: String; + /** + * The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current. + */ + version?: Long; + /** + * The reason that the task was stopped. + */ + stoppedReason?: String; + /** + * The stop code indicating why a task was stopped. The stoppedReason may contain additional details. + */ + stopCode?: TaskStopCode; + /** + * The connectivity status of a task. + */ + connectivity?: Connectivity; + /** + * The Unix timestamp for when the task last went into CONNECTED status. + */ + connectivityAt?: Timestamp; + /** + * The Unix timestamp for when the container image pull began. + */ + pullStartedAt?: Timestamp; + /** + * The Unix timestamp for when the container image pull completed. + */ + pullStoppedAt?: Timestamp; + /** + * The Unix timestamp for when the task execution stopped. + */ + executionStoppedAt?: Timestamp; + /** + * The Unix timestamp for when the task was created (the task entered the PENDING state). + */ + createdAt?: Timestamp; + /** + * The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state). + */ + startedAt?: Timestamp; + /** + * The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED). + */ + stoppingAt?: Timestamp; + /** + * The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state). + */ + stoppedAt?: Timestamp; + /** + * The name of the task group associated with the task. + */ + group?: String; + /** + * The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + launchType?: LaunchType; + /** + * The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + platformVersion?: String; + /** + * The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode. + */ + attachments?: Attachments; + /** + * The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly. The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. + */ + healthStatus?: HealthStatus; + /** + * The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + tags?: Tags; + } + export interface TaskDefinition { + /** + * The full Amazon Resource Name (ARN) of the task definition. + */ + taskDefinitionArn?: String; + /** + * A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. + */ + containerDefinitions?: ContainerDefinitions; + /** + * The family of your task definition, used as the definition name. + */ + family?: String; + /** + * The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. + */ + taskRoleArn?: String; + /** + * The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. + */ + executionRoleArn?: String; + /** + * The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode. With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings. If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode. If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object. For more information, see Network settings in the Docker run reference. + */ + networkMode?: NetworkMode; + /** + * 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 1. Each time that 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. + */ + revision?: Integer; + /** + * The list of volumes in a task. If you are using the Fargate launch type, the host and sourcePath parameters are not supported. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. + */ + volumes?: VolumeList; + /** + * The status of the task definition. + */ + status?: TaskDefinitionStatus; + /** + * The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task. + */ + requiresAttributes?: RequiresAttributes; + /** + * An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task. + */ + placementConstraints?: TaskDefinitionPlacementConstraints; + /** + * The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + compatibilities?: CompatibilityList; + /** + * The launch type that the task is using. + */ + requiresCompatibilities?: CompatibilityList; + /** + * The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter: 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + */ + cpu?: String; + /** + * The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) + */ + memory?: String; + /** + * The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference. If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security. This parameter is not supported for Windows containers or tasks using the Fargate launch type. + */ + pidMode?: PidMode; + /** + * The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference. If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security. If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide. For tasks that use the host IPC mode, IPC namespace related systemControls are not supported. For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task. This parameter is not supported for Windows containers or tasks using the Fargate launch type. + */ + ipcMode?: IpcMode; + /** + * The configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide. + */ + proxyConfiguration?: ProxyConfiguration; + } + export type TaskDefinitionFamilyStatus = "ACTIVE"|"INACTIVE"|"ALL"|string; + export type TaskDefinitionField = "TAGS"|string; + export type TaskDefinitionFieldList = TaskDefinitionField[]; + export interface TaskDefinitionPlacementConstraint { + /** + * The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates. + */ + type?: TaskDefinitionPlacementConstraintType; + /** + * A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. + */ + expression?: String; + } + export type TaskDefinitionPlacementConstraintType = "memberOf"|string; + export type TaskDefinitionPlacementConstraints = TaskDefinitionPlacementConstraint[]; + export type TaskDefinitionStatus = "ACTIVE"|"INACTIVE"|string; + export type TaskField = "TAGS"|string; + export type TaskFieldList = TaskField[]; + export interface TaskOverride { + /** + * One or more container overrides sent to a task. + */ + containerOverrides?: ContainerOverrides; + /** + * 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. + */ + taskRoleArn?: String; + /** + * The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. + */ + executionRoleArn?: String; + } + export interface TaskSet { + /** + * The ID of the task set. + */ + id?: String; + /** + * The Amazon Resource Name (ARN) of the task set. + */ + taskSetArn?: String; + /** + * The Amazon Resource Name (ARN) of the service the task set exists in. + */ + serviceArn?: String; + /** + * The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in. + */ + clusterArn?: String; + /** + * The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used. + */ + startedBy?: String; + /** + * The external ID associated with the task set. If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID. If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute. + */ + externalId?: String; + /** + * The status of the task set. The following describes each state: PRIMARY The task set is serving production traffic. ACTIVE The task set is not serving production traffic. DRAINING The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. + */ + status?: String; + /** + * The task definition the task set is using. + */ + taskDefinition?: String; + /** + * The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks. + */ + computedDesiredCount?: Integer; + /** + * The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state. + */ + pendingCount?: Integer; + /** + * The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use. + */ + runningCount?: Integer; + /** + * The Unix timestamp for when the task set was created. + */ + createdAt?: Timestamp; + /** + * The Unix timestamp for when the task set was last updated. + */ + updatedAt?: Timestamp; + /** + * The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. + */ + launchType?: LaunchType; + /** + * The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + platformVersion?: String; + /** + * The network configuration for the task set. + */ + networkConfiguration?: NetworkConfiguration; + /** + * Details on a load balancer that is used with a task set. + */ + loadBalancers?: LoadBalancers; + /** + * The details of the service discovery registries to assign to this task set. For more information, see Service Discovery. + */ + serviceRegistries?: ServiceRegistries; + /** + * A floating-point percentage of the desired number of tasks to place and keep running in the task set. + */ + scale?: Scale; + /** + * The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE: The task runningCount is equal to the computedDesiredCount. The pendingCount is 0. There are no tasks running on container instances in the DRAINING status. All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks. If any of those conditions are not met, the stability status returns STABILIZING. + */ + stabilityStatus?: StabilityStatus; + /** + * The Unix timestamp for when the task set stability status was retrieved. + */ + stabilityStatusAt?: Timestamp; + } + export type TaskSets = TaskSet[]; + export type TaskStopCode = "TaskFailedToStart"|"EssentialContainerExited"|"UserInitiated"|string; + export type Tasks = Task[]; + export type Timestamp = Date; + export interface Tmpfs { + /** + * The absolute file path where the tmpfs volume is to be mounted. + */ + containerPath: String; + /** + * The size (in MiB) of the tmpfs volume. + */ + size: Integer; + /** + * The list of tmpfs volume mount options. Valid values: "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" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol" + */ + mountOptions?: StringList; + } + export type TmpfsList = Tmpfs[]; + export type TransportProtocol = "tcp"|"udp"|string; + export interface Ulimit { + /** + * The type of the ulimit. + */ + name: UlimitName; + /** + * The soft limit for the ulimit type. + */ + softLimit: Integer; + /** + * The hard limit for the ulimit type. + */ + hardLimit: Integer; + } + export type UlimitList = Ulimit[]; + export type UlimitName = "core"|"cpu"|"data"|"fsize"|"locks"|"memlock"|"msgqueue"|"nice"|"nofile"|"nproc"|"rss"|"rtprio"|"rttime"|"sigpending"|"stack"|string; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances. + */ + resourceArn: String; + /** + * The keys of the tags to be removed. + */ + tagKeys: TagKeys; + } + export interface UntagResourceResponse { + } + export interface UpdateContainerAgentRequest { + /** + * 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. + */ + cluster?: String; + /** + * The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent. + */ + containerInstance: String; + } + export interface UpdateContainerAgentResponse { + /** + * The container instance for which the container agent was updated. + */ + containerInstance?: ContainerInstance; + } + export interface UpdateContainerInstancesStateRequest { + /** + * 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. + */ + cluster?: String; + /** + * A list of container instance IDs or full ARN entries. + */ + containerInstances: StringList; + /** + * The container instance state with which to update the container instance. + */ + status: ContainerInstanceStatus; + } + export interface UpdateContainerInstancesStateResponse { + /** + * The list of container instances. + */ + containerInstances?: ContainerInstances; + /** + * Any failures associated with the call. + */ + failures?: Failures; + } + export interface UpdateServicePrimaryTaskSetRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in. + */ + cluster: String; + /** + * The short name or full Amazon Resource Name (ARN) of the service that the task set exists in. + */ + service: String; + /** + * The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment. + */ + primaryTaskSet: String; + } + export interface UpdateServicePrimaryTaskSetResponse { + taskSet?: TaskSet; + } + export interface UpdateServiceRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed. + */ + cluster?: String; + /** + * The name of the service to update. + */ + service: String; + /** + * The number of instantiations of the task to place and keep running in your service. + */ + desiredCount?: BoxedInteger; + /** + * The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. + */ + taskDefinition?: String; + /** + * Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. + */ + deploymentConfiguration?: DeploymentConfiguration; + /** + * The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment. + */ + networkConfiguration?: NetworkConfiguration; + /** + * The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. + */ + platformVersion?: String; + /** + * 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 (my_image:latest) or to roll Fargate tasks onto a newer platform version. + */ + forceNewDeployment?: Boolean; + /** + * 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 that time, 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. + */ + healthCheckGracePeriodSeconds?: BoxedInteger; + } + export interface UpdateServiceResponse { + /** + * The full description of your service following the update call. + */ + service?: Service; + } + export interface UpdateTaskSetRequest { + /** + * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in. + */ + cluster: String; + /** + * The short name or full Amazon Resource Name (ARN) of the service that the task set exists in. + */ + service: String; + /** + * The short name or full Amazon Resource Name (ARN) of the task set to update. + */ + taskSet: String; + scale: Scale; + } + export interface UpdateTaskSetResponse { + taskSet?: TaskSet; + } + export interface VersionInfo { + /** + * The version number of the Amazon ECS container agent. + */ + agentVersion?: String; + /** + * The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository. + */ + agentHash?: String; + /** + * The Docker version running on the container instance. + */ + dockerVersion?: String; + } + export interface Volume { + /** + * The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints. + */ + name?: String; + /** + * This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running. Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path. + */ + host?: HostVolumeProperties; + /** + * This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead. + */ + dockerVolumeConfiguration?: DockerVolumeConfiguration; + } + export interface VolumeFrom { + /** + * The name of another container within the same task definition from which to mount volumes. + */ + sourceContainer?: String; + /** + * If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false. + */ + readOnly?: BoxedBoolean; + } + export type VolumeFromList = VolumeFrom[]; + export type VolumeList = Volume[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-11-13"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ECS client. + */ + export import Types = ECS; +} +export = ECS; diff --git a/node_modules/aws-sdk/clients/ecs.js b/node_modules/aws-sdk/clients/ecs.js new file mode 100644 index 0000000..5f93755 --- /dev/null +++ b/node_modules/aws-sdk/clients/ecs.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['ecs'] = {}; +AWS.ECS = Service.defineService('ecs', ['2014-11-13']); +Object.defineProperty(apiLoader.services['ecs'], '2014-11-13', { + get: function get() { + var model = require('../apis/ecs-2014-11-13.min.json'); + model.paginators = require('../apis/ecs-2014-11-13.paginators.json').pagination; + model.waiters = require('../apis/ecs-2014-11-13.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ECS; diff --git a/node_modules/aws-sdk/clients/efs.d.ts b/node_modules/aws-sdk/clients/efs.d.ts new file mode 100644 index 0000000..b26a1b5 --- /dev/null +++ b/node_modules/aws-sdk/clients/efs.d.ts @@ -0,0 +1,525 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class EFS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: EFS.Types.ClientConfiguration) + config: Config & EFS.Types.ClientConfiguration; + /** + * Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token. The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error. The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state. This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes. After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works. This operation requires permissions for the elasticfilesystem:CreateFileSystem action. + */ + createFileSystem(params: EFS.Types.CreateFileSystemRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request; + /** + * Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token. The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error. The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state. This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes. After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works. This operation requires permissions for the elasticfilesystem:CreateFileSystem action. + */ + createFileSystem(callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request; + /** + * Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works. In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems. In the request, you also provide a subnet ID, which determines the following: VPC in which Amazon EFS creates the mount target Availability Zone in which Amazon EFS creates the mount target IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request) After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview. Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements: Must belong to the same VPC as the subnets of the existing mount targets Must not be in the same Availability Zone as any of the subnets of the existing mount targets If the request satisfies the requirements, Amazon EFS does the following: Creates a new mount target in the specified subnet. Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state. We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:CreateMountTarget This operation also requires permissions for the following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface + */ + createMountTarget(params: EFS.Types.CreateMountTargetRequest, callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request; + /** + * Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works. In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems. In the request, you also provide a subnet ID, which determines the following: VPC in which Amazon EFS creates the mount target Availability Zone in which Amazon EFS creates the mount target IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request) After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview. Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements: Must belong to the same VPC as the subnets of the existing mount targets Must not be in the same Availability Zone as any of the subnets of the existing mount targets If the request satisfies the requirements, Amazon EFS does the following: Creates a new mount target in the specified subnet. Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state. We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:CreateMountTarget This operation also requires permissions for the following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface + */ + createMountTarget(callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request; + /** + * Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation. This operation requires permission for the elasticfilesystem:CreateTags action. + */ + createTags(params: EFS.Types.CreateTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation. This operation requires permission for the elasticfilesystem:CreateTags action. + */ + createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system. You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget. The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error. This operation requires permissions for the elasticfilesystem:DeleteFileSystem action. + */ + deleteFileSystem(params: EFS.Types.DeleteFileSystemRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system. You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget. The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error. This operation requires permissions for the elasticfilesystem:DeleteFileSystem action. + */ + deleteFileSystem(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified mount target. This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system. The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface: ec2:DeleteNetworkInterface + */ + deleteMountTarget(params: EFS.Types.DeleteMountTargetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified mount target. This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system. The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface: ec2:DeleteNetworkInterface + */ + deleteMountTarget(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide. This operation requires permissions for the elasticfilesystem:DeleteTags action. + */ + deleteTags(params: EFS.Types.DeleteTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide. This operation requires permissions for the elasticfilesystem:DeleteTags action. + */ + deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker. To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified. This operation requires permissions for the elasticfilesystem:DescribeFileSystems action. + */ + describeFileSystems(params: EFS.Types.DescribeFileSystemsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeFileSystemsResponse) => void): Request; + /** + * Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker. To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified. This operation requires permissions for the elasticfilesystem:DescribeFileSystems action. + */ + describeFileSystems(callback?: (err: AWSError, data: EFS.Types.DescribeFileSystemsResponse) => void): Request; + /** + * Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation. + */ + describeLifecycleConfiguration(params: EFS.Types.DescribeLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request; + /** + * Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation. + */ + describeLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request; + /** + * Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. This operation requires permissions for the following actions: elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system. ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface. + */ + describeMountTargetSecurityGroups(params: EFS.Types.DescribeMountTargetSecurityGroupsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetSecurityGroupsResponse) => void): Request; + /** + * Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. This operation requires permissions for the following actions: elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system. ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface. + */ + describeMountTargetSecurityGroups(callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetSecurityGroupsResponse) => void): Request; + /** + * Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified. This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId. + */ + describeMountTargets(params: EFS.Types.DescribeMountTargetsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetsResponse) => void): Request; + /** + * Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified. This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId. + */ + describeMountTargets(callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetsResponse) => void): Request; + /** + * Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. This operation requires permissions for the elasticfilesystem:DescribeTags action. + */ + describeTags(params: EFS.Types.DescribeTagsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeTagsResponse) => void): Request; + /** + * Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. This operation requires permissions for the elasticfilesystem:DescribeTags action. + */ + describeTags(callback?: (err: AWSError, data: EFS.Types.DescribeTagsResponse) => void): Request; + /** + * Modifies the set of security groups in effect for a mount target. When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. The operation requires permissions for the following actions: elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system. ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface. + */ + modifyMountTargetSecurityGroups(params: EFS.Types.ModifyMountTargetSecurityGroupsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the set of security groups in effect for a mount target. When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. The operation requires permissions for the following actions: elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system. ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface. + */ + modifyMountTargetSecurityGroups(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and disables lifecycle management. You can enable lifecycle management only for EFS file systems created after the release of EFS infrequent access. In the request, specify the following: The ID for the file system for which you are creating a lifecycle management configuration. A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one "TransitionToIA": "AFTER_30_DAYS" LifecyclePolicy item. This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system. + */ + putLifecycleConfiguration(params: EFS.Types.PutLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request; + /** + * Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and disables lifecycle management. You can enable lifecycle management only for EFS file systems created after the release of EFS infrequent access. In the request, specify the following: The ID for the file system for which you are creating a lifecycle management configuration. A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one "TransitionToIA": "AFTER_30_DAYS" LifecyclePolicy item. This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system. + */ + putLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request; + /** + * Updates the throughput mode or the amount of provisioned throughput of an existing file system. + */ + updateFileSystem(params: EFS.Types.UpdateFileSystemRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request; + /** + * Updates the throughput mode or the amount of provisioned throughput of an existing file system. + */ + updateFileSystem(callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request; +} +declare namespace EFS { + export type AwsAccountId = string; + export interface CreateFileSystemRequest { + /** + * A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation. + */ + CreationToken: CreationToken; + /** + * The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. + */ + PerformanceMode?: PerformanceMode; + /** + * A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system. + */ + Encrypted?: Encrypted; + /** + * The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats: Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab. ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. Key alias - A previously created display name for a key, for example alias/projectKey1. Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1. If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true. + */ + KmsKeyId?: KmsKeyId; + /** + * The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change. + */ + ThroughputMode?: ThroughputMode; + /** + * The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide. + */ + ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps; + /** + * A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. + */ + Tags?: Tags; + } + export interface CreateMountTargetRequest { + /** + * The ID of the file system for which to create the mount target. + */ + FileSystemId: FileSystemId; + /** + * The ID of the subnet to add the mount target in. + */ + SubnetId: SubnetId; + /** + * Valid IPv4 address within the address range of the specified subnet. + */ + IpAddress?: IpAddress; + /** + * Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified. + */ + SecurityGroups?: SecurityGroups; + } + export interface CreateTagsRequest { + /** + * The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system. + */ + FileSystemId: FileSystemId; + /** + * An array of Tag objects to add. Each Tag object is a key-value pair. + */ + Tags: Tags; + } + export type CreationToken = string; + export interface DeleteFileSystemRequest { + /** + * The ID of the file system you want to delete. + */ + FileSystemId: FileSystemId; + } + export interface DeleteMountTargetRequest { + /** + * The ID of the mount target to delete (String). + */ + MountTargetId: MountTargetId; + } + export interface DeleteTagsRequest { + /** + * The ID of the file system whose tags you want to delete (String). + */ + FileSystemId: FileSystemId; + /** + * A list of tag keys to delete. + */ + TagKeys: TagKeys; + } + export interface DescribeFileSystemsRequest { + /** + * (Optional) Specifies the maximum number of file systems to return in the response (integer). Currently, this number is automatically set to 10. + */ + MaxItems?: MaxItems; + /** + * (Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off. + */ + Marker?: Marker; + /** + * (Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system. + */ + CreationToken?: CreationToken; + /** + * (Optional) ID of the file system whose description you want to retrieve (String). + */ + FileSystemId?: FileSystemId; + } + export interface DescribeFileSystemsResponse { + /** + * Present if provided by caller in the request (String). + */ + Marker?: Marker; + /** + * An array of file system descriptions. + */ + FileSystems?: FileSystemDescriptions; + /** + * Present if there are more file systems than returned in the response (String). You can use the NextMarker in the subsequent request to fetch the descriptions. + */ + NextMarker?: Marker; + } + export interface DescribeLifecycleConfigurationRequest { + /** + * The ID of the file system whose LifecycleConfiguration object you want to retrieve (String). + */ + FileSystemId: FileSystemId; + } + export interface DescribeMountTargetSecurityGroupsRequest { + /** + * The ID of the mount target whose security groups you want to retrieve. + */ + MountTargetId: MountTargetId; + } + export interface DescribeMountTargetSecurityGroupsResponse { + /** + * An array of security groups. + */ + SecurityGroups: SecurityGroups; + } + export interface DescribeMountTargetsRequest { + /** + * (Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10. + */ + MaxItems?: MaxItems; + /** + * (Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String). If present, it specifies to continue the list from where the previous returning call left off. + */ + Marker?: Marker; + /** + * (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if MountTargetId is not included. + */ + FileSystemId?: FileSystemId; + /** + * (Optional) ID of the mount target that you want to have described (String). It must be included in your request if FileSystemId is not included. + */ + MountTargetId?: MountTargetId; + } + export interface DescribeMountTargetsResponse { + /** + * If the request included the Marker, the response returns that value in this field. + */ + Marker?: Marker; + /** + * Returns the file system's mount targets as an array of MountTargetDescription objects. + */ + MountTargets?: MountTargetDescriptions; + /** + * If a value is present, there are more mount targets to return. In a subsequent request, you can provide Marker in your request with this value to retrieve the next set of mount targets. + */ + NextMarker?: Marker; + } + export interface DescribeTagsRequest { + /** + * (Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 10. + */ + MaxItems?: MaxItems; + /** + * (Optional) An opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off. + */ + Marker?: Marker; + /** + * The ID of the file system whose tag set you want to retrieve. + */ + FileSystemId: FileSystemId; + } + export interface DescribeTagsResponse { + /** + * If the request included a Marker, the response returns that value in this field. + */ + Marker?: Marker; + /** + * Returns tags associated with the file system as an array of Tag objects. + */ + Tags: Tags; + /** + * If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags. + */ + NextMarker?: Marker; + } + export type Encrypted = boolean; + export interface FileSystemDescription { + /** + * The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner. + */ + OwnerId: AwsAccountId; + /** + * The opaque string specified in the request. + */ + CreationToken: CreationToken; + /** + * The ID of the file system, assigned by Amazon EFS. + */ + FileSystemId: FileSystemId; + /** + * The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z). + */ + CreationTime: Timestamp; + /** + * The lifecycle phase of the file system. + */ + LifeCycleState: LifeCycleState; + /** + * You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field. + */ + Name?: TagValue; + /** + * The current number of mount targets that the file system has. For more information, see CreateMountTarget. + */ + NumberOfMountTargets: MountTargetCount; + /** + * The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time. + */ + SizeInBytes: FileSystemSize; + /** + * The performance mode of the file system. + */ + PerformanceMode: PerformanceMode; + /** + * A Boolean value that, if true, indicates that the file system is encrypted. + */ + Encrypted?: Encrypted; + /** + * The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system. + */ + KmsKeyId?: KmsKeyId; + /** + * The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change. + */ + ThroughputMode?: ThroughputMode; + /** + * The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide. + */ + ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps; + /** + * The tags associated with the file system, presented as an array of Tag objects. + */ + Tags: Tags; + } + export type FileSystemDescriptions = FileSystemDescription[]; + export type FileSystemId = string; + export type FileSystemNullableSizeValue = number; + export interface FileSystemSize { + /** + * The latest known metered size (in bytes) of data stored in the file system. + */ + Value: FileSystemSizeValue; + /** + * The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z. + */ + Timestamp?: Timestamp; + /** + * The latest known metered size (in bytes) of data stored in the Infrequent Access storage class. + */ + ValueInIA?: FileSystemNullableSizeValue; + /** + * The latest known metered size (in bytes) of data stored in the Standard storage class. + */ + ValueInStandard?: FileSystemNullableSizeValue; + } + export type FileSystemSizeValue = number; + export type IpAddress = string; + export type KmsKeyId = string; + export type LifeCycleState = "creating"|"available"|"updating"|"deleting"|"deleted"|string; + export interface LifecycleConfigurationDescription { + /** + * An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system. + */ + LifecyclePolicies?: LifecyclePolicies; + } + export type LifecyclePolicies = LifecyclePolicy[]; + export interface LifecyclePolicy { + /** + * A value that indicates how long it takes to transition files to the IA storage class. Currently, the only valid value is AFTER_30_DAYS. AFTER_30_DAYS indicates files that have not been read from or written to for 30 days are transitioned from the Standard storage class to the IA storage class. Metadata operations such as listing the contents of a directory don't count as a file access event. + */ + TransitionToIA?: TransitionToIARules; + } + export type Marker = string; + export type MaxItems = number; + export interface ModifyMountTargetSecurityGroupsRequest { + /** + * The ID of the mount target whose security groups you want to modify. + */ + MountTargetId: MountTargetId; + /** + * An array of up to five VPC security group IDs. + */ + SecurityGroups?: SecurityGroups; + } + export type MountTargetCount = number; + export interface MountTargetDescription { + /** + * AWS account ID that owns the resource. + */ + OwnerId?: AwsAccountId; + /** + * System-assigned mount target ID. + */ + MountTargetId: MountTargetId; + /** + * The ID of the file system for which the mount target is intended. + */ + FileSystemId: FileSystemId; + /** + * The ID of the mount target's subnet. + */ + SubnetId: SubnetId; + /** + * Lifecycle state of the mount target. + */ + LifeCycleState: LifeCycleState; + /** + * Address at which the file system can be mounted by using the mount target. + */ + IpAddress?: IpAddress; + /** + * The ID of the network interface that Amazon EFS created when it created the mount target. + */ + NetworkInterfaceId?: NetworkInterfaceId; + } + export type MountTargetDescriptions = MountTargetDescription[]; + export type MountTargetId = string; + export type NetworkInterfaceId = string; + export type PerformanceMode = "generalPurpose"|"maxIO"|string; + export type ProvisionedThroughputInMibps = number; + export interface PutLifecycleConfigurationRequest { + /** + * The ID of the file system for which you are creating the LifecycleConfiguration object (String). + */ + FileSystemId: FileSystemId; + /** + * An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object tells lifecycle management when to transition files from the Standard storage class to the Infrequent Access storage class. + */ + LifecyclePolicies: LifecyclePolicies; + } + export type SecurityGroup = string; + export type SecurityGroups = SecurityGroup[]; + export type SubnetId = string; + export interface Tag { + /** + * The tag key (String). The key can't start with aws:. + */ + Key: TagKey; + /** + * The value of the tag key. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeys = TagKey[]; + export type TagValue = string; + export type Tags = Tag[]; + export type ThroughputMode = "bursting"|"provisioned"|string; + export type Timestamp = Date; + export type TransitionToIARules = "AFTER_30_DAYS"|string; + export interface UpdateFileSystemRequest { + /** + * The ID of the file system that you want to update. + */ + FileSystemId: FileSystemId; + /** + * (Optional) The throughput mode that you want your file system to use. If you're not updating your throughput mode, you don't need to provide this value in your request. + */ + ThroughputMode?: ThroughputMode; + /** + * (Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request. + */ + ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-02-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the EFS client. + */ + export import Types = EFS; +} +export = EFS; diff --git a/node_modules/aws-sdk/clients/efs.js b/node_modules/aws-sdk/clients/efs.js new file mode 100644 index 0000000..19b4f2c --- /dev/null +++ b/node_modules/aws-sdk/clients/efs.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['efs'] = {}; +AWS.EFS = Service.defineService('efs', ['2015-02-01']); +Object.defineProperty(apiLoader.services['efs'], '2015-02-01', { + get: function get() { + var model = require('../apis/elasticfilesystem-2015-02-01.min.json'); + model.paginators = require('../apis/elasticfilesystem-2015-02-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.EFS; diff --git a/node_modules/aws-sdk/clients/eks.d.ts b/node_modules/aws-sdk/clients/eks.d.ts new file mode 100644 index 0000000..ec59951 --- /dev/null +++ b/node_modules/aws-sdk/clients/eks.d.ts @@ -0,0 +1,447 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class EKS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: EKS.Types.ClientConfiguration) + config: Config & EKS.Types.ClientConfiguration; + /** + * Creates an Amazon EKS control plane. The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, like etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique, and runs on its own set of Amazon EC2 instances. The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec, logs, and proxy data flows). Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster. You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide . You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs are not exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing. Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide. + */ + createCluster(params: EKS.Types.CreateClusterRequest, callback?: (err: AWSError, data: EKS.Types.CreateClusterResponse) => void): Request; + /** + * Creates an Amazon EKS control plane. The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, like etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique, and runs on its own set of Amazon EC2 instances. The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec, logs, and proxy data flows). Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster. You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide . You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs are not exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing. Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide. + */ + createCluster(callback?: (err: AWSError, data: EKS.Types.CreateClusterResponse) => void): Request; + /** + * Deletes the Amazon EKS cluster control plane. If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide. + */ + deleteCluster(params: EKS.Types.DeleteClusterRequest, callback?: (err: AWSError, data: EKS.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes the Amazon EKS cluster control plane. If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide. + */ + deleteCluster(callback?: (err: AWSError, data: EKS.Types.DeleteClusterResponse) => void): Request; + /** + * Returns descriptive information about an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS. The API server endpoint and certificate authority data are not available until the cluster reaches the ACTIVE state. + */ + describeCluster(params: EKS.Types.DescribeClusterRequest, callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request; + /** + * Returns descriptive information about an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS. The API server endpoint and certificate authority data are not available until the cluster reaches the ACTIVE state. + */ + describeCluster(callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request; + /** + * Returns descriptive information about an update against your Amazon EKS cluster. When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure. + */ + describeUpdate(params: EKS.Types.DescribeUpdateRequest, callback?: (err: AWSError, data: EKS.Types.DescribeUpdateResponse) => void): Request; + /** + * Returns descriptive information about an update against your Amazon EKS cluster. When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure. + */ + describeUpdate(callback?: (err: AWSError, data: EKS.Types.DescribeUpdateResponse) => void): Request; + /** + * Lists the Amazon EKS clusters in your AWS account in the specified Region. + */ + listClusters(params: EKS.Types.ListClustersRequest, callback?: (err: AWSError, data: EKS.Types.ListClustersResponse) => void): Request; + /** + * Lists the Amazon EKS clusters in your AWS account in the specified Region. + */ + listClusters(callback?: (err: AWSError, data: EKS.Types.ListClustersResponse) => void): Request; + /** + * Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region. + */ + listUpdates(params: EKS.Types.ListUpdatesRequest, callback?: (err: AWSError, data: EKS.Types.ListUpdatesResponse) => void): Request; + /** + * Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region. + */ + listUpdates(callback?: (err: AWSError, data: EKS.Types.ListUpdatesResponse) => void): Request; + /** + * Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation. You can use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide . You can also use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs are not exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active. + */ + updateClusterConfig(params: EKS.Types.UpdateClusterConfigRequest, callback?: (err: AWSError, data: EKS.Types.UpdateClusterConfigResponse) => void): Request; + /** + * Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation. You can use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide . You can also use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs are not exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active. + */ + updateClusterConfig(callback?: (err: AWSError, data: EKS.Types.UpdateClusterConfigResponse) => void): Request; + /** + * Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active. + */ + updateClusterVersion(params: EKS.Types.UpdateClusterVersionRequest, callback?: (err: AWSError, data: EKS.Types.UpdateClusterVersionResponse) => void): Request; + /** + * Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active. + */ + updateClusterVersion(callback?: (err: AWSError, data: EKS.Types.UpdateClusterVersionResponse) => void): Request; + /** + * Waits for the clusterActive state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times). + */ + waitFor(state: "clusterActive", params: EKS.Types.DescribeClusterRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request; + /** + * Waits for the clusterActive state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times). + */ + waitFor(state: "clusterActive", callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request; + /** + * Waits for the clusterDeleted state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times). + */ + waitFor(state: "clusterDeleted", params: EKS.Types.DescribeClusterRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request; + /** + * Waits for the clusterDeleted state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times). + */ + waitFor(state: "clusterDeleted", callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request; +} +declare namespace EKS { + export type Boolean = boolean; + export type BoxedBoolean = boolean; + export interface Certificate { + /** + * The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster. + */ + data?: String; + } + export interface Cluster { + /** + * The name of the cluster. + */ + name?: String; + /** + * The Amazon Resource Name (ARN) of the cluster. + */ + arn?: String; + /** + * The Unix epoch timestamp in seconds for when the cluster was created. + */ + createdAt?: Timestamp; + /** + * The Kubernetes server version for the cluster. + */ + version?: String; + /** + * The endpoint for your Kubernetes API server. + */ + endpoint?: String; + /** + * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. + */ + roleArn?: String; + /** + * The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. + */ + resourcesVpcConfig?: VpcConfigResponse; + /** + * The logging configuration for your cluster. + */ + logging?: Logging; + /** + * The current status of the cluster. + */ + status?: ClusterStatus; + /** + * The certificate-authority-data for your cluster. + */ + certificateAuthority?: Certificate; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken?: String; + /** + * The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide . + */ + platformVersion?: String; + } + export type ClusterName = string; + export type ClusterStatus = "CREATING"|"ACTIVE"|"DELETING"|"FAILED"|string; + export interface CreateClusterRequest { + /** + * The unique name to give to your cluster. + */ + name: ClusterName; + /** + * The desired Kubernetes version for your cluster. If you do not specify a value here, the latest version available in Amazon EKS is used. + */ + version?: String; + /** + * The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide . + */ + roleArn: String; + /** + * The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You may specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane. + */ + resourcesVpcConfig: VpcConfigRequest; + /** + * Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs are not exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing. + */ + logging?: Logging; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken?: String; + } + export interface CreateClusterResponse { + /** + * The full description of your new cluster. + */ + cluster?: Cluster; + } + export interface DeleteClusterRequest { + /** + * The name of the cluster to delete. + */ + name: String; + } + export interface DeleteClusterResponse { + /** + * The full description of the cluster to delete. + */ + cluster?: Cluster; + } + export interface DescribeClusterRequest { + /** + * The name of the cluster to describe. + */ + name: String; + } + export interface DescribeClusterResponse { + /** + * The full description of your specified cluster. + */ + cluster?: Cluster; + } + export interface DescribeUpdateRequest { + /** + * The name of the Amazon EKS cluster to update. + */ + name: String; + /** + * The ID of the update to describe. + */ + updateId: String; + } + export interface DescribeUpdateResponse { + /** + * The full description of the specified update. + */ + update?: Update; + } + export type ErrorCode = "SubnetNotFound"|"SecurityGroupNotFound"|"EniLimitReached"|"IpNotAvailable"|"AccessDenied"|"OperationNotPermitted"|"VpcIdNotFound"|"Unknown"|string; + export interface ErrorDetail { + /** + * A brief description of the error. SubnetNotFound: One of the subnets associated with the cluster could not be found. SecurityGroupNotFound: One of the security groups associated with the cluster could not be found. EniLimitReached: You have reached the elastic network interface limit for your account. IpNotAvailable: A subnet associated with the cluster does not have any free IP addresses. AccessDenied: You do not have permissions to perform the specified operation. OperationNotPermitted: The service role associated with the cluster does not have the required access permissions for Amazon EKS. VpcIdNotFound: The VPC associated with the cluster could not be found. + */ + errorCode?: ErrorCode; + /** + * A more complete description of the error. + */ + errorMessage?: String; + /** + * An optional field that contains the resource IDs associated with the error. + */ + resourceIds?: StringList; + } + export type ErrorDetails = ErrorDetail[]; + export interface ListClustersRequest { + /** + * The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: ListClustersRequestMaxResults; + /** + * The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: String; + } + export type ListClustersRequestMaxResults = number; + export interface ListClustersResponse { + /** + * A list of all of the clusters for your account in the specified Region. + */ + clusters?: StringList; + /** + * The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListUpdatesRequest { + /** + * The name of the Amazon EKS cluster for which to list updates. + */ + name: String; + /** + * The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. + */ + nextToken?: String; + /** + * The maximum number of update results returned by ListUpdates in paginated output. When this parameter is used, ListUpdates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListUpdates returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: ListUpdatesRequestMaxResults; + } + export type ListUpdatesRequestMaxResults = number; + export interface ListUpdatesResponse { + /** + * A list of all the updates for the specified cluster and Region. + */ + updateIds?: StringList; + /** + * The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface LogSetup { + /** + * The available cluster control plane log types. + */ + types?: LogTypes; + /** + * If a log type is enabled, then that log type exports its control plane logs to CloudWatch Logs. If a log type is not enabled, then that log type does not export its control plane logs. Each individual log type can be enabled or disabled independently. + */ + enabled?: BoxedBoolean; + } + export type LogSetups = LogSetup[]; + export type LogType = "api"|"audit"|"authenticator"|"controllerManager"|"scheduler"|string; + export type LogTypes = LogType[]; + export interface Logging { + /** + * The cluster control plane logging configuration for your cluster. + */ + clusterLogging?: LogSetups; + } + export type String = string; + export type StringList = String[]; + export type Timestamp = Date; + export interface Update { + /** + * A UUID that is used to track the update. + */ + id?: String; + /** + * The current status of the update. + */ + status?: UpdateStatus; + /** + * The type of the update. + */ + type?: UpdateType; + /** + * A key-value map that contains the parameters associated with the update. + */ + params?: UpdateParams; + /** + * The Unix epoch timestamp in seconds for when the update was created. + */ + createdAt?: Timestamp; + /** + * Any errors associated with a Failed update. + */ + errors?: ErrorDetails; + } + export interface UpdateClusterConfigRequest { + /** + * The name of the Amazon EKS cluster to update. + */ + name: String; + resourcesVpcConfig?: VpcConfigRequest; + /** + * Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs are not exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing. + */ + logging?: Logging; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken?: String; + } + export interface UpdateClusterConfigResponse { + update?: Update; + } + export interface UpdateClusterVersionRequest { + /** + * The name of the Amazon EKS cluster to update. + */ + name: String; + /** + * The desired Kubernetes version following a successful update. + */ + version: String; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken?: String; + } + export interface UpdateClusterVersionResponse { + /** + * The full description of the specified update + */ + update?: Update; + } + export interface UpdateParam { + /** + * The keys associated with an update request. + */ + type?: UpdateParamType; + /** + * The value of the keys submitted as part of an update request. + */ + value?: String; + } + export type UpdateParamType = "Version"|"PlatformVersion"|"EndpointPrivateAccess"|"EndpointPublicAccess"|"ClusterLogging"|string; + export type UpdateParams = UpdateParam[]; + export type UpdateStatus = "InProgress"|"Failed"|"Cancelled"|"Successful"|string; + export type UpdateType = "VersionUpdate"|"EndpointAccessUpdate"|"LoggingUpdate"|string; + export interface VpcConfigRequest { + /** + * Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane. + */ + subnetIds?: StringList; + /** + * Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you do not specify a security group, the default security group for your VPC is used. + */ + securityGroupIds?: StringList; + /** + * Set this value to false to disable public access for your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide . + */ + endpointPublicAccess?: BoxedBoolean; + /** + * Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC will use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide . + */ + endpointPrivateAccess?: BoxedBoolean; + } + export interface VpcConfigResponse { + /** + * The subnets associated with your cluster. + */ + subnetIds?: StringList; + /** + * The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane. + */ + securityGroupIds?: StringList; + /** + * The VPC associated with your cluster. + */ + vpcId?: String; + /** + * This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC. + */ + endpointPublicAccess?: Boolean; + /** + * This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC will use the private VPC endpoint instead of traversing the internet. + */ + endpointPrivateAccess?: Boolean; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-11-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the EKS client. + */ + export import Types = EKS; +} +export = EKS; diff --git a/node_modules/aws-sdk/clients/eks.js b/node_modules/aws-sdk/clients/eks.js new file mode 100644 index 0000000..88f7a86 --- /dev/null +++ b/node_modules/aws-sdk/clients/eks.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['eks'] = {}; +AWS.EKS = Service.defineService('eks', ['2017-11-01']); +Object.defineProperty(apiLoader.services['eks'], '2017-11-01', { + get: function get() { + var model = require('../apis/eks-2017-11-01.min.json'); + model.paginators = require('../apis/eks-2017-11-01.paginators.json').pagination; + model.waiters = require('../apis/eks-2017-11-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.EKS; diff --git a/node_modules/aws-sdk/clients/elasticache.d.ts b/node_modules/aws-sdk/clients/elasticache.d.ts new file mode 100644 index 0000000..4b4931f --- /dev/null +++ b/node_modules/aws-sdk/clients/elasticache.d.ts @@ -0,0 +1,2433 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ElastiCache extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ElastiCache.Types.ClientConfiguration) + config: Config & ElastiCache.Types.ClientConfiguration; + /** + * Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs. When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide. + */ + addTagsToResource(params: ElastiCache.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request; + /** + * Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs. When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide. + */ + addTagsToResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request; + /** + * Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. + */ + authorizeCacheSecurityGroupIngress(params: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult) => void): Request; + /** + * Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. + */ + authorizeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult) => void): Request; + /** + * Makes a copy of an existing snapshot. This operation is valid for Redis only. Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control. You could receive the following error messages. Error Messages Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions. Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. + */ + copySnapshot(params: ElastiCache.Types.CopySnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request; + /** + * Makes a copy of an existing snapshot. This operation is valid for Redis only. Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control. You could receive the following error messages. Error Messages Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions. Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. + */ + copySnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request; + /** + * Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters. + */ + createCacheCluster(params: ElastiCache.Types.CreateCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request; + /** + * Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters. + */ + createCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request; + /** + * Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide. + */ + createCacheParameterGroup(params: ElastiCache.Types.CreateCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request; + /** + * Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide. + */ + createCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request; + /** + * Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup. + */ + createCacheSecurityGroup(params: ElastiCache.Types.CreateCacheSecurityGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request; + /** + * Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup. + */ + createCacheSecurityGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request; + /** + * Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). + */ + createCacheSubnetGroup(params: ElastiCache.Types.CreateCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request; + /** + * Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). + */ + createCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request; + /** + * Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards). When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide. This operation is valid for Redis only. + */ + createReplicationGroup(params: ElastiCache.Types.CreateReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request; + /** + * Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards). When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide. This operation is valid for Redis only. + */ + createReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request; + /** + * Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only. + */ + createSnapshot(params: ElastiCache.Types.CreateSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request; + /** + * Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only. + */ + createSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request; + /** + * Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. + */ + decreaseReplicaCount(params: ElastiCache.Types.DecreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request; + /** + * Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. + */ + decreaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request; + /** + * Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group. This operation is not valid for Redis (cluster mode enabled) clusters. + */ + deleteCacheCluster(params: ElastiCache.Types.DeleteCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request; + /** + * Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group. This operation is not valid for Redis (cluster mode enabled) clusters. + */ + deleteCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request; + /** + * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. + */ + deleteCacheParameterGroup(params: ElastiCache.Types.DeleteCacheParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. + */ + deleteCacheParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters. + */ + deleteCacheSecurityGroup(params: ElastiCache.Types.DeleteCacheSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters. + */ + deleteCacheSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters. + */ + deleteCacheSubnetGroup(params: ElastiCache.Types.DeleteCacheSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters. + */ + deleteCacheSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. This operation is valid for Redis only. + */ + deleteReplicationGroup(params: ElastiCache.Types.DeleteReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request; + /** + * Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. This operation is valid for Redis only. + */ + deleteReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request; + /** + * Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Redis only. + */ + deleteSnapshot(params: ElastiCache.Types.DeleteSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request; + /** + * Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Redis only. + */ + deleteSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request; + /** + * Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed. + */ + describeCacheClusters(params: ElastiCache.Types.DescribeCacheClustersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request; + /** + * Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed. + */ + describeCacheClusters(callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request; + /** + * Returns a list of the available cache engines and their versions. + */ + describeCacheEngineVersions(params: ElastiCache.Types.DescribeCacheEngineVersionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request; + /** + * Returns a list of the available cache engines and their versions. + */ + describeCacheEngineVersions(callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request; + /** + * Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group. + */ + describeCacheParameterGroups(params: ElastiCache.Types.DescribeCacheParameterGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request; + /** + * Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group. + */ + describeCacheParameterGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request; + /** + * Returns the detailed parameter list for a particular cache parameter group. + */ + describeCacheParameters(params: ElastiCache.Types.DescribeCacheParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request; + /** + * Returns the detailed parameter list for a particular cache parameter group. + */ + describeCacheParameters(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request; + /** + * Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. + */ + describeCacheSecurityGroups(params: ElastiCache.Types.DescribeCacheSecurityGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request; + /** + * Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. + */ + describeCacheSecurityGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request; + /** + * Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. + */ + describeCacheSubnetGroups(params: ElastiCache.Types.DescribeCacheSubnetGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request; + /** + * Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. + */ + describeCacheSubnetGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request; + /** + * Returns the default engine and system parameter information for the specified cache engine. + */ + describeEngineDefaultParameters(params: ElastiCache.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the specified cache engine. + */ + describeEngineDefaultParameters(callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request; + /** + * Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. + */ + describeEvents(params: ElastiCache.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request; + /** + * Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. + */ + describeEvents(callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request; + /** + * Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Redis only. + */ + describeReplicationGroups(params: ElastiCache.Types.DescribeReplicationGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request; + /** + * Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Redis only. + */ + describeReplicationGroups(callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request; + /** + * Returns information about reserved cache nodes for this account, or about a specified reserved cache node. + */ + describeReservedCacheNodes(params: ElastiCache.Types.DescribeReservedCacheNodesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request; + /** + * Returns information about reserved cache nodes for this account, or about a specified reserved cache node. + */ + describeReservedCacheNodes(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request; + /** + * Lists available reserved cache node offerings. + */ + describeReservedCacheNodesOfferings(params: ElastiCache.Types.DescribeReservedCacheNodesOfferingsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request; + /** + * Lists available reserved cache node offerings. + */ + describeReservedCacheNodesOfferings(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request; + /** + * Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Redis only. + */ + describeSnapshots(params: ElastiCache.Types.DescribeSnapshotsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request; + /** + * Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Redis only. + */ + describeSnapshots(callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request; + /** + * Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. + */ + increaseReplicaCount(params: ElastiCache.Types.IncreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request; + /** + * Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. + */ + increaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request; + /** + * Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation. + */ + listAllowedNodeTypeModifications(params: ElastiCache.Types.ListAllowedNodeTypeModificationsMessage, callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request; + /** + * Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation. + */ + listAllowedNodeTypeModifications(callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request; + /** + * Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs. If the cluster is not in the available state, ListTagsForResource returns an error. You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags. + */ + listTagsForResource(params: ElastiCache.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request; + /** + * Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs. If the cluster is not in the available state, ListTagsForResource returns an error. You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags. + */ + listTagsForResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request; + /** + * Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values. + */ + modifyCacheCluster(params: ElastiCache.Types.ModifyCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request; + /** + * Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values. + */ + modifyCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request; + /** + * Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. + */ + modifyCacheParameterGroup(params: ElastiCache.Types.ModifyCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. + */ + modifyCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request; + /** + * Modifies an existing cache subnet group. + */ + modifyCacheSubnetGroup(params: ElastiCache.Types.ModifyCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request; + /** + * Modifies an existing cache subnet group. + */ + modifyCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request; + /** + * Modifies the settings for a replication group. For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see: Scaling for Amazon ElastiCache for Redis—Redis (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only. + */ + modifyReplicationGroup(params: ElastiCache.Types.ModifyReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request; + /** + * Modifies the settings for a replication group. For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see: Scaling for Amazon ElastiCache for Redis—Redis (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only. + */ + modifyReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request; + /** + * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards. + */ + modifyReplicationGroupShardConfiguration(params: ElastiCache.Types.ModifyReplicationGroupShardConfigurationMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request; + /** + * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards. + */ + modifyReplicationGroupShardConfiguration(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request; + /** + * Allows you to purchase a reserved cache node offering. + */ + purchaseReservedCacheNodesOffering(params: ElastiCache.Types.PurchaseReservedCacheNodesOfferingMessage, callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request; + /** + * Allows you to purchase a reserved cache node offering. + */ + purchaseReservedCacheNodesOffering(callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request; + /** + * Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process. + */ + rebootCacheCluster(params: ElastiCache.Types.RebootCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request; + /** + * Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process. + */ + rebootCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request; + /** + * Removes the tags identified by the TagKeys list from the named resource. + */ + removeTagsFromResource(params: ElastiCache.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request; + /** + * Removes the tags identified by the TagKeys list from the named resource. + */ + removeTagsFromResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request; + /** + * Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters. + */ + resetCacheParameterGroup(params: ElastiCache.Types.ResetCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters. + */ + resetCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request; + /** + * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized. + */ + revokeCacheSecurityGroupIngress(params: ElastiCache.Types.RevokeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request; + /** + * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized. + */ + revokeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request; + /** + * Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). Note the following A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period. If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently. If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made. To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide. + */ + testFailover(params: ElastiCache.Types.TestFailoverMessage, callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request; + /** + * Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). Note the following A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period. If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently. If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made. To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide. + */ + testFailover(callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request; + /** + * Waits for the cacheClusterAvailable state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is available. + */ + waitFor(state: "cacheClusterAvailable", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request; + /** + * Waits for the cacheClusterAvailable state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is available. + */ + waitFor(state: "cacheClusterAvailable", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request; + /** + * Waits for the cacheClusterDeleted state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is deleted. + */ + waitFor(state: "cacheClusterDeleted", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request; + /** + * Waits for the cacheClusterDeleted state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is deleted. + */ + waitFor(state: "cacheClusterDeleted", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request; + /** + * Waits for the replicationGroupAvailable state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is available. + */ + waitFor(state: "replicationGroupAvailable", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request; + /** + * Waits for the replicationGroupAvailable state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is available. + */ + waitFor(state: "replicationGroupAvailable", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request; + /** + * Waits for the replicationGroupDeleted state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is deleted. + */ + waitFor(state: "replicationGroupDeleted", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request; + /** + * Waits for the replicationGroupDeleted state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is deleted. + */ + waitFor(state: "replicationGroupDeleted", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request; +} +declare namespace ElastiCache { + export type AZMode = "single-az"|"cross-az"|string; + export interface AddTagsToResourceMessage { + /** + * The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + ResourceName: String; + /** + * A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value. + */ + Tags: TagList; + } + export type AllowedNodeGroupId = string; + export interface AllowedNodeTypeModificationsMessage { + /** + * A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter. + */ + ScaleUpModifications?: NodeTypeList; + } + export interface AuthorizeCacheSecurityGroupIngressMessage { + /** + * The cache security group that allows network ingress. + */ + CacheSecurityGroupName: String; + /** + * The Amazon EC2 security group to be authorized for ingress to the cache security group. + */ + EC2SecurityGroupName: String; + /** + * The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter. + */ + EC2SecurityGroupOwnerId: String; + } + export interface AuthorizeCacheSecurityGroupIngressResult { + CacheSecurityGroup?: CacheSecurityGroup; + } + export type AutomaticFailoverStatus = "enabled"|"disabled"|"enabling"|"disabling"|string; + export interface AvailabilityZone { + /** + * The name of the Availability Zone. + */ + Name?: String; + } + export type AvailabilityZonesList = String[]; + export type Boolean = boolean; + export type BooleanOptional = boolean; + export interface CacheCluster { + /** + * The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster. + */ + CacheClusterId?: String; + /** + * Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211 + */ + ConfigurationEndpoint?: Endpoint; + /** + * The URL of the web page where you can download the latest ElastiCache client library. + */ + ClientDownloadLandingPage?: String; + /** + * The name of the compute and memory capacity node type for the cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * The name of the cache engine (memcached or redis) to be used for this cluster. + */ + Engine?: String; + /** + * The version of the cache engine that is used in this cluster. + */ + EngineVersion?: String; + /** + * The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting. + */ + CacheClusterStatus?: String; + /** + * The number of cache nodes in the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. + */ + NumCacheNodes?: IntegerOptional; + /** + * The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones. + */ + PreferredAvailabilityZone?: String; + /** + * The date and time when the cluster was created. + */ + CacheClusterCreateTime?: TStamp; + /** + * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30 + */ + PreferredMaintenanceWindow?: String; + PendingModifiedValues?: PendingModifiedValues; + /** + * Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS). + */ + NotificationConfiguration?: NotificationConfiguration; + /** + * A list of cache security group elements, composed of name and status sub-elements. + */ + CacheSecurityGroups?: CacheSecurityGroupMembershipList; + /** + * Status of the cache parameter group. + */ + CacheParameterGroup?: CacheParameterGroupStatus; + /** + * The name of the cache subnet group associated with the cluster. + */ + CacheSubnetGroupName?: String; + /** + * A list of cache nodes that are members of the cluster. + */ + CacheNodes?: CacheNodeList; + /** + * This parameter is currently disabled. + */ + AutoMinorVersionUpgrade?: Boolean; + /** + * A list of VPC Security Groups associated with the cluster. + */ + SecurityGroups?: SecurityGroupMembershipList; + /** + * The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group. + */ + ReplicationGroupId?: String; + /** + * The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + */ + SnapshotRetentionLimit?: IntegerOptional; + /** + * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00 + */ + SnapshotWindow?: String; + /** + * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false + */ + AuthTokenEnabled?: BooleanOptional; + /** + * A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false + */ + TransitEncryptionEnabled?: BooleanOptional; + /** + * A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false + */ + AtRestEncryptionEnabled?: BooleanOptional; + } + export type CacheClusterList = CacheCluster[]; + export interface CacheClusterMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of clusters. Each item in the list contains detailed information about one cluster. + */ + CacheClusters?: CacheClusterList; + } + export interface CacheEngineVersion { + /** + * The name of the cache engine. + */ + Engine?: String; + /** + * The version number of the cache engine. + */ + EngineVersion?: String; + /** + * The name of the cache parameter group family associated with this cache engine. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0 + */ + CacheParameterGroupFamily?: String; + /** + * The description of the cache engine. + */ + CacheEngineDescription?: String; + /** + * The description of the cache engine version. + */ + CacheEngineVersionDescription?: String; + } + export type CacheEngineVersionList = CacheEngineVersion[]; + export interface CacheEngineVersionMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of cache engine version details. Each element in the list contains detailed information about one cache engine version. + */ + CacheEngineVersions?: CacheEngineVersionList; + } + export interface CacheNode { + /** + * The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account. + */ + CacheNodeId?: String; + /** + * The current state of this cache node. + */ + CacheNodeStatus?: String; + /** + * The date and time when the cache node was created. + */ + CacheNodeCreateTime?: TStamp; + /** + * The hostname for connecting to this cache node. + */ + Endpoint?: Endpoint; + /** + * The status of the parameter group applied to this cache node. + */ + ParameterGroupStatus?: String; + /** + * The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster. + */ + SourceCacheNodeId?: String; + /** + * The Availability Zone where this node was created and now resides. + */ + CustomerAvailabilityZone?: String; + } + export type CacheNodeIdsList = String[]; + export type CacheNodeList = CacheNode[]; + export interface CacheNodeTypeSpecificParameter { + /** + * The name of the parameter. + */ + ParameterName?: String; + /** + * A description of the parameter. + */ + Description?: String; + /** + * The source of the parameter value. + */ + Source?: String; + /** + * The valid data type for the parameter. + */ + DataType?: String; + /** + * The valid range of values for the parameter. + */ + AllowedValues?: String; + /** + * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. + */ + IsModifiable?: Boolean; + /** + * The earliest cache engine version to which the parameter can apply. + */ + MinimumEngineVersion?: String; + /** + * A list of cache node types and their corresponding values for this parameter. + */ + CacheNodeTypeSpecificValues?: CacheNodeTypeSpecificValueList; + /** + * Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster. + */ + ChangeType?: ChangeType; + } + export type CacheNodeTypeSpecificParametersList = CacheNodeTypeSpecificParameter[]; + export interface CacheNodeTypeSpecificValue { + /** + * The cache node type for which this value applies. + */ + CacheNodeType?: String; + /** + * The value for the cache node type. + */ + Value?: String; + } + export type CacheNodeTypeSpecificValueList = CacheNodeTypeSpecificValue[]; + export interface CacheParameterGroup { + /** + * The name of the cache parameter group. + */ + CacheParameterGroupName?: String; + /** + * The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0 + */ + CacheParameterGroupFamily?: String; + /** + * The description for this cache parameter group. + */ + Description?: String; + } + export interface CacheParameterGroupDetails { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of Parameter instances. + */ + Parameters?: ParametersList; + /** + * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter. + */ + CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList; + } + export type CacheParameterGroupList = CacheParameterGroup[]; + export interface CacheParameterGroupNameMessage { + /** + * The name of the cache parameter group. + */ + CacheParameterGroupName?: String; + } + export interface CacheParameterGroupStatus { + /** + * The name of the cache parameter group. + */ + CacheParameterGroupName?: String; + /** + * The status of parameter updates. + */ + ParameterApplyStatus?: String; + /** + * A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.). + */ + CacheNodeIdsToReboot?: CacheNodeIdsList; + } + export interface CacheParameterGroupsMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group. + */ + CacheParameterGroups?: CacheParameterGroupList; + } + export interface CacheSecurityGroup { + /** + * The AWS account ID of the cache security group owner. + */ + OwnerId?: String; + /** + * The name of the cache security group. + */ + CacheSecurityGroupName?: String; + /** + * The description of the cache security group. + */ + Description?: String; + /** + * A list of Amazon EC2 security groups that are associated with this cache security group. + */ + EC2SecurityGroups?: EC2SecurityGroupList; + } + export interface CacheSecurityGroupMembership { + /** + * The name of the cache security group. + */ + CacheSecurityGroupName?: String; + /** + * The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified. + */ + Status?: String; + } + export type CacheSecurityGroupMembershipList = CacheSecurityGroupMembership[]; + export interface CacheSecurityGroupMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of cache security groups. Each element in the list contains detailed information about one group. + */ + CacheSecurityGroups?: CacheSecurityGroups; + } + export type CacheSecurityGroupNameList = String[]; + export type CacheSecurityGroups = CacheSecurityGroup[]; + export interface CacheSubnetGroup { + /** + * The name of the cache subnet group. + */ + CacheSubnetGroupName?: String; + /** + * The description of the cache subnet group. + */ + CacheSubnetGroupDescription?: String; + /** + * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. + */ + VpcId?: String; + /** + * A list of subnets associated with the cache subnet group. + */ + Subnets?: SubnetList; + } + export interface CacheSubnetGroupMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of cache subnet groups. Each element in the list contains detailed information about one group. + */ + CacheSubnetGroups?: CacheSubnetGroups; + } + export type CacheSubnetGroups = CacheSubnetGroup[]; + export type ChangeType = "immediate"|"requires-reboot"|string; + export type ClusterIdList = String[]; + export interface ConfigureShard { + /** + * The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id. + */ + NodeGroupId: AllowedNodeGroupId; + /** + * The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with. The minimum number of replicas in a shard or replication group is: Redis (cluster mode disabled) If Multi-AZ with Automatic Failover is enabled: 1 If Multi-AZ with Automatic Failover is not enable: 0 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails) + */ + NewReplicaCount: Integer; + /** + * A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas. + */ + PreferredAvailabilityZones?: PreferredAvailabilityZoneList; + } + export interface CopySnapshotMessage { + /** + * The name of an existing snapshot from which to make a copy. + */ + SourceSnapshotName: String; + /** + * A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting. + */ + TargetSnapshotName: String; + /** + * The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide. For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide. + */ + TargetBucket?: String; + } + export interface CopySnapshotResult { + Snapshot?: Snapshot; + } + export interface CreateCacheClusterMessage { + /** + * The node group (shard) identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens. + */ + CacheClusterId: String; + /** + * The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones. This parameter is only valid if the Engine parameter is redis. + */ + ReplicationGroupId?: String; + /** + * Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. This parameter is only supported for Memcached clusters. If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode. + */ + AZMode?: AZMode; + /** + * The EC2 Availability Zone in which the cluster is created. All nodes belonging to this Memcached cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones. Default: System chosen Availability Zone. + */ + PreferredAvailabilityZone?: String; + /** + * A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important. This option is only supported on Memcached. If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheNodes. If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. + */ + PreferredAvailabilityZones?: PreferredAvailabilityZoneList; + /** + * The initial number of cache nodes that the cluster has. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/. + */ + NumCacheNodes?: IntegerOptional; + /** + * The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * The name of the cache engine to be used for this cluster. Valid values for this parameter are: memcached | redis + */ + Engine?: String; + /** + * The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version. + */ + EngineVersion?: String; + /** + * The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster. + */ + CacheParameterGroupName?: String; + /** + * The name of the subnet group to be used for the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups. + */ + CacheSubnetGroupName?: String; + /** + * A list of security group names to associate with this cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). + */ + CacheSecurityGroupNames?: CacheSecurityGroupNameList; + /** + * One or more VPC security groups associated with the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). + */ + SecurityGroupIds?: SecurityGroupIdsList; + /** + * A list of cost allocation tags to be added to this resource. + */ + Tags?: TagList; + /** + * A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas. This parameter is only valid if the Engine parameter is redis. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb + */ + SnapshotArns?: SnapshotArnsList; + /** + * The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created. This parameter is only valid if the Engine parameter is redis. + */ + SnapshotName?: String; + /** + * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30 + */ + PreferredMaintenanceWindow?: String; + /** + * The port number on which each of the cache nodes accepts connections. + */ + Port?: IntegerOptional; + /** + * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner. + */ + NotificationTopicArn?: String; + /** + * This parameter is currently disabled. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted. This parameter is only valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are disabled for this cache cluster). + */ + SnapshotRetentionLimit?: IntegerOptional; + /** + * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis. + */ + SnapshotWindow?: String; + /** + * Reserved parameter. The password used to access a password protected server. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. Cannot contain any of the following characters: '/', '"', or '@'. For more information, see AUTH password at http://redis.io/commands/AUTH. + */ + AuthToken?: String; + } + export interface CreateCacheClusterResult { + CacheCluster?: CacheCluster; + } + export interface CreateCacheParameterGroupMessage { + /** + * A user-specified name for the cache parameter group. + */ + CacheParameterGroupName: String; + /** + * The name of the cache parameter group family that the cache parameter group can be used with. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0 + */ + CacheParameterGroupFamily: String; + /** + * A user-specified description for the cache parameter group. + */ + Description: String; + } + export interface CreateCacheParameterGroupResult { + CacheParameterGroup?: CacheParameterGroup; + } + export interface CreateCacheSecurityGroupMessage { + /** + * A name for the cache security group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default". Example: mysecuritygroup + */ + CacheSecurityGroupName: String; + /** + * A description for the cache security group. + */ + Description: String; + } + export interface CreateCacheSecurityGroupResult { + CacheSecurityGroup?: CacheSecurityGroup; + } + export interface CreateCacheSubnetGroupMessage { + /** + * A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup + */ + CacheSubnetGroupName: String; + /** + * A description for the cache subnet group. + */ + CacheSubnetGroupDescription: String; + /** + * A list of VPC subnet IDs for the cache subnet group. + */ + SubnetIds: SubnetIdentifierList; + } + export interface CreateCacheSubnetGroupResult { + CacheSubnetGroup?: CacheSubnetGroup; + } + export interface CreateReplicationGroupMessage { + /** + * The replication group identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens. + */ + ReplicationGroupId: String; + /** + * A user-created description for the replication group. + */ + ReplicationGroupDescription: String; + /** + * The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified. + */ + PrimaryClusterId?: String; + /** + * Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. Default: false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types. + */ + AutomaticFailoverEnabled?: BooleanOptional; + /** + * The number of clusters this replication group initially has. This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6. The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas). + */ + NumCacheClusters?: IntegerOptional; + /** + * A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheClusters. Default: system chosen Availability Zones. + */ + PreferredCacheClusterAZs?: AvailabilityZonesList; + /** + * An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. Default: 1 + */ + NumNodeGroups?: IntegerOptional; + /** + * An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. + */ + ReplicasPerNodeGroup?: IntegerOptional; + /** + * A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots. If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file, you must configure each node group (shard) using this parameter because you must specify the slots for each node group. + */ + NodeGroupConfiguration?: NodeGroupConfigurationList; + /** + * The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * The name of the cache engine to be used for the clusters in this replication group. + */ + Engine?: String; + /** + * The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version. + */ + EngineVersion?: String; + /** + * The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2. To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on. + */ + CacheParameterGroupName?: String; + /** + * The name of the cache subnet group to be used for the replication group. If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups. + */ + CacheSubnetGroupName?: String; + /** + * A list of cache security group names to associate with this replication group. + */ + CacheSecurityGroupNames?: CacheSecurityGroupNameList; + /** + * One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC). + */ + SecurityGroupIds?: SecurityGroupIdsList; + /** + * A list of cost allocation tags to be added to this resource. A tag is a key-value pair. + */ + Tags?: TagList; + /** + * A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb + */ + SnapshotArns?: SnapshotArnsList; + /** + * The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created. + */ + SnapshotName?: String; + /** + * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30 + */ + PreferredMaintenanceWindow?: String; + /** + * The port number on which each member of the replication group accepts connections. + */ + Port?: IntegerOptional; + /** + * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner. + */ + NotificationTopicArn?: String; + /** + * This parameter is currently disabled. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. Default: 0 (i.e., automatic backups are disabled for this cluster). + */ + SnapshotRetentionLimit?: IntegerOptional; + /** + * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. + */ + SnapshotWindow?: String; + /** + * Reserved parameter. The password used to access a password protected server. AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. Cannot contain any of the following characters: '/', '"', or '@'. For more information, see AUTH password at http://redis.io/commands/AUTH. + */ + AuthToken?: String; + /** + * A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6 or 4.x, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. + */ + TransitEncryptionEnabled?: BooleanOptional; + /** + * A flag that enables encryption at rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false + */ + AtRestEncryptionEnabled?: BooleanOptional; + } + export interface CreateReplicationGroupResult { + ReplicationGroup?: ReplicationGroup; + } + export interface CreateSnapshotMessage { + /** + * The identifier of an existing replication group. The snapshot is created from this replication group. + */ + ReplicationGroupId?: String; + /** + * The identifier of an existing cluster. The snapshot is created from this cluster. + */ + CacheClusterId?: String; + /** + * A name for the snapshot being created. + */ + SnapshotName: String; + } + export interface CreateSnapshotResult { + Snapshot?: Snapshot; + } + export interface DecreaseReplicaCountMessage { + /** + * The id of the replication group from which you want to remove replica nodes. + */ + ReplicationGroupId: String; + /** + * The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups. The minimum number of replicas in a shard or replication group is: Redis (cluster mode disabled) If Multi-AZ with Automatic Failover is enabled: 1 If Multi-AZ with Automatic Failover is not enabled: 0 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails) + */ + NewReplicaCount?: IntegerOptional; + /** + * A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones. + */ + ReplicaConfiguration?: ReplicaConfigurationList; + /** + * A list of the node ids to remove from the replication group or node group (shard). + */ + ReplicasToRemove?: RemoveReplicasList; + /** + * If True, the number of replica nodes is decreased immediately. If False, the number of replica nodes is decreased during the next maintenance window. + */ + ApplyImmediately: Boolean; + } + export interface DecreaseReplicaCountResult { + ReplicationGroup?: ReplicationGroup; + } + export interface DeleteCacheClusterMessage { + /** + * The cluster identifier for the cluster to be deleted. This parameter is not case sensitive. + */ + CacheClusterId: String; + /** + * The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward. + */ + FinalSnapshotIdentifier?: String; + } + export interface DeleteCacheClusterResult { + CacheCluster?: CacheCluster; + } + export interface DeleteCacheParameterGroupMessage { + /** + * The name of the cache parameter group to delete. The specified cache security group must not be associated with any clusters. + */ + CacheParameterGroupName: String; + } + export interface DeleteCacheSecurityGroupMessage { + /** + * The name of the cache security group to delete. You cannot delete the default security group. + */ + CacheSecurityGroupName: String; + } + export interface DeleteCacheSubnetGroupMessage { + /** + * The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. + */ + CacheSubnetGroupName: String; + } + export interface DeleteReplicationGroupMessage { + /** + * The identifier for the cluster to be deleted. This parameter is not case sensitive. + */ + ReplicationGroupId: String; + /** + * If set to true, all of the read replicas are deleted, but the primary node is retained. + */ + RetainPrimaryCluster?: BooleanOptional; + /** + * The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted. + */ + FinalSnapshotIdentifier?: String; + } + export interface DeleteReplicationGroupResult { + ReplicationGroup?: ReplicationGroup; + } + export interface DeleteSnapshotMessage { + /** + * The name of the snapshot to be deleted. + */ + SnapshotName: String; + } + export interface DeleteSnapshotResult { + Snapshot?: Snapshot; + } + export interface DescribeCacheClustersMessage { + /** + * The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive. + */ + CacheClusterId?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes. + */ + ShowCacheNodeInfo?: BooleanOptional; + /** + * An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters. + */ + ShowCacheClustersNotInReplicationGroups?: BooleanOptional; + } + export interface DescribeCacheEngineVersionsMessage { + /** + * The cache engine to return. Valid values: memcached | redis + */ + Engine?: String; + /** + * The cache engine version to return. Example: 1.4.14 + */ + EngineVersion?: String; + /** + * The name of a specific cache parameter group family to return details for. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0 Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens + */ + CacheParameterGroupFamily?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned. + */ + DefaultOnly?: Boolean; + } + export interface DescribeCacheParameterGroupsMessage { + /** + * The name of a specific cache parameter group to return details for. + */ + CacheParameterGroupName?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeCacheParametersMessage { + /** + * The name of a specific cache parameter group to return details for. + */ + CacheParameterGroupName: String; + /** + * The parameter types to return. Valid values: user | system | engine-default + */ + Source?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeCacheSecurityGroupsMessage { + /** + * The name of the cache security group to return details for. + */ + CacheSecurityGroupName?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeCacheSubnetGroupsMessage { + /** + * The name of the cache subnet group to return details for. + */ + CacheSubnetGroupName?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultParametersMessage { + /** + * The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0 + */ + CacheParameterGroupFamily: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultParametersResult { + EngineDefaults?: EngineDefaults; + } + export interface DescribeEventsMessage { + /** + * The identifier of the event source for which events are returned. If not specified, all sources are included in the response. + */ + SourceIdentifier?: String; + /** + * The event source to retrieve events for. If no value is specified, all events are returned. + */ + SourceType?: SourceType; + /** + * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z + */ + StartTime?: TStamp; + /** + * The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z + */ + EndTime?: TStamp; + /** + * The number of minutes worth of events to retrieve. + */ + Duration?: IntegerOptional; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeReplicationGroupsMessage { + /** + * The identifier for the replication group to be described. This parameter is not case sensitive. If you do not specify this parameter, information about all replication groups is returned. + */ + ReplicationGroupId?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeReservedCacheNodesMessage { + /** + * The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID. + */ + ReservedCacheNodeId?: String; + /** + * The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier. + */ + ReservedCacheNodesOfferingId?: String; + /** + * The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000 + */ + Duration?: String; + /** + * The product description filter value. Use this parameter to show only those reservations matching the specified product description. + */ + ProductDescription?: String; + /** + * The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" + */ + OfferingType?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeReservedCacheNodesOfferingsMessage { + /** + * The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 + */ + ReservedCacheNodesOfferingId?: String; + /** + * The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration. Valid Values: 1 | 3 | 31536000 | 94608000 + */ + Duration?: String; + /** + * The product description filter value. Use this parameter to show only the available offerings matching the specified product description. + */ + ProductDescription?: String; + /** + * The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" + */ + OfferingType?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeSnapshotsListMessage { + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * A list of snapshots. Each item in the list contains detailed information about one snapshot. + */ + Snapshots?: SnapshotList; + } + export interface DescribeSnapshotsMessage { + /** + * A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described. + */ + ReplicationGroupId?: String; + /** + * A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described. + */ + CacheClusterId?: String; + /** + * A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described. + */ + SnapshotName?: String; + /** + * If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots. + */ + SnapshotSource?: String; + /** + * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50. + */ + MaxRecords?: IntegerOptional; + /** + * A Boolean value which if true, the node group (shard) configuration is included in the snapshot description. + */ + ShowNodeGroupConfig?: BooleanOptional; + } + export type Double = number; + export interface EC2SecurityGroup { + /** + * The status of the Amazon EC2 security group. + */ + Status?: String; + /** + * The name of the Amazon EC2 security group. + */ + EC2SecurityGroupName?: String; + /** + * The AWS account ID of the Amazon EC2 security group owner. + */ + EC2SecurityGroupOwnerId?: String; + } + export type EC2SecurityGroupList = EC2SecurityGroup[]; + export interface Endpoint { + /** + * The DNS hostname of the cache node. + */ + Address?: String; + /** + * The port number that the cache engine is listening on. + */ + Port?: Integer; + } + export interface EngineDefaults { + /** + * Specifies the name of the cache parameter group family to which the engine default parameters apply. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0 + */ + CacheParameterGroupFamily?: String; + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * Contains a list of engine default parameters. + */ + Parameters?: ParametersList; + /** + * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter. + */ + CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList; + } + export interface Event { + /** + * The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster. + */ + SourceIdentifier?: String; + /** + * Specifies the origin of this event - a cluster, a parameter group, a security group, etc. + */ + SourceType?: SourceType; + /** + * The text of the event. + */ + Message?: String; + /** + * The date and time when the event occurred. + */ + Date?: TStamp; + } + export type EventList = Event[]; + export interface EventsMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of events. Each element in the list contains detailed information about one event. + */ + Events?: EventList; + } + export interface IncreaseReplicaCountMessage { + /** + * The id of the replication group to which you want to add replica nodes. + */ + ReplicationGroupId: String; + /** + * The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups. + */ + NewReplicaCount?: IntegerOptional; + /** + * A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones. + */ + ReplicaConfiguration?: ReplicaConfigurationList; + /** + * If True, the number of replica nodes is increased immediately. If False, the number of replica nodes is increased during the next maintenance window. + */ + ApplyImmediately: Boolean; + } + export interface IncreaseReplicaCountResult { + ReplicationGroup?: ReplicationGroup; + } + export type Integer = number; + export type IntegerOptional = number; + export type KeyList = String[]; + export interface ListAllowedNodeTypeModificationsMessage { + /** + * The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to. You must provide a value for either the CacheClusterId or the ReplicationGroupId. + */ + CacheClusterId?: String; + /** + * The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to. You must provide a value for either the CacheClusterId or the ReplicationGroupId. + */ + ReplicationGroupId?: String; + } + export interface ListTagsForResourceMessage { + /** + * The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + ResourceName: String; + } + export interface ModifyCacheClusterMessage { + /** + * The cluster identifier. This value is stored as a lowercase string. + */ + CacheClusterId: String; + /** + * The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately). A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster. + */ + NumCacheNodes?: IntegerOptional; + /** + * A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove. + */ + CacheNodeIdsToRemove?: CacheNodeIdsList; + /** + * Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones. Valid values: single-az | cross-az. This option is only supported for Memcached clusters. You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached. + */ + AZMode?: AZMode; + /** + * The list of Availability Zones where the new Memcached cache nodes are created. This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request. This option is only supported on Memcached clusters. Scenarios: Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes. Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node. Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations. The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached. Impact of new add/remove requests upon pending requests Scenario-1 Pending Action: Delete New Request: Delete Result: The new delete, pending or immediate, replaces the pending delete. Scenario-2 Pending Action: Delete New Request: Create Result: The new create, pending or immediate, replaces the pending delete. Scenario-3 Pending Action: Create New Request: Delete Result: The new delete, pending or immediate, replaces the pending create. Scenario-4 Pending Action: Create New Request: Create Result: The new create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending. + */ + NewAvailabilityZones?: PreferredAvailabilityZoneList; + /** + * A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible. You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default". + */ + CacheSecurityGroupNames?: CacheSecurityGroupNameList; + /** + * Specifies the VPC Security Groups associated with the cluster. This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC). + */ + SecurityGroupIds?: SecurityGroupIdsList; + /** + * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30 + */ + PreferredMaintenanceWindow?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the cluster owner. + */ + NotificationTopicArn?: String; + /** + * The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request. + */ + CacheParameterGroupName?: String; + /** + * The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive + */ + NotificationTopicStatus?: String; + /** + * If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false + */ + ApplyImmediately?: Boolean; + /** + * The upgraded version of the cache engine to be run on the cache nodes. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version. + */ + EngineVersion?: String; + /** + * This parameter is currently disabled. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + */ + SnapshotRetentionLimit?: IntegerOptional; + /** + * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. + */ + SnapshotWindow?: String; + /** + * A valid cache node type that you want to scale this cluster up to. + */ + CacheNodeType?: String; + } + export interface ModifyCacheClusterResult { + CacheCluster?: CacheCluster; + } + export interface ModifyCacheParameterGroupMessage { + /** + * The name of the cache parameter group to modify. + */ + CacheParameterGroupName: String; + /** + * An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request. + */ + ParameterNameValues: ParameterNameValueList; + } + export interface ModifyCacheSubnetGroupMessage { + /** + * The name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup + */ + CacheSubnetGroupName: String; + /** + * A description of the cache subnet group. + */ + CacheSubnetGroupDescription?: String; + /** + * The EC2 subnet IDs for the cache subnet group. + */ + SubnetIds?: SubnetIdentifierList; + } + export interface ModifyCacheSubnetGroupResult { + CacheSubnetGroup?: CacheSubnetGroup; + } + export interface ModifyReplicationGroupMessage { + /** + * The identifier of the replication group to modify. + */ + ReplicationGroupId: String; + /** + * A description for the replication group. Maximum length is 255 characters. + */ + ReplicationGroupDescription?: String; + /** + * For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas. + */ + PrimaryClusterId?: String; + /** + * The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups. + */ + SnapshottingClusterId?: String; + /** + * Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. Valid values: true | false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types. + */ + AutomaticFailoverEnabled?: BooleanOptional; + /** + * A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible. This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default. + */ + CacheSecurityGroupNames?: CacheSecurityGroupNameList; + /** + * Specifies the VPC Security Groups associated with the clusters in the replication group. This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC). + */ + SecurityGroupIds?: SecurityGroupIdsList; + /** + * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30 + */ + PreferredMaintenanceWindow?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the replication group owner. + */ + NotificationTopicArn?: String; + /** + * The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request. + */ + CacheParameterGroupName?: String; + /** + * The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. Valid values: active | inactive + */ + NotificationTopicStatus?: String; + /** + * If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group. If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: true | false Default: false + */ + ApplyImmediately?: Boolean; + /** + * The upgraded version of the cache engine to be run on the clusters in the replication group. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version. + */ + EngineVersion?: String; + /** + * This parameter is currently disabled. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + */ + SnapshotRetentionLimit?: IntegerOptional; + /** + * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId. Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. + */ + SnapshotWindow?: String; + /** + * A valid cache node type that you want to scale this replication group to. + */ + CacheNodeType?: String; + /** + * Deprecated. This parameter is not used. + */ + NodeGroupId?: String; + } + export interface ModifyReplicationGroupResult { + ReplicationGroup?: ReplicationGroup; + } + export interface ModifyReplicationGroupShardConfigurationMessage { + /** + * The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured. + */ + ReplicationGroupId: String; + /** + * The number of node groups (shards) that results from the modification of the shard configuration. + */ + NodeGroupCount: Integer; + /** + * Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. Value: true + */ + ApplyImmediately: Boolean; + /** + * Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you. You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards). + */ + ReshardingConfiguration?: ReshardingConfigurationList; + /** + * If the value of NodeGroupCount is less than the current number of node groups (shards), the NodeGroupsToRemove or NodeGroupsToRetain is a required list of node group ids to remove from or retain in the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster. + */ + NodeGroupsToRemove?: NodeGroupsToRemoveList; + /** + * If the value of NodeGroupCount is less than the current number of node groups (shards), the NodeGroupsToRemove or NodeGroupsToRetain is a required list of node group ids to remove from or retain in the cluster. ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster. + */ + NodeGroupsToRetain?: NodeGroupsToRetainList; + } + export interface ModifyReplicationGroupShardConfigurationResult { + ReplicationGroup?: ReplicationGroup; + } + export interface NodeGroup { + /** + * The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015. + */ + NodeGroupId?: String; + /** + * The current state of this replication group - creating, available, etc. + */ + Status?: String; + /** + * The endpoint of the primary node in this node group (shard). + */ + PrimaryEndpoint?: Endpoint; + /** + * The keyspace for this node group (shard). + */ + Slots?: String; + /** + * A list containing information about individual nodes within the node group (shard). + */ + NodeGroupMembers?: NodeGroupMemberList; + } + export interface NodeGroupConfiguration { + /** + * The 4-digit id for the node group these configuration values apply to. + */ + NodeGroupId?: AllowedNodeGroupId; + /** + * A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey. Example: "0-3999" + */ + Slots?: String; + /** + * The number of read replica nodes in this node group (shard). + */ + ReplicaCount?: IntegerOptional; + /** + * The Availability Zone where the primary node of this node group (shard) is launched. + */ + PrimaryAvailabilityZone?: String; + /** + * A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified. + */ + ReplicaAvailabilityZones?: AvailabilityZonesList; + } + export type NodeGroupConfigurationList = NodeGroupConfiguration[]; + export type NodeGroupList = NodeGroup[]; + export interface NodeGroupMember { + /** + * The ID of the cluster to which the node belongs. + */ + CacheClusterId?: String; + /** + * The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.). + */ + CacheNodeId?: String; + /** + * The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters. + */ + ReadEndpoint?: Endpoint; + /** + * The name of the Availability Zone in which the node is located. + */ + PreferredAvailabilityZone?: String; + /** + * The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups. + */ + CurrentRole?: String; + } + export type NodeGroupMemberList = NodeGroupMember[]; + export type NodeGroupsToRemoveList = AllowedNodeGroupId[]; + export type NodeGroupsToRetainList = AllowedNodeGroupId[]; + export interface NodeSnapshot { + /** + * A unique identifier for the source cluster. + */ + CacheClusterId?: String; + /** + * A unique identifier for the source node group (shard). + */ + NodeGroupId?: String; + /** + * The cache node identifier for the node in the source cluster. + */ + CacheNodeId?: String; + /** + * The configuration for the source node group (shard). + */ + NodeGroupConfiguration?: NodeGroupConfiguration; + /** + * The size of the cache on the source cache node. + */ + CacheSize?: String; + /** + * The date and time when the cache node was created in the source cluster. + */ + CacheNodeCreateTime?: TStamp; + /** + * The date and time when the source node's metadata and cache data set was obtained for the snapshot. + */ + SnapshotCreateTime?: TStamp; + } + export type NodeSnapshotList = NodeSnapshot[]; + export type NodeTypeList = String[]; + export interface NotificationConfiguration { + /** + * The Amazon Resource Name (ARN) that identifies the topic. + */ + TopicArn?: String; + /** + * The current state of the topic. + */ + TopicStatus?: String; + } + export interface Parameter { + /** + * The name of the parameter. + */ + ParameterName?: String; + /** + * The value of the parameter. + */ + ParameterValue?: String; + /** + * A description of the parameter. + */ + Description?: String; + /** + * The source of the parameter. + */ + Source?: String; + /** + * The valid data type for the parameter. + */ + DataType?: String; + /** + * The valid range of values for the parameter. + */ + AllowedValues?: String; + /** + * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. + */ + IsModifiable?: Boolean; + /** + * The earliest cache engine version to which the parameter can apply. + */ + MinimumEngineVersion?: String; + /** + * Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster. + */ + ChangeType?: ChangeType; + } + export interface ParameterNameValue { + /** + * The name of the parameter. + */ + ParameterName?: String; + /** + * The value of the parameter. + */ + ParameterValue?: String; + } + export type ParameterNameValueList = ParameterNameValue[]; + export type ParametersList = Parameter[]; + export type PendingAutomaticFailoverStatus = "enabled"|"disabled"|string; + export interface PendingModifiedValues { + /** + * The new number of cache nodes for the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. + */ + NumCacheNodes?: IntegerOptional; + /** + * A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.). + */ + CacheNodeIdsToRemove?: CacheNodeIdsList; + /** + * The new cache engine version that the cluster runs. + */ + EngineVersion?: String; + /** + * The cache node type that this cluster or replication group is scaled to. + */ + CacheNodeType?: String; + } + export type PreferredAvailabilityZoneList = String[]; + export interface PurchaseReservedCacheNodesOfferingMessage { + /** + * The ID of the reserved cache node offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 + */ + ReservedCacheNodesOfferingId: String; + /** + * A customer-specified identifier to track this reservation. The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation. Example: myreservationID + */ + ReservedCacheNodeId?: String; + /** + * The number of cache node instances to reserve. Default: 1 + */ + CacheNodeCount?: IntegerOptional; + } + export interface PurchaseReservedCacheNodesOfferingResult { + ReservedCacheNode?: ReservedCacheNode; + } + export interface RebootCacheClusterMessage { + /** + * The cluster identifier. This parameter is stored as a lowercase string. + */ + CacheClusterId: String; + /** + * A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs. + */ + CacheNodeIdsToReboot: CacheNodeIdsList; + } + export interface RebootCacheClusterResult { + CacheCluster?: CacheCluster; + } + export interface RecurringCharge { + /** + * The monetary amount of the recurring charge. + */ + RecurringChargeAmount?: Double; + /** + * The frequency of the recurring charge. + */ + RecurringChargeFrequency?: String; + } + export type RecurringChargeList = RecurringCharge[]; + export type RemoveReplicasList = String[]; + export interface RemoveTagsFromResourceMessage { + /** + * The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + ResourceName: String; + /** + * A list of TagKeys identifying the tags you want removed from the named resource. + */ + TagKeys: KeyList; + } + export type ReplicaConfigurationList = ConfigureShard[]; + export interface ReplicationGroup { + /** + * The identifier for the replication group. + */ + ReplicationGroupId?: String; + /** + * The user supplied description of the replication group. + */ + Description?: String; + /** + * The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting. + */ + Status?: String; + /** + * A group of settings to be applied to the replication group, either immediately or during the next maintenance window. + */ + PendingModifiedValues?: ReplicationGroupPendingModifiedValues; + /** + * The names of all the cache clusters that are part of this replication group. + */ + MemberClusters?: ClusterIdList; + /** + * A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard). + */ + NodeGroups?: NodeGroupList; + /** + * The cluster ID that is used as the daily snapshot source for the replication group. + */ + SnapshottingClusterId?: String; + /** + * Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types. + */ + AutomaticFailover?: AutomaticFailoverStatus; + /** + * The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group. + */ + ConfigurationEndpoint?: Endpoint; + /** + * The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + */ + SnapshotRetentionLimit?: IntegerOptional; + /** + * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis. + */ + SnapshotWindow?: String; + /** + * A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). Valid values: true | false + */ + ClusterEnabled?: BooleanOptional; + /** + * The name of the compute and memory capacity node type for each node in the replication group. + */ + CacheNodeType?: String; + /** + * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false + */ + AuthTokenEnabled?: BooleanOptional; + /** + * A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false + */ + TransitEncryptionEnabled?: BooleanOptional; + /** + * A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false + */ + AtRestEncryptionEnabled?: BooleanOptional; + } + export type ReplicationGroupList = ReplicationGroup[]; + export interface ReplicationGroupMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of replication groups. Each item in the list contains detailed information about one replication group. + */ + ReplicationGroups?: ReplicationGroupList; + } + export interface ReplicationGroupPendingModifiedValues { + /** + * The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window. + */ + PrimaryClusterId?: String; + /** + * Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types. + */ + AutomaticFailoverStatus?: PendingAutomaticFailoverStatus; + /** + * The status of an online resharding operation. + */ + Resharding?: ReshardingStatus; + } + export interface ReservedCacheNode { + /** + * The unique identifier for the reservation. + */ + ReservedCacheNodeId?: String; + /** + * The offering identifier. + */ + ReservedCacheNodesOfferingId?: String; + /** + * The cache node type for the reserved cache nodes. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * The time the reservation started. + */ + StartTime?: TStamp; + /** + * The duration of the reservation in seconds. + */ + Duration?: Integer; + /** + * The fixed price charged for this reserved cache node. + */ + FixedPrice?: Double; + /** + * The hourly price charged for this reserved cache node. + */ + UsagePrice?: Double; + /** + * The number of cache nodes that have been reserved. + */ + CacheNodeCount?: Integer; + /** + * The description of the reserved cache node. + */ + ProductDescription?: String; + /** + * The offering type of this reserved cache node. + */ + OfferingType?: String; + /** + * The state of the reserved cache node. + */ + State?: String; + /** + * The recurring price charged to run this reserved cache node. + */ + RecurringCharges?: RecurringChargeList; + /** + * The Amazon Resource Name (ARN) of the reserved cache node. Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582 + */ + ReservationARN?: String; + } + export type ReservedCacheNodeList = ReservedCacheNode[]; + export interface ReservedCacheNodeMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of reserved cache nodes. Each element in the list contains detailed information about one node. + */ + ReservedCacheNodes?: ReservedCacheNodeList; + } + export interface ReservedCacheNodesOffering { + /** + * A unique identifier for the reserved cache node offering. + */ + ReservedCacheNodesOfferingId?: String; + /** + * The cache node type for the reserved cache node. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * The duration of the offering. in seconds. + */ + Duration?: Integer; + /** + * The fixed price charged for this offering. + */ + FixedPrice?: Double; + /** + * The hourly price charged for this offering. + */ + UsagePrice?: Double; + /** + * The cache engine used by the offering. + */ + ProductDescription?: String; + /** + * The offering type. + */ + OfferingType?: String; + /** + * The recurring price charged to run this reserved cache node. + */ + RecurringCharges?: RecurringChargeList; + } + export type ReservedCacheNodesOfferingList = ReservedCacheNodesOffering[]; + export interface ReservedCacheNodesOfferingMessage { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + Marker?: String; + /** + * A list of reserved cache node offerings. Each element in the list contains detailed information about one offering. + */ + ReservedCacheNodesOfferings?: ReservedCacheNodesOfferingList; + } + export interface ResetCacheParameterGroupMessage { + /** + * The name of the cache parameter group to reset. + */ + CacheParameterGroupName: String; + /** + * If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values. Valid values: true | false + */ + ResetAllParameters?: Boolean; + /** + * An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset. + */ + ParameterNameValues?: ParameterNameValueList; + } + export interface ReshardingConfiguration { + /** + * The 4-digit id for the node group these configuration values apply to. + */ + NodeGroupId?: AllowedNodeGroupId; + /** + * A list of preferred availability zones for the nodes in this cluster. + */ + PreferredAvailabilityZones?: AvailabilityZonesList; + } + export type ReshardingConfigurationList = ReshardingConfiguration[]; + export interface ReshardingStatus { + /** + * Represents the progress of an online resharding operation. + */ + SlotMigration?: SlotMigration; + } + export interface RevokeCacheSecurityGroupIngressMessage { + /** + * The name of the cache security group to revoke ingress from. + */ + CacheSecurityGroupName: String; + /** + * The name of the Amazon EC2 security group to revoke access from. + */ + EC2SecurityGroupName: String; + /** + * The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter. + */ + EC2SecurityGroupOwnerId: String; + } + export interface RevokeCacheSecurityGroupIngressResult { + CacheSecurityGroup?: CacheSecurityGroup; + } + export type SecurityGroupIdsList = String[]; + export interface SecurityGroupMembership { + /** + * The identifier of the cache security group. + */ + SecurityGroupId?: String; + /** + * The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified. + */ + Status?: String; + } + export type SecurityGroupMembershipList = SecurityGroupMembership[]; + export interface SlotMigration { + /** + * The percentage of the slot migration that is complete. + */ + ProgressPercentage?: Double; + } + export interface Snapshot { + /** + * The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name. + */ + SnapshotName?: String; + /** + * The unique identifier of the source replication group. + */ + ReplicationGroupId?: String; + /** + * A description of the source replication group. + */ + ReplicationGroupDescription?: String; + /** + * The user-supplied identifier of the source cluster. + */ + CacheClusterId?: String; + /** + * The status of the snapshot. Valid values: creating | available | restoring | copying | deleting. + */ + SnapshotStatus?: String; + /** + * Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual). + */ + SnapshotSource?: String; + /** + * The name of the compute and memory capacity node type for the source cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis + */ + CacheNodeType?: String; + /** + * The name of the cache engine (memcached or redis) used by the source cluster. + */ + Engine?: String; + /** + * The version of the cache engine version that is used by the source cluster. + */ + EngineVersion?: String; + /** + * The number of cache nodes in the source cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. + */ + NumCacheNodes?: IntegerOptional; + /** + * The name of the Availability Zone in which the source cluster is located. + */ + PreferredAvailabilityZone?: String; + /** + * The date and time when the source cluster was created. + */ + CacheClusterCreateTime?: TStamp; + /** + * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30 + */ + PreferredMaintenanceWindow?: String; + /** + * The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications. + */ + TopicArn?: String; + /** + * The port number used by each cache nodes in the source cluster. + */ + Port?: IntegerOptional; + /** + * The cache parameter group that is associated with the source cluster. + */ + CacheParameterGroupName?: String; + /** + * The name of the cache subnet group associated with the source cluster. + */ + CacheSubnetGroupName?: String; + /** + * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster. + */ + VpcId?: String; + /** + * This parameter is currently disabled. + */ + AutoMinorVersionUpgrade?: Boolean; + /** + * For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + */ + SnapshotRetentionLimit?: IntegerOptional; + /** + * The daily time range during which ElastiCache takes daily snapshots of the source cluster. + */ + SnapshotWindow?: String; + /** + * The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same. + */ + NumNodeGroups?: IntegerOptional; + /** + * Indicates the status of Multi-AZ with automatic failover for the source Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types. + */ + AutomaticFailover?: AutomaticFailoverStatus; + /** + * A list of the cache nodes in the source cluster. + */ + NodeSnapshots?: NodeSnapshotList; + } + export type SnapshotArnsList = String[]; + export type SnapshotList = Snapshot[]; + export type SourceType = "cache-cluster"|"cache-parameter-group"|"cache-security-group"|"cache-subnet-group"|"replication-group"|string; + export type String = string; + export interface Subnet { + /** + * The unique identifier for the subnet. + */ + SubnetIdentifier?: String; + /** + * The Availability Zone associated with the subnet. + */ + SubnetAvailabilityZone?: AvailabilityZone; + } + export type SubnetIdentifierList = String[]; + export type SubnetList = Subnet[]; + export type TStamp = Date; + export interface Tag { + /** + * The key for the tag. May not be null. + */ + Key?: String; + /** + * The tag's value. May be null. + */ + Value?: String; + } + export type TagList = Tag[]; + export interface TagListMessage { + /** + * A list of cost allocation tags as key-value pairs. + */ + TagList?: TagList; + } + export interface TestFailoverMessage { + /** + * The name of the replication group (console: cluster) whose automatic failover is being tested by this operation. + */ + ReplicationGroupId: String; + /** + * The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period. + */ + NodeGroupId: AllowedNodeGroupId; + } + export interface TestFailoverResult { + ReplicationGroup?: ReplicationGroup; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-11-15"|"2014-03-24"|"2014-07-15"|"2014-09-30"|"2015-02-02"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ElastiCache client. + */ + export import Types = ElastiCache; +} +export = ElastiCache; diff --git a/node_modules/aws-sdk/clients/elasticache.js b/node_modules/aws-sdk/clients/elasticache.js new file mode 100644 index 0000000..0eca10e --- /dev/null +++ b/node_modules/aws-sdk/clients/elasticache.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['elasticache'] = {}; +AWS.ElastiCache = Service.defineService('elasticache', ['2012-11-15*', '2014-03-24*', '2014-07-15*', '2014-09-30*', '2015-02-02']); +Object.defineProperty(apiLoader.services['elasticache'], '2015-02-02', { + get: function get() { + var model = require('../apis/elasticache-2015-02-02.min.json'); + model.paginators = require('../apis/elasticache-2015-02-02.paginators.json').pagination; + model.waiters = require('../apis/elasticache-2015-02-02.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ElastiCache; diff --git a/node_modules/aws-sdk/clients/elasticbeanstalk.d.ts b/node_modules/aws-sdk/clients/elasticbeanstalk.d.ts new file mode 100644 index 0000000..e931615 --- /dev/null +++ b/node_modules/aws-sdk/clients/elasticbeanstalk.d.ts @@ -0,0 +1,2590 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ElasticBeanstalk extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ElasticBeanstalk.Types.ClientConfiguration) + config: Config & ElasticBeanstalk.Types.ClientConfiguration; + /** + * Cancels in-progress environment configuration update or application version deployment. + */ + abortEnvironmentUpdate(params: ElasticBeanstalk.Types.AbortEnvironmentUpdateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels in-progress environment configuration update or application version deployment. + */ + abortEnvironmentUpdate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions. + */ + applyEnvironmentManagedAction(params: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult) => void): Request; + /** + * Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions. + */ + applyEnvironmentManagedAction(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult) => void): Request; + /** + * Checks if the specified CNAME is available. + */ + checkDNSAvailability(params: ElasticBeanstalk.Types.CheckDNSAvailabilityMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage) => void): Request; + /** + * Checks if the specified CNAME is available. + */ + checkDNSAvailability(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage) => void): Request; + /** + * Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details. + */ + composeEnvironments(params: ElasticBeanstalk.Types.ComposeEnvironmentsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request; + /** + * Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details. + */ + composeEnvironments(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request; + /** + * Creates an application that has one configuration template named default and no application versions. + */ + createApplication(params: ElasticBeanstalk.Types.CreateApplicationMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request; + /** + * Creates an application that has one configuration template named default and no application versions. + */ + createApplication(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request; + /** + * Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows: Specify a commit in an AWS CodeCommit repository with SourceBuildInformation. Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration. Specify a source bundle in S3 with SourceBundle Omit both SourceBuildInformation and SourceBundle to use the default sample application. Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version. + */ + createApplicationVersion(params: ElasticBeanstalk.Types.CreateApplicationVersionMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request; + /** + * Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows: Specify a commit in an AWS CodeCommit repository with SourceBuildInformation. Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration. Specify a source bundle in S3 with SourceBundle Omit both SourceBuildInformation and SourceBundle to use the default sample application. Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version. + */ + createApplicationVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request; + /** + * Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings. Templates aren't associated with any environment. The EnvironmentName response element is always null. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks + */ + createConfigurationTemplate(params: ElasticBeanstalk.Types.CreateConfigurationTemplateMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request; + /** + * Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings. Templates aren't associated with any environment. The EnvironmentName response element is always null. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks + */ + createConfigurationTemplate(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request; + /** + * Launches an environment for the specified application using the specified configuration. + */ + createEnvironment(params: ElasticBeanstalk.Types.CreateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request; + /** + * Launches an environment for the specified application using the specified configuration. + */ + createEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request; + /** + * Create a new version of your custom platform. + */ + createPlatformVersion(params: ElasticBeanstalk.Types.CreatePlatformVersionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.CreatePlatformVersionResult) => void): Request; + /** + * Create a new version of your custom platform. + */ + createPlatformVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CreatePlatformVersionResult) => void): Request; + /** + * Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket. + */ + createStorageLocation(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CreateStorageLocationResultMessage) => void): Request; + /** + * Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment. + */ + deleteApplication(params: ElasticBeanstalk.Types.DeleteApplicationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment. + */ + deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment. + */ + deleteApplicationVersion(params: ElasticBeanstalk.Types.DeleteApplicationVersionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment. + */ + deleteApplicationVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified configuration template. 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. + */ + deleteConfigurationTemplate(params: ElasticBeanstalk.Types.DeleteConfigurationTemplateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified configuration template. 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. + */ + deleteConfigurationTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the draft configuration associated with the running environment. Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus 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. + */ + deleteEnvironmentConfiguration(params: ElasticBeanstalk.Types.DeleteEnvironmentConfigurationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the draft configuration associated with the running environment. Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus 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. + */ + deleteEnvironmentConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified version of a custom platform. + */ + deletePlatformVersion(params: ElasticBeanstalk.Types.DeletePlatformVersionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DeletePlatformVersionResult) => void): Request; + /** + * Deletes the specified version of a custom platform. + */ + deletePlatformVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DeletePlatformVersionResult) => void): Request; + /** + * Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account. The result currently has one set of attributes—resource quotas. + */ + describeAccountAttributes(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeAccountAttributesResult) => void): Request; + /** + * Retrieve a list of application versions. + */ + describeApplicationVersions(params: ElasticBeanstalk.Types.DescribeApplicationVersionsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage) => void): Request; + /** + * Retrieve a list of application versions. + */ + describeApplicationVersions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage) => void): Request; + /** + * Returns the descriptions of existing applications. + */ + describeApplications(params: ElasticBeanstalk.Types.DescribeApplicationsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionsMessage) => void): Request; + /** + * Returns the descriptions of existing applications. + */ + describeApplications(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionsMessage) => void): Request; + /** + * 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. + */ + describeConfigurationOptions(params: ElasticBeanstalk.Types.DescribeConfigurationOptionsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationOptionsDescription) => void): Request; + /** + * 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. + */ + describeConfigurationOptions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationOptionsDescription) => void): Request; + /** + * Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related Topics DeleteEnvironmentConfiguration + */ + describeConfigurationSettings(params: ElasticBeanstalk.Types.DescribeConfigurationSettingsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescriptions) => void): Request; + /** + * Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related Topics DeleteEnvironmentConfiguration + */ + describeConfigurationSettings(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescriptions) => void): Request; + /** + * Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. + */ + describeEnvironmentHealth(params: ElasticBeanstalk.Types.DescribeEnvironmentHealthRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentHealthResult) => void): Request; + /** + * Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. + */ + describeEnvironmentHealth(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentHealthResult) => void): Request; + /** + * Lists an environment's completed and failed managed actions. + */ + describeEnvironmentManagedActionHistory(params: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult) => void): Request; + /** + * Lists an environment's completed and failed managed actions. + */ + describeEnvironmentManagedActionHistory(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult) => void): Request; + /** + * Lists an environment's upcoming and in-progress managed actions. + */ + describeEnvironmentManagedActions(params: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult) => void): Request; + /** + * Lists an environment's upcoming and in-progress managed actions. + */ + describeEnvironmentManagedActions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult) => void): Request; + /** + * Returns AWS resources for this environment. + */ + describeEnvironmentResources(params: ElasticBeanstalk.Types.DescribeEnvironmentResourcesMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage) => void): Request; + /** + * Returns AWS resources for this environment. + */ + describeEnvironmentResources(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage) => void): Request; + /** + * Returns descriptions for existing environments. + */ + describeEnvironments(params: ElasticBeanstalk.Types.DescribeEnvironmentsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request; + /** + * Returns descriptions for existing environments. + */ + describeEnvironments(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request; + /** + * Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken. + */ + describeEvents(params: ElasticBeanstalk.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EventDescriptionsMessage) => void): Request; + /** + * Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken. + */ + describeEvents(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EventDescriptionsMessage) => void): Request; + /** + * Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting. + */ + describeInstancesHealth(params: ElasticBeanstalk.Types.DescribeInstancesHealthRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeInstancesHealthResult) => void): Request; + /** + * Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting. + */ + describeInstancesHealth(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeInstancesHealthResult) => void): Request; + /** + * Describes the version of the platform. + */ + describePlatformVersion(params: ElasticBeanstalk.Types.DescribePlatformVersionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribePlatformVersionResult) => void): Request; + /** + * Describes the version of the platform. + */ + describePlatformVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribePlatformVersionResult) => void): Request; + /** + * Returns a list of the available solution stack names, with the public version first and then in reverse chronological order. + */ + listAvailableSolutionStacks(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListAvailableSolutionStacksResultMessage) => void): Request; + /** + * Lists the available platforms. + */ + listPlatformVersions(params: ElasticBeanstalk.Types.ListPlatformVersionsRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListPlatformVersionsResult) => void): Request; + /** + * Lists the available platforms. + */ + listPlatformVersions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListPlatformVersionsResult) => void): Request; + /** + * Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs. Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment. + */ + listTagsForResource(params: ElasticBeanstalk.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ResourceTagsDescriptionMessage) => void): Request; + /** + * Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs. Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment. + */ + listTagsForResource(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ResourceTagsDescriptionMessage) => void): Request; + /** + * Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. + */ + rebuildEnvironment(params: ElasticBeanstalk.Types.RebuildEnvironmentMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. + */ + rebuildEnvironment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Initiates a request to compile the specified type of information of the deployed environment. Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs. Use RetrieveEnvironmentInfo to obtain the set of logs. Related Topics RetrieveEnvironmentInfo + */ + requestEnvironmentInfo(params: ElasticBeanstalk.Types.RequestEnvironmentInfoMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Initiates a request to compile the specified type of information of the deployed environment. Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs. Use RetrieveEnvironmentInfo to obtain the set of logs. Related Topics RetrieveEnvironmentInfo + */ + requestEnvironmentInfo(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Causes the environment to restart the application container server running on each Amazon EC2 instance. + */ + restartAppServer(params: ElasticBeanstalk.Types.RestartAppServerMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Causes the environment to restart the application container server running on each Amazon EC2 instance. + */ + restartAppServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo + */ + retrieveEnvironmentInfo(params: ElasticBeanstalk.Types.RetrieveEnvironmentInfoMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage) => void): Request; + /** + * Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo + */ + retrieveEnvironmentInfo(callback?: (err: AWSError, data: ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage) => void): Request; + /** + * Swaps the CNAMEs of two environments. + */ + swapEnvironmentCNAMEs(params: ElasticBeanstalk.Types.SwapEnvironmentCNAMEsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Swaps the CNAMEs of two environments. + */ + swapEnvironmentCNAMEs(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Terminates the specified environment. + */ + terminateEnvironment(params: ElasticBeanstalk.Types.TerminateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request; + /** + * Terminates the specified environment. + */ + terminateEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request; + /** + * Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string. + */ + updateApplication(params: ElasticBeanstalk.Types.UpdateApplicationMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request; + /** + * Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string. + */ + updateApplication(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request; + /** + * Modifies lifecycle settings for an application. + */ + updateApplicationResourceLifecycle(params: ElasticBeanstalk.Types.UpdateApplicationResourceLifecycleMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationResourceLifecycleDescriptionMessage) => void): Request; + /** + * Modifies lifecycle settings for an application. + */ + updateApplicationResourceLifecycle(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationResourceLifecycleDescriptionMessage) => void): Request; + /** + * Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string. + */ + updateApplicationVersion(params: ElasticBeanstalk.Types.UpdateApplicationVersionMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request; + /** + * Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string. + */ + updateApplicationVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request; + /** + * Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions + */ + updateConfigurationTemplate(params: ElasticBeanstalk.Types.UpdateConfigurationTemplateMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request; + /** + * Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions + */ + updateConfigurationTemplate(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request; + /** + * Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error. When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values. + */ + updateEnvironment(params: ElasticBeanstalk.Types.UpdateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request; + /** + * Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error. When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values. + */ + updateEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request; + /** + * Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove. Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment. If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name: elasticbeanstalk:AddTags Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter. elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter. For details about creating a custom user policy, see Creating a Custom User Policy. + */ + updateTagsForResource(params: ElasticBeanstalk.Types.UpdateTagsForResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove. Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment. If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name: elasticbeanstalk:AddTags Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter. elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter. For details about creating a custom user policy, see Creating a Custom User Policy. + */ + updateTagsForResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option values. + */ + validateConfigurationSettings(params: ElasticBeanstalk.Types.ValidateConfigurationSettingsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages) => void): Request; + /** + * Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option values. + */ + validateConfigurationSettings(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages) => void): Request; +} +declare namespace ElasticBeanstalk { + export type ARN = string; + export interface AbortEnvironmentUpdateMessage { + /** + * This specifies the ID of the environment with the in-progress update that you want to cancel. + */ + EnvironmentId?: EnvironmentId; + /** + * This specifies the name of the environment with the in-progress update that you want to cancel. + */ + EnvironmentName?: EnvironmentName; + } + export type AbortableOperationInProgress = boolean; + export type ActionHistoryStatus = "Completed"|"Failed"|"Unknown"|string; + export type ActionStatus = "Scheduled"|"Pending"|"Running"|"Unknown"|string; + export type ActionType = "InstanceRefresh"|"PlatformUpdate"|"Unknown"|string; + export type ApplicationArn = string; + export interface ApplicationDescription { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationArn?: ApplicationArn; + /** + * The name of the application. + */ + ApplicationName?: ApplicationName; + /** + * User-defined description of the application. + */ + Description?: Description; + /** + * The date when the application was created. + */ + DateCreated?: CreationDate; + /** + * The date when the application was last modified. + */ + DateUpdated?: UpdateDate; + /** + * The names of the versions for this application. + */ + Versions?: VersionLabelsList; + /** + * The names of the configuration templates associated with this application. + */ + ConfigurationTemplates?: ConfigurationTemplateNamesList; + /** + * The lifecycle settings for the application. + */ + ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig; + } + export type ApplicationDescriptionList = ApplicationDescription[]; + export interface ApplicationDescriptionMessage { + /** + * The ApplicationDescription of the application. + */ + Application?: ApplicationDescription; + } + export interface ApplicationDescriptionsMessage { + /** + * This parameter contains a list of ApplicationDescription. + */ + Applications?: ApplicationDescriptionList; + } + export interface ApplicationMetrics { + /** + * The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration). + */ + Duration?: NullableInteger; + /** + * Average number of requests handled by the web server per second over the last 10 seconds. + */ + RequestCount?: RequestCount; + /** + * Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. + */ + StatusCodes?: StatusCodes; + /** + * Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution. + */ + Latency?: Latency; + } + export type ApplicationName = string; + export type ApplicationNamesList = ApplicationName[]; + export interface ApplicationResourceLifecycleConfig { + /** + * The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value. + */ + ServiceRole?: String; + /** + * The application version lifecycle configuration. + */ + VersionLifecycleConfig?: ApplicationVersionLifecycleConfig; + } + export interface ApplicationResourceLifecycleDescriptionMessage { + /** + * The name of the application. + */ + ApplicationName?: ApplicationName; + /** + * The lifecycle configuration. + */ + ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig; + } + export type ApplicationVersionArn = string; + export interface ApplicationVersionDescription { + /** + * The Amazon Resource Name (ARN) of the application version. + */ + ApplicationVersionArn?: ApplicationVersionArn; + /** + * The name of the application to which the application version belongs. + */ + ApplicationName?: ApplicationName; + /** + * The description of the application version. + */ + Description?: Description; + /** + * A unique identifier for the application version. + */ + VersionLabel?: VersionLabel; + /** + * If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version. + */ + SourceBuildInformation?: SourceBuildInformation; + /** + * Reference to the artifact from the AWS CodeBuild build. + */ + BuildArn?: String; + /** + * The storage location of the application version's source bundle in Amazon S3. + */ + SourceBundle?: S3Location; + /** + * The creation date of the application version. + */ + DateCreated?: CreationDate; + /** + * The last modified date of the application version. + */ + DateUpdated?: UpdateDate; + /** + * The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values. Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment. Processing – Elastic Beanstalk is currently processing the application version. Building – Application version is currently undergoing an AWS CodeBuild build. Processed – Elastic Beanstalk was successfully pre-processed and validated. Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable. + */ + Status?: ApplicationVersionStatus; + } + export type ApplicationVersionDescriptionList = ApplicationVersionDescription[]; + export interface ApplicationVersionDescriptionMessage { + /** + * The ApplicationVersionDescription of the application version. + */ + ApplicationVersion?: ApplicationVersionDescription; + } + export interface ApplicationVersionDescriptionsMessage { + /** + * List of ApplicationVersionDescription objects sorted in order of creation. + */ + ApplicationVersions?: ApplicationVersionDescriptionList; + /** + * In a paginated request, the token that you can pass in a subsequent request to get the next response page. + */ + NextToken?: Token; + } + export interface ApplicationVersionLifecycleConfig { + /** + * Specify a max count rule to restrict the number of application versions that are retained for an application. + */ + MaxCountRule?: MaxCountRule; + /** + * Specify a max age rule to restrict the length of time that application versions are retained for an application. + */ + MaxAgeRule?: MaxAgeRule; + } + export type ApplicationVersionProccess = boolean; + export type ApplicationVersionStatus = "Processed"|"Unprocessed"|"Failed"|"Processing"|"Building"|string; + export interface ApplyEnvironmentManagedActionRequest { + /** + * The name of the target environment. + */ + EnvironmentName?: String; + /** + * The environment ID of the target environment. + */ + EnvironmentId?: String; + /** + * The action ID of the scheduled managed action to execute. + */ + ActionId: String; + } + export interface ApplyEnvironmentManagedActionResult { + /** + * The action ID of the managed action. + */ + ActionId?: String; + /** + * A description of the managed action. + */ + ActionDescription?: String; + /** + * The type of managed action. + */ + ActionType?: ActionType; + /** + * The status of the managed action. + */ + Status?: String; + } + export type AutoCreateApplication = boolean; + export interface AutoScalingGroup { + /** + * The name of the AutoScalingGroup . + */ + Name?: ResourceId; + } + export type AutoScalingGroupList = AutoScalingGroup[]; + export type AvailableSolutionStackDetailsList = SolutionStackDescription[]; + export type AvailableSolutionStackNamesList = SolutionStackName[]; + export type BoxedBoolean = boolean; + export type BoxedInt = number; + export interface BuildConfiguration { + /** + * The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip. + */ + ArtifactName?: String; + /** + * The Amazon Resource Name (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. + */ + CodeBuildServiceRole: NonEmptyString; + /** + * Information about the compute resources the build project will use. BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds + */ + ComputeType?: ComputeType; + /** + * The ID of the Docker image to use for this build project. + */ + Image: NonEmptyString; + /** + * 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. + */ + TimeoutInMinutes?: BoxedInt; + } + export interface Builder { + /** + * The ARN of the builder. + */ + ARN?: ARN; + } + export interface CPUUtilization { + /** + * Percentage of time that the CPU has spent in the User state over the last 10 seconds. + */ + User?: NullableDouble; + /** + * Available on Linux environments only. Percentage of time that the CPU has spent in the Nice state over the last 10 seconds. + */ + Nice?: NullableDouble; + /** + * Available on Linux environments only. Percentage of time that the CPU has spent in the System state over the last 10 seconds. + */ + System?: NullableDouble; + /** + * Percentage of time that the CPU has spent in the Idle state over the last 10 seconds. + */ + Idle?: NullableDouble; + /** + * Available on Linux environments only. Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds. + */ + IOWait?: NullableDouble; + /** + * Available on Linux environments only. Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds. + */ + IRQ?: NullableDouble; + /** + * Available on Linux environments only. Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds. + */ + SoftIRQ?: NullableDouble; + /** + * Available on Windows environments only. Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds. + */ + Privileged?: NullableDouble; + } + export type Cause = string; + export type Causes = Cause[]; + export interface CheckDNSAvailabilityMessage { + /** + * The prefix used when this CNAME is reserved. + */ + CNAMEPrefix: DNSCnamePrefix; + } + export interface CheckDNSAvailabilityResultMessage { + /** + * Indicates if the specified CNAME is available: true : The CNAME is available. false : The CNAME is not available. + */ + Available?: CnameAvailability; + /** + * The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix. + */ + FullyQualifiedCNAME?: DNSCname; + } + export type CnameAvailability = boolean; + export interface ComposeEnvironmentsMessage { + /** + * The name of the application to which the specified source bundles belong. + */ + ApplicationName?: ApplicationName; + /** + * The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details. + */ + GroupName?: GroupName; + /** + * A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create. + */ + VersionLabels?: VersionLabels; + } + export type ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|string; + export type ConfigurationDeploymentStatus = "deployed"|"pending"|"failed"|string; + export type ConfigurationOptionDefaultValue = string; + export interface ConfigurationOptionDescription { + /** + * A unique namespace identifying the option's associated AWS resource. + */ + Namespace?: OptionNamespace; + /** + * The name of the configuration option. + */ + Name?: ConfigurationOptionName; + /** + * The default value for this configuration option. + */ + DefaultValue?: ConfigurationOptionDefaultValue; + /** + * An indication of which action is required if the value for this configuration option changes: NoInterruption : There is no interruption to the environment or application availability. RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process. RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted. + */ + ChangeSeverity?: ConfigurationOptionSeverity; + /** + * An indication of whether the user defined this configuration option: true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings. false : This configuration was not defined by the user. Constraint: You can remove only UserDefined options from a configuration. Valid Values: true | false + */ + UserDefined?: UserDefinedOption; + /** + * An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values: Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints. List : Values for this option are multiple selections from the possible values. Boolean : Values for this option are either true or false . Json : Values for this option are a JSON representation of a ConfigDocument. + */ + ValueType?: ConfigurationOptionValueType; + /** + * If specified, values for the configuration option are selected from this list. + */ + ValueOptions?: ConfigurationOptionPossibleValues; + /** + * If specified, the configuration option must be a numeric value greater than this value. + */ + MinValue?: OptionRestrictionMinValue; + /** + * If specified, the configuration option must be a numeric value less than this value. + */ + MaxValue?: OptionRestrictionMaxValue; + /** + * If specified, the configuration option must be a string value no longer than this value. + */ + MaxLength?: OptionRestrictionMaxLength; + /** + * If specified, the configuration option must be a string value that satisfies this regular expression. + */ + Regex?: OptionRestrictionRegex; + } + export type ConfigurationOptionDescriptionsList = ConfigurationOptionDescription[]; + export type ConfigurationOptionName = string; + export type ConfigurationOptionPossibleValue = string; + export type ConfigurationOptionPossibleValues = ConfigurationOptionPossibleValue[]; + export interface ConfigurationOptionSetting { + /** + * A unique resource name for a time-based scaling configuration option. + */ + ResourceName?: ResourceName; + /** + * A unique namespace identifying the option's associated AWS resource. + */ + Namespace?: OptionNamespace; + /** + * The name of the configuration option. + */ + OptionName?: ConfigurationOptionName; + /** + * The current value for the configuration option. + */ + Value?: ConfigurationOptionValue; + } + export type ConfigurationOptionSettingsList = ConfigurationOptionSetting[]; + export type ConfigurationOptionSeverity = string; + export type ConfigurationOptionValue = string; + export type ConfigurationOptionValueType = "Scalar"|"List"|string; + export interface ConfigurationOptionsDescription { + /** + * The name of the solution stack these configuration options belong to. + */ + SolutionStackName?: SolutionStackName; + /** + * The ARN of the platform. + */ + PlatformArn?: PlatformArn; + /** + * A list of ConfigurationOptionDescription. + */ + Options?: ConfigurationOptionDescriptionsList; + } + export interface ConfigurationSettingsDescription { + /** + * The name of the solution stack this configuration set uses. + */ + SolutionStackName?: SolutionStackName; + /** + * The ARN of the platform. + */ + PlatformArn?: PlatformArn; + /** + * The name of the application associated with this configuration set. + */ + ApplicationName?: ApplicationName; + /** + * If not null, the name of the configuration template for this configuration set. + */ + TemplateName?: ConfigurationTemplateName; + /** + * Describes this configuration set. + */ + Description?: Description; + /** + * If not null, the name of the environment for this configuration set. + */ + EnvironmentName?: EnvironmentName; + /** + * If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set: null: This configuration is not associated with a running environment. pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. deployed: This is the configuration that is currently deployed to the associated running environment. failed: This is a draft configuration that failed to successfully deploy. + */ + DeploymentStatus?: ConfigurationDeploymentStatus; + /** + * The date (in UTC time) when this configuration set was created. + */ + DateCreated?: CreationDate; + /** + * The date (in UTC time) when this configuration set was last modified. + */ + DateUpdated?: UpdateDate; + /** + * A list of the configuration options and their values in this configuration set. + */ + OptionSettings?: ConfigurationOptionSettingsList; + } + export type ConfigurationSettingsDescriptionList = ConfigurationSettingsDescription[]; + export interface ConfigurationSettingsDescriptions { + /** + * A list of ConfigurationSettingsDescription. + */ + ConfigurationSettings?: ConfigurationSettingsDescriptionList; + } + export interface ConfigurationSettingsValidationMessages { + /** + * A list of ValidationMessage. + */ + Messages?: ValidationMessagesList; + } + export type ConfigurationTemplateName = string; + export type ConfigurationTemplateNamesList = ConfigurationTemplateName[]; + export interface CreateApplicationMessage { + /** + * The name of the application. Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error. + */ + ApplicationName: ApplicationName; + /** + * Describes the application. + */ + Description?: Description; + /** + * Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions. + */ + ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig; + /** + * Specifies the tags applied to the application. Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags. + */ + Tags?: Tags; + } + export interface CreateApplicationVersionMessage { + /** + * The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error. + */ + ApplicationName: ApplicationName; + /** + * A label identifying this version. Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error. + */ + VersionLabel: VersionLabel; + /** + * Describes this version. + */ + Description?: Description; + /** + * Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version. + */ + SourceBuildInformation?: SourceBuildInformation; + /** + * The Amazon S3 bucket and key that identify the location of the source bundle for this version. The Amazon S3 bucket must be in the same region as the environment. Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application. + */ + SourceBundle?: S3Location; + /** + * Settings for an AWS CodeBuild build. + */ + BuildConfiguration?: BuildConfiguration; + /** + * Set to true to create an application with the specified name if it doesn't already exist. + */ + AutoCreateApplication?: AutoCreateApplication; + /** + * Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment. You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional. The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration. + */ + Process?: ApplicationVersionProccess; + /** + * Specifies the tags applied to the application version. Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags. + */ + Tags?: Tags; + } + export interface CreateConfigurationTemplateMessage { + /** + * The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. + */ + ApplicationName: ApplicationName; + /** + * The name of the configuration template. Constraint: This name must be unique per application. Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. + */ + TemplateName: ConfigurationTemplateName; + /** + * The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values. Use ListAvailableSolutionStacks to obtain a list of available solution stacks. A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error. If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template. + */ + SolutionStackName?: SolutionStackName; + /** + * The ARN of the custom platform. + */ + PlatformArn?: PlatformArn; + /** + * If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration. If no configuration template is found, returns an InvalidParameterValue error. Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error. + */ + SourceConfiguration?: SourceConfiguration; + /** + * The ID of the environment used with this configuration template. + */ + EnvironmentId?: EnvironmentId; + /** + * Describes this configuration. + */ + Description?: Description; + /** + * If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template. + */ + OptionSettings?: ConfigurationOptionSettingsList; + /** + * Specifies the tags applied to the configuration template. + */ + Tags?: Tags; + } + export interface CreateEnvironmentMessage { + /** + * The name of the application that contains the version to be deployed. If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error. + */ + ApplicationName: ApplicationName; + /** + * A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application. + */ + EnvironmentName?: EnvironmentName; + /** + * The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details. + */ + GroupName?: GroupName; + /** + * Describes this environment. + */ + Description?: Description; + /** + * If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name. + */ + CNAMEPrefix?: DNSCnamePrefix; + /** + * This specifies the tier to use for creating this environment. + */ + Tier?: EnvironmentTier; + /** + * Specifies the tags applied to resources in the environment. + */ + Tags?: Tags; + /** + * The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container. + */ + VersionLabel?: VersionLabel; + /** + * The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. + */ + TemplateName?: ConfigurationTemplateName; + /** + * This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms. + */ + SolutionStackName?: SolutionStackName; + /** + * The ARN of the platform. + */ + PlatformArn?: PlatformArn; + /** + * If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template. + */ + OptionSettings?: ConfigurationOptionSettingsList; + /** + * A list of custom user-defined configuration options to remove from the configuration set for this new environment. + */ + OptionsToRemove?: OptionsSpecifierList; + } + export interface CreatePlatformVersionRequest { + /** + * The name of your custom platform. + */ + PlatformName: PlatformName; + /** + * The number, such as 1.0.2, for the new platform version. + */ + PlatformVersion: PlatformVersion; + /** + * The location of the platform definition archive in Amazon S3. + */ + PlatformDefinitionBundle: S3Location; + /** + * The name of the builder environment. + */ + EnvironmentName?: EnvironmentName; + /** + * The configuration option settings to apply to the builder environment. + */ + OptionSettings?: ConfigurationOptionSettingsList; + /** + * Specifies the tags applied to the new platform version. Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags. + */ + Tags?: Tags; + } + export interface CreatePlatformVersionResult { + /** + * Detailed information about the new version of the custom platform. + */ + PlatformSummary?: PlatformSummary; + /** + * The builder used to create the custom platform. + */ + Builder?: Builder; + } + export interface CreateStorageLocationResultMessage { + /** + * The name of the Amazon S3 bucket created. + */ + S3Bucket?: S3Bucket; + } + export type CreationDate = Date; + export interface CustomAmi { + /** + * The type of virtualization used to create the custom AMI. + */ + VirtualizationType?: VirtualizationType; + /** + * THe ID of the image used to create the custom AMI. + */ + ImageId?: ImageId; + } + export type CustomAmiList = CustomAmi[]; + export type DNSCname = string; + export type DNSCnamePrefix = string; + export interface DeleteApplicationMessage { + /** + * The name of the application to delete. + */ + ApplicationName: ApplicationName; + /** + * When set to true, running environments will be terminated before deleting the application. + */ + TerminateEnvByForce?: TerminateEnvForce; + } + export interface DeleteApplicationVersionMessage { + /** + * The name of the application to which the version belongs. + */ + ApplicationName: ApplicationName; + /** + * The label of the version to delete. + */ + VersionLabel: VersionLabel; + /** + * Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3. + */ + DeleteSourceBundle?: DeleteSourceBundle; + } + export interface DeleteConfigurationTemplateMessage { + /** + * The name of the application to delete the configuration template from. + */ + ApplicationName: ApplicationName; + /** + * The name of the configuration template to delete. + */ + TemplateName: ConfigurationTemplateName; + } + export interface DeleteEnvironmentConfigurationMessage { + /** + * The name of the application the environment is associated with. + */ + ApplicationName: ApplicationName; + /** + * The name of the environment to delete the draft configuration from. + */ + EnvironmentName: EnvironmentName; + } + export interface DeletePlatformVersionRequest { + /** + * The ARN of the version of the custom platform. + */ + PlatformArn?: PlatformArn; + } + export interface DeletePlatformVersionResult { + /** + * Detailed information about the version of the custom platform. + */ + PlatformSummary?: PlatformSummary; + } + export type DeleteSourceBundle = boolean; + export interface Deployment { + /** + * The version label of the application version in the deployment. + */ + VersionLabel?: String; + /** + * The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings. + */ + DeploymentId?: NullableLong; + /** + * The status of the deployment: In Progress : The deployment is in progress. Deployed : The deployment succeeded. Failed : The deployment failed. + */ + Status?: String; + /** + * For in-progress deployments, the time that the deployment started. For completed deployments, the time that the deployment ended. + */ + DeploymentTime?: DeploymentTimestamp; + } + export type DeploymentTimestamp = Date; + export interface DescribeAccountAttributesResult { + /** + * The Elastic Beanstalk resource quotas associated with the calling AWS account. + */ + ResourceQuotas?: ResourceQuotas; + } + export interface DescribeApplicationVersionsMessage { + /** + * Specify an application name to show only application versions for that application. + */ + ApplicationName?: ApplicationName; + /** + * Specify a version label to show a specific application version. + */ + VersionLabels?: VersionLabelsList; + /** + * For a paginated request. Specify a maximum number of application versions to include in each response. If no MaxRecords is specified, all available application versions are retrieved in a single response. + */ + MaxRecords?: MaxRecords; + /** + * For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no NextToken is specified, the first page is retrieved. + */ + NextToken?: Token; + } + export interface DescribeApplicationsMessage { + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. + */ + ApplicationNames?: ApplicationNamesList; + } + export interface DescribeConfigurationOptionsMessage { + /** + * The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment. + */ + ApplicationName?: ApplicationName; + /** + * The name of the configuration template whose configuration options you want to describe. + */ + TemplateName?: ConfigurationTemplateName; + /** + * The name of the environment whose configuration options you want to describe. + */ + EnvironmentName?: EnvironmentName; + /** + * The name of the solution stack whose configuration options you want to describe. + */ + SolutionStackName?: SolutionStackName; + /** + * The ARN of the custom platform. + */ + PlatformArn?: PlatformArn; + /** + * If specified, restricts the descriptions to only the specified options. + */ + Options?: OptionsSpecifierList; + } + export interface DescribeConfigurationSettingsMessage { + /** + * The application for the environment or configuration template. + */ + ApplicationName: ApplicationName; + /** + * The name of the configuration template to describe. Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error. + */ + TemplateName?: ConfigurationTemplateName; + /** + * The name of the environment to describe. Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + } + export interface DescribeEnvironmentHealthRequest { + /** + * Specify the environment by name. You must specify either this or an EnvironmentName, or both. + */ + EnvironmentName?: EnvironmentName; + /** + * Specify the environment by ID. You must specify either this or an EnvironmentName, or both. + */ + EnvironmentId?: EnvironmentId; + /** + * Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment. + */ + AttributeNames?: EnvironmentHealthAttributes; + } + export interface DescribeEnvironmentHealthResult { + /** + * The environment's name. + */ + EnvironmentName?: EnvironmentName; + /** + * The health status of the environment. For example, Ok. + */ + HealthStatus?: String; + /** + * The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated. + */ + Status?: EnvironmentHealth; + /** + * The health color of the environment. + */ + Color?: String; + /** + * Descriptions of the data that contributed to the environment's current health status. + */ + Causes?: Causes; + /** + * Application request metrics for the environment. + */ + ApplicationMetrics?: ApplicationMetrics; + /** + * Summary health information for the instances in the environment. + */ + InstancesHealth?: InstanceHealthSummary; + /** + * The date and time that the health information was retrieved. + */ + RefreshedAt?: RefreshedAt; + } + export interface DescribeEnvironmentManagedActionHistoryRequest { + /** + * The environment ID of the target environment. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the target environment. + */ + EnvironmentName?: EnvironmentName; + /** + * The pagination token returned by a previous request. + */ + NextToken?: String; + /** + * The maximum number of items to return for a single request. + */ + MaxItems?: Integer; + } + export interface DescribeEnvironmentManagedActionHistoryResult { + /** + * A list of completed and failed managed actions. + */ + ManagedActionHistoryItems?: ManagedActionHistoryItems; + /** + * A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results. + */ + NextToken?: String; + } + export interface DescribeEnvironmentManagedActionsRequest { + /** + * The name of the target environment. + */ + EnvironmentName?: String; + /** + * The environment ID of the target environment. + */ + EnvironmentId?: String; + /** + * To show only actions with a particular status, specify a status. + */ + Status?: ActionStatus; + } + export interface DescribeEnvironmentManagedActionsResult { + /** + * A list of upcoming and in-progress managed actions. + */ + ManagedActions?: ManagedActions; + } + export interface DescribeEnvironmentResourcesMessage { + /** + * The ID of the environment to retrieve AWS resource usage data. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the environment to retrieve AWS resource usage data. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + } + export interface DescribeEnvironmentsMessage { + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application. + */ + ApplicationName?: ApplicationName; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version. + */ + VersionLabel?: VersionLabel; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs. + */ + EnvironmentIds?: EnvironmentIdList; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names. + */ + EnvironmentNames?: EnvironmentNamesList; + /** + * Indicates whether to include deleted environments: true: Environments that have been deleted after IncludedDeletedBackTo are displayed. false: Do not include deleted environments. + */ + IncludeDeleted?: IncludeDeleted; + /** + * If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed. + */ + IncludedDeletedBackTo?: IncludeDeletedBackTo; + /** + * For a paginated request. Specify a maximum number of environments to include in each response. If no MaxRecords is specified, all available environments are retrieved in a single response. + */ + MaxRecords?: MaxRecords; + /** + * For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no NextToken is specified, the first page is retrieved. + */ + NextToken?: Token; + } + export interface DescribeEventsMessage { + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application. + */ + ApplicationName?: ApplicationName; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version. + */ + VersionLabel?: VersionLabel; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration. + */ + TemplateName?: ConfigurationTemplateName; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. + */ + EnvironmentId?: EnvironmentId; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. + */ + EnvironmentName?: EnvironmentName; + /** + * The ARN of the version of the custom platform. + */ + PlatformArn?: PlatformArn; + /** + * If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. + */ + RequestId?: RequestId; + /** + * If specified, limits the events returned from this call to include only those with the specified severity or higher. + */ + Severity?: EventSeverity; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. + */ + StartTime?: TimeFilterStart; + /** + * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime. + */ + EndTime?: TimeFilterEnd; + /** + * Specifies the maximum number of events that can be returned, beginning with the most recent event. + */ + MaxRecords?: MaxRecords; + /** + * Pagination token. If specified, the events return the next batch of results. + */ + NextToken?: Token; + } + export interface DescribeInstancesHealthRequest { + /** + * Specify the AWS Elastic Beanstalk environment by name. + */ + EnvironmentName?: EnvironmentName; + /** + * Specify the AWS Elastic Beanstalk environment by ID. + */ + EnvironmentId?: EnvironmentId; + /** + * Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances. + */ + AttributeNames?: InstancesHealthAttributes; + /** + * Specify the pagination token returned by a previous call. + */ + NextToken?: NextToken; + } + export interface DescribeInstancesHealthResult { + /** + * Detailed health information about each instance. The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type. + */ + InstanceHealthList?: InstanceHealthList; + /** + * The date and time that the health information was retrieved. + */ + RefreshedAt?: RefreshedAt; + /** + * Pagination token for the next page of results, if available. + */ + NextToken?: NextToken; + } + export interface DescribePlatformVersionRequest { + /** + * The ARN of the version of the platform. + */ + PlatformArn?: PlatformArn; + } + export interface DescribePlatformVersionResult { + /** + * Detailed information about the version of the platform. + */ + PlatformDescription?: PlatformDescription; + } + export type Description = string; + export type Ec2InstanceId = string; + export type EndpointURL = string; + export type EnvironmentArn = string; + export interface EnvironmentDescription { + /** + * The name of this environment. + */ + EnvironmentName?: EnvironmentName; + /** + * The ID of this environment. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the application associated with this environment. + */ + ApplicationName?: ApplicationName; + /** + * The application version deployed in this environment. + */ + VersionLabel?: VersionLabel; + /** + * The name of the SolutionStack deployed with this environment. + */ + SolutionStackName?: SolutionStackName; + /** + * The ARN of the platform. + */ + PlatformArn?: PlatformArn; + /** + * The name of the configuration template used to originally launch this environment. + */ + TemplateName?: ConfigurationTemplateName; + /** + * Describes this environment. + */ + Description?: Description; + /** + * For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. + */ + EndpointURL?: EndpointURL; + /** + * The URL to the CNAME for this environment. + */ + CNAME?: DNSCname; + /** + * The creation date for this environment. + */ + DateCreated?: CreationDate; + /** + * The last modified date for this environment. + */ + DateUpdated?: UpdateDate; + /** + * The current operational status of the environment: Launching: Environment is in the process of initial deployment. Updating: Environment is in the process of updating its configuration settings or application version. Ready: Environment is available to have an action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process. Terminated: Environment is not running. + */ + Status?: EnvironmentStatus; + /** + * Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress. + */ + AbortableOperationInProgress?: AbortableOperationInProgress; + /** + * Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and fully functional. Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request. Default: Grey + */ + Health?: EnvironmentHealth; + /** + * Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses. + */ + HealthStatus?: EnvironmentHealthStatus; + /** + * The description of the AWS resources used by this environment. + */ + Resources?: EnvironmentResourcesDescription; + /** + * Describes the current tier of this environment. + */ + Tier?: EnvironmentTier; + /** + * A list of links to other environments in the same group. + */ + EnvironmentLinks?: EnvironmentLinks; + /** + * The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN. + */ + EnvironmentArn?: EnvironmentArn; + } + export type EnvironmentDescriptionsList = EnvironmentDescription[]; + export interface EnvironmentDescriptionsMessage { + /** + * Returns an EnvironmentDescription list. + */ + Environments?: EnvironmentDescriptionsList; + /** + * In a paginated request, the token that you can pass in a subsequent request to get the next response page. + */ + NextToken?: Token; + } + export type EnvironmentHealth = "Green"|"Yellow"|"Red"|"Grey"|string; + export type EnvironmentHealthAttribute = "Status"|"Color"|"Causes"|"ApplicationMetrics"|"InstancesHealth"|"All"|"HealthStatus"|"RefreshedAt"|string; + export type EnvironmentHealthAttributes = EnvironmentHealthAttribute[]; + export type EnvironmentHealthStatus = "NoData"|"Unknown"|"Pending"|"Ok"|"Info"|"Warning"|"Degraded"|"Severe"|"Suspended"|string; + export type EnvironmentId = string; + export type EnvironmentIdList = EnvironmentId[]; + export interface EnvironmentInfoDescription { + /** + * The type of information retrieved. + */ + InfoType?: EnvironmentInfoType; + /** + * The Amazon EC2 Instance ID for this information. + */ + Ec2InstanceId?: Ec2InstanceId; + /** + * The time stamp when this information was retrieved. + */ + SampleTimestamp?: SampleTimestamp; + /** + * The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes. Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties. + */ + Message?: Message; + } + export type EnvironmentInfoDescriptionList = EnvironmentInfoDescription[]; + export type EnvironmentInfoType = "tail"|"bundle"|string; + export interface EnvironmentLink { + /** + * The name of the link. + */ + LinkName?: String; + /** + * The name of the linked environment (the dependency). + */ + EnvironmentName?: String; + } + export type EnvironmentLinks = EnvironmentLink[]; + export type EnvironmentName = string; + export type EnvironmentNamesList = EnvironmentName[]; + export interface EnvironmentResourceDescription { + /** + * The name of the environment. + */ + EnvironmentName?: EnvironmentName; + /** + * The AutoScalingGroups used by this environment. + */ + AutoScalingGroups?: AutoScalingGroupList; + /** + * The Amazon EC2 instances used by this environment. + */ + Instances?: InstanceList; + /** + * The Auto Scaling launch configurations in use by this environment. + */ + LaunchConfigurations?: LaunchConfigurationList; + /** + * The Amazon EC2 launch templates in use by this environment. + */ + LaunchTemplates?: LaunchTemplateList; + /** + * The LoadBalancers in use by this environment. + */ + LoadBalancers?: LoadBalancerList; + /** + * The AutoScaling triggers in use by this environment. + */ + Triggers?: TriggerList; + /** + * The queues used by this environment. + */ + Queues?: QueueList; + } + export interface EnvironmentResourceDescriptionsMessage { + /** + * A list of EnvironmentResourceDescription. + */ + EnvironmentResources?: EnvironmentResourceDescription; + } + export interface EnvironmentResourcesDescription { + /** + * Describes the LoadBalancer. + */ + LoadBalancer?: LoadBalancerDescription; + } + export type EnvironmentStatus = "Launching"|"Updating"|"Ready"|"Terminating"|"Terminated"|string; + export interface EnvironmentTier { + /** + * The name of this environment tier. Valid values: For Web server tier – WebServer For Worker tier – Worker + */ + Name?: String; + /** + * The type of this environment tier. Valid values: For Web server tier – Standard For Worker tier – SQS/HTTP + */ + Type?: String; + /** + * The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified. + */ + Version?: String; + } + export type EventDate = Date; + export interface EventDescription { + /** + * The date when the event occurred. + */ + EventDate?: EventDate; + /** + * The event message. + */ + Message?: EventMessage; + /** + * The application associated with the event. + */ + ApplicationName?: ApplicationName; + /** + * The release label for the application version associated with this event. + */ + VersionLabel?: VersionLabel; + /** + * The name of the configuration associated with this event. + */ + TemplateName?: ConfigurationTemplateName; + /** + * The name of the environment associated with this event. + */ + EnvironmentName?: EnvironmentName; + /** + * The ARN of the platform. + */ + PlatformArn?: PlatformArn; + /** + * The web service request ID for the activity of this event. + */ + RequestId?: RequestId; + /** + * The severity level of this event. + */ + Severity?: EventSeverity; + } + export type EventDescriptionList = EventDescription[]; + export interface EventDescriptionsMessage { + /** + * A list of EventDescription. + */ + Events?: EventDescriptionList; + /** + * If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events. + */ + NextToken?: Token; + } + export type EventMessage = string; + export type EventSeverity = "TRACE"|"DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL"|string; + export type FailureType = "UpdateCancelled"|"CancellationFailed"|"RollbackFailed"|"RollbackSuccessful"|"InternalFailure"|"InvalidEnvironmentState"|"PermissionsError"|string; + export type FileTypeExtension = string; + export type ForceTerminate = boolean; + export type GroupName = string; + export type ImageId = string; + export type IncludeDeleted = boolean; + export type IncludeDeletedBackTo = Date; + export interface Instance { + /** + * The ID of the Amazon EC2 instance. + */ + Id?: ResourceId; + } + export type InstanceHealthList = SingleInstanceHealth[]; + export interface InstanceHealthSummary { + /** + * Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance. + */ + NoData?: NullableInteger; + /** + * Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance. + */ + Unknown?: NullableInteger; + /** + * Grey. An operation is in progress on an instance within the command timeout. + */ + Pending?: NullableInteger; + /** + * Green. An instance is passing health checks and the health agent is not reporting any problems. + */ + Ok?: NullableInteger; + /** + * Green. An operation is in progress on an instance. + */ + Info?: NullableInteger; + /** + * Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment. + */ + Warning?: NullableInteger; + /** + * Red. The health agent is reporting a high number of request failures or other issues for an instance or environment. + */ + Degraded?: NullableInteger; + /** + * Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment. + */ + Severe?: NullableInteger; + } + export type InstanceId = string; + export type InstanceList = Instance[]; + export type InstancesHealthAttribute = "HealthStatus"|"Color"|"Causes"|"ApplicationMetrics"|"RefreshedAt"|"LaunchedAt"|"System"|"Deployment"|"AvailabilityZone"|"InstanceType"|"All"|string; + export type InstancesHealthAttributes = InstancesHealthAttribute[]; + export type Integer = number; + export interface Latency { + /** + * The average latency for the slowest 0.1 percent of requests over the last 10 seconds. + */ + P999?: NullableDouble; + /** + * The average latency for the slowest 1 percent of requests over the last 10 seconds. + */ + P99?: NullableDouble; + /** + * The average latency for the slowest 5 percent of requests over the last 10 seconds. + */ + P95?: NullableDouble; + /** + * The average latency for the slowest 10 percent of requests over the last 10 seconds. + */ + P90?: NullableDouble; + /** + * The average latency for the slowest 15 percent of requests over the last 10 seconds. + */ + P85?: NullableDouble; + /** + * The average latency for the slowest 25 percent of requests over the last 10 seconds. + */ + P75?: NullableDouble; + /** + * The average latency for the slowest 50 percent of requests over the last 10 seconds. + */ + P50?: NullableDouble; + /** + * The average latency for the slowest 90 percent of requests over the last 10 seconds. + */ + P10?: NullableDouble; + } + export interface LaunchConfiguration { + /** + * The name of the launch configuration. + */ + Name?: ResourceId; + } + export type LaunchConfigurationList = LaunchConfiguration[]; + export interface LaunchTemplate { + /** + * The ID of the launch template. + */ + Id?: ResourceId; + } + export type LaunchTemplateList = LaunchTemplate[]; + export type LaunchedAt = Date; + export interface ListAvailableSolutionStacksResultMessage { + /** + * A list of available solution stacks. + */ + SolutionStacks?: AvailableSolutionStackNamesList; + /** + * A list of available solution stacks and their SolutionStackDescription. + */ + SolutionStackDetails?: AvailableSolutionStackDetailsList; + } + export interface ListPlatformVersionsRequest { + /** + * List only the platforms where the platform member value relates to one of the supplied values. + */ + Filters?: PlatformFilters; + /** + * The maximum number of platform values returned in one call. + */ + MaxRecords?: PlatformMaxRecords; + /** + * The starting index into the remaining list of platforms. Use the NextToken value from a previous ListPlatformVersion call. + */ + NextToken?: Token; + } + export interface ListPlatformVersionsResult { + /** + * Detailed information about the platforms. + */ + PlatformSummaryList?: PlatformSummaryList; + /** + * The starting index into the remaining list of platforms. if this value is not null, you can use it in a subsequent ListPlatformVersion call. + */ + NextToken?: Token; + } + export interface ListTagsForResourceMessage { + /** + * The Amazon Resource Name (ARN) of the resouce for which a tag list is requested. Must be the ARN of an Elastic Beanstalk environment. + */ + ResourceArn: ResourceArn; + } + export interface Listener { + /** + * The protocol that is used by the Listener. + */ + Protocol?: String; + /** + * The port that is used by the Listener. + */ + Port?: Integer; + } + export type LoadAverage = LoadAverageValue[]; + export type LoadAverageValue = number; + export interface LoadBalancer { + /** + * The name of the LoadBalancer. + */ + Name?: ResourceId; + } + export interface LoadBalancerDescription { + /** + * The name of the LoadBalancer. + */ + LoadBalancerName?: String; + /** + * The domain name of the LoadBalancer. + */ + Domain?: String; + /** + * A list of Listeners used by the LoadBalancer. + */ + Listeners?: LoadBalancerListenersDescription; + } + export type LoadBalancerList = LoadBalancer[]; + export type LoadBalancerListenersDescription = Listener[]; + export type Maintainer = string; + export interface ManagedAction { + /** + * A unique identifier for the managed action. + */ + ActionId?: String; + /** + * A description of the managed action. + */ + ActionDescription?: String; + /** + * The type of managed action. + */ + ActionType?: ActionType; + /** + * The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction. + */ + Status?: ActionStatus; + /** + * The start time of the maintenance window in which the managed action will execute. + */ + WindowStartTime?: Timestamp; + } + export interface ManagedActionHistoryItem { + /** + * A unique identifier for the managed action. + */ + ActionId?: String; + /** + * The type of the managed action. + */ + ActionType?: ActionType; + /** + * A description of the managed action. + */ + ActionDescription?: String; + /** + * If the action failed, the type of failure. + */ + FailureType?: FailureType; + /** + * The status of the action. + */ + Status?: ActionHistoryStatus; + /** + * If the action failed, a description of the failure. + */ + FailureDescription?: String; + /** + * The date and time that the action started executing. + */ + ExecutedTime?: Timestamp; + /** + * The date and time that the action finished executing. + */ + FinishedTime?: Timestamp; + } + export type ManagedActionHistoryItems = ManagedActionHistoryItem[]; + export type ManagedActions = ManagedAction[]; + export interface MaxAgeRule { + /** + * Specify true to apply the rule, or false to disable it. + */ + Enabled: BoxedBoolean; + /** + * Specify the number of days to retain an application versions. + */ + MaxAgeInDays?: BoxedInt; + /** + * Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. + */ + DeleteSourceFromS3?: BoxedBoolean; + } + export interface MaxCountRule { + /** + * Specify true to apply the rule, or false to disable it. + */ + Enabled: BoxedBoolean; + /** + * Specify the maximum number of application versions to retain. + */ + MaxCount?: BoxedInt; + /** + * Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. + */ + DeleteSourceFromS3?: BoxedBoolean; + } + export type MaxRecords = number; + export type Message = string; + export type NextToken = string; + export type NonEmptyString = string; + export type NullableDouble = number; + export type NullableInteger = number; + export type NullableLong = number; + export type OperatingSystemName = string; + export type OperatingSystemVersion = string; + export type OptionNamespace = string; + export type OptionRestrictionMaxLength = number; + export type OptionRestrictionMaxValue = number; + export type OptionRestrictionMinValue = number; + export interface OptionRestrictionRegex { + /** + * The regular expression pattern that a string configuration option value with this restriction must match. + */ + Pattern?: RegexPattern; + /** + * A unique name representing this regular expression. + */ + Label?: RegexLabel; + } + export interface OptionSpecification { + /** + * A unique resource name for a time-based scaling configuration option. + */ + ResourceName?: ResourceName; + /** + * A unique namespace identifying the option's associated AWS resource. + */ + Namespace?: OptionNamespace; + /** + * The name of the configuration option. + */ + OptionName?: ConfigurationOptionName; + } + export type OptionsSpecifierList = OptionSpecification[]; + export type PlatformArn = string; + export type PlatformCategory = string; + export interface PlatformDescription { + /** + * The ARN of the platform. + */ + PlatformArn?: PlatformArn; + /** + * The AWS account ID of the person who created the platform. + */ + PlatformOwner?: PlatformOwner; + /** + * The name of the platform. + */ + PlatformName?: PlatformName; + /** + * The version of the platform. + */ + PlatformVersion?: PlatformVersion; + /** + * The name of the solution stack used by the platform. + */ + SolutionStackName?: SolutionStackName; + /** + * The status of the platform. + */ + PlatformStatus?: PlatformStatus; + /** + * The date when the platform was created. + */ + DateCreated?: CreationDate; + /** + * The date when the platform was last updated. + */ + DateUpdated?: UpdateDate; + /** + * The category of the platform. + */ + PlatformCategory?: PlatformCategory; + /** + * The description of the platform. + */ + Description?: Description; + /** + * Information about the maintainer of the platform. + */ + Maintainer?: Maintainer; + /** + * The operating system used by the platform. + */ + OperatingSystemName?: OperatingSystemName; + /** + * The version of the operating system used by the platform. + */ + OperatingSystemVersion?: OperatingSystemVersion; + /** + * The programming languages supported by the platform. + */ + ProgrammingLanguages?: PlatformProgrammingLanguages; + /** + * The frameworks supported by the platform. + */ + Frameworks?: PlatformFrameworks; + /** + * The custom AMIs supported by the platform. + */ + CustomAmiList?: CustomAmiList; + /** + * The tiers supported by the platform. + */ + SupportedTierList?: SupportedTierList; + /** + * The additions supported by the platform. + */ + SupportedAddonList?: SupportedAddonList; + } + export interface PlatformFilter { + /** + * The custom platform attribute to which the filter values are applied. Valid Values: PlatformName | PlatformVersion | PlatformStatus | PlatformOwner + */ + Type?: PlatformFilterType; + /** + * The operator to apply to the Type with each of the Values. Valid Values: = (equal to) | != (not equal to) | < (less than) | <= (less than or equal to) | > (greater than) | >= (greater than or equal to) | contains | begins_with | ends_with + */ + Operator?: PlatformFilterOperator; + /** + * The list of values applied to the custom platform attribute. + */ + Values?: PlatformFilterValueList; + } + export type PlatformFilterOperator = string; + export type PlatformFilterType = string; + export type PlatformFilterValue = string; + export type PlatformFilterValueList = PlatformFilterValue[]; + export type PlatformFilters = PlatformFilter[]; + export interface PlatformFramework { + /** + * The name of the framework. + */ + Name?: String; + /** + * The version of the framework. + */ + Version?: String; + } + export type PlatformFrameworks = PlatformFramework[]; + export type PlatformMaxRecords = number; + export type PlatformName = string; + export type PlatformOwner = string; + export interface PlatformProgrammingLanguage { + /** + * The name of the programming language. + */ + Name?: String; + /** + * The version of the programming language. + */ + Version?: String; + } + export type PlatformProgrammingLanguages = PlatformProgrammingLanguage[]; + export type PlatformStatus = "Creating"|"Failed"|"Ready"|"Deleting"|"Deleted"|string; + export interface PlatformSummary { + /** + * The ARN of the platform. + */ + PlatformArn?: PlatformArn; + /** + * The AWS account ID of the person who created the platform. + */ + PlatformOwner?: PlatformOwner; + /** + * The status of the platform. You can create an environment from the platform once it is ready. + */ + PlatformStatus?: PlatformStatus; + /** + * The category of platform. + */ + PlatformCategory?: PlatformCategory; + /** + * The operating system used by the platform. + */ + OperatingSystemName?: OperatingSystemName; + /** + * The version of the operating system used by the platform. + */ + OperatingSystemVersion?: OperatingSystemVersion; + /** + * The tiers in which the platform runs. + */ + SupportedTierList?: SupportedTierList; + /** + * The additions associated with the platform. + */ + SupportedAddonList?: SupportedAddonList; + } + export type PlatformSummaryList = PlatformSummary[]; + export type PlatformVersion = string; + export interface Queue { + /** + * The name of the queue. + */ + Name?: String; + /** + * The URL of the queue. + */ + URL?: String; + } + export type QueueList = Queue[]; + export interface RebuildEnvironmentMessage { + /** + * The ID of the environment to rebuild. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the environment to rebuild. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + } + export type RefreshedAt = Date; + export type RegexLabel = string; + export type RegexPattern = string; + export type RequestCount = number; + export interface RequestEnvironmentInfoMessage { + /** + * The ID of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + /** + * The type of information to request. + */ + InfoType: EnvironmentInfoType; + } + export type RequestId = string; + export type ResourceArn = string; + export type ResourceId = string; + export type ResourceName = string; + export interface ResourceQuota { + /** + * The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use. + */ + Maximum?: BoxedInt; + } + export interface ResourceQuotas { + /** + * The quota for applications in the AWS account. + */ + ApplicationQuota?: ResourceQuota; + /** + * The quota for application versions in the AWS account. + */ + ApplicationVersionQuota?: ResourceQuota; + /** + * The quota for environments in the AWS account. + */ + EnvironmentQuota?: ResourceQuota; + /** + * The quota for configuration templates in the AWS account. + */ + ConfigurationTemplateQuota?: ResourceQuota; + /** + * The quota for custom platforms in the AWS account. + */ + CustomPlatformQuota?: ResourceQuota; + } + export interface ResourceTagsDescriptionMessage { + /** + * The Amazon Resource Name (ARN) of the resouce for which a tag list was requested. + */ + ResourceArn?: ResourceArn; + /** + * A list of tag key-value pairs. + */ + ResourceTags?: TagList; + } + export interface RestartAppServerMessage { + /** + * The ID of the environment to restart the server for. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the environment to restart the server for. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + } + export interface RetrieveEnvironmentInfoMessage { + /** + * The ID of the data's environment. If no such environment is found, returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the data's environment. If no such environment is found, returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + /** + * The type of information to retrieve. + */ + InfoType: EnvironmentInfoType; + } + export interface RetrieveEnvironmentInfoResultMessage { + /** + * The EnvironmentInfoDescription of the environment. + */ + EnvironmentInfo?: EnvironmentInfoDescriptionList; + } + export type S3Bucket = string; + export type S3Key = string; + export interface S3Location { + /** + * The Amazon S3 bucket where the data is located. + */ + S3Bucket?: S3Bucket; + /** + * The Amazon S3 key where the data is located. + */ + S3Key?: S3Key; + } + export type SampleTimestamp = Date; + export interface SingleInstanceHealth { + /** + * The ID of the Amazon EC2 instance. + */ + InstanceId?: InstanceId; + /** + * Returns the health status of the specified instance. For more information, see Health Colors and Statuses. + */ + HealthStatus?: String; + /** + * Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses. + */ + Color?: String; + /** + * Represents the causes, which provide more information about the current health status. + */ + Causes?: Causes; + /** + * The time at which the EC2 instance was launched. + */ + LaunchedAt?: LaunchedAt; + /** + * Request metrics from your application. + */ + ApplicationMetrics?: ApplicationMetrics; + /** + * Operating system metrics from the instance. + */ + System?: SystemStatus; + /** + * Information about the most recent deployment to an instance. + */ + Deployment?: Deployment; + /** + * The availability zone in which the instance runs. + */ + AvailabilityZone?: String; + /** + * The instance's type. + */ + InstanceType?: String; + } + export interface SolutionStackDescription { + /** + * The name of the solution stack. + */ + SolutionStackName?: SolutionStackName; + /** + * The permitted file types allowed for a solution stack. + */ + PermittedFileTypes?: SolutionStackFileTypeList; + } + export type SolutionStackFileTypeList = FileTypeExtension[]; + export type SolutionStackName = string; + export interface SourceBuildInformation { + /** + * The type of repository. Git Zip + */ + SourceType: SourceType; + /** + * Location where the repository is stored. CodeCommit S3 + */ + SourceRepository: SourceRepository; + /** + * The location of the source code, as a formatted string, depending on the value of SourceRepository For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a. For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file. + */ + SourceLocation: SourceLocation; + } + export interface SourceConfiguration { + /** + * The name of the application associated with the configuration. + */ + ApplicationName?: ApplicationName; + /** + * The name of the configuration template. + */ + TemplateName?: ConfigurationTemplateName; + } + export type SourceLocation = string; + export type SourceRepository = "CodeCommit"|"S3"|string; + export type SourceType = "Git"|"Zip"|string; + export interface StatusCodes { + /** + * The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code. + */ + Status2xx?: NullableInteger; + /** + * The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code. + */ + Status3xx?: NullableInteger; + /** + * The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code. + */ + Status4xx?: NullableInteger; + /** + * The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code. + */ + Status5xx?: NullableInteger; + } + export type String = string; + export type SupportedAddon = string; + export type SupportedAddonList = SupportedAddon[]; + export type SupportedTier = string; + export type SupportedTierList = SupportedTier[]; + export interface SwapEnvironmentCNAMEsMessage { + /** + * The ID of the source environment. Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId. + */ + SourceEnvironmentId?: EnvironmentId; + /** + * The name of the source environment. Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName. + */ + SourceEnvironmentName?: EnvironmentName; + /** + * The ID of the destination environment. Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId. + */ + DestinationEnvironmentId?: EnvironmentId; + /** + * The name of the destination environment. Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName. + */ + DestinationEnvironmentName?: EnvironmentName; + } + export interface SystemStatus { + /** + * CPU utilization metrics for the instance. + */ + CPUUtilization?: CPUUtilization; + /** + * Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics. + */ + LoadAverage?: LoadAverage; + } + export interface Tag { + /** + * The key of the tag. + */ + Key?: TagKey; + /** + * The value of the tag. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export type TagValue = string; + export type Tags = Tag[]; + export type TerminateEnvForce = boolean; + export interface TerminateEnvironmentMessage { + /** + * The ID of the environment to terminate. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the environment to terminate. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + /** + * Indicates whether the associated AWS resources should shut down when the environment is terminated: true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. For more information, see the AWS Elastic Beanstalk User Guide. Default: true Valid Values: true | false + */ + TerminateResources?: TerminateEnvironmentResources; + /** + * Terminates the target environment even if another environment in the same group is dependent on it. + */ + ForceTerminate?: ForceTerminate; + } + export type TerminateEnvironmentResources = boolean; + export type TimeFilterEnd = Date; + export type TimeFilterStart = Date; + export type Timestamp = Date; + export type Token = string; + export interface Trigger { + /** + * The name of the trigger. + */ + Name?: ResourceId; + } + export type TriggerList = Trigger[]; + export interface UpdateApplicationMessage { + /** + * The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error. + */ + ApplicationName: ApplicationName; + /** + * A new description for the application. Default: If not specified, AWS Elastic Beanstalk does not update the description. + */ + Description?: Description; + } + export interface UpdateApplicationResourceLifecycleMessage { + /** + * The name of the application. + */ + ApplicationName: ApplicationName; + /** + * The lifecycle configuration. + */ + ResourceLifecycleConfig: ApplicationResourceLifecycleConfig; + } + export interface UpdateApplicationVersionMessage { + /** + * The name of the application associated with this version. If no application is found with this name, UpdateApplication returns an InvalidParameterValue error. + */ + ApplicationName: ApplicationName; + /** + * The name of the version to update. If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error. + */ + VersionLabel: VersionLabel; + /** + * A new description for this version. + */ + Description?: Description; + } + export interface UpdateConfigurationTemplateMessage { + /** + * The name of the application associated with the configuration template to update. If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error. + */ + ApplicationName: ApplicationName; + /** + * The name of the configuration template to update. If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error. + */ + TemplateName: ConfigurationTemplateName; + /** + * A new description for the configuration. + */ + Description?: Description; + /** + * A list of configuration option settings to update with the new specified option value. + */ + OptionSettings?: ConfigurationOptionSettingsList; + /** + * A list of configuration options to remove from the configuration set. Constraint: You can remove only UserDefined configuration options. + */ + OptionsToRemove?: OptionsSpecifierList; + } + export type UpdateDate = Date; + export interface UpdateEnvironmentMessage { + /** + * The name of the application with which the environment is associated. + */ + ApplicationName?: ApplicationName; + /** + * The ID of the environment to update. If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentId?: EnvironmentId; + /** + * The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + */ + EnvironmentName?: EnvironmentName; + /** + * The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details. + */ + GroupName?: GroupName; + /** + * If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment. + */ + Description?: Description; + /** + * This specifies the tier to use to update the environment. Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error. + */ + Tier?: EnvironmentTier; + /** + * If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error. + */ + VersionLabel?: VersionLabel; + /** + * If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error. + */ + TemplateName?: ConfigurationTemplateName; + /** + * This specifies the platform version that the environment will run after the environment is updated. + */ + SolutionStackName?: SolutionStackName; + /** + * The ARN of the platform, if used. + */ + PlatformArn?: PlatformArn; + /** + * If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value. + */ + OptionSettings?: ConfigurationOptionSettingsList; + /** + * A list of custom user-defined configuration options to remove from the configuration set for this environment. + */ + OptionsToRemove?: OptionsSpecifierList; + } + export interface UpdateTagsForResourceMessage { + /** + * The Amazon Resource Name (ARN) of the resouce to be updated. Must be the ARN of an Elastic Beanstalk environment. + */ + ResourceArn: ResourceArn; + /** + * A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated. + */ + TagsToAdd?: TagList; + /** + * A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored. + */ + TagsToRemove?: TagKeyList; + } + export type UserDefinedOption = boolean; + export interface ValidateConfigurationSettingsMessage { + /** + * The name of the application that the configuration template or environment belongs to. + */ + ApplicationName: ApplicationName; + /** + * The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name. + */ + TemplateName?: ConfigurationTemplateName; + /** + * The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name. + */ + EnvironmentName?: EnvironmentName; + /** + * A list of the options and desired values to evaluate. + */ + OptionSettings: ConfigurationOptionSettingsList; + } + export interface ValidationMessage { + /** + * A message describing the error or warning. + */ + Message?: ValidationMessageString; + /** + * An indication of the severity of this message: error: This message indicates that this is not a valid setting for an option. warning: This message is providing information you should take into account. + */ + Severity?: ValidationSeverity; + /** + * The namespace to which the option belongs. + */ + Namespace?: OptionNamespace; + /** + * The name of the option. + */ + OptionName?: ConfigurationOptionName; + } + export type ValidationMessageString = string; + export type ValidationMessagesList = ValidationMessage[]; + export type ValidationSeverity = "error"|"warning"|string; + export type VersionLabel = string; + export type VersionLabels = VersionLabel[]; + export type VersionLabelsList = VersionLabel[]; + export type VirtualizationType = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2010-12-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ElasticBeanstalk client. + */ + export import Types = ElasticBeanstalk; +} +export = ElasticBeanstalk; diff --git a/node_modules/aws-sdk/clients/elasticbeanstalk.js b/node_modules/aws-sdk/clients/elasticbeanstalk.js new file mode 100644 index 0000000..96c5a93 --- /dev/null +++ b/node_modules/aws-sdk/clients/elasticbeanstalk.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['elasticbeanstalk'] = {}; +AWS.ElasticBeanstalk = Service.defineService('elasticbeanstalk', ['2010-12-01']); +Object.defineProperty(apiLoader.services['elasticbeanstalk'], '2010-12-01', { + get: function get() { + var model = require('../apis/elasticbeanstalk-2010-12-01.min.json'); + model.paginators = require('../apis/elasticbeanstalk-2010-12-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ElasticBeanstalk; diff --git a/node_modules/aws-sdk/clients/elastictranscoder.d.ts b/node_modules/aws-sdk/clients/elastictranscoder.d.ts new file mode 100644 index 0000000..bb98a3b --- /dev/null +++ b/node_modules/aws-sdk/clients/elastictranscoder.d.ts @@ -0,0 +1,1486 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ElasticTranscoder extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ElasticTranscoder.Types.ClientConfiguration) + config: Config & ElasticTranscoder.Types.ClientConfiguration; + /** + * The CancelJob operation cancels an unfinished job. You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline. + */ + cancelJob(params: ElasticTranscoder.Types.CancelJobRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CancelJobResponse) => void): Request; + /** + * The CancelJob operation cancels an unfinished job. You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline. + */ + cancelJob(callback?: (err: AWSError, data: ElasticTranscoder.Types.CancelJobResponse) => void): Request; + /** + * When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). + */ + createJob(params: ElasticTranscoder.Types.CreateJobRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CreateJobResponse) => void): Request; + /** + * When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). + */ + createJob(callback?: (err: AWSError, data: ElasticTranscoder.Types.CreateJobResponse) => void): Request; + /** + * The CreatePipeline operation creates a pipeline with settings that you specify. + */ + createPipeline(params: ElasticTranscoder.Types.CreatePipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePipelineResponse) => void): Request; + /** + * The CreatePipeline operation creates a pipeline with settings that you specify. + */ + createPipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePipelineResponse) => void): Request; + /** + * The CreatePreset operation creates a preset with settings that you specify. Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces. Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services. + */ + createPreset(params: ElasticTranscoder.Types.CreatePresetRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePresetResponse) => void): Request; + /** + * The CreatePreset operation creates a preset with settings that you specify. Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces. Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services. + */ + createPreset(callback?: (err: AWSError, data: ElasticTranscoder.Types.CreatePresetResponse) => void): Request; + /** + * The DeletePipeline operation removes a pipeline. You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error. + */ + deletePipeline(params: ElasticTranscoder.Types.DeletePipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePipelineResponse) => void): Request; + /** + * The DeletePipeline operation removes a pipeline. You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error. + */ + deletePipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePipelineResponse) => void): Request; + /** + * The DeletePreset operation removes a preset that you've added in an AWS region. You can't delete the default presets that are included with Elastic Transcoder. + */ + deletePreset(params: ElasticTranscoder.Types.DeletePresetRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePresetResponse) => void): Request; + /** + * The DeletePreset operation removes a preset that you've added in an AWS region. You can't delete the default presets that are included with Elastic Transcoder. + */ + deletePreset(callback?: (err: AWSError, data: ElasticTranscoder.Types.DeletePresetResponse) => void): Request; + /** + * The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. + */ + listJobsByPipeline(params: ElasticTranscoder.Types.ListJobsByPipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByPipelineResponse) => void): Request; + /** + * The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. + */ + listJobsByPipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByPipelineResponse) => void): Request; + /** + * The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. + */ + listJobsByStatus(params: ElasticTranscoder.Types.ListJobsByStatusRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByStatusResponse) => void): Request; + /** + * The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. + */ + listJobsByStatus(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListJobsByStatusResponse) => void): Request; + /** + * The ListPipelines operation gets a list of the pipelines associated with the current AWS account. + */ + listPipelines(params: ElasticTranscoder.Types.ListPipelinesRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPipelinesResponse) => void): Request; + /** + * The ListPipelines operation gets a list of the pipelines associated with the current AWS account. + */ + listPipelines(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPipelinesResponse) => void): Request; + /** + * The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. + */ + listPresets(params: ElasticTranscoder.Types.ListPresetsRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPresetsResponse) => void): Request; + /** + * The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. + */ + listPresets(callback?: (err: AWSError, data: ElasticTranscoder.Types.ListPresetsResponse) => void): Request; + /** + * The ReadJob operation returns detailed information about a job. + */ + readJob(params: ElasticTranscoder.Types.ReadJobRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request; + /** + * The ReadJob operation returns detailed information about a job. + */ + readJob(callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request; + /** + * The ReadPipeline operation gets detailed information about a pipeline. + */ + readPipeline(params: ElasticTranscoder.Types.ReadPipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPipelineResponse) => void): Request; + /** + * The ReadPipeline operation gets detailed information about a pipeline. + */ + readPipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPipelineResponse) => void): Request; + /** + * The ReadPreset operation gets detailed information about a preset. + */ + readPreset(params: ElasticTranscoder.Types.ReadPresetRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPresetResponse) => void): Request; + /** + * The ReadPreset operation gets detailed information about a preset. + */ + readPreset(callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadPresetResponse) => void): Request; + /** + * The TestRole operation tests the IAM role used to create the pipeline. The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. + */ + testRole(params: ElasticTranscoder.Types.TestRoleRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.TestRoleResponse) => void): Request; + /** + * The TestRole operation tests the IAM role used to create the pipeline. The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. + */ + testRole(callback?: (err: AWSError, data: ElasticTranscoder.Types.TestRoleResponse) => void): Request; + /** + * Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. + */ + updatePipeline(params: ElasticTranscoder.Types.UpdatePipelineRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineResponse) => void): Request; + /** + * Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. + */ + updatePipeline(callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineResponse) => void): Request; + /** + * With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. + */ + updatePipelineNotifications(params: ElasticTranscoder.Types.UpdatePipelineNotificationsRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineNotificationsResponse) => void): Request; + /** + * With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. + */ + updatePipelineNotifications(callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineNotificationsResponse) => void): Request; + /** + * The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request. + */ + updatePipelineStatus(params: ElasticTranscoder.Types.UpdatePipelineStatusRequest, callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineStatusResponse) => void): Request; + /** + * The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request. + */ + updatePipelineStatus(callback?: (err: AWSError, data: ElasticTranscoder.Types.UpdatePipelineStatusResponse) => void): Request; + /** + * Waits for the jobComplete state by periodically calling the underlying ElasticTranscoder.readJoboperation every 30 seconds (at most 120 times). + */ + waitFor(state: "jobComplete", params: ElasticTranscoder.Types.ReadJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request; + /** + * Waits for the jobComplete state by periodically calling the underlying ElasticTranscoder.readJoboperation every 30 seconds (at most 120 times). + */ + waitFor(state: "jobComplete", callback?: (err: AWSError, data: ElasticTranscoder.Types.ReadJobResponse) => void): Request; +} +declare namespace ElasticTranscoder { + export type AccessControl = string; + export type AccessControls = AccessControl[]; + export interface Artwork { + /** + * The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket. If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. + */ + InputKey?: WatermarkKey; + /** + * The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive. + */ + MaxWidth?: DigitsOrAuto; + /** + * The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive. + */ + MaxHeight?: DigitsOrAuto; + /** + * Specify one of the following values to control scaling of the output album art: Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value. Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. Stretch: Elastic Transcoder stretches the output art to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted. Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output art. ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up. ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up. + */ + SizingPolicy?: SizingPolicy; + /** + * When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight. + */ + PaddingPolicy?: PaddingPolicy; + /** + * The format of album art, if any. Valid formats are .jpg and .png. + */ + AlbumArtFormat?: JpgOrPng; + /** + * The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork. + */ + Encryption?: Encryption; + } + export type Artworks = Artwork[]; + export type Ascending = string; + export type AspectRatio = string; + export type AudioBitDepth = string; + export type AudioBitOrder = string; + export type AudioBitRate = string; + export type AudioChannels = string; + export type AudioCodec = string; + export interface AudioCodecOptions { + /** + * You can only choose an audio profile when you specify AAC for the value of Audio:Codec. Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles: auto: If you specify auto, Elastic Transcoder selects the profile based on the bit rate selected for the output file. AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps. HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps. HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps. All outputs in a Smooth playlist must have the same value for Profile. If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required. + */ + Profile?: AudioCodecProfile; + /** + * You can only choose an audio bit depth when you specify flac or pcm for the value of Audio:Codec. The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file. Valid values are 16 and 24. The most common bit depth is 24. + */ + BitDepth?: AudioBitDepth; + /** + * You can only choose an audio bit order when you specify pcm for the value of Audio:Codec. The order the bits of a PCM sample are stored in. The supported value is LittleEndian. + */ + BitOrder?: AudioBitOrder; + /** + * You can only choose whether an audio sample is signed when you specify pcm for the value of Audio:Codec. Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned). The supported value is Signed. + */ + Signed?: AudioSigned; + } + export type AudioCodecProfile = string; + export type AudioPackingMode = string; + export interface AudioParameters { + /** + * The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis. + */ + Codec?: AudioCodec; + /** + * The sample rate of the audio stream in the output file, in Hertz. Valid values include: auto, 22050, 32000, 44100, 48000, 96000 If you specify auto, Elastic Transcoder automatically detects the sample rate. + */ + SampleRate?: AudioSampleRate; + /** + * The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive. + */ + BitRate?: AudioBitRate; + /** + * The number of audio channels in the output file. The following values are valid: auto, 0, 1, 2 One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto. The output of a specific channel value and inputs are as follows: auto channel specified, with any input: Pass through up to eight input channels. 0 channels specified, with any input: Audio omitted from the output. 1 channel specified, with at least one input channel: Mono sound. 2 channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, see Audio:AudioPackingMode. For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode. + */ + Channels?: AudioChannels; + /** + * The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack. The following values are valid: SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks When you specify SingleTrack, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack for all non-mxf containers. The outputs of SingleTrack for a specific channel value and inputs are as follows: 0 channels with any input: Audio omitted from the output 1, 2, or auto channels with no audio input: Audio omitted from the output 1 channel with any input with audio: One track with one channel, downmixed if necessary 2 channels with one track with one channel: One track with two identical channels 2 or auto channels with two tracks with one channel each: One track with two channels 2 or auto channels with one track with two channels: One track with two channels 2 channels with one track with multiple channels: One track with two channels auto channels with one track with one channel: One track with one channel auto channels with one track with multiple channels: One track with multiple channels When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks. The outputs of OneChannelPerTrack for a specific channel value and inputs are as follows: 0 channels with any input: Audio omitted from the output 1, 2, or auto channels with no audio input: Audio omitted from the output 1 channel with any input with audio: One track with one channel, downmixed if necessary 2 channels with one track with one channel: Two tracks with one identical channel each 2 or auto channels with two tracks with one channel each: Two tracks with one channel each 2 or auto channels with one track with two channels: Two tracks with one channel each 2 channels with one track with multiple channels: Two tracks with one channel each auto channels with one track with one channel: One track with one channel auto channels with one track with multiple channels: Up to eight tracks with one channel each When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks. The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are as follows: 0 channels with any input: Audio omitted from the output 1, 2, or auto channels with no audio input: Audio omitted from the output 1 channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks 2 channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks 2 or auto channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks 2 or auto channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks 2 channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks auto channels with one track with one channel: One track with one channel, plus seven MOS tracks auto channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all + */ + AudioPackingMode?: AudioPackingMode; + /** + * If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include: auto, AAC-LC, HE-AAC, HE-AACv2 If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file. + */ + CodecOptions?: AudioCodecOptions; + } + export type AudioSampleRate = string; + export type AudioSigned = string; + export type Base64EncodedString = string; + export type BucketName = string; + export interface CancelJobRequest { + /** + * The identifier of the job that you want to cancel. To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action. + */ + Id: Id; + } + export interface CancelJobResponse { + } + export interface CaptionFormat { + /** + * The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output. Valid Embedded Caption Formats: for FLAC: None For MP3: None For MP4: mov-text For MPEG-TS: None For ogg: None For webm: None Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. For FMP4: dfxp Non-FMP4 outputs: All sidecar types fmp4 captions have an extension of .ismt + */ + Format?: CaptionFormatFormat; + /** + * The prefix for caption filenames, in the form description-{language}, where: description is a description of the video. {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names. If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files. For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt. + */ + Pattern?: CaptionFormatPattern; + /** + * The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats. + */ + Encryption?: Encryption; + } + export type CaptionFormatFormat = string; + export type CaptionFormatPattern = string; + export type CaptionFormats = CaptionFormat[]; + export type CaptionMergePolicy = string; + export interface CaptionSource { + /** + * The name of the sidecar caption file that you want Elastic Transcoder to include in the output file. + */ + Key?: LongKey; + /** + * A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of: 2-character ISO 639-1 code 3-character ISO 639-2 code For more information on ISO language codes and language names, see the List of ISO 639-1 codes. + */ + Language?: Key; + /** + * For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions. Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss. + */ + TimeOffset?: TimeOffset; + /** + * The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions. + */ + Label?: Name; + /** + * The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources. + */ + Encryption?: Encryption; + } + export type CaptionSources = CaptionSource[]; + export interface Captions { + /** + * A policy that determines how Elastic Transcoder handles the existence of multiple captions. MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language. MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files. Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources. MergePolicy cannot be null. + */ + MergePolicy?: CaptionMergePolicy; + /** + * Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank. + */ + CaptionSources?: CaptionSources; + /** + * The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error. + */ + CaptionFormats?: CaptionFormats; + } + export interface Clip { + /** + * Settings that determine when a clip begins and how long it lasts. + */ + TimeSpan?: TimeSpan; + } + export type CodecOption = string; + export type CodecOptions = {[key: string]: CodecOption}; + export type Composition = Clip[]; + export interface CreateJobOutput { + /** + * The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails. + */ + Key?: Key; + /** + * Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. If you don't want Elastic Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job. Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}. {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object. When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension. + */ + ThumbnailPattern?: ThumbnailPattern; + /** + * The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. + */ + ThumbnailEncryption?: Encryption; + /** + * The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata. + */ + Rotate?: Rotate; + /** + * The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. + */ + PresetId?: Id; + /** + * (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer. The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist. + */ + SegmentDuration?: FloatString; + /** + * Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output. + */ + Watermarks?: JobWatermarks; + /** + * Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output. + */ + AlbumArt?: JobAlbumArt; + /** + * You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null. + */ + Composition?: Composition; + /** + * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs include: mov-text Elastic Transcoder supports a maximum of one embedded format per output. Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array. For more information on embedded files, see the Subtitles Wikipedia page. For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. + */ + Captions?: Captions; + /** + * You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually. + */ + Encryption?: Encryption; + } + export type CreateJobOutputs = CreateJobOutput[]; + export interface CreateJobPlaylist { + /** + * The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique. Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions. + */ + Name?: Filename; + /** + * The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth. + */ + Format?: PlaylistFormat; + /** + * For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key: OutputKeyPrefixOutputs:Key If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000: OutputKeyPrefixOutputs:Key.m3u8 OutputKeyPrefixOutputs:Key00000.ts If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8: OutputKeyPrefixOutputs:Key_v4.m3u8 OutputKeyPrefixOutputs:Key_iframe.m3u8 OutputKeyPrefixOutputs:Key.ts Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs. + */ + OutputKeys?: OutputKeys; + /** + * The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. + */ + HlsContentProtection?: HlsContentProtection; + /** + * The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. + */ + PlayReadyDrm?: PlayReadyDrm; + } + export type CreateJobPlaylists = CreateJobPlaylist[]; + export interface CreateJobRequest { + /** + * The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files. + */ + PipelineId: Id; + /** + * A section of the request body that provides information about the file that is being transcoded. + */ + Input?: JobInput; + /** + * A section of the request body that provides information about the files that are being transcoded. + */ + Inputs?: JobInputs; + /** + * A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax. + */ + Output?: CreateJobOutput; + /** + * A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax. + */ + Outputs?: CreateJobOutputs; + /** + * The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. + */ + OutputKeyPrefix?: Key; + /** + * If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. The maximum number of master playlists in a job is 30. + */ + Playlists?: CreateJobPlaylists; + /** + * User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them. + */ + UserMetadata?: UserMetadata; + } + export interface CreateJobResponse { + /** + * A section of the response body that provides information about the job that is created. + */ + Job?: Job; + } + export interface CreatePipelineRequest { + /** + * The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characters. + */ + Name: Name; + /** + * The Amazon S3 bucket in which you saved the media files that you want to transcode. + */ + InputBucket: BucketName; + /** + * The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.) Specify this value when all of the following are true: You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket. You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists. You do not want to specify the permissions that Elastic Transcoder grants to the files. When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role. You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class. If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead. + */ + OutputBucket?: BucketName; + /** + * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline. + */ + Role: Role; + /** + * The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + */ + AwsKmsKeyArn?: KeyArn; + /** + * The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide. Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. + */ + Notifications?: Notifications; + /** + * The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. Grantee Type: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. + */ + ContentConfig?: PipelineOutputConfig; + /** + * The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. GranteeType: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket. + */ + ThumbnailConfig?: PipelineOutputConfig; + } + export interface CreatePipelineResponse { + /** + * A section of the response body that provides information about the pipeline that is created. + */ + Pipeline?: Pipeline; + /** + * Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline. Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges. + */ + Warnings?: Warnings; + } + export interface CreatePresetRequest { + /** + * The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. + */ + Name: Name; + /** + * A description of the preset. + */ + Description?: Description; + /** + * The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. + */ + Container: PresetContainer; + /** + * A section of the request body that specifies the video parameters. + */ + Video?: VideoParameters; + /** + * A section of the request body that specifies the audio parameters. + */ + Audio?: AudioParameters; + /** + * A section of the request body that specifies the thumbnail parameters, if any. + */ + Thumbnails?: Thumbnails; + } + export interface CreatePresetResponse { + /** + * A section of the response body that provides information about the preset that is created. + */ + Preset?: Preset; + /** + * If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output. + */ + Warning?: String; + } + export interface DeletePipelineRequest { + /** + * The identifier of the pipeline that you want to delete. + */ + Id: Id; + } + export interface DeletePipelineResponse { + } + export interface DeletePresetRequest { + /** + * The identifier of the preset for which you want to get detailed information. + */ + Id: Id; + } + export interface DeletePresetResponse { + } + export type Description = string; + export interface DetectedProperties { + /** + * The detected width of the input file, in pixels. + */ + Width?: NullableInteger; + /** + * The detected height of the input file, in pixels. + */ + Height?: NullableInteger; + /** + * The detected frame rate of the input file, in frames per second. + */ + FrameRate?: FloatString; + /** + * The detected file size of the input file, in bytes. + */ + FileSize?: NullableLong; + /** + * The detected duration of the input file, in milliseconds. + */ + DurationMillis?: NullableLong; + } + export type Digits = string; + export type DigitsOrAuto = string; + export interface Encryption { + /** + * The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options: s3: Amazon S3 creates and manages the keys used for encrypting your files. s3-aws-kms: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify s3-aws-kms and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline. aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for HLS files. aes-ctr: AES Counter Mode. aes-gcm: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process. For all three AES options, you must provide the following settings, which must be base64-encoded: Key Key MD5 Initialization Vector For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data. + */ + Mode?: EncryptionMode; + /** + * The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded: 128, 192, or 256. The key must also be encrypted by using the Amazon Key Management Service. + */ + Key?: Base64EncodedString; + /** + * The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded. + */ + KeyMd5?: Base64EncodedString; + /** + * The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded. + */ + InitializationVector?: ZeroTo255String; + } + export type EncryptionMode = string; + export type ExceptionMessages = String[]; + export type Filename = string; + export type FixedGOP = string; + export type FloatString = string; + export type FrameRate = string; + export type Grantee = string; + export type GranteeType = string; + export interface HlsContentProtection { + /** + * The content protection method for your output. The only valid value is: aes-128. This value is written into the method attribute of the EXT-X-KEY metadata tag in the output playlist. + */ + Method?: HlsContentProtectionMethod; + /** + * If you want Elastic Transcoder to generate a key for you, leave this field blank. If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded: 128, 192, or 256. + */ + Key?: Base64EncodedString; + /** + * If Elastic Transcoder is generating your key for you, you must leave this field blank. The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded. + */ + KeyMd5?: Base64EncodedString; + /** + * If Elastic Transcoder is generating your key for you, you must leave this field blank. The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded. + */ + InitializationVector?: ZeroTo255String; + /** + * The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file. + */ + LicenseAcquisitionUrl?: ZeroTo512String; + /** + * Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist. + */ + KeyStoragePolicy?: KeyStoragePolicy; + } + export type HlsContentProtectionMethod = string; + export type HorizontalAlign = string; + export type Id = string; + export interface InputCaptions { + /** + * A policy that determines how Elastic Transcoder handles the existence of multiple captions. MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language. MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files. Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources. MergePolicy cannot be null. + */ + MergePolicy?: CaptionMergePolicy; + /** + * Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank. + */ + CaptionSources?: CaptionSources; + } + export type Interlaced = string; + export interface Job { + /** + * The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job. + */ + Id?: Id; + /** + * The Amazon Resource Name (ARN) for the job. + */ + Arn?: String; + /** + * The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files. + */ + PipelineId?: Id; + /** + * A section of the request or response body that provides information about the file that is being transcoded. + */ + Input?: JobInput; + /** + * Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output. + */ + Inputs?: JobInputs; + /** + * If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object. Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file. + */ + Output?: JobOutput; + /** + * Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job. If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job. + */ + Outputs?: JobOutputs; + /** + * The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix. + */ + OutputKeyPrefix?: Key; + /** + * Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. The maximum number of master playlists in a job is 30. + */ + Playlists?: Playlists; + /** + * The status of the job: Submitted, Progressing, Complete, Canceled, or Error. + */ + Status?: JobStatus; + /** + * User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them. Metadata keys and values must use characters from the following list: 0-9 A-Z and a-z Space The following symbols: _.:/=+-%@ + */ + UserMetadata?: UserMetadata; + /** + * Details about the timing of a job. + */ + Timing?: Timing; + } + export interface JobAlbumArt { + /** + * A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files. Replace: The specified album art replaces any existing album art. Prepend: The specified album art is placed in front of any existing album art. Append: The specified album art is placed after any existing album art. Fallback: If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file. + */ + MergePolicy?: MergePolicy; + /** + * The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg and .png + */ + Artwork?: Artworks; + } + export type JobContainer = string; + export interface JobInput { + /** + * The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. + */ + Key?: LongKey; + /** + * The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values: 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate. + */ + FrameRate?: FrameRate; + /** + * This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file. + */ + Resolution?: Resolution; + /** + * The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio. + */ + AspectRatio?: AspectRatio; + /** + * Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values: true, false If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing. + */ + Interlaced?: Interlaced; + /** + * The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values: 3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm + */ + Container?: JobContainer; + /** + * The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file. + */ + Encryption?: Encryption; + /** + * Settings for clipping an input. Each input can have different clip settings. + */ + TimeSpan?: TimeSpan; + /** + * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs include: mov-text Elastic Transcoder supports a maximum of one embedded format per output. Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array. For more information on embedded files, see the Subtitles Wikipedia page. For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. + */ + InputCaptions?: InputCaptions; + /** + * The detected properties of the input file. + */ + DetectedProperties?: DetectedProperties; + } + export type JobInputs = JobInput[]; + export interface JobOutput { + /** + * A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1. + */ + Id?: String; + /** + * The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. + */ + Key?: Key; + /** + * Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. If you don't want Elastic Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job. Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}. {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object. When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension. + */ + ThumbnailPattern?: ThumbnailPattern; + /** + * The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. + */ + ThumbnailEncryption?: Encryption; + /** + * The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270 The value auto generally works only if the file that you're transcoding contains rotation metadata. + */ + Rotate?: Rotate; + /** + * The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets. + */ + PresetId?: Id; + /** + * (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4, MPEG-DASH, and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer. The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist. + */ + SegmentDuration?: FloatString; + /** + * The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output: Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. When Elastic Transcoder starts to process the first output, Outputs:Status for that output and Job:Status both change to Progressing. For each output, the value of Outputs:Status remains Submitted until Elastic Transcoder starts to process the output. Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error. When all of the outputs reach a terminal status, Job:Status changes to Complete only if Outputs:Status for all of the outputs is Complete. If Outputs:Status for one or more outputs is Error, the terminal status for Job:Status is also Error. The value of Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error. + */ + Status?: JobStatus; + /** + * Information that further explains Status. + */ + StatusDetail?: Description; + /** + * Duration of the output file, in seconds. + */ + Duration?: NullableLong; + /** + * Specifies the width of the output file in pixels. + */ + Width?: NullableInteger; + /** + * Height of the output file, in pixels. + */ + Height?: NullableInteger; + /** + * Frame rate of the output file, in frames per second. + */ + FrameRate?: FloatString; + /** + * File size of the output file, in bytes. + */ + FileSize?: NullableLong; + /** + * Duration of the output file, in milliseconds. + */ + DurationMillis?: NullableLong; + /** + * Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in Preset for the current output. Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add covers the first one, the third one covers the second, and the fourth one covers the third. + */ + Watermarks?: JobWatermarks; + /** + * The album art to be associated with the output file, if any. + */ + AlbumArt?: JobAlbumArt; + /** + * You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null. + */ + Composition?: Composition; + /** + * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs include: mov-text Elastic Transcoder supports a maximum of one embedded format per output. Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array. For more information on embedded files, see the Subtitles Wikipedia page. For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. + */ + Captions?: Captions; + /** + * The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket. + */ + Encryption?: Encryption; + /** + * If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output file, the AppliedColorSpaceConversion parameter shows the conversion used. If no ColorSpaceConversionMode was defined in the preset, this parameter is not be included in the job response. + */ + AppliedColorSpaceConversion?: String; + } + export type JobOutputs = JobOutput[]; + export type JobStatus = string; + export interface JobWatermark { + /** + * The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use. + */ + PresetWatermarkId?: PresetWatermarkId; + /** + * The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket. If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. + */ + InputKey?: WatermarkKey; + /** + * The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks. + */ + Encryption?: Encryption; + } + export type JobWatermarks = JobWatermark[]; + export type Jobs = Job[]; + export type JpgOrPng = string; + export type Key = string; + export type KeyArn = string; + export type KeyIdGuid = string; + export type KeyStoragePolicy = string; + export type KeyframesMaxDist = string; + export interface ListJobsByPipelineRequest { + /** + * The ID of the pipeline for which you want to get job information. + */ + PipelineId: Id; + /** + * To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false. + */ + Ascending?: Ascending; + /** + * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. + */ + PageToken?: Id; + } + export interface ListJobsByPipelineResponse { + /** + * An array of Job objects that are in the specified pipeline. + */ + Jobs?: Jobs; + /** + * A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null. + */ + NextPageToken?: Id; + } + export interface ListJobsByStatusRequest { + /** + * To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error. + */ + Status: JobStatus; + /** + * To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false. + */ + Ascending?: Ascending; + /** + * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. + */ + PageToken?: Id; + } + export interface ListJobsByStatusResponse { + /** + * An array of Job objects that have the specified status. + */ + Jobs?: Jobs; + /** + * A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null. + */ + NextPageToken?: Id; + } + export interface ListPipelinesRequest { + /** + * To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines in reverse chronological order, enter false. + */ + Ascending?: Ascending; + /** + * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. + */ + PageToken?: Id; + } + export interface ListPipelinesResponse { + /** + * An array of Pipeline objects. + */ + Pipelines?: Pipelines; + /** + * A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of NextPageToken is null. + */ + NextPageToken?: Id; + } + export interface ListPresetsRequest { + /** + * To list presets in chronological order by the date and time that they were created, enter true. To list presets in reverse chronological order, enter false. + */ + Ascending?: Ascending; + /** + * When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results. + */ + PageToken?: Id; + } + export interface ListPresetsResponse { + /** + * An array of Preset objects. + */ + Presets?: Presets; + /** + * A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of NextPageToken is null. + */ + NextPageToken?: Id; + } + export type LongKey = string; + export type MaxFrameRate = string; + export type MergePolicy = string; + export type Name = string; + export type NonEmptyBase64EncodedString = string; + export interface Notifications { + /** + * The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. + */ + Progressing?: SnsTopic; + /** + * The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. + */ + Completed?: SnsTopic; + /** + * The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. + */ + Warning?: SnsTopic; + /** + * The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. + */ + Error?: SnsTopic; + } + export type NullableInteger = number; + export type NullableLong = number; + export type OneTo512String = string; + export type Opacity = string; + export type OutputKeys = Key[]; + export type PaddingPolicy = string; + export interface Permission { + /** + * The type of value that appears in the Grantee object: Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The registered email address of an AWS account. Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. + */ + GranteeType?: GranteeType; + /** + * The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. + */ + Grantee?: Grantee; + /** + * The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + */ + Access?: AccessControls; + } + export type Permissions = Permission[]; + export interface Pipeline { + /** + * The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset. + */ + Id?: Id; + /** + * The Amazon Resource Name (ARN) for the pipeline. + */ + Arn?: String; + /** + * The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characters + */ + Name?: Name; + /** + * The current status of the pipeline: Active: The pipeline is processing jobs. Paused: The pipeline is not currently processing jobs. + */ + Status?: PipelineStatus; + /** + * The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks. + */ + InputBucket?: BucketName; + /** + * The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig. + */ + OutputBucket?: BucketName; + /** + * The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline. + */ + Role?: Role; + /** + * The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + */ + AwsKmsKeyArn?: KeyArn; + /** + * The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. + */ + Notifications?: Notifications; + /** + * Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have. GranteeType: The type of value that appears in the Grantee object: Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Email: The registered email address of an AWS account. Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to transcoded files and playlists. Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. + */ + ContentConfig?: PipelineOutputConfig; + /** + * Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have. GranteeType: The type of value that appears in the Grantee object: Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The registered email address of an AWS account. Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to thumbnail files. Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket. + */ + ThumbnailConfig?: PipelineOutputConfig; + } + export interface PipelineOutputConfig { + /** + * The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true: You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket. You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists. You do not want to specify the permissions that Elastic Transcoder grants to the files. You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class. If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead. + */ + Bucket?: BucketName; + /** + * The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. + */ + StorageClass?: StorageClass; + /** + * Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user. If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group. + */ + Permissions?: Permissions; + } + export type PipelineStatus = string; + export type Pipelines = Pipeline[]; + export type PixelsOrPercent = string; + export interface PlayReadyDrm { + /** + * The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. + */ + Format?: PlayReadyDrmFormatString; + /** + * The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded: 128, 192, or 256. The key must also be encrypted by using AWS KMS. + */ + Key?: NonEmptyBase64EncodedString; + /** + * The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded. + */ + KeyMd5?: NonEmptyBase64EncodedString; + /** + * The ID for your DRM key, so that your DRM license provider knows which key to provide. The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider. + */ + KeyId?: KeyIdGuid; + /** + * The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder generates one for you. + */ + InitializationVector?: ZeroTo255String; + /** + * The location of the license key required to play DRM content. The URL must be an absolute path, and is referenced by the PlayReady header. The PlayReady header is referenced in the protection header of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL looks like this: https://www.example.com/exampleKey/ + */ + LicenseAcquisitionUrl?: OneTo512String; + } + export type PlayReadyDrmFormatString = string; + export interface Playlist { + /** + * The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique. Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions. + */ + Name?: Filename; + /** + * The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth. + */ + Format?: PlaylistFormat; + /** + * For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key: OutputKeyPrefixOutputs:Key If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000: OutputKeyPrefixOutputs:Key.m3u8 OutputKeyPrefixOutputs:Key00000.ts If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8: OutputKeyPrefixOutputs:Key_v4.m3u8 OutputKeyPrefixOutputs:Key_iframe.m3u8 OutputKeyPrefixOutputs:Key.ts Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs. + */ + OutputKeys?: OutputKeys; + /** + * The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. + */ + HlsContentProtection?: HlsContentProtection; + /** + * The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist. + */ + PlayReadyDrm?: PlayReadyDrm; + /** + * The status of the job with which the playlist is associated. + */ + Status?: JobStatus; + /** + * Information that further explains the status. + */ + StatusDetail?: Description; + } + export type PlaylistFormat = string; + export type Playlists = Playlist[]; + export interface Preset { + /** + * Identifier for the new preset. You use this value to get settings for the preset or to delete it. + */ + Id?: Id; + /** + * The Amazon Resource Name (ARN) for the preset. + */ + Arn?: String; + /** + * The name of the preset. + */ + Name?: Name; + /** + * A description of the preset. + */ + Description?: Description; + /** + * The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. + */ + Container?: PresetContainer; + /** + * A section of the response body that provides information about the audio preset values. + */ + Audio?: AudioParameters; + /** + * A section of the response body that provides information about the video preset values. + */ + Video?: VideoParameters; + /** + * A section of the response body that provides information about the thumbnail preset values, if any. + */ + Thumbnails?: Thumbnails; + /** + * Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you have defined (Custom). + */ + Type?: PresetType; + } + export type PresetContainer = string; + export type PresetType = string; + export interface PresetWatermark { + /** + * A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long. + */ + Id?: PresetWatermarkId; + /** + * The maximum width of the watermark in one of the following formats: number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxWidth. integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation. If you specify the value in pixels, it must be less than or equal to the value of MaxWidth. + */ + MaxWidth?: PixelsOrPercent; + /** + * The maximum height of the watermark in one of the following formats: number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxHeight. integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation. If you specify the value in pixels, it must be less than or equal to the value of MaxHeight. + */ + MaxHeight?: PixelsOrPercent; + /** + * A value that controls scaling of the watermark: Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value. Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of MaxWidth and MaxHeight are different, the watermark will be distorted. ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up. + */ + SizingPolicy?: WatermarkSizingPolicy; + /** + * The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset: Left: The left edge of the watermark is aligned with the left border of the video. Right: The right edge of the watermark is aligned with the right border of the video. Center: The watermark is centered between the left and right borders. + */ + HorizontalAlign?: HorizontalAlign; + /** + * The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign: number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth. integer percentage (%): The range of valid values is 0 to 100. For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video. HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped. Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation. + */ + HorizontalOffset?: PixelsOrPercent; + /** + * The vertical position of the watermark unless you specify a non-zero value for VerticalOffset: Top: The top edge of the watermark is aligned with the top border of the video. Bottom: The bottom edge of the watermark is aligned with the bottom border of the video. Center: The watermark is centered between the top and bottom borders. + */ + VerticalAlign?: VerticalAlign; + /** + * VerticalOffset The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign: number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxHeight. integer percentage (%): The range of valid values is 0 to 100. For example, if you specify Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video. VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom. If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation. + */ + VerticalOffset?: PixelsOrPercent; + /** + * A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float. Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency. + */ + Opacity?: Opacity; + /** + * A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight: Content: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. Frame: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. + */ + Target?: Target; + } + export type PresetWatermarkId = string; + export type PresetWatermarks = PresetWatermark[]; + export type Presets = Preset[]; + export interface ReadJobRequest { + /** + * The identifier of the job for which you want to get detailed information. + */ + Id: Id; + } + export interface ReadJobResponse { + /** + * A section of the response body that provides information about the job. + */ + Job?: Job; + } + export interface ReadPipelineRequest { + /** + * The identifier of the pipeline to read. + */ + Id: Id; + } + export interface ReadPipelineResponse { + /** + * A section of the response body that provides information about the pipeline. + */ + Pipeline?: Pipeline; + /** + * Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline. Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges. + */ + Warnings?: Warnings; + } + export interface ReadPresetRequest { + /** + * The identifier of the preset for which you want to get detailed information. + */ + Id: Id; + } + export interface ReadPresetResponse { + /** + * A section of the response body that provides information about the preset. + */ + Preset?: Preset; + } + export type Resolution = string; + export type Role = string; + export type Rotate = string; + export type SizingPolicy = string; + export type SnsTopic = string; + export type SnsTopics = SnsTopic[]; + export type StorageClass = string; + export type String = string; + export type Success = string; + export type Target = string; + export interface TestRoleRequest { + /** + * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test. + */ + Role: Role; + /** + * The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket. + */ + InputBucket: BucketName; + /** + * The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket. + */ + OutputBucket: BucketName; + /** + * The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to. + */ + Topics: SnsTopics; + } + export interface TestRoleResponse { + /** + * If the operation is successful, this value is true; otherwise, the value is false. + */ + Success?: Success; + /** + * If the Success element contains false, this value is an array of one or more error messages that were generated during the test process. + */ + Messages?: ExceptionMessages; + } + export type ThumbnailPattern = string; + export type ThumbnailResolution = string; + export interface Thumbnails { + /** + * The format of thumbnails, if any. Valid values are jpg and png. You specify whether you want Elastic Transcoder to create thumbnails when you create a job. + */ + Format?: JpgOrPng; + /** + * The approximate number of seconds between thumbnails. Specify an integer value. + */ + Interval?: Digits; + /** + * To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object. + */ + Resolution?: ThumbnailResolution; + /** + * To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The aspect ratio of thumbnails. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file. + */ + AspectRatio?: AspectRatio; + /** + * The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096. + */ + MaxWidth?: DigitsOrAuto; + /** + * The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072. + */ + MaxHeight?: DigitsOrAuto; + /** + * Specify one of the following values to control scaling of thumbnails: Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails. ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. + */ + SizingPolicy?: SizingPolicy; + /** + * When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings. + */ + PaddingPolicy?: PaddingPolicy; + } + export type Time = string; + export type TimeOffset = string; + export interface TimeSpan { + /** + * The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file. + */ + StartTime?: Time; + /** + * The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file. If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message. + */ + Duration?: Time; + } + export interface Timing { + /** + * The time the job was submitted to Elastic Transcoder, in epoch milliseconds. + */ + SubmitTimeMillis?: NullableLong; + /** + * The time the job began transcoding, in epoch milliseconds. + */ + StartTimeMillis?: NullableLong; + /** + * The time the job finished transcoding, in epoch milliseconds. + */ + FinishTimeMillis?: NullableLong; + } + export interface UpdatePipelineNotificationsRequest { + /** + * The identifier of the pipeline for which you want to change notification settings. + */ + Id: Id; + /** + * The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic. Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic. + */ + Notifications: Notifications; + } + export interface UpdatePipelineNotificationsResponse { + /** + * A section of the response body that provides information about the pipeline associated with this notification. + */ + Pipeline?: Pipeline; + } + export interface UpdatePipelineRequest { + /** + * The ID of the pipeline that you want to update. + */ + Id: Id; + /** + * The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. Constraints: Maximum 40 characters + */ + Name?: Name; + /** + * The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks. + */ + InputBucket?: BucketName; + /** + * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline. + */ + Role?: Role; + /** + * The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + */ + AwsKmsKeyArn?: KeyArn; + /** + * The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic. Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic. Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic. + */ + Notifications?: Notifications; + /** + * The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. Grantee Type: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. + */ + ContentConfig?: PipelineOutputConfig; + /** + * The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails. If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. GranteeType: Specify the type of value that appears in the Grantee object: Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number. Email: The value in the Grantee object is the registered email address of an AWS account. Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket. + */ + ThumbnailConfig?: PipelineOutputConfig; + } + export interface UpdatePipelineResponse { + /** + * The pipeline updated by this UpdatePipelineResponse call. + */ + Pipeline?: Pipeline; + /** + * Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline. Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges. + */ + Warnings?: Warnings; + } + export interface UpdatePipelineStatusRequest { + /** + * The identifier of the pipeline to update. + */ + Id: Id; + /** + * The desired status of the pipeline: Active: The pipeline is processing jobs. Paused: The pipeline is not currently processing jobs. + */ + Status: PipelineStatus; + } + export interface UpdatePipelineStatusResponse { + /** + * A section of the response body that provides information about the pipeline. + */ + Pipeline?: Pipeline; + } + export type UserMetadata = {[key: string]: String}; + export type VerticalAlign = string; + export type VideoBitRate = string; + export type VideoCodec = string; + export interface VideoParameters { + /** + * The video codec for the output file. Valid values include gif, H.264, mpeg2, vp8, and vp9. You can only specify vp8 and vp9 when the container type is webm, gif when the container type is gif, and mpeg2 when the container type is mpg. + */ + Codec?: VideoCodec; + /** + * Profile (H.264/VP8/VP9 Only) The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles: baseline: The profile most commonly used for videoconferencing and for mobile applications. main: The profile used for standard-definition digital TV broadcasts. high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs. Level (H.264 Only) The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels: 1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1 MaxReferenceFrames (H.264 Only) Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following: Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16) where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the Level object. See the list below. (A macroblock is a block of pixels measuring 16x16.) 1 - 396 1b - 396 1.1 - 900 1.2 - 2376 1.3 - 2376 2 - 2376 2.1 - 4752 2.2 - 8100 3 - 8100 3.1 - 18000 3.2 - 20480 4 - 32768 4.1 - 32768 MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only) The maximum number of bits per second in a video buffer; the size of the buffer is specified by BufferSize. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video. BufferSize (Optional, H.264/MPEG2/VP8/VP9 only) The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify MaxBitRate and omit BufferSize, Elastic Transcoder sets BufferSize to 10 times the value of MaxBitRate. InterlacedMode (Optional, H.264/MPEG2 Only) The interlace mode for the output video. Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering. Valid values include Progressive (no interlacing, top to bottom), TopFirst (top field first), BottomFirst (bottom field first), and Auto. If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output. If Auto is specified, Elastic Transcoder interlaces the output. ColorSpaceConversionMode (Optional, H.264/MPEG2 Only) The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color. Bt.601 is the standard for standard definition video, while Bt.709 is the standard for high definition video. Valid values include None, Bt709toBt601, Bt601toBt709, and Auto. If you chose Auto for ColorSpaceConversionMode and your output is interlaced, your frame rate is one of 23.97, 24, 25, 29.97, 50, or 60, your SegmentDuration is null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions: Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709 Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709 HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies Bt709ToBt601 HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies Bt709ToBt601 Elastic Transcoder may change the behavior of the ColorspaceConversionMode Auto mode in the future. All outputs in a playlist must use the same ColorSpaceConversionMode. If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the color space of a file. If you are unsure what ColorSpaceConversionMode was applied to your output file, you can check the AppliedColorSpaceConversion parameter included in your job response. If your job does not have an AppliedColorSpaceConversion in its response, no ColorSpaceConversionMode was applied. ChromaSubsampling The sampling pattern for the chroma (color) channels of the output video. Valid values include yuv420p and yuv422p. yuv420p samples the chroma information of every other horizontal and every other vertical line, yuv422p samples the color information of every horizontal line and every other vertical line. LoopCount (Gif Only) The number of times you want the output gif to loop. Valid values include Infinite and integers between 0 and 100, inclusive. + */ + CodecOptions?: CodecOptions; + /** + * Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality. For Smooth outputs, the FrameRate must have a constant ratio to the KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels while the file is being played. For example, an input file can have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist of 90, 75, and 30, respectively. Alternately, this can be achieved by setting FrameRate to auto and having the same values for MaxFrameRate and KeyframesMaxDist. + */ + KeyframesMaxDist?: KeyframesMaxDist; + /** + * Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. Whether to use a fixed value for FixedGOP. Valid values are true and false: true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance between key frames (the number of frames in a group of pictures, or GOP). false: The distance between key frames can vary. FixedGOP must be set to true for fmp4 containers. + */ + FixedGOP?: FixedGOP; + /** + * The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. If you specify auto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than auto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile: Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile) 1 - 64 : 80 1b - 128 : 160 1.1 - 192 : 240 1.2 - 384 : 480 1.3 - 768 : 960 2 - 2000 : 2500 3 - 10000 : 12500 3.1 - 14000 : 17500 3.2 - 20000 : 25000 4 - 20000 : 25000 4.1 - 50000 : 62500 + */ + BitRate?: VideoBitRate; + /** + * The frames per second for the video stream in the output file. Valid values include: auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation: Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels) where: width in pixels and height in pixels represent the Resolution of the output video. maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level. The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed): 1 - 380160 1b - 380160 1.1 - 76800 1.2 - 1536000 1.3 - 3041280 2 - 3041280 2.1 - 5068800 2.2 - 5184000 3 - 10368000 3.1 - 27648000 3.2 - 55296000 4 - 62914560 4.1 - 62914560 + */ + FrameRate?: FrameRate; + /** + * If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60. + */ + MaxFrameRate?: MaxFrameRate; + /** + * To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The width and height of the video in the output file, in pixels. Valid values are auto and width x height: auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules. width x height : The width and height of the output video in pixels. Note the following about specifying the width and height: The width must be an even integer between 128 and 4096, inclusive. The height must be an even integer between 96 and 3072, inclusive. If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution. If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution. We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value): 1 - 25344 1b - 25344 1.1 - 101376 1.2 - 101376 1.3 - 101376 2 - 101376 2.1 - 202752 2.2 - 404720 3 - 404720 3.1 - 921600 3.2 - 1310720 4 - 2097152 4.1 - 2097152 + */ + Resolution?: Resolution; + /** + * To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together. The display aspect ratio of the video in the output file. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file. If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video. + */ + AspectRatio?: AspectRatio; + /** + * The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096. + */ + MaxWidth?: DigitsOrAuto; + /** + * The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072. + */ + MaxHeight?: DigitsOrAuto; + /** + * The value that Elastic Transcoder adds to the metadata in the output file. + */ + DisplayAspectRatio?: AspectRatio; + /** + * Specify one of the following values to control scaling of the output video: Fit: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value. Fill: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value. Stretch: Elastic Transcoder stretches the output video to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted. Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output video. ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up. ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up. + */ + SizingPolicy?: SizingPolicy; + /** + * When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for MaxWidth and MaxHeight. + */ + PaddingPolicy?: PaddingPolicy; + /** + * Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video. Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency. When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions. + */ + Watermarks?: PresetWatermarks; + } + export interface Warning { + /** + * The code of the cross-regional warning. + */ + Code?: String; + /** + * The message explaining what resources are in a different region from the pipeline. AWS KMS keys must be in the same region as the pipeline. + */ + Message?: String; + } + export type Warnings = Warning[]; + export type WatermarkKey = string; + export type WatermarkSizingPolicy = string; + export type ZeroTo255String = string; + export type ZeroTo512String = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-09-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ElasticTranscoder client. + */ + export import Types = ElasticTranscoder; +} +export = ElasticTranscoder; diff --git a/node_modules/aws-sdk/clients/elastictranscoder.js b/node_modules/aws-sdk/clients/elastictranscoder.js new file mode 100644 index 0000000..a2be9bf --- /dev/null +++ b/node_modules/aws-sdk/clients/elastictranscoder.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['elastictranscoder'] = {}; +AWS.ElasticTranscoder = Service.defineService('elastictranscoder', ['2012-09-25']); +Object.defineProperty(apiLoader.services['elastictranscoder'], '2012-09-25', { + get: function get() { + var model = require('../apis/elastictranscoder-2012-09-25.min.json'); + model.paginators = require('../apis/elastictranscoder-2012-09-25.paginators.json').pagination; + model.waiters = require('../apis/elastictranscoder-2012-09-25.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ElasticTranscoder; diff --git a/node_modules/aws-sdk/clients/elb.d.ts b/node_modules/aws-sdk/clients/elb.d.ts new file mode 100644 index 0000000..50dee99 --- /dev/null +++ b/node_modules/aws-sdk/clients/elb.d.ts @@ -0,0 +1,1204 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ELB extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ELB.Types.ClientConfiguration) + config: Config & ELB.Types.ClientConfiguration; + /** + * Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value. For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + addTags(params: ELB.Types.AddTagsInput, callback?: (err: AWSError, data: ELB.Types.AddTagsOutput) => void): Request; + /** + * Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value. For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + addTags(callback?: (err: AWSError, data: ELB.Types.AddTagsOutput) => void): Request; + /** + * Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups. For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide. + */ + applySecurityGroupsToLoadBalancer(params: ELB.Types.ApplySecurityGroupsToLoadBalancerInput, callback?: (err: AWSError, data: ELB.Types.ApplySecurityGroupsToLoadBalancerOutput) => void): Request; + /** + * Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups. For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide. + */ + applySecurityGroupsToLoadBalancer(callback?: (err: AWSError, data: ELB.Types.ApplySecurityGroupsToLoadBalancerOutput) => void): Request; + /** + * Adds one or more subnets to the set of configured subnets for the specified load balancer. The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide. + */ + attachLoadBalancerToSubnets(params: ELB.Types.AttachLoadBalancerToSubnetsInput, callback?: (err: AWSError, data: ELB.Types.AttachLoadBalancerToSubnetsOutput) => void): Request; + /** + * Adds one or more subnets to the set of configured subnets for the specified load balancer. The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide. + */ + attachLoadBalancerToSubnets(callback?: (err: AWSError, data: ELB.Types.AttachLoadBalancerToSubnetsOutput) => void): Request; + /** + * Specifies the health check settings to use when evaluating the health state of your EC2 instances. For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide. + */ + configureHealthCheck(params: ELB.Types.ConfigureHealthCheckInput, callback?: (err: AWSError, data: ELB.Types.ConfigureHealthCheckOutput) => void): Request; + /** + * Specifies the health check settings to use when evaluating the health state of your EC2 instances. For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide. + */ + configureHealthCheck(callback?: (err: AWSError, data: ELB.Types.ConfigureHealthCheckOutput) => void): Request; + /** + * Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie. If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued. For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide. + */ + createAppCookieStickinessPolicy(params: ELB.Types.CreateAppCookieStickinessPolicyInput, callback?: (err: AWSError, data: ELB.Types.CreateAppCookieStickinessPolicyOutput) => void): Request; + /** + * Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie. If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued. For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide. + */ + createAppCookieStickinessPolicy(callback?: (err: AWSError, data: ELB.Types.CreateAppCookieStickinessPolicyOutput) => void): Request; + /** + * Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm. A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration. For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide. + */ + createLBCookieStickinessPolicy(params: ELB.Types.CreateLBCookieStickinessPolicyInput, callback?: (err: AWSError, data: ELB.Types.CreateLBCookieStickinessPolicyOutput) => void): Request; + /** + * Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm. A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration. For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide. + */ + createLBCookieStickinessPolicy(callback?: (err: AWSError, data: ELB.Types.CreateLBCookieStickinessPolicyOutput) => void): Request; + /** + * Creates a Classic Load Balancer. You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + createLoadBalancer(params: ELB.Types.CreateAccessPointInput, callback?: (err: AWSError, data: ELB.Types.CreateAccessPointOutput) => void): Request; + /** + * Creates a Classic Load Balancer. You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + createLoadBalancer(callback?: (err: AWSError, data: ELB.Types.CreateAccessPointOutput) => void): Request; + /** + * Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener. For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + createLoadBalancerListeners(params: ELB.Types.CreateLoadBalancerListenerInput, callback?: (err: AWSError, data: ELB.Types.CreateLoadBalancerListenerOutput) => void): Request; + /** + * Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener. For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + createLoadBalancerListeners(callback?: (err: AWSError, data: ELB.Types.CreateLoadBalancerListenerOutput) => void): Request; + /** + * Creates a policy with the specified attributes for the specified load balancer. Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type. + */ + createLoadBalancerPolicy(params: ELB.Types.CreateLoadBalancerPolicyInput, callback?: (err: AWSError, data: ELB.Types.CreateLoadBalancerPolicyOutput) => void): Request; + /** + * Creates a policy with the specified attributes for the specified load balancer. Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type. + */ + createLoadBalancerPolicy(callback?: (err: AWSError, data: ELB.Types.CreateLoadBalancerPolicyOutput) => void): Request; + /** + * Deletes the specified load balancer. If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances. If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds. + */ + deleteLoadBalancer(params: ELB.Types.DeleteAccessPointInput, callback?: (err: AWSError, data: ELB.Types.DeleteAccessPointOutput) => void): Request; + /** + * Deletes the specified load balancer. If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances. If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds. + */ + deleteLoadBalancer(callback?: (err: AWSError, data: ELB.Types.DeleteAccessPointOutput) => void): Request; + /** + * Deletes the specified listeners from the specified load balancer. + */ + deleteLoadBalancerListeners(params: ELB.Types.DeleteLoadBalancerListenerInput, callback?: (err: AWSError, data: ELB.Types.DeleteLoadBalancerListenerOutput) => void): Request; + /** + * Deletes the specified listeners from the specified load balancer. + */ + deleteLoadBalancerListeners(callback?: (err: AWSError, data: ELB.Types.DeleteLoadBalancerListenerOutput) => void): Request; + /** + * Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. + */ + deleteLoadBalancerPolicy(params: ELB.Types.DeleteLoadBalancerPolicyInput, callback?: (err: AWSError, data: ELB.Types.DeleteLoadBalancerPolicyOutput) => void): Request; + /** + * Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. + */ + deleteLoadBalancerPolicy(callback?: (err: AWSError, data: ELB.Types.DeleteLoadBalancerPolicyOutput) => void): Request; + /** + * Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer. You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer. For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide. + */ + deregisterInstancesFromLoadBalancer(params: ELB.Types.DeregisterEndPointsInput, callback?: (err: AWSError, data: ELB.Types.DeregisterEndPointsOutput) => void): Request; + /** + * Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer. You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer. For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide. + */ + deregisterInstancesFromLoadBalancer(callback?: (err: AWSError, data: ELB.Types.DeregisterEndPointsOutput) => void): Request; + /** + * Describes the current Elastic Load Balancing resource limits for your AWS account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + describeAccountLimits(params: ELB.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: ELB.Types.DescribeAccountLimitsOutput) => void): Request; + /** + * Describes the current Elastic Load Balancing resource limits for your AWS account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + describeAccountLimits(callback?: (err: AWSError, data: ELB.Types.DescribeAccountLimitsOutput) => void): Request; + /** + * Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned. + */ + describeInstanceHealth(params: ELB.Types.DescribeEndPointStateInput, callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; + /** + * Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned. + */ + describeInstanceHealth(callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; + /** + * Describes the attributes for the specified load balancer. + */ + describeLoadBalancerAttributes(params: ELB.Types.DescribeLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELB.Types.DescribeLoadBalancerAttributesOutput) => void): Request; + /** + * Describes the attributes for the specified load balancer. + */ + describeLoadBalancerAttributes(callback?: (err: AWSError, data: ELB.Types.DescribeLoadBalancerAttributesOutput) => void): Request; + /** + * Describes the specified policies. If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix. + */ + describeLoadBalancerPolicies(params: ELB.Types.DescribeLoadBalancerPoliciesInput, callback?: (err: AWSError, data: ELB.Types.DescribeLoadBalancerPoliciesOutput) => void): Request; + /** + * Describes the specified policies. If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix. + */ + describeLoadBalancerPolicies(callback?: (err: AWSError, data: ELB.Types.DescribeLoadBalancerPoliciesOutput) => void): Request; + /** + * Describes the specified load balancer policy types or all load balancer policy types. The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances. You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy. + */ + describeLoadBalancerPolicyTypes(params: ELB.Types.DescribeLoadBalancerPolicyTypesInput, callback?: (err: AWSError, data: ELB.Types.DescribeLoadBalancerPolicyTypesOutput) => void): Request; + /** + * Describes the specified load balancer policy types or all load balancer policy types. The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances. You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy. + */ + describeLoadBalancerPolicyTypes(callback?: (err: AWSError, data: ELB.Types.DescribeLoadBalancerPolicyTypesOutput) => void): Request; + /** + * Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. + */ + describeLoadBalancers(params: ELB.Types.DescribeAccessPointsInput, callback?: (err: AWSError, data: ELB.Types.DescribeAccessPointsOutput) => void): Request; + /** + * Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. + */ + describeLoadBalancers(callback?: (err: AWSError, data: ELB.Types.DescribeAccessPointsOutput) => void): Request; + /** + * Describes the tags associated with the specified load balancers. + */ + describeTags(params: ELB.Types.DescribeTagsInput, callback?: (err: AWSError, data: ELB.Types.DescribeTagsOutput) => void): Request; + /** + * Describes the tags associated with the specified load balancers. + */ + describeTags(callback?: (err: AWSError, data: ELB.Types.DescribeTagsOutput) => void): Request; + /** + * Removes the specified subnets from the set of configured subnets for the load balancer. After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets. + */ + detachLoadBalancerFromSubnets(params: ELB.Types.DetachLoadBalancerFromSubnetsInput, callback?: (err: AWSError, data: ELB.Types.DetachLoadBalancerFromSubnetsOutput) => void): Request; + /** + * Removes the specified subnets from the set of configured subnets for the load balancer. After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets. + */ + detachLoadBalancerFromSubnets(callback?: (err: AWSError, data: ELB.Types.DetachLoadBalancerFromSubnetsOutput) => void): Request; + /** + * Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC. For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets. There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide. + */ + disableAvailabilityZonesForLoadBalancer(params: ELB.Types.RemoveAvailabilityZonesInput, callback?: (err: AWSError, data: ELB.Types.RemoveAvailabilityZonesOutput) => void): Request; + /** + * Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC. For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets. There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide. + */ + disableAvailabilityZonesForLoadBalancer(callback?: (err: AWSError, data: ELB.Types.RemoveAvailabilityZonesOutput) => void): Request; + /** + * Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC. For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets. The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide. + */ + enableAvailabilityZonesForLoadBalancer(params: ELB.Types.AddAvailabilityZonesInput, callback?: (err: AWSError, data: ELB.Types.AddAvailabilityZonesOutput) => void): Request; + /** + * Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC. For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets. The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide. + */ + enableAvailabilityZonesForLoadBalancer(callback?: (err: AWSError, data: ELB.Types.AddAvailabilityZonesOutput) => void): Request; + /** + * Modifies the attributes of the specified load balancer. You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer. For more information, see the following in the Classic Load Balancers Guide: Cross-Zone Load Balancing Connection Draining Access Logs Idle Connection Timeout + */ + modifyLoadBalancerAttributes(params: ELB.Types.ModifyLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELB.Types.ModifyLoadBalancerAttributesOutput) => void): Request; + /** + * Modifies the attributes of the specified load balancer. You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer. For more information, see the following in the Classic Load Balancers Guide: Cross-Zone Load Balancing Connection Draining Access Logs Idle Connection Timeout + */ + modifyLoadBalancerAttributes(callback?: (err: AWSError, data: ELB.Types.ModifyLoadBalancerAttributesOutput) => void): Request; + /** + * Adds the specified instances to the specified load balancer. The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC. Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth. After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer. For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide. + */ + registerInstancesWithLoadBalancer(params: ELB.Types.RegisterEndPointsInput, callback?: (err: AWSError, data: ELB.Types.RegisterEndPointsOutput) => void): Request; + /** + * Adds the specified instances to the specified load balancer. The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC. Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth. After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer. For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide. + */ + registerInstancesWithLoadBalancer(callback?: (err: AWSError, data: ELB.Types.RegisterEndPointsOutput) => void): Request; + /** + * Removes one or more tags from the specified load balancer. + */ + removeTags(params: ELB.Types.RemoveTagsInput, callback?: (err: AWSError, data: ELB.Types.RemoveTagsOutput) => void): Request; + /** + * Removes one or more tags from the specified load balancer. + */ + removeTags(callback?: (err: AWSError, data: ELB.Types.RemoveTagsOutput) => void): Request; + /** + * Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port. For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide. + */ + setLoadBalancerListenerSSLCertificate(params: ELB.Types.SetLoadBalancerListenerSSLCertificateInput, callback?: (err: AWSError, data: ELB.Types.SetLoadBalancerListenerSSLCertificateOutput) => void): Request; + /** + * Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port. For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide. + */ + setLoadBalancerListenerSSLCertificate(callback?: (err: AWSError, data: ELB.Types.SetLoadBalancerListenerSSLCertificateOutput) => void): Request; + /** + * Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies. Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable. You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance. For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide. + */ + setLoadBalancerPoliciesForBackendServer(params: ELB.Types.SetLoadBalancerPoliciesForBackendServerInput, callback?: (err: AWSError, data: ELB.Types.SetLoadBalancerPoliciesForBackendServerOutput) => void): Request; + /** + * Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies. Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable. You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance. For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide. + */ + setLoadBalancerPoliciesForBackendServer(callback?: (err: AWSError, data: ELB.Types.SetLoadBalancerPoliciesForBackendServerOutput) => void): Request; + /** + * Replaces the current set of policies for the specified load balancer port with the specified set of policies. To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer. For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide. + */ + setLoadBalancerPoliciesOfListener(params: ELB.Types.SetLoadBalancerPoliciesOfListenerInput, callback?: (err: AWSError, data: ELB.Types.SetLoadBalancerPoliciesOfListenerOutput) => void): Request; + /** + * Replaces the current set of policies for the specified load balancer port with the specified set of policies. To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer. For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide. + */ + setLoadBalancerPoliciesOfListener(callback?: (err: AWSError, data: ELB.Types.SetLoadBalancerPoliciesOfListenerOutput) => void): Request; + /** + * Waits for the instanceDeregistered state by periodically calling the underlying ELB.describeInstanceHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceDeregistered", params: ELB.Types.DescribeEndPointStateInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; + /** + * Waits for the instanceDeregistered state by periodically calling the underlying ELB.describeInstanceHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceDeregistered", callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; + /** + * Waits for the anyInstanceInService state by periodically calling the underlying ELB.describeInstanceHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "anyInstanceInService", params: ELB.Types.DescribeEndPointStateInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; + /** + * Waits for the anyInstanceInService state by periodically calling the underlying ELB.describeInstanceHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "anyInstanceInService", callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; + /** + * Waits for the instanceInService state by periodically calling the underlying ELB.describeInstanceHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceInService", params: ELB.Types.DescribeEndPointStateInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; + /** + * Waits for the instanceInService state by periodically calling the underlying ELB.describeInstanceHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "instanceInService", callback?: (err: AWSError, data: ELB.Types.DescribeEndPointStateOutput) => void): Request; +} +declare namespace ELB { + export interface AccessLog { + /** + * Specifies whether access logs are enabled for the load balancer. + */ + Enabled: AccessLogEnabled; + /** + * The name of the Amazon S3 bucket where the access logs are stored. + */ + S3BucketName?: S3BucketName; + /** + * The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes. Default: 60 minutes + */ + EmitInterval?: AccessLogInterval; + /** + * The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket. + */ + S3BucketPrefix?: AccessLogPrefix; + } + export type AccessLogEnabled = boolean; + export type AccessLogInterval = number; + export type AccessLogPrefix = string; + export type AccessPointName = string; + export type AccessPointPort = number; + export interface AddAvailabilityZonesInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The Availability Zones. These must be in the same region as the load balancer. + */ + AvailabilityZones: AvailabilityZones; + } + export interface AddAvailabilityZonesOutput { + /** + * The updated list of Availability Zones for the load balancer. + */ + AvailabilityZones?: AvailabilityZones; + } + export interface AddTagsInput { + /** + * The name of the load balancer. You can specify one load balancer only. + */ + LoadBalancerNames: LoadBalancerNames; + /** + * The tags. + */ + Tags: TagList; + } + export interface AddTagsOutput { + } + export interface AdditionalAttribute { + /** + * This parameter is reserved. + */ + Key?: AdditionalAttributeKey; + /** + * This parameter is reserved. + */ + Value?: AdditionalAttributeValue; + } + export type AdditionalAttributeKey = string; + export type AdditionalAttributeValue = string; + export type AdditionalAttributes = AdditionalAttribute[]; + export type AppCookieStickinessPolicies = AppCookieStickinessPolicy[]; + export interface AppCookieStickinessPolicy { + /** + * The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer. + */ + PolicyName?: PolicyName; + /** + * The name of the application cookie used for stickiness. + */ + CookieName?: CookieName; + } + export interface ApplySecurityGroupsToLoadBalancerInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group. + */ + SecurityGroups: SecurityGroups; + } + export interface ApplySecurityGroupsToLoadBalancerOutput { + /** + * The IDs of the security groups associated with the load balancer. + */ + SecurityGroups?: SecurityGroups; + } + export interface AttachLoadBalancerToSubnetsInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The IDs of the subnets to add. You can add only one subnet per Availability Zone. + */ + Subnets: Subnets; + } + export interface AttachLoadBalancerToSubnetsOutput { + /** + * The IDs of the subnets attached to the load balancer. + */ + Subnets?: Subnets; + } + export type AttributeName = string; + export type AttributeType = string; + export type AttributeValue = string; + export type AvailabilityZone = string; + export type AvailabilityZones = AvailabilityZone[]; + export interface BackendServerDescription { + /** + * The port on which the EC2 instance is listening. + */ + InstancePort?: InstancePort; + /** + * The names of the policies enabled for the EC2 instance. + */ + PolicyNames?: PolicyNames; + } + export type BackendServerDescriptions = BackendServerDescription[]; + export type Cardinality = string; + export interface ConfigureHealthCheckInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The configuration information. + */ + HealthCheck: HealthCheck; + } + export interface ConfigureHealthCheckOutput { + /** + * The updated health check. + */ + HealthCheck?: HealthCheck; + } + export interface ConnectionDraining { + /** + * Specifies whether connection draining is enabled for the load balancer. + */ + Enabled: ConnectionDrainingEnabled; + /** + * The maximum time, in seconds, to keep the existing connections open before deregistering the instances. + */ + Timeout?: ConnectionDrainingTimeout; + } + export type ConnectionDrainingEnabled = boolean; + export type ConnectionDrainingTimeout = number; + export interface ConnectionSettings { + /** + * The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer. + */ + IdleTimeout: IdleTimeout; + } + export type CookieExpirationPeriod = number; + export type CookieName = string; + export interface CreateAccessPointInput { + /** + * The name of the load balancer. This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen. + */ + LoadBalancerName: AccessPointName; + /** + * The listeners. For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + Listeners: Listeners; + /** + * One or more Availability Zones from the same region as the load balancer. You must specify at least one Availability Zone. You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones. + */ + Subnets?: Subnets; + /** + * The IDs of the security groups to assign to the load balancer. + */ + SecurityGroups?: SecurityGroups; + /** + * The type of a load balancer. Valid only for load balancers in a VPC. By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide. Specify internal to create a load balancer with a DNS name that resolves to private IP addresses. + */ + Scheme?: LoadBalancerScheme; + /** + * A list of tags to assign to the load balancer. For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide. + */ + Tags?: TagList; + } + export interface CreateAccessPointOutput { + /** + * The DNS name of the load balancer. + */ + DNSName?: DNSName; + } + export interface CreateAppCookieStickinessPolicyInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer. + */ + PolicyName: PolicyName; + /** + * The name of the application cookie used for stickiness. + */ + CookieName: CookieName; + } + export interface CreateAppCookieStickinessPolicyOutput { + } + export interface CreateLBCookieStickinessPolicyInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer. + */ + PolicyName: PolicyName; + /** + * The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session. + */ + CookieExpirationPeriod?: CookieExpirationPeriod; + } + export interface CreateLBCookieStickinessPolicyOutput { + } + export interface CreateLoadBalancerListenerInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The listeners. + */ + Listeners: Listeners; + } + export interface CreateLoadBalancerListenerOutput { + } + export interface CreateLoadBalancerPolicyInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer. + */ + PolicyName: PolicyName; + /** + * The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes. + */ + PolicyTypeName: PolicyTypeName; + /** + * The policy attributes. + */ + PolicyAttributes?: PolicyAttributes; + } + export interface CreateLoadBalancerPolicyOutput { + } + export type CreatedTime = Date; + export interface CrossZoneLoadBalancing { + /** + * Specifies whether cross-zone load balancing is enabled for the load balancer. + */ + Enabled: CrossZoneLoadBalancingEnabled; + } + export type CrossZoneLoadBalancingEnabled = boolean; + export type DNSName = string; + export type DefaultValue = string; + export interface DeleteAccessPointInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + } + export interface DeleteAccessPointOutput { + } + export interface DeleteLoadBalancerListenerInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The client port numbers of the listeners. + */ + LoadBalancerPorts: Ports; + } + export interface DeleteLoadBalancerListenerOutput { + } + export interface DeleteLoadBalancerPolicyInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The name of the policy. + */ + PolicyName: PolicyName; + } + export interface DeleteLoadBalancerPolicyOutput { + } + export interface DeregisterEndPointsInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The IDs of the instances. + */ + Instances: Instances; + } + export interface DeregisterEndPointsOutput { + /** + * The remaining instances registered with the load balancer. + */ + Instances?: Instances; + } + export interface DescribeAccessPointsInput { + /** + * The names of the load balancers. + */ + LoadBalancerNames?: LoadBalancerNames; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call (a number from 1 to 400). The default is 400. + */ + PageSize?: PageSize; + } + export interface DescribeAccessPointsOutput { + /** + * Information about the load balancers. + */ + LoadBalancerDescriptions?: LoadBalancerDescriptions; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeAccountLimitsInput { + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeAccountLimitsOutput { + /** + * Information about the limits. + */ + Limits?: Limits; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeEndPointStateInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The IDs of the instances. + */ + Instances?: Instances; + } + export interface DescribeEndPointStateOutput { + /** + * Information about the health of the instances. + */ + InstanceStates?: InstanceStates; + } + export interface DescribeLoadBalancerAttributesInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + } + export interface DescribeLoadBalancerAttributesOutput { + /** + * Information about the load balancer attributes. + */ + LoadBalancerAttributes?: LoadBalancerAttributes; + } + export interface DescribeLoadBalancerPoliciesInput { + /** + * The name of the load balancer. + */ + LoadBalancerName?: AccessPointName; + /** + * The names of the policies. + */ + PolicyNames?: PolicyNames; + } + export interface DescribeLoadBalancerPoliciesOutput { + /** + * Information about the policies. + */ + PolicyDescriptions?: PolicyDescriptions; + } + export interface DescribeLoadBalancerPolicyTypesInput { + /** + * The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing. + */ + PolicyTypeNames?: PolicyTypeNames; + } + export interface DescribeLoadBalancerPolicyTypesOutput { + /** + * Information about the policy types. + */ + PolicyTypeDescriptions?: PolicyTypeDescriptions; + } + export interface DescribeTagsInput { + /** + * The names of the load balancers. + */ + LoadBalancerNames: LoadBalancerNamesMax20; + } + export interface DescribeTagsOutput { + /** + * Information about the tags. + */ + TagDescriptions?: TagDescriptions; + } + export type Description = string; + export interface DetachLoadBalancerFromSubnetsInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The IDs of the subnets. + */ + Subnets: Subnets; + } + export interface DetachLoadBalancerFromSubnetsOutput { + /** + * The IDs of the remaining subnets for the load balancer. + */ + Subnets?: Subnets; + } + export type EndPointPort = number; + export interface HealthCheck { + /** + * The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535. TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. SSL is also specified as SSL: port pair, for example, SSL:5000. For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy. The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less. + */ + Target: HealthCheckTarget; + /** + * The approximate interval, in seconds, between health checks of an individual instance. + */ + Interval: HealthCheckInterval; + /** + * The amount of time, in seconds, during which no response means a failed health check. This value must be less than the Interval value. + */ + Timeout: HealthCheckTimeout; + /** + * The number of consecutive health check failures required before moving the instance to the Unhealthy state. + */ + UnhealthyThreshold: UnhealthyThreshold; + /** + * The number of consecutive health checks successes required before moving the instance to the Healthy state. + */ + HealthyThreshold: HealthyThreshold; + } + export type HealthCheckInterval = number; + export type HealthCheckTarget = string; + export type HealthCheckTimeout = number; + export type HealthyThreshold = number; + export type IdleTimeout = number; + export interface Instance { + /** + * The instance ID. + */ + InstanceId?: InstanceId; + } + export type InstanceId = string; + export type InstancePort = number; + export interface InstanceState { + /** + * The ID of the instance. + */ + InstanceId?: InstanceId; + /** + * The current state of the instance. Valid values: InService | OutOfService | Unknown + */ + State?: State; + /** + * Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance. Valid values: ELB | Instance | N/A + */ + ReasonCode?: ReasonCode; + /** + * A description of the instance state. This string can contain one or more of the following messages. N/A A transient error occurred. Please try again later. Instance has failed at least the UnhealthyThreshold number of health checks consecutively. Instance has not passed the configured HealthyThreshold number of health checks consecutively. Instance registration is still in progress. Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to. Instance is not currently registered with the LoadBalancer. Instance deregistration currently in progress. Disable Availability Zone is currently in progress. Instance is in pending state. Instance is in stopped state. Instance is in terminated state. + */ + Description?: Description; + } + export type InstanceStates = InstanceState[]; + export type Instances = Instance[]; + export type LBCookieStickinessPolicies = LBCookieStickinessPolicy[]; + export interface LBCookieStickinessPolicy { + /** + * The name of the policy. This name must be unique within the set of policies for this load balancer. + */ + PolicyName?: PolicyName; + /** + * The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session. + */ + CookieExpirationPeriod?: CookieExpirationPeriod; + } + export interface Limit { + /** + * The name of the limit. The possible values are: classic-listeners classic-load-balancers classic-registered-instances + */ + Name?: Name; + /** + * The maximum value of the limit. + */ + Max?: Max; + } + export type Limits = Limit[]; + export interface Listener { + /** + * The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL. + */ + Protocol: Protocol; + /** + * The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535. + */ + LoadBalancerPort: AccessPointPort; + /** + * The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL. If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol. If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP. + */ + InstanceProtocol?: Protocol; + /** + * The port on which the instance is listening. + */ + InstancePort: InstancePort; + /** + * The Amazon Resource Name (ARN) of the server certificate. + */ + SSLCertificateId?: SSLCertificateId; + } + export interface ListenerDescription { + /** + * The listener. + */ + Listener?: Listener; + /** + * The policies. If there are no policies enabled, the list is empty. + */ + PolicyNames?: PolicyNames; + } + export type ListenerDescriptions = ListenerDescription[]; + export type Listeners = Listener[]; + export interface LoadBalancerAttributes { + /** + * If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones. For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide. + */ + CrossZoneLoadBalancing?: CrossZoneLoadBalancing; + /** + * If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify. For more information, see Enable Access Logs in the Classic Load Balancers Guide. + */ + AccessLog?: AccessLog; + /** + * If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance. For more information, see Configure Connection Draining in the Classic Load Balancers Guide. + */ + ConnectionDraining?: ConnectionDraining; + /** + * If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration. By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide. + */ + ConnectionSettings?: ConnectionSettings; + /** + * This parameter is reserved. + */ + AdditionalAttributes?: AdditionalAttributes; + } + export interface LoadBalancerDescription { + /** + * The name of the load balancer. + */ + LoadBalancerName?: AccessPointName; + /** + * The DNS name of the load balancer. + */ + DNSName?: DNSName; + /** + * The DNS name of the load balancer. For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide. + */ + CanonicalHostedZoneName?: DNSName; + /** + * The ID of the Amazon Route 53 hosted zone for the load balancer. + */ + CanonicalHostedZoneNameID?: DNSName; + /** + * The listeners for the load balancer. + */ + ListenerDescriptions?: ListenerDescriptions; + /** + * The policies defined for the load balancer. + */ + Policies?: Policies; + /** + * Information about your EC2 instances. + */ + BackendServerDescriptions?: BackendServerDescriptions; + /** + * The Availability Zones for the load balancer. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The IDs of the subnets for the load balancer. + */ + Subnets?: Subnets; + /** + * The ID of the VPC for the load balancer. + */ + VPCId?: VPCId; + /** + * The IDs of the instances for the load balancer. + */ + Instances?: Instances; + /** + * Information about the health checks conducted on the load balancer. + */ + HealthCheck?: HealthCheck; + /** + * The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source. + */ + SourceSecurityGroup?: SourceSecurityGroup; + /** + * The security groups for the load balancer. Valid only for load balancers in a VPC. + */ + SecurityGroups?: SecurityGroups; + /** + * The date and time the load balancer was created. + */ + CreatedTime?: CreatedTime; + /** + * The type of load balancer. Valid only for load balancers in a VPC. If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address. If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address. + */ + Scheme?: LoadBalancerScheme; + } + export type LoadBalancerDescriptions = LoadBalancerDescription[]; + export type LoadBalancerNames = AccessPointName[]; + export type LoadBalancerNamesMax20 = AccessPointName[]; + export type LoadBalancerScheme = string; + export type Marker = string; + export type Max = string; + export interface ModifyLoadBalancerAttributesInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The attributes for the load balancer. + */ + LoadBalancerAttributes: LoadBalancerAttributes; + } + export interface ModifyLoadBalancerAttributesOutput { + /** + * The name of the load balancer. + */ + LoadBalancerName?: AccessPointName; + /** + * Information about the load balancer attributes. + */ + LoadBalancerAttributes?: LoadBalancerAttributes; + } + export type Name = string; + export type PageSize = number; + export interface Policies { + /** + * The stickiness policies created using CreateAppCookieStickinessPolicy. + */ + AppCookieStickinessPolicies?: AppCookieStickinessPolicies; + /** + * The stickiness policies created using CreateLBCookieStickinessPolicy. + */ + LBCookieStickinessPolicies?: LBCookieStickinessPolicies; + /** + * The policies other than the stickiness policies. + */ + OtherPolicies?: PolicyNames; + } + export interface PolicyAttribute { + /** + * The name of the attribute. + */ + AttributeName?: AttributeName; + /** + * The value of the attribute. + */ + AttributeValue?: AttributeValue; + } + export interface PolicyAttributeDescription { + /** + * The name of the attribute. + */ + AttributeName?: AttributeName; + /** + * The value of the attribute. + */ + AttributeValue?: AttributeValue; + } + export type PolicyAttributeDescriptions = PolicyAttributeDescription[]; + export interface PolicyAttributeTypeDescription { + /** + * The name of the attribute. + */ + AttributeName?: AttributeName; + /** + * The type of the attribute. For example, Boolean or Integer. + */ + AttributeType?: AttributeType; + /** + * A description of the attribute. + */ + Description?: Description; + /** + * The default value of the attribute, if applicable. + */ + DefaultValue?: DefaultValue; + /** + * The cardinality of the attribute. Valid values: ONE(1) : Single value required ZERO_OR_ONE(0..1) : Up to one value is allowed ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed ONE_OR_MORE(1..*0) : Required. Multiple values are allowed + */ + Cardinality?: Cardinality; + } + export type PolicyAttributeTypeDescriptions = PolicyAttributeTypeDescription[]; + export type PolicyAttributes = PolicyAttribute[]; + export interface PolicyDescription { + /** + * The name of the policy. + */ + PolicyName?: PolicyName; + /** + * The name of the policy type. + */ + PolicyTypeName?: PolicyTypeName; + /** + * The policy attributes. + */ + PolicyAttributeDescriptions?: PolicyAttributeDescriptions; + } + export type PolicyDescriptions = PolicyDescription[]; + export type PolicyName = string; + export type PolicyNames = PolicyName[]; + export interface PolicyTypeDescription { + /** + * The name of the policy type. + */ + PolicyTypeName?: PolicyTypeName; + /** + * A description of the policy type. + */ + Description?: Description; + /** + * The description of the policy attributes associated with the policies defined by Elastic Load Balancing. + */ + PolicyAttributeTypeDescriptions?: PolicyAttributeTypeDescriptions; + } + export type PolicyTypeDescriptions = PolicyTypeDescription[]; + export type PolicyTypeName = string; + export type PolicyTypeNames = PolicyTypeName[]; + export type Ports = AccessPointPort[]; + export type Protocol = string; + export type ReasonCode = string; + export interface RegisterEndPointsInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The IDs of the instances. + */ + Instances: Instances; + } + export interface RegisterEndPointsOutput { + /** + * The updated list of instances for the load balancer. + */ + Instances?: Instances; + } + export interface RemoveAvailabilityZonesInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The Availability Zones. + */ + AvailabilityZones: AvailabilityZones; + } + export interface RemoveAvailabilityZonesOutput { + /** + * The remaining Availability Zones for the load balancer. + */ + AvailabilityZones?: AvailabilityZones; + } + export interface RemoveTagsInput { + /** + * The name of the load balancer. You can specify a maximum of one load balancer name. + */ + LoadBalancerNames: LoadBalancerNames; + /** + * The list of tag keys to remove. + */ + Tags: TagKeyList; + } + export interface RemoveTagsOutput { + } + export type S3BucketName = string; + export type SSLCertificateId = string; + export type SecurityGroupId = string; + export type SecurityGroupName = string; + export type SecurityGroupOwnerAlias = string; + export type SecurityGroups = SecurityGroupId[]; + export interface SetLoadBalancerListenerSSLCertificateInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The port that uses the specified SSL certificate. + */ + LoadBalancerPort: AccessPointPort; + /** + * The Amazon Resource Name (ARN) of the SSL certificate. + */ + SSLCertificateId: SSLCertificateId; + } + export interface SetLoadBalancerListenerSSLCertificateOutput { + } + export interface SetLoadBalancerPoliciesForBackendServerInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The port number associated with the EC2 instance. + */ + InstancePort: EndPointPort; + /** + * The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance. + */ + PolicyNames: PolicyNames; + } + export interface SetLoadBalancerPoliciesForBackendServerOutput { + } + export interface SetLoadBalancerPoliciesOfListenerInput { + /** + * The name of the load balancer. + */ + LoadBalancerName: AccessPointName; + /** + * The external port of the load balancer. + */ + LoadBalancerPort: AccessPointPort; + /** + * The names of the policies. This list must include all policies to be enabled. If you omit a policy that is currently enabled, it is disabled. If the list is empty, all current policies are disabled. + */ + PolicyNames: PolicyNames; + } + export interface SetLoadBalancerPoliciesOfListenerOutput { + } + export interface SourceSecurityGroup { + /** + * The owner of the security group. + */ + OwnerAlias?: SecurityGroupOwnerAlias; + /** + * The name of the security group. + */ + GroupName?: SecurityGroupName; + } + export type State = string; + export type SubnetId = string; + export type Subnets = SubnetId[]; + export interface Tag { + /** + * The key of the tag. + */ + Key: TagKey; + /** + * The value of the tag. + */ + Value?: TagValue; + } + export interface TagDescription { + /** + * The name of the load balancer. + */ + LoadBalancerName?: AccessPointName; + /** + * The tags. + */ + Tags?: TagList; + } + export type TagDescriptions = TagDescription[]; + export type TagKey = string; + export type TagKeyList = TagKeyOnly[]; + export interface TagKeyOnly { + /** + * The name of the key. + */ + Key?: TagKey; + } + export type TagList = Tag[]; + export type TagValue = string; + export type UnhealthyThreshold = number; + export type VPCId = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-06-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ELB client. + */ + export import Types = ELB; +} +export = ELB; diff --git a/node_modules/aws-sdk/clients/elb.js b/node_modules/aws-sdk/clients/elb.js new file mode 100644 index 0000000..361acbb --- /dev/null +++ b/node_modules/aws-sdk/clients/elb.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['elb'] = {}; +AWS.ELB = Service.defineService('elb', ['2012-06-01']); +Object.defineProperty(apiLoader.services['elb'], '2012-06-01', { + get: function get() { + var model = require('../apis/elasticloadbalancing-2012-06-01.min.json'); + model.paginators = require('../apis/elasticloadbalancing-2012-06-01.paginators.json').pagination; + model.waiters = require('../apis/elasticloadbalancing-2012-06-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ELB; diff --git a/node_modules/aws-sdk/clients/elbv2.d.ts b/node_modules/aws-sdk/clients/elbv2.d.ts new file mode 100644 index 0000000..668dd5c --- /dev/null +++ b/node_modules/aws-sdk/clients/elbv2.d.ts @@ -0,0 +1,1718 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ELBv2 extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ELBv2.Types.ClientConfiguration) + config: Config & ELBv2.Types.ClientConfiguration; + /** + * Adds the specified certificate to the specified HTTPS listener. If the certificate was already added, the call is successful but the certificate is not added again. To list the certificates for your listener, use DescribeListenerCertificates. To remove certificates from your listener, use RemoveListenerCertificates. To specify the default SSL server certificate, use ModifyListener. + */ + addListenerCertificates(params: ELBv2.Types.AddListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.AddListenerCertificatesOutput) => void): Request; + /** + * Adds the specified certificate to the specified HTTPS listener. If the certificate was already added, the call is successful but the certificate is not added again. To list the certificates for your listener, use DescribeListenerCertificates. To remove certificates from your listener, use RemoveListenerCertificates. To specify the default SSL server certificate, use ModifyListener. + */ + addListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.AddListenerCertificatesOutput) => void): Request; + /** + * Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags. + */ + addTags(params: ELBv2.Types.AddTagsInput, callback?: (err: AWSError, data: ELBv2.Types.AddTagsOutput) => void): Request; + /** + * Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags. + */ + addTags(callback?: (err: AWSError, data: ELBv2.Types.AddTagsOutput) => void): Request; + /** + * Creates a listener for the specified Application Load Balancer or Network Load Balancer. To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds. For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide. + */ + createListener(params: ELBv2.Types.CreateListenerInput, callback?: (err: AWSError, data: ELBv2.Types.CreateListenerOutput) => void): Request; + /** + * Creates a listener for the specified Application Load Balancer or Network Load Balancer. To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds. For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide. + */ + createListener(callback?: (err: AWSError, data: ELBv2.Types.CreateListenerOutput) => void): Request; + /** + * Creates an Application Load Balancer or a Network Load Balancer. When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags. To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide. + */ + createLoadBalancer(params: ELBv2.Types.CreateLoadBalancerInput, callback?: (err: AWSError, data: ELBv2.Types.CreateLoadBalancerOutput) => void): Request; + /** + * Creates an Application Load Balancer or a Network Load Balancer. When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags. To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide. + */ + createLoadBalancer(callback?: (err: AWSError, data: ELBv2.Types.CreateLoadBalancerOutput) => void): Request; + /** + * Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide. To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule. + */ + createRule(params: ELBv2.Types.CreateRuleInput, callback?: (err: AWSError, data: ELBv2.Types.CreateRuleOutput) => void): Request; + /** + * Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide. To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule. + */ + createRule(callback?: (err: AWSError, data: ELBv2.Types.CreateRuleOutput) => void): Request; + /** + * Creates a target group. To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth. To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule. To delete a target group, use DeleteTargetGroup. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds. For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide. + */ + createTargetGroup(params: ELBv2.Types.CreateTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.CreateTargetGroupOutput) => void): Request; + /** + * Creates a target group. To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth. To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule. To delete a target group, use DeleteTargetGroup. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds. For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide. + */ + createTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.CreateTargetGroupOutput) => void): Request; + /** + * Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer. + */ + deleteListener(params: ELBv2.Types.DeleteListenerInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteListenerOutput) => void): Request; + /** + * Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer. + */ + deleteListener(callback?: (err: AWSError, data: ELBv2.Types.DeleteListenerOutput) => void): Request; + /** + * Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them. + */ + deleteLoadBalancer(params: ELBv2.Types.DeleteLoadBalancerInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteLoadBalancerOutput) => void): Request; + /** + * Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them. + */ + deleteLoadBalancer(callback?: (err: AWSError, data: ELBv2.Types.DeleteLoadBalancerOutput) => void): Request; + /** + * Deletes the specified rule. + */ + deleteRule(params: ELBv2.Types.DeleteRuleInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteRuleOutput) => void): Request; + /** + * Deletes the specified rule. + */ + deleteRule(callback?: (err: AWSError, data: ELBv2.Types.DeleteRuleOutput) => void): Request; + /** + * Deletes the specified target group. You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. + */ + deleteTargetGroup(params: ELBv2.Types.DeleteTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteTargetGroupOutput) => void): Request; + /** + * Deletes the specified target group. You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. + */ + deleteTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.DeleteTargetGroupOutput) => void): Request; + /** + * Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer. + */ + deregisterTargets(params: ELBv2.Types.DeregisterTargetsInput, callback?: (err: AWSError, data: ELBv2.Types.DeregisterTargetsOutput) => void): Request; + /** + * Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer. + */ + deregisterTargets(callback?: (err: AWSError, data: ELBv2.Types.DeregisterTargetsOutput) => void): Request; + /** + * Describes the current Elastic Load Balancing resource limits for your AWS account. For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide. + */ + describeAccountLimits(params: ELBv2.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeAccountLimitsOutput) => void): Request; + /** + * Describes the current Elastic Load Balancing resource limits for your AWS account. For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide. + */ + describeAccountLimits(callback?: (err: AWSError, data: ELBv2.Types.DescribeAccountLimitsOutput) => void): Request; + /** + * Describes the certificates for the specified HTTPS listener. + */ + describeListenerCertificates(params: ELBv2.Types.DescribeListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeListenerCertificatesOutput) => void): Request; + /** + * Describes the certificates for the specified HTTPS listener. + */ + describeListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.DescribeListenerCertificatesOutput) => void): Request; + /** + * Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners. + */ + describeListeners(params: ELBv2.Types.DescribeListenersInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeListenersOutput) => void): Request; + /** + * Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners. + */ + describeListeners(callback?: (err: AWSError, data: ELBv2.Types.DescribeListenersOutput) => void): Request; + /** + * Describes the attributes for the specified Application Load Balancer or Network Load Balancer. For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide. + */ + describeLoadBalancerAttributes(params: ELBv2.Types.DescribeLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancerAttributesOutput) => void): Request; + /** + * Describes the attributes for the specified Application Load Balancer or Network Load Balancer. For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide. + */ + describeLoadBalancerAttributes(callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancerAttributesOutput) => void): Request; + /** + * Describes the specified load balancers or all of your load balancers. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes. + */ + describeLoadBalancers(params: ELBv2.Types.DescribeLoadBalancersInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Describes the specified load balancers or all of your load balancers. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes. + */ + describeLoadBalancers(callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules. + */ + describeRules(params: ELBv2.Types.DescribeRulesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeRulesOutput) => void): Request; + /** + * Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules. + */ + describeRules(callback?: (err: AWSError, data: ELBv2.Types.DescribeRulesOutput) => void): Request; + /** + * Describes the specified policies or all policies used for SSL negotiation. For more information, see Security Policies in the Application Load Balancers Guide. + */ + describeSSLPolicies(params: ELBv2.Types.DescribeSSLPoliciesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeSSLPoliciesOutput) => void): Request; + /** + * Describes the specified policies or all policies used for SSL negotiation. For more information, see Security Policies in the Application Load Balancers Guide. + */ + describeSSLPolicies(callback?: (err: AWSError, data: ELBv2.Types.DescribeSSLPoliciesOutput) => void): Request; + /** + * Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups. + */ + describeTags(params: ELBv2.Types.DescribeTagsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTagsOutput) => void): Request; + /** + * Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups. + */ + describeTags(callback?: (err: AWSError, data: ELBv2.Types.DescribeTagsOutput) => void): Request; + /** + * Describes the attributes for the specified target group. For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide. + */ + describeTargetGroupAttributes(params: ELBv2.Types.DescribeTargetGroupAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupAttributesOutput) => void): Request; + /** + * Describes the attributes for the specified target group. For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide. + */ + describeTargetGroupAttributes(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupAttributesOutput) => void): Request; + /** + * Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups. To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes. + */ + describeTargetGroups(params: ELBv2.Types.DescribeTargetGroupsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupsOutput) => void): Request; + /** + * Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups. To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes. + */ + describeTargetGroups(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupsOutput) => void): Request; + /** + * Describes the health of the specified targets or all of your targets. + */ + describeTargetHealth(params: ELBv2.Types.DescribeTargetHealthInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request; + /** + * Describes the health of the specified targets or all of your targets. + */ + describeTargetHealth(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request; + /** + * Modifies the specified properties of the specified listener. Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and server certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and server certificate properties. + */ + modifyListener(params: ELBv2.Types.ModifyListenerInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyListenerOutput) => void): Request; + /** + * Modifies the specified properties of the specified listener. Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and server certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and server certificate properties. + */ + modifyListener(callback?: (err: AWSError, data: ELBv2.Types.ModifyListenerOutput) => void): Request; + /** + * Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer. If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values. + */ + modifyLoadBalancerAttributes(params: ELBv2.Types.ModifyLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyLoadBalancerAttributesOutput) => void): Request; + /** + * Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer. If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values. + */ + modifyLoadBalancerAttributes(callback?: (err: AWSError, data: ELBv2.Types.ModifyLoadBalancerAttributesOutput) => void): Request; + /** + * Modifies the specified rule. Any existing properties that you do not modify retain their current values. To modify the actions for the default rule, use ModifyListener. + */ + modifyRule(params: ELBv2.Types.ModifyRuleInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyRuleOutput) => void): Request; + /** + * Modifies the specified rule. Any existing properties that you do not modify retain their current values. To modify the actions for the default rule, use ModifyListener. + */ + modifyRule(callback?: (err: AWSError, data: ELBv2.Types.ModifyRuleOutput) => void): Request; + /** + * Modifies the health checks used when evaluating the health state of the targets in the specified target group. To monitor the health of the targets, use DescribeTargetHealth. + */ + modifyTargetGroup(params: ELBv2.Types.ModifyTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupOutput) => void): Request; + /** + * Modifies the health checks used when evaluating the health state of the targets in the specified target group. To monitor the health of the targets, use DescribeTargetHealth. + */ + modifyTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupOutput) => void): Request; + /** + * Modifies the specified attributes of the specified target group. + */ + modifyTargetGroupAttributes(params: ELBv2.Types.ModifyTargetGroupAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupAttributesOutput) => void): Request; + /** + * Modifies the specified attributes of the specified target group. + */ + modifyTargetGroupAttributes(callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupAttributesOutput) => void): Request; + /** + * Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address. To remove a target from a target group, use DeregisterTargets. + */ + registerTargets(params: ELBv2.Types.RegisterTargetsInput, callback?: (err: AWSError, data: ELBv2.Types.RegisterTargetsOutput) => void): Request; + /** + * Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address. To remove a target from a target group, use DeregisterTargets. + */ + registerTargets(callback?: (err: AWSError, data: ELBv2.Types.RegisterTargetsOutput) => void): Request; + /** + * Removes the specified certificate from the specified HTTPS listener. You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener. To list the certificates for your listener, use DescribeListenerCertificates. + */ + removeListenerCertificates(params: ELBv2.Types.RemoveListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.RemoveListenerCertificatesOutput) => void): Request; + /** + * Removes the specified certificate from the specified HTTPS listener. You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener. To list the certificates for your listener, use DescribeListenerCertificates. + */ + removeListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.RemoveListenerCertificatesOutput) => void): Request; + /** + * Removes the specified tags from the specified Elastic Load Balancing resource. To list the current tags for your resources, use DescribeTags. + */ + removeTags(params: ELBv2.Types.RemoveTagsInput, callback?: (err: AWSError, data: ELBv2.Types.RemoveTagsOutput) => void): Request; + /** + * Removes the specified tags from the specified Elastic Load Balancing resource. To list the current tags for your resources, use DescribeTags. + */ + removeTags(callback?: (err: AWSError, data: ELBv2.Types.RemoveTagsOutput) => void): Request; + /** + * Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer. Network Load Balancers must use ipv4. + */ + setIpAddressType(params: ELBv2.Types.SetIpAddressTypeInput, callback?: (err: AWSError, data: ELBv2.Types.SetIpAddressTypeOutput) => void): Request; + /** + * Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer. Network Load Balancers must use ipv4. + */ + setIpAddressType(callback?: (err: AWSError, data: ELBv2.Types.SetIpAddressTypeOutput) => void): Request; + /** + * Sets the priorities of the specified rules. You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority. + */ + setRulePriorities(params: ELBv2.Types.SetRulePrioritiesInput, callback?: (err: AWSError, data: ELBv2.Types.SetRulePrioritiesOutput) => void): Request; + /** + * Sets the priorities of the specified rules. You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority. + */ + setRulePriorities(callback?: (err: AWSError, data: ELBv2.Types.SetRulePrioritiesOutput) => void): Request; + /** + * Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups. You can't specify a security group for a Network Load Balancer. + */ + setSecurityGroups(params: ELBv2.Types.SetSecurityGroupsInput, callback?: (err: AWSError, data: ELBv2.Types.SetSecurityGroupsOutput) => void): Request; + /** + * Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups. You can't specify a security group for a Network Load Balancer. + */ + setSecurityGroups(callback?: (err: AWSError, data: ELBv2.Types.SetSecurityGroupsOutput) => void): Request; + /** + * Enables the Availability Zone for the specified public subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets. You can't change the subnets for a Network Load Balancer. + */ + setSubnets(params: ELBv2.Types.SetSubnetsInput, callback?: (err: AWSError, data: ELBv2.Types.SetSubnetsOutput) => void): Request; + /** + * Enables the Availability Zone for the specified public subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets. You can't change the subnets for a Network Load Balancer. + */ + setSubnets(callback?: (err: AWSError, data: ELBv2.Types.SetSubnetsOutput) => void): Request; + /** + * Waits for the loadBalancerExists state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "loadBalancerExists", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Waits for the loadBalancerExists state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "loadBalancerExists", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Waits for the loadBalancerAvailable state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "loadBalancerAvailable", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Waits for the loadBalancerAvailable state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "loadBalancerAvailable", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Waits for the loadBalancersDeleted state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "loadBalancersDeleted", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Waits for the loadBalancersDeleted state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "loadBalancersDeleted", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request; + /** + * Waits for the targetInService state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "targetInService", params: ELBv2.Types.DescribeTargetHealthInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request; + /** + * Waits for the targetInService state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "targetInService", callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request; + /** + * Waits for the targetDeregistered state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "targetDeregistered", params: ELBv2.Types.DescribeTargetHealthInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request; + /** + * Waits for the targetDeregistered state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). + */ + waitFor(state: "targetDeregistered", callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request; +} +declare namespace ELBv2 { + export interface Action { + /** + * The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect. + */ + Type: ActionTypeEnum; + /** + * The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward. + */ + TargetGroupArn?: TargetGroupArn; + /** + * [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc. + */ + AuthenticateOidcConfig?: AuthenticateOidcActionConfig; + /** + * [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito. + */ + AuthenticateCognitoConfig?: AuthenticateCognitoActionConfig; + /** + * The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The final action to be performed must be a forward or a fixed-response action. + */ + Order?: ActionOrder; + /** + * [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect. + */ + RedirectConfig?: RedirectActionConfig; + /** + * [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response. + */ + FixedResponseConfig?: FixedResponseActionConfig; + } + export type ActionOrder = number; + export type ActionTypeEnum = "forward"|"authenticate-oidc"|"authenticate-cognito"|"redirect"|"fixed-response"|string; + export type Actions = Action[]; + export interface AddListenerCertificatesInput { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: ListenerArn; + /** + * The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault. + */ + Certificates: CertificateList; + } + export interface AddListenerCertificatesOutput { + /** + * Information about the certificates. + */ + Certificates?: CertificateList; + } + export interface AddTagsInput { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArns: ResourceArns; + /** + * The tags. Each resource can have a maximum of 10 tags. + */ + Tags: TagList; + } + export interface AddTagsOutput { + } + export type AllocationId = string; + export type AuthenticateCognitoActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateCognitoActionAuthenticationRequestParamValue}; + export type AuthenticateCognitoActionAuthenticationRequestParamName = string; + export type AuthenticateCognitoActionAuthenticationRequestParamValue = string; + export type AuthenticateCognitoActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string; + export interface AuthenticateCognitoActionConfig { + /** + * The Amazon Resource Name (ARN) of the Amazon Cognito user pool. + */ + UserPoolArn: AuthenticateCognitoActionUserPoolArn; + /** + * The ID of the Amazon Cognito user pool client. + */ + UserPoolClientId: AuthenticateCognitoActionUserPoolClientId; + /** + * The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. + */ + UserPoolDomain: AuthenticateCognitoActionUserPoolDomain; + /** + * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. + */ + SessionCookieName?: AuthenticateCognitoActionSessionCookieName; + /** + * The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. + */ + Scope?: AuthenticateCognitoActionScope; + /** + * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). + */ + SessionTimeout?: AuthenticateCognitoActionSessionTimeout; + /** + * The query parameters (up to 10) to include in the redirect request to the authorization endpoint. + */ + AuthenticationRequestExtraParams?: AuthenticateCognitoActionAuthenticationRequestExtraParams; + /** + * The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. + */ + OnUnauthenticatedRequest?: AuthenticateCognitoActionConditionalBehaviorEnum; + } + export type AuthenticateCognitoActionScope = string; + export type AuthenticateCognitoActionSessionCookieName = string; + export type AuthenticateCognitoActionSessionTimeout = number; + export type AuthenticateCognitoActionUserPoolArn = string; + export type AuthenticateCognitoActionUserPoolClientId = string; + export type AuthenticateCognitoActionUserPoolDomain = string; + export type AuthenticateOidcActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateOidcActionAuthenticationRequestParamValue}; + export type AuthenticateOidcActionAuthenticationRequestParamName = string; + export type AuthenticateOidcActionAuthenticationRequestParamValue = string; + export type AuthenticateOidcActionAuthorizationEndpoint = string; + export type AuthenticateOidcActionClientId = string; + export type AuthenticateOidcActionClientSecret = string; + export type AuthenticateOidcActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string; + export interface AuthenticateOidcActionConfig { + /** + * The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + */ + Issuer: AuthenticateOidcActionIssuer; + /** + * The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + */ + AuthorizationEndpoint: AuthenticateOidcActionAuthorizationEndpoint; + /** + * The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + */ + TokenEndpoint: AuthenticateOidcActionTokenEndpoint; + /** + * The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. + */ + UserInfoEndpoint: AuthenticateOidcActionUserInfoEndpoint; + /** + * The OAuth 2.0 client identifier. + */ + ClientId: AuthenticateOidcActionClientId; + /** + * The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true. + */ + ClientSecret?: AuthenticateOidcActionClientSecret; + /** + * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. + */ + SessionCookieName?: AuthenticateOidcActionSessionCookieName; + /** + * The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. + */ + Scope?: AuthenticateOidcActionScope; + /** + * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). + */ + SessionTimeout?: AuthenticateOidcActionSessionTimeout; + /** + * The query parameters (up to 10) to include in the redirect request to the authorization endpoint. + */ + AuthenticationRequestExtraParams?: AuthenticateOidcActionAuthenticationRequestExtraParams; + /** + * The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. + */ + OnUnauthenticatedRequest?: AuthenticateOidcActionConditionalBehaviorEnum; + /** + * Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. + */ + UseExistingClientSecret?: AuthenticateOidcActionUseExistingClientSecret; + } + export type AuthenticateOidcActionIssuer = string; + export type AuthenticateOidcActionScope = string; + export type AuthenticateOidcActionSessionCookieName = string; + export type AuthenticateOidcActionSessionTimeout = number; + export type AuthenticateOidcActionTokenEndpoint = string; + export type AuthenticateOidcActionUseExistingClientSecret = boolean; + export type AuthenticateOidcActionUserInfoEndpoint = string; + export interface AvailabilityZone { + /** + * The name of the Availability Zone. + */ + ZoneName?: ZoneName; + /** + * The ID of the subnet. + */ + SubnetId?: SubnetId; + /** + * [Network Load Balancers] The static IP address. + */ + LoadBalancerAddresses?: LoadBalancerAddresses; + } + export type AvailabilityZones = AvailabilityZone[]; + export type CanonicalHostedZoneId = string; + export interface Certificate { + /** + * The Amazon Resource Name (ARN) of the certificate. + */ + CertificateArn?: CertificateArn; + /** + * Indicates whether the certificate is the default certificate. Do not set IsDefault when specifying a certificate as an input parameter. + */ + IsDefault?: Default; + } + export type CertificateArn = string; + export type CertificateList = Certificate[]; + export interface Cipher { + /** + * The name of the cipher. + */ + Name?: CipherName; + /** + * The priority of the cipher. + */ + Priority?: CipherPriority; + } + export type CipherName = string; + export type CipherPriority = number; + export type Ciphers = Cipher[]; + export type ConditionFieldName = string; + export interface CreateListenerInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn: LoadBalancerArn; + /** + * The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS. + */ + Protocol: ProtocolEnum; + /** + * The port on which the load balancer is listening. + */ + Port: Port; + /** + * [HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy. + */ + SslPolicy?: SslPolicyName; + /** + * [HTTPS and TLS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault. To create a certificate list, use AddListenerCertificates. + */ + Certificates?: CertificateList; + /** + * The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response. + */ + DefaultActions: Actions; + } + export interface CreateListenerOutput { + /** + * Information about the listener. + */ + Listeners?: Listeners; + } + export interface CreateLoadBalancerInput { + /** + * The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". + */ + Name: LoadBalancerName; + /** + * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. + */ + Subnets?: Subnets; + /** + * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet. + */ + SubnetMappings?: SubnetMappings; + /** + * [Application Load Balancers] The IDs of the security groups for the load balancer. + */ + SecurityGroups?: SecurityGroups; + /** + * The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. + */ + Scheme?: LoadBalancerSchemeEnum; + /** + * One or more tags to assign to the load balancer. + */ + Tags?: TagList; + /** + * The type of load balancer. The default is application. + */ + Type?: LoadBalancerTypeEnum; + /** + * [Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. + */ + IpAddressType?: IpAddressType; + } + export interface CreateLoadBalancerOutput { + /** + * Information about the load balancer. + */ + LoadBalancers?: LoadBalancers; + } + export interface CreateRuleInput { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: ListenerArn; + /** + * The conditions. Each condition specifies a field name and a single value. If the field name is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters. A-Z, a-z, 0-9 - . * (matches 0 or more characters) ? (matches exactly 1 character) If the field name is path-pattern, you can specify a single path pattern. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters. A-Z, a-z, 0-9 _ - . $ / ~ " ' @ : + & (using &amp;) * (matches 0 or more characters) ? (matches exactly 1 character) + */ + Conditions: RuleConditionList; + /** + * The rule priority. A listener can't have multiple rules with the same priority. + */ + Priority: RulePriority; + /** + * The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response. + */ + Actions: Actions; + } + export interface CreateRuleOutput { + /** + * Information about the rule. + */ + Rules?: Rules; + } + export interface CreateTargetGroupInput { + /** + * The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. + */ + Name: TargetGroupName; + /** + * The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS. If the target is a Lambda function, this parameter does not apply. + */ + Protocol?: ProtocolEnum; + /** + * The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. + */ + Port?: Port; + /** + * The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. + */ + VpcId?: VpcId; + /** + * The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks. + */ + HealthCheckProtocol?: ProtocolEnum; + /** + * The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer. + */ + HealthCheckPort?: HealthCheckPort; + /** + * Indicates whether health checks are enabled. If the target type is instance or ip, the default is true. If the target type is lambda, the default is false. + */ + HealthCheckEnabled?: HealthCheckEnabled; + /** + * [HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /. + */ + HealthCheckPath?: Path; + /** + * The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds. + */ + HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; + /** + * The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2–120 seconds and the default is 5 seconds if the target type is instance or ip and 30 seconds if the target type is lambda. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks. + */ + HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds; + /** + * The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3. + */ + HealthyThresholdCount?: HealthCheckThresholdCount; + /** + * The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count. + */ + UnhealthyThresholdCount?: HealthCheckThresholdCount; + /** + * [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target. + */ + Matcher?: Matcher; + /** + * The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. instance - Targets are specified by instance ID. This is the default value. ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses. lambda - The target groups contains a single Lambda function. + */ + TargetType?: TargetTypeEnum; + } + export interface CreateTargetGroupOutput { + /** + * Information about the target group. + */ + TargetGroups?: TargetGroups; + } + export type CreatedTime = Date; + export type DNSName = string; + export type Default = boolean; + export interface DeleteListenerInput { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: ListenerArn; + } + export interface DeleteListenerOutput { + } + export interface DeleteLoadBalancerInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn: LoadBalancerArn; + } + export interface DeleteLoadBalancerOutput { + } + export interface DeleteRuleInput { + /** + * The Amazon Resource Name (ARN) of the rule. + */ + RuleArn: RuleArn; + } + export interface DeleteRuleOutput { + } + export interface DeleteTargetGroupInput { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn: TargetGroupArn; + } + export interface DeleteTargetGroupOutput { + } + export interface DeregisterTargetsInput { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn: TargetGroupArn; + /** + * The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it. + */ + Targets: TargetDescriptions; + } + export interface DeregisterTargetsOutput { + } + export interface DescribeAccountLimitsInput { + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeAccountLimitsOutput { + /** + * Information about the limits. + */ + Limits?: Limits; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeListenerCertificatesInput { + /** + * The Amazon Resource Names (ARN) of the listener. + */ + ListenerArn: ListenerArn; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeListenerCertificatesOutput { + /** + * Information about the certificates. + */ + Certificates?: CertificateList; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeListenersInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn?: LoadBalancerArn; + /** + * The Amazon Resource Names (ARN) of the listeners. + */ + ListenerArns?: ListenerArns; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeListenersOutput { + /** + * Information about the listeners. + */ + Listeners?: Listeners; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeLoadBalancerAttributesInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn: LoadBalancerArn; + } + export interface DescribeLoadBalancerAttributesOutput { + /** + * Information about the load balancer attributes. + */ + Attributes?: LoadBalancerAttributes; + } + export interface DescribeLoadBalancersInput { + /** + * The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call. + */ + LoadBalancerArns?: LoadBalancerArns; + /** + * The names of the load balancers. + */ + Names?: LoadBalancerNames; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeLoadBalancersOutput { + /** + * Information about the load balancers. + */ + LoadBalancers?: LoadBalancers; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeRulesInput { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn?: ListenerArn; + /** + * The Amazon Resource Names (ARN) of the rules. + */ + RuleArns?: RuleArns; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeRulesOutput { + /** + * Information about the rules. + */ + Rules?: Rules; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeSSLPoliciesInput { + /** + * The names of the policies. + */ + Names?: SslPolicyNames; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeSSLPoliciesOutput { + /** + * Information about the policies. + */ + SslPolicies?: SslPolicies; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeTagsInput { + /** + * The Amazon Resource Names (ARN) of the resources. + */ + ResourceArns: ResourceArns; + } + export interface DescribeTagsOutput { + /** + * Information about the tags. + */ + TagDescriptions?: TagDescriptions; + } + export interface DescribeTargetGroupAttributesInput { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn: TargetGroupArn; + } + export interface DescribeTargetGroupAttributesOutput { + /** + * Information about the target group attributes + */ + Attributes?: TargetGroupAttributes; + } + export interface DescribeTargetGroupsInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn?: LoadBalancerArn; + /** + * The Amazon Resource Names (ARN) of the target groups. + */ + TargetGroupArns?: TargetGroupArns; + /** + * The names of the target groups. + */ + Names?: TargetGroupNames; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: Marker; + /** + * The maximum number of results to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeTargetGroupsOutput { + /** + * Information about the target groups. + */ + TargetGroups?: TargetGroups; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + NextMarker?: Marker; + } + export interface DescribeTargetHealthInput { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn: TargetGroupArn; + /** + * The targets. + */ + Targets?: TargetDescriptions; + } + export interface DescribeTargetHealthOutput { + /** + * Information about the health of the targets. + */ + TargetHealthDescriptions?: TargetHealthDescriptions; + } + export type Description = string; + export interface FixedResponseActionConfig { + /** + * The message. + */ + MessageBody?: FixedResponseActionMessage; + /** + * The HTTP response code (2XX, 4XX, or 5XX). + */ + StatusCode: FixedResponseActionStatusCode; + /** + * The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json + */ + ContentType?: FixedResponseActionContentType; + } + export type FixedResponseActionContentType = string; + export type FixedResponseActionMessage = string; + export type FixedResponseActionStatusCode = string; + export type HealthCheckEnabled = boolean; + export type HealthCheckIntervalSeconds = number; + export type HealthCheckPort = string; + export type HealthCheckThresholdCount = number; + export type HealthCheckTimeoutSeconds = number; + export interface HostHeaderConditionConfig { + Values?: ListOfString; + } + export type HttpCode = string; + export interface HttpHeaderConditionConfig { + HttpHeaderName?: HttpHeaderConditionName; + Values?: ListOfString; + } + export type HttpHeaderConditionName = string; + export interface HttpRequestMethodConditionConfig { + Values?: ListOfString; + } + export type IpAddress = string; + export type IpAddressType = "ipv4"|"dualstack"|string; + export type IsDefault = boolean; + export interface Limit { + /** + * The name of the limit. The possible values are: application-load-balancers listeners-per-application-load-balancer listeners-per-network-load-balancer network-load-balancers rules-per-application-load-balancer target-groups targets-per-application-load-balancer targets-per-availability-zone-per-network-load-balancer targets-per-network-load-balancer + */ + Name?: Name; + /** + * The maximum value of the limit. + */ + Max?: Max; + } + export type Limits = Limit[]; + export type ListOfString = StringValue[]; + export interface Listener { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn?: ListenerArn; + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn?: LoadBalancerArn; + /** + * The port on which the load balancer is listening. + */ + Port?: Port; + /** + * The protocol for connections from clients to the load balancer. + */ + Protocol?: ProtocolEnum; + /** + * The SSL server certificate. You must provide a certificate if the protocol is HTTPS or TLS. + */ + Certificates?: CertificateList; + /** + * The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy. + */ + SslPolicy?: SslPolicyName; + /** + * The default actions for the listener. + */ + DefaultActions?: Actions; + } + export type ListenerArn = string; + export type ListenerArns = ListenerArn[]; + export type Listeners = Listener[]; + export interface LoadBalancer { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn?: LoadBalancerArn; + /** + * The public DNS name of the load balancer. + */ + DNSName?: DNSName; + /** + * The ID of the Amazon Route 53 hosted zone associated with the load balancer. + */ + CanonicalHostedZoneId?: CanonicalHostedZoneId; + /** + * The date and time the load balancer was created. + */ + CreatedTime?: CreatedTime; + /** + * The name of the load balancer. + */ + LoadBalancerName?: LoadBalancerName; + /** + * The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer. + */ + Scheme?: LoadBalancerSchemeEnum; + /** + * The ID of the VPC for the load balancer. + */ + VpcId?: VpcId; + /** + * The state of the load balancer. + */ + State?: LoadBalancerState; + /** + * The type of load balancer. + */ + Type?: LoadBalancerTypeEnum; + /** + * The Availability Zones for the load balancer. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The IDs of the security groups for the load balancer. + */ + SecurityGroups?: SecurityGroups; + /** + * The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). + */ + IpAddressType?: IpAddressType; + } + export interface LoadBalancerAddress { + /** + * The static IP address. + */ + IpAddress?: IpAddress; + /** + * [Network Load Balancers] The allocation ID of the Elastic IP address. + */ + AllocationId?: AllocationId; + } + export type LoadBalancerAddresses = LoadBalancerAddress[]; + export type LoadBalancerArn = string; + export type LoadBalancerArns = LoadBalancerArn[]; + export interface LoadBalancerAttribute { + /** + * The name of the attribute. The following attributes are supported by both Application Load Balancers and Network Load Balancers: access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. The following attributes are supported by only Application Load Balancers: idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. The following attributes are supported by only Network Load Balancers: load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false. + */ + Key?: LoadBalancerAttributeKey; + /** + * The value of the attribute. + */ + Value?: LoadBalancerAttributeValue; + } + export type LoadBalancerAttributeKey = string; + export type LoadBalancerAttributeValue = string; + export type LoadBalancerAttributes = LoadBalancerAttribute[]; + export type LoadBalancerName = string; + export type LoadBalancerNames = LoadBalancerName[]; + export type LoadBalancerSchemeEnum = "internet-facing"|"internal"|string; + export interface LoadBalancerState { + /** + * The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If the load balancer could not be set up, its state is failed. + */ + Code?: LoadBalancerStateEnum; + /** + * A description of the state. + */ + Reason?: StateReason; + } + export type LoadBalancerStateEnum = "active"|"provisioning"|"active_impaired"|"failed"|string; + export type LoadBalancerTypeEnum = "application"|"network"|string; + export type LoadBalancers = LoadBalancer[]; + export type Marker = string; + export interface Matcher { + /** + * The HTTP codes. For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299"). For Network Load Balancers, this is 200–399. + */ + HttpCode: HttpCode; + } + export type Max = string; + export interface ModifyListenerInput { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: ListenerArn; + /** + * The port for connections from clients to the load balancer. + */ + Port?: Port; + /** + * The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP and TLS protocols. + */ + Protocol?: ProtocolEnum; + /** + * [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide. + */ + SslPolicy?: SslPolicyName; + /** + * [HTTPS and TLS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault. To create a certificate list, use AddListenerCertificates. + */ + Certificates?: CertificateList; + /** + * The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response. + */ + DefaultActions?: Actions; + } + export interface ModifyListenerOutput { + /** + * Information about the modified listener. + */ + Listeners?: Listeners; + } + export interface ModifyLoadBalancerAttributesInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn: LoadBalancerArn; + /** + * The load balancer attributes. + */ + Attributes: LoadBalancerAttributes; + } + export interface ModifyLoadBalancerAttributesOutput { + /** + * Information about the load balancer attributes. + */ + Attributes?: LoadBalancerAttributes; + } + export interface ModifyRuleInput { + /** + * The Amazon Resource Name (ARN) of the rule. + */ + RuleArn: RuleArn; + /** + * The conditions. Each condition specifies a field name and a single value. If the field name is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters. A-Z, a-z, 0-9 - . * (matches 0 or more characters) ? (matches exactly 1 character) If the field name is path-pattern, you can specify a single path pattern. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters. A-Z, a-z, 0-9 _ - . $ / ~ " ' @ : + & (using &amp;) * (matches 0 or more characters) ? (matches exactly 1 character) + */ + Conditions?: RuleConditionList; + /** + * The actions. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response. + */ + Actions?: Actions; + } + export interface ModifyRuleOutput { + /** + * Information about the modified rule. + */ + Rules?: Rules; + } + export interface ModifyTargetGroupAttributesInput { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn: TargetGroupArn; + /** + * The attributes. + */ + Attributes: TargetGroupAttributes; + } + export interface ModifyTargetGroupAttributesOutput { + /** + * Information about the attributes. + */ + Attributes?: TargetGroupAttributes; + } + export interface ModifyTargetGroupInput { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn: TargetGroupArn; + /** + * The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks. If the protocol of the target group is TCP, you can't modify this setting. + */ + HealthCheckProtocol?: ProtocolEnum; + /** + * The port the load balancer uses when performing health checks on targets. + */ + HealthCheckPort?: HealthCheckPort; + /** + * [HTTP/HTTPS health checks] The ping path that is the destination for the health check request. + */ + HealthCheckPath?: Path; + /** + * Indicates whether health checks are enabled. + */ + HealthCheckEnabled?: HealthCheckEnabled; + /** + * The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. If the protocol of the target group is TCP, you can't modify this setting. + */ + HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; + /** + * [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check. If the protocol of the target group is TCP, you can't modify this setting. + */ + HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds; + /** + * The number of consecutive health checks successes required before considering an unhealthy target healthy. + */ + HealthyThresholdCount?: HealthCheckThresholdCount; + /** + * The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count. + */ + UnhealthyThresholdCount?: HealthCheckThresholdCount; + /** + * [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target. If the protocol of the target group is TCP, you can't modify this setting. + */ + Matcher?: Matcher; + } + export interface ModifyTargetGroupOutput { + /** + * Information about the modified target group. + */ + TargetGroups?: TargetGroups; + } + export type Name = string; + export type PageSize = number; + export type Path = string; + export interface PathPatternConditionConfig { + Values?: ListOfString; + } + export type Port = number; + export type ProtocolEnum = "HTTP"|"HTTPS"|"TCP"|"TLS"|string; + export interface QueryStringConditionConfig { + Values?: QueryStringKeyValuePairList; + } + export interface QueryStringKeyValuePair { + Key?: StringValue; + Value?: StringValue; + } + export type QueryStringKeyValuePairList = QueryStringKeyValuePair[]; + export interface RedirectActionConfig { + /** + * The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. + */ + Protocol?: RedirectActionProtocol; + /** + * The port. You can specify a value from 1 to 65535 or #{port}. + */ + Port?: RedirectActionPort; + /** + * The hostname. This component is not percent-encoded. The hostname can contain #{host}. + */ + Host?: RedirectActionHost; + /** + * The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. + */ + Path?: RedirectActionPath; + /** + * The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. + */ + Query?: RedirectActionQuery; + /** + * The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302). + */ + StatusCode: RedirectActionStatusCodeEnum; + } + export type RedirectActionHost = string; + export type RedirectActionPath = string; + export type RedirectActionPort = string; + export type RedirectActionProtocol = string; + export type RedirectActionQuery = string; + export type RedirectActionStatusCodeEnum = "HTTP_301"|"HTTP_302"|string; + export interface RegisterTargetsInput { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn: TargetGroupArn; + /** + * The targets. To register a target by instance ID, specify the instance ID. To register a target by IP address, specify the IP address. To register a Lambda function, specify the ARN of the Lambda function. + */ + Targets: TargetDescriptions; + } + export interface RegisterTargetsOutput { + } + export interface RemoveListenerCertificatesInput { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: ListenerArn; + /** + * The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault. + */ + Certificates: CertificateList; + } + export interface RemoveListenerCertificatesOutput { + } + export interface RemoveTagsInput { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArns: ResourceArns; + /** + * The tag keys for the tags to remove. + */ + TagKeys: TagKeys; + } + export interface RemoveTagsOutput { + } + export type ResourceArn = string; + export type ResourceArns = ResourceArn[]; + export interface Rule { + /** + * The Amazon Resource Name (ARN) of the rule. + */ + RuleArn?: RuleArn; + /** + * The priority. + */ + Priority?: String; + /** + * The conditions. + */ + Conditions?: RuleConditionList; + /** + * The actions. + */ + Actions?: Actions; + /** + * Indicates whether this is the default rule. + */ + IsDefault?: IsDefault; + } + export type RuleArn = string; + export type RuleArns = RuleArn[]; + export interface RuleCondition { + /** + * The name of the field. The possible values are host-header and path-pattern. + */ + Field?: ConditionFieldName; + /** + * The condition value. If the field name is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters. A-Z, a-z, 0-9 - . * (matches 0 or more characters) ? (matches exactly 1 character) If the field name is path-pattern, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters. A-Z, a-z, 0-9 _ - . $ / ~ " ' @ : + & (using &amp;) * (matches 0 or more characters) ? (matches exactly 1 character) + */ + Values?: ListOfString; + HostHeaderConfig?: HostHeaderConditionConfig; + PathPatternConfig?: PathPatternConditionConfig; + HttpHeaderConfig?: HttpHeaderConditionConfig; + QueryStringConfig?: QueryStringConditionConfig; + HttpRequestMethodConfig?: HttpRequestMethodConditionConfig; + SourceIpConfig?: SourceIpConditionConfig; + } + export type RuleConditionList = RuleCondition[]; + export type RulePriority = number; + export type RulePriorityList = RulePriorityPair[]; + export interface RulePriorityPair { + /** + * The Amazon Resource Name (ARN) of the rule. + */ + RuleArn?: RuleArn; + /** + * The rule priority. + */ + Priority?: RulePriority; + } + export type Rules = Rule[]; + export type SecurityGroupId = string; + export type SecurityGroups = SecurityGroupId[]; + export interface SetIpAddressTypeInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn: LoadBalancerArn; + /** + * The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. + */ + IpAddressType: IpAddressType; + } + export interface SetIpAddressTypeOutput { + /** + * The IP address type. + */ + IpAddressType?: IpAddressType; + } + export interface SetRulePrioritiesInput { + /** + * The rule priorities. + */ + RulePriorities: RulePriorityList; + } + export interface SetRulePrioritiesOutput { + /** + * Information about the rules. + */ + Rules?: Rules; + } + export interface SetSecurityGroupsInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn: LoadBalancerArn; + /** + * The IDs of the security groups. + */ + SecurityGroups: SecurityGroups; + } + export interface SetSecurityGroupsOutput { + /** + * The IDs of the security groups associated with the load balancer. + */ + SecurityGroupIds?: SecurityGroups; + } + export interface SetSubnetsInput { + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + LoadBalancerArn: LoadBalancerArn; + /** + * The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. + */ + Subnets?: Subnets; + /** + * The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. You cannot specify Elastic IP addresses for your subnets. + */ + SubnetMappings?: SubnetMappings; + } + export interface SetSubnetsOutput { + /** + * Information about the subnet and Availability Zone. + */ + AvailabilityZones?: AvailabilityZones; + } + export interface SourceIpConditionConfig { + Values?: ListOfString; + } + export type SslPolicies = SslPolicy[]; + export interface SslPolicy { + /** + * The protocols. + */ + SslProtocols?: SslProtocols; + /** + * The ciphers. + */ + Ciphers?: Ciphers; + /** + * The name of the policy. + */ + Name?: SslPolicyName; + } + export type SslPolicyName = string; + export type SslPolicyNames = SslPolicyName[]; + export type SslProtocol = string; + export type SslProtocols = SslProtocol[]; + export type StateReason = string; + export type String = string; + export type StringValue = string; + export type SubnetId = string; + export interface SubnetMapping { + /** + * The ID of the subnet. + */ + SubnetId?: SubnetId; + /** + * [Network Load Balancers] The allocation ID of the Elastic IP address. + */ + AllocationId?: AllocationId; + } + export type SubnetMappings = SubnetMapping[]; + export type Subnets = SubnetId[]; + export interface Tag { + /** + * The key of the tag. + */ + Key: TagKey; + /** + * The value of the tag. + */ + Value?: TagValue; + } + export interface TagDescription { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArn?: ResourceArn; + /** + * Information about the tags. + */ + Tags?: TagList; + } + export type TagDescriptions = TagDescription[]; + export type TagKey = string; + export type TagKeys = TagKey[]; + export type TagList = Tag[]; + export type TagValue = string; + export interface TargetDescription { + /** + * The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. + */ + Id: TargetId; + /** + * The port on which the target is listening. + */ + Port?: Port; + /** + * An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance. If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required. With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all. If the target type is lambda, this parameter is optional and the only supported value is all. + */ + AvailabilityZone?: ZoneName; + } + export type TargetDescriptions = TargetDescription[]; + export interface TargetGroup { + /** + * The Amazon Resource Name (ARN) of the target group. + */ + TargetGroupArn?: TargetGroupArn; + /** + * The name of the target group. + */ + TargetGroupName?: TargetGroupName; + /** + * The protocol to use for routing traffic to the targets. + */ + Protocol?: ProtocolEnum; + /** + * The port on which the targets are listening. + */ + Port?: Port; + /** + * The ID of the VPC for the targets. + */ + VpcId?: VpcId; + /** + * The protocol to use to connect with the target. + */ + HealthCheckProtocol?: ProtocolEnum; + /** + * The port to use to connect with the target. + */ + HealthCheckPort?: HealthCheckPort; + /** + * Indicates whether health checks are enabled. + */ + HealthCheckEnabled?: HealthCheckEnabled; + /** + * The approximate amount of time, in seconds, between health checks of an individual target. + */ + HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; + /** + * The amount of time, in seconds, during which no response means a failed health check. + */ + HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds; + /** + * The number of consecutive health checks successes required before considering an unhealthy target healthy. + */ + HealthyThresholdCount?: HealthCheckThresholdCount; + /** + * The number of consecutive health check failures required before considering the target unhealthy. + */ + UnhealthyThresholdCount?: HealthCheckThresholdCount; + /** + * The destination for the health check request. + */ + HealthCheckPath?: Path; + /** + * The HTTP codes to use when checking for a successful response from a target. + */ + Matcher?: Matcher; + /** + * The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group. + */ + LoadBalancerArns?: LoadBalancerArns; + /** + * The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address). + */ + TargetType?: TargetTypeEnum; + } + export type TargetGroupArn = string; + export type TargetGroupArns = TargetGroupArn[]; + export interface TargetGroupAttribute { + /** + * The name of the attribute. The following attribute is supported by both Application Load Balancers and Network Load Balancers: deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. The following attributes are supported by Application Load Balancers if the target is not a Lambda function: slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by default. stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false. stickiness.type - The type of sticky sessions. The possible value is lb_cookie. stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the target is a Lambda function. lambda.multi_value_headers.enabled - Indicates whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. The following attribute is supported only by Network Load Balancers: proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. + */ + Key?: TargetGroupAttributeKey; + /** + * The value of the attribute. + */ + Value?: TargetGroupAttributeValue; + } + export type TargetGroupAttributeKey = string; + export type TargetGroupAttributeValue = string; + export type TargetGroupAttributes = TargetGroupAttribute[]; + export type TargetGroupName = string; + export type TargetGroupNames = TargetGroupName[]; + export type TargetGroups = TargetGroup[]; + export interface TargetHealth { + /** + * The state of the target. + */ + State?: TargetHealthStateEnum; + /** + * The reason code. If the target state is healthy, a reason code is not provided. If the target state is initial, the reason code can be one of the following values: Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer. Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status. If the target state is unhealthy, the reason code can be one of the following values: Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Target.Timeout - The health check requests timed out. Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason. Elb.InternalError - The health checks failed due to an internal error. If the target state is unused, the reason code can be one of the following values: Target.NotRegistered - The target is not registered with the target group. Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. Target.IpUnusable - The target IP address is reserved for use by a load balancer. Target.InvalidState - The target is in the stopped or terminated state. If the target state is draining, the reason code can be the following value: Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired. If the target state is unavailable, the reason code can be the following value: Target.HealthCheckDisabled - Health checks are disabled for the target group. + */ + Reason?: TargetHealthReasonEnum; + /** + * A description of the target health that provides additional details. If the state is healthy, a description is not provided. + */ + Description?: Description; + } + export interface TargetHealthDescription { + /** + * The description of the target. + */ + Target?: TargetDescription; + /** + * The port to use to connect with the target. + */ + HealthCheckPort?: HealthCheckPort; + /** + * The health information for the target. + */ + TargetHealth?: TargetHealth; + } + export type TargetHealthDescriptions = TargetHealthDescription[]; + export type TargetHealthReasonEnum = "Elb.RegistrationInProgress"|"Elb.InitialHealthChecking"|"Target.ResponseCodeMismatch"|"Target.Timeout"|"Target.FailedHealthChecks"|"Target.NotRegistered"|"Target.NotInUse"|"Target.DeregistrationInProgress"|"Target.InvalidState"|"Target.IpUnusable"|"Target.HealthCheckDisabled"|"Elb.InternalError"|string; + export type TargetHealthStateEnum = "initial"|"healthy"|"unhealthy"|"unused"|"draining"|"unavailable"|string; + export type TargetId = string; + export type TargetTypeEnum = "instance"|"ip"|"lambda"|string; + export type VpcId = string; + export type ZoneName = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-12-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ELBv2 client. + */ + export import Types = ELBv2; +} +export = ELBv2; diff --git a/node_modules/aws-sdk/clients/elbv2.js b/node_modules/aws-sdk/clients/elbv2.js new file mode 100644 index 0000000..6b98bf8 --- /dev/null +++ b/node_modules/aws-sdk/clients/elbv2.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['elbv2'] = {}; +AWS.ELBv2 = Service.defineService('elbv2', ['2015-12-01']); +Object.defineProperty(apiLoader.services['elbv2'], '2015-12-01', { + get: function get() { + var model = require('../apis/elasticloadbalancingv2-2015-12-01.min.json'); + model.paginators = require('../apis/elasticloadbalancingv2-2015-12-01.paginators.json').pagination; + model.waiters = require('../apis/elasticloadbalancingv2-2015-12-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ELBv2; diff --git a/node_modules/aws-sdk/clients/emr.d.ts b/node_modules/aws-sdk/clients/emr.d.ts new file mode 100644 index 0000000..0f51e01 --- /dev/null +++ b/node_modules/aws-sdk/clients/emr.d.ts @@ -0,0 +1,2407 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class EMR extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: EMR.Types.ClientConfiguration) + config: Config & EMR.Types.ClientConfiguration; + /** + * Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x. + */ + addInstanceFleet(params: EMR.Types.AddInstanceFleetInput, callback?: (err: AWSError, data: EMR.Types.AddInstanceFleetOutput) => void): Request; + /** + * Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x. + */ + addInstanceFleet(callback?: (err: AWSError, data: EMR.Types.AddInstanceFleetOutput) => void): Request; + /** + * Adds one or more instance groups to a running cluster. + */ + addInstanceGroups(params: EMR.Types.AddInstanceGroupsInput, callback?: (err: AWSError, data: EMR.Types.AddInstanceGroupsOutput) => void): Request; + /** + * Adds one or more instance groups to a running cluster. + */ + addInstanceGroups(callback?: (err: AWSError, data: EMR.Types.AddInstanceGroupsOutput) => void): Request; + /** + * AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING. + */ + addJobFlowSteps(params: EMR.Types.AddJobFlowStepsInput, callback?: (err: AWSError, data: EMR.Types.AddJobFlowStepsOutput) => void): Request; + /** + * AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING. + */ + addJobFlowSteps(callback?: (err: AWSError, data: EMR.Types.AddJobFlowStepsOutput) => void): Request; + /** + * Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. + */ + addTags(params: EMR.Types.AddTagsInput, callback?: (err: AWSError, data: EMR.Types.AddTagsOutput) => void): Request; + /** + * Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. + */ + addTags(callback?: (err: AWSError, data: EMR.Types.AddTagsOutput) => void): Request; + /** + * Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state. + */ + cancelSteps(params: EMR.Types.CancelStepsInput, callback?: (err: AWSError, data: EMR.Types.CancelStepsOutput) => void): Request; + /** + * Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state. + */ + cancelSteps(callback?: (err: AWSError, data: EMR.Types.CancelStepsOutput) => void): Request; + /** + * Creates a security configuration, which is stored in the service and can be specified when a cluster is created. + */ + createSecurityConfiguration(params: EMR.Types.CreateSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.CreateSecurityConfigurationOutput) => void): Request; + /** + * Creates a security configuration, which is stored in the service and can be specified when a cluster is created. + */ + createSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.CreateSecurityConfigurationOutput) => void): Request; + /** + * Deletes a security configuration. + */ + deleteSecurityConfiguration(params: EMR.Types.DeleteSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.DeleteSecurityConfigurationOutput) => void): Request; + /** + * Deletes a security configuration. + */ + deleteSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.DeleteSecurityConfigurationOutput) => void): Request; + /** + * Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. + */ + describeCluster(params: EMR.Types.DescribeClusterInput, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request; + /** + * Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. + */ + describeCluster(callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request; + /** + * This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned: Job flows created and completed in the last two weeks Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR can return a maximum of 512 job flow descriptions. + */ + describeJobFlows(params: EMR.Types.DescribeJobFlowsInput, callback?: (err: AWSError, data: EMR.Types.DescribeJobFlowsOutput) => void): Request; + /** + * This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned: Job flows created and completed in the last two weeks Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR can return a maximum of 512 job flow descriptions. + */ + describeJobFlows(callback?: (err: AWSError, data: EMR.Types.DescribeJobFlowsOutput) => void): Request; + /** + * Provides the details of a security configuration by returning the configuration JSON. + */ + describeSecurityConfiguration(params: EMR.Types.DescribeSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.DescribeSecurityConfigurationOutput) => void): Request; + /** + * Provides the details of a security configuration by returning the configuration JSON. + */ + describeSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.DescribeSecurityConfigurationOutput) => void): Request; + /** + * Provides more detail about the cluster step. + */ + describeStep(params: EMR.Types.DescribeStepInput, callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request; + /** + * Provides more detail about the cluster step. + */ + describeStep(callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request; + /** + * Provides information about the bootstrap actions associated with a cluster. + */ + listBootstrapActions(params: EMR.Types.ListBootstrapActionsInput, callback?: (err: AWSError, data: EMR.Types.ListBootstrapActionsOutput) => void): Request; + /** + * Provides information about the bootstrap actions associated with a cluster. + */ + listBootstrapActions(callback?: (err: AWSError, data: EMR.Types.ListBootstrapActionsOutput) => void): Request; + /** + * Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. + */ + listClusters(params: EMR.Types.ListClustersInput, callback?: (err: AWSError, data: EMR.Types.ListClustersOutput) => void): Request; + /** + * Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. + */ + listClusters(callback?: (err: AWSError, data: EMR.Types.ListClustersOutput) => void): Request; + /** + * Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + */ + listInstanceFleets(params: EMR.Types.ListInstanceFleetsInput, callback?: (err: AWSError, data: EMR.Types.ListInstanceFleetsOutput) => void): Request; + /** + * Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + */ + listInstanceFleets(callback?: (err: AWSError, data: EMR.Types.ListInstanceFleetsOutput) => void): Request; + /** + * Provides all available details about the instance groups in a cluster. + */ + listInstanceGroups(params: EMR.Types.ListInstanceGroupsInput, callback?: (err: AWSError, data: EMR.Types.ListInstanceGroupsOutput) => void): Request; + /** + * Provides all available details about the instance groups in a cluster. + */ + listInstanceGroups(callback?: (err: AWSError, data: EMR.Types.ListInstanceGroupsOutput) => void): Request; + /** + * Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING. + */ + listInstances(params: EMR.Types.ListInstancesInput, callback?: (err: AWSError, data: EMR.Types.ListInstancesOutput) => void): Request; + /** + * Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING. + */ + listInstances(callback?: (err: AWSError, data: EMR.Types.ListInstancesOutput) => void): Request; + /** + * Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls. + */ + listSecurityConfigurations(params: EMR.Types.ListSecurityConfigurationsInput, callback?: (err: AWSError, data: EMR.Types.ListSecurityConfigurationsOutput) => void): Request; + /** + * Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls. + */ + listSecurityConfigurations(callback?: (err: AWSError, data: EMR.Types.ListSecurityConfigurationsOutput) => void): Request; + /** + * Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request. + */ + listSteps(params: EMR.Types.ListStepsInput, callback?: (err: AWSError, data: EMR.Types.ListStepsOutput) => void): Request; + /** + * Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request. + */ + listSteps(callback?: (err: AWSError, data: EMR.Types.ListStepsOutput) => void): Request; + /** + * Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + */ + modifyInstanceFleet(params: EMR.Types.ModifyInstanceFleetInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + */ + modifyInstanceFleet(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically. + */ + modifyInstanceGroups(params: EMR.Types.ModifyInstanceGroupsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically. + */ + modifyInstanceGroups(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. + */ + putAutoScalingPolicy(params: EMR.Types.PutAutoScalingPolicyInput, callback?: (err: AWSError, data: EMR.Types.PutAutoScalingPolicyOutput) => void): Request; + /** + * Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. + */ + putAutoScalingPolicy(callback?: (err: AWSError, data: EMR.Types.PutAutoScalingPolicyOutput) => void): Request; + /** + * Removes an automatic scaling policy from a specified instance group within an EMR cluster. + */ + removeAutoScalingPolicy(params: EMR.Types.RemoveAutoScalingPolicyInput, callback?: (err: AWSError, data: EMR.Types.RemoveAutoScalingPolicyOutput) => void): Request; + /** + * Removes an automatic scaling policy from a specified instance group within an EMR cluster. + */ + removeAutoScalingPolicy(callback?: (err: AWSError, data: EMR.Types.RemoveAutoScalingPolicyOutput) => void): Request; + /** + * Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. The following example removes the stack tag with value Prod from a cluster: + */ + removeTags(params: EMR.Types.RemoveTagsInput, callback?: (err: AWSError, data: EMR.Types.RemoveTagsOutput) => void): Request; + /** + * Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. The following example removes the stack tag with value Prod from a cluster: + */ + removeTags(callback?: (err: AWSError, data: EMR.Types.RemoveTagsOutput) => void): Request; + /** + * RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed. For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both. + */ + runJobFlow(params: EMR.Types.RunJobFlowInput, callback?: (err: AWSError, data: EMR.Types.RunJobFlowOutput) => void): Request; + /** + * RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed. For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both. + */ + runJobFlow(callback?: (err: AWSError, data: EMR.Types.RunJobFlowOutput) => void): Request; + /** + * SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster. SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage. To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide. + */ + setTerminationProtection(params: EMR.Types.SetTerminationProtectionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster. SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage. To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide. + */ + setTerminationProtection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster. + */ + setVisibleToAllUsers(params: EMR.Types.SetVisibleToAllUsersInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster. + */ + setVisibleToAllUsers(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances. + */ + terminateJobFlows(params: EMR.Types.TerminateJobFlowsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances. + */ + terminateJobFlows(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the clusterRunning state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times). + */ + waitFor(state: "clusterRunning", params: EMR.Types.DescribeClusterInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request; + /** + * Waits for the clusterRunning state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times). + */ + waitFor(state: "clusterRunning", callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request; + /** + * Waits for the stepComplete state by periodically calling the underlying EMR.describeStepoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "stepComplete", params: EMR.Types.DescribeStepInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request; + /** + * Waits for the stepComplete state by periodically calling the underlying EMR.describeStepoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "stepComplete", callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request; + /** + * Waits for the clusterTerminated state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times). + */ + waitFor(state: "clusterTerminated", params: EMR.Types.DescribeClusterInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request; + /** + * Waits for the clusterTerminated state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times). + */ + waitFor(state: "clusterTerminated", callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request; +} +declare namespace EMR { + export type ActionOnFailure = "TERMINATE_JOB_FLOW"|"TERMINATE_CLUSTER"|"CANCEL_AND_WAIT"|"CONTINUE"|string; + export interface AddInstanceFleetInput { + /** + * The unique identifier of the cluster. + */ + ClusterId: XmlStringMaxLen256; + /** + * Specifies the configuration of the instance fleet. + */ + InstanceFleet: InstanceFleetConfig; + } + export interface AddInstanceFleetOutput { + /** + * The unique identifier of the cluster. + */ + ClusterId?: XmlStringMaxLen256; + /** + * The unique identifier of the instance fleet. + */ + InstanceFleetId?: InstanceFleetId; + } + export interface AddInstanceGroupsInput { + /** + * Instance groups to add. + */ + InstanceGroups: InstanceGroupConfigList; + /** + * Job flow in which to add the instance groups. + */ + JobFlowId: XmlStringMaxLen256; + } + export interface AddInstanceGroupsOutput { + /** + * The job flow ID in which the instance groups are added. + */ + JobFlowId?: XmlStringMaxLen256; + /** + * Instance group IDs of the newly created instance groups. + */ + InstanceGroupIds?: InstanceGroupIdsList; + } + export interface AddJobFlowStepsInput { + /** + * A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters. + */ + JobFlowId: XmlStringMaxLen256; + /** + * A list of StepConfig to be executed by the job flow. + */ + Steps: StepConfigList; + } + export interface AddJobFlowStepsOutput { + /** + * The identifiers of the list of steps added to the job flow. + */ + StepIds?: StepIdsList; + } + export interface AddTagsInput { + /** + * The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier. + */ + ResourceId: ResourceId; + /** + * A list of tags to associate with a cluster and propagate to EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters. + */ + Tags: TagList; + } + export interface AddTagsOutput { + } + export type AdjustmentType = "CHANGE_IN_CAPACITY"|"PERCENT_CHANGE_IN_CAPACITY"|"EXACT_CAPACITY"|string; + export interface Application { + /** + * The name of the application. + */ + Name?: String; + /** + * The version of the application. + */ + Version?: String; + /** + * Arguments for Amazon EMR to pass to the application. + */ + Args?: StringList; + /** + * This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes. + */ + AdditionalInfo?: StringMap; + } + export type ApplicationList = Application[]; + export interface AutoScalingPolicy { + /** + * The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits. + */ + Constraints: ScalingConstraints; + /** + * The scale-in and scale-out rules that comprise the automatic scaling policy. + */ + Rules: ScalingRuleList; + } + export interface AutoScalingPolicyDescription { + /** + * The status of an automatic scaling policy. + */ + Status?: AutoScalingPolicyStatus; + /** + * The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits. + */ + Constraints?: ScalingConstraints; + /** + * The scale-in and scale-out rules that comprise the automatic scaling policy. + */ + Rules?: ScalingRuleList; + } + export type AutoScalingPolicyState = "PENDING"|"ATTACHING"|"ATTACHED"|"DETACHING"|"DETACHED"|"FAILED"|string; + export interface AutoScalingPolicyStateChangeReason { + /** + * The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error. + */ + Code?: AutoScalingPolicyStateChangeReasonCode; + /** + * A friendly, more verbose message that accompanies an automatic scaling policy state change. + */ + Message?: String; + } + export type AutoScalingPolicyStateChangeReasonCode = "USER_REQUEST"|"PROVISION_FAILURE"|"CLEANUP_FAILURE"|string; + export interface AutoScalingPolicyStatus { + /** + * Indicates the status of the automatic scaling policy. + */ + State?: AutoScalingPolicyState; + /** + * The reason for a change in status. + */ + StateChangeReason?: AutoScalingPolicyStateChangeReason; + } + export type Boolean = boolean; + export type BooleanObject = boolean; + export interface BootstrapActionConfig { + /** + * The name of the bootstrap action. + */ + Name: XmlStringMaxLen256; + /** + * The script run by the bootstrap action. + */ + ScriptBootstrapAction: ScriptBootstrapActionConfig; + } + export type BootstrapActionConfigList = BootstrapActionConfig[]; + export interface BootstrapActionDetail { + /** + * A description of the bootstrap action. + */ + BootstrapActionConfig?: BootstrapActionConfig; + } + export type BootstrapActionDetailList = BootstrapActionDetail[]; + export interface CancelStepsInfo { + /** + * The encrypted StepId of a step. + */ + StepId?: StepId; + /** + * The status of a CancelSteps Request. The value may be SUBMITTED or FAILED. + */ + Status?: CancelStepsRequestStatus; + /** + * The reason for the failure if the CancelSteps request fails. + */ + Reason?: String; + } + export type CancelStepsInfoList = CancelStepsInfo[]; + export interface CancelStepsInput { + /** + * The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs. + */ + ClusterId?: XmlStringMaxLen256; + /** + * The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster. + */ + StepIds?: StepIdsList; + } + export interface CancelStepsOutput { + /** + * A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified. + */ + CancelStepsInfoList?: CancelStepsInfoList; + } + export type CancelStepsRequestStatus = "SUBMITTED"|"FAILED"|string; + export interface CloudWatchAlarmDefinition { + /** + * Determines how the metric specified by MetricName is compared to the value specified by Threshold. + */ + ComparisonOperator: ComparisonOperator; + /** + * The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1. + */ + EvaluationPeriods?: Integer; + /** + * The name of the CloudWatch metric that is watched to determine an alarm condition. + */ + MetricName: String; + /** + * The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce. + */ + Namespace?: String; + /** + * The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300. + */ + Period: Integer; + /** + * The statistic to apply to the metric associated with the alarm. The default is AVERAGE. + */ + Statistic?: Statistic; + /** + * The value against which the specified statistic is compared. + */ + Threshold: NonNegativeDouble; + /** + * The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric. + */ + Unit?: Unit; + /** + * A CloudWatch metric dimension. + */ + Dimensions?: MetricDimensionList; + } + export interface Cluster { + /** + * The unique identifier for the cluster. + */ + Id?: ClusterId; + /** + * The name of the cluster. + */ + Name?: String; + /** + * The current status details about the cluster. + */ + Status?: ClusterStatus; + /** + * Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on. + */ + Ec2InstanceAttributes?: Ec2InstanceAttributes; + /** + * The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration. + */ + InstanceCollectionType?: InstanceCollectionType; + /** + * The path to the Amazon S3 location where logs for this cluster are stored. + */ + LogUri?: String; + /** + * The AMI version requested for this cluster. + */ + RequestedAmiVersion?: String; + /** + * The AMI version running on this cluster. + */ + RunningAmiVersion?: String; + /** + * The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version, for example, emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use AmiVersion. + */ + ReleaseLabel?: String; + /** + * Specifies whether the cluster should terminate after completing all steps. + */ + AutoTerminate?: Boolean; + /** + * Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error. + */ + TerminationProtected?: Boolean; + /** + * Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action. + */ + VisibleToAllUsers?: Boolean; + /** + * The applications installed on this cluster. + */ + Applications?: ApplicationList; + /** + * A list of tags associated with a cluster. + */ + Tags?: TagList; + /** + * The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. + */ + ServiceRole?: String; + /** + * An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate. + */ + NormalizedInstanceHours?: Integer; + /** + * The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name. + */ + MasterPublicDnsName?: String; + /** + * Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster. + */ + Configurations?: ConfigurationList; + /** + * The name of the security configuration applied to the cluster. + */ + SecurityConfiguration?: XmlString; + /** + * An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group. + */ + AutoScalingRole?: XmlString; + /** + * The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0. + */ + ScaleDownBehavior?: ScaleDownBehavior; + /** + * Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI. + */ + CustomAmiId?: XmlStringMaxLen256; + /** + * The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later. + */ + EbsRootVolumeSize?: Integer; + /** + * Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI. + */ + RepoUpgradeOnBoot?: RepoUpgradeOnBoot; + /** + * Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide. + */ + KerberosAttributes?: KerberosAttributes; + } + export type ClusterId = string; + export type ClusterState = "STARTING"|"BOOTSTRAPPING"|"RUNNING"|"WAITING"|"TERMINATING"|"TERMINATED"|"TERMINATED_WITH_ERRORS"|string; + export interface ClusterStateChangeReason { + /** + * The programmatic code for the state change reason. + */ + Code?: ClusterStateChangeReasonCode; + /** + * The descriptive message for the state change reason. + */ + Message?: String; + } + export type ClusterStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"INSTANCE_FLEET_TIMEOUT"|"BOOTSTRAP_FAILURE"|"USER_REQUEST"|"STEP_FAILURE"|"ALL_STEPS_COMPLETED"|string; + export type ClusterStateList = ClusterState[]; + export interface ClusterStatus { + /** + * The current state of the cluster. + */ + State?: ClusterState; + /** + * The reason for the cluster status change. + */ + StateChangeReason?: ClusterStateChangeReason; + /** + * A timeline that represents the status of a cluster over the lifetime of the cluster. + */ + Timeline?: ClusterTimeline; + } + export interface ClusterSummary { + /** + * The unique identifier for the cluster. + */ + Id?: ClusterId; + /** + * The name of the cluster. + */ + Name?: String; + /** + * The details about the current status of the cluster. + */ + Status?: ClusterStatus; + /** + * An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate. + */ + NormalizedInstanceHours?: Integer; + } + export type ClusterSummaryList = ClusterSummary[]; + export interface ClusterTimeline { + /** + * The creation date and time of the cluster. + */ + CreationDateTime?: _Date; + /** + * The date and time when the cluster was ready to execute steps. + */ + ReadyDateTime?: _Date; + /** + * The date and time when the cluster was terminated. + */ + EndDateTime?: _Date; + } + export interface Command { + /** + * The name of the command. + */ + Name?: String; + /** + * The Amazon S3 location of the command script. + */ + ScriptPath?: String; + /** + * Arguments for Amazon EMR to pass to the command for execution. + */ + Args?: StringList; + } + export type CommandList = Command[]; + export type ComparisonOperator = "GREATER_THAN_OR_EQUAL"|"GREATER_THAN"|"LESS_THAN"|"LESS_THAN_OR_EQUAL"|string; + export interface Configuration { + /** + * The classification within a configuration. + */ + Classification?: String; + /** + * A list of additional configurations to apply within a configuration object. + */ + Configurations?: ConfigurationList; + /** + * A set of properties specified within a configuration classification. + */ + Properties?: StringMap; + } + export type ConfigurationList = Configuration[]; + export interface CreateSecurityConfigurationInput { + /** + * The name of the security configuration. + */ + Name: XmlString; + /** + * The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide. + */ + SecurityConfiguration: String; + } + export interface CreateSecurityConfigurationOutput { + /** + * The name of the security configuration. + */ + Name: XmlString; + /** + * The date and time the security configuration was created. + */ + CreationDateTime: _Date; + } + export type _Date = Date; + export interface DeleteSecurityConfigurationInput { + /** + * The name of the security configuration. + */ + Name: XmlString; + } + export interface DeleteSecurityConfigurationOutput { + } + export interface DescribeClusterInput { + /** + * The identifier of the cluster to describe. + */ + ClusterId: ClusterId; + } + export interface DescribeClusterOutput { + /** + * This output contains the details for the requested cluster. + */ + Cluster?: Cluster; + } + export interface DescribeJobFlowsInput { + /** + * Return only job flows created after this date and time. + */ + CreatedAfter?: _Date; + /** + * Return only job flows created before this date and time. + */ + CreatedBefore?: _Date; + /** + * Return only job flows whose job flow ID is contained in this list. + */ + JobFlowIds?: XmlStringList; + /** + * Return only job flows whose state is contained in this list. + */ + JobFlowStates?: JobFlowExecutionStateList; + } + export interface DescribeJobFlowsOutput { + /** + * A list of job flows matching the parameters supplied. + */ + JobFlows?: JobFlowDetailList; + } + export interface DescribeSecurityConfigurationInput { + /** + * The name of the security configuration. + */ + Name: XmlString; + } + export interface DescribeSecurityConfigurationOutput { + /** + * The name of the security configuration. + */ + Name?: XmlString; + /** + * The security configuration details in JSON format. + */ + SecurityConfiguration?: String; + /** + * The date and time the security configuration was created + */ + CreationDateTime?: _Date; + } + export interface DescribeStepInput { + /** + * The identifier of the cluster with steps to describe. + */ + ClusterId: ClusterId; + /** + * The identifier of the step to describe. + */ + StepId: StepId; + } + export interface DescribeStepOutput { + /** + * The step details for the requested step identifier. + */ + Step?: Step; + } + export type EC2InstanceIdsList = InstanceId[]; + export type EC2InstanceIdsToTerminateList = InstanceId[]; + export interface EbsBlockDevice { + /** + * EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster. + */ + VolumeSpecification?: VolumeSpecification; + /** + * The device name that is exposed to the instance, such as /dev/sdh. + */ + Device?: String; + } + export interface EbsBlockDeviceConfig { + /** + * EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster. + */ + VolumeSpecification: VolumeSpecification; + /** + * Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group + */ + VolumesPerInstance?: Integer; + } + export type EbsBlockDeviceConfigList = EbsBlockDeviceConfig[]; + export type EbsBlockDeviceList = EbsBlockDevice[]; + export interface EbsConfiguration { + /** + * An array of Amazon EBS volume specifications attached to a cluster instance. + */ + EbsBlockDeviceConfigs?: EbsBlockDeviceConfigList; + /** + * Indicates whether an Amazon EBS volume is EBS-optimized. + */ + EbsOptimized?: BooleanObject; + } + export interface EbsVolume { + /** + * The device name that is exposed to the instance, such as /dev/sdh. + */ + Device?: String; + /** + * The volume identifier of the EBS volume. + */ + VolumeId?: String; + } + export type EbsVolumeList = EbsVolume[]; + export interface Ec2InstanceAttributes { + /** + * The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop". + */ + Ec2KeyName?: String; + /** + * To launch the cluster in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster is launched in the normal AWS cloud, outside of a VPC. Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a cluster launched in a VPC. + */ + Ec2SubnetId?: String; + /** + * Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together. + */ + RequestedEc2SubnetIds?: XmlStringMaxLen256List; + /** + * The Availability Zone in which the cluster will run. + */ + Ec2AvailabilityZone?: String; + /** + * Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together. + */ + RequestedEc2AvailabilityZones?: XmlStringMaxLen256List; + /** + * The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role. + */ + IamInstanceProfile?: String; + /** + * The identifier of the Amazon EC2 security group for the master node. + */ + EmrManagedMasterSecurityGroup?: String; + /** + * The identifier of the Amazon EC2 security group for the core and task nodes. + */ + EmrManagedSlaveSecurityGroup?: String; + /** + * The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets. + */ + ServiceAccessSecurityGroup?: String; + /** + * A list of additional Amazon EC2 security group IDs for the master node. + */ + AdditionalMasterSecurityGroups?: StringList; + /** + * A list of additional Amazon EC2 security group IDs for the core and task nodes. + */ + AdditionalSlaveSecurityGroups?: StringList; + } + export interface FailureDetails { + /** + * The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason. + */ + Reason?: String; + /** + * The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure. + */ + Message?: String; + /** + * The path to the log file where the step failure root cause was originally recorded. + */ + LogFile?: String; + } + export interface HadoopJarStepConfig { + /** + * A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function. + */ + Properties?: KeyValueList; + /** + * A path to a JAR file run during the step. + */ + Jar: XmlString; + /** + * The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file. + */ + MainClass?: XmlString; + /** + * A list of command line arguments passed to the JAR file's main function when executed. + */ + Args?: XmlStringList; + } + export interface HadoopStepConfig { + /** + * The path to the JAR file that runs during the step. + */ + Jar?: String; + /** + * The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function. + */ + Properties?: StringMap; + /** + * The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file. + */ + MainClass?: String; + /** + * The list of command line arguments to pass to the JAR file's main function for execution. + */ + Args?: StringList; + } + export interface Instance { + /** + * The unique identifier for the instance in Amazon EMR. + */ + Id?: InstanceId; + /** + * The unique identifier of the instance in Amazon EC2. + */ + Ec2InstanceId?: InstanceId; + /** + * The public DNS name of the instance. + */ + PublicDnsName?: String; + /** + * The public IP address of the instance. + */ + PublicIpAddress?: String; + /** + * The private DNS name of the instance. + */ + PrivateDnsName?: String; + /** + * The private IP address of the instance. + */ + PrivateIpAddress?: String; + /** + * The current status of the instance. + */ + Status?: InstanceStatus; + /** + * The identifier of the instance group to which this instance belongs. + */ + InstanceGroupId?: String; + /** + * The unique identifier of the instance fleet to which an EC2 instance belongs. + */ + InstanceFleetId?: InstanceFleetId; + /** + * The instance purchasing option. Valid values are ON_DEMAND or SPOT. + */ + Market?: MarketType; + /** + * The EC2 instance type, for example m3.xlarge. + */ + InstanceType?: InstanceType; + /** + * The list of EBS volumes that are attached to this instance. + */ + EbsVolumes?: EbsVolumeList; + } + export type InstanceCollectionType = "INSTANCE_FLEET"|"INSTANCE_GROUP"|string; + export interface InstanceFleet { + /** + * The unique identifier of the instance fleet. + */ + Id?: InstanceFleetId; + /** + * A friendly name for the instance fleet. + */ + Name?: XmlStringMaxLen256; + /** + * The current status of the instance fleet. + */ + Status?: InstanceFleetStatus; + /** + * The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK. + */ + InstanceFleetType?: InstanceFleetType; + /** + * The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + */ + TargetOnDemandCapacity?: WholeNumber; + /** + * The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + */ + TargetSpotCapacity?: WholeNumber; + /** + * The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity. + */ + ProvisionedOnDemandCapacity?: WholeNumber; + /** + * The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity. + */ + ProvisionedSpotCapacity?: WholeNumber; + /** + * The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet. + */ + InstanceTypeSpecifications?: InstanceTypeSpecificationList; + /** + * Describes the launch specification for an instance fleet. + */ + LaunchSpecifications?: InstanceFleetProvisioningSpecifications; + } + export interface InstanceFleetConfig { + /** + * The friendly name of the instance fleet. + */ + Name?: XmlStringMaxLen256; + /** + * The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK. + */ + InstanceFleetType: InstanceFleetType; + /** + * The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + */ + TargetOnDemandCapacity?: WholeNumber; + /** + * The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1. + */ + TargetSpotCapacity?: WholeNumber; + /** + * The instance type configurations that define the EC2 instances in the instance fleet. + */ + InstanceTypeConfigs?: InstanceTypeConfigList; + /** + * The launch specification for the instance fleet. + */ + LaunchSpecifications?: InstanceFleetProvisioningSpecifications; + } + export type InstanceFleetConfigList = InstanceFleetConfig[]; + export type InstanceFleetId = string; + export type InstanceFleetList = InstanceFleet[]; + export interface InstanceFleetModifyConfig { + /** + * A unique identifier for the instance fleet. + */ + InstanceFleetId: InstanceFleetId; + /** + * The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity. + */ + TargetOnDemandCapacity?: WholeNumber; + /** + * The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity. + */ + TargetSpotCapacity?: WholeNumber; + } + export interface InstanceFleetProvisioningSpecifications { + /** + * The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior. + */ + SpotSpecification: SpotProvisioningSpecification; + } + export type InstanceFleetState = "PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"RESIZING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|string; + export interface InstanceFleetStateChangeReason { + /** + * A code corresponding to the reason the state change occurred. + */ + Code?: InstanceFleetStateChangeReasonCode; + /** + * An explanatory message. + */ + Message?: String; + } + export type InstanceFleetStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"CLUSTER_TERMINATED"|string; + export interface InstanceFleetStatus { + /** + * A code representing the instance fleet status. PROVISIONING—The instance fleet is provisioning EC2 resources and is not yet ready to run jobs. BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway. RUNNING—EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs. RESIZING—A resize operation is underway. EC2 instances are either being added or removed. SUSPENDED—A resize operation could not complete. Existing EC2 instances are running, but instances can't be added or removed. TERMINATING—The instance fleet is terminating EC2 instances. TERMINATED—The instance fleet is no longer active, and all EC2 instances have been terminated. + */ + State?: InstanceFleetState; + /** + * Provides status change reason details for the instance fleet. + */ + StateChangeReason?: InstanceFleetStateChangeReason; + /** + * Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination. + */ + Timeline?: InstanceFleetTimeline; + } + export interface InstanceFleetTimeline { + /** + * The time and date the instance fleet was created. + */ + CreationDateTime?: _Date; + /** + * The time and date the instance fleet was ready to run jobs. + */ + ReadyDateTime?: _Date; + /** + * The time and date the instance fleet terminated. + */ + EndDateTime?: _Date; + } + export type InstanceFleetType = "MASTER"|"CORE"|"TASK"|string; + export interface InstanceGroup { + /** + * The identifier of the instance group. + */ + Id?: InstanceGroupId; + /** + * The name of the instance group. + */ + Name?: String; + /** + * The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT. + */ + Market?: MarketType; + /** + * The type of the instance group. Valid values are MASTER, CORE or TASK. + */ + InstanceGroupType?: InstanceGroupType; + /** + * The maximum Spot price your are willing to pay for EC2 instances. An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specify the maximum spot price in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price. + */ + BidPrice?: String; + /** + * The EC2 instance type for all instances in the instance group. + */ + InstanceType?: InstanceType; + /** + * The target number of instances for the instance group. + */ + RequestedInstanceCount?: Integer; + /** + * The number of instances currently running in this instance group. + */ + RunningInstanceCount?: Integer; + /** + * The current status of the instance group. + */ + Status?: InstanceGroupStatus; + /** + * Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task). + */ + Configurations?: ConfigurationList; + /** + * The version number of the requested configuration specification for this instance group. + */ + ConfigurationsVersion?: Long; + /** + * A list of configurations that were successfully applied for an instance group last time. + */ + LastSuccessfullyAppliedConfigurations?: ConfigurationList; + /** + * The version number of a configuration specification that was successfully applied for an instance group last time. + */ + LastSuccessfullyAppliedConfigurationsVersion?: Long; + /** + * The EBS block devices that are mapped to this instance group. + */ + EbsBlockDevices?: EbsBlockDeviceList; + /** + * If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O. + */ + EbsOptimized?: BooleanObject; + /** + * Policy for customizing shrink operations. + */ + ShrinkPolicy?: ShrinkPolicy; + /** + * An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy. + */ + AutoScalingPolicy?: AutoScalingPolicyDescription; + } + export interface InstanceGroupConfig { + /** + * Friendly name given to the instance group. + */ + Name?: XmlStringMaxLen256; + /** + * Market type of the EC2 instances used to create a cluster node. + */ + Market?: MarketType; + /** + * The role of the instance group in the cluster. + */ + InstanceRole: InstanceRoleType; + /** + * The maximum Spot price your are willing to pay for EC2 instances. An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specify the maximum spot price in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price. + */ + BidPrice?: XmlStringMaxLen256; + /** + * The EC2 instance type for all instances in the instance group. + */ + InstanceType: InstanceType; + /** + * Target number of instances for the instance group. + */ + InstanceCount: Integer; + /** + * Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task). + */ + Configurations?: ConfigurationList; + /** + * EBS configurations that will be attached to each EC2 instance in the instance group. + */ + EbsConfiguration?: EbsConfiguration; + /** + * An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy. + */ + AutoScalingPolicy?: AutoScalingPolicy; + } + export type InstanceGroupConfigList = InstanceGroupConfig[]; + export interface InstanceGroupDetail { + /** + * Unique identifier for the instance group. + */ + InstanceGroupId?: XmlStringMaxLen256; + /** + * Friendly name for the instance group. + */ + Name?: XmlStringMaxLen256; + /** + * Market type of the EC2 instances used to create a cluster node. + */ + Market: MarketType; + /** + * Instance group role in the cluster + */ + InstanceRole: InstanceRoleType; + /** + * The maximum Spot price your are willing to pay for EC2 instances. An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specified in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price. + */ + BidPrice?: XmlStringMaxLen256; + /** + * EC2 instance type. + */ + InstanceType: InstanceType; + /** + * Target number of instances to run in the instance group. + */ + InstanceRequestCount: Integer; + /** + * Actual count of running instances. + */ + InstanceRunningCount: Integer; + /** + * State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED. + */ + State: InstanceGroupState; + /** + * Details regarding the state of the instance group. + */ + LastStateChangeReason?: XmlString; + /** + * The date/time the instance group was created. + */ + CreationDateTime: _Date; + /** + * The date/time the instance group was started. + */ + StartDateTime?: _Date; + /** + * The date/time the instance group was available to the cluster. + */ + ReadyDateTime?: _Date; + /** + * The date/time the instance group was terminated. + */ + EndDateTime?: _Date; + } + export type InstanceGroupDetailList = InstanceGroupDetail[]; + export type InstanceGroupId = string; + export type InstanceGroupIdsList = XmlStringMaxLen256[]; + export type InstanceGroupList = InstanceGroup[]; + export interface InstanceGroupModifyConfig { + /** + * Unique ID of the instance group to expand or shrink. + */ + InstanceGroupId: XmlStringMaxLen256; + /** + * Target size for the instance group. + */ + InstanceCount?: Integer; + /** + * The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size. + */ + EC2InstanceIdsToTerminate?: EC2InstanceIdsToTerminateList; + /** + * Policy for customizing shrink operations. + */ + ShrinkPolicy?: ShrinkPolicy; + /** + * A list of new or modified configurations to apply for an instance group. + */ + Configurations?: ConfigurationList; + } + export type InstanceGroupModifyConfigList = InstanceGroupModifyConfig[]; + export type InstanceGroupState = "PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"RECONFIGURING"|"RESIZING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|"ARRESTED"|"SHUTTING_DOWN"|"ENDED"|string; + export interface InstanceGroupStateChangeReason { + /** + * The programmable code for the state change reason. + */ + Code?: InstanceGroupStateChangeReasonCode; + /** + * The status change reason description. + */ + Message?: String; + } + export type InstanceGroupStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"CLUSTER_TERMINATED"|string; + export interface InstanceGroupStatus { + /** + * The current state of the instance group. + */ + State?: InstanceGroupState; + /** + * The status change reason details for the instance group. + */ + StateChangeReason?: InstanceGroupStateChangeReason; + /** + * The timeline of the instance group status over time. + */ + Timeline?: InstanceGroupTimeline; + } + export interface InstanceGroupTimeline { + /** + * The creation date and time of the instance group. + */ + CreationDateTime?: _Date; + /** + * The date and time when the instance group became ready to perform tasks. + */ + ReadyDateTime?: _Date; + /** + * The date and time when the instance group terminated. + */ + EndDateTime?: _Date; + } + export type InstanceGroupType = "MASTER"|"CORE"|"TASK"|string; + export type InstanceGroupTypeList = InstanceGroupType[]; + export type InstanceId = string; + export type InstanceList = Instance[]; + export interface InstanceResizePolicy { + /** + * Specific list of instances to be terminated when shrinking an instance group. + */ + InstancesToTerminate?: EC2InstanceIdsList; + /** + * Specific list of instances to be protected when shrinking an instance group. + */ + InstancesToProtect?: EC2InstanceIdsList; + /** + * Decommissioning timeout override for the specific list of instances to be terminated. + */ + InstanceTerminationTimeout?: Integer; + } + export type InstanceRoleType = "MASTER"|"CORE"|"TASK"|string; + export type InstanceState = "AWAITING_FULFILLMENT"|"PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"TERMINATED"|string; + export interface InstanceStateChangeReason { + /** + * The programmable code for the state change reason. + */ + Code?: InstanceStateChangeReasonCode; + /** + * The status change reason description. + */ + Message?: String; + } + export type InstanceStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"BOOTSTRAP_FAILURE"|"CLUSTER_TERMINATED"|string; + export type InstanceStateList = InstanceState[]; + export interface InstanceStatus { + /** + * The current state of the instance. + */ + State?: InstanceState; + /** + * The details of the status change reason for the instance. + */ + StateChangeReason?: InstanceStateChangeReason; + /** + * The timeline of the instance status over time. + */ + Timeline?: InstanceTimeline; + } + export interface InstanceTimeline { + /** + * The creation date and time of the instance. + */ + CreationDateTime?: _Date; + /** + * The date and time when the instance was ready to perform tasks. + */ + ReadyDateTime?: _Date; + /** + * The date and time when the instance was terminated. + */ + EndDateTime?: _Date; + } + export type InstanceType = string; + export interface InstanceTypeConfig { + /** + * An EC2 instance type, such as m3.xlarge. + */ + InstanceType: InstanceType; + /** + * The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified. + */ + WeightedCapacity?: WholeNumber; + /** + * The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. + */ + BidPrice?: XmlStringMaxLen256; + /** + * The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. + */ + BidPriceAsPercentageOfOnDemandPrice?: NonNegativeDouble; + /** + * The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType. + */ + EbsConfiguration?: EbsConfiguration; + /** + * A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster. + */ + Configurations?: ConfigurationList; + } + export type InstanceTypeConfigList = InstanceTypeConfig[]; + export interface InstanceTypeSpecification { + /** + * The EC2 instance type, for example m3.xlarge. + */ + InstanceType?: InstanceType; + /** + * The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1. + */ + WeightedCapacity?: WholeNumber; + /** + * The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. + */ + BidPrice?: XmlStringMaxLen256; + /** + * The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). + */ + BidPriceAsPercentageOfOnDemandPrice?: NonNegativeDouble; + /** + * A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. + */ + Configurations?: ConfigurationList; + /** + * The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType. + */ + EbsBlockDevices?: EbsBlockDeviceList; + /** + * Evaluates to TRUE when the specified InstanceType is EBS-optimized. + */ + EbsOptimized?: BooleanObject; + } + export type InstanceTypeSpecificationList = InstanceTypeSpecification[]; + export type Integer = number; + export interface JobFlowDetail { + /** + * The job flow identifier. + */ + JobFlowId: XmlStringMaxLen256; + /** + * The name of the job flow. + */ + Name: XmlStringMaxLen256; + /** + * The location in Amazon S3 where log files for the job are stored. + */ + LogUri?: XmlString; + /** + * Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. + */ + AmiVersion?: XmlStringMaxLen256; + /** + * Describes the execution status of the job flow. + */ + ExecutionStatusDetail: JobFlowExecutionStatusDetail; + /** + * Describes the Amazon EC2 instances of the job flow. + */ + Instances: JobFlowInstancesDetail; + /** + * A list of steps run by the job flow. + */ + Steps?: StepDetailList; + /** + * A list of the bootstrap actions run by the job flow. + */ + BootstrapActions?: BootstrapActionDetailList; + /** + * A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty. + */ + SupportedProducts?: SupportedProductsList; + /** + * Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action. + */ + VisibleToAllUsers?: Boolean; + /** + * The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role. + */ + JobFlowRole?: XmlString; + /** + * The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. + */ + ServiceRole?: XmlString; + /** + * An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group. + */ + AutoScalingRole?: XmlString; + /** + * The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0. + */ + ScaleDownBehavior?: ScaleDownBehavior; + } + export type JobFlowDetailList = JobFlowDetail[]; + export type JobFlowExecutionState = "STARTING"|"BOOTSTRAPPING"|"RUNNING"|"WAITING"|"SHUTTING_DOWN"|"TERMINATED"|"COMPLETED"|"FAILED"|string; + export type JobFlowExecutionStateList = JobFlowExecutionState[]; + export interface JobFlowExecutionStatusDetail { + /** + * The state of the job flow. + */ + State: JobFlowExecutionState; + /** + * The creation date and time of the job flow. + */ + CreationDateTime: _Date; + /** + * The start date and time of the job flow. + */ + StartDateTime?: _Date; + /** + * The date and time when the job flow was ready to start running bootstrap actions. + */ + ReadyDateTime?: _Date; + /** + * The completion date and time of the job flow. + */ + EndDateTime?: _Date; + /** + * Description of the job flow last changed state. + */ + LastStateChangeReason?: XmlString; + } + export interface JobFlowInstancesConfig { + /** + * The EC2 instance type of the master node. + */ + MasterInstanceType?: InstanceType; + /** + * The EC2 instance type of the core and task nodes. + */ + SlaveInstanceType?: InstanceType; + /** + * The number of EC2 instances in the cluster. + */ + InstanceCount?: Integer; + /** + * Configuration for the instance groups in a cluster. + */ + InstanceGroups?: InstanceGroupConfigList; + /** + * The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration. + */ + InstanceFleets?: InstanceFleetConfigList; + /** + * The name of the EC2 key pair that can be used to ssh to the master node as the user called "hadoop." + */ + Ec2KeyName?: XmlStringMaxLen256; + /** + * The Availability Zone in which the cluster runs. + */ + Placement?: PlacementType; + /** + * Specifies whether the cluster should remain available after completing all steps. + */ + KeepJobFlowAliveWhenNoSteps?: Boolean; + /** + * Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error. + */ + TerminationProtected?: Boolean; + /** + * Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used. + */ + HadoopVersion?: XmlStringMaxLen256; + /** + * Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster launches in the normal Amazon Web Services cloud, outside of an Amazon VPC, if the account launching the cluster supports EC2 Classic networks in the region where the cluster launches. Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for clusters launched in an Amazon VPC. + */ + Ec2SubnetId?: XmlStringMaxLen256; + /** + * Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + */ + Ec2SubnetIds?: XmlStringMaxLen256List; + /** + * The identifier of the Amazon EC2 security group for the master node. + */ + EmrManagedMasterSecurityGroup?: XmlStringMaxLen256; + /** + * The identifier of the Amazon EC2 security group for the core and task nodes. + */ + EmrManagedSlaveSecurityGroup?: XmlStringMaxLen256; + /** + * The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets. + */ + ServiceAccessSecurityGroup?: XmlStringMaxLen256; + /** + * A list of additional Amazon EC2 security group IDs for the master node. + */ + AdditionalMasterSecurityGroups?: SecurityGroupsList; + /** + * A list of additional Amazon EC2 security group IDs for the core and task nodes. + */ + AdditionalSlaveSecurityGroups?: SecurityGroupsList; + } + export interface JobFlowInstancesDetail { + /** + * The Amazon EC2 master node instance type. + */ + MasterInstanceType: InstanceType; + /** + * The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name. + */ + MasterPublicDnsName?: XmlString; + /** + * The Amazon EC2 instance identifier of the master node. + */ + MasterInstanceId?: XmlString; + /** + * The Amazon EC2 core and task node instance type. + */ + SlaveInstanceType: InstanceType; + /** + * The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes. + */ + InstanceCount: Integer; + /** + * Details about the instance groups in a cluster. + */ + InstanceGroups?: InstanceGroupDetailList; + /** + * An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate. + */ + NormalizedInstanceHours?: Integer; + /** + * The name of an Amazon EC2 key pair that can be used to ssh to the master node. + */ + Ec2KeyName?: XmlStringMaxLen256; + /** + * For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched. + */ + Ec2SubnetId?: XmlStringMaxLen256; + /** + * The Amazon EC2 Availability Zone for the cluster. + */ + Placement?: PlacementType; + /** + * Specifies whether the cluster should remain available after completing all steps. + */ + KeepJobFlowAliveWhenNoSteps?: Boolean; + /** + * Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error. + */ + TerminationProtected?: Boolean; + /** + * The Hadoop version for the cluster. + */ + HadoopVersion?: XmlStringMaxLen256; + } + export interface KerberosAttributes { + /** + * The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL. + */ + Realm: XmlStringMaxLen256; + /** + * The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster. + */ + KdcAdminPassword: XmlStringMaxLen256; + /** + * Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms. + */ + CrossRealmTrustPrincipalPassword?: XmlStringMaxLen256; + /** + * Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain. + */ + ADDomainJoinUser?: XmlStringMaxLen256; + /** + * The Active Directory password for ADDomainJoinUser. + */ + ADDomainJoinPassword?: XmlStringMaxLen256; + } + export interface KeyValue { + /** + * The unique identifier of a key value pair. + */ + Key?: XmlString; + /** + * The value part of the identified key. + */ + Value?: XmlString; + } + export type KeyValueList = KeyValue[]; + export interface ListBootstrapActionsInput { + /** + * The cluster identifier for the bootstrap actions to list. + */ + ClusterId: ClusterId; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListBootstrapActionsOutput { + /** + * The bootstrap actions associated with the cluster. + */ + BootstrapActions?: CommandList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListClustersInput { + /** + * The creation date and time beginning value filter for listing clusters. + */ + CreatedAfter?: _Date; + /** + * The creation date and time end value filter for listing clusters. + */ + CreatedBefore?: _Date; + /** + * The cluster state filters to apply when listing clusters. + */ + ClusterStates?: ClusterStateList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListClustersOutput { + /** + * The list of clusters for the account based on the given filters. + */ + Clusters?: ClusterSummaryList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListInstanceFleetsInput { + /** + * The unique identifier of the cluster. + */ + ClusterId: ClusterId; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListInstanceFleetsOutput { + /** + * The list of instance fleets for the cluster and given filters. + */ + InstanceFleets?: InstanceFleetList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListInstanceGroupsInput { + /** + * The identifier of the cluster for which to list the instance groups. + */ + ClusterId: ClusterId; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListInstanceGroupsOutput { + /** + * The list of instance groups for the cluster and given filters. + */ + InstanceGroups?: InstanceGroupList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListInstancesInput { + /** + * The identifier of the cluster for which to list the instances. + */ + ClusterId: ClusterId; + /** + * The identifier of the instance group for which to list the instances. + */ + InstanceGroupId?: InstanceGroupId; + /** + * The type of instance group for which to list the instances. + */ + InstanceGroupTypes?: InstanceGroupTypeList; + /** + * The unique identifier of the instance fleet. + */ + InstanceFleetId?: InstanceFleetId; + /** + * The node type of the instance fleet. For example MASTER, CORE, or TASK. + */ + InstanceFleetType?: InstanceFleetType; + /** + * A list of instance states that will filter the instances returned with this request. + */ + InstanceStates?: InstanceStateList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListInstancesOutput { + /** + * The list of instances for the cluster and given filters. + */ + Instances?: InstanceList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListSecurityConfigurationsInput { + /** + * The pagination token that indicates the set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListSecurityConfigurationsOutput { + /** + * The creation date and time, and name, of each security configuration. + */ + SecurityConfigurations?: SecurityConfigurationList; + /** + * A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required. + */ + Marker?: Marker; + } + export interface ListStepsInput { + /** + * The identifier of the cluster for which to list the steps. + */ + ClusterId: ClusterId; + /** + * The filter to limit the step list based on certain states. + */ + StepStates?: StepStateList; + /** + * The filter to limit the step list based on the identifier of the steps. + */ + StepIds?: XmlStringList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export interface ListStepsOutput { + /** + * The filtered list of steps for the cluster. + */ + Steps?: StepSummaryList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + Marker?: Marker; + } + export type Long = number; + export type Marker = string; + export type MarketType = "ON_DEMAND"|"SPOT"|string; + export interface MetricDimension { + /** + * The dimension name. + */ + Key?: String; + /** + * The dimension value. + */ + Value?: String; + } + export type MetricDimensionList = MetricDimension[]; + export interface ModifyInstanceFleetInput { + /** + * The unique identifier of the cluster. + */ + ClusterId: ClusterId; + /** + * The unique identifier of the instance fleet. + */ + InstanceFleet: InstanceFleetModifyConfig; + } + export interface ModifyInstanceGroupsInput { + /** + * The ID of the cluster to which the instance group belongs. + */ + ClusterId?: ClusterId; + /** + * Instance groups to change. + */ + InstanceGroups?: InstanceGroupModifyConfigList; + } + export type NewSupportedProductsList = SupportedProductConfig[]; + export type NonNegativeDouble = number; + export interface PlacementType { + /** + * The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets. + */ + AvailabilityZone?: XmlString; + /** + * When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. + */ + AvailabilityZones?: XmlStringMaxLen256List; + } + export interface PutAutoScalingPolicyInput { + /** + * Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster. + */ + ClusterId: ClusterId; + /** + * Specifies the ID of the instance group to which the automatic scaling policy is applied. + */ + InstanceGroupId: InstanceGroupId; + /** + * Specifies the definition of the automatic scaling policy. + */ + AutoScalingPolicy: AutoScalingPolicy; + } + export interface PutAutoScalingPolicyOutput { + /** + * Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster. + */ + ClusterId?: ClusterId; + /** + * Specifies the ID of the instance group to which the scaling policy is applied. + */ + InstanceGroupId?: InstanceGroupId; + /** + * The automatic scaling policy definition. + */ + AutoScalingPolicy?: AutoScalingPolicyDescription; + } + export interface RemoveAutoScalingPolicyInput { + /** + * Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster. + */ + ClusterId: ClusterId; + /** + * Specifies the ID of the instance group to which the scaling policy is applied. + */ + InstanceGroupId: InstanceGroupId; + } + export interface RemoveAutoScalingPolicyOutput { + } + export interface RemoveTagsInput { + /** + * The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier. + */ + ResourceId: ResourceId; + /** + * A list of tag keys to remove from a resource. + */ + TagKeys: StringList; + } + export interface RemoveTagsOutput { + } + export type RepoUpgradeOnBoot = "SECURITY"|"NONE"|string; + export type ResourceId = string; + export interface RunJobFlowInput { + /** + * The name of the job flow. + */ + Name: XmlStringMaxLen256; + /** + * The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created. + */ + LogUri?: XmlString; + /** + * A JSON string for selecting additional features. + */ + AdditionalInfo?: XmlString; + /** + * Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. + */ + AmiVersion?: XmlStringMaxLen256; + /** + * The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version, for example, emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use AmiVersion. + */ + ReleaseLabel?: XmlStringMaxLen256; + /** + * A specification of the number and type of Amazon EC2 instances. + */ + Instances: JobFlowInstancesConfig; + /** + * A list of steps to run. + */ + Steps?: StepConfigList; + /** + * A list of bootstrap actions to run before Hadoop starts on the cluster nodes. + */ + BootstrapActions?: BootstrapActionConfigList; + /** + * For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are: "mapr-m3" - launch the job flow using MapR M3 Edition. "mapr-m5" - launch the job flow using MapR M5 Edition. + */ + SupportedProducts?: SupportedProductsList; + /** + * For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. Supported values are: "mapr-m3" - launch the cluster using MapR M3 Edition. "mapr-m5" - launch the cluster using MapR M5 Edition. "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively. "mapr-m7" - launch the cluster using MapR M7 Edition. "hunk" - launch the cluster with the Hunk Big Data Analtics Platform. "hue"- launch the cluster with Hue installed. "spark" - launch the cluster with Apache Spark installed. "ganglia" - launch the cluster with the Ganglia Monitoring System installed. + */ + NewSupportedProducts?: NewSupportedProductsList; + /** + * Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide. + */ + Applications?: ApplicationList; + /** + * For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating. + */ + Configurations?: ConfigurationList; + /** + * Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to false, only the IAM user that created the cluster can view and manage it. + */ + VisibleToAllUsers?: Boolean; + /** + * Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console. + */ + JobFlowRole?: XmlString; + /** + * The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. + */ + ServiceRole?: XmlString; + /** + * A list of tags to associate with a cluster and propagate to Amazon EC2 instances. + */ + Tags?: TagList; + /** + * The name of a security configuration to apply to the cluster. + */ + SecurityConfiguration?: XmlString; + /** + * An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group. + */ + AutoScalingRole?: XmlString; + /** + * Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0. + */ + ScaleDownBehavior?: ScaleDownBehavior; + /** + * Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead. For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI. + */ + CustomAmiId?: XmlStringMaxLen256; + /** + * The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later. + */ + EbsRootVolumeSize?: Integer; + /** + * Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually. + */ + RepoUpgradeOnBoot?: RepoUpgradeOnBoot; + /** + * Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide. + */ + KerberosAttributes?: KerberosAttributes; + } + export interface RunJobFlowOutput { + /** + * An unique identifier for the job flow. + */ + JobFlowId?: XmlStringMaxLen256; + } + export type ScaleDownBehavior = "TERMINATE_AT_INSTANCE_HOUR"|"TERMINATE_AT_TASK_COMPLETION"|string; + export interface ScalingAction { + /** + * Not available for instance groups. Instance groups use the market type specified for the group. + */ + Market?: MarketType; + /** + * The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment. + */ + SimpleScalingPolicyConfiguration: SimpleScalingPolicyConfiguration; + } + export interface ScalingConstraints { + /** + * The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary. + */ + MinCapacity: Integer; + /** + * The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary. + */ + MaxCapacity: Integer; + } + export interface ScalingRule { + /** + * The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy. + */ + Name: String; + /** + * A friendly, more verbose description of the automatic scaling rule. + */ + Description?: String; + /** + * The conditions that trigger an automatic scaling activity. + */ + Action: ScalingAction; + /** + * The CloudWatch alarm definition that determines when automatic scaling activity is triggered. + */ + Trigger: ScalingTrigger; + } + export type ScalingRuleList = ScalingRule[]; + export interface ScalingTrigger { + /** + * The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins. + */ + CloudWatchAlarmDefinition: CloudWatchAlarmDefinition; + } + export interface ScriptBootstrapActionConfig { + /** + * Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system. + */ + Path: XmlString; + /** + * A list of command line arguments to pass to the bootstrap action script. + */ + Args?: XmlStringList; + } + export type SecurityConfigurationList = SecurityConfigurationSummary[]; + export interface SecurityConfigurationSummary { + /** + * The name of the security configuration. + */ + Name?: XmlString; + /** + * The date and time the security configuration was created. + */ + CreationDateTime?: _Date; + } + export type SecurityGroupsList = XmlStringMaxLen256[]; + export interface SetTerminationProtectionInput { + /** + * A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows . + */ + JobFlowIds: XmlStringList; + /** + * A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error. + */ + TerminationProtected: Boolean; + } + export interface SetVisibleToAllUsersInput { + /** + * Identifiers of the job flows to receive the new visibility setting. + */ + JobFlowIds: XmlStringList; + /** + * Whether the specified clusters are visible to all IAM users of the AWS account associated with the cluster. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the clusters. If it is set to False, only the IAM user that created a cluster can view and manage it. + */ + VisibleToAllUsers: Boolean; + } + export interface ShrinkPolicy { + /** + * The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout. + */ + DecommissionTimeout?: Integer; + /** + * Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group. + */ + InstanceResizePolicy?: InstanceResizePolicy; + } + export interface SimpleScalingPolicyConfiguration { + /** + * The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer. + */ + AdjustmentType?: AdjustmentType; + /** + * The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity. + */ + ScalingAdjustment: Integer; + /** + * The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0. + */ + CoolDown?: Integer; + } + export interface SpotProvisioningSpecification { + /** + * The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created. + */ + TimeoutDurationMinutes: WholeNumber; + /** + * The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity. + */ + TimeoutAction: SpotProvisioningTimeoutAction; + /** + * The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. + */ + BlockDurationMinutes?: WholeNumber; + } + export type SpotProvisioningTimeoutAction = "SWITCH_TO_ON_DEMAND"|"TERMINATE_CLUSTER"|string; + export type Statistic = "SAMPLE_COUNT"|"AVERAGE"|"SUM"|"MINIMUM"|"MAXIMUM"|string; + export interface Step { + /** + * The identifier of the cluster step. + */ + Id?: StepId; + /** + * The name of the cluster step. + */ + Name?: String; + /** + * The Hadoop job configuration of the cluster step. + */ + Config?: HadoopStepConfig; + /** + * The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + */ + ActionOnFailure?: ActionOnFailure; + /** + * The current execution status details of the cluster step. + */ + Status?: StepStatus; + } + export interface StepConfig { + /** + * The name of the step. + */ + Name: XmlStringMaxLen256; + /** + * The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + */ + ActionOnFailure?: ActionOnFailure; + /** + * The JAR file used for the step. + */ + HadoopJarStep: HadoopJarStepConfig; + } + export type StepConfigList = StepConfig[]; + export interface StepDetail { + /** + * The step configuration. + */ + StepConfig: StepConfig; + /** + * The description of the step status. + */ + ExecutionStatusDetail: StepExecutionStatusDetail; + } + export type StepDetailList = StepDetail[]; + export type StepExecutionState = "PENDING"|"RUNNING"|"CONTINUE"|"COMPLETED"|"CANCELLED"|"FAILED"|"INTERRUPTED"|string; + export interface StepExecutionStatusDetail { + /** + * The state of the step. + */ + State: StepExecutionState; + /** + * The creation date and time of the step. + */ + CreationDateTime: _Date; + /** + * The start date and time of the step. + */ + StartDateTime?: _Date; + /** + * The completion date and time of the step. + */ + EndDateTime?: _Date; + /** + * A description of the step's current state. + */ + LastStateChangeReason?: XmlString; + } + export type StepId = string; + export type StepIdsList = XmlStringMaxLen256[]; + export type StepState = "PENDING"|"CANCEL_PENDING"|"RUNNING"|"COMPLETED"|"CANCELLED"|"FAILED"|"INTERRUPTED"|string; + export interface StepStateChangeReason { + /** + * The programmable code for the state change reason. Note: Currently, the service provides no code for the state change. + */ + Code?: StepStateChangeReasonCode; + /** + * The descriptive message for the state change reason. + */ + Message?: String; + } + export type StepStateChangeReasonCode = "NONE"|string; + export type StepStateList = StepState[]; + export interface StepStatus { + /** + * The execution state of the cluster step. + */ + State?: StepState; + /** + * The reason for the step execution status change. + */ + StateChangeReason?: StepStateChangeReason; + /** + * The details for the step failure including reason, message, and log file path where the root cause was identified. + */ + FailureDetails?: FailureDetails; + /** + * The timeline of the cluster step status over time. + */ + Timeline?: StepTimeline; + } + export interface StepSummary { + /** + * The identifier of the cluster step. + */ + Id?: StepId; + /** + * The name of the cluster step. + */ + Name?: String; + /** + * The Hadoop job configuration of the cluster step. + */ + Config?: HadoopStepConfig; + /** + * The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + */ + ActionOnFailure?: ActionOnFailure; + /** + * The current execution status details of the cluster step. + */ + Status?: StepStatus; + } + export type StepSummaryList = StepSummary[]; + export interface StepTimeline { + /** + * The date and time when the cluster step was created. + */ + CreationDateTime?: _Date; + /** + * The date and time when the cluster step execution started. + */ + StartDateTime?: _Date; + /** + * The date and time when the cluster step execution completed or failed. + */ + EndDateTime?: _Date; + } + export type String = string; + export type StringList = String[]; + export type StringMap = {[key: string]: String}; + export interface SupportedProductConfig { + /** + * The name of the product configuration. + */ + Name?: XmlStringMaxLen256; + /** + * The list of user-supplied arguments. + */ + Args?: XmlStringList; + } + export type SupportedProductsList = XmlStringMaxLen256[]; + export interface Tag { + /** + * A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag . + */ + Key?: String; + /** + * A user-defined value, which is optional in a tag. For more information, see Tag Clusters. + */ + Value?: String; + } + export type TagList = Tag[]; + export interface TerminateJobFlowsInput { + /** + * A list of job flows to be shutdown. + */ + JobFlowIds: XmlStringList; + } + export type Unit = "NONE"|"SECONDS"|"MICRO_SECONDS"|"MILLI_SECONDS"|"BYTES"|"KILO_BYTES"|"MEGA_BYTES"|"GIGA_BYTES"|"TERA_BYTES"|"BITS"|"KILO_BITS"|"MEGA_BITS"|"GIGA_BITS"|"TERA_BITS"|"PERCENT"|"COUNT"|"BYTES_PER_SECOND"|"KILO_BYTES_PER_SECOND"|"MEGA_BYTES_PER_SECOND"|"GIGA_BYTES_PER_SECOND"|"TERA_BYTES_PER_SECOND"|"BITS_PER_SECOND"|"KILO_BITS_PER_SECOND"|"MEGA_BITS_PER_SECOND"|"GIGA_BITS_PER_SECOND"|"TERA_BITS_PER_SECOND"|"COUNT_PER_SECOND"|string; + export interface VolumeSpecification { + /** + * The volume type. Volume types supported are gp2, io1, standard. + */ + VolumeType: String; + /** + * The number of I/O operations per second (IOPS) that the volume supports. + */ + Iops?: Integer; + /** + * The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10. + */ + SizeInGB: Integer; + } + export type WholeNumber = number; + export type XmlString = string; + export type XmlStringList = XmlString[]; + export type XmlStringMaxLen256 = string; + export type XmlStringMaxLen256List = XmlStringMaxLen256[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2009-03-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the EMR client. + */ + export import Types = EMR; +} +export = EMR; diff --git a/node_modules/aws-sdk/clients/emr.js b/node_modules/aws-sdk/clients/emr.js new file mode 100644 index 0000000..a53499a --- /dev/null +++ b/node_modules/aws-sdk/clients/emr.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['emr'] = {}; +AWS.EMR = Service.defineService('emr', ['2009-03-31']); +Object.defineProperty(apiLoader.services['emr'], '2009-03-31', { + get: function get() { + var model = require('../apis/elasticmapreduce-2009-03-31.min.json'); + model.paginators = require('../apis/elasticmapreduce-2009-03-31.paginators.json').pagination; + model.waiters = require('../apis/elasticmapreduce-2009-03-31.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.EMR; diff --git a/node_modules/aws-sdk/clients/es.d.ts b/node_modules/aws-sdk/clients/es.d.ts new file mode 100644 index 0000000..2b2f143 --- /dev/null +++ b/node_modules/aws-sdk/clients/es.d.ts @@ -0,0 +1,1298 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ES extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ES.Types.ClientConfiguration) + config: Config & ES.Types.ClientConfiguration; + /** + * Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information. + */ + addTags(params: ES.Types.AddTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information. + */ + addTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state. + */ + cancelElasticsearchServiceSoftwareUpdate(params: ES.Types.CancelElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request; + /** + * Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state. + */ + cancelElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request; + /** + * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide. + */ + createElasticsearchDomain(params: ES.Types.CreateElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request; + /** + * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide. + */ + createElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request; + /** + * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. + */ + deleteElasticsearchDomain(params: ES.Types.DeleteElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request; + /** + * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. + */ + deleteElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request; + /** + * Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains. + */ + deleteElasticsearchServiceRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN. + */ + describeElasticsearchDomain(params: ES.Types.DescribeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request; + /** + * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN. + */ + describeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request; + /** + * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options. + */ + describeElasticsearchDomainConfig(params: ES.Types.DescribeElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request; + /** + * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options. + */ + describeElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request; + /** + * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN. + */ + describeElasticsearchDomains(params: ES.Types.DescribeElasticsearchDomainsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request; + /** + * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN. + */ + describeElasticsearchDomains(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request; + /** + * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying. + */ + describeElasticsearchInstanceTypeLimits(params: ES.Types.DescribeElasticsearchInstanceTypeLimitsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request; + /** + * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying. + */ + describeElasticsearchInstanceTypeLimits(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request; + /** + * Lists available reserved Elasticsearch instance offerings. + */ + describeReservedElasticsearchInstanceOfferings(params: ES.Types.DescribeReservedElasticsearchInstanceOfferingsRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request; + /** + * Lists available reserved Elasticsearch instance offerings. + */ + describeReservedElasticsearchInstanceOfferings(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request; + /** + * Returns information about reserved Elasticsearch instances for this account. + */ + describeReservedElasticsearchInstances(params: ES.Types.DescribeReservedElasticsearchInstancesRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request; + /** + * Returns information about reserved Elasticsearch instances for this account. + */ + describeReservedElasticsearchInstances(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request; + /** + * Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain. + */ + getCompatibleElasticsearchVersions(params: ES.Types.GetCompatibleElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request; + /** + * Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain. + */ + getCompatibleElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request; + /** + * Retrieves the complete history of the last 10 upgrades that were performed on the domain. + */ + getUpgradeHistory(params: ES.Types.GetUpgradeHistoryRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request; + /** + * Retrieves the complete history of the last 10 upgrades that were performed on the domain. + */ + getUpgradeHistory(callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request; + /** + * Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain. + */ + getUpgradeStatus(params: ES.Types.GetUpgradeStatusRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request; + /** + * Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain. + */ + getUpgradeStatus(callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request; + /** + * Returns the name of all Elasticsearch domains owned by the current user's account. + */ + listDomainNames(callback?: (err: AWSError, data: ES.Types.ListDomainNamesResponse) => void): Request; + /** + * List all Elasticsearch instance types that are supported for given ElasticsearchVersion + */ + listElasticsearchInstanceTypes(params: ES.Types.ListElasticsearchInstanceTypesRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request; + /** + * List all Elasticsearch instance types that are supported for given ElasticsearchVersion + */ + listElasticsearchInstanceTypes(callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request; + /** + * List all supported Elasticsearch versions + */ + listElasticsearchVersions(params: ES.Types.ListElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request; + /** + * List all supported Elasticsearch versions + */ + listElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request; + /** + * Returns all tags for the given Elasticsearch domain. + */ + listTags(params: ES.Types.ListTagsRequest, callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request; + /** + * Returns all tags for the given Elasticsearch domain. + */ + listTags(callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request; + /** + * Allows you to purchase reserved Elasticsearch instances. + */ + purchaseReservedElasticsearchInstanceOffering(params: ES.Types.PurchaseReservedElasticsearchInstanceOfferingRequest, callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request; + /** + * Allows you to purchase reserved Elasticsearch instances. + */ + purchaseReservedElasticsearchInstanceOffering(callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request; + /** + * Removes the specified set of tags from the specified Elasticsearch domain. + */ + removeTags(params: ES.Types.RemoveTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified set of tags from the specified Elasticsearch domain. + */ + removeTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Schedules a service software update for an Amazon ES domain. + */ + startElasticsearchServiceSoftwareUpdate(params: ES.Types.StartElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request; + /** + * Schedules a service software update for an Amazon ES domain. + */ + startElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request; + /** + * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. + */ + updateElasticsearchDomainConfig(params: ES.Types.UpdateElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request; + /** + * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. + */ + updateElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request; + /** + * Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version. + */ + upgradeElasticsearchDomain(params: ES.Types.UpgradeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request; + /** + * Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version. + */ + upgradeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request; +} +declare namespace ES { + export type ARN = string; + export interface AccessPoliciesStatus { + /** + * The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information. + */ + Options: PolicyDocument; + /** + * The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included. + */ + Status: OptionStatus; + } + export interface AddTagsRequest { + /** + * Specify the ARN for which you want to add the tags. + */ + ARN: ARN; + /** + * List of Tag that need to be added for the Elasticsearch domain. + */ + TagList: TagList; + } + export interface AdditionalLimit { + /** + * Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc. Attributes and their details: MaximumNumberOfDataNodesSupported This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node. MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don't need any master nodes to govern them. + */ + LimitName?: LimitName; + /** + * Value for given AdditionalLimit$LimitName . + */ + LimitValues?: LimitValueList; + } + export type AdditionalLimitList = AdditionalLimit[]; + export type AdvancedOptions = {[key: string]: String}; + export interface AdvancedOptionsStatus { + /** + * Specifies the status of advanced options for the specified Elasticsearch domain. + */ + Options: AdvancedOptions; + /** + * Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export type Boolean = boolean; + export interface CancelElasticsearchServiceSoftwareUpdateRequest { + /** + * The name of the domain that you want to stop the latest service software update on. + */ + DomainName: DomainName; + } + export interface CancelElasticsearchServiceSoftwareUpdateResponse { + /** + * The current status of the Elasticsearch service software update. + */ + ServiceSoftwareOptions?: ServiceSoftwareOptions; + } + export type CloudWatchLogsLogGroupArn = string; + export interface CognitoOptions { + /** + * Specifies the option to enable Cognito for Kibana authentication. + */ + Enabled?: Boolean; + /** + * Specifies the Cognito user pool ID for Kibana authentication. + */ + UserPoolId?: UserPoolId; + /** + * Specifies the Cognito identity pool ID for Kibana authentication. + */ + IdentityPoolId?: IdentityPoolId; + /** + * Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources. + */ + RoleArn?: RoleArn; + } + export interface CognitoOptionsStatus { + /** + * Specifies the Cognito options for the specified Elasticsearch domain. + */ + Options: CognitoOptions; + /** + * Specifies the status of the Cognito options for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export type CompatibleElasticsearchVersionsList = CompatibleVersionsMap[]; + export interface CompatibleVersionsMap { + /** + * The current version of Elasticsearch on which a domain is. + */ + SourceVersion?: ElasticsearchVersionString; + TargetVersions?: ElasticsearchVersionList; + } + export interface CreateElasticsearchDomainRequest { + /** + * The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). + */ + DomainName: DomainName; + /** + * String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide. + */ + ElasticsearchVersion?: ElasticsearchVersionString; + /** + * Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. + */ + ElasticsearchClusterConfig?: ElasticsearchClusterConfig; + /** + * Options to enable, disable and specify the type and size of EBS storage volumes. + */ + EBSOptions?: EBSOptions; + /** + * IAM access policy as a JSON-formatted string. + */ + AccessPolicies?: PolicyDocument; + /** + * Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. + */ + SnapshotOptions?: SnapshotOptions; + /** + * Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains + */ + VPCOptions?: VPCOptions; + /** + * Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana. + */ + CognitoOptions?: CognitoOptions; + /** + * Specifies the Encryption At Rest Options. + */ + EncryptionAtRestOptions?: EncryptionAtRestOptions; + /** + * Specifies the NodeToNodeEncryptionOptions. + */ + NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions; + /** + * Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information. + */ + AdvancedOptions?: AdvancedOptions; + /** + * Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log. + */ + LogPublishingOptions?: LogPublishingOptions; + } + export interface CreateElasticsearchDomainResponse { + /** + * The status of the newly created Elasticsearch domain. + */ + DomainStatus?: ElasticsearchDomainStatus; + } + export interface DeleteElasticsearchDomainRequest { + /** + * The name of the Elasticsearch domain that you want to permanently delete. + */ + DomainName: DomainName; + } + export interface DeleteElasticsearchDomainResponse { + /** + * The status of the Elasticsearch domain being deleted. + */ + DomainStatus?: ElasticsearchDomainStatus; + } + export type DeploymentCloseDateTimeStamp = Date; + export type DeploymentStatus = "PENDING_UPDATE"|"IN_PROGRESS"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE"|string; + export interface DescribeElasticsearchDomainConfigRequest { + /** + * The Elasticsearch domain that you want to get information about. + */ + DomainName: DomainName; + } + export interface DescribeElasticsearchDomainConfigResponse { + /** + * The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request. + */ + DomainConfig: ElasticsearchDomainConfig; + } + export interface DescribeElasticsearchDomainRequest { + /** + * The name of the Elasticsearch domain for which you want information. + */ + DomainName: DomainName; + } + export interface DescribeElasticsearchDomainResponse { + /** + * The current status of the Elasticsearch domain. + */ + DomainStatus: ElasticsearchDomainStatus; + } + export interface DescribeElasticsearchDomainsRequest { + /** + * The Elasticsearch domains for which you want information. + */ + DomainNames: DomainNameList; + } + export interface DescribeElasticsearchDomainsResponse { + /** + * The status of the domains requested in the DescribeElasticsearchDomains request. + */ + DomainStatusList: ElasticsearchDomainStatusList; + } + export interface DescribeElasticsearchInstanceTypeLimitsRequest { + /** + * DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain. + */ + DomainName?: DomainName; + /** + * The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed. + */ + InstanceType: ESPartitionInstanceType; + /** + * Version of Elasticsearch for which Limits are needed. + */ + ElasticsearchVersion: ElasticsearchVersionString; + } + export interface DescribeElasticsearchInstanceTypeLimitsResponse { + LimitsByRole?: LimitsByRole; + } + export interface DescribeReservedElasticsearchInstanceOfferingsRequest { + /** + * The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. + */ + ReservedElasticsearchInstanceOfferingId?: GUID; + /** + * Set this value to limit the number of results returned. If not specified, defaults to 100. + */ + MaxResults?: MaxResults; + /** + * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. + */ + NextToken?: NextToken; + } + export interface DescribeReservedElasticsearchInstanceOfferingsResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: NextToken; + /** + * List of reserved Elasticsearch instance offerings + */ + ReservedElasticsearchInstanceOfferings?: ReservedElasticsearchInstanceOfferingList; + } + export interface DescribeReservedElasticsearchInstancesRequest { + /** + * The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID. + */ + ReservedElasticsearchInstanceId?: GUID; + /** + * Set this value to limit the number of results returned. If not specified, defaults to 100. + */ + MaxResults?: MaxResults; + /** + * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. + */ + NextToken?: NextToken; + } + export interface DescribeReservedElasticsearchInstancesResponse { + /** + * Provides an identifier to allow retrieval of paginated results. + */ + NextToken?: String; + /** + * List of reserved Elasticsearch instances. + */ + ReservedElasticsearchInstances?: ReservedElasticsearchInstanceList; + } + export type DomainId = string; + export interface DomainInfo { + /** + * Specifies the DomainName. + */ + DomainName?: DomainName; + } + export type DomainInfoList = DomainInfo[]; + export type DomainName = string; + export type DomainNameList = DomainName[]; + export type Double = number; + export interface EBSOptions { + /** + * Specifies whether EBS-based storage is enabled. + */ + EBSEnabled?: Boolean; + /** + * Specifies the volume type for EBS-based storage. + */ + VolumeType?: VolumeType; + /** + * Integer to specify the size of an EBS volume. + */ + VolumeSize?: IntegerClass; + /** + * Specifies the IOPD for a Provisioned IOPS EBS volume (SSD). + */ + Iops?: IntegerClass; + } + export interface EBSOptionsStatus { + /** + * Specifies the EBS options for the specified Elasticsearch domain. + */ + Options: EBSOptions; + /** + * Specifies the status of the EBS options for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export type ESPartitionInstanceType = "m3.medium.elasticsearch"|"m3.large.elasticsearch"|"m3.xlarge.elasticsearch"|"m3.2xlarge.elasticsearch"|"m4.large.elasticsearch"|"m4.xlarge.elasticsearch"|"m4.2xlarge.elasticsearch"|"m4.4xlarge.elasticsearch"|"m4.10xlarge.elasticsearch"|"t2.micro.elasticsearch"|"t2.small.elasticsearch"|"t2.medium.elasticsearch"|"r3.large.elasticsearch"|"r3.xlarge.elasticsearch"|"r3.2xlarge.elasticsearch"|"r3.4xlarge.elasticsearch"|"r3.8xlarge.elasticsearch"|"i2.xlarge.elasticsearch"|"i2.2xlarge.elasticsearch"|"d2.xlarge.elasticsearch"|"d2.2xlarge.elasticsearch"|"d2.4xlarge.elasticsearch"|"d2.8xlarge.elasticsearch"|"c4.large.elasticsearch"|"c4.xlarge.elasticsearch"|"c4.2xlarge.elasticsearch"|"c4.4xlarge.elasticsearch"|"c4.8xlarge.elasticsearch"|"r4.large.elasticsearch"|"r4.xlarge.elasticsearch"|"r4.2xlarge.elasticsearch"|"r4.4xlarge.elasticsearch"|"r4.8xlarge.elasticsearch"|"r4.16xlarge.elasticsearch"|"i3.large.elasticsearch"|"i3.xlarge.elasticsearch"|"i3.2xlarge.elasticsearch"|"i3.4xlarge.elasticsearch"|"i3.8xlarge.elasticsearch"|"i3.16xlarge.elasticsearch"|string; + export interface ElasticsearchClusterConfig { + /** + * The instance type for an Elasticsearch cluster. + */ + InstanceType?: ESPartitionInstanceType; + /** + * The number of instances in the specified domain cluster. + */ + InstanceCount?: IntegerClass; + /** + * A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information. + */ + DedicatedMasterEnabled?: Boolean; + /** + * A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information. + */ + ZoneAwarenessEnabled?: Boolean; + /** + * Specifies the zone awareness configuration for a domain when zone awareness is enabled. + */ + ZoneAwarenessConfig?: ZoneAwarenessConfig; + /** + * The instance type for a dedicated master node. + */ + DedicatedMasterType?: ESPartitionInstanceType; + /** + * Total number of dedicated master nodes, active and on standby, for the cluster. + */ + DedicatedMasterCount?: IntegerClass; + } + export interface ElasticsearchClusterConfigStatus { + /** + * Specifies the cluster configuration for the specified Elasticsearch domain. + */ + Options: ElasticsearchClusterConfig; + /** + * Specifies the status of the configuration for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export interface ElasticsearchDomainConfig { + /** + * String of format X.Y to specify version for the Elasticsearch domain. + */ + ElasticsearchVersion?: ElasticsearchVersionStatus; + /** + * Specifies the ElasticsearchClusterConfig for the Elasticsearch domain. + */ + ElasticsearchClusterConfig?: ElasticsearchClusterConfigStatus; + /** + * Specifies the EBSOptions for the Elasticsearch domain. + */ + EBSOptions?: EBSOptionsStatus; + /** + * IAM access policy as a JSON-formatted string. + */ + AccessPolicies?: AccessPoliciesStatus; + /** + * Specifies the SnapshotOptions for the Elasticsearch domain. + */ + SnapshotOptions?: SnapshotOptionsStatus; + /** + * The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains. + */ + VPCOptions?: VPCDerivedInfoStatus; + /** + * The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana. + */ + CognitoOptions?: CognitoOptionsStatus; + /** + * Specifies the EncryptionAtRestOptions for the Elasticsearch domain. + */ + EncryptionAtRestOptions?: EncryptionAtRestOptionsStatus; + /** + * Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain. + */ + NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus; + /** + * Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information. + */ + AdvancedOptions?: AdvancedOptionsStatus; + /** + * Log publishing options for the given domain. + */ + LogPublishingOptions?: LogPublishingOptionsStatus; + } + export interface ElasticsearchDomainStatus { + /** + * The unique identifier for the specified Elasticsearch domain. + */ + DomainId: DomainId; + /** + * The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). + */ + DomainName: DomainName; + /** + * The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information. + */ + ARN: ARN; + /** + * The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress. + */ + Created?: Boolean; + /** + * The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned. + */ + Deleted?: Boolean; + /** + * The Elasticsearch domain endpoint that you use to submit index and search requests. + */ + Endpoint?: ServiceUrl; + /** + * Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'. + */ + Endpoints?: EndpointsMap; + /** + * The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active. + */ + Processing?: Boolean; + /** + * The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active. + */ + UpgradeProcessing?: Boolean; + ElasticsearchVersion?: ElasticsearchVersionString; + /** + * The type and number of instances in the domain cluster. + */ + ElasticsearchClusterConfig: ElasticsearchClusterConfig; + /** + * The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information. + */ + EBSOptions?: EBSOptions; + /** + * IAM access policy as a JSON-formatted string. + */ + AccessPolicies?: PolicyDocument; + /** + * Specifies the status of the SnapshotOptions + */ + SnapshotOptions?: SnapshotOptions; + /** + * The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains. + */ + VPCOptions?: VPCDerivedInfo; + /** + * The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana. + */ + CognitoOptions?: CognitoOptions; + /** + * Specifies the status of the EncryptionAtRestOptions. + */ + EncryptionAtRestOptions?: EncryptionAtRestOptions; + /** + * Specifies the status of the NodeToNodeEncryptionOptions. + */ + NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions; + /** + * Specifies the status of the AdvancedOptions + */ + AdvancedOptions?: AdvancedOptions; + /** + * Log publishing options for the given domain. + */ + LogPublishingOptions?: LogPublishingOptions; + /** + * The current status of the Elasticsearch domain's service software. + */ + ServiceSoftwareOptions?: ServiceSoftwareOptions; + } + export type ElasticsearchDomainStatusList = ElasticsearchDomainStatus[]; + export type ElasticsearchInstanceTypeList = ESPartitionInstanceType[]; + export type ElasticsearchVersionList = ElasticsearchVersionString[]; + export interface ElasticsearchVersionStatus { + /** + * Specifies the Elasticsearch version for the specified Elasticsearch domain. + */ + Options: ElasticsearchVersionString; + /** + * Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export type ElasticsearchVersionString = string; + export interface EncryptionAtRestOptions { + /** + * Specifies the option to enable Encryption At Rest. + */ + Enabled?: Boolean; + /** + * Specifies the KMS Key ID for Encryption At Rest options. + */ + KmsKeyId?: KmsKeyId; + } + export interface EncryptionAtRestOptionsStatus { + /** + * Specifies the Encryption At Rest options for the specified Elasticsearch domain. + */ + Options: EncryptionAtRestOptions; + /** + * Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export type EndpointsMap = {[key: string]: ServiceUrl}; + export type GUID = string; + export interface GetCompatibleElasticsearchVersionsRequest { + DomainName?: DomainName; + } + export interface GetCompatibleElasticsearchVersionsResponse { + /** + * A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation. + */ + CompatibleElasticsearchVersions?: CompatibleElasticsearchVersionsList; + } + export interface GetUpgradeHistoryRequest { + DomainName: DomainName; + MaxResults?: MaxResults; + NextToken?: NextToken; + } + export interface GetUpgradeHistoryResponse { + /** + * A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object. + */ + UpgradeHistories?: UpgradeHistoryList; + /** + * Pagination token that needs to be supplied to the next call to get the next page of results + */ + NextToken?: String; + } + export interface GetUpgradeStatusRequest { + DomainName: DomainName; + } + export interface GetUpgradeStatusResponse { + /** + * Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade + */ + UpgradeStep?: UpgradeStep; + /** + * One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed + */ + StepStatus?: UpgradeStatus; + /** + * A string that describes the update briefly + */ + UpgradeName?: UpgradeName; + } + export type IdentityPoolId = string; + export type InstanceCount = number; + export interface InstanceCountLimits { + MinimumInstanceCount?: MinimumInstanceCount; + MaximumInstanceCount?: MaximumInstanceCount; + } + export interface InstanceLimits { + InstanceCountLimits?: InstanceCountLimits; + } + export type InstanceRole = string; + export type Integer = number; + export type IntegerClass = number; + export type Issue = string; + export type Issues = Issue[]; + export type KmsKeyId = string; + export type LimitName = string; + export type LimitValue = string; + export type LimitValueList = LimitValue[]; + export interface Limits { + /** + * StorageType represents the list of storage related types and attributes that are available for given InstanceType. + */ + StorageTypes?: StorageTypeList; + InstanceLimits?: InstanceLimits; + /** + * List of additional limits that are specific to a given InstanceType and for each of it's InstanceRole . + */ + AdditionalLimits?: AdditionalLimitList; + } + export type LimitsByRole = {[key: string]: Limits}; + export interface ListDomainNamesResponse { + /** + * List of Elasticsearch domain names. + */ + DomainNames?: DomainInfoList; + } + export interface ListElasticsearchInstanceTypesRequest { + /** + * Version of Elasticsearch for which list of supported elasticsearch instance types are needed. + */ + ElasticsearchVersion: ElasticsearchVersionString; + /** + * DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain. + */ + DomainName?: DomainName; + /** + * Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored. + */ + MaxResults?: MaxResults; + /** + * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. + */ + NextToken?: NextToken; + } + export interface ListElasticsearchInstanceTypesResponse { + /** + * List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion + */ + ElasticsearchInstanceTypes?: ElasticsearchInstanceTypeList; + /** + * In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results. + */ + NextToken?: NextToken; + } + export interface ListElasticsearchVersionsRequest { + /** + * Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored. + */ + MaxResults?: MaxResults; + NextToken?: NextToken; + } + export interface ListElasticsearchVersionsResponse { + ElasticsearchVersions?: ElasticsearchVersionList; + NextToken?: NextToken; + } + export interface ListTagsRequest { + /** + * Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view. + */ + ARN: ARN; + } + export interface ListTagsResponse { + /** + * List of Tag for the requested Elasticsearch domain. + */ + TagList?: TagList; + } + export interface LogPublishingOption { + CloudWatchLogsLogGroupArn?: CloudWatchLogsLogGroupArn; + /** + * Specifies whether given log publishing option is enabled or not. + */ + Enabled?: Boolean; + } + export type LogPublishingOptions = {[key: string]: LogPublishingOption}; + export interface LogPublishingOptionsStatus { + /** + * The log publishing options configured for the Elasticsearch domain. + */ + Options?: LogPublishingOptions; + /** + * The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included. + */ + Status?: OptionStatus; + } + export type LogType = "INDEX_SLOW_LOGS"|"SEARCH_SLOW_LOGS"|"ES_APPLICATION_LOGS"|string; + export type MaxResults = number; + export type MaximumInstanceCount = number; + export type MinimumInstanceCount = number; + export type NextToken = string; + export interface NodeToNodeEncryptionOptions { + /** + * Specify true to enable node-to-node encryption. + */ + Enabled?: Boolean; + } + export interface NodeToNodeEncryptionOptionsStatus { + /** + * Specifies the node-to-node encryption options for the specified Elasticsearch domain. + */ + Options: NodeToNodeEncryptionOptions; + /** + * Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|string; + export interface OptionStatus { + /** + * Timestamp which tells the creation date for the entity. + */ + CreationDate: UpdateTimestamp; + /** + * Timestamp which tells the last updated time for the entity. + */ + UpdateDate: UpdateTimestamp; + /** + * Specifies the latest version for the entity. + */ + UpdateVersion?: UIntValue; + /** + * Provides the OptionState for the Elasticsearch domain. + */ + State: OptionState; + /** + * Indicates whether the Elasticsearch domain is being deleted. + */ + PendingDeletion?: Boolean; + } + export type PolicyDocument = string; + export interface PurchaseReservedElasticsearchInstanceOfferingRequest { + /** + * The ID of the reserved Elasticsearch instance offering to purchase. + */ + ReservedElasticsearchInstanceOfferingId: GUID; + /** + * A customer-specified identifier to track this reservation. + */ + ReservationName: ReservationToken; + /** + * The number of Elasticsearch instances to reserve. + */ + InstanceCount?: InstanceCount; + } + export interface PurchaseReservedElasticsearchInstanceOfferingResponse { + /** + * Details of the reserved Elasticsearch instance which was purchased. + */ + ReservedElasticsearchInstanceId?: GUID; + /** + * The customer-specified identifier used to track this reservation. + */ + ReservationName?: ReservationToken; + } + export interface RecurringCharge { + /** + * The monetary amount of the recurring charge. + */ + RecurringChargeAmount?: Double; + /** + * The frequency of the recurring charge. + */ + RecurringChargeFrequency?: String; + } + export type RecurringChargeList = RecurringCharge[]; + export interface RemoveTagsRequest { + /** + * Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags. + */ + ARN: ARN; + /** + * Specifies the TagKey list which you want to remove from the Elasticsearch domain. + */ + TagKeys: StringList; + } + export type ReservationToken = string; + export interface ReservedElasticsearchInstance { + /** + * The customer-specified identifier to track this reservation. + */ + ReservationName?: ReservationToken; + /** + * The unique identifier for the reservation. + */ + ReservedElasticsearchInstanceId?: GUID; + /** + * The offering identifier. + */ + ReservedElasticsearchInstanceOfferingId?: String; + /** + * The Elasticsearch instance type offered by the reserved instance offering. + */ + ElasticsearchInstanceType?: ESPartitionInstanceType; + /** + * The time the reservation started. + */ + StartTime?: UpdateTimestamp; + /** + * The duration, in seconds, for which the Elasticsearch instance is reserved. + */ + Duration?: Integer; + /** + * The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering. + */ + FixedPrice?: Double; + /** + * The rate you are charged for each hour for the domain that is using this reserved instance. + */ + UsagePrice?: Double; + /** + * The currency code for the reserved Elasticsearch instance offering. + */ + CurrencyCode?: String; + /** + * The number of Elasticsearch instances that have been reserved. + */ + ElasticsearchInstanceCount?: Integer; + /** + * The state of the reserved Elasticsearch instance. + */ + State?: String; + /** + * The payment option as defined in the reserved Elasticsearch instance offering. + */ + PaymentOption?: ReservedElasticsearchInstancePaymentOption; + /** + * The charge to your account regardless of whether you are creating any domains using the instance offering. + */ + RecurringCharges?: RecurringChargeList; + } + export type ReservedElasticsearchInstanceList = ReservedElasticsearchInstance[]; + export interface ReservedElasticsearchInstanceOffering { + /** + * The Elasticsearch reserved instance offering identifier. + */ + ReservedElasticsearchInstanceOfferingId?: GUID; + /** + * The Elasticsearch instance type offered by the reserved instance offering. + */ + ElasticsearchInstanceType?: ESPartitionInstanceType; + /** + * The duration, in seconds, for which the offering will reserve the Elasticsearch instance. + */ + Duration?: Integer; + /** + * The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering. + */ + FixedPrice?: Double; + /** + * The rate you are charged for each hour the domain that is using the offering is running. + */ + UsagePrice?: Double; + /** + * The currency code for the reserved Elasticsearch instance offering. + */ + CurrencyCode?: String; + /** + * Payment option for the reserved Elasticsearch instance offering + */ + PaymentOption?: ReservedElasticsearchInstancePaymentOption; + /** + * The charge to your account regardless of whether you are creating any domains using the instance offering. + */ + RecurringCharges?: RecurringChargeList; + } + export type ReservedElasticsearchInstanceOfferingList = ReservedElasticsearchInstanceOffering[]; + export type ReservedElasticsearchInstancePaymentOption = "ALL_UPFRONT"|"PARTIAL_UPFRONT"|"NO_UPFRONT"|string; + export type RoleArn = string; + export interface ServiceSoftwareOptions { + /** + * The current service software version that is present on the domain. + */ + CurrentVersion?: String; + /** + * The new service software version if one is available. + */ + NewVersion?: String; + /** + * True if you are able to update you service software version. False if you are not able to update your service software version. + */ + UpdateAvailable?: Boolean; + /** + * True if you are able to cancel your service software version update. False if you are not able to cancel your service software version. + */ + Cancellable?: Boolean; + /** + * The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. + */ + UpdateStatus?: DeploymentStatus; + /** + * The description of the UpdateStatus. + */ + Description?: String; + /** + * Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. + */ + AutomatedUpdateDate?: DeploymentCloseDateTimeStamp; + } + export type ServiceUrl = string; + export interface SnapshotOptions { + /** + * Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours. + */ + AutomatedSnapshotStartHour?: IntegerClass; + } + export interface SnapshotOptionsStatus { + /** + * Specifies the daily snapshot options specified for the Elasticsearch domain. + */ + Options: SnapshotOptions; + /** + * Specifies the status of a daily automated snapshot. + */ + Status: OptionStatus; + } + export interface StartElasticsearchServiceSoftwareUpdateRequest { + /** + * The name of the domain that you want to update to the latest service software. + */ + DomainName: DomainName; + } + export interface StartElasticsearchServiceSoftwareUpdateResponse { + /** + * The current status of the Elasticsearch service software update. + */ + ServiceSoftwareOptions?: ServiceSoftwareOptions; + } + export type StartTimestamp = Date; + export type StorageSubTypeName = string; + export interface StorageType { + StorageTypeName?: StorageTypeName; + StorageSubTypeName?: StorageSubTypeName; + /** + * List of limits that are applicable for given storage type. + */ + StorageTypeLimits?: StorageTypeLimitList; + } + export interface StorageTypeLimit { + /** + * Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable MinimumVolumeSize Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. MaximumVolumeSize Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. MaximumIops Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. MinimumIops Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. + */ + LimitName?: LimitName; + /** + * Values for the StorageTypeLimit$LimitName . + */ + LimitValues?: LimitValueList; + } + export type StorageTypeLimitList = StorageTypeLimit[]; + export type StorageTypeList = StorageType[]; + export type StorageTypeName = string; + export type String = string; + export type StringList = String[]; + export interface Tag { + /** + * Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached. + */ + Key: TagKey; + /** + * Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity + */ + Value: TagValue; + } + export type TagKey = string; + export type TagList = Tag[]; + export type TagValue = string; + export type UIntValue = number; + export interface UpdateElasticsearchDomainConfigRequest { + /** + * The name of the Elasticsearch domain that you are updating. + */ + DomainName: DomainName; + /** + * The type and number of instances to instantiate for the domain cluster. + */ + ElasticsearchClusterConfig?: ElasticsearchClusterConfig; + /** + * Specify the type and size of the EBS volume that you want to use. + */ + EBSOptions?: EBSOptions; + /** + * Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours. + */ + SnapshotOptions?: SnapshotOptions; + /** + * Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains + */ + VPCOptions?: VPCOptions; + /** + * Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana. + */ + CognitoOptions?: CognitoOptions; + /** + * Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information. + */ + AdvancedOptions?: AdvancedOptions; + /** + * IAM access policy as a JSON-formatted string. + */ + AccessPolicies?: PolicyDocument; + /** + * Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log. + */ + LogPublishingOptions?: LogPublishingOptions; + } + export interface UpdateElasticsearchDomainConfigResponse { + /** + * The status of the updated Elasticsearch domain. + */ + DomainConfig: ElasticsearchDomainConfig; + } + export type UpdateTimestamp = Date; + export interface UpgradeElasticsearchDomainRequest { + DomainName: DomainName; + /** + * The version of Elasticsearch that you intend to upgrade the domain to. + */ + TargetVersion: ElasticsearchVersionString; + /** + * This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. + */ + PerformCheckOnly?: Boolean; + } + export interface UpgradeElasticsearchDomainResponse { + DomainName?: DomainName; + /** + * The version of Elasticsearch that you intend to upgrade the domain to. + */ + TargetVersion?: ElasticsearchVersionString; + /** + * This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. + */ + PerformCheckOnly?: Boolean; + } + export interface UpgradeHistory { + /** + * A string that describes the update briefly + */ + UpgradeName?: UpgradeName; + /** + * UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format. + */ + StartTimestamp?: StartTimestamp; + /** + * The overall status of the update. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed + */ + UpgradeStatus?: UpgradeStatus; + /** + * A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check. + */ + StepsList?: UpgradeStepsList; + } + export type UpgradeHistoryList = UpgradeHistory[]; + export type UpgradeName = string; + export type UpgradeStatus = "IN_PROGRESS"|"SUCCEEDED"|"SUCCEEDED_WITH_ISSUES"|"FAILED"|string; + export type UpgradeStep = "PRE_UPGRADE_CHECK"|"SNAPSHOT"|"UPGRADE"|string; + export interface UpgradeStepItem { + /** + * Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade + */ + UpgradeStep?: UpgradeStep; + /** + * The status of a particular step during an upgrade. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed + */ + UpgradeStepStatus?: UpgradeStatus; + /** + * A list of strings containing detailed information about the errors encountered in a particular step. + */ + Issues?: Issues; + /** + * The Floating point value representing progress percentage of a particular step. + */ + ProgressPercent?: Double; + } + export type UpgradeStepsList = UpgradeStepItem[]; + export type UserPoolId = string; + export interface VPCDerivedInfo { + /** + * The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions. + */ + VPCId?: String; + /** + * Specifies the subnets for VPC endpoint. + */ + SubnetIds?: StringList; + /** + * The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions. + */ + AvailabilityZones?: StringList; + /** + * Specifies the security groups for VPC endpoint. + */ + SecurityGroupIds?: StringList; + } + export interface VPCDerivedInfoStatus { + /** + * Specifies the VPC options for the specified Elasticsearch domain. + */ + Options: VPCDerivedInfo; + /** + * Specifies the status of the VPC options for the specified Elasticsearch domain. + */ + Status: OptionStatus; + } + export interface VPCOptions { + /** + * Specifies the subnets for VPC endpoint. + */ + SubnetIds?: StringList; + /** + * Specifies the security groups for VPC endpoint. + */ + SecurityGroupIds?: StringList; + } + export type VolumeType = "standard"|"gp2"|"io1"|string; + export interface ZoneAwarenessConfig { + /** + * An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled + */ + AvailabilityZoneCount?: IntegerClass; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-01-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ES client. + */ + export import Types = ES; +} +export = ES; diff --git a/node_modules/aws-sdk/clients/es.js b/node_modules/aws-sdk/clients/es.js new file mode 100644 index 0000000..1887172 --- /dev/null +++ b/node_modules/aws-sdk/clients/es.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['es'] = {}; +AWS.ES = Service.defineService('es', ['2015-01-01']); +Object.defineProperty(apiLoader.services['es'], '2015-01-01', { + get: function get() { + var model = require('../apis/es-2015-01-01.min.json'); + model.paginators = require('../apis/es-2015-01-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ES; diff --git a/node_modules/aws-sdk/clients/firehose.d.ts b/node_modules/aws-sdk/clients/firehose.d.ts new file mode 100644 index 0000000..de3b5d5 --- /dev/null +++ b/node_modules/aws-sdk/clients/firehose.d.ts @@ -0,0 +1,1497 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Firehose extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Firehose.Types.ClientConfiguration) + config: Config & Firehose.Types.ClientConfiguration; + /** + * Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per AWS Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be 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. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. 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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide. + */ + createDeliveryStream(params: Firehose.Types.CreateDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request; + /** + * Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per AWS Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be 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. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. 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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide. + */ + createDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request; + /** + * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service might continue to accept the records, but it 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. + */ + deleteDeliveryStream(params: Firehose.Types.DeleteDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.DeleteDeliveryStreamOutput) => void): Request; + /** + * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service might continue to accept the records, but it 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. + */ + deleteDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.DeleteDeliveryStreamOutput) => void): Request; + /** + * Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it. + */ + describeDeliveryStream(params: Firehose.Types.DescribeDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.DescribeDeliveryStreamOutput) => void): Request; + /** + * Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it. + */ + describeDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.DescribeDeliveryStreamOutput) => void): Request; + /** + * Lists your delivery streams in alphabetical order of their names. The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call. + */ + listDeliveryStreams(params: Firehose.Types.ListDeliveryStreamsInput, callback?: (err: AWSError, data: Firehose.Types.ListDeliveryStreamsOutput) => void): Request; + /** + * Lists your delivery streams in alphabetical order of their names. The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call. + */ + listDeliveryStreams(callback?: (err: AWSError, data: Firehose.Types.ListDeliveryStreamsOutput) => void): Request; + /** + * Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account. + */ + listTagsForDeliveryStream(params: Firehose.Types.ListTagsForDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.ListTagsForDeliveryStreamOutput) => void): Request; + /** + * Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account. + */ + listTagsForDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.ListTagsForDeliveryStreamOutput) => void): Request; + /** + * Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. 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 PutRecord and PutRecordBatch, 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 Amazon Kinesis Data Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. 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. 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 (\n) 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. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding. + */ + putRecord(params: Firehose.Types.PutRecordInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request; + /** + * Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. 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 PutRecord and PutRecordBatch, 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 Amazon Kinesis Data Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. 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. 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 (\n) 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. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding. + */ + putRecord(callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request; + /** + * 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 PutRecord. Applications using these operations are referred to as producers. 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 PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits. Each PutRecordBatch 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. You must specify the name of the delivery stream and the data record when using PutRecord. 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. 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 (\n) 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. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses 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. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount 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. If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. 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. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding. + */ + putRecordBatch(params: Firehose.Types.PutRecordBatchInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request; + /** + * 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 PutRecord. Applications using these operations are referred to as producers. 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 PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits. Each PutRecordBatch 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. You must specify the name of the delivery stream and the data record when using PutRecord. 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. 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 (\n) 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. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses 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. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount 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. If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. 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. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding. + */ + putRecordBatch(callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request; + /** + * Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to ENABLING, and then to ENABLED. You can continue to read and write data to your stream while its status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a delivery stream, use DescribeDeliveryStream. You can only enable SSE for a delivery stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period. + */ + startDeliveryStreamEncryption(params: Firehose.Types.StartDeliveryStreamEncryptionInput, callback?: (err: AWSError, data: Firehose.Types.StartDeliveryStreamEncryptionOutput) => void): Request; + /** + * Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to ENABLING, and then to ENABLED. You can continue to read and write data to your stream while its status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a delivery stream, use DescribeDeliveryStream. You can only enable SSE for a delivery stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period. + */ + startDeliveryStreamEncryption(callback?: (err: AWSError, data: Firehose.Types.StartDeliveryStreamEncryptionOutput) => void): Request; + /** + * Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a delivery stream, use DescribeDeliveryStream. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period. + */ + stopDeliveryStreamEncryption(params: Firehose.Types.StopDeliveryStreamEncryptionInput, callback?: (err: AWSError, data: Firehose.Types.StopDeliveryStreamEncryptionOutput) => void): Request; + /** + * Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a delivery stream, use DescribeDeliveryStream. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period. + */ + stopDeliveryStreamEncryption(callback?: (err: AWSError, data: Firehose.Types.StopDeliveryStreamEncryptionOutput) => void): Request; + /** + * Adds or updates tags for the specified delivery stream. A tag is a key-value pair 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 Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. Each delivery stream can have up to 50 tags. This operation has a limit of five transactions per second per account. + */ + tagDeliveryStream(params: Firehose.Types.TagDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.TagDeliveryStreamOutput) => void): Request; + /** + * Adds or updates tags for the specified delivery stream. A tag is a key-value pair 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 Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. Each delivery stream can have up to 50 tags. This operation has a limit of five transactions per second per account. + */ + tagDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.TagDeliveryStreamOutput) => void): Request; + /** + * Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes. If you specify a tag that doesn't exist, the operation ignores it. This operation has a limit of five transactions per second per account. + */ + untagDeliveryStream(params: Firehose.Types.UntagDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.UntagDeliveryStreamOutput) => void): Request; + /** + * Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes. If you specify a tag that doesn't exist, the operation ignores it. This operation has a limit of five transactions per second per account. + */ + untagDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.UntagDeliveryStreamOutput) => void): Request; + /** + * Updates the specified destination of the specified delivery stream. 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. Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination. 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 EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. 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. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId 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 DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call. + */ + updateDestination(params: Firehose.Types.UpdateDestinationInput, callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request; + /** + * Updates the specified destination of the specified delivery stream. 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. Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination. 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 EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. 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. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId 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 DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call. + */ + updateDestination(callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request; +} +declare namespace Firehose { + export type AWSKMSKeyARN = string; + export type BlockSizeBytes = number; + export type BooleanObject = boolean; + export type BucketARN = string; + export interface BufferingHints { + /** + * Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. + */ + SizeInMBs?: SizeInMBs; + /** + * Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. + */ + IntervalInSeconds?: IntervalInSeconds; + } + export interface CloudWatchLoggingOptions { + /** + * Enables or disables CloudWatch logging. + */ + Enabled?: BooleanObject; + /** + * The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled. + */ + LogGroupName?: LogGroupName; + /** + * The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled. + */ + LogStreamName?: LogStreamName; + } + export type ClusterJDBCURL = string; + export type ColumnToJsonKeyMappings = {[key: string]: NonEmptyString}; + export type CompressionFormat = "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|string; + export interface CopyCommand { + /** + * The name of the target table. The table must already exist in the database. + */ + DataTableName: DataTableName; + /** + * A comma-separated list of column names. + */ + DataTableColumns?: DataTableColumns; + /** + * Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows: delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop. delimiter '|' - fields are delimited with "|" (this is the default delimiter). delimiter '|' escape - the delimiter should be escaped. fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table. JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data. For more examples, see Amazon Redshift COPY command examples. + */ + CopyOptions?: CopyOptions; + } + export type CopyOptions = string; + export interface CreateDeliveryStreamInput { + /** + * The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * The delivery stream type. This parameter can be one of the following values: DirectPut: Provider applications access the delivery stream directly. KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source. + */ + DeliveryStreamType?: DeliveryStreamType; + /** + * When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream. + */ + KinesisStreamSourceConfiguration?: KinesisStreamSourceConfiguration; + /** + * [Deprecated] The destination in Amazon S3. You can specify only one destination. + */ + S3DestinationConfiguration?: S3DestinationConfiguration; + /** + * The destination in Amazon S3. You can specify only one destination. + */ + ExtendedS3DestinationConfiguration?: ExtendedS3DestinationConfiguration; + /** + * The destination in Amazon Redshift. You can specify only one destination. + */ + RedshiftDestinationConfiguration?: RedshiftDestinationConfiguration; + /** + * The destination in Amazon ES. You can specify only one destination. + */ + ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration; + /** + * The destination in Splunk. You can specify only one destination. + */ + SplunkDestinationConfiguration?: SplunkDestinationConfiguration; + /** + * A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. 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 Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. You can specify up to 50 tags when creating a delivery stream. + */ + Tags?: TagDeliveryStreamInputTagList; + } + export interface CreateDeliveryStreamOutput { + /** + * The ARN of the delivery stream. + */ + DeliveryStreamARN?: DeliveryStreamARN; + } + export type Data = Buffer|Uint8Array|Blob|string; + export interface DataFormatConversionConfiguration { + /** + * Specifies the AWS Glue Data Catalog table that contains the column information. + */ + SchemaConfiguration?: SchemaConfiguration; + /** + * Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. + */ + InputFormatConfiguration?: InputFormatConfiguration; + /** + * Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. + */ + OutputFormatConfiguration?: OutputFormatConfiguration; + /** + * Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details. + */ + Enabled?: BooleanObject; + } + export type DataTableColumns = string; + export type DataTableName = string; + export interface DeleteDeliveryStreamInput { + /** + * The name of the delivery stream. + */ + DeliveryStreamName: DeliveryStreamName; + } + export interface DeleteDeliveryStreamOutput { + } + export type DeliveryStartTimestamp = Date; + export type DeliveryStreamARN = string; + export interface DeliveryStreamDescription { + /** + * The name of the delivery stream. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + DeliveryStreamARN: DeliveryStreamARN; + /** + * The status of the delivery stream. + */ + DeliveryStreamStatus: DeliveryStreamStatus; + /** + * Indicates the server-side encryption (SSE) status for the delivery stream. + */ + DeliveryStreamEncryptionConfiguration?: DeliveryStreamEncryptionConfiguration; + /** + * The delivery stream type. This can be one of the following values: DirectPut: Provider applications access the delivery stream directly. KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source. + */ + DeliveryStreamType: DeliveryStreamType; + /** + * 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. + */ + VersionId: DeliveryStreamVersionId; + /** + * The date and time that the delivery stream was created. + */ + CreateTimestamp?: Timestamp; + /** + * The date and time that the delivery stream was last updated. + */ + LastUpdateTimestamp?: Timestamp; + /** + * If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream. + */ + Source?: SourceDescription; + /** + * The destinations. + */ + Destinations: DestinationDescriptionList; + /** + * Indicates whether there are more destinations available to list. + */ + HasMoreDestinations: BooleanObject; + } + export interface DeliveryStreamEncryptionConfiguration { + /** + * For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. + */ + Status?: DeliveryStreamEncryptionStatus; + } + export type DeliveryStreamEncryptionStatus = "ENABLED"|"ENABLING"|"DISABLED"|"DISABLING"|string; + export type DeliveryStreamName = string; + export type DeliveryStreamNameList = DeliveryStreamName[]; + export type DeliveryStreamStatus = "CREATING"|"DELETING"|"ACTIVE"|string; + export type DeliveryStreamType = "DirectPut"|"KinesisStreamAsSource"|string; + export type DeliveryStreamVersionId = string; + export interface DescribeDeliveryStreamInput { + /** + * The name of the delivery stream. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * The limit on the number of destinations to return. You can have one destination per delivery stream. + */ + Limit?: DescribeDeliveryStreamInputLimit; + /** + * The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream. + */ + ExclusiveStartDestinationId?: DestinationId; + } + export type DescribeDeliveryStreamInputLimit = number; + export interface DescribeDeliveryStreamOutput { + /** + * Information about the delivery stream. + */ + DeliveryStreamDescription: DeliveryStreamDescription; + } + export interface Deserializer { + /** + * The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe. + */ + OpenXJsonSerDe?: OpenXJsonSerDe; + /** + * The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe. + */ + HiveJsonSerDe?: HiveJsonSerDe; + } + export interface DestinationDescription { + /** + * The ID of the destination. + */ + DestinationId: DestinationId; + /** + * [Deprecated] The destination in Amazon S3. + */ + S3DestinationDescription?: S3DestinationDescription; + /** + * The destination in Amazon S3. + */ + ExtendedS3DestinationDescription?: ExtendedS3DestinationDescription; + /** + * The destination in Amazon Redshift. + */ + RedshiftDestinationDescription?: RedshiftDestinationDescription; + /** + * The destination in Amazon ES. + */ + ElasticsearchDestinationDescription?: ElasticsearchDestinationDescription; + /** + * The destination in Splunk. + */ + SplunkDestinationDescription?: SplunkDestinationDescription; + } + export type DestinationDescriptionList = DestinationDescription[]; + export type DestinationId = string; + export interface ElasticsearchBufferingHints { + /** + * Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). + */ + IntervalInSeconds?: ElasticsearchBufferingIntervalInSeconds; + /** + * Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. + */ + SizeInMBs?: ElasticsearchBufferingSizeInMBs; + } + export type ElasticsearchBufferingIntervalInSeconds = number; + export type ElasticsearchBufferingSizeInMBs = number; + export interface ElasticsearchDestinationConfiguration { + /** + * 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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN: RoleARN; + /** + * The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + DomainARN: ElasticsearchDomainARN; + /** + * The Elasticsearch index name. + */ + IndexName: ElasticsearchIndexName; + /** + * The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time. + */ + TypeName: ElasticsearchTypeName; + /** + * The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay. + */ + IndexRotationPeriod?: ElasticsearchIndexRotationPeriod; + /** + * The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used. + */ + BufferingHints?: ElasticsearchBufferingHints; + /** + * The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes). + */ + RetryOptions?: ElasticsearchRetryOptions; + /** + * Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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 Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly. + */ + S3BackupMode?: ElasticsearchS3BackupMode; + /** + * The configuration for the backup Amazon S3 location. + */ + S3Configuration: S3DestinationConfiguration; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface ElasticsearchDestinationDescription { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN?: RoleARN; + /** + * The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + DomainARN?: ElasticsearchDomainARN; + /** + * The Elasticsearch index name. + */ + IndexName?: ElasticsearchIndexName; + /** + * The Elasticsearch type name. + */ + TypeName?: ElasticsearchTypeName; + /** + * The Elasticsearch index rotation period + */ + IndexRotationPeriod?: ElasticsearchIndexRotationPeriod; + /** + * The buffering options. + */ + BufferingHints?: ElasticsearchBufferingHints; + /** + * The Amazon ES retry options. + */ + RetryOptions?: ElasticsearchRetryOptions; + /** + * The Amazon S3 backup mode. + */ + S3BackupMode?: ElasticsearchS3BackupMode; + /** + * The Amazon S3 destination. + */ + S3DestinationDescription?: S3DestinationDescription; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon CloudWatch logging options. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface ElasticsearchDestinationUpdate { + /** + * 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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN?: RoleARN; + /** + * The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + DomainARN?: ElasticsearchDomainARN; + /** + * The Elasticsearch index name. + */ + IndexName?: ElasticsearchIndexName; + /** + * The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime. + */ + TypeName?: ElasticsearchTypeName; + /** + * The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay. + */ + IndexRotationPeriod?: ElasticsearchIndexRotationPeriod; + /** + * The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used. + */ + BufferingHints?: ElasticsearchBufferingHints; + /** + * The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes). + */ + RetryOptions?: ElasticsearchRetryOptions; + /** + * The Amazon S3 destination. + */ + S3Update?: S3DestinationUpdate; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export type ElasticsearchDomainARN = string; + export type ElasticsearchIndexName = string; + export type ElasticsearchIndexRotationPeriod = "NoRotation"|"OneHour"|"OneDay"|"OneWeek"|"OneMonth"|string; + export type ElasticsearchRetryDurationInSeconds = number; + export interface ElasticsearchRetryOptions { + /** + * After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries 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. + */ + DurationInSeconds?: ElasticsearchRetryDurationInSeconds; + } + export type ElasticsearchS3BackupMode = "FailedDocumentsOnly"|"AllDocuments"|string; + export type ElasticsearchTypeName = string; + export interface EncryptionConfiguration { + /** + * Specifically override existing encryption information to ensure that no encryption is used. + */ + NoEncryptionConfig?: NoEncryptionConfig; + /** + * The encryption key. + */ + KMSEncryptionConfig?: KMSEncryptionConfig; + } + export type ErrorCode = string; + export type ErrorMessage = string; + export type ErrorOutputPrefix = string; + export interface ExtendedS3DestinationConfiguration { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN: RoleARN; + /** + * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + BucketARN: BucketARN; + /** + * 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 Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide. + */ + Prefix?: Prefix; + /** + * A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. + */ + ErrorOutputPrefix?: ErrorOutputPrefix; + /** + * The buffering option. + */ + BufferingHints?: BufferingHints; + /** + * The compression format. If no value is specified, the default is UNCOMPRESSED. + */ + CompressionFormat?: CompressionFormat; + /** + * The encryption configuration. If no value is specified, the default is no encryption. + */ + EncryptionConfiguration?: EncryptionConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon S3 backup mode. + */ + S3BackupMode?: S3BackupMode; + /** + * The configuration for backup in Amazon S3. + */ + S3BackupConfiguration?: S3DestinationConfiguration; + /** + * The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. + */ + DataFormatConversionConfiguration?: DataFormatConversionConfiguration; + } + export interface ExtendedS3DestinationDescription { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN: RoleARN; + /** + * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + BucketARN: BucketARN; + /** + * 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 Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide. + */ + Prefix?: Prefix; + /** + * A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. + */ + ErrorOutputPrefix?: ErrorOutputPrefix; + /** + * The buffering option. + */ + BufferingHints: BufferingHints; + /** + * The compression format. If no value is specified, the default is UNCOMPRESSED. + */ + CompressionFormat: CompressionFormat; + /** + * The encryption configuration. If no value is specified, the default is no encryption. + */ + EncryptionConfiguration: EncryptionConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon S3 backup mode. + */ + S3BackupMode?: S3BackupMode; + /** + * The configuration for backup in Amazon S3. + */ + S3BackupDescription?: S3DestinationDescription; + /** + * The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. + */ + DataFormatConversionConfiguration?: DataFormatConversionConfiguration; + } + export interface ExtendedS3DestinationUpdate { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN?: RoleARN; + /** + * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + BucketARN?: BucketARN; + /** + * 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 Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide. + */ + Prefix?: Prefix; + /** + * A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. + */ + ErrorOutputPrefix?: ErrorOutputPrefix; + /** + * The buffering option. + */ + BufferingHints?: BufferingHints; + /** + * The compression format. If no value is specified, the default is UNCOMPRESSED. + */ + CompressionFormat?: CompressionFormat; + /** + * The encryption configuration. If no value is specified, the default is no encryption. + */ + EncryptionConfiguration?: EncryptionConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * Enables or disables Amazon S3 backup mode. + */ + S3BackupMode?: S3BackupMode; + /** + * The Amazon S3 destination for backup. + */ + S3BackupUpdate?: S3DestinationUpdate; + /** + * The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. + */ + DataFormatConversionConfiguration?: DataFormatConversionConfiguration; + } + export type HECAcknowledgmentTimeoutInSeconds = number; + export type HECEndpoint = string; + export type HECEndpointType = "Raw"|"Event"|string; + export type HECToken = string; + export interface HiveJsonSerDe { + /** + * Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default. + */ + TimestampFormats?: ListOfNonEmptyStrings; + } + export interface InputFormatConfiguration { + /** + * Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request. + */ + Deserializer?: Deserializer; + } + export type IntervalInSeconds = number; + export interface KMSEncryptionConfig { + /** + * The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + AWSKMSKeyARN: AWSKMSKeyARN; + } + export type KinesisStreamARN = string; + export interface KinesisStreamSourceConfiguration { + /** + * The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format. + */ + KinesisStreamARN: KinesisStreamARN; + /** + * The ARN of the role that provides access to the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format. + */ + RoleARN: RoleARN; + } + export interface KinesisStreamSourceDescription { + /** + * The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format. + */ + KinesisStreamARN?: KinesisStreamARN; + /** + * The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format. + */ + RoleARN?: RoleARN; + /** + * Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp. + */ + DeliveryStartTimestamp?: DeliveryStartTimestamp; + } + export interface ListDeliveryStreamsInput { + /** + * The maximum number of delivery streams to list. The default value is 10. + */ + Limit?: ListDeliveryStreamsInputLimit; + /** + * The delivery stream type. This can be one of the following values: DirectPut: Provider applications access the delivery stream directly. KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source. This parameter is optional. If this parameter is omitted, delivery streams of all types are returned. + */ + DeliveryStreamType?: DeliveryStreamType; + /** + * The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName. + */ + ExclusiveStartDeliveryStreamName?: DeliveryStreamName; + } + export type ListDeliveryStreamsInputLimit = number; + export interface ListDeliveryStreamsOutput { + /** + * The names of the delivery streams. + */ + DeliveryStreamNames: DeliveryStreamNameList; + /** + * Indicates whether there are more delivery streams available to list. + */ + HasMoreDeliveryStreams: BooleanObject; + } + export type ListOfNonEmptyStrings = NonEmptyString[]; + export type ListOfNonEmptyStringsWithoutWhitespace = NonEmptyStringWithoutWhitespace[]; + export interface ListTagsForDeliveryStreamInput { + /** + * The name of the delivery stream whose tags you want to list. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey. + */ + ExclusiveStartTagKey?: TagKey; + /** + * The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response. + */ + Limit?: ListTagsForDeliveryStreamInputLimit; + } + export type ListTagsForDeliveryStreamInputLimit = number; + export interface ListTagsForDeliveryStreamOutput { + /** + * A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit. + */ + Tags: ListTagsForDeliveryStreamOutputTagList; + /** + * If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again. + */ + HasMoreTags: BooleanObject; + } + export type ListTagsForDeliveryStreamOutputTagList = Tag[]; + export type LogGroupName = string; + export type LogStreamName = string; + export type NoEncryptionConfig = "NoEncryption"|string; + export type NonEmptyString = string; + export type NonEmptyStringWithoutWhitespace = string; + export type NonNegativeIntegerObject = number; + export interface OpenXJsonSerDe { + /** + * When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option. The default is false. + */ + ConvertDotsInJsonKeysToUnderscores?: BooleanObject; + /** + * When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them. + */ + CaseInsensitive?: BooleanObject; + /** + * Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts. + */ + ColumnToJsonKeyMappings?: ColumnToJsonKeyMappings; + } + export type OrcCompression = "NONE"|"ZLIB"|"SNAPPY"|string; + export type OrcFormatVersion = "V0_11"|"V0_12"|string; + export type OrcRowIndexStride = number; + export interface OrcSerDe { + /** + * The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB. + */ + StripeSizeBytes?: OrcStripeSizeBytes; + /** + * The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations. + */ + BlockSizeBytes?: BlockSizeBytes; + /** + * The number of rows between index entries. The default is 10,000 and the minimum is 1,000. + */ + RowIndexStride?: OrcRowIndexStride; + /** + * Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false. + */ + EnablePadding?: BooleanObject; + /** + * A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size. For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task. Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false. + */ + PaddingTolerance?: Proportion; + /** + * The compression code to use over data blocks. The default is SNAPPY. + */ + Compression?: OrcCompression; + /** + * The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null. + */ + BloomFilterColumns?: ListOfNonEmptyStringsWithoutWhitespace; + /** + * The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1. + */ + BloomFilterFalsePositiveProbability?: Proportion; + /** + * Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1. + */ + DictionaryKeyThreshold?: Proportion; + /** + * The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12. + */ + FormatVersion?: OrcFormatVersion; + } + export type OrcStripeSizeBytes = number; + export interface OutputFormatConfiguration { + /** + * Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request. + */ + Serializer?: Serializer; + } + export type ParquetCompression = "UNCOMPRESSED"|"GZIP"|"SNAPPY"|string; + export type ParquetPageSizeBytes = number; + export interface ParquetSerDe { + /** + * The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations. + */ + BlockSizeBytes?: BlockSizeBytes; + /** + * The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB. + */ + PageSizeBytes?: ParquetPageSizeBytes; + /** + * The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed. + */ + Compression?: ParquetCompression; + /** + * Indicates whether to enable dictionary compression. + */ + EnableDictionaryCompression?: BooleanObject; + /** + * The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0. + */ + MaxPaddingBytes?: NonNegativeIntegerObject; + /** + * Indicates the version of row format to output. The possible values are V1 and V2. The default is V1. + */ + WriterVersion?: ParquetWriterVersion; + } + export type ParquetWriterVersion = "V1"|"V2"|string; + export type Password = string; + export type Prefix = string; + export interface ProcessingConfiguration { + /** + * Enables or disables data processing. + */ + Enabled?: BooleanObject; + /** + * The data processors. + */ + Processors?: ProcessorList; + } + export interface Processor { + /** + * The type of processor. + */ + Type: ProcessorType; + /** + * The processor parameters. + */ + Parameters?: ProcessorParameterList; + } + export type ProcessorList = Processor[]; + export interface ProcessorParameter { + /** + * The name of the parameter. + */ + ParameterName: ProcessorParameterName; + /** + * The parameter value. + */ + ParameterValue: ProcessorParameterValue; + } + export type ProcessorParameterList = ProcessorParameter[]; + export type ProcessorParameterName = "LambdaArn"|"NumberOfRetries"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|string; + export type ProcessorParameterValue = string; + export type ProcessorType = "Lambda"|string; + export type Proportion = number; + export interface PutRecordBatchInput { + /** + * The name of the delivery stream. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * One or more records. + */ + Records: PutRecordBatchRequestEntryList; + } + export interface PutRecordBatchOutput { + /** + * The number of records that might have failed processing. This number might be greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount to determine whether there are records that you need to resend. + */ + FailedPutCount: NonNegativeIntegerObject; + /** + * Indicates whether server-side encryption (SSE) was enabled during this operation. + */ + Encrypted?: BooleanObject; + /** + * The results array. For each record, the index of the response element is the same as the index used in the request array. + */ + RequestResponses: PutRecordBatchResponseEntryList; + } + export type PutRecordBatchRequestEntryList = Record[]; + export interface PutRecordBatchResponseEntry { + /** + * The ID of the record. + */ + RecordId?: PutResponseRecordId; + /** + * The error code for an individual record result. + */ + ErrorCode?: ErrorCode; + /** + * The error message for an individual record result. + */ + ErrorMessage?: ErrorMessage; + } + export type PutRecordBatchResponseEntryList = PutRecordBatchResponseEntry[]; + export interface PutRecordInput { + /** + * The name of the delivery stream. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * The record. + */ + Record: Record; + } + export interface PutRecordOutput { + /** + * The ID of the record. + */ + RecordId: PutResponseRecordId; + /** + * Indicates whether server-side encryption (SSE) was enabled during this operation. + */ + Encrypted?: BooleanObject; + } + export type PutResponseRecordId = string; + export interface Record { + /** + * The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB. + */ + Data: Data; + } + export interface RedshiftDestinationConfiguration { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN: RoleARN; + /** + * The database connection string. + */ + ClusterJDBCURL: ClusterJDBCURL; + /** + * The COPY command. + */ + CopyCommand: CopyCommand; + /** + * The name of the user. + */ + Username: Username; + /** + * The user password. + */ + Password: Password; + /** + * The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). + */ + RetryOptions?: RedshiftRetryOptions; + /** + * The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. + */ + S3Configuration: S3DestinationConfiguration; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon S3 backup mode. + */ + S3BackupMode?: RedshiftS3BackupMode; + /** + * The configuration for backup in Amazon S3. + */ + S3BackupConfiguration?: S3DestinationConfiguration; + /** + * The CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface RedshiftDestinationDescription { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN: RoleARN; + /** + * The database connection string. + */ + ClusterJDBCURL: ClusterJDBCURL; + /** + * The COPY command. + */ + CopyCommand: CopyCommand; + /** + * The name of the user. + */ + Username: Username; + /** + * The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). + */ + RetryOptions?: RedshiftRetryOptions; + /** + * The Amazon S3 destination. + */ + S3DestinationDescription: S3DestinationDescription; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon S3 backup mode. + */ + S3BackupMode?: RedshiftS3BackupMode; + /** + * The configuration for backup in Amazon S3. + */ + S3BackupDescription?: S3DestinationDescription; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface RedshiftDestinationUpdate { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN?: RoleARN; + /** + * The database connection string. + */ + ClusterJDBCURL?: ClusterJDBCURL; + /** + * The COPY command. + */ + CopyCommand?: CopyCommand; + /** + * The name of the user. + */ + Username?: Username; + /** + * The user password. + */ + Password?: Password; + /** + * The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). + */ + RetryOptions?: RedshiftRetryOptions; + /** + * The Amazon S3 destination. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. + */ + S3Update?: S3DestinationUpdate; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon S3 backup mode. + */ + S3BackupMode?: RedshiftS3BackupMode; + /** + * The Amazon S3 destination for backup. + */ + S3BackupUpdate?: S3DestinationUpdate; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export type RedshiftRetryDurationInSeconds = number; + export interface RedshiftRetryOptions { + /** + * 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 DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value. + */ + DurationInSeconds?: RedshiftRetryDurationInSeconds; + } + export type RedshiftS3BackupMode = "Disabled"|"Enabled"|string; + export type RoleARN = string; + export type S3BackupMode = "Disabled"|"Enabled"|string; + export interface S3DestinationConfiguration { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN: RoleARN; + /** + * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + BucketARN: BucketARN; + /** + * 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 Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide. + */ + Prefix?: Prefix; + /** + * A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. + */ + ErrorOutputPrefix?: ErrorOutputPrefix; + /** + * The buffering option. If no value is specified, BufferingHints object default values are used. + */ + BufferingHints?: BufferingHints; + /** + * The compression format. If no value is specified, the default is UNCOMPRESSED. The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket. + */ + CompressionFormat?: CompressionFormat; + /** + * The encryption configuration. If no value is specified, the default is no encryption. + */ + EncryptionConfiguration?: EncryptionConfiguration; + /** + * The CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface S3DestinationDescription { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN: RoleARN; + /** + * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + BucketARN: BucketARN; + /** + * 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 Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide. + */ + Prefix?: Prefix; + /** + * A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. + */ + ErrorOutputPrefix?: ErrorOutputPrefix; + /** + * The buffering option. If no value is specified, BufferingHints object default values are used. + */ + BufferingHints: BufferingHints; + /** + * The compression format. If no value is specified, the default is UNCOMPRESSED. + */ + CompressionFormat: CompressionFormat; + /** + * The encryption configuration. If no value is specified, the default is no encryption. + */ + EncryptionConfiguration: EncryptionConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface S3DestinationUpdate { + /** + * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + RoleARN?: RoleARN; + /** + * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + BucketARN?: BucketARN; + /** + * 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 Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide. + */ + Prefix?: Prefix; + /** + * A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. + */ + ErrorOutputPrefix?: ErrorOutputPrefix; + /** + * The buffering option. If no value is specified, BufferingHints object default values are used. + */ + BufferingHints?: BufferingHints; + /** + * The compression format. If no value is specified, the default is UNCOMPRESSED. The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket. + */ + CompressionFormat?: CompressionFormat; + /** + * The encryption configuration. If no value is specified, the default is no encryption. + */ + EncryptionConfiguration?: EncryptionConfiguration; + /** + * The CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface SchemaConfiguration { + /** + * The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed. + */ + RoleARN?: NonEmptyStringWithoutWhitespace; + /** + * The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default. + */ + CatalogId?: NonEmptyStringWithoutWhitespace; + /** + * Specifies the name of the AWS Glue database that contains the schema for the output data. + */ + DatabaseName?: NonEmptyStringWithoutWhitespace; + /** + * Specifies the AWS Glue table that contains the column information that constitutes your data schema. + */ + TableName?: NonEmptyStringWithoutWhitespace; + /** + * If you don't specify an AWS Region, the default is the current Region. + */ + Region?: NonEmptyStringWithoutWhitespace; + /** + * Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up. + */ + VersionId?: NonEmptyStringWithoutWhitespace; + } + export interface Serializer { + /** + * A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet. + */ + ParquetSerDe?: ParquetSerDe; + /** + * A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC. + */ + OrcSerDe?: OrcSerDe; + } + export type SizeInMBs = number; + export interface SourceDescription { + /** + * The KinesisStreamSourceDescription value for the source Kinesis data stream. + */ + KinesisStreamSourceDescription?: KinesisStreamSourceDescription; + } + export interface SplunkDestinationConfiguration { + /** + * The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data. + */ + HECEndpoint: HECEndpoint; + /** + * This type can be either "Raw" or "Event." + */ + HECEndpointType: HECEndpointType; + /** + * This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint. + */ + HECToken: HECToken; + /** + * 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. + */ + HECAcknowledgmentTimeoutInSeconds?: HECAcknowledgmentTimeoutInSeconds; + /** + * 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. + */ + RetryOptions?: SplunkRetryOptions; + /** + * Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. + */ + S3BackupMode?: SplunkS3BackupMode; + /** + * The configuration for the backup Amazon S3 location. + */ + S3Configuration: S3DestinationConfiguration; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface SplunkDestinationDescription { + /** + * The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data. + */ + HECEndpoint?: HECEndpoint; + /** + * This type can be either "Raw" or "Event." + */ + HECEndpointType?: HECEndpointType; + /** + * A GUID you obtain from your Splunk cluster when you create a new HEC endpoint. + */ + HECToken?: HECToken; + /** + * 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. + */ + HECAcknowledgmentTimeoutInSeconds?: HECAcknowledgmentTimeoutInSeconds; + /** + * 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. + */ + RetryOptions?: SplunkRetryOptions; + /** + * Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. + */ + S3BackupMode?: SplunkS3BackupMode; + /** + * The Amazon S3 destination.> + */ + S3DestinationDescription?: S3DestinationDescription; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface SplunkDestinationUpdate { + /** + * The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data. + */ + HECEndpoint?: HECEndpoint; + /** + * This type can be either "Raw" or "Event." + */ + HECEndpointType?: HECEndpointType; + /** + * A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint. + */ + HECToken?: HECToken; + /** + * 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. + */ + HECAcknowledgmentTimeoutInSeconds?: HECAcknowledgmentTimeoutInSeconds; + /** + * 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. + */ + RetryOptions?: SplunkRetryOptions; + /** + * Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. + */ + S3BackupMode?: SplunkS3BackupMode; + /** + * Your update to the configuration of the backup Amazon S3 location. + */ + S3Update?: S3DestinationUpdate; + /** + * The data processing configuration. + */ + ProcessingConfiguration?: ProcessingConfiguration; + /** + * The Amazon CloudWatch logging options for your delivery stream. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export type SplunkRetryDurationInSeconds = number; + export interface SplunkRetryOptions { + /** + * 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. + */ + DurationInSeconds?: SplunkRetryDurationInSeconds; + } + export type SplunkS3BackupMode = "FailedEventsOnly"|"AllEvents"|string; + export interface StartDeliveryStreamEncryptionInput { + /** + * The name of the delivery stream for which you want to enable server-side encryption (SSE). + */ + DeliveryStreamName: DeliveryStreamName; + } + export interface StartDeliveryStreamEncryptionOutput { + } + export interface StopDeliveryStreamEncryptionInput { + /** + * The name of the delivery stream for which you want to disable server-side encryption (SSE). + */ + DeliveryStreamName: DeliveryStreamName; + } + export interface StopDeliveryStreamEncryptionOutput { + } + export interface Tag { + /** + * A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @ + */ + Key: TagKey; + /** + * An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @ + */ + Value?: TagValue; + } + export interface TagDeliveryStreamInput { + /** + * The name of the delivery stream to which you want to add the tags. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * A set of key-value pairs to use to create the tags. + */ + Tags: TagDeliveryStreamInputTagList; + } + export type TagDeliveryStreamInputTagList = Tag[]; + export interface TagDeliveryStreamOutput { + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagValue = string; + export type Timestamp = Date; + export interface UntagDeliveryStreamInput { + /** + * The name of the delivery stream. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * A list of tag keys. Each corresponding tag is removed from the delivery stream. + */ + TagKeys: TagKeyList; + } + export interface UntagDeliveryStreamOutput { + } + export interface UpdateDestinationInput { + /** + * The name of the delivery stream. + */ + DeliveryStreamName: DeliveryStreamName; + /** + * Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and 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 VersionId value is updated. The service then performs a merge of the old configuration with the new configuration. + */ + CurrentDeliveryStreamVersionId: DeliveryStreamVersionId; + /** + * The ID of the destination. + */ + DestinationId: DestinationId; + /** + * [Deprecated] Describes an update for a destination in Amazon S3. + */ + S3DestinationUpdate?: S3DestinationUpdate; + /** + * Describes an update for a destination in Amazon S3. + */ + ExtendedS3DestinationUpdate?: ExtendedS3DestinationUpdate; + /** + * Describes an update for a destination in Amazon Redshift. + */ + RedshiftDestinationUpdate?: RedshiftDestinationUpdate; + /** + * Describes an update for a destination in Amazon ES. + */ + ElasticsearchDestinationUpdate?: ElasticsearchDestinationUpdate; + /** + * Describes an update for a destination in Splunk. + */ + SplunkDestinationUpdate?: SplunkDestinationUpdate; + } + export interface UpdateDestinationOutput { + } + export type Username = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-08-04"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Firehose client. + */ + export import Types = Firehose; +} +export = Firehose; diff --git a/node_modules/aws-sdk/clients/firehose.js b/node_modules/aws-sdk/clients/firehose.js new file mode 100644 index 0000000..8aa30bb --- /dev/null +++ b/node_modules/aws-sdk/clients/firehose.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['firehose'] = {}; +AWS.Firehose = Service.defineService('firehose', ['2015-08-04']); +Object.defineProperty(apiLoader.services['firehose'], '2015-08-04', { + get: function get() { + var model = require('../apis/firehose-2015-08-04.min.json'); + model.paginators = require('../apis/firehose-2015-08-04.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Firehose; diff --git a/node_modules/aws-sdk/clients/fms.d.ts b/node_modules/aws-sdk/clients/fms.d.ts new file mode 100644 index 0000000..1ef3346 --- /dev/null +++ b/node_modules/aws-sdk/clients/fms.d.ts @@ -0,0 +1,568 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class FMS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: FMS.Types.ClientConfiguration) + config: Config & FMS.Types.ClientConfiguration; + /** + * Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account your AWS organization 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. The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account. + */ + associateAdminAccount(params: FMS.Types.AssociateAdminAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account your AWS organization 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. The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account. + */ + associateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. + */ + deleteNotificationChannel(params: FMS.Types.DeleteNotificationChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. + */ + deleteNotificationChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Permanently deletes an AWS Firewall Manager policy. + */ + deletePolicy(params: FMS.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Permanently deletes an AWS Firewall Manager policy. + */ + deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request . + */ + disassociateAdminAccount(params: FMS.Types.DisassociateAdminAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request . + */ + disassociateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator. + */ + getAdminAccount(params: FMS.Types.GetAdminAccountRequest, callback?: (err: AWSError, data: FMS.Types.GetAdminAccountResponse) => void): Request; + /** + * Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator. + */ + getAdminAccount(callback?: (err: AWSError, data: FMS.Types.GetAdminAccountResponse) => void): Request; + /** + * 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. + */ + getComplianceDetail(params: FMS.Types.GetComplianceDetailRequest, callback?: (err: AWSError, data: FMS.Types.GetComplianceDetailResponse) => void): Request; + /** + * 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. + */ + getComplianceDetail(callback?: (err: AWSError, data: FMS.Types.GetComplianceDetailResponse) => void): Request; + /** + * Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs. + */ + getNotificationChannel(params: FMS.Types.GetNotificationChannelRequest, callback?: (err: AWSError, data: FMS.Types.GetNotificationChannelResponse) => void): Request; + /** + * Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs. + */ + getNotificationChannel(callback?: (err: AWSError, data: FMS.Types.GetNotificationChannelResponse) => void): Request; + /** + * Returns information about the specified AWS Firewall Manager policy. + */ + getPolicy(params: FMS.Types.GetPolicyRequest, callback?: (err: AWSError, data: FMS.Types.GetPolicyResponse) => void): Request; + /** + * Returns information about the specified AWS Firewall Manager policy. + */ + getPolicy(callback?: (err: AWSError, data: FMS.Types.GetPolicyResponse) => void): Request; + /** + * If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. + */ + getProtectionStatus(params: FMS.Types.GetProtectionStatusRequest, callback?: (err: AWSError, data: FMS.Types.GetProtectionStatusResponse) => void): Request; + /** + * If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. + */ + getProtectionStatus(callback?: (err: AWSError, data: FMS.Types.GetProtectionStatusResponse) => void): Request; + /** + * Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy. + */ + listComplianceStatus(params: FMS.Types.ListComplianceStatusRequest, callback?: (err: AWSError, data: FMS.Types.ListComplianceStatusResponse) => void): Request; + /** + * Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy. + */ + listComplianceStatus(callback?: (err: AWSError, data: FMS.Types.ListComplianceStatusResponse) => void): Request; + /** + * Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization. The ListMemberAccounts must be submitted by the account that is set as the AWS Firewall Manager administrator. + */ + listMemberAccounts(params: FMS.Types.ListMemberAccountsRequest, callback?: (err: AWSError, data: FMS.Types.ListMemberAccountsResponse) => void): Request; + /** + * Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization. The ListMemberAccounts must be submitted by the account that is set as the AWS Firewall Manager administrator. + */ + listMemberAccounts(callback?: (err: AWSError, data: FMS.Types.ListMemberAccountsResponse) => void): Request; + /** + * Returns an array of PolicySummary objects in the response. + */ + listPolicies(params: FMS.Types.ListPoliciesRequest, callback?: (err: AWSError, data: FMS.Types.ListPoliciesResponse) => void): Request; + /** + * Returns an array of PolicySummary objects in the response. + */ + listPolicies(callback?: (err: AWSError, data: FMS.Types.ListPoliciesResponse) => void): Request; + /** + * Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs. + */ + putNotificationChannel(params: FMS.Types.PutNotificationChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs. + */ + putNotificationChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates an AWS Firewall Manager policy. Firewall Manager provides two types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources, or a WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. A policy is specific to either WAF or Shield Advanced. If you want to enforce both WAF rules and Shield Advanced protection across accounts, you can create multiple policies. You can create one or more policies for WAF rules, and one or more policies for Shield Advanced. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information on subscribing to Shield Advanced, see CreateSubscription. + */ + putPolicy(params: FMS.Types.PutPolicyRequest, callback?: (err: AWSError, data: FMS.Types.PutPolicyResponse) => void): Request; + /** + * Creates an AWS Firewall Manager policy. Firewall Manager provides two types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources, or a WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. A policy is specific to either WAF or Shield Advanced. If you want to enforce both WAF rules and Shield Advanced protection across accounts, you can create multiple policies. You can create one or more policies for WAF rules, and one or more policies for Shield Advanced. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information on subscribing to Shield Advanced, see CreateSubscription. + */ + putPolicy(callback?: (err: AWSError, data: FMS.Types.PutPolicyResponse) => void): Request; +} +declare namespace FMS { + export type AWSAccountId = string; + export type AccountRoleStatus = "READY"|"CREATING"|"PENDING_DELETION"|"DELETING"|"DELETED"|string; + export interface AssociateAdminAccountRequest { + /** + * 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 Managing the AWS Accounts in Your Organization. + */ + AdminAccount: AWSAccountId; + } + export type Boolean = boolean; + export interface ComplianceViolator { + /** + * The resource ID. + */ + ResourceId?: ResourceId; + /** + * The reason that the resource is not protected by the policy. + */ + ViolationReason?: ViolationReason; + /** + * The resource type. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution. + */ + ResourceType?: ResourceType; + } + export type ComplianceViolators = ComplianceViolator[]; + export type CustomerPolicyScopeId = string; + export type CustomerPolicyScopeIdList = CustomerPolicyScopeId[]; + export type CustomerPolicyScopeIdType = "ACCOUNT"|string; + export type CustomerPolicyScopeMap = {[key: string]: CustomerPolicyScopeIdList}; + export interface DeleteNotificationChannelRequest { + } + export interface DeletePolicyRequest { + /** + * The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies. + */ + PolicyId: PolicyId; + /** + * If True, the request will also perform a clean-up process that will: Delete rule groups created by AWS Firewall Manager Remove web ACLs from in-scope resources Delete web ACLs that contain no rules or rule groups After the cleanup, in-scope resources will no longer be protected by web ACLs in this policy. Protection of out-of-scope resources will remain unchanged. Scope is determined by tags and accounts associated with the policy. When creating the policy, if you specified that only resources in specific accounts or with specific tags be protected by the policy, those resources are in-scope. All others are out of scope. If you did not specify tags or accounts, all resources are in-scope. + */ + DeleteAllPolicyResources?: Boolean; + } + export type DependentServiceName = "AWSCONFIG"|"AWSWAF"|"AWSSHIELD_ADVANCED"|string; + export type DetailedInfo = string; + export interface DisassociateAdminAccountRequest { + } + export interface EvaluationResult { + /** + * Describes an AWS account's compliance with the AWS Firewall Manager policy. + */ + ComplianceStatus?: PolicyComplianceStatusType; + /** + * 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. + */ + ViolatorCount?: ResourceCount; + /** + * Indicates that over 100 resources are non-compliant with the AWS Firewall Manager policy. + */ + EvaluationLimitExceeded?: Boolean; + } + export type EvaluationResults = EvaluationResult[]; + export interface GetAdminAccountRequest { + } + export interface GetAdminAccountResponse { + /** + * The AWS account that is set as the AWS Firewall Manager administrator. + */ + AdminAccount?: AWSAccountId; + /** + * The status of the AWS account that you set as the AWS Firewall Manager administrator. + */ + RoleStatus?: AccountRoleStatus; + } + export interface GetComplianceDetailRequest { + /** + * The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies. + */ + PolicyId: PolicyId; + /** + * The AWS account that owns the resources that you want to get the details for. + */ + MemberAccount: AWSAccountId; + } + export interface GetComplianceDetailResponse { + /** + * Information about the resources and the policy that you specified in the GetComplianceDetail request. + */ + PolicyComplianceDetail?: PolicyComplianceDetail; + } + export interface GetNotificationChannelRequest { + } + export interface GetNotificationChannelResponse { + /** + * The SNS topic that records AWS Firewall Manager activity. + */ + SnsTopicArn?: ResourceArn; + /** + * The IAM role that is used by AWS Firewall Manager to record activity to SNS. + */ + SnsRoleName?: ResourceArn; + } + export interface GetPolicyRequest { + /** + * The ID of the AWS Firewall Manager policy that you want the details for. + */ + PolicyId: PolicyId; + } + export interface GetPolicyResponse { + /** + * Information about the specified AWS Firewall Manager policy. + */ + Policy?: Policy; + /** + * The Amazon Resource Name (ARN) of the specified policy. + */ + PolicyArn?: ResourceArn; + } + export interface GetProtectionStatusRequest { + /** + * The ID of the policy for which you want to get the attack information. + */ + PolicyId: PolicyId; + /** + * The AWS account that is in scope of the policy that you want to get the details for. + */ + MemberAccountId?: AWSAccountId; + /** + * The start of the time period to query for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed. + */ + StartTime?: TimeStamp; + /** + * The end of the time period to query for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed. + */ + EndTime?: TimeStamp; + /** + * If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects. + */ + NextToken?: PaginationToken; + /** + * Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects. + */ + MaxResults?: PaginationMaxResults; + } + export interface GetProtectionStatusResponse { + /** + * The ID of the AWS Firewall administrator account for this policy. + */ + AdminAccountId?: AWSAccountId; + /** + * The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED. + */ + ServiceType?: SecurityServiceType; + /** + * Details about the attack, including the following: Attack type Account ID ARN of the resource attacked Start time of the attack End time of the attack (ongoing attacks will not have an end time) The details are in JSON format. An example is shown in the Examples section below. + */ + Data?: ProtectionData; + /** + * If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request. AWS SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes. + */ + NextToken?: PaginationToken; + } + export type IssueInfoMap = {[key: string]: DetailedInfo}; + export interface ListComplianceStatusRequest { + /** + * The ID of the AWS Firewall Manager policy that you want the details for. + */ + PolicyId: PolicyId; + /** + * If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects. + */ + NextToken?: PaginationToken; + /** + * Specifies the number of PolicyComplianceStatus objects that you want AWS Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects. + */ + MaxResults?: PaginationMaxResults; + } + export interface ListComplianceStatusResponse { + /** + * An array of PolicyComplianceStatus objects. + */ + PolicyComplianceStatusList?: PolicyComplianceStatusList; + /** + * If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request. + */ + NextToken?: PaginationToken; + } + export interface ListMemberAccountsRequest { + /** + * If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs. + */ + NextToken?: PaginationToken; + /** + * Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs. + */ + MaxResults?: PaginationMaxResults; + } + export interface ListMemberAccountsResponse { + /** + * An array of account IDs. + */ + MemberAccounts?: MemberAccounts; + /** + * If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request. + */ + NextToken?: PaginationToken; + } + export interface ListPoliciesRequest { + /** + * If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects. + */ + NextToken?: PaginationToken; + /** + * Specifies the number of PolicySummary objects that you want AWS Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects. + */ + MaxResults?: PaginationMaxResults; + } + export interface ListPoliciesResponse { + /** + * An array of PolicySummary objects. + */ + PolicyList?: PolicySummaryList; + /** + * If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request. + */ + NextToken?: PaginationToken; + } + export type ManagedServiceData = string; + export type MemberAccounts = AWSAccountId[]; + export type PaginationMaxResults = number; + export type PaginationToken = string; + export interface Policy { + /** + * The ID of the AWS Firewall Manager policy. + */ + PolicyId?: PolicyId; + /** + * The friendly name of the AWS Firewall Manager policy. + */ + PolicyName: ResourceName; + /** + * A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request. + */ + PolicyUpdateToken?: PolicyUpdateToken; + /** + * Details about the security service that is being used to protect the resources. + */ + SecurityServicePolicyData: SecurityServicePolicyData; + /** + * The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution. + */ + ResourceType: ResourceType; + /** + * An array of ResourceType. + */ + ResourceTypeList?: ResourceTypeList; + /** + * An array of ResourceTag objects. + */ + ResourceTags?: ResourceTags; + /** + * If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy. + */ + ExcludeResourceTags: Boolean; + /** + * Indicates if the policy should be automatically applied to new resources. + */ + RemediationEnabled: Boolean; + /** + * Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy. The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}. + */ + IncludeMap?: CustomerPolicyScopeMap; + /** + * Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy. The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}. + */ + ExcludeMap?: CustomerPolicyScopeMap; + } + export interface PolicyComplianceDetail { + /** + * The AWS account that created the AWS Firewall Manager policy. + */ + PolicyOwner?: AWSAccountId; + /** + * The ID of the AWS Firewall Manager policy. + */ + PolicyId?: PolicyId; + /** + * The AWS account ID. + */ + MemberAccount?: AWSAccountId; + /** + * An array of resources that are not protected by the policy. + */ + Violators?: ComplianceViolators; + /** + * Indicates if over 100 resources are non-compliant with the AWS Firewall Manager policy. + */ + EvaluationLimitExceeded?: Boolean; + /** + * A time stamp that indicates when the returned information should be considered out-of-date. + */ + ExpiredAt?: TimeStamp; + /** + * Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message received that indicates the problem with the service. + */ + IssueInfoMap?: IssueInfoMap; + } + export interface PolicyComplianceStatus { + /** + * The AWS account that created the AWS Firewall Manager policy. + */ + PolicyOwner?: AWSAccountId; + /** + * The ID of the AWS Firewall Manager policy. + */ + PolicyId?: PolicyId; + /** + * The friendly name of the AWS Firewall Manager policy. + */ + PolicyName?: ResourceName; + /** + * The member account ID. + */ + MemberAccount?: AWSAccountId; + /** + * An array of EvaluationResult objects. + */ + EvaluationResults?: EvaluationResults; + /** + * Time stamp of the last update to the EvaluationResult objects. + */ + LastUpdated?: TimeStamp; + /** + * Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message received that indicates the problem with the service. + */ + IssueInfoMap?: IssueInfoMap; + } + export type PolicyComplianceStatusList = PolicyComplianceStatus[]; + export type PolicyComplianceStatusType = "COMPLIANT"|"NON_COMPLIANT"|string; + export type PolicyId = string; + export interface PolicySummary { + /** + * The Amazon Resource Name (ARN) of the specified policy. + */ + PolicyArn?: ResourceArn; + /** + * The ID of the specified policy. + */ + PolicyId?: PolicyId; + /** + * The friendly name of the specified policy. + */ + PolicyName?: ResourceName; + /** + * The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution. + */ + ResourceType?: ResourceType; + /** + * The service that the policy is using to protect the resources. This specifies the type of policy that is created, either a WAF policy or Shield Advanced policy. + */ + SecurityServiceType?: SecurityServiceType; + /** + * Indicates if the policy should be automatically applied to new resources. + */ + RemediationEnabled?: Boolean; + } + export type PolicySummaryList = PolicySummary[]; + export type PolicyUpdateToken = string; + export type ProtectionData = string; + export interface PutNotificationChannelRequest { + /** + * The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager. + */ + SnsTopicArn: ResourceArn; + /** + * The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity. + */ + SnsRoleName: ResourceArn; + } + export interface PutPolicyRequest { + /** + * The details of the AWS Firewall Manager policy to be created. + */ + Policy: Policy; + } + export interface PutPolicyResponse { + /** + * The details of the AWS Firewall Manager policy that was created. + */ + Policy?: Policy; + /** + * The Amazon Resource Name (ARN) of the policy that was created. + */ + PolicyArn?: ResourceArn; + } + export type ResourceArn = string; + export type ResourceCount = number; + export type ResourceId = string; + export type ResourceName = string; + export interface ResourceTag { + /** + * The resource tag key. + */ + Key: TagKey; + /** + * The resource tag value. + */ + Value?: TagValue; + } + export type ResourceTags = ResourceTag[]; + export type ResourceType = string; + export type ResourceTypeList = ResourceType[]; + export interface SecurityServicePolicyData { + /** + * The service that the policy is using to protect the resources. This specifies the type of policy that is created, either a WAF policy or Shield Advanced policy. + */ + Type: SecurityServiceType; + /** + * Details about the service. This contains WAF data in JSON format, as shown in the following example: ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}} If this is a Shield Advanced policy, this string will be empty. + */ + ManagedServiceData?: ManagedServiceData; + } + export type SecurityServiceType = "WAF"|"SHIELD_ADVANCED"|string; + export type TagKey = string; + export type TagValue = string; + export type TimeStamp = Date; + export type ViolationReason = "WEB_ACL_MISSING_RULE_GROUP"|"RESOURCE_MISSING_WEB_ACL"|"RESOURCE_INCORRECT_WEB_ACL"|"RESOURCE_MISSING_SHIELD_PROTECTION"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-01-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the FMS client. + */ + export import Types = FMS; +} +export = FMS; diff --git a/node_modules/aws-sdk/clients/fms.js b/node_modules/aws-sdk/clients/fms.js new file mode 100644 index 0000000..b77f4fa --- /dev/null +++ b/node_modules/aws-sdk/clients/fms.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['fms'] = {}; +AWS.FMS = Service.defineService('fms', ['2018-01-01']); +Object.defineProperty(apiLoader.services['fms'], '2018-01-01', { + get: function get() { + var model = require('../apis/fms-2018-01-01.min.json'); + model.paginators = require('../apis/fms-2018-01-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.FMS; diff --git a/node_modules/aws-sdk/clients/fsx.d.ts b/node_modules/aws-sdk/clients/fsx.d.ts new file mode 100644 index 0000000..792629c --- /dev/null +++ b/node_modules/aws-sdk/clients/fsx.d.ts @@ -0,0 +1,679 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class FSx extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: FSx.Types.ClientConfiguration) + config: Config & FSx.Types.ClientConfiguration; + /** + * Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data. If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following: Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the backup. By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same. The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information. + */ + createBackup(params: FSx.Types.CreateBackupRequest, callback?: (err: AWSError, data: FSx.Types.CreateBackupResponse) => void): Request; + /** + * Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data. If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following: Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the backup. By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same. The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information. + */ + createBackup(callback?: (err: AWSError, data: FSx.Types.CreateBackupResponse) => void): Request; + /** + * Creates a new, empty Amazon FSx file system. If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system. This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. + */ + createFileSystem(params: FSx.Types.CreateFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.CreateFileSystemResponse) => void): Request; + /** + * Creates a new, empty Amazon FSx file system. If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system. This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. + */ + createFileSystem(callback?: (err: AWSError, data: FSx.Types.CreateFileSystemResponse) => void): Request; + /** + * Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup. If a file system with the specified client request token exists and the parameters match, this call returns the description of the existing file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following: Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system. Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings. By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. + */ + createFileSystemFromBackup(params: FSx.Types.CreateFileSystemFromBackupRequest, callback?: (err: AWSError, data: FSx.Types.CreateFileSystemFromBackupResponse) => void): Request; + /** + * Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup. If a file system with the specified client request token exists and the parameters match, this call returns the description of the existing file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following: Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system. Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings. By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. + */ + createFileSystemFromBackup(callback?: (err: AWSError, data: FSx.Types.CreateFileSystemFromBackupResponse) => void): Request; + /** + * Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone. The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls. The data in a deleted backup is also deleted and can't be recovered by any means. + */ + deleteBackup(params: FSx.Types.DeleteBackupRequest, callback?: (err: AWSError, data: FSx.Types.DeleteBackupResponse) => void): Request; + /** + * Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone. The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls. The data in a deleted backup is also deleted and can't be recovered by any means. + */ + deleteBackup(callback?: (err: AWSError, data: FSx.Types.DeleteBackupResponse) => void): Request; + /** + * Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted. The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error. The data in a deleted file system is also deleted and can't be recovered by any means. + */ + deleteFileSystem(params: FSx.Types.DeleteFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.DeleteFileSystemResponse) => void): Request; + /** + * Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted. The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error. The data in a deleted file system is also deleted and can't be recovered by any means. + */ + deleteFileSystem(callback?: (err: AWSError, data: FSx.Types.DeleteFileSystemResponse) => void): Request; + /** + * Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified. + */ + describeBackups(params: FSx.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: FSx.Types.DescribeBackupsResponse) => void): Request; + /** + * Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified. + */ + describeBackups(callback?: (err: AWSError, data: FSx.Types.DescribeBackupsResponse) => void): Request; + /** + * Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified. + */ + describeFileSystems(params: FSx.Types.DescribeFileSystemsRequest, callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemsResponse) => void): Request; + /** + * Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified. + */ + describeFileSystems(callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemsResponse) => void): Request; + /** + * Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server. When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified. + */ + listTagsForResource(params: FSx.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: FSx.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server. When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified. + */ + listTagsForResource(callback?: (err: AWSError, data: FSx.Types.ListTagsForResourceResponse) => void): Request; + /** + * Tags an Amazon FSx resource. + */ + tagResource(params: FSx.Types.TagResourceRequest, callback?: (err: AWSError, data: FSx.Types.TagResourceResponse) => void): Request; + /** + * Tags an Amazon FSx resource. + */ + tagResource(callback?: (err: AWSError, data: FSx.Types.TagResourceResponse) => void): Request; + /** + * This action removes a tag from an Amazon FSx resource. + */ + untagResource(params: FSx.Types.UntagResourceRequest, callback?: (err: AWSError, data: FSx.Types.UntagResourceResponse) => void): Request; + /** + * This action removes a tag from an Amazon FSx resource. + */ + untagResource(callback?: (err: AWSError, data: FSx.Types.UntagResourceResponse) => void): Request; + /** + * Updates a file system configuration. + */ + updateFileSystem(params: FSx.Types.UpdateFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request; + /** + * Updates a file system configuration. + */ + updateFileSystem(callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request; +} +declare namespace FSx { + export type AWSAccountId = string; + export type ArchivePath = string; + export type AutomaticBackupRetentionDays = number; + export interface Backup { + /** + * The ID of the backup. + */ + BackupId: BackupId; + /** + * The lifecycle status of the backup. + */ + Lifecycle: BackupLifecycle; + /** + * Details explaining any failures that occur when creating a backup. + */ + FailureDetails?: BackupFailureDetails; + /** + * The type of the backup. + */ + Type: BackupType; + ProgressPercent?: ProgressPercent; + /** + * The time when a particular backup was created. + */ + CreationTime: CreationTime; + /** + * The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data. + */ + KmsKeyId?: KmsKeyId; + /** + * The Amazon Resource Name (ARN) for the backup resource. + */ + ResourceARN?: ResourceARN; + /** + * Tags associated with a particular file system. + */ + Tags?: Tags; + /** + * Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted. + */ + FileSystem: FileSystem; + } + export interface BackupFailureDetails { + /** + * A message describing the backup creation failure. + */ + Message?: ErrorMessage; + } + export type BackupId = string; + export type BackupIds = BackupId[]; + export type BackupLifecycle = "AVAILABLE"|"CREATING"|"DELETED"|"FAILED"|string; + export type BackupType = "AUTOMATIC"|"USER_INITIATED"|string; + export type Backups = Backup[]; + export type ClientRequestToken = string; + export interface CreateBackupRequest { + /** + * The ID of the file system to back up. + */ + FileSystemId: FileSystemId; + /** + * (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. + */ + Tags?: Tags; + } + export interface CreateBackupResponse { + /** + * A description of the backup. + */ + Backup?: Backup; + } + export interface CreateFileSystemFromBackupRequest { + BackupId: BackupId; + /** + * (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. + */ + ClientRequestToken?: ClientRequestToken; + /** + * A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also launched in that subnet's Availability Zone. + */ + SubnetIds: SubnetIds; + /** + * A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later describe requests. + */ + SecurityGroupIds?: SecurityGroupIds; + /** + * The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name. + */ + Tags?: Tags; + /** + * The configuration for this Microsoft Windows file system. + */ + WindowsConfiguration?: CreateFileSystemWindowsConfiguration; + } + export interface CreateFileSystemFromBackupResponse { + /** + * A description of the file system. + */ + FileSystem?: FileSystem; + } + export interface CreateFileSystemLustreConfiguration { + /** + * The preferred time to perform weekly maintenance, in the UTC time zone. + */ + WeeklyMaintenanceStartTime?: WeeklyTime; + /** + * (Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. + */ + ImportPath?: ArchivePath; + /** + * (Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z. The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket. + */ + ExportPath?: ArchivePath; + /** + * (Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. + */ + ImportedFileChunkSize?: Megabytes; + } + export interface CreateFileSystemRequest { + /** + * (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The type of file system. + */ + FileSystemType: FileSystemType; + /** + * The storage capacity of the file system. For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB. For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB. + */ + StorageCapacity: StorageCapacity; + /** + * A list of IDs for the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also launched in that subnet's Availability Zone. + */ + SubnetIds: SubnetIds; + /** + * A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces. This list isn't returned in later describe requests. + */ + SecurityGroupIds?: SecurityGroupIds; + /** + * The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name. + */ + Tags?: Tags; + KmsKeyId?: KmsKeyId; + /** + * The configuration for this Microsoft Windows file system. + */ + WindowsConfiguration?: CreateFileSystemWindowsConfiguration; + LustreConfiguration?: CreateFileSystemLustreConfiguration; + } + export interface CreateFileSystemResponse { + /** + * A description of the file system. + */ + FileSystem?: FileSystem; + } + export interface CreateFileSystemWindowsConfiguration { + /** + * The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. + */ + ActiveDirectoryId?: DirectoryId; + /** + * The throughput of an Amazon FSx file system, measured in megabytes per second. + */ + ThroughputCapacity: MegabytesPerSecond; + /** + * The preferred start time to perform weekly maintenance, in the UTC time zone. + */ + WeeklyMaintenanceStartTime?: WeeklyTime; + /** + * The preferred time to take daily automatic backups, in the UTC time zone. + */ + DailyAutomaticBackupStartTime?: DailyTime; + /** + * The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 days. + */ + AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; + /** + * A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. + */ + CopyTagsToBackups?: Flag; + } + export type CreationTime = Date; + export type DNSName = string; + export type DailyTime = string; + export interface DataRepositoryConfiguration { + /** + * The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. + */ + ImportPath?: ArchivePath; + /** + * The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. + */ + ExportPath?: ArchivePath; + /** + * For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. + */ + ImportedFileChunkSize?: Megabytes; + } + export interface DeleteBackupRequest { + /** + * The ID of the backup you want to delete. + */ + BackupId: BackupId; + /** + * (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK. + */ + ClientRequestToken?: ClientRequestToken; + } + export interface DeleteBackupResponse { + /** + * The ID of the backup deleted. + */ + BackupId?: BackupId; + /** + * The lifecycle of the backup. Should be DELETED. + */ + Lifecycle?: BackupLifecycle; + } + export interface DeleteFileSystemRequest { + /** + * The ID of the file system you want to delete. + */ + FileSystemId: FileSystemId; + /** + * (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK. + */ + ClientRequestToken?: ClientRequestToken; + WindowsConfiguration?: DeleteFileSystemWindowsConfiguration; + } + export interface DeleteFileSystemResponse { + /** + * The ID of the file system being deleted. + */ + FileSystemId?: FileSystemId; + /** + * The file system lifecycle for the deletion request. Should be DELETING. + */ + Lifecycle?: FileSystemLifecycle; + WindowsResponse?: DeleteFileSystemWindowsResponse; + } + export interface DeleteFileSystemWindowsConfiguration { + /** + * By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so. + */ + SkipFinalBackup?: Flag; + /** + * A set of tags for your final backup. + */ + FinalBackupTags?: Tags; + } + export interface DeleteFileSystemWindowsResponse { + /** + * The ID of the final backup for this file system. + */ + FinalBackupId?: BackupId; + /** + * The set of tags applied to the final backup. + */ + FinalBackupTags?: Tags; + } + export interface DescribeBackupsRequest { + /** + * (Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown. + */ + BackupIds?: BackupIds; + /** + * (Optional) Filters structure. Supported names are file-system-id and backup-type. + */ + Filters?: Filters; + /** + * (Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page. + */ + MaxResults?: MaxResults; + /** + * (Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off. + */ + NextToken?: NextToken; + } + export interface DescribeBackupsResponse { + /** + * Any array of backups. + */ + Backups?: Backups; + /** + * This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups. + */ + NextToken?: NextToken; + } + export interface DescribeFileSystemsRequest { + /** + * (Optional) IDs of the file systems whose descriptions you want to retrieve (String). + */ + FileSystemIds?: FileSystemIds; + /** + * (Optional) Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page. + */ + MaxResults?: MaxResults; + /** + * (Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off. + */ + NextToken?: NextToken; + } + export interface DescribeFileSystemsResponse { + /** + * An array of file system descriptions. + */ + FileSystems?: FileSystems; + /** + * Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions. + */ + NextToken?: NextToken; + } + export type DirectoryId = string; + export type ErrorMessage = string; + export interface FileSystem { + /** + * The AWS account that created the file system. If the file system was created by an IAM user, the AWS account to which the IAM user belongs is the owner. + */ + OwnerId?: AWSAccountId; + /** + * The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. + */ + CreationTime?: CreationTime; + /** + * The eight-digit ID of the file system that was automatically assigned by Amazon FSx. + */ + FileSystemId?: FileSystemId; + /** + * Type of file system. Currently the only supported type is WINDOWS. + */ + FileSystemType?: FileSystemType; + /** + * The lifecycle status of the file system. + */ + Lifecycle?: FileSystemLifecycle; + FailureDetails?: FileSystemFailureDetails; + /** + * The storage capacity of the file system in gigabytes. + */ + StorageCapacity?: StorageCapacity; + /** + * The ID of the primary VPC for the file system. + */ + VpcId?: VpcId; + /** + * The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet. + */ + SubnetIds?: SubnetIds; + /** + * The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide. For an Amazon FSx for Windows File Server file system, you can have one network interface Id. For an Amazon FSx for Lustre file system, you can have more than one. + */ + NetworkInterfaceIds?: NetworkInterfaceIds; + /** + * The DNS name for the file system. + */ + DNSName?: DNSName; + /** + * The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system. + */ + KmsKeyId?: KmsKeyId; + /** + * The resource ARN of the file system. + */ + ResourceARN?: ResourceARN; + /** + * The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide. + */ + Tags?: Tags; + /** + * The configuration for this Microsoft Windows file system. + */ + WindowsConfiguration?: WindowsFileSystemConfiguration; + LustreConfiguration?: LustreFileSystemConfiguration; + } + export interface FileSystemFailureDetails { + /** + * Message describing the failures that occurred during file system creation. + */ + Message?: ErrorMessage; + } + export type FileSystemId = string; + export type FileSystemIds = FileSystemId[]; + export type FileSystemLifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|string; + export type FileSystemMaintenanceOperation = "PATCHING"|"BACKING_UP"|string; + export type FileSystemMaintenanceOperations = FileSystemMaintenanceOperation[]; + export type FileSystemType = "WINDOWS"|"LUSTRE"|string; + export type FileSystems = FileSystem[]; + export interface Filter { + /** + * The name for this filter. + */ + Name?: FilterName; + /** + * The values of the filter. These are all the values for any of the applied filters. + */ + Values?: FilterValues; + } + export type FilterName = "file-system-id"|"backup-type"|string; + export type FilterValue = string; + export type FilterValues = FilterValue[]; + export type Filters = Filter[]; + export type Flag = boolean; + export type KmsKeyId = string; + export interface ListTagsForResourceRequest { + /** + * The ARN of the Amazon FSx resource that will have its tags listed. + */ + ResourceARN: ResourceARN; + /** + * (Optional) Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page. + */ + MaxResults?: MaxResults; + /** + * (Optional) Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceResponse { + /** + * A list of tags on the resource. + */ + Tags?: Tags; + /** + * This is present if there are more tags than returned in the response (String). You can use the NextToken value in the later request to fetch the tags. + */ + NextToken?: NextToken; + } + export interface LustreFileSystemConfiguration { + /** + * The UTC time that you want to begin your weekly maintenance window. + */ + WeeklyMaintenanceStartTime?: WeeklyTime; + DataRepositoryConfiguration?: DataRepositoryConfiguration; + } + export type MaxResults = number; + export type Megabytes = number; + export type MegabytesPerSecond = number; + export type NetworkInterfaceId = string; + export type NetworkInterfaceIds = NetworkInterfaceId[]; + export type NextToken = string; + export type ProgressPercent = number; + export type ResourceARN = string; + export type SecurityGroupId = string; + export type SecurityGroupIds = SecurityGroupId[]; + export type StorageCapacity = number; + export type SubnetId = string; + export type SubnetIds = SubnetId[]; + export interface Tag { + /** + * A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached. + */ + Key?: TagKey; + /** + * A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeys = TagKey[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag. + */ + ResourceARN: ResourceARN; + /** + * A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter. + */ + Tags: Tags; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Tags = Tag[]; + export interface UntagResourceRequest { + /** + * The ARN of the Amazon FSx resource to untag. + */ + ResourceARN: ResourceARN; + /** + * A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent. + */ + TagKeys: TagKeys; + } + export interface UntagResourceResponse { + } + export interface UpdateFileSystemLustreConfiguration { + /** + * The preferred time to perform weekly maintenance, in the UTC time zone. + */ + WeeklyMaintenanceStartTime?: WeeklyTime; + } + export interface UpdateFileSystemRequest { + FileSystemId: FileSystemId; + /** + * (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The configuration for this Microsoft Windows file system. The only supported options are for backup and maintenance. + */ + WindowsConfiguration?: UpdateFileSystemWindowsConfiguration; + LustreConfiguration?: UpdateFileSystemLustreConfiguration; + } + export interface UpdateFileSystemResponse { + /** + * A description of the file system. + */ + FileSystem?: FileSystem; + } + export interface UpdateFileSystemWindowsConfiguration { + /** + * The preferred time to perform weekly maintenance, in the UTC time zone. + */ + WeeklyMaintenanceStartTime?: WeeklyTime; + /** + * The preferred time to take daily automatic backups, in the UTC time zone. + */ + DailyAutomaticBackupStartTime?: DailyTime; + /** + * The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days. + */ + AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; + } + export type VpcId = string; + export type WeeklyTime = string; + export interface WindowsFileSystemConfiguration { + /** + * The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. + */ + ActiveDirectoryId?: DirectoryId; + /** + * The throughput of an Amazon FSx file system, measured in megabytes per second. + */ + ThroughputCapacity?: MegabytesPerSecond; + /** + * The list of maintenance operations in progress for this file system. + */ + MaintenanceOperationsInProgress?: FileSystemMaintenanceOperations; + /** + * The preferred time to perform weekly maintenance, in the UTC time zone. + */ + WeeklyMaintenanceStartTime?: WeeklyTime; + /** + * The preferred time to take daily automatic backups, in the UTC time zone. + */ + DailyAutomaticBackupStartTime?: DailyTime; + /** + * The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days. + */ + AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; + /** + * A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. + */ + CopyTagsToBackups?: Flag; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-03-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the FSx client. + */ + export import Types = FSx; +} +export = FSx; diff --git a/node_modules/aws-sdk/clients/fsx.js b/node_modules/aws-sdk/clients/fsx.js new file mode 100644 index 0000000..e06cfb5 --- /dev/null +++ b/node_modules/aws-sdk/clients/fsx.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['fsx'] = {}; +AWS.FSx = Service.defineService('fsx', ['2018-03-01']); +Object.defineProperty(apiLoader.services['fsx'], '2018-03-01', { + get: function get() { + var model = require('../apis/fsx-2018-03-01.min.json'); + model.paginators = require('../apis/fsx-2018-03-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.FSx; diff --git a/node_modules/aws-sdk/clients/gamelift.d.ts b/node_modules/aws-sdk/clients/gamelift.d.ts new file mode 100644 index 0000000..1cce89c --- /dev/null +++ b/node_modules/aws-sdk/clients/gamelift.d.ts @@ -0,0 +1,3286 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class GameLift extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: GameLift.Types.ClientConfiguration) + config: Config & GameLift.Types.ClientConfiguration; + /** + * Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit. When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error. To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match. If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED, and processing is terminated. A new matchmaking request for these players can be submitted as needed. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + acceptMatch(params: GameLift.Types.AcceptMatchInput, callback?: (err: AWSError, data: GameLift.Types.AcceptMatchOutput) => void): Request; + /** + * Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit. When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error. To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match. If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED, and processing is terminated. A new matchmaking request for these players can be submitted as needed. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + acceptMatch(callback?: (err: AWSError, data: GameLift.Types.AcceptMatchOutput) => void): Request; + /** + * Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + createAlias(params: GameLift.Types.CreateAliasInput, callback?: (err: AWSError, data: GameLift.Types.CreateAliasOutput) => void): Request; + /** + * Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + createAlias(callback?: (err: AWSError, data: GameLift.Types.CreateAliasOutput) => void): Request; + /** + * Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location. Game server binaries must be combined into a .zip file for use with Amazon GameLift. To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios: Store a build file in an Amazon S3 bucket under your own AWS account. To use this option, you must first give Amazon GameLift access to that Amazon S3 bucket. To create a new build record using files in your Amazon S3 bucket, call CreateBuild and specify a build name, operating system, and the storage location of your game build. Upload a build file directly to Amazon GameLift's Amazon S3 account. To use this option, you first call CreateBuild with a build name and operating system. This action creates a new build record and returns an Amazon S3 storage location (bucket and key only) and temporary access credentials. Use the credentials to manually upload your build file to the storage location (see the Amazon S3 topic Uploading Objects). You can upload files to a location only once. If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets. Learn more Uploading Your Game Create a Build with Files in Amazon S3 Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + createBuild(params: GameLift.Types.CreateBuildInput, callback?: (err: AWSError, data: GameLift.Types.CreateBuildOutput) => void): Request; + /** + * Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location. Game server binaries must be combined into a .zip file for use with Amazon GameLift. To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios: Store a build file in an Amazon S3 bucket under your own AWS account. To use this option, you must first give Amazon GameLift access to that Amazon S3 bucket. To create a new build record using files in your Amazon S3 bucket, call CreateBuild and specify a build name, operating system, and the storage location of your game build. Upload a build file directly to Amazon GameLift's Amazon S3 account. To use this option, you first call CreateBuild with a build name and operating system. This action creates a new build record and returns an Amazon S3 storage location (bucket and key only) and temporary access credentials. Use the credentials to manually upload your build file to the storage location (see the Amazon S3 topic Uploading Objects). You can upload files to a location only once. If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets. Learn more Uploading Your Game Create a Build with Files in Amazon S3 Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + createBuild(callback?: (err: AWSError, data: GameLift.Types.CreateBuildOutput) => void): Request; + /** + * Creates a new fleet to run your game servers. whether they are custom game builds or Realtime Servers with game-specific script. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can host multiple game sessions. When creating a fleet, you choose the hardware specifications, set some configuration options, and specify the game server to deploy on the new fleet. To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type and fleet type (spot or on-demand), (3) the build ID for your game build or script ID if using Realtime Servers, and (4) a run-time configuration, which determines how game servers will run on each instance in the fleet. When creating a Realtime Servers fleet, we recommend using a minimal version of the Realtime script (see this working code example ). This will make it much easier to troubleshoot any fleet creation issues. Once the fleet is active, you can update your Realtime script as needed. If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events: Creates a fleet record. Status: NEW. Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console. Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance. Downloads the game build or Realtime script to the new instance and installs it. Statuses: DOWNLOADING, VALIDATING, BUILDING. Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds. Status: ACTIVATING. Sets the fleet's status to ACTIVE as soon as one server process is ready to host a game session. Learn more Working with Fleets Debug Fleet Creation Issues Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + createFleet(params: GameLift.Types.CreateFleetInput, callback?: (err: AWSError, data: GameLift.Types.CreateFleetOutput) => void): Request; + /** + * Creates a new fleet to run your game servers. whether they are custom game builds or Realtime Servers with game-specific script. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can host multiple game sessions. When creating a fleet, you choose the hardware specifications, set some configuration options, and specify the game server to deploy on the new fleet. To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type and fleet type (spot or on-demand), (3) the build ID for your game build or script ID if using Realtime Servers, and (4) a run-time configuration, which determines how game servers will run on each instance in the fleet. When creating a Realtime Servers fleet, we recommend using a minimal version of the Realtime script (see this working code example ). This will make it much easier to troubleshoot any fleet creation issues. Once the fleet is active, you can update your Realtime script as needed. If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events: Creates a fleet record. Status: NEW. Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console. Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance. Downloads the game build or Realtime script to the new instance and installs it. Statuses: DOWNLOADING, VALIDATING, BUILDING. Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds. Status: ACTIVATING. Sets the fleet's status to ACTIVE as soon as one server process is ready to host a game session. Learn more Working with Fleets Debug Fleet Creation Issues Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + createFleet(callback?: (err: AWSError, data: GameLift.Types.CreateFleetOutput) => void): Request; + /** + * Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it. To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified. Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change. Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request. Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy. Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files. Available in Amazon GameLift Local. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + createGameSession(params: GameLift.Types.CreateGameSessionInput, callback?: (err: AWSError, data: GameLift.Types.CreateGameSessionOutput) => void): Request; + /** + * Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it. To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified. Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change. Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request. Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy. Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files. Available in Amazon GameLift Local. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + createGameSession(callback?: (err: AWSError, data: GameLift.Types.CreateGameSessionOutput) => void): Request; + /** + * Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name. Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience. Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc. To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + createGameSessionQueue(params: GameLift.Types.CreateGameSessionQueueInput, callback?: (err: AWSError, data: GameLift.Types.CreateGameSessionQueueOutput) => void): Request; + /** + * Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name. Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience. Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc. To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + createGameSessionQueue(callback?: (err: AWSError, data: GameLift.Types.CreateGameSessionQueueOutput) => void): Request; + /** + * Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used. To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt. Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept. Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking). Since notifications promise only "best effort" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + createMatchmakingConfiguration(params: GameLift.Types.CreateMatchmakingConfigurationInput, callback?: (err: AWSError, data: GameLift.Types.CreateMatchmakingConfigurationOutput) => void): Request; + /** + * Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used. To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt. Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept. Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking). Since notifications promise only "best effort" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + createMatchmakingConfiguration(callback?: (err: AWSError, data: GameLift.Types.CreateMatchmakingConfigurationOutput) => void): Request; + /** + * Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration. To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same region as the matchmaking configuration they will be used with. Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set. Learn more Build a Rule Set Design a Matchmaker Matchmaking with FlexMatch Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + createMatchmakingRuleSet(params: GameLift.Types.CreateMatchmakingRuleSetInput, callback?: (err: AWSError, data: GameLift.Types.CreateMatchmakingRuleSetOutput) => void): Request; + /** + * Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration. To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same region as the matchmaking configuration they will be used with. Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set. Learn more Build a Rule Set Design a Matchmaker Matchmaking with FlexMatch Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + createMatchmakingRuleSet(callback?: (err: AWSError, data: GameLift.Types.CreateMatchmakingRuleSetOutput) => void): Request; + /** + * Reserves an open player slot in an active game session. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions. When the player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player. To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned. Player sessions cannot be updated. Available in Amazon GameLift Local. CreatePlayerSession CreatePlayerSessions DescribePlayerSessions Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + createPlayerSession(params: GameLift.Types.CreatePlayerSessionInput, callback?: (err: AWSError, data: GameLift.Types.CreatePlayerSessionOutput) => void): Request; + /** + * Reserves an open player slot in an active game session. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions. When the player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player. To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned. Player sessions cannot be updated. Available in Amazon GameLift Local. CreatePlayerSession CreatePlayerSessions DescribePlayerSessions Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + createPlayerSession(callback?: (err: AWSError, data: GameLift.Types.CreatePlayerSessionOutput) => void): Request; + /** + * Reserves open slots in a game session for a group of players. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession. When a player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player. To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, a slot is reserved in the game session for each player and a set of new PlayerSession objects is returned. Player sessions cannot be updated. Available in Amazon GameLift Local. CreatePlayerSession CreatePlayerSessions DescribePlayerSessions Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + createPlayerSessions(params: GameLift.Types.CreatePlayerSessionsInput, callback?: (err: AWSError, data: GameLift.Types.CreatePlayerSessionsOutput) => void): Request; + /** + * Reserves open slots in a game session for a group of players. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession. When a player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player. To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, a slot is reserved in the game session for each player and a set of new PlayerSession objects is returned. Player sessions cannot be updated. Available in Amazon GameLift Local. CreatePlayerSession CreatePlayerSessions DescribePlayerSessions Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + createPlayerSessions(callback?: (err: AWSError, data: GameLift.Types.CreatePlayerSessionsOutput) => void): Request; + /** + * Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations: A locally available directory. Use the ZipFile parameter for this option. An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket. If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment. Learn more Amazon GameLift Realtime Servers Set Up a Role for Amazon GameLift Access Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + createScript(params: GameLift.Types.CreateScriptInput, callback?: (err: AWSError, data: GameLift.Types.CreateScriptOutput) => void): Request; + /** + * Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations: A locally available directory. Use the ZipFile parameter for this option. An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket. If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment. Learn more Amazon GameLift Realtime Servers Set Up a Role for Amazon GameLift Access Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + createScript(callback?: (err: AWSError, data: GameLift.Types.CreateScriptOutput) => void): Request; + /** + * Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets. You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC. To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift. The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + createVpcPeeringAuthorization(params: GameLift.Types.CreateVpcPeeringAuthorizationInput, callback?: (err: AWSError, data: GameLift.Types.CreateVpcPeeringAuthorizationOutput) => void): Request; + /** + * Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets. You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC. To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift. The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + createVpcPeeringAuthorization(callback?: (err: AWSError, data: GameLift.Types.CreateVpcPeeringAuthorizationOutput) => void): Request; + /** + * Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. For more information, see VPC Peering with Amazon GameLift Fleets. Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + createVpcPeeringConnection(params: GameLift.Types.CreateVpcPeeringConnectionInput, callback?: (err: AWSError, data: GameLift.Types.CreateVpcPeeringConnectionOutput) => void): Request; + /** + * Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. For more information, see VPC Peering with Amazon GameLift Fleets. Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + createVpcPeeringConnection(callback?: (err: AWSError, data: GameLift.Types.CreateVpcPeeringConnectionOutput) => void): Request; + /** + * Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + deleteAlias(params: GameLift.Types.DeleteAliasInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + deleteAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a build. This action permanently deletes the build record and any uploaded build files. To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + deleteBuild(params: GameLift.Types.DeleteBuildInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a build. This action permanently deletes the build record and any uploaded build files. To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + deleteBuild(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity. This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + deleteFleet(params: GameLift.Types.DeleteFleetInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity. This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + deleteFleet(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + deleteGameSessionQueue(params: GameLift.Types.DeleteGameSessionQueueInput, callback?: (err: AWSError, data: GameLift.Types.DeleteGameSessionQueueOutput) => void): Request; + /** + * Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + deleteGameSessionQueue(callback?: (err: AWSError, data: GameLift.Types.DeleteGameSessionQueueOutput) => void): Request; + /** + * Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + deleteMatchmakingConfiguration(params: GameLift.Types.DeleteMatchmakingConfigurationInput, callback?: (err: AWSError, data: GameLift.Types.DeleteMatchmakingConfigurationOutput) => void): Request; + /** + * Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + deleteMatchmakingConfiguration(callback?: (err: AWSError, data: GameLift.Types.DeleteMatchmakingConfigurationOutput) => void): Request; + /** + * Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration. Learn more Build a Rule Set Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + deleteMatchmakingRuleSet(params: GameLift.Types.DeleteMatchmakingRuleSetInput, callback?: (err: AWSError, data: GameLift.Types.DeleteMatchmakingRuleSetOutput) => void): Request; + /** + * Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration. Learn more Build a Rule Set Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + deleteMatchmakingRuleSet(callback?: (err: AWSError, data: GameLift.Types.DeleteMatchmakingRuleSetOutput) => void): Request; + /** + * Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with. To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet. DescribeFleetCapacity UpdateFleetCapacity DescribeEC2InstanceLimits Manage scaling policies: PutScalingPolicy (auto-scaling) DescribeScalingPolicies (auto-scaling) DeleteScalingPolicy (auto-scaling) Manage fleet actions: StartFleetActions StopFleetActions + */ + deleteScalingPolicy(params: GameLift.Types.DeleteScalingPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with. To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet. DescribeFleetCapacity UpdateFleetCapacity DescribeEC2InstanceLimits Manage scaling policies: PutScalingPolicy (auto-scaling) DescribeScalingPolicies (auto-scaling) DeleteScalingPolicy (auto-scaling) Manage fleet actions: StartFleetActions StopFleetActions + */ + deleteScalingPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Realtime script. This action permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted). To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + deleteScript(params: GameLift.Types.DeleteScriptInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Realtime script. This action permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted). To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + deleteScript(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels a pending VPC peering authorization for the specified VPC. If the authorization has already been used to create a peering connection, call DeleteVpcPeeringConnection to remove the connection. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + deleteVpcPeeringAuthorization(params: GameLift.Types.DeleteVpcPeeringAuthorizationInput, callback?: (err: AWSError, data: GameLift.Types.DeleteVpcPeeringAuthorizationOutput) => void): Request; + /** + * Cancels a pending VPC peering authorization for the specified VPC. If the authorization has already been used to create a peering connection, call DeleteVpcPeeringConnection to remove the connection. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + deleteVpcPeeringAuthorization(callback?: (err: AWSError, data: GameLift.Types.DeleteVpcPeeringAuthorizationOutput) => void): Request; + /** + * Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization. Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + deleteVpcPeeringConnection(params: GameLift.Types.DeleteVpcPeeringConnectionInput, callback?: (err: AWSError, data: GameLift.Types.DeleteVpcPeeringConnectionOutput) => void): Request; + /** + * Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization. Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + deleteVpcPeeringConnection(callback?: (err: AWSError, data: GameLift.Types.DeleteVpcPeeringConnectionOutput) => void): Request; + /** + * Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias. To get alias properties, specify the alias ID. If successful, the requested alias record is returned. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + describeAlias(params: GameLift.Types.DescribeAliasInput, callback?: (err: AWSError, data: GameLift.Types.DescribeAliasOutput) => void): Request; + /** + * Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias. To get alias properties, specify the alias ID. If successful, the requested alias record is returned. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + describeAlias(callback?: (err: AWSError, data: GameLift.Types.DescribeAliasOutput) => void): Request; + /** + * Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + describeBuild(params: GameLift.Types.DescribeBuildInput, callback?: (err: AWSError, data: GameLift.Types.DescribeBuildOutput) => void): Request; + /** + * Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + describeBuild(callback?: (err: AWSError, data: GameLift.Types.DescribeBuildOutput) => void): Request; + /** + * Retrieves the following information for the specified EC2 instance type: maximum number of instances allowed per AWS account (service limit) current usage level for the AWS account Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner). Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeEC2InstanceLimits(params: GameLift.Types.DescribeEC2InstanceLimitsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeEC2InstanceLimitsOutput) => void): Request; + /** + * Retrieves the following information for the specified EC2 instance type: maximum number of instances allowed per AWS account (service limit) current usage level for the AWS account Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner). Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeEC2InstanceLimits(callback?: (err: AWSError, data: GameLift.Types.DescribeEC2InstanceLimitsOutput) => void): Request; + /** + * Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist. Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetAttributes(params: GameLift.Types.DescribeFleetAttributesInput, callback?: (err: AWSError, data: GameLift.Types.DescribeFleetAttributesOutput) => void): Request; + /** + * Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist. Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetAttributes(callback?: (err: AWSError, data: GameLift.Types.DescribeFleetAttributesOutput) => void): Request; + /** + * Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist. Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetCapacity(params: GameLift.Types.DescribeFleetCapacityInput, callback?: (err: AWSError, data: GameLift.Types.DescribeFleetCapacityOutput) => void): Request; + /** + * Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist. Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetCapacity(callback?: (err: AWSError, data: GameLift.Types.DescribeFleetCapacityOutput) => void): Request; + /** + * Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetEvents(params: GameLift.Types.DescribeFleetEventsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeFleetEventsOutput) => void): Request; + /** + * Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetEvents(callback?: (err: AWSError, data: GameLift.Types.DescribeFleetEventsOutput) => void): Request; + /** + * Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetPortSettings(params: GameLift.Types.DescribeFleetPortSettingsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeFleetPortSettingsOutput) => void): Request; + /** + * Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetPortSettings(callback?: (err: AWSError, data: GameLift.Types.DescribeFleetPortSettingsOutput) => void): Request; + /** + * Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist. Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetUtilization(params: GameLift.Types.DescribeFleetUtilizationInput, callback?: (err: AWSError, data: GameLift.Types.DescribeFleetUtilizationOutput) => void): Request; + /** + * Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist. Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeFleetUtilization(callback?: (err: AWSError, data: GameLift.Types.DescribeFleetUtilizationOutput) => void): Request; + /** + * Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet. To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describeGameSessionDetails(params: GameLift.Types.DescribeGameSessionDetailsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionDetailsOutput) => void): Request; + /** + * Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet. To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describeGameSessionDetails(callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionDetailsOutput) => void): Request; + /** + * Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describeGameSessionPlacement(params: GameLift.Types.DescribeGameSessionPlacementInput, callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionPlacementOutput) => void): Request; + /** + * Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describeGameSessionPlacement(callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionPlacementOutput) => void): Request; + /** + * Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + describeGameSessionQueues(params: GameLift.Types.DescribeGameSessionQueuesInput, callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionQueuesOutput) => void): Request; + /** + * Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + describeGameSessionQueues(callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionQueuesOutput) => void): Request; + /** + * Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails. To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request. Available in Amazon GameLift Local. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describeGameSessions(params: GameLift.Types.DescribeGameSessionsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionsOutput) => void): Request; + /** + * Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails. To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request. Available in Amazon GameLift Local. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describeGameSessions(callback?: (err: AWSError, data: GameLift.Types.DescribeGameSessionsOutput) => void): Request; + /** + * Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance. To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result. + */ + describeInstances(params: GameLift.Types.DescribeInstancesInput, callback?: (err: AWSError, data: GameLift.Types.DescribeInstancesOutput) => void): Request; + /** + * Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance. To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result. + */ + describeInstances(callback?: (err: AWSError, data: GameLift.Types.DescribeInstancesOutput) => void): Request; + /** + * Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session. You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking. To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + describeMatchmaking(params: GameLift.Types.DescribeMatchmakingInput, callback?: (err: AWSError, data: GameLift.Types.DescribeMatchmakingOutput) => void): Request; + /** + * Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session. You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking. To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + describeMatchmaking(callback?: (err: AWSError, data: GameLift.Types.DescribeMatchmakingOutput) => void): Request; + /** + * Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + describeMatchmakingConfigurations(params: GameLift.Types.DescribeMatchmakingConfigurationsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeMatchmakingConfigurationsOutput) => void): Request; + /** + * Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + describeMatchmakingConfigurations(callback?: (err: AWSError, data: GameLift.Types.DescribeMatchmakingConfigurationsOutput) => void): Request; + /** + * Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name. Learn more Build a Rule Set Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + describeMatchmakingRuleSets(params: GameLift.Types.DescribeMatchmakingRuleSetsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeMatchmakingRuleSetsOutput) => void): Request; + /** + * Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name. Learn more Build a Rule Set Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + describeMatchmakingRuleSets(callback?: (err: AWSError, data: GameLift.Types.DescribeMatchmakingRuleSetsOutput) => void): Request; + /** + * Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player. To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request. Available in Amazon GameLift Local. CreatePlayerSession CreatePlayerSessions DescribePlayerSessions Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describePlayerSessions(params: GameLift.Types.DescribePlayerSessionsInput, callback?: (err: AWSError, data: GameLift.Types.DescribePlayerSessionsOutput) => void): Request; + /** + * Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player. To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request. Available in Amazon GameLift Local. CreatePlayerSession CreatePlayerSessions DescribePlayerSessions Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + describePlayerSessions(callback?: (err: AWSError, data: GameLift.Types.DescribePlayerSessionsOutput) => void): Request; + /** + * Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeRuntimeConfiguration(params: GameLift.Types.DescribeRuntimeConfigurationInput, callback?: (err: AWSError, data: GameLift.Types.DescribeRuntimeConfigurationOutput) => void): Request; + /** + * Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + describeRuntimeConfiguration(callback?: (err: AWSError, data: GameLift.Types.DescribeRuntimeConfigurationOutput) => void): Request; + /** + * Retrieves all scaling policies applied to a fleet. To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet. A fleet may have all of its scaling policies suspended (StopFleetActions). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions. DescribeFleetCapacity UpdateFleetCapacity DescribeEC2InstanceLimits Manage scaling policies: PutScalingPolicy (auto-scaling) DescribeScalingPolicies (auto-scaling) DeleteScalingPolicy (auto-scaling) Manage fleet actions: StartFleetActions StopFleetActions + */ + describeScalingPolicies(params: GameLift.Types.DescribeScalingPoliciesInput, callback?: (err: AWSError, data: GameLift.Types.DescribeScalingPoliciesOutput) => void): Request; + /** + * Retrieves all scaling policies applied to a fleet. To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet. A fleet may have all of its scaling policies suspended (StopFleetActions). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions. DescribeFleetCapacity UpdateFleetCapacity DescribeEC2InstanceLimits Manage scaling policies: PutScalingPolicy (auto-scaling) DescribeScalingPolicies (auto-scaling) DeleteScalingPolicy (auto-scaling) Manage fleet actions: StartFleetActions StopFleetActions + */ + describeScalingPolicies(callback?: (err: AWSError, data: GameLift.Types.DescribeScalingPoliciesOutput) => void): Request; + /** + * Retrieves properties for a Realtime script. To request a script record, specify the script ID. If successful, an object containing the script properties is returned. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + describeScript(params: GameLift.Types.DescribeScriptInput, callback?: (err: AWSError, data: GameLift.Types.DescribeScriptOutput) => void): Request; + /** + * Retrieves properties for a Realtime script. To request a script record, specify the script ID. If successful, an object containing the script properties is returned. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + describeScript(callback?: (err: AWSError, data: GameLift.Types.DescribeScriptOutput) => void): Request; + /** + * Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + describeVpcPeeringAuthorizations(params: GameLift.Types.DescribeVpcPeeringAuthorizationsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeVpcPeeringAuthorizationsOutput) => void): Request; + /** + * Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + describeVpcPeeringAuthorizations(callback?: (err: AWSError, data: GameLift.Types.DescribeVpcPeeringAuthorizationsOutput) => void): Request; + /** + * Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + describeVpcPeeringConnections(params: GameLift.Types.DescribeVpcPeeringConnectionsInput, callback?: (err: AWSError, data: GameLift.Types.DescribeVpcPeeringConnectionsOutput) => void): Request; + /** + * Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect. CreateVpcPeeringAuthorization DescribeVpcPeeringAuthorizations DeleteVpcPeeringAuthorization CreateVpcPeeringConnection DescribeVpcPeeringConnections DeleteVpcPeeringConnection + */ + describeVpcPeeringConnections(callback?: (err: AWSError, data: GameLift.Types.DescribeVpcPeeringConnectionsOutput) => void): Request; + /** + * Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs. See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + getGameSessionLogUrl(params: GameLift.Types.GetGameSessionLogUrlInput, callback?: (err: AWSError, data: GameLift.Types.GetGameSessionLogUrlOutput) => void): Request; + /** + * Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs. See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + getGameSessionLogUrl(callback?: (err: AWSError, data: GameLift.Types.GetGameSessionLogUrlOutput) => void): Request; + /** + * Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time. Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance. To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials. + */ + getInstanceAccess(params: GameLift.Types.GetInstanceAccessInput, callback?: (err: AWSError, data: GameLift.Types.GetInstanceAccessOutput) => void): Request; + /** + * Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time. Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance. To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials. + */ + getInstanceAccess(callback?: (err: AWSError, data: GameLift.Types.GetInstanceAccessOutput) => void): Request; + /** + * Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages. Returned aliases are not listed in any particular order. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + listAliases(params: GameLift.Types.ListAliasesInput, callback?: (err: AWSError, data: GameLift.Types.ListAliasesOutput) => void): Request; + /** + * Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages. Returned aliases are not listed in any particular order. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + listAliases(callback?: (err: AWSError, data: GameLift.Types.ListAliasesOutput) => void): Request; + /** + * Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages. Build records are not listed in any particular order. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + listBuilds(params: GameLift.Types.ListBuildsInput, callback?: (err: AWSError, data: GameLift.Types.ListBuildsOutput) => void): Request; + /** + * Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages. Build records are not listed in any particular order. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + listBuilds(callback?: (err: AWSError, data: GameLift.Types.ListBuildsOutput) => void): Request; + /** + * Retrieves a collection of fleet records for this AWS account. You can filter the result set to find only those fleets that are deployed with a specific build or script. Use the pagination parameters to retrieve results in sequential pages. Fleet records are not listed in a particular order. Learn more Set Up Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + listFleets(params: GameLift.Types.ListFleetsInput, callback?: (err: AWSError, data: GameLift.Types.ListFleetsOutput) => void): Request; + /** + * Retrieves a collection of fleet records for this AWS account. You can filter the result set to find only those fleets that are deployed with a specific build or script. Use the pagination parameters to retrieve results in sequential pages. Fleet records are not listed in a particular order. Learn more Set Up Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + listFleets(callback?: (err: AWSError, data: GameLift.Types.ListFleetsOutput) => void): Request; + /** + * Retrieves script records for all Realtime scripts that are associated with the AWS account in use. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + listScripts(params: GameLift.Types.ListScriptsInput, callback?: (err: AWSError, data: GameLift.Types.ListScriptsOutput) => void): Request; + /** + * Retrieves script records for all Realtime scripts that are associated with the AWS account in use. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + listScripts(callback?: (err: AWSError, data: GameLift.Types.ListScriptsOutput) => void): Request; + /** + * Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences. You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy. Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling. Target-based policy A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target. For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer. To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. Rule-based policy A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%." A policy's rule statement has the following structure: If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment]. To implement the example, the rule statement would look like this: If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10]. To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. DescribeFleetCapacity UpdateFleetCapacity DescribeEC2InstanceLimits Manage scaling policies: PutScalingPolicy (auto-scaling) DescribeScalingPolicies (auto-scaling) DeleteScalingPolicy (auto-scaling) Manage fleet actions: StartFleetActions StopFleetActions + */ + putScalingPolicy(params: GameLift.Types.PutScalingPolicyInput, callback?: (err: AWSError, data: GameLift.Types.PutScalingPolicyOutput) => void): Request; + /** + * Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences. You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy. Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling. Target-based policy A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target. For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer. To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. Rule-based policy A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%." A policy's rule statement has the following structure: If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment]. To implement the example, the rule statement would look like this: If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10]. To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. DescribeFleetCapacity UpdateFleetCapacity DescribeEC2InstanceLimits Manage scaling policies: PutScalingPolicy (auto-scaling) DescribeScalingPolicies (auto-scaling) DeleteScalingPolicy (auto-scaling) Manage fleet actions: StartFleetActions StopFleetActions + */ + putScalingPolicy(callback?: (err: AWSError, data: GameLift.Types.PutScalingPolicyOutput) => void): Request; + /** + * Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild. To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID. Learn more Uploading Your Game Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + requestUploadCredentials(params: GameLift.Types.RequestUploadCredentialsInput, callback?: (err: AWSError, data: GameLift.Types.RequestUploadCredentialsOutput) => void): Request; + /** + * Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild. To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID. Learn more Uploading Your Game Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + requestUploadCredentials(callback?: (err: AWSError, data: GameLift.Types.RequestUploadCredentialsOutput) => void): Request; + /** + * Retrieves the fleet ID that a specified alias is currently pointing to. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + resolveAlias(params: GameLift.Types.ResolveAliasInput, callback?: (err: AWSError, data: GameLift.Types.ResolveAliasOutput) => void): Request; + /** + * Retrieves the fleet ID that a specified alias is currently pointing to. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + resolveAlias(callback?: (err: AWSError, data: GameLift.Types.ResolveAliasOutput) => void): Request; + /** + * Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes: gameSessionId -- Unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value. gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session. gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl". All custom data values are searched as strings. maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds. playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out. hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join. To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages. You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + searchGameSessions(params: GameLift.Types.SearchGameSessionsInput, callback?: (err: AWSError, data: GameLift.Types.SearchGameSessionsOutput) => void): Request; + /** + * Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes: gameSessionId -- Unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value. gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session. gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl". All custom data values are searched as strings. maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds. playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out. hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join. To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages. You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + searchGameSessions(callback?: (err: AWSError, data: GameLift.Types.SearchGameSessionsOutput) => void): Request; + /** + * Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity. To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + startFleetActions(params: GameLift.Types.StartFleetActionsInput, callback?: (err: AWSError, data: GameLift.Types.StartFleetActionsOutput) => void): Request; + /** + * Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity. To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + startFleetActions(callback?: (err: AWSError, data: GameLift.Types.StartFleetActionsOutput) => void): Request; + /** + * Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out. A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request. When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order. Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region's average lag for all players and reorders to get the best game play across all players. To place a new game session request, specify the following: The queue name and a set of game session properties and settings A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request (Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player) Latency data for all players (if you want to optimize game play for the players) If successful, a new game session placement is created. To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + startGameSessionPlacement(params: GameLift.Types.StartGameSessionPlacementInput, callback?: (err: AWSError, data: GameLift.Types.StartGameSessionPlacementOutput) => void): Request; + /** + * Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out. A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request. When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order. Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region's average lag for all players and reorders to get the best game play across all players. To place a new game session request, specify the following: The queue name and a set of game session properties and settings A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request (Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player) Latency data for all players (if you want to optimize game play for the players) If successful, a new game session placement is created. To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + startGameSessionPlacement(callback?: (err: AWSError, data: GameLift.Types.StartGameSessionPlacementOutput) => void): Request; + /** + * Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created. To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch. The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + startMatchBackfill(params: GameLift.Types.StartMatchBackfillInput, callback?: (err: AWSError, data: GameLift.Types.StartMatchBackfillOutput) => void): Request; + /** + * Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created. To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch. The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + startMatchBackfill(callback?: (err: AWSError, data: GameLift.Types.StartMatchBackfillOutput) => void): Request; + /** + * Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration. For complete information on setting up and using FlexMatch, see the topic Adding FlexMatch to Your Game. To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED. Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches. Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests: Polling -- Call DescribeMatchmaking. This operation returns the full ticket object, including current status and (for completed tickets) game session connection info. We recommend polling no more than once every 10 seconds. Notifications -- Get event notifications for changes in ticket status using Amazon Simple Notification Service (SNS). Notifications are easy to set up (see CreateMatchmakingConfiguration) and typically deliver match status changes faster and more efficiently than polling. We recommend that you use polling to back up to notifications (since delivery is not guaranteed) and call DescribeMatchmaking only when notifications are not received within 30 seconds. Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows: Your client code submits a StartMatchmaking request for one or more players and tracks the status of the request ticket. FlexMatch uses this ticket and others in process to build an acceptable match. When a potential match is identified, all tickets in the proposed match are advanced to the next status. If the match requires player acceptance (set in the matchmaking configuration), the tickets move into status REQUIRES_ACCEPTANCE. This status triggers your client code to solicit acceptance from all players in every ticket involved in the match, and then call AcceptMatch for each player. If any player rejects or fails to accept the match before a specified timeout, the proposed match is dropped (see AcceptMatch for more details). Once a match is proposed and accepted, the matchmaking tickets move into status PLACING. FlexMatch locates resources for a new game session using the game session queue (set in the matchmaking configuration) and creates the game session based on the match data. When the match is successfully placed, the matchmaking tickets move into COMPLETED status. Connection information (including game session endpoint and player session) is added to the matchmaking tickets. Matched players can use the connection information to join the game. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + startMatchmaking(params: GameLift.Types.StartMatchmakingInput, callback?: (err: AWSError, data: GameLift.Types.StartMatchmakingOutput) => void): Request; + /** + * Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration. For complete information on setting up and using FlexMatch, see the topic Adding FlexMatch to Your Game. To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED. Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches. Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests: Polling -- Call DescribeMatchmaking. This operation returns the full ticket object, including current status and (for completed tickets) game session connection info. We recommend polling no more than once every 10 seconds. Notifications -- Get event notifications for changes in ticket status using Amazon Simple Notification Service (SNS). Notifications are easy to set up (see CreateMatchmakingConfiguration) and typically deliver match status changes faster and more efficiently than polling. We recommend that you use polling to back up to notifications (since delivery is not guaranteed) and call DescribeMatchmaking only when notifications are not received within 30 seconds. Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows: Your client code submits a StartMatchmaking request for one or more players and tracks the status of the request ticket. FlexMatch uses this ticket and others in process to build an acceptable match. When a potential match is identified, all tickets in the proposed match are advanced to the next status. If the match requires player acceptance (set in the matchmaking configuration), the tickets move into status REQUIRES_ACCEPTANCE. This status triggers your client code to solicit acceptance from all players in every ticket involved in the match, and then call AcceptMatch for each player. If any player rejects or fails to accept the match before a specified timeout, the proposed match is dropped (see AcceptMatch for more details). Once a match is proposed and accepted, the matchmaking tickets move into status PLACING. FlexMatch locates resources for a new game session using the game session queue (set in the matchmaking configuration) and creates the game session based on the match data. When the match is successfully placed, the matchmaking tickets move into COMPLETED status. Connection information (including game session endpoint and player session) is added to the matchmaking tickets. Matched players can use the connection information to join the game. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + startMatchmaking(callback?: (err: AWSError, data: GameLift.Types.StartMatchmakingOutput) => void): Request; + /** + * Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes. To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting (FleetCapacity. Changes to the fleet's capacity must be done manually using UpdateFleetCapacity. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + stopFleetActions(params: GameLift.Types.StopFleetActionsInput, callback?: (err: AWSError, data: GameLift.Types.StopFleetActionsOutput) => void): Request; + /** + * Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes. To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting (FleetCapacity. Changes to the fleet's capacity must be done manually using UpdateFleetCapacity. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + stopFleetActions(callback?: (err: AWSError, data: GameLift.Types.StopFleetActionsOutput) => void): Request; + /** + * Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + stopGameSessionPlacement(params: GameLift.Types.StopGameSessionPlacementInput, callback?: (err: AWSError, data: GameLift.Types.StopGameSessionPlacementOutput) => void): Request; + /** + * Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + stopGameSessionPlacement(callback?: (err: AWSError, data: GameLift.Types.StopGameSessionPlacementOutput) => void): Request; + /** + * Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + stopMatchmaking(params: GameLift.Types.StopMatchmakingInput, callback?: (err: AWSError, data: GameLift.Types.StopMatchmakingOutput) => void): Request; + /** + * Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED. StartMatchmaking DescribeMatchmaking StopMatchmaking AcceptMatch StartMatchBackfill + */ + stopMatchmaking(callback?: (err: AWSError, data: GameLift.Types.StopMatchmakingOutput) => void): Request; + /** + * Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + updateAlias(params: GameLift.Types.UpdateAliasInput, callback?: (err: AWSError, data: GameLift.Types.UpdateAliasOutput) => void): Request; + /** + * Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned. CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias + */ + updateAlias(callback?: (err: AWSError, data: GameLift.Types.UpdateAliasOutput) => void): Request; + /** + * Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + updateBuild(params: GameLift.Types.UpdateBuildInput, callback?: (err: AWSError, data: GameLift.Types.UpdateBuildOutput) => void): Request; + /** + * Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned. Learn more Working with Builds Related operations CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild + */ + updateBuild(callback?: (err: AWSError, data: GameLift.Types.UpdateBuildOutput) => void): Request; + /** + * Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateFleetAttributes(params: GameLift.Types.UpdateFleetAttributesInput, callback?: (err: AWSError, data: GameLift.Types.UpdateFleetAttributesOutput) => void): Request; + /** + * Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateFleetAttributes(callback?: (err: AWSError, data: GameLift.Types.UpdateFleetAttributesOutput) => void): Request; + /** + * Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type. Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments. To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateFleetCapacity(params: GameLift.Types.UpdateFleetCapacityInput, callback?: (err: AWSError, data: GameLift.Types.UpdateFleetCapacityOutput) => void): Request; + /** + * Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type. Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments. To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateFleetCapacity(callback?: (err: AWSError, data: GameLift.Types.UpdateFleetCapacityOutput) => void): Request; + /** + * Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateFleetPortSettings(params: GameLift.Types.UpdateFleetPortSettingsInput, callback?: (err: AWSError, data: GameLift.Types.UpdateFleetPortSettingsOutput) => void): Request; + /** + * Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateFleetPortSettings(callback?: (err: AWSError, data: GameLift.Types.UpdateFleetPortSettingsOutput) => void): Request; + /** + * Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + updateGameSession(params: GameLift.Types.UpdateGameSessionInput, callback?: (err: AWSError, data: GameLift.Types.UpdateGameSessionOutput) => void): Request; + /** + * Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned. CreateGameSession DescribeGameSessions DescribeGameSessionDetails SearchGameSessions UpdateGameSession GetGameSessionLogUrl Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement + */ + updateGameSession(callback?: (err: AWSError, data: GameLift.Types.UpdateGameSessionOutput) => void): Request; + /** + * Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + updateGameSessionQueue(params: GameLift.Types.UpdateGameSessionQueueInput, callback?: (err: AWSError, data: GameLift.Types.UpdateGameSessionQueueOutput) => void): Request; + /** + * Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations. CreateGameSessionQueue DescribeGameSessionQueues UpdateGameSessionQueue DeleteGameSessionQueue + */ + updateGameSessionQueue(callback?: (err: AWSError, data: GameLift.Types.UpdateGameSessionQueueOutput) => void): Request; + /** + * Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + updateMatchmakingConfiguration(params: GameLift.Types.UpdateMatchmakingConfigurationInput, callback?: (err: AWSError, data: GameLift.Types.UpdateMatchmakingConfigurationOutput) => void): Request; + /** + * Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings. CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + updateMatchmakingConfiguration(callback?: (err: AWSError, data: GameLift.Types.UpdateMatchmakingConfigurationOutput) => void): Request; + /** + * Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status. To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with an updated set of server process configurations. Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; run-time configuration changes are applied gradually as existing processes shut down and new processes are launched during Amazon GameLift's normal process recycling activity. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateRuntimeConfiguration(params: GameLift.Types.UpdateRuntimeConfigurationInput, callback?: (err: AWSError, data: GameLift.Types.UpdateRuntimeConfigurationOutput) => void): Request; + /** + * Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status. To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with an updated set of server process configurations. Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; run-time configuration changes are applied gradually as existing processes shut down and new processes are launched during Amazon GameLift's normal process recycling activity. Learn more Working with Fleets. Related operations CreateFleet ListFleets DeleteFleet Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits DescribeFleetEvents Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings UpdateRuntimeConfiguration Manage fleet actions: StartFleetActions StopFleetActions + */ + updateRuntimeConfiguration(callback?: (err: AWSError, data: GameLift.Types.UpdateRuntimeConfigurationOutput) => void): Request; + /** + * Updates Realtime script metadata and content. To update script metadata, specify the script ID and provide updated name and/or version values. To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script. If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + updateScript(params: GameLift.Types.UpdateScriptInput, callback?: (err: AWSError, data: GameLift.Types.UpdateScriptOutput) => void): Request; + /** + * Updates Realtime script metadata and content. To update script metadata, specify the script ID and provide updated name and/or version values. To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script. If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions. Learn more Amazon GameLift Realtime Servers Related operations CreateScript ListScripts DescribeScript UpdateScript DeleteScript + */ + updateScript(callback?: (err: AWSError, data: GameLift.Types.UpdateScriptOutput) => void): Request; + /** + * Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string. Learn more Build a Rule Set Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + validateMatchmakingRuleSet(params: GameLift.Types.ValidateMatchmakingRuleSetInput, callback?: (err: AWSError, data: GameLift.Types.ValidateMatchmakingRuleSetOutput) => void): Request; + /** + * Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string. Learn more Build a Rule Set Related operations CreateMatchmakingConfiguration DescribeMatchmakingConfigurations UpdateMatchmakingConfiguration DeleteMatchmakingConfiguration CreateMatchmakingRuleSet DescribeMatchmakingRuleSets ValidateMatchmakingRuleSet DeleteMatchmakingRuleSet + */ + validateMatchmakingRuleSet(callback?: (err: AWSError, data: GameLift.Types.ValidateMatchmakingRuleSetOutput) => void): Request; +} +declare namespace GameLift { + export interface AcceptMatchInput { + /** + * Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail. + */ + TicketId: MatchmakingIdStringModel; + /** + * Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs. + */ + PlayerIds: StringList; + /** + * Player response to the proposed match. + */ + AcceptanceType: AcceptanceType; + } + export interface AcceptMatchOutput { + } + export type AcceptanceType = "ACCEPT"|"REJECT"|string; + export interface Alias { + /** + * Unique identifier for an alias; alias IDs are unique within a region. + */ + AliasId?: AliasId; + /** + * Descriptive label that is associated with an alias. Alias names do not need to be unique. + */ + Name?: NonBlankAndLengthConstraintString; + /** + * Unique identifier for an alias; alias ARNs are unique across all regions. + */ + AliasArn?: ArnStringModel; + /** + * Human-readable description of an alias. + */ + Description?: FreeText; + /** + * Alias configuration for the alias, including routing type and settings. + */ + RoutingStrategy?: RoutingStrategy; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + /** + * Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + LastUpdatedTime?: Timestamp; + } + export type AliasId = string; + export type AliasList = Alias[]; + export type ArnStringModel = string; + export interface AttributeValue { + /** + * For single string values. Maximum string length is 100 characters. + */ + S?: NonZeroAndMaxString; + /** + * For number values, expressed as double. + */ + N?: DoubleObject; + /** + * For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored. + */ + SL?: StringList; + /** + * For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters. + */ + SDM?: StringDoubleMap; + } + export interface AwsCredentials { + /** + * Temporary key allowing access to the Amazon GameLift S3 account. + */ + AccessKeyId?: NonEmptyString; + /** + * Temporary secret key allowing access to the Amazon GameLift S3 account. + */ + SecretAccessKey?: NonEmptyString; + /** + * Token used to associate a specific build ID with the files uploaded using these credentials. + */ + SessionToken?: NonEmptyString; + } + export type BooleanModel = boolean; + export interface Build { + /** + * Unique identifier for a build. + */ + BuildId?: BuildId; + /** + * Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild. + */ + Name?: FreeText; + /** + * Version that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild. + */ + Version?: FreeText; + /** + * Current status of the build. Possible build statuses include the following: INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value. READY -- The game build has been successfully uploaded. You can now create new fleets for this build. FAILED -- The game build upload failed. You cannot create new fleets for this build. + */ + Status?: BuildStatus; + /** + * File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0. + */ + SizeOnDisk?: PositiveLong; + /** + * Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. + */ + OperatingSystem?: OperatingSystem; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + } + export type BuildId = string; + export type BuildList = Build[]; + export type BuildStatus = "INITIALIZED"|"READY"|"FAILED"|string; + export type ComparisonOperatorType = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|string; + export interface CreateAliasInput { + /** + * Descriptive label that is associated with an alias. Alias names do not need to be unique. + */ + Name: NonBlankAndLengthConstraintString; + /** + * Human-readable description of an alias. + */ + Description?: NonZeroAndMaxString; + /** + * Object that specifies the fleet and routing type to use for the alias. + */ + RoutingStrategy: RoutingStrategy; + } + export interface CreateAliasOutput { + /** + * Object that describes the newly created alias record. + */ + Alias?: Alias; + } + export interface CreateBuildInput { + /** + * Descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later. + */ + Name?: NonZeroAndMaxString; + /** + * Version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later. + */ + Version?: NonZeroAndMaxString; + /** + * Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key, as well as a the ARN for a role that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in. + */ + StorageLocation?: S3Location; + /** + * Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later. + */ + OperatingSystem?: OperatingSystem; + } + export interface CreateBuildOutput { + /** + * The newly created build record, including a unique build ID and status. + */ + Build?: Build; + /** + * This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials. + */ + UploadCredentials?: AwsCredentials; + /** + * Amazon S3 location for your game build file, including bucket name and key. + */ + StorageLocation?: S3Location; + } + export interface CreateFleetInput { + /** + * Descriptive label that is associated with a fleet. Fleet names do not need to be unique. + */ + Name: NonZeroAndMaxString; + /** + * Human-readable description of a fleet. + */ + Description?: NonZeroAndMaxString; + /** + * Unique identifier for a build to be deployed on the new fleet. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + */ + BuildId?: BuildId; + /** + * Unique identifier for a Realtime script to be deployed on the new fleet. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created. + */ + ScriptId?: ScriptId; + /** + * This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.) + */ + ServerLaunchPath?: NonZeroAndMaxString; + /** + * This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.) + */ + ServerLaunchParameters?: NonZeroAndMaxString; + /** + * This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference. + */ + LogPaths?: StringList; + /** + * Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + */ + EC2InstanceType: EC2InstanceType; + /** + * Range of IP addresses and port settings that permit inbound traffic to access game sessions that running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet. + */ + EC2InboundPermissions?: IpPermissionsList; + /** + * Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession. NoProtection -- The game session can be terminated during a scale-down event. FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event. + */ + NewGameSessionProtectionPolicy?: ProtectionPolicy; + /** + * Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The run-time configuration lists the types of server processes to run on an instance and includes the following configuration settings: the server executable or launch script file, launch parameters, and the number of processes to run concurrently on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration. + */ + RuntimeConfiguration?: RuntimeConfiguration; + /** + * Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. + */ + ResourceCreationLimitPolicy?: ResourceCreationLimitPolicy; + /** + * Name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time. + */ + MetricGroups?: MetricGroupList; + /** + * Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings. + */ + PeerVpcAwsAccountId?: NonZeroAndMaxString; + /** + * Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets. + */ + PeerVpcId?: NonZeroAndMaxString; + /** + * Indicates whether to use on-demand instances or spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances. + */ + FleetType?: FleetType; + /** + * Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. + */ + InstanceRoleArn?: NonEmptyString; + } + export interface CreateFleetOutput { + /** + * Properties for the newly created fleet. + */ + FleetAttributes?: FleetAttributes; + } + export interface CreateGameSessionInput { + /** + * Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both. + */ + FleetId?: FleetId; + /** + * Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both. + */ + AliasId?: AliasId; + /** + * Maximum number of players that can be connected simultaneously to the game session. + */ + MaximumPlayerSessionCount: WholeNumber; + /** + * Descriptive label that is associated with a game session. Session names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). + */ + GameProperties?: GamePropertyList; + /** + * Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have. + */ + CreatorId?: NonZeroAndMaxString; + /** + * This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) + */ + GameSessionId?: IdStringModel; + /** + * Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted. + */ + IdempotencyToken?: IdStringModel; + /** + * Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). + */ + GameSessionData?: GameSessionData; + } + export interface CreateGameSessionOutput { + /** + * Object that describes the newly created game session record. + */ + GameSession?: GameSession; + } + export interface CreateGameSessionQueueInput { + /** + * Descriptive label that is associated with game session queue. Queue names must be unique within each region. + */ + Name: GameSessionQueueName; + /** + * Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. + */ + TimeoutInSeconds?: WholeNumber; + /** + * Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail. + */ + PlayerLatencyPolicies?: PlayerLatencyPolicyList; + /** + * List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. + */ + Destinations?: GameSessionQueueDestinationList; + } + export interface CreateGameSessionQueueOutput { + /** + * Object that describes the newly created game session queue. + */ + GameSessionQueue?: GameSessionQueue; + } + export interface CreateMatchmakingConfigurationInput { + /** + * Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket. + */ + Name: MatchmakingIdStringModel; + /** + * Meaningful description of the matchmaking configuration. + */ + Description?: NonZeroAndMaxString; + /** + * Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region. + */ + GameSessionQueueArns: QueueArnsList; + /** + * Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed. + */ + RequestTimeoutSeconds: MatchmakingRequestTimeoutInteger; + /** + * Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match. + */ + AcceptanceTimeoutSeconds?: MatchmakingAcceptanceTimeoutInteger; + /** + * Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. + */ + AcceptanceRequired: BooleanModel; + /** + * Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region. + */ + RuleSetName: MatchmakingIdStringModel; + /** + * SNS topic ARN that is set up to receive matchmaking notifications. + */ + NotificationTarget?: SnsArnStringModel; + /** + * Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. + */ + AdditionalPlayerCount?: WholeNumber; + /** + * Information to attached to all events related to the matchmaking configuration. + */ + CustomEventData?: CustomEventData; + /** + * Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. + */ + GameProperties?: GamePropertyList; + /** + * Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. + */ + GameSessionData?: GameSessionData; + } + export interface CreateMatchmakingConfigurationOutput { + /** + * Object that describes the newly created matchmaking configuration. + */ + Configuration?: MatchmakingConfiguration; + } + export interface CreateMatchmakingRuleSetInput { + /** + * Unique identifier for a matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. (Note: The rule set name is different from the optional "name" field in the rule set body.) + */ + Name: MatchmakingIdStringModel; + /** + * Collection of matchmaking rules, formatted as a JSON string. Note that comments are not allowed in JSON, but most elements support a description field. + */ + RuleSetBody: RuleSetBody; + } + export interface CreateMatchmakingRuleSetOutput { + /** + * Object that describes the newly created matchmaking rule set. + */ + RuleSet: MatchmakingRuleSet; + } + export interface CreatePlayerSessionInput { + /** + * Unique identifier for the game session to add a player to. + */ + GameSessionId: ArnStringModel; + /** + * Unique identifier for a player. Player IDs are developer-defined. + */ + PlayerId: NonZeroAndMaxString; + /** + * Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. + */ + PlayerData?: PlayerData; + } + export interface CreatePlayerSessionOutput { + /** + * Object that describes the newly created player session record. + */ + PlayerSession?: PlayerSession; + } + export interface CreatePlayerSessionsInput { + /** + * Unique identifier for the game session to add players to. + */ + GameSessionId: ArnStringModel; + /** + * List of unique identifiers for the players to be added. + */ + PlayerIds: PlayerIdList; + /** + * Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data strings for player IDs not included in the PlayerIds parameter are ignored. + */ + PlayerDataMap?: PlayerDataMap; + } + export interface CreatePlayerSessionsOutput { + /** + * Collection of player session objects created for the added players. + */ + PlayerSessions?: PlayerSessionList; + } + export interface CreateScriptInput { + /** + * Descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later. + */ + Name?: NonZeroAndMaxString; + /** + * Version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later. + */ + Version?: NonZeroAndMaxString; + /** + * Location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. + */ + StorageLocation?: S3Location; + /** + * Data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip. + */ + ZipFile?: ZipBlob; + } + export interface CreateScriptOutput { + /** + * The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service. + */ + Script?: Script; + } + export interface CreateVpcPeeringAuthorizationInput { + /** + * Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings. + */ + GameLiftAwsAccountId: NonZeroAndMaxString; + /** + * Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets. + */ + PeerVpcId: NonZeroAndMaxString; + } + export interface CreateVpcPeeringAuthorizationOutput { + /** + * Details on the requested VPC peering authorization, including expiration. + */ + VpcPeeringAuthorization?: VpcPeeringAuthorization; + } + export interface CreateVpcPeeringConnectionInput { + /** + * Unique identifier for a fleet. This tells Amazon GameLift which GameLift VPC to peer with. + */ + FleetId: FleetId; + /** + * Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings. + */ + PeerVpcAwsAccountId: NonZeroAndMaxString; + /** + * Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets. + */ + PeerVpcId: NonZeroAndMaxString; + } + export interface CreateVpcPeeringConnectionOutput { + } + export type CustomEventData = string; + export interface DeleteAliasInput { + /** + * Unique identifier for a fleet alias. Specify the alias you want to delete. + */ + AliasId: AliasId; + } + export interface DeleteBuildInput { + /** + * Unique identifier for a build to delete. + */ + BuildId: BuildId; + } + export interface DeleteFleetInput { + /** + * Unique identifier for a fleet to be deleted. + */ + FleetId: FleetId; + } + export interface DeleteGameSessionQueueInput { + /** + * Descriptive label that is associated with game session queue. Queue names must be unique within each region. + */ + Name: GameSessionQueueName; + } + export interface DeleteGameSessionQueueOutput { + } + export interface DeleteMatchmakingConfigurationInput { + /** + * Unique identifier for a matchmaking configuration + */ + Name: MatchmakingIdStringModel; + } + export interface DeleteMatchmakingConfigurationOutput { + } + export interface DeleteMatchmakingRuleSetInput { + /** + * Unique identifier for a matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.) + */ + Name: MatchmakingIdStringModel; + } + export interface DeleteMatchmakingRuleSetOutput { + } + export interface DeleteScalingPolicyInput { + /** + * Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. + */ + Name: NonZeroAndMaxString; + /** + * Unique identifier for a fleet to be deleted. + */ + FleetId: FleetId; + } + export interface DeleteScriptInput { + /** + * Unique identifier for a Realtime script to delete. + */ + ScriptId: ScriptId; + } + export interface DeleteVpcPeeringAuthorizationInput { + /** + * Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings. + */ + GameLiftAwsAccountId: NonZeroAndMaxString; + /** + * Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets. + */ + PeerVpcId: NonZeroAndMaxString; + } + export interface DeleteVpcPeeringAuthorizationOutput { + } + export interface DeleteVpcPeeringConnectionInput { + /** + * Unique identifier for a fleet. This value must match the fleet ID referenced in the VPC peering connection record. + */ + FleetId: FleetId; + /** + * Unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections. + */ + VpcPeeringConnectionId: NonZeroAndMaxString; + } + export interface DeleteVpcPeeringConnectionOutput { + } + export interface DescribeAliasInput { + /** + * Unique identifier for a fleet alias. Specify the alias you want to retrieve. + */ + AliasId: AliasId; + } + export interface DescribeAliasOutput { + /** + * Object that contains the requested alias. + */ + Alias?: Alias; + } + export interface DescribeBuildInput { + /** + * Unique identifier for a build to retrieve properties for. + */ + BuildId: BuildId; + } + export interface DescribeBuildOutput { + /** + * Set of properties describing the requested build. + */ + Build?: Build; + } + export interface DescribeEC2InstanceLimitsInput { + /** + * Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types. + */ + EC2InstanceType?: EC2InstanceType; + } + export interface DescribeEC2InstanceLimitsOutput { + /** + * Object that contains the maximum number of instances for the specified instance type. + */ + EC2InstanceLimits?: EC2InstanceLimitList; + } + export interface DescribeFleetAttributesInput { + /** + * Unique identifier for a fleet(s) to retrieve attributes for. To request attributes for all fleets, leave this parameter empty. + */ + FleetIds?: FleetIdList; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeFleetAttributesOutput { + /** + * Collection of objects containing attribute metadata for each requested fleet ID. + */ + FleetAttributes?: FleetAttributesList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeFleetCapacityInput { + /** + * Unique identifier for a fleet(s) to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty. + */ + FleetIds?: FleetIdList; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeFleetCapacityOutput { + /** + * Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets. + */ + FleetCapacity?: FleetCapacityList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeFleetEventsInput { + /** + * Unique identifier for a fleet to get event logs for. + */ + FleetId: FleetId; + /** + * Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057"). + */ + StartTime?: Timestamp; + /** + * Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057"). + */ + EndTime?: Timestamp; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeFleetEventsOutput { + /** + * Collection of objects containing event log entries for the specified fleet. + */ + Events?: EventList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeFleetPortSettingsInput { + /** + * Unique identifier for a fleet to retrieve port settings for. + */ + FleetId: FleetId; + } + export interface DescribeFleetPortSettingsOutput { + /** + * Object that contains port settings for the requested fleet ID. + */ + InboundPermissions?: IpPermissionsList; + } + export interface DescribeFleetUtilizationInput { + /** + * Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty. + */ + FleetIds?: FleetIdList; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeFleetUtilizationOutput { + /** + * Collection of objects containing utilization information for each requested fleet ID. + */ + FleetUtilization?: FleetUtilizationList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeGameSessionDetailsInput { + /** + * Unique identifier for a fleet to retrieve all game sessions active on the fleet. + */ + FleetId?: FleetId; + /** + * Unique identifier for the game session to retrieve. + */ + GameSessionId?: ArnStringModel; + /** + * Unique identifier for an alias associated with the fleet to retrieve all game sessions for. + */ + AliasId?: AliasId; + /** + * Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory). + */ + StatusFilter?: NonZeroAndMaxString; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeGameSessionDetailsOutput { + /** + * Collection of objects containing game session properties and the protection policy currently in force for each session matching the request. + */ + GameSessionDetails?: GameSessionDetailList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeGameSessionPlacementInput { + /** + * Unique identifier for a game session placement to retrieve. + */ + PlacementId: IdStringModel; + } + export interface DescribeGameSessionPlacementOutput { + /** + * Object that describes the requested game session placement. + */ + GameSessionPlacement?: GameSessionPlacement; + } + export interface DescribeGameSessionQueuesInput { + /** + * List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty. + */ + Names?: GameSessionQueueNameList; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeGameSessionQueuesOutput { + /** + * Collection of objects that describes the requested game session queues. + */ + GameSessionQueues?: GameSessionQueueList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeGameSessionsInput { + /** + * Unique identifier for a fleet to retrieve all game sessions for. + */ + FleetId?: FleetId; + /** + * Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value. + */ + GameSessionId?: ArnStringModel; + /** + * Unique identifier for an alias associated with the fleet to retrieve all game sessions for. + */ + AliasId?: AliasId; + /** + * Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory). + */ + StatusFilter?: NonZeroAndMaxString; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeGameSessionsOutput { + /** + * Collection of objects containing game session properties for each session matching the request. + */ + GameSessions?: GameSessionList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeInstancesInput { + /** + * Unique identifier for a fleet to retrieve instance information for. + */ + FleetId: FleetId; + /** + * Unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet. + */ + InstanceId?: InstanceId; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeInstancesOutput { + /** + * Collection of objects containing properties for each instance returned. + */ + Instances?: InstanceList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeMatchmakingConfigurationsInput { + /** + * Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty. + */ + Names?: MatchmakingIdList; + /** + * Unique identifier for a matchmaking rule set. Use this parameter to retrieve all matchmaking configurations that use this rule set. + */ + RuleSetName?: MatchmakingIdStringModel; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeMatchmakingConfigurationsOutput { + /** + * Collection of requested matchmaking configuration objects. + */ + Configurations?: MatchmakingConfigurationList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeMatchmakingInput { + /** + * Unique identifier for a matchmaking ticket. You can include up to 10 ID values. + */ + TicketIds: MatchmakingIdList; + } + export interface DescribeMatchmakingOutput { + /** + * Collection of existing matchmaking ticket objects matching the request. + */ + TicketList?: MatchmakingTicketList; + } + export interface DescribeMatchmakingRuleSetsInput { + /** + * List of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) + */ + Names?: MatchmakingRuleSetNameList; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: RuleSetLimit; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeMatchmakingRuleSetsOutput { + /** + * Collection of requested matchmaking rule set objects. + */ + RuleSets: MatchmakingRuleSetList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribePlayerSessionsInput { + /** + * Unique identifier for the game session to retrieve player sessions for. + */ + GameSessionId?: ArnStringModel; + /** + * Unique identifier for a player to retrieve player sessions for. + */ + PlayerId?: NonZeroAndMaxString; + /** + * Unique identifier for a player session to retrieve. + */ + PlayerSessionId?: PlayerSessionId; + /** + * Player session status to filter results on. Possible player session statuses include the following: RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. ACTIVE -- The player has been validated by the server process and is currently connected. COMPLETED -- The player connection has been dropped. TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds). + */ + PlayerSessionStatusFilter?: NonZeroAndMaxString; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribePlayerSessionsOutput { + /** + * Collection of objects containing properties for each player session that matches the request. + */ + PlayerSessions?: PlayerSessionList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeRuntimeConfigurationInput { + /** + * Unique identifier for a fleet to get the run-time configuration for. + */ + FleetId: FleetId; + } + export interface DescribeRuntimeConfigurationOutput { + /** + * Instructions describing how server processes should be launched and maintained on each instance in the fleet. + */ + RuntimeConfiguration?: RuntimeConfiguration; + } + export interface DescribeScalingPoliciesInput { + /** + * Unique identifier for a fleet to retrieve scaling policies for. + */ + FleetId: FleetId; + /** + * Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status. ACTIVE -- The scaling policy is currently in force. UPDATEREQUESTED -- A request to update the scaling policy has been received. UPDATING -- A change is being made to the scaling policy. DELETEREQUESTED -- A request to delete the scaling policy has been received. DELETING -- The scaling policy is being deleted. DELETED -- The scaling policy has been deleted. ERROR -- An error occurred in creating the policy. It should be removed and recreated. + */ + StatusFilter?: ScalingStatusType; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeScalingPoliciesOutput { + /** + * Collection of objects containing the scaling policies matching the request. + */ + ScalingPolicies?: ScalingPolicyList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface DescribeScriptInput { + /** + * Unique identifier for a Realtime script to retrieve properties for. + */ + ScriptId: ScriptId; + } + export interface DescribeScriptOutput { + /** + * Set of properties describing the requested script. + */ + Script?: Script; + } + export interface DescribeVpcPeeringAuthorizationsInput { + } + export interface DescribeVpcPeeringAuthorizationsOutput { + /** + * Collection of objects that describe all valid VPC peering operations for the current AWS account. + */ + VpcPeeringAuthorizations?: VpcPeeringAuthorizationList; + } + export interface DescribeVpcPeeringConnectionsInput { + /** + * Unique identifier for a fleet. + */ + FleetId?: FleetId; + } + export interface DescribeVpcPeeringConnectionsOutput { + /** + * Collection of VPC peering connection records that match the request. + */ + VpcPeeringConnections?: VpcPeeringConnectionList; + } + export interface DesiredPlayerSession { + /** + * Unique identifier for a player to associate with the player session. + */ + PlayerId?: NonZeroAndMaxString; + /** + * Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. + */ + PlayerData?: PlayerData; + } + export type DesiredPlayerSessionList = DesiredPlayerSession[]; + export type Double = number; + export type DoubleObject = number; + export interface EC2InstanceCounts { + /** + * Ideal number of active instances in the fleet. + */ + DESIRED?: WholeNumber; + /** + * Minimum value allowed for the fleet's instance count. + */ + MINIMUM?: WholeNumber; + /** + * Maximum value allowed for the fleet's instance count. + */ + MAXIMUM?: WholeNumber; + /** + * Number of instances in the fleet that are starting but not yet active. + */ + PENDING?: WholeNumber; + /** + * Actual number of active instances in the fleet. + */ + ACTIVE?: WholeNumber; + /** + * Number of active instances in the fleet that are not currently hosting a game session. + */ + IDLE?: WholeNumber; + /** + * Number of instances in the fleet that are no longer active but haven't yet been terminated. + */ + TERMINATING?: WholeNumber; + } + export interface EC2InstanceLimit { + /** + * Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + */ + EC2InstanceType?: EC2InstanceType; + /** + * Number of instances of the specified type that are currently in use by this AWS account. + */ + CurrentInstances?: WholeNumber; + /** + * Number of instances allowed. + */ + InstanceLimit?: WholeNumber; + } + export type EC2InstanceLimitList = EC2InstanceLimit[]; + export type EC2InstanceType = "t2.micro"|"t2.small"|"t2.medium"|"t2.large"|"c3.large"|"c3.xlarge"|"c3.2xlarge"|"c3.4xlarge"|"c3.8xlarge"|"c4.large"|"c4.xlarge"|"c4.2xlarge"|"c4.4xlarge"|"c4.8xlarge"|"r3.large"|"r3.xlarge"|"r3.2xlarge"|"r3.4xlarge"|"r3.8xlarge"|"r4.large"|"r4.xlarge"|"r4.2xlarge"|"r4.4xlarge"|"r4.8xlarge"|"r4.16xlarge"|"m3.medium"|"m3.large"|"m3.xlarge"|"m3.2xlarge"|"m4.large"|"m4.xlarge"|"m4.2xlarge"|"m4.4xlarge"|"m4.10xlarge"|string; + export interface Event { + /** + * Unique identifier for a fleet event. + */ + EventId?: NonZeroAndMaxString; + /** + * Unique identifier for an event resource, such as a fleet ID. + */ + ResourceId?: NonZeroAndMaxString; + /** + * Type of event being logged. The following events are currently in use: Fleet creation events: FLEET_CREATED -- A fleet record was successfully created with a status of NEW. Event messaging includes the fleet ID. FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation. FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance. FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl. FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, and the Amazon GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl. FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the Amazon GameLift is now verifying that the game server launch paths, which are specified in the fleet's run-time configuration, exist. If any listed launch path exists, Amazon GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the run-time configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl. FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the run-time configuration failed because the executable specified in a launch path does not exist on the instance. FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the run-time configuration failed because the executable specified in a launch path failed to run on the fleet instance. FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. A possible reason for failure is that the game server is not reporting "process ready" to the Amazon GameLift service. FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions. VPC peering events: FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift fleet and a VPC in your AWS account. FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see DescribeVpcPeeringConnections) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted. Spot instance events: INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification. Other fleet events: FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings. FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting. FLEET_DELETED -- A request to delete a fleet was initiated. GENERIC_EVENT -- An unspecified event has occurred. + */ + EventCode?: EventCode; + /** + * Additional information related to the event. + */ + Message?: NonEmptyString; + /** + * Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + EventTime?: Timestamp; + /** + * Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console. + */ + PreSignedLogUrl?: NonZeroAndMaxString; + } + export type EventCode = "GENERIC_EVENT"|"FLEET_CREATED"|"FLEET_DELETED"|"FLEET_SCALING_EVENT"|"FLEET_STATE_DOWNLOADING"|"FLEET_STATE_VALIDATING"|"FLEET_STATE_BUILDING"|"FLEET_STATE_ACTIVATING"|"FLEET_STATE_ACTIVE"|"FLEET_STATE_ERROR"|"FLEET_INITIALIZATION_FAILED"|"FLEET_BINARY_DOWNLOAD_FAILED"|"FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND"|"FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE"|"FLEET_VALIDATION_TIMED_OUT"|"FLEET_ACTIVATION_FAILED"|"FLEET_ACTIVATION_FAILED_NO_INSTANCES"|"FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED"|"SERVER_PROCESS_INVALID_PATH"|"SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT"|"SERVER_PROCESS_PROCESS_READY_TIMEOUT"|"SERVER_PROCESS_CRASHED"|"SERVER_PROCESS_TERMINATED_UNHEALTHY"|"SERVER_PROCESS_FORCE_TERMINATED"|"SERVER_PROCESS_PROCESS_EXIT_TIMEOUT"|"GAME_SESSION_ACTIVATION_TIMEOUT"|"FLEET_CREATION_EXTRACTING_BUILD"|"FLEET_CREATION_RUNNING_INSTALLER"|"FLEET_CREATION_VALIDATING_RUNTIME_CONFIG"|"FLEET_VPC_PEERING_SUCCEEDED"|"FLEET_VPC_PEERING_FAILED"|"FLEET_VPC_PEERING_DELETED"|"INSTANCE_INTERRUPTED"|string; + export type EventList = Event[]; + export type FleetAction = "AUTO_SCALING"|string; + export type FleetActionList = FleetAction[]; + export interface FleetAttributes { + /** + * Unique identifier for a fleet. + */ + FleetId?: FleetId; + /** + * Identifier for a fleet that is unique across all regions. + */ + FleetArn?: ArnStringModel; + /** + * Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification. + */ + FleetType?: FleetType; + /** + * EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions. + */ + InstanceType?: EC2InstanceType; + /** + * Human-readable description of the fleet. + */ + Description?: NonZeroAndMaxString; + /** + * Descriptive label that is associated with a fleet. Fleet names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + /** + * Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + TerminationTime?: Timestamp; + /** + * Current status of the fleet. Possible fleet statuses include the following: NEW -- A new fleet has been defined and desired instances is set to 1. DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes. ACTIVE -- Hosts can now accept game sessions. ERROR -- An error occurred when downloading, validating, building, or activating the fleet. DELETING -- Hosts are responding to a delete fleet request. TERMINATED -- The fleet no longer exists. + */ + Status?: FleetStatus; + /** + * Unique identifier for a build. + */ + BuildId?: BuildId; + /** + * Unique identifier for a Realtime script. + */ + ScriptId?: ScriptId; + /** + * Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration. + */ + ServerLaunchPath?: NonZeroAndMaxString; + /** + * Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration. + */ + ServerLaunchParameters?: NonZeroAndMaxString; + /** + * Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs. + */ + LogPaths?: StringList; + /** + * Type of game session protection to set for all new instances started in the fleet. NoProtection -- The game session can be terminated during a scale-down event. FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event. + */ + NewGameSessionProtectionPolicy?: ProtectionPolicy; + /** + * Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet. + */ + OperatingSystem?: OperatingSystem; + /** + * Fleet policy to limit the number of game sessions an individual player can create over a span of time. + */ + ResourceCreationLimitPolicy?: ResourceCreationLimitPolicy; + /** + * Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time. + */ + MetricGroups?: MetricGroupList; + /** + * List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling. + */ + StoppedActions?: FleetActionList; + /** + * Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. + */ + InstanceRoleArn?: NonEmptyString; + } + export type FleetAttributesList = FleetAttributes[]; + export interface FleetCapacity { + /** + * Unique identifier for a fleet. + */ + FleetId?: FleetId; + /** + * Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + */ + InstanceType?: EC2InstanceType; + /** + * Current status of fleet capacity. + */ + InstanceCounts?: EC2InstanceCounts; + } + export type FleetCapacityList = FleetCapacity[]; + export type FleetId = string; + export type FleetIdList = FleetId[]; + export type FleetStatus = "NEW"|"DOWNLOADING"|"VALIDATING"|"BUILDING"|"ACTIVATING"|"ACTIVE"|"DELETING"|"ERROR"|"TERMINATED"|string; + export type FleetType = "ON_DEMAND"|"SPOT"|string; + export interface FleetUtilization { + /** + * Unique identifier for a fleet. + */ + FleetId?: FleetId; + /** + * Number of server processes in an ACTIVE status currently running across all instances in the fleet + */ + ActiveServerProcessCount?: WholeNumber; + /** + * Number of active game sessions currently being hosted on all instances in the fleet. + */ + ActiveGameSessionCount?: WholeNumber; + /** + * Number of active player sessions currently being hosted on all instances in the fleet. + */ + CurrentPlayerSessionCount?: WholeNumber; + /** + * Maximum players allowed across all game sessions currently being hosted on all instances in the fleet. + */ + MaximumPlayerSessionCount?: WholeNumber; + } + export type FleetUtilizationList = FleetUtilization[]; + export type Float = number; + export type FreeText = string; + export interface GameProperty { + /** + * Game property identifier. + */ + Key: GamePropertyKey; + /** + * Game property value. + */ + Value: GamePropertyValue; + } + export type GamePropertyKey = string; + export type GamePropertyList = GameProperty[]; + export type GamePropertyValue = string; + export interface GameSession { + /** + * Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>. + */ + GameSessionId?: NonZeroAndMaxString; + /** + * Descriptive label that is associated with a game session. Session names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Unique identifier for a fleet that the game session is running on. + */ + FleetId?: FleetId; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + /** + * Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + TerminationTime?: Timestamp; + /** + * Number of players currently in the game session. + */ + CurrentPlayerSessionCount?: WholeNumber; + /** + * Maximum number of players that can be connected simultaneously to the game session. + */ + MaximumPlayerSessionCount?: WholeNumber; + /** + * Current status of the game session. A game session must have an ACTIVE status to have player sessions. + */ + Status?: GameSessionStatus; + /** + * Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated. + */ + StatusReason?: GameSessionStatusReason; + /** + * Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions. + */ + GameProperties?: GamePropertyList; + /** + * IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. + */ + IpAddress?: IpAddress; + /** + * Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. + */ + Port?: PortNumber; + /** + * Indicates whether or not the game session is accepting new players. + */ + PlayerSessionCreationPolicy?: PlayerSessionCreationPolicy; + /** + * Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create. + */ + CreatorId?: NonZeroAndMaxString; + /** + * Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). + */ + GameSessionData?: GameSessionData; + /** + * Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill). + */ + MatchmakerData?: MatchmakerData; + } + export type GameSessionActivationTimeoutSeconds = number; + export interface GameSessionConnectionInfo { + /** + * Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it. + */ + GameSessionArn?: ArnStringModel; + /** + * IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. + */ + IpAddress?: StringModel; + /** + * Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. + */ + Port?: PositiveInteger; + /** + * Collection of player session IDs, one for each player ID that was included in the original matchmaking request. + */ + MatchedPlayerSessions?: MatchedPlayerSessionList; + } + export type GameSessionData = string; + export interface GameSessionDetail { + /** + * Object that describes a game session. + */ + GameSession?: GameSession; + /** + * Current status of protection for the game session. NoProtection -- The game session can be terminated during a scale-down event. FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event. + */ + ProtectionPolicy?: ProtectionPolicy; + } + export type GameSessionDetailList = GameSessionDetail[]; + export type GameSessionList = GameSession[]; + export interface GameSessionPlacement { + /** + * Unique identifier for a game session placement. + */ + PlacementId?: IdStringModel; + /** + * Descriptive label that is associated with game session queue. Queue names must be unique within each region. + */ + GameSessionQueueName?: GameSessionQueueName; + /** + * Current status of the game session placement request. PENDING -- The placement request is currently in the queue waiting to be processed. FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available. CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement. TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed. + */ + Status?: GameSessionPlacementState; + /** + * Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). + */ + GameProperties?: GamePropertyList; + /** + * Maximum number of players that can be connected simultaneously to the game session. + */ + MaximumPlayerSessionCount?: WholeNumber; + /** + * Descriptive label that is associated with a game session. Session names do not need to be unique. + */ + GameSessionName?: NonZeroAndMaxString; + /** + * Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED). + */ + GameSessionId?: NonZeroAndMaxString; + /** + * Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed. + */ + GameSessionArn?: NonZeroAndMaxString; + /** + * Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED). + */ + GameSessionRegion?: NonZeroAndMaxString; + /** + * Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. + */ + PlayerLatencies?: PlayerLatencyList; + /** + * Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + StartTime?: Timestamp; + /** + * Time stamp indicating when this request was completed, canceled, or timed out. + */ + EndTime?: Timestamp; + /** + * IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED). + */ + IpAddress?: IpAddress; + /** + * Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED). + */ + Port?: PortNumber; + /** + * Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID. + */ + PlacedPlayerSessions?: PlacedPlayerSessionList; + /** + * Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). + */ + GameSessionData?: GameSessionData; + /** + * Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. + */ + MatchmakerData?: MatchmakerData; + } + export type GameSessionPlacementState = "PENDING"|"FULFILLED"|"CANCELLED"|"TIMED_OUT"|string; + export interface GameSessionQueue { + /** + * Descriptive label that is associated with game session queue. Queue names must be unique within each region. + */ + Name?: GameSessionQueueName; + /** + * Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + */ + GameSessionQueueArn?: ArnStringModel; + /** + * Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. + */ + TimeoutInSeconds?: WholeNumber; + /** + * Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. + */ + PlayerLatencyPolicies?: PlayerLatencyPolicyList; + /** + * List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. + */ + Destinations?: GameSessionQueueDestinationList; + } + export interface GameSessionQueueDestination { + /** + * Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions. + */ + DestinationArn?: ArnStringModel; + } + export type GameSessionQueueDestinationList = GameSessionQueueDestination[]; + export type GameSessionQueueList = GameSessionQueue[]; + export type GameSessionQueueName = string; + export type GameSessionQueueNameList = GameSessionQueueName[]; + export type GameSessionStatus = "ACTIVE"|"ACTIVATING"|"TERMINATED"|"TERMINATING"|"ERROR"|string; + export type GameSessionStatusReason = "INTERRUPTED"|string; + export interface GetGameSessionLogUrlInput { + /** + * Unique identifier for the game session to get logs for. + */ + GameSessionId: ArnStringModel; + } + export interface GetGameSessionLogUrlOutput { + /** + * Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained. + */ + PreSignedUrl?: NonZeroAndMaxString; + } + export interface GetInstanceAccessInput { + /** + * Unique identifier for a fleet that contains the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted. + */ + FleetId: FleetId; + /** + * Unique identifier for an instance you want to get access to. You can access an instance in any status. + */ + InstanceId: InstanceId; + } + export interface GetInstanceAccessOutput { + /** + * Object that contains connection information for a fleet instance, including IP address and access credentials. + */ + InstanceAccess?: InstanceAccess; + } + export type IdStringModel = string; + export interface Instance { + /** + * Unique identifier for a fleet that the instance is in. + */ + FleetId?: FleetId; + /** + * Unique identifier for an instance. + */ + InstanceId?: InstanceId; + /** + * IP address assigned to the instance. + */ + IpAddress?: IpAddress; + /** + * Operating system that is running on this instance. + */ + OperatingSystem?: OperatingSystem; + /** + * EC2 instance type that defines the computing resources of this instance. + */ + Type?: EC2InstanceType; + /** + * Current status of the instance. Possible statuses include the following: PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration. ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions. TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem. + */ + Status?: InstanceStatus; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + } + export interface InstanceAccess { + /** + * Unique identifier for a fleet containing the instance being accessed. + */ + FleetId?: FleetId; + /** + * Unique identifier for an instance being accessed. + */ + InstanceId?: InstanceId; + /** + * IP address assigned to the instance. + */ + IpAddress?: IpAddress; + /** + * Operating system that is running on the instance. + */ + OperatingSystem?: OperatingSystem; + /** + * Credentials required to access the instance. + */ + Credentials?: InstanceCredentials; + } + export interface InstanceCredentials { + /** + * User login string. + */ + UserName?: NonEmptyString; + /** + * Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux instances, it is a private key (which must be saved as a .pem file) for use with SSH. + */ + Secret?: NonEmptyString; + } + export type InstanceId = string; + export type InstanceList = Instance[]; + export type InstanceStatus = "PENDING"|"ACTIVE"|"TERMINATING"|string; + export type Integer = number; + export type IpAddress = string; + export interface IpPermission { + /** + * Starting value for a range of allowed port numbers. + */ + FromPort: PortNumber; + /** + * Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. + */ + ToPort: PortNumber; + /** + * Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]". + */ + IpRange: NonBlankString; + /** + * Network communication protocol used by the fleet. + */ + Protocol: IpProtocol; + } + export type IpPermissionsList = IpPermission[]; + export type IpProtocol = "TCP"|"UDP"|string; + export type LatencyMap = {[key: string]: PositiveInteger}; + export interface ListAliasesInput { + /** + * Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include the following: SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets. TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded. + */ + RoutingStrategyType?: RoutingStrategyType; + /** + * Descriptive label that is associated with an alias. Alias names do not need to be unique. + */ + Name?: NonEmptyString; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonEmptyString; + } + export interface ListAliasesOutput { + /** + * Collection of alias records that match the list request. + */ + Aliases?: AliasList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonEmptyString; + } + export interface ListBuildsInput { + /** + * Build status to filter results by. To retrieve all builds, leave this parameter empty. Possible build statuses include the following: INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value. READY -- The game build has been successfully uploaded. You can now create new fleets for this build. FAILED -- The game build upload failed. You cannot create new fleets for this build. + */ + Status?: BuildStatus; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonEmptyString; + } + export interface ListBuildsOutput { + /** + * Collection of build records that match the request. + */ + Builds?: BuildList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonEmptyString; + } + export interface ListFleetsInput { + /** + * Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty. + */ + BuildId?: BuildId; + /** + * Unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using the specified script. To retrieve all fleets, leave this parameter empty. + */ + ScriptId?: ScriptId; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface ListFleetsOutput { + /** + * Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization. + */ + FleetIds?: FleetIdList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface ListScriptsInput { + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonEmptyString; + } + export interface ListScriptsOutput { + /** + * Set of properties describing the requested script. + */ + Scripts?: ScriptList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonEmptyString; + } + export interface MatchedPlayerSession { + /** + * Unique identifier for a player + */ + PlayerId?: NonZeroAndMaxString; + /** + * Unique identifier for a player session + */ + PlayerSessionId?: PlayerSessionId; + } + export type MatchedPlayerSessionList = MatchedPlayerSession[]; + export type MatchmakerData = string; + export type MatchmakingAcceptanceTimeoutInteger = number; + export interface MatchmakingConfiguration { + /** + * Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket. + */ + Name?: MatchmakingIdStringModel; + /** + * Descriptive label that is associated with matchmaking configuration. + */ + Description?: NonZeroAndMaxString; + /** + * Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region. + */ + GameSessionQueueArns?: QueueArnsList; + /** + * Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed. + */ + RequestTimeoutSeconds?: MatchmakingRequestTimeoutInteger; + /** + * Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match. + */ + AcceptanceTimeoutSeconds?: MatchmakingAcceptanceTimeoutInteger; + /** + * Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. + */ + AcceptanceRequired?: BooleanModel; + /** + * Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region. + */ + RuleSetName?: MatchmakingIdStringModel; + /** + * SNS topic ARN that is set up to receive matchmaking notifications. + */ + NotificationTarget?: SnsArnStringModel; + /** + * Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. + */ + AdditionalPlayerCount?: WholeNumber; + /** + * Information to attached to all events related to the matchmaking configuration. + */ + CustomEventData?: CustomEventData; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + /** + * Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. + */ + GameProperties?: GamePropertyList; + /** + * Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. + */ + GameSessionData?: GameSessionData; + } + export type MatchmakingConfigurationList = MatchmakingConfiguration[]; + export type MatchmakingConfigurationStatus = "CANCELLED"|"COMPLETED"|"FAILED"|"PLACING"|"QUEUED"|"REQUIRES_ACCEPTANCE"|"SEARCHING"|"TIMED_OUT"|string; + export type MatchmakingIdList = MatchmakingIdStringModel[]; + export type MatchmakingIdStringModel = string; + export type MatchmakingRequestTimeoutInteger = number; + export interface MatchmakingRuleSet { + /** + * Unique identifier for a matchmaking rule set + */ + RuleSetName?: MatchmakingIdStringModel; + /** + * Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.) + */ + RuleSetBody: RuleSetBody; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + } + export type MatchmakingRuleSetList = MatchmakingRuleSet[]; + export type MatchmakingRuleSetNameList = MatchmakingIdStringModel[]; + export interface MatchmakingTicket { + /** + * Unique identifier for a matchmaking ticket. + */ + TicketId?: MatchmakingIdStringModel; + /** + * Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match. + */ + ConfigurationName?: MatchmakingIdStringModel; + /** + * Current status of the matchmaking request. QUEUED -- The matchmaking request has been received and is currently waiting to be processed. SEARCHING -- The matchmaking request is currently being processed. REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement. PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match. COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players. FAILED -- The matchmaking request was not completed. Tickets with players who fail to accept a proposed match are placed in FAILED status. CANCELLED -- The matchmaking request was canceled with a call to StopMatchmaking. TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration. Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs. + */ + Status?: MatchmakingConfigurationStatus; + /** + * Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances. + */ + StatusReason?: StringModel; + /** + * Additional information about the current status. + */ + StatusMessage?: StringModel; + /** + * Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + StartTime?: Timestamp; + /** + * Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + EndTime?: Timestamp; + /** + * A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match. + */ + Players?: PlayerList; + /** + * Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed. + */ + GameSessionConnectionInfo?: GameSessionConnectionInfo; + /** + * Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty. + */ + EstimatedWaitTime?: WholeNumber; + } + export type MatchmakingTicketList = MatchmakingTicket[]; + export type MaxConcurrentGameSessionActivations = number; + export type MetricGroup = string; + export type MetricGroupList = MetricGroup[]; + export type MetricName = "ActivatingGameSessions"|"ActiveGameSessions"|"ActiveInstances"|"AvailableGameSessions"|"AvailablePlayerSessions"|"CurrentPlayerSessions"|"IdleInstances"|"PercentAvailableGameSessions"|"PercentIdleInstances"|"QueueDepth"|"WaitTime"|string; + export type NonBlankAndLengthConstraintString = string; + export type NonBlankString = string; + export type NonEmptyString = string; + export type NonZeroAndMaxString = string; + export type OperatingSystem = "WINDOWS_2012"|"AMAZON_LINUX"|string; + export interface PlacedPlayerSession { + /** + * Unique identifier for a player that is associated with this player session. + */ + PlayerId?: NonZeroAndMaxString; + /** + * Unique identifier for a player session. + */ + PlayerSessionId?: PlayerSessionId; + } + export type PlacedPlayerSessionList = PlacedPlayerSession[]; + export interface Player { + /** + * Unique identifier for a player + */ + PlayerId?: NonZeroAndMaxString; + /** + * Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}. + */ + PlayerAttributes?: PlayerAttributeMap; + /** + * Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set. + */ + Team?: NonZeroAndMaxString; + /** + * Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported. If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable. + */ + LatencyInMs?: LatencyMap; + } + export type PlayerAttributeMap = {[key: string]: AttributeValue}; + export type PlayerData = string; + export type PlayerDataMap = {[key: string]: PlayerData}; + export type PlayerIdList = NonZeroAndMaxString[]; + export interface PlayerLatency { + /** + * Unique identifier for a player associated with the latency data. + */ + PlayerId?: NonZeroAndMaxString; + /** + * Name of the region that is associated with the latency value. + */ + RegionIdentifier?: NonZeroAndMaxString; + /** + * Amount of time that represents the time lag experienced by the player when connected to the specified region. + */ + LatencyInMilliseconds?: Float; + } + export type PlayerLatencyList = PlayerLatency[]; + export interface PlayerLatencyPolicy { + /** + * The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property. + */ + MaximumIndividualPlayerLatencyMilliseconds?: WholeNumber; + /** + * The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out. + */ + PolicyDurationSeconds?: WholeNumber; + } + export type PlayerLatencyPolicyList = PlayerLatencyPolicy[]; + export type PlayerList = Player[]; + export interface PlayerSession { + /** + * Unique identifier for a player session. + */ + PlayerSessionId?: PlayerSessionId; + /** + * Unique identifier for a player that is associated with this player session. + */ + PlayerId?: NonZeroAndMaxString; + /** + * Unique identifier for the game session that the player session is connected to. + */ + GameSessionId?: NonZeroAndMaxString; + /** + * Unique identifier for a fleet that the player's game session is running on. + */ + FleetId?: FleetId; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + /** + * Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + TerminationTime?: Timestamp; + /** + * Current status of the player session. Possible player session statuses include the following: RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. ACTIVE -- The player has been validated by the server process and is currently connected. COMPLETED -- The player connection has been dropped. TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds). + */ + Status?: PlayerSessionStatus; + /** + * IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. + */ + IpAddress?: IpAddress; + /** + * Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number. + */ + Port?: PortNumber; + /** + * Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. + */ + PlayerData?: PlayerData; + } + export type PlayerSessionCreationPolicy = "ACCEPT_ALL"|"DENY_ALL"|string; + export type PlayerSessionId = string; + export type PlayerSessionList = PlayerSession[]; + export type PlayerSessionStatus = "RESERVED"|"ACTIVE"|"COMPLETED"|"TIMEDOUT"|string; + export type PolicyType = "RuleBased"|"TargetBased"|string; + export type PortNumber = number; + export type PositiveInteger = number; + export type PositiveLong = number; + export type ProtectionPolicy = "NoProtection"|"FullProtection"|string; + export interface PutScalingPolicyInput { + /** + * Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name. + */ + Name: NonZeroAndMaxString; + /** + * Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING. + */ + FleetId: FleetId; + /** + * Amount of adjustment to make, based on the scaling adjustment type. + */ + ScalingAdjustment?: Integer; + /** + * Type of adjustment to make to a fleet's instance count (see FleetCapacity): ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down. ExactCapacity -- set the instance count to the scaling adjustment value. PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%. + */ + ScalingAdjustmentType?: ScalingAdjustmentType; + /** + * Metric value used to trigger a scaling event. + */ + Threshold?: Double; + /** + * Comparison operator to use when measuring the metric against the threshold value. + */ + ComparisonOperator?: ComparisonOperatorType; + /** + * Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. + */ + EvaluationPeriods?: PositiveInteger; + /** + * Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch. ActivatingGameSessions -- Game sessions in the process of being created. ActiveGameSessions -- Game sessions that are currently running. ActiveInstances -- Fleet instances that are currently running at least one game session. AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity. AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included. CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player. IdleInstances -- Active instances that are currently hosting zero game sessions. PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy. PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions. QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination. WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. + */ + MetricName: MetricName; + /** + * Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment. + */ + PolicyType?: PolicyType; + /** + * Object that contains settings for a target-based scaling policy. + */ + TargetConfiguration?: TargetConfiguration; + } + export interface PutScalingPolicyOutput { + /** + * Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + } + export type QueueArnsList = ArnStringModel[]; + export interface RequestUploadCredentialsInput { + /** + * Unique identifier for a build to get credentials for. + */ + BuildId: BuildId; + } + export interface RequestUploadCredentialsOutput { + /** + * AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for. + */ + UploadCredentials?: AwsCredentials; + /** + * Amazon S3 path and key, identifying where the game build files are stored. + */ + StorageLocation?: S3Location; + } + export interface ResolveAliasInput { + /** + * Unique identifier for the alias you want to resolve. + */ + AliasId: AliasId; + } + export interface ResolveAliasOutput { + /** + * Fleet identifier that is associated with the requested alias. + */ + FleetId?: FleetId; + } + export interface ResourceCreationLimitPolicy { + /** + * Maximum number of game sessions that an individual can create during the policy period. + */ + NewGameSessionsPerCreator?: WholeNumber; + /** + * Time span used in evaluating the resource creation limit policy. + */ + PolicyPeriodInMinutes?: WholeNumber; + } + export interface RoutingStrategy { + /** + * Type of routing strategy. Possible routing types include the following: SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets. TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded. + */ + Type?: RoutingStrategyType; + /** + * Unique identifier for a fleet that the alias points to. + */ + FleetId?: FleetId; + /** + * Message text to be used with a terminal routing strategy. + */ + Message?: FreeText; + } + export type RoutingStrategyType = "SIMPLE"|"TERMINAL"|string; + export type RuleSetBody = string; + export type RuleSetLimit = number; + export interface RuntimeConfiguration { + /** + * Collection of server process configurations that describe which server processes to run on each instance in a fleet. + */ + ServerProcesses?: ServerProcessList; + /** + * Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time. + */ + MaxConcurrentGameSessionActivations?: MaxConcurrentGameSessionActivations; + /** + * Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED. + */ + GameSessionActivationTimeoutSeconds?: GameSessionActivationTimeoutSeconds; + } + export interface S3Location { + /** + * Amazon S3 bucket identifier. This is the name of the S3 bucket. + */ + Bucket?: NonEmptyString; + /** + * Name of the zip file containing the build files or script files. + */ + Key?: NonEmptyString; + /** + * Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket. + */ + RoleArn?: NonEmptyString; + /** + * Version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file; if not set, the latest version of the file is retrieved. + */ + ObjectVersion?: NonEmptyString; + } + export type ScalingAdjustmentType = "ChangeInCapacity"|"ExactCapacity"|"PercentChangeInCapacity"|string; + export interface ScalingPolicy { + /** + * Unique identifier for a fleet that is associated with this scaling policy. + */ + FleetId?: FleetId; + /** + * Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity. ACTIVE -- The scaling policy can be used for auto-scaling a fleet. UPDATE_REQUESTED -- A request to update the scaling policy has been received. UPDATING -- A change is being made to the scaling policy. DELETE_REQUESTED -- A request to delete the scaling policy has been received. DELETING -- The scaling policy is being deleted. DELETED -- The scaling policy has been deleted. ERROR -- An error occurred in creating the policy. It should be removed and recreated. + */ + Status?: ScalingStatusType; + /** + * Amount of adjustment to make, based on the scaling adjustment type. + */ + ScalingAdjustment?: Integer; + /** + * Type of adjustment to make to a fleet's instance count (see FleetCapacity): ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down. ExactCapacity -- set the instance count to the scaling adjustment value. PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down. + */ + ScalingAdjustmentType?: ScalingAdjustmentType; + /** + * Comparison operator to use when measuring a metric against the threshold value. + */ + ComparisonOperator?: ComparisonOperatorType; + /** + * Metric value used to trigger a scaling event. + */ + Threshold?: Double; + /** + * Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. + */ + EvaluationPeriods?: PositiveInteger; + /** + * Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch. ActivatingGameSessions -- Game sessions in the process of being created. ActiveGameSessions -- Game sessions that are currently running. ActiveInstances -- Fleet instances that are currently running at least one game session. AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity. AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included. CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player. IdleInstances -- Active instances that are currently hosting zero game sessions. PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy. PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions. QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination. WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. + */ + MetricName?: MetricName; + /** + * Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment. + */ + PolicyType?: PolicyType; + /** + * Object that contains settings for a target-based scaling policy. + */ + TargetConfiguration?: TargetConfiguration; + } + export type ScalingPolicyList = ScalingPolicy[]; + export type ScalingStatusType = "ACTIVE"|"UPDATE_REQUESTED"|"UPDATING"|"DELETE_REQUESTED"|"DELETING"|"DELETED"|"ERROR"|string; + export interface Script { + /** + * Unique identifier for a Realtime script + */ + ScriptId?: ScriptId; + /** + * Descriptive label that is associated with a script. Script names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Version that is associated with a build or script. Version strings do not need to be unique. + */ + Version?: NonZeroAndMaxString; + /** + * File size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0". + */ + SizeOnDisk?: PositiveLong; + /** + * Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + StorageLocation?: S3Location; + } + export type ScriptId = string; + export type ScriptList = Script[]; + export interface SearchGameSessionsInput { + /** + * Unique identifier for a fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both. + */ + FleetId?: FleetId; + /** + * Unique identifier for an alias associated with the fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both. + */ + AliasId?: AliasId; + /** + * String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status. A filter expression can contain one or multiple conditions. Each condition consists of the following: Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions. Comparator -- Valid comparators are: =, <>, <, >, <=, >=. Value -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: "FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'". To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y). Session search evaluates conditions from left to right using the following precedence rules: =, <>, <, >, <=, >= Parentheses NOT AND OR For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true". + */ + FilterExpression?: NonZeroAndMaxString; + /** + * Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements: Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions. Order -- Valid sort orders are ASC (ascending) and DESC (descending). For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list. + */ + SortExpression?: NonZeroAndMaxString; + /** + * Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20. + */ + Limit?: PositiveInteger; + /** + * Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. + */ + NextToken?: NonZeroAndMaxString; + } + export interface SearchGameSessionsOutput { + /** + * Collection of objects containing game session properties for each session matching the request. + */ + GameSessions?: GameSessionList; + /** + * Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list. + */ + NextToken?: NonZeroAndMaxString; + } + export interface ServerProcess { + /** + * Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root: Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" + */ + LaunchPath: NonZeroAndMaxString; + /** + * Optional list of parameters to pass to the server executable or Realtime script on launch. + */ + Parameters?: NonZeroAndMaxString; + /** + * Number of server processes using this configuration to run concurrently on an instance. + */ + ConcurrentExecutions: PositiveInteger; + } + export type ServerProcessList = ServerProcess[]; + export type SnsArnStringModel = string; + export interface StartFleetActionsInput { + /** + * Unique identifier for a fleet + */ + FleetId: FleetId; + /** + * List of actions to restart on the fleet. + */ + Actions: FleetActionList; + } + export interface StartFleetActionsOutput { + } + export interface StartGameSessionPlacementInput { + /** + * Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request. + */ + PlacementId: IdStringModel; + /** + * Name of the queue to use to place the new game session. + */ + GameSessionQueueName: GameSessionQueueName; + /** + * Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). + */ + GameProperties?: GamePropertyList; + /** + * Maximum number of players that can be connected simultaneously to the game session. + */ + MaximumPlayerSessionCount: WholeNumber; + /** + * Descriptive label that is associated with a game session. Session names do not need to be unique. + */ + GameSessionName?: NonZeroAndMaxString; + /** + * Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. + */ + PlayerLatencies?: PlayerLatencyList; + /** + * Set of information on each player to create a player session for. + */ + DesiredPlayerSessions?: DesiredPlayerSessionList; + /** + * Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). + */ + GameSessionData?: GameSessionData; + } + export interface StartGameSessionPlacementOutput { + /** + * Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status. + */ + GameSessionPlacement?: GameSessionPlacement; + } + export interface StartMatchBackfillInput { + /** + * Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results. + */ + TicketId?: MatchmakingIdStringModel; + /** + * Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4", the matchmaking configuration name is "MM-4v4".) Use only the name for this parameter. + */ + ConfigurationName: MatchmakingIdStringModel; + /** + * Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it. + */ + GameSessionArn: ArnStringModel; + /** + * Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game. PlayerID, PlayerAttributes, Team -\\- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data. LatencyInMs -\\- If the matchmaker uses player latency, include a latency value, in milliseconds, for the region that the game session is currently in. Do not include latency values for any other region. + */ + Players: PlayerList; + } + export interface StartMatchBackfillOutput { + /** + * Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process. + */ + MatchmakingTicket?: MatchmakingTicket; + } + export interface StartMatchmakingInput { + /** + * Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results. + */ + TicketId?: MatchmakingIdStringModel; + /** + * Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request. + */ + ConfigurationName: MatchmakingIdStringModel; + /** + * Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to. + */ + Players: PlayerList; + } + export interface StartMatchmakingOutput { + /** + * Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process. + */ + MatchmakingTicket?: MatchmakingTicket; + } + export interface StopFleetActionsInput { + /** + * Unique identifier for a fleet + */ + FleetId: FleetId; + /** + * List of actions to suspend on the fleet. + */ + Actions: FleetActionList; + } + export interface StopFleetActionsOutput { + } + export interface StopGameSessionPlacementInput { + /** + * Unique identifier for a game session placement to cancel. + */ + PlacementId: IdStringModel; + } + export interface StopGameSessionPlacementOutput { + /** + * Object that describes the canceled game session placement, with CANCELLED status and an end time stamp. + */ + GameSessionPlacement?: GameSessionPlacement; + } + export interface StopMatchmakingInput { + /** + * Unique identifier for a matchmaking ticket. + */ + TicketId: MatchmakingIdStringModel; + } + export interface StopMatchmakingOutput { + } + export type StringDoubleMap = {[key: string]: DoubleObject}; + export type StringList = NonZeroAndMaxString[]; + export type StringModel = string; + export interface TargetConfiguration { + /** + * Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). + */ + TargetValue: Double; + } + export type Timestamp = Date; + export interface UpdateAliasInput { + /** + * Unique identifier for a fleet alias. Specify the alias you want to update. + */ + AliasId: AliasId; + /** + * Descriptive label that is associated with an alias. Alias names do not need to be unique. + */ + Name?: NonBlankAndLengthConstraintString; + /** + * Human-readable description of an alias. + */ + Description?: NonZeroAndMaxString; + /** + * Object that specifies the fleet and routing type to use for the alias. + */ + RoutingStrategy?: RoutingStrategy; + } + export interface UpdateAliasOutput { + /** + * Object that contains the updated alias configuration. + */ + Alias?: Alias; + } + export interface UpdateBuildInput { + /** + * Unique identifier for a build to update. + */ + BuildId: BuildId; + /** + * Descriptive label that is associated with a build. Build names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Version that is associated with a build or script. Version strings do not need to be unique. + */ + Version?: NonZeroAndMaxString; + } + export interface UpdateBuildOutput { + /** + * Object that contains the updated build record. + */ + Build?: Build; + } + export interface UpdateFleetAttributesInput { + /** + * Unique identifier for a fleet to update attribute metadata for. + */ + FleetId: FleetId; + /** + * Descriptive label that is associated with a fleet. Fleet names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Human-readable description of a fleet. + */ + Description?: NonZeroAndMaxString; + /** + * Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession. NoProtection -- The game session can be terminated during a scale-down event. FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event. + */ + NewGameSessionProtectionPolicy?: ProtectionPolicy; + /** + * Policy that limits the number of game sessions an individual player can create over a span of time. + */ + ResourceCreationLimitPolicy?: ResourceCreationLimitPolicy; + /** + * Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time. + */ + MetricGroups?: MetricGroupList; + } + export interface UpdateFleetAttributesOutput { + /** + * Unique identifier for a fleet that was updated. + */ + FleetId?: FleetId; + } + export interface UpdateFleetCapacityInput { + /** + * Unique identifier for a fleet to update capacity for. + */ + FleetId: FleetId; + /** + * Number of EC2 instances you want this fleet to host. + */ + DesiredInstances?: WholeNumber; + /** + * Minimum value allowed for the fleet's instance count. Default if not set is 0. + */ + MinSize?: WholeNumber; + /** + * Maximum value allowed for the fleet's instance count. Default if not set is 1. + */ + MaxSize?: WholeNumber; + } + export interface UpdateFleetCapacityOutput { + /** + * Unique identifier for a fleet that was updated. + */ + FleetId?: FleetId; + } + export interface UpdateFleetPortSettingsInput { + /** + * Unique identifier for a fleet to update port settings for. + */ + FleetId: FleetId; + /** + * Collection of port settings to be added to the fleet record. + */ + InboundPermissionAuthorizations?: IpPermissionsList; + /** + * Collection of port settings to be removed from the fleet record. + */ + InboundPermissionRevocations?: IpPermissionsList; + } + export interface UpdateFleetPortSettingsOutput { + /** + * Unique identifier for a fleet that was updated. + */ + FleetId?: FleetId; + } + export interface UpdateGameSessionInput { + /** + * Unique identifier for the game session to update. + */ + GameSessionId: ArnStringModel; + /** + * Maximum number of players that can be connected simultaneously to the game session. + */ + MaximumPlayerSessionCount?: WholeNumber; + /** + * Descriptive label that is associated with a game session. Session names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Policy determining whether or not the game session accepts new players. + */ + PlayerSessionCreationPolicy?: PlayerSessionCreationPolicy; + /** + * Game session protection policy to apply to this game session only. NoProtection -- The game session can be terminated during a scale-down event. FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event. + */ + ProtectionPolicy?: ProtectionPolicy; + } + export interface UpdateGameSessionOutput { + /** + * Object that contains the updated game session metadata. + */ + GameSession?: GameSession; + } + export interface UpdateGameSessionQueueInput { + /** + * Descriptive label that is associated with game session queue. Queue names must be unique within each region. + */ + Name: GameSessionQueueName; + /** + * Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. + */ + TimeoutInSeconds?: WholeNumber; + /** + * Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies. + */ + PlayerLatencyPolicies?: PlayerLatencyPolicyList; + /** + * List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations. + */ + Destinations?: GameSessionQueueDestinationList; + } + export interface UpdateGameSessionQueueOutput { + /** + * Object that describes the newly updated game session queue. + */ + GameSessionQueue?: GameSessionQueue; + } + export interface UpdateMatchmakingConfigurationInput { + /** + * Unique identifier for a matchmaking configuration to update. + */ + Name: MatchmakingIdStringModel; + /** + * Descriptive label that is associated with matchmaking configuration. + */ + Description?: NonZeroAndMaxString; + /** + * Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region. + */ + GameSessionQueueArns?: QueueArnsList; + /** + * Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed. + */ + RequestTimeoutSeconds?: MatchmakingRequestTimeoutInteger; + /** + * Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match. + */ + AcceptanceTimeoutSeconds?: MatchmakingAcceptanceTimeoutInteger; + /** + * Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. + */ + AcceptanceRequired?: BooleanModel; + /** + * Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region. + */ + RuleSetName?: MatchmakingIdStringModel; + /** + * SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information. + */ + NotificationTarget?: SnsArnStringModel; + /** + * Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. + */ + AdditionalPlayerCount?: WholeNumber; + /** + * Information to attached to all events related to the matchmaking configuration. + */ + CustomEventData?: CustomEventData; + /** + * Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. + */ + GameProperties?: GamePropertyList; + /** + * Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. + */ + GameSessionData?: GameSessionData; + } + export interface UpdateMatchmakingConfigurationOutput { + /** + * Object that describes the updated matchmaking configuration. + */ + Configuration?: MatchmakingConfiguration; + } + export interface UpdateRuntimeConfigurationInput { + /** + * Unique identifier for a fleet to update run-time configuration for. + */ + FleetId: FleetId; + /** + * Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The run-time configuration lists the types of server processes to run on an instance and includes the following configuration settings: the server executable or launch script file, launch parameters, and the number of processes to run concurrently on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration. + */ + RuntimeConfiguration: RuntimeConfiguration; + } + export interface UpdateRuntimeConfigurationOutput { + /** + * The run-time configuration currently in force. If the update was successful, this object matches the one in the request. + */ + RuntimeConfiguration?: RuntimeConfiguration; + } + export interface UpdateScriptInput { + /** + * Unique identifier for a Realtime script to update. + */ + ScriptId: ScriptId; + /** + * Descriptive label that is associated with a script. Script names do not need to be unique. + */ + Name?: NonZeroAndMaxString; + /** + * Version that is associated with a build or script. Version strings do not need to be unique. + */ + Version?: NonZeroAndMaxString; + /** + * Location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. + */ + StorageLocation?: S3Location; + /** + * Data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip. + */ + ZipFile?: ZipBlob; + } + export interface UpdateScriptOutput { + /** + * The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service. + */ + Script?: Script; + } + export interface ValidateMatchmakingRuleSetInput { + /** + * Collection of matchmaking rules to validate, formatted as a JSON string. + */ + RuleSetBody: RuleSetBody; + } + export interface ValidateMatchmakingRuleSetOutput { + /** + * Response indicating whether or not the rule set is valid. + */ + Valid?: BooleanModel; + } + export interface VpcPeeringAuthorization { + /** + * Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings. + */ + GameLiftAwsAccountId?: NonZeroAndMaxString; + /** + * + */ + PeerVpcAwsAccountId?: NonZeroAndMaxString; + /** + * Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets. + */ + PeerVpcId?: NonZeroAndMaxString; + /** + * Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + CreationTime?: Timestamp; + /** + * Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + */ + ExpirationTime?: Timestamp; + } + export type VpcPeeringAuthorizationList = VpcPeeringAuthorization[]; + export interface VpcPeeringConnection { + /** + * Unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet. + */ + FleetId?: FleetId; + /** + * CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created. + */ + IpV4CidrBlock?: NonZeroAndMaxString; + /** + * Unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection. + */ + VpcPeeringConnectionId?: NonZeroAndMaxString; + /** + * Object that contains status information about the connection. Status indicates if a connection is pending, successful, or failed. + */ + Status?: VpcPeeringConnectionStatus; + /** + * Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets. + */ + PeerVpcId?: NonZeroAndMaxString; + /** + * Unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account. + */ + GameLiftVpcId?: NonZeroAndMaxString; + } + export type VpcPeeringConnectionList = VpcPeeringConnection[]; + export interface VpcPeeringConnectionStatus { + /** + * Code indicating the status of a VPC peering connection. + */ + Code?: NonZeroAndMaxString; + /** + * Additional messaging associated with the connection status. + */ + Message?: NonZeroAndMaxString; + } + export type WholeNumber = number; + export type ZipBlob = Buffer|Uint8Array|Blob|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-10-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the GameLift client. + */ + export import Types = GameLift; +} +export = GameLift; diff --git a/node_modules/aws-sdk/clients/gamelift.js b/node_modules/aws-sdk/clients/gamelift.js new file mode 100644 index 0000000..18ee436 --- /dev/null +++ b/node_modules/aws-sdk/clients/gamelift.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['gamelift'] = {}; +AWS.GameLift = Service.defineService('gamelift', ['2015-10-01']); +Object.defineProperty(apiLoader.services['gamelift'], '2015-10-01', { + get: function get() { + var model = require('../apis/gamelift-2015-10-01.min.json'); + model.paginators = require('../apis/gamelift-2015-10-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.GameLift; diff --git a/node_modules/aws-sdk/clients/glacier.d.ts b/node_modules/aws-sdk/clients/glacier.d.ts new file mode 100644 index 0000000..df7ea15 --- /dev/null +++ b/node_modules/aws-sdk/clients/glacier.d.ts @@ -0,0 +1,1439 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {GlacierCustomizations} from '../lib/services/glacier'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Readable} from 'stream'; +interface Blob {} +declare class Glacier extends GlacierCustomizations { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Glacier.Types.ClientConfiguration) + config: Config & Glacier.Types.ClientConfiguration; + /** + * This operation aborts a multipart upload identified by the upload ID. After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload. This operation is idempotent. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide. + */ + abortMultipartUpload(params: Glacier.Types.AbortMultipartUploadInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation aborts a multipart upload identified by the upload ID. After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload. This operation is idempotent. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide. + */ + abortMultipartUpload(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault. A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies. This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault. + */ + abortVaultLock(params: Glacier.Types.AbortVaultLockInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault. A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies. This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault. + */ + abortVaultLock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon Glacier Resources. + */ + addTagsToVault(params: Glacier.Types.AddTagsToVaultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon Glacier Resources. + */ + addTagsToVault(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob. In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue. Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails. Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide. + */ + completeMultipartUpload(params: Glacier.Types.CompleteMultipartUploadInput, callback?: (err: AWSError, data: Glacier.Types.ArchiveCreationOutput) => void): Request; + /** + * You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob. In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue. Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails. Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide. + */ + completeMultipartUpload(callback?: (err: AWSError, data: Glacier.Types.ArchiveCreationOutput) => void): Request; + /** + * This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault. If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error. + */ + completeVaultLock(params: Glacier.Types.CompleteVaultLockInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault. If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error. + */ + completeVaultLock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier. You must use the following guidelines when naming a vault. Names can be between 1 and 255 characters long. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). This operation is idempotent. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide. + */ + createVault(params: Glacier.Types.CreateVaultInput, callback?: (err: AWSError, data: Glacier.Types.CreateVaultOutput) => void): Request; + /** + * This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier. You must use the following guidelines when naming a vault. Names can be between 1 and 255 characters long. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). This operation is idempotent. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide. + */ + createVault(callback?: (err: AWSError, data: Glacier.Types.CreateVaultOutput) => void): Request; + /** + * 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: 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. 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. This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide. + */ + deleteArchive(params: Glacier.Types.DeleteArchiveInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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: 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. 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. This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide. + */ + deleteArchive(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive). This operation is idempotent. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide. + */ + deleteVault(params: Glacier.Types.DeleteVaultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive). This operation is idempotent. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide. + */ + deleteVault(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. 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 Amazon Glacier Access Control with Vault Access Policies. + */ + deleteVaultAccessPolicy(params: Glacier.Types.DeleteVaultAccessPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. 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 Amazon Glacier Access Control with Vault Access Policies. + */ + deleteVaultAccessPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide. + */ + deleteVaultNotifications(params: Glacier.Types.DeleteVaultNotificationsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide. + */ + deleteVaultNotifications(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * 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 InitiateJob. 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. A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. 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 Access Control Using AWS Identity and Access Management (IAM). For more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide. + */ + describeJob(params: Glacier.Types.DescribeJobInput, callback?: (err: AWSError, data: Glacier.Types.GlacierJobDescription) => void): Request; + /** + * 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 InitiateJob. 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. A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. 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 Access Control Using AWS Identity and Access Management (IAM). For more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide. + */ + describeJob(callback?: (err: AWSError, data: Glacier.Types.GlacierJobDescription) => void): Request; + /** + * 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 InitiateJob. Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier and Describe Vault in the Amazon Glacier Developer Guide. + */ + describeVault(params: Glacier.Types.DescribeVaultInput, callback?: (err: AWSError, data: Glacier.Types.DescribeVaultOutput) => void): Request; + /** + * 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 InitiateJob. Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier and Describe Vault in the Amazon Glacier Developer Guide. + */ + describeVault(callback?: (err: AWSError, data: Glacier.Types.DescribeVaultOutput) => void): Request; + /** + * 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 Amazon Glacier Data Retrieval Policies. + */ + getDataRetrievalPolicy(params: Glacier.Types.GetDataRetrievalPolicyInput, callback?: (err: AWSError, data: Glacier.Types.GetDataRetrievalPolicyOutput) => void): Request; + /** + * 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 Amazon Glacier Data Retrieval Policies. + */ + getDataRetrievalPolicy(callback?: (err: AWSError, data: Glacier.Types.GetDataRetrievalPolicyOutput) => void): Request; + /** + * This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory. You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data. A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response. For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the Get Job Output response. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected. A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output + */ + getJobOutput(params: Glacier.Types.GetJobOutputInput, callback?: (err: AWSError, data: Glacier.Types.GetJobOutputOutput) => void): Request; + /** + * This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory. You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data. A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response. For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the Get Job Output response. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected. A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output + */ + getJobOutput(callback?: (err: AWSError, data: Glacier.Types.GetJobOutputOutput) => void): Request; + /** + * This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies. + */ + getVaultAccessPolicy(params: Glacier.Types.GetVaultAccessPolicyInput, callback?: (err: AWSError, data: Glacier.Types.GetVaultAccessPolicyOutput) => void): Request; + /** + * This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies. + */ + getVaultAccessPolicy(callback?: (err: AWSError, data: Glacier.Types.GetVaultAccessPolicyOutput) => void): Request; + /** + * This operation retrieves the following attributes from the lock-policy subresource set on the specified vault: The vault lock policy set on the vault. The state of the vault lock, which is either InProgess or Locked. When the lock ID expires. The lock ID is used to complete the vault locking process. When the vault lock was initiated and put into the InProgress state. A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies. + */ + getVaultLock(params: Glacier.Types.GetVaultLockInput, callback?: (err: AWSError, data: Glacier.Types.GetVaultLockOutput) => void): Request; + /** + * This operation retrieves the following attributes from the lock-policy subresource set on the specified vault: The vault lock policy set on the vault. The state of the vault lock, which is either InProgess or Locked. When the lock ID expires. The lock ID is used to complete the vault locking process. When the vault lock was initiated and put into the InProgress state. A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies. + */ + getVaultLock(callback?: (err: AWSError, data: Glacier.Types.GetVaultLockOutput) => void): Request; + /** + * This operation retrieves the notification-configuration subresource of the specified vault. For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide. + */ + getVaultNotifications(params: Glacier.Types.GetVaultNotificationsInput, callback?: (err: AWSError, data: Glacier.Types.GetVaultNotificationsOutput) => void): Request; + /** + * This operation retrieves the notification-configuration subresource of the specified vault. For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide. + */ + getVaultNotifications(callback?: (err: AWSError, data: Glacier.Types.GetVaultNotificationsOutput) => void): Request; + /** + * This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job. + */ + initiateJob(params: Glacier.Types.InitiateJobInput, callback?: (err: AWSError, data: Glacier.Types.InitiateJobOutput) => void): Request; + /** + * This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job. + */ + initiateJob(callback?: (err: AWSError, data: Glacier.Types.InitiateJobOutput) => void): Request; + /** + * This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart). When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB. Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size. After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide. + */ + initiateMultipartUpload(params: Glacier.Types.InitiateMultipartUploadInput, callback?: (err: AWSError, data: Glacier.Types.InitiateMultipartUploadOutput) => void): Request; + /** + * This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart). When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB. Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size. After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide. + */ + initiateMultipartUpload(callback?: (err: AWSError, data: Glacier.Types.InitiateMultipartUploadOutput) => void): Request; + /** + * This operation initiates the vault locking process by doing the following: Installing a vault lock policy on the specified vault. Setting the lock state of vault lock to InProgress. Returning a lock ID, which is used to complete the vault locking process. You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies. You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked. After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault. You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy. + */ + initiateVaultLock(params: Glacier.Types.InitiateVaultLockInput, callback?: (err: AWSError, data: Glacier.Types.InitiateVaultLockOutput) => void): Request; + /** + * This operation initiates the vault locking process by doing the following: Installing a vault lock policy on the specified vault. Setting the lock state of vault lock to InProgress. Returning a lock ID, which is used to complete the vault locking process. You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies. You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked. After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault. You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy. + */ + initiateVaultLock(callback?: (err: AWSError, data: Glacier.Types.InitiateVaultLockOutput) => void): Request; + /** + * This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time. Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists. The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request. You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit. Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false). For more information about using this operation, see the documentation for the underlying REST API List Jobs. + */ + listJobs(params: Glacier.Types.ListJobsInput, callback?: (err: AWSError, data: Glacier.Types.ListJobsOutput) => void): Request; + /** + * This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time. Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists. The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request. You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit. Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false). For more information about using this operation, see the documentation for the underlying REST API List Jobs. + */ + listJobs(callback?: (err: AWSError, data: Glacier.Types.ListJobsOutput) => void): Request; + /** + * This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request. Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide. + */ + listMultipartUploads(params: Glacier.Types.ListMultipartUploadsInput, callback?: (err: AWSError, data: Glacier.Types.ListMultipartUploadsOutput) => void): Request; + /** + * This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request. Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide. + */ + listMultipartUploads(callback?: (err: AWSError, data: Glacier.Types.ListMultipartUploadsOutput) => void): Request; + /** + * This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide. + */ + listParts(params: Glacier.Types.ListPartsInput, callback?: (err: AWSError, data: Glacier.Types.ListPartsOutput) => void): Request; + /** + * This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide. + */ + listParts(callback?: (err: AWSError, data: Glacier.Types.ListPartsOutput) => void): Request; + /** + * This operation lists the provisioned capacity units for the specified AWS account. + */ + listProvisionedCapacity(params: Glacier.Types.ListProvisionedCapacityInput, callback?: (err: AWSError, data: Glacier.Types.ListProvisionedCapacityOutput) => void): Request; + /** + * This operation lists the provisioned capacity units for the specified AWS account. + */ + listProvisionedCapacity(callback?: (err: AWSError, data: Glacier.Types.ListProvisionedCapacityOutput) => void): Request; + /** + * This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon Glacier Resources. + */ + listTagsForVault(params: Glacier.Types.ListTagsForVaultInput, callback?: (err: AWSError, data: Glacier.Types.ListTagsForVaultOutput) => void): Request; + /** + * This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon Glacier Resources. + */ + listTagsForVault(callback?: (err: AWSError, data: Glacier.Types.ListTagsForVaultOutput) => void): Request; + /** + * This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. By default, this operation returns up to 10 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide. + */ + listVaults(params: Glacier.Types.ListVaultsInput, callback?: (err: AWSError, data: Glacier.Types.ListVaultsOutput) => void): Request; + /** + * This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. By default, this operation returns up to 10 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide. + */ + listVaults(callback?: (err: AWSError, data: Glacier.Types.ListVaultsOutput) => void): Request; + /** + * This operation purchases a provisioned capacity unit for an AWS account. + */ + purchaseProvisionedCapacity(params: Glacier.Types.PurchaseProvisionedCapacityInput, callback?: (err: AWSError, data: Glacier.Types.PurchaseProvisionedCapacityOutput) => void): Request; + /** + * This operation purchases a provisioned capacity unit for an AWS account. + */ + purchaseProvisionedCapacity(callback?: (err: AWSError, data: Glacier.Types.PurchaseProvisionedCapacityOutput) => void): Request; + /** + * This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. + */ + removeTagsFromVault(params: Glacier.Types.RemoveTagsFromVaultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. + */ + removeTagsFromVault(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation. The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. + */ + setDataRetrievalPolicy(params: Glacier.Types.SetDataRetrievalPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation. The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. + */ + setDataRetrievalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies. + */ + setVaultAccessPolicy(params: Glacier.Types.SetVaultAccessPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies. + */ + setVaultAccessPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic. Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events: ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob. InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide. + */ + setVaultNotifications(params: Glacier.Types.SetVaultNotificationsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic. Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events: ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob. InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide. + */ + setVaultNotifications(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response. You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob. You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums. You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. Archives are immutable. After you upload an archive, you cannot edit the archive or its description. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide. + */ + uploadArchive(params: Glacier.Types.UploadArchiveInput, callback?: (err: AWSError, data: Glacier.Types.ArchiveCreationOutput) => void): Request; + /** + * This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response. You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob. You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums. You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. Archives are immutable. After you upload an archive, you cannot edit the archive or its description. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide. + */ + uploadArchive(callback?: (err: AWSError, data: Glacier.Types.ArchiveCreationOutput) => void): Request; + /** + * This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload. Amazon Glacier rejects your upload part request if any of the following conditions is true: SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums. Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size. If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail. Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide. + */ + uploadMultipartPart(params: Glacier.Types.UploadMultipartPartInput, callback?: (err: AWSError, data: Glacier.Types.UploadMultipartPartOutput) => void): Request; + /** + * This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload. Amazon Glacier rejects your upload part request if any of the following conditions is true: SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums. Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size. If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail. Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data. 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 Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide. + */ + uploadMultipartPart(callback?: (err: AWSError, data: Glacier.Types.UploadMultipartPartOutput) => void): Request; + /** + * Waits for the vaultExists state by periodically calling the underlying Glacier.describeVaultoperation every 3 seconds (at most 15 times). + */ + waitFor(state: "vaultExists", params: Glacier.Types.DescribeVaultInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Glacier.Types.DescribeVaultOutput) => void): Request; + /** + * Waits for the vaultExists state by periodically calling the underlying Glacier.describeVaultoperation every 3 seconds (at most 15 times). + */ + waitFor(state: "vaultExists", callback?: (err: AWSError, data: Glacier.Types.DescribeVaultOutput) => void): Request; + /** + * Waits for the vaultNotExists state by periodically calling the underlying Glacier.describeVaultoperation every 3 seconds (at most 15 times). + */ + waitFor(state: "vaultNotExists", params: Glacier.Types.DescribeVaultInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Glacier.Types.DescribeVaultOutput) => void): Request; + /** + * Waits for the vaultNotExists state by periodically calling the underlying Glacier.describeVaultoperation every 3 seconds (at most 15 times). + */ + waitFor(state: "vaultNotExists", callback?: (err: AWSError, data: Glacier.Types.DescribeVaultOutput) => void): Request; +} +declare namespace Glacier { + export interface AbortMultipartUploadInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The upload ID of the multipart upload to delete. + */ + uploadId: string; + } + export interface AbortVaultLockInput { + /** + * The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export type AccessControlPolicyList = Grant[]; + export type ActionCode = "ArchiveRetrieval"|"InventoryRetrieval"|"Select"|string; + export interface AddTagsToVaultInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string. + */ + Tags?: TagMap; + } + export interface ArchiveCreationOutput { + /** + * The relative URI path of the newly added archive resource. + */ + location?: string; + /** + * The checksum of the archive computed by Amazon Glacier. + */ + checksum?: string; + /** + * The ID of the archive. This value is also included as part of the location. + */ + archiveId?: string; + } + export interface CSVInput { + /** + * Describes the first line of input. Valid values are None, Ignore, and Use. + */ + FileHeaderInfo?: FileHeaderInfo; + /** + * A single character used to indicate that a row should be ignored when the character is present at the start of that row. + */ + Comments?: string; + /** + * A single character used for escaping the quotation-mark character inside an already escaped value. + */ + QuoteEscapeCharacter?: string; + /** + * A value used to separate individual records from each other. + */ + RecordDelimiter?: string; + /** + * A value used to separate individual fields from each other within a record. + */ + FieldDelimiter?: string; + /** + * A value used as an escape character where the field delimiter is part of the value. + */ + QuoteCharacter?: string; + } + export interface CSVOutput { + /** + * A value that indicates whether all output fields should be contained within quotation marks. + */ + QuoteFields?: QuoteFields; + /** + * A single character used for escaping the quotation-mark character inside an already escaped value. + */ + QuoteEscapeCharacter?: string; + /** + * A value used to separate individual records from each other. + */ + RecordDelimiter?: string; + /** + * A value used to separate individual fields from each other within a record. + */ + FieldDelimiter?: string; + /** + * A value used as an escape character where the field delimiter is part of the value. + */ + QuoteCharacter?: string; + } + export type CannedACL = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|string; + export interface CompleteMultipartUploadInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The upload ID of the multipart upload. + */ + uploadId: string; + /** + * The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded. + */ + archiveSize?: string; + /** + * The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails. + */ + checksum?: string; + } + export interface CompleteVaultLockInput { + /** + * The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The lockId value is the lock ID obtained from a InitiateVaultLock request. + */ + lockId: string; + } + export interface CreateVaultInput { + /** + * The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface CreateVaultOutput { + /** + * The URI of the vault that was created. + */ + location?: string; + } + export interface DataRetrievalPolicy { + /** + * The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field. + */ + Rules?: DataRetrievalRulesList; + } + export interface DataRetrievalRule { + /** + * The type of data retrieval policy to set. Valid values: BytesPerHour|FreeTier|None + */ + Strategy?: string; + /** + * The maximum number of bytes that can be retrieved in an hour. This field is required only if the value of the Strategy field is BytesPerHour. Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field. + */ + BytesPerHour?: NullableLong; + } + export type DataRetrievalRulesList = DataRetrievalRule[]; + export type DateTime = string; + export interface DeleteArchiveInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The ID of the archive to delete. + */ + archiveId: string; + } + export interface DeleteVaultAccessPolicyInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface DeleteVaultInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface DeleteVaultNotificationsInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface DescribeJobInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The ID of the job to describe. + */ + jobId: string; + } + export interface DescribeVaultInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface DescribeVaultOutput { + /** + * The Amazon Resource Name (ARN) of the vault. + */ + VaultARN?: string; + /** + * The name of the vault. + */ + VaultName?: string; + /** + * The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z. + */ + CreationDate?: string; + /** + * The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z. + */ + LastInventoryDate?: string; + /** + * The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault. + */ + NumberOfArchives?: long; + /** + * Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault. + */ + SizeInBytes?: long; + } + export interface Encryption { + /** + * The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms. + */ + EncryptionType?: EncryptionType; + /** + * The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4. + */ + KMSKeyId?: string; + /** + * Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results. + */ + KMSContext?: string; + } + export type EncryptionType = "aws:kms"|"AES256"|string; + export type ExpressionType = "SQL"|string; + export type FileHeaderInfo = "USE"|"IGNORE"|"NONE"|string; + export interface GetDataRetrievalPolicyInput { + /** + * The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + } + export interface GetDataRetrievalPolicyOutput { + /** + * Contains the returned data retrieval policy in JSON format. + */ + Policy?: DataRetrievalPolicy; + } + export interface GetJobOutputInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The job ID whose data is downloaded. + */ + jobId: string; + /** + * The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output. If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output: Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors. + */ + range?: string; + } + export interface GetJobOutputOutput { + /** + * The job data, either archive data or inventory data. + */ + body?: Stream; + /** + * The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions: You get the entire range of the archive. You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header. You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header. + */ + checksum?: string; + /** + * The HTTP response code for a job output request. The value depends on whether a range was specified in the request. + */ + status?: httpstatus; + /** + * The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB. + */ + contentRange?: string; + /** + * Indicates the range units accepted. For more information, see RFC2616. + */ + acceptRanges?: string; + /** + * The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json. + */ + contentType?: string; + /** + * The description of an archive. + */ + archiveDescription?: string; + } + export interface GetVaultAccessPolicyInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface GetVaultAccessPolicyOutput { + /** + * Contains the returned vault access policy as a JSON string. + */ + policy?: VaultAccessPolicy; + } + export interface GetVaultLockInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface GetVaultLockOutput { + /** + * The vault lock policy as a JSON string, which uses "\" as an escape character. + */ + Policy?: string; + /** + * The state of the vault lock. InProgress or Locked. + */ + State?: string; + /** + * The UTC date and time at which the lock ID expires. This value can be null if the vault lock is in a Locked state. + */ + ExpirationDate?: string; + /** + * The UTC date and time at which the vault lock was put into the InProgress state. + */ + CreationDate?: string; + } + export interface GetVaultNotificationsInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface GetVaultNotificationsOutput { + /** + * Returns the notification configuration set on the vault. + */ + vaultNotificationConfig?: VaultNotificationConfig; + } + export interface GlacierJobDescription { + /** + * An opaque string that identifies an Amazon Glacier job. + */ + JobId?: string; + /** + * The job description provided when initiating the job. + */ + JobDescription?: string; + /** + * The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select. + */ + Action?: ActionCode; + /** + * The archive ID requested for a select job or archive retrieval. Otherwise, this field is null. + */ + ArchiveId?: string; + /** + * The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested. + */ + VaultARN?: string; + /** + * The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z". + */ + CreationDate?: string; + /** + * The job status. When a job is completed, you get the job's output using Get Job Output (GET output). + */ + Completed?: boolean; + /** + * The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job. + */ + StatusCode?: StatusCode; + /** + * A friendly message that describes the job status. + */ + StatusMessage?: string; + /** + * For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null. + */ + ArchiveSizeInBytes?: Size; + /** + * For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null. + */ + InventorySizeInBytes?: Size; + /** + * An Amazon SNS topic that receives notification. + */ + SNSTopic?: string; + /** + * The UTC time that the job request completed. While the job is in progress, the value is null. + */ + CompletionDate?: string; + /** + * For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null. The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value. If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This field is null for the following: Archive retrieval jobs that specify a range that is not tree-hash aligned Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress Inventory jobs Select jobs + */ + SHA256TreeHash?: string; + /** + * The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null. + */ + ArchiveSHA256TreeHash?: string; + /** + * The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null. + */ + RetrievalByteRange?: string; + /** + * The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default. + */ + Tier?: string; + /** + * Parameters used for range inventory retrieval. + */ + InventoryRetrievalParameters?: InventoryRetrievalJobDescription; + /** + * Contains the job output location. + */ + JobOutputPath?: string; + /** + * Contains the parameters used for a select. + */ + SelectParameters?: SelectParameters; + /** + * Contains the location where the data from the select job is stored. + */ + OutputLocation?: OutputLocation; + } + export interface Grant { + /** + * The grantee. + */ + Grantee?: Grantee; + /** + * Specifies the permission given to the grantee. + */ + Permission?: Permission; + } + export interface Grantee { + /** + * Type of grantee + */ + Type: Type; + /** + * Screen name of the grantee. + */ + DisplayName?: string; + /** + * URI of the grantee group. + */ + URI?: string; + /** + * The canonical user ID of the grantee. + */ + ID?: string; + /** + * Email address of the grantee. + */ + EmailAddress?: string; + } + export interface InitiateJobInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * Provides options for specifying job information. + */ + jobParameters?: JobParameters; + } + export interface InitiateJobOutput { + /** + * The relative URI path of the job. + */ + location?: string; + /** + * The ID of the job. + */ + jobId?: string; + /** + * The path to the location of where the select results are stored. + */ + jobOutputPath?: string; + } + export interface InitiateMultipartUploadInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The archive description that you are uploading in parts. The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB). + */ + archiveDescription?: string; + /** + * The size of each part except the last, in bytes. The last part can be smaller than this part size. + */ + partSize?: string; + } + export interface InitiateMultipartUploadOutput { + /** + * The relative URI path of the multipart upload ID Amazon Glacier created. + */ + location?: string; + /** + * The ID of the multipart upload. This value is also included as part of the location. + */ + uploadId?: string; + } + export interface InitiateVaultLockInput { + /** + * The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The vault lock policy as a JSON string, which uses "\" as an escape character. + */ + policy?: VaultLockPolicy; + } + export interface InitiateVaultLockOutput { + /** + * The lock ID, which is used to complete the vault locking process. + */ + lockId?: string; + } + export interface InputSerialization { + /** + * Describes the serialization of a CSV-encoded object. + */ + csv?: CSVInput; + } + export interface InventoryRetrievalJobDescription { + /** + * The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON. + */ + Format?: string; + /** + * The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z. + */ + StartDate?: DateTime; + /** + * The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z. + */ + EndDate?: DateTime; + /** + * The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request. + */ + Limit?: string; + /** + * An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval. + */ + Marker?: string; + } + export interface InventoryRetrievalJobInput { + /** + * The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z. + */ + StartDate?: string; + /** + * The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z. + */ + EndDate?: string; + /** + * Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1. + */ + Limit?: string; + /** + * An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. + */ + Marker?: string; + } + export type JobList = GlacierJobDescription[]; + export interface JobParameters { + /** + * When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON". + */ + Format?: string; + /** + * The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval". + */ + Type?: string; + /** + * The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request. + */ + ArchiveId?: string; + /** + * The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal. + */ + Description?: string; + /** + * The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist. + */ + SNSTopic?: string; + /** + * The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response. An error occurs if you specify this field for an inventory retrieval job request. + */ + RetrievalByteRange?: string; + /** + * The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default. + */ + Tier?: string; + /** + * Input parameters used for range inventory retrieval. + */ + InventoryRetrievalParameters?: InventoryRetrievalJobInput; + /** + * Contains the parameters that define a job. + */ + SelectParameters?: SelectParameters; + /** + * Contains information about the location where the select job results are stored. + */ + OutputLocation?: OutputLocation; + } + export interface ListJobsInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit. + */ + limit?: string; + /** + * An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request. + */ + marker?: string; + /** + * The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed. + */ + statuscode?: string; + /** + * The state of the jobs to return. You can specify true or false. + */ + completed?: string; + } + export interface ListJobsOutput { + /** + * A list of job objects. Each job object contains metadata describing the job. + */ + JobList?: JobList; + /** + * An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request. + */ + Marker?: string; + } + export interface ListMultipartUploadsInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request. + */ + marker?: string; + /** + * Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 50 uploads. + */ + limit?: string; + } + export interface ListMultipartUploadsOutput { + /** + * A list of in-progress multipart uploads. + */ + UploadsList?: UploadsList; + /** + * An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null. + */ + Marker?: string; + } + export interface ListPartsInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The upload ID of the multipart upload. + */ + uploadId: string; + /** + * An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request. + */ + marker?: string; + /** + * The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit. + */ + limit?: string; + } + export interface ListPartsOutput { + /** + * The ID of the upload to which the parts are associated. + */ + MultipartUploadId?: string; + /** + * The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated. + */ + VaultARN?: string; + /** + * The description of the archive that was specified in the Initiate Multipart Upload request. + */ + ArchiveDescription?: string; + /** + * The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request. + */ + PartSizeInBytes?: long; + /** + * The UTC time at which the multipart upload was initiated. + */ + CreationDate?: string; + /** + * A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair. + */ + Parts?: PartList; + /** + * An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null. + */ + Marker?: string; + } + export interface ListProvisionedCapacityInput { + /** + * The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID. + */ + accountId: string; + } + export interface ListProvisionedCapacityOutput { + /** + * The response body contains the following JSON fields. + */ + ProvisionedCapacityList?: ProvisionedCapacityList; + } + export interface ListTagsForVaultInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + } + export interface ListTagsForVaultOutput { + /** + * The tags attached to the vault. Each tag is composed of a key and a value. + */ + Tags?: TagMap; + } + export interface ListVaultsInput { + /** + * The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin. + */ + marker?: string; + /** + * The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit. + */ + limit?: string; + } + export interface ListVaultsOutput { + /** + * List of vaults. + */ + VaultList?: VaultList; + /** + * The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list. + */ + Marker?: string; + } + export type NotificationEventList = string[]; + export type NullableLong = number; + export interface OutputLocation { + /** + * Describes an S3 location that will receive the results of the job request. + */ + S3?: S3Location; + } + export interface OutputSerialization { + /** + * Describes the serialization of CSV-encoded query results. + */ + csv?: CSVOutput; + } + export type PartList = PartListElement[]; + export interface PartListElement { + /** + * The byte range of a part, inclusive of the upper value of the range. + */ + RangeInBytes?: string; + /** + * The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null. + */ + SHA256TreeHash?: string; + } + export type Permission = "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"|string; + export interface ProvisionedCapacityDescription { + /** + * The ID that identifies the provisioned capacity unit. + */ + CapacityId?: string; + /** + * The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC). + */ + StartDate?: string; + /** + * The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC). + */ + ExpirationDate?: string; + } + export type ProvisionedCapacityList = ProvisionedCapacityDescription[]; + export interface PurchaseProvisionedCapacityInput { + /** + * The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID. + */ + accountId: string; + } + export interface PurchaseProvisionedCapacityOutput { + /** + * The ID that identifies the provisioned capacity unit. + */ + capacityId?: string; + } + export type QuoteFields = "ALWAYS"|"ASNEEDED"|string; + export interface RemoveTagsFromVaultInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * A list of tag keys. Each corresponding tag is removed from the vault. + */ + TagKeys?: TagKeyList; + } + export interface S3Location { + /** + * The name of the Amazon S3 bucket where the job results are stored. + */ + BucketName?: string; + /** + * The prefix that is prepended to the results for this request. + */ + Prefix?: string; + /** + * Contains information about the encryption used to store the job results in Amazon S3. + */ + Encryption?: Encryption; + /** + * The canned access control list (ACL) to apply to the job results. + */ + CannedACL?: CannedACL; + /** + * A list of grants that control access to the staged results. + */ + AccessControlList?: AccessControlPolicyList; + /** + * The tag-set that is applied to the job results. + */ + Tagging?: hashmap; + /** + * A map of metadata to store with the job results in Amazon S3. + */ + UserMetadata?: hashmap; + /** + * The storage class used to store the job results. + */ + StorageClass?: StorageClass; + } + export interface SelectParameters { + /** + * Describes the serialization format of the object. + */ + InputSerialization?: InputSerialization; + /** + * The type of the provided expression, for example SQL. + */ + ExpressionType?: ExpressionType; + /** + * The expression that is used to select the object. + */ + Expression?: string; + /** + * Describes how the results of the select job are serialized. + */ + OutputSerialization?: OutputSerialization; + } + export interface SetDataRetrievalPolicyInput { + /** + * The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The data retrieval policy in JSON format. + */ + Policy?: DataRetrievalPolicy; + } + export interface SetVaultAccessPolicyInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The vault access policy as a JSON string. + */ + policy?: VaultAccessPolicy; + } + export interface SetVaultNotificationsInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * Provides options for specifying notification configuration. + */ + vaultNotificationConfig?: VaultNotificationConfig; + } + export type Size = number; + export type StatusCode = "InProgress"|"Succeeded"|"Failed"|string; + export type StorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|string; + export type Stream = Buffer|Uint8Array|Blob|string|Readable; + export type TagKey = string; + export type TagKeyList = string[]; + export type TagMap = {[key: string]: TagValue}; + export type TagValue = string; + export type Type = "AmazonCustomerByEmail"|"CanonicalUser"|"Group"|string; + export interface UploadArchiveInput { + /** + * The name of the vault. + */ + vaultName: string; + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The optional description of the archive you are uploading. + */ + archiveDescription?: string; + /** + * The SHA256 tree hash of the data being uploaded. + */ + checksum?: string; + /** + * The data to upload. + */ + body?: Stream; + } + export interface UploadListElement { + /** + * The ID of a multipart upload. + */ + MultipartUploadId?: string; + /** + * The Amazon Resource Name (ARN) of the vault that contains the archive. + */ + VaultARN?: string; + /** + * The description of the archive that was specified in the Initiate Multipart Upload request. + */ + ArchiveDescription?: string; + /** + * The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size. + */ + PartSizeInBytes?: long; + /** + * The UTC time at which the multipart upload was initiated. + */ + CreationDate?: string; + } + export interface UploadMultipartPartInput { + /** + * The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. + */ + accountId: string; + /** + * The name of the vault. + */ + vaultName: string; + /** + * The upload ID of the multipart upload. + */ + uploadId: string; + /** + * The SHA256 tree hash of the data being uploaded. + */ + checksum?: string; + /** + * Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*. + */ + range?: string; + /** + * The data to upload. + */ + body?: Stream; + } + export interface UploadMultipartPartOutput { + /** + * The SHA256 tree hash that Amazon Glacier computed for the uploaded part. + */ + checksum?: string; + } + export type UploadsList = UploadListElement[]; + export interface VaultAccessPolicy { + /** + * The vault access policy. + */ + Policy?: string; + } + export type VaultList = DescribeVaultOutput[]; + export interface VaultLockPolicy { + /** + * The vault lock policy. + */ + Policy?: string; + } + export interface VaultNotificationConfig { + /** + * The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN). + */ + SNSTopic?: string; + /** + * A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic. + */ + Events?: NotificationEventList; + } + export type hashmap = {[key: string]: string}; + export type httpstatus = number; + export type long = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-06-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Glacier client. + */ + export import Types = Glacier; +} +export = Glacier; diff --git a/node_modules/aws-sdk/clients/glacier.js b/node_modules/aws-sdk/clients/glacier.js new file mode 100644 index 0000000..e6fccbe --- /dev/null +++ b/node_modules/aws-sdk/clients/glacier.js @@ -0,0 +1,20 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['glacier'] = {}; +AWS.Glacier = Service.defineService('glacier', ['2012-06-01']); +require('../lib/services/glacier'); +Object.defineProperty(apiLoader.services['glacier'], '2012-06-01', { + get: function get() { + var model = require('../apis/glacier-2012-06-01.min.json'); + model.paginators = require('../apis/glacier-2012-06-01.paginators.json').pagination; + model.waiters = require('../apis/glacier-2012-06-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Glacier; diff --git a/node_modules/aws-sdk/clients/globalaccelerator.d.ts b/node_modules/aws-sdk/clients/globalaccelerator.d.ts new file mode 100644 index 0000000..09f60a6 --- /dev/null +++ b/node_modules/aws-sdk/clients/globalaccelerator.d.ts @@ -0,0 +1,692 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class GlobalAccelerator extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: GlobalAccelerator.Types.ClientConfiguration) + config: Config & GlobalAccelerator.Types.ClientConfiguration; + /** + * Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example. + */ + createAccelerator(params: GlobalAccelerator.Types.CreateAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateAcceleratorResponse) => void): Request; + /** + * Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example. + */ + createAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateAcceleratorResponse) => void): Request; + /** + * Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example. + */ + createEndpointGroup(params: GlobalAccelerator.Types.CreateEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateEndpointGroupResponse) => void): Request; + /** + * Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example. + */ + createEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateEndpointGroupResponse) => void): Request; + /** + * Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to Example. + */ + createListener(params: GlobalAccelerator.Types.CreateListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateListenerResponse) => void): Request; + /** + * Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to Example. + */ + createListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.CreateListenerResponse) => void): Request; + /** + * Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). + */ + deleteAccelerator(params: GlobalAccelerator.Types.DeleteAcceleratorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). + */ + deleteAccelerator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete an endpoint group from a listener. + */ + deleteEndpointGroup(params: GlobalAccelerator.Types.DeleteEndpointGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete an endpoint group from a listener. + */ + deleteEndpointGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete a listener from an accelerator. + */ + deleteListener(params: GlobalAccelerator.Types.DeleteListenerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete a listener from an accelerator. + */ + deleteListener(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example. + */ + describeAccelerator(params: GlobalAccelerator.Types.DescribeAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorResponse) => void): Request; + /** + * Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example. + */ + describeAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorResponse) => void): Request; + /** + * Describe the attributes of an accelerator. + */ + describeAcceleratorAttributes(params: GlobalAccelerator.Types.DescribeAcceleratorAttributesRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorAttributesResponse) => void): Request; + /** + * Describe the attributes of an accelerator. + */ + describeAcceleratorAttributes(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeAcceleratorAttributesResponse) => void): Request; + /** + * Describe an endpoint group. + */ + describeEndpointGroup(params: GlobalAccelerator.Types.DescribeEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeEndpointGroupResponse) => void): Request; + /** + * Describe an endpoint group. + */ + describeEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeEndpointGroupResponse) => void): Request; + /** + * Describe a listener. + */ + describeListener(params: GlobalAccelerator.Types.DescribeListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeListenerResponse) => void): Request; + /** + * Describe a listener. + */ + describeListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.DescribeListenerResponse) => void): Request; + /** + * List the accelerators for an AWS account. + */ + listAccelerators(params: GlobalAccelerator.Types.ListAcceleratorsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListAcceleratorsResponse) => void): Request; + /** + * List the accelerators for an AWS account. + */ + listAccelerators(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListAcceleratorsResponse) => void): Request; + /** + * List the endpoint groups that are associated with a listener. + */ + listEndpointGroups(params: GlobalAccelerator.Types.ListEndpointGroupsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListEndpointGroupsResponse) => void): Request; + /** + * List the endpoint groups that are associated with a listener. + */ + listEndpointGroups(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListEndpointGroupsResponse) => void): Request; + /** + * List the listeners for an accelerator. + */ + listListeners(params: GlobalAccelerator.Types.ListListenersRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.ListListenersResponse) => void): Request; + /** + * List the listeners for an accelerator. + */ + listListeners(callback?: (err: AWSError, data: GlobalAccelerator.Types.ListListenersResponse) => void): Request; + /** + * Update an accelerator. + */ + updateAccelerator(params: GlobalAccelerator.Types.UpdateAcceleratorRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorResponse) => void): Request; + /** + * Update an accelerator. + */ + updateAccelerator(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorResponse) => void): Request; + /** + * Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example. + */ + updateAcceleratorAttributes(params: GlobalAccelerator.Types.UpdateAcceleratorAttributesRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorAttributesResponse) => void): Request; + /** + * Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example. + */ + updateAcceleratorAttributes(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateAcceleratorAttributesResponse) => void): Request; + /** + * Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example. + */ + updateEndpointGroup(params: GlobalAccelerator.Types.UpdateEndpointGroupRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateEndpointGroupResponse) => void): Request; + /** + * Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example. + */ + updateEndpointGroup(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateEndpointGroupResponse) => void): Request; + /** + * Update a listener. + */ + updateListener(params: GlobalAccelerator.Types.UpdateListenerRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateListenerResponse) => void): Request; + /** + * Update a listener. + */ + updateListener(callback?: (err: AWSError, data: GlobalAccelerator.Types.UpdateListenerResponse) => void): Request; +} +declare namespace GlobalAccelerator { + export interface Accelerator { + /** + * The Amazon Resource Name (ARN) of the accelerator. + */ + AcceleratorArn?: GenericString; + /** + * The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen. + */ + Name?: GenericString; + /** + * The value for the address type must be IPv4. + */ + IpAddressType?: IpAddressType; + /** + * Indicates whether theaccelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted. + */ + Enabled?: GenericBoolean; + /** + * IP address set associated with the accelerator. + */ + IpSets?: IpSets; + /** + * Describes the deployment status of the accelerator. + */ + Status?: AcceleratorStatus; + /** + * The date and time that the accelerator was created. + */ + CreatedTime?: Timestamp; + /** + * The date and time that the accelerator was last modified. + */ + LastModifiedTime?: Timestamp; + } + export interface AcceleratorAttributes { + /** + * Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more information, see Flow Logs in the AWS Global Accelerator Developer Guide. + */ + FlowLogsEnabled?: GenericBoolean; + /** + * The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket. + */ + FlowLogsS3Bucket?: GenericString; + /** + * The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket. + */ + FlowLogsS3Prefix?: GenericString; + } + export type AcceleratorStatus = "DEPLOYED"|"IN_PROGRESS"|string; + export type Accelerators = Accelerator[]; + export type ClientAffinity = "NONE"|"SOURCE_IP"|string; + export interface CreateAcceleratorRequest { + /** + * The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen. + */ + Name: GenericString; + /** + * The value for the address type must be IPv4. + */ + IpAddressType?: IpAddressType; + /** + * Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted. + */ + Enabled?: GenericBoolean; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreateAcceleratorResponse { + /** + * The accelerator that is created by specifying a listener and the supported IP address types. + */ + Accelerator?: Accelerator; + } + export interface CreateEndpointGroupRequest { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: GenericString; + /** + * The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region. + */ + EndpointGroupRegion: GenericString; + /** + * The list of endpoint objects. + */ + EndpointConfigurations?: EndpointConfigurations; + /** + * The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100. + */ + TrafficDialPercentage?: TrafficDialPercentage; + /** + * The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. + */ + HealthCheckPort?: HealthCheckPort; + /** + * The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP. + */ + HealthCheckProtocol?: HealthCheckProtocol; + /** + * If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). + */ + HealthCheckPath?: GenericString; + /** + * The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30. + */ + HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; + /** + * The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. + */ + ThresholdCount?: ThresholdCount; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreateEndpointGroupResponse { + /** + * The information about the endpoint group that was created. + */ + EndpointGroup?: EndpointGroup; + } + export interface CreateListenerRequest { + /** + * The Amazon Resource Name (ARN) of your accelerator. + */ + AcceleratorArn: GenericString; + /** + * The list of port ranges to support for connections from clients to your accelerator. + */ + PortRanges: PortRanges; + /** + * The protocol for connections from clients to your accelerator. + */ + Protocol: Protocol; + /** + * Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint. AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value. The default value is NONE. + */ + ClientAffinity?: ClientAffinity; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreateListenerResponse { + /** + * The listener that you've created. + */ + Listener?: Listener; + } + export interface DeleteAcceleratorRequest { + /** + * The Amazon Resource Name (ARN) of an accelerator. + */ + AcceleratorArn: GenericString; + } + export interface DeleteEndpointGroupRequest { + /** + * The Amazon Resource Name (ARN) of the endpoint group to delete. + */ + EndpointGroupArn: GenericString; + } + export interface DeleteListenerRequest { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: GenericString; + } + export interface DescribeAcceleratorAttributesRequest { + /** + * The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe. Value is required. + */ + AcceleratorArn?: GenericString; + } + export interface DescribeAcceleratorAttributesResponse { + /** + * The attributes of the accelerator. + */ + AcceleratorAttributes?: AcceleratorAttributes; + } + export interface DescribeAcceleratorRequest { + /** + * The Amazon Resource Name (ARN) of the accelerator to describe. + */ + AcceleratorArn: GenericString; + } + export interface DescribeAcceleratorResponse { + /** + * The description of the accelerator. + */ + Accelerator?: Accelerator; + } + export interface DescribeEndpointGroupRequest { + /** + * The Amazon Resource Name (ARN) of the endpoint group to describe. + */ + EndpointGroupArn: GenericString; + } + export interface DescribeEndpointGroupResponse { + /** + * The description of an endpoint group. + */ + EndpointGroup?: EndpointGroup; + } + export interface DescribeListenerRequest { + /** + * The Amazon Resource Name (ARN) of the listener to describe. + */ + ListenerArn: GenericString; + } + export interface DescribeListenerResponse { + /** + * The description of a listener. + */ + Listener?: Listener; + } + export interface EndpointConfiguration { + /** + * An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. + */ + EndpointId?: GenericString; + /** + * The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide. + */ + Weight?: EndpointWeight; + } + export type EndpointConfigurations = EndpointConfiguration[]; + export interface EndpointDescription { + /** + * An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. + */ + EndpointId?: GenericString; + /** + * The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide. + */ + Weight?: EndpointWeight; + /** + * The health status of the endpoint. + */ + HealthState?: HealthState; + /** + * The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided. If the endpoint state is unhealthy, the reason code can be one of the following values: Timeout: The health check requests to the endpoint are timing out before returning a status. Failed: The health check failed, for example because the endpoint response was invalid (malformed). If the endpoint state is initial, the reason code can be one of the following values: ProvisioningInProgress: The endpoint is in the process of being provisioned. InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status. + */ + HealthReason?: GenericString; + } + export type EndpointDescriptions = EndpointDescription[]; + export interface EndpointGroup { + /** + * The Amazon Resource Name (ARN) of the endpoint group. + */ + EndpointGroupArn?: GenericString; + /** + * The AWS Region that this endpoint group belongs. + */ + EndpointGroupRegion?: GenericString; + /** + * The list of endpoint objects. + */ + EndpointDescriptions?: EndpointDescriptions; + /** + * The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100. + */ + TrafficDialPercentage?: TrafficDialPercentage; + /** + * The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports. + */ + HealthCheckPort?: HealthCheckPort; + /** + * The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP. + */ + HealthCheckProtocol?: HealthCheckProtocol; + /** + * If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/). + */ + HealthCheckPath?: GenericString; + /** + * The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30. + */ + HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; + /** + * The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. + */ + ThresholdCount?: ThresholdCount; + } + export type EndpointGroups = EndpointGroup[]; + export type EndpointWeight = number; + export type GenericBoolean = boolean; + export type GenericString = string; + export type HealthCheckIntervalSeconds = number; + export type HealthCheckPort = number; + export type HealthCheckProtocol = "TCP"|"HTTP"|"HTTPS"|string; + export type HealthState = "INITIAL"|"HEALTHY"|"UNHEALTHY"|string; + export type IdempotencyToken = string; + export type IpAddress = string; + export type IpAddressType = "IPV4"|string; + export type IpAddresses = IpAddress[]; + export interface IpSet { + /** + * The types of IP addresses included in this IP set. + */ + IpFamily?: GenericString; + /** + * The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses. + */ + IpAddresses?: IpAddresses; + } + export type IpSets = IpSet[]; + export interface ListAcceleratorsRequest { + /** + * The number of Global Accelerator objects that you want to return with this call. The default value is 10. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. You receive this token from a previous call. + */ + NextToken?: GenericString; + } + export interface ListAcceleratorsResponse { + /** + * The list of accelerators for a customer account. + */ + Accelerators?: Accelerators; + /** + * The token for the next set of results. You receive this token from a previous call. + */ + NextToken?: GenericString; + } + export interface ListEndpointGroupsRequest { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn: GenericString; + /** + * The number of endpoint group objects that you want to return with this call. The default value is 10. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. You receive this token from a previous call. + */ + NextToken?: GenericString; + } + export interface ListEndpointGroupsResponse { + /** + * The list of the endpoint groups associated with a listener. + */ + EndpointGroups?: EndpointGroups; + /** + * The token for the next set of results. You receive this token from a previous call. + */ + NextToken?: GenericString; + } + export interface ListListenersRequest { + /** + * The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects. + */ + AcceleratorArn: GenericString; + /** + * The number of listener objects that you want to return with this call. The default value is 10. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of results. You receive this token from a previous call. + */ + NextToken?: GenericString; + } + export interface ListListenersResponse { + /** + * The list of listeners for an accelerator. + */ + Listeners?: Listeners; + /** + * The token for the next set of results. You receive this token from a previous call. + */ + NextToken?: GenericString; + } + export interface Listener { + /** + * The Amazon Resource Name (ARN) of the listener. + */ + ListenerArn?: GenericString; + /** + * The list of port ranges for the connections from clients to the accelerator. + */ + PortRanges?: PortRanges; + /** + * The protocol for the connections from clients to the accelerator. + */ + Protocol?: Protocol; + /** + * Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint. AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value. The default value is NONE. + */ + ClientAffinity?: ClientAffinity; + } + export type Listeners = Listener[]; + export type MaxResults = number; + export type PortNumber = number; + export interface PortRange { + /** + * The first port in the range of ports, inclusive. + */ + FromPort?: PortNumber; + /** + * The last port in the range of ports, inclusive. + */ + ToPort?: PortNumber; + } + export type PortRanges = PortRange[]; + export type Protocol = "TCP"|"UDP"|string; + export type ThresholdCount = number; + export type Timestamp = Date; + export type TrafficDialPercentage = number; + export interface UpdateAcceleratorAttributesRequest { + /** + * The Amazon Resource Name (ARN) of the accelerator that you want to update. Attribute is required. + */ + AcceleratorArn?: GenericString; + /** + * Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more information, see Flow Logs in the AWS Global Accelerator Developer Guide. + */ + FlowLogsEnabled?: GenericBoolean; + /** + * The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket. + */ + FlowLogsS3Bucket?: GenericString; + /** + * Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket. + */ + FlowLogsS3Prefix?: GenericString; + } + export interface UpdateAcceleratorAttributesResponse { + /** + * Updated attributes for the accelerator. + */ + AcceleratorAttributes?: AcceleratorAttributes; + } + export interface UpdateAcceleratorRequest { + /** + * The Amazon Resource Name (ARN) of the accelerator to update. + */ + AcceleratorArn: GenericString; + /** + * The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen. + */ + Name?: GenericString; + /** + * The value for the address type must be IPv4. + */ + IpAddressType?: IpAddressType; + /** + * Indicates whether an accelerator is enabled. The value is true or false. The default value is true. If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted. + */ + Enabled?: GenericBoolean; + } + export interface UpdateAcceleratorResponse { + /** + * Information about the updated accelerator. + */ + Accelerator?: Accelerator; + } + export interface UpdateEndpointGroupRequest { + /** + * The Amazon Resource Name (ARN) of the endpoint group. + */ + EndpointGroupArn: GenericString; + /** + * The list of endpoint objects. + */ + EndpointConfigurations?: EndpointConfigurations; + /** + * The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100. + */ + TrafficDialPercentage?: TrafficDialPercentage; + /** + * The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list. + */ + HealthCheckPort?: HealthCheckPort; + /** + * The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP. + */ + HealthCheckProtocol?: HealthCheckProtocol; + /** + * If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). + */ + HealthCheckPath?: GenericString; + /** + * The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30. + */ + HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; + /** + * The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. + */ + ThresholdCount?: ThresholdCount; + } + export interface UpdateEndpointGroupResponse { + /** + * The information about the endpoint group that was updated. + */ + EndpointGroup?: EndpointGroup; + } + export interface UpdateListenerRequest { + /** + * The Amazon Resource Name (ARN) of the listener to update. + */ + ListenerArn: GenericString; + /** + * The updated list of port ranges for the connections from clients to the accelerator. + */ + PortRanges?: PortRanges; + /** + * The updated protocol for the connections from clients to the accelerator. + */ + Protocol?: Protocol; + /** + * Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint. AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value. The default value is NONE. + */ + ClientAffinity?: ClientAffinity; + } + export interface UpdateListenerResponse { + /** + * Information for the updated listener. + */ + Listener?: Listener; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-08-08"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the GlobalAccelerator client. + */ + export import Types = GlobalAccelerator; +} +export = GlobalAccelerator; diff --git a/node_modules/aws-sdk/clients/globalaccelerator.js b/node_modules/aws-sdk/clients/globalaccelerator.js new file mode 100644 index 0000000..6858b8e --- /dev/null +++ b/node_modules/aws-sdk/clients/globalaccelerator.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['globalaccelerator'] = {}; +AWS.GlobalAccelerator = Service.defineService('globalaccelerator', ['2018-08-08']); +Object.defineProperty(apiLoader.services['globalaccelerator'], '2018-08-08', { + get: function get() { + var model = require('../apis/globalaccelerator-2018-08-08.min.json'); + model.paginators = require('../apis/globalaccelerator-2018-08-08.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.GlobalAccelerator; diff --git a/node_modules/aws-sdk/clients/glue.d.ts b/node_modules/aws-sdk/clients/glue.d.ts new file mode 100644 index 0000000..3a78db1 --- /dev/null +++ b/node_modules/aws-sdk/clients/glue.d.ts @@ -0,0 +1,4735 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Glue extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Glue.Types.ClientConfiguration) + config: Config & Glue.Types.ClientConfiguration; + /** + * Creates one or more partitions in a batch operation. + */ + batchCreatePartition(params: Glue.Types.BatchCreatePartitionRequest, callback?: (err: AWSError, data: Glue.Types.BatchCreatePartitionResponse) => void): Request; + /** + * Creates one or more partitions in a batch operation. + */ + batchCreatePartition(callback?: (err: AWSError, data: Glue.Types.BatchCreatePartitionResponse) => void): Request; + /** + * Deletes a list of connection definitions from the Data Catalog. + */ + batchDeleteConnection(params: Glue.Types.BatchDeleteConnectionRequest, callback?: (err: AWSError, data: Glue.Types.BatchDeleteConnectionResponse) => void): Request; + /** + * Deletes a list of connection definitions from the Data Catalog. + */ + batchDeleteConnection(callback?: (err: AWSError, data: Glue.Types.BatchDeleteConnectionResponse) => void): Request; + /** + * Deletes one or more partitions in a batch operation. + */ + batchDeletePartition(params: Glue.Types.BatchDeletePartitionRequest, callback?: (err: AWSError, data: Glue.Types.BatchDeletePartitionResponse) => void): Request; + /** + * Deletes one or more partitions in a batch operation. + */ + batchDeletePartition(callback?: (err: AWSError, data: Glue.Types.BatchDeletePartitionResponse) => void): Request; + /** + * Deletes multiple tables at once. After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table. + */ + batchDeleteTable(params: Glue.Types.BatchDeleteTableRequest, callback?: (err: AWSError, data: Glue.Types.BatchDeleteTableResponse) => void): Request; + /** + * Deletes multiple tables at once. After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table. + */ + batchDeleteTable(callback?: (err: AWSError, data: Glue.Types.BatchDeleteTableResponse) => void): Request; + /** + * Deletes a specified batch of versions of a table. + */ + batchDeleteTableVersion(params: Glue.Types.BatchDeleteTableVersionRequest, callback?: (err: AWSError, data: Glue.Types.BatchDeleteTableVersionResponse) => void): Request; + /** + * Deletes a specified batch of versions of a table. + */ + batchDeleteTableVersion(callback?: (err: AWSError, data: Glue.Types.BatchDeleteTableVersionResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetCrawlers(params: Glue.Types.BatchGetCrawlersRequest, callback?: (err: AWSError, data: Glue.Types.BatchGetCrawlersResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetCrawlers(callback?: (err: AWSError, data: Glue.Types.BatchGetCrawlersResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of DevEndpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetDevEndpoints(params: Glue.Types.BatchGetDevEndpointsRequest, callback?: (err: AWSError, data: Glue.Types.BatchGetDevEndpointsResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of DevEndpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetDevEndpoints(callback?: (err: AWSError, data: Glue.Types.BatchGetDevEndpointsResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetJobs(params: Glue.Types.BatchGetJobsRequest, callback?: (err: AWSError, data: Glue.Types.BatchGetJobsResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetJobs(callback?: (err: AWSError, data: Glue.Types.BatchGetJobsResponse) => void): Request; + /** + * Retrieves partitions in a batch request. + */ + batchGetPartition(params: Glue.Types.BatchGetPartitionRequest, callback?: (err: AWSError, data: Glue.Types.BatchGetPartitionResponse) => void): Request; + /** + * Retrieves partitions in a batch request. + */ + batchGetPartition(callback?: (err: AWSError, data: Glue.Types.BatchGetPartitionResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetTriggers(params: Glue.Types.BatchGetTriggersRequest, callback?: (err: AWSError, data: Glue.Types.BatchGetTriggersResponse) => void): Request; + /** + * Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. + */ + batchGetTriggers(callback?: (err: AWSError, data: Glue.Types.BatchGetTriggersResponse) => void): Request; + /** + * Stops one or more job runs for a specified job definition. + */ + batchStopJobRun(params: Glue.Types.BatchStopJobRunRequest, callback?: (err: AWSError, data: Glue.Types.BatchStopJobRunResponse) => void): Request; + /** + * Stops one or more job runs for a specified job definition. + */ + batchStopJobRun(callback?: (err: AWSError, data: Glue.Types.BatchStopJobRunResponse) => void): Request; + /** + * Creates a classifier in the user's account. This may be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present. + */ + createClassifier(params: Glue.Types.CreateClassifierRequest, callback?: (err: AWSError, data: Glue.Types.CreateClassifierResponse) => void): Request; + /** + * Creates a classifier in the user's account. This may be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present. + */ + createClassifier(callback?: (err: AWSError, data: Glue.Types.CreateClassifierResponse) => void): Request; + /** + * Creates a connection definition in the Data Catalog. + */ + createConnection(params: Glue.Types.CreateConnectionRequest, callback?: (err: AWSError, data: Glue.Types.CreateConnectionResponse) => void): Request; + /** + * Creates a connection definition in the Data Catalog. + */ + createConnection(callback?: (err: AWSError, data: Glue.Types.CreateConnectionResponse) => void): Request; + /** + * Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field. + */ + createCrawler(params: Glue.Types.CreateCrawlerRequest, callback?: (err: AWSError, data: Glue.Types.CreateCrawlerResponse) => void): Request; + /** + * Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field. + */ + createCrawler(callback?: (err: AWSError, data: Glue.Types.CreateCrawlerResponse) => void): Request; + /** + * Creates a new database in a Data Catalog. + */ + createDatabase(params: Glue.Types.CreateDatabaseRequest, callback?: (err: AWSError, data: Glue.Types.CreateDatabaseResponse) => void): Request; + /** + * Creates a new database in a Data Catalog. + */ + createDatabase(callback?: (err: AWSError, data: Glue.Types.CreateDatabaseResponse) => void): Request; + /** + * Creates a new DevEndpoint. + */ + createDevEndpoint(params: Glue.Types.CreateDevEndpointRequest, callback?: (err: AWSError, data: Glue.Types.CreateDevEndpointResponse) => void): Request; + /** + * Creates a new DevEndpoint. + */ + createDevEndpoint(callback?: (err: AWSError, data: Glue.Types.CreateDevEndpointResponse) => void): Request; + /** + * Creates a new job definition. + */ + createJob(params: Glue.Types.CreateJobRequest, callback?: (err: AWSError, data: Glue.Types.CreateJobResponse) => void): Request; + /** + * Creates a new job definition. + */ + createJob(callback?: (err: AWSError, data: Glue.Types.CreateJobResponse) => void): Request; + /** + * Creates a new partition. + */ + createPartition(params: Glue.Types.CreatePartitionRequest, callback?: (err: AWSError, data: Glue.Types.CreatePartitionResponse) => void): Request; + /** + * Creates a new partition. + */ + createPartition(callback?: (err: AWSError, data: Glue.Types.CreatePartitionResponse) => void): Request; + /** + * Transforms a directed acyclic graph (DAG) into code. + */ + createScript(params: Glue.Types.CreateScriptRequest, callback?: (err: AWSError, data: Glue.Types.CreateScriptResponse) => void): Request; + /** + * Transforms a directed acyclic graph (DAG) into code. + */ + createScript(callback?: (err: AWSError, data: Glue.Types.CreateScriptResponse) => void): Request; + /** + * Creates a new security configuration. + */ + createSecurityConfiguration(params: Glue.Types.CreateSecurityConfigurationRequest, callback?: (err: AWSError, data: Glue.Types.CreateSecurityConfigurationResponse) => void): Request; + /** + * Creates a new security configuration. + */ + createSecurityConfiguration(callback?: (err: AWSError, data: Glue.Types.CreateSecurityConfigurationResponse) => void): Request; + /** + * Creates a new table definition in the Data Catalog. + */ + createTable(params: Glue.Types.CreateTableRequest, callback?: (err: AWSError, data: Glue.Types.CreateTableResponse) => void): Request; + /** + * Creates a new table definition in the Data Catalog. + */ + createTable(callback?: (err: AWSError, data: Glue.Types.CreateTableResponse) => void): Request; + /** + * Creates a new trigger. + */ + createTrigger(params: Glue.Types.CreateTriggerRequest, callback?: (err: AWSError, data: Glue.Types.CreateTriggerResponse) => void): Request; + /** + * Creates a new trigger. + */ + createTrigger(callback?: (err: AWSError, data: Glue.Types.CreateTriggerResponse) => void): Request; + /** + * Creates a new function definition in the Data Catalog. + */ + createUserDefinedFunction(params: Glue.Types.CreateUserDefinedFunctionRequest, callback?: (err: AWSError, data: Glue.Types.CreateUserDefinedFunctionResponse) => void): Request; + /** + * Creates a new function definition in the Data Catalog. + */ + createUserDefinedFunction(callback?: (err: AWSError, data: Glue.Types.CreateUserDefinedFunctionResponse) => void): Request; + /** + * Removes a classifier from the Data Catalog. + */ + deleteClassifier(params: Glue.Types.DeleteClassifierRequest, callback?: (err: AWSError, data: Glue.Types.DeleteClassifierResponse) => void): Request; + /** + * Removes a classifier from the Data Catalog. + */ + deleteClassifier(callback?: (err: AWSError, data: Glue.Types.DeleteClassifierResponse) => void): Request; + /** + * Deletes a connection from the Data Catalog. + */ + deleteConnection(params: Glue.Types.DeleteConnectionRequest, callback?: (err: AWSError, data: Glue.Types.DeleteConnectionResponse) => void): Request; + /** + * Deletes a connection from the Data Catalog. + */ + deleteConnection(callback?: (err: AWSError, data: Glue.Types.DeleteConnectionResponse) => void): Request; + /** + * Removes a specified crawler from the Data Catalog, unless the crawler state is RUNNING. + */ + deleteCrawler(params: Glue.Types.DeleteCrawlerRequest, callback?: (err: AWSError, data: Glue.Types.DeleteCrawlerResponse) => void): Request; + /** + * Removes a specified crawler from the Data Catalog, unless the crawler state is RUNNING. + */ + deleteCrawler(callback?: (err: AWSError, data: Glue.Types.DeleteCrawlerResponse) => void): Request; + /** + * Removes a specified Database from a Data Catalog. After completing this operation, you will no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database. + */ + deleteDatabase(params: Glue.Types.DeleteDatabaseRequest, callback?: (err: AWSError, data: Glue.Types.DeleteDatabaseResponse) => void): Request; + /** + * Removes a specified Database from a Data Catalog. After completing this operation, you will no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database. + */ + deleteDatabase(callback?: (err: AWSError, data: Glue.Types.DeleteDatabaseResponse) => void): Request; + /** + * Deletes a specified DevEndpoint. + */ + deleteDevEndpoint(params: Glue.Types.DeleteDevEndpointRequest, callback?: (err: AWSError, data: Glue.Types.DeleteDevEndpointResponse) => void): Request; + /** + * Deletes a specified DevEndpoint. + */ + deleteDevEndpoint(callback?: (err: AWSError, data: Glue.Types.DeleteDevEndpointResponse) => void): Request; + /** + * Deletes a specified job definition. If the job definition is not found, no exception is thrown. + */ + deleteJob(params: Glue.Types.DeleteJobRequest, callback?: (err: AWSError, data: Glue.Types.DeleteJobResponse) => void): Request; + /** + * Deletes a specified job definition. If the job definition is not found, no exception is thrown. + */ + deleteJob(callback?: (err: AWSError, data: Glue.Types.DeleteJobResponse) => void): Request; + /** + * Deletes a specified partition. + */ + deletePartition(params: Glue.Types.DeletePartitionRequest, callback?: (err: AWSError, data: Glue.Types.DeletePartitionResponse) => void): Request; + /** + * Deletes a specified partition. + */ + deletePartition(callback?: (err: AWSError, data: Glue.Types.DeletePartitionResponse) => void): Request; + /** + * Deletes a specified policy. + */ + deleteResourcePolicy(params: Glue.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: Glue.Types.DeleteResourcePolicyResponse) => void): Request; + /** + * Deletes a specified policy. + */ + deleteResourcePolicy(callback?: (err: AWSError, data: Glue.Types.DeleteResourcePolicyResponse) => void): Request; + /** + * Deletes a specified security configuration. + */ + deleteSecurityConfiguration(params: Glue.Types.DeleteSecurityConfigurationRequest, callback?: (err: AWSError, data: Glue.Types.DeleteSecurityConfigurationResponse) => void): Request; + /** + * Deletes a specified security configuration. + */ + deleteSecurityConfiguration(callback?: (err: AWSError, data: Glue.Types.DeleteSecurityConfigurationResponse) => void): Request; + /** + * Removes a table definition from the Data Catalog. After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table. + */ + deleteTable(params: Glue.Types.DeleteTableRequest, callback?: (err: AWSError, data: Glue.Types.DeleteTableResponse) => void): Request; + /** + * Removes a table definition from the Data Catalog. After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table. + */ + deleteTable(callback?: (err: AWSError, data: Glue.Types.DeleteTableResponse) => void): Request; + /** + * Deletes a specified version of a table. + */ + deleteTableVersion(params: Glue.Types.DeleteTableVersionRequest, callback?: (err: AWSError, data: Glue.Types.DeleteTableVersionResponse) => void): Request; + /** + * Deletes a specified version of a table. + */ + deleteTableVersion(callback?: (err: AWSError, data: Glue.Types.DeleteTableVersionResponse) => void): Request; + /** + * Deletes a specified trigger. If the trigger is not found, no exception is thrown. + */ + deleteTrigger(params: Glue.Types.DeleteTriggerRequest, callback?: (err: AWSError, data: Glue.Types.DeleteTriggerResponse) => void): Request; + /** + * Deletes a specified trigger. If the trigger is not found, no exception is thrown. + */ + deleteTrigger(callback?: (err: AWSError, data: Glue.Types.DeleteTriggerResponse) => void): Request; + /** + * Deletes an existing function definition from the Data Catalog. + */ + deleteUserDefinedFunction(params: Glue.Types.DeleteUserDefinedFunctionRequest, callback?: (err: AWSError, data: Glue.Types.DeleteUserDefinedFunctionResponse) => void): Request; + /** + * Deletes an existing function definition from the Data Catalog. + */ + deleteUserDefinedFunction(callback?: (err: AWSError, data: Glue.Types.DeleteUserDefinedFunctionResponse) => void): Request; + /** + * Retrieves the status of a migration operation. + */ + getCatalogImportStatus(params: Glue.Types.GetCatalogImportStatusRequest, callback?: (err: AWSError, data: Glue.Types.GetCatalogImportStatusResponse) => void): Request; + /** + * Retrieves the status of a migration operation. + */ + getCatalogImportStatus(callback?: (err: AWSError, data: Glue.Types.GetCatalogImportStatusResponse) => void): Request; + /** + * Retrieve a classifier by name. + */ + getClassifier(params: Glue.Types.GetClassifierRequest, callback?: (err: AWSError, data: Glue.Types.GetClassifierResponse) => void): Request; + /** + * Retrieve a classifier by name. + */ + getClassifier(callback?: (err: AWSError, data: Glue.Types.GetClassifierResponse) => void): Request; + /** + * Lists all classifier objects in the Data Catalog. + */ + getClassifiers(params: Glue.Types.GetClassifiersRequest, callback?: (err: AWSError, data: Glue.Types.GetClassifiersResponse) => void): Request; + /** + * Lists all classifier objects in the Data Catalog. + */ + getClassifiers(callback?: (err: AWSError, data: Glue.Types.GetClassifiersResponse) => void): Request; + /** + * Retrieves a connection definition from the Data Catalog. + */ + getConnection(params: Glue.Types.GetConnectionRequest, callback?: (err: AWSError, data: Glue.Types.GetConnectionResponse) => void): Request; + /** + * Retrieves a connection definition from the Data Catalog. + */ + getConnection(callback?: (err: AWSError, data: Glue.Types.GetConnectionResponse) => void): Request; + /** + * Retrieves a list of connection definitions from the Data Catalog. + */ + getConnections(params: Glue.Types.GetConnectionsRequest, callback?: (err: AWSError, data: Glue.Types.GetConnectionsResponse) => void): Request; + /** + * Retrieves a list of connection definitions from the Data Catalog. + */ + getConnections(callback?: (err: AWSError, data: Glue.Types.GetConnectionsResponse) => void): Request; + /** + * Retrieves metadata for a specified crawler. + */ + getCrawler(params: Glue.Types.GetCrawlerRequest, callback?: (err: AWSError, data: Glue.Types.GetCrawlerResponse) => void): Request; + /** + * Retrieves metadata for a specified crawler. + */ + getCrawler(callback?: (err: AWSError, data: Glue.Types.GetCrawlerResponse) => void): Request; + /** + * Retrieves metrics about specified crawlers. + */ + getCrawlerMetrics(params: Glue.Types.GetCrawlerMetricsRequest, callback?: (err: AWSError, data: Glue.Types.GetCrawlerMetricsResponse) => void): Request; + /** + * Retrieves metrics about specified crawlers. + */ + getCrawlerMetrics(callback?: (err: AWSError, data: Glue.Types.GetCrawlerMetricsResponse) => void): Request; + /** + * Retrieves metadata for all crawlers defined in the customer account. + */ + getCrawlers(params: Glue.Types.GetCrawlersRequest, callback?: (err: AWSError, data: Glue.Types.GetCrawlersResponse) => void): Request; + /** + * Retrieves metadata for all crawlers defined in the customer account. + */ + getCrawlers(callback?: (err: AWSError, data: Glue.Types.GetCrawlersResponse) => void): Request; + /** + * Retrieves the security configuration for a specified catalog. + */ + getDataCatalogEncryptionSettings(params: Glue.Types.GetDataCatalogEncryptionSettingsRequest, callback?: (err: AWSError, data: Glue.Types.GetDataCatalogEncryptionSettingsResponse) => void): Request; + /** + * Retrieves the security configuration for a specified catalog. + */ + getDataCatalogEncryptionSettings(callback?: (err: AWSError, data: Glue.Types.GetDataCatalogEncryptionSettingsResponse) => void): Request; + /** + * Retrieves the definition of a specified database. + */ + getDatabase(params: Glue.Types.GetDatabaseRequest, callback?: (err: AWSError, data: Glue.Types.GetDatabaseResponse) => void): Request; + /** + * Retrieves the definition of a specified database. + */ + getDatabase(callback?: (err: AWSError, data: Glue.Types.GetDatabaseResponse) => void): Request; + /** + * Retrieves all Databases defined in a given Data Catalog. + */ + getDatabases(params: Glue.Types.GetDatabasesRequest, callback?: (err: AWSError, data: Glue.Types.GetDatabasesResponse) => void): Request; + /** + * Retrieves all Databases defined in a given Data Catalog. + */ + getDatabases(callback?: (err: AWSError, data: Glue.Types.GetDatabasesResponse) => void): Request; + /** + * Transforms a Python script into a directed acyclic graph (DAG). + */ + getDataflowGraph(params: Glue.Types.GetDataflowGraphRequest, callback?: (err: AWSError, data: Glue.Types.GetDataflowGraphResponse) => void): Request; + /** + * Transforms a Python script into a directed acyclic graph (DAG). + */ + getDataflowGraph(callback?: (err: AWSError, data: Glue.Types.GetDataflowGraphResponse) => void): Request; + /** + * Retrieves information about a specified DevEndpoint. When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address. + */ + getDevEndpoint(params: Glue.Types.GetDevEndpointRequest, callback?: (err: AWSError, data: Glue.Types.GetDevEndpointResponse) => void): Request; + /** + * Retrieves information about a specified DevEndpoint. When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address. + */ + getDevEndpoint(callback?: (err: AWSError, data: Glue.Types.GetDevEndpointResponse) => void): Request; + /** + * Retrieves all the DevEndpoints in this AWS account. When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address. + */ + getDevEndpoints(params: Glue.Types.GetDevEndpointsRequest, callback?: (err: AWSError, data: Glue.Types.GetDevEndpointsResponse) => void): Request; + /** + * Retrieves all the DevEndpoints in this AWS account. When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address. + */ + getDevEndpoints(callback?: (err: AWSError, data: Glue.Types.GetDevEndpointsResponse) => void): Request; + /** + * Retrieves an existing job definition. + */ + getJob(params: Glue.Types.GetJobRequest, callback?: (err: AWSError, data: Glue.Types.GetJobResponse) => void): Request; + /** + * Retrieves an existing job definition. + */ + getJob(callback?: (err: AWSError, data: Glue.Types.GetJobResponse) => void): Request; + /** + * Retrieves the metadata for a given job run. + */ + getJobRun(params: Glue.Types.GetJobRunRequest, callback?: (err: AWSError, data: Glue.Types.GetJobRunResponse) => void): Request; + /** + * Retrieves the metadata for a given job run. + */ + getJobRun(callback?: (err: AWSError, data: Glue.Types.GetJobRunResponse) => void): Request; + /** + * Retrieves metadata for all runs of a given job definition. + */ + getJobRuns(params: Glue.Types.GetJobRunsRequest, callback?: (err: AWSError, data: Glue.Types.GetJobRunsResponse) => void): Request; + /** + * Retrieves metadata for all runs of a given job definition. + */ + getJobRuns(callback?: (err: AWSError, data: Glue.Types.GetJobRunsResponse) => void): Request; + /** + * Retrieves all current job definitions. + */ + getJobs(params: Glue.Types.GetJobsRequest, callback?: (err: AWSError, data: Glue.Types.GetJobsResponse) => void): Request; + /** + * Retrieves all current job definitions. + */ + getJobs(callback?: (err: AWSError, data: Glue.Types.GetJobsResponse) => void): Request; + /** + * Creates mappings. + */ + getMapping(params: Glue.Types.GetMappingRequest, callback?: (err: AWSError, data: Glue.Types.GetMappingResponse) => void): Request; + /** + * Creates mappings. + */ + getMapping(callback?: (err: AWSError, data: Glue.Types.GetMappingResponse) => void): Request; + /** + * Retrieves information about a specified partition. + */ + getPartition(params: Glue.Types.GetPartitionRequest, callback?: (err: AWSError, data: Glue.Types.GetPartitionResponse) => void): Request; + /** + * Retrieves information about a specified partition. + */ + getPartition(callback?: (err: AWSError, data: Glue.Types.GetPartitionResponse) => void): Request; + /** + * Retrieves information about the partitions in a table. + */ + getPartitions(params: Glue.Types.GetPartitionsRequest, callback?: (err: AWSError, data: Glue.Types.GetPartitionsResponse) => void): Request; + /** + * Retrieves information about the partitions in a table. + */ + getPartitions(callback?: (err: AWSError, data: Glue.Types.GetPartitionsResponse) => void): Request; + /** + * Gets code to perform a specified mapping. + */ + getPlan(params: Glue.Types.GetPlanRequest, callback?: (err: AWSError, data: Glue.Types.GetPlanResponse) => void): Request; + /** + * Gets code to perform a specified mapping. + */ + getPlan(callback?: (err: AWSError, data: Glue.Types.GetPlanResponse) => void): Request; + /** + * Retrieves a specified resource policy. + */ + getResourcePolicy(params: Glue.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: Glue.Types.GetResourcePolicyResponse) => void): Request; + /** + * Retrieves a specified resource policy. + */ + getResourcePolicy(callback?: (err: AWSError, data: Glue.Types.GetResourcePolicyResponse) => void): Request; + /** + * Retrieves a specified security configuration. + */ + getSecurityConfiguration(params: Glue.Types.GetSecurityConfigurationRequest, callback?: (err: AWSError, data: Glue.Types.GetSecurityConfigurationResponse) => void): Request; + /** + * Retrieves a specified security configuration. + */ + getSecurityConfiguration(callback?: (err: AWSError, data: Glue.Types.GetSecurityConfigurationResponse) => void): Request; + /** + * Retrieves a list of all security configurations. + */ + getSecurityConfigurations(params: Glue.Types.GetSecurityConfigurationsRequest, callback?: (err: AWSError, data: Glue.Types.GetSecurityConfigurationsResponse) => void): Request; + /** + * Retrieves a list of all security configurations. + */ + getSecurityConfigurations(callback?: (err: AWSError, data: Glue.Types.GetSecurityConfigurationsResponse) => void): Request; + /** + * Retrieves the Table definition in a Data Catalog for a specified table. + */ + getTable(params: Glue.Types.GetTableRequest, callback?: (err: AWSError, data: Glue.Types.GetTableResponse) => void): Request; + /** + * Retrieves the Table definition in a Data Catalog for a specified table. + */ + getTable(callback?: (err: AWSError, data: Glue.Types.GetTableResponse) => void): Request; + /** + * Retrieves a specified version of a table. + */ + getTableVersion(params: Glue.Types.GetTableVersionRequest, callback?: (err: AWSError, data: Glue.Types.GetTableVersionResponse) => void): Request; + /** + * Retrieves a specified version of a table. + */ + getTableVersion(callback?: (err: AWSError, data: Glue.Types.GetTableVersionResponse) => void): Request; + /** + * Retrieves a list of strings that identify available versions of a specified table. + */ + getTableVersions(params: Glue.Types.GetTableVersionsRequest, callback?: (err: AWSError, data: Glue.Types.GetTableVersionsResponse) => void): Request; + /** + * Retrieves a list of strings that identify available versions of a specified table. + */ + getTableVersions(callback?: (err: AWSError, data: Glue.Types.GetTableVersionsResponse) => void): Request; + /** + * Retrieves the definitions of some or all of the tables in a given Database. + */ + getTables(params: Glue.Types.GetTablesRequest, callback?: (err: AWSError, data: Glue.Types.GetTablesResponse) => void): Request; + /** + * Retrieves the definitions of some or all of the tables in a given Database. + */ + getTables(callback?: (err: AWSError, data: Glue.Types.GetTablesResponse) => void): Request; + /** + * Retrieves a list of tags associated with a resource. + */ + getTags(params: Glue.Types.GetTagsRequest, callback?: (err: AWSError, data: Glue.Types.GetTagsResponse) => void): Request; + /** + * Retrieves a list of tags associated with a resource. + */ + getTags(callback?: (err: AWSError, data: Glue.Types.GetTagsResponse) => void): Request; + /** + * Retrieves the definition of a trigger. + */ + getTrigger(params: Glue.Types.GetTriggerRequest, callback?: (err: AWSError, data: Glue.Types.GetTriggerResponse) => void): Request; + /** + * Retrieves the definition of a trigger. + */ + getTrigger(callback?: (err: AWSError, data: Glue.Types.GetTriggerResponse) => void): Request; + /** + * Gets all the triggers associated with a job. + */ + getTriggers(params: Glue.Types.GetTriggersRequest, callback?: (err: AWSError, data: Glue.Types.GetTriggersResponse) => void): Request; + /** + * Gets all the triggers associated with a job. + */ + getTriggers(callback?: (err: AWSError, data: Glue.Types.GetTriggersResponse) => void): Request; + /** + * Retrieves a specified function definition from the Data Catalog. + */ + getUserDefinedFunction(params: Glue.Types.GetUserDefinedFunctionRequest, callback?: (err: AWSError, data: Glue.Types.GetUserDefinedFunctionResponse) => void): Request; + /** + * Retrieves a specified function definition from the Data Catalog. + */ + getUserDefinedFunction(callback?: (err: AWSError, data: Glue.Types.GetUserDefinedFunctionResponse) => void): Request; + /** + * Retrieves a multiple function definitions from the Data Catalog. + */ + getUserDefinedFunctions(params: Glue.Types.GetUserDefinedFunctionsRequest, callback?: (err: AWSError, data: Glue.Types.GetUserDefinedFunctionsResponse) => void): Request; + /** + * Retrieves a multiple function definitions from the Data Catalog. + */ + getUserDefinedFunctions(callback?: (err: AWSError, data: Glue.Types.GetUserDefinedFunctionsResponse) => void): Request; + /** + * Imports an existing Athena Data Catalog to AWS Glue + */ + importCatalogToGlue(params: Glue.Types.ImportCatalogToGlueRequest, callback?: (err: AWSError, data: Glue.Types.ImportCatalogToGlueResponse) => void): Request; + /** + * Imports an existing Athena Data Catalog to AWS Glue + */ + importCatalogToGlue(callback?: (err: AWSError, data: Glue.Types.ImportCatalogToGlueResponse) => void): Request; + /** + * Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listCrawlers(params: Glue.Types.ListCrawlersRequest, callback?: (err: AWSError, data: Glue.Types.ListCrawlersResponse) => void): Request; + /** + * Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listCrawlers(callback?: (err: AWSError, data: Glue.Types.ListCrawlersResponse) => void): Request; + /** + * Retrieves the names of all DevEndpoint resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listDevEndpoints(params: Glue.Types.ListDevEndpointsRequest, callback?: (err: AWSError, data: Glue.Types.ListDevEndpointsResponse) => void): Request; + /** + * Retrieves the names of all DevEndpoint resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listDevEndpoints(callback?: (err: AWSError, data: Glue.Types.ListDevEndpointsResponse) => void): Request; + /** + * Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listJobs(params: Glue.Types.ListJobsRequest, callback?: (err: AWSError, data: Glue.Types.ListJobsResponse) => void): Request; + /** + * Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listJobs(callback?: (err: AWSError, data: Glue.Types.ListJobsResponse) => void): Request; + /** + * Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listTriggers(params: Glue.Types.ListTriggersRequest, callback?: (err: AWSError, data: Glue.Types.ListTriggersResponse) => void): Request; + /** + * Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved. + */ + listTriggers(callback?: (err: AWSError, data: Glue.Types.ListTriggersResponse) => void): Request; + /** + * Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter. + */ + putDataCatalogEncryptionSettings(params: Glue.Types.PutDataCatalogEncryptionSettingsRequest, callback?: (err: AWSError, data: Glue.Types.PutDataCatalogEncryptionSettingsResponse) => void): Request; + /** + * Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter. + */ + putDataCatalogEncryptionSettings(callback?: (err: AWSError, data: Glue.Types.PutDataCatalogEncryptionSettingsResponse) => void): Request; + /** + * Sets the Data Catalog resource policy for access control. + */ + putResourcePolicy(params: Glue.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: Glue.Types.PutResourcePolicyResponse) => void): Request; + /** + * Sets the Data Catalog resource policy for access control. + */ + putResourcePolicy(callback?: (err: AWSError, data: Glue.Types.PutResourcePolicyResponse) => void): Request; + /** + * Resets a bookmark entry. + */ + resetJobBookmark(params: Glue.Types.ResetJobBookmarkRequest, callback?: (err: AWSError, data: Glue.Types.ResetJobBookmarkResponse) => void): Request; + /** + * Resets a bookmark entry. + */ + resetJobBookmark(callback?: (err: AWSError, data: Glue.Types.ResetJobBookmarkResponse) => void): Request; + /** + * Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException. + */ + startCrawler(params: Glue.Types.StartCrawlerRequest, callback?: (err: AWSError, data: Glue.Types.StartCrawlerResponse) => void): Request; + /** + * Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException. + */ + startCrawler(callback?: (err: AWSError, data: Glue.Types.StartCrawlerResponse) => void): Request; + /** + * Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED. + */ + startCrawlerSchedule(params: Glue.Types.StartCrawlerScheduleRequest, callback?: (err: AWSError, data: Glue.Types.StartCrawlerScheduleResponse) => void): Request; + /** + * Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED. + */ + startCrawlerSchedule(callback?: (err: AWSError, data: Glue.Types.StartCrawlerScheduleResponse) => void): Request; + /** + * Starts a job run using a job definition. + */ + startJobRun(params: Glue.Types.StartJobRunRequest, callback?: (err: AWSError, data: Glue.Types.StartJobRunResponse) => void): Request; + /** + * Starts a job run using a job definition. + */ + startJobRun(callback?: (err: AWSError, data: Glue.Types.StartJobRunResponse) => void): Request; + /** + * Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started. + */ + startTrigger(params: Glue.Types.StartTriggerRequest, callback?: (err: AWSError, data: Glue.Types.StartTriggerResponse) => void): Request; + /** + * Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started. + */ + startTrigger(callback?: (err: AWSError, data: Glue.Types.StartTriggerResponse) => void): Request; + /** + * If the specified crawler is running, stops the crawl. + */ + stopCrawler(params: Glue.Types.StopCrawlerRequest, callback?: (err: AWSError, data: Glue.Types.StopCrawlerResponse) => void): Request; + /** + * If the specified crawler is running, stops the crawl. + */ + stopCrawler(callback?: (err: AWSError, data: Glue.Types.StopCrawlerResponse) => void): Request; + /** + * Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running. + */ + stopCrawlerSchedule(params: Glue.Types.StopCrawlerScheduleRequest, callback?: (err: AWSError, data: Glue.Types.StopCrawlerScheduleResponse) => void): Request; + /** + * Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running. + */ + stopCrawlerSchedule(callback?: (err: AWSError, data: Glue.Types.StopCrawlerScheduleResponse) => void): Request; + /** + * Stops a specified trigger. + */ + stopTrigger(params: Glue.Types.StopTriggerRequest, callback?: (err: AWSError, data: Glue.Types.StopTriggerResponse) => void): Request; + /** + * Stops a specified trigger. + */ + stopTrigger(callback?: (err: AWSError, data: Glue.Types.StopTriggerResponse) => void): Request; + /** + * Adds tags to a resource. A tag is a label you can assign to an AWS resource. In AWS Glue, you can tag only certain resources. For information about what resources you can tag, see AWS Tags in AWS Glue. + */ + tagResource(params: Glue.Types.TagResourceRequest, callback?: (err: AWSError, data: Glue.Types.TagResourceResponse) => void): Request; + /** + * Adds tags to a resource. A tag is a label you can assign to an AWS resource. In AWS Glue, you can tag only certain resources. For information about what resources you can tag, see AWS Tags in AWS Glue. + */ + tagResource(callback?: (err: AWSError, data: Glue.Types.TagResourceResponse) => void): Request; + /** + * Removes tags from a resource. + */ + untagResource(params: Glue.Types.UntagResourceRequest, callback?: (err: AWSError, data: Glue.Types.UntagResourceResponse) => void): Request; + /** + * Removes tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: Glue.Types.UntagResourceResponse) => void): Request; + /** + * Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present). + */ + updateClassifier(params: Glue.Types.UpdateClassifierRequest, callback?: (err: AWSError, data: Glue.Types.UpdateClassifierResponse) => void): Request; + /** + * Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present). + */ + updateClassifier(callback?: (err: AWSError, data: Glue.Types.UpdateClassifierResponse) => void): Request; + /** + * Updates a connection definition in the Data Catalog. + */ + updateConnection(params: Glue.Types.UpdateConnectionRequest, callback?: (err: AWSError, data: Glue.Types.UpdateConnectionResponse) => void): Request; + /** + * Updates a connection definition in the Data Catalog. + */ + updateConnection(callback?: (err: AWSError, data: Glue.Types.UpdateConnectionResponse) => void): Request; + /** + * Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it. + */ + updateCrawler(params: Glue.Types.UpdateCrawlerRequest, callback?: (err: AWSError, data: Glue.Types.UpdateCrawlerResponse) => void): Request; + /** + * Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it. + */ + updateCrawler(callback?: (err: AWSError, data: Glue.Types.UpdateCrawlerResponse) => void): Request; + /** + * Updates the schedule of a crawler using a cron expression. + */ + updateCrawlerSchedule(params: Glue.Types.UpdateCrawlerScheduleRequest, callback?: (err: AWSError, data: Glue.Types.UpdateCrawlerScheduleResponse) => void): Request; + /** + * Updates the schedule of a crawler using a cron expression. + */ + updateCrawlerSchedule(callback?: (err: AWSError, data: Glue.Types.UpdateCrawlerScheduleResponse) => void): Request; + /** + * Updates an existing database definition in a Data Catalog. + */ + updateDatabase(params: Glue.Types.UpdateDatabaseRequest, callback?: (err: AWSError, data: Glue.Types.UpdateDatabaseResponse) => void): Request; + /** + * Updates an existing database definition in a Data Catalog. + */ + updateDatabase(callback?: (err: AWSError, data: Glue.Types.UpdateDatabaseResponse) => void): Request; + /** + * Updates a specified DevEndpoint. + */ + updateDevEndpoint(params: Glue.Types.UpdateDevEndpointRequest, callback?: (err: AWSError, data: Glue.Types.UpdateDevEndpointResponse) => void): Request; + /** + * Updates a specified DevEndpoint. + */ + updateDevEndpoint(callback?: (err: AWSError, data: Glue.Types.UpdateDevEndpointResponse) => void): Request; + /** + * Updates an existing job definition. + */ + updateJob(params: Glue.Types.UpdateJobRequest, callback?: (err: AWSError, data: Glue.Types.UpdateJobResponse) => void): Request; + /** + * Updates an existing job definition. + */ + updateJob(callback?: (err: AWSError, data: Glue.Types.UpdateJobResponse) => void): Request; + /** + * Updates a partition. + */ + updatePartition(params: Glue.Types.UpdatePartitionRequest, callback?: (err: AWSError, data: Glue.Types.UpdatePartitionResponse) => void): Request; + /** + * Updates a partition. + */ + updatePartition(callback?: (err: AWSError, data: Glue.Types.UpdatePartitionResponse) => void): Request; + /** + * Updates a metadata table in the Data Catalog. + */ + updateTable(params: Glue.Types.UpdateTableRequest, callback?: (err: AWSError, data: Glue.Types.UpdateTableResponse) => void): Request; + /** + * Updates a metadata table in the Data Catalog. + */ + updateTable(callback?: (err: AWSError, data: Glue.Types.UpdateTableResponse) => void): Request; + /** + * Updates a trigger definition. + */ + updateTrigger(params: Glue.Types.UpdateTriggerRequest, callback?: (err: AWSError, data: Glue.Types.UpdateTriggerResponse) => void): Request; + /** + * Updates a trigger definition. + */ + updateTrigger(callback?: (err: AWSError, data: Glue.Types.UpdateTriggerResponse) => void): Request; + /** + * Updates an existing function definition in the Data Catalog. + */ + updateUserDefinedFunction(params: Glue.Types.UpdateUserDefinedFunctionRequest, callback?: (err: AWSError, data: Glue.Types.UpdateUserDefinedFunctionResponse) => void): Request; + /** + * Updates an existing function definition in the Data Catalog. + */ + updateUserDefinedFunction(callback?: (err: AWSError, data: Glue.Types.UpdateUserDefinedFunctionResponse) => void): Request; +} +declare namespace Glue { + export interface Action { + /** + * The name of a job to be executed. + */ + JobName?: NameString; + /** + * The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide. + */ + Arguments?: GenericMap; + /** + * The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job. + */ + Timeout?: Timeout; + /** + * Specifies configuration properties of a job run notification. + */ + NotificationProperty?: NotificationProperty; + /** + * The name of the SecurityConfiguration structure to be used with this action. + */ + SecurityConfiguration?: NameString; + } + export type ActionList = Action[]; + export type AttemptCount = number; + export interface BatchCreatePartitionRequest { + /** + * The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID. + */ + CatalogId?: CatalogIdString; + /** + * The name of the metadata database in which the partition is to be created. + */ + DatabaseName: NameString; + /** + * The name of the metadata table in which the partition is to be created. + */ + TableName: NameString; + /** + * A list of PartitionInput structures that define the partitions to be created. + */ + PartitionInputList: PartitionInputList; + } + export interface BatchCreatePartitionResponse { + /** + * Errors encountered when trying to create the requested partitions. + */ + Errors?: PartitionErrors; + } + export interface BatchDeleteConnectionRequest { + /** + * The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * A list of names of the connections to delete. + */ + ConnectionNameList: DeleteConnectionNameList; + } + export interface BatchDeleteConnectionResponse { + /** + * A list of names of the connection definitions that were successfully deleted. + */ + Succeeded?: NameStringList; + /** + * A map of the names of connections that were not successfully deleted to error details. + */ + Errors?: ErrorByName; + } + export interface BatchDeletePartitionRequest { + /** + * The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database in which the table in question resides. + */ + DatabaseName: NameString; + /** + * The name of the table where the partitions to be deleted is located. + */ + TableName: NameString; + /** + * A list of PartitionInput structures that define the partitions to be deleted. + */ + PartitionsToDelete: BatchDeletePartitionValueList; + } + export interface BatchDeletePartitionResponse { + /** + * Errors encountered when trying to delete the requested partitions. + */ + Errors?: PartitionErrors; + } + export type BatchDeletePartitionValueList = PartitionValueList[]; + export type BatchDeleteTableNameList = NameString[]; + export interface BatchDeleteTableRequest { + /** + * The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the tables to delete reside. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * A list of the table to delete. + */ + TablesToDelete: BatchDeleteTableNameList; + } + export interface BatchDeleteTableResponse { + /** + * A list of errors encountered in attempting to delete the specified tables. + */ + Errors?: TableErrors; + } + export type BatchDeleteTableVersionList = VersionString[]; + export interface BatchDeleteTableVersionRequest { + /** + * The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * The name of the table. For Hive compatibility, this name is entirely lowercase. + */ + TableName: NameString; + /** + * A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1. + */ + VersionIds: BatchDeleteTableVersionList; + } + export interface BatchDeleteTableVersionResponse { + /** + * A list of errors encountered while trying to delete the specified table versions. + */ + Errors?: TableVersionErrors; + } + export interface BatchGetCrawlersRequest { + /** + * A list of crawler names, which may be the names returned from the ListCrawlers operation. + */ + CrawlerNames: CrawlerNameList; + } + export interface BatchGetCrawlersResponse { + /** + * A list of crawler definitions. + */ + Crawlers?: CrawlerList; + /** + * A list of names of crawlers not found. + */ + CrawlersNotFound?: CrawlerNameList; + } + export interface BatchGetDevEndpointsRequest { + /** + * The list of DevEndpoint names, which may be the names returned from the ListDevEndpoint operation. + */ + DevEndpointNames: DevEndpointNames; + } + export interface BatchGetDevEndpointsResponse { + /** + * A list of DevEndpoint definitions. + */ + DevEndpoints?: DevEndpointList; + /** + * A list of DevEndpoints not found. + */ + DevEndpointsNotFound?: DevEndpointNames; + } + export interface BatchGetJobsRequest { + /** + * A list of job names, which may be the names returned from the ListJobs operation. + */ + JobNames: JobNameList; + } + export interface BatchGetJobsResponse { + /** + * A list of job definitions. + */ + Jobs?: JobList; + /** + * A list of names of jobs not found. + */ + JobsNotFound?: JobNameList; + } + export interface BatchGetPartitionRequest { + /** + * The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the partitions reside. + */ + DatabaseName: NameString; + /** + * The name of the partitions' table. + */ + TableName: NameString; + /** + * A list of partition values identifying the partitions to retrieve. + */ + PartitionsToGet: BatchGetPartitionValueList; + } + export interface BatchGetPartitionResponse { + /** + * A list of the requested partitions. + */ + Partitions?: PartitionList; + /** + * A list of the partition values in the request for which partions were not returned. + */ + UnprocessedKeys?: BatchGetPartitionValueList; + } + export type BatchGetPartitionValueList = PartitionValueList[]; + export interface BatchGetTriggersRequest { + /** + * A list of trigger names, which may be the names returned from the ListTriggers operation. + */ + TriggerNames: TriggerNameList; + } + export interface BatchGetTriggersResponse { + /** + * A list of trigger definitions. + */ + Triggers?: TriggerList; + /** + * A list of names of triggers not found. + */ + TriggersNotFound?: TriggerNameList; + } + export interface BatchStopJobRunError { + /** + * The name of the job definition used in the job run in question. + */ + JobName?: NameString; + /** + * The JobRunId of the job run in question. + */ + JobRunId?: IdString; + /** + * Specifies details about the error that was encountered. + */ + ErrorDetail?: ErrorDetail; + } + export type BatchStopJobRunErrorList = BatchStopJobRunError[]; + export type BatchStopJobRunJobRunIdList = IdString[]; + export interface BatchStopJobRunRequest { + /** + * The name of the job definition for which to stop job runs. + */ + JobName: NameString; + /** + * A list of the JobRunIds that should be stopped for that job definition. + */ + JobRunIds: BatchStopJobRunJobRunIdList; + } + export interface BatchStopJobRunResponse { + /** + * A list of the JobRuns that were successfully submitted for stopping. + */ + SuccessfulSubmissions?: BatchStopJobRunSuccessfulSubmissionList; + /** + * A list of the errors that were encountered in tryng to stop JobRuns, including the JobRunId for which each error was encountered and details about the error. + */ + Errors?: BatchStopJobRunErrorList; + } + export interface BatchStopJobRunSuccessfulSubmission { + /** + * The name of the job definition used in the job run that was stopped. + */ + JobName?: NameString; + /** + * The JobRunId of the job run that was stopped. + */ + JobRunId?: IdString; + } + export type BatchStopJobRunSuccessfulSubmissionList = BatchStopJobRunSuccessfulSubmission[]; + export type Boolean = boolean; + export type BooleanNullable = boolean; + export type BooleanValue = boolean; + export type BoundedPartitionValueList = ValueString[]; + export type CatalogEncryptionMode = "DISABLED"|"SSE-KMS"|string; + export type CatalogEntries = CatalogEntry[]; + export interface CatalogEntry { + /** + * The database in which the table metadata resides. + */ + DatabaseName: NameString; + /** + * The name of the table in question. + */ + TableName: NameString; + } + export type CatalogIdString = string; + export interface CatalogImportStatus { + /** + * True if the migration has completed, or False otherwise. + */ + ImportCompleted?: Boolean; + /** + * The time that the migration was started. + */ + ImportTime?: Timestamp; + /** + * The name of the person who initiated the migration. + */ + ImportedBy?: NameString; + } + export type Classification = string; + export interface Classifier { + /** + * A GrokClassifier object. + */ + GrokClassifier?: GrokClassifier; + /** + * An XMLClassifier object. + */ + XMLClassifier?: XMLClassifier; + /** + * A JsonClassifier object. + */ + JsonClassifier?: JsonClassifier; + /** + * A CSVClassifier object. + */ + CsvClassifier?: CsvClassifier; + } + export type ClassifierList = Classifier[]; + export type ClassifierNameList = NameString[]; + export interface CloudWatchEncryption { + /** + * The encryption mode to use for CloudWatch data. + */ + CloudWatchEncryptionMode?: CloudWatchEncryptionMode; + /** + * The AWS ARN of the KMS key to be used to encrypt the data. + */ + KmsKeyArn?: KmsKeyArn; + } + export type CloudWatchEncryptionMode = "DISABLED"|"SSE-KMS"|string; + export type CodeGenArgName = string; + export type CodeGenArgValue = string; + export interface CodeGenEdge { + /** + * The ID of the node at which the edge starts. + */ + Source: CodeGenIdentifier; + /** + * The ID of the node at which the edge ends. + */ + Target: CodeGenIdentifier; + /** + * The target of the edge. + */ + TargetParameter?: CodeGenArgName; + } + export type CodeGenIdentifier = string; + export interface CodeGenNode { + /** + * A node identifier that is unique within the node's graph. + */ + Id: CodeGenIdentifier; + /** + * The type of node this is. + */ + NodeType: CodeGenNodeType; + /** + * Properties of the node, in the form of name-value pairs. + */ + Args: CodeGenNodeArgs; + /** + * The line number of the node. + */ + LineNumber?: Integer; + } + export interface CodeGenNodeArg { + /** + * The name of the argument or property. + */ + Name: CodeGenArgName; + /** + * The value of the argument or property. + */ + Value: CodeGenArgValue; + /** + * True if the value is used as a parameter. + */ + Param?: Boolean; + } + export type CodeGenNodeArgs = CodeGenNodeArg[]; + export type CodeGenNodeType = string; + export interface Column { + /** + * The name of the Column. + */ + Name: NameString; + /** + * The datatype of data in the Column. + */ + Type?: ColumnTypeString; + /** + * Free-form text comment. + */ + Comment?: CommentString; + } + export type ColumnList = Column[]; + export type ColumnTypeString = string; + export type ColumnValueStringList = ColumnValuesString[]; + export type ColumnValuesString = string; + export type CommentString = string; + export interface Condition { + /** + * A logical operator. + */ + LogicalOperator?: LogicalOperator; + /** + * The name of the Job to whose JobRuns this condition applies and on which this trigger waits. + */ + JobName?: NameString; + /** + * The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED. + */ + State?: JobRunState; + } + export type ConditionList = Condition[]; + export interface Connection { + /** + * The name of the connection definition. + */ + Name?: NameString; + /** + * The description of the connection. + */ + Description?: DescriptionString; + /** + * The type of the connection. Currently, only JDBC is supported; SFTP is not supported. + */ + ConnectionType?: ConnectionType; + /** + * A list of criteria that can be used in selecting this connection. + */ + MatchCriteria?: MatchCriteria; + /** + * These key-value pairs define parameters for the connection: HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host. PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections. USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME". PASSWORD - A password, if one is used, for the user name. ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password. JDBC_DRIVER_JAR_URI - The Amazon S3 path of the JAR file that contains the JDBC driver to use. JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use. JDBC_ENGINE - The name of the JDBC engine to use. JDBC_ENGINE_VERSION - The version of the JDBC engine to use. CONFIG_FILES - (Reserved for future use). INSTANCE_ID - The instance ID to use. JDBC_CONNECTION_URL - The URL for the JDBC connection. JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching will be enforced for the JDBC connection on the client. The default is false. + */ + ConnectionProperties?: ConnectionProperties; + /** + * A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully. + */ + PhysicalConnectionRequirements?: PhysicalConnectionRequirements; + /** + * The time that this connection definition was created. + */ + CreationTime?: Timestamp; + /** + * The last time that this connection definition was updated. + */ + LastUpdatedTime?: Timestamp; + /** + * The user, group, or role that last updated this connection definition. + */ + LastUpdatedBy?: NameString; + } + export interface ConnectionInput { + /** + * The name of the connection. + */ + Name: NameString; + /** + * The description of the connection. + */ + Description?: DescriptionString; + /** + * The type of the connection. Currently, only JDBC is supported; SFTP is not supported. + */ + ConnectionType: ConnectionType; + /** + * A list of criteria that can be used in selecting this connection. + */ + MatchCriteria?: MatchCriteria; + /** + * These key-value pairs define parameters for the connection. + */ + ConnectionProperties: ConnectionProperties; + /** + * A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection. + */ + PhysicalConnectionRequirements?: PhysicalConnectionRequirements; + } + export type ConnectionList = Connection[]; + export type ConnectionName = string; + export interface ConnectionPasswordEncryption { + /** + * When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption. + */ + ReturnConnectionPasswordEncrypted: Boolean; + /** + * An AWS KMS key that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog. You can set the decrypt permission to enable or restrict access on the password key according to your security requirements. + */ + AwsKmsKeyId?: NameString; + } + export type ConnectionProperties = {[key: string]: ValueString}; + export type ConnectionPropertyKey = "HOST"|"PORT"|"USERNAME"|"PASSWORD"|"ENCRYPTED_PASSWORD"|"JDBC_DRIVER_JAR_URI"|"JDBC_DRIVER_CLASS_NAME"|"JDBC_ENGINE"|"JDBC_ENGINE_VERSION"|"CONFIG_FILES"|"INSTANCE_ID"|"JDBC_CONNECTION_URL"|"JDBC_ENFORCE_SSL"|string; + export type ConnectionType = "JDBC"|"SFTP"|string; + export interface ConnectionsList { + /** + * A list of connections used by the job. + */ + Connections?: StringList; + } + export interface Crawler { + /** + * The crawler name. + */ + Name?: NameString; + /** + * The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3. + */ + Role?: Role; + /** + * A collection of targets to crawl. + */ + Targets?: CrawlerTargets; + /** + * The database where metadata is written by this crawler. + */ + DatabaseName?: DatabaseName; + /** + * A description of the crawler. + */ + Description?: DescriptionString; + /** + * A list of custom classifiers associated with the crawler. + */ + Classifiers?: ClassifierNameList; + /** + * Sets the behavior when the crawler finds a changed or deleted object. + */ + SchemaChangePolicy?: SchemaChangePolicy; + /** + * Indicates whether the crawler is running, or whether a run is pending. + */ + State?: CrawlerState; + /** + * The prefix added to the names of tables that are created. + */ + TablePrefix?: TablePrefix; + /** + * For scheduled crawlers, the schedule when the crawler runs. + */ + Schedule?: Schedule; + /** + * If the crawler is running, contains the total time elapsed since the last crawl began. + */ + CrawlElapsedTime?: MillisecondsCount; + /** + * The time when the crawler was created. + */ + CreationTime?: Timestamp; + /** + * The time the crawler was last updated. + */ + LastUpdated?: Timestamp; + /** + * The status of the last crawl, and potentially error information if an error occurred. + */ + LastCrawl?: LastCrawlInfo; + /** + * The version of the crawler. + */ + Version?: VersionId; + /** + * Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler. + */ + Configuration?: CrawlerConfiguration; + /** + * The name of the SecurityConfiguration structure to be used by this Crawler. + */ + CrawlerSecurityConfiguration?: CrawlerSecurityConfiguration; + } + export type CrawlerConfiguration = string; + export type CrawlerList = Crawler[]; + export interface CrawlerMetrics { + /** + * The name of the crawler. + */ + CrawlerName?: NameString; + /** + * The estimated time left to complete a running crawl. + */ + TimeLeftSeconds?: NonNegativeDouble; + /** + * True if the crawler is still estimating how long it will take to complete this run. + */ + StillEstimating?: Boolean; + /** + * The duration of the crawler's most recent run, in seconds. + */ + LastRuntimeSeconds?: NonNegativeDouble; + /** + * The median duration of this crawler's runs, in seconds. + */ + MedianRuntimeSeconds?: NonNegativeDouble; + /** + * The number of tables created by this crawler. + */ + TablesCreated?: NonNegativeInteger; + /** + * The number of tables updated by this crawler. + */ + TablesUpdated?: NonNegativeInteger; + /** + * The number of tables deleted by this crawler. + */ + TablesDeleted?: NonNegativeInteger; + } + export type CrawlerMetricsList = CrawlerMetrics[]; + export type CrawlerNameList = NameString[]; + export type CrawlerSecurityConfiguration = string; + export type CrawlerState = "READY"|"RUNNING"|"STOPPING"|string; + export interface CrawlerTargets { + /** + * Specifies Amazon S3 targets. + */ + S3Targets?: S3TargetList; + /** + * Specifies JDBC targets. + */ + JdbcTargets?: JdbcTargetList; + /** + * Specifies DynamoDB targets. + */ + DynamoDBTargets?: DynamoDBTargetList; + } + export interface CreateClassifierRequest { + /** + * A GrokClassifier object specifying the classifier to create. + */ + GrokClassifier?: CreateGrokClassifierRequest; + /** + * An XMLClassifier object specifying the classifier to create. + */ + XMLClassifier?: CreateXMLClassifierRequest; + /** + * A JsonClassifier object specifying the classifier to create. + */ + JsonClassifier?: CreateJsonClassifierRequest; + /** + * A CsvClassifier object specifying the classifier to create. + */ + CsvClassifier?: CreateCsvClassifierRequest; + } + export interface CreateClassifierResponse { + } + export interface CreateConnectionRequest { + /** + * The ID of the Data Catalog in which to create the connection. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * A ConnectionInput object defining the connection to create. + */ + ConnectionInput: ConnectionInput; + } + export interface CreateConnectionResponse { + } + export interface CreateCrawlerRequest { + /** + * Name of the new crawler. + */ + Name: NameString; + /** + * The IAM role (or ARN of an IAM role) used by the new crawler to access customer resources. + */ + Role: Role; + /** + * The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*. + */ + DatabaseName: DatabaseName; + /** + * A description of the new crawler. + */ + Description?: DescriptionString; + /** + * A list of collection of targets to crawl. + */ + Targets: CrawlerTargets; + /** + * A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *). + */ + Schedule?: CronExpression; + /** + * A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification. + */ + Classifiers?: ClassifierNameList; + /** + * The table prefix used for catalog tables that are created. + */ + TablePrefix?: TablePrefix; + /** + * Policy for the crawler's update and deletion behavior. + */ + SchemaChangePolicy?: SchemaChangePolicy; + /** + * Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler. + */ + Configuration?: CrawlerConfiguration; + /** + * The name of the SecurityConfiguration structure to be used by this Crawler. + */ + CrawlerSecurityConfiguration?: CrawlerSecurityConfiguration; + /** + * The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide. + */ + Tags?: TagsMap; + } + export interface CreateCrawlerResponse { + } + export interface CreateCsvClassifierRequest { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * A custom symbol to denote what separates each column entry in the row. + */ + Delimiter?: CsvColumnDelimiter; + /** + * A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter. + */ + QuoteSymbol?: CsvQuoteSymbol; + /** + * Indicates whether the CSV file contains a header. + */ + ContainsHeader?: CsvHeaderOption; + /** + * A list of strings representing column names. + */ + Header?: CsvHeader; + /** + * Specifies not to trim values before identifying the type of column values. The default value is true. + */ + DisableValueTrimming?: NullableBoolean; + /** + * Enables the processing of files that contain only one column. + */ + AllowSingleColumn?: NullableBoolean; + } + export interface CreateDatabaseRequest { + /** + * The ID of the Data Catalog in which to create the database. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * A DatabaseInput object defining the metadata database to create in the catalog. + */ + DatabaseInput: DatabaseInput; + } + export interface CreateDatabaseResponse { + } + export interface CreateDevEndpointRequest { + /** + * The name to be assigned to the new DevEndpoint. + */ + EndpointName: GenericString; + /** + * The IAM role for the DevEndpoint. + */ + RoleArn: RoleArn; + /** + * Security group IDs for the security groups to be used by the new DevEndpoint. + */ + SecurityGroupIds?: StringList; + /** + * The subnet ID for the new DevEndpoint to use. + */ + SubnetId?: GenericString; + /** + * The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys. + */ + PublicKey?: GenericString; + /** + * A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client. If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute. + */ + PublicKeys?: PublicKeysList; + /** + * The number of AWS Glue Data Processing Units (DPUs) to allocate to this DevEndpoint. + */ + NumberOfNodes?: IntegerValue; + /** + * Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma. Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported. + */ + ExtraPythonLibsS3Path?: GenericString; + /** + * Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint. + */ + ExtraJarsS3Path?: GenericString; + /** + * The name of the SecurityConfiguration structure to be used with this DevEndpoint. + */ + SecurityConfiguration?: NameString; + /** + * The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide. + */ + Tags?: TagsMap; + /** + * A map of arguments used to configure the DevEndpoint. + */ + Arguments?: MapValue; + } + export interface CreateDevEndpointResponse { + /** + * The name assigned to the new DevEndpoint. + */ + EndpointName?: GenericString; + /** + * The current status of the new DevEndpoint. + */ + Status?: GenericString; + /** + * The security groups assigned to the new DevEndpoint. + */ + SecurityGroupIds?: StringList; + /** + * The subnet ID assigned to the new DevEndpoint. + */ + SubnetId?: GenericString; + /** + * The AWS ARN of the role assigned to the new DevEndpoint. + */ + RoleArn?: RoleArn; + /** + * The address of the YARN endpoint used by this DevEndpoint. + */ + YarnEndpointAddress?: GenericString; + /** + * The Apache Zeppelin port for the remote Apache Spark interpreter. + */ + ZeppelinRemoteSparkInterpreterPort?: IntegerValue; + /** + * The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint. + */ + NumberOfNodes?: IntegerValue; + /** + * The AWS availability zone where this DevEndpoint is located. + */ + AvailabilityZone?: GenericString; + /** + * The ID of the VPC used by this DevEndpoint. + */ + VpcId?: GenericString; + /** + * Path(s) to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint. + */ + ExtraPythonLibsS3Path?: GenericString; + /** + * Path to one or more Java Jars in an S3 bucket that will be loaded in your DevEndpoint. + */ + ExtraJarsS3Path?: GenericString; + /** + * The reason for a current failure in this DevEndpoint. + */ + FailureReason?: GenericString; + /** + * The name of the SecurityConfiguration structure being used with this DevEndpoint. + */ + SecurityConfiguration?: NameString; + /** + * The point in time at which this DevEndpoint was created. + */ + CreatedTimestamp?: TimestampValue; + /** + * The map of arguments used to configure this DevEndpoint. + */ + Arguments?: MapValue; + } + export interface CreateGrokClassifierRequest { + /** + * An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on. + */ + Classification: Classification; + /** + * The name of the new classifier. + */ + Name: NameString; + /** + * The grok pattern used by this classifier. + */ + GrokPattern: GrokPattern; + /** + * Optional custom grok patterns used by this classifier. + */ + CustomPatterns?: CustomPatterns; + } + export interface CreateJobRequest { + /** + * The name you assign to this job definition. It must be unique in your account. + */ + Name: NameString; + /** + * Description of the job being defined. + */ + Description?: DescriptionString; + /** + * This field is reserved for future use. + */ + LogUri?: UriString; + /** + * The name or ARN of the IAM role associated with this job. + */ + Role: RoleString; + /** + * An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. + */ + ExecutionProperty?: ExecutionProperty; + /** + * The JobCommand that executes this job. + */ + Command: JobCommand; + /** + * The default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide. + */ + DefaultArguments?: GenericMap; + /** + * The connections used for this job. + */ + Connections?: ConnectionsList; + /** + * The maximum number of times to retry this job if it fails. + */ + MaxRetries?: MaxRetries; + /** + * This parameter is deprecated. Use MaxCapacity instead. 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 AWS Glue pricing page. + */ + AllocatedCapacity?: IntegerValue; + /** + * The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). + */ + Timeout?: Timeout; + /** + * The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. 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 AWS Glue pricing page. Do not set Max Capacity if using WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job: When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. + */ + MaxCapacity?: NullableDouble; + /** + * Specifies configuration properties of a job notification. + */ + NotificationProperty?: NotificationProperty; + /** + * The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. + */ + WorkerType?: WorkerType; + /** + * The number of workers of a defined workerType that are allocated when a job runs. The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. + */ + NumberOfWorkers?: NullableInteger; + /** + * The name of the SecurityConfiguration structure to be used with this job. + */ + SecurityConfiguration?: NameString; + /** + * The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide. + */ + Tags?: TagsMap; + } + export interface CreateJobResponse { + /** + * The unique name that was provided for this job definition. + */ + Name?: NameString; + } + export interface CreateJsonClassifierRequest { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers. + */ + JsonPath: JsonPath; + } + export interface CreatePartitionRequest { + /** + * The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID. + */ + CatalogId?: CatalogIdString; + /** + * The name of the metadata database in which the partition is to be created. + */ + DatabaseName: NameString; + /** + * The name of the metadata table in which the partition is to be created. + */ + TableName: NameString; + /** + * A PartitionInput structure defining the partition to be created. + */ + PartitionInput: PartitionInput; + } + export interface CreatePartitionResponse { + } + export interface CreateScriptRequest { + /** + * A list of the nodes in the DAG. + */ + DagNodes?: DagNodes; + /** + * A list of the edges in the DAG. + */ + DagEdges?: DagEdges; + /** + * The programming language of the resulting code from the DAG. + */ + Language?: Language; + } + export interface CreateScriptResponse { + /** + * The Python script generated from the DAG. + */ + PythonScript?: PythonScript; + /** + * The Scala code generated from the DAG. + */ + ScalaCode?: ScalaCode; + } + export interface CreateSecurityConfigurationRequest { + /** + * The name for the new security configuration. + */ + Name: NameString; + /** + * The encryption configuration for the new security configuration. + */ + EncryptionConfiguration: EncryptionConfiguration; + } + export interface CreateSecurityConfigurationResponse { + /** + * The name assigned to the new security configuration. + */ + Name?: NameString; + /** + * The time at which the new security configuration was created. + */ + CreatedTimestamp?: TimestampValue; + } + export interface CreateTableRequest { + /** + * The ID of the Data Catalog in which to create the Table. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * The TableInput object that defines the metadata table to create in the catalog. + */ + TableInput: TableInput; + } + export interface CreateTableResponse { + } + export interface CreateTriggerRequest { + /** + * The name of the trigger. + */ + Name: NameString; + /** + * The type of the new trigger. + */ + Type: TriggerType; + /** + * A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *). This field is required when the trigger type is SCHEDULED. + */ + Schedule?: GenericString; + /** + * A predicate to specify when the new trigger should fire. This field is required when the trigger type is CONDITIONAL. + */ + Predicate?: Predicate; + /** + * The actions initiated by this trigger when it fires. + */ + Actions: ActionList; + /** + * A description of the new trigger. + */ + Description?: DescriptionString; + /** + * Set to true to start SCHEDULED and CONDITIONAL triggers when created. True not supported for ON_DEMAND triggers. + */ + StartOnCreation?: BooleanValue; + /** + * The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide. + */ + Tags?: TagsMap; + } + export interface CreateTriggerResponse { + /** + * The name of the trigger. + */ + Name?: NameString; + } + export interface CreateUserDefinedFunctionRequest { + /** + * The ID of the Data Catalog in which to create the function. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database in which to create the function. + */ + DatabaseName: NameString; + /** + * A FunctionInput object that defines the function to create in the Data Catalog. + */ + FunctionInput: UserDefinedFunctionInput; + } + export interface CreateUserDefinedFunctionResponse { + } + export interface CreateXMLClassifierRequest { + /** + * An identifier of the data format that the classifier matches. + */ + Classification: Classification; + /** + * The name of the classifier. + */ + Name: NameString; + /** + * The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not). + */ + RowTag?: RowTag; + } + export type CronExpression = string; + export interface CsvClassifier { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * The time this classifier was registered. + */ + CreationTime?: Timestamp; + /** + * The time this classifier was last updated. + */ + LastUpdated?: Timestamp; + /** + * The version of this classifier. + */ + Version?: VersionId; + /** + * A custom symbol to denote what separates each column entry in the row. + */ + Delimiter?: CsvColumnDelimiter; + /** + * A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter. + */ + QuoteSymbol?: CsvQuoteSymbol; + /** + * Indicates whether the CSV file contains a header. + */ + ContainsHeader?: CsvHeaderOption; + /** + * A list of strings representing column names. + */ + Header?: CsvHeader; + /** + * Specifies not to trim values before identifying the type of column values. The default value is true. + */ + DisableValueTrimming?: NullableBoolean; + /** + * Enables the processing of files that contain only one column. + */ + AllowSingleColumn?: NullableBoolean; + } + export type CsvColumnDelimiter = string; + export type CsvHeader = NameString[]; + export type CsvHeaderOption = "UNKNOWN"|"PRESENT"|"ABSENT"|string; + export type CsvQuoteSymbol = string; + export type CustomPatterns = string; + export type DagEdges = CodeGenEdge[]; + export type DagNodes = CodeGenNode[]; + export interface DataCatalogEncryptionSettings { + /** + * Specifies the encryption-at-rest configuration for the Data Catalog. + */ + EncryptionAtRest?: EncryptionAtRest; + /** + * When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption. + */ + ConnectionPasswordEncryption?: ConnectionPasswordEncryption; + } + export interface Database { + /** + * Name of the database. For Hive compatibility, this is folded to lowercase when it is stored. + */ + Name: NameString; + /** + * Description of the database. + */ + Description?: DescriptionString; + /** + * The location of the database (for example, an HDFS path). + */ + LocationUri?: URI; + /** + * These key-value pairs define parameters and properties of the database. + */ + Parameters?: ParametersMap; + /** + * The time at which the metadata database was created in the catalog. + */ + CreateTime?: Timestamp; + } + export interface DatabaseInput { + /** + * Name of the database. For Hive compatibility, this is folded to lowercase when it is stored. + */ + Name: NameString; + /** + * Description of the database + */ + Description?: DescriptionString; + /** + * The location of the database (for example, an HDFS path). + */ + LocationUri?: URI; + /** + * Thes key-value pairs define parameters and properties of the database. + */ + Parameters?: ParametersMap; + } + export type DatabaseList = Database[]; + export type DatabaseName = string; + export type DeleteBehavior = "LOG"|"DELETE_FROM_DATABASE"|"DEPRECATE_IN_DATABASE"|string; + export interface DeleteClassifierRequest { + /** + * Name of the classifier to remove. + */ + Name: NameString; + } + export interface DeleteClassifierResponse { + } + export type DeleteConnectionNameList = NameString[]; + export interface DeleteConnectionRequest { + /** + * The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the connection to delete. + */ + ConnectionName: NameString; + } + export interface DeleteConnectionResponse { + } + export interface DeleteCrawlerRequest { + /** + * Name of the crawler to remove. + */ + Name: NameString; + } + export interface DeleteCrawlerResponse { + } + export interface DeleteDatabaseRequest { + /** + * The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the Database to delete. For Hive compatibility, this must be all lowercase. + */ + Name: NameString; + } + export interface DeleteDatabaseResponse { + } + export interface DeleteDevEndpointRequest { + /** + * The name of the DevEndpoint. + */ + EndpointName: GenericString; + } + export interface DeleteDevEndpointResponse { + } + export interface DeleteJobRequest { + /** + * The name of the job definition to delete. + */ + JobName: NameString; + } + export interface DeleteJobResponse { + /** + * The name of the job definition that was deleted. + */ + JobName?: NameString; + } + export interface DeletePartitionRequest { + /** + * The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database in which the table in question resides. + */ + DatabaseName: NameString; + /** + * The name of the table where the partition to be deleted is located. + */ + TableName: NameString; + /** + * The values that define the partition. + */ + PartitionValues: ValueStringList; + } + export interface DeletePartitionResponse { + } + export interface DeleteResourcePolicyRequest { + /** + * The hash value returned when this policy was set. + */ + PolicyHashCondition?: HashString; + } + export interface DeleteResourcePolicyResponse { + } + export interface DeleteSecurityConfigurationRequest { + /** + * The name of the security configuration to delete. + */ + Name: NameString; + } + export interface DeleteSecurityConfigurationResponse { + } + export interface DeleteTableRequest { + /** + * The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase. + */ + Name: NameString; + } + export interface DeleteTableResponse { + } + export interface DeleteTableVersionRequest { + /** + * The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * The name of the table. For Hive compatibility, this name is entirely lowercase. + */ + TableName: NameString; + /** + * The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1. + */ + VersionId: VersionString; + } + export interface DeleteTableVersionResponse { + } + export interface DeleteTriggerRequest { + /** + * The name of the trigger to delete. + */ + Name: NameString; + } + export interface DeleteTriggerResponse { + /** + * The name of the trigger that was deleted. + */ + Name?: NameString; + } + export interface DeleteUserDefinedFunctionRequest { + /** + * The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the function is located. + */ + DatabaseName: NameString; + /** + * The name of the function definition to be deleted. + */ + FunctionName: NameString; + } + export interface DeleteUserDefinedFunctionResponse { + } + export type DescriptionString = string; + export type DescriptionStringRemovable = string; + export interface DevEndpoint { + /** + * The name of the DevEndpoint. + */ + EndpointName?: GenericString; + /** + * The AWS ARN of the IAM role used in this DevEndpoint. + */ + RoleArn?: RoleArn; + /** + * A list of security group identifiers used in this DevEndpoint. + */ + SecurityGroupIds?: StringList; + /** + * The subnet ID for this DevEndpoint. + */ + SubnetId?: GenericString; + /** + * The YARN endpoint address used by this DevEndpoint. + */ + YarnEndpointAddress?: GenericString; + /** + * A private IP address to access the DevEndpoint within a VPC, if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your virtual private cloud (VPC). + */ + PrivateAddress?: GenericString; + /** + * The Apache Zeppelin port for the remote Apache Spark interpreter. + */ + ZeppelinRemoteSparkInterpreterPort?: IntegerValue; + /** + * The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-VPC (virtual private cloud) DevEndpoint. + */ + PublicAddress?: GenericString; + /** + * The current status of this DevEndpoint. + */ + Status?: GenericString; + /** + * The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint. + */ + NumberOfNodes?: IntegerValue; + /** + * The AWS availability zone where this DevEndpoint is located. + */ + AvailabilityZone?: GenericString; + /** + * The ID of the virtual private cloud (VPC) used by this DevEndpoint. + */ + VpcId?: GenericString; + /** + * Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma. Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported. + */ + ExtraPythonLibsS3Path?: GenericString; + /** + * Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint. Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint. + */ + ExtraJarsS3Path?: GenericString; + /** + * The reason for a current failure in this DevEndpoint. + */ + FailureReason?: GenericString; + /** + * The status of the last update. + */ + LastUpdateStatus?: GenericString; + /** + * The point in time at which this DevEndpoint was created. + */ + CreatedTimestamp?: TimestampValue; + /** + * The point in time at which this DevEndpoint was last modified. + */ + LastModifiedTimestamp?: TimestampValue; + /** + * The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys. + */ + PublicKey?: GenericString; + /** + * A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client. If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute. + */ + PublicKeys?: PublicKeysList; + /** + * The name of the SecurityConfiguration structure to be used with this DevEndpoint. + */ + SecurityConfiguration?: NameString; + /** + * A map of arguments used to configure the DevEndpoint. Note that currently, we only support "--enable-glue-datacatalog": "" as a valid argument. + */ + Arguments?: MapValue; + } + export interface DevEndpointCustomLibraries { + /** + * Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma. Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported. + */ + ExtraPythonLibsS3Path?: GenericString; + /** + * Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint. Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint. + */ + ExtraJarsS3Path?: GenericString; + } + export type DevEndpointList = DevEndpoint[]; + export type DevEndpointNameList = NameString[]; + export type DevEndpointNames = GenericString[]; + export interface DynamoDBTarget { + /** + * The name of the DynamoDB table to crawl. + */ + Path?: Path; + } + export type DynamoDBTargetList = DynamoDBTarget[]; + export interface EncryptionAtRest { + /** + * The encryption-at-rest mode for encrypting Data Catalog data. + */ + CatalogEncryptionMode: CatalogEncryptionMode; + /** + * The ID of the AWS KMS key to use for encryption at rest. + */ + SseAwsKmsKeyId?: NameString; + } + export interface EncryptionConfiguration { + /** + * The encryption configuration for S3 data. + */ + S3Encryption?: S3EncryptionList; + /** + * The encryption configuration for CloudWatch. + */ + CloudWatchEncryption?: CloudWatchEncryption; + /** + * The encryption configuration for Job Bookmarks. + */ + JobBookmarksEncryption?: JobBookmarksEncryption; + } + export type ErrorByName = {[key: string]: ErrorDetail}; + export interface ErrorDetail { + /** + * The code associated with this error. + */ + ErrorCode?: NameString; + /** + * A message describing the error. + */ + ErrorMessage?: DescriptionString; + } + export type ErrorString = string; + export interface ExecutionProperty { + /** + * 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. + */ + MaxConcurrentRuns?: MaxConcurrentRuns; + } + export type ExecutionTime = number; + export type ExistCondition = "MUST_EXIST"|"NOT_EXIST"|"NONE"|string; + export type FieldType = string; + export type FilterString = string; + export type FormatString = string; + export type GenericMap = {[key: string]: GenericString}; + export type GenericString = string; + export interface GetCatalogImportStatusRequest { + /** + * The ID of the catalog to migrate. Currently, this should be the AWS account ID. + */ + CatalogId?: CatalogIdString; + } + export interface GetCatalogImportStatusResponse { + /** + * The status of the specified catalog migration. + */ + ImportStatus?: CatalogImportStatus; + } + export interface GetClassifierRequest { + /** + * Name of the classifier to retrieve. + */ + Name: NameString; + } + export interface GetClassifierResponse { + /** + * The requested classifier. + */ + Classifier?: Classifier; + } + export interface GetClassifiersRequest { + /** + * Size of the list to return (optional). + */ + MaxResults?: PageSize; + /** + * An optional continuation token. + */ + NextToken?: Token; + } + export interface GetClassifiersResponse { + /** + * The requested list of classifier objects. + */ + Classifiers?: ClassifierList; + /** + * A continuation token. + */ + NextToken?: Token; + } + export interface GetConnectionRequest { + /** + * The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the connection definition to retrieve. + */ + Name: NameString; + /** + * Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties. + */ + HidePassword?: Boolean; + } + export interface GetConnectionResponse { + /** + * The requested connection definition. + */ + Connection?: Connection; + } + export interface GetConnectionsFilter { + /** + * A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned. + */ + MatchCriteria?: MatchCriteria; + /** + * The type of connections to return. Currently, only JDBC is supported; SFTP is not supported. + */ + ConnectionType?: ConnectionType; + } + export interface GetConnectionsRequest { + /** + * The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * A filter that controls which connections will be returned. + */ + Filter?: GetConnectionsFilter; + /** + * Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties. + */ + HidePassword?: Boolean; + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: Token; + /** + * The maximum number of connections to return in one response. + */ + MaxResults?: PageSize; + } + export interface GetConnectionsResponse { + /** + * A list of requested connection definitions. + */ + ConnectionList?: ConnectionList; + /** + * A continuation token, if the list of connections returned does not include the last of the filtered connections. + */ + NextToken?: Token; + } + export interface GetCrawlerMetricsRequest { + /** + * A list of the names of crawlers about which to retrieve metrics. + */ + CrawlerNameList?: CrawlerNameList; + /** + * The maximum size of a list to return. + */ + MaxResults?: PageSize; + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: Token; + } + export interface GetCrawlerMetricsResponse { + /** + * A list of metrics for the specified crawler. + */ + CrawlerMetricsList?: CrawlerMetricsList; + /** + * A continuation token, if the returned list does not contain the last metric available. + */ + NextToken?: Token; + } + export interface GetCrawlerRequest { + /** + * Name of the crawler to retrieve metadata for. + */ + Name: NameString; + } + export interface GetCrawlerResponse { + /** + * The metadata for the specified crawler. + */ + Crawler?: Crawler; + } + export interface GetCrawlersRequest { + /** + * The number of crawlers to return on each call. + */ + MaxResults?: PageSize; + /** + * A continuation token, if this is a continuation request. + */ + NextToken?: Token; + } + export interface GetCrawlersResponse { + /** + * A list of crawler metadata. + */ + Crawlers?: CrawlerList; + /** + * A continuation token, if the returned list has not reached the end of those defined in this customer account. + */ + NextToken?: Token; + } + export interface GetDataCatalogEncryptionSettingsRequest { + /** + * The ID of the Data Catalog for which to retrieve the security configuration. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + } + export interface GetDataCatalogEncryptionSettingsResponse { + /** + * The requested security configuration. + */ + DataCatalogEncryptionSettings?: DataCatalogEncryptionSettings; + } + export interface GetDatabaseRequest { + /** + * The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the database to retrieve. For Hive compatibility, this should be all lowercase. + */ + Name: NameString; + } + export interface GetDatabaseResponse { + /** + * The definition of the specified database in the catalog. + */ + Database?: Database; + } + export interface GetDatabasesRequest { + /** + * The ID of the Data Catalog from which to retrieve Databases. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: Token; + /** + * The maximum number of databases to return in one response. + */ + MaxResults?: PageSize; + } + export interface GetDatabasesResponse { + /** + * A list of Database objects from the specified catalog. + */ + DatabaseList: DatabaseList; + /** + * A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last. + */ + NextToken?: Token; + } + export interface GetDataflowGraphRequest { + /** + * The Python script to transform. + */ + PythonScript?: PythonScript; + } + export interface GetDataflowGraphResponse { + /** + * A list of the nodes in the resulting DAG. + */ + DagNodes?: DagNodes; + /** + * A list of the edges in the resulting DAG. + */ + DagEdges?: DagEdges; + } + export interface GetDevEndpointRequest { + /** + * Name of the DevEndpoint for which to retrieve information. + */ + EndpointName: GenericString; + } + export interface GetDevEndpointResponse { + /** + * A DevEndpoint definition. + */ + DevEndpoint?: DevEndpoint; + } + export interface GetDevEndpointsRequest { + /** + * The maximum size of information to return. + */ + MaxResults?: PageSize; + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: GenericString; + } + export interface GetDevEndpointsResponse { + /** + * A list of DevEndpoint definitions. + */ + DevEndpoints?: DevEndpointList; + /** + * A continuation token, if not all DevEndpoint definitions have yet been returned. + */ + NextToken?: GenericString; + } + export interface GetJobRequest { + /** + * The name of the job definition to retrieve. + */ + JobName: NameString; + } + export interface GetJobResponse { + /** + * The requested job definition. + */ + Job?: Job; + } + export interface GetJobRunRequest { + /** + * Name of the job definition being run. + */ + JobName: NameString; + /** + * The ID of the job run. + */ + RunId: IdString; + /** + * True if a list of predecessor runs should be returned. + */ + PredecessorsIncluded?: BooleanValue; + } + export interface GetJobRunResponse { + /** + * The requested job-run metadata. + */ + JobRun?: JobRun; + } + export interface GetJobRunsRequest { + /** + * The name of the job definition for which to retrieve all job runs. + */ + JobName: NameString; + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: GenericString; + /** + * The maximum size of the response. + */ + MaxResults?: PageSize; + } + export interface GetJobRunsResponse { + /** + * A list of job-run metatdata objects. + */ + JobRuns?: JobRunList; + /** + * A continuation token, if not all reequested job runs have been returned. + */ + NextToken?: GenericString; + } + export interface GetJobsRequest { + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: GenericString; + /** + * The maximum size of the response. + */ + MaxResults?: PageSize; + } + export interface GetJobsResponse { + /** + * A list of job definitions. + */ + Jobs?: JobList; + /** + * A continuation token, if not all job definitions have yet been returned. + */ + NextToken?: GenericString; + } + export interface GetMappingRequest { + /** + * Specifies the source table. + */ + Source: CatalogEntry; + /** + * A list of target tables. + */ + Sinks?: CatalogEntries; + /** + * Parameters for the mapping. + */ + Location?: Location; + } + export interface GetMappingResponse { + /** + * A list of mappings to the specified targets. + */ + Mapping: MappingList; + } + export interface GetPartitionRequest { + /** + * The ID of the Data Catalog where the partition in question resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the partition resides. + */ + DatabaseName: NameString; + /** + * The name of the partition's table. + */ + TableName: NameString; + /** + * The values that define the partition. + */ + PartitionValues: ValueStringList; + } + export interface GetPartitionResponse { + /** + * The requested information, in the form of a Partition object. + */ + Partition?: Partition; + } + export interface GetPartitionsRequest { + /** + * The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the partitions reside. + */ + DatabaseName: NameString; + /** + * The name of the partitions' table. + */ + TableName: NameString; + /** + * An expression filtering the partitions to be returned. The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression. Operators: The following are the operators that you can use in the Expression API call: = Checks if the values of the two operands are equal or not; if yes, then the condition becomes true. Example: Assume 'variable a' holds 10 and 'variable b' holds 20. (a = b) is not true. < > Checks if the values of two operands are equal or not; if the values are not equal, then the condition becomes true. Example: (a < > b) is true. > Checks if the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true. Example: (a > b) is not true. < Checks if the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true. Example: (a < b) is true. >= Checks if the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true. Example: (a >= b) is not true. <= Checks if the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true. Example: (a <= b) is true. AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL Logical operators. Supported Partition Key Types: The following are the the supported partition keys. string date timestamp int bigint long tinyint smallint decimal If an invalid type is encountered, an exception is thrown. The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions. Sample API Call: + */ + Expression?: PredicateString; + /** + * A continuation token, if this is not the first call to retrieve these partitions. + */ + NextToken?: Token; + /** + * The segment of the table's partitions to scan in this request. + */ + Segment?: Segment; + /** + * The maximum number of partitions to return in a single response. + */ + MaxResults?: PageSize; + } + export interface GetPartitionsResponse { + /** + * A list of requested partitions. + */ + Partitions?: PartitionList; + /** + * A continuation token, if the returned list of partitions does not does not include the last one. + */ + NextToken?: Token; + } + export interface GetPlanRequest { + /** + * The list of mappings from a source table to target tables. + */ + Mapping: MappingList; + /** + * The source table. + */ + Source: CatalogEntry; + /** + * The target tables. + */ + Sinks?: CatalogEntries; + /** + * Parameters for the mapping. + */ + Location?: Location; + /** + * The programming language of the code to perform the mapping. + */ + Language?: Language; + } + export interface GetPlanResponse { + /** + * A Python script to perform the mapping. + */ + PythonScript?: PythonScript; + /** + * Scala code to perform the mapping. + */ + ScalaCode?: ScalaCode; + } + export interface GetResourcePolicyRequest { + } + export interface GetResourcePolicyResponse { + /** + * Contains the requested policy document, in JSON format. + */ + PolicyInJson?: PolicyJsonString; + /** + * Contains the hash value associated with this policy. + */ + PolicyHash?: HashString; + /** + * The date and time at which the policy was created. + */ + CreateTime?: Timestamp; + /** + * The date and time at which the policy was last updated. + */ + UpdateTime?: Timestamp; + } + export interface GetSecurityConfigurationRequest { + /** + * The name of the security configuration to retrieve. + */ + Name: NameString; + } + export interface GetSecurityConfigurationResponse { + /** + * The requested security configuration + */ + SecurityConfiguration?: SecurityConfiguration; + } + export interface GetSecurityConfigurationsRequest { + /** + * The maximum number of results to return. + */ + MaxResults?: PageSize; + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: GenericString; + } + export interface GetSecurityConfigurationsResponse { + /** + * A list of security configurations. + */ + SecurityConfigurations?: SecurityConfigurationList; + /** + * A continuation token, if there are more security configurations to return. + */ + NextToken?: GenericString; + } + export interface GetTableRequest { + /** + * The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase. + */ + Name: NameString; + } + export interface GetTableResponse { + /** + * The Table object that defines the specified table. + */ + Table?: Table; + } + export interface GetTableVersionRequest { + /** + * The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * The name of the table. For Hive compatibility, this name is entirely lowercase. + */ + TableName: NameString; + /** + * The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1. + */ + VersionId?: VersionString; + } + export interface GetTableVersionResponse { + /** + * The requested table version. + */ + TableVersion?: TableVersion; + } + export type GetTableVersionsList = TableVersion[]; + export interface GetTableVersionsRequest { + /** + * The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * The name of the table. For Hive compatibility, this name is entirely lowercase. + */ + TableName: NameString; + /** + * A continuation token, if this is not the first call. + */ + NextToken?: Token; + /** + * The maximum number of table versions to return in one response. + */ + MaxResults?: PageSize; + } + export interface GetTableVersionsResponse { + /** + * A list of strings identifying available versions of the specified table. + */ + TableVersions?: GetTableVersionsList; + /** + * A continuation token, if the list of available versions does not include the last one. + */ + NextToken?: Token; + } + export interface GetTablesRequest { + /** + * The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * A regular expression pattern. If present, only those tables whose names match the pattern are returned. + */ + Expression?: FilterString; + /** + * A continuation token, included if this is a continuation call. + */ + NextToken?: Token; + /** + * The maximum number of tables to return in a single response. + */ + MaxResults?: PageSize; + } + export interface GetTablesResponse { + /** + * A list of the requested Table objects. + */ + TableList?: TableList; + /** + * A continuation token, present if the current list segment is not the last. + */ + NextToken?: Token; + } + export interface GetTagsRequest { + /** + * The Amazon ARN of the resource for which to retrieve tags. + */ + ResourceArn: GlueResourceArn; + } + export interface GetTagsResponse { + /** + * The requested tags. + */ + Tags?: TagsMap; + } + export interface GetTriggerRequest { + /** + * The name of the trigger to retrieve. + */ + Name: NameString; + } + export interface GetTriggerResponse { + /** + * The requested trigger definition. + */ + Trigger?: Trigger; + } + export interface GetTriggersRequest { + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: GenericString; + /** + * The name of the job for which to retrieve triggers. The trigger that can start this job will be returned, and if there is no such trigger, all triggers will be returned. + */ + DependentJobName?: NameString; + /** + * The maximum size of the response. + */ + MaxResults?: PageSize; + } + export interface GetTriggersResponse { + /** + * A list of triggers for the specified job. + */ + Triggers?: TriggerList; + /** + * A continuation token, if not all the requested triggers have yet been returned. + */ + NextToken?: GenericString; + } + export interface GetUserDefinedFunctionRequest { + /** + * The ID of the Data Catalog where the function to be retrieved is located. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the function is located. + */ + DatabaseName: NameString; + /** + * The name of the function. + */ + FunctionName: NameString; + } + export interface GetUserDefinedFunctionResponse { + /** + * The requested function definition. + */ + UserDefinedFunction?: UserDefinedFunction; + } + export interface GetUserDefinedFunctionsRequest { + /** + * The ID of the Data Catalog where the functions to be retrieved are located. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the functions are located. + */ + DatabaseName: NameString; + /** + * An optional function-name pattern string that filters the function definitions returned. + */ + Pattern: NameString; + /** + * A continuation token, if this is a continuation call. + */ + NextToken?: Token; + /** + * The maximum number of functions to return in one response. + */ + MaxResults?: PageSize; + } + export interface GetUserDefinedFunctionsResponse { + /** + * A list of requested function definitions. + */ + UserDefinedFunctions?: UserDefinedFunctionList; + /** + * A continuation token, if the list of functions returned does not include the last requested function. + */ + NextToken?: Token; + } + export type GlueResourceArn = string; + export interface GrokClassifier { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on. + */ + Classification: Classification; + /** + * The time this classifier was registered. + */ + CreationTime?: Timestamp; + /** + * The time this classifier was last updated. + */ + LastUpdated?: Timestamp; + /** + * The version of this classifier. + */ + Version?: VersionId; + /** + * The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifers. + */ + GrokPattern: GrokPattern; + /** + * Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifers. + */ + CustomPatterns?: CustomPatterns; + } + export type GrokPattern = string; + export type HashString = string; + export type IdString = string; + export interface ImportCatalogToGlueRequest { + /** + * The ID of the catalog to import. Currently, this should be the AWS account ID. + */ + CatalogId?: CatalogIdString; + } + export interface ImportCatalogToGlueResponse { + } + export type Integer = number; + export type IntegerFlag = number; + export type IntegerValue = number; + export interface JdbcTarget { + /** + * The name of the connection to use to connect to the JDBC target. + */ + ConnectionName?: ConnectionName; + /** + * The path of the JDBC target. + */ + Path?: Path; + /** + * A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler. + */ + Exclusions?: PathList; + } + export type JdbcTargetList = JdbcTarget[]; + export interface Job { + /** + * The name you assign to this job definition. + */ + Name?: NameString; + /** + * Description of the job being defined. + */ + Description?: DescriptionString; + /** + * This field is reserved for future use. + */ + LogUri?: UriString; + /** + * The name or ARN of the IAM role associated with this job. + */ + Role?: RoleString; + /** + * The time and date that this job definition was created. + */ + CreatedOn?: TimestampValue; + /** + * The last point in time when this job definition was modified. + */ + LastModifiedOn?: TimestampValue; + /** + * An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. + */ + ExecutionProperty?: ExecutionProperty; + /** + * The JobCommand that executes this job. + */ + Command?: JobCommand; + /** + * The default arguments for this job, specified as name-value pairs. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide. + */ + DefaultArguments?: GenericMap; + /** + * The connections used for this job. + */ + Connections?: ConnectionsList; + /** + * The maximum number of times to retry this job after a JobRun fails. + */ + MaxRetries?: MaxRetries; + /** + * This field is deprecated, use MaxCapacity instead. 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 AWS Glue pricing page. + */ + AllocatedCapacity?: IntegerValue; + /** + * The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). + */ + Timeout?: Timeout; + /** + * The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. 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 AWS Glue pricing page. Do not set Max Capacity if using WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job: When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. + */ + MaxCapacity?: NullableDouble; + /** + * The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. + */ + WorkerType?: WorkerType; + /** + * The number of workers of a defined workerType that are allocated when a job runs. The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. + */ + NumberOfWorkers?: NullableInteger; + /** + * The name of the SecurityConfiguration structure to be used with this job. + */ + SecurityConfiguration?: NameString; + /** + * Specifies configuration properties of a job notification. + */ + NotificationProperty?: NotificationProperty; + } + export interface JobBookmarkEntry { + /** + * Name of the job in question. + */ + JobName?: JobName; + /** + * Version of the job. + */ + Version?: IntegerValue; + /** + * The run ID number. + */ + Run?: IntegerValue; + /** + * The attempt ID number. + */ + Attempt?: IntegerValue; + /** + * The bookmark itself. + */ + JobBookmark?: JsonValue; + } + export interface JobBookmarksEncryption { + /** + * The encryption mode to use for Job bookmarks data. + */ + JobBookmarksEncryptionMode?: JobBookmarksEncryptionMode; + /** + * The AWS ARN of the KMS key to be used to encrypt the data. + */ + KmsKeyArn?: KmsKeyArn; + } + export type JobBookmarksEncryptionMode = "DISABLED"|"CSE-KMS"|string; + export interface JobCommand { + /** + * The name of the job command: this must be glueetl, for an Apache Spark ETL job, or pythonshell, for a Python shell job. + */ + Name?: GenericString; + /** + * Specifies the S3 path to a script that executes a job (required). + */ + ScriptLocation?: ScriptLocationString; + } + export type JobList = Job[]; + export type JobName = string; + export type JobNameList = NameString[]; + export interface JobRun { + /** + * The ID of this job run. + */ + Id?: IdString; + /** + * The number of the attempt to run this job. + */ + Attempt?: AttemptCount; + /** + * The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action. + */ + PreviousRunId?: IdString; + /** + * The name of the trigger that started this job run. + */ + TriggerName?: NameString; + /** + * The name of the job definition being used in this run. + */ + JobName?: NameString; + /** + * The date and time at which this job run was started. + */ + StartedOn?: TimestampValue; + /** + * The last time this job run was modified. + */ + LastModifiedOn?: TimestampValue; + /** + * The date and time this job run completed. + */ + CompletedOn?: TimestampValue; + /** + * The current state of the job run. + */ + JobRunState?: JobRunState; + /** + * The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide. + */ + Arguments?: GenericMap; + /** + * An error message associated with this job run. + */ + ErrorMessage?: ErrorString; + /** + * A list of predecessors to this job run. + */ + PredecessorRuns?: PredecessorList; + /** + * This field is deprecated, use MaxCapacity instead. 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 AWS Glue pricing page. + */ + AllocatedCapacity?: IntegerValue; + /** + * The amount of time (in seconds) that the job run consumed resources. + */ + ExecutionTime?: ExecutionTime; + /** + * The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job. + */ + Timeout?: Timeout; + /** + * The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. 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 AWS Glue pricing page. Do not set Max Capacity if using WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job: When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. + */ + MaxCapacity?: NullableDouble; + /** + * Specifies configuration properties of a job run notification. + */ + NotificationProperty?: NotificationProperty; + /** + * The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. + */ + WorkerType?: WorkerType; + /** + * The number of workers of a defined workerType that are allocated when a job runs. The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. + */ + NumberOfWorkers?: NullableInteger; + /** + * The name of the SecurityConfiguration structure to be used with this job run. + */ + SecurityConfiguration?: NameString; + /** + * The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration will be used to encrypt the log group. + */ + LogGroupName?: GenericString; + } + export type JobRunList = JobRun[]; + export type JobRunState = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED"|"TIMEOUT"|string; + export interface JobUpdate { + /** + * Description of the job being defined. + */ + Description?: DescriptionString; + /** + * This field is reserved for future use. + */ + LogUri?: UriString; + /** + * The name or ARN of the IAM role associated with this job (required). + */ + Role?: RoleString; + /** + * An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. + */ + ExecutionProperty?: ExecutionProperty; + /** + * The JobCommand that executes this job (required). + */ + Command?: JobCommand; + /** + * The default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide. + */ + DefaultArguments?: GenericMap; + /** + * The connections used for this job. + */ + Connections?: ConnectionsList; + /** + * The maximum number of times to retry this job if it fails. + */ + MaxRetries?: MaxRetries; + /** + * This field is deprecated. Use MaxCapacity instead. 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 AWS Glue pricing page. + */ + AllocatedCapacity?: IntegerValue; + /** + * The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). + */ + Timeout?: Timeout; + /** + * The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. 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 AWS Glue pricing page. Do not set Max Capacity if using WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job: When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. + */ + MaxCapacity?: NullableDouble; + /** + * The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. + */ + WorkerType?: WorkerType; + /** + * The number of workers of a defined workerType that are allocated when a job runs. The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. + */ + NumberOfWorkers?: NullableInteger; + /** + * The name of the SecurityConfiguration structure to be used with this job. + */ + SecurityConfiguration?: NameString; + /** + * Specifies configuration properties of a job notification. + */ + NotificationProperty?: NotificationProperty; + } + export interface JsonClassifier { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * The time this classifier was registered. + */ + CreationTime?: Timestamp; + /** + * The time this classifier was last updated. + */ + LastUpdated?: Timestamp; + /** + * The version of this classifier. + */ + Version?: VersionId; + /** + * A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers. + */ + JsonPath: JsonPath; + } + export type JsonPath = string; + export type JsonValue = string; + export type KeyString = string; + export type KmsKeyArn = string; + export type Language = "PYTHON"|"SCALA"|string; + export interface LastCrawlInfo { + /** + * Status of the last crawl. + */ + Status?: LastCrawlStatus; + /** + * If an error occurred, the error information about the last crawl. + */ + ErrorMessage?: DescriptionString; + /** + * The log group for the last crawl. + */ + LogGroup?: LogGroup; + /** + * The log stream for the last crawl. + */ + LogStream?: LogStream; + /** + * The prefix for a message about this crawl. + */ + MessagePrefix?: MessagePrefix; + /** + * The time at which the crawl started. + */ + StartTime?: Timestamp; + } + export type LastCrawlStatus = "SUCCEEDED"|"CANCELLED"|"FAILED"|string; + export interface ListCrawlersRequest { + /** + * The maximum size of a list to return. + */ + MaxResults?: PageSize; + /** + * A continuation token, if this is a continuation request. + */ + NextToken?: Token; + /** + * Specifies to return only these tagged resources. + */ + Tags?: TagsMap; + } + export interface ListCrawlersResponse { + /** + * The names of all crawlers in the account, or the crawlers with the specified tags. + */ + CrawlerNames?: CrawlerNameList; + /** + * A continuation token, if the returned list does not contain the last metric available. + */ + NextToken?: Token; + } + export interface ListDevEndpointsRequest { + /** + * A continuation token, if this is a continuation request. + */ + NextToken?: GenericString; + /** + * The maximum size of a list to return. + */ + MaxResults?: PageSize; + /** + * Specifies to return only these tagged resources. + */ + Tags?: TagsMap; + } + export interface ListDevEndpointsResponse { + /** + * The names of all DevEndpoints in the account, or the DevEndpoints with the specified tags. + */ + DevEndpointNames?: DevEndpointNameList; + /** + * A continuation token, if the returned list does not contain the last metric available. + */ + NextToken?: GenericString; + } + export interface ListJobsRequest { + /** + * A continuation token, if this is a continuation request. + */ + NextToken?: GenericString; + /** + * The maximum size of a list to return. + */ + MaxResults?: PageSize; + /** + * Specifies to return only these tagged resources. + */ + Tags?: TagsMap; + } + export interface ListJobsResponse { + /** + * The names of all jobs in the account, or the jobs with the specified tags. + */ + JobNames?: JobNameList; + /** + * A continuation token, if the returned list does not contain the last metric available. + */ + NextToken?: GenericString; + } + export interface ListTriggersRequest { + /** + * A continuation token, if this is a continuation request. + */ + NextToken?: GenericString; + /** + * The name of the job for which to retrieve triggers. The trigger that can start this job will be returned, and if there is no such trigger, all triggers will be returned. + */ + DependentJobName?: NameString; + /** + * The maximum size of a list to return. + */ + MaxResults?: PageSize; + /** + * Specifies to return only these tagged resources. + */ + Tags?: TagsMap; + } + export interface ListTriggersResponse { + /** + * The names of all triggers in the account, or the triggers with the specified tags. + */ + TriggerNames?: TriggerNameList; + /** + * A continuation token, if the returned list does not contain the last metric available. + */ + NextToken?: GenericString; + } + export interface Location { + /** + * A JDBC location. + */ + Jdbc?: CodeGenNodeArgs; + /** + * An Amazon S3 location. + */ + S3?: CodeGenNodeArgs; + /** + * A DynamoDB Table location. + */ + DynamoDB?: CodeGenNodeArgs; + } + export type LocationMap = {[key: string]: ColumnValuesString}; + export type LocationString = string; + export type LogGroup = string; + export type LogStream = string; + export type Logical = "AND"|"ANY"|string; + export type LogicalOperator = "EQUALS"|string; + export type MapValue = {[key: string]: GenericString}; + export interface MappingEntry { + /** + * The name of the source table. + */ + SourceTable?: TableName; + /** + * The source path. + */ + SourcePath?: SchemaPathString; + /** + * The source type. + */ + SourceType?: FieldType; + /** + * The target table. + */ + TargetTable?: TableName; + /** + * The target path. + */ + TargetPath?: SchemaPathString; + /** + * The target type. + */ + TargetType?: FieldType; + } + export type MappingList = MappingEntry[]; + export type MatchCriteria = NameString[]; + export type MaxConcurrentRuns = number; + export type MaxRetries = number; + export type MessagePrefix = string; + export type MillisecondsCount = number; + export type NameString = string; + export type NameStringList = NameString[]; + export type NonNegativeDouble = number; + export type NonNegativeInteger = number; + export interface NotificationProperty { + /** + * After a job run starts, the number of minutes to wait before sending a job run delay notification. + */ + NotifyDelayAfter?: NotifyDelayAfter; + } + export type NotifyDelayAfter = number; + export type NullableBoolean = boolean; + export type NullableDouble = number; + export type NullableInteger = number; + export interface Order { + /** + * The name of the column. + */ + Column: NameString; + /** + * Indicates that the column is sorted in ascending order (== 1), or in descending order (==0). + */ + SortOrder: IntegerFlag; + } + export type OrderList = Order[]; + export type PageSize = number; + export type ParametersMap = {[key: string]: ParametersMapValue}; + export type ParametersMapValue = string; + export interface Partition { + /** + * The values of the partition. + */ + Values?: ValueStringList; + /** + * The name of the catalog database where the table in question is located. + */ + DatabaseName?: NameString; + /** + * The name of the table in question. + */ + TableName?: NameString; + /** + * The time at which the partition was created. + */ + CreationTime?: Timestamp; + /** + * The last time at which the partition was accessed. + */ + LastAccessTime?: Timestamp; + /** + * Provides information about the physical location where the partition is stored. + */ + StorageDescriptor?: StorageDescriptor; + /** + * These key-value pairs define partition parameters. + */ + Parameters?: ParametersMap; + /** + * The last time at which column statistics were computed for this partition. + */ + LastAnalyzedTime?: Timestamp; + } + export interface PartitionError { + /** + * The values that define the partition. + */ + PartitionValues?: ValueStringList; + /** + * Details about the partition error. + */ + ErrorDetail?: ErrorDetail; + } + export type PartitionErrors = PartitionError[]; + export interface PartitionInput { + /** + * The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input. + */ + Values?: ValueStringList; + /** + * The last time at which the partition was accessed. + */ + LastAccessTime?: Timestamp; + /** + * Provides information about the physical location where the partition is stored. + */ + StorageDescriptor?: StorageDescriptor; + /** + * These key-value pairs define partition parameters. + */ + Parameters?: ParametersMap; + /** + * The last time at which column statistics were computed for this partition. + */ + LastAnalyzedTime?: Timestamp; + } + export type PartitionInputList = PartitionInput[]; + export type PartitionList = Partition[]; + export interface PartitionValueList { + /** + * The list of values. + */ + Values: ValueStringList; + } + export type Path = string; + export type PathList = Path[]; + export interface PhysicalConnectionRequirements { + /** + * The subnet ID used by the connection. + */ + SubnetId?: NameString; + /** + * The security group ID list used by the connection. + */ + SecurityGroupIdList?: SecurityGroupIdList; + /** + * The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future. + */ + AvailabilityZone?: NameString; + } + export type PolicyJsonString = string; + export interface Predecessor { + /** + * The name of the job definition used by the predecessor job run. + */ + JobName?: NameString; + /** + * The job-run ID of the predecessor job run. + */ + RunId?: IdString; + } + export type PredecessorList = Predecessor[]; + export interface Predicate { + /** + * Optional field if only one condition is listed. If multiple conditions are listed, then this field is required. + */ + Logical?: Logical; + /** + * A list of the conditions that determine when the trigger will fire. + */ + Conditions?: ConditionList; + } + export type PredicateString = string; + export type PrincipalType = "USER"|"ROLE"|"GROUP"|string; + export type PublicKeysList = GenericString[]; + export interface PutDataCatalogEncryptionSettingsRequest { + /** + * The ID of the Data Catalog for which to set the security configuration. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The security configuration to set. + */ + DataCatalogEncryptionSettings: DataCatalogEncryptionSettings; + } + export interface PutDataCatalogEncryptionSettingsResponse { + } + export interface PutResourcePolicyRequest { + /** + * Contains the policy document to set, in JSON format. + */ + PolicyInJson: PolicyJsonString; + /** + * The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set. + */ + PolicyHashCondition?: HashString; + /** + * A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call will not depend on the existence of a policy. + */ + PolicyExistsCondition?: ExistCondition; + } + export interface PutResourcePolicyResponse { + /** + * A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy. + */ + PolicyHash?: HashString; + } + export type PythonScript = string; + export interface ResetJobBookmarkRequest { + /** + * The name of the job in question. + */ + JobName: JobName; + } + export interface ResetJobBookmarkResponse { + /** + * The reset bookmark entry. + */ + JobBookmarkEntry?: JobBookmarkEntry; + } + export type ResourceType = "JAR"|"FILE"|"ARCHIVE"|string; + export interface ResourceUri { + /** + * The type of the resource. + */ + ResourceType?: ResourceType; + /** + * The URI for accessing the resource. + */ + Uri?: URI; + } + export type ResourceUriList = ResourceUri[]; + export type Role = string; + export type RoleArn = string; + export type RoleString = string; + export type RowTag = string; + export interface S3Encryption { + /** + * The encryption mode to use for S3 data. + */ + S3EncryptionMode?: S3EncryptionMode; + /** + * The AWS ARN of the KMS key to be used to encrypt the data. + */ + KmsKeyArn?: KmsKeyArn; + } + export type S3EncryptionList = S3Encryption[]; + export type S3EncryptionMode = "DISABLED"|"SSE-KMS"|"SSE-S3"|string; + export interface S3Target { + /** + * The path to the Amazon S3 target. + */ + Path?: Path; + /** + * A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler. + */ + Exclusions?: PathList; + } + export type S3TargetList = S3Target[]; + export type ScalaCode = string; + export interface Schedule { + /** + * A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *). + */ + ScheduleExpression?: CronExpression; + /** + * The state of the schedule. + */ + State?: ScheduleState; + } + export type ScheduleState = "SCHEDULED"|"NOT_SCHEDULED"|"TRANSITIONING"|string; + export interface SchemaChangePolicy { + /** + * The update behavior when the crawler finds a changed schema. + */ + UpdateBehavior?: UpdateBehavior; + /** + * The deletion behavior when the crawler finds a deleted object. + */ + DeleteBehavior?: DeleteBehavior; + } + export type SchemaPathString = string; + export type ScriptLocationString = string; + export interface SecurityConfiguration { + /** + * The name of the security configuration. + */ + Name?: NameString; + /** + * The time at which this security configuration was created. + */ + CreatedTimeStamp?: TimestampValue; + /** + * The encryption configuration associated with this security configuration. + */ + EncryptionConfiguration?: EncryptionConfiguration; + } + export type SecurityConfigurationList = SecurityConfiguration[]; + export type SecurityGroupIdList = NameString[]; + export interface Segment { + /** + * The zero-based index number of the this segment. For example, if the total number of segments is 4, SegmentNumber values will range from zero through three. + */ + SegmentNumber: NonNegativeInteger; + /** + * The total numer of segments. + */ + TotalSegments: TotalSegmentsInteger; + } + export interface SerDeInfo { + /** + * Name of the SerDe. + */ + Name?: NameString; + /** + * Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe. + */ + SerializationLibrary?: NameString; + /** + * These key-value pairs define initialization parameters for the SerDe. + */ + Parameters?: ParametersMap; + } + export interface SkewedInfo { + /** + * A list of names of columns that contain skewed values. + */ + SkewedColumnNames?: NameStringList; + /** + * A list of values that appear so frequently as to be considered skewed. + */ + SkewedColumnValues?: ColumnValueStringList; + /** + * A mapping of skewed values to the columns that contain them. + */ + SkewedColumnValueLocationMaps?: LocationMap; + } + export interface StartCrawlerRequest { + /** + * Name of the crawler to start. + */ + Name: NameString; + } + export interface StartCrawlerResponse { + } + export interface StartCrawlerScheduleRequest { + /** + * Name of the crawler to schedule. + */ + CrawlerName: NameString; + } + export interface StartCrawlerScheduleResponse { + } + export interface StartJobRunRequest { + /** + * The name of the job definition to use. + */ + JobName: NameString; + /** + * The ID of a previous JobRun to retry. + */ + JobRunId?: IdString; + /** + * The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide. + */ + Arguments?: GenericMap; + /** + * This field is deprecated, use MaxCapacity instead. 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 AWS Glue pricing page. + */ + AllocatedCapacity?: IntegerValue; + /** + * The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job. + */ + Timeout?: Timeout; + /** + * The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. 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 AWS Glue pricing page. Do not set Max Capacity if using WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job: When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. + */ + MaxCapacity?: NullableDouble; + /** + * The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. + */ + WorkerType?: WorkerType; + /** + * The number of workers of a defined workerType that are allocated when a job runs. The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X. + */ + NumberOfWorkers?: NullableInteger; + /** + * The name of the SecurityConfiguration structure to be used with this job run. + */ + SecurityConfiguration?: NameString; + /** + * Specifies configuration properties of a job run notification. + */ + NotificationProperty?: NotificationProperty; + } + export interface StartJobRunResponse { + /** + * The ID assigned to this job run. + */ + JobRunId?: IdString; + } + export interface StartTriggerRequest { + /** + * The name of the trigger to start. + */ + Name: NameString; + } + export interface StartTriggerResponse { + /** + * The name of the trigger that was started. + */ + Name?: NameString; + } + export interface StopCrawlerRequest { + /** + * Name of the crawler to stop. + */ + Name: NameString; + } + export interface StopCrawlerResponse { + } + export interface StopCrawlerScheduleRequest { + /** + * Name of the crawler whose schedule state to set. + */ + CrawlerName: NameString; + } + export interface StopCrawlerScheduleResponse { + } + export interface StopTriggerRequest { + /** + * The name of the trigger to stop. + */ + Name: NameString; + } + export interface StopTriggerResponse { + /** + * The name of the trigger that was stopped. + */ + Name?: NameString; + } + export interface StorageDescriptor { + /** + * A list of the Columns in the table. + */ + Columns?: ColumnList; + /** + * The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name. + */ + Location?: LocationString; + /** + * The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format. + */ + InputFormat?: FormatString; + /** + * The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format. + */ + OutputFormat?: FormatString; + /** + * True if the data in the table is compressed, or False if not. + */ + Compressed?: Boolean; + /** + * Must be specified if the table contains any dimension columns. + */ + NumberOfBuckets?: Integer; + /** + * Serialization/deserialization (SerDe) information. + */ + SerdeInfo?: SerDeInfo; + /** + * A list of reducer grouping columns, clustering columns, and bucketing columns in the table. + */ + BucketColumns?: NameStringList; + /** + * A list specifying the sort order of each bucket in the table. + */ + SortColumns?: OrderList; + /** + * User-supplied properties in key-value form. + */ + Parameters?: ParametersMap; + /** + * Information about values that appear very frequently in a column (skewed values). + */ + SkewedInfo?: SkewedInfo; + /** + * True if the table data is stored in subdirectories, or False if not. + */ + StoredAsSubDirectories?: Boolean; + } + export type StringList = GenericString[]; + export interface Table { + /** + * Name of the table. For Hive compatibility, this must be entirely lowercase. + */ + Name: NameString; + /** + * Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase. + */ + DatabaseName?: NameString; + /** + * Description of the table. + */ + Description?: DescriptionString; + /** + * Owner of the table. + */ + Owner?: NameString; + /** + * Time when the table definition was created in the Data Catalog. + */ + CreateTime?: Timestamp; + /** + * Last time the table was updated. + */ + UpdateTime?: Timestamp; + /** + * Last time the table was accessed. This is usually taken from HDFS, and may not be reliable. + */ + LastAccessTime?: Timestamp; + /** + * Last time column statistics were computed for this table. + */ + LastAnalyzedTime?: Timestamp; + /** + * Retention time for this table. + */ + Retention?: NonNegativeInteger; + /** + * A storage descriptor containing information about the physical storage of this table. + */ + StorageDescriptor?: StorageDescriptor; + /** + * A list of columns by which the table is partitioned. Only primitive types are supported as partition keys. When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example: "PartitionKeys": [] + */ + PartitionKeys?: ColumnList; + /** + * If the table is a view, the original text of the view; otherwise null. + */ + ViewOriginalText?: ViewTextString; + /** + * If the table is a view, the expanded text of the view; otherwise null. + */ + ViewExpandedText?: ViewTextString; + /** + * The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). + */ + TableType?: TableTypeString; + /** + * These key-value pairs define properties associated with the table. + */ + Parameters?: ParametersMap; + /** + * Person or entity who created the table. + */ + CreatedBy?: NameString; + } + export interface TableError { + /** + * Name of the table. For Hive compatibility, this must be entirely lowercase. + */ + TableName?: NameString; + /** + * Detail about the error. + */ + ErrorDetail?: ErrorDetail; + } + export type TableErrors = TableError[]; + export interface TableInput { + /** + * Name of the table. For Hive compatibility, this is folded to lowercase when it is stored. + */ + Name: NameString; + /** + * Description of the table. + */ + Description?: DescriptionString; + /** + * Owner of the table. + */ + Owner?: NameString; + /** + * Last time the table was accessed. + */ + LastAccessTime?: Timestamp; + /** + * Last time column statistics were computed for this table. + */ + LastAnalyzedTime?: Timestamp; + /** + * Retention time for this table. + */ + Retention?: NonNegativeInteger; + /** + * A storage descriptor containing information about the physical storage of this table. + */ + StorageDescriptor?: StorageDescriptor; + /** + * A list of columns by which the table is partitioned. Only primitive types are supported as partition keys. When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example: "PartitionKeys": [] + */ + PartitionKeys?: ColumnList; + /** + * If the table is a view, the original text of the view; otherwise null. + */ + ViewOriginalText?: ViewTextString; + /** + * If the table is a view, the expanded text of the view; otherwise null. + */ + ViewExpandedText?: ViewTextString; + /** + * The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). + */ + TableType?: TableTypeString; + /** + * These key-value pairs define properties associated with the table. + */ + Parameters?: ParametersMap; + } + export type TableList = Table[]; + export type TableName = string; + export type TablePrefix = string; + export type TableTypeString = string; + export interface TableVersion { + /** + * The table in question + */ + Table?: Table; + /** + * The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1. + */ + VersionId?: VersionString; + } + export interface TableVersionError { + /** + * The name of the table in question. + */ + TableName?: NameString; + /** + * The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1. + */ + VersionId?: VersionString; + /** + * Detail about the error. + */ + ErrorDetail?: ErrorDetail; + } + export type TableVersionErrors = TableVersionError[]; + export type TagKey = string; + export type TagKeysList = TagKey[]; + export interface TagResourceRequest { + /** + * The ARN of the AWS Glue resource to which to add the tags. For more information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern. + */ + ResourceArn: GlueResourceArn; + /** + * Tags to add to this resource. + */ + TagsToAdd: TagsMap; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type TagsMap = {[key: string]: TagValue}; + export type Timeout = number; + export type Timestamp = Date; + export type TimestampValue = Date; + export type Token = string; + export type TotalSegmentsInteger = number; + export interface Trigger { + /** + * Name of the trigger. + */ + Name?: NameString; + /** + * Reserved for future use. + */ + Id?: IdString; + /** + * The type of trigger that this is. + */ + Type?: TriggerType; + /** + * The current state of the trigger. + */ + State?: TriggerState; + /** + * A description of this trigger. + */ + Description?: DescriptionString; + /** + * A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *). + */ + Schedule?: GenericString; + /** + * The actions initiated by this trigger. + */ + Actions?: ActionList; + /** + * The predicate of this trigger, which defines when it will fire. + */ + Predicate?: Predicate; + } + export type TriggerList = Trigger[]; + export type TriggerNameList = NameString[]; + export type TriggerState = "CREATING"|"CREATED"|"ACTIVATING"|"ACTIVATED"|"DEACTIVATING"|"DEACTIVATED"|"DELETING"|"UPDATING"|string; + export type TriggerType = "SCHEDULED"|"CONDITIONAL"|"ON_DEMAND"|string; + export interface TriggerUpdate { + /** + * Reserved for future use. + */ + Name?: NameString; + /** + * A description of this trigger. + */ + Description?: DescriptionString; + /** + * A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *). + */ + Schedule?: GenericString; + /** + * The actions initiated by this trigger. + */ + Actions?: ActionList; + /** + * The predicate of this trigger, which defines when it will fire. + */ + Predicate?: Predicate; + } + export type URI = string; + export interface UntagResourceRequest { + /** + * The ARN of the resource from which to remove the tags. + */ + ResourceArn: GlueResourceArn; + /** + * Tags to remove from this resource. + */ + TagsToRemove: TagKeysList; + } + export interface UntagResourceResponse { + } + export type UpdateBehavior = "LOG"|"UPDATE_IN_DATABASE"|string; + export interface UpdateClassifierRequest { + /** + * A GrokClassifier object with updated fields. + */ + GrokClassifier?: UpdateGrokClassifierRequest; + /** + * An XMLClassifier object with updated fields. + */ + XMLClassifier?: UpdateXMLClassifierRequest; + /** + * A JsonClassifier object with updated fields. + */ + JsonClassifier?: UpdateJsonClassifierRequest; + /** + * A CsvClassifier object with updated fields. + */ + CsvClassifier?: UpdateCsvClassifierRequest; + } + export interface UpdateClassifierResponse { + } + export interface UpdateConnectionRequest { + /** + * The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the connection definition to update. + */ + Name: NameString; + /** + * A ConnectionInput object that redefines the connection in question. + */ + ConnectionInput: ConnectionInput; + } + export interface UpdateConnectionResponse { + } + export interface UpdateCrawlerRequest { + /** + * Name of the new crawler. + */ + Name: NameString; + /** + * The IAM role (or ARN of an IAM role) used by the new crawler to access customer resources. + */ + Role?: Role; + /** + * The AWS Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*. + */ + DatabaseName?: DatabaseName; + /** + * A description of the new crawler. + */ + Description?: DescriptionStringRemovable; + /** + * A list of targets to crawl. + */ + Targets?: CrawlerTargets; + /** + * A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *). + */ + Schedule?: CronExpression; + /** + * A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification. + */ + Classifiers?: ClassifierNameList; + /** + * The table prefix used for catalog tables that are created. + */ + TablePrefix?: TablePrefix; + /** + * Policy for the crawler's update and deletion behavior. + */ + SchemaChangePolicy?: SchemaChangePolicy; + /** + * Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler. + */ + Configuration?: CrawlerConfiguration; + /** + * The name of the SecurityConfiguration structure to be used by this Crawler. + */ + CrawlerSecurityConfiguration?: CrawlerSecurityConfiguration; + } + export interface UpdateCrawlerResponse { + } + export interface UpdateCrawlerScheduleRequest { + /** + * Name of the crawler whose schedule to update. + */ + CrawlerName: NameString; + /** + * The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *). + */ + Schedule?: CronExpression; + } + export interface UpdateCrawlerScheduleResponse { + } + export interface UpdateCsvClassifierRequest { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * A custom symbol to denote what separates each column entry in the row. + */ + Delimiter?: CsvColumnDelimiter; + /** + * A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter. + */ + QuoteSymbol?: CsvQuoteSymbol; + /** + * Indicates whether the CSV file contains a header. + */ + ContainsHeader?: CsvHeaderOption; + /** + * A list of strings representing column names. + */ + Header?: CsvHeader; + /** + * Specifies not to trim values before identifying the type of column values. The default value is true. + */ + DisableValueTrimming?: NullableBoolean; + /** + * Enables the processing of files that contain only one column. + */ + AllowSingleColumn?: NullableBoolean; + } + export interface UpdateDatabaseRequest { + /** + * The ID of the Data Catalog in which the metadata database resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase. + */ + Name: NameString; + /** + * A DatabaseInput object specifying the new definition of the metadata database in the catalog. + */ + DatabaseInput: DatabaseInput; + } + export interface UpdateDatabaseResponse { + } + export interface UpdateDevEndpointRequest { + /** + * The name of the DevEndpoint to be updated. + */ + EndpointName: GenericString; + /** + * The public key for the DevEndpoint to use. + */ + PublicKey?: GenericString; + /** + * The list of public keys for the DevEndpoint to use. + */ + AddPublicKeys?: PublicKeysList; + /** + * The list of public keys to be deleted from the DevEndpoint. + */ + DeletePublicKeys?: PublicKeysList; + /** + * Custom Python or Java libraries to be loaded in the DevEndpoint. + */ + CustomLibraries?: DevEndpointCustomLibraries; + /** + * True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False otherwise. + */ + UpdateEtlLibraries?: BooleanValue; + /** + * The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint. + */ + DeleteArguments?: StringList; + /** + * The map of arguments to add the map of arguments used to configure the DevEndpoint. + */ + AddArguments?: MapValue; + } + export interface UpdateDevEndpointResponse { + } + export interface UpdateGrokClassifierRequest { + /** + * The name of the GrokClassifier. + */ + Name: NameString; + /** + * An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on. + */ + Classification?: Classification; + /** + * The grok pattern used by this classifier. + */ + GrokPattern?: GrokPattern; + /** + * Optional custom grok patterns used by this classifier. + */ + CustomPatterns?: CustomPatterns; + } + export interface UpdateJobRequest { + /** + * Name of the job definition to update. + */ + JobName: NameString; + /** + * Specifies the values with which to update the job definition. + */ + JobUpdate: JobUpdate; + } + export interface UpdateJobResponse { + /** + * Returns the name of the updated job definition. + */ + JobName?: NameString; + } + export interface UpdateJsonClassifierRequest { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers. + */ + JsonPath?: JsonPath; + } + export interface UpdatePartitionRequest { + /** + * The ID of the Data Catalog where the partition to be updated resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database in which the table in question resides. + */ + DatabaseName: NameString; + /** + * The name of the table where the partition to be updated is located. + */ + TableName: NameString; + /** + * A list of the values defining the partition. + */ + PartitionValueList: BoundedPartitionValueList; + /** + * The new partition object to which to update the partition. + */ + PartitionInput: PartitionInput; + } + export interface UpdatePartitionResponse { + } + export interface UpdateTableRequest { + /** + * The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase. + */ + DatabaseName: NameString; + /** + * An updated TableInput object to define the metadata table in the catalog. + */ + TableInput: TableInput; + /** + * By default, UpdateTable always creates an archived version of the table before updating it. If skipArchive is set to true, however, UpdateTable does not create the archived version. + */ + SkipArchive?: BooleanNullable; + } + export interface UpdateTableResponse { + } + export interface UpdateTriggerRequest { + /** + * The name of the trigger to update. + */ + Name: NameString; + /** + * The new values with which to update the trigger. + */ + TriggerUpdate: TriggerUpdate; + } + export interface UpdateTriggerResponse { + /** + * The resulting trigger definition. + */ + Trigger?: Trigger; + } + export interface UpdateUserDefinedFunctionRequest { + /** + * The ID of the Data Catalog where the function to be updated is located. If none is supplied, the AWS account ID is used by default. + */ + CatalogId?: CatalogIdString; + /** + * The name of the catalog database where the function to be updated is located. + */ + DatabaseName: NameString; + /** + * The name of the function. + */ + FunctionName: NameString; + /** + * A FunctionInput object that re-defines the function in the Data Catalog. + */ + FunctionInput: UserDefinedFunctionInput; + } + export interface UpdateUserDefinedFunctionResponse { + } + export interface UpdateXMLClassifierRequest { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * An identifier of the data format that the classifier matches. + */ + Classification?: Classification; + /** + * The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not). + */ + RowTag?: RowTag; + } + export type UriString = string; + export interface UserDefinedFunction { + /** + * The name of the function. + */ + FunctionName?: NameString; + /** + * The Java class that contains the function code. + */ + ClassName?: NameString; + /** + * The owner of the function. + */ + OwnerName?: NameString; + /** + * The owner type. + */ + OwnerType?: PrincipalType; + /** + * The time at which the function was created. + */ + CreateTime?: Timestamp; + /** + * The resource URIs for the function. + */ + ResourceUris?: ResourceUriList; + } + export interface UserDefinedFunctionInput { + /** + * The name of the function. + */ + FunctionName?: NameString; + /** + * The Java class that contains the function code. + */ + ClassName?: NameString; + /** + * The owner of the function. + */ + OwnerName?: NameString; + /** + * The owner type. + */ + OwnerType?: PrincipalType; + /** + * The resource URIs for the function. + */ + ResourceUris?: ResourceUriList; + } + export type UserDefinedFunctionList = UserDefinedFunction[]; + export type ValueString = string; + export type ValueStringList = ValueString[]; + export type VersionId = number; + export type VersionString = string; + export type ViewTextString = string; + export type WorkerType = "Standard"|"G.1X"|"G.2X"|string; + export interface XMLClassifier { + /** + * The name of the classifier. + */ + Name: NameString; + /** + * An identifier of the data format that the classifier matches. + */ + Classification: Classification; + /** + * The time this classifier was registered. + */ + CreationTime?: Timestamp; + /** + * The time this classifier was last updated. + */ + LastUpdated?: Timestamp; + /** + * The version of this classifier. + */ + Version?: VersionId; + /** + * The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not). + */ + RowTag?: RowTag; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-03-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Glue client. + */ + export import Types = Glue; +} +export = Glue; diff --git a/node_modules/aws-sdk/clients/glue.js b/node_modules/aws-sdk/clients/glue.js new file mode 100644 index 0000000..c2efdd8 --- /dev/null +++ b/node_modules/aws-sdk/clients/glue.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['glue'] = {}; +AWS.Glue = Service.defineService('glue', ['2017-03-31']); +Object.defineProperty(apiLoader.services['glue'], '2017-03-31', { + get: function get() { + var model = require('../apis/glue-2017-03-31.min.json'); + model.paginators = require('../apis/glue-2017-03-31.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Glue; diff --git a/node_modules/aws-sdk/clients/greengrass.d.ts b/node_modules/aws-sdk/clients/greengrass.d.ts new file mode 100644 index 0000000..6955bd7 --- /dev/null +++ b/node_modules/aws-sdk/clients/greengrass.d.ts @@ -0,0 +1,3634 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Greengrass extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Greengrass.Types.ClientConfiguration) + config: Config & Greengrass.Types.ClientConfiguration; + /** + * Associates a role with a group. Your 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. + */ + associateRoleToGroup(params: Greengrass.Types.AssociateRoleToGroupRequest, callback?: (err: AWSError, data: Greengrass.Types.AssociateRoleToGroupResponse) => void): Request; + /** + * Associates a role with a group. Your 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. + */ + associateRoleToGroup(callback?: (err: AWSError, data: Greengrass.Types.AssociateRoleToGroupResponse) => void): Request; + /** + * Associates a role with your account. AWS IoT 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''. + */ + associateServiceRoleToAccount(params: Greengrass.Types.AssociateServiceRoleToAccountRequest, callback?: (err: AWSError, data: Greengrass.Types.AssociateServiceRoleToAccountResponse) => void): Request; + /** + * Associates a role with your account. AWS IoT 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''. + */ + associateServiceRoleToAccount(callback?: (err: AWSError, data: Greengrass.Types.AssociateServiceRoleToAccountResponse) => void): Request; + /** + * Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time. + */ + createConnectorDefinition(params: Greengrass.Types.CreateConnectorDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateConnectorDefinitionResponse) => void): Request; + /** + * Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time. + */ + createConnectorDefinition(callback?: (err: AWSError, data: Greengrass.Types.CreateConnectorDefinitionResponse) => void): Request; + /** + * Creates a version of a connector definition which has already been defined. + */ + createConnectorDefinitionVersion(params: Greengrass.Types.CreateConnectorDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateConnectorDefinitionVersionResponse) => void): Request; + /** + * Creates a version of a connector definition which has already been defined. + */ + createConnectorDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateConnectorDefinitionVersionResponse) => void): Request; + /** + * Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core. + */ + createCoreDefinition(params: Greengrass.Types.CreateCoreDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateCoreDefinitionResponse) => void): Request; + /** + * Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core. + */ + createCoreDefinition(callback?: (err: AWSError, data: Greengrass.Types.CreateCoreDefinitionResponse) => void): Request; + /** + * Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core. + */ + createCoreDefinitionVersion(params: Greengrass.Types.CreateCoreDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateCoreDefinitionVersionResponse) => void): Request; + /** + * Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core. + */ + createCoreDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateCoreDefinitionVersionResponse) => void): Request; + /** + * Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters. + */ + createDeployment(params: Greengrass.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateDeploymentResponse) => void): Request; + /** + * Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters. + */ + createDeployment(callback?: (err: AWSError, data: Greengrass.Types.CreateDeploymentResponse) => void): Request; + /** + * Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time. + */ + createDeviceDefinition(params: Greengrass.Types.CreateDeviceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateDeviceDefinitionResponse) => void): Request; + /** + * Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time. + */ + createDeviceDefinition(callback?: (err: AWSError, data: Greengrass.Types.CreateDeviceDefinitionResponse) => void): Request; + /** + * Creates a version of a device definition that has already been defined. + */ + createDeviceDefinitionVersion(params: Greengrass.Types.CreateDeviceDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateDeviceDefinitionVersionResponse) => void): Request; + /** + * Creates a version of a device definition that has already been defined. + */ + createDeviceDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateDeviceDefinitionVersionResponse) => void): Request; + /** + * 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. + */ + createFunctionDefinition(params: Greengrass.Types.CreateFunctionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateFunctionDefinitionResponse) => void): Request; + /** + * 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. + */ + createFunctionDefinition(callback?: (err: AWSError, data: Greengrass.Types.CreateFunctionDefinitionResponse) => void): Request; + /** + * Creates a version of a Lambda function definition that has already been defined. + */ + createFunctionDefinitionVersion(params: Greengrass.Types.CreateFunctionDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateFunctionDefinitionVersionResponse) => void): Request; + /** + * Creates a version of a Lambda function definition that has already been defined. + */ + createFunctionDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateFunctionDefinitionVersionResponse) => void): Request; + /** + * Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups. + */ + createGroup(params: Greengrass.Types.CreateGroupRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateGroupResponse) => void): Request; + /** + * Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups. + */ + createGroup(callback?: (err: AWSError, data: Greengrass.Types.CreateGroupResponse) => void): Request; + /** + * Creates a CA for the group. If a CA already exists, it will rotate the existing CA. + */ + createGroupCertificateAuthority(params: Greengrass.Types.CreateGroupCertificateAuthorityRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateGroupCertificateAuthorityResponse) => void): Request; + /** + * Creates a CA for the group. If a CA already exists, it will rotate the existing CA. + */ + createGroupCertificateAuthority(callback?: (err: AWSError, data: Greengrass.Types.CreateGroupCertificateAuthorityResponse) => void): Request; + /** + * Creates a version of a group which has already been defined. + */ + createGroupVersion(params: Greengrass.Types.CreateGroupVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateGroupVersionResponse) => void): Request; + /** + * Creates a version of a group which has already been defined. + */ + createGroupVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateGroupVersionResponse) => void): Request; + /** + * Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time. + */ + createLoggerDefinition(params: Greengrass.Types.CreateLoggerDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateLoggerDefinitionResponse) => void): Request; + /** + * Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time. + */ + createLoggerDefinition(callback?: (err: AWSError, data: Greengrass.Types.CreateLoggerDefinitionResponse) => void): Request; + /** + * Creates a version of a logger definition that has already been defined. + */ + createLoggerDefinitionVersion(params: Greengrass.Types.CreateLoggerDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateLoggerDefinitionVersionResponse) => void): Request; + /** + * Creates a version of a logger definition that has already been defined. + */ + createLoggerDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateLoggerDefinitionVersionResponse) => void): Request; + /** + * 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. + */ + createResourceDefinition(params: Greengrass.Types.CreateResourceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateResourceDefinitionResponse) => void): Request; + /** + * 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. + */ + createResourceDefinition(callback?: (err: AWSError, data: Greengrass.Types.CreateResourceDefinitionResponse) => void): Request; + /** + * Creates a version of a resource definition that has already been defined. + */ + createResourceDefinitionVersion(params: Greengrass.Types.CreateResourceDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateResourceDefinitionVersionResponse) => void): Request; + /** + * Creates a version of a resource definition that has already been defined. + */ + createResourceDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateResourceDefinitionVersionResponse) => void): Request; + /** + * 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. + */ + createSoftwareUpdateJob(params: Greengrass.Types.CreateSoftwareUpdateJobRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateSoftwareUpdateJobResponse) => void): Request; + /** + * 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. + */ + createSoftwareUpdateJob(callback?: (err: AWSError, data: Greengrass.Types.CreateSoftwareUpdateJobResponse) => void): Request; + /** + * Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time. + */ + createSubscriptionDefinition(params: Greengrass.Types.CreateSubscriptionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateSubscriptionDefinitionResponse) => void): Request; + /** + * Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time. + */ + createSubscriptionDefinition(callback?: (err: AWSError, data: Greengrass.Types.CreateSubscriptionDefinitionResponse) => void): Request; + /** + * Creates a version of a subscription definition which has already been defined. + */ + createSubscriptionDefinitionVersion(params: Greengrass.Types.CreateSubscriptionDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.CreateSubscriptionDefinitionVersionResponse) => void): Request; + /** + * Creates a version of a subscription definition which has already been defined. + */ + createSubscriptionDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.CreateSubscriptionDefinitionVersionResponse) => void): Request; + /** + * Add tags to a resource. + */ + tagResource(params: Greengrass.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Add tags to a resource. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a connector definition. + */ + deleteConnectorDefinition(params: Greengrass.Types.DeleteConnectorDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteConnectorDefinitionResponse) => void): Request; + /** + * Deletes a connector definition. + */ + deleteConnectorDefinition(callback?: (err: AWSError, data: Greengrass.Types.DeleteConnectorDefinitionResponse) => void): Request; + /** + * Deletes a core definition. + */ + deleteCoreDefinition(params: Greengrass.Types.DeleteCoreDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteCoreDefinitionResponse) => void): Request; + /** + * Deletes a core definition. + */ + deleteCoreDefinition(callback?: (err: AWSError, data: Greengrass.Types.DeleteCoreDefinitionResponse) => void): Request; + /** + * Deletes a device definition. + */ + deleteDeviceDefinition(params: Greengrass.Types.DeleteDeviceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteDeviceDefinitionResponse) => void): Request; + /** + * Deletes a device definition. + */ + deleteDeviceDefinition(callback?: (err: AWSError, data: Greengrass.Types.DeleteDeviceDefinitionResponse) => void): Request; + /** + * Deletes a Lambda function definition. + */ + deleteFunctionDefinition(params: Greengrass.Types.DeleteFunctionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteFunctionDefinitionResponse) => void): Request; + /** + * Deletes a Lambda function definition. + */ + deleteFunctionDefinition(callback?: (err: AWSError, data: Greengrass.Types.DeleteFunctionDefinitionResponse) => void): Request; + /** + * Deletes a group. + */ + deleteGroup(params: Greengrass.Types.DeleteGroupRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteGroupResponse) => void): Request; + /** + * Deletes a group. + */ + deleteGroup(callback?: (err: AWSError, data: Greengrass.Types.DeleteGroupResponse) => void): Request; + /** + * Deletes a logger definition. + */ + deleteLoggerDefinition(params: Greengrass.Types.DeleteLoggerDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteLoggerDefinitionResponse) => void): Request; + /** + * Deletes a logger definition. + */ + deleteLoggerDefinition(callback?: (err: AWSError, data: Greengrass.Types.DeleteLoggerDefinitionResponse) => void): Request; + /** + * Deletes a resource definition. + */ + deleteResourceDefinition(params: Greengrass.Types.DeleteResourceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteResourceDefinitionResponse) => void): Request; + /** + * Deletes a resource definition. + */ + deleteResourceDefinition(callback?: (err: AWSError, data: Greengrass.Types.DeleteResourceDefinitionResponse) => void): Request; + /** + * Deletes a subscription definition. + */ + deleteSubscriptionDefinition(params: Greengrass.Types.DeleteSubscriptionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.DeleteSubscriptionDefinitionResponse) => void): Request; + /** + * Deletes a subscription definition. + */ + deleteSubscriptionDefinition(callback?: (err: AWSError, data: Greengrass.Types.DeleteSubscriptionDefinitionResponse) => void): Request; + /** + * Remove tags with specified keys from a resource. + */ + untagResource(params: Greengrass.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove tags with specified keys from a resource. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates the role from a group. + */ + disassociateRoleFromGroup(params: Greengrass.Types.DisassociateRoleFromGroupRequest, callback?: (err: AWSError, data: Greengrass.Types.DisassociateRoleFromGroupResponse) => void): Request; + /** + * Disassociates the role from a group. + */ + disassociateRoleFromGroup(callback?: (err: AWSError, data: Greengrass.Types.DisassociateRoleFromGroupResponse) => void): Request; + /** + * Disassociates the service role from your account. Without a service role, deployments will not work. + */ + disassociateServiceRoleFromAccount(params: Greengrass.Types.DisassociateServiceRoleFromAccountRequest, callback?: (err: AWSError, data: Greengrass.Types.DisassociateServiceRoleFromAccountResponse) => void): Request; + /** + * Disassociates the service role from your account. Without a service role, deployments will not work. + */ + disassociateServiceRoleFromAccount(callback?: (err: AWSError, data: Greengrass.Types.DisassociateServiceRoleFromAccountResponse) => void): Request; + /** + * Retrieves the role associated with a particular group. + */ + getAssociatedRole(params: Greengrass.Types.GetAssociatedRoleRequest, callback?: (err: AWSError, data: Greengrass.Types.GetAssociatedRoleResponse) => void): Request; + /** + * Retrieves the role associated with a particular group. + */ + getAssociatedRole(callback?: (err: AWSError, data: Greengrass.Types.GetAssociatedRoleResponse) => void): Request; + /** + * Returns the status of a bulk deployment. + */ + getBulkDeploymentStatus(params: Greengrass.Types.GetBulkDeploymentStatusRequest, callback?: (err: AWSError, data: Greengrass.Types.GetBulkDeploymentStatusResponse) => void): Request; + /** + * Returns the status of a bulk deployment. + */ + getBulkDeploymentStatus(callback?: (err: AWSError, data: Greengrass.Types.GetBulkDeploymentStatusResponse) => void): Request; + /** + * Retrieves the connectivity information for a core. + */ + getConnectivityInfo(params: Greengrass.Types.GetConnectivityInfoRequest, callback?: (err: AWSError, data: Greengrass.Types.GetConnectivityInfoResponse) => void): Request; + /** + * Retrieves the connectivity information for a core. + */ + getConnectivityInfo(callback?: (err: AWSError, data: Greengrass.Types.GetConnectivityInfoResponse) => void): Request; + /** + * Retrieves information about a connector definition. + */ + getConnectorDefinition(params: Greengrass.Types.GetConnectorDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetConnectorDefinitionResponse) => void): Request; + /** + * Retrieves information about a connector definition. + */ + getConnectorDefinition(callback?: (err: AWSError, data: Greengrass.Types.GetConnectorDefinitionResponse) => void): Request; + /** + * Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services. + */ + getConnectorDefinitionVersion(params: Greengrass.Types.GetConnectorDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetConnectorDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services. + */ + getConnectorDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.GetConnectorDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a core definition version. + */ + getCoreDefinition(params: Greengrass.Types.GetCoreDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetCoreDefinitionResponse) => void): Request; + /** + * Retrieves information about a core definition version. + */ + getCoreDefinition(callback?: (err: AWSError, data: Greengrass.Types.GetCoreDefinitionResponse) => void): Request; + /** + * Retrieves information about a core definition version. + */ + getCoreDefinitionVersion(params: Greengrass.Types.GetCoreDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetCoreDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a core definition version. + */ + getCoreDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.GetCoreDefinitionVersionResponse) => void): Request; + /** + * Returns the status of a deployment. + */ + getDeploymentStatus(params: Greengrass.Types.GetDeploymentStatusRequest, callback?: (err: AWSError, data: Greengrass.Types.GetDeploymentStatusResponse) => void): Request; + /** + * Returns the status of a deployment. + */ + getDeploymentStatus(callback?: (err: AWSError, data: Greengrass.Types.GetDeploymentStatusResponse) => void): Request; + /** + * Retrieves information about a device definition. + */ + getDeviceDefinition(params: Greengrass.Types.GetDeviceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetDeviceDefinitionResponse) => void): Request; + /** + * Retrieves information about a device definition. + */ + getDeviceDefinition(callback?: (err: AWSError, data: Greengrass.Types.GetDeviceDefinitionResponse) => void): Request; + /** + * Retrieves information about a device definition version. + */ + getDeviceDefinitionVersion(params: Greengrass.Types.GetDeviceDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetDeviceDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a device definition version. + */ + getDeviceDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.GetDeviceDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a Lambda function definition, including its creation time and latest version. + */ + getFunctionDefinition(params: Greengrass.Types.GetFunctionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetFunctionDefinitionResponse) => void): Request; + /** + * Retrieves information about a Lambda function definition, including its creation time and latest version. + */ + getFunctionDefinition(callback?: (err: AWSError, data: Greengrass.Types.GetFunctionDefinitionResponse) => void): Request; + /** + * Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations. + */ + getFunctionDefinitionVersion(params: Greengrass.Types.GetFunctionDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetFunctionDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations. + */ + getFunctionDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.GetFunctionDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a group. + */ + getGroup(params: Greengrass.Types.GetGroupRequest, callback?: (err: AWSError, data: Greengrass.Types.GetGroupResponse) => void): Request; + /** + * Retrieves information about a group. + */ + getGroup(callback?: (err: AWSError, data: Greengrass.Types.GetGroupResponse) => void): Request; + /** + * Retreives the CA associated with a group. Returns the public key of the CA. + */ + getGroupCertificateAuthority(params: Greengrass.Types.GetGroupCertificateAuthorityRequest, callback?: (err: AWSError, data: Greengrass.Types.GetGroupCertificateAuthorityResponse) => void): Request; + /** + * Retreives the CA associated with a group. Returns the public key of the CA. + */ + getGroupCertificateAuthority(callback?: (err: AWSError, data: Greengrass.Types.GetGroupCertificateAuthorityResponse) => void): Request; + /** + * Retrieves the current configuration for the CA used by the group. + */ + getGroupCertificateConfiguration(params: Greengrass.Types.GetGroupCertificateConfigurationRequest, callback?: (err: AWSError, data: Greengrass.Types.GetGroupCertificateConfigurationResponse) => void): Request; + /** + * Retrieves the current configuration for the CA used by the group. + */ + getGroupCertificateConfiguration(callback?: (err: AWSError, data: Greengrass.Types.GetGroupCertificateConfigurationResponse) => void): Request; + /** + * Retrieves information about a group version. + */ + getGroupVersion(params: Greengrass.Types.GetGroupVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetGroupVersionResponse) => void): Request; + /** + * Retrieves information about a group version. + */ + getGroupVersion(callback?: (err: AWSError, data: Greengrass.Types.GetGroupVersionResponse) => void): Request; + /** + * Retrieves information about a logger definition. + */ + getLoggerDefinition(params: Greengrass.Types.GetLoggerDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetLoggerDefinitionResponse) => void): Request; + /** + * Retrieves information about a logger definition. + */ + getLoggerDefinition(callback?: (err: AWSError, data: Greengrass.Types.GetLoggerDefinitionResponse) => void): Request; + /** + * Retrieves information about a logger definition version. + */ + getLoggerDefinitionVersion(params: Greengrass.Types.GetLoggerDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetLoggerDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a logger definition version. + */ + getLoggerDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.GetLoggerDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a resource definition, including its creation time and latest version. + */ + getResourceDefinition(params: Greengrass.Types.GetResourceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetResourceDefinitionResponse) => void): Request; + /** + * Retrieves information about a resource definition, including its creation time and latest version. + */ + getResourceDefinition(callback?: (err: AWSError, data: Greengrass.Types.GetResourceDefinitionResponse) => void): Request; + /** + * Retrieves information about a resource definition version, including which resources are included in the version. + */ + getResourceDefinitionVersion(params: Greengrass.Types.GetResourceDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetResourceDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a resource definition version, including which resources are included in the version. + */ + getResourceDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.GetResourceDefinitionVersionResponse) => void): Request; + /** + * Retrieves the service role that is attached to your account. + */ + getServiceRoleForAccount(params: Greengrass.Types.GetServiceRoleForAccountRequest, callback?: (err: AWSError, data: Greengrass.Types.GetServiceRoleForAccountResponse) => void): Request; + /** + * Retrieves the service role that is attached to your account. + */ + getServiceRoleForAccount(callback?: (err: AWSError, data: Greengrass.Types.GetServiceRoleForAccountResponse) => void): Request; + /** + * Retrieves information about a subscription definition. + */ + getSubscriptionDefinition(params: Greengrass.Types.GetSubscriptionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetSubscriptionDefinitionResponse) => void): Request; + /** + * Retrieves information about a subscription definition. + */ + getSubscriptionDefinition(callback?: (err: AWSError, data: Greengrass.Types.GetSubscriptionDefinitionResponse) => void): Request; + /** + * Retrieves information about a subscription definition version. + */ + getSubscriptionDefinitionVersion(params: Greengrass.Types.GetSubscriptionDefinitionVersionRequest, callback?: (err: AWSError, data: Greengrass.Types.GetSubscriptionDefinitionVersionResponse) => void): Request; + /** + * Retrieves information about a subscription definition version. + */ + getSubscriptionDefinitionVersion(callback?: (err: AWSError, data: Greengrass.Types.GetSubscriptionDefinitionVersionResponse) => void): Request; + /** + * Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status. + */ + listBulkDeploymentDetailedReports(params: Greengrass.Types.ListBulkDeploymentDetailedReportsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListBulkDeploymentDetailedReportsResponse) => void): Request; + /** + * Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status. + */ + listBulkDeploymentDetailedReports(callback?: (err: AWSError, data: Greengrass.Types.ListBulkDeploymentDetailedReportsResponse) => void): Request; + /** + * Returns a list of bulk deployments. + */ + listBulkDeployments(params: Greengrass.Types.ListBulkDeploymentsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListBulkDeploymentsResponse) => void): Request; + /** + * Returns a list of bulk deployments. + */ + listBulkDeployments(callback?: (err: AWSError, data: Greengrass.Types.ListBulkDeploymentsResponse) => void): Request; + /** + * Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services. + */ + listConnectorDefinitionVersions(params: Greengrass.Types.ListConnectorDefinitionVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListConnectorDefinitionVersionsResponse) => void): Request; + /** + * Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services. + */ + listConnectorDefinitionVersions(callback?: (err: AWSError, data: Greengrass.Types.ListConnectorDefinitionVersionsResponse) => void): Request; + /** + * Retrieves a list of connector definitions. + */ + listConnectorDefinitions(params: Greengrass.Types.ListConnectorDefinitionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListConnectorDefinitionsResponse) => void): Request; + /** + * Retrieves a list of connector definitions. + */ + listConnectorDefinitions(callback?: (err: AWSError, data: Greengrass.Types.ListConnectorDefinitionsResponse) => void): Request; + /** + * Lists the versions of a core definition. + */ + listCoreDefinitionVersions(params: Greengrass.Types.ListCoreDefinitionVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListCoreDefinitionVersionsResponse) => void): Request; + /** + * Lists the versions of a core definition. + */ + listCoreDefinitionVersions(callback?: (err: AWSError, data: Greengrass.Types.ListCoreDefinitionVersionsResponse) => void): Request; + /** + * Retrieves a list of core definitions. + */ + listCoreDefinitions(params: Greengrass.Types.ListCoreDefinitionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListCoreDefinitionsResponse) => void): Request; + /** + * Retrieves a list of core definitions. + */ + listCoreDefinitions(callback?: (err: AWSError, data: Greengrass.Types.ListCoreDefinitionsResponse) => void): Request; + /** + * Returns a history of deployments for the group. + */ + listDeployments(params: Greengrass.Types.ListDeploymentsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListDeploymentsResponse) => void): Request; + /** + * Returns a history of deployments for the group. + */ + listDeployments(callback?: (err: AWSError, data: Greengrass.Types.ListDeploymentsResponse) => void): Request; + /** + * Lists the versions of a device definition. + */ + listDeviceDefinitionVersions(params: Greengrass.Types.ListDeviceDefinitionVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListDeviceDefinitionVersionsResponse) => void): Request; + /** + * Lists the versions of a device definition. + */ + listDeviceDefinitionVersions(callback?: (err: AWSError, data: Greengrass.Types.ListDeviceDefinitionVersionsResponse) => void): Request; + /** + * Retrieves a list of device definitions. + */ + listDeviceDefinitions(params: Greengrass.Types.ListDeviceDefinitionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListDeviceDefinitionsResponse) => void): Request; + /** + * Retrieves a list of device definitions. + */ + listDeviceDefinitions(callback?: (err: AWSError, data: Greengrass.Types.ListDeviceDefinitionsResponse) => void): Request; + /** + * Lists the versions of a Lambda function definition. + */ + listFunctionDefinitionVersions(params: Greengrass.Types.ListFunctionDefinitionVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListFunctionDefinitionVersionsResponse) => void): Request; + /** + * Lists the versions of a Lambda function definition. + */ + listFunctionDefinitionVersions(callback?: (err: AWSError, data: Greengrass.Types.ListFunctionDefinitionVersionsResponse) => void): Request; + /** + * Retrieves a list of Lambda function definitions. + */ + listFunctionDefinitions(params: Greengrass.Types.ListFunctionDefinitionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListFunctionDefinitionsResponse) => void): Request; + /** + * Retrieves a list of Lambda function definitions. + */ + listFunctionDefinitions(callback?: (err: AWSError, data: Greengrass.Types.ListFunctionDefinitionsResponse) => void): Request; + /** + * Retrieves the current CAs for a group. + */ + listGroupCertificateAuthorities(params: Greengrass.Types.ListGroupCertificateAuthoritiesRequest, callback?: (err: AWSError, data: Greengrass.Types.ListGroupCertificateAuthoritiesResponse) => void): Request; + /** + * Retrieves the current CAs for a group. + */ + listGroupCertificateAuthorities(callback?: (err: AWSError, data: Greengrass.Types.ListGroupCertificateAuthoritiesResponse) => void): Request; + /** + * Lists the versions of a group. + */ + listGroupVersions(params: Greengrass.Types.ListGroupVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListGroupVersionsResponse) => void): Request; + /** + * Lists the versions of a group. + */ + listGroupVersions(callback?: (err: AWSError, data: Greengrass.Types.ListGroupVersionsResponse) => void): Request; + /** + * Retrieves a list of groups. + */ + listGroups(params: Greengrass.Types.ListGroupsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListGroupsResponse) => void): Request; + /** + * Retrieves a list of groups. + */ + listGroups(callback?: (err: AWSError, data: Greengrass.Types.ListGroupsResponse) => void): Request; + /** + * Lists the versions of a logger definition. + */ + listLoggerDefinitionVersions(params: Greengrass.Types.ListLoggerDefinitionVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListLoggerDefinitionVersionsResponse) => void): Request; + /** + * Lists the versions of a logger definition. + */ + listLoggerDefinitionVersions(callback?: (err: AWSError, data: Greengrass.Types.ListLoggerDefinitionVersionsResponse) => void): Request; + /** + * Retrieves a list of logger definitions. + */ + listLoggerDefinitions(params: Greengrass.Types.ListLoggerDefinitionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListLoggerDefinitionsResponse) => void): Request; + /** + * Retrieves a list of logger definitions. + */ + listLoggerDefinitions(callback?: (err: AWSError, data: Greengrass.Types.ListLoggerDefinitionsResponse) => void): Request; + /** + * Lists the versions of a resource definition. + */ + listResourceDefinitionVersions(params: Greengrass.Types.ListResourceDefinitionVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListResourceDefinitionVersionsResponse) => void): Request; + /** + * Lists the versions of a resource definition. + */ + listResourceDefinitionVersions(callback?: (err: AWSError, data: Greengrass.Types.ListResourceDefinitionVersionsResponse) => void): Request; + /** + * Retrieves a list of resource definitions. + */ + listResourceDefinitions(params: Greengrass.Types.ListResourceDefinitionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListResourceDefinitionsResponse) => void): Request; + /** + * Retrieves a list of resource definitions. + */ + listResourceDefinitions(callback?: (err: AWSError, data: Greengrass.Types.ListResourceDefinitionsResponse) => void): Request; + /** + * Lists the versions of a subscription definition. + */ + listSubscriptionDefinitionVersions(params: Greengrass.Types.ListSubscriptionDefinitionVersionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListSubscriptionDefinitionVersionsResponse) => void): Request; + /** + * Lists the versions of a subscription definition. + */ + listSubscriptionDefinitionVersions(callback?: (err: AWSError, data: Greengrass.Types.ListSubscriptionDefinitionVersionsResponse) => void): Request; + /** + * Retrieves a list of subscription definitions. + */ + listSubscriptionDefinitions(params: Greengrass.Types.ListSubscriptionDefinitionsRequest, callback?: (err: AWSError, data: Greengrass.Types.ListSubscriptionDefinitionsResponse) => void): Request; + /** + * Retrieves a list of subscription definitions. + */ + listSubscriptionDefinitions(callback?: (err: AWSError, data: Greengrass.Types.ListSubscriptionDefinitionsResponse) => void): Request; + /** + * Retrieves the tags for a resource. + */ + listTagsForResource(params: Greengrass.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Greengrass.Types.ListTagsForResourceResponse) => void): Request; + /** + * Retrieves the tags for a resource. + */ + listTagsForResource(callback?: (err: AWSError, data: Greengrass.Types.ListTagsForResourceResponse) => void): Request; + /** + * Resets a group's deployments. + */ + resetDeployments(params: Greengrass.Types.ResetDeploymentsRequest, callback?: (err: AWSError, data: Greengrass.Types.ResetDeploymentsResponse) => void): Request; + /** + * Resets a group's deployments. + */ + resetDeployments(callback?: (err: AWSError, data: Greengrass.Types.ResetDeploymentsResponse) => void): Request; + /** + * Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters. + */ + startBulkDeployment(params: Greengrass.Types.StartBulkDeploymentRequest, callback?: (err: AWSError, data: Greengrass.Types.StartBulkDeploymentResponse) => void): Request; + /** + * Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters. + */ + startBulkDeployment(callback?: (err: AWSError, data: Greengrass.Types.StartBulkDeploymentResponse) => void): Request; + /** + * Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments. + */ + stopBulkDeployment(params: Greengrass.Types.StopBulkDeploymentRequest, callback?: (err: AWSError, data: Greengrass.Types.StopBulkDeploymentResponse) => void): Request; + /** + * Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments. + */ + stopBulkDeployment(callback?: (err: AWSError, data: Greengrass.Types.StopBulkDeploymentResponse) => void): Request; + /** + * Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it. + */ + updateConnectivityInfo(params: Greengrass.Types.UpdateConnectivityInfoRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateConnectivityInfoResponse) => void): Request; + /** + * Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it. + */ + updateConnectivityInfo(callback?: (err: AWSError, data: Greengrass.Types.UpdateConnectivityInfoResponse) => void): Request; + /** + * Updates a connector definition. + */ + updateConnectorDefinition(params: Greengrass.Types.UpdateConnectorDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateConnectorDefinitionResponse) => void): Request; + /** + * Updates a connector definition. + */ + updateConnectorDefinition(callback?: (err: AWSError, data: Greengrass.Types.UpdateConnectorDefinitionResponse) => void): Request; + /** + * Updates a core definition. + */ + updateCoreDefinition(params: Greengrass.Types.UpdateCoreDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateCoreDefinitionResponse) => void): Request; + /** + * Updates a core definition. + */ + updateCoreDefinition(callback?: (err: AWSError, data: Greengrass.Types.UpdateCoreDefinitionResponse) => void): Request; + /** + * Updates a device definition. + */ + updateDeviceDefinition(params: Greengrass.Types.UpdateDeviceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateDeviceDefinitionResponse) => void): Request; + /** + * Updates a device definition. + */ + updateDeviceDefinition(callback?: (err: AWSError, data: Greengrass.Types.UpdateDeviceDefinitionResponse) => void): Request; + /** + * Updates a Lambda function definition. + */ + updateFunctionDefinition(params: Greengrass.Types.UpdateFunctionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateFunctionDefinitionResponse) => void): Request; + /** + * Updates a Lambda function definition. + */ + updateFunctionDefinition(callback?: (err: AWSError, data: Greengrass.Types.UpdateFunctionDefinitionResponse) => void): Request; + /** + * Updates a group. + */ + updateGroup(params: Greengrass.Types.UpdateGroupRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateGroupResponse) => void): Request; + /** + * Updates a group. + */ + updateGroup(callback?: (err: AWSError, data: Greengrass.Types.UpdateGroupResponse) => void): Request; + /** + * Updates the Certificate expiry time for a group. + */ + updateGroupCertificateConfiguration(params: Greengrass.Types.UpdateGroupCertificateConfigurationRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateGroupCertificateConfigurationResponse) => void): Request; + /** + * Updates the Certificate expiry time for a group. + */ + updateGroupCertificateConfiguration(callback?: (err: AWSError, data: Greengrass.Types.UpdateGroupCertificateConfigurationResponse) => void): Request; + /** + * Updates a logger definition. + */ + updateLoggerDefinition(params: Greengrass.Types.UpdateLoggerDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateLoggerDefinitionResponse) => void): Request; + /** + * Updates a logger definition. + */ + updateLoggerDefinition(callback?: (err: AWSError, data: Greengrass.Types.UpdateLoggerDefinitionResponse) => void): Request; + /** + * Updates a resource definition. + */ + updateResourceDefinition(params: Greengrass.Types.UpdateResourceDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateResourceDefinitionResponse) => void): Request; + /** + * Updates a resource definition. + */ + updateResourceDefinition(callback?: (err: AWSError, data: Greengrass.Types.UpdateResourceDefinitionResponse) => void): Request; + /** + * Updates a subscription definition. + */ + updateSubscriptionDefinition(params: Greengrass.Types.UpdateSubscriptionDefinitionRequest, callback?: (err: AWSError, data: Greengrass.Types.UpdateSubscriptionDefinitionResponse) => void): Request; + /** + * Updates a subscription definition. + */ + updateSubscriptionDefinition(callback?: (err: AWSError, data: Greengrass.Types.UpdateSubscriptionDefinitionResponse) => void): Request; +} +declare namespace Greengrass { + export interface AssociateRoleToGroupRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + /** + * The ARN of the role you wish to associate with this group. + */ + RoleArn?: __string; + } + export interface AssociateRoleToGroupResponse { + /** + * The time, in milliseconds since the epoch, when the role ARN was associated with the group. + */ + AssociatedAt?: __string; + } + export interface AssociateServiceRoleToAccountRequest { + /** + * The ARN of the service role you wish to associate with your account. + */ + RoleArn?: __string; + } + export interface AssociateServiceRoleToAccountResponse { + /** + * The time when the service role was associated with the account. + */ + AssociatedAt?: __string; + } + export interface BulkDeployment { + /** + * The ARN of the bulk deployment. + */ + BulkDeploymentArn?: __string; + /** + * The ID of the bulk deployment. + */ + BulkDeploymentId?: __string; + /** + * The time, in ISO format, when the deployment was created. + */ + CreatedAt?: __string; + } + export interface BulkDeploymentMetrics { + /** + * The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version. + */ + InvalidInputRecords?: __integer; + /** + * The total number of group records from the input file that have been processed so far, or attempted. + */ + RecordsProcessed?: __integer; + /** + * The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to five times. + */ + RetryAttempts?: __integer; + } + export interface BulkDeploymentResult { + /** + * The time, in ISO format, when the deployment was created. + */ + CreatedAt?: __string; + /** + * The ARN of the group deployment. + */ + DeploymentArn?: __string; + /** + * The ID of the group deployment. + */ + DeploymentId?: __string; + /** + * The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''. + */ + DeploymentStatus?: __string; + /** + * The type of the deployment. + */ + DeploymentType?: DeploymentType; + /** + * Details about the error. + */ + ErrorDetails?: ErrorDetails; + /** + * The error message for a failed deployment + */ + ErrorMessage?: __string; + /** + * The ARN of the Greengrass group. + */ + GroupArn?: __string; + } + export type BulkDeploymentResults = BulkDeploymentResult[]; + export type BulkDeploymentStatus = "Initializing"|"Running"|"Completed"|"Stopping"|"Stopped"|"Failed"|string; + export type BulkDeployments = BulkDeployment[]; + export interface ConnectivityInfo { + /** + * The endpoint for the Greengrass core. Can be an IP address or DNS. + */ + HostAddress?: __string; + /** + * The ID of the connectivity information. + */ + Id?: __string; + /** + * Metadata for this endpoint. + */ + Metadata?: __string; + /** + * The port of the Greengrass core. Usually 8883. + */ + PortNumber?: __integer; + } + export interface Connector { + /** + * The ARN of the connector. + */ + ConnectorArn?: __string; + /** + * A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+. + */ + Id?: __string; + /** + * The parameters or configuration that the connector uses. + */ + Parameters?: __mapOf__string; + } + export interface ConnectorDefinitionVersion { + /** + * A list of references to connectors in this version, with their corresponding configuration settings. + */ + Connectors?: __listOfConnector; + } + export interface Core { + /** + * The ARN of the certificate associated with the core. + */ + CertificateArn?: __string; + /** + * A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. + */ + Id?: __string; + /** + * If true, the core's local shadow is automatically synced with the cloud. + */ + SyncShadow?: __boolean; + /** + * The ARN of the thing which is the core. + */ + ThingArn?: __string; + } + export interface CoreDefinitionVersion { + /** + * A list of cores in the core definition version. + */ + Cores?: __listOfCore; + } + export interface CreateConnectorDefinitionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the connector definition. + */ + InitialVersion?: ConnectorDefinitionVersion; + /** + * The name of the connector definition. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateConnectorDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateConnectorDefinitionVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the connector definition. + */ + ConnectorDefinitionId: __string; + /** + * A list of references to connectors in this version, with their corresponding configuration settings. + */ + Connectors?: __listOfConnector; + } + export interface CreateConnectorDefinitionVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface CreateCoreDefinitionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the core definition. + */ + InitialVersion?: CoreDefinitionVersion; + /** + * The name of the core definition. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateCoreDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateCoreDefinitionVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the core definition. + */ + CoreDefinitionId: __string; + /** + * A list of cores in the core definition version. + */ + Cores?: __listOfCore; + } + export interface CreateCoreDefinitionVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface CreateDeploymentRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the deployment if you wish to redeploy a previous deployment. + */ + DeploymentId?: __string; + /** + * The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid. + */ + DeploymentType?: DeploymentType; + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + /** + * The ID of the group version to be deployed. + */ + GroupVersionId?: __string; + } + export interface CreateDeploymentResponse { + /** + * The ARN of the deployment. + */ + DeploymentArn?: __string; + /** + * The ID of the deployment. + */ + DeploymentId?: __string; + } + export interface CreateDeviceDefinitionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the device definition. + */ + InitialVersion?: DeviceDefinitionVersion; + /** + * The name of the device definition. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateDeviceDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateDeviceDefinitionVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the device definition. + */ + DeviceDefinitionId: __string; + /** + * A list of devices in the definition version. + */ + Devices?: __listOfDevice; + } + export interface CreateDeviceDefinitionVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface CreateFunctionDefinitionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the function definition. + */ + InitialVersion?: FunctionDefinitionVersion; + /** + * The name of the function definition. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateFunctionDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateFunctionDefinitionVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings. + */ + DefaultConfig?: FunctionDefaultConfig; + /** + * The ID of the Lambda function definition. + */ + FunctionDefinitionId: __string; + /** + * A list of Lambda functions in this function definition version. + */ + Functions?: __listOfFunction; + } + export interface CreateFunctionDefinitionVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface CreateGroupCertificateAuthorityRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface CreateGroupCertificateAuthorityResponse { + /** + * The ARN of the group certificate authority. + */ + GroupCertificateAuthorityArn?: __string; + } + export interface CreateGroupRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the group. + */ + InitialVersion?: GroupVersion; + /** + * The name of the group. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateGroupResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateGroupVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ARN of the connector definition version for this group. + */ + ConnectorDefinitionVersionArn?: __string; + /** + * The ARN of the core definition version for this group. + */ + CoreDefinitionVersionArn?: __string; + /** + * The ARN of the device definition version for this group. + */ + DeviceDefinitionVersionArn?: __string; + /** + * The ARN of the function definition version for this group. + */ + FunctionDefinitionVersionArn?: __string; + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + /** + * The ARN of the logger definition version for this group. + */ + LoggerDefinitionVersionArn?: __string; + /** + * The ARN of the resource definition version for this group. + */ + ResourceDefinitionVersionArn?: __string; + /** + * The ARN of the subscription definition version for this group. + */ + SubscriptionDefinitionVersionArn?: __string; + } + export interface CreateGroupVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface CreateLoggerDefinitionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the logger definition. + */ + InitialVersion?: LoggerDefinitionVersion; + /** + * The name of the logger definition. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateLoggerDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateLoggerDefinitionVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the logger definition. + */ + LoggerDefinitionId: __string; + /** + * A list of loggers. + */ + Loggers?: __listOfLogger; + } + export interface CreateLoggerDefinitionVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface CreateResourceDefinitionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the resource definition. + */ + InitialVersion?: ResourceDefinitionVersion; + /** + * The name of the resource definition. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateResourceDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateResourceDefinitionVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the resource definition. + */ + ResourceDefinitionId: __string; + /** + * A list of resources. + */ + Resources?: __listOfResource; + } + export interface CreateResourceDefinitionVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface CreateSoftwareUpdateJobRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + S3UrlSignerRole?: S3UrlSignerRole; + SoftwareToUpdate?: SoftwareToUpdate; + UpdateAgentLogLevel?: UpdateAgentLogLevel; + UpdateTargets?: UpdateTargets; + UpdateTargetsArchitecture?: UpdateTargetsArchitecture; + UpdateTargetsOperatingSystem?: UpdateTargetsOperatingSystem; + } + export interface CreateSoftwareUpdateJobResponse { + /** + * The IoT Job ARN corresponding to this update. + */ + IotJobArn?: __string; + /** + * The IoT Job Id corresponding to this update. + */ + IotJobId?: __string; + } + export interface CreateSubscriptionDefinitionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * Information about the initial version of the subscription definition. + */ + InitialVersion?: SubscriptionDefinitionVersion; + /** + * The name of the subscription definition. + */ + Name?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface CreateSubscriptionDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface CreateSubscriptionDefinitionVersionRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ID of the subscription definition. + */ + SubscriptionDefinitionId: __string; + /** + * A list of subscriptions. + */ + Subscriptions?: __listOfSubscription; + } + export interface CreateSubscriptionDefinitionVersionResponse { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArn: __string; + /** + * A map of the key-value pairs for the resource tag. + */ + tags: __mapOf__string; + } + export interface DefinitionInformation { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + Tags?: Tags; + } + export interface DeleteConnectorDefinitionRequest { + /** + * The ID of the connector definition. + */ + ConnectorDefinitionId: __string; + } + export interface DeleteConnectorDefinitionResponse { + } + export interface DeleteCoreDefinitionRequest { + /** + * The ID of the core definition. + */ + CoreDefinitionId: __string; + } + export interface DeleteCoreDefinitionResponse { + } + export interface DeleteDeviceDefinitionRequest { + /** + * The ID of the device definition. + */ + DeviceDefinitionId: __string; + } + export interface DeleteDeviceDefinitionResponse { + } + export interface DeleteFunctionDefinitionRequest { + /** + * The ID of the Lambda function definition. + */ + FunctionDefinitionId: __string; + } + export interface DeleteFunctionDefinitionResponse { + } + export interface DeleteGroupRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface DeleteGroupResponse { + } + export interface DeleteLoggerDefinitionRequest { + /** + * The ID of the logger definition. + */ + LoggerDefinitionId: __string; + } + export interface DeleteLoggerDefinitionResponse { + } + export interface DeleteResourceDefinitionRequest { + /** + * The ID of the resource definition. + */ + ResourceDefinitionId: __string; + } + export interface DeleteResourceDefinitionResponse { + } + export interface DeleteSubscriptionDefinitionRequest { + /** + * The ID of the subscription definition. + */ + SubscriptionDefinitionId: __string; + } + export interface DeleteSubscriptionDefinitionResponse { + } + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArn: __string; + /** + * A list of the keys to remove from the resource tags. + */ + TagKeys: __listOf__string; + } + export interface Deployment { + /** + * The time, in milliseconds since the epoch, when the deployment was created. + */ + CreatedAt?: __string; + /** + * The ARN of the deployment. + */ + DeploymentArn?: __string; + /** + * The ID of the deployment. + */ + DeploymentId?: __string; + /** + * The type of the deployment. + */ + DeploymentType?: DeploymentType; + /** + * The ARN of the group for this deployment. + */ + GroupArn?: __string; + } + export type DeploymentType = "NewDeployment"|"Redeployment"|"ResetDeployment"|"ForceResetDeployment"|string; + export type Deployments = Deployment[]; + export interface Device { + /** + * The ARN of the certificate associated with the device. + */ + CertificateArn?: __string; + /** + * A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. + */ + Id?: __string; + /** + * If true, the device's local shadow will be automatically synced with the cloud. + */ + SyncShadow?: __boolean; + /** + * The thing ARN of the device. + */ + ThingArn?: __string; + } + export interface DeviceDefinitionVersion { + /** + * A list of devices in the definition version. + */ + Devices?: __listOfDevice; + } + export interface DisassociateRoleFromGroupRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface DisassociateRoleFromGroupResponse { + /** + * The time, in milliseconds since the epoch, when the role was disassociated from the group. + */ + DisassociatedAt?: __string; + } + export interface DisassociateServiceRoleFromAccountRequest { + } + export interface DisassociateServiceRoleFromAccountResponse { + /** + * The time when the service role was disassociated from the account. + */ + DisassociatedAt?: __string; + } + export type EncodingType = "binary"|"json"|string; + export interface ErrorDetail { + /** + * A detailed error code. + */ + DetailedErrorCode?: __string; + /** + * A detailed error message. + */ + DetailedErrorMessage?: __string; + } + export type ErrorDetails = ErrorDetail[]; + export interface Function { + /** + * The ARN of the Lambda function. + */ + FunctionArn?: __string; + /** + * The configuration of the Lambda function. + */ + FunctionConfiguration?: FunctionConfiguration; + /** + * A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. + */ + Id?: __string; + } + export interface FunctionConfiguration { + /** + * The expected encoding type of the input payload for the function. The default is ''json''. + */ + EncodingType?: EncodingType; + /** + * The environment configuration of the function. + */ + Environment?: FunctionConfigurationEnvironment; + /** + * The execution arguments. + */ + ExecArgs?: __string; + /** + * The name of the function executable. + */ + Executable?: __string; + /** + * The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization. + */ + MemorySize?: __integer; + /** + * True if the function is pinned. Pinned means the function is long-lived and starts when the core starts. + */ + Pinned?: __boolean; + /** + * The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request. + */ + Timeout?: __integer; + } + export interface FunctionConfigurationEnvironment { + /** + * 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. This setting applies only when you run the Lambda function in a Greengrass container. + */ + AccessSysfs?: __boolean; + /** + * Configuration related to executing the Lambda function + */ + Execution?: FunctionExecutionConfig; + /** + * 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. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container. + */ + ResourceAccessPolicies?: __listOfResourceAccessPolicy; + /** + * Environment variables for the Lambda function's configuration. + */ + Variables?: __mapOf__string; + } + export interface FunctionDefaultConfig { + Execution?: FunctionDefaultExecutionConfig; + } + export interface FunctionDefaultExecutionConfig { + IsolationMode?: FunctionIsolationMode; + RunAs?: FunctionRunAsConfig; + } + export interface FunctionDefinitionVersion { + /** + * The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings. + */ + DefaultConfig?: FunctionDefaultConfig; + /** + * A list of Lambda functions in this function definition version. + */ + Functions?: __listOfFunction; + } + export interface FunctionExecutionConfig { + IsolationMode?: FunctionIsolationMode; + RunAs?: FunctionRunAsConfig; + } + export type FunctionIsolationMode = "GreengrassContainer"|"NoContainer"|string; + export interface FunctionRunAsConfig { + /** + * The group ID whose permissions are used to run a Lambda function. + */ + Gid?: __integer; + /** + * The user ID whose permissions are used to run a Lambda function. + */ + Uid?: __integer; + } + export interface GetAssociatedRoleRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface GetAssociatedRoleResponse { + /** + * The time when the role was associated with the group. + */ + AssociatedAt?: __string; + /** + * The ARN of the role that is associated with the group. + */ + RoleArn?: __string; + } + export interface GetBulkDeploymentStatusRequest { + /** + * The ID of the bulk deployment. + */ + BulkDeploymentId: __string; + } + export interface GetBulkDeploymentStatusResponse { + /** + * Relevant metrics on input records processed during bulk deployment. + */ + BulkDeploymentMetrics?: BulkDeploymentMetrics; + /** + * The status of the bulk deployment. + */ + BulkDeploymentStatus?: BulkDeploymentStatus; + /** + * The time, in ISO format, when the deployment was created. + */ + CreatedAt?: __string; + /** + * Error details + */ + ErrorDetails?: ErrorDetails; + /** + * Error message + */ + ErrorMessage?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetConnectivityInfoRequest { + /** + * The thing name. + */ + ThingName: __string; + } + export interface GetConnectivityInfoResponse { + /** + * Connectivity info list. + */ + ConnectivityInfo?: __listOfConnectivityInfo; + /** + * A message about the connectivity info request. + */ + Message?: __string; + } + export interface GetConnectorDefinitionRequest { + /** + * The ID of the connector definition. + */ + ConnectorDefinitionId: __string; + } + export interface GetConnectorDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetConnectorDefinitionVersionRequest { + /** + * The ID of the connector definition. + */ + ConnectorDefinitionId: __string; + /** + * The ID of the connector definition version. + */ + ConnectorDefinitionVersionId: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface GetConnectorDefinitionVersionResponse { + /** + * The ARN of the connector definition version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the connector definition version was created. + */ + CreationTimestamp?: __string; + /** + * Information about the connector definition version. + */ + Definition?: ConnectorDefinitionVersion; + /** + * The ID of the connector definition version. + */ + Id?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The version of the connector definition version. + */ + Version?: __string; + } + export interface GetCoreDefinitionRequest { + /** + * The ID of the core definition. + */ + CoreDefinitionId: __string; + } + export interface GetCoreDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetCoreDefinitionVersionRequest { + /** + * The ID of the core definition. + */ + CoreDefinitionId: __string; + /** + * The ID of the core definition version. + */ + CoreDefinitionVersionId: __string; + } + export interface GetCoreDefinitionVersionResponse { + /** + * The ARN of the core definition version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the core definition version was created. + */ + CreationTimestamp?: __string; + /** + * Information about the core definition version. + */ + Definition?: CoreDefinitionVersion; + /** + * The ID of the core definition version. + */ + Id?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The version of the core definition version. + */ + Version?: __string; + } + export interface GetDeploymentStatusRequest { + /** + * The ID of the deployment. + */ + DeploymentId: __string; + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface GetDeploymentStatusResponse { + /** + * The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''. + */ + DeploymentStatus?: __string; + /** + * The type of the deployment. + */ + DeploymentType?: DeploymentType; + /** + * Error details + */ + ErrorDetails?: ErrorDetails; + /** + * Error message + */ + ErrorMessage?: __string; + /** + * The time, in milliseconds since the epoch, when the deployment status was updated. + */ + UpdatedAt?: __string; + } + export interface GetDeviceDefinitionRequest { + /** + * The ID of the device definition. + */ + DeviceDefinitionId: __string; + } + export interface GetDeviceDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetDeviceDefinitionVersionRequest { + /** + * The ID of the device definition. + */ + DeviceDefinitionId: __string; + /** + * The ID of the device definition version. + */ + DeviceDefinitionVersionId: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface GetDeviceDefinitionVersionResponse { + /** + * The ARN of the device definition version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the device definition version was created. + */ + CreationTimestamp?: __string; + /** + * Information about the device definition version. + */ + Definition?: DeviceDefinitionVersion; + /** + * The ID of the device definition version. + */ + Id?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The version of the device definition version. + */ + Version?: __string; + } + export interface GetFunctionDefinitionRequest { + /** + * The ID of the Lambda function definition. + */ + FunctionDefinitionId: __string; + } + export interface GetFunctionDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetFunctionDefinitionVersionRequest { + /** + * The ID of the Lambda function definition. + */ + FunctionDefinitionId: __string; + /** + * The ID of the function definition version. + */ + FunctionDefinitionVersionId: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface GetFunctionDefinitionVersionResponse { + /** + * The ARN of the function definition version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the function definition version was created. + */ + CreationTimestamp?: __string; + /** + * Information on the definition. + */ + Definition?: FunctionDefinitionVersion; + /** + * The ID of the function definition version. + */ + Id?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The version of the function definition version. + */ + Version?: __string; + } + export interface GetGroupCertificateAuthorityRequest { + /** + * The ID of the certificate authority. + */ + CertificateAuthorityId: __string; + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface GetGroupCertificateAuthorityResponse { + /** + * The ARN of the certificate authority for the group. + */ + GroupCertificateAuthorityArn?: __string; + /** + * The ID of the certificate authority for the group. + */ + GroupCertificateAuthorityId?: __string; + /** + * The PEM encoded certificate for the group. + */ + PemEncodedCertificate?: __string; + } + export interface GetGroupCertificateConfigurationRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface GetGroupCertificateConfigurationResponse { + /** + * The amount of time remaining before the certificate authority expires, in milliseconds. + */ + CertificateAuthorityExpiryInMilliseconds?: __string; + /** + * The amount of time remaining before the certificate expires, in milliseconds. + */ + CertificateExpiryInMilliseconds?: __string; + /** + * The ID of the group certificate configuration. + */ + GroupId?: __string; + } + export interface GetGroupRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface GetGroupResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetGroupVersionRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + /** + * The ID of the group version. + */ + GroupVersionId: __string; + } + export interface GetGroupVersionResponse { + /** + * The ARN of the group version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the group version was created. + */ + CreationTimestamp?: __string; + /** + * Information about the group version definition. + */ + Definition?: GroupVersion; + /** + * The ID of the group version. + */ + Id?: __string; + /** + * The unique ID for the version of the group. + */ + Version?: __string; + } + export interface GetLoggerDefinitionRequest { + /** + * The ID of the logger definition. + */ + LoggerDefinitionId: __string; + } + export interface GetLoggerDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetLoggerDefinitionVersionRequest { + /** + * The ID of the logger definition. + */ + LoggerDefinitionId: __string; + /** + * The ID of the logger definition version. + */ + LoggerDefinitionVersionId: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface GetLoggerDefinitionVersionResponse { + /** + * The ARN of the logger definition version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the logger definition version was created. + */ + CreationTimestamp?: __string; + /** + * Information about the logger definition version. + */ + Definition?: LoggerDefinitionVersion; + /** + * The ID of the logger definition version. + */ + Id?: __string; + /** + * The version of the logger definition version. + */ + Version?: __string; + } + export interface GetResourceDefinitionRequest { + /** + * The ID of the resource definition. + */ + ResourceDefinitionId: __string; + } + export interface GetResourceDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetResourceDefinitionVersionRequest { + /** + * The ID of the resource definition. + */ + ResourceDefinitionId: __string; + /** + * The ID of the resource definition version. + */ + ResourceDefinitionVersionId: __string; + } + export interface GetResourceDefinitionVersionResponse { + /** + * Arn of the resource definition version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the resource definition version was created. + */ + CreationTimestamp?: __string; + /** + * Information about the definition. + */ + Definition?: ResourceDefinitionVersion; + /** + * The ID of the resource definition version. + */ + Id?: __string; + /** + * The version of the resource definition version. + */ + Version?: __string; + } + export interface GetServiceRoleForAccountRequest { + } + export interface GetServiceRoleForAccountResponse { + /** + * The time when the service role was associated with the account. + */ + AssociatedAt?: __string; + /** + * The ARN of the role which is associated with the account. + */ + RoleArn?: __string; + } + export interface GetSubscriptionDefinitionRequest { + /** + * The ID of the subscription definition. + */ + SubscriptionDefinitionId: __string; + } + export interface GetSubscriptionDefinitionResponse { + /** + * The ARN of the definition. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the definition. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the definition was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the definition. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the definition. + */ + LatestVersionArn?: __string; + /** + * The name of the definition. + */ + Name?: __string; + /** + * The tags for the definition. + */ + tags?: __mapOf__string; + } + export interface GetSubscriptionDefinitionVersionRequest { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The ID of the subscription definition. + */ + SubscriptionDefinitionId: __string; + /** + * The ID of the subscription definition version. + */ + SubscriptionDefinitionVersionId: __string; + } + export interface GetSubscriptionDefinitionVersionResponse { + /** + * The ARN of the subscription definition version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the subscription definition version was created. + */ + CreationTimestamp?: __string; + /** + * Information about the subscription definition version. + */ + Definition?: SubscriptionDefinitionVersion; + /** + * The ID of the subscription definition version. + */ + Id?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The version of the subscription definition version. + */ + Version?: __string; + } + export interface GroupCertificateAuthorityProperties { + /** + * The ARN of the certificate authority for the group. + */ + GroupCertificateAuthorityArn?: __string; + /** + * The ID of the certificate authority for the group. + */ + GroupCertificateAuthorityId?: __string; + } + export interface GroupInformation { + /** + * The ARN of the group. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the group was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the group. + */ + Id?: __string; + /** + * The time, in milliseconds since the epoch, when the group was last updated. + */ + LastUpdatedTimestamp?: __string; + /** + * The latest version of the group. + */ + LatestVersion?: __string; + /** + * The ARN of the latest version of the group. + */ + LatestVersionArn?: __string; + /** + * The name of the group. + */ + Name?: __string; + } + export interface GroupOwnerSetting { + /** + * If true, AWS IoT 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. + */ + AutoAddGroupOwner?: __boolean; + /** + * The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional. + */ + GroupOwner?: __string; + } + export interface GroupVersion { + /** + * The ARN of the connector definition version for this group. + */ + ConnectorDefinitionVersionArn?: __string; + /** + * The ARN of the core definition version for this group. + */ + CoreDefinitionVersionArn?: __string; + /** + * The ARN of the device definition version for this group. + */ + DeviceDefinitionVersionArn?: __string; + /** + * The ARN of the function definition version for this group. + */ + FunctionDefinitionVersionArn?: __string; + /** + * The ARN of the logger definition version for this group. + */ + LoggerDefinitionVersionArn?: __string; + /** + * The ARN of the resource definition version for this group. + */ + ResourceDefinitionVersionArn?: __string; + /** + * The ARN of the subscription definition version for this group. + */ + SubscriptionDefinitionVersionArn?: __string; + } + export interface ListBulkDeploymentDetailedReportsRequest { + /** + * The ID of the bulk deployment. + */ + BulkDeploymentId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListBulkDeploymentDetailedReportsResponse { + /** + * A list of the individual group deployments in the bulk deployment operation. + */ + Deployments?: BulkDeploymentResults; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListBulkDeploymentsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListBulkDeploymentsResponse { + /** + * A list of bulk deployments. + */ + BulkDeployments?: BulkDeployments; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListConnectorDefinitionVersionsRequest { + /** + * The ID of the connector definition. + */ + ConnectorDefinitionId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListConnectorDefinitionVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListConnectorDefinitionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListConnectorDefinitionsResponse { + /** + * Information about a definition. + */ + Definitions?: __listOfDefinitionInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListCoreDefinitionVersionsRequest { + /** + * The ID of the core definition. + */ + CoreDefinitionId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListCoreDefinitionVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListCoreDefinitionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListCoreDefinitionsResponse { + /** + * Information about a definition. + */ + Definitions?: __listOfDefinitionInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListDeploymentsRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListDeploymentsResponse { + /** + * A list of deployments for the requested groups. + */ + Deployments?: Deployments; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListDeviceDefinitionVersionsRequest { + /** + * The ID of the device definition. + */ + DeviceDefinitionId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListDeviceDefinitionVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListDeviceDefinitionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListDeviceDefinitionsResponse { + /** + * Information about a definition. + */ + Definitions?: __listOfDefinitionInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListFunctionDefinitionVersionsRequest { + /** + * The ID of the Lambda function definition. + */ + FunctionDefinitionId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListFunctionDefinitionVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListFunctionDefinitionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListFunctionDefinitionsResponse { + /** + * Information about a definition. + */ + Definitions?: __listOfDefinitionInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListGroupCertificateAuthoritiesRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface ListGroupCertificateAuthoritiesResponse { + /** + * A list of certificate authorities associated with the group. + */ + GroupCertificateAuthorities?: __listOfGroupCertificateAuthorityProperties; + } + export interface ListGroupVersionsRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListGroupVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListGroupsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListGroupsResponse { + /** + * Information about a group. + */ + Groups?: __listOfGroupInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListLoggerDefinitionVersionsRequest { + /** + * The ID of the logger definition. + */ + LoggerDefinitionId: __string; + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListLoggerDefinitionVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListLoggerDefinitionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListLoggerDefinitionsResponse { + /** + * Information about a definition. + */ + Definitions?: __listOfDefinitionInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListResourceDefinitionVersionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The ID of the resource definition. + */ + ResourceDefinitionId: __string; + } + export interface ListResourceDefinitionVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListResourceDefinitionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListResourceDefinitionsResponse { + /** + * Information about a definition. + */ + Definitions?: __listOfDefinitionInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListSubscriptionDefinitionVersionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * The ID of the subscription definition. + */ + SubscriptionDefinitionId: __string; + } + export interface ListSubscriptionDefinitionVersionsResponse { + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + /** + * Information about a version. + */ + Versions?: __listOfVersionInformation; + } + export interface ListSubscriptionDefinitionsRequest { + /** + * The maximum number of results to be returned per request. + */ + MaxResults?: __string; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListSubscriptionDefinitionsResponse { + /** + * Information about a definition. + */ + Definitions?: __listOfDefinitionInformation; + /** + * The token for the next set of results, or ''null'' if there are no additional results. + */ + NextToken?: __string; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + /** + * A map of the key-value pairs for the resource tag. + */ + tags?: __mapOf__string; + } + export interface LocalDeviceResourceData { + /** + * Group/owner related settings for local resources. + */ + GroupOwnerSetting?: GroupOwnerSetting; + /** + * 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''. + */ + SourcePath?: __string; + } + export interface LocalVolumeResourceData { + /** + * The absolute local path of the resource inside the Lambda environment. + */ + DestinationPath?: __string; + /** + * Allows you to configure additional group privileges for the Lambda process. This field is optional. + */ + GroupOwnerSetting?: GroupOwnerSetting; + /** + * The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''. + */ + SourcePath?: __string; + } + export interface Logger { + /** + * The component that will be subject to logging. + */ + Component?: LoggerComponent; + /** + * A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. + */ + Id?: __string; + /** + * The level of the logs. + */ + Level?: LoggerLevel; + /** + * The amount of file space, in KB, to use if the local file system is used for logging purposes. + */ + Space?: __integer; + /** + * The type of log output which will be used. + */ + Type?: LoggerType; + } + export type LoggerComponent = "GreengrassSystem"|"Lambda"|string; + export interface LoggerDefinitionVersion { + /** + * A list of loggers. + */ + Loggers?: __listOfLogger; + } + export type LoggerLevel = "DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL"|string; + export type LoggerType = "FileSystem"|"AWSCloudWatch"|string; + export type Permission = "ro"|"rw"|string; + export interface ResetDeploymentsRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * If true, performs a best-effort only core reset. + */ + Force?: __boolean; + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface ResetDeploymentsResponse { + /** + * The ARN of the deployment. + */ + DeploymentArn?: __string; + /** + * The ID of the deployment. + */ + DeploymentId?: __string; + } + export interface Resource { + /** + * 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. + */ + Id?: __string; + /** + * The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group. + */ + Name?: __string; + /** + * A container of data for all resource types. + */ + ResourceDataContainer?: ResourceDataContainer; + } + export interface ResourceAccessPolicy { + /** + * The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only). + */ + Permission?: Permission; + /** + * The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.) + */ + ResourceId?: __string; + } + export interface ResourceDataContainer { + /** + * Attributes that define the local device resource. + */ + LocalDeviceResourceData?: LocalDeviceResourceData; + /** + * Attributes that define the local volume resource. + */ + LocalVolumeResourceData?: LocalVolumeResourceData; + /** + * Attributes that define an Amazon S3 machine learning resource. + */ + S3MachineLearningModelResourceData?: S3MachineLearningModelResourceData; + /** + * Attributes that define an Amazon SageMaker machine learning resource. + */ + SageMakerMachineLearningModelResourceData?: SageMakerMachineLearningModelResourceData; + /** + * Attributes that define a secret resource, which references a secret from AWS Secrets Manager. + */ + SecretsManagerSecretResourceData?: SecretsManagerSecretResourceData; + } + export interface ResourceDefinitionVersion { + /** + * A list of resources. + */ + Resources?: __listOfResource; + } + export interface S3MachineLearningModelResourceData { + /** + * The absolute local path of the resource inside the Lambda environment. + */ + DestinationPath?: __string; + /** + * The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format. + */ + S3Uri?: __string; + } + export type S3UrlSignerRole = string; + export interface SageMakerMachineLearningModelResourceData { + /** + * The absolute local path of the resource inside the Lambda environment. + */ + DestinationPath?: __string; + /** + * The ARN of the Amazon SageMaker training job that represents the source model. + */ + SageMakerJobArn?: __string; + } + export interface SecretsManagerSecretResourceData { + /** + * The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default. + */ + ARN?: __string; + /** + * Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''. + */ + AdditionalStagingLabelsToDownload?: __listOf__string; + } + export type SoftwareToUpdate = "core"|"ota_agent"|string; + export interface StartBulkDeploymentRequest { + /** + * A client token used to correlate requests and responses. + */ + AmznClientToken?: __string; + /** + * The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file. + */ + ExecutionRoleArn?: __string; + /** + * The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types. + */ + InputFileUri?: __string; + /** + * Tag(s) to add to the new resource + */ + tags?: Tags; + } + export interface StartBulkDeploymentResponse { + /** + * The ARN of the bulk deployment. + */ + BulkDeploymentArn?: __string; + /** + * The ID of the bulk deployment. + */ + BulkDeploymentId?: __string; + } + export interface StopBulkDeploymentRequest { + /** + * The ID of the bulk deployment. + */ + BulkDeploymentId: __string; + } + export interface StopBulkDeploymentResponse { + } + export interface Subscription { + /** + * A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. + */ + Id?: __string; + /** + * The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'. + */ + Source?: __string; + /** + * The MQTT topic used to route the message. + */ + Subject?: __string; + /** + * Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'. + */ + Target?: __string; + } + export interface SubscriptionDefinitionVersion { + /** + * A list of subscriptions. + */ + Subscriptions?: __listOfSubscription; + } + export type Tags = {[key: string]: __string}; + export type UpdateAgentLogLevel = "NONE"|"TRACE"|"DEBUG"|"VERBOSE"|"INFO"|"WARN"|"ERROR"|"FATAL"|string; + export interface UpdateConnectivityInfoRequest { + /** + * A list of connectivity info. + */ + ConnectivityInfo?: __listOfConnectivityInfo; + /** + * The thing name. + */ + ThingName: __string; + } + export interface UpdateConnectivityInfoResponse { + /** + * A message about the connectivity info update request. + */ + Message?: __string; + /** + * The new version of the connectivity info. + */ + Version?: __string; + } + export interface UpdateConnectorDefinitionRequest { + /** + * The ID of the connector definition. + */ + ConnectorDefinitionId: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface UpdateConnectorDefinitionResponse { + } + export interface UpdateCoreDefinitionRequest { + /** + * The ID of the core definition. + */ + CoreDefinitionId: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface UpdateCoreDefinitionResponse { + } + export interface UpdateDeviceDefinitionRequest { + /** + * The ID of the device definition. + */ + DeviceDefinitionId: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface UpdateDeviceDefinitionResponse { + } + export interface UpdateFunctionDefinitionRequest { + /** + * The ID of the Lambda function definition. + */ + FunctionDefinitionId: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface UpdateFunctionDefinitionResponse { + } + export interface UpdateGroupCertificateConfigurationRequest { + /** + * The amount of time remaining before the certificate expires, in milliseconds. + */ + CertificateExpiryInMilliseconds?: __string; + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + } + export interface UpdateGroupCertificateConfigurationResponse { + /** + * The amount of time remaining before the certificate authority expires, in milliseconds. + */ + CertificateAuthorityExpiryInMilliseconds?: __string; + /** + * The amount of time remaining before the certificate expires, in milliseconds. + */ + CertificateExpiryInMilliseconds?: __string; + /** + * The ID of the group certificate configuration. + */ + GroupId?: __string; + } + export interface UpdateGroupRequest { + /** + * The ID of the Greengrass group. + */ + GroupId: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface UpdateGroupResponse { + } + export interface UpdateLoggerDefinitionRequest { + /** + * The ID of the logger definition. + */ + LoggerDefinitionId: __string; + /** + * The name of the definition. + */ + Name?: __string; + } + export interface UpdateLoggerDefinitionResponse { + } + export interface UpdateResourceDefinitionRequest { + /** + * The name of the definition. + */ + Name?: __string; + /** + * The ID of the resource definition. + */ + ResourceDefinitionId: __string; + } + export interface UpdateResourceDefinitionResponse { + } + export interface UpdateSubscriptionDefinitionRequest { + /** + * The name of the definition. + */ + Name?: __string; + /** + * The ID of the subscription definition. + */ + SubscriptionDefinitionId: __string; + } + export interface UpdateSubscriptionDefinitionResponse { + } + export type UpdateTargets = __string[]; + export type UpdateTargetsArchitecture = "armv7l"|"x86_64"|"aarch64"|string; + export type UpdateTargetsOperatingSystem = "ubuntu"|"raspbian"|"amazon_linux"|string; + export interface VersionInformation { + /** + * The ARN of the version. + */ + Arn?: __string; + /** + * The time, in milliseconds since the epoch, when the version was created. + */ + CreationTimestamp?: __string; + /** + * The ID of the version. + */ + Id?: __string; + /** + * The unique ID of the version. + */ + Version?: __string; + } + export type __boolean = boolean; + export type __integer = number; + export type __listOfConnectivityInfo = ConnectivityInfo[]; + export type __listOfConnector = Connector[]; + export type __listOfCore = Core[]; + export type __listOfDefinitionInformation = DefinitionInformation[]; + export type __listOfDevice = Device[]; + export type __listOfFunction = Function[]; + export type __listOfGroupCertificateAuthorityProperties = GroupCertificateAuthorityProperties[]; + export type __listOfGroupInformation = GroupInformation[]; + export type __listOfLogger = Logger[]; + export type __listOfResource = Resource[]; + export type __listOfResourceAccessPolicy = ResourceAccessPolicy[]; + export type __listOfSubscription = Subscription[]; + export type __listOfVersionInformation = VersionInformation[]; + export type __listOf__string = __string[]; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-06-07"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Greengrass client. + */ + export import Types = Greengrass; +} +export = Greengrass; diff --git a/node_modules/aws-sdk/clients/greengrass.js b/node_modules/aws-sdk/clients/greengrass.js new file mode 100644 index 0000000..f9420ae --- /dev/null +++ b/node_modules/aws-sdk/clients/greengrass.js @@ -0,0 +1,17 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['greengrass'] = {}; +AWS.Greengrass = Service.defineService('greengrass', ['2017-06-07']); +Object.defineProperty(apiLoader.services['greengrass'], '2017-06-07', { + get: function get() { + var model = require('../apis/greengrass-2017-06-07.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Greengrass; diff --git a/node_modules/aws-sdk/clients/guardduty.d.ts b/node_modules/aws-sdk/clients/guardduty.d.ts new file mode 100644 index 0000000..6976c7d --- /dev/null +++ b/node_modules/aws-sdk/clients/guardduty.d.ts @@ -0,0 +1,1772 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class GuardDuty extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: GuardDuty.Types.ClientConfiguration) + config: Config & GuardDuty.Types.ClientConfiguration; + /** + * Accepts the invitation to be monitored by a master GuardDuty account. + */ + acceptInvitation(params: GuardDuty.Types.AcceptInvitationRequest, callback?: (err: AWSError, data: GuardDuty.Types.AcceptInvitationResponse) => void): Request; + /** + * Accepts the invitation to be monitored by a master GuardDuty account. + */ + acceptInvitation(callback?: (err: AWSError, data: GuardDuty.Types.AcceptInvitationResponse) => void): Request; + /** + * Archives Amazon GuardDuty findings specified by the list of finding IDs. + */ + archiveFindings(params: GuardDuty.Types.ArchiveFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ArchiveFindingsResponse) => void): Request; + /** + * Archives Amazon GuardDuty findings specified by the list of finding IDs. + */ + archiveFindings(callback?: (err: AWSError, data: GuardDuty.Types.ArchiveFindingsResponse) => void): Request; + /** + * Creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector must be created in order for GuardDuty to become operational. + */ + createDetector(params: GuardDuty.Types.CreateDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateDetectorResponse) => void): Request; + /** + * Creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector must be created in order for GuardDuty to become operational. + */ + createDetector(callback?: (err: AWSError, data: GuardDuty.Types.CreateDetectorResponse) => void): Request; + /** + * Creates a filter using the specified finding criteria. + */ + createFilter(params: GuardDuty.Types.CreateFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateFilterResponse) => void): Request; + /** + * Creates a filter using the specified finding criteria. + */ + createFilter(callback?: (err: AWSError, data: GuardDuty.Types.CreateFilterResponse) => void): Request; + /** + * Creates a new IPSet - a list of trusted IP addresses that have been whitelisted for secure communication with AWS infrastructure and applications. + */ + createIPSet(params: GuardDuty.Types.CreateIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateIPSetResponse) => void): Request; + /** + * Creates a new IPSet - a list of trusted IP addresses that have been whitelisted for secure communication with AWS infrastructure and applications. + */ + createIPSet(callback?: (err: AWSError, data: GuardDuty.Types.CreateIPSetResponse) => void): Request; + /** + * Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts. + */ + createMembers(params: GuardDuty.Types.CreateMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateMembersResponse) => void): Request; + /** + * Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts. + */ + createMembers(callback?: (err: AWSError, data: GuardDuty.Types.CreateMembersResponse) => void): Request; + /** + * Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types. + */ + createSampleFindings(params: GuardDuty.Types.CreateSampleFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateSampleFindingsResponse) => void): Request; + /** + * Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types. + */ + createSampleFindings(callback?: (err: AWSError, data: GuardDuty.Types.CreateSampleFindingsResponse) => void): Request; + /** + * Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. + */ + createThreatIntelSet(params: GuardDuty.Types.CreateThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.CreateThreatIntelSetResponse) => void): Request; + /** + * Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. + */ + createThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.CreateThreatIntelSetResponse) => void): Request; + /** + * Declines invitations sent to the current member account by AWS account specified by their account IDs. + */ + declineInvitations(params: GuardDuty.Types.DeclineInvitationsRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeclineInvitationsResponse) => void): Request; + /** + * Declines invitations sent to the current member account by AWS account specified by their account IDs. + */ + declineInvitations(callback?: (err: AWSError, data: GuardDuty.Types.DeclineInvitationsResponse) => void): Request; + /** + * Deletes a Amazon GuardDuty detector specified by the detector ID. + */ + deleteDetector(params: GuardDuty.Types.DeleteDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteDetectorResponse) => void): Request; + /** + * Deletes a Amazon GuardDuty detector specified by the detector ID. + */ + deleteDetector(callback?: (err: AWSError, data: GuardDuty.Types.DeleteDetectorResponse) => void): Request; + /** + * Deletes the filter specified by the filter name. + */ + deleteFilter(params: GuardDuty.Types.DeleteFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteFilterResponse) => void): Request; + /** + * Deletes the filter specified by the filter name. + */ + deleteFilter(callback?: (err: AWSError, data: GuardDuty.Types.DeleteFilterResponse) => void): Request; + /** + * Deletes the IPSet specified by the IPSet ID. + */ + deleteIPSet(params: GuardDuty.Types.DeleteIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteIPSetResponse) => void): Request; + /** + * Deletes the IPSet specified by the IPSet ID. + */ + deleteIPSet(callback?: (err: AWSError, data: GuardDuty.Types.DeleteIPSetResponse) => void): Request; + /** + * Deletes invitations sent to the current member account by AWS accounts specified by their account IDs. + */ + deleteInvitations(params: GuardDuty.Types.DeleteInvitationsRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteInvitationsResponse) => void): Request; + /** + * Deletes invitations sent to the current member account by AWS accounts specified by their account IDs. + */ + deleteInvitations(callback?: (err: AWSError, data: GuardDuty.Types.DeleteInvitationsResponse) => void): Request; + /** + * Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs. + */ + deleteMembers(params: GuardDuty.Types.DeleteMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteMembersResponse) => void): Request; + /** + * Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs. + */ + deleteMembers(callback?: (err: AWSError, data: GuardDuty.Types.DeleteMembersResponse) => void): Request; + /** + * Deletes ThreatIntelSet specified by the ThreatIntelSet ID. + */ + deleteThreatIntelSet(params: GuardDuty.Types.DeleteThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.DeleteThreatIntelSetResponse) => void): Request; + /** + * Deletes ThreatIntelSet specified by the ThreatIntelSet ID. + */ + deleteThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.DeleteThreatIntelSetResponse) => void): Request; + /** + * Disassociates the current GuardDuty member account from its master account. + */ + disassociateFromMasterAccount(params: GuardDuty.Types.DisassociateFromMasterAccountRequest, callback?: (err: AWSError, data: GuardDuty.Types.DisassociateFromMasterAccountResponse) => void): Request; + /** + * Disassociates the current GuardDuty member account from its master account. + */ + disassociateFromMasterAccount(callback?: (err: AWSError, data: GuardDuty.Types.DisassociateFromMasterAccountResponse) => void): Request; + /** + * Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs. + */ + disassociateMembers(params: GuardDuty.Types.DisassociateMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.DisassociateMembersResponse) => void): Request; + /** + * Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs. + */ + disassociateMembers(callback?: (err: AWSError, data: GuardDuty.Types.DisassociateMembersResponse) => void): Request; + /** + * Retrieves an Amazon GuardDuty detector specified by the detectorId. + */ + getDetector(params: GuardDuty.Types.GetDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetDetectorResponse) => void): Request; + /** + * Retrieves an Amazon GuardDuty detector specified by the detectorId. + */ + getDetector(callback?: (err: AWSError, data: GuardDuty.Types.GetDetectorResponse) => void): Request; + /** + * Returns the details of the filter specified by the filter name. + */ + getFilter(params: GuardDuty.Types.GetFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetFilterResponse) => void): Request; + /** + * Returns the details of the filter specified by the filter name. + */ + getFilter(callback?: (err: AWSError, data: GuardDuty.Types.GetFilterResponse) => void): Request; + /** + * Describes Amazon GuardDuty findings specified by finding IDs. + */ + getFindings(params: GuardDuty.Types.GetFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsResponse) => void): Request; + /** + * Describes Amazon GuardDuty findings specified by finding IDs. + */ + getFindings(callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsResponse) => void): Request; + /** + * Lists Amazon GuardDuty findings' statistics for the specified detector ID. + */ + getFindingsStatistics(params: GuardDuty.Types.GetFindingsStatisticsRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsStatisticsResponse) => void): Request; + /** + * Lists Amazon GuardDuty findings' statistics for the specified detector ID. + */ + getFindingsStatistics(callback?: (err: AWSError, data: GuardDuty.Types.GetFindingsStatisticsResponse) => void): Request; + /** + * Retrieves the IPSet specified by the IPSet ID. + */ + getIPSet(params: GuardDuty.Types.GetIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetIPSetResponse) => void): Request; + /** + * Retrieves the IPSet specified by the IPSet ID. + */ + getIPSet(callback?: (err: AWSError, data: GuardDuty.Types.GetIPSetResponse) => void): Request; + /** + * Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation. + */ + getInvitationsCount(params: GuardDuty.Types.GetInvitationsCountRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetInvitationsCountResponse) => void): Request; + /** + * Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation. + */ + getInvitationsCount(callback?: (err: AWSError, data: GuardDuty.Types.GetInvitationsCountResponse) => void): Request; + /** + * Provides the details for the GuardDuty master account to the current GuardDuty member account. + */ + getMasterAccount(params: GuardDuty.Types.GetMasterAccountRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetMasterAccountResponse) => void): Request; + /** + * Provides the details for the GuardDuty master account to the current GuardDuty member account. + */ + getMasterAccount(callback?: (err: AWSError, data: GuardDuty.Types.GetMasterAccountResponse) => void): Request; + /** + * Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs. + */ + getMembers(params: GuardDuty.Types.GetMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetMembersResponse) => void): Request; + /** + * Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs. + */ + getMembers(callback?: (err: AWSError, data: GuardDuty.Types.GetMembersResponse) => void): Request; + /** + * Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID. + */ + getThreatIntelSet(params: GuardDuty.Types.GetThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetThreatIntelSetResponse) => void): Request; + /** + * Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID. + */ + getThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.GetThreatIntelSetResponse) => void): Request; + /** + * Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account. + */ + inviteMembers(params: GuardDuty.Types.InviteMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.InviteMembersResponse) => void): Request; + /** + * Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account. + */ + inviteMembers(callback?: (err: AWSError, data: GuardDuty.Types.InviteMembersResponse) => void): Request; + /** + * Lists detectorIds of all the existing Amazon GuardDuty detector resources. + */ + listDetectors(params: GuardDuty.Types.ListDetectorsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListDetectorsResponse) => void): Request; + /** + * Lists detectorIds of all the existing Amazon GuardDuty detector resources. + */ + listDetectors(callback?: (err: AWSError, data: GuardDuty.Types.ListDetectorsResponse) => void): Request; + /** + * Returns a paginated list of the current filters. + */ + listFilters(params: GuardDuty.Types.ListFiltersRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListFiltersResponse) => void): Request; + /** + * Returns a paginated list of the current filters. + */ + listFilters(callback?: (err: AWSError, data: GuardDuty.Types.ListFiltersResponse) => void): Request; + /** + * Lists Amazon GuardDuty findings for the specified detector ID. + */ + listFindings(params: GuardDuty.Types.ListFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListFindingsResponse) => void): Request; + /** + * Lists Amazon GuardDuty findings for the specified detector ID. + */ + listFindings(callback?: (err: AWSError, data: GuardDuty.Types.ListFindingsResponse) => void): Request; + /** + * Lists the IPSets of the GuardDuty service specified by the detector ID. + */ + listIPSets(params: GuardDuty.Types.ListIPSetsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListIPSetsResponse) => void): Request; + /** + * Lists the IPSets of the GuardDuty service specified by the detector ID. + */ + listIPSets(callback?: (err: AWSError, data: GuardDuty.Types.ListIPSetsResponse) => void): Request; + /** + * Lists all GuardDuty membership invitations that were sent to the current AWS account. + */ + listInvitations(params: GuardDuty.Types.ListInvitationsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListInvitationsResponse) => void): Request; + /** + * Lists all GuardDuty membership invitations that were sent to the current AWS account. + */ + listInvitations(callback?: (err: AWSError, data: GuardDuty.Types.ListInvitationsResponse) => void): Request; + /** + * Lists details about all member accounts for the current GuardDuty master account. + */ + listMembers(params: GuardDuty.Types.ListMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListMembersResponse) => void): Request; + /** + * Lists details about all member accounts for the current GuardDuty master account. + */ + listMembers(callback?: (err: AWSError, data: GuardDuty.Types.ListMembersResponse) => void): Request; + /** + * Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. + */ + listThreatIntelSets(params: GuardDuty.Types.ListThreatIntelSetsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListThreatIntelSetsResponse) => void): Request; + /** + * Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. + */ + listThreatIntelSets(callback?: (err: AWSError, data: GuardDuty.Types.ListThreatIntelSetsResponse) => void): Request; + /** + * Re-enables GuardDuty to monitor findings of the member accounts specified by the account IDs. A master GuardDuty account can run this command after disabling GuardDuty from monitoring these members' findings by running StopMonitoringMembers. + */ + startMonitoringMembers(params: GuardDuty.Types.StartMonitoringMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.StartMonitoringMembersResponse) => void): Request; + /** + * Re-enables GuardDuty to monitor findings of the member accounts specified by the account IDs. A master GuardDuty account can run this command after disabling GuardDuty from monitoring these members' findings by running StopMonitoringMembers. + */ + startMonitoringMembers(callback?: (err: AWSError, data: GuardDuty.Types.StartMonitoringMembersResponse) => void): Request; + /** + * Disables GuardDuty from monitoring findings of the member accounts specified by the account IDs. After running this command, a master GuardDuty account can run StartMonitoringMembers to re-enable GuardDuty to monitor these members’ findings. + */ + stopMonitoringMembers(params: GuardDuty.Types.StopMonitoringMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.StopMonitoringMembersResponse) => void): Request; + /** + * Disables GuardDuty from monitoring findings of the member accounts specified by the account IDs. After running this command, a master GuardDuty account can run StartMonitoringMembers to re-enable GuardDuty to monitor these members’ findings. + */ + stopMonitoringMembers(callback?: (err: AWSError, data: GuardDuty.Types.StopMonitoringMembersResponse) => void): Request; + /** + * Unarchives Amazon GuardDuty findings specified by the list of finding IDs. + */ + unarchiveFindings(params: GuardDuty.Types.UnarchiveFindingsRequest, callback?: (err: AWSError, data: GuardDuty.Types.UnarchiveFindingsResponse) => void): Request; + /** + * Unarchives Amazon GuardDuty findings specified by the list of finding IDs. + */ + unarchiveFindings(callback?: (err: AWSError, data: GuardDuty.Types.UnarchiveFindingsResponse) => void): Request; + /** + * Updates an Amazon GuardDuty detector specified by the detectorId. + */ + updateDetector(params: GuardDuty.Types.UpdateDetectorRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateDetectorResponse) => void): Request; + /** + * Updates an Amazon GuardDuty detector specified by the detectorId. + */ + updateDetector(callback?: (err: AWSError, data: GuardDuty.Types.UpdateDetectorResponse) => void): Request; + /** + * Updates the filter specified by the filter name. + */ + updateFilter(params: GuardDuty.Types.UpdateFilterRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateFilterResponse) => void): Request; + /** + * Updates the filter specified by the filter name. + */ + updateFilter(callback?: (err: AWSError, data: GuardDuty.Types.UpdateFilterResponse) => void): Request; + /** + * Marks specified Amazon GuardDuty findings as useful or not useful. + */ + updateFindingsFeedback(params: GuardDuty.Types.UpdateFindingsFeedbackRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateFindingsFeedbackResponse) => void): Request; + /** + * Marks specified Amazon GuardDuty findings as useful or not useful. + */ + updateFindingsFeedback(callback?: (err: AWSError, data: GuardDuty.Types.UpdateFindingsFeedbackResponse) => void): Request; + /** + * Updates the IPSet specified by the IPSet ID. + */ + updateIPSet(params: GuardDuty.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateIPSetResponse) => void): Request; + /** + * Updates the IPSet specified by the IPSet ID. + */ + updateIPSet(callback?: (err: AWSError, data: GuardDuty.Types.UpdateIPSetResponse) => void): Request; + /** + * Updates the ThreatIntelSet specified by ThreatIntelSet ID. + */ + updateThreatIntelSet(params: GuardDuty.Types.UpdateThreatIntelSetRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateThreatIntelSetResponse) => void): Request; + /** + * Updates the ThreatIntelSet specified by ThreatIntelSet ID. + */ + updateThreatIntelSet(callback?: (err: AWSError, data: GuardDuty.Types.UpdateThreatIntelSetResponse) => void): Request; +} +declare namespace GuardDuty { + export interface AcceptInvitationRequest { + /** + * The unique ID of the detector of the GuardDuty member account. + */ + DetectorId: __string; + /** + * This value is used to validate the master account to the member account. + */ + InvitationId: InvitationId; + /** + * The account ID of the master GuardDuty account whose invitation you're accepting. + */ + MasterId: MasterId; + } + export interface AcceptInvitationResponse { + } + export interface AccessKeyDetails { + /** + * Access key ID of the user. + */ + AccessKeyId?: __string; + /** + * The principal ID of the user. + */ + PrincipalId?: __string; + /** + * The name of the user. + */ + UserName?: __string; + /** + * The type of the user. + */ + UserType?: __string; + } + export interface AccountDetail { + /** + * Member account ID. + */ + AccountId: AccountId; + /** + * Member account's email address. + */ + Email: Email; + } + export type AccountDetails = AccountDetail[]; + export type AccountId = string; + export type AccountIds = __string[]; + export interface Action { + /** + * GuardDuty Finding activity type. + */ + ActionType?: __string; + /** + * Information about the AWS_API_CALL action described in this finding. + */ + AwsApiCallAction?: AwsApiCallAction; + /** + * Information about the DNS_REQUEST action described in this finding. + */ + DnsRequestAction?: DnsRequestAction; + /** + * Information about the NETWORK_CONNECTION action described in this finding. + */ + NetworkConnectionAction?: NetworkConnectionAction; + /** + * Information about the PORT_PROBE action described in this finding. + */ + PortProbeAction?: PortProbeAction; + } + export type Activate = boolean; + export interface ArchiveFindingsRequest { + /** + * The ID of the detector that specifies the GuardDuty service whose findings you want to archive. + */ + DetectorId: __string; + /** + * IDs of the findings that you want to archive. + */ + FindingIds: FindingIds; + } + export interface ArchiveFindingsResponse { + } + export interface AwsApiCallAction { + /** + * AWS API name. + */ + Api?: __string; + /** + * AWS API caller type. + */ + CallerType?: __string; + /** + * Domain information for the AWS API call. + */ + DomainDetails?: DomainDetails; + /** + * Remote IP information of the connection. + */ + RemoteIpDetails?: RemoteIpDetails; + /** + * AWS service name whose API was invoked. + */ + ServiceName?: __string; + } + export interface City { + /** + * City name of the remote IP address. + */ + CityName?: __string; + } + export type Comments = string; + export interface Condition { + /** + * Represents the equal condition to be applied to a single field when querying for findings. + */ + Eq?: Eq; + /** + * Represents the greater than condition to be applied to a single field when querying for findings. + */ + Gt?: __integer; + /** + * Represents the greater than equal condition to be applied to a single field when querying for findings. + */ + Gte?: __integer; + /** + * Represents the less than condition to be applied to a single field when querying for findings. + */ + Lt?: __integer; + /** + * Represents the less than equal condition to be applied to a single field when querying for findings. + */ + Lte?: __integer; + /** + * Represents the not equal condition to be applied to a single field when querying for findings. + */ + Neq?: Neq; + } + export type CountBySeverityFindingStatistic = number; + export interface Country { + /** + * Country code of the remote IP address. + */ + CountryCode?: __string; + /** + * Country name of the remote IP address. + */ + CountryName?: __string; + } + export interface CreateDetectorRequest { + /** + * The idempotency token for the create request. + */ + ClientToken?: __stringMin0Max64; + /** + * A boolean value that specifies whether the detector is to be enabled. + */ + Enable: Enable; + /** + * A enum value that specifies how frequently customer got Finding updates published. + */ + FindingPublishingFrequency?: FindingPublishingFrequency; + } + export interface CreateDetectorResponse { + /** + * The unique ID of the created detector. + */ + DetectorId?: DetectorId; + } + export interface CreateFilterRequest { + /** + * Specifies the action that is to be applied to the findings that match the filter. + */ + Action?: FilterAction; + /** + * The idempotency token for the create request. + */ + ClientToken?: __stringMin0Max64; + /** + * The description of the filter. + */ + Description?: FilterDescription; + /** + * The unique ID of the detector that you want to update. + */ + DetectorId: __string; + /** + * Represents the criteria to be used in the filter for querying findings. + */ + FindingCriteria: FindingCriteria; + /** + * The name of the filter. + */ + Name: FilterName; + /** + * Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings. + */ + Rank?: FilterRank; + } + export interface CreateFilterResponse { + /** + * The name of the successfully created filter. + */ + Name?: FilterName; + } + export interface CreateIPSetRequest { + /** + * A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet. + */ + Activate: Activate; + /** + * The idempotency token for the create request. + */ + ClientToken?: __stringMin0Max64; + /** + * The unique ID of the detector that you want to update. + */ + DetectorId: __string; + /** + * The format of the file that contains the IPSet. + */ + Format: IpSetFormat; + /** + * The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key) + */ + Location: Location; + /** + * The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet. + */ + Name: Name; + } + export interface CreateIPSetResponse { + IpSetId?: IpSetId; + } + export interface CreateMembersRequest { + /** + * A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty account. + */ + AccountDetails: AccountDetails; + /** + * The unique ID of the detector of the GuardDuty account with which you want to associate member accounts. + */ + DetectorId: __string; + } + export interface CreateMembersResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface CreateSampleFindingsRequest { + /** + * The ID of the detector to create sample findings for. + */ + DetectorId: __string; + /** + * Types of sample findings that you want to generate. + */ + FindingTypes?: FindingTypes; + } + export interface CreateSampleFindingsResponse { + } + export interface CreateThreatIntelSetRequest { + /** + * A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet. + */ + Activate: Activate; + /** + * The idempotency token for the create request. + */ + ClientToken?: __stringMin0Max64; + /** + * The unique ID of the detector that you want to update. + */ + DetectorId: __string; + /** + * The format of the file that contains the ThreatIntelSet. + */ + Format: ThreatIntelSetFormat; + /** + * The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). + */ + Location: Location; + /** + * A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet. + */ + Name: Name; + } + export interface CreateThreatIntelSetResponse { + ThreatIntelSetId?: ThreatIntelSetId; + } + export type CreatedAt = string; + export interface DeclineInvitationsRequest { + /** + * A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to decline invitations from. + */ + AccountIds: AccountIds; + } + export interface DeclineInvitationsResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface DeleteDetectorRequest { + /** + * The unique ID that specifies the detector that you want to delete. + */ + DetectorId: __string; + } + export interface DeleteDetectorResponse { + } + export interface DeleteFilterRequest { + /** + * The unique ID that specifies the detector where you want to delete a filter. + */ + DetectorId: __string; + /** + * The name of the filter. + */ + FilterName: __string; + } + export interface DeleteFilterResponse { + } + export interface DeleteIPSetRequest { + /** + * The detectorID that specifies the GuardDuty service whose IPSet you want to delete. + */ + DetectorId: __string; + /** + * The unique ID that specifies the IPSet that you want to delete. + */ + IpSetId: __string; + } + export interface DeleteIPSetResponse { + } + export interface DeleteInvitationsRequest { + /** + * A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to delete invitations from. + */ + AccountIds: AccountIds; + } + export interface DeleteInvitationsResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface DeleteMembersRequest { + /** + * A list of account IDs of the GuardDuty member accounts that you want to delete. + */ + AccountIds: AccountIds; + /** + * The unique ID of the detector of the GuardDuty account whose members you want to delete. + */ + DetectorId: __string; + } + export interface DeleteMembersResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface DeleteThreatIntelSetRequest { + /** + * The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to delete. + */ + DetectorId: __string; + /** + * The unique ID that specifies the ThreatIntelSet that you want to delete. + */ + ThreatIntelSetId: __string; + } + export interface DeleteThreatIntelSetResponse { + } + export type DetectorId = string; + export type DetectorIds = DetectorId[]; + export type DetectorStatus = "ENABLED"|"DISABLED"|string; + export interface DisassociateFromMasterAccountRequest { + /** + * The unique ID of the detector of the GuardDuty member account. + */ + DetectorId: __string; + } + export interface DisassociateFromMasterAccountResponse { + } + export interface DisassociateMembersRequest { + /** + * A list of account IDs of the GuardDuty member accounts that you want to disassociate from master. + */ + AccountIds: AccountIds; + /** + * The unique ID of the detector of the GuardDuty account whose members you want to disassociate from master. + */ + DetectorId: __string; + } + export interface DisassociateMembersResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface DnsRequestAction { + /** + * Domain information for the DNS request. + */ + Domain?: Domain; + } + export type Domain = string; + export interface DomainDetails { + } + export type Email = string; + export type Enable = boolean; + export type Eq = __string[]; + export type Feedback = "USEFUL"|"NOT_USEFUL"|string; + export type FilterAction = "NOOP"|"ARCHIVE"|string; + export type FilterDescription = string; + export type FilterName = string; + export type FilterNames = FilterName[]; + export type FilterRank = number; + export interface Finding { + /** + * AWS account ID where the activity occurred that prompted GuardDuty to generate a finding. + */ + AccountId: __string; + /** + * The ARN of a finding described by the action. + */ + Arn: __string; + /** + * The confidence level of a finding. + */ + Confidence?: __double; + /** + * The time stamp at which a finding was generated. + */ + CreatedAt: CreatedAt; + /** + * The description of a finding. + */ + Description?: __string; + /** + * The identifier that corresponds to a finding described by the action. + */ + Id: __string; + /** + * The AWS resource partition. + */ + Partition?: __string; + /** + * The AWS region where the activity occurred that prompted GuardDuty to generate a finding. + */ + Region: __string; + /** + * The AWS resource associated with the activity that prompted GuardDuty to generate a finding. + */ + Resource: Resource; + /** + * Findings' schema version. + */ + SchemaVersion: __string; + /** + * Additional information assigned to the generated finding by GuardDuty. + */ + Service?: Service; + /** + * The severity of a finding. + */ + Severity: __double; + /** + * The title of a finding. + */ + Title?: __string; + /** + * The type of a finding described by the action. + */ + Type: __string; + /** + * The time stamp at which a finding was last updated. + */ + UpdatedAt: UpdatedAt; + } + export interface FindingCriteria { + /** + * Represents a map of finding properties that match specified conditions and values when querying findings. + */ + Criterion?: __mapOfCondition; + } + export type FindingId = string; + export type FindingIds = FindingId[]; + export type FindingPublishingFrequency = "FIFTEEN_MINUTES"|"ONE_HOUR"|"SIX_HOURS"|string; + export type FindingStatisticType = "COUNT_BY_SEVERITY"|string; + export type FindingStatisticTypes = FindingStatisticType[]; + export interface FindingStatistics { + /** + * Represents a map of severity to count statistic for a set of findings + */ + CountBySeverity?: __mapOfCountBySeverityFindingStatistic; + } + export type FindingType = string; + export type FindingTypes = FindingType[]; + export type Findings = Finding[]; + export interface GeoLocation { + /** + * Latitude information of remote IP address. + */ + Lat?: __double; + /** + * Longitude information of remote IP address. + */ + Lon?: __double; + } + export interface GetDetectorRequest { + /** + * The unique ID of the detector that you want to retrieve. + */ + DetectorId: __string; + } + export interface GetDetectorResponse { + CreatedAt?: CreatedAt; + FindingPublishingFrequency?: FindingPublishingFrequency; + ServiceRole?: ServiceRole; + Status?: DetectorStatus; + UpdatedAt?: UpdatedAt; + } + export interface GetFilterRequest { + /** + * The detector ID that specifies the GuardDuty service where you want to list the details of the specified filter. + */ + DetectorId: __string; + /** + * The name of the filter whose details you want to get. + */ + FilterName: __string; + } + export interface GetFilterResponse { + /** + * Specifies the action that is to be applied to the findings that match the filter. + */ + Action?: FilterAction; + /** + * The description of the filter. + */ + Description?: FilterDescription; + /** + * Represents the criteria to be used in the filter for querying findings. + */ + FindingCriteria?: FindingCriteria; + /** + * The name of the filter. + */ + Name?: FilterName; + /** + * Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings. + */ + Rank?: FilterRank; + } + export interface GetFindingsRequest { + /** + * The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve. + */ + DetectorId: __string; + /** + * IDs of the findings that you want to retrieve. + */ + FindingIds: FindingIds; + /** + * Represents the criteria used for sorting findings. + */ + SortCriteria?: SortCriteria; + } + export interface GetFindingsResponse { + Findings?: Findings; + } + export interface GetFindingsStatisticsRequest { + /** + * The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve. + */ + DetectorId: __string; + /** + * Represents the criteria used for querying findings. + */ + FindingCriteria?: FindingCriteria; + /** + * Types of finding statistics to retrieve. + */ + FindingStatisticTypes: FindingStatisticTypes; + } + export interface GetFindingsStatisticsResponse { + /** + * Finding statistics object. + */ + FindingStatistics?: FindingStatistics; + } + export interface GetIPSetRequest { + /** + * The detectorID that specifies the GuardDuty service whose IPSet you want to retrieve. + */ + DetectorId: __string; + /** + * The unique ID that specifies the IPSet that you want to describe. + */ + IpSetId: __string; + } + export interface GetIPSetResponse { + /** + * The format of the file that contains the IPSet. + */ + Format?: IpSetFormat; + /** + * The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key) + */ + Location?: Location; + /** + * The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet. + */ + Name?: Name; + /** + * The status of ipSet file uploaded. + */ + Status?: IpSetStatus; + } + export interface GetInvitationsCountRequest { + } + export interface GetInvitationsCountResponse { + /** + * The number of received invitations. + */ + InvitationsCount?: __integer; + } + export interface GetMasterAccountRequest { + /** + * The unique ID of the detector of the GuardDuty member account. + */ + DetectorId: __string; + } + export interface GetMasterAccountResponse { + Master?: Master; + } + export interface GetMembersRequest { + /** + * A list of account IDs of the GuardDuty member accounts that you want to describe. + */ + AccountIds: AccountIds; + /** + * The unique ID of the detector of the GuardDuty account whose members you want to retrieve. + */ + DetectorId: __string; + } + export interface GetMembersResponse { + Members?: Members; + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface GetThreatIntelSetRequest { + /** + * The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to describe. + */ + DetectorId: __string; + /** + * The unique ID that specifies the ThreatIntelSet that you want to describe. + */ + ThreatIntelSetId: __string; + } + export interface GetThreatIntelSetResponse { + /** + * The format of the threatIntelSet. + */ + Format?: ThreatIntelSetFormat; + /** + * The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). + */ + Location?: Location; + /** + * A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet. + */ + Name?: Name; + /** + * The status of threatIntelSet file uploaded. + */ + Status?: ThreatIntelSetStatus; + } + export interface IamInstanceProfile { + /** + * AWS EC2 instance profile ARN. + */ + Arn?: __string; + /** + * AWS EC2 instance profile ID. + */ + Id?: __string; + } + export interface InstanceDetails { + /** + * The availability zone of the EC2 instance. + */ + AvailabilityZone?: __string; + IamInstanceProfile?: IamInstanceProfile; + /** + * The image description of the EC2 instance. + */ + ImageDescription?: __string; + /** + * The image ID of the EC2 instance. + */ + ImageId?: __string; + /** + * The ID of the EC2 instance. + */ + InstanceId?: __string; + /** + * The state of the EC2 instance. + */ + InstanceState?: __string; + /** + * The type of the EC2 instance. + */ + InstanceType?: __string; + /** + * The launch time of the EC2 instance. + */ + LaunchTime?: __string; + /** + * The network interface information of the EC2 instance. + */ + NetworkInterfaces?: NetworkInterfaces; + /** + * The platform of the EC2 instance. + */ + Platform?: __string; + /** + * The product code of the EC2 instance. + */ + ProductCodes?: ProductCodes; + /** + * The tags of the EC2 instance. + */ + Tags?: Tags; + } + export interface Invitation { + /** + * Inviter account ID + */ + AccountId?: __string; + /** + * This value is used to validate the inviter account to the member account. + */ + InvitationId?: InvitationId; + /** + * Timestamp at which the invitation was sent + */ + InvitedAt?: InvitedAt; + /** + * The status of the relationship between the inviter and invitee accounts. + */ + RelationshipStatus?: __string; + } + export type InvitationId = string; + export type Invitations = Invitation[]; + export interface InviteMembersRequest { + /** + * A list of account IDs of the accounts that you want to invite to GuardDuty as members. + */ + AccountIds: AccountIds; + /** + * The unique ID of the detector of the GuardDuty account with which you want to invite members. + */ + DetectorId: __string; + /** + * A boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members. + */ + DisableEmailNotification?: __boolean; + /** + * The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members. + */ + Message?: Message; + } + export interface InviteMembersResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export type InvitedAt = string; + export type IpSetFormat = "TXT"|"STIX"|"OTX_CSV"|"ALIEN_VAULT"|"PROOF_POINT"|"FIRE_EYE"|string; + export type IpSetId = string; + export type IpSetIds = IpSetId[]; + export type IpSetStatus = "INACTIVE"|"ACTIVATING"|"ACTIVE"|"DEACTIVATING"|"ERROR"|"DELETE_PENDING"|"DELETED"|string; + export type Ipv6Address = string; + export type Ipv6Addresses = Ipv6Address[]; + export interface ListDetectorsRequest { + /** + * You can use this parameter to indicate the maximum number of detectors that you want in the response. + */ + MaxResults?: MaxResults; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListDetectors action. For subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + NextToken?: __string; + } + export interface ListDetectorsResponse { + DetectorIds?: DetectorIds; + NextToken?: NextToken; + } + export interface ListFiltersRequest { + /** + * The ID of the detector that specifies the GuardDuty service where you want to list filters. + */ + DetectorId: __string; + /** + * Indicates the maximum number of items that you want in the response. The maximum value is 50. + */ + MaxResults?: MaxResults; + /** + * Paginates results. Set the value of this parameter to NULL on your first call to the ListFilters operation.For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + NextToken?: __string; + } + export interface ListFiltersResponse { + FilterNames?: FilterNames; + NextToken?: NextToken; + } + export interface ListFindingsRequest { + /** + * The ID of the detector that specifies the GuardDuty service whose findings you want to list. + */ + DetectorId: __string; + /** + * Represents the criteria used for querying findings. + */ + FindingCriteria?: FindingCriteria; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50. + */ + MaxResults?: MaxResults; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. For subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + NextToken?: NextToken; + /** + * Represents the criteria used for sorting findings. + */ + SortCriteria?: SortCriteria; + } + export interface ListFindingsResponse { + FindingIds?: FindingIds; + NextToken?: NextToken; + } + export interface ListIPSetsRequest { + /** + * The unique ID of the detector that you want to retrieve. + */ + DetectorId: __string; + /** + * You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 7. The maximum value is 7. + */ + MaxResults?: MaxResults; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListIPSet action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + NextToken?: __string; + } + export interface ListIPSetsResponse { + IpSetIds?: IpSetIds; + NextToken?: NextToken; + } + export interface ListInvitationsRequest { + /** + * You can use this parameter to indicate the maximum number of invitations you want in the response. The default value is 50. The maximum value is 50. + */ + MaxResults?: MaxResults; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListInvitations action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + NextToken?: __string; + } + export interface ListInvitationsResponse { + Invitations?: Invitations; + NextToken?: NextToken; + } + export interface ListMembersRequest { + /** + * The unique ID of the detector of the GuardDuty account whose members you want to list. + */ + DetectorId: __string; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 1. The maximum value is 50. + */ + MaxResults?: MaxResults; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMembers action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + NextToken?: __string; + /** + * Specifies what member accounts the response is to include based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response will include member accounts whose relationship status with the master is set to Enabled, Disabled. If onlyAssociated is set to FALSE, the response will include all existing member accounts. + */ + OnlyAssociated?: __string; + } + export interface ListMembersResponse { + Members?: Members; + NextToken?: NextToken; + } + export interface ListThreatIntelSetsRequest { + /** + * The detectorID that specifies the GuardDuty service whose ThreatIntelSets you want to list. + */ + DetectorId: __string; + /** + * You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 7. The maximum value is 7. + */ + MaxResults?: MaxResults; + /** + * Pagination token to start retrieving threat intel sets from. + */ + NextToken?: __string; + } + export interface ListThreatIntelSetsResponse { + NextToken?: NextToken; + ThreatIntelSetIds?: ThreatIntelSetIds; + } + export interface LocalPortDetails { + /** + * Port number of the local connection. + */ + Port?: __integer; + /** + * Port name of the local connection. + */ + PortName?: __string; + } + export type Location = string; + export interface Master { + /** + * Master account ID + */ + AccountId?: __string; + /** + * This value is used to validate the master account to the member account. + */ + InvitationId?: InvitationId; + /** + * Timestamp at which the invitation was sent + */ + InvitedAt?: InvitedAt; + /** + * The status of the relationship between the master and member accounts. + */ + RelationshipStatus?: __string; + } + export type MasterId = string; + export type MaxResults = number; + export interface Member { + AccountId: AccountId; + DetectorId?: DetectorId; + /** + * Member account's email address. + */ + Email: Email; + /** + * Timestamp at which the invitation was sent + */ + InvitedAt?: InvitedAt; + MasterId: MasterId; + /** + * The status of the relationship between the member and the master. + */ + RelationshipStatus: __string; + UpdatedAt: UpdatedAt; + } + export type Members = Member[]; + export type Message = string; + export type Name = string; + export type Neq = __string[]; + export interface NetworkConnectionAction { + /** + * Network connection blocked information. + */ + Blocked?: __boolean; + /** + * Network connection direction. + */ + ConnectionDirection?: __string; + /** + * Local port information of the connection. + */ + LocalPortDetails?: LocalPortDetails; + /** + * Network connection protocol. + */ + Protocol?: __string; + /** + * Remote IP information of the connection. + */ + RemoteIpDetails?: RemoteIpDetails; + /** + * Remote port information of the connection. + */ + RemotePortDetails?: RemotePortDetails; + } + export interface NetworkInterface { + /** + * A list of EC2 instance IPv6 address information. + */ + Ipv6Addresses?: Ipv6Addresses; + /** + * The ID of the network interface + */ + NetworkInterfaceId?: NetworkInterfaceId; + /** + * Private DNS name of the EC2 instance. + */ + PrivateDnsName?: PrivateDnsName; + /** + * Private IP address of the EC2 instance. + */ + PrivateIpAddress?: PrivateIpAddress; + /** + * Other private IP address information of the EC2 instance. + */ + PrivateIpAddresses?: PrivateIpAddresses; + /** + * Public DNS name of the EC2 instance. + */ + PublicDnsName?: __string; + /** + * Public IP address of the EC2 instance. + */ + PublicIp?: __string; + /** + * Security groups associated with the EC2 instance. + */ + SecurityGroups?: SecurityGroups; + /** + * The subnet ID of the EC2 instance. + */ + SubnetId?: __string; + /** + * The VPC ID of the EC2 instance. + */ + VpcId?: __string; + } + export type NetworkInterfaceId = string; + export type NetworkInterfaces = NetworkInterface[]; + export type NextToken = string; + export type OrderBy = "ASC"|"DESC"|string; + export interface Organization { + /** + * Autonomous system number of the internet provider of the remote IP address. + */ + Asn?: __string; + /** + * Organization that registered this ASN. + */ + AsnOrg?: __string; + /** + * ISP information for the internet provider. + */ + Isp?: __string; + /** + * Name of the internet provider. + */ + Org?: __string; + } + export interface PortProbeAction { + /** + * Port probe blocked information. + */ + Blocked?: __boolean; + /** + * A list of port probe details objects. + */ + PortProbeDetails?: __listOfPortProbeDetail; + } + export interface PortProbeDetail { + /** + * Local port information of the connection. + */ + LocalPortDetails?: LocalPortDetails; + /** + * Remote IP information of the connection. + */ + RemoteIpDetails?: RemoteIpDetails; + } + export type PrivateDnsName = string; + export type PrivateIpAddress = string; + export interface PrivateIpAddressDetails { + /** + * Private DNS name of the EC2 instance. + */ + PrivateDnsName?: PrivateDnsName; + /** + * Private IP address of the EC2 instance. + */ + PrivateIpAddress?: PrivateIpAddress; + } + export type PrivateIpAddresses = PrivateIpAddressDetails[]; + export interface ProductCode { + /** + * Product code information. + */ + Code?: __string; + /** + * Product code type. + */ + ProductType?: __string; + } + export type ProductCodes = ProductCode[]; + export interface RemoteIpDetails { + /** + * City information of the remote IP address. + */ + City?: City; + /** + * Country code of the remote IP address. + */ + Country?: Country; + /** + * Location information of the remote IP address. + */ + GeoLocation?: GeoLocation; + /** + * IPV4 remote address of the connection. + */ + IpAddressV4?: __string; + /** + * ISP Organization information of the remote IP address. + */ + Organization?: Organization; + } + export interface RemotePortDetails { + /** + * Port number of the remote connection. + */ + Port?: __integer; + /** + * Port name of the remote connection. + */ + PortName?: __string; + } + export interface Resource { + AccessKeyDetails?: AccessKeyDetails; + InstanceDetails?: InstanceDetails; + /** + * The type of the AWS resource. + */ + ResourceType?: __string; + } + export interface SecurityGroup { + /** + * EC2 instance's security group ID. + */ + GroupId?: __string; + /** + * EC2 instance's security group name. + */ + GroupName?: __string; + } + export type SecurityGroups = SecurityGroup[]; + export interface Service { + /** + * Information about the activity described in a finding. + */ + Action?: Action; + /** + * Indicates whether this finding is archived. + */ + Archived?: __boolean; + /** + * Total count of the occurrences of this finding type. + */ + Count?: __integer; + /** + * Detector ID for the GuardDuty service. + */ + DetectorId?: DetectorId; + /** + * First seen timestamp of the activity that prompted GuardDuty to generate this finding. + */ + EventFirstSeen?: __string; + /** + * Last seen timestamp of the activity that prompted GuardDuty to generate this finding. + */ + EventLastSeen?: __string; + /** + * Resource role information for this finding. + */ + ResourceRole?: __string; + /** + * The name of the AWS service (GuardDuty) that generated a finding. + */ + ServiceName?: __string; + /** + * Feedback left about the finding. + */ + UserFeedback?: __string; + } + export type ServiceRole = string; + export interface SortCriteria { + /** + * Represents the finding attribute (for example, accountId) by which to sort findings. + */ + AttributeName?: __string; + /** + * Order by which the sorted findings are to be displayed. + */ + OrderBy?: OrderBy; + } + export interface StartMonitoringMembersRequest { + /** + * A list of account IDs of the GuardDuty member accounts whose findings you want the master account to monitor. + */ + AccountIds: AccountIds; + /** + * The unique ID of the detector of the GuardDuty account whom you want to re-enable to monitor members' findings. + */ + DetectorId: __string; + } + export interface StartMonitoringMembersResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface StopMonitoringMembersRequest { + /** + * A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop monitoring. + */ + AccountIds: AccountIds; + /** + * The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings. + */ + DetectorId: __string; + } + export interface StopMonitoringMembersResponse { + /** + * A list of objects containing the unprocessed account and a result string explaining why it was unprocessed. + */ + UnprocessedAccounts?: UnprocessedAccounts; + } + export interface Tag { + /** + * EC2 instance tag key. + */ + Key?: __string; + /** + * EC2 instance tag value. + */ + Value?: __string; + } + export type Tags = Tag[]; + export type ThreatIntelSetFormat = "TXT"|"STIX"|"OTX_CSV"|"ALIEN_VAULT"|"PROOF_POINT"|"FIRE_EYE"|string; + export type ThreatIntelSetId = string; + export type ThreatIntelSetIds = ThreatIntelSetId[]; + export type ThreatIntelSetStatus = "INACTIVE"|"ACTIVATING"|"ACTIVE"|"DEACTIVATING"|"ERROR"|"DELETE_PENDING"|"DELETED"|string; + export interface UnarchiveFindingsRequest { + /** + * The ID of the detector that specifies the GuardDuty service whose findings you want to unarchive. + */ + DetectorId: __string; + /** + * IDs of the findings that you want to unarchive. + */ + FindingIds: FindingIds; + } + export interface UnarchiveFindingsResponse { + } + export interface UnprocessedAccount { + /** + * AWS Account ID. + */ + AccountId: __string; + /** + * A reason why the account hasn't been processed. + */ + Result: __string; + } + export type UnprocessedAccounts = UnprocessedAccount[]; + export interface UpdateDetectorRequest { + /** + * The unique ID of the detector that you want to update. + */ + DetectorId: __string; + /** + * Updated boolean value for the detector that specifies whether the detector is enabled. + */ + Enable?: Enable; + /** + * A enum value that specifies how frequently customer got Finding updates published. + */ + FindingPublishingFrequency?: FindingPublishingFrequency; + } + export interface UpdateDetectorResponse { + } + export interface UpdateFilterRequest { + /** + * Specifies the action that is to be applied to the findings that match the filter. + */ + Action?: FilterAction; + /** + * The description of the filter. + */ + Description?: FilterDescription; + /** + * The unique ID of the detector that specifies the GuardDuty service where you want to update a filter. + */ + DetectorId: __string; + /** + * The name of the filter. + */ + FilterName: __string; + /** + * Represents the criteria to be used in the filter for querying findings. + */ + FindingCriteria?: FindingCriteria; + /** + * Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings. + */ + Rank?: FilterRank; + } + export interface UpdateFilterResponse { + /** + * The name of the filter. + */ + Name?: FilterName; + } + export interface UpdateFindingsFeedbackRequest { + /** + * Additional feedback about the GuardDuty findings. + */ + Comments?: Comments; + /** + * The ID of the detector that specifies the GuardDuty service whose findings you want to mark as useful or not useful. + */ + DetectorId: __string; + /** + * Valid values: USEFUL | NOT_USEFUL + */ + Feedback: Feedback; + /** + * IDs of the findings that you want to mark as useful or not useful. + */ + FindingIds: FindingIds; + } + export interface UpdateFindingsFeedbackResponse { + } + export interface UpdateIPSetRequest { + /** + * The updated boolean value that specifies whether the IPSet is active or not. + */ + Activate?: Activate; + /** + * The detectorID that specifies the GuardDuty service whose IPSet you want to update. + */ + DetectorId: __string; + /** + * The unique ID that specifies the IPSet that you want to update. + */ + IpSetId: __string; + /** + * The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key). + */ + Location?: Location; + /** + * The unique ID that specifies the IPSet that you want to update. + */ + Name?: Name; + } + export interface UpdateIPSetResponse { + } + export interface UpdateThreatIntelSetRequest { + /** + * The updated boolean value that specifies whether the ThreateIntelSet is active or not. + */ + Activate?: Activate; + /** + * The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update. + */ + DetectorId: __string; + /** + * The updated URI of the file that contains the ThreateIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key) + */ + Location?: Location; + /** + * The unique ID that specifies the ThreatIntelSet that you want to update. + */ + Name?: Name; + /** + * The unique ID that specifies the ThreatIntelSet that you want to update. + */ + ThreatIntelSetId: __string; + } + export interface UpdateThreatIntelSetResponse { + } + export type UpdatedAt = string; + export type __boolean = boolean; + export type __double = number; + export type __integer = number; + export type __listOfPortProbeDetail = PortProbeDetail[]; + export type __mapOfCondition = {[key: string]: Condition}; + export type __mapOfCountBySeverityFindingStatistic = {[key: string]: CountBySeverityFindingStatistic}; + export type __string = string; + export type __stringMin0Max64 = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-11-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the GuardDuty client. + */ + export import Types = GuardDuty; +} +export = GuardDuty; diff --git a/node_modules/aws-sdk/clients/guardduty.js b/node_modules/aws-sdk/clients/guardduty.js new file mode 100644 index 0000000..8b0cc74 --- /dev/null +++ b/node_modules/aws-sdk/clients/guardduty.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['guardduty'] = {}; +AWS.GuardDuty = Service.defineService('guardduty', ['2017-11-28']); +Object.defineProperty(apiLoader.services['guardduty'], '2017-11-28', { + get: function get() { + var model = require('../apis/guardduty-2017-11-28.min.json'); + model.paginators = require('../apis/guardduty-2017-11-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.GuardDuty; diff --git a/node_modules/aws-sdk/clients/health.d.ts b/node_modules/aws-sdk/clients/health.d.ts new file mode 100644 index 0000000..bd75851 --- /dev/null +++ b/node_modules/aws-sdk/clients/health.d.ts @@ -0,0 +1,518 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Health extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Health.Types.ClientConfiguration) + config: Config & Health.Types.ClientConfiguration; + /** + * Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. + */ + describeAffectedEntities(params: Health.Types.DescribeAffectedEntitiesRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request; + /** + * Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. + */ + describeAffectedEntities(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request; + /** + * Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned. + */ + describeEntityAggregates(params: Health.Types.DescribeEntityAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request; + /** + * Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned. + */ + describeEntityAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request; + /** + * Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned. + */ + describeEventAggregates(params: Health.Types.DescribeEventAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request; + /** + * Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned. + */ + describeEventAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request; + /** + * Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation. If a specified event cannot be retrieved, an error message is returned for that event. + */ + describeEventDetails(params: Health.Types.DescribeEventDetailsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request; + /** + * Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation. If a specified event cannot be retrieved, an error message is returned for that event. + */ + describeEventDetails(callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request; + /** + * Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order. + */ + describeEventTypes(params: Health.Types.DescribeEventTypesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request; + /** + * Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order. + */ + describeEventTypes(callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request; + /** + * Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent. + */ + describeEvents(params: Health.Types.DescribeEventsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request; + /** + * Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent. + */ + describeEvents(callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request; +} +declare namespace Health { + export interface AffectedEntity { + /** + * The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K + */ + entityArn?: entityArn; + /** + * The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + */ + eventArn?: eventArn; + /** + * The ID of the affected entity. + */ + entityValue?: entityValue; + entityUrl?: entityUrl; + /** + * The 12-digit AWS account number that contains the affected entity. + */ + awsAccountId?: accountId; + /** + * The most recent time that the entity was updated. + */ + lastUpdatedTime?: timestamp; + /** + * The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN. + */ + statusCode?: entityStatusCode; + /** + * A map of entity tags attached to the affected entity. + */ + tags?: tagSet; + } + export interface DateTimeRange { + /** + * The starting date and time of a time range. + */ + from?: timestamp; + /** + * The ending date and time of a time range. + */ + to?: timestamp; + } + export interface DescribeAffectedEntitiesRequest { + /** + * Values to narrow the results returned. At least one event ARN is required. + */ + filter: EntityFilter; + /** + * The locale (language) to return information in. English (en) is the default and the only supported value at this time. + */ + locale?: locale; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + /** + * The maximum number of items to return in one batch, between 10 and 100, inclusive. + */ + maxResults?: maxResults; + } + export interface DescribeAffectedEntitiesResponse { + /** + * The entities that match the filter criteria. + */ + entities?: EntityList; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + } + export interface DescribeEntityAggregatesRequest { + /** + * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" + */ + eventArns?: EventArnsList; + } + export interface DescribeEntityAggregatesResponse { + /** + * The number of entities that are affected by each of the specified events. + */ + entityAggregates?: EntityAggregateList; + } + export interface DescribeEventAggregatesRequest { + /** + * Values to narrow the results returned. + */ + filter?: EventFilter; + /** + * The only currently supported value is eventTypeCategory. + */ + aggregateField: eventAggregateField; + /** + * The maximum number of items to return in one batch, between 10 and 100, inclusive. + */ + maxResults?: maxResults; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + } + export interface DescribeEventAggregatesResponse { + /** + * The number of events in each category that meet the optional filter criteria. + */ + eventAggregates?: EventAggregateList; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + } + export type DescribeEventDetailsFailedSet = EventDetailsErrorItem[]; + export interface DescribeEventDetailsRequest { + /** + * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" + */ + eventArns: eventArnList; + /** + * The locale (language) to return information in. English (en) is the default and the only supported value at this time. + */ + locale?: locale; + } + export interface DescribeEventDetailsResponse { + /** + * Information about the events that could be retrieved. + */ + successfulSet?: DescribeEventDetailsSuccessfulSet; + /** + * Error messages for any events that could not be retrieved. + */ + failedSet?: DescribeEventDetailsFailedSet; + } + export type DescribeEventDetailsSuccessfulSet = EventDetails[]; + export interface DescribeEventTypesRequest { + /** + * Values to narrow the results returned. + */ + filter?: EventTypeFilter; + /** + * The locale (language) to return information in. English (en) is the default and the only supported value at this time. + */ + locale?: locale; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + /** + * The maximum number of items to return in one batch, between 10 and 100, inclusive. + */ + maxResults?: maxResults; + } + export interface DescribeEventTypesResponse { + /** + * A list of event types that match the filter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT). + */ + eventTypes?: EventTypeList; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + } + export interface DescribeEventsRequest { + /** + * Values to narrow the results returned. + */ + filter?: EventFilter; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + /** + * The maximum number of items to return in one batch, between 10 and 100, inclusive. + */ + maxResults?: maxResults; + /** + * The locale (language) to return information in. English (en) is the default and the only supported value at this time. + */ + locale?: locale; + } + export interface DescribeEventsResponse { + /** + * The events that match the specified filter criteria. + */ + events?: EventList; + /** + * If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. + */ + nextToken?: nextToken; + } + export interface EntityAggregate { + /** + * The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + */ + eventArn?: eventArn; + /** + * The number entities that match the criteria for the specified events. + */ + count?: count; + } + export type EntityAggregateList = EntityAggregate[]; + export interface EntityFilter { + /** + * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" + */ + eventArns: eventArnList; + /** + * A list of entity ARNs (unique identifiers). + */ + entityArns?: entityArnList; + /** + * A list of IDs for affected entities. + */ + entityValues?: entityValueList; + /** + * A list of the most recent dates and times that the entity was updated. + */ + lastUpdatedTimes?: dateTimeRangeList; + /** + * A map of entity tags attached to the affected entity. + */ + tags?: tagFilter; + /** + * A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN). + */ + statusCodes?: entityStatusCodeList; + } + export type EntityList = AffectedEntity[]; + export interface Event { + /** + * The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + */ + arn?: eventArn; + /** + * The AWS service that is affected by the event. For example, EC2, RDS. + */ + service?: service; + /** + * The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + */ + eventTypeCode?: eventTypeCode; + /** + * The category of the event. Possible values are issue, scheduledChange, and accountNotification. + */ + eventTypeCategory?: eventTypeCategory; + /** + * The AWS region name of the event. + */ + region?: region; + /** + * The AWS Availability Zone of the event. For example, us-east-1a. + */ + availabilityZone?: availabilityZone; + /** + * The date and time that the event began. + */ + startTime?: timestamp; + /** + * The date and time that the event ended. + */ + endTime?: timestamp; + /** + * The most recent date and time that the event was updated. + */ + lastUpdatedTime?: timestamp; + /** + * The most recent status of the event. Possible values are open, closed, and upcoming. + */ + statusCode?: eventStatusCode; + } + export interface EventAggregate { + /** + * The issue type for the associated count. + */ + aggregateValue?: aggregateValue; + /** + * The number of events of the associated issue type. + */ + count?: count; + } + export type EventAggregateList = EventAggregate[]; + export type EventArnsList = eventArn[]; + export interface EventDescription { + /** + * The most recent description of the event. + */ + latestDescription?: eventDescription; + } + export interface EventDetails { + /** + * Summary information about the event. + */ + event?: Event; + /** + * The most recent description of the event. + */ + eventDescription?: EventDescription; + /** + * Additional metadata about the event. + */ + eventMetadata?: eventMetadata; + } + export interface EventDetailsErrorItem { + /** + * The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + */ + eventArn?: eventArn; + /** + * The name of the error. + */ + errorName?: string; + /** + * A message that describes the error. + */ + errorMessage?: string; + } + export interface EventFilter { + /** + * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" + */ + eventArns?: eventArnList; + /** + * A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED" + */ + eventTypeCodes?: eventTypeList; + /** + * The AWS services associated with the event. For example, EC2, RDS. + */ + services?: serviceList; + /** + * A list of AWS regions. + */ + regions?: regionList; + /** + * A list of AWS availability zones. + */ + availabilityZones?: availabilityZones; + /** + * A list of dates and times that the event began. + */ + startTimes?: dateTimeRangeList; + /** + * A list of dates and times that the event ended. + */ + endTimes?: dateTimeRangeList; + /** + * A list of dates and times that the event was last updated. + */ + lastUpdatedTimes?: dateTimeRangeList; + /** + * A list of entity ARNs (unique identifiers). + */ + entityArns?: entityArnList; + /** + * A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e). + */ + entityValues?: entityValueList; + /** + * A list of event type category codes (issue, scheduledChange, or accountNotification). + */ + eventTypeCategories?: eventTypeCategoryList; + /** + * A map of entity tags attached to the affected entity. + */ + tags?: tagFilter; + /** + * A list of event status codes. + */ + eventStatusCodes?: eventStatusCodeList; + } + export type EventList = Event[]; + export interface EventType { + /** + * The AWS service that is affected by the event. For example, EC2, RDS. + */ + service?: service; + /** + * The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + */ + code?: eventTypeCode; + /** + * A list of event type category codes (issue, scheduledChange, or accountNotification). + */ + category?: eventTypeCategory; + } + export type EventTypeCategoryList = eventTypeCategory[]; + export type EventTypeCodeList = eventTypeCode[]; + export interface EventTypeFilter { + /** + * A list of event type codes. + */ + eventTypeCodes?: EventTypeCodeList; + /** + * The AWS services associated with the event. For example, EC2, RDS. + */ + services?: serviceList; + /** + * A list of event type category codes (issue, scheduledChange, or accountNotification). + */ + eventTypeCategories?: EventTypeCategoryList; + } + export type EventTypeList = EventType[]; + export type accountId = string; + export type aggregateValue = string; + export type availabilityZone = string; + export type availabilityZones = availabilityZone[]; + export type count = number; + export type dateTimeRangeList = DateTimeRange[]; + export type entityArn = string; + export type entityArnList = entityArn[]; + export type entityStatusCode = "IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|string; + export type entityStatusCodeList = entityStatusCode[]; + export type entityUrl = string; + export type entityValue = string; + export type entityValueList = entityValue[]; + export type eventAggregateField = "eventTypeCategory"|string; + export type eventArn = string; + export type eventArnList = eventArn[]; + export type eventDescription = string; + export type eventMetadata = {[key: string]: metadataValue}; + export type eventStatusCode = "open"|"closed"|"upcoming"|string; + export type eventStatusCodeList = eventStatusCode[]; + export type eventType = string; + export type eventTypeCategory = "issue"|"accountNotification"|"scheduledChange"|string; + export type eventTypeCategoryList = eventTypeCategory[]; + export type eventTypeCode = string; + export type eventTypeList = eventType[]; + export type locale = string; + export type maxResults = number; + export type metadataKey = string; + export type metadataValue = string; + export type nextToken = string; + export type region = string; + export type regionList = region[]; + export type service = string; + export type serviceList = service[]; + export type tagFilter = tagSet[]; + export type tagKey = string; + export type tagSet = {[key: string]: tagValue}; + export type tagValue = string; + export type timestamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-08-04"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Health client. + */ + export import Types = Health; +} +export = Health; diff --git a/node_modules/aws-sdk/clients/health.js b/node_modules/aws-sdk/clients/health.js new file mode 100644 index 0000000..30f4deb --- /dev/null +++ b/node_modules/aws-sdk/clients/health.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['health'] = {}; +AWS.Health = Service.defineService('health', ['2016-08-04']); +Object.defineProperty(apiLoader.services['health'], '2016-08-04', { + get: function get() { + var model = require('../apis/health-2016-08-04.min.json'); + model.paginators = require('../apis/health-2016-08-04.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Health; diff --git a/node_modules/aws-sdk/clients/iam.d.ts b/node_modules/aws-sdk/clients/iam.d.ts new file mode 100644 index 0000000..11c84a8 --- /dev/null +++ b/node_modules/aws-sdk/clients/iam.d.ts @@ -0,0 +1,4623 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class IAM extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: IAM.Types.ClientConfiguration) + config: Config & IAM.Types.ClientConfiguration; + /** + * Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource. This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider. + */ + addClientIDToOpenIDConnectProvider(params: IAM.Types.AddClientIDToOpenIDConnectProviderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource. This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider. + */ + addClientIDToOpenIDConnectProvider(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of AWS because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it. The caller of this API must be granted the PassRole permission on the IAM role by a permissions policy. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles. + */ + addRoleToInstanceProfile(params: IAM.Types.AddRoleToInstanceProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of AWS because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it. The caller of this API must be granted the PassRole permission on the IAM role by a permissions policy. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles. + */ + addRoleToInstanceProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds the specified user to the specified group. + */ + addUserToGroup(params: IAM.Types.AddUserToGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds the specified user to the specified group. + */ + addUserToGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified managed policy to the specified IAM group. You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + attachGroupPolicy(params: IAM.Types.AttachGroupPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified managed policy to the specified IAM group. You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + attachGroupPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + attachRolePolicy(params: IAM.Types.AttachRolePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + attachRolePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified managed policy to the specified user. You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + attachUserPolicy(params: IAM.Types.AttachUserPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified managed policy to the specified user. You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + attachUserPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the password of the IAM user who is calling this operation. The AWS account root user password is not affected by this operation. To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the IAM User Guide. + */ + changePassword(params: IAM.Types.ChangePasswordRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the password of the IAM user who is calling this operation. The AWS account root user password is not affected by this operation. To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the IAM User Guide. + */ + changePassword(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users. For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide. To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. + */ + createAccessKey(params: IAM.Types.CreateAccessKeyRequest, callback?: (err: AWSError, data: IAM.Types.CreateAccessKeyResponse) => void): Request; + /** + * Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users. For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide. To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. + */ + createAccessKey(callback?: (err: AWSError, data: IAM.Types.CreateAccessKeyResponse) => void): Request; + /** + * Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. + */ + createAccountAlias(params: IAM.Types.CreateAccountAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. + */ + createAccountAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new group. For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide. + */ + createGroup(params: IAM.Types.CreateGroupRequest, callback?: (err: AWSError, data: IAM.Types.CreateGroupResponse) => void): Request; + /** + * Creates a new group. For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide. + */ + createGroup(callback?: (err: AWSError, data: IAM.Types.CreateGroupResponse) => void): Request; + /** + * Creates a new instance profile. For information about instance profiles, go to About Instance Profiles. For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide. + */ + createInstanceProfile(params: IAM.Types.CreateInstanceProfileRequest, callback?: (err: AWSError, data: IAM.Types.CreateInstanceProfileResponse) => void): Request; + /** + * Creates a new instance profile. For information about instance profiles, go to About Instance Profiles. For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide. + */ + createInstanceProfile(callback?: (err: AWSError, data: IAM.Types.CreateInstanceProfileResponse) => void): Request; + /** + * Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide. + */ + createLoginProfile(params: IAM.Types.CreateLoginProfileRequest, callback?: (err: AWSError, data: IAM.Types.CreateLoginProfileResponse) => void): Request; + /** + * Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide. + */ + createLoginProfile(callback?: (err: AWSError, data: IAM.Types.CreateLoginProfileResponse) => void): Request; + /** + * Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC). The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider. When you create the IAM OIDC provider, you specify the following: The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider A list of thumbprints of the server certificate(s) that the IdP uses You get all of this information from the OIDC IdP that you want to use to access AWS. The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users. + */ + createOpenIDConnectProvider(params: IAM.Types.CreateOpenIDConnectProviderRequest, callback?: (err: AWSError, data: IAM.Types.CreateOpenIDConnectProviderResponse) => void): Request; + /** + * Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC). The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider. When you create the IAM OIDC provider, you specify the following: The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider A list of thumbprints of the server certificate(s) that the IdP uses You get all of this information from the OIDC IdP that you want to use to access AWS. The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users. + */ + createOpenIDConnectProvider(callback?: (err: AWSError, data: IAM.Types.CreateOpenIDConnectProviderResponse) => void): Request; + /** + * Creates a new managed policy for your AWS account. This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide. For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide. + */ + createPolicy(params: IAM.Types.CreatePolicyRequest, callback?: (err: AWSError, data: IAM.Types.CreatePolicyResponse) => void): Request; + /** + * Creates a new managed policy for your AWS account. This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide. For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide. + */ + createPolicy(callback?: (err: AWSError, data: IAM.Types.CreatePolicyResponse) => void): Request; + /** + * Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version. Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + createPolicyVersion(params: IAM.Types.CreatePolicyVersionRequest, callback?: (err: AWSError, data: IAM.Types.CreatePolicyVersionResponse) => void): Request; + /** + * Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version. Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + createPolicyVersion(callback?: (err: AWSError, data: IAM.Types.CreatePolicyVersionResponse) => void): Request; + /** + * Creates a new role for your AWS account. For more information about roles, go to IAM Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide. + */ + createRole(params: IAM.Types.CreateRoleRequest, callback?: (err: AWSError, data: IAM.Types.CreateRoleResponse) => void): Request; + /** + * Creates a new role for your AWS account. For more information about roles, go to IAM Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide. + */ + createRole(callback?: (err: AWSError, data: IAM.Types.CreateRoleResponse) => void): Request; + /** + * Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0. The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP. This operation requires Signature Version 4. For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide. + */ + createSAMLProvider(params: IAM.Types.CreateSAMLProviderRequest, callback?: (err: AWSError, data: IAM.Types.CreateSAMLProviderResponse) => void): Request; + /** + * Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0. The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP. This operation requires Signature Version 4. For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide. + */ + createSAMLProvider(callback?: (err: AWSError, data: IAM.Types.CreateSAMLProviderResponse) => void): Request; + /** + * Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using Service-Linked Roles in the IAM User Guide. To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role. + */ + createServiceLinkedRole(params: IAM.Types.CreateServiceLinkedRoleRequest, callback?: (err: AWSError, data: IAM.Types.CreateServiceLinkedRoleResponse) => void): Request; + /** + * Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using Service-Linked Roles in the IAM User Guide. To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role. + */ + createServiceLinkedRole(callback?: (err: AWSError, data: IAM.Types.CreateServiceLinkedRoleResponse) => void): Request; + /** + * Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. The only supported service at this time is AWS CodeCommit. You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide. + */ + createServiceSpecificCredential(params: IAM.Types.CreateServiceSpecificCredentialRequest, callback?: (err: AWSError, data: IAM.Types.CreateServiceSpecificCredentialResponse) => void): Request; + /** + * Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. The only supported service at this time is AWS CodeCommit. You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide. + */ + createServiceSpecificCredential(callback?: (err: AWSError, data: IAM.Types.CreateServiceSpecificCredentialResponse) => void): Request; + /** + * Creates a new IAM user for your AWS account. For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide. + */ + createUser(params: IAM.Types.CreateUserRequest, callback?: (err: AWSError, data: IAM.Types.CreateUserResponse) => void): Request; + /** + * Creates a new IAM user for your AWS account. For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide. + */ + createUser(callback?: (err: AWSError, data: IAM.Types.CreateUserResponse) => void): Request; + /** + * Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide. For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide. The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures. + */ + createVirtualMFADevice(params: IAM.Types.CreateVirtualMFADeviceRequest, callback?: (err: AWSError, data: IAM.Types.CreateVirtualMFADeviceResponse) => void): Request; + /** + * Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide. For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide. The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures. + */ + createVirtualMFADevice(callback?: (err: AWSError, data: IAM.Types.CreateVirtualMFADeviceResponse) => void): Request; + /** + * Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled. For more information about creating and working with virtual MFA devices, go to Enabling a Virtual Multi-factor Authentication (MFA) Device in the IAM User Guide. + */ + deactivateMFADevice(params: IAM.Types.DeactivateMFADeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled. For more information about creating and working with virtual MFA devices, go to Enabling a Virtual Multi-factor Authentication (MFA) Device in the IAM User Guide. + */ + deactivateMFADevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the access key pair associated with the specified IAM user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. + */ + deleteAccessKey(params: IAM.Types.DeleteAccessKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the access key pair associated with the specified IAM user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. + */ + deleteAccessKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. + */ + deleteAccountAlias(params: IAM.Types.DeleteAccountAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. + */ + deleteAccountAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the password policy for the AWS account. There are no parameters. + */ + deleteAccountPasswordPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified IAM group. The group must not contain any users or have any attached policies. + */ + deleteGroup(params: IAM.Types.DeleteGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified IAM group. The group must not contain any users or have any attached policies. + */ + deleteGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified inline policy that is embedded in the specified IAM group. A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. + */ + deleteGroupPolicy(params: IAM.Types.DeleteGroupPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified inline policy that is embedded in the specified IAM group. A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. + */ + deleteGroupPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified instance profile. The instance profile must not have an associated role. Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. For more information about instance profiles, go to About Instance Profiles. + */ + deleteInstanceProfile(params: IAM.Types.DeleteInstanceProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified instance profile. The instance profile must not have an associated role. Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. For more information about instance profiles, go to About Instance Profiles. + */ + deleteInstanceProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console. Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. + */ + deleteLoginProfile(params: IAM.Types.DeleteLoginProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console. Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. + */ + deleteLoginProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an OpenID Connect identity provider (IdP) resource object in IAM. Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails. This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist. + */ + deleteOpenIDConnectProvider(params: IAM.Types.DeleteOpenIDConnectProviderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an OpenID Connect identity provider (IdP) resource object in IAM. Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails. This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist. + */ + deleteOpenIDConnectProvider(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified managed policy. Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy: Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy API operations. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy. Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. Delete the policy (this automatically deletes the policy's default version) using this API. For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + deletePolicy(params: IAM.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified managed policy. Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy: Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy API operations. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy. Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. Delete the policy (this automatically deletes the policy's default version) using this API. For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified version from the specified managed policy. You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. For information about versions for managed policies, see Versioning for Managed Policies in the IAM User Guide. + */ + deletePolicyVersion(params: IAM.Types.DeletePolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified version from the specified managed policy. You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. For information about versions for managed policies, see Versioning for Managed Policies in the IAM User Guide. + */ + deletePolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles. Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. + */ + deleteRole(params: IAM.Types.DeleteRoleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles. Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. + */ + deleteRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the permissions boundary for the specified IAM role. Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies. + */ + deleteRolePermissionsBoundary(params: IAM.Types.DeleteRolePermissionsBoundaryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the permissions boundary for the specified IAM role. Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies. + */ + deleteRolePermissionsBoundary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified inline policy that is embedded in the specified IAM role. A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. + */ + deleteRolePolicy(params: IAM.Types.DeleteRolePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified inline policy that is embedded in the specified IAM role. A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. + */ + deleteRolePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a SAML provider resource in IAM. Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails. This operation requires Signature Version 4. + */ + deleteSAMLProvider(params: IAM.Types.DeleteSAMLProviderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a SAML provider resource in IAM. Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails. This operation requires Signature Version 4. + */ + deleteSAMLProvider(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified SSH public key. The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + deleteSSHPublicKey(params: IAM.Types.DeleteSSHPublicKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified SSH public key. The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + deleteSSHPublicKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified server certificate. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM. If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference. + */ + deleteServerCertificate(params: IAM.Types.DeleteServerCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified server certificate. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM. If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference. + */ + deleteServerCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned. If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus API operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the AWS documentation for your service. For more information about service-linked roles, see Roles Terms and Concepts: AWS Service-Linked Role in the IAM User Guide. + */ + deleteServiceLinkedRole(params: IAM.Types.DeleteServiceLinkedRoleRequest, callback?: (err: AWSError, data: IAM.Types.DeleteServiceLinkedRoleResponse) => void): Request; + /** + * Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned. If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus API operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the AWS documentation for your service. For more information about service-linked roles, see Roles Terms and Concepts: AWS Service-Linked Role in the IAM User Guide. + */ + deleteServiceLinkedRole(callback?: (err: AWSError, data: IAM.Types.DeleteServiceLinkedRoleResponse) => void): Request; + /** + * Deletes the specified service-specific credential. + */ + deleteServiceSpecificCredential(params: IAM.Types.DeleteServiceSpecificCredentialRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified service-specific credential. + */ + deleteServiceSpecificCredential(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a signing certificate associated with the specified IAM user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated IAM users. + */ + deleteSigningCertificate(params: IAM.Types.DeleteSigningCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a signing certificate associated with the specified IAM user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated IAM users. + */ + deleteSigningCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified IAM user. Unlike the AWS Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM User. Before attempting to delete a user, remove the following items: Password (DeleteLoginProfile) Access keys (DeleteAccessKey) Signing certificate (DeleteSigningCertificate) SSH public key (DeleteSSHPublicKey) Git credentials (DeleteServiceSpecificCredential) Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice) Inline policies (DeleteUserPolicy) Attached managed policies (DetachUserPolicy) Group memberships (RemoveUserFromGroup) + */ + deleteUser(params: IAM.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified IAM user. Unlike the AWS Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM User. Before attempting to delete a user, remove the following items: Password (DeleteLoginProfile) Access keys (DeleteAccessKey) Signing certificate (DeleteSigningCertificate) SSH public key (DeleteSSHPublicKey) Git credentials (DeleteServiceSpecificCredential) Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice) Inline policies (DeleteUserPolicy) Attached managed policies (DetachUserPolicy) Group memberships (RemoveUserFromGroup) + */ + deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the permissions boundary for the specified IAM user. Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies. + */ + deleteUserPermissionsBoundary(params: IAM.Types.DeleteUserPermissionsBoundaryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the permissions boundary for the specified IAM user. Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies. + */ + deleteUserPermissionsBoundary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified inline policy that is embedded in the specified IAM user. A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. + */ + deleteUserPolicy(params: IAM.Types.DeleteUserPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified inline policy that is embedded in the specified IAM user. A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide. + */ + deleteUserPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a virtual MFA device. You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice. + */ + deleteVirtualMFADevice(params: IAM.Types.DeleteVirtualMFADeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a virtual MFA device. You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice. + */ + deleteVirtualMFADevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified managed policy from the specified IAM group. A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + detachGroupPolicy(params: IAM.Types.DetachGroupPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified managed policy from the specified IAM group. A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + detachGroupPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified managed policy from the specified role. A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + detachRolePolicy(params: IAM.Types.DetachRolePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified managed policy from the specified role. A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + detachRolePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified managed policy from the specified user. A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + detachUserPolicy(params: IAM.Types.DetachUserPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified managed policy from the specified user. A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + detachUserPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device. + */ + enableMFADevice(params: IAM.Types.EnableMFADeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device. + */ + enableMFADevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide. + */ + generateCredentialReport(callback?: (err: AWSError, data: IAM.Types.GenerateCredentialReportResponse) => void): Request; + /** + * Generates a request for a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access AWS services. Recent activity usually appears within four hours. IAM reports activity for the last 365 days, or less if your Region began supporting this feature within the last year. For more information, see Regions Where Data Is Tracked. The service last accessed data includes all attempts to access an AWS API, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM Events with CloudTrail in the IAM User Guide. The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report: GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every AWS service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt. GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific AWS service. To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter. For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation. Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide. For more information about service last accessed data, see Reducing Policy Scope by Viewing User Activity in the IAM User Guide. + */ + generateServiceLastAccessedDetails(params: IAM.Types.GenerateServiceLastAccessedDetailsRequest, callback?: (err: AWSError, data: IAM.Types.GenerateServiceLastAccessedDetailsResponse) => void): Request; + /** + * Generates a request for a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access AWS services. Recent activity usually appears within four hours. IAM reports activity for the last 365 days, or less if your Region began supporting this feature within the last year. For more information, see Regions Where Data Is Tracked. The service last accessed data includes all attempts to access an AWS API, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM Events with CloudTrail in the IAM User Guide. The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report: GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every AWS service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt. GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific AWS service. To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter. For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation. Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide. For more information about service last accessed data, see Reducing Policy Scope by Viewing User Activity in the IAM User Guide. + */ + generateServiceLastAccessedDetails(callback?: (err: AWSError, data: IAM.Types.GenerateServiceLastAccessedDetailsResponse) => void): Request; + /** + * Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and Region that were specified in the last request made with that key. + */ + getAccessKeyLastUsed(params: IAM.Types.GetAccessKeyLastUsedRequest, callback?: (err: AWSError, data: IAM.Types.GetAccessKeyLastUsedResponse) => void): Request; + /** + * Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and Region that were specified in the last request made with that key. + */ + getAccessKeyLastUsed(callback?: (err: AWSError, data: IAM.Types.GetAccessKeyLastUsedResponse) => void): Request; + /** + * Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters. + */ + getAccountAuthorizationDetails(params: IAM.Types.GetAccountAuthorizationDetailsRequest, callback?: (err: AWSError, data: IAM.Types.GetAccountAuthorizationDetailsResponse) => void): Request; + /** + * Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters. + */ + getAccountAuthorizationDetails(callback?: (err: AWSError, data: IAM.Types.GetAccountAuthorizationDetailsResponse) => void): Request; + /** + * Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy. + */ + getAccountPasswordPolicy(callback?: (err: AWSError, data: IAM.Types.GetAccountPasswordPolicyResponse) => void): Request; + /** + * Retrieves information about IAM entity usage and IAM quotas in the AWS account. For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide. + */ + getAccountSummary(callback?: (err: AWSError, data: IAM.Types.GetAccountSummaryResponse) => void): Request; + /** + * Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request. + */ + getContextKeysForCustomPolicy(params: IAM.Types.GetContextKeysForCustomPolicyRequest, callback?: (err: AWSError, data: IAM.Types.GetContextKeysForPolicyResponse) => void): Request; + /** + * Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request. + */ + getContextKeysForCustomPolicy(callback?: (err: AWSError, data: IAM.Types.GetContextKeysForPolicyResponse) => void): Request; + /** + * Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. + */ + getContextKeysForPrincipalPolicy(params: IAM.Types.GetContextKeysForPrincipalPolicyRequest, callback?: (err: AWSError, data: IAM.Types.GetContextKeysForPolicyResponse) => void): Request; + /** + * Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. + */ + getContextKeysForPrincipalPolicy(callback?: (err: AWSError, data: IAM.Types.GetContextKeysForPolicyResponse) => void): Request; + /** + * Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide. + */ + getCredentialReport(callback?: (err: AWSError, data: IAM.Types.GetCredentialReportResponse) => void): Request; + /** + * Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters. + */ + getGroup(params: IAM.Types.GetGroupRequest, callback?: (err: AWSError, data: IAM.Types.GetGroupResponse) => void): Request; + /** + * Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters. + */ + getGroup(callback?: (err: AWSError, data: IAM.Types.GetGroupResponse) => void): Request; + /** + * Retrieves the specified inline policy document that is embedded in the specified IAM group. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + getGroupPolicy(params: IAM.Types.GetGroupPolicyRequest, callback?: (err: AWSError, data: IAM.Types.GetGroupPolicyResponse) => void): Request; + /** + * Retrieves the specified inline policy document that is embedded in the specified IAM group. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + getGroupPolicy(callback?: (err: AWSError, data: IAM.Types.GetGroupPolicyResponse) => void): Request; + /** + * Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide. + */ + getInstanceProfile(params: IAM.Types.GetInstanceProfileRequest, callback?: (err: AWSError, data: IAM.Types.GetInstanceProfileResponse) => void): Request; + /** + * Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide. + */ + getInstanceProfile(callback?: (err: AWSError, data: IAM.Types.GetInstanceProfileResponse) => void): Request; + /** + * Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the operation returns a 404 (NoSuchEntity) error. + */ + getLoginProfile(params: IAM.Types.GetLoginProfileRequest, callback?: (err: AWSError, data: IAM.Types.GetLoginProfileResponse) => void): Request; + /** + * Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the operation returns a 404 (NoSuchEntity) error. + */ + getLoginProfile(callback?: (err: AWSError, data: IAM.Types.GetLoginProfileResponse) => void): Request; + /** + * Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM. + */ + getOpenIDConnectProvider(params: IAM.Types.GetOpenIDConnectProviderRequest, callback?: (err: AWSError, data: IAM.Types.GetOpenIDConnectProviderResponse) => void): Request; + /** + * Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM. + */ + getOpenIDConnectProvider(callback?: (err: AWSError, data: IAM.Types.GetOpenIDConnectProviderResponse) => void): Request; + /** + * Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion. This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + getPolicy(params: IAM.Types.GetPolicyRequest, callback?: (err: AWSError, data: IAM.Types.GetPolicyResponse) => void): Request; + /** + * Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion. This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + getPolicy(callback?: (err: AWSError, data: IAM.Types.GetPolicyResponse) => void): Request; + /** + * Retrieves information about the specified version of the specified managed policy, including the policy document. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. To list the available versions for a policy, use ListPolicyVersions. This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API. For more information about the types of policies, see Managed Policies and Inline Policies in the IAM User Guide. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + getPolicyVersion(params: IAM.Types.GetPolicyVersionRequest, callback?: (err: AWSError, data: IAM.Types.GetPolicyVersionResponse) => void): Request; + /** + * Retrieves information about the specified version of the specified managed policy, including the policy document. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. To list the available versions for a policy, use ListPolicyVersions. This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API. For more information about the types of policies, see Managed Policies and Inline Policies in the IAM User Guide. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + getPolicyVersion(callback?: (err: AWSError, data: IAM.Types.GetPolicyVersionResponse) => void): Request; + /** + * Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. + */ + getRole(params: IAM.Types.GetRoleRequest, callback?: (err: AWSError, data: IAM.Types.GetRoleResponse) => void): Request; + /** + * Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. + */ + getRole(callback?: (err: AWSError, data: IAM.Types.GetRoleResponse) => void): Request; + /** + * Retrieves the specified inline policy document that is embedded with the specified IAM role. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For more information about roles, see Using Roles to Delegate Permissions and Federate Identities. + */ + getRolePolicy(params: IAM.Types.GetRolePolicyRequest, callback?: (err: AWSError, data: IAM.Types.GetRolePolicyResponse) => void): Request; + /** + * Retrieves the specified inline policy document that is embedded with the specified IAM role. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For more information about roles, see Using Roles to Delegate Permissions and Federate Identities. + */ + getRolePolicy(callback?: (err: AWSError, data: IAM.Types.GetRolePolicyResponse) => void): Request; + /** + * Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated. This operation requires Signature Version 4. + */ + getSAMLProvider(params: IAM.Types.GetSAMLProviderRequest, callback?: (err: AWSError, data: IAM.Types.GetSAMLProviderResponse) => void): Request; + /** + * Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated. This operation requires Signature Version 4. + */ + getSAMLProvider(callback?: (err: AWSError, data: IAM.Types.GetSAMLProviderResponse) => void): Request; + /** + * Retrieves the specified SSH public key, including metadata about the key. The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + getSSHPublicKey(params: IAM.Types.GetSSHPublicKeyRequest, callback?: (err: AWSError, data: IAM.Types.GetSSHPublicKeyResponse) => void): Request; + /** + * Retrieves the specified SSH public key, including metadata about the key. The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + getSSHPublicKey(callback?: (err: AWSError, data: IAM.Types.GetSSHPublicKeyResponse) => void): Request; + /** + * Retrieves information about the specified server certificate stored in IAM. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic includes a list of AWS services that can use the server certificates that you manage with IAM. + */ + getServerCertificate(params: IAM.Types.GetServerCertificateRequest, callback?: (err: AWSError, data: IAM.Types.GetServerCertificateResponse) => void): Request; + /** + * Retrieves information about the specified server certificate stored in IAM. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic includes a list of AWS services that can use the server certificates that you manage with IAM. + */ + getServerCertificate(callback?: (err: AWSError, data: IAM.Types.GetServerCertificateResponse) => void): Request; + /** + * After you generate a user, group, role, or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetails. This operation retrieves the status of your report job and a list of AWS services that the resource (user, group, role, or managed policy) can access. Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide. For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed. The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report: User – Returns the user ARN that you used to generate the report Group – Returns the ARN of the group member (user) that last attempted to access the service Role – Returns the role ARN that you used to generate the report Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service By default, the list is sorted by service namespace. + */ + getServiceLastAccessedDetails(params: IAM.Types.GetServiceLastAccessedDetailsRequest, callback?: (err: AWSError, data: IAM.Types.GetServiceLastAccessedDetailsResponse) => void): Request; + /** + * After you generate a user, group, role, or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetails. This operation retrieves the status of your report job and a list of AWS services that the resource (user, group, role, or managed policy) can access. Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide. For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed. The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report: User – Returns the user ARN that you used to generate the report Group – Returns the ARN of the group member (user) that last attempted to access the service Role – Returns the role ARN that you used to generate the report Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service By default, the list is sorted by service namespace. + */ + getServiceLastAccessedDetails(callback?: (err: AWSError, data: IAM.Types.GetServiceLastAccessedDetailsResponse) => void): Request; + /** + * After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service. Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service. Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service. You can also use this operation for user or role reports to retrieve details about those entities. If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed. By default, the list of associated entities is sorted by date, with the most recent access listed first. + */ + getServiceLastAccessedDetailsWithEntities(params: IAM.Types.GetServiceLastAccessedDetailsWithEntitiesRequest, callback?: (err: AWSError, data: IAM.Types.GetServiceLastAccessedDetailsWithEntitiesResponse) => void): Request; + /** + * After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service. Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service. Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service. You can also use this operation for user or role reports to retrieve details about those entities. If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed. By default, the list of associated entities is sorted by date, with the most recent access listed first. + */ + getServiceLastAccessedDetailsWithEntities(callback?: (err: AWSError, data: IAM.Types.GetServiceLastAccessedDetailsWithEntitiesResponse) => void): Request; + /** + * Retrieves the status of your service-linked role deletion. After you use the DeleteServiceLinkedRole API operation to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service. + */ + getServiceLinkedRoleDeletionStatus(params: IAM.Types.GetServiceLinkedRoleDeletionStatusRequest, callback?: (err: AWSError, data: IAM.Types.GetServiceLinkedRoleDeletionStatusResponse) => void): Request; + /** + * Retrieves the status of your service-linked role deletion. After you use the DeleteServiceLinkedRole API operation to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service. + */ + getServiceLinkedRoleDeletionStatus(callback?: (err: AWSError, data: IAM.Types.GetServiceLinkedRoleDeletionStatusResponse) => void): Request; + /** + * Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API. + */ + getUser(params: IAM.Types.GetUserRequest, callback?: (err: AWSError, data: IAM.Types.GetUserResponse) => void): Request; + /** + * Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API. + */ + getUser(callback?: (err: AWSError, data: IAM.Types.GetUserResponse) => void): Request; + /** + * Retrieves the specified inline policy document that is embedded in the specified IAM user. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + getUserPolicy(params: IAM.Types.GetUserPolicyRequest, callback?: (err: AWSError, data: IAM.Types.GetUserPolicyResponse) => void): Request; + /** + * Retrieves the specified inline policy document that is embedded in the specified IAM user. Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + getUserPolicy(callback?: (err: AWSError, data: IAM.Types.GetUserPolicyResponse) => void): Request; + /** + * Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list. Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters. If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. + */ + listAccessKeys(params: IAM.Types.ListAccessKeysRequest, callback?: (err: AWSError, data: IAM.Types.ListAccessKeysResponse) => void): Request; + /** + * Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list. Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters. If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. + */ + listAccessKeys(callback?: (err: AWSError, data: IAM.Types.ListAccessKeysResponse) => void): Request; + /** + * Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. + */ + listAccountAliases(params: IAM.Types.ListAccountAliasesRequest, callback?: (err: AWSError, data: IAM.Types.ListAccountAliasesResponse) => void): Request; + /** + * Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide. + */ + listAccountAliases(callback?: (err: AWSError, data: IAM.Types.ListAccountAliasesResponse) => void): Request; + /** + * Lists all managed policies that are attached to the specified IAM group. An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list. + */ + listAttachedGroupPolicies(params: IAM.Types.ListAttachedGroupPoliciesRequest, callback?: (err: AWSError, data: IAM.Types.ListAttachedGroupPoliciesResponse) => void): Request; + /** + * Lists all managed policies that are attached to the specified IAM group. An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list. + */ + listAttachedGroupPolicies(callback?: (err: AWSError, data: IAM.Types.ListAttachedGroupPoliciesResponse) => void): Request; + /** + * Lists all managed policies that are attached to the specified IAM role. An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list. + */ + listAttachedRolePolicies(params: IAM.Types.ListAttachedRolePoliciesRequest, callback?: (err: AWSError, data: IAM.Types.ListAttachedRolePoliciesResponse) => void): Request; + /** + * Lists all managed policies that are attached to the specified IAM role. An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list. + */ + listAttachedRolePolicies(callback?: (err: AWSError, data: IAM.Types.ListAttachedRolePoliciesResponse) => void): Request; + /** + * Lists all managed policies that are attached to the specified IAM user. An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list. + */ + listAttachedUserPolicies(params: IAM.Types.ListAttachedUserPoliciesRequest, callback?: (err: AWSError, data: IAM.Types.ListAttachedUserPoliciesResponse) => void): Request; + /** + * Lists all managed policies that are attached to the specified IAM user. An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list. + */ + listAttachedUserPolicies(callback?: (err: AWSError, data: IAM.Types.ListAttachedUserPoliciesResponse) => void): Request; + /** + * Lists all IAM users, groups, and roles that the specified managed policy is attached to. You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role. You can paginate the results using the MaxItems and Marker parameters. + */ + listEntitiesForPolicy(params: IAM.Types.ListEntitiesForPolicyRequest, callback?: (err: AWSError, data: IAM.Types.ListEntitiesForPolicyResponse) => void): Request; + /** + * Lists all IAM users, groups, and roles that the specified managed policy is attached to. You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role. You can paginate the results using the MaxItems and Marker parameters. + */ + listEntitiesForPolicy(callback?: (err: AWSError, data: IAM.Types.ListEntitiesForPolicyResponse) => void): Request; + /** + * Lists the names of the inline policies that are embedded in the specified IAM group. An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list. + */ + listGroupPolicies(params: IAM.Types.ListGroupPoliciesRequest, callback?: (err: AWSError, data: IAM.Types.ListGroupPoliciesResponse) => void): Request; + /** + * Lists the names of the inline policies that are embedded in the specified IAM group. An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list. + */ + listGroupPolicies(callback?: (err: AWSError, data: IAM.Types.ListGroupPoliciesResponse) => void): Request; + /** + * Lists the IAM groups that have the specified path prefix. You can paginate the results using the MaxItems and Marker parameters. + */ + listGroups(params: IAM.Types.ListGroupsRequest, callback?: (err: AWSError, data: IAM.Types.ListGroupsResponse) => void): Request; + /** + * Lists the IAM groups that have the specified path prefix. You can paginate the results using the MaxItems and Marker parameters. + */ + listGroups(callback?: (err: AWSError, data: IAM.Types.ListGroupsResponse) => void): Request; + /** + * Lists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters. + */ + listGroupsForUser(params: IAM.Types.ListGroupsForUserRequest, callback?: (err: AWSError, data: IAM.Types.ListGroupsForUserResponse) => void): Request; + /** + * Lists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters. + */ + listGroupsForUser(callback?: (err: AWSError, data: IAM.Types.ListGroupsForUserResponse) => void): Request; + /** + * Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, go to About Instance Profiles. You can paginate the results using the MaxItems and Marker parameters. + */ + listInstanceProfiles(params: IAM.Types.ListInstanceProfilesRequest, callback?: (err: AWSError, data: IAM.Types.ListInstanceProfilesResponse) => void): Request; + /** + * Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, go to About Instance Profiles. You can paginate the results using the MaxItems and Marker parameters. + */ + listInstanceProfiles(callback?: (err: AWSError, data: IAM.Types.ListInstanceProfilesResponse) => void): Request; + /** + * Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to About Instance Profiles. You can paginate the results using the MaxItems and Marker parameters. + */ + listInstanceProfilesForRole(params: IAM.Types.ListInstanceProfilesForRoleRequest, callback?: (err: AWSError, data: IAM.Types.ListInstanceProfilesForRoleResponse) => void): Request; + /** + * Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to About Instance Profiles. You can paginate the results using the MaxItems and Marker parameters. + */ + listInstanceProfilesForRole(callback?: (err: AWSError, data: IAM.Types.ListInstanceProfilesForRoleResponse) => void): Request; + /** + * Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API. You can paginate the results using the MaxItems and Marker parameters. + */ + listMFADevices(params: IAM.Types.ListMFADevicesRequest, callback?: (err: AWSError, data: IAM.Types.ListMFADevicesResponse) => void): Request; + /** + * Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API. You can paginate the results using the MaxItems and Marker parameters. + */ + listMFADevices(callback?: (err: AWSError, data: IAM.Types.ListMFADevicesResponse) => void): Request; + /** + * Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account. + */ + listOpenIDConnectProviders(params: IAM.Types.ListOpenIDConnectProvidersRequest, callback?: (err: AWSError, data: IAM.Types.ListOpenIDConnectProvidersResponse) => void): Request; + /** + * Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account. + */ + listOpenIDConnectProviders(callback?: (err: AWSError, data: IAM.Types.ListOpenIDConnectProvidersResponse) => void): Request; + /** + * Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies. You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS. You can paginate the results using the MaxItems and Marker parameters. For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + listPolicies(params: IAM.Types.ListPoliciesRequest, callback?: (err: AWSError, data: IAM.Types.ListPoliciesResponse) => void): Request; + /** + * Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies. You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS. You can paginate the results using the MaxItems and Marker parameters. For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + listPolicies(callback?: (err: AWSError, data: IAM.Types.ListPoliciesResponse) => void): Request; + /** + * Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service. This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide. The list of policies returned by the operation depends on the ARN of the identity that you provide. User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs. Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included. Role – The list of policies includes only the managed and inline policies that are attached to the role. For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide. Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations. + */ + listPoliciesGrantingServiceAccess(params: IAM.Types.ListPoliciesGrantingServiceAccessRequest, callback?: (err: AWSError, data: IAM.Types.ListPoliciesGrantingServiceAccessResponse) => void): Request; + /** + * Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service. This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide. The list of policies returned by the operation depends on the ARN of the identity that you provide. User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs. Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included. Role – The list of policies includes only the managed and inline policies that are attached to the role. For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide. Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations. + */ + listPoliciesGrantingServiceAccess(callback?: (err: AWSError, data: IAM.Types.ListPoliciesGrantingServiceAccessResponse) => void): Request; + /** + * Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version. For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + listPolicyVersions(params: IAM.Types.ListPolicyVersionsRequest, callback?: (err: AWSError, data: IAM.Types.ListPolicyVersionsResponse) => void): Request; + /** + * Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version. For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + listPolicyVersions(callback?: (err: AWSError, data: IAM.Types.ListPolicyVersionsResponse) => void): Request; + /** + * Lists the names of the inline policies that are embedded in the specified IAM role. An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list. + */ + listRolePolicies(params: IAM.Types.ListRolePoliciesRequest, callback?: (err: AWSError, data: IAM.Types.ListRolePoliciesResponse) => void): Request; + /** + * Lists the names of the inline policies that are embedded in the specified IAM role. An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list. + */ + listRolePolicies(callback?: (err: AWSError, data: IAM.Types.ListRolePoliciesResponse) => void): Request; + /** + * Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + listRoleTags(params: IAM.Types.ListRoleTagsRequest, callback?: (err: AWSError, data: IAM.Types.ListRoleTagsResponse) => void): Request; + /** + * Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + listRoleTags(callback?: (err: AWSError, data: IAM.Types.ListRoleTagsResponse) => void): Request; + /** + * Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, go to Working with Roles. You can paginate the results using the MaxItems and Marker parameters. + */ + listRoles(params: IAM.Types.ListRolesRequest, callback?: (err: AWSError, data: IAM.Types.ListRolesResponse) => void): Request; + /** + * Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, go to Working with Roles. You can paginate the results using the MaxItems and Marker parameters. + */ + listRoles(callback?: (err: AWSError, data: IAM.Types.ListRolesResponse) => void): Request; + /** + * Lists the SAML provider resource objects defined in IAM in the account. This operation requires Signature Version 4. + */ + listSAMLProviders(params: IAM.Types.ListSAMLProvidersRequest, callback?: (err: AWSError, data: IAM.Types.ListSAMLProvidersResponse) => void): Request; + /** + * Lists the SAML provider resource objects defined in IAM in the account. This operation requires Signature Version 4. + */ + listSAMLProviders(callback?: (err: AWSError, data: IAM.Types.ListSAMLProvidersResponse) => void): Request; + /** + * Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list. The SSH public keys returned by this operation are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters. + */ + listSSHPublicKeys(params: IAM.Types.ListSSHPublicKeysRequest, callback?: (err: AWSError, data: IAM.Types.ListSSHPublicKeysResponse) => void): Request; + /** + * Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list. The SSH public keys returned by this operation are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters. + */ + listSSHPublicKeys(callback?: (err: AWSError, data: IAM.Types.ListSSHPublicKeysResponse) => void): Request; + /** + * Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list. You can paginate the results using the MaxItems and Marker parameters. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM. + */ + listServerCertificates(params: IAM.Types.ListServerCertificatesRequest, callback?: (err: AWSError, data: IAM.Types.ListServerCertificatesResponse) => void): Request; + /** + * Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list. You can paginate the results using the MaxItems and Marker parameters. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM. + */ + listServerCertificates(callback?: (err: AWSError, data: IAM.Types.ListServerCertificatesResponse) => void): Request; + /** + * Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide. + */ + listServiceSpecificCredentials(params: IAM.Types.ListServiceSpecificCredentialsRequest, callback?: (err: AWSError, data: IAM.Types.ListServiceSpecificCredentialsResponse) => void): Request; + /** + * Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide. + */ + listServiceSpecificCredentials(callback?: (err: AWSError, data: IAM.Types.ListServiceSpecificCredentialsResponse) => void): Request; + /** + * Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list. Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters. If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. + */ + listSigningCertificates(params: IAM.Types.ListSigningCertificatesRequest, callback?: (err: AWSError, data: IAM.Types.ListSigningCertificatesResponse) => void): Request; + /** + * Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list. Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters. If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. + */ + listSigningCertificates(callback?: (err: AWSError, data: IAM.Types.ListSigningCertificatesResponse) => void): Request; + /** + * Lists the names of the inline policies embedded in the specified IAM user. An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list. + */ + listUserPolicies(params: IAM.Types.ListUserPoliciesRequest, callback?: (err: AWSError, data: IAM.Types.ListUserPoliciesResponse) => void): Request; + /** + * Lists the names of the inline policies embedded in the specified IAM user. An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list. + */ + listUserPolicies(callback?: (err: AWSError, data: IAM.Types.ListUserPoliciesResponse) => void): Request; + /** + * Lists the tags that are attached to the specified user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + listUserTags(params: IAM.Types.ListUserTagsRequest, callback?: (err: AWSError, data: IAM.Types.ListUserTagsResponse) => void): Request; + /** + * Lists the tags that are attached to the specified user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + listUserTags(callback?: (err: AWSError, data: IAM.Types.ListUserTagsResponse) => void): Request; + /** + * Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the AWS account. If there are none, the operation returns an empty list. You can paginate the results using the MaxItems and Marker parameters. + */ + listUsers(params: IAM.Types.ListUsersRequest, callback?: (err: AWSError, data: IAM.Types.ListUsersResponse) => void): Request; + /** + * Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the AWS account. If there are none, the operation returns an empty list. You can paginate the results using the MaxItems and Marker parameters. + */ + listUsers(callback?: (err: AWSError, data: IAM.Types.ListUsersResponse) => void): Request; + /** + * Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any. You can paginate the results using the MaxItems and Marker parameters. + */ + listVirtualMFADevices(params: IAM.Types.ListVirtualMFADevicesRequest, callback?: (err: AWSError, data: IAM.Types.ListVirtualMFADevicesResponse) => void): Request; + /** + * Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any. You can paginate the results using the MaxItems and Marker parameters. + */ + listVirtualMFADevices(callback?: (err: AWSError, data: IAM.Types.ListVirtualMFADevicesResponse) => void): Request; + /** + * Adds or updates an inline policy document that is embedded in the specified IAM group. A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + putGroupPolicy(params: IAM.Types.PutGroupPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates an inline policy document that is embedded in the specified IAM group. A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + putGroupPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role. You cannot set the boundary for a service-linked role. Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON Policy Evaluation Logic in the IAM User Guide. + */ + putRolePermissionsBoundary(params: IAM.Types.PutRolePermissionsBoundaryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role. You cannot set the boundary for a service-linked role. Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON Policy Evaluation Logic in the IAM User Guide. + */ + putRolePermissionsBoundary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities. A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + putRolePolicy(params: IAM.Types.PutRolePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities. A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + putRolePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user. Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON Policy Evaluation Logic in the IAM User Guide. + */ + putUserPermissionsBoundary(params: IAM.Types.PutUserPermissionsBoundaryRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user. Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON Policy Evaluation Logic in the IAM User Guide. + */ + putUserPermissionsBoundary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates an inline policy document that is embedded in the specified IAM user. An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + putUserPolicy(params: IAM.Types.PutUserPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates an inline policy document that is embedded in the specified IAM user. An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide. For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + putUserPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object. This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist. + */ + removeClientIDFromOpenIDConnectProvider(params: IAM.Types.RemoveClientIDFromOpenIDConnectProviderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object. This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist. + */ + removeClientIDFromOpenIDConnectProvider(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified IAM role from the specified EC2 instance profile. Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance. For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles. + */ + removeRoleFromInstanceProfile(params: IAM.Types.RemoveRoleFromInstanceProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified IAM role from the specified EC2 instance profile. Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance. For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles. + */ + removeRoleFromInstanceProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified user from the specified group. + */ + removeUserFromGroup(params: IAM.Types.RemoveUserFromGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified user from the specified group. + */ + removeUserFromGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. + */ + resetServiceSpecificCredential(params: IAM.Types.ResetServiceSpecificCredentialRequest, callback?: (err: AWSError, data: IAM.Types.ResetServiceSpecificCredentialResponse) => void): Request; + /** + * Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. + */ + resetServiceSpecificCredential(callback?: (err: AWSError, data: IAM.Types.ResetServiceSpecificCredentialResponse) => void): Request; + /** + * Synchronizes the specified MFA device with its IAM resource object on the AWS servers. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide. + */ + resyncMFADevice(params: IAM.Types.ResyncMFADeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Synchronizes the specified MFA device with its IAM resource object on the AWS servers. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide. + */ + resyncMFADevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the specified version of the specified policy as the policy's default (operative) version. This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + setDefaultPolicyVersion(params: IAM.Types.SetDefaultPolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the specified version of the specified policy as the policy's default (operative) version. This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide. + */ + setDefaultPolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the specified version of the global endpoint token as the token version used for the AWS account. By default, AWS Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. AWS recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see AWS Regions and Endpoints in the AWS General Reference. If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and Deactivating STS in an AWS Region in the IAM User Guide. To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation. + */ + setSecurityTokenServicePreferences(params: IAM.Types.SetSecurityTokenServicePreferencesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the specified version of the global endpoint token as the token version used for the AWS account. By default, AWS Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. AWS recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see AWS Regions and Endpoints in the AWS General Reference. If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and Deactivating STS in an AWS Region in the IAM User Guide. To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation. + */ + setSecurityTokenServicePreferences(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and AWS resources to determine the policies' effective permissions. The policies are provided as strings. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker parameters to paginate the results. + */ + simulateCustomPolicy(params: IAM.Types.SimulateCustomPolicyRequest, callback?: (err: AWSError, data: IAM.Types.SimulatePolicyResponse) => void): Request; + /** + * Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and AWS resources to determine the policies' effective permissions. The policies are provided as strings. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker parameters to paginate the results. + */ + simulateCustomPolicy(callback?: (err: AWSError, data: IAM.Types.SimulatePolicyResponse) => void): Request; + /** + * Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and Marker parameters to paginate the results. + */ + simulatePrincipalPolicy(params: IAM.Types.SimulatePrincipalPolicyRequest, callback?: (err: AWSError, data: IAM.Types.SimulatePolicyResponse) => void): Request; + /** + * Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead. Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and Marker parameters to paginate the results. + */ + simulatePrincipalPolicy(callback?: (err: AWSError, data: IAM.Types.SimulatePolicyResponse) => void): Request; + /** + * Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Reference tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM user or role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control Access Using IAM Tags in the IAM User Guide. Cost allocation - Use tags to help track which individuals and teams are using which AWS resources. Make sure that you have no invalid tags and that you do not exceed the allowed number of tags per role. In either case, the entire request fails and no tags are added to the role. AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + tagRole(params: IAM.Types.TagRoleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Reference tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM user or role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control Access Using IAM Tags in the IAM User Guide. Cost allocation - Use tags to help track which individuals and teams are using which AWS resources. Make sure that you have no invalid tags and that you do not exceed the allowed number of tags per role. In either case, the entire request fails and no tags are added to the role. AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + tagRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Reference tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user or to a role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control Access Using IAM Tags in the IAM User Guide. Cost allocation - Use tags to help track which individuals and teams are using which AWS resources. Make sure that you have no invalid tags and that you do not exceed the allowed number of tags per role. In either case, the entire request fails and no tags are added to the role. AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + tagUser(params: IAM.Types.TagUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Reference tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user or to a role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control Access Using IAM Tags in the IAM User Guide. Cost allocation - Use tags to help track which individuals and teams are using which AWS resources. Make sure that you have no invalid tags and that you do not exceed the allowed number of tags per role. In either case, the entire request fails and no tags are added to the role. AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + tagUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from the role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + untagRole(params: IAM.Types.UntagRoleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from the role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + untagRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from the user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + untagUser(params: IAM.Types.UntagUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from the user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + untagUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow. If the UserName is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide. + */ + updateAccessKey(params: IAM.Types.UpdateAccessKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow. If the UserName is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide. + */ + updateAccessKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the password policy settings for the AWS account. This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation. For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide. + */ + updateAccountPasswordPolicy(params: IAM.Types.UpdateAccountPasswordPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the password policy settings for the AWS account. This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation. For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide. + */ + updateAccountPasswordPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities. + */ + updateAssumeRolePolicy(params: IAM.Types.UpdateAssumeRolePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities. + */ + updateAssumeRolePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the name and/or the path of the specified IAM group. You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide. The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access Management. + */ + updateGroup(params: IAM.Types.UpdateGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the name and/or the path of the specified IAM group. You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide. The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access Management. + */ + updateGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the password for the specified IAM user. IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide. + */ + updateLoginProfile(params: IAM.Types.UpdateLoginProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the password for the specified IAM user. IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide. + */ + updateLoginProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints. The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated. Trust for the OIDC provider is derived from the provider's certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users. + */ + updateOpenIDConnectProviderThumbprint(params: IAM.Types.UpdateOpenIDConnectProviderThumbprintRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints. The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated. Trust for the OIDC provider is derived from the provider's certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users. + */ + updateOpenIDConnectProviderThumbprint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the description or maximum session duration setting of a role. + */ + updateRole(params: IAM.Types.UpdateRoleRequest, callback?: (err: AWSError, data: IAM.Types.UpdateRoleResponse) => void): Request; + /** + * Updates the description or maximum session duration setting of a role. + */ + updateRole(callback?: (err: AWSError, data: IAM.Types.UpdateRoleResponse) => void): Request; + /** + * Use UpdateRole instead. Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation. + */ + updateRoleDescription(params: IAM.Types.UpdateRoleDescriptionRequest, callback?: (err: AWSError, data: IAM.Types.UpdateRoleDescriptionResponse) => void): Request; + /** + * Use UpdateRole instead. Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation. + */ + updateRoleDescription(callback?: (err: AWSError, data: IAM.Types.UpdateRoleDescriptionResponse) => void): Request; + /** + * Updates the metadata document for an existing SAML provider resource object. This operation requires Signature Version 4. + */ + updateSAMLProvider(params: IAM.Types.UpdateSAMLProviderRequest, callback?: (err: AWSError, data: IAM.Types.UpdateSAMLProviderResponse) => void): Request; + /** + * Updates the metadata document for an existing SAML provider resource object. This operation requires Signature Version 4. + */ + updateSAMLProvider(callback?: (err: AWSError, data: IAM.Types.UpdateSAMLProviderResponse) => void): Request; + /** + * Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow. The SSH public key affected by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + updateSSHPublicKey(params: IAM.Types.UpdateSSHPublicKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow. The SSH public key affected by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + updateSSHPublicKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the name and/or the path of the specified server certificate stored in IAM. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM. You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide. The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access Management in the IAM User Guide. + */ + updateServerCertificate(params: IAM.Types.UpdateServerCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the name and/or the path of the specified server certificate stored in IAM. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM. You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide. The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access Management in the IAM User Guide. + */ + updateServerCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow. + */ + updateServiceSpecificCredential(params: IAM.Types.UpdateServiceSpecificCredentialRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow. + */ + updateServiceSpecificCredential(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow. If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. + */ + updateSigningCertificate(params: IAM.Types.UpdateSigningCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow. If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. + */ + updateSigningCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the name and/or the path of the specified IAM user. You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide. To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies. + */ + updateUser(params: IAM.Types.UpdateUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the name and/or the path of the specified IAM user. You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide. To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies. + */ + updateUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Uploads an SSH public key and associates it with the specified IAM user. The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + uploadSSHPublicKey(params: IAM.Types.UploadSSHPublicKeyRequest, callback?: (err: AWSError, data: IAM.Types.UploadSSHPublicKeyResponse) => void): Request; + /** + * Uploads an SSH public key and associates it with the specified IAM user. The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide. + */ + uploadSSHPublicKey(callback?: (err: AWSError, data: IAM.Types.UploadSSHPublicKeyResponse) => void): Request; + /** + * Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic includes a list of AWS services that can use the server certificates that you manage with IAM. For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide. Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide. + */ + uploadServerCertificate(params: IAM.Types.UploadServerCertificateRequest, callback?: (err: AWSError, data: IAM.Types.UploadServerCertificateResponse) => void): Request; + /** + * Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide. For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic includes a list of AWS services that can use the server certificates that you manage with IAM. For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide. Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide. + */ + uploadServerCertificate(callback?: (err: AWSError, data: IAM.Types.UploadServerCertificateResponse) => void): Request; + /** + * Uploads an X.509 signing certificate and associates it with the specified IAM user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active. If the UserName is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + uploadSigningCertificate(params: IAM.Types.UploadSigningCertificateRequest, callback?: (err: AWSError, data: IAM.Types.UploadSigningCertificateResponse) => void): Request; + /** + * Uploads an X.509 signing certificate and associates it with the specified IAM user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active. If the UserName is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users. Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide. + */ + uploadSigningCertificate(callback?: (err: AWSError, data: IAM.Types.UploadSigningCertificateResponse) => void): Request; + /** + * Waits for the instanceProfileExists state by periodically calling the underlying IAM.getInstanceProfileoperation every 1 seconds (at most 40 times). + */ + waitFor(state: "instanceProfileExists", params: IAM.Types.GetInstanceProfileRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IAM.Types.GetInstanceProfileResponse) => void): Request; + /** + * Waits for the instanceProfileExists state by periodically calling the underlying IAM.getInstanceProfileoperation every 1 seconds (at most 40 times). + */ + waitFor(state: "instanceProfileExists", callback?: (err: AWSError, data: IAM.Types.GetInstanceProfileResponse) => void): Request; + /** + * Waits for the userExists state by periodically calling the underlying IAM.getUseroperation every 1 seconds (at most 20 times). + */ + waitFor(state: "userExists", params: IAM.Types.GetUserRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IAM.Types.GetUserResponse) => void): Request; + /** + * Waits for the userExists state by periodically calling the underlying IAM.getUseroperation every 1 seconds (at most 20 times). + */ + waitFor(state: "userExists", callback?: (err: AWSError, data: IAM.Types.GetUserResponse) => void): Request; + /** + * Waits for the roleExists state by periodically calling the underlying IAM.getRoleoperation every 1 seconds (at most 20 times). + */ + waitFor(state: "roleExists", params: IAM.Types.GetRoleRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IAM.Types.GetRoleResponse) => void): Request; + /** + * Waits for the roleExists state by periodically calling the underlying IAM.getRoleoperation every 1 seconds (at most 20 times). + */ + waitFor(state: "roleExists", callback?: (err: AWSError, data: IAM.Types.GetRoleResponse) => void): Request; + /** + * Waits for the policyExists state by periodically calling the underlying IAM.getPolicyoperation every 1 seconds (at most 20 times). + */ + waitFor(state: "policyExists", params: IAM.Types.GetPolicyRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IAM.Types.GetPolicyResponse) => void): Request; + /** + * Waits for the policyExists state by periodically calling the underlying IAM.getPolicyoperation every 1 seconds (at most 20 times). + */ + waitFor(state: "policyExists", callback?: (err: AWSError, data: IAM.Types.GetPolicyResponse) => void): Request; +} +declare namespace IAM { + export interface AccessKey { + /** + * The name of the IAM user that the access key is associated with. + */ + UserName: userNameType; + /** + * The ID for this access key. + */ + AccessKeyId: accessKeyIdType; + /** + * The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not. + */ + Status: statusType; + /** + * The secret key used to sign requests. + */ + SecretAccessKey: accessKeySecretType; + /** + * The date when the access key was created. + */ + CreateDate?: dateType; + } + export interface AccessKeyLastUsed { + /** + * The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null in the following situations: The user does not have an access key. An access key exists but has not been used since IAM began tracking this information. There is no sign-in data associated with the user + */ + LastUsedDate: dateType; + /** + * The name of the AWS service with which this access key was most recently used. The value of this field is "N/A" in the following situations: The user does not have an access key. An access key exists but has not been used since IAM started tracking this information. There is no sign-in data associated with the user + */ + ServiceName: stringType; + /** + * The AWS region where this access key was most recently used. The value for this field is "N/A" in the following situations: The user does not have an access key. An access key exists but has not been used since IAM began tracking this information. There is no sign-in data associated with the user For more information about AWS regions, see Regions and Endpoints in the Amazon Web Services General Reference. + */ + Region: stringType; + } + export interface AccessKeyMetadata { + /** + * The name of the IAM user that the key is associated with. + */ + UserName?: userNameType; + /** + * The ID for this access key. + */ + AccessKeyId?: accessKeyIdType; + /** + * The status of the access key. Active means that the key is valid for API calls; Inactive means it is not. + */ + Status?: statusType; + /** + * The date when the access key was created. + */ + CreateDate?: dateType; + } + export type ActionNameListType = ActionNameType[]; + export type ActionNameType = string; + export interface AddClientIDToOpenIDConnectProviderRequest { + /** + * The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation. + */ + OpenIDConnectProviderArn: arnType; + /** + * The client ID (also known as audience) to add to the IAM OpenID Connect provider resource. + */ + ClientID: clientIDType; + } + export interface AddRoleToInstanceProfileRequest { + /** + * The name of the instance profile to update. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + InstanceProfileName: instanceProfileNameType; + /** + * The name of the role to add. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + } + export interface AddUserToGroupRequest { + /** + * The name of the group to update. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * The name of the user to add. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + } + export type ArnListType = arnType[]; + export interface AttachGroupPolicyRequest { + /** + * The name (friendly name, not ARN) of the group to attach the policy to. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface AttachRolePolicyRequest { + /** + * The name (friendly name, not ARN) of the role to attach the policy to. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface AttachUserPolicyRequest { + /** + * The name (friendly name, not ARN) of the IAM user to attach the policy to. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface AttachedPermissionsBoundary { + /** + * The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy. + */ + PermissionsBoundaryType?: PermissionsBoundaryAttachmentType; + /** + * The ARN of the policy used to set the permissions boundary for the user or role. + */ + PermissionsBoundaryArn?: arnType; + } + export interface AttachedPolicy { + /** + * The friendly name of the attached policy. + */ + PolicyName?: policyNameType; + PolicyArn?: arnType; + } + export type BootstrapDatum = Buffer|Uint8Array|Blob|string; + export interface ChangePasswordRequest { + /** + * The IAM user's current password. + */ + OldPassword: passwordType; + /** + * The new password. The new password must conform to the AWS account's password policy, if one exists. The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool. + */ + NewPassword: passwordType; + } + export type ColumnNumber = number; + export interface ContextEntry { + /** + * The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId. + */ + ContextKeyName?: ContextKeyNameType; + /** + * The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy. + */ + ContextKeyValues?: ContextKeyValueListType; + /** + * The data type of the value (or values) specified in the ContextKeyValues parameter. + */ + ContextKeyType?: ContextKeyTypeEnum; + } + export type ContextEntryListType = ContextEntry[]; + export type ContextKeyNameType = string; + export type ContextKeyNamesResultListType = ContextKeyNameType[]; + export type ContextKeyTypeEnum = "string"|"stringList"|"numeric"|"numericList"|"boolean"|"booleanList"|"ip"|"ipList"|"binary"|"binaryList"|"date"|"dateList"|string; + export type ContextKeyValueListType = ContextKeyValueType[]; + export type ContextKeyValueType = string; + export interface CreateAccessKeyRequest { + /** + * The name of the IAM user that the new key will belong to. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + } + export interface CreateAccessKeyResponse { + /** + * A structure with details about the access key. + */ + AccessKey: AccessKey; + } + export interface CreateAccountAliasRequest { + /** + * The account alias to create. This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row. + */ + AccountAlias: accountAliasType; + } + export interface CreateGroupRequest { + /** + * The path to the group. For more information about paths, see IAM Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + Path?: pathType; + /** + * The name of the group to create. Do not include the path in this value. IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource". + */ + GroupName: groupNameType; + } + export interface CreateGroupResponse { + /** + * A structure containing details about the new group. + */ + Group: Group; + } + export interface CreateInstanceProfileRequest { + /** + * The name of the instance profile to create. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + InstanceProfileName: instanceProfileNameType; + /** + * The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + Path?: pathType; + } + export interface CreateInstanceProfileResponse { + /** + * A structure containing details about the new instance profile. + */ + InstanceProfile: InstanceProfile; + } + export interface CreateLoginProfileRequest { + /** + * The name of the IAM user to create a password for. The user must already exist. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The new password for the user. The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool. + */ + Password: passwordType; + /** + * Specifies whether the user is required to set a new password on next sign-in. + */ + PasswordResetRequired?: booleanType; + } + export interface CreateLoginProfileResponse { + /** + * A structure containing the user name and password create date. + */ + LoginProfile: LoginProfile; + } + export interface CreateOpenIDConnectProviderRequest { + /** + * The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error. + */ + Url: OpenIDConnectProviderUrlType; + /** + * A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.) You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider. There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long. + */ + ClientIDList?: clientIDListType; + /** + * A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates. The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string. You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com. For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide. + */ + ThumbprintList: thumbprintListType; + } + export interface CreateOpenIDConnectProviderResponse { + /** + * The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry. + */ + OpenIDConnectProviderArn?: arnType; + } + export interface CreatePolicyRequest { + /** + * The friendly name of the policy. IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource". + */ + PolicyName: policyNameType; + /** + * The path for the policy. For more information about paths, see IAM Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + Path?: policyPathType; + /** + * The JSON policy document that you want to use as the content for the new policy. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyDocument: policyDocumentType; + /** + * A friendly description of the policy. Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." The policy description is immutable. After a value is assigned, it cannot be changed. + */ + Description?: policyDescriptionType; + } + export interface CreatePolicyResponse { + /** + * A structure containing details about the new policy. + */ + Policy?: Policy; + } + export interface CreatePolicyVersionRequest { + /** + * The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + /** + * The JSON policy document that you want to use as the content for this new version of the policy. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyDocument: policyDocumentType; + /** + * Specifies whether to set this version as the policy's default version. When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + SetAsDefault?: booleanType; + } + export interface CreatePolicyVersionResponse { + /** + * A structure containing details about the new policy version. + */ + PolicyVersion?: PolicyVersion; + } + export interface CreateRoleRequest { + /** + * The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + Path?: pathType; + /** + * The name of the role to create. IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource". + */ + RoleName: roleNameType; + /** + * The trust relationship policy document that grants an entity permission to assume the role. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + AssumeRolePolicyDocument: policyDocumentType; + /** + * A description of the role. + */ + Description?: roleDescriptionType; + /** + * The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. + */ + MaxSessionDuration?: roleMaxSessionDurationType; + /** + * The ARN of the policy that is used to set the permissions boundary for the role. + */ + PermissionsBoundary?: arnType; + /** + * A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created. + */ + Tags?: tagListType; + } + export interface CreateRoleResponse { + /** + * A structure containing details about the new role. + */ + Role: Role; + } + export interface CreateSAMLProviderRequest { + /** + * An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. For more information, see About SAML 2.0-based Federation in the IAM User Guide + */ + SAMLMetadataDocument: SAMLMetadataDocumentType; + /** + * The name of the provider to create. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + Name: SAMLProviderNameType; + } + export interface CreateSAMLProviderResponse { + /** + * The Amazon Resource Name (ARN) of the new SAML provider resource in IAM. + */ + SAMLProviderArn?: arnType; + } + export interface CreateServiceLinkedRoleRequest { + /** + * The service principal for the AWS service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com. Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see AWS Services That Work with IAM in the IAM User Guide. Look for the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that service. + */ + AWSServiceName: groupNameType; + /** + * The description of the role. + */ + Description?: roleDescriptionType; + /** + * A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix. Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix. + */ + CustomSuffix?: customSuffixType; + } + export interface CreateServiceLinkedRoleResponse { + /** + * A Role object that contains details about the newly created role. + */ + Role?: Role; + } + export interface CreateServiceSpecificCredentialRequest { + /** + * The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The name of the AWS service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials. + */ + ServiceName: serviceName; + } + export interface CreateServiceSpecificCredentialResponse { + /** + * A structure that contains information about the newly created service-specific credential. This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential. + */ + ServiceSpecificCredential?: ServiceSpecificCredential; + } + export interface CreateUserRequest { + /** + * The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + Path?: pathType; + /** + * The name of the user to create. IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource". + */ + UserName: userNameType; + /** + * The ARN of the policy that is used to set the permissions boundary for the user. + */ + PermissionsBoundary?: arnType; + /** + * A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed number of tags per user, then the entire request fails and the user is not created. + */ + Tags?: tagListType; + } + export interface CreateUserResponse { + /** + * A structure with details about the new IAM user. + */ + User?: User; + } + export interface CreateVirtualMFADeviceRequest { + /** + * The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + Path?: pathType; + /** + * The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + VirtualMFADeviceName: virtualMFADeviceName; + } + export interface CreateVirtualMFADeviceResponse { + /** + * A structure containing details about the new virtual MFA device. + */ + VirtualMFADevice: VirtualMFADevice; + } + export interface DeactivateMFADeviceRequest { + /** + * The name of the user whose MFA device you want to deactivate. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/- + */ + SerialNumber: serialNumberType; + } + export interface DeleteAccessKeyRequest { + /** + * The name of the user whose access key pair you want to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * The access key ID for the access key ID and secret access key you want to delete. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + AccessKeyId: accessKeyIdType; + } + export interface DeleteAccountAliasRequest { + /** + * The name of the account alias to delete. This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row. + */ + AccountAlias: accountAliasType; + } + export interface DeleteGroupPolicyRequest { + /** + * The name (friendly name, not ARN) identifying the group that the policy is embedded in. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * The name identifying the policy document to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + } + export interface DeleteGroupRequest { + /** + * The name of the IAM group to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + } + export interface DeleteInstanceProfileRequest { + /** + * The name of the instance profile to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + InstanceProfileName: instanceProfileNameType; + } + export interface DeleteLoginProfileRequest { + /** + * The name of the user whose password you want to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + } + export interface DeleteOpenIDConnectProviderRequest { + /** + * The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation. + */ + OpenIDConnectProviderArn: arnType; + } + export interface DeletePolicyRequest { + /** + * The Amazon Resource Name (ARN) of the IAM policy you want to delete. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface DeletePolicyVersionRequest { + /** + * The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + /** + * The policy version to delete. This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + VersionId: policyVersionIdType; + } + export interface DeleteRolePermissionsBoundaryRequest { + /** + * The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary. + */ + RoleName: roleNameType; + } + export interface DeleteRolePolicyRequest { + /** + * The name (friendly name, not ARN) identifying the role that the policy is embedded in. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The name of the inline policy to delete from the specified IAM role. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + } + export interface DeleteRoleRequest { + /** + * The name of the role to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + } + export interface DeleteSAMLProviderRequest { + /** + * The Amazon Resource Name (ARN) of the SAML provider to delete. + */ + SAMLProviderArn: arnType; + } + export interface DeleteSSHPublicKeyRequest { + /** + * The name of the IAM user associated with the SSH public key. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The unique identifier for the SSH public key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + SSHPublicKeyId: publicKeyIdType; + } + export interface DeleteServerCertificateRequest { + /** + * The name of the server certificate you want to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + ServerCertificateName: serverCertificateNameType; + } + export interface DeleteServiceLinkedRoleRequest { + /** + * The name of the service-linked role to be deleted. + */ + RoleName: roleNameType; + } + export interface DeleteServiceLinkedRoleResponse { + /** + * The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>. + */ + DeletionTaskId: DeletionTaskIdType; + } + export interface DeleteServiceSpecificCredentialRequest { + /** + * The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: userNameType; + /** + * The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + ServiceSpecificCredentialId: serviceSpecificCredentialId; + } + export interface DeleteSigningCertificateRequest { + /** + * The name of the user the signing certificate belongs to. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * The ID of the signing certificate to delete. The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits. + */ + CertificateId: certificateIdType; + } + export interface DeleteUserPermissionsBoundaryRequest { + /** + * The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary. + */ + UserName: userNameType; + } + export interface DeleteUserPolicyRequest { + /** + * The name (friendly name, not ARN) identifying the user that the policy is embedded in. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * The name identifying the policy document to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + } + export interface DeleteUserRequest { + /** + * The name of the user to delete. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + } + export interface DeleteVirtualMFADeviceRequest { + /** + * The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/- + */ + SerialNumber: serialNumberType; + } + export interface DeletionTaskFailureReasonType { + /** + * A short description of the reason that the service-linked role deletion failed. + */ + Reason?: ReasonType; + /** + * A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the region in which the resources are being used. + */ + RoleUsageList?: RoleUsageListType; + } + export type DeletionTaskIdType = string; + export type DeletionTaskStatusType = "SUCCEEDED"|"IN_PROGRESS"|"FAILED"|"NOT_STARTED"|string; + export interface DetachGroupPolicyRequest { + /** + * The name (friendly name, not ARN) of the IAM group to detach the policy from. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface DetachRolePolicyRequest { + /** + * The name (friendly name, not ARN) of the IAM role to detach the policy from. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface DetachUserPolicyRequest { + /** + * The name (friendly name, not ARN) of the IAM user to detach the policy from. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface EnableMFADeviceRequest { + /** + * The name of the IAM user for whom you want to enable the MFA device. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/- + */ + SerialNumber: serialNumberType; + /** + * An authentication code emitted by the device. The format for this parameter is a string of six digits. Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device. + */ + AuthenticationCode1: authenticationCodeType; + /** + * A subsequent authentication code emitted by the device. The format for this parameter is a string of six digits. Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device. + */ + AuthenticationCode2: authenticationCodeType; + } + export interface EntityDetails { + /** + * The EntityInfo object that contains details about the entity (user or role). + */ + EntityInfo: EntityInfo; + /** + * The date and time, in ISO 8601 date-time format, when the authenticated entity last attempted to access AWS. AWS does not report unauthenticated requests. This field is null if no IAM entities attempted to access the service within the reporting period. + */ + LastAuthenticated?: dateType; + } + export interface EntityInfo { + Arn: arnType; + /** + * The name of the entity (user or role). + */ + Name: userNameType; + /** + * The type of entity (user or role). + */ + Type: policyOwnerEntityType; + /** + * The identifier of the entity (user or role). + */ + Id: idType; + /** + * The path to the entity (user or role). For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path?: pathType; + } + export type EntityType = "User"|"Role"|"Group"|"LocalManagedPolicy"|"AWSManagedPolicy"|string; + export interface ErrorDetails { + /** + * Detailed information about the reason that the operation failed. + */ + Message: stringType; + /** + * The error code associated with the operation failure. + */ + Code: stringType; + } + export type EvalDecisionDetailsType = {[key: string]: PolicyEvaluationDecisionType}; + export type EvalDecisionSourceType = string; + export interface EvaluationResult { + /** + * The name of the API operation tested on the indicated resource. + */ + EvalActionName: ActionNameType; + /** + * The ARN of the resource that the indicated API operation was tested on. + */ + EvalResourceName?: ResourceNameType; + /** + * The result of the simulation. + */ + EvalDecision: PolicyEvaluationDecisionType; + /** + * A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. Inaddition, the deny statement is the only entry included in the result. + */ + MatchedStatements?: StatementListType; + /** + * A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy. + */ + MissingContextValues?: ContextKeyNamesResultListType; + /** + * A structure that details how AWS Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization. + */ + OrganizationsDecisionDetail?: OrganizationsDecisionDetail; + /** + * Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies + */ + EvalDecisionDetails?: EvalDecisionDetailsType; + /** + * The individual results of the simulation of the API operation specified in EvalActionName on each resource. + */ + ResourceSpecificResults?: ResourceSpecificResultListType; + } + export type EvaluationResultsListType = EvaluationResult[]; + export interface GenerateCredentialReportResponse { + /** + * Information about the state of the credential report. + */ + State?: ReportStateType; + /** + * Information about the credential report. + */ + Description?: ReportStateDescriptionType; + } + export interface GenerateServiceLastAccessedDetailsRequest { + /** + * The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an AWS service. + */ + Arn: arnType; + } + export interface GenerateServiceLastAccessedDetailsResponse { + /** + * The job ID that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. + */ + JobId?: jobIDType; + } + export interface GetAccessKeyLastUsedRequest { + /** + * The identifier of an access key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + AccessKeyId: accessKeyIdType; + } + export interface GetAccessKeyLastUsedResponse { + /** + * The name of the AWS IAM user that owns this access key. + */ + UserName?: existingUserNameType; + /** + * Contains information about the last time the access key was used. + */ + AccessKeyLastUsed?: AccessKeyLastUsed; + } + export interface GetAccountAuthorizationDetailsRequest { + /** + * A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies. The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below. + */ + Filter?: entityListType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + } + export interface GetAccountAuthorizationDetailsResponse { + /** + * A list containing information about IAM users. + */ + UserDetailList?: userDetailListType; + /** + * A list containing information about IAM groups. + */ + GroupDetailList?: groupDetailListType; + /** + * A list containing information about IAM roles. + */ + RoleDetailList?: roleDetailListType; + /** + * A list containing information about managed policies. + */ + Policies?: ManagedPolicyDetailListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface GetAccountPasswordPolicyResponse { + /** + * A structure that contains details about the account's password policy. + */ + PasswordPolicy: PasswordPolicy; + } + export interface GetAccountSummaryResponse { + /** + * A set of key–value pairs containing information about IAM entity usage and IAM quotas. + */ + SummaryMap?: summaryMapType; + } + export interface GetContextKeysForCustomPolicyRequest { + /** + * A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyInputList: SimulationPolicyListType; + } + export interface GetContextKeysForPolicyResponse { + /** + * The list of context keys that are referenced in the input policies. + */ + ContextKeyNames?: ContextKeyNamesResultListType; + } + export interface GetContextKeysForPrincipalPolicyRequest { + /** + * The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicySourceArn: arnType; + /** + * An optional list of additional policies for which you want the list of context keys that are referenced. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyInputList?: SimulationPolicyListType; + } + export interface GetCredentialReportResponse { + /** + * Contains the credential report. The report is Base64-encoded. + */ + Content?: ReportContentType; + /** + * The format (MIME type) of the credential report. + */ + ReportFormat?: ReportFormatType; + /** + * The date and time when the credential report was created, in ISO 8601 date-time format. + */ + GeneratedTime?: dateType; + } + export interface GetGroupPolicyRequest { + /** + * The name of the group the policy is associated with. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * The name of the policy document to get. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + } + export interface GetGroupPolicyResponse { + /** + * The group the policy is associated with. + */ + GroupName: groupNameType; + /** + * The name of the policy. + */ + PolicyName: policyNameType; + /** + * The policy document. IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. + */ + PolicyDocument: policyDocumentType; + } + export interface GetGroupRequest { + /** + * The name of the group. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface GetGroupResponse { + /** + * A structure that contains details about the group. + */ + Group: Group; + /** + * A list of users in the group. + */ + Users: userListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface GetInstanceProfileRequest { + /** + * The name of the instance profile to get information about. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + InstanceProfileName: instanceProfileNameType; + } + export interface GetInstanceProfileResponse { + /** + * A structure containing details about the instance profile. + */ + InstanceProfile: InstanceProfile; + } + export interface GetLoginProfileRequest { + /** + * The name of the user whose login profile you want to retrieve. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + } + export interface GetLoginProfileResponse { + /** + * A structure containing the user name and password create date for the user. + */ + LoginProfile: LoginProfile; + } + export interface GetOpenIDConnectProviderRequest { + /** + * The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + OpenIDConnectProviderArn: arnType; + } + export interface GetOpenIDConnectProviderResponse { + /** + * The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider. + */ + Url?: OpenIDConnectProviderUrlType; + /** + * A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider. + */ + ClientIDList?: clientIDListType; + /** + * A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider. + */ + ThumbprintList?: thumbprintListType; + /** + * The date and time when the IAM OIDC provider resource object was created in the AWS account. + */ + CreateDate?: dateType; + } + export interface GetPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the managed policy that you want information about. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + } + export interface GetPolicyResponse { + /** + * A structure containing details about the policy. + */ + Policy?: Policy; + } + export interface GetPolicyVersionRequest { + /** + * The Amazon Resource Name (ARN) of the managed policy that you want information about. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + /** + * Identifies the policy version to retrieve. This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits. + */ + VersionId: policyVersionIdType; + } + export interface GetPolicyVersionResponse { + /** + * A structure containing details about the policy version. + */ + PolicyVersion?: PolicyVersion; + } + export interface GetRolePolicyRequest { + /** + * The name of the role associated with the policy. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The name of the policy document to get. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + } + export interface GetRolePolicyResponse { + /** + * The role the policy is associated with. + */ + RoleName: roleNameType; + /** + * The name of the policy. + */ + PolicyName: policyNameType; + /** + * The policy document. IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. + */ + PolicyDocument: policyDocumentType; + } + export interface GetRoleRequest { + /** + * The name of the IAM role to get information about. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + } + export interface GetRoleResponse { + /** + * A structure containing details about the IAM role. + */ + Role: Role; + } + export interface GetSAMLProviderRequest { + /** + * The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + SAMLProviderArn: arnType; + } + export interface GetSAMLProviderResponse { + /** + * The XML metadata document that includes information about an identity provider. + */ + SAMLMetadataDocument?: SAMLMetadataDocumentType; + /** + * The date and time when the SAML provider was created. + */ + CreateDate?: dateType; + /** + * The expiration date and time for the SAML provider. + */ + ValidUntil?: dateType; + } + export interface GetSSHPublicKeyRequest { + /** + * The name of the IAM user associated with the SSH public key. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The unique identifier for the SSH public key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + SSHPublicKeyId: publicKeyIdType; + /** + * Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM. + */ + Encoding: encodingType; + } + export interface GetSSHPublicKeyResponse { + /** + * A structure containing details about the SSH public key. + */ + SSHPublicKey?: SSHPublicKey; + } + export interface GetServerCertificateRequest { + /** + * The name of the server certificate you want to retrieve information about. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + ServerCertificateName: serverCertificateNameType; + } + export interface GetServerCertificateResponse { + /** + * A structure containing details about the server certificate. + */ + ServerCertificate: ServerCertificate; + } + export interface GetServiceLastAccessedDetailsRequest { + /** + * The ID of the request generated by the GenerateServiceLastAccessedDetails operation. + */ + JobId: jobIDType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + } + export interface GetServiceLastAccessedDetailsResponse { + /** + * The status of the job. + */ + JobStatus: jobStatusType; + /** + * The date and time, in ISO 8601 date-time format, when the report job was created. + */ + JobCreationDate: dateType; + /** + * A ServiceLastAccessed object that contains details about the most recent attempt to access the service. + */ + ServicesLastAccessed: ServicesLastAccessed; + /** + * The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed. This field is null if the job is still in progress, as indicated by a JobStatus value of IN_PROGRESS. + */ + JobCompletionDate: dateType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + /** + * An object that contains details about the reason the operation failed. + */ + Error?: ErrorDetails; + } + export interface GetServiceLastAccessedDetailsWithEntitiesRequest { + /** + * The ID of the request generated by the GenerateServiceLastAccessedDetails operation. + */ + JobId: jobIDType; + /** + * The service namespace for an AWS service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service. To learn the service namespace for a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference. + */ + ServiceNamespace: serviceNamespaceType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + } + export interface GetServiceLastAccessedDetailsWithEntitiesResponse { + /** + * The status of the job. + */ + JobStatus: jobStatusType; + /** + * The date and time, in ISO 8601 date-time format, when the report job was created. + */ + JobCreationDate: dateType; + /** + * The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed. + */ + JobCompletionDate: dateType; + /** + * An EntityDetailsList object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified AWS service. + */ + EntityDetailsList: entityDetailsListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + /** + * An object that contains details about the reason the operation failed. + */ + Error?: ErrorDetails; + } + export interface GetServiceLinkedRoleDeletionStatusRequest { + /** + * The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>. + */ + DeletionTaskId: DeletionTaskIdType; + } + export interface GetServiceLinkedRoleDeletionStatusResponse { + /** + * The status of the deletion. + */ + Status: DeletionTaskStatusType; + /** + * An object that contains details about the reason the deletion failed. + */ + Reason?: DeletionTaskFailureReasonType; + } + export interface GetUserPolicyRequest { + /** + * The name of the user who the policy is associated with. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * The name of the policy document to get. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + } + export interface GetUserPolicyResponse { + /** + * The user the policy is associated with. + */ + UserName: existingUserNameType; + /** + * The name of the policy. + */ + PolicyName: policyNameType; + /** + * The policy document. IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. + */ + PolicyDocument: policyDocumentType; + } + export interface GetUserRequest { + /** + * The name of the user to get information about. This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + } + export interface GetUserResponse { + /** + * A structure containing details about the IAM user. Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used dates in the IAM credential report, and returned by this GetUser API. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the returned password last used date is accurate. You can use password last used information to identify unused credentials for deletion. For example, you might delete users who did not sign in to AWS in the last 90 days. In cases like this, we recommend that you adjust your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to access AWS programmatically you can refer to access key last used information because it is accurate for all dates. + */ + User: User; + } + export interface Group { + /** + * The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path: pathType; + /** + * The friendly name that identifies the group. + */ + GroupName: groupNameType; + /** + * The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + GroupId: idType; + /** + * The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide. + */ + Arn: arnType; + /** + * The date and time, in ISO 8601 date-time format, when the group was created. + */ + CreateDate: dateType; + } + export interface GroupDetail { + /** + * The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path?: pathType; + /** + * The friendly name that identifies the group. + */ + GroupName?: groupNameType; + /** + * The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + GroupId?: idType; + Arn?: arnType; + /** + * The date and time, in ISO 8601 date-time format, when the group was created. + */ + CreateDate?: dateType; + /** + * A list of the inline policies embedded in the group. + */ + GroupPolicyList?: policyDetailListType; + /** + * A list of the managed policies attached to the group. + */ + AttachedManagedPolicies?: attachedPoliciesListType; + } + export interface InstanceProfile { + /** + * The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path: pathType; + /** + * The name identifying the instance profile. + */ + InstanceProfileName: instanceProfileNameType; + /** + * The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + InstanceProfileId: idType; + /** + * The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide. + */ + Arn: arnType; + /** + * The date when the instance profile was created. + */ + CreateDate: dateType; + /** + * The role associated with the instance profile. + */ + Roles: roleListType; + } + export type LineNumber = number; + export interface ListAccessKeysRequest { + /** + * The name of the user. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListAccessKeysResponse { + /** + * A list of objects containing metadata about the access keys. + */ + AccessKeyMetadata: accessKeyMetadataListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListAccountAliasesRequest { + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListAccountAliasesResponse { + /** + * A list of aliases associated with the account. AWS supports only one alias per account. + */ + AccountAliases: accountAliasListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListAttachedGroupPoliciesRequest { + /** + * The name (friendly name, not ARN) of the group to list attached policies for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: policyPathType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListAttachedGroupPoliciesResponse { + /** + * A list of the attached policies. + */ + AttachedPolicies?: attachedPoliciesListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListAttachedRolePoliciesRequest { + /** + * The name (friendly name, not ARN) of the role to list attached policies for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: policyPathType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListAttachedRolePoliciesResponse { + /** + * A list of the attached policies. + */ + AttachedPolicies?: attachedPoliciesListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListAttachedUserPoliciesRequest { + /** + * The name (friendly name, not ARN) of the user to list attached policies for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: policyPathType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListAttachedUserPoliciesResponse { + /** + * A list of the attached policies. + */ + AttachedPolicies?: attachedPoliciesListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListEntitiesForPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the IAM policy for which you want the versions. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + /** + * The entity type to use for filtering the results. For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below. + */ + EntityFilter?: EntityType; + /** + * The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: pathType; + /** + * The policy usage method to use for filtering the results. To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary. This parameter is optional. If it is not included, all policies are returned. + */ + PolicyUsageFilter?: PolicyUsageType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListEntitiesForPolicyResponse { + /** + * A list of IAM groups that the policy is attached to. + */ + PolicyGroups?: PolicyGroupListType; + /** + * A list of IAM users that the policy is attached to. + */ + PolicyUsers?: PolicyUserListType; + /** + * A list of IAM roles that the policy is attached to. + */ + PolicyRoles?: PolicyRoleListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListGroupPoliciesRequest { + /** + * The name of the group to list policies for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListGroupPoliciesResponse { + /** + * A list of policy names. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyNames: policyNameListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListGroupsForUserRequest { + /** + * The name of the user to list groups for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListGroupsForUserResponse { + /** + * A list of groups. + */ + Groups: groupListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListGroupsRequest { + /** + * The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: pathPrefixType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListGroupsResponse { + /** + * A list of groups. + */ + Groups: groupListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListInstanceProfilesForRoleRequest { + /** + * The name of the role to list instance profiles for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListInstanceProfilesForRoleResponse { + /** + * A list of instance profiles. + */ + InstanceProfiles: instanceProfileListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListInstanceProfilesRequest { + /** + * The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: pathPrefixType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListInstanceProfilesResponse { + /** + * A list of instance profiles. + */ + InstanceProfiles: instanceProfileListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListMFADevicesRequest { + /** + * The name of the user whose MFA devices you want to list. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListMFADevicesResponse { + /** + * A list of MFA devices. + */ + MFADevices: mfaDeviceListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListOpenIDConnectProvidersRequest { + } + export interface ListOpenIDConnectProvidersResponse { + /** + * The list of IAM OIDC provider resource objects defined in the AWS account. + */ + OpenIDConnectProviderList?: OpenIDConnectProviderListType; + } + export interface ListPoliciesGrantingServiceAccessEntry { + /** + * The namespace of the service that was accessed. To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference. + */ + ServiceNamespace?: serviceNamespaceType; + /** + * The PoliciesGrantingServiceAccess object that contains details about the policy. + */ + Policies?: policyGrantingServiceAccessListType; + } + export interface ListPoliciesGrantingServiceAccessRequest { + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * The ARN of the IAM identity (user, group, or role) whose policies you want to list. + */ + Arn: arnType; + /** + * The service namespace for the AWS services whose policies you want to list. To learn the service namespace for a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference. + */ + ServiceNamespaces: serviceNamespaceListType; + } + export interface ListPoliciesGrantingServiceAccessResponse { + /** + * A ListPoliciesGrantingServiceAccess object that contains details about the permissions policies attached to the specified identity (user, group, or role). + */ + PoliciesGrantingServiceAccess: listPolicyGrantingServiceAccessResponseListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListPoliciesRequest { + /** + * The scope to use for filtering the results. To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS account, set Scope to Local. This parameter is optional. If it is not included, or if it is set to All, all policies are returned. + */ + Scope?: policyScopeType; + /** + * A flag to filter the results to only the attached policies. When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned. + */ + OnlyAttached?: booleanType; + /** + * The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: policyPathType; + /** + * The policy usage method to use for filtering the results. To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary. This parameter is optional. If it is not included, all policies are returned. + */ + PolicyUsageFilter?: PolicyUsageType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListPoliciesResponse { + /** + * A list of policies. + */ + Policies?: policyListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListPolicyVersionsRequest { + /** + * The Amazon Resource Name (ARN) of the IAM policy for which you want the versions. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListPolicyVersionsResponse { + /** + * A list of policy versions. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + Versions?: policyDocumentVersionListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListRolePoliciesRequest { + /** + * The name of the role to list policies for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListRolePoliciesResponse { + /** + * A list of policy names. + */ + PolicyNames: policyNameListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListRoleTagsRequest { + /** + * The name of the IAM role for which you want to see the list of tags. This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * (Optional) Use this only when paginating results to indicate the maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated response element is true. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when more results are available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListRoleTagsResponse { + /** + * The list of tags currently that is attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified role, the response contains an empty list. + */ + Tags: tagListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can use the Marker request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the MaxItems number of results even when more results are available. Check IsTruncated after every call to ensure that you receive all of your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListRolesRequest { + /** + * The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: pathPrefixType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListRolesResponse { + /** + * A list of roles. + */ + Roles: roleListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListSAMLProvidersRequest { + } + export interface ListSAMLProvidersResponse { + /** + * The list of SAML provider resource objects defined in IAM for this AWS account. + */ + SAMLProviderList?: SAMLProviderListType; + } + export interface ListSSHPublicKeysRequest { + /** + * The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the AWS access key used to sign the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: userNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListSSHPublicKeysResponse { + /** + * A list of the SSH public keys assigned to IAM user. + */ + SSHPublicKeys?: SSHPublicKeyListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListServerCertificatesRequest { + /** + * The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts. This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: pathPrefixType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListServerCertificatesResponse { + /** + * A list of server certificates. + */ + ServerCertificateMetadataList: serverCertificateMetadataListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListServiceSpecificCredentialsRequest { + /** + * The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: userNameType; + /** + * Filters the returned results to only those for the specified AWS service. If not specified, then AWS returns service-specific credentials for all services. + */ + ServiceName?: serviceName; + } + export interface ListServiceSpecificCredentialsResponse { + /** + * A list of structures that each contain details about a service-specific credential. + */ + ServiceSpecificCredentials?: ServiceSpecificCredentialsListType; + } + export interface ListSigningCertificatesRequest { + /** + * The name of the IAM user whose signing certificates you want to examine. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListSigningCertificatesResponse { + /** + * A list of the user's signing certificate information. + */ + Certificates: certificateListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListUserPoliciesRequest { + /** + * The name of the user to list policies for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListUserPoliciesResponse { + /** + * A list of policy names. + */ + PolicyNames: policyNameListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListUserTagsRequest { + /** + * The name of the IAM user whose tags you want to see. This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@- + */ + UserName: existingUserNameType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * (Optional) Use this only when paginating results to indicate the maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated response element is true. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when more results are available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListUserTagsResponse { + /** + * The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified user, the response contains an empty list. + */ + Tags: tagListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can use the Marker request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the MaxItems number of results even when more results are available. Check IsTruncated after every call to ensure that you receive all of your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListUsersRequest { + /** + * The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + PathPrefix?: pathPrefixType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListUsersResponse { + /** + * A list of users. + */ + Users: userListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface ListVirtualMFADevicesRequest { + /** + * The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices., + */ + AssignmentStatus?: assignmentStatusType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + } + export interface ListVirtualMFADevicesResponse { + /** + * The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request. + */ + VirtualMFADevices: virtualMFADeviceListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface LoginProfile { + /** + * The name of the user, which can be used for signing in to the AWS Management Console. + */ + UserName: userNameType; + /** + * The date when the password for the user was created. + */ + CreateDate: dateType; + /** + * Specifies whether the user is required to set a new password on next sign-in. + */ + PasswordResetRequired?: booleanType; + } + export interface MFADevice { + /** + * The user with whom the MFA device is associated. + */ + UserName: userNameType; + /** + * The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. + */ + SerialNumber: serialNumberType; + /** + * The date when the MFA device was enabled for the user. + */ + EnableDate: dateType; + } + export interface ManagedPolicyDetail { + /** + * The friendly name (not ARN) identifying the policy. + */ + PolicyName?: policyNameType; + /** + * The stable and unique string identifying the policy. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + PolicyId?: idType; + Arn?: arnType; + /** + * The path to the policy. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path?: policyPathType; + /** + * The identifier for the version of the policy that is set as the default (operative) version. For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide. + */ + DefaultVersionId?: policyVersionIdType; + /** + * The number of principal entities (users, groups, and roles) that the policy is attached to. + */ + AttachmentCount?: attachmentCountType; + /** + * The number of entities (users and roles) for which the policy is used as the permissions boundary. For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide. + */ + PermissionsBoundaryUsageCount?: attachmentCountType; + /** + * Specifies whether the policy can be attached to an IAM user, group, or role. + */ + IsAttachable?: booleanType; + /** + * A friendly description of the policy. + */ + Description?: policyDescriptionType; + /** + * The date and time, in ISO 8601 date-time format, when the policy was created. + */ + CreateDate?: dateType; + /** + * The date and time, in ISO 8601 date-time format, when the policy was last updated. When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created. + */ + UpdateDate?: dateType; + /** + * A list containing information about the versions of the policy. + */ + PolicyVersionList?: policyDocumentVersionListType; + } + export type ManagedPolicyDetailListType = ManagedPolicyDetail[]; + export interface OpenIDConnectProviderListEntry { + Arn?: arnType; + } + export type OpenIDConnectProviderListType = OpenIDConnectProviderListEntry[]; + export type OpenIDConnectProviderUrlType = string; + export interface OrganizationsDecisionDetail { + /** + * Specifies whether the simulated operation is allowed by the AWS Organizations service control policies that impact the simulated user's account. + */ + AllowedByOrganizations?: booleanType; + } + export interface PasswordPolicy { + /** + * Minimum length to require for IAM user passwords. + */ + MinimumPasswordLength?: minimumPasswordLengthType; + /** + * Specifies whether to require symbols for IAM user passwords. + */ + RequireSymbols?: booleanType; + /** + * Specifies whether to require numbers for IAM user passwords. + */ + RequireNumbers?: booleanType; + /** + * Specifies whether to require uppercase characters for IAM user passwords. + */ + RequireUppercaseCharacters?: booleanType; + /** + * Specifies whether to require lowercase characters for IAM user passwords. + */ + RequireLowercaseCharacters?: booleanType; + /** + * Specifies whether IAM users are allowed to change their own password. + */ + AllowUsersToChangePassword?: booleanType; + /** + * Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present. + */ + ExpirePasswords?: booleanType; + /** + * The number of days that an IAM user password is valid. + */ + MaxPasswordAge?: maxPasswordAgeType; + /** + * Specifies the number of previous passwords that IAM users are prevented from reusing. + */ + PasswordReusePrevention?: passwordReusePreventionType; + /** + * Specifies whether IAM users are prevented from setting a new password after their password has expired. + */ + HardExpiry?: booleanObjectType; + } + export type PermissionsBoundaryAttachmentType = "PermissionsBoundaryPolicy"|string; + export interface Policy { + /** + * The friendly name (not ARN) identifying the policy. + */ + PolicyName?: policyNameType; + /** + * The stable and unique string identifying the policy. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + PolicyId?: idType; + Arn?: arnType; + /** + * The path to the policy. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path?: policyPathType; + /** + * The identifier for the version of the policy that is set as the default version. + */ + DefaultVersionId?: policyVersionIdType; + /** + * The number of entities (users, groups, and roles) that the policy is attached to. + */ + AttachmentCount?: attachmentCountType; + /** + * The number of entities (users and roles) for which the policy is used to set the permissions boundary. For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide. + */ + PermissionsBoundaryUsageCount?: attachmentCountType; + /** + * Specifies whether the policy can be attached to an IAM user, group, or role. + */ + IsAttachable?: booleanType; + /** + * A friendly description of the policy. This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation. + */ + Description?: policyDescriptionType; + /** + * The date and time, in ISO 8601 date-time format, when the policy was created. + */ + CreateDate?: dateType; + /** + * The date and time, in ISO 8601 date-time format, when the policy was last updated. When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created. + */ + UpdateDate?: dateType; + } + export interface PolicyDetail { + /** + * The name of the policy. + */ + PolicyName?: policyNameType; + /** + * The policy document. + */ + PolicyDocument?: policyDocumentType; + } + export type PolicyEvaluationDecisionType = "allowed"|"explicitDeny"|"implicitDeny"|string; + export interface PolicyGrantingServiceAccess { + /** + * The policy name. + */ + PolicyName: policyNameType; + /** + * The policy type. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide. + */ + PolicyType: policyType; + PolicyArn?: arnType; + /** + * The type of entity (user or role) that used the policy to access the service to which the inline policy is attached. This field is null for managed policies. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide. + */ + EntityType?: policyOwnerEntityType; + /** + * The name of the entity (user or role) to which the inline policy is attached. This field is null for managed policies. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide. + */ + EntityName?: entityNameType; + } + export interface PolicyGroup { + /** + * The name (friendly name, not ARN) identifying the group. + */ + GroupName?: groupNameType; + /** + * The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM User Guide. + */ + GroupId?: idType; + } + export type PolicyGroupListType = PolicyGroup[]; + export type PolicyIdentifierType = string; + export interface PolicyRole { + /** + * The name (friendly name, not ARN) identifying the role. + */ + RoleName?: roleNameType; + /** + * The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM User Guide. + */ + RoleId?: idType; + } + export type PolicyRoleListType = PolicyRole[]; + export type PolicySourceType = "user"|"group"|"role"|"aws-managed"|"user-managed"|"resource"|"none"|string; + export type PolicyUsageType = "PermissionsPolicy"|"PermissionsBoundary"|string; + export interface PolicyUser { + /** + * The name (friendly name, not ARN) identifying the user. + */ + UserName?: userNameType; + /** + * The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide. + */ + UserId?: idType; + } + export type PolicyUserListType = PolicyUser[]; + export interface PolicyVersion { + /** + * The policy document. The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations. The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. + */ + Document?: policyDocumentType; + /** + * The identifier for the policy version. Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1. + */ + VersionId?: policyVersionIdType; + /** + * Specifies whether the policy version is set as the policy's default version. + */ + IsDefaultVersion?: booleanType; + /** + * The date and time, in ISO 8601 date-time format, when the policy version was created. + */ + CreateDate?: dateType; + } + export interface Position { + /** + * The line containing the specified position in the document. + */ + Line?: LineNumber; + /** + * The column in the line containing the specified position in the document. + */ + Column?: ColumnNumber; + } + export interface PutGroupPolicyRequest { + /** + * The name of the group to associate the policy with. &regex-name;. + */ + GroupName: groupNameType; + /** + * The name of the policy document. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + /** + * The policy document. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyDocument: policyDocumentType; + } + export interface PutRolePermissionsBoundaryRequest { + /** + * The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary. + */ + RoleName: roleNameType; + /** + * The ARN of the policy that is used to set the permissions boundary for the role. + */ + PermissionsBoundary: arnType; + } + export interface PutRolePolicyRequest { + /** + * The name of the role to associate the policy with. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The name of the policy document. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + /** + * The policy document. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyDocument: policyDocumentType; + } + export interface PutUserPermissionsBoundaryRequest { + /** + * The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary. + */ + UserName: userNameType; + /** + * The ARN of the policy that is used to set the permissions boundary for the user. + */ + PermissionsBoundary: arnType; + } + export interface PutUserPolicyRequest { + /** + * The name of the user to associate the policy with. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * The name of the policy document. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + PolicyName: policyNameType; + /** + * The policy document. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyDocument: policyDocumentType; + } + export type ReasonType = string; + export type RegionNameType = string; + export interface RemoveClientIDFromOpenIDConnectProviderRequest { + /** + * The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + OpenIDConnectProviderArn: arnType; + /** + * The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider. + */ + ClientID: clientIDType; + } + export interface RemoveRoleFromInstanceProfileRequest { + /** + * The name of the instance profile to update. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + InstanceProfileName: instanceProfileNameType; + /** + * The name of the role to remove. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + } + export interface RemoveUserFromGroupRequest { + /** + * The name of the group to update. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * The name of the user to remove. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + } + export type ReportContentType = Buffer|Uint8Array|Blob|string; + export type ReportFormatType = "text/csv"|string; + export type ReportStateDescriptionType = string; + export type ReportStateType = "STARTED"|"INPROGRESS"|"COMPLETE"|string; + export interface ResetServiceSpecificCredentialRequest { + /** + * The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: userNameType; + /** + * The unique identifier of the service-specific credential. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + ServiceSpecificCredentialId: serviceSpecificCredentialId; + } + export interface ResetServiceSpecificCredentialResponse { + /** + * A structure with details about the updated service-specific credential, including the new password. This is the only time that you can access the password. You cannot recover the password later, but you can reset it again. + */ + ServiceSpecificCredential?: ServiceSpecificCredential; + } + export type ResourceHandlingOptionType = string; + export type ResourceNameListType = ResourceNameType[]; + export type ResourceNameType = string; + export interface ResourceSpecificResult { + /** + * The name of the simulated resource, in Amazon Resource Name (ARN) format. + */ + EvalResourceName: ResourceNameType; + /** + * The result of the simulation of the simulated API operation on the resource specified in EvalResourceName. + */ + EvalResourceDecision: PolicyEvaluationDecisionType; + /** + * A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result. + */ + MatchedStatements?: StatementListType; + /** + * A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy. + */ + MissingContextValues?: ContextKeyNamesResultListType; + /** + * Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. + */ + EvalDecisionDetails?: EvalDecisionDetailsType; + } + export type ResourceSpecificResultListType = ResourceSpecificResult[]; + export interface ResyncMFADeviceRequest { + /** + * The name of the user whose MFA device you want to resynchronize. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * Serial number that uniquely identifies the MFA device. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + SerialNumber: serialNumberType; + /** + * An authentication code emitted by the device. The format for this parameter is a sequence of six digits. + */ + AuthenticationCode1: authenticationCodeType; + /** + * A subsequent authentication code emitted by the device. The format for this parameter is a sequence of six digits. + */ + AuthenticationCode2: authenticationCodeType; + } + export interface Role { + /** + * The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path: pathType; + /** + * The friendly name that identifies the role. + */ + RoleName: roleNameType; + /** + * The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + RoleId: idType; + /** + * The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide. + */ + Arn: arnType; + /** + * The date and time, in ISO 8601 date-time format, when the role was created. + */ + CreateDate: dateType; + /** + * The policy that grants an entity permission to assume the role. + */ + AssumeRolePolicyDocument?: policyDocumentType; + /** + * A description of the role that you provide. + */ + Description?: roleDescriptionType; + /** + * The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter. + */ + MaxSessionDuration?: roleMaxSessionDurationType; + /** + * The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide. + */ + PermissionsBoundary?: AttachedPermissionsBoundary; + /** + * A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + Tags?: tagListType; + } + export interface RoleDetail { + /** + * The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path?: pathType; + /** + * The friendly name that identifies the role. + */ + RoleName?: roleNameType; + /** + * The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + RoleId?: idType; + Arn?: arnType; + /** + * The date and time, in ISO 8601 date-time format, when the role was created. + */ + CreateDate?: dateType; + /** + * The trust policy that grants permission to assume the role. + */ + AssumeRolePolicyDocument?: policyDocumentType; + /** + * A list of instance profiles that contain this role. + */ + InstanceProfileList?: instanceProfileListType; + /** + * A list of inline policies embedded in the role. These policies are the role's access (permissions) policies. + */ + RolePolicyList?: policyDetailListType; + /** + * A list of managed policies attached to the role. These policies are the role's access (permissions) policies. + */ + AttachedManagedPolicies?: attachedPoliciesListType; + /** + * The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide. + */ + PermissionsBoundary?: AttachedPermissionsBoundary; + /** + * A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + Tags?: tagListType; + } + export type RoleUsageListType = RoleUsageType[]; + export interface RoleUsageType { + /** + * The name of the region where the service-linked role is being used. + */ + Region?: RegionNameType; + /** + * The name of the resource that is using the service-linked role. + */ + Resources?: ArnListType; + } + export type SAMLMetadataDocumentType = string; + export interface SAMLProviderListEntry { + /** + * The Amazon Resource Name (ARN) of the SAML provider. + */ + Arn?: arnType; + /** + * The expiration date and time for the SAML provider. + */ + ValidUntil?: dateType; + /** + * The date and time when the SAML provider was created. + */ + CreateDate?: dateType; + } + export type SAMLProviderListType = SAMLProviderListEntry[]; + export type SAMLProviderNameType = string; + export interface SSHPublicKey { + /** + * The name of the IAM user associated with the SSH public key. + */ + UserName: userNameType; + /** + * The unique identifier for the SSH public key. + */ + SSHPublicKeyId: publicKeyIdType; + /** + * The MD5 message digest of the SSH public key. + */ + Fingerprint: publicKeyFingerprintType; + /** + * The SSH public key. + */ + SSHPublicKeyBody: publicKeyMaterialType; + /** + * The status of the SSH public key. Active means that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used. + */ + Status: statusType; + /** + * The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded. + */ + UploadDate?: dateType; + } + export type SSHPublicKeyListType = SSHPublicKeyMetadata[]; + export interface SSHPublicKeyMetadata { + /** + * The name of the IAM user associated with the SSH public key. + */ + UserName: userNameType; + /** + * The unique identifier for the SSH public key. + */ + SSHPublicKeyId: publicKeyIdType; + /** + * The status of the SSH public key. Active means that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used. + */ + Status: statusType; + /** + * The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded. + */ + UploadDate: dateType; + } + export interface ServerCertificate { + /** + * The meta information of the server certificate, such as its name, path, ID, and ARN. + */ + ServerCertificateMetadata: ServerCertificateMetadata; + /** + * The contents of the public key certificate. + */ + CertificateBody: certificateBodyType; + /** + * The contents of the public key certificate chain. + */ + CertificateChain?: certificateChainType; + } + export interface ServerCertificateMetadata { + /** + * The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path: pathType; + /** + * The name that identifies the server certificate. + */ + ServerCertificateName: serverCertificateNameType; + /** + * The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + ServerCertificateId: idType; + /** + * The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide. + */ + Arn: arnType; + /** + * The date when the server certificate was uploaded. + */ + UploadDate?: dateType; + /** + * The date on which the certificate is set to expire. + */ + Expiration?: dateType; + } + export interface ServiceLastAccessed { + /** + * The name of the service in which access was attempted. + */ + ServiceName: serviceNameType; + /** + * The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the service. AWS does not report unauthenticated requests. This field is null if no IAM entities attempted to access the service within the reporting period. + */ + LastAuthenticated?: dateType; + /** + * The namespace of the service in which access was attempted. To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference. + */ + ServiceNamespace: serviceNamespaceType; + /** + * The ARN of the authenticated entity (user or role) that last attempted to access the service. AWS does not report unauthenticated requests. This field is null if no IAM entities attempted to access the service within the reporting period. + */ + LastAuthenticatedEntity?: arnType; + /** + * The total number of authenticated entities that have attempted to access the service. This field is null if no IAM entities attempted to access the service within the reporting period. + */ + TotalAuthenticatedEntities?: integerType; + } + export interface ServiceSpecificCredential { + /** + * The date and time, in ISO 8601 date-time format, when the service-specific credential were created. + */ + CreateDate: dateType; + /** + * The name of the service associated with the service-specific credential. + */ + ServiceName: serviceName; + /** + * The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the AWS account, as in jane-at-123456789012, for example. This value cannot be configured by the user. + */ + ServiceUserName: serviceUserName; + /** + * The generated password for the service-specific credential. + */ + ServicePassword: servicePassword; + /** + * The unique identifier for the service-specific credential. + */ + ServiceSpecificCredentialId: serviceSpecificCredentialId; + /** + * The name of the IAM user associated with the service-specific credential. + */ + UserName: userNameType; + /** + * The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not. + */ + Status: statusType; + } + export interface ServiceSpecificCredentialMetadata { + /** + * The name of the IAM user associated with the service-specific credential. + */ + UserName: userNameType; + /** + * The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not. + */ + Status: statusType; + /** + * The generated user name for the service-specific credential. + */ + ServiceUserName: serviceUserName; + /** + * The date and time, in ISO 8601 date-time format, when the service-specific credential were created. + */ + CreateDate: dateType; + /** + * The unique identifier for the service-specific credential. + */ + ServiceSpecificCredentialId: serviceSpecificCredentialId; + /** + * The name of the service associated with the service-specific credential. + */ + ServiceName: serviceName; + } + export type ServiceSpecificCredentialsListType = ServiceSpecificCredentialMetadata[]; + export type ServicesLastAccessed = ServiceLastAccessed[]; + export interface SetDefaultPolicyVersionRequest { + /** + * The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicyArn: arnType; + /** + * The version of the policy to set as the default (operative) version. For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide. + */ + VersionId: policyVersionIdType; + } + export interface SetSecurityTokenServicePreferencesRequest { + /** + * The version of the global endpoint token. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and Deactivating STS in an AWS Region in the IAM User Guide. + */ + GlobalEndpointTokenVersion: globalEndpointTokenVersion; + } + export interface SigningCertificate { + /** + * The name of the user the signing certificate is associated with. + */ + UserName: userNameType; + /** + * The ID for the signing certificate. + */ + CertificateId: certificateIdType; + /** + * The contents of the signing certificate. + */ + CertificateBody: certificateBodyType; + /** + * The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not. + */ + Status: statusType; + /** + * The date when the signing certificate was uploaded. + */ + UploadDate?: dateType; + } + export interface SimulateCustomPolicyRequest { + /** + * A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyInputList: SimulationPolicyListType; + /** + * A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name. + */ + ActionNames: ActionNameListType; + /** + * A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter. If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + ResourceArns?: ResourceNameListType; + /** + * A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + ResourcePolicy?: policyDocumentType; + /** + * An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn. The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root. + */ + ResourceOwner?: ResourceNameType; + /** + * The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal. + */ + CallerArn?: ResourceNameType; + /** + * A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied. + */ + ContextEntries?: ContextEntryListType; + /** + * Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation. Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the Amazon EC2 User Guide. EC2-Classic-InstanceStore instance, image, security-group EC2-Classic-EBS instance, image, security-group, volume EC2-VPC-InstanceStore instance, image, security-group, network-interface EC2-VPC-InstanceStore-Subnet instance, image, security-group, network-interface, subnet EC2-VPC-EBS instance, image, security-group, network-interface, volume EC2-VPC-EBS-Subnet instance, image, security-group, network-interface, subnet, volume + */ + ResourceHandlingOption?: ResourceHandlingOptionType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + } + export interface SimulatePolicyResponse { + /** + * The results of the simulation. + */ + EvaluationResults?: EvaluationResultsListType; + /** + * A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + */ + IsTruncated?: booleanType; + /** + * When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + */ + Marker?: responseMarkerType; + } + export interface SimulatePrincipalPolicyRequest { + /** + * The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + PolicySourceArn: arnType; + /** + * An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyInputList?: SimulationPolicyListType; + /** + * A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser. + */ + ActionNames: ActionNameListType; + /** + * A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + ResourceArns?: ResourceNameListType; + /** + * A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + ResourcePolicy?: policyDocumentType; + /** + * An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn. + */ + ResourceOwner?: ResourceNameType; + /** + * The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal. CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + CallerArn?: ResourceNameType; + /** + * A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied. + */ + ContextEntries?: ContextEntryListType; + /** + * Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation. Each of the EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the Amazon EC2 User Guide. EC2-Classic-InstanceStore instance, image, security group EC2-Classic-EBS instance, image, security group, volume EC2-VPC-InstanceStore instance, image, security group, network interface EC2-VPC-InstanceStore-Subnet instance, image, security group, network interface, subnet EC2-VPC-EBS instance, image, security group, network interface, volume EC2-VPC-EBS-Subnet instance, image, security group, network interface, subnet, volume + */ + ResourceHandlingOption?: ResourceHandlingOptionType; + /** + * Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from. + */ + MaxItems?: maxItemsType; + /** + * Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + */ + Marker?: markerType; + } + export type SimulationPolicyListType = policyDocumentType[]; + export interface Statement { + /** + * The identifier of the policy that was provided as an input. + */ + SourcePolicyId?: PolicyIdentifierType; + /** + * The type of the policy. + */ + SourcePolicyType?: PolicySourceType; + /** + * The row and column of the beginning of the Statement in an IAM policy. + */ + StartPosition?: Position; + /** + * The row and column of the end of a Statement in an IAM policy. + */ + EndPosition?: Position; + } + export type StatementListType = Statement[]; + export interface Tag { + /** + * The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices. + */ + Key: tagKeyType; + /** + * The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values. AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. + */ + Value: tagValueType; + } + export interface TagRoleRequest { + /** + * The name of the role that you want to add tags to. This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The list of tags that you want to attach to the role. Each tag consists of a key name and an associated value. You can specify this with a JSON string. + */ + Tags: tagListType; + } + export interface TagUserRequest { + /** + * The name of the user that you want to add tags to. This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@- + */ + UserName: existingUserNameType; + /** + * The list of tags that you want to attach to the user. Each tag consists of a key name and an associated value. + */ + Tags: tagListType; + } + export interface UntagRoleRequest { + /** + * The name of the IAM role from which you want to remove tags. This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role. + */ + TagKeys: tagKeyListType; + } + export interface UntagUserRequest { + /** + * The name of the IAM user from which you want to remove tags. This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@- + */ + UserName: existingUserNameType; + /** + * A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user. + */ + TagKeys: tagKeyListType; + } + export interface UpdateAccessKeyRequest { + /** + * The name of the user whose key you want to update. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * The access key ID of the secret access key you want to update. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + AccessKeyId: accessKeyIdType; + /** + * The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used. + */ + Status: statusType; + } + export interface UpdateAccountPasswordPolicyRequest { + /** + * The minimum number of characters allowed in an IAM user password. If you do not specify a value for this parameter, then the operation uses the default value of 6. + */ + MinimumPasswordLength?: minimumPasswordLengthType; + /** + * Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character. + */ + RequireSymbols?: booleanType; + /** + * Specifies whether IAM user passwords must contain at least one numeric character (0 to 9). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character. + */ + RequireNumbers?: booleanType; + /** + * Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character. + */ + RequireUppercaseCharacters?: booleanType; + /** + * Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character. + */ + RequireLowercaseCharacters?: booleanType; + /** + * Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the IAM User Guide. If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password. + */ + AllowUsersToChangePassword?: booleanType; + /** + * The number of days that an IAM user password is valid. If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire. + */ + MaxPasswordAge?: maxPasswordAgeType; + /** + * Specifies the number of previous passwords that IAM users are prevented from reusing. If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords. + */ + PasswordReusePrevention?: passwordReusePreventionType; + /** + * Prevents IAM users from setting a new password after their password has expired. The IAM user cannot be accessed until an administrator resets the password. If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user. + */ + HardExpiry?: booleanObjectType; + } + export interface UpdateAssumeRolePolicyRequest { + /** + * The name of the role to update with the new policy. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + RoleName: roleNameType; + /** + * The policy that grants an entity permission to assume the role. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PolicyDocument: policyDocumentType; + } + export interface UpdateGroupRequest { + /** + * Name of the IAM group to update. If you're changing the name of the group, this is the original name. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + GroupName: groupNameType; + /** + * New path for the IAM group. Only include this if changing the group's path. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + NewPath?: pathType; + /** + * New name for the IAM group. Only include this if changing the group's name. IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource". + */ + NewGroupName?: groupNameType; + } + export interface UpdateLoginProfileRequest { + /** + * The name of the user whose password you want to update. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The new password for the specified IAM user. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see UpdateAccountPasswordPolicy. + */ + Password?: passwordType; + /** + * Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in. + */ + PasswordResetRequired?: booleanObjectType; + } + export interface UpdateOpenIDConnectProviderThumbprintRequest { + /** + * The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + OpenIDConnectProviderArn: arnType; + /** + * A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider. + */ + ThumbprintList: thumbprintListType; + } + export interface UpdateRoleDescriptionRequest { + /** + * The name of the role that you want to modify. + */ + RoleName: roleNameType; + /** + * The new description that you want to apply to the specified role. + */ + Description: roleDescriptionType; + } + export interface UpdateRoleDescriptionResponse { + /** + * A structure that contains details about the modified role. + */ + Role?: Role; + } + export interface UpdateRoleRequest { + /** + * The name of the role that you want to modify. + */ + RoleName: roleNameType; + /** + * The new description that you want to apply to the specified role. + */ + Description?: roleDescriptionType; + /** + * The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. + */ + MaxSessionDuration?: roleMaxSessionDurationType; + } + export interface UpdateRoleResponse { + } + export interface UpdateSAMLProviderRequest { + /** + * An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. + */ + SAMLMetadataDocument: SAMLMetadataDocumentType; + /** + * The Amazon Resource Name (ARN) of the SAML provider to update. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + SAMLProviderArn: arnType; + } + export interface UpdateSAMLProviderResponse { + /** + * The Amazon Resource Name (ARN) of the SAML provider that was updated. + */ + SAMLProviderArn?: arnType; + } + export interface UpdateSSHPublicKeyRequest { + /** + * The name of the IAM user associated with the SSH public key. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The unique identifier for the SSH public key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + SSHPublicKeyId: publicKeyIdType; + /** + * The status to assign to the SSH public key. Active means that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used. + */ + Status: statusType; + } + export interface UpdateServerCertificateRequest { + /** + * The name of the server certificate that you want to update. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + ServerCertificateName: serverCertificateNameType; + /** + * The new path for the server certificate. Include this only if you are updating the server certificate's path. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + NewPath?: pathType; + /** + * The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + NewServerCertificateName?: serverCertificateNameType; + } + export interface UpdateServiceSpecificCredentialRequest { + /** + * The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: userNameType; + /** + * The unique identifier of the service-specific credential. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + ServiceSpecificCredentialId: serviceSpecificCredentialId; + /** + * The status to be assigned to the service-specific credential. + */ + Status: statusType; + } + export interface UpdateSigningCertificateRequest { + /** + * The name of the IAM user the signing certificate belongs to. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * The ID of the signing certificate you want to update. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit. + */ + CertificateId: certificateIdType; + /** + * The status you want to assign to the certificate. Active means that the certificate can be used for API calls to AWS Inactive means that the certificate cannot be used. + */ + Status: statusType; + } + export interface UpdateUserRequest { + /** + * Name of the user to update. If you're changing the name of the user, this is the original user name. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: existingUserNameType; + /** + * New path for the IAM user. Include this parameter only if you're changing the user's path. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + */ + NewPath?: pathType; + /** + * New name for the user. Include this parameter only if you're changing the user's name. IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource". + */ + NewUserName?: userNameType; + } + export interface UploadSSHPublicKeyRequest { + /** + * The name of the IAM user to associate the SSH public key with. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName: userNameType; + /** + * The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + SSHPublicKeyBody: publicKeyMaterialType; + } + export interface UploadSSHPublicKeyResponse { + /** + * Contains information about the SSH public key. + */ + SSHPublicKey?: SSHPublicKey; + } + export interface UploadServerCertificateRequest { + /** + * The path for the server certificate. For more information about paths, see IAM Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/). + */ + Path?: pathType; + /** + * The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + ServerCertificateName: serverCertificateNameType; + /** + * The contents of the public key certificate in PEM-encoded format. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + CertificateBody: certificateBodyType; + /** + * The contents of the private key in PEM-encoded format. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + PrivateKey: privateKeyType; + /** + * The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + CertificateChain?: certificateChainType; + } + export interface UploadServerCertificateResponse { + /** + * The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key. + */ + ServerCertificateMetadata?: ServerCertificateMetadata; + } + export interface UploadSigningCertificateRequest { + /** + * The name of the user the signing certificate is for. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + */ + UserName?: existingUserNameType; + /** + * The contents of the signing certificate. The regex pattern used to validate this parameter is a string of characters consisting of the following: Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D) + */ + CertificateBody: certificateBodyType; + } + export interface UploadSigningCertificateResponse { + /** + * Information about the certificate. + */ + Certificate: SigningCertificate; + } + export interface User { + /** + * The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path: pathType; + /** + * The friendly name identifying the user. + */ + UserName: userNameType; + /** + * The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + UserId: idType; + /** + * The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide. + */ + Arn: arnType; + /** + * The date and time, in ISO 8601 date-time format, when the user was created. + */ + CreateDate: dateType; + /** + * The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because: The user never had a password. A password exists but has not been used since IAM started tracking this information on October 20, 2014. A null valuedoes not mean that the user never had a password. Also, if the user does not currently have a password, but had one in the past, then this field contains the date and time the most recent password was used. This value is returned only in the GetUser and ListUsers operations. + */ + PasswordLastUsed?: dateType; + /** + * The ARN of the policy used to set the permissions boundary for the user. For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide. + */ + PermissionsBoundary?: AttachedPermissionsBoundary; + /** + * A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + Tags?: tagListType; + } + export interface UserDetail { + /** + * The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide. + */ + Path?: pathType; + /** + * The friendly name identifying the user. + */ + UserName?: userNameType; + /** + * The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide. + */ + UserId?: idType; + Arn?: arnType; + /** + * The date and time, in ISO 8601 date-time format, when the user was created. + */ + CreateDate?: dateType; + /** + * A list of the inline policies embedded in the user. + */ + UserPolicyList?: policyDetailListType; + /** + * A list of IAM groups that the user is in. + */ + GroupList?: groupNameListType; + /** + * A list of the managed policies attached to the user. + */ + AttachedManagedPolicies?: attachedPoliciesListType; + /** + * The ARN of the policy used to set the permissions boundary for the user. For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide. + */ + PermissionsBoundary?: AttachedPermissionsBoundary; + /** + * A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide. + */ + Tags?: tagListType; + } + export interface VirtualMFADevice { + /** + * The serial number associated with VirtualMFADevice. + */ + SerialNumber: serialNumberType; + /** + * The base32 seed defined as specified in RFC3548. The Base32StringSeed is base64-encoded. + */ + Base32StringSeed?: BootstrapDatum; + /** + * A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments. AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in base32 format. The Base32String value is base64-encoded. + */ + QRCodePNG?: BootstrapDatum; + /** + * The IAM user associated with this virtual MFA device. + */ + User?: User; + /** + * The date and time on which the virtual MFA device was enabled. + */ + EnableDate?: dateType; + } + export type accessKeyIdType = string; + export type accessKeyMetadataListType = AccessKeyMetadata[]; + export type accessKeySecretType = string; + export type accountAliasListType = accountAliasType[]; + export type accountAliasType = string; + export type arnType = string; + export type assignmentStatusType = "Assigned"|"Unassigned"|"Any"|string; + export type attachedPoliciesListType = AttachedPolicy[]; + export type attachmentCountType = number; + export type authenticationCodeType = string; + export type booleanObjectType = boolean; + export type booleanType = boolean; + export type certificateBodyType = string; + export type certificateChainType = string; + export type certificateIdType = string; + export type certificateListType = SigningCertificate[]; + export type clientIDListType = clientIDType[]; + export type clientIDType = string; + export type customSuffixType = string; + export type dateType = Date; + export type encodingType = "SSH"|"PEM"|string; + export type entityDetailsListType = EntityDetails[]; + export type entityListType = EntityType[]; + export type entityNameType = string; + export type existingUserNameType = string; + export type globalEndpointTokenVersion = "v1Token"|"v2Token"|string; + export type groupDetailListType = GroupDetail[]; + export type groupListType = Group[]; + export type groupNameListType = groupNameType[]; + export type groupNameType = string; + export type idType = string; + export type instanceProfileListType = InstanceProfile[]; + export type instanceProfileNameType = string; + export type integerType = number; + export type jobIDType = string; + export type jobStatusType = "IN_PROGRESS"|"COMPLETED"|"FAILED"|string; + export type listPolicyGrantingServiceAccessResponseListType = ListPoliciesGrantingServiceAccessEntry[]; + export type markerType = string; + export type maxItemsType = number; + export type maxPasswordAgeType = number; + export type mfaDeviceListType = MFADevice[]; + export type minimumPasswordLengthType = number; + export type passwordReusePreventionType = number; + export type passwordType = string; + export type pathPrefixType = string; + export type pathType = string; + export type policyDescriptionType = string; + export type policyDetailListType = PolicyDetail[]; + export type policyDocumentType = string; + export type policyDocumentVersionListType = PolicyVersion[]; + export type policyGrantingServiceAccessListType = PolicyGrantingServiceAccess[]; + export type policyListType = Policy[]; + export type policyNameListType = policyNameType[]; + export type policyNameType = string; + export type policyOwnerEntityType = "USER"|"ROLE"|"GROUP"|string; + export type policyPathType = string; + export type policyScopeType = "All"|"AWS"|"Local"|string; + export type policyType = "INLINE"|"MANAGED"|string; + export type policyVersionIdType = string; + export type privateKeyType = string; + export type publicKeyFingerprintType = string; + export type publicKeyIdType = string; + export type publicKeyMaterialType = string; + export type responseMarkerType = string; + export type roleDescriptionType = string; + export type roleDetailListType = RoleDetail[]; + export type roleListType = Role[]; + export type roleMaxSessionDurationType = number; + export type roleNameType = string; + export type serialNumberType = string; + export type serverCertificateMetadataListType = ServerCertificateMetadata[]; + export type serverCertificateNameType = string; + export type serviceName = string; + export type serviceNameType = string; + export type serviceNamespaceListType = serviceNamespaceType[]; + export type serviceNamespaceType = string; + export type servicePassword = string; + export type serviceSpecificCredentialId = string; + export type serviceUserName = string; + export type statusType = "Active"|"Inactive"|string; + export type stringType = string; + export type summaryKeyType = "Users"|"UsersQuota"|"Groups"|"GroupsQuota"|"ServerCertificates"|"ServerCertificatesQuota"|"UserPolicySizeQuota"|"GroupPolicySizeQuota"|"GroupsPerUserQuota"|"SigningCertificatesPerUserQuota"|"AccessKeysPerUserQuota"|"MFADevices"|"MFADevicesInUse"|"AccountMFAEnabled"|"AccountAccessKeysPresent"|"AccountSigningCertificatesPresent"|"AttachedPoliciesPerGroupQuota"|"AttachedPoliciesPerRoleQuota"|"AttachedPoliciesPerUserQuota"|"Policies"|"PoliciesQuota"|"PolicySizeQuota"|"PolicyVersionsInUse"|"PolicyVersionsInUseQuota"|"VersionsPerPolicyQuota"|"GlobalEndpointTokenVersion"|string; + export type summaryMapType = {[key: string]: summaryValueType}; + export type summaryValueType = number; + export type tagKeyListType = tagKeyType[]; + export type tagKeyType = string; + export type tagListType = Tag[]; + export type tagValueType = string; + export type thumbprintListType = thumbprintType[]; + export type thumbprintType = string; + export type userDetailListType = UserDetail[]; + export type userListType = User[]; + export type userNameType = string; + export type virtualMFADeviceListType = VirtualMFADevice[]; + export type virtualMFADeviceName = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2010-05-08"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the IAM client. + */ + export import Types = IAM; +} +export = IAM; diff --git a/node_modules/aws-sdk/clients/iam.js b/node_modules/aws-sdk/clients/iam.js new file mode 100644 index 0000000..ee268cd --- /dev/null +++ b/node_modules/aws-sdk/clients/iam.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['iam'] = {}; +AWS.IAM = Service.defineService('iam', ['2010-05-08']); +Object.defineProperty(apiLoader.services['iam'], '2010-05-08', { + get: function get() { + var model = require('../apis/iam-2010-05-08.min.json'); + model.paginators = require('../apis/iam-2010-05-08.paginators.json').pagination; + model.waiters = require('../apis/iam-2010-05-08.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.IAM; diff --git a/node_modules/aws-sdk/clients/importexport.d.ts b/node_modules/aws-sdk/clients/importexport.d.ts new file mode 100644 index 0000000..2cc0214 --- /dev/null +++ b/node_modules/aws-sdk/clients/importexport.d.ts @@ -0,0 +1,214 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ImportExport extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ImportExport.Types.ClientConfiguration) + config: Config & ImportExport.Types.ClientConfiguration; + /** + * This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete. + */ + cancelJob(params: ImportExport.Types.CancelJobInput, callback?: (err: AWSError, data: ImportExport.Types.CancelJobOutput) => void): Request; + /** + * This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete. + */ + cancelJob(callback?: (err: AWSError, data: ImportExport.Types.CancelJobOutput) => void): Request; + /** + * This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device. + */ + createJob(params: ImportExport.Types.CreateJobInput, callback?: (err: AWSError, data: ImportExport.Types.CreateJobOutput) => void): Request; + /** + * This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device. + */ + createJob(callback?: (err: AWSError, data: ImportExport.Types.CreateJobOutput) => void): Request; + /** + * This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing. + */ + getShippingLabel(params: ImportExport.Types.GetShippingLabelInput, callback?: (err: AWSError, data: ImportExport.Types.GetShippingLabelOutput) => void): Request; + /** + * This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing. + */ + getShippingLabel(callback?: (err: AWSError, data: ImportExport.Types.GetShippingLabelOutput) => void): Request; + /** + * This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. + */ + getStatus(params: ImportExport.Types.GetStatusInput, callback?: (err: AWSError, data: ImportExport.Types.GetStatusOutput) => void): Request; + /** + * This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. + */ + getStatus(callback?: (err: AWSError, data: ImportExport.Types.GetStatusOutput) => void): Request; + /** + * This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. + */ + listJobs(params: ImportExport.Types.ListJobsInput, callback?: (err: AWSError, data: ImportExport.Types.ListJobsOutput) => void): Request; + /** + * This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. + */ + listJobs(callback?: (err: AWSError, data: ImportExport.Types.ListJobsOutput) => void): Request; + /** + * You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own. + */ + updateJob(params: ImportExport.Types.UpdateJobInput, callback?: (err: AWSError, data: ImportExport.Types.UpdateJobOutput) => void): Request; + /** + * You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own. + */ + updateJob(callback?: (err: AWSError, data: ImportExport.Types.UpdateJobOutput) => void): Request; +} +declare namespace ImportExport { + export type APIVersion = string; + export interface Artifact { + Description?: Description; + URL?: URL; + } + export type ArtifactList = Artifact[]; + export interface CancelJobInput { + JobId: JobId; + APIVersion?: APIVersion; + } + export interface CancelJobOutput { + Success?: Success; + } + export type Carrier = string; + export interface CreateJobInput { + JobType: JobType; + Manifest: Manifest; + ManifestAddendum?: ManifestAddendum; + ValidateOnly: ValidateOnly; + APIVersion?: APIVersion; + } + export interface CreateJobOutput { + JobId?: JobId; + JobType?: JobType; + Signature?: Signature; + SignatureFileContents?: SignatureFileContents; + WarningMessage?: WarningMessage; + ArtifactList?: ArtifactList; + } + export type CreationDate = Date; + export type CurrentManifest = string; + export type Description = string; + export type ErrorCount = number; + export type GenericString = string; + export interface GetShippingLabelInput { + jobIds: JobIdList; + name?: name; + company?: company; + phoneNumber?: phoneNumber; + country?: country; + stateOrProvince?: stateOrProvince; + city?: city; + postalCode?: postalCode; + street1?: street1; + street2?: street2; + street3?: street3; + APIVersion?: APIVersion; + } + export interface GetShippingLabelOutput { + ShippingLabelURL?: GenericString; + Warning?: GenericString; + } + export interface GetStatusInput { + JobId: JobId; + APIVersion?: APIVersion; + } + export interface GetStatusOutput { + JobId?: JobId; + JobType?: JobType; + LocationCode?: LocationCode; + LocationMessage?: LocationMessage; + ProgressCode?: ProgressCode; + ProgressMessage?: ProgressMessage; + Carrier?: Carrier; + TrackingNumber?: TrackingNumber; + LogBucket?: LogBucket; + LogKey?: LogKey; + ErrorCount?: ErrorCount; + Signature?: Signature; + SignatureFileContents?: Signature; + CurrentManifest?: CurrentManifest; + CreationDate?: CreationDate; + ArtifactList?: ArtifactList; + } + export type IsCanceled = boolean; + export type IsTruncated = boolean; + export interface Job { + JobId?: JobId; + CreationDate?: CreationDate; + IsCanceled?: IsCanceled; + JobType?: JobType; + } + export type JobId = string; + export type JobIdList = GenericString[]; + export type JobType = "Import"|"Export"|string; + export type JobsList = Job[]; + export interface ListJobsInput { + MaxJobs?: MaxJobs; + Marker?: Marker; + APIVersion?: APIVersion; + } + export interface ListJobsOutput { + Jobs?: JobsList; + IsTruncated?: IsTruncated; + } + export type LocationCode = string; + export type LocationMessage = string; + export type LogBucket = string; + export type LogKey = string; + export type Manifest = string; + export type ManifestAddendum = string; + export type Marker = string; + export type MaxJobs = number; + export type ProgressCode = string; + export type ProgressMessage = string; + export type Signature = string; + export type SignatureFileContents = string; + export type Success = boolean; + export type TrackingNumber = string; + export type URL = string; + export interface UpdateJobInput { + JobId: JobId; + Manifest: Manifest; + JobType: JobType; + ValidateOnly: ValidateOnly; + APIVersion?: APIVersion; + } + export interface UpdateJobOutput { + Success?: Success; + WarningMessage?: WarningMessage; + ArtifactList?: ArtifactList; + } + export type ValidateOnly = boolean; + export type WarningMessage = string; + export type city = string; + export type company = string; + export type country = string; + export type name = string; + export type phoneNumber = string; + export type postalCode = string; + export type stateOrProvince = string; + export type street1 = string; + export type street2 = string; + export type street3 = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2010-06-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ImportExport client. + */ + export import Types = ImportExport; +} +export = ImportExport; diff --git a/node_modules/aws-sdk/clients/importexport.js b/node_modules/aws-sdk/clients/importexport.js new file mode 100644 index 0000000..b9b054d --- /dev/null +++ b/node_modules/aws-sdk/clients/importexport.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['importexport'] = {}; +AWS.ImportExport = Service.defineService('importexport', ['2010-06-01']); +Object.defineProperty(apiLoader.services['importexport'], '2010-06-01', { + get: function get() { + var model = require('../apis/importexport-2010-06-01.min.json'); + model.paginators = require('../apis/importexport-2010-06-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ImportExport; diff --git a/node_modules/aws-sdk/clients/inspector.d.ts b/node_modules/aws-sdk/clients/inspector.d.ts new file mode 100644 index 0000000..39ac66e --- /dev/null +++ b/node_modules/aws-sdk/clients/inspector.d.ts @@ -0,0 +1,1766 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Inspector extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Inspector.Types.ClientConfiguration) + config: Config & Inspector.Types.ClientConfiguration; + /** + * Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings. + */ + addAttributesToFindings(params: Inspector.Types.AddAttributesToFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.AddAttributesToFindingsResponse) => void): Request; + /** + * Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings. + */ + addAttributesToFindings(callback?: (err: AWSError, data: Inspector.Types.AddAttributesToFindingsResponse) => void): Request; + /** + * Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets. + */ + createAssessmentTarget(params: Inspector.Types.CreateAssessmentTargetRequest, callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTargetResponse) => void): Request; + /** + * Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets. + */ + createAssessmentTarget(callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTargetResponse) => void): Request; + /** + * Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. + */ + createAssessmentTemplate(params: Inspector.Types.CreateAssessmentTemplateRequest, callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTemplateResponse) => void): Request; + /** + * Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. + */ + createAssessmentTemplate(callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTemplateResponse) => void): Request; + /** + * Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment. + */ + createExclusionsPreview(params: Inspector.Types.CreateExclusionsPreviewRequest, callback?: (err: AWSError, data: Inspector.Types.CreateExclusionsPreviewResponse) => void): Request; + /** + * Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment. + */ + createExclusionsPreview(callback?: (err: AWSError, data: Inspector.Types.CreateExclusionsPreviewResponse) => void): Request; + /** + * Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget. + */ + createResourceGroup(params: Inspector.Types.CreateResourceGroupRequest, callback?: (err: AWSError, data: Inspector.Types.CreateResourceGroupResponse) => void): Request; + /** + * Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget. + */ + createResourceGroup(callback?: (err: AWSError, data: Inspector.Types.CreateResourceGroupResponse) => void): Request; + /** + * Deletes the assessment run that is specified by the ARN of the assessment run. + */ + deleteAssessmentRun(params: Inspector.Types.DeleteAssessmentRunRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the assessment run that is specified by the ARN of the assessment run. + */ + deleteAssessmentRun(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the assessment target that is specified by the ARN of the assessment target. + */ + deleteAssessmentTarget(params: Inspector.Types.DeleteAssessmentTargetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the assessment target that is specified by the ARN of the assessment target. + */ + deleteAssessmentTarget(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the assessment template that is specified by the ARN of the assessment template. + */ + deleteAssessmentTemplate(params: Inspector.Types.DeleteAssessmentTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the assessment template that is specified by the ARN of the assessment template. + */ + deleteAssessmentTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describes the assessment runs that are specified by the ARNs of the assessment runs. + */ + describeAssessmentRuns(params: Inspector.Types.DescribeAssessmentRunsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentRunsResponse) => void): Request; + /** + * Describes the assessment runs that are specified by the ARNs of the assessment runs. + */ + describeAssessmentRuns(callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentRunsResponse) => void): Request; + /** + * Describes the assessment targets that are specified by the ARNs of the assessment targets. + */ + describeAssessmentTargets(params: Inspector.Types.DescribeAssessmentTargetsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTargetsResponse) => void): Request; + /** + * Describes the assessment targets that are specified by the ARNs of the assessment targets. + */ + describeAssessmentTargets(callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTargetsResponse) => void): Request; + /** + * Describes the assessment templates that are specified by the ARNs of the assessment templates. + */ + describeAssessmentTemplates(params: Inspector.Types.DescribeAssessmentTemplatesRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTemplatesResponse) => void): Request; + /** + * Describes the assessment templates that are specified by the ARNs of the assessment templates. + */ + describeAssessmentTemplates(callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTemplatesResponse) => void): Request; + /** + * Describes the IAM role that enables Amazon Inspector to access your AWS account. + */ + describeCrossAccountAccessRole(callback?: (err: AWSError, data: Inspector.Types.DescribeCrossAccountAccessRoleResponse) => void): Request; + /** + * Describes the exclusions that are specified by the exclusions' ARNs. + */ + describeExclusions(params: Inspector.Types.DescribeExclusionsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeExclusionsResponse) => void): Request; + /** + * Describes the exclusions that are specified by the exclusions' ARNs. + */ + describeExclusions(callback?: (err: AWSError, data: Inspector.Types.DescribeExclusionsResponse) => void): Request; + /** + * Describes the findings that are specified by the ARNs of the findings. + */ + describeFindings(params: Inspector.Types.DescribeFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeFindingsResponse) => void): Request; + /** + * Describes the findings that are specified by the ARNs of the findings. + */ + describeFindings(callback?: (err: AWSError, data: Inspector.Types.DescribeFindingsResponse) => void): Request; + /** + * Describes the resource groups that are specified by the ARNs of the resource groups. + */ + describeResourceGroups(params: Inspector.Types.DescribeResourceGroupsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeResourceGroupsResponse) => void): Request; + /** + * Describes the resource groups that are specified by the ARNs of the resource groups. + */ + describeResourceGroups(callback?: (err: AWSError, data: Inspector.Types.DescribeResourceGroupsResponse) => void): Request; + /** + * Describes the rules packages that are specified by the ARNs of the rules packages. + */ + describeRulesPackages(params: Inspector.Types.DescribeRulesPackagesRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeRulesPackagesResponse) => void): Request; + /** + * Describes the rules packages that are specified by the ARNs of the rules packages. + */ + describeRulesPackages(callback?: (err: AWSError, data: Inspector.Types.DescribeRulesPackagesResponse) => void): Request; + /** + * Produces an assessment report that includes detailed and comprehensive results of a specified assessment run. + */ + getAssessmentReport(params: Inspector.Types.GetAssessmentReportRequest, callback?: (err: AWSError, data: Inspector.Types.GetAssessmentReportResponse) => void): Request; + /** + * Produces an assessment report that includes detailed and comprehensive results of a specified assessment run. + */ + getAssessmentReport(callback?: (err: AWSError, data: Inspector.Types.GetAssessmentReportResponse) => void): Request; + /** + * Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API. + */ + getExclusionsPreview(params: Inspector.Types.GetExclusionsPreviewRequest, callback?: (err: AWSError, data: Inspector.Types.GetExclusionsPreviewResponse) => void): Request; + /** + * Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API. + */ + getExclusionsPreview(callback?: (err: AWSError, data: Inspector.Types.GetExclusionsPreviewResponse) => void): Request; + /** + * Information about the data that is collected for the specified assessment run. + */ + getTelemetryMetadata(params: Inspector.Types.GetTelemetryMetadataRequest, callback?: (err: AWSError, data: Inspector.Types.GetTelemetryMetadataResponse) => void): Request; + /** + * Information about the data that is collected for the specified assessment run. + */ + getTelemetryMetadata(callback?: (err: AWSError, data: Inspector.Types.GetTelemetryMetadataResponse) => void): Request; + /** + * Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs. + */ + listAssessmentRunAgents(params: Inspector.Types.ListAssessmentRunAgentsRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunAgentsResponse) => void): Request; + /** + * Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs. + */ + listAssessmentRunAgents(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunAgentsResponse) => void): Request; + /** + * Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates. + */ + listAssessmentRuns(params: Inspector.Types.ListAssessmentRunsRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunsResponse) => void): Request; + /** + * Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates. + */ + listAssessmentRuns(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunsResponse) => void): Request; + /** + * Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets. + */ + listAssessmentTargets(params: Inspector.Types.ListAssessmentTargetsRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTargetsResponse) => void): Request; + /** + * Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets. + */ + listAssessmentTargets(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTargetsResponse) => void): Request; + /** + * Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets. + */ + listAssessmentTemplates(params: Inspector.Types.ListAssessmentTemplatesRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTemplatesResponse) => void): Request; + /** + * Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets. + */ + listAssessmentTemplates(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTemplatesResponse) => void): Request; + /** + * Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent. + */ + listEventSubscriptions(params: Inspector.Types.ListEventSubscriptionsRequest, callback?: (err: AWSError, data: Inspector.Types.ListEventSubscriptionsResponse) => void): Request; + /** + * Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent. + */ + listEventSubscriptions(callback?: (err: AWSError, data: Inspector.Types.ListEventSubscriptionsResponse) => void): Request; + /** + * List exclusions that are generated by the assessment run. + */ + listExclusions(params: Inspector.Types.ListExclusionsRequest, callback?: (err: AWSError, data: Inspector.Types.ListExclusionsResponse) => void): Request; + /** + * List exclusions that are generated by the assessment run. + */ + listExclusions(callback?: (err: AWSError, data: Inspector.Types.ListExclusionsResponse) => void): Request; + /** + * Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs. + */ + listFindings(params: Inspector.Types.ListFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.ListFindingsResponse) => void): Request; + /** + * Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs. + */ + listFindings(callback?: (err: AWSError, data: Inspector.Types.ListFindingsResponse) => void): Request; + /** + * Lists all available Amazon Inspector rules packages. + */ + listRulesPackages(params: Inspector.Types.ListRulesPackagesRequest, callback?: (err: AWSError, data: Inspector.Types.ListRulesPackagesResponse) => void): Request; + /** + * Lists all available Amazon Inspector rules packages. + */ + listRulesPackages(callback?: (err: AWSError, data: Inspector.Types.ListRulesPackagesResponse) => void): Request; + /** + * Lists all tags associated with an assessment template. + */ + listTagsForResource(params: Inspector.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Inspector.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists all tags associated with an assessment template. + */ + listTagsForResource(callback?: (err: AWSError, data: Inspector.Types.ListTagsForResourceResponse) => void): Request; + /** + * Previews the agents installed on the EC2 instances that are part of the specified assessment target. + */ + previewAgents(params: Inspector.Types.PreviewAgentsRequest, callback?: (err: AWSError, data: Inspector.Types.PreviewAgentsResponse) => void): Request; + /** + * Previews the agents installed on the EC2 instances that are part of the specified assessment target. + */ + previewAgents(callback?: (err: AWSError, data: Inspector.Types.PreviewAgentsResponse) => void): Request; + /** + * Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments. + */ + registerCrossAccountAccessRole(params: Inspector.Types.RegisterCrossAccountAccessRoleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments. + */ + registerCrossAccountAccessRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists. + */ + removeAttributesFromFindings(params: Inspector.Types.RemoveAttributesFromFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.RemoveAttributesFromFindingsResponse) => void): Request; + /** + * Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists. + */ + removeAttributesFromFindings(callback?: (err: AWSError, data: Inspector.Types.RemoveAttributesFromFindingsResponse) => void): Request; + /** + * Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template. + */ + setTagsForResource(params: Inspector.Types.SetTagsForResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template. + */ + setTagsForResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account. + */ + startAssessmentRun(params: Inspector.Types.StartAssessmentRunRequest, callback?: (err: AWSError, data: Inspector.Types.StartAssessmentRunResponse) => void): Request; + /** + * Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account. + */ + startAssessmentRun(callback?: (err: AWSError, data: Inspector.Types.StartAssessmentRunResponse) => void): Request; + /** + * Stops the assessment run that is specified by the ARN of the assessment run. + */ + stopAssessmentRun(params: Inspector.Types.StopAssessmentRunRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops the assessment run that is specified by the ARN of the assessment run. + */ + stopAssessmentRun(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. + */ + subscribeToEvent(params: Inspector.Types.SubscribeToEventRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. + */ + subscribeToEvent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. + */ + unsubscribeFromEvent(params: Inspector.Types.UnsubscribeFromEventRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. + */ + unsubscribeFromEvent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the assessment target that is specified by the ARN of the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. + */ + updateAssessmentTarget(params: Inspector.Types.UpdateAssessmentTargetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the assessment target that is specified by the ARN of the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. + */ + updateAssessmentTarget(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace Inspector { + export interface AddAttributesToFindingsRequest { + /** + * The ARNs that specify the findings that you want to assign attributes to. + */ + findingArns: AddRemoveAttributesFindingArnList; + /** + * The array of attributes that you want to assign to specified findings. + */ + attributes: UserAttributeList; + } + export interface AddAttributesToFindingsResponse { + /** + * Attribute details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export type AddRemoveAttributesFindingArnList = Arn[]; + export interface AgentFilter { + /** + * The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY. + */ + agentHealths: AgentHealthList; + /** + * The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN. + */ + agentHealthCodes: AgentHealthCodeList; + } + export type AgentHealth = "HEALTHY"|"UNHEALTHY"|"UNKNOWN"|string; + export type AgentHealthCode = "IDLE"|"RUNNING"|"SHUTDOWN"|"UNHEALTHY"|"THROTTLED"|"UNKNOWN"|string; + export type AgentHealthCodeList = AgentHealthCode[]; + export type AgentHealthList = AgentHealth[]; + export type AgentId = string; + export type AgentIdList = AgentId[]; + export interface AgentPreview { + /** + * The hostname of the EC2 instance on which the Amazon Inspector Agent is installed. + */ + hostname?: Hostname; + /** + * The ID of the EC2 instance where the agent is installed. + */ + agentId: AgentId; + /** + * The Auto Scaling group for the EC2 instance where the agent is installed. + */ + autoScalingGroup?: AutoScalingGroup; + /** + * The health status of the Amazon Inspector Agent. + */ + agentHealth?: AgentHealth; + /** + * The version of the Amazon Inspector Agent. + */ + agentVersion?: AgentVersion; + /** + * The operating system running on the EC2 instance on which the Amazon Inspector Agent is installed. + */ + operatingSystem?: OperatingSystem; + /** + * The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Agent is installed. + */ + kernelVersion?: KernelVersion; + /** + * The IP address of the EC2 instance on which the Amazon Inspector Agent is installed. + */ + ipv4Address?: Ipv4Address; + } + export type AgentPreviewList = AgentPreview[]; + export type AgentVersion = string; + export type AmiId = string; + export type Arn = string; + export type ArnCount = number; + export type AssessmentRulesPackageArnList = Arn[]; + export interface AssessmentRun { + /** + * The ARN of the assessment run. + */ + arn: Arn; + /** + * The auto-generated name for the assessment run. + */ + name: AssessmentRunName; + /** + * The ARN of the assessment template that is associated with the assessment run. + */ + assessmentTemplateArn: Arn; + /** + * The state of the assessment run. + */ + state: AssessmentRunState; + /** + * The duration of the assessment run. + */ + durationInSeconds: AssessmentRunDuration; + /** + * The rules packages selected for the assessment run. + */ + rulesPackageArns: AssessmentRulesPackageArnList; + /** + * The user-defined attributes that are assigned to every generated finding. + */ + userAttributesForFindings: UserAttributeList; + /** + * The time when StartAssessmentRun was called. + */ + createdAt: Timestamp; + /** + * The time when StartAssessmentRun was called. + */ + startedAt?: Timestamp; + /** + * The assessment run completion time that corresponds to the rules packages evaluation completion time or failure. + */ + completedAt?: Timestamp; + /** + * The last time when the assessment run's state changed. + */ + stateChangedAt: Timestamp; + /** + * A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed. + */ + dataCollected: Bool; + /** + * A list of the assessment run state changes. + */ + stateChanges: AssessmentRunStateChangeList; + /** + * A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once. + */ + notifications: AssessmentRunNotificationList; + /** + * Provides a total count of generated findings per severity. + */ + findingCounts: AssessmentRunFindingCounts; + } + export interface AssessmentRunAgent { + /** + * The AWS account of the EC2 instance where the agent is installed. + */ + agentId: AgentId; + /** + * The ARN of the assessment run that is associated with the agent. + */ + assessmentRunArn: Arn; + /** + * The current health state of the agent. + */ + agentHealth: AgentHealth; + /** + * The detailed health state of the agent. + */ + agentHealthCode: AgentHealthCode; + /** + * The description for the agent health code. + */ + agentHealthDetails?: Message; + /** + * The Auto Scaling group of the EC2 instance that is specified by the agent ID. + */ + autoScalingGroup?: AutoScalingGroup; + /** + * The Amazon Inspector application data metrics that are collected by the agent. + */ + telemetryMetadata: TelemetryMetadataList; + } + export type AssessmentRunAgentList = AssessmentRunAgent[]; + export type AssessmentRunDuration = number; + export interface AssessmentRunFilter { + /** + * For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type. + */ + namePattern?: NamePattern; + /** + * For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type. + */ + states?: AssessmentRunStateList; + /** + * For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun data type. + */ + durationRange?: DurationRange; + /** + * For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type. + */ + rulesPackageArns?: FilterRulesPackageArnList; + /** + * For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun data type. + */ + startTimeRange?: TimestampRange; + /** + * For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun data type. + */ + completionTimeRange?: TimestampRange; + /** + * For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type. + */ + stateChangeTimeRange?: TimestampRange; + } + export type AssessmentRunFindingCounts = {[key: string]: FindingCount}; + export type AssessmentRunList = AssessmentRun[]; + export type AssessmentRunName = string; + export interface AssessmentRunNotification { + /** + * The date of the notification. + */ + date: Timestamp; + /** + * The event for which a notification is sent. + */ + event: InspectorEvent; + /** + * The message included in the notification. + */ + message?: Message; + /** + * The Boolean value that specifies whether the notification represents an error. + */ + error: Bool; + /** + * The SNS topic to which the SNS notification is sent. + */ + snsTopicArn?: Arn; + /** + * The status code of the SNS notification. + */ + snsPublishStatusCode?: AssessmentRunNotificationSnsStatusCode; + } + export type AssessmentRunNotificationList = AssessmentRunNotification[]; + export type AssessmentRunNotificationSnsStatusCode = "SUCCESS"|"TOPIC_DOES_NOT_EXIST"|"ACCESS_DENIED"|"INTERNAL_ERROR"|string; + export type AssessmentRunState = "CREATED"|"START_DATA_COLLECTION_PENDING"|"START_DATA_COLLECTION_IN_PROGRESS"|"COLLECTING_DATA"|"STOP_DATA_COLLECTION_PENDING"|"DATA_COLLECTED"|"START_EVALUATING_RULES_PENDING"|"EVALUATING_RULES"|"FAILED"|"ERROR"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"CANCELED"|string; + export interface AssessmentRunStateChange { + /** + * The last time the assessment run state changed. + */ + stateChangedAt: Timestamp; + /** + * The assessment run state. + */ + state: AssessmentRunState; + } + export type AssessmentRunStateChangeList = AssessmentRunStateChange[]; + export type AssessmentRunStateList = AssessmentRunState[]; + export interface AssessmentTarget { + /** + * The ARN that specifies the Amazon Inspector assessment target. + */ + arn: Arn; + /** + * The name of the Amazon Inspector assessment target. + */ + name: AssessmentTargetName; + /** + * The ARN that specifies the resource group that is associated with the assessment target. + */ + resourceGroupArn?: Arn; + /** + * The time at which the assessment target is created. + */ + createdAt: Timestamp; + /** + * The time at which UpdateAssessmentTarget is called. + */ + updatedAt: Timestamp; + } + export interface AssessmentTargetFilter { + /** + * For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTargetName property of the AssessmentTarget data type. + */ + assessmentTargetNamePattern?: NamePattern; + } + export type AssessmentTargetList = AssessmentTarget[]; + export type AssessmentTargetName = string; + export interface AssessmentTemplate { + /** + * The ARN of the assessment template. + */ + arn: Arn; + /** + * The name of the assessment template. + */ + name: AssessmentTemplateName; + /** + * The ARN of the assessment target that corresponds to this assessment template. + */ + assessmentTargetArn: Arn; + /** + * The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day). + */ + durationInSeconds: AssessmentRunDuration; + /** + * The rules packages that are specified for this assessment template. + */ + rulesPackageArns: AssessmentTemplateRulesPackageArnList; + /** + * The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template. + */ + userAttributesForFindings: UserAttributeList; + /** + * The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greaterpa than zero. + */ + lastAssessmentRunArn?: Arn; + /** + * The number of existing assessment runs associated with this assessment template. This value can be zero or a positive integer. + */ + assessmentRunCount: ArnCount; + /** + * The time at which the assessment template is created. + */ + createdAt: Timestamp; + } + export interface AssessmentTemplateFilter { + /** + * For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTemplateName property of the AssessmentTemplate data type. + */ + namePattern?: NamePattern; + /** + * For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentTemplate data type. + */ + durationRange?: DurationRange; + /** + * For a record to match a filter, the values that are specified for this data type property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data type. + */ + rulesPackageArns?: FilterRulesPackageArnList; + } + export type AssessmentTemplateList = AssessmentTemplate[]; + export type AssessmentTemplateName = string; + export type AssessmentTemplateRulesPackageArnList = Arn[]; + export interface AssetAttributes { + /** + * The schema version of this data type. + */ + schemaVersion: NumericVersion; + /** + * The ID of the agent that is installed on the EC2 instance where the finding is generated. + */ + agentId?: AgentId; + /** + * The Auto Scaling group of the EC2 instance where the finding is generated. + */ + autoScalingGroup?: AutoScalingGroup; + /** + * The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where the finding is generated. + */ + amiId?: AmiId; + /** + * The hostname of the EC2 instance where the finding is generated. + */ + hostname?: Hostname; + /** + * The list of IP v4 addresses of the EC2 instance where the finding is generated. + */ + ipv4Addresses?: Ipv4AddressList; + /** + * The tags related to the EC2 instance where the finding is generated. + */ + tags?: Tags; + /** + * An array of the network interfaces interacting with the EC2 instance where the finding is generated. + */ + networkInterfaces?: NetworkInterfaces; + } + export type AssetType = "ec2-instance"|string; + export interface Attribute { + /** + * The attribute key. + */ + key: AttributeKey; + /** + * The value assigned to the attribute key. + */ + value?: AttributeValue; + } + export type AttributeKey = string; + export type AttributeList = Attribute[]; + export type AttributeValue = string; + export type AutoScalingGroup = string; + export type AutoScalingGroupList = AutoScalingGroup[]; + export type BatchDescribeArnList = Arn[]; + export type BatchDescribeExclusionsArnList = Arn[]; + export type Bool = boolean; + export interface CreateAssessmentTargetRequest { + /** + * The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account. + */ + assessmentTargetName: AssessmentTargetName; + /** + * The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. + */ + resourceGroupArn?: Arn; + } + export interface CreateAssessmentTargetResponse { + /** + * The ARN that specifies the assessment target that is created. + */ + assessmentTargetArn: Arn; + } + export interface CreateAssessmentTemplateRequest { + /** + * The ARN that specifies the assessment target for which you want to create the assessment template. + */ + assessmentTargetArn: Arn; + /** + * The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique. + */ + assessmentTemplateName: AssessmentTemplateName; + /** + * The duration of the assessment run in seconds. + */ + durationInSeconds: AssessmentRunDuration; + /** + * The ARNs that specify the rules packages that you want to attach to the assessment template. + */ + rulesPackageArns: AssessmentTemplateRulesPackageArnList; + /** + * The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique. + */ + userAttributesForFindings?: UserAttributeList; + } + export interface CreateAssessmentTemplateResponse { + /** + * The ARN that specifies the assessment template that is created. + */ + assessmentTemplateArn: Arn; + } + export interface CreateExclusionsPreviewRequest { + /** + * The ARN that specifies the assessment template for which you want to create an exclusions preview. + */ + assessmentTemplateArn: Arn; + } + export interface CreateExclusionsPreviewResponse { + /** + * Specifies the unique identifier of the requested exclusions preview. You can use the unique identifier to retrieve the exclusions preview when running the GetExclusionsPreview API. + */ + previewToken: UUID; + } + export interface CreateResourceGroupRequest { + /** + * A collection of keys and an array of possible values, '[{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values":["Value3"]}]'. For example,'[{"key":"Name","values":["TestEC2Instance"]}]'. + */ + resourceGroupTags: ResourceGroupTags; + } + export interface CreateResourceGroupResponse { + /** + * The ARN that specifies the resource group that is created. + */ + resourceGroupArn: Arn; + } + export interface DeleteAssessmentRunRequest { + /** + * The ARN that specifies the assessment run that you want to delete. + */ + assessmentRunArn: Arn; + } + export interface DeleteAssessmentTargetRequest { + /** + * The ARN that specifies the assessment target that you want to delete. + */ + assessmentTargetArn: Arn; + } + export interface DeleteAssessmentTemplateRequest { + /** + * The ARN that specifies the assessment template that you want to delete. + */ + assessmentTemplateArn: Arn; + } + export interface DescribeAssessmentRunsRequest { + /** + * The ARN that specifies the assessment run that you want to describe. + */ + assessmentRunArns: BatchDescribeArnList; + } + export interface DescribeAssessmentRunsResponse { + /** + * Information about the assessment run. + */ + assessmentRuns: AssessmentRunList; + /** + * Assessment run details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export interface DescribeAssessmentTargetsRequest { + /** + * The ARNs that specifies the assessment targets that you want to describe. + */ + assessmentTargetArns: BatchDescribeArnList; + } + export interface DescribeAssessmentTargetsResponse { + /** + * Information about the assessment targets. + */ + assessmentTargets: AssessmentTargetList; + /** + * Assessment target details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export interface DescribeAssessmentTemplatesRequest { + assessmentTemplateArns: BatchDescribeArnList; + } + export interface DescribeAssessmentTemplatesResponse { + /** + * Information about the assessment templates. + */ + assessmentTemplates: AssessmentTemplateList; + /** + * Assessment template details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export interface DescribeCrossAccountAccessRoleResponse { + /** + * The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account. + */ + roleArn: Arn; + /** + * A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account. + */ + valid: Bool; + /** + * The date when the cross-account access role was registered. + */ + registeredAt: Timestamp; + } + export interface DescribeExclusionsRequest { + /** + * The list of ARNs that specify the exclusions that you want to describe. + */ + exclusionArns: BatchDescribeExclusionsArnList; + /** + * The locale into which you want to translate the exclusion's title, description, and recommendation. + */ + locale?: Locale; + } + export interface DescribeExclusionsResponse { + /** + * Information about the exclusions. + */ + exclusions: ExclusionMap; + /** + * Exclusion details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export interface DescribeFindingsRequest { + /** + * The ARN that specifies the finding that you want to describe. + */ + findingArns: BatchDescribeArnList; + /** + * The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding. + */ + locale?: Locale; + } + export interface DescribeFindingsResponse { + /** + * Information about the finding. + */ + findings: FindingList; + /** + * Finding details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export interface DescribeResourceGroupsRequest { + /** + * The ARN that specifies the resource group that you want to describe. + */ + resourceGroupArns: BatchDescribeArnList; + } + export interface DescribeResourceGroupsResponse { + /** + * Information about a resource group. + */ + resourceGroups: ResourceGroupList; + /** + * Resource group details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export interface DescribeRulesPackagesRequest { + /** + * The ARN that specifies the rules package that you want to describe. + */ + rulesPackageArns: BatchDescribeArnList; + /** + * The locale that you want to translate a rules package description into. + */ + locale?: Locale; + } + export interface DescribeRulesPackagesResponse { + /** + * Information about the rules package. + */ + rulesPackages: RulesPackageList; + /** + * Rules package details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export interface DurationRange { + /** + * The minimum value of the duration range. Must be greater than zero. + */ + minSeconds?: AssessmentRunDuration; + /** + * The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week). + */ + maxSeconds?: AssessmentRunDuration; + } + export interface EventSubscription { + /** + * The event for which Amazon Simple Notification Service (SNS) notifications are sent. + */ + event: InspectorEvent; + /** + * The time at which SubscribeToEvent is called. + */ + subscribedAt: Timestamp; + } + export type EventSubscriptionList = EventSubscription[]; + export interface Exclusion { + /** + * The ARN that specifies the exclusion. + */ + arn: Arn; + /** + * The name of the exclusion. + */ + title: Text; + /** + * The description of the exclusion. + */ + description: Text; + /** + * The recommendation for the exclusion. + */ + recommendation: Text; + /** + * The AWS resources for which the exclusion pertains. + */ + scopes: ScopeList; + /** + * The system-defined attributes for the exclusion. + */ + attributes?: AttributeList; + } + export type ExclusionMap = {[key: string]: Exclusion}; + export interface ExclusionPreview { + /** + * The name of the exclusion preview. + */ + title: Text; + /** + * The description of the exclusion preview. + */ + description: Text; + /** + * The recommendation for the exclusion preview. + */ + recommendation: Text; + /** + * The AWS resources for which the exclusion preview pertains. + */ + scopes: ScopeList; + /** + * The system-defined attributes for the exclusion preview. + */ + attributes?: AttributeList; + } + export type ExclusionPreviewList = ExclusionPreview[]; + export interface FailedItemDetails { + /** + * The status code of a failed item. + */ + failureCode: FailedItemErrorCode; + /** + * Indicates whether you can immediately retry a request for this item for a specified resource. + */ + retryable: Bool; + } + export type FailedItemErrorCode = "INVALID_ARN"|"DUPLICATE_ARN"|"ITEM_DOES_NOT_EXIST"|"ACCESS_DENIED"|"LIMIT_EXCEEDED"|"INTERNAL_ERROR"|string; + export type FailedItems = {[key: string]: FailedItemDetails}; + export type FilterRulesPackageArnList = Arn[]; + export interface Finding { + /** + * The ARN that specifies the finding. + */ + arn: Arn; + /** + * The schema version of this data type. + */ + schemaVersion?: NumericVersion; + /** + * The data element is set to "Inspector". + */ + service?: ServiceName; + /** + * This data type is used in the Finding data type. + */ + serviceAttributes?: InspectorServiceAttributes; + /** + * The type of the host from which the finding is generated. + */ + assetType?: AssetType; + /** + * A collection of attributes of the host from which the finding is generated. + */ + assetAttributes?: AssetAttributes; + /** + * The ID of the finding. + */ + id?: FindingId; + /** + * The name of the finding. + */ + title?: Text; + /** + * The description of the finding. + */ + description?: Text; + /** + * The recommendation for the finding. + */ + recommendation?: Text; + /** + * The finding severity. Values can be set to High, Medium, Low, and Informational. + */ + severity?: Severity; + /** + * The numeric value of the finding severity. + */ + numericSeverity?: NumericSeverity; + /** + * This data element is currently not used. + */ + confidence?: IocConfidence; + /** + * This data element is currently not used. + */ + indicatorOfCompromise?: Bool; + /** + * The system-defined attributes for the finding. + */ + attributes: AttributeList; + /** + * The user-defined attributes that are assigned to the finding. + */ + userAttributes: UserAttributeList; + /** + * The time when the finding was generated. + */ + createdAt: Timestamp; + /** + * The time when AddAttributesToFindings is called. + */ + updatedAt: Timestamp; + } + export type FindingCount = number; + export interface FindingFilter { + /** + * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the agentId property of the Finding data type. + */ + agentIds?: AgentIdList; + /** + * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the autoScalingGroup property of the Finding data type. + */ + autoScalingGroups?: AutoScalingGroupList; + /** + * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type. + */ + ruleNames?: RuleNameList; + /** + * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the severity property of the Finding data type. + */ + severities?: SeverityList; + /** + * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type. + */ + rulesPackageArns?: FilterRulesPackageArnList; + /** + * For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the attributes property of the Finding data type. + */ + attributes?: AttributeList; + /** + * For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the userAttributes property of the Finding data type. + */ + userAttributes?: AttributeList; + /** + * The time range during which the finding is generated. + */ + creationTimeRange?: TimestampRange; + } + export type FindingId = string; + export type FindingList = Finding[]; + export interface GetAssessmentReportRequest { + /** + * The ARN that specifies the assessment run for which you want to generate a report. + */ + assessmentRunArn: Arn; + /** + * Specifies the file format (html or pdf) of the assessment report that you want to generate. + */ + reportFileFormat: ReportFileFormat; + /** + * Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports. + */ + reportType: ReportType; + } + export interface GetAssessmentReportResponse { + /** + * Specifies the status of the request to generate an assessment report. + */ + status: ReportStatus; + /** + * Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated. + */ + url?: Url; + } + export interface GetExclusionsPreviewRequest { + /** + * The ARN that specifies the assessment template for which the exclusions preview was requested. + */ + assessmentTemplateArn: Arn; + /** + * The unique identifier associated of the exclusions preview. + */ + previewToken: UUID; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500. + */ + maxResults?: ListMaxResults; + /** + * The locale into which you want to translate the exclusion's title, description, and recommendation. + */ + locale?: Locale; + } + export interface GetExclusionsPreviewResponse { + /** + * Specifies the status of the request to generate an exclusions preview. + */ + previewStatus: PreviewStatus; + /** + * Information about the exclusions included in the preview. + */ + exclusionPreviews?: ExclusionPreviewList; + /** + * When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export interface GetTelemetryMetadataRequest { + /** + * The ARN that specifies the assessment run that has the telemetry data that you want to obtain. + */ + assessmentRunArn: Arn; + } + export interface GetTelemetryMetadataResponse { + /** + * Telemetry details. + */ + telemetryMetadata: TelemetryMetadataList; + } + export type Hostname = string; + export type InspectorEvent = "ASSESSMENT_RUN_STARTED"|"ASSESSMENT_RUN_COMPLETED"|"ASSESSMENT_RUN_STATE_CHANGED"|"FINDING_REPORTED"|"OTHER"|string; + export interface InspectorServiceAttributes { + /** + * The schema version of this data type. + */ + schemaVersion: NumericVersion; + /** + * The ARN of the assessment run during which the finding is generated. + */ + assessmentRunArn?: Arn; + /** + * The ARN of the rules package that is used to generate the finding. + */ + rulesPackageArn?: Arn; + } + export type IocConfidence = number; + export type Ipv4Address = string; + export type Ipv4AddressList = Ipv4Address[]; + export type Ipv6Addresses = Text[]; + export type KernelVersion = string; + export interface ListAssessmentRunAgentsRequest { + /** + * The ARN that specifies the assessment run whose agents you want to list. + */ + assessmentRunArn: Arn; + /** + * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. + */ + filter?: AgentFilter; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: ListMaxResults; + } + export interface ListAssessmentRunAgentsResponse { + /** + * A list of ARNs that specifies the agents returned by the action. + */ + assessmentRunAgents: AssessmentRunAgentList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export interface ListAssessmentRunsRequest { + /** + * The ARNs that specify the assessment templates whose assessment runs you want to list. + */ + assessmentTemplateArns?: ListParentArnList; + /** + * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. + */ + filter?: AssessmentRunFilter; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: ListMaxResults; + } + export interface ListAssessmentRunsResponse { + /** + * A list of ARNs that specifies the assessment runs that are returned by the action. + */ + assessmentRunArns: ListReturnedArnList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export interface ListAssessmentTargetsRequest { + /** + * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. + */ + filter?: AssessmentTargetFilter; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTargets action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: ListMaxResults; + } + export interface ListAssessmentTargetsResponse { + /** + * A list of ARNs that specifies the assessment targets that are returned by the action. + */ + assessmentTargetArns: ListReturnedArnList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export interface ListAssessmentTemplatesRequest { + /** + * A list of ARNs that specifies the assessment targets whose assessment templates you want to list. + */ + assessmentTargetArns?: ListParentArnList; + /** + * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. + */ + filter?: AssessmentTemplateFilter; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTemplates action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: ListMaxResults; + } + export interface ListAssessmentTemplatesResponse { + /** + * A list of ARNs that specifies the assessment templates returned by the action. + */ + assessmentTemplateArns: ListReturnedArnList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export type ListEventSubscriptionsMaxResults = number; + export interface ListEventSubscriptionsRequest { + /** + * The ARN of the assessment template for which you want to list the existing event subscriptions. + */ + resourceArn?: Arn; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: ListEventSubscriptionsMaxResults; + } + export interface ListEventSubscriptionsResponse { + /** + * Details of the returned event subscriptions. + */ + subscriptions: SubscriptionList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export interface ListExclusionsRequest { + /** + * The ARN of the assessment run that generated the exclusions that you want to list. + */ + assessmentRunArn: Arn; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500. + */ + maxResults?: ListMaxResults; + } + export interface ListExclusionsResponse { + /** + * A list of exclusions' ARNs returned by the action. + */ + exclusionArns: ListReturnedArnList; + /** + * When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export interface ListFindingsRequest { + /** + * The ARNs of the assessment runs that generate the findings that you want to list. + */ + assessmentRunArns?: ListParentArnList; + /** + * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. + */ + filter?: FindingFilter; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: ListMaxResults; + } + export interface ListFindingsResponse { + /** + * A list of ARNs that specifies the findings returned by the action. + */ + findingArns: ListReturnedArnList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export type ListMaxResults = number; + export type ListParentArnList = Arn[]; + export type ListReturnedArnList = Arn[]; + export interface ListRulesPackagesRequest { + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: ListMaxResults; + } + export interface ListRulesPackagesResponse { + /** + * The list of ARNs that specifies the rules packages returned by the action. + */ + rulesPackageArns: ListReturnedArnList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export interface ListTagsForResourceRequest { + /** + * The ARN that specifies the assessment template whose tags you want to list. + */ + resourceArn: Arn; + } + export interface ListTagsForResourceResponse { + /** + * A collection of key and value pairs. + */ + tags: TagList; + } + export type Locale = "EN_US"|string; + export type Long = number; + export type Message = string; + export type MessageType = string; + export type NamePattern = string; + export interface NetworkInterface { + /** + * The ID of the network interface. + */ + networkInterfaceId?: Text; + /** + * The ID of a subnet associated with the network interface. + */ + subnetId?: Text; + /** + * The ID of a VPC associated with the network interface. + */ + vpcId?: Text; + /** + * The name of a private DNS associated with the network interface. + */ + privateDnsName?: Text; + /** + * The private IP address associated with the network interface. + */ + privateIpAddress?: Text; + /** + * A list of the private IP addresses associated with the network interface. Includes the privateDnsName and privateIpAddress. + */ + privateIpAddresses?: PrivateIpAddresses; + /** + * The name of a public DNS associated with the network interface. + */ + publicDnsName?: Text; + /** + * The public IP address from which the network interface is reachable. + */ + publicIp?: Text; + /** + * The IP addresses associated with the network interface. + */ + ipv6Addresses?: Ipv6Addresses; + /** + * A list of the security groups associated with the network interface. Includes the groupId and groupName. + */ + securityGroups?: SecurityGroups; + } + export type NetworkInterfaces = NetworkInterface[]; + export type NumericSeverity = number; + export type NumericVersion = number; + export type OperatingSystem = string; + export type PaginationToken = string; + export type PreviewAgentsMaxResults = number; + export interface PreviewAgentsRequest { + /** + * The ARN of the assessment target whose agents you want to preview. + */ + previewAgentsArn: Arn; + /** + * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + nextToken?: PaginationToken; + /** + * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. + */ + maxResults?: PreviewAgentsMaxResults; + } + export interface PreviewAgentsResponse { + /** + * The resulting list of agents. + */ + agentPreviews: AgentPreviewList; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: PaginationToken; + } + export type PreviewStatus = "WORK_IN_PROGRESS"|"COMPLETED"|string; + export interface PrivateIp { + /** + * The DNS name of the private IP address. + */ + privateDnsName?: Text; + /** + * The full IP address of the network inteface. + */ + privateIpAddress?: Text; + } + export type PrivateIpAddresses = PrivateIp[]; + export type ProviderName = string; + export interface RegisterCrossAccountAccessRoleRequest { + /** + * The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments. + */ + roleArn: Arn; + } + export interface RemoveAttributesFromFindingsRequest { + /** + * The ARNs that specify the findings that you want to remove attributes from. + */ + findingArns: AddRemoveAttributesFindingArnList; + /** + * The array of attribute keys that you want to remove from specified findings. + */ + attributeKeys: UserAttributeKeyList; + } + export interface RemoveAttributesFromFindingsResponse { + /** + * Attributes details that cannot be described. An error code is provided for each failed item. + */ + failedItems: FailedItems; + } + export type ReportFileFormat = "HTML"|"PDF"|string; + export type ReportStatus = "WORK_IN_PROGRESS"|"FAILED"|"COMPLETED"|string; + export type ReportType = "FINDING"|"FULL"|string; + export interface ResourceGroup { + /** + * The ARN of the resource group. + */ + arn: Arn; + /** + * The tags (key and value pairs) of the resource group. This data type property is used in the CreateResourceGroup action. + */ + tags: ResourceGroupTags; + /** + * The time at which resource group is created. + */ + createdAt: Timestamp; + } + export type ResourceGroupList = ResourceGroup[]; + export interface ResourceGroupTag { + /** + * A tag key. + */ + key: TagKey; + /** + * The value assigned to a tag key. + */ + value?: TagValue; + } + export type ResourceGroupTags = ResourceGroupTag[]; + export type RuleName = string; + export type RuleNameList = RuleName[]; + export interface RulesPackage { + /** + * The ARN of the rules package. + */ + arn: Arn; + /** + * The name of the rules package. + */ + name: RulesPackageName; + /** + * The version ID of the rules package. + */ + version: Version; + /** + * The provider of the rules package. + */ + provider: ProviderName; + /** + * The description of the rules package. + */ + description?: Text; + } + export type RulesPackageList = RulesPackage[]; + export type RulesPackageName = string; + export interface Scope { + /** + * The type of the scope. + */ + key?: ScopeType; + /** + * The resource identifier for the specified scope type. + */ + value?: ScopeValue; + } + export type ScopeList = Scope[]; + export type ScopeType = "INSTANCE_ID"|"RULES_PACKAGE_ARN"|string; + export type ScopeValue = string; + export interface SecurityGroup { + /** + * The name of the security group. + */ + groupName?: Text; + /** + * The ID of the security group. + */ + groupId?: Text; + } + export type SecurityGroups = SecurityGroup[]; + export type ServiceName = string; + export interface SetTagsForResourceRequest { + /** + * The ARN of the assessment template that you want to set tags to. + */ + resourceArn: Arn; + /** + * A collection of key and value pairs that you want to set to the assessment template. + */ + tags?: TagList; + } + export type Severity = "Low"|"Medium"|"High"|"Informational"|"Undefined"|string; + export type SeverityList = Severity[]; + export interface StartAssessmentRunRequest { + /** + * The ARN of the assessment template of the assessment run that you want to start. + */ + assessmentTemplateArn: Arn; + /** + * You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run. + */ + assessmentRunName?: AssessmentRunName; + } + export interface StartAssessmentRunResponse { + /** + * The ARN of the assessment run that has been started. + */ + assessmentRunArn: Arn; + } + export type StopAction = "START_EVALUATION"|"SKIP_EVALUATION"|string; + export interface StopAssessmentRunRequest { + /** + * The ARN of the assessment run that you want to stop. + */ + assessmentRunArn: Arn; + /** + * An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated. + */ + stopAction?: StopAction; + } + export interface SubscribeToEventRequest { + /** + * The ARN of the assessment template that is used during the event for which you want to receive SNS notifications. + */ + resourceArn: Arn; + /** + * The event for which you want to receive SNS notifications. + */ + event: InspectorEvent; + /** + * The ARN of the SNS topic to which the SNS notifications are sent. + */ + topicArn: Arn; + } + export interface Subscription { + /** + * The ARN of the assessment template that is used during the event for which the SNS notification is sent. + */ + resourceArn: Arn; + /** + * The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent. + */ + topicArn: Arn; + /** + * The list of existing event subscriptions. + */ + eventSubscriptions: EventSubscriptionList; + } + export type SubscriptionList = Subscription[]; + export interface Tag { + /** + * A tag key. + */ + key: TagKey; + /** + * A value assigned to a tag key. + */ + value?: TagValue; + } + export type TagKey = string; + export type TagList = Tag[]; + export type TagValue = string; + export type Tags = Tag[]; + export interface TelemetryMetadata { + /** + * A specific type of behavioral data that is collected by the agent. + */ + messageType: MessageType; + /** + * The count of messages that the agent sends to the Amazon Inspector service. + */ + count: Long; + /** + * The data size of messages that the agent sends to the Amazon Inspector service. + */ + dataSize?: Long; + } + export type TelemetryMetadataList = TelemetryMetadata[]; + export type Text = string; + export type Timestamp = Date; + export interface TimestampRange { + /** + * The minimum value of the timestamp range. + */ + beginDate?: Timestamp; + /** + * The maximum value of the timestamp range. + */ + endDate?: Timestamp; + } + export type UUID = string; + export interface UnsubscribeFromEventRequest { + /** + * The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications. + */ + resourceArn: Arn; + /** + * The event for which you want to stop receiving SNS notifications. + */ + event: InspectorEvent; + /** + * The ARN of the SNS topic to which SNS notifications are sent. + */ + topicArn: Arn; + } + export interface UpdateAssessmentTargetRequest { + /** + * The ARN of the assessment target that you want to update. + */ + assessmentTargetArn: Arn; + /** + * The name of the assessment target that you want to update. + */ + assessmentTargetName: AssessmentTargetName; + /** + * The ARN of the resource group that is used to specify the new resource group to associate with the assessment target. + */ + resourceGroupArn?: Arn; + } + export type Url = string; + export type UserAttributeKeyList = AttributeKey[]; + export type UserAttributeList = Attribute[]; + export type Version = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-08-18"|"2016-02-16"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Inspector client. + */ + export import Types = Inspector; +} +export = Inspector; diff --git a/node_modules/aws-sdk/clients/inspector.js b/node_modules/aws-sdk/clients/inspector.js new file mode 100644 index 0000000..b03c62d --- /dev/null +++ b/node_modules/aws-sdk/clients/inspector.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['inspector'] = {}; +AWS.Inspector = Service.defineService('inspector', ['2015-08-18*', '2016-02-16']); +Object.defineProperty(apiLoader.services['inspector'], '2016-02-16', { + get: function get() { + var model = require('../apis/inspector-2016-02-16.min.json'); + model.paginators = require('../apis/inspector-2016-02-16.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Inspector; diff --git a/node_modules/aws-sdk/clients/iot.d.ts b/node_modules/aws-sdk/clients/iot.d.ts new file mode 100644 index 0000000..966f23f --- /dev/null +++ b/node_modules/aws-sdk/clients/iot.d.ts @@ -0,0 +1,7362 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Iot extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Iot.Types.ClientConfiguration) + config: Config & Iot.Types.ClientConfiguration; + /** + * Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. + */ + acceptCertificateTransfer(params: Iot.Types.AcceptCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. + */ + acceptCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds a thing to a billing group. + */ + addThingToBillingGroup(params: Iot.Types.AddThingToBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request; + /** + * Adds a thing to a billing group. + */ + addThingToBillingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request; + /** + * Adds a thing to a thing group. + */ + addThingToThingGroup(params: Iot.Types.AddThingToThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request; + /** + * Adds a thing to a thing group. + */ + addThingToThingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request; + /** + * Associates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to "CONTINUOUS". The job status must currently be "IN_PROGRESS". The total number of targets associated with a job must not exceed 100. + */ + associateTargetsWithJob(params: Iot.Types.AssociateTargetsWithJobRequest, callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request; + /** + * Associates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to "CONTINUOUS". The job status must currently be "IN_PROGRESS". The total number of targets associated with a job must not exceed 100. + */ + associateTargetsWithJob(callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request; + /** + * Attaches a policy to the specified target. + */ + attachPolicy(params: Iot.Types.AttachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches a policy to the specified target. + */ + attachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy instead. + */ + attachPrincipalPolicy(params: Iot.Types.AttachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy instead. + */ + attachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it. + */ + attachSecurityProfile(params: Iot.Types.AttachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request; + /** + * Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it. + */ + attachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request; + /** + * Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. + */ + attachThingPrincipal(params: Iot.Types.AttachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request; + /** + * Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. + */ + attachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request; + /** + * Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs. + */ + cancelAuditTask(params: Iot.Types.CancelAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request; + /** + * Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs. + */ + cancelAuditTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request; + /** + * Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE. + */ + cancelCertificateTransfer(params: Iot.Types.CancelCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE. + */ + cancelCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels a job. + */ + cancelJob(params: Iot.Types.CancelJobRequest, callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request; + /** + * Cancels a job. + */ + cancelJob(callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request; + /** + * Cancels the execution of a job for a given thing. + */ + cancelJobExecution(params: Iot.Types.CancelJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels the execution of a job for a given thing. + */ + cancelJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Clears the default authorizer. + */ + clearDefaultAuthorizer(params: Iot.Types.ClearDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request; + /** + * Clears the default authorizer. + */ + clearDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request; + /** + * Creates an authorizer. + */ + createAuthorizer(params: Iot.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request; + /** + * Creates an authorizer. + */ + createAuthorizer(callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request; + /** + * Creates a billing group. + */ + createBillingGroup(params: Iot.Types.CreateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request; + /** + * Creates a billing group. + */ + createBillingGroup(callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request; + /** + * Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path" + */ + createCertificateFromCsr(params: Iot.Types.CreateCertificateFromCsrRequest, callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request; + /** + * Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path" + */ + createCertificateFromCsr(callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request; + /** + * Creates a dynamic thing group. + */ + createDynamicThingGroup(params: Iot.Types.CreateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request; + /** + * Creates a dynamic thing group. + */ + createDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request; + /** + * Creates a job. + */ + createJob(params: Iot.Types.CreateJobRequest, callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request; + /** + * Creates a job. + */ + createJob(callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request; + /** + * Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location. + */ + createKeysAndCertificate(params: Iot.Types.CreateKeysAndCertificateRequest, callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request; + /** + * Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location. + */ + createKeysAndCertificate(callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request; + /** + * Creates an AWS IoT OTAUpdate on a target group of things or groups. + */ + createOTAUpdate(params: Iot.Types.CreateOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request; + /** + * Creates an AWS IoT OTAUpdate on a target group of things or groups. + */ + createOTAUpdate(callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request; + /** + * Creates an AWS IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version. + */ + createPolicy(params: Iot.Types.CreatePolicyRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request; + /** + * Creates an AWS IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version. + */ + createPolicy(callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request; + /** + * Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached). + */ + createPolicyVersion(params: Iot.Types.CreatePolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request; + /** + * Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached). + */ + createPolicyVersion(callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request; + /** + * Creates a role alias. + */ + createRoleAlias(params: Iot.Types.CreateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request; + /** + * Creates a role alias. + */ + createRoleAlias(callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request; + /** + * Creates a scheduled audit that is run at a specified time interval. + */ + createScheduledAudit(params: Iot.Types.CreateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request; + /** + * Creates a scheduled audit that is run at a specified time interval. + */ + createScheduledAudit(callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request; + /** + * Creates a Device Defender security profile. + */ + createSecurityProfile(params: Iot.Types.CreateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request; + /** + * Creates a Device Defender security profile. + */ + createSecurityProfile(callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request; + /** + * Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1. + */ + createStream(params: Iot.Types.CreateStreamRequest, callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request; + /** + * Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1. + */ + createStream(callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request; + /** + * Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. This is a control plane operation. See Authorization for information about authorizing control plane actions. + */ + createThing(params: Iot.Types.CreateThingRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request; + /** + * Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. This is a control plane operation. See Authorization for information about authorizing control plane actions. + */ + createThing(callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request; + /** + * Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions. + */ + createThingGroup(params: Iot.Types.CreateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request; + /** + * Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions. + */ + createThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request; + /** + * Creates a new thing type. + */ + createThingType(params: Iot.Types.CreateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request; + /** + * Creates a new thing type. + */ + createThingType(callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request; + /** + * Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. + */ + createTopicRule(params: Iot.Types.CreateTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. + */ + createTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. + */ + deleteAccountAuditConfiguration(params: Iot.Types.DeleteAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request; + /** + * Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. + */ + deleteAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request; + /** + * Deletes an authorizer. + */ + deleteAuthorizer(params: Iot.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request; + /** + * Deletes an authorizer. + */ + deleteAuthorizer(callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request; + /** + * Deletes the billing group. + */ + deleteBillingGroup(params: Iot.Types.DeleteBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request; + /** + * Deletes the billing group. + */ + deleteBillingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request; + /** + * Deletes a registered CA certificate. + */ + deleteCACertificate(params: Iot.Types.DeleteCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request; + /** + * Deletes a registered CA certificate. + */ + deleteCACertificate(callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request; + /** + * Deletes the specified certificate. A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status. + */ + deleteCertificate(params: Iot.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified certificate. A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status. + */ + deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a dynamic thing group. + */ + deleteDynamicThingGroup(params: Iot.Types.DeleteDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request; + /** + * Deletes a dynamic thing group. + */ + deleteDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request; + /** + * Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur. + */ + deleteJob(params: Iot.Types.DeleteJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur. + */ + deleteJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a job execution. + */ + deleteJobExecution(params: Iot.Types.DeleteJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a job execution. + */ + deleteJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delete an OTA update. + */ + deleteOTAUpdate(params: Iot.Types.DeleteOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request; + /** + * Delete an OTA update. + */ + deleteOTAUpdate(callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request; + /** + * Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it. + */ + deletePolicy(params: Iot.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it. + */ + deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. + */ + deletePolicyVersion(params: Iot.Types.DeletePolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. + */ + deletePolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a CA certificate registration code. + */ + deleteRegistrationCode(params: Iot.Types.DeleteRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request; + /** + * Deletes a CA certificate registration code. + */ + deleteRegistrationCode(callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request; + /** + * Deletes a role alias + */ + deleteRoleAlias(params: Iot.Types.DeleteRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request; + /** + * Deletes a role alias + */ + deleteRoleAlias(callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request; + /** + * Deletes a scheduled audit. + */ + deleteScheduledAudit(params: Iot.Types.DeleteScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request; + /** + * Deletes a scheduled audit. + */ + deleteScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request; + /** + * Deletes a Device Defender security profile. + */ + deleteSecurityProfile(params: Iot.Types.DeleteSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request; + /** + * Deletes a Device Defender security profile. + */ + deleteSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request; + /** + * Deletes a stream. + */ + deleteStream(params: Iot.Types.DeleteStreamRequest, callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request; + /** + * Deletes a stream. + */ + deleteStream(callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request; + /** + * Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. + */ + deleteThing(params: Iot.Types.DeleteThingRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request; + /** + * Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. + */ + deleteThing(callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request; + /** + * Deletes a thing group. + */ + deleteThingGroup(params: Iot.Types.DeleteThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request; + /** + * Deletes a thing group. + */ + deleteThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request; + /** + * Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type. + */ + deleteThingType(params: Iot.Types.DeleteThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request; + /** + * Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type. + */ + deleteThingType(callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request; + /** + * Deletes the rule. + */ + deleteTopicRule(params: Iot.Types.DeleteTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the rule. + */ + deleteTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a logging level. + */ + deleteV2LoggingLevel(params: Iot.Types.DeleteV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a logging level. + */ + deleteV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecates a thing type. You can not associate new things with deprecated thing type. + */ + deprecateThingType(params: Iot.Types.DeprecateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request; + /** + * Deprecates a thing type. You can not associate new things with deprecated thing type. + */ + deprecateThingType(callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request; + /** + * Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. + */ + describeAccountAuditConfiguration(params: Iot.Types.DescribeAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request; + /** + * Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. + */ + describeAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request; + /** + * Gets information about a Device Defender audit. + */ + describeAuditTask(params: Iot.Types.DescribeAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request; + /** + * Gets information about a Device Defender audit. + */ + describeAuditTask(callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request; + /** + * Describes an authorizer. + */ + describeAuthorizer(params: Iot.Types.DescribeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request; + /** + * Describes an authorizer. + */ + describeAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request; + /** + * Returns information about a billing group. + */ + describeBillingGroup(params: Iot.Types.DescribeBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request; + /** + * Returns information about a billing group. + */ + describeBillingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request; + /** + * Describes a registered CA certificate. + */ + describeCACertificate(params: Iot.Types.DescribeCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request; + /** + * Describes a registered CA certificate. + */ + describeCACertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request; + /** + * Gets information about the specified certificate. + */ + describeCertificate(params: Iot.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request; + /** + * Gets information about the specified certificate. + */ + describeCertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request; + /** + * Describes the default authorizer. + */ + describeDefaultAuthorizer(params: Iot.Types.DescribeDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request; + /** + * Describes the default authorizer. + */ + describeDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request; + /** + * Returns a unique endpoint specific to the AWS account making the call. + */ + describeEndpoint(params: Iot.Types.DescribeEndpointRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request; + /** + * Returns a unique endpoint specific to the AWS account making the call. + */ + describeEndpoint(callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request; + /** + * Describes event configurations. + */ + describeEventConfigurations(params: Iot.Types.DescribeEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request; + /** + * Describes event configurations. + */ + describeEventConfigurations(callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request; + /** + * Describes a search index. + */ + describeIndex(params: Iot.Types.DescribeIndexRequest, callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request; + /** + * Describes a search index. + */ + describeIndex(callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request; + /** + * Describes a job. + */ + describeJob(params: Iot.Types.DescribeJobRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request; + /** + * Describes a job. + */ + describeJob(callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request; + /** + * Describes a job execution. + */ + describeJobExecution(params: Iot.Types.DescribeJobExecutionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request; + /** + * Describes a job execution. + */ + describeJobExecution(callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request; + /** + * Describes a role alias. + */ + describeRoleAlias(params: Iot.Types.DescribeRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request; + /** + * Describes a role alias. + */ + describeRoleAlias(callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request; + /** + * Gets information about a scheduled audit. + */ + describeScheduledAudit(params: Iot.Types.DescribeScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request; + /** + * Gets information about a scheduled audit. + */ + describeScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request; + /** + * Gets information about a Device Defender security profile. + */ + describeSecurityProfile(params: Iot.Types.DescribeSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request; + /** + * Gets information about a Device Defender security profile. + */ + describeSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request; + /** + * Gets information about a stream. + */ + describeStream(params: Iot.Types.DescribeStreamRequest, callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request; + /** + * Gets information about a stream. + */ + describeStream(callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request; + /** + * Gets information about the specified thing. + */ + describeThing(params: Iot.Types.DescribeThingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request; + /** + * Gets information about the specified thing. + */ + describeThing(callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request; + /** + * Describe a thing group. + */ + describeThingGroup(params: Iot.Types.DescribeThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request; + /** + * Describe a thing group. + */ + describeThingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request; + /** + * Describes a bulk thing provisioning task. + */ + describeThingRegistrationTask(params: Iot.Types.DescribeThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request; + /** + * Describes a bulk thing provisioning task. + */ + describeThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request; + /** + * Gets information about the specified thing type. + */ + describeThingType(params: Iot.Types.DescribeThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request; + /** + * Gets information about the specified thing type. + */ + describeThingType(callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request; + /** + * Detaches a policy from the specified target. + */ + detachPolicy(params: Iot.Types.DetachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a policy from the specified target. + */ + detachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy instead. + */ + detachPrincipalPolicy(params: Iot.Types.DetachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy instead. + */ + detachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates a Device Defender security profile from a thing group or from this account. + */ + detachSecurityProfile(params: Iot.Types.DetachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request; + /** + * Disassociates a Device Defender security profile from a thing group or from this account. + */ + detachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request; + /** + * Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. This call is asynchronous. It might take several seconds for the detachment to propagate. + */ + detachThingPrincipal(params: Iot.Types.DetachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request; + /** + * Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. This call is asynchronous. It might take several seconds for the detachment to propagate. + */ + detachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request; + /** + * Disables the rule. + */ + disableTopicRule(params: Iot.Types.DisableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the rule. + */ + disableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the rule. + */ + enableTopicRule(params: Iot.Types.EnableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the rule. + */ + enableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway. + */ + getEffectivePolicies(params: Iot.Types.GetEffectivePoliciesRequest, callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request; + /** + * Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway. + */ + getEffectivePolicies(callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request; + /** + * Gets the search configuration. + */ + getIndexingConfiguration(params: Iot.Types.GetIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request; + /** + * Gets the search configuration. + */ + getIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request; + /** + * Gets a job document. + */ + getJobDocument(params: Iot.Types.GetJobDocumentRequest, callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request; + /** + * Gets a job document. + */ + getJobDocument(callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request; + /** + * Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. + */ + getLoggingOptions(params: Iot.Types.GetLoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request; + /** + * Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. + */ + getLoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request; + /** + * Gets an OTA update. + */ + getOTAUpdate(params: Iot.Types.GetOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request; + /** + * Gets an OTA update. + */ + getOTAUpdate(callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request; + /** + * Gets information about the specified policy with the policy document of the default version. + */ + getPolicy(params: Iot.Types.GetPolicyRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request; + /** + * Gets information about the specified policy with the policy document of the default version. + */ + getPolicy(callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request; + /** + * Gets information about the specified policy version. + */ + getPolicyVersion(params: Iot.Types.GetPolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request; + /** + * Gets information about the specified policy version. + */ + getPolicyVersion(callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request; + /** + * Gets a registration code used to register a CA certificate with AWS IoT. + */ + getRegistrationCode(params: Iot.Types.GetRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request; + /** + * Gets a registration code used to register a CA certificate with AWS IoT. + */ + getRegistrationCode(callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request; + /** + * Gets statistics about things that match the specified query. + */ + getStatistics(params: Iot.Types.GetStatisticsRequest, callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request; + /** + * Gets statistics about things that match the specified query. + */ + getStatistics(callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request; + /** + * Gets information about the rule. + */ + getTopicRule(params: Iot.Types.GetTopicRuleRequest, callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request; + /** + * Gets information about the rule. + */ + getTopicRule(callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request; + /** + * Gets the fine grained logging options. + */ + getV2LoggingOptions(params: Iot.Types.GetV2LoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request; + /** + * Gets the fine grained logging options. + */ + getV2LoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request; + /** + * Lists the active violations for a given Device Defender security profile. + */ + listActiveViolations(params: Iot.Types.ListActiveViolationsRequest, callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request; + /** + * Lists the active violations for a given Device Defender security profile. + */ + listActiveViolations(callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request; + /** + * Lists the policies attached to the specified thing group. + */ + listAttachedPolicies(params: Iot.Types.ListAttachedPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request; + /** + * Lists the policies attached to the specified thing group. + */ + listAttachedPolicies(callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request; + /** + * Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.) + */ + listAuditFindings(params: Iot.Types.ListAuditFindingsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request; + /** + * Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.) + */ + listAuditFindings(callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request; + /** + * Lists the Device Defender audits that have been performed during a given time period. + */ + listAuditTasks(params: Iot.Types.ListAuditTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request; + /** + * Lists the Device Defender audits that have been performed during a given time period. + */ + listAuditTasks(callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request; + /** + * Lists the authorizers registered in your account. + */ + listAuthorizers(params: Iot.Types.ListAuthorizersRequest, callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request; + /** + * Lists the authorizers registered in your account. + */ + listAuthorizers(callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request; + /** + * Lists the billing groups you have created. + */ + listBillingGroups(params: Iot.Types.ListBillingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request; + /** + * Lists the billing groups you have created. + */ + listBillingGroups(callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request; + /** + * Lists the CA certificates registered for your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. + */ + listCACertificates(params: Iot.Types.ListCACertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request; + /** + * Lists the CA certificates registered for your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. + */ + listCACertificates(callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request; + /** + * Lists the certificates registered in your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. + */ + listCertificates(params: Iot.Types.ListCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request; + /** + * Lists the certificates registered in your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. + */ + listCertificates(callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request; + /** + * List the device certificates signed by the specified CA certificate. + */ + listCertificatesByCA(params: Iot.Types.ListCertificatesByCARequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request; + /** + * List the device certificates signed by the specified CA certificate. + */ + listCertificatesByCA(callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request; + /** + * Lists the search indices. + */ + listIndices(params: Iot.Types.ListIndicesRequest, callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request; + /** + * Lists the search indices. + */ + listIndices(callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request; + /** + * Lists the job executions for a job. + */ + listJobExecutionsForJob(params: Iot.Types.ListJobExecutionsForJobRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request; + /** + * Lists the job executions for a job. + */ + listJobExecutionsForJob(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request; + /** + * Lists the job executions for the specified thing. + */ + listJobExecutionsForThing(params: Iot.Types.ListJobExecutionsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request; + /** + * Lists the job executions for the specified thing. + */ + listJobExecutionsForThing(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request; + /** + * Lists jobs. + */ + listJobs(params: Iot.Types.ListJobsRequest, callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request; + /** + * Lists jobs. + */ + listJobs(callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request; + /** + * Lists OTA updates. + */ + listOTAUpdates(params: Iot.Types.ListOTAUpdatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request; + /** + * Lists OTA updates. + */ + listOTAUpdates(callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request; + /** + * Lists certificates that are being transferred but not yet accepted. + */ + listOutgoingCertificates(params: Iot.Types.ListOutgoingCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request; + /** + * Lists certificates that are being transferred but not yet accepted. + */ + listOutgoingCertificates(callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request; + /** + * Lists your policies. + */ + listPolicies(params: Iot.Types.ListPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request; + /** + * Lists your policies. + */ + listPolicies(callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request; + /** + * Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy instead. + */ + listPolicyPrincipals(params: Iot.Types.ListPolicyPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request; + /** + * Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy instead. + */ + listPolicyPrincipals(callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request; + /** + * Lists the versions of the specified policy and identifies the default version. + */ + listPolicyVersions(params: Iot.Types.ListPolicyVersionsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request; + /** + * Lists the versions of the specified policy and identifies the default version. + */ + listPolicyVersions(callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request; + /** + * Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This API is deprecated. Please use ListAttachedPolicies instead. + */ + listPrincipalPolicies(params: Iot.Types.ListPrincipalPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request; + /** + * Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This API is deprecated. Please use ListAttachedPolicies instead. + */ + listPrincipalPolicies(callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request; + /** + * Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. + */ + listPrincipalThings(params: Iot.Types.ListPrincipalThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request; + /** + * Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. + */ + listPrincipalThings(callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request; + /** + * Lists the role aliases registered in your account. + */ + listRoleAliases(params: Iot.Types.ListRoleAliasesRequest, callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request; + /** + * Lists the role aliases registered in your account. + */ + listRoleAliases(callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request; + /** + * Lists all of your scheduled audits. + */ + listScheduledAudits(params: Iot.Types.ListScheduledAuditsRequest, callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request; + /** + * Lists all of your scheduled audits. + */ + listScheduledAudits(callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request; + /** + * Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account. + */ + listSecurityProfiles(params: Iot.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request; + /** + * Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account. + */ + listSecurityProfiles(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request; + /** + * Lists the Device Defender security profiles attached to a target (thing group). + */ + listSecurityProfilesForTarget(params: Iot.Types.ListSecurityProfilesForTargetRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request; + /** + * Lists the Device Defender security profiles attached to a target (thing group). + */ + listSecurityProfilesForTarget(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request; + /** + * Lists all of the streams in your AWS account. + */ + listStreams(params: Iot.Types.ListStreamsRequest, callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request; + /** + * Lists all of the streams in your AWS account. + */ + listStreams(callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request; + /** + * Lists the tags (metadata) you have assigned to the resource. + */ + listTagsForResource(params: Iot.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags (metadata) you have assigned to the resource. + */ + listTagsForResource(callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request; + /** + * List targets for the specified policy. + */ + listTargetsForPolicy(params: Iot.Types.ListTargetsForPolicyRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request; + /** + * List targets for the specified policy. + */ + listTargetsForPolicy(callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request; + /** + * Lists the targets (thing groups) associated with a given Device Defender security profile. + */ + listTargetsForSecurityProfile(params: Iot.Types.ListTargetsForSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request; + /** + * Lists the targets (thing groups) associated with a given Device Defender security profile. + */ + listTargetsForSecurityProfile(callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request; + /** + * List the thing groups in your account. + */ + listThingGroups(params: Iot.Types.ListThingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request; + /** + * List the thing groups in your account. + */ + listThingGroups(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request; + /** + * List the thing groups to which the specified thing belongs. + */ + listThingGroupsForThing(params: Iot.Types.ListThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request; + /** + * List the thing groups to which the specified thing belongs. + */ + listThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request; + /** + * Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. + */ + listThingPrincipals(params: Iot.Types.ListThingPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request; + /** + * Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. + */ + listThingPrincipals(callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request; + /** + * Information about the thing registration tasks. + */ + listThingRegistrationTaskReports(params: Iot.Types.ListThingRegistrationTaskReportsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTaskReportsResponse) => void): Request; + /** + * Information about the thing registration tasks. + */ + listThingRegistrationTaskReports(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTaskReportsResponse) => void): Request; + /** + * List bulk thing provisioning tasks. + */ + listThingRegistrationTasks(params: Iot.Types.ListThingRegistrationTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request; + /** + * List bulk thing provisioning tasks. + */ + listThingRegistrationTasks(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request; + /** + * Lists the existing thing types. + */ + listThingTypes(params: Iot.Types.ListThingTypesRequest, callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request; + /** + * Lists the existing thing types. + */ + listThingTypes(callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request; + /** + * Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. + */ + listThings(params: Iot.Types.ListThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request; + /** + * Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. + */ + listThings(callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request; + /** + * Lists the things you have added to the given billing group. + */ + listThingsInBillingGroup(params: Iot.Types.ListThingsInBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request; + /** + * Lists the things you have added to the given billing group. + */ + listThingsInBillingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request; + /** + * Lists the things in the specified group. + */ + listThingsInThingGroup(params: Iot.Types.ListThingsInThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request; + /** + * Lists the things in the specified group. + */ + listThingsInThingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request; + /** + * Lists the rules for the specific topic. + */ + listTopicRules(params: Iot.Types.ListTopicRulesRequest, callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request; + /** + * Lists the rules for the specific topic. + */ + listTopicRules(callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request; + /** + * Lists logging levels. + */ + listV2LoggingLevels(params: Iot.Types.ListV2LoggingLevelsRequest, callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request; + /** + * Lists logging levels. + */ + listV2LoggingLevels(callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request; + /** + * Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior or thing (device). + */ + listViolationEvents(params: Iot.Types.ListViolationEventsRequest, callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request; + /** + * Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior or thing (device). + */ + listViolationEvents(callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request; + /** + * Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API. + */ + registerCACertificate(params: Iot.Types.RegisterCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request; + /** + * Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API. + */ + registerCACertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request; + /** + * Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered. + */ + registerCertificate(params: Iot.Types.RegisterCertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request; + /** + * Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered. + */ + registerCertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request; + /** + * Provisions a thing. + */ + registerThing(params: Iot.Types.RegisterThingRequest, callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request; + /** + * Provisions a thing. + */ + registerThing(callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request; + /** + * Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state. + */ + rejectCertificateTransfer(params: Iot.Types.RejectCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state. + */ + rejectCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the given thing from the billing group. + */ + removeThingFromBillingGroup(params: Iot.Types.RemoveThingFromBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request; + /** + * Removes the given thing from the billing group. + */ + removeThingFromBillingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request; + /** + * Remove the specified thing from the specified group. + */ + removeThingFromThingGroup(params: Iot.Types.RemoveThingFromThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request; + /** + * Remove the specified thing from the specified group. + */ + removeThingFromThingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request; + /** + * Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. + */ + replaceTopicRule(params: Iot.Types.ReplaceTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. + */ + replaceTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The query search index. + */ + searchIndex(params: Iot.Types.SearchIndexRequest, callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request; + /** + * The query search index. + */ + searchIndex(callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request; + /** + * Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. + */ + setDefaultAuthorizer(params: Iot.Types.SetDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request; + /** + * Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. + */ + setDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request; + /** + * Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API. + */ + setDefaultPolicyVersion(params: Iot.Types.SetDefaultPolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API. + */ + setDefaultPolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. + */ + setLoggingOptions(params: Iot.Types.SetLoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. + */ + setLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the logging level. + */ + setV2LoggingLevel(params: Iot.Types.SetV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the logging level. + */ + setV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the logging options for the V2 logging service. + */ + setV2LoggingOptions(params: Iot.Types.SetV2LoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the logging options for the V2 logging service. + */ + setV2LoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts an on-demand Device Defender audit. + */ + startOnDemandAuditTask(params: Iot.Types.StartOnDemandAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request; + /** + * Starts an on-demand Device Defender audit. + */ + startOnDemandAuditTask(callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request; + /** + * Creates a bulk thing provisioning task. + */ + startThingRegistrationTask(params: Iot.Types.StartThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request; + /** + * Creates a bulk thing provisioning task. + */ + startThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request; + /** + * Cancels a bulk thing provisioning task. + */ + stopThingRegistrationTask(params: Iot.Types.StopThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request; + /** + * Cancels a bulk thing provisioning task. + */ + stopThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request; + /** + * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. + */ + tagResource(params: Iot.Types.TagResourceRequest, callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request; + /** + * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. + */ + tagResource(callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request; + /** + * Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway. + */ + testAuthorization(params: Iot.Types.TestAuthorizationRequest, callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request; + /** + * Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway. + */ + testAuthorization(callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request; + /** + * Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway. + */ + testInvokeAuthorizer(params: Iot.Types.TestInvokeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request; + /** + * Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway. + */ + testInvokeAuthorizer(callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request; + /** + * Transfers the specified certificate to the specified AWS account. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them. + */ + transferCertificate(params: Iot.Types.TransferCertificateRequest, callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request; + /** + * Transfers the specified certificate to the specified AWS account. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them. + */ + transferCertificate(callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request; + /** + * Removes the given tags (metadata) from the resource. + */ + untagResource(params: Iot.Types.UntagResourceRequest, callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request; + /** + * Removes the given tags (metadata) from the resource. + */ + untagResource(callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request; + /** + * Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. + */ + updateAccountAuditConfiguration(params: Iot.Types.UpdateAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request; + /** + * Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. + */ + updateAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request; + /** + * Updates an authorizer. + */ + updateAuthorizer(params: Iot.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request; + /** + * Updates an authorizer. + */ + updateAuthorizer(callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request; + /** + * Updates information about the billing group. + */ + updateBillingGroup(params: Iot.Types.UpdateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request; + /** + * Updates information about the billing group. + */ + updateBillingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request; + /** + * Updates a registered CA certificate. + */ + updateCACertificate(params: Iot.Types.UpdateCACertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a registered CA certificate. + */ + updateCACertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the status of the specified certificate. This operation is idempotent. Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect. The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate. + */ + updateCertificate(params: Iot.Types.UpdateCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the status of the specified certificate. This operation is idempotent. Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect. The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate. + */ + updateCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a dynamic thing group. + */ + updateDynamicThingGroup(params: Iot.Types.UpdateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request; + /** + * Updates a dynamic thing group. + */ + updateDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request; + /** + * Updates the event configurations. + */ + updateEventConfigurations(params: Iot.Types.UpdateEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request; + /** + * Updates the event configurations. + */ + updateEventConfigurations(callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request; + /** + * Updates the search configuration. + */ + updateIndexingConfiguration(params: Iot.Types.UpdateIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request; + /** + * Updates the search configuration. + */ + updateIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request; + /** + * Updates supported fields of the specified job. + */ + updateJob(params: Iot.Types.UpdateJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates supported fields of the specified job. + */ + updateJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a role alias. + */ + updateRoleAlias(params: Iot.Types.UpdateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request; + /** + * Updates a role alias. + */ + updateRoleAlias(callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request; + /** + * Updates a scheduled audit, including what checks are performed and how often the audit takes place. + */ + updateScheduledAudit(params: Iot.Types.UpdateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request; + /** + * Updates a scheduled audit, including what checks are performed and how often the audit takes place. + */ + updateScheduledAudit(callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request; + /** + * Updates a Device Defender security profile. + */ + updateSecurityProfile(params: Iot.Types.UpdateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request; + /** + * Updates a Device Defender security profile. + */ + updateSecurityProfile(callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request; + /** + * Updates an existing stream. The stream version will be incremented by one. + */ + updateStream(params: Iot.Types.UpdateStreamRequest, callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request; + /** + * Updates an existing stream. The stream version will be incremented by one. + */ + updateStream(callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request; + /** + * Updates the data for a thing. + */ + updateThing(params: Iot.Types.UpdateThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request; + /** + * Updates the data for a thing. + */ + updateThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request; + /** + * Update a thing group. + */ + updateThingGroup(params: Iot.Types.UpdateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request; + /** + * Update a thing group. + */ + updateThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request; + /** + * Updates the groups to which the thing belongs. + */ + updateThingGroupsForThing(params: Iot.Types.UpdateThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request; + /** + * Updates the groups to which the thing belongs. + */ + updateThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request; + /** + * Validates a Device Defender security profile behaviors specification. + */ + validateSecurityProfileBehaviors(params: Iot.Types.ValidateSecurityProfileBehaviorsRequest, callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request; + /** + * Validates a Device Defender security profile behaviors specification. + */ + validateSecurityProfileBehaviors(callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request; +} +declare namespace Iot { + export type AbortAction = "CANCEL"|string; + export interface AbortConfig { + /** + * The list of abort criteria to define rules to abort the job. + */ + criteriaList: AbortCriteriaList; + } + export interface AbortCriteria { + /** + * The type of job execution failure to define a rule to initiate a job abort. + */ + failureType: JobExecutionFailureType; + /** + * The type of abort action to initiate a job abort. + */ + action: AbortAction; + /** + * The threshold as a percentage of the total number of executed things that will initiate a job abort. AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999). + */ + thresholdPercentage: AbortThresholdPercentage; + /** + * Minimum number of executed things before evaluating an abort rule. + */ + minNumberOfExecutedThings: MinimumNumberOfExecutedThings; + } + export type AbortCriteriaList = AbortCriteria[]; + export type AbortThresholdPercentage = number; + export interface AcceptCertificateTransferRequest { + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + /** + * Specifies whether the certificate is active. + */ + setAsActive?: SetAsActive; + } + export interface Action { + /** + * Write to a DynamoDB table. + */ + dynamoDB?: DynamoDBAction; + /** + * Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column. + */ + dynamoDBv2?: DynamoDBv2Action; + /** + * Invoke a Lambda function. + */ + lambda?: LambdaAction; + /** + * Publish to an Amazon SNS topic. + */ + sns?: SnsAction; + /** + * Publish to an Amazon SQS queue. + */ + sqs?: SqsAction; + /** + * Write data to an Amazon Kinesis stream. + */ + kinesis?: KinesisAction; + /** + * Publish to another MQTT topic. + */ + republish?: RepublishAction; + /** + * Write to an Amazon S3 bucket. + */ + s3?: S3Action; + /** + * Write to an Amazon Kinesis Firehose stream. + */ + firehose?: FirehoseAction; + /** + * Capture a CloudWatch metric. + */ + cloudwatchMetric?: CloudwatchMetricAction; + /** + * Change the state of a CloudWatch alarm. + */ + cloudwatchAlarm?: CloudwatchAlarmAction; + /** + * Write data to an Amazon Elasticsearch Service domain. + */ + elasticsearch?: ElasticsearchAction; + /** + * Send a message to a Salesforce IoT Cloud Input Stream. + */ + salesforce?: SalesforceAction; + /** + * Sends message data to an AWS IoT Analytics channel. + */ + iotAnalytics?: IotAnalyticsAction; + /** + * Sends an input to an AWS IoT Events detector. + */ + iotEvents?: IotEventsAction; + /** + * Starts execution of a Step Functions state machine. + */ + stepFunctions?: StepFunctionsAction; + } + export type ActionList = Action[]; + export type ActionType = "PUBLISH"|"SUBSCRIBE"|"RECEIVE"|"CONNECT"|string; + export interface ActiveViolation { + /** + * The ID of the active violation. + */ + violationId?: ViolationId; + /** + * The name of the thing responsible for the active violation. + */ + thingName?: ThingName; + /** + * The security profile whose behavior is in violation. + */ + securityProfileName?: SecurityProfileName; + /** + * The behavior which is being violated. + */ + behavior?: Behavior; + /** + * The value of the metric (the measurement) which caused the most recent violation. + */ + lastViolationValue?: MetricValue; + /** + * The time the most recent violation occurred. + */ + lastViolationTime?: Timestamp; + /** + * The time the violation started. + */ + violationStartTime?: Timestamp; + } + export type ActiveViolations = ActiveViolation[]; + export interface AddThingToBillingGroupRequest { + /** + * The name of the billing group. + */ + billingGroupName?: BillingGroupName; + /** + * The ARN of the billing group. + */ + billingGroupArn?: BillingGroupArn; + /** + * The name of the thing to be added to the billing group. + */ + thingName?: ThingName; + /** + * The ARN of the thing to be added to the billing group. + */ + thingArn?: ThingArn; + } + export interface AddThingToBillingGroupResponse { + } + export interface AddThingToThingGroupRequest { + /** + * The name of the group to which you are adding a thing. + */ + thingGroupName?: ThingGroupName; + /** + * The ARN of the group to which you are adding a thing. + */ + thingGroupArn?: ThingGroupArn; + /** + * The name of the thing to add to a group. + */ + thingName?: ThingName; + /** + * The ARN of the thing to add to a group. + */ + thingArn?: ThingArn; + /** + * Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group. + */ + overrideDynamicGroups?: OverrideDynamicGroups; + } + export interface AddThingToThingGroupResponse { + } + export type AdditionalMetricsToRetainList = BehaviorMetric[]; + export type AdditionalParameterMap = {[key: string]: Value}; + export type AggregationField = string; + export type AlarmName = string; + export interface AlertTarget { + /** + * The ARN of the notification target to which alerts are sent. + */ + alertTargetArn: AlertTargetArn; + /** + * The ARN of the role that grants permission to send alerts to the notification target. + */ + roleArn: RoleArn; + } + export type AlertTargetArn = string; + export type AlertTargetType = "SNS"|string; + export type AlertTargets = {[key: string]: AlertTarget}; + export type AllowAutoRegistration = boolean; + export interface Allowed { + /** + * A list of policies that allowed the authentication. + */ + policies?: Policies; + } + export type ApproximateSecondsBeforeTimedOut = number; + export type AscendingOrder = boolean; + export interface AssociateTargetsWithJobRequest { + /** + * A list of thing group ARNs that define the targets of the job. + */ + targets: JobTargets; + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId: JobId; + /** + * An optional comment string describing why the job was associated with the targets. + */ + comment?: Comment; + } + export interface AssociateTargetsWithJobResponse { + /** + * An ARN identifying the job. + */ + jobArn?: JobArn; + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId?: JobId; + /** + * A short text description of the job. + */ + description?: JobDescription; + } + export interface AttachPolicyRequest { + /** + * The name of the policy to attach. + */ + policyName: PolicyName; + /** + * The identity to which the policy is attached. + */ + target: PolicyTarget; + } + export interface AttachPrincipalPolicyRequest { + /** + * The policy name. + */ + policyName: PolicyName; + /** + * The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID. + */ + principal: Principal; + } + export interface AttachSecurityProfileRequest { + /** + * The security profile that is attached. + */ + securityProfileName: SecurityProfileName; + /** + * The ARN of the target (thing group) to which the security profile is attached. + */ + securityProfileTargetArn: SecurityProfileTargetArn; + } + export interface AttachSecurityProfileResponse { + } + export interface AttachThingPrincipalRequest { + /** + * The name of the thing. + */ + thingName: ThingName; + /** + * The principal, such as a certificate or other credential. + */ + principal: Principal; + } + export interface AttachThingPrincipalResponse { + } + export type AttributeKey = string; + export type AttributeName = string; + export interface AttributePayload { + /** + * A JSON string containing up to three key-value pair in JSON format. For example: {\"attributes\":{\"string1\":\"string2\"}} + */ + attributes?: Attributes; + /** + * Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them. To remove an attribute, call UpdateThing with an empty attribute value. The merge attribute is only valid when calling UpdateThing. + */ + merge?: Flag; + } + export type AttributeValue = string; + export type Attributes = {[key: string]: AttributeValue}; + export type AttributesMap = {[key: string]: Value}; + export interface AuditCheckConfiguration { + /** + * True if this audit check is enabled for this account. + */ + enabled?: Enabled; + } + export type AuditCheckConfigurations = {[key: string]: AuditCheckConfiguration}; + export interface AuditCheckDetails { + /** + * The completion status of this check, one of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED". + */ + checkRunStatus?: AuditCheckRunStatus; + /** + * True if the check completed and found all resources compliant. + */ + checkCompliant?: CheckCompliant; + /** + * The number of resources on which the check was performed. + */ + totalResourcesCount?: TotalResourcesCount; + /** + * The number of resources that the check found non-compliant. + */ + nonCompliantResourcesCount?: NonCompliantResourcesCount; + /** + * The code of any error encountered when performing this check during this audit. One of "INSUFFICIENT_PERMISSIONS", or "AUDIT_CHECK_DISABLED". + */ + errorCode?: ErrorCode; + /** + * The message associated with any error encountered when performing this check during this audit. + */ + message?: ErrorMessage; + } + export type AuditCheckName = string; + export type AuditCheckRunStatus = "IN_PROGRESS"|"WAITING_FOR_DATA_COLLECTION"|"CANCELED"|"COMPLETED_COMPLIANT"|"COMPLETED_NON_COMPLIANT"|"FAILED"|string; + export type AuditDetails = {[key: string]: AuditCheckDetails}; + export interface AuditFinding { + /** + * The ID of the audit that generated this result (finding) + */ + taskId?: AuditTaskId; + /** + * The audit check that generated this result. + */ + checkName?: AuditCheckName; + /** + * The time the audit started. + */ + taskStartTime?: Timestamp; + /** + * The time the result (finding) was discovered. + */ + findingTime?: Timestamp; + /** + * The severity of the result (finding). + */ + severity?: AuditFindingSeverity; + /** + * The resource that was found to be non-compliant with the audit check. + */ + nonCompliantResource?: NonCompliantResource; + /** + * The list of related resources. + */ + relatedResources?: RelatedResources; + /** + * The reason the resource was non-compliant. + */ + reasonForNonCompliance?: ReasonForNonCompliance; + /** + * A code which indicates the reason that the resource was non-compliant. + */ + reasonForNonComplianceCode?: ReasonForNonComplianceCode; + } + export type AuditFindingSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|string; + export type AuditFindings = AuditFinding[]; + export type AuditFrequency = "DAILY"|"WEEKLY"|"BIWEEKLY"|"MONTHLY"|string; + export interface AuditNotificationTarget { + /** + * The ARN of the target (SNS topic) to which audit notifications are sent. + */ + targetArn?: TargetArn; + /** + * The ARN of the role that grants permission to send notifications to the target. + */ + roleArn?: RoleArn; + /** + * True if notifications to the target are enabled. + */ + enabled?: Enabled; + } + export type AuditNotificationTargetConfigurations = {[key: string]: AuditNotificationTarget}; + export type AuditNotificationType = "SNS"|string; + export type AuditTaskId = string; + export interface AuditTaskMetadata { + /** + * The ID of this audit. + */ + taskId?: AuditTaskId; + /** + * The status of this audit: one of "IN_PROGRESS", "COMPLETED", "FAILED" or "CANCELED". + */ + taskStatus?: AuditTaskStatus; + /** + * The type of this audit: one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK". + */ + taskType?: AuditTaskType; + } + export type AuditTaskMetadataList = AuditTaskMetadata[]; + export type AuditTaskStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|string; + export type AuditTaskType = "ON_DEMAND_AUDIT_TASK"|"SCHEDULED_AUDIT_TASK"|string; + export type AuthDecision = "ALLOWED"|"EXPLICIT_DENY"|"IMPLICIT_DENY"|string; + export interface AuthInfo { + /** + * The type of action for which the principal is being authorized. + */ + actionType?: ActionType; + /** + * The resources for which the principal is being authorized to perform the specified action. + */ + resources?: Resources; + } + export type AuthInfos = AuthInfo[]; + export interface AuthResult { + /** + * Authorization information. + */ + authInfo?: AuthInfo; + /** + * The policies and statements that allowed the specified action. + */ + allowed?: Allowed; + /** + * The policies and statements that denied the specified action. + */ + denied?: Denied; + /** + * The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements. + */ + authDecision?: AuthDecision; + /** + * Contains any missing context values found while evaluating policy. + */ + missingContextValues?: MissingContextValues; + } + export type AuthResults = AuthResult[]; + export type AuthorizerArn = string; + export interface AuthorizerDescription { + /** + * The authorizer name. + */ + authorizerName?: AuthorizerName; + /** + * The authorizer ARN. + */ + authorizerArn?: AuthorizerArn; + /** + * The authorizer's Lambda function ARN. + */ + authorizerFunctionArn?: AuthorizerFunctionArn; + /** + * The key used to extract the token from the HTTP headers. + */ + tokenKeyName?: TokenKeyName; + /** + * The public keys used to validate the token signature returned by your custom authentication service. + */ + tokenSigningPublicKeys?: PublicKeyMap; + /** + * The status of the authorizer. + */ + status?: AuthorizerStatus; + /** + * The UNIX timestamp of when the authorizer was created. + */ + creationDate?: DateType; + /** + * The UNIX timestamp of when the authorizer was last updated. + */ + lastModifiedDate?: DateType; + } + export type AuthorizerFunctionArn = string; + export type AuthorizerName = string; + export type AuthorizerStatus = "ACTIVE"|"INACTIVE"|string; + export interface AuthorizerSummary { + /** + * The authorizer name. + */ + authorizerName?: AuthorizerName; + /** + * The authorizer ARN. + */ + authorizerArn?: AuthorizerArn; + } + export type Authorizers = AuthorizerSummary[]; + export type AutoRegistrationStatus = "ENABLE"|"DISABLE"|string; + export type AwsAccountId = string; + export type AwsArn = string; + export type AwsIotJobArn = string; + export type AwsIotJobId = string; + export type AwsIotSqlVersion = string; + export interface AwsJobExecutionsRolloutConfig { + /** + * The maximum number of OTA update job executions started per minute. + */ + maximumPerMinute?: MaximumPerMinute; + } + export interface Behavior { + /** + * The name you have given to the behavior. + */ + name: BehaviorName; + /** + * What is measured by the behavior. + */ + metric?: BehaviorMetric; + /** + * The criteria that determine if a device is behaving normally in regard to the metric. + */ + criteria?: BehaviorCriteria; + } + export interface BehaviorCriteria { + /** + * The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). + */ + comparisonOperator?: ComparisonOperator; + /** + * The value to be compared with the metric. + */ + value?: MetricValue; + /** + * Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. + */ + durationSeconds?: DurationSeconds; + /** + * If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1. + */ + consecutiveDatapointsToAlarm?: ConsecutiveDatapointsToAlarm; + /** + * If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1. + */ + consecutiveDatapointsToClear?: ConsecutiveDatapointsToClear; + /** + * A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior. + */ + statisticalThreshold?: StatisticalThreshold; + } + export type BehaviorMetric = string; + export type BehaviorName = string; + export type Behaviors = Behavior[]; + export type BillingGroupArn = string; + export type BillingGroupDescription = string; + export type BillingGroupId = string; + export interface BillingGroupMetadata { + /** + * The date the billing group was created. + */ + creationDate?: CreationDate; + } + export type BillingGroupName = string; + export type BillingGroupNameAndArnList = GroupNameAndArn[]; + export interface BillingGroupProperties { + /** + * The description of the billing group. + */ + billingGroupDescription?: BillingGroupDescription; + } + export type Boolean = boolean; + export type BucketName = string; + export interface CACertificate { + /** + * The ARN of the CA certificate. + */ + certificateArn?: CertificateArn; + /** + * The ID of the CA certificate. + */ + certificateId?: CertificateId; + /** + * The status of the CA certificate. The status value REGISTER_INACTIVE is deprecated and should not be used. + */ + status?: CACertificateStatus; + /** + * The date the CA certificate was created. + */ + creationDate?: DateType; + } + export interface CACertificateDescription { + /** + * The CA certificate ARN. + */ + certificateArn?: CertificateArn; + /** + * The CA certificate ID. + */ + certificateId?: CertificateId; + /** + * The status of a CA certificate. + */ + status?: CACertificateStatus; + /** + * The CA certificate data, in PEM format. + */ + certificatePem?: CertificatePem; + /** + * The owner of the CA certificate. + */ + ownedBy?: AwsAccountId; + /** + * The date the CA certificate was created. + */ + creationDate?: DateType; + /** + * Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE" + */ + autoRegistrationStatus?: AutoRegistrationStatus; + /** + * The date the CA certificate was last modified. + */ + lastModifiedDate?: DateType; + /** + * The customer version of the CA certificate. + */ + customerVersion?: CustomerVersion; + /** + * The generation ID of the CA certificate. + */ + generationId?: GenerationId; + /** + * When the CA certificate is valid. + */ + validity?: CertificateValidity; + } + export type CACertificateStatus = "ACTIVE"|"INACTIVE"|string; + export type CACertificates = CACertificate[]; + export interface CancelAuditTaskRequest { + /** + * The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS". + */ + taskId: AuditTaskId; + } + export interface CancelAuditTaskResponse { + } + export interface CancelCertificateTransferRequest { + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + } + export interface CancelJobExecutionRequest { + /** + * The ID of the job to be canceled. + */ + jobId: JobId; + /** + * The name of the thing whose execution of the job will be canceled. + */ + thingName: ThingName; + /** + * (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false. Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state. + */ + force?: ForceFlag; + /** + * (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.) + */ + expectedVersion?: ExpectedVersion; + /** + * A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs. + */ + statusDetails?: DetailsMap; + } + export interface CancelJobRequest { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId: JobId; + /** + * (Optional)A reason code string that explains why the job was canceled. + */ + reasonCode?: ReasonCode; + /** + * An optional comment string describing why the job was canceled. + */ + comment?: Comment; + /** + * (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false. Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state. + */ + force?: ForceFlag; + } + export interface CancelJobResponse { + /** + * The job ARN. + */ + jobArn?: JobArn; + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId?: JobId; + /** + * A short text description of the job. + */ + description?: JobDescription; + } + export type CanceledChecksCount = number; + export type CanceledThings = number; + export type CannedAccessControlList = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"log-delivery-write"|string; + export interface Certificate { + /** + * The ARN of the certificate. + */ + certificateArn?: CertificateArn; + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId?: CertificateId; + /** + * The status of the certificate. The status value REGISTER_INACTIVE is deprecated and should not be used. + */ + status?: CertificateStatus; + /** + * The date and time the certificate was created. + */ + creationDate?: DateType; + } + export type CertificateArn = string; + export interface CertificateDescription { + /** + * The ARN of the certificate. + */ + certificateArn?: CertificateArn; + /** + * The ID of the certificate. + */ + certificateId?: CertificateId; + /** + * The certificate ID of the CA certificate used to sign this certificate. + */ + caCertificateId?: CertificateId; + /** + * The status of the certificate. + */ + status?: CertificateStatus; + /** + * The certificate data, in PEM format. + */ + certificatePem?: CertificatePem; + /** + * The ID of the AWS account that owns the certificate. + */ + ownedBy?: AwsAccountId; + /** + * The ID of the AWS account of the previous owner of the certificate. + */ + previousOwnedBy?: AwsAccountId; + /** + * The date and time the certificate was created. + */ + creationDate?: DateType; + /** + * The date and time the certificate was last modified. + */ + lastModifiedDate?: DateType; + /** + * The customer version of the certificate. + */ + customerVersion?: CustomerVersion; + /** + * The transfer data. + */ + transferData?: TransferData; + /** + * The generation ID of the certificate. + */ + generationId?: GenerationId; + /** + * When the certificate is valid. + */ + validity?: CertificateValidity; + } + export type CertificateId = string; + export type CertificateName = string; + export type CertificatePathOnDevice = string; + export type CertificatePem = string; + export type CertificateSigningRequest = string; + export type CertificateStatus = "ACTIVE"|"INACTIVE"|"REVOKED"|"PENDING_TRANSFER"|"REGISTER_INACTIVE"|"PENDING_ACTIVATION"|string; + export interface CertificateValidity { + /** + * The certificate is not valid before this date. + */ + notBefore?: DateType; + /** + * The certificate is not valid after this date. + */ + notAfter?: DateType; + } + export type Certificates = Certificate[]; + export type ChannelName = string; + export type CheckCompliant = boolean; + export type Cidr = string; + export type Cidrs = Cidr[]; + export interface ClearDefaultAuthorizerRequest { + } + export interface ClearDefaultAuthorizerResponse { + } + export type ClientId = string; + export interface CloudwatchAlarmAction { + /** + * The IAM role that allows access to the CloudWatch alarm. + */ + roleArn: AwsArn; + /** + * The CloudWatch alarm name. + */ + alarmName: AlarmName; + /** + * The reason for the alarm change. + */ + stateReason: StateReason; + /** + * The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA. + */ + stateValue: StateValue; + } + export interface CloudwatchMetricAction { + /** + * The IAM role that allows access to the CloudWatch metric. + */ + roleArn: AwsArn; + /** + * The CloudWatch metric namespace name. + */ + metricNamespace: String; + /** + * The CloudWatch metric name. + */ + metricName: String; + /** + * The CloudWatch metric value. + */ + metricValue: String; + /** + * The metric unit supported by CloudWatch. + */ + metricUnit: String; + /** + * An optional Unix timestamp. + */ + metricTimestamp?: String; + } + export type Code = string; + export interface CodeSigning { + /** + * The ID of the AWSSignerJob which was created to sign the file. + */ + awsSignerJobId?: SigningJobId; + /** + * Describes the code-signing job. + */ + startSigningJobParameter?: StartSigningJobParameter; + /** + * A custom method for code signing a file. + */ + customCodeSigning?: CustomCodeSigning; + } + export interface CodeSigningCertificateChain { + /** + * The name of the certificate. + */ + certificateName?: CertificateName; + /** + * A base64 encoded binary representation of the code signing certificate chain. + */ + inlineDocument?: InlineDocument; + } + export interface CodeSigningSignature { + /** + * A base64 encoded binary representation of the code signing signature. + */ + inlineDocument?: Signature; + } + export type CognitoIdentityPoolId = string; + export type Comment = string; + export type ComparisonOperator = "less-than"|"less-than-equals"|"greater-than"|"greater-than-equals"|"in-cidr-set"|"not-in-cidr-set"|"in-port-set"|"not-in-port-set"|string; + export type CompliantChecksCount = number; + export interface Configuration { + /** + * True to enable the configuration. + */ + Enabled?: Enabled; + } + export type ConnectivityTimestamp = number; + export type ConsecutiveDatapointsToAlarm = number; + export type ConsecutiveDatapointsToClear = number; + export type Count = number; + export interface CreateAuthorizerRequest { + /** + * The authorizer name. + */ + authorizerName: AuthorizerName; + /** + * The ARN of the authorizer's Lambda function. + */ + authorizerFunctionArn: AuthorizerFunctionArn; + /** + * The name of the token key used to extract the token from the HTTP headers. + */ + tokenKeyName: TokenKeyName; + /** + * The public keys used to verify the digital signature returned by your custom authentication service. + */ + tokenSigningPublicKeys: PublicKeyMap; + /** + * The status of the create authorizer request. + */ + status?: AuthorizerStatus; + } + export interface CreateAuthorizerResponse { + /** + * The authorizer's name. + */ + authorizerName?: AuthorizerName; + /** + * The authorizer ARN. + */ + authorizerArn?: AuthorizerArn; + } + export interface CreateBillingGroupRequest { + /** + * The name you wish to give to the billing group. + */ + billingGroupName: BillingGroupName; + /** + * The properties of the billing group. + */ + billingGroupProperties?: BillingGroupProperties; + /** + * Metadata which can be used to manage the billing group. + */ + tags?: TagList; + } + export interface CreateBillingGroupResponse { + /** + * The name you gave to the billing group. + */ + billingGroupName?: BillingGroupName; + /** + * The ARN of the billing group. + */ + billingGroupArn?: BillingGroupArn; + /** + * The ID of the billing group. + */ + billingGroupId?: BillingGroupId; + } + export interface CreateCertificateFromCsrRequest { + /** + * The certificate signing request (CSR). + */ + certificateSigningRequest: CertificateSigningRequest; + /** + * Specifies whether the certificate is active. + */ + setAsActive?: SetAsActive; + } + export interface CreateCertificateFromCsrResponse { + /** + * The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations. + */ + certificateArn?: CertificateArn; + /** + * The ID of the certificate. Certificate management operations only take a certificateId. + */ + certificateId?: CertificateId; + /** + * The certificate data, in PEM format. + */ + certificatePem?: CertificatePem; + } + export interface CreateDynamicThingGroupRequest { + /** + * The dynamic thing group name to create. + */ + thingGroupName: ThingGroupName; + /** + * The dynamic thing group properties. + */ + thingGroupProperties?: ThingGroupProperties; + /** + * The dynamic thing group index name. Currently one index is supported: "AWS_Things". + */ + indexName?: IndexName; + /** + * The dynamic thing group search query string. See Query Syntax for information about query string syntax. + */ + queryString: QueryString; + /** + * The dynamic thing group query version. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value. + */ + queryVersion?: QueryVersion; + /** + * Metadata which can be used to manage the dynamic thing group. + */ + tags?: TagList; + } + export interface CreateDynamicThingGroupResponse { + /** + * The dynamic thing group name. + */ + thingGroupName?: ThingGroupName; + /** + * The dynamic thing group ARN. + */ + thingGroupArn?: ThingGroupArn; + /** + * The dynamic thing group ID. + */ + thingGroupId?: ThingGroupId; + /** + * The dynamic thing group index name. + */ + indexName?: IndexName; + /** + * The dynamic thing group search query string. + */ + queryString?: QueryString; + /** + * The dynamic thing group query version. + */ + queryVersion?: QueryVersion; + } + export interface CreateJobRequest { + /** + * A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here. + */ + jobId: JobId; + /** + * A list of things and thing groups to which the job should be sent. + */ + targets: JobTargets; + /** + * An S3 link to the job document. + */ + documentSource?: JobDocumentSource; + /** + * The job document. If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking. + */ + document?: JobDocument; + /** + * A short text description of the job. + */ + description?: JobDescription; + /** + * Configuration information for pre-signed S3 URLs. + */ + presignedUrlConfig?: PresignedUrlConfig; + /** + * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group. + */ + targetSelection?: TargetSelection; + /** + * Allows you to create a staged rollout of the job. + */ + jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig; + /** + * Allows you to create criteria to abort a job. + */ + abortConfig?: AbortConfig; + /** + * Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT. + */ + timeoutConfig?: TimeoutConfig; + /** + * Metadata which can be used to manage the job. + */ + tags?: TagList; + } + export interface CreateJobResponse { + /** + * The job ARN. + */ + jobArn?: JobArn; + /** + * The unique identifier you assigned to this job. + */ + jobId?: JobId; + /** + * The job description. + */ + description?: JobDescription; + } + export interface CreateKeysAndCertificateRequest { + /** + * Specifies whether the certificate is active. + */ + setAsActive?: SetAsActive; + } + export interface CreateKeysAndCertificateResponse { + /** + * The ARN of the certificate. + */ + certificateArn?: CertificateArn; + /** + * The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate). + */ + certificateId?: CertificateId; + /** + * The certificate data, in PEM format. + */ + certificatePem?: CertificatePem; + /** + * The generated key pair. + */ + keyPair?: KeyPair; + } + export interface CreateOTAUpdateRequest { + /** + * The ID of the OTA update to be created. + */ + otaUpdateId: OTAUpdateId; + /** + * The description of the OTA update. + */ + description?: OTAUpdateDescription; + /** + * The targeted devices to receive OTA updates. + */ + targets: Targets; + /** + * Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT. + */ + targetSelection?: TargetSelection; + /** + * Configuration for the rollout of OTA updates. + */ + awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig; + /** + * The files to be streamed by the OTA update. + */ + files: OTAUpdateFiles; + /** + * The IAM role that allows access to the AWS IoT Jobs service. + */ + roleArn: RoleArn; + /** + * A list of additional OTA update parameters which are name-value pairs. + */ + additionalParameters?: AdditionalParameterMap; + /** + * Metadata which can be used to manage updates. + */ + tags?: TagList; + } + export interface CreateOTAUpdateResponse { + /** + * The OTA update ID. + */ + otaUpdateId?: OTAUpdateId; + /** + * The AWS IoT job ID associated with the OTA update. + */ + awsIotJobId?: AwsIotJobId; + /** + * The OTA update ARN. + */ + otaUpdateArn?: OTAUpdateArn; + /** + * The AWS IoT job ARN associated with the OTA update. + */ + awsIotJobArn?: AwsIotJobArn; + /** + * The OTA update status. + */ + otaUpdateStatus?: OTAUpdateStatus; + } + export interface CreatePolicyRequest { + /** + * The policy name. + */ + policyName: PolicyName; + /** + * The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace. + */ + policyDocument: PolicyDocument; + } + export interface CreatePolicyResponse { + /** + * The policy name. + */ + policyName?: PolicyName; + /** + * The policy ARN. + */ + policyArn?: PolicyArn; + /** + * The JSON document that describes the policy. + */ + policyDocument?: PolicyDocument; + /** + * The policy version ID. + */ + policyVersionId?: PolicyVersionId; + } + export interface CreatePolicyVersionRequest { + /** + * The policy name. + */ + policyName: PolicyName; + /** + * The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace. + */ + policyDocument: PolicyDocument; + /** + * Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached). + */ + setAsDefault?: SetAsDefault; + } + export interface CreatePolicyVersionResponse { + /** + * The policy ARN. + */ + policyArn?: PolicyArn; + /** + * The JSON document that describes the policy. + */ + policyDocument?: PolicyDocument; + /** + * The policy version ID. + */ + policyVersionId?: PolicyVersionId; + /** + * Specifies whether the policy version is the default. + */ + isDefaultVersion?: IsDefaultVersion; + } + export interface CreateRoleAliasRequest { + /** + * The role alias that points to a role ARN. This allows you to change the role without having to update the device. + */ + roleAlias: RoleAlias; + /** + * The role ARN. + */ + roleArn: RoleArn; + /** + * How long (in seconds) the credentials will be valid. + */ + credentialDurationSeconds?: CredentialDurationSeconds; + } + export interface CreateRoleAliasResponse { + /** + * The role alias. + */ + roleAlias?: RoleAlias; + /** + * The role alias ARN. + */ + roleAliasArn?: RoleAliasArn; + } + export interface CreateScheduledAuditRequest { + /** + * How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system. + */ + frequency: AuditFrequency; + /** + * The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month. + */ + dayOfMonth?: DayOfMonth; + /** + * The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". + */ + dayOfWeek?: DayOfWeek; + /** + * Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.) + */ + targetCheckNames: TargetAuditCheckNames; + /** + * Metadata which can be used to manage the scheduled audit. + */ + tags?: TagList; + /** + * The name you want to give to the scheduled audit. (Max. 128 chars) + */ + scheduledAuditName: ScheduledAuditName; + } + export interface CreateScheduledAuditResponse { + /** + * The ARN of the scheduled audit. + */ + scheduledAuditArn?: ScheduledAuditArn; + } + export interface CreateSecurityProfileRequest { + /** + * The name you are giving to the security profile. + */ + securityProfileName: SecurityProfileName; + /** + * A description of the security profile. + */ + securityProfileDescription?: SecurityProfileDescription; + /** + * Specifies the behaviors that, when violated by a device (thing), cause an alert. + */ + behaviors?: Behaviors; + /** + * Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior. + */ + alertTargets?: AlertTargets; + /** + * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors but it is also retained for any metric specified here. + */ + additionalMetricsToRetain?: AdditionalMetricsToRetainList; + /** + * Metadata which can be used to manage the security profile. + */ + tags?: TagList; + } + export interface CreateSecurityProfileResponse { + /** + * The name you gave to the security profile. + */ + securityProfileName?: SecurityProfileName; + /** + * The ARN of the security profile. + */ + securityProfileArn?: SecurityProfileArn; + } + export interface CreateStreamRequest { + /** + * The stream ID. + */ + streamId: StreamId; + /** + * A description of the stream. + */ + description?: StreamDescription; + /** + * The files to stream. + */ + files: StreamFiles; + /** + * An IAM role that allows the IoT service principal assumes to access your S3 files. + */ + roleArn: RoleArn; + /** + * Metadata which can be used to manage streams. + */ + tags?: TagList; + } + export interface CreateStreamResponse { + /** + * The stream ID. + */ + streamId?: StreamId; + /** + * The stream ARN. + */ + streamArn?: StreamArn; + /** + * A description of the stream. + */ + description?: StreamDescription; + /** + * The version of the stream. + */ + streamVersion?: StreamVersion; + } + export interface CreateThingGroupRequest { + /** + * The thing group name to create. + */ + thingGroupName: ThingGroupName; + /** + * The name of the parent thing group. + */ + parentGroupName?: ThingGroupName; + /** + * The thing group properties. + */ + thingGroupProperties?: ThingGroupProperties; + /** + * Metadata which can be used to manage the thing group. + */ + tags?: TagList; + } + export interface CreateThingGroupResponse { + /** + * The thing group name. + */ + thingGroupName?: ThingGroupName; + /** + * The thing group ARN. + */ + thingGroupArn?: ThingGroupArn; + /** + * The thing group ID. + */ + thingGroupId?: ThingGroupId; + } + export interface CreateThingRequest { + /** + * The name of the thing to create. + */ + thingName: ThingName; + /** + * The name of the thing type associated with the new thing. + */ + thingTypeName?: ThingTypeName; + /** + * The attribute payload, which consists of up to three name/value pairs in a JSON document. For example: {\"attributes\":{\"string1\":\"string2\"}} + */ + attributePayload?: AttributePayload; + /** + * The name of the billing group the thing will be added to. + */ + billingGroupName?: BillingGroupName; + } + export interface CreateThingResponse { + /** + * The name of the new thing. + */ + thingName?: ThingName; + /** + * The ARN of the new thing. + */ + thingArn?: ThingArn; + /** + * The thing ID. + */ + thingId?: ThingId; + } + export interface CreateThingTypeRequest { + /** + * The name of the thing type. + */ + thingTypeName: ThingTypeName; + /** + * The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names. + */ + thingTypeProperties?: ThingTypeProperties; + /** + * Metadata which can be used to manage the thing type. + */ + tags?: TagList; + } + export interface CreateThingTypeResponse { + /** + * The name of the thing type. + */ + thingTypeName?: ThingTypeName; + /** + * The Amazon Resource Name (ARN) of the thing type. + */ + thingTypeArn?: ThingTypeArn; + /** + * The thing type ID. + */ + thingTypeId?: ThingTypeId; + } + export interface CreateTopicRuleRequest { + /** + * The name of the rule. + */ + ruleName: RuleName; + /** + * The rule payload. + */ + topicRulePayload: TopicRulePayload; + /** + * Metadata which can be used to manage the topic rule. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." + */ + tags?: String; + } + export type CreatedAtDate = Date; + export type CreationDate = Date; + export type CredentialDurationSeconds = number; + export interface CustomCodeSigning { + /** + * The signature for the file. + */ + signature?: CodeSigningSignature; + /** + * The certificate chain. + */ + certificateChain?: CodeSigningCertificateChain; + /** + * The hash algorithm used to code sign the file. + */ + hashAlgorithm?: HashAlgorithm; + /** + * The signature algorithm used to code sign the file. + */ + signatureAlgorithm?: SignatureAlgorithm; + } + export type CustomerVersion = number; + export type DateType = Date; + export type DayOfMonth = string; + export type DayOfWeek = "SUN"|"MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|string; + export interface DeleteAccountAuditConfigurationRequest { + /** + * If true, all scheduled audits are deleted. + */ + deleteScheduledAudits?: DeleteScheduledAudits; + } + export interface DeleteAccountAuditConfigurationResponse { + } + export type DeleteAdditionalMetricsToRetain = boolean; + export type DeleteAlertTargets = boolean; + export interface DeleteAuthorizerRequest { + /** + * The name of the authorizer to delete. + */ + authorizerName: AuthorizerName; + } + export interface DeleteAuthorizerResponse { + } + export type DeleteBehaviors = boolean; + export interface DeleteBillingGroupRequest { + /** + * The name of the billing group. + */ + billingGroupName: BillingGroupName; + /** + * The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException. + */ + expectedVersion?: OptionalVersion; + } + export interface DeleteBillingGroupResponse { + } + export interface DeleteCACertificateRequest { + /** + * The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + } + export interface DeleteCACertificateResponse { + } + export interface DeleteCertificateRequest { + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + /** + * Forces a certificate request to be deleted. + */ + forceDelete?: ForceDelete; + } + export interface DeleteDynamicThingGroupRequest { + /** + * The name of the dynamic thing group to delete. + */ + thingGroupName: ThingGroupName; + /** + * The expected version of the dynamic thing group to delete. + */ + expectedVersion?: OptionalVersion; + } + export interface DeleteDynamicThingGroupResponse { + } + export interface DeleteJobExecutionRequest { + /** + * The ID of the job whose execution on a particular device will be deleted. + */ + jobId: JobId; + /** + * The name of the thing whose job execution will be deleted. + */ + thingName: ThingName; + /** + * The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device. Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here. + */ + executionNumber: ExecutionNumber; + /** + * (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false. Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state. + */ + force?: ForceFlag; + } + export interface DeleteJobRequest { + /** + * The ID of the job to be deleted. After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job. + */ + jobId: JobId; + /** + * (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false. Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state. + */ + force?: ForceFlag; + } + export interface DeleteOTAUpdateRequest { + /** + * The OTA update ID to delete. + */ + otaUpdateId: OTAUpdateId; + /** + * Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted. + */ + deleteStream?: DeleteStream; + /** + * Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted. + */ + forceDeleteAWSJob?: ForceDeleteAWSJob; + } + export interface DeleteOTAUpdateResponse { + } + export interface DeletePolicyRequest { + /** + * The name of the policy to delete. + */ + policyName: PolicyName; + } + export interface DeletePolicyVersionRequest { + /** + * The name of the policy. + */ + policyName: PolicyName; + /** + * The policy version ID. + */ + policyVersionId: PolicyVersionId; + } + export interface DeleteRegistrationCodeRequest { + } + export interface DeleteRegistrationCodeResponse { + } + export interface DeleteRoleAliasRequest { + /** + * The role alias to delete. + */ + roleAlias: RoleAlias; + } + export interface DeleteRoleAliasResponse { + } + export interface DeleteScheduledAuditRequest { + /** + * The name of the scheduled audit you want to delete. + */ + scheduledAuditName: ScheduledAuditName; + } + export interface DeleteScheduledAuditResponse { + } + export type DeleteScheduledAudits = boolean; + export interface DeleteSecurityProfileRequest { + /** + * The name of the security profile to be deleted. + */ + securityProfileName: SecurityProfileName; + /** + * The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a VersionConflictException is thrown. + */ + expectedVersion?: OptionalVersion; + } + export interface DeleteSecurityProfileResponse { + } + export type DeleteStream = boolean; + export interface DeleteStreamRequest { + /** + * The stream ID. + */ + streamId: StreamId; + } + export interface DeleteStreamResponse { + } + export interface DeleteThingGroupRequest { + /** + * The name of the thing group to delete. + */ + thingGroupName: ThingGroupName; + /** + * The expected version of the thing group to delete. + */ + expectedVersion?: OptionalVersion; + } + export interface DeleteThingGroupResponse { + } + export interface DeleteThingRequest { + /** + * The name of the thing to delete. + */ + thingName: ThingName; + /** + * The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException. + */ + expectedVersion?: OptionalVersion; + } + export interface DeleteThingResponse { + } + export interface DeleteThingTypeRequest { + /** + * The name of the thing type. + */ + thingTypeName: ThingTypeName; + } + export interface DeleteThingTypeResponse { + } + export interface DeleteTopicRuleRequest { + /** + * The name of the rule. + */ + ruleName: RuleName; + } + export interface DeleteV2LoggingLevelRequest { + /** + * The type of resource for which you are configuring logging. Must be THING_Group. + */ + targetType: LogTargetType; + /** + * The name of the resource for which you are configuring logging. + */ + targetName: LogTargetName; + } + export type DeliveryStreamName = string; + export interface Denied { + /** + * Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny. + */ + implicitDeny?: ImplicitDeny; + /** + * Information that explicitly denies the authorization. + */ + explicitDeny?: ExplicitDeny; + } + export interface DeprecateThingTypeRequest { + /** + * The name of the thing type to deprecate. + */ + thingTypeName: ThingTypeName; + /** + * Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things. + */ + undoDeprecate?: UndoDeprecate; + } + export interface DeprecateThingTypeResponse { + } + export type DeprecationDate = Date; + export interface DescribeAccountAuditConfigurationRequest { + } + export interface DescribeAccountAuditConfigurationResponse { + /** + * The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit. On the first call to UpdateAccountAuditConfiguration this parameter is required. + */ + roleArn?: RoleArn; + /** + * Information about the targets to which audit notifications are sent for this account. + */ + auditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations; + /** + * Which audit checks are enabled and disabled for this account. + */ + auditCheckConfigurations?: AuditCheckConfigurations; + } + export interface DescribeAuditTaskRequest { + /** + * The ID of the audit whose information you want to get. + */ + taskId: AuditTaskId; + } + export interface DescribeAuditTaskResponse { + /** + * The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED". + */ + taskStatus?: AuditTaskStatus; + /** + * The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK". + */ + taskType?: AuditTaskType; + /** + * The time the audit started. + */ + taskStartTime?: Timestamp; + /** + * Statistical information about the audit. + */ + taskStatistics?: TaskStatistics; + /** + * The name of the scheduled audit (only if the audit was a scheduled audit). + */ + scheduledAuditName?: ScheduledAuditName; + /** + * Detailed information about each check performed during this audit. + */ + auditDetails?: AuditDetails; + } + export interface DescribeAuthorizerRequest { + /** + * The name of the authorizer to describe. + */ + authorizerName: AuthorizerName; + } + export interface DescribeAuthorizerResponse { + /** + * The authorizer description. + */ + authorizerDescription?: AuthorizerDescription; + } + export interface DescribeBillingGroupRequest { + /** + * The name of the billing group. + */ + billingGroupName: BillingGroupName; + } + export interface DescribeBillingGroupResponse { + /** + * The name of the billing group. + */ + billingGroupName?: BillingGroupName; + /** + * The ID of the billing group. + */ + billingGroupId?: BillingGroupId; + /** + * The ARN of the billing group. + */ + billingGroupArn?: BillingGroupArn; + /** + * The version of the billing group. + */ + version?: Version; + /** + * The properties of the billing group. + */ + billingGroupProperties?: BillingGroupProperties; + /** + * Additional information about the billing group. + */ + billingGroupMetadata?: BillingGroupMetadata; + } + export interface DescribeCACertificateRequest { + /** + * The CA certificate identifier. + */ + certificateId: CertificateId; + } + export interface DescribeCACertificateResponse { + /** + * The CA certificate description. + */ + certificateDescription?: CACertificateDescription; + /** + * Information about the registration configuration. + */ + registrationConfig?: RegistrationConfig; + } + export interface DescribeCertificateRequest { + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + } + export interface DescribeCertificateResponse { + /** + * The description of the certificate. + */ + certificateDescription?: CertificateDescription; + } + export interface DescribeDefaultAuthorizerRequest { + } + export interface DescribeDefaultAuthorizerResponse { + /** + * The default authorizer's description. + */ + authorizerDescription?: AuthorizerDescription; + } + export interface DescribeEndpointRequest { + /** + * The endpoint type. Valid endpoint types include: iot:Data - Returns a VeriSign signed data endpoint. iot:Data-ATS - Returns an ATS signed data endpoint. iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint. iot:Jobs - Returns an AWS IoT device management Jobs API endpoint. + */ + endpointType?: EndpointType; + } + export interface DescribeEndpointResponse { + /** + * The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com. + */ + endpointAddress?: EndpointAddress; + } + export interface DescribeEventConfigurationsRequest { + } + export interface DescribeEventConfigurationsResponse { + /** + * The event configurations. + */ + eventConfigurations?: EventConfigurations; + /** + * The creation date of the event configuration. + */ + creationDate?: CreationDate; + /** + * The date the event configurations were last modified. + */ + lastModifiedDate?: LastModifiedDate; + } + export interface DescribeIndexRequest { + /** + * The index name. + */ + indexName: IndexName; + } + export interface DescribeIndexResponse { + /** + * The index name. + */ + indexName?: IndexName; + /** + * The index status. + */ + indexStatus?: IndexStatus; + /** + * Contains a value that specifies the type of indexing performed. Valid values are: REGISTRY – Your thing index contains only registry data. REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data. REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data. REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data. + */ + schema?: IndexSchema; + } + export interface DescribeJobExecutionRequest { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId: JobId; + /** + * The name of the thing on which the job execution is running. + */ + thingName: ThingName; + /** + * A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device. + */ + executionNumber?: ExecutionNumber; + } + export interface DescribeJobExecutionResponse { + /** + * Information about the job execution. + */ + execution?: JobExecution; + } + export interface DescribeJobRequest { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId: JobId; + } + export interface DescribeJobResponse { + /** + * An S3 link to the job document. + */ + documentSource?: JobDocumentSource; + /** + * Information about the job. + */ + job?: Job; + } + export interface DescribeRoleAliasRequest { + /** + * The role alias to describe. + */ + roleAlias: RoleAlias; + } + export interface DescribeRoleAliasResponse { + /** + * The role alias description. + */ + roleAliasDescription?: RoleAliasDescription; + } + export interface DescribeScheduledAuditRequest { + /** + * The name of the scheduled audit whose information you want to get. + */ + scheduledAuditName: ScheduledAuditName; + } + export interface DescribeScheduledAuditResponse { + /** + * How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system. + */ + frequency?: AuditFrequency; + /** + * The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month. + */ + dayOfMonth?: DayOfMonth; + /** + * The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT". + */ + dayOfWeek?: DayOfWeek; + /** + * Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.) + */ + targetCheckNames?: TargetAuditCheckNames; + /** + * The name of the scheduled audit. + */ + scheduledAuditName?: ScheduledAuditName; + /** + * The ARN of the scheduled audit. + */ + scheduledAuditArn?: ScheduledAuditArn; + } + export interface DescribeSecurityProfileRequest { + /** + * The name of the security profile whose information you want to get. + */ + securityProfileName: SecurityProfileName; + } + export interface DescribeSecurityProfileResponse { + /** + * The name of the security profile. + */ + securityProfileName?: SecurityProfileName; + /** + * The ARN of the security profile. + */ + securityProfileArn?: SecurityProfileArn; + /** + * A description of the security profile (associated with the security profile when it was created or updated). + */ + securityProfileDescription?: SecurityProfileDescription; + /** + * Specifies the behaviors that, when violated by a device (thing), cause an alert. + */ + behaviors?: Behaviors; + /** + * Where the alerts are sent. (Alerts are always sent to the console.) + */ + alertTargets?: AlertTargets; + /** + * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors but it is also retained for any metric specified here. + */ + additionalMetricsToRetain?: AdditionalMetricsToRetainList; + /** + * The version of the security profile. A new version is generated whenever the security profile is updated. + */ + version?: Version; + /** + * The time the security profile was created. + */ + creationDate?: Timestamp; + /** + * The time the security profile was last modified. + */ + lastModifiedDate?: Timestamp; + } + export interface DescribeStreamRequest { + /** + * The stream ID. + */ + streamId: StreamId; + } + export interface DescribeStreamResponse { + /** + * Information about the stream. + */ + streamInfo?: StreamInfo; + } + export interface DescribeThingGroupRequest { + /** + * The name of the thing group. + */ + thingGroupName: ThingGroupName; + } + export interface DescribeThingGroupResponse { + /** + * The name of the thing group. + */ + thingGroupName?: ThingGroupName; + /** + * The thing group ID. + */ + thingGroupId?: ThingGroupId; + /** + * The thing group ARN. + */ + thingGroupArn?: ThingGroupArn; + /** + * The version of the thing group. + */ + version?: Version; + /** + * The thing group properties. + */ + thingGroupProperties?: ThingGroupProperties; + /** + * Thing group metadata. + */ + thingGroupMetadata?: ThingGroupMetadata; + /** + * The dynamic thing group index name. + */ + indexName?: IndexName; + /** + * The dynamic thing group search query string. + */ + queryString?: QueryString; + /** + * The dynamic thing group query version. + */ + queryVersion?: QueryVersion; + /** + * The dynamic thing group status. + */ + status?: DynamicGroupStatus; + } + export interface DescribeThingRegistrationTaskRequest { + /** + * The task ID. + */ + taskId: TaskId; + } + export interface DescribeThingRegistrationTaskResponse { + /** + * The task ID. + */ + taskId?: TaskId; + /** + * The task creation date. + */ + creationDate?: CreationDate; + /** + * The date when the task was last modified. + */ + lastModifiedDate?: LastModifiedDate; + /** + * The task's template. + */ + templateBody?: TemplateBody; + /** + * The S3 bucket that contains the input file. + */ + inputFileBucket?: RegistryS3BucketName; + /** + * The input file key. + */ + inputFileKey?: RegistryS3KeyName; + /** + * The role ARN that grants access to the input file bucket. + */ + roleArn?: RoleArn; + /** + * The status of the bulk thing provisioning task. + */ + status?: Status; + /** + * The message. + */ + message?: ErrorMessage; + /** + * The number of things successfully provisioned. + */ + successCount?: Count; + /** + * The number of things that failed to be provisioned. + */ + failureCount?: Count; + /** + * The progress of the bulk provisioning task expressed as a percentage. + */ + percentageProgress?: Percentage; + } + export interface DescribeThingRequest { + /** + * The name of the thing. + */ + thingName: ThingName; + } + export interface DescribeThingResponse { + /** + * The default client ID. + */ + defaultClientId?: ClientId; + /** + * The name of the thing. + */ + thingName?: ThingName; + /** + * The ID of the thing to describe. + */ + thingId?: ThingId; + /** + * The ARN of the thing to describe. + */ + thingArn?: ThingArn; + /** + * The thing type name. + */ + thingTypeName?: ThingTypeName; + /** + * The thing attributes. + */ + attributes?: Attributes; + /** + * The current version of the thing record in the registry. To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls. + */ + version?: Version; + /** + * The name of the billing group the thing belongs to. + */ + billingGroupName?: BillingGroupName; + } + export interface DescribeThingTypeRequest { + /** + * The name of the thing type. + */ + thingTypeName: ThingTypeName; + } + export interface DescribeThingTypeResponse { + /** + * The name of the thing type. + */ + thingTypeName?: ThingTypeName; + /** + * The thing type ID. + */ + thingTypeId?: ThingTypeId; + /** + * The thing type ARN. + */ + thingTypeArn?: ThingTypeArn; + /** + * The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names. + */ + thingTypeProperties?: ThingTypeProperties; + /** + * The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated. + */ + thingTypeMetadata?: ThingTypeMetadata; + } + export type Description = string; + export interface Destination { + /** + * Describes the location in S3 of the updated firmware. + */ + s3Destination?: S3Destination; + } + export interface DetachPolicyRequest { + /** + * The policy to detach. + */ + policyName: PolicyName; + /** + * The target from which the policy will be detached. + */ + target: PolicyTarget; + } + export interface DetachPrincipalPolicyRequest { + /** + * The name of the policy to detach. + */ + policyName: PolicyName; + /** + * The principal. If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID. + */ + principal: Principal; + } + export interface DetachSecurityProfileRequest { + /** + * The security profile that is detached. + */ + securityProfileName: SecurityProfileName; + /** + * The ARN of the thing group from which the security profile is detached. + */ + securityProfileTargetArn: SecurityProfileTargetArn; + } + export interface DetachSecurityProfileResponse { + } + export interface DetachThingPrincipalRequest { + /** + * The name of the thing. + */ + thingName: ThingName; + /** + * If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity. + */ + principal: Principal; + } + export interface DetachThingPrincipalResponse { + } + export type DetailsKey = string; + export type DetailsMap = {[key: string]: DetailsValue}; + export type DetailsValue = string; + export type DisableAllLogs = boolean; + export interface DisableTopicRuleRequest { + /** + * The name of the rule to disable. + */ + ruleName: RuleName; + } + export type DurationSeconds = number; + export type DynamicGroupStatus = "ACTIVE"|"BUILDING"|"REBUILDING"|string; + export interface DynamoDBAction { + /** + * The name of the DynamoDB table. + */ + tableName: TableName; + /** + * The ARN of the IAM role that grants access to the DynamoDB table. + */ + roleArn: AwsArn; + /** + * The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE. + */ + operation?: DynamoOperation; + /** + * The hash key name. + */ + hashKeyField: HashKeyField; + /** + * The hash key value. + */ + hashKeyValue: HashKeyValue; + /** + * The hash key type. Valid values are "STRING" or "NUMBER" + */ + hashKeyType?: DynamoKeyType; + /** + * The range key name. + */ + rangeKeyField?: RangeKeyField; + /** + * The range key value. + */ + rangeKeyValue?: RangeKeyValue; + /** + * The range key type. Valid values are "STRING" or "NUMBER" + */ + rangeKeyType?: DynamoKeyType; + /** + * The action payload. This name can be customized. + */ + payloadField?: PayloadField; + } + export interface DynamoDBv2Action { + /** + * The ARN of the IAM role that grants access to the DynamoDB table. + */ + roleArn: AwsArn; + /** + * Specifies the DynamoDB table to which the message data will be written. For example: { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } } Each attribute in the message payload will be written to a separate column in the DynamoDB database. + */ + putItem: PutItemInput; + } + export type DynamoKeyType = "STRING"|"NUMBER"|string; + export type DynamoOperation = string; + export type EffectivePolicies = EffectivePolicy[]; + export interface EffectivePolicy { + /** + * The policy name. + */ + policyName?: PolicyName; + /** + * The policy ARN. + */ + policyArn?: PolicyArn; + /** + * The IAM policy document. + */ + policyDocument?: PolicyDocument; + } + export interface ElasticsearchAction { + /** + * The IAM role ARN that has access to Elasticsearch. + */ + roleArn: AwsArn; + /** + * The endpoint of your Elasticsearch domain. + */ + endpoint: ElasticsearchEndpoint; + /** + * The Elasticsearch index where you want to store your data. + */ + index: ElasticsearchIndex; + /** + * The type of document you are storing. + */ + type: ElasticsearchType; + /** + * The unique identifier for the document you are storing. + */ + id: ElasticsearchId; + } + export type ElasticsearchEndpoint = string; + export type ElasticsearchId = string; + export type ElasticsearchIndex = string; + export type ElasticsearchType = string; + export interface EnableTopicRuleRequest { + /** + * The name of the topic rule to enable. + */ + ruleName: RuleName; + } + export type Enabled = boolean; + export type EndpointAddress = string; + export type EndpointType = string; + export type ErrorCode = string; + export interface ErrorInfo { + /** + * The error code. + */ + code?: Code; + /** + * The error message. + */ + message?: OTAUpdateErrorMessage; + } + export type ErrorMessage = string; + export type EvaluationStatistic = string; + export type EventConfigurations = {[key: string]: Configuration}; + export type EventType = "THING"|"THING_GROUP"|"THING_TYPE"|"THING_GROUP_MEMBERSHIP"|"THING_GROUP_HIERARCHY"|"THING_TYPE_ASSOCIATION"|"JOB"|"JOB_EXECUTION"|"POLICY"|"CERTIFICATE"|"CA_CERTIFICATE"|string; + export type ExecutionNamePrefix = string; + export type ExecutionNumber = number; + export type ExpectedVersion = number; + export type ExpiresInSec = number; + export interface ExplicitDeny { + /** + * The policies that denied the authorization. + */ + policies?: Policies; + } + export interface ExponentialRolloutRate { + /** + * The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout. + */ + baseRatePerMinute: RolloutRatePerMinute; + /** + * The exponential factor to increase the rate of rollout for a job. + */ + incrementFactor: IncrementFactor; + /** + * The criteria to initiate the increase in rate of rollout for a job. AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55). + */ + rateIncreaseCriteria: RateIncreaseCriteria; + } + export type FailedChecksCount = number; + export type FailedThings = number; + export type FileId = number; + export interface FileLocation { + /** + * The stream that contains the OTA update. + */ + stream?: Stream; + /** + * The location of the updated firmware in S3. + */ + s3Location?: S3Location; + } + export type FileName = string; + export interface FirehoseAction { + /** + * The IAM role that grants access to the Amazon Kinesis Firehose stream. + */ + roleArn: AwsArn; + /** + * The delivery stream name. + */ + deliveryStreamName: DeliveryStreamName; + /** + * A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). + */ + separator?: FirehoseSeparator; + } + export type FirehoseSeparator = string; + export type Flag = boolean; + export type ForceDelete = boolean; + export type ForceDeleteAWSJob = boolean; + export type ForceFlag = boolean; + export type Forced = boolean; + export type FunctionArn = string; + export type GEMaxResults = number; + export type GenerationId = string; + export interface GetEffectivePoliciesRequest { + /** + * The principal. + */ + principal?: Principal; + /** + * The Cognito identity pool ID. + */ + cognitoIdentityPoolId?: CognitoIdentityPoolId; + /** + * The thing name. + */ + thingName?: ThingName; + } + export interface GetEffectivePoliciesResponse { + /** + * The effective policies. + */ + effectivePolicies?: EffectivePolicies; + } + export interface GetIndexingConfigurationRequest { + } + export interface GetIndexingConfigurationResponse { + /** + * Thing indexing configuration. + */ + thingIndexingConfiguration?: ThingIndexingConfiguration; + /** + * The index configuration. + */ + thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration; + } + export interface GetJobDocumentRequest { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId: JobId; + } + export interface GetJobDocumentResponse { + /** + * The job document content. + */ + document?: JobDocument; + } + export interface GetLoggingOptionsRequest { + } + export interface GetLoggingOptionsResponse { + /** + * The ARN of the IAM role that grants access. + */ + roleArn?: AwsArn; + /** + * The logging level. + */ + logLevel?: LogLevel; + } + export interface GetOTAUpdateRequest { + /** + * The OTA update ID. + */ + otaUpdateId: OTAUpdateId; + } + export interface GetOTAUpdateResponse { + /** + * The OTA update info. + */ + otaUpdateInfo?: OTAUpdateInfo; + } + export interface GetPolicyRequest { + /** + * The name of the policy. + */ + policyName: PolicyName; + } + export interface GetPolicyResponse { + /** + * The policy name. + */ + policyName?: PolicyName; + /** + * The policy ARN. + */ + policyArn?: PolicyArn; + /** + * The JSON document that describes the policy. + */ + policyDocument?: PolicyDocument; + /** + * The default policy version ID. + */ + defaultVersionId?: PolicyVersionId; + /** + * The date the policy was created. + */ + creationDate?: DateType; + /** + * The date the policy was last modified. + */ + lastModifiedDate?: DateType; + /** + * The generation ID of the policy. + */ + generationId?: GenerationId; + } + export interface GetPolicyVersionRequest { + /** + * The name of the policy. + */ + policyName: PolicyName; + /** + * The policy version ID. + */ + policyVersionId: PolicyVersionId; + } + export interface GetPolicyVersionResponse { + /** + * The policy ARN. + */ + policyArn?: PolicyArn; + /** + * The policy name. + */ + policyName?: PolicyName; + /** + * The JSON document that describes the policy. + */ + policyDocument?: PolicyDocument; + /** + * The policy version ID. + */ + policyVersionId?: PolicyVersionId; + /** + * Specifies whether the policy version is the default. + */ + isDefaultVersion?: IsDefaultVersion; + /** + * The date the policy version was created. + */ + creationDate?: DateType; + /** + * The date the policy version was last modified. + */ + lastModifiedDate?: DateType; + /** + * The generation ID of the policy version. + */ + generationId?: GenerationId; + } + export interface GetRegistrationCodeRequest { + } + export interface GetRegistrationCodeResponse { + /** + * The CA certificate registration code. + */ + registrationCode?: RegistrationCode; + } + export interface GetStatisticsRequest { + /** + * The name of the index to search. The default value is AWS_Things. + */ + indexName?: IndexName; + /** + * The query used to search. You can specify "*" for the query string to get the count of all indexed things in your AWS account. + */ + queryString: QueryString; + /** + * The aggregation field name. Currently not supported. + */ + aggregationField?: AggregationField; + /** + * The version of the query used to search. + */ + queryVersion?: QueryVersion; + } + export interface GetStatisticsResponse { + /** + * The statistics returned by the Fleet Indexing service based on the query and aggregation field. + */ + statistics?: Statistics; + } + export interface GetTopicRuleRequest { + /** + * The name of the rule. + */ + ruleName: RuleName; + } + export interface GetTopicRuleResponse { + /** + * The rule ARN. + */ + ruleArn?: RuleArn; + /** + * The rule. + */ + rule?: TopicRule; + } + export interface GetV2LoggingOptionsRequest { + } + export interface GetV2LoggingOptionsResponse { + /** + * The IAM role ARN AWS IoT uses to write to your CloudWatch logs. + */ + roleArn?: AwsArn; + /** + * The default log level. + */ + defaultLogLevel?: LogLevel; + /** + * Disables all logs. + */ + disableAllLogs?: DisableAllLogs; + } + export interface GroupNameAndArn { + /** + * The group name. + */ + groupName?: ThingGroupName; + /** + * The group ARN. + */ + groupArn?: ThingGroupArn; + } + export type HashAlgorithm = string; + export type HashKeyField = string; + export type HashKeyValue = string; + export interface ImplicitDeny { + /** + * Policies that don't contain a matching allow or deny statement for the specified action on the specified resource. + */ + policies?: Policies; + } + export type InProgressChecksCount = number; + export type InProgressThings = number; + export type InProgressTimeoutInMinutes = number; + export type IncrementFactor = number; + export type IndexName = string; + export type IndexNamesList = IndexName[]; + export type IndexSchema = string; + export type IndexStatus = "ACTIVE"|"BUILDING"|"REBUILDING"|string; + export type InlineDocument = string; + export type InputName = string; + export interface IotAnalyticsAction { + /** + * (deprecated) The ARN of the IoT Analytics channel to which message data will be sent. + */ + channelArn?: AwsArn; + /** + * The name of the IoT Analytics channel to which message data will be sent. + */ + channelName?: ChannelName; + /** + * The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage). + */ + roleArn?: AwsArn; + } + export interface IotEventsAction { + /** + * The name of the AWS IoT Events input. + */ + inputName: InputName; + /** + * [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector. + */ + messageId?: MessageId; + /** + * The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage"). + */ + roleArn: AwsArn; + } + export type IsAuthenticated = boolean; + export type IsDefaultVersion = boolean; + export type IsDisabled = boolean; + export interface Job { + /** + * An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId". + */ + jobArn?: JobArn; + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId?: JobId; + /** + * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group. + */ + targetSelection?: TargetSelection; + /** + * The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED. + */ + status?: JobStatus; + /** + * Will be true if the job was canceled with the optional force parameter set to true. + */ + forceCanceled?: Forced; + /** + * If the job was updated, provides the reason code for the update. + */ + reasonCode?: ReasonCode; + /** + * If the job was updated, describes the reason for the update. + */ + comment?: Comment; + /** + * A list of IoT things and thing groups to which the job should be sent. + */ + targets?: JobTargets; + /** + * A short text description of the job. + */ + description?: JobDescription; + /** + * Configuration for pre-signed S3 URLs. + */ + presignedUrlConfig?: PresignedUrlConfig; + /** + * Allows you to create a staged rollout of a job. + */ + jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig; + /** + * Configuration for criteria to abort the job. + */ + abortConfig?: AbortConfig; + /** + * The time, in seconds since the epoch, when the job was created. + */ + createdAt?: DateType; + /** + * The time, in seconds since the epoch, when the job was last updated. + */ + lastUpdatedAt?: DateType; + /** + * The time, in seconds since the epoch, when the job was completed. + */ + completedAt?: DateType; + /** + * Details about the job process. + */ + jobProcessDetails?: JobProcessDetails; + /** + * Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT. + */ + timeoutConfig?: TimeoutConfig; + } + export type JobArn = string; + export type JobDescription = string; + export type JobDocument = string; + export type JobDocumentSource = string; + export interface JobExecution { + /** + * The unique identifier you assigned to the job when it was created. + */ + jobId?: JobId; + /** + * The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED). + */ + status?: JobExecutionStatus; + /** + * Will be true if the job execution was canceled with the optional force parameter set to true. + */ + forceCanceled?: Forced; + /** + * A collection of name/value pairs that describe the status of the job execution. + */ + statusDetails?: JobExecutionStatusDetails; + /** + * The ARN of the thing on which the job execution is running. + */ + thingArn?: ThingArn; + /** + * The time, in seconds since the epoch, when the job execution was queued. + */ + queuedAt?: DateType; + /** + * The time, in seconds since the epoch, when the job execution started. + */ + startedAt?: DateType; + /** + * The time, in seconds since the epoch, when the job execution was last updated. + */ + lastUpdatedAt?: DateType; + /** + * A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information. + */ + executionNumber?: ExecutionNumber; + /** + * The version of the job execution. Job execution versions are incremented each time they are updated by a device. + */ + versionNumber?: VersionNumber; + /** + * The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status. + */ + approximateSecondsBeforeTimedOut?: ApproximateSecondsBeforeTimedOut; + } + export type JobExecutionFailureType = "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL"|string; + export type JobExecutionStatus = "QUEUED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"REJECTED"|"REMOVED"|"CANCELED"|string; + export interface JobExecutionStatusDetails { + /** + * The job execution status. + */ + detailsMap?: DetailsMap; + } + export interface JobExecutionSummary { + /** + * The status of the job execution. + */ + status?: JobExecutionStatus; + /** + * The time, in seconds since the epoch, when the job execution was queued. + */ + queuedAt?: DateType; + /** + * The time, in seconds since the epoch, when the job execution started. + */ + startedAt?: DateType; + /** + * The time, in seconds since the epoch, when the job execution was last updated. + */ + lastUpdatedAt?: DateType; + /** + * A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information. + */ + executionNumber?: ExecutionNumber; + } + export interface JobExecutionSummaryForJob { + /** + * The ARN of the thing on which the job execution is running. + */ + thingArn?: ThingArn; + /** + * Contains a subset of information about a job execution. + */ + jobExecutionSummary?: JobExecutionSummary; + } + export type JobExecutionSummaryForJobList = JobExecutionSummaryForJob[]; + export interface JobExecutionSummaryForThing { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId?: JobId; + /** + * Contains a subset of information about a job execution. + */ + jobExecutionSummary?: JobExecutionSummary; + } + export type JobExecutionSummaryForThingList = JobExecutionSummaryForThing[]; + export interface JobExecutionsRolloutConfig { + /** + * The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout. + */ + maximumPerMinute?: MaxJobExecutionsPerMin; + /** + * The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout. + */ + exponentialRate?: ExponentialRolloutRate; + } + export type JobId = string; + export interface JobProcessDetails { + /** + * The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices. + */ + processingTargets?: ProcessingTargetNameList; + /** + * The number of things that cancelled the job. + */ + numberOfCanceledThings?: CanceledThings; + /** + * The number of things which successfully completed the job. + */ + numberOfSucceededThings?: SucceededThings; + /** + * The number of things that failed executing the job. + */ + numberOfFailedThings?: FailedThings; + /** + * The number of things that rejected the job. + */ + numberOfRejectedThings?: RejectedThings; + /** + * The number of things that are awaiting execution of the job. + */ + numberOfQueuedThings?: QueuedThings; + /** + * The number of things currently executing the job. + */ + numberOfInProgressThings?: InProgressThings; + /** + * The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job. + */ + numberOfRemovedThings?: RemovedThings; + /** + * The number of things whose job execution status is TIMED_OUT. + */ + numberOfTimedOutThings?: TimedOutThings; + } + export type JobStatus = "IN_PROGRESS"|"CANCELED"|"COMPLETED"|"DELETION_IN_PROGRESS"|string; + export interface JobSummary { + /** + * The job ARN. + */ + jobArn?: JobArn; + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId?: JobId; + /** + * The ID of the thing group. + */ + thingGroupId?: ThingGroupId; + /** + * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group. + */ + targetSelection?: TargetSelection; + /** + * The job summary status. + */ + status?: JobStatus; + /** + * The time, in seconds since the epoch, when the job was created. + */ + createdAt?: DateType; + /** + * The time, in seconds since the epoch, when the job was last updated. + */ + lastUpdatedAt?: DateType; + /** + * The time, in seconds since the epoch, when the job completed. + */ + completedAt?: DateType; + } + export type JobSummaryList = JobSummary[]; + export type JobTargets = TargetArn[]; + export type JsonDocument = string; + export type Key = string; + export type KeyName = string; + export interface KeyPair { + /** + * The public key. + */ + PublicKey?: PublicKey; + /** + * The private key. + */ + PrivateKey?: PrivateKey; + } + export type KeyValue = string; + export interface KinesisAction { + /** + * The ARN of the IAM role that grants access to the Amazon Kinesis stream. + */ + roleArn: AwsArn; + /** + * The name of the Amazon Kinesis stream. + */ + streamName: StreamName; + /** + * The partition key. + */ + partitionKey?: PartitionKey; + } + export interface LambdaAction { + /** + * The ARN of the Lambda function. + */ + functionArn: FunctionArn; + } + export type LaserMaxResults = number; + export type LastModifiedDate = Date; + export interface ListActiveViolationsRequest { + /** + * The name of the thing whose active violations are listed. + */ + thingName?: ThingName; + /** + * The name of the Device Defender security profile for which violations are listed. + */ + securityProfileName?: SecurityProfileName; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: MaxResults; + } + export interface ListActiveViolationsResponse { + /** + * The list of active violations. + */ + activeViolations?: ActiveViolations; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListAttachedPoliciesRequest { + /** + * The group for which the policies will be listed. + */ + target: PolicyTarget; + /** + * When true, recursively list attached policies. + */ + recursive?: Recursive; + /** + * The token to retrieve the next set of results. + */ + marker?: Marker; + /** + * The maximum number of results to be returned per request. + */ + pageSize?: PageSize; + } + export interface ListAttachedPoliciesResponse { + /** + * The policies. + */ + policies?: Policies; + /** + * The token to retrieve the next set of results, or ``null`` if there are no more results. + */ + nextMarker?: Marker; + } + export interface ListAuditFindingsRequest { + /** + * A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both. + */ + taskId?: AuditTaskId; + /** + * A filter to limit results to the findings for the specified audit check. + */ + checkName?: AuditCheckName; + /** + * Information identifying the non-compliant resource. + */ + resourceIdentifier?: ResourceIdentifier; + /** + * The maximum number of results to return at one time. The default is 25. + */ + maxResults?: MaxResults; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both. + */ + startTime?: Timestamp; + /** + * A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both. + */ + endTime?: Timestamp; + } + export interface ListAuditFindingsResponse { + /** + * The findings (results) of the audit. + */ + findings?: AuditFindings; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListAuditTasksRequest { + /** + * The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException". + */ + startTime: Timestamp; + /** + * The end of the time period. + */ + endTime: Timestamp; + /** + * A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK". + */ + taskType?: AuditTaskType; + /** + * A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED" or "CANCELED". + */ + taskStatus?: AuditTaskStatus; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. The default is 25. + */ + maxResults?: MaxResults; + } + export interface ListAuditTasksResponse { + /** + * The audits that were performed during the specified time period. + */ + tasks?: AuditTaskMetadataList; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListAuthorizersRequest { + /** + * The maximum number of results to return at one time. + */ + pageSize?: PageSize; + /** + * A marker used to get the next set of results. + */ + marker?: Marker; + /** + * Return the list of authorizers in ascending alphabetical order. + */ + ascendingOrder?: AscendingOrder; + /** + * The status of the list authorizers request. + */ + status?: AuthorizerStatus; + } + export interface ListAuthorizersResponse { + /** + * The authorizers. + */ + authorizers?: Authorizers; + /** + * A marker used to get the next set of results. + */ + nextMarker?: Marker; + } + export interface ListBillingGroupsRequest { + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return per request. + */ + maxResults?: RegistryMaxResults; + /** + * Limit the results to billing groups whose names have the given prefix. + */ + namePrefixFilter?: BillingGroupName; + } + export interface ListBillingGroupsResponse { + /** + * The list of billing groups. + */ + billingGroups?: BillingGroupNameAndArnList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListCACertificatesRequest { + /** + * The result page size. + */ + pageSize?: PageSize; + /** + * The marker for the next set of results. + */ + marker?: Marker; + /** + * Determines the order of the results. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListCACertificatesResponse { + /** + * The CA certificates registered in your AWS account. + */ + certificates?: CACertificates; + /** + * The current position within the list of CA certificates. + */ + nextMarker?: Marker; + } + export interface ListCertificatesByCARequest { + /** + * The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate. + */ + caCertificateId: CertificateId; + /** + * The result page size. + */ + pageSize?: PageSize; + /** + * The marker for the next set of results. + */ + marker?: Marker; + /** + * Specifies the order for results. If True, the results are returned in ascending order, based on the creation date. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListCertificatesByCAResponse { + /** + * The device certificates signed by the specified CA certificate. + */ + certificates?: Certificates; + /** + * The marker for the next set of results, or null if there are no additional results. + */ + nextMarker?: Marker; + } + export interface ListCertificatesRequest { + /** + * The result page size. + */ + pageSize?: PageSize; + /** + * The marker for the next set of results. + */ + marker?: Marker; + /** + * Specifies the order for results. If True, the results are returned in ascending order, based on the creation date. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListCertificatesResponse { + /** + * The descriptions of the certificates. + */ + certificates?: Certificates; + /** + * The marker for the next set of results, or null if there are no additional results. + */ + nextMarker?: Marker; + } + export interface ListIndicesRequest { + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: QueryMaxResults; + } + export interface ListIndicesResponse { + /** + * The index names. + */ + indexNames?: IndexNamesList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListJobExecutionsForJobRequest { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId: JobId; + /** + * The status of the job. + */ + status?: JobExecutionStatus; + /** + * The maximum number of results to be returned per request. + */ + maxResults?: LaserMaxResults; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + } + export interface ListJobExecutionsForJobResponse { + /** + * A list of job execution summaries. + */ + executionSummaries?: JobExecutionSummaryForJobList; + /** + * The token for the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListJobExecutionsForThingRequest { + /** + * The thing name. + */ + thingName: ThingName; + /** + * An optional filter that lets you search for jobs that have the specified status. + */ + status?: JobExecutionStatus; + /** + * The maximum number of results to be returned per request. + */ + maxResults?: LaserMaxResults; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + } + export interface ListJobExecutionsForThingResponse { + /** + * A list of job execution summaries. + */ + executionSummaries?: JobExecutionSummaryForThingList; + /** + * The token for the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListJobsRequest { + /** + * An optional filter that lets you search for jobs that have the specified status. + */ + status?: JobStatus; + /** + * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group. + */ + targetSelection?: TargetSelection; + /** + * The maximum number of results to return per request. + */ + maxResults?: LaserMaxResults; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * A filter that limits the returned jobs to those for the specified group. + */ + thingGroupName?: ThingGroupName; + /** + * A filter that limits the returned jobs to those for the specified group. + */ + thingGroupId?: ThingGroupId; + } + export interface ListJobsResponse { + /** + * A list of jobs. + */ + jobs?: JobSummaryList; + /** + * The token for the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListOTAUpdatesRequest { + /** + * The maximum number of results to return at one time. + */ + maxResults?: MaxResults; + /** + * A token used to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The OTA update job status. + */ + otaUpdateStatus?: OTAUpdateStatus; + } + export interface ListOTAUpdatesResponse { + /** + * A list of OTA update jobs. + */ + otaUpdates?: OTAUpdatesSummary; + /** + * A token to use to get the next set of results. + */ + nextToken?: NextToken; + } + export interface ListOutgoingCertificatesRequest { + /** + * The result page size. + */ + pageSize?: PageSize; + /** + * The marker for the next set of results. + */ + marker?: Marker; + /** + * Specifies the order for results. If True, the results are returned in ascending order, based on the creation date. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListOutgoingCertificatesResponse { + /** + * The certificates that are being transferred but not yet accepted. + */ + outgoingCertificates?: OutgoingCertificates; + /** + * The marker for the next set of results. + */ + nextMarker?: Marker; + } + export interface ListPoliciesRequest { + /** + * The marker for the next set of results. + */ + marker?: Marker; + /** + * The result page size. + */ + pageSize?: PageSize; + /** + * Specifies the order for results. If true, the results are returned in ascending creation order. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListPoliciesResponse { + /** + * The descriptions of the policies. + */ + policies?: Policies; + /** + * The marker for the next set of results, or null if there are no additional results. + */ + nextMarker?: Marker; + } + export interface ListPolicyPrincipalsRequest { + /** + * The policy name. + */ + policyName: PolicyName; + /** + * The marker for the next set of results. + */ + marker?: Marker; + /** + * The result page size. + */ + pageSize?: PageSize; + /** + * Specifies the order for results. If true, the results are returned in ascending creation order. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListPolicyPrincipalsResponse { + /** + * The descriptions of the principals. + */ + principals?: Principals; + /** + * The marker for the next set of results, or null if there are no additional results. + */ + nextMarker?: Marker; + } + export interface ListPolicyVersionsRequest { + /** + * The policy name. + */ + policyName: PolicyName; + } + export interface ListPolicyVersionsResponse { + /** + * The policy versions. + */ + policyVersions?: PolicyVersions; + } + export interface ListPrincipalPoliciesRequest { + /** + * The principal. + */ + principal: Principal; + /** + * The marker for the next set of results. + */ + marker?: Marker; + /** + * The result page size. + */ + pageSize?: PageSize; + /** + * Specifies the order for results. If true, results are returned in ascending creation order. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListPrincipalPoliciesResponse { + /** + * The policies. + */ + policies?: Policies; + /** + * The marker for the next set of results, or null if there are no additional results. + */ + nextMarker?: Marker; + } + export interface ListPrincipalThingsRequest { + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this operation. + */ + maxResults?: RegistryMaxResults; + /** + * The principal. + */ + principal: Principal; + } + export interface ListPrincipalThingsResponse { + /** + * The things. + */ + things?: ThingNameList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListRoleAliasesRequest { + /** + * The maximum number of results to return at one time. + */ + pageSize?: PageSize; + /** + * A marker used to get the next set of results. + */ + marker?: Marker; + /** + * Return the list of role aliases in ascending alphabetical order. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListRoleAliasesResponse { + /** + * The role aliases. + */ + roleAliases?: RoleAliases; + /** + * A marker used to get the next set of results. + */ + nextMarker?: Marker; + } + export interface ListScheduledAuditsRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. The default is 25. + */ + maxResults?: MaxResults; + } + export interface ListScheduledAuditsResponse { + /** + * The list of scheduled audits. + */ + scheduledAudits?: ScheduledAuditMetadataList; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListSecurityProfilesForTargetRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: MaxResults; + /** + * If true, return child groups as well. + */ + recursive?: Recursive; + /** + * The ARN of the target (thing group) whose attached security profiles you want to get. + */ + securityProfileTargetArn: SecurityProfileTargetArn; + } + export interface ListSecurityProfilesForTargetResponse { + /** + * A list of security profiles and their associated targets. + */ + securityProfileTargetMappings?: SecurityProfileTargetMappings; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListSecurityProfilesRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: MaxResults; + } + export interface ListSecurityProfilesResponse { + /** + * A list of security profile identifiers (names and ARNs). + */ + securityProfileIdentifiers?: SecurityProfileIdentifiers; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListStreamsRequest { + /** + * The maximum number of results to return at a time. + */ + maxResults?: MaxResults; + /** + * A token used to get the next set of results. + */ + nextToken?: NextToken; + /** + * Set to true to return the list of streams in ascending order. + */ + ascendingOrder?: AscendingOrder; + } + export interface ListStreamsResponse { + /** + * A list of streams. + */ + streams?: StreamsSummary; + /** + * A token used to get the next set of results. + */ + nextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The ARN of the resource. + */ + resourceArn: ResourceArn; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + } + export interface ListTagsForResourceResponse { + /** + * The list of tags assigned to the resource. + */ + tags?: TagList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListTargetsForPolicyRequest { + /** + * The policy name. + */ + policyName: PolicyName; + /** + * A marker used to get the next set of results. + */ + marker?: Marker; + /** + * The maximum number of results to return at one time. + */ + pageSize?: PageSize; + } + export interface ListTargetsForPolicyResponse { + /** + * The policy targets. + */ + targets?: PolicyTargets; + /** + * A marker used to get the next set of results. + */ + nextMarker?: Marker; + } + export interface ListTargetsForSecurityProfileRequest { + /** + * The security profile. + */ + securityProfileName: SecurityProfileName; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: MaxResults; + } + export interface ListTargetsForSecurityProfileResponse { + /** + * The thing groups to which the security profile is attached. + */ + securityProfileTargets?: SecurityProfileTargets; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingGroupsForThingRequest { + /** + * The thing name. + */ + thingName: ThingName; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: RegistryMaxResults; + } + export interface ListThingGroupsForThingResponse { + /** + * The thing groups. + */ + thingGroups?: ThingGroupNameAndArnList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingGroupsRequest { + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: RegistryMaxResults; + /** + * A filter that limits the results to those with the specified parent group. + */ + parentGroup?: ThingGroupName; + /** + * A filter that limits the results to those with the specified name prefix. + */ + namePrefixFilter?: ThingGroupName; + /** + * If true, return child groups as well. + */ + recursive?: RecursiveWithoutDefault; + } + export interface ListThingGroupsResponse { + /** + * The thing groups. + */ + thingGroups?: ThingGroupNameAndArnList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingPrincipalsRequest { + /** + * The name of the thing. + */ + thingName: ThingName; + } + export interface ListThingPrincipalsResponse { + /** + * The principals associated with the thing. + */ + principals?: Principals; + } + export interface ListThingRegistrationTaskReportsRequest { + /** + * The id of the task. + */ + taskId: TaskId; + /** + * The type of task report. + */ + reportType: ReportType; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return per request. + */ + maxResults?: RegistryMaxResults; + } + export interface ListThingRegistrationTaskReportsResponse { + /** + * Links to the task resources. + */ + resourceLinks?: S3FileUrlList; + /** + * The type of task report. + */ + reportType?: ReportType; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingRegistrationTasksRequest { + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: RegistryMaxResults; + /** + * The status of the bulk thing provisioning task. + */ + status?: Status; + } + export interface ListThingRegistrationTasksResponse { + /** + * A list of bulk thing provisioning task IDs. + */ + taskIds?: TaskIdList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingTypesRequest { + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this operation. + */ + maxResults?: RegistryMaxResults; + /** + * The name of the thing type. + */ + thingTypeName?: ThingTypeName; + } + export interface ListThingTypesResponse { + /** + * The thing types. + */ + thingTypes?: ThingTypeList; + /** + * The token for the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingsInBillingGroupRequest { + /** + * The name of the billing group. + */ + billingGroupName: BillingGroupName; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return per request. + */ + maxResults?: RegistryMaxResults; + } + export interface ListThingsInBillingGroupResponse { + /** + * A list of things in the billing group. + */ + things?: ThingNameList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingsInThingGroupRequest { + /** + * The thing group name. + */ + thingGroupName: ThingGroupName; + /** + * When true, list things in this thing group and in all child groups as well. + */ + recursive?: Recursive; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: RegistryMaxResults; + } + export interface ListThingsInThingGroupResponse { + /** + * The things in the specified thing group. + */ + things?: ThingNameList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListThingsRequest { + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this operation. + */ + maxResults?: RegistryMaxResults; + /** + * The attribute name used to search for things. + */ + attributeName?: AttributeName; + /** + * The attribute value used to search for things. + */ + attributeValue?: AttributeValue; + /** + * The name of the thing type used to search for things. + */ + thingTypeName?: ThingTypeName; + } + export interface ListThingsResponse { + /** + * The things. + */ + things?: ThingAttributeList; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListTopicRulesRequest { + /** + * The topic. + */ + topic?: Topic; + /** + * The maximum number of results to return. + */ + maxResults?: GEMaxResults; + /** + * A token used to retrieve the next value. + */ + nextToken?: NextToken; + /** + * Specifies whether the rule is disabled. + */ + ruleDisabled?: IsDisabled; + } + export interface ListTopicRulesResponse { + /** + * The rules. + */ + rules?: TopicRuleList; + /** + * A token used to retrieve the next value. + */ + nextToken?: NextToken; + } + export interface ListV2LoggingLevelsRequest { + /** + * The type of resource for which you are configuring logging. Must be THING_Group. + */ + targetType?: LogTargetType; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: SkyfallMaxResults; + } + export interface ListV2LoggingLevelsResponse { + /** + * The logging configuration for a target. + */ + logTargetConfigurations?: LogTargetConfigurations; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export interface ListViolationEventsRequest { + /** + * The start time for the alerts to be listed. + */ + startTime: Timestamp; + /** + * The end time for the alerts to be listed. + */ + endTime: Timestamp; + /** + * A filter to limit results to those alerts caused by the specified thing. + */ + thingName?: ThingName; + /** + * A filter to limit results to those alerts generated by the specified security profile. + */ + securityProfileName?: SecurityProfileName; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: MaxResults; + } + export interface ListViolationEventsResponse { + /** + * The security profile violation alerts issued for this account during the given time frame, potentially filtered by security profile, behavior violated, or thing (device) violating. + */ + violationEvents?: ViolationEvents; + /** + * A token that can be used to retrieve the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + } + export type LogLevel = "DEBUG"|"INFO"|"ERROR"|"WARN"|"DISABLED"|string; + export interface LogTarget { + /** + * The target type. + */ + targetType: LogTargetType; + /** + * The target name. + */ + targetName?: LogTargetName; + } + export interface LogTargetConfiguration { + /** + * A log target + */ + logTarget?: LogTarget; + /** + * The logging level. + */ + logLevel?: LogLevel; + } + export type LogTargetConfigurations = LogTargetConfiguration[]; + export type LogTargetName = string; + export type LogTargetType = "DEFAULT"|"THING_GROUP"|string; + export interface LoggingOptionsPayload { + /** + * The ARN of the IAM role that grants access. + */ + roleArn: AwsArn; + /** + * The log level. + */ + logLevel?: LogLevel; + } + export type Marker = string; + export type MaxJobExecutionsPerMin = number; + export type MaxResults = number; + export type MaximumPerMinute = number; + export type Message = string; + export type MessageFormat = "RAW"|"JSON"|string; + export type MessageId = string; + export interface MetricValue { + /** + * If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric. + */ + count?: UnsignedLong; + /** + * If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric. + */ + cidrs?: Cidrs; + /** + * If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric. + */ + ports?: Ports; + } + export type MinimumNumberOfExecutedThings = number; + export type MissingContextValue = string; + export type MissingContextValues = MissingContextValue[]; + export type NextToken = string; + export type NonCompliantChecksCount = number; + export interface NonCompliantResource { + /** + * The type of the non-compliant resource. + */ + resourceType?: ResourceType; + /** + * Information identifying the non-compliant resource. + */ + resourceIdentifier?: ResourceIdentifier; + /** + * Additional information about the non-compliant resource. + */ + additionalInfo?: StringMap; + } + export type NonCompliantResourcesCount = number; + export type NumberOfThings = number; + export type OTAUpdateArn = string; + export type OTAUpdateDescription = string; + export type OTAUpdateErrorMessage = string; + export interface OTAUpdateFile { + /** + * The name of the file. + */ + fileName?: FileName; + /** + * The file version. + */ + fileVersion?: OTAUpdateFileVersion; + /** + * The location of the updated firmware. + */ + fileLocation?: FileLocation; + /** + * The code signing method of the file. + */ + codeSigning?: CodeSigning; + /** + * A list of name/attribute pairs. + */ + attributes?: AttributesMap; + } + export type OTAUpdateFileVersion = string; + export type OTAUpdateFiles = OTAUpdateFile[]; + export type OTAUpdateId = string; + export interface OTAUpdateInfo { + /** + * The OTA update ID. + */ + otaUpdateId?: OTAUpdateId; + /** + * The OTA update ARN. + */ + otaUpdateArn?: OTAUpdateArn; + /** + * The date when the OTA update was created. + */ + creationDate?: DateType; + /** + * The date when the OTA update was last updated. + */ + lastModifiedDate?: DateType; + /** + * A description of the OTA update. + */ + description?: OTAUpdateDescription; + /** + * The targets of the OTA update. + */ + targets?: Targets; + /** + * Configuration for the rollout of OTA updates. + */ + awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig; + /** + * Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group. + */ + targetSelection?: TargetSelection; + /** + * A list of files associated with the OTA update. + */ + otaUpdateFiles?: OTAUpdateFiles; + /** + * The status of the OTA update. + */ + otaUpdateStatus?: OTAUpdateStatus; + /** + * The AWS IoT job ID associated with the OTA update. + */ + awsIotJobId?: AwsIotJobId; + /** + * The AWS IoT job ARN associated with the OTA update. + */ + awsIotJobArn?: AwsIotJobArn; + /** + * Error information associated with the OTA update. + */ + errorInfo?: ErrorInfo; + /** + * A collection of name/value pairs + */ + additionalParameters?: AdditionalParameterMap; + } + export type OTAUpdateStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"CREATE_FAILED"|string; + export interface OTAUpdateSummary { + /** + * The OTA update ID. + */ + otaUpdateId?: OTAUpdateId; + /** + * The OTA update ARN. + */ + otaUpdateArn?: OTAUpdateArn; + /** + * The date when the OTA update was created. + */ + creationDate?: DateType; + } + export type OTAUpdatesSummary = OTAUpdateSummary[]; + export type OptionalVersion = number; + export interface OutgoingCertificate { + /** + * The certificate ARN. + */ + certificateArn?: CertificateArn; + /** + * The certificate ID. + */ + certificateId?: CertificateId; + /** + * The AWS account to which the transfer was made. + */ + transferredTo?: AwsAccountId; + /** + * The date the transfer was initiated. + */ + transferDate?: DateType; + /** + * The transfer message. + */ + transferMessage?: Message; + /** + * The certificate creation date. + */ + creationDate?: DateType; + } + export type OutgoingCertificates = OutgoingCertificate[]; + export type OverrideDynamicGroups = boolean; + export type PageSize = number; + export type Parameter = string; + export type Parameters = {[key: string]: Value}; + export type PartitionKey = string; + export type PayloadField = string; + export type Percentage = number; + export type Platform = string; + export type Policies = Policy[]; + export interface Policy { + /** + * The policy name. + */ + policyName?: PolicyName; + /** + * The policy ARN. + */ + policyArn?: PolicyArn; + } + export type PolicyArn = string; + export type PolicyDocument = string; + export type PolicyDocuments = PolicyDocument[]; + export type PolicyName = string; + export type PolicyNames = PolicyName[]; + export type PolicyTarget = string; + export type PolicyTargets = PolicyTarget[]; + export interface PolicyVersion { + /** + * The policy version ID. + */ + versionId?: PolicyVersionId; + /** + * Specifies whether the policy version is the default. + */ + isDefaultVersion?: IsDefaultVersion; + /** + * The date and time the policy was created. + */ + createDate?: DateType; + } + export type PolicyVersionId = string; + export interface PolicyVersionIdentifier { + /** + * The name of the policy. + */ + policyName?: PolicyName; + /** + * The ID of the version of the policy associated with the resource. + */ + policyVersionId?: PolicyVersionId; + } + export type PolicyVersions = PolicyVersion[]; + export type Port = number; + export type Ports = Port[]; + export type Prefix = string; + export interface PresignedUrlConfig { + /** + * The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files. + */ + roleArn?: RoleArn; + /** + * How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document. + */ + expiresInSec?: ExpiresInSec; + } + export type Principal = string; + export type PrincipalArn = string; + export type PrincipalId = string; + export type Principals = PrincipalArn[]; + export type PrivateKey = string; + export type ProcessingTargetName = string; + export type ProcessingTargetNameList = ProcessingTargetName[]; + export type PublicKey = string; + export type PublicKeyMap = {[key: string]: KeyValue}; + export interface PutItemInput { + /** + * The table where the message data will be written + */ + tableName: TableName; + } + export type QueryMaxResults = number; + export type QueryString = string; + export type QueryVersion = string; + export type QueueUrl = string; + export type QueuedThings = number; + export type RangeKeyField = string; + export type RangeKeyValue = string; + export interface RateIncreaseCriteria { + /** + * The threshold for number of notified things that will initiate the increase in rate of rollout. + */ + numberOfNotifiedThings?: NumberOfThings; + /** + * The threshold for number of succeeded things that will initiate the increase in rate of rollout. + */ + numberOfSucceededThings?: NumberOfThings; + } + export type ReasonCode = string; + export type ReasonForNonCompliance = string; + export type ReasonForNonComplianceCode = string; + export type Recursive = boolean; + export type RecursiveWithoutDefault = boolean; + export interface RegisterCACertificateRequest { + /** + * The CA certificate. + */ + caCertificate: CertificatePem; + /** + * The private key verification certificate. + */ + verificationCertificate: CertificatePem; + /** + * A boolean value that specifies if the CA certificate is set to active. + */ + setAsActive?: SetAsActive; + /** + * Allows this CA certificate to be used for auto registration of device certificates. + */ + allowAutoRegistration?: AllowAutoRegistration; + /** + * Information about the registration configuration. + */ + registrationConfig?: RegistrationConfig; + } + export interface RegisterCACertificateResponse { + /** + * The CA certificate ARN. + */ + certificateArn?: CertificateArn; + /** + * The CA certificate identifier. + */ + certificateId?: CertificateId; + } + export interface RegisterCertificateRequest { + /** + * The certificate data, in PEM format. + */ + certificatePem: CertificatePem; + /** + * The CA certificate used to sign the device certificate being registered. + */ + caCertificatePem?: CertificatePem; + /** + * A boolean value that specifies if the certificate is set to active. + */ + setAsActive?: SetAsActiveFlag; + /** + * The status of the register certificate request. + */ + status?: CertificateStatus; + } + export interface RegisterCertificateResponse { + /** + * The certificate ARN. + */ + certificateArn?: CertificateArn; + /** + * The certificate identifier. + */ + certificateId?: CertificateId; + } + export interface RegisterThingRequest { + /** + * The provisioning template. See Programmatic Provisioning for more information. + */ + templateBody: TemplateBody; + /** + * The parameters for provisioning a thing. See Programmatic Provisioning for more information. + */ + parameters?: Parameters; + } + export interface RegisterThingResponse { + /** + * . + */ + certificatePem?: CertificatePem; + /** + * ARNs for the generated resources. + */ + resourceArns?: ResourceArns; + } + export type RegistrationCode = string; + export interface RegistrationConfig { + /** + * The template body. + */ + templateBody?: TemplateBody; + /** + * The ARN of the role. + */ + roleArn?: RoleArn; + } + export type RegistryMaxResults = number; + export type RegistryS3BucketName = string; + export type RegistryS3KeyName = string; + export interface RejectCertificateTransferRequest { + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + /** + * The reason the certificate transfer was rejected. + */ + rejectReason?: Message; + } + export type RejectedThings = number; + export interface RelatedResource { + /** + * The type of resource. + */ + resourceType?: ResourceType; + /** + * Information identifying the resource. + */ + resourceIdentifier?: ResourceIdentifier; + /** + * Additional information about the resource. + */ + additionalInfo?: StringMap; + } + export type RelatedResources = RelatedResource[]; + export type RemoveAutoRegistration = boolean; + export interface RemoveThingFromBillingGroupRequest { + /** + * The name of the billing group. + */ + billingGroupName?: BillingGroupName; + /** + * The ARN of the billing group. + */ + billingGroupArn?: BillingGroupArn; + /** + * The name of the thing to be removed from the billing group. + */ + thingName?: ThingName; + /** + * The ARN of the thing to be removed from the billing group. + */ + thingArn?: ThingArn; + } + export interface RemoveThingFromBillingGroupResponse { + } + export interface RemoveThingFromThingGroupRequest { + /** + * The group name. + */ + thingGroupName?: ThingGroupName; + /** + * The group ARN. + */ + thingGroupArn?: ThingGroupArn; + /** + * The name of the thing to remove from the group. + */ + thingName?: ThingName; + /** + * The ARN of the thing to remove from the group. + */ + thingArn?: ThingArn; + } + export interface RemoveThingFromThingGroupResponse { + } + export type RemoveThingType = boolean; + export type RemovedThings = number; + export interface ReplaceTopicRuleRequest { + /** + * The name of the rule. + */ + ruleName: RuleName; + /** + * The rule payload. + */ + topicRulePayload: TopicRulePayload; + } + export type ReportType = "ERRORS"|"RESULTS"|string; + export interface RepublishAction { + /** + * The ARN of the IAM role that grants access. + */ + roleArn: AwsArn; + /** + * The name of the MQTT topic. + */ + topic: TopicPattern; + } + export type Resource = string; + export type ResourceArn = string; + export type ResourceArns = {[key: string]: ResourceArn}; + export interface ResourceIdentifier { + /** + * The ID of the certificate attached to the resource. + */ + deviceCertificateId?: CertificateId; + /** + * The ID of the CA certificate used to authorize the certificate. + */ + caCertificateId?: CertificateId; + /** + * The ID of the Cognito Identity Pool. + */ + cognitoIdentityPoolId?: CognitoIdentityPoolId; + /** + * The client ID. + */ + clientId?: ClientId; + /** + * The version of the policy associated with the resource. + */ + policyVersionIdentifier?: PolicyVersionIdentifier; + /** + * The account with which the resource is associated. + */ + account?: AwsAccountId; + } + export type ResourceLogicalId = string; + export type ResourceType = "DEVICE_CERTIFICATE"|"CA_CERTIFICATE"|"IOT_POLICY"|"COGNITO_IDENTITY_POOL"|"CLIENT_ID"|"ACCOUNT_SETTINGS"|string; + export type Resources = Resource[]; + export type RoleAlias = string; + export type RoleAliasArn = string; + export interface RoleAliasDescription { + /** + * The role alias. + */ + roleAlias?: RoleAlias; + /** + * The ARN of the role alias. + */ + roleAliasArn?: RoleAliasArn; + /** + * The role ARN. + */ + roleArn?: RoleArn; + /** + * The role alias owner. + */ + owner?: AwsAccountId; + /** + * The number of seconds for which the credential is valid. + */ + credentialDurationSeconds?: CredentialDurationSeconds; + /** + * The UNIX timestamp of when the role alias was created. + */ + creationDate?: DateType; + /** + * The UNIX timestamp of when the role alias was last modified. + */ + lastModifiedDate?: DateType; + } + export type RoleAliases = RoleAlias[]; + export type RoleArn = string; + export type RolloutRatePerMinute = number; + export type RuleArn = string; + export type RuleName = string; + export interface S3Action { + /** + * The ARN of the IAM role that grants access. + */ + roleArn: AwsArn; + /** + * The Amazon S3 bucket. + */ + bucketName: BucketName; + /** + * The object key. + */ + key: Key; + /** + * The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs. + */ + cannedAcl?: CannedAccessControlList; + } + export type S3Bucket = string; + export interface S3Destination { + /** + * The S3 bucket that contains the updated firmware. + */ + bucket?: S3Bucket; + /** + * The S3 prefix. + */ + prefix?: Prefix; + } + export type S3FileUrl = string; + export type S3FileUrlList = S3FileUrl[]; + export type S3Key = string; + export interface S3Location { + /** + * The S3 bucket. + */ + bucket?: S3Bucket; + /** + * The S3 key. + */ + key?: S3Key; + /** + * The S3 bucket version. + */ + version?: S3Version; + } + export type S3Version = string; + export type SQL = string; + export interface SalesforceAction { + /** + * The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream. + */ + token: SalesforceToken; + /** + * The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream. + */ + url: SalesforceEndpoint; + } + export type SalesforceEndpoint = string; + export type SalesforceToken = string; + export type ScheduledAuditArn = string; + export interface ScheduledAuditMetadata { + /** + * The name of the scheduled audit. + */ + scheduledAuditName?: ScheduledAuditName; + /** + * The ARN of the scheduled audit. + */ + scheduledAuditArn?: ScheduledAuditArn; + /** + * How often the scheduled audit takes place. + */ + frequency?: AuditFrequency; + /** + * The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month. + */ + dayOfMonth?: DayOfMonth; + /** + * The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY"). + */ + dayOfWeek?: DayOfWeek; + } + export type ScheduledAuditMetadataList = ScheduledAuditMetadata[]; + export type ScheduledAuditName = string; + export interface SearchIndexRequest { + /** + * The search index name. + */ + indexName?: IndexName; + /** + * The search query string. + */ + queryString: QueryString; + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return at one time. + */ + maxResults?: QueryMaxResults; + /** + * The query version. + */ + queryVersion?: QueryVersion; + } + export interface SearchIndexResponse { + /** + * The token used to get the next set of results, or null if there are no additional results. + */ + nextToken?: NextToken; + /** + * The things that match the search query. + */ + things?: ThingDocumentList; + /** + * The thing groups that match the search query. + */ + thingGroups?: ThingGroupDocumentList; + } + export type SearchableAttributes = AttributeName[]; + export type Seconds = number; + export type SecurityProfileArn = string; + export type SecurityProfileDescription = string; + export interface SecurityProfileIdentifier { + /** + * The name you have given to the security profile. + */ + name: SecurityProfileName; + /** + * The ARN of the security profile. + */ + arn: SecurityProfileArn; + } + export type SecurityProfileIdentifiers = SecurityProfileIdentifier[]; + export type SecurityProfileName = string; + export interface SecurityProfileTarget { + /** + * The ARN of the security profile. + */ + arn: SecurityProfileTargetArn; + } + export type SecurityProfileTargetArn = string; + export interface SecurityProfileTargetMapping { + /** + * Information that identifies the security profile. + */ + securityProfileIdentifier?: SecurityProfileIdentifier; + /** + * Information about the target (thing group) associated with the security profile. + */ + target?: SecurityProfileTarget; + } + export type SecurityProfileTargetMappings = SecurityProfileTargetMapping[]; + export type SecurityProfileTargets = SecurityProfileTarget[]; + export type SetAsActive = boolean; + export type SetAsActiveFlag = boolean; + export type SetAsDefault = boolean; + export interface SetDefaultAuthorizerRequest { + /** + * The authorizer name. + */ + authorizerName: AuthorizerName; + } + export interface SetDefaultAuthorizerResponse { + /** + * The authorizer name. + */ + authorizerName?: AuthorizerName; + /** + * The authorizer ARN. + */ + authorizerArn?: AuthorizerArn; + } + export interface SetDefaultPolicyVersionRequest { + /** + * The policy name. + */ + policyName: PolicyName; + /** + * The policy version ID. + */ + policyVersionId: PolicyVersionId; + } + export interface SetLoggingOptionsRequest { + /** + * The logging options payload. + */ + loggingOptionsPayload: LoggingOptionsPayload; + } + export interface SetV2LoggingLevelRequest { + /** + * The log target. + */ + logTarget: LogTarget; + /** + * The log level. + */ + logLevel: LogLevel; + } + export interface SetV2LoggingOptionsRequest { + /** + * The ARN of the role that allows IoT to write to Cloudwatch logs. + */ + roleArn?: AwsArn; + /** + * The default logging level. + */ + defaultLogLevel?: LogLevel; + /** + * If true all logs are disabled. The default is false. + */ + disableAllLogs?: DisableAllLogs; + } + export type Signature = Buffer|Uint8Array|Blob|string; + export type SignatureAlgorithm = string; + export type SigningJobId = string; + export type SigningProfileName = string; + export interface SigningProfileParameter { + /** + * Certificate ARN. + */ + certificateArn?: CertificateArn; + /** + * The hardware platform of your device. + */ + platform?: Platform; + /** + * The location of the code-signing certificate on your device. + */ + certificatePathOnDevice?: CertificatePathOnDevice; + } + export type SkyfallMaxResults = number; + export interface SnsAction { + /** + * The ARN of the SNS topic. + */ + targetArn: AwsArn; + /** + * The ARN of the IAM role that grants access. + */ + roleArn: AwsArn; + /** + * (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation. + */ + messageFormat?: MessageFormat; + } + export interface SqsAction { + /** + * The ARN of the IAM role that grants access. + */ + roleArn: AwsArn; + /** + * The URL of the Amazon SQS queue. + */ + queueUrl: QueueUrl; + /** + * Specifies whether to use Base64 encoding. + */ + useBase64?: UseBase64; + } + export interface StartOnDemandAuditTaskRequest { + /** + * Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled. + */ + targetCheckNames: TargetAuditCheckNames; + } + export interface StartOnDemandAuditTaskResponse { + /** + * The ID of the on-demand audit you started. + */ + taskId?: AuditTaskId; + } + export interface StartSigningJobParameter { + /** + * Describes the code-signing profile. + */ + signingProfileParameter?: SigningProfileParameter; + /** + * The code-signing profile name. + */ + signingProfileName?: SigningProfileName; + /** + * The location to write the code-signed file. + */ + destination?: Destination; + } + export interface StartThingRegistrationTaskRequest { + /** + * The provisioning template. + */ + templateBody: TemplateBody; + /** + * The S3 bucket that contains the input file. + */ + inputFileBucket: RegistryS3BucketName; + /** + * The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing). + */ + inputFileKey: RegistryS3KeyName; + /** + * The IAM role ARN that grants permission the input file. + */ + roleArn: RoleArn; + } + export interface StartThingRegistrationTaskResponse { + /** + * The bulk thing provisioning task ID. + */ + taskId?: TaskId; + } + export type StateMachineName = string; + export type StateReason = string; + export type StateValue = string; + export interface StatisticalThreshold { + /** + * The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs. + */ + statistic?: EvaluationStatistic; + } + export interface Statistics { + /** + * The count of things that match the query. + */ + count?: Count; + } + export type Status = "InProgress"|"Completed"|"Failed"|"Cancelled"|"Cancelling"|string; + export interface StepFunctionsAction { + /** + * (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided. + */ + executionNamePrefix?: ExecutionNamePrefix; + /** + * The name of the Step Functions state machine whose execution will be started. + */ + stateMachineName: StateMachineName; + /** + * The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution"). + */ + roleArn: AwsArn; + } + export interface StopThingRegistrationTaskRequest { + /** + * The bulk thing provisioning task ID. + */ + taskId: TaskId; + } + export interface StopThingRegistrationTaskResponse { + } + export interface Stream { + /** + * The stream ID. + */ + streamId?: StreamId; + /** + * The ID of a file associated with a stream. + */ + fileId?: FileId; + } + export type StreamArn = string; + export type StreamDescription = string; + export interface StreamFile { + /** + * The file ID. + */ + fileId?: FileId; + /** + * The location of the file in S3. + */ + s3Location?: S3Location; + } + export type StreamFiles = StreamFile[]; + export type StreamId = string; + export interface StreamInfo { + /** + * The stream ID. + */ + streamId?: StreamId; + /** + * The stream ARN. + */ + streamArn?: StreamArn; + /** + * The stream version. + */ + streamVersion?: StreamVersion; + /** + * The description of the stream. + */ + description?: StreamDescription; + /** + * The files to stream. + */ + files?: StreamFiles; + /** + * The date when the stream was created. + */ + createdAt?: DateType; + /** + * The date when the stream was last updated. + */ + lastUpdatedAt?: DateType; + /** + * An IAM role AWS IoT assumes to access your S3 files. + */ + roleArn?: RoleArn; + } + export type StreamName = string; + export interface StreamSummary { + /** + * The stream ID. + */ + streamId?: StreamId; + /** + * The stream ARN. + */ + streamArn?: StreamArn; + /** + * The stream version. + */ + streamVersion?: StreamVersion; + /** + * A description of the stream. + */ + description?: StreamDescription; + } + export type StreamVersion = number; + export type StreamsSummary = StreamSummary[]; + export type String = string; + export type StringMap = {[key: string]: String}; + export type SucceededThings = number; + export type TableName = string; + export interface Tag { + /** + * The tag's key. + */ + Key?: TagKey; + /** + * The tag's value. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The ARN of the resource. + */ + resourceArn: ResourceArn; + /** + * The new or modified tags for the resource. + */ + tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Target = string; + export type TargetArn = string; + export type TargetAuditCheckNames = AuditCheckName[]; + export type TargetSelection = "CONTINUOUS"|"SNAPSHOT"|string; + export type Targets = Target[]; + export type TaskId = string; + export type TaskIdList = TaskId[]; + export interface TaskStatistics { + /** + * The number of checks in this audit. + */ + totalChecks?: TotalChecksCount; + /** + * The number of checks in progress. + */ + inProgressChecks?: InProgressChecksCount; + /** + * The number of checks waiting for data collection. + */ + waitingForDataCollectionChecks?: WaitingForDataCollectionChecksCount; + /** + * The number of checks that found compliant resources. + */ + compliantChecks?: CompliantChecksCount; + /** + * The number of checks that found non-compliant resources. + */ + nonCompliantChecks?: NonCompliantChecksCount; + /** + * The number of checks + */ + failedChecks?: FailedChecksCount; + /** + * The number of checks that did not run because the audit was canceled. + */ + canceledChecks?: CanceledChecksCount; + } + export type TemplateBody = string; + export interface TestAuthorizationRequest { + /** + * The principal. + */ + principal?: Principal; + /** + * The Cognito identity pool ID. + */ + cognitoIdentityPoolId?: CognitoIdentityPoolId; + /** + * A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list. + */ + authInfos: AuthInfos; + /** + * The MQTT client ID. + */ + clientId?: ClientId; + /** + * When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized. + */ + policyNamesToAdd?: PolicyNames; + /** + * When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized. + */ + policyNamesToSkip?: PolicyNames; + } + export interface TestAuthorizationResponse { + /** + * The authentication results. + */ + authResults?: AuthResults; + } + export interface TestInvokeAuthorizerRequest { + /** + * The custom authorizer name. + */ + authorizerName: AuthorizerName; + /** + * The token returned by your custom authentication service. + */ + token: Token; + /** + * The signature made with the token and your custom authentication service's private key. + */ + tokenSignature: TokenSignature; + } + export interface TestInvokeAuthorizerResponse { + /** + * True if the token is authenticated, otherwise false. + */ + isAuthenticated?: IsAuthenticated; + /** + * The principal ID. + */ + principalId?: PrincipalId; + /** + * IAM policy documents. + */ + policyDocuments?: PolicyDocuments; + /** + * The number of seconds after which the temporary credentials are refreshed. + */ + refreshAfterInSeconds?: Seconds; + /** + * The number of seconds after which the connection is terminated. + */ + disconnectAfterInSeconds?: Seconds; + } + export type ThingArn = string; + export interface ThingAttribute { + /** + * The name of the thing. + */ + thingName?: ThingName; + /** + * The name of the thing type, if the thing has been associated with a type. + */ + thingTypeName?: ThingTypeName; + /** + * The thing ARN. + */ + thingArn?: ThingArn; + /** + * A list of thing attributes which are name-value pairs. + */ + attributes?: Attributes; + /** + * The version of the thing record in the registry. + */ + version?: Version; + } + export type ThingAttributeList = ThingAttribute[]; + export interface ThingConnectivity { + /** + * True if the thing is connected to the AWS IoT service; false if it is not connected. + */ + connected?: Boolean; + /** + * The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for more than a few weeks, the time value might be missing. + */ + timestamp?: ConnectivityTimestamp; + } + export type ThingConnectivityIndexingMode = "OFF"|"STATUS"|string; + export interface ThingDocument { + /** + * The thing name. + */ + thingName?: ThingName; + /** + * The thing ID. + */ + thingId?: ThingId; + /** + * The thing type name. + */ + thingTypeName?: ThingTypeName; + /** + * Thing group names. + */ + thingGroupNames?: ThingGroupNameList; + /** + * The attributes. + */ + attributes?: Attributes; + /** + * The shadow. + */ + shadow?: JsonDocument; + /** + * Indicates whether the thing is connected to the AWS IoT service. + */ + connectivity?: ThingConnectivity; + } + export type ThingDocumentList = ThingDocument[]; + export type ThingGroupArn = string; + export type ThingGroupDescription = string; + export interface ThingGroupDocument { + /** + * The thing group name. + */ + thingGroupName?: ThingGroupName; + /** + * The thing group ID. + */ + thingGroupId?: ThingGroupId; + /** + * The thing group description. + */ + thingGroupDescription?: ThingGroupDescription; + /** + * The thing group attributes. + */ + attributes?: Attributes; + /** + * Parent group names. + */ + parentGroupNames?: ThingGroupNameList; + } + export type ThingGroupDocumentList = ThingGroupDocument[]; + export type ThingGroupId = string; + export interface ThingGroupIndexingConfiguration { + /** + * Thing group indexing mode. + */ + thingGroupIndexingMode: ThingGroupIndexingMode; + } + export type ThingGroupIndexingMode = "OFF"|"ON"|string; + export type ThingGroupList = ThingGroupName[]; + export interface ThingGroupMetadata { + /** + * The parent thing group name. + */ + parentGroupName?: ThingGroupName; + /** + * The root parent thing group. + */ + rootToParentThingGroups?: ThingGroupNameAndArnList; + /** + * The UNIX timestamp of when the thing group was created. + */ + creationDate?: CreationDate; + } + export type ThingGroupName = string; + export type ThingGroupNameAndArnList = GroupNameAndArn[]; + export type ThingGroupNameList = ThingGroupName[]; + export interface ThingGroupProperties { + /** + * The thing group description. + */ + thingGroupDescription?: ThingGroupDescription; + /** + * The thing group attributes in JSON format. + */ + attributePayload?: AttributePayload; + } + export type ThingId = string; + export interface ThingIndexingConfiguration { + /** + * Thing indexing mode. Valid values are: REGISTRY – Your thing index contains registry data only. REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data. OFF - Thing indexing is disabled. + */ + thingIndexingMode: ThingIndexingMode; + /** + * Thing connectivity indexing mode. Valid values are: STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF. OFF - Thing connectivity status indexing is disabled. + */ + thingConnectivityIndexingMode?: ThingConnectivityIndexingMode; + } + export type ThingIndexingMode = "OFF"|"REGISTRY"|"REGISTRY_AND_SHADOW"|string; + export type ThingName = string; + export type ThingNameList = ThingName[]; + export type ThingTypeArn = string; + export interface ThingTypeDefinition { + /** + * The name of the thing type. + */ + thingTypeName?: ThingTypeName; + /** + * The thing type ARN. + */ + thingTypeArn?: ThingTypeArn; + /** + * The ThingTypeProperties for the thing type. + */ + thingTypeProperties?: ThingTypeProperties; + /** + * The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated. + */ + thingTypeMetadata?: ThingTypeMetadata; + } + export type ThingTypeDescription = string; + export type ThingTypeId = string; + export type ThingTypeList = ThingTypeDefinition[]; + export interface ThingTypeMetadata { + /** + * Whether the thing type is deprecated. If true, no new things could be associated with this type. + */ + deprecated?: Boolean; + /** + * The date and time when the thing type was deprecated. + */ + deprecationDate?: DeprecationDate; + /** + * The date and time when the thing type was created. + */ + creationDate?: CreationDate; + } + export type ThingTypeName = string; + export interface ThingTypeProperties { + /** + * The description of the thing type. + */ + thingTypeDescription?: ThingTypeDescription; + /** + * A list of searchable thing attribute names. + */ + searchableAttributes?: SearchableAttributes; + } + export type TimedOutThings = number; + export interface TimeoutConfig { + /** + * Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status. + */ + inProgressTimeoutInMinutes?: InProgressTimeoutInMinutes; + } + export type Timestamp = Date; + export type Token = string; + export type TokenKeyName = string; + export type TokenSignature = string; + export type Topic = string; + export type TopicPattern = string; + export interface TopicRule { + /** + * The name of the rule. + */ + ruleName?: RuleName; + /** + * The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters. + */ + sql?: SQL; + /** + * The description of the rule. + */ + description?: Description; + /** + * The date and time the rule was created. + */ + createdAt?: CreatedAtDate; + /** + * The actions associated with the rule. + */ + actions?: ActionList; + /** + * Specifies whether the rule is disabled. + */ + ruleDisabled?: IsDisabled; + /** + * The version of the SQL rules engine to use when evaluating the rule. + */ + awsIotSqlVersion?: AwsIotSqlVersion; + /** + * The action to perform when an error occurs. + */ + errorAction?: Action; + } + export type TopicRuleList = TopicRuleListItem[]; + export interface TopicRuleListItem { + /** + * The rule ARN. + */ + ruleArn?: RuleArn; + /** + * The name of the rule. + */ + ruleName?: RuleName; + /** + * The pattern for the topic names that apply. + */ + topicPattern?: TopicPattern; + /** + * The date and time the rule was created. + */ + createdAt?: CreatedAtDate; + /** + * Specifies whether the rule is disabled. + */ + ruleDisabled?: IsDisabled; + } + export interface TopicRulePayload { + /** + * The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide. + */ + sql: SQL; + /** + * The description of the rule. + */ + description?: Description; + /** + * The actions associated with the rule. + */ + actions: ActionList; + /** + * Specifies whether the rule is disabled. + */ + ruleDisabled?: IsDisabled; + /** + * The version of the SQL rules engine to use when evaluating the rule. + */ + awsIotSqlVersion?: AwsIotSqlVersion; + /** + * The action to take when an error occurs. + */ + errorAction?: Action; + } + export type TotalChecksCount = number; + export type TotalResourcesCount = number; + export interface TransferCertificateRequest { + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + /** + * The AWS account. + */ + targetAwsAccount: AwsAccountId; + /** + * The transfer message. + */ + transferMessage?: Message; + } + export interface TransferCertificateResponse { + /** + * The ARN of the certificate. + */ + transferredCertificateArn?: CertificateArn; + } + export interface TransferData { + /** + * The transfer message. + */ + transferMessage?: Message; + /** + * The reason why the transfer was rejected. + */ + rejectReason?: Message; + /** + * The date the transfer took place. + */ + transferDate?: DateType; + /** + * The date the transfer was accepted. + */ + acceptDate?: DateType; + /** + * The date the transfer was rejected. + */ + rejectDate?: DateType; + } + export type UndoDeprecate = boolean; + export type UnsignedLong = number; + export interface UntagResourceRequest { + /** + * The ARN of the resource. + */ + resourceArn: ResourceArn; + /** + * A list of the keys of the tags to be removed from the resource. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateAccountAuditConfigurationRequest { + /** + * The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit. + */ + roleArn?: RoleArn; + /** + * Information about the targets to which audit notifications are sent. + */ + auditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations; + /** + * Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks including those that are currently enabled. Note that some data collection may begin immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself. On the first call to UpdateAccountAuditConfiguration this parameter is required and must specify at least one enabled check. + */ + auditCheckConfigurations?: AuditCheckConfigurations; + } + export interface UpdateAccountAuditConfigurationResponse { + } + export interface UpdateAuthorizerRequest { + /** + * The authorizer name. + */ + authorizerName: AuthorizerName; + /** + * The ARN of the authorizer's Lambda function. + */ + authorizerFunctionArn?: AuthorizerFunctionArn; + /** + * The key used to extract the token from the HTTP headers. + */ + tokenKeyName?: TokenKeyName; + /** + * The public keys used to verify the token signature. + */ + tokenSigningPublicKeys?: PublicKeyMap; + /** + * The status of the update authorizer request. + */ + status?: AuthorizerStatus; + } + export interface UpdateAuthorizerResponse { + /** + * The authorizer name. + */ + authorizerName?: AuthorizerName; + /** + * The authorizer ARN. + */ + authorizerArn?: AuthorizerArn; + } + export interface UpdateBillingGroupRequest { + /** + * The name of the billing group. + */ + billingGroupName: BillingGroupName; + /** + * The properties of the billing group. + */ + billingGroupProperties: BillingGroupProperties; + /** + * The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException. + */ + expectedVersion?: OptionalVersion; + } + export interface UpdateBillingGroupResponse { + /** + * The latest version of the billing group. + */ + version?: Version; + } + export interface UpdateCACertificateRequest { + /** + * The CA certificate identifier. + */ + certificateId: CertificateId; + /** + * The updated status of the CA certificate. Note: The status value REGISTER_INACTIVE is deprecated and should not be used. + */ + newStatus?: CACertificateStatus; + /** + * The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE". + */ + newAutoRegistrationStatus?: AutoRegistrationStatus; + /** + * Information about the registration configuration. + */ + registrationConfig?: RegistrationConfig; + /** + * If true, remove auto registration. + */ + removeAutoRegistration?: RemoveAutoRegistration; + } + export interface UpdateCertificateRequest { + /** + * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) + */ + certificateId: CertificateId; + /** + * The new status. Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used. + */ + newStatus: CertificateStatus; + } + export interface UpdateDynamicThingGroupRequest { + /** + * The name of the dynamic thing group to update. + */ + thingGroupName: ThingGroupName; + /** + * The dynamic thing group properties to update. + */ + thingGroupProperties: ThingGroupProperties; + /** + * The expected version of the dynamic thing group to update. + */ + expectedVersion?: OptionalVersion; + /** + * The dynamic thing group index to update. Currently one index is supported: 'AWS_Things'. + */ + indexName?: IndexName; + /** + * The dynamic thing group search query string to update. + */ + queryString?: QueryString; + /** + * The dynamic thing group query version to update. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value. + */ + queryVersion?: QueryVersion; + } + export interface UpdateDynamicThingGroupResponse { + /** + * The dynamic thing group version. + */ + version?: Version; + } + export interface UpdateEventConfigurationsRequest { + /** + * The new event configuration values. + */ + eventConfigurations?: EventConfigurations; + } + export interface UpdateEventConfigurationsResponse { + } + export interface UpdateIndexingConfigurationRequest { + /** + * Thing indexing configuration. + */ + thingIndexingConfiguration?: ThingIndexingConfiguration; + /** + * Thing group indexing configuration. + */ + thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration; + } + export interface UpdateIndexingConfigurationResponse { + } + export interface UpdateJobRequest { + /** + * The ID of the job to be updated. + */ + jobId: JobId; + /** + * A short text description of the job. + */ + description?: JobDescription; + /** + * Configuration information for pre-signed S3 URLs. + */ + presignedUrlConfig?: PresignedUrlConfig; + /** + * Allows you to create a staged rollout of the job. + */ + jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig; + /** + * Allows you to create criteria to abort a job. + */ + abortConfig?: AbortConfig; + /** + * Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT. + */ + timeoutConfig?: TimeoutConfig; + } + export interface UpdateRoleAliasRequest { + /** + * The role alias to update. + */ + roleAlias: RoleAlias; + /** + * The role ARN. + */ + roleArn?: RoleArn; + /** + * The number of seconds the credential will be valid. + */ + credentialDurationSeconds?: CredentialDurationSeconds; + } + export interface UpdateRoleAliasResponse { + /** + * The role alias. + */ + roleAlias?: RoleAlias; + /** + * The role alias ARN. + */ + roleAliasArn?: RoleAliasArn; + } + export interface UpdateScheduledAuditRequest { + /** + * How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system. + */ + frequency?: AuditFrequency; + /** + * The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month. + */ + dayOfMonth?: DayOfMonth; + /** + * The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY". + */ + dayOfWeek?: DayOfWeek; + /** + * Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.) + */ + targetCheckNames?: TargetAuditCheckNames; + /** + * The name of the scheduled audit. (Max. 128 chars) + */ + scheduledAuditName: ScheduledAuditName; + } + export interface UpdateScheduledAuditResponse { + /** + * The ARN of the scheduled audit. + */ + scheduledAuditArn?: ScheduledAuditArn; + } + export interface UpdateSecurityProfileRequest { + /** + * The name of the security profile you want to update. + */ + securityProfileName: SecurityProfileName; + /** + * A description of the security profile. + */ + securityProfileDescription?: SecurityProfileDescription; + /** + * Specifies the behaviors that, when violated by a device (thing), cause an alert. + */ + behaviors?: Behaviors; + /** + * Where the alerts are sent. (Alerts are always sent to the console.) + */ + alertTargets?: AlertTargets; + /** + * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors but it is also retained for any metric specified here. + */ + additionalMetricsToRetain?: AdditionalMetricsToRetainList; + /** + * If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation an exception occurs. + */ + deleteBehaviors?: DeleteBehaviors; + /** + * If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation an exception occurs. + */ + deleteAlertTargets?: DeleteAlertTargets; + /** + * If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation an exception occurs. + */ + deleteAdditionalMetricsToRetain?: DeleteAdditionalMetricsToRetain; + /** + * The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a VersionConflictException is thrown. + */ + expectedVersion?: OptionalVersion; + } + export interface UpdateSecurityProfileResponse { + /** + * The name of the security profile that was updated. + */ + securityProfileName?: SecurityProfileName; + /** + * The ARN of the security profile that was updated. + */ + securityProfileArn?: SecurityProfileArn; + /** + * The description of the security profile. + */ + securityProfileDescription?: SecurityProfileDescription; + /** + * Specifies the behaviors that, when violated by a device (thing), cause an alert. + */ + behaviors?: Behaviors; + /** + * Where the alerts are sent. (Alerts are always sent to the console.) + */ + alertTargets?: AlertTargets; + /** + * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors but it is also retained for any metric specified here. + */ + additionalMetricsToRetain?: AdditionalMetricsToRetainList; + /** + * The updated version of the security profile. + */ + version?: Version; + /** + * The time the security profile was created. + */ + creationDate?: Timestamp; + /** + * The time the security profile was last modified. + */ + lastModifiedDate?: Timestamp; + } + export interface UpdateStreamRequest { + /** + * The stream ID. + */ + streamId: StreamId; + /** + * The description of the stream. + */ + description?: StreamDescription; + /** + * The files associated with the stream. + */ + files?: StreamFiles; + /** + * An IAM role that allows the IoT service principal assumes to access your S3 files. + */ + roleArn?: RoleArn; + } + export interface UpdateStreamResponse { + /** + * The stream ID. + */ + streamId?: StreamId; + /** + * The stream ARN. + */ + streamArn?: StreamArn; + /** + * A description of the stream. + */ + description?: StreamDescription; + /** + * The stream version. + */ + streamVersion?: StreamVersion; + } + export interface UpdateThingGroupRequest { + /** + * The thing group to update. + */ + thingGroupName: ThingGroupName; + /** + * The thing group properties. + */ + thingGroupProperties: ThingGroupProperties; + /** + * The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail. + */ + expectedVersion?: OptionalVersion; + } + export interface UpdateThingGroupResponse { + /** + * The version of the updated thing group. + */ + version?: Version; + } + export interface UpdateThingGroupsForThingRequest { + /** + * The thing whose group memberships will be updated. + */ + thingName?: ThingName; + /** + * The groups to which the thing will be added. + */ + thingGroupsToAdd?: ThingGroupList; + /** + * The groups from which the thing will be removed. + */ + thingGroupsToRemove?: ThingGroupList; + /** + * Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group. + */ + overrideDynamicGroups?: OverrideDynamicGroups; + } + export interface UpdateThingGroupsForThingResponse { + } + export interface UpdateThingRequest { + /** + * The name of the thing to update. + */ + thingName: ThingName; + /** + * The name of the thing type. + */ + thingTypeName?: ThingTypeName; + /** + * A list of thing attributes, a JSON string containing name-value pairs. For example: {\"attributes\":{\"name1\":\"value2\"}} This data is used to add new attributes or update existing attributes. + */ + attributePayload?: AttributePayload; + /** + * The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException. + */ + expectedVersion?: OptionalVersion; + /** + * Remove a thing type association. If true, the association is removed. + */ + removeThingType?: RemoveThingType; + } + export interface UpdateThingResponse { + } + export type UseBase64 = boolean; + export type Valid = boolean; + export interface ValidateSecurityProfileBehaviorsRequest { + /** + * Specifies the behaviors that, when violated by a device (thing), cause an alert. + */ + behaviors: Behaviors; + } + export interface ValidateSecurityProfileBehaviorsResponse { + /** + * True if the behaviors were valid. + */ + valid?: Valid; + /** + * The list of any errors found in the behaviors. + */ + validationErrors?: ValidationErrors; + } + export interface ValidationError { + /** + * The description of an error found in the behaviors. + */ + errorMessage?: ErrorMessage; + } + export type ValidationErrors = ValidationError[]; + export type Value = string; + export type Version = number; + export type VersionNumber = number; + export interface ViolationEvent { + /** + * The ID of the violation event. + */ + violationId?: ViolationId; + /** + * The name of the thing responsible for the violation event. + */ + thingName?: ThingName; + /** + * The name of the security profile whose behavior was violated. + */ + securityProfileName?: SecurityProfileName; + /** + * The behavior which was violated. + */ + behavior?: Behavior; + /** + * The value of the metric (the measurement). + */ + metricValue?: MetricValue; + /** + * The type of violation event. + */ + violationEventType?: ViolationEventType; + /** + * The time the violation event occurred. + */ + violationEventTime?: Timestamp; + } + export type ViolationEventType = "in-alarm"|"alarm-cleared"|"alarm-invalidated"|string; + export type ViolationEvents = ViolationEvent[]; + export type ViolationId = string; + export type WaitingForDataCollectionChecksCount = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-05-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Iot client. + */ + export import Types = Iot; +} +export = Iot; diff --git a/node_modules/aws-sdk/clients/iot.js b/node_modules/aws-sdk/clients/iot.js new file mode 100644 index 0000000..05ca17a --- /dev/null +++ b/node_modules/aws-sdk/clients/iot.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['iot'] = {}; +AWS.Iot = Service.defineService('iot', ['2015-05-28']); +Object.defineProperty(apiLoader.services['iot'], '2015-05-28', { + get: function get() { + var model = require('../apis/iot-2015-05-28.min.json'); + model.paginators = require('../apis/iot-2015-05-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Iot; diff --git a/node_modules/aws-sdk/clients/iot1clickdevicesservice.d.ts b/node_modules/aws-sdk/clients/iot1clickdevicesservice.d.ts new file mode 100644 index 0000000..e0487f3 --- /dev/null +++ b/node_modules/aws-sdk/clients/iot1clickdevicesservice.d.ts @@ -0,0 +1,468 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class IoT1ClickDevicesService extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: IoT1ClickDevicesService.Types.ClientConfiguration) + config: Config & IoT1ClickDevicesService.Types.ClientConfiguration; + /** + * Adds device(s) to your account (i.e., claim one or more devices) if and only if you + received a claim code with the device(s). + */ + claimDevicesByClaimCode(params: IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeResponse) => void): Request; + /** + * Adds device(s) to your account (i.e., claim one or more devices) if and only if you + received a claim code with the device(s). + */ + claimDevicesByClaimCode(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeResponse) => void): Request; + /** + * Given a device ID, returns a DescribeDeviceResponse object describing the + details of the device. + */ + describeDevice(params: IoT1ClickDevicesService.Types.DescribeDeviceRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.DescribeDeviceResponse) => void): Request; + /** + * Given a device ID, returns a DescribeDeviceResponse object describing the + details of the device. + */ + describeDevice(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.DescribeDeviceResponse) => void): Request; + /** + * Given a device ID, finalizes the claim request for the associated device. + Claiming a device consists of initiating a claim, then publishing a device event, + and finalizing the claim. For a device of type button, a device event can + be published by simply clicking the device. + + */ + finalizeDeviceClaim(params: IoT1ClickDevicesService.Types.FinalizeDeviceClaimRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.FinalizeDeviceClaimResponse) => void): Request; + /** + * Given a device ID, finalizes the claim request for the associated device. + Claiming a device consists of initiating a claim, then publishing a device event, + and finalizing the claim. For a device of type button, a device event can + be published by simply clicking the device. + + */ + finalizeDeviceClaim(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.FinalizeDeviceClaimResponse) => void): Request; + /** + * Given a device ID, returns the invokable methods associated with the device. + */ + getDeviceMethods(params: IoT1ClickDevicesService.Types.GetDeviceMethodsRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.GetDeviceMethodsResponse) => void): Request; + /** + * Given a device ID, returns the invokable methods associated with the device. + */ + getDeviceMethods(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.GetDeviceMethodsResponse) => void): Request; + /** + * Given a device ID, initiates a claim request for the associated device. + Claiming a device consists of initiating a claim, then publishing a device event, + and finalizing the claim. For a device of type button, a device event can + be published by simply clicking the device. + + */ + initiateDeviceClaim(params: IoT1ClickDevicesService.Types.InitiateDeviceClaimRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InitiateDeviceClaimResponse) => void): Request; + /** + * Given a device ID, initiates a claim request for the associated device. + Claiming a device consists of initiating a claim, then publishing a device event, + and finalizing the claim. For a device of type button, a device event can + be published by simply clicking the device. + + */ + initiateDeviceClaim(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InitiateDeviceClaimResponse) => void): Request; + /** + * Given a device ID, issues a request to invoke a named device method (with possible + parameters). See the "Example POST" code snippet below. + */ + invokeDeviceMethod(params: IoT1ClickDevicesService.Types.InvokeDeviceMethodRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InvokeDeviceMethodResponse) => void): Request; + /** + * Given a device ID, issues a request to invoke a named device method (with possible + parameters). See the "Example POST" code snippet below. + */ + invokeDeviceMethod(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InvokeDeviceMethodResponse) => void): Request; + /** + * Using a device ID, returns a DeviceEventsResponse object containing an + array of events for the device. + */ + listDeviceEvents(params: IoT1ClickDevicesService.Types.ListDeviceEventsRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDeviceEventsResponse) => void): Request; + /** + * Using a device ID, returns a DeviceEventsResponse object containing an + array of events for the device. + */ + listDeviceEvents(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDeviceEventsResponse) => void): Request; + /** + * Lists the 1-Click compatible devices associated with your AWS account. + */ + listDevices(params: IoT1ClickDevicesService.Types.ListDevicesRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDevicesResponse) => void): Request; + /** + * Lists the 1-Click compatible devices associated with your AWS account. + */ + listDevices(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDevicesResponse) => void): Request; + /** + * Lists the tags associated with the specified resource ARN. + */ + listTagsForResource(params: IoT1ClickDevicesService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags associated with the specified resource ARN. + */ + listTagsForResource(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListTagsForResourceResponse) => void): Request; + /** + * Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per + resource. + */ + tagResource(params: IoT1ClickDevicesService.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per + resource. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates a device from your AWS account using its device ID. + */ + unclaimDevice(params: IoT1ClickDevicesService.Types.UnclaimDeviceRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UnclaimDeviceResponse) => void): Request; + /** + * Disassociates a device from your AWS account using its device ID. + */ + unclaimDevice(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UnclaimDeviceResponse) => void): Request; + /** + * Using tag keys, deletes the tags (key/value pairs) associated with the specified + resource ARN. + */ + untagResource(params: IoT1ClickDevicesService.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Using tag keys, deletes the tags (key/value pairs) associated with the specified + resource ARN. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Using a Boolean value (true or false), this operation + enables or disables the device given a device ID. + */ + updateDeviceState(params: IoT1ClickDevicesService.Types.UpdateDeviceStateRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UpdateDeviceStateResponse) => void): Request; + /** + * Using a Boolean value (true or false), this operation + enables or disables the device given a device ID. + */ + updateDeviceState(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UpdateDeviceStateResponse) => void): Request; +} +declare namespace IoT1ClickDevicesService { + export interface Attributes { + } + export interface ClaimDevicesByClaimCodeRequest { + /** + * The claim code, starting with "C-", as provided by the device manufacturer. + */ + ClaimCode: __string; + } + export interface ClaimDevicesByClaimCodeResponse { + /** + * The claim code provided by the device manufacturer. + */ + ClaimCode?: __stringMin12Max40; + /** + * The total number of devices associated with the claim code that has been processed in + the claim request. + */ + Total?: __integer; + } + export interface DescribeDeviceRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + } + export interface DescribeDeviceResponse { + /** + * Device details. + */ + DeviceDescription?: DeviceDescription; + } + export interface Device { + /** + * The user specified attributes associated with the device for an event. + */ + Attributes?: Attributes; + /** + * The unique identifier of the device. + */ + DeviceId?: __string; + /** + * The device type, such as "button". + */ + Type?: __string; + } + export type DeviceAttributes = {[key: string]: __string}; + export interface DeviceDescription { + /** + * The ARN of the device. + */ + Arn?: __string; + /** + * An array of zero or more elements of DeviceAttribute objects providing + user specified device attributes. + */ + Attributes?: DeviceAttributes; + /** + * The unique identifier of the device. + */ + DeviceId?: __string; + /** + * A Boolean value indicating whether or not the device is enabled. + */ + Enabled?: __boolean; + /** + * A value between 0 and 1 inclusive, representing the fraction of life remaining for the + device. + */ + RemainingLife?: __doubleMin0Max100; + /** + * The type of the device, such as "button". + */ + Type?: __string; + /** + * The tags currently associated with the AWS IoT 1-Click device. + */ + Tags?: __mapOf__string; + } + export interface DeviceEvent { + /** + * An object representing the device associated with the event. + */ + Device?: Device; + /** + * A serialized JSON object representing the device-type specific event. + */ + StdEvent?: __string; + } + export interface DeviceMethod { + /** + * The type of the device, such as "button". + */ + DeviceType?: __string; + /** + * The name of the method applicable to the deviceType. + */ + MethodName?: __string; + } + export interface FinalizeDeviceClaimRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + /** + * A collection of key/value pairs defining the resource tags. For example, { + "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS + Tagging Strategies. + + + */ + Tags?: __mapOf__string; + } + export interface FinalizeDeviceClaimResponse { + /** + * The device's final claim state. + */ + State?: __string; + } + export interface GetDeviceMethodsRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + } + export interface GetDeviceMethodsResponse { + /** + * List of available device APIs. + */ + DeviceMethods?: __listOfDeviceMethod; + } + export interface InitiateDeviceClaimRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + } + export interface InitiateDeviceClaimResponse { + /** + * The device's final claim state. + */ + State?: __string; + } + export interface InvokeDeviceMethodRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + /** + * The device method to invoke. + */ + DeviceMethod?: DeviceMethod; + /** + * A JSON encoded string containing the device method request parameters. + */ + DeviceMethodParameters?: __string; + } + export interface InvokeDeviceMethodResponse { + /** + * A JSON encoded string containing the device method response. + */ + DeviceMethodResponse?: __string; + } + export interface ListDeviceEventsRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + /** + * The start date for the device event query, in ISO8061 format. For example, + 2018-03-28T15:45:12.880Z + + */ + FromTimeStamp: __timestampIso8601; + /** + * The maximum number of results to return per request. If not set, a default value of + 100 is used. + */ + MaxResults?: MaxResults; + /** + * The token to retrieve the next set of results. + */ + NextToken?: __string; + /** + * The end date for the device event query, in ISO8061 format. For example, + 2018-03-28T15:45:12.880Z + + */ + ToTimeStamp: __timestampIso8601; + } + export interface ListDeviceEventsResponse { + /** + * An array of zero or more elements describing the event(s) associated with the + device. + */ + Events?: __listOfDeviceEvent; + /** + * The token to retrieve the next set of results. + */ + NextToken?: __string; + } + export interface ListDevicesRequest { + /** + * The type of the device, such as "button". + */ + DeviceType?: __string; + /** + * The maximum number of results to return per request. If not set, a default value of + 100 is used. + */ + MaxResults?: MaxResults; + /** + * The token to retrieve the next set of results. + */ + NextToken?: __string; + } + export interface ListDevicesResponse { + /** + * A list of devices. + */ + Devices?: __listOfDeviceDescription; + /** + * The token to retrieve the next set of results. + */ + NextToken?: __string; + } + export interface ListTagsForResourceRequest { + /** + * The ARN of the resource. + */ + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + /** + * A collection of key/value pairs defining the resource tags. For example, { + "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS + Tagging Strategies. + + + */ + Tags?: __mapOf__string; + } + export type MaxResults = number; + export interface TagResourceRequest { + /** + * The ARN of the resource. + */ + ResourceArn: __string; + /** + * A collection of key/value pairs defining the resource tags. For example, { + "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS + Tagging Strategies. + + + */ + Tags: __mapOf__string; + } + export interface UnclaimDeviceRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + } + export interface UnclaimDeviceResponse { + /** + * The device's final claim state. + */ + State?: __string; + } + export interface UntagResourceRequest { + /** + * The ARN of the resource. + */ + ResourceArn: __string; + /** + * A collections of tag keys. For example, {"key1","key2"} + */ + TagKeys: __listOf__string; + } + export interface UpdateDeviceStateRequest { + /** + * The unique identifier of the device. + */ + DeviceId: __string; + /** + * If true, the device is enabled. If false, the device is + disabled. + */ + Enabled?: __boolean; + } + export interface UpdateDeviceStateResponse { + } + export type __boolean = boolean; + export type __doubleMin0Max100 = number; + export type __integer = number; + export type __listOfDeviceDescription = DeviceDescription[]; + export type __listOfDeviceEvent = DeviceEvent[]; + export type __listOfDeviceMethod = DeviceMethod[]; + export type __listOf__string = __string[]; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + export type __stringMin12Max40 = string; + export type __timestampIso8601 = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-05-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the IoT1ClickDevicesService client. + */ + export import Types = IoT1ClickDevicesService; +} +export = IoT1ClickDevicesService; diff --git a/node_modules/aws-sdk/clients/iot1clickdevicesservice.js b/node_modules/aws-sdk/clients/iot1clickdevicesservice.js new file mode 100644 index 0000000..4d0495d --- /dev/null +++ b/node_modules/aws-sdk/clients/iot1clickdevicesservice.js @@ -0,0 +1,17 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['iot1clickdevicesservice'] = {}; +AWS.IoT1ClickDevicesService = Service.defineService('iot1clickdevicesservice', ['2018-05-14']); +Object.defineProperty(apiLoader.services['iot1clickdevicesservice'], '2018-05-14', { + get: function get() { + var model = require('../apis/iot1click-devices-2018-05-14.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.IoT1ClickDevicesService; diff --git a/node_modules/aws-sdk/clients/iot1clickprojects.d.ts b/node_modules/aws-sdk/clients/iot1clickprojects.d.ts new file mode 100644 index 0000000..063ff5d --- /dev/null +++ b/node_modules/aws-sdk/clients/iot1clickprojects.d.ts @@ -0,0 +1,546 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class IoT1ClickProjects extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: IoT1ClickProjects.Types.ClientConfiguration) + config: Config & IoT1ClickProjects.Types.ClientConfiguration; + /** + * Associates a physical device with a placement. + */ + associateDeviceWithPlacement(params: IoT1ClickProjects.Types.AssociateDeviceWithPlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.AssociateDeviceWithPlacementResponse) => void): Request; + /** + * Associates a physical device with a placement. + */ + associateDeviceWithPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.AssociateDeviceWithPlacementResponse) => void): Request; + /** + * Creates an empty placement. + */ + createPlacement(params: IoT1ClickProjects.Types.CreatePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreatePlacementResponse) => void): Request; + /** + * Creates an empty placement. + */ + createPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreatePlacementResponse) => void): Request; + /** + * Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. + */ + createProject(params: IoT1ClickProjects.Types.CreateProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreateProjectResponse) => void): Request; + /** + * Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. + */ + createProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreateProjectResponse) => void): Request; + /** + * Deletes a placement. To delete a placement, it must not have any devices associated with it. When you delete a placement, all associated data becomes irretrievable. + */ + deletePlacement(params: IoT1ClickProjects.Types.DeletePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeletePlacementResponse) => void): Request; + /** + * Deletes a placement. To delete a placement, it must not have any devices associated with it. When you delete a placement, all associated data becomes irretrievable. + */ + deletePlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeletePlacementResponse) => void): Request; + /** + * Deletes a project. To delete a project, it must not have any placements associated with it. When you delete a project, all associated data becomes irretrievable. + */ + deleteProject(params: IoT1ClickProjects.Types.DeleteProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeleteProjectResponse) => void): Request; + /** + * Deletes a project. To delete a project, it must not have any placements associated with it. When you delete a project, all associated data becomes irretrievable. + */ + deleteProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeleteProjectResponse) => void): Request; + /** + * Describes a placement in a project. + */ + describePlacement(params: IoT1ClickProjects.Types.DescribePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribePlacementResponse) => void): Request; + /** + * Describes a placement in a project. + */ + describePlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribePlacementResponse) => void): Request; + /** + * Returns an object describing a project. + */ + describeProject(params: IoT1ClickProjects.Types.DescribeProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribeProjectResponse) => void): Request; + /** + * Returns an object describing a project. + */ + describeProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribeProjectResponse) => void): Request; + /** + * Removes a physical device from a placement. + */ + disassociateDeviceFromPlacement(params: IoT1ClickProjects.Types.DisassociateDeviceFromPlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DisassociateDeviceFromPlacementResponse) => void): Request; + /** + * Removes a physical device from a placement. + */ + disassociateDeviceFromPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DisassociateDeviceFromPlacementResponse) => void): Request; + /** + * Returns an object enumerating the devices in a placement. + */ + getDevicesInPlacement(params: IoT1ClickProjects.Types.GetDevicesInPlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.GetDevicesInPlacementResponse) => void): Request; + /** + * Returns an object enumerating the devices in a placement. + */ + getDevicesInPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.GetDevicesInPlacementResponse) => void): Request; + /** + * Lists the placement(s) of a project. + */ + listPlacements(params: IoT1ClickProjects.Types.ListPlacementsRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListPlacementsResponse) => void): Request; + /** + * Lists the placement(s) of a project. + */ + listPlacements(callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListPlacementsResponse) => void): Request; + /** + * Lists the AWS IoT 1-Click project(s) associated with your AWS account and region. + */ + listProjects(params: IoT1ClickProjects.Types.ListProjectsRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListProjectsResponse) => void): Request; + /** + * Lists the AWS IoT 1-Click project(s) associated with your AWS account and region. + */ + listProjects(callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListProjectsResponse) => void): Request; + /** + * Lists the tags (metadata key/value pairs) which you have assigned to the resource. + */ + listTagsForResource(params: IoT1ClickProjects.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags (metadata key/value pairs) which you have assigned to the resource. + */ + listTagsForResource(callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListTagsForResourceResponse) => void): Request; + /** + * Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies. + */ + tagResource(params: IoT1ClickProjects.Types.TagResourceRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.TagResourceResponse) => void): Request; + /** + * Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies. + */ + tagResource(callback?: (err: AWSError, data: IoT1ClickProjects.Types.TagResourceResponse) => void): Request; + /** + * Removes one or more tags (metadata key/value pairs) from a resource. + */ + untagResource(params: IoT1ClickProjects.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.UntagResourceResponse) => void): Request; + /** + * Removes one or more tags (metadata key/value pairs) from a resource. + */ + untagResource(callback?: (err: AWSError, data: IoT1ClickProjects.Types.UntagResourceResponse) => void): Request; + /** + * Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., ""). + */ + updatePlacement(params: IoT1ClickProjects.Types.UpdatePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdatePlacementResponse) => void): Request; + /** + * Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., ""). + */ + updatePlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdatePlacementResponse) => void): Request; + /** + * Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., ""). + */ + updateProject(params: IoT1ClickProjects.Types.UpdateProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdateProjectResponse) => void): Request; + /** + * Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., ""). + */ + updateProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdateProjectResponse) => void): Request; +} +declare namespace IoT1ClickProjects { + export interface AssociateDeviceWithPlacementRequest { + /** + * The name of the project containing the placement in which to associate the device. + */ + projectName: ProjectName; + /** + * The name of the placement in which to associate the device. + */ + placementName: PlacementName; + /** + * The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values. + */ + deviceId: DeviceId; + /** + * The device template name to associate with the device ID. + */ + deviceTemplateName: DeviceTemplateName; + } + export interface AssociateDeviceWithPlacementResponse { + } + export type AttributeDefaultValue = string; + export type AttributeName = string; + export type AttributeValue = string; + export interface CreatePlacementRequest { + /** + * The name of the placement to be created. + */ + placementName: PlacementName; + /** + * The name of the project in which to create the placement. + */ + projectName: ProjectName; + /** + * Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement. + */ + attributes?: PlacementAttributeMap; + } + export interface CreatePlacementResponse { + } + export interface CreateProjectRequest { + /** + * The name of the project to create. + */ + projectName: ProjectName; + /** + * An optional description for the project. + */ + description?: Description; + /** + * The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API. + */ + placementTemplate?: PlacementTemplate; + /** + * Optional tags (metadata key/value pairs) to be associated with the project. For example, { {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies. + */ + tags?: TagMap; + } + export interface CreateProjectResponse { + } + export type DefaultPlacementAttributeMap = {[key: string]: AttributeDefaultValue}; + export interface DeletePlacementRequest { + /** + * The name of the empty placement to delete. + */ + placementName: PlacementName; + /** + * The project containing the empty placement to delete. + */ + projectName: ProjectName; + } + export interface DeletePlacementResponse { + } + export interface DeleteProjectRequest { + /** + * The name of the empty project to delete. + */ + projectName: ProjectName; + } + export interface DeleteProjectResponse { + } + export interface DescribePlacementRequest { + /** + * The name of the placement within a project. + */ + placementName: PlacementName; + /** + * The project containing the placement to be described. + */ + projectName: ProjectName; + } + export interface DescribePlacementResponse { + /** + * An object describing the placement. + */ + placement: PlacementDescription; + } + export interface DescribeProjectRequest { + /** + * The name of the project to be described. + */ + projectName: ProjectName; + } + export interface DescribeProjectResponse { + /** + * An object describing the project. + */ + project: ProjectDescription; + } + export type Description = string; + export type DeviceCallbackKey = string; + export type DeviceCallbackOverrideMap = {[key: string]: DeviceCallbackValue}; + export type DeviceCallbackValue = string; + export type DeviceId = string; + export type DeviceMap = {[key: string]: DeviceId}; + export interface DeviceTemplate { + /** + * The device type, which currently must be "button". + */ + deviceType?: DeviceType; + /** + * An optional Lambda function to invoke instead of the default Lambda function provided by the placement template. + */ + callbackOverrides?: DeviceCallbackOverrideMap; + } + export type DeviceTemplateMap = {[key: string]: DeviceTemplate}; + export type DeviceTemplateName = string; + export type DeviceType = string; + export interface DisassociateDeviceFromPlacementRequest { + /** + * The name of the project that contains the placement. + */ + projectName: ProjectName; + /** + * The name of the placement that the device should be removed from. + */ + placementName: PlacementName; + /** + * The device ID that should be removed from the placement. + */ + deviceTemplateName: DeviceTemplateName; + } + export interface DisassociateDeviceFromPlacementResponse { + } + export interface GetDevicesInPlacementRequest { + /** + * The name of the project containing the placement. + */ + projectName: ProjectName; + /** + * The name of the placement to get the devices from. + */ + placementName: PlacementName; + } + export interface GetDevicesInPlacementResponse { + /** + * An object containing the devices (zero or more) within the placement. + */ + devices: DeviceMap; + } + export interface ListPlacementsRequest { + /** + * The project containing the placements to be listed. + */ + projectName: ProjectName; + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return per request. If not set, a default value of 100 is used. + */ + maxResults?: MaxResults; + } + export interface ListPlacementsResponse { + /** + * An object listing the requested placements. + */ + placements: PlacementSummaryList; + /** + * The token used to retrieve the next set of results - will be effectively empty if there are no further results. + */ + nextToken?: NextToken; + } + export interface ListProjectsRequest { + /** + * The token to retrieve the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return per request. If not set, a default value of 100 is used. + */ + maxResults?: MaxResults; + } + export interface ListProjectsResponse { + /** + * An object containing the list of projects. + */ + projects: ProjectSummaryList; + /** + * The token used to retrieve the next set of results - will be effectively empty if there are no further results. + */ + nextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The ARN of the resource whose tags you want to list. + */ + resourceArn: ProjectArn; + } + export interface ListTagsForResourceResponse { + /** + * The tags (metadata key/value pairs) which you have assigned to the resource. + */ + tags?: TagMap; + } + export type MaxResults = number; + export type NextToken = string; + export type PlacementAttributeMap = {[key: string]: AttributeValue}; + export interface PlacementDescription { + /** + * The name of the project containing the placement. + */ + projectName: ProjectName; + /** + * The name of the placement. + */ + placementName: PlacementName; + /** + * The user-defined attributes associated with the placement. + */ + attributes: PlacementAttributeMap; + /** + * The date when the placement was initially created, in UNIX epoch time format. + */ + createdDate: Time; + /** + * The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same. + */ + updatedDate: Time; + } + export type PlacementName = string; + export interface PlacementSummary { + /** + * The name of the project containing the placement. + */ + projectName: ProjectName; + /** + * The name of the placement being summarized. + */ + placementName: PlacementName; + /** + * The date when the placement was originally created, in UNIX epoch time format. + */ + createdDate: Time; + /** + * The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same. + */ + updatedDate: Time; + } + export type PlacementSummaryList = PlacementSummary[]; + export interface PlacementTemplate { + /** + * The default attributes (key/value pairs) to be applied to all placements using this template. + */ + defaultAttributes?: DefaultPlacementAttributeMap; + /** + * An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template. + */ + deviceTemplates?: DeviceTemplateMap; + } + export type ProjectArn = string; + export interface ProjectDescription { + /** + * The ARN of the project. + */ + arn?: ProjectArn; + /** + * The name of the project for which to obtain information from. + */ + projectName: ProjectName; + /** + * The description of the project. + */ + description?: Description; + /** + * The date when the project was originally created, in UNIX epoch time format. + */ + createdDate: Time; + /** + * The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same. + */ + updatedDate: Time; + /** + * An object describing the project's placement specifications. + */ + placementTemplate?: PlacementTemplate; + /** + * The tags (metadata key/value pairs) associated with the project. + */ + tags?: TagMap; + } + export type ProjectName = string; + export interface ProjectSummary { + /** + * The ARN of the project. + */ + arn?: ProjectArn; + /** + * The name of the project being summarized. + */ + projectName: ProjectName; + /** + * The date when the project was originally created, in UNIX epoch time format. + */ + createdDate: Time; + /** + * The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same. + */ + updatedDate: Time; + /** + * The tags (metadata key/value pairs) associated with the project. + */ + tags?: TagMap; + } + export type ProjectSummaryList = ProjectSummary[]; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagMap = {[key: string]: TagValue}; + export interface TagResourceRequest { + /** + * The ARN of the resouce for which tag(s) should be added or modified. + */ + resourceArn: ProjectArn; + /** + * The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource. + */ + tags: TagMap; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Time = Date; + export interface UntagResourceRequest { + /** + * The ARN of the resource whose tag you want to remove. + */ + resourceArn: ProjectArn; + /** + * The keys of those tags which you want to remove. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdatePlacementRequest { + /** + * The name of the placement to update. + */ + placementName: PlacementName; + /** + * The name of the project containing the placement to be updated. + */ + projectName: ProjectName; + /** + * The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50. + */ + attributes?: PlacementAttributeMap; + } + export interface UpdatePlacementResponse { + } + export interface UpdateProjectRequest { + /** + * The name of the project to be updated. + */ + projectName: ProjectName; + /** + * An optional user-defined description for the project. + */ + description?: Description; + /** + * An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API. + */ + placementTemplate?: PlacementTemplate; + } + export interface UpdateProjectResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-05-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the IoT1ClickProjects client. + */ + export import Types = IoT1ClickProjects; +} +export = IoT1ClickProjects; diff --git a/node_modules/aws-sdk/clients/iot1clickprojects.js b/node_modules/aws-sdk/clients/iot1clickprojects.js new file mode 100644 index 0000000..4e62a4c --- /dev/null +++ b/node_modules/aws-sdk/clients/iot1clickprojects.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['iot1clickprojects'] = {}; +AWS.IoT1ClickProjects = Service.defineService('iot1clickprojects', ['2018-05-14']); +Object.defineProperty(apiLoader.services['iot1clickprojects'], '2018-05-14', { + get: function get() { + var model = require('../apis/iot1click-projects-2018-05-14.min.json'); + model.paginators = require('../apis/iot1click-projects-2018-05-14.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.IoT1ClickProjects; diff --git a/node_modules/aws-sdk/clients/iotanalytics.d.ts b/node_modules/aws-sdk/clients/iotanalytics.d.ts new file mode 100644 index 0000000..afa1f28 --- /dev/null +++ b/node_modules/aws-sdk/clients/iotanalytics.d.ts @@ -0,0 +1,1658 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class IoTAnalytics extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: IoTAnalytics.Types.ClientConfiguration) + config: Config & IoTAnalytics.Types.ClientConfiguration; + /** + * Sends messages to a channel. + */ + batchPutMessage(params: IoTAnalytics.Types.BatchPutMessageRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.BatchPutMessageResponse) => void): Request; + /** + * Sends messages to a channel. + */ + batchPutMessage(callback?: (err: AWSError, data: IoTAnalytics.Types.BatchPutMessageResponse) => void): Request; + /** + * Cancels the reprocessing of data through the pipeline. + */ + cancelPipelineReprocessing(params: IoTAnalytics.Types.CancelPipelineReprocessingRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CancelPipelineReprocessingResponse) => void): Request; + /** + * Cancels the reprocessing of data through the pipeline. + */ + cancelPipelineReprocessing(callback?: (err: AWSError, data: IoTAnalytics.Types.CancelPipelineReprocessingResponse) => void): Request; + /** + * Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. + */ + createChannel(params: IoTAnalytics.Types.CreateChannelRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateChannelResponse) => void): Request; + /** + * Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. + */ + createChannel(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateChannelResponse) => void): Request; + /** + * Creates a data set. A data set stores data retrieved from a data store by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application). This operation creates the skeleton of a data set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify. + */ + createDataset(params: IoTAnalytics.Types.CreateDatasetRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetResponse) => void): Request; + /** + * Creates a data set. A data set stores data retrieved from a data store by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application). This operation creates the skeleton of a data set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify. + */ + createDataset(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetResponse) => void): Request; + /** + * Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application). + */ + createDatasetContent(params: IoTAnalytics.Types.CreateDatasetContentRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetContentResponse) => void): Request; + /** + * Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application). + */ + createDatasetContent(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetContentResponse) => void): Request; + /** + * Creates a data store, which is a repository for messages. + */ + createDatastore(params: IoTAnalytics.Types.CreateDatastoreRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request; + /** + * Creates a data store, which is a repository for messages. + */ + createDatastore(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request; + /** + * Creates a pipeline. A pipeline consumes messages from one or more channels and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. + */ + createPipeline(params: IoTAnalytics.Types.CreatePipelineRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreatePipelineResponse) => void): Request; + /** + * Creates a pipeline. A pipeline consumes messages from one or more channels and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. + */ + createPipeline(callback?: (err: AWSError, data: IoTAnalytics.Types.CreatePipelineResponse) => void): Request; + /** + * Deletes the specified channel. + */ + deleteChannel(params: IoTAnalytics.Types.DeleteChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified channel. + */ + deleteChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified data set. You do not have to delete the content of the data set before you perform this operation. + */ + deleteDataset(params: IoTAnalytics.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified data set. You do not have to delete the content of the data set before you perform this operation. + */ + deleteDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the content of the specified data set. + */ + deleteDatasetContent(params: IoTAnalytics.Types.DeleteDatasetContentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the content of the specified data set. + */ + deleteDatasetContent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified data store. + */ + deleteDatastore(params: IoTAnalytics.Types.DeleteDatastoreRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified data store. + */ + deleteDatastore(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified pipeline. + */ + deletePipeline(params: IoTAnalytics.Types.DeletePipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified pipeline. + */ + deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves information about a channel. + */ + describeChannel(params: IoTAnalytics.Types.DescribeChannelRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeChannelResponse) => void): Request; + /** + * Retrieves information about a channel. + */ + describeChannel(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeChannelResponse) => void): Request; + /** + * Retrieves information about a data set. + */ + describeDataset(params: IoTAnalytics.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatasetResponse) => void): Request; + /** + * Retrieves information about a data set. + */ + describeDataset(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatasetResponse) => void): Request; + /** + * Retrieves information about a data store. + */ + describeDatastore(params: IoTAnalytics.Types.DescribeDatastoreRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatastoreResponse) => void): Request; + /** + * Retrieves information about a data store. + */ + describeDatastore(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatastoreResponse) => void): Request; + /** + * Retrieves the current settings of the AWS IoT Analytics logging options. + */ + describeLoggingOptions(params: IoTAnalytics.Types.DescribeLoggingOptionsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeLoggingOptionsResponse) => void): Request; + /** + * Retrieves the current settings of the AWS IoT Analytics logging options. + */ + describeLoggingOptions(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeLoggingOptionsResponse) => void): Request; + /** + * Retrieves information about a pipeline. + */ + describePipeline(params: IoTAnalytics.Types.DescribePipelineRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribePipelineResponse) => void): Request; + /** + * Retrieves information about a pipeline. + */ + describePipeline(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribePipelineResponse) => void): Request; + /** + * Retrieves the contents of a data set as pre-signed URIs. + */ + getDatasetContent(params: IoTAnalytics.Types.GetDatasetContentRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.GetDatasetContentResponse) => void): Request; + /** + * Retrieves the contents of a data set as pre-signed URIs. + */ + getDatasetContent(callback?: (err: AWSError, data: IoTAnalytics.Types.GetDatasetContentResponse) => void): Request; + /** + * Retrieves a list of channels. + */ + listChannels(params: IoTAnalytics.Types.ListChannelsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListChannelsResponse) => void): Request; + /** + * Retrieves a list of channels. + */ + listChannels(callback?: (err: AWSError, data: IoTAnalytics.Types.ListChannelsResponse) => void): Request; + /** + * Lists information about data set contents that have been created. + */ + listDatasetContents(params: IoTAnalytics.Types.ListDatasetContentsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetContentsResponse) => void): Request; + /** + * Lists information about data set contents that have been created. + */ + listDatasetContents(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetContentsResponse) => void): Request; + /** + * Retrieves information about data sets. + */ + listDatasets(params: IoTAnalytics.Types.ListDatasetsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetsResponse) => void): Request; + /** + * Retrieves information about data sets. + */ + listDatasets(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetsResponse) => void): Request; + /** + * Retrieves a list of data stores. + */ + listDatastores(params: IoTAnalytics.Types.ListDatastoresRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatastoresResponse) => void): Request; + /** + * Retrieves a list of data stores. + */ + listDatastores(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatastoresResponse) => void): Request; + /** + * Retrieves a list of pipelines. + */ + listPipelines(params: IoTAnalytics.Types.ListPipelinesRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListPipelinesResponse) => void): Request; + /** + * Retrieves a list of pipelines. + */ + listPipelines(callback?: (err: AWSError, data: IoTAnalytics.Types.ListPipelinesResponse) => void): Request; + /** + * Lists the tags (metadata) which you have assigned to the resource. + */ + listTagsForResource(params: IoTAnalytics.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags (metadata) which you have assigned to the resource. + */ + listTagsForResource(callback?: (err: AWSError, data: IoTAnalytics.Types.ListTagsForResourceResponse) => void): Request; + /** + * Sets or updates the AWS IoT Analytics logging options. Note that if you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect. + */ + putLoggingOptions(params: IoTAnalytics.Types.PutLoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets or updates the AWS IoT Analytics logging options. Note that if you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect. + */ + putLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Simulates the results of running a pipeline activity on a message payload. + */ + runPipelineActivity(params: IoTAnalytics.Types.RunPipelineActivityRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.RunPipelineActivityResponse) => void): Request; + /** + * Simulates the results of running a pipeline activity on a message payload. + */ + runPipelineActivity(callback?: (err: AWSError, data: IoTAnalytics.Types.RunPipelineActivityResponse) => void): Request; + /** + * Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved. + */ + sampleChannelData(params: IoTAnalytics.Types.SampleChannelDataRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.SampleChannelDataResponse) => void): Request; + /** + * Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved. + */ + sampleChannelData(callback?: (err: AWSError, data: IoTAnalytics.Types.SampleChannelDataResponse) => void): Request; + /** + * Starts the reprocessing of raw message data through the pipeline. + */ + startPipelineReprocessing(params: IoTAnalytics.Types.StartPipelineReprocessingRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.StartPipelineReprocessingResponse) => void): Request; + /** + * Starts the reprocessing of raw message data through the pipeline. + */ + startPipelineReprocessing(callback?: (err: AWSError, data: IoTAnalytics.Types.StartPipelineReprocessingResponse) => void): Request; + /** + * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. + */ + tagResource(params: IoTAnalytics.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.TagResourceResponse) => void): Request; + /** + * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. + */ + tagResource(callback?: (err: AWSError, data: IoTAnalytics.Types.TagResourceResponse) => void): Request; + /** + * Removes the given tags (metadata) from the resource. + */ + untagResource(params: IoTAnalytics.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.UntagResourceResponse) => void): Request; + /** + * Removes the given tags (metadata) from the resource. + */ + untagResource(callback?: (err: AWSError, data: IoTAnalytics.Types.UntagResourceResponse) => void): Request; + /** + * Updates the settings of a channel. + */ + updateChannel(params: IoTAnalytics.Types.UpdateChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings of a channel. + */ + updateChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings of a data set. + */ + updateDataset(params: IoTAnalytics.Types.UpdateDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings of a data set. + */ + updateDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings of a data store. + */ + updateDatastore(params: IoTAnalytics.Types.UpdateDatastoreRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings of a data store. + */ + updateDatastore(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. + */ + updatePipeline(params: IoTAnalytics.Types.UpdatePipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. + */ + updatePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace IoTAnalytics { + export type ActivityBatchSize = number; + export type ActivityName = string; + export interface AddAttributesActivity { + /** + * The name of the 'addAttributes' activity. + */ + name: ActivityName; + /** + * A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute. The existing attributes remain in the message, so if you want to remove the originals, use "RemoveAttributeActivity". + */ + attributes: AttributeNameMapping; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type AttributeName = string; + export type AttributeNameMapping = {[key: string]: AttributeName}; + export type AttributeNames = AttributeName[]; + export type BatchPutMessageErrorEntries = BatchPutMessageErrorEntry[]; + export interface BatchPutMessageErrorEntry { + /** + * The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the message object.) + */ + messageId?: MessageId; + /** + * The code associated with the error. + */ + errorCode?: ErrorCode; + /** + * The message associated with the error. + */ + errorMessage?: ErrorMessage; + } + export interface BatchPutMessageRequest { + /** + * The name of the channel where the messages are sent. + */ + channelName: ChannelName; + /** + * The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'. Note that the field names of message payloads (data) that you send to AWS IoT Analytics: Must contain only alphanumeric characters and undescores (_); no other special characters are allowed. Must begin with an alphabetic character or single underscore (_). Cannot contain hyphens (-). In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$". Cannot be greater than 255 characters. Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.) For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads. + */ + messages: Messages; + } + export interface BatchPutMessageResponse { + /** + * A list of any errors encountered when sending the messages to the channel. + */ + batchPutMessageErrorEntries?: BatchPutMessageErrorEntries; + } + export interface CancelPipelineReprocessingRequest { + /** + * The name of pipeline for which data reprocessing is canceled. + */ + pipelineName: PipelineName; + /** + * The ID of the reprocessing task (returned by "StartPipelineReprocessing"). + */ + reprocessingId: ReprocessingId; + } + export interface CancelPipelineReprocessingResponse { + } + export interface Channel { + /** + * The name of the channel. + */ + name?: ChannelName; + /** + * The ARN of the channel. + */ + arn?: ChannelArn; + /** + * The status of the channel. + */ + status?: ChannelStatus; + /** + * How long, in days, message data is kept for the channel. + */ + retentionPeriod?: RetentionPeriod; + /** + * When the channel was created. + */ + creationTime?: Timestamp; + /** + * When the channel was last updated. + */ + lastUpdateTime?: Timestamp; + } + export interface ChannelActivity { + /** + * The name of the 'channel' activity. + */ + name: ActivityName; + /** + * The name of the channel from which the messages are processed. + */ + channelName: ChannelName; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type ChannelArn = string; + export type ChannelName = string; + export interface ChannelStatistics { + /** + * The estimated size of the channel. + */ + size?: EstimatedResourceSize; + } + export type ChannelStatus = "CREATING"|"ACTIVE"|"DELETING"|string; + export type ChannelSummaries = ChannelSummary[]; + export interface ChannelSummary { + /** + * The name of the channel. + */ + channelName?: ChannelName; + /** + * The status of the channel. + */ + status?: ChannelStatus; + /** + * When the channel was created. + */ + creationTime?: Timestamp; + /** + * The last time the channel was updated. + */ + lastUpdateTime?: Timestamp; + } + export type ComputeType = "ACU_1"|"ACU_2"|string; + export interface ContainerDatasetAction { + /** + * The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents. + */ + image: Image; + /** + * The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application. + */ + executionRoleArn: RoleArn; + /** + * Configuration of the resource which executes the "containerAction". + */ + resourceConfiguration: ResourceConfiguration; + /** + * The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue". + */ + variables?: Variables; + } + export interface CreateChannelRequest { + /** + * The name of the channel. + */ + channelName: ChannelName; + /** + * How long, in days, message data is kept for the channel. + */ + retentionPeriod?: RetentionPeriod; + /** + * Metadata which can be used to manage the channel. + */ + tags?: TagList; + } + export interface CreateChannelResponse { + /** + * The name of the channel. + */ + channelName?: ChannelName; + /** + * The ARN of the channel. + */ + channelArn?: ChannelArn; + /** + * How long, in days, message data is kept for the channel. + */ + retentionPeriod?: RetentionPeriod; + } + export interface CreateDatasetContentRequest { + /** + * The name of the data set. + */ + datasetName: DatasetName; + } + export interface CreateDatasetContentResponse { + /** + * The version ID of the data set contents which are being created. + */ + versionId?: DatasetContentVersion; + } + export interface CreateDatasetRequest { + /** + * The name of the data set. + */ + datasetName: DatasetName; + /** + * A list of actions that create the data set contents. + */ + actions: DatasetActions; + /** + * A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects. + */ + triggers?: DatasetTriggers; + /** + * When data set contents are created they are delivered to destinations specified here. + */ + contentDeliveryRules?: DatasetContentDeliveryRules; + /** + * [Optional] How long, in days, versions of data set contents are kept for the data set. If not specified or set to null, versions of data set contents are retained for at most 90 days. The number of versions of data set contents retained is determined by the versioningConfiguration parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + */ + retentionPeriod?: RetentionPeriod; + /** + * [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the "retentionPeriod" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + */ + versioningConfiguration?: VersioningConfiguration; + /** + * Metadata which can be used to manage the data set. + */ + tags?: TagList; + } + export interface CreateDatasetResponse { + /** + * The name of the data set. + */ + datasetName?: DatasetName; + /** + * The ARN of the data set. + */ + datasetArn?: DatasetArn; + /** + * How long, in days, data set contents are kept for the data set. + */ + retentionPeriod?: RetentionPeriod; + } + export interface CreateDatastoreRequest { + /** + * The name of the data store. + */ + datastoreName: DatastoreName; + /** + * How long, in days, message data is kept for the data store. + */ + retentionPeriod?: RetentionPeriod; + /** + * Metadata which can be used to manage the data store. + */ + tags?: TagList; + } + export interface CreateDatastoreResponse { + /** + * The name of the data store. + */ + datastoreName?: DatastoreName; + /** + * The ARN of the data store. + */ + datastoreArn?: DatastoreArn; + /** + * How long, in days, message data is kept for the data store. + */ + retentionPeriod?: RetentionPeriod; + } + export interface CreatePipelineRequest { + /** + * The name of the pipeline. + */ + pipelineName: PipelineName; + /** + * A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example: pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ] + */ + pipelineActivities: PipelineActivities; + /** + * Metadata which can be used to manage the pipeline. + */ + tags?: TagList; + } + export interface CreatePipelineResponse { + /** + * The name of the pipeline. + */ + pipelineName?: PipelineName; + /** + * The ARN of the pipeline. + */ + pipelineArn?: PipelineArn; + } + export interface Dataset { + /** + * The name of the data set. + */ + name?: DatasetName; + /** + * The ARN of the data set. + */ + arn?: DatasetArn; + /** + * The "DatasetAction" objects that automatically create the data set contents. + */ + actions?: DatasetActions; + /** + * The "DatasetTrigger" objects that specify when the data set is automatically updated. + */ + triggers?: DatasetTriggers; + /** + * When data set contents are created they are delivered to destinations specified here. + */ + contentDeliveryRules?: DatasetContentDeliveryRules; + /** + * The status of the data set. + */ + status?: DatasetStatus; + /** + * When the data set was created. + */ + creationTime?: Timestamp; + /** + * The last time the data set was updated. + */ + lastUpdateTime?: Timestamp; + /** + * [Optional] How long, in days, message data is kept for the data set. + */ + retentionPeriod?: RetentionPeriod; + /** + * [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the "retentionPeriod" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + */ + versioningConfiguration?: VersioningConfiguration; + } + export interface DatasetAction { + /** + * The name of the data set action by which data set contents are automatically created. + */ + actionName?: DatasetActionName; + /** + * An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents. + */ + queryAction?: SqlQueryDatasetAction; + /** + * Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries. + */ + containerAction?: ContainerDatasetAction; + } + export type DatasetActionName = string; + export type DatasetActionSummaries = DatasetActionSummary[]; + export interface DatasetActionSummary { + /** + * The name of the action which automatically creates the data set's contents. + */ + actionName?: DatasetActionName; + /** + * The type of action by which the data set's contents are automatically created. + */ + actionType?: DatasetActionType; + } + export type DatasetActionType = "QUERY"|"CONTAINER"|string; + export type DatasetActions = DatasetAction[]; + export type DatasetArn = string; + export interface DatasetContentDeliveryDestination { + /** + * Configuration information for delivery of data set contents to AWS IoT Events. + */ + iotEventsDestinationConfiguration?: IotEventsDestinationConfiguration; + } + export interface DatasetContentDeliveryRule { + /** + * The name of the data set content delivery rules entry. + */ + entryName?: EntryName; + /** + * The destination to which data set contents are delivered. + */ + destination: DatasetContentDeliveryDestination; + } + export type DatasetContentDeliveryRules = DatasetContentDeliveryRule[]; + export type DatasetContentState = "CREATING"|"SUCCEEDED"|"FAILED"|string; + export interface DatasetContentStatus { + /** + * The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED". + */ + state?: DatasetContentState; + /** + * The reason the data set contents are in this state. + */ + reason?: Reason; + } + export type DatasetContentSummaries = DatasetContentSummary[]; + export interface DatasetContentSummary { + /** + * The version of the data set contents. + */ + version?: DatasetContentVersion; + /** + * The status of the data set contents. + */ + status?: DatasetContentStatus; + /** + * The actual time the creation of the data set contents was started. + */ + creationTime?: Timestamp; + /** + * The time the creation of the data set contents was scheduled to start. + */ + scheduleTime?: Timestamp; + } + export type DatasetContentVersion = string; + export interface DatasetContentVersionValue { + /** + * The name of the data set whose latest contents are used as input to the notebook or application. + */ + datasetName: DatasetName; + } + export type DatasetEntries = DatasetEntry[]; + export interface DatasetEntry { + /** + * The name of the data set item. + */ + entryName?: EntryName; + /** + * The pre-signed URI of the data set item. + */ + dataURI?: PresignedURI; + } + export type DatasetName = string; + export type DatasetStatus = "CREATING"|"ACTIVE"|"DELETING"|string; + export type DatasetSummaries = DatasetSummary[]; + export interface DatasetSummary { + /** + * The name of the data set. + */ + datasetName?: DatasetName; + /** + * The status of the data set. + */ + status?: DatasetStatus; + /** + * The time the data set was created. + */ + creationTime?: Timestamp; + /** + * The last time the data set was updated. + */ + lastUpdateTime?: Timestamp; + /** + * A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects + */ + triggers?: DatasetTriggers; + /** + * A list of "DataActionSummary" objects. + */ + actions?: DatasetActionSummaries; + } + export interface DatasetTrigger { + /** + * The "Schedule" when the trigger is initiated. + */ + schedule?: Schedule; + /** + * The data set whose content creation triggers the creation of this data set's contents. + */ + dataset?: TriggeringDataset; + } + export type DatasetTriggers = DatasetTrigger[]; + export interface Datastore { + /** + * The name of the data store. + */ + name?: DatastoreName; + /** + * The ARN of the data store. + */ + arn?: DatastoreArn; + /** + * The status of a data store: CREATING The data store is being created. ACTIVE The data store has been created and can be used. DELETING The data store is being deleted. + */ + status?: DatastoreStatus; + /** + * How long, in days, message data is kept for the data store. + */ + retentionPeriod?: RetentionPeriod; + /** + * When the data store was created. + */ + creationTime?: Timestamp; + /** + * The last time the data store was updated. + */ + lastUpdateTime?: Timestamp; + } + export interface DatastoreActivity { + /** + * The name of the 'datastore' activity. + */ + name: ActivityName; + /** + * The name of the data store where processed messages are stored. + */ + datastoreName: DatastoreName; + } + export type DatastoreArn = string; + export type DatastoreName = string; + export interface DatastoreStatistics { + /** + * The estimated size of the data store. + */ + size?: EstimatedResourceSize; + } + export type DatastoreStatus = "CREATING"|"ACTIVE"|"DELETING"|string; + export type DatastoreSummaries = DatastoreSummary[]; + export interface DatastoreSummary { + /** + * The name of the data store. + */ + datastoreName?: DatastoreName; + /** + * The status of the data store. + */ + status?: DatastoreStatus; + /** + * When the data store was created. + */ + creationTime?: Timestamp; + /** + * The last time the data store was updated. + */ + lastUpdateTime?: Timestamp; + } + export interface DeleteChannelRequest { + /** + * The name of the channel to delete. + */ + channelName: ChannelName; + } + export interface DeleteDatasetContentRequest { + /** + * The name of the data set whose content is deleted. + */ + datasetName: DatasetName; + /** + * The version of the data set whose content is deleted. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default. + */ + versionId?: DatasetContentVersion; + } + export interface DeleteDatasetRequest { + /** + * The name of the data set to delete. + */ + datasetName: DatasetName; + } + export interface DeleteDatastoreRequest { + /** + * The name of the data store to delete. + */ + datastoreName: DatastoreName; + } + export interface DeletePipelineRequest { + /** + * The name of the pipeline to delete. + */ + pipelineName: PipelineName; + } + export interface DeltaTime { + /** + * The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the "in flight" time of your message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame. + */ + offsetSeconds: OffsetSeconds; + /** + * An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated. + */ + timeExpression: TimeExpression; + } + export interface DescribeChannelRequest { + /** + * The name of the channel whose information is retrieved. + */ + channelName: ChannelName; + /** + * If true, additional statistical information about the channel is included in the response. + */ + includeStatistics?: IncludeStatisticsFlag; + } + export interface DescribeChannelResponse { + /** + * An object that contains information about the channel. + */ + channel?: Channel; + /** + * Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request. + */ + statistics?: ChannelStatistics; + } + export interface DescribeDatasetRequest { + /** + * The name of the data set whose information is retrieved. + */ + datasetName: DatasetName; + } + export interface DescribeDatasetResponse { + /** + * An object that contains information about the data set. + */ + dataset?: Dataset; + } + export interface DescribeDatastoreRequest { + /** + * The name of the data store + */ + datastoreName: DatastoreName; + /** + * If true, additional statistical information about the datastore is included in the response. + */ + includeStatistics?: IncludeStatisticsFlag; + } + export interface DescribeDatastoreResponse { + /** + * Information about the data store. + */ + datastore?: Datastore; + /** + * Additional statistical information about the data store. Included if the 'includeStatistics' parameter is set to true in the request. + */ + statistics?: DatastoreStatistics; + } + export interface DescribeLoggingOptionsRequest { + } + export interface DescribeLoggingOptionsResponse { + /** + * The current settings of the AWS IoT Analytics logging options. + */ + loggingOptions?: LoggingOptions; + } + export interface DescribePipelineRequest { + /** + * The name of the pipeline whose information is retrieved. + */ + pipelineName: PipelineName; + } + export interface DescribePipelineResponse { + /** + * A "Pipeline" object that contains information about the pipeline. + */ + pipeline?: Pipeline; + } + export interface DeviceRegistryEnrichActivity { + /** + * The name of the 'deviceRegistryEnrich' activity. + */ + name: ActivityName; + /** + * The name of the attribute that is added to the message. + */ + attribute: AttributeName; + /** + * The name of the IoT device whose registry information is added to the message. + */ + thingName: AttributeName; + /** + * The ARN of the role that allows access to the device's registry information. + */ + roleArn: RoleArn; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export interface DeviceShadowEnrichActivity { + /** + * The name of the 'deviceShadowEnrich' activity. + */ + name: ActivityName; + /** + * The name of the attribute that is added to the message. + */ + attribute: AttributeName; + /** + * The name of the IoT device whose shadow information is added to the message. + */ + thingName: AttributeName; + /** + * The ARN of the role that allows access to the device's shadow. + */ + roleArn: RoleArn; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type DoubleValue = number; + export type EndTime = Date; + export type EntryName = string; + export type ErrorCode = string; + export type ErrorMessage = string; + export interface EstimatedResourceSize { + /** + * The estimated size of the resource in bytes. + */ + estimatedSizeInBytes?: SizeInBytes; + /** + * The time when the estimate of the size of the resource was made. + */ + estimatedOn?: Timestamp; + } + export interface FilterActivity { + /** + * The name of the 'filter' activity. + */ + name: ActivityName; + /** + * An expression that looks like a SQL WHERE clause that must return a Boolean value. + */ + filter: FilterExpression; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type FilterExpression = string; + export interface GetDatasetContentRequest { + /** + * The name of the data set whose contents are retrieved. + */ + datasetName: DatasetName; + /** + * The version of the data set whose contents are retrieved. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default. + */ + versionId?: DatasetContentVersion; + } + export interface GetDatasetContentResponse { + /** + * A list of "DatasetEntry" objects. + */ + entries?: DatasetEntries; + /** + * The time when the request was made. + */ + timestamp?: Timestamp; + /** + * The status of the data set content. + */ + status?: DatasetContentStatus; + } + export type Image = string; + export type IncludeStatisticsFlag = boolean; + export interface IotEventsDestinationConfiguration { + /** + * The name of the AWS IoT Events input to which data set contents are delivered. + */ + inputName: IotEventsInputName; + /** + * The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input. + */ + roleArn: RoleArn; + } + export type IotEventsInputName = string; + export interface LambdaActivity { + /** + * The name of the 'lambda' activity. + */ + name: ActivityName; + /** + * The name of the Lambda function that is run on the message. + */ + lambdaName: LambdaName; + /** + * The number of messages passed to the Lambda function for processing. The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions. + */ + batchSize: ActivityBatchSize; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type LambdaName = string; + export interface ListChannelsRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this request. The default value is 100. + */ + maxResults?: MaxResults; + } + export interface ListChannelsResponse { + /** + * A list of "ChannelSummary" objects. + */ + channelSummaries?: ChannelSummaries; + /** + * The token to retrieve the next set of results, or null if there are no more results. + */ + nextToken?: NextToken; + } + export interface ListDatasetContentsRequest { + /** + * The name of the data set whose contents information you want to list. + */ + datasetName: DatasetName; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this request. + */ + maxResults?: MaxResults; + /** + * A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp) + */ + scheduledOnOrAfter?: Timestamp; + /** + * A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp) + */ + scheduledBefore?: Timestamp; + } + export interface ListDatasetContentsResponse { + /** + * Summary information about data set contents that have been created. + */ + datasetContentSummaries?: DatasetContentSummaries; + /** + * The token to retrieve the next set of results, or null if there are no more results. + */ + nextToken?: NextToken; + } + export interface ListDatasetsRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this request. The default value is 100. + */ + maxResults?: MaxResults; + } + export interface ListDatasetsResponse { + /** + * A list of "DatasetSummary" objects. + */ + datasetSummaries?: DatasetSummaries; + /** + * The token to retrieve the next set of results, or null if there are no more results. + */ + nextToken?: NextToken; + } + export interface ListDatastoresRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this request. The default value is 100. + */ + maxResults?: MaxResults; + } + export interface ListDatastoresResponse { + /** + * A list of "DatastoreSummary" objects. + */ + datastoreSummaries?: DatastoreSummaries; + /** + * The token to retrieve the next set of results, or null if there are no more results. + */ + nextToken?: NextToken; + } + export interface ListPipelinesRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in this request. The default value is 100. + */ + maxResults?: MaxResults; + } + export interface ListPipelinesResponse { + /** + * A list of "PipelineSummary" objects. + */ + pipelineSummaries?: PipelineSummaries; + /** + * The token to retrieve the next set of results, or null if there are no more results. + */ + nextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * The ARN of the resource whose tags you want to list. + */ + resourceArn: ResourceArn; + } + export interface ListTagsForResourceResponse { + /** + * The tags (metadata) which you have assigned to the resource. + */ + tags?: TagList; + } + export type LogResult = string; + export type LoggingEnabled = boolean; + export type LoggingLevel = "ERROR"|string; + export interface LoggingOptions { + /** + * The ARN of the role that grants permission to AWS IoT Analytics to perform logging. + */ + roleArn: RoleArn; + /** + * The logging level. Currently, only "ERROR" is supported. + */ + level: LoggingLevel; + /** + * If true, logging is enabled for AWS IoT Analytics. + */ + enabled: LoggingEnabled; + } + export interface MathActivity { + /** + * The name of the 'math' activity. + */ + name: ActivityName; + /** + * The name of the attribute that contains the result of the math operation. + */ + attribute: AttributeName; + /** + * An expression that uses one or more existing attributes and must return an integer value. + */ + math: MathExpression; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type MathExpression = string; + export type MaxMessages = number; + export type MaxResults = number; + export type MaxVersions = number; + export interface Message { + /** + * The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent. + */ + messageId: MessageId; + /** + * The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity). + */ + payload: MessagePayload; + } + export type MessageId = string; + export type MessagePayload = Buffer|Uint8Array|Blob|string; + export type MessagePayloads = MessagePayload[]; + export type Messages = Message[]; + export type NextToken = string; + export type OffsetSeconds = number; + export type OutputFileName = string; + export interface OutputFileUriValue { + /** + * The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket. + */ + fileName: OutputFileName; + } + export interface Pipeline { + /** + * The name of the pipeline. + */ + name?: PipelineName; + /** + * The ARN of the pipeline. + */ + arn?: PipelineArn; + /** + * The activities that perform transformations on the messages. + */ + activities?: PipelineActivities; + /** + * A summary of information about the pipeline reprocessing. + */ + reprocessingSummaries?: ReprocessingSummaries; + /** + * When the pipeline was created. + */ + creationTime?: Timestamp; + /** + * The last time the pipeline was updated. + */ + lastUpdateTime?: Timestamp; + } + export type PipelineActivities = PipelineActivity[]; + export interface PipelineActivity { + /** + * Determines the source of the messages to be processed. + */ + channel?: ChannelActivity; + /** + * Runs a Lambda function to modify the message. + */ + lambda?: LambdaActivity; + /** + * Specifies where to store the processed message data. + */ + datastore?: DatastoreActivity; + /** + * Adds other attributes based on existing attributes in the message. + */ + addAttributes?: AddAttributesActivity; + /** + * Removes attributes from a message. + */ + removeAttributes?: RemoveAttributesActivity; + /** + * Creates a new message using only the specified attributes from the original message. + */ + selectAttributes?: SelectAttributesActivity; + /** + * Filters a message based on its attributes. + */ + filter?: FilterActivity; + /** + * Computes an arithmetic expression using the message's attributes and adds it to the message. + */ + math?: MathActivity; + /** + * Adds data from the AWS IoT device registry to your message. + */ + deviceRegistryEnrich?: DeviceRegistryEnrichActivity; + /** + * Adds information from the AWS IoT Device Shadows service to a message. + */ + deviceShadowEnrich?: DeviceShadowEnrichActivity; + } + export type PipelineArn = string; + export type PipelineName = string; + export type PipelineSummaries = PipelineSummary[]; + export interface PipelineSummary { + /** + * The name of the pipeline. + */ + pipelineName?: PipelineName; + /** + * A summary of information about the pipeline reprocessing. + */ + reprocessingSummaries?: ReprocessingSummaries; + /** + * When the pipeline was created. + */ + creationTime?: Timestamp; + /** + * When the pipeline was last updated. + */ + lastUpdateTime?: Timestamp; + } + export type PresignedURI = string; + export interface PutLoggingOptionsRequest { + /** + * The new values of the AWS IoT Analytics logging options. + */ + loggingOptions: LoggingOptions; + } + export interface QueryFilter { + /** + * Used to limit data to that which has arrived since the last execution of the action. + */ + deltaTime?: DeltaTime; + } + export type QueryFilters = QueryFilter[]; + export type Reason = string; + export interface RemoveAttributesActivity { + /** + * The name of the 'removeAttributes' activity. + */ + name: ActivityName; + /** + * A list of 1-50 attributes to remove from the message. + */ + attributes: AttributeNames; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type ReprocessingId = string; + export type ReprocessingStatus = "RUNNING"|"SUCCEEDED"|"CANCELLED"|"FAILED"|string; + export type ReprocessingSummaries = ReprocessingSummary[]; + export interface ReprocessingSummary { + /** + * The 'reprocessingId' returned by "StartPipelineReprocessing". + */ + id?: ReprocessingId; + /** + * The status of the pipeline reprocessing. + */ + status?: ReprocessingStatus; + /** + * The time the pipeline reprocessing was created. + */ + creationTime?: Timestamp; + } + export type ResourceArn = string; + export interface ResourceConfiguration { + /** + * The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB). + */ + computeType: ComputeType; + /** + * The size (in GB) of the persistent storage available to the resource instance used to execute the "containerAction" (min: 1, max: 50). + */ + volumeSizeInGB: VolumeSizeInGB; + } + export interface RetentionPeriod { + /** + * If true, message data is kept indefinitely. + */ + unlimited?: UnlimitedRetentionPeriod; + /** + * The number of days that message data is kept. The "unlimited" parameter must be false. + */ + numberOfDays?: RetentionPeriodInDays; + } + export type RetentionPeriodInDays = number; + export type RoleArn = string; + export interface RunPipelineActivityRequest { + /** + * The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a 'lambda' activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used. + */ + pipelineActivity: PipelineActivity; + /** + * The sample message payloads on which the pipeline activity is run. + */ + payloads: MessagePayloads; + } + export interface RunPipelineActivityResponse { + /** + * The enriched or transformed sample message payloads as base64-encoded strings. (The results of running the pipeline activity on each input sample message payload, encoded in base64.) + */ + payloads?: MessagePayloads; + /** + * In case the pipeline activity fails, the log message that is generated. + */ + logResult?: LogResult; + } + export interface SampleChannelDataRequest { + /** + * The name of the channel whose message samples are retrieved. + */ + channelName: ChannelName; + /** + * The number of sample messages to be retrieved. The limit is 10, the default is also 10. + */ + maxMessages?: MaxMessages; + /** + * The start of the time window from which sample messages are retrieved. + */ + startTime?: StartTime; + /** + * The end of the time window from which sample messages are retrieved. + */ + endTime?: EndTime; + } + export interface SampleChannelDataResponse { + /** + * The list of message samples. Each sample message is returned as a base64-encoded string. + */ + payloads?: MessagePayloads; + } + export interface Schedule { + /** + * The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide. + */ + expression?: ScheduleExpression; + } + export type ScheduleExpression = string; + export interface SelectAttributesActivity { + /** + * The name of the 'selectAttributes' activity. + */ + name: ActivityName; + /** + * A list of the attributes to select from the message. + */ + attributes: AttributeNames; + /** + * The next activity in the pipeline. + */ + next?: ActivityName; + } + export type SizeInBytes = number; + export type SqlQuery = string; + export interface SqlQueryDatasetAction { + /** + * A SQL query string. + */ + sqlQuery: SqlQuery; + /** + * Pre-filters applied to message data. + */ + filters?: QueryFilters; + } + export interface StartPipelineReprocessingRequest { + /** + * The name of the pipeline on which to start reprocessing. + */ + pipelineName: PipelineName; + /** + * The start time (inclusive) of raw message data that is reprocessed. + */ + startTime?: StartTime; + /** + * The end time (exclusive) of raw message data that is reprocessed. + */ + endTime?: EndTime; + } + export interface StartPipelineReprocessingResponse { + /** + * The ID of the pipeline reprocessing activity that was started. + */ + reprocessingId?: ReprocessingId; + } + export type StartTime = Date; + export type StringValue = string; + export interface Tag { + /** + * The tag's key. + */ + key: TagKey; + /** + * The tag's value. + */ + value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The ARN of the resource whose tags you want to modify. + */ + resourceArn: ResourceArn; + /** + * The new or modified tags for the resource. + */ + tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type TimeExpression = string; + export type Timestamp = Date; + export interface TriggeringDataset { + /** + * The name of the data set whose content generation triggers the new data set content generation. + */ + name: DatasetName; + } + export type UnlimitedRetentionPeriod = boolean; + export type UnlimitedVersioning = boolean; + export interface UntagResourceRequest { + /** + * The ARN of the resource whose tags you want to remove. + */ + resourceArn: ResourceArn; + /** + * The keys of those tags which you want to remove. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateChannelRequest { + /** + * The name of the channel to be updated. + */ + channelName: ChannelName; + /** + * How long, in days, message data is kept for the channel. + */ + retentionPeriod?: RetentionPeriod; + } + export interface UpdateDatasetRequest { + /** + * The name of the data set to update. + */ + datasetName: DatasetName; + /** + * A list of "DatasetAction" objects. + */ + actions: DatasetActions; + /** + * A list of "DatasetTrigger" objects. The list can be empty or can contain up to five DataSetTrigger objects. + */ + triggers?: DatasetTriggers; + /** + * When data set contents are created they are delivered to destinations specified here. + */ + contentDeliveryRules?: DatasetContentDeliveryRules; + /** + * How long, in days, data set contents are kept for the data set. + */ + retentionPeriod?: RetentionPeriod; + /** + * [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the "retentionPeriod" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + */ + versioningConfiguration?: VersioningConfiguration; + } + export interface UpdateDatastoreRequest { + /** + * The name of the data store to be updated. + */ + datastoreName: DatastoreName; + /** + * How long, in days, message data is kept for the data store. + */ + retentionPeriod?: RetentionPeriod; + } + export interface UpdatePipelineRequest { + /** + * The name of the pipeline to update. + */ + pipelineName: PipelineName; + /** + * A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example: pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ] + */ + pipelineActivities: PipelineActivities; + } + export interface Variable { + /** + * The name of the variable. + */ + name: VariableName; + /** + * The value of the variable as a string. + */ + stringValue?: StringValue; + /** + * The value of the variable as a double (numeric). + */ + doubleValue?: DoubleValue; + /** + * The value of the variable as a structure that specifies a data set content version. + */ + datasetContentVersionValue?: DatasetContentVersionValue; + /** + * The value of the variable as a structure that specifies an output file URI. + */ + outputFileUriValue?: OutputFileUriValue; + } + export type VariableName = string; + export type Variables = Variable[]; + export interface VersioningConfiguration { + /** + * If true, unlimited versions of data set contents will be kept. + */ + unlimited?: UnlimitedVersioning; + /** + * How many versions of data set contents will be kept. The "unlimited" parameter must be false. + */ + maxVersions?: MaxVersions; + } + export type VolumeSizeInGB = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-11-27"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the IoTAnalytics client. + */ + export import Types = IoTAnalytics; +} +export = IoTAnalytics; diff --git a/node_modules/aws-sdk/clients/iotanalytics.js b/node_modules/aws-sdk/clients/iotanalytics.js new file mode 100644 index 0000000..f417239 --- /dev/null +++ b/node_modules/aws-sdk/clients/iotanalytics.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['iotanalytics'] = {}; +AWS.IoTAnalytics = Service.defineService('iotanalytics', ['2017-11-27']); +Object.defineProperty(apiLoader.services['iotanalytics'], '2017-11-27', { + get: function get() { + var model = require('../apis/iotanalytics-2017-11-27.min.json'); + model.paginators = require('../apis/iotanalytics-2017-11-27.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.IoTAnalytics; diff --git a/node_modules/aws-sdk/clients/iotdata.d.ts b/node_modules/aws-sdk/clients/iotdata.d.ts new file mode 100644 index 0000000..9442009 --- /dev/null +++ b/node_modules/aws-sdk/clients/iotdata.d.ts @@ -0,0 +1,123 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class IotData extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: IotData.Types.ClientConfiguration) + config: Config & IotData.Types.ClientConfiguration; + /** + * Deletes the thing shadow for the specified thing. For more information, see DeleteThingShadow in the AWS IoT Developer Guide. + */ + deleteThingShadow(params: IotData.Types.DeleteThingShadowRequest, callback?: (err: AWSError, data: IotData.Types.DeleteThingShadowResponse) => void): Request; + /** + * Deletes the thing shadow for the specified thing. For more information, see DeleteThingShadow in the AWS IoT Developer Guide. + */ + deleteThingShadow(callback?: (err: AWSError, data: IotData.Types.DeleteThingShadowResponse) => void): Request; + /** + * Gets the thing shadow for the specified thing. For more information, see GetThingShadow in the AWS IoT Developer Guide. + */ + getThingShadow(params: IotData.Types.GetThingShadowRequest, callback?: (err: AWSError, data: IotData.Types.GetThingShadowResponse) => void): Request; + /** + * Gets the thing shadow for the specified thing. For more information, see GetThingShadow in the AWS IoT Developer Guide. + */ + getThingShadow(callback?: (err: AWSError, data: IotData.Types.GetThingShadowResponse) => void): Request; + /** + * Publishes state information. For more information, see HTTP Protocol in the AWS IoT Developer Guide. + */ + publish(params: IotData.Types.PublishRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Publishes state information. For more information, see HTTP Protocol in the AWS IoT Developer Guide. + */ + publish(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the thing shadow for the specified thing. For more information, see UpdateThingShadow in the AWS IoT Developer Guide. + */ + updateThingShadow(params: IotData.Types.UpdateThingShadowRequest, callback?: (err: AWSError, data: IotData.Types.UpdateThingShadowResponse) => void): Request; + /** + * Updates the thing shadow for the specified thing. For more information, see UpdateThingShadow in the AWS IoT Developer Guide. + */ + updateThingShadow(callback?: (err: AWSError, data: IotData.Types.UpdateThingShadowResponse) => void): Request; +} +declare namespace IotData { + export interface DeleteThingShadowRequest { + /** + * The name of the thing. + */ + thingName: ThingName; + } + export interface DeleteThingShadowResponse { + /** + * The state information, in JSON format. + */ + payload: JsonDocument; + } + export interface GetThingShadowRequest { + /** + * The name of the thing. + */ + thingName: ThingName; + } + export interface GetThingShadowResponse { + /** + * The state information, in JSON format. + */ + payload?: JsonDocument; + } + export type JsonDocument = Buffer|Uint8Array|Blob|string; + export type Payload = Buffer|Uint8Array|Blob|string; + export interface PublishRequest { + /** + * The name of the MQTT topic. + */ + topic: Topic; + /** + * The Quality of Service (QoS) level. + */ + qos?: Qos; + /** + * The state information, in JSON format. + */ + payload?: Payload; + } + export type Qos = number; + export type ThingName = string; + export type Topic = string; + export interface UpdateThingShadowRequest { + /** + * The name of the thing. + */ + thingName: ThingName; + /** + * The state information, in JSON format. + */ + payload: JsonDocument; + } + export interface UpdateThingShadowResponse { + /** + * The state information, in JSON format. + */ + payload?: JsonDocument; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-05-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the IotData client. + */ + export import Types = IotData; +} +export = IotData; diff --git a/node_modules/aws-sdk/clients/iotdata.js b/node_modules/aws-sdk/clients/iotdata.js new file mode 100644 index 0000000..1df465f --- /dev/null +++ b/node_modules/aws-sdk/clients/iotdata.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['iotdata'] = {}; +AWS.IotData = Service.defineService('iotdata', ['2015-05-28']); +require('../lib/services/iotdata'); +Object.defineProperty(apiLoader.services['iotdata'], '2015-05-28', { + get: function get() { + var model = require('../apis/iot-data-2015-05-28.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.IotData; diff --git a/node_modules/aws-sdk/clients/iotjobsdataplane.d.ts b/node_modules/aws-sdk/clients/iotjobsdataplane.d.ts new file mode 100644 index 0000000..f703253 --- /dev/null +++ b/node_modules/aws-sdk/clients/iotjobsdataplane.d.ts @@ -0,0 +1,277 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class IoTJobsDataPlane extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: IoTJobsDataPlane.Types.ClientConfiguration) + config: Config & IoTJobsDataPlane.Types.ClientConfiguration; + /** + * Gets details of a job execution. + */ + describeJobExecution(params: IoTJobsDataPlane.Types.DescribeJobExecutionRequest, callback?: (err: AWSError, data: IoTJobsDataPlane.Types.DescribeJobExecutionResponse) => void): Request; + /** + * Gets details of a job execution. + */ + describeJobExecution(callback?: (err: AWSError, data: IoTJobsDataPlane.Types.DescribeJobExecutionResponse) => void): Request; + /** + * Gets the list of all jobs for a thing that are not in a terminal status. + */ + getPendingJobExecutions(params: IoTJobsDataPlane.Types.GetPendingJobExecutionsRequest, callback?: (err: AWSError, data: IoTJobsDataPlane.Types.GetPendingJobExecutionsResponse) => void): Request; + /** + * Gets the list of all jobs for a thing that are not in a terminal status. + */ + getPendingJobExecutions(callback?: (err: AWSError, data: IoTJobsDataPlane.Types.GetPendingJobExecutionsResponse) => void): Request; + /** + * Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing. + */ + startNextPendingJobExecution(params: IoTJobsDataPlane.Types.StartNextPendingJobExecutionRequest, callback?: (err: AWSError, data: IoTJobsDataPlane.Types.StartNextPendingJobExecutionResponse) => void): Request; + /** + * Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing. + */ + startNextPendingJobExecution(callback?: (err: AWSError, data: IoTJobsDataPlane.Types.StartNextPendingJobExecutionResponse) => void): Request; + /** + * Updates the status of a job execution. + */ + updateJobExecution(params: IoTJobsDataPlane.Types.UpdateJobExecutionRequest, callback?: (err: AWSError, data: IoTJobsDataPlane.Types.UpdateJobExecutionResponse) => void): Request; + /** + * Updates the status of a job execution. + */ + updateJobExecution(callback?: (err: AWSError, data: IoTJobsDataPlane.Types.UpdateJobExecutionResponse) => void): Request; +} +declare namespace IoTJobsDataPlane { + export type ApproximateSecondsBeforeTimedOut = number; + export type DescribeJobExecutionJobId = string; + export interface DescribeJobExecutionRequest { + /** + * The unique identifier assigned to this job when it was created. + */ + jobId: DescribeJobExecutionJobId; + /** + * The thing name associated with the device the job execution is running on. + */ + thingName: ThingName; + /** + * Optional. When set to true, the response contains the job document. The default is false. + */ + includeJobDocument?: IncludeJobDocument; + /** + * Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned. + */ + executionNumber?: ExecutionNumber; + } + export interface DescribeJobExecutionResponse { + /** + * Contains data about a job execution. + */ + execution?: JobExecution; + } + export type DetailsKey = string; + export type DetailsMap = {[key: string]: DetailsValue}; + export type DetailsValue = string; + export type ExecutionNumber = number; + export type ExpectedVersion = number; + export interface GetPendingJobExecutionsRequest { + /** + * The name of the thing that is executing the job. + */ + thingName: ThingName; + } + export interface GetPendingJobExecutionsResponse { + /** + * A list of JobExecutionSummary objects with status IN_PROGRESS. + */ + inProgressJobs?: JobExecutionSummaryList; + /** + * A list of JobExecutionSummary objects with status QUEUED. + */ + queuedJobs?: JobExecutionSummaryList; + } + export type IncludeExecutionState = boolean; + export type IncludeJobDocument = boolean; + export type JobDocument = string; + export interface JobExecution { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId?: JobId; + /** + * The name of the thing that is executing the job. + */ + thingName?: ThingName; + /** + * The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED". + */ + status?: JobExecutionStatus; + /** + * A collection of name/value pairs that describe the status of the job execution. + */ + statusDetails?: DetailsMap; + /** + * The time, in milliseconds since the epoch, when the job execution was enqueued. + */ + queuedAt?: QueuedAt; + /** + * The time, in milliseconds since the epoch, when the job execution was started. + */ + startedAt?: StartedAt; + /** + * The time, in milliseconds since the epoch, when the job execution was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. + */ + approximateSecondsBeforeTimedOut?: ApproximateSecondsBeforeTimedOut; + /** + * The version of the job execution. Job execution versions are incremented each time they are updated by a device. + */ + versionNumber?: VersionNumber; + /** + * A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information. + */ + executionNumber?: ExecutionNumber; + /** + * The content of the job document. + */ + jobDocument?: JobDocument; + } + export interface JobExecutionState { + /** + * The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED". + */ + status?: JobExecutionStatus; + /** + * A collection of name/value pairs that describe the status of the job execution. + */ + statusDetails?: DetailsMap; + /** + * The version of the job execution. Job execution versions are incremented each time they are updated by a device. + */ + versionNumber?: VersionNumber; + } + export type JobExecutionStatus = "QUEUED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"REJECTED"|"REMOVED"|"CANCELED"|string; + export interface JobExecutionSummary { + /** + * The unique identifier you assigned to this job when it was created. + */ + jobId?: JobId; + /** + * The time, in milliseconds since the epoch, when the job execution was enqueued. + */ + queuedAt?: QueuedAt; + /** + * The time, in milliseconds since the epoch, when the job execution started. + */ + startedAt?: StartedAt; + /** + * The time, in milliseconds since the epoch, when the job execution was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device. + */ + versionNumber?: VersionNumber; + /** + * A number that identifies a particular job execution on a particular device. + */ + executionNumber?: ExecutionNumber; + } + export type JobExecutionSummaryList = JobExecutionSummary[]; + export type JobId = string; + export type LastUpdatedAt = number; + export type QueuedAt = number; + export interface StartNextPendingJobExecutionRequest { + /** + * The name of the thing associated with the device. + */ + thingName: ThingName; + /** + * A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. + */ + statusDetails?: DetailsMap; + /** + * Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig). + */ + stepTimeoutInMinutes?: StepTimeoutInMinutes; + } + export interface StartNextPendingJobExecutionResponse { + /** + * A JobExecution object. + */ + execution?: JobExecution; + } + export type StartedAt = number; + export type StepTimeoutInMinutes = number; + export type ThingName = string; + export interface UpdateJobExecutionRequest { + /** + * The unique identifier assigned to this job when it was created. + */ + jobId: JobId; + /** + * The name of the thing associated with the device. + */ + thingName: ThingName; + /** + * The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update. + */ + status: JobExecutionStatus; + /** + * Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. + */ + statusDetails?: DetailsMap; + /** + * Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig). + */ + stepTimeoutInMinutes?: StepTimeoutInMinutes; + /** + * Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.) + */ + expectedVersion?: ExpectedVersion; + /** + * Optional. When included and set to true, the response contains the JobExecutionState data. The default is false. + */ + includeJobExecutionState?: IncludeExecutionState; + /** + * Optional. When set to true, the response contains the job document. The default is false. + */ + includeJobDocument?: IncludeJobDocument; + /** + * Optional. A number that identifies a particular job execution on a particular device. + */ + executionNumber?: ExecutionNumber; + } + export interface UpdateJobExecutionResponse { + /** + * A JobExecutionState object. + */ + executionState?: JobExecutionState; + /** + * The contents of the Job Documents. + */ + jobDocument?: JobDocument; + } + export type VersionNumber = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-29"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the IoTJobsDataPlane client. + */ + export import Types = IoTJobsDataPlane; +} +export = IoTJobsDataPlane; diff --git a/node_modules/aws-sdk/clients/iotjobsdataplane.js b/node_modules/aws-sdk/clients/iotjobsdataplane.js new file mode 100644 index 0000000..5e471e1 --- /dev/null +++ b/node_modules/aws-sdk/clients/iotjobsdataplane.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['iotjobsdataplane'] = {}; +AWS.IoTJobsDataPlane = Service.defineService('iotjobsdataplane', ['2017-09-29']); +Object.defineProperty(apiLoader.services['iotjobsdataplane'], '2017-09-29', { + get: function get() { + var model = require('../apis/iot-jobs-data-2017-09-29.min.json'); + model.paginators = require('../apis/iot-jobs-data-2017-09-29.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.IoTJobsDataPlane; diff --git a/node_modules/aws-sdk/clients/kafka.d.ts b/node_modules/aws-sdk/clients/kafka.d.ts new file mode 100644 index 0000000..c7e6b4b --- /dev/null +++ b/node_modules/aws-sdk/clients/kafka.d.ts @@ -0,0 +1,463 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Kafka extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Kafka.Types.ClientConfiguration) + config: Config & Kafka.Types.ClientConfiguration; + /** + * Creates a new MSK cluster. + */ + createCluster(params: Kafka.Types.CreateClusterRequest, callback?: (err: AWSError, data: Kafka.Types.CreateClusterResponse) => void): Request; + /** + * Creates a new MSK cluster. + */ + createCluster(callback?: (err: AWSError, data: Kafka.Types.CreateClusterResponse) => void): Request; + /** + * Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request. + */ + deleteCluster(params: Kafka.Types.DeleteClusterRequest, callback?: (err: AWSError, data: Kafka.Types.DeleteClusterResponse) => void): Request; + /** + * Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request. + */ + deleteCluster(callback?: (err: AWSError, data: Kafka.Types.DeleteClusterResponse) => void): Request; + /** + * Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. + */ + describeCluster(params: Kafka.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeClusterResponse) => void): Request; + /** + * Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. + */ + describeCluster(callback?: (err: AWSError, data: Kafka.Types.DescribeClusterResponse) => void): Request; + /** + * A list of brokers that a client application can use to bootstrap. + */ + getBootstrapBrokers(params: Kafka.Types.GetBootstrapBrokersRequest, callback?: (err: AWSError, data: Kafka.Types.GetBootstrapBrokersResponse) => void): Request; + /** + * A list of brokers that a client application can use to bootstrap. + */ + getBootstrapBrokers(callback?: (err: AWSError, data: Kafka.Types.GetBootstrapBrokersResponse) => void): Request; + /** + * Returns a list of clusters in an account. + */ + listClusters(params: Kafka.Types.ListClustersRequest, callback?: (err: AWSError, data: Kafka.Types.ListClustersResponse) => void): Request; + /** + * Returns a list of clusters in an account. + */ + listClusters(callback?: (err: AWSError, data: Kafka.Types.ListClustersResponse) => void): Request; + /** + * Returns a list of the broker nodes in the cluster. + */ + listNodes(params: Kafka.Types.ListNodesRequest, callback?: (err: AWSError, data: Kafka.Types.ListNodesResponse) => void): Request; + /** + * Returns a list of the broker nodes in the cluster. + */ + listNodes(callback?: (err: AWSError, data: Kafka.Types.ListNodesResponse) => void): Request; + /** + * Returns a list of tags attached to a resource. + */ + listTagsForResource(params: Kafka.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Kafka.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns a list of tags attached to a resource. + */ + listTagsForResource(callback?: (err: AWSError, data: Kafka.Types.ListTagsForResourceResponse) => void): Request; + /** + * Tag a resource with given tags. + */ + tagResource(params: Kafka.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Tag a resource with given tags. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove tags of a resource by given tag keys. + */ + untagResource(params: Kafka.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove tags of a resource by given tag keys. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace Kafka { + export type BrokerAZDistribution = "DEFAULT"|string; + export interface BrokerNodeGroupInfo { + /** + * The distribution of broker nodes across Availability Zones. + */ + BrokerAZDistribution?: BrokerAZDistribution; + /** + * The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e. + */ + ClientSubnets: __listOf__string; + /** + * The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, +kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. + */ + InstanceType: __stringMin5Max32; + /** + * The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. + */ + SecurityGroups?: __listOf__string; + /** + * Contains information about storage volumes attached to MSK broker nodes. + */ + StorageInfo?: StorageInfo; + } + export interface BrokerNodeInfo { + /** + * The attached elastic network interface of the broker. + */ + AttachedENIId?: __string; + /** + * The ID of the broker. + */ + BrokerId?: __double; + /** + * The client subnet to which this broker node belongs. + */ + ClientSubnet?: __string; + /** + * The virtual private cloud (VPC) of the client. + */ + ClientVpcIpAddress?: __string; + /** + * Information about the version of software currently deployed on the Kafka brokers in the cluster. + */ + CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo; + } + export interface BrokerSoftwareInfo { + /** + * The Amazon Resource Name (ARN) of the configuration used for the cluster. + */ + ConfigurationArn?: __string; + /** + * The revision of the configuration to use. + */ + ConfigurationRevision?: __string; + /** + * The version of Apache Kafka. + */ + KafkaVersion?: __string; + } + export interface ClusterInfo { + /** + * Information about the broker nodes. + */ + BrokerNodeGroupInfo?: BrokerNodeGroupInfo; + /** + * The Amazon Resource Name (ARN) that uniquely identifies the cluster. + */ + ClusterArn?: __string; + /** + * The name of the cluster. + */ + ClusterName?: __string; + /** + * The time when the cluster was created. + */ + CreationTime?: __timestampIso8601; + /** + * Information about the version of software currently deployed on the Kafka brokers in the cluster. + */ + CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo; + /** + * The current version of the MSK cluster. + */ + CurrentVersion?: __string; + /** + * Includes all encryption-related information. + */ + EncryptionInfo?: EncryptionInfo; + /** + * Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. + */ + EnhancedMonitoring?: EnhancedMonitoring; + /** + * The number of Kafka broker nodes in the cluster. + */ + NumberOfBrokerNodes?: __integer; + /** + * The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. + */ + State?: ClusterState; + /** + * The connection string to use to connect to the Apache ZooKeeper cluster. + */ + ZookeeperConnectString?: __string; + } + export type ClusterState = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|string; + export interface CreateClusterRequest { + /** + * Information about the broker nodes in the cluster. + */ + BrokerNodeGroupInfo: BrokerNodeGroupInfo; + /** + * The name of the cluster. + */ + ClusterName: __stringMin1Max64; + /** + * Includes all encryption-related information. + */ + EncryptionInfo?: EncryptionInfo; + /** + * Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. + */ + EnhancedMonitoring?: EnhancedMonitoring; + /** + * The version of Apache Kafka. + */ + KafkaVersion: __stringMin1Max128; + /** + * The number of Kafka broker nodes in the Amazon MSK cluster. + */ + NumberOfBrokerNodes: __integerMin1Max15; + } + export interface CreateClusterResponse { + /** + * The Amazon Resource Name (ARN) of the cluster. + */ + ClusterArn?: __string; + /** + * The name of the MSK cluster. + */ + ClusterName?: __string; + /** + * The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. + */ + State?: ClusterState; + } + export interface DeleteClusterRequest { + /** + * The Amazon Resource Name (ARN) that uniquely identifies the cluster. + */ + ClusterArn: __string; + /** + * The current version of the MSK cluster. + */ + CurrentVersion?: __string; + } + export interface DeleteClusterResponse { + /** + * The Amazon Resource Name (ARN) of the cluster. + */ + ClusterArn?: __string; + /** + * The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. + */ + State?: ClusterState; + } + export interface DescribeClusterRequest { + /** + * The Amazon Resource Name (ARN) that uniquely identifies the cluster. + */ + ClusterArn: __string; + } + export interface DescribeClusterResponse { + /** + * The cluster information. + */ + ClusterInfo?: ClusterInfo; + } + export interface EBSStorageInfo { + /** + * The size in GiB of the EBS volume for the data drive on each broker node. + */ + VolumeSize?: __integerMin1Max16384; + } + export interface EncryptionAtRest { + /** + * The AWS KMS key used for data encryption. + */ + DataVolumeKMSKeyId: __string; + } + export interface EncryptionInfo { + /** + * The data volume encryption details. + */ + EncryptionAtRest?: EncryptionAtRest; + } + export type EnhancedMonitoring = "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|string; + export interface GetBootstrapBrokersRequest { + /** + * The Amazon Resource Name (ARN) that uniquely identifies the cluster. + */ + ClusterArn: __string; + } + export interface GetBootstrapBrokersResponse { + /** + * A string containing one or more hostname:port pairs. + */ + BootstrapBrokerString?: __string; + } + export interface ListClustersRequest { + /** + * Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix. + */ + ClusterNameFilter?: __string; + /** + * The maximum number of clusters to return in the response. If there are more clusters, the response includes a NextToken parameter. + */ + MaxResults?: MaxResults; + /** + * The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. + To get another batch of clusters, provide this token in your next request. + */ + NextToken?: __string; + } + export interface ListClustersResponse { + /** + * Information on each of the MSK clusters in the response. + */ + ClusterInfoList?: __listOfClusterInfo; + /** + * The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. + To get another batch of clusters, provide this token in your next request. + */ + NextToken?: __string; + } + export interface ListNodesRequest { + /** + * The Amazon Resource Name (ARN) that uniquely identifies the cluster. + */ + ClusterArn: __string; + /** + * The maximum number of clusters to return in the response. If there are more clusters, the response includes a NextToken parameter. + */ + MaxResults?: MaxResults; + /** + * The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. + To get another batch of clusters, provide this token in your next request. + */ + NextToken?: __string; + } + export interface ListNodesResponse { + /** + * The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. + To get another batch of nodes, provide this token in your next request. + */ + NextToken?: __string; + /** + * List containing a NodeInfo object. + */ + NodeInfoList?: __listOfNodeInfo; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) that uniquely identifies the resource. + */ + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + /** + * The key-value pairs for the resource tags + */ + Tags?: __mapOf__string; + } + export type MaxResults = number; + export interface NodeInfo { + /** + * The start time. + */ + AddedToClusterTime?: __string; + /** + * The broker node info. + */ + BrokerNodeInfo?: BrokerNodeInfo; + /** + * The instance type. + */ + InstanceType?: __string; + /** + * The Amazon Resource Name (ARN) of the node. + */ + NodeARN?: __string; + /** + * The node type. + */ + NodeType?: NodeType; + /** + * The ZookeeperNodeInfo. + */ + ZookeeperNodeInfo?: ZookeeperNodeInfo; + } + export type NodeType = "BROKER"|string; + export interface StorageInfo { + /** + * EBS volume information. + */ + EbsStorageInfo?: EBSStorageInfo; + } + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) that uniquely identifies the resource. + */ + ResourceArn: __string; + /** + * The key-value pairs for the resource tags + */ + Tags: __mapOf__string; + } + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) that uniquely identifies the resource. + */ + ResourceArn: __string; + /** + * The list of tag keys. + */ + TagKeys: __listOf__string; + } + export interface ZookeeperNodeInfo { + /** + * The attached elastic network interface of the broker. + */ + AttachedENIId?: __string; + /** + * The virtual private cloud (VPC) IP address of the client. + */ + ClientVpcIpAddress?: __string; + /** + * The role-specific ID for Zookeeper. + */ + ZookeeperId?: __double; + /** + * The version of Zookeeper. + */ + ZookeeperVersion?: __string; + } + export type __double = number; + export type __integer = number; + export type __integerMin1Max15 = number; + export type __integerMin1Max16384 = number; + export type __listOfClusterInfo = ClusterInfo[]; + export type __listOfNodeInfo = NodeInfo[]; + export type __listOf__string = __string[]; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + export type __stringMin1Max128 = string; + export type __stringMin1Max64 = string; + export type __stringMin5Max32 = string; + export type __timestampIso8601 = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-11-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Kafka client. + */ + export import Types = Kafka; +} +export = Kafka; diff --git a/node_modules/aws-sdk/clients/kafka.js b/node_modules/aws-sdk/clients/kafka.js new file mode 100644 index 0000000..bbc693a --- /dev/null +++ b/node_modules/aws-sdk/clients/kafka.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kafka'] = {}; +AWS.Kafka = Service.defineService('kafka', ['2018-11-14']); +Object.defineProperty(apiLoader.services['kafka'], '2018-11-14', { + get: function get() { + var model = require('../apis/kafka-2018-11-14.min.json'); + model.paginators = require('../apis/kafka-2018-11-14.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Kafka; diff --git a/node_modules/aws-sdk/clients/kinesis.d.ts b/node_modules/aws-sdk/clients/kinesis.d.ts new file mode 100644 index 0000000..da52147 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesis.d.ts @@ -0,0 +1,1035 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Kinesis extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Kinesis.Types.ClientConfiguration) + config: Config & Kinesis.Types.ClientConfiguration; + /** + * Adds or updates tags for the specified Kinesis data stream. Each time you invoke this operation, you can specify up to 10 tags. If you want to add more than 10 tags to your stream, you can invoke this operation multiple times. In total, each stream can have up to 50 tags. If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys. AddTagsToStream has a limit of five transactions per second per account. + */ + addTagsToStream(params: Kinesis.Types.AddTagsToStreamInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or updates tags for the specified Kinesis data stream. Each time you invoke this operation, you can specify up to 10 tags. If you want to add more than 10 tags to your stream, you can invoke this operation multiple times. In total, each stream can have up to 50 tags. If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys. AddTagsToStream has a limit of five transactions per second per account. + */ + addTagsToStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream. You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. If the amount of data input increases or decreases, you can add or remove shards. The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name. CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream. You receive a LimitExceededException when making a CreateStream request when you try to do one of the following: Have more than five streams in the CREATING state at any point in time. Create more shards than are authorized for your account. For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support. You can use DescribeStream to check the stream status, which is returned in StreamStatus. CreateStream has a limit of five transactions per second per account. + */ + createStream(params: Kinesis.Types.CreateStreamInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream. You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. If the amount of data input increases or decreases, you can add or remove shards. The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name. CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream. You receive a LimitExceededException when making a CreateStream request when you try to do one of the following: Have more than five streams in the CREATING state at any point in time. Create more shards than are authorized for your account. For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support. You can use DescribeStream to check the stream status, which is returned in StreamStatus. CreateStream has a limit of five transactions per second per account. + */ + createStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours. This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. + */ + decreaseStreamRetentionPeriod(params: Kinesis.Types.DecreaseStreamRetentionPeriodInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours. This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. + */ + decreaseStreamRetentionPeriod(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException. If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete. When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream. You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus. DeleteStream has a limit of five transactions per second per account. + */ + deleteStream(params: Kinesis.Types.DeleteStreamInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException. If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete. When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream. You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus. DeleteStream has a limit of five transactions per second per account. + */ + deleteStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN. This operation has a limit of five transactions per second per account. + */ + deregisterStreamConsumer(params: Kinesis.Types.DeregisterStreamConsumerInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN. This operation has a limit of five transactions per second per account. + */ + deregisterStreamConsumer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describes the shard limits and usage for the account. If you update your account limits, the old limits might be returned for a few minutes. This operation has a limit of one transaction per second per account. + */ + describeLimits(params: Kinesis.Types.DescribeLimitsInput, callback?: (err: AWSError, data: Kinesis.Types.DescribeLimitsOutput) => void): Request; + /** + * Describes the shard limits and usage for the account. If you update your account limits, the old limits might be returned for a few minutes. This operation has a limit of one transaction per second per account. + */ + describeLimits(callback?: (err: AWSError, data: Kinesis.Types.DescribeLimitsOutput) => void): Request; + /** + * Describes the specified Kinesis data stream. The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream. You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide. There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard. This operation has a limit of 10 transactions per second per account. + */ + describeStream(params: Kinesis.Types.DescribeStreamInput, callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamOutput) => void): Request; + /** + * Describes the specified Kinesis data stream. The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream. You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide. There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard. This operation has a limit of 10 transactions per second per account. + */ + describeStream(callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamOutput) => void): Request; + /** + * To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. This operation has a limit of 20 transactions per second per account. + */ + describeStreamConsumer(params: Kinesis.Types.DescribeStreamConsumerInput, callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamConsumerOutput) => void): Request; + /** + * To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. This operation has a limit of 20 transactions per second per account. + */ + describeStreamConsumer(callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamConsumerOutput) => void): Request; + /** + * Provides a summarized description of the specified Kinesis data stream without the shard list. The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. + */ + describeStreamSummary(params: Kinesis.Types.DescribeStreamSummaryInput, callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamSummaryOutput) => void): Request; + /** + * Provides a summarized description of the specified Kinesis data stream without the shard list. The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. + */ + describeStreamSummary(callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamSummaryOutput) => void): Request; + /** + * Disables enhanced monitoring. + */ + disableEnhancedMonitoring(params: Kinesis.Types.DisableEnhancedMonitoringInput, callback?: (err: AWSError, data: Kinesis.Types.EnhancedMonitoringOutput) => void): Request; + /** + * Disables enhanced monitoring. + */ + disableEnhancedMonitoring(callback?: (err: AWSError, data: Kinesis.Types.EnhancedMonitoringOutput) => void): Request; + /** + * Enables enhanced Kinesis data stream monitoring for shard-level metrics. + */ + enableEnhancedMonitoring(params: Kinesis.Types.EnableEnhancedMonitoringInput, callback?: (err: AWSError, data: Kinesis.Types.EnhancedMonitoringOutput) => void): Request; + /** + * Enables enhanced Kinesis data stream monitoring for shard-level metrics. + */ + enableEnhancedMonitoring(callback?: (err: AWSError, data: Kinesis.Types.EnhancedMonitoringOutput) => void): Request; + /** + * Gets data records from a Kinesis data stream's shard. Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records. You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process. Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000. The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second. To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide). Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order. This operation has a limit of five transactions per second per account. + */ + getRecords(params: Kinesis.Types.GetRecordsInput, callback?: (err: AWSError, data: Kinesis.Types.GetRecordsOutput) => void): Request; + /** + * Gets data records from a Kinesis data stream's shard. Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records. You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process. Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000. The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second. To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide). Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order. This operation has a limit of five transactions per second per account. + */ + getRecords(callback?: (err: AWSError, data: Kinesis.Types.GetRecordsOutput) => void): Request; + /** + * Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester. A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards. You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard. When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request. If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide. If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards. GetShardIterator has a limit of five transactions per second per account per open shard. + */ + getShardIterator(params: Kinesis.Types.GetShardIteratorInput, callback?: (err: AWSError, data: Kinesis.Types.GetShardIteratorOutput) => void): Request; + /** + * Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester. A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards. You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard. When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request. If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide. If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards. GetShardIterator has a limit of five transactions per second per account per open shard. + */ + getShardIterator(callback?: (err: AWSError, data: Kinesis.Types.GetShardIteratorOutput) => void): Request; + /** + * Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days). If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications. + */ + increaseStreamRetentionPeriod(params: Kinesis.Types.IncreaseStreamRetentionPeriodInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days). If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications. + */ + increaseStreamRetentionPeriod(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream. This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM. + */ + listShards(params: Kinesis.Types.ListShardsInput, callback?: (err: AWSError, data: Kinesis.Types.ListShardsOutput) => void): Request; + /** + * Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream. This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM. + */ + listShards(callback?: (err: AWSError, data: Kinesis.Types.ListShardsOutput) => void): Request; + /** + * Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer. This operation has a limit of 10 transactions per second per account. + */ + listStreamConsumers(params: Kinesis.Types.ListStreamConsumersInput, callback?: (err: AWSError, data: Kinesis.Types.ListStreamConsumersOutput) => void): Request; + /** + * Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer. This operation has a limit of 10 transactions per second per account. + */ + listStreamConsumers(callback?: (err: AWSError, data: Kinesis.Types.ListStreamConsumersOutput) => void): Request; + /** + * Lists your Kinesis data streams. The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10. You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. ListStreams has a limit of five transactions per second per account. + */ + listStreams(params: Kinesis.Types.ListStreamsInput, callback?: (err: AWSError, data: Kinesis.Types.ListStreamsOutput) => void): Request; + /** + * Lists your Kinesis data streams. The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10. You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. ListStreams has a limit of five transactions per second per account. + */ + listStreams(callback?: (err: AWSError, data: Kinesis.Types.ListStreamsOutput) => void): Request; + /** + * Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. + */ + listTagsForStream(params: Kinesis.Types.ListTagsForStreamInput, callback?: (err: AWSError, data: Kinesis.Types.ListTagsForStreamOutput) => void): Request; + /** + * Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. + */ + listTagsForStream(callback?: (err: AWSError, data: Kinesis.Types.ListTagsForStreamOutput) => void): Request; + /** + * Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards. MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide. If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException. You can use DescribeStream to check the state of the stream, which is returned in StreamStatus. MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state. You use DescribeStream to determine the shard IDs that are specified in the MergeShards request. If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException. MergeShards has a limit of five transactions per second per account. + */ + mergeShards(params: Kinesis.Types.MergeShardsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards. MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide. If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException. You can use DescribeStream to check the state of the stream, which is returned in StreamStatus. MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state. You use DescribeStream to determine the shard IDs that are specified in the MergeShards request. If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException. MergeShards has a limit of five transactions per second per account. + */ + mergeShards(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs. Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record. Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException. By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. + */ + putRecord(params: Kinesis.Types.PutRecordInput, callback?: (err: AWSError, data: Kinesis.Types.PutRecordOutput) => void): Request; + /** + * Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs. Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record. Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException. By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. + */ + putRecord(callback?: (err: AWSError, data: Kinesis.Types.PutRecordOutput) => void): Request; + /** + * Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing. Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob. The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide. The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array. The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide. By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. + */ + putRecords(params: Kinesis.Types.PutRecordsInput, callback?: (err: AWSError, data: Kinesis.Types.PutRecordsOutput) => void): Request; + /** + * Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing. Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob. The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide. The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array. The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide. By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. + */ + putRecords(callback?: (err: AWSError, data: Kinesis.Types.PutRecordsOutput) => void): Request; + /** + * Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can read data from the stream at a rate of up to 2 MiB per second. This rate is unaffected by the total number of consumers that read from the same stream. You can register up to 5 consumers per stream. A given consumer can only be registered with one stream. This operation has a limit of five transactions per second per account. + */ + registerStreamConsumer(params: Kinesis.Types.RegisterStreamConsumerInput, callback?: (err: AWSError, data: Kinesis.Types.RegisterStreamConsumerOutput) => void): Request; + /** + * Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can read data from the stream at a rate of up to 2 MiB per second. This rate is unaffected by the total number of consumers that read from the same stream. You can register up to 5 consumers per stream. A given consumer can only be registered with one stream. This operation has a limit of five transactions per second per account. + */ + registerStreamConsumer(callback?: (err: AWSError, data: Kinesis.Types.RegisterStreamConsumerOutput) => void): Request; + /** + * Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes. If you specify a tag that does not exist, it is ignored. RemoveTagsFromStream has a limit of five transactions per second per account. + */ + removeTagsFromStream(params: Kinesis.Types.RemoveTagsFromStreamInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes. If you specify a tag that does not exist, it is ignored. RemoveTagsFromStream has a limit of five transactions per second per account. + */ + removeTagsFromStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing. You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide. You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request. SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state. You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException. If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException. For the default shard limit for an AWS account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support. If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException. SplitShard has a limit of five transactions per second per account. + */ + splitShard(params: Kinesis.Types.SplitShardInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing. You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide. You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request. SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state. You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException. If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException. For the default shard limit for an AWS account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support. If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException. SplitShard has a limit of five transactions per second per account. + */ + splitShard(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables or updates server-side encryption using an AWS KMS key for a specified stream. Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream. API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period. Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords. + */ + startStreamEncryption(params: Kinesis.Types.StartStreamEncryptionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables or updates server-side encryption using an AWS KMS key for a specified stream. Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream. API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period. Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords. + */ + startStreamEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables server-side encryption for a specified stream. Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams. API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period. Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords. + */ + stopStreamEncryption(params: Kinesis.Types.StopStreamEncryptionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables server-side encryption for a specified stream. Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams. API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period. Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords. + */ + stopStreamEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the shard count of the specified stream to the specified number of shards. Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING. To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges. This operation has the following default limits. By default, you cannot do the following: Scale more than twice per rolling 24-hour period per stream Scale up to more than double your current shard count for a stream Scale down below half your current shard count for a stream Scale up to more than 500 shards in a stream Scale a stream with more than 500 shards down unless the result is less than 500 shards Scale up to more than the shard limit for your account For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form. + */ + updateShardCount(params: Kinesis.Types.UpdateShardCountInput, callback?: (err: AWSError, data: Kinesis.Types.UpdateShardCountOutput) => void): Request; + /** + * Updates the shard count of the specified stream to the specified number of shards. Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING. To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges. This operation has the following default limits. By default, you cannot do the following: Scale more than twice per rolling 24-hour period per stream Scale up to more than double your current shard count for a stream Scale down below half your current shard count for a stream Scale up to more than 500 shards in a stream Scale a stream with more than 500 shards down unless the result is less than 500 shards Scale up to more than the shard limit for your account For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form. + */ + updateShardCount(callback?: (err: AWSError, data: Kinesis.Types.UpdateShardCountOutput) => void): Request; + /** + * Waits for the streamExists state by periodically calling the underlying Kinesis.describeStreamoperation every 10 seconds (at most 18 times). + */ + waitFor(state: "streamExists", params: Kinesis.Types.DescribeStreamInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamOutput) => void): Request; + /** + * Waits for the streamExists state by periodically calling the underlying Kinesis.describeStreamoperation every 10 seconds (at most 18 times). + */ + waitFor(state: "streamExists", callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamOutput) => void): Request; + /** + * Waits for the streamNotExists state by periodically calling the underlying Kinesis.describeStreamoperation every 10 seconds (at most 18 times). + */ + waitFor(state: "streamNotExists", params: Kinesis.Types.DescribeStreamInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamOutput) => void): Request; + /** + * Waits for the streamNotExists state by periodically calling the underlying Kinesis.describeStreamoperation every 10 seconds (at most 18 times). + */ + waitFor(state: "streamNotExists", callback?: (err: AWSError, data: Kinesis.Types.DescribeStreamOutput) => void): Request; +} +declare namespace Kinesis { + export interface AddTagsToStreamInput { + /** + * The name of the stream. + */ + StreamName: StreamName; + /** + * A set of up to 10 key-value pairs to use to create the tags. + */ + Tags: TagMap; + } + export type BooleanObject = boolean; + export interface Consumer { + /** + * The name of the consumer is something you choose when you register the consumer. + */ + ConsumerName: ConsumerName; + /** + * When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard. If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs. + */ + ConsumerARN: ConsumerARN; + /** + * A consumer can't read data while in the CREATING or DELETING states. + */ + ConsumerStatus: ConsumerStatus; + /** + * + */ + ConsumerCreationTimestamp: Timestamp; + } + export type ConsumerARN = string; + export type ConsumerCountObject = number; + export interface ConsumerDescription { + /** + * The name of the consumer is something you choose when you register the consumer. + */ + ConsumerName: ConsumerName; + /** + * When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard. If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs. + */ + ConsumerARN: ConsumerARN; + /** + * A consumer can't read data while in the CREATING or DELETING states. + */ + ConsumerStatus: ConsumerStatus; + /** + * + */ + ConsumerCreationTimestamp: Timestamp; + /** + * The ARN of the stream with which you registered the consumer. + */ + StreamARN: StreamARN; + } + export type ConsumerList = Consumer[]; + export type ConsumerName = string; + export type ConsumerStatus = "CREATING"|"DELETING"|"ACTIVE"|string; + export interface CreateStreamInput { + /** + * A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name. + */ + StreamName: StreamName; + /** + * The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput. DefaultShardLimit; + */ + ShardCount: PositiveIntegerObject; + } + export type Data = Buffer|Uint8Array|Blob|string; + export interface DecreaseStreamRetentionPeriodInput { + /** + * The name of the stream to modify. + */ + StreamName: StreamName; + /** + * The new retention period of the stream, in hours. Must be less than the current retention period. + */ + RetentionPeriodHours: RetentionPeriodHours; + } + export interface DeleteStreamInput { + /** + * The name of the stream to delete. + */ + StreamName: StreamName; + /** + * If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException. + */ + EnforceConsumerDeletion?: BooleanObject; + } + export interface DeregisterStreamConsumerInput { + /** + * The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + StreamARN?: StreamARN; + /** + * The name that you gave to the consumer. + */ + ConsumerName?: ConsumerName; + /** + * The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN. + */ + ConsumerARN?: ConsumerARN; + } + export interface DescribeLimitsInput { + } + export interface DescribeLimitsOutput { + /** + * The maximum number of shards. + */ + ShardLimit: ShardCountObject; + /** + * The number of open shards. + */ + OpenShardCount: ShardCountObject; + } + export interface DescribeStreamConsumerInput { + /** + * The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + StreamARN?: StreamARN; + /** + * The name that you gave to the consumer. + */ + ConsumerName?: ConsumerName; + /** + * The ARN returned by Kinesis Data Streams when you registered the consumer. + */ + ConsumerARN?: ConsumerARN; + } + export interface DescribeStreamConsumerOutput { + /** + * An object that represents the details of the consumer. + */ + ConsumerDescription: ConsumerDescription; + } + export interface DescribeStreamInput { + /** + * The name of the stream to describe. + */ + StreamName: StreamName; + /** + * The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned. + */ + Limit?: DescribeStreamInputLimit; + /** + * The shard ID of the shard to start with. + */ + ExclusiveStartShardId?: ShardId; + } + export type DescribeStreamInputLimit = number; + export interface DescribeStreamOutput { + /** + * The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available. + */ + StreamDescription: StreamDescription; + } + export interface DescribeStreamSummaryInput { + /** + * The name of the stream to describe. + */ + StreamName: StreamName; + } + export interface DescribeStreamSummaryOutput { + /** + * A StreamDescriptionSummary containing information about the stream. + */ + StreamDescriptionSummary: StreamDescriptionSummary; + } + export interface DisableEnhancedMonitoringInput { + /** + * The name of the Kinesis data stream for which to disable enhanced monitoring. + */ + StreamName: StreamName; + /** + * List of shard-level metrics to disable. The following are the valid shard-level metrics. The value "ALL" disables every metric. IncomingBytes IncomingRecords OutgoingBytes OutgoingRecords WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide. + */ + ShardLevelMetrics: MetricsNameList; + } + export interface EnableEnhancedMonitoringInput { + /** + * The name of the stream for which to enable enhanced monitoring. + */ + StreamName: StreamName; + /** + * List of shard-level metrics to enable. The following are the valid shard-level metrics. The value "ALL" enables every metric. IncomingBytes IncomingRecords OutgoingBytes OutgoingRecords WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide. + */ + ShardLevelMetrics: MetricsNameList; + } + export type EncryptionType = "NONE"|"KMS"|string; + export interface EnhancedMetrics { + /** + * List of shard-level metrics. The following are the valid shard-level metrics. The value "ALL" enhances every metric. IncomingBytes IncomingRecords OutgoingBytes OutgoingRecords WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide. + */ + ShardLevelMetrics?: MetricsNameList; + } + export type EnhancedMonitoringList = EnhancedMetrics[]; + export interface EnhancedMonitoringOutput { + /** + * The name of the Kinesis data stream. + */ + StreamName?: StreamName; + /** + * Represents the current state of the metrics that are in the enhanced state before the operation. + */ + CurrentShardLevelMetrics?: MetricsNameList; + /** + * Represents the list of all the metrics that would be in the enhanced state after the operation. + */ + DesiredShardLevelMetrics?: MetricsNameList; + } + export type ErrorCode = string; + export type ErrorMessage = string; + export interface GetRecordsInput { + /** + * The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard. + */ + ShardIterator: ShardIterator; + /** + * The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. + */ + Limit?: GetRecordsInputLimit; + } + export type GetRecordsInputLimit = number; + export interface GetRecordsOutput { + /** + * The data records retrieved from the shard. + */ + Records: RecordList; + /** + * The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data. + */ + NextShardIterator?: ShardIterator; + /** + * The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment. + */ + MillisBehindLatest?: MillisBehindLatest; + } + export interface GetShardIteratorInput { + /** + * The name of the Amazon Kinesis data stream. + */ + StreamName: StreamName; + /** + * The shard ID of the Kinesis Data Streams shard to get the iterator for. + */ + ShardId: ShardId; + /** + * Determines how the shard iterator is used to start reading data records from the shard. The following are the valid Amazon Kinesis shard iterator types: AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber. AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber. AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp. TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard. LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard. + */ + ShardIteratorType: ShardIteratorType; + /** + * The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. + */ + StartingSequenceNumber?: SequenceNumber; + /** + * The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON). + */ + Timestamp?: Timestamp; + } + export interface GetShardIteratorOutput { + /** + * The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. + */ + ShardIterator?: ShardIterator; + } + export type HashKey = string; + export interface HashKeyRange { + /** + * The starting hash key of the hash key range. + */ + StartingHashKey: HashKey; + /** + * The ending hash key of the hash key range. + */ + EndingHashKey: HashKey; + } + export interface IncreaseStreamRetentionPeriodInput { + /** + * The name of the stream to modify. + */ + StreamName: StreamName; + /** + * The new retention period of the stream, in hours. Must be more than the current retention period. + */ + RetentionPeriodHours: RetentionPeriodHours; + } + export type KeyId = string; + export interface ListShardsInput { + /** + * The name of the data stream whose shards you want to list. You cannot specify this parameter if you specify the NextToken parameter. + */ + StreamName?: StreamName; + /** + * When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream. You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation. Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException. + */ + NextToken?: NextToken; + /** + * Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId. If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream. You cannot specify this parameter if you specify NextToken. + */ + ExclusiveStartShardId?: ShardId; + /** + * The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default. When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards. + */ + MaxResults?: ListShardsInputLimit; + /** + * Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for. You cannot specify this parameter if you specify the NextToken parameter. + */ + StreamCreationTimestamp?: Timestamp; + } + export type ListShardsInputLimit = number; + export interface ListShardsOutput { + /** + * An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard. + */ + Shards?: ShardList; + /** + * When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken. Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException. + */ + NextToken?: NextToken; + } + export interface ListStreamConsumersInput { + /** + * The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + StreamARN: StreamARN; + /** + * When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of consumers that are registered with the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream. You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers. Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException. + */ + NextToken?: NextToken; + /** + * The maximum number of consumers that you want a single call of ListStreamConsumers to return. + */ + MaxResults?: ListStreamConsumersInputLimit; + /** + * Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for. You can't specify this parameter if you specify the NextToken parameter. + */ + StreamCreationTimestamp?: Timestamp; + } + export type ListStreamConsumersInputLimit = number; + export interface ListStreamConsumersOutput { + /** + * An array of JSON objects. Each object represents one registered consumer. + */ + Consumers?: ConsumerList; + /** + * When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken. Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException. + */ + NextToken?: NextToken; + } + export interface ListStreamsInput { + /** + * The maximum number of streams to list. + */ + Limit?: ListStreamsInputLimit; + /** + * The name of the stream to start the list with. + */ + ExclusiveStartStreamName?: StreamName; + } + export type ListStreamsInputLimit = number; + export interface ListStreamsOutput { + /** + * The names of the streams that are associated with the AWS account making the ListStreams request. + */ + StreamNames: StreamNameList; + /** + * If set to true, there are more streams available to list. + */ + HasMoreStreams: BooleanObject; + } + export interface ListTagsForStreamInput { + /** + * The name of the stream. + */ + StreamName: StreamName; + /** + * The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey. + */ + ExclusiveStartTagKey?: TagKey; + /** + * The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response. + */ + Limit?: ListTagsForStreamInputLimit; + } + export type ListTagsForStreamInputLimit = number; + export interface ListTagsForStreamOutput { + /** + * A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit. + */ + Tags: TagList; + /** + * If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned. + */ + HasMoreTags: BooleanObject; + } + export interface MergeShardsInput { + /** + * The name of the stream for the merge. + */ + StreamName: StreamName; + /** + * The shard ID of the shard to combine with the adjacent shard for the merge. + */ + ShardToMerge: ShardId; + /** + * The shard ID of the adjacent shard for the merge. + */ + AdjacentShardToMerge: ShardId; + } + export type MetricsName = "IncomingBytes"|"IncomingRecords"|"OutgoingBytes"|"OutgoingRecords"|"WriteProvisionedThroughputExceeded"|"ReadProvisionedThroughputExceeded"|"IteratorAgeMilliseconds"|"ALL"|string; + export type MetricsNameList = MetricsName[]; + export type MillisBehindLatest = number; + export type NextToken = string; + export type PartitionKey = string; + export type PositiveIntegerObject = number; + export interface PutRecordInput { + /** + * The name of the stream to put the data record into. + */ + StreamName: StreamName; + /** + * The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB). + */ + Data: Data; + /** + * Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. + */ + PartitionKey: PartitionKey; + /** + * The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash. + */ + ExplicitHashKey?: HashKey; + /** + * Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time. + */ + SequenceNumberForOrdering?: SequenceNumber; + } + export interface PutRecordOutput { + /** + * The shard ID of the shard where the data record was placed. + */ + ShardId: ShardId; + /** + * The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream. + */ + SequenceNumber: SequenceNumber; + /** + * The encryption type to use on the record. This parameter can be one of the following values: NONE: Do not encrypt the records in the stream. KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key. + */ + EncryptionType?: EncryptionType; + } + export interface PutRecordsInput { + /** + * The records associated with the request. + */ + Records: PutRecordsRequestEntryList; + /** + * The stream name associated with the request. + */ + StreamName: StreamName; + } + export interface PutRecordsOutput { + /** + * The number of unsuccessfully processed records in a PutRecords request. + */ + FailedRecordCount?: PositiveIntegerObject; + /** + * An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result. + */ + Records: PutRecordsResultEntryList; + /** + * The encryption type used on the records. This parameter can be one of the following values: NONE: Do not encrypt the records. KMS: Use server-side encryption on the records using a customer-managed AWS KMS key. + */ + EncryptionType?: EncryptionType; + } + export interface PutRecordsRequestEntry { + /** + * The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB). + */ + Data: Data; + /** + * The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash. + */ + ExplicitHashKey?: HashKey; + /** + * Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. + */ + PartitionKey: PartitionKey; + } + export type PutRecordsRequestEntryList = PutRecordsRequestEntry[]; + export interface PutRecordsResultEntry { + /** + * The sequence number for an individual record result. + */ + SequenceNumber?: SequenceNumber; + /** + * The shard ID for an individual record result. + */ + ShardId?: ShardId; + /** + * The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure. + */ + ErrorCode?: ErrorCode; + /** + * The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure". + */ + ErrorMessage?: ErrorMessage; + } + export type PutRecordsResultEntryList = PutRecordsResultEntry[]; + export interface Record { + /** + * The unique identifier of the record within its shard. + */ + SequenceNumber: SequenceNumber; + /** + * The approximate time that the record was inserted into the stream. + */ + ApproximateArrivalTimestamp?: Timestamp; + /** + * The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB). + */ + Data: Data; + /** + * Identifies which shard in the stream the data record is assigned to. + */ + PartitionKey: PartitionKey; + /** + * The encryption type used on the record. This parameter can be one of the following values: NONE: Do not encrypt the records in the stream. KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key. + */ + EncryptionType?: EncryptionType; + } + export type RecordList = Record[]; + export interface RegisterStreamConsumerInput { + /** + * The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + StreamARN: StreamARN; + /** + * For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams. + */ + ConsumerName: ConsumerName; + } + export interface RegisterStreamConsumerOutput { + /** + * An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams. + */ + Consumer: Consumer; + } + export interface RemoveTagsFromStreamInput { + /** + * The name of the stream. + */ + StreamName: StreamName; + /** + * A list of tag keys. Each corresponding tag is removed from the stream. + */ + TagKeys: TagKeyList; + } + export type RetentionPeriodHours = number; + export type ScalingType = "UNIFORM_SCALING"|string; + export type SequenceNumber = string; + export interface SequenceNumberRange { + /** + * The starting sequence number for the range. + */ + StartingSequenceNumber: SequenceNumber; + /** + * The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null. + */ + EndingSequenceNumber?: SequenceNumber; + } + export interface Shard { + /** + * The unique identifier of the shard within the stream. + */ + ShardId: ShardId; + /** + * The shard ID of the shard's parent. + */ + ParentShardId?: ShardId; + /** + * The shard ID of the shard adjacent to the shard's parent. + */ + AdjacentParentShardId?: ShardId; + /** + * The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers. + */ + HashKeyRange: HashKeyRange; + /** + * The range of possible sequence numbers for the shard. + */ + SequenceNumberRange: SequenceNumberRange; + } + export type ShardCountObject = number; + export type ShardId = string; + export type ShardIterator = string; + export type ShardIteratorType = "AT_SEQUENCE_NUMBER"|"AFTER_SEQUENCE_NUMBER"|"TRIM_HORIZON"|"LATEST"|"AT_TIMESTAMP"|string; + export type ShardList = Shard[]; + export interface SplitShardInput { + /** + * The name of the stream for the shard split. + */ + StreamName: StreamName; + /** + * The shard ID of the shard to split. + */ + ShardToSplit: ShardId; + /** + * A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard. + */ + NewStartingHashKey: HashKey; + } + export interface StartStreamEncryptionInput { + /** + * The name of the stream for which to start encrypting records. + */ + StreamName: StreamName; + /** + * The encryption type to use. The only valid value is KMS. + */ + EncryptionType: EncryptionType; + /** + * The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis. Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally unique key ID example: 12345678-1234-1234-1234-123456789012 Alias name example: alias/MyAliasName Master key owned by Kinesis Data Streams: alias/aws/kinesis + */ + KeyId: KeyId; + } + export interface StopStreamEncryptionInput { + /** + * The name of the stream on which to stop encrypting records. + */ + StreamName: StreamName; + /** + * The encryption type. The only valid value is KMS. + */ + EncryptionType: EncryptionType; + /** + * The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis. Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally unique key ID example: 12345678-1234-1234-1234-123456789012 Alias name example: alias/MyAliasName Master key owned by Kinesis Data Streams: alias/aws/kinesis + */ + KeyId: KeyId; + } + export type StreamARN = string; + export interface StreamDescription { + /** + * The name of the stream being described. + */ + StreamName: StreamName; + /** + * The Amazon Resource Name (ARN) for the stream being described. + */ + StreamARN: StreamARN; + /** + * The current status of the stream being described. The stream status is one of the following states: CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING. DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream. UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state. + */ + StreamStatus: StreamStatus; + /** + * The shards that comprise the stream. + */ + Shards: ShardList; + /** + * If set to true, more shards in the stream are available to describe. + */ + HasMoreShards: BooleanObject; + /** + * The current retention period, in hours. + */ + RetentionPeriodHours: RetentionPeriodHours; + /** + * The approximate time that the stream was created. + */ + StreamCreationTimestamp: Timestamp; + /** + * Represents the current enhanced monitoring settings of the stream. + */ + EnhancedMonitoring: EnhancedMonitoringList; + /** + * The server-side encryption type used on the stream. This parameter can be one of the following values: NONE: Do not encrypt the records in the stream. KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key. + */ + EncryptionType?: EncryptionType; + /** + * The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis. Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally unique key ID example: 12345678-1234-1234-1234-123456789012 Alias name example: alias/MyAliasName Master key owned by Kinesis Data Streams: alias/aws/kinesis + */ + KeyId?: KeyId; + } + export interface StreamDescriptionSummary { + /** + * The name of the stream being described. + */ + StreamName: StreamName; + /** + * The Amazon Resource Name (ARN) for the stream being described. + */ + StreamARN: StreamARN; + /** + * The current status of the stream being described. The stream status is one of the following states: CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING. DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream. UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state. + */ + StreamStatus: StreamStatus; + /** + * The current retention period, in hours. + */ + RetentionPeriodHours: PositiveIntegerObject; + /** + * The approximate time that the stream was created. + */ + StreamCreationTimestamp: Timestamp; + /** + * Represents the current enhanced monitoring settings of the stream. + */ + EnhancedMonitoring: EnhancedMonitoringList; + /** + * The encryption type used. This value is one of the following: KMS NONE + */ + EncryptionType?: EncryptionType; + /** + * The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis. Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally unique key ID example: 12345678-1234-1234-1234-123456789012 Alias name example: alias/MyAliasName Master key owned by Kinesis Data Streams: alias/aws/kinesis + */ + KeyId?: KeyId; + /** + * The number of open shards in the stream. + */ + OpenShardCount: ShardCountObject; + /** + * The number of enhanced fan-out consumers registered with the stream. + */ + ConsumerCount?: ConsumerCountObject; + } + export type StreamName = string; + export type StreamNameList = StreamName[]; + export type StreamStatus = "CREATING"|"DELETING"|"ACTIVE"|"UPDATING"|string; + export interface Tag { + /** + * A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @ + */ + Key: TagKey; + /** + * An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @ + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export type TagMap = {[key: string]: TagValue}; + export type TagValue = string; + export type Timestamp = Date; + export interface UpdateShardCountInput { + /** + * The name of the stream. + */ + StreamName: StreamName; + /** + * The new number of shards. + */ + TargetShardCount: PositiveIntegerObject; + /** + * The scaling type. Uniform scaling creates shards of equal size. + */ + ScalingType: ScalingType; + } + export interface UpdateShardCountOutput { + /** + * The name of the stream. + */ + StreamName?: StreamName; + /** + * The current number of shards. + */ + CurrentShardCount?: PositiveIntegerObject; + /** + * The updated number of shards. + */ + TargetShardCount?: PositiveIntegerObject; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-12-02"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Kinesis client. + */ + export import Types = Kinesis; +} +export = Kinesis; diff --git a/node_modules/aws-sdk/clients/kinesis.js b/node_modules/aws-sdk/clients/kinesis.js new file mode 100644 index 0000000..e7fbe10 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesis.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kinesis'] = {}; +AWS.Kinesis = Service.defineService('kinesis', ['2013-12-02']); +Object.defineProperty(apiLoader.services['kinesis'], '2013-12-02', { + get: function get() { + var model = require('../apis/kinesis-2013-12-02.min.json'); + model.paginators = require('../apis/kinesis-2013-12-02.paginators.json').pagination; + model.waiters = require('../apis/kinesis-2013-12-02.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Kinesis; diff --git a/node_modules/aws-sdk/clients/kinesisanalytics.d.ts b/node_modules/aws-sdk/clients/kinesisanalytics.d.ts new file mode 100644 index 0000000..d92b1e6 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisanalytics.d.ts @@ -0,0 +1,1224 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class KinesisAnalytics extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: KinesisAnalytics.Types.ClientConfiguration) + config: Config & KinesisAnalytics.Types.ClientConfiguration; + /** + * Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs. + */ + addApplicationCloudWatchLoggingOption(params: KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs. + */ + addApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input. You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action. + */ + addApplicationInput(params: KinesisAnalytics.Types.AddApplicationInputRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputResponse) => void): Request; + /** + * Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input. You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action. + */ + addApplicationInput(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputResponse) => void): Request; + /** + * Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda. + */ + addApplicationInputProcessingConfiguration(params: KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda. + */ + addApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. + */ + addApplicationOutput(params: KinesisAnalytics.Types.AddApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationOutputResponse) => void): Request; + /** + * Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. + */ + addApplicationOutput(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationOutputResponse) => void): Request; + /** + * Adds a reference data source to an existing application. Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. + */ + addApplicationReferenceDataSource(params: KinesisAnalytics.Types.AddApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationReferenceDataSourceResponse) => void): Request; + /** + * Adds a reference data source to an existing application. Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. + */ + addApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationReferenceDataSourceResponse) => void): Request; + /** + * Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works. In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source. Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps. In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations. To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started. + */ + createApplication(params: KinesisAnalytics.Types.CreateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.CreateApplicationResponse) => void): Request; + /** + * Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works. In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source. Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps. In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations. To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started. + */ + createApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.CreateApplicationResponse) => void): Request; + /** + * Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code). This operation requires permissions to perform the kinesisanalytics:DeleteApplication action. + */ + deleteApplication(params: KinesisAnalytics.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationResponse) => void): Request; + /** + * Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code). This operation requires permissions to perform the kinesisanalytics:DeleteApplication action. + */ + deleteApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationResponse) => void): Request; + /** + * Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs. + */ + deleteApplicationCloudWatchLoggingOption(params: KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs. + */ + deleteApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Deletes an InputProcessingConfiguration from an input. + */ + deleteApplicationInputProcessingConfiguration(params: KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Deletes an InputProcessingConfiguration from an input. + */ + deleteApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination. This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action. + */ + deleteApplicationOutput(params: KinesisAnalytics.Types.DeleteApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationOutputResponse) => void): Request; + /** + * Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination. This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action. + */ + deleteApplicationOutput(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationOutputResponse) => void): Request; + /** + * Deletes a reference data source configuration from the specified application configuration. If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action. + */ + deleteApplicationReferenceDataSource(params: KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request; + /** + * Deletes a reference data source configuration from the specified application configuration. If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action. + */ + deleteApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request; + /** + * Returns information about a specific Amazon Kinesis Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update. + */ + describeApplication(params: KinesisAnalytics.Types.DescribeApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DescribeApplicationResponse) => void): Request; + /** + * Returns information about a specific Amazon Kinesis Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update. + */ + describeApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.DescribeApplicationResponse) => void): Request; + /** + * Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action. + */ + discoverInputSchema(params: KinesisAnalytics.Types.DiscoverInputSchemaRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DiscoverInputSchemaResponse) => void): Request; + /** + * Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action. + */ + discoverInputSchema(callback?: (err: AWSError, data: KinesisAnalytics.Types.DiscoverInputSchemaResponse) => void): Request; + /** + * Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response. If you want detailed information about a specific application, use DescribeApplication. This operation requires permissions to perform the kinesisanalytics:ListApplications action. + */ + listApplications(params: KinesisAnalytics.Types.ListApplicationsRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.ListApplicationsResponse) => void): Request; + /** + * Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response. If you want detailed information about a specific application, use DescribeApplication. This operation requires permissions to perform the kinesisanalytics:ListApplications action. + */ + listApplications(callback?: (err: AWSError, data: KinesisAnalytics.Types.ListApplicationsResponse) => void): Request; + /** + * Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application. After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination. The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation. After you start the application, you can stop the application from processing the input by calling the StopApplication operation. This operation requires permissions to perform the kinesisanalytics:StartApplication action. + */ + startApplication(params: KinesisAnalytics.Types.StartApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.StartApplicationResponse) => void): Request; + /** + * Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application. After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination. The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation. After you start the application, you can stop the application from processing the input by calling the StopApplication operation. This operation requires permissions to perform the kinesisanalytics:StartApplication action. + */ + startApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.StartApplicationResponse) => void): Request; + /** + * Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. This operation requires permissions to perform the kinesisanalytics:StopApplication action. + */ + stopApplication(params: KinesisAnalytics.Types.StopApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.StopApplicationResponse) => void): Request; + /** + * Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. This operation requires permissions to perform the kinesisanalytics:StopApplication action. + */ + stopApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.StopApplicationResponse) => void): Request; + /** + * Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration. Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application. This operation requires permission for the kinesisanalytics:UpdateApplication action. + */ + updateApplication(params: KinesisAnalytics.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.UpdateApplicationResponse) => void): Request; + /** + * Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration. Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application. This operation requires permission for the kinesisanalytics:UpdateApplication action. + */ + updateApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.UpdateApplicationResponse) => void): Request; +} +declare namespace KinesisAnalytics { + export interface AddApplicationCloudWatchLoggingOptionRequest { + /** + * The Kinesis Analytics application name. + */ + ApplicationName: ApplicationName; + /** + * The version ID of the Kinesis Analytics application. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled. + */ + CloudWatchLoggingOption: CloudWatchLoggingOption; + } + export interface AddApplicationCloudWatchLoggingOptionResponse { + } + export interface AddApplicationInputProcessingConfigurationRequest { + /** + * Name of the application to which you want to add the input processing configuration. + */ + ApplicationName: ApplicationName; + /** + * Version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation. + */ + InputId: Id; + /** + * The InputProcessingConfiguration to add to the application. + */ + InputProcessingConfiguration: InputProcessingConfiguration; + } + export interface AddApplicationInputProcessingConfigurationResponse { + } + export interface AddApplicationInputRequest { + /** + * Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source. + */ + ApplicationName: ApplicationName; + /** + * Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The Input to add. + */ + Input: Input; + } + export interface AddApplicationInputResponse { + } + export interface AddApplicationOutputRequest { + /** + * Name of the application to which you want to add the output configuration. + */ + ApplicationName: ApplicationName; + /** + * Version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination. + */ + Output: Output; + } + export interface AddApplicationOutputResponse { + } + export interface AddApplicationReferenceDataSourceRequest { + /** + * Name of an existing application. + */ + ApplicationName: ApplicationName; + /** + * Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf. + */ + ReferenceDataSource: ReferenceDataSource; + } + export interface AddApplicationReferenceDataSourceResponse { + } + export type ApplicationCode = string; + export type ApplicationDescription = string; + export interface ApplicationDetail { + /** + * Name of the application. + */ + ApplicationName: ApplicationName; + /** + * Description of the application. + */ + ApplicationDescription?: ApplicationDescription; + /** + * ARN of the application. + */ + ApplicationARN: ResourceARN; + /** + * Status of the application. + */ + ApplicationStatus: ApplicationStatus; + /** + * Time stamp when the application version was created. + */ + CreateTimestamp?: Timestamp; + /** + * Time stamp when the application was last updated. + */ + LastUpdateTimestamp?: Timestamp; + /** + * Describes the application input configuration. For more information, see Configuring Application Input. + */ + InputDescriptions?: InputDescriptions; + /** + * Describes the application output configuration. For more information, see Configuring Application Output. + */ + OutputDescriptions?: OutputDescriptions; + /** + * Describes reference data sources configured for the application. For more information, see Configuring Application Input. + */ + ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions; + /** + * Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs. + */ + CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions; + /** + * Returns the application code that you provided to perform data analysis on any of the in-application streams in your application. + */ + ApplicationCode?: ApplicationCode; + /** + * Provides the current application version. + */ + ApplicationVersionId: ApplicationVersionId; + } + export type ApplicationName = string; + export type ApplicationStatus = "DELETING"|"STARTING"|"STOPPING"|"READY"|"RUNNING"|"UPDATING"|string; + export type ApplicationSummaries = ApplicationSummary[]; + export interface ApplicationSummary { + /** + * Name of the application. + */ + ApplicationName: ApplicationName; + /** + * ARN of the application. + */ + ApplicationARN: ResourceARN; + /** + * Status of the application. + */ + ApplicationStatus: ApplicationStatus; + } + export interface ApplicationUpdate { + /** + * Describes application input configuration updates. + */ + InputUpdates?: InputUpdates; + /** + * Describes application code updates. + */ + ApplicationCodeUpdate?: ApplicationCode; + /** + * Describes application output configuration updates. + */ + OutputUpdates?: OutputUpdates; + /** + * Describes application reference data source updates. + */ + ReferenceDataSourceUpdates?: ReferenceDataSourceUpdates; + /** + * Describes application CloudWatch logging option updates. + */ + CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdates; + } + export type ApplicationVersionId = number; + export type BooleanObject = boolean; + export type BucketARN = string; + export interface CSVMappingParameters { + /** + * Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter. + */ + RecordRowDelimiter: RecordRowDelimiter; + /** + * Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter. + */ + RecordColumnDelimiter: RecordColumnDelimiter; + } + export interface CloudWatchLoggingOption { + /** + * ARN of the CloudWatch log to receive application messages. + */ + LogStreamARN: LogStreamARN; + /** + * IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled. + */ + RoleARN: RoleARN; + } + export interface CloudWatchLoggingOptionDescription { + /** + * ID of the CloudWatch logging option description. + */ + CloudWatchLoggingOptionId?: Id; + /** + * ARN of the CloudWatch log to receive application messages. + */ + LogStreamARN: LogStreamARN; + /** + * IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled. + */ + RoleARN: RoleARN; + } + export type CloudWatchLoggingOptionDescriptions = CloudWatchLoggingOptionDescription[]; + export interface CloudWatchLoggingOptionUpdate { + /** + * ID of the CloudWatch logging option to update + */ + CloudWatchLoggingOptionId: Id; + /** + * ARN of the CloudWatch log to receive application messages. + */ + LogStreamARNUpdate?: LogStreamARN; + /** + * IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled. + */ + RoleARNUpdate?: RoleARN; + } + export type CloudWatchLoggingOptionUpdates = CloudWatchLoggingOptionUpdate[]; + export type CloudWatchLoggingOptions = CloudWatchLoggingOption[]; + export interface CreateApplicationRequest { + /** + * Name of your Amazon Kinesis Analytics application (for example, sample-app). + */ + ApplicationName: ApplicationName; + /** + * Summary description of the application. + */ + ApplicationDescription?: ApplicationDescription; + /** + * Use this parameter to configure the application input. You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table). For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf. To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream. + */ + Inputs?: Inputs; + /** + * You can configure application output to write data from any of the in-application streams to up to three destinations. These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three. In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf. In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf. + */ + Outputs?: Outputs; + /** + * Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + /** + * One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code. You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps. Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams. + */ + ApplicationCode?: ApplicationCode; + } + export interface CreateApplicationResponse { + /** + * In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status. + */ + ApplicationSummary: ApplicationSummary; + } + export interface DeleteApplicationCloudWatchLoggingOptionRequest { + /** + * The Kinesis Analytics application name. + */ + ApplicationName: ApplicationName; + /** + * The version ID of the Kinesis Analytics application. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation. + */ + CloudWatchLoggingOptionId: Id; + } + export interface DeleteApplicationCloudWatchLoggingOptionResponse { + } + export interface DeleteApplicationInputProcessingConfigurationRequest { + /** + * The Kinesis Analytics application name. + */ + ApplicationName: ApplicationName; + /** + * The version ID of the Kinesis Analytics application. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation. + */ + InputId: Id; + } + export interface DeleteApplicationInputProcessingConfigurationResponse { + } + export interface DeleteApplicationOutputRequest { + /** + * Amazon Kinesis Analytics application name. + */ + ApplicationName: ApplicationName; + /** + * Amazon Kinesis Analytics application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId. + */ + OutputId: Id; + } + export interface DeleteApplicationOutputResponse { + } + export interface DeleteApplicationReferenceDataSourceRequest { + /** + * Name of an existing application. + */ + ApplicationName: ApplicationName; + /** + * Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID. + */ + ReferenceId: Id; + } + export interface DeleteApplicationReferenceDataSourceResponse { + } + export interface DeleteApplicationRequest { + /** + * Name of the Amazon Kinesis Analytics application to delete. + */ + ApplicationName: ApplicationName; + /** + * You can use the DescribeApplication operation to get this value. + */ + CreateTimestamp: Timestamp; + } + export interface DeleteApplicationResponse { + } + export interface DescribeApplicationRequest { + /** + * Name of the application. + */ + ApplicationName: ApplicationName; + } + export interface DescribeApplicationResponse { + /** + * Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details. + */ + ApplicationDetail: ApplicationDetail; + } + export interface DestinationSchema { + /** + * Specifies the format of the records on the output stream. + */ + RecordFormatType: RecordFormatType; + } + export interface DiscoverInputSchemaRequest { + /** + * Amazon Resource Name (ARN) of the streaming source. + */ + ResourceARN?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. + */ + RoleARN?: RoleARN; + /** + * Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes. + */ + InputStartingPositionConfiguration?: InputStartingPositionConfiguration; + /** + * Specify this parameter to discover a schema from data in an Amazon S3 object. + */ + S3Configuration?: S3Configuration; + /** + * The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records. + */ + InputProcessingConfiguration?: InputProcessingConfiguration; + } + export interface DiscoverInputSchemaResponse { + /** + * Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create. + */ + InputSchema?: SourceSchema; + /** + * An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row). + */ + ParsedInputRecords?: ParsedInputRecords; + /** + * Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter. + */ + ProcessedInputRecords?: ProcessedInputRecords; + /** + * Raw stream data that was sampled to infer the schema. + */ + RawInputRecords?: RawInputRecords; + } + export type FileKey = string; + export type Id = string; + export type InAppStreamName = string; + export type InAppStreamNames = InAppStreamName[]; + export type InAppTableName = string; + export interface Input { + /** + * Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. + */ + NamePrefix: InAppStreamName; + /** + * The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor. + */ + InputProcessingConfiguration?: InputProcessingConfiguration; + /** + * If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. + */ + KinesisStreamsInput?: KinesisStreamsInput; + /** + * If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. + */ + KinesisFirehoseInput?: KinesisFirehoseInput; + /** + * Describes the number of in-application streams to create. Data from your source is routed to these in-application input streams. (see Configuring Application Input. + */ + InputParallelism?: InputParallelism; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. Also used to describe the format of the reference data source. + */ + InputSchema: SourceSchema; + } + export interface InputConfiguration { + /** + * Input source ID. You can get this ID by calling the DescribeApplication operation. + */ + Id: Id; + /** + * Point at which you want the application to start processing records from the streaming source. + */ + InputStartingPositionConfiguration: InputStartingPositionConfiguration; + } + export type InputConfigurations = InputConfiguration[]; + export interface InputDescription { + /** + * Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application. + */ + InputId?: Id; + /** + * In-application name prefix. + */ + NamePrefix?: InAppStreamName; + /** + * Returns the in-application stream names that are mapped to the stream source. + */ + InAppStreamNames?: InAppStreamNames; + /** + * The description of the preprocessor that executes on records in this input before the application's code is run. + */ + InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription; + /** + * If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. + */ + KinesisStreamsInputDescription?: KinesisStreamsInputDescription; + /** + * If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. + */ + KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. + */ + InputSchema?: SourceSchema; + /** + * Describes the configured parallelism (number of in-application streams mapped to the streaming source). + */ + InputParallelism?: InputParallelism; + /** + * Point at which the application is configured to read from the input stream. + */ + InputStartingPositionConfiguration?: InputStartingPositionConfiguration; + } + export type InputDescriptions = InputDescription[]; + export interface InputLambdaProcessor { + /** + * The ARN of the AWS Lambda function that operates on records in the stream. + */ + ResourceARN: ResourceARN; + /** + * The ARN of the IAM role that is used to access the AWS Lambda function. + */ + RoleARN: RoleARN; + } + export interface InputLambdaProcessorDescription { + /** + * The ARN of the AWS Lambda function that is used to preprocess the records in the stream. + */ + ResourceARN?: ResourceARN; + /** + * The ARN of the IAM role that is used to access the AWS Lambda function. + */ + RoleARN?: RoleARN; + } + export interface InputLambdaProcessorUpdate { + /** + * The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream. + */ + ResourceARNUpdate?: ResourceARN; + /** + * The ARN of the new IAM role that is used to access the AWS Lambda function. + */ + RoleARNUpdate?: RoleARN; + } + export interface InputParallelism { + /** + * Number of in-application streams to create. For more information, see Limits. + */ + Count?: InputParallelismCount; + } + export type InputParallelismCount = number; + export interface InputParallelismUpdate { + /** + * Number of in-application streams to create for the specified streaming source. + */ + CountUpdate?: InputParallelismCount; + } + export interface InputProcessingConfiguration { + /** + * The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code. + */ + InputLambdaProcessor: InputLambdaProcessor; + } + export interface InputProcessingConfigurationDescription { + /** + * Provides configuration information about the associated InputLambdaProcessorDescription. + */ + InputLambdaProcessorDescription?: InputLambdaProcessorDescription; + } + export interface InputProcessingConfigurationUpdate { + /** + * Provides update information for an InputLambdaProcessor. + */ + InputLambdaProcessorUpdate: InputLambdaProcessorUpdate; + } + export interface InputSchemaUpdate { + /** + * Specifies the format of the records on the streaming source. + */ + RecordFormatUpdate?: RecordFormat; + /** + * Specifies the encoding of the records in the streaming source. For example, UTF-8. + */ + RecordEncodingUpdate?: RecordEncoding; + /** + * A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream. + */ + RecordColumnUpdates?: RecordColumns; + } + export type InputStartingPosition = "NOW"|"TRIM_HORIZON"|"LAST_STOPPED_POINT"|string; + export interface InputStartingPositionConfiguration { + /** + * The starting position on the stream. NOW - Start reading just after the most recent record in the stream, start at the request time stamp that the customer issued. TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream. LAST_STOPPED_POINT - Resume reading from where the application last stopped reading. + */ + InputStartingPosition?: InputStartingPosition; + } + export interface InputUpdate { + /** + * Input ID of the application input to be updated. + */ + InputId: Id; + /** + * Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source. + */ + NamePrefixUpdate?: InAppStreamName; + /** + * Describes updates for an input processing configuration. + */ + InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate; + /** + * If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN. + */ + KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate; + /** + * If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN. + */ + KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate; + /** + * Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created. + */ + InputSchemaUpdate?: InputSchemaUpdate; + /** + * Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source). + */ + InputParallelismUpdate?: InputParallelismUpdate; + } + export type InputUpdates = InputUpdate[]; + export type Inputs = Input[]; + export interface JSONMappingParameters { + /** + * Path to the top-level parent that contains the records. + */ + RecordRowPath: RecordRowPath; + } + export interface KinesisFirehoseInput { + /** + * ARN of the input delivery stream. + */ + ResourceARN: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream. + */ + RoleARN: RoleARN; + } + export interface KinesisFirehoseInputDescription { + /** + * Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. + */ + ResourceARN?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream. + */ + RoleARN?: RoleARN; + } + export interface KinesisFirehoseInputUpdate { + /** + * Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read. + */ + ResourceARNUpdate?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARNUpdate?: RoleARN; + } + export interface KinesisFirehoseOutput { + /** + * ARN of the destination Amazon Kinesis Firehose delivery stream to write to. + */ + ResourceARN: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARN: RoleARN; + } + export interface KinesisFirehoseOutputDescription { + /** + * Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. + */ + ResourceARN?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream. + */ + RoleARN?: RoleARN; + } + export interface KinesisFirehoseOutputUpdate { + /** + * Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to. + */ + ResourceARNUpdate?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARNUpdate?: RoleARN; + } + export interface KinesisStreamsInput { + /** + * ARN of the input Amazon Kinesis stream to read. + */ + ResourceARN: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARN: RoleARN; + } + export interface KinesisStreamsInputDescription { + /** + * Amazon Resource Name (ARN) of the Amazon Kinesis stream. + */ + ResourceARN?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream. + */ + RoleARN?: RoleARN; + } + export interface KinesisStreamsInputUpdate { + /** + * Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read. + */ + ResourceARNUpdate?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARNUpdate?: RoleARN; + } + export interface KinesisStreamsOutput { + /** + * ARN of the destination Amazon Kinesis stream to write to. + */ + ResourceARN: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARN: RoleARN; + } + export interface KinesisStreamsOutputDescription { + /** + * Amazon Resource Name (ARN) of the Amazon Kinesis stream. + */ + ResourceARN?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream. + */ + RoleARN?: RoleARN; + } + export interface KinesisStreamsOutputUpdate { + /** + * Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output. + */ + ResourceARNUpdate?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARNUpdate?: RoleARN; + } + export interface LambdaOutput { + /** + * Amazon Resource Name (ARN) of the destination Lambda function to write to. + */ + ResourceARN: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARN: RoleARN; + } + export interface LambdaOutputDescription { + /** + * Amazon Resource Name (ARN) of the destination Lambda function. + */ + ResourceARN?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function. + */ + RoleARN?: RoleARN; + } + export interface LambdaOutputUpdate { + /** + * Amazon Resource Name (ARN) of the destination Lambda function. + */ + ResourceARNUpdate?: ResourceARN; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. + */ + RoleARNUpdate?: RoleARN; + } + export type ListApplicationsInputLimit = number; + export interface ListApplicationsRequest { + /** + * Maximum number of applications to list. + */ + Limit?: ListApplicationsInputLimit; + /** + * Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications. + */ + ExclusiveStartApplicationName?: ApplicationName; + } + export interface ListApplicationsResponse { + /** + * List of ApplicationSummary objects. + */ + ApplicationSummaries: ApplicationSummaries; + /** + * Returns true if there are more applications to retrieve. + */ + HasMoreApplications: BooleanObject; + } + export type LogStreamARN = string; + export interface MappingParameters { + /** + * Provides additional mapping information when JSON is the record format on the streaming source. + */ + JSONMappingParameters?: JSONMappingParameters; + /** + * Provides additional mapping information when the record format uses delimiters (for example, CSV). + */ + CSVMappingParameters?: CSVMappingParameters; + } + export interface Output { + /** + * Name of the in-application stream. + */ + Name: InAppStreamName; + /** + * Identifies an Amazon Kinesis stream as the destination. + */ + KinesisStreamsOutput?: KinesisStreamsOutput; + /** + * Identifies an Amazon Kinesis Firehose delivery stream as the destination. + */ + KinesisFirehoseOutput?: KinesisFirehoseOutput; + /** + * Identifies an AWS Lambda function as the destination. + */ + LambdaOutput?: LambdaOutput; + /** + * Describes the data format when records are written to the destination. For more information, see Configuring Application Output. + */ + DestinationSchema: DestinationSchema; + } + export interface OutputDescription { + /** + * A unique identifier for the output configuration. + */ + OutputId?: Id; + /** + * Name of the in-application stream configured as output. + */ + Name?: InAppStreamName; + /** + * Describes Amazon Kinesis stream configured as the destination where output is written. + */ + KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription; + /** + * Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written. + */ + KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription; + /** + * Describes the AWS Lambda function configured as the destination where output is written. + */ + LambdaOutputDescription?: LambdaOutputDescription; + /** + * Data format used for writing data to the destination. + */ + DestinationSchema?: DestinationSchema; + } + export type OutputDescriptions = OutputDescription[]; + export interface OutputUpdate { + /** + * Identifies the specific output configuration that you want to update. + */ + OutputId: Id; + /** + * If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name. + */ + NameUpdate?: InAppStreamName; + /** + * Describes an Amazon Kinesis stream as the destination for the output. + */ + KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate; + /** + * Describes an Amazon Kinesis Firehose delivery stream as the destination for the output. + */ + KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate; + /** + * Describes an AWS Lambda function as the destination for the output. + */ + LambdaOutputUpdate?: LambdaOutputUpdate; + /** + * Describes the data format when records are written to the destination. For more information, see Configuring Application Output. + */ + DestinationSchemaUpdate?: DestinationSchema; + } + export type OutputUpdates = OutputUpdate[]; + export type Outputs = Output[]; + export type ParsedInputRecord = ParsedInputRecordField[]; + export type ParsedInputRecordField = string; + export type ParsedInputRecords = ParsedInputRecord[]; + export type ProcessedInputRecord = string; + export type ProcessedInputRecords = ProcessedInputRecord[]; + export type RawInputRecord = string; + export type RawInputRecords = RawInputRecord[]; + export interface RecordColumn { + /** + * Name of the column created in the in-application input stream or reference table. + */ + Name: RecordColumnName; + /** + * Reference to the data element in the streaming input of the reference data source. + */ + Mapping?: RecordColumnMapping; + /** + * Type of column created in the in-application input stream or reference table. + */ + SqlType: RecordColumnSqlType; + } + export type RecordColumnDelimiter = string; + export type RecordColumnMapping = string; + export type RecordColumnName = string; + export type RecordColumnSqlType = string; + export type RecordColumns = RecordColumn[]; + export type RecordEncoding = string; + export interface RecordFormat { + /** + * The type of record format. + */ + RecordFormatType: RecordFormatType; + /** + * When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source. + */ + MappingParameters?: MappingParameters; + } + export type RecordFormatType = "JSON"|"CSV"|string; + export type RecordRowDelimiter = string; + export type RecordRowPath = string; + export interface ReferenceDataSource { + /** + * Name of the in-application table to create. + */ + TableName: InAppTableName; + /** + * Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application. + */ + S3ReferenceDataSource?: S3ReferenceDataSource; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + */ + ReferenceSchema: SourceSchema; + } + export interface ReferenceDataSourceDescription { + /** + * ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation. + */ + ReferenceId: Id; + /** + * The in-application table name created by the specific reference data source configuration. + */ + TableName: InAppTableName; + /** + * Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table. + */ + S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + */ + ReferenceSchema?: SourceSchema; + } + export type ReferenceDataSourceDescriptions = ReferenceDataSourceDescription[]; + export interface ReferenceDataSourceUpdate { + /** + * ID of the reference data source being updated. You can use the DescribeApplication operation to get this value. + */ + ReferenceId: Id; + /** + * In-application table name that is created by this update. + */ + TableNameUpdate?: InAppTableName; + /** + * Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table. + */ + S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + */ + ReferenceSchemaUpdate?: SourceSchema; + } + export type ReferenceDataSourceUpdates = ReferenceDataSourceUpdate[]; + export type ResourceARN = string; + export type RoleARN = string; + export interface S3Configuration { + /** + * IAM ARN of the role used to access the data. + */ + RoleARN: RoleARN; + /** + * ARN of the S3 bucket that contains the data. + */ + BucketARN: BucketARN; + /** + * The name of the object that contains the data. + */ + FileKey: FileKey; + } + export interface S3ReferenceDataSource { + /** + * Amazon Resource Name (ARN) of the S3 bucket. + */ + BucketARN: BucketARN; + /** + * Object key name containing reference data. + */ + FileKey: FileKey; + /** + * ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role. + */ + ReferenceRoleARN: RoleARN; + } + export interface S3ReferenceDataSourceDescription { + /** + * Amazon Resource Name (ARN) of the S3 bucket. + */ + BucketARN: BucketARN; + /** + * Amazon S3 object key name. + */ + FileKey: FileKey; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table. + */ + ReferenceRoleARN: RoleARN; + } + export interface S3ReferenceDataSourceUpdate { + /** + * Amazon Resource Name (ARN) of the S3 bucket. + */ + BucketARNUpdate?: BucketARN; + /** + * Object key name. + */ + FileKeyUpdate?: FileKey; + /** + * ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application. + */ + ReferenceRoleARNUpdate?: RoleARN; + } + export interface SourceSchema { + /** + * Specifies the format of the records on the streaming source. + */ + RecordFormat: RecordFormat; + /** + * Specifies the encoding of the records in the streaming source. For example, UTF-8. + */ + RecordEncoding?: RecordEncoding; + /** + * A list of RecordColumn objects. + */ + RecordColumns: RecordColumns; + } + export interface StartApplicationRequest { + /** + * Name of the application. + */ + ApplicationName: ApplicationName; + /** + * Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading. + */ + InputConfigurations: InputConfigurations; + } + export interface StartApplicationResponse { + } + export interface StopApplicationRequest { + /** + * Name of the running application to stop. + */ + ApplicationName: ApplicationName; + } + export interface StopApplicationResponse { + } + export type Timestamp = Date; + export interface UpdateApplicationRequest { + /** + * Name of the Amazon Kinesis Analytics application to update. + */ + ApplicationName: ApplicationName; + /** + * The current application version ID. You can use the DescribeApplication operation to get this value. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * Describes application updates. + */ + ApplicationUpdate: ApplicationUpdate; + } + export interface UpdateApplicationResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-08-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the KinesisAnalytics client. + */ + export import Types = KinesisAnalytics; +} +export = KinesisAnalytics; diff --git a/node_modules/aws-sdk/clients/kinesisanalytics.js b/node_modules/aws-sdk/clients/kinesisanalytics.js new file mode 100644 index 0000000..00048f3 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisanalytics.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kinesisanalytics'] = {}; +AWS.KinesisAnalytics = Service.defineService('kinesisanalytics', ['2015-08-14']); +Object.defineProperty(apiLoader.services['kinesisanalytics'], '2015-08-14', { + get: function get() { + var model = require('../apis/kinesisanalytics-2015-08-14.min.json'); + model.paginators = require('../apis/kinesisanalytics-2015-08-14.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.KinesisAnalytics; diff --git a/node_modules/aws-sdk/clients/kinesisanalyticsv2.d.ts b/node_modules/aws-sdk/clients/kinesisanalyticsv2.d.ts new file mode 100644 index 0000000..88bdfac --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisanalyticsv2.d.ts @@ -0,0 +1,1909 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class KinesisAnalyticsV2 extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: KinesisAnalyticsV2.Types.ClientConfiguration) + config: Config & KinesisAnalyticsV2.Types.ClientConfiguration; + /** + * Adds an Amazon CloudWatch log stream to monitor application configuration errors. + */ + addApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Adds an Amazon CloudWatch log stream to monitor application configuration errors. + */ + addApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. + */ + addApplicationInput(params: KinesisAnalyticsV2.Types.AddApplicationInputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request; + /** + * Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. + */ + addApplicationInput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request; + /** + * Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda. + */ + addApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda. + */ + addApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. + */ + addApplicationOutput(params: KinesisAnalyticsV2.Types.AddApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request; + /** + * Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. + */ + addApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request; + /** + * Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table. + */ + addApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request; + /** + * Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table. + */ + addApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request; + /** + * Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application. SQL is not enabled for this private beta release. Using SQL parameters (such as SqlApplicationConfiguration) will result in an error. + */ + createApplication(params: KinesisAnalyticsV2.Types.CreateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request; + /** + * Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application. SQL is not enabled for this private beta release. Using SQL parameters (such as SqlApplicationConfiguration) will result in an error. + */ + createApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request; + /** + * Creates a snapshot of the application's state data. + */ + createApplicationSnapshot(params: KinesisAnalyticsV2.Types.CreateApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request; + /** + * Creates a snapshot of the application's state data. + */ + createApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request; + /** + * Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application. + */ + deleteApplication(params: KinesisAnalyticsV2.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request; + /** + * Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application. + */ + deleteApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request; + /** + * Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application. + */ + deleteApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application. + */ + deleteApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request; + /** + * Deletes an InputProcessingConfiguration from an input. + */ + deleteApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Deletes an InputProcessingConfiguration from an input. + */ + deleteApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request; + /** + * Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination. + */ + deleteApplicationOutput(params: KinesisAnalyticsV2.Types.DeleteApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request; + /** + * Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination. + */ + deleteApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request; + /** + * Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. + */ + deleteApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request; + /** + * Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. + */ + deleteApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request; + /** + * Deletes a snapshot of application state. + */ + deleteApplicationSnapshot(params: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request; + /** + * Deletes a snapshot of application state. + */ + deleteApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request; + /** + * Returns information about a specific Amazon Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. + */ + describeApplication(params: KinesisAnalyticsV2.Types.DescribeApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request; + /** + * Returns information about a specific Amazon Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. + */ + describeApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request; + /** + * Returns information about a snapshot of application state data. + */ + describeApplicationSnapshot(params: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request; + /** + * Returns information about a snapshot of application state data. + */ + describeApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request; + /** + * Infers a schema for an SQL-based Amazon Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface. + */ + discoverInputSchema(params: KinesisAnalyticsV2.Types.DiscoverInputSchemaRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request; + /** + * Infers a schema for an SQL-based Amazon Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface. + */ + discoverInputSchema(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request; + /** + * Lists information about the current application snapshots. + */ + listApplicationSnapshots(params: KinesisAnalyticsV2.Types.ListApplicationSnapshotsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request; + /** + * Lists information about the current application snapshots. + */ + listApplicationSnapshots(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request; + /** + * Returns a list of Amazon Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication. + */ + listApplications(params: KinesisAnalyticsV2.Types.ListApplicationsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request; + /** + * Returns a list of Amazon Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication. + */ + listApplications(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request; + /** + * Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application. SQL is not enabled for this private beta. Using SQL parameters (such as RunConfiguration$SqlRunConfigurations) will result in an error. + */ + startApplication(params: KinesisAnalyticsV2.Types.StartApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request; + /** + * Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application. SQL is not enabled for this private beta. Using SQL parameters (such as RunConfiguration$SqlRunConfigurations) will result in an error. + */ + startApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request; + /** + * Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. + */ + stopApplication(params: KinesisAnalyticsV2.Types.StopApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request; + /** + * Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. + */ + stopApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request; + /** + * Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application. SQL is not enabled for this private beta. Using SQL parameters (such as SqlApplicationConfigurationUpdate) will result in an error. + */ + updateApplication(params: KinesisAnalyticsV2.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request; + /** + * Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application. SQL is not enabled for this private beta. Using SQL parameters (such as SqlApplicationConfigurationUpdate) will result in an error. + */ + updateApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request; +} +declare namespace KinesisAnalyticsV2 { + export interface AddApplicationCloudWatchLoggingOptionRequest { + /** + * The Kinesis Data Analytics application name. + */ + ApplicationName: ApplicationName; + /** + * The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using DescribeApplication. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN). + */ + CloudWatchLoggingOption: CloudWatchLoggingOption; + } + export interface AddApplicationCloudWatchLoggingOptionResponse { + /** + * The application's ARN. + */ + ApplicationARN?: ResourceARN; + /** + * The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options. + */ + ApplicationVersionId?: ApplicationVersionId; + /** + * The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application. + */ + CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions; + } + export interface AddApplicationInputProcessingConfigurationRequest { + /** + * The name of the application to which you want to add the input processing configuration. + */ + ApplicationName: ApplicationName; + /** + * The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation. + */ + InputId: Id; + /** + * The InputProcessingConfiguration to add to the application. + */ + InputProcessingConfiguration: InputProcessingConfiguration; + } + export interface AddApplicationInputProcessingConfigurationResponse { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationARN?: ResourceARN; + /** + * Provides the current application version. + */ + ApplicationVersionId?: ApplicationVersionId; + /** + * The input ID that is associated with the application input. This is the ID that Amazon Kinesis Data Analytics assigns to each input configuration that you add to your application. + */ + InputId?: Id; + /** + * The description of the preprocessor that executes on records in this input before the application's code is run. + */ + InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription; + } + export interface AddApplicationInputRequest { + /** + * The name of your existing application to which you want to add the streaming source. + */ + ApplicationName: ApplicationName; + /** + * The current version of your application. You can use the DescribeApplication operation to find the current application version. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The Input to add. + */ + Input: Input; + } + export interface AddApplicationInputResponse { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationARN?: ResourceARN; + /** + * Provides the current application version. + */ + ApplicationVersionId?: ApplicationVersionId; + /** + * Describes the application input configuration. + */ + InputDescriptions?: InputDescriptions; + } + export interface AddApplicationOutputRequest { + /** + * The name of the application to which you want to add the output configuration. + */ + ApplicationName: ApplicationName; + /** + * The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination. + */ + Output: Output; + } + export interface AddApplicationOutputResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationARN?: ResourceARN; + /** + * The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated. + */ + ApplicationVersionId?: ApplicationVersionId; + /** + * Describes the application output configuration. For more information, see Configuring Application Output. + */ + OutputDescriptions?: OutputDescriptions; + } + export interface AddApplicationReferenceDataSourceRequest { + /** + * The name of an existing application. + */ + ApplicationName: ApplicationName; + /** + * The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. + */ + ReferenceDataSource: ReferenceDataSource; + } + export interface AddApplicationReferenceDataSourceResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationARN?: ResourceARN; + /** + * The updated application version ID. Amazon Kinesis Data Analytics increments this ID when the application is updated. + */ + ApplicationVersionId?: ApplicationVersionId; + /** + * Describes reference data sources configured for the application. + */ + ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions; + } + export interface ApplicationCodeConfiguration { + /** + * The location and type of the application code. + */ + CodeContent?: CodeContent; + /** + * Specifies whether the code content is in text or zip format. + */ + CodeContentType: CodeContentType; + } + export interface ApplicationCodeConfigurationDescription { + /** + * Specifies whether the code content is in text or zip format. + */ + CodeContentType: CodeContentType; + /** + * Describes details about the location and format of the application code. + */ + CodeContentDescription?: CodeContentDescription; + } + export interface ApplicationCodeConfigurationUpdate { + /** + * Describes updates to the code content type. + */ + CodeContentTypeUpdate?: CodeContentType; + /** + * Describes updates to the code content of an application. + */ + CodeContentUpdate?: CodeContentUpdate; + } + export interface ApplicationConfiguration { + /** + * The creation and update parameters for an SQL-based Kinesis Data Analytics application. + */ + SqlApplicationConfiguration?: SqlApplicationConfiguration; + /** + * The creation and update parameters for a Java-based Kinesis Data Analytics application. + */ + FlinkApplicationConfiguration?: FlinkApplicationConfiguration; + /** + * Describes execution properties for a Java-based Kinesis Data Analytics application. + */ + EnvironmentProperties?: EnvironmentProperties; + /** + * The code location and type parameters for a Java-based Kinesis Data Analytics application. + */ + ApplicationCodeConfiguration: ApplicationCodeConfiguration; + /** + * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + */ + ApplicationSnapshotConfiguration?: ApplicationSnapshotConfiguration; + } + export interface ApplicationConfigurationDescription { + /** + * The details about inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application. + */ + SqlApplicationConfigurationDescription?: SqlApplicationConfigurationDescription; + /** + * The details about the application code for a Java-based Kinesis Data Analytics application. + */ + ApplicationCodeConfigurationDescription?: ApplicationCodeConfigurationDescription; + /** + * The details about the starting properties for a Kinesis Data Analytics application. + */ + RunConfigurationDescription?: RunConfigurationDescription; + /** + * The details about a Java-based Kinesis Data Analytics application. + */ + FlinkApplicationConfigurationDescription?: FlinkApplicationConfigurationDescription; + /** + * Describes execution properties for a Java-based Kinesis Data Analytics application. + */ + EnvironmentPropertyDescriptions?: EnvironmentPropertyDescriptions; + /** + * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + */ + ApplicationSnapshotConfigurationDescription?: ApplicationSnapshotConfigurationDescription; + } + export interface ApplicationConfigurationUpdate { + /** + * Describes updates to an SQL-based Kinesis Data Analytics application's configuration. + */ + SqlApplicationConfigurationUpdate?: SqlApplicationConfigurationUpdate; + /** + * Describes updates to a Java-based Kinesis Data Analytics application's code configuration. + */ + ApplicationCodeConfigurationUpdate?: ApplicationCodeConfigurationUpdate; + /** + * Describes updates to a Java-based Kinesis Data Analytics application's configuration. + */ + FlinkApplicationConfigurationUpdate?: FlinkApplicationConfigurationUpdate; + /** + * Describes updates to the environment properties for a Java-based Kinesis Data Analytics application. + */ + EnvironmentPropertyUpdates?: EnvironmentPropertyUpdates; + /** + * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + */ + ApplicationSnapshotConfigurationUpdate?: ApplicationSnapshotConfigurationUpdate; + } + export type ApplicationDescription = string; + export interface ApplicationDetail { + /** + * The ARN of the application. + */ + ApplicationARN: ResourceARN; + /** + * The description of the application. + */ + ApplicationDescription?: ApplicationDescription; + /** + * The name of the application. + */ + ApplicationName: ApplicationName; + /** + * The runtime environment for the application (SQL-1.0 or JAVA-8-FLINK-1.5). + */ + RuntimeEnvironment: RuntimeEnvironment; + /** + * Specifies the IAM role that the application uses to access external resources. + */ + ServiceExecutionRole?: RoleARN; + /** + * The status of the application. + */ + ApplicationStatus: ApplicationStatus; + /** + * Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application. + */ + ApplicationVersionId: ApplicationVersionId; + /** + * The current timestamp when the application was created. + */ + CreateTimestamp?: Timestamp; + /** + * The current timestamp when the application was last updated. + */ + LastUpdateTimestamp?: Timestamp; + /** + * Provides details about the application's SQL or Java code and starting parameters. + */ + ApplicationConfigurationDescription?: ApplicationConfigurationDescription; + /** + * Describes the application Amazon CloudWatch logging options. + */ + CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions; + } + export type ApplicationName = string; + export interface ApplicationRestoreConfiguration { + /** + * Specifies how the application should be restored. + */ + ApplicationRestoreType: ApplicationRestoreType; + /** + * The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType. + */ + SnapshotName?: SnapshotName; + } + export type ApplicationRestoreType = "SKIP_RESTORE_FROM_SNAPSHOT"|"RESTORE_FROM_LATEST_SNAPSHOT"|"RESTORE_FROM_CUSTOM_SNAPSHOT"|string; + export interface ApplicationSnapshotConfiguration { + /** + * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + */ + SnapshotsEnabled: BooleanObject; + } + export interface ApplicationSnapshotConfigurationDescription { + /** + * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + */ + SnapshotsEnabled: BooleanObject; + } + export interface ApplicationSnapshotConfigurationUpdate { + /** + * Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application. + */ + SnapshotsEnabledUpdate: BooleanObject; + } + export type ApplicationStatus = "DELETING"|"STARTING"|"STOPPING"|"READY"|"RUNNING"|"UPDATING"|string; + export type ApplicationSummaries = ApplicationSummary[]; + export interface ApplicationSummary { + /** + * The name of the application. + */ + ApplicationName: ApplicationName; + /** + * The ARN of the application. + */ + ApplicationARN: ResourceARN; + /** + * The status of the application. + */ + ApplicationStatus: ApplicationStatus; + /** + * Provides the current application version. + */ + ApplicationVersionId: ApplicationVersionId; + /** + * The runtime environment for the application (SQL-1.0 or JAVA-8-FLINK-1.5). + */ + RuntimeEnvironment: RuntimeEnvironment; + } + export type ApplicationVersionId = number; + export type BooleanObject = boolean; + export type BucketARN = string; + export interface CSVMappingParameters { + /** + * The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter. + */ + RecordRowDelimiter: RecordRowDelimiter; + /** + * The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter. + */ + RecordColumnDelimiter: RecordColumnDelimiter; + } + export interface CheckpointConfiguration { + /** + * Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior. + */ + ConfigurationType: ConfigurationType; + /** + * Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application. + */ + CheckpointingEnabled?: BooleanObject; + /** + * Describes the interval in milliseconds between checkpoint operations. + */ + CheckpointInterval?: CheckpointInterval; + /** + * Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation. + */ + MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints; + } + export interface CheckpointConfigurationDescription { + /** + * Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics. + */ + ConfigurationType?: ConfigurationType; + /** + * Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application. + */ + CheckpointingEnabled?: BooleanObject; + /** + * Describes the interval in milliseconds between checkpoint operations. + */ + CheckpointInterval?: CheckpointInterval; + /** + * Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. + */ + MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints; + } + export interface CheckpointConfigurationUpdate { + /** + * Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. + */ + ConfigurationTypeUpdate?: ConfigurationType; + /** + * Describes updates to whether checkpointing is enabled for an application. + */ + CheckpointingEnabledUpdate?: BooleanObject; + /** + * Describes updates to the interval in milliseconds between checkpoint operations. + */ + CheckpointIntervalUpdate?: CheckpointInterval; + /** + * Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. + */ + MinPauseBetweenCheckpointsUpdate?: MinPauseBetweenCheckpoints; + } + export type CheckpointInterval = number; + export interface CloudWatchLoggingOption { + /** + * The ARN of the CloudWatch log to receive application messages. + */ + LogStreamARN: LogStreamARN; + } + export interface CloudWatchLoggingOptionDescription { + /** + * The ID of the CloudWatch logging option description. + */ + CloudWatchLoggingOptionId?: Id; + /** + * The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages. + */ + LogStreamARN: LogStreamARN; + /** + * The IAM ARN of the role to use to send application messages. Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role. + */ + RoleARN?: RoleARN; + } + export type CloudWatchLoggingOptionDescriptions = CloudWatchLoggingOptionDescription[]; + export interface CloudWatchLoggingOptionUpdate { + /** + * The ID of the CloudWatch logging option to update + */ + CloudWatchLoggingOptionId: Id; + /** + * The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages. + */ + LogStreamARNUpdate?: LogStreamARN; + } + export type CloudWatchLoggingOptionUpdates = CloudWatchLoggingOptionUpdate[]; + export type CloudWatchLoggingOptions = CloudWatchLoggingOption[]; + export interface CodeContent { + /** + * The text-format code for a Java-based Kinesis Data Analytics application. + */ + TextContent?: TextContent; + /** + * The zip-format code for a Java-based Kinesis Data Analytics application. + */ + ZipFileContent?: ZipFileContent; + /** + * Information about the Amazon S3 bucket containing the application code. + */ + S3ContentLocation?: S3ContentLocation; + } + export interface CodeContentDescription { + /** + * The text-format code + */ + TextContent?: TextContent; + /** + * The checksum that can be used to validate zip-format code. + */ + CodeMD5?: CodeMD5; + /** + * The size in bytes of the application code. Can be used to validate zip-format code. + */ + CodeSize?: CodeSize; + /** + * The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3. + */ + S3ApplicationCodeLocationDescription?: S3ApplicationCodeLocationDescription; + } + export type CodeContentType = "PLAINTEXT"|"ZIPFILE"|string; + export interface CodeContentUpdate { + /** + * Describes an update to the text code for an application. + */ + TextContentUpdate?: TextContent; + /** + * Describes an update to the zipped code for an application. + */ + ZipFileContentUpdate?: ZipFileContent; + /** + * Describes an update to the location of code for an application. + */ + S3ContentLocationUpdate?: S3ContentLocationUpdate; + } + export type CodeMD5 = string; + export type CodeSize = number; + export type ConfigurationType = "DEFAULT"|"CUSTOM"|string; + export interface CreateApplicationRequest { + /** + * The name of your application (for example, sample-app). + */ + ApplicationName: ApplicationName; + /** + * A summary description of the application. + */ + ApplicationDescription?: ApplicationDescription; + /** + * The runtime environment for the application (SQL-1.0 or JAVA-8-FLINK-1.5). + */ + RuntimeEnvironment: RuntimeEnvironment; + /** + * The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources. + */ + ServiceExecutionRole: RoleARN; + /** + * Use this parameter to configure the application. + */ + ApplicationConfiguration?: ApplicationConfiguration; + /** + * Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors. + */ + CloudWatchLoggingOptions?: CloudWatchLoggingOptions; + } + export interface CreateApplicationResponse { + /** + * In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created. + */ + ApplicationDetail: ApplicationDetail; + } + export interface CreateApplicationSnapshotRequest { + /** + * The name of an existing application + */ + ApplicationName: ApplicationName; + /** + * An identifier for the application snapshot. + */ + SnapshotName: SnapshotName; + } + export interface CreateApplicationSnapshotResponse { + } + export interface DeleteApplicationCloudWatchLoggingOptionRequest { + /** + * The application name. + */ + ApplicationName: ApplicationName; + /** + * The version ID of the application. You can retrieve the application version ID using DescribeApplication. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation. + */ + CloudWatchLoggingOptionId: Id; + } + export interface DeleteApplicationCloudWatchLoggingOptionResponse { + /** + * The application's Amazon Resource Name (ARN). + */ + ApplicationARN?: ResourceARN; + /** + * The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options. + */ + ApplicationVersionId?: ApplicationVersionId; + /** + * The descriptions of the remaining CloudWatch logging options for the application. + */ + CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions; + } + export interface DeleteApplicationInputProcessingConfigurationRequest { + /** + * The name of the application. + */ + ApplicationName: ApplicationName; + /** + * The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation. + */ + InputId: Id; + } + export interface DeleteApplicationInputProcessingConfigurationResponse { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationARN?: ResourceARN; + /** + * The current application version ID. + */ + ApplicationVersionId?: ApplicationVersionId; + } + export interface DeleteApplicationOutputRequest { + /** + * The application name. + */ + ApplicationName: ApplicationName; + /** + * The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId. + */ + OutputId: Id; + } + export interface DeleteApplicationOutputResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationARN?: ResourceARN; + /** + * The current application version ID. + */ + ApplicationVersionId?: ApplicationVersionId; + } + export interface DeleteApplicationReferenceDataSourceRequest { + /** + * The name of an existing application. + */ + ApplicationName: ApplicationName; + /** + * The current application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID. + */ + ReferenceId: Id; + } + export interface DeleteApplicationReferenceDataSourceResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationARN?: ResourceARN; + /** + * The updated version ID of the application. + */ + ApplicationVersionId?: ApplicationVersionId; + } + export interface DeleteApplicationRequest { + /** + * The name of the application to delete. + */ + ApplicationName: ApplicationName; + /** + * Use the DescribeApplication operation to get this value. + */ + CreateTimestamp: Timestamp; + } + export interface DeleteApplicationResponse { + } + export interface DeleteApplicationSnapshotRequest { + /** + * The name of an existing application. + */ + ApplicationName: ApplicationName; + /** + * The identifier for the snapshot delete. + */ + SnapshotName: SnapshotName; + /** + * The creation timestamp of the application snapshot to delete. You can retrieve this value using or . + */ + SnapshotCreationTimestamp: Timestamp; + } + export interface DeleteApplicationSnapshotResponse { + } + export interface DescribeApplicationRequest { + /** + * The name of the application. + */ + ApplicationName: ApplicationName; + /** + * Displays verbose information about a Kinesis Data Analytics application, including the application's job plan. + */ + IncludeAdditionalDetails?: BooleanObject; + } + export interface DescribeApplicationResponse { + /** + * Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version. + */ + ApplicationDetail: ApplicationDetail; + } + export interface DescribeApplicationSnapshotRequest { + /** + * The name of an existing application. + */ + ApplicationName: ApplicationName; + /** + * The identifier of an application snapshot. You can retrieve this value using . + */ + SnapshotName: SnapshotName; + } + export interface DescribeApplicationSnapshotResponse { + /** + * An object containing information about the application snapshot. + */ + SnapshotDetails: SnapshotDetails; + } + export interface DestinationSchema { + /** + * Specifies the format of the records on the output stream. + */ + RecordFormatType: RecordFormatType; + } + export interface DiscoverInputSchemaRequest { + /** + * The Amazon Resource Name (ARN) of the streaming source. + */ + ResourceARN?: ResourceARN; + /** + * The ARN of the role that is used to access the streaming source. + */ + ServiceExecutionRole: RoleARN; + /** + * The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes. + */ + InputStartingPositionConfiguration?: InputStartingPositionConfiguration; + /** + * Specify this parameter to discover a schema from data in an Amazon S3 object. + */ + S3Configuration?: S3Configuration; + /** + * The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records. + */ + InputProcessingConfiguration?: InputProcessingConfiguration; + } + export interface DiscoverInputSchemaResponse { + /** + * The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create. + */ + InputSchema?: SourceSchema; + /** + * An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row). + */ + ParsedInputRecords?: ParsedInputRecords; + /** + * The stream data that was modified by the processor specified in the InputProcessingConfiguration parameter. + */ + ProcessedInputRecords?: ProcessedInputRecords; + /** + * The raw stream data that was sampled to infer the schema. + */ + RawInputRecords?: RawInputRecords; + } + export interface EnvironmentProperties { + /** + * Describes the execution property groups. + */ + PropertyGroups: PropertyGroups; + } + export interface EnvironmentPropertyDescriptions { + /** + * Describes the execution property groups. + */ + PropertyGroupDescriptions?: PropertyGroups; + } + export interface EnvironmentPropertyUpdates { + /** + * Describes updates to the execution property groups. + */ + PropertyGroups: PropertyGroups; + } + export type FileKey = string; + export interface FlinkApplicationConfiguration { + /** + * Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation. + */ + CheckpointConfiguration?: CheckpointConfiguration; + /** + * Describes configuration parameters for Amazon CloudWatch logging for an application. + */ + MonitoringConfiguration?: MonitoringConfiguration; + /** + * Describes parameters for how an application executes multiple tasks simultaneously. + */ + ParallelismConfiguration?: ParallelismConfiguration; + } + export interface FlinkApplicationConfigurationDescription { + /** + * Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. + */ + CheckpointConfigurationDescription?: CheckpointConfigurationDescription; + /** + * Describes configuration parameters for Amazon CloudWatch logging for an application. + */ + MonitoringConfigurationDescription?: MonitoringConfigurationDescription; + /** + * Describes parameters for how an application executes multiple tasks simultaneously. + */ + ParallelismConfigurationDescription?: ParallelismConfigurationDescription; + /** + * The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation. + */ + JobPlanDescription?: JobPlanDescription; + } + export interface FlinkApplicationConfigurationUpdate { + /** + * Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. + */ + CheckpointConfigurationUpdate?: CheckpointConfigurationUpdate; + /** + * Describes updates to the configuration parameters for Amazon CloudWatch logging for an application. + */ + MonitoringConfigurationUpdate?: MonitoringConfigurationUpdate; + /** + * Describes updates to the parameters for how an application executes multiple tasks simultaneously. + */ + ParallelismConfigurationUpdate?: ParallelismConfigurationUpdate; + } + export type Id = string; + export type InAppStreamName = string; + export type InAppStreamNames = InAppStreamName[]; + export type InAppTableName = string; + export interface Input { + /** + * The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. + */ + NamePrefix: InAppStreamName; + /** + * The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor. + */ + InputProcessingConfiguration?: InputProcessingConfiguration; + /** + * If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN). + */ + KinesisStreamsInput?: KinesisStreamsInput; + /** + * If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN. + */ + KinesisFirehoseInput?: KinesisFirehoseInput; + /** + * Describes the number of in-application streams to create. + */ + InputParallelism?: InputParallelism; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. Also used to describe the format of the reference data source. + */ + InputSchema: SourceSchema; + } + export interface InputDescription { + /** + * The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application. + */ + InputId?: Id; + /** + * The in-application name prefix. + */ + NamePrefix?: InAppStreamName; + /** + * Returns the in-application stream names that are mapped to the stream source. + */ + InAppStreamNames?: InAppStreamNames; + /** + * The description of the preprocessor that executes on records in this input before the application's code is run. + */ + InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription; + /** + * If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN). + */ + KinesisStreamsInputDescription?: KinesisStreamsInputDescription; + /** + * If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN. + */ + KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. + */ + InputSchema?: SourceSchema; + /** + * Describes the configured parallelism (number of in-application streams mapped to the streaming source). + */ + InputParallelism?: InputParallelism; + /** + * The point at which the application is configured to read from the input stream. + */ + InputStartingPositionConfiguration?: InputStartingPositionConfiguration; + } + export type InputDescriptions = InputDescription[]; + export interface InputLambdaProcessor { + /** + * The ARN of the AWS Lambda function that operates on records in the stream. + */ + ResourceARN: ResourceARN; + } + export interface InputLambdaProcessorDescription { + /** + * The ARN of the AWS Lambda function that is used to preprocess the records in the stream. + */ + ResourceARN: ResourceARN; + /** + * The ARN of the IAM role that is used to access the AWS Lambda function. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role. + */ + RoleARN?: RoleARN; + } + export interface InputLambdaProcessorUpdate { + /** + * The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream. + */ + ResourceARNUpdate: ResourceARN; + } + export interface InputParallelism { + /** + * The number of in-application streams to create. + */ + Count?: InputParallelismCount; + } + export type InputParallelismCount = number; + export interface InputParallelismUpdate { + /** + * The number of in-application streams to create for the specified streaming source. + */ + CountUpdate: InputParallelismCount; + } + export interface InputProcessingConfiguration { + /** + * The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code. + */ + InputLambdaProcessor: InputLambdaProcessor; + } + export interface InputProcessingConfigurationDescription { + /** + * Provides configuration information about the associated InputLambdaProcessorDescription + */ + InputLambdaProcessorDescription?: InputLambdaProcessorDescription; + } + export interface InputProcessingConfigurationUpdate { + /** + * Provides update information for an InputLambdaProcessor. + */ + InputLambdaProcessorUpdate: InputLambdaProcessorUpdate; + } + export interface InputSchemaUpdate { + /** + * Specifies the format of the records on the streaming source. + */ + RecordFormatUpdate?: RecordFormat; + /** + * Specifies the encoding of the records in the streaming source; for example, UTF-8. + */ + RecordEncodingUpdate?: RecordEncoding; + /** + * A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream. + */ + RecordColumnUpdates?: RecordColumns; + } + export type InputStartingPosition = "NOW"|"TRIM_HORIZON"|"LAST_STOPPED_POINT"|string; + export interface InputStartingPositionConfiguration { + /** + * The starting position on the stream. NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued. TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream. LAST_STOPPED_POINT - Resume reading from where the application last stopped reading. + */ + InputStartingPosition?: InputStartingPosition; + } + export interface InputUpdate { + /** + * The input ID of the application input to be updated. + */ + InputId: Id; + /** + * The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source. + */ + NamePrefixUpdate?: InAppStreamName; + /** + * Describes updates to an InputProcessingConfiguration. + */ + InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate; + /** + * If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN). + */ + KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate; + /** + * If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN. + */ + KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate; + /** + * Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created. + */ + InputSchemaUpdate?: InputSchemaUpdate; + /** + * Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source). + */ + InputParallelismUpdate?: InputParallelismUpdate; + } + export type InputUpdates = InputUpdate[]; + export type Inputs = Input[]; + export interface JSONMappingParameters { + /** + * The path to the top-level parent that contains the records. + */ + RecordRowPath: RecordRowPath; + } + export type JobPlanDescription = string; + export interface KinesisFirehoseInput { + /** + * The Amazon Resource Name (ARN) of the delivery stream. + */ + ResourceARN: ResourceARN; + } + export interface KinesisFirehoseInputDescription { + /** + * The Amazon Resource Name (ARN) of the delivery stream. + */ + ResourceARN: ResourceARN; + /** + * The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role. + */ + RoleARN?: RoleARN; + } + export interface KinesisFirehoseInputUpdate { + /** + * The Amazon Resource Name (ARN) of the input delivery stream to read. + */ + ResourceARNUpdate: ResourceARN; + } + export interface KinesisFirehoseOutput { + /** + * The ARN of the destination delivery stream to write to. + */ + ResourceARN: ResourceARN; + } + export interface KinesisFirehoseOutputDescription { + /** + * The Amazon Resource Name (ARN) of the delivery stream. + */ + ResourceARN: ResourceARN; + /** + * The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role. + */ + RoleARN?: RoleARN; + } + export interface KinesisFirehoseOutputUpdate { + /** + * The Amazon Resource Name (ARN) of the delivery stream to write to. + */ + ResourceARNUpdate: ResourceARN; + } + export interface KinesisStreamsInput { + /** + * The ARN of the input Kinesis data stream to read. + */ + ResourceARN: ResourceARN; + } + export interface KinesisStreamsInputDescription { + /** + * The Amazon Resource Name (ARN) of the Kinesis data stream. + */ + ResourceARN: ResourceARN; + /** + * The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role. + */ + RoleARN?: RoleARN; + } + export interface KinesisStreamsInputUpdate { + /** + * The Amazon Resource Name (ARN) of the input Kinesis data stream to read. + */ + ResourceARNUpdate: ResourceARN; + } + export interface KinesisStreamsOutput { + /** + * The ARN of the destination Kinesis data stream to write to. + */ + ResourceARN: ResourceARN; + } + export interface KinesisStreamsOutputDescription { + /** + * The Amazon Resource Name (ARN) of the Kinesis data stream. + */ + ResourceARN: ResourceARN; + /** + * The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role. + */ + RoleARN?: RoleARN; + } + export interface KinesisStreamsOutputUpdate { + /** + * The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output. + */ + ResourceARNUpdate: ResourceARN; + } + export interface LambdaOutput { + /** + * The Amazon Resource Name (ARN) of the destination Lambda function to write to. + */ + ResourceARN: ResourceARN; + } + export interface LambdaOutputDescription { + /** + * The Amazon Resource Name (ARN) of the destination Lambda function. + */ + ResourceARN: ResourceARN; + /** + * The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role. + */ + RoleARN?: RoleARN; + } + export interface LambdaOutputUpdate { + /** + * The Amazon Resource Name (ARN) of the destination AWS Lambda function. + */ + ResourceARNUpdate: ResourceARN; + } + export interface ListApplicationSnapshotsRequest { + /** + * The name of an existing application. + */ + ApplicationName: ApplicationName; + /** + * The maximum number of application snapshots to list. + */ + Limit?: ListSnapshotsInputLimit; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + } + export interface ListApplicationSnapshotsResponse { + /** + * A collection of objects containing information about the application snapshots. + */ + SnapshotSummaries?: SnapshotSummaries; + /** + * The token for the next set of results, or null if there are no additional results. + */ + NextToken?: NextToken; + } + export type ListApplicationsInputLimit = number; + export interface ListApplicationsRequest { + /** + * The maximum number of applications to list. + */ + Limit?: ListApplicationsInputLimit; + /** + * If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the AWS Command Line Interface's Pagination Options. + */ + NextToken?: ApplicationName; + } + export interface ListApplicationsResponse { + /** + * A list of ApplicationSummary objects. + */ + ApplicationSummaries: ApplicationSummaries; + /** + * The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the AWS Command Line Interface's Pagination Options. + */ + NextToken?: ApplicationName; + } + export type ListSnapshotsInputLimit = number; + export type LogLevel = "INFO"|"WARN"|"ERROR"|"DEBUG"|string; + export type LogStreamARN = string; + export interface MappingParameters { + /** + * Provides additional mapping information when JSON is the record format on the streaming source. + */ + JSONMappingParameters?: JSONMappingParameters; + /** + * Provides additional mapping information when the record format uses delimiters (for example, CSV). + */ + CSVMappingParameters?: CSVMappingParameters; + } + export type MetricsLevel = "APPLICATION"|"TASK"|"OPERATOR"|"PARALLELISM"|string; + export type MinPauseBetweenCheckpoints = number; + export interface MonitoringConfiguration { + /** + * Describes whether to use the default CloudWatch logging configuration for an application. + */ + ConfigurationType: ConfigurationType; + /** + * Describes the granularity of the CloudWatch Logs for an application. + */ + MetricsLevel?: MetricsLevel; + /** + * Describes the verbosity of the CloudWatch Logs for an application. + */ + LogLevel?: LogLevel; + } + export interface MonitoringConfigurationDescription { + /** + * Describes whether to use the default CloudWatch logging configuration for an application. + */ + ConfigurationType?: ConfigurationType; + /** + * Describes the granularity of the CloudWatch Logs for an application. + */ + MetricsLevel?: MetricsLevel; + /** + * Describes the verbosity of the CloudWatch Logs for an application. + */ + LogLevel?: LogLevel; + } + export interface MonitoringConfigurationUpdate { + /** + * Describes updates to whether to use the default CloudWatch logging configuration for an application. + */ + ConfigurationTypeUpdate?: ConfigurationType; + /** + * Describes updates to the granularity of the CloudWatch Logs for an application. + */ + MetricsLevelUpdate?: MetricsLevel; + /** + * Describes updates to the verbosity of the CloudWatch Logs for an application. + */ + LogLevelUpdate?: LogLevel; + } + export type NextToken = string; + export type ObjectVersion = string; + export interface Output { + /** + * The name of the in-application stream. + */ + Name: InAppStreamName; + /** + * Identifies an Amazon Kinesis data stream as the destination. + */ + KinesisStreamsOutput?: KinesisStreamsOutput; + /** + * Identifies an Amazon Kinesis Data Firehose delivery stream as the destination. + */ + KinesisFirehoseOutput?: KinesisFirehoseOutput; + /** + * Identifies an AWS Lambda function as the destination. + */ + LambdaOutput?: LambdaOutput; + /** + * Describes the data format when records are written to the destination. + */ + DestinationSchema: DestinationSchema; + } + export interface OutputDescription { + /** + * A unique identifier for the output configuration. + */ + OutputId?: Id; + /** + * The name of the in-application stream that is configured as output. + */ + Name?: InAppStreamName; + /** + * Describes the Kinesis data stream that is configured as the destination where output is written. + */ + KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription; + /** + * Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written. + */ + KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription; + /** + * Describes the Lambda function that is configured as the destination where output is written. + */ + LambdaOutputDescription?: LambdaOutputDescription; + /** + * The data format used for writing data to the destination. + */ + DestinationSchema?: DestinationSchema; + } + export type OutputDescriptions = OutputDescription[]; + export interface OutputUpdate { + /** + * Identifies the specific output configuration that you want to update. + */ + OutputId: Id; + /** + * If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name. + */ + NameUpdate?: InAppStreamName; + /** + * Describes a Kinesis data stream as the destination for the output. + */ + KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate; + /** + * Describes a Kinesis Data Firehose delivery stream as the destination for the output. + */ + KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate; + /** + * Describes an AWS Lambda function as the destination for the output. + */ + LambdaOutputUpdate?: LambdaOutputUpdate; + /** + * Describes the data format when records are written to the destination. + */ + DestinationSchemaUpdate?: DestinationSchema; + } + export type OutputUpdates = OutputUpdate[]; + export type Outputs = Output[]; + export type Parallelism = number; + export interface ParallelismConfiguration { + /** + * Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. + */ + ConfigurationType: ConfigurationType; + /** + * Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration$AutoScalingEnabled is set to true. + */ + Parallelism?: Parallelism; + /** + * Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing. + */ + ParallelismPerKPU?: ParallelismPerKPU; + /** + * Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput. + */ + AutoScalingEnabled?: BooleanObject; + } + export interface ParallelismConfigurationDescription { + /** + * Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. + */ + ConfigurationType?: ConfigurationType; + /** + * Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. + */ + Parallelism?: Parallelism; + /** + * Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. + */ + ParallelismPerKPU?: ParallelismPerKPU; + /** + * Describes the current number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. + */ + CurrentParallelism?: Parallelism; + /** + * Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput. + */ + AutoScalingEnabled?: BooleanObject; + } + export interface ParallelismConfigurationUpdate { + /** + * Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. + */ + ConfigurationTypeUpdate?: ConfigurationType; + /** + * Describes updates to the initial number of parallel tasks an application can perform. + */ + ParallelismUpdate?: Parallelism; + /** + * Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application. + */ + ParallelismPerKPUUpdate?: ParallelismPerKPU; + /** + * Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput. + */ + AutoScalingEnabledUpdate?: BooleanObject; + } + export type ParallelismPerKPU = number; + export type ParsedInputRecord = ParsedInputRecordField[]; + export type ParsedInputRecordField = string; + export type ParsedInputRecords = ParsedInputRecord[]; + export type ProcessedInputRecord = string; + export type ProcessedInputRecords = ProcessedInputRecord[]; + export interface PropertyGroup { + /** + * Describes the key of an application execution property key-value pair. + */ + PropertyGroupId: Id; + /** + * Describes the value of an application execution property key-value pair. + */ + PropertyMap: PropertyMap; + } + export type PropertyGroups = PropertyGroup[]; + export type PropertyKey = string; + export type PropertyMap = {[key: string]: PropertyValue}; + export type PropertyValue = string; + export type RawInputRecord = string; + export type RawInputRecords = RawInputRecord[]; + export interface RecordColumn { + /** + * The name of the column that is created in the in-application input stream or reference table. + */ + Name: RecordColumnName; + /** + * A reference to the data element in the streaming input of the reference data source. + */ + Mapping?: RecordColumnMapping; + /** + * The type of column created in the in-application input stream or reference table. + */ + SqlType: RecordColumnSqlType; + } + export type RecordColumnDelimiter = string; + export type RecordColumnMapping = string; + export type RecordColumnName = string; + export type RecordColumnSqlType = string; + export type RecordColumns = RecordColumn[]; + export type RecordEncoding = string; + export interface RecordFormat { + /** + * The type of record format. + */ + RecordFormatType: RecordFormatType; + /** + * When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source. + */ + MappingParameters?: MappingParameters; + } + export type RecordFormatType = "JSON"|"CSV"|string; + export type RecordRowDelimiter = string; + export type RecordRowPath = string; + export interface ReferenceDataSource { + /** + * The name of the in-application table to create. + */ + TableName: InAppTableName; + /** + * Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application. + */ + S3ReferenceDataSource?: S3ReferenceDataSource; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + */ + ReferenceSchema: SourceSchema; + } + export interface ReferenceDataSourceDescription { + /** + * The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation. + */ + ReferenceId: Id; + /** + * The in-application table name created by the specific reference data source configuration. + */ + TableName: InAppTableName; + /** + * Provides the Amazon S3 bucket name, the object key name that contains the reference data. + */ + S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + */ + ReferenceSchema?: SourceSchema; + } + export type ReferenceDataSourceDescriptions = ReferenceDataSourceDescription[]; + export interface ReferenceDataSourceUpdate { + /** + * The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value. + */ + ReferenceId: Id; + /** + * The in-application table name that is created by this update. + */ + TableNameUpdate?: InAppTableName; + /** + * Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table. + */ + S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate; + /** + * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. + */ + ReferenceSchemaUpdate?: SourceSchema; + } + export type ReferenceDataSourceUpdates = ReferenceDataSourceUpdate[]; + export type ReferenceDataSources = ReferenceDataSource[]; + export type ResourceARN = string; + export type RoleARN = string; + export interface RunConfiguration { + /** + * Describes the starting parameters for an SQL-based Kinesis Data Analytics application. + */ + SqlRunConfigurations?: SqlRunConfigurations; + /** + * Describes the restore behavior of a restarting application. + */ + ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration; + } + export interface RunConfigurationDescription { + /** + * Describes the restore behavior of a restarting application. + */ + ApplicationRestoreConfigurationDescription?: ApplicationRestoreConfiguration; + } + export interface RunConfigurationUpdate { + /** + * Describes updates to the restore behavior of a restarting application. + */ + ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration; + } + export type RuntimeEnvironment = "SQL-1_0"|"FLINK-1_6"|string; + export interface S3ApplicationCodeLocationDescription { + /** + * The Amazon Resource Name (ARN) for the S3 bucket containing the application code. + */ + BucketARN: BucketARN; + /** + * The file key for the object containing the application code. + */ + FileKey: FileKey; + /** + * The version of the object containing the application code. + */ + ObjectVersion?: ObjectVersion; + } + export interface S3Configuration { + /** + * The ARN of the S3 bucket that contains the data. + */ + BucketARN: BucketARN; + /** + * The name of the object that contains the data. + */ + FileKey: FileKey; + } + export interface S3ContentLocation { + /** + * The Amazon Resource Name (ARN) for the S3 bucket containing the application code. + */ + BucketARN: BucketARN; + /** + * The file key for the object containing the application code. + */ + FileKey: FileKey; + /** + * The version of the object containing the application code. + */ + ObjectVersion?: ObjectVersion; + } + export interface S3ContentLocationUpdate { + /** + * The new Amazon Resource Name (ARN) for the S3 bucket containing the application code. + */ + BucketARNUpdate?: BucketARN; + /** + * The new file key for the object containing the application code. + */ + FileKeyUpdate?: FileKey; + /** + * The new version of the object containing the application code. + */ + ObjectVersionUpdate?: ObjectVersion; + } + export interface S3ReferenceDataSource { + /** + * The Amazon Resource Name (ARN) of the S3 bucket. + */ + BucketARN?: BucketARN; + /** + * The object key name containing the reference data. + */ + FileKey?: FileKey; + } + export interface S3ReferenceDataSourceDescription { + /** + * The Amazon Resource Name (ARN) of the S3 bucket. + */ + BucketARN: BucketARN; + /** + * Amazon S3 object key name. + */ + FileKey: FileKey; + /** + * The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role. + */ + ReferenceRoleARN?: RoleARN; + } + export interface S3ReferenceDataSourceUpdate { + /** + * The Amazon Resource Name (ARN) of the S3 bucket. + */ + BucketARNUpdate?: BucketARN; + /** + * The object key name. + */ + FileKeyUpdate?: FileKey; + } + export interface SnapshotDetails { + /** + * The identifier for the application snapshot. + */ + SnapshotName: SnapshotName; + /** + * The status of the application snapshot. + */ + SnapshotStatus: SnapshotStatus; + /** + * The current application version ID when the snapshot was created. + */ + ApplicationVersionId: ApplicationVersionId; + /** + * The timestamp of the application snapshot. + */ + SnapshotCreationTimestamp?: Timestamp; + } + export type SnapshotName = string; + export type SnapshotStatus = "CREATING"|"READY"|"DELETING"|"FAILED"|string; + export type SnapshotSummaries = SnapshotDetails[]; + export interface SourceSchema { + /** + * Specifies the format of the records on the streaming source. + */ + RecordFormat: RecordFormat; + /** + * Specifies the encoding of the records in the streaming source. For example, UTF-8. + */ + RecordEncoding?: RecordEncoding; + /** + * A list of RecordColumn objects. + */ + RecordColumns: RecordColumns; + } + export interface SqlApplicationConfiguration { + /** + * The array of Input objects describing the input streams used by the application. + */ + Inputs?: Inputs; + /** + * The array of Output objects describing the destination streams used by the application. + */ + Outputs?: Outputs; + /** + * The array of ReferenceDataSource objects describing the reference data sources used by the application. + */ + ReferenceDataSources?: ReferenceDataSources; + } + export interface SqlApplicationConfigurationDescription { + /** + * The array of InputDescription objects describing the input streams used by the application. + */ + InputDescriptions?: InputDescriptions; + /** + * The array of OutputDescription objects describing the destination streams used by the application. + */ + OutputDescriptions?: OutputDescriptions; + /** + * The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application. + */ + ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions; + } + export interface SqlApplicationConfigurationUpdate { + /** + * The array of InputUpdate objects describing the new input streams used by the application. + */ + InputUpdates?: InputUpdates; + /** + * The array of OutputUpdate objects describing the new destination streams used by the application. + */ + OutputUpdates?: OutputUpdates; + /** + * The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application. + */ + ReferenceDataSourceUpdates?: ReferenceDataSourceUpdates; + } + export interface SqlRunConfiguration { + /** + * The input source ID. You can get this ID by calling the DescribeApplication operation. + */ + InputId: Id; + /** + * The point at which you want the application to start processing records from the streaming source. + */ + InputStartingPositionConfiguration: InputStartingPositionConfiguration; + } + export type SqlRunConfigurations = SqlRunConfiguration[]; + export interface StartApplicationRequest { + /** + * The name of the application. + */ + ApplicationName: ApplicationName; + /** + * Identifies the run configuration (start parameters) of a Kinesis Data Analytics application. + */ + RunConfiguration: RunConfiguration; + } + export interface StartApplicationResponse { + } + export interface StopApplicationRequest { + /** + * The name of the running application to stop. + */ + ApplicationName: ApplicationName; + } + export interface StopApplicationResponse { + } + export type TextContent = string; + export type Timestamp = Date; + export interface UpdateApplicationRequest { + /** + * The name of the application to update. + */ + ApplicationName: ApplicationName; + /** + * The current application version ID. You can retrieve the application version ID using DescribeApplication. + */ + CurrentApplicationVersionId: ApplicationVersionId; + /** + * Describes application configuration updates. + */ + ApplicationConfigurationUpdate?: ApplicationConfigurationUpdate; + /** + * Describes updates to the service execution role. + */ + ServiceExecutionRoleUpdate?: RoleARN; + /** + * Describes updates to the application's starting parameters. + */ + RunConfigurationUpdate?: RunConfigurationUpdate; + /** + * Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption. + */ + CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdates; + } + export interface UpdateApplicationResponse { + /** + * Describes application updates. + */ + ApplicationDetail: ApplicationDetail; + } + export type ZipFileContent = Buffer|Uint8Array|Blob|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-05-23"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the KinesisAnalyticsV2 client. + */ + export import Types = KinesisAnalyticsV2; +} +export = KinesisAnalyticsV2; diff --git a/node_modules/aws-sdk/clients/kinesisanalyticsv2.js b/node_modules/aws-sdk/clients/kinesisanalyticsv2.js new file mode 100644 index 0000000..a0fa27d --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisanalyticsv2.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kinesisanalyticsv2'] = {}; +AWS.KinesisAnalyticsV2 = Service.defineService('kinesisanalyticsv2', ['2018-05-23']); +Object.defineProperty(apiLoader.services['kinesisanalyticsv2'], '2018-05-23', { + get: function get() { + var model = require('../apis/kinesisanalyticsv2-2018-05-23.min.json'); + model.paginators = require('../apis/kinesisanalyticsv2-2018-05-23.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.KinesisAnalyticsV2; diff --git a/node_modules/aws-sdk/clients/kinesisvideo.d.ts b/node_modules/aws-sdk/clients/kinesisvideo.d.ts new file mode 100644 index 0000000..34950f2 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisvideo.d.ts @@ -0,0 +1,389 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class KinesisVideo extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: KinesisVideo.Types.ClientConfiguration) + config: Config & KinesisVideo.Types.ClientConfiguration; + /** + * Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream action. + */ + createStream(params: KinesisVideo.Types.CreateStreamInput, callback?: (err: AWSError, data: KinesisVideo.Types.CreateStreamOutput) => void): Request; + /** + * Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream action. + */ + createStream(callback?: (err: AWSError, data: KinesisVideo.Types.CreateStreamOutput) => void): Request; + /** + * Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. This operation requires permission for the KinesisVideo:DeleteStream action. + */ + deleteStream(params: KinesisVideo.Types.DeleteStreamInput, callback?: (err: AWSError, data: KinesisVideo.Types.DeleteStreamOutput) => void): Request; + /** + * Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. This operation requires permission for the KinesisVideo:DeleteStream action. + */ + deleteStream(callback?: (err: AWSError, data: KinesisVideo.Types.DeleteStreamOutput) => void): Request; + /** + * Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN. + */ + describeStream(params: KinesisVideo.Types.DescribeStreamInput, callback?: (err: AWSError, data: KinesisVideo.Types.DescribeStreamOutput) => void): Request; + /** + * Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN. + */ + describeStream(callback?: (err: AWSError, data: KinesisVideo.Types.DescribeStreamOutput) => void): Request; + /** + * Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation). The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. In the request, specify the stream either by StreamName or StreamARN. + */ + getDataEndpoint(params: KinesisVideo.Types.GetDataEndpointInput, callback?: (err: AWSError, data: KinesisVideo.Types.GetDataEndpointOutput) => void): Request; + /** + * Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation). The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. In the request, specify the stream either by StreamName or StreamARN. + */ + getDataEndpoint(callback?: (err: AWSError, data: KinesisVideo.Types.GetDataEndpointOutput) => void): Request; + /** + * Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition. + */ + listStreams(params: KinesisVideo.Types.ListStreamsInput, callback?: (err: AWSError, data: KinesisVideo.Types.ListStreamsOutput) => void): Request; + /** + * Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition. + */ + listStreams(callback?: (err: AWSError, data: KinesisVideo.Types.ListStreamsOutput) => void): Request; + /** + * Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN. + */ + listTagsForStream(params: KinesisVideo.Types.ListTagsForStreamInput, callback?: (err: AWSError, data: KinesisVideo.Types.ListTagsForStreamOutput) => void): Request; + /** + * Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN. + */ + listTagsForStream(callback?: (err: AWSError, data: KinesisVideo.Types.ListTagsForStreamOutput) => void): Request; + /** + * Adds one or more tags to a 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. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. Kinesis video streams support up to 50 tags. + */ + tagStream(params: KinesisVideo.Types.TagStreamInput, callback?: (err: AWSError, data: KinesisVideo.Types.TagStreamOutput) => void): Request; + /** + * Adds one or more tags to a 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. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. Kinesis video streams support up to 50 tags. + */ + tagStream(callback?: (err: AWSError, data: KinesisVideo.Types.TagStreamOutput) => void): Request; + /** + * Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the StreamName or StreamARN. + */ + untagStream(params: KinesisVideo.Types.UntagStreamInput, callback?: (err: AWSError, data: KinesisVideo.Types.UntagStreamOutput) => void): Request; + /** + * Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the StreamName or StreamARN. + */ + untagStream(callback?: (err: AWSError, data: KinesisVideo.Types.UntagStreamOutput) => void): Request; + /** + * Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN. The retention period that you specify replaces the current value. This operation requires permission for the KinesisVideo:UpdateDataRetention action. Changing the data retention period affects the data in the stream as follows: If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours. If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately. + */ + updateDataRetention(params: KinesisVideo.Types.UpdateDataRetentionInput, callback?: (err: AWSError, data: KinesisVideo.Types.UpdateDataRetentionOutput) => void): Request; + /** + * Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN. The retention period that you specify replaces the current value. This operation requires permission for the KinesisVideo:UpdateDataRetention action. Changing the data retention period affects the data in the stream as follows: If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours. If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately. + */ + updateDataRetention(callback?: (err: AWSError, data: KinesisVideo.Types.UpdateDataRetentionOutput) => void): Request; + /** + * Updates stream metadata, such as the device name and media type. You must provide the stream name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. UpdateStream is an asynchronous operation, and takes time to complete. + */ + updateStream(params: KinesisVideo.Types.UpdateStreamInput, callback?: (err: AWSError, data: KinesisVideo.Types.UpdateStreamOutput) => void): Request; + /** + * Updates stream metadata, such as the device name and media type. You must provide the stream name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. UpdateStream is an asynchronous operation, and takes time to complete. + */ + updateStream(callback?: (err: AWSError, data: KinesisVideo.Types.UpdateStreamOutput) => void): Request; +} +declare namespace KinesisVideo { + export type APIName = "PUT_MEDIA"|"GET_MEDIA"|"LIST_FRAGMENTS"|"GET_MEDIA_FOR_FRAGMENT_LIST"|"GET_HLS_STREAMING_SESSION_URL"|string; + export type ComparisonOperator = "BEGINS_WITH"|string; + export interface CreateStreamInput { + /** + * The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name. + */ + DeviceName?: DeviceName; + /** + * A name for the stream that you are creating. The stream name is an identifier for the stream, and must be unique for each account and region. + */ + StreamName: StreamName; + /** + * The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines. This parameter is optional; the default value is null (or empty in JSON). + */ + MediaType?: MediaType; + /** + * The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used. For more information, see DescribeKey. + */ + KmsKeyId?: KmsKeyId; + /** + * The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is 0, indicating that the stream does not persist data. When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached. + */ + DataRetentionInHours?: DataRetentionInHours; + /** + * A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional). + */ + Tags?: ResourceTags; + } + export interface CreateStreamOutput { + /** + * The Amazon Resource Name (ARN) of the stream. + */ + StreamARN?: ResourceARN; + } + export type DataEndpoint = string; + export type DataRetentionChangeInHours = number; + export type DataRetentionInHours = number; + export interface DeleteStreamInput { + /** + * The Amazon Resource Name (ARN) of the stream that you want to delete. + */ + StreamARN: ResourceARN; + /** + * Optional: The version of the stream that you want to delete. Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API. If not specified, only the CreationTime is checked before deleting the stream. + */ + CurrentVersion?: Version; + } + export interface DeleteStreamOutput { + } + export interface DescribeStreamInput { + /** + * The name of the stream. + */ + StreamName?: StreamName; + /** + * The Amazon Resource Name (ARN) of the stream. + */ + StreamARN?: ResourceARN; + } + export interface DescribeStreamOutput { + /** + * An object that describes the stream. + */ + StreamInfo?: StreamInfo; + } + export type DeviceName = string; + export interface GetDataEndpointInput { + /** + * The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request. + */ + StreamName?: StreamName; + /** + * The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request. + */ + StreamARN?: ResourceARN; + /** + * The name of the API action for which to get an endpoint. + */ + APIName: APIName; + } + export interface GetDataEndpointOutput { + /** + * The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application. + */ + DataEndpoint?: DataEndpoint; + } + export type KmsKeyId = string; + export interface ListStreamsInput { + /** + * The maximum number of streams to return in the response. The default is 10,000. + */ + MaxResults?: ListStreamsInputLimit; + /** + * If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request. + */ + NextToken?: NextToken; + /** + * Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition. + */ + StreamNameCondition?: StreamNameCondition; + } + export type ListStreamsInputLimit = number; + export interface ListStreamsOutput { + /** + * An array of StreamInfo objects. + */ + StreamInfoList?: StreamInfoList; + /** + * If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request. + */ + NextToken?: NextToken; + } + export interface ListTagsForStreamInput { + /** + * If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags. + */ + NextToken?: NextToken; + /** + * The Amazon Resource Name (ARN) of the stream that you want to list tags for. + */ + StreamARN?: ResourceARN; + /** + * The name of the stream that you want to list tags for. + */ + StreamName?: StreamName; + } + export interface ListTagsForStreamOutput { + /** + * If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags. + */ + NextToken?: NextToken; + /** + * A map of tag keys and values associated with the specified stream. + */ + Tags?: ResourceTags; + } + export type MediaType = string; + export type NextToken = string; + export type ResourceARN = string; + export type ResourceTags = {[key: string]: TagValue}; + export type Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|string; + export interface StreamInfo { + /** + * The name of the device that is associated with the stream. + */ + DeviceName?: DeviceName; + /** + * The name of the stream. + */ + StreamName?: StreamName; + /** + * The Amazon Resource Name (ARN) of the stream. + */ + StreamARN?: ResourceARN; + /** + * The MediaType of the stream. + */ + MediaType?: MediaType; + /** + * The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream. + */ + KmsKeyId?: KmsKeyId; + /** + * The version of the stream. + */ + Version?: Version; + /** + * The status of the stream. + */ + Status?: Status; + /** + * A time stamp that indicates when the stream was created. + */ + CreationTime?: Timestamp; + /** + * How long the stream retains data, in hours. + */ + DataRetentionInHours?: DataRetentionInHours; + } + export type StreamInfoList = StreamInfo[]; + export type StreamName = string; + export interface StreamNameCondition { + /** + * A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix. + */ + ComparisonOperator?: ComparisonOperator; + /** + * A value to compare. + */ + ComparisonValue?: StreamName; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export interface TagStreamInput { + /** + * The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to. + */ + StreamARN?: ResourceARN; + /** + * The name of the stream that you want to add the tag or tags to. + */ + StreamName?: StreamName; + /** + * A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional). + */ + Tags: ResourceTags; + } + export interface TagStreamOutput { + } + export type TagValue = string; + export type Timestamp = Date; + export interface UntagStreamInput { + /** + * The Amazon Resource Name (ARN) of the stream that you want to remove tags from. + */ + StreamARN?: ResourceARN; + /** + * The name of the stream that you want to remove tags from. + */ + StreamName?: StreamName; + /** + * A list of the keys of the tags that you want to remove. + */ + TagKeyList: TagKeyList; + } + export interface UntagStreamOutput { + } + export interface UpdateDataRetentionInput { + /** + * The name of the stream whose retention period you want to change. + */ + StreamName?: StreamName; + /** + * The Amazon Resource Name (ARN) of the stream whose retention period you want to change. + */ + StreamARN?: ResourceARN; + /** + * The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API. + */ + CurrentVersion: Version; + /** + * Indicates whether you want to increase or decrease the retention period. + */ + Operation: UpdateDataRetentionOperation; + /** + * The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years). + */ + DataRetentionChangeInHours: DataRetentionChangeInHours; + } + export type UpdateDataRetentionOperation = "INCREASE_DATA_RETENTION"|"DECREASE_DATA_RETENTION"|string; + export interface UpdateDataRetentionOutput { + } + export interface UpdateStreamInput { + /** + * The name of the stream whose metadata you want to update. The stream name is an identifier for the stream, and must be unique for each account and region. + */ + StreamName?: StreamName; + /** + * The ARN of the stream whose metadata you want to update. + */ + StreamARN?: ResourceARN; + /** + * The version of the stream whose metadata you want to update. + */ + CurrentVersion: Version; + /** + * The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name. + */ + DeviceName?: DeviceName; + /** + * The stream's media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements. To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType. + */ + MediaType?: MediaType; + } + export interface UpdateStreamOutput { + } + export type Version = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the KinesisVideo client. + */ + export import Types = KinesisVideo; +} +export = KinesisVideo; diff --git a/node_modules/aws-sdk/clients/kinesisvideo.js b/node_modules/aws-sdk/clients/kinesisvideo.js new file mode 100644 index 0000000..d51a9d1 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisvideo.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kinesisvideo'] = {}; +AWS.KinesisVideo = Service.defineService('kinesisvideo', ['2017-09-30']); +Object.defineProperty(apiLoader.services['kinesisvideo'], '2017-09-30', { + get: function get() { + var model = require('../apis/kinesisvideo-2017-09-30.min.json'); + model.paginators = require('../apis/kinesisvideo-2017-09-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.KinesisVideo; diff --git a/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts b/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts new file mode 100644 index 0000000..dfea04b --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts @@ -0,0 +1,230 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Readable} from 'stream'; +interface Blob {} +declare class KinesisVideoArchivedMedia extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: KinesisVideoArchivedMedia.Types.ClientConfiguration) + config: Config & KinesisVideoArchivedMedia.Types.ClientConfiguration; + /** + * Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents. You must specify either the StreamName or the StreamARN. An Amazon Kinesis video stream has the following requirements for providing data through HLS: The media must contain h.264 encoded video and, optionally, AAC encoded audio. Specifically, the codec id of track 1 should be V_MPEG/ISO/AVC. Optionally, the codec id of track 2 should be A_AAC. Data retention must be greater than 0. The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags. The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7). Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification. The following procedure shows how to use HLS with Kinesis Video Streams: Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS). Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials. The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions: GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution. GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track. GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames. GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing for details. GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream. If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media. Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing. The following restrictions apply to HLS sessions: A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits. A Kinesis video stream can have a maximum of five active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit. You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply. For more information about HLS, see HTTP Live Streaming on the Apple Developer site. + */ + getHLSStreamingSessionURL(params: KinesisVideoArchivedMedia.Types.GetHLSStreamingSessionURLInput, callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.GetHLSStreamingSessionURLOutput) => void): Request; + /** + * Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents. You must specify either the StreamName or the StreamARN. An Amazon Kinesis video stream has the following requirements for providing data through HLS: The media must contain h.264 encoded video and, optionally, AAC encoded audio. Specifically, the codec id of track 1 should be V_MPEG/ISO/AVC. Optionally, the codec id of track 2 should be A_AAC. Data retention must be greater than 0. The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags. The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7). Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification. The following procedure shows how to use HLS with Kinesis Video Streams: Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS). Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials. The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions: GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution. GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track. GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames. GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing for details. GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream. If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media. Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing. The following restrictions apply to HLS sessions: A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits. A Kinesis video stream can have a maximum of five active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit. You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply. For more information about HLS, see HTTP Live Streaming on the Apple Developer site. + */ + getHLSStreamingSessionURL(callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.GetHLSStreamingSessionURLOutput) => void): Request; + /** + * Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter. The following limits apply when using the GetMediaForFragmentList API: A client can call GetMediaForFragmentList up to five times per second per stream. Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session. + */ + getMediaForFragmentList(params: KinesisVideoArchivedMedia.Types.GetMediaForFragmentListInput, callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.GetMediaForFragmentListOutput) => void): Request; + /** + * Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter. The following limits apply when using the GetMediaForFragmentList API: A client can call GetMediaForFragmentList up to five times per second per stream. Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session. + */ + getMediaForFragmentList(callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.GetMediaForFragmentListOutput) => void): Request; + /** + * Returns a list of Fragment objects from the specified stream and timestamp range within the archived data. Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second. You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url parameter. + */ + listFragments(params: KinesisVideoArchivedMedia.Types.ListFragmentsInput, callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.ListFragmentsOutput) => void): Request; + /** + * Returns a list of Fragment objects from the specified stream and timestamp range within the archived data. Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second. You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url parameter. + */ + listFragments(callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.ListFragmentsOutput) => void): Request; +} +declare namespace KinesisVideoArchivedMedia { + export type ContainerFormat = "FRAGMENTED_MP4"|"MPEG_TS"|string; + export type ContentType = string; + export type DiscontinuityMode = "ALWAYS"|"NEVER"|string; + export type DisplayFragmentTimestamp = "ALWAYS"|"NEVER"|string; + export type Expires = number; + export interface Fragment { + /** + * The index value of the fragment. + */ + FragmentNumber?: String; + /** + * The total fragment size, including information about the fragment and contained media data. + */ + FragmentSizeInBytes?: Long; + /** + * The timestamp from the producer corresponding to the fragment. + */ + ProducerTimestamp?: Timestamp; + /** + * The timestamp from the AWS server corresponding to the fragment. + */ + ServerTimestamp?: Timestamp; + /** + * The playback duration or other time value associated with the fragment. + */ + FragmentLengthInMilliseconds?: Long; + } + export type FragmentList = Fragment[]; + export type FragmentNumberList = FragmentNumberString[]; + export type FragmentNumberString = string; + export interface FragmentSelector { + /** + * The origin of the timestamps to use (Server or Producer). + */ + FragmentSelectorType: FragmentSelectorType; + /** + * The range of timestamps to return. + */ + TimestampRange: TimestampRange; + } + export type FragmentSelectorType = "PRODUCER_TIMESTAMP"|"SERVER_TIMESTAMP"|string; + export interface GetHLSStreamingSessionURLInput { + /** + * The name of the stream for which to retrieve the HLS master playlist URL. You must specify either the StreamName or the StreamARN. + */ + StreamName?: StreamName; + /** + * The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL. You must specify either the StreamName or the StreamARN. + */ + StreamARN?: ResourceARN; + /** + * Whether to retrieve live or archived, on-demand data. Features of the two types of session include the following: LIVE : For sessions of this type, the HLS media playlist is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new playlist on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display. In LIVE mode, the newest available fragments are included in an HLS media playlist, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the HLS media playlist if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the playlist, the older fragment is not added, and the gap is not filled. ON_DEMAND : For sessions of this type, the HLS media playlist contains all the fragments for the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The playlist must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display. In both playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player. The default is LIVE. + */ + PlaybackMode?: PlaybackMode; + /** + * The time range of the requested fragment, and the source of the timestamps. This parameter is required if PlaybackMode is ON_DEMAND. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND, both FragmentSelectorType and TimestampRange must be set. + */ + HLSFragmentSelector?: HLSFragmentSelector; + /** + * Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4. The default is FRAGMENTED_MP4. + */ + ContainerFormat?: ContainerFormat; + /** + * Specifies when flags marking discontinuities between fragments will be added to the media playlists. The default is ALWAYS when HLSFragmentSelector is SERVER_TIMESTAMP, and NEVER when it is PRODUCER_TIMESTAMP. Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap between fragments (as is typical if HLSFragmentSelector is SERVER_TIMESTAMP), the media player timeline has small gaps between fragments in some places, and overwrites frames in other places. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the fragment being played immediately after the previous fragment. We recommend that you always have discontinuity flags between fragments if the fragment timestamps are not accurate or if fragments might be missing. You should not place discontinuity flags between fragments for the player timeline to accurately map to the producer timestamps. + */ + DiscontinuityMode?: DiscontinuityMode; + /** + * Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media. The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps. + */ + DisplayFragmentTimestamp?: DisplayFragmentTimestamp; + /** + * The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session. The default is 300 (5 minutes). + */ + Expires?: Expires; + /** + * The maximum number of fragments that are returned in the HLS media playlists. When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number. When there are a higher number of fragments available in a live HLS media playlist, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments. The default is 5 fragments if PlaybackMode is LIVE, and 1,000 if PlaybackMode is ON_DEMAND. The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments. + */ + MaxMediaPlaylistFragmentResults?: PageLimit; + } + export interface GetHLSStreamingSessionURLOutput { + /** + * The URL (containing the session token) that a media player can use to retrieve the HLS master playlist. + */ + HLSStreamingSessionURL?: HLSStreamingSessionURL; + } + export interface GetMediaForFragmentListInput { + /** + * The name of the stream from which to retrieve fragment media. + */ + StreamName: StreamName; + /** + * A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments. + */ + Fragments: FragmentNumberList; + } + export interface GetMediaForFragmentListOutput { + /** + * The content type of the requested media. + */ + ContentType?: ContentType; + /** + * The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags: AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment. AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment. The following tags will be included if an exception occurs: AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception + */ + Payload?: Payload; + } + export interface HLSFragmentSelector { + /** + * The source of the timestamps for the requested media. When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is ON_DEMAND, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value) are included. Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the HLS media playlists will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned. When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the HLS media playlist. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist. The default is SERVER_TIMESTAMP. + */ + FragmentSelectorType?: HLSFragmentSelectorType; + /** + * The start and end of the timestamp range for the requested media. This value should not be present if PlaybackType is LIVE. + */ + TimestampRange?: HLSTimestampRange; + } + export type HLSFragmentSelectorType = "PRODUCER_TIMESTAMP"|"SERVER_TIMESTAMP"|string; + export type HLSStreamingSessionURL = string; + export interface HLSTimestampRange { + /** + * The start of the timestamp range for the requested media. If the HLSTimestampRange value is specified, the StartTimestamp value is required. This value is inclusive. Fragments that start before the StartTimestamp and continue past it are included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head. + */ + StartTimestamp?: Timestamp; + /** + * The end of the timestamp range for the requested media. This value must be within 3 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past. If the HLSTimestampRange value is specified, the EndTimestamp value is required. This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session. + */ + EndTimestamp?: Timestamp; + } + export interface ListFragmentsInput { + /** + * The name of the stream from which to retrieve a fragment list. + */ + StreamName: StreamName; + /** + * The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination. + */ + MaxResults?: PageLimit; + /** + * A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response. + */ + NextToken?: String; + /** + * Describes the timestamp range and timestamp origin for the range of fragments to return. + */ + FragmentSelector?: FragmentSelector; + } + export interface ListFragmentsOutput { + /** + * A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no specific order, even across pages. + */ + Fragments?: FragmentList; + /** + * If the returned list is truncated, the operation returns this token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + NextToken?: String; + } + export type Long = number; + export type PageLimit = number; + export type Payload = Buffer|Uint8Array|Blob|string|Readable; + export type PlaybackMode = "LIVE"|"ON_DEMAND"|string; + export type ResourceARN = string; + export type StreamName = string; + export type String = string; + export type Timestamp = Date; + export interface TimestampRange { + /** + * The starting timestamp in the range of timestamps for which to return fragments. + */ + StartTimestamp: Timestamp; + /** + * The ending timestamp in the range of timestamps for which to return fragments. + */ + EndTimestamp: Timestamp; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the KinesisVideoArchivedMedia client. + */ + export import Types = KinesisVideoArchivedMedia; +} +export = KinesisVideoArchivedMedia; diff --git a/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.js b/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.js new file mode 100644 index 0000000..31c7357 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kinesisvideoarchivedmedia'] = {}; +AWS.KinesisVideoArchivedMedia = Service.defineService('kinesisvideoarchivedmedia', ['2017-09-30']); +Object.defineProperty(apiLoader.services['kinesisvideoarchivedmedia'], '2017-09-30', { + get: function get() { + var model = require('../apis/kinesis-video-archived-media-2017-09-30.min.json'); + model.paginators = require('../apis/kinesis-video-archived-media-2017-09-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.KinesisVideoArchivedMedia; diff --git a/node_modules/aws-sdk/clients/kinesisvideomedia.d.ts b/node_modules/aws-sdk/clients/kinesisvideomedia.d.ts new file mode 100644 index 0000000..9f83d87 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisvideomedia.d.ts @@ -0,0 +1,91 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Readable} from 'stream'; +interface Blob {} +declare class KinesisVideoMedia extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: KinesisVideoMedia.Types.ClientConfiguration) + config: Config & KinesisVideoMedia.Types.ClientConfiguration; + /** + * Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter. When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see . The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request. The following limits apply when using the GetMedia API: A client can call GetMedia up to five times per second per stream. Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session. + */ + getMedia(params: KinesisVideoMedia.Types.GetMediaInput, callback?: (err: AWSError, data: KinesisVideoMedia.Types.GetMediaOutput) => void): Request; + /** + * Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter. When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see . The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request. The following limits apply when using the GetMedia API: A client can call GetMedia up to five times per second per stream. Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session. + */ + getMedia(callback?: (err: AWSError, data: KinesisVideoMedia.Types.GetMediaOutput) => void): Request; +} +declare namespace KinesisVideoMedia { + export type ContentType = string; + export type ContinuationToken = string; + export type FragmentNumberString = string; + export interface GetMediaInput { + /** + * The Kinesis video stream name from where you want to get the media content. If you don't specify the streamName, you must specify the streamARN. + */ + StreamName?: StreamName; + /** + * The ARN of the stream from where you want to get the media content. If you don't specify the streamARN, you must specify the streamName. + */ + StreamARN?: ResourceARN; + /** + * Identifies the starting chunk to get from the specified stream. + */ + StartSelector: StartSelector; + } + export interface GetMediaOutput { + /** + * The content type of the requested media. + */ + ContentType?: ContentType; + /** + * The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia call also include the following additional Matroska (MKV) tags: AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your GetMedia call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream. AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment. AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment. The following tags will be present if an error occurs: AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop. AWS_KINESISVIDEO_ERROR_ID: Integer code of the error. The error codes are as follows: 3002 - Error writing to the stream 4000 - Requested fragment is not found 4500 - Access denied for the stream's KMS key 4501 - Stream's KMS key is disabled 4502 - Validation error on the stream's KMS key 4503 - KMS key specified in the stream is unavailable 4504 - Invalid usage of the KMS key specified in the stream 4505 - Invalid state of the KMS key specified in the stream 4506 - Unable to find the KMS key specified in the stream 5000 - Internal error + */ + Payload?: Payload; + } + export type Payload = Buffer|Uint8Array|Blob|string|Readable; + export type ResourceARN = string; + export interface StartSelector { + /** + * Identifies the fragment on the Kinesis video stream where you want to start getting the data from. NOW - Start with the latest chunk on the stream. EARLIEST - Start with earliest available chunk on the stream. FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber. PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server timestamp. You specify the timestamp by adding StartTimestamp. CONTINUATION_TOKEN - Read using the specified continuation token. If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector. + */ + StartSelectorType: StartSelectorType; + /** + * Specifies the fragment number from where you want the GetMedia API to start returning the fragments. + */ + AfterFragmentNumber?: FragmentNumberString; + /** + * A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified timestamp. + */ + StartTimestamp?: Timestamp; + /** + * Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token. + */ + ContinuationToken?: ContinuationToken; + } + export type StartSelectorType = "FRAGMENT_NUMBER"|"SERVER_TIMESTAMP"|"PRODUCER_TIMESTAMP"|"NOW"|"EARLIEST"|"CONTINUATION_TOKEN"|string; + export type StreamName = string; + export type Timestamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the KinesisVideoMedia client. + */ + export import Types = KinesisVideoMedia; +} +export = KinesisVideoMedia; diff --git a/node_modules/aws-sdk/clients/kinesisvideomedia.js b/node_modules/aws-sdk/clients/kinesisvideomedia.js new file mode 100644 index 0000000..af9a631 --- /dev/null +++ b/node_modules/aws-sdk/clients/kinesisvideomedia.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kinesisvideomedia'] = {}; +AWS.KinesisVideoMedia = Service.defineService('kinesisvideomedia', ['2017-09-30']); +Object.defineProperty(apiLoader.services['kinesisvideomedia'], '2017-09-30', { + get: function get() { + var model = require('../apis/kinesis-video-media-2017-09-30.min.json'); + model.paginators = require('../apis/kinesis-video-media-2017-09-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.KinesisVideoMedia; diff --git a/node_modules/aws-sdk/clients/kms.d.ts b/node_modules/aws-sdk/clients/kms.d.ts new file mode 100644 index 0000000..cf4d3fc --- /dev/null +++ b/node_modules/aws-sdk/clients/kms.d.ts @@ -0,0 +1,1341 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class KMS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: KMS.Types.ClientConfiguration) + config: Config & KMS.Types.ClientConfiguration; + /** + * Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account. For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + cancelKeyDeletion(params: KMS.Types.CancelKeyDeletionRequest, callback?: (err: AWSError, data: KMS.Types.CancelKeyDeletionResponse) => void): Request; + /** + * Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account. For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + cancelKeyDeletion(callback?: (err: AWSError, data: KMS.Types.CancelKeyDeletionResponse) => void): Request; + /** + * Connects or reconnects a custom key store to its associated AWS CloudHSM cluster. The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time. To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation. During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the kmsuser crypto user (CU), and rotates its password. The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry. To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again. If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide. + */ + connectCustomKeyStore(params: KMS.Types.ConnectCustomKeyStoreRequest, callback?: (err: AWSError, data: KMS.Types.ConnectCustomKeyStoreResponse) => void): Request; + /** + * Connects or reconnects a custom key store to its associated AWS CloudHSM cluster. The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time. To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation. During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the kmsuser crypto user (CU), and rotates its password. The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry. To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again. If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide. + */ + connectCustomKeyStore(callback?: (err: AWSError, data: KMS.Types.ConnectCustomKeyStoreResponse) => void): Request; + /** + * Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey. Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region. Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation. The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs. The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account. To map an existing alias to a different CMK, call UpdateAlias. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + createAlias(params: KMS.Types.CreateAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey. Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region. Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation. The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs. The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account. To map an existing alias to a different CMK, call UpdateAlias. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + createAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it. For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide. + */ + createCustomKeyStore(params: KMS.Types.CreateCustomKeyStoreRequest, callback?: (err: AWSError, data: KMS.Types.CreateCustomKeyStoreResponse) => void): Request; + /** + * Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it. For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide. + */ + createCustomKeyStore(callback?: (err: AWSError, data: KMS.Types.CreateCustomKeyStoreResponse) => void): Request; + /** + * Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies. To create a grant that allows a cryptographic operation only when the encryption context in the operation request matches or includes a specified encryption context, use the Constraints parameter. For details, see GrantConstraints. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide . The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + createGrant(params: KMS.Types.CreateGrantRequest, callback?: (err: AWSError, data: KMS.Types.CreateGrantResponse) => void): Request; + /** + * Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies. To create a grant that allows a cryptographic operation only when the encryption context in the operation request matches or includes a specified encryption context, use the Constraints parameter. For details, see GrantConstraints. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide . The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + createGrant(callback?: (err: AWSError, data: KMS.Types.CreateGrantResponse) => void): Request; + /** + * Creates a customer managed customer master key (CMK) in your AWS account. You can use a CMK to encrypt small amounts of data (up to 4096 bytes) directly. But CMKs are more commonly used to encrypt the data keys that are used to encrypt data. To create a CMK for imported key material, use the Origin parameter with a value of EXTERNAL. To create a CMK in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region. You cannot use this operation to create a CMK in a different AWS account. + */ + createKey(params: KMS.Types.CreateKeyRequest, callback?: (err: AWSError, data: KMS.Types.CreateKeyResponse) => void): Request; + /** + * Creates a customer managed customer master key (CMK) in your AWS account. You can use a CMK to encrypt small amounts of data (up to 4096 bytes) directly. But CMKs are more commonly used to encrypt the data keys that are used to encrypt data. To create a CMK for imported key material, use the Origin parameter with a value of EXTERNAL. To create a CMK in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region. You cannot use this operation to create a CMK in a different AWS account. + */ + createKey(callback?: (err: AWSError, data: KMS.Types.CreateKeyResponse) => void): Request; + /** + * Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations: GenerateDataKey GenerateDataKeyWithoutPlaintext Encrypt Whenever possible, use key policies to give users permission to call the Decrypt operation on the CMK, instead of IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + decrypt(params: KMS.Types.DecryptRequest, callback?: (err: AWSError, data: KMS.Types.DecryptResponse) => void): Request; + /** + * Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations: GenerateDataKey GenerateDataKeyWithoutPlaintext Encrypt Whenever possible, use key policies to give users permission to call the Decrypt operation on the CMK, instead of IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + decrypt(callback?: (err: AWSError, data: KMS.Types.DecryptResponse) => void): Request; + /** + * Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account. Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation. Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias. + */ + deleteAlias(params: KMS.Types.DeleteAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account. Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation. Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias. + */ + deleteAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster. The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store. Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. + */ + deleteCustomKeyStore(params: KMS.Types.DeleteCustomKeyStoreRequest, callback?: (err: AWSError, data: KMS.Types.DeleteCustomKeyStoreResponse) => void): Request; + /** + * Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster. The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store. Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. + */ + deleteCustomKeyStore(callback?: (err: AWSError, data: KMS.Types.DeleteCustomKeyStoreResponse) => void): Request; + /** + * Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account. When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport. After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + deleteImportedKeyMaterial(params: KMS.Types.DeleteImportedKeyMaterialRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account. When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport. After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + deleteImportedKeyMaterial(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets information about custom key stores in the account and region. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both). To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry. Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any. For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide. + */ + describeCustomKeyStores(params: KMS.Types.DescribeCustomKeyStoresRequest, callback?: (err: AWSError, data: KMS.Types.DescribeCustomKeyStoresResponse) => void): Request; + /** + * Gets information about custom key stores in the account and region. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both). To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry. Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any. For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide. + */ + describeCustomKeyStores(callback?: (err: AWSError, data: KMS.Types.DescribeCustomKeyStoresResponse) => void): Request; + /** + * Provides detailed information about the specified customer master key (CMK). You can use DescribeKey on a predefined AWS alias, that is, an AWS alias with no key ID. When you do, AWS KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter. + */ + describeKey(params: KMS.Types.DescribeKeyRequest, callback?: (err: AWSError, data: KMS.Types.DescribeKeyResponse) => void): Request; + /** + * Provides detailed information about the specified customer master key (CMK). You can use DescribeKey on a predefined AWS alias, that is, an AWS alias with no key ID. When you do, AWS KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter. + */ + describeKey(callback?: (err: AWSError, data: KMS.Types.DescribeKeyResponse) => void): Request; + /** + * Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide . The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + disableKey(params: KMS.Types.DisableKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide . The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + disableKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + disableKeyRotation(params: KMS.Types.DisableKeyRotationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + disableKeyRotation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time. While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. + */ + disconnectCustomKeyStore(params: KMS.Types.DisconnectCustomKeyStoreRequest, callback?: (err: AWSError, data: KMS.Types.DisconnectCustomKeyStoreResponse) => void): Request; + /** + * Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time. While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. + */ + disconnectCustomKeyStore(callback?: (err: AWSError, data: KMS.Types.DisconnectCustomKeyStoreResponse) => void): Request; + /** + * Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + enableKey(params: KMS.Types.EnableKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + enableKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. You cannot enable automatic rotation of CMKs with imported key material or CMKs in a custom key store. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + enableKeyRotation(params: KMS.Types.EnableKeyRotationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. You cannot enable automatic rotation of CMKs with imported key material or CMKs in a custom key store. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + enableKeyRotation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases: You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information. You can use the Encrypt operation to move encrypted data from one AWS region to another. In the first region, generate a data key and use the plaintext key to encrypt the data. Then, in the new region, call the Encrypt method on same plaintext data key. Now, you can safely move the encrypted data and encrypted data key to the new region, and decrypt in the new region when necessary. You don't need use this operation to encrypt a data key within a region. The GenerateDataKey and GenerateDataKeyWithoutPlaintext operations return an encrypted data key. Also, you don't need to use this operation to encrypt data in your application. You can use the plaintext and encrypted data keys that the GenerateDataKey operation returns. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter. + */ + encrypt(params: KMS.Types.EncryptRequest, callback?: (err: AWSError, data: KMS.Types.EncryptResponse) => void): Request; + /** + * Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases: You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information. You can use the Encrypt operation to move encrypted data from one AWS region to another. In the first region, generate a data key and use the plaintext key to encrypt the data. Then, in the new region, call the Encrypt method on same plaintext data key. Now, you can safely move the encrypted data and encrypted data key to the new region, and decrypt in the new region when necessary. You don't need use this operation to encrypt a data key within a region. The GenerateDataKey and GenerateDataKeyWithoutPlaintext operations return an encrypted data key. Also, you don't need to use this operation to encrypt data in your application. You can use the plaintext and encrypted data keys that the GenerateDataKey operation returns. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter. + */ + encrypt(callback?: (err: AWSError, data: KMS.Types.EncryptResponse) => void): Request; + /** + * Generates a unique data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data. GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key. To generate a data key, you need to specify the customer master key (CMK) that will be used to encrypt the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field (but not both). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter. You will find the plaintext copy of the data key in the Plaintext field of the response, and the encrypted copy of the data key in the CiphertextBlob field. We recommend that you use the following pattern to encrypt data locally in your application: Use the GenerateDataKey operation to get a data encryption key. Use the plaintext data key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data. To decrypt data locally: Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory. To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To get a cryptographically secure random byte string, use GenerateRandom. You can use the optional encryption context to add additional security to your encryption operation. When you specify an EncryptionContext in the GenerateDataKey operation, you must specify the same encryption context (a case-sensitive exact match) in your request to Decrypt the data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide . The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + generateDataKey(params: KMS.Types.GenerateDataKeyRequest, callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyResponse) => void): Request; + /** + * Generates a unique data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data. GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key. To generate a data key, you need to specify the customer master key (CMK) that will be used to encrypt the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field (but not both). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter. You will find the plaintext copy of the data key in the Plaintext field of the response, and the encrypted copy of the data key in the CiphertextBlob field. We recommend that you use the following pattern to encrypt data locally in your application: Use the GenerateDataKey operation to get a data encryption key. Use the plaintext data key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data. To decrypt data locally: Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory. To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To get a cryptographically secure random byte string, use GenerateRandom. You can use the optional encryption context to add additional security to your encryption operation. When you specify an EncryptionContext in the GenerateDataKey operation, you must specify the same encryption context (a case-sensitive exact match) in your request to Decrypt the data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide . The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + generateDataKey(callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyResponse) => void): Request; + /** + * Generates a unique data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. GenerateDataKeyWithoutPlaintext is identical to GenerateDataKey except that returns only the encrypted copy of the data key. Like GenerateDataKey, GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key. It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + generateDataKeyWithoutPlaintext(params: KMS.Types.GenerateDataKeyWithoutPlaintextRequest, callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyWithoutPlaintextResponse) => void): Request; + /** + * Generates a unique data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. GenerateDataKeyWithoutPlaintext is identical to GenerateDataKey except that returns only the encrypted copy of the data key. Like GenerateDataKey, GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key. It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + generateDataKeyWithoutPlaintext(callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyWithoutPlaintextResponse) => void): Request; + /** + * Returns a random byte string that is cryptographically secure. By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID. For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper. + */ + generateRandom(params: KMS.Types.GenerateRandomRequest, callback?: (err: AWSError, data: KMS.Types.GenerateRandomResponse) => void): Request; + /** + * Returns a random byte string that is cryptographically secure. By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID. For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper. + */ + generateRandom(callback?: (err: AWSError, data: KMS.Types.GenerateRandomResponse) => void): Request; + /** + * Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. + */ + getKeyPolicy(params: KMS.Types.GetKeyPolicyRequest, callback?: (err: AWSError, data: KMS.Types.GetKeyPolicyResponse) => void): Request; + /** + * Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. + */ + getKeyPolicy(callback?: (err: AWSError, data: KMS.Types.GetKeyPolicyResponse) => void): Request; + /** + * Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK). The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key. Pending deletion: While a CMK is pending deletion, its key rotation status is false and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. + */ + getKeyRotationStatus(params: KMS.Types.GetKeyRotationStatusRequest, callback?: (err: AWSError, data: KMS.Types.GetKeyRotationStatusResponse) => void): Request; + /** + * Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK). The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key. Pending deletion: While a CMK is pending deletion, its key rotation status is false and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. + */ + getKeyRotationStatus(callback?: (err: AWSError, data: KMS.Types.GetKeyRotationStatusResponse) => void): Request; + /** + * Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a CMK in a different AWS account. This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be used for a subsequent ImportKeyMaterial request. To get new ones, send another GetParametersForImport request. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + getParametersForImport(params: KMS.Types.GetParametersForImportRequest, callback?: (err: AWSError, data: KMS.Types.GetParametersForImportResponse) => void): Request; + /** + * Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a CMK in a different AWS account. This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be used for a subsequent ImportKeyMaterial request. To get new ones, send another GetParametersForImport request. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + getParametersForImport(callback?: (err: AWSError, data: KMS.Types.GetParametersForImportResponse) => void): Request; + /** + * Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide. Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response. When calling this operation, you must specify the following values: The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL. To create a CMK with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call DescribeKey.) The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport. The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response. Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. When this operation is successful, the key state of the CMK changes from PendingImport to Enabled, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + importKeyMaterial(params: KMS.Types.ImportKeyMaterialRequest, callback?: (err: AWSError, data: KMS.Types.ImportKeyMaterialResponse) => void): Request; + /** + * Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide. Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response. When calling this operation, you must specify the following values: The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL. To create a CMK with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call DescribeKey.) The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport. The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response. Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. When this operation is successful, the key state of the CMK changes from PendingImport to Enabled, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + importKeyMaterial(callback?: (err: AWSError, data: KMS.Types.ImportKeyMaterialResponse) => void): Request; + /** + * Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias. By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the KeyId parameter. The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format aws/<service-name>, such as aws/dynamodb. The response might also include aliases that have no TargetKeyId field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases limit. + */ + listAliases(params: KMS.Types.ListAliasesRequest, callback?: (err: AWSError, data: KMS.Types.ListAliasesResponse) => void): Request; + /** + * Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias. By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the KeyId parameter. The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format aws/<service-name>, such as aws/dynamodb. The response might also include aliases that have no TargetKeyId field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases limit. + */ + listAliases(callback?: (err: AWSError, data: KMS.Types.ListAliasesResponse) => void): Request; + /** + * Gets a list of all grants for the specified customer master key (CMK). To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. + */ + listGrants(params: KMS.Types.ListGrantsRequest, callback?: (err: AWSError, data: KMS.Types.ListGrantsResponse) => void): Request; + /** + * Gets a list of all grants for the specified customer master key (CMK). To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. + */ + listGrants(callback?: (err: AWSError, data: KMS.Types.ListGrantsResponse) => void): Request; + /** + * Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account. + */ + listKeyPolicies(params: KMS.Types.ListKeyPoliciesRequest, callback?: (err: AWSError, data: KMS.Types.ListKeyPoliciesResponse) => void): Request; + /** + * Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account. + */ + listKeyPolicies(callback?: (err: AWSError, data: KMS.Types.ListKeyPoliciesResponse) => void): Request; + /** + * Gets a list of all customer master keys (CMKs) in the caller's AWS account and region. + */ + listKeys(params: KMS.Types.ListKeysRequest, callback?: (err: AWSError, data: KMS.Types.ListKeysResponse) => void): Request; + /** + * Gets a list of all customer master keys (CMKs) in the caller's AWS account and region. + */ + listKeys(callback?: (err: AWSError, data: KMS.Types.ListKeysResponse) => void): Request; + /** + * Returns a list of all tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. + */ + listResourceTags(params: KMS.Types.ListResourceTagsRequest, callback?: (err: AWSError, data: KMS.Types.ListResourceTagsResponse) => void): Request; + /** + * Returns a list of all tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. + */ + listResourceTags(callback?: (err: AWSError, data: KMS.Types.ListResourceTagsResponse) => void): Request; + /** + * Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified. A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant. + */ + listRetirableGrants(params: KMS.Types.ListRetirableGrantsRequest, callback?: (err: AWSError, data: KMS.Types.ListGrantsResponse) => void): Request; + /** + * Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified. A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant. + */ + listRetirableGrants(callback?: (err: AWSError, data: KMS.Types.ListGrantsResponse) => void): Request; + /** + * Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide. + */ + putKeyPolicy(params: KMS.Types.PutKeyPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide. + */ + putKeyPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext. You can reencrypt data using CMKs in different AWS accounts. Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console. But you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + reEncrypt(params: KMS.Types.ReEncryptRequest, callback?: (err: AWSError, data: KMS.Types.ReEncryptResponse) => void): Request; + /** + * Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext. You can reencrypt data using CMKs in different AWS accounts. Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console. But you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + reEncrypt(callback?: (err: AWSError, data: KMS.Types.ReEncryptResponse) => void): Request; + /** + * Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: The AWS account (root user) under which the grant was created The RetiringPrincipal, if present in the grant The GranteePrincipal, if RetireGrant is an operation specified in the grant You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both. + */ + retireGrant(params: KMS.Types.RetireGrantRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: The AWS account (root user) under which the grant was created The RetiringPrincipal, if present in the grant The GranteePrincipal, if RetireGrant is an operation specified in the grant You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both. + */ + retireGrant(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. + */ + revokeGrant(params: KMS.Types.RevokeGrantRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. + */ + revokeGrant(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it. Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey. If you schedule deletion of a CMK from a custom key store, when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. You cannot perform this operation on a CMK in a different AWS account. For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + scheduleKeyDeletion(params: KMS.Types.ScheduleKeyDeletionRequest, callback?: (err: AWSError, data: KMS.Types.ScheduleKeyDeletionResponse) => void): Request; + /** + * Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it. Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey. If you schedule deletion of a CMK from a custom key store, when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. You cannot perform this operation on a CMK in a different AWS account. For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + scheduleKeyDeletion(callback?: (err: AWSError, data: KMS.Types.ScheduleKeyDeletionResponse) => void): Request; + /** + * Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + tagResource(params: KMS.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + untagResource(params: KMS.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account. This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias. Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation. The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + updateAlias(params: KMS.Types.UpdateAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account. This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias. Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation. The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + updateAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store. You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. Use the parameters of UpdateCustomKeyStore to edit your keystore settings. Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify. Use the KeyStorePassword parameter tell AWS KMS the current password of the kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster. Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. + */ + updateCustomKeyStore(params: KMS.Types.UpdateCustomKeyStoreRequest, callback?: (err: AWSError, data: KMS.Types.UpdateCustomKeyStoreResponse) => void): Request; + /** + * Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store. You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. Use the parameters of UpdateCustomKeyStore to edit your keystore settings. Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify. Use the KeyStorePassword parameter tell AWS KMS the current password of the kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster. Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. + */ + updateCustomKeyStore(callback?: (err: AWSError, data: KMS.Types.UpdateCustomKeyStoreResponse) => void): Request; + /** + * Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey. You cannot perform this operation on a CMK in a different AWS account. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + updateKeyDescription(params: KMS.Types.UpdateKeyDescriptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey. You cannot perform this operation on a CMK in a different AWS account. The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + updateKeyDescription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace KMS { + export type AWSAccountIdType = string; + export type AlgorithmSpec = "RSAES_PKCS1_V1_5"|"RSAES_OAEP_SHA_1"|"RSAES_OAEP_SHA_256"|string; + export type AliasList = AliasListEntry[]; + export interface AliasListEntry { + /** + * String that contains the alias. This value begins with alias/. + */ + AliasName?: AliasNameType; + /** + * String that contains the key ARN. + */ + AliasArn?: ArnType; + /** + * String that contains the key identifier referred to by the alias. + */ + TargetKeyId?: KeyIdType; + } + export type AliasNameType = string; + export type ArnType = string; + export type BooleanType = boolean; + export interface CancelKeyDeletionRequest { + /** + * The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface CancelKeyDeletionResponse { + /** + * The unique identifier of the master key for which deletion is canceled. + */ + KeyId?: KeyIdType; + } + export type CiphertextType = Buffer|Uint8Array|Blob|string; + export type CloudHsmClusterIdType = string; + export interface ConnectCustomKeyStoreRequest { + /** + * Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation. + */ + CustomKeyStoreId: CustomKeyStoreIdType; + } + export interface ConnectCustomKeyStoreResponse { + } + export type ConnectionErrorCodeType = "INVALID_CREDENTIALS"|"CLUSTER_NOT_FOUND"|"NETWORK_ERRORS"|"INTERNAL_ERROR"|"INSUFFICIENT_CLOUDHSM_HSMS"|"USER_LOCKED_OUT"|string; + export type ConnectionStateType = "CONNECTED"|"CONNECTING"|"FAILED"|"DISCONNECTED"|"DISCONNECTING"|string; + export interface CreateAliasRequest { + /** + * Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs. + */ + AliasName: AliasNameType; + /** + * Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide. + */ + TargetKeyId: KeyIdType; + } + export interface CreateCustomKeyStoreRequest { + /** + * Specifies a friendly name for the custom key store. The name must be unique in your AWS account. + */ + CustomKeyStoreName: CustomKeyStoreNameType; + /** + * Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation. + */ + CloudHsmClusterId: CloudHsmClusterIdType; + /** + * Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster. + */ + TrustAnchorCertificate: TrustAnchorCertificateType; + /** + * Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster. + */ + KeyStorePassword: KeyStorePasswordType; + } + export interface CreateCustomKeyStoreResponse { + /** + * A unique identifier for the new custom key store. + */ + CustomKeyStoreId?: CustomKeyStoreIdType; + } + export interface CreateGrantRequest { + /** + * The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference. + */ + GranteePrincipal: PrincipalIdType; + /** + * The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference. + */ + RetiringPrincipal?: PrincipalIdType; + /** + * A list of operations that the grant permits. + */ + Operations: GrantOperationList; + /** + * Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide . + */ + Constraints?: GrantConstraints; + /** + * A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantTokens?: GrantTokenList; + /** + * A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request. When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably. + */ + Name?: GrantNameType; + } + export interface CreateGrantResponse { + /** + * The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantToken?: GrantTokenType; + /** + * The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation. + */ + GrantId?: GrantIdType; + } + export interface CreateKeyRequest { + /** + * The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide . Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide. The key policy size limit is 32 kilobytes (32768 bytes). + */ + Policy?: PolicyType; + /** + * A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task. + */ + Description?: DescriptionType; + /** + * The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data. + */ + KeyUsage?: KeyUsageType; + /** + * The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material in its own key store. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. + */ + Origin?: OriginType; + /** + * Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. To find the ID of a custom key store, use the DescribeCustomKeyStores operation. The response includes the custom key store ID and the ID of the AWS CloudHSM cluster. This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. + */ + CustomKeyStoreId?: CustomKeyStoreIdType; + /** + * A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK. The default value is false. + */ + BypassPolicyLockoutSafetyCheck?: BooleanType; + /** + * One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource. + */ + Tags?: TagList; + } + export interface CreateKeyResponse { + /** + * Metadata associated with the CMK. + */ + KeyMetadata?: KeyMetadata; + } + export type CustomKeyStoreIdType = string; + export type CustomKeyStoreNameType = string; + export type CustomKeyStoresList = CustomKeyStoresListEntry[]; + export interface CustomKeyStoresListEntry { + /** + * A unique identifier for the custom key store. + */ + CustomKeyStoreId?: CustomKeyStoreIdType; + /** + * The user-specified friendly name for the custom key store. + */ + CustomKeyStoreName?: CustomKeyStoreNameType; + /** + * A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store. + */ + CloudHsmClusterId?: CloudHsmClusterIdType; + /** + * The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file. + */ + TrustAnchorCertificate?: TrustAnchorCertificateType; + /** + * Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED. The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM. A value of FAILED indicates that an attempt to connect was unsuccessful. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide. + */ + ConnectionState?: ConnectionStateType; + /** + * Describes the connection error. Valid values are: CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM. INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again. INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store. USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the password value for the custom key store. For help with connection failures, see Troubleshooting Custom Key Stores in the AWS Key Management Service Developer Guide. + */ + ConnectionErrorCode?: ConnectionErrorCodeType; + /** + * The date and time when the custom key store was created. + */ + CreationDate?: DateType; + } + export type DataKeySpec = "AES_256"|"AES_128"|string; + export type DateType = Date; + export interface DecryptRequest { + /** + * Ciphertext to be decrypted. The blob includes metadata. + */ + CiphertextBlob: CiphertextType; + /** + * The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context. + */ + EncryptionContext?: EncryptionContextType; + /** + * A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantTokens?: GrantTokenList; + } + export interface DecryptResponse { + /** + * ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation. + */ + KeyId?: KeyIdType; + /** + * Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. + */ + Plaintext?: PlaintextType; + } + export interface DeleteAliasRequest { + /** + * The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias. + */ + AliasName: AliasNameType; + } + export interface DeleteCustomKeyStoreRequest { + /** + * Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation. + */ + CustomKeyStoreId: CustomKeyStoreIdType; + } + export interface DeleteCustomKeyStoreResponse { + } + export interface DeleteImportedKeyMaterialRequest { + /** + * Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface DescribeCustomKeyStoresRequest { + /** + * Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both. + */ + CustomKeyStoreId?: CustomKeyStoreIdType; + /** + * Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both. + */ + CustomKeyStoreName?: CustomKeyStoreNameType; + /** + * Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. + */ + Limit?: LimitType; + /** + * Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. + */ + Marker?: MarkerType; + } + export interface DescribeCustomKeyStoresResponse { + /** + * Contains metadata about each custom key store. + */ + CustomKeyStores?: CustomKeyStoresList; + /** + * When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. + */ + NextMarker?: MarkerType; + /** + * A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request. + */ + Truncated?: BooleanType; + } + export interface DescribeKeyRequest { + /** + * Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases. + */ + KeyId: KeyIdType; + /** + * A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantTokens?: GrantTokenList; + } + export interface DescribeKeyResponse { + /** + * Metadata associated with the key. + */ + KeyMetadata?: KeyMetadata; + } + export type DescriptionType = string; + export interface DisableKeyRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface DisableKeyRotationRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface DisconnectCustomKeyStoreRequest { + /** + * Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation. + */ + CustomKeyStoreId: CustomKeyStoreIdType; + } + export interface DisconnectCustomKeyStoreResponse { + } + export interface EnableKeyRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface EnableKeyRotationRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface EncryptRequest { + /** + * A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases. + */ + KeyId: KeyIdType; + /** + * Data to be encrypted. + */ + Plaintext: PlaintextType; + /** + * Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context. + */ + EncryptionContext?: EncryptionContextType; + /** + * A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantTokens?: GrantTokenList; + } + export interface EncryptResponse { + /** + * The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. + */ + CiphertextBlob?: CiphertextType; + /** + * The ID of the key used during encryption. + */ + KeyId?: KeyIdType; + } + export type EncryptionContextKey = string; + export type EncryptionContextType = {[key: string]: EncryptionContextValue}; + export type EncryptionContextValue = string; + export type ExpirationModelType = "KEY_MATERIAL_EXPIRES"|"KEY_MATERIAL_DOES_NOT_EXPIRE"|string; + export interface GenerateDataKeyRequest { + /** + * An identifier for the CMK that encrypts the data key. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases. + */ + KeyId: KeyIdType; + /** + * A set of key-value pairs that represents additional authenticated data. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. + */ + EncryptionContext?: EncryptionContextType; + /** + * The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one. + */ + NumberOfBytes?: NumberOfBytesType; + /** + * The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key. + */ + KeySpec?: DataKeySpec; + /** + * A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantTokens?: GrantTokenList; + } + export interface GenerateDataKeyResponse { + /** + * The encrypted copy of the data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. + */ + CiphertextBlob?: CiphertextType; + /** + * The plaintext data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible. + */ + Plaintext?: PlaintextType; + /** + * The identifier of the CMK that encrypted the data key. + */ + KeyId?: KeyIdType; + } + export interface GenerateDataKeyWithoutPlaintextRequest { + /** + * The identifier of the customer master key (CMK) that encrypts the data key. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases. + */ + KeyId: KeyIdType; + /** + * A set of key-value pairs that represents additional authenticated data. For more information, see Encryption Context in the AWS Key Management Service Developer Guide. + */ + EncryptionContext?: EncryptionContextType; + /** + * The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key. + */ + KeySpec?: DataKeySpec; + /** + * The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one. + */ + NumberOfBytes?: NumberOfBytesType; + /** + * A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantTokens?: GrantTokenList; + } + export interface GenerateDataKeyWithoutPlaintextResponse { + /** + * The encrypted data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. + */ + CiphertextBlob?: CiphertextType; + /** + * The identifier of the CMK that encrypted the data key. + */ + KeyId?: KeyIdType; + } + export interface GenerateRandomRequest { + /** + * The length of the byte string. + */ + NumberOfBytes?: NumberOfBytesType; + /** + * Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation. + */ + CustomKeyStoreId?: CustomKeyStoreIdType; + } + export interface GenerateRandomResponse { + /** + * The random byte string. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. + */ + Plaintext?: PlaintextType; + } + export interface GetKeyPolicyRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies. + */ + PolicyName: PolicyNameType; + } + export interface GetKeyPolicyResponse { + /** + * A key policy document in JSON format. + */ + Policy?: PolicyType; + } + export interface GetKeyRotationStatusRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface GetKeyRotationStatusResponse { + /** + * A Boolean value that specifies whether key rotation is enabled. + */ + KeyRotationEnabled?: BooleanType; + } + export interface GetParametersForImportRequest { + /** + * The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide. + */ + WrappingAlgorithm: AlgorithmSpec; + /** + * The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported. + */ + WrappingKeySpec: WrappingKeySpec; + } + export interface GetParametersForImportResponse { + /** + * The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request. + */ + KeyId?: KeyIdType; + /** + * The import token to send in a subsequent ImportKeyMaterial request. + */ + ImportToken?: CiphertextType; + /** + * The public key to use to encrypt the key material before importing it with ImportKeyMaterial. + */ + PublicKey?: PlaintextType; + /** + * The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to get new ones. + */ + ParametersValidTo?: DateType; + } + export interface GrantConstraints { + /** + * A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs. + */ + EncryptionContextSubset?: EncryptionContextType; + /** + * A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint. + */ + EncryptionContextEquals?: EncryptionContextType; + } + export type GrantIdType = string; + export type GrantList = GrantListEntry[]; + export interface GrantListEntry { + /** + * The unique identifier for the customer master key (CMK) to which the grant applies. + */ + KeyId?: KeyIdType; + /** + * The unique identifier for the grant. + */ + GrantId?: GrantIdType; + /** + * The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null. + */ + Name?: GrantNameType; + /** + * The date and time when the grant was created. + */ + CreationDate?: DateType; + /** + * The principal that receives the grant's permissions. + */ + GranteePrincipal?: PrincipalIdType; + /** + * The principal that can retire the grant. + */ + RetiringPrincipal?: PrincipalIdType; + /** + * The AWS account under which the grant was issued. + */ + IssuingAccount?: PrincipalIdType; + /** + * The list of operations permitted by the grant. + */ + Operations?: GrantOperationList; + /** + * A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. + */ + Constraints?: GrantConstraints; + } + export type GrantNameType = string; + export type GrantOperation = "Decrypt"|"Encrypt"|"GenerateDataKey"|"GenerateDataKeyWithoutPlaintext"|"ReEncryptFrom"|"ReEncryptTo"|"CreateGrant"|"RetireGrant"|"DescribeKey"|string; + export type GrantOperationList = GrantOperation[]; + export type GrantTokenList = GrantTokenType[]; + export type GrantTokenType = string; + export interface ImportKeyMaterialRequest { + /** + * The identifier of the CMK to import the key material into. The CMK's Origin must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material. + */ + ImportToken: CiphertextType; + /** + * The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport request, using the wrapping algorithm that you specified in that request. + */ + EncryptedKeyMaterial: CiphertextType; + /** + * The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required. + */ + ValidTo?: DateType; + /** + * Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter. + */ + ExpirationModel?: ExpirationModelType; + } + export interface ImportKeyMaterialResponse { + } + export type KeyIdType = string; + export type KeyList = KeyListEntry[]; + export interface KeyListEntry { + /** + * Unique identifier of the key. + */ + KeyId?: KeyIdType; + /** + * ARN of the key. + */ + KeyArn?: ArnType; + } + export type KeyManagerType = "AWS"|"CUSTOMER"|string; + export interface KeyMetadata { + /** + * The twelve-digit account ID of the AWS account that owns the CMK. + */ + AWSAccountId?: AWSAccountIdType; + /** + * The globally unique identifier for the CMK. + */ + KeyId: KeyIdType; + /** + * The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference. + */ + Arn?: ArnType; + /** + * The date and time when the CMK was created. + */ + CreationDate?: DateType; + /** + * Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false. + */ + Enabled?: BooleanType; + /** + * The description of the CMK. + */ + Description?: DescriptionType; + /** + * The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data. + */ + KeyUsage?: KeyUsageType; + /** + * The state of the CMK. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide. + */ + KeyState?: KeyState; + /** + * The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion. + */ + DeletionDate?: DateType; + /** + * The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted. + */ + ValidTo?: DateType; + /** + * The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store. + */ + Origin?: OriginType; + /** + * A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store. + */ + CustomKeyStoreId?: CustomKeyStoreIdType; + /** + * The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store. + */ + CloudHsmClusterId?: CloudHsmClusterIdType; + /** + * Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted. + */ + ExpirationModel?: ExpirationModelType; + /** + * The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide. + */ + KeyManager?: KeyManagerType; + } + export type KeyState = "Enabled"|"Disabled"|"PendingDeletion"|"PendingImport"|"Unavailable"|string; + export type KeyStorePasswordType = string; + export type KeyUsageType = "ENCRYPT_DECRYPT"|string; + export type LimitType = number; + export interface ListAliasesRequest { + /** + * Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value. This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region. + */ + KeyId?: KeyIdType; + /** + * Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. + */ + Limit?: LimitType; + /** + * Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. + */ + Marker?: MarkerType; + } + export interface ListAliasesResponse { + /** + * A list of aliases. + */ + Aliases?: AliasList; + /** + * When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. + */ + NextMarker?: MarkerType; + /** + * A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request. + */ + Truncated?: BooleanType; + } + export interface ListGrantsRequest { + /** + * Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. + */ + Limit?: LimitType; + /** + * Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. + */ + Marker?: MarkerType; + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + } + export interface ListGrantsResponse { + /** + * A list of grants. + */ + Grants?: GrantList; + /** + * When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. + */ + NextMarker?: MarkerType; + /** + * A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request. + */ + Truncated?: BooleanType; + } + export interface ListKeyPoliciesRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100. Only one policy can be attached to a key. + */ + Limit?: LimitType; + /** + * Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. + */ + Marker?: MarkerType; + } + export interface ListKeyPoliciesResponse { + /** + * A list of key policy names. The only valid value is default. + */ + PolicyNames?: PolicyNameList; + /** + * When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. + */ + NextMarker?: MarkerType; + /** + * A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request. + */ + Truncated?: BooleanType; + } + export interface ListKeysRequest { + /** + * Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100. + */ + Limit?: LimitType; + /** + * Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. + */ + Marker?: MarkerType; + } + export interface ListKeysResponse { + /** + * A list of customer master keys (CMKs). + */ + Keys?: KeyList; + /** + * When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. + */ + NextMarker?: MarkerType; + /** + * A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request. + */ + Truncated?: BooleanType; + } + export interface ListResourceTagsRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50. + */ + Limit?: LimitType; + /** + * Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received. + */ + Marker?: MarkerType; + } + export interface ListResourceTagsResponse { + /** + * A list of tags. Each tag consists of a tag key and a tag value. + */ + Tags?: TagList; + /** + * When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. Do not assume or infer any information from this value. + */ + NextMarker?: MarkerType; + /** + * A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request. + */ + Truncated?: BooleanType; + } + export interface ListRetirableGrantsRequest { + /** + * Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. + */ + Limit?: LimitType; + /** + * Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. + */ + Marker?: MarkerType; + /** + * The retiring principal for which to list grants. To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference. + */ + RetiringPrincipal: PrincipalIdType; + } + export type MarkerType = string; + export type NumberOfBytesType = number; + export type OriginType = "AWS_KMS"|"EXTERNAL"|"AWS_CLOUDHSM"|string; + export type PendingWindowInDaysType = number; + export type PlaintextType = Buffer|Uint8Array|Blob|string; + export type PolicyNameList = PolicyNameType[]; + export type PolicyNameType = string; + export type PolicyType = string; + export type PrincipalIdType = string; + export interface PutKeyPolicyRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * The name of the key policy. The only valid value is default. + */ + PolicyName: PolicyNameType; + /** + * The key policy to attach to the CMK. The key policy must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide. Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide. The key policy size limit is 32 kilobytes (32768 bytes). + */ + Policy: PolicyType; + /** + * A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK. The default value is false. + */ + BypassPolicyLockoutSafetyCheck?: BooleanType; + } + export interface ReEncryptRequest { + /** + * Ciphertext of the data to reencrypt. + */ + CiphertextBlob: CiphertextType; + /** + * Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter. + */ + SourceEncryptionContext?: EncryptionContextType; + /** + * A unique identifier for the CMK that is used to reencrypt the data. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases. + */ + DestinationKeyId: KeyIdType; + /** + * Encryption context to use when the data is reencrypted. + */ + DestinationEncryptionContext?: EncryptionContextType; + /** + * A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide. + */ + GrantTokens?: GrantTokenList; + } + export interface ReEncryptResponse { + /** + * The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. + */ + CiphertextBlob?: CiphertextType; + /** + * Unique identifier of the CMK used to originally encrypt the data. + */ + SourceKeyId?: KeyIdType; + /** + * Unique identifier of the CMK used to reencrypt the data. + */ + KeyId?: KeyIdType; + } + export interface RetireGrantRequest { + /** + * Token that identifies the grant to be retired. + */ + GrantToken?: GrantTokenType; + /** + * The Amazon Resource Name (ARN) of the CMK associated with the grant. For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab + */ + KeyId?: KeyIdType; + /** + * Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation. Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 + */ + GrantId?: GrantIdType; + } + export interface RevokeGrantRequest { + /** + * A unique identifier for the customer master key associated with the grant. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * Identifier of the grant to be revoked. + */ + GrantId: GrantIdType; + } + export interface ScheduleKeyDeletionRequest { + /** + * The unique identifier of the customer master key (CMK) to delete. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30. + */ + PendingWindowInDays?: PendingWindowInDaysType; + } + export interface ScheduleKeyDeletionResponse { + /** + * The unique identifier of the customer master key (CMK) for which deletion is scheduled. + */ + KeyId?: KeyIdType; + /** + * The date and time after which AWS KMS deletes the customer master key (CMK). + */ + DeletionDate?: DateType; + } + export interface Tag { + /** + * The key of the tag. + */ + TagKey: TagKeyType; + /** + * The value of the tag. + */ + TagValue: TagValueType; + } + export type TagKeyList = TagKeyType[]; + export type TagKeyType = string; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * A unique identifier for the CMK you are tagging. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * One or more tags. Each tag consists of a tag key and a tag value. + */ + Tags: TagList; + } + export type TagValueType = string; + export type TrustAnchorCertificateType = string; + export interface UntagResourceRequest { + /** + * A unique identifier for the CMK from which you are removing tags. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * One or more tag keys. Specify only the tag keys, not the tag values. + */ + TagKeys: TagKeyList; + } + export interface UpdateAliasRequest { + /** + * Specifies the name of the alias to change. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. + */ + AliasName: AliasNameType; + /** + * Unique identifier of the customer master key (CMK) to be mapped to the alias. When the update operation completes, the alias will point to this CMK. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To verify that the alias is mapped to the correct CMK, use ListAliases. + */ + TargetKeyId: KeyIdType; + } + export interface UpdateCustomKeyStoreRequest { + /** + * Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation. + */ + CustomKeyStoreId: CustomKeyStoreIdType; + /** + * Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account. + */ + NewCustomKeyStoreName?: CustomKeyStoreNameType; + /** + * Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store. This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster. + */ + KeyStorePassword?: KeyStorePasswordType; + /** + * Associates the custom key store with a related AWS CloudHSM cluster. Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation. + */ + CloudHsmClusterId?: CloudHsmClusterIdType; + } + export interface UpdateCustomKeyStoreResponse { + } + export interface UpdateKeyDescriptionRequest { + /** + * A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. + */ + KeyId: KeyIdType; + /** + * New description for the CMK. + */ + Description: DescriptionType; + } + export type WrappingKeySpec = "RSA_2048"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-11-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the KMS client. + */ + export import Types = KMS; +} +export = KMS; diff --git a/node_modules/aws-sdk/clients/kms.js b/node_modules/aws-sdk/clients/kms.js new file mode 100644 index 0000000..09c0f05 --- /dev/null +++ b/node_modules/aws-sdk/clients/kms.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['kms'] = {}; +AWS.KMS = Service.defineService('kms', ['2014-11-01']); +Object.defineProperty(apiLoader.services['kms'], '2014-11-01', { + get: function get() { + var model = require('../apis/kms-2014-11-01.min.json'); + model.paginators = require('../apis/kms-2014-11-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.KMS; diff --git a/node_modules/aws-sdk/clients/lambda.d.ts b/node_modules/aws-sdk/clients/lambda.d.ts new file mode 100644 index 0000000..eddf6d7 --- /dev/null +++ b/node_modules/aws-sdk/clients/lambda.d.ts @@ -0,0 +1,1695 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Readable} from 'stream'; +interface Blob {} +declare class Lambda extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Lambda.Types.ClientConfiguration) + config: Config & Lambda.Types.ClientConfiguration; + /** + * Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization. To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it. + */ + addLayerVersionPermission(params: Lambda.Types.AddLayerVersionPermissionRequest, callback?: (err: AWSError, data: Lambda.Types.AddLayerVersionPermissionResponse) => void): Request; + /** + * Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization. To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it. + */ + addLayerVersionPermission(callback?: (err: AWSError, data: Lambda.Types.AddLayerVersionPermissionResponse) => void): Request; + /** + * Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. This action adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies. + */ + addPermission(params: Lambda.Types.AddPermissionRequest, callback?: (err: AWSError, data: Lambda.Types.AddPermissionResponse) => void): Request; + /** + * Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. This action adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies. + */ + addPermission(callback?: (err: AWSError, data: Lambda.Types.AddPermissionResponse) => void): Request; + /** + * Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives. + */ + createAlias(params: Lambda.Types.CreateAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request; + /** + * Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives. + */ + createAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request; + /** + * Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function. For details about each event source type, see the following topics. Using AWS Lambda with Amazon Kinesis Using AWS Lambda with Amazon SQS Using AWS Lambda with Amazon DynamoDB + */ + createEventSourceMapping(params: Lambda.Types.CreateEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function. For details about each event source type, see the following topics. Using AWS Lambda with Amazon Kinesis Using AWS Lambda with Amazon SQS Using AWS Lambda with Amazon DynamoDB + */ + createEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing. A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration. The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency). If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions. + */ + createFunction(params: Lambda.Types.CreateFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing. A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration. The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency). If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions. + */ + createFunction(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Deletes a Lambda function alias. + */ + deleteAlias(params: Lambda.Types.DeleteAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Lambda function alias. + */ + deleteAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. + */ + deleteEventSourceMapping(params: Lambda.Types.DeleteEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. + */ + deleteEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it. + */ + deleteFunction(params: Lambda.Types.DeleteFunctionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it. + */ + deleteFunction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a concurrent execution limit from a function. + */ + deleteFunctionConcurrency(params: Lambda.Types.DeleteFunctionConcurrencyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a concurrent execution limit from a function. + */ + deleteFunctionConcurrency(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it. + */ + deleteLayerVersion(params: Lambda.Types.DeleteLayerVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it. + */ + deleteLayerVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves details about your account's limits and usage in an AWS Region. + */ + getAccountSettings(params: Lambda.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: Lambda.Types.GetAccountSettingsResponse) => void): Request; + /** + * Retrieves details about your account's limits and usage in an AWS Region. + */ + getAccountSettings(callback?: (err: AWSError, data: Lambda.Types.GetAccountSettingsResponse) => void): Request; + /** + * Returns details about a Lambda function alias. + */ + getAlias(params: Lambda.Types.GetAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request; + /** + * Returns details about a Lambda function alias. + */ + getAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request; + /** + * Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. + */ + getEventSourceMapping(params: Lambda.Types.GetEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. + */ + getEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned. + */ + getFunction(params: Lambda.Types.GetFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request; + /** + * Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned. + */ + getFunction(callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request; + /** + * Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration. To get all of a function's details, including function-level settings, use GetFunction. + */ + getFunctionConfiguration(params: Lambda.Types.GetFunctionConfigurationRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration. To get all of a function's details, including function-level settings, use GetFunction. + */ + getFunctionConfiguration(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes. + */ + getLayerVersion(params: Lambda.Types.GetLayerVersionRequest, callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request; + /** + * Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes. + */ + getLayerVersion(callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request; + /** + * Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes. + */ + getLayerVersionByArn(params: Lambda.Types.GetLayerVersionByArnRequest, callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request; + /** + * Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes. + */ + getLayerVersionByArn(callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionResponse) => void): Request; + /** + * Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission. + */ + getLayerVersionPolicy(params: Lambda.Types.GetLayerVersionPolicyRequest, callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionPolicyResponse) => void): Request; + /** + * Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission. + */ + getLayerVersionPolicy(callback?: (err: AWSError, data: Lambda.Types.GetLayerVersionPolicyResponse) => void): Request; + /** + * Returns the resource-based IAM policy for a function, version, or alias. + */ + getPolicy(params: Lambda.Types.GetPolicyRequest, callback?: (err: AWSError, data: Lambda.Types.GetPolicyResponse) => void): Request; + /** + * Returns the resource-based IAM policy for a function, version, or alias. + */ + getPolicy(callback?: (err: AWSError, data: Lambda.Types.GetPolicyResponse) => void): Request; + /** + * Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event. For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. To record function errors for asynchronous invocations, configure your function with a dead letter queue. When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior. The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded). For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings. This operation requires permission for the lambda:InvokeFunction action. + */ + invoke(params: Lambda.Types.InvocationRequest, callback?: (err: AWSError, data: Lambda.Types.InvocationResponse) => void): Request; + /** + * Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event. For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. To record function errors for asynchronous invocations, configure your function with a dead letter queue. When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior. The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded). For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings. This operation requires permission for the lambda:InvokeFunction action. + */ + invoke(callback?: (err: AWSError, data: Lambda.Types.InvocationResponse) => void): Request; + /** + * For asynchronous function invocation, use Invoke. Invokes a function asynchronously. + */ + invokeAsync(params: Lambda.Types.InvokeAsyncRequest, callback?: (err: AWSError, data: Lambda.Types.InvokeAsyncResponse) => void): Request; + /** + * For asynchronous function invocation, use Invoke. Invokes a function asynchronously. + */ + invokeAsync(callback?: (err: AWSError, data: Lambda.Types.InvokeAsyncResponse) => void): Request; + /** + * Returns a list of aliases for a Lambda function. + */ + listAliases(params: Lambda.Types.ListAliasesRequest, callback?: (err: AWSError, data: Lambda.Types.ListAliasesResponse) => void): Request; + /** + * Returns a list of aliases for a Lambda function. + */ + listAliases(callback?: (err: AWSError, data: Lambda.Types.ListAliasesResponse) => void): Request; + /** + * Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source. + */ + listEventSourceMappings(params: Lambda.Types.ListEventSourceMappingsRequest, callback?: (err: AWSError, data: Lambda.Types.ListEventSourceMappingsResponse) => void): Request; + /** + * Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source. + */ + listEventSourceMappings(callback?: (err: AWSError, data: Lambda.Types.ListEventSourceMappingsResponse) => void): Request; + /** + * Returns a list of Lambda functions, with the version-specific configuration of each. Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction. + */ + listFunctions(params: Lambda.Types.ListFunctionsRequest, callback?: (err: AWSError, data: Lambda.Types.ListFunctionsResponse) => void): Request; + /** + * Returns a list of Lambda functions, with the version-specific configuration of each. Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction. + */ + listFunctions(callback?: (err: AWSError, data: Lambda.Types.ListFunctionsResponse) => void): Request; + /** + * Lists the versions of an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. + */ + listLayerVersions(params: Lambda.Types.ListLayerVersionsRequest, callback?: (err: AWSError, data: Lambda.Types.ListLayerVersionsResponse) => void): Request; + /** + * Lists the versions of an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. + */ + listLayerVersions(callback?: (err: AWSError, data: Lambda.Types.ListLayerVersionsResponse) => void): Request; + /** + * Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. + */ + listLayers(params: Lambda.Types.ListLayersRequest, callback?: (err: AWSError, data: Lambda.Types.ListLayersResponse) => void): Request; + /** + * Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. + */ + listLayers(callback?: (err: AWSError, data: Lambda.Types.ListLayersResponse) => void): Request; + /** + * Returns a function's tags. You can also view tags with GetFunction. + */ + listTags(params: Lambda.Types.ListTagsRequest, callback?: (err: AWSError, data: Lambda.Types.ListTagsResponse) => void): Request; + /** + * Returns a function's tags. You can also view tags with GetFunction. + */ + listTags(callback?: (err: AWSError, data: Lambda.Types.ListTagsResponse) => void): Request; + /** + * Returns a list of versions, with the version-specific configuration of each. + */ + listVersionsByFunction(params: Lambda.Types.ListVersionsByFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.ListVersionsByFunctionResponse) => void): Request; + /** + * Returns a list of versions, with the version-specific configuration of each. + */ + listVersionsByFunction(callback?: (err: AWSError, data: Lambda.Types.ListVersionsByFunctionResponse) => void): Request; + /** + * Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same version name, a new version is created. Add layers to your function with CreateFunction or UpdateFunctionConfiguration. + */ + publishLayerVersion(params: Lambda.Types.PublishLayerVersionRequest, callback?: (err: AWSError, data: Lambda.Types.PublishLayerVersionResponse) => void): Request; + /** + * Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same version name, a new version is created. Add layers to your function with CreateFunction or UpdateFunctionConfiguration. + */ + publishLayerVersion(callback?: (err: AWSError, data: Lambda.Types.PublishLayerVersionResponse) => void): Request; + /** + * Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version. Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias. + */ + publishVersion(params: Lambda.Types.PublishVersionRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version. Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias. + */ + publishVersion(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level. Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function. Use GetAccountSettings to see your regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency. + */ + putFunctionConcurrency(params: Lambda.Types.PutFunctionConcurrencyRequest, callback?: (err: AWSError, data: Lambda.Types.Concurrency) => void): Request; + /** + * Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level. Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function. Use GetAccountSettings to see your regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency. + */ + putFunctionConcurrency(callback?: (err: AWSError, data: Lambda.Types.Concurrency) => void): Request; + /** + * Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission. + */ + removeLayerVersionPermission(params: Lambda.Types.RemoveLayerVersionPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission. + */ + removeLayerVersionPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy. + */ + removePermission(params: Lambda.Types.RemovePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy. + */ + removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds tags to a function. + */ + tagResource(params: Lambda.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds tags to a function. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags from a function. + */ + untagResource(params: Lambda.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags from a function. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the configuration of a Lambda function alias. + */ + updateAlias(params: Lambda.Types.UpdateAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request; + /** + * Updates the configuration of a Lambda function alias. + */ + updateAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request; + /** + * Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location. + */ + updateEventSourceMapping(params: Lambda.Types.UpdateEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location. + */ + updateEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request; + /** + * Updates a Lambda function's code. The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version. + */ + updateFunctionCode(params: Lambda.Types.UpdateFunctionCodeRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Updates a Lambda function's code. The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version. + */ + updateFunctionCode(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Modify the version-specific settings of a Lambda function. These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version. To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission. + */ + updateFunctionConfiguration(params: Lambda.Types.UpdateFunctionConfigurationRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; + /** + * Modify the version-specific settings of a Lambda function. These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version. To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission. + */ + updateFunctionConfiguration(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request; +} +declare namespace Lambda { + export interface AccountLimit { + /** + * The amount of storage space that you can use for all deployment packages and layer archives. + */ + TotalCodeSize?: Long; + /** + * The maximum size of your function's code and layers when they're extracted. + */ + CodeSizeUnzipped?: Long; + /** + * The maximum size of a deployment package when it's uploaded directly to AWS Lambda. Use Amazon S3 for larger files. + */ + CodeSizeZipped?: Long; + /** + * The maximum number of simultaneous function executions. + */ + ConcurrentExecutions?: Integer; + /** + * The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency. + */ + UnreservedConcurrentExecutions?: UnreservedConcurrentExecutions; + } + export interface AccountUsage { + /** + * The amount of storage space, in bytes, that's being used by deployment packages and layer archives. + */ + TotalCodeSize?: Long; + /** + * The number of Lambda functions. + */ + FunctionCount?: Long; + } + export type Action = string; + export interface AddLayerVersionPermissionRequest { + /** + * The name or Amazon Resource Name (ARN) of the layer. + */ + LayerName: LayerName; + /** + * The version number. + */ + VersionNumber: LayerVersionNumber; + /** + * An identifier that distinguishes the policy from others on the same layer version. + */ + StatementId: StatementId; + /** + * The API action that grants access to the layer. For example, lambda:GetLayerVersion. + */ + Action: LayerPermissionAllowedAction; + /** + * An account ID, or * to grant permission to all AWS accounts. + */ + Principal: LayerPermissionAllowedPrincipal; + /** + * With the principal set to *, grant permission to all accounts in the specified organization. + */ + OrganizationId?: OrganizationId; + /** + * Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it. + */ + RevisionId?: String; + } + export interface AddLayerVersionPermissionResponse { + /** + * The permission statement. + */ + Statement?: String; + /** + * A unique identifier for the current revision of the policy. + */ + RevisionId?: String; + } + export interface AddPermissionRequest { + /** + * The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * A statement identifier that differentiates the statement from others in the same policy. + */ + StatementId: StatementId; + /** + * The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction. + */ + Action: Action; + /** + * The AWS service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service. + */ + Principal: Principal; + /** + * For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. + */ + SourceArn?: Arn; + /** + * For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account. + */ + SourceAccount?: SourceOwner; + /** + * For Alexa Smart Home functions, a token that must be supplied by the invoker. + */ + EventSourceToken?: EventSourceToken; + /** + * Specify a version or alias to add permissions to a published version of the function. + */ + Qualifier?: Qualifier; + /** + * Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it. + */ + RevisionId?: String; + } + export interface AddPermissionResponse { + /** + * The permission statement that's added to the function policy. + */ + Statement?: String; + } + export type AdditionalVersion = string; + export type AdditionalVersionWeights = {[key: string]: Weight}; + export type Alias = string; + export interface AliasConfiguration { + /** + * The Amazon Resource Name (ARN) of the alias. + */ + AliasArn?: FunctionArn; + /** + * The name of the alias. + */ + Name?: Alias; + /** + * The function version that the alias invokes. + */ + FunctionVersion?: Version; + /** + * A description of the alias. + */ + Description?: Description; + /** + * The routing configuration of the alias. + */ + RoutingConfig?: AliasRoutingConfiguration; + /** + * A unique identifier that changes when you update the alias. + */ + RevisionId?: String; + } + export type AliasList = AliasConfiguration[]; + export interface AliasRoutingConfiguration { + /** + * The name of the second alias, and the percentage of traffic that's routed to it. + */ + AdditionalVersionWeights?: AdditionalVersionWeights; + } + export type Arn = string; + export type BatchSize = number; + export type _Blob = Buffer|Uint8Array|Blob|string; + export type BlobStream = Buffer|Uint8Array|Blob|string|Readable; + export type Boolean = boolean; + export type CompatibleRuntimes = Runtime[]; + export interface Concurrency { + /** + * The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency. + */ + ReservedConcurrentExecutions?: ReservedConcurrentExecutions; + } + export interface CreateAliasRequest { + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The name of the alias. + */ + Name: Alias; + /** + * The function version that the alias invokes. + */ + FunctionVersion: Version; + /** + * A description of the alias. + */ + Description?: Description; + /** + * The routing configuration of the alias. + */ + RoutingConfig?: AliasRoutingConfiguration; + } + export interface CreateEventSourceMappingRequest { + /** + * The Amazon Resource Name (ARN) of the event source. Amazon Kinesis - The ARN of the data stream or a stream consumer. Amazon DynamoDB Streams - The ARN of the stream. Amazon Simple Queue Service - The ARN of the queue. + */ + EventSourceArn: Arn; + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * Disables the event source mapping to pause polling and invocation. + */ + Enabled?: Enabled; + /** + * The maximum number of items to retrieve in a single batch. Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max 1,000. Amazon Simple Queue Service - Default 10. Max 10. + */ + BatchSize?: BatchSize; + /** + * The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams. + */ + StartingPosition?: EventSourcePosition; + /** + * With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + */ + StartingPositionTimestamp?: _Date; + } + export interface CreateFunctionRequest { + /** + * The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The identifier of the function's runtime. + */ + Runtime: Runtime; + /** + * The Amazon Resource Name (ARN) of the function's execution role. + */ + Role: RoleArn; + /** + * The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model. + */ + Handler: Handler; + /** + * The code for the function. + */ + Code: FunctionCode; + /** + * A description of the function. + */ + Description?: Description; + /** + * The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. + */ + Timeout?: Timeout; + /** + * The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB. + */ + MemorySize?: MemorySize; + /** + * Set to true to publish the first version of the function during creation. + */ + Publish?: Boolean; + /** + * For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings. + */ + VpcConfig?: VpcConfig; + /** + * A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues. + */ + DeadLetterConfig?: DeadLetterConfig; + /** + * Environment variables that are accessible from function code during execution. + */ + Environment?: Environment; + /** + * The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. + */ + KMSKeyArn?: KMSKeyArn; + /** + * Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray. + */ + TracingConfig?: TracingConfig; + /** + * A list of tags to apply to the function. + */ + Tags?: Tags; + /** + * A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. + */ + Layers?: LayerList; + } + export type _Date = Date; + export interface DeadLetterConfig { + /** + * The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. + */ + TargetArn?: ResourceArn; + } + export interface DeleteAliasRequest { + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The name of the alias. + */ + Name: Alias; + } + export interface DeleteEventSourceMappingRequest { + /** + * The identifier of the event source mapping. + */ + UUID: String; + } + export interface DeleteFunctionConcurrencyRequest { + /** + * The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + } + export interface DeleteFunctionRequest { + /** + * The name of the Lambda function or version. Name formats Function name - my-function (name-only), my-function:1 (with version). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * Specify a version to delete. You can't delete a version that's referenced by an alias. + */ + Qualifier?: Qualifier; + } + export interface DeleteLayerVersionRequest { + /** + * The name or Amazon Resource Name (ARN) of the layer. + */ + LayerName: LayerName; + /** + * The version number. + */ + VersionNumber: LayerVersionNumber; + } + export type Description = string; + export type Enabled = boolean; + export interface Environment { + /** + * Environment variable key-value pairs. + */ + Variables?: EnvironmentVariables; + } + export interface EnvironmentError { + /** + * The error code. + */ + ErrorCode?: String; + /** + * The error message. + */ + Message?: SensitiveString; + } + export interface EnvironmentResponse { + /** + * Environment variable key-value pairs. + */ + Variables?: EnvironmentVariables; + /** + * Error messages for environment variables that couldn't be applied. + */ + Error?: EnvironmentError; + } + export type EnvironmentVariableName = string; + export type EnvironmentVariableValue = string; + export type EnvironmentVariables = {[key: string]: EnvironmentVariableValue}; + export interface EventSourceMappingConfiguration { + /** + * The identifier of the event source mapping. + */ + UUID?: String; + /** + * The maximum number of items to retrieve in a single batch. + */ + BatchSize?: BatchSize; + /** + * The Amazon Resource Name (ARN) of the event source. + */ + EventSourceArn?: Arn; + /** + * The ARN of the Lambda function. + */ + FunctionArn?: FunctionArn; + /** + * The date that the event source mapping was last updated. + */ + LastModified?: _Date; + /** + * The result of the last AWS Lambda invocation of your Lambda function. + */ + LastProcessingResult?: String; + /** + * The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + */ + State?: String; + /** + * The cause of the last state change, either User initiated or Lambda initiated. + */ + StateTransitionReason?: String; + } + export type EventSourceMappingsList = EventSourceMappingConfiguration[]; + export type EventSourcePosition = "TRIM_HORIZON"|"LATEST"|"AT_TIMESTAMP"|string; + export type EventSourceToken = string; + export type FunctionArn = string; + export interface FunctionCode { + /** + * The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you. + */ + ZipFile?: _Blob; + /** + * An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. + */ + S3Bucket?: S3Bucket; + /** + * The Amazon S3 key of the deployment package. + */ + S3Key?: S3Key; + /** + * For versioned objects, the version of the deployment package object to use. + */ + S3ObjectVersion?: S3ObjectVersion; + } + export interface FunctionCodeLocation { + /** + * The service that's hosting the file. + */ + RepositoryType?: String; + /** + * A presigned URL that you can use to download the deployment package. + */ + Location?: String; + } + export interface FunctionConfiguration { + /** + * The name of the function. + */ + FunctionName?: NamespacedFunctionName; + /** + * The function's Amazon Resource Name (ARN). + */ + FunctionArn?: NameSpacedFunctionArn; + /** + * The runtime environment for the Lambda function. + */ + Runtime?: Runtime; + /** + * The function's execution role. + */ + Role?: RoleArn; + /** + * The function that Lambda calls to begin executing your function. + */ + Handler?: Handler; + /** + * The size of the function's deployment package, in bytes. + */ + CodeSize?: Long; + /** + * The function's description. + */ + Description?: Description; + /** + * The amount of time that Lambda allows a function to run before stopping it. + */ + Timeout?: Timeout; + /** + * The memory that's allocated to the function. + */ + MemorySize?: MemorySize; + /** + * The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). + */ + LastModified?: Timestamp; + /** + * The SHA256 hash of the function's deployment package. + */ + CodeSha256?: String; + /** + * The version of the Lambda function. + */ + Version?: Version; + /** + * The function's networking configuration. + */ + VpcConfig?: VpcConfigResponse; + /** + * The function's dead letter queue. + */ + DeadLetterConfig?: DeadLetterConfig; + /** + * The function's environment variables. + */ + Environment?: EnvironmentResponse; + /** + * The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer-managed CMK. + */ + KMSKeyArn?: KMSKeyArn; + /** + * The function's AWS X-Ray tracing configuration. + */ + TracingConfig?: TracingConfigResponse; + /** + * For Lambda@Edge functions, the ARN of the master function. + */ + MasterArn?: FunctionArn; + /** + * The latest updated revision of the function or alias. + */ + RevisionId?: String; + /** + * The function's layers. + */ + Layers?: LayersReferenceList; + } + export type FunctionList = FunctionConfiguration[]; + export type FunctionName = string; + export type FunctionVersion = "ALL"|string; + export interface GetAccountSettingsRequest { + } + export interface GetAccountSettingsResponse { + /** + * Limits that are related to concurrency and code storage. + */ + AccountLimit?: AccountLimit; + /** + * The number of functions and amount of storage in use. + */ + AccountUsage?: AccountUsage; + } + export interface GetAliasRequest { + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The name of the alias. + */ + Name: Alias; + } + export interface GetEventSourceMappingRequest { + /** + * The identifier of the event source mapping. + */ + UUID: String; + } + export interface GetFunctionConfigurationRequest { + /** + * The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: NamespacedFunctionName; + /** + * Specify a version or alias to get details about a published version of the function. + */ + Qualifier?: Qualifier; + } + export interface GetFunctionRequest { + /** + * The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: NamespacedFunctionName; + /** + * Specify a version or alias to get details about a published version of the function. + */ + Qualifier?: Qualifier; + } + export interface GetFunctionResponse { + /** + * The configuration of the function or version. + */ + Configuration?: FunctionConfiguration; + /** + * The deployment package of the function or version. + */ + Code?: FunctionCodeLocation; + /** + * The function's tags. + */ + Tags?: Tags; + /** + * The function's reserved concurrency. + */ + Concurrency?: Concurrency; + } + export interface GetLayerVersionByArnRequest { + /** + * The ARN of the layer version. + */ + Arn: LayerVersionArn; + } + export interface GetLayerVersionPolicyRequest { + /** + * The name or Amazon Resource Name (ARN) of the layer. + */ + LayerName: LayerName; + /** + * The version number. + */ + VersionNumber: LayerVersionNumber; + } + export interface GetLayerVersionPolicyResponse { + /** + * The policy document. + */ + Policy?: String; + /** + * A unique identifier for the current revision of the policy. + */ + RevisionId?: String; + } + export interface GetLayerVersionRequest { + /** + * The name or Amazon Resource Name (ARN) of the layer. + */ + LayerName: LayerName; + /** + * The version number. + */ + VersionNumber: LayerVersionNumber; + } + export interface GetLayerVersionResponse { + /** + * Details about the layer version. + */ + Content?: LayerVersionContentOutput; + /** + * The ARN of the layer. + */ + LayerArn?: LayerArn; + /** + * The ARN of the layer version. + */ + LayerVersionArn?: LayerVersionArn; + /** + * The description of the version. + */ + Description?: Description; + /** + * The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). + */ + CreatedDate?: Timestamp; + /** + * The version number. + */ + Version?: LayerVersionNumber; + /** + * The layer's compatible runtimes. + */ + CompatibleRuntimes?: CompatibleRuntimes; + /** + * The layer's software license. + */ + LicenseInfo?: LicenseInfo; + } + export interface GetPolicyRequest { + /** + * The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: NamespacedFunctionName; + /** + * Specify a version or alias to get the policy for that resource. + */ + Qualifier?: Qualifier; + } + export interface GetPolicyResponse { + /** + * The resource-based policy. + */ + Policy?: String; + /** + * A unique identifier for the current revision of the policy. + */ + RevisionId?: String; + } + export type Handler = string; + export type HttpStatus = number; + export type Integer = number; + export interface InvocationRequest { + /** + * The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: NamespacedFunctionName; + /** + * Choose from the following options. RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data. Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code. DryRun - Validate parameter values and verify that the user or role has permission to invoke the function. + */ + InvocationType?: InvocationType; + /** + * Set to Tail to include the execution log in the response. + */ + LogType?: LogType; + /** + * Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. + */ + ClientContext?: String; + /** + * The JSON that you want to provide to your Lambda function as input. + */ + Payload?: _Blob; + /** + * Specify a version or alias to invoke a published version of the function. + */ + Qualifier?: Qualifier; + } + export interface InvocationResponse { + /** + * The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204. + */ + StatusCode?: Integer; + /** + * If present, indicates that an error occurred during function execution. Details about the error are included in the response payload. Handled - The runtime caught an error thrown by the function and formatted it into a JSON document. Unhandled - The runtime didn't handle the error. For example, the function ran out of memory or timed out. + */ + FunctionError?: String; + /** + * The last 4 KB of the execution log, which is base64 encoded. + */ + LogResult?: String; + /** + * The response from the function, or an error object. + */ + Payload?: _Blob; + /** + * The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to. + */ + ExecutedVersion?: Version; + } + export type InvocationType = "Event"|"RequestResponse"|"DryRun"|string; + export interface InvokeAsyncRequest { + /** + * The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: NamespacedFunctionName; + /** + * The JSON that you want to provide to your Lambda function as input. + */ + InvokeArgs: BlobStream; + } + export interface InvokeAsyncResponse { + /** + * The status code. + */ + Status?: HttpStatus; + } + export type KMSKeyArn = string; + export interface Layer { + /** + * The Amazon Resource Name (ARN) of the function layer. + */ + Arn?: LayerVersionArn; + /** + * The size of the layer archive in bytes. + */ + CodeSize?: Long; + } + export type LayerArn = string; + export type LayerList = LayerVersionArn[]; + export type LayerName = string; + export type LayerPermissionAllowedAction = string; + export type LayerPermissionAllowedPrincipal = string; + export type LayerVersionArn = string; + export interface LayerVersionContentInput { + /** + * The Amazon S3 bucket of the layer archive. + */ + S3Bucket?: S3Bucket; + /** + * The Amazon S3 key of the layer archive. + */ + S3Key?: S3Key; + /** + * For versioned objects, the version of the layer archive object to use. + */ + S3ObjectVersion?: S3ObjectVersion; + /** + * The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you. + */ + ZipFile?: _Blob; + } + export interface LayerVersionContentOutput { + /** + * A link to the layer archive in Amazon S3 that is valid for 10 minutes. + */ + Location?: String; + /** + * The SHA-256 hash of the layer archive. + */ + CodeSha256?: String; + /** + * The size of the layer archive in bytes. + */ + CodeSize?: Long; + } + export type LayerVersionNumber = number; + export type LayerVersionsList = LayerVersionsListItem[]; + export interface LayerVersionsListItem { + /** + * The ARN of the layer version. + */ + LayerVersionArn?: LayerVersionArn; + /** + * The version number. + */ + Version?: LayerVersionNumber; + /** + * The description of the version. + */ + Description?: Description; + /** + * The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000. + */ + CreatedDate?: Timestamp; + /** + * The layer's compatible runtimes. + */ + CompatibleRuntimes?: CompatibleRuntimes; + /** + * The layer's open-source license. + */ + LicenseInfo?: LicenseInfo; + } + export type LayersList = LayersListItem[]; + export interface LayersListItem { + /** + * The name of the layer. + */ + LayerName?: LayerName; + /** + * The Amazon Resource Name (ARN) of the function layer. + */ + LayerArn?: LayerArn; + /** + * The newest version of the layer. + */ + LatestMatchingVersion?: LayerVersionsListItem; + } + export type LayersReferenceList = Layer[]; + export type LicenseInfo = string; + export interface ListAliasesRequest { + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * Specify a function version to only list aliases that invoke that version. + */ + FunctionVersion?: Version; + /** + * Specify the pagination token that's returned by a previous request to retrieve the next page of results. + */ + Marker?: String; + /** + * Limit the number of aliases returned. + */ + MaxItems?: MaxListItems; + } + export interface ListAliasesResponse { + /** + * The pagination token that's included if more results are available. + */ + NextMarker?: String; + /** + * A list of aliases. + */ + Aliases?: AliasList; + } + export interface ListEventSourceMappingsRequest { + /** + * The Amazon Resource Name (ARN) of the event source. Amazon Kinesis - The ARN of the data stream or a stream consumer. Amazon DynamoDB Streams - The ARN of the stream. Amazon Simple Queue Service - The ARN of the queue. + */ + EventSourceArn?: Arn; + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. + */ + FunctionName?: FunctionName; + /** + * A pagination token returned by a previous call. + */ + Marker?: String; + /** + * The maximum number of event source mappings to return. + */ + MaxItems?: MaxListItems; + } + export interface ListEventSourceMappingsResponse { + /** + * A pagination token that's returned when the response doesn't contain all event source mappings. + */ + NextMarker?: String; + /** + * A list of event source mappings. + */ + EventSourceMappings?: EventSourceMappingsList; + } + export interface ListFunctionsRequest { + /** + * For Lambda@Edge functions, the AWS Region of the master function. For example, us-east-2 or ALL. If specified, you must set FunctionVersion to ALL. + */ + MasterRegion?: MasterRegion; + /** + * Set to ALL to include entries for all published versions of each function. + */ + FunctionVersion?: FunctionVersion; + /** + * Specify the pagination token that's returned by a previous request to retrieve the next page of results. + */ + Marker?: String; + /** + * Specify a value between 1 and 50 to limit the number of functions in the response. + */ + MaxItems?: MaxListItems; + } + export interface ListFunctionsResponse { + /** + * The pagination token that's included if more results are available. + */ + NextMarker?: String; + /** + * A list of Lambda functions. + */ + Functions?: FunctionList; + } + export interface ListLayerVersionsRequest { + /** + * A runtime identifier. For example, go1.x. + */ + CompatibleRuntime?: Runtime; + /** + * The name or Amazon Resource Name (ARN) of the layer. + */ + LayerName: LayerName; + /** + * A pagination token returned by a previous call. + */ + Marker?: String; + /** + * The maximum number of versions to return. + */ + MaxItems?: MaxLayerListItems; + } + export interface ListLayerVersionsResponse { + /** + * A pagination token returned when the response doesn't contain all versions. + */ + NextMarker?: String; + /** + * A list of versions. + */ + LayerVersions?: LayerVersionsList; + } + export interface ListLayersRequest { + /** + * A runtime identifier. For example, go1.x. + */ + CompatibleRuntime?: Runtime; + /** + * A pagination token returned by a previous call. + */ + Marker?: String; + /** + * The maximum number of layers to return. + */ + MaxItems?: MaxLayerListItems; + } + export interface ListLayersResponse { + /** + * A pagination token returned when the response doesn't contain all layers. + */ + NextMarker?: String; + /** + * A list of function layers. + */ + Layers?: LayersList; + } + export interface ListTagsRequest { + /** + * The function's Amazon Resource Name (ARN). + */ + Resource: FunctionArn; + } + export interface ListTagsResponse { + /** + * The function's tags. + */ + Tags?: Tags; + } + export interface ListVersionsByFunctionRequest { + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: NamespacedFunctionName; + /** + * Specify the pagination token that's returned by a previous request to retrieve the next page of results. + */ + Marker?: String; + /** + * Limit the number of versions that are returned. + */ + MaxItems?: MaxListItems; + } + export interface ListVersionsByFunctionResponse { + /** + * The pagination token that's included if more results are available. + */ + NextMarker?: String; + /** + * A list of Lambda function versions. + */ + Versions?: FunctionList; + } + export type LogType = "None"|"Tail"|string; + export type Long = number; + export type MasterRegion = string; + export type MaxLayerListItems = number; + export type MaxListItems = number; + export type MemorySize = number; + export type NameSpacedFunctionArn = string; + export type NamespacedFunctionName = string; + export type NamespacedStatementId = string; + export type OrganizationId = string; + export type Principal = string; + export interface PublishLayerVersionRequest { + /** + * The name or Amazon Resource Name (ARN) of the layer. + */ + LayerName: LayerName; + /** + * The description of the version. + */ + Description?: Description; + /** + * The function layer archive. + */ + Content: LayerVersionContentInput; + /** + * A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions. + */ + CompatibleRuntimes?: CompatibleRuntimes; + /** + * The layer's software license. It can be any of the following: An SPDX license identifier. For example, MIT. The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT. The full text of the license. + */ + LicenseInfo?: LicenseInfo; + } + export interface PublishLayerVersionResponse { + /** + * Details about the layer version. + */ + Content?: LayerVersionContentOutput; + /** + * The ARN of the layer. + */ + LayerArn?: LayerArn; + /** + * The ARN of the layer version. + */ + LayerVersionArn?: LayerVersionArn; + /** + * The description of the version. + */ + Description?: Description; + /** + * The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). + */ + CreatedDate?: Timestamp; + /** + * The version number. + */ + Version?: LayerVersionNumber; + /** + * The layer's compatible runtimes. + */ + CompatibleRuntimes?: CompatibleRuntimes; + /** + * The layer's software license. + */ + LicenseInfo?: LicenseInfo; + } + export interface PublishVersionRequest { + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode. + */ + CodeSha256?: String; + /** + * A description for the version to override the description in the function configuration. + */ + Description?: Description; + /** + * Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it. + */ + RevisionId?: String; + } + export interface PutFunctionConcurrencyRequest { + /** + * The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The number of simultaneous executions to reserve for the function. + */ + ReservedConcurrentExecutions: ReservedConcurrentExecutions; + } + export type Qualifier = string; + export interface RemoveLayerVersionPermissionRequest { + /** + * The name or Amazon Resource Name (ARN) of the layer. + */ + LayerName: LayerName; + /** + * The version number. + */ + VersionNumber: LayerVersionNumber; + /** + * The identifier that was specified when the statement was added. + */ + StatementId: StatementId; + /** + * Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it. + */ + RevisionId?: String; + } + export interface RemovePermissionRequest { + /** + * The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * Statement ID of the permission to remove. + */ + StatementId: NamespacedStatementId; + /** + * Specify a version or alias to remove permissions from a published version of the function. + */ + Qualifier?: Qualifier; + /** + * Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it. + */ + RevisionId?: String; + } + export type ReservedConcurrentExecutions = number; + export type ResourceArn = string; + export type RoleArn = string; + export type Runtime = "nodejs"|"nodejs4.3"|"nodejs6.10"|"nodejs8.10"|"java8"|"python2.7"|"python3.6"|"python3.7"|"dotnetcore1.0"|"dotnetcore2.0"|"dotnetcore2.1"|"nodejs4.3-edge"|"go1.x"|"ruby2.5"|"provided"|string; + export type S3Bucket = string; + export type S3Key = string; + export type S3ObjectVersion = string; + export type SecurityGroupId = string; + export type SecurityGroupIds = SecurityGroupId[]; + export type SensitiveString = string; + export type SourceOwner = string; + export type StatementId = string; + export type String = string; + export type SubnetId = string; + export type SubnetIds = SubnetId[]; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export interface TagResourceRequest { + /** + * The function's Amazon Resource Name (ARN). + */ + Resource: FunctionArn; + /** + * A list of tags to apply to the function. + */ + Tags: Tags; + } + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export type Timeout = number; + export type Timestamp = string; + export interface TracingConfig { + /** + * The tracing mode. + */ + Mode?: TracingMode; + } + export interface TracingConfigResponse { + /** + * The tracing mode. + */ + Mode?: TracingMode; + } + export type TracingMode = "Active"|"PassThrough"|string; + export type UnreservedConcurrentExecutions = number; + export interface UntagResourceRequest { + /** + * The function's Amazon Resource Name (ARN). + */ + Resource: FunctionArn; + /** + * A list of tag keys to remove from the function. + */ + TagKeys: TagKeyList; + } + export interface UpdateAliasRequest { + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The name of the alias. + */ + Name: Alias; + /** + * The function version that the alias invokes. + */ + FunctionVersion?: Version; + /** + * A description of the alias. + */ + Description?: Description; + /** + * The routing configuration of the alias. + */ + RoutingConfig?: AliasRoutingConfiguration; + /** + * Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it. + */ + RevisionId?: String; + } + export interface UpdateEventSourceMappingRequest { + /** + * The identifier of the event source mapping. + */ + UUID: String; + /** + * The name of the Lambda function. Name formats Function name - MyFunction. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. Partial ARN - 123456789012:function:MyFunction. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. + */ + FunctionName?: FunctionName; + /** + * Disables the event source mapping to pause polling and invocation. + */ + Enabled?: Enabled; + /** + * The maximum number of items to retrieve in a single batch. Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max 1,000. Amazon Simple Queue Service - Default 10. Max 10. + */ + BatchSize?: BatchSize; + } + export interface UpdateFunctionCodeRequest { + /** + * The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you. + */ + ZipFile?: _Blob; + /** + * An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. + */ + S3Bucket?: S3Bucket; + /** + * The Amazon S3 key of the deployment package. + */ + S3Key?: S3Key; + /** + * For versioned objects, the version of the deployment package object to use. + */ + S3ObjectVersion?: S3ObjectVersion; + /** + * Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately. + */ + Publish?: Boolean; + /** + * Set to true to validate the request parameters and access permissions without modifying the function code. + */ + DryRun?: Boolean; + /** + * Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it. + */ + RevisionId?: String; + } + export interface UpdateFunctionConfigurationRequest { + /** + * The name of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + */ + FunctionName: FunctionName; + /** + * The Amazon Resource Name (ARN) of the function's execution role. + */ + Role?: RoleArn; + /** + * The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model. + */ + Handler?: Handler; + /** + * A description of the function. + */ + Description?: Description; + /** + * The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. + */ + Timeout?: Timeout; + /** + * The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB. + */ + MemorySize?: MemorySize; + /** + * For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings. + */ + VpcConfig?: VpcConfig; + /** + * Environment variables that are accessible from function code during execution. + */ + Environment?: Environment; + /** + * The identifier of the function's runtime. + */ + Runtime?: Runtime; + /** + * A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues. + */ + DeadLetterConfig?: DeadLetterConfig; + /** + * The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. + */ + KMSKeyArn?: KMSKeyArn; + /** + * Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray. + */ + TracingConfig?: TracingConfig; + /** + * Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it. + */ + RevisionId?: String; + /** + * A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. + */ + Layers?: LayerList; + } + export type Version = string; + export interface VpcConfig { + /** + * A list of VPC subnet IDs. + */ + SubnetIds?: SubnetIds; + /** + * A list of VPC security groups IDs. + */ + SecurityGroupIds?: SecurityGroupIds; + } + export interface VpcConfigResponse { + /** + * A list of VPC subnet IDs. + */ + SubnetIds?: SubnetIds; + /** + * A list of VPC security groups IDs. + */ + SecurityGroupIds?: SecurityGroupIds; + /** + * The ID of the VPC. + */ + VpcId?: VpcId; + } + export type VpcId = string; + export type Weight = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-11-11"|"2015-03-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Lambda client. + */ + export import Types = Lambda; +} +export = Lambda; diff --git a/node_modules/aws-sdk/clients/lambda.js b/node_modules/aws-sdk/clients/lambda.js new file mode 100644 index 0000000..0d041d0 --- /dev/null +++ b/node_modules/aws-sdk/clients/lambda.js @@ -0,0 +1,28 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['lambda'] = {}; +AWS.Lambda = Service.defineService('lambda', ['2014-11-11', '2015-03-31']); +require('../lib/services/lambda'); +Object.defineProperty(apiLoader.services['lambda'], '2014-11-11', { + get: function get() { + var model = require('../apis/lambda-2014-11-11.min.json'); + model.paginators = require('../apis/lambda-2014-11-11.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['lambda'], '2015-03-31', { + get: function get() { + var model = require('../apis/lambda-2015-03-31.min.json'); + model.paginators = require('../apis/lambda-2015-03-31.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Lambda; diff --git a/node_modules/aws-sdk/clients/lexmodelbuildingservice.d.ts b/node_modules/aws-sdk/clients/lexmodelbuildingservice.d.ts new file mode 100644 index 0000000..4d3f2b2 --- /dev/null +++ b/node_modules/aws-sdk/clients/lexmodelbuildingservice.d.ts @@ -0,0 +1,2023 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class LexModelBuildingService extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: LexModelBuildingService.Types.ClientConfiguration) + config: Config & LexModelBuildingService.Types.ClientConfiguration; + /** + * Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version. You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation. When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permission for the lex:CreateBotVersion action. + */ + createBotVersion(params: LexModelBuildingService.Types.CreateBotVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateBotVersionResponse) => void): Request; + /** + * Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version. You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation. When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permission for the lex:CreateBotVersion action. + */ + createBotVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateBotVersionResponse) => void): Request; + /** + * Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created. You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the lex:CreateIntentVersion action. + */ + createIntentVersion(params: LexModelBuildingService.Types.CreateIntentVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateIntentVersionResponse) => void): Request; + /** + * Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created. You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the lex:CreateIntentVersion action. + */ + createIntentVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateIntentVersionResponse) => void): Request; + /** + * Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created. You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation. When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions for the lex:CreateSlotTypeVersion action. + */ + createSlotTypeVersion(params: LexModelBuildingService.Types.CreateSlotTypeVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateSlotTypeVersionResponse) => void): Request; + /** + * Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created. You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation. When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions for the lex:CreateSlotTypeVersion action. + */ + createSlotTypeVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateSlotTypeVersionResponse) => void): Request; + /** + * Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action. + */ + deleteBot(params: LexModelBuildingService.Types.DeleteBotRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action. + */ + deleteBot(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an alias for the specified bot. You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful. + */ + deleteBotAlias(params: LexModelBuildingService.Types.DeleteBotAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an alias for the specified bot. You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful. + */ + deleteBotAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action. + */ + deleteBotChannelAssociation(params: LexModelBuildingService.Types.DeleteBotChannelAssociationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action. + */ + deleteBotChannelAssociation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the lex:DeleteBotVersion action. + */ + deleteBotVersion(params: LexModelBuildingService.Types.DeleteBotVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the lex:DeleteBotVersion action. + */ + deleteBotVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation. You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first. If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful. This operation requires permission for the lex:DeleteIntent action. + */ + deleteIntent(params: LexModelBuildingService.Types.DeleteIntentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation. You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first. If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful. This operation requires permission for the lex:DeleteIntent action. + */ + deleteIntent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the lex:DeleteIntentVersion action. + */ + deleteIntentVersion(params: LexModelBuildingService.Types.DeleteIntentVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the lex:DeleteIntentVersion action. + */ + deleteIntentVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation. You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful. This operation requires permission for the lex:DeleteSlotType action. + */ + deleteSlotType(params: LexModelBuildingService.Types.DeleteSlotTypeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation. You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful. This operation requires permission for the lex:DeleteSlotType action. + */ + deleteSlotType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the lex:DeleteSlotTypeVersion action. + */ + deleteSlotTypeVersion(params: LexModelBuildingService.Types.DeleteSlotTypeVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the lex:DeleteSlotTypeVersion action. + */ + deleteSlotTypeVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user. This operation requires permissions for the lex:DeleteUtterances action. + */ + deleteUtterances(params: LexModelBuildingService.Types.DeleteUtterancesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user. This operation requires permissions for the lex:DeleteUtterances action. + */ + deleteUtterances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the lex:GetBot action. + */ + getBot(params: LexModelBuildingService.Types.GetBotRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotResponse) => void): Request; + /** + * Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the lex:GetBot action. + */ + getBot(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotResponse) => void): Request; + /** + * Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action. + */ + getBotAlias(params: LexModelBuildingService.Types.GetBotAliasRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasResponse) => void): Request; + /** + * Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action. + */ + getBotAlias(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasResponse) => void): Request; + /** + * Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action. + */ + getBotAliases(params: LexModelBuildingService.Types.GetBotAliasesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasesResponse) => void): Request; + /** + * Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action. + */ + getBotAliases(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasesResponse) => void): Request; + /** + * Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action. + */ + getBotChannelAssociation(params: LexModelBuildingService.Types.GetBotChannelAssociationRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationResponse) => void): Request; + /** + * Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action. + */ + getBotChannelAssociation(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationResponse) => void): Request; + /** + * Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action. + */ + getBotChannelAssociations(params: LexModelBuildingService.Types.GetBotChannelAssociationsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationsResponse) => void): Request; + /** + * Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action. + */ + getBotChannelAssociations(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationsResponse) => void): Request; + /** + * Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetBotVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetBotVersions action. + */ + getBotVersions(params: LexModelBuildingService.Types.GetBotVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotVersionsResponse) => void): Request; + /** + * Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetBotVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetBotVersions action. + */ + getBotVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotVersionsResponse) => void): Request; + /** + * Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string. If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots. This operation requires permission for the lex:GetBots action. + */ + getBots(params: LexModelBuildingService.Types.GetBotsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotsResponse) => void): Request; + /** + * Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string. If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots. This operation requires permission for the lex:GetBots action. + */ + getBots(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotsResponse) => void): Request; + /** + * Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action. + */ + getBuiltinIntent(params: LexModelBuildingService.Types.GetBuiltinIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentResponse) => void): Request; + /** + * Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action. + */ + getBuiltinIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentResponse) => void): Request; + /** + * Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action. + */ + getBuiltinIntents(params: LexModelBuildingService.Types.GetBuiltinIntentsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentsResponse) => void): Request; + /** + * Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action. + */ + getBuiltinIntents(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentsResponse) => void): Request; + /** + * Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes action. + */ + getBuiltinSlotTypes(params: LexModelBuildingService.Types.GetBuiltinSlotTypesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinSlotTypesResponse) => void): Request; + /** + * Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes action. + */ + getBuiltinSlotTypes(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinSlotTypesResponse) => void): Request; + /** + * Exports the contents of a Amazon Lex resource in a specified format. + */ + getExport(params: LexModelBuildingService.Types.GetExportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetExportResponse) => void): Request; + /** + * Exports the contents of a Amazon Lex resource in a specified format. + */ + getExport(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetExportResponse) => void): Request; + /** + * Gets information about an import job started with the StartImport operation. + */ + getImport(params: LexModelBuildingService.Types.GetImportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetImportResponse) => void): Request; + /** + * Gets information about an import job started with the StartImport operation. + */ + getImport(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetImportResponse) => void): Request; + /** + * Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the lex:GetIntent action. + */ + getIntent(params: LexModelBuildingService.Types.GetIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentResponse) => void): Request; + /** + * Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the lex:GetIntent action. + */ + getIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentResponse) => void): Request; + /** + * Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetIntentVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetIntentVersions action. + */ + getIntentVersions(params: LexModelBuildingService.Types.GetIntentVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentVersionsResponse) => void): Request; + /** + * Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetIntentVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetIntentVersions action. + */ + getIntentVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentVersionsResponse) => void): Request; + /** + * Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all intents. The operation requires permission for the lex:GetIntents action. + */ + getIntents(params: LexModelBuildingService.Types.GetIntentsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentsResponse) => void): Request; + /** + * Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all intents. The operation requires permission for the lex:GetIntents action. + */ + getIntents(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentsResponse) => void): Request; + /** + * Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version. This operation requires permissions for the lex:GetSlotType action. + */ + getSlotType(params: LexModelBuildingService.Types.GetSlotTypeRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeResponse) => void): Request; + /** + * Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version. This operation requires permissions for the lex:GetSlotType action. + */ + getSlotType(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeResponse) => void): Request; + /** + * Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetSlotTypeVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action. + */ + getSlotTypeVersions(params: LexModelBuildingService.Types.GetSlotTypeVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeVersionsResponse) => void): Request; + /** + * Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetSlotTypeVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action. + */ + getSlotTypeVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeVersionsResponse) => void): Request; + /** + * Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all slot types. The operation requires permission for the lex:GetSlotTypes action. + */ + getSlotTypes(params: LexModelBuildingService.Types.GetSlotTypesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypesResponse) => void): Request; + /** + * Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all slot types. The operation requires permission for the lex:GetSlotTypes action. + */ + getSlotTypes(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypesResponse) => void): Request; + /** + * Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance. After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version. This operation requires permissions for the lex:GetUtterancesView action. + */ + getUtterancesView(params: LexModelBuildingService.Types.GetUtterancesViewRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetUtterancesViewResponse) => void): Request; + /** + * Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance. After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version. This operation requires permissions for the lex:GetUtterancesView action. + */ + getUtterancesView(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetUtterancesViewResponse) => void): Request; + /** + * Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control. + */ + putBot(params: LexModelBuildingService.Types.PutBotRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request; + /** + * Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control. + */ + putBot(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request; + /** + * Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:PutBotAlias action. + */ + putBotAlias(params: LexModelBuildingService.Types.PutBotAliasRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request; + /** + * Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:PutBotAlias action. + */ + putBotAlias(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request; + /** + * Creates an intent or replaces an existing intent. To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent. To create an intent or replace an existing intent, you must provide the following: Intent name. For example, OrderPizza. Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza." Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza. How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. You can specify other optional information in the request, such as: A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order." A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?" If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action. + */ + putIntent(params: LexModelBuildingService.Types.PutIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request; + /** + * Creates an intent or replaces an existing intent. To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent. To create an intent or replace an existing intent, you must provide the following: Intent name. For example, OrderPizza. Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza." Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza. How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. You can specify other optional information in the request, such as: A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order." A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?" If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action. + */ + putIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request; + /** + * Creates a custom slot type or replaces an existing custom slot type. To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT. This operation requires permissions for the lex:PutSlotType action. + */ + putSlotType(params: LexModelBuildingService.Types.PutSlotTypeRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request; + /** + * Creates a custom slot type or replaces an existing custom slot type. To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT. This operation requires permissions for the lex:PutSlotType action. + */ + putSlotType(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request; + /** + * Starts a job to import a resource to Amazon Lex. + */ + startImport(params: LexModelBuildingService.Types.StartImportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request; + /** + * Starts a job to import a resource to Amazon Lex. + */ + startImport(callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request; +} +declare namespace LexModelBuildingService { + export type AliasName = string; + export type AliasNameOrListAll = string; + export type _Blob = Buffer|Uint8Array|Blob|string; + export type Boolean = boolean; + export interface BotAliasMetadata { + /** + * The name of the bot alias. + */ + name?: AliasName; + /** + * A description of the bot alias. + */ + description?: Description; + /** + * The version of the Amazon Lex bot to which the alias points. + */ + botVersion?: Version; + /** + * The name of the bot to which the alias points. + */ + botName?: BotName; + /** + * The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the bot alias was created. + */ + createdDate?: Timestamp; + /** + * Checksum of the bot alias. + */ + checksum?: String; + } + export type BotAliasMetadataList = BotAliasMetadata[]; + export interface BotChannelAssociation { + /** + * The name of the association between the bot and the channel. + */ + name?: BotChannelName; + /** + * A text description of the association you are creating. + */ + description?: Description; + /** + * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made. + */ + botAlias?: AliasName; + /** + * The name of the Amazon Lex bot to which this association is being made. Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio. + */ + botName?: BotName; + /** + * The date that the association between the Amazon Lex bot and the channel was created. + */ + createdDate?: Timestamp; + /** + * Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform. + */ + type?: ChannelType; + /** + * Provides information necessary to communicate with the messaging platform. + */ + botConfiguration?: ChannelConfigurationMap; + /** + * The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field. + */ + status?: ChannelStatus; + /** + * If status is FAILED, Amazon Lex provides the reason that it failed to create the association. + */ + failureReason?: String; + } + export type BotChannelAssociationList = BotChannelAssociation[]; + export type BotChannelName = string; + export interface BotMetadata { + /** + * The name of the bot. + */ + name?: BotName; + /** + * A description of the bot. + */ + description?: Description; + /** + * The status of the bot. + */ + status?: Status; + /** + * The date that the bot was updated. When you create a bot, the creation date and last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the bot was created. + */ + createdDate?: Timestamp; + /** + * The version of the bot. For a new bot, the version is always $LATEST. + */ + version?: Version; + } + export type BotMetadataList = BotMetadata[]; + export type BotName = string; + export type BotVersions = Version[]; + export interface BuiltinIntentMetadata { + /** + * A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. + */ + signature?: BuiltinIntentSignature; + /** + * A list of identifiers for the locales that the intent supports. + */ + supportedLocales?: LocaleList; + } + export type BuiltinIntentMetadataList = BuiltinIntentMetadata[]; + export type BuiltinIntentSignature = string; + export interface BuiltinIntentSlot { + /** + * A list of the slots defined for the intent. + */ + name?: String; + } + export type BuiltinIntentSlotList = BuiltinIntentSlot[]; + export interface BuiltinSlotTypeMetadata { + /** + * A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit. + */ + signature?: BuiltinSlotTypeSignature; + /** + * A list of target locales for the slot. + */ + supportedLocales?: LocaleList; + } + export type BuiltinSlotTypeMetadataList = BuiltinSlotTypeMetadata[]; + export type BuiltinSlotTypeSignature = string; + export type ChannelConfigurationMap = {[key: string]: String}; + export type ChannelStatus = "IN_PROGRESS"|"CREATED"|"FAILED"|string; + export type ChannelType = "Facebook"|"Slack"|"Twilio-Sms"|"Kik"|string; + export interface CodeHook { + /** + * The Amazon Resource Name (ARN) of the Lambda function. + */ + uri: LambdaARN; + /** + * The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda. + */ + messageVersion: MessageVersion; + } + export type ContentString = string; + export type ContentType = "PlainText"|"SSML"|"CustomPayload"|string; + export type Count = number; + export interface CreateBotVersionRequest { + /** + * The name of the bot that you want to create a new version of. The name is case sensitive. + */ + name: BotName; + /** + * Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the $LATEST version of the bot has a different checksum, a PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version. + */ + checksum?: String; + } + export interface CreateBotVersionResponse { + /** + * The name of the bot. + */ + name?: BotName; + /** + * A description of the bot. + */ + description?: Description; + /** + * An array of Intent objects. For more information, see PutBot. + */ + intents?: IntentList; + /** + * The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot. + */ + clarificationPrompt?: Prompt; + /** + * The message that Amazon Lex uses to abort a conversation. For more information, see PutBot. + */ + abortStatement?: Statement; + /** + * When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element. + */ + status?: Status; + /** + * If status is FAILED, Amazon Lex provides the reason that it failed to build the bot. + */ + failureReason?: String; + /** + * The date when the $LATEST version of this bot was updated. + */ + lastUpdatedDate?: Timestamp; + /** + * The date when the bot version was created. + */ + createdDate?: Timestamp; + /** + * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot. + */ + idleSessionTTLInSeconds?: SessionTTL; + /** + * The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user. + */ + voiceId?: String; + /** + * Checksum identifying the version of the bot that was created. + */ + checksum?: String; + /** + * The version of the bot. + */ + version?: Version; + /** + * Specifies the target locale for the bot. + */ + locale?: Locale; + /** + * For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. + */ + childDirected?: Boolean; + } + export interface CreateIntentVersionRequest { + /** + * The name of the intent that you want to create a new version of. The name is case sensitive. + */ + name: IntentName; + /** + * Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version. + */ + checksum?: String; + } + export interface CreateIntentVersionResponse { + /** + * The name of the intent. + */ + name?: IntentName; + /** + * A description of the intent. + */ + description?: Description; + /** + * An array of slot types that defines the information required to fulfill the intent. + */ + slots?: SlotList; + /** + * An array of sample utterances configured for the intent. + */ + sampleUtterances?: IntentUtteranceList; + /** + * If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it. + */ + confirmationPrompt?: Prompt; + /** + * If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled. + */ + rejectionStatement?: Statement; + /** + * If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. + */ + followUpPrompt?: FollowUpPrompt; + /** + * After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user. + */ + conclusionStatement?: Statement; + /** + * If defined, Amazon Lex invokes this Lambda function for each user input. + */ + dialogCodeHook?: CodeHook; + /** + * Describes how the intent is fulfilled. + */ + fulfillmentActivity?: FulfillmentActivity; + /** + * A unique identifier for a built-in intent. + */ + parentIntentSignature?: BuiltinIntentSignature; + /** + * The date that the intent was updated. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the intent was created. + */ + createdDate?: Timestamp; + /** + * The version number assigned to the new version of the intent. + */ + version?: Version; + /** + * Checksum of the intent version created. + */ + checksum?: String; + } + export interface CreateSlotTypeVersionRequest { + /** + * The name of the slot type that you want to create a new version for. The name is case sensitive. + */ + name: SlotTypeName; + /** + * Checksum for the $LATEST version of the slot type that you want to publish. If you specify a checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version. + */ + checksum?: String; + } + export interface CreateSlotTypeVersionResponse { + /** + * The name of the slot type. + */ + name?: SlotTypeName; + /** + * A description of the slot type. + */ + description?: Description; + /** + * A list of EnumerationValue objects that defines the values that the slot type can take. + */ + enumerationValues?: EnumerationValues; + /** + * The date that the slot type was updated. When you create a resource, the creation date and last update date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the slot type was created. + */ + createdDate?: Timestamp; + /** + * The version assigned to the new slot type version. + */ + version?: Version; + /** + * Checksum of the $LATEST version of the slot type. + */ + checksum?: String; + /** + * The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType. + */ + valueSelectionStrategy?: SlotValueSelectionStrategy; + } + export type CustomOrBuiltinSlotTypeName = string; + export interface DeleteBotAliasRequest { + /** + * The name of the alias to delete. The name is case sensitive. + */ + name: AliasName; + /** + * The name of the bot that the alias points to. + */ + botName: BotName; + } + export interface DeleteBotChannelAssociationRequest { + /** + * The name of the association. The name is case sensitive. + */ + name: BotChannelName; + /** + * The name of the Amazon Lex bot. + */ + botName: BotName; + /** + * An alias that points to the specific version of the Amazon Lex bot to which this association is being made. + */ + botAlias: AliasName; + } + export interface DeleteBotRequest { + /** + * The name of the bot. The name is case sensitive. + */ + name: BotName; + } + export interface DeleteBotVersionRequest { + /** + * The name of the bot. + */ + name: BotName; + /** + * The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the DeleteBot operation. + */ + version: NumericalVersion; + } + export interface DeleteIntentRequest { + /** + * The name of the intent. The name is case sensitive. + */ + name: IntentName; + } + export interface DeleteIntentVersionRequest { + /** + * The name of the intent. + */ + name: IntentName; + /** + * The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the DeleteIntent operation. + */ + version: NumericalVersion; + } + export interface DeleteSlotTypeRequest { + /** + * The name of the slot type. The name is case sensitive. + */ + name: SlotTypeName; + } + export interface DeleteSlotTypeVersionRequest { + /** + * The name of the slot type. + */ + name: SlotTypeName; + /** + * The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the DeleteSlotType operation. + */ + version: NumericalVersion; + } + export interface DeleteUtterancesRequest { + /** + * The name of the bot that stored the utterances. + */ + botName: BotName; + /** + * The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance. + */ + userId: UserId; + } + export type Description = string; + export interface EnumerationValue { + /** + * The value of the slot type. + */ + value: Value; + /** + * Additional values related to the slot type value. + */ + synonyms?: SynonymList; + } + export type EnumerationValues = EnumerationValue[]; + export type ExportStatus = "IN_PROGRESS"|"READY"|"FAILED"|string; + export type ExportType = "ALEXA_SKILLS_KIT"|"LEX"|string; + export interface FollowUpPrompt { + /** + * Prompts for information from the user. + */ + prompt: Prompt; + /** + * If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled. + */ + rejectionStatement: Statement; + } + export interface FulfillmentActivity { + /** + * How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application. + */ + type: FulfillmentActivityType; + /** + * A description of the Lambda function that is run to fulfill the intent. + */ + codeHook?: CodeHook; + } + export type FulfillmentActivityType = "ReturnIntent"|"CodeHook"|string; + export interface GetBotAliasRequest { + /** + * The name of the bot alias. The name is case sensitive. + */ + name: AliasName; + /** + * The name of the bot. + */ + botName: BotName; + } + export interface GetBotAliasResponse { + /** + * The name of the bot alias. + */ + name?: AliasName; + /** + * A description of the bot alias. + */ + description?: Description; + /** + * The version of the bot that the alias points to. + */ + botVersion?: Version; + /** + * The name of the bot that the alias points to. + */ + botName?: BotName; + /** + * The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the bot alias was created. + */ + createdDate?: Timestamp; + /** + * Checksum of the bot alias. + */ + checksum?: String; + } + export interface GetBotAliasesRequest { + /** + * The name of the bot. + */ + botName: BotName; + /** + * A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of aliases to return in the response. The default is 50. . + */ + maxResults?: MaxResults; + /** + * Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." + */ + nameContains?: AliasName; + } + export interface GetBotAliasesResponse { + /** + * An array of BotAliasMetadata objects, each describing a bot alias. + */ + BotAliases?: BotAliasMetadataList; + /** + * A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request. + */ + nextToken?: NextToken; + } + export interface GetBotChannelAssociationRequest { + /** + * The name of the association between the bot and the channel. The name is case sensitive. + */ + name: BotChannelName; + /** + * The name of the Amazon Lex bot. + */ + botName: BotName; + /** + * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made. + */ + botAlias: AliasName; + } + export interface GetBotChannelAssociationResponse { + /** + * The name of the association between the bot and the channel. + */ + name?: BotChannelName; + /** + * A description of the association between the bot and the channel. + */ + description?: Description; + /** + * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made. + */ + botAlias?: AliasName; + /** + * The name of the Amazon Lex bot. + */ + botName?: BotName; + /** + * The date that the association between the bot and the channel was created. + */ + createdDate?: Timestamp; + /** + * The type of the messaging platform. + */ + type?: ChannelType; + /** + * Provides information that the messaging platform needs to communicate with the Amazon Lex bot. + */ + botConfiguration?: ChannelConfigurationMap; + /** + * The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field. + */ + status?: ChannelStatus; + /** + * If status is FAILED, Amazon Lex provides the reason that it failed to create the association. + */ + failureReason?: String; + } + export interface GetBotChannelAssociationsRequest { + /** + * The name of the Amazon Lex bot in the association. + */ + botName: BotName; + /** + * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made. + */ + botAlias: AliasNameOrListAll; + /** + * A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of associations to return in the response. The default is 50. + */ + maxResults?: MaxResults; + /** + * Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter. + */ + nameContains?: BotChannelName; + } + export interface GetBotChannelAssociationsResponse { + /** + * An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel. + */ + botChannelAssociations?: BotChannelAssociationList; + /** + * A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request. + */ + nextToken?: NextToken; + } + export interface GetBotRequest { + /** + * The name of the bot. The name is case sensitive. + */ + name: BotName; + /** + * The version or alias of the bot. + */ + versionOrAlias: String; + } + export interface GetBotResponse { + /** + * The name of the bot. + */ + name?: BotName; + /** + * A description of the bot. + */ + description?: Description; + /** + * An array of intent objects. For more information, see PutBot. + */ + intents?: IntentList; + /** + * The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot. + */ + clarificationPrompt?: Prompt; + /** + * The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot. + */ + abortStatement?: Statement; + /** + * The status of the bot. If the bot is ready to run, the status is READY. If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT. + */ + status?: Status; + /** + * If status is FAILED, Amazon Lex explains why it failed to build the bot. + */ + failureReason?: String; + /** + * The date that the bot was updated. When you create a resource, the creation date and last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the bot was created. + */ + createdDate?: Timestamp; + /** + * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot. + */ + idleSessionTTLInSeconds?: SessionTTL; + /** + * The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot. + */ + voiceId?: String; + /** + * Checksum of the bot used to identify a specific revision of the bot's $LATEST version. + */ + checksum?: String; + /** + * The version of the bot. For a new bot, the version is always $LATEST. + */ + version?: Version; + /** + * The target locale for the bot. + */ + locale?: Locale; + /** + * For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. + */ + childDirected?: Boolean; + } + export interface GetBotVersionsRequest { + /** + * The name of the bot for which versions should be returned. + */ + name: BotName; + /** + * A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of bot versions to return in the response. The default is 10. + */ + maxResults?: MaxResults; + } + export interface GetBotVersionsResponse { + /** + * An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version. + */ + bots?: BotMetadataList; + /** + * A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. + */ + nextToken?: NextToken; + } + export interface GetBotsRequest { + /** + * A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of bots to return in the response that the request will return. The default is 10. + */ + maxResults?: MaxResults; + /** + * Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." + */ + nameContains?: BotName; + } + export interface GetBotsResponse { + /** + * An array of botMetadata objects, with one entry for each bot. + */ + bots?: BotMetadataList; + /** + * If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots. + */ + nextToken?: NextToken; + } + export interface GetBuiltinIntentRequest { + /** + * The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. + */ + signature: BuiltinIntentSignature; + } + export interface GetBuiltinIntentResponse { + /** + * The unique identifier for a built-in intent. + */ + signature?: BuiltinIntentSignature; + /** + * A list of locales that the intent supports. + */ + supportedLocales?: LocaleList; + /** + * An array of BuiltinIntentSlot objects, one entry for each slot type in the intent. + */ + slots?: BuiltinIntentSlotList; + } + export interface GetBuiltinIntentsRequest { + /** + * A list of locales that the intent supports. + */ + locale?: Locale; + /** + * Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. + */ + signatureContains?: String; + /** + * A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of intents to return in the response. The default is 10. + */ + maxResults?: MaxResults; + } + export interface GetBuiltinIntentsResponse { + /** + * An array of builtinIntentMetadata objects, one for each intent in the response. + */ + intents?: BuiltinIntentMetadataList; + /** + * A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request. + */ + nextToken?: NextToken; + } + export interface GetBuiltinSlotTypesRequest { + /** + * A list of locales that the slot type supports. + */ + locale?: Locale; + /** + * Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." + */ + signatureContains?: String; + /** + * A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of slot types to return in the response. The default is 10. + */ + maxResults?: MaxResults; + } + export interface GetBuiltinSlotTypesResponse { + /** + * An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned. + */ + slotTypes?: BuiltinSlotTypeMetadataList; + /** + * If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types. + */ + nextToken?: NextToken; + } + export interface GetExportRequest { + /** + * The name of the bot to export. + */ + name: Name; + /** + * The version of the bot to export. + */ + version: NumericalVersion; + /** + * The type of resource to export. + */ + resourceType: ResourceType; + /** + * The format of the exported data. + */ + exportType: ExportType; + } + export interface GetExportResponse { + /** + * The name of the bot being exported. + */ + name?: Name; + /** + * The version of the bot being exported. + */ + version?: NumericalVersion; + /** + * The type of the exported resource. + */ + resourceType?: ResourceType; + /** + * The format of the exported data. + */ + exportType?: ExportType; + /** + * The status of the export. IN_PROGRESS - The export is in progress. READY - The export is complete. FAILED - The export could not be completed. + */ + exportStatus?: ExportStatus; + /** + * If status is FAILED, Amazon Lex provides the reason that it failed to export the resource. + */ + failureReason?: String; + /** + * An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure. + */ + url?: String; + } + export interface GetImportRequest { + /** + * The identifier of the import job information to return. + */ + importId: String; + } + export interface GetImportResponse { + /** + * The name given to the import job. + */ + name?: Name; + /** + * The type of resource imported. + */ + resourceType?: ResourceType; + /** + * The action taken when there was a conflict between an existing resource and a resource in the import file. + */ + mergeStrategy?: MergeStrategy; + /** + * The identifier for the specific import job. + */ + importId?: String; + /** + * The status of the import job. If the status is FAILED, you can get the reason for the failure from the failureReason field. + */ + importStatus?: ImportStatus; + /** + * A string that describes why an import job failed to complete. + */ + failureReason?: StringList; + /** + * A timestamp for the date and time that the import job was created. + */ + createdDate?: Timestamp; + } + export interface GetIntentRequest { + /** + * The name of the intent. The name is case sensitive. + */ + name: IntentName; + /** + * The version of the intent. + */ + version: Version; + } + export interface GetIntentResponse { + /** + * The name of the intent. + */ + name?: IntentName; + /** + * A description of the intent. + */ + description?: Description; + /** + * An array of intent slots configured for the intent. + */ + slots?: SlotList; + /** + * An array of sample utterances configured for the intent. + */ + sampleUtterances?: IntentUtteranceList; + /** + * If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent. + */ + confirmationPrompt?: Prompt; + /** + * If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled. + */ + rejectionStatement?: Statement; + /** + * If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent. + */ + followUpPrompt?: FollowUpPrompt; + /** + * After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user. + */ + conclusionStatement?: Statement; + /** + * If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent. + */ + dialogCodeHook?: CodeHook; + /** + * Describes how the intent is fulfilled. For more information, see PutIntent. + */ + fulfillmentActivity?: FulfillmentActivity; + /** + * A unique identifier for a built-in intent. + */ + parentIntentSignature?: BuiltinIntentSignature; + /** + * The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the intent was created. + */ + createdDate?: Timestamp; + /** + * The version of the intent. + */ + version?: Version; + /** + * Checksum of the intent. + */ + checksum?: String; + } + export interface GetIntentVersionsRequest { + /** + * The name of the intent for which versions should be returned. + */ + name: IntentName; + /** + * A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of intent versions to return in the response. The default is 10. + */ + maxResults?: MaxResults; + } + export interface GetIntentVersionsResponse { + /** + * An array of IntentMetadata objects, one for each numbered version of the intent plus one for the $LATEST version. + */ + intents?: IntentMetadataList; + /** + * A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. + */ + nextToken?: NextToken; + } + export interface GetIntentsRequest { + /** + * A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of intents to return in the response. The default is 10. + */ + maxResults?: MaxResults; + /** + * Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." + */ + nameContains?: IntentName; + } + export interface GetIntentsResponse { + /** + * An array of Intent objects. For more information, see PutBot. + */ + intents?: IntentMetadataList; + /** + * If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents. + */ + nextToken?: NextToken; + } + export interface GetSlotTypeRequest { + /** + * The name of the slot type. The name is case sensitive. + */ + name: SlotTypeName; + /** + * The version of the slot type. + */ + version: Version; + } + export interface GetSlotTypeResponse { + /** + * The name of the slot type. + */ + name?: SlotTypeName; + /** + * A description of the slot type. + */ + description?: Description; + /** + * A list of EnumerationValue objects that defines the values that the slot type can take. + */ + enumerationValues?: EnumerationValues; + /** + * The date that the slot type was updated. When you create a resource, the creation date and last update date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the slot type was created. + */ + createdDate?: Timestamp; + /** + * The version of the slot type. + */ + version?: Version; + /** + * Checksum of the $LATEST version of the slot type. + */ + checksum?: String; + /** + * The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType. + */ + valueSelectionStrategy?: SlotValueSelectionStrategy; + } + export interface GetSlotTypeVersionsRequest { + /** + * The name of the slot type for which versions should be returned. + */ + name: SlotTypeName; + /** + * A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of slot type versions to return in the response. The default is 10. + */ + maxResults?: MaxResults; + } + export interface GetSlotTypeVersionsResponse { + /** + * An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for the $LATEST version. + */ + slotTypes?: SlotTypeMetadataList; + /** + * A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. + */ + nextToken?: NextToken; + } + export interface GetSlotTypesRequest { + /** + * A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request. + */ + nextToken?: NextToken; + /** + * The maximum number of slot types to return in the response. The default is 10. + */ + maxResults?: MaxResults; + /** + * Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." + */ + nameContains?: SlotTypeName; + } + export interface GetSlotTypesResponse { + /** + * An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description. + */ + slotTypes?: SlotTypeMetadataList; + /** + * If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types. + */ + nextToken?: NextToken; + } + export interface GetUtterancesViewRequest { + /** + * The name of the bot for which utterance information should be returned. + */ + botName: BotName; + /** + * An array of bot versions for which utterance information should be returned. The limit is 5 versions per request. + */ + botVersions: BotVersions; + /** + * To return utterances that were recognized and handled, useDetected. To return utterances that were not recognized, use Missed. + */ + statusType: StatusType; + } + export interface GetUtterancesViewResponse { + /** + * The name of the bot for which utterance information was returned. + */ + botName?: BotName; + /** + * An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version. + */ + utterances?: ListsOfUtterances; + } + export type GroupNumber = number; + export type ImportStatus = "IN_PROGRESS"|"COMPLETE"|"FAILED"|string; + export interface Intent { + /** + * The name of the intent. + */ + intentName: IntentName; + /** + * The version of the intent. + */ + intentVersion: Version; + } + export type IntentList = Intent[]; + export interface IntentMetadata { + /** + * The name of the intent. + */ + name?: IntentName; + /** + * A description of the intent. + */ + description?: Description; + /** + * The date that the intent was updated. When you create an intent, the creation date and last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the intent was created. + */ + createdDate?: Timestamp; + /** + * The version of the intent. + */ + version?: Version; + } + export type IntentMetadataList = IntentMetadata[]; + export type IntentName = string; + export type IntentUtteranceList = Utterance[]; + export type LambdaARN = string; + export type ListOfUtterance = UtteranceData[]; + export type ListsOfUtterances = UtteranceList[]; + export type Locale = "en-US"|"en-GB"|"de-DE"|string; + export type LocaleList = Locale[]; + export type MaxResults = number; + export type MergeStrategy = "OVERWRITE_LATEST"|"FAIL_ON_CONFLICT"|string; + export interface Message { + /** + * The content type of the message string. + */ + contentType: ContentType; + /** + * The text of the message. + */ + content: ContentString; + /** + * Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response. + */ + groupNumber?: GroupNumber; + } + export type MessageList = Message[]; + export type MessageVersion = string; + export type Name = string; + export type NextToken = string; + export type NumericalVersion = string; + export type Priority = number; + export type ProcessBehavior = "SAVE"|"BUILD"|string; + export interface Prompt { + /** + * An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML). + */ + messages: MessageList; + /** + * The number of times to prompt the user for information. + */ + maxAttempts: PromptMaxAttempts; + /** + * A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card. + */ + responseCard?: ResponseCard; + } + export type PromptMaxAttempts = number; + export interface PutBotAliasRequest { + /** + * The name of the alias. The name is not case sensitive. + */ + name: AliasName; + /** + * A description of the alias. + */ + description?: Description; + /** + * The version of the bot. + */ + botVersion: Version; + /** + * The name of the bot. + */ + botName: BotName; + /** + * Identifies a specific revision of the $LATEST version. When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception. + */ + checksum?: String; + } + export interface PutBotAliasResponse { + /** + * The name of the alias. + */ + name?: AliasName; + /** + * A description of the alias. + */ + description?: Description; + /** + * The version of the bot that the alias points to. + */ + botVersion?: Version; + /** + * The name of the bot that the alias points to. + */ + botName?: BotName; + /** + * The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the bot alias was created. + */ + createdDate?: Timestamp; + /** + * The checksum for the current version of the alias. + */ + checksum?: String; + } + export interface PutBotRequest { + /** + * The name of the bot. The name is not case sensitive. + */ + name: BotName; + /** + * A description of the bot. + */ + description?: Description; + /** + * An array of Intent objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works. + */ + intents?: IntentList; + /** + * When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeate the clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field. When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'" + */ + clarificationPrompt?: Prompt; + /** + * When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type. For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times. For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot. + */ + abortStatement?: Statement; + /** + * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout. For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over. If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot. The default is 300 seconds (5 minutes). + */ + idleSessionTTLInSeconds?: SessionTTL; + /** + * The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide. + */ + voiceId?: String; + /** + * Identifies a specific revision of the $LATEST version. When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a bot, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception. + */ + checksum?: String; + /** + * If you set the processBehavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. If you don't specify this value, the default value is BUILD. + */ + processBehavior?: ProcessBehavior; + /** + * Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. The default is en-US. + */ + locale: Locale; + /** + * For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. + */ + childDirected: Boolean; + createVersion?: Boolean; + } + export interface PutBotResponse { + /** + * The name of the bot. + */ + name?: BotName; + /** + * A description of the bot. + */ + description?: Description; + /** + * An array of Intent objects. For more information, see PutBot. + */ + intents?: IntentList; + /** + * The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot. + */ + clarificationPrompt?: Prompt; + /** + * The message that Amazon Lex uses to abort a conversation. For more information, see PutBot. + */ + abortStatement?: Statement; + /** + * When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element. When you set processBehaviorto SAVE, Amazon Lex sets the status code to NOT BUILT. + */ + status?: Status; + /** + * If status is FAILED, Amazon Lex provides the reason that it failed to build the bot. + */ + failureReason?: String; + /** + * The date that the bot was updated. When you create a resource, the creation date and last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the bot was created. + */ + createdDate?: Timestamp; + /** + * The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot. + */ + idleSessionTTLInSeconds?: SessionTTL; + /** + * The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot. + */ + voiceId?: String; + /** + * Checksum of the bot that you created. + */ + checksum?: String; + /** + * The version of the bot. For a new bot, the version is always $LATEST. + */ + version?: Version; + /** + * The target locale for the bot. + */ + locale?: Locale; + /** + * For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. + */ + childDirected?: Boolean; + createVersion?: Boolean; + } + export interface PutIntentRequest { + /** + * The name of the intent. The name is not case sensitive. The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent. For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit. + */ + name: IntentName; + /** + * A description of the intent. + */ + description?: Description; + /** + * An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works. + */ + slots?: SlotList; + /** + * An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". In each utterance, a slot name is enclosed in curly braces. + */ + sampleUtterances?: IntentUtteranceList; + /** + * Prompts the user to confirm the intent. This question should have a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information. You you must provide both the rejectionStatement and the confirmationPrompt, or neither. + */ + confirmationPrompt?: Prompt; + /** + * When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled. You must provide both the rejectionStatement and the confirmationPrompt, or neither. + */ + rejectionStatement?: Statement; + /** + * Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink. The action that Amazon Lex takes depends on the user's response, as follows: If the user says "Yes" it responds with the clarification prompt that is configured for the bot. if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent. If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. If it doesn't recognize the utterance it repeats the follow-up prompt again. The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one. + */ + followUpPrompt?: FollowUpPrompt; + /** + * The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function. This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element. The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one. + */ + conclusionStatement?: Statement; + /** + * Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction. For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute. + */ + dialogCodeHook?: CodeHook; + /** + * Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store. You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). + */ + fulfillmentActivity?: FulfillmentActivity; + /** + * A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit. + */ + parentIntentSignature?: BuiltinIntentSignature; + /** + * Identifies a specific revision of the $LATEST version. When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a intent, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception. + */ + checksum?: String; + createVersion?: Boolean; + } + export interface PutIntentResponse { + /** + * The name of the intent. + */ + name?: IntentName; + /** + * A description of the intent. + */ + description?: Description; + /** + * An array of intent slots that are configured for the intent. + */ + slots?: SlotList; + /** + * An array of sample utterances that are configured for the intent. + */ + sampleUtterances?: IntentUtteranceList; + /** + * If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it. + */ + confirmationPrompt?: Prompt; + /** + * If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled. + */ + rejectionStatement?: Statement; + /** + * If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. + */ + followUpPrompt?: FollowUpPrompt; + /** + * After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex conveys this statement to the user. + */ + conclusionStatement?: Statement; + /** + * If defined in the intent, Amazon Lex invokes this Lambda function for each user input. + */ + dialogCodeHook?: CodeHook; + /** + * If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent. + */ + fulfillmentActivity?: FulfillmentActivity; + /** + * A unique identifier for the built-in intent that this intent is based on. + */ + parentIntentSignature?: BuiltinIntentSignature; + /** + * The date that the intent was updated. When you create a resource, the creation date and last update dates are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the intent was created. + */ + createdDate?: Timestamp; + /** + * The version of the intent. For a new intent, the version is always $LATEST. + */ + version?: Version; + /** + * Checksum of the $LATESTversion of the intent created or updated. + */ + checksum?: String; + createVersion?: Boolean; + } + export interface PutSlotTypeRequest { + /** + * The name of the slot type. The name is not case sensitive. The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called DATE. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. + */ + name: SlotTypeName; + /** + * A description of the slot type. + */ + description?: Description; + /** + * A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot. When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use. + */ + enumerationValues?: EnumerationValues; + /** + * Identifies a specific revision of the $LATEST version. When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception. + */ + checksum?: String; + /** + * Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE. + */ + valueSelectionStrategy?: SlotValueSelectionStrategy; + createVersion?: Boolean; + } + export interface PutSlotTypeResponse { + /** + * The name of the slot type. + */ + name?: SlotTypeName; + /** + * A description of the slot type. + */ + description?: Description; + /** + * A list of EnumerationValue objects that defines the values that the slot type can take. + */ + enumerationValues?: EnumerationValues; + /** + * The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the slot type was created. + */ + createdDate?: Timestamp; + /** + * The version of the slot type. For a new slot type, the version is always $LATEST. + */ + version?: Version; + /** + * Checksum of the $LATEST version of the slot type. + */ + checksum?: String; + /** + * The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType. + */ + valueSelectionStrategy?: SlotValueSelectionStrategy; + createVersion?: Boolean; + } + export type ResourceType = "BOT"|"INTENT"|"SLOT_TYPE"|string; + export type ResponseCard = string; + export type SessionTTL = number; + export interface Slot { + /** + * The name of the slot. + */ + name: SlotName; + /** + * A description of the slot. + */ + description?: Description; + /** + * Specifies whether the slot is required or optional. + */ + slotConstraint: SlotConstraint; + /** + * The type of the slot, either a custom slot type that you defined or one of the built-in slot types. + */ + slotType?: CustomOrBuiltinSlotTypeName; + /** + * The version of the slot type. + */ + slotTypeVersion?: Version; + /** + * The prompt that Amazon Lex uses to elicit the slot value from the user. + */ + valueElicitationPrompt?: Prompt; + /** + * Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1. If multiple slots share the same priority, the order in which Lex elicits values is arbitrary. + */ + priority?: Priority; + /** + * If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances. + */ + sampleUtterances?: SlotUtteranceList; + /** + * A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply. + */ + responseCard?: ResponseCard; + } + export type SlotConstraint = "Required"|"Optional"|string; + export type SlotList = Slot[]; + export type SlotName = string; + export interface SlotTypeMetadata { + /** + * The name of the slot type. + */ + name?: SlotTypeName; + /** + * A description of the slot type. + */ + description?: Description; + /** + * The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same. + */ + lastUpdatedDate?: Timestamp; + /** + * The date that the slot type was created. + */ + createdDate?: Timestamp; + /** + * The version of the slot type. + */ + version?: Version; + } + export type SlotTypeMetadataList = SlotTypeMetadata[]; + export type SlotTypeName = string; + export type SlotUtteranceList = Utterance[]; + export type SlotValueSelectionStrategy = "ORIGINAL_VALUE"|"TOP_RESOLUTION"|string; + export interface StartImportRequest { + /** + * A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field. + */ + payload: _Blob; + /** + * Specifies the type of resource to export. Each resource also exports any resources that it depends on. A bot exports dependent intents. An intent exports dependent slot types. + */ + resourceType: ResourceType; + /** + * Specifies the action that the StartImport operation should take when there is an existing resource with the same name. FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation. OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file. + */ + mergeStrategy: MergeStrategy; + } + export interface StartImportResponse { + /** + * The name given to the import job. + */ + name?: Name; + /** + * The type of resource to import. + */ + resourceType?: ResourceType; + /** + * The action to take when there is a merge conflict. + */ + mergeStrategy?: MergeStrategy; + /** + * The identifier for the specific import job. + */ + importId?: String; + /** + * The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation. + */ + importStatus?: ImportStatus; + /** + * A timestamp for the date and time that the import job was requested. + */ + createdDate?: Timestamp; + } + export interface Statement { + /** + * A collection of message objects. + */ + messages: MessageList; + /** + * At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card. + */ + responseCard?: ResponseCard; + } + export type Status = "BUILDING"|"READY"|"READY_BASIC_TESTING"|"FAILED"|"NOT_BUILT"|string; + export type StatusType = "Detected"|"Missed"|string; + export type String = string; + export type StringList = String[]; + export type SynonymList = Value[]; + export type Timestamp = Date; + export type UserId = string; + export type Utterance = string; + export interface UtteranceData { + /** + * The text that was entered by the user or the text representation of an audio clip. + */ + utteranceString?: UtteranceString; + /** + * The number of times that the utterance was processed. + */ + count?: Count; + /** + * The total number of individuals that used the utterance. + */ + distinctUsers?: Count; + /** + * The date that the utterance was first recorded. + */ + firstUtteredDate?: Timestamp; + /** + * The date that the utterance was last recorded. + */ + lastUtteredDate?: Timestamp; + } + export interface UtteranceList { + /** + * The version of the bot that processed the list. + */ + botVersion?: Version; + /** + * One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100. + */ + utterances?: ListOfUtterance; + } + export type UtteranceString = string; + export type Value = string; + export type Version = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-04-19"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the LexModelBuildingService client. + */ + export import Types = LexModelBuildingService; +} +export = LexModelBuildingService; diff --git a/node_modules/aws-sdk/clients/lexmodelbuildingservice.js b/node_modules/aws-sdk/clients/lexmodelbuildingservice.js new file mode 100644 index 0000000..41ff6a2 --- /dev/null +++ b/node_modules/aws-sdk/clients/lexmodelbuildingservice.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['lexmodelbuildingservice'] = {}; +AWS.LexModelBuildingService = Service.defineService('lexmodelbuildingservice', ['2017-04-19']); +Object.defineProperty(apiLoader.services['lexmodelbuildingservice'], '2017-04-19', { + get: function get() { + var model = require('../apis/lex-models-2017-04-19.min.json'); + model.paginators = require('../apis/lex-models-2017-04-19.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.LexModelBuildingService; diff --git a/node_modules/aws-sdk/clients/lexruntime.d.ts b/node_modules/aws-sdk/clients/lexruntime.d.ts new file mode 100644 index 0000000..44b1785 --- /dev/null +++ b/node_modules/aws-sdk/clients/lexruntime.d.ts @@ -0,0 +1,251 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Readable} from 'stream'; +interface Blob {} +declare class LexRuntime extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: LexRuntime.Types.ClientConfiguration) + config: Config & LexRuntime.Types.ClientConfiguration; + /** + * Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot. The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications. In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages: For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?". After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?". After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples: If the message is to elicit slot data, Amazon Lex returns the following context information: x-amz-lex-dialog-state header set to ElicitSlot x-amz-lex-intent-name header set to the intent name in the current context x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information x-amz-lex-slots header set to a map of slots configured for the intent with their current values If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted. If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted. In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context. + */ + postContent(params: LexRuntime.Types.PostContentRequest, callback?: (err: AWSError, data: LexRuntime.Types.PostContentResponse) => void): Request; + /** + * Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot. The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications. In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages: For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?". After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?". After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples: If the message is to elicit slot data, Amazon Lex returns the following context information: x-amz-lex-dialog-state header set to ElicitSlot x-amz-lex-intent-name header set to the intent name in the current context x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information x-amz-lex-slots header set to a map of slots configured for the intent with their current values If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted. If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted. In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context. + */ + postContent(callback?: (err: AWSError, data: LexRuntime.Types.PostContentResponse) => void): Request; + /** + * Sends user input (text-only) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot. In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages: For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?" After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?". After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples: If the message is to elicit slot data, Amazon Lex returns the following context information: dialogState set to ElicitSlot intentName set to the intent name in the current context slotToElicit set to the slot name for which the message is eliciting information slots set to a map of slots, configured for the intent, with currently known values If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null. If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null. In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context. + */ + postText(params: LexRuntime.Types.PostTextRequest, callback?: (err: AWSError, data: LexRuntime.Types.PostTextResponse) => void): Request; + /** + * Sends user input (text-only) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot. In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages: For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?" After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?". After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples: If the message is to elicit slot data, Amazon Lex returns the following context information: dialogState set to ElicitSlot intentName set to the intent name in the current context slotToElicit set to the slot name for which the message is eliciting information slots set to a map of slots, configured for the intent, with currently known values If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null. If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null. In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context. + */ + postText(callback?: (err: AWSError, data: LexRuntime.Types.PostTextResponse) => void): Request; +} +declare namespace LexRuntime { + export type Accept = string; + export type AttributesString = string; + export type BlobStream = Buffer|Uint8Array|Blob|string|Readable; + export type BotAlias = string; + export type BotName = string; + export interface Button { + /** + * Text that is visible to the user on the button. + */ + text: ButtonTextStringWithLength; + /** + * The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the user chooses the button, the value sent can be "New York City." + */ + value: ButtonValueStringWithLength; + } + export type ButtonTextStringWithLength = string; + export type ButtonValueStringWithLength = string; + export type ContentType = "application/vnd.amazonaws.card.generic"|string; + export type DialogState = "ElicitIntent"|"ConfirmIntent"|"ElicitSlot"|"Fulfilled"|"ReadyForFulfillment"|"Failed"|string; + export interface GenericAttachment { + /** + * The title of the option. + */ + title?: StringWithLength; + /** + * The subtitle shown below the title. + */ + subTitle?: StringWithLength; + /** + * The URL of an attachment to the response card. + */ + attachmentLinkUrl?: StringUrlWithLength; + /** + * The URL of an image that is displayed to the user. + */ + imageUrl?: StringUrlWithLength; + /** + * The list of options to show to the user. + */ + buttons?: listOfButtons; + } + export type HttpContentType = string; + export type IntentName = string; + export type MessageFormatType = "PlainText"|"CustomPayload"|"SSML"|"Composite"|string; + export interface PostContentRequest { + /** + * Name of the Amazon Lex bot. + */ + botName: BotName; + /** + * Alias of the Amazon Lex bot. + */ + botAlias: BotAlias; + /** + * The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field. To decide the user ID to use for your application, consider the following factors. The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information. If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier. If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier. A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations. + */ + userId: UserId; + /** + * You pass this value as the x-amz-lex-session-attributes HTTP header. Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB. For more information, see Setting Session Attributes. + */ + sessionAttributes?: AttributesString; + /** + * You pass this value as the x-amz-lex-request-attributes HTTP header. Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB. The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:. For more information, see Setting Request Attributes. + */ + requestAttributes?: AttributesString; + /** + * You pass this value as the Content-Type HTTP header. Indicates the audio format or text. The header value must start with one of the following prefixes: PCM format, audio data must be in little-endian byte order. audio/l16; rate=16000; channels=1 audio/x-l16; sample-rate=16000; channel-count=1 audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false Opus format audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4 Text format text/plain; charset=utf-8 + */ + contentType: HttpContentType; + /** + * You pass this value as the Accept HTTP header. The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request. If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response. If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format. The following are the accepted values: audio/mpeg audio/ogg audio/pcm text/plain; charset=utf-8 audio/* (defaults to mpeg) + */ + accept?: Accept; + /** + * User input in PCM or Opus audio format or text format as described in the Content-Type HTTP header. You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally. + */ + inputStream: BlobStream; + } + export interface PostContentResponse { + /** + * Content type as specified in the Accept HTTP header in the request. + */ + contentType?: HttpContentType; + /** + * Current user intent that Amazon Lex is aware of. + */ + intentName?: IntentName; + /** + * Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE. + */ + slots?: String; + /** + * Map of key/value pairs representing the session-specific context information. + */ + sessionAttributes?: String; + /** + * The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message. When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats. If the Lambda function returns a message, Amazon Lex passes it to the client in its response. + */ + message?: Text; + /** + * The format of the response message. One of the following values: PlainText - The message contains plain UTF-8 text. CustomPayload - The message is a custom format for the client. SSML - The message contains text formatted for voice output. Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created. + */ + messageFormat?: MessageFormatType; + /** + * Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface. ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples: For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state. ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response. For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink). ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent. For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent. ReadyForFulfillment - Conveys that the client has to fulfill the request. Failed - Conveys that the conversation with the user failed. This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent. + */ + dialogState?: DialogState; + /** + * If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value. + */ + slotToElicit?: String; + /** + * The text used to process the request. If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send. + */ + inputTranscript?: String; + /** + * The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response. + */ + audioStream?: BlobStream; + } + export interface PostTextRequest { + /** + * The name of the Amazon Lex bot. + */ + botName: BotName; + /** + * The alias of the Amazon Lex bot. + */ + botAlias: BotAlias; + /** + * The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field. To decide the user ID to use for your application, consider the following factors. The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information. If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier. If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier. A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations. + */ + userId: UserId; + /** + * Application-specific information passed between Amazon Lex and a client application. For more information, see Setting Session Attributes. + */ + sessionAttributes?: StringMap; + /** + * Request-specific information passed between Amazon Lex and a client application. The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:. For more information, see Setting Request Attributes. + */ + requestAttributes?: StringMap; + /** + * The text that the user entered (Amazon Lex interprets this text). + */ + inputText: Text; + } + export interface PostTextResponse { + /** + * The current user intent that Amazon Lex is aware of. + */ + intentName?: IntentName; + /** + * The intent slots that Amazon Lex detected from the user input in the conversation. Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE. + */ + slots?: StringMap; + /** + * A map of key-value pairs representing the session-specific context information. + */ + sessionAttributes?: StringMap; + /** + * The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message. When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats. If the Lambda function returns a message, Amazon Lex passes it to the client in its response. + */ + message?: Text; + /** + * The format of the response message. One of the following values: PlainText - The message contains plain UTF-8 text. CustomPayload - The message is a custom format defined by the Lambda function. SSML - The message contains text formatted for voice output. Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created. + */ + messageFormat?: MessageFormatType; + /** + * Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface. ElicitIntent - Amazon Lex wants to elicit user intent. For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState. ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response. For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink). ElicitSlot - Amazon Lex is expecting a slot value for the current intent. For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent. ReadyForFulfillment - Conveys that the client has to fulfill the intent. Failed - Conveys that the conversation with the user failed. This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent. + */ + dialogState?: DialogState; + /** + * If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value. + */ + slotToElicit?: String; + /** + * Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function). + */ + responseCard?: ResponseCard; + } + export interface ResponseCard { + /** + * The version of the response card format. + */ + version?: String; + /** + * The content type of the response. + */ + contentType?: ContentType; + /** + * An array of attachment objects representing options. + */ + genericAttachments?: genericAttachmentList; + } + export type String = string; + export type StringMap = {[key: string]: String}; + export type StringUrlWithLength = string; + export type StringWithLength = string; + export type Text = string; + export type UserId = string; + export type genericAttachmentList = GenericAttachment[]; + export type listOfButtons = Button[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-11-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the LexRuntime client. + */ + export import Types = LexRuntime; +} +export = LexRuntime; diff --git a/node_modules/aws-sdk/clients/lexruntime.js b/node_modules/aws-sdk/clients/lexruntime.js new file mode 100644 index 0000000..77add98 --- /dev/null +++ b/node_modules/aws-sdk/clients/lexruntime.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['lexruntime'] = {}; +AWS.LexRuntime = Service.defineService('lexruntime', ['2016-11-28']); +Object.defineProperty(apiLoader.services['lexruntime'], '2016-11-28', { + get: function get() { + var model = require('../apis/runtime.lex-2016-11-28.min.json'); + model.paginators = require('../apis/runtime.lex-2016-11-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.LexRuntime; diff --git a/node_modules/aws-sdk/clients/licensemanager.d.ts b/node_modules/aws-sdk/clients/licensemanager.d.ts new file mode 100644 index 0000000..933e199 --- /dev/null +++ b/node_modules/aws-sdk/clients/licensemanager.d.ts @@ -0,0 +1,727 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class LicenseManager extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: LicenseManager.Types.ClientConfiguration) + config: Config & LicenseManager.Types.ClientConfiguration; + /** + * Creates a new license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or VCPU), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), the number of licenses purchased and used. + */ + createLicenseConfiguration(params: LicenseManager.Types.CreateLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConfigurationResponse) => void): Request; + /** + * Creates a new license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or VCPU), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), the number of licenses purchased and used. + */ + createLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConfigurationResponse) => void): Request; + /** + * Deletes an existing license configuration. This action fails if the configuration is in use. + */ + deleteLicenseConfiguration(params: LicenseManager.Types.DeleteLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseConfigurationResponse) => void): Request; + /** + * Deletes an existing license configuration. This action fails if the configuration is in use. + */ + deleteLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseConfigurationResponse) => void): Request; + /** + * Returns a detailed description of a license configuration. + */ + getLicenseConfiguration(params: LicenseManager.Types.GetLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConfigurationResponse) => void): Request; + /** + * Returns a detailed description of a license configuration. + */ + getLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConfigurationResponse) => void): Request; + /** + * Gets License Manager settings for a region. Exposes the configured S3 bucket, SNS topic, etc., for inspection. + */ + getServiceSettings(params: LicenseManager.Types.GetServiceSettingsRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetServiceSettingsResponse) => void): Request; + /** + * Gets License Manager settings for a region. Exposes the configured S3 bucket, SNS topic, etc., for inspection. + */ + getServiceSettings(callback?: (err: AWSError, data: LicenseManager.Types.GetServiceSettingsResponse) => void): Request; + /** + * Lists the resource associations for a license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance may not consume a license (depending on the license rules). Use this operation to find all resources associated with a license configuration. + */ + listAssociationsForLicenseConfiguration(params: LicenseManager.Types.ListAssociationsForLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse) => void): Request; + /** + * Lists the resource associations for a license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance may not consume a license (depending on the license rules). Use this operation to find all resources associated with a license configuration. + */ + listAssociationsForLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse) => void): Request; + /** + * Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement. + */ + listLicenseConfigurations(params: LicenseManager.Types.ListLicenseConfigurationsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConfigurationsResponse) => void): Request; + /** + * Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement. + */ + listLicenseConfigurations(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConfigurationsResponse) => void): Request; + /** + * Returns the license configuration for a resource. + */ + listLicenseSpecificationsForResource(params: LicenseManager.Types.ListLicenseSpecificationsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseSpecificationsForResourceResponse) => void): Request; + /** + * Returns the license configuration for a resource. + */ + listLicenseSpecificationsForResource(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseSpecificationsForResourceResponse) => void): Request; + /** + * Returns a detailed list of resources. + */ + listResourceInventory(params: LicenseManager.Types.ListResourceInventoryRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListResourceInventoryResponse) => void): Request; + /** + * Returns a detailed list of resources. + */ + listResourceInventory(callback?: (err: AWSError, data: LicenseManager.Types.ListResourceInventoryResponse) => void): Request; + /** + * Lists tags attached to a resource. + */ + listTagsForResource(params: LicenseManager.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists tags attached to a resource. + */ + listTagsForResource(callback?: (err: AWSError, data: LicenseManager.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration. + */ + listUsageForLicenseConfiguration(params: LicenseManager.Types.ListUsageForLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListUsageForLicenseConfigurationResponse) => void): Request; + /** + * Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration. + */ + listUsageForLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.ListUsageForLicenseConfigurationResponse) => void): Request; + /** + * Attach one of more tags to any resource. + */ + tagResource(params: LicenseManager.Types.TagResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.TagResourceResponse) => void): Request; + /** + * Attach one of more tags to any resource. + */ + tagResource(callback?: (err: AWSError, data: LicenseManager.Types.TagResourceResponse) => void): Request; + /** + * Remove tags from a resource. + */ + untagResource(params: LicenseManager.Types.UntagResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.UntagResourceResponse) => void): Request; + /** + * Remove tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: LicenseManager.Types.UntagResourceResponse) => void): Request; + /** + * Modifies the attributes of an existing license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (Instances, cores, sockets, VCPUs), tenancy (shared or Dedicated Host), host affinity (how long a VM is associated with a host), the number of licenses purchased and used. + */ + updateLicenseConfiguration(params: LicenseManager.Types.UpdateLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseConfigurationResponse) => void): Request; + /** + * Modifies the attributes of an existing license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (Instances, cores, sockets, VCPUs), tenancy (shared or Dedicated Host), host affinity (how long a VM is associated with a host), the number of licenses purchased and used. + */ + updateLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseConfigurationResponse) => void): Request; + /** + * Adds or removes license configurations for a specified AWS resource. This operation currently supports updating the license specifications of AMIs, instances, and hosts. Launch templates and AWS CloudFormation templates are not managed from this operation as those resources send the license configurations directly to a resource creation operation, such as RunInstances. + */ + updateLicenseSpecificationsForResource(params: LicenseManager.Types.UpdateLicenseSpecificationsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse) => void): Request; + /** + * Adds or removes license configurations for a specified AWS resource. This operation currently supports updating the license specifications of AMIs, instances, and hosts. Launch templates and AWS CloudFormation templates are not managed from this operation as those resources send the license configurations directly to a resource creation operation, such as RunInstances. + */ + updateLicenseSpecificationsForResource(callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse) => void): Request; + /** + * Updates License Manager service settings. + */ + updateServiceSettings(params: LicenseManager.Types.UpdateServiceSettingsRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateServiceSettingsResponse) => void): Request; + /** + * Updates License Manager service settings. + */ + updateServiceSettings(callback?: (err: AWSError, data: LicenseManager.Types.UpdateServiceSettingsResponse) => void): Request; +} +declare namespace LicenseManager { + export type Boolean = boolean; + export type BoxBoolean = boolean; + export type BoxInteger = number; + export type BoxLong = number; + export interface ConsumedLicenseSummary { + /** + * Resource type of the resource consuming a license (instance, host, or AMI). + */ + ResourceType?: ResourceType; + /** + * Number of licenses consumed by a resource. + */ + ConsumedLicenses?: BoxLong; + } + export type ConsumedLicenseSummaryList = ConsumedLicenseSummary[]; + export interface CreateLicenseConfigurationRequest { + /** + * Name of the license configuration. + */ + Name: String; + /** + * Human-friendly description of the license configuration. + */ + Description?: String; + /** + * Dimension to use to track the license inventory. + */ + LicenseCountingType: LicenseCountingType; + /** + * Number of licenses managed by the license configuration. + */ + LicenseCount?: BoxLong; + /** + * Flag indicating whether hard or soft license enforcement is used. Exceeding a hard limit results in the blocked deployment of new instances. + */ + LicenseCountHardLimit?: BoxBoolean; + /** + * Array of configured License Manager rules. + */ + LicenseRules?: StringList; + /** + * The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags . + */ + Tags?: TagList; + } + export interface CreateLicenseConfigurationResponse { + /** + * ARN of the license configuration object after its creation. + */ + LicenseConfigurationArn?: String; + } + export type DateTime = Date; + export interface DeleteLicenseConfigurationRequest { + /** + * Unique ID of the configuration object to delete. + */ + LicenseConfigurationArn: String; + } + export interface DeleteLicenseConfigurationResponse { + } + export interface Filter { + /** + * Name of the filter. Filter names are case-sensitive. + */ + Name?: FilterName; + /** + * One or more filter values. Filter values are case-sensitive. + */ + Values?: FilterValues; + } + export type FilterName = string; + export type FilterValue = string; + export type FilterValues = FilterValue[]; + export type Filters = Filter[]; + export interface GetLicenseConfigurationRequest { + /** + * ARN of the license configuration being requested. + */ + LicenseConfigurationArn: String; + } + export interface GetLicenseConfigurationResponse { + /** + * Unique ID for the license configuration. + */ + LicenseConfigurationId?: String; + /** + * ARN of the license configuration requested. + */ + LicenseConfigurationArn?: String; + /** + * Name of the license configuration. + */ + Name?: String; + /** + * Description of the license configuration. + */ + Description?: String; + /** + * Dimension on which the licenses are counted (for example, instances, cores, sockets, or VCPUs). + */ + LicenseCountingType?: LicenseCountingType; + /** + * List of flexible text strings designating license rules. + */ + LicenseRules?: StringList; + /** + * Number of available licenses. + */ + LicenseCount?: BoxLong; + /** + * Sets the number of available licenses as a hard limit. + */ + LicenseCountHardLimit?: BoxBoolean; + /** + * Number of licenses assigned to resources. + */ + ConsumedLicenses?: BoxLong; + /** + * License configuration status (active, etc.). + */ + Status?: String; + /** + * Owner account ID for the license configuration. + */ + OwnerAccountId?: String; + /** + * List of summaries for consumed licenses used by various resources. + */ + ConsumedLicenseSummaryList?: ConsumedLicenseSummaryList; + /** + * List of summaries of managed resources. + */ + ManagedResourceSummaryList?: ManagedResourceSummaryList; + /** + * List of tags attached to the license configuration. + */ + Tags?: TagList; + } + export interface GetServiceSettingsRequest { + } + export interface GetServiceSettingsResponse { + /** + * Regional S3 bucket path for storing reports, license trail event data, discovery data, etc. + */ + S3BucketArn?: String; + /** + * SNS topic configured to receive notifications from License Manager. + */ + SnsTopicArn?: String; + /** + * Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery. + */ + OrganizationConfiguration?: OrganizationConfiguration; + /** + * Indicates whether cross-account discovery has been enabled. + */ + EnableCrossAccountsDiscovery?: BoxBoolean; + } + export interface InventoryFilter { + /** + * The name of the filter. + */ + Name: String; + /** + * The condition of the filter. + */ + Condition: InventoryFilterCondition; + /** + * Value of the filter. + */ + Value?: String; + } + export type InventoryFilterCondition = "EQUALS"|"NOT_EQUALS"|"BEGINS_WITH"|"CONTAINS"|string; + export type InventoryFilterList = InventoryFilter[]; + export interface LicenseConfiguration { + /** + * Unique ID of the LicenseConfiguration object. + */ + LicenseConfigurationId?: String; + /** + * ARN of the LicenseConfiguration object. + */ + LicenseConfigurationArn?: String; + /** + * Name of the license configuration. + */ + Name?: String; + /** + * Description of the license configuration. + */ + Description?: String; + /** + * Dimension to use to track license inventory. + */ + LicenseCountingType?: LicenseCountingType; + /** + * Array of configured License Manager rules. + */ + LicenseRules?: StringList; + /** + * Number of licenses managed by the license configuration. + */ + LicenseCount?: BoxLong; + /** + * Sets the number of available licenses as a hard limit. + */ + LicenseCountHardLimit?: BoxBoolean; + /** + * Number of licenses consumed. + */ + ConsumedLicenses?: BoxLong; + /** + * Status of the license configuration. + */ + Status?: String; + /** + * Account ID of the license configuration's owner. + */ + OwnerAccountId?: String; + /** + * List of summaries for licenses consumed by various resources. + */ + ConsumedLicenseSummaryList?: ConsumedLicenseSummaryList; + /** + * List of summaries for managed resources. + */ + ManagedResourceSummaryList?: ManagedResourceSummaryList; + } + export interface LicenseConfigurationAssociation { + /** + * ARN of the resource associated with the license configuration. + */ + ResourceArn?: String; + /** + * Type of server resource. + */ + ResourceType?: ResourceType; + /** + * ID of the AWS account that owns the resource consuming licenses. + */ + ResourceOwnerId?: String; + /** + * Time when the license configuration was associated with the resource. + */ + AssociationTime?: DateTime; + } + export type LicenseConfigurationAssociations = LicenseConfigurationAssociation[]; + export type LicenseConfigurationStatus = "AVAILABLE"|"DISABLED"|string; + export interface LicenseConfigurationUsage { + /** + * ARN of the resource associated with a license configuration. + */ + ResourceArn?: String; + /** + * Type of resource associated with athe license configuration. + */ + ResourceType?: ResourceType; + /** + * Status of a resource associated with the license configuration. + */ + ResourceStatus?: String; + /** + * ID of the account that owns a resource that is associated with the license configuration. + */ + ResourceOwnerId?: String; + /** + * Time when the license configuration was initially associated with a resource. + */ + AssociationTime?: DateTime; + /** + * Number of licenses consumed out of the total provisioned in the license configuration. + */ + ConsumedLicenses?: BoxLong; + } + export type LicenseConfigurationUsageList = LicenseConfigurationUsage[]; + export type LicenseConfigurations = LicenseConfiguration[]; + export type LicenseCountingType = "vCPU"|"Instance"|"Core"|"Socket"|string; + export interface LicenseSpecification { + /** + * ARN of the LicenseConfiguration object. + */ + LicenseConfigurationArn: String; + } + export type LicenseSpecifications = LicenseSpecification[]; + export interface ListAssociationsForLicenseConfigurationRequest { + /** + * ARN of a LicenseConfiguration object. + */ + LicenseConfigurationArn: String; + /** + * Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: BoxInteger; + /** + * Token for the next set of results. + */ + NextToken?: String; + } + export interface ListAssociationsForLicenseConfigurationResponse { + /** + * Lists association objects for the license configuration, each containing the association time, number of consumed licenses, resource ARN, resource ID, account ID that owns the resource, resource size, and resource type. + */ + LicenseConfigurationAssociations?: LicenseConfigurationAssociations; + /** + * Token for the next set of results. + */ + NextToken?: String; + } + export interface ListLicenseConfigurationsRequest { + /** + * An array of ARNs for the calling account’s license configurations. + */ + LicenseConfigurationArns?: StringList; + /** + * Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: BoxInteger; + /** + * Token for the next set of results. + */ + NextToken?: String; + /** + * One or more filters. + */ + Filters?: Filters; + } + export interface ListLicenseConfigurationsResponse { + /** + * Array of license configuration objects. + */ + LicenseConfigurations?: LicenseConfigurations; + /** + * Token for the next set of results. + */ + NextToken?: String; + } + export interface ListLicenseSpecificationsForResourceRequest { + /** + * ARN of an AMI or Amazon EC2 instance that has an associated license configuration. + */ + ResourceArn: String; + /** + * Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: BoxInteger; + /** + * Token for the next set of results. + */ + NextToken?: String; + } + export interface ListLicenseSpecificationsForResourceResponse { + /** + * License configurations associated with a resource. + */ + LicenseSpecifications?: LicenseSpecifications; + /** + * Token for the next set of results. + */ + NextToken?: String; + } + export interface ListResourceInventoryRequest { + /** + * Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: BoxInteger; + /** + * Token for the next set of results. + */ + NextToken?: String; + /** + * One or more filters. + */ + Filters?: InventoryFilterList; + } + export interface ListResourceInventoryResponse { + /** + * The detailed list of resources. + */ + ResourceInventoryList?: ResourceInventoryList; + /** + * Token for the next set of results. + */ + NextToken?: String; + } + export interface ListTagsForResourceRequest { + /** + * ARN for the resource. + */ + ResourceArn: String; + } + export interface ListTagsForResourceResponse { + /** + * List of tags attached to the resource. + */ + Tags?: TagList; + } + export interface ListUsageForLicenseConfigurationRequest { + /** + * ARN of the targeted LicenseConfiguration object. + */ + LicenseConfigurationArn: String; + /** + * Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. + */ + MaxResults?: BoxInteger; + /** + * Token for the next set of results. + */ + NextToken?: String; + /** + * List of filters to apply. + */ + Filters?: Filters; + } + export interface ListUsageForLicenseConfigurationResponse { + /** + * An array of LicenseConfigurationUsage objects. + */ + LicenseConfigurationUsageList?: LicenseConfigurationUsageList; + /** + * Token for the next set of results. + */ + NextToken?: String; + } + export interface ManagedResourceSummary { + /** + * Type of resource associated with a license (instance, host, or AMI). + */ + ResourceType?: ResourceType; + /** + * Number of resources associated with licenses. + */ + AssociationCount?: BoxLong; + } + export type ManagedResourceSummaryList = ManagedResourceSummary[]; + export interface OrganizationConfiguration { + /** + * Flag to activate AWS Organization integration. + */ + EnableIntegration: Boolean; + } + export interface ResourceInventory { + /** + * Unique ID of the resource. + */ + ResourceId?: String; + /** + * The type of resource. + */ + ResourceType?: ResourceType; + /** + * The ARN of the resource. + */ + ResourceArn?: String; + /** + * The platform of the resource. + */ + Platform?: String; + /** + * Platform version of the resource in the inventory. + */ + PlatformVersion?: String; + /** + * Unique ID of the account that owns the resource. + */ + ResourceOwningAccountId?: String; + } + export type ResourceInventoryList = ResourceInventory[]; + export type ResourceType = "EC2_INSTANCE"|"EC2_HOST"|"EC2_AMI"|string; + export type String = string; + export type StringList = String[]; + export interface Tag { + /** + * Key for the resource tag. + */ + Key?: String; + /** + * Value for the resource tag. + */ + Value?: String; + } + export type TagKeyList = String[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * Resource of the ARN to be tagged. + */ + ResourceArn: String; + /** + * Names of the tags to attach to the resource. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export interface UntagResourceRequest { + /** + * ARN of the resource. + */ + ResourceArn: String; + /** + * List keys identifying tags to remove. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateLicenseConfigurationRequest { + /** + * ARN for a license configuration. + */ + LicenseConfigurationArn: String; + /** + * New status of the license configuration (ACTIVE or INACTIVE). + */ + LicenseConfigurationStatus?: LicenseConfigurationStatus; + /** + * List of flexible text strings designating license rules. + */ + LicenseRules?: StringList; + /** + * New number of licenses managed by the license configuration. + */ + LicenseCount?: BoxLong; + /** + * Sets the number of available licenses as a hard limit. + */ + LicenseCountHardLimit?: BoxBoolean; + /** + * New name of the license configuration. + */ + Name?: String; + /** + * New human-friendly description of the license configuration. + */ + Description?: String; + } + export interface UpdateLicenseConfigurationResponse { + } + export interface UpdateLicenseSpecificationsForResourceRequest { + /** + * ARN for an AWS server resource. + */ + ResourceArn: String; + /** + * License configuration ARNs to be added to a resource. + */ + AddLicenseSpecifications?: LicenseSpecifications; + /** + * License configuration ARNs to be removed from a resource. + */ + RemoveLicenseSpecifications?: LicenseSpecifications; + } + export interface UpdateLicenseSpecificationsForResourceResponse { + } + export interface UpdateServiceSettingsRequest { + /** + * ARN of the Amazon S3 bucket where License Manager information is stored. + */ + S3BucketArn?: String; + /** + * ARN of the Amazon SNS topic used for License Manager alerts. + */ + SnsTopicArn?: String; + /** + * Integrates AWS Organizations with License Manager for cross-account discovery. + */ + OrganizationConfiguration?: OrganizationConfiguration; + /** + * Activates cross-account discovery. + */ + EnableCrossAccountsDiscovery?: BoxBoolean; + } + export interface UpdateServiceSettingsResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-08-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the LicenseManager client. + */ + export import Types = LicenseManager; +} +export = LicenseManager; diff --git a/node_modules/aws-sdk/clients/licensemanager.js b/node_modules/aws-sdk/clients/licensemanager.js new file mode 100644 index 0000000..e403dc8 --- /dev/null +++ b/node_modules/aws-sdk/clients/licensemanager.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['licensemanager'] = {}; +AWS.LicenseManager = Service.defineService('licensemanager', ['2018-08-01']); +Object.defineProperty(apiLoader.services['licensemanager'], '2018-08-01', { + get: function get() { + var model = require('../apis/license-manager-2018-08-01.min.json'); + model.paginators = require('../apis/license-manager-2018-08-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.LicenseManager; diff --git a/node_modules/aws-sdk/clients/lightsail.d.ts b/node_modules/aws-sdk/clients/lightsail.d.ts new file mode 100644 index 0000000..f4726ce --- /dev/null +++ b/node_modules/aws-sdk/clients/lightsail.d.ts @@ -0,0 +1,4347 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Lightsail extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Lightsail.Types.ClientConfiguration) + config: Config & Lightsail.Types.ClientConfiguration; + /** + * Allocates a static IP address. + */ + allocateStaticIp(params: Lightsail.Types.AllocateStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.AllocateStaticIpResult) => void): Request; + /** + * Allocates a static IP address. + */ + allocateStaticIp(callback?: (err: AWSError, data: Lightsail.Types.AllocateStaticIpResult) => void): Request; + /** + * Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide. + */ + attachDisk(params: Lightsail.Types.AttachDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachDiskResult) => void): Request; + /** + * Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide. + */ + attachDisk(callback?: (err: AWSError, data: Lightsail.Types.AttachDiskResult) => void): Request; + /** + * Attaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + attachInstancesToLoadBalancer(params: Lightsail.Types.AttachInstancesToLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachInstancesToLoadBalancerResult) => void): Request; + /** + * Attaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + attachInstancesToLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.AttachInstancesToLoadBalancerResult) => void): Request; + /** + * Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate. The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + attachLoadBalancerTlsCertificate(params: Lightsail.Types.AttachLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachLoadBalancerTlsCertificateResult) => void): Request; + /** + * Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate. The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + attachLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.AttachLoadBalancerTlsCertificateResult) => void): Request; + /** + * Attaches a static IP address to a specific Amazon Lightsail instance. + */ + attachStaticIp(params: Lightsail.Types.AttachStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachStaticIpResult) => void): Request; + /** + * Attaches a static IP address to a specific Amazon Lightsail instance. + */ + attachStaticIp(callback?: (err: AWSError, data: Lightsail.Types.AttachStaticIpResult) => void): Request; + /** + * Closes the public ports on a specific Amazon Lightsail instance. The close instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + closeInstancePublicPorts(params: Lightsail.Types.CloseInstancePublicPortsRequest, callback?: (err: AWSError, data: Lightsail.Types.CloseInstancePublicPortsResult) => void): Request; + /** + * Closes the public ports on a specific Amazon Lightsail instance. The close instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + closeInstancePublicPorts(callback?: (err: AWSError, data: Lightsail.Types.CloseInstancePublicPortsResult) => void): Request; + /** + * Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail. + */ + copySnapshot(params: Lightsail.Types.CopySnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CopySnapshotResult) => void): Request; + /** + * Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail. + */ + copySnapshot(callback?: (err: AWSError, data: Lightsail.Types.CopySnapshotResult) => void): Request; + /** + * Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record. + */ + createCloudFormationStack(params: Lightsail.Types.CreateCloudFormationStackRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateCloudFormationStackResult) => void): Request; + /** + * Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record. + */ + createCloudFormationStack(callback?: (err: AWSError, data: Lightsail.Types.CreateCloudFormationStackResult) => void): Request; + /** + * Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail. The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createDisk(params: Lightsail.Types.CreateDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDiskResult) => void): Request; + /** + * Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail. The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createDisk(callback?: (err: AWSError, data: Lightsail.Types.CreateDiskResult) => void): Request; + /** + * Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail. The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide. + */ + createDiskFromSnapshot(params: Lightsail.Types.CreateDiskFromSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDiskFromSnapshotResult) => void): Request; + /** + * Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail. The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide. + */ + createDiskFromSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateDiskFromSnapshotResult) => void): Request; + /** + * Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createDiskSnapshot(params: Lightsail.Types.CreateDiskSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDiskSnapshotResult) => void): Request; + /** + * Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createDiskSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateDiskSnapshotResult) => void): Request; + /** + * Creates a domain resource for the specified domain (e.g., example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createDomain(params: Lightsail.Types.CreateDomainRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDomainResult) => void): Request; + /** + * Creates a domain resource for the specified domain (e.g., example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createDomain(callback?: (err: AWSError, data: Lightsail.Types.CreateDomainResult) => void): Request; + /** + * Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + createDomainEntry(params: Lightsail.Types.CreateDomainEntryRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDomainEntryResult) => void): Request; + /** + * Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + createDomainEntry(callback?: (err: AWSError, data: Lightsail.Types.CreateDomainEntryResult) => void): Request; + /** + * Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createInstanceSnapshot(params: Lightsail.Types.CreateInstanceSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateInstanceSnapshotResult) => void): Request; + /** + * Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createInstanceSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateInstanceSnapshotResult) => void): Request; + /** + * Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints. The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createInstances(params: Lightsail.Types.CreateInstancesRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesResult) => void): Request; + /** + * Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints. The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createInstances(callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesResult) => void): Request; + /** + * Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide. + */ + createInstancesFromSnapshot(params: Lightsail.Types.CreateInstancesFromSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesFromSnapshotResult) => void): Request; + /** + * Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide. + */ + createInstancesFromSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesFromSnapshotResult) => void): Request; + /** + * Creates an SSH key pair. The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createKeyPair(params: Lightsail.Types.CreateKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateKeyPairResult) => void): Request; + /** + * Creates an SSH key pair. The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createKeyPair(callback?: (err: AWSError, data: Lightsail.Types.CreateKeyPairResult) => void): Request; + /** + * Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createLoadBalancer(params: Lightsail.Types.CreateLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerResult) => void): Request; + /** + * Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerResult) => void): Request; + /** + * Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + createLoadBalancerTlsCertificate(params: Lightsail.Types.CreateLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerTlsCertificateResult) => void): Request; + /** + * Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + createLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerTlsCertificateResult) => void): Request; + /** + * Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createRelationalDatabase(params: Lightsail.Types.CreateRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseResult) => void): Request; + /** + * Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseResult) => void): Request; + /** + * Creates a new database from an existing database snapshot in Amazon Lightsail. You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan. The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide. + */ + createRelationalDatabaseFromSnapshot(params: Lightsail.Types.CreateRelationalDatabaseFromSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseFromSnapshotResult) => void): Request; + /** + * Creates a new database from an existing database snapshot in Amazon Lightsail. You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan. The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide. + */ + createRelationalDatabaseFromSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseFromSnapshotResult) => void): Request; + /** + * Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createRelationalDatabaseSnapshot(params: Lightsail.Types.CreateRelationalDatabaseSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseSnapshotResult) => void): Request; + /** + * Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide. + */ + createRelationalDatabaseSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseSnapshotResult) => void): Request; + /** + * Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide. + */ + deleteDisk(params: Lightsail.Types.DeleteDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskResult) => void): Request; + /** + * Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide. + */ + deleteDisk(callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskResult) => void): Request; + /** + * Deletes the specified disk snapshot. When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk. The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide. + */ + deleteDiskSnapshot(params: Lightsail.Types.DeleteDiskSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskSnapshotResult) => void): Request; + /** + * Deletes the specified disk snapshot. When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk. The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide. + */ + deleteDiskSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskSnapshotResult) => void): Request; + /** + * Deletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + deleteDomain(params: Lightsail.Types.DeleteDomainRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainResult) => void): Request; + /** + * Deletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + deleteDomain(callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainResult) => void): Request; + /** + * Deletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + deleteDomainEntry(params: Lightsail.Types.DeleteDomainEntryRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainEntryResult) => void): Request; + /** + * Deletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + deleteDomainEntry(callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainEntryResult) => void): Request; + /** + * Deletes a specific Amazon Lightsail virtual private server, or instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + deleteInstance(params: Lightsail.Types.DeleteInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceResult) => void): Request; + /** + * Deletes a specific Amazon Lightsail virtual private server, or instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + deleteInstance(callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceResult) => void): Request; + /** + * Deletes a specific snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide. + */ + deleteInstanceSnapshot(params: Lightsail.Types.DeleteInstanceSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceSnapshotResult) => void): Request; + /** + * Deletes a specific snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide. + */ + deleteInstanceSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceSnapshotResult) => void): Request; + /** + * Deletes a specific SSH key pair. The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by keyPairName. For more information, see the Lightsail Dev Guide. + */ + deleteKeyPair(params: Lightsail.Types.DeleteKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteKeyPairResult) => void): Request; + /** + * Deletes a specific SSH key pair. The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by keyPairName. For more information, see the Lightsail Dev Guide. + */ + deleteKeyPair(callback?: (err: AWSError, data: Lightsail.Types.DeleteKeyPairResult) => void): Request; + /** + * Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client. + */ + deleteKnownHostKeys(params: Lightsail.Types.DeleteKnownHostKeysRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteKnownHostKeysResult) => void): Request; + /** + * Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client. + */ + deleteKnownHostKeys(callback?: (err: AWSError, data: Lightsail.Types.DeleteKnownHostKeysResult) => void): Request; + /** + * Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again. The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + deleteLoadBalancer(params: Lightsail.Types.DeleteLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerResult) => void): Request; + /** + * Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again. The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + deleteLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerResult) => void): Request; + /** + * Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The delete load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + deleteLoadBalancerTlsCertificate(params: Lightsail.Types.DeleteLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerTlsCertificateResult) => void): Request; + /** + * Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The delete load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + deleteLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerTlsCertificateResult) => void): Request; + /** + * Deletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + deleteRelationalDatabase(params: Lightsail.Types.DeleteRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseResult) => void): Request; + /** + * Deletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + deleteRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseResult) => void): Request; + /** + * Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + deleteRelationalDatabaseSnapshot(params: Lightsail.Types.DeleteRelationalDatabaseSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseSnapshotResult) => void): Request; + /** + * Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + deleteRelationalDatabaseSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseSnapshotResult) => void): Request; + /** + * Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk. The detach disk operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide. + */ + detachDisk(params: Lightsail.Types.DetachDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.DetachDiskResult) => void): Request; + /** + * Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk. The detach disk operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide. + */ + detachDisk(callback?: (err: AWSError, data: Lightsail.Types.DetachDiskResult) => void): Request; + /** + * Detaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + detachInstancesFromLoadBalancer(params: Lightsail.Types.DetachInstancesFromLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.DetachInstancesFromLoadBalancerResult) => void): Request; + /** + * Detaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + detachInstancesFromLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.DetachInstancesFromLoadBalancerResult) => void): Request; + /** + * Detaches a static IP from the Amazon Lightsail instance to which it is attached. + */ + detachStaticIp(params: Lightsail.Types.DetachStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.DetachStaticIpResult) => void): Request; + /** + * Detaches a static IP from the Amazon Lightsail instance to which it is attached. + */ + detachStaticIp(callback?: (err: AWSError, data: Lightsail.Types.DetachStaticIpResult) => void): Request; + /** + * Downloads the default SSH key pair from the user's account. + */ + downloadDefaultKeyPair(params: Lightsail.Types.DownloadDefaultKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.DownloadDefaultKeyPairResult) => void): Request; + /** + * Downloads the default SSH key pair from the user's account. + */ + downloadDefaultKeyPair(callback?: (err: AWSError, data: Lightsail.Types.DownloadDefaultKeyPairResult) => void): Request; + /** + * Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the Lightsail Dev Guide. Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2. + */ + exportSnapshot(params: Lightsail.Types.ExportSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.ExportSnapshotResult) => void): Request; + /** + * Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the Lightsail Dev Guide. Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2. + */ + exportSnapshot(callback?: (err: AWSError, data: Lightsail.Types.ExportSnapshotResult) => void): Request; + /** + * Returns the names of all active (not deleted) resources. + */ + getActiveNames(params: Lightsail.Types.GetActiveNamesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetActiveNamesResult) => void): Request; + /** + * Returns the names of all active (not deleted) resources. + */ + getActiveNames(callback?: (err: AWSError, data: Lightsail.Types.GetActiveNamesResult) => void): Request; + /** + * Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. + */ + getBlueprints(params: Lightsail.Types.GetBlueprintsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetBlueprintsResult) => void): Request; + /** + * Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. + */ + getBlueprints(callback?: (err: AWSError, data: Lightsail.Types.GetBlueprintsResult) => void): Request; + /** + * Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance). + */ + getBundles(params: Lightsail.Types.GetBundlesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetBundlesResult) => void): Request; + /** + * Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance). + */ + getBundles(callback?: (err: AWSError, data: Lightsail.Types.GetBundlesResult) => void): Request; + /** + * Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot. + */ + getCloudFormationStackRecords(params: Lightsail.Types.GetCloudFormationStackRecordsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetCloudFormationStackRecordsResult) => void): Request; + /** + * Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot. + */ + getCloudFormationStackRecords(callback?: (err: AWSError, data: Lightsail.Types.GetCloudFormationStackRecordsResult) => void): Request; + /** + * Returns information about a specific block storage disk. + */ + getDisk(params: Lightsail.Types.GetDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDiskResult) => void): Request; + /** + * Returns information about a specific block storage disk. + */ + getDisk(callback?: (err: AWSError, data: Lightsail.Types.GetDiskResult) => void): Request; + /** + * Returns information about a specific block storage disk snapshot. + */ + getDiskSnapshot(params: Lightsail.Types.GetDiskSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotResult) => void): Request; + /** + * Returns information about a specific block storage disk snapshot. + */ + getDiskSnapshot(callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotResult) => void): Request; + /** + * Returns information about all block storage disk snapshots in your AWS account and region. If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. + */ + getDiskSnapshots(params: Lightsail.Types.GetDiskSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotsResult) => void): Request; + /** + * Returns information about all block storage disk snapshots in your AWS account and region. If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. + */ + getDiskSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotsResult) => void): Request; + /** + * Returns information about all block storage disks in your AWS account and region. If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. + */ + getDisks(params: Lightsail.Types.GetDisksRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDisksResult) => void): Request; + /** + * Returns information about all block storage disks in your AWS account and region. If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. + */ + getDisks(callback?: (err: AWSError, data: Lightsail.Types.GetDisksResult) => void): Request; + /** + * Returns information about a specific domain recordset. + */ + getDomain(params: Lightsail.Types.GetDomainRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDomainResult) => void): Request; + /** + * Returns information about a specific domain recordset. + */ + getDomain(callback?: (err: AWSError, data: Lightsail.Types.GetDomainResult) => void): Request; + /** + * Returns a list of all domains in the user's account. + */ + getDomains(params: Lightsail.Types.GetDomainsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDomainsResult) => void): Request; + /** + * Returns a list of all domains in the user's account. + */ + getDomains(callback?: (err: AWSError, data: Lightsail.Types.GetDomainsResult) => void): Request; + /** + * Returns the export snapshot record created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation. + */ + getExportSnapshotRecords(params: Lightsail.Types.GetExportSnapshotRecordsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetExportSnapshotRecordsResult) => void): Request; + /** + * Returns the export snapshot record created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation. + */ + getExportSnapshotRecords(callback?: (err: AWSError, data: Lightsail.Types.GetExportSnapshotRecordsResult) => void): Request; + /** + * Returns information about a specific Amazon Lightsail instance, which is a virtual private server. + */ + getInstance(params: Lightsail.Types.GetInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceResult) => void): Request; + /** + * Returns information about a specific Amazon Lightsail instance, which is a virtual private server. + */ + getInstance(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceResult) => void): Request; + /** + * Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + getInstanceAccessDetails(params: Lightsail.Types.GetInstanceAccessDetailsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceAccessDetailsResult) => void): Request; + /** + * Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + getInstanceAccessDetails(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceAccessDetailsResult) => void): Request; + /** + * Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. + */ + getInstanceMetricData(params: Lightsail.Types.GetInstanceMetricDataRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceMetricDataResult) => void): Request; + /** + * Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. + */ + getInstanceMetricData(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceMetricDataResult) => void): Request; + /** + * Returns the port states for a specific virtual private server, or instance. + */ + getInstancePortStates(params: Lightsail.Types.GetInstancePortStatesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstancePortStatesResult) => void): Request; + /** + * Returns the port states for a specific virtual private server, or instance. + */ + getInstancePortStates(callback?: (err: AWSError, data: Lightsail.Types.GetInstancePortStatesResult) => void): Request; + /** + * Returns information about a specific instance snapshot. + */ + getInstanceSnapshot(params: Lightsail.Types.GetInstanceSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotResult) => void): Request; + /** + * Returns information about a specific instance snapshot. + */ + getInstanceSnapshot(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotResult) => void): Request; + /** + * Returns all instance snapshots for the user's account. + */ + getInstanceSnapshots(params: Lightsail.Types.GetInstanceSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotsResult) => void): Request; + /** + * Returns all instance snapshots for the user's account. + */ + getInstanceSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotsResult) => void): Request; + /** + * Returns the state of a specific instance. Works on one instance at a time. + */ + getInstanceState(params: Lightsail.Types.GetInstanceStateRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceStateResult) => void): Request; + /** + * Returns the state of a specific instance. Works on one instance at a time. + */ + getInstanceState(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceStateResult) => void): Request; + /** + * Returns information about all Amazon Lightsail virtual private servers, or instances. + */ + getInstances(params: Lightsail.Types.GetInstancesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstancesResult) => void): Request; + /** + * Returns information about all Amazon Lightsail virtual private servers, or instances. + */ + getInstances(callback?: (err: AWSError, data: Lightsail.Types.GetInstancesResult) => void): Request; + /** + * Returns information about a specific key pair. + */ + getKeyPair(params: Lightsail.Types.GetKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairResult) => void): Request; + /** + * Returns information about a specific key pair. + */ + getKeyPair(callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairResult) => void): Request; + /** + * Returns information about all key pairs in the user's account. + */ + getKeyPairs(params: Lightsail.Types.GetKeyPairsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairsResult) => void): Request; + /** + * Returns information about all key pairs in the user's account. + */ + getKeyPairs(callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairsResult) => void): Request; + /** + * Returns information about the specified Lightsail load balancer. + */ + getLoadBalancer(params: Lightsail.Types.GetLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerResult) => void): Request; + /** + * Returns information about the specified Lightsail load balancer. + */ + getLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerResult) => void): Request; + /** + * Returns information about health metrics for your Lightsail load balancer. + */ + getLoadBalancerMetricData(params: Lightsail.Types.GetLoadBalancerMetricDataRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerMetricDataResult) => void): Request; + /** + * Returns information about health metrics for your Lightsail load balancer. + */ + getLoadBalancerMetricData(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerMetricDataResult) => void): Request; + /** + * Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive. + */ + getLoadBalancerTlsCertificates(params: Lightsail.Types.GetLoadBalancerTlsCertificatesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerTlsCertificatesResult) => void): Request; + /** + * Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive. + */ + getLoadBalancerTlsCertificates(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerTlsCertificatesResult) => void): Request; + /** + * Returns information about all load balancers in an account. If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. + */ + getLoadBalancers(params: Lightsail.Types.GetLoadBalancersRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancersResult) => void): Request; + /** + * Returns information about all load balancers in an account. If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. + */ + getLoadBalancers(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancersResult) => void): Request; + /** + * Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on. + */ + getOperation(params: Lightsail.Types.GetOperationRequest, callback?: (err: AWSError, data: Lightsail.Types.GetOperationResult) => void): Request; + /** + * Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on. + */ + getOperation(callback?: (err: AWSError, data: Lightsail.Types.GetOperationResult) => void): Request; + /** + * Returns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request. + */ + getOperations(params: Lightsail.Types.GetOperationsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetOperationsResult) => void): Request; + /** + * Returns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request. + */ + getOperations(callback?: (err: AWSError, data: Lightsail.Types.GetOperationsResult) => void): Request; + /** + * Gets operations for a specific resource (e.g., an instance or a static IP). + */ + getOperationsForResource(params: Lightsail.Types.GetOperationsForResourceRequest, callback?: (err: AWSError, data: Lightsail.Types.GetOperationsForResourceResult) => void): Request; + /** + * Gets operations for a specific resource (e.g., an instance or a static IP). + */ + getOperationsForResource(callback?: (err: AWSError, data: Lightsail.Types.GetOperationsForResourceResult) => void): Request; + /** + * Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region. + */ + getRegions(params: Lightsail.Types.GetRegionsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRegionsResult) => void): Request; + /** + * Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region. + */ + getRegions(callback?: (err: AWSError, data: Lightsail.Types.GetRegionsResult) => void): Request; + /** + * Returns information about a specific database in Amazon Lightsail. + */ + getRelationalDatabase(params: Lightsail.Types.GetRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseResult) => void): Request; + /** + * Returns information about a specific database in Amazon Lightsail. + */ + getRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseResult) => void): Request; + /** + * Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a specific database engine. + */ + getRelationalDatabaseBlueprints(params: Lightsail.Types.GetRelationalDatabaseBlueprintsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBlueprintsResult) => void): Request; + /** + * Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a specific database engine. + */ + getRelationalDatabaseBlueprints(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBlueprintsResult) => void): Request; + /** + * Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. You can use a bundle ID to create a new database with explicit performance specifications. + */ + getRelationalDatabaseBundles(params: Lightsail.Types.GetRelationalDatabaseBundlesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBundlesResult) => void): Request; + /** + * Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. You can use a bundle ID to create a new database with explicit performance specifications. + */ + getRelationalDatabaseBundles(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBundlesResult) => void): Request; + /** + * Returns a list of events for a specific database in Amazon Lightsail. + */ + getRelationalDatabaseEvents(params: Lightsail.Types.GetRelationalDatabaseEventsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseEventsResult) => void): Request; + /** + * Returns a list of events for a specific database in Amazon Lightsail. + */ + getRelationalDatabaseEvents(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseEventsResult) => void): Request; + /** + * Returns a list of log events for a database in Amazon Lightsail. + */ + getRelationalDatabaseLogEvents(params: Lightsail.Types.GetRelationalDatabaseLogEventsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogEventsResult) => void): Request; + /** + * Returns a list of log events for a database in Amazon Lightsail. + */ + getRelationalDatabaseLogEvents(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogEventsResult) => void): Request; + /** + * Returns a list of available log streams for a specific database in Amazon Lightsail. + */ + getRelationalDatabaseLogStreams(params: Lightsail.Types.GetRelationalDatabaseLogStreamsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogStreamsResult) => void): Request; + /** + * Returns a list of available log streams for a specific database in Amazon Lightsail. + */ + getRelationalDatabaseLogStreams(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogStreamsResult) => void): Request; + /** + * Returns the current, previous, or pending versions of the master user password for a Lightsail database. The asdf operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. + */ + getRelationalDatabaseMasterUserPassword(params: Lightsail.Types.GetRelationalDatabaseMasterUserPasswordRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMasterUserPasswordResult) => void): Request; + /** + * Returns the current, previous, or pending versions of the master user password for a Lightsail database. The asdf operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. + */ + getRelationalDatabaseMasterUserPassword(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMasterUserPasswordResult) => void): Request; + /** + * Returns the data points of the specified metric for a database in Amazon Lightsail. + */ + getRelationalDatabaseMetricData(params: Lightsail.Types.GetRelationalDatabaseMetricDataRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMetricDataResult) => void): Request; + /** + * Returns the data points of the specified metric for a database in Amazon Lightsail. + */ + getRelationalDatabaseMetricData(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMetricDataResult) => void): Request; + /** + * Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types. + */ + getRelationalDatabaseParameters(params: Lightsail.Types.GetRelationalDatabaseParametersRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseParametersResult) => void): Request; + /** + * Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types. + */ + getRelationalDatabaseParameters(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseParametersResult) => void): Request; + /** + * Returns information about a specific database snapshot in Amazon Lightsail. + */ + getRelationalDatabaseSnapshot(params: Lightsail.Types.GetRelationalDatabaseSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotResult) => void): Request; + /** + * Returns information about a specific database snapshot in Amazon Lightsail. + */ + getRelationalDatabaseSnapshot(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotResult) => void): Request; + /** + * Returns information about all of your database snapshots in Amazon Lightsail. + */ + getRelationalDatabaseSnapshots(params: Lightsail.Types.GetRelationalDatabaseSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotsResult) => void): Request; + /** + * Returns information about all of your database snapshots in Amazon Lightsail. + */ + getRelationalDatabaseSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotsResult) => void): Request; + /** + * Returns information about all of your databases in Amazon Lightsail. + */ + getRelationalDatabases(params: Lightsail.Types.GetRelationalDatabasesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabasesResult) => void): Request; + /** + * Returns information about all of your databases in Amazon Lightsail. + */ + getRelationalDatabases(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabasesResult) => void): Request; + /** + * Returns information about a specific static IP. + */ + getStaticIp(params: Lightsail.Types.GetStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpResult) => void): Request; + /** + * Returns information about a specific static IP. + */ + getStaticIp(callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpResult) => void): Request; + /** + * Returns information about all static IPs in the user's account. + */ + getStaticIps(params: Lightsail.Types.GetStaticIpsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpsResult) => void): Request; + /** + * Returns information about all static IPs in the user's account. + */ + getStaticIps(callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpsResult) => void): Request; + /** + * Imports a public SSH key from a specific key pair. + */ + importKeyPair(params: Lightsail.Types.ImportKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.ImportKeyPairResult) => void): Request; + /** + * Imports a public SSH key from a specific key pair. + */ + importKeyPair(callback?: (err: AWSError, data: Lightsail.Types.ImportKeyPairResult) => void): Request; + /** + * Returns a Boolean value indicating whether your Lightsail VPC is peered. + */ + isVpcPeered(params: Lightsail.Types.IsVpcPeeredRequest, callback?: (err: AWSError, data: Lightsail.Types.IsVpcPeeredResult) => void): Request; + /** + * Returns a Boolean value indicating whether your Lightsail VPC is peered. + */ + isVpcPeered(callback?: (err: AWSError, data: Lightsail.Types.IsVpcPeeredResult) => void): Request; + /** + * Adds public ports to an Amazon Lightsail instance. The open instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + openInstancePublicPorts(params: Lightsail.Types.OpenInstancePublicPortsRequest, callback?: (err: AWSError, data: Lightsail.Types.OpenInstancePublicPortsResult) => void): Request; + /** + * Adds public ports to an Amazon Lightsail instance. The open instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + openInstancePublicPorts(callback?: (err: AWSError, data: Lightsail.Types.OpenInstancePublicPortsResult) => void): Request; + /** + * Tries to peer the Lightsail VPC with the user's default VPC. + */ + peerVpc(params: Lightsail.Types.PeerVpcRequest, callback?: (err: AWSError, data: Lightsail.Types.PeerVpcResult) => void): Request; + /** + * Tries to peer the Lightsail VPC with the user's default VPC. + */ + peerVpc(callback?: (err: AWSError, data: Lightsail.Types.PeerVpcResult) => void): Request; + /** + * Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request. The put instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + putInstancePublicPorts(params: Lightsail.Types.PutInstancePublicPortsRequest, callback?: (err: AWSError, data: Lightsail.Types.PutInstancePublicPortsResult) => void): Request; + /** + * Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request. The put instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + putInstancePublicPorts(callback?: (err: AWSError, data: Lightsail.Types.PutInstancePublicPortsResult) => void): Request; + /** + * Restarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + rebootInstance(params: Lightsail.Types.RebootInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.RebootInstanceResult) => void): Request; + /** + * Restarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + rebootInstance(callback?: (err: AWSError, data: Lightsail.Types.RebootInstanceResult) => void): Request; + /** + * Restarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + rebootRelationalDatabase(params: Lightsail.Types.RebootRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.RebootRelationalDatabaseResult) => void): Request; + /** + * Restarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + rebootRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.RebootRelationalDatabaseResult) => void): Request; + /** + * Deletes a specific static IP from your account. + */ + releaseStaticIp(params: Lightsail.Types.ReleaseStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.ReleaseStaticIpResult) => void): Request; + /** + * Deletes a specific static IP from your account. + */ + releaseStaticIp(callback?: (err: AWSError, data: Lightsail.Types.ReleaseStaticIpResult) => void): Request; + /** + * Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The start instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + startInstance(params: Lightsail.Types.StartInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.StartInstanceResult) => void): Request; + /** + * Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The start instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + startInstance(callback?: (err: AWSError, data: Lightsail.Types.StartInstanceResult) => void): Request; + /** + * Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + startRelationalDatabase(params: Lightsail.Types.StartRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.StartRelationalDatabaseResult) => void): Request; + /** + * Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + startRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.StartRelationalDatabaseResult) => void): Request; + /** + * Stops a specific Amazon Lightsail instance that is currently running. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + stopInstance(params: Lightsail.Types.StopInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.StopInstanceResult) => void): Request; + /** + * Stops a specific Amazon Lightsail instance that is currently running. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide. + */ + stopInstance(callback?: (err: AWSError, data: Lightsail.Types.StopInstanceResult) => void): Request; + /** + * Stops a specific database that is currently running in Amazon Lightsail. The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + stopRelationalDatabase(params: Lightsail.Types.StopRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.StopRelationalDatabaseResult) => void): Request; + /** + * Stops a specific database that is currently running in Amazon Lightsail. The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + stopRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.StopRelationalDatabaseResult) => void): Request; + /** + * Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide. The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide. + */ + tagResource(params: Lightsail.Types.TagResourceRequest, callback?: (err: AWSError, data: Lightsail.Types.TagResourceResult) => void): Request; + /** + * Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide. The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide. + */ + tagResource(callback?: (err: AWSError, data: Lightsail.Types.TagResourceResult) => void): Request; + /** + * Attempts to unpeer the Lightsail VPC from the user's default VPC. + */ + unpeerVpc(params: Lightsail.Types.UnpeerVpcRequest, callback?: (err: AWSError, data: Lightsail.Types.UnpeerVpcResult) => void): Request; + /** + * Attempts to unpeer the Lightsail VPC from the user's default VPC. + */ + unpeerVpc(callback?: (err: AWSError, data: Lightsail.Types.UnpeerVpcResult) => void): Request; + /** + * Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide. + */ + untagResource(params: Lightsail.Types.UntagResourceRequest, callback?: (err: AWSError, data: Lightsail.Types.UntagResourceResult) => void): Request; + /** + * Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the Lightsail Dev Guide. + */ + untagResource(callback?: (err: AWSError, data: Lightsail.Types.UntagResourceResult) => void): Request; + /** + * Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + updateDomainEntry(params: Lightsail.Types.UpdateDomainEntryRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateDomainEntryResult) => void): Request; + /** + * Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide. + */ + updateDomainEntry(callback?: (err: AWSError, data: Lightsail.Types.UpdateDomainEntryResult) => void): Request; + /** + * Updates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + updateLoadBalancerAttribute(params: Lightsail.Types.UpdateLoadBalancerAttributeRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateLoadBalancerAttributeResult) => void): Request; + /** + * Updates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide. + */ + updateLoadBalancerAttribute(callback?: (err: AWSError, data: Lightsail.Types.UpdateLoadBalancerAttributeResult) => void): Request; + /** + * Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + updateRelationalDatabase(params: Lightsail.Types.UpdateRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseResult) => void): Request; + /** + * Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + updateRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseResult) => void): Request; + /** + * Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + updateRelationalDatabaseParameters(params: Lightsail.Types.UpdateRelationalDatabaseParametersRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseParametersResult) => void): Request; + /** + * Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide. + */ + updateRelationalDatabaseParameters(callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseParametersResult) => void): Request; +} +declare namespace Lightsail { + export type AccessDirection = "inbound"|"outbound"|string; + export interface AllocateStaticIpRequest { + /** + * The name of the static IP address. + */ + staticIpName: ResourceName; + } + export interface AllocateStaticIpResult { + /** + * An array of key-value pairs containing information about the static IP address you allocated. + */ + operations?: OperationList; + } + export interface AttachDiskRequest { + /** + * The unique Lightsail disk name (e.g., my-disk). + */ + diskName: ResourceName; + /** + * The name of the Lightsail instance where you want to utilize the storage disk. + */ + instanceName: ResourceName; + /** + * The disk path to expose to the instance (e.g., /dev/xvdf). + */ + diskPath: NonEmptyString; + } + export interface AttachDiskResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface AttachInstancesToLoadBalancerRequest { + /** + * The name of the load balancer. + */ + loadBalancerName: ResourceName; + /** + * An array of strings representing the instance name(s) you want to attach to your load balancer. An instance must be running before you can attach it to your load balancer. There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20). + */ + instanceNames: ResourceNameList; + } + export interface AttachInstancesToLoadBalancerResult { + /** + * An object representing the API operations. + */ + operations?: OperationList; + } + export interface AttachLoadBalancerTlsCertificateRequest { + /** + * The name of the load balancer to which you want to associate the SSL/TLS certificate. + */ + loadBalancerName: ResourceName; + /** + * The name of your SSL/TLS certificate. + */ + certificateName: ResourceName; + } + export interface AttachLoadBalancerTlsCertificateResult { + /** + * An object representing the API operations. These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose. + */ + operations?: OperationList; + } + export interface AttachStaticIpRequest { + /** + * The name of the static IP. + */ + staticIpName: ResourceName; + /** + * The instance name to which you want to attach the static IP address. + */ + instanceName: ResourceName; + } + export interface AttachStaticIpResult { + /** + * An array of key-value pairs containing information about your API operations. + */ + operations?: OperationList; + } + export type AttachedDiskMap = {[key: string]: DiskMapList}; + export interface AvailabilityZone { + /** + * The name of the Availability Zone. The format is us-east-2a (case-sensitive). + */ + zoneName?: NonEmptyString; + /** + * The state of the Availability Zone. + */ + state?: NonEmptyString; + } + export type AvailabilityZoneList = AvailabilityZone[]; + export type Base64 = string; + export interface Blueprint { + /** + * The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). + */ + blueprintId?: NonEmptyString; + /** + * The friendly name of the blueprint (e.g., Amazon Linux). + */ + name?: ResourceName; + /** + * The group name of the blueprint (e.g., amazon-linux). + */ + group?: NonEmptyString; + /** + * The type of the blueprint (e.g., os or app). + */ + type?: BlueprintType; + /** + * The description of the blueprint. + */ + description?: string; + /** + * A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. + */ + isActive?: boolean; + /** + * The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes. + */ + minPower?: integer; + /** + * The version number of the operating system, application, or stack (e.g., 2016.03.0). + */ + version?: string; + /** + * The version code. + */ + versionCode?: string; + /** + * The product URL to learn more about the image or blueprint. + */ + productUrl?: string; + /** + * The end-user license agreement URL for the image or blueprint. + */ + licenseUrl?: string; + /** + * The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint. + */ + platform?: InstancePlatform; + } + export type BlueprintList = Blueprint[]; + export type BlueprintType = "os"|"app"|string; + export interface Bundle { + /** + * The price in US dollars (e.g., 5.0). + */ + price?: float; + /** + * The number of vCPUs included in the bundle (e.g., 2). + */ + cpuCount?: integer; + /** + * The size of the SSD (e.g., 30). + */ + diskSizeInGb?: integer; + /** + * The bundle ID (e.g., micro_1_0). + */ + bundleId?: NonEmptyString; + /** + * The Amazon EC2 instance type (e.g., t2.micro). + */ + instanceType?: string; + /** + * A Boolean value indicating whether the bundle is active. + */ + isActive?: boolean; + /** + * A friendly name for the bundle (e.g., Micro). + */ + name?: string; + /** + * A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. + */ + power?: integer; + /** + * The amount of RAM in GB (e.g., 2.0). + */ + ramSizeInGb?: float; + /** + * The data transfer rate per month in GB (e.g., 2000). + */ + transferPerMonthInGb?: integer; + /** + * The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle. + */ + supportedPlatforms?: InstancePlatformList; + } + export type BundleList = Bundle[]; + export interface CloseInstancePublicPortsRequest { + /** + * Information about the public port you are trying to close. + */ + portInfo: PortInfo; + /** + * The name of the instance on which you're attempting to close the public ports. + */ + instanceName: ResourceName; + } + export interface CloseInstancePublicPortsResult { + /** + * An array of key-value pairs that contains information about the operation. + */ + operation?: Operation; + } + export interface CloudFormationStackRecord { + /** + * The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the CloudFormation stack record. + */ + arn?: NonEmptyString; + /** + * The date when the CloudFormation stack record was created. + */ + createdAt?: IsoDate; + /** + * A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record. + */ + location?: ResourceLocation; + /** + * The Lightsail resource type (e.g., CloudFormationStackRecord). + */ + resourceType?: ResourceType; + /** + * The current state of the CloudFormation stack record. + */ + state?: RecordState; + /** + * A list of objects describing the source of the CloudFormation stack record. + */ + sourceInfo?: CloudFormationStackRecordSourceInfoList; + /** + * A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack. + */ + destinationInfo?: DestinationInfo; + } + export type CloudFormationStackRecordList = CloudFormationStackRecord[]; + export interface CloudFormationStackRecordSourceInfo { + /** + * The Lightsail resource type (e.g., ExportSnapshotRecord). + */ + resourceType?: CloudFormationStackRecordSourceType; + /** + * The name of the record. + */ + name?: NonEmptyString; + /** + * The Amazon Resource Name (ARN) of the export snapshot record. + */ + arn?: NonEmptyString; + } + export type CloudFormationStackRecordSourceInfoList = CloudFormationStackRecordSourceInfo[]; + export type CloudFormationStackRecordSourceType = "ExportSnapshotRecord"|string; + export interface CopySnapshotRequest { + /** + * The name of the source instance or disk snapshot to be copied. + */ + sourceSnapshotName: ResourceName; + /** + * The name of the new instance or disk snapshot to be created as a copy. + */ + targetSnapshotName: ResourceName; + /** + * The AWS Region where the source snapshot is located. + */ + sourceRegion: RegionName; + } + export interface CopySnapshotResult { + /** + * A list of objects describing the API operation. + */ + operations?: OperationList; + } + export interface CreateCloudFormationStackRequest { + /** + * An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array. + */ + instances: InstanceEntryList; + } + export interface CreateCloudFormationStackResult { + /** + * A list of objects describing the API operation. + */ + operations?: OperationList; + } + export interface CreateDiskFromSnapshotRequest { + /** + * The unique Lightsail disk name (e.g., my-disk). + */ + diskName: ResourceName; + /** + * The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk. + */ + diskSnapshotName: ResourceName; + /** + * The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk. Use the GetRegions operation to list the Availability Zones where Lightsail is currently available. + */ + availabilityZone: NonEmptyString; + /** + * The size of the disk in GB (e.g., 32). + */ + sizeInGb: integer; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateDiskFromSnapshotResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface CreateDiskRequest { + /** + * The unique Lightsail disk name (e.g., my-disk). + */ + diskName: ResourceName; + /** + * The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk. Use the GetRegions operation to list the Availability Zones where Lightsail is currently available. + */ + availabilityZone: NonEmptyString; + /** + * The size of the disk in GB (e.g., 32). + */ + sizeInGb: integer; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateDiskResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface CreateDiskSnapshotRequest { + /** + * The unique name of the source disk (e.g., Disk-Virginia-1). This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive. + */ + diskName?: ResourceName; + /** + * The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk. + */ + diskSnapshotName: ResourceName; + /** + * The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created. This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive. + */ + instanceName?: ResourceName; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateDiskSnapshotResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface CreateDomainEntryRequest { + /** + * The domain name (e.g., example.com) for which you want to create the domain entry. + */ + domainName: DomainName; + /** + * An array of key-value pairs containing information about the domain entry request. + */ + domainEntry: DomainEntry; + } + export interface CreateDomainEntryResult { + /** + * An array of key-value pairs containing information about the operation. + */ + operation?: Operation; + } + export interface CreateDomainRequest { + /** + * The domain name to manage (e.g., example.com). You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain. + */ + domainName: DomainName; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateDomainResult { + /** + * An array of key-value pairs containing information about the domain resource you created. + */ + operation?: Operation; + } + export interface CreateInstanceSnapshotRequest { + /** + * The name for your new snapshot. + */ + instanceSnapshotName: ResourceName; + /** + * The Lightsail instance on which to base your snapshot. + */ + instanceName: ResourceName; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateInstanceSnapshotResult { + /** + * An array of key-value pairs containing information about the results of your create instances snapshot request. + */ + operations?: OperationList; + } + export interface CreateInstancesFromSnapshotRequest { + /** + * The names for your new instances. + */ + instanceNames: StringList; + /** + * An object containing information about one or more disk mappings. + */ + attachedDiskMapping?: AttachedDiskMap; + /** + * The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request. + */ + availabilityZone: string; + /** + * The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots. + */ + instanceSnapshotName: ResourceName; + /** + * The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0). + */ + bundleId: NonEmptyString; + /** + * You can create a launch script that configures a server with additional user data. For example, apt-get -y update. Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide. + */ + userData?: string; + /** + * The name for your key pair. + */ + keyPairName?: ResourceName; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateInstancesFromSnapshotResult { + /** + * An array of key-value pairs containing information about the results of your create instances from snapshot request. + */ + operations?: OperationList; + } + export interface CreateInstancesRequest { + /** + * The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"] + */ + instanceNames: StringList; + /** + * The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request. + */ + availabilityZone: string; + /** + * (Deprecated) The name for your custom image. In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated. + */ + customImageName?: ResourceName; + /** + * The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints). + */ + blueprintId: NonEmptyString; + /** + * The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0). + */ + bundleId: NonEmptyString; + /** + * A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update. Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide. + */ + userData?: string; + /** + * The name of your key pair. + */ + keyPairName?: ResourceName; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateInstancesResult { + /** + * An array of key-value pairs containing information about the results of your create instances request. + */ + operations?: OperationList; + } + export interface CreateKeyPairRequest { + /** + * The name for your new key pair. + */ + keyPairName: ResourceName; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateKeyPairResult { + /** + * An array of key-value pairs containing information about the new key pair you just created. + */ + keyPair?: KeyPair; + /** + * A base64-encoded public key of the ssh-rsa type. + */ + publicKeyBase64?: Base64; + /** + * A base64-encoded RSA private key. + */ + privateKeyBase64?: Base64; + /** + * An array of key-value pairs containing information about the results of your create key pair request. + */ + operation?: Operation; + } + export interface CreateLoadBalancerRequest { + /** + * The name of your load balancer. + */ + loadBalancerName: ResourceName; + /** + * The instance port where you're creating your load balancer. + */ + instancePort: Port; + /** + * The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/"). You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it. + */ + healthCheckPath?: string; + /** + * The name of the SSL/TLS certificate. If you specify certificateName, then certificateDomainName is required (and vice-versa). + */ + certificateName?: ResourceName; + /** + * The domain name with which your certificate is associated (e.g., example.com). If you specify certificateDomainName, then certificateName is required (and vice-versa). + */ + certificateDomainName?: DomainName; + /** + * The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com). + */ + certificateAlternativeNames?: DomainNameList; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateLoadBalancerResult { + /** + * An object containing information about the API operations. + */ + operations?: OperationList; + } + export interface CreateLoadBalancerTlsCertificateRequest { + /** + * The load balancer name where you want to create the SSL/TLS certificate. + */ + loadBalancerName: ResourceName; + /** + * The SSL/TLS certificate name. You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits. + */ + certificateName: ResourceName; + /** + * The domain name (e.g., example.com) for your SSL/TLS certificate. + */ + certificateDomainName: DomainName; + /** + * An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com). + */ + certificateAlternativeNames?: DomainNameList; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateLoadBalancerTlsCertificateResult { + /** + * An object containing information about the API operations. + */ + operations?: OperationList; + } + export interface CreateRelationalDatabaseFromSnapshotRequest { + /** + * The name to use for your new database. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number. + */ + relationalDatabaseName: ResourceName; + /** + * The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request. + */ + availabilityZone?: string; + /** + * Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database. + */ + publiclyAccessible?: boolean; + /** + * The name of the database snapshot from which to create your new database. + */ + relationalDatabaseSnapshotName?: ResourceName; + /** + * The bundle ID for your new database. A bundle describes the performance specifications for your database. You can get a list of database bundle IDs by using the get relational database bundles operation. When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database. + */ + relationalDatabaseBundleId?: string; + /** + * The name of the source database. + */ + sourceRelationalDatabaseName?: ResourceName; + /** + * The date and time to restore your database from. Constraints: Must be before the latest restorable time for the database. Cannot be specified if the use latest restorable time parameter is true. Specified in Universal Coordinated Time (UTC). Specified in the Unix time format. For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time. + */ + restoreTime?: IsoDate; + /** + * Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time. Default: false Constraints: Cannot be specified if the restore time parameter is provided. + */ + useLatestRestorableTime?: boolean; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateRelationalDatabaseFromSnapshotResult { + /** + * An object describing the result of your create relational database from snapshot request. + */ + operations?: OperationList; + } + export interface CreateRelationalDatabaseRequest { + /** + * The name to use for your new database. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number. + */ + relationalDatabaseName: ResourceName; + /** + * The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request. + */ + availabilityZone?: string; + /** + * The blueprint ID for your new database. A blueprint describes the major engine version of a database. You can get a list of database blueprints IDs by using the get relational database blueprints operation. + */ + relationalDatabaseBlueprintId: string; + /** + * The bundle ID for your new database. A bundle describes the performance specifications for your database. You can get a list of database bundle IDs by using the get relational database bundles operation. + */ + relationalDatabaseBundleId: string; + /** + * The name of the master database created when the Lightsail database resource is created. Constraints: Must contain from 1 to 64 alphanumeric characters. Cannot be a word reserved by the specified database engine + */ + masterDatabaseName: string; + /** + * The master user name for your new database. Constraints: Master user name is required. Must contain from 1 to 16 alphanumeric characters. The first character must be a letter. Cannot be a reserved word for the database engine you choose. For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively. + */ + masterUsername: string; + /** + * The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain 8 to 41 characters. + */ + masterUserPassword?: SensitiveString; + /** + * The daily time range during which automated backups are created for your new database if automated backups are enabled. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation. Constraints: Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 Specified in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + preferredBackupWindow?: string; + /** + * The weekly time range during which system maintenance can occur on your new database. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: Must be in the ddd:hh24:mi-ddd:hh24:mi format. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be at least 30 minutes. Specified in Universal Coordinated Time (UTC). Example: Tue:17:00-Tue:17:30 + */ + preferredMaintenanceWindow?: string; + /** + * Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database. + */ + publiclyAccessible?: boolean; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateRelationalDatabaseResult { + /** + * An object describing the result of your create relational database request. + */ + operations?: OperationList; + } + export interface CreateRelationalDatabaseSnapshotRequest { + /** + * The name of the database on which to base your new snapshot. + */ + relationalDatabaseName: ResourceName; + /** + * The name for your new database snapshot. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number. + */ + relationalDatabaseSnapshotName: ResourceName; + /** + * The tag keys and optional values to add to the resource during create. To tag a resource after it has been created, see the tag resource operation. + */ + tags?: TagList; + } + export interface CreateRelationalDatabaseSnapshotResult { + /** + * An object describing the result of your create relational database snapshot request. + */ + operations?: OperationList; + } + export interface DeleteDiskRequest { + /** + * The unique name of the disk you want to delete (e.g., my-disk). + */ + diskName: ResourceName; + } + export interface DeleteDiskResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface DeleteDiskSnapshotRequest { + /** + * The name of the disk snapshot you want to delete (e.g., my-disk-snapshot). + */ + diskSnapshotName: ResourceName; + } + export interface DeleteDiskSnapshotResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface DeleteDomainEntryRequest { + /** + * The name of the domain entry to delete. + */ + domainName: DomainName; + /** + * An array of key-value pairs containing information about your domain entries. + */ + domainEntry: DomainEntry; + } + export interface DeleteDomainEntryResult { + /** + * An array of key-value pairs containing information about the results of your delete domain entry request. + */ + operation?: Operation; + } + export interface DeleteDomainRequest { + /** + * The specific domain name to delete. + */ + domainName: DomainName; + } + export interface DeleteDomainResult { + /** + * An array of key-value pairs containing information about the results of your delete domain request. + */ + operation?: Operation; + } + export interface DeleteInstanceRequest { + /** + * The name of the instance to delete. + */ + instanceName: ResourceName; + } + export interface DeleteInstanceResult { + /** + * An array of key-value pairs containing information about the results of your delete instance request. + */ + operations?: OperationList; + } + export interface DeleteInstanceSnapshotRequest { + /** + * The name of the snapshot to delete. + */ + instanceSnapshotName: ResourceName; + } + export interface DeleteInstanceSnapshotResult { + /** + * An array of key-value pairs containing information about the results of your delete instance snapshot request. + */ + operations?: OperationList; + } + export interface DeleteKeyPairRequest { + /** + * The name of the key pair to delete. + */ + keyPairName: ResourceName; + } + export interface DeleteKeyPairResult { + /** + * An array of key-value pairs containing information about the results of your delete key pair request. + */ + operation?: Operation; + } + export interface DeleteKnownHostKeysRequest { + /** + * The name of the instance for which you want to reset the host key or certificate. + */ + instanceName: ResourceName; + } + export interface DeleteKnownHostKeysResult { + /** + * A list of objects describing the API operation. + */ + operations?: OperationList; + } + export interface DeleteLoadBalancerRequest { + /** + * The name of the load balancer you want to delete. + */ + loadBalancerName: ResourceName; + } + export interface DeleteLoadBalancerResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface DeleteLoadBalancerTlsCertificateRequest { + /** + * The load balancer name. + */ + loadBalancerName: ResourceName; + /** + * The SSL/TLS certificate name. + */ + certificateName: ResourceName; + /** + * When true, forces the deletion of an SSL/TLS certificate. There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer. + */ + force?: boolean; + } + export interface DeleteLoadBalancerTlsCertificateResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface DeleteRelationalDatabaseRequest { + /** + * The name of the database that you are deleting. + */ + relationalDatabaseName: ResourceName; + /** + * Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false. Default: false + */ + skipFinalSnapshot?: boolean; + /** + * The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter. Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number. + */ + finalRelationalDatabaseSnapshotName?: ResourceName; + } + export interface DeleteRelationalDatabaseResult { + /** + * An object describing the result of your delete relational database request. + */ + operations?: OperationList; + } + export interface DeleteRelationalDatabaseSnapshotRequest { + /** + * The name of the database snapshot that you are deleting. + */ + relationalDatabaseSnapshotName: ResourceName; + } + export interface DeleteRelationalDatabaseSnapshotResult { + /** + * An object describing the result of your delete relational database snapshot request. + */ + operations?: OperationList; + } + export interface DestinationInfo { + /** + * The ID of the resource created at the destination. + */ + id?: NonEmptyString; + /** + * The destination service of the record. + */ + service?: NonEmptyString; + } + export interface DetachDiskRequest { + /** + * The unique name of the disk you want to detach from your instance (e.g., my-disk). + */ + diskName: ResourceName; + } + export interface DetachDiskResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface DetachInstancesFromLoadBalancerRequest { + /** + * The name of the Lightsail load balancer. + */ + loadBalancerName: ResourceName; + /** + * An array of strings containing the names of the instances you want to detach from the load balancer. + */ + instanceNames: ResourceNameList; + } + export interface DetachInstancesFromLoadBalancerResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface DetachStaticIpRequest { + /** + * The name of the static IP to detach from the instance. + */ + staticIpName: ResourceName; + } + export interface DetachStaticIpResult { + /** + * An array of key-value pairs containing information about the results of your detach static IP request. + */ + operations?: OperationList; + } + export interface Disk { + /** + * The unique name of the disk. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the disk. + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The date when the disk was created. + */ + createdAt?: IsoDate; + /** + * The AWS Region and Availability Zone where the disk is located. + */ + location?: ResourceLocation; + /** + * The Lightsail resource type (e.g., Disk). + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The size of the disk in GB. + */ + sizeInGb?: integer; + /** + * A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it). + */ + isSystemDisk?: boolean; + /** + * The input/output operations per second (IOPS) of the disk. + */ + iops?: integer; + /** + * The disk path. + */ + path?: string; + /** + * Describes the status of the disk. + */ + state?: DiskState; + /** + * The resources to which the disk is attached. + */ + attachedTo?: ResourceName; + /** + * A Boolean value indicating whether the disk is attached. + */ + isAttached?: boolean; + /** + * (Deprecated) The attachment state of the disk. In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead. + */ + attachmentState?: string; + /** + * (Deprecated) The number of GB in use by the disk. In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated. + */ + gbInUse?: integer; + } + export interface DiskInfo { + /** + * The disk name. + */ + name?: string; + /** + * The disk path. + */ + path?: NonEmptyString; + /** + * The size of the disk in GB (e.g., 32). + */ + sizeInGb?: integer; + /** + * A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it). + */ + isSystemDisk?: boolean; + } + export type DiskInfoList = DiskInfo[]; + export type DiskList = Disk[]; + export interface DiskMap { + /** + * The original disk path exposed to the instance (for example, /dev/sdh). + */ + originalDiskPath?: NonEmptyString; + /** + * The new disk name (e.g., my-new-disk). + */ + newDiskName?: ResourceName; + } + export type DiskMapList = DiskMap[]; + export interface DiskSnapshot { + /** + * The name of the disk snapshot (e.g., my-disk-snapshot). + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the disk snapshot. + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The date when the disk snapshot was created. + */ + createdAt?: IsoDate; + /** + * The AWS Region and Availability Zone where the disk snapshot was created. + */ + location?: ResourceLocation; + /** + * The Lightsail resource type (e.g., DiskSnapshot). + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The size of the disk in GB. + */ + sizeInGb?: integer; + /** + * The status of the disk snapshot operation. + */ + state?: DiskSnapshotState; + /** + * The progress of the disk snapshot operation. + */ + progress?: string; + /** + * The unique name of the source disk from which the disk snapshot was created. + */ + fromDiskName?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created. + */ + fromDiskArn?: NonEmptyString; + /** + * The unique name of the source instance from which the disk (system volume) snapshot was created. + */ + fromInstanceName?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created. + */ + fromInstanceArn?: NonEmptyString; + } + export interface DiskSnapshotInfo { + /** + * The size of the disk in GB (e.g., 32). + */ + sizeInGb?: integer; + } + export type DiskSnapshotList = DiskSnapshot[]; + export type DiskSnapshotState = "pending"|"completed"|"error"|"unknown"|string; + export type DiskState = "pending"|"error"|"available"|"in-use"|"unknown"|string; + export interface Domain { + /** + * The name of the domain. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE). + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The date when the domain recordset was created. + */ + createdAt?: IsoDate; + /** + * The AWS Region and Availability Zones where the domain recordset was created. + */ + location?: ResourceLocation; + /** + * The resource type. + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * An array of key-value pairs containing information about the domain entries. + */ + domainEntries?: DomainEntryList; + } + export interface DomainEntry { + /** + * The ID of the domain recordset entry. + */ + id?: NonEmptyString; + /** + * The name of the domain. + */ + name?: DomainName; + /** + * The target AWS name server (e.g., ns-111.awsdns-22.com.). For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set isAlias to true when setting up an A record for a load balancer. + */ + target?: string; + /** + * When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer + */ + isAlias?: boolean; + /** + * The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The following domain entry types can be used: A CNAME MX NS SOA SRV TXT + */ + type?: DomainEntryType; + /** + * (Deprecated) The options for the domain entry. In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated. + */ + options?: DomainEntryOptions; + } + export type DomainEntryList = DomainEntry[]; + export type DomainEntryOptions = {[key: string]: string}; + export type DomainEntryOptionsKeys = string; + export type DomainEntryType = string; + export type DomainList = Domain[]; + export type DomainName = string; + export type DomainNameList = DomainName[]; + export interface DownloadDefaultKeyPairRequest { + } + export interface DownloadDefaultKeyPairResult { + /** + * A base64-encoded public key of the ssh-rsa type. + */ + publicKeyBase64?: Base64; + /** + * A base64-encoded RSA private key. + */ + privateKeyBase64?: Base64; + } + export interface ExportSnapshotRecord { + /** + * The export snapshot record name. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the export snapshot record. + */ + arn?: NonEmptyString; + /** + * The date when the export snapshot record was created. + */ + createdAt?: IsoDate; + /** + * The AWS Region and Availability Zone where the export snapshot record is located. + */ + location?: ResourceLocation; + /** + * The Lightsail resource type (e.g., ExportSnapshotRecord). + */ + resourceType?: ResourceType; + /** + * The state of the export snapshot record. + */ + state?: RecordState; + /** + * A list of objects describing the source of the export snapshot record. + */ + sourceInfo?: ExportSnapshotRecordSourceInfo; + /** + * A list of objects describing the destination of the export snapshot record. + */ + destinationInfo?: DestinationInfo; + } + export type ExportSnapshotRecordList = ExportSnapshotRecord[]; + export interface ExportSnapshotRecordSourceInfo { + /** + * The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot). + */ + resourceType?: ExportSnapshotRecordSourceType; + /** + * The date when the source instance or disk snapshot was created. + */ + createdAt?: IsoDate; + /** + * The name of the source instance or disk snapshot. + */ + name?: NonEmptyString; + /** + * The Amazon Resource Name (ARN) of the source instance or disk snapshot. + */ + arn?: NonEmptyString; + /** + * The name of the snapshot's source instance or disk. + */ + fromResourceName?: NonEmptyString; + /** + * The Amazon Resource Name (ARN) of the snapshot's source instance or disk. + */ + fromResourceArn?: NonEmptyString; + /** + * A list of objects describing an instance snapshot. + */ + instanceSnapshotInfo?: InstanceSnapshotInfo; + /** + * A list of objects describing a disk snapshot. + */ + diskSnapshotInfo?: DiskSnapshotInfo; + } + export type ExportSnapshotRecordSourceType = "InstanceSnapshot"|"DiskSnapshot"|string; + export interface ExportSnapshotRequest { + /** + * The name of the instance or disk snapshot to be exported to Amazon EC2. + */ + sourceSnapshotName: ResourceName; + } + export interface ExportSnapshotResult { + /** + * A list of objects describing the API operation. + */ + operations?: OperationList; + } + export interface GetActiveNamesRequest { + /** + * A token used for paginating results from your get active names request. + */ + pageToken?: string; + } + export interface GetActiveNamesResult { + /** + * The list of active names returned by the get active names request. + */ + activeNames?: StringList; + /** + * A token used for advancing to the next page of results from your get active names request. + */ + nextPageToken?: string; + } + export interface GetBlueprintsRequest { + /** + * A Boolean value indicating whether to include inactive results in your request. + */ + includeInactive?: boolean; + /** + * A token used for advancing to the next page of results from your get blueprints request. + */ + pageToken?: string; + } + export interface GetBlueprintsResult { + /** + * An array of key-value pairs that contains information about the available blueprints. + */ + blueprints?: BlueprintList; + /** + * A token used for advancing to the next page of results from your get blueprints request. + */ + nextPageToken?: string; + } + export interface GetBundlesRequest { + /** + * A Boolean value that indicates whether to include inactive bundle results in your request. + */ + includeInactive?: boolean; + /** + * A token used for advancing to the next page of results from your get bundles request. + */ + pageToken?: string; + } + export interface GetBundlesResult { + /** + * An array of key-value pairs that contains information about the available bundles. + */ + bundles?: BundleList; + /** + * A token used for advancing to the next page of results from your get active names request. + */ + nextPageToken?: string; + } + export interface GetCloudFormationStackRecordsRequest { + /** + * A token used for advancing to a specific page of results for your get cloud formation stack records request. + */ + pageToken?: string; + } + export interface GetCloudFormationStackRecordsResult { + /** + * A list of objects describing the CloudFormation stack records. + */ + cloudFormationStackRecords?: CloudFormationStackRecordList; + /** + * A token used for advancing to the next page of results of your get relational database bundles request. + */ + nextPageToken?: string; + } + export interface GetDiskRequest { + /** + * The name of the disk (e.g., my-disk). + */ + diskName: ResourceName; + } + export interface GetDiskResult { + /** + * An object containing information about the disk. + */ + disk?: Disk; + } + export interface GetDiskSnapshotRequest { + /** + * The name of the disk snapshot (e.g., my-disk-snapshot). + */ + diskSnapshotName: ResourceName; + } + export interface GetDiskSnapshotResult { + /** + * An object containing information about the disk snapshot. + */ + diskSnapshot?: DiskSnapshot; + } + export interface GetDiskSnapshotsRequest { + /** + * A token used for advancing to the next page of results from your GetDiskSnapshots request. + */ + pageToken?: string; + } + export interface GetDiskSnapshotsResult { + /** + * An array of objects containing information about all block storage disk snapshots. + */ + diskSnapshots?: DiskSnapshotList; + /** + * A token used for advancing to the next page of results from your GetDiskSnapshots request. + */ + nextPageToken?: string; + } + export interface GetDisksRequest { + /** + * A token used for advancing to the next page of results from your GetDisks request. + */ + pageToken?: string; + } + export interface GetDisksResult { + /** + * An array of objects containing information about all block storage disks. + */ + disks?: DiskList; + /** + * A token used for advancing to the next page of results from your GetDisks request. + */ + nextPageToken?: string; + } + export interface GetDomainRequest { + /** + * The domain name for which your want to return information about. + */ + domainName: DomainName; + } + export interface GetDomainResult { + /** + * An array of key-value pairs containing information about your get domain request. + */ + domain?: Domain; + } + export interface GetDomainsRequest { + /** + * A token used for advancing to the next page of results from your get domains request. + */ + pageToken?: string; + } + export interface GetDomainsResult { + /** + * An array of key-value pairs containing information about each of the domain entries in the user's account. + */ + domains?: DomainList; + /** + * A token used for advancing to the next page of results from your get active names request. + */ + nextPageToken?: string; + } + export interface GetExportSnapshotRecordsRequest { + /** + * A token used for advancing to a specific page of results for your get export snapshot records request. + */ + pageToken?: string; + } + export interface GetExportSnapshotRecordsResult { + /** + * A list of objects describing the export snapshot records. + */ + exportSnapshotRecords?: ExportSnapshotRecordList; + /** + * A token used for advancing to the next page of results of your get relational database bundles request. + */ + nextPageToken?: string; + } + export interface GetInstanceAccessDetailsRequest { + /** + * The name of the instance to access. + */ + instanceName: ResourceName; + /** + * The protocol to use to connect to your instance. Defaults to ssh. + */ + protocol?: InstanceAccessProtocol; + } + export interface GetInstanceAccessDetailsResult { + /** + * An array of key-value pairs containing information about a get instance access request. + */ + accessDetails?: InstanceAccessDetails; + } + export interface GetInstanceMetricDataRequest { + /** + * The name of the instance for which you want to get metrics data. + */ + instanceName: ResourceName; + /** + * The metric name to get data about. + */ + metricName: InstanceMetricName; + /** + * The granularity, in seconds, of the returned data points. + */ + period: MetricPeriod; + /** + * The start time of the time period. + */ + startTime: timestamp; + /** + * The end time of the time period. + */ + endTime: timestamp; + /** + * The unit. The list of valid values is below. + */ + unit: MetricUnit; + /** + * The instance statistics. + */ + statistics: MetricStatisticList; + } + export interface GetInstanceMetricDataResult { + /** + * The metric name to return data for. + */ + metricName?: InstanceMetricName; + /** + * An array of key-value pairs containing information about the results of your get instance metric data request. + */ + metricData?: MetricDatapointList; + } + export interface GetInstancePortStatesRequest { + /** + * The name of the instance. + */ + instanceName: ResourceName; + } + export interface GetInstancePortStatesResult { + /** + * Information about the port states resulting from your request. + */ + portStates?: InstancePortStateList; + } + export interface GetInstanceRequest { + /** + * The name of the instance. + */ + instanceName: ResourceName; + } + export interface GetInstanceResult { + /** + * An array of key-value pairs containing information about the specified instance. + */ + instance?: Instance; + } + export interface GetInstanceSnapshotRequest { + /** + * The name of the snapshot for which you are requesting information. + */ + instanceSnapshotName: ResourceName; + } + export interface GetInstanceSnapshotResult { + /** + * An array of key-value pairs containing information about the results of your get instance snapshot request. + */ + instanceSnapshot?: InstanceSnapshot; + } + export interface GetInstanceSnapshotsRequest { + /** + * A token used for advancing to the next page of results from your get instance snapshots request. + */ + pageToken?: string; + } + export interface GetInstanceSnapshotsResult { + /** + * An array of key-value pairs containing information about the results of your get instance snapshots request. + */ + instanceSnapshots?: InstanceSnapshotList; + /** + * A token used for advancing to the next page of results from your get instance snapshots request. + */ + nextPageToken?: string; + } + export interface GetInstanceStateRequest { + /** + * The name of the instance to get state information about. + */ + instanceName: ResourceName; + } + export interface GetInstanceStateResult { + /** + * The state of the instance. + */ + state?: InstanceState; + } + export interface GetInstancesRequest { + /** + * A token used for advancing to the next page of results from your get instances request. + */ + pageToken?: string; + } + export interface GetInstancesResult { + /** + * An array of key-value pairs containing information about your instances. + */ + instances?: InstanceList; + /** + * A token used for advancing to the next page of results from your get instances request. + */ + nextPageToken?: string; + } + export interface GetKeyPairRequest { + /** + * The name of the key pair for which you are requesting information. + */ + keyPairName: ResourceName; + } + export interface GetKeyPairResult { + /** + * An array of key-value pairs containing information about the key pair. + */ + keyPair?: KeyPair; + } + export interface GetKeyPairsRequest { + /** + * A token used for advancing to the next page of results from your get key pairs request. + */ + pageToken?: string; + } + export interface GetKeyPairsResult { + /** + * An array of key-value pairs containing information about the key pairs. + */ + keyPairs?: KeyPairList; + /** + * A token used for advancing to the next page of results from your get key pairs request. + */ + nextPageToken?: string; + } + export interface GetLoadBalancerMetricDataRequest { + /** + * The name of the load balancer. + */ + loadBalancerName: ResourceName; + /** + * The metric about which you want to return information. Valid values are listed below, along with the most useful statistics to include in your request. ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. HealthyHostCount - The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. UnhealthyHostCount - The number of target instances that are considered unhealthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics: The most useful statistic is Average. RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics: The most useful statistic is Sum. RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. + */ + metricName: LoadBalancerMetricName; + /** + * The granularity, in seconds, of the returned data points. + */ + period: MetricPeriod; + /** + * The start time of the period. + */ + startTime: timestamp; + /** + * The end time of the period. + */ + endTime: timestamp; + /** + * The unit for the time period request. Valid values are listed below. + */ + unit: MetricUnit; + /** + * An array of statistics that you want to request metrics for. Valid values are listed below. SampleCount - The count (number) of data points used for the statistical calculation. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed. Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric. Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application. + */ + statistics: MetricStatisticList; + } + export interface GetLoadBalancerMetricDataResult { + /** + * The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request. ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. HealthyHostCount - The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. UnhealthyHostCount - The number of target instances that are considered unhealthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics: The most useful statistic is Average. RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics: The most useful statistic is Sum. RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. + */ + metricName?: LoadBalancerMetricName; + /** + * An array of metric datapoint objects. + */ + metricData?: MetricDatapointList; + } + export interface GetLoadBalancerRequest { + /** + * The name of the load balancer. + */ + loadBalancerName: ResourceName; + } + export interface GetLoadBalancerResult { + /** + * An object containing information about your load balancer. + */ + loadBalancer?: LoadBalancer; + } + export interface GetLoadBalancerTlsCertificatesRequest { + /** + * The name of the load balancer you associated with your SSL/TLS certificate. + */ + loadBalancerName: ResourceName; + } + export interface GetLoadBalancerTlsCertificatesResult { + /** + * An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates. + */ + tlsCertificates?: LoadBalancerTlsCertificateList; + } + export interface GetLoadBalancersRequest { + /** + * A token used for paginating the results from your GetLoadBalancers request. + */ + pageToken?: string; + } + export interface GetLoadBalancersResult { + /** + * An array of LoadBalancer objects describing your load balancers. + */ + loadBalancers?: LoadBalancerList; + /** + * A token used for advancing to the next page of results from your GetLoadBalancers request. + */ + nextPageToken?: string; + } + export interface GetOperationRequest { + /** + * A GUID used to identify the operation. + */ + operationId: NonEmptyString; + } + export interface GetOperationResult { + /** + * An array of key-value pairs containing information about the results of your get operation request. + */ + operation?: Operation; + } + export interface GetOperationsForResourceRequest { + /** + * The name of the resource for which you are requesting information. + */ + resourceName: ResourceName; + /** + * A token used for advancing to the next page of results from your get operations for resource request. + */ + pageToken?: string; + } + export interface GetOperationsForResourceResult { + /** + * An array of key-value pairs containing information about the results of your get operations for resource request. + */ + operations?: OperationList; + /** + * (Deprecated) Returns the number of pages of results that remain. In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the next page token parameter instead. + */ + nextPageCount?: string; + /** + * 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. + */ + nextPageToken?: string; + } + export interface GetOperationsRequest { + /** + * A token used for advancing to the next page of results from your get operations request. + */ + pageToken?: string; + } + export interface GetOperationsResult { + /** + * An array of key-value pairs containing information about the results of your get operations request. + */ + operations?: OperationList; + /** + * A token used for advancing to the next page of results from your get operations request. + */ + nextPageToken?: string; + } + export interface GetRegionsRequest { + /** + * A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a. + */ + includeAvailabilityZones?: boolean; + /** + * >A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a). + */ + includeRelationalDatabaseAvailabilityZones?: boolean; + } + export interface GetRegionsResult { + /** + * An array of key-value pairs containing information about your get regions request. + */ + regions?: RegionList; + } + export interface GetRelationalDatabaseBlueprintsRequest { + /** + * A token used for advancing to a specific page of results for your get relational database blueprints request. + */ + pageToken?: string; + } + export interface GetRelationalDatabaseBlueprintsResult { + /** + * An object describing the result of your get relational database blueprints request. + */ + blueprints?: RelationalDatabaseBlueprintList; + /** + * A token used for advancing to the next page of results of your get relational database blueprints request. + */ + nextPageToken?: string; + } + export interface GetRelationalDatabaseBundlesRequest { + /** + * A token used for advancing to a specific page of results for your get relational database bundles request. + */ + pageToken?: string; + } + export interface GetRelationalDatabaseBundlesResult { + /** + * An object describing the result of your get relational database bundles request. + */ + bundles?: RelationalDatabaseBundleList; + /** + * A token used for advancing to the next page of results of your get relational database bundles request. + */ + nextPageToken?: string; + } + export interface GetRelationalDatabaseEventsRequest { + /** + * The name of the database from which to get events. + */ + relationalDatabaseName: ResourceName; + /** + * The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120. Default: 60 The minimum is 1 and the maximum is 14 days (20160 minutes). + */ + durationInMinutes?: integer; + /** + * A token used for advancing to a specific page of results from for get relational database events request. + */ + pageToken?: string; + } + export interface GetRelationalDatabaseEventsResult { + /** + * An object describing the result of your get relational database events request. + */ + relationalDatabaseEvents?: RelationalDatabaseEventList; + /** + * A token used for advancing to the next page of results from your get relational database events request. + */ + nextPageToken?: string; + } + export interface GetRelationalDatabaseLogEventsRequest { + /** + * The name of your database for which to get log events. + */ + relationalDatabaseName: ResourceName; + /** + * The name of the log stream. Use the get relational database log streams operation to get a list of available log streams. + */ + logStreamName: string; + /** + * The start of the time interval from which to get log events. Constraints: Specified in Universal Coordinated Time (UTC). Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time. + */ + startTime?: IsoDate; + /** + * The end of the time interval from which to get log events. Constraints: Specified in Universal Coordinated Time (UTC). Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time. + */ + endTime?: IsoDate; + /** + * Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log. Default: false + */ + startFromHead?: boolean; + /** + * A token used for advancing to a specific page of results for your get relational database log events request. + */ + pageToken?: string; + } + export interface GetRelationalDatabaseLogEventsResult { + /** + * An object describing the result of your get relational database log events request. + */ + resourceLogEvents?: LogEventList; + /** + * A token used for advancing to the previous page of results from your get relational database log events request. + */ + nextBackwardToken?: string; + /** + * A token used for advancing to the next page of results from your get relational database log events request. + */ + nextForwardToken?: string; + } + export interface GetRelationalDatabaseLogStreamsRequest { + /** + * The name of your database for which to get log streams. + */ + relationalDatabaseName: ResourceName; + } + export interface GetRelationalDatabaseLogStreamsResult { + /** + * An object describing the result of your get relational database log streams request. + */ + logStreams?: StringList; + } + export interface GetRelationalDatabaseMasterUserPasswordRequest { + /** + * The name of your database for which to get the master user password. + */ + relationalDatabaseName: ResourceName; + /** + * The password version to return. Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available. Default: CURRENT + */ + passwordVersion?: RelationalDatabasePasswordVersion; + } + export interface GetRelationalDatabaseMasterUserPasswordResult { + /** + * The master user password for the password version specified. + */ + masterUserPassword?: SensitiveString; + /** + * The timestamp when the specified version of the master user password was created. + */ + createdAt?: IsoDate; + } + export interface GetRelationalDatabaseMetricDataRequest { + /** + * The name of your database from which to get metric data. + */ + relationalDatabaseName: ResourceName; + /** + * The name of the metric data to return. + */ + metricName: RelationalDatabaseMetricName; + /** + * The granularity, in seconds, of the returned data points. + */ + period: MetricPeriod; + /** + * The start of the time interval from which to get metric data. Constraints: Specified in Universal Coordinated Time (UTC). Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time. + */ + startTime: IsoDate; + /** + * The end of the time interval from which to get metric data. Constraints: Specified in Universal Coordinated Time (UTC). Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time. + */ + endTime: IsoDate; + /** + * The unit for the metric data request. + */ + unit: MetricUnit; + /** + * The array of statistics for your metric data request. + */ + statistics: MetricStatisticList; + } + export interface GetRelationalDatabaseMetricDataResult { + /** + * The name of the metric. + */ + metricName?: RelationalDatabaseMetricName; + /** + * An object describing the result of your get relational database metric data request. + */ + metricData?: MetricDatapointList; + } + export interface GetRelationalDatabaseParametersRequest { + /** + * The name of your database for which to get parameters. + */ + relationalDatabaseName: ResourceName; + /** + * A token used for advancing to a specific page of results for your get relational database parameters request. + */ + pageToken?: string; + } + export interface GetRelationalDatabaseParametersResult { + /** + * An object describing the result of your get relational database parameters request. + */ + parameters?: RelationalDatabaseParameterList; + /** + * A token used for advancing to the next page of results from your get static IPs request. + */ + nextPageToken?: string; + } + export interface GetRelationalDatabaseRequest { + /** + * The name of the database that you are looking up. + */ + relationalDatabaseName: ResourceName; + } + export interface GetRelationalDatabaseResult { + /** + * An object describing the specified database. + */ + relationalDatabase?: RelationalDatabase; + } + export interface GetRelationalDatabaseSnapshotRequest { + /** + * The name of the database snapshot for which to get information. + */ + relationalDatabaseSnapshotName: ResourceName; + } + export interface GetRelationalDatabaseSnapshotResult { + /** + * An object describing the specified database snapshot. + */ + relationalDatabaseSnapshot?: RelationalDatabaseSnapshot; + } + export interface GetRelationalDatabaseSnapshotsRequest { + /** + * A token used for advancing to a specific page of results for your get relational database snapshots request. + */ + pageToken?: string; + } + export interface GetRelationalDatabaseSnapshotsResult { + /** + * An object describing the result of your get relational database snapshots request. + */ + relationalDatabaseSnapshots?: RelationalDatabaseSnapshotList; + /** + * A token used for advancing to the next page of results from your get relational database snapshots request. + */ + nextPageToken?: string; + } + export interface GetRelationalDatabasesRequest { + /** + * A token used for advancing to a specific page of results for your get relational database request. + */ + pageToken?: string; + } + export interface GetRelationalDatabasesResult { + /** + * An object describing the result of your get relational databases request. + */ + relationalDatabases?: RelationalDatabaseList; + /** + * A token used for advancing to the next page of results from your get relational databases request. + */ + nextPageToken?: string; + } + export interface GetStaticIpRequest { + /** + * The name of the static IP in Lightsail. + */ + staticIpName: ResourceName; + } + export interface GetStaticIpResult { + /** + * An array of key-value pairs containing information about the requested static IP. + */ + staticIp?: StaticIp; + } + export interface GetStaticIpsRequest { + /** + * A token used for advancing to the next page of results from your get static IPs request. + */ + pageToken?: string; + } + export interface GetStaticIpsResult { + /** + * An array of key-value pairs containing information about your get static IPs request. + */ + staticIps?: StaticIpList; + /** + * A token used for advancing to the next page of results from your get static IPs request. + */ + nextPageToken?: string; + } + export interface HostKeyAttributes { + /** + * The SSH host key algorithm or the RDP certificate format. For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert. + */ + algorithm?: string; + /** + * The public SSH host key or the RDP certificate. + */ + publicKey?: string; + /** + * The time that the SSH host key or RDP certificate was recorded by Lightsail. + */ + witnessedAt?: IsoDate; + /** + * The SHA-1 fingerprint of the returned SSH host key or RDP certificate. Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0 Example of an SHA-1 RDP fingerprint: af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45 + */ + fingerprintSHA1?: string; + /** + * The SHA-256 fingerprint of the returned SSH host key or RDP certificate. Example of an SHA-256 SSH fingerprint: SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o Example of an SHA-256 RDP fingerprint: 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68 + */ + fingerprintSHA256?: string; + /** + * The returned RDP certificate is valid after this point in time. This value is listed only for RDP certificates. + */ + notValidBefore?: IsoDate; + /** + * The returned RDP certificate is not valid after this point in time. This value is listed only for RDP certificates. + */ + notValidAfter?: IsoDate; + } + export type HostKeysList = HostKeyAttributes[]; + export interface ImportKeyPairRequest { + /** + * The name of the key pair for which you want to import the public key. + */ + keyPairName: ResourceName; + /** + * A base64-encoded public key of the ssh-rsa type. + */ + publicKeyBase64: Base64; + } + export interface ImportKeyPairResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operation?: Operation; + } + export interface Instance { + /** + * The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1). + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE). + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The timestamp when the instance was created (e.g., 1479734909.17). + */ + createdAt?: IsoDate; + /** + * The region name and Availability Zone where the instance is located. + */ + location?: ResourceLocation; + /** + * The type of resource (usually Instance). + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The blueprint ID (e.g., os_amlinux_2016_03). + */ + blueprintId?: NonEmptyString; + /** + * The friendly name of the blueprint (e.g., Amazon Linux). + */ + blueprintName?: NonEmptyString; + /** + * The bundle for the instance (e.g., micro_1_0). + */ + bundleId?: NonEmptyString; + /** + * A Boolean value indicating whether this instance has a static IP assigned to it. + */ + isStaticIp?: boolean; + /** + * The private IP address of the instance. + */ + privateIpAddress?: IpAddress; + /** + * The public IP address of the instance. + */ + publicIpAddress?: IpAddress; + /** + * The IPv6 address of the instance. + */ + ipv6Address?: IpV6Address; + /** + * The size of the vCPU and the amount of RAM for the instance. + */ + hardware?: InstanceHardware; + /** + * Information about the public ports and monthly data transfer rates for the instance. + */ + networking?: InstanceNetworking; + /** + * The status code and the state (e.g., running) for the instance. + */ + state?: InstanceState; + /** + * The user name for connecting to the instance (e.g., ec2-user). + */ + username?: NonEmptyString; + /** + * The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair). + */ + sshKeyName?: ResourceName; + } + export interface InstanceAccessDetails { + /** + * For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub. + */ + certKey?: string; + /** + * For SSH access, the date on which the temporary keys expire. + */ + expiresAt?: IsoDate; + /** + * The public IP address of the Amazon Lightsail instance. + */ + ipAddress?: IpAddress; + /** + * For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready. If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string. If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default. + */ + password?: string; + /** + * For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready. + */ + passwordData?: PasswordData; + /** + * For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey). + */ + privateKey?: string; + /** + * The protocol for these Amazon Lightsail instance access details. + */ + protocol?: InstanceAccessProtocol; + /** + * The name of this Amazon Lightsail instance. + */ + instanceName?: ResourceName; + /** + * The user name to use when logging in to the Amazon Lightsail instance. + */ + username?: string; + /** + * Describes the public SSH host keys or the RDP certificate. + */ + hostKeys?: HostKeysList; + } + export type InstanceAccessProtocol = "ssh"|"rdp"|string; + export interface InstanceEntry { + /** + * The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance. Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack. + */ + sourceName: ResourceName; + /** + * The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance. + */ + instanceType: NonEmptyString; + /** + * The port configuration to use for the new Amazon EC2 instance. The following configuration options are available: DEFAULT — Use the default firewall settings from the image. INSTANCE — Use the firewall settings from the source Lightsail instance. NONE — Default to Amazon EC2. CLOSED — All ports closed. + */ + portInfoSource: PortInfoSourceType; + /** + * A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update. Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. + */ + userData?: string; + /** + * The Availability Zone for the new Amazon EC2 instance. + */ + availabilityZone: string; + } + export type InstanceEntryList = InstanceEntry[]; + export interface InstanceHardware { + /** + * The number of vCPUs the instance has. + */ + cpuCount?: integer; + /** + * The disks attached to the instance. + */ + disks?: DiskList; + /** + * The amount of RAM in GB on the instance (e.g., 1.0). + */ + ramSizeInGb?: float; + } + export type InstanceHealthReason = "Lb.RegistrationInProgress"|"Lb.InitialHealthChecking"|"Lb.InternalError"|"Instance.ResponseCodeMismatch"|"Instance.Timeout"|"Instance.FailedHealthChecks"|"Instance.NotRegistered"|"Instance.NotInUse"|"Instance.DeregistrationInProgress"|"Instance.InvalidState"|"Instance.IpUnusable"|string; + export type InstanceHealthState = "initial"|"healthy"|"unhealthy"|"unused"|"draining"|"unavailable"|string; + export interface InstanceHealthSummary { + /** + * The name of the Lightsail instance for which you are requesting health check data. + */ + instanceName?: ResourceName; + /** + * Describes the overall instance health. Valid values are below. + */ + instanceHealth?: InstanceHealthState; + /** + * More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided. If instanceHealth is initial, the instanceHealthReason value can be one of the following: Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer. Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status. If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following: Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Instance.Timeout - The health check requests timed out. Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason. Lb.InternalError - The health checks failed due to an internal error. If instanceHealth is unused, the instanceHealthReason value can be one of the following: Instance.NotRegistered - The target instance is not registered with the target group. Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer. Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer. Instance.InvalidState - The target is in the stopped or terminated state. If instanceHealth is draining, the instanceHealthReason value can be one of the following: Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired. + */ + instanceHealthReason?: InstanceHealthReason; + } + export type InstanceHealthSummaryList = InstanceHealthSummary[]; + export type InstanceList = Instance[]; + export type InstanceMetricName = "CPUUtilization"|"NetworkIn"|"NetworkOut"|"StatusCheckFailed"|"StatusCheckFailed_Instance"|"StatusCheckFailed_System"|string; + export interface InstanceNetworking { + /** + * The amount of data in GB allocated for monthly data transfers. + */ + monthlyTransfer?: MonthlyTransfer; + /** + * An array of key-value pairs containing information about the ports on the instance. + */ + ports?: InstancePortInfoList; + } + export type InstancePlatform = "LINUX_UNIX"|"WINDOWS"|string; + export type InstancePlatformList = InstancePlatform[]; + export interface InstancePortInfo { + /** + * The first port in the range. + */ + fromPort?: Port; + /** + * The last port in the range. + */ + toPort?: Port; + /** + * The protocol being used. Can be one of the following. tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. + */ + protocol?: NetworkProtocol; + /** + * The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)). + */ + accessFrom?: string; + /** + * The type of access (Public or Private). + */ + accessType?: PortAccessType; + /** + * The common name. + */ + commonName?: string; + /** + * The access direction (inbound or outbound). + */ + accessDirection?: AccessDirection; + } + export type InstancePortInfoList = InstancePortInfo[]; + export interface InstancePortState { + /** + * The first port in the range. + */ + fromPort?: Port; + /** + * The last port in the range. + */ + toPort?: Port; + /** + * The protocol being used. Can be one of the following. tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. + */ + protocol?: NetworkProtocol; + /** + * Specifies whether the instance port is open or closed. + */ + state?: PortState; + } + export type InstancePortStateList = InstancePortState[]; + export interface InstanceSnapshot { + /** + * The name of the snapshot. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE). + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The timestamp when the snapshot was created (e.g., 1479907467.024). + */ + createdAt?: IsoDate; + /** + * The region name and Availability Zone where you created the snapshot. + */ + location?: ResourceLocation; + /** + * The type of resource (usually InstanceSnapshot). + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The state the snapshot is in. + */ + state?: InstanceSnapshotState; + /** + * The progress of the snapshot. + */ + progress?: string; + /** + * An array of disk objects containing information about all block storage disks. + */ + fromAttachedDisks?: DiskList; + /** + * The instance from which the snapshot was created. + */ + fromInstanceName?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE). + */ + fromInstanceArn?: NonEmptyString; + /** + * The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly. + */ + fromBlueprintId?: string; + /** + * The bundle ID from which you created the snapshot (e.g., micro_1_0). + */ + fromBundleId?: string; + /** + * The size in GB of the SSD. + */ + sizeInGb?: integer; + } + export interface InstanceSnapshotInfo { + /** + * The bundle ID from which the source instance was created (e.g., micro_1_0). + */ + fromBundleId?: NonEmptyString; + /** + * The blueprint ID from which the source instance (e.g., os_debian_8_3). + */ + fromBlueprintId?: NonEmptyString; + /** + * A list of objects describing the disks that were attached to the source instance. + */ + fromDiskInfo?: DiskInfoList; + } + export type InstanceSnapshotList = InstanceSnapshot[]; + export type InstanceSnapshotState = "pending"|"error"|"available"|string; + export interface InstanceState { + /** + * The status code for the instance. + */ + code?: integer; + /** + * The state of the instance (e.g., running or pending). + */ + name?: string; + } + export type IpAddress = string; + export type IpV6Address = string; + export interface IsVpcPeeredRequest { + } + export interface IsVpcPeeredResult { + /** + * Returns true if the Lightsail VPC is peered; otherwise, false. + */ + isPeered?: boolean; + } + export type IsoDate = Date; + export interface KeyPair { + /** + * The friendly name of the SSH key pair. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE). + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The timestamp when the key pair was created (e.g., 1479816991.349). + */ + createdAt?: IsoDate; + /** + * The region name and Availability Zone where the key pair was created. + */ + location?: ResourceLocation; + /** + * The resource type (usually KeyPair). + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The RSA fingerprint of the key pair. + */ + fingerprint?: Base64; + } + export type KeyPairList = KeyPair[]; + export interface LoadBalancer { + /** + * The name of the load balancer (e.g., my-load-balancer). + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the load balancer. + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The date when your load balancer was created. + */ + createdAt?: IsoDate; + /** + * The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones. + */ + location?: ResourceLocation; + /** + * The resource type (e.g., LoadBalancer. + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The DNS name of your Lightsail load balancer. + */ + dnsName?: NonEmptyString; + /** + * The status of your load balancer. Valid values are below. + */ + state?: LoadBalancerState; + /** + * The protocol you have enabled for your load balancer. Valid values are below. You can't just have HTTP_HTTPS, but you can have just HTTP. + */ + protocol?: LoadBalancerProtocol; + /** + * An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443. + */ + publicPorts?: PortList; + /** + * The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page. + */ + healthCheckPath?: NonEmptyString; + /** + * The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443. + */ + instancePort?: integer; + /** + * An array of InstanceHealthSummary objects describing the health of the load balancer. + */ + instanceHealthSummary?: InstanceHealthSummaryList; + /** + * An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer. + */ + tlsCertificateSummaries?: LoadBalancerTlsCertificateSummaryList; + /** + * A string to string map of the configuration options for your load balancer. Valid values are listed below. + */ + configurationOptions?: LoadBalancerConfigurationOptions; + } + export type LoadBalancerAttributeName = "HealthCheckPath"|"SessionStickinessEnabled"|"SessionStickiness_LB_CookieDurationSeconds"|string; + export type LoadBalancerConfigurationOptions = {[key: string]: string}; + export type LoadBalancerList = LoadBalancer[]; + export type LoadBalancerMetricName = "ClientTLSNegotiationErrorCount"|"HealthyHostCount"|"UnhealthyHostCount"|"HTTPCode_LB_4XX_Count"|"HTTPCode_LB_5XX_Count"|"HTTPCode_Instance_2XX_Count"|"HTTPCode_Instance_3XX_Count"|"HTTPCode_Instance_4XX_Count"|"HTTPCode_Instance_5XX_Count"|"InstanceResponseTime"|"RejectedConnectionCount"|"RequestCount"|string; + export type LoadBalancerProtocol = "HTTP_HTTPS"|"HTTP"|string; + export type LoadBalancerState = "active"|"provisioning"|"active_impaired"|"failed"|"unknown"|string; + export interface LoadBalancerTlsCertificate { + /** + * The name of the SSL/TLS certificate (e.g., my-certificate). + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the SSL/TLS certificate. + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The time when you created your SSL/TLS certificate. + */ + createdAt?: IsoDate; + /** + * The AWS Region and Availability Zone where you created your certificate. + */ + location?: ResourceLocation; + /** + * The resource type (e.g., LoadBalancerTlsCertificate). Instance - A Lightsail instance (a virtual private server) StaticIp - A static IP address KeyPair - The key pair used to connect to a Lightsail instance InstanceSnapshot - A Lightsail instance snapshot Domain - A DNS zone PeeredVpc - A peered VPC LoadBalancer - A Lightsail load balancer LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer Disk - A Lightsail block storage disk DiskSnapshot - A block storage disk snapshot + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The load balancer name where your SSL/TLS certificate is attached. + */ + loadBalancerName?: ResourceName; + /** + * When true, the SSL/TLS certificate is attached to the Lightsail load balancer. + */ + isAttached?: boolean; + /** + * The status of the SSL/TLS certificate. Valid values are below. + */ + status?: LoadBalancerTlsCertificateStatus; + /** + * The domain name for your SSL/TLS certificate. + */ + domainName?: DomainName; + /** + * An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records. + */ + domainValidationRecords?: LoadBalancerTlsCertificateDomainValidationRecordList; + /** + * The reason for the SSL/TLS certificate validation failure. + */ + failureReason?: LoadBalancerTlsCertificateFailureReason; + /** + * The time when the SSL/TLS certificate was issued. + */ + issuedAt?: IsoDate; + /** + * The issuer of the certificate. + */ + issuer?: NonEmptyString; + /** + * The algorithm that was used to generate the key pair (the public and private key). + */ + keyAlgorithm?: NonEmptyString; + /** + * The timestamp when the SSL/TLS certificate expires. + */ + notAfter?: IsoDate; + /** + * The timestamp when the SSL/TLS certificate is first valid. + */ + notBefore?: IsoDate; + /** + * An object containing information about the status of Lightsail's managed renewal for the certificate. + */ + renewalSummary?: LoadBalancerTlsCertificateRenewalSummary; + /** + * The reason the certificate was revoked. Valid values are below. + */ + revocationReason?: LoadBalancerTlsCertificateRevocationReason; + /** + * The timestamp when the SSL/TLS certificate was revoked. + */ + revokedAt?: IsoDate; + /** + * The serial number of the certificate. + */ + serial?: NonEmptyString; + /** + * The algorithm that was used to sign the certificate. + */ + signatureAlgorithm?: NonEmptyString; + /** + * The name of the entity that is associated with the public key contained in the certificate. + */ + subject?: NonEmptyString; + /** + * One or more domains or subdomains 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 (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com, www.example.com, or m.example.com. + */ + subjectAlternativeNames?: StringList; + } + export type LoadBalancerTlsCertificateDomainStatus = "PENDING_VALIDATION"|"FAILED"|"SUCCESS"|string; + export interface LoadBalancerTlsCertificateDomainValidationOption { + /** + * The fully qualified domain name in the certificate request. + */ + domainName?: DomainName; + /** + * The status of the domain validation. Valid values are listed below. + */ + validationStatus?: LoadBalancerTlsCertificateDomainStatus; + } + export type LoadBalancerTlsCertificateDomainValidationOptionList = LoadBalancerTlsCertificateDomainValidationOption[]; + export interface LoadBalancerTlsCertificateDomainValidationRecord { + /** + * A fully qualified domain name in the certificate. For example, example.com. + */ + name?: NonEmptyString; + /** + * The type of validation record. For example, CNAME for domain validation. + */ + type?: NonEmptyString; + /** + * The value for that type. + */ + value?: NonEmptyString; + /** + * The validation status. Valid values are listed below. + */ + validationStatus?: LoadBalancerTlsCertificateDomainStatus; + /** + * The domain name against which your SSL/TLS certificate was validated. + */ + domainName?: DomainName; + } + export type LoadBalancerTlsCertificateDomainValidationRecordList = LoadBalancerTlsCertificateDomainValidationRecord[]; + export type LoadBalancerTlsCertificateFailureReason = "NO_AVAILABLE_CONTACTS"|"ADDITIONAL_VERIFICATION_REQUIRED"|"DOMAIN_NOT_ALLOWED"|"INVALID_PUBLIC_DOMAIN"|"OTHER"|string; + export type LoadBalancerTlsCertificateList = LoadBalancerTlsCertificate[]; + export type LoadBalancerTlsCertificateRenewalStatus = "PENDING_AUTO_RENEWAL"|"PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string; + export interface LoadBalancerTlsCertificateRenewalSummary { + /** + * The status of Lightsail's managed renewal of the certificate. Valid values are listed below. + */ + renewalStatus?: LoadBalancerTlsCertificateRenewalStatus; + /** + * Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. + */ + domainValidationOptions?: LoadBalancerTlsCertificateDomainValidationOptionList; + } + export type LoadBalancerTlsCertificateRevocationReason = "UNSPECIFIED"|"KEY_COMPROMISE"|"CA_COMPROMISE"|"AFFILIATION_CHANGED"|"SUPERCEDED"|"CESSATION_OF_OPERATION"|"CERTIFICATE_HOLD"|"REMOVE_FROM_CRL"|"PRIVILEGE_WITHDRAWN"|"A_A_COMPROMISE"|string; + export type LoadBalancerTlsCertificateStatus = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"|"UNKNOWN"|string; + export interface LoadBalancerTlsCertificateSummary { + /** + * The name of the SSL/TLS certificate. + */ + name?: ResourceName; + /** + * When true, the SSL/TLS certificate is attached to the Lightsail load balancer. + */ + isAttached?: boolean; + } + export type LoadBalancerTlsCertificateSummaryList = LoadBalancerTlsCertificateSummary[]; + export interface LogEvent { + /** + * The timestamp when the database log event was created. + */ + createdAt?: IsoDate; + /** + * The message of the database log event. + */ + message?: string; + } + export type LogEventList = LogEvent[]; + export interface MetricDatapoint { + /** + * The average. + */ + average?: double; + /** + * The maximum. + */ + maximum?: double; + /** + * The minimum. + */ + minimum?: double; + /** + * The sample count. + */ + sampleCount?: double; + /** + * The sum. + */ + sum?: double; + /** + * The timestamp (e.g., 1479816991.349). + */ + timestamp?: timestamp; + /** + * The unit. + */ + unit?: MetricUnit; + } + export type MetricDatapointList = MetricDatapoint[]; + export type MetricPeriod = number; + export type MetricStatistic = "Minimum"|"Maximum"|"Sum"|"Average"|"SampleCount"|string; + export type MetricStatisticList = MetricStatistic[]; + export type MetricUnit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"|string; + export interface MonthlyTransfer { + /** + * The amount allocated per month (in GB). + */ + gbPerMonthAllocated?: integer; + } + export type NetworkProtocol = "tcp"|"all"|"udp"|string; + export type NonEmptyString = string; + export interface OpenInstancePublicPortsRequest { + /** + * An array of key-value pairs containing information about the port mappings. + */ + portInfo: PortInfo; + /** + * The name of the instance for which you want to open the public ports. + */ + instanceName: ResourceName; + } + export interface OpenInstancePublicPortsResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operation?: Operation; + } + export interface Operation { + /** + * The ID of the operation. + */ + id?: NonEmptyString; + /** + * The resource name. + */ + resourceName?: ResourceName; + /** + * The resource type. + */ + resourceType?: ResourceType; + /** + * The timestamp when the operation was initialized (e.g., 1479816991.349). + */ + createdAt?: IsoDate; + /** + * The region and Availability Zone. + */ + location?: ResourceLocation; + /** + * A Boolean value indicating whether the operation is terminal. + */ + isTerminal?: boolean; + /** + * Details about the operation (e.g., Debian-1GB-Ohio-1). + */ + operationDetails?: string; + /** + * The type of operation. + */ + operationType?: OperationType; + /** + * The status of the operation. + */ + status?: OperationStatus; + /** + * The timestamp when the status was changed (e.g., 1479816991.349). + */ + statusChangedAt?: IsoDate; + /** + * The error code. + */ + errorCode?: string; + /** + * The error details. + */ + errorDetails?: string; + } + export type OperationList = Operation[]; + export type OperationStatus = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded"|string; + export type OperationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|string; + export interface PasswordData { + /** + * The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready. If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field. If you are using a custom key pair, you need to use your own means of decryption. If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default. + */ + ciphertext?: string; + /** + * The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair). If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair. + */ + keyPairName?: ResourceName; + } + export interface PeerVpcRequest { + } + export interface PeerVpcResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operation?: Operation; + } + export interface PendingMaintenanceAction { + /** + * The type of pending database maintenance action. + */ + action?: NonEmptyString; + /** + * Additional detail about the pending database maintenance action. + */ + description?: NonEmptyString; + /** + * The effective date of the pending database maintenance action. + */ + currentApplyDate?: IsoDate; + } + export type PendingMaintenanceActionList = PendingMaintenanceAction[]; + export interface PendingModifiedRelationalDatabaseValues { + /** + * The password for the master user of the database. + */ + masterUserPassword?: string; + /** + * The database engine version. + */ + engineVersion?: string; + /** + * A Boolean value indicating whether automated backup retention is enabled. + */ + backupRetentionEnabled?: boolean; + } + export type Port = number; + export type PortAccessType = "Public"|"Private"|string; + export interface PortInfo { + /** + * The first port in the range. + */ + fromPort?: Port; + /** + * The last port in the range. + */ + toPort?: Port; + /** + * The protocol. + */ + protocol?: NetworkProtocol; + } + export type PortInfoList = PortInfo[]; + export type PortInfoSourceType = "DEFAULT"|"INSTANCE"|"NONE"|"CLOSED"|string; + export type PortList = Port[]; + export type PortState = "open"|"closed"|string; + export interface PutInstancePublicPortsRequest { + /** + * Specifies information about the public port(s). + */ + portInfos: PortInfoList; + /** + * The Lightsail instance name of the public port(s) you are setting. + */ + instanceName: ResourceName; + } + export interface PutInstancePublicPortsResult { + /** + * Describes metadata about the operation you just executed. + */ + operation?: Operation; + } + export interface RebootInstanceRequest { + /** + * The name of the instance to reboot. + */ + instanceName: ResourceName; + } + export interface RebootInstanceResult { + /** + * An array of key-value pairs containing information about the request operations. + */ + operations?: OperationList; + } + export interface RebootRelationalDatabaseRequest { + /** + * The name of your database to reboot. + */ + relationalDatabaseName: ResourceName; + } + export interface RebootRelationalDatabaseResult { + /** + * An object describing the result of your reboot relational database request. + */ + operations?: OperationList; + } + export type RecordState = "Started"|"Succeeded"|"Failed"|string; + export interface Region { + /** + * The continent code (e.g., NA, meaning North America). + */ + continentCode?: string; + /** + * The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada). + */ + description?: string; + /** + * The display name (e.g., Ohio). + */ + displayName?: string; + /** + * The region name (e.g., us-east-2). + */ + name?: RegionName; + /** + * The Availability Zones. Follows the format us-east-2a (case-sensitive). + */ + availabilityZones?: AvailabilityZoneList; + /** + * The Availability Zones for databases. Follows the format us-east-2a (case-sensitive). + */ + relationalDatabaseAvailabilityZones?: AvailabilityZoneList; + } + export type RegionList = Region[]; + export type RegionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|string; + export interface RelationalDatabase { + /** + * The unique name of the database resource in Lightsail. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the database. + */ + arn?: NonEmptyString; + /** + * The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The timestamp when the database was created. Formatted in Unix time. + */ + createdAt?: IsoDate; + /** + * The Region name and Availability Zone where the database is located. + */ + location?: ResourceLocation; + /** + * The Lightsail resource type for the database (for example, RelationalDatabase). + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The blueprint ID for the database. A blueprint describes the major engine version of a database. + */ + relationalDatabaseBlueprintId?: NonEmptyString; + /** + * The bundle ID for the database. A bundle describes the performance specifications for your database. + */ + relationalDatabaseBundleId?: NonEmptyString; + /** + * The name of the master database created when the Lightsail database resource is created. + */ + masterDatabaseName?: string; + /** + * Describes the hardware of the database. + */ + hardware?: RelationalDatabaseHardware; + /** + * Describes the current state of the database. + */ + state?: NonEmptyString; + /** + * Describes the secondary Availability Zone of a high availability database. The secondary database is used for failover support of a high availability database. + */ + secondaryAvailabilityZone?: string; + /** + * A Boolean value indicating whether automated backup retention is enabled for the database. + */ + backupRetentionEnabled?: boolean; + /** + * Describes pending database value modifications. + */ + pendingModifiedValues?: PendingModifiedRelationalDatabaseValues; + /** + * The database software (for example, MySQL). + */ + engine?: NonEmptyString; + /** + * The database engine version (for example, 5.7.23). + */ + engineVersion?: NonEmptyString; + /** + * The latest point in time to which the database can be restored. Formatted in Unix time. + */ + latestRestorableTime?: IsoDate; + /** + * The master user name of the database. + */ + masterUsername?: NonEmptyString; + /** + * The status of parameter updates for the database. + */ + parameterApplyStatus?: NonEmptyString; + /** + * The daily time range during which automated backups are created for the database (for example, 16:00-16:30). + */ + preferredBackupWindow?: NonEmptyString; + /** + * The weekly time range during which system maintenance can occur on the database. In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30. + */ + preferredMaintenanceWindow?: NonEmptyString; + /** + * A Boolean value indicating whether the database is publicly accessible. + */ + publiclyAccessible?: boolean; + /** + * The master endpoint for the database. + */ + masterEndpoint?: RelationalDatabaseEndpoint; + /** + * Describes the pending maintenance actions for the database. + */ + pendingMaintenanceActions?: PendingMaintenanceActionList; + } + export interface RelationalDatabaseBlueprint { + /** + * The ID for the database blueprint. + */ + blueprintId?: string; + /** + * The database software of the database blueprint (for example, MySQL). + */ + engine?: RelationalDatabaseEngine; + /** + * The database engine version for the database blueprint (for example, 5.7.23). + */ + engineVersion?: string; + /** + * The description of the database engine for the database blueprint. + */ + engineDescription?: string; + /** + * The description of the database engine version for the database blueprint. + */ + engineVersionDescription?: string; + /** + * A Boolean value indicating whether the engine version is the default for the database blueprint. + */ + isEngineDefault?: boolean; + } + export type RelationalDatabaseBlueprintList = RelationalDatabaseBlueprint[]; + export interface RelationalDatabaseBundle { + /** + * The ID for the database bundle. + */ + bundleId?: string; + /** + * The name for the database bundle. + */ + name?: string; + /** + * The cost of the database bundle in US currency. + */ + price?: float; + /** + * The amount of RAM in GB (for example, 2.0) for the database bundle. + */ + ramSizeInGb?: float; + /** + * The size of the disk for the database bundle. + */ + diskSizeInGb?: integer; + /** + * The data transfer rate per month in GB for the database bundle. + */ + transferPerMonthInGb?: integer; + /** + * The number of virtual CPUs (vCPUs) for the database bundle. + */ + cpuCount?: integer; + /** + * A Boolean value indicating whether the database bundle is encrypted. + */ + isEncrypted?: boolean; + /** + * A Boolean value indicating whether the database bundle is active. + */ + isActive?: boolean; + } + export type RelationalDatabaseBundleList = RelationalDatabaseBundle[]; + export interface RelationalDatabaseEndpoint { + /** + * Specifies the port that the database is listening on. + */ + port?: integer; + /** + * Specifies the DNS address of the database. + */ + address?: NonEmptyString; + } + export type RelationalDatabaseEngine = "mysql"|string; + export interface RelationalDatabaseEvent { + /** + * The database that the database event relates to. + */ + resource?: ResourceName; + /** + * The timestamp when the database event was created. + */ + createdAt?: IsoDate; + /** + * The message of the database event. + */ + message?: string; + /** + * The category that the database event belongs to. + */ + eventCategories?: StringList; + } + export type RelationalDatabaseEventList = RelationalDatabaseEvent[]; + export interface RelationalDatabaseHardware { + /** + * The number of vCPUs for the database. + */ + cpuCount?: integer; + /** + * The size of the disk for the database. + */ + diskSizeInGb?: integer; + /** + * The amount of RAM in GB for the database. + */ + ramSizeInGb?: float; + } + export type RelationalDatabaseList = RelationalDatabase[]; + export type RelationalDatabaseMetricName = "CPUUtilization"|"DatabaseConnections"|"DiskQueueDepth"|"FreeStorageSpace"|"NetworkReceiveThroughput"|"NetworkTransmitThroughput"|string; + export interface RelationalDatabaseParameter { + /** + * Specifies the valid range of values for the parameter. + */ + allowedValues?: string; + /** + * Indicates when parameter updates are applied. Can be immediate or pending-reboot. + */ + applyMethod?: string; + /** + * Specifies the engine-specific parameter type. + */ + applyType?: string; + /** + * Specifies the valid data type for the parameter. + */ + dataType?: string; + /** + * Provides a description of the parameter. + */ + description?: string; + /** + * A Boolean value indicating whether the parameter can be modified. + */ + isModifiable?: boolean; + /** + * Specifies the name of the parameter. + */ + parameterName?: string; + /** + * Specifies the value of the parameter. + */ + parameterValue?: string; + } + export type RelationalDatabaseParameterList = RelationalDatabaseParameter[]; + export type RelationalDatabasePasswordVersion = "CURRENT"|"PREVIOUS"|"PENDING"|string; + export interface RelationalDatabaseSnapshot { + /** + * The name of the database snapshot. + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the database snapshot. + */ + arn?: NonEmptyString; + /** + * The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The timestamp when the database snapshot was created. + */ + createdAt?: IsoDate; + /** + * The Region name and Availability Zone where the database snapshot is located. + */ + location?: ResourceLocation; + /** + * The Lightsail resource type. + */ + resourceType?: ResourceType; + /** + * The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide. + */ + tags?: TagList; + /** + * The software of the database snapshot (for example, MySQL) + */ + engine?: NonEmptyString; + /** + * The database engine version for the database snapshot (for example, 5.7.23). + */ + engineVersion?: NonEmptyString; + /** + * The size of the disk in GB (for example, 32) for the database snapshot. + */ + sizeInGb?: integer; + /** + * The state of the database snapshot. + */ + state?: NonEmptyString; + /** + * The name of the source database from which the database snapshot was created. + */ + fromRelationalDatabaseName?: NonEmptyString; + /** + * The Amazon Resource Name (ARN) of the database from which the database snapshot was created. + */ + fromRelationalDatabaseArn?: NonEmptyString; + /** + * The bundle ID of the database from which the database snapshot was created. + */ + fromRelationalDatabaseBundleId?: string; + /** + * The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database. + */ + fromRelationalDatabaseBlueprintId?: string; + } + export type RelationalDatabaseSnapshotList = RelationalDatabaseSnapshot[]; + export interface ReleaseStaticIpRequest { + /** + * The name of the static IP to delete. + */ + staticIpName: ResourceName; + } + export interface ReleaseStaticIpResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operations?: OperationList; + } + export interface ResourceLocation { + /** + * The Availability Zone. Follows the format us-east-2a (case-sensitive). + */ + availabilityZone?: string; + /** + * The AWS Region name. + */ + regionName?: RegionName; + } + export type ResourceName = string; + export type ResourceNameList = ResourceName[]; + export type ResourceType = "Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|string; + export type SensitiveString = string; + export interface StartInstanceRequest { + /** + * The name of the instance (a virtual private server) to start. + */ + instanceName: ResourceName; + } + export interface StartInstanceResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operations?: OperationList; + } + export interface StartRelationalDatabaseRequest { + /** + * The name of your database to start. + */ + relationalDatabaseName: ResourceName; + } + export interface StartRelationalDatabaseResult { + /** + * An object describing the result of your start relational database request. + */ + operations?: OperationList; + } + export interface StaticIp { + /** + * The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE). + */ + name?: ResourceName; + /** + * The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE). + */ + arn?: NonEmptyString; + /** + * The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. + */ + supportCode?: string; + /** + * The timestamp when the static IP was created (e.g., 1479735304.222). + */ + createdAt?: IsoDate; + /** + * The region and Availability Zone where the static IP was created. + */ + location?: ResourceLocation; + /** + * The resource type (usually StaticIp). + */ + resourceType?: ResourceType; + /** + * The static IP address. + */ + ipAddress?: IpAddress; + /** + * The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1). + */ + attachedTo?: ResourceName; + /** + * A Boolean value indicating whether the static IP is attached. + */ + isAttached?: boolean; + } + export type StaticIpList = StaticIp[]; + export interface StopInstanceRequest { + /** + * The name of the instance (a virtual private server) to stop. + */ + instanceName: ResourceName; + /** + * When set to True, forces a Lightsail instance that is stuck in a stopping state to stop. Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request. + */ + force?: boolean; + } + export interface StopInstanceResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operations?: OperationList; + } + export interface StopRelationalDatabaseRequest { + /** + * The name of your database to stop. + */ + relationalDatabaseName: ResourceName; + /** + * The name of your new database snapshot to be created before stopping your database. + */ + relationalDatabaseSnapshotName?: ResourceName; + } + export interface StopRelationalDatabaseResult { + /** + * An object describing the result of your stop relational database request. + */ + operations?: OperationList; + } + export type StringList = string[]; + export type StringMax256 = string; + export interface Tag { + /** + * The key of the tag. Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ + */ + key?: TagKey; + /** + * The value of the tag. Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ + */ + value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The name of the resource to which you are adding tags. + */ + resourceName: ResourceName; + /** + * The tag key and optional value. + */ + tags: TagList; + } + export interface TagResourceResult { + /** + * A list of objects describing the API operation. + */ + operations?: OperationList; + } + export type TagValue = string; + export interface UnpeerVpcRequest { + } + export interface UnpeerVpcResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operation?: Operation; + } + export interface UntagResourceRequest { + /** + * The name of the resource from which you are removing a tag. + */ + resourceName: ResourceName; + /** + * The tag keys to delete from the specified resource. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResult { + /** + * A list of objects describing the API operation. + */ + operations?: OperationList; + } + export interface UpdateDomainEntryRequest { + /** + * The name of the domain recordset to update. + */ + domainName: DomainName; + /** + * An array of key-value pairs containing information about the domain entry. + */ + domainEntry: DomainEntry; + } + export interface UpdateDomainEntryResult { + /** + * An array of key-value pairs containing information about the request operation. + */ + operations?: OperationList; + } + export interface UpdateLoadBalancerAttributeRequest { + /** + * The name of the load balancer that you want to modify (e.g., my-load-balancer. + */ + loadBalancerName: ResourceName; + /** + * The name of the attribute you want to update. Valid values are below. + */ + attributeName: LoadBalancerAttributeName; + /** + * The value that you want to specify for the attribute name. + */ + attributeValue: StringMax256; + } + export interface UpdateLoadBalancerAttributeResult { + /** + * An object describing the API operations. + */ + operations?: OperationList; + } + export interface UpdateRelationalDatabaseParametersRequest { + /** + * The name of your database for which to update parameters. + */ + relationalDatabaseName: ResourceName; + /** + * The database parameters to update. + */ + parameters: RelationalDatabaseParameterList; + } + export interface UpdateRelationalDatabaseParametersResult { + /** + * An object describing the result of your update relational database parameters request. + */ + operations?: OperationList; + } + export interface UpdateRelationalDatabaseRequest { + /** + * The name of your database to update. + */ + relationalDatabaseName: ResourceName; + /** + * The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain 8 to 41 characters. + */ + masterUserPassword?: SensitiveString; + /** + * When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password. + */ + rotateMasterUserPassword?: boolean; + /** + * The daily time range during which automated backups are created for your database if automated backups are enabled. Constraints: Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 Specified in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + preferredBackupWindow?: string; + /** + * The weekly time range during which system maintenance can occur on your database. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: Must be in the ddd:hh24:mi-ddd:hh24:mi format. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be at least 30 minutes. Specified in Universal Coordinated Time (UTC). Example: Tue:17:00-Tue:17:30 + */ + preferredMaintenanceWindow?: string; + /** + * When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage. + */ + enableBackupRetention?: boolean; + /** + * When true, disables automated backup retention for your database. Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation. Updates are applied during the next maintenance window because this can result in an outage. + */ + disableBackupRetention?: boolean; + /** + * Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database. + */ + publiclyAccessible?: boolean; + /** + * When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage. Default: false + */ + applyImmediately?: boolean; + } + export interface UpdateRelationalDatabaseResult { + /** + * An object describing the result of your update relational database request. + */ + operations?: OperationList; + } + export type double = number; + export type float = number; + export type integer = number; + export type timestamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-11-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Lightsail client. + */ + export import Types = Lightsail; +} +export = Lightsail; diff --git a/node_modules/aws-sdk/clients/lightsail.js b/node_modules/aws-sdk/clients/lightsail.js new file mode 100644 index 0000000..4d62e57 --- /dev/null +++ b/node_modules/aws-sdk/clients/lightsail.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['lightsail'] = {}; +AWS.Lightsail = Service.defineService('lightsail', ['2016-11-28']); +Object.defineProperty(apiLoader.services['lightsail'], '2016-11-28', { + get: function get() { + var model = require('../apis/lightsail-2016-11-28.min.json'); + model.paginators = require('../apis/lightsail-2016-11-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Lightsail; diff --git a/node_modules/aws-sdk/clients/machinelearning.d.ts b/node_modules/aws-sdk/clients/machinelearning.d.ts new file mode 100644 index 0000000..83f91e0 --- /dev/null +++ b/node_modules/aws-sdk/clients/machinelearning.d.ts @@ -0,0 +1,1707 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MachineLearning extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MachineLearning.Types.ClientConfiguration) + config: Config & MachineLearning.Types.ClientConfiguration; + /** + * Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value. + */ + addTags(params: MachineLearning.Types.AddTagsInput, callback?: (err: AWSError, data: MachineLearning.Types.AddTagsOutput) => void): Request; + /** + * Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value. + */ + addTags(callback?: (err: AWSError, data: MachineLearning.Types.AddTagsOutput) => void): Request; + /** + * Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources. CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED. You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter. + */ + createBatchPrediction(params: MachineLearning.Types.CreateBatchPredictionInput, callback?: (err: AWSError, data: MachineLearning.Types.CreateBatchPredictionOutput) => void): Request; + /** + * Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources. CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED. You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter. + */ + createBatchPrediction(callback?: (err: AWSError, data: MachineLearning.Types.CreateBatchPredictionOutput) => void): Request; + /** + * Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. + */ + createDataSourceFromRDS(params: MachineLearning.Types.CreateDataSourceFromRDSInput, callback?: (err: AWSError, data: MachineLearning.Types.CreateDataSourceFromRDSOutput) => void): Request; + /** + * Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. + */ + createDataSourceFromRDS(callback?: (err: AWSError, data: MachineLearning.Types.CreateDataSourceFromRDSOutput) => void): Request; + /** + * Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation. After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions. You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values. + */ + createDataSourceFromRedshift(params: MachineLearning.Types.CreateDataSourceFromRedshiftInput, callback?: (err: AWSError, data: MachineLearning.Types.CreateDataSourceFromRedshiftOutput) => void): Request; + /** + * Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation. After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions. You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values. + */ + createDataSourceFromRedshift(callback?: (err: AWSError, data: MachineLearning.Types.CreateDataSourceFromRedshiftOutput) => void): Request; + /** + * Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations. If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource. After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions. + */ + createDataSourceFromS3(params: MachineLearning.Types.CreateDataSourceFromS3Input, callback?: (err: AWSError, data: MachineLearning.Types.CreateDataSourceFromS3Output) => void): Request; + /** + * Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations. If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource. After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions. + */ + createDataSourceFromS3(callback?: (err: AWSError, data: MachineLearning.Types.CreateDataSourceFromS3Output) => void): Request; + /** + * Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS. CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED. You can use the GetEvaluation operation to check progress of the evaluation during the creation operation. + */ + createEvaluation(params: MachineLearning.Types.CreateEvaluationInput, callback?: (err: AWSError, data: MachineLearning.Types.CreateEvaluationOutput) => void): Request; + /** + * Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS. CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED. You can use the GetEvaluation operation to check progress of the evaluation during the creation operation. + */ + createEvaluation(callback?: (err: AWSError, data: MachineLearning.Types.CreateEvaluationOutput) => void): Request; + /** + * Creates a new MLModel using the DataSource and the recipe as information sources. An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel. CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED. You can use the GetMLModel operation to check the progress of the MLModel during the creation operation. CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations. + */ + createMLModel(params: MachineLearning.Types.CreateMLModelInput, callback?: (err: AWSError, data: MachineLearning.Types.CreateMLModelOutput) => void): Request; + /** + * Creates a new MLModel using the DataSource and the recipe as information sources. An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel. CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED. You can use the GetMLModel operation to check the progress of the MLModel during the creation operation. CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations. + */ + createMLModel(callback?: (err: AWSError, data: MachineLearning.Types.CreateMLModelOutput) => void): Request; + /** + * Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel. + */ + createRealtimeEndpoint(params: MachineLearning.Types.CreateRealtimeEndpointInput, callback?: (err: AWSError, data: MachineLearning.Types.CreateRealtimeEndpointOutput) => void): Request; + /** + * Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel. + */ + createRealtimeEndpoint(callback?: (err: AWSError, data: MachineLearning.Types.CreateRealtimeEndpointOutput) => void): Request; + /** + * Assigns the DELETED status to a BatchPrediction, rendering it unusable. After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED. Caution: The result of the DeleteBatchPrediction operation is irreversible. + */ + deleteBatchPrediction(params: MachineLearning.Types.DeleteBatchPredictionInput, callback?: (err: AWSError, data: MachineLearning.Types.DeleteBatchPredictionOutput) => void): Request; + /** + * Assigns the DELETED status to a BatchPrediction, rendering it unusable. After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED. Caution: The result of the DeleteBatchPrediction operation is irreversible. + */ + deleteBatchPrediction(callback?: (err: AWSError, data: MachineLearning.Types.DeleteBatchPredictionOutput) => void): Request; + /** + * Assigns the DELETED status to a DataSource, rendering it unusable. After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED. Caution: The results of the DeleteDataSource operation are irreversible. + */ + deleteDataSource(params: MachineLearning.Types.DeleteDataSourceInput, callback?: (err: AWSError, data: MachineLearning.Types.DeleteDataSourceOutput) => void): Request; + /** + * Assigns the DELETED status to a DataSource, rendering it unusable. After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED. Caution: The results of the DeleteDataSource operation are irreversible. + */ + deleteDataSource(callback?: (err: AWSError, data: MachineLearning.Types.DeleteDataSourceOutput) => void): Request; + /** + * Assigns the DELETED status to an Evaluation, rendering it unusable. After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED. Caution The results of the DeleteEvaluation operation are irreversible. + */ + deleteEvaluation(params: MachineLearning.Types.DeleteEvaluationInput, callback?: (err: AWSError, data: MachineLearning.Types.DeleteEvaluationOutput) => void): Request; + /** + * Assigns the DELETED status to an Evaluation, rendering it unusable. After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED. Caution The results of the DeleteEvaluation operation are irreversible. + */ + deleteEvaluation(callback?: (err: AWSError, data: MachineLearning.Types.DeleteEvaluationOutput) => void): Request; + /** + * Assigns the DELETED status to an MLModel, rendering it unusable. After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED. Caution: The result of the DeleteMLModel operation is irreversible. + */ + deleteMLModel(params: MachineLearning.Types.DeleteMLModelInput, callback?: (err: AWSError, data: MachineLearning.Types.DeleteMLModelOutput) => void): Request; + /** + * Assigns the DELETED status to an MLModel, rendering it unusable. After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED. Caution: The result of the DeleteMLModel operation is irreversible. + */ + deleteMLModel(callback?: (err: AWSError, data: MachineLearning.Types.DeleteMLModelOutput) => void): Request; + /** + * Deletes a real time endpoint of an MLModel. + */ + deleteRealtimeEndpoint(params: MachineLearning.Types.DeleteRealtimeEndpointInput, callback?: (err: AWSError, data: MachineLearning.Types.DeleteRealtimeEndpointOutput) => void): Request; + /** + * Deletes a real time endpoint of an MLModel. + */ + deleteRealtimeEndpoint(callback?: (err: AWSError, data: MachineLearning.Types.DeleteRealtimeEndpointOutput) => void): Request; + /** + * Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags. If you specify a tag that doesn't exist, Amazon ML ignores it. + */ + deleteTags(params: MachineLearning.Types.DeleteTagsInput, callback?: (err: AWSError, data: MachineLearning.Types.DeleteTagsOutput) => void): Request; + /** + * Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags. If you specify a tag that doesn't exist, Amazon ML ignores it. + */ + deleteTags(callback?: (err: AWSError, data: MachineLearning.Types.DeleteTagsOutput) => void): Request; + /** + * Returns a list of BatchPrediction operations that match the search criteria in the request. + */ + describeBatchPredictions(params: MachineLearning.Types.DescribeBatchPredictionsInput, callback?: (err: AWSError, data: MachineLearning.Types.DescribeBatchPredictionsOutput) => void): Request; + /** + * Returns a list of BatchPrediction operations that match the search criteria in the request. + */ + describeBatchPredictions(callback?: (err: AWSError, data: MachineLearning.Types.DescribeBatchPredictionsOutput) => void): Request; + /** + * Returns a list of DataSource that match the search criteria in the request. + */ + describeDataSources(params: MachineLearning.Types.DescribeDataSourcesInput, callback?: (err: AWSError, data: MachineLearning.Types.DescribeDataSourcesOutput) => void): Request; + /** + * Returns a list of DataSource that match the search criteria in the request. + */ + describeDataSources(callback?: (err: AWSError, data: MachineLearning.Types.DescribeDataSourcesOutput) => void): Request; + /** + * Returns a list of DescribeEvaluations that match the search criteria in the request. + */ + describeEvaluations(params: MachineLearning.Types.DescribeEvaluationsInput, callback?: (err: AWSError, data: MachineLearning.Types.DescribeEvaluationsOutput) => void): Request; + /** + * Returns a list of DescribeEvaluations that match the search criteria in the request. + */ + describeEvaluations(callback?: (err: AWSError, data: MachineLearning.Types.DescribeEvaluationsOutput) => void): Request; + /** + * Returns a list of MLModel that match the search criteria in the request. + */ + describeMLModels(params: MachineLearning.Types.DescribeMLModelsInput, callback?: (err: AWSError, data: MachineLearning.Types.DescribeMLModelsOutput) => void): Request; + /** + * Returns a list of MLModel that match the search criteria in the request. + */ + describeMLModels(callback?: (err: AWSError, data: MachineLearning.Types.DescribeMLModelsOutput) => void): Request; + /** + * Describes one or more of the tags for your Amazon ML object. + */ + describeTags(params: MachineLearning.Types.DescribeTagsInput, callback?: (err: AWSError, data: MachineLearning.Types.DescribeTagsOutput) => void): Request; + /** + * Describes one or more of the tags for your Amazon ML object. + */ + describeTags(callback?: (err: AWSError, data: MachineLearning.Types.DescribeTagsOutput) => void): Request; + /** + * Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request. + */ + getBatchPrediction(params: MachineLearning.Types.GetBatchPredictionInput, callback?: (err: AWSError, data: MachineLearning.Types.GetBatchPredictionOutput) => void): Request; + /** + * Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request. + */ + getBatchPrediction(callback?: (err: AWSError, data: MachineLearning.Types.GetBatchPredictionOutput) => void): Request; + /** + * Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource. GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. + */ + getDataSource(params: MachineLearning.Types.GetDataSourceInput, callback?: (err: AWSError, data: MachineLearning.Types.GetDataSourceOutput) => void): Request; + /** + * Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource. GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. + */ + getDataSource(callback?: (err: AWSError, data: MachineLearning.Types.GetDataSourceOutput) => void): Request; + /** + * Returns an Evaluation that includes metadata as well as the current status of the Evaluation. + */ + getEvaluation(params: MachineLearning.Types.GetEvaluationInput, callback?: (err: AWSError, data: MachineLearning.Types.GetEvaluationOutput) => void): Request; + /** + * Returns an Evaluation that includes metadata as well as the current status of the Evaluation. + */ + getEvaluation(callback?: (err: AWSError, data: MachineLearning.Types.GetEvaluationOutput) => void): Request; + /** + * Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel. GetMLModel provides results in normal or verbose format. + */ + getMLModel(params: MachineLearning.Types.GetMLModelInput, callback?: (err: AWSError, data: MachineLearning.Types.GetMLModelOutput) => void): Request; + /** + * Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel. GetMLModel provides results in normal or verbose format. + */ + getMLModel(callback?: (err: AWSError, data: MachineLearning.Types.GetMLModelOutput) => void): Request; + /** + * Generates a prediction for the observation using the specified ML Model. Note Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. + */ + predict(params: MachineLearning.Types.PredictInput, callback?: (err: AWSError, data: MachineLearning.Types.PredictOutput) => void): Request; + /** + * Generates a prediction for the observation using the specified ML Model. Note Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. + */ + predict(callback?: (err: AWSError, data: MachineLearning.Types.PredictOutput) => void): Request; + /** + * Updates the BatchPredictionName of a BatchPrediction. You can use the GetBatchPrediction operation to view the contents of the updated data element. + */ + updateBatchPrediction(params: MachineLearning.Types.UpdateBatchPredictionInput, callback?: (err: AWSError, data: MachineLearning.Types.UpdateBatchPredictionOutput) => void): Request; + /** + * Updates the BatchPredictionName of a BatchPrediction. You can use the GetBatchPrediction operation to view the contents of the updated data element. + */ + updateBatchPrediction(callback?: (err: AWSError, data: MachineLearning.Types.UpdateBatchPredictionOutput) => void): Request; + /** + * Updates the DataSourceName of a DataSource. You can use the GetDataSource operation to view the contents of the updated data element. + */ + updateDataSource(params: MachineLearning.Types.UpdateDataSourceInput, callback?: (err: AWSError, data: MachineLearning.Types.UpdateDataSourceOutput) => void): Request; + /** + * Updates the DataSourceName of a DataSource. You can use the GetDataSource operation to view the contents of the updated data element. + */ + updateDataSource(callback?: (err: AWSError, data: MachineLearning.Types.UpdateDataSourceOutput) => void): Request; + /** + * Updates the EvaluationName of an Evaluation. You can use the GetEvaluation operation to view the contents of the updated data element. + */ + updateEvaluation(params: MachineLearning.Types.UpdateEvaluationInput, callback?: (err: AWSError, data: MachineLearning.Types.UpdateEvaluationOutput) => void): Request; + /** + * Updates the EvaluationName of an Evaluation. You can use the GetEvaluation operation to view the contents of the updated data element. + */ + updateEvaluation(callback?: (err: AWSError, data: MachineLearning.Types.UpdateEvaluationOutput) => void): Request; + /** + * Updates the MLModelName and the ScoreThreshold of an MLModel. You can use the GetMLModel operation to view the contents of the updated data element. + */ + updateMLModel(params: MachineLearning.Types.UpdateMLModelInput, callback?: (err: AWSError, data: MachineLearning.Types.UpdateMLModelOutput) => void): Request; + /** + * Updates the MLModelName and the ScoreThreshold of an MLModel. You can use the GetMLModel operation to view the contents of the updated data element. + */ + updateMLModel(callback?: (err: AWSError, data: MachineLearning.Types.UpdateMLModelOutput) => void): Request; + /** + * Waits for the dataSourceAvailable state by periodically calling the underlying MachineLearning.describeDataSourcesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dataSourceAvailable", params: MachineLearning.Types.DescribeDataSourcesInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: MachineLearning.Types.DescribeDataSourcesOutput) => void): Request; + /** + * Waits for the dataSourceAvailable state by periodically calling the underlying MachineLearning.describeDataSourcesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dataSourceAvailable", callback?: (err: AWSError, data: MachineLearning.Types.DescribeDataSourcesOutput) => void): Request; + /** + * Waits for the mLModelAvailable state by periodically calling the underlying MachineLearning.describeMLModelsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "mLModelAvailable", params: MachineLearning.Types.DescribeMLModelsInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: MachineLearning.Types.DescribeMLModelsOutput) => void): Request; + /** + * Waits for the mLModelAvailable state by periodically calling the underlying MachineLearning.describeMLModelsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "mLModelAvailable", callback?: (err: AWSError, data: MachineLearning.Types.DescribeMLModelsOutput) => void): Request; + /** + * Waits for the evaluationAvailable state by periodically calling the underlying MachineLearning.describeEvaluationsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "evaluationAvailable", params: MachineLearning.Types.DescribeEvaluationsInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: MachineLearning.Types.DescribeEvaluationsOutput) => void): Request; + /** + * Waits for the evaluationAvailable state by periodically calling the underlying MachineLearning.describeEvaluationsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "evaluationAvailable", callback?: (err: AWSError, data: MachineLearning.Types.DescribeEvaluationsOutput) => void): Request; + /** + * Waits for the batchPredictionAvailable state by periodically calling the underlying MachineLearning.describeBatchPredictionsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "batchPredictionAvailable", params: MachineLearning.Types.DescribeBatchPredictionsInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: MachineLearning.Types.DescribeBatchPredictionsOutput) => void): Request; + /** + * Waits for the batchPredictionAvailable state by periodically calling the underlying MachineLearning.describeBatchPredictionsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "batchPredictionAvailable", callback?: (err: AWSError, data: MachineLearning.Types.DescribeBatchPredictionsOutput) => void): Request; +} +declare namespace MachineLearning { + export interface AddTagsInput { + /** + * The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null. + */ + Tags: TagList; + /** + * The ID of the ML object to tag. For example, exampleModelId. + */ + ResourceId: EntityId; + /** + * The type of the ML object to tag. + */ + ResourceType: TaggableResourceType; + } + export interface AddTagsOutput { + /** + * The ID of the ML object that was tagged. + */ + ResourceId?: EntityId; + /** + * The type of the ML object that was tagged. + */ + ResourceType?: TaggableResourceType; + } + export type Algorithm = "sgd"|string; + export type AwsUserArn = string; + export interface BatchPrediction { + /** + * The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request. + */ + BatchPredictionId?: EntityId; + /** + * The ID of the MLModel that generated predictions for the BatchPrediction request. + */ + MLModelId?: EntityId; + /** + * The ID of the DataSource that points to the group of observations to predict. + */ + BatchPredictionDataSourceId?: EntityId; + /** + * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). + */ + InputDataLocationS3?: S3Url; + /** + * The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time that the BatchPrediction was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * A user-supplied name or description of the BatchPrediction. + */ + Name?: EntityName; + /** + * The status of the BatchPrediction. This element can have one of the following values: PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. INPROGRESS - The process is underway. FAILED - The request to perform a batch prediction did not run to completion. It is not usable. COMPLETED - The batch prediction process completed successfully. DELETED - The BatchPrediction is marked as deleted. It is not usable. + */ + Status?: EntityStatus; + /** + * The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'. + */ + OutputUri?: S3Url; + /** + * A description of the most recent details about processing the batch prediction request. + */ + Message?: Message; + ComputeTime?: LongType; + FinishedAt?: EpochTime; + StartedAt?: EpochTime; + TotalRecordCount?: LongType; + InvalidRecordCount?: LongType; + } + export type BatchPredictionFilterVariable = "CreatedAt"|"LastUpdatedAt"|"Status"|"Name"|"IAMUser"|"MLModelId"|"DataSourceId"|"DataURI"|string; + export type BatchPredictions = BatchPrediction[]; + export type ComparatorValue = string; + export type ComputeStatistics = boolean; + export interface CreateBatchPredictionInput { + /** + * A user-supplied ID that uniquely identifies the BatchPrediction. + */ + BatchPredictionId: EntityId; + /** + * A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set. + */ + BatchPredictionName?: EntityName; + /** + * The ID of the MLModel that will generate predictions for the group of observations. + */ + MLModelId: EntityId; + /** + * The ID of the DataSource that points to the group of observations to predict. + */ + BatchPredictionDataSourceId: EntityId; + /** + * The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'. Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide. + */ + OutputUri: S3Url; + } + export interface CreateBatchPredictionOutput { + /** + * A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request. + */ + BatchPredictionId?: EntityId; + } + export interface CreateDataSourceFromRDSInput { + /** + * A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource. + */ + DataSourceId: EntityId; + /** + * A user-supplied name or description of the DataSource. + */ + DataSourceName?: EntityName; + /** + * The data specification of an Amazon RDS DataSource: DatabaseInformation - DatabaseName - The name of the Amazon RDS database. InstanceIdentifier - A unique identifier for the Amazon RDS database instance. DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database. ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines. ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines. SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance. SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource. S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location. DataSchemaUri - The Amazon S3 location of the DataSchema. DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified. DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource. Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" + */ + RDSData: RDSDataSpec; + /** + * The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3. + */ + RoleARN: RoleARN; + /** + * The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training. + */ + ComputeStatistics?: ComputeStatistics; + } + export interface CreateDataSourceFromRDSOutput { + /** + * A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request. + */ + DataSourceId?: EntityId; + } + export interface CreateDataSourceFromRedshiftInput { + /** + * A user-supplied ID that uniquely identifies the DataSource. + */ + DataSourceId: EntityId; + /** + * A user-supplied name or description of the DataSource. + */ + DataSourceName?: EntityName; + /** + * The data specification of an Amazon Redshift DataSource: DatabaseInformation - DatabaseName - The name of the Amazon Redshift database. ClusterIdentifier - The unique ID for the Amazon Redshift cluster. DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database. SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource. S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location. DataSchemaUri - The Amazon S3 location of the DataSchema. DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified. DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the DataSource. Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" + */ + DataSpec: RedshiftDataSpec; + /** + * A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following: A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation + */ + RoleARN: RoleARN; + /** + * The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training. + */ + ComputeStatistics?: ComputeStatistics; + } + export interface CreateDataSourceFromRedshiftOutput { + /** + * A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request. + */ + DataSourceId?: EntityId; + } + export interface CreateDataSourceFromS3Input { + /** + * A user-supplied identifier that uniquely identifies the DataSource. + */ + DataSourceId: EntityId; + /** + * A user-supplied name or description of the DataSource. + */ + DataSourceName?: EntityName; + /** + * The data specification of a DataSource: DataLocationS3 - The Amazon S3 location of the observation data. DataSchemaLocationS3 - The Amazon S3 location of the DataSchema. DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified. DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource. Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" + */ + DataSpec: S3DataSpec; + /** + * The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training. + */ + ComputeStatistics?: ComputeStatistics; + } + export interface CreateDataSourceFromS3Output { + /** + * A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request. + */ + DataSourceId?: EntityId; + } + export interface CreateEvaluationInput { + /** + * A user-supplied ID that uniquely identifies the Evaluation. + */ + EvaluationId: EntityId; + /** + * A user-supplied name or description of the Evaluation. + */ + EvaluationName?: EntityName; + /** + * The ID of the MLModel to evaluate. The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation. + */ + MLModelId: EntityId; + /** + * The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel. + */ + EvaluationDataSourceId: EntityId; + } + export interface CreateEvaluationOutput { + /** + * The user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request. + */ + EvaluationId?: EntityId; + } + export interface CreateMLModelInput { + /** + * A user-supplied ID that uniquely identifies the MLModel. + */ + MLModelId: EntityId; + /** + * A user-supplied name or description of the MLModel. + */ + MLModelName?: EntityName; + /** + * The category of supervised learning that this MLModel will address. Choose from the following types: Choose REGRESSION if the MLModel will be used to predict a numeric value. Choose BINARY if the MLModel result has two possible values. Choose MULTICLASS if the MLModel result has a limited number of values. For more information, see the Amazon Machine Learning Developer Guide. + */ + MLModelType: MLModelType; + /** + * A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs. The following is the current set of training parameters: sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance. The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432. sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10. sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data. sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08. The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly. sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08. The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly. + */ + Parameters?: TrainingParameters; + /** + * The DataSource that points to the training data. + */ + TrainingDataSourceId: EntityId; + /** + * The data recipe for creating the MLModel. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default. + */ + Recipe?: Recipe; + /** + * The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default. + */ + RecipeUri?: S3Url; + } + export interface CreateMLModelOutput { + /** + * A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request. + */ + MLModelId?: EntityId; + } + export interface CreateRealtimeEndpointInput { + /** + * The ID assigned to the MLModel during creation. + */ + MLModelId: EntityId; + } + export interface CreateRealtimeEndpointOutput { + /** + * A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request. + */ + MLModelId?: EntityId; + /** + * The endpoint information of the MLModel + */ + RealtimeEndpointInfo?: RealtimeEndpointInfo; + } + export type DataRearrangement = string; + export type DataSchema = string; + export interface DataSource { + /** + * The ID that is assigned to the DataSource during creation. + */ + DataSourceId?: EntityId; + /** + * The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource. + */ + DataLocationS3?: S3Url; + /** + * A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created. + */ + DataRearrangement?: DataRearrangement; + /** + * The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time that the DataSource was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * The total number of observations contained in the data files that the DataSource references. + */ + DataSizeInBytes?: LongType; + /** + * The number of data files referenced by the DataSource. + */ + NumberOfFiles?: LongType; + /** + * A user-supplied name or description of the DataSource. + */ + Name?: EntityName; + /** + * The current status of the DataSource. This element can have one of the following values: PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource. INPROGRESS - The creation process is underway. FAILED - The request to create a DataSource did not run to completion. It is not usable. COMPLETED - The creation process completed successfully. DELETED - The DataSource is marked as deleted. It is not usable. + */ + Status?: EntityStatus; + /** + * A description of the most recent details about creating the DataSource. + */ + Message?: Message; + RedshiftMetadata?: RedshiftMetadata; + RDSMetadata?: RDSMetadata; + RoleARN?: RoleARN; + /** + * The parameter is true if statistics need to be generated from the observation data. + */ + ComputeStatistics?: ComputeStatistics; + ComputeTime?: LongType; + FinishedAt?: EpochTime; + StartedAt?: EpochTime; + } + export type DataSourceFilterVariable = "CreatedAt"|"LastUpdatedAt"|"Status"|"Name"|"DataLocationS3"|"IAMUser"|string; + export type DataSources = DataSource[]; + export interface DeleteBatchPredictionInput { + /** + * A user-supplied ID that uniquely identifies the BatchPrediction. + */ + BatchPredictionId: EntityId; + } + export interface DeleteBatchPredictionOutput { + /** + * A user-supplied ID that uniquely identifies the BatchPrediction. This value should be identical to the value of the BatchPredictionID in the request. + */ + BatchPredictionId?: EntityId; + } + export interface DeleteDataSourceInput { + /** + * A user-supplied ID that uniquely identifies the DataSource. + */ + DataSourceId: EntityId; + } + export interface DeleteDataSourceOutput { + /** + * A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request. + */ + DataSourceId?: EntityId; + } + export interface DeleteEvaluationInput { + /** + * A user-supplied ID that uniquely identifies the Evaluation to delete. + */ + EvaluationId: EntityId; + } + export interface DeleteEvaluationOutput { + /** + * A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request. + */ + EvaluationId?: EntityId; + } + export interface DeleteMLModelInput { + /** + * A user-supplied ID that uniquely identifies the MLModel. + */ + MLModelId: EntityId; + } + export interface DeleteMLModelOutput { + /** + * A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelID in the request. + */ + MLModelId?: EntityId; + } + export interface DeleteRealtimeEndpointInput { + /** + * The ID assigned to the MLModel during creation. + */ + MLModelId: EntityId; + } + export interface DeleteRealtimeEndpointOutput { + /** + * A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request. + */ + MLModelId?: EntityId; + /** + * The endpoint information of the MLModel + */ + RealtimeEndpointInfo?: RealtimeEndpointInfo; + } + export interface DeleteTagsInput { + /** + * One or more tags to delete. + */ + TagKeys: TagKeyList; + /** + * The ID of the tagged ML object. For example, exampleModelId. + */ + ResourceId: EntityId; + /** + * The type of the tagged ML object. + */ + ResourceType: TaggableResourceType; + } + export interface DeleteTagsOutput { + /** + * The ID of the ML object from which tags were deleted. + */ + ResourceId?: EntityId; + /** + * The type of the ML object from which tags were deleted. + */ + ResourceType?: TaggableResourceType; + } + export interface DescribeBatchPredictionsInput { + /** + * Use one of the following variables to filter a list of BatchPrediction: CreatedAt - Sets the search criteria to the BatchPrediction creation date. Status - Sets the search criteria to the BatchPrediction status. Name - Sets the search criteria to the contents of the BatchPrediction Name. IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation. MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction. DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction. DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory. + */ + FilterVariable?: BatchPredictionFilterVariable; + /** + * The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ. + */ + EQ?: ComparatorValue; + /** + * The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT. + */ + GT?: ComparatorValue; + /** + * The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT. + */ + LT?: ComparatorValue; + /** + * The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE. + */ + GE?: ComparatorValue; + /** + * The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE. + */ + LE?: ComparatorValue; + /** + * The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE. + */ + NE?: ComparatorValue; + /** + * A string that is found at the beginning of a variable, such as Name or Id. For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix: 2014-09 2014-09-09 2014-09-09-Holiday + */ + Prefix?: ComparatorValue; + /** + * A two-value parameter that determines the sequence of the resulting list of MLModels. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges the list in descending order (Z-A, 9-0). Results are sorted by FilterVariable. + */ + SortOrder?: SortOrder; + /** + * An ID of the page in the paginated results. + */ + NextToken?: StringType; + /** + * The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100. + */ + Limit?: PageLimit; + } + export interface DescribeBatchPredictionsOutput { + /** + * A list of BatchPrediction objects that meet the search criteria. + */ + Results?: BatchPredictions; + /** + * The ID of the next page in the paginated results that indicates at least one more page follows. + */ + NextToken?: StringType; + } + export interface DescribeDataSourcesInput { + /** + * Use one of the following variables to filter a list of DataSource: CreatedAt - Sets the search criteria to DataSource creation dates. Status - Sets the search criteria to DataSource statuses. Name - Sets the search criteria to the contents of DataSource Name. DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory. IAMUser - Sets the search criteria to the user account that invoked the DataSource creation. + */ + FilterVariable?: DataSourceFilterVariable; + /** + * The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ. + */ + EQ?: ComparatorValue; + /** + * The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT. + */ + GT?: ComparatorValue; + /** + * The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT. + */ + LT?: ComparatorValue; + /** + * The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE. + */ + GE?: ComparatorValue; + /** + * The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE. + */ + LE?: ComparatorValue; + /** + * The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE. + */ + NE?: ComparatorValue; + /** + * A string that is found at the beginning of a variable, such as Name or Id. For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix: 2014-09 2014-09-09 2014-09-09-Holiday + */ + Prefix?: ComparatorValue; + /** + * A two-value parameter that determines the sequence of the resulting list of DataSource. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges the list in descending order (Z-A, 9-0). Results are sorted by FilterVariable. + */ + SortOrder?: SortOrder; + /** + * The ID of the page in the paginated results. + */ + NextToken?: StringType; + /** + * The maximum number of DataSource to include in the result. + */ + Limit?: PageLimit; + } + export interface DescribeDataSourcesOutput { + /** + * A list of DataSource that meet the search criteria. + */ + Results?: DataSources; + /** + * An ID of the next page in the paginated results that indicates at least one more page follows. + */ + NextToken?: StringType; + } + export interface DescribeEvaluationsInput { + /** + * Use one of the following variable to filter a list of Evaluation objects: CreatedAt - Sets the search criteria to the Evaluation creation date. Status - Sets the search criteria to the Evaluation status. Name - Sets the search criteria to the contents of Evaluation Name. IAMUser - Sets the search criteria to the user account that invoked an Evaluation. MLModelId - Sets the search criteria to the MLModel that was evaluated. DataSourceId - Sets the search criteria to the DataSource used in Evaluation. DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory. + */ + FilterVariable?: EvaluationFilterVariable; + /** + * The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ. + */ + EQ?: ComparatorValue; + /** + * The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT. + */ + GT?: ComparatorValue; + /** + * The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT. + */ + LT?: ComparatorValue; + /** + * The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE. + */ + GE?: ComparatorValue; + /** + * The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE. + */ + LE?: ComparatorValue; + /** + * The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE. + */ + NE?: ComparatorValue; + /** + * A string that is found at the beginning of a variable, such as Name or Id. For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix: 2014-09 2014-09-09 2014-09-09-Holiday + */ + Prefix?: ComparatorValue; + /** + * A two-value parameter that determines the sequence of the resulting list of Evaluation. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges the list in descending order (Z-A, 9-0). Results are sorted by FilterVariable. + */ + SortOrder?: SortOrder; + /** + * The ID of the page in the paginated results. + */ + NextToken?: StringType; + /** + * The maximum number of Evaluation to include in the result. + */ + Limit?: PageLimit; + } + export interface DescribeEvaluationsOutput { + /** + * A list of Evaluation that meet the search criteria. + */ + Results?: Evaluations; + /** + * The ID of the next page in the paginated results that indicates at least one more page follows. + */ + NextToken?: StringType; + } + export interface DescribeMLModelsInput { + /** + * Use one of the following variables to filter a list of MLModel: CreatedAt - Sets the search criteria to MLModel creation date. Status - Sets the search criteria to MLModel status. Name - Sets the search criteria to the contents of MLModel Name. IAMUser - Sets the search criteria to the user account that invoked the MLModel creation. TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel. RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status. MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class. Algorithm - Sets the search criteria to the algorithm that the MLModel uses. TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory. + */ + FilterVariable?: MLModelFilterVariable; + /** + * The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ. + */ + EQ?: ComparatorValue; + /** + * The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT. + */ + GT?: ComparatorValue; + /** + * The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT. + */ + LT?: ComparatorValue; + /** + * The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE. + */ + GE?: ComparatorValue; + /** + * The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE. + */ + LE?: ComparatorValue; + /** + * The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE. + */ + NE?: ComparatorValue; + /** + * A string that is found at the beginning of a variable, such as Name or Id. For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix: 2014-09 2014-09-09 2014-09-09-Holiday + */ + Prefix?: ComparatorValue; + /** + * A two-value parameter that determines the sequence of the resulting list of MLModel. asc - Arranges the list in ascending order (A-Z, 0-9). dsc - Arranges the list in descending order (Z-A, 9-0). Results are sorted by FilterVariable. + */ + SortOrder?: SortOrder; + /** + * The ID of the page in the paginated results. + */ + NextToken?: StringType; + /** + * The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100. + */ + Limit?: PageLimit; + } + export interface DescribeMLModelsOutput { + /** + * A list of MLModel that meet the search criteria. + */ + Results?: MLModels; + /** + * The ID of the next page in the paginated results that indicates at least one more page follows. + */ + NextToken?: StringType; + } + export interface DescribeTagsInput { + /** + * The ID of the ML object. For example, exampleModelId. + */ + ResourceId: EntityId; + /** + * The type of the ML object. + */ + ResourceType: TaggableResourceType; + } + export interface DescribeTagsOutput { + /** + * The ID of the tagged ML object. + */ + ResourceId?: EntityId; + /** + * The type of the tagged ML object. + */ + ResourceType?: TaggableResourceType; + /** + * A list of tags associated with the ML object. + */ + Tags?: TagList; + } + export type DetailsAttributes = "PredictiveModelType"|"Algorithm"|string; + export type DetailsMap = {[key: string]: DetailsValue}; + export type DetailsValue = string; + export type EDPPipelineId = string; + export type EDPResourceRole = string; + export type EDPSecurityGroupId = string; + export type EDPSecurityGroupIds = EDPSecurityGroupId[]; + export type EDPServiceRole = string; + export type EDPSubnetId = string; + export type EntityId = string; + export type EntityName = string; + export type EntityStatus = "PENDING"|"INPROGRESS"|"FAILED"|"COMPLETED"|"DELETED"|string; + export type EpochTime = Date; + export interface Evaluation { + /** + * The ID that is assigned to the Evaluation at creation. + */ + EvaluationId?: EntityId; + /** + * The ID of the MLModel that is the focus of the evaluation. + */ + MLModelId?: EntityId; + /** + * The ID of the DataSource that is used to evaluate the MLModel. + */ + EvaluationDataSourceId?: EntityId; + /** + * The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation. + */ + InputDataLocationS3?: S3Url; + /** + * The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time that the Evaluation was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to the Evaluation. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * A user-supplied name or description of the Evaluation. + */ + Name?: EntityName; + /** + * The status of the evaluation. This element can have one of the following values: PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel. INPROGRESS - The evaluation is underway. FAILED - The request to evaluate an MLModel did not run to completion. It is not usable. COMPLETED - The evaluation process completed successfully. DELETED - The Evaluation is marked as deleted. It is not usable. + */ + Status?: EntityStatus; + /** + * Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel: BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance. RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable. MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance. For more information about performance metrics, please see the Amazon Machine Learning Developer Guide. + */ + PerformanceMetrics?: PerformanceMetrics; + /** + * A description of the most recent details about evaluating the MLModel. + */ + Message?: Message; + ComputeTime?: LongType; + FinishedAt?: EpochTime; + StartedAt?: EpochTime; + } + export type EvaluationFilterVariable = "CreatedAt"|"LastUpdatedAt"|"Status"|"Name"|"IAMUser"|"MLModelId"|"DataSourceId"|"DataURI"|string; + export type Evaluations = Evaluation[]; + export interface GetBatchPredictionInput { + /** + * An ID assigned to the BatchPrediction at creation. + */ + BatchPredictionId: EntityId; + } + export interface GetBatchPredictionOutput { + /** + * An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request. + */ + BatchPredictionId?: EntityId; + /** + * The ID of the MLModel that generated predictions for the BatchPrediction request. + */ + MLModelId?: EntityId; + /** + * The ID of the DataSource that was used to create the BatchPrediction. + */ + BatchPredictionDataSourceId?: EntityId; + /** + * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). + */ + InputDataLocationS3?: S3Url; + /** + * The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time when the BatchPrediction was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to BatchPrediction. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * A user-supplied name or description of the BatchPrediction. + */ + Name?: EntityName; + /** + * The status of the BatchPrediction, which can be one of the following values: PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions. INPROGRESS - The batch predictions are in progress. FAILED - The request to perform a batch prediction did not run to completion. It is not usable. COMPLETED - The batch prediction process completed successfully. DELETED - The BatchPrediction is marked as deleted. It is not usable. + */ + Status?: EntityStatus; + /** + * The location of an Amazon S3 bucket or directory to receive the operation results. + */ + OutputUri?: S3Url; + /** + * A link to the file that contains logs of the CreateBatchPrediction operation. + */ + LogUri?: PresignedS3Url; + /** + * A description of the most recent details about processing the batch prediction request. + */ + Message?: Message; + /** + * The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state. + */ + ComputeTime?: LongType; + /** + * The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state. + */ + FinishedAt?: EpochTime; + /** + * The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state. + */ + StartedAt?: EpochTime; + /** + * The number of total records that Amazon Machine Learning saw while processing the BatchPrediction. + */ + TotalRecordCount?: LongType; + /** + * The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction. + */ + InvalidRecordCount?: LongType; + } + export interface GetDataSourceInput { + /** + * The ID assigned to the DataSource at creation. + */ + DataSourceId: EntityId; + /** + * Specifies whether the GetDataSource operation should return DataSourceSchema. If true, DataSourceSchema is returned. If false, DataSourceSchema is not returned. + */ + Verbose?: Verbose; + } + export interface GetDataSourceOutput { + /** + * The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request. + */ + DataSourceId?: EntityId; + /** + * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). + */ + DataLocationS3?: S3Url; + /** + * A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created. + */ + DataRearrangement?: DataRearrangement; + /** + * The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time that the DataSource was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to the DataSource. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * The total size of observations in the data files. + */ + DataSizeInBytes?: LongType; + /** + * The number of data files referenced by the DataSource. + */ + NumberOfFiles?: LongType; + /** + * A user-supplied name or description of the DataSource. + */ + Name?: EntityName; + /** + * The current status of the DataSource. This element can have one of the following values: PENDING - Amazon ML submitted a request to create a DataSource. INPROGRESS - The creation process is underway. FAILED - The request to create a DataSource did not run to completion. It is not usable. COMPLETED - The creation process completed successfully. DELETED - The DataSource is marked as deleted. It is not usable. + */ + Status?: EntityStatus; + /** + * A link to the file containing logs of CreateDataSourceFrom* operations. + */ + LogUri?: PresignedS3Url; + /** + * The user-supplied description of the most recent details about creating the DataSource. + */ + Message?: Message; + RedshiftMetadata?: RedshiftMetadata; + RDSMetadata?: RDSMetadata; + RoleARN?: RoleARN; + /** + * The parameter is true if statistics need to be generated from the observation data. + */ + ComputeStatistics?: ComputeStatistics; + /** + * The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true. + */ + ComputeTime?: LongType; + /** + * The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state. + */ + FinishedAt?: EpochTime; + /** + * The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state. + */ + StartedAt?: EpochTime; + /** + * The schema used by all of the data files of this DataSource. Note This parameter is provided as part of the verbose format. + */ + DataSourceSchema?: DataSchema; + } + export interface GetEvaluationInput { + /** + * The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded and cataloged. The ID provides the means to access the information. + */ + EvaluationId: EntityId; + } + export interface GetEvaluationOutput { + /** + * The evaluation ID which is same as the EvaluationId in the request. + */ + EvaluationId?: EntityId; + /** + * The ID of the MLModel that was the focus of the evaluation. + */ + MLModelId?: EntityId; + /** + * The DataSource used for this evaluation. + */ + EvaluationDataSourceId?: EntityId; + /** + * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). + */ + InputDataLocationS3?: S3Url; + /** + * The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time that the Evaluation was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to the Evaluation. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * A user-supplied name or description of the Evaluation. + */ + Name?: EntityName; + /** + * The status of the evaluation. This element can have one of the following values: PENDING - Amazon Machine Language (Amazon ML) submitted a request to evaluate an MLModel. INPROGRESS - The evaluation is underway. FAILED - The request to evaluate an MLModel did not run to completion. It is not usable. COMPLETED - The evaluation process completed successfully. DELETED - The Evaluation is marked as deleted. It is not usable. + */ + Status?: EntityStatus; + /** + * Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel: BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance. RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable. MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance. For more information about performance metrics, please see the Amazon Machine Learning Developer Guide. + */ + PerformanceMetrics?: PerformanceMetrics; + /** + * A link to the file that contains logs of the CreateEvaluation operation. + */ + LogUri?: PresignedS3Url; + /** + * A description of the most recent details about evaluating the MLModel. + */ + Message?: Message; + /** + * The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the Evaluation, normalized and scaled on computation resources. ComputeTime is only available if the Evaluation is in the COMPLETED state. + */ + ComputeTime?: LongType; + /** + * The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED or FAILED. FinishedAt is only available when the Evaluation is in the COMPLETED or FAILED state. + */ + FinishedAt?: EpochTime; + /** + * The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. StartedAt isn't available if the Evaluation is in the PENDING state. + */ + StartedAt?: EpochTime; + } + export interface GetMLModelInput { + /** + * The ID assigned to the MLModel at creation. + */ + MLModelId: EntityId; + /** + * Specifies whether the GetMLModel operation should return Recipe. If true, Recipe is returned. If false, Recipe is not returned. + */ + Verbose?: Verbose; + } + export interface GetMLModelOutput { + /** + * The MLModel ID, which is same as the MLModelId in the request. + */ + MLModelId?: EntityId; + /** + * The ID of the training DataSource. + */ + TrainingDataSourceId?: EntityId; + /** + * The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time that the MLModel was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to the MLModel. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * A user-supplied name or description of the MLModel. + */ + Name?: MLModelName; + /** + * The current status of the MLModel. This element can have one of the following values: PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel. INPROGRESS - The request is processing. FAILED - The request did not run to completion. The ML model isn't usable. COMPLETED - The request completed successfully. DELETED - The MLModel is marked as deleted. It isn't usable. + */ + Status?: EntityStatus; + SizeInBytes?: LongType; + /** + * The current endpoint of the MLModel + */ + EndpointInfo?: RealtimeEndpointInfo; + /** + * A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs. The following is the current set of training parameters: sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance. The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432. sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10. sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data. sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08. The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly. sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08. The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly. + */ + TrainingParameters?: TrainingParameters; + /** + * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). + */ + InputDataLocationS3?: S3Url; + /** + * Identifies the MLModel category. The following are the available types: REGRESSION -- Produces a numeric result. For example, "What price should a house be listed at?" BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?" MULTICLASS -- Produces one of several possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?" + */ + MLModelType?: MLModelType; + /** + * The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction. Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false. + */ + ScoreThreshold?: ScoreThreshold; + /** + * The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time. + */ + ScoreThresholdLastUpdatedAt?: EpochTime; + /** + * A link to the file that contains logs of the CreateMLModel operation. + */ + LogUri?: PresignedS3Url; + /** + * A description of the most recent details about accessing the MLModel. + */ + Message?: Message; + /** + * The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state. + */ + ComputeTime?: LongType; + /** + * The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state. + */ + FinishedAt?: EpochTime; + /** + * The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state. + */ + StartedAt?: EpochTime; + /** + * The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training. Note This parameter is provided as part of the verbose format. + */ + Recipe?: Recipe; + /** + * The schema used by all of the data files referenced by the DataSource. Note This parameter is provided as part of the verbose format. + */ + Schema?: DataSchema; + } + export type IntegerType = number; + export type Label = string; + export type LongType = number; + export interface MLModel { + /** + * The ID assigned to the MLModel at creation. + */ + MLModelId?: EntityId; + /** + * The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId. + */ + TrainingDataSourceId?: EntityId; + /** + * The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account. + */ + CreatedByIamUser?: AwsUserArn; + /** + * The time that the MLModel was created. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The time of the most recent edit to the MLModel. The time is expressed in epoch time. + */ + LastUpdatedAt?: EpochTime; + /** + * A user-supplied name or description of the MLModel. + */ + Name?: MLModelName; + /** + * The current status of an MLModel. This element can have one of the following values: PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel. INPROGRESS - The creation process is underway. FAILED - The request to create an MLModel didn't run to completion. The model isn't usable. COMPLETED - The creation process completed successfully. DELETED - The MLModel is marked as deleted. It isn't usable. + */ + Status?: EntityStatus; + SizeInBytes?: LongType; + /** + * The current endpoint of the MLModel. + */ + EndpointInfo?: RealtimeEndpointInfo; + /** + * A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs. The following is the current set of training parameters: sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance. The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432. sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10. sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08. The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly. sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08. The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly. + */ + TrainingParameters?: TrainingParameters; + /** + * The location of the data file or directory in Amazon Simple Storage Service (Amazon S3). + */ + InputDataLocationS3?: S3Url; + /** + * The algorithm used to train the MLModel. The following algorithm is supported: SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function. + */ + Algorithm?: Algorithm; + /** + * Identifies the MLModel category. The following are the available types: REGRESSION - Produces a numeric result. For example, "What price should a house be listed at?" BINARY - Produces one of two possible results. For example, "Is this a child-friendly web site?". MULTICLASS - Produces one of several possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk trade?". + */ + MLModelType?: MLModelType; + ScoreThreshold?: ScoreThreshold; + /** + * The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time. + */ + ScoreThresholdLastUpdatedAt?: EpochTime; + /** + * A description of the most recent details about accessing the MLModel. + */ + Message?: Message; + ComputeTime?: LongType; + FinishedAt?: EpochTime; + StartedAt?: EpochTime; + } + export type MLModelFilterVariable = "CreatedAt"|"LastUpdatedAt"|"Status"|"Name"|"IAMUser"|"TrainingDataSourceId"|"RealtimeEndpointStatus"|"MLModelType"|"Algorithm"|"TrainingDataURI"|string; + export type MLModelName = string; + export type MLModelType = "REGRESSION"|"BINARY"|"MULTICLASS"|string; + export type MLModels = MLModel[]; + export type Message = string; + export type PageLimit = number; + export interface PerformanceMetrics { + Properties?: PerformanceMetricsProperties; + } + export type PerformanceMetricsProperties = {[key: string]: PerformanceMetricsPropertyValue}; + export type PerformanceMetricsPropertyKey = string; + export type PerformanceMetricsPropertyValue = string; + export interface PredictInput { + /** + * A unique identifier of the MLModel. + */ + MLModelId: EntityId; + Record: Record; + PredictEndpoint: VipURL; + } + export interface PredictOutput { + Prediction?: Prediction; + } + export interface Prediction { + /** + * The prediction label for either a BINARY or MULTICLASS MLModel. + */ + predictedLabel?: Label; + /** + * The prediction value for REGRESSION MLModel. + */ + predictedValue?: floatLabel; + predictedScores?: ScoreValuePerLabelMap; + details?: DetailsMap; + } + export type PresignedS3Url = string; + export interface RDSDataSpec { + /** + * Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database. + */ + DatabaseInformation: RDSDatabase; + /** + * The query that is used to retrieve the observation data for the DataSource. + */ + SelectSqlQuery: RDSSelectSqlQuery; + /** + * The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database. + */ + DatabaseCredentials: RDSDatabaseCredentials; + /** + * The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location. + */ + S3StagingLocation: S3Url; + /** + * A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource. There are multiple parameters that control what data is used to create a datasource: percentBegin Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource. percentEnd Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource. complement The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter. For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data. Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}} Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}} strategy To change how Amazon ML splits the data for a datasource, use the strategy parameter. The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data. The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources: Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}} Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}} To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records. The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources: Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}} + */ + DataRearrangement?: DataRearrangement; + /** + * A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. A DataSchema is not required if you specify a DataSchemaUri Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema. { "version": "1.0", "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } + */ + DataSchema?: DataSchema; + /** + * The Amazon S3 location of the DataSchema. + */ + DataSchemaUri?: S3Url; + /** + * The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines. + */ + ResourceRole: EDPResourceRole; + /** + * The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines. + */ + ServiceRole: EDPServiceRole; + /** + * The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3. + */ + SubnetId: EDPSubnetId; + /** + * The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task. + */ + SecurityGroupIds: EDPSecurityGroupIds; + } + export interface RDSDatabase { + /** + * The ID of an RDS DB instance. + */ + InstanceIdentifier: RDSInstanceIdentifier; + DatabaseName: RDSDatabaseName; + } + export interface RDSDatabaseCredentials { + Username: RDSDatabaseUsername; + Password: RDSDatabasePassword; + } + export type RDSDatabaseName = string; + export type RDSDatabasePassword = string; + export type RDSDatabaseUsername = string; + export type RDSInstanceIdentifier = string; + export interface RDSMetadata { + /** + * The database details required to connect to an Amazon RDS. + */ + Database?: RDSDatabase; + DatabaseUserName?: RDSDatabaseUsername; + /** + * The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput. + */ + SelectSqlQuery?: RDSSelectSqlQuery; + /** + * The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines. + */ + ResourceRole?: EDPResourceRole; + /** + * The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines. + */ + ServiceRole?: EDPServiceRole; + /** + * The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console. + */ + DataPipelineId?: EDPPipelineId; + } + export type RDSSelectSqlQuery = string; + export interface RealtimeEndpointInfo { + /** + * The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second. + */ + PeakRequestsPerSecond?: IntegerType; + /** + * The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time. + */ + CreatedAt?: EpochTime; + /** + * The URI that specifies where to send real-time prediction requests for the MLModel. Note The application must wait until the real-time endpoint is ready before using this URI. + */ + EndpointUrl?: VipURL; + /** + * The current status of the real-time endpoint for the MLModel. This element can have one of the following values: NONE - Endpoint does not exist or was previously deleted. READY - Endpoint is ready to be used for real-time predictions. UPDATING - Updating/creating the endpoint. + */ + EndpointStatus?: RealtimeEndpointStatus; + } + export type RealtimeEndpointStatus = "NONE"|"READY"|"UPDATING"|"FAILED"|string; + export type Recipe = string; + export type Record = {[key: string]: VariableValue}; + export type RedshiftClusterIdentifier = string; + export interface RedshiftDataSpec { + /** + * Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource. + */ + DatabaseInformation: RedshiftDatabase; + /** + * Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource. + */ + SelectSqlQuery: RedshiftSelectSqlQuery; + /** + * Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database. + */ + DatabaseCredentials: RedshiftDatabaseCredentials; + /** + * Describes an Amazon S3 location to store the result set of the SelectSqlQuery query. + */ + S3StagingLocation: S3Url; + /** + * A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource. There are multiple parameters that control what data is used to create a datasource: percentBegin Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource. percentEnd Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource. complement The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter. For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data. Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}} Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}} strategy To change how Amazon ML splits the data for a datasource, use the strategy parameter. The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data. The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources: Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}} Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}} To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records. The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources: Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}} + */ + DataRearrangement?: DataRearrangement; + /** + * A JSON string that represents the schema for an Amazon Redshift DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. A DataSchema is not required if you specify a DataSchemaUri. Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema. { "version": "1.0", "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } + */ + DataSchema?: DataSchema; + /** + * Describes the schema location for an Amazon Redshift DataSource. + */ + DataSchemaUri?: S3Url; + } + export interface RedshiftDatabase { + DatabaseName: RedshiftDatabaseName; + ClusterIdentifier: RedshiftClusterIdentifier; + } + export interface RedshiftDatabaseCredentials { + Username: RedshiftDatabaseUsername; + Password: RedshiftDatabasePassword; + } + export type RedshiftDatabaseName = string; + export type RedshiftDatabasePassword = string; + export type RedshiftDatabaseUsername = string; + export interface RedshiftMetadata { + RedshiftDatabase?: RedshiftDatabase; + DatabaseUserName?: RedshiftDatabaseUsername; + /** + * The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput. + */ + SelectSqlQuery?: RedshiftSelectSqlQuery; + } + export type RedshiftSelectSqlQuery = string; + export type RoleARN = string; + export interface S3DataSpec { + /** + * The location of the data file(s) used by a DataSource. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files. + */ + DataLocationS3: S3Url; + /** + * A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource. There are multiple parameters that control what data is used to create a datasource: percentBegin Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource. percentEnd Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource. complement The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter. For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data. Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}} Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}} strategy To change how Amazon ML splits the data for a datasource, use the strategy parameter. The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data. The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources: Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}} Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}} To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records. The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources: Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}} + */ + DataRearrangement?: DataRearrangement; + /** + * A JSON string that represents the schema for an Amazon S3 DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. You must provide either the DataSchema or the DataSchemaLocationS3. Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema. { "version": "1.0", "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } + */ + DataSchema?: DataSchema; + /** + * Describes the schema location in Amazon S3. You must provide either the DataSchema or the DataSchemaLocationS3. + */ + DataSchemaLocationS3?: S3Url; + } + export type S3Url = string; + export type ScoreThreshold = number; + export type ScoreValue = number; + export type ScoreValuePerLabelMap = {[key: string]: ScoreValue}; + export type SortOrder = "asc"|"dsc"|string; + export type StringType = string; + export interface Tag { + /** + * A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @. + */ + Key?: TagKey; + /** + * An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export type TagValue = string; + export type TaggableResourceType = "BatchPrediction"|"DataSource"|"Evaluation"|"MLModel"|string; + export type TrainingParameters = {[key: string]: StringType}; + export interface UpdateBatchPredictionInput { + /** + * The ID assigned to the BatchPrediction during creation. + */ + BatchPredictionId: EntityId; + /** + * A new user-supplied name or description of the BatchPrediction. + */ + BatchPredictionName: EntityName; + } + export interface UpdateBatchPredictionOutput { + /** + * The ID assigned to the BatchPrediction during creation. This value should be identical to the value of the BatchPredictionId in the request. + */ + BatchPredictionId?: EntityId; + } + export interface UpdateDataSourceInput { + /** + * The ID assigned to the DataSource during creation. + */ + DataSourceId: EntityId; + /** + * A new user-supplied name or description of the DataSource that will replace the current description. + */ + DataSourceName: EntityName; + } + export interface UpdateDataSourceOutput { + /** + * The ID assigned to the DataSource during creation. This value should be identical to the value of the DataSourceID in the request. + */ + DataSourceId?: EntityId; + } + export interface UpdateEvaluationInput { + /** + * The ID assigned to the Evaluation during creation. + */ + EvaluationId: EntityId; + /** + * A new user-supplied name or description of the Evaluation that will replace the current content. + */ + EvaluationName: EntityName; + } + export interface UpdateEvaluationOutput { + /** + * The ID assigned to the Evaluation during creation. This value should be identical to the value of the Evaluation in the request. + */ + EvaluationId?: EntityId; + } + export interface UpdateMLModelInput { + /** + * The ID assigned to the MLModel during creation. + */ + MLModelId: EntityId; + /** + * A user-supplied name or description of the MLModel. + */ + MLModelName?: EntityName; + /** + * The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction. Output values greater than or equal to the ScoreThreshold receive a positive result from the MLModel, such as true. Output values less than the ScoreThreshold receive a negative response from the MLModel, such as false. + */ + ScoreThreshold?: ScoreThreshold; + } + export interface UpdateMLModelOutput { + /** + * The ID assigned to the MLModel during creation. This value should be identical to the value of the MLModelID in the request. + */ + MLModelId?: EntityId; + } + export type VariableName = string; + export type VariableValue = string; + export type Verbose = boolean; + export type VipURL = string; + export type floatLabel = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-12-12"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MachineLearning client. + */ + export import Types = MachineLearning; +} +export = MachineLearning; diff --git a/node_modules/aws-sdk/clients/machinelearning.js b/node_modules/aws-sdk/clients/machinelearning.js new file mode 100644 index 0000000..68011b6 --- /dev/null +++ b/node_modules/aws-sdk/clients/machinelearning.js @@ -0,0 +1,20 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['machinelearning'] = {}; +AWS.MachineLearning = Service.defineService('machinelearning', ['2014-12-12']); +require('../lib/services/machinelearning'); +Object.defineProperty(apiLoader.services['machinelearning'], '2014-12-12', { + get: function get() { + var model = require('../apis/machinelearning-2014-12-12.min.json'); + model.paginators = require('../apis/machinelearning-2014-12-12.paginators.json').pagination; + model.waiters = require('../apis/machinelearning-2014-12-12.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MachineLearning; diff --git a/node_modules/aws-sdk/clients/macie.d.ts b/node_modules/aws-sdk/clients/macie.d.ts new file mode 100644 index 0000000..9e8a1a1 --- /dev/null +++ b/node_modules/aws-sdk/clients/macie.d.ts @@ -0,0 +1,284 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Macie extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Macie.Types.ClientConfiguration) + config: Config & Macie.Types.ClientConfiguration; + /** + * Associates a specified AWS account with Amazon Macie as a member account. + */ + associateMemberAccount(params: Macie.Types.AssociateMemberAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates a specified AWS account with Amazon Macie as a member account. + */ + associateMemberAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account. + */ + associateS3Resources(params: Macie.Types.AssociateS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.AssociateS3ResourcesResult) => void): Request; + /** + * Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account. + */ + associateS3Resources(callback?: (err: AWSError, data: Macie.Types.AssociateS3ResourcesResult) => void): Request; + /** + * Removes the specified member account from Amazon Macie. + */ + disassociateMemberAccount(params: Macie.Types.DisassociateMemberAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified member account from Amazon Macie. + */ + disassociateMemberAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account. + */ + disassociateS3Resources(params: Macie.Types.DisassociateS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.DisassociateS3ResourcesResult) => void): Request; + /** + * Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account. + */ + disassociateS3Resources(callback?: (err: AWSError, data: Macie.Types.DisassociateS3ResourcesResult) => void): Request; + /** + * Lists all Amazon Macie member accounts for the current Amazon Macie master account. + */ + listMemberAccounts(params: Macie.Types.ListMemberAccountsRequest, callback?: (err: AWSError, data: Macie.Types.ListMemberAccountsResult) => void): Request; + /** + * Lists all Amazon Macie member accounts for the current Amazon Macie master account. + */ + listMemberAccounts(callback?: (err: AWSError, data: Macie.Types.ListMemberAccountsResult) => void): Request; + /** + * Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account. + */ + listS3Resources(params: Macie.Types.ListS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.ListS3ResourcesResult) => void): Request; + /** + * Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account. + */ + listS3Resources(callback?: (err: AWSError, data: Macie.Types.ListS3ResourcesResult) => void): Request; + /** + * Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account. + */ + updateS3Resources(params: Macie.Types.UpdateS3ResourcesRequest, callback?: (err: AWSError, data: Macie.Types.UpdateS3ResourcesResult) => void): Request; + /** + * Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account. + */ + updateS3Resources(callback?: (err: AWSError, data: Macie.Types.UpdateS3ResourcesResult) => void): Request; +} +declare namespace Macie { + export type AWSAccountId = string; + export interface AssociateMemberAccountRequest { + /** + * The ID of the AWS account that you want to associate with Amazon Macie as a member account. + */ + memberAccountId: AWSAccountId; + } + export interface AssociateS3ResourcesRequest { + /** + * The ID of the Amazon Macie member account whose resources you want to associate with Macie. + */ + memberAccountId?: AWSAccountId; + /** + * The S3 resources that you want to associate with Amazon Macie for monitoring and data classification. + */ + s3Resources: S3ResourcesClassification; + } + export interface AssociateS3ResourcesResult { + /** + * S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for each failed item. + */ + failedS3Resources?: FailedS3Resources; + } + export type BucketName = string; + export interface ClassificationType { + /** + * A one-time classification of all of the existing objects in a specified S3 bucket. + */ + oneTime: S3OneTimeClassificationType; + /** + * A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie. + */ + continuous: S3ContinuousClassificationType; + } + export interface ClassificationTypeUpdate { + /** + * A one-time classification of all of the existing objects in a specified S3 bucket. + */ + oneTime?: S3OneTimeClassificationType; + /** + * A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie. + */ + continuous?: S3ContinuousClassificationType; + } + export interface DisassociateMemberAccountRequest { + /** + * The ID of the member account that you want to remove from Amazon Macie. + */ + memberAccountId: AWSAccountId; + } + export interface DisassociateS3ResourcesRequest { + /** + * The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon Macie. + */ + memberAccountId?: AWSAccountId; + /** + * The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie. + */ + associatedS3Resources: S3Resources; + } + export interface DisassociateS3ResourcesResult { + /** + * S3 resources that couldn't be removed from being monitored and classified by Amazon Macie. An error code and an error message are provided for each failed item. + */ + failedS3Resources?: FailedS3Resources; + } + export type ErrorCode = string; + export type ExceptionMessage = string; + export interface FailedS3Resource { + /** + * The failed S3 resources. + */ + failedItem?: S3Resource; + /** + * The status code of a failed item. + */ + errorCode?: ErrorCode; + /** + * The error message of a failed item. + */ + errorMessage?: ExceptionMessage; + } + export type FailedS3Resources = FailedS3Resource[]; + export interface ListMemberAccountsRequest { + /** + * Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + nextToken?: NextToken; + /** + * Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250. + */ + maxResults?: MaxResults; + } + export interface ListMemberAccountsResult { + /** + * A list of the Amazon Macie member accounts returned by the action. The current master account is also included in this list. + */ + memberAccounts?: MemberAccounts; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: NextToken; + } + export interface ListS3ResourcesRequest { + /** + * The Amazon Macie member account ID whose associated S3 resources you want to list. + */ + memberAccountId?: AWSAccountId; + /** + * Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + nextToken?: NextToken; + /** + * Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250. + */ + maxResults?: MaxResults; + } + export interface ListS3ResourcesResult { + /** + * A list of the associated S3 resources returned by the action. + */ + s3Resources?: S3ResourcesClassification; + /** + * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. + */ + nextToken?: NextToken; + } + export type MaxResults = number; + export interface MemberAccount { + /** + * The AWS account ID of the Amazon Macie member account. + */ + accountId?: AWSAccountId; + } + export type MemberAccounts = MemberAccount[]; + export type NextToken = string; + export type Prefix = string; + export type S3ContinuousClassificationType = "FULL"|string; + export type S3OneTimeClassificationType = "FULL"|"NONE"|string; + export interface S3Resource { + /** + * The name of the S3 bucket. + */ + bucketName: BucketName; + /** + * The prefix of the S3 bucket. + */ + prefix?: Prefix; + } + export interface S3ResourceClassification { + /** + * The name of the S3 bucket that you want to associate with Amazon Macie. + */ + bucketName: BucketName; + /** + * The prefix of the S3 bucket that you want to associate with Amazon Macie. + */ + prefix?: Prefix; + /** + * The classification type that you want to specify for the resource associated with Amazon Macie. + */ + classificationType: ClassificationType; + } + export interface S3ResourceClassificationUpdate { + /** + * The name of the S3 bucket whose classification types you want to update. + */ + bucketName: BucketName; + /** + * The prefix of the S3 bucket whose classification types you want to update. + */ + prefix?: Prefix; + /** + * The classification type that you want to update for the resource associated with Amazon Macie. + */ + classificationTypeUpdate: ClassificationTypeUpdate; + } + export type S3Resources = S3Resource[]; + export type S3ResourcesClassification = S3ResourceClassification[]; + export type S3ResourcesClassificationUpdate = S3ResourceClassificationUpdate[]; + export interface UpdateS3ResourcesRequest { + /** + * The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update. + */ + memberAccountId?: AWSAccountId; + /** + * The S3 resources whose classification types you want to update. + */ + s3ResourcesUpdate: S3ResourcesClassificationUpdate; + } + export interface UpdateS3ResourcesResult { + /** + * The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item. + */ + failedS3Resources?: FailedS3Resources; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-12-19"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Macie client. + */ + export import Types = Macie; +} +export = Macie; diff --git a/node_modules/aws-sdk/clients/macie.js b/node_modules/aws-sdk/clients/macie.js new file mode 100644 index 0000000..9517974 --- /dev/null +++ b/node_modules/aws-sdk/clients/macie.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['macie'] = {}; +AWS.Macie = Service.defineService('macie', ['2017-12-19']); +Object.defineProperty(apiLoader.services['macie'], '2017-12-19', { + get: function get() { + var model = require('../apis/macie-2017-12-19.min.json'); + model.paginators = require('../apis/macie-2017-12-19.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Macie; diff --git a/node_modules/aws-sdk/clients/managedblockchain.d.ts b/node_modules/aws-sdk/clients/managedblockchain.d.ts new file mode 100644 index 0000000..46152c0 --- /dev/null +++ b/node_modules/aws-sdk/clients/managedblockchain.d.ts @@ -0,0 +1,1066 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ManagedBlockchain extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ManagedBlockchain.Types.ClientConfiguration) + config: Config & ManagedBlockchain.Types.ClientConfiguration; + /** + * Creates a member within a Managed Blockchain network. + */ + createMember(params: ManagedBlockchain.Types.CreateMemberInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateMemberOutput) => void): Request; + /** + * Creates a member within a Managed Blockchain network. + */ + createMember(callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateMemberOutput) => void): Request; + /** + * Creates a new blockchain network using Amazon Managed Blockchain. + */ + createNetwork(params: ManagedBlockchain.Types.CreateNetworkInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateNetworkOutput) => void): Request; + /** + * Creates a new blockchain network using Amazon Managed Blockchain. + */ + createNetwork(callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateNetworkOutput) => void): Request; + /** + * Creates a peer node in a member. + */ + createNode(params: ManagedBlockchain.Types.CreateNodeInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateNodeOutput) => void): Request; + /** + * Creates a peer node in a member. + */ + createNode(callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateNodeOutput) => void): Request; + /** + * Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal. + */ + createProposal(params: ManagedBlockchain.Types.CreateProposalInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateProposalOutput) => void): Request; + /** + * Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal. + */ + createProposal(callback?: (err: AWSError, data: ManagedBlockchain.Types.CreateProposalOutput) => void): Request; + /** + * Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also. + */ + deleteMember(params: ManagedBlockchain.Types.DeleteMemberInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.DeleteMemberOutput) => void): Request; + /** + * Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also. + */ + deleteMember(callback?: (err: AWSError, data: ManagedBlockchain.Types.DeleteMemberOutput) => void): Request; + /** + * Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered. + */ + deleteNode(params: ManagedBlockchain.Types.DeleteNodeInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.DeleteNodeOutput) => void): Request; + /** + * Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered. + */ + deleteNode(callback?: (err: AWSError, data: ManagedBlockchain.Types.DeleteNodeOutput) => void): Request; + /** + * Returns detailed information about a member. + */ + getMember(params: ManagedBlockchain.Types.GetMemberInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.GetMemberOutput) => void): Request; + /** + * Returns detailed information about a member. + */ + getMember(callback?: (err: AWSError, data: ManagedBlockchain.Types.GetMemberOutput) => void): Request; + /** + * Returns detailed information about a network. + */ + getNetwork(params: ManagedBlockchain.Types.GetNetworkInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.GetNetworkOutput) => void): Request; + /** + * Returns detailed information about a network. + */ + getNetwork(callback?: (err: AWSError, data: ManagedBlockchain.Types.GetNetworkOutput) => void): Request; + /** + * Returns detailed information about a peer node. + */ + getNode(params: ManagedBlockchain.Types.GetNodeInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.GetNodeOutput) => void): Request; + /** + * Returns detailed information about a peer node. + */ + getNode(callback?: (err: AWSError, data: ManagedBlockchain.Types.GetNodeOutput) => void): Request; + /** + * Returns detailed information about a proposal. + */ + getProposal(params: ManagedBlockchain.Types.GetProposalInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.GetProposalOutput) => void): Request; + /** + * Returns detailed information about a proposal. + */ + getProposal(callback?: (err: AWSError, data: ManagedBlockchain.Types.GetProposalOutput) => void): Request; + /** + * Returns a listing of all invitations made on the specified network. + */ + listInvitations(params: ManagedBlockchain.Types.ListInvitationsInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.ListInvitationsOutput) => void): Request; + /** + * Returns a listing of all invitations made on the specified network. + */ + listInvitations(callback?: (err: AWSError, data: ManagedBlockchain.Types.ListInvitationsOutput) => void): Request; + /** + * Returns a listing of the members in a network and properties of their configurations. + */ + listMembers(params: ManagedBlockchain.Types.ListMembersInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.ListMembersOutput) => void): Request; + /** + * Returns a listing of the members in a network and properties of their configurations. + */ + listMembers(callback?: (err: AWSError, data: ManagedBlockchain.Types.ListMembersOutput) => void): Request; + /** + * Returns information about the networks in which the current AWS account has members. + */ + listNetworks(params: ManagedBlockchain.Types.ListNetworksInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.ListNetworksOutput) => void): Request; + /** + * Returns information about the networks in which the current AWS account has members. + */ + listNetworks(callback?: (err: AWSError, data: ManagedBlockchain.Types.ListNetworksOutput) => void): Request; + /** + * Returns information about the nodes within a network. + */ + listNodes(params: ManagedBlockchain.Types.ListNodesInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.ListNodesOutput) => void): Request; + /** + * Returns information about the nodes within a network. + */ + listNodes(callback?: (err: AWSError, data: ManagedBlockchain.Types.ListNodesOutput) => void): Request; + /** + * Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote. + */ + listProposalVotes(params: ManagedBlockchain.Types.ListProposalVotesInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.ListProposalVotesOutput) => void): Request; + /** + * Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote. + */ + listProposalVotes(callback?: (err: AWSError, data: ManagedBlockchain.Types.ListProposalVotesOutput) => void): Request; + /** + * Returns a listing of proposals for the network. + */ + listProposals(params: ManagedBlockchain.Types.ListProposalsInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.ListProposalsOutput) => void): Request; + /** + * Returns a listing of proposals for the network. + */ + listProposals(callback?: (err: AWSError, data: ManagedBlockchain.Types.ListProposalsOutput) => void): Request; + /** + * Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network. + */ + rejectInvitation(params: ManagedBlockchain.Types.RejectInvitationInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.RejectInvitationOutput) => void): Request; + /** + * Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network. + */ + rejectInvitation(callback?: (err: AWSError, data: ManagedBlockchain.Types.RejectInvitationOutput) => void): Request; + /** + * Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action. + */ + voteOnProposal(params: ManagedBlockchain.Types.VoteOnProposalInput, callback?: (err: AWSError, data: ManagedBlockchain.Types.VoteOnProposalOutput) => void): Request; + /** + * Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action. + */ + voteOnProposal(callback?: (err: AWSError, data: ManagedBlockchain.Types.VoteOnProposalOutput) => void): Request; +} +declare namespace ManagedBlockchain { + export interface ApprovalThresholdPolicy { + /** + * The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved. + */ + ThresholdPercentage?: ThresholdPercentageInt; + /** + * The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions are not carried out. + */ + ProposalDurationInHours?: ProposalDurationInt; + /** + * Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved. + */ + ThresholdComparator?: ThresholdComparator; + } + export type AvailabilityZoneString = string; + export type ClientRequestTokenString = string; + export interface CreateMemberInput { + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI. + */ + ClientRequestToken: ClientRequestTokenString; + /** + * The unique identifier of the invitation that is sent to the member to join the network. + */ + InvitationId: ResourceIdString; + /** + * The unique identifier of the network in which the member is created. + */ + NetworkId: ResourceIdString; + /** + * Member configuration parameters. + */ + MemberConfiguration: MemberConfiguration; + } + export interface CreateMemberOutput { + /** + * The unique identifier of the member. + */ + MemberId?: ResourceIdString; + } + export interface CreateNetworkInput { + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI. + */ + ClientRequestToken: ClientRequestTokenString; + /** + * The name of the network. + */ + Name: NameString; + /** + * An optional description for the network. + */ + Description?: DescriptionString; + /** + * The blockchain framework that the network uses. + */ + Framework: Framework; + /** + * The version of the blockchain framework that the network uses. + */ + FrameworkVersion: FrameworkVersionString; + /** + * Configuration properties of the blockchain framework relevant to the network configuration. + */ + FrameworkConfiguration?: NetworkFrameworkConfiguration; + /** + * The voting rules used by the network to determine if a proposal is approved. + */ + VotingPolicy: VotingPolicy; + /** + * Configuration properties for the first member within the network. + */ + MemberConfiguration: MemberConfiguration; + } + export interface CreateNetworkOutput { + /** + * The unique identifier for the network. + */ + NetworkId?: ResourceIdString; + /** + * The unique identifier for the first member within the network. + */ + MemberId?: ResourceIdString; + } + export interface CreateNodeInput { + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI. + */ + ClientRequestToken: ClientRequestTokenString; + /** + * The unique identifier of the network in which this node runs. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the member that owns this node. + */ + MemberId: ResourceIdString; + /** + * The properties of a node configuration. + */ + NodeConfiguration: NodeConfiguration; + } + export interface CreateNodeOutput { + /** + * The unique identifier of the node. + */ + NodeId?: ResourceIdString; + } + export interface CreateProposalInput { + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI. + */ + ClientRequestToken: ClientRequestTokenString; + /** + * The unique identifier of the network for which the proposal is made. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single AWS account. + */ + MemberId: ResourceIdString; + /** + * The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions. + */ + Actions: ProposalActions; + /** + * A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member." + */ + Description?: DescriptionString; + } + export interface CreateProposalOutput { + /** + * The unique identifier of the proposal. + */ + ProposalId?: ResourceIdString; + } + export interface DeleteMemberInput { + /** + * The unique identifier of the network from which the member is removed. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the member to remove. + */ + MemberId: ResourceIdString; + } + export interface DeleteMemberOutput { + } + export interface DeleteNodeInput { + /** + * The unique identifier of the network that the node belongs to. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the member that owns this node. + */ + MemberId: ResourceIdString; + /** + * The unique identifier of the node. + */ + NodeId: ResourceIdString; + } + export interface DeleteNodeOutput { + } + export type DescriptionString = string; + export type Edition = "STARTER"|"STANDARD"|string; + export type Framework = "HYPERLEDGER_FABRIC"|string; + export type FrameworkVersionString = string; + export interface GetMemberInput { + /** + * The unique identifier of the network to which the member belongs. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the member. + */ + MemberId: ResourceIdString; + } + export interface GetMemberOutput { + /** + * The properties of a member. + */ + Member?: Member; + } + export interface GetNetworkInput { + /** + * The unique identifier of the network to get information about. + */ + NetworkId: ResourceIdString; + } + export interface GetNetworkOutput { + /** + * An object containing network configuration parameters. + */ + Network?: Network; + } + export interface GetNodeInput { + /** + * The unique identifier of the network to which the node belongs. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the member that owns the node. + */ + MemberId: ResourceIdString; + /** + * The unique identifier of the node. + */ + NodeId: ResourceIdString; + } + export interface GetNodeOutput { + /** + * Properties of the node configuration. + */ + Node?: Node; + } + export interface GetProposalInput { + /** + * The unique identifier of the network for which the proposal is made. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the proposal. + */ + ProposalId: ResourceIdString; + } + export interface GetProposalOutput { + /** + * Information about a proposal. + */ + Proposal?: Proposal; + } + export type InstanceTypeString = string; + export interface Invitation { + /** + * The unique identifier for the invitation. + */ + InvitationId?: ResourceIdString; + /** + * The date and time that the invitation was created. + */ + CreationDate?: Timestamp; + /** + * The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId. + */ + ExpirationDate?: Timestamp; + /** + * The status of the invitation: PENDING - The invitee has not created a member to join the network, and the invitation has not yet expired. ACCEPTING - The invitee has begun creating a member, and creation has not yet completed. ACCEPTED - The invitee created a member and joined the network using the InvitationID. REJECTED - The invitee rejected the invitation. EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate. + */ + Status?: InvitationStatus; + NetworkSummary?: NetworkSummary; + } + export type InvitationList = Invitation[]; + export type InvitationStatus = "PENDING"|"ACCEPTED"|"ACCEPTING"|"REJECTED"|"EXPIRED"|string; + export interface InviteAction { + /** + * The AWS account ID to invite. + */ + Principal: PrincipalString; + } + export type InviteActionList = InviteAction[]; + export type IsOwned = boolean; + export interface ListInvitationsInput { + /** + * The maximum number of invitations to return. + */ + MaxResults?: ProposalListMaxResults; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListInvitationsOutput { + /** + * The invitations for the network. + */ + Invitations?: InvitationList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListMembersInput { + /** + * The unique identifier of the network for which to list members. + */ + NetworkId: ResourceIdString; + /** + * The optional name of the member to list. + */ + Name?: String; + /** + * An optional status specifier. If provided, only members currently in this status are listed. + */ + Status?: MemberStatus; + /** + * An optional Boolean value. If provided, the request is limited either to members that the current AWS account owns (true) or that other AWS accounts own (false). If omitted, all members are listed. + */ + IsOwned?: IsOwned; + /** + * The maximum number of members to return in the request. + */ + MaxResults?: MemberListMaxResults; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListMembersOutput { + /** + * An array of MemberSummary objects. Each object contains details about a network member. + */ + Members?: MemberSummaryList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListNetworksInput { + /** + * The name of the network. + */ + Name?: String; + /** + * An optional framework specifier. If provided, only networks of this framework type are listed. + */ + Framework?: Framework; + /** + * An optional status specifier. If provided, only networks currently in this status are listed. + */ + Status?: NetworkStatus; + /** + * The maximum number of networks to list. + */ + MaxResults?: NetworkListMaxResults; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListNetworksOutput { + /** + * An array of NetworkSummary objects that contain configuration properties for each network. + */ + Networks?: NetworkSummaryList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListNodesInput { + /** + * The unique identifier of the network for which to list nodes. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the member who owns the nodes to list. + */ + MemberId: ResourceIdString; + /** + * An optional status specifier. If provided, only nodes currently in this status are listed. + */ + Status?: NodeStatus; + /** + * The maximum number of nodes to list. + */ + MaxResults?: NodeListMaxResults; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListNodesOutput { + /** + * An array of NodeSummary objects that contain configuration properties for each node. + */ + Nodes?: NodeSummaryList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListProposalVotesInput { + /** + * The unique identifier of the network. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the proposal. + */ + ProposalId: ResourceIdString; + /** + * The maximum number of votes to return. + */ + MaxResults?: ProposalListMaxResults; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListProposalVotesOutput { + /** + * The listing of votes. + */ + ProposalVotes?: ProposalVoteList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListProposalsInput { + /** + * The unique identifier of the network. + */ + NetworkId: ResourceIdString; + /** + * The maximum number of proposals to return. + */ + MaxResults?: ProposalListMaxResults; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface ListProposalsOutput { + /** + * The summary of each proposal made on the network. + */ + Proposals?: ProposalSummaryList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: PaginationToken; + } + export interface Member { + /** + * The unique identifier of the network to which the member belongs. + */ + NetworkId?: ResourceIdString; + /** + * The unique identifier of the member. + */ + Id?: ResourceIdString; + /** + * The name of the member. + */ + Name?: NetworkMemberNameString; + /** + * An optional description for the member. + */ + Description?: DescriptionString; + /** + * Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses. + */ + FrameworkAttributes?: MemberFrameworkAttributes; + /** + * The status of a member. CREATING - The AWS account is in the process of creating a member. AVAILABLE - The member has been created and can participate in the network. CREATE_FAILED - The AWS account attempted to create a member and creation failed. DELETING - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member. DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member. + */ + Status?: MemberStatus; + /** + * The date and time that the member was created. + */ + CreationDate?: Timestamp; + } + export interface MemberConfiguration { + /** + * The name of the member. + */ + Name: NetworkMemberNameString; + /** + * An optional description of the member. + */ + Description?: DescriptionString; + /** + * Configuration properties of the blockchain framework relevant to the member. + */ + FrameworkConfiguration: MemberFrameworkConfiguration; + } + export interface MemberFabricAttributes { + /** + * The user name for the initial administrator user for the member. + */ + AdminUsername?: UsernameString; + /** + * The endpoint used to access the member's certificate authority. + */ + CaEndpoint?: String; + } + export interface MemberFabricConfiguration { + /** + * The user name for the member's initial administrative user. + */ + AdminUsername: UsernameString; + /** + * The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(\), @, or a space. + */ + AdminPassword: PasswordString; + } + export interface MemberFrameworkAttributes { + /** + * Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric. + */ + Fabric?: MemberFabricAttributes; + } + export interface MemberFrameworkConfiguration { + /** + * Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric. + */ + Fabric?: MemberFabricConfiguration; + } + export type MemberListMaxResults = number; + export type MemberStatus = "CREATING"|"AVAILABLE"|"CREATE_FAILED"|"DELETING"|"DELETED"|string; + export interface MemberSummary { + /** + * The unique identifier of the member. + */ + Id?: ResourceIdString; + /** + * The name of the member. + */ + Name?: NetworkMemberNameString; + /** + * An optional description of the member. + */ + Description?: DescriptionString; + /** + * The status of the member. CREATING - The AWS account is in the process of creating a member. AVAILABLE - The member has been created and can participate in the network. CREATE_FAILED - The AWS account attempted to create a member and creation failed. DELETING - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member. DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member. + */ + Status?: MemberStatus; + /** + * The date and time that the member was created. + */ + CreationDate?: Timestamp; + /** + * An indicator of whether the member is owned by your AWS account or a different AWS account. + */ + IsOwned?: IsOwned; + } + export type MemberSummaryList = MemberSummary[]; + export type NameString = string; + export interface Network { + /** + * The unique identifier of the network. + */ + Id?: ResourceIdString; + /** + * The name of the network. + */ + Name?: NameString; + /** + * Attributes of the blockchain framework for the network. + */ + Description?: DescriptionString; + /** + * The blockchain framework that the network uses. + */ + Framework?: Framework; + /** + * The version of the blockchain framework that the network uses. + */ + FrameworkVersion?: FrameworkVersionString; + /** + * Attributes of the blockchain framework that the network uses. + */ + FrameworkAttributes?: NetworkFrameworkAttributes; + /** + * The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources. + */ + VpcEndpointServiceName?: String; + /** + * The voting rules for the network to decide if a proposal is accepted. + */ + VotingPolicy?: VotingPolicy; + /** + * The current status of the network. + */ + Status?: NetworkStatus; + /** + * The date and time that the network was created. + */ + CreationDate?: Timestamp; + } + export interface NetworkFabricAttributes { + /** + * The endpoint of the ordering service for the network. + */ + OrderingServiceEndpoint?: String; + /** + * The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing. + */ + Edition?: Edition; + } + export interface NetworkFabricConfiguration { + /** + * The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing. + */ + Edition: Edition; + } + export interface NetworkFrameworkAttributes { + /** + * Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric. + */ + Fabric?: NetworkFabricAttributes; + } + export interface NetworkFrameworkConfiguration { + /** + * Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric. + */ + Fabric?: NetworkFabricConfiguration; + } + export type NetworkListMaxResults = number; + export type NetworkMemberNameString = string; + export type NetworkStatus = "CREATING"|"AVAILABLE"|"CREATE_FAILED"|"DELETING"|"DELETED"|string; + export interface NetworkSummary { + /** + * The unique identifier of the network. + */ + Id?: ResourceIdString; + /** + * The name of the network. + */ + Name?: NameString; + /** + * An optional description of the network. + */ + Description?: DescriptionString; + /** + * The blockchain framework that the network uses. + */ + Framework?: Framework; + /** + * The version of the blockchain framework that the network uses. + */ + FrameworkVersion?: FrameworkVersionString; + /** + * The current status of the network. + */ + Status?: NetworkStatus; + /** + * The date and time that the network was created. + */ + CreationDate?: Timestamp; + } + export type NetworkSummaryList = NetworkSummary[]; + export interface Node { + /** + * The unique identifier of the network that the node is in. + */ + NetworkId?: ResourceIdString; + /** + * The unique identifier of the member to which the node belongs. + */ + MemberId?: ResourceIdString; + /** + * The unique identifier of the node. + */ + Id?: ResourceIdString; + /** + * The instance type of the node. + */ + InstanceType?: InstanceTypeString; + /** + * The Availability Zone in which the node exists. + */ + AvailabilityZone?: AvailabilityZoneString; + /** + * Attributes of the blockchain framework being used. + */ + FrameworkAttributes?: NodeFrameworkAttributes; + /** + * The status of the node. + */ + Status?: NodeStatus; + /** + * The date and time that the node was created. + */ + CreationDate?: Timestamp; + } + export interface NodeConfiguration { + /** + * The Amazon Managed Blockchain instance type for the node. + */ + InstanceType: InstanceTypeString; + /** + * The Availability Zone in which the node exists. + */ + AvailabilityZone: AvailabilityZoneString; + } + export interface NodeFabricAttributes { + /** + * The endpoint that identifies the peer node for all services except peer channel-based event services. + */ + PeerEndpoint?: String; + /** + * The endpoint that identifies the peer node for peer channel-based event services. + */ + PeerEventEndpoint?: String; + } + export interface NodeFrameworkAttributes { + /** + * Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric. + */ + Fabric?: NodeFabricAttributes; + } + export type NodeListMaxResults = number; + export type NodeStatus = "CREATING"|"AVAILABLE"|"CREATE_FAILED"|"DELETING"|"DELETED"|"FAILED"|string; + export interface NodeSummary { + /** + * The unique identifier of the node. + */ + Id?: ResourceIdString; + /** + * The status of the node. + */ + Status?: NodeStatus; + /** + * The date and time that the node was created. + */ + CreationDate?: Timestamp; + /** + * The Availability Zone in which the node exists. + */ + AvailabilityZone?: AvailabilityZoneString; + /** + * The EC2 instance type for the node. + */ + InstanceType?: InstanceTypeString; + } + export type NodeSummaryList = NodeSummary[]; + export type PaginationToken = string; + export type PasswordString = string; + export type PrincipalString = string; + export interface Proposal { + /** + * The unique identifier of the proposal. + */ + ProposalId?: ResourceIdString; + /** + * The unique identifier of the network for which the proposal is made. + */ + NetworkId?: ResourceIdString; + /** + * The description of the proposal. + */ + Description?: DescriptionString; + /** + * The actions to perform on the network if the proposal is APPROVED. + */ + Actions?: ProposalActions; + /** + * The unique identifier of the member that created the proposal. + */ + ProposedByMemberId?: ResourceIdString; + /** + * The name of the member that created the proposal. + */ + ProposedByMemberName?: NetworkMemberNameString; + /** + * The status of the proposal. Values are as follows: IN_PROGRESS - The proposal is active and open for member voting. APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out. REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions are not carried out. EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out. ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error. + */ + Status?: ProposalStatus; + /** + * The date and time that the proposal was created. + */ + CreationDate?: Timestamp; + /** + * The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out. + */ + ExpirationDate?: Timestamp; + /** + * The current total of YES votes cast on the proposal by members. + */ + YesVoteCount?: VoteCount; + /** + * The current total of NO votes cast on the proposal by members. + */ + NoVoteCount?: VoteCount; + /** + * The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES votes and NO votes. + */ + OutstandingVoteCount?: VoteCount; + } + export interface ProposalActions { + /** + * The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network. + */ + Invitations?: InviteActionList; + /** + * The actions to perform for an APPROVED proposal to remove a member from the network, which deletes the member and all associated member resources from the network. + */ + Removals?: RemoveActionList; + } + export type ProposalDurationInt = number; + export type ProposalListMaxResults = number; + export type ProposalStatus = "IN_PROGRESS"|"APPROVED"|"REJECTED"|"EXPIRED"|"ACTION_FAILED"|string; + export interface ProposalSummary { + /** + * The unique identifier of the proposal. + */ + ProposalId?: ResourceIdString; + /** + * The description of the proposal. + */ + Description?: DescriptionString; + /** + * The unique identifier of the member that created the proposal. + */ + ProposedByMemberId?: ResourceIdString; + /** + * The name of the member that created the proposal. + */ + ProposedByMemberName?: NetworkMemberNameString; + /** + * The status of the proposal. Values are as follows: IN_PROGRESS - The proposal is active and open for member voting. APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out. REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions are not carried out. EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out. ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error. + */ + Status?: ProposalStatus; + /** + * The date and time that the proposal was created. + */ + CreationDate?: Timestamp; + /** + * The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out. + */ + ExpirationDate?: Timestamp; + } + export type ProposalSummaryList = ProposalSummary[]; + export type ProposalVoteList = VoteSummary[]; + export interface RejectInvitationInput { + /** + * The unique identifier of the invitation to reject. + */ + InvitationId: ResourceIdString; + } + export interface RejectInvitationOutput { + } + export interface RemoveAction { + /** + * The unique identifier of the member to remove. + */ + MemberId: ResourceIdString; + } + export type RemoveActionList = RemoveAction[]; + export type ResourceIdString = string; + export type String = string; + export type ThresholdComparator = "GREATER_THAN"|"GREATER_THAN_OR_EQUAL_TO"|string; + export type ThresholdPercentageInt = number; + export type Timestamp = Date; + export type UsernameString = string; + export type VoteCount = number; + export interface VoteOnProposalInput { + /** + * The unique identifier of the network. + */ + NetworkId: ResourceIdString; + /** + * The unique identifier of the proposal. + */ + ProposalId: ResourceIdString; + /** + * The unique identifier of the member casting the vote. + */ + VoterMemberId: ResourceIdString; + /** + * The value of the vote. + */ + Vote: VoteValue; + } + export interface VoteOnProposalOutput { + } + export interface VoteSummary { + /** + * The vote value, either YES or NO. + */ + Vote?: VoteValue; + /** + * The name of the member that cast the vote. + */ + MemberName?: NetworkMemberNameString; + /** + * The unique identifier of the member that cast the vote. + */ + MemberId?: ResourceIdString; + } + export type VoteValue = "YES"|"NO"|string; + export interface VotingPolicy { + /** + * Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created. + */ + ApprovalThresholdPolicy?: ApprovalThresholdPolicy; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-09-24"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ManagedBlockchain client. + */ + export import Types = ManagedBlockchain; +} +export = ManagedBlockchain; diff --git a/node_modules/aws-sdk/clients/managedblockchain.js b/node_modules/aws-sdk/clients/managedblockchain.js new file mode 100644 index 0000000..50dedc8 --- /dev/null +++ b/node_modules/aws-sdk/clients/managedblockchain.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['managedblockchain'] = {}; +AWS.ManagedBlockchain = Service.defineService('managedblockchain', ['2018-09-24']); +Object.defineProperty(apiLoader.services['managedblockchain'], '2018-09-24', { + get: function get() { + var model = require('../apis/managedblockchain-2018-09-24.min.json'); + model.paginators = require('../apis/managedblockchain-2018-09-24.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ManagedBlockchain; diff --git a/node_modules/aws-sdk/clients/marketplacecommerceanalytics.d.ts b/node_modules/aws-sdk/clients/marketplacecommerceanalytics.d.ts new file mode 100644 index 0000000..c052f84 --- /dev/null +++ b/node_modules/aws-sdk/clients/marketplacecommerceanalytics.d.ts @@ -0,0 +1,132 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MarketplaceCommerceAnalytics extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MarketplaceCommerceAnalytics.Types.ClientConfiguration) + config: Config & MarketplaceCommerceAnalytics.Types.ClientConfiguration; + /** + * Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. + */ + generateDataSet(params: MarketplaceCommerceAnalytics.Types.GenerateDataSetRequest, callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.GenerateDataSetResult) => void): Request; + /** + * Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. + */ + generateDataSet(callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.GenerateDataSetResult) => void): Request; + /** + * Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. + */ + startSupportDataExport(params: MarketplaceCommerceAnalytics.Types.StartSupportDataExportRequest, callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.StartSupportDataExportResult) => void): Request; + /** + * Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. + */ + startSupportDataExport(callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.StartSupportDataExportResult) => void): Request; +} +declare namespace MarketplaceCommerceAnalytics { + export type CustomerDefinedValues = {[key: string]: OptionalValue}; + export type DataSetPublicationDate = Date; + export type DataSetRequestId = string; + export type DataSetType = "customer_subscriber_hourly_monthly_subscriptions"|"customer_subscriber_annual_subscriptions"|"daily_business_usage_by_instance_type"|"daily_business_fees"|"daily_business_free_trial_conversions"|"daily_business_new_instances"|"daily_business_new_product_subscribers"|"daily_business_canceled_product_subscribers"|"monthly_revenue_billing_and_revenue_data"|"monthly_revenue_annual_subscriptions"|"disbursed_amount_by_product"|"disbursed_amount_by_product_with_uncollected_funds"|"disbursed_amount_by_instance_hours"|"disbursed_amount_by_customer_geo"|"disbursed_amount_by_age_of_uncollected_funds"|"disbursed_amount_by_age_of_disbursed_funds"|"customer_profile_by_industry"|"customer_profile_by_revenue"|"customer_profile_by_geography"|"sales_compensation_billed_revenue"|"us_sales_and_use_tax_records"|string; + export type DestinationS3BucketName = string; + export type DestinationS3Prefix = string; + export type FromDate = Date; + export interface GenerateDataSetRequest { + /** + * The desired data set type. customer_subscriber_hourly_monthly_subscriptions From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time. customer_subscriber_annual_subscriptions From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time. daily_business_usage_by_instance_type From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time. daily_business_fees From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time. daily_business_free_trial_conversions From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time. daily_business_new_instances From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time. daily_business_new_product_subscribers From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time. daily_business_canceled_product_subscribers From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time. monthly_revenue_billing_and_revenue_data From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior. From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior. monthly_revenue_annual_subscriptions From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior. From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior. disbursed_amount_by_product From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time. disbursed_amount_by_product_with_uncollected_funds From 2012-04-19 to 2015-01-25: Available every 30 days by 5:00 PM Pacific Time. From 2015-01-26 to present: This data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds. disbursed_amount_by_instance_hours From 2012-09-04 to present: Available every 30 days by 5:00 PM Pacific Time. disbursed_amount_by_customer_geo From 2012-04-19 to present: Available every 30 days by 5:00 PM Pacific Time. disbursed_amount_by_age_of_uncollected_funds From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time. disbursed_amount_by_age_of_disbursed_funds From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time. customer_profile_by_industry From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time. From 2017-06-30 to present: This data set is no longer available. customer_profile_by_revenue From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time. From 2017-06-30 to present: This data set is no longer available. customer_profile_by_geography From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time. From 2017-06-30 to present: This data set is no longer available. sales_compensation_billed_revenue From 2016-12 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior, and up-front software charges (e.g. annual) from one month prior. From 2017-06 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior. us_sales_and_use_tax_records From 2017-02-15 to present: Available monthly on the 15th day of the month by 5:00 PM Pacific Time. + */ + dataSetType: DataSetType; + /** + * The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored). + */ + dataSetPublicationDate: DataSetPublicationDate; + /** + * The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. + */ + roleNameArn: RoleNameArn; + /** + * The name (friendly name, not ARN) of the destination S3 bucket. + */ + destinationS3BucketName: DestinationS3BucketName; + /** + * (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root. + */ + destinationS3Prefix?: DestinationS3Prefix; + /** + * Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred. + */ + snsTopicArn: SnsTopicArn; + /** + * (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems. + */ + customerDefinedValues?: CustomerDefinedValues; + } + export interface GenerateDataSetResult { + /** + * A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used to correlate a request with notifications from the SNS topic. + */ + dataSetRequestId?: DataSetRequestId; + } + export type OptionalKey = string; + export type OptionalValue = string; + export type RoleNameArn = string; + export type SnsTopicArn = string; + export interface StartSupportDataExportRequest { + /** + * Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time. customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter. test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data + */ + dataSetType: SupportDataSetType; + /** + * The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type. + */ + fromDate: FromDate; + /** + * The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. + */ + roleNameArn: RoleNameArn; + /** + * The name (friendly name, not ARN) of the destination S3 bucket. + */ + destinationS3BucketName: DestinationS3BucketName; + /** + * (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root. + */ + destinationS3Prefix?: DestinationS3Prefix; + /** + * Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred. + */ + snsTopicArn: SnsTopicArn; + /** + * (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. + */ + customerDefinedValues?: CustomerDefinedValues; + } + export interface StartSupportDataExportResult { + /** + * A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be used to correlate a request with notifications from the SNS topic. + */ + dataSetRequestId?: DataSetRequestId; + } + export type SupportDataSetType = "customer_support_contacts_data"|"test_customer_support_contacts_data"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-07-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MarketplaceCommerceAnalytics client. + */ + export import Types = MarketplaceCommerceAnalytics; +} +export = MarketplaceCommerceAnalytics; diff --git a/node_modules/aws-sdk/clients/marketplacecommerceanalytics.js b/node_modules/aws-sdk/clients/marketplacecommerceanalytics.js new file mode 100644 index 0000000..0161ec8 --- /dev/null +++ b/node_modules/aws-sdk/clients/marketplacecommerceanalytics.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['marketplacecommerceanalytics'] = {}; +AWS.MarketplaceCommerceAnalytics = Service.defineService('marketplacecommerceanalytics', ['2015-07-01']); +Object.defineProperty(apiLoader.services['marketplacecommerceanalytics'], '2015-07-01', { + get: function get() { + var model = require('../apis/marketplacecommerceanalytics-2015-07-01.min.json'); + model.paginators = require('../apis/marketplacecommerceanalytics-2015-07-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MarketplaceCommerceAnalytics; diff --git a/node_modules/aws-sdk/clients/marketplaceentitlementservice.d.ts b/node_modules/aws-sdk/clients/marketplaceentitlementservice.d.ts new file mode 100644 index 0000000..d79b9c1 --- /dev/null +++ b/node_modules/aws-sdk/clients/marketplaceentitlementservice.d.ts @@ -0,0 +1,120 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MarketplaceEntitlementService extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MarketplaceEntitlementService.Types.ClientConfiguration) + config: Config & MarketplaceEntitlementService.Types.ClientConfiguration; + /** + * GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions. + */ + getEntitlements(params: MarketplaceEntitlementService.Types.GetEntitlementsRequest, callback?: (err: AWSError, data: MarketplaceEntitlementService.Types.GetEntitlementsResult) => void): Request; + /** + * GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions. + */ + getEntitlements(callback?: (err: AWSError, data: MarketplaceEntitlementService.Types.GetEntitlementsResult) => void): Request; +} +declare namespace MarketplaceEntitlementService { + export type Boolean = boolean; + export type Double = number; + export interface Entitlement { + /** + * The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created. + */ + ProductCode?: ProductCode; + /** + * The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace. + */ + Dimension?: NonEmptyString; + /** + * The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service. + */ + CustomerIdentifier?: NonEmptyString; + /** + * The EntitlementValue represents the amount of capacity that the customer is entitled to for the product. + */ + Value?: EntitlementValue; + /** + * The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date. + */ + ExpirationDate?: Timestamp; + } + export type EntitlementList = Entitlement[]; + export interface EntitlementValue { + /** + * The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set. + */ + IntegerValue?: Integer; + /** + * The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set. + */ + DoubleValue?: Double; + /** + * The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set. + */ + BooleanValue?: Boolean; + /** + * The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set. + */ + StringValue?: String; + } + export type FilterValue = string; + export type FilterValueList = FilterValue[]; + export type GetEntitlementFilterName = "CUSTOMER_IDENTIFIER"|"DIMENSION"|string; + export type GetEntitlementFilters = {[key: string]: FilterValueList}; + export interface GetEntitlementsRequest { + /** + * Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created. + */ + ProductCode: ProductCode; + /** + * Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key. + */ + Filter?: GetEntitlementFilters; + /** + * For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult. + */ + NextToken?: NonEmptyString; + /** + * The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements. + */ + MaxResults?: Integer; + } + export interface GetEntitlementsResult { + /** + * The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used. + */ + Entitlements?: EntitlementList; + /** + * For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set of entitlements, NextToken might still be present and should be used. + */ + NextToken?: NonEmptyString; + } + export type Integer = number; + export type NonEmptyString = string; + export type ProductCode = string; + export type String = string; + export type Timestamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-01-11"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MarketplaceEntitlementService client. + */ + export import Types = MarketplaceEntitlementService; +} +export = MarketplaceEntitlementService; diff --git a/node_modules/aws-sdk/clients/marketplaceentitlementservice.js b/node_modules/aws-sdk/clients/marketplaceentitlementservice.js new file mode 100644 index 0000000..6ba7de0 --- /dev/null +++ b/node_modules/aws-sdk/clients/marketplaceentitlementservice.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['marketplaceentitlementservice'] = {}; +AWS.MarketplaceEntitlementService = Service.defineService('marketplaceentitlementservice', ['2017-01-11']); +Object.defineProperty(apiLoader.services['marketplaceentitlementservice'], '2017-01-11', { + get: function get() { + var model = require('../apis/entitlement.marketplace-2017-01-11.min.json'); + model.paginators = require('../apis/entitlement.marketplace-2017-01-11.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MarketplaceEntitlementService; diff --git a/node_modules/aws-sdk/clients/marketplacemetering.d.ts b/node_modules/aws-sdk/clients/marketplacemetering.d.ts new file mode 100644 index 0000000..98e7164 --- /dev/null +++ b/node_modules/aws-sdk/clients/marketplacemetering.d.ts @@ -0,0 +1,197 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MarketplaceMetering extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MarketplaceMetering.Types.ClientConfiguration) + config: Config & MarketplaceMetering.Types.ClientConfiguration; + /** + * BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers. For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records. Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage. BatchMeterUsage can process up to 25 UsageRecords at a time. + */ + batchMeterUsage(params: MarketplaceMetering.Types.BatchMeterUsageRequest, callback?: (err: AWSError, data: MarketplaceMetering.Types.BatchMeterUsageResult) => void): Request; + /** + * BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers. For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records. Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage. BatchMeterUsage can process up to 25 UsageRecords at a time. + */ + batchMeterUsage(callback?: (err: AWSError, data: MarketplaceMetering.Types.BatchMeterUsageResult) => void): Request; + /** + * API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID. MeterUsage is authenticated on the buyer's AWS account, generally when running from an EC2 instance on the AWS Marketplace. + */ + meterUsage(params: MarketplaceMetering.Types.MeterUsageRequest, callback?: (err: AWSError, data: MarketplaceMetering.Types.MeterUsageResult) => void): Request; + /** + * API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID. MeterUsage is authenticated on the buyer's AWS account, generally when running from an EC2 instance on the AWS Marketplace. + */ + meterUsage(callback?: (err: AWSError, data: MarketplaceMetering.Types.MeterUsageResult) => void): Request; + /** + * Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering. Calling RegisterUsage from containers running outside of ECS is not currently supported. Free and BYOL products for ECS aren't required to call RegisterUsage, but you may choose to do so if you would like to receive usage data in your seller reports. The sections below explain the behavior of RegisterUsage. RegisterUsage performs two primary functions: metering and entitlement. Entitlement: RegisterUsage allows you to verify that the customer running your paid software is subscribed to your product on AWS Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task is still running. Metering: RegisterUsage meters software use per ECS task, per hour, with usage prorated to the second. A minimum of 1 minute of usage applies to tasks that are short lived. For example, if a customer has a 10 node ECS cluster and creates an ECS service configured as a Daemon Set, then ECS will launch a task on all 10 cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for software use is automatically handled by the AWS Marketplace Metering Control Plane -- your software is not required to perform any metering specific actions, other than call RegisterUsage once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime. + */ + registerUsage(params: MarketplaceMetering.Types.RegisterUsageRequest, callback?: (err: AWSError, data: MarketplaceMetering.Types.RegisterUsageResult) => void): Request; + /** + * Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering. Calling RegisterUsage from containers running outside of ECS is not currently supported. Free and BYOL products for ECS aren't required to call RegisterUsage, but you may choose to do so if you would like to receive usage data in your seller reports. The sections below explain the behavior of RegisterUsage. RegisterUsage performs two primary functions: metering and entitlement. Entitlement: RegisterUsage allows you to verify that the customer running your paid software is subscribed to your product on AWS Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task is still running. Metering: RegisterUsage meters software use per ECS task, per hour, with usage prorated to the second. A minimum of 1 minute of usage applies to tasks that are short lived. For example, if a customer has a 10 node ECS cluster and creates an ECS service configured as a Daemon Set, then ECS will launch a task on all 10 cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for software use is automatically handled by the AWS Marketplace Metering Control Plane -- your software is not required to perform any metering specific actions, other than call RegisterUsage once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime. + */ + registerUsage(callback?: (err: AWSError, data: MarketplaceMetering.Types.RegisterUsageResult) => void): Request; + /** + * ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier and product code. + */ + resolveCustomer(params: MarketplaceMetering.Types.ResolveCustomerRequest, callback?: (err: AWSError, data: MarketplaceMetering.Types.ResolveCustomerResult) => void): Request; + /** + * ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier and product code. + */ + resolveCustomer(callback?: (err: AWSError, data: MarketplaceMetering.Types.ResolveCustomerResult) => void): Request; +} +declare namespace MarketplaceMetering { + export interface BatchMeterUsageRequest { + /** + * The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time. + */ + UsageRecords: UsageRecordList; + /** + * Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product. + */ + ProductCode: ProductCode; + } + export interface BatchMeterUsageResult { + /** + * Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid. + */ + Results?: UsageRecordResultList; + /** + * Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest. + */ + UnprocessedRecords?: UsageRecordList; + } + export type Boolean = boolean; + export type CustomerIdentifier = string; + export interface MeterUsageRequest { + /** + * Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product. + */ + ProductCode: ProductCode; + /** + * Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored. + */ + Timestamp: Timestamp; + /** + * It will be one of the fcp dimension name provided during the publishing of the product. + */ + UsageDimension: UsageDimension; + /** + * Consumption value for the hour. Defaults to 0 if not specified. + */ + UsageQuantity?: UsageQuantity; + /** + * Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to false if not specified. + */ + DryRun?: Boolean; + } + export interface MeterUsageResult { + /** + * Metering record id. + */ + MeteringRecordId?: String; + } + export type NonEmptyString = string; + export type Nonce = string; + export type ProductCode = string; + export interface RegisterUsageRequest { + /** + * Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product. + */ + ProductCode: ProductCode; + /** + * Public Key Version provided by AWS Marketplace + */ + PublicKeyVersion: VersionInteger; + /** + * (Optional) To scope down the registration to a specific running software instance and guard against replay attacks. + */ + Nonce?: Nonce; + } + export interface RegisterUsageResult { + /** + * (Optional) Only included when public key version has expired + */ + PublicKeyRotationTimestamp?: Timestamp; + /** + * JWT Token + */ + Signature?: NonEmptyString; + } + export interface ResolveCustomerRequest { + /** + * When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier and product code. + */ + RegistrationToken: NonEmptyString; + } + export interface ResolveCustomerResult { + /** + * The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord. + */ + CustomerIdentifier?: CustomerIdentifier; + /** + * The product code is returned to confirm that the buyer is registering for your product. Subsequent BatchMeterUsage calls should be made using this product code. + */ + ProductCode?: ProductCode; + } + export type String = string; + export type Timestamp = Date; + export type UsageDimension = string; + export type UsageQuantity = number; + export interface UsageRecord { + /** + * Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored. Your application can meter usage for up to one hour in the past. + */ + Timestamp: Timestamp; + /** + * The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application. + */ + CustomerIdentifier: CustomerIdentifier; + /** + * During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application. + */ + Dimension: UsageDimension; + /** + * The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified. + */ + Quantity?: UsageQuantity; + } + export type UsageRecordList = UsageRecord[]; + export interface UsageRecordResult { + /** + * The UsageRecord that was part of the BatchMeterUsage request. + */ + UsageRecord?: UsageRecord; + /** + * The MeteringRecordId is a unique identifier for this metering event. + */ + MeteringRecordId?: String; + /** + * The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage. Success- The UsageRecord was accepted and honored by BatchMeterUsage. CustomerNotSubscribed- The CustomerIdentifier specified is not subscribed to your product. The UsageRecord was not honored. Future UsageRecords for this customer will fail until the customer subscribes to your product. DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity. + */ + Status?: UsageRecordResultStatus; + } + export type UsageRecordResultList = UsageRecordResult[]; + export type UsageRecordResultStatus = "Success"|"CustomerNotSubscribed"|"DuplicateRecord"|string; + export type VersionInteger = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-01-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MarketplaceMetering client. + */ + export import Types = MarketplaceMetering; +} +export = MarketplaceMetering; diff --git a/node_modules/aws-sdk/clients/marketplacemetering.js b/node_modules/aws-sdk/clients/marketplacemetering.js new file mode 100644 index 0000000..460b033 --- /dev/null +++ b/node_modules/aws-sdk/clients/marketplacemetering.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['marketplacemetering'] = {}; +AWS.MarketplaceMetering = Service.defineService('marketplacemetering', ['2016-01-14']); +Object.defineProperty(apiLoader.services['marketplacemetering'], '2016-01-14', { + get: function get() { + var model = require('../apis/meteringmarketplace-2016-01-14.min.json'); + model.paginators = require('../apis/meteringmarketplace-2016-01-14.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MarketplaceMetering; diff --git a/node_modules/aws-sdk/clients/mediaconnect.d.ts b/node_modules/aws-sdk/clients/mediaconnect.d.ts new file mode 100644 index 0000000..13da9fc --- /dev/null +++ b/node_modules/aws-sdk/clients/mediaconnect.d.ts @@ -0,0 +1,881 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MediaConnect extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MediaConnect.Types.ClientConfiguration) + config: Config & MediaConnect.Types.ClientConfiguration; + /** + * Adds outputs to an existing flow. You can create up to 20 outputs per flow. + */ + addFlowOutputs(params: MediaConnect.Types.AddFlowOutputsRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddFlowOutputsResponse) => void): Request; + /** + * Adds outputs to an existing flow. You can create up to 20 outputs per flow. + */ + addFlowOutputs(callback?: (err: AWSError, data: MediaConnect.Types.AddFlowOutputsResponse) => void): Request; + /** + * Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50). + */ + createFlow(params: MediaConnect.Types.CreateFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.CreateFlowResponse) => void): Request; + /** + * Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50). + */ + createFlow(callback?: (err: AWSError, data: MediaConnect.Types.CreateFlowResponse) => void): Request; + /** + * Deletes a flow. Before you can delete a flow, you must stop the flow. + */ + deleteFlow(params: MediaConnect.Types.DeleteFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.DeleteFlowResponse) => void): Request; + /** + * Deletes a flow. Before you can delete a flow, you must stop the flow. + */ + deleteFlow(callback?: (err: AWSError, data: MediaConnect.Types.DeleteFlowResponse) => void): Request; + /** + * Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements. + */ + describeFlow(params: MediaConnect.Types.DescribeFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request; + /** + * Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements. + */ + describeFlow(callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request; + /** + * Grants entitlements to an existing flow. + */ + grantFlowEntitlements(params: MediaConnect.Types.GrantFlowEntitlementsRequest, callback?: (err: AWSError, data: MediaConnect.Types.GrantFlowEntitlementsResponse) => void): Request; + /** + * Grants entitlements to an existing flow. + */ + grantFlowEntitlements(callback?: (err: AWSError, data: MediaConnect.Types.GrantFlowEntitlementsResponse) => void): Request; + /** + * Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page. + */ + listEntitlements(params: MediaConnect.Types.ListEntitlementsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListEntitlementsResponse) => void): Request; + /** + * Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page. + */ + listEntitlements(callback?: (err: AWSError, data: MediaConnect.Types.ListEntitlementsResponse) => void): Request; + /** + * Displays a list of flows that are associated with this account. This request returns a paginated result. + */ + listFlows(params: MediaConnect.Types.ListFlowsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListFlowsResponse) => void): Request; + /** + * Displays a list of flows that are associated with this account. This request returns a paginated result. + */ + listFlows(callback?: (err: AWSError, data: MediaConnect.Types.ListFlowsResponse) => void): Request; + /** + * List all tags on an AWS Elemental MediaConnect resource + */ + listTagsForResource(params: MediaConnect.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListTagsForResourceResponse) => void): Request; + /** + * List all tags on an AWS Elemental MediaConnect resource + */ + listTagsForResource(callback?: (err: AWSError, data: MediaConnect.Types.ListTagsForResourceResponse) => void): Request; + /** + * Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output. + */ + removeFlowOutput(params: MediaConnect.Types.RemoveFlowOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowOutputResponse) => void): Request; + /** + * Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output. + */ + removeFlowOutput(callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowOutputResponse) => void): Request; + /** + * Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed. + */ + revokeFlowEntitlement(params: MediaConnect.Types.RevokeFlowEntitlementRequest, callback?: (err: AWSError, data: MediaConnect.Types.RevokeFlowEntitlementResponse) => void): Request; + /** + * Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed. + */ + revokeFlowEntitlement(callback?: (err: AWSError, data: MediaConnect.Types.RevokeFlowEntitlementResponse) => void): Request; + /** + * Starts a flow. + */ + startFlow(params: MediaConnect.Types.StartFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.StartFlowResponse) => void): Request; + /** + * Starts a flow. + */ + startFlow(callback?: (err: AWSError, data: MediaConnect.Types.StartFlowResponse) => void): Request; + /** + * Stops a flow. + */ + stopFlow(params: MediaConnect.Types.StopFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.StopFlowResponse) => void): Request; + /** + * Stops a flow. + */ + stopFlow(callback?: (err: AWSError, data: MediaConnect.Types.StopFlowResponse) => void): Request; + /** + * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. + */ + tagResource(params: MediaConnect.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes specified tags from a resource. + */ + untagResource(params: MediaConnect.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes specified tags from a resource. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed. + */ + updateFlowEntitlement(params: MediaConnect.Types.UpdateFlowEntitlementRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowEntitlementResponse) => void): Request; + /** + * You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed. + */ + updateFlowEntitlement(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowEntitlementResponse) => void): Request; + /** + * Updates an existing flow output. + */ + updateFlowOutput(params: MediaConnect.Types.UpdateFlowOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowOutputResponse) => void): Request; + /** + * Updates an existing flow output. + */ + updateFlowOutput(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowOutputResponse) => void): Request; + /** + * Updates the source of a flow. + */ + updateFlowSource(params: MediaConnect.Types.UpdateFlowSourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowSourceResponse) => void): Request; + /** + * Updates the source of a flow. + */ + updateFlowSource(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowSourceResponse) => void): Request; +} +declare namespace MediaConnect { + export interface AddFlowOutputsRequest { + /** + * The flow that you want to add outputs to. + */ + FlowArn: __string; + /** + * A list of outputs that you want to add. + */ + Outputs: __listOfAddOutputRequest; + } + export interface AddFlowOutputsResponse { + /** + * The ARN of the flow that these outputs were added to. + */ + FlowArn?: __string; + /** + * The details of the newly added outputs. + */ + Outputs?: __listOfOutput; + } + export interface AddOutputRequest { + /** + * A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user. + */ + Description?: __string; + /** + * The IP address from which video will be sent to output destinations. + */ + Destination: __string; + /** + * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). + */ + Encryption?: Encryption; + /** + * The maximum latency in milliseconds for Zixi-based streams. + */ + MaxLatency?: __integer; + /** + * The name of the output. This value must be unique within the current flow. + */ + Name?: __string; + /** + * The port to use when content is distributed to this output. + */ + Port: __integer; + /** + * The protocol to use for the output. + */ + Protocol: Protocol; + /** + * The smoothing latency in milliseconds for RTP and RTP-FEC streams. + */ + SmoothingLatency?: __integer; + /** + * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. + */ + StreamId?: __string; + } + export type Algorithm = "aes128"|"aes192"|"aes256"|string; + export interface CreateFlowRequest { + /** + * The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region. + */ + AvailabilityZone?: __string; + /** + * The entitlements that you want to grant on a flow. + */ + Entitlements?: __listOfGrantEntitlementRequest; + /** + * The name of the flow. + */ + Name: __string; + /** + * The outputs that you want to add to this flow. + */ + Outputs?: __listOfAddOutputRequest; + Source: SetSourceRequest; + } + export interface CreateFlowResponse { + Flow?: Flow; + } + export interface DeleteFlowRequest { + /** + * The ARN of the flow that you want to delete. + */ + FlowArn: __string; + } + export interface DeleteFlowResponse { + /** + * The ARN of the flow that was deleted. + */ + FlowArn?: __string; + /** + * The status of the flow when the DeleteFlow process begins. + */ + Status?: Status; + } + export interface DescribeFlowRequest { + /** + * The ARN of the flow that you want to describe. + */ + FlowArn: __string; + } + export interface DescribeFlowResponse { + Flow?: Flow; + Messages?: Messages; + } + export interface Encryption { + /** + * The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). + */ + Algorithm: Algorithm; + /** + * The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). + */ + KeyType?: KeyType; + /** + * The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). + */ + RoleArn: __string; + /** + * The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key. + */ + SecretArn: __string; + } + export interface Entitlement { + /** + * A description of the entitlement. + */ + Description?: __string; + /** + * The type of encryption that will be used on the output that is associated with this entitlement. + */ + Encryption?: Encryption; + /** + * The ARN of the entitlement. + */ + EntitlementArn: __string; + /** + * The name of the entitlement. + */ + Name: __string; + /** + * The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source. + */ + Subscribers: __listOf__string; + } + export interface Flow { + /** + * The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS. + */ + AvailabilityZone: __string; + /** + * A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account. + */ + Description?: __string; + /** + * The IP address from which video will be sent to output destinations. + */ + EgressIp?: __string; + /** + * The entitlements in this flow. + */ + Entitlements: __listOfEntitlement; + /** + * The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. + */ + FlowArn: __string; + /** + * The name of the flow. + */ + Name: __string; + /** + * The outputs in this flow. + */ + Outputs: __listOfOutput; + Source: Source; + /** + * The current status of the flow. + */ + Status: Status; + } + export interface GrantEntitlementRequest { + /** + * A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user. + */ + Description?: __string; + /** + * The type of encryption that will be used on the output that is associated with this entitlement. + */ + Encryption?: Encryption; + /** + * The name of the entitlement. This value must be unique within the current flow. + */ + Name?: __string; + /** + * The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source. + */ + Subscribers: __listOf__string; + } + export interface GrantFlowEntitlementsRequest { + /** + * The list of entitlements that you want to grant. + */ + Entitlements: __listOfGrantEntitlementRequest; + /** + * The flow that you want to grant entitlements on. + */ + FlowArn: __string; + } + export interface GrantFlowEntitlementsResponse { + /** + * The entitlements that were just granted. + */ + Entitlements?: __listOfEntitlement; + /** + * The ARN of the flow that these entitlements were granted to. + */ + FlowArn?: __string; + } + export type KeyType = "static-key"|string; + export interface ListEntitlementsRequest { + /** + * The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page. + */ + MaxResults?: MaxResults; + /** + * The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value. + */ + NextToken?: __string; + } + export interface ListEntitlementsResponse { + /** + * A list of entitlements that have been granted to you from other AWS accounts. + */ + Entitlements?: __listOfListedEntitlement; + /** + * The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value. + */ + NextToken?: __string; + } + export interface ListFlowsRequest { + /** + * The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. + */ + MaxResults?: MaxResults; + /** + * The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value. + */ + NextToken?: __string; + } + export interface ListFlowsResponse { + /** + * A list of flow summaries. + */ + Flows?: __listOfListedFlow; + /** + * The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value. + */ + NextToken?: __string; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags. + */ + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + /** + * A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + Tags?: __mapOf__string; + } + export interface ListedEntitlement { + /** + * The ARN of the entitlement. + */ + EntitlementArn: __string; + /** + * The name of the entitlement. + */ + EntitlementName: __string; + } + export interface ListedFlow { + /** + * The Availability Zone that the flow was created in. + */ + AvailabilityZone: __string; + /** + * A description of the flow. + */ + Description: __string; + /** + * The ARN of the flow. + */ + FlowArn: __string; + /** + * The name of the flow. + */ + Name: __string; + /** + * The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account). + */ + SourceType: SourceType; + /** + * The current status of the flow. + */ + Status: Status; + } + export type MaxResults = number; + export interface Messages { + /** + * A list of errors that might have been generated from processes on this flow. + */ + Errors: __listOf__string; + } + export interface Output { + /** + * A description of the output. + */ + Description?: __string; + /** + * The address where you want to send the output. + */ + Destination?: __string; + /** + * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). + */ + Encryption?: Encryption; + /** + * The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows. + */ + EntitlementArn?: __string; + /** + * The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input. + */ + MediaLiveInputArn?: __string; + /** + * The name of the output. This value must be unique within the current flow. + */ + Name: __string; + /** + * The ARN of the output. + */ + OutputArn: __string; + /** + * The port to use when content is distributed to this output. + */ + Port?: __integer; + /** + * Attributes related to the transport stream that are used in the output. + */ + Transport?: Transport; + } + export type Protocol = "zixi-push"|"rtp-fec"|"rtp"|string; + export interface RemoveFlowOutputRequest { + /** + * The flow that you want to remove an output from. + */ + FlowArn: __string; + /** + * The ARN of the output that you want to remove. + */ + OutputArn: __string; + } + export interface RemoveFlowOutputResponse { + /** + * The ARN of the flow that is associated with the output you removed. + */ + FlowArn?: __string; + /** + * The ARN of the output that was removed. + */ + OutputArn?: __string; + } + export interface RevokeFlowEntitlementRequest { + /** + * The ARN of the entitlement that you want to revoke. + */ + EntitlementArn: __string; + /** + * The flow that you want to revoke an entitlement from. + */ + FlowArn: __string; + } + export interface RevokeFlowEntitlementResponse { + /** + * The ARN of the entitlement that was revoked. + */ + EntitlementArn?: __string; + /** + * The ARN of the flow that the entitlement was revoked from. + */ + FlowArn?: __string; + } + export interface SetSourceRequest { + /** + * The type of encryption that is used on the content ingested from this source. + */ + Decryption?: Encryption; + /** + * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. + */ + Description?: __string; + /** + * The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow. + */ + EntitlementArn?: __string; + /** + * The port that the flow will be listening on for incoming content. + */ + IngestPort?: __integer; + /** + * The smoothing max bitrate for RTP and RTP-FEC streams. + */ + MaxBitrate?: __integer; + /** + * The maximum latency in milliseconds for Zixi-based streams. + */ + MaxLatency?: __integer; + /** + * The name of the source. + */ + Name?: __string; + /** + * The protocol that is used by the source. + */ + Protocol?: Protocol; + /** + * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. + */ + StreamId?: __string; + /** + * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + */ + WhitelistCidr?: __string; + } + export interface Source { + /** + * The type of encryption that is used on the content ingested from this source. + */ + Decryption?: Encryption; + /** + * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. + */ + Description?: __string; + /** + * The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow. + */ + EntitlementArn?: __string; + /** + * The IP address that the flow will be listening on for incoming content. + */ + IngestIp?: __string; + /** + * The port that the flow will be listening on for incoming content. + */ + IngestPort?: __integer; + /** + * The name of the source. + */ + Name: __string; + /** + * The ARN of the source. + */ + SourceArn: __string; + /** + * Attributes related to the transport stream that are used in the source. + */ + Transport?: Transport; + /** + * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + */ + WhitelistCidr?: __string; + } + export type SourceType = "OWNED"|"ENTITLED"|string; + export interface StartFlowRequest { + /** + * The ARN of the flow that you want to start. + */ + FlowArn: __string; + } + export interface StartFlowResponse { + /** + * The ARN of the flow that you started. + */ + FlowArn?: __string; + /** + * The status of the flow when the StartFlow process begins. + */ + Status?: Status; + } + export type Status = "STANDBY"|"ACTIVE"|"UPDATING"|"DELETING"|"STARTING"|"STOPPING"|"ERROR"|string; + export interface StopFlowRequest { + /** + * The ARN of the flow that you want to stop. + */ + FlowArn: __string; + } + export interface StopFlowResponse { + /** + * The ARN of the flow that you stopped. + */ + FlowArn?: __string; + /** + * The status of the flow when the StopFlow process begins. + */ + Status?: Status; + } + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags. + */ + ResourceArn: __string; + /** + * A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + Tags: __mapOf__string; + } + export interface Transport { + /** + * The smoothing max bitrate for RTP and RTP-FEC streams. + */ + MaxBitrate?: __integer; + /** + * The maximum latency in milliseconds for Zixi-based streams. + */ + MaxLatency?: __integer; + /** + * The protocol that is used by the source or output. + */ + Protocol: Protocol; + /** + * The smoothing latency in milliseconds for RTP and RTP-FEC streams. + */ + SmoothingLatency?: __integer; + /** + * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. + */ + StreamId?: __string; + } + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags. + */ + ResourceArn: __string; + /** + * The keys of the tags to be removed. + */ + TagKeys: __listOf__string; + } + export interface UpdateEncryption { + /** + * The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). + */ + Algorithm?: Algorithm; + /** + * The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). + */ + KeyType?: KeyType; + /** + * The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). + */ + RoleArn?: __string; + /** + * The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key. + */ + SecretArn?: __string; + } + export interface UpdateFlowEntitlementRequest { + /** + * A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user. + */ + Description?: __string; + /** + * The type of encryption that will be used on the output associated with this entitlement. + */ + Encryption?: UpdateEncryption; + /** + * The ARN of the entitlement that you want to update. + */ + EntitlementArn: __string; + /** + * The flow that is associated with the entitlement that you want to update. + */ + FlowArn: __string; + /** + * The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source. + */ + Subscribers?: __listOf__string; + } + export interface UpdateFlowEntitlementResponse { + Entitlement?: Entitlement; + /** + * The ARN of the flow that this entitlement was granted on. + */ + FlowArn?: __string; + } + export interface UpdateFlowOutputRequest { + /** + * A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user. + */ + Description?: __string; + /** + * The IP address where you want to send the output. + */ + Destination?: __string; + /** + * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). + */ + Encryption?: UpdateEncryption; + /** + * The flow that is associated with the output that you want to update. + */ + FlowArn: __string; + /** + * The maximum latency in milliseconds for Zixi-based streams. + */ + MaxLatency?: __integer; + /** + * The ARN of the output that you want to update. + */ + OutputArn: __string; + /** + * The port to use when content is distributed to this output. + */ + Port?: __integer; + /** + * The protocol to use for the output. + */ + Protocol?: Protocol; + /** + * The smoothing latency in milliseconds for RTP and RTP-FEC streams. + */ + SmoothingLatency?: __integer; + /** + * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. + */ + StreamId?: __string; + } + export interface UpdateFlowOutputResponse { + /** + * The ARN of the flow that is associated with the updated output. + */ + FlowArn?: __string; + Output?: Output; + } + export interface UpdateFlowSourceRequest { + /** + * The type of encryption used on the content ingested from this source. + */ + Decryption?: UpdateEncryption; + /** + * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. + */ + Description?: __string; + /** + * The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow. + */ + EntitlementArn?: __string; + /** + * The flow that is associated with the source that you want to update. + */ + FlowArn: __string; + /** + * The port that the flow will be listening on for incoming content. + */ + IngestPort?: __integer; + /** + * The smoothing max bitrate for RTP and RTP-FEC streams. + */ + MaxBitrate?: __integer; + /** + * The maximum latency in milliseconds for Zixi-based streams. + */ + MaxLatency?: __integer; + /** + * The protocol that is used by the source. + */ + Protocol?: Protocol; + /** + * The ARN of the source that you want to update. + */ + SourceArn: __string; + /** + * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. + */ + StreamId?: __string; + /** + * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + */ + WhitelistCidr?: __string; + } + export interface UpdateFlowSourceResponse { + /** + * The ARN of the flow that you want to update. + */ + FlowArn?: __string; + /** + * The settings for the source of the flow. + */ + Source?: Source; + } + export type __integer = number; + export type __listOfAddOutputRequest = AddOutputRequest[]; + export type __listOfEntitlement = Entitlement[]; + export type __listOfGrantEntitlementRequest = GrantEntitlementRequest[]; + export type __listOfListedEntitlement = ListedEntitlement[]; + export type __listOfListedFlow = ListedFlow[]; + export type __listOfOutput = Output[]; + export type __listOf__string = __string[]; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-11-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MediaConnect client. + */ + export import Types = MediaConnect; +} +export = MediaConnect; diff --git a/node_modules/aws-sdk/clients/mediaconnect.js b/node_modules/aws-sdk/clients/mediaconnect.js new file mode 100644 index 0000000..16b42f5 --- /dev/null +++ b/node_modules/aws-sdk/clients/mediaconnect.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mediaconnect'] = {}; +AWS.MediaConnect = Service.defineService('mediaconnect', ['2018-11-14']); +Object.defineProperty(apiLoader.services['mediaconnect'], '2018-11-14', { + get: function get() { + var model = require('../apis/mediaconnect-2018-11-14.min.json'); + model.paginators = require('../apis/mediaconnect-2018-11-14.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MediaConnect; diff --git a/node_modules/aws-sdk/clients/mediaconvert.d.ts b/node_modules/aws-sdk/clients/mediaconvert.d.ts new file mode 100644 index 0000000..c2ee00a --- /dev/null +++ b/node_modules/aws-sdk/clients/mediaconvert.d.ts @@ -0,0 +1,4197 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MediaConvert extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MediaConvert.Types.ClientConfiguration) + config: Config & MediaConvert.Types.ClientConfiguration; + /** + * Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert. + */ + associateCertificate(params: MediaConvert.Types.AssociateCertificateRequest, callback?: (err: AWSError, data: MediaConvert.Types.AssociateCertificateResponse) => void): Request; + /** + * Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert. + */ + associateCertificate(callback?: (err: AWSError, data: MediaConvert.Types.AssociateCertificateResponse) => void): Request; + /** + * Permanently cancel a job. Once you have canceled a job, you can't start it again. + */ + cancelJob(params: MediaConvert.Types.CancelJobRequest, callback?: (err: AWSError, data: MediaConvert.Types.CancelJobResponse) => void): Request; + /** + * Permanently cancel a job. Once you have canceled a job, you can't start it again. + */ + cancelJob(callback?: (err: AWSError, data: MediaConvert.Types.CancelJobResponse) => void): Request; + /** + * Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + createJob(params: MediaConvert.Types.CreateJobRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreateJobResponse) => void): Request; + /** + * Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + createJob(callback?: (err: AWSError, data: MediaConvert.Types.CreateJobResponse) => void): Request; + /** + * Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + createJobTemplate(params: MediaConvert.Types.CreateJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreateJobTemplateResponse) => void): Request; + /** + * Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + createJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.CreateJobTemplateResponse) => void): Request; + /** + * Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + createPreset(params: MediaConvert.Types.CreatePresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreatePresetResponse) => void): Request; + /** + * Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + createPreset(callback?: (err: AWSError, data: MediaConvert.Types.CreatePresetResponse) => void): Request; + /** + * Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html + */ + createQueue(params: MediaConvert.Types.CreateQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreateQueueResponse) => void): Request; + /** + * Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html + */ + createQueue(callback?: (err: AWSError, data: MediaConvert.Types.CreateQueueResponse) => void): Request; + /** + * Permanently delete a job template you have created. + */ + deleteJobTemplate(params: MediaConvert.Types.DeleteJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.DeleteJobTemplateResponse) => void): Request; + /** + * Permanently delete a job template you have created. + */ + deleteJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.DeleteJobTemplateResponse) => void): Request; + /** + * Permanently delete a preset you have created. + */ + deletePreset(params: MediaConvert.Types.DeletePresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.DeletePresetResponse) => void): Request; + /** + * Permanently delete a preset you have created. + */ + deletePreset(callback?: (err: AWSError, data: MediaConvert.Types.DeletePresetResponse) => void): Request; + /** + * Permanently delete a queue you have created. + */ + deleteQueue(params: MediaConvert.Types.DeleteQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.DeleteQueueResponse) => void): Request; + /** + * Permanently delete a queue you have created. + */ + deleteQueue(callback?: (err: AWSError, data: MediaConvert.Types.DeleteQueueResponse) => void): Request; + /** + * Send an request with an empty body to the regional API endpoint to get your account API endpoint. + */ + describeEndpoints(params: MediaConvert.Types.DescribeEndpointsRequest, callback?: (err: AWSError, data: MediaConvert.Types.DescribeEndpointsResponse) => void): Request; + /** + * Send an request with an empty body to the regional API endpoint to get your account API endpoint. + */ + describeEndpoints(callback?: (err: AWSError, data: MediaConvert.Types.DescribeEndpointsResponse) => void): Request; + /** + * Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource. + */ + disassociateCertificate(params: MediaConvert.Types.DisassociateCertificateRequest, callback?: (err: AWSError, data: MediaConvert.Types.DisassociateCertificateResponse) => void): Request; + /** + * Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource. + */ + disassociateCertificate(callback?: (err: AWSError, data: MediaConvert.Types.DisassociateCertificateResponse) => void): Request; + /** + * Retrieve the JSON for a specific completed transcoding job. + */ + getJob(params: MediaConvert.Types.GetJobRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetJobResponse) => void): Request; + /** + * Retrieve the JSON for a specific completed transcoding job. + */ + getJob(callback?: (err: AWSError, data: MediaConvert.Types.GetJobResponse) => void): Request; + /** + * Retrieve the JSON for a specific job template. + */ + getJobTemplate(params: MediaConvert.Types.GetJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetJobTemplateResponse) => void): Request; + /** + * Retrieve the JSON for a specific job template. + */ + getJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.GetJobTemplateResponse) => void): Request; + /** + * Retrieve the JSON for a specific preset. + */ + getPreset(params: MediaConvert.Types.GetPresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetPresetResponse) => void): Request; + /** + * Retrieve the JSON for a specific preset. + */ + getPreset(callback?: (err: AWSError, data: MediaConvert.Types.GetPresetResponse) => void): Request; + /** + * Retrieve the JSON for a specific queue. + */ + getQueue(params: MediaConvert.Types.GetQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetQueueResponse) => void): Request; + /** + * Retrieve the JSON for a specific queue. + */ + getQueue(callback?: (err: AWSError, data: MediaConvert.Types.GetQueueResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array + */ + listJobTemplates(params: MediaConvert.Types.ListJobTemplatesRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListJobTemplatesResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array + */ + listJobTemplates(callback?: (err: AWSError, data: MediaConvert.Types.ListJobTemplatesResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array. + */ + listJobs(params: MediaConvert.Types.ListJobsRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListJobsResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array. + */ + listJobs(callback?: (err: AWSError, data: MediaConvert.Types.ListJobsResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array. + */ + listPresets(params: MediaConvert.Types.ListPresetsRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListPresetsResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array. + */ + listPresets(callback?: (err: AWSError, data: MediaConvert.Types.ListPresetsResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array. + */ + listQueues(params: MediaConvert.Types.ListQueuesRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListQueuesResponse) => void): Request; + /** + * Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array. + */ + listQueues(callback?: (err: AWSError, data: MediaConvert.Types.ListQueuesResponse) => void): Request; + /** + * Retrieve the tags for a MediaConvert resource. + */ + listTagsForResource(params: MediaConvert.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListTagsForResourceResponse) => void): Request; + /** + * Retrieve the tags for a MediaConvert resource. + */ + listTagsForResource(callback?: (err: AWSError, data: MediaConvert.Types.ListTagsForResourceResponse) => void): Request; + /** + * Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + */ + tagResource(params: MediaConvert.Types.TagResourceRequest, callback?: (err: AWSError, data: MediaConvert.Types.TagResourceResponse) => void): Request; + /** + * Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + */ + tagResource(callback?: (err: AWSError, data: MediaConvert.Types.TagResourceResponse) => void): Request; + /** + * Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + */ + untagResource(params: MediaConvert.Types.UntagResourceRequest, callback?: (err: AWSError, data: MediaConvert.Types.UntagResourceResponse) => void): Request; + /** + * Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + */ + untagResource(callback?: (err: AWSError, data: MediaConvert.Types.UntagResourceResponse) => void): Request; + /** + * Modify one of your existing job templates. + */ + updateJobTemplate(params: MediaConvert.Types.UpdateJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.UpdateJobTemplateResponse) => void): Request; + /** + * Modify one of your existing job templates. + */ + updateJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.UpdateJobTemplateResponse) => void): Request; + /** + * Modify one of your existing presets. + */ + updatePreset(params: MediaConvert.Types.UpdatePresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.UpdatePresetResponse) => void): Request; + /** + * Modify one of your existing presets. + */ + updatePreset(callback?: (err: AWSError, data: MediaConvert.Types.UpdatePresetResponse) => void): Request; + /** + * Modify one of your existing queues. + */ + updateQueue(params: MediaConvert.Types.UpdateQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.UpdateQueueResponse) => void): Request; + /** + * Modify one of your existing queues. + */ + updateQueue(callback?: (err: AWSError, data: MediaConvert.Types.UpdateQueueResponse) => void): Request; +} +declare namespace MediaConvert { + export type AacAudioDescriptionBroadcasterMix = "BROADCASTER_MIXED_AD"|"NORMAL"|string; + export type AacCodecProfile = "LC"|"HEV1"|"HEV2"|string; + export type AacCodingMode = "AD_RECEIVER_MIX"|"CODING_MODE_1_0"|"CODING_MODE_1_1"|"CODING_MODE_2_0"|"CODING_MODE_5_1"|string; + export type AacRateControlMode = "CBR"|"VBR"|string; + export type AacRawFormat = "LATM_LOAS"|"NONE"|string; + export interface AacSettings { + /** + * Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType. + */ + AudioDescriptionBroadcasterMix?: AacAudioDescriptionBroadcasterMix; + /** + * Average bitrate in bits/second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values you choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile. + */ + Bitrate?: __integerMin6000Max1024000; + /** + * AAC Profile. + */ + CodecProfile?: AacCodecProfile; + /** + * Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. "1.0 - Audio Description (Receiver Mix)" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. + */ + CodingMode?: AacCodingMode; + /** + * Rate Control Mode. + */ + RateControlMode?: AacRateControlMode; + /** + * Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the output container. + */ + RawFormat?: AacRawFormat; + /** + * Sample rate in Hz. Valid values depend on rate control mode and profile. + */ + SampleRate?: __integerMin8000Max96000; + /** + * Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. + */ + Specification?: AacSpecification; + /** + * VBR Quality Level - Only used if rate_control_mode is VBR. + */ + VbrQuality?: AacVbrQuality; + } + export type AacSpecification = "MPEG2"|"MPEG4"|string; + export type AacVbrQuality = "LOW"|"MEDIUM_LOW"|"MEDIUM_HIGH"|"HIGH"|string; + export type Ac3BitstreamMode = "COMPLETE_MAIN"|"COMMENTARY"|"DIALOGUE"|"EMERGENCY"|"HEARING_IMPAIRED"|"MUSIC_AND_EFFECTS"|"VISUALLY_IMPAIRED"|"VOICE_OVER"|string; + export type Ac3CodingMode = "CODING_MODE_1_0"|"CODING_MODE_1_1"|"CODING_MODE_2_0"|"CODING_MODE_3_2_LFE"|string; + export type Ac3DynamicRangeCompressionProfile = "FILM_STANDARD"|"NONE"|string; + export type Ac3LfeFilter = "ENABLED"|"DISABLED"|string; + export type Ac3MetadataControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export interface Ac3Settings { + /** + * Average bitrate in bits/second. Valid bitrates depend on the coding mode. + */ + Bitrate?: __integerMin64000Max640000; + /** + * Specifies the "Bitstream Mode" (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. + */ + BitstreamMode?: Ac3BitstreamMode; + /** + * Dolby Digital coding mode. Determines number of channels. + */ + CodingMode?: Ac3CodingMode; + /** + * Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through. + */ + Dialnorm?: __integerMin1Max31; + /** + * If set to FILM_STANDARD, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. + */ + DynamicRangeCompressionProfile?: Ac3DynamicRangeCompressionProfile; + /** + * Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode. + */ + LfeFilter?: Ac3LfeFilter; + /** + * When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. + */ + MetadataControl?: Ac3MetadataControl; + /** + * Sample rate in hz. Sample rate is always 48000. + */ + SampleRate?: __integerMin48000Max48000; + } + export type AccelerationMode = "DISABLED"|"ENABLED"|string; + export interface AccelerationSettings { + /** + * Acceleration configuration for the job. + */ + Mode: AccelerationMode; + } + export type AfdSignaling = "NONE"|"AUTO"|"FIXED"|string; + export interface AiffSettings { + /** + * Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track. + */ + BitDepth?: __integerMin16Max24; + /** + * Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2. + */ + Channels?: __integerMin1Max2; + /** + * Sample rate in hz. + */ + SampleRate?: __integerMin8000Max192000; + } + export interface AncillarySourceSettings { + /** + * Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough. + */ + SourceAncillaryChannelNumber?: __integerMin1Max4; + } + export type AntiAlias = "DISABLED"|"ENABLED"|string; + export interface AssociateCertificateRequest { + /** + * The ARN of the ACM certificate that you want to associate with your MediaConvert resource. + */ + Arn: __string; + } + export interface AssociateCertificateResponse { + } + export type AudioCodec = "AAC"|"MP2"|"WAV"|"AIFF"|"AC3"|"EAC3"|"PASSTHROUGH"|string; + export interface AudioCodecSettings { + /** + * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode. + */ + AacSettings?: AacSettings; + /** + * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3. + */ + Ac3Settings?: Ac3Settings; + /** + * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF. + */ + AiffSettings?: AiffSettings; + /** + * Type of Audio codec. + */ + Codec?: AudioCodec; + /** + * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3. + */ + Eac3Settings?: Eac3Settings; + /** + * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2. + */ + Mp2Settings?: Mp2Settings; + /** + * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV. + */ + WavSettings?: WavSettings; + } + export type AudioDefaultSelection = "DEFAULT"|"NOT_DEFAULT"|string; + export interface AudioDescription { + /** + * Advanced audio normalization settings. + */ + AudioNormalizationSettings?: AudioNormalizationSettings; + /** + * Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically. + */ + AudioSourceName?: __string; + /** + * Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved. + */ + AudioType?: __integerMin0Max255; + /** + * When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD. + */ + AudioTypeControl?: AudioTypeControl; + /** + * Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings + */ + CodecSettings?: AudioCodecSettings; + /** + * Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input. + */ + CustomLanguageCode?: __stringMin3Max3PatternAZaZ3; + /** + * Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input. + */ + LanguageCode?: LanguageCode; + /** + * Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT is selected but there is no ISO 639 language code specified by the input. + */ + LanguageCodeControl?: AudioLanguageCodeControl; + /** + * Advanced audio remixing settings. + */ + RemixSettings?: RemixSettings; + /** + * Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal. + */ + StreamName?: __stringPatternWS; + } + export type AudioLanguageCodeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export type AudioNormalizationAlgorithm = "ITU_BS_1770_1"|"ITU_BS_1770_2"|string; + export type AudioNormalizationAlgorithmControl = "CORRECT_AUDIO"|"MEASURE_ONLY"|string; + export type AudioNormalizationLoudnessLogging = "LOG"|"DONT_LOG"|string; + export type AudioNormalizationPeakCalculation = "TRUE_PEAK"|"NONE"|string; + export interface AudioNormalizationSettings { + /** + * Audio normalization algorithm to use. 1770-1 conforms to the CALM Act specification, 1770-2 conforms to the EBU R-128 specification. + */ + Algorithm?: AudioNormalizationAlgorithm; + /** + * When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted. + */ + AlgorithmControl?: AudioNormalizationAlgorithmControl; + /** + * Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. Gating only applies when not using real_time_correction. + */ + CorrectionGateLevel?: __integerMinNegative70Max0; + /** + * If set to LOG, log each output's audio track loudness to a CSV file. + */ + LoudnessLogging?: AudioNormalizationLoudnessLogging; + /** + * If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness. + */ + PeakCalculation?: AudioNormalizationPeakCalculation; + /** + * Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS. + */ + TargetLkfs?: __doubleMinNegative59Max0; + } + export interface AudioSelector { + /** + * Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code + */ + CustomLanguageCode?: __stringMin3Max3PatternAZaZ3; + /** + * Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio. + */ + DefaultSelection?: AudioDefaultSelection; + /** + * Specifies audio data from an external file source. + */ + ExternalAudioFileInput?: __stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE; + /** + * Selects a specific language code from within an audio source. + */ + LanguageCode?: LanguageCode; + /** + * Specifies a time delta in milliseconds to offset the audio from the input video. + */ + Offset?: __integerMinNegative2147483648Max2147483647; + /** + * Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101). + */ + Pids?: __listOf__integerMin1Max2147483647; + /** + * Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track. + */ + ProgramSelection?: __integerMin0Max8; + /** + * Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other. + */ + RemixSettings?: RemixSettings; + /** + * Specifies the type of the audio selector. + */ + SelectorType?: AudioSelectorType; + /** + * Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, "tracks": [1,2,3]. + */ + Tracks?: __listOf__integerMin1Max2147483647; + } + export interface AudioSelectorGroup { + /** + * Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g., "Audio Selector 1"). The audio selector name parameter can be repeated to add any number of audio selectors to the group. + */ + AudioSelectorNames?: __listOf__stringMin1; + } + export type AudioSelectorType = "PID"|"TRACK"|"LANGUAGE_CODE"|string; + export type AudioTypeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export interface AvailBlanking { + /** + * Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. + */ + AvailBlankingImage?: __stringMin14PatternS3BmpBMPPngPNG; + } + export type BillingTagsSource = "QUEUE"|"PRESET"|"JOB_TEMPLATE"|string; + export interface BurninDestinationSettings { + /** + * If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + Alignment?: BurninSubtitleAlignment; + /** + * Specifies the color of the rectangle behind the captions. +All burn-in and DVB-Sub font settings must match. + */ + BackgroundColor?: BurninSubtitleBackgroundColor; + /** + * Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + BackgroundOpacity?: __integerMin0Max255; + /** + * Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + FontColor?: BurninSubtitleFontColor; + /** + * Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. +All burn-in and DVB-Sub font settings must match. + */ + FontOpacity?: __integerMin0Max255; + /** + * Font resolution in DPI (dots per inch); default is 96 dpi. +All burn-in and DVB-Sub font settings must match. + */ + FontResolution?: __integerMin96Max600; + /** + * Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions. + */ + FontScript?: FontScript; + /** + * A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match. + */ + FontSize?: __integerMin0Max96; + /** + * Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineColor?: BurninSubtitleOutlineColor; + /** + * Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineSize?: __integerMin0Max10; + /** + * Specifies the color of the shadow cast by the captions. +All burn-in and DVB-Sub font settings must match. + */ + ShadowColor?: BurninSubtitleShadowColor; + /** + * Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + ShadowOpacity?: __integerMin0Max255; + /** + * Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. + */ + ShadowXOffset?: __integerMinNegative2147483648Max2147483647; + /** + * Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. + */ + ShadowYOffset?: __integerMinNegative2147483648Max2147483647; + /** + * Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption. + */ + TeletextSpacing?: BurninSubtitleTeletextSpacing; + /** + * Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + XPosition?: __integerMin0Max2147483647; + /** + * Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + YPosition?: __integerMin0Max2147483647; + } + export type BurninSubtitleAlignment = "CENTERED"|"LEFT"|string; + export type BurninSubtitleBackgroundColor = "NONE"|"BLACK"|"WHITE"|string; + export type BurninSubtitleFontColor = "WHITE"|"BLACK"|"YELLOW"|"RED"|"GREEN"|"BLUE"|string; + export type BurninSubtitleOutlineColor = "BLACK"|"WHITE"|"YELLOW"|"RED"|"GREEN"|"BLUE"|string; + export type BurninSubtitleShadowColor = "NONE"|"BLACK"|"WHITE"|string; + export type BurninSubtitleTeletextSpacing = "FIXED_GRID"|"PROPORTIONAL"|string; + export interface CancelJobRequest { + /** + * The Job ID of the job to be cancelled. + */ + Id: __string; + } + export interface CancelJobResponse { + } + export interface CaptionDescription { + /** + * Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input. + */ + CaptionSelectorName?: __stringMin1; + /** + * Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text. + */ + CustomLanguageCode?: __stringMin3Max3PatternAZaZ3; + /** + * Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext. + */ + DestinationSettings?: CaptionDestinationSettings; + /** + * Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text. + */ + LanguageCode?: LanguageCode; + /** + * Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal. + */ + LanguageDescription?: __string; + } + export interface CaptionDescriptionPreset { + /** + * Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text. + */ + CustomLanguageCode?: __stringMin3Max3PatternAZaZ3; + /** + * Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext. + */ + DestinationSettings?: CaptionDestinationSettings; + /** + * Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text. + */ + LanguageCode?: LanguageCode; + /** + * Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal. + */ + LanguageDescription?: __string; + } + export interface CaptionDestinationSettings { + /** + * Burn-In Destination Settings. + */ + BurninDestinationSettings?: BurninDestinationSettings; + /** + * Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20). + */ + DestinationType?: CaptionDestinationType; + /** + * DVB-Sub Destination Settings + */ + DvbSubDestinationSettings?: DvbSubDestinationSettings; + /** + * Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number. + */ + EmbeddedDestinationSettings?: EmbeddedDestinationSettings; + /** + * Settings for SCC caption output. + */ + SccDestinationSettings?: SccDestinationSettings; + /** + * Settings for Teletext caption output + */ + TeletextDestinationSettings?: TeletextDestinationSettings; + /** + * Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough). + */ + TtmlDestinationSettings?: TtmlDestinationSettings; + } + export type CaptionDestinationType = "BURN_IN"|"DVB_SUB"|"EMBEDDED"|"EMBEDDED_PLUS_SCTE20"|"SCTE20_PLUS_EMBEDDED"|"SCC"|"SRT"|"SMI"|"TELETEXT"|"TTML"|"WEBVTT"|string; + export interface CaptionSelector { + /** + * The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions. + */ + CustomLanguageCode?: __stringMin3Max3PatternAZaZ3; + /** + * The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions. + */ + LanguageCode?: LanguageCode; + /** + * Source settings (SourceSettings) contains the group of settings for captions in the input. + */ + SourceSettings?: CaptionSourceSettings; + } + export interface CaptionSourceSettings { + /** + * Settings for ancillary captions source. + */ + AncillarySourceSettings?: AncillarySourceSettings; + /** + * DVB Sub Source Settings + */ + DvbSubSourceSettings?: DvbSubSourceSettings; + /** + * Settings for embedded captions Source + */ + EmbeddedSourceSettings?: EmbeddedSourceSettings; + /** + * Settings for File-based Captions in Source + */ + FileSourceSettings?: FileSourceSettings; + /** + * Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format. + */ + SourceType?: CaptionSourceType; + /** + * Settings specific to Teletext caption sources, including Page number. + */ + TeletextSourceSettings?: TeletextSourceSettings; + /** + * Settings specific to caption sources that are specfied by track number. Sources include IMSC in IMF. + */ + TrackSourceSettings?: TrackSourceSettings; + } + export type CaptionSourceType = "ANCILLARY"|"DVB_SUB"|"EMBEDDED"|"SCTE20"|"SCC"|"TTML"|"STL"|"SRT"|"SMI"|"TELETEXT"|"NULL_SOURCE"|"IMSC"|string; + export interface ChannelMapping { + /** + * List of output channels + */ + OutputChannels?: __listOfOutputChannelMapping; + } + export type CmafClientCache = "DISABLED"|"ENABLED"|string; + export type CmafCodecSpecification = "RFC_6381"|"RFC_4281"|string; + export interface CmafEncryptionSettings { + /** + * This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default. + */ + ConstantInitializationVector?: __stringMin32Max32Pattern09aFAF32; + /** + * Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption. + */ + EncryptionMethod?: CmafEncryptionType; + /** + * The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest. + */ + InitializationVectorInManifest?: CmafInitializationVectorInManifest; + /** + * Use these settings to set up encryption with a static key provider. + */ + StaticKeyProvider?: StaticKeyProvider; + /** + * Indicates which type of key provider is used for encryption. + */ + Type?: CmafKeyProviderType; + } + export type CmafEncryptionType = "SAMPLE_AES"|string; + export interface CmafGroupSettings { + /** + * A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file. + */ + BaseUrl?: __string; + /** + * When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay. + */ + ClientCache?: CmafClientCache; + /** + * Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. + */ + CodecSpecification?: CmafCodecSpecification; + /** + * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. + */ + Destination?: __stringPatternS3; + /** + * Settings associated with the destination. Will vary based on the type of destination + */ + DestinationSettings?: DestinationSettings; + /** + * DRM settings. + */ + Encryption?: CmafEncryptionSettings; + /** + * Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types. + */ + FragmentLength?: __integerMin1Max2147483647; + /** + * When set to GZIP, compresses HLS playlist. + */ + ManifestCompression?: CmafManifestCompression; + /** + * Indicates whether the output manifest should use floating point values for segment duration. + */ + ManifestDurationFormat?: CmafManifestDurationFormat; + /** + * Minimum time of initially buffered media that is needed to ensure smooth playout. + */ + MinBufferTime?: __integerMin0Max2147483647; + /** + * Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. + */ + MinFinalSegmentLength?: __doubleMin0Max2147483647; + /** + * When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. + */ + SegmentControl?: CmafSegmentControl; + /** + * Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment. + */ + SegmentLength?: __integerMin1Max2147483647; + /** + * Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. + */ + StreamInfResolution?: CmafStreamInfResolution; + /** + * When set to ENABLED, a DASH MPD manifest will be generated for this output. + */ + WriteDashManifest?: CmafWriteDASHManifest; + /** + * When set to ENABLED, an Apple HLS manifest will be generated for this output. + */ + WriteHlsManifest?: CmafWriteHLSManifest; + } + export type CmafInitializationVectorInManifest = "INCLUDE"|"EXCLUDE"|string; + export type CmafKeyProviderType = "STATIC_KEY"|string; + export type CmafManifestCompression = "GZIP"|"NONE"|string; + export type CmafManifestDurationFormat = "FLOATING_POINT"|"INTEGER"|string; + export type CmafSegmentControl = "SINGLE_FILE"|"SEGMENTED_FILES"|string; + export type CmafStreamInfResolution = "INCLUDE"|"EXCLUDE"|string; + export type CmafWriteDASHManifest = "DISABLED"|"ENABLED"|string; + export type CmafWriteHLSManifest = "DISABLED"|"ENABLED"|string; + export interface ColorCorrector { + /** + * Brightness level. + */ + Brightness?: __integerMin1Max100; + /** + * Determines if colorspace conversion will be performed. If set to _None_, no conversion will be performed. If _Force 601_ or _Force 709_ are selected, conversion will be performed for inputs with differing colorspaces. An input's colorspace can be specified explicitly in the "Video Selector":#inputs-video_selector if necessary. + */ + ColorSpaceConversion?: ColorSpaceConversion; + /** + * Contrast level. + */ + Contrast?: __integerMin1Max100; + /** + * Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. Note that these settings are not color correction. + */ + Hdr10Metadata?: Hdr10Metadata; + /** + * Hue in degrees. + */ + Hue?: __integerMinNegative180Max180; + /** + * Saturation level. + */ + Saturation?: __integerMin1Max100; + } + export type ColorMetadata = "IGNORE"|"INSERT"|string; + export type ColorSpace = "FOLLOW"|"REC_601"|"REC_709"|"HDR10"|"HLG_2020"|string; + export type ColorSpaceConversion = "NONE"|"FORCE_601"|"FORCE_709"|"FORCE_HDR10"|"FORCE_HLG_2020"|string; + export type ColorSpaceUsage = "FORCE"|"FALLBACK"|string; + export type Commitment = "ONE_YEAR"|string; + export interface ContainerSettings { + /** + * Container for this output. Some containers require a container settings object. If not specified, the default object will be created. + */ + Container?: ContainerType; + /** + * Settings for F4v container + */ + F4vSettings?: F4vSettings; + /** + * MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset. + */ + M2tsSettings?: M2tsSettings; + /** + * Settings for TS segments in HLS + */ + M3u8Settings?: M3u8Settings; + /** + * Settings for MOV Container. + */ + MovSettings?: MovSettings; + /** + * Settings for MP4 Container + */ + Mp4Settings?: Mp4Settings; + } + export type ContainerType = "F4V"|"ISMV"|"M2TS"|"M3U8"|"CMFC"|"MOV"|"MP4"|"MPD"|"MXF"|"RAW"|string; + export interface CreateJobRequest { + /** + * Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. + */ + AccelerationSettings?: AccelerationSettings; + /** + * Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted. + */ + BillingTagsSource?: BillingTagsSource; + /** + * Idempotency token for CreateJob operation. + */ + ClientRequestToken?: __string; + /** + * When you create a job, you can either specify a job template or specify the transcoding settings individually + */ + JobTemplate?: __string; + /** + * Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html. + */ + Queue?: __string; + /** + * Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. + */ + Role: __string; + /** + * JobSettings contains all the transcode settings for a job. + */ + Settings: JobSettings; + /** + * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. + */ + StatusUpdateInterval?: StatusUpdateInterval; + /** + * User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. + */ + UserMetadata?: __mapOf__string; + } + export interface CreateJobResponse { + /** + * Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + Job?: Job; + } + export interface CreateJobTemplateRequest { + /** + * Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. + */ + AccelerationSettings?: AccelerationSettings; + /** + * Optional. A category for the job template you are creating + */ + Category?: __string; + /** + * Optional. A description of the job template you are creating. + */ + Description?: __string; + /** + * The name of the job template you are creating. + */ + Name: __string; + /** + * Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue. + */ + Queue?: __string; + /** + * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it. + */ + Settings: JobTemplateSettings; + /** + * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. + */ + StatusUpdateInterval?: StatusUpdateInterval; + /** + * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. + */ + Tags?: __mapOf__string; + } + export interface CreateJobTemplateResponse { + /** + * A job template is a pre-made set of encoding instructions that you can use to quickly create a job. + */ + JobTemplate?: JobTemplate; + } + export interface CreatePresetRequest { + /** + * Optional. A category for the preset you are creating. + */ + Category?: __string; + /** + * Optional. A description of the preset you are creating. + */ + Description?: __string; + /** + * The name of the preset you are creating. + */ + Name: __string; + /** + * Settings for preset + */ + Settings: PresetSettings; + /** + * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. + */ + Tags?: __mapOf__string; + } + export interface CreatePresetResponse { + /** + * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process. + */ + Preset?: Preset; + } + export interface CreateQueueRequest { + /** + * Optional. A description of the queue that you are creating. + */ + Description?: __string; + /** + * The name of the queue that you are creating. + */ + Name: __string; + /** + * Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand. + */ + PricingPlan?: PricingPlan; + /** + * Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues. + */ + ReservationPlanSettings?: ReservationPlanSettings; + /** + * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. + */ + Tags?: __mapOf__string; + } + export interface CreateQueueResponse { + /** + * You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html. + */ + Queue?: Queue; + } + export interface DashIsoEncryptionSettings { + /** + * This setting can improve the compatibility of your output with video players on obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI (UNENCRYPTED_SEI) only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1 (CENC_V1). If you choose Unencrypted SEI, for that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted. + */ + PlaybackDeviceCompatibility?: DashIsoPlaybackDeviceCompatibility; + /** + * Settings for use with a SPEKE key provider + */ + SpekeKeyProvider?: SpekeKeyProvider; + } + export interface DashIsoGroupSettings { + /** + * A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file. + */ + BaseUrl?: __string; + /** + * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. + */ + Destination?: __stringPatternS3; + /** + * Settings associated with the destination. Will vary based on the type of destination + */ + DestinationSettings?: DestinationSettings; + /** + * DRM settings. + */ + Encryption?: DashIsoEncryptionSettings; + /** + * Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types. + */ + FragmentLength?: __integerMin1Max2147483647; + /** + * Supports HbbTV specification as indicated + */ + HbbtvCompliance?: DashIsoHbbtvCompliance; + /** + * Minimum time of initially buffered media that is needed to ensure smooth playout. + */ + MinBufferTime?: __integerMin0Max2147483647; + /** + * When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. + */ + SegmentControl?: DashIsoSegmentControl; + /** + * Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types. + */ + SegmentLength?: __integerMin1Max2147483647; + /** + * When you enable Precise segment duration in manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element. + */ + WriteSegmentTimelineInRepresentation?: DashIsoWriteSegmentTimelineInRepresentation; + } + export type DashIsoHbbtvCompliance = "HBBTV_1_5"|"NONE"|string; + export type DashIsoPlaybackDeviceCompatibility = "CENC_V1"|"UNENCRYPTED_SEI"|string; + export type DashIsoSegmentControl = "SINGLE_FILE"|"SEGMENTED_FILES"|string; + export type DashIsoWriteSegmentTimelineInRepresentation = "ENABLED"|"DISABLED"|string; + export type DecryptionMode = "AES_CTR"|"AES_CBC"|"AES_GCM"|string; + export type DeinterlaceAlgorithm = "INTERPOLATE"|"INTERPOLATE_TICKER"|"BLEND"|"BLEND_TICKER"|string; + export interface Deinterlacer { + /** + * Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) produces sharper pictures, while blend (BLEND) produces smoother motion. Use (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, such as a scrolling headline at the bottom of the frame. + */ + Algorithm?: DeinterlaceAlgorithm; + /** + * - When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video. + */ + Control?: DeinterlacerControl; + /** + * Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive. + */ + Mode?: DeinterlacerMode; + } + export type DeinterlacerControl = "FORCE_ALL_FRAMES"|"NORMAL"|string; + export type DeinterlacerMode = "DEINTERLACE"|"INVERSE_TELECINE"|"ADAPTIVE"|string; + export interface DeleteJobTemplateRequest { + /** + * The name of the job template to be deleted. + */ + Name: __string; + } + export interface DeleteJobTemplateResponse { + } + export interface DeletePresetRequest { + /** + * The name of the preset to be deleted. + */ + Name: __string; + } + export interface DeletePresetResponse { + } + export interface DeleteQueueRequest { + /** + * The name of the queue that you want to delete. + */ + Name: __string; + } + export interface DeleteQueueResponse { + } + export type DescribeEndpointsMode = "DEFAULT"|"GET_ONLY"|string; + export interface DescribeEndpointsRequest { + /** + * Optional. Max number of endpoints, up to twenty, that will be returned at one time. + */ + MaxResults?: __integer; + /** + * Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist. + */ + Mode?: DescribeEndpointsMode; + /** + * Use this string, provided with the response to a previous request, to request the next batch of endpoints. + */ + NextToken?: __string; + } + export interface DescribeEndpointsResponse { + /** + * List of endpoints + */ + Endpoints?: __listOfEndpoint; + /** + * Use this string to request the next batch of endpoints. + */ + NextToken?: __string; + } + export interface DestinationSettings { + /** + * Settings associated with S3 destination + */ + S3Settings?: S3DestinationSettings; + } + export interface DisassociateCertificateRequest { + /** + * The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource. + */ + Arn: __string; + } + export interface DisassociateCertificateResponse { + } + export type DropFrameTimecode = "DISABLED"|"ENABLED"|string; + export interface DvbNitSettings { + /** + * The numeric value placed in the Network Information Table (NIT). + */ + NetworkId?: __integerMin0Max65535; + /** + * The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is 256 characters. + */ + NetworkName?: __stringMin1Max256; + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + NitInterval?: __integerMin25Max10000; + } + export interface DvbSdtSettings { + /** + * Selects method of inserting SDT information into output stream. "Follow input SDT" copies SDT information from input stream to output stream. "Follow input SDT if present" copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter "SDT Manually" means user will enter the SDT information. "No SDT" means output stream will not contain SDT information. + */ + OutputSdt?: OutputSdt; + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + SdtInterval?: __integerMin25Max2000; + /** + * The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters. + */ + ServiceName?: __stringMin1Max256; + /** + * The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters. + */ + ServiceProviderName?: __stringMin1Max256; + } + export interface DvbSubDestinationSettings { + /** + * If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + Alignment?: DvbSubtitleAlignment; + /** + * Specifies the color of the rectangle behind the captions. +All burn-in and DVB-Sub font settings must match. + */ + BackgroundColor?: DvbSubtitleBackgroundColor; + /** + * Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + BackgroundOpacity?: __integerMin0Max255; + /** + * Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + FontColor?: DvbSubtitleFontColor; + /** + * Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. +All burn-in and DVB-Sub font settings must match. + */ + FontOpacity?: __integerMin0Max255; + /** + * Font resolution in DPI (dots per inch); default is 96 dpi. +All burn-in and DVB-Sub font settings must match. + */ + FontResolution?: __integerMin96Max600; + /** + * Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions. + */ + FontScript?: FontScript; + /** + * A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match. + */ + FontSize?: __integerMin0Max96; + /** + * Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineColor?: DvbSubtitleOutlineColor; + /** + * Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineSize?: __integerMin0Max10; + /** + * Specifies the color of the shadow cast by the captions. +All burn-in and DVB-Sub font settings must match. + */ + ShadowColor?: DvbSubtitleShadowColor; + /** + * Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + ShadowOpacity?: __integerMin0Max255; + /** + * Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. + */ + ShadowXOffset?: __integerMinNegative2147483648Max2147483647; + /** + * Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. + */ + ShadowYOffset?: __integerMinNegative2147483648Max2147483647; + /** + * Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption. + */ + TeletextSpacing?: DvbSubtitleTeletextSpacing; + /** + * Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + XPosition?: __integerMin0Max2147483647; + /** + * Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + YPosition?: __integerMin0Max2147483647; + } + export interface DvbSubSourceSettings { + /** + * When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. + */ + Pid?: __integerMin1Max2147483647; + } + export type DvbSubtitleAlignment = "CENTERED"|"LEFT"|string; + export type DvbSubtitleBackgroundColor = "NONE"|"BLACK"|"WHITE"|string; + export type DvbSubtitleFontColor = "WHITE"|"BLACK"|"YELLOW"|"RED"|"GREEN"|"BLUE"|string; + export type DvbSubtitleOutlineColor = "BLACK"|"WHITE"|"YELLOW"|"RED"|"GREEN"|"BLUE"|string; + export type DvbSubtitleShadowColor = "NONE"|"BLACK"|"WHITE"|string; + export type DvbSubtitleTeletextSpacing = "FIXED_GRID"|"PROPORTIONAL"|string; + export interface DvbTdtSettings { + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + TdtInterval?: __integerMin1000Max30000; + } + export type Eac3AttenuationControl = "ATTENUATE_3_DB"|"NONE"|string; + export type Eac3BitstreamMode = "COMPLETE_MAIN"|"COMMENTARY"|"EMERGENCY"|"HEARING_IMPAIRED"|"VISUALLY_IMPAIRED"|string; + export type Eac3CodingMode = "CODING_MODE_1_0"|"CODING_MODE_2_0"|"CODING_MODE_3_2"|string; + export type Eac3DcFilter = "ENABLED"|"DISABLED"|string; + export type Eac3DynamicRangeCompressionLine = "NONE"|"FILM_STANDARD"|"FILM_LIGHT"|"MUSIC_STANDARD"|"MUSIC_LIGHT"|"SPEECH"|string; + export type Eac3DynamicRangeCompressionRf = "NONE"|"FILM_STANDARD"|"FILM_LIGHT"|"MUSIC_STANDARD"|"MUSIC_LIGHT"|"SPEECH"|string; + export type Eac3LfeControl = "LFE"|"NO_LFE"|string; + export type Eac3LfeFilter = "ENABLED"|"DISABLED"|string; + export type Eac3MetadataControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export type Eac3PassthroughControl = "WHEN_POSSIBLE"|"NO_PASSTHROUGH"|string; + export type Eac3PhaseControl = "SHIFT_90_DEGREES"|"NO_SHIFT"|string; + export interface Eac3Settings { + /** + * If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. + */ + AttenuationControl?: Eac3AttenuationControl; + /** + * Average bitrate in bits/second. Valid bitrates depend on the coding mode. + */ + Bitrate?: __integerMin64000Max640000; + /** + * Specifies the "Bitstream Mode" (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. + */ + BitstreamMode?: Eac3BitstreamMode; + /** + * Dolby Digital Plus coding mode. Determines number of channels. + */ + CodingMode?: Eac3CodingMode; + /** + * Activates a DC highpass filter for all input channels. + */ + DcFilter?: Eac3DcFilter; + /** + * Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. + */ + Dialnorm?: __integerMin1Max31; + /** + * Enables Dynamic Range Compression that restricts the absolute peak level for a signal. + */ + DynamicRangeCompressionLine?: Eac3DynamicRangeCompressionLine; + /** + * Enables Heavy Dynamic Range Compression, ensures that the instantaneous signal peaks do not exceed specified levels. + */ + DynamicRangeCompressionRf?: Eac3DynamicRangeCompressionRf; + /** + * When encoding 3/2 audio, controls whether the LFE channel is enabled + */ + LfeControl?: Eac3LfeControl; + /** + * Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode. + */ + LfeFilter?: Eac3LfeFilter; + /** + * Left only/Right only center mix level. Only used for 3/2 coding mode. +Valid values: 3.0, 1.5, 0.0, -1.5 -3.0 -4.5 -6.0 -60 + */ + LoRoCenterMixLevel?: __doubleMinNegative60Max3; + /** + * Left only/Right only surround mix level. Only used for 3/2 coding mode. +Valid values: -1.5 -3.0 -4.5 -6.0 -60 + */ + LoRoSurroundMixLevel?: __doubleMinNegative60MaxNegative1; + /** + * Left total/Right total center mix level. Only used for 3/2 coding mode. +Valid values: 3.0, 1.5, 0.0, -1.5 -3.0 -4.5 -6.0 -60 + */ + LtRtCenterMixLevel?: __doubleMinNegative60Max3; + /** + * Left total/Right total surround mix level. Only used for 3/2 coding mode. +Valid values: -1.5 -3.0 -4.5 -6.0 -60 + */ + LtRtSurroundMixLevel?: __doubleMinNegative60MaxNegative1; + /** + * When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. + */ + MetadataControl?: Eac3MetadataControl; + /** + * When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. + */ + PassthroughControl?: Eac3PassthroughControl; + /** + * Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode. + */ + PhaseControl?: Eac3PhaseControl; + /** + * Sample rate in hz. Sample rate is always 48000. + */ + SampleRate?: __integerMin48000Max48000; + /** + * Stereo downmix preference. Only used for 3/2 coding mode. + */ + StereoDownmix?: Eac3StereoDownmix; + /** + * When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. + */ + SurroundExMode?: Eac3SurroundExMode; + /** + * When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. + */ + SurroundMode?: Eac3SurroundMode; + } + export type Eac3StereoDownmix = "NOT_INDICATED"|"LO_RO"|"LT_RT"|"DPL2"|string; + export type Eac3SurroundExMode = "NOT_INDICATED"|"ENABLED"|"DISABLED"|string; + export type Eac3SurroundMode = "NOT_INDICATED"|"ENABLED"|"DISABLED"|string; + export type EmbeddedConvert608To708 = "UPCONVERT"|"DISABLED"|string; + export interface EmbeddedDestinationSettings { + /** + * Ignore this setting unless your input captions are SCC format and your output container is MXF. With this combination of input captions format and output container, you can optionally use this setting to replace the input channel number with the track number that you specify. Specify a different number for each output captions track. If you don't specify an output track number, the system uses the input channel number for the output channel number. This setting applies to each output individually. You can optionally combine two captions channels in your output. The two output channel numbers can be one of the following pairs: 1,3; 2,4; 1,4; or 2,3. + */ + Destination608ChannelNumber?: __integerMin1Max4; + } + export interface EmbeddedSourceSettings { + /** + * When set to UPCONVERT, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. + */ + Convert608To708?: EmbeddedConvert608To708; + /** + * Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. + */ + Source608ChannelNumber?: __integerMin1Max4; + /** + * Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'. + */ + Source608TrackNumber?: __integerMin1Max1; + } + export interface Endpoint { + /** + * URL of endpoint + */ + Url?: __string; + } + export interface EsamManifestConfirmConditionNotification { + /** + * Provide your ESAM ManifestConfirmConditionNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the Manifest Conditioning instructions in the message that you supply. + */ + MccXml?: __stringPatternSNManifestConfirmConditionNotificationNS; + } + export interface EsamSettings { + /** + * Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning instructions that you provide in the setting MCC XML (mccXml). + */ + ManifestConfirmConditionNotification?: EsamManifestConfirmConditionNotification; + /** + * Specifies the stream distance, in milliseconds, between the SCTE 35 messages that the transcoder places and the splice points that they refer to. If the time between the start of the asset and the SCTE-35 message is less than this value, then the transcoder places the SCTE-35 marker at the beginning of the stream. + */ + ResponseSignalPreroll?: __integerMin0Max30000; + /** + * Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing instructions that you provide in the setting SCC XML (sccXml). + */ + SignalProcessingNotification?: EsamSignalProcessingNotification; + } + export interface EsamSignalProcessingNotification { + /** + * Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the signal processing instructions in the message that you supply. Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. If you want the service to place SCTE-35 markers at the insertion points you specify in the XML document, you must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify an ESAM XML document or enable SCTE-35 passthrough. You can't do both. + */ + SccXml?: __stringPatternSNSignalProcessingNotificationNS; + } + export type F4vMoovPlacement = "PROGRESSIVE_DOWNLOAD"|"NORMAL"|string; + export interface F4vSettings { + /** + * If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end. + */ + MoovPlacement?: F4vMoovPlacement; + } + export interface FileGroupSettings { + /** + * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. + */ + Destination?: __stringPatternS3; + /** + * Settings associated with the destination. Will vary based on the type of destination + */ + DestinationSettings?: DestinationSettings; + } + export type FileSourceConvert608To708 = "UPCONVERT"|"DISABLED"|string; + export interface FileSourceSettings { + /** + * If set to UPCONVERT, 608 caption data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. + */ + Convert608To708?: FileSourceConvert608To708; + /** + * External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', and 'smi'. + */ + SourceFile?: __stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTSmiSMI; + /** + * Specifies a time delta in seconds to offset the captions from the source file. + */ + TimeDelta?: __integerMinNegative2147483648Max2147483647; + } + export type FontScript = "AUTOMATIC"|"HANS"|"HANT"|string; + export interface FrameCaptureSettings { + /** + * Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture. + */ + FramerateDenominator?: __integerMin1Max2147483647; + /** + * Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places. + */ + FramerateNumerator?: __integerMin1Max2147483647; + /** + * Maximum number of captures (encoded jpg output files). + */ + MaxCaptures?: __integerMin1Max10000000; + /** + * JPEG Quality - a higher value equals higher quality. + */ + Quality?: __integerMin1Max100; + } + export interface GetJobRequest { + /** + * the job ID of the job. + */ + Id: __string; + } + export interface GetJobResponse { + /** + * Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + Job?: Job; + } + export interface GetJobTemplateRequest { + /** + * The name of the job template. + */ + Name: __string; + } + export interface GetJobTemplateResponse { + /** + * A job template is a pre-made set of encoding instructions that you can use to quickly create a job. + */ + JobTemplate?: JobTemplate; + } + export interface GetPresetRequest { + /** + * The name of the preset. + */ + Name: __string; + } + export interface GetPresetResponse { + /** + * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process. + */ + Preset?: Preset; + } + export interface GetQueueRequest { + /** + * The name of the queue that you want information about. + */ + Name: __string; + } + export interface GetQueueResponse { + /** + * You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html. + */ + Queue?: Queue; + } + export type H264AdaptiveQuantization = "OFF"|"LOW"|"MEDIUM"|"HIGH"|"HIGHER"|"MAX"|string; + export type H264CodecLevel = "AUTO"|"LEVEL_1"|"LEVEL_1_1"|"LEVEL_1_2"|"LEVEL_1_3"|"LEVEL_2"|"LEVEL_2_1"|"LEVEL_2_2"|"LEVEL_3"|"LEVEL_3_1"|"LEVEL_3_2"|"LEVEL_4"|"LEVEL_4_1"|"LEVEL_4_2"|"LEVEL_5"|"LEVEL_5_1"|"LEVEL_5_2"|string; + export type H264CodecProfile = "BASELINE"|"HIGH"|"HIGH_10BIT"|"HIGH_422"|"HIGH_422_10BIT"|"MAIN"|string; + export type H264DynamicSubGop = "ADAPTIVE"|"STATIC"|string; + export type H264EntropyEncoding = "CABAC"|"CAVLC"|string; + export type H264FieldEncoding = "PAFF"|"FORCE_FIELD"|string; + export type H264FlickerAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type H264FramerateControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type H264FramerateConversionAlgorithm = "DUPLICATE_DROP"|"INTERPOLATE"|string; + export type H264GopBReference = "DISABLED"|"ENABLED"|string; + export type H264GopSizeUnits = "FRAMES"|"SECONDS"|string; + export type H264InterlaceMode = "PROGRESSIVE"|"TOP_FIELD"|"BOTTOM_FIELD"|"FOLLOW_TOP_FIELD"|"FOLLOW_BOTTOM_FIELD"|string; + export type H264ParControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type H264QualityTuningLevel = "SINGLE_PASS"|"SINGLE_PASS_HQ"|"MULTI_PASS_HQ"|string; + export interface H264QvbrSettings { + /** + * Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output. + */ + MaxAverageBitrate?: __integerMin1000Max1152000000; + /** + * Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9. + */ + QvbrQualityLevel?: __integerMin1Max10; + } + export type H264RateControlMode = "VBR"|"CBR"|"QVBR"|string; + export type H264RepeatPps = "DISABLED"|"ENABLED"|string; + export type H264SceneChangeDetect = "DISABLED"|"ENABLED"|string; + export interface H264Settings { + /** + * Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. + */ + AdaptiveQuantization?: H264AdaptiveQuantization; + /** + * Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000. + */ + Bitrate?: __integerMin1000Max1152000000; + /** + * Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO). + */ + CodecLevel?: H264CodecLevel; + /** + * H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License. + */ + CodecProfile?: H264CodecProfile; + /** + * Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames). + */ + DynamicSubGop?: H264DynamicSubGop; + /** + * Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC. + */ + EntropyEncoding?: H264EntropyEncoding; + /** + * Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs. + */ + FieldEncoding?: H264FieldEncoding; + /** + * Adjust quantization within each frame to reduce flicker or 'pop' on I-frames. + */ + FlickerAdaptiveQuantization?: H264FlickerAdaptiveQuantization; + /** + * If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. + */ + FramerateControl?: H264FramerateControl; + /** + * When set to INTERPOLATE, produces smoother motion during frame rate conversion. + */ + FramerateConversionAlgorithm?: H264FramerateConversionAlgorithm; + /** + * When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + */ + FramerateDenominator?: __integerMin1Max2147483647; + /** + * Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + */ + FramerateNumerator?: __integerMin1Max2147483647; + /** + * If enable, use reference B frames for GOP structures that have B frames > 1. + */ + GopBReference?: H264GopBReference; + /** + * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. + */ + GopClosedCadence?: __integerMin0Max2147483647; + /** + * GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. + */ + GopSize?: __doubleMin0; + /** + * Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time. + */ + GopSizeUnits?: H264GopSizeUnits; + /** + * Percentage of the buffer that should initially be filled (HRD buffer model). + */ + HrdBufferInitialFillPercentage?: __integerMin0Max100; + /** + * Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + */ + HrdBufferSize?: __integerMin0Max1152000000; + /** + * Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows. + - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". + - If the source is progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose. + */ + InterlaceMode?: H264InterlaceMode; + /** + * Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR. + */ + MaxBitrate?: __integerMin1000Max1152000000; + /** + * Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 + */ + MinIInterval?: __integerMin0Max30; + /** + * Number of B-frames between reference frames. + */ + NumberBFramesBetweenReferenceFrames?: __integerMin0Max7; + /** + * Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. + */ + NumberReferenceFrames?: __integerMin1Max6; + /** + * Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio. + */ + ParControl?: H264ParControl; + /** + * Pixel Aspect Ratio denominator. + */ + ParDenominator?: __integerMin1Max2147483647; + /** + * Pixel Aspect Ratio numerator. + */ + ParNumerator?: __integerMin1Max2147483647; + /** + * Use Quality tuning level (H264QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding. + */ + QualityTuningLevel?: H264QualityTuningLevel; + /** + * Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode. + */ + QvbrSettings?: H264QvbrSettings; + /** + * Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR). + */ + RateControlMode?: H264RateControlMode; + /** + * Places a PPS header on each encoded picture, even if repeated. + */ + RepeatPps?: H264RepeatPps; + /** + * Scene change detection (inserts I-frames on scene changes). + */ + SceneChangeDetect?: H264SceneChangeDetect; + /** + * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. + */ + Slices?: __integerMin1Max32; + /** + * Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly. + */ + SlowPal?: H264SlowPal; + /** + * Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. + */ + Softness?: __integerMin0Max128; + /** + * Adjust quantization within each frame based on spatial variation of content complexity. + */ + SpatialAdaptiveQuantization?: H264SpatialAdaptiveQuantization; + /** + * Produces a bitstream compliant with SMPTE RP-2027. + */ + Syntax?: H264Syntax; + /** + * This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i. + */ + Telecine?: H264Telecine; + /** + * Adjust quantization within each frame based on temporal variation of content complexity. + */ + TemporalAdaptiveQuantization?: H264TemporalAdaptiveQuantization; + /** + * Inserts timecode for each frame as 4 bytes of an unregistered SEI message. + */ + UnregisteredSeiTimecode?: H264UnregisteredSeiTimecode; + } + export type H264SlowPal = "DISABLED"|"ENABLED"|string; + export type H264SpatialAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type H264Syntax = "DEFAULT"|"RP2027"|string; + export type H264Telecine = "NONE"|"SOFT"|"HARD"|string; + export type H264TemporalAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type H264UnregisteredSeiTimecode = "DISABLED"|"ENABLED"|string; + export type H265AdaptiveQuantization = "OFF"|"LOW"|"MEDIUM"|"HIGH"|"HIGHER"|"MAX"|string; + export type H265AlternateTransferFunctionSei = "DISABLED"|"ENABLED"|string; + export type H265CodecLevel = "AUTO"|"LEVEL_1"|"LEVEL_2"|"LEVEL_2_1"|"LEVEL_3"|"LEVEL_3_1"|"LEVEL_4"|"LEVEL_4_1"|"LEVEL_5"|"LEVEL_5_1"|"LEVEL_5_2"|"LEVEL_6"|"LEVEL_6_1"|"LEVEL_6_2"|string; + export type H265CodecProfile = "MAIN_MAIN"|"MAIN_HIGH"|"MAIN10_MAIN"|"MAIN10_HIGH"|"MAIN_422_8BIT_MAIN"|"MAIN_422_8BIT_HIGH"|"MAIN_422_10BIT_MAIN"|"MAIN_422_10BIT_HIGH"|string; + export type H265DynamicSubGop = "ADAPTIVE"|"STATIC"|string; + export type H265FlickerAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type H265FramerateControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type H265FramerateConversionAlgorithm = "DUPLICATE_DROP"|"INTERPOLATE"|string; + export type H265GopBReference = "DISABLED"|"ENABLED"|string; + export type H265GopSizeUnits = "FRAMES"|"SECONDS"|string; + export type H265InterlaceMode = "PROGRESSIVE"|"TOP_FIELD"|"BOTTOM_FIELD"|"FOLLOW_TOP_FIELD"|"FOLLOW_BOTTOM_FIELD"|string; + export type H265ParControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type H265QualityTuningLevel = "SINGLE_PASS"|"SINGLE_PASS_HQ"|"MULTI_PASS_HQ"|string; + export interface H265QvbrSettings { + /** + * Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output. + */ + MaxAverageBitrate?: __integerMin1000Max1466400000; + /** + * Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9. + */ + QvbrQualityLevel?: __integerMin1Max10; + } + export type H265RateControlMode = "VBR"|"CBR"|"QVBR"|string; + export type H265SampleAdaptiveOffsetFilterMode = "DEFAULT"|"ADAPTIVE"|"OFF"|string; + export type H265SceneChangeDetect = "DISABLED"|"ENABLED"|string; + export interface H265Settings { + /** + * Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. + */ + AdaptiveQuantization?: H265AdaptiveQuantization; + /** + * Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF). + */ + AlternateTransferFunctionSei?: H265AlternateTransferFunctionSei; + /** + * Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000. + */ + Bitrate?: __integerMin1000Max1466400000; + /** + * H.265 Level. + */ + CodecLevel?: H265CodecLevel; + /** + * Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License. + */ + CodecProfile?: H265CodecProfile; + /** + * Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames). + */ + DynamicSubGop?: H265DynamicSubGop; + /** + * Adjust quantization within each frame to reduce flicker or 'pop' on I-frames. + */ + FlickerAdaptiveQuantization?: H265FlickerAdaptiveQuantization; + /** + * If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. + */ + FramerateControl?: H265FramerateControl; + /** + * When set to INTERPOLATE, produces smoother motion during frame rate conversion. + */ + FramerateConversionAlgorithm?: H265FramerateConversionAlgorithm; + /** + * Frame rate denominator. + */ + FramerateDenominator?: __integerMin1Max2147483647; + /** + * Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + */ + FramerateNumerator?: __integerMin1Max2147483647; + /** + * If enable, use reference B frames for GOP structures that have B frames > 1. + */ + GopBReference?: H265GopBReference; + /** + * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. + */ + GopClosedCadence?: __integerMin0Max2147483647; + /** + * GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. + */ + GopSize?: __doubleMin0; + /** + * Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time. + */ + GopSizeUnits?: H265GopSizeUnits; + /** + * Percentage of the buffer that should initially be filled (HRD buffer model). + */ + HrdBufferInitialFillPercentage?: __integerMin0Max100; + /** + * Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + */ + HrdBufferSize?: __integerMin0Max1466400000; + /** + * Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. + - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". + - If the source is progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose. + */ + InterlaceMode?: H265InterlaceMode; + /** + * Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR. + */ + MaxBitrate?: __integerMin1000Max1466400000; + /** + * Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 + */ + MinIInterval?: __integerMin0Max30; + /** + * Number of B-frames between reference frames. + */ + NumberBFramesBetweenReferenceFrames?: __integerMin0Max7; + /** + * Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. + */ + NumberReferenceFrames?: __integerMin1Max6; + /** + * Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio. + */ + ParControl?: H265ParControl; + /** + * Pixel Aspect Ratio denominator. + */ + ParDenominator?: __integerMin1Max2147483647; + /** + * Pixel Aspect Ratio numerator. + */ + ParNumerator?: __integerMin1Max2147483647; + /** + * Use Quality tuning level (H265QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding. + */ + QualityTuningLevel?: H265QualityTuningLevel; + /** + * Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode. + */ + QvbrSettings?: H265QvbrSettings; + /** + * Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR). + */ + RateControlMode?: H265RateControlMode; + /** + * Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content + */ + SampleAdaptiveOffsetFilterMode?: H265SampleAdaptiveOffsetFilterMode; + /** + * Scene change detection (inserts I-frames on scene changes). + */ + SceneChangeDetect?: H265SceneChangeDetect; + /** + * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. + */ + Slices?: __integerMin1Max32; + /** + * Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly. + */ + SlowPal?: H265SlowPal; + /** + * Adjust quantization within each frame based on spatial variation of content complexity. + */ + SpatialAdaptiveQuantization?: H265SpatialAdaptiveQuantization; + /** + * This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i. + */ + Telecine?: H265Telecine; + /** + * Adjust quantization within each frame based on temporal variation of content complexity. + */ + TemporalAdaptiveQuantization?: H265TemporalAdaptiveQuantization; + /** + * Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output. + */ + TemporalIds?: H265TemporalIds; + /** + * Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures. + */ + Tiles?: H265Tiles; + /** + * Inserts timecode for each frame as 4 bytes of an unregistered SEI message. + */ + UnregisteredSeiTimecode?: H265UnregisteredSeiTimecode; + /** + * Use this setting only for outputs encoded with H.265 that are in CMAF or DASH output groups. If you include writeMp4PackagingType in your JSON job specification for other outputs, your video might not work properly with downstream systems and video players. If the location of parameter set NAL units don't matter in your workflow, ignore this setting. The service defaults to marking your output as HEV1. Choose HVC1 to mark your output as HVC1. This makes your output compliant with this specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. Keep the default HEV1 to mark your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples. + */ + WriteMp4PackagingType?: H265WriteMp4PackagingType; + } + export type H265SlowPal = "DISABLED"|"ENABLED"|string; + export type H265SpatialAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type H265Telecine = "NONE"|"SOFT"|"HARD"|string; + export type H265TemporalAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type H265TemporalIds = "DISABLED"|"ENABLED"|string; + export type H265Tiles = "DISABLED"|"ENABLED"|string; + export type H265UnregisteredSeiTimecode = "DISABLED"|"ENABLED"|string; + export type H265WriteMp4PackagingType = "HVC1"|"HEV1"|string; + export interface Hdr10Metadata { + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + BluePrimaryX?: __integerMin0Max50000; + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + BluePrimaryY?: __integerMin0Max50000; + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + GreenPrimaryX?: __integerMin0Max50000; + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + GreenPrimaryY?: __integerMin0Max50000; + /** + * Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. + */ + MaxContentLightLevel?: __integerMin0Max65535; + /** + * Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. + */ + MaxFrameAverageLightLevel?: __integerMin0Max65535; + /** + * Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter. + */ + MaxLuminance?: __integerMin0Max2147483647; + /** + * Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter + */ + MinLuminance?: __integerMin0Max2147483647; + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + RedPrimaryX?: __integerMin0Max50000; + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + RedPrimaryY?: __integerMin0Max50000; + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + WhitePointX?: __integerMin0Max50000; + /** + * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + */ + WhitePointY?: __integerMin0Max50000; + } + export type HlsAdMarkers = "ELEMENTAL"|"ELEMENTAL_SCTE35"|string; + export type HlsAudioTrackType = "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"|"ALTERNATE_AUDIO_AUTO_SELECT"|"ALTERNATE_AUDIO_NOT_AUTO_SELECT"|"AUDIO_ONLY_VARIANT_STREAM"|string; + export interface HlsCaptionLanguageMapping { + /** + * Caption channel. + */ + CaptionChannel?: __integerMinNegative2147483648Max2147483647; + /** + * Specify the language for this caption channel, using the ISO 639-2 or ISO 639-3 three-letter language code + */ + CustomLanguageCode?: __stringMin3Max3PatternAZaZ3; + /** + * Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php. + */ + LanguageCode?: LanguageCode; + /** + * Caption language description. + */ + LanguageDescription?: __string; + } + export type HlsCaptionLanguageSetting = "INSERT"|"OMIT"|"NONE"|string; + export type HlsClientCache = "DISABLED"|"ENABLED"|string; + export type HlsCodecSpecification = "RFC_6381"|"RFC_4281"|string; + export type HlsDirectoryStructure = "SINGLE_DIRECTORY"|"SUBDIRECTORY_PER_STREAM"|string; + export interface HlsEncryptionSettings { + /** + * This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default. + */ + ConstantInitializationVector?: __stringMin32Max32Pattern09aFAF32; + /** + * Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption. + */ + EncryptionMethod?: HlsEncryptionType; + /** + * The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest. + */ + InitializationVectorInManifest?: HlsInitializationVectorInManifest; + /** + * Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection. + */ + OfflineEncrypted?: HlsOfflineEncrypted; + /** + * Settings for use with a SPEKE key provider + */ + SpekeKeyProvider?: SpekeKeyProvider; + /** + * Use these settings to set up encryption with a static key provider. + */ + StaticKeyProvider?: StaticKeyProvider; + /** + * Indicates which type of key provider is used for encryption. + */ + Type?: HlsKeyProviderType; + } + export type HlsEncryptionType = "AES128"|"SAMPLE_AES"|string; + export interface HlsGroupSettings { + /** + * Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. + */ + AdMarkers?: __listOfHlsAdMarkers; + /** + * A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. + */ + BaseUrl?: __string; + /** + * Language to be used on Caption outputs + */ + CaptionLanguageMappings?: __listOfHlsCaptionLanguageMapping; + /** + * Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest. + */ + CaptionLanguageSetting?: HlsCaptionLanguageSetting; + /** + * When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay. + */ + ClientCache?: HlsClientCache; + /** + * Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. + */ + CodecSpecification?: HlsCodecSpecification; + /** + * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. + */ + Destination?: __stringPatternS3; + /** + * Settings associated with the destination. Will vary based on the type of destination + */ + DestinationSettings?: DestinationSettings; + /** + * Indicates whether segments should be placed in subdirectories. + */ + DirectoryStructure?: HlsDirectoryStructure; + /** + * DRM settings. + */ + Encryption?: HlsEncryptionSettings; + /** + * When set to GZIP, compresses HLS playlist. + */ + ManifestCompression?: HlsManifestCompression; + /** + * Indicates whether the output manifest should use floating point values for segment duration. + */ + ManifestDurationFormat?: HlsManifestDurationFormat; + /** + * Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. + */ + MinFinalSegmentLength?: __doubleMin0Max2147483647; + /** + * When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. + */ + MinSegmentLength?: __integerMin0Max2147483647; + /** + * Indicates whether the .m3u8 manifest file should be generated for this HLS output group. + */ + OutputSelection?: HlsOutputSelection; + /** + * Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset. + */ + ProgramDateTime?: HlsProgramDateTime; + /** + * Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. + */ + ProgramDateTimePeriod?: __integerMin0Max3600; + /** + * When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback. + */ + SegmentControl?: HlsSegmentControl; + /** + * Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. + */ + SegmentLength?: __integerMin1Max2147483647; + /** + * Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect. + */ + SegmentsPerSubdirectory?: __integerMin1Max2147483647; + /** + * Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. + */ + StreamInfResolution?: HlsStreamInfResolution; + /** + * Indicates ID3 frame that has the timecode. + */ + TimedMetadataId3Frame?: HlsTimedMetadataId3Frame; + /** + * Timed Metadata interval in seconds. + */ + TimedMetadataId3Period?: __integerMinNegative2147483648Max2147483647; + /** + * Provides an extra millisecond delta offset to fine tune the timestamps. + */ + TimestampDeltaMilliseconds?: __integerMinNegative2147483648Max2147483647; + } + export type HlsIFrameOnlyManifest = "INCLUDE"|"EXCLUDE"|string; + export type HlsInitializationVectorInManifest = "INCLUDE"|"EXCLUDE"|string; + export type HlsKeyProviderType = "SPEKE"|"STATIC_KEY"|string; + export type HlsManifestCompression = "GZIP"|"NONE"|string; + export type HlsManifestDurationFormat = "FLOATING_POINT"|"INTEGER"|string; + export type HlsOfflineEncrypted = "ENABLED"|"DISABLED"|string; + export type HlsOutputSelection = "MANIFESTS_AND_SEGMENTS"|"SEGMENTS_ONLY"|string; + export type HlsProgramDateTime = "INCLUDE"|"EXCLUDE"|string; + export type HlsSegmentControl = "SINGLE_FILE"|"SEGMENTED_FILES"|string; + export interface HlsSettings { + /** + * Specifies the group to which the audio Rendition belongs. + */ + AudioGroupId?: __string; + /** + * List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. + */ + AudioRenditionSets?: __string; + /** + * Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO + */ + AudioTrackType?: HlsAudioTrackType; + /** + * When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest + */ + IFrameOnlyManifest?: HlsIFrameOnlyManifest; + /** + * String concatenated to end of segment filenames. Accepts "Format Identifiers":#format_identifier_parameters. + */ + SegmentModifier?: __string; + } + export type HlsStreamInfResolution = "INCLUDE"|"EXCLUDE"|string; + export type HlsTimedMetadataId3Frame = "NONE"|"PRIV"|"TDRL"|string; + export interface Id3Insertion { + /** + * Use ID3 tag (Id3) to provide a tag value in base64-encode format. + */ + Id3?: __stringPatternAZaZ0902; + /** + * Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format. + */ + Timecode?: __stringPattern010920405090509092; + } + export interface ImageInserter { + /** + * Specify the images that you want to overlay on your video. The images must be PNG or TGA files. + */ + InsertableImages?: __listOfInsertableImage; + } + export interface Input { + /** + * Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See "Audio Selector Group":#inputs-audio_selector_group for more information. + */ + AudioSelectorGroups?: __mapOfAudioSelectorGroup; + /** + * Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input. + */ + AudioSelectors?: __mapOfAudioSelector; + /** + * Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input. + */ + CaptionSelectors?: __mapOfCaptionSelector; + /** + * Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs. + */ + DeblockFilter?: InputDeblockFilter; + /** + * Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content. + */ + DecryptionSettings?: InputDecryptionSettings; + /** + * Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. + */ + DenoiseFilter?: InputDenoiseFilter; + /** + * Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL. + */ + FileInput?: __stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL; + /** + * Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type. + */ + FilterEnable?: InputFilterEnable; + /** + * Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0. + */ + FilterStrength?: __integerMinNegative5Max5; + /** + * Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default. + */ + ImageInserter?: ImageInserter; + /** + * (InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them. + */ + InputClippings?: __listOfInputClipping; + /** + * Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default. + */ + ProgramNumber?: __integerMin1Max2147483647; + /** + * Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data. + */ + PsiControl?: InputPsiControl; + /** + * Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it. + */ + SupplementalImps?: __listOf__stringPatternS3ASSETMAPXml; + /** + * Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes. + */ + TimecodeSource?: InputTimecodeSource; + /** + * Selector for video. + */ + VideoSelector?: VideoSelector; + } + export interface InputClipping { + /** + * Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00. + */ + EndTimecode?: __stringPattern010920405090509092; + /** + * Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00. + */ + StartTimecode?: __stringPattern010920405090509092; + } + export type InputDeblockFilter = "ENABLED"|"DISABLED"|string; + export interface InputDecryptionSettings { + /** + * Specify the encryption mode that you used to encrypt your input files. + */ + DecryptionMode?: DecryptionMode; + /** + * Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits. + */ + EncryptedDecryptionKey?: __stringMin24Max512PatternAZaZ0902; + /** + * Specify the initialization vector that you used when you encrypted your content before uploading it to Amazon S3. You can use a 16-byte initialization vector with any encryption mode. Or, you can use a 12-byte initialization vector with GCM or CTR. MediaConvert accepts only initialization vectors that are base64-encoded. + */ + InitializationVector?: __stringMin16Max24PatternAZaZ0922AZaZ0916; + /** + * Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that Region is different from the one you are using for AWS Elemental MediaConvert. + */ + KmsKeyRegion?: __stringMin9Max19PatternAZ26EastWestCentralNorthSouthEastWest1912; + } + export type InputDenoiseFilter = "ENABLED"|"DISABLED"|string; + export type InputFilterEnable = "AUTO"|"DISABLE"|"FORCE"|string; + export type InputPsiControl = "IGNORE_PSI"|"USE_PSI"|string; + export type InputRotate = "DEGREE_0"|"DEGREES_90"|"DEGREES_180"|"DEGREES_270"|"AUTO"|string; + export interface InputTemplate { + /** + * Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See "Audio Selector Group":#inputs-audio_selector_group for more information. + */ + AudioSelectorGroups?: __mapOfAudioSelectorGroup; + /** + * Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input. + */ + AudioSelectors?: __mapOfAudioSelector; + /** + * Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input. + */ + CaptionSelectors?: __mapOfCaptionSelector; + /** + * Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs. + */ + DeblockFilter?: InputDeblockFilter; + /** + * Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. + */ + DenoiseFilter?: InputDenoiseFilter; + /** + * Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type. + */ + FilterEnable?: InputFilterEnable; + /** + * Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0. + */ + FilterStrength?: __integerMinNegative5Max5; + /** + * Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default. + */ + ImageInserter?: ImageInserter; + /** + * (InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them. + */ + InputClippings?: __listOfInputClipping; + /** + * Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default. + */ + ProgramNumber?: __integerMin1Max2147483647; + /** + * Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data. + */ + PsiControl?: InputPsiControl; + /** + * Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes. + */ + TimecodeSource?: InputTimecodeSource; + /** + * Selector for video. + */ + VideoSelector?: VideoSelector; + } + export type InputTimecodeSource = "EMBEDDED"|"ZEROBASED"|"SPECIFIEDSTART"|string; + export interface InsertableImage { + /** + * Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time. + */ + Duration?: __integerMin0Max2147483647; + /** + * Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time. + */ + FadeIn?: __integerMin0Max2147483647; + /** + * Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration. + */ + FadeOut?: __integerMin0Max2147483647; + /** + * Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank. + */ + Height?: __integerMin0Max2147483647; + /** + * Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file. + */ + ImageInserterInput?: __stringMin14PatternS3BmpBMPPngPNGTgaTGA; + /** + * Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify. + */ + ImageX?: __integerMin0Max2147483647; + /** + * Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify. + */ + ImageY?: __integerMin0Max2147483647; + /** + * Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer. + */ + Layer?: __integerMin0Max99; + /** + * Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50. + */ + Opacity?: __integerMin0Max100; + /** + * Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings. + */ + StartTime?: __stringPattern01D20305D205D; + /** + * Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank. + */ + Width?: __integerMin0Max2147483647; + } + export interface Job { + /** + * Accelerated transcoding can significantly speed up jobs with long, visually complex content. + */ + AccelerationSettings?: AccelerationSettings; + /** + * An identifier for this resource that is unique within all of AWS. + */ + Arn?: __string; + /** + * Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted. + */ + BillingTagsSource?: BillingTagsSource; + /** + * The time, in Unix epoch format in seconds, when the job got created. + */ + CreatedAt?: __timestampUnix; + /** + * A job's phase can be PROBING, TRANSCODING OR UPLOADING + */ + CurrentPhase?: JobPhase; + /** + * Error code for the job + */ + ErrorCode?: __integer; + /** + * Error message of Job + */ + ErrorMessage?: __string; + /** + * A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources + */ + Id?: __string; + /** + * An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, including audio-only jobs and jobs that use input clipping, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value. + */ + JobPercentComplete?: __integer; + /** + * The job template that the job is created from, if it is created from a job template. + */ + JobTemplate?: __string; + /** + * List of output group details + */ + OutputGroupDetails?: __listOfOutputGroupDetail; + /** + * Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + */ + Queue?: __string; + /** + * The number of times that the service automatically attempted to process your job after encountering an error. + */ + RetryCount?: __integer; + /** + * The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html + */ + Role: __string; + /** + * JobSettings contains all the transcode settings for a job. + */ + Settings: JobSettings; + /** + * A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR. + */ + Status?: JobStatus; + /** + * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. + */ + StatusUpdateInterval?: StatusUpdateInterval; + /** + * Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds. + */ + Timing?: Timing; + /** + * User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. + */ + UserMetadata?: __mapOf__string; + } + export type JobPhase = "PROBING"|"TRANSCODING"|"UPLOADING"|string; + export interface JobSettings { + /** + * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. + */ + AdAvailOffset?: __integerMinNegative1000Max1000; + /** + * Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails. + */ + AvailBlanking?: AvailBlanking; + /** + * Settings for Event Signaling And Messaging (ESAM). + */ + Esam?: EsamSettings; + /** + * Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output. + */ + Inputs?: __listOfInput; + /** + * Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. + */ + MotionImageInserter?: MotionImageInserter; + /** + * Settings for Nielsen Configuration + */ + NielsenConfiguration?: NielsenConfiguration; + /** + * (OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings + */ + OutputGroups?: __listOfOutputGroup; + /** + * Contains settings used to acquire and adjust timecode information from inputs. + */ + TimecodeConfig?: TimecodeConfig; + /** + * Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects. + */ + TimedMetadataInsertion?: TimedMetadataInsertion; + } + export type JobStatus = "SUBMITTED"|"PROGRESSING"|"COMPLETE"|"CANCELED"|"ERROR"|string; + export interface JobTemplate { + /** + * Accelerated transcoding is currently in private preview. Contact AWS for more information. + */ + AccelerationSettings?: AccelerationSettings; + /** + * An identifier for this resource that is unique within all of AWS. + */ + Arn?: __string; + /** + * An optional category you create to organize your job templates. + */ + Category?: __string; + /** + * The timestamp in epoch seconds for Job template creation. + */ + CreatedAt?: __timestampUnix; + /** + * An optional description you create for each job template. + */ + Description?: __string; + /** + * The timestamp in epoch seconds when the Job template was last updated. + */ + LastUpdated?: __timestampUnix; + /** + * A name you create for each job template. Each name must be unique within your account. + */ + Name: __string; + /** + * Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue. + */ + Queue?: __string; + /** + * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it. + */ + Settings: JobTemplateSettings; + /** + * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. + */ + StatusUpdateInterval?: StatusUpdateInterval; + /** + * A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user. + */ + Type?: Type; + } + export type JobTemplateListBy = "NAME"|"CREATION_DATE"|"SYSTEM"|string; + export interface JobTemplateSettings { + /** + * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. + */ + AdAvailOffset?: __integerMinNegative1000Max1000; + /** + * Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails. + */ + AvailBlanking?: AvailBlanking; + /** + * Settings for Event Signaling And Messaging (ESAM). + */ + Esam?: EsamSettings; + /** + * Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template. + */ + Inputs?: __listOfInputTemplate; + /** + * Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. + */ + MotionImageInserter?: MotionImageInserter; + /** + * Settings for Nielsen Configuration + */ + NielsenConfiguration?: NielsenConfiguration; + /** + * (OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings + */ + OutputGroups?: __listOfOutputGroup; + /** + * Contains settings used to acquire and adjust timecode information from inputs. + */ + TimecodeConfig?: TimecodeConfig; + /** + * Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects. + */ + TimedMetadataInsertion?: TimedMetadataInsertion; + } + export type LanguageCode = "ENG"|"SPA"|"FRA"|"DEU"|"GER"|"ZHO"|"ARA"|"HIN"|"JPN"|"RUS"|"POR"|"ITA"|"URD"|"VIE"|"KOR"|"PAN"|"ABK"|"AAR"|"AFR"|"AKA"|"SQI"|"AMH"|"ARG"|"HYE"|"ASM"|"AVA"|"AVE"|"AYM"|"AZE"|"BAM"|"BAK"|"EUS"|"BEL"|"BEN"|"BIH"|"BIS"|"BOS"|"BRE"|"BUL"|"MYA"|"CAT"|"KHM"|"CHA"|"CHE"|"NYA"|"CHU"|"CHV"|"COR"|"COS"|"CRE"|"HRV"|"CES"|"DAN"|"DIV"|"NLD"|"DZO"|"ENM"|"EPO"|"EST"|"EWE"|"FAO"|"FIJ"|"FIN"|"FRM"|"FUL"|"GLA"|"GLG"|"LUG"|"KAT"|"ELL"|"GRN"|"GUJ"|"HAT"|"HAU"|"HEB"|"HER"|"HMO"|"HUN"|"ISL"|"IDO"|"IBO"|"IND"|"INA"|"ILE"|"IKU"|"IPK"|"GLE"|"JAV"|"KAL"|"KAN"|"KAU"|"KAS"|"KAZ"|"KIK"|"KIN"|"KIR"|"KOM"|"KON"|"KUA"|"KUR"|"LAO"|"LAT"|"LAV"|"LIM"|"LIN"|"LIT"|"LUB"|"LTZ"|"MKD"|"MLG"|"MSA"|"MAL"|"MLT"|"GLV"|"MRI"|"MAR"|"MAH"|"MON"|"NAU"|"NAV"|"NDE"|"NBL"|"NDO"|"NEP"|"SME"|"NOR"|"NOB"|"NNO"|"OCI"|"OJI"|"ORI"|"ORM"|"OSS"|"PLI"|"FAS"|"POL"|"PUS"|"QUE"|"QAA"|"RON"|"ROH"|"RUN"|"SMO"|"SAG"|"SAN"|"SRD"|"SRB"|"SNA"|"III"|"SND"|"SIN"|"SLK"|"SLV"|"SOM"|"SOT"|"SUN"|"SWA"|"SSW"|"SWE"|"TGL"|"TAH"|"TGK"|"TAM"|"TAT"|"TEL"|"THA"|"BOD"|"TIR"|"TON"|"TSO"|"TSN"|"TUR"|"TUK"|"TWI"|"UIG"|"UKR"|"UZB"|"VEN"|"VOL"|"WLN"|"CYM"|"FRY"|"WOL"|"XHO"|"YID"|"YOR"|"ZHA"|"ZUL"|"ORJ"|"QPC"|"TNG"|string; + export interface ListJobTemplatesRequest { + /** + * Optionally, specify a job template category to limit responses to only job templates from that category. + */ + Category?: __string; + /** + * Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name. + */ + ListBy?: JobTemplateListBy; + /** + * Optional. Number of job templates, up to twenty, that will be returned at one time. + */ + MaxResults?: __integerMin1Max20; + /** + * Use this string, provided with the response to a previous request, to request the next batch of job templates. + */ + NextToken?: __string; + /** + * When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource. + */ + Order?: Order; + } + export interface ListJobTemplatesResponse { + /** + * List of Job templates. + */ + JobTemplates?: __listOfJobTemplate; + /** + * Use this string to request the next batch of job templates. + */ + NextToken?: __string; + } + export interface ListJobsRequest { + /** + * Optional. Number of jobs, up to twenty, that will be returned at one time. + */ + MaxResults?: __integerMin1Max20; + /** + * Use this string, provided with the response to a previous request, to request the next batch of jobs. + */ + NextToken?: __string; + /** + * When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource. + */ + Order?: Order; + /** + * Provide a queue name to get back only jobs from that queue. + */ + Queue?: __string; + /** + * A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR. + */ + Status?: JobStatus; + } + export interface ListJobsResponse { + /** + * List of jobs + */ + Jobs?: __listOfJob; + /** + * Use this string to request the next batch of jobs. + */ + NextToken?: __string; + } + export interface ListPresetsRequest { + /** + * Optionally, specify a preset category to limit responses to only presets from that category. + */ + Category?: __string; + /** + * Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name. + */ + ListBy?: PresetListBy; + /** + * Optional. Number of presets, up to twenty, that will be returned at one time + */ + MaxResults?: __integerMin1Max20; + /** + * Use this string, provided with the response to a previous request, to request the next batch of presets. + */ + NextToken?: __string; + /** + * When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource. + */ + Order?: Order; + } + export interface ListPresetsResponse { + /** + * Use this string to request the next batch of presets. + */ + NextToken?: __string; + /** + * List of presets + */ + Presets?: __listOfPreset; + } + export interface ListQueuesRequest { + /** + * Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date. + */ + ListBy?: QueueListBy; + /** + * Optional. Number of queues, up to twenty, that will be returned at one time. + */ + MaxResults?: __integerMin1Max20; + /** + * Use this string, provided with the response to a previous request, to request the next batch of queues. + */ + NextToken?: __string; + /** + * When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource. + */ + Order?: Order; + } + export interface ListQueuesResponse { + /** + * Use this string to request the next batch of queues. + */ + NextToken?: __string; + /** + * List of queues. + */ + Queues?: __listOfQueue; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource that you want to list tags for. To get the ARN, send a GET request with the resource name. + */ + Arn: __string; + } + export interface ListTagsForResourceResponse { + /** + * The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource. + */ + ResourceTags?: ResourceTags; + } + export type M2tsAudioBufferModel = "DVB"|"ATSC"|string; + export type M2tsBufferModel = "MULTIPLEX"|"NONE"|string; + export type M2tsEbpAudioInterval = "VIDEO_AND_FIXED_INTERVALS"|"VIDEO_INTERVAL"|string; + export type M2tsEbpPlacement = "VIDEO_AND_AUDIO_PIDS"|"VIDEO_PID"|string; + export type M2tsEsRateInPes = "INCLUDE"|"EXCLUDE"|string; + export type M2tsForceTsVideoEbpOrder = "FORCE"|"DEFAULT"|string; + export type M2tsNielsenId3 = "INSERT"|"NONE"|string; + export type M2tsPcrControl = "PCR_EVERY_PES_PACKET"|"CONFIGURED_PCR_PERIOD"|string; + export type M2tsRateMode = "VBR"|"CBR"|string; + export interface M2tsScte35Esam { + /** + * Packet Identifier (PID) of the SCTE-35 stream in the transport stream generated by ESAM. + */ + Scte35EsamPid?: __integerMin32Max8182; + } + export type M2tsScte35Source = "PASSTHROUGH"|"NONE"|string; + export type M2tsSegmentationMarkers = "NONE"|"RAI_SEGSTART"|"RAI_ADAPT"|"PSI_SEGSTART"|"EBP"|"EBP_LEGACY"|string; + export type M2tsSegmentationStyle = "MAINTAIN_CADENCE"|"RESET_CADENCE"|string; + export interface M2tsSettings { + /** + * Selects between the DVB and ATSC buffer models for Dolby Digital audio. + */ + AudioBufferModel?: M2tsAudioBufferModel; + /** + * The number of audio frames to insert for each PES packet. + */ + AudioFramesPerPes?: __integerMin0Max2147483647; + /** + * Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492. + */ + AudioPids?: __listOf__integerMin32Max8182; + /** + * Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000. + */ + Bitrate?: __integerMin0Max2147483647; + /** + * Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. + */ + BufferModel?: M2tsBufferModel; + /** + * Inserts DVB Network Information Table (NIT) at the specified table repetition interval. + */ + DvbNitSettings?: DvbNitSettings; + /** + * Inserts DVB Service Description Table (NIT) at the specified table repetition interval. + */ + DvbSdtSettings?: DvbSdtSettings; + /** + * Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479. + */ + DvbSubPids?: __listOf__integerMin32Max8182; + /** + * Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. + */ + DvbTdtSettings?: DvbTdtSettings; + /** + * Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499. + */ + DvbTeletextPid?: __integerMin32Max8182; + /** + * When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY). + */ + EbpAudioInterval?: M2tsEbpAudioInterval; + /** + * Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY). + */ + EbpPlacement?: M2tsEbpPlacement; + /** + * Controls whether to include the ES Rate field in the PES header. + */ + EsRateInPes?: M2tsEsRateInPes; + /** + * Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE). + */ + ForceTsVideoEbpOrder?: M2tsForceTsVideoEbpOrder; + /** + * The length, in seconds, of each fragment. Only used with EBP markers. + */ + FragmentTime?: __doubleMin0; + /** + * Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream. + */ + MaxPcrInterval?: __integerMin0Max500; + /** + * When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. + */ + MinEbpInterval?: __integerMin0Max10000; + /** + * If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. + */ + NielsenId3?: M2tsNielsenId3; + /** + * Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. + */ + NullPacketBitrate?: __doubleMin0; + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + PatInterval?: __integerMin0Max1000; + /** + * When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream. + */ + PcrControl?: M2tsPcrControl; + /** + * Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid). + */ + PcrPid?: __integerMin32Max8182; + /** + * Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream. + */ + PmtInterval?: __integerMin0Max1000; + /** + * Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480. + */ + PmtPid?: __integerMin32Max8182; + /** + * Specify the packet identifier (PID) of the private metadata stream. Default is 503. + */ + PrivateMetadataPid?: __integerMin32Max8182; + /** + * Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data. + */ + ProgramNumber?: __integerMin0Max65535; + /** + * When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate. + */ + RateMode?: M2tsRateMode; + /** + * Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml). + */ + Scte35Esam?: M2tsScte35Esam; + /** + * Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream. + */ + Scte35Pid?: __integerMin32Max8182; + /** + * Enables SCTE-35 passthrough (scte35Source) to pass any SCTE-35 signals from input to output. + */ + Scte35Source?: M2tsScte35Source; + /** + * Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. + */ + SegmentationMarkers?: M2tsSegmentationMarkers; + /** + * The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule. + */ + SegmentationStyle?: M2tsSegmentationStyle; + /** + * Specify the length, in seconds, of each segment. Required unless markers is set to _none_. + */ + SegmentationTime?: __doubleMin0; + /** + * Specify the packet identifier (PID) for timed metadata in this output. Default is 502. + */ + TimedMetadataPid?: __integerMin32Max8182; + /** + * Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data. + */ + TransportStreamId?: __integerMin0Max65535; + /** + * Specify the packet identifier (PID) of the elementary video stream in the transport stream. + */ + VideoPid?: __integerMin32Max8182; + } + export type M3u8NielsenId3 = "INSERT"|"NONE"|string; + export type M3u8PcrControl = "PCR_EVERY_PES_PACKET"|"CONFIGURED_PCR_PERIOD"|string; + export type M3u8Scte35Source = "PASSTHROUGH"|"NONE"|string; + export interface M3u8Settings { + /** + * The number of audio frames to insert for each PES packet. + */ + AudioFramesPerPes?: __integerMin0Max2147483647; + /** + * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. + */ + AudioPids?: __listOf__integerMin32Max8182; + /** + * If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. + */ + NielsenId3?: M3u8NielsenId3; + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + PatInterval?: __integerMin0Max1000; + /** + * When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. + */ + PcrControl?: M3u8PcrControl; + /** + * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. + */ + PcrPid?: __integerMin32Max8182; + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + PmtInterval?: __integerMin0Max1000; + /** + * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. + */ + PmtPid?: __integerMin32Max8182; + /** + * Packet Identifier (PID) of the private metadata stream in the transport stream. + */ + PrivateMetadataPid?: __integerMin32Max8182; + /** + * The value of the program number field in the Program Map Table. + */ + ProgramNumber?: __integerMin0Max65535; + /** + * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. + */ + Scte35Pid?: __integerMin32Max8182; + /** + * Enables SCTE-35 passthrough (scte35Source) to pass any SCTE-35 signals from input to output. + */ + Scte35Source?: M3u8Scte35Source; + /** + * Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output. + */ + TimedMetadata?: TimedMetadata; + /** + * Packet Identifier (PID) of the timed metadata stream in the transport stream. + */ + TimedMetadataPid?: __integerMin32Max8182; + /** + * The value of the transport stream ID field in the Program Map Table. + */ + TransportStreamId?: __integerMin0Max65535; + /** + * Packet Identifier (PID) of the elementary video stream in the transport stream. + */ + VideoPid?: __integerMin32Max8182; + } + export interface MotionImageInserter { + /** + * If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video. + */ + Framerate?: MotionImageInsertionFramerate; + /** + * Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence. + */ + Input?: __stringMin14Max1285PatternS3Mov09Png; + /** + * Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files. + */ + InsertionMode?: MotionImageInsertionMode; + /** + * Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling. + */ + Offset?: MotionImageInsertionOffset; + /** + * Specify whether your motion graphic overlay repeats on a loop or plays only once. + */ + Playback?: MotionImagePlayback; + /** + * Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource. + */ + StartTime?: __stringMin11Max11Pattern01D20305D205D; + } + export interface MotionImageInsertionFramerate { + /** + * The bottom of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 1. + */ + FramerateDenominator?: __integerMin1Max17895697; + /** + * The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 24. + */ + FramerateNumerator?: __integerMin1Max2147483640; + } + export type MotionImageInsertionMode = "MOV"|"PNG"|string; + export interface MotionImageInsertionOffset { + /** + * Set the distance, in pixels, between the overlay and the left edge of the video frame. + */ + ImageX?: __integerMin0Max2147483647; + /** + * Set the distance, in pixels, between the overlay and the top edge of the video frame. + */ + ImageY?: __integerMin0Max2147483647; + } + export type MotionImagePlayback = "ONCE"|"REPEAT"|string; + export type MovClapAtom = "INCLUDE"|"EXCLUDE"|string; + export type MovCslgAtom = "INCLUDE"|"EXCLUDE"|string; + export type MovMpeg2FourCCControl = "XDCAM"|"MPEG"|string; + export type MovPaddingControl = "OMNEON"|"NONE"|string; + export type MovReference = "SELF_CONTAINED"|"EXTERNAL"|string; + export interface MovSettings { + /** + * When enabled, include 'clap' atom if appropriate for the video output settings. + */ + ClapAtom?: MovClapAtom; + /** + * When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools. + */ + CslgAtom?: MovCslgAtom; + /** + * When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2. + */ + Mpeg2FourCCControl?: MovMpeg2FourCCControl; + /** + * If set to OMNEON, inserts Omneon-compatible padding + */ + PaddingControl?: MovPaddingControl; + /** + * Always keep the default value (SELF_CONTAINED) for this setting. + */ + Reference?: MovReference; + } + export interface Mp2Settings { + /** + * Average bitrate in bits/second. + */ + Bitrate?: __integerMin32000Max384000; + /** + * Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2. + */ + Channels?: __integerMin1Max2; + /** + * Sample rate in hz. + */ + SampleRate?: __integerMin32000Max48000; + } + export type Mp4CslgAtom = "INCLUDE"|"EXCLUDE"|string; + export type Mp4FreeSpaceBox = "INCLUDE"|"EXCLUDE"|string; + export type Mp4MoovPlacement = "PROGRESSIVE_DOWNLOAD"|"NORMAL"|string; + export interface Mp4Settings { + /** + * When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools. + */ + CslgAtom?: Mp4CslgAtom; + /** + * Inserts a free-space box immediately after the moov box. + */ + FreeSpaceBox?: Mp4FreeSpaceBox; + /** + * If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end. + */ + MoovPlacement?: Mp4MoovPlacement; + /** + * Overrides the "Major Brand" field in the output file. Usually not necessary to specify. + */ + Mp4MajorBrand?: __string; + } + export type Mpeg2AdaptiveQuantization = "OFF"|"LOW"|"MEDIUM"|"HIGH"|string; + export type Mpeg2CodecLevel = "AUTO"|"LOW"|"MAIN"|"HIGH1440"|"HIGH"|string; + export type Mpeg2CodecProfile = "MAIN"|"PROFILE_422"|string; + export type Mpeg2DynamicSubGop = "ADAPTIVE"|"STATIC"|string; + export type Mpeg2FramerateControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type Mpeg2FramerateConversionAlgorithm = "DUPLICATE_DROP"|"INTERPOLATE"|string; + export type Mpeg2GopSizeUnits = "FRAMES"|"SECONDS"|string; + export type Mpeg2InterlaceMode = "PROGRESSIVE"|"TOP_FIELD"|"BOTTOM_FIELD"|"FOLLOW_TOP_FIELD"|"FOLLOW_BOTTOM_FIELD"|string; + export type Mpeg2IntraDcPrecision = "AUTO"|"INTRA_DC_PRECISION_8"|"INTRA_DC_PRECISION_9"|"INTRA_DC_PRECISION_10"|"INTRA_DC_PRECISION_11"|string; + export type Mpeg2ParControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type Mpeg2QualityTuningLevel = "SINGLE_PASS"|"MULTI_PASS"|string; + export type Mpeg2RateControlMode = "VBR"|"CBR"|string; + export type Mpeg2SceneChangeDetect = "DISABLED"|"ENABLED"|string; + export interface Mpeg2Settings { + /** + * Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. + */ + AdaptiveQuantization?: Mpeg2AdaptiveQuantization; + /** + * Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000. + */ + Bitrate?: __integerMin1000Max288000000; + /** + * Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output. + */ + CodecLevel?: Mpeg2CodecLevel; + /** + * Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output. + */ + CodecProfile?: Mpeg2CodecProfile; + /** + * Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames). + */ + DynamicSubGop?: Mpeg2DynamicSubGop; + /** + * If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. + */ + FramerateControl?: Mpeg2FramerateControl; + /** + * When set to INTERPOLATE, produces smoother motion during frame rate conversion. + */ + FramerateConversionAlgorithm?: Mpeg2FramerateConversionAlgorithm; + /** + * Frame rate denominator. + */ + FramerateDenominator?: __integerMin1Max1001; + /** + * Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + */ + FramerateNumerator?: __integerMin24Max60000; + /** + * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. + */ + GopClosedCadence?: __integerMin0Max2147483647; + /** + * GOP Length (keyframe interval) in frames or seconds. Must be greater than zero. + */ + GopSize?: __doubleMin0; + /** + * Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time. + */ + GopSizeUnits?: Mpeg2GopSizeUnits; + /** + * Percentage of the buffer that should initially be filled (HRD buffer model). + */ + HrdBufferInitialFillPercentage?: __integerMin0Max100; + /** + * Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + */ + HrdBufferSize?: __integerMin0Max47185920; + /** + * Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. + - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". + - If the source is progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose. + */ + InterlaceMode?: Mpeg2InterlaceMode; + /** + * Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio. + */ + IntraDcPrecision?: Mpeg2IntraDcPrecision; + /** + * Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. + */ + MaxBitrate?: __integerMin1000Max300000000; + /** + * Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 + */ + MinIInterval?: __integerMin0Max30; + /** + * Number of B-frames between reference frames. + */ + NumberBFramesBetweenReferenceFrames?: __integerMin0Max7; + /** + * Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio. + */ + ParControl?: Mpeg2ParControl; + /** + * Pixel Aspect Ratio denominator. + */ + ParDenominator?: __integerMin1Max2147483647; + /** + * Pixel Aspect Ratio numerator. + */ + ParNumerator?: __integerMin1Max2147483647; + /** + * Use Quality tuning level (Mpeg2QualityTuningLevel) to specifiy whether to use single-pass or multipass video encoding. + */ + QualityTuningLevel?: Mpeg2QualityTuningLevel; + /** + * Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr). + */ + RateControlMode?: Mpeg2RateControlMode; + /** + * Scene change detection (inserts I-frames on scene changes). + */ + SceneChangeDetect?: Mpeg2SceneChangeDetect; + /** + * Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly. + */ + SlowPal?: Mpeg2SlowPal; + /** + * Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. + */ + Softness?: __integerMin0Max128; + /** + * Adjust quantization within each frame based on spatial variation of content complexity. + */ + SpatialAdaptiveQuantization?: Mpeg2SpatialAdaptiveQuantization; + /** + * Produces a Type D-10 compatible bitstream (SMPTE 356M-2001). + */ + Syntax?: Mpeg2Syntax; + /** + * Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player. + */ + Telecine?: Mpeg2Telecine; + /** + * Adjust quantization within each frame based on temporal variation of content complexity. + */ + TemporalAdaptiveQuantization?: Mpeg2TemporalAdaptiveQuantization; + } + export type Mpeg2SlowPal = "DISABLED"|"ENABLED"|string; + export type Mpeg2SpatialAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type Mpeg2Syntax = "DEFAULT"|"D_10"|string; + export type Mpeg2Telecine = "NONE"|"SOFT"|"HARD"|string; + export type Mpeg2TemporalAdaptiveQuantization = "DISABLED"|"ENABLED"|string; + export type MsSmoothAudioDeduplication = "COMBINE_DUPLICATE_STREAMS"|"NONE"|string; + export interface MsSmoothEncryptionSettings { + /** + * Settings for use with a SPEKE key provider + */ + SpekeKeyProvider?: SpekeKeyProvider; + } + export interface MsSmoothGroupSettings { + /** + * COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a Microsoft Smooth output group into a single audio stream. + */ + AudioDeduplication?: MsSmoothAudioDeduplication; + /** + * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. + */ + Destination?: __stringPatternS3; + /** + * Settings associated with the destination. Will vary based on the type of destination + */ + DestinationSettings?: DestinationSettings; + /** + * If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider. + */ + Encryption?: MsSmoothEncryptionSettings; + /** + * Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate. + */ + FragmentLength?: __integerMin1Max2147483647; + /** + * Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16. + */ + ManifestEncoding?: MsSmoothManifestEncoding; + } + export type MsSmoothManifestEncoding = "UTF8"|"UTF16"|string; + export interface NielsenConfiguration { + /** + * Use Nielsen Configuration (NielsenConfiguration) to set the Nielsen measurement system breakout code. Supported values are 0, 3, 7, and 9. + */ + BreakoutCode?: __integerMin0Max9; + /** + * Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen. + */ + DistributorId?: __string; + } + export interface NoiseReducer { + /** + * Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles. + */ + Filter?: NoiseReducerFilter; + /** + * Settings for a noise reducer filter + */ + FilterSettings?: NoiseReducerFilterSettings; + /** + * Noise reducer filter settings for spatial filter. + */ + SpatialFilterSettings?: NoiseReducerSpatialFilterSettings; + } + export type NoiseReducerFilter = "BILATERAL"|"MEAN"|"GAUSSIAN"|"LANCZOS"|"SHARPEN"|"CONSERVE"|"SPATIAL"|string; + export interface NoiseReducerFilterSettings { + /** + * Relative strength of noise reducing filter. Higher values produce stronger filtering. + */ + Strength?: __integerMin0Max3; + } + export interface NoiseReducerSpatialFilterSettings { + /** + * Specify strength of post noise reduction sharpening filter, with 0 disabling the filter and 3 enabling it at maximum strength. + */ + PostFilterSharpenStrength?: __integerMin0Max3; + /** + * The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value. + */ + Speed?: __integerMinNegative2Max3; + /** + * Relative strength of noise reducing filter. Higher values produce stronger filtering. + */ + Strength?: __integerMin0Max16; + } + export type Order = "ASCENDING"|"DESCENDING"|string; + export interface Output { + /** + * (AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings. + */ + AudioDescriptions?: __listOfAudioDescription; + /** + * (CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one instance of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings. + */ + CaptionDescriptions?: __listOfCaptionDescription; + /** + * Container specific settings. + */ + ContainerSettings?: ContainerSettings; + /** + * Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3) + */ + Extension?: __string; + /** + * Use Name modifier (NameModifier) to have the service add a string to the end of each output filename. You specify the base filename as part of your destination URI. When you create multiple outputs in the same output group, Name modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output group. + */ + NameModifier?: __stringMin1; + /** + * Specific settings for this type of output. + */ + OutputSettings?: OutputSettings; + /** + * Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both. + */ + Preset?: __stringMin0; + /** + * (VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output. + */ + VideoDescription?: VideoDescription; + } + export interface OutputChannelMapping { + /** + * List of input channels + */ + InputChannels?: __listOf__integerMinNegative60Max6; + } + export interface OutputDetail { + /** + * Duration in milliseconds + */ + DurationInMs?: __integer; + /** + * Contains details about the output's video stream + */ + VideoDetails?: VideoDetail; + } + export interface OutputGroup { + /** + * Use Custom Group Name (CustomName) to specify a name for the output group. This value is displayed on the console and can make your job settings JSON more human-readable. It does not affect your outputs. Use up to twelve characters that are either letters, numbers, spaces, or underscores. + */ + CustomName?: __string; + /** + * Name of the output group + */ + Name?: __string; + /** + * Output Group settings, including type + */ + OutputGroupSettings?: OutputGroupSettings; + /** + * This object holds groups of encoding settings, one group of settings per output. + */ + Outputs?: __listOfOutput; + } + export interface OutputGroupDetail { + /** + * Details about the output + */ + OutputDetails?: __listOfOutputDetail; + } + export interface OutputGroupSettings { + /** + * Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output. + */ + CmafGroupSettings?: CmafGroupSettings; + /** + * Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS. + */ + DashIsoGroupSettings?: DashIsoGroupSettings; + /** + * Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS. + */ + FileGroupSettings?: FileGroupSettings; + /** + * Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS. + */ + HlsGroupSettings?: HlsGroupSettings; + /** + * Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS. + */ + MsSmoothGroupSettings?: MsSmoothGroupSettings; + /** + * Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF) + */ + Type?: OutputGroupType; + } + export type OutputGroupType = "HLS_GROUP_SETTINGS"|"DASH_ISO_GROUP_SETTINGS"|"FILE_GROUP_SETTINGS"|"MS_SMOOTH_GROUP_SETTINGS"|"CMAF_GROUP_SETTINGS"|string; + export type OutputSdt = "SDT_FOLLOW"|"SDT_FOLLOW_IF_PRESENT"|"SDT_MANUAL"|"SDT_NONE"|string; + export interface OutputSettings { + /** + * Settings for HLS output groups + */ + HlsSettings?: HlsSettings; + } + export interface Preset { + /** + * An identifier for this resource that is unique within all of AWS. + */ + Arn?: __string; + /** + * An optional category you create to organize your presets. + */ + Category?: __string; + /** + * The timestamp in epoch seconds for preset creation. + */ + CreatedAt?: __timestampUnix; + /** + * An optional description you create for each preset. + */ + Description?: __string; + /** + * The timestamp in epoch seconds when the preset was last updated. + */ + LastUpdated?: __timestampUnix; + /** + * A name you create for each preset. Each name must be unique within your account. + */ + Name: __string; + /** + * Settings for preset + */ + Settings: PresetSettings; + /** + * A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user. + */ + Type?: Type; + } + export type PresetListBy = "NAME"|"CREATION_DATE"|"SYSTEM"|string; + export interface PresetSettings { + /** + * (AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings. + */ + AudioDescriptions?: __listOfAudioDescription; + /** + * Caption settings for this preset. There can be multiple caption settings in a single output. + */ + CaptionDescriptions?: __listOfCaptionDescriptionPreset; + /** + * Container specific settings. + */ + ContainerSettings?: ContainerSettings; + /** + * (VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output. + */ + VideoDescription?: VideoDescription; + } + export type PricingPlan = "ON_DEMAND"|"RESERVED"|string; + export type ProresCodecProfile = "APPLE_PRORES_422"|"APPLE_PRORES_422_HQ"|"APPLE_PRORES_422_LT"|"APPLE_PRORES_422_PROXY"|string; + export type ProresFramerateControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type ProresFramerateConversionAlgorithm = "DUPLICATE_DROP"|"INTERPOLATE"|string; + export type ProresInterlaceMode = "PROGRESSIVE"|"TOP_FIELD"|"BOTTOM_FIELD"|"FOLLOW_TOP_FIELD"|"FOLLOW_BOTTOM_FIELD"|string; + export type ProresParControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export interface ProresSettings { + /** + * Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output. + */ + CodecProfile?: ProresCodecProfile; + /** + * If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. + */ + FramerateControl?: ProresFramerateControl; + /** + * When set to INTERPOLATE, produces smoother motion during frame rate conversion. + */ + FramerateConversionAlgorithm?: ProresFramerateConversionAlgorithm; + /** + * Frame rate denominator. + */ + FramerateDenominator?: __integerMin1Max2147483647; + /** + * When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. + */ + FramerateNumerator?: __integerMin1Max2147483647; + /** + * Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. + - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". + - If the source is progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose. + */ + InterlaceMode?: ProresInterlaceMode; + /** + * Use (ProresParControl) to specify how the service determines the pixel aspect ratio. Set to Follow source (INITIALIZE_FROM_SOURCE) to use the pixel aspect ratio from the input. To specify a different pixel aspect ratio: Using the console, choose it from the dropdown menu. Using the API, set ProresParControl to (SPECIFIED) and provide for (ParNumerator) and (ParDenominator). + */ + ParControl?: ProresParControl; + /** + * Pixel Aspect Ratio denominator. + */ + ParDenominator?: __integerMin1Max2147483647; + /** + * Pixel Aspect Ratio numerator. + */ + ParNumerator?: __integerMin1Max2147483647; + /** + * Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly. + */ + SlowPal?: ProresSlowPal; + /** + * Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player. + */ + Telecine?: ProresTelecine; + } + export type ProresSlowPal = "DISABLED"|"ENABLED"|string; + export type ProresTelecine = "NONE"|"HARD"|string; + export interface Queue { + /** + * An identifier for this resource that is unique within all of AWS. + */ + Arn?: __string; + /** + * The timestamp in epoch seconds for when you created the queue. + */ + CreatedAt?: __timestampUnix; + /** + * An optional description that you create for each queue. + */ + Description?: __string; + /** + * The timestamp in epoch seconds for when you most recently updated the queue. + */ + LastUpdated?: __timestampUnix; + /** + * A name that you create for each queue. Each name must be unique within your account. + */ + Name: __string; + /** + * Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. + */ + PricingPlan?: PricingPlan; + /** + * The estimated number of jobs with a PROGRESSING status. + */ + ProgressingJobsCount?: __integer; + /** + * Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues. + */ + ReservationPlan?: ReservationPlan; + /** + * Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error. + */ + Status?: QueueStatus; + /** + * The estimated number of jobs with a SUBMITTED status. + */ + SubmittedJobsCount?: __integer; + /** + * Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues. + */ + Type?: Type; + } + export type QueueListBy = "NAME"|"CREATION_DATE"|string; + export type QueueStatus = "ACTIVE"|"PAUSED"|string; + export interface Rectangle { + /** + * Height of rectangle in pixels. Specify only even numbers. + */ + Height?: __integerMin2Max2147483647; + /** + * Width of rectangle in pixels. Specify only even numbers. + */ + Width?: __integerMin2Max2147483647; + /** + * The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers. + */ + X?: __integerMin0Max2147483647; + /** + * The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers. + */ + Y?: __integerMin0Max2147483647; + } + export interface RemixSettings { + /** + * Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification). + */ + ChannelMapping?: ChannelMapping; + /** + * Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different. + */ + ChannelsIn?: __integerMin1Max16; + /** + * Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8 + */ + ChannelsOut?: __integerMin1Max8; + } + export type RenewalType = "AUTO_RENEW"|"EXPIRE"|string; + export interface ReservationPlan { + /** + * The length of the term of your reserved queue pricing plan commitment. + */ + Commitment?: Commitment; + /** + * The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires. + */ + ExpiresAt?: __timestampUnix; + /** + * The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue. + */ + PurchasedAt?: __timestampUnix; + /** + * Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. + */ + RenewalType?: RenewalType; + /** + * Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue. + */ + ReservedSlots?: __integer; + /** + * Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED. + */ + Status?: ReservationPlanStatus; + } + export interface ReservationPlanSettings { + /** + * The length of the term of your reserved queue pricing plan commitment. + */ + Commitment: Commitment; + /** + * Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment. + */ + RenewalType: RenewalType; + /** + * Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity. + */ + ReservedSlots: __integer; + } + export type ReservationPlanStatus = "ACTIVE"|"EXPIRED"|string; + export interface ResourceTags { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + Arn?: __string; + /** + * The tags for the resource. + */ + Tags?: __mapOf__string; + } + export type RespondToAfd = "NONE"|"RESPOND"|"PASSTHROUGH"|string; + export interface S3DestinationSettings { + /** + * Settings for how your job outputs are encrypted as they are uploaded to Amazon S3. + */ + Encryption?: S3EncryptionSettings; + } + export interface S3EncryptionSettings { + /** + * Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3 (SERVER_SIDE_ENCRYPTION_S3). If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN (kmsKeyArn). + */ + EncryptionType?: S3ServerSideEncryptionType; + /** + * Optionally, specify the customer master key (CMK) that you want to use to encrypt the data key that AWS uses to encrypt your output content. Enter the Amazon Resource Name (ARN) of the CMK. To use this setting, you must also set Server-side encryption (S3ServerSideEncryptionType) to AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). If you set Server-side encryption to AWS KMS but don't specify a CMK here, AWS uses the AWS managed CMK associated with Amazon S3. + */ + KmsKeyArn?: __stringPatternArnAwsUsGovKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912; + } + export type S3ServerSideEncryptionType = "SERVER_SIDE_ENCRYPTION_S3"|"SERVER_SIDE_ENCRYPTION_KMS"|string; + export type ScalingBehavior = "DEFAULT"|"STRETCH_TO_OUTPUT"|string; + export type SccDestinationFramerate = "FRAMERATE_23_97"|"FRAMERATE_24"|"FRAMERATE_29_97_DROPFRAME"|"FRAMERATE_29_97_NON_DROPFRAME"|string; + export interface SccDestinationSettings { + /** + * Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME). + */ + Framerate?: SccDestinationFramerate; + } + export interface SpekeKeyProvider { + /** + * Optional AWS Certificate Manager ARN for a certificate to send to the keyprovider. The certificate holds a key used by the keyprovider to encrypt the keys in its response. + */ + CertificateArn?: __stringPatternArnAwsUsGovAcm; + /** + * The SPEKE-compliant server uses Resource ID (ResourceId) to identify content. + */ + ResourceId?: __string; + /** + * Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. + */ + SystemIds?: __listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12; + /** + * Use URL (Url) to specify the SPEKE-compliant server that will provide keys for content. + */ + Url?: __stringPatternHttps; + } + export interface StaticKeyProvider { + /** + * Relates to DRM implementation. Sets the value of the KEYFORMAT attribute. Must be 'identity' or a reverse DNS string. May be omitted to indicate an implicit value of 'identity'. + */ + KeyFormat?: __stringPatternIdentityAZaZ26AZaZ09163; + /** + * Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3). + */ + KeyFormatVersions?: __stringPatternDD; + /** + * Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue). + */ + StaticKeyValue?: __stringPatternAZaZ0932; + /** + * Relates to DRM implementation. The location of the license server used for protecting content. + */ + Url?: __string; + } + export type StatusUpdateInterval = "SECONDS_10"|"SECONDS_12"|"SECONDS_15"|"SECONDS_20"|"SECONDS_30"|"SECONDS_60"|"SECONDS_120"|"SECONDS_180"|"SECONDS_240"|"SECONDS_300"|"SECONDS_360"|"SECONDS_420"|"SECONDS_480"|"SECONDS_540"|"SECONDS_600"|string; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name. + */ + Arn: __string; + /** + * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. + */ + Tags: __mapOf__string; + } + export interface TagResourceResponse { + } + export interface TeletextDestinationSettings { + /** + * Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of Teletext data, do not use this field. + */ + PageNumber?: __stringMin3Max3Pattern1809aFAF09aEAE; + } + export interface TeletextSourceSettings { + /** + * Use Page Number (PageNumber) to specify the three-digit hexadecimal page number that will be used for Teletext captions. Do not use this setting if you are passing through teletext from the input source to output. + */ + PageNumber?: __stringMin3Max3Pattern1809aFAF09aEAE; + } + export interface TimecodeBurnin { + /** + * Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48. + */ + FontSize?: __integerMin10Max48; + /** + * Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode on output video. + */ + Position?: TimecodeBurninPosition; + /** + * Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For example, a prefix of "EZ-" will result in the timecode "EZ-00:00:00:00". Provide either the characters themselves or the ASCII code equivalents. The supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters represented on a standard English keyboard. + */ + Prefix?: __stringPattern; + } + export type TimecodeBurninPosition = "TOP_CENTER"|"TOP_LEFT"|"TOP_RIGHT"|"MIDDLE_LEFT"|"MIDDLE_CENTER"|"MIDDLE_RIGHT"|"BOTTOM_LEFT"|"BOTTOM_CENTER"|"BOTTOM_RIGHT"|string; + export interface TimecodeConfig { + /** + * If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores frame rate conversion. System behavior for Anchor Timecode varies depending on your setting for Source (TimecodeSource). * If Source (TimecodeSource) is set to Specified Start (SPECIFIEDSTART), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Source (TimecodeSource) is set to Start at 0 (ZEROBASED) the first frame is 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED), the first frame is the timecode value on the first input frame of the input. + */ + Anchor?: __stringPattern010920405090509092; + /** + * Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value. + */ + Source?: TimecodeSource; + /** + * Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). + */ + Start?: __stringPattern010920405090509092; + /** + * Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format "yyyy-mm-dd". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25. + */ + TimestampOffset?: __stringPattern0940191020191209301; + } + export type TimecodeSource = "EMBEDDED"|"ZEROBASED"|"SPECIFIEDSTART"|string; + export type TimedMetadata = "PASSTHROUGH"|"NONE"|string; + export interface TimedMetadataInsertion { + /** + * Id3Insertions contains the array of Id3Insertion instances. + */ + Id3Insertions?: __listOfId3Insertion; + } + export interface Timing { + /** + * The time, in Unix epoch format, that the transcoding job finished + */ + FinishTime?: __timestampUnix; + /** + * The time, in Unix epoch format, that transcoding for the job began. + */ + StartTime?: __timestampUnix; + /** + * The time, in Unix epoch format, that you submitted the job. + */ + SubmitTime?: __timestampUnix; + } + export interface TrackSourceSettings { + /** + * Use this setting to select a single captions track from a source. Track numbers correspond to the order in the captions source file. For IMF sources, track numbering is based on the order that the captions appear in the CPL. For example, use 1 to select the captions asset that is listed first in the CPL. To include more than one captions track in your job outputs, create multiple input captions selectors. Specify one track per selector. + */ + TrackNumber?: __integerMin1Max2147483647; + } + export interface TtmlDestinationSettings { + /** + * Pass through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. + */ + StylePassthrough?: TtmlStylePassthrough; + } + export type TtmlStylePassthrough = "ENABLED"|"DISABLED"|string; + export type Type = "SYSTEM"|"CUSTOM"|string; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name. + */ + Arn: __string; + /** + * The keys of the tags that you want to remove from the resource. + */ + TagKeys?: __listOf__string; + } + export interface UntagResourceResponse { + } + export interface UpdateJobTemplateRequest { + /** + * Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. + */ + AccelerationSettings?: AccelerationSettings; + /** + * The new category for the job template, if you are changing it. + */ + Category?: __string; + /** + * The new description for the job template, if you are changing it. + */ + Description?: __string; + /** + * The name of the job template you are modifying + */ + Name: __string; + /** + * The new queue for the job template, if you are changing it. + */ + Queue?: __string; + /** + * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it. + */ + Settings?: JobTemplateSettings; + /** + * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. + */ + StatusUpdateInterval?: StatusUpdateInterval; + } + export interface UpdateJobTemplateResponse { + /** + * A job template is a pre-made set of encoding instructions that you can use to quickly create a job. + */ + JobTemplate?: JobTemplate; + } + export interface UpdatePresetRequest { + /** + * The new category for the preset, if you are changing it. + */ + Category?: __string; + /** + * The new description for the preset, if you are changing it. + */ + Description?: __string; + /** + * The name of the preset you are modifying. + */ + Name: __string; + /** + * Settings for preset + */ + Settings?: PresetSettings; + } + export interface UpdatePresetResponse { + /** + * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process. + */ + Preset?: Preset; + } + export interface UpdateQueueRequest { + /** + * The new description for the queue, if you are changing it. + */ + Description?: __string; + /** + * The name of the queue that you are modifying. + */ + Name: __string; + /** + * The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them. + */ + ReservationPlanSettings?: ReservationPlanSettings; + /** + * Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error. + */ + Status?: QueueStatus; + } + export interface UpdateQueueResponse { + /** + * You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html. + */ + Queue?: Queue; + } + export type VideoCodec = "FRAME_CAPTURE"|"H_264"|"H_265"|"MPEG2"|"PRORES"|string; + export interface VideoCodecSettings { + /** + * Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec. + */ + Codec?: VideoCodec; + /** + * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE. + */ + FrameCaptureSettings?: FrameCaptureSettings; + /** + * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264. + */ + H264Settings?: H264Settings; + /** + * Settings for H265 codec + */ + H265Settings?: H265Settings; + /** + * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2. + */ + Mpeg2Settings?: Mpeg2Settings; + /** + * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES. + */ + ProresSettings?: ProresSettings; + } + export interface VideoDescription { + /** + * This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data. + */ + AfdSignaling?: AfdSignaling; + /** + * The service automatically applies the anti-alias filter to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting. + */ + AntiAlias?: AntiAlias; + /** + * Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value you choose for Video codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings + */ + CodecSettings?: VideoCodecSettings; + /** + * Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled by default. + */ + ColorMetadata?: ColorMetadata; + /** + * Applies only if your input aspect ratio is different from your output aspect ratio. Use Input cropping rectangle (Crop) to specify the video area the service will include in the output. This will crop the input source, causing video pixels to be removed on encode. If you crop your input frame size to smaller than your output frame size, make sure to specify the behavior you want in your output setting "Scaling behavior". + */ + Crop?: Rectangle; + /** + * Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled. + */ + DropFrameTimecode?: DropFrameTimecode; + /** + * Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output. + */ + FixedAfd?: __integerMin0Max15; + /** + * Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height. + */ + Height?: __integerMin32Max2160; + /** + * Use Position (Position) to point to a rectangle object to define your position. This setting overrides any other aspect ratio. + */ + Position?: Rectangle; + /** + * Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output. + */ + RespondToAfd?: RespondToAfd; + /** + * Applies only if your input aspect ratio is different from your output aspect ratio. Choose "Stretch to output" to have the service stretch your video image to fit. Keep the setting "Default" to allow the service to letterbox your video instead. This setting overrides any positioning value you specify elsewhere in the job. + */ + ScalingBehavior?: ScalingBehavior; + /** + * Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content. + */ + Sharpness?: __integerMin0Max100; + /** + * Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does. + */ + TimecodeInsertion?: VideoTimecodeInsertion; + /** + * Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default. + */ + VideoPreprocessors?: VideoPreprocessor; + /** + * Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width. + */ + Width?: __integerMin32Max4096; + } + export interface VideoDetail { + /** + * Height in pixels for the output + */ + HeightInPx?: __integer; + /** + * Width in pixels for the output + */ + WidthInPx?: __integer; + } + export interface VideoPreprocessor { + /** + * Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. + */ + ColorCorrector?: ColorCorrector; + /** + * Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture. + */ + Deinterlacer?: Deinterlacer; + /** + * Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default. + */ + ImageInserter?: ImageInserter; + /** + * Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. + */ + NoiseReducer?: NoiseReducer; + /** + * Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output. + */ + TimecodeBurnin?: TimecodeBurnin; + } + export interface VideoSelector { + /** + * If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value FOLLOW. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values. + */ + ColorSpace?: ColorSpace; + /** + * There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available. + */ + ColorSpaceUsage?: ColorSpaceUsage; + /** + * Use the "HDR master display information" (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the following settings. Set "MP4 packaging type" (writeMp4PackagingType) to HVC1 (HVC1). Set "Profile" (H265Settings > codecProfile) to Main10/High (MAIN10_HIGH). Set "Level" (H265Settings > codecLevel) to 5 (LEVEL_5). + */ + Hdr10Metadata?: Hdr10Metadata; + /** + * Use PID (Pid) to select specific video data from an input file. Specify this value as an integer; the system automatically converts it to the hexidecimal value. For example, 257 selects PID 0x101. A PID, or packet identifier, is an identifier for a set of data in an MPEG-2 transport stream container. + */ + Pid?: __integerMin1Max2147483647; + /** + * Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. + */ + ProgramNumber?: __integerMinNegative2147483648Max2147483647; + /** + * Use Rotate (InputRotate) to specify how the service rotates your video. You can choose automatic rotation or specify a rotation. You can specify a clockwise rotation of 0, 90, 180, or 270 degrees. If your input video container is .mov or .mp4 and your input has rotation metadata, you can choose Automatic to have the service rotate your video according to the rotation specified in the metadata. The rotation must be within one degree of 90, 180, or 270 degrees. If the rotation metadata specifies any other rotation, the service will default to no rotation. By default, the service does no rotation, even if your input video has rotation metadata. The service doesn't pass through rotation metadata. + */ + Rotate?: InputRotate; + } + export type VideoTimecodeInsertion = "DISABLED"|"PIC_TIMING_SEI"|string; + export type WavFormat = "RIFF"|"RF64"|string; + export interface WavSettings { + /** + * Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track. + */ + BitDepth?: __integerMin16Max24; + /** + * Set Channels to specify the number of channels in this output audio track. With WAV, valid values 1, 2, 4, and 8. In the console, these values are Mono, Stereo, 4-Channel, and 8-Channel, respectively. + */ + Channels?: __integerMin1Max8; + /** + * The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64. + */ + Format?: WavFormat; + /** + * Sample rate in Hz. + */ + SampleRate?: __integerMin8000Max192000; + } + export type __doubleMin0 = number; + export type __doubleMin0Max2147483647 = number; + export type __doubleMinNegative59Max0 = number; + export type __doubleMinNegative60Max3 = number; + export type __doubleMinNegative60MaxNegative1 = number; + export type __integer = number; + export type __integerMin0Max10 = number; + export type __integerMin0Max100 = number; + export type __integerMin0Max1000 = number; + export type __integerMin0Max10000 = number; + export type __integerMin0Max1152000000 = number; + export type __integerMin0Max128 = number; + export type __integerMin0Max1466400000 = number; + export type __integerMin0Max15 = number; + export type __integerMin0Max16 = number; + export type __integerMin0Max2147483647 = number; + export type __integerMin0Max255 = number; + export type __integerMin0Max3 = number; + export type __integerMin0Max30 = number; + export type __integerMin0Max30000 = number; + export type __integerMin0Max3600 = number; + export type __integerMin0Max47185920 = number; + export type __integerMin0Max500 = number; + export type __integerMin0Max50000 = number; + export type __integerMin0Max65535 = number; + export type __integerMin0Max7 = number; + export type __integerMin0Max8 = number; + export type __integerMin0Max9 = number; + export type __integerMin0Max96 = number; + export type __integerMin0Max99 = number; + export type __integerMin1000Max1152000000 = number; + export type __integerMin1000Max1466400000 = number; + export type __integerMin1000Max288000000 = number; + export type __integerMin1000Max30000 = number; + export type __integerMin1000Max300000000 = number; + export type __integerMin10Max48 = number; + export type __integerMin16Max24 = number; + export type __integerMin1Max1 = number; + export type __integerMin1Max10 = number; + export type __integerMin1Max100 = number; + export type __integerMin1Max10000000 = number; + export type __integerMin1Max1001 = number; + export type __integerMin1Max16 = number; + export type __integerMin1Max17895697 = number; + export type __integerMin1Max2 = number; + export type __integerMin1Max20 = number; + export type __integerMin1Max2147483640 = number; + export type __integerMin1Max2147483647 = number; + export type __integerMin1Max31 = number; + export type __integerMin1Max32 = number; + export type __integerMin1Max4 = number; + export type __integerMin1Max6 = number; + export type __integerMin1Max8 = number; + export type __integerMin24Max60000 = number; + export type __integerMin25Max10000 = number; + export type __integerMin25Max2000 = number; + export type __integerMin2Max2147483647 = number; + export type __integerMin32000Max384000 = number; + export type __integerMin32000Max48000 = number; + export type __integerMin32Max2160 = number; + export type __integerMin32Max4096 = number; + export type __integerMin32Max8182 = number; + export type __integerMin48000Max48000 = number; + export type __integerMin6000Max1024000 = number; + export type __integerMin64000Max640000 = number; + export type __integerMin8000Max192000 = number; + export type __integerMin8000Max96000 = number; + export type __integerMin96Max600 = number; + export type __integerMinNegative1000Max1000 = number; + export type __integerMinNegative180Max180 = number; + export type __integerMinNegative2147483648Max2147483647 = number; + export type __integerMinNegative2Max3 = number; + export type __integerMinNegative5Max5 = number; + export type __integerMinNegative60Max6 = number; + export type __integerMinNegative70Max0 = number; + export type __listOfAudioDescription = AudioDescription[]; + export type __listOfCaptionDescription = CaptionDescription[]; + export type __listOfCaptionDescriptionPreset = CaptionDescriptionPreset[]; + export type __listOfEndpoint = Endpoint[]; + export type __listOfHlsAdMarkers = HlsAdMarkers[]; + export type __listOfHlsCaptionLanguageMapping = HlsCaptionLanguageMapping[]; + export type __listOfId3Insertion = Id3Insertion[]; + export type __listOfInput = Input[]; + export type __listOfInputClipping = InputClipping[]; + export type __listOfInputTemplate = InputTemplate[]; + export type __listOfInsertableImage = InsertableImage[]; + export type __listOfJob = Job[]; + export type __listOfJobTemplate = JobTemplate[]; + export type __listOfOutput = Output[]; + export type __listOfOutputChannelMapping = OutputChannelMapping[]; + export type __listOfOutputDetail = OutputDetail[]; + export type __listOfOutputGroup = OutputGroup[]; + export type __listOfOutputGroupDetail = OutputGroupDetail[]; + export type __listOfPreset = Preset[]; + export type __listOfQueue = Queue[]; + export type __listOf__integerMin1Max2147483647 = __integerMin1Max2147483647[]; + export type __listOf__integerMin32Max8182 = __integerMin32Max8182[]; + export type __listOf__integerMinNegative60Max6 = __integerMinNegative60Max6[]; + export type __listOf__string = __string[]; + export type __listOf__stringMin1 = __stringMin1[]; + export type __listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12 = __stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12[]; + export type __listOf__stringPatternS3ASSETMAPXml = __stringPatternS3ASSETMAPXml[]; + export type __mapOfAudioSelector = {[key: string]: AudioSelector}; + export type __mapOfAudioSelectorGroup = {[key: string]: AudioSelectorGroup}; + export type __mapOfCaptionSelector = {[key: string]: CaptionSelector}; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + export type __stringMin0 = string; + export type __stringMin1 = string; + export type __stringMin11Max11Pattern01D20305D205D = string; + export type __stringMin14Max1285PatternS3Mov09Png = string; + export type __stringMin14PatternS3BmpBMPPngPNG = string; + export type __stringMin14PatternS3BmpBMPPngPNGTgaTGA = string; + export type __stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTSmiSMI = string; + export type __stringMin16Max24PatternAZaZ0922AZaZ0916 = string; + export type __stringMin1Max256 = string; + export type __stringMin24Max512PatternAZaZ0902 = string; + export type __stringMin32Max32Pattern09aFAF32 = string; + export type __stringMin3Max3Pattern1809aFAF09aEAE = string; + export type __stringMin3Max3PatternAZaZ3 = string; + export type __stringMin9Max19PatternAZ26EastWestCentralNorthSouthEastWest1912 = string; + export type __stringPattern = string; + export type __stringPattern010920405090509092 = string; + export type __stringPattern01D20305D205D = string; + export type __stringPattern0940191020191209301 = string; + export type __stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12 = string; + export type __stringPatternAZaZ0902 = string; + export type __stringPatternAZaZ0932 = string; + export type __stringPatternArnAwsUsGovAcm = string; + export type __stringPatternArnAwsUsGovKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912 = string; + export type __stringPatternDD = string; + export type __stringPatternHttps = string; + export type __stringPatternIdentityAZaZ26AZaZ09163 = string; + export type __stringPatternS3 = string; + export type __stringPatternS3ASSETMAPXml = string; + export type __stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE = string; + export type __stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL = string; + export type __stringPatternSNManifestConfirmConditionNotificationNS = string; + export type __stringPatternSNSignalProcessingNotificationNS = string; + export type __stringPatternWS = string; + export type __timestampUnix = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-08-29"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MediaConvert client. + */ + export import Types = MediaConvert; +} +export = MediaConvert; diff --git a/node_modules/aws-sdk/clients/mediaconvert.js b/node_modules/aws-sdk/clients/mediaconvert.js new file mode 100644 index 0000000..2ebc6e5 --- /dev/null +++ b/node_modules/aws-sdk/clients/mediaconvert.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mediaconvert'] = {}; +AWS.MediaConvert = Service.defineService('mediaconvert', ['2017-08-29']); +Object.defineProperty(apiLoader.services['mediaconvert'], '2017-08-29', { + get: function get() { + var model = require('../apis/mediaconvert-2017-08-29.min.json'); + model.paginators = require('../apis/mediaconvert-2017-08-29.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MediaConvert; diff --git a/node_modules/aws-sdk/clients/medialive.d.ts b/node_modules/aws-sdk/clients/medialive.d.ts new file mode 100644 index 0000000..ee43507 --- /dev/null +++ b/node_modules/aws-sdk/clients/medialive.d.ts @@ -0,0 +1,4319 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MediaLive extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MediaLive.Types.ClientConfiguration) + config: Config & MediaLive.Types.ClientConfiguration; + /** + * Update a channel schedule + */ + batchUpdateSchedule(params: MediaLive.Types.BatchUpdateScheduleRequest, callback?: (err: AWSError, data: MediaLive.Types.BatchUpdateScheduleResponse) => void): Request; + /** + * Update a channel schedule + */ + batchUpdateSchedule(callback?: (err: AWSError, data: MediaLive.Types.BatchUpdateScheduleResponse) => void): Request; + /** + * Creates a new channel + */ + createChannel(params: MediaLive.Types.CreateChannelRequest, callback?: (err: AWSError, data: MediaLive.Types.CreateChannelResponse) => void): Request; + /** + * Creates a new channel + */ + createChannel(callback?: (err: AWSError, data: MediaLive.Types.CreateChannelResponse) => void): Request; + /** + * Create an input + */ + createInput(params: MediaLive.Types.CreateInputRequest, callback?: (err: AWSError, data: MediaLive.Types.CreateInputResponse) => void): Request; + /** + * Create an input + */ + createInput(callback?: (err: AWSError, data: MediaLive.Types.CreateInputResponse) => void): Request; + /** + * Creates a Input Security Group + */ + createInputSecurityGroup(params: MediaLive.Types.CreateInputSecurityGroupRequest, callback?: (err: AWSError, data: MediaLive.Types.CreateInputSecurityGroupResponse) => void): Request; + /** + * Creates a Input Security Group + */ + createInputSecurityGroup(callback?: (err: AWSError, data: MediaLive.Types.CreateInputSecurityGroupResponse) => void): Request; + /** + * Create tags for a resource + */ + createTags(params: MediaLive.Types.CreateTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Create tags for a resource + */ + createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts deletion of channel. The associated outputs are also deleted. + */ + deleteChannel(params: MediaLive.Types.DeleteChannelRequest, callback?: (err: AWSError, data: MediaLive.Types.DeleteChannelResponse) => void): Request; + /** + * Starts deletion of channel. The associated outputs are also deleted. + */ + deleteChannel(callback?: (err: AWSError, data: MediaLive.Types.DeleteChannelResponse) => void): Request; + /** + * Deletes the input end point + */ + deleteInput(params: MediaLive.Types.DeleteInputRequest, callback?: (err: AWSError, data: MediaLive.Types.DeleteInputResponse) => void): Request; + /** + * Deletes the input end point + */ + deleteInput(callback?: (err: AWSError, data: MediaLive.Types.DeleteInputResponse) => void): Request; + /** + * Deletes an Input Security Group + */ + deleteInputSecurityGroup(params: MediaLive.Types.DeleteInputSecurityGroupRequest, callback?: (err: AWSError, data: MediaLive.Types.DeleteInputSecurityGroupResponse) => void): Request; + /** + * Deletes an Input Security Group + */ + deleteInputSecurityGroup(callback?: (err: AWSError, data: MediaLive.Types.DeleteInputSecurityGroupResponse) => void): Request; + /** + * Delete an expired reservation. + */ + deleteReservation(params: MediaLive.Types.DeleteReservationRequest, callback?: (err: AWSError, data: MediaLive.Types.DeleteReservationResponse) => void): Request; + /** + * Delete an expired reservation. + */ + deleteReservation(callback?: (err: AWSError, data: MediaLive.Types.DeleteReservationResponse) => void): Request; + /** + * Delete all schedule actions on a channel. + */ + deleteSchedule(params: MediaLive.Types.DeleteScheduleRequest, callback?: (err: AWSError, data: MediaLive.Types.DeleteScheduleResponse) => void): Request; + /** + * Delete all schedule actions on a channel. + */ + deleteSchedule(callback?: (err: AWSError, data: MediaLive.Types.DeleteScheduleResponse) => void): Request; + /** + * Removes tags for a resource + */ + deleteTags(params: MediaLive.Types.DeleteTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags for a resource + */ + deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets details about a channel + */ + describeChannel(params: MediaLive.Types.DescribeChannelRequest, callback?: (err: AWSError, data: MediaLive.Types.DescribeChannelResponse) => void): Request; + /** + * Gets details about a channel + */ + describeChannel(callback?: (err: AWSError, data: MediaLive.Types.DescribeChannelResponse) => void): Request; + /** + * Produces details about an input + */ + describeInput(params: MediaLive.Types.DescribeInputRequest, callback?: (err: AWSError, data: MediaLive.Types.DescribeInputResponse) => void): Request; + /** + * Produces details about an input + */ + describeInput(callback?: (err: AWSError, data: MediaLive.Types.DescribeInputResponse) => void): Request; + /** + * Produces a summary of an Input Security Group + */ + describeInputSecurityGroup(params: MediaLive.Types.DescribeInputSecurityGroupRequest, callback?: (err: AWSError, data: MediaLive.Types.DescribeInputSecurityGroupResponse) => void): Request; + /** + * Produces a summary of an Input Security Group + */ + describeInputSecurityGroup(callback?: (err: AWSError, data: MediaLive.Types.DescribeInputSecurityGroupResponse) => void): Request; + /** + * Get details for an offering. + */ + describeOffering(params: MediaLive.Types.DescribeOfferingRequest, callback?: (err: AWSError, data: MediaLive.Types.DescribeOfferingResponse) => void): Request; + /** + * Get details for an offering. + */ + describeOffering(callback?: (err: AWSError, data: MediaLive.Types.DescribeOfferingResponse) => void): Request; + /** + * Get details for a reservation. + */ + describeReservation(params: MediaLive.Types.DescribeReservationRequest, callback?: (err: AWSError, data: MediaLive.Types.DescribeReservationResponse) => void): Request; + /** + * Get details for a reservation. + */ + describeReservation(callback?: (err: AWSError, data: MediaLive.Types.DescribeReservationResponse) => void): Request; + /** + * Get a channel schedule + */ + describeSchedule(params: MediaLive.Types.DescribeScheduleRequest, callback?: (err: AWSError, data: MediaLive.Types.DescribeScheduleResponse) => void): Request; + /** + * Get a channel schedule + */ + describeSchedule(callback?: (err: AWSError, data: MediaLive.Types.DescribeScheduleResponse) => void): Request; + /** + * Produces list of channels that have been created + */ + listChannels(params: MediaLive.Types.ListChannelsRequest, callback?: (err: AWSError, data: MediaLive.Types.ListChannelsResponse) => void): Request; + /** + * Produces list of channels that have been created + */ + listChannels(callback?: (err: AWSError, data: MediaLive.Types.ListChannelsResponse) => void): Request; + /** + * Produces a list of Input Security Groups for an account + */ + listInputSecurityGroups(params: MediaLive.Types.ListInputSecurityGroupsRequest, callback?: (err: AWSError, data: MediaLive.Types.ListInputSecurityGroupsResponse) => void): Request; + /** + * Produces a list of Input Security Groups for an account + */ + listInputSecurityGroups(callback?: (err: AWSError, data: MediaLive.Types.ListInputSecurityGroupsResponse) => void): Request; + /** + * Produces list of inputs that have been created + */ + listInputs(params: MediaLive.Types.ListInputsRequest, callback?: (err: AWSError, data: MediaLive.Types.ListInputsResponse) => void): Request; + /** + * Produces list of inputs that have been created + */ + listInputs(callback?: (err: AWSError, data: MediaLive.Types.ListInputsResponse) => void): Request; + /** + * List offerings available for purchase. + */ + listOfferings(params: MediaLive.Types.ListOfferingsRequest, callback?: (err: AWSError, data: MediaLive.Types.ListOfferingsResponse) => void): Request; + /** + * List offerings available for purchase. + */ + listOfferings(callback?: (err: AWSError, data: MediaLive.Types.ListOfferingsResponse) => void): Request; + /** + * List purchased reservations. + */ + listReservations(params: MediaLive.Types.ListReservationsRequest, callback?: (err: AWSError, data: MediaLive.Types.ListReservationsResponse) => void): Request; + /** + * List purchased reservations. + */ + listReservations(callback?: (err: AWSError, data: MediaLive.Types.ListReservationsResponse) => void): Request; + /** + * Produces list of tags that have been created for a resource + */ + listTagsForResource(params: MediaLive.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaLive.Types.ListTagsForResourceResponse) => void): Request; + /** + * Produces list of tags that have been created for a resource + */ + listTagsForResource(callback?: (err: AWSError, data: MediaLive.Types.ListTagsForResourceResponse) => void): Request; + /** + * Purchase an offering and create a reservation. + */ + purchaseOffering(params: MediaLive.Types.PurchaseOfferingRequest, callback?: (err: AWSError, data: MediaLive.Types.PurchaseOfferingResponse) => void): Request; + /** + * Purchase an offering and create a reservation. + */ + purchaseOffering(callback?: (err: AWSError, data: MediaLive.Types.PurchaseOfferingResponse) => void): Request; + /** + * Starts an existing channel + */ + startChannel(params: MediaLive.Types.StartChannelRequest, callback?: (err: AWSError, data: MediaLive.Types.StartChannelResponse) => void): Request; + /** + * Starts an existing channel + */ + startChannel(callback?: (err: AWSError, data: MediaLive.Types.StartChannelResponse) => void): Request; + /** + * Stops a running channel + */ + stopChannel(params: MediaLive.Types.StopChannelRequest, callback?: (err: AWSError, data: MediaLive.Types.StopChannelResponse) => void): Request; + /** + * Stops a running channel + */ + stopChannel(callback?: (err: AWSError, data: MediaLive.Types.StopChannelResponse) => void): Request; + /** + * Updates a channel. + */ + updateChannel(params: MediaLive.Types.UpdateChannelRequest, callback?: (err: AWSError, data: MediaLive.Types.UpdateChannelResponse) => void): Request; + /** + * Updates a channel. + */ + updateChannel(callback?: (err: AWSError, data: MediaLive.Types.UpdateChannelResponse) => void): Request; + /** + * Changes the class of the channel. + */ + updateChannelClass(params: MediaLive.Types.UpdateChannelClassRequest, callback?: (err: AWSError, data: MediaLive.Types.UpdateChannelClassResponse) => void): Request; + /** + * Changes the class of the channel. + */ + updateChannelClass(callback?: (err: AWSError, data: MediaLive.Types.UpdateChannelClassResponse) => void): Request; + /** + * Updates an input. + */ + updateInput(params: MediaLive.Types.UpdateInputRequest, callback?: (err: AWSError, data: MediaLive.Types.UpdateInputResponse) => void): Request; + /** + * Updates an input. + */ + updateInput(callback?: (err: AWSError, data: MediaLive.Types.UpdateInputResponse) => void): Request; + /** + * Update an Input Security Group's Whilelists. + */ + updateInputSecurityGroup(params: MediaLive.Types.UpdateInputSecurityGroupRequest, callback?: (err: AWSError, data: MediaLive.Types.UpdateInputSecurityGroupResponse) => void): Request; + /** + * Update an Input Security Group's Whilelists. + */ + updateInputSecurityGroup(callback?: (err: AWSError, data: MediaLive.Types.UpdateInputSecurityGroupResponse) => void): Request; + /** + * Update reservation. + */ + updateReservation(params: MediaLive.Types.UpdateReservationRequest, callback?: (err: AWSError, data: MediaLive.Types.UpdateReservationResponse) => void): Request; + /** + * Update reservation. + */ + updateReservation(callback?: (err: AWSError, data: MediaLive.Types.UpdateReservationResponse) => void): Request; +} +declare namespace MediaLive { + export type AacCodingMode = "AD_RECEIVER_MIX"|"CODING_MODE_1_0"|"CODING_MODE_1_1"|"CODING_MODE_2_0"|"CODING_MODE_5_1"|string; + export type AacInputType = "BROADCASTER_MIXED_AD"|"NORMAL"|string; + export type AacProfile = "HEV1"|"HEV2"|"LC"|string; + export type AacRateControlMode = "CBR"|"VBR"|string; + export type AacRawFormat = "LATM_LOAS"|"NONE"|string; + export interface AacSettings { + /** + * Average bitrate in bits/second. Valid values depend on rate control mode and profile. + */ + Bitrate?: __double; + /** + * Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. + */ + CodingMode?: AacCodingMode; + /** + * Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. + +Leave set to "normal" when input does not contain pre-mixed audio + AD. + */ + InputType?: AacInputType; + /** + * AAC Profile. + */ + Profile?: AacProfile; + /** + * Rate Control Mode. + */ + RateControlMode?: AacRateControlMode; + /** + * Sets LATM / LOAS AAC output for raw containers. + */ + RawFormat?: AacRawFormat; + /** + * Sample rate in Hz. Valid values depend on rate control mode and profile. + */ + SampleRate?: __double; + /** + * Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. + */ + Spec?: AacSpec; + /** + * VBR Quality Level - Only used if rateControlMode is VBR. + */ + VbrQuality?: AacVbrQuality; + } + export type AacSpec = "MPEG2"|"MPEG4"|string; + export type AacVbrQuality = "HIGH"|"LOW"|"MEDIUM_HIGH"|"MEDIUM_LOW"|string; + export type Ac3BitstreamMode = "COMMENTARY"|"COMPLETE_MAIN"|"DIALOGUE"|"EMERGENCY"|"HEARING_IMPAIRED"|"MUSIC_AND_EFFECTS"|"VISUALLY_IMPAIRED"|"VOICE_OVER"|string; + export type Ac3CodingMode = "CODING_MODE_1_0"|"CODING_MODE_1_1"|"CODING_MODE_2_0"|"CODING_MODE_3_2_LFE"|string; + export type Ac3DrcProfile = "FILM_STANDARD"|"NONE"|string; + export type Ac3LfeFilter = "DISABLED"|"ENABLED"|string; + export type Ac3MetadataControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export interface Ac3Settings { + /** + * Average bitrate in bits/second. Valid bitrates depend on the coding mode. + */ + Bitrate?: __double; + /** + * Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. + */ + BitstreamMode?: Ac3BitstreamMode; + /** + * Dolby Digital coding mode. Determines number of channels. + */ + CodingMode?: Ac3CodingMode; + /** + * Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. + */ + Dialnorm?: __integerMin1Max31; + /** + * If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. + */ + DrcProfile?: Ac3DrcProfile; + /** + * When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. + */ + LfeFilter?: Ac3LfeFilter; + /** + * When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. + */ + MetadataControl?: Ac3MetadataControl; + } + export type AfdSignaling = "AUTO"|"FIXED"|"NONE"|string; + export interface ArchiveContainerSettings { + M2tsSettings?: M2tsSettings; + } + export interface ArchiveGroupSettings { + /** + * A directory and base filename where archive files should be written. + */ + Destination: OutputLocationRef; + /** + * Number of seconds to write to archive file before closing and starting a new one. + */ + RolloverInterval?: __integerMin1; + } + export interface ArchiveOutputSettings { + /** + * Settings specific to the container type of the file. + */ + ContainerSettings: ArchiveContainerSettings; + /** + * Output file extension. If excluded, this will be auto-selected from the container type. + */ + Extension?: __string; + /** + * String concatenated to the end of the destination filename. Required for multiple outputs of the same type. + */ + NameModifier?: __string; + } + export interface AribDestinationSettings { + } + export interface AribSourceSettings { + } + export interface AudioChannelMapping { + /** + * Indices and gain values for each input channel that should be remixed into this output channel. + */ + InputChannelLevels: __listOfInputChannelLevel; + /** + * The index of the output channel being produced. + */ + OutputChannel: __integerMin0Max7; + } + export interface AudioCodecSettings { + AacSettings?: AacSettings; + Ac3Settings?: Ac3Settings; + Eac3Settings?: Eac3Settings; + Mp2Settings?: Mp2Settings; + PassThroughSettings?: PassThroughSettings; + } + export interface AudioDescription { + /** + * Advanced audio normalization settings. + */ + AudioNormalizationSettings?: AudioNormalizationSettings; + /** + * The name of the AudioSelector used as the source for this AudioDescription. + */ + AudioSelectorName: __string; + /** + * Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. + */ + AudioType?: AudioType; + /** + * Determines how audio type is determined. + followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. + useConfigured: The value in Audio Type is included in the output. +Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. + */ + AudioTypeControl?: AudioDescriptionAudioTypeControl; + /** + * Audio codec settings. + */ + CodecSettings?: AudioCodecSettings; + /** + * Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. + */ + LanguageCode?: __stringMin3Max3; + /** + * Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. + */ + LanguageCodeControl?: AudioDescriptionLanguageCodeControl; + /** + * The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. + */ + Name: __string; + /** + * Settings that control how input audio channels are remixed into the output audio channels. + */ + RemixSettings?: RemixSettings; + /** + * Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). + */ + StreamName?: __string; + } + export type AudioDescriptionAudioTypeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export type AudioDescriptionLanguageCodeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export interface AudioLanguageSelection { + /** + * Selects a specific three-letter language code from within an audio source. + */ + LanguageCode: __string; + /** + * When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. + */ + LanguageSelectionPolicy?: AudioLanguageSelectionPolicy; + } + export type AudioLanguageSelectionPolicy = "LOOSE"|"STRICT"|string; + export type AudioNormalizationAlgorithm = "ITU_1770_1"|"ITU_1770_2"|string; + export type AudioNormalizationAlgorithmControl = "CORRECT_AUDIO"|string; + export interface AudioNormalizationSettings { + /** + * Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. + */ + Algorithm?: AudioNormalizationAlgorithm; + /** + * When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. + */ + AlgorithmControl?: AudioNormalizationAlgorithmControl; + /** + * Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS. + */ + TargetLkfs?: __doubleMinNegative59Max0; + } + export interface AudioOnlyHlsSettings { + /** + * Specifies the group to which the audio Rendition belongs. + */ + AudioGroupId?: __string; + /** + * For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}. + */ + AudioOnlyImage?: InputLocation; + /** + * Four types of audio-only tracks are supported: + +Audio-Only Variant Stream +The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. + +Alternate Audio, Auto Select, Default +Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES + +Alternate Audio, Auto Select, Not Default +Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES + +Alternate Audio, not Auto Select +Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO + */ + AudioTrackType?: AudioOnlyHlsTrackType; + } + export type AudioOnlyHlsTrackType = "ALTERNATE_AUDIO_AUTO_SELECT"|"ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"|"ALTERNATE_AUDIO_NOT_AUTO_SELECT"|"AUDIO_ONLY_VARIANT_STREAM"|string; + export interface AudioPidSelection { + /** + * Selects a specific PID from within a source. + */ + Pid: __integerMin0Max8191; + } + export interface AudioSelector { + /** + * The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. + */ + Name: __stringMin1; + /** + * The audio selector settings. + */ + SelectorSettings?: AudioSelectorSettings; + } + export interface AudioSelectorSettings { + AudioLanguageSelection?: AudioLanguageSelection; + AudioPidSelection?: AudioPidSelection; + } + export type AudioType = "CLEAN_EFFECTS"|"HEARING_IMPAIRED"|"UNDEFINED"|"VISUAL_IMPAIRED_COMMENTARY"|string; + export type AuthenticationScheme = "AKAMAI"|"COMMON"|string; + export interface AvailBlanking { + /** + * Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. + */ + AvailBlankingImage?: InputLocation; + /** + * When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. + */ + State?: AvailBlankingState; + } + export type AvailBlankingState = "DISABLED"|"ENABLED"|string; + export interface AvailConfiguration { + /** + * Ad avail settings. + */ + AvailSettings?: AvailSettings; + } + export interface AvailSettings { + Scte35SpliceInsert?: Scte35SpliceInsert; + Scte35TimeSignalApos?: Scte35TimeSignalApos; + } + export interface BatchScheduleActionCreateRequest { + /** + * A list of schedule actions to create. + */ + ScheduleActions: __listOfScheduleAction; + } + export interface BatchScheduleActionCreateResult { + /** + * List of actions that have been created in the schedule. + */ + ScheduleActions: __listOfScheduleAction; + } + export interface BatchScheduleActionDeleteRequest { + /** + * A list of schedule actions to delete. + */ + ActionNames: __listOf__string; + } + export interface BatchScheduleActionDeleteResult { + /** + * List of actions that have been deleted from the schedule. + */ + ScheduleActions: __listOfScheduleAction; + } + export interface BatchUpdateScheduleRequest { + /** + * Id of the channel whose schedule is being updated. + */ + ChannelId: __string; + /** + * Schedule actions to create in the schedule. + */ + Creates?: BatchScheduleActionCreateRequest; + /** + * Schedule actions to delete from the schedule. + */ + Deletes?: BatchScheduleActionDeleteRequest; + } + export interface BatchUpdateScheduleResponse { + /** + * Schedule actions created in the schedule. + */ + Creates?: BatchScheduleActionCreateResult; + /** + * Schedule actions deleted from the schedule. + */ + Deletes?: BatchScheduleActionDeleteResult; + } + export interface BlackoutSlate { + /** + * Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. + */ + BlackoutSlateImage?: InputLocation; + /** + * Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". + */ + NetworkEndBlackout?: BlackoutSlateNetworkEndBlackout; + /** + * Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. + */ + NetworkEndBlackoutImage?: InputLocation; + /** + * Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). + */ + NetworkId?: __stringMin34Max34; + /** + * When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. + */ + State?: BlackoutSlateState; + } + export type BlackoutSlateNetworkEndBlackout = "DISABLED"|"ENABLED"|string; + export type BlackoutSlateState = "DISABLED"|"ENABLED"|string; + export type BurnInAlignment = "CENTERED"|"LEFT"|"SMART"|string; + export type BurnInBackgroundColor = "BLACK"|"NONE"|"WHITE"|string; + export interface BurnInDestinationSettings { + /** + * If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. + */ + Alignment?: BurnInAlignment; + /** + * Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. + */ + BackgroundColor?: BurnInBackgroundColor; + /** + * Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + BackgroundOpacity?: __integerMin0Max255; + /** + * External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. + */ + Font?: InputLocation; + /** + * Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + FontColor?: BurnInFontColor; + /** + * Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. + */ + FontOpacity?: __integerMin0Max255; + /** + * Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. + */ + FontResolution?: __integerMin96Max600; + /** + * When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. + */ + FontSize?: __string; + /** + * Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineColor?: BurnInOutlineColor; + /** + * Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineSize?: __integerMin0Max10; + /** + * Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. + */ + ShadowColor?: BurnInShadowColor; + /** + * Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + ShadowOpacity?: __integerMin0Max255; + /** + * Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. + */ + ShadowXOffset?: __integer; + /** + * Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. + */ + ShadowYOffset?: __integer; + /** + * Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. + */ + TeletextGridControl?: BurnInTeletextGridControl; + /** + * Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. + */ + XPosition?: __integerMin0; + /** + * Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. + */ + YPosition?: __integerMin0; + } + export type BurnInFontColor = "BLACK"|"BLUE"|"GREEN"|"RED"|"WHITE"|"YELLOW"|string; + export type BurnInOutlineColor = "BLACK"|"BLUE"|"GREEN"|"RED"|"WHITE"|"YELLOW"|string; + export type BurnInShadowColor = "BLACK"|"NONE"|"WHITE"|string; + export type BurnInTeletextGridControl = "FIXED"|"SCALED"|string; + export interface CaptionDescription { + /** + * Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. + */ + CaptionSelectorName: __string; + /** + * Additional settings for captions destination that depend on the destination type. + */ + DestinationSettings?: CaptionDestinationSettings; + /** + * ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ + */ + LanguageCode?: __string; + /** + * Human readable information to indicate captions available for players (eg. English, or Spanish). + */ + LanguageDescription?: __string; + /** + * Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event. + */ + Name: __string; + } + export interface CaptionDestinationSettings { + AribDestinationSettings?: AribDestinationSettings; + BurnInDestinationSettings?: BurnInDestinationSettings; + DvbSubDestinationSettings?: DvbSubDestinationSettings; + EmbeddedDestinationSettings?: EmbeddedDestinationSettings; + EmbeddedPlusScte20DestinationSettings?: EmbeddedPlusScte20DestinationSettings; + RtmpCaptionInfoDestinationSettings?: RtmpCaptionInfoDestinationSettings; + Scte20PlusEmbeddedDestinationSettings?: Scte20PlusEmbeddedDestinationSettings; + Scte27DestinationSettings?: Scte27DestinationSettings; + SmpteTtDestinationSettings?: SmpteTtDestinationSettings; + TeletextDestinationSettings?: TeletextDestinationSettings; + TtmlDestinationSettings?: TtmlDestinationSettings; + WebvttDestinationSettings?: WebvttDestinationSettings; + } + export interface CaptionLanguageMapping { + /** + * The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) + */ + CaptionChannel: __integerMin1Max4; + /** + * Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) + */ + LanguageCode: __stringMin3Max3; + /** + * Textual description of language + */ + LanguageDescription: __stringMin1; + } + export interface CaptionSelector { + /** + * When specified this field indicates the three letter language code of the caption track to extract from the source. + */ + LanguageCode?: __string; + /** + * Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. + */ + Name: __stringMin1; + /** + * Caption selector settings. + */ + SelectorSettings?: CaptionSelectorSettings; + } + export interface CaptionSelectorSettings { + AribSourceSettings?: AribSourceSettings; + DvbSubSourceSettings?: DvbSubSourceSettings; + EmbeddedSourceSettings?: EmbeddedSourceSettings; + Scte20SourceSettings?: Scte20SourceSettings; + Scte27SourceSettings?: Scte27SourceSettings; + TeletextSourceSettings?: TeletextSourceSettings; + } + export interface Channel { + /** + * The unique arn of the channel. + */ + Arn?: __string; + /** + * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. + */ + ChannelClass?: ChannelClass; + /** + * A list of destinations of the channel. For UDP outputs, there is one +destination per output. For other types (HLS, for example), there is +one destination per packager. + + */ + Destinations?: __listOfOutputDestination; + /** + * The endpoints where outgoing connections initiate from + */ + EgressEndpoints?: __listOfChannelEgressEndpoint; + EncoderSettings?: EncoderSettings; + /** + * The unique id of the channel. + */ + Id?: __string; + /** + * List of input attachments for channel. + */ + InputAttachments?: __listOfInputAttachment; + InputSpecification?: InputSpecification; + /** + * The log level being written to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * The name of the channel. (user-mutable) + */ + Name?: __string; + /** + * The number of currently healthy pipelines. + */ + PipelinesRunningCount?: __integer; + /** + * The Amazon Resource Name (ARN) of the role assumed when running the Channel. + */ + RoleArn?: __string; + State?: ChannelState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + } + export type ChannelClass = "STANDARD"|"SINGLE_PIPELINE"|string; + export interface ChannelEgressEndpoint { + /** + * Public IP of where a channel's output comes from + */ + SourceIp?: __string; + } + export type ChannelState = "CREATING"|"CREATE_FAILED"|"IDLE"|"STARTING"|"RUNNING"|"RECOVERING"|"STOPPING"|"DELETING"|"DELETED"|"UPDATING"|"UPDATE_FAILED"|string; + export interface ChannelSummary { + /** + * The unique arn of the channel. + */ + Arn?: __string; + /** + * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. + */ + ChannelClass?: ChannelClass; + /** + * A list of destinations of the channel. For UDP outputs, there is one +destination per output. For other types (HLS, for example), there is +one destination per packager. + + */ + Destinations?: __listOfOutputDestination; + /** + * The endpoints where outgoing connections initiate from + */ + EgressEndpoints?: __listOfChannelEgressEndpoint; + /** + * The unique id of the channel. + */ + Id?: __string; + /** + * List of input attachments for channel. + */ + InputAttachments?: __listOfInputAttachment; + InputSpecification?: InputSpecification; + /** + * The log level being written to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * The name of the channel. (user-mutable) + */ + Name?: __string; + /** + * The number of currently healthy pipelines. + */ + PipelinesRunningCount?: __integer; + /** + * The Amazon Resource Name (ARN) of the role assumed when running the Channel. + */ + RoleArn?: __string; + State?: ChannelState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + } + export interface CreateChannelRequest { + /** + * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. + */ + ChannelClass?: ChannelClass; + Destinations?: __listOfOutputDestination; + EncoderSettings?: EncoderSettings; + /** + * List of input attachments for channel. + */ + InputAttachments?: __listOfInputAttachment; + /** + * Specification of input for this channel (max. bitrate, resolution, codec, etc.) + */ + InputSpecification?: InputSpecification; + /** + * The log level to write to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * Name of channel. + */ + Name?: __string; + /** + * Unique request ID to be specified. This is needed to prevent retries from +creating multiple resources. + + */ + RequestId?: __string; + /** + * Deprecated field that's only usable by whitelisted customers. + */ + Reserved?: __string; + /** + * An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. + */ + RoleArn?: __string; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + } + export interface CreateChannelResponse { + Channel?: Channel; + } + export interface CreateInputRequest { + /** + * Destination settings for PUSH type inputs. + */ + Destinations?: __listOfInputDestinationRequest; + /** + * A list of security groups referenced by IDs to attach to the input. + */ + InputSecurityGroups?: __listOf__string; + /** + * A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one +Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a +separate Availability Zone as this ensures your EML input is redundant to AZ issues. + + */ + MediaConnectFlows?: __listOfMediaConnectFlowRequest; + /** + * Name of the input. + */ + Name?: __string; + /** + * Unique identifier of the request to ensure the request is handled +exactly once in case of retries. + + */ + RequestId?: __string; + /** + * The Amazon Resource Name (ARN) of the role this input assumes during and after creation. + */ + RoleArn?: __string; + /** + * The source URLs for a PULL-type input. Every PULL type input needs +exactly two source URLs for redundancy. +Only specify sources for PULL type Inputs. Leave Destinations empty. + + */ + Sources?: __listOfInputSourceRequest; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + Type?: InputType; + Vpc?: InputVpcRequest; + } + export interface CreateInputResponse { + Input?: Input; + } + export interface CreateInputSecurityGroupRequest { + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + /** + * List of IPv4 CIDR addresses to whitelist + */ + WhitelistRules?: __listOfInputWhitelistRuleCidr; + } + export interface CreateInputSecurityGroupResponse { + SecurityGroup?: InputSecurityGroup; + } + export interface CreateTagsRequest { + ResourceArn: __string; + Tags?: Tags; + } + export interface DeleteChannelRequest { + /** + * Unique ID of the channel. + */ + ChannelId: __string; + } + export interface DeleteChannelResponse { + /** + * The unique arn of the channel. + */ + Arn?: __string; + /** + * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. + */ + ChannelClass?: ChannelClass; + /** + * A list of destinations of the channel. For UDP outputs, there is one +destination per output. For other types (HLS, for example), there is +one destination per packager. + + */ + Destinations?: __listOfOutputDestination; + /** + * The endpoints where outgoing connections initiate from + */ + EgressEndpoints?: __listOfChannelEgressEndpoint; + EncoderSettings?: EncoderSettings; + /** + * The unique id of the channel. + */ + Id?: __string; + /** + * List of input attachments for channel. + */ + InputAttachments?: __listOfInputAttachment; + InputSpecification?: InputSpecification; + /** + * The log level being written to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * The name of the channel. (user-mutable) + */ + Name?: __string; + /** + * The number of currently healthy pipelines. + */ + PipelinesRunningCount?: __integer; + /** + * The Amazon Resource Name (ARN) of the role assumed when running the Channel. + */ + RoleArn?: __string; + State?: ChannelState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + } + export interface DeleteInputRequest { + /** + * Unique ID of the input + */ + InputId: __string; + } + export interface DeleteInputResponse { + } + export interface DeleteInputSecurityGroupRequest { + /** + * The Input Security Group to delete + */ + InputSecurityGroupId: __string; + } + export interface DeleteInputSecurityGroupResponse { + } + export interface DeleteReservationRequest { + /** + * Unique reservation ID, e.g. '1234567' + */ + ReservationId: __string; + } + export interface DeleteReservationResponse { + /** + * Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' + */ + Arn?: __string; + /** + * Number of reserved resources + */ + Count?: __integer; + /** + * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + */ + CurrencyCode?: __string; + /** + * Lease duration, e.g. '12' + */ + Duration?: __integer; + /** + * Units for duration, e.g. 'MONTHS' + */ + DurationUnits?: OfferingDurationUnits; + /** + * Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' + */ + End?: __string; + /** + * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + */ + FixedPrice?: __double; + /** + * User specified reservation name + */ + Name?: __string; + /** + * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' + */ + OfferingDescription?: __string; + /** + * Unique offering ID, e.g. '87654321' + */ + OfferingId?: __string; + /** + * Offering type, e.g. 'NO_UPFRONT' + */ + OfferingType?: OfferingType; + /** + * AWS region, e.g. 'us-west-2' + */ + Region?: __string; + /** + * Unique reservation ID, e.g. '1234567' + */ + ReservationId?: __string; + /** + * Resource configuration details + */ + ResourceSpecification?: ReservationResourceSpecification; + /** + * Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' + */ + Start?: __string; + /** + * Current state of reservation, e.g. 'ACTIVE' + */ + State?: ReservationState; + /** + * A collection of key-value pairs + */ + Tags?: Tags; + /** + * Recurring usage charge for each reserved resource, e.g. '157.0' + */ + UsagePrice?: __double; + } + export interface DeleteScheduleRequest { + /** + * Id of the channel whose schedule is being deleted. + */ + ChannelId: __string; + } + export interface DeleteScheduleResponse { + } + export interface DeleteTagsRequest { + ResourceArn: __string; + /** + * An array of tag keys to delete + */ + TagKeys: __listOf__string; + } + export interface DescribeChannelRequest { + /** + * channel ID + */ + ChannelId: __string; + } + export interface DescribeChannelResponse { + /** + * The unique arn of the channel. + */ + Arn?: __string; + /** + * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. + */ + ChannelClass?: ChannelClass; + /** + * A list of destinations of the channel. For UDP outputs, there is one +destination per output. For other types (HLS, for example), there is +one destination per packager. + + */ + Destinations?: __listOfOutputDestination; + /** + * The endpoints where outgoing connections initiate from + */ + EgressEndpoints?: __listOfChannelEgressEndpoint; + EncoderSettings?: EncoderSettings; + /** + * The unique id of the channel. + */ + Id?: __string; + /** + * List of input attachments for channel. + */ + InputAttachments?: __listOfInputAttachment; + InputSpecification?: InputSpecification; + /** + * The log level being written to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * The name of the channel. (user-mutable) + */ + Name?: __string; + /** + * The number of currently healthy pipelines. + */ + PipelinesRunningCount?: __integer; + /** + * The Amazon Resource Name (ARN) of the role assumed when running the Channel. + */ + RoleArn?: __string; + State?: ChannelState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + } + export interface DescribeInputRequest { + /** + * Unique ID of the input + */ + InputId: __string; + } + export interface DescribeInputResponse { + /** + * The Unique ARN of the input (generated, immutable). + */ + Arn?: __string; + /** + * A list of channel IDs that that input is attached to (currently an input can only be attached to one channel). + */ + AttachedChannels?: __listOf__string; + /** + * A list of the destinations of the input (PUSH-type). + */ + Destinations?: __listOfInputDestination; + /** + * The generated ID of the input (unique for user account, immutable). + */ + Id?: __string; + /** + * STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. +SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. + + */ + InputClass?: InputClass; + /** + * A list of MediaConnect Flows for this input. + */ + MediaConnectFlows?: __listOfMediaConnectFlow; + /** + * The user-assigned name (This is a mutable value). + */ + Name?: __string; + /** + * The Amazon Resource Name (ARN) of the role this input assumes during and after creation. + */ + RoleArn?: __string; + /** + * A list of IDs for all the Input Security Groups attached to the input. + */ + SecurityGroups?: __listOf__string; + /** + * A list of the sources of the input (PULL-type). + */ + Sources?: __listOfInputSource; + State?: InputState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + Type?: InputType; + } + export interface DescribeInputSecurityGroupRequest { + /** + * The id of the Input Security Group to describe + */ + InputSecurityGroupId: __string; + } + export interface DescribeInputSecurityGroupResponse { + /** + * Unique ARN of Input Security Group + */ + Arn?: __string; + /** + * The Id of the Input Security Group + */ + Id?: __string; + /** + * The list of inputs currently using this Input Security Group. + */ + Inputs?: __listOf__string; + /** + * The current state of the Input Security Group. + */ + State?: InputSecurityGroupState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + /** + * Whitelist rules and their sync status + */ + WhitelistRules?: __listOfInputWhitelistRule; + } + export interface DescribeOfferingRequest { + /** + * Unique offering ID, e.g. '87654321' + */ + OfferingId: __string; + } + export interface DescribeOfferingResponse { + /** + * Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' + */ + Arn?: __string; + /** + * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + */ + CurrencyCode?: __string; + /** + * Lease duration, e.g. '12' + */ + Duration?: __integer; + /** + * Units for duration, e.g. 'MONTHS' + */ + DurationUnits?: OfferingDurationUnits; + /** + * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + */ + FixedPrice?: __double; + /** + * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' + */ + OfferingDescription?: __string; + /** + * Unique offering ID, e.g. '87654321' + */ + OfferingId?: __string; + /** + * Offering type, e.g. 'NO_UPFRONT' + */ + OfferingType?: OfferingType; + /** + * AWS region, e.g. 'us-west-2' + */ + Region?: __string; + /** + * Resource configuration details + */ + ResourceSpecification?: ReservationResourceSpecification; + /** + * Recurring usage charge for each reserved resource, e.g. '157.0' + */ + UsagePrice?: __double; + } + export interface DescribeReservationRequest { + /** + * Unique reservation ID, e.g. '1234567' + */ + ReservationId: __string; + } + export interface DescribeReservationResponse { + /** + * Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' + */ + Arn?: __string; + /** + * Number of reserved resources + */ + Count?: __integer; + /** + * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + */ + CurrencyCode?: __string; + /** + * Lease duration, e.g. '12' + */ + Duration?: __integer; + /** + * Units for duration, e.g. 'MONTHS' + */ + DurationUnits?: OfferingDurationUnits; + /** + * Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' + */ + End?: __string; + /** + * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + */ + FixedPrice?: __double; + /** + * User specified reservation name + */ + Name?: __string; + /** + * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' + */ + OfferingDescription?: __string; + /** + * Unique offering ID, e.g. '87654321' + */ + OfferingId?: __string; + /** + * Offering type, e.g. 'NO_UPFRONT' + */ + OfferingType?: OfferingType; + /** + * AWS region, e.g. 'us-west-2' + */ + Region?: __string; + /** + * Unique reservation ID, e.g. '1234567' + */ + ReservationId?: __string; + /** + * Resource configuration details + */ + ResourceSpecification?: ReservationResourceSpecification; + /** + * Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' + */ + Start?: __string; + /** + * Current state of reservation, e.g. 'ACTIVE' + */ + State?: ReservationState; + /** + * A collection of key-value pairs + */ + Tags?: Tags; + /** + * Recurring usage charge for each reserved resource, e.g. '157.0' + */ + UsagePrice?: __double; + } + export interface DescribeScheduleRequest { + /** + * Id of the channel whose schedule is being updated. + */ + ChannelId: __string; + MaxResults?: MaxResults; + NextToken?: __string; + } + export interface DescribeScheduleResponse { + /** + * The next token; for use in pagination. + */ + NextToken?: __string; + /** + * The list of actions in the schedule. + */ + ScheduleActions?: __listOfScheduleAction; + } + export interface DvbNitSettings { + /** + * The numeric value placed in the Network Information Table (NIT). + */ + NetworkId: __integerMin0Max65536; + /** + * The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. + */ + NetworkName: __stringMin1Max256; + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + RepInterval?: __integerMin25Max10000; + } + export type DvbSdtOutputSdt = "SDT_FOLLOW"|"SDT_FOLLOW_IF_PRESENT"|"SDT_MANUAL"|"SDT_NONE"|string; + export interface DvbSdtSettings { + /** + * Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. + */ + OutputSdt?: DvbSdtOutputSdt; + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + RepInterval?: __integerMin25Max2000; + /** + * The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. + */ + ServiceName?: __stringMin1Max256; + /** + * The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. + */ + ServiceProviderName?: __stringMin1Max256; + } + export type DvbSubDestinationAlignment = "CENTERED"|"LEFT"|"SMART"|string; + export type DvbSubDestinationBackgroundColor = "BLACK"|"NONE"|"WHITE"|string; + export type DvbSubDestinationFontColor = "BLACK"|"BLUE"|"GREEN"|"RED"|"WHITE"|"YELLOW"|string; + export type DvbSubDestinationOutlineColor = "BLACK"|"BLUE"|"GREEN"|"RED"|"WHITE"|"YELLOW"|string; + export interface DvbSubDestinationSettings { + /** + * If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + Alignment?: DvbSubDestinationAlignment; + /** + * Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. + */ + BackgroundColor?: DvbSubDestinationBackgroundColor; + /** + * Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + BackgroundOpacity?: __integerMin0Max255; + /** + * External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. + */ + Font?: InputLocation; + /** + * Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + FontColor?: DvbSubDestinationFontColor; + /** + * Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. + */ + FontOpacity?: __integerMin0Max255; + /** + * Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. + */ + FontResolution?: __integerMin96Max600; + /** + * When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. + */ + FontSize?: __string; + /** + * Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineColor?: DvbSubDestinationOutlineColor; + /** + * Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + OutlineSize?: __integerMin0Max10; + /** + * Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. + */ + ShadowColor?: DvbSubDestinationShadowColor; + /** + * Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. + */ + ShadowOpacity?: __integerMin0Max255; + /** + * Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. + */ + ShadowXOffset?: __integer; + /** + * Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. + */ + ShadowYOffset?: __integer; + /** + * Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. + */ + TeletextGridControl?: DvbSubDestinationTeletextGridControl; + /** + * Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + XPosition?: __integerMin0; + /** + * Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. + */ + YPosition?: __integerMin0; + } + export type DvbSubDestinationShadowColor = "BLACK"|"NONE"|"WHITE"|string; + export type DvbSubDestinationTeletextGridControl = "FIXED"|"SCALED"|string; + export interface DvbSubSourceSettings { + /** + * When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. + */ + Pid?: __integerMin1; + } + export interface DvbTdtSettings { + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + RepInterval?: __integerMin1000Max30000; + } + export type Eac3AttenuationControl = "ATTENUATE_3_DB"|"NONE"|string; + export type Eac3BitstreamMode = "COMMENTARY"|"COMPLETE_MAIN"|"EMERGENCY"|"HEARING_IMPAIRED"|"VISUALLY_IMPAIRED"|string; + export type Eac3CodingMode = "CODING_MODE_1_0"|"CODING_MODE_2_0"|"CODING_MODE_3_2"|string; + export type Eac3DcFilter = "DISABLED"|"ENABLED"|string; + export type Eac3DrcLine = "FILM_LIGHT"|"FILM_STANDARD"|"MUSIC_LIGHT"|"MUSIC_STANDARD"|"NONE"|"SPEECH"|string; + export type Eac3DrcRf = "FILM_LIGHT"|"FILM_STANDARD"|"MUSIC_LIGHT"|"MUSIC_STANDARD"|"NONE"|"SPEECH"|string; + export type Eac3LfeControl = "LFE"|"NO_LFE"|string; + export type Eac3LfeFilter = "DISABLED"|"ENABLED"|string; + export type Eac3MetadataControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string; + export type Eac3PassthroughControl = "NO_PASSTHROUGH"|"WHEN_POSSIBLE"|string; + export type Eac3PhaseControl = "NO_SHIFT"|"SHIFT_90_DEGREES"|string; + export interface Eac3Settings { + /** + * When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. + */ + AttenuationControl?: Eac3AttenuationControl; + /** + * Average bitrate in bits/second. Valid bitrates depend on the coding mode. + */ + Bitrate?: __double; + /** + * Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. + */ + BitstreamMode?: Eac3BitstreamMode; + /** + * Dolby Digital Plus coding mode. Determines number of channels. + */ + CodingMode?: Eac3CodingMode; + /** + * When set to enabled, activates a DC highpass filter for all input channels. + */ + DcFilter?: Eac3DcFilter; + /** + * Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. + */ + Dialnorm?: __integerMin1Max31; + /** + * Sets the Dolby dynamic range compression profile. + */ + DrcLine?: Eac3DrcLine; + /** + * Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. + */ + DrcRf?: Eac3DrcRf; + /** + * When encoding 3/2 audio, setting to lfe enables the LFE channel + */ + LfeControl?: Eac3LfeControl; + /** + * When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. + */ + LfeFilter?: Eac3LfeFilter; + /** + * Left only/Right only center mix level. Only used for 3/2 coding mode. + */ + LoRoCenterMixLevel?: __double; + /** + * Left only/Right only surround mix level. Only used for 3/2 coding mode. + */ + LoRoSurroundMixLevel?: __double; + /** + * Left total/Right total center mix level. Only used for 3/2 coding mode. + */ + LtRtCenterMixLevel?: __double; + /** + * Left total/Right total surround mix level. Only used for 3/2 coding mode. + */ + LtRtSurroundMixLevel?: __double; + /** + * When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. + */ + MetadataControl?: Eac3MetadataControl; + /** + * When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. + */ + PassthroughControl?: Eac3PassthroughControl; + /** + * When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. + */ + PhaseControl?: Eac3PhaseControl; + /** + * Stereo downmix preference. Only used for 3/2 coding mode. + */ + StereoDownmix?: Eac3StereoDownmix; + /** + * When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. + */ + SurroundExMode?: Eac3SurroundExMode; + /** + * When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. + */ + SurroundMode?: Eac3SurroundMode; + } + export type Eac3StereoDownmix = "DPL2"|"LO_RO"|"LT_RT"|"NOT_INDICATED"|string; + export type Eac3SurroundExMode = "DISABLED"|"ENABLED"|"NOT_INDICATED"|string; + export type Eac3SurroundMode = "DISABLED"|"ENABLED"|"NOT_INDICATED"|string; + export type EmbeddedConvert608To708 = "DISABLED"|"UPCONVERT"|string; + export interface EmbeddedDestinationSettings { + } + export interface EmbeddedPlusScte20DestinationSettings { + } + export type EmbeddedScte20Detection = "AUTO"|"OFF"|string; + export interface EmbeddedSourceSettings { + /** + * If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. + */ + Convert608To708?: EmbeddedConvert608To708; + /** + * Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. + */ + Scte20Detection?: EmbeddedScte20Detection; + /** + * Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. + */ + Source608ChannelNumber?: __integerMin1Max4; + /** + * This field is unused and deprecated. + */ + Source608TrackNumber?: __integerMin1Max5; + } + export interface EncoderSettings { + AudioDescriptions: __listOfAudioDescription; + /** + * Settings for ad avail blanking. + */ + AvailBlanking?: AvailBlanking; + /** + * Event-wide configuration settings for ad avail insertion. + */ + AvailConfiguration?: AvailConfiguration; + /** + * Settings for blackout slate. + */ + BlackoutSlate?: BlackoutSlate; + /** + * Settings for caption decriptions + */ + CaptionDescriptions?: __listOfCaptionDescription; + /** + * Configuration settings that apply to the event as a whole. + */ + GlobalConfiguration?: GlobalConfiguration; + OutputGroups: __listOfOutputGroup; + /** + * Contains settings used to acquire and adjust timecode information from inputs. + */ + TimecodeConfig: TimecodeConfig; + VideoDescriptions: __listOfVideoDescription; + } + export type FecOutputIncludeFec = "COLUMN"|"COLUMN_AND_ROW"|string; + export interface FecOutputSettings { + /** + * Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. + */ + ColumnDepth?: __integerMin4Max20; + /** + * Enables column only or column and row based FEC + */ + IncludeFec?: FecOutputIncludeFec; + /** + * Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive. + */ + RowLength?: __integerMin1Max20; + } + export type FixedAfd = "AFD_0000"|"AFD_0010"|"AFD_0011"|"AFD_0100"|"AFD_1000"|"AFD_1001"|"AFD_1010"|"AFD_1011"|"AFD_1101"|"AFD_1110"|"AFD_1111"|string; + export interface FixedModeScheduleActionStartSettings { + /** + * Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format". + */ + Time: __string; + } + export interface FollowModeScheduleActionStartSettings { + /** + * Identifies whether this action starts relative to the start or relative to the end of the reference action. + */ + FollowPoint: FollowPoint; + /** + * The action name of another action that this one refers to. + */ + ReferenceActionName: __string; + } + export type FollowPoint = "END"|"START"|string; + export interface FrameCaptureGroupSettings { + /** + * The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg + */ + Destination: OutputLocationRef; + } + export interface FrameCaptureOutputSettings { + /** + * Required if the output group contains more than one output. This modifier forms part of the output file name. + */ + NameModifier?: __string; + } + export interface FrameCaptureSettings { + /** + * The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds. + */ + CaptureInterval: __integerMin1Max3600; + } + export interface GlobalConfiguration { + /** + * Value to set the initial audio gain for the Live Event. + */ + InitialAudioGain?: __integerMinNegative60Max60; + /** + * Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). + */ + InputEndAction?: GlobalConfigurationInputEndAction; + /** + * Settings for system actions when input is lost. + */ + InputLossBehavior?: InputLossBehavior; + /** + * Indicates how MediaLive pipelines are synchronized. + +PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. +EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. + */ + OutputLockingMode?: GlobalConfigurationOutputLockingMode; + /** + * Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. + */ + OutputTimingSource?: GlobalConfigurationOutputTimingSource; + /** + * Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. + */ + SupportLowFramerateInputs?: GlobalConfigurationLowFramerateInputs; + } + export type GlobalConfigurationInputEndAction = "NONE"|"SWITCH_AND_LOOP_INPUTS"|string; + export type GlobalConfigurationLowFramerateInputs = "DISABLED"|"ENABLED"|string; + export type GlobalConfigurationOutputLockingMode = "EPOCH_LOCKING"|"PIPELINE_LOCKING"|string; + export type GlobalConfigurationOutputTimingSource = "INPUT_CLOCK"|"SYSTEM_CLOCK"|string; + export type H264AdaptiveQuantization = "HIGH"|"HIGHER"|"LOW"|"MAX"|"MEDIUM"|"OFF"|string; + export type H264ColorMetadata = "IGNORE"|"INSERT"|string; + export type H264EntropyEncoding = "CABAC"|"CAVLC"|string; + export type H264FlickerAq = "DISABLED"|"ENABLED"|string; + export type H264FramerateControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type H264GopBReference = "DISABLED"|"ENABLED"|string; + export type H264GopSizeUnits = "FRAMES"|"SECONDS"|string; + export type H264Level = "H264_LEVEL_1"|"H264_LEVEL_1_1"|"H264_LEVEL_1_2"|"H264_LEVEL_1_3"|"H264_LEVEL_2"|"H264_LEVEL_2_1"|"H264_LEVEL_2_2"|"H264_LEVEL_3"|"H264_LEVEL_3_1"|"H264_LEVEL_3_2"|"H264_LEVEL_4"|"H264_LEVEL_4_1"|"H264_LEVEL_4_2"|"H264_LEVEL_5"|"H264_LEVEL_5_1"|"H264_LEVEL_5_2"|"H264_LEVEL_AUTO"|string; + export type H264LookAheadRateControl = "HIGH"|"LOW"|"MEDIUM"|string; + export type H264ParControl = "INITIALIZE_FROM_SOURCE"|"SPECIFIED"|string; + export type H264Profile = "BASELINE"|"HIGH"|"HIGH_10BIT"|"HIGH_422"|"HIGH_422_10BIT"|"MAIN"|string; + export type H264RateControlMode = "CBR"|"QVBR"|"VBR"|string; + export type H264ScanType = "INTERLACED"|"PROGRESSIVE"|string; + export type H264SceneChangeDetect = "DISABLED"|"ENABLED"|string; + export interface H264Settings { + /** + * Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. + */ + AdaptiveQuantization?: H264AdaptiveQuantization; + /** + * Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. + */ + AfdSignaling?: AfdSignaling; + /** + * Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. + */ + Bitrate?: __integerMin1000; + /** + * Percentage of the buffer that should initially be filled (HRD buffer model). + */ + BufFillPct?: __integerMin0Max100; + /** + * Size of buffer (HRD buffer model) in bits/second. + */ + BufSize?: __integerMin0; + /** + * Includes colorspace metadata in the output. + */ + ColorMetadata?: H264ColorMetadata; + /** + * Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. + */ + EntropyEncoding?: H264EntropyEncoding; + /** + * Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. + */ + FixedAfd?: FixedAfd; + /** + * If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. + */ + FlickerAq?: H264FlickerAq; + /** + * This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. + */ + FramerateControl?: H264FramerateControl; + /** + * Framerate denominator. + */ + FramerateDenominator?: __integerMin1; + /** + * Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. + */ + FramerateNumerator?: __integerMin1; + /** + * Documentation update needed + */ + GopBReference?: H264GopBReference; + /** + * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. + */ + GopClosedCadence?: __integerMin0; + /** + * Number of B-frames between reference frames. + */ + GopNumBFrames?: __integerMin0Max7; + /** + * GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero. + */ + GopSize?: __doubleMin1; + /** + * Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. + */ + GopSizeUnits?: H264GopSizeUnits; + /** + * H.264 Level. + */ + Level?: H264Level; + /** + * Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. + */ + LookAheadRateControl?: H264LookAheadRateControl; + /** + * For QVBR: See the tooltip for Quality level + +For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. + */ + MaxBitrate?: __integerMin1000; + /** + * Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 + */ + MinIInterval?: __integerMin0Max30; + /** + * Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. + */ + NumRefFrames?: __integerMin1Max6; + /** + * This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. + */ + ParControl?: H264ParControl; + /** + * Pixel Aspect Ratio denominator. + */ + ParDenominator?: __integerMin1; + /** + * Pixel Aspect Ratio numerator. + */ + ParNumerator?: __integer; + /** + * H.264 Profile. + */ + Profile?: H264Profile; + /** + * Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: +- Primary screen: Quality level: 8 to 10. Max bitrate: 4M +- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M +- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M + */ + QvbrQualityLevel?: __integerMin1Max10; + /** + * Rate control mode. + +QVBR: Quality will match the specified quality level except when it is constrained by the +maximum bitrate. Recommended if you or your viewers pay for bandwidth. + +VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR +if you want to maintain a specific average bitrate over the duration of the channel. + +CBR: Quality varies, depending on the video complexity. Recommended only if you distribute +your assets to devices that cannot handle variable bitrates. + */ + RateControlMode?: H264RateControlMode; + /** + * Sets the scan type of the output to progressive or top-field-first interlaced. + */ + ScanType?: H264ScanType; + /** + * Scene change detection. + +- On: inserts I-frames when scene change is detected. +- Off: does not force an I-frame when scene change is detected. + */ + SceneChangeDetect?: H264SceneChangeDetect; + /** + * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. +This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. + */ + Slices?: __integerMin1Max32; + /** + * Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. + */ + Softness?: __integerMin0Max128; + /** + * If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. + */ + SpatialAq?: H264SpatialAq; + /** + * If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. + */ + SubgopLength?: H264SubGopLength; + /** + * Produces a bitstream compliant with SMPTE RP-2027. + */ + Syntax?: H264Syntax; + /** + * If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. + */ + TemporalAq?: H264TemporalAq; + /** + * Determines how timecodes should be inserted into the video elementary stream. +- 'disabled': Do not include timecodes +- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config + */ + TimecodeInsertion?: H264TimecodeInsertionBehavior; + } + export type H264SpatialAq = "DISABLED"|"ENABLED"|string; + export type H264SubGopLength = "DYNAMIC"|"FIXED"|string; + export type H264Syntax = "DEFAULT"|"RP2027"|string; + export type H264TemporalAq = "DISABLED"|"ENABLED"|string; + export type H264TimecodeInsertionBehavior = "DISABLED"|"PIC_TIMING_SEI"|string; + export type HlsAdMarkers = "ADOBE"|"ELEMENTAL"|"ELEMENTAL_SCTE35"|string; + export type HlsAkamaiHttpTransferMode = "CHUNKED"|"NON_CHUNKED"|string; + export interface HlsAkamaiSettings { + /** + * Number of seconds to wait before retrying connection to the CDN if the connection is lost. + */ + ConnectionRetryInterval?: __integerMin0; + /** + * Size in seconds of file cache for streaming outputs. + */ + FilecacheDuration?: __integerMin0Max600; + /** + * Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. + */ + HttpTransferMode?: HlsAkamaiHttpTransferMode; + /** + * Number of retry attempts that will be made before the Live Event is put into an error state. + */ + NumRetries?: __integerMin0; + /** + * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. + */ + RestartDelay?: __integerMin0Max15; + /** + * Salt for authenticated Akamai. + */ + Salt?: __string; + /** + * Token parameter for authenticated akamai. If not specified, _gda_ is used. + */ + Token?: __string; + } + export interface HlsBasicPutSettings { + /** + * Number of seconds to wait before retrying connection to the CDN if the connection is lost. + */ + ConnectionRetryInterval?: __integerMin0; + /** + * Size in seconds of file cache for streaming outputs. + */ + FilecacheDuration?: __integerMin0Max600; + /** + * Number of retry attempts that will be made before the Live Event is put into an error state. + */ + NumRetries?: __integerMin0; + /** + * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. + */ + RestartDelay?: __integerMin0Max15; + } + export type HlsCaptionLanguageSetting = "INSERT"|"NONE"|"OMIT"|string; + export interface HlsCdnSettings { + HlsAkamaiSettings?: HlsAkamaiSettings; + HlsBasicPutSettings?: HlsBasicPutSettings; + HlsMediaStoreSettings?: HlsMediaStoreSettings; + HlsWebdavSettings?: HlsWebdavSettings; + } + export type HlsClientCache = "DISABLED"|"ENABLED"|string; + export type HlsCodecSpecification = "RFC_4281"|"RFC_6381"|string; + export type HlsDirectoryStructure = "SINGLE_DIRECTORY"|"SUBDIRECTORY_PER_STREAM"|string; + export type HlsEncryptionType = "AES128"|"SAMPLE_AES"|string; + export interface HlsGroupSettings { + /** + * Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. + */ + AdMarkers?: __listOfHlsAdMarkers; + /** + * A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. + */ + BaseUrlContent?: __string; + /** + * A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. + */ + BaseUrlManifest?: __string; + /** + * Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". + */ + CaptionLanguageMappings?: __listOfCaptionLanguageMapping; + /** + * Applies only to 608 Embedded output captions. +insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. +none: Include CLOSED-CAPTIONS=NONE line in the manifest. +omit: Omit any CLOSED-CAPTIONS line from the manifest. + */ + CaptionLanguageSetting?: HlsCaptionLanguageSetting; + /** + * When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. + */ + ClientCache?: HlsClientCache; + /** + * Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. + */ + CodecSpecification?: HlsCodecSpecification; + /** + * For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. + */ + ConstantIv?: __stringMin32Max32; + /** + * A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). + */ + Destination: OutputLocationRef; + /** + * Place segments in subdirectories. + */ + DirectoryStructure?: HlsDirectoryStructure; + /** + * Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. + */ + EncryptionType?: HlsEncryptionType; + /** + * Parameters that control interactions with the CDN. + */ + HlsCdnSettings?: HlsCdnSettings; + /** + * DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). + +STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" + */ + IFrameOnlyPlaylists?: IFrameOnlyPlaylistType; + /** + * Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field. + */ + IndexNSegments?: __integerMin3; + /** + * Parameter that control output group behavior on input loss. + */ + InputLossAction?: InputLossActionForHlsOut; + /** + * For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. + */ + IvInManifest?: HlsIvInManifest; + /** + * For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. + */ + IvSource?: HlsIvSource; + /** + * Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory. + */ + KeepSegments?: __integerMin1; + /** + * The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. + */ + KeyFormat?: __string; + /** + * Either a single positive integer version value or a slash delimited list of version values (1/2/3). + */ + KeyFormatVersions?: __string; + /** + * The key provider settings. + */ + KeyProviderSettings?: KeyProviderSettings; + /** + * When set to gzip, compresses HLS playlist. + */ + ManifestCompression?: HlsManifestCompression; + /** + * Indicates whether the output manifest should use floating point or integer values for segment duration. + */ + ManifestDurationFormat?: HlsManifestDurationFormat; + /** + * When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. + */ + MinSegmentLength?: __integerMin0; + /** + * If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. + +VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. + */ + Mode?: HlsMode; + /** + * MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. + +SEGMENTSONLY: Does not generate any manifests for this output group. + */ + OutputSelection?: HlsOutputSelection; + /** + * Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. + */ + ProgramDateTime?: HlsProgramDateTime; + /** + * Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. + */ + ProgramDateTimePeriod?: __integerMin0Max3600; + /** + * ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. + +DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. + +For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. + */ + RedundantManifest?: HlsRedundantManifest; + /** + * Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. + */ + SegmentLength?: __integerMin1; + /** + * useInputSegmentation has been deprecated. The configured segment size is always used. + */ + SegmentationMode?: HlsSegmentationMode; + /** + * Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. + */ + SegmentsPerSubdirectory?: __integerMin1; + /** + * Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. + */ + StreamInfResolution?: HlsStreamInfResolution; + /** + * Indicates ID3 frame that has the timecode. + */ + TimedMetadataId3Frame?: HlsTimedMetadataId3Frame; + /** + * Timed Metadata interval in seconds. + */ + TimedMetadataId3Period?: __integerMin0; + /** + * Provides an extra millisecond delta offset to fine tune the timestamps. + */ + TimestampDeltaMilliseconds?: __integerMin0; + /** + * SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. + +SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. + */ + TsFileMode?: HlsTsFileMode; + } + export interface HlsInputSettings { + /** + * When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. + */ + Bandwidth?: __integerMin0; + /** + * When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. + */ + BufferSegments?: __integerMin0; + /** + * The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. + */ + Retries?: __integerMin0; + /** + * The number of seconds between retries when an attempt to read a manifest or segment fails. + */ + RetryInterval?: __integerMin0; + } + export type HlsIvInManifest = "EXCLUDE"|"INCLUDE"|string; + export type HlsIvSource = "EXPLICIT"|"FOLLOWS_SEGMENT_NUMBER"|string; + export type HlsManifestCompression = "GZIP"|"NONE"|string; + export type HlsManifestDurationFormat = "FLOATING_POINT"|"INTEGER"|string; + export interface HlsMediaStoreSettings { + /** + * Number of seconds to wait before retrying connection to the CDN if the connection is lost. + */ + ConnectionRetryInterval?: __integerMin0; + /** + * Size in seconds of file cache for streaming outputs. + */ + FilecacheDuration?: __integerMin0Max600; + /** + * When set to temporal, output files are stored in non-persistent memory for faster reading and writing. + */ + MediaStoreStorageClass?: HlsMediaStoreStorageClass; + /** + * Number of retry attempts that will be made before the Live Event is put into an error state. + */ + NumRetries?: __integerMin0; + /** + * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. + */ + RestartDelay?: __integerMin0Max15; + } + export type HlsMediaStoreStorageClass = "TEMPORAL"|string; + export type HlsMode = "LIVE"|"VOD"|string; + export type HlsOutputSelection = "MANIFESTS_AND_SEGMENTS"|"SEGMENTS_ONLY"|string; + export interface HlsOutputSettings { + /** + * Settings regarding the underlying stream. These settings are different for audio-only outputs. + */ + HlsSettings: HlsSettings; + /** + * String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters. + */ + NameModifier?: __stringMin1; + /** + * String concatenated to end of segment filenames. + */ + SegmentModifier?: __string; + } + export type HlsProgramDateTime = "EXCLUDE"|"INCLUDE"|string; + export type HlsRedundantManifest = "DISABLED"|"ENABLED"|string; + export type HlsSegmentationMode = "USE_INPUT_SEGMENTATION"|"USE_SEGMENT_DURATION"|string; + export interface HlsSettings { + AudioOnlyHlsSettings?: AudioOnlyHlsSettings; + StandardHlsSettings?: StandardHlsSettings; + } + export type HlsStreamInfResolution = "EXCLUDE"|"INCLUDE"|string; + export type HlsTimedMetadataId3Frame = "NONE"|"PRIV"|"TDRL"|string; + export interface HlsTimedMetadataScheduleActionSettings { + /** + * Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure + */ + Id3: __string; + } + export type HlsTsFileMode = "SEGMENTED_FILES"|"SINGLE_FILE"|string; + export type HlsWebdavHttpTransferMode = "CHUNKED"|"NON_CHUNKED"|string; + export interface HlsWebdavSettings { + /** + * Number of seconds to wait before retrying connection to the CDN if the connection is lost. + */ + ConnectionRetryInterval?: __integerMin0; + /** + * Size in seconds of file cache for streaming outputs. + */ + FilecacheDuration?: __integerMin0Max600; + /** + * Specify whether or not to use chunked transfer encoding to WebDAV. + */ + HttpTransferMode?: HlsWebdavHttpTransferMode; + /** + * Number of retry attempts that will be made before the Live Event is put into an error state. + */ + NumRetries?: __integerMin0; + /** + * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. + */ + RestartDelay?: __integerMin0Max15; + } + export type IFrameOnlyPlaylistType = "DISABLED"|"STANDARD"|string; + export interface Input { + /** + * The Unique ARN of the input (generated, immutable). + */ + Arn?: __string; + /** + * A list of channel IDs that that input is attached to (currently an input can only be attached to one channel). + */ + AttachedChannels?: __listOf__string; + /** + * A list of the destinations of the input (PUSH-type). + */ + Destinations?: __listOfInputDestination; + /** + * The generated ID of the input (unique for user account, immutable). + */ + Id?: __string; + /** + * STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. +SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. + + */ + InputClass?: InputClass; + /** + * A list of MediaConnect Flows for this input. + */ + MediaConnectFlows?: __listOfMediaConnectFlow; + /** + * The user-assigned name (This is a mutable value). + */ + Name?: __string; + /** + * The Amazon Resource Name (ARN) of the role this input assumes during and after creation. + */ + RoleArn?: __string; + /** + * A list of IDs for all the Input Security Groups attached to the input. + */ + SecurityGroups?: __listOf__string; + /** + * A list of the sources of the input (PULL-type). + */ + Sources?: __listOfInputSource; + State?: InputState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + Type?: InputType; + } + export interface InputAttachment { + /** + * User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. + */ + InputAttachmentName?: __string; + /** + * The ID of the input + */ + InputId?: __string; + /** + * Settings of an input (caption selector, etc.) + */ + InputSettings?: InputSettings; + } + export interface InputChannelLevel { + /** + * Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. + */ + Gain: __integerMinNegative60Max6; + /** + * The index of the input channel used as a source. + */ + InputChannel: __integerMin0Max15; + } + export type InputClass = "STANDARD"|"SINGLE_PIPELINE"|string; + export type InputCodec = "MPEG2"|"AVC"|"HEVC"|string; + export type InputDeblockFilter = "DISABLED"|"ENABLED"|string; + export type InputDenoiseFilter = "DISABLED"|"ENABLED"|string; + export interface InputDestination { + /** + * The system-generated static IP address of endpoint. +It remains fixed for the lifetime of the input. + + */ + Ip?: __string; + /** + * The port number for the input. + */ + Port?: __string; + /** + * This represents the endpoint that the customer stream will be +pushed to. + + */ + Url?: __string; + Vpc?: InputDestinationVpc; + } + export interface InputDestinationRequest { + /** + * A unique name for the location the RTMP stream is being pushed +to. + + */ + StreamName?: __string; + } + export interface InputDestinationVpc { + /** + * The availability zone of the Input destination. + + */ + AvailabilityZone?: __string; + /** + * The network interface ID of the Input destination in the VPC. + + */ + NetworkInterfaceId?: __string; + } + export type InputFilter = "AUTO"|"DISABLED"|"FORCED"|string; + export interface InputLocation { + /** + * key used to extract the password from EC2 Parameter store + */ + PasswordParam?: __string; + /** + * Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". + */ + Uri: __string; + /** + * Documentation update needed + */ + Username?: __string; + } + export type InputLossActionForHlsOut = "EMIT_OUTPUT"|"PAUSE_OUTPUT"|string; + export type InputLossActionForMsSmoothOut = "EMIT_OUTPUT"|"PAUSE_OUTPUT"|string; + export type InputLossActionForRtmpOut = "EMIT_OUTPUT"|"PAUSE_OUTPUT"|string; + export type InputLossActionForUdpOut = "DROP_PROGRAM"|"DROP_TS"|"EMIT_PROGRAM"|string; + export interface InputLossBehavior { + /** + * Documentation update needed + */ + BlackFrameMsec?: __integerMin0Max1000000; + /** + * When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. + */ + InputLossImageColor?: __stringMin6Max6; + /** + * When input loss image type is "slate" these fields specify the parameters for accessing the slate. + */ + InputLossImageSlate?: InputLocation; + /** + * Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. + */ + InputLossImageType?: InputLossImageType; + /** + * Documentation update needed + */ + RepeatFrameMsec?: __integerMin0Max1000000; + } + export type InputLossImageType = "COLOR"|"SLATE"|string; + export type InputMaximumBitrate = "MAX_10_MBPS"|"MAX_20_MBPS"|"MAX_50_MBPS"|string; + export type InputResolution = "SD"|"HD"|"UHD"|string; + export interface InputSecurityGroup { + /** + * Unique ARN of Input Security Group + */ + Arn?: __string; + /** + * The Id of the Input Security Group + */ + Id?: __string; + /** + * The list of inputs currently using this Input Security Group. + */ + Inputs?: __listOf__string; + /** + * The current state of the Input Security Group. + */ + State?: InputSecurityGroupState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + /** + * Whitelist rules and their sync status + */ + WhitelistRules?: __listOfInputWhitelistRule; + } + export type InputSecurityGroupState = "IDLE"|"IN_USE"|"UPDATING"|"DELETED"|string; + export interface InputSettings { + /** + * Used to select the audio stream to decode for inputs that have multiple available. + */ + AudioSelectors?: __listOfAudioSelector; + /** + * Used to select the caption input to use for inputs that have multiple available. + */ + CaptionSelectors?: __listOfCaptionSelector; + /** + * Enable or disable the deblock filter when filtering. + */ + DeblockFilter?: InputDeblockFilter; + /** + * Enable or disable the denoise filter when filtering. + */ + DenoiseFilter?: InputDenoiseFilter; + /** + * Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). + */ + FilterStrength?: __integerMin1Max5; + /** + * Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. +1) auto - filtering will be applied depending on input type/quality +2) disabled - no filtering will be applied to the input +3) forced - filtering will be applied regardless of input type + */ + InputFilter?: InputFilter; + /** + * Input settings. + */ + NetworkInputSettings?: NetworkInputSettings; + /** + * Loop input if it is a file. This allows a file input to be streamed indefinitely. + */ + SourceEndBehavior?: InputSourceEndBehavior; + /** + * Informs which video elementary stream to decode for input types that have multiple available. + */ + VideoSelector?: VideoSelector; + } + export interface InputSource { + /** + * The key used to extract the password from EC2 Parameter store. + */ + PasswordParam?: __string; + /** + * This represents the customer's source URL where stream is +pulled from. + + */ + Url?: __string; + /** + * The username for the input source. + */ + Username?: __string; + } + export type InputSourceEndBehavior = "CONTINUE"|"LOOP"|string; + export interface InputSourceRequest { + /** + * The key used to extract the password from EC2 Parameter store. + */ + PasswordParam?: __string; + /** + * This represents the customer's source URL where stream is +pulled from. + + */ + Url?: __string; + /** + * The username for the input source. + */ + Username?: __string; + } + export interface InputSpecification { + /** + * Input codec + */ + Codec?: InputCodec; + /** + * Maximum input bitrate, categorized coarsely + */ + MaximumBitrate?: InputMaximumBitrate; + /** + * Input resolution, categorized coarsely + */ + Resolution?: InputResolution; + } + export type InputState = "CREATING"|"DETACHED"|"ATTACHED"|"DELETING"|"DELETED"|string; + export interface InputSwitchScheduleActionSettings { + /** + * The name of the input attachment that should be switched to by this action. + */ + InputAttachmentNameReference: __string; + } + export type InputType = "UDP_PUSH"|"RTP_PUSH"|"RTMP_PUSH"|"RTMP_PULL"|"URL_PULL"|"MP4_FILE"|"MEDIACONNECT"|string; + export interface InputVpcRequest { + /** + * A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces. +Requires subnetIds. If none are specified then the VPC default security group will be used. + + */ + SecurityGroupIds?: __listOf__string; + /** + * A list of 2 VPC subnet IDs from the same VPC. +Subnet IDs must be mapped to two unique availability zones (AZ). + + */ + SubnetIds: __listOf__string; + } + export interface InputWhitelistRule { + /** + * The IPv4 CIDR that's whitelisted. + */ + Cidr?: __string; + } + export interface InputWhitelistRuleCidr { + /** + * The IPv4 CIDR to whitelist. + */ + Cidr?: __string; + } + export interface KeyProviderSettings { + StaticKeySettings?: StaticKeySettings; + } + export interface ListChannelsRequest { + MaxResults?: MaxResults; + NextToken?: __string; + } + export interface ListChannelsResponse { + Channels?: __listOfChannelSummary; + NextToken?: __string; + } + export interface ListInputSecurityGroupsRequest { + MaxResults?: MaxResults; + NextToken?: __string; + } + export interface ListInputSecurityGroupsResponse { + /** + * List of input security groups + */ + InputSecurityGroups?: __listOfInputSecurityGroup; + NextToken?: __string; + } + export interface ListInputsRequest { + MaxResults?: MaxResults; + NextToken?: __string; + } + export interface ListInputsResponse { + Inputs?: __listOfInput; + NextToken?: __string; + } + export interface ListOfferingsRequest { + /** + * Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE' + + */ + ChannelClass?: __string; + /** + * Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID) + + */ + ChannelConfiguration?: __string; + /** + * Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO' + */ + Codec?: __string; + MaxResults?: MaxResults; + /** + * Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS' + + */ + MaximumBitrate?: __string; + /** + * Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS' + */ + MaximumFramerate?: __string; + NextToken?: __string; + /** + * Filter by resolution, 'SD', 'HD', or 'UHD' + */ + Resolution?: __string; + /** + * Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' + */ + ResourceType?: __string; + /** + * Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION' + + */ + SpecialFeature?: __string; + /** + * Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM' + + */ + VideoQuality?: __string; + } + export interface ListOfferingsResponse { + /** + * Token to retrieve the next page of results + */ + NextToken?: __string; + /** + * List of offerings + */ + Offerings?: __listOfOffering; + } + export interface ListReservationsRequest { + /** + * Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE' + + */ + ChannelClass?: __string; + /** + * Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO' + */ + Codec?: __string; + MaxResults?: MaxResults; + /** + * Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS' + + */ + MaximumBitrate?: __string; + /** + * Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS' + */ + MaximumFramerate?: __string; + NextToken?: __string; + /** + * Filter by resolution, 'SD', 'HD', or 'UHD' + */ + Resolution?: __string; + /** + * Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' + */ + ResourceType?: __string; + /** + * Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION' + + */ + SpecialFeature?: __string; + /** + * Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM' + + */ + VideoQuality?: __string; + } + export interface ListReservationsResponse { + /** + * Token to retrieve the next page of results + */ + NextToken?: __string; + /** + * List of reservations + */ + Reservations?: __listOfReservation; + } + export interface ListTagsForResourceRequest { + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + Tags?: Tags; + } + export type LogLevel = "ERROR"|"WARNING"|"INFO"|"DEBUG"|"DISABLED"|string; + export type M2tsAbsentInputAudioBehavior = "DROP"|"ENCODE_SILENCE"|string; + export type M2tsArib = "DISABLED"|"ENABLED"|string; + export type M2tsAribCaptionsPidControl = "AUTO"|"USE_CONFIGURED"|string; + export type M2tsAudioBufferModel = "ATSC"|"DVB"|string; + export type M2tsAudioInterval = "VIDEO_AND_FIXED_INTERVALS"|"VIDEO_INTERVAL"|string; + export type M2tsAudioStreamType = "ATSC"|"DVB"|string; + export type M2tsBufferModel = "MULTIPLEX"|"NONE"|string; + export type M2tsCcDescriptor = "DISABLED"|"ENABLED"|string; + export type M2tsEbifControl = "NONE"|"PASSTHROUGH"|string; + export type M2tsEbpPlacement = "VIDEO_AND_AUDIO_PIDS"|"VIDEO_PID"|string; + export type M2tsEsRateInPes = "EXCLUDE"|"INCLUDE"|string; + export type M2tsKlv = "NONE"|"PASSTHROUGH"|string; + export type M2tsPcrControl = "CONFIGURED_PCR_PERIOD"|"PCR_EVERY_PES_PACKET"|string; + export type M2tsRateMode = "CBR"|"VBR"|string; + export type M2tsScte35Control = "NONE"|"PASSTHROUGH"|string; + export type M2tsSegmentationMarkers = "EBP"|"EBP_LEGACY"|"NONE"|"PSI_SEGSTART"|"RAI_ADAPT"|"RAI_SEGSTART"|string; + export type M2tsSegmentationStyle = "MAINTAIN_CADENCE"|"RESET_CADENCE"|string; + export interface M2tsSettings { + /** + * When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. + */ + AbsentInputAudioBehavior?: M2tsAbsentInputAudioBehavior; + /** + * When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. + */ + Arib?: M2tsArib; + /** + * Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + AribCaptionsPid?: __string; + /** + * If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. + */ + AribCaptionsPidControl?: M2tsAribCaptionsPidControl; + /** + * When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. + */ + AudioBufferModel?: M2tsAudioBufferModel; + /** + * The number of audio frames to insert for each PES packet. + */ + AudioFramesPerPes?: __integerMin0; + /** + * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). + */ + AudioPids?: __string; + /** + * When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. + */ + AudioStreamType?: M2tsAudioStreamType; + /** + * The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. + */ + Bitrate?: __integerMin0; + /** + * If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. + */ + BufferModel?: M2tsBufferModel; + /** + * When set to enabled, generates captionServiceDescriptor in PMT. + */ + CcDescriptor?: M2tsCcDescriptor; + /** + * Inserts DVB Network Information Table (NIT) at the specified table repetition interval. + */ + DvbNitSettings?: DvbNitSettings; + /** + * Inserts DVB Service Description Table (SDT) at the specified table repetition interval. + */ + DvbSdtSettings?: DvbSdtSettings; + /** + * Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). + */ + DvbSubPids?: __string; + /** + * Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. + */ + DvbTdtSettings?: DvbTdtSettings; + /** + * Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + DvbTeletextPid?: __string; + /** + * If set to passthrough, passes any EBIF data from the input source to this output. + */ + Ebif?: M2tsEbifControl; + /** + * When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. + */ + EbpAudioInterval?: M2tsAudioInterval; + /** + * When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. + */ + EbpLookaheadMs?: __integerMin0Max10000; + /** + * Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. + */ + EbpPlacement?: M2tsEbpPlacement; + /** + * This field is unused and deprecated. + */ + EcmPid?: __string; + /** + * Include or exclude the ES Rate field in the PES header. + */ + EsRateInPes?: M2tsEsRateInPes; + /** + * Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + EtvPlatformPid?: __string; + /** + * Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + EtvSignalPid?: __string; + /** + * The length in seconds of each fragment. Only used with EBP markers. + */ + FragmentTime?: __doubleMin0; + /** + * If set to passthrough, passes any KLV data from the input source to this output. + */ + Klv?: M2tsKlv; + /** + * Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). + */ + KlvDataPids?: __string; + /** + * Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. + */ + NullPacketBitrate?: __doubleMin0; + /** + * The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. + */ + PatInterval?: __integerMin0Max1000; + /** + * When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. + */ + PcrControl?: M2tsPcrControl; + /** + * Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. + */ + PcrPeriod?: __integerMin0Max500; + /** + * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + PcrPid?: __string; + /** + * The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. + */ + PmtInterval?: __integerMin0Max1000; + /** + * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + PmtPid?: __string; + /** + * The value of the program number field in the Program Map Table. + */ + ProgramNum?: __integerMin0Max65535; + /** + * When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. + */ + RateMode?: M2tsRateMode; + /** + * Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). + */ + Scte27Pids?: __string; + /** + * Optionally pass SCTE-35 signals from the input source to this output. + */ + Scte35Control?: M2tsScte35Control; + /** + * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + Scte35Pid?: __string; + /** + * Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. + */ + SegmentationMarkers?: M2tsSegmentationMarkers; + /** + * The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. + +When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. + +When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. + */ + SegmentationStyle?: M2tsSegmentationStyle; + /** + * The length in seconds of each segment. Required unless markers is set to None_. + */ + SegmentationTime?: __doubleMin1; + /** + * When set to passthrough, timed metadata will be passed through from input to output. + */ + TimedMetadataBehavior?: M2tsTimedMetadataBehavior; + /** + * Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + TimedMetadataPid?: __string; + /** + * The value of the transport stream ID field in the Program Map Table. + */ + TransportStreamId?: __integerMin0Max65535; + /** + * Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + VideoPid?: __string; + } + export type M2tsTimedMetadataBehavior = "NO_PASSTHROUGH"|"PASSTHROUGH"|string; + export type M3u8PcrControl = "CONFIGURED_PCR_PERIOD"|"PCR_EVERY_PES_PACKET"|string; + export type M3u8Scte35Behavior = "NO_PASSTHROUGH"|"PASSTHROUGH"|string; + export interface M3u8Settings { + /** + * The number of audio frames to insert for each PES packet. + */ + AudioFramesPerPes?: __integerMin0; + /** + * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. + */ + AudioPids?: __string; + /** + * This parameter is unused and deprecated. + */ + EcmPid?: __string; + /** + * The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file. + */ + PatInterval?: __integerMin0Max1000; + /** + * When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. + */ + PcrControl?: M3u8PcrControl; + /** + * Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. + */ + PcrPeriod?: __integerMin0Max500; + /** + * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. + */ + PcrPid?: __string; + /** + * The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file. + */ + PmtInterval?: __integerMin0Max1000; + /** + * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. + */ + PmtPid?: __string; + /** + * The value of the program number field in the Program Map Table. + */ + ProgramNum?: __integerMin0Max65535; + /** + * If set to passthrough, passes any SCTE-35 signals from the input source to this output. + */ + Scte35Behavior?: M3u8Scte35Behavior; + /** + * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. + */ + Scte35Pid?: __string; + /** + * When set to passthrough, timed metadata is passed through from input to output. + */ + TimedMetadataBehavior?: M3u8TimedMetadataBehavior; + /** + * Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). + */ + TimedMetadataPid?: __string; + /** + * The value of the transport stream ID field in the Program Map Table. + */ + TransportStreamId?: __integerMin0Max65535; + /** + * Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. + */ + VideoPid?: __string; + } + export type M3u8TimedMetadataBehavior = "NO_PASSTHROUGH"|"PASSTHROUGH"|string; + export type MaxResults = number; + export interface MediaConnectFlow { + /** + * The unique ARN of the MediaConnect Flow being used as a source. + */ + FlowArn?: __string; + } + export interface MediaConnectFlowRequest { + /** + * The ARN of the MediaConnect Flow that you want to use as a source. + */ + FlowArn?: __string; + } + export interface MediaPackageGroupSettings { + /** + * MediaPackage channel destination. + */ + Destination: OutputLocationRef; + } + export interface MediaPackageOutputDestinationSettings { + /** + * ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. + */ + ChannelId?: __stringMin1; + } + export interface MediaPackageOutputSettings { + } + export type Mp2CodingMode = "CODING_MODE_1_0"|"CODING_MODE_2_0"|string; + export interface Mp2Settings { + /** + * Average bitrate in bits/second. + */ + Bitrate?: __double; + /** + * The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). + */ + CodingMode?: Mp2CodingMode; + /** + * Sample rate in Hz. + */ + SampleRate?: __double; + } + export interface MsSmoothGroupSettings { + /** + * The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none". + */ + AcquisitionPointId?: __string; + /** + * If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. + */ + AudioOnlyTimecodeControl?: SmoothGroupAudioOnlyTimecodeControl; + /** + * If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. + */ + CertificateMode?: SmoothGroupCertificateMode; + /** + * Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. + */ + ConnectionRetryInterval?: __integerMin0; + /** + * Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. + */ + Destination: OutputLocationRef; + /** + * MS Smooth event ID to be sent to the IIS server. + +Should only be specified if eventIdMode is set to useConfigured. + */ + EventId?: __string; + /** + * Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. + +Options: +- "useConfigured" - use the value provided in eventId +- "useTimestamp" - generate and send an event ID based on the current timestamp +- "noEventId" - do not send an event ID to the IIS server. + */ + EventIdMode?: SmoothGroupEventIdMode; + /** + * When set to sendEos, send EOS signal to IIS server when stopping the event + */ + EventStopBehavior?: SmoothGroupEventStopBehavior; + /** + * Size in seconds of file cache for streaming outputs. + */ + FilecacheDuration?: __integerMin0; + /** + * Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. + */ + FragmentLength?: __integerMin1; + /** + * Parameter that control output group behavior on input loss. + */ + InputLossAction?: InputLossActionForMsSmoothOut; + /** + * Number of retry attempts. + */ + NumRetries?: __integerMin0; + /** + * Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. + */ + RestartDelay?: __integerMin0; + /** + * useInputSegmentation has been deprecated. The configured segment size is always used. + */ + SegmentationMode?: SmoothGroupSegmentationMode; + /** + * Number of milliseconds to delay the output from the second pipeline. + */ + SendDelayMs?: __integerMin0Max10000; + /** + * If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. + */ + SparseTrackType?: SmoothGroupSparseTrackType; + /** + * When set to send, send stream manifest so publishing point doesn't start until all streams start. + */ + StreamManifestBehavior?: SmoothGroupStreamManifestBehavior; + /** + * Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. + */ + TimestampOffset?: __string; + /** + * Type of timestamp date offset to use. +- useEventStartDate: Use the date the event was started as the offset +- useConfiguredOffset: Use an explicitly configured date as the offset + */ + TimestampOffsetMode?: SmoothGroupTimestampOffsetMode; + } + export interface MsSmoothOutputSettings { + /** + * String concatenated to the end of the destination filename. Required for multiple outputs of the same type. + */ + NameModifier?: __string; + } + export type NetworkInputServerValidation = "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"|"CHECK_CRYPTOGRAPHY_ONLY"|string; + export interface NetworkInputSettings { + /** + * Specifies HLS input settings when the uri is for a HLS manifest. + */ + HlsInputSettings?: HlsInputSettings; + /** + * Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. + */ + ServerValidation?: NetworkInputServerValidation; + } + export interface Offering { + /** + * Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' + */ + Arn?: __string; + /** + * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + */ + CurrencyCode?: __string; + /** + * Lease duration, e.g. '12' + */ + Duration?: __integer; + /** + * Units for duration, e.g. 'MONTHS' + */ + DurationUnits?: OfferingDurationUnits; + /** + * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + */ + FixedPrice?: __double; + /** + * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' + */ + OfferingDescription?: __string; + /** + * Unique offering ID, e.g. '87654321' + */ + OfferingId?: __string; + /** + * Offering type, e.g. 'NO_UPFRONT' + */ + OfferingType?: OfferingType; + /** + * AWS region, e.g. 'us-west-2' + */ + Region?: __string; + /** + * Resource configuration details + */ + ResourceSpecification?: ReservationResourceSpecification; + /** + * Recurring usage charge for each reserved resource, e.g. '157.0' + */ + UsagePrice?: __double; + } + export type OfferingDurationUnits = "MONTHS"|string; + export type OfferingType = "NO_UPFRONT"|string; + export interface Output { + /** + * The names of the AudioDescriptions used as audio sources for this output. + */ + AudioDescriptionNames?: __listOf__string; + /** + * The names of the CaptionDescriptions used as caption sources for this output. + */ + CaptionDescriptionNames?: __listOf__string; + /** + * The name used to identify an output. + */ + OutputName?: __stringMin1Max255; + /** + * Output type-specific settings. + */ + OutputSettings: OutputSettings; + /** + * The name of the VideoDescription used as the source for this output. + */ + VideoDescriptionName?: __string; + } + export interface OutputDestination { + /** + * User-specified id. This is used in an output group or an output. + */ + Id?: __string; + /** + * Destination settings for a MediaPackage output; one destination for both encoders. + */ + MediaPackageSettings?: __listOfMediaPackageOutputDestinationSettings; + /** + * Destination settings for a standard output; one destination for each redundant encoder. + */ + Settings?: __listOfOutputDestinationSettings; + } + export interface OutputDestinationSettings { + /** + * key used to extract the password from EC2 Parameter store + */ + PasswordParam?: __string; + /** + * Stream name for RTMP destinations (URLs of type rtmp://) + */ + StreamName?: __string; + /** + * A URL specifying a destination + */ + Url?: __string; + /** + * username for destination + */ + Username?: __string; + } + export interface OutputGroup { + /** + * Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed. + */ + Name?: __stringMax32; + /** + * Settings associated with the output group. + */ + OutputGroupSettings: OutputGroupSettings; + Outputs: __listOfOutput; + } + export interface OutputGroupSettings { + ArchiveGroupSettings?: ArchiveGroupSettings; + FrameCaptureGroupSettings?: FrameCaptureGroupSettings; + HlsGroupSettings?: HlsGroupSettings; + MediaPackageGroupSettings?: MediaPackageGroupSettings; + MsSmoothGroupSettings?: MsSmoothGroupSettings; + RtmpGroupSettings?: RtmpGroupSettings; + UdpGroupSettings?: UdpGroupSettings; + } + export interface OutputLocationRef { + DestinationRefId?: __string; + } + export interface OutputSettings { + ArchiveOutputSettings?: ArchiveOutputSettings; + FrameCaptureOutputSettings?: FrameCaptureOutputSettings; + HlsOutputSettings?: HlsOutputSettings; + MediaPackageOutputSettings?: MediaPackageOutputSettings; + MsSmoothOutputSettings?: MsSmoothOutputSettings; + RtmpOutputSettings?: RtmpOutputSettings; + UdpOutputSettings?: UdpOutputSettings; + } + export interface PassThroughSettings { + } + export interface PauseStateScheduleActionSettings { + Pipelines?: __listOfPipelinePauseStateSettings; + } + export type PipelineId = "PIPELINE_0"|"PIPELINE_1"|string; + export interface PipelinePauseStateSettings { + /** + * Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1"). + */ + PipelineId: PipelineId; + } + export interface PurchaseOfferingRequest { + /** + * Number of resources + */ + Count: __integerMin1; + /** + * Name for the new reservation + */ + Name?: __string; + /** + * Offering to purchase, e.g. '87654321' + */ + OfferingId: __string; + /** + * Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. + */ + RequestId?: __string; + /** + * Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now. + */ + Start?: __string; + /** + * A collection of key-value pairs + */ + Tags?: Tags; + } + export interface PurchaseOfferingResponse { + Reservation?: Reservation; + } + export interface RemixSettings { + /** + * Mapping of input channels to output channels, with appropriate gain adjustments. + */ + ChannelMappings: __listOfAudioChannelMapping; + /** + * Number of input channels to be used. + */ + ChannelsIn?: __integerMin1Max16; + /** + * Number of output channels to be produced. +Valid values: 1, 2, 4, 6, 8 + */ + ChannelsOut?: __integerMin1Max8; + } + export interface Reservation { + /** + * Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' + */ + Arn?: __string; + /** + * Number of reserved resources + */ + Count?: __integer; + /** + * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' + */ + CurrencyCode?: __string; + /** + * Lease duration, e.g. '12' + */ + Duration?: __integer; + /** + * Units for duration, e.g. 'MONTHS' + */ + DurationUnits?: OfferingDurationUnits; + /** + * Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' + */ + End?: __string; + /** + * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering + */ + FixedPrice?: __double; + /** + * User specified reservation name + */ + Name?: __string; + /** + * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' + */ + OfferingDescription?: __string; + /** + * Unique offering ID, e.g. '87654321' + */ + OfferingId?: __string; + /** + * Offering type, e.g. 'NO_UPFRONT' + */ + OfferingType?: OfferingType; + /** + * AWS region, e.g. 'us-west-2' + */ + Region?: __string; + /** + * Unique reservation ID, e.g. '1234567' + */ + ReservationId?: __string; + /** + * Resource configuration details + */ + ResourceSpecification?: ReservationResourceSpecification; + /** + * Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' + */ + Start?: __string; + /** + * Current state of reservation, e.g. 'ACTIVE' + */ + State?: ReservationState; + /** + * A collection of key-value pairs + */ + Tags?: Tags; + /** + * Recurring usage charge for each reserved resource, e.g. '157.0' + */ + UsagePrice?: __double; + } + export type ReservationCodec = "MPEG2"|"AVC"|"HEVC"|"AUDIO"|string; + export type ReservationMaximumBitrate = "MAX_10_MBPS"|"MAX_20_MBPS"|"MAX_50_MBPS"|string; + export type ReservationMaximumFramerate = "MAX_30_FPS"|"MAX_60_FPS"|string; + export type ReservationResolution = "SD"|"HD"|"UHD"|string; + export interface ReservationResourceSpecification { + /** + * Channel class, e.g. 'STANDARD' + */ + ChannelClass?: ChannelClass; + /** + * Codec, e.g. 'AVC' + */ + Codec?: ReservationCodec; + /** + * Maximum bitrate, e.g. 'MAX_20_MBPS' + */ + MaximumBitrate?: ReservationMaximumBitrate; + /** + * Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) + */ + MaximumFramerate?: ReservationMaximumFramerate; + /** + * Resolution, e.g. 'HD' + */ + Resolution?: ReservationResolution; + /** + * Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' + */ + ResourceType?: ReservationResourceType; + /** + * Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) + */ + SpecialFeature?: ReservationSpecialFeature; + /** + * Video quality, e.g. 'STANDARD' (Outputs only) + */ + VideoQuality?: ReservationVideoQuality; + } + export type ReservationResourceType = "INPUT"|"OUTPUT"|"CHANNEL"|string; + export type ReservationSpecialFeature = "ADVANCED_AUDIO"|"AUDIO_NORMALIZATION"|string; + export type ReservationState = "ACTIVE"|"EXPIRED"|"CANCELED"|"DELETED"|string; + export type ReservationVideoQuality = "STANDARD"|"ENHANCED"|"PREMIUM"|string; + export type RtmpCacheFullBehavior = "DISCONNECT_IMMEDIATELY"|"WAIT_FOR_SERVER"|string; + export type RtmpCaptionData = "ALL"|"FIELD1_608"|"FIELD1_AND_FIELD2_608"|string; + export interface RtmpCaptionInfoDestinationSettings { + } + export interface RtmpGroupSettings { + /** + * Authentication scheme to use when connecting with CDN + */ + AuthenticationScheme?: AuthenticationScheme; + /** + * Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. + */ + CacheFullBehavior?: RtmpCacheFullBehavior; + /** + * Cache length, in seconds, is used to calculate buffer size. + */ + CacheLength?: __integerMin30; + /** + * Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. + */ + CaptionData?: RtmpCaptionData; + /** + * Controls the behavior of this RTMP group if input becomes unavailable. + +- emitOutput: Emit a slate until input returns. +- pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. + */ + InputLossAction?: InputLossActionForRtmpOut; + /** + * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. + */ + RestartDelay?: __integerMin0; + } + export type RtmpOutputCertificateMode = "SELF_SIGNED"|"VERIFY_AUTHENTICITY"|string; + export interface RtmpOutputSettings { + /** + * If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. + */ + CertificateMode?: RtmpOutputCertificateMode; + /** + * Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. + */ + ConnectionRetryInterval?: __integerMin1; + /** + * The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. + */ + Destination: OutputLocationRef; + /** + * Number of retry attempts. + */ + NumRetries?: __integerMin0; + } + export interface ScheduleAction { + /** + * The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused. + */ + ActionName: __string; + /** + * Settings for this schedule action. + */ + ScheduleActionSettings: ScheduleActionSettings; + /** + * The time for the action to start in the channel. + */ + ScheduleActionStartSettings: ScheduleActionStartSettings; + } + export interface ScheduleActionSettings { + /** + * Action to insert HLS metadata + */ + HlsTimedMetadataSettings?: HlsTimedMetadataScheduleActionSettings; + /** + * Action to switch the input + */ + InputSwitchSettings?: InputSwitchScheduleActionSettings; + /** + * Action to pause or unpause one or both channel pipelines + */ + PauseStateSettings?: PauseStateScheduleActionSettings; + /** + * Action to insert SCTE-35 return_to_network message + */ + Scte35ReturnToNetworkSettings?: Scte35ReturnToNetworkScheduleActionSettings; + /** + * Action to insert SCTE-35 splice_insert message + */ + Scte35SpliceInsertSettings?: Scte35SpliceInsertScheduleActionSettings; + /** + * Action to insert SCTE-35 time_signal message + */ + Scte35TimeSignalSettings?: Scte35TimeSignalScheduleActionSettings; + /** + * Action to activate a static image overlay + */ + StaticImageActivateSettings?: StaticImageActivateScheduleActionSettings; + /** + * Action to deactivate a static image overlay + */ + StaticImageDeactivateSettings?: StaticImageDeactivateScheduleActionSettings; + } + export interface ScheduleActionStartSettings { + /** + * Holds the start time for the action. + */ + FixedModeScheduleActionStartSettings?: FixedModeScheduleActionStartSettings; + /** + * Specifies an action to follow for scheduling this action. + */ + FollowModeScheduleActionStartSettings?: FollowModeScheduleActionStartSettings; + } + export type Scte20Convert608To708 = "DISABLED"|"UPCONVERT"|string; + export interface Scte20PlusEmbeddedDestinationSettings { + } + export interface Scte20SourceSettings { + /** + * If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. + */ + Convert608To708?: Scte20Convert608To708; + /** + * Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. + */ + Source608ChannelNumber?: __integerMin1Max4; + } + export interface Scte27DestinationSettings { + } + export interface Scte27SourceSettings { + /** + * The pid field is used in conjunction with the caption selector languageCode field as follows: + - Specify PID and Language: Extracts captions from that PID; the language is "informational". + - Specify PID and omit Language: Extracts the specified PID. + - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. + - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through. + */ + Pid?: __integerMin1; + } + export type Scte35AposNoRegionalBlackoutBehavior = "FOLLOW"|"IGNORE"|string; + export type Scte35AposWebDeliveryAllowedBehavior = "FOLLOW"|"IGNORE"|string; + export type Scte35ArchiveAllowedFlag = "ARCHIVE_NOT_ALLOWED"|"ARCHIVE_ALLOWED"|string; + export interface Scte35DeliveryRestrictions { + /** + * Corresponds to SCTE-35 archive_allowed_flag. + */ + ArchiveAllowedFlag: Scte35ArchiveAllowedFlag; + /** + * Corresponds to SCTE-35 device_restrictions parameter. + */ + DeviceRestrictions: Scte35DeviceRestrictions; + /** + * Corresponds to SCTE-35 no_regional_blackout_flag parameter. + */ + NoRegionalBlackoutFlag: Scte35NoRegionalBlackoutFlag; + /** + * Corresponds to SCTE-35 web_delivery_allowed_flag parameter. + */ + WebDeliveryAllowedFlag: Scte35WebDeliveryAllowedFlag; + } + export interface Scte35Descriptor { + /** + * SCTE-35 Descriptor Settings. + */ + Scte35DescriptorSettings: Scte35DescriptorSettings; + } + export interface Scte35DescriptorSettings { + /** + * SCTE-35 Segmentation Descriptor. + */ + SegmentationDescriptorScte35DescriptorSettings: Scte35SegmentationDescriptor; + } + export type Scte35DeviceRestrictions = "NONE"|"RESTRICT_GROUP0"|"RESTRICT_GROUP1"|"RESTRICT_GROUP2"|string; + export type Scte35NoRegionalBlackoutFlag = "REGIONAL_BLACKOUT"|"NO_REGIONAL_BLACKOUT"|string; + export interface Scte35ReturnToNetworkScheduleActionSettings { + /** + * The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35. + */ + SpliceEventId: __integerMin0Max4294967295; + } + export type Scte35SegmentationCancelIndicator = "SEGMENTATION_EVENT_NOT_CANCELED"|"SEGMENTATION_EVENT_CANCELED"|string; + export interface Scte35SegmentationDescriptor { + /** + * Holds the four SCTE-35 delivery restriction parameters. + */ + DeliveryRestrictions?: Scte35DeliveryRestrictions; + /** + * Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id. + */ + SegmentNum?: __integerMin0Max255; + /** + * Corresponds to SCTE-35 segmentation_event_cancel_indicator. + */ + SegmentationCancelIndicator: Scte35SegmentationCancelIndicator; + /** + * Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message. + */ + SegmentationDuration?: __integerMin0Max1099511627775; + /** + * Corresponds to SCTE-35 segmentation_event_id. + */ + SegmentationEventId: __integerMin0Max4294967295; + /** + * Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52"). + */ + SegmentationTypeId?: __integerMin0Max255; + /** + * Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e. + */ + SegmentationUpid?: __string; + /** + * Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12"). + */ + SegmentationUpidType?: __integerMin0Max255; + /** + * Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id. + */ + SegmentsExpected?: __integerMin0Max255; + /** + * Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id. + */ + SubSegmentNum?: __integerMin0Max255; + /** + * Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id. + */ + SubSegmentsExpected?: __integerMin0Max255; + } + export interface Scte35SpliceInsert { + /** + * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. + */ + AdAvailOffset?: __integerMinNegative1000Max1000; + /** + * When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates + */ + NoRegionalBlackoutFlag?: Scte35SpliceInsertNoRegionalBlackoutBehavior; + /** + * When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates + */ + WebDeliveryAllowedFlag?: Scte35SpliceInsertWebDeliveryAllowedBehavior; + } + export type Scte35SpliceInsertNoRegionalBlackoutBehavior = "FOLLOW"|"IGNORE"|string; + export interface Scte35SpliceInsertScheduleActionSettings { + /** + * Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time. + */ + Duration?: __integerMin0Max8589934591; + /** + * The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35. + */ + SpliceEventId: __integerMin0Max4294967295; + } + export type Scte35SpliceInsertWebDeliveryAllowedBehavior = "FOLLOW"|"IGNORE"|string; + export interface Scte35TimeSignalApos { + /** + * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. + */ + AdAvailOffset?: __integerMinNegative1000Max1000; + /** + * When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates + */ + NoRegionalBlackoutFlag?: Scte35AposNoRegionalBlackoutBehavior; + /** + * When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates + */ + WebDeliveryAllowedFlag?: Scte35AposWebDeliveryAllowedBehavior; + } + export interface Scte35TimeSignalScheduleActionSettings { + /** + * The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal. + */ + Scte35Descriptors: __listOfScte35Descriptor; + } + export type Scte35WebDeliveryAllowedFlag = "WEB_DELIVERY_NOT_ALLOWED"|"WEB_DELIVERY_ALLOWED"|string; + export type SmoothGroupAudioOnlyTimecodeControl = "PASSTHROUGH"|"USE_CONFIGURED_CLOCK"|string; + export type SmoothGroupCertificateMode = "SELF_SIGNED"|"VERIFY_AUTHENTICITY"|string; + export type SmoothGroupEventIdMode = "NO_EVENT_ID"|"USE_CONFIGURED"|"USE_TIMESTAMP"|string; + export type SmoothGroupEventStopBehavior = "NONE"|"SEND_EOS"|string; + export type SmoothGroupSegmentationMode = "USE_INPUT_SEGMENTATION"|"USE_SEGMENT_DURATION"|string; + export type SmoothGroupSparseTrackType = "NONE"|"SCTE_35"|string; + export type SmoothGroupStreamManifestBehavior = "DO_NOT_SEND"|"SEND"|string; + export type SmoothGroupTimestampOffsetMode = "USE_CONFIGURED_OFFSET"|"USE_EVENT_START_DATE"|string; + export interface SmpteTtDestinationSettings { + } + export interface StandardHlsSettings { + /** + * List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. + */ + AudioRenditionSets?: __string; + M3u8Settings: M3u8Settings; + } + export interface StartChannelRequest { + /** + * A request to start a channel + */ + ChannelId: __string; + } + export interface StartChannelResponse { + /** + * The unique arn of the channel. + */ + Arn?: __string; + /** + * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. + */ + ChannelClass?: ChannelClass; + /** + * A list of destinations of the channel. For UDP outputs, there is one +destination per output. For other types (HLS, for example), there is +one destination per packager. + + */ + Destinations?: __listOfOutputDestination; + /** + * The endpoints where outgoing connections initiate from + */ + EgressEndpoints?: __listOfChannelEgressEndpoint; + EncoderSettings?: EncoderSettings; + /** + * The unique id of the channel. + */ + Id?: __string; + /** + * List of input attachments for channel. + */ + InputAttachments?: __listOfInputAttachment; + InputSpecification?: InputSpecification; + /** + * The log level being written to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * The name of the channel. (user-mutable) + */ + Name?: __string; + /** + * The number of currently healthy pipelines. + */ + PipelinesRunningCount?: __integer; + /** + * The Amazon Resource Name (ARN) of the role assumed when running the Channel. + */ + RoleArn?: __string; + State?: ChannelState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + } + export interface StaticImageActivateScheduleActionSettings { + /** + * The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated. + */ + Duration?: __integerMin0; + /** + * The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in). + */ + FadeIn?: __integerMin0; + /** + * Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out). + */ + FadeOut?: __integerMin0; + /** + * The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay. + */ + Height?: __integerMin1; + /** + * The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video. + */ + Image: InputLocation; + /** + * Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right. + */ + ImageX?: __integerMin0; + /** + * Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom. + */ + ImageY?: __integerMin0; + /** + * The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0. + */ + Layer?: __integerMin0Max7; + /** + * Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100. + */ + Opacity?: __integerMin0Max100; + /** + * The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay. + */ + Width?: __integerMin1; + } + export interface StaticImageDeactivateScheduleActionSettings { + /** + * The time in milliseconds for the image to fade out. Default is 0 (no fade-out). + */ + FadeOut?: __integerMin0; + /** + * The image overlay layer to deactivate, 0 to 7. Default is 0. + */ + Layer?: __integerMin0Max7; + } + export interface StaticKeySettings { + /** + * The URL of the license server used for protecting content. + */ + KeyProviderServer?: InputLocation; + /** + * Static key value as a 32 character hexadecimal string. + */ + StaticKeyValue: __stringMin32Max32; + } + export interface StopChannelRequest { + /** + * A request to stop a running channel + */ + ChannelId: __string; + } + export interface StopChannelResponse { + /** + * The unique arn of the channel. + */ + Arn?: __string; + /** + * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. + */ + ChannelClass?: ChannelClass; + /** + * A list of destinations of the channel. For UDP outputs, there is one +destination per output. For other types (HLS, for example), there is +one destination per packager. + + */ + Destinations?: __listOfOutputDestination; + /** + * The endpoints where outgoing connections initiate from + */ + EgressEndpoints?: __listOfChannelEgressEndpoint; + EncoderSettings?: EncoderSettings; + /** + * The unique id of the channel. + */ + Id?: __string; + /** + * List of input attachments for channel. + */ + InputAttachments?: __listOfInputAttachment; + InputSpecification?: InputSpecification; + /** + * The log level being written to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * The name of the channel. (user-mutable) + */ + Name?: __string; + /** + * The number of currently healthy pipelines. + */ + PipelinesRunningCount?: __integer; + /** + * The Amazon Resource Name (ARN) of the role assumed when running the Channel. + */ + RoleArn?: __string; + State?: ChannelState; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + } + export type Tags = {[key: string]: __string}; + export interface TeletextDestinationSettings { + } + export interface TeletextSourceSettings { + /** + * Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix. + */ + PageNumber?: __string; + } + export interface TimecodeConfig { + /** + * Identifies the source for the timecode that will be associated with the events outputs. +-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). +-System Clock (systemclock): Use the UTC time. +-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. + */ + Source: TimecodeConfigSource; + /** + * Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified. + */ + SyncThreshold?: __integerMin1Max1000000; + } + export type TimecodeConfigSource = "EMBEDDED"|"SYSTEMCLOCK"|"ZEROBASED"|string; + export interface TtmlDestinationSettings { + /** + * When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. + */ + StyleControl?: TtmlDestinationStyleControl; + } + export type TtmlDestinationStyleControl = "PASSTHROUGH"|"USE_CONFIGURED"|string; + export interface UdpContainerSettings { + M2tsSettings?: M2tsSettings; + } + export interface UdpGroupSettings { + /** + * Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. + */ + InputLossAction?: InputLossActionForUdpOut; + /** + * Indicates ID3 frame that has the timecode. + */ + TimedMetadataId3Frame?: UdpTimedMetadataId3Frame; + /** + * Timed Metadata interval in seconds. + */ + TimedMetadataId3Period?: __integerMin0; + } + export interface UdpOutputSettings { + /** + * UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. + */ + BufferMsec?: __integerMin0Max10000; + ContainerSettings: UdpContainerSettings; + /** + * Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). + */ + Destination: OutputLocationRef; + /** + * Settings for enabling and adjusting Forward Error Correction on UDP outputs. + */ + FecOutputSettings?: FecOutputSettings; + } + export type UdpTimedMetadataId3Frame = "NONE"|"PRIV"|"TDRL"|string; + export interface UpdateChannelClassRequest { + /** + * The channel class that you wish to update this channel to use. + */ + ChannelClass: ChannelClass; + /** + * Channel Id of the channel whose class should be updated. + */ + ChannelId: __string; + /** + * A list of output destinations for this channel. + */ + Destinations?: __listOfOutputDestination; + } + export interface UpdateChannelClassResponse { + Channel?: Channel; + } + export interface UpdateChannelRequest { + /** + * channel ID + */ + ChannelId: __string; + /** + * A list of output destinations for this channel. + */ + Destinations?: __listOfOutputDestination; + /** + * The encoder settings for this channel. + */ + EncoderSettings?: EncoderSettings; + InputAttachments?: __listOfInputAttachment; + /** + * Specification of input for this channel (max. bitrate, resolution, codec, etc.) + */ + InputSpecification?: InputSpecification; + /** + * The log level to write to CloudWatch Logs. + */ + LogLevel?: LogLevel; + /** + * The name of the channel. + */ + Name?: __string; + /** + * An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed. + */ + RoleArn?: __string; + } + export interface UpdateChannelResponse { + Channel?: Channel; + } + export interface UpdateInputRequest { + /** + * Destination settings for PUSH type inputs. + */ + Destinations?: __listOfInputDestinationRequest; + /** + * Unique ID of the input. + */ + InputId: __string; + /** + * A list of security groups referenced by IDs to attach to the input. + */ + InputSecurityGroups?: __listOf__string; + /** + * A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one +Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a +separate Availability Zone as this ensures your EML input is redundant to AZ issues. + + */ + MediaConnectFlows?: __listOfMediaConnectFlowRequest; + /** + * Name of the input. + */ + Name?: __string; + /** + * The Amazon Resource Name (ARN) of the role this input assumes during and after creation. + */ + RoleArn?: __string; + /** + * The source URLs for a PULL-type input. Every PULL type input needs +exactly two source URLs for redundancy. +Only specify sources for PULL type Inputs. Leave Destinations empty. + + */ + Sources?: __listOfInputSourceRequest; + } + export interface UpdateInputResponse { + Input?: Input; + } + export interface UpdateInputSecurityGroupRequest { + /** + * The id of the Input Security Group to update. + */ + InputSecurityGroupId: __string; + /** + * A collection of key-value pairs. + */ + Tags?: Tags; + /** + * List of IPv4 CIDR addresses to whitelist + */ + WhitelistRules?: __listOfInputWhitelistRuleCidr; + } + export interface UpdateInputSecurityGroupResponse { + SecurityGroup?: InputSecurityGroup; + } + export interface UpdateReservationRequest { + /** + * Name of the reservation + */ + Name?: __string; + /** + * Unique reservation ID, e.g. '1234567' + */ + ReservationId: __string; + } + export interface UpdateReservationResponse { + Reservation?: Reservation; + } + export interface VideoCodecSettings { + FrameCaptureSettings?: FrameCaptureSettings; + H264Settings?: H264Settings; + } + export interface VideoDescription { + /** + * Video codec settings. + */ + CodecSettings?: VideoCodecSettings; + /** + * Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. + */ + Height?: __integer; + /** + * The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. + */ + Name: __string; + /** + * Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. + */ + RespondToAfd?: VideoDescriptionRespondToAfd; + /** + * STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. + */ + ScalingBehavior?: VideoDescriptionScalingBehavior; + /** + * Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. + */ + Sharpness?: __integerMin0Max100; + /** + * Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. + */ + Width?: __integer; + } + export type VideoDescriptionRespondToAfd = "NONE"|"PASSTHROUGH"|"RESPOND"|string; + export type VideoDescriptionScalingBehavior = "DEFAULT"|"STRETCH_TO_OUTPUT"|string; + export interface VideoSelector { + /** + * Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. + */ + ColorSpace?: VideoSelectorColorSpace; + /** + * Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. + */ + ColorSpaceUsage?: VideoSelectorColorSpaceUsage; + /** + * The video selector settings. + */ + SelectorSettings?: VideoSelectorSettings; + } + export type VideoSelectorColorSpace = "FOLLOW"|"REC_601"|"REC_709"|string; + export type VideoSelectorColorSpaceUsage = "FALLBACK"|"FORCE"|string; + export interface VideoSelectorPid { + /** + * Selects a specific PID from within a video source. + */ + Pid?: __integerMin0Max8191; + } + export interface VideoSelectorProgramId { + /** + * Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default. + */ + ProgramId?: __integerMin0Max65536; + } + export interface VideoSelectorSettings { + VideoSelectorPid?: VideoSelectorPid; + VideoSelectorProgramId?: VideoSelectorProgramId; + } + export interface WebvttDestinationSettings { + } + export type __double = number; + export type __doubleMin0 = number; + export type __doubleMin1 = number; + export type __doubleMinNegative59Max0 = number; + export type __integer = number; + export type __integerMin0 = number; + export type __integerMin0Max10 = number; + export type __integerMin0Max100 = number; + export type __integerMin0Max1000 = number; + export type __integerMin0Max10000 = number; + export type __integerMin0Max1000000 = number; + export type __integerMin0Max1099511627775 = number; + export type __integerMin0Max128 = number; + export type __integerMin0Max15 = number; + export type __integerMin0Max255 = number; + export type __integerMin0Max30 = number; + export type __integerMin0Max3600 = number; + export type __integerMin0Max4294967295 = number; + export type __integerMin0Max500 = number; + export type __integerMin0Max600 = number; + export type __integerMin0Max65535 = number; + export type __integerMin0Max65536 = number; + export type __integerMin0Max7 = number; + export type __integerMin0Max8191 = number; + export type __integerMin0Max8589934591 = number; + export type __integerMin1 = number; + export type __integerMin1000 = number; + export type __integerMin1000Max30000 = number; + export type __integerMin1Max10 = number; + export type __integerMin1Max1000000 = number; + export type __integerMin1Max16 = number; + export type __integerMin1Max20 = number; + export type __integerMin1Max31 = number; + export type __integerMin1Max32 = number; + export type __integerMin1Max3600 = number; + export type __integerMin1Max4 = number; + export type __integerMin1Max5 = number; + export type __integerMin1Max6 = number; + export type __integerMin1Max8 = number; + export type __integerMin25Max10000 = number; + export type __integerMin25Max2000 = number; + export type __integerMin3 = number; + export type __integerMin30 = number; + export type __integerMin4Max20 = number; + export type __integerMin96Max600 = number; + export type __integerMinNegative1000Max1000 = number; + export type __integerMinNegative60Max6 = number; + export type __integerMinNegative60Max60 = number; + export type __listOfAudioChannelMapping = AudioChannelMapping[]; + export type __listOfAudioDescription = AudioDescription[]; + export type __listOfAudioSelector = AudioSelector[]; + export type __listOfCaptionDescription = CaptionDescription[]; + export type __listOfCaptionLanguageMapping = CaptionLanguageMapping[]; + export type __listOfCaptionSelector = CaptionSelector[]; + export type __listOfChannelEgressEndpoint = ChannelEgressEndpoint[]; + export type __listOfChannelSummary = ChannelSummary[]; + export type __listOfHlsAdMarkers = HlsAdMarkers[]; + export type __listOfInput = Input[]; + export type __listOfInputAttachment = InputAttachment[]; + export type __listOfInputChannelLevel = InputChannelLevel[]; + export type __listOfInputDestination = InputDestination[]; + export type __listOfInputDestinationRequest = InputDestinationRequest[]; + export type __listOfInputSecurityGroup = InputSecurityGroup[]; + export type __listOfInputSource = InputSource[]; + export type __listOfInputSourceRequest = InputSourceRequest[]; + export type __listOfInputWhitelistRule = InputWhitelistRule[]; + export type __listOfInputWhitelistRuleCidr = InputWhitelistRuleCidr[]; + export type __listOfMediaConnectFlow = MediaConnectFlow[]; + export type __listOfMediaConnectFlowRequest = MediaConnectFlowRequest[]; + export type __listOfMediaPackageOutputDestinationSettings = MediaPackageOutputDestinationSettings[]; + export type __listOfOffering = Offering[]; + export type __listOfOutput = Output[]; + export type __listOfOutputDestination = OutputDestination[]; + export type __listOfOutputDestinationSettings = OutputDestinationSettings[]; + export type __listOfOutputGroup = OutputGroup[]; + export type __listOfPipelinePauseStateSettings = PipelinePauseStateSettings[]; + export type __listOfReservation = Reservation[]; + export type __listOfScheduleAction = ScheduleAction[]; + export type __listOfScte35Descriptor = Scte35Descriptor[]; + export type __listOfVideoDescription = VideoDescription[]; + export type __listOf__string = __string[]; + export type __string = string; + export type __stringMax32 = string; + export type __stringMin1 = string; + export type __stringMin1Max255 = string; + export type __stringMin1Max256 = string; + export type __stringMin32Max32 = string; + export type __stringMin34Max34 = string; + export type __stringMin3Max3 = string; + export type __stringMin6Max6 = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-10-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MediaLive client. + */ + export import Types = MediaLive; +} +export = MediaLive; diff --git a/node_modules/aws-sdk/clients/medialive.js b/node_modules/aws-sdk/clients/medialive.js new file mode 100644 index 0000000..e7a2993 --- /dev/null +++ b/node_modules/aws-sdk/clients/medialive.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['medialive'] = {}; +AWS.MediaLive = Service.defineService('medialive', ['2017-10-14']); +Object.defineProperty(apiLoader.services['medialive'], '2017-10-14', { + get: function get() { + var model = require('../apis/medialive-2017-10-14.min.json'); + model.paginators = require('../apis/medialive-2017-10-14.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MediaLive; diff --git a/node_modules/aws-sdk/clients/mediapackage.d.ts b/node_modules/aws-sdk/clients/mediapackage.d.ts new file mode 100644 index 0000000..7b2def8 --- /dev/null +++ b/node_modules/aws-sdk/clients/mediapackage.d.ts @@ -0,0 +1,1011 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MediaPackage extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MediaPackage.Types.ClientConfiguration) + config: Config & MediaPackage.Types.ClientConfiguration; + /** + * Creates a new Channel. + */ + createChannel(params: MediaPackage.Types.CreateChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.CreateChannelResponse) => void): Request; + /** + * Creates a new Channel. + */ + createChannel(callback?: (err: AWSError, data: MediaPackage.Types.CreateChannelResponse) => void): Request; + /** + * Creates a new OriginEndpoint record. + */ + createOriginEndpoint(params: MediaPackage.Types.CreateOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.CreateOriginEndpointResponse) => void): Request; + /** + * Creates a new OriginEndpoint record. + */ + createOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.CreateOriginEndpointResponse) => void): Request; + /** + * Deletes an existing Channel. + */ + deleteChannel(params: MediaPackage.Types.DeleteChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.DeleteChannelResponse) => void): Request; + /** + * Deletes an existing Channel. + */ + deleteChannel(callback?: (err: AWSError, data: MediaPackage.Types.DeleteChannelResponse) => void): Request; + /** + * Deletes an existing OriginEndpoint. + */ + deleteOriginEndpoint(params: MediaPackage.Types.DeleteOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.DeleteOriginEndpointResponse) => void): Request; + /** + * Deletes an existing OriginEndpoint. + */ + deleteOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.DeleteOriginEndpointResponse) => void): Request; + /** + * Gets details about a Channel. + */ + describeChannel(params: MediaPackage.Types.DescribeChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.DescribeChannelResponse) => void): Request; + /** + * Gets details about a Channel. + */ + describeChannel(callback?: (err: AWSError, data: MediaPackage.Types.DescribeChannelResponse) => void): Request; + /** + * Gets details about an existing OriginEndpoint. + */ + describeOriginEndpoint(params: MediaPackage.Types.DescribeOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.DescribeOriginEndpointResponse) => void): Request; + /** + * Gets details about an existing OriginEndpoint. + */ + describeOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.DescribeOriginEndpointResponse) => void): Request; + /** + * Returns a collection of Channels. + */ + listChannels(params: MediaPackage.Types.ListChannelsRequest, callback?: (err: AWSError, data: MediaPackage.Types.ListChannelsResponse) => void): Request; + /** + * Returns a collection of Channels. + */ + listChannels(callback?: (err: AWSError, data: MediaPackage.Types.ListChannelsResponse) => void): Request; + /** + * Returns a collection of OriginEndpoint records. + */ + listOriginEndpoints(params: MediaPackage.Types.ListOriginEndpointsRequest, callback?: (err: AWSError, data: MediaPackage.Types.ListOriginEndpointsResponse) => void): Request; + /** + * Returns a collection of OriginEndpoint records. + */ + listOriginEndpoints(callback?: (err: AWSError, data: MediaPackage.Types.ListOriginEndpointsResponse) => void): Request; + /** + * + */ + listTagsForResource(params: MediaPackage.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaPackage.Types.ListTagsForResourceResponse) => void): Request; + /** + * + */ + listTagsForResource(callback?: (err: AWSError, data: MediaPackage.Types.ListTagsForResourceResponse) => void): Request; + /** + * Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead + */ + rotateChannelCredentials(params: MediaPackage.Types.RotateChannelCredentialsRequest, callback?: (err: AWSError, data: MediaPackage.Types.RotateChannelCredentialsResponse) => void): Request; + /** + * Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead + */ + rotateChannelCredentials(callback?: (err: AWSError, data: MediaPackage.Types.RotateChannelCredentialsResponse) => void): Request; + /** + * Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id. + */ + rotateIngestEndpointCredentials(params: MediaPackage.Types.RotateIngestEndpointCredentialsRequest, callback?: (err: AWSError, data: MediaPackage.Types.RotateIngestEndpointCredentialsResponse) => void): Request; + /** + * Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id. + */ + rotateIngestEndpointCredentials(callback?: (err: AWSError, data: MediaPackage.Types.RotateIngestEndpointCredentialsResponse) => void): Request; + /** + * + */ + tagResource(params: MediaPackage.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + untagResource(params: MediaPackage.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates an existing Channel. + */ + updateChannel(params: MediaPackage.Types.UpdateChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.UpdateChannelResponse) => void): Request; + /** + * Updates an existing Channel. + */ + updateChannel(callback?: (err: AWSError, data: MediaPackage.Types.UpdateChannelResponse) => void): Request; + /** + * Updates an existing OriginEndpoint. + */ + updateOriginEndpoint(params: MediaPackage.Types.UpdateOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.UpdateOriginEndpointResponse) => void): Request; + /** + * Updates an existing OriginEndpoint. + */ + updateOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.UpdateOriginEndpointResponse) => void): Request; +} +declare namespace MediaPackage { + export type AdMarkers = "NONE"|"SCTE35_ENHANCED"|"PASSTHROUGH"|string; + export interface Channel { + /** + * The Amazon Resource Name (ARN) assigned to the Channel. + */ + Arn?: __string; + /** + * A short text description of the Channel. + */ + Description?: __string; + HlsIngest?: HlsIngest; + /** + * The ID of the Channel. + */ + Id?: __string; + Tags?: Tags; + } + export interface CmafEncryption { + /** + * Time (in seconds) between each encryption key rotation. + */ + KeyRotationIntervalSeconds?: __integer; + SpekeKeyProvider: SpekeKeyProvider; + } + export interface CmafPackage { + Encryption?: CmafEncryption; + /** + * A list of HLS manifest configurations + */ + HlsManifests?: __listOfHlsManifest; + /** + * Duration (in seconds) of each segment. Actual segments will be +rounded to the nearest multiple of the source segment duration. + + */ + SegmentDurationSeconds?: __integer; + /** + * An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. + */ + SegmentPrefix?: __string; + StreamSelection?: StreamSelection; + } + export interface CmafPackageCreateOrUpdateParameters { + Encryption?: CmafEncryption; + /** + * A list of HLS manifest configurations + */ + HlsManifests?: __listOfHlsManifestCreateOrUpdateParameters; + /** + * Duration (in seconds) of each segment. Actual segments will be +rounded to the nearest multiple of the source segment duration. + + */ + SegmentDurationSeconds?: __integer; + /** + * An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. + */ + SegmentPrefix?: __string; + StreamSelection?: StreamSelection; + } + export interface CreateChannelRequest { + /** + * A short text description of the Channel. + */ + Description?: __string; + /** + * The ID of the Channel. The ID must be unique within the region and it +cannot be changed after a Channel is created. + + */ + Id: __string; + Tags?: Tags; + } + export interface CreateChannelResponse { + /** + * The Amazon Resource Name (ARN) assigned to the Channel. + */ + Arn?: __string; + /** + * A short text description of the Channel. + */ + Description?: __string; + HlsIngest?: HlsIngest; + /** + * The ID of the Channel. + */ + Id?: __string; + Tags?: Tags; + } + export interface CreateOriginEndpointRequest { + /** + * The ID of the Channel that the OriginEndpoint will be associated with. +This cannot be changed after the OriginEndpoint is created. + + */ + ChannelId: __string; + CmafPackage?: CmafPackageCreateOrUpdateParameters; + DashPackage?: DashPackage; + /** + * A short text description of the OriginEndpoint. + */ + Description?: __string; + HlsPackage?: HlsPackage; + /** + * The ID of the OriginEndpoint. The ID must be unique within the region +and it cannot be changed after the OriginEndpoint is created. + + */ + Id: __string; + /** + * A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index"). + */ + ManifestName?: __string; + MssPackage?: MssPackage; + /** + * Maximum duration (seconds) of content to retain for startover playback. +If not specified, startover playback will be disabled for the OriginEndpoint. + + */ + StartoverWindowSeconds?: __integer; + Tags?: Tags; + /** + * Amount of delay (seconds) to enforce on the playback of live content. +If not specified, there will be no time delay in effect for the OriginEndpoint. + + */ + TimeDelaySeconds?: __integer; + /** + * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. + */ + Whitelist?: __listOf__string; + } + export interface CreateOriginEndpointResponse { + /** + * The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + */ + Arn?: __string; + /** + * The ID of the Channel the OriginEndpoint is associated with. + */ + ChannelId?: __string; + CmafPackage?: CmafPackage; + DashPackage?: DashPackage; + /** + * A short text description of the OriginEndpoint. + */ + Description?: __string; + HlsPackage?: HlsPackage; + /** + * The ID of the OriginEndpoint. + */ + Id?: __string; + /** + * A short string appended to the end of the OriginEndpoint URL. + */ + ManifestName?: __string; + MssPackage?: MssPackage; + /** + * Maximum duration (seconds) of content to retain for startover playback. +If not specified, startover playback will be disabled for the OriginEndpoint. + + */ + StartoverWindowSeconds?: __integer; + Tags?: Tags; + /** + * Amount of delay (seconds) to enforce on the playback of live content. +If not specified, there will be no time delay in effect for the OriginEndpoint. + + */ + TimeDelaySeconds?: __integer; + /** + * The URL of the packaged OriginEndpoint for consumption. + */ + Url?: __string; + /** + * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. + */ + Whitelist?: __listOf__string; + } + export interface DashEncryption { + /** + * Time (in seconds) between each encryption key rotation. + */ + KeyRotationIntervalSeconds?: __integer; + SpekeKeyProvider: SpekeKeyProvider; + } + export interface DashPackage { + Encryption?: DashEncryption; + /** + * Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. + */ + ManifestLayout?: ManifestLayout; + /** + * Time window (in seconds) contained in each manifest. + */ + ManifestWindowSeconds?: __integer; + /** + * Minimum duration (in seconds) that a player will buffer media before starting the presentation. + */ + MinBufferTimeSeconds?: __integer; + /** + * Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD). + */ + MinUpdatePeriodSeconds?: __integer; + /** + * A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) +Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not +be partitioned into more than one period. If the list contains "ADS", new periods will be created where +the Channel source contains SCTE-35 ad markers. + + */ + PeriodTriggers?: __listOf__PeriodTriggersElement; + /** + * The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. + */ + Profile?: Profile; + /** + * Duration (in seconds) of each segment. Actual segments will be +rounded to the nearest multiple of the source segment duration. + + */ + SegmentDurationSeconds?: __integer; + /** + * Determines the type of SegmentTimeline included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. + */ + SegmentTemplateFormat?: SegmentTemplateFormat; + StreamSelection?: StreamSelection; + /** + * Duration (in seconds) to delay live content before presentation. + */ + SuggestedPresentationDelaySeconds?: __integer; + } + export interface DeleteChannelRequest { + /** + * The ID of the Channel to delete. + */ + Id: __string; + } + export interface DeleteChannelResponse { + } + export interface DeleteOriginEndpointRequest { + /** + * The ID of the OriginEndpoint to delete. + */ + Id: __string; + } + export interface DeleteOriginEndpointResponse { + } + export interface DescribeChannelRequest { + /** + * The ID of a Channel. + */ + Id: __string; + } + export interface DescribeChannelResponse { + /** + * The Amazon Resource Name (ARN) assigned to the Channel. + */ + Arn?: __string; + /** + * A short text description of the Channel. + */ + Description?: __string; + HlsIngest?: HlsIngest; + /** + * The ID of the Channel. + */ + Id?: __string; + Tags?: Tags; + } + export interface DescribeOriginEndpointRequest { + /** + * The ID of the OriginEndpoint. + */ + Id: __string; + } + export interface DescribeOriginEndpointResponse { + /** + * The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + */ + Arn?: __string; + /** + * The ID of the Channel the OriginEndpoint is associated with. + */ + ChannelId?: __string; + CmafPackage?: CmafPackage; + DashPackage?: DashPackage; + /** + * A short text description of the OriginEndpoint. + */ + Description?: __string; + HlsPackage?: HlsPackage; + /** + * The ID of the OriginEndpoint. + */ + Id?: __string; + /** + * A short string appended to the end of the OriginEndpoint URL. + */ + ManifestName?: __string; + MssPackage?: MssPackage; + /** + * Maximum duration (seconds) of content to retain for startover playback. +If not specified, startover playback will be disabled for the OriginEndpoint. + + */ + StartoverWindowSeconds?: __integer; + Tags?: Tags; + /** + * Amount of delay (seconds) to enforce on the playback of live content. +If not specified, there will be no time delay in effect for the OriginEndpoint. + + */ + TimeDelaySeconds?: __integer; + /** + * The URL of the packaged OriginEndpoint for consumption. + */ + Url?: __string; + /** + * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. + */ + Whitelist?: __listOf__string; + } + export type EncryptionMethod = "AES_128"|"SAMPLE_AES"|string; + export interface HlsEncryption { + /** + * A constant initialization vector for encryption (optional). +When not specified the initialization vector will be periodically rotated. + + */ + ConstantInitializationVector?: __string; + /** + * The encryption method to use. + */ + EncryptionMethod?: EncryptionMethod; + /** + * Interval (in seconds) between each encryption key rotation. + */ + KeyRotationIntervalSeconds?: __integer; + /** + * When enabled, the EXT-X-KEY tag will be repeated in output manifests. + */ + RepeatExtXKey?: __boolean; + SpekeKeyProvider: SpekeKeyProvider; + } + export interface HlsIngest { + /** + * A list of endpoints to which the source stream should be sent. + */ + IngestEndpoints?: __listOfIngestEndpoint; + } + export interface HlsManifest { + /** + * This setting controls how ad markers are included in the packaged OriginEndpoint. +"NONE" will omit all SCTE-35 ad markers from the output. +"PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad +markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. +"SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 +messages in the input source. + + */ + AdMarkers?: AdMarkers; + /** + * The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. + */ + Id: __string; + /** + * When enabled, an I-Frame only stream will be included in the output. + */ + IncludeIframeOnlyStream?: __boolean; + /** + * An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. + */ + ManifestName?: __string; + /** + * The HTTP Live Streaming (HLS) playlist type. +When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE +entry will be included in the media playlist. + + */ + PlaylistType?: PlaylistType; + /** + * Time window (in seconds) contained in each parent manifest. + */ + PlaylistWindowSeconds?: __integer; + /** + * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag +inserted into manifests. Additionally, when an interval is specified +ID3Timed Metadata messages will be generated every 5 seconds using the +ingest time of the content. +If the interval is not specified, or set to 0, then +no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no +ID3Timed Metadata messages will be generated. Note that irrespective +of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, +it will be passed through to HLS output. + + */ + ProgramDateTimeIntervalSeconds?: __integer; + /** + * The URL of the packaged OriginEndpoint for consumption. + */ + Url?: __string; + } + export interface HlsManifestCreateOrUpdateParameters { + /** + * This setting controls how ad markers are included in the packaged OriginEndpoint. +"NONE" will omit all SCTE-35 ad markers from the output. +"PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad +markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. +"SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 +messages in the input source. + + */ + AdMarkers?: AdMarkers; + /** + * The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. + */ + Id: __string; + /** + * When enabled, an I-Frame only stream will be included in the output. + */ + IncludeIframeOnlyStream?: __boolean; + /** + * An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. + */ + ManifestName?: __string; + /** + * The HTTP Live Streaming (HLS) playlist type. +When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE +entry will be included in the media playlist. + + */ + PlaylistType?: PlaylistType; + /** + * Time window (in seconds) contained in each parent manifest. + */ + PlaylistWindowSeconds?: __integer; + /** + * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag +inserted into manifests. Additionally, when an interval is specified +ID3Timed Metadata messages will be generated every 5 seconds using the +ingest time of the content. +If the interval is not specified, or set to 0, then +no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no +ID3Timed Metadata messages will be generated. Note that irrespective +of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, +it will be passed through to HLS output. + + */ + ProgramDateTimeIntervalSeconds?: __integer; + } + export interface HlsPackage { + /** + * This setting controls how ad markers are included in the packaged OriginEndpoint. +"NONE" will omit all SCTE-35 ad markers from the output. +"PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad +markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. +"SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 +messages in the input source. + + */ + AdMarkers?: AdMarkers; + Encryption?: HlsEncryption; + /** + * When enabled, an I-Frame only stream will be included in the output. + */ + IncludeIframeOnlyStream?: __boolean; + /** + * The HTTP Live Streaming (HLS) playlist type. +When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE +entry will be included in the media playlist. + + */ + PlaylistType?: PlaylistType; + /** + * Time window (in seconds) contained in each parent manifest. + */ + PlaylistWindowSeconds?: __integer; + /** + * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag +inserted into manifests. Additionally, when an interval is specified +ID3Timed Metadata messages will be generated every 5 seconds using the +ingest time of the content. +If the interval is not specified, or set to 0, then +no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no +ID3Timed Metadata messages will be generated. Note that irrespective +of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, +it will be passed through to HLS output. + + */ + ProgramDateTimeIntervalSeconds?: __integer; + /** + * Duration (in seconds) of each fragment. Actual fragments will be +rounded to the nearest multiple of the source fragment duration. + + */ + SegmentDurationSeconds?: __integer; + StreamSelection?: StreamSelection; + /** + * When enabled, audio streams will be placed in rendition groups in the output. + */ + UseAudioRenditionGroup?: __boolean; + } + export interface IngestEndpoint { + /** + * The system generated unique identifier for the IngestEndpoint + */ + Id?: __string; + /** + * The system generated password for ingest authentication. + */ + Password?: __string; + /** + * The ingest URL to which the source stream should be sent. + */ + Url?: __string; + /** + * The system generated username for ingest authentication. + */ + Username?: __string; + } + export interface ListChannelsRequest { + /** + * Upper bound on number of records to return. + */ + MaxResults?: MaxResults; + /** + * A token used to resume pagination from the end of a previous request. + */ + NextToken?: __string; + } + export interface ListChannelsResponse { + /** + * A list of Channel records. + */ + Channels?: __listOfChannel; + /** + * A token that can be used to resume pagination from the end of the collection. + */ + NextToken?: __string; + } + export interface ListOriginEndpointsRequest { + /** + * When specified, the request will return only OriginEndpoints associated with the given Channel ID. + */ + ChannelId?: __string; + /** + * The upper bound on the number of records to return. + */ + MaxResults?: MaxResults; + /** + * A token used to resume pagination from the end of a previous request. + */ + NextToken?: __string; + } + export interface ListOriginEndpointsResponse { + /** + * A token that can be used to resume pagination from the end of the collection. + */ + NextToken?: __string; + /** + * A list of OriginEndpoint records. + */ + OriginEndpoints?: __listOfOriginEndpoint; + } + export interface ListTagsForResourceRequest { + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + Tags?: __mapOf__string; + } + export type ManifestLayout = "FULL"|"COMPACT"|string; + export type MaxResults = number; + export interface MssEncryption { + SpekeKeyProvider: SpekeKeyProvider; + } + export interface MssPackage { + Encryption?: MssEncryption; + /** + * The time window (in seconds) contained in each manifest. + */ + ManifestWindowSeconds?: __integer; + /** + * The duration (in seconds) of each segment. + */ + SegmentDurationSeconds?: __integer; + StreamSelection?: StreamSelection; + } + export interface OriginEndpoint { + /** + * The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + */ + Arn?: __string; + /** + * The ID of the Channel the OriginEndpoint is associated with. + */ + ChannelId?: __string; + CmafPackage?: CmafPackage; + DashPackage?: DashPackage; + /** + * A short text description of the OriginEndpoint. + */ + Description?: __string; + HlsPackage?: HlsPackage; + /** + * The ID of the OriginEndpoint. + */ + Id?: __string; + /** + * A short string appended to the end of the OriginEndpoint URL. + */ + ManifestName?: __string; + MssPackage?: MssPackage; + /** + * Maximum duration (seconds) of content to retain for startover playback. +If not specified, startover playback will be disabled for the OriginEndpoint. + + */ + StartoverWindowSeconds?: __integer; + Tags?: Tags; + /** + * Amount of delay (seconds) to enforce on the playback of live content. +If not specified, there will be no time delay in effect for the OriginEndpoint. + + */ + TimeDelaySeconds?: __integer; + /** + * The URL of the packaged OriginEndpoint for consumption. + */ + Url?: __string; + /** + * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. + */ + Whitelist?: __listOf__string; + } + export type PlaylistType = "NONE"|"EVENT"|"VOD"|string; + export type Profile = "NONE"|"HBBTV_1_5"|string; + export interface RotateChannelCredentialsRequest { + /** + * The ID of the channel to update. + */ + Id: __string; + } + export interface RotateChannelCredentialsResponse { + /** + * The Amazon Resource Name (ARN) assigned to the Channel. + */ + Arn?: __string; + /** + * A short text description of the Channel. + */ + Description?: __string; + HlsIngest?: HlsIngest; + /** + * The ID of the Channel. + */ + Id?: __string; + Tags?: Tags; + } + export interface RotateIngestEndpointCredentialsRequest { + /** + * The ID of the channel the IngestEndpoint is on. + */ + Id: __string; + /** + * The id of the IngestEndpoint whose credentials should be rotated + */ + IngestEndpointId: __string; + } + export interface RotateIngestEndpointCredentialsResponse { + /** + * The Amazon Resource Name (ARN) assigned to the Channel. + */ + Arn?: __string; + /** + * A short text description of the Channel. + */ + Description?: __string; + HlsIngest?: HlsIngest; + /** + * The ID of the Channel. + */ + Id?: __string; + Tags?: Tags; + } + export type SegmentTemplateFormat = "NUMBER_WITH_TIMELINE"|"TIME_WITH_TIMELINE"|string; + export interface SpekeKeyProvider { + /** + * An Amazon Resource Name (ARN) of a Certificate Manager certificate +that MediaPackage will use for enforcing secure end-to-end data +transfer with the key provider service. + + */ + CertificateArn?: __string; + /** + * The resource ID to include in key requests. + */ + ResourceId: __string; + /** + * An Amazon Resource Name (ARN) of an IAM role that AWS Elemental +MediaPackage will assume when accessing the key provider service. + + */ + RoleArn: __string; + /** + * The system IDs to include in key requests. + */ + SystemIds: __listOf__string; + /** + * The URL of the external key provider service. + */ + Url: __string; + } + export type StreamOrder = "ORIGINAL"|"VIDEO_BITRATE_ASCENDING"|"VIDEO_BITRATE_DESCENDING"|string; + export interface StreamSelection { + /** + * The maximum video bitrate (bps) to include in output. + */ + MaxVideoBitsPerSecond?: __integer; + /** + * The minimum video bitrate (bps) to include in output. + */ + MinVideoBitsPerSecond?: __integer; + /** + * A directive that determines the order of streams in the output. + */ + StreamOrder?: StreamOrder; + } + export interface TagResourceRequest { + ResourceArn: __string; + Tags: __mapOf__string; + } + export type Tags = {[key: string]: __string}; + export interface UntagResourceRequest { + ResourceArn: __string; + /** + * The key(s) of tag to be deleted + */ + TagKeys: __listOf__string; + } + export interface UpdateChannelRequest { + /** + * A short text description of the Channel. + */ + Description?: __string; + /** + * The ID of the Channel to update. + */ + Id: __string; + } + export interface UpdateChannelResponse { + /** + * The Amazon Resource Name (ARN) assigned to the Channel. + */ + Arn?: __string; + /** + * A short text description of the Channel. + */ + Description?: __string; + HlsIngest?: HlsIngest; + /** + * The ID of the Channel. + */ + Id?: __string; + Tags?: Tags; + } + export interface UpdateOriginEndpointRequest { + CmafPackage?: CmafPackageCreateOrUpdateParameters; + DashPackage?: DashPackage; + /** + * A short text description of the OriginEndpoint. + */ + Description?: __string; + HlsPackage?: HlsPackage; + /** + * The ID of the OriginEndpoint to update. + */ + Id: __string; + /** + * A short string that will be appended to the end of the Endpoint URL. + */ + ManifestName?: __string; + MssPackage?: MssPackage; + /** + * Maximum duration (in seconds) of content to retain for startover playback. +If not specified, startover playback will be disabled for the OriginEndpoint. + + */ + StartoverWindowSeconds?: __integer; + /** + * Amount of delay (in seconds) to enforce on the playback of live content. +If not specified, there will be no time delay in effect for the OriginEndpoint. + + */ + TimeDelaySeconds?: __integer; + /** + * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. + */ + Whitelist?: __listOf__string; + } + export interface UpdateOriginEndpointResponse { + /** + * The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + */ + Arn?: __string; + /** + * The ID of the Channel the OriginEndpoint is associated with. + */ + ChannelId?: __string; + CmafPackage?: CmafPackage; + DashPackage?: DashPackage; + /** + * A short text description of the OriginEndpoint. + */ + Description?: __string; + HlsPackage?: HlsPackage; + /** + * The ID of the OriginEndpoint. + */ + Id?: __string; + /** + * A short string appended to the end of the OriginEndpoint URL. + */ + ManifestName?: __string; + MssPackage?: MssPackage; + /** + * Maximum duration (seconds) of content to retain for startover playback. +If not specified, startover playback will be disabled for the OriginEndpoint. + + */ + StartoverWindowSeconds?: __integer; + Tags?: Tags; + /** + * Amount of delay (seconds) to enforce on the playback of live content. +If not specified, there will be no time delay in effect for the OriginEndpoint. + + */ + TimeDelaySeconds?: __integer; + /** + * The URL of the packaged OriginEndpoint for consumption. + */ + Url?: __string; + /** + * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. + */ + Whitelist?: __listOf__string; + } + export type __PeriodTriggersElement = "ADS"|string; + export type __boolean = boolean; + export type __integer = number; + export type __listOfChannel = Channel[]; + export type __listOfHlsManifest = HlsManifest[]; + export type __listOfHlsManifestCreateOrUpdateParameters = HlsManifestCreateOrUpdateParameters[]; + export type __listOfIngestEndpoint = IngestEndpoint[]; + export type __listOfOriginEndpoint = OriginEndpoint[]; + export type __listOf__PeriodTriggersElement = __PeriodTriggersElement[]; + export type __listOf__string = __string[]; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-10-12"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MediaPackage client. + */ + export import Types = MediaPackage; +} +export = MediaPackage; diff --git a/node_modules/aws-sdk/clients/mediapackage.js b/node_modules/aws-sdk/clients/mediapackage.js new file mode 100644 index 0000000..49109e6 --- /dev/null +++ b/node_modules/aws-sdk/clients/mediapackage.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mediapackage'] = {}; +AWS.MediaPackage = Service.defineService('mediapackage', ['2017-10-12']); +Object.defineProperty(apiLoader.services['mediapackage'], '2017-10-12', { + get: function get() { + var model = require('../apis/mediapackage-2017-10-12.min.json'); + model.paginators = require('../apis/mediapackage-2017-10-12.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MediaPackage; diff --git a/node_modules/aws-sdk/clients/mediastore.d.ts b/node_modules/aws-sdk/clients/mediastore.d.ts new file mode 100644 index 0000000..a2ddd13 --- /dev/null +++ b/node_modules/aws-sdk/clients/mediastore.d.ts @@ -0,0 +1,384 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MediaStore extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MediaStore.Types.ClientConfiguration) + config: Config & MediaStore.Types.ClientConfiguration; + /** + * Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service. + */ + createContainer(params: MediaStore.Types.CreateContainerInput, callback?: (err: AWSError, data: MediaStore.Types.CreateContainerOutput) => void): Request; + /** + * Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service. + */ + createContainer(callback?: (err: AWSError, data: MediaStore.Types.CreateContainerOutput) => void): Request; + /** + * Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers. + */ + deleteContainer(params: MediaStore.Types.DeleteContainerInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerOutput) => void): Request; + /** + * Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers. + */ + deleteContainer(callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerOutput) => void): Request; + /** + * Deletes the access policy that is associated with the specified container. + */ + deleteContainerPolicy(params: MediaStore.Types.DeleteContainerPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerPolicyOutput) => void): Request; + /** + * Deletes the access policy that is associated with the specified container. + */ + deleteContainerPolicy(callback?: (err: AWSError, data: MediaStore.Types.DeleteContainerPolicyOutput) => void): Request; + /** + * Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others. + */ + deleteCorsPolicy(params: MediaStore.Types.DeleteCorsPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteCorsPolicyOutput) => void): Request; + /** + * Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others. + */ + deleteCorsPolicy(callback?: (err: AWSError, data: MediaStore.Types.DeleteCorsPolicyOutput) => void): Request; + /** + * Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect. + */ + deleteLifecyclePolicy(params: MediaStore.Types.DeleteLifecyclePolicyInput, callback?: (err: AWSError, data: MediaStore.Types.DeleteLifecyclePolicyOutput) => void): Request; + /** + * Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect. + */ + deleteLifecyclePolicy(callback?: (err: AWSError, data: MediaStore.Types.DeleteLifecyclePolicyOutput) => void): Request; + /** + * Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers. + */ + describeContainer(params: MediaStore.Types.DescribeContainerInput, callback?: (err: AWSError, data: MediaStore.Types.DescribeContainerOutput) => void): Request; + /** + * Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers. + */ + describeContainer(callback?: (err: AWSError, data: MediaStore.Types.DescribeContainerOutput) => void): Request; + /** + * Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. + */ + getContainerPolicy(params: MediaStore.Types.GetContainerPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.GetContainerPolicyOutput) => void): Request; + /** + * Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. + */ + getContainerPolicy(callback?: (err: AWSError, data: MediaStore.Types.GetContainerPolicyOutput) => void): Request; + /** + * Returns the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others. + */ + getCorsPolicy(params: MediaStore.Types.GetCorsPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.GetCorsPolicyOutput) => void): Request; + /** + * Returns the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others. + */ + getCorsPolicy(callback?: (err: AWSError, data: MediaStore.Types.GetCorsPolicyOutput) => void): Request; + /** + * Retrieves the object lifecycle policy that is assigned to a container. + */ + getLifecyclePolicy(params: MediaStore.Types.GetLifecyclePolicyInput, callback?: (err: AWSError, data: MediaStore.Types.GetLifecyclePolicyOutput) => void): Request; + /** + * Retrieves the object lifecycle policy that is assigned to a container. + */ + getLifecyclePolicy(callback?: (err: AWSError, data: MediaStore.Types.GetLifecyclePolicyOutput) => void): Request; + /** + * Lists the properties of all containers in AWS Elemental MediaStore. You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive. See also DescribeContainer, which gets the properties of one container. + */ + listContainers(params: MediaStore.Types.ListContainersInput, callback?: (err: AWSError, data: MediaStore.Types.ListContainersOutput) => void): Request; + /** + * Lists the properties of all containers in AWS Elemental MediaStore. You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive. See also DescribeContainer, which gets the properties of one container. + */ + listContainers(callback?: (err: AWSError, data: MediaStore.Types.ListContainersOutput) => void): Request; + /** + * Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy. + */ + putContainerPolicy(params: MediaStore.Types.PutContainerPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.PutContainerPolicyOutput) => void): Request; + /** + * Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy. + */ + putContainerPolicy(callback?: (err: AWSError, data: MediaStore.Types.PutContainerPolicyOutput) => void): Request; + /** + * Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability. To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore. + */ + putCorsPolicy(params: MediaStore.Types.PutCorsPolicyInput, callback?: (err: AWSError, data: MediaStore.Types.PutCorsPolicyOutput) => void): Request; + /** + * Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability. To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore. + */ + putCorsPolicy(callback?: (err: AWSError, data: MediaStore.Types.PutCorsPolicyOutput) => void): Request; + /** + * Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect. For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy. + */ + putLifecyclePolicy(params: MediaStore.Types.PutLifecyclePolicyInput, callback?: (err: AWSError, data: MediaStore.Types.PutLifecyclePolicyOutput) => void): Request; + /** + * Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect. For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy. + */ + putLifecyclePolicy(callback?: (err: AWSError, data: MediaStore.Types.PutLifecyclePolicyOutput) => void): Request; + /** + * Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs. + */ + startAccessLogging(params: MediaStore.Types.StartAccessLoggingInput, callback?: (err: AWSError, data: MediaStore.Types.StartAccessLoggingOutput) => void): Request; + /** + * Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs. + */ + startAccessLogging(callback?: (err: AWSError, data: MediaStore.Types.StartAccessLoggingOutput) => void): Request; + /** + * Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable. + */ + stopAccessLogging(params: MediaStore.Types.StopAccessLoggingInput, callback?: (err: AWSError, data: MediaStore.Types.StopAccessLoggingOutput) => void): Request; + /** + * Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable. + */ + stopAccessLogging(callback?: (err: AWSError, data: MediaStore.Types.StopAccessLoggingOutput) => void): Request; +} +declare namespace MediaStore { + export type AllowedHeaders = Header[]; + export type AllowedMethods = MethodName[]; + export type AllowedOrigins = Origin[]; + export interface Container { + /** + * The DNS endpoint of the container. Use the endpoint to identify the specific container when sending requests to the data plane. The service assigns this value when the container is created. Once the value has been assigned, it does not change. + */ + Endpoint?: Endpoint; + /** + * Unix timestamp. + */ + CreationTime?: TimeStamp; + /** + * The Amazon Resource Name (ARN) of the container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container> For example: arn:aws:mediastore:us-west-2:111122223333:container/movies + */ + ARN?: ContainerARN; + /** + * The name of the container. + */ + Name?: ContainerName; + /** + * The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When the endpoint is available, the status changes to ACTIVE. + */ + Status?: ContainerStatus; + /** + * The state of access logging on the container. This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true, indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs. + */ + AccessLoggingEnabled?: ContainerAccessLoggingEnabled; + } + export type ContainerARN = string; + export type ContainerAccessLoggingEnabled = boolean; + export type ContainerList = Container[]; + export type ContainerListLimit = number; + export type ContainerName = string; + export type ContainerPolicy = string; + export type ContainerStatus = "ACTIVE"|"CREATING"|"DELETING"|string; + export type CorsPolicy = CorsRule[]; + export interface CorsRule { + /** + * One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object). Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins. + */ + AllowedOrigins: AllowedOrigins; + /** + * Identifies an HTTP method that the origin that is specified in the rule is allowed to execute. Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element. + */ + AllowedMethods?: AllowedMethods; + /** + * Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back. This element can contain only one wildcard character (*). + */ + AllowedHeaders: AllowedHeaders; + /** + * The time in seconds that your browser caches the preflight response for the specified resource. A CORS rule can have only one MaxAgeSeconds element. + */ + MaxAgeSeconds?: MaxAgeSeconds; + /** + * One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object). This element is optional for each rule. + */ + ExposeHeaders?: ExposeHeaders; + } + export interface CreateContainerInput { + /** + * The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name. + */ + ContainerName: ContainerName; + } + export interface CreateContainerOutput { + /** + * ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies ContainerName: The container name as specified in the request. CreationTime: Unix time stamp. Status: The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When an endpoint is available, the status changes to ACTIVE. The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers. + */ + Container: Container; + } + export interface DeleteContainerInput { + /** + * The name of the container to delete. + */ + ContainerName: ContainerName; + } + export interface DeleteContainerOutput { + } + export interface DeleteContainerPolicyInput { + /** + * The name of the container that holds the policy. + */ + ContainerName: ContainerName; + } + export interface DeleteContainerPolicyOutput { + } + export interface DeleteCorsPolicyInput { + /** + * The name of the container to remove the policy from. + */ + ContainerName: ContainerName; + } + export interface DeleteCorsPolicyOutput { + } + export interface DeleteLifecyclePolicyInput { + /** + * The name of the container that holds the object lifecycle policy. + */ + ContainerName: ContainerName; + } + export interface DeleteLifecyclePolicyOutput { + } + export interface DescribeContainerInput { + /** + * The name of the container to query. + */ + ContainerName?: ContainerName; + } + export interface DescribeContainerOutput { + /** + * The name of the queried container. + */ + Container?: Container; + } + export type Endpoint = string; + export type ExposeHeaders = Header[]; + export interface GetContainerPolicyInput { + /** + * The name of the container. + */ + ContainerName: ContainerName; + } + export interface GetContainerPolicyOutput { + /** + * The contents of the access policy. + */ + Policy: ContainerPolicy; + } + export interface GetCorsPolicyInput { + /** + * The name of the container that the policy is assigned to. + */ + ContainerName: ContainerName; + } + export interface GetCorsPolicyOutput { + /** + * The CORS policy assigned to the container. + */ + CorsPolicy: CorsPolicy; + } + export interface GetLifecyclePolicyInput { + /** + * The name of the container that the object lifecycle policy is assigned to. + */ + ContainerName: ContainerName; + } + export interface GetLifecyclePolicyOutput { + /** + * The object lifecycle policy that is assigned to the container. + */ + LifecyclePolicy: LifecyclePolicy; + } + export type Header = string; + export type LifecyclePolicy = string; + export interface ListContainersInput { + /** + * Only if you used MaxResults in the first command, enter the token (which was included in the previous response) to obtain the next set of containers. This token is included in a response only if there actually are more containers to list. + */ + NextToken?: PaginationToken; + /** + * Enter the maximum number of containers in the response. Use from 1 to 255 characters. + */ + MaxResults?: ContainerListLimit; + } + export interface ListContainersOutput { + /** + * The names of the containers. + */ + Containers: ContainerList; + /** + * NextToken is the token to use in the next call to ListContainers. This token is returned only if you included the MaxResults tag in the original command, and only if there are still containers to return. + */ + NextToken?: PaginationToken; + } + export type MaxAgeSeconds = number; + export type MethodName = "PUT"|"GET"|"DELETE"|"HEAD"|string; + export type Origin = string; + export type PaginationToken = string; + export interface PutContainerPolicyInput { + /** + * The name of the container. + */ + ContainerName: ContainerName; + /** + * The contents of the policy, which includes the following: One Version tag One Statement tag that contains the standard tags for the policy. + */ + Policy: ContainerPolicy; + } + export interface PutContainerPolicyOutput { + } + export interface PutCorsPolicyInput { + /** + * The name of the container that you want to assign the CORS policy to. + */ + ContainerName: ContainerName; + /** + * The CORS policy to apply to the container. + */ + CorsPolicy: CorsPolicy; + } + export interface PutCorsPolicyOutput { + } + export interface PutLifecyclePolicyInput { + /** + * The name of the container that you want to assign the object lifecycle policy to. + */ + ContainerName: ContainerName; + /** + * The object lifecycle policy to apply to the container. + */ + LifecyclePolicy: LifecyclePolicy; + } + export interface PutLifecyclePolicyOutput { + } + export interface StartAccessLoggingInput { + /** + * The name of the container that you want to start access logging on. + */ + ContainerName: ContainerName; + } + export interface StartAccessLoggingOutput { + } + export interface StopAccessLoggingInput { + /** + * The name of the container that you want to stop access logging on. + */ + ContainerName: ContainerName; + } + export interface StopAccessLoggingOutput { + } + export type TimeStamp = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MediaStore client. + */ + export import Types = MediaStore; +} +export = MediaStore; diff --git a/node_modules/aws-sdk/clients/mediastore.js b/node_modules/aws-sdk/clients/mediastore.js new file mode 100644 index 0000000..ef4d0ee --- /dev/null +++ b/node_modules/aws-sdk/clients/mediastore.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mediastore'] = {}; +AWS.MediaStore = Service.defineService('mediastore', ['2017-09-01']); +Object.defineProperty(apiLoader.services['mediastore'], '2017-09-01', { + get: function get() { + var model = require('../apis/mediastore-2017-09-01.min.json'); + model.paginators = require('../apis/mediastore-2017-09-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MediaStore; diff --git a/node_modules/aws-sdk/clients/mediastoredata.d.ts b/node_modules/aws-sdk/clients/mediastoredata.d.ts new file mode 100644 index 0000000..d978bc9 --- /dev/null +++ b/node_modules/aws-sdk/clients/mediastoredata.d.ts @@ -0,0 +1,257 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Readable} from 'stream'; +interface Blob {} +declare class MediaStoreData extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MediaStoreData.Types.ClientConfiguration) + config: Config & MediaStoreData.Types.ClientConfiguration; + /** + * Deletes an object at the specified path. + */ + deleteObject(params: MediaStoreData.Types.DeleteObjectRequest, callback?: (err: AWSError, data: MediaStoreData.Types.DeleteObjectResponse) => void): Request; + /** + * Deletes an object at the specified path. + */ + deleteObject(callback?: (err: AWSError, data: MediaStoreData.Types.DeleteObjectResponse) => void): Request; + /** + * Gets the headers for an object at the specified path. + */ + describeObject(params: MediaStoreData.Types.DescribeObjectRequest, callback?: (err: AWSError, data: MediaStoreData.Types.DescribeObjectResponse) => void): Request; + /** + * Gets the headers for an object at the specified path. + */ + describeObject(callback?: (err: AWSError, data: MediaStoreData.Types.DescribeObjectResponse) => void): Request; + /** + * Downloads the object at the specified path. + */ + getObject(params: MediaStoreData.Types.GetObjectRequest, callback?: (err: AWSError, data: MediaStoreData.Types.GetObjectResponse) => void): Request; + /** + * Downloads the object at the specified path. + */ + getObject(callback?: (err: AWSError, data: MediaStoreData.Types.GetObjectResponse) => void): Request; + /** + * Provides a list of metadata entries about folders and objects in the specified folder. + */ + listItems(params: MediaStoreData.Types.ListItemsRequest, callback?: (err: AWSError, data: MediaStoreData.Types.ListItemsResponse) => void): Request; + /** + * Provides a list of metadata entries about folders and objects in the specified folder. + */ + listItems(callback?: (err: AWSError, data: MediaStoreData.Types.ListItemsResponse) => void): Request; + /** + * Uploads an object to the specified path. Object sizes are limited to 25 MB. + */ + putObject(params: MediaStoreData.Types.PutObjectRequest, callback?: (err: AWSError, data: MediaStoreData.Types.PutObjectResponse) => void): Request; + /** + * Uploads an object to the specified path. Object sizes are limited to 25 MB. + */ + putObject(callback?: (err: AWSError, data: MediaStoreData.Types.PutObjectResponse) => void): Request; +} +declare namespace MediaStoreData { + export type ContentRangePattern = string; + export type ContentType = string; + export interface DeleteObjectRequest { + /** + * The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name> + */ + Path: PathNaming; + } + export interface DeleteObjectResponse { + } + export interface DescribeObjectRequest { + /** + * The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name> + */ + Path: PathNaming; + } + export interface DescribeObjectResponse { + /** + * The ETag that represents a unique instance of the object. + */ + ETag?: ETag; + /** + * The content type of the object. + */ + ContentType?: ContentType; + /** + * The length of the object in bytes. + */ + ContentLength?: NonNegativeLong; + /** + * An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9. Headers with a custom user-defined value are also accepted. + */ + CacheControl?: StringPrimitive; + /** + * The date and time that the object was last modified. + */ + LastModified?: TimeStamp; + } + export type ETag = string; + export interface GetObjectRequest { + /** + * The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name> For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi. Do not include the container name in this path. If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder. There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore. For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide. The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension. + */ + Path: PathNaming; + /** + * The range bytes of an object to retrieve. For more information about the Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. + */ + Range?: RangePattern; + } + export interface GetObjectResponse { + /** + * The bytes of the object. + */ + Body?: PayloadBlob; + /** + * An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9. Headers with a custom user-defined value are also accepted. + */ + CacheControl?: StringPrimitive; + /** + * The range of bytes to retrieve. + */ + ContentRange?: ContentRangePattern; + /** + * The length of the object in bytes. + */ + ContentLength?: NonNegativeLong; + /** + * The content type of the object. + */ + ContentType?: ContentType; + /** + * The ETag that represents a unique instance of the object. + */ + ETag?: ETag; + /** + * The date and time that the object was last modified. + */ + LastModified?: TimeStamp; + /** + * The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status codes indicate the type of error that occurred. + */ + StatusCode: statusCode; + } + export interface Item { + /** + * The name of the item. + */ + Name?: ItemName; + /** + * The item type (folder or object). + */ + Type?: ItemType; + /** + * The ETag that represents a unique instance of the item. + */ + ETag?: ETag; + /** + * The date and time that the item was last modified. + */ + LastModified?: TimeStamp; + /** + * The content type of the item. + */ + ContentType?: ContentType; + /** + * The length of the item in bytes. + */ + ContentLength?: NonNegativeLong; + } + export type ItemList = Item[]; + export type ItemName = string; + export type ItemType = "OBJECT"|"FOLDER"|string; + export interface ListItemsRequest { + /** + * The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name> + */ + Path?: ListPathNaming; + /** + * The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page. + */ + MaxResults?: ListLimit; + /** + * The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value. Tokens expire after 15 minutes. + */ + NextToken?: PaginationToken; + } + export interface ListItemsResponse { + /** + * The metadata entries for the folders and objects at the requested path. + */ + Items?: ItemList; + /** + * The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results. + */ + NextToken?: PaginationToken; + } + export type ListLimit = number; + export type ListPathNaming = string; + export type NonNegativeLong = number; + export type PaginationToken = string; + export type PathNaming = string; + export type PayloadBlob = Buffer|Uint8Array|Blob|string|Readable; + export interface PutObjectRequest { + /** + * The bytes to be stored. + */ + Body: PayloadBlob; + /** + * The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name> For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi. Do not include the container name in this path. If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder. There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore. For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide. The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension. + */ + Path: PathNaming; + /** + * The content type of the object. + */ + ContentType?: ContentType; + /** + * An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9. Headers with a custom user-defined value are also accepted. + */ + CacheControl?: StringPrimitive; + /** + * Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received. + */ + StorageClass?: StorageClass; + } + export interface PutObjectResponse { + /** + * The SHA256 digest of the object that is persisted. + */ + ContentSHA256?: SHA256Hash; + /** + * Unique identifier of the object in the container. + */ + ETag?: ETag; + /** + * The storage class where the object was persisted. The class should be “Temporal”. + */ + StorageClass?: StorageClass; + } + export type RangePattern = string; + export type SHA256Hash = string; + export type StorageClass = "TEMPORAL"|string; + export type StringPrimitive = string; + export type TimeStamp = Date; + export type statusCode = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MediaStoreData client. + */ + export import Types = MediaStoreData; +} +export = MediaStoreData; diff --git a/node_modules/aws-sdk/clients/mediastoredata.js b/node_modules/aws-sdk/clients/mediastoredata.js new file mode 100644 index 0000000..029fb4c --- /dev/null +++ b/node_modules/aws-sdk/clients/mediastoredata.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mediastoredata'] = {}; +AWS.MediaStoreData = Service.defineService('mediastoredata', ['2017-09-01']); +Object.defineProperty(apiLoader.services['mediastoredata'], '2017-09-01', { + get: function get() { + var model = require('../apis/mediastore-data-2017-09-01.min.json'); + model.paginators = require('../apis/mediastore-data-2017-09-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MediaStoreData; diff --git a/node_modules/aws-sdk/clients/mediatailor.d.ts b/node_modules/aws-sdk/clients/mediatailor.d.ts new file mode 100644 index 0000000..502031d --- /dev/null +++ b/node_modules/aws-sdk/clients/mediatailor.d.ts @@ -0,0 +1,394 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MediaTailor extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MediaTailor.Types.ClientConfiguration) + config: Config & MediaTailor.Types.ClientConfiguration; + /** + * Deletes the playback configuration for the specified name. + */ + deletePlaybackConfiguration(params: MediaTailor.Types.DeletePlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeletePlaybackConfigurationResponse) => void): Request; + /** + * Deletes the playback configuration for the specified name. + */ + deletePlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.DeletePlaybackConfigurationResponse) => void): Request; + /** + * Returns the playback configuration for the specified name. + */ + getPlaybackConfiguration(params: MediaTailor.Types.GetPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request; + /** + * Returns the playback configuration for the specified name. + */ + getPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request; + /** + * Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful. + */ + listPlaybackConfigurations(params: MediaTailor.Types.ListPlaybackConfigurationsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request; + /** + * Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful. + */ + listPlaybackConfigurations(callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request; + /** + * Returns a list of the tags assigned to the specified playback configuration resource. + */ + listTagsForResource(params: MediaTailor.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns a list of the tags assigned to the specified playback configuration resource. + */ + listTagsForResource(callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request; + /** + * Adds a new playback configuration to AWS Elemental MediaTailor. + */ + putPlaybackConfiguration(params: MediaTailor.Types.PutPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request; + /** + * Adds a new playback configuration to AWS Elemental MediaTailor. + */ + putPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request; + /** + * Adds tags to the specified playback configuration resource. You can specify one or more tags to add. + */ + tagResource(params: MediaTailor.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds tags to the specified playback configuration resource. You can specify one or more tags to add. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags from the specified playback configuration resource. You can specify one or more tags to remove. + */ + untagResource(params: MediaTailor.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags from the specified playback configuration resource. You can specify one or more tags to remove. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace MediaTailor { + export interface CdnConfiguration { + /** + * A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the following origin: ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments. + */ + AdSegmentUrlPrefix?: __string; + /** + * A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments. + */ + ContentSegmentUrlPrefix?: __string; + } + export interface DashConfiguration { + /** + * The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations. + */ + ManifestEndpointPrefix?: __string; + /** + * The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value. + */ + MpdLocation?: __string; + /** + * The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD. + */ + OriginManifestType?: OriginManifestType; + } + export interface DashConfigurationForPut { + /** + * The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value. + */ + MpdLocation?: __string; + /** + * The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD. + */ + OriginManifestType?: OriginManifestType; + } + export interface DeletePlaybackConfigurationRequest { + /** + * The identifier for the playback configuration. + */ + Name: __string; + } + export interface DeletePlaybackConfigurationResponse { + } + export interface GetPlaybackConfigurationRequest { + /** + * The identifier for the playback configuration. + */ + Name: __string; + } + export interface GetPlaybackConfigurationResponse { + /** + * The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters. + */ + AdDecisionServerUrl?: __string; + /** + * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. + */ + CdnConfiguration?: CdnConfiguration; + /** + * The configuration for DASH content. + */ + DashConfiguration?: DashConfiguration; + /** + * The configuration for HLS content. + */ + HlsConfiguration?: HlsConfiguration; + /** + * The identifier for the playback configuration. + */ + Name?: __string; + /** + * The Amazon Resource Name (ARN) for the playback configuration. + */ + PlaybackConfigurationArn?: __string; + /** + * The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. + */ + PlaybackEndpointPrefix?: __string; + /** + * The URL that the player uses to initialize a session that uses client-side reporting. + */ + SessionInitializationEndpointPrefix?: __string; + /** + * The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. + */ + SlateAdUrl?: __string; + /** + * The tags assigned to the playback configuration. + */ + Tags?: __mapOf__string; + /** + * The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support. + */ + TranscodeProfileName?: __string; + /** + * The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters. + */ + VideoContentSourceUrl?: __string; + } + export interface HlsConfiguration { + /** + * The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting. + */ + ManifestEndpointPrefix?: __string; + } + export interface ListPlaybackConfigurationsRequest { + /** + * Maximum number of records to return. + */ + MaxResults?: __integerMin1Max100; + /** + * Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results. + */ + NextToken?: __string; + } + export interface ListPlaybackConfigurationsResponse { + /** + * Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored. + */ + Items?: __listOfPlaybackConfigurations; + /** + * Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results. + */ + NextToken?: __string; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request. + */ + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + /** + * A comma-separated list of tag key:value pairs. For example: + { + "Key1": "Value1", + "Key2": "Value2" + } + + */ + Tags?: __mapOf__string; + } + export type OriginManifestType = "SINGLE_PERIOD"|"MULTI_PERIOD"|string; + export interface PlaybackConfiguration { + /** + * The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters. + */ + AdDecisionServerUrl?: __string; + /** + * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. + */ + CdnConfiguration?: CdnConfiguration; + /** + * The configuration for DASH content. + */ + DashConfiguration?: DashConfiguration; + /** + * The configuration for HLS content. + */ + HlsConfiguration?: HlsConfiguration; + /** + * The identifier for the playback configuration. + */ + Name?: __string; + /** + * The Amazon Resource Name (ARN) for the playback configuration. + */ + PlaybackConfigurationArn?: __string; + /** + * The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. + */ + PlaybackEndpointPrefix?: __string; + /** + * The URL that the player uses to initialize a session that uses client-side reporting. + */ + SessionInitializationEndpointPrefix?: __string; + /** + * The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. + */ + SlateAdUrl?: __string; + /** + * The tags assigned to the playback configuration. + */ + Tags?: __mapOf__string; + /** + * The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support. + */ + TranscodeProfileName?: __string; + /** + * The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters. + */ + VideoContentSourceUrl?: __string; + } + export interface PutPlaybackConfigurationRequest { + /** + * The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters. + */ + AdDecisionServerUrl?: __string; + /** + * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. + */ + CdnConfiguration?: CdnConfiguration; + /** + * The configuration for DASH content. + */ + DashConfiguration?: DashConfigurationForPut; + /** + * The identifier for the playback configuration. + */ + Name?: __string; + /** + * The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. + */ + SlateAdUrl?: __string; + /** + * The tags to assign to the playback configuration. + */ + Tags?: __mapOf__string; + /** + * The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support. + */ + TranscodeProfileName?: __string; + /** + * The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters. + */ + VideoContentSourceUrl?: __string; + } + export interface PutPlaybackConfigurationResponse { + /** + * The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters. + */ + AdDecisionServerUrl?: __string; + /** + * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. + */ + CdnConfiguration?: CdnConfiguration; + /** + * The configuration for DASH content. + */ + DashConfiguration?: DashConfiguration; + /** + * The configuration for HLS content. + */ + HlsConfiguration?: HlsConfiguration; + /** + * The identifier for the playback configuration. + */ + Name?: __string; + /** + * The Amazon Resource Name (ARN) for the playback configuration. + */ + PlaybackConfigurationArn?: __string; + /** + * The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. + */ + PlaybackEndpointPrefix?: __string; + /** + * The URL that the player uses to initialize a session that uses client-side reporting. + */ + SessionInitializationEndpointPrefix?: __string; + /** + * The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. + */ + SlateAdUrl?: __string; + /** + * The tags assigned to the playback configuration. + */ + Tags?: __mapOf__string; + /** + * The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support. + */ + TranscodeProfileName?: __string; + /** + * The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters. + */ + VideoContentSourceUrl?: __string; + } + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request. + */ + ResourceArn: __string; + /** + * A comma-separated list of tag key:value pairs. For example: + { + "Key1": "Value1", + "Key2": "Value2" + } + + */ + Tags: __mapOf__string; + } + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request. + */ + ResourceArn: __string; + /** + * A comma-separated list of the tag keys to remove from the playback configuration. + */ + TagKeys: __listOf__string; + } + export type __integerMin1Max100 = number; + export type __listOfPlaybackConfigurations = PlaybackConfiguration[]; + export type __listOf__string = __string[]; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-04-23"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MediaTailor client. + */ + export import Types = MediaTailor; +} +export = MediaTailor; diff --git a/node_modules/aws-sdk/clients/mediatailor.js b/node_modules/aws-sdk/clients/mediatailor.js new file mode 100644 index 0000000..bbc0eb0 --- /dev/null +++ b/node_modules/aws-sdk/clients/mediatailor.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mediatailor'] = {}; +AWS.MediaTailor = Service.defineService('mediatailor', ['2018-04-23']); +Object.defineProperty(apiLoader.services['mediatailor'], '2018-04-23', { + get: function get() { + var model = require('../apis/mediatailor-2018-04-23.min.json'); + model.paginators = require('../apis/mediatailor-2018-04-23.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MediaTailor; diff --git a/node_modules/aws-sdk/clients/migrationhub.d.ts b/node_modules/aws-sdk/clients/migrationhub.d.ts new file mode 100644 index 0000000..e6e5011 --- /dev/null +++ b/node_modules/aws-sdk/clients/migrationhub.d.ts @@ -0,0 +1,601 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MigrationHub extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MigrationHub.Types.ClientConfiguration) + config: Config & MigrationHub.Types.ClientConfiguration; + /** + * Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits: Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task. The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc. + */ + associateCreatedArtifact(params: MigrationHub.Types.AssociateCreatedArtifactRequest, callback?: (err: AWSError, data: MigrationHub.Types.AssociateCreatedArtifactResult) => void): Request; + /** + * Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits: Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task. The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc. + */ + associateCreatedArtifact(callback?: (err: AWSError, data: MigrationHub.Types.AssociateCreatedArtifactResult) => void): Request; + /** + * Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task. + */ + associateDiscoveredResource(params: MigrationHub.Types.AssociateDiscoveredResourceRequest, callback?: (err: AWSError, data: MigrationHub.Types.AssociateDiscoveredResourceResult) => void): Request; + /** + * Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task. + */ + associateDiscoveredResource(callback?: (err: AWSError, data: MigrationHub.Types.AssociateDiscoveredResourceResult) => void): Request; + /** + * Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account. + */ + createProgressUpdateStream(params: MigrationHub.Types.CreateProgressUpdateStreamRequest, callback?: (err: AWSError, data: MigrationHub.Types.CreateProgressUpdateStreamResult) => void): Request; + /** + * Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account. + */ + createProgressUpdateStream(callback?: (err: AWSError, data: MigrationHub.Types.CreateProgressUpdateStreamResult) => void): Request; + /** + * Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits: The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call). The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts). If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call. CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs realted to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted. Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream). + */ + deleteProgressUpdateStream(params: MigrationHub.Types.DeleteProgressUpdateStreamRequest, callback?: (err: AWSError, data: MigrationHub.Types.DeleteProgressUpdateStreamResult) => void): Request; + /** + * Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits: The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call). The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts). If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call. CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs realted to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted. Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream). + */ + deleteProgressUpdateStream(callback?: (err: AWSError, data: MigrationHub.Types.DeleteProgressUpdateStreamResult) => void): Request; + /** + * Gets the migration status of an application. + */ + describeApplicationState(params: MigrationHub.Types.DescribeApplicationStateRequest, callback?: (err: AWSError, data: MigrationHub.Types.DescribeApplicationStateResult) => void): Request; + /** + * Gets the migration status of an application. + */ + describeApplicationState(callback?: (err: AWSError, data: MigrationHub.Types.DescribeApplicationStateResult) => void): Request; + /** + * Retrieves a list of all attributes associated with a specific migration task. + */ + describeMigrationTask(params: MigrationHub.Types.DescribeMigrationTaskRequest, callback?: (err: AWSError, data: MigrationHub.Types.DescribeMigrationTaskResult) => void): Request; + /** + * Retrieves a list of all attributes associated with a specific migration task. + */ + describeMigrationTask(callback?: (err: AWSError, data: MigrationHub.Types.DescribeMigrationTaskResult) => void): Request; + /** + * Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits: A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task. The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc. + */ + disassociateCreatedArtifact(params: MigrationHub.Types.DisassociateCreatedArtifactRequest, callback?: (err: AWSError, data: MigrationHub.Types.DisassociateCreatedArtifactResult) => void): Request; + /** + * Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits: A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task. The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc. + */ + disassociateCreatedArtifact(callback?: (err: AWSError, data: MigrationHub.Types.DisassociateCreatedArtifactResult) => void): Request; + /** + * Disassociate an Application Discovery Service (ADS) discovered resource from a migration task. + */ + disassociateDiscoveredResource(params: MigrationHub.Types.DisassociateDiscoveredResourceRequest, callback?: (err: AWSError, data: MigrationHub.Types.DisassociateDiscoveredResourceResult) => void): Request; + /** + * Disassociate an Application Discovery Service (ADS) discovered resource from a migration task. + */ + disassociateDiscoveredResource(callback?: (err: AWSError, data: MigrationHub.Types.DisassociateDiscoveredResourceResult) => void): Request; + /** + * Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool. This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub. + */ + importMigrationTask(params: MigrationHub.Types.ImportMigrationTaskRequest, callback?: (err: AWSError, data: MigrationHub.Types.ImportMigrationTaskResult) => void): Request; + /** + * Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool. This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub. + */ + importMigrationTask(callback?: (err: AWSError, data: MigrationHub.Types.ImportMigrationTaskResult) => void): Request; + /** + * Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits: Gets the list of the created artifacts while migration is taking place. Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API. Lists created artifacts in a paginated interface. + */ + listCreatedArtifacts(params: MigrationHub.Types.ListCreatedArtifactsRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListCreatedArtifactsResult) => void): Request; + /** + * Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits: Gets the list of the created artifacts while migration is taking place. Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API. Lists created artifacts in a paginated interface. + */ + listCreatedArtifacts(callback?: (err: AWSError, data: MigrationHub.Types.ListCreatedArtifactsResult) => void): Request; + /** + * Lists discovered resources associated with the given MigrationTask. + */ + listDiscoveredResources(params: MigrationHub.Types.ListDiscoveredResourcesRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListDiscoveredResourcesResult) => void): Request; + /** + * Lists discovered resources associated with the given MigrationTask. + */ + listDiscoveredResources(callback?: (err: AWSError, data: MigrationHub.Types.ListDiscoveredResourcesResult) => void): Request; + /** + * Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits: Can show a summary list of the most recent migration tasks. Can show a summary list of migration tasks associated with a given discovered resource. Lists migration tasks in a paginated interface. + */ + listMigrationTasks(params: MigrationHub.Types.ListMigrationTasksRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListMigrationTasksResult) => void): Request; + /** + * Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits: Can show a summary list of the most recent migration tasks. Can show a summary list of migration tasks associated with a given discovered resource. Lists migration tasks in a paginated interface. + */ + listMigrationTasks(callback?: (err: AWSError, data: MigrationHub.Types.ListMigrationTasksResult) => void): Request; + /** + * Lists progress update streams associated with the user account making this call. + */ + listProgressUpdateStreams(params: MigrationHub.Types.ListProgressUpdateStreamsRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListProgressUpdateStreamsResult) => void): Request; + /** + * Lists progress update streams associated with the user account making this call. + */ + listProgressUpdateStreams(callback?: (err: AWSError, data: MigrationHub.Types.ListProgressUpdateStreamsResult) => void): Request; + /** + * Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED. + */ + notifyApplicationState(params: MigrationHub.Types.NotifyApplicationStateRequest, callback?: (err: AWSError, data: MigrationHub.Types.NotifyApplicationStateResult) => void): Request; + /** + * Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED. + */ + notifyApplicationState(callback?: (err: AWSError, data: MigrationHub.Types.NotifyApplicationStateResult) => void): Request; + /** + * Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits: Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status. MigrationTaskName is used for addressing updates to the correct target. ProgressUpdateStream is used for access control and to provide a namespace for each migration tool. + */ + notifyMigrationTaskState(params: MigrationHub.Types.NotifyMigrationTaskStateRequest, callback?: (err: AWSError, data: MigrationHub.Types.NotifyMigrationTaskStateResult) => void): Request; + /** + * Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits: Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status. MigrationTaskName is used for addressing updates to the correct target. ProgressUpdateStream is used for access control and to provide a namespace for each migration tool. + */ + notifyMigrationTaskState(callback?: (err: AWSError, data: MigrationHub.Types.NotifyMigrationTaskStateResult) => void): Request; + /** + * Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after PutResourceAttributes returns. Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overiding the MAC address. Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value. Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources. + */ + putResourceAttributes(params: MigrationHub.Types.PutResourceAttributesRequest, callback?: (err: AWSError, data: MigrationHub.Types.PutResourceAttributesResult) => void): Request; + /** + * Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after PutResourceAttributes returns. Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overiding the MAC address. Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value. Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources. + */ + putResourceAttributes(callback?: (err: AWSError, data: MigrationHub.Types.PutResourceAttributesResult) => void): Request; +} +declare namespace MigrationHub { + export type ApplicationId = string; + export type ApplicationStatus = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETED"|string; + export interface AssociateCreatedArtifactRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * Unique identifier that references the migration task. + */ + MigrationTaskName: MigrationTaskName; + /** + * An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) + */ + CreatedArtifact: CreatedArtifact; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface AssociateCreatedArtifactResult { + } + export interface AssociateDiscoveredResourceRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * The identifier given to the MigrationTask. + */ + MigrationTaskName: MigrationTaskName; + /** + * Object representing a Resource. + */ + DiscoveredResource: DiscoveredResource; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface AssociateDiscoveredResourceResult { + } + export type ConfigurationId = string; + export interface CreateProgressUpdateStreamRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStreamName: ProgressUpdateStream; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface CreateProgressUpdateStreamResult { + } + export interface CreatedArtifact { + /** + * An ARN that uniquely identifies the result of a migration task. + */ + Name: CreatedArtifactName; + /** + * A description that can be free-form text to record additional detail about the artifact for clarity or for later reference. + */ + Description?: CreatedArtifactDescription; + } + export type CreatedArtifactDescription = string; + export type CreatedArtifactList = CreatedArtifact[]; + export type CreatedArtifactName = string; + export interface DeleteProgressUpdateStreamRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStreamName: ProgressUpdateStream; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface DeleteProgressUpdateStreamResult { + } + export interface DescribeApplicationStateRequest { + /** + * The configurationId in ADS that uniquely identifies the grouped application. + */ + ApplicationId: ApplicationId; + } + export interface DescribeApplicationStateResult { + /** + * Status of the application - Not Started, In-Progress, Complete. + */ + ApplicationStatus?: ApplicationStatus; + /** + * The timestamp when the application status was last updated. + */ + LastUpdatedTime?: UpdateDateTime; + } + export interface DescribeMigrationTaskRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * The identifier given to the MigrationTask. + */ + MigrationTaskName: MigrationTaskName; + } + export interface DescribeMigrationTaskResult { + /** + * Object encapsulating information about the migration task. + */ + MigrationTask?: MigrationTask; + } + export interface DisassociateCreatedArtifactRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * Unique identifier that references the migration task to be disassociated with the artifact. + */ + MigrationTaskName: MigrationTaskName; + /** + * An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) + */ + CreatedArtifactName: CreatedArtifactName; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface DisassociateCreatedArtifactResult { + } + export interface DisassociateDiscoveredResourceRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * The identifier given to the MigrationTask. + */ + MigrationTaskName: MigrationTaskName; + /** + * ConfigurationId of the ADS resource to be disassociated. + */ + ConfigurationId: ConfigurationId; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface DisassociateDiscoveredResourceResult { + } + export interface DiscoveredResource { + /** + * The configurationId in ADS that uniquely identifies the on-premise resource. + */ + ConfigurationId: ConfigurationId; + /** + * A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference. + */ + Description?: DiscoveredResourceDescription; + } + export type DiscoveredResourceDescription = string; + export type DiscoveredResourceList = DiscoveredResource[]; + export type DryRun = boolean; + export interface ImportMigrationTaskRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * Unique identifier that references the migration task. + */ + MigrationTaskName: MigrationTaskName; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface ImportMigrationTaskResult { + } + export type LatestResourceAttributeList = ResourceAttribute[]; + export interface ListCreatedArtifactsRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * Unique identifier that references the migration task. + */ + MigrationTaskName: MigrationTaskName; + /** + * If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. + */ + NextToken?: Token; + /** + * Maximum number of results to be returned per page. + */ + MaxResults?: MaxResultsCreatedArtifacts; + } + export interface ListCreatedArtifactsResult { + /** + * If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from. + */ + NextToken?: Token; + /** + * List of created artifacts up to the maximum number of results specified in the request. + */ + CreatedArtifactList?: CreatedArtifactList; + } + export interface ListDiscoveredResourcesRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * The name of the MigrationTask. + */ + MigrationTaskName: MigrationTaskName; + /** + * If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. + */ + NextToken?: Token; + /** + * The maximum number of results returned per page. + */ + MaxResults?: MaxResultsResources; + } + export interface ListDiscoveredResourcesResult { + /** + * If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from. + */ + NextToken?: Token; + /** + * Returned list of discovered resources associated with the given MigrationTask. + */ + DiscoveredResourceList?: DiscoveredResourceList; + } + export interface ListMigrationTasksRequest { + /** + * If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. + */ + NextToken?: Token; + /** + * Value to specify how many results are returned per page. + */ + MaxResults?: MaxResults; + /** + * Filter migration tasks by discovered resource name. + */ + ResourceName?: ResourceName; + } + export interface ListMigrationTasksResult { + /** + * If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from. + */ + NextToken?: Token; + /** + * Lists the migration task's summary which includes: MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each task. + */ + MigrationTaskSummaryList?: MigrationTaskSummaryList; + } + export interface ListProgressUpdateStreamsRequest { + /** + * If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken. + */ + NextToken?: Token; + /** + * Filter to limit the maximum number of results to list per page. + */ + MaxResults?: MaxResults; + } + export interface ListProgressUpdateStreamsResult { + /** + * List of progress update streams up to the max number of results passed in the input. + */ + ProgressUpdateStreamSummaryList?: ProgressUpdateStreamSummaryList; + /** + * If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from. + */ + NextToken?: Token; + } + export type MaxResults = number; + export type MaxResultsCreatedArtifacts = number; + export type MaxResultsResources = number; + export interface MigrationTask { + /** + * A name that identifies the vendor of the migration tool being used. + */ + ProgressUpdateStream?: ProgressUpdateStream; + /** + * Unique identifier that references the migration task. + */ + MigrationTaskName?: MigrationTaskName; + /** + * Task object encapsulating task information. + */ + Task?: Task; + /** + * The timestamp when the task was gathered. + */ + UpdateDateTime?: UpdateDateTime; + /** + * + */ + ResourceAttributeList?: LatestResourceAttributeList; + } + export type MigrationTaskName = string; + export interface MigrationTaskSummary { + /** + * An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool. + */ + ProgressUpdateStream?: ProgressUpdateStream; + /** + * Unique identifier that references the migration task. + */ + MigrationTaskName?: MigrationTaskName; + /** + * Status of the task. + */ + Status?: Status; + /** + * + */ + ProgressPercent?: ProgressPercent; + /** + * Detail information of what is being done within the overall status state. + */ + StatusDetail?: StatusDetail; + /** + * The timestamp when the task was gathered. + */ + UpdateDateTime?: UpdateDateTime; + } + export type MigrationTaskSummaryList = MigrationTaskSummary[]; + export type NextUpdateSeconds = number; + export interface NotifyApplicationStateRequest { + /** + * The configurationId in ADS that uniquely identifies the grouped application. + */ + ApplicationId: ApplicationId; + /** + * Status of the application - Not Started, In-Progress, Complete. + */ + Status: ApplicationStatus; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface NotifyApplicationStateResult { + } + export interface NotifyMigrationTaskStateRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * Unique identifier that references the migration task. + */ + MigrationTaskName: MigrationTaskName; + /** + * Information about the task's progress and status. + */ + Task: Task; + /** + * The timestamp when the task was gathered. + */ + UpdateDateTime: UpdateDateTime; + /** + * Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale. + */ + NextUpdateSeconds: NextUpdateSeconds; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface NotifyMigrationTaskStateResult { + } + export type ProgressPercent = number; + export type ProgressUpdateStream = string; + export interface ProgressUpdateStreamSummary { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStreamName?: ProgressUpdateStream; + } + export type ProgressUpdateStreamSummaryList = ProgressUpdateStreamSummary[]; + export interface PutResourceAttributesRequest { + /** + * The name of the ProgressUpdateStream. + */ + ProgressUpdateStream: ProgressUpdateStream; + /** + * Unique identifier that references the migration task. + */ + MigrationTaskName: MigrationTaskName; + /** + * Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository. Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters. If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service (ADS)'s repository. See the Example section below for a use case of specifying "VM" related values. If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching. + */ + ResourceAttributeList: ResourceAttributeList; + /** + * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. + */ + DryRun?: DryRun; + } + export interface PutResourceAttributesResult { + } + export interface ResourceAttribute { + /** + * Type of resource. + */ + Type: ResourceAttributeType; + /** + * Value of the resource type. + */ + Value: ResourceAttributeValue; + } + export type ResourceAttributeList = ResourceAttribute[]; + export type ResourceAttributeType = "IPV4_ADDRESS"|"IPV6_ADDRESS"|"MAC_ADDRESS"|"FQDN"|"VM_MANAGER_ID"|"VM_MANAGED_OBJECT_REFERENCE"|"VM_NAME"|"VM_PATH"|"BIOS_ID"|"MOTHERBOARD_SERIAL_NUMBER"|string; + export type ResourceAttributeValue = string; + export type ResourceName = string; + export type Status = "NOT_STARTED"|"IN_PROGRESS"|"FAILED"|"COMPLETED"|string; + export type StatusDetail = string; + export interface Task { + /** + * Status of the task - Not Started, In-Progress, Complete. + */ + Status: Status; + /** + * Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state. + */ + StatusDetail?: StatusDetail; + /** + * Indication of the percentage completion of the task. + */ + ProgressPercent?: ProgressPercent; + } + export type Token = string; + export type UpdateDateTime = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-05-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MigrationHub client. + */ + export import Types = MigrationHub; +} +export = MigrationHub; diff --git a/node_modules/aws-sdk/clients/migrationhub.js b/node_modules/aws-sdk/clients/migrationhub.js new file mode 100644 index 0000000..0b9227a --- /dev/null +++ b/node_modules/aws-sdk/clients/migrationhub.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['migrationhub'] = {}; +AWS.MigrationHub = Service.defineService('migrationhub', ['2017-05-31']); +Object.defineProperty(apiLoader.services['migrationhub'], '2017-05-31', { + get: function get() { + var model = require('../apis/AWSMigrationHub-2017-05-31.min.json'); + model.paginators = require('../apis/AWSMigrationHub-2017-05-31.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MigrationHub; diff --git a/node_modules/aws-sdk/clients/mobile.d.ts b/node_modules/aws-sdk/clients/mobile.d.ts new file mode 100644 index 0000000..3292537 --- /dev/null +++ b/node_modules/aws-sdk/clients/mobile.d.ts @@ -0,0 +1,333 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Mobile extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Mobile.Types.ClientConfiguration) + config: Config & Mobile.Types.ClientConfiguration; + /** + * Creates an AWS Mobile Hub project. + */ + createProject(params: Mobile.Types.CreateProjectRequest, callback?: (err: AWSError, data: Mobile.Types.CreateProjectResult) => void): Request; + /** + * Creates an AWS Mobile Hub project. + */ + createProject(callback?: (err: AWSError, data: Mobile.Types.CreateProjectResult) => void): Request; + /** + * Delets a project in AWS Mobile Hub. + */ + deleteProject(params: Mobile.Types.DeleteProjectRequest, callback?: (err: AWSError, data: Mobile.Types.DeleteProjectResult) => void): Request; + /** + * Delets a project in AWS Mobile Hub. + */ + deleteProject(callback?: (err: AWSError, data: Mobile.Types.DeleteProjectResult) => void): Request; + /** + * Get the bundle details for the requested bundle id. + */ + describeBundle(params: Mobile.Types.DescribeBundleRequest, callback?: (err: AWSError, data: Mobile.Types.DescribeBundleResult) => void): Request; + /** + * Get the bundle details for the requested bundle id. + */ + describeBundle(callback?: (err: AWSError, data: Mobile.Types.DescribeBundleResult) => void): Request; + /** + * Gets details about a project in AWS Mobile Hub. + */ + describeProject(params: Mobile.Types.DescribeProjectRequest, callback?: (err: AWSError, data: Mobile.Types.DescribeProjectResult) => void): Request; + /** + * Gets details about a project in AWS Mobile Hub. + */ + describeProject(callback?: (err: AWSError, data: Mobile.Types.DescribeProjectResult) => void): Request; + /** + * Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources. + */ + exportBundle(params: Mobile.Types.ExportBundleRequest, callback?: (err: AWSError, data: Mobile.Types.ExportBundleResult) => void): Request; + /** + * Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources. + */ + exportBundle(callback?: (err: AWSError, data: Mobile.Types.ExportBundleResult) => void): Request; + /** + * Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account. + */ + exportProject(params: Mobile.Types.ExportProjectRequest, callback?: (err: AWSError, data: Mobile.Types.ExportProjectResult) => void): Request; + /** + * Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account. + */ + exportProject(callback?: (err: AWSError, data: Mobile.Types.ExportProjectResult) => void): Request; + /** + * List all available bundles. + */ + listBundles(params: Mobile.Types.ListBundlesRequest, callback?: (err: AWSError, data: Mobile.Types.ListBundlesResult) => void): Request; + /** + * List all available bundles. + */ + listBundles(callback?: (err: AWSError, data: Mobile.Types.ListBundlesResult) => void): Request; + /** + * Lists projects in AWS Mobile Hub. + */ + listProjects(params: Mobile.Types.ListProjectsRequest, callback?: (err: AWSError, data: Mobile.Types.ListProjectsResult) => void): Request; + /** + * Lists projects in AWS Mobile Hub. + */ + listProjects(callback?: (err: AWSError, data: Mobile.Types.ListProjectsResult) => void): Request; + /** + * Update an existing project. + */ + updateProject(params: Mobile.Types.UpdateProjectRequest, callback?: (err: AWSError, data: Mobile.Types.UpdateProjectResult) => void): Request; + /** + * Update an existing project. + */ + updateProject(callback?: (err: AWSError, data: Mobile.Types.UpdateProjectResult) => void): Request; +} +declare namespace Mobile { + export type AttributeKey = string; + export type AttributeValue = string; + export type Attributes = {[key: string]: AttributeValue}; + export type Boolean = boolean; + export type BundleDescription = string; + export interface BundleDetails { + bundleId?: BundleId; + title?: BundleTitle; + version?: BundleVersion; + description?: BundleDescription; + iconUrl?: IconUrl; + availablePlatforms?: Platforms; + } + export type BundleId = string; + export type BundleList = BundleDetails[]; + export type BundleTitle = string; + export type BundleVersion = string; + export type ConsoleUrl = string; + export type Contents = Buffer|Uint8Array|Blob|string; + export interface CreateProjectRequest { + /** + * Name of the project. + */ + name?: ProjectName; + /** + * Default region where project resources should be created. + */ + region?: ProjectRegion; + /** + * ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the contents of the file downloaded from the URL provided in an export project operation. + */ + contents?: Contents; + /** + * Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported. + */ + snapshotId?: SnapshotId; + } + export interface CreateProjectResult { + /** + * Detailed information about the created AWS Mobile Hub project. + */ + details?: ProjectDetails; + } + export type _Date = Date; + export interface DeleteProjectRequest { + /** + * Unique project identifier. + */ + projectId: ProjectId; + } + export interface DeleteProjectResult { + /** + * Resources which were deleted. + */ + deletedResources?: Resources; + /** + * Resources which were not deleted, due to a risk of losing potentially important data or files. + */ + orphanedResources?: Resources; + } + export interface DescribeBundleRequest { + /** + * Unique bundle identifier. + */ + bundleId: BundleId; + } + export interface DescribeBundleResult { + /** + * The details of the bundle. + */ + details?: BundleDetails; + } + export interface DescribeProjectRequest { + /** + * Unique project identifier. + */ + projectId: ProjectId; + /** + * If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project. + */ + syncFromResources?: Boolean; + } + export interface DescribeProjectResult { + details?: ProjectDetails; + } + export type DownloadUrl = string; + export interface ExportBundleRequest { + /** + * Unique bundle identifier. + */ + bundleId: BundleId; + /** + * Unique project identifier. + */ + projectId?: ProjectId; + /** + * Developer desktop or target application platform. + */ + platform?: Platform; + } + export interface ExportBundleResult { + /** + * URL which contains the custom-generated SDK and tool packages used to integrate the client mobile app or web app with the AWS resources created by the AWS Mobile Hub project. + */ + downloadUrl?: DownloadUrl; + } + export interface ExportProjectRequest { + /** + * Unique project identifier. + */ + projectId: ProjectId; + } + export interface ExportProjectResult { + /** + * URL which can be used to download the exported project configuation file(s). + */ + downloadUrl?: DownloadUrl; + /** + * URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again. + */ + shareUrl?: ShareUrl; + /** + * Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL. + */ + snapshotId?: SnapshotId; + } + export type Feature = string; + export type IconUrl = string; + export interface ListBundlesRequest { + /** + * Maximum number of records to list in a single response. + */ + maxResults?: MaxResults; + /** + * Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more bundles. + */ + nextToken?: NextToken; + } + export interface ListBundlesResult { + /** + * A list of bundles. + */ + bundleList?: BundleList; + /** + * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries. + */ + nextToken?: NextToken; + } + export interface ListProjectsRequest { + /** + * Maximum number of records to list in a single response. + */ + maxResults?: MaxResults; + /** + * Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more projects. + */ + nextToken?: NextToken; + } + export interface ListProjectsResult { + projects?: ProjectSummaries; + nextToken?: NextToken; + } + export type MaxResults = number; + export type NextToken = string; + export type Platform = "OSX"|"WINDOWS"|"LINUX"|"OBJC"|"SWIFT"|"ANDROID"|"JAVASCRIPT"|string; + export type Platforms = Platform[]; + export interface ProjectDetails { + name?: ProjectName; + projectId?: ProjectId; + region?: ProjectRegion; + state?: ProjectState; + /** + * Date the project was created. + */ + createdDate?: _Date; + /** + * Date of the last modification of the project. + */ + lastUpdatedDate?: _Date; + /** + * Website URL for this project in the AWS Mobile Hub console. + */ + consoleUrl?: ConsoleUrl; + resources?: Resources; + } + export type ProjectId = string; + export type ProjectName = string; + export type ProjectRegion = string; + export type ProjectState = "NORMAL"|"SYNCING"|"IMPORTING"|string; + export type ProjectSummaries = ProjectSummary[]; + export interface ProjectSummary { + /** + * Name of the project. + */ + name?: ProjectName; + /** + * Unique project identifier. + */ + projectId?: ProjectId; + } + export interface Resource { + type?: ResourceType; + name?: ResourceName; + arn?: ResourceArn; + feature?: Feature; + attributes?: Attributes; + } + export type ResourceArn = string; + export type ResourceName = string; + export type ResourceType = string; + export type Resources = Resource[]; + export type ShareUrl = string; + export type SnapshotId = string; + export interface UpdateProjectRequest { + /** + * ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file downloaded from the URL provided in an export project operation. + */ + contents?: Contents; + /** + * Unique project identifier. + */ + projectId: ProjectId; + } + export interface UpdateProjectResult { + /** + * Detailed information about the updated AWS Mobile Hub project. + */ + details?: ProjectDetails; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-07-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Mobile client. + */ + export import Types = Mobile; +} +export = Mobile; diff --git a/node_modules/aws-sdk/clients/mobile.js b/node_modules/aws-sdk/clients/mobile.js new file mode 100644 index 0000000..5ddfe47 --- /dev/null +++ b/node_modules/aws-sdk/clients/mobile.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mobile'] = {}; +AWS.Mobile = Service.defineService('mobile', ['2017-07-01']); +Object.defineProperty(apiLoader.services['mobile'], '2017-07-01', { + get: function get() { + var model = require('../apis/mobile-2017-07-01.min.json'); + model.paginators = require('../apis/mobile-2017-07-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Mobile; diff --git a/node_modules/aws-sdk/clients/mobileanalytics.d.ts b/node_modules/aws-sdk/clients/mobileanalytics.d.ts new file mode 100644 index 0000000..b935e4c --- /dev/null +++ b/node_modules/aws-sdk/clients/mobileanalytics.d.ts @@ -0,0 +1,108 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MobileAnalytics extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MobileAnalytics.Types.ClientConfiguration) + config: Config & MobileAnalytics.Types.ClientConfiguration; + /** + * The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values. + */ + putEvents(params: MobileAnalytics.Types.PutEventsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values. + */ + putEvents(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace MobileAnalytics { + export type Double = number; + export interface Event { + /** + * A name signifying an event that occurred in your app. This is used for grouping and aggregating like events together for reporting purposes. + */ + eventType: String50Chars; + /** + * The time the event occurred in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z + */ + timestamp: ISO8601Timestamp; + /** + * The session the event occured within. + */ + session?: Session; + /** + * The version of the event. + */ + version?: String10Chars; + /** + * A collection of key-value pairs that give additional context to the event. The key-value pairs are specified by the developer. This collection can be empty or the attribute object can be omitted. + */ + attributes?: MapOfStringToString; + /** + * A collection of key-value pairs that gives additional, measurable context to the event. The key-value pairs are specified by the developer. This collection can be empty or the attribute object can be omitted. + */ + metrics?: MapOfStringToNumber; + } + export type EventListDefinition = Event[]; + export type ISO8601Timestamp = string; + export type Long = number; + export type MapOfStringToNumber = {[key: string]: Double}; + export type MapOfStringToString = {[key: string]: String0to1000Chars}; + export interface PutEventsInput { + /** + * An array of Event JSON objects + */ + events: EventListDefinition; + /** + * The client context including the client ID, app title, app version and package name. + */ + clientContext: String; + /** + * The encoding used for the client context. + */ + clientContextEncoding?: String; + } + export interface Session { + /** + * A unique identifier for the session + */ + id?: String50Chars; + /** + * The duration of the session. + */ + duration?: Long; + /** + * The time the event started in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z + */ + startTimestamp?: ISO8601Timestamp; + /** + * The time the event terminated in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z + */ + stopTimestamp?: ISO8601Timestamp; + } + export type String = string; + export type String0to1000Chars = string; + export type String10Chars = string; + export type String50Chars = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-06-05"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MobileAnalytics client. + */ + export import Types = MobileAnalytics; +} +export = MobileAnalytics; diff --git a/node_modules/aws-sdk/clients/mobileanalytics.js b/node_modules/aws-sdk/clients/mobileanalytics.js new file mode 100644 index 0000000..6994e19 --- /dev/null +++ b/node_modules/aws-sdk/clients/mobileanalytics.js @@ -0,0 +1,17 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mobileanalytics'] = {}; +AWS.MobileAnalytics = Service.defineService('mobileanalytics', ['2014-06-05']); +Object.defineProperty(apiLoader.services['mobileanalytics'], '2014-06-05', { + get: function get() { + var model = require('../apis/mobileanalytics-2014-06-05.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MobileAnalytics; diff --git a/node_modules/aws-sdk/clients/mq.d.ts b/node_modules/aws-sdk/clients/mq.d.ts new file mode 100644 index 0000000..b30f8a9 --- /dev/null +++ b/node_modules/aws-sdk/clients/mq.d.ts @@ -0,0 +1,1174 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MQ extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MQ.Types.ClientConfiguration) + config: Config & MQ.Types.ClientConfiguration; + /** + * Creates a broker. Note: This API is asynchronous. + */ + createBroker(params: MQ.Types.CreateBrokerRequest, callback?: (err: AWSError, data: MQ.Types.CreateBrokerResponse) => void): Request; + /** + * Creates a broker. Note: This API is asynchronous. + */ + createBroker(callback?: (err: AWSError, data: MQ.Types.CreateBrokerResponse) => void): Request; + /** + * Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). + */ + createConfiguration(params: MQ.Types.CreateConfigurationRequest, callback?: (err: AWSError, data: MQ.Types.CreateConfigurationResponse) => void): Request; + /** + * Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). + */ + createConfiguration(callback?: (err: AWSError, data: MQ.Types.CreateConfigurationResponse) => void): Request; + /** + * Add a tag to a resource. + */ + createTags(params: MQ.Types.CreateTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Add a tag to a resource. + */ + createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates an ActiveMQ user. + */ + createUser(params: MQ.Types.CreateUserRequest, callback?: (err: AWSError, data: MQ.Types.CreateUserResponse) => void): Request; + /** + * Creates an ActiveMQ user. + */ + createUser(callback?: (err: AWSError, data: MQ.Types.CreateUserResponse) => void): Request; + /** + * Deletes a broker. Note: This API is asynchronous. + */ + deleteBroker(params: MQ.Types.DeleteBrokerRequest, callback?: (err: AWSError, data: MQ.Types.DeleteBrokerResponse) => void): Request; + /** + * Deletes a broker. Note: This API is asynchronous. + */ + deleteBroker(callback?: (err: AWSError, data: MQ.Types.DeleteBrokerResponse) => void): Request; + /** + * Removes a tag from a resource. + */ + deleteTags(params: MQ.Types.DeleteTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a tag from a resource. + */ + deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an ActiveMQ user. + */ + deleteUser(params: MQ.Types.DeleteUserRequest, callback?: (err: AWSError, data: MQ.Types.DeleteUserResponse) => void): Request; + /** + * Deletes an ActiveMQ user. + */ + deleteUser(callback?: (err: AWSError, data: MQ.Types.DeleteUserResponse) => void): Request; + /** + * Returns information about the specified broker. + */ + describeBroker(params: MQ.Types.DescribeBrokerRequest, callback?: (err: AWSError, data: MQ.Types.DescribeBrokerResponse) => void): Request; + /** + * Returns information about the specified broker. + */ + describeBroker(callback?: (err: AWSError, data: MQ.Types.DescribeBrokerResponse) => void): Request; + /** + * Describe available engine types and versions. + */ + describeBrokerEngineTypes(params: MQ.Types.DescribeBrokerEngineTypesRequest, callback?: (err: AWSError, data: MQ.Types.DescribeBrokerEngineTypesResponse) => void): Request; + /** + * Describe available engine types and versions. + */ + describeBrokerEngineTypes(callback?: (err: AWSError, data: MQ.Types.DescribeBrokerEngineTypesResponse) => void): Request; + /** + * Describe available broker instance options. + */ + describeBrokerInstanceOptions(params: MQ.Types.DescribeBrokerInstanceOptionsRequest, callback?: (err: AWSError, data: MQ.Types.DescribeBrokerInstanceOptionsResponse) => void): Request; + /** + * Describe available broker instance options. + */ + describeBrokerInstanceOptions(callback?: (err: AWSError, data: MQ.Types.DescribeBrokerInstanceOptionsResponse) => void): Request; + /** + * Returns information about the specified configuration. + */ + describeConfiguration(params: MQ.Types.DescribeConfigurationRequest, callback?: (err: AWSError, data: MQ.Types.DescribeConfigurationResponse) => void): Request; + /** + * Returns information about the specified configuration. + */ + describeConfiguration(callback?: (err: AWSError, data: MQ.Types.DescribeConfigurationResponse) => void): Request; + /** + * Returns the specified configuration revision for the specified configuration. + */ + describeConfigurationRevision(params: MQ.Types.DescribeConfigurationRevisionRequest, callback?: (err: AWSError, data: MQ.Types.DescribeConfigurationRevisionResponse) => void): Request; + /** + * Returns the specified configuration revision for the specified configuration. + */ + describeConfigurationRevision(callback?: (err: AWSError, data: MQ.Types.DescribeConfigurationRevisionResponse) => void): Request; + /** + * Returns information about an ActiveMQ user. + */ + describeUser(params: MQ.Types.DescribeUserRequest, callback?: (err: AWSError, data: MQ.Types.DescribeUserResponse) => void): Request; + /** + * Returns information about an ActiveMQ user. + */ + describeUser(callback?: (err: AWSError, data: MQ.Types.DescribeUserResponse) => void): Request; + /** + * Returns a list of all brokers. + */ + listBrokers(params: MQ.Types.ListBrokersRequest, callback?: (err: AWSError, data: MQ.Types.ListBrokersResponse) => void): Request; + /** + * Returns a list of all brokers. + */ + listBrokers(callback?: (err: AWSError, data: MQ.Types.ListBrokersResponse) => void): Request; + /** + * Returns a list of all revisions for the specified configuration. + */ + listConfigurationRevisions(params: MQ.Types.ListConfigurationRevisionsRequest, callback?: (err: AWSError, data: MQ.Types.ListConfigurationRevisionsResponse) => void): Request; + /** + * Returns a list of all revisions for the specified configuration. + */ + listConfigurationRevisions(callback?: (err: AWSError, data: MQ.Types.ListConfigurationRevisionsResponse) => void): Request; + /** + * Returns a list of all configurations. + */ + listConfigurations(params: MQ.Types.ListConfigurationsRequest, callback?: (err: AWSError, data: MQ.Types.ListConfigurationsResponse) => void): Request; + /** + * Returns a list of all configurations. + */ + listConfigurations(callback?: (err: AWSError, data: MQ.Types.ListConfigurationsResponse) => void): Request; + /** + * Lists tags for a resource. + */ + listTags(params: MQ.Types.ListTagsRequest, callback?: (err: AWSError, data: MQ.Types.ListTagsResponse) => void): Request; + /** + * Lists tags for a resource. + */ + listTags(callback?: (err: AWSError, data: MQ.Types.ListTagsResponse) => void): Request; + /** + * Returns a list of all ActiveMQ users. + */ + listUsers(params: MQ.Types.ListUsersRequest, callback?: (err: AWSError, data: MQ.Types.ListUsersResponse) => void): Request; + /** + * Returns a list of all ActiveMQ users. + */ + listUsers(callback?: (err: AWSError, data: MQ.Types.ListUsersResponse) => void): Request; + /** + * Reboots a broker. Note: This API is asynchronous. + */ + rebootBroker(params: MQ.Types.RebootBrokerRequest, callback?: (err: AWSError, data: MQ.Types.RebootBrokerResponse) => void): Request; + /** + * Reboots a broker. Note: This API is asynchronous. + */ + rebootBroker(callback?: (err: AWSError, data: MQ.Types.RebootBrokerResponse) => void): Request; + /** + * Adds a pending configuration change to a broker. + */ + updateBroker(params: MQ.Types.UpdateBrokerRequest, callback?: (err: AWSError, data: MQ.Types.UpdateBrokerResponse) => void): Request; + /** + * Adds a pending configuration change to a broker. + */ + updateBroker(callback?: (err: AWSError, data: MQ.Types.UpdateBrokerResponse) => void): Request; + /** + * Updates the specified configuration. + */ + updateConfiguration(params: MQ.Types.UpdateConfigurationRequest, callback?: (err: AWSError, data: MQ.Types.UpdateConfigurationResponse) => void): Request; + /** + * Updates the specified configuration. + */ + updateConfiguration(callback?: (err: AWSError, data: MQ.Types.UpdateConfigurationResponse) => void): Request; + /** + * Updates the information for an ActiveMQ user. + */ + updateUser(params: MQ.Types.UpdateUserRequest, callback?: (err: AWSError, data: MQ.Types.UpdateUserResponse) => void): Request; + /** + * Updates the information for an ActiveMQ user. + */ + updateUser(callback?: (err: AWSError, data: MQ.Types.UpdateUserResponse) => void): Request; +} +declare namespace MQ { + export interface AvailabilityZone { + /** + * Id for the availability zone. + */ + Name?: __string; + } + export interface BrokerEngineType { + /** + * The type of broker engine. + */ + EngineType?: EngineType; + /** + * The list of engine versions. + */ + EngineVersions?: __listOfEngineVersion; + } + export interface BrokerInstance { + /** + * The URL of the broker's ActiveMQ Web Console. + */ + ConsoleURL?: __string; + /** + * The broker's wire-level protocol endpoints. + */ + Endpoints?: __listOf__string; + /** + * The IP address of the Elastic Network Interface (ENI) attached to the broker. + */ + IpAddress?: __string; + } + export interface BrokerInstanceOption { + /** + * The list of available az. + */ + AvailabilityZones?: __listOfAvailabilityZone; + /** + * The type of broker engine. + */ + EngineType?: EngineType; + /** + * The type of broker instance. + */ + HostInstanceType?: __string; + /** + * The list of supported engine versions. + */ + SupportedEngineVersions?: __listOf__string; + } + export type BrokerState = "CREATION_IN_PROGRESS"|"CREATION_FAILED"|"DELETION_IN_PROGRESS"|"RUNNING"|"REBOOT_IN_PROGRESS"|string; + export interface BrokerSummary { + /** + * The Amazon Resource Name (ARN) of the broker. + */ + BrokerArn?: __string; + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId?: __string; + /** + * The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. + */ + BrokerName?: __string; + /** + * The status of the broker. + */ + BrokerState?: BrokerState; + /** + * The time when the broker was created. + */ + Created?: __timestampIso8601; + /** + * Required. The deployment mode of the broker. + */ + DeploymentMode?: DeploymentMode; + /** + * The broker's instance type. + */ + HostInstanceType?: __string; + } + export type ChangeType = "CREATE"|"UPDATE"|"DELETE"|string; + export interface Configuration { + /** + * Required. The ARN of the configuration. + */ + Arn?: __string; + /** + * Required. The date and time of the configuration revision. + */ + Created?: __timestampIso8601; + /** + * Required. The description of the configuration. + */ + Description?: __string; + /** + * Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. + */ + EngineType?: EngineType; + /** + * Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + EngineVersion?: __string; + /** + * Required. The unique ID that Amazon MQ generates for the configuration. + */ + Id?: __string; + /** + * Required. The latest revision of the configuration. + */ + LatestRevision?: ConfigurationRevision; + /** + * Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. + */ + Name?: __string; + /** + * The list of all tags associated with this configuration. + */ + Tags?: __mapOf__string; + } + export interface ConfigurationId { + /** + * Required. The unique ID that Amazon MQ generates for the configuration. + */ + Id?: __string; + /** + * The revision number of the configuration. + */ + Revision?: __integer; + } + export interface ConfigurationRevision { + /** + * Required. The date and time of the configuration revision. + */ + Created?: __timestampIso8601; + /** + * The description of the configuration revision. + */ + Description?: __string; + /** + * Required. The revision number of the configuration. + */ + Revision?: __integer; + } + export interface Configurations { + /** + * The current configuration of the broker. + */ + Current?: ConfigurationId; + /** + * The history of configurations applied to the broker. + */ + History?: __listOfConfigurationId; + /** + * The pending configuration of the broker. + */ + Pending?: ConfigurationId; + } + export interface CreateBrokerRequest { + /** + * Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. + */ + AutoMinorVersionUpgrade?: __boolean; + /** + * Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. + */ + BrokerName?: __string; + /** + * A list of information about the configuration. + */ + Configuration?: ConfigurationId; + /** + * The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency. + */ + CreatorRequestId?: __string; + /** + * Required. The deployment mode of the broker. + */ + DeploymentMode?: DeploymentMode; + /** + * Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. + */ + EngineType?: EngineType; + /** + * Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + EngineVersion?: __string; + /** + * Required. The broker's instance type. + */ + HostInstanceType?: __string; + /** + * Enables Amazon CloudWatch logging for brokers. + */ + Logs?: Logs; + /** + * The parameters that determine the WeeklyStartTime. + */ + MaintenanceWindowStartTime?: WeeklyStartTime; + /** + * Required. Enables connections from applications outside of the VPC that hosts the broker's subnets. + */ + PubliclyAccessible?: __boolean; + /** + * The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. + */ + SecurityGroups?: __listOf__string; + /** + * The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. + */ + SubnetIds?: __listOf__string; + /** + * Create tags when creating the broker. + */ + Tags?: __mapOf__string; + /** + * Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Users?: __listOfUser; + } + export interface CreateBrokerResponse { + /** + * The Amazon Resource Name (ARN) of the broker. + */ + BrokerArn?: __string; + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId?: __string; + } + export interface CreateConfigurationRequest { + /** + * Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. + */ + EngineType?: EngineType; + /** + * Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + EngineVersion?: __string; + /** + * Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. + */ + Name?: __string; + /** + * Create tags when creating the configuration. + */ + Tags?: __mapOf__string; + } + export interface CreateConfigurationResponse { + /** + * Required. The Amazon Resource Name (ARN) of the configuration. + */ + Arn?: __string; + /** + * Required. The date and time of the configuration. + */ + Created?: __timestampIso8601; + /** + * Required. The unique ID that Amazon MQ generates for the configuration. + */ + Id?: __string; + /** + * The latest revision of the configuration. + */ + LatestRevision?: ConfigurationRevision; + /** + * Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. + */ + Name?: __string; + } + export interface CreateTagsRequest { + /** + * The Amazon Resource Name (ARN) of the resource tag. + */ + ResourceArn: __string; + /** + * The key-value pair for the resource tag. + */ + Tags?: __mapOf__string; + } + export interface CreateUserRequest { + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId: __string; + /** + * Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + */ + ConsoleAccess?: __boolean; + /** + * The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Groups?: __listOf__string; + /** + * Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas. + */ + Password?: __string; + /** + * The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Username: __string; + } + export interface CreateUserResponse { + } + export type DayOfWeek = "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY"|string; + export interface DeleteBrokerRequest { + /** + * The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. + */ + BrokerId: __string; + } + export interface DeleteBrokerResponse { + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId?: __string; + } + export interface DeleteTagsRequest { + /** + * The Amazon Resource Name (ARN) of the resource tag. + */ + ResourceArn: __string; + /** + * An array of tag keys to delete + */ + TagKeys: __listOf__string; + } + export interface DeleteUserRequest { + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId: __string; + /** + * The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Username: __string; + } + export interface DeleteUserResponse { + } + export type DeploymentMode = "SINGLE_INSTANCE"|"ACTIVE_STANDBY_MULTI_AZ"|string; + export interface DescribeBrokerEngineTypesRequest { + /** + * Filter response by engine type. + */ + EngineType?: __string; + /** + * The maximum number of engine types that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: MaxResults; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface DescribeBrokerEngineTypesResponse { + /** + * List of available engine types and versions. + */ + BrokerEngineTypes?: __listOfBrokerEngineType; + /** + * Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: __integerMin5Max100; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface DescribeBrokerInstanceOptionsRequest { + /** + * Filter response by engine type. + */ + EngineType?: __string; + /** + * Filter response by host instance type. + */ + HostInstanceType?: __string; + /** + * The maximum number of instance options that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: MaxResults; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface DescribeBrokerInstanceOptionsResponse { + /** + * List of available broker instance options. + */ + BrokerInstanceOptions?: __listOfBrokerInstanceOption; + /** + * Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: __integerMin5Max100; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface DescribeBrokerRequest { + /** + * The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. + */ + BrokerId: __string; + } + export interface DescribeBrokerResponse { + /** + * Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. + */ + AutoMinorVersionUpgrade?: __boolean; + /** + * The Amazon Resource Name (ARN) of the broker. + */ + BrokerArn?: __string; + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId?: __string; + /** + * A list of information about allocated brokers. + */ + BrokerInstances?: __listOfBrokerInstance; + /** + * The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. + */ + BrokerName?: __string; + /** + * The status of the broker. + */ + BrokerState?: BrokerState; + /** + * The list of all revisions for the specified configuration. + */ + Configurations?: Configurations; + /** + * The time when the broker was created. + */ + Created?: __timestampIso8601; + /** + * Required. The deployment mode of the broker. + */ + DeploymentMode?: DeploymentMode; + /** + * Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. + */ + EngineType?: EngineType; + /** + * The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + EngineVersion?: __string; + /** + * The broker's instance type. + */ + HostInstanceType?: __string; + /** + * The list of information about logs currently enabled and pending to be deployed for the specified broker. + */ + Logs?: LogsSummary; + /** + * The parameters that determine the WeeklyStartTime. + */ + MaintenanceWindowStartTime?: WeeklyStartTime; + /** + * The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + PendingEngineVersion?: __string; + /** + * Required. Enables connections from applications outside of the VPC that hosts the broker's subnets. + */ + PubliclyAccessible?: __boolean; + /** + * Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. + */ + SecurityGroups?: __listOf__string; + /** + * The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. + */ + SubnetIds?: __listOf__string; + /** + * The list of all tags associated with this broker. + */ + Tags?: __mapOf__string; + /** + * The list of all ActiveMQ usernames for the specified broker. + */ + Users?: __listOfUserSummary; + } + export interface DescribeConfigurationRequest { + /** + * The unique ID that Amazon MQ generates for the configuration. + */ + ConfigurationId: __string; + } + export interface DescribeConfigurationResponse { + /** + * Required. The ARN of the configuration. + */ + Arn?: __string; + /** + * Required. The date and time of the configuration revision. + */ + Created?: __timestampIso8601; + /** + * Required. The description of the configuration. + */ + Description?: __string; + /** + * Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. + */ + EngineType?: EngineType; + /** + * Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + EngineVersion?: __string; + /** + * Required. The unique ID that Amazon MQ generates for the configuration. + */ + Id?: __string; + /** + * Required. The latest revision of the configuration. + */ + LatestRevision?: ConfigurationRevision; + /** + * Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. + */ + Name?: __string; + /** + * The list of all tags associated with this configuration. + */ + Tags?: __mapOf__string; + } + export interface DescribeConfigurationRevisionRequest { + /** + * The unique ID that Amazon MQ generates for the configuration. + */ + ConfigurationId: __string; + /** + * The revision of the configuration. + */ + ConfigurationRevision: __string; + } + export interface DescribeConfigurationRevisionResponse { + /** + * Required. The unique ID that Amazon MQ generates for the configuration. + */ + ConfigurationId?: __string; + /** + * Required. The date and time of the configuration. + */ + Created?: __timestampIso8601; + /** + * Required. The base64-encoded XML configuration. + */ + Data?: __string; + /** + * The description of the configuration. + */ + Description?: __string; + } + export interface DescribeUserRequest { + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId: __string; + /** + * The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Username: __string; + } + export interface DescribeUserResponse { + /** + * Required. The unique ID that Amazon MQ generates for the broker. + */ + BrokerId?: __string; + /** + * Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + */ + ConsoleAccess?: __boolean; + /** + * The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Groups?: __listOf__string; + /** + * The status of the changes pending for the ActiveMQ user. + */ + Pending?: UserPendingChanges; + /** + * Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Username?: __string; + } + export type EngineType = "ACTIVEMQ"|string; + export interface EngineVersion { + /** + * Id for the version. + */ + Name?: __string; + } + export interface ListBrokersRequest { + /** + * The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: MaxResults; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface ListBrokersResponse { + /** + * A list of information about all brokers. + */ + BrokerSummaries?: __listOfBrokerSummary; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface ListConfigurationRevisionsRequest { + /** + * The unique ID that Amazon MQ generates for the configuration. + */ + ConfigurationId: __string; + /** + * The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: MaxResults; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface ListConfigurationRevisionsResponse { + /** + * The unique ID that Amazon MQ generates for the configuration. + */ + ConfigurationId?: __string; + /** + * The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: __integer; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + /** + * The list of all revisions for the specified configuration. + */ + Revisions?: __listOfConfigurationRevision; + } + export interface ListConfigurationsRequest { + /** + * The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: MaxResults; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface ListConfigurationsResponse { + /** + * The list of all revisions for the specified configuration. + */ + Configurations?: __listOfConfiguration; + /** + * The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: __integer; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface ListTagsRequest { + /** + * The Amazon Resource Name (ARN) of the resource tag. + */ + ResourceArn: __string; + } + export interface ListTagsResponse { + /** + * The key-value pair for the resource tag. + */ + Tags?: __mapOf__string; + } + export interface ListUsersRequest { + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId: __string; + /** + * The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: MaxResults; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + } + export interface ListUsersResponse { + /** + * Required. The unique ID that Amazon MQ generates for the broker. + */ + BrokerId?: __string; + /** + * Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100. + */ + MaxResults?: __integerMin5Max100; + /** + * The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. + */ + NextToken?: __string; + /** + * Required. The list of all ActiveMQ usernames for the specified broker. + */ + Users?: __listOfUserSummary; + } + export interface Logs { + /** + * Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. + */ + Audit?: __boolean; + /** + * Enables general logging. + */ + General?: __boolean; + } + export interface LogsSummary { + /** + * Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. + */ + Audit?: __boolean; + /** + * The location of the CloudWatch Logs log group where audit logs are sent. + */ + AuditLogGroup?: __string; + /** + * Enables general logging. + */ + General?: __boolean; + /** + * The location of the CloudWatch Logs log group where general logs are sent. + */ + GeneralLogGroup?: __string; + /** + * The list of information about logs pending to be deployed for the specified broker. + */ + Pending?: PendingLogs; + } + export type MaxResults = number; + export interface PendingLogs { + /** + * Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. + */ + Audit?: __boolean; + /** + * Enables general logging. + */ + General?: __boolean; + } + export interface RebootBrokerRequest { + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId: __string; + } + export interface RebootBrokerResponse { + } + export interface SanitizationWarning { + /** + * The name of the XML attribute that has been sanitized. + */ + AttributeName?: __string; + /** + * The name of the XML element that has been sanitized. + */ + ElementName?: __string; + /** + * Required. The reason for which the XML elements or attributes were sanitized. + */ + Reason?: SanitizationWarningReason; + } + export type SanitizationWarningReason = "DISALLOWED_ELEMENT_REMOVED"|"DISALLOWED_ATTRIBUTE_REMOVED"|"INVALID_ATTRIBUTE_VALUE_REMOVED"|string; + export interface UpdateBrokerRequest { + /** + * Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. + */ + AutoMinorVersionUpgrade?: __boolean; + /** + * The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. + */ + BrokerId: __string; + /** + * A list of information about the configuration. + */ + Configuration?: ConfigurationId; + /** + * The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + EngineVersion?: __string; + /** + * Enables Amazon CloudWatch logging for brokers. + */ + Logs?: Logs; + } + export interface UpdateBrokerResponse { + /** + * The new value of automatic upgrades to new minor version for brokers. + */ + AutoMinorVersionUpgrade?: __boolean; + /** + * Required. The unique ID that Amazon MQ generates for the broker. + */ + BrokerId?: __string; + /** + * The ID of the updated configuration. + */ + Configuration?: ConfigurationId; + /** + * The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html + */ + EngineVersion?: __string; + /** + * The list of information about logs to be enabled for the specified broker. + */ + Logs?: Logs; + } + export interface UpdateConfigurationRequest { + /** + * The unique ID that Amazon MQ generates for the configuration. + */ + ConfigurationId: __string; + /** + * Required. The base64-encoded XML configuration. + */ + Data?: __string; + /** + * The description of the configuration. + */ + Description?: __string; + } + export interface UpdateConfigurationResponse { + /** + * Required. The Amazon Resource Name (ARN) of the configuration. + */ + Arn?: __string; + /** + * Required. The date and time of the configuration. + */ + Created?: __timestampIso8601; + /** + * Required. The unique ID that Amazon MQ generates for the configuration. + */ + Id?: __string; + /** + * The latest revision of the configuration. + */ + LatestRevision?: ConfigurationRevision; + /** + * Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. + */ + Name?: __string; + /** + * The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized. + */ + Warnings?: __listOfSanitizationWarning; + } + export interface UpdateUserRequest { + /** + * The unique ID that Amazon MQ generates for the broker. + */ + BrokerId: __string; + /** + * Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + */ + ConsoleAccess?: __boolean; + /** + * The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Groups?: __listOf__string; + /** + * The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas. + */ + Password?: __string; + /** + * Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Username: __string; + } + export interface UpdateUserResponse { + } + export interface User { + /** + * Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + */ + ConsoleAccess?: __boolean; + /** + * The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Groups?: __listOf__string; + /** + * Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas. + */ + Password?: __string; + /** + * Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Username?: __string; + } + export interface UserPendingChanges { + /** + * Enables access to the the ActiveMQ Web Console for the ActiveMQ user. + */ + ConsoleAccess?: __boolean; + /** + * The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Groups?: __listOf__string; + /** + * Required. The type of change pending for the ActiveMQ user. + */ + PendingChange?: ChangeType; + } + export interface UserSummary { + /** + * The type of change pending for the ActiveMQ user. + */ + PendingChange?: ChangeType; + /** + * Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. + */ + Username?: __string; + } + export interface WeeklyStartTime { + /** + * Required. The day of the week. + */ + DayOfWeek?: DayOfWeek; + /** + * Required. The time, in 24-hour format. + */ + TimeOfDay?: __string; + /** + * The time zone, UTC by default, in either the Country/City format, or the UTC offset format. + */ + TimeZone?: __string; + } + export type __boolean = boolean; + export type __integer = number; + export type __integerMin5Max100 = number; + export type __listOfAvailabilityZone = AvailabilityZone[]; + export type __listOfBrokerEngineType = BrokerEngineType[]; + export type __listOfBrokerInstance = BrokerInstance[]; + export type __listOfBrokerInstanceOption = BrokerInstanceOption[]; + export type __listOfBrokerSummary = BrokerSummary[]; + export type __listOfConfiguration = Configuration[]; + export type __listOfConfigurationId = ConfigurationId[]; + export type __listOfConfigurationRevision = ConfigurationRevision[]; + export type __listOfEngineVersion = EngineVersion[]; + export type __listOfSanitizationWarning = SanitizationWarning[]; + export type __listOfUser = User[]; + export type __listOfUserSummary = UserSummary[]; + export type __listOf__string = __string[]; + export type __mapOf__string = {[key: string]: __string}; + export type __string = string; + export type __timestampIso8601 = Date; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-11-27"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MQ client. + */ + export import Types = MQ; +} +export = MQ; diff --git a/node_modules/aws-sdk/clients/mq.js b/node_modules/aws-sdk/clients/mq.js new file mode 100644 index 0000000..2791313 --- /dev/null +++ b/node_modules/aws-sdk/clients/mq.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mq'] = {}; +AWS.MQ = Service.defineService('mq', ['2017-11-27']); +Object.defineProperty(apiLoader.services['mq'], '2017-11-27', { + get: function get() { + var model = require('../apis/mq-2017-11-27.min.json'); + model.paginators = require('../apis/mq-2017-11-27.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MQ; diff --git a/node_modules/aws-sdk/clients/mturk.d.ts b/node_modules/aws-sdk/clients/mturk.d.ts new file mode 100644 index 0000000..95c8142 --- /dev/null +++ b/node_modules/aws-sdk/clients/mturk.d.ts @@ -0,0 +1,1687 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class MTurk extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: MTurk.Types.ClientConfiguration) + config: Config & MTurk.Types.ClientConfiguration; + /** + * The AcceptQualificationRequest operation approves a Worker's request for a Qualification. Only the owner of the Qualification type can grant a Qualification request for that type. A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body. + */ + acceptQualificationRequest(params: MTurk.Types.AcceptQualificationRequestRequest, callback?: (err: AWSError, data: MTurk.Types.AcceptQualificationRequestResponse) => void): Request; + /** + * The AcceptQualificationRequest operation approves a Worker's request for a Qualification. Only the owner of the Qualification type can grant a Qualification request for that type. A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body. + */ + acceptQualificationRequest(callback?: (err: AWSError, data: MTurk.Types.AcceptQualificationRequestResponse) => void): Request; + /** + * The ApproveAssignment operation approves the results of a completed assignment. Approving an assignment initiates two payments from the Requester's Amazon.com account The Worker who submitted the results is paid the reward specified in the HIT. Amazon Mechanical Turk fees are debited. If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site. You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted. + */ + approveAssignment(params: MTurk.Types.ApproveAssignmentRequest, callback?: (err: AWSError, data: MTurk.Types.ApproveAssignmentResponse) => void): Request; + /** + * The ApproveAssignment operation approves the results of a completed assignment. Approving an assignment initiates two payments from the Requester's Amazon.com account The Worker who submitted the results is paid the reward specified in the HIT. Amazon Mechanical Turk fees are debited. If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site. You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted. + */ + approveAssignment(callback?: (err: AWSError, data: MTurk.Types.ApproveAssignmentResponse) => void): Request; + /** + * The AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker. You can only assign a Qualification of a Qualification type that you created (using the CreateQualificationType operation). Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the RejectQualificationRequest operation. + */ + associateQualificationWithWorker(params: MTurk.Types.AssociateQualificationWithWorkerRequest, callback?: (err: AWSError, data: MTurk.Types.AssociateQualificationWithWorkerResponse) => void): Request; + /** + * The AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker. You can only assign a Qualification of a Qualification type that you created (using the CreateQualificationType operation). Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the RejectQualificationRequest operation. + */ + associateQualificationWithWorker(callback?: (err: AWSError, data: MTurk.Types.AssociateQualificationWithWorkerResponse) => void): Request; + /** + * The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT. To extend the maximum number of assignments, specify the number of additional assignments. HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception. HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception. + */ + createAdditionalAssignmentsForHIT(params: MTurk.Types.CreateAdditionalAssignmentsForHITRequest, callback?: (err: AWSError, data: MTurk.Types.CreateAdditionalAssignmentsForHITResponse) => void): Request; + /** + * The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT. To extend the maximum number of assignments, specify the number of additional assignments. HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception. HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception. + */ + createAdditionalAssignmentsForHIT(callback?: (err: AWSError, data: MTurk.Types.CreateAdditionalAssignmentsForHITResponse) => void): Request; + /** + * The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website. This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT is created for you, with a new HITTypeID. The HITTypeID can be used to create additional HITs in the future without needing to specify common parameters such as the title, description and reward amount each time. An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType operation and then call the CreateHITWithHITType operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHIT also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing. + */ + createHIT(params: MTurk.Types.CreateHITRequest, callback?: (err: AWSError, data: MTurk.Types.CreateHITResponse) => void): Request; + /** + * The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website. This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT is created for you, with a new HITTypeID. The HITTypeID can be used to create additional HITs in the future without needing to specify common parameters such as the title, description and reward amount each time. An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType operation and then call the CreateHITWithHITType operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHIT also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing. + */ + createHIT(callback?: (err: AWSError, data: MTurk.Types.CreateHITResponse) => void): Request; + /** + * The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned. + */ + createHITType(params: MTurk.Types.CreateHITTypeRequest, callback?: (err: AWSError, data: MTurk.Types.CreateHITTypeResponse) => void): Request; + /** + * The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned. + */ + createHITType(callback?: (err: AWSError, data: MTurk.Types.CreateHITTypeResponse) => void): Request; + /** + * The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation. This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHITWithHITType also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing. + */ + createHITWithHITType(params: MTurk.Types.CreateHITWithHITTypeRequest, callback?: (err: AWSError, data: MTurk.Types.CreateHITWithHITTypeResponse) => void): Request; + /** + * The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation. This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHITWithHITType also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing. + */ + createHITWithHITType(callback?: (err: AWSError, data: MTurk.Types.CreateHITWithHITTypeResponse) => void): Request; + /** + * The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure. + */ + createQualificationType(params: MTurk.Types.CreateQualificationTypeRequest, callback?: (err: AWSError, data: MTurk.Types.CreateQualificationTypeResponse) => void): Request; + /** + * The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure. + */ + createQualificationType(callback?: (err: AWSError, data: MTurk.Types.CreateQualificationTypeResponse) => void): Request; + /** + * The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers. + */ + createWorkerBlock(params: MTurk.Types.CreateWorkerBlockRequest, callback?: (err: AWSError, data: MTurk.Types.CreateWorkerBlockResponse) => void): Request; + /** + * The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers. + */ + createWorkerBlock(callback?: (err: AWSError, data: MTurk.Types.CreateWorkerBlockResponse) => void): Request; + /** + * The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it. You can only dispose of HITs that are in the Reviewable state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the Reviewable state (for example, that has not expired, or still has active assignments), or on a HIT that is Reviewable but without all of its submitted assignments already approved or rejected, the service will return an error. HITs are automatically disposed of after 120 days. After you dispose of a HIT, you can no longer approve the HIT's rejected assignments. Disposed HITs are not returned in results for the ListHITs operation. Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs. + */ + deleteHIT(params: MTurk.Types.DeleteHITRequest, callback?: (err: AWSError, data: MTurk.Types.DeleteHITResponse) => void): Request; + /** + * The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it. You can only dispose of HITs that are in the Reviewable state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the Reviewable state (for example, that has not expired, or still has active assignments), or on a HIT that is Reviewable but without all of its submitted assignments already approved or rejected, the service will return an error. HITs are automatically disposed of after 120 days. After you dispose of a HIT, you can no longer approve the HIT's rejected assignments. Disposed HITs are not returned in results for the ListHITs operation. Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs. + */ + deleteHIT(callback?: (err: AWSError, data: MTurk.Types.DeleteHITResponse) => void): Request; + /** + * The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType. + */ + deleteQualificationType(params: MTurk.Types.DeleteQualificationTypeRequest, callback?: (err: AWSError, data: MTurk.Types.DeleteQualificationTypeResponse) => void): Request; + /** + * The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType. + */ + deleteQualificationType(callback?: (err: AWSError, data: MTurk.Types.DeleteQualificationTypeResponse) => void): Request; + /** + * The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully. + */ + deleteWorkerBlock(params: MTurk.Types.DeleteWorkerBlockRequest, callback?: (err: AWSError, data: MTurk.Types.DeleteWorkerBlockResponse) => void): Request; + /** + * The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully. + */ + deleteWorkerBlock(callback?: (err: AWSError, data: MTurk.Types.DeleteWorkerBlockResponse) => void): Request; + /** + * The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message. + */ + disassociateQualificationFromWorker(params: MTurk.Types.DisassociateQualificationFromWorkerRequest, callback?: (err: AWSError, data: MTurk.Types.DisassociateQualificationFromWorkerResponse) => void): Request; + /** + * The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message. + */ + disassociateQualificationFromWorker(callback?: (err: AWSError, data: MTurk.Types.DisassociateQualificationFromWorkerResponse) => void): Request; + /** + * The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account. + */ + getAccountBalance(params: MTurk.Types.GetAccountBalanceRequest, callback?: (err: AWSError, data: MTurk.Types.GetAccountBalanceResponse) => void): Request; + /** + * The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account. + */ + getAccountBalance(callback?: (err: AWSError, data: MTurk.Types.GetAccountBalanceResponse) => void): Request; + /** + * The GetAssignment operation retrieves the details of the specified Assignment. + */ + getAssignment(params: MTurk.Types.GetAssignmentRequest, callback?: (err: AWSError, data: MTurk.Types.GetAssignmentResponse) => void): Request; + /** + * The GetAssignment operation retrieves the details of the specified Assignment. + */ + getAssignment(callback?: (err: AWSError, data: MTurk.Types.GetAssignmentResponse) => void): Request; + /** + * The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure. Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3. + */ + getFileUploadURL(params: MTurk.Types.GetFileUploadURLRequest, callback?: (err: AWSError, data: MTurk.Types.GetFileUploadURLResponse) => void): Request; + /** + * The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure. Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3. + */ + getFileUploadURL(callback?: (err: AWSError, data: MTurk.Types.GetFileUploadURLResponse) => void): Request; + /** + * The GetHIT operation retrieves the details of the specified HIT. + */ + getHIT(params: MTurk.Types.GetHITRequest, callback?: (err: AWSError, data: MTurk.Types.GetHITResponse) => void): Request; + /** + * The GetHIT operation retrieves the details of the specified HIT. + */ + getHIT(callback?: (err: AWSError, data: MTurk.Types.GetHITResponse) => void): Request; + /** + * The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type. To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment data returned by the ListAssignmentsForHIT operation. Only the owner of a Qualification type can query the value of a Worker's Qualification of that type. + */ + getQualificationScore(params: MTurk.Types.GetQualificationScoreRequest, callback?: (err: AWSError, data: MTurk.Types.GetQualificationScoreResponse) => void): Request; + /** + * The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type. To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment data returned by the ListAssignmentsForHIT operation. Only the owner of a Qualification type can query the value of a Worker's Qualification of that type. + */ + getQualificationScore(callback?: (err: AWSError, data: MTurk.Types.GetQualificationScoreResponse) => void): Request; + /** + * The GetQualificationTypeoperation retrieves information about a Qualification type using its ID. + */ + getQualificationType(params: MTurk.Types.GetQualificationTypeRequest, callback?: (err: AWSError, data: MTurk.Types.GetQualificationTypeResponse) => void): Request; + /** + * The GetQualificationTypeoperation retrieves information about a Qualification type using its ID. + */ + getQualificationType(callback?: (err: AWSError, data: MTurk.Types.GetQualificationTypeResponse) => void): Request; + /** + * The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT. You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation. Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set. Only the Requester who created the HIT can retrieve the assignments for that HIT. Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination. + */ + listAssignmentsForHIT(params: MTurk.Types.ListAssignmentsForHITRequest, callback?: (err: AWSError, data: MTurk.Types.ListAssignmentsForHITResponse) => void): Request; + /** + * The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT. You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation. Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set. Only the Requester who created the HIT can retrieve the assignments for that HIT. Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination. + */ + listAssignmentsForHIT(callback?: (err: AWSError, data: MTurk.Types.ListAssignmentsForHITResponse) => void): Request; + /** + * The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment. + */ + listBonusPayments(params: MTurk.Types.ListBonusPaymentsRequest, callback?: (err: AWSError, data: MTurk.Types.ListBonusPaymentsResponse) => void): Request; + /** + * The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment. + */ + listBonusPayments(callback?: (err: AWSError, data: MTurk.Types.ListBonusPaymentsResponse) => void): Request; + /** + * The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted. + */ + listHITs(params: MTurk.Types.ListHITsRequest, callback?: (err: AWSError, data: MTurk.Types.ListHITsResponse) => void): Request; + /** + * The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted. + */ + listHITs(callback?: (err: AWSError, data: MTurk.Types.ListHITsResponse) => void): Request; + /** + * The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the DeleteHIT operation or that have been auto-deleted. + */ + listHITsForQualificationType(params: MTurk.Types.ListHITsForQualificationTypeRequest, callback?: (err: AWSError, data: MTurk.Types.ListHITsForQualificationTypeResponse) => void): Request; + /** + * The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the DeleteHIT operation or that have been auto-deleted. + */ + listHITsForQualificationType(callback?: (err: AWSError, data: MTurk.Types.ListHITsForQualificationTypeResponse) => void): Request; + /** + * The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation. + */ + listQualificationRequests(params: MTurk.Types.ListQualificationRequestsRequest, callback?: (err: AWSError, data: MTurk.Types.ListQualificationRequestsResponse) => void): Request; + /** + * The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation. + */ + listQualificationRequests(callback?: (err: AWSError, data: MTurk.Types.ListQualificationRequestsResponse) => void): Request; + /** + * The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term. + */ + listQualificationTypes(params: MTurk.Types.ListQualificationTypesRequest, callback?: (err: AWSError, data: MTurk.Types.ListQualificationTypesResponse) => void): Request; + /** + * The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term. + */ + listQualificationTypes(callback?: (err: AWSError, data: MTurk.Types.ListQualificationTypesResponse) => void): Request; + /** + * The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results. + */ + listReviewPolicyResultsForHIT(params: MTurk.Types.ListReviewPolicyResultsForHITRequest, callback?: (err: AWSError, data: MTurk.Types.ListReviewPolicyResultsForHITResponse) => void): Request; + /** + * The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results. + */ + listReviewPolicyResultsForHIT(callback?: (err: AWSError, data: MTurk.Types.ListReviewPolicyResultsForHITResponse) => void): Request; + /** + * The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation. + */ + listReviewableHITs(params: MTurk.Types.ListReviewableHITsRequest, callback?: (err: AWSError, data: MTurk.Types.ListReviewableHITsResponse) => void): Request; + /** + * The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation. + */ + listReviewableHITs(callback?: (err: AWSError, data: MTurk.Types.ListReviewableHITsResponse) => void): Request; + /** + * The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs. + */ + listWorkerBlocks(params: MTurk.Types.ListWorkerBlocksRequest, callback?: (err: AWSError, data: MTurk.Types.ListWorkerBlocksResponse) => void): Request; + /** + * The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs. + */ + listWorkerBlocks(callback?: (err: AWSError, data: MTurk.Types.ListWorkerBlocksResponse) => void): Request; + /** + * The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type. + */ + listWorkersWithQualificationType(params: MTurk.Types.ListWorkersWithQualificationTypeRequest, callback?: (err: AWSError, data: MTurk.Types.ListWorkersWithQualificationTypeResponse) => void): Request; + /** + * The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type. + */ + listWorkersWithQualificationType(callback?: (err: AWSError, data: MTurk.Types.ListWorkersWithQualificationTypeResponse) => void): Request; + /** + * The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker. + */ + notifyWorkers(params: MTurk.Types.NotifyWorkersRequest, callback?: (err: AWSError, data: MTurk.Types.NotifyWorkersResponse) => void): Request; + /** + * The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker. + */ + notifyWorkers(callback?: (err: AWSError, data: MTurk.Types.NotifyWorkersResponse) => void): Request; + /** + * The RejectAssignment operation rejects the results of a completed assignment. You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future. Only the Requester who created the HIT can reject an assignment for the HIT. + */ + rejectAssignment(params: MTurk.Types.RejectAssignmentRequest, callback?: (err: AWSError, data: MTurk.Types.RejectAssignmentResponse) => void): Request; + /** + * The RejectAssignment operation rejects the results of a completed assignment. You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future. Only the Requester who created the HIT can reject an assignment for the HIT. + */ + rejectAssignment(callback?: (err: AWSError, data: MTurk.Types.RejectAssignmentResponse) => void): Request; + /** + * The RejectQualificationRequest operation rejects a user's request for a Qualification. You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message. + */ + rejectQualificationRequest(params: MTurk.Types.RejectQualificationRequestRequest, callback?: (err: AWSError, data: MTurk.Types.RejectQualificationRequestResponse) => void): Request; + /** + * The RejectQualificationRequest operation rejects a user's request for a Qualification. You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message. + */ + rejectQualificationRequest(callback?: (err: AWSError, data: MTurk.Types.RejectQualificationRequestResponse) => void): Request; + /** + * The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees. + */ + sendBonus(params: MTurk.Types.SendBonusRequest, callback?: (err: AWSError, data: MTurk.Types.SendBonusResponse) => void): Request; + /** + * The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees. + */ + sendBonus(callback?: (err: AWSError, data: MTurk.Types.SendBonusResponse) => void): Request; + /** + * The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately. + */ + sendTestEventNotification(params: MTurk.Types.SendTestEventNotificationRequest, callback?: (err: AWSError, data: MTurk.Types.SendTestEventNotificationResponse) => void): Request; + /** + * The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately. + */ + sendTestEventNotification(callback?: (err: AWSError, data: MTurk.Types.SendTestEventNotificationResponse) => void): Request; + /** + * The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired. + */ + updateExpirationForHIT(params: MTurk.Types.UpdateExpirationForHITRequest, callback?: (err: AWSError, data: MTurk.Types.UpdateExpirationForHITResponse) => void): Request; + /** + * The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired. + */ + updateExpirationForHIT(callback?: (err: AWSError, data: MTurk.Types.UpdateExpirationForHITResponse) => void): Request; + /** + * The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status. + */ + updateHITReviewStatus(params: MTurk.Types.UpdateHITReviewStatusRequest, callback?: (err: AWSError, data: MTurk.Types.UpdateHITReviewStatusResponse) => void): Request; + /** + * The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status. + */ + updateHITReviewStatus(callback?: (err: AWSError, data: MTurk.Types.UpdateHITReviewStatusResponse) => void): Request; + /** + * The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones. + */ + updateHITTypeOfHIT(params: MTurk.Types.UpdateHITTypeOfHITRequest, callback?: (err: AWSError, data: MTurk.Types.UpdateHITTypeOfHITResponse) => void): Request; + /** + * The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones. + */ + updateHITTypeOfHIT(callback?: (err: AWSError, data: MTurk.Types.UpdateHITTypeOfHITResponse) => void): Request; + /** + * The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to UpdateNotificationSettings. + */ + updateNotificationSettings(params: MTurk.Types.UpdateNotificationSettingsRequest, callback?: (err: AWSError, data: MTurk.Types.UpdateNotificationSettingsResponse) => void): Request; + /** + * The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to UpdateNotificationSettings. + */ + updateNotificationSettings(callback?: (err: AWSError, data: MTurk.Types.UpdateNotificationSettingsResponse) => void): Request; + /** + * The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes. Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries. You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key. If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test. If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values. If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually. You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type. + */ + updateQualificationType(params: MTurk.Types.UpdateQualificationTypeRequest, callback?: (err: AWSError, data: MTurk.Types.UpdateQualificationTypeResponse) => void): Request; + /** + * The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes. Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries. You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key. If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test. If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values. If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually. You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type. + */ + updateQualificationType(callback?: (err: AWSError, data: MTurk.Types.UpdateQualificationTypeResponse) => void): Request; +} +declare namespace MTurk { + export interface AcceptQualificationRequestRequest { + /** + * The ID of the Qualification request, as returned by the GetQualificationRequests operation. + */ + QualificationRequestId: String; + /** + * The value of the Qualification. You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement. + */ + IntegerValue?: Integer; + } + export interface AcceptQualificationRequestResponse { + } + export interface ApproveAssignmentRequest { + /** + * The ID of the assignment. The assignment must correspond to a HIT created by the Requester. + */ + AssignmentId: EntityId; + /** + * A message for the Worker, which the Worker can see in the Status section of the web site. + */ + RequesterFeedback?: String; + /** + * A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to False. + */ + OverrideRejection?: Boolean; + } + export interface ApproveAssignmentResponse { + } + export interface Assignment { + /** + * A unique identifier for the assignment. + */ + AssignmentId?: EntityId; + /** + * The ID of the Worker who accepted the HIT. + */ + WorkerId?: CustomerId; + /** + * The ID of the HIT. + */ + HITId?: EntityId; + /** + * The status of the assignment. + */ + AssignmentStatus?: AssignmentStatus; + /** + * If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester. This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted from the assignment if the Worker has not yet submitted results. + */ + AutoApprovalTime?: Timestamp; + /** + * The date and time the Worker accepted the assignment. + */ + AcceptTime?: Timestamp; + /** + * If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is omitted from the assignment if the Worker has not yet submitted results. + */ + SubmitTime?: Timestamp; + /** + * If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results. This value is omitted from the assignment if the Requester has not yet approved the results. + */ + ApprovalTime?: Timestamp; + /** + * If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results. + */ + RejectionTime?: Timestamp; + /** + * The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT. + */ + Deadline?: Timestamp; + /** + * The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer may be empty. + */ + Answer?: String; + /** + * The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback. + */ + RequesterFeedback?: String; + } + export type AssignmentList = Assignment[]; + export type AssignmentStatus = "Submitted"|"Approved"|"Rejected"|string; + export type AssignmentStatusList = AssignmentStatus[]; + export interface AssociateQualificationWithWorkerRequest { + /** + * The ID of the Qualification type to use for the assigned Qualification. + */ + QualificationTypeId: EntityId; + /** + * The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests. + */ + WorkerId: CustomerId; + /** + * The value of the Qualification to assign. + */ + IntegerValue?: Integer; + /** + * Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker. Note: this is true by default. + */ + SendNotification?: Boolean; + } + export interface AssociateQualificationWithWorkerResponse { + } + export interface BonusPayment { + /** + * The ID of the Worker to whom the bonus was paid. + */ + WorkerId?: CustomerId; + BonusAmount?: CurrencyAmount; + /** + * The ID of the assignment associated with this bonus payment. + */ + AssignmentId?: EntityId; + /** + * The Reason text given when the bonus was granted, if any. + */ + Reason?: String; + /** + * The date and time of when the bonus was granted. + */ + GrantTime?: Timestamp; + } + export type BonusPaymentList = BonusPayment[]; + export type Boolean = boolean; + export type Comparator = "LessThan"|"LessThanOrEqualTo"|"GreaterThan"|"GreaterThanOrEqualTo"|"EqualTo"|"NotEqualTo"|"Exists"|"DoesNotExist"|"In"|"NotIn"|string; + export type CountryParameters = string; + export interface CreateAdditionalAssignmentsForHITRequest { + /** + * The ID of the HIT to extend. + */ + HITId: EntityId; + /** + * The number of additional assignments to request for this HIT. + */ + NumberOfAdditionalAssignments: Integer; + /** + * A unique identifier for this request, which allows you to retry the call on error without extending the HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the extend HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID. + */ + UniqueRequestToken?: IdempotencyToken; + } + export interface CreateAdditionalAssignmentsForHITResponse { + } + export interface CreateHITRequest { + /** + * The number of times the HIT can be accepted and completed before the HIT becomes unavailable. + */ + MaxAssignments?: Integer; + /** + * The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it. + */ + AutoApprovalDelayInSeconds?: Long; + /** + * An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted. + */ + LifetimeInSeconds: Long; + /** + * The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept. + */ + AssignmentDurationInSeconds: Long; + /** + * The amount of money the Requester will pay a Worker for successfully completing the HIT. + */ + Reward: CurrencyAmount; + /** + * The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned. + */ + Title: String; + /** + * One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs. + */ + Keywords?: String; + /** + * A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it. + */ + Description: String; + /** + * The data the person completing the HIT uses to produce the results. Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId parameter must be provided. + */ + Question?: String; + /** + * An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester. The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped. + */ + RequesterAnnotation?: String; + /** + * Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure. + */ + QualificationRequirements?: QualificationRequirementList; + /** + * A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs. + */ + UniqueRequestToken?: IdempotencyToken; + /** + * The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy. + */ + AssignmentReviewPolicy?: ReviewPolicy; + /** + * The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy. + */ + HITReviewPolicy?: ReviewPolicy; + /** + * The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter must be provided. + */ + HITLayoutId?: EntityId; + /** + * If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout. + */ + HITLayoutParameters?: HITLayoutParameterList; + } + export interface CreateHITResponse { + /** + * Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation. + */ + HIT?: HIT; + } + export interface CreateHITTypeRequest { + /** + * The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it. + */ + AutoApprovalDelayInSeconds?: Long; + /** + * The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept. + */ + AssignmentDurationInSeconds: Long; + /** + * The amount of money the Requester will pay a Worker for successfully completing the HIT. + */ + Reward: CurrencyAmount; + /** + * The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned. + */ + Title: String; + /** + * One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs. + */ + Keywords?: String; + /** + * A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it. + */ + Description: String; + /** + * Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure. + */ + QualificationRequirements?: QualificationRequirementList; + } + export interface CreateHITTypeResponse { + /** + * The ID of the newly registered HIT type. + */ + HITTypeId?: EntityId; + } + export interface CreateHITWithHITTypeRequest { + /** + * The HIT type ID you want to create this HIT with. + */ + HITTypeId: EntityId; + /** + * The number of times the HIT can be accepted and completed before the HIT becomes unavailable. + */ + MaxAssignments?: Integer; + /** + * An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted. + */ + LifetimeInSeconds: Long; + /** + * The data the person completing the HIT uses to produce the results. Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId parameter must be provided. + */ + Question?: String; + /** + * An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester. The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped. + */ + RequesterAnnotation?: String; + /** + * A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs. + */ + UniqueRequestToken?: IdempotencyToken; + /** + * The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy. + */ + AssignmentReviewPolicy?: ReviewPolicy; + /** + * The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy. + */ + HITReviewPolicy?: ReviewPolicy; + /** + * The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter must be provided. + */ + HITLayoutId?: EntityId; + /** + * If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout. + */ + HITLayoutParameters?: HITLayoutParameterList; + } + export interface CreateHITWithHITTypeResponse { + /** + * Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation. + */ + HIT?: HIT; + } + export interface CreateQualificationTypeRequest { + /** + * The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types. + */ + Name: String; + /** + * One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search. + */ + Keywords?: String; + /** + * A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type. + */ + Description: String; + /** + * The initial status of the Qualification type. Constraints: Valid values are: Active | Inactive + */ + QualificationTypeStatus: QualificationTypeStatus; + /** + * The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request. Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled. + */ + RetryDelayInSeconds?: Long; + /** + * The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true. Constraints: None. If not specified, the Worker may request the Qualification without answering any questions. + */ + Test?: String; + /** + * The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure. Constraints: Must not be longer than 65535 bytes. Constraints: None. If not specified, you must process Qualification requests manually. + */ + AnswerKey?: String; + /** + * The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. + */ + TestDurationInSeconds?: Long; + /** + * Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Constraints: If the Test parameter is specified, this parameter cannot be true. + */ + AutoGranted?: Boolean; + /** + * The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true. + */ + AutoGrantedValue?: Integer; + } + export interface CreateQualificationTypeResponse { + /** + * The created Qualification type, returned as a QualificationType data structure. + */ + QualificationType?: QualificationType; + } + export interface CreateWorkerBlockRequest { + /** + * The ID of the Worker to block. + */ + WorkerId: CustomerId; + /** + * A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message. + */ + Reason: String; + } + export interface CreateWorkerBlockResponse { + } + export type CurrencyAmount = string; + export type CustomerId = string; + export type CustomerIdList = CustomerId[]; + export interface DeleteHITRequest { + /** + * The ID of the HIT to be deleted. + */ + HITId: EntityId; + } + export interface DeleteHITResponse { + } + export interface DeleteQualificationTypeRequest { + /** + * The ID of the QualificationType to dispose. + */ + QualificationTypeId: EntityId; + } + export interface DeleteQualificationTypeResponse { + } + export interface DeleteWorkerBlockRequest { + /** + * The ID of the Worker to unblock. + */ + WorkerId: CustomerId; + /** + * A message that explains the reason for unblocking the Worker. The Worker does not see this message. + */ + Reason?: String; + } + export interface DeleteWorkerBlockResponse { + } + export interface DisassociateQualificationFromWorkerRequest { + /** + * The ID of the Worker who possesses the Qualification to be revoked. + */ + WorkerId: CustomerId; + /** + * The ID of the Qualification type of the Qualification to be revoked. + */ + QualificationTypeId: EntityId; + /** + * A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message. + */ + Reason?: String; + } + export interface DisassociateQualificationFromWorkerResponse { + } + export type EntityId = string; + export type EventType = "AssignmentAccepted"|"AssignmentAbandoned"|"AssignmentReturned"|"AssignmentSubmitted"|"AssignmentRejected"|"AssignmentApproved"|"HITCreated"|"HITExpired"|"HITReviewable"|"HITExtended"|"HITDisposed"|"Ping"|string; + export type EventTypeList = EventType[]; + export interface GetAccountBalanceRequest { + } + export interface GetAccountBalanceResponse { + AvailableBalance?: CurrencyAmount; + OnHoldBalance?: CurrencyAmount; + } + export interface GetAssignmentRequest { + /** + * The ID of the Assignment to be retrieved. + */ + AssignmentId: EntityId; + } + export interface GetAssignmentResponse { + /** + * The assignment. The response includes one Assignment element. + */ + Assignment?: Assignment; + /** + * The HIT associated with this assignment. The response includes one HIT element. + */ + HIT?: HIT; + } + export interface GetFileUploadURLRequest { + /** + * The ID of the assignment that contains the question with a FileUploadAnswer. + */ + AssignmentId: EntityId; + /** + * The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT. + */ + QuestionIdentifier: String; + } + export interface GetFileUploadURLResponse { + /** + * A temporary URL for the file that the Worker uploaded for the answer. + */ + FileUploadURL?: String; + } + export interface GetHITRequest { + /** + * The ID of the HIT to be retrieved. + */ + HITId: EntityId; + } + export interface GetHITResponse { + /** + * Contains the requested HIT data. + */ + HIT?: HIT; + } + export interface GetQualificationScoreRequest { + /** + * The ID of the QualificationType. + */ + QualificationTypeId: EntityId; + /** + * The ID of the Worker whose Qualification is being updated. + */ + WorkerId: CustomerId; + } + export interface GetQualificationScoreResponse { + /** + * The Qualification data structure of the Qualification assigned to a user, including the Qualification type and the value (score). + */ + Qualification?: Qualification; + } + export interface GetQualificationTypeRequest { + /** + * The ID of the QualificationType. + */ + QualificationTypeId: EntityId; + } + export interface GetQualificationTypeResponse { + /** + * The returned Qualification Type + */ + QualificationType?: QualificationType; + } + export interface HIT { + /** + * A unique identifier for the HIT. + */ + HITId?: EntityId; + /** + * The ID of the HIT type of this HIT + */ + HITTypeId?: EntityId; + /** + * The ID of the HIT Group of this HIT. + */ + HITGroupId?: EntityId; + /** + * The ID of the HIT Layout of this HIT. + */ + HITLayoutId?: EntityId; + /** + * The date and time the HIT was created. + */ + CreationTime?: Timestamp; + /** + * The title of the HIT. + */ + Title?: String; + /** + * A general description of the HIT. + */ + Description?: String; + /** + * The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure. + */ + Question?: String; + /** + * One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results. + */ + Keywords?: String; + /** + * The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed. + */ + HITStatus?: HITStatus; + /** + * The number of times the HIT can be accepted and completed before the HIT becomes unavailable. + */ + MaxAssignments?: Integer; + Reward?: CurrencyAmount; + /** + * The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid. + */ + AutoApprovalDelayInSeconds?: Long; + /** + * The date and time the HIT expires. + */ + Expiration?: Timestamp; + /** + * The length of time, in seconds, that a Worker has to complete the HIT after accepting it. + */ + AssignmentDurationInSeconds?: Long; + /** + * An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT. + */ + RequesterAnnotation?: String; + /** + * Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure. + */ + QualificationRequirements?: QualificationRequirementList; + /** + * Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate. + */ + HITReviewStatus?: HITReviewStatus; + /** + * The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned. + */ + NumberOfAssignmentsPending?: Integer; + /** + * The number of assignments for this HIT that are available for Workers to accept. + */ + NumberOfAssignmentsAvailable?: Integer; + /** + * The number of assignments for this HIT that have been approved or rejected. + */ + NumberOfAssignmentsCompleted?: Integer; + } + export type HITAccessActions = "Accept"|"PreviewAndAccept"|"DiscoverPreviewAndAccept"|string; + export interface HITLayoutParameter { + /** + * The name of the parameter in the HITLayout. + */ + Name: String; + /** + * The value substituted for the parameter referenced in the HITLayout. + */ + Value: String; + } + export type HITLayoutParameterList = HITLayoutParameter[]; + export type HITList = HIT[]; + export type HITReviewStatus = "NotReviewed"|"MarkedForReview"|"ReviewedAppropriate"|"ReviewedInappropriate"|string; + export type HITStatus = "Assignable"|"Unassignable"|"Reviewable"|"Reviewing"|"Disposed"|string; + export type IdempotencyToken = string; + export type Integer = number; + export type IntegerList = Integer[]; + export interface ListAssignmentsForHITRequest { + /** + * The ID of the HIT. + */ + HITId: EntityId; + /** + * Pagination token + */ + NextToken?: PaginationToken; + MaxResults?: ResultSize; + /** + * The status of the assignments to return: Submitted | Approved | Rejected + */ + AssignmentStatuses?: AssignmentStatusList; + } + export interface ListAssignmentsForHITResponse { + NextToken?: PaginationToken; + /** + * The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call. + */ + NumResults?: Integer; + /** + * The collection of Assignment data structures returned by this call. + */ + Assignments?: AssignmentList; + } + export interface ListBonusPaymentsRequest { + /** + * The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified + */ + HITId?: EntityId; + /** + * The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified + */ + AssignmentId?: EntityId; + /** + * Pagination token + */ + NextToken?: PaginationToken; + MaxResults?: ResultSize; + } + export interface ListBonusPaymentsResponse { + /** + * The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call. + */ + NumResults?: Integer; + NextToken?: PaginationToken; + /** + * A successful request to the ListBonusPayments operation returns a list of BonusPayment objects. + */ + BonusPayments?: BonusPaymentList; + } + export interface ListHITsForQualificationTypeRequest { + /** + * The ID of the Qualification type to use when querying HITs. + */ + QualificationTypeId: EntityId; + /** + * Pagination Token + */ + NextToken?: PaginationToken; + /** + * Limit the number of results returned. + */ + MaxResults?: ResultSize; + } + export interface ListHITsForQualificationTypeResponse { + NextToken?: PaginationToken; + /** + * The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call. + */ + NumResults?: Integer; + /** + * The list of HIT elements returned by the query. + */ + HITs?: HITList; + } + export interface ListHITsRequest { + /** + * Pagination token + */ + NextToken?: PaginationToken; + MaxResults?: ResultSize; + } + export interface ListHITsResponse { + NextToken?: PaginationToken; + /** + * The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call. + */ + NumResults?: Integer; + /** + * The list of HIT elements returned by the query. + */ + HITs?: HITList; + } + export interface ListQualificationRequestsRequest { + /** + * The ID of the QualificationType. + */ + QualificationTypeId?: EntityId; + NextToken?: PaginationToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: ResultSize; + } + export interface ListQualificationRequestsResponse { + /** + * The number of Qualification requests on this page in the filtered results list, equivalent to the number of Qualification requests being returned by this call. + */ + NumResults?: Integer; + NextToken?: PaginationToken; + /** + * The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query. + */ + QualificationRequests?: QualificationRequestList; + } + export interface ListQualificationTypesRequest { + /** + * A text query against all of the searchable attributes of Qualification types. + */ + Query?: String; + /** + * Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False. + */ + MustBeRequestable: Boolean; + /** + * Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types. + */ + MustBeOwnedByCaller?: Boolean; + NextToken?: PaginationToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: ResultSize; + } + export interface ListQualificationTypesResponse { + /** + * The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns. + */ + NumResults?: Integer; + NextToken?: PaginationToken; + /** + * The list of QualificationType elements returned by the query. + */ + QualificationTypes?: QualificationTypeList; + } + export interface ListReviewPolicyResultsForHITRequest { + /** + * The unique identifier of the HIT to retrieve review results for. + */ + HITId: EntityId; + /** + * The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies. + */ + PolicyLevels?: ReviewPolicyLevelList; + /** + * Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes. + */ + RetrieveActions?: Boolean; + /** + * Specify if the operation should retrieve a list of the results computed by the Review Policies. + */ + RetrieveResults?: Boolean; + /** + * Pagination token + */ + NextToken?: PaginationToken; + /** + * Limit the number of results returned. + */ + MaxResults?: ResultSize; + } + export interface ListReviewPolicyResultsForHITResponse { + /** + * The HITId of the HIT for which results have been returned. + */ + HITId?: EntityId; + /** + * The name of the Assignment-level Review Policy. This contains only the PolicyName element. + */ + AssignmentReviewPolicy?: ReviewPolicy; + /** + * The name of the HIT-level Review Policy. This contains only the PolicyName element. + */ + HITReviewPolicy?: ReviewPolicy; + /** + * Contains both ReviewResult and ReviewAction elements for an Assignment. + */ + AssignmentReviewReport?: ReviewReport; + /** + * Contains both ReviewResult and ReviewAction elements for a particular HIT. + */ + HITReviewReport?: ReviewReport; + NextToken?: PaginationToken; + } + export interface ListReviewableHITsRequest { + /** + * The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered + */ + HITTypeId?: EntityId; + /** + * Can be either Reviewable or Reviewing. Reviewable is the default value. + */ + Status?: ReviewableHITStatus; + /** + * Pagination Token + */ + NextToken?: PaginationToken; + /** + * Limit the number of results returned. + */ + MaxResults?: ResultSize; + } + export interface ListReviewableHITsResponse { + NextToken?: PaginationToken; + /** + * The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call. + */ + NumResults?: Integer; + /** + * The list of HIT elements returned by the query. + */ + HITs?: HITList; + } + export interface ListWorkerBlocksRequest { + /** + * Pagination token + */ + NextToken?: PaginationToken; + MaxResults?: ResultSize; + } + export interface ListWorkerBlocksResponse { + NextToken?: PaginationToken; + /** + * The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call. + */ + NumResults?: Integer; + /** + * The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking. + */ + WorkerBlocks?: WorkerBlockList; + } + export interface ListWorkersWithQualificationTypeRequest { + /** + * The ID of the Qualification type of the Qualifications to return. + */ + QualificationTypeId: EntityId; + /** + * The status of the Qualifications to return. Can be Granted | Revoked. + */ + Status?: QualificationStatus; + /** + * Pagination Token + */ + NextToken?: PaginationToken; + /** + * Limit the number of results returned. + */ + MaxResults?: ResultSize; + } + export interface ListWorkersWithQualificationTypeResponse { + NextToken?: PaginationToken; + /** + * The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call. + */ + NumResults?: Integer; + /** + * The list of Qualification elements returned by this call. + */ + Qualifications?: QualificationList; + } + export interface Locale { + /** + * The country of the locale. Must be a valid ISO 3166 country code. For example, the code US refers to the United States of America. + */ + Country: CountryParameters; + /** + * The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For example, the code WA refers to the state of Washington. + */ + Subdivision?: CountryParameters; + } + export type LocaleList = Locale[]; + export type Long = number; + export interface NotificationSpecification { + /** + * The target for notification messages. The Destination’s format is determined by the specified Transport: When Transport is Email, the Destination is your email address. When Transport is SQS, the Destination is your queue URL. When Transport is SNS, the Destination is the ARN of your topic. + */ + Destination: String; + /** + * The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS. + */ + Transport: NotificationTransport; + /** + * The version of the Notification API to use. Valid value is 2006-05-05. + */ + Version: String; + /** + * The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation. + */ + EventTypes: EventTypeList; + } + export type NotificationTransport = "Email"|"SQS"|"SNS"|string; + export type NotifyWorkersFailureCode = "SoftFailure"|"HardFailure"|string; + export interface NotifyWorkersFailureStatus { + /** + * Encoded value for the failure type. + */ + NotifyWorkersFailureCode?: NotifyWorkersFailureCode; + /** + * A message detailing the reason the Worker could not be notified. + */ + NotifyWorkersFailureMessage?: String; + /** + * The ID of the Worker. + */ + WorkerId?: CustomerId; + } + export type NotifyWorkersFailureStatusList = NotifyWorkersFailureStatus[]; + export interface NotifyWorkersRequest { + /** + * The subject line of the email message to send. Can include up to 200 characters. + */ + Subject: String; + /** + * The text of the email message to send. Can include up to 4,096 characters + */ + MessageText: String; + /** + * A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time. + */ + WorkerIds: CustomerIdList; + } + export interface NotifyWorkersResponse { + /** + * When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects. + */ + NotifyWorkersFailureStatuses?: NotifyWorkersFailureStatusList; + } + export type PaginationToken = string; + export interface ParameterMapEntry { + /** + * The QuestionID from the HIT that is used to identify which question requires Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review Policy. + */ + Key?: String; + /** + * The list of answers to the question specified in the MapEntry Key element. The Worker must match all values in order for the answer to be scored correctly. + */ + Values?: StringList; + } + export type ParameterMapEntryList = ParameterMapEntry[]; + export interface PolicyParameter { + /** + * Name of the parameter from the list of Review Polices. + */ + Key?: String; + /** + * The list of values of the Parameter + */ + Values?: StringList; + /** + * List of ParameterMapEntry objects. + */ + MapEntries?: ParameterMapEntryList; + } + export type PolicyParameterList = PolicyParameter[]; + export interface Qualification { + /** + * The ID of the Qualification type for the Qualification. + */ + QualificationTypeId?: EntityId; + /** + * The ID of the Worker who possesses the Qualification. + */ + WorkerId?: CustomerId; + /** + * The date and time the Qualification was granted to the Worker. If the Worker's Qualification was revoked, and then re-granted based on a new Qualification request, GrantTime is the date and time of the last call to the AcceptQualificationRequest operation. + */ + GrantTime?: Timestamp; + /** + * The value (score) of the Qualification, if the Qualification has an integer value. + */ + IntegerValue?: Integer; + LocaleValue?: Locale; + /** + * The status of the Qualification. Valid values are Granted | Revoked. + */ + Status?: QualificationStatus; + } + export type QualificationList = Qualification[]; + export interface QualificationRequest { + /** + * The ID of the Qualification request, a unique identifier generated when the request was submitted. + */ + QualificationRequestId?: String; + /** + * The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation. + */ + QualificationTypeId?: EntityId; + /** + * The ID of the Worker requesting the Qualification. + */ + WorkerId?: CustomerId; + /** + * The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the time the Worker requests the Qualification. + */ + Test?: String; + /** + * The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty. + */ + Answer?: String; + /** + * The date and time the Qualification request had a status of Submitted. This is either the time the Worker submitted answers for a Qualification test, or the time the Worker requested the Qualification if the Qualification type does not have a test. + */ + SubmitTime?: Timestamp; + } + export type QualificationRequestList = QualificationRequest[]; + export interface QualificationRequirement { + /** + * The ID of the Qualification type for the requirement. + */ + QualificationTypeId: String; + /** + * The kind of comparison to make against a Qualification's value. You can compare a Qualification's value to an IntegerValue to see if it is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement can also test if a Qualification Exists or DoesNotExist in the user's profile, regardless of its value. + */ + Comparator: Comparator; + /** + * The integer value to compare against the Qualification's value. IntegerValue must not be present if Comparator is Exists or DoesNotExist. IntegerValue can only be used if the Qualification type has an integer value; it cannot be used with the Worker_Locale QualificationType ID. When performing a set comparison by using the In or the NotIn comparator, you can use up to 15 IntegerValue elements in a QualificationRequirement data structure. + */ + IntegerValues?: IntegerList; + /** + * The locale value to compare against the Qualification's value. The local value must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale QualificationType ID. LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use a single LocaleValue element when using the EqualTo or NotEqualTo comparators. When performing a set comparison by using the In or the NotIn comparator, you can use up to 30 LocaleValue elements in a QualificationRequirement data structure. + */ + LocaleValues?: LocaleList; + /** + * DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, the question data for the HIT will not be shown when a Worker whose Qualifications do not meet this requirement tries to preview the HIT. That is, a Worker's Qualifications must meet all of the requirements for which RequiredToPreview is true in order to preview the HIT. If a Worker meets all of the requirements where RequiredToPreview is true (or if there are no such requirements), but does not meet all of the requirements for the HIT, the Worker will be allowed to preview the HIT's question data, but will not be allowed to accept and complete the HIT. The default is false. This should not be used in combination with the ActionsGuarded field. + */ + RequiredToPreview?: Boolean; + /** + * Setting this attribute prevents Workers whose Qualifications do not meet this QualificationRequirement from taking the specified action. Valid arguments include "Accept" (Worker cannot accept the HIT, but can preview the HIT and see it in their search results), "PreviewAndAccept" (Worker cannot accept or preview the HIT, but can see the HIT in their search results), and "DiscoverPreviewAndAccept" (Worker cannot accept, preview, or see the HIT in their search results). It's possible for you to create a HIT with multiple QualificationRequirements (which can have different values for the ActionGuarded attribute). In this case, the Worker is only permitted to perform an action when they have met all QualificationRequirements guarding the action. The actions in the order of least restrictive to most restrictive are Discover, Preview and Accept. For example, if a Worker meets all QualificationRequirements that are set to DiscoverPreviewAndAccept, but do not meet all requirements that are set with PreviewAndAccept, then the Worker will be able to Discover, i.e. see the HIT in their search result, but will not be able to Preview or Accept the HIT. ActionsGuarded should not be used in combination with the RequiredToPreview field. + */ + ActionsGuarded?: HITAccessActions; + } + export type QualificationRequirementList = QualificationRequirement[]; + export type QualificationStatus = "Granted"|"Revoked"|string; + export interface QualificationType { + /** + * A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation. + */ + QualificationTypeId?: EntityId; + /** + * The date and time the Qualification type was created. + */ + CreationTime?: Timestamp; + /** + * The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search. + */ + Name?: String; + /** + * A long description for the Qualification type. + */ + Description?: String; + /** + * One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search. + */ + Keywords?: String; + /** + * The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive. + */ + QualificationTypeStatus?: QualificationTypeStatus; + /** + * The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true. + */ + Test?: String; + /** + * The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification. + */ + TestDurationInSeconds?: Long; + /** + * The answers to the Qualification test specified in the Test parameter. + */ + AnswerKey?: String; + /** + * The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once. + */ + RetryDelayInSeconds?: Long; + /** + * Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False. + */ + IsRequestable?: Boolean; + /** + * Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False. + */ + AutoGranted?: Boolean; + /** + * The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default. + */ + AutoGrantedValue?: Integer; + } + export type QualificationTypeList = QualificationType[]; + export type QualificationTypeStatus = "Active"|"Inactive"|string; + export interface RejectAssignmentRequest { + /** + * The ID of the assignment. The assignment must correspond to a HIT created by the Requester. + */ + AssignmentId: EntityId; + /** + * A message for the Worker, which the Worker can see in the Status section of the web site. + */ + RequesterFeedback: String; + } + export interface RejectAssignmentResponse { + } + export interface RejectQualificationRequestRequest { + /** + * The ID of the Qualification request, as returned by the ListQualificationRequests operation. + */ + QualificationRequestId: String; + /** + * A text message explaining why the request was rejected, to be shown to the Worker who made the request. + */ + Reason?: String; + } + export interface RejectQualificationRequestResponse { + } + export type ResultSize = number; + export interface ReviewActionDetail { + /** + * The unique identifier for the action. + */ + ActionId?: EntityId; + /** + * The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary. + */ + ActionName?: String; + /** + * The specific HITId or AssignmentID targeted by the action. + */ + TargetId?: EntityId; + /** + * The type of object in TargetId. + */ + TargetType?: String; + /** + * The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED. + */ + Status?: ReviewActionStatus; + /** + * The date when the action was completed. + */ + CompleteTime?: Timestamp; + /** + * A description of the outcome of the review. + */ + Result?: String; + /** + * Present only when the Results have a FAILED Status. + */ + ErrorCode?: String; + } + export type ReviewActionDetailList = ReviewActionDetail[]; + export type ReviewActionStatus = "Intended"|"Succeeded"|"Failed"|"Cancelled"|string; + export interface ReviewPolicy { + /** + * Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 + */ + PolicyName: String; + /** + * Name of the parameter from the Review policy. + */ + Parameters?: PolicyParameterList; + } + export type ReviewPolicyLevel = "Assignment"|"HIT"|string; + export type ReviewPolicyLevelList = ReviewPolicyLevel[]; + export interface ReviewReport { + /** + * A list of ReviewResults objects for each action specified in the Review Policy. + */ + ReviewResults?: ReviewResultDetailList; + /** + * A list of ReviewAction objects for each action specified in the Review Policy. + */ + ReviewActions?: ReviewActionDetailList; + } + export interface ReviewResultDetail { + /** + * A unique identifier of the Review action result. + */ + ActionId?: EntityId; + /** + * The HITID or AssignmentId about which this result was taken. Note that HIT-level Review Policies will often emit results about both the HIT itself and its Assignments, while Assignment-level review policies generally only emit results about the Assignment itself. + */ + SubjectId?: EntityId; + /** + * The type of the object from the SubjectId field. + */ + SubjectType?: String; + /** + * Specifies the QuestionId the result is describing. Depending on whether the TargetType is a HIT or Assignment this results could specify multiple values. If TargetType is HIT and QuestionId is absent, then the result describes results of the HIT, including the HIT agreement score. If ObjectType is Assignment and QuestionId is absent, then the result describes the Worker's performance on the HIT. + */ + QuestionId?: EntityId; + /** + * Key identifies the particular piece of reviewed information. + */ + Key?: String; + /** + * The values of Key provided by the review policies you have selected. + */ + Value?: String; + } + export type ReviewResultDetailList = ReviewResultDetail[]; + export type ReviewableHITStatus = "Reviewable"|"Reviewing"|string; + export interface SendBonusRequest { + /** + * The ID of the Worker being paid the bonus. + */ + WorkerId: CustomerId; + /** + * The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes. + */ + BonusAmount: CurrencyAmount; + /** + * The ID of the assignment for which this bonus is paid. + */ + AssignmentId: EntityId; + /** + * A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message. + */ + Reason: String; + /** + * A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID. + */ + UniqueRequestToken?: IdempotencyToken; + } + export interface SendBonusResponse { + } + export interface SendTestEventNotificationRequest { + /** + * The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type. + */ + Notification: NotificationSpecification; + /** + * The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event. + */ + TestEventType: EventType; + } + export interface SendTestEventNotificationResponse { + } + export type String = string; + export type StringList = String[]; + export type Timestamp = Date; + export interface UpdateExpirationForHITRequest { + /** + * The HIT to update. + */ + HITId: EntityId; + /** + * The date and time at which you want the HIT to expire + */ + ExpireAt: Timestamp; + } + export interface UpdateExpirationForHITResponse { + } + export interface UpdateHITReviewStatusRequest { + /** + * The ID of the HIT to update. + */ + HITId: EntityId; + /** + * Specifies how to update the HIT status. Default is False. Setting this to false will only transition a HIT from Reviewable to Reviewing Setting this to true will only transition a HIT from Reviewing to Reviewable + */ + Revert?: Boolean; + } + export interface UpdateHITReviewStatusResponse { + } + export interface UpdateHITTypeOfHITRequest { + /** + * The HIT to update. + */ + HITId: EntityId; + /** + * The ID of the new HIT type. + */ + HITTypeId: EntityId; + } + export interface UpdateHITTypeOfHITResponse { + } + export interface UpdateNotificationSettingsRequest { + /** + * The ID of the HIT type whose notification specification is being updated. + */ + HITTypeId: EntityId; + /** + * The notification specification for the HIT type. + */ + Notification?: NotificationSpecification; + /** + * Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed. + */ + Active?: Boolean; + } + export interface UpdateNotificationSettingsResponse { + } + export interface UpdateQualificationTypeRequest { + /** + * The ID of the Qualification type to update. + */ + QualificationTypeId: EntityId; + /** + * The new description of the Qualification type. + */ + Description?: String; + /** + * The new status of the Qualification type - Active | Inactive + */ + QualificationTypeStatus?: QualificationTypeStatus; + /** + * The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true. Constraints: None. If not specified, the Worker may request the Qualification without answering any questions. + */ + Test?: String; + /** + * The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure. + */ + AnswerKey?: String; + /** + * The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. + */ + TestDurationInSeconds?: Long; + /** + * The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType. + */ + RetryDelayInSeconds?: Long; + /** + * Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Constraints: If the Test parameter is specified, this parameter cannot be true. + */ + AutoGranted?: Boolean; + /** + * The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true. + */ + AutoGrantedValue?: Integer; + } + export interface UpdateQualificationTypeResponse { + /** + * Contains a QualificationType data structure. + */ + QualificationType?: QualificationType; + } + export interface WorkerBlock { + /** + * The ID of the Worker who accepted the HIT. + */ + WorkerId?: CustomerId; + /** + * A message explaining the reason the Worker was blocked. + */ + Reason?: String; + } + export type WorkerBlockList = WorkerBlock[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-01-17"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the MTurk client. + */ + export import Types = MTurk; +} +export = MTurk; diff --git a/node_modules/aws-sdk/clients/mturk.js b/node_modules/aws-sdk/clients/mturk.js new file mode 100644 index 0000000..814c5ec --- /dev/null +++ b/node_modules/aws-sdk/clients/mturk.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['mturk'] = {}; +AWS.MTurk = Service.defineService('mturk', ['2017-01-17']); +Object.defineProperty(apiLoader.services['mturk'], '2017-01-17', { + get: function get() { + var model = require('../apis/mturk-requester-2017-01-17.min.json'); + model.paginators = require('../apis/mturk-requester-2017-01-17.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.MTurk; diff --git a/node_modules/aws-sdk/clients/neptune.d.ts b/node_modules/aws-sdk/clients/neptune.d.ts new file mode 100644 index 0000000..0e3993b --- /dev/null +++ b/node_modules/aws-sdk/clients/neptune.d.ts @@ -0,0 +1,3333 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Neptune extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Neptune.Types.ClientConfiguration) + config: Config & Neptune.Types.ClientConfiguration; + /** + * Associates an Identity and Access Management (IAM) role from an Neptune DB cluster. + */ + addRoleToDBCluster(params: Neptune.Types.AddRoleToDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an Identity and Access Management (IAM) role from an Neptune DB cluster. + */ + addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds a source identifier to an existing event notification subscription. + */ + addSourceIdentifierToSubscription(params: Neptune.Types.AddSourceIdentifierToSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.AddSourceIdentifierToSubscriptionResult) => void): Request; + /** + * Adds a source identifier to an existing event notification subscription. + */ + addSourceIdentifierToSubscription(callback?: (err: AWSError, data: Neptune.Types.AddSourceIdentifierToSubscriptionResult) => void): Request; + /** + * Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune. + */ + addTagsToResource(params: Neptune.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune. + */ + addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Applies a pending maintenance action to a resource (for example, to a DB instance). + */ + applyPendingMaintenanceAction(params: Neptune.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: Neptune.Types.ApplyPendingMaintenanceActionResult) => void): Request; + /** + * Applies a pending maintenance action to a resource (for example, to a DB instance). + */ + applyPendingMaintenanceAction(callback?: (err: AWSError, data: Neptune.Types.ApplyPendingMaintenanceActionResult) => void): Request; + /** + * Copies the specified DB cluster parameter group. + */ + copyDBClusterParameterGroup(params: Neptune.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterParameterGroupResult) => void): Request; + /** + * Copies the specified DB cluster parameter group. + */ + copyDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterParameterGroupResult) => void): Request; + /** + * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can't copy from one AWS Region to another. + */ + copyDBClusterSnapshot(params: Neptune.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterSnapshotResult) => void): Request; + /** + * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can't copy from one AWS Region to another. + */ + copyDBClusterSnapshot(callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterSnapshotResult) => void): Request; + /** + * Copies the specified DB parameter group. + */ + copyDBParameterGroup(params: Neptune.Types.CopyDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CopyDBParameterGroupResult) => void): Request; + /** + * Copies the specified DB parameter group. + */ + copyDBParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CopyDBParameterGroupResult) => void): Request; + /** + * Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance. + */ + createDBCluster(params: Neptune.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterResult) => void): Request; + /** + * Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance. + */ + createDBCluster(callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterResult) => void): Request; + /** + * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. + */ + createDBClusterParameterGroup(params: Neptune.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterParameterGroupResult) => void): Request; + /** + * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. + */ + createDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterParameterGroupResult) => void): Request; + /** + * Creates a snapshot of a DB cluster. + */ + createDBClusterSnapshot(params: Neptune.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterSnapshotResult) => void): Request; + /** + * Creates a snapshot of a DB cluster. + */ + createDBClusterSnapshot(callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterSnapshotResult) => void): Request; + /** + * Creates a new DB instance. + */ + createDBInstance(params: Neptune.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBInstanceResult) => void): Request; + /** + * Creates a new DB instance. + */ + createDBInstance(callback?: (err: AWSError, data: Neptune.Types.CreateDBInstanceResult) => void): Request; + /** + * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + createDBParameterGroup(params: Neptune.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBParameterGroupResult) => void): Request; + /** + * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + createDBParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CreateDBParameterGroupResult) => void): Request; + /** + * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + createDBSubnetGroup(params: Neptune.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBSubnetGroupResult) => void): Request; + /** + * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + createDBSubnetGroup(callback?: (err: AWSError, data: Neptune.Types.CreateDBSubnetGroupResult) => void): Request; + /** + * Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account. + */ + createEventSubscription(params: Neptune.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.CreateEventSubscriptionResult) => void): Request; + /** + * Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account. + */ + createEventSubscription(callback?: (err: AWSError, data: Neptune.Types.CreateEventSubscriptionResult) => void): Request; + /** + * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. + */ + deleteDBCluster(params: Neptune.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterResult) => void): Request; + /** + * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. + */ + deleteDBCluster(callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterResult) => void): Request; + /** + * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. + */ + deleteDBClusterParameterGroup(params: Neptune.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. + */ + deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. + */ + deleteDBClusterSnapshot(params: Neptune.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterSnapshotResult) => void): Request; + /** + * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. + */ + deleteDBClusterSnapshot(callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterSnapshotResult) => void): Request; + /** + * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true: The DB instance is the only instance in the DB cluster. + */ + deleteDBInstance(params: Neptune.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteDBInstanceResult) => void): Request; + /** + * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true: The DB instance is the only instance in the DB cluster. + */ + deleteDBInstance(callback?: (err: AWSError, data: Neptune.Types.DeleteDBInstanceResult) => void): Request; + /** + * Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances. + */ + deleteDBParameterGroup(params: Neptune.Types.DeleteDBParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances. + */ + deleteDBParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. + */ + deleteDBSubnetGroup(params: Neptune.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. + */ + deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an event notification subscription. + */ + deleteEventSubscription(params: Neptune.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteEventSubscriptionResult) => void): Request; + /** + * Deletes an event notification subscription. + */ + deleteEventSubscription(callback?: (err: AWSError, data: Neptune.Types.DeleteEventSubscriptionResult) => void): Request; + /** + * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. + */ + describeDBClusterParameterGroups(params: Neptune.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupsMessage) => void): Request; + /** + * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. + */ + describeDBClusterParameterGroups(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupsMessage) => void): Request; + /** + * Returns the detailed parameter list for a particular DB cluster parameter group. + */ + describeDBClusterParameters(params: Neptune.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupDetails) => void): Request; + /** + * Returns the detailed parameter list for a particular DB cluster parameter group. + */ + describeDBClusterParameters(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupDetails) => void): Request; + /** + * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. + */ + describeDBClusterSnapshotAttributes(params: Neptune.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request; + /** + * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. + */ + describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: Neptune.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request; + /** + * Returns information about DB cluster snapshots. This API action supports pagination. + */ + describeDBClusterSnapshots(params: Neptune.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterSnapshotMessage) => void): Request; + /** + * Returns information about DB cluster snapshots. This API action supports pagination. + */ + describeDBClusterSnapshots(callback?: (err: AWSError, data: Neptune.Types.DBClusterSnapshotMessage) => void): Request; + /** + * Returns information about provisioned DB clusters. This API supports pagination. + */ + describeDBClusters(params: Neptune.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterMessage) => void): Request; + /** + * Returns information about provisioned DB clusters. This API supports pagination. + */ + describeDBClusters(callback?: (err: AWSError, data: Neptune.Types.DBClusterMessage) => void): Request; + /** + * Returns a list of the available DB engines. + */ + describeDBEngineVersions(params: Neptune.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: Neptune.Types.DBEngineVersionMessage) => void): Request; + /** + * Returns a list of the available DB engines. + */ + describeDBEngineVersions(callback?: (err: AWSError, data: Neptune.Types.DBEngineVersionMessage) => void): Request; + /** + * Returns information about provisioned instances. This API supports pagination. + */ + describeDBInstances(params: Neptune.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request; + /** + * Returns information about provisioned instances. This API supports pagination. + */ + describeDBInstances(callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request; + /** + * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group. + */ + describeDBParameterGroups(params: Neptune.Types.DescribeDBParameterGroupsMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupsMessage) => void): Request; + /** + * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group. + */ + describeDBParameterGroups(callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupsMessage) => void): Request; + /** + * Returns the detailed parameter list for a particular DB parameter group. + */ + describeDBParameters(params: Neptune.Types.DescribeDBParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupDetails) => void): Request; + /** + * Returns the detailed parameter list for a particular DB parameter group. + */ + describeDBParameters(callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupDetails) => void): Request; + /** + * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. + */ + describeDBSubnetGroups(params: Neptune.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: Neptune.Types.DBSubnetGroupMessage) => void): Request; + /** + * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. + */ + describeDBSubnetGroups(callback?: (err: AWSError, data: Neptune.Types.DBSubnetGroupMessage) => void): Request; + /** + * Returns the default engine and system parameter information for the cluster database engine. + */ + describeEngineDefaultClusterParameters(params: Neptune.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultClusterParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the cluster database engine. + */ + describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultClusterParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the specified database engine. + */ + describeEngineDefaultParameters(params: Neptune.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the specified database engine. + */ + describeEngineDefaultParameters(callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultParametersResult) => void): Request; + /** + * Displays a list of categories for all event source types, or, if specified, for a specified source type. + */ + describeEventCategories(params: Neptune.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: Neptune.Types.EventCategoriesMessage) => void): Request; + /** + * Displays a list of categories for all event source types, or, if specified, for a specified source type. + */ + describeEventCategories(callback?: (err: AWSError, data: Neptune.Types.EventCategoriesMessage) => void): Request; + /** + * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. + */ + describeEventSubscriptions(params: Neptune.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: Neptune.Types.EventSubscriptionsMessage) => void): Request; + /** + * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. + */ + describeEventSubscriptions(callback?: (err: AWSError, data: Neptune.Types.EventSubscriptionsMessage) => void): Request; + /** + * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. + */ + describeEvents(params: Neptune.Types.DescribeEventsMessage, callback?: (err: AWSError, data: Neptune.Types.EventsMessage) => void): Request; + /** + * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. + */ + describeEvents(callback?: (err: AWSError, data: Neptune.Types.EventsMessage) => void): Request; + /** + * Returns a list of orderable DB instance options for the specified engine. + */ + describeOrderableDBInstanceOptions(params: Neptune.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: Neptune.Types.OrderableDBInstanceOptionsMessage) => void): Request; + /** + * Returns a list of orderable DB instance options for the specified engine. + */ + describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: Neptune.Types.OrderableDBInstanceOptionsMessage) => void): Request; + /** + * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. + */ + describePendingMaintenanceActions(params: Neptune.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: Neptune.Types.PendingMaintenanceActionsMessage) => void): Request; + /** + * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. + */ + describePendingMaintenanceActions(callback?: (err: AWSError, data: Neptune.Types.PendingMaintenanceActionsMessage) => void): Request; + /** + * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. + */ + describeValidDBInstanceModifications(params: Neptune.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeValidDBInstanceModificationsResult) => void): Request; + /** + * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. + */ + describeValidDBInstanceModifications(callback?: (err: AWSError, data: Neptune.Types.DescribeValidDBInstanceModificationsResult) => void): Request; + /** + * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. + */ + failoverDBCluster(params: Neptune.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.FailoverDBClusterResult) => void): Request; + /** + * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. + */ + failoverDBCluster(callback?: (err: AWSError, data: Neptune.Types.FailoverDBClusterResult) => void): Request; + /** + * Lists all tags on an Amazon Neptune resource. + */ + listTagsForResource(params: Neptune.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: Neptune.Types.TagListMessage) => void): Request; + /** + * Lists all tags on an Amazon Neptune resource. + */ + listTagsForResource(callback?: (err: AWSError, data: Neptune.Types.TagListMessage) => void): Request; + /** + * Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. + */ + modifyDBCluster(params: Neptune.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterResult) => void): Request; + /** + * Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. + */ + modifyDBCluster(callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterResult) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. + */ + modifyDBClusterParameterGroup(params: Neptune.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. + */ + modifyDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action. + */ + modifyDBClusterSnapshotAttribute(params: Neptune.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action. + */ + modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request; + /** + * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance. + */ + modifyDBInstance(params: Neptune.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBInstanceResult) => void): Request; + /** + * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance. + */ + modifyDBInstance(callback?: (err: AWSError, data: Neptune.Types.ModifyDBInstanceResult) => void): Request; + /** + * Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + modifyDBParameterGroup(params: Neptune.Types.ModifyDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + modifyDBParameterGroup(callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + modifyDBSubnetGroup(params: Neptune.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBSubnetGroupResult) => void): Request; + /** + * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + modifyDBSubnetGroup(callback?: (err: AWSError, data: Neptune.Types.ModifyDBSubnetGroupResult) => void): Request; + /** + * Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action. + */ + modifyEventSubscription(params: Neptune.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyEventSubscriptionResult) => void): Request; + /** + * Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action. + */ + modifyEventSubscription(callback?: (err: AWSError, data: Neptune.Types.ModifyEventSubscriptionResult) => void): Request; + /** + * Not supported. + */ + promoteReadReplicaDBCluster(params: Neptune.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.PromoteReadReplicaDBClusterResult) => void): Request; + /** + * Not supported. + */ + promoteReadReplicaDBCluster(callback?: (err: AWSError, data: Neptune.Types.PromoteReadReplicaDBClusterResult) => void): Request; + /** + * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. + */ + rebootDBInstance(params: Neptune.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.RebootDBInstanceResult) => void): Request; + /** + * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. + */ + rebootDBInstance(callback?: (err: AWSError, data: Neptune.Types.RebootDBInstanceResult) => void): Request; + /** + * Disassociates an Identity and Access Management (IAM) role from a DB cluster. + */ + removeRoleFromDBCluster(params: Neptune.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates an Identity and Access Management (IAM) role from a DB cluster. + */ + removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a source identifier from an existing event notification subscription. + */ + removeSourceIdentifierFromSubscription(params: Neptune.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request; + /** + * Removes a source identifier from an existing event notification subscription. + */ + removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: Neptune.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request; + /** + * Removes metadata tags from an Amazon Neptune resource. + */ + removeTagsFromResource(params: Neptune.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes metadata tags from an Amazon Neptune resource. + */ + removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. + */ + resetDBClusterParameterGroup(params: Neptune.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. + */ + resetDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. + */ + resetDBParameterGroup(params: Neptune.Types.ResetDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. + */ + resetDBParameterGroup(callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + */ + restoreDBClusterFromSnapshot(params: Neptune.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterFromSnapshotResult) => void): Request; + /** + * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + */ + restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterFromSnapshotResult) => void): Request; + /** + * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. + */ + restoreDBClusterToPointInTime(params: Neptune.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterToPointInTimeResult) => void): Request; + /** + * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. + */ + restoreDBClusterToPointInTime(callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterToPointInTimeResult) => void): Request; + /** + * Waits for the dBInstanceAvailable state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceAvailable", params: Neptune.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceAvailable state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceDeleted state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceDeleted", params: Neptune.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceDeleted state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request; +} +declare namespace Neptune { + export interface AddRoleToDBClusterMessage { + /** + * The name of the DB cluster to associate the IAM role with. + */ + DBClusterIdentifier: String; + /** + * The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole. + */ + RoleArn: String; + } + export interface AddSourceIdentifierToSubscriptionMessage { + /** + * The name of the event notification subscription you want to add a source identifier to. + */ + SubscriptionName: String; + /** + * The identifier of the event source to be added. Constraints: If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied. + */ + SourceIdentifier: String; + } + export interface AddSourceIdentifierToSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface AddTagsToResourceMessage { + /** + * The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). + */ + ResourceName: String; + /** + * The tags to be assigned to the Amazon Neptune resource. + */ + Tags: TagList; + } + export type ApplyMethod = "immediate"|"pending-reboot"|string; + export interface ApplyPendingMaintenanceActionMessage { + /** + * The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). + */ + ResourceIdentifier: String; + /** + * The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade + */ + ApplyAction: String; + /** + * A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests. + */ + OptInType: String; + } + export interface ApplyPendingMaintenanceActionResult { + ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions; + } + export type AttributeValueList = String[]; + export interface AvailabilityZone { + /** + * The name of the availability zone. + */ + Name?: String; + } + export type AvailabilityZoneList = AvailabilityZone[]; + export type AvailabilityZones = String[]; + export type Boolean = boolean; + export type BooleanOptional = boolean; + export interface CharacterSet { + /** + * The name of the character set. + */ + CharacterSetName?: String; + /** + * The description of the character set. + */ + CharacterSetDescription?: String; + } + export interface CloudwatchLogsExportConfiguration { + /** + * The list of log types to enable. + */ + EnableLogTypes?: LogTypeList; + /** + * The list of log types to disable. + */ + DisableLogTypes?: LogTypeList; + } + export interface CopyDBClusterParameterGroupMessage { + /** + * The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1. + */ + SourceDBClusterParameterGroupIdentifier: String; + /** + * The identifier for the copied DB cluster parameter group. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster-param-group1 + */ + TargetDBClusterParameterGroupIdentifier: String; + /** + * A description for the copied DB cluster parameter group. + */ + TargetDBClusterParameterGroupDescription: String; + /** + * The tags to be assigned to the copied DB cluster parameter group. + */ + Tags?: TagList; + } + export interface CopyDBClusterParameterGroupResult { + DBClusterParameterGroup?: DBClusterParameterGroup; + } + export interface CopyDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You can't copy from one AWS Region to another. Constraints: Must specify a valid system snapshot in the "available" state. Specify a valid DB snapshot identifier. Example: my-cluster-snapshot1 + */ + SourceDBClusterSnapshotIdentifier: String; + /** + * The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2 + */ + TargetDBClusterSnapshotIdentifier: String; + /** + * The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon Neptune encrypts the target DB cluster snapshot using the specified KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. + */ + KmsKeyId?: String; + /** + * Not currently supported. + */ + PreSignedUrl?: String; + /** + * True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false. + */ + CopyTags?: BooleanOptional; + /** + * The tags to assign to the new DB cluster snapshot copy. + */ + Tags?: TagList; + } + export interface CopyDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface CopyDBParameterGroupMessage { + /** + * The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN. + */ + SourceDBParameterGroupIdentifier: String; + /** + * The identifier for the copied DB parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-db-parameter-group + */ + TargetDBParameterGroupIdentifier: String; + /** + * A description for the copied DB parameter group. + */ + TargetDBParameterGroupDescription: String; + /** + * The tags to be assigned to the copied DB parameter group. + */ + Tags?: TagList; + } + export interface CopyDBParameterGroupResult { + DBParameterGroup?: DBParameterGroup; + } + export interface CreateDBClusterMessage { + /** + * A list of EC2 Availability Zones that instances in the DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35 + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * A value that indicates that the DB cluster should be associated with the specified CharacterSet. + */ + CharacterSetName?: String; + /** + * The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating. + */ + DatabaseName?: String; + /** + * The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1 + */ + DBClusterIdentifier: String; + /** + * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName?: String; + /** + * A list of EC2 VPC security groups to associate with this DB cluster. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * The name of the database engine to be used for this DB cluster. Valid Values: neptune + */ + Engine: String; + /** + * The version number of the database engine to use. Example: 1.0.1 + */ + EngineVersion?: String; + /** + * The port number on which the instances in the DB cluster accept connections. Default: 8182 + */ + Port?: IntegerOptional; + /** + * The name of the master user for the DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Cannot be a reserved word for the chosen database engine. + */ + MasterUsername?: String; + /** + * The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword?: String; + /** + * A value that indicates that the DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster. + */ + OptionGroupName?: String; + /** + * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. + */ + ReplicationSourceIdentifier?: String; + /** + * The tags to assign to the new DB cluster. + */ + Tags?: TagList; + /** + * Specifies whether the DB cluster is encrypted. + */ + StorageEncrypted?: BooleanOptional; + /** + * The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key. If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune 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. If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region. + */ + KmsKeyId?: String; + /** + * This parameter is not currently supported. + */ + PreSignedUrl?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + } + export interface CreateDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string. + */ + DBClusterParameterGroupName: String; + /** + * The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. + */ + DBParameterGroupFamily: String; + /** + * The description for the DB cluster parameter group. + */ + Description: String; + /** + * The tags to be assigned to the new DB cluster parameter group. + */ + Tags?: TagList; + } + export interface CreateDBClusterParameterGroupResult { + DBClusterParameterGroup?: DBClusterParameterGroup; + } + export interface CreateDBClusterResult { + DBCluster?: DBCluster; + } + export interface CreateDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1 + */ + DBClusterSnapshotIdentifier: String; + /** + * The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster1 + */ + DBClusterIdentifier: String; + /** + * The tags to be assigned to the DB cluster snapshot. + */ + Tags?: TagList; + } + export interface CreateDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface CreateDBInstanceMessage { + /** + * Not supported. + */ + DBName?: String; + /** + * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance + */ + DBInstanceIdentifier: String; + /** + * The amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume. + */ + AllocatedStorage?: IntegerOptional; + /** + * The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions. + */ + DBInstanceClass: String; + /** + * The name of the database engine to be used for this instance. Valid Values: neptune + */ + Engine: String; + /** + * The name for the master user. Not used. + */ + MasterUsername?: String; + /** + * The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Not used. + */ + MasterUserPassword?: String; + /** + * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. + */ + DBSecurityGroups?: DBSecurityGroupNameList; + /** + * A list of EC2 VPC security groups to associate with this DB instance. Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC security group for the DB subnet group's VPC. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The EC2 Availability Zone that the DB instance is created in Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint. + */ + AvailabilityZone?: String; + /** + * A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance. + */ + DBSubnetGroupName?: String; + /** + * The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens + */ + DBParameterGroupName?: String; + /** + * The number of days for which automated backups are retained. Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster. Default: 1 Constraints: Must be a value from 0 to 35 Cannot be set to 0 if the DB instance is a source to Read Replicas + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The daily time range during which automated backups are created. Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster. + */ + PreferredBackupWindow?: String; + /** + * The port number on which the database accepts connections. Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster. Default: 8182 Type: Integer + */ + Port?: IntegerOptional; + /** + * Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true. + */ + MultiAZ?: BooleanOptional; + /** + * The version number of the database engine to use. + */ + EngineVersion?: String; + /** + * Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license + */ + LicenseModel?: String; + /** + * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. + */ + Iops?: IntegerOptional; + /** + * Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance + */ + OptionGroupName?: String; + /** + * Indicates that the DB instance should be associated with the specified CharacterSet. Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster. + */ + CharacterSetName?: String; + /** + * This flag should no longer be used. + */ + PubliclyAccessible?: BooleanOptional; + /** + * The tags to assign to the new instance. + */ + Tags?: TagList; + /** + * The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String + */ + DBClusterIdentifier?: String; + /** + * Specifies the storage type to be associated with the DB instance. Not applicable. Storage is managed by the DB Cluster. + */ + StorageType?: String; + /** + * The ARN from the key store with which to associate the instance for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * The password for the given ARN from the key store in order to access the device. + */ + TdeCredentialPassword?: String; + /** + * Specifies whether the DB instance is encrypted. Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster. Default: false + */ + StorageEncrypted?: BooleanOptional; + /** + * The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune 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. + */ + KmsKeyId?: String; + /** + * Specify the Active Directory Domain to create the instance in. + */ + Domain?: String; + /** + * True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 + */ + MonitoringInterval?: IntegerOptional; + /** + * The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. + */ + MonitoringRoleArn?: String; + /** + * Specify the name of the IAM role to be used when making API calls to the Directory Service. + */ + DomainIAMRoleName?: String; + /** + * A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid Values: 0 - 15 + */ + PromotionTier?: IntegerOptional; + /** + * The time zone of the DB instance. + */ + Timezone?: String; + /** + * True to enable AWS Identity and Access Management (IAM) authentication for Neptune. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * True to enable Performance Insights for the DB instance, and otherwise false. + */ + EnablePerformanceInsights?: BooleanOptional; + /** + * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * The list of log types that need to be enabled for exporting to CloudWatch Logs. + */ + EnableCloudwatchLogsExports?: LogTypeList; + } + export interface CreateDBInstanceResult { + DBInstance?: DBInstance; + } + export interface CreateDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. + */ + DBParameterGroupName: String; + /** + * The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. + */ + DBParameterGroupFamily: String; + /** + * The description for the DB parameter group. + */ + Description: String; + /** + * The tags to be assigned to the new DB parameter group. + */ + Tags?: TagList; + } + export interface CreateDBParameterGroupResult { + DBParameterGroup?: DBParameterGroup; + } + export interface CreateDBSubnetGroupMessage { + /** + * The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + /** + * The description for the DB subnet group. + */ + DBSubnetGroupDescription: String; + /** + * The EC2 Subnet IDs for the DB subnet group. + */ + SubnetIds: SubnetIdentifierList; + /** + * The tags to be assigned to the new DB subnet group. + */ + Tags?: TagList; + } + export interface CreateDBSubnetGroupResult { + DBSubnetGroup?: DBSubnetGroup; + } + export interface CreateEventSubscriptionMessage { + /** + * The name of the subscription. Constraints: The name must be less than 255 characters. + */ + SubscriptionName: String; + /** + * The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + */ + SnsTopicArn: String; + /** + * The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot + */ + SourceType?: String; + /** + * A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action. + */ + EventCategories?: EventCategoriesList; + /** + * The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are supplied, SourceType must also be provided. If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied. + */ + SourceIds?: SourceIdsList; + /** + * A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. + */ + Enabled?: BooleanOptional; + /** + * The tags to be applied to the new event subscription. + */ + Tags?: TagList; + } + export interface CreateEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface DBCluster { + /** + * AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed. + */ + AllocatedStorage?: IntegerOptional; + /** + * Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * Specifies the number of days for which automatic DB snapshots are retained. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * If present, specifies the name of the character set that this cluster is associated with. + */ + CharacterSetName?: String; + /** + * Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster. + */ + DatabaseName?: String; + /** + * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. + */ + DBClusterIdentifier?: String; + /** + * Specifies the name of the DB cluster parameter group for the DB cluster. + */ + DBClusterParameterGroup?: String; + /** + * Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. + */ + DBSubnetGroup?: String; + /** + * Specifies the current state of this DB cluster. + */ + Status?: String; + /** + * Specifies the progress of the operation as a percentage. + */ + PercentProgress?: String; + /** + * Specifies the earliest time to which a database can be restored with point-in-time restore. + */ + EarliestRestorableTime?: TStamp; + /** + * Specifies the connection endpoint for the primary instance of the DB cluster. + */ + Endpoint?: String; + /** + * The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster. If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint. + */ + ReaderEndpoint?: String; + /** + * Specifies whether the DB cluster has instances in multiple Availability Zones. + */ + MultiAZ?: Boolean; + /** + * Provides the name of the database engine to be used for this DB cluster. + */ + Engine?: String; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * Specifies the latest time to which a database can be restored with point-in-time restore. + */ + LatestRestorableTime?: TStamp; + /** + * Specifies the port that the database engine is listening on. + */ + Port?: IntegerOptional; + /** + * Contains the master username for the DB cluster. + */ + MasterUsername?: String; + /** + * Provides the list of option group memberships for this DB cluster. + */ + DBClusterOptionGroupMemberships?: DBClusterOptionGroupMemberships; + /** + * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. + */ + PreferredBackupWindow?: String; + /** + * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + */ + PreferredMaintenanceWindow?: String; + /** + * Not supported by Neptune. + */ + ReplicationSourceIdentifier?: String; + /** + * Contains one or more identifiers of the Read Replicas associated with this DB cluster. + */ + ReadReplicaIdentifiers?: ReadReplicaIdentifierList; + /** + * Provides the list of instances that make up the DB cluster. + */ + DBClusterMembers?: DBClusterMemberList; + /** + * Provides a list of VPC security groups that the DB cluster belongs to. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + */ + HostedZoneId?: String; + /** + * Specifies whether the DB cluster is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster. + */ + KmsKeyId?: String; + /** + * The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. + */ + DbClusterResourceId?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster. + */ + DBClusterArn?: String; + /** + * Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + */ + AssociatedRoles?: DBClusterRoles; + /** + * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + /** + * Identifies the clone group to which the DB cluster is associated. + */ + CloneGroupId?: String; + /** + * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). + */ + ClusterCreateTime?: TStamp; + } + export type DBClusterList = DBCluster[]; + export interface DBClusterMember { + /** + * Specifies the instance identifier for this member of the DB cluster. + */ + DBInstanceIdentifier?: String; + /** + * Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise. + */ + IsClusterWriter?: Boolean; + /** + * Specifies the status of the DB cluster parameter group for this member of the DB cluster. + */ + DBClusterParameterGroupStatus?: String; + /** + * A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. + */ + PromotionTier?: IntegerOptional; + } + export type DBClusterMemberList = DBClusterMember[]; + export interface DBClusterMessage { + /** + * A pagination token that can be used in a subsequent DescribeDBClusters request. + */ + Marker?: String; + /** + * Contains a list of DB clusters for the user. + */ + DBClusters?: DBClusterList; + } + export type DBClusterOptionGroupMemberships = DBClusterOptionGroupStatus[]; + export interface DBClusterOptionGroupStatus { + /** + * Specifies the name of the DB cluster option group. + */ + DBClusterOptionGroupName?: String; + /** + * Specifies the status of the DB cluster option group. + */ + Status?: String; + } + export interface DBClusterParameterGroup { + /** + * Provides the name of the DB cluster parameter group. + */ + DBClusterParameterGroupName?: String; + /** + * Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with. + */ + DBParameterGroupFamily?: String; + /** + * Provides the customer-specified description for this DB cluster parameter group. + */ + Description?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster parameter group. + */ + DBClusterParameterGroupArn?: String; + } + export interface DBClusterParameterGroupDetails { + /** + * Provides a list of parameters for the DB cluster parameter group. + */ + Parameters?: ParametersList; + /** + * An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export type DBClusterParameterGroupList = DBClusterParameterGroup[]; + export interface DBClusterParameterGroupNameMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. + */ + DBClusterParameterGroupName?: String; + } + export interface DBClusterParameterGroupsMessage { + /** + * An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * A list of DB cluster parameter groups. + */ + DBClusterParameterGroups?: DBClusterParameterGroupList; + } + export interface DBClusterRole { + /** + * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. + */ + RoleArn?: String; + /** + * Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf. PENDING - the IAM role ARN is being associated with the DB cluster. INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf. + */ + Status?: String; + } + export type DBClusterRoles = DBClusterRole[]; + export interface DBClusterSnapshot { + /** + * Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * Specifies the identifier for the DB cluster snapshot. + */ + DBClusterSnapshotIdentifier?: String; + /** + * Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. + */ + DBClusterIdentifier?: String; + /** + * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). + */ + SnapshotCreateTime?: TStamp; + /** + * Specifies the name of the database engine. + */ + Engine?: String; + /** + * Specifies the allocated storage size in gibibytes (GiB). + */ + AllocatedStorage?: Integer; + /** + * Specifies the status of this DB cluster snapshot. + */ + Status?: String; + /** + * Specifies the port that the DB cluster was listening on at the time of the snapshot. + */ + Port?: Integer; + /** + * Provides the VPC ID associated with the DB cluster snapshot. + */ + VpcId?: String; + /** + * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). + */ + ClusterCreateTime?: TStamp; + /** + * Provides the master username for the DB cluster snapshot. + */ + MasterUsername?: String; + /** + * Provides the version of the database engine for this DB cluster snapshot. + */ + EngineVersion?: String; + /** + * Provides the license model information for this DB cluster snapshot. + */ + LicenseModel?: String; + /** + * Provides the type of the DB cluster snapshot. + */ + SnapshotType?: String; + /** + * Specifies the percentage of the estimated data that has been transferred. + */ + PercentProgress?: Integer; + /** + * Specifies whether the DB cluster snapshot is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. + */ + KmsKeyId?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster snapshot. + */ + DBClusterSnapshotArn?: String; + /** + * If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value. + */ + SourceDBClusterSnapshotArn?: String; + /** + * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + } + export interface DBClusterSnapshotAttribute { + /** + * The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action. + */ + AttributeName?: String; + /** + * The value(s) for the manual DB cluster snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore. + */ + AttributeValues?: AttributeValueList; + } + export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[]; + export interface DBClusterSnapshotAttributesResult { + /** + * The identifier of the manual DB cluster snapshot that the attributes apply to. + */ + DBClusterSnapshotIdentifier?: String; + /** + * The list of attributes and values for the manual DB cluster snapshot. + */ + DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList; + } + export type DBClusterSnapshotList = DBClusterSnapshot[]; + export interface DBClusterSnapshotMessage { + /** + * An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * Provides a list of DB cluster snapshots for the user. + */ + DBClusterSnapshots?: DBClusterSnapshotList; + } + export interface DBEngineVersion { + /** + * The name of the database engine. + */ + Engine?: String; + /** + * The version number of the database engine. + */ + EngineVersion?: String; + /** + * The name of the DB parameter group family for the database engine. + */ + DBParameterGroupFamily?: String; + /** + * The description of the database engine. + */ + DBEngineDescription?: String; + /** + * The description of the database engine version. + */ + DBEngineVersionDescription?: String; + /** + * The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified. + */ + DefaultCharacterSet?: CharacterSet; + /** + * A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action. + */ + SupportedCharacterSets?: SupportedCharacterSetsList; + /** + * A list of engine versions that this database engine version can be upgraded to. + */ + ValidUpgradeTarget?: ValidUpgradeTargetList; + /** + * A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action. + */ + SupportedTimezones?: SupportedTimezonesList; + /** + * The types of logs that the database engine has available for export to CloudWatch Logs. + */ + ExportableLogTypes?: LogTypeList; + /** + * A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. + */ + SupportsLogExportsToCloudwatchLogs?: Boolean; + /** + * Indicates whether the database engine version supports read replicas. + */ + SupportsReadReplica?: Boolean; + } + export type DBEngineVersionList = DBEngineVersion[]; + export interface DBEngineVersionMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBEngineVersion elements. + */ + DBEngineVersions?: DBEngineVersionList; + } + export interface DBInstance { + /** + * Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. + */ + DBInstanceIdentifier?: String; + /** + * Contains the name of the compute and memory capacity class of the DB instance. + */ + DBInstanceClass?: String; + /** + * Provides the name of the database engine to be used for this DB instance. + */ + Engine?: String; + /** + * Specifies the current state of this database. + */ + DBInstanceStatus?: String; + /** + * Contains the master username for the DB instance. + */ + MasterUsername?: String; + /** + * The database name. + */ + DBName?: String; + /** + * Specifies the connection endpoint. + */ + Endpoint?: Endpoint; + /** + * Specifies the allocated storage size specified in gibibytes. + */ + AllocatedStorage?: Integer; + /** + * Provides the date and time the DB instance was created. + */ + InstanceCreateTime?: TStamp; + /** + * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. + */ + PreferredBackupWindow?: String; + /** + * Specifies the number of days for which automatic DB snapshots are retained. + */ + BackupRetentionPeriod?: Integer; + /** + * Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. + */ + DBSecurityGroups?: DBSecurityGroupMembershipList; + /** + * Provides a list of VPC security group elements that the DB instance belongs to. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * Provides the list of DB parameter groups applied to this DB instance. + */ + DBParameterGroups?: DBParameterGroupStatusList; + /** + * Specifies the name of the Availability Zone the DB instance is located in. + */ + AvailabilityZone?: String; + /** + * Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group. + */ + DBSubnetGroup?: DBSubnetGroup; + /** + * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + */ + PreferredMaintenanceWindow?: String; + /** + * Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. + */ + PendingModifiedValues?: PendingModifiedValues; + /** + * Specifies the latest time to which a database can be restored with point-in-time restore. + */ + LatestRestorableTime?: TStamp; + /** + * Specifies if the DB instance is a Multi-AZ deployment. + */ + MultiAZ?: Boolean; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * Indicates that minor version patches are applied automatically. + */ + AutoMinorVersionUpgrade?: Boolean; + /** + * Contains the identifier of the source DB instance if this DB instance is a Read Replica. + */ + ReadReplicaSourceDBInstanceIdentifier?: String; + /** + * Contains one or more identifiers of the Read Replicas associated with this DB instance. + */ + ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList; + /** + * Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance. + */ + ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList; + /** + * License model information for this DB instance. + */ + LicenseModel?: String; + /** + * Specifies the Provisioned IOPS (I/O operations per second) value. + */ + Iops?: IntegerOptional; + /** + * Provides the list of option group memberships for this DB instance. + */ + OptionGroupMemberships?: OptionGroupMembershipList; + /** + * If present, specifies the name of the character set that this instance is associated with. + */ + CharacterSetName?: String; + /** + * If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. + */ + SecondaryAvailabilityZone?: String; + /** + * This flag should no longer be used. + */ + PubliclyAccessible?: Boolean; + /** + * The status of a Read Replica. If the instance is not a Read Replica, this is blank. + */ + StatusInfos?: DBInstanceStatusInfoList; + /** + * Specifies the storage type associated with DB instance. + */ + StorageType?: String; + /** + * The ARN from the key store with which the instance is associated for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port. + */ + DbInstancePort?: Integer; + /** + * If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. + */ + DBClusterIdentifier?: String; + /** + * Not supported: The encryption for DB instances is managed by the DB cluster. + */ + StorageEncrypted?: Boolean; + /** + * Not supported: The encryption for DB instances is managed by the DB cluster. + */ + KmsKeyId?: String; + /** + * The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. + */ + DbiResourceId?: String; + /** + * The identifier of the CA certificate for this DB instance. + */ + CACertificateIdentifier?: String; + /** + * Not supported + */ + DomainMemberships?: DomainMembershipList; + /** + * Specifies whether tags are copied from the DB instance to snapshots of the DB instance. + */ + CopyTagsToSnapshot?: Boolean; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. + */ + MonitoringInterval?: IntegerOptional; + /** + * The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance. + */ + EnhancedMonitoringResourceArn?: String; + /** + * The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. + */ + MonitoringRoleArn?: String; + /** + * A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. + */ + PromotionTier?: IntegerOptional; + /** + * The Amazon Resource Name (ARN) for the DB instance. + */ + DBInstanceArn?: String; + /** + * Not supported. + */ + Timezone?: String; + /** + * True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + /** + * True if Performance Insights is enabled for the DB instance, and otherwise false. + */ + PerformanceInsightsEnabled?: BooleanOptional; + /** + * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * A list of log types that this DB instance is configured to export to CloudWatch Logs. + */ + EnabledCloudwatchLogsExports?: LogTypeList; + } + export type DBInstanceList = DBInstance[]; + export interface DBInstanceMessage { + /** + * 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 MaxRecords . + */ + Marker?: String; + /** + * A list of DBInstance instances. + */ + DBInstances?: DBInstanceList; + } + export interface DBInstanceStatusInfo { + /** + * This value is currently "read replication." + */ + StatusType?: String; + /** + * Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. + */ + Normal?: Boolean; + /** + * Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated. + */ + Status?: String; + /** + * Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank. + */ + Message?: String; + } + export type DBInstanceStatusInfoList = DBInstanceStatusInfo[]; + export interface DBParameterGroup { + /** + * Provides the name of the DB parameter group. + */ + DBParameterGroupName?: String; + /** + * Provides the name of the DB parameter group family that this DB parameter group is compatible with. + */ + DBParameterGroupFamily?: String; + /** + * Provides the customer-specified description for this DB parameter group. + */ + Description?: String; + /** + * The Amazon Resource Name (ARN) for the DB parameter group. + */ + DBParameterGroupArn?: String; + } + export interface DBParameterGroupDetails { + /** + * A list of Parameter values. + */ + Parameters?: ParametersList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export type DBParameterGroupList = DBParameterGroup[]; + export interface DBParameterGroupNameMessage { + /** + * Provides the name of the DB parameter group. + */ + DBParameterGroupName?: String; + } + export interface DBParameterGroupStatus { + /** + * The name of the DP parameter group. + */ + DBParameterGroupName?: String; + /** + * The status of parameter updates. + */ + ParameterApplyStatus?: String; + } + export type DBParameterGroupStatusList = DBParameterGroupStatus[]; + export interface DBParameterGroupsMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBParameterGroup instances. + */ + DBParameterGroups?: DBParameterGroupList; + } + export interface DBSecurityGroupMembership { + /** + * The name of the DB security group. + */ + DBSecurityGroupName?: String; + /** + * The status of the DB security group. + */ + Status?: String; + } + export type DBSecurityGroupMembershipList = DBSecurityGroupMembership[]; + export type DBSecurityGroupNameList = String[]; + export interface DBSubnetGroup { + /** + * The name of the DB subnet group. + */ + DBSubnetGroupName?: String; + /** + * Provides the description of the DB subnet group. + */ + DBSubnetGroupDescription?: String; + /** + * Provides the VpcId of the DB subnet group. + */ + VpcId?: String; + /** + * Provides the status of the DB subnet group. + */ + SubnetGroupStatus?: String; + /** + * Contains a list of Subnet elements. + */ + Subnets?: SubnetList; + /** + * The Amazon Resource Name (ARN) for the DB subnet group. + */ + DBSubnetGroupArn?: String; + } + export interface DBSubnetGroupMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBSubnetGroup instances. + */ + DBSubnetGroups?: DBSubnetGroups; + } + export type DBSubnetGroups = DBSubnetGroup[]; + export interface DeleteDBClusterMessage { + /** + * The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: Must match an existing DBClusterIdentifier. + */ + DBClusterIdentifier: String; + /** + * Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted. You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false. Default: false + */ + SkipFinalSnapshot?: Boolean; + /** + * The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens + */ + FinalDBSnapshotIdentifier?: String; + } + export interface DeleteDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You can't delete a default DB cluster parameter group. Cannot be associated with any DB clusters. + */ + DBClusterParameterGroupName: String; + } + export interface DeleteDBClusterResult { + DBCluster?: DBCluster; + } + export interface DeleteDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state. + */ + DBClusterSnapshotIdentifier: String; + } + export interface DeleteDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface DeleteDBInstanceMessage { + /** + * The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: Must match the name of an existing DB instance. + */ + DBInstanceIdentifier: String; + /** + * Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted. Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". Specify true when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false. Default: false + */ + SkipFinalSnapshot?: Boolean; + /** + * The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Cannot be specified when deleting a Read Replica. + */ + FinalDBSnapshotIdentifier?: String; + } + export interface DeleteDBInstanceResult { + DBInstance?: DBInstance; + } + export interface DeleteDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: Must be the name of an existing DB parameter group You can't delete a default DB parameter group Cannot be associated with any DB instances + */ + DBParameterGroupName: String; + } + export interface DeleteDBSubnetGroupMessage { + /** + * The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + } + export interface DeleteEventSubscriptionMessage { + /** + * The name of the event notification subscription you want to delete. + */ + SubscriptionName: String; + } + export interface DeleteEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface DescribeDBClusterParameterGroupsMessage { + /** + * The name of a specific DB cluster parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterParametersMessage { + /** + * The name of a specific DB cluster parameter group to return parameter details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName: String; + /** + * A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer. + */ + Source?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterSnapshotAttributesMessage { + /** + * The identifier for the DB cluster snapshot to describe the attributes for. + */ + DBClusterSnapshotIdentifier: String; + } + export interface DescribeDBClusterSnapshotAttributesResult { + DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; + } + export interface DescribeDBClusterSnapshotsMessage { + /** + * The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier?: String; + /** + * A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified. + */ + DBClusterSnapshotIdentifier?: String; + /** + * The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my AWS account. manual - Return all DB cluster snapshots that have been taken by my AWS account. shared - Return all manual DB cluster snapshots that have been shared to my AWS account. public - Return all DB cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public. + */ + SnapshotType?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false. You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action. + */ + IncludeShared?: Boolean; + /** + * True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. The default is false. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. + */ + IncludePublic?: Boolean; + } + export interface DescribeDBClustersMessage { + /** + * The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match an existing DBClusterIdentifier. + */ + DBClusterIdentifier?: String; + /** + * A filter that specifies one or more DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBEngineVersionsMessage { + /** + * The database engine to return. + */ + Engine?: String; + /** + * The database engine version to return. Example: 5.1.49 + */ + EngineVersion?: String; + /** + * The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DBParameterGroupFamily. + */ + DBParameterGroupFamily?: String; + /** + * Not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Indicates that only the default version of the specified engine or engine and major version combination is returned. + */ + DefaultOnly?: Boolean; + /** + * If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version. + */ + ListSupportedCharacterSets?: BooleanOptional; + /** + * If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version. + */ + ListSupportedTimezones?: BooleanOptional; + } + export interface DescribeDBInstancesMessage { + /** + * The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier?: String; + /** + * A filter that specifies one or more DB instances to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBParameterGroupsMessage { + /** + * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBParameterGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBParametersMessage { + /** + * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBParameterGroup. + */ + DBParameterGroupName: String; + /** + * The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default + */ + Source?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBSubnetGroupsMessage { + /** + * The name of the DB subnet group to return details for. + */ + DBSubnetGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultClusterParametersMessage { + /** + * The name of the DB cluster parameter group family to return engine parameter information for. + */ + DBParameterGroupFamily: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultClusterParametersResult { + EngineDefaults?: EngineDefaults; + } + export interface DescribeEngineDefaultParametersMessage { + /** + * The name of the DB parameter group family. + */ + DBParameterGroupFamily: String; + /** + * Not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultParametersResult { + EngineDefaults?: EngineDefaults; + } + export interface DescribeEventCategoriesMessage { + /** + * The type of source that is generating the events. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot + */ + SourceType?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + } + export interface DescribeEventSubscriptionsMessage { + /** + * The name of the event notification subscription you want to describe. + */ + SubscriptionName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export interface DescribeEventsMessage { + /** + * The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. If the source type is DBInstance, then a DBInstanceIdentifier must be supplied. If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied. If the source type is DBParameterGroup, a DBParameterGroupName must be supplied. If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied. Cannot end with a hyphen or contain two consecutive hyphens. + */ + SourceIdentifier?: String; + /** + * The event source to retrieve events for. If no value is specified, all events are returned. + */ + SourceType?: SourceType; + /** + * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z + */ + StartTime?: TStamp; + /** + * The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z + */ + EndTime?: TStamp; + /** + * The number of minutes to retrieve events for. Default: 60 + */ + Duration?: IntegerOptional; + /** + * A list of event categories that trigger notifications for a event notification subscription. + */ + EventCategories?: EventCategoriesList; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeOrderableDBInstanceOptionsMessage { + /** + * The name of the engine to retrieve DB instance options for. + */ + Engine: String; + /** + * The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. + */ + EngineVersion?: String; + /** + * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. + */ + DBInstanceClass?: String; + /** + * The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. + */ + LicenseModel?: String; + /** + * The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. + */ + Vpc?: BooleanOptional; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export interface DescribePendingMaintenanceActionsMessage { + /** + * The ARN of a resource to return pending maintenance actions for. + */ + ResourceIdentifier?: String; + /** + * A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs. + */ + Filters?: FilterList; + /** + * An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords. + */ + Marker?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + } + export interface DescribeValidDBInstanceModificationsMessage { + /** + * The customer identifier or the ARN of your DB instance. + */ + DBInstanceIdentifier: String; + } + export interface DescribeValidDBInstanceModificationsResult { + ValidDBInstanceModificationsMessage?: ValidDBInstanceModificationsMessage; + } + export interface DomainMembership { + /** + * The identifier of the Active Directory Domain. + */ + Domain?: String; + /** + * The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc). + */ + Status?: String; + /** + * The fully qualified domain name of the Active Directory Domain. + */ + FQDN?: String; + /** + * The name of the IAM role to be used when making API calls to the Directory Service. + */ + IAMRoleName?: String; + } + export type DomainMembershipList = DomainMembership[]; + export type Double = number; + export type DoubleOptional = number; + export interface DoubleRange { + /** + * The minimum value in the range. + */ + From?: Double; + /** + * The maximum value in the range. + */ + To?: Double; + } + export type DoubleRangeList = DoubleRange[]; + export interface Endpoint { + /** + * Specifies the DNS address of the DB instance. + */ + Address?: String; + /** + * Specifies the port that the database engine is listening on. + */ + Port?: Integer; + /** + * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + */ + HostedZoneId?: String; + } + export interface EngineDefaults { + /** + * Specifies the name of the DB parameter group family that the engine default parameters apply to. + */ + DBParameterGroupFamily?: String; + /** + * An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + /** + * Contains a list of engine default parameters. + */ + Parameters?: ParametersList; + } + export interface Event { + /** + * Provides the identifier for the source of the event. + */ + SourceIdentifier?: String; + /** + * Specifies the source type for this event. + */ + SourceType?: SourceType; + /** + * Provides the text of this event. + */ + Message?: String; + /** + * Specifies the category for the event. + */ + EventCategories?: EventCategoriesList; + /** + * Specifies the date and time of the event. + */ + Date?: TStamp; + /** + * The Amazon Resource Name (ARN) for the event. + */ + SourceArn?: String; + } + export type EventCategoriesList = String[]; + export interface EventCategoriesMap { + /** + * The source type that the returned categories belong to + */ + SourceType?: String; + /** + * The event categories for the specified source type + */ + EventCategories?: EventCategoriesList; + } + export type EventCategoriesMapList = EventCategoriesMap[]; + export interface EventCategoriesMessage { + /** + * A list of EventCategoriesMap data types. + */ + EventCategoriesMapList?: EventCategoriesMapList; + } + export type EventList = Event[]; + export interface EventSubscription { + /** + * The AWS customer account associated with the event notification subscription. + */ + CustomerAwsId?: String; + /** + * The event notification subscription Id. + */ + CustSubscriptionId?: String; + /** + * The topic ARN of the event notification subscription. + */ + SnsTopicArn?: String; + /** + * The status of the event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. + */ + Status?: String; + /** + * The time the event notification subscription was created. + */ + SubscriptionCreationTime?: String; + /** + * The source type for the event notification subscription. + */ + SourceType?: String; + /** + * A list of source IDs for the event notification subscription. + */ + SourceIdsList?: SourceIdsList; + /** + * A list of event categories for the event notification subscription. + */ + EventCategoriesList?: EventCategoriesList; + /** + * A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled. + */ + Enabled?: Boolean; + /** + * The Amazon Resource Name (ARN) for the event subscription. + */ + EventSubscriptionArn?: String; + } + export type EventSubscriptionsList = EventSubscription[]; + export interface EventSubscriptionsMessage { + /** + * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * A list of EventSubscriptions data types. + */ + EventSubscriptionsList?: EventSubscriptionsList; + } + export interface EventsMessage { + /** + * An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + /** + * A list of Event instances. + */ + Events?: EventList; + } + export interface FailoverDBClusterMessage { + /** + * A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier?: String; + /** + * The name of the instance to promote to the primary instance. You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1. + */ + TargetDBInstanceIdentifier?: String; + } + export interface FailoverDBClusterResult { + DBCluster?: DBCluster; + } + export interface Filter { + /** + * This parameter is not currently supported. + */ + Name: String; + /** + * This parameter is not currently supported. + */ + Values: FilterValueList; + } + export type FilterList = Filter[]; + export type FilterValueList = String[]; + export type Integer = number; + export type IntegerOptional = number; + export type KeyList = String[]; + export interface ListTagsForResourceMessage { + /** + * The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). + */ + ResourceName: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + } + export type LogTypeList = String[]; + export interface ModifyDBClusterMessage { + /** + * The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier: String; + /** + * The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster2 + */ + NewDBClusterIdentifier?: String; + /** + * A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. Default: false + */ + ApplyImmediately?: Boolean; + /** + * The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35 + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The name of the DB cluster parameter group to use for the DB cluster. + */ + DBClusterParameterGroupName?: String; + /** + * A list of VPC security groups that the DB cluster will belong to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster. + */ + Port?: IntegerOptional; + /** + * The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword?: String; + /** + * A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster. + */ + OptionGroupName?: String; + /** + * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true. For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. + */ + EngineVersion?: String; + } + export interface ModifyDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group to modify. + */ + DBClusterParameterGroupName: String; + /** + * A list of parameters in the DB cluster parameter group to modify. + */ + Parameters: ParametersList; + } + export interface ModifyDBClusterResult { + DBCluster?: DBCluster; + } + export interface ModifyDBClusterSnapshotAttributeMessage { + /** + * The identifier for the DB cluster snapshot to modify the attributes for. + */ + DBClusterSnapshotIdentifier: String; + /** + * The name of the DB cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore. + */ + AttributeName: String; + /** + * A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. + */ + ValuesToAdd?: AttributeValueList; + /** + * A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot. + */ + ValuesToRemove?: AttributeValueList; + } + export interface ModifyDBClusterSnapshotAttributeResult { + DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; + } + export interface ModifyDBInstanceMessage { + /** + * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * The new amount of storage (in gibibytes) to allocate for the DB instance. Not applicable. Storage is managed by the DB Cluster. + */ + AllocatedStorage?: IntegerOptional; + /** + * The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request. Default: Uses existing setting + */ + DBInstanceClass?: String; + /** + * The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup + */ + DBSubnetGroupName?: String; + /** + * A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups. + */ + DBSecurityGroups?: DBSecurityGroupNameList; + /** + * A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Default: false + */ + ApplyImmediately?: Boolean; + /** + * Not applicable. + */ + MasterUserPassword?: String; + /** + * The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance. + */ + DBParameterGroupName?: String; + /** + * Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The daily time range during which automated backups are created if automated backups are enabled. Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: Must be in the format hh24:mi-hh24:mi Must be in Universal Time Coordinated (UTC) Must not conflict with the preferred maintenance window Must be at least 30 minutes + */ + PreferredBackupWindow?: String; + /** + * The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes + */ + PreferredMaintenanceWindow?: String; + /** + * Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. + */ + MultiAZ?: BooleanOptional; + /** + * The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. + */ + EngineVersion?: String; + /** + * Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. + */ + AllowMajorVersionUpgrade?: Boolean; + /** + * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * Not supported. + */ + LicenseModel?: String; + /** + * The new Provisioned IOPS (I/O operations per second) value for the instance. Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. Default: Uses existing setting + */ + Iops?: IntegerOptional; + /** + * Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance + */ + OptionGroupName?: String; + /** + * The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance + */ + NewDBInstanceIdentifier?: String; + /** + * Not supported. + */ + StorageType?: String; + /** + * The ARN from the key store with which to associate the instance for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * The password for the given ARN from the key store in order to access the device. + */ + TdeCredentialPassword?: String; + /** + * Indicates the certificate that needs to be associated with the instance. + */ + CACertificateIdentifier?: String; + /** + * Not supported. + */ + Domain?: String; + /** + * True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 + */ + MonitoringInterval?: IntegerOptional; + /** + * The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter. Default: 8182 + */ + DBPortNumber?: IntegerOptional; + /** + * This flag should no longer be used. + */ + PubliclyAccessible?: BooleanOptional; + /** + * The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. + */ + MonitoringRoleArn?: String; + /** + * Not supported + */ + DomainIAMRoleName?: String; + /** + * A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid Values: 0 - 15 + */ + PromotionTier?: IntegerOptional; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * Not supported. + */ + EnablePerformanceInsights?: BooleanOptional; + /** + * Not supported. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster. + */ + CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration; + } + export interface ModifyDBInstanceResult { + DBInstance?: DBInstance; + } + export interface ModifyDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: If supplied, must match the name of an existing DBParameterGroup. + */ + DBParameterGroupName: String; + /** + * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. + */ + Parameters: ParametersList; + } + export interface ModifyDBSubnetGroupMessage { + /** + * The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + /** + * The description for the DB subnet group. + */ + DBSubnetGroupDescription?: String; + /** + * The EC2 subnet IDs for the DB subnet group. + */ + SubnetIds: SubnetIdentifierList; + } + export interface ModifyDBSubnetGroupResult { + DBSubnetGroup?: DBSubnetGroup; + } + export interface ModifyEventSubscriptionMessage { + /** + * The name of the event notification subscription. + */ + SubscriptionName: String; + /** + * The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + */ + SnsTopicArn?: String; + /** + * The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot + */ + SourceType?: String; + /** + * A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action. + */ + EventCategories?: EventCategoriesList; + /** + * A Boolean value; set to true to activate the subscription. + */ + Enabled?: BooleanOptional; + } + export interface ModifyEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface OptionGroupMembership { + /** + * The name of the option group that the instance belongs to. + */ + OptionGroupName?: String; + /** + * The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed. + */ + Status?: String; + } + export type OptionGroupMembershipList = OptionGroupMembership[]; + export interface OrderableDBInstanceOption { + /** + * The engine type of a DB instance. + */ + Engine?: String; + /** + * The engine version of a DB instance. + */ + EngineVersion?: String; + /** + * The DB instance class for a DB instance. + */ + DBInstanceClass?: String; + /** + * The license model for a DB instance. + */ + LicenseModel?: String; + /** + * A list of Availability Zones for a DB instance. + */ + AvailabilityZones?: AvailabilityZoneList; + /** + * Indicates whether a DB instance is Multi-AZ capable. + */ + MultiAZCapable?: Boolean; + /** + * Indicates whether a DB instance can have a Read Replica. + */ + ReadReplicaCapable?: Boolean; + /** + * Indicates whether a DB instance is in a VPC. + */ + Vpc?: Boolean; + /** + * Indicates whether a DB instance supports encrypted storage. + */ + SupportsStorageEncryption?: Boolean; + /** + * Indicates the storage type for a DB instance. + */ + StorageType?: String; + /** + * Indicates whether a DB instance supports provisioned IOPS. + */ + SupportsIops?: Boolean; + /** + * Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds. + */ + SupportsEnhancedMonitoring?: Boolean; + /** + * Indicates whether a DB instance supports IAM database authentication. + */ + SupportsIAMDatabaseAuthentication?: Boolean; + /** + * True if a DB instance supports Performance Insights, otherwise false. + */ + SupportsPerformanceInsights?: Boolean; + /** + * Minimum storage size for a DB instance. + */ + MinStorageSize?: IntegerOptional; + /** + * Maximum storage size for a DB instance. + */ + MaxStorageSize?: IntegerOptional; + /** + * Minimum total provisioned IOPS for a DB instance. + */ + MinIopsPerDbInstance?: IntegerOptional; + /** + * Maximum total provisioned IOPS for a DB instance. + */ + MaxIopsPerDbInstance?: IntegerOptional; + /** + * Minimum provisioned IOPS per GiB for a DB instance. + */ + MinIopsPerGib?: DoubleOptional; + /** + * Maximum provisioned IOPS per GiB for a DB instance. + */ + MaxIopsPerGib?: DoubleOptional; + } + export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[]; + export interface OrderableDBInstanceOptionsMessage { + /** + * An OrderableDBInstanceOption structure containing information about orderable options for the DB instance. + */ + OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList; + /** + * An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export interface Parameter { + /** + * Specifies the name of the parameter. + */ + ParameterName?: String; + /** + * Specifies the value of the parameter. + */ + ParameterValue?: String; + /** + * Provides a description of the parameter. + */ + Description?: String; + /** + * Indicates the source of the parameter value. + */ + Source?: String; + /** + * Specifies the engine specific parameters type. + */ + ApplyType?: String; + /** + * Specifies the valid data type for the parameter. + */ + DataType?: String; + /** + * Specifies the valid range of values for the parameter. + */ + AllowedValues?: String; + /** + * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. + */ + IsModifiable?: Boolean; + /** + * The earliest engine version to which the parameter can apply. + */ + MinimumEngineVersion?: String; + /** + * Indicates when to apply parameter updates. + */ + ApplyMethod?: ApplyMethod; + } + export type ParametersList = Parameter[]; + export interface PendingCloudwatchLogsExports { + /** + * Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. + */ + LogTypesToEnable?: LogTypeList; + /** + * Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. + */ + LogTypesToDisable?: LogTypeList; + } + export interface PendingMaintenanceAction { + /** + * The type of pending maintenance action that is available for the resource. + */ + Action?: String; + /** + * The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored. + */ + AutoAppliedAfterDate?: TStamp; + /** + * The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored. + */ + ForcedApplyDate?: TStamp; + /** + * Indicates the type of opt-in request that has been received for the resource. + */ + OptInStatus?: String; + /** + * The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate. + */ + CurrentApplyDate?: TStamp; + /** + * A description providing more detail about the maintenance action. + */ + Description?: String; + } + export type PendingMaintenanceActionDetails = PendingMaintenanceAction[]; + export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[]; + export interface PendingMaintenanceActionsMessage { + /** + * A list of the pending maintenance actions for the resource. + */ + PendingMaintenanceActions?: PendingMaintenanceActions; + /** + * An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords. + */ + Marker?: String; + } + export interface PendingModifiedValues { + /** + * Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied. + */ + DBInstanceClass?: String; + /** + * Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied. + */ + AllocatedStorage?: IntegerOptional; + /** + * Contains the pending or currently-in-progress change of the master credentials for the DB instance. + */ + MasterUserPassword?: String; + /** + * Specifies the pending port for the DB instance. + */ + Port?: IntegerOptional; + /** + * Specifies the pending number of days for which automated backups are retained. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. + */ + MultiAZ?: BooleanOptional; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license + */ + LicenseModel?: String; + /** + * Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied. + */ + Iops?: IntegerOptional; + /** + * Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied. + */ + DBInstanceIdentifier?: String; + /** + * Specifies the storage type to be associated with the DB instance. + */ + StorageType?: String; + /** + * Specifies the identifier of the CA certificate for the DB instance. + */ + CACertificateIdentifier?: String; + /** + * The new DB subnet group for the DB instance. + */ + DBSubnetGroupName?: String; + /** + * Specifies the CloudWatch logs to be exported. + */ + PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports; + } + export interface PromoteReadReplicaDBClusterMessage { + /** + * Not supported. + */ + DBClusterIdentifier: String; + } + export interface PromoteReadReplicaDBClusterResult { + DBCluster?: DBCluster; + } + export interface Range { + /** + * The minimum value in the range. + */ + From?: Integer; + /** + * The maximum value in the range. + */ + To?: Integer; + /** + * The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000... + */ + Step?: IntegerOptional; + } + export type RangeList = Range[]; + export type ReadReplicaDBClusterIdentifierList = String[]; + export type ReadReplicaDBInstanceIdentifierList = String[]; + export type ReadReplicaIdentifierList = String[]; + export interface RebootDBInstanceMessage { + /** + * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * When true, the reboot is conducted through a MultiAZ failover. Constraint: You can't specify true if the instance is not configured for MultiAZ. + */ + ForceFailover?: BooleanOptional; + } + export interface RebootDBInstanceResult { + DBInstance?: DBInstance; + } + export interface RemoveRoleFromDBClusterMessage { + /** + * The name of the DB cluster to disassociate the IAM role from. + */ + DBClusterIdentifier: String; + /** + * The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole. + */ + RoleArn: String; + } + export interface RemoveSourceIdentifierFromSubscriptionMessage { + /** + * The name of the event notification subscription you want to remove a source identifier from. + */ + SubscriptionName: String; + /** + * The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group. + */ + SourceIdentifier: String; + } + export interface RemoveSourceIdentifierFromSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface RemoveTagsFromResourceMessage { + /** + * The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). + */ + ResourceName: String; + /** + * The tag key (name) of the tag to be removed. + */ + TagKeys: KeyList; + } + export interface ResetDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group to reset. + */ + DBClusterParameterGroupName: String; + /** + * A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter. + */ + ResetAllParameters?: Boolean; + /** + * A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true. + */ + Parameters?: ParametersList; + } + export interface ResetDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: Must match the name of an existing DBParameterGroup. + */ + DBParameterGroupName: String; + /** + * Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values. Default: true + */ + ResetAllParameters?: Boolean; + /** + * To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Valid Values (for Apply method): pending-reboot + */ + Parameters?: ParametersList; + } + export interface ResourcePendingMaintenanceActions { + /** + * The ARN of the resource that has pending maintenance actions. + */ + ResourceIdentifier?: String; + /** + * A list that provides details about the pending maintenance actions for the resource. + */ + PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails; + } + export interface RestoreDBClusterFromSnapshotMessage { + /** + * Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id + */ + DBClusterIdentifier: String; + /** + * The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot. + */ + SnapshotIdentifier: String; + /** + * The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source + */ + Engine: String; + /** + * The version of the database engine to use for the new DB cluster. + */ + EngineVersion?: String; + /** + * The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster. + */ + Port?: IntegerOptional; + /** + * The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * Not supported. + */ + DatabaseName?: String; + /** + * The name of the option group to use for the restored DB cluster. + */ + OptionGroupName?: String; + /** + * A list of VPC security groups that the new DB cluster will belong to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The tags to be assigned to the restored DB cluster. + */ + Tags?: TagList; + /** + * The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If you do not specify a value for the KmsKeyId parameter, then the following will occur: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted. + */ + KmsKeyId?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The name of the DB cluster parameter group to associate with the new DB cluster. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName?: String; + } + export interface RestoreDBClusterFromSnapshotResult { + DBCluster?: DBCluster; + } + export interface RestoreDBClusterToPointInTimeMessage { + /** + * The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens + */ + DBClusterIdentifier: String; + /** + * The type of restore to be performed. The only type of restore currently supported is full-copy (the default). + */ + RestoreType?: String; + /** + * The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster. + */ + SourceDBClusterIdentifier: String; + /** + * The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Must be specified if UseLatestRestorableTime parameter is not provided Cannot be specified if UseLatestRestorableTime parameter is true Cannot be specified if RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z + */ + RestoreToTime?: TStamp; + /** + * A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be specified if RestoreToTime parameter is provided. + */ + UseLatestRestorableTime?: Boolean; + /** + * The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster. + */ + Port?: IntegerOptional; + /** + * The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * The name of the option group for the new DB cluster. + */ + OptionGroupName?: String; + /** + * A list of VPC security groups that the new DB cluster belongs to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The tags to be applied to the restored DB cluster. + */ + Tags?: TagList; + /** + * The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter. If you do not specify a value for the KmsKeyId parameter, then the following will occur: If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. If the DB cluster is not encrypted, then the restored DB cluster is not encrypted. If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected. + */ + KmsKeyId?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The name of the DB cluster parameter group to associate with the new DB cluster. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName?: String; + } + export interface RestoreDBClusterToPointInTimeResult { + DBCluster?: DBCluster; + } + export type SourceIdsList = String[]; + export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string; + export type String = string; + export interface Subnet { + /** + * Specifies the identifier of the subnet. + */ + SubnetIdentifier?: String; + /** + * Specifies the EC2 Availability Zone that the subnet is in. + */ + SubnetAvailabilityZone?: AvailabilityZone; + /** + * Specifies the status of the subnet. + */ + SubnetStatus?: String; + } + export type SubnetIdentifierList = String[]; + export type SubnetList = Subnet[]; + export type SupportedCharacterSetsList = CharacterSet[]; + export type SupportedTimezonesList = Timezone[]; + export type TStamp = Date; + export interface Tag { + /** + * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Key?: String; + /** + * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Value?: String; + } + export type TagList = Tag[]; + export interface TagListMessage { + /** + * List of tags returned by the ListTagsForResource operation. + */ + TagList?: TagList; + } + export interface Timezone { + /** + * The name of the time zone. + */ + TimezoneName?: String; + } + export interface UpgradeTarget { + /** + * The name of the upgrade target database engine. + */ + Engine?: String; + /** + * The version number of the upgrade target database engine. + */ + EngineVersion?: String; + /** + * The version of the database engine that a DB instance can be upgraded to. + */ + Description?: String; + /** + * A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true. + */ + AutoUpgrade?: Boolean; + /** + * A value that indicates whether a database engine is upgraded to a major version. + */ + IsMajorVersionUpgrade?: Boolean; + } + export interface ValidDBInstanceModificationsMessage { + /** + * Valid storage options for your DB instance. + */ + Storage?: ValidStorageOptionsList; + } + export interface ValidStorageOptions { + /** + * The valid storage types for your DB instance. For example, gp2, io1. + */ + StorageType?: String; + /** + * The valid range of storage in gibibytes. For example, 100 to 16384. + */ + StorageSize?: RangeList; + /** + * The valid range of provisioned IOPS. For example, 1000-20000. + */ + ProvisionedIops?: RangeList; + /** + * The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage. + */ + IopsToStorageRatio?: DoubleRangeList; + } + export type ValidStorageOptionsList = ValidStorageOptions[]; + export type ValidUpgradeTargetList = UpgradeTarget[]; + export type VpcSecurityGroupIdList = String[]; + export interface VpcSecurityGroupMembership { + /** + * The name of the VPC security group. + */ + VpcSecurityGroupId?: String; + /** + * The status of the VPC security group. + */ + Status?: String; + } + export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-10-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Neptune client. + */ + export import Types = Neptune; +} +export = Neptune; diff --git a/node_modules/aws-sdk/clients/neptune.js b/node_modules/aws-sdk/clients/neptune.js new file mode 100644 index 0000000..db8e040 --- /dev/null +++ b/node_modules/aws-sdk/clients/neptune.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['neptune'] = {}; +AWS.Neptune = Service.defineService('neptune', ['2014-10-31']); +Object.defineProperty(apiLoader.services['neptune'], '2014-10-31', { + get: function get() { + var model = require('../apis/neptune-2014-10-31.min.json'); + model.paginators = require('../apis/neptune-2014-10-31.paginators.json').pagination; + model.waiters = require('../apis/neptune-2014-10-31.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Neptune; diff --git a/node_modules/aws-sdk/clients/opsworks.d.ts b/node_modules/aws-sdk/clients/opsworks.d.ts new file mode 100644 index 0000000..a34c934 --- /dev/null +++ b/node_modules/aws-sdk/clients/opsworks.d.ts @@ -0,0 +1,3588 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class OpsWorks extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: OpsWorks.Types.ClientConfiguration) + config: Config & OpsWorks.Types.ClientConfiguration; + /** + * Assign a registered instance to a layer. You can assign registered on-premises instances to any layer type. You can assign registered Amazon EC2 instances only to custom layers. You cannot use this action with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + assignInstance(params: OpsWorks.Types.AssignInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assign a registered instance to a layer. You can assign registered on-premises instances to any layer type. You can assign registered Amazon EC2 instances only to custom layers. You cannot use this action with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + assignInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + assignVolume(params: OpsWorks.Types.AssignVolumeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + assignVolume(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + associateElasticIp(params: OpsWorks.Types.AssociateElasticIpRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + associateElasticIp(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing. You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + attachElasticLoadBalancer(params: OpsWorks.Types.AttachElasticLoadBalancerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing. You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + attachElasticLoadBalancer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + cloneStack(params: OpsWorks.Types.CloneStackRequest, callback?: (err: AWSError, data: OpsWorks.Types.CloneStackResult) => void): Request; + /** + * Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + cloneStack(callback?: (err: AWSError, data: OpsWorks.Types.CloneStackResult) => void): Request; + /** + * Creates an app for a specified stack. For more information, see Creating Apps. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createApp(params: OpsWorks.Types.CreateAppRequest, callback?: (err: AWSError, data: OpsWorks.Types.CreateAppResult) => void): Request; + /** + * Creates an app for a specified stack. For more information, see Creating Apps. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createApp(callback?: (err: AWSError, data: OpsWorks.Types.CreateAppResult) => void): Request; + /** + * Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands. Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createDeployment(params: OpsWorks.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: OpsWorks.Types.CreateDeploymentResult) => void): Request; + /** + * Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands. Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createDeployment(callback?: (err: AWSError, data: OpsWorks.Types.CreateDeploymentResult) => void): Request; + /** + * Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createInstance(params: OpsWorks.Types.CreateInstanceRequest, callback?: (err: AWSError, data: OpsWorks.Types.CreateInstanceResult) => void): Request; + /** + * Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createInstance(callback?: (err: AWSError, data: OpsWorks.Types.CreateInstanceResult) => void): Request; + /** + * Creates a layer. For more information, see How to Create a Layer. You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createLayer(params: OpsWorks.Types.CreateLayerRequest, callback?: (err: AWSError, data: OpsWorks.Types.CreateLayerResult) => void): Request; + /** + * Creates a layer. For more information, see How to Create a Layer. You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + createLayer(callback?: (err: AWSError, data: OpsWorks.Types.CreateLayerResult) => void): Request; + /** + * Creates a new stack. For more information, see Create a New Stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + createStack(params: OpsWorks.Types.CreateStackRequest, callback?: (err: AWSError, data: OpsWorks.Types.CreateStackResult) => void): Request; + /** + * Creates a new stack. For more information, see Create a New Stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + createStack(callback?: (err: AWSError, data: OpsWorks.Types.CreateStackResult) => void): Request; + /** + * Creates a new user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + createUserProfile(params: OpsWorks.Types.CreateUserProfileRequest, callback?: (err: AWSError, data: OpsWorks.Types.CreateUserProfileResult) => void): Request; + /** + * Creates a new user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + createUserProfile(callback?: (err: AWSError, data: OpsWorks.Types.CreateUserProfileResult) => void): Request; + /** + * Deletes a specified app. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteApp(params: OpsWorks.Types.DeleteAppRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified app. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteApp(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. For more information, see Deleting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteInstance(params: OpsWorks.Types.DeleteInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. For more information, see Deleting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteLayer(params: OpsWorks.Types.DeleteLayerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteLayer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteStack(params: OpsWorks.Types.DeleteStackRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deleteStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + deleteUserProfile(params: OpsWorks.Types.DeleteUserProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + deleteUserProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html. + */ + deregisterEcsCluster(params: OpsWorks.Types.DeregisterEcsClusterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html. + */ + deregisterEcsCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterElasticIp(params: OpsWorks.Types.DeregisterElasticIpRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterElasticIp(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterInstance(params: OpsWorks.Types.DeregisterInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters an Amazon RDS instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterRdsDbInstance(params: OpsWorks.Types.DeregisterRdsDbInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters an Amazon RDS instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterRdsDbInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterVolume(params: OpsWorks.Types.DeregisterVolumeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + deregisterVolume(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager. + */ + describeAgentVersions(params: OpsWorks.Types.DescribeAgentVersionsRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeAgentVersionsResult) => void): Request; + /** + * Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager. + */ + describeAgentVersions(callback?: (err: AWSError, data: OpsWorks.Types.DescribeAgentVersionsResult) => void): Request; + /** + * Requests a description of a specified set of apps. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeApps(params: OpsWorks.Types.DescribeAppsRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeAppsResult) => void): Request; + /** + * Requests a description of a specified set of apps. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeApps(callback?: (err: AWSError, data: OpsWorks.Types.DescribeAppsResult) => void): Request; + /** + * Describes the results of specified commands. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeCommands(params: OpsWorks.Types.DescribeCommandsRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeCommandsResult) => void): Request; + /** + * Describes the results of specified commands. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeCommands(callback?: (err: AWSError, data: OpsWorks.Types.DescribeCommandsResult) => void): Request; + /** + * Requests a description of a specified set of deployments. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeDeployments(params: OpsWorks.Types.DescribeDeploymentsRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeDeploymentsResult) => void): Request; + /** + * Requests a description of a specified set of deployments. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeDeployments(callback?: (err: AWSError, data: OpsWorks.Types.DescribeDeploymentsResult) => void): Request; + /** + * Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. + */ + describeEcsClusters(params: OpsWorks.Types.DescribeEcsClustersRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeEcsClustersResult) => void): Request; + /** + * Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. + */ + describeEcsClusters(callback?: (err: AWSError, data: OpsWorks.Types.DescribeEcsClustersResult) => void): Request; + /** + * Describes Elastic IP addresses. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeElasticIps(params: OpsWorks.Types.DescribeElasticIpsRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeElasticIpsResult) => void): Request; + /** + * Describes Elastic IP addresses. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeElasticIps(callback?: (err: AWSError, data: OpsWorks.Types.DescribeElasticIpsResult) => void): Request; + /** + * Describes a stack's Elastic Load Balancing instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeElasticLoadBalancers(params: OpsWorks.Types.DescribeElasticLoadBalancersRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeElasticLoadBalancersResult) => void): Request; + /** + * Describes a stack's Elastic Load Balancing instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeElasticLoadBalancers(callback?: (err: AWSError, data: OpsWorks.Types.DescribeElasticLoadBalancersResult) => void): Request; + /** + * Requests a description of a set of instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeInstances(params: OpsWorks.Types.DescribeInstancesRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Requests a description of a set of instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeInstances(callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Requests a description of one or more layers in a specified stack. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeLayers(params: OpsWorks.Types.DescribeLayersRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeLayersResult) => void): Request; + /** + * Requests a description of one or more layers in a specified stack. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeLayers(callback?: (err: AWSError, data: OpsWorks.Types.DescribeLayersResult) => void): Request; + /** + * Describes load-based auto scaling configurations for specified layers. You must specify at least one of the parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeLoadBasedAutoScaling(params: OpsWorks.Types.DescribeLoadBasedAutoScalingRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeLoadBasedAutoScalingResult) => void): Request; + /** + * Describes load-based auto scaling configurations for specified layers. You must specify at least one of the parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeLoadBasedAutoScaling(callback?: (err: AWSError, data: OpsWorks.Types.DescribeLoadBasedAutoScalingResult) => void): Request; + /** + * Describes a user's SSH information. Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeMyUserProfile(callback?: (err: AWSError, data: OpsWorks.Types.DescribeMyUserProfileResult) => void): Request; + /** + * Describes the operating systems that are supported by AWS OpsWorks Stacks. + */ + describeOperatingSystems(callback?: (err: AWSError, data: OpsWorks.Types.DescribeOperatingSystemsResponse) => void): Request; + /** + * Describes the permissions for a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + describePermissions(params: OpsWorks.Types.DescribePermissionsRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribePermissionsResult) => void): Request; + /** + * Describes the permissions for a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + describePermissions(callback?: (err: AWSError, data: OpsWorks.Types.DescribePermissionsResult) => void): Request; + /** + * Describe an instance's RAID arrays. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeRaidArrays(params: OpsWorks.Types.DescribeRaidArraysRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeRaidArraysResult) => void): Request; + /** + * Describe an instance's RAID arrays. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeRaidArrays(callback?: (err: AWSError, data: OpsWorks.Types.DescribeRaidArraysResult) => void): Request; + /** + * Describes Amazon RDS instances. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. + */ + describeRdsDbInstances(params: OpsWorks.Types.DescribeRdsDbInstancesRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeRdsDbInstancesResult) => void): Request; + /** + * Describes Amazon RDS instances. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. + */ + describeRdsDbInstances(callback?: (err: AWSError, data: OpsWorks.Types.DescribeRdsDbInstancesResult) => void): Request; + /** + * Describes AWS OpsWorks Stacks service errors. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. + */ + describeServiceErrors(params: OpsWorks.Types.DescribeServiceErrorsRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeServiceErrorsResult) => void): Request; + /** + * Describes AWS OpsWorks Stacks service errors. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. + */ + describeServiceErrors(callback?: (err: AWSError, data: OpsWorks.Types.DescribeServiceErrorsResult) => void): Request; + /** + * Requests a description of a stack's provisioning parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeStackProvisioningParameters(params: OpsWorks.Types.DescribeStackProvisioningParametersRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeStackProvisioningParametersResult) => void): Request; + /** + * Requests a description of a stack's provisioning parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeStackProvisioningParameters(callback?: (err: AWSError, data: OpsWorks.Types.DescribeStackProvisioningParametersResult) => void): Request; + /** + * Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeStackSummary(params: OpsWorks.Types.DescribeStackSummaryRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeStackSummaryResult) => void): Request; + /** + * Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeStackSummary(callback?: (err: AWSError, data: OpsWorks.Types.DescribeStackSummaryResult) => void): Request; + /** + * Requests a description of one or more stacks. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeStacks(params: OpsWorks.Types.DescribeStacksRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeStacksResult) => void): Request; + /** + * Requests a description of one or more stacks. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeStacks(callback?: (err: AWSError, data: OpsWorks.Types.DescribeStacksResult) => void): Request; + /** + * Describes time-based auto scaling configurations for specified instances. You must specify at least one of the parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeTimeBasedAutoScaling(params: OpsWorks.Types.DescribeTimeBasedAutoScalingRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeTimeBasedAutoScalingResult) => void): Request; + /** + * Describes time-based auto scaling configurations for specified instances. You must specify at least one of the parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeTimeBasedAutoScaling(callback?: (err: AWSError, data: OpsWorks.Types.DescribeTimeBasedAutoScalingResult) => void): Request; + /** + * Describe specified users. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeUserProfiles(params: OpsWorks.Types.DescribeUserProfilesRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeUserProfilesResult) => void): Request; + /** + * Describe specified users. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeUserProfiles(callback?: (err: AWSError, data: OpsWorks.Types.DescribeUserProfilesResult) => void): Request; + /** + * Describes an instance's Amazon EBS volumes. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeVolumes(params: OpsWorks.Types.DescribeVolumesRequest, callback?: (err: AWSError, data: OpsWorks.Types.DescribeVolumesResult) => void): Request; + /** + * Describes an instance's Amazon EBS volumes. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + describeVolumes(callback?: (err: AWSError, data: OpsWorks.Types.DescribeVolumesResult) => void): Request; + /** + * Detaches a specified Elastic Load Balancing instance from its layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + detachElasticLoadBalancer(params: OpsWorks.Types.DetachElasticLoadBalancerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a specified Elastic Load Balancing instance from its layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + detachElasticLoadBalancer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + disassociateElasticIp(params: OpsWorks.Types.DisassociateElasticIpRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + disassociateElasticIp(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets a generated host name for the specified layer, based on the current host name theme. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + getHostnameSuggestion(params: OpsWorks.Types.GetHostnameSuggestionRequest, callback?: (err: AWSError, data: OpsWorks.Types.GetHostnameSuggestionResult) => void): Request; + /** + * Gets a generated host name for the specified layer, based on the current host name theme. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + getHostnameSuggestion(callback?: (err: AWSError, data: OpsWorks.Types.GetHostnameSuggestionResult) => void): Request; + /** + * This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period. + */ + grantAccess(params: OpsWorks.Types.GrantAccessRequest, callback?: (err: AWSError, data: OpsWorks.Types.GrantAccessResult) => void): Request; + /** + * This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period. + */ + grantAccess(callback?: (err: AWSError, data: OpsWorks.Types.GrantAccessResult) => void): Request; + /** + * Returns a list of tags that are applied to the specified stack or layer. + */ + listTags(params: OpsWorks.Types.ListTagsRequest, callback?: (err: AWSError, data: OpsWorks.Types.ListTagsResult) => void): Request; + /** + * Returns a list of tags that are applied to the specified stack or layer. + */ + listTags(callback?: (err: AWSError, data: OpsWorks.Types.ListTagsResult) => void): Request; + /** + * Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + rebootInstance(params: OpsWorks.Types.RebootInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + rebootInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerEcsCluster(params: OpsWorks.Types.RegisterEcsClusterRequest, callback?: (err: AWSError, data: OpsWorks.Types.RegisterEcsClusterResult) => void): Request; + /** + * Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerEcsCluster(callback?: (err: AWSError, data: OpsWorks.Types.RegisterEcsClusterResult) => void): Request; + /** + * Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerElasticIp(params: OpsWorks.Types.RegisterElasticIpRequest, callback?: (err: AWSError, data: OpsWorks.Types.RegisterElasticIpResult) => void): Request; + /** + * Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerElasticIp(callback?: (err: AWSError, data: OpsWorks.Types.RegisterElasticIpResult) => void): Request; + /** + * Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack. We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack. Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerInstance(params: OpsWorks.Types.RegisterInstanceRequest, callback?: (err: AWSError, data: OpsWorks.Types.RegisterInstanceResult) => void): Request; + /** + * Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack. We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack. Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerInstance(callback?: (err: AWSError, data: OpsWorks.Types.RegisterInstanceResult) => void): Request; + /** + * Registers an Amazon RDS instance with a stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerRdsDbInstance(params: OpsWorks.Types.RegisterRdsDbInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers an Amazon RDS instance with a stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerRdsDbInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerVolume(params: OpsWorks.Types.RegisterVolumeRequest, callback?: (err: AWSError, data: OpsWorks.Types.RegisterVolumeResult) => void): Request; + /** + * Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + registerVolume(callback?: (err: AWSError, data: OpsWorks.Types.RegisterVolumeResult) => void): Request; + /** + * Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances. To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + setLoadBasedAutoScaling(params: OpsWorks.Types.SetLoadBasedAutoScalingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances. To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + setLoadBasedAutoScaling(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Specifies a user's permissions. For more information, see Security and Permissions. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + setPermission(params: OpsWorks.Types.SetPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Specifies a user's permissions. For more information, see Security and Permissions. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + setPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + setTimeBasedAutoScaling(params: OpsWorks.Types.SetTimeBasedAutoScalingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + setTimeBasedAutoScaling(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + startInstance(params: OpsWorks.Types.StartInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + startInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts a stack's instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + startStack(params: OpsWorks.Types.StartStackRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts a stack's instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + startStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + stopInstance(params: OpsWorks.Types.StopInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + stopInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + stopStack(params: OpsWorks.Types.StopStackRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + stopStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide. + */ + tagResource(params: OpsWorks.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + unassignInstance(params: OpsWorks.Types.UnassignInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + unassignInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + unassignVolume(params: OpsWorks.Types.UnassignVolumeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + unassignVolume(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags from a specified stack or layer. + */ + untagResource(params: OpsWorks.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes tags from a specified stack or layer. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified app. Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateApp(params: OpsWorks.Types.UpdateAppRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified app. Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateApp(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a registered Elastic IP address's name. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateElasticIp(params: OpsWorks.Types.UpdateElasticIpRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a registered Elastic IP address's name. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateElasticIp(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateInstance(params: OpsWorks.Types.UpdateInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateLayer(params: OpsWorks.Types.UpdateLayerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateLayer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a user's SSH public key. Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + updateMyUserProfile(params: OpsWorks.Types.UpdateMyUserProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a user's SSH public key. Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + updateMyUserProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates an Amazon RDS instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateRdsDbInstance(params: OpsWorks.Types.UpdateRdsDbInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates an Amazon RDS instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateRdsDbInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateStack(params: OpsWorks.Types.UpdateStackRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + updateUserProfile(params: OpsWorks.Types.UpdateUserProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a specified user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. + */ + updateUserProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateVolume(params: OpsWorks.Types.UpdateVolumeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. + */ + updateVolume(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the appExists state by periodically calling the underlying OpsWorks.describeAppsoperation every 1 seconds (at most 40 times). + */ + waitFor(state: "appExists", params: OpsWorks.Types.DescribeAppsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorks.Types.DescribeAppsResult) => void): Request; + /** + * Waits for the appExists state by periodically calling the underlying OpsWorks.describeAppsoperation every 1 seconds (at most 40 times). + */ + waitFor(state: "appExists", callback?: (err: AWSError, data: OpsWorks.Types.DescribeAppsResult) => void): Request; + /** + * Waits for the deploymentSuccessful state by periodically calling the underlying OpsWorks.describeDeploymentsoperation every 15 seconds (at most 40 times). Wait until a deployment has completed successfully. + */ + waitFor(state: "deploymentSuccessful", params: OpsWorks.Types.DescribeDeploymentsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorks.Types.DescribeDeploymentsResult) => void): Request; + /** + * Waits for the deploymentSuccessful state by periodically calling the underlying OpsWorks.describeDeploymentsoperation every 15 seconds (at most 40 times). Wait until a deployment has completed successfully. + */ + waitFor(state: "deploymentSuccessful", callback?: (err: AWSError, data: OpsWorks.Types.DescribeDeploymentsResult) => void): Request; + /** + * Waits for the instanceOnline state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is online. + */ + waitFor(state: "instanceOnline", params: OpsWorks.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceOnline state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is online. + */ + waitFor(state: "instanceOnline", callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceRegistered state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is registered. + */ + waitFor(state: "instanceRegistered", params: OpsWorks.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceRegistered state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is registered. + */ + waitFor(state: "instanceRegistered", callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceStopped state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is stopped. + */ + waitFor(state: "instanceStopped", params: OpsWorks.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceStopped state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is stopped. + */ + waitFor(state: "instanceStopped", callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceTerminated state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is terminated. + */ + waitFor(state: "instanceTerminated", params: OpsWorks.Types.DescribeInstancesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; + /** + * Waits for the instanceTerminated state by periodically calling the underlying OpsWorks.describeInstancesoperation every 15 seconds (at most 40 times). Wait until OpsWorks instance is terminated. + */ + waitFor(state: "instanceTerminated", callback?: (err: AWSError, data: OpsWorks.Types.DescribeInstancesResult) => void): Request; +} +declare namespace OpsWorks { + export interface AgentVersion { + /** + * The agent version. + */ + Version?: String; + /** + * The configuration manager. + */ + ConfigurationManager?: StackConfigurationManager; + } + export type AgentVersions = AgentVersion[]; + export interface App { + /** + * The app ID. + */ + AppId?: String; + /** + * The app stack ID. + */ + StackId?: String; + /** + * The app's short name. + */ + Shortname?: String; + /** + * The app name. + */ + Name?: String; + /** + * A description of the app. + */ + Description?: String; + /** + * The app's data sources. + */ + DataSources?: DataSources; + /** + * The app type. + */ + Type?: AppType; + /** + * A Source object that describes the app repository. + */ + AppSource?: Source; + /** + * The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com' + */ + Domains?: Strings; + /** + * Whether to enable SSL for the app. + */ + EnableSsl?: Boolean; + /** + * An SslConfiguration object with the SSL configuration. + */ + SslConfiguration?: SslConfiguration; + /** + * The stack attributes. + */ + Attributes?: AppAttributes; + /** + * When the app was created. + */ + CreatedAt?: String; + /** + * An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message. + */ + Environment?: EnvironmentVariables; + } + export type AppAttributes = {[key: string]: String}; + export type AppAttributesKeys = "DocumentRoot"|"RailsEnv"|"AutoBundleOnDeploy"|"AwsFlowRubySettings"|string; + export type AppType = "aws-flow-ruby"|"java"|"rails"|"php"|"nodejs"|"static"|"other"|string; + export type Apps = App[]; + export type Architecture = "x86_64"|"i386"|string; + export interface AssignInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + /** + * The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer. + */ + LayerIds: Strings; + } + export interface AssignVolumeRequest { + /** + * The volume ID. + */ + VolumeId: String; + /** + * The instance ID. + */ + InstanceId?: String; + } + export interface AssociateElasticIpRequest { + /** + * The Elastic IP address. + */ + ElasticIp: String; + /** + * The instance ID. + */ + InstanceId?: String; + } + export interface AttachElasticLoadBalancerRequest { + /** + * The Elastic Load Balancing instance's name. + */ + ElasticLoadBalancerName: String; + /** + * The ID of the layer to which the Elastic Load Balancing instance is to be attached. + */ + LayerId: String; + } + export interface AutoScalingThresholds { + /** + * The number of instances to add or remove when the load exceeds a threshold. + */ + InstanceCount?: Integer; + /** + * The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. + */ + ThresholdsWaitTime?: Minute; + /** + * The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online. + */ + IgnoreMetricsTime?: Minute; + /** + * The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. + */ + CpuThreshold?: Double; + /** + * The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. + */ + MemoryThreshold?: Double; + /** + * The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing). + */ + LoadThreshold?: Double; + /** + * Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf. + */ + Alarms?: Strings; + } + export type AutoScalingType = "load"|"timer"|string; + export interface BlockDeviceMapping { + /** + * The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name. + */ + DeviceName?: String; + /** + * Suppresses the specified device included in the AMI's block device mapping. + */ + NoDevice?: String; + /** + * The virtual device name. For more information, see BlockDeviceMapping. + */ + VirtualName?: String; + /** + * An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched. + */ + Ebs?: EbsBlockDevice; + } + export type BlockDeviceMappings = BlockDeviceMapping[]; + export type Boolean = boolean; + export interface ChefConfiguration { + /** + * Whether to enable Berkshelf. + */ + ManageBerkshelf?: Boolean; + /** + * The Berkshelf version. + */ + BerkshelfVersion?: String; + } + export interface CloneStackRequest { + /** + * The source stack ID. + */ + SourceStackId: String; + /** + * The cloned stack name. + */ + Name?: String; + /** + * The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints. + */ + Region?: String; + /** + * The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later. If your account supports EC2 Classic, the default value is no VPC. If your account does not support EC2 Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: It must belong to a VPC in your account that is in the specified region. You must specify a value for DefaultSubnetId. For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms. + */ + VpcId?: String; + /** + * A list of stack attributes and values as key/value pairs to be added to the cloned stack. + */ + Attributes?: StackAttributes; + /** + * The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers. You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly. + */ + ServiceRoleArn: String; + /** + * The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. + */ + DefaultInstanceProfileArn?: String; + /** + * The stack's operating system, which must be set to one of the following. A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs. The default option is the parent stack's operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems. You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux. + */ + DefaultOs?: String; + /** + * The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are: Baked_Goods Clouds Europe_Cities Fruits Greek_Deities Legendary_creatures_from_Japan Planets_and_Moons Roman_Deities Scottish_Islands US_Cities Wild_Cats To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme. + */ + HostnameTheme?: String; + /** + * The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description. + */ + DefaultAvailabilityZone?: String; + /** + * The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description. + */ + DefaultSubnetId?: String; + /** + * A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes + */ + CustomJson?: String; + /** + * The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. + */ + ConfigurationManager?: StackConfigurationManager; + /** + * A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack. + */ + ChefConfiguration?: ChefConfiguration; + /** + * Whether to use custom cookbooks. + */ + UseCustomCookbooks?: Boolean; + /** + * Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings: True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group. False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see Create a New Stack. + */ + UseOpsworksSecurityGroups?: Boolean; + CustomCookbooksSource?: Source; + /** + * A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. + */ + DefaultSshKeyName?: String; + /** + * Whether to clone the source stack's permissions. + */ + ClonePermissions?: Boolean; + /** + * A list of source stack app IDs to be included in the cloned stack. + */ + CloneAppIds?: Strings; + /** + * The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. + */ + DefaultRootDeviceType?: RootDeviceType; + /** + * The default AWS OpsWorks Stacks agent version. You have the following options: Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. + */ + AgentVersion?: String; + } + export interface CloneStackResult { + /** + * The cloned stack ID. + */ + StackId?: String; + } + export interface CloudWatchLogsConfiguration { + /** + * Whether CloudWatch Logs is enabled for a layer. + */ + Enabled?: Boolean; + /** + * A list of configuration options for CloudWatch Logs. + */ + LogStreams?: CloudWatchLogsLogStreams; + } + export type CloudWatchLogsEncoding = "ascii"|"big5"|"big5hkscs"|"cp037"|"cp424"|"cp437"|"cp500"|"cp720"|"cp737"|"cp775"|"cp850"|"cp852"|"cp855"|"cp856"|"cp857"|"cp858"|"cp860"|"cp861"|"cp862"|"cp863"|"cp864"|"cp865"|"cp866"|"cp869"|"cp874"|"cp875"|"cp932"|"cp949"|"cp950"|"cp1006"|"cp1026"|"cp1140"|"cp1250"|"cp1251"|"cp1252"|"cp1253"|"cp1254"|"cp1255"|"cp1256"|"cp1257"|"cp1258"|"euc_jp"|"euc_jis_2004"|"euc_jisx0213"|"euc_kr"|"gb2312"|"gbk"|"gb18030"|"hz"|"iso2022_jp"|"iso2022_jp_1"|"iso2022_jp_2"|"iso2022_jp_2004"|"iso2022_jp_3"|"iso2022_jp_ext"|"iso2022_kr"|"latin_1"|"iso8859_2"|"iso8859_3"|"iso8859_4"|"iso8859_5"|"iso8859_6"|"iso8859_7"|"iso8859_8"|"iso8859_9"|"iso8859_10"|"iso8859_13"|"iso8859_14"|"iso8859_15"|"iso8859_16"|"johab"|"koi8_r"|"koi8_u"|"mac_cyrillic"|"mac_greek"|"mac_iceland"|"mac_latin2"|"mac_roman"|"mac_turkish"|"ptcp154"|"shift_jis"|"shift_jis_2004"|"shift_jisx0213"|"utf_32"|"utf_32_be"|"utf_32_le"|"utf_16"|"utf_16_be"|"utf_16_le"|"utf_7"|"utf_8"|"utf_8_sig"|string; + export type CloudWatchLogsInitialPosition = "start_of_file"|"end_of_file"|string; + export interface CloudWatchLogsLogStream { + /** + * Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period). + */ + LogGroupName?: String; + /** + * Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference. + */ + DatetimeFormat?: String; + /** + * Specifies the time zone of log event time stamps. + */ + TimeZone?: CloudWatchLogsTimeZone; + /** + * Specifies log files that you want to push to CloudWatch Logs. File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group. Zipped files are not supported. + */ + File?: String; + /** + * Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available. + */ + FileFingerprintLines?: String; + /** + * Specifies the pattern for identifying the start of a log message. + */ + MultiLineStartPattern?: String; + /** + * Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream. + */ + InitialPosition?: CloudWatchLogsInitialPosition; + /** + * Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here. + */ + Encoding?: CloudWatchLogsEncoding; + /** + * Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms. + */ + BufferDuration?: Integer; + /** + * Specifies the max number of log events in a batch, up to 10000. The default value is 1000. + */ + BatchCount?: Integer; + /** + * Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. + */ + BatchSize?: Integer; + } + export type CloudWatchLogsLogStreams = CloudWatchLogsLogStream[]; + export type CloudWatchLogsTimeZone = "LOCAL"|"UTC"|string; + export interface Command { + /** + * The command ID. + */ + CommandId?: String; + /** + * The ID of the instance where the command was executed. + */ + InstanceId?: String; + /** + * The command deployment ID. + */ + DeploymentId?: String; + /** + * Date and time when the command was run. + */ + CreatedAt?: DateTime; + /** + * Date and time when the command was acknowledged. + */ + AcknowledgedAt?: DateTime; + /** + * Date when the command completed. + */ + CompletedAt?: DateTime; + /** + * The command status: failed successful skipped pending + */ + Status?: String; + /** + * The command exit code. + */ + ExitCode?: Integer; + /** + * The URL of the command log. + */ + LogUrl?: String; + /** + * The command type: configure deploy execute_recipes install_dependencies restart rollback setup start stop undeploy update_custom_cookbooks update_dependencies + */ + Type?: String; + } + export type Commands = Command[]; + export interface CreateAppRequest { + /** + * The stack ID. + */ + StackId: String; + /** + * The app's short name. + */ + Shortname?: String; + /** + * The app name. + */ + Name: String; + /** + * A description of the app. + */ + Description?: String; + /** + * The app's data source. + */ + DataSources?: DataSources; + /** + * The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other. + */ + Type: AppType; + /** + * A Source object that specifies the app repository. + */ + AppSource?: Source; + /** + * The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com' + */ + Domains?: Strings; + /** + * Whether to enable SSL for the app. + */ + EnableSsl?: Boolean; + /** + * An SslConfiguration object with the SSL configuration. + */ + SslConfiguration?: SslConfiguration; + /** + * One or more user-defined key/value pairs to be added to the stack attributes. + */ + Attributes?: AppAttributes; + /** + * An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version. + */ + Environment?: EnvironmentVariables; + } + export interface CreateAppResult { + /** + * The app ID. + */ + AppId?: String; + } + export interface CreateDeploymentRequest { + /** + * The stack ID. + */ + StackId: String; + /** + * The app ID. This parameter is required for app deployments, but not for other deployment commands. + */ + AppId?: String; + /** + * The instance IDs for the deployment targets. + */ + InstanceIds?: Strings; + /** + * The layer IDs for the deployment targets. + */ + LayerIds?: Strings; + /** + * A DeploymentCommand object that specifies the deployment command and any associated arguments. + */ + Command: DeploymentCommand; + /** + * A user-defined comment. + */ + Comment?: String; + /** + * A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. + */ + CustomJson?: String; + } + export interface CreateDeploymentResult { + /** + * The deployment ID, which can be used with other requests to identify the deployment. + */ + DeploymentId?: String; + } + export interface CreateInstanceRequest { + /** + * The stack ID. + */ + StackId: String; + /** + * An array that contains the instance's layer IDs. + */ + LayerIds: Strings; + /** + * The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table. + */ + InstanceType: String; + /** + * For load-based or time-based instances, the type. Windows stacks can use only time-based instances. + */ + AutoScalingType?: AutoScalingType; + /** + * The instance host name. + */ + Hostname?: String; + /** + * The instance's operating system, which must be set to one of the following. A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. A custom AMI: Custom. For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems. The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs. + */ + Os?: String; + /** + * A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs. If you specify a custom AMI, you must set Os to Custom. + */ + AmiId?: String; + /** + * The instance's Amazon EC2 key-pair name. + */ + SshKeyName?: String; + /** + * The instance Availability Zone. For more information, see Regions and Endpoints. + */ + AvailabilityZone?: String; + /** + * The instance's virtualization type, paravirtual or hvm. + */ + VirtualizationType?: String; + /** + * The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet. + */ + SubnetId?: String; + /** + * The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types. + */ + Architecture?: Architecture; + /** + * The instance root device type. For more information, see Storage for the Root Device. + */ + RootDeviceType?: RootDeviceType; + /** + * An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs. + */ + BlockDeviceMappings?: BlockDeviceMappings; + /** + * Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true to ensure that your instances have the latest security updates. + */ + InstallUpdatesOnBoot?: Boolean; + /** + * Whether to create an Amazon EBS-optimized instance. + */ + EbsOptimized?: Boolean; + /** + * The default AWS OpsWorks Stacks agent version. You have the following options: INHERIT - Use the stack's default agent version setting. version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance. The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. + */ + AgentVersion?: String; + /** + * The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances. + */ + Tenancy?: String; + } + export interface CreateInstanceResult { + /** + * The instance ID. + */ + InstanceId?: String; + } + export interface CreateLayerRequest { + /** + * The layer stack ID. + */ + StackId: String; + /** + * The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. + */ + Type: LayerType; + /** + * The layer name, which is used by the console. + */ + Name: String; + /** + * For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference. + */ + Shortname: String; + /** + * One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN. + */ + Attributes?: LayerAttributes; + /** + * Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream. + */ + CloudWatchLogsConfiguration?: CloudWatchLogsConfiguration; + /** + * The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. + */ + CustomInstanceProfileArn?: String; + /** + * A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI. + */ + CustomJson?: String; + /** + * An array containing the layer custom security group IDs. + */ + CustomSecurityGroupIds?: Strings; + /** + * An array of Package objects that describes the layer packages. + */ + Packages?: Strings; + /** + * A VolumeConfigurations object that describes the layer's Amazon EBS volumes. + */ + VolumeConfigurations?: VolumeConfigurations; + /** + * Whether to disable auto healing for the layer. + */ + EnableAutoHealing?: Boolean; + /** + * Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. + */ + AutoAssignElasticIps?: Boolean; + /** + * For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. + */ + AutoAssignPublicIps?: Boolean; + /** + * A LayerCustomRecipes object that specifies the layer custom recipes. + */ + CustomRecipes?: Recipes; + /** + * Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. To ensure that your instances have the latest security updates, we strongly recommend using the default value of true. + */ + InstallUpdatesOnBoot?: Boolean; + /** + * Whether to use Amazon EBS-optimized instances. + */ + UseEbsOptimizedInstances?: Boolean; + /** + * A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining. + */ + LifecycleEventConfiguration?: LifecycleEventConfiguration; + } + export interface CreateLayerResult { + /** + * The layer ID. + */ + LayerId?: String; + } + export interface CreateStackRequest { + /** + * The stack name. + */ + Name: String; + /** + * The stack's AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints. In the AWS CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the AWS CLI common parameter --region are set to the same value, the stack uses a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI --region parameter is, this also results in a stack with a regional endpoint. However, if the --region parameter is set to us-east-1, and the --stack-region parameter is set to one of the following, then the stack uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region. + */ + Region: String; + /** + * The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later. If your account supports EC2-Classic, the default value is no VPC. If your account does not support EC2-Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: It must belong to a VPC in your account that is in the specified region. You must specify a value for DefaultSubnetId. For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms. + */ + VpcId?: String; + /** + * One or more user-defined key-value pairs to be added to the stack attributes. + */ + Attributes?: StackAttributes; + /** + * The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers. + */ + ServiceRoleArn: String; + /** + * The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. + */ + DefaultInstanceProfileArn: String; + /** + * The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following. A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs. The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems. + */ + DefaultOs?: String; + /** + * The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are: Baked_Goods Clouds Europe_Cities Fruits Greek_Deities Legendary_creatures_from_Japan Planets_and_Moons Roman_Deities Scottish_Islands US_Cities Wild_Cats To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme. + */ + HostnameTheme?: String; + /** + * The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description. + */ + DefaultAvailabilityZone?: String; + /** + * The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description. + */ + DefaultSubnetId?: String; + /** + * A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. + */ + CustomJson?: String; + /** + * The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. + */ + ConfigurationManager?: StackConfigurationManager; + /** + * A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack. + */ + ChefConfiguration?: ChefConfiguration; + /** + * Whether the stack uses custom cookbooks. + */ + UseCustomCookbooks?: Boolean; + /** + * Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings: True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see Create a New Stack. + */ + UseOpsworksSecurityGroups?: Boolean; + CustomCookbooksSource?: Source; + /** + * A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. + */ + DefaultSshKeyName?: String; + /** + * The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device. + */ + DefaultRootDeviceType?: RootDeviceType; + /** + * The default AWS OpsWorks Stacks agent version. You have the following options: Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. + */ + AgentVersion?: String; + } + export interface CreateStackResult { + /** + * The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks. + */ + StackId?: String; + } + export interface CreateUserProfileRequest { + /** + * The user's IAM ARN; this can also be a federated user's ARN. + */ + IamUserArn: String; + /** + * The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. + */ + SshUsername?: String; + /** + * The user's public SSH key. + */ + SshPublicKey?: String; + /** + * Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key. + */ + AllowSelfManagement?: Boolean; + } + export interface CreateUserProfileResult { + /** + * The user's IAM ARN. + */ + IamUserArn?: String; + } + export type DailyAutoScalingSchedule = {[key: string]: Switch}; + export interface DataSource { + /** + * The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, RdsDbInstance, or None. + */ + Type?: String; + /** + * The data source's ARN. + */ + Arn?: String; + /** + * The database name. + */ + DatabaseName?: String; + } + export type DataSources = DataSource[]; + export type DateTime = string; + export interface DeleteAppRequest { + /** + * The app ID. + */ + AppId: String; + } + export interface DeleteInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + /** + * Whether to delete the instance Elastic IP address. + */ + DeleteElasticIp?: Boolean; + /** + * Whether to delete the instance's Amazon EBS volumes. + */ + DeleteVolumes?: Boolean; + } + export interface DeleteLayerRequest { + /** + * The layer ID. + */ + LayerId: String; + } + export interface DeleteStackRequest { + /** + * The stack ID. + */ + StackId: String; + } + export interface DeleteUserProfileRequest { + /** + * The user's IAM ARN. This can also be a federated user's ARN. + */ + IamUserArn: String; + } + export interface Deployment { + /** + * The deployment ID. + */ + DeploymentId?: String; + /** + * The stack ID. + */ + StackId?: String; + /** + * The app ID. + */ + AppId?: String; + /** + * Date when the deployment was created. + */ + CreatedAt?: DateTime; + /** + * Date when the deployment completed. + */ + CompletedAt?: DateTime; + /** + * The deployment duration. + */ + Duration?: Integer; + /** + * The user's IAM ARN. + */ + IamUserArn?: String; + /** + * A user-defined comment. + */ + Comment?: String; + Command?: DeploymentCommand; + /** + * The deployment status: running successful failed + */ + Status?: String; + /** + * A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. + */ + CustomJson?: String; + /** + * The IDs of the target instances. + */ + InstanceIds?: Strings; + } + export interface DeploymentCommand { + /** + * Specifies the operation. You can specify only one command. For stacks, the following commands are available: execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}. install_dependencies: Install the stack's dependencies. update_custom_cookbooks: Update the stack's custom cookbooks. update_dependencies: Update the stack's dependencies. The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing. For apps, the following commands are available: deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. Set Args to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions. start: Start the app's web or application server. stop: Stop the app's web or application server. restart: Restart the app's web or application server. undeploy: Undeploy the app. + */ + Name: DeploymentCommandName; + /** + * The arguments of those commands that take arguments. It should be set to a JSON object with the following format: {"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...} The update_dependencies command takes two arguments: upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2016.09. You must also set the allow_reboot argument to true. allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false. For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the following. { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } + */ + Args?: DeploymentCommandArgs; + } + export type DeploymentCommandArgs = {[key: string]: Strings}; + export type DeploymentCommandName = "install_dependencies"|"update_dependencies"|"update_custom_cookbooks"|"execute_recipes"|"configure"|"setup"|"deploy"|"rollback"|"start"|"stop"|"restart"|"undeploy"|string; + export type Deployments = Deployment[]; + export interface DeregisterEcsClusterRequest { + /** + * The cluster's Amazon Resource Number (ARN). + */ + EcsClusterArn: String; + } + export interface DeregisterElasticIpRequest { + /** + * The Elastic IP address. + */ + ElasticIp: String; + } + export interface DeregisterInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + } + export interface DeregisterRdsDbInstanceRequest { + /** + * The Amazon RDS instance's ARN. + */ + RdsDbInstanceArn: String; + } + export interface DeregisterVolumeRequest { + /** + * The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID. + */ + VolumeId: String; + } + export interface DescribeAgentVersionsRequest { + /** + * The stack ID. + */ + StackId?: String; + /** + * The configuration manager. + */ + ConfigurationManager?: StackConfigurationManager; + } + export interface DescribeAgentVersionsResult { + /** + * The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console. + */ + AgentVersions?: AgentVersions; + } + export interface DescribeAppsRequest { + /** + * The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack. + */ + StackId?: String; + /** + * An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app. + */ + AppIds?: Strings; + } + export interface DescribeAppsResult { + /** + * An array of App objects that describe the specified apps. + */ + Apps?: Apps; + } + export interface DescribeCommandsRequest { + /** + * The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment. + */ + DeploymentId?: String; + /** + * The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance. + */ + InstanceId?: String; + /** + * An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command. + */ + CommandIds?: Strings; + } + export interface DescribeCommandsResult { + /** + * An array of Command objects that describe each of the specified commands. + */ + Commands?: Commands; + } + export interface DescribeDeploymentsRequest { + /** + * The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack. + */ + StackId?: String; + /** + * The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app. + */ + AppId?: String; + /** + * An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment. + */ + DeploymentIds?: Strings; + } + export interface DescribeDeploymentsResult { + /** + * An array of Deployment objects that describe the deployments. + */ + Deployments?: Deployments; + } + export interface DescribeEcsClustersRequest { + /** + * A list of ARNs, one for each cluster to be described. + */ + EcsClusterArns?: Strings; + /** + * A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack. + */ + StackId?: String; + /** + * If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. + */ + NextToken?: String; + /** + * To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. + */ + MaxResults?: Integer; + } + export interface DescribeEcsClustersResult { + /** + * A list of EcsCluster objects containing the cluster descriptions. + */ + EcsClusters?: EcsClusters; + /** + * If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null. + */ + NextToken?: String; + } + export interface DescribeElasticIpsRequest { + /** + * The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance. + */ + InstanceId?: String; + /** + * A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack. + */ + StackId?: String; + /** + * An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address. + */ + Ips?: Strings; + } + export interface DescribeElasticIpsResult { + /** + * An ElasticIps object that describes the specified Elastic IP addresses. + */ + ElasticIps?: ElasticIps; + } + export interface DescribeElasticLoadBalancersRequest { + /** + * A stack ID. The action describes the stack's Elastic Load Balancing instances. + */ + StackId?: String; + /** + * A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers. + */ + LayerIds?: Strings; + } + export interface DescribeElasticLoadBalancersResult { + /** + * A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances. + */ + ElasticLoadBalancers?: ElasticLoadBalancers; + } + export interface DescribeInstancesRequest { + /** + * A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack. + */ + StackId?: String; + /** + * A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer. + */ + LayerId?: String; + /** + * An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance. + */ + InstanceIds?: Strings; + } + export interface DescribeInstancesResult { + /** + * An array of Instance objects that describe the instances. + */ + Instances?: Instances; + } + export interface DescribeLayersRequest { + /** + * The stack ID. + */ + StackId?: String; + /** + * An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack. + */ + LayerIds?: Strings; + } + export interface DescribeLayersResult { + /** + * An array of Layer objects that describe the layers. + */ + Layers?: Layers; + } + export interface DescribeLoadBasedAutoScalingRequest { + /** + * An array of layer IDs. + */ + LayerIds: Strings; + } + export interface DescribeLoadBasedAutoScalingResult { + /** + * An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration. + */ + LoadBasedAutoScalingConfigurations?: LoadBasedAutoScalingConfigurations; + } + export interface DescribeMyUserProfileResult { + /** + * A UserProfile object that describes the user's SSH information. + */ + UserProfile?: SelfUserProfile; + } + export interface DescribeOperatingSystemsResponse { + /** + * Contains information in response to a DescribeOperatingSystems request. + */ + OperatingSystems?: OperatingSystems; + } + export interface DescribePermissionsRequest { + /** + * The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers. + */ + IamUserArn?: String; + /** + * The stack ID. + */ + StackId?: String; + } + export interface DescribePermissionsResult { + /** + * An array of Permission objects that describe the stack permissions. If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs. If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs. If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN. + */ + Permissions?: Permissions; + } + export interface DescribeRaidArraysRequest { + /** + * The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance. + */ + InstanceId?: String; + /** + * The stack ID. + */ + StackId?: String; + /** + * An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array. + */ + RaidArrayIds?: Strings; + } + export interface DescribeRaidArraysResult { + /** + * A RaidArrays object that describes the specified RAID arrays. + */ + RaidArrays?: RaidArrays; + } + export interface DescribeRdsDbInstancesRequest { + /** + * The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances. + */ + StackId: String; + /** + * An array containing the ARNs of the instances to be described. + */ + RdsDbInstanceArns?: Strings; + } + export interface DescribeRdsDbInstancesResult { + /** + * An a array of RdsDbInstance objects that describe the instances. + */ + RdsDbInstances?: RdsDbInstances; + } + export interface DescribeServiceErrorsRequest { + /** + * The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack. + */ + StackId?: String; + /** + * The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance. + */ + InstanceId?: String; + /** + * An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error. + */ + ServiceErrorIds?: Strings; + } + export interface DescribeServiceErrorsResult { + /** + * An array of ServiceError objects that describe the specified service errors. + */ + ServiceErrors?: ServiceErrors; + } + export interface DescribeStackProvisioningParametersRequest { + /** + * The stack ID. + */ + StackId: String; + } + export interface DescribeStackProvisioningParametersResult { + /** + * The AWS OpsWorks Stacks agent installer's URL. + */ + AgentInstallerUrl?: String; + /** + * An embedded object that contains the provisioning parameters. + */ + Parameters?: Parameters; + } + export interface DescribeStackSummaryRequest { + /** + * The stack ID. + */ + StackId: String; + } + export interface DescribeStackSummaryResult { + /** + * A StackSummary object that contains the results. + */ + StackSummary?: StackSummary; + } + export interface DescribeStacksRequest { + /** + * An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack. + */ + StackIds?: Strings; + } + export interface DescribeStacksResult { + /** + * An array of Stack objects that describe the stacks. + */ + Stacks?: Stacks; + } + export interface DescribeTimeBasedAutoScalingRequest { + /** + * An array of instance IDs. + */ + InstanceIds: Strings; + } + export interface DescribeTimeBasedAutoScalingResult { + /** + * An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances. + */ + TimeBasedAutoScalingConfigurations?: TimeBasedAutoScalingConfigurations; + } + export interface DescribeUserProfilesRequest { + /** + * An array of IAM or federated user ARNs that identify the users to be described. + */ + IamUserArns?: Strings; + } + export interface DescribeUserProfilesResult { + /** + * A Users object that describes the specified users. + */ + UserProfiles?: UserProfiles; + } + export interface DescribeVolumesRequest { + /** + * The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance. + */ + InstanceId?: String; + /** + * A stack ID. The action describes the stack's registered Amazon EBS volumes. + */ + StackId?: String; + /** + * The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array. + */ + RaidArrayId?: String; + /** + * Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume. + */ + VolumeIds?: Strings; + } + export interface DescribeVolumesResult { + /** + * An array of volume IDs. + */ + Volumes?: Volumes; + } + export interface DetachElasticLoadBalancerRequest { + /** + * The Elastic Load Balancing instance's name. + */ + ElasticLoadBalancerName: String; + /** + * The ID of the layer that the Elastic Load Balancing instance is attached to. + */ + LayerId: String; + } + export interface DisassociateElasticIpRequest { + /** + * The Elastic IP address. + */ + ElasticIp: String; + } + export type Double = number; + export interface EbsBlockDevice { + /** + * The snapshot ID. + */ + SnapshotId?: String; + /** + * The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice. + */ + Iops?: Integer; + /** + * The volume size, in GiB. For more information, see EbsBlockDevice. + */ + VolumeSize?: Integer; + /** + * The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes. If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size). + */ + VolumeType?: VolumeType; + /** + * Whether the volume is deleted on instance termination. + */ + DeleteOnTermination?: Boolean; + } + export interface EcsCluster { + /** + * The cluster's ARN. + */ + EcsClusterArn?: String; + /** + * The cluster name. + */ + EcsClusterName?: String; + /** + * The stack ID. + */ + StackId?: String; + /** + * The time and date that the cluster was registered with the stack. + */ + RegisteredAt?: DateTime; + } + export type EcsClusters = EcsCluster[]; + export interface ElasticIp { + /** + * The IP address. + */ + Ip?: String; + /** + * The name. + */ + Name?: String; + /** + * The domain. + */ + Domain?: String; + /** + * The AWS region. For more information, see Regions and Endpoints. + */ + Region?: String; + /** + * The ID of the instance that the address is attached to. + */ + InstanceId?: String; + } + export type ElasticIps = ElasticIp[]; + export interface ElasticLoadBalancer { + /** + * The Elastic Load Balancing instance's name. + */ + ElasticLoadBalancerName?: String; + /** + * The instance's AWS region. + */ + Region?: String; + /** + * The instance's public DNS name. + */ + DnsName?: String; + /** + * The ID of the stack that the instance is associated with. + */ + StackId?: String; + /** + * The ID of the layer that the instance is attached to. + */ + LayerId?: String; + /** + * The VPC ID. + */ + VpcId?: String; + /** + * A list of Availability Zones. + */ + AvailabilityZones?: Strings; + /** + * A list of subnet IDs, if the stack is running in a VPC. + */ + SubnetIds?: Strings; + /** + * A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for. + */ + Ec2InstanceIds?: Strings; + } + export type ElasticLoadBalancers = ElasticLoadBalancer[]; + export interface EnvironmentVariable { + /** + * (Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore. + */ + Key: String; + /** + * (Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable. + */ + Value: String; + /** + * (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false. + */ + Secure?: Boolean; + } + export type EnvironmentVariables = EnvironmentVariable[]; + export interface GetHostnameSuggestionRequest { + /** + * The layer ID. + */ + LayerId: String; + } + export interface GetHostnameSuggestionResult { + /** + * The layer ID. + */ + LayerId?: String; + /** + * The generated host name. + */ + Hostname?: String; + } + export interface GrantAccessRequest { + /** + * The instance's AWS OpsWorks Stacks ID. + */ + InstanceId: String; + /** + * The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out. + */ + ValidForInMinutes?: ValidForInMinutes; + } + export interface GrantAccessResult { + /** + * A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection. + */ + TemporaryCredential?: TemporaryCredential; + } + export type Hour = string; + export interface Instance { + /** + * The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version. + */ + AgentVersion?: String; + /** + * A custom AMI ID to be used to create the instance. For more information, see Instances + */ + AmiId?: String; + /** + * The instance architecture: "i386" or "x86_64". + */ + Architecture?: Architecture; + /** + * The instance's Amazon Resource Number (ARN). + */ + Arn?: String; + /** + * For load-based or time-based instances, the type. + */ + AutoScalingType?: AutoScalingType; + /** + * The instance Availability Zone. For more information, see Regions and Endpoints. + */ + AvailabilityZone?: String; + /** + * An array of BlockDeviceMapping objects that specify the instance's block device mappings. + */ + BlockDeviceMappings?: BlockDeviceMappings; + /** + * The time that the instance was created. + */ + CreatedAt?: DateTime; + /** + * Whether this is an Amazon EBS-optimized instance. + */ + EbsOptimized?: Boolean; + /** + * The ID of the associated Amazon EC2 instance. + */ + Ec2InstanceId?: String; + /** + * For container instances, the Amazon ECS cluster's ARN. + */ + EcsClusterArn?: String; + /** + * For container instances, the instance's ARN. + */ + EcsContainerInstanceArn?: String; + /** + * The instance Elastic IP address . + */ + ElasticIp?: String; + /** + * The instance host name. + */ + Hostname?: String; + /** + * For registered instances, the infrastructure class: ec2 or on-premises. + */ + InfrastructureClass?: String; + /** + * Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true, to ensure that your instances have the latest security updates. + */ + InstallUpdatesOnBoot?: Boolean; + /** + * The instance ID. + */ + InstanceId?: String; + /** + * The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers. + */ + InstanceProfileArn?: String; + /** + * The instance type, such as t2.micro. + */ + InstanceType?: String; + /** + * The ID of the last service error. For more information, call DescribeServiceErrors. + */ + LastServiceErrorId?: String; + /** + * An array containing the instance layer IDs. + */ + LayerIds?: Strings; + /** + * The instance's operating system. + */ + Os?: String; + /** + * The instance's platform. + */ + Platform?: String; + /** + * The instance's private DNS name. + */ + PrivateDns?: String; + /** + * The instance's private IP address. + */ + PrivateIp?: String; + /** + * The instance public DNS name. + */ + PublicDns?: String; + /** + * The instance public IP address. + */ + PublicIp?: String; + /** + * For registered instances, who performed the registration. + */ + RegisteredBy?: String; + /** + * The instance's reported AWS OpsWorks Stacks agent version. + */ + ReportedAgentVersion?: String; + /** + * For registered instances, the reported operating system. + */ + ReportedOs?: ReportedOs; + /** + * The instance's root device type. For more information, see Storage for the Root Device. + */ + RootDeviceType?: RootDeviceType; + /** + * The root device volume ID. + */ + RootDeviceVolumeId?: String; + /** + * An array containing the instance security group IDs. + */ + SecurityGroupIds?: Strings; + /** + * The SSH key's Deep Security Agent (DSA) fingerprint. + */ + SshHostDsaKeyFingerprint?: String; + /** + * The SSH key's RSA fingerprint. + */ + SshHostRsaKeyFingerprint?: String; + /** + * The instance's Amazon EC2 key-pair name. + */ + SshKeyName?: String; + /** + * The stack ID. + */ + StackId?: String; + /** + * The instance status: booting connection_lost online pending rebooting requested running_setup setup_failed shutting_down start_failed stop_failed stopped stopping terminated terminating + */ + Status?: String; + /** + * The instance's subnet ID; applicable only if the stack is running in a VPC. + */ + SubnetId?: String; + /** + * The instance's tenancy option, such as dedicated or host. + */ + Tenancy?: String; + /** + * The instance's virtualization type: paravirtual or hvm. + */ + VirtualizationType?: VirtualizationType; + } + export interface InstanceIdentity { + /** + * A JSON document that contains the metadata. + */ + Document?: String; + /** + * A signature that can be used to verify the document's accuracy and authenticity. + */ + Signature?: String; + } + export type Instances = Instance[]; + export interface InstancesCount { + /** + * The number of instances in the Assigning state. + */ + Assigning?: Integer; + /** + * The number of instances with booting status. + */ + Booting?: Integer; + /** + * The number of instances with connection_lost status. + */ + ConnectionLost?: Integer; + /** + * The number of instances in the Deregistering state. + */ + Deregistering?: Integer; + /** + * The number of instances with online status. + */ + Online?: Integer; + /** + * The number of instances with pending status. + */ + Pending?: Integer; + /** + * The number of instances with rebooting status. + */ + Rebooting?: Integer; + /** + * The number of instances in the Registered state. + */ + Registered?: Integer; + /** + * The number of instances in the Registering state. + */ + Registering?: Integer; + /** + * The number of instances with requested status. + */ + Requested?: Integer; + /** + * The number of instances with running_setup status. + */ + RunningSetup?: Integer; + /** + * The number of instances with setup_failed status. + */ + SetupFailed?: Integer; + /** + * The number of instances with shutting_down status. + */ + ShuttingDown?: Integer; + /** + * The number of instances with start_failed status. + */ + StartFailed?: Integer; + /** + * The number of instances with stop_failed status. + */ + StopFailed?: Integer; + /** + * The number of instances with stopped status. + */ + Stopped?: Integer; + /** + * The number of instances with stopping status. + */ + Stopping?: Integer; + /** + * The number of instances with terminated status. + */ + Terminated?: Integer; + /** + * The number of instances with terminating status. + */ + Terminating?: Integer; + /** + * The number of instances in the Unassigning state. + */ + Unassigning?: Integer; + } + export type Integer = number; + export interface Layer { + /** + * The Amazon Resource Number (ARN) of a layer. + */ + Arn?: String; + /** + * The layer stack ID. + */ + StackId?: String; + /** + * The layer ID. + */ + LayerId?: String; + /** + * The layer type. + */ + Type?: LayerType; + /** + * The layer name. + */ + Name?: String; + /** + * The layer short name. + */ + Shortname?: String; + /** + * The layer attributes. For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN. + */ + Attributes?: LayerAttributes; + /** + * The Amazon CloudWatch Logs configuration settings for the layer. + */ + CloudWatchLogsConfiguration?: CloudWatchLogsConfiguration; + /** + * The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. + */ + CustomInstanceProfileArn?: String; + /** + * A JSON formatted string containing the layer's custom stack configuration and deployment attributes. + */ + CustomJson?: String; + /** + * An array containing the layer's custom security group IDs. + */ + CustomSecurityGroupIds?: Strings; + /** + * An array containing the layer's security group names. + */ + DefaultSecurityGroupNames?: Strings; + /** + * An array of Package objects that describe the layer's packages. + */ + Packages?: Strings; + /** + * A VolumeConfigurations object that describes the layer's Amazon EBS volumes. + */ + VolumeConfigurations?: VolumeConfigurations; + /** + * Whether auto healing is disabled for the layer. + */ + EnableAutoHealing?: Boolean; + /** + * Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. + */ + AutoAssignElasticIps?: Boolean; + /** + * For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. + */ + AutoAssignPublicIps?: Boolean; + DefaultRecipes?: Recipes; + /** + * A LayerCustomRecipes object that specifies the layer's custom recipes. + */ + CustomRecipes?: Recipes; + /** + * Date when the layer was created. + */ + CreatedAt?: DateTime; + /** + * Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true, to ensure that your instances have the latest security updates. + */ + InstallUpdatesOnBoot?: Boolean; + /** + * Whether the layer uses Amazon EBS-optimized instances. + */ + UseEbsOptimizedInstances?: Boolean; + /** + * A LifeCycleEventConfiguration object that specifies the Shutdown event configuration. + */ + LifecycleEventConfiguration?: LifecycleEventConfiguration; + } + export type LayerAttributes = {[key: string]: String}; + export type LayerAttributesKeys = "EcsClusterArn"|"EnableHaproxyStats"|"HaproxyStatsUrl"|"HaproxyStatsUser"|"HaproxyStatsPassword"|"HaproxyHealthCheckUrl"|"HaproxyHealthCheckMethod"|"MysqlRootPassword"|"MysqlRootPasswordUbiquitous"|"GangliaUrl"|"GangliaUser"|"GangliaPassword"|"MemcachedMemory"|"NodejsVersion"|"RubyVersion"|"RubygemsVersion"|"ManageBundler"|"BundlerVersion"|"RailsStack"|"PassengerVersion"|"Jvm"|"JvmVersion"|"JvmOptions"|"JavaAppServer"|"JavaAppServerVersion"|string; + export type LayerType = "aws-flow-ruby"|"ecs-cluster"|"java-app"|"lb"|"web"|"php-app"|"rails-app"|"nodejs-app"|"memcached"|"db-master"|"monitoring-master"|"custom"|string; + export type Layers = Layer[]; + export interface LifecycleEventConfiguration { + /** + * A ShutdownEventConfiguration object that specifies the Shutdown event configuration. + */ + Shutdown?: ShutdownEventConfiguration; + } + export interface ListTagsRequest { + /** + * The stack or layer's Amazon Resource Number (ARN). + */ + ResourceArn: ResourceArn; + /** + * Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call. + */ + MaxResults?: MaxResults; + /** + * Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call. + */ + NextToken?: NextToken; + } + export interface ListTagsResult { + /** + * A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer. + */ + Tags?: Tags; + /** + * If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to get the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null. + */ + NextToken?: NextToken; + } + export interface LoadBasedAutoScalingConfiguration { + /** + * The layer ID. + */ + LayerId?: String; + /** + * Whether load-based auto scaling is enabled for the layer. + */ + Enable?: Boolean; + /** + * An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks Stacks increases the number of instances. + */ + UpScaling?: AutoScalingThresholds; + /** + * An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks Stacks reduces the number of instances. + */ + DownScaling?: AutoScalingThresholds; + } + export type LoadBasedAutoScalingConfigurations = LoadBasedAutoScalingConfiguration[]; + export type MaxResults = number; + export type Minute = number; + export type NextToken = string; + export interface OperatingSystem { + /** + * The name of the operating system, such as Amazon Linux 2017.09. + */ + Name?: String; + /** + * The ID of a supported operating system, such as Amazon Linux 2017.09. + */ + Id?: String; + /** + * The type of a supported operating system, either Linux or Windows. + */ + Type?: String; + /** + * Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system. + */ + ConfigurationManagers?: OperatingSystemConfigurationManagers; + /** + * A short name for the operating system manufacturer. + */ + ReportedName?: String; + /** + * The version of the operating system, including the release and edition, if applicable. + */ + ReportedVersion?: String; + /** + * Indicates that an operating system is not supported for new instances. + */ + Supported?: Boolean; + } + export interface OperatingSystemConfigurationManager { + /** + * The name of the configuration manager, which is Chef. + */ + Name?: String; + /** + * The versions of the configuration manager that are supported by an operating system. + */ + Version?: String; + } + export type OperatingSystemConfigurationManagers = OperatingSystemConfigurationManager[]; + export type OperatingSystems = OperatingSystem[]; + export type Parameters = {[key: string]: String}; + export interface Permission { + /** + * A stack ID. + */ + StackId?: String; + /** + * The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers. + */ + IamUserArn?: String; + /** + * Whether the user can use SSH. + */ + AllowSsh?: Boolean; + /** + * Whether the user can use sudo. + */ + AllowSudo?: Boolean; + /** + * The user's permission level, which must be the following: deny show deploy manage iam_only For more information on the permissions associated with these levels, see Managing User Permissions + */ + Level?: String; + } + export type Permissions = Permission[]; + export interface RaidArray { + /** + * The array ID. + */ + RaidArrayId?: String; + /** + * The instance ID. + */ + InstanceId?: String; + /** + * The array name. + */ + Name?: String; + /** + * The RAID level. + */ + RaidLevel?: Integer; + /** + * The number of disks in the array. + */ + NumberOfDisks?: Integer; + /** + * The array's size. + */ + Size?: Integer; + /** + * The array's Linux device. For example /dev/mdadm0. + */ + Device?: String; + /** + * The array's mount point. + */ + MountPoint?: String; + /** + * The array's Availability Zone. For more information, see Regions and Endpoints. + */ + AvailabilityZone?: String; + /** + * When the RAID array was created. + */ + CreatedAt?: DateTime; + /** + * The stack ID. + */ + StackId?: String; + /** + * The volume type, standard or PIOPS. + */ + VolumeType?: String; + /** + * For PIOPS volumes, the IOPS per disk. + */ + Iops?: Integer; + } + export type RaidArrays = RaidArray[]; + export interface RdsDbInstance { + /** + * The instance's ARN. + */ + RdsDbInstanceArn?: String; + /** + * The DB instance identifier. + */ + DbInstanceIdentifier?: String; + /** + * The master user name. + */ + DbUser?: String; + /** + * AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value. + */ + DbPassword?: String; + /** + * The instance's AWS region. + */ + Region?: String; + /** + * The instance's address. + */ + Address?: String; + /** + * The instance's database engine. + */ + Engine?: String; + /** + * The ID of the stack with which the instance is registered. + */ + StackId?: String; + /** + * Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts to discover the instance only once. If this value is set to true, you must deregister the instance, and then register it again. + */ + MissingOnRds?: Boolean; + } + export type RdsDbInstances = RdsDbInstance[]; + export interface RebootInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + } + export interface Recipes { + /** + * An array of custom recipe names to be run following a setup event. + */ + Setup?: Strings; + /** + * An array of custom recipe names to be run following a configure event. + */ + Configure?: Strings; + /** + * An array of custom recipe names to be run following a deploy event. + */ + Deploy?: Strings; + /** + * An array of custom recipe names to be run following a undeploy event. + */ + Undeploy?: Strings; + /** + * An array of custom recipe names to be run following a shutdown event. + */ + Shutdown?: Strings; + } + export interface RegisterEcsClusterRequest { + /** + * The cluster's ARN. + */ + EcsClusterArn: String; + /** + * The stack ID. + */ + StackId: String; + } + export interface RegisterEcsClusterResult { + /** + * The cluster's ARN. + */ + EcsClusterArn?: String; + } + export interface RegisterElasticIpRequest { + /** + * The Elastic IP address. + */ + ElasticIp: String; + /** + * The stack ID. + */ + StackId: String; + } + export interface RegisterElasticIpResult { + /** + * The Elastic IP address. + */ + ElasticIp?: String; + } + export interface RegisterInstanceRequest { + /** + * The ID of the stack that the instance is to be registered with. + */ + StackId: String; + /** + * The instance's hostname. + */ + Hostname?: String; + /** + * The instance's public IP address. + */ + PublicIp?: String; + /** + * The instance's private IP address. + */ + PrivateIp?: String; + /** + * The instances public RSA key. This key is used to encrypt communication between the instance and the service. + */ + RsaPublicKey?: String; + /** + * The instances public RSA key fingerprint. + */ + RsaPublicKeyFingerprint?: String; + /** + * An InstanceIdentity object that contains the instance's identity. + */ + InstanceIdentity?: InstanceIdentity; + } + export interface RegisterInstanceResult { + /** + * The registered instance's AWS OpsWorks Stacks ID. + */ + InstanceId?: String; + } + export interface RegisterRdsDbInstanceRequest { + /** + * The stack ID. + */ + StackId: String; + /** + * The Amazon RDS instance's ARN. + */ + RdsDbInstanceArn: String; + /** + * The database's master user name. + */ + DbUser: String; + /** + * The database password. + */ + DbPassword: String; + } + export interface RegisterVolumeRequest { + /** + * The Amazon EBS volume ID. + */ + Ec2VolumeId?: String; + /** + * The stack ID. + */ + StackId: String; + } + export interface RegisterVolumeResult { + /** + * The volume ID. + */ + VolumeId?: String; + } + export interface ReportedOs { + /** + * The operating system family. + */ + Family?: String; + /** + * The operating system name. + */ + Name?: String; + /** + * The operating system version. + */ + Version?: String; + } + export type ResourceArn = string; + export type RootDeviceType = "ebs"|"instance-store"|string; + export interface SelfUserProfile { + /** + * The user's IAM ARN. + */ + IamUserArn?: String; + /** + * The user's name. + */ + Name?: String; + /** + * The user's SSH user name. + */ + SshUsername?: String; + /** + * The user's SSH public key. + */ + SshPublicKey?: String; + } + export interface ServiceError { + /** + * The error ID. + */ + ServiceErrorId?: String; + /** + * The stack ID. + */ + StackId?: String; + /** + * The instance ID. + */ + InstanceId?: String; + /** + * The error type. + */ + Type?: String; + /** + * A message that describes the error. + */ + Message?: String; + /** + * When the error occurred. + */ + CreatedAt?: DateTime; + } + export type ServiceErrors = ServiceError[]; + export interface SetLoadBasedAutoScalingRequest { + /** + * The layer ID. + */ + LayerId: String; + /** + * Enables load-based auto scaling for the layer. + */ + Enable?: Boolean; + /** + * An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances. + */ + UpScaling?: AutoScalingThresholds; + /** + * An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances. + */ + DownScaling?: AutoScalingThresholds; + } + export interface SetPermissionRequest { + /** + * The stack ID. + */ + StackId: String; + /** + * The user's IAM ARN. This can also be a federated user's ARN. + */ + IamUserArn: String; + /** + * The user is allowed to use SSH to communicate with the instance. + */ + AllowSsh?: Boolean; + /** + * The user is allowed to use sudo to elevate privileges. + */ + AllowSudo?: Boolean; + /** + * The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level. deny show deploy manage iam_only For more information about the permissions associated with these levels, see Managing User Permissions. + */ + Level?: String; + } + export interface SetTimeBasedAutoScalingRequest { + /** + * The instance ID. + */ + InstanceId: String; + /** + * An AutoScalingSchedule with the instance schedule. + */ + AutoScalingSchedule?: WeeklyAutoScalingSchedule; + } + export interface ShutdownEventConfiguration { + /** + * The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance. + */ + ExecutionTimeout?: Integer; + /** + * Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining + */ + DelayUntilElbConnectionsDrained?: Boolean; + } + export interface Source { + /** + * The repository type. + */ + Type?: SourceType; + /** + * The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz. + */ + Url?: String; + /** + * This parameter depends on the repository type. For Amazon S3 bundles, set Username to the appropriate IAM access key ID. For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name. + */ + Username?: String; + /** + * When included in a request, the parameter depends on the repository type. For Amazon S3 bundles, set Password to the appropriate IAM secret access key. For HTTP bundles and Subversion repositories, set Password to the password. For more information on how to safely handle IAM credentials, see http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html. In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value. + */ + Password?: String; + /** + * In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value. + */ + SshKey?: String; + /** + * The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. + */ + Revision?: String; + } + export type SourceType = "git"|"svn"|"archive"|"s3"|string; + export interface SslConfiguration { + /** + * The contents of the certificate's domain.crt file. + */ + Certificate: String; + /** + * The private key; the contents of the certificate's domain.kex file. + */ + PrivateKey: String; + /** + * Optional. Can be used to specify an intermediate certificate authority key or client authentication. + */ + Chain?: String; + } + export interface Stack { + /** + * The stack ID. + */ + StackId?: String; + /** + * The stack name. + */ + Name?: String; + /** + * The stack's ARN. + */ + Arn?: String; + /** + * The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints. + */ + Region?: String; + /** + * The VPC ID; applicable only if the stack is running in a VPC. + */ + VpcId?: String; + /** + * The stack's attributes. + */ + Attributes?: StackAttributes; + /** + * The stack AWS Identity and Access Management (IAM) role. + */ + ServiceRoleArn?: String; + /** + * The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. + */ + DefaultInstanceProfileArn?: String; + /** + * The stack's default operating system. + */ + DefaultOs?: String; + /** + * The stack host name theme, with spaces replaced by underscores. + */ + HostnameTheme?: String; + /** + * The stack's default Availability Zone. For more information, see Regions and Endpoints. + */ + DefaultAvailabilityZone?: String; + /** + * The default subnet ID; applicable only if the stack is running in a VPC. + */ + DefaultSubnetId?: String; + /** + * A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. + */ + CustomJson?: String; + /** + * The configuration manager. + */ + ConfigurationManager?: StackConfigurationManager; + /** + * A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack. + */ + ChefConfiguration?: ChefConfiguration; + /** + * Whether the stack uses custom cookbooks. + */ + UseCustomCookbooks?: Boolean; + /** + * Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers. + */ + UseOpsworksSecurityGroups?: Boolean; + CustomCookbooksSource?: Source; + /** + * A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance. + */ + DefaultSshKeyName?: String; + /** + * The date when the stack was created. + */ + CreatedAt?: DateTime; + /** + * The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. + */ + DefaultRootDeviceType?: RootDeviceType; + /** + * The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version. + */ + AgentVersion?: String; + } + export type StackAttributes = {[key: string]: String}; + export type StackAttributesKeys = "Color"|string; + export interface StackConfigurationManager { + /** + * The name. This parameter must be set to "Chef". + */ + Name?: String; + /** + * The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. + */ + Version?: String; + } + export interface StackSummary { + /** + * The stack ID. + */ + StackId?: String; + /** + * The stack name. + */ + Name?: String; + /** + * The stack's ARN. + */ + Arn?: String; + /** + * The number of layers. + */ + LayersCount?: Integer; + /** + * The number of apps. + */ + AppsCount?: Integer; + /** + * An InstancesCount object with the number of instances in each status. + */ + InstancesCount?: InstancesCount; + } + export type Stacks = Stack[]; + export interface StartInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + } + export interface StartStackRequest { + /** + * The stack ID. + */ + StackId: String; + } + export interface StopInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + /** + * Specifies whether to force an instance to stop. + */ + Force?: Boolean; + } + export interface StopStackRequest { + /** + * The stack ID. + */ + StackId: String; + } + export type String = string; + export type Strings = String[]; + export type Switch = string; + export type TagKey = string; + export type TagKeys = TagKey[]; + export interface TagResourceRequest { + /** + * The stack or layer's Amazon Resource Number (ARN). + */ + ResourceArn: ResourceArn; + /** + * A map that contains tag keys and tag values that are attached to a stack or layer. The key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / Leading and trailing white spaces are trimmed from both the key and value. A maximum of 40 tags is allowed for any resource. + */ + Tags: Tags; + } + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export interface TemporaryCredential { + /** + * The user name. + */ + Username?: String; + /** + * The password. + */ + Password?: String; + /** + * The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out. + */ + ValidForInMinutes?: Integer; + /** + * The instance's AWS OpsWorks Stacks ID. + */ + InstanceId?: String; + } + export interface TimeBasedAutoScalingConfiguration { + /** + * The instance ID. + */ + InstanceId?: String; + /** + * A WeeklyAutoScalingSchedule object with the instance schedule. + */ + AutoScalingSchedule?: WeeklyAutoScalingSchedule; + } + export type TimeBasedAutoScalingConfigurations = TimeBasedAutoScalingConfiguration[]; + export interface UnassignInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + } + export interface UnassignVolumeRequest { + /** + * The volume ID. + */ + VolumeId: String; + } + export interface UntagResourceRequest { + /** + * The stack or layer's Amazon Resource Number (ARN). + */ + ResourceArn: ResourceArn; + /** + * A list of the keys of tags to be removed from a stack or layer. + */ + TagKeys: TagKeys; + } + export interface UpdateAppRequest { + /** + * The app ID. + */ + AppId: String; + /** + * The app name. + */ + Name?: String; + /** + * A description of the app. + */ + Description?: String; + /** + * The app's data sources. + */ + DataSources?: DataSources; + /** + * The app type. + */ + Type?: AppType; + /** + * A Source object that specifies the app repository. + */ + AppSource?: Source; + /** + * The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com' + */ + Domains?: Strings; + /** + * Whether SSL is enabled for the app. + */ + EnableSsl?: Boolean; + /** + * An SslConfiguration object with the SSL configuration. + */ + SslConfiguration?: SslConfiguration; + /** + * One or more user-defined key/value pairs to be added to the stack attributes. + */ + Attributes?: AppAttributes; + /** + * An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version. + */ + Environment?: EnvironmentVariables; + } + export interface UpdateElasticIpRequest { + /** + * The IP address for which you want to update the name. + */ + ElasticIp: String; + /** + * The new name. + */ + Name?: String; + } + export interface UpdateInstanceRequest { + /** + * The instance ID. + */ + InstanceId: String; + /** + * The instance's layer IDs. + */ + LayerIds?: Strings; + /** + * The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table. + */ + InstanceType?: String; + /** + * For load-based or time-based instances, the type. Windows stacks can use only time-based instances. + */ + AutoScalingType?: AutoScalingType; + /** + * The instance host name. + */ + Hostname?: String; + /** + * The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI. A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems. The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs. You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. + */ + Os?: String; + /** + * The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. + */ + AmiId?: String; + /** + * The instance's Amazon EC2 key name. + */ + SshKeyName?: String; + /** + * The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types. + */ + Architecture?: Architecture; + /** + * Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true, to ensure that your instances have the latest security updates. + */ + InstallUpdatesOnBoot?: Boolean; + /** + * This property cannot be updated. + */ + EbsOptimized?: Boolean; + /** + * The default AWS OpsWorks Stacks agent version. You have the following options: INHERIT - Use the stack's default agent version setting. version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance. The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. + */ + AgentVersion?: String; + } + export interface UpdateLayerRequest { + /** + * The layer ID. + */ + LayerId: String; + /** + * The layer name, which is used by the console. + */ + Name?: String; + /** + * For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/. The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference + */ + Shortname?: String; + /** + * One or more user-defined key/value pairs to be added to the stack attributes. + */ + Attributes?: LayerAttributes; + /** + * Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream. + */ + CloudWatchLogsConfiguration?: CloudWatchLogsConfiguration; + /** + * The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers. + */ + CustomInstanceProfileArn?: String; + /** + * A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. + */ + CustomJson?: String; + /** + * An array containing the layer's custom security group IDs. + */ + CustomSecurityGroupIds?: Strings; + /** + * An array of Package objects that describe the layer's packages. + */ + Packages?: Strings; + /** + * A VolumeConfigurations object that describes the layer's Amazon EBS volumes. + */ + VolumeConfigurations?: VolumeConfigurations; + /** + * Whether to disable auto healing for the layer. + */ + EnableAutoHealing?: Boolean; + /** + * Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer. + */ + AutoAssignElasticIps?: Boolean; + /** + * For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer. + */ + AutoAssignPublicIps?: Boolean; + /** + * A LayerCustomRecipes object that specifies the layer's custom recipes. + */ + CustomRecipes?: Recipes; + /** + * Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the default value of true, to ensure that your instances have the latest security updates. + */ + InstallUpdatesOnBoot?: Boolean; + /** + * Whether to use Amazon EBS-optimized instances. + */ + UseEbsOptimizedInstances?: Boolean; + /** + * + */ + LifecycleEventConfiguration?: LifecycleEventConfiguration; + } + export interface UpdateMyUserProfileRequest { + /** + * The user's SSH public key. + */ + SshPublicKey?: String; + } + export interface UpdateRdsDbInstanceRequest { + /** + * The Amazon RDS instance's ARN. + */ + RdsDbInstanceArn: String; + /** + * The master user name. + */ + DbUser?: String; + /** + * The database password. + */ + DbPassword?: String; + } + export interface UpdateStackRequest { + /** + * The stack ID. + */ + StackId: String; + /** + * The stack's new name. + */ + Name?: String; + /** + * One or more user-defined key-value pairs to be added to the stack attributes. + */ + Attributes?: StackAttributes; + /** + * Do not use this parameter. You cannot update a stack's service role. + */ + ServiceRoleArn?: String; + /** + * The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers. + */ + DefaultInstanceProfileArn?: String; + /** + * The stack's operating system, which must be set to one of the following: A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. CentOS Linux 7 Red Hat Enterprise Linux 7 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs. The default option is the stack's current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems. + */ + DefaultOs?: String; + /** + * The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are: Baked_Goods Clouds Europe_Cities Fruits Greek_Deities Legendary_creatures_from_Japan Planets_and_Moons Roman_Deities Scottish_Islands US_Cities Wild_Cats To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme. + */ + HostnameTheme?: String; + /** + * The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack. + */ + DefaultAvailabilityZone?: String; + /** + * The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description. + */ + DefaultSubnetId?: String; + /** + * A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes. + */ + CustomJson?: String; + /** + * The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. + */ + ConfigurationManager?: StackConfigurationManager; + /** + * A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack. + */ + ChefConfiguration?: ChefConfiguration; + /** + * Whether the stack uses custom cookbooks. + */ + UseCustomCookbooks?: Boolean; + CustomCookbooksSource?: Source; + /** + * A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance. + */ + DefaultSshKeyName?: String; + /** + * The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device. + */ + DefaultRootDeviceType?: RootDeviceType; + /** + * Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings: True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings. For more information, see Create a New Stack. + */ + UseOpsworksSecurityGroups?: Boolean; + /** + * The default AWS OpsWorks Stacks agent version. You have the following options: Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. + */ + AgentVersion?: String; + } + export interface UpdateUserProfileRequest { + /** + * The user IAM ARN. This can also be a federated user's ARN. + */ + IamUserArn: String; + /** + * The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. + */ + SshUsername?: String; + /** + * The user's new SSH public key. + */ + SshPublicKey?: String; + /** + * Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions. + */ + AllowSelfManagement?: Boolean; + } + export interface UpdateVolumeRequest { + /** + * The volume ID. + */ + VolumeId: String; + /** + * The new name. + */ + Name?: String; + /** + * The new mount point. + */ + MountPoint?: String; + } + export interface UserProfile { + /** + * The user's IAM ARN. + */ + IamUserArn?: String; + /** + * The user's name. + */ + Name?: String; + /** + * The user's SSH user name. + */ + SshUsername?: String; + /** + * The user's SSH public key. + */ + SshPublicKey?: String; + /** + * Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions. + */ + AllowSelfManagement?: Boolean; + } + export type UserProfiles = UserProfile[]; + export type ValidForInMinutes = number; + export type VirtualizationType = "paravirtual"|"hvm"|string; + export interface Volume { + /** + * The volume ID. + */ + VolumeId?: String; + /** + * The Amazon EC2 volume ID. + */ + Ec2VolumeId?: String; + /** + * The volume name. + */ + Name?: String; + /** + * The RAID array ID. + */ + RaidArrayId?: String; + /** + * The instance ID. + */ + InstanceId?: String; + /** + * The value returned by DescribeVolumes. + */ + Status?: String; + /** + * The volume size. + */ + Size?: Integer; + /** + * The device name. + */ + Device?: String; + /** + * The volume mount point. For example, "/mnt/disk1". + */ + MountPoint?: String; + /** + * The AWS region. For more information about AWS regions, see Regions and Endpoints. + */ + Region?: String; + /** + * The volume Availability Zone. For more information, see Regions and Endpoints. + */ + AvailabilityZone?: String; + /** + * The volume type. For more information, see Amazon EBS Volume Types. standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. + */ + VolumeType?: String; + /** + * For PIOPS volumes, the IOPS per disk. + */ + Iops?: Integer; + /** + * Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. + */ + Encrypted?: Boolean; + } + export interface VolumeConfiguration { + /** + * The volume mount point. For example "/dev/sdh". + */ + MountPoint: String; + /** + * The volume RAID level. + */ + RaidLevel?: Integer; + /** + * The number of disks in the volume. + */ + NumberOfDisks: Integer; + /** + * The volume size. + */ + Size: Integer; + /** + * The volume type. For more information, see Amazon EBS Volume Types. standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. + */ + VolumeType?: String; + /** + * For PIOPS volumes, the IOPS per disk. + */ + Iops?: Integer; + /** + * Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption. + */ + Encrypted?: Boolean; + } + export type VolumeConfigurations = VolumeConfiguration[]; + export type VolumeType = "gp2"|"io1"|"standard"|string; + export type Volumes = Volume[]; + export interface WeeklyAutoScalingSchedule { + /** + * The schedule for Monday. + */ + Monday?: DailyAutoScalingSchedule; + /** + * The schedule for Tuesday. + */ + Tuesday?: DailyAutoScalingSchedule; + /** + * The schedule for Wednesday. + */ + Wednesday?: DailyAutoScalingSchedule; + /** + * The schedule for Thursday. + */ + Thursday?: DailyAutoScalingSchedule; + /** + * The schedule for Friday. + */ + Friday?: DailyAutoScalingSchedule; + /** + * The schedule for Saturday. + */ + Saturday?: DailyAutoScalingSchedule; + /** + * The schedule for Sunday. + */ + Sunday?: DailyAutoScalingSchedule; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-02-18"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the OpsWorks client. + */ + export import Types = OpsWorks; +} +export = OpsWorks; diff --git a/node_modules/aws-sdk/clients/opsworks.js b/node_modules/aws-sdk/clients/opsworks.js new file mode 100644 index 0000000..23ea631 --- /dev/null +++ b/node_modules/aws-sdk/clients/opsworks.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['opsworks'] = {}; +AWS.OpsWorks = Service.defineService('opsworks', ['2013-02-18']); +Object.defineProperty(apiLoader.services['opsworks'], '2013-02-18', { + get: function get() { + var model = require('../apis/opsworks-2013-02-18.min.json'); + model.paginators = require('../apis/opsworks-2013-02-18.paginators.json').pagination; + model.waiters = require('../apis/opsworks-2013-02-18.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.OpsWorks; diff --git a/node_modules/aws-sdk/clients/opsworkscm.d.ts b/node_modules/aws-sdk/clients/opsworkscm.d.ts new file mode 100644 index 0000000..6cfb692 --- /dev/null +++ b/node_modules/aws-sdk/clients/opsworkscm.d.ts @@ -0,0 +1,787 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class OpsWorksCM extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: OpsWorksCM.Types.ClientConfiguration) + config: Config & OpsWorksCM.Types.ClientConfiguration; + /** + * Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode. On a Chef server: This command is an alternative to knife bootstrap. Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem" On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR. Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem" A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance. + */ + associateNode(params: OpsWorksCM.Types.AssociateNodeRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.AssociateNodeResponse) => void): Request; + /** + * Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode. On a Chef server: This command is an alternative to knife bootstrap. Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem" On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR. Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem" A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance. + */ + associateNode(callback?: (err: AWSError, data: OpsWorksCM.Types.AssociateNodeResponse) => void): Request; + /** + * Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created. Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups. This operation is asynchronous. A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid. + */ + createBackup(params: OpsWorksCM.Types.CreateBackupRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.CreateBackupResponse) => void): Request; + /** + * Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created. Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups. This operation is asynchronous. A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid. + */ + createBackup(callback?: (err: AWSError, data: OpsWorksCM.Types.CreateBackupResponse) => void): Request; + /** + * Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers. This operation is asynchronous. A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid. If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group. Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console. + */ + createServer(params: OpsWorksCM.Types.CreateServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.CreateServerResponse) => void): Request; + /** + * Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers. This operation is asynchronous. A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid. If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group. Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console. + */ + createServer(callback?: (err: AWSError, data: OpsWorksCM.Types.CreateServerResponse) => void): Request; + /** + * Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous. An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid. + */ + deleteBackup(params: OpsWorksCM.Types.DeleteBackupRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteBackupResponse) => void): Request; + /** + * Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous. An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid. + */ + deleteBackup(callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteBackupResponse) => void): Request; + /** + * Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. This operation is asynchronous. An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + deleteServer(params: OpsWorksCM.Types.DeleteServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteServerResponse) => void): Request; + /** + * Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. This operation is asynchronous. An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + deleteServer(callback?: (err: AWSError, data: OpsWorksCM.Types.DeleteServerResponse) => void): Request; + /** + * Describes your account attributes, and creates requests to increase limits before they are reached or exceeded. This operation is synchronous. + */ + describeAccountAttributes(params: OpsWorksCM.Types.DescribeAccountAttributesRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeAccountAttributesResponse) => void): Request; + /** + * Describes your account attributes, and creates requests to increase limits before they are reached or exceeded. This operation is synchronous. + */ + describeAccountAttributes(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeAccountAttributesResponse) => void): Request; + /** + * Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups. This operation is synchronous. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeBackups(params: OpsWorksCM.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeBackupsResponse) => void): Request; + /** + * Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups. This operation is synchronous. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeBackups(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeBackupsResponse) => void): Request; + /** + * Describes events for a specified server. Results are ordered by time, with newest events first. This operation is synchronous. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeEvents(params: OpsWorksCM.Types.DescribeEventsRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeEventsResponse) => void): Request; + /** + * Describes events for a specified server. Results are ordered by time, with newest events first. This operation is synchronous. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeEvents(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeEventsResponse) => void): Request; + /** + * Returns the current status of an existing association or disassociation request. A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeNodeAssociationStatus(params: OpsWorksCM.Types.DescribeNodeAssociationStatusRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request; + /** + * Returns the current status of an existing association or disassociation request. A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeNodeAssociationStatus(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request; + /** + * Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services. This operation is synchronous. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeServers(params: OpsWorksCM.Types.DescribeServersRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeServersResponse) => void): Request; + /** + * Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services. This operation is synchronous. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + describeServers(callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeServersResponse) => void): Request; + /** + * Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode. A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + disassociateNode(params: OpsWorksCM.Types.DisassociateNodeRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.DisassociateNodeResponse) => void): Request; + /** + * Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode. A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + disassociateNode(callback?: (err: AWSError, data: OpsWorksCM.Types.DisassociateNodeResponse) => void): Request; + /** + * Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server. This operation is synchronous. A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING. + */ + exportServerEngineAttribute(params: OpsWorksCM.Types.ExportServerEngineAttributeRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.ExportServerEngineAttributeResponse) => void): Request; + /** + * Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server. This operation is synchronous. A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING. + */ + exportServerEngineAttribute(callback?: (err: AWSError, data: OpsWorksCM.Types.ExportServerEngineAttributeResponse) => void): Request; + /** + * Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. This operation is asynchronous. An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + restoreServer(params: OpsWorksCM.Types.RestoreServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.RestoreServerResponse) => void): Request; + /** + * Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. This operation is asynchronous. An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + restoreServer(callback?: (err: AWSError, data: OpsWorksCM.Types.RestoreServerResponse) => void): Request; + /** + * Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress. Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + startMaintenance(params: OpsWorksCM.Types.StartMaintenanceRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.StartMaintenanceResponse) => void): Request; + /** + * Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress. Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + startMaintenance(callback?: (err: AWSError, data: OpsWorksCM.Types.StartMaintenanceResponse) => void): Request; + /** + * Updates settings for a server. This operation is synchronous. + */ + updateServer(params: OpsWorksCM.Types.UpdateServerRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerResponse) => void): Request; + /** + * Updates settings for a server. This operation is synchronous. + */ + updateServer(callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerResponse) => void): Request; + /** + * Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD). This operation is asynchronous. This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + updateServerEngineAttributes(params: OpsWorksCM.Types.UpdateServerEngineAttributesRequest, callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerEngineAttributesResponse) => void): Request; + /** + * Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD). This operation is asynchronous. This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. + */ + updateServerEngineAttributes(callback?: (err: AWSError, data: OpsWorksCM.Types.UpdateServerEngineAttributesResponse) => void): Request; + /** + * Waits for the nodeAssociated state by periodically calling the underlying OpsWorksCM.describeNodeAssociationStatusoperation every 15 seconds (at most 15 times). Wait until node is associated or disassociated. + */ + waitFor(state: "nodeAssociated", params: OpsWorksCM.Types.DescribeNodeAssociationStatusRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request; + /** + * Waits for the nodeAssociated state by periodically calling the underlying OpsWorksCM.describeNodeAssociationStatusoperation every 15 seconds (at most 15 times). Wait until node is associated or disassociated. + */ + waitFor(state: "nodeAssociated", callback?: (err: AWSError, data: OpsWorksCM.Types.DescribeNodeAssociationStatusResponse) => void): Request; +} +declare namespace OpsWorksCM { + export interface AccountAttribute { + /** + * The attribute name. The following are supported attribute names. ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers. ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved. + */ + Name?: String; + /** + * The maximum allowed value. + */ + Maximum?: Integer; + /** + * The current usage, such as the current number of servers that are associated with the account. + */ + Used?: Integer; + } + export type AccountAttributes = AccountAttribute[]; + export interface AssociateNodeRequest { + /** + * The name of the server with which to associate the node. + */ + ServerName: ServerName; + /** + * The name of the node. + */ + NodeName: NodeName; + /** + * Engine attributes used for associating the node. Attributes accepted in a AssociateNode request for Chef CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one organization named default can exist. CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API. Attributes accepted in a AssociateNode request for Puppet PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node. + */ + EngineAttributes: EngineAttributes; + } + export interface AssociateNodeResponse { + /** + * Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the association request. + */ + NodeAssociationStatusToken?: NodeAssociationStatusToken; + } + export type AttributeName = string; + export type AttributeValue = string; + export interface Backup { + /** + * The ARN of the backup. + */ + BackupArn?: String; + /** + * The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS + */ + BackupId?: BackupId; + /** + * The backup type. Valid values are automated or manual. + */ + BackupType?: BackupType; + /** + * The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z + */ + CreatedAt?: Timestamp; + /** + * A user-provided description for a manual backup. This field is empty for automated backups. + */ + Description?: String; + /** + * The engine type that is obtained from the server when the backup is created. + */ + Engine?: String; + /** + * The engine model that is obtained from the server when the backup is created. + */ + EngineModel?: String; + /** + * The engine version that is obtained from the server when the backup is created. + */ + EngineVersion?: String; + /** + * The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup. + */ + InstanceProfileArn?: String; + /** + * The instance type that is obtained from the server when the backup is created. + */ + InstanceType?: String; + /** + * The key pair that is obtained from the server when the backup is created. + */ + KeyPair?: String; + /** + * The preferred backup period that is obtained from the server when the backup is created. + */ + PreferredBackupWindow?: TimeWindowDefinition; + /** + * The preferred maintenance period that is obtained from the server when the backup is created. + */ + PreferredMaintenanceWindow?: TimeWindowDefinition; + /** + * This field is deprecated and is no longer used. + */ + S3DataSize?: Integer; + /** + * This field is deprecated and is no longer used. + */ + S3DataUrl?: String; + /** + * The Amazon S3 URL of the backup's log file. + */ + S3LogUrl?: String; + /** + * The security group IDs that are obtained from the server when the backup is created. + */ + SecurityGroupIds?: Strings; + /** + * The name of the server from which the backup was made. + */ + ServerName?: ServerName; + /** + * The service role ARN that is obtained from the server when the backup is created. + */ + ServiceRoleArn?: String; + /** + * The status of a backup while in progress. + */ + Status?: BackupStatus; + /** + * An informational message about backup status. + */ + StatusDescription?: String; + /** + * The subnet IDs that are obtained from the server when the backup is created. + */ + SubnetIds?: Strings; + /** + * The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created. + */ + ToolsVersion?: String; + /** + * The IAM user ARN of the requester for manual backups. This field is empty for automated backups. + */ + UserArn?: String; + } + export type BackupId = string; + export type BackupRetentionCountDefinition = number; + export type BackupStatus = "IN_PROGRESS"|"OK"|"FAILED"|"DELETING"|string; + export type BackupType = "AUTOMATED"|"MANUAL"|string; + export type Backups = Backup[]; + export type Boolean = boolean; + export interface CreateBackupRequest { + /** + * The name of the server that you want to back up. + */ + ServerName: ServerName; + /** + * A user-defined description of the backup. + */ + Description?: String; + } + export interface CreateBackupResponse { + /** + * Backup created by request. + */ + Backup?: Backup; + } + export interface CreateServerRequest { + /** + * Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true. + */ + AssociatePublicIpAddress?: Boolean; + /** + * Enable or disable scheduled backups. Valid values are true or false. The default value is true. + */ + DisableAutomatedBackup?: Boolean; + /** + * The configuration management engine to use. Valid values include Chef and Puppet. + */ + Engine?: String; + /** + * The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef. + */ + EngineModel?: String; + /** + * The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017. + */ + EngineVersion?: String; + /** + * Optional engine attributes on a specified server. Attributes accepted in a Chef createServer request: CHEF_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, a private key is generated and returned in the response. CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_DELIVERY_ADMIN_PASSWORD is set, one is generated and returned in the response. Attributes accepted in a Puppet createServer request: PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters. PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170. PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify an SSH URL and a PEM-encoded private SSH key. + */ + EngineAttributes?: EngineAttributes; + /** + * The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1. + */ + BackupRetentionCount?: BackupRetentionCountDefinition; + /** + * The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. + */ + ServerName: ServerName; + /** + * The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need. + */ + InstanceProfileArn: InstanceProfileArn; + /** + * The Amazon EC2 instance type to use. For example, m4.large. Recommended instance types include t2.medium and greater, m4.*, or c4.xlarge and greater. + */ + InstanceType: String; + /** + * The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH. + */ + KeyPair?: KeyPair; + /** + * The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information. Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) + */ + PreferredMaintenanceWindow?: TimeWindowDefinition; + /** + * The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats: HH:MM for daily backups DDD:HH:MM for weekly backups The specified time is in coordinated universal time (UTC). The default value is a random, daily start time. Example: 08:00, which represents a daily start time of 08:00 UTC. Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) + */ + PreferredBackupWindow?: TimeWindowDefinition; + /** + * A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds. If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone). + */ + SecurityGroupIds?: Strings; + /** + * The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need. + */ + ServiceRoleArn: ServiceRoleArn; + /** + * The IDs of subnets in which to launch the server EC2 instance. Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more information about supported Amazon EC2 platforms, see Supported Platforms. + */ + SubnetIds?: Strings; + /** + * If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. + */ + BackupId?: BackupId; + } + export interface CreateServerResponse { + /** + * The server that is created by the request. + */ + Server?: Server; + } + export interface DeleteBackupRequest { + /** + * The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS. + */ + BackupId: BackupId; + } + export interface DeleteBackupResponse { + } + export interface DeleteServerRequest { + /** + * The ID of the server to delete. + */ + ServerName: ServerName; + } + export interface DeleteServerResponse { + } + export interface DescribeAccountAttributesRequest { + } + export interface DescribeAccountAttributesResponse { + /** + * The attributes that are currently set for the account. + */ + Attributes?: AccountAttributes; + } + export interface DescribeBackupsRequest { + /** + * Describes a single backup. + */ + BackupId?: BackupId; + /** + * Returns backups for the server with the specified ServerName. + */ + ServerName?: ServerName; + /** + * This is not currently implemented for DescribeBackups requests. + */ + NextToken?: NextToken; + /** + * This is not currently implemented for DescribeBackups requests. + */ + MaxResults?: MaxResults; + } + export interface DescribeBackupsResponse { + /** + * Contains the response to a DescribeBackups request. + */ + Backups?: Backups; + /** + * This is not currently implemented for DescribeBackups requests. + */ + NextToken?: String; + } + export interface DescribeEventsRequest { + /** + * The name of the server for which you want to view events. + */ + ServerName: ServerName; + /** + * NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur. + */ + NextToken?: NextToken; + /** + * To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface DescribeEventsResponse { + /** + * Contains the response to a DescribeEvents request. + */ + ServerEvents?: ServerEvents; + /** + * NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur. + */ + NextToken?: String; + } + export interface DescribeNodeAssociationStatusRequest { + /** + * The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse. + */ + NodeAssociationStatusToken: NodeAssociationStatusToken; + /** + * The name of the server from which to disassociate the node. + */ + ServerName: ServerName; + } + export interface DescribeNodeAssociationStatusResponse { + /** + * The status of the association or disassociation request. Possible values: SUCCESS: The association or disassociation succeeded. FAILED: The association or disassociation failed. IN_PROGRESS: The association or disassociation is still in progress. + */ + NodeAssociationStatus?: NodeAssociationStatus; + /** + * Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR). + */ + EngineAttributes?: EngineAttributes; + } + export interface DescribeServersRequest { + /** + * Describes the server with the specified ServerName. + */ + ServerName?: ServerName; + /** + * This is not currently implemented for DescribeServers requests. + */ + NextToken?: NextToken; + /** + * This is not currently implemented for DescribeServers requests. + */ + MaxResults?: MaxResults; + } + export interface DescribeServersResponse { + /** + * Contains the response to a DescribeServers request. For Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates. + */ + Servers?: Servers; + /** + * This is not currently implemented for DescribeServers requests. + */ + NextToken?: String; + } + export interface DisassociateNodeRequest { + /** + * The name of the server from which to disassociate the node. + */ + ServerName: ServerName; + /** + * The name of the client node. + */ + NodeName: NodeName; + /** + * Engine attributes that are used for disassociating the node. No attributes are required for Puppet. Attributes required in a DisassociateNode request for Chef CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist. + */ + EngineAttributes?: EngineAttributes; + } + export interface DisassociateNodeResponse { + /** + * Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request. + */ + NodeAssociationStatusToken?: NodeAssociationStatusToken; + } + export interface EngineAttribute { + /** + * The name of the engine attribute. + */ + Name?: EngineAttributeName; + /** + * The value of the engine attribute. + */ + Value?: EngineAttributeValue; + } + export type EngineAttributeName = string; + export type EngineAttributeValue = string; + export type EngineAttributes = EngineAttribute[]; + export interface ExportServerEngineAttributeRequest { + /** + * The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list. + */ + ExportAttributeName: String; + /** + * The name of the server from which you are exporting the attribute. + */ + ServerName: ServerName; + /** + * The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names. RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored. OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored. NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored. NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored. + */ + InputAttributes?: EngineAttributes; + } + export interface ExportServerEngineAttributeResponse { + /** + * The requested engine attribute pair with attribute name and value. + */ + EngineAttribute?: EngineAttribute; + /** + * The server name used in the request. + */ + ServerName?: ServerName; + } + export type InstanceProfileArn = string; + export type Integer = number; + export type KeyPair = string; + export type MaintenanceStatus = "SUCCESS"|"FAILED"|string; + export type MaxResults = number; + export type NextToken = string; + export type NodeAssociationStatus = "SUCCESS"|"FAILED"|"IN_PROGRESS"|string; + export type NodeAssociationStatusToken = string; + export type NodeName = string; + export interface RestoreServerRequest { + /** + * The ID of the backup that you want to use to restore a server. + */ + BackupId: BackupId; + /** + * The name of the server that you want to restore. + */ + ServerName: ServerName; + /** + * The type of the instance to create. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium, m4.large, and m4.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. + */ + InstanceType?: String; + /** + * The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key. + */ + KeyPair?: KeyPair; + } + export interface RestoreServerResponse { + } + export interface Server { + /** + * Associate a public IP address with a server that you are launching. + */ + AssociatePublicIpAddress?: Boolean; + /** + * The number of automated backups to keep. + */ + BackupRetentionCount?: Integer; + /** + * The name of the server. + */ + ServerName?: String; + /** + * Time stamp of server creation. Example 2016-07-29T13:38:47.520Z + */ + CreatedAt?: Timestamp; + /** + * The ARN of the CloudFormation stack that was used to create the server. + */ + CloudFormationStackArn?: String; + /** + * Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount. + */ + DisableAutomatedBackup?: Boolean; + /** + * A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io + */ + Endpoint?: String; + /** + * The engine type of the server. Valid values in this release include Chef and Puppet. + */ + Engine?: String; + /** + * The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef. + */ + EngineModel?: String; + /** + * The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer(). Attributes returned in a createServer response for Chef CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands. Attributes returned in a createServer response for Puppet PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online. + */ + EngineAttributes?: EngineAttributes; + /** + * The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017. + */ + EngineVersion?: String; + /** + * The instance profile ARN of the server. + */ + InstanceProfileArn?: String; + /** + * The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console. + */ + InstanceType?: String; + /** + * The key pair associated with the server. + */ + KeyPair?: String; + /** + * The status of the most recent server maintenance run. Shows SUCCESS or FAILED. + */ + MaintenanceStatus?: MaintenanceStatus; + /** + * The preferred maintenance period specified for the server. + */ + PreferredMaintenanceWindow?: TimeWindowDefinition; + /** + * The preferred backup period specified for the server. + */ + PreferredBackupWindow?: TimeWindowDefinition; + /** + * The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console. + */ + SecurityGroupIds?: Strings; + /** + * The service role ARN used to create the server. + */ + ServiceRoleArn?: String; + /** + * The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state. + */ + Status?: ServerStatus; + /** + * Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results). + */ + StatusReason?: String; + /** + * The subnet IDs specified in a CreateServer request. + */ + SubnetIds?: Strings; + /** + * The ARN of the server. + */ + ServerArn?: String; + } + export interface ServerEvent { + /** + * The time when the event occurred. + */ + CreatedAt?: Timestamp; + /** + * The name of the server on or for which the event occurred. + */ + ServerName?: String; + /** + * A human-readable informational or status message. + */ + Message?: String; + /** + * The Amazon S3 URL of the event's log file. + */ + LogUrl?: String; + } + export type ServerEvents = ServerEvent[]; + export type ServerName = string; + export type ServerStatus = "BACKING_UP"|"CONNECTION_LOST"|"CREATING"|"DELETING"|"MODIFYING"|"FAILED"|"HEALTHY"|"RUNNING"|"RESTORING"|"SETUP"|"UNDER_MAINTENANCE"|"UNHEALTHY"|"TERMINATED"|string; + export type Servers = Server[]; + export type ServiceRoleArn = string; + export interface StartMaintenanceRequest { + /** + * The name of the server on which to run maintenance. + */ + ServerName: ServerName; + /** + * Engine attributes that are specific to the server on which you want to run maintenance. + */ + EngineAttributes?: EngineAttributes; + } + export interface StartMaintenanceResponse { + /** + * Contains the response to a StartMaintenance request. + */ + Server?: Server; + } + export type String = string; + export type Strings = String[]; + export type TimeWindowDefinition = string; + export type Timestamp = Date; + export interface UpdateServerEngineAttributesRequest { + /** + * The name of the server to update. + */ + ServerName: ServerName; + /** + * The name of the engine attribute to update. + */ + AttributeName: AttributeName; + /** + * The value to set for the attribute. + */ + AttributeValue?: AttributeValue; + } + export interface UpdateServerEngineAttributesResponse { + /** + * Contains the response to an UpdateServerEngineAttributes request. + */ + Server?: Server; + } + export interface UpdateServerRequest { + /** + * Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default. + */ + DisableAutomatedBackup?: Boolean; + /** + * Sets the number of automated backups that you want to keep. + */ + BackupRetentionCount?: Integer; + /** + * The name of the server to update. + */ + ServerName: ServerName; + PreferredMaintenanceWindow?: TimeWindowDefinition; + PreferredBackupWindow?: TimeWindowDefinition; + } + export interface UpdateServerResponse { + /** + * Contains the response to a UpdateServer request. + */ + Server?: Server; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-11-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the OpsWorksCM client. + */ + export import Types = OpsWorksCM; +} +export = OpsWorksCM; diff --git a/node_modules/aws-sdk/clients/opsworkscm.js b/node_modules/aws-sdk/clients/opsworkscm.js new file mode 100644 index 0000000..cacc8b5 --- /dev/null +++ b/node_modules/aws-sdk/clients/opsworkscm.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['opsworkscm'] = {}; +AWS.OpsWorksCM = Service.defineService('opsworkscm', ['2016-11-01']); +Object.defineProperty(apiLoader.services['opsworkscm'], '2016-11-01', { + get: function get() { + var model = require('../apis/opsworkscm-2016-11-01.min.json'); + model.paginators = require('../apis/opsworkscm-2016-11-01.paginators.json').pagination; + model.waiters = require('../apis/opsworkscm-2016-11-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.OpsWorksCM; diff --git a/node_modules/aws-sdk/clients/organizations.d.ts b/node_modules/aws-sdk/clients/organizations.d.ts new file mode 100644 index 0000000..c7504f3 --- /dev/null +++ b/node_modules/aws-sdk/clients/organizations.d.ts @@ -0,0 +1,1382 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Organizations extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Organizations.Types.ClientConfiguration) + config: Config & Organizations.Types.ClientConfiguration; + /** + * Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request. This operation can be called only by the following principals when they also have the relevant IAM permissions: Invitation to join or Approve all features request handshakes: only a principal from the member account. The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, then the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide. Enable all features final confirmation handshake: only a principal from the master account. For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide. After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. + */ + acceptHandshake(params: Organizations.Types.AcceptHandshakeRequest, callback?: (err: AWSError, data: Organizations.Types.AcceptHandshakeResponse) => void): Request; + /** + * Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request. This operation can be called only by the following principals when they also have the relevant IAM permissions: Invitation to join or Approve all features request handshakes: only a principal from the member account. The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, then the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide. Enable all features final confirmation handshake: only a principal from the master account. For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide. After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. + */ + acceptHandshake(callback?: (err: AWSError, data: Organizations.Types.AcceptHandshakeResponse) => void): Request; + /** + * Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy: Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to: If you attach an SCP to a root, it affects all accounts in the organization. If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs. If you attach the policy directly to an account, then it affects only that account. SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP. AWS Organizations attaches a default SCP named "FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account. For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + attachPolicy(params: Organizations.Types.AttachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy: Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to: If you attach an SCP to a root, it affects all accounts in the organization. If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs. If you attach the policy directly to an account, then it affects only that account. SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP. AWS Organizations attaches a default SCP named "FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account. For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + attachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED. This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake. After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. + */ + cancelHandshake(params: Organizations.Types.CancelHandshakeRequest, callback?: (err: AWSError, data: Organizations.Types.CancelHandshakeResponse) => void): Request; + /** + * Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED. This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake. After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. + */ + cancelHandshake(callback?: (err: AWSError, data: Organizations.Types.CancelHandshakeResponse) => void): Request; + /** + * Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide. The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations will create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide. AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account. This operation can be called only from the organization's master account. For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support. Using CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools. + */ + createAccount(params: Organizations.Types.CreateAccountRequest, callback?: (err: AWSError, data: Organizations.Types.CreateAccountResponse) => void): Request; + /** + * Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide. The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations will create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide. AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account. This operation can be called only from the organization's master account. For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support. Using CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools. + */ + createAccount(callback?: (err: AWSError, data: Organizations.Types.CreateAccountResponse) => void): Request; + /** + * This action is available if all of the following are true: You are authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide. You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region. You call this action from the master account of your organization in the commercial Region. You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide. AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following: Verify that AWS CloudTrail is enabled to store logs. Create an S3 bucket for AWS CloudTrail log storage. For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide. You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide. Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide. When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address. A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide. For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support. Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools. + */ + createGovCloudAccount(params: Organizations.Types.CreateGovCloudAccountRequest, callback?: (err: AWSError, data: Organizations.Types.CreateGovCloudAccountResponse) => void): Request; + /** + * This action is available if all of the following are true: You are authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide. You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region. You call this action from the master account of your organization in the commercial Region. You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide. AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following: Verify that AWS CloudTrail is enabled to store logs. Create an S3 bucket for AWS CloudTrail log storage. For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide. You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide. Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide. When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address. A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide. For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support. Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools. + */ + createGovCloudAccount(callback?: (err: AWSError, data: Organizations.Types.CreateGovCloudAccountResponse) => void): Request; + /** + * Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization. This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions. By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING", then no policy types are enabled by default and you cannot use organization policies. + */ + createOrganization(params: Organizations.Types.CreateOrganizationRequest, callback?: (err: AWSError, data: Organizations.Types.CreateOrganizationResponse) => void): Request; + /** + * Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization. This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions. By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING", then no policy types are enabled by default and you cannot use organization policies. + */ + createOrganization(callback?: (err: AWSError, data: Organizations.Types.CreateOrganizationResponse) => void): Request; + /** + * Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five. For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + createOrganizationalUnit(params: Organizations.Types.CreateOrganizationalUnitRequest, callback?: (err: AWSError, data: Organizations.Types.CreateOrganizationalUnitResponse) => void): Request; + /** + * Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five. For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + createOrganizationalUnit(callback?: (err: AWSError, data: Organizations.Types.CreateOrganizationalUnitResponse) => void): Request; + /** + * Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account. For more information about policies and their use, see Managing Organization Policies. This operation can be called only from the organization's master account. + */ + createPolicy(params: Organizations.Types.CreatePolicyRequest, callback?: (err: AWSError, data: Organizations.Types.CreatePolicyResponse) => void): Request; + /** + * Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account. For more information about policies and their use, see Managing Organization Policies. This operation can be called only from the organization's master account. + */ + createPolicy(callback?: (err: AWSError, data: Organizations.Types.CreatePolicyResponse) => void): Request; + /** + * Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request. This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can re-initiate the process with a new handshake request. After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. + */ + declineHandshake(params: Organizations.Types.DeclineHandshakeRequest, callback?: (err: AWSError, data: Organizations.Types.DeclineHandshakeResponse) => void): Request; + /** + * Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request. This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can re-initiate the process with a new handshake request. After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. + */ + declineHandshake(callback?: (err: AWSError, data: Organizations.Types.DeclineHandshakeResponse) => void): Request; + /** + * Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts. + */ + deleteOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete. This operation can be called only from the organization's master account. + */ + deleteOrganizationalUnit(params: Organizations.Types.DeleteOrganizationalUnitRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete. This operation can be called only from the organization's master account. + */ + deleteOrganizationalUnit(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts. This operation can be called only from the organization's master account. + */ + deletePolicy(params: Organizations.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts. This operation can be called only from the organization's master account. + */ + deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves Organizations-related information about the specified account. This operation can be called only from the organization's master account. + */ + describeAccount(params: Organizations.Types.DescribeAccountRequest, callback?: (err: AWSError, data: Organizations.Types.DescribeAccountResponse) => void): Request; + /** + * Retrieves Organizations-related information about the specified account. This operation can be called only from the organization's master account. + */ + describeAccount(callback?: (err: AWSError, data: Organizations.Types.DescribeAccountResponse) => void): Request; + /** + * Retrieves the current status of an asynchronous request to create an account. This operation can be called only from the organization's master account. + */ + describeCreateAccountStatus(params: Organizations.Types.DescribeCreateAccountStatusRequest, callback?: (err: AWSError, data: Organizations.Types.DescribeCreateAccountStatusResponse) => void): Request; + /** + * Retrieves the current status of an asynchronous request to create an account. This operation can be called only from the organization's master account. + */ + describeCreateAccountStatus(callback?: (err: AWSError, data: Organizations.Types.DescribeCreateAccountStatusResponse) => void): Request; + /** + * Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake. You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible. This operation can be called from any account in the organization. + */ + describeHandshake(params: Organizations.Types.DescribeHandshakeRequest, callback?: (err: AWSError, data: Organizations.Types.DescribeHandshakeResponse) => void): Request; + /** + * Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake. You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible. This operation can be called from any account in the organization. + */ + describeHandshake(callback?: (err: AWSError, data: Organizations.Types.DescribeHandshakeResponse) => void): Request; + /** + * Retrieves information about the organization that the user's account belongs to. This operation can be called from any account in the organization. Even if a policy type is shown as available in the organization, it can be disabled separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root. + */ + describeOrganization(callback?: (err: AWSError, data: Organizations.Types.DescribeOrganizationResponse) => void): Request; + /** + * Retrieves information about an organizational unit (OU). This operation can be called only from the organization's master account. + */ + describeOrganizationalUnit(params: Organizations.Types.DescribeOrganizationalUnitRequest, callback?: (err: AWSError, data: Organizations.Types.DescribeOrganizationalUnitResponse) => void): Request; + /** + * Retrieves information about an organizational unit (OU). This operation can be called only from the organization's master account. + */ + describeOrganizationalUnit(callback?: (err: AWSError, data: Organizations.Types.DescribeOrganizationalUnitResponse) => void): Request; + /** + * Retrieves information about a policy. This operation can be called only from the organization's master account. + */ + describePolicy(params: Organizations.Types.DescribePolicyRequest, callback?: (err: AWSError, data: Organizations.Types.DescribePolicyResponse) => void): Request; + /** + * Retrieves information about a policy. This operation can be called only from the organization's master account. + */ + describePolicy(callback?: (err: AWSError, data: Organizations.Types.DescribePolicyResponse) => void): Request; + /** + * Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate. Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), then you are using the authorization strategy of blacklisting. This operation can be called only from the organization's master account. + */ + detachPolicy(params: Organizations.Types.DetachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate. Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), then you are using the authorization strategy of blacklisting. This operation can be called only from the organization's master account. + */ + detachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations. We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service. After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts unless the operations are explicitly permitted by the IAM policies that are attached to your roles. For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + disableAWSServiceAccess(params: Organizations.Types.DisableAWSServiceAccessRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations. We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service. After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts unless the operations are explicitly permitted by the IAM policies that are attached to your roles. For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + disableAWSServiceAccess(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation. This operation can be called only from the organization's master account. If you disable a policy type for a root, it still shows as enabled for the organization if all features are enabled in that organization. Use ListRoots to see the status of policy types for a specified root. Use DescribeOrganization to see the status of policy types in the organization. + */ + disablePolicyType(params: Organizations.Types.DisablePolicyTypeRequest, callback?: (err: AWSError, data: Organizations.Types.DisablePolicyTypeResponse) => void): Request; + /** + * Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation. This operation can be called only from the organization's master account. If you disable a policy type for a root, it still shows as enabled for the organization if all features are enabled in that organization. Use ListRoots to see the status of policy types for a specified root. Use DescribeOrganization to see the status of policy types in the organization. + */ + disablePolicyType(callback?: (err: AWSError, data: Organizations.Types.DisablePolicyTypeResponse) => void): Request; + /** + * Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts. We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service. For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide. This operation can be called only from the organization's master account and only if the organization has enabled all features. + */ + enableAWSServiceAccess(params: Organizations.Types.EnableAWSServiceAccessRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts. We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service. For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide. This operation can be called only from the organization's master account and only if the organization has enabled all features. + */ + enableAWSServiceAccess(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide. This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake. After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots. After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains "Action": "ENABLE_ALL_FEATURES". This completes the change. After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this. This operation can be called only from the organization's master account. + */ + enableAllFeatures(params: Organizations.Types.EnableAllFeaturesRequest, callback?: (err: AWSError, data: Organizations.Types.EnableAllFeaturesResponse) => void): Request; + /** + * Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide. This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake. After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots. After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains "Action": "ENABLE_ALL_FEATURES". This completes the change. After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this. This operation can be called only from the organization's master account. + */ + enableAllFeatures(callback?: (err: AWSError, data: Organizations.Types.EnableAllFeaturesResponse) => void): Request; + /** + * Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation. This operation can be called only from the organization's master account. You can enable a policy type in a root only if that policy type is available in the organization. Use DescribeOrganization to view the status of available policy types in the organization. To view the status of policy type in a root, use ListRoots. + */ + enablePolicyType(params: Organizations.Types.EnablePolicyTypeRequest, callback?: (err: AWSError, data: Organizations.Types.EnablePolicyTypeResponse) => void): Request; + /** + * Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation. This operation can be called only from the organization's master account. You can enable a policy type in a root only if that policy type is available in the organization. Use DescribeOrganization to view the status of available policy types in the organization. To view the status of policy type in a root, use ListRoots. + */ + enablePolicyType(callback?: (err: AWSError, data: Organizations.Types.EnablePolicyTypeResponse) => void): Request; + /** + * Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response. You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see Consolidated Billing in India. If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, then contact AWS Customer Support. This operation can be called only from the organization's master account. + */ + inviteAccountToOrganization(params: Organizations.Types.InviteAccountToOrganizationRequest, callback?: (err: AWSError, data: Organizations.Types.InviteAccountToOrganizationResponse) => void): Request; + /** + * Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response. You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see Consolidated Billing in India. If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, then contact AWS Customer Support. This operation can be called only from the organization's master account. + */ + inviteAccountToOrganization(callback?: (err: AWSError, data: Organizations.Types.InviteAccountToOrganizationResponse) => void): Request; + /** + * Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use RemoveAccountFromOrganization instead. This operation can be called only from a member account in the organization. The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling LeaveOrganization and leaving the organization. You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide. You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide. + */ + leaveOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts. For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + listAWSServiceAccessForOrganization(params: Organizations.Types.ListAWSServiceAccessForOrganizationRequest, callback?: (err: AWSError, data: Organizations.Types.ListAWSServiceAccessForOrganizationResponse) => void): Request; + /** + * Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts. For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide. This operation can be called only from the organization's master account. + */ + listAWSServiceAccessForOrganization(callback?: (err: AWSError, data: Organizations.Types.ListAWSServiceAccessForOrganizationResponse) => void): Request; + /** + * Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listAccounts(params: Organizations.Types.ListAccountsRequest, callback?: (err: AWSError, data: Organizations.Types.ListAccountsResponse) => void): Request; + /** + * Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listAccounts(callback?: (err: AWSError, data: Organizations.Types.ListAccountsResponse) => void): Request; + /** + * Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that are not in any OU. If you specify an OU, you get a list of all the accounts in only that OU, and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listAccountsForParent(params: Organizations.Types.ListAccountsForParentRequest, callback?: (err: AWSError, data: Organizations.Types.ListAccountsForParentResponse) => void): Request; + /** + * Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that are not in any OU. If you specify an OU, you get a list of all the accounts in only that OU, and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listAccountsForParent(callback?: (err: AWSError, data: Organizations.Types.ListAccountsForParentResponse) => void): Request; + /** + * Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listChildren(params: Organizations.Types.ListChildrenRequest, callback?: (err: AWSError, data: Organizations.Types.ListChildrenResponse) => void): Request; + /** + * Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listChildren(callback?: (err: AWSError, data: Organizations.Types.ListChildrenResponse) => void): Request; + /** + * Lists the account creation requests that match the specified status that is currently being tracked for the organization. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listCreateAccountStatus(params: Organizations.Types.ListCreateAccountStatusRequest, callback?: (err: AWSError, data: Organizations.Types.ListCreateAccountStatusResponse) => void): Request; + /** + * Lists the account creation requests that match the specified status that is currently being tracked for the organization. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listCreateAccountStatus(callback?: (err: AWSError, data: Organizations.Types.ListCreateAccountStatusResponse) => void): Request; + /** + * Lists the current handshakes that are associated with the account of the requesting user. Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called from any account in the organization. + */ + listHandshakesForAccount(params: Organizations.Types.ListHandshakesForAccountRequest, callback?: (err: AWSError, data: Organizations.Types.ListHandshakesForAccountResponse) => void): Request; + /** + * Lists the current handshakes that are associated with the account of the requesting user. Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called from any account in the organization. + */ + listHandshakesForAccount(callback?: (err: AWSError, data: Organizations.Types.ListHandshakesForAccountResponse) => void): Request; + /** + * Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake. Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listHandshakesForOrganization(params: Organizations.Types.ListHandshakesForOrganizationRequest, callback?: (err: AWSError, data: Organizations.Types.ListHandshakesForOrganizationResponse) => void): Request; + /** + * Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake. Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listHandshakesForOrganization(callback?: (err: AWSError, data: Organizations.Types.ListHandshakesForOrganizationResponse) => void): Request; + /** + * Lists the organizational units (OUs) in a parent organizational unit or root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listOrganizationalUnitsForParent(params: Organizations.Types.ListOrganizationalUnitsForParentRequest, callback?: (err: AWSError, data: Organizations.Types.ListOrganizationalUnitsForParentResponse) => void): Request; + /** + * Lists the organizational units (OUs) in a parent organizational unit or root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listOrganizationalUnitsForParent(callback?: (err: AWSError, data: Organizations.Types.ListOrganizationalUnitsForParentResponse) => void): Request; + /** + * Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. In the current release, a child can have only a single parent. + */ + listParents(params: Organizations.Types.ListParentsRequest, callback?: (err: AWSError, data: Organizations.Types.ListParentsResponse) => void): Request; + /** + * Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. In the current release, a child can have only a single parent. + */ + listParents(callback?: (err: AWSError, data: Organizations.Types.ListParentsResponse) => void): Request; + /** + * Retrieves the list of all policies in an organization of a specified type. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listPolicies(params: Organizations.Types.ListPoliciesRequest, callback?: (err: AWSError, data: Organizations.Types.ListPoliciesResponse) => void): Request; + /** + * Retrieves the list of all policies in an organization of a specified type. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listPolicies(callback?: (err: AWSError, data: Organizations.Types.ListPoliciesResponse) => void): Request; + /** + * Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listPoliciesForTarget(params: Organizations.Types.ListPoliciesForTargetRequest, callback?: (err: AWSError, data: Organizations.Types.ListPoliciesForTargetResponse) => void): Request; + /** + * Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listPoliciesForTarget(callback?: (err: AWSError, data: Organizations.Types.ListPoliciesForTargetResponse) => void): Request; + /** + * Lists the roots that are defined in the current organization. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. Policy types can be enabled and disabled in roots. This is distinct from whether they are available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization. + */ + listRoots(params: Organizations.Types.ListRootsRequest, callback?: (err: AWSError, data: Organizations.Types.ListRootsResponse) => void): Request; + /** + * Lists the roots that are defined in the current organization. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. Policy types can be enabled and disabled in roots. This is distinct from whether they are available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization. + */ + listRoots(callback?: (err: AWSError, data: Organizations.Types.ListRootsResponse) => void): Request; + /** + * Lists all the roots, organizational units (OUs), and accounts to which the specified policy is attached. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listTargetsForPolicy(params: Organizations.Types.ListTargetsForPolicyRequest, callback?: (err: AWSError, data: Organizations.Types.ListTargetsForPolicyResponse) => void): Request; + /** + * Lists all the roots, organizational units (OUs), and accounts to which the specified policy is attached. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account. + */ + listTargetsForPolicy(callback?: (err: AWSError, data: Organizations.Types.ListTargetsForPolicyResponse) => void): Request; + /** + * Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU. This operation can be called only from the organization's master account. + */ + moveAccount(params: Organizations.Types.MoveAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU. This operation can be called only from the organization's master account. + */ + moveAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified account from the organization. The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization. This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead. You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide. + */ + removeAccountFromOrganization(params: Organizations.Types.RemoveAccountFromOrganizationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified account from the organization. The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization. This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead. You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide. + */ + removeAccountFromOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached. This operation can be called only from the organization's master account. + */ + updateOrganizationalUnit(params: Organizations.Types.UpdateOrganizationalUnitRequest, callback?: (err: AWSError, data: Organizations.Types.UpdateOrganizationalUnitResponse) => void): Request; + /** + * Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached. This operation can be called only from the organization's master account. + */ + updateOrganizationalUnit(callback?: (err: AWSError, data: Organizations.Types.UpdateOrganizationalUnitResponse) => void): Request; + /** + * Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type. This operation can be called only from the organization's master account. + */ + updatePolicy(params: Organizations.Types.UpdatePolicyRequest, callback?: (err: AWSError, data: Organizations.Types.UpdatePolicyResponse) => void): Request; + /** + * Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type. This operation can be called only from the organization's master account. + */ + updatePolicy(callback?: (err: AWSError, data: Organizations.Types.UpdatePolicyResponse) => void): Request; +} +declare namespace Organizations { + export interface AcceptHandshakeRequest { + /** + * The unique identifier (ID) of the handshake that you want to accept. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. + */ + HandshakeId: HandshakeId; + } + export interface AcceptHandshakeResponse { + /** + * A structure that contains details about the accepted handshake. + */ + Handshake?: Handshake; + } + export interface Account { + /** + * The unique identifier (ID) of the account. The regex pattern for an account ID string requires exactly 12 digits. + */ + Id?: AccountId; + /** + * The Amazon Resource Name (ARN) of the account. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + Arn?: AccountArn; + /** + * The email address associated with the AWS account. The regex pattern for this parameter is a string of characters that represents a standard Internet email address. + */ + Email?: Email; + /** + * The friendly name of the account. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name?: AccountName; + /** + * The status of the account in the organization. + */ + Status?: AccountStatus; + /** + * The method by which the account joined the organization. + */ + JoinedMethod?: AccountJoinedMethod; + /** + * The date the account became a part of the organization. + */ + JoinedTimestamp?: Timestamp; + } + export type AccountArn = string; + export type AccountId = string; + export type AccountJoinedMethod = "INVITED"|"CREATED"|string; + export type AccountName = string; + export type AccountStatus = "ACTIVE"|"SUSPENDED"|string; + export type Accounts = Account[]; + export type ActionType = "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"|string; + export interface AttachPolicyRequest { + /** + * The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. + */ + PolicyId: PolicyId; + /** + * The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations. The regex pattern for a target ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Account: a string that consists of exactly 12 digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + TargetId: PolicyTargetId; + } + export type AwsManagedPolicy = boolean; + export interface CancelHandshakeRequest { + /** + * The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. + */ + HandshakeId: HandshakeId; + } + export interface CancelHandshakeResponse { + /** + * A structure that contains details about the handshake that you canceled. + */ + Handshake?: Handshake; + } + export interface Child { + /** + * The unique identifier (ID) of this child entity. The regex pattern for a child ID string requires one of the following: Account: a string that consists of exactly 12 digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + Id?: ChildId; + /** + * The type of this child entity. + */ + Type?: ChildType; + } + export type ChildId = string; + export type ChildType = "ACCOUNT"|"ORGANIZATIONAL_UNIT"|string; + export type Children = Child[]; + export type CreateAccountFailureReason = "ACCOUNT_LIMIT_EXCEEDED"|"EMAIL_ALREADY_EXISTS"|"INVALID_ADDRESS"|"INVALID_EMAIL"|"CONCURRENT_ACCOUNT_MODIFICATION"|"INTERNAL_FAILURE"|string; + export interface CreateAccountRequest { + /** + * The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. + */ + Email: Email; + /** + * The friendly name of the member account. + */ + AccountName: AccountName; + /** + * (Optional) The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account. If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole. For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide, and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide. The regex pattern that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@- + */ + RoleName?: RoleName; + /** + * If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide. If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account. + */ + IamUserAccessToBilling?: IAMUserAccessToBilling; + } + export type CreateAccountRequestId = string; + export interface CreateAccountResponse { + /** + * A structure that contains details about the request to create an account. This response structure might not be fully populated when you first receive it because account creation is an asynchronous process. You can pass the returned CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the request at later times. You can also check the AWS CloudTrail log for the CreateAccountResult event. For more information, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide. + */ + CreateAccountStatus?: CreateAccountStatus; + } + export type CreateAccountState = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string; + export type CreateAccountStates = CreateAccountState[]; + export interface CreateAccountStatus { + /** + * The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account. The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits. + */ + Id?: CreateAccountRequestId; + /** + * The account name given to the account when it was created. + */ + AccountName?: AccountName; + /** + * The status of the request. + */ + State?: CreateAccountState; + /** + * The date and time that the request was made for the account creation. + */ + RequestedTimestamp?: Timestamp; + /** + * The date and time that the account was created and the request completed. + */ + CompletedTimestamp?: Timestamp; + /** + * If the account was created successfully, the unique identifier (ID) of the new account. The regex pattern for an account ID string requires exactly 12 digits. + */ + AccountId?: AccountId; + /** + * + */ + GovCloudAccountId?: AccountId; + /** + * If the request failed, a description of the reason for the failure. ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization. EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists. INVALID_ADDRESS: The account could not be created because the address you provided is not valid. INVALID_EMAIL: The account could not be created because the email address you provided is not valid. INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support. + */ + FailureReason?: CreateAccountFailureReason; + } + export type CreateAccountStatuses = CreateAccountStatus[]; + export interface CreateGovCloudAccountRequest { + /** + * The email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount, the request for the email address for the AWS GovCloud (US) account originates from the commercial Region, not from the AWS GovCloud (US) Region. + */ + Email: Email; + /** + * The friendly name of the member account. + */ + AccountName: AccountName; + /** + * (Optional) The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account. If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole. For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide. The regex pattern that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@- + */ + RoleName?: RoleName; + /** + * If set to ALLOW, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide. If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account. + */ + IamUserAccessToBilling?: IAMUserAccessToBilling; + } + export interface CreateGovCloudAccountResponse { + CreateAccountStatus?: CreateAccountStatus; + } + export interface CreateOrganizationRequest { + /** + * Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality. CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the master account. For more information, see Consolidated billing in the AWS Organizations User Guide. The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region. ALL: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any type of policy to any member account in the organization. For more information, see All features in the AWS Organizations User Guide. + */ + FeatureSet?: OrganizationFeatureSet; + } + export interface CreateOrganizationResponse { + /** + * A structure that contains details about the newly created organization. + */ + Organization?: Organization; + } + export interface CreateOrganizationalUnitRequest { + /** + * The unique identifier (ID) of the parent root or OU in which you want to create the new OU. The regex pattern for a parent ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + ParentId: ParentId; + /** + * The friendly name to assign to the new OU. + */ + Name: OrganizationalUnitName; + } + export interface CreateOrganizationalUnitResponse { + /** + * A structure that contains details about the newly created OU. + */ + OrganizationalUnit?: OrganizationalUnit; + } + export interface CreatePolicyRequest { + /** + * The policy content to add to the new policy. For example, if you create a service control policy (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide. + */ + Content: PolicyContent; + /** + * An optional description to assign to the policy. + */ + Description: PolicyDescription; + /** + * The friendly name to assign to the policy. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name: PolicyName; + /** + * The type of policy to create. In the current release, the only type of policy that you can create is a service control policy (SCP). + */ + Type: PolicyType; + } + export interface CreatePolicyResponse { + /** + * A structure that contains details about the newly created policy. + */ + Policy?: Policy; + } + export interface DeclineHandshakeRequest { + /** + * The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. + */ + HandshakeId: HandshakeId; + } + export interface DeclineHandshakeResponse { + /** + * A structure that contains details about the declined handshake. The state is updated to show the value DECLINED. + */ + Handshake?: Handshake; + } + export interface DeleteOrganizationalUnitRequest { + /** + * The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + OrganizationalUnitId: OrganizationalUnitId; + } + export interface DeletePolicyRequest { + /** + * The unique identifier (ID) of the policy that you want to delete. You can get the ID from the ListPolicies or ListPoliciesForTarget operations. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. + */ + PolicyId: PolicyId; + } + export interface DescribeAccountRequest { + /** + * The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations. The regex pattern for an account ID string requires exactly 12 digits. + */ + AccountId: AccountId; + } + export interface DescribeAccountResponse { + /** + * A structure that contains information about the requested account. + */ + Account?: Account; + } + export interface DescribeCreateAccountStatusRequest { + /** + * Specifies the operationId that uniquely identifies the request. You can get the ID from the response to an earlier CreateAccount request, or from the ListCreateAccountStatus operation. The regex pattern for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits. + */ + CreateAccountRequestId: CreateAccountRequestId; + } + export interface DescribeCreateAccountStatusResponse { + /** + * A structure that contains the current status of an account creation request. + */ + CreateAccountStatus?: CreateAccountStatus; + } + export interface DescribeHandshakeRequest { + /** + * The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. + */ + HandshakeId: HandshakeId; + } + export interface DescribeHandshakeResponse { + /** + * A structure that contains information about the specified handshake. + */ + Handshake?: Handshake; + } + export interface DescribeOrganizationResponse { + /** + * A structure that contains information about the organization. + */ + Organization?: Organization; + } + export interface DescribeOrganizationalUnitRequest { + /** + * The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent operation. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + OrganizationalUnitId: OrganizationalUnitId; + } + export interface DescribeOrganizationalUnitResponse { + /** + * A structure that contains details about the specified OU. + */ + OrganizationalUnit?: OrganizationalUnit; + } + export interface DescribePolicyRequest { + /** + * The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. + */ + PolicyId: PolicyId; + } + export interface DescribePolicyResponse { + /** + * A structure that contains details about the specified policy. + */ + Policy?: Policy; + } + export interface DetachPolicyRequest { + /** + * The unique identifier (ID) of the policy you want to detach. You can get the ID from the ListPolicies or ListPoliciesForTarget operations. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. + */ + PolicyId: PolicyId; + /** + * The unique identifier (ID) of the root, OU, or account from which you want to detach the policy. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations. The regex pattern for a target ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Account: a string that consists of exactly 12 digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + TargetId: PolicyTargetId; + } + export interface DisableAWSServiceAccessRequest { + /** + * The service principal name of the AWS service for which you want to disable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com. + */ + ServicePrincipal: ServicePrincipal; + } + export interface DisablePolicyTypeRequest { + /** + * The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation. The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits. + */ + RootId: RootId; + /** + * The policy type that you want to disable in this root. + */ + PolicyType: PolicyType; + } + export interface DisablePolicyTypeResponse { + /** + * A structure that shows the root with the updated list of enabled policy types. + */ + Root?: Root; + } + export type Email = string; + export interface EnableAWSServiceAccessRequest { + /** + * The service principal name of the AWS service for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com. + */ + ServicePrincipal: ServicePrincipal; + } + export interface EnableAllFeaturesRequest { + } + export interface EnableAllFeaturesResponse { + /** + * A structure that contains details about the handshake created to support this request to enable all features in the organization. + */ + Handshake?: Handshake; + } + export interface EnablePolicyTypeRequest { + /** + * The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the ListRoots operation. The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits. + */ + RootId: RootId; + /** + * The policy type that you want to enable. + */ + PolicyType: PolicyType; + } + export interface EnablePolicyTypeResponse { + /** + * A structure that shows the root with the updated list of enabled policy types. + */ + Root?: Root; + } + export interface EnabledServicePrincipal { + /** + * The name of the service principal. This is typically in the form of a URL, such as: servicename.amazonaws.com. + */ + ServicePrincipal?: ServicePrincipal; + /** + * The date that the service principal was enabled for integration with AWS Organizations. + */ + DateEnabled?: Timestamp; + } + export type EnabledServicePrincipals = EnabledServicePrincipal[]; + export type GenericArn = string; + export interface Handshake { + /** + * The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. + */ + Id?: HandshakeId; + /** + * The Amazon Resource Name (ARN) of a handshake. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + Arn?: HandshakeArn; + /** + * Information about the two accounts that are participating in the handshake. + */ + Parties?: HandshakeParties; + /** + * The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows: REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond. OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action. CANCELED: This handshake is no longer active because it was canceled by the originating account. ACCEPTED: This handshake is complete because it has been accepted by the recipient. DECLINED: This handshake is no longer active because it was declined by the recipient account. EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days). + */ + State?: HandshakeState; + /** + * The date and time that the handshake request was made. + */ + RequestedTimestamp?: Timestamp; + /** + * The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid. + */ + ExpirationTimestamp?: Timestamp; + /** + * The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported: INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts. ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred. APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features. + */ + Action?: ActionType; + /** + * Additional information that is needed to process the handshake. + */ + Resources?: HandshakeResources; + } + export type HandshakeArn = string; + export interface HandshakeFilter { + /** + * Specifies the type of handshake action. If you specify ActionType, you cannot also specify ParentHandshakeId. + */ + ActionType?: ActionType; + /** + * Specifies the parent handshake. Only used for handshake types that are a child of another type. If you specify ParentHandshakeId, you cannot also specify ActionType. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. + */ + ParentHandshakeId?: HandshakeId; + } + export type HandshakeId = string; + export type HandshakeNotes = string; + export type HandshakeParties = HandshakeParty[]; + export interface HandshakeParty { + /** + * The unique identifier (ID) for the party. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. + */ + Id: HandshakePartyId; + /** + * The type of party. + */ + Type: HandshakePartyType; + } + export type HandshakePartyId = string; + export type HandshakePartyType = "ACCOUNT"|"ORGANIZATION"|"EMAIL"|string; + export interface HandshakeResource { + /** + * The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type. + */ + Value?: HandshakeResourceValue; + /** + * The type of information being passed, specifying how the value is to be interpreted by the other party: ACCOUNT - Specifies an AWS account ID number. ORGANIZATION - Specifies an organization ID number. EMAIL - Specifies the email address that is associated with the account that receives the handshake. OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization. OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization. NOTES - Additional text provided by the handshake initiator and intended for the recipient to read. + */ + Type?: HandshakeResourceType; + /** + * When needed, contains an additional array of HandshakeResource objects. + */ + Resources?: HandshakeResources; + } + export type HandshakeResourceType = "ACCOUNT"|"ORGANIZATION"|"ORGANIZATION_FEATURE_SET"|"EMAIL"|"MASTER_EMAIL"|"MASTER_NAME"|"NOTES"|"PARENT_HANDSHAKE"|string; + export type HandshakeResourceValue = string; + export type HandshakeResources = HandshakeResource[]; + export type HandshakeState = "REQUESTED"|"OPEN"|"CANCELED"|"ACCEPTED"|"DECLINED"|"EXPIRED"|string; + export type Handshakes = Handshake[]; + export type IAMUserAccessToBilling = "ALLOW"|"DENY"|string; + export interface InviteAccountToOrganizationRequest { + /** + * The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements: { "Type": "ACCOUNT", "Id": "< account id number >" } If you use the AWS CLI, you can submit this as a single string, similar to the following example: --target Id=123456789012,Type=ACCOUNT If you specify "Type": "ACCOUNT", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account. --target Id=diego@example.com,Type=EMAIL + */ + Target: HandshakeParty; + /** + * Additional information that you want to include in the generated email to the recipient account owner. + */ + Notes?: HandshakeNotes; + } + export interface InviteAccountToOrganizationResponse { + /** + * A structure that contains details about the handshake that is created to support this invitation request. + */ + Handshake?: Handshake; + } + export interface ListAWSServiceAccessForOrganizationRequest { + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListAWSServiceAccessForOrganizationResponse { + /** + * A list of the service principals for the services that are enabled to integrate with your organization. Each principal is a structure that includes the name and the date that it was enabled for integration with AWS Organizations. + */ + EnabledServicePrincipals?: EnabledServicePrincipals; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListAccountsForParentRequest { + /** + * The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list. + */ + ParentId: ParentId; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListAccountsForParentResponse { + /** + * A list of the accounts in the specified root or OU. + */ + Accounts?: Accounts; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListAccountsRequest { + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListAccountsResponse { + /** + * A list of objects in the organization. + */ + Accounts?: Accounts; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListChildrenRequest { + /** + * The unique identifier (ID) for the parent root or OU whose children you want to list. The regex pattern for a parent ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + ParentId: ParentId; + /** + * Filters the output to include only the specified child type. + */ + ChildType: ChildType; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListChildrenResponse { + /** + * The list of children of the specified parent container. + */ + Children?: Children; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListCreateAccountStatusRequest { + /** + * A list of one or more states that you want included in the response. If this parameter is not present, then all requests are included in the response. + */ + States?: CreateAccountStates; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListCreateAccountStatusResponse { + /** + * A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created. + */ + CreateAccountStatuses?: CreateAccountStatuses; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListHandshakesForAccountRequest { + /** + * Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request. + */ + Filter?: HandshakeFilter; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListHandshakesForAccountResponse { + /** + * A list of Handshake objects with details about each of the handshakes that is associated with the specified account. + */ + Handshakes?: Handshakes; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListHandshakesForOrganizationRequest { + /** + * A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request. + */ + Filter?: HandshakeFilter; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListHandshakesForOrganizationResponse { + /** + * A list of Handshake objects with details about each of the handshakes that are associated with an organization. + */ + Handshakes?: Handshakes; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListOrganizationalUnitsForParentRequest { + /** + * The unique identifier (ID) of the root or OU whose child OUs you want to list. The regex pattern for a parent ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + ParentId: ParentId; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListOrganizationalUnitsForParentResponse { + /** + * A list of the OUs in the specified root or parent OU. + */ + OrganizationalUnits?: OrganizationalUnits; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListParentsRequest { + /** + * The unique identifier (ID) of the OU or account whose parent containers you want to list. Do not specify a root. The regex pattern for a child ID string requires one of the following: Account: a string that consists of exactly 12 digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + ChildId: ChildId; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListParentsResponse { + /** + * A list of parents for the specified child account or OU. + */ + Parents?: Parents; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListPoliciesForTargetRequest { + /** + * The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list. The regex pattern for a target ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Account: a string that consists of exactly 12 digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + TargetId: PolicyTargetId; + /** + * The type of policy that you want to include in the returned list. + */ + Filter: PolicyType; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListPoliciesForTargetResponse { + /** + * The list of policies that match the criteria in the request. + */ + Policies?: Policies; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListPoliciesRequest { + /** + * Specifies the type of policy that you want to include in the response. + */ + Filter: PolicyType; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListPoliciesResponse { + /** + * A list of policies that match the filter criteria in the request. The output list does not include the policy contents. To see the content for a policy, see DescribePolicy. + */ + Policies?: Policies; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListRootsRequest { + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListRootsResponse { + /** + * A list of roots that are defined in an organization. + */ + Roots?: Roots; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export interface ListTargetsForPolicyRequest { + /** + * The unique identifier (ID) of the policy for which you want to know its attachments. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. + */ + PolicyId: PolicyId; + /** + * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextToken; + /** + * (Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResults; + } + export interface ListTargetsForPolicyResponse { + /** + * A list of structures, each of which contains details about one of the entities to which the specified policy is attached. + */ + Targets?: PolicyTargets; + /** + * If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. + */ + NextToken?: NextToken; + } + export type MaxResults = number; + export interface MoveAccountRequest { + /** + * The unique identifier (ID) of the account that you want to move. The regex pattern for an account ID string requires exactly 12 digits. + */ + AccountId: AccountId; + /** + * The unique identifier (ID) of the root or organizational unit that you want to move the account from. The regex pattern for a parent ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + SourceParentId: ParentId; + /** + * The unique identifier (ID) of the root or organizational unit that you want to move the account to. The regex pattern for a parent ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + DestinationParentId: ParentId; + } + export type NextToken = string; + export interface Organization { + /** + * The unique identifier (ID) of an organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lower-case letters or digits. + */ + Id?: OrganizationId; + /** + * The Amazon Resource Name (ARN) of an organization. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + Arn?: OrganizationArn; + /** + * Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide. + */ + FeatureSet?: OrganizationFeatureSet; + /** + * The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + MasterAccountArn?: AccountArn; + /** + * The unique identifier (ID) of the master account of an organization. The regex pattern for an account ID string requires exactly 12 digits. + */ + MasterAccountId?: AccountId; + /** + * The email address that is associated with the AWS account that is designated as the master account for the organization. + */ + MasterAccountEmail?: Email; + /** + * A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list. Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root. + */ + AvailablePolicyTypes?: PolicyTypes; + } + export type OrganizationArn = string; + export type OrganizationFeatureSet = "ALL"|"CONSOLIDATED_BILLING"|string; + export type OrganizationId = string; + export interface OrganizationalUnit { + /** + * The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + Id?: OrganizationalUnitId; + /** + * The Amazon Resource Name (ARN) of this OU. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + Arn?: OrganizationalUnitArn; + /** + * The friendly name of this OU. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name?: OrganizationalUnitName; + } + export type OrganizationalUnitArn = string; + export type OrganizationalUnitId = string; + export type OrganizationalUnitName = string; + export type OrganizationalUnits = OrganizationalUnit[]; + export interface Parent { + /** + * The unique identifier (ID) of the parent entity. The regex pattern for a parent ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + Id?: ParentId; + /** + * The type of the parent entity. + */ + Type?: ParentType; + } + export type ParentId = string; + export type ParentType = "ROOT"|"ORGANIZATIONAL_UNIT"|string; + export type Parents = Parent[]; + export type Policies = PolicySummary[]; + export interface Policy { + /** + * A structure that contains additional details about the policy. + */ + PolicySummary?: PolicySummary; + /** + * The text content of the policy. + */ + Content?: PolicyContent; + } + export type PolicyArn = string; + export type PolicyContent = string; + export type PolicyDescription = string; + export type PolicyId = string; + export type PolicyName = string; + export interface PolicySummary { + /** + * The unique identifier (ID) of the policy. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. + */ + Id?: PolicyId; + /** + * The Amazon Resource Name (ARN) of the policy. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + Arn?: PolicyArn; + /** + * The friendly name of the policy. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name?: PolicyName; + /** + * The description of the policy. + */ + Description?: PolicyDescription; + /** + * The type of policy. + */ + Type?: PolicyType; + /** + * A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it. + */ + AwsManaged?: AwsManagedPolicy; + } + export type PolicyTargetId = string; + export interface PolicyTargetSummary { + /** + * The unique identifier (ID) of the policy target. The regex pattern for a target ID string requires one of the following: Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. Account: a string that consists of exactly 12 digits. Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + TargetId?: PolicyTargetId; + /** + * The Amazon Resource Name (ARN) of the policy target. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + Arn?: GenericArn; + /** + * The friendly name of the policy target. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name?: TargetName; + /** + * The type of the policy target. + */ + Type?: TargetType; + } + export type PolicyTargets = PolicyTargetSummary[]; + export type PolicyType = "SERVICE_CONTROL_POLICY"|string; + export type PolicyTypeStatus = "ENABLED"|"PENDING_ENABLE"|"PENDING_DISABLE"|string; + export interface PolicyTypeSummary { + /** + * The name of the policy type. + */ + Type?: PolicyType; + /** + * The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root. + */ + Status?: PolicyTypeStatus; + } + export type PolicyTypes = PolicyTypeSummary[]; + export interface RemoveAccountFromOrganizationRequest { + /** + * The unique identifier (ID) of the member account that you want to remove from the organization. The regex pattern for an account ID string requires exactly 12 digits. + */ + AccountId: AccountId; + } + export type RoleName = string; + export interface Root { + /** + * The unique identifier (ID) for the root. The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits. + */ + Id?: RootId; + /** + * The Amazon Resource Name (ARN) of the root. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide. + */ + Arn?: RootArn; + /** + * The friendly name of the root. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name?: RootName; + /** + * The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts. Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization. + */ + PolicyTypes?: PolicyTypes; + } + export type RootArn = string; + export type RootId = string; + export type RootName = string; + export type Roots = Root[]; + export type ServicePrincipal = string; + export type TargetName = string; + export type TargetType = "ACCOUNT"|"ORGANIZATIONAL_UNIT"|"ROOT"|string; + export type Timestamp = Date; + export interface UpdateOrganizationalUnitRequest { + /** + * The unique identifier (ID) of the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. + */ + OrganizationalUnitId: OrganizationalUnitId; + /** + * The new name that you want to assign to the OU. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name?: OrganizationalUnitName; + } + export interface UpdateOrganizationalUnitResponse { + /** + * A structure that contains the details about the specified OU, including its new name. + */ + OrganizationalUnit?: OrganizationalUnit; + } + export interface UpdatePolicyRequest { + /** + * The unique identifier (ID) of the policy that you want to update. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. + */ + PolicyId: PolicyId; + /** + * If provided, the new name for the policy. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range. + */ + Name?: PolicyName; + /** + * If provided, the new description for the policy. + */ + Description?: PolicyDescription; + /** + * If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide. + */ + Content?: PolicyContent; + } + export interface UpdatePolicyResponse { + /** + * A structure that contains details about the updated policy, showing the requested changes. + */ + Policy?: Policy; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-11-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Organizations client. + */ + export import Types = Organizations; +} +export = Organizations; diff --git a/node_modules/aws-sdk/clients/organizations.js b/node_modules/aws-sdk/clients/organizations.js new file mode 100644 index 0000000..be3c1dd --- /dev/null +++ b/node_modules/aws-sdk/clients/organizations.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['organizations'] = {}; +AWS.Organizations = Service.defineService('organizations', ['2016-11-28']); +Object.defineProperty(apiLoader.services['organizations'], '2016-11-28', { + get: function get() { + var model = require('../apis/organizations-2016-11-28.min.json'); + model.paginators = require('../apis/organizations-2016-11-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Organizations; diff --git a/node_modules/aws-sdk/clients/pi.d.ts b/node_modules/aws-sdk/clients/pi.d.ts new file mode 100644 index 0000000..c5e8cf3 --- /dev/null +++ b/node_modules/aws-sdk/clients/pi.d.ts @@ -0,0 +1,266 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class PI extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: PI.Types.ClientConfiguration) + config: Config & PI.Types.ClientConfiguration; + /** + * For a specific time period, retrieve the top N dimension keys for a metric. + */ + describeDimensionKeys(params: PI.Types.DescribeDimensionKeysRequest, callback?: (err: AWSError, data: PI.Types.DescribeDimensionKeysResponse) => void): Request; + /** + * For a specific time period, retrieve the top N dimension keys for a metric. + */ + describeDimensionKeys(callback?: (err: AWSError, data: PI.Types.DescribeDimensionKeysResponse) => void): Request; + /** + * Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group. + */ + getResourceMetrics(params: PI.Types.GetResourceMetricsRequest, callback?: (err: AWSError, data: PI.Types.GetResourceMetricsResponse) => void): Request; + /** + * Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group. + */ + getResourceMetrics(callback?: (err: AWSError, data: PI.Types.GetResourceMetricsResponse) => void): Request; +} +declare namespace PI { + export interface DataPoint { + /** + * The time, in epoch format, associated with a particular Value. + */ + Timestamp: ISOTimestamp; + /** + * The actual value associated with a particular Timestamp. + */ + Value: Double; + } + export type DataPointsList = DataPoint[]; + export interface DescribeDimensionKeysRequest { + /** + * The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS + */ + ServiceType: ServiceType; + /** + * An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A + */ + Identifier: String; + /** + * The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned. The value for StartTime must be earlier than the value for EndTime. + */ + StartTime: ISOTimestamp; + /** + * The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned. The value for EndTime must be later than the value for StartTime. + */ + EndTime: ISOTimestamp; + /** + * The name of a Performance Insights metric to be measured. Valid values for Metric are: db.load.avg - a scaled representation of the number of active sessions for the database engine. db.sampledload.avg - the raw number of active sessions for the database engine. + */ + Metric: String; + /** + * The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are: 1 (one second) 60 (one minute) 300 (five minutes) 3600 (one hour) 86400 (twenty-four hours) If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response. + */ + PeriodInSeconds?: Integer; + /** + * A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension. + */ + GroupBy: DimensionGroup; + /** + * For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response. + */ + PartitionBy?: DimensionGroup; + /** + * One or more filters to apply in the request. Restrictions: Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters. A single filter for any other dimension in this dimension group. + */ + Filter?: MetricQueryFilterMap; + /** + * The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved. + */ + MaxResults?: MaxResults; + /** + * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords. + */ + NextToken?: String; + } + export interface DescribeDimensionKeysResponse { + /** + * The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime. + */ + AlignedStartTime?: ISOTimestamp; + /** + * The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime. + */ + AlignedEndTime?: ISOTimestamp; + /** + * If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions. + */ + PartitionKeys?: ResponsePartitionKeyList; + /** + * The dimension keys that were requested. + */ + Keys?: DimensionKeyDescriptionList; + /** + * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords. + */ + NextToken?: String; + } + export interface DimensionGroup { + /** + * The name of the dimension group. Valid values are: db.user db.host db.sql db.sql_tokenized db.wait_event db.wait_event_type + */ + Group: String; + /** + * A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response. Valid values for elements in the Dimensions array are: db.user.id db.user.name db.host.id db.host.name db.sql.id db.sql.db_id db.sql.statement db.sql.tokenized_id db.sql_tokenized.id db.sql_tokenized.db_id db.sql_tokenized.statement db.wait_event.name db.wait_event.type db.wait_event_type.name + */ + Dimensions?: StringList; + /** + * The maximum number of items to fetch for this dimension group. + */ + Limit?: Limit; + } + export interface DimensionKeyDescription { + /** + * A map of name-value pairs for the dimensions in the group. + */ + Dimensions?: DimensionMap; + /** + * The aggregated metric value for the dimension(s), over the requested time range. + */ + Total?: Double; + /** + * If PartitionBy was specified, PartitionKeys contains the dimensions that were. + */ + Partitions?: MetricValuesList; + } + export type DimensionKeyDescriptionList = DimensionKeyDescription[]; + export type DimensionMap = {[key: string]: String}; + export type Double = number; + export interface GetResourceMetricsRequest { + /** + * The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS + */ + ServiceType: ServiceType; + /** + * An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A + */ + Identifier: String; + /** + * An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria. + */ + MetricQueries: MetricQueryList; + /** + * The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned. The value for StartTime must be earlier than the value for EndTime. + */ + StartTime: ISOTimestamp; + /** + * The date and time specifiying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned. The value for EndTime must be later than the value for StartTime. + */ + EndTime: ISOTimestamp; + /** + * The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are: 1 (one second) 60 (one minute) 300 (five minutes) 3600 (one hour) 86400 (twenty-four hours) If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response. + */ + PeriodInSeconds?: Integer; + /** + * The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved. + */ + MaxResults?: MaxResults; + /** + * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords. + */ + NextToken?: String; + } + export interface GetResourceMetricsResponse { + /** + * The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime. + */ + AlignedStartTime?: ISOTimestamp; + /** + * The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime. + */ + AlignedEndTime?: ISOTimestamp; + /** + * An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A + */ + Identifier?: String; + /** + * An array of metric results,, where each array element contains all of the data points for a particular dimension. + */ + MetricList?: MetricKeyDataPointsList; + /** + * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords. + */ + NextToken?: String; + } + export type ISOTimestamp = Date; + export type Integer = number; + export type Limit = number; + export type MaxResults = number; + export interface MetricKeyDataPoints { + /** + * The dimension(s) to which the data points apply. + */ + Key?: ResponseResourceMetricKey; + /** + * An array of timestamp-value pairs, representing measurements over a period of time. + */ + DataPoints?: DataPointsList; + } + export type MetricKeyDataPointsList = MetricKeyDataPoints[]; + export interface MetricQuery { + /** + * The name of a Performance Insights metric to be measured. Valid values for Metric are: db.load.avg - a scaled representation of the number of active sessions for the database engine. db.sampledload.avg - the raw number of active sessions for the database engine. + */ + Metric: String; + /** + * A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension. + */ + GroupBy?: DimensionGroup; + /** + * One or more filters to apply in the request. Restrictions: Any number of filters by the same dimension, as specified in the GroupBy parameter. A single filter for any other dimension in this dimension group. + */ + Filter?: MetricQueryFilterMap; + } + export type MetricQueryFilterMap = {[key: string]: String}; + export type MetricQueryList = MetricQuery[]; + export type MetricValuesList = Double[]; + export interface ResponsePartitionKey { + /** + * A dimension map that contains the dimension(s) for this partition. + */ + Dimensions: DimensionMap; + } + export type ResponsePartitionKeyList = ResponsePartitionKey[]; + export interface ResponseResourceMetricKey { + /** + * The name of a Performance Insights metric to be measured. Valid values for Metric are: db.load.avg - a scaled representation of the number of active sessions for the database engine. db.sampledload.avg - the raw number of active sessions for the database engine. + */ + Metric: String; + /** + * The valid dimensions for the metric. + */ + Dimensions?: DimensionMap; + } + export type ServiceType = "RDS"|string; + export type String = string; + export type StringList = String[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-02-27"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the PI client. + */ + export import Types = PI; +} +export = PI; diff --git a/node_modules/aws-sdk/clients/pi.js b/node_modules/aws-sdk/clients/pi.js new file mode 100644 index 0000000..19bf6db --- /dev/null +++ b/node_modules/aws-sdk/clients/pi.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['pi'] = {}; +AWS.PI = Service.defineService('pi', ['2018-02-27']); +Object.defineProperty(apiLoader.services['pi'], '2018-02-27', { + get: function get() { + var model = require('../apis/pi-2018-02-27.min.json'); + model.paginators = require('../apis/pi-2018-02-27.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.PI; diff --git a/node_modules/aws-sdk/clients/pinpoint.d.ts b/node_modules/aws-sdk/clients/pinpoint.d.ts new file mode 100644 index 0000000..3618f38 --- /dev/null +++ b/node_modules/aws-sdk/clients/pinpoint.d.ts @@ -0,0 +1,4783 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Pinpoint extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Pinpoint.Types.ClientConfiguration) + config: Config & Pinpoint.Types.ClientConfiguration; + /** + * Creates or updates an app. + */ + createApp(params: Pinpoint.Types.CreateAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request; + /** + * Creates or updates an app. + */ + createApp(callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request; + /** + * Creates or updates a campaign. + */ + createCampaign(params: Pinpoint.Types.CreateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request; + /** + * Creates or updates a campaign. + */ + createCampaign(callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request; + /** + * Creates an export job. + */ + createExportJob(params: Pinpoint.Types.CreateExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request; + /** + * Creates an export job. + */ + createExportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request; + /** + * Creates or updates an import job. + */ + createImportJob(params: Pinpoint.Types.CreateImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request; + /** + * Creates or updates an import job. + */ + createImportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request; + /** + * Used to create or update a segment. + */ + createSegment(params: Pinpoint.Types.CreateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request; + /** + * Used to create or update a segment. + */ + createSegment(callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request; + /** + * Delete an ADM channel. + */ + deleteAdmChannel(params: Pinpoint.Types.DeleteAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request; + /** + * Delete an ADM channel. + */ + deleteAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request; + /** + * Deletes the APNs channel for an app. + */ + deleteApnsChannel(params: Pinpoint.Types.DeleteApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request; + /** + * Deletes the APNs channel for an app. + */ + deleteApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request; + /** + * Delete an APNS sandbox channel. + */ + deleteApnsSandboxChannel(params: Pinpoint.Types.DeleteApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request; + /** + * Delete an APNS sandbox channel. + */ + deleteApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request; + /** + * Delete an APNS VoIP channel + */ + deleteApnsVoipChannel(params: Pinpoint.Types.DeleteApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request; + /** + * Delete an APNS VoIP channel + */ + deleteApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request; + /** + * Delete an APNS VoIP sandbox channel + */ + deleteApnsVoipSandboxChannel(params: Pinpoint.Types.DeleteApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request; + /** + * Delete an APNS VoIP sandbox channel + */ + deleteApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request; + /** + * Deletes an app. + */ + deleteApp(params: Pinpoint.Types.DeleteAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request; + /** + * Deletes an app. + */ + deleteApp(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request; + /** + * Delete a BAIDU GCM channel + */ + deleteBaiduChannel(params: Pinpoint.Types.DeleteBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request; + /** + * Delete a BAIDU GCM channel + */ + deleteBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request; + /** + * Deletes a campaign. + */ + deleteCampaign(params: Pinpoint.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request; + /** + * Deletes a campaign. + */ + deleteCampaign(callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request; + /** + * Delete an email channel. + */ + deleteEmailChannel(params: Pinpoint.Types.DeleteEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request; + /** + * Delete an email channel. + */ + deleteEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request; + /** + * Deletes an endpoint. + */ + deleteEndpoint(params: Pinpoint.Types.DeleteEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request; + /** + * Deletes an endpoint. + */ + deleteEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request; + /** + * Deletes the event stream for an app. + */ + deleteEventStream(params: Pinpoint.Types.DeleteEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request; + /** + * Deletes the event stream for an app. + */ + deleteEventStream(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request; + /** + * Deletes the GCM channel for an app. + */ + deleteGcmChannel(params: Pinpoint.Types.DeleteGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request; + /** + * Deletes the GCM channel for an app. + */ + deleteGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request; + /** + * Deletes a segment. + */ + deleteSegment(params: Pinpoint.Types.DeleteSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request; + /** + * Deletes a segment. + */ + deleteSegment(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request; + /** + * Delete an SMS channel. + */ + deleteSmsChannel(params: Pinpoint.Types.DeleteSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request; + /** + * Delete an SMS channel. + */ + deleteSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request; + /** + * Deletes endpoints that are associated with a User ID. + */ + deleteUserEndpoints(params: Pinpoint.Types.DeleteUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request; + /** + * Deletes endpoints that are associated with a User ID. + */ + deleteUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request; + /** + * Delete an Voice channel + */ + deleteVoiceChannel(params: Pinpoint.Types.DeleteVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request; + /** + * Delete an Voice channel + */ + deleteVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request; + /** + * Get an ADM channel. + */ + getAdmChannel(params: Pinpoint.Types.GetAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request; + /** + * Get an ADM channel. + */ + getAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request; + /** + * Returns information about the APNs channel for an app. + */ + getApnsChannel(params: Pinpoint.Types.GetApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request; + /** + * Returns information about the APNs channel for an app. + */ + getApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request; + /** + * Get an APNS sandbox channel. + */ + getApnsSandboxChannel(params: Pinpoint.Types.GetApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request; + /** + * Get an APNS sandbox channel. + */ + getApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request; + /** + * Get an APNS VoIP channel + */ + getApnsVoipChannel(params: Pinpoint.Types.GetApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request; + /** + * Get an APNS VoIP channel + */ + getApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request; + /** + * Get an APNS VoIPSandbox channel + */ + getApnsVoipSandboxChannel(params: Pinpoint.Types.GetApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request; + /** + * Get an APNS VoIPSandbox channel + */ + getApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request; + /** + * Returns information about an app. + */ + getApp(params: Pinpoint.Types.GetAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request; + /** + * Returns information about an app. + */ + getApp(callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request; + /** + * Used to request the settings for an app. + */ + getApplicationSettings(params: Pinpoint.Types.GetApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request; + /** + * Used to request the settings for an app. + */ + getApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request; + /** + * Returns information about your apps. + */ + getApps(params: Pinpoint.Types.GetAppsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request; + /** + * Returns information about your apps. + */ + getApps(callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request; + /** + * Get a BAIDU GCM channel + */ + getBaiduChannel(params: Pinpoint.Types.GetBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request; + /** + * Get a BAIDU GCM channel + */ + getBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request; + /** + * Returns information about a campaign. + */ + getCampaign(params: Pinpoint.Types.GetCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request; + /** + * Returns information about a campaign. + */ + getCampaign(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request; + /** + * Returns information about the activity performed by a campaign. + */ + getCampaignActivities(params: Pinpoint.Types.GetCampaignActivitiesRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request; + /** + * Returns information about the activity performed by a campaign. + */ + getCampaignActivities(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request; + /** + * Returns information about a specific version of a campaign. + */ + getCampaignVersion(params: Pinpoint.Types.GetCampaignVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request; + /** + * Returns information about a specific version of a campaign. + */ + getCampaignVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request; + /** + * Returns information about your campaign versions. + */ + getCampaignVersions(params: Pinpoint.Types.GetCampaignVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request; + /** + * Returns information about your campaign versions. + */ + getCampaignVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request; + /** + * Returns information about your campaigns. + */ + getCampaigns(params: Pinpoint.Types.GetCampaignsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request; + /** + * Returns information about your campaigns. + */ + getCampaigns(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request; + /** + * Get all channels. + */ + getChannels(params: Pinpoint.Types.GetChannelsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request; + /** + * Get all channels. + */ + getChannels(callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request; + /** + * Get an email channel. + */ + getEmailChannel(params: Pinpoint.Types.GetEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request; + /** + * Get an email channel. + */ + getEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request; + /** + * Returns information about an endpoint. + */ + getEndpoint(params: Pinpoint.Types.GetEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request; + /** + * Returns information about an endpoint. + */ + getEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request; + /** + * Returns the event stream for an app. + */ + getEventStream(params: Pinpoint.Types.GetEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request; + /** + * Returns the event stream for an app. + */ + getEventStream(callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request; + /** + * Returns information about an export job. + */ + getExportJob(params: Pinpoint.Types.GetExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request; + /** + * Returns information about an export job. + */ + getExportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request; + /** + * Returns information about your export jobs. + */ + getExportJobs(params: Pinpoint.Types.GetExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request; + /** + * Returns information about your export jobs. + */ + getExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request; + /** + * Returns information about the GCM channel for an app. + */ + getGcmChannel(params: Pinpoint.Types.GetGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request; + /** + * Returns information about the GCM channel for an app. + */ + getGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request; + /** + * Returns information about an import job. + */ + getImportJob(params: Pinpoint.Types.GetImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request; + /** + * Returns information about an import job. + */ + getImportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request; + /** + * Returns information about your import jobs. + */ + getImportJobs(params: Pinpoint.Types.GetImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request; + /** + * Returns information about your import jobs. + */ + getImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request; + /** + * Returns information about a segment. + */ + getSegment(params: Pinpoint.Types.GetSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request; + /** + * Returns information about a segment. + */ + getSegment(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request; + /** + * Returns a list of export jobs for a specific segment. + */ + getSegmentExportJobs(params: Pinpoint.Types.GetSegmentExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request; + /** + * Returns a list of export jobs for a specific segment. + */ + getSegmentExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request; + /** + * Returns a list of import jobs for a specific segment. + */ + getSegmentImportJobs(params: Pinpoint.Types.GetSegmentImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request; + /** + * Returns a list of import jobs for a specific segment. + */ + getSegmentImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request; + /** + * Returns information about a segment version. + */ + getSegmentVersion(params: Pinpoint.Types.GetSegmentVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request; + /** + * Returns information about a segment version. + */ + getSegmentVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request; + /** + * Returns information about your segment versions. + */ + getSegmentVersions(params: Pinpoint.Types.GetSegmentVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request; + /** + * Returns information about your segment versions. + */ + getSegmentVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request; + /** + * Used to get information about your segments. + */ + getSegments(params: Pinpoint.Types.GetSegmentsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request; + /** + * Used to get information about your segments. + */ + getSegments(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request; + /** + * Get an SMS channel. + */ + getSmsChannel(params: Pinpoint.Types.GetSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request; + /** + * Get an SMS channel. + */ + getSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request; + /** + * Returns information about the endpoints that are associated with a User ID. + */ + getUserEndpoints(params: Pinpoint.Types.GetUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request; + /** + * Returns information about the endpoints that are associated with a User ID. + */ + getUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request; + /** + * Get a Voice Channel + */ + getVoiceChannel(params: Pinpoint.Types.GetVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request; + /** + * Get a Voice Channel + */ + getVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request; + /** + * + */ + listTagsForResource(params: Pinpoint.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request; + /** + * + */ + listTagsForResource(callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns information about the specified phone number. + */ + phoneNumberValidate(params: Pinpoint.Types.PhoneNumberValidateRequest, callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request; + /** + * Returns information about the specified phone number. + */ + phoneNumberValidate(callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request; + /** + * Use to create or update the event stream for an app. + */ + putEventStream(params: Pinpoint.Types.PutEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request; + /** + * Use to create or update the event stream for an app. + */ + putEventStream(callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request; + /** + * Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with. + */ + putEvents(params: Pinpoint.Types.PutEventsRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request; + /** + * Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with. + */ + putEvents(callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request; + /** + * Used to remove the attributes for an app + */ + removeAttributes(params: Pinpoint.Types.RemoveAttributesRequest, callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request; + /** + * Used to remove the attributes for an app + */ + removeAttributes(callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request; + /** + * Used to send a direct message. + */ + sendMessages(params: Pinpoint.Types.SendMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request; + /** + * Used to send a direct message. + */ + sendMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request; + /** + * Used to send a message to a list of users. + */ + sendUsersMessages(params: Pinpoint.Types.SendUsersMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request; + /** + * Used to send a message to a list of users. + */ + sendUsersMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request; + /** + * + */ + tagResource(params: Pinpoint.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + untagResource(params: Pinpoint.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Update an ADM channel. + */ + updateAdmChannel(params: Pinpoint.Types.UpdateAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request; + /** + * Update an ADM channel. + */ + updateAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request; + /** + * Use to update the APNs channel for an app. + */ + updateApnsChannel(params: Pinpoint.Types.UpdateApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request; + /** + * Use to update the APNs channel for an app. + */ + updateApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request; + /** + * Update an APNS sandbox channel. + */ + updateApnsSandboxChannel(params: Pinpoint.Types.UpdateApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request; + /** + * Update an APNS sandbox channel. + */ + updateApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request; + /** + * Update an APNS VoIP channel + */ + updateApnsVoipChannel(params: Pinpoint.Types.UpdateApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request; + /** + * Update an APNS VoIP channel + */ + updateApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request; + /** + * Update an APNS VoIP sandbox channel + */ + updateApnsVoipSandboxChannel(params: Pinpoint.Types.UpdateApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request; + /** + * Update an APNS VoIP sandbox channel + */ + updateApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request; + /** + * Used to update the settings for an app. + */ + updateApplicationSettings(params: Pinpoint.Types.UpdateApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request; + /** + * Used to update the settings for an app. + */ + updateApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request; + /** + * Update a BAIDU GCM channel + */ + updateBaiduChannel(params: Pinpoint.Types.UpdateBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request; + /** + * Update a BAIDU GCM channel + */ + updateBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request; + /** + * Use to update a campaign. + */ + updateCampaign(params: Pinpoint.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request; + /** + * Use to update a campaign. + */ + updateCampaign(callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request; + /** + * Update an email channel. + */ + updateEmailChannel(params: Pinpoint.Types.UpdateEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request; + /** + * Update an email channel. + */ + updateEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request; + /** + * Creates or updates an endpoint. + */ + updateEndpoint(params: Pinpoint.Types.UpdateEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request; + /** + * Creates or updates an endpoint. + */ + updateEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request; + /** + * Use to update a batch of endpoints. + */ + updateEndpointsBatch(params: Pinpoint.Types.UpdateEndpointsBatchRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request; + /** + * Use to update a batch of endpoints. + */ + updateEndpointsBatch(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request; + /** + * Use to update the GCM channel for an app. + */ + updateGcmChannel(params: Pinpoint.Types.UpdateGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request; + /** + * Use to update the GCM channel for an app. + */ + updateGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request; + /** + * Used to update a segment. + */ + updateSegment(params: Pinpoint.Types.UpdateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request; + /** + * Used to update a segment. + */ + updateSegment(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request; + /** + * Update an SMS channel. + */ + updateSmsChannel(params: Pinpoint.Types.UpdateSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request; + /** + * Update an SMS channel. + */ + updateSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request; + /** + * Update an Voice channel + */ + updateVoiceChannel(params: Pinpoint.Types.UpdateVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request; + /** + * Update an Voice channel + */ + updateVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request; +} +declare namespace Pinpoint { + export interface ADMChannelRequest { + /** + * The Client ID that you obtained from the Amazon App Distribution Portal. + */ + ClientId?: __string; + /** + * The Client Secret that you obtained from the Amazon App Distribution Portal. + */ + ClientSecret?: __string; + /** + * Indicates whether or not the channel is enabled for sending messages. + */ + Enabled?: __boolean; + } + export interface ADMChannelResponse { + /** + * The ID of the application to which the channel applies. + */ + ApplicationId?: __string; + /** + * The date and time when this channel was created. + */ + CreationDate?: __string; + /** + * Indicates whether or not the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * (Deprecated) An identifier for the channel. Retained for backwards compatibility. + */ + Id?: __string; + /** + * Indicates whether or not the channel is archived. + */ + IsArchived?: __boolean; + /** + * The user who last updated this channel. + */ + LastModifiedBy?: __string; + /** + * The date and time when this channel was last modified. + */ + LastModifiedDate?: __string; + /** + * The platform type. For this channel, the value is always "ADM." + */ + Platform?: __string; + /** + * The channel version. + */ + Version?: __integer; + } + export interface ADMMessage { + /** + * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL + */ + Action?: Action; + /** + * The message body of the notification. + */ + Body?: __string; + /** + * Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one. + */ + ConsolidationKey?: __string; + /** + * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object + */ + Data?: MapOf__string; + /** + * Optional. Number of seconds ADM should retain the message if the device is offline + */ + ExpiresAfter?: __string; + /** + * The icon image name of the asset saved in your application. + */ + IconReference?: __string; + /** + * The URL that points to an image used as the large icon to the notification content view. + */ + ImageIconUrl?: __string; + /** + * The URL that points to an image used in the push notification. + */ + ImageUrl?: __string; + /** + * Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity + */ + MD5?: __string; + /** + * The Raw JSON formatted string to be used as the payload. This value overrides the message. + */ + RawContent?: __string; + /** + * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. + */ + SilentPush?: __boolean; + /** + * The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view + */ + SmallImageIconUrl?: __string; + /** + * Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ + */ + Sound?: __string; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * The message title that displays above the message on the user's device. + */ + Title?: __string; + /** + * The URL to open in the user's mobile browser. Used if the value for Action is URL. + */ + Url?: __string; + } + export interface APNSChannelRequest { + /** + * The bundle id used for APNs Tokens. + */ + BundleId?: __string; + /** + * The distribution certificate from Apple. + */ + Certificate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * The certificate private key. + */ + PrivateKey?: __string; + /** + * The team id used for APNs Tokens. + */ + TeamId?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKey?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKeyId?: __string; + } + export interface APNSChannelResponse { + /** + * The ID of the application that the channel applies to. + */ + ApplicationId?: __string; + /** + * The date and time when this channel was created. + */ + CreationDate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute. + */ + HasTokenKey?: __boolean; + /** + * (Deprecated) An identifier for the channel. Retained for backwards compatibility. + */ + Id?: __string; + /** + * Indicates whether or not the channel is archived. + */ + IsArchived?: __boolean; + /** + * The user who last updated this channel. + */ + LastModifiedBy?: __string; + /** + * The date and time when this channel was last modified. + */ + LastModifiedDate?: __string; + /** + * The platform type. For this channel, the value is always "ADM." + */ + Platform?: __string; + /** + * The channel version. + */ + Version?: __integer; + } + export interface APNSMessage { + /** + * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL + */ + Action?: Action; + /** + * Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0. + */ + Badge?: __integer; + /** + * The message body of the notification. + */ + Body?: __string; + /** + * Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories. + */ + Category?: __string; + /** + * An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs. + */ + CollapseId?: __string; + /** + * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object + */ + Data?: MapOf__string; + /** + * A URL that refers to the location of an image or video that you want to display in the push notification. + */ + MediaUrl?: __string; + /** + * The preferred authentication method, either "CERTIFICATE" or "TOKEN" + */ + PreferredAuthenticationMethod?: __string; + /** + * The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: + +"5" - Low priority. Messages might be delayed, delivered in groups, and throttled. + +"10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. + +The default value is "10". + +The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. + +For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide. + */ + Priority?: __string; + /** + * The Raw JSON formatted string to be used as the payload. This value overrides the message. + */ + RawContent?: __string; + /** + * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. + */ + SilentPush?: __boolean; + /** + * Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound. + */ + Sound?: __string; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. + */ + ThreadId?: __string; + /** + * The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs. + */ + TimeToLive?: __integer; + /** + * The message title that displays above the message on the user's device. + */ + Title?: __string; + /** + * The URL to open in the user's mobile browser. Used if the value for Action is URL. + */ + Url?: __string; + } + export interface APNSSandboxChannelRequest { + /** + * The bundle id used for APNs Tokens. + */ + BundleId?: __string; + /** + * The distribution certificate from Apple. + */ + Certificate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * The certificate private key. + */ + PrivateKey?: __string; + /** + * The team id used for APNs Tokens. + */ + TeamId?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKey?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKeyId?: __string; + } + export interface APNSSandboxChannelResponse { + /** + * The ID of the application to which the channel applies. + */ + ApplicationId?: __string; + /** + * When was this segment created + */ + CreationDate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute. + */ + HasTokenKey?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who last updated this entry + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * The platform type. Will be APNS_SANDBOX. + */ + Platform?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export interface APNSVoipChannelRequest { + /** + * The bundle id used for APNs Tokens. + */ + BundleId?: __string; + /** + * The distribution certificate from Apple. + */ + Certificate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * The certificate private key. + */ + PrivateKey?: __string; + /** + * The team id used for APNs Tokens. + */ + TeamId?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKey?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKeyId?: __string; + } + export interface APNSVoipChannelResponse { + /** + * Application id + */ + ApplicationId?: __string; + /** + * When was this segment created + */ + CreationDate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * If the channel is registered with a token key for authentication. + */ + HasTokenKey?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who made the last change + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * The platform type. Will be APNS. + */ + Platform?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export interface APNSVoipSandboxChannelRequest { + /** + * The bundle id used for APNs Tokens. + */ + BundleId?: __string; + /** + * The distribution certificate from Apple. + */ + Certificate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * The certificate private key. + */ + PrivateKey?: __string; + /** + * The team id used for APNs Tokens. + */ + TeamId?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKey?: __string; + /** + * The token key used for APNs Tokens. + */ + TokenKeyId?: __string; + } + export interface APNSVoipSandboxChannelResponse { + /** + * Application id + */ + ApplicationId?: __string; + /** + * When was this segment created + */ + CreationDate?: __string; + /** + * The default authentication method used for APNs. + */ + DefaultAuthenticationMethod?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * If the channel is registered with a token key for authentication. + */ + HasTokenKey?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who made the last change + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * The platform type. Will be APNS. + */ + Platform?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export type Action = "OPEN_APP"|"DEEP_LINK"|"URL"|string; + export interface ActivitiesResponse { + /** + * List of campaign activities + */ + Item?: ListOfActivityResponse; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: __string; + } + export interface ActivityResponse { + /** + * The ID of the application to which the campaign applies. + */ + ApplicationId?: __string; + /** + * The ID of the campaign to which the activity applies. + */ + CampaignId?: __string; + /** + * The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format. + */ + End?: __string; + /** + * The unique activity ID. + */ + Id?: __string; + /** + * Indicates whether the activity succeeded. + +Valid values: SUCCESS, FAIL + */ + Result?: __string; + /** + * The scheduled start time for the activity in ISO 8601 format. + */ + ScheduledStart?: __string; + /** + * The actual start time of the activity in ISO 8601 format. + */ + Start?: __string; + /** + * The state of the activity. + +Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED + */ + State?: __string; + /** + * The total number of endpoints to which the campaign successfully delivered messages. + */ + SuccessfulEndpointCount?: __integer; + /** + * The total number of timezones completed. + */ + TimezonesCompletedCount?: __integer; + /** + * The total number of unique timezones present in the segment. + */ + TimezonesTotalCount?: __integer; + /** + * The total number of endpoints to which the campaign attempts to deliver messages. + */ + TotalEndpointCount?: __integer; + /** + * The ID of a variation of the campaign used for A/B testing. + */ + TreatmentId?: __string; + } + export interface AddressConfiguration { + /** + * Body override. If specified will override default body. + */ + BodyOverride?: __string; + /** + * The channel type. + +Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU + */ + ChannelType?: ChannelType; + /** + * A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes. + */ + Context?: MapOf__string; + /** + * The Raw JSON formatted string to be used as the payload. This value overrides the message. + */ + RawContent?: __string; + /** + * A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * Title override. If specified will override default title if applicable. + */ + TitleOverride?: __string; + } + export interface ApplicationResponse { + /** + * The arn for the application. + */ + Arn?: __string; + /** + * The unique application ID. + */ + Id?: __string; + /** + * The display name of the application. + */ + Name?: __string; + /** + * The Tags for the application. + */ + tags?: MapOf__string; + } + export interface ApplicationSettingsResource { + /** + * The unique ID for the application. + */ + ApplicationId?: __string; + /** + * Default campaign hook. + */ + CampaignHook?: CampaignHook; + /** + * The date that the settings were last updated in ISO 8601 format. + */ + LastModifiedDate?: __string; + /** + * The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. + */ + Limits?: CampaignLimits; + /** + * The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time. + +Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. + +When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: +- The endpoint includes a valid Demographic.Timezone attribute. +- The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). +- The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable). + +Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level. + */ + QuietTime?: QuietTime; + } + export interface ApplicationsResponse { + /** + * List of applications returned in this page. + */ + Item?: ListOfApplicationResponse; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: __string; + } + export interface AttributeDimension { + /** + * The type of dimension: + +INCLUSIVE - Endpoints that match the criteria are included in the segment. + +EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. + */ + AttributeType?: AttributeType; + /** + * The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. + */ + Values?: ListOf__string; + } + export type AttributeType = "INCLUSIVE"|"EXCLUSIVE"|string; + export interface AttributesResource { + /** + * The unique ID for the application. + */ + ApplicationId?: __string; + /** + * The attribute type for the application. + */ + AttributeType?: __string; + /** + * The attributes for the application. + */ + Attributes?: ListOf__string; + } + export interface BaiduChannelRequest { + /** + * Platform credential API key from Baidu. + */ + ApiKey?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Platform credential Secret key from Baidu. + */ + SecretKey?: __string; + } + export interface BaiduChannelResponse { + /** + * Application id + */ + ApplicationId?: __string; + /** + * When was this segment created + */ + CreationDate?: __string; + /** + * The Baidu API key from Baidu. + */ + Credential?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who made the last change + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * The platform type. Will be BAIDU + */ + Platform?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export interface BaiduMessage { + /** + * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL + */ + Action?: Action; + /** + * The message body of the notification. + */ + Body?: __string; + /** + * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object + */ + Data?: MapOf__string; + /** + * The icon image name of the asset saved in your application. + */ + IconReference?: __string; + /** + * The URL that points to an image used as the large icon to the notification content view. + */ + ImageIconUrl?: __string; + /** + * The URL that points to an image used in the push notification. + */ + ImageUrl?: __string; + /** + * The Raw JSON formatted string to be used as the payload. This value overrides the message. + */ + RawContent?: __string; + /** + * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. + */ + SilentPush?: __boolean; + /** + * The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view + */ + SmallImageIconUrl?: __string; + /** + * Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ + */ + Sound?: __string; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds) + */ + TimeToLive?: __integer; + /** + * The message title that displays above the message on the user's device. + */ + Title?: __string; + /** + * The URL to open in the user's mobile browser. Used if the value for Action is URL. + */ + Url?: __string; + } + export interface CampaignEmailMessage { + /** + * The email text body. + */ + Body?: __string; + /** + * The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel. + */ + FromAddress?: __string; + /** + * The email html body. + */ + HtmlBody?: __string; + /** + * The email title (Or subject). + */ + Title?: __string; + } + export interface CampaignEventFilter { + /** + * An object that defines the dimensions for the event filter. + */ + Dimensions?: EventDimensions; + /** + * The type of event that causes the campaign to be sent. Possible values: + +SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. + +ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information. + */ + FilterType?: FilterType; + } + export interface CampaignHook { + /** + * Lambda function name or arn to be called for delivery + */ + LambdaFunctionName?: __string; + /** + * What mode Lambda should be invoked in. + */ + Mode?: Mode; + /** + * Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request + */ + WebUrl?: __string; + } + export interface CampaignLimits { + /** + * The maximum number of messages that each campaign can send to a single endpoint in a 24-hour period. + */ + Daily?: __integer; + /** + * The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60. + */ + MaximumDuration?: __integer; + /** + * The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000. + */ + MessagesPerSecond?: __integer; + /** + * The maximum number of messages that an individual campaign can send to a single endpoint over the course of the campaign. + */ + Total?: __integer; + } + export interface CampaignResponse { + /** + * Treatments that are defined in addition to the default treatment. + */ + AdditionalTreatments?: ListOfTreatmentResource; + /** + * The ID of the application to which the campaign applies. + */ + ApplicationId?: __string; + /** + * The arn for the campaign. + */ + Arn?: __string; + /** + * The date the campaign was created in ISO 8601 format. + */ + CreationDate?: __string; + /** + * The status of the campaign's default treatment. Only present for A/B test campaigns. + */ + DefaultState?: CampaignState; + /** + * A description of the campaign. + */ + Description?: __string; + /** + * The allocated percentage of end users who will not receive messages from this campaign. + */ + HoldoutPercent?: __integer; + /** + * Campaign hook information. + */ + Hook?: CampaignHook; + /** + * The unique campaign ID. + */ + Id?: __string; + /** + * Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false. + */ + IsPaused?: __boolean; + /** + * The date the campaign was last updated in ISO 8601 format. + */ + LastModifiedDate?: __string; + /** + * The campaign limits settings. + */ + Limits?: CampaignLimits; + /** + * The message configuration settings. + */ + MessageConfiguration?: MessageConfiguration; + /** + * The custom name of the campaign. + */ + Name?: __string; + /** + * The campaign schedule. + */ + Schedule?: Schedule; + /** + * The ID of the segment to which the campaign sends messages. + */ + SegmentId?: __string; + /** + * The version of the segment to which the campaign sends messages. + */ + SegmentVersion?: __integer; + /** + * The campaign status. + +An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED. + */ + State?: CampaignState; + /** + * The Tags for the campaign. + */ + tags?: MapOf__string; + /** + * A custom description for the treatment. + */ + TreatmentDescription?: __string; + /** + * The custom name of a variation of the campaign used for A/B testing. + */ + TreatmentName?: __string; + /** + * The campaign version number. + */ + Version?: __integer; + } + export interface CampaignSmsMessage { + /** + * The SMS text body. + */ + Body?: __string; + /** + * Is this is a transactional SMS message, otherwise a promotional message. + */ + MessageType?: MessageType; + /** + * Sender ID of sent message. + */ + SenderId?: __string; + } + export interface CampaignState { + /** + * The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. + +Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED + */ + CampaignStatus?: CampaignStatus; + } + export type CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|string; + export interface CampaignsResponse { + /** + * A list of campaigns. + */ + Item?: ListOfCampaignResponse; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: __string; + } + export interface ChannelResponse { + /** + * Application id + */ + ApplicationId?: __string; + /** + * When was this segment created + */ + CreationDate?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who made the last change + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export type ChannelType = "GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string; + export interface ChannelsResponse { + /** + * A map of channels, with the ChannelType as the key and the Channel as the value. + */ + Channels?: MapOfChannelResponse; + } + export interface CreateAppRequest { + CreateApplicationRequest: CreateApplicationRequest; + } + export interface CreateAppResponse { + ApplicationResponse: ApplicationResponse; + } + export interface CreateApplicationRequest { + /** + * The display name of the application. Used in the Amazon Pinpoint console. + */ + Name?: __string; + /** + * The Tags for the app. + */ + tags?: MapOf__string; + } + export interface CreateCampaignRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + WriteCampaignRequest: WriteCampaignRequest; + } + export interface CreateCampaignResponse { + CampaignResponse: CampaignResponse; + } + export interface CreateExportJobRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + ExportJobRequest: ExportJobRequest; + } + export interface CreateExportJobResponse { + ExportJobResponse: ExportJobResponse; + } + export interface CreateImportJobRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + ImportJobRequest: ImportJobRequest; + } + export interface CreateImportJobResponse { + ImportJobResponse: ImportJobResponse; + } + export interface CreateSegmentRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + WriteSegmentRequest: WriteSegmentRequest; + } + export interface CreateSegmentResponse { + SegmentResponse: SegmentResponse; + } + export interface DefaultMessage { + /** + * The message body of the notification, the email body or the text message. + */ + Body?: __string; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + } + export interface DefaultPushNotificationMessage { + /** + * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL + */ + Action?: Action; + /** + * The message body of the notification. + */ + Body?: __string; + /** + * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object + */ + Data?: MapOf__string; + /** + * Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers. + */ + SilentPush?: __boolean; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * The message title that displays above the message on the user's device. + */ + Title?: __string; + /** + * The URL to open in the user's mobile browser. Used if the value for Action is URL. + */ + Url?: __string; + } + export interface DeleteAdmChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteAdmChannelResponse { + ADMChannelResponse: ADMChannelResponse; + } + export interface DeleteApnsChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteApnsChannelResponse { + APNSChannelResponse: APNSChannelResponse; + } + export interface DeleteApnsSandboxChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteApnsSandboxChannelResponse { + APNSSandboxChannelResponse: APNSSandboxChannelResponse; + } + export interface DeleteApnsVoipChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteApnsVoipChannelResponse { + APNSVoipChannelResponse: APNSVoipChannelResponse; + } + export interface DeleteApnsVoipSandboxChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteApnsVoipSandboxChannelResponse { + APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse; + } + export interface DeleteAppRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteAppResponse { + ApplicationResponse: ApplicationResponse; + } + export interface DeleteBaiduChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteBaiduChannelResponse { + BaiduChannelResponse: BaiduChannelResponse; + } + export interface DeleteCampaignRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the campaign. + */ + CampaignId: __string; + } + export interface DeleteCampaignResponse { + CampaignResponse: CampaignResponse; + } + export interface DeleteEmailChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteEmailChannelResponse { + EmailChannelResponse: EmailChannelResponse; + } + export interface DeleteEndpointRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the endpoint. + */ + EndpointId: __string; + } + export interface DeleteEndpointResponse { + EndpointResponse: EndpointResponse; + } + export interface DeleteEventStreamRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteEventStreamResponse { + EventStream: EventStream; + } + export interface DeleteGcmChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteGcmChannelResponse { + GCMChannelResponse: GCMChannelResponse; + } + export interface DeleteSegmentRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the segment. + */ + SegmentId: __string; + } + export interface DeleteSegmentResponse { + SegmentResponse: SegmentResponse; + } + export interface DeleteSmsChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteSmsChannelResponse { + SMSChannelResponse: SMSChannelResponse; + } + export interface DeleteUserEndpointsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the user. + */ + UserId: __string; + } + export interface DeleteUserEndpointsResponse { + EndpointsResponse: EndpointsResponse; + } + export interface DeleteVoiceChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface DeleteVoiceChannelResponse { + VoiceChannelResponse: VoiceChannelResponse; + } + export type DeliveryStatus = "SUCCESSFUL"|"THROTTLED"|"TEMPORARY_FAILURE"|"PERMANENT_FAILURE"|"UNKNOWN_FAILURE"|"OPT_OUT"|"DUPLICATE"|string; + export type DimensionType = "INCLUSIVE"|"EXCLUSIVE"|string; + export interface DirectMessageConfiguration { + /** + * The message to ADM channels. Overrides the default push notification message. + */ + ADMMessage?: ADMMessage; + /** + * The message to APNS channels. Overrides the default push notification message. + */ + APNSMessage?: APNSMessage; + /** + * The message to Baidu GCM channels. Overrides the default push notification message. + */ + BaiduMessage?: BaiduMessage; + /** + * The default message for all channels. + */ + DefaultMessage?: DefaultMessage; + /** + * The default push notification message for all push channels. + */ + DefaultPushNotificationMessage?: DefaultPushNotificationMessage; + /** + * The message to Email channels. Overrides the default message. + */ + EmailMessage?: EmailMessage; + /** + * The message to GCM channels. Overrides the default push notification message. + */ + GCMMessage?: GCMMessage; + /** + * The message to SMS channels. Overrides the default message. + */ + SMSMessage?: SMSMessage; + /** + * The message to Voice channels. Overrides the default message. + */ + VoiceMessage?: VoiceMessage; + } + export type Duration = "HR_24"|"DAY_7"|"DAY_14"|"DAY_30"|string; + export interface EmailChannelRequest { + /** + * The configuration set that you want to use when you send email using the Pinpoint Email API. + */ + ConfigurationSet?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * The email address used to send emails from. + */ + FromAddress?: __string; + /** + * The ARN of an identity verified with SES. + */ + Identity?: __string; + /** + * The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service + */ + RoleArn?: __string; + } + export interface EmailChannelResponse { + /** + * The unique ID of the application to which the email channel belongs. + */ + ApplicationId?: __string; + /** + * The configuration set that you want to use when you send email using the Pinpoint Email API. + */ + ConfigurationSet?: __string; + /** + * The date that the settings were last updated in ISO 8601 format. + */ + CreationDate?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * The email address used to send emails from. + */ + FromAddress?: __string; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * The ARN of an identity verified with SES. + */ + Identity?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who last updated this entry + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * Messages per second that can be sent + */ + MessagesPerSecond?: __integer; + /** + * Platform type. Will be "EMAIL" + */ + Platform?: __string; + /** + * The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service + */ + RoleArn?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export interface EmailMessage { + /** + * The body of the email message. + */ + Body?: __string; + /** + * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. + */ + FeedbackForwardingAddress?: __string; + /** + * The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel. + */ + FromAddress?: __string; + /** + * An email represented as a raw MIME message. + */ + RawEmail?: RawEmail; + /** + * The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply. + */ + ReplyToAddresses?: ListOf__string; + /** + * An email composed of a subject, a text part and a html part. + */ + SimpleEmail?: SimpleEmail; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + } + export interface EndpointBatchItem { + /** + * The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. + */ + Address?: __string; + /** + * Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. + +The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values. + */ + Attributes?: MapOfListOf__string; + /** + * The channel type. + +Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU + */ + ChannelType?: ChannelType; + /** + * The endpoint demographic attributes. + */ + Demographic?: EndpointDemographic; + /** + * The last time the endpoint was updated. Provided in ISO 8601 format. + */ + EffectiveDate?: __string; + /** + * Unused. + */ + EndpointStatus?: __string; + /** + * The unique Id for the Endpoint in the batch. + */ + Id?: __string; + /** + * The endpoint location attributes. + */ + Location?: EndpointLocation; + /** + * Custom metrics that your app reports to Amazon Pinpoint. + */ + Metrics?: MapOf__double; + /** + * Indicates whether a user has opted out of receiving messages with one of the following values: + +ALL - User has opted out of all messages. + +NONE - Users has not opted out and receives all messages. + */ + OptOut?: __string; + /** + * The unique ID for the most recent request to update the endpoint. + */ + RequestId?: __string; + /** + * Custom user-specific attributes that your app reports to Amazon Pinpoint. + */ + User?: EndpointUser; + } + export interface EndpointBatchRequest { + /** + * List of items to update. Maximum 100 items + */ + Item?: ListOfEndpointBatchItem; + } + export interface EndpointDemographic { + /** + * The version of the application associated with the endpoint. + */ + AppVersion?: __string; + /** + * The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value. + + */ + Locale?: __string; + /** + * The manufacturer of the endpoint device, such as Apple or Samsung. + */ + Make?: __string; + /** + * The model name or number of the endpoint device, such as iPhone. + */ + Model?: __string; + /** + * The model version of the endpoint device. + */ + ModelVersion?: __string; + /** + * The platform of the endpoint device, such as iOS or Android. + */ + Platform?: __string; + /** + * The platform version of the endpoint device. + */ + PlatformVersion?: __string; + /** + * The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles. + */ + Timezone?: __string; + } + export interface EndpointItemResponse { + /** + * A custom message associated with the registration of an endpoint when issuing a response. + */ + Message?: __string; + /** + * The status code associated with the merging of an endpoint when issuing a response. + */ + StatusCode?: __integer; + } + export interface EndpointLocation { + /** + * The city where the endpoint is located. + */ + City?: __string; + /** + * The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States. + */ + Country?: __string; + /** + * The latitude of the endpoint location, rounded to one decimal place. + */ + Latitude?: __double; + /** + * The longitude of the endpoint location, rounded to one decimal place. + */ + Longitude?: __double; + /** + * The postal code or zip code of the endpoint. + */ + PostalCode?: __string; + /** + * The region of the endpoint location. For example, in the United States, this corresponds to a state. + */ + Region?: __string; + } + export interface EndpointMessageResult { + /** + * Address that endpoint message was delivered to. + */ + Address?: __string; + /** + * The delivery status of the message. Possible values: + +SUCCESS - The message was successfully delivered to the endpoint. + +TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. + +FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. + +TIMEOUT - The message couldn't be sent within the timeout period. + +QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. + +DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. + +HOLDOUT - The endpoint was in a hold out treatment for the campaign. + +THROTTLED - Amazon Pinpoint throttled sending to this endpoint. + +EXPIRED - The endpoint address is expired. + +CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. + +SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. + +UNKNOWN - An unknown error occurred. + */ + DeliveryStatus?: DeliveryStatus; + /** + * Unique message identifier associated with the message that was sent. + */ + MessageId?: __string; + /** + * Downstream service status code. + */ + StatusCode?: __integer; + /** + * Status message for message delivery. + */ + StatusMessage?: __string; + /** + * If token was updated as part of delivery. (This is GCM Specific) + */ + UpdatedToken?: __string; + } + export interface EndpointRequest { + /** + * The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. + */ + Address?: __string; + /** + * Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. + +The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values. + */ + Attributes?: MapOfListOf__string; + /** + * The channel type. + +Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU + */ + ChannelType?: ChannelType; + /** + * Demographic attributes for the endpoint. + */ + Demographic?: EndpointDemographic; + /** + * The date and time when the endpoint was updated, shown in ISO 8601 format. + */ + EffectiveDate?: __string; + /** + * Unused. + */ + EndpointStatus?: __string; + /** + * The endpoint location attributes. + */ + Location?: EndpointLocation; + /** + * Custom metrics that your app reports to Amazon Pinpoint. + */ + Metrics?: MapOf__double; + /** + * Indicates whether a user has opted out of receiving messages with one of the following values: + +ALL - User has opted out of all messages. + +NONE - Users has not opted out and receives all messages. + */ + OptOut?: __string; + /** + * The unique ID for the most recent request to update the endpoint. + */ + RequestId?: __string; + /** + * Custom user-specific attributes that your app reports to Amazon Pinpoint. + */ + User?: EndpointUser; + } + export interface EndpointResponse { + /** + * The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId. + */ + Address?: __string; + /** + * The ID of the application that is associated with the endpoint. + */ + ApplicationId?: __string; + /** + * Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. + +The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes. + */ + Attributes?: MapOfListOf__string; + /** + * The channel type. + +Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU + */ + ChannelType?: ChannelType; + /** + * A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign. + */ + CohortId?: __string; + /** + * The date and time when the endpoint was created, shown in ISO 8601 format. + */ + CreationDate?: __string; + /** + * The endpoint demographic attributes. + */ + Demographic?: EndpointDemographic; + /** + * The date and time when the endpoint was last updated, shown in ISO 8601 format. + */ + EffectiveDate?: __string; + /** + * Unused. + */ + EndpointStatus?: __string; + /** + * The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application. + */ + Id?: __string; + /** + * The endpoint location attributes. + */ + Location?: EndpointLocation; + /** + * Custom metrics that your app reports to Amazon Pinpoint. + */ + Metrics?: MapOf__double; + /** + * Indicates whether a user has opted out of receiving messages with one of the following values: + +ALL - User has opted out of all messages. + +NONE - Users has not opted out and receives all messages. + */ + OptOut?: __string; + /** + * The unique ID for the most recent request to update the endpoint. + */ + RequestId?: __string; + /** + * Custom user-specific attributes that your app reports to Amazon Pinpoint. + */ + User?: EndpointUser; + } + export interface EndpointSendConfiguration { + /** + * Body override. If specified will override default body. + */ + BodyOverride?: __string; + /** + * A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes. + */ + Context?: MapOf__string; + /** + * The Raw JSON formatted string to be used as the payload. This value overrides the message. + */ + RawContent?: __string; + /** + * A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * Title override. If specified will override default title if applicable. + */ + TitleOverride?: __string; + } + export interface EndpointUser { + /** + * Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. + +The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes. + */ + UserAttributes?: MapOfListOf__string; + /** + * The unique ID of the user. + */ + UserId?: __string; + } + export interface EndpointsResponse { + /** + * The list of endpoints. + */ + Item?: ListOfEndpointResponse; + } + export interface Event { + /** + * The package name associated with the app that's recording the event. + */ + AppPackageName?: __string; + /** + * The title of the app that's recording the event. + */ + AppTitle?: __string; + /** + * The version number of the app that's recording the event. + */ + AppVersionCode?: __string; + /** + * Custom attributes that are associated with the event you're adding or updating. + */ + Attributes?: MapOf__string; + /** + * The version of the SDK that's running on the client device. + */ + ClientSdkVersion?: __string; + /** + * The name of the custom event that you're recording. + */ + EventType?: __string; + /** + * Custom metrics related to the event. + */ + Metrics?: MapOf__double; + /** + * The name of the SDK that's being used to record the event. + */ + SdkName?: __string; + /** + * Information about the session in which the event occurred. + */ + Session?: Session; + /** + * The date and time when the event occurred, in ISO 8601 format. + */ + Timestamp?: __string; + } + export interface EventDimensions { + /** + * Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. + */ + Attributes?: MapOfAttributeDimension; + /** + * The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app. + */ + EventType?: SetDimension; + /** + * Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. + */ + Metrics?: MapOfMetricDimension; + } + export interface EventItemResponse { + /** + * A custom message that is associated with the processing of an event. + */ + Message?: __string; + /** + * The status returned in the response as a result of processing the event. + +Possible values: 400 (for invalid events) and 202 (for events that were accepted). + */ + StatusCode?: __integer; + } + export interface EventStream { + /** + * The ID of the application from which events should be published. + */ + ApplicationId?: __string; + /** + * The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. + Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME + Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME + */ + DestinationStreamArn?: __string; + /** + * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint. + */ + ExternalId?: __string; + /** + * The date the event stream was last updated in ISO 8601 format. + */ + LastModifiedDate?: __string; + /** + * The IAM user who last modified the event stream. + */ + LastUpdatedBy?: __string; + /** + * The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account. + */ + RoleArn?: __string; + } + export interface EventsBatch { + /** + * The PublicEndpoint attached to the EndpointId from the request. + */ + Endpoint?: PublicEndpoint; + /** + * An object that contains a set of events associated with the endpoint. + */ + Events?: MapOfEvent; + } + export interface EventsRequest { + /** + * A batch of events to process. Each BatchItem consists of an endpoint ID as the key, and an EventsBatch object as the value. + */ + BatchItem?: MapOfEventsBatch; + } + export interface EventsResponse { + /** + * A map that contains a multipart response for each endpoint. Each item in this object uses the endpoint ID as the key, and the item response as the value. + +If no item response exists, the value can also be one of the following: 202 (if the request was processed successfully) or 400 (if the payload was invalid, or required fields were missing). + */ + Results?: MapOfItemResponse; + } + export interface ExportJobRequest { + /** + * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to. + */ + RoleArn?: __string; + /** + * A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. + +The URL should follow this format: s3://bucket-name/folder-name/ + +Amazon Pinpoint will export endpoints to this location. + */ + S3UrlPrefix?: __string; + /** + * The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application. + */ + SegmentId?: __string; + /** + * The version of the segment to export if specified. + */ + SegmentVersion?: __integer; + } + export interface ExportJobResource { + /** + * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to. + */ + RoleArn?: __string; + /** + * A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. + +The URL should follow this format: s3://bucket-name/folder-name/ + +Amazon Pinpoint will export endpoints to this location. + */ + S3UrlPrefix?: __string; + /** + * The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application. + */ + SegmentId?: __string; + /** + * The version of the segment to export if specified. + */ + SegmentVersion?: __integer; + } + export interface ExportJobResponse { + /** + * The unique ID of the application associated with the export job. + */ + ApplicationId?: __string; + /** + * The number of pieces that have successfully completed as of the time of the request. + */ + CompletedPieces?: __integer; + /** + * The date the job completed in ISO 8601 format. + */ + CompletionDate?: __string; + /** + * The date the job was created in ISO 8601 format. + */ + CreationDate?: __string; + /** + * The export job settings. + */ + Definition?: ExportJobResource; + /** + * The number of pieces that failed to be processed as of the time of the request. + */ + FailedPieces?: __integer; + /** + * Provides up to 100 of the first failed entries for the job, if any exist. + */ + Failures?: ListOf__string; + /** + * The unique ID of the job. + */ + Id?: __string; + /** + * The status of the job. +Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED + +The job status is FAILED if one or more pieces failed. + */ + JobStatus?: JobStatus; + /** + * The number of endpoints that were not processed; for example, because of syntax errors. + */ + TotalFailures?: __integer; + /** + * The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints. + */ + TotalPieces?: __integer; + /** + * The number of endpoints that were processed by the job. + */ + TotalProcessed?: __integer; + /** + * The job type. Will be 'EXPORT'. + */ + Type?: __string; + } + export interface ExportJobsResponse { + /** + * A list of export jobs for the application. + */ + Item?: ListOfExportJobResponse; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: __string; + } + export type FilterType = "SYSTEM"|"ENDPOINT"|string; + export type Format = "CSV"|"JSON"|string; + export type Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|string; + export interface GCMChannelRequest { + /** + * Platform credential API key from Google. + */ + ApiKey?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + } + export interface GCMChannelResponse { + /** + * The ID of the application to which the channel applies. + */ + ApplicationId?: __string; + /** + * When was this segment created + */ + CreationDate?: __string; + /** + * The GCM API key from Google. + */ + Credential?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * Channel ID. Not used. Present only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who last updated this entry + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * The platform type. Will be GCM + */ + Platform?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export interface GCMMessage { + /** + * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL + */ + Action?: Action; + /** + * The message body of the notification. + */ + Body?: __string; + /** + * This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active. + */ + CollapseKey?: __string; + /** + * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object + */ + Data?: MapOf__string; + /** + * The icon image name of the asset saved in your application. + */ + IconReference?: __string; + /** + * The URL that points to an image used as the large icon to the notification content view. + */ + ImageIconUrl?: __string; + /** + * The URL that points to an image used in the push notification. + */ + ImageUrl?: __string; + /** + * The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: + +"Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. + +"High" - Messages are sent immediately and might wake a sleeping device. + +The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. + +For more information, see About FCM Messages in the Firebase documentation. + */ + Priority?: __string; + /** + * The Raw JSON formatted string to be used as the payload. This value overrides the message. + */ + RawContent?: __string; + /** + * This parameter specifies the package name of the application where the registration tokens must match in order to receive the message. + */ + RestrictedPackageName?: __string; + /** + * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. + */ + SilentPush?: __boolean; + /** + * The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view + */ + SmallImageIconUrl?: __string; + /** + * Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ + */ + Sound?: __string; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter. + */ + TimeToLive?: __integer; + /** + * The message title that displays above the message on the user's device. + */ + Title?: __string; + /** + * The URL to open in the user's mobile browser. Used if the value for Action is URL. + */ + Url?: __string; + } + export interface GPSCoordinates { + /** + * Latitude + */ + Latitude?: __double; + /** + * Longitude + */ + Longitude?: __double; + } + export interface GPSPointDimension { + /** + * Coordinate to measure distance from. + */ + Coordinates?: GPSCoordinates; + /** + * Range in kilometers from the coordinate. + */ + RangeInKilometers?: __double; + } + export interface GetAdmChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetAdmChannelResponse { + ADMChannelResponse: ADMChannelResponse; + } + export interface GetApnsChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetApnsChannelResponse { + APNSChannelResponse: APNSChannelResponse; + } + export interface GetApnsSandboxChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetApnsSandboxChannelResponse { + APNSSandboxChannelResponse: APNSSandboxChannelResponse; + } + export interface GetApnsVoipChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetApnsVoipChannelResponse { + APNSVoipChannelResponse: APNSVoipChannelResponse; + } + export interface GetApnsVoipSandboxChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetApnsVoipSandboxChannelResponse { + APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse; + } + export interface GetAppRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetAppResponse { + ApplicationResponse: ApplicationResponse; + } + export interface GetApplicationSettingsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetApplicationSettingsResponse { + ApplicationSettingsResource: ApplicationSettingsResource; + } + export interface GetAppsRequest { + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetAppsResponse { + ApplicationsResponse: ApplicationsResponse; + } + export interface GetBaiduChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetBaiduChannelResponse { + BaiduChannelResponse: BaiduChannelResponse; + } + export interface GetCampaignActivitiesRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the campaign. + */ + CampaignId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetCampaignActivitiesResponse { + ActivitiesResponse: ActivitiesResponse; + } + export interface GetCampaignRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the campaign. + */ + CampaignId: __string; + } + export interface GetCampaignResponse { + CampaignResponse: CampaignResponse; + } + export interface GetCampaignVersionRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the campaign. + */ + CampaignId: __string; + /** + * The version of the campaign. + */ + Version: __string; + } + export interface GetCampaignVersionResponse { + CampaignResponse: CampaignResponse; + } + export interface GetCampaignVersionsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the campaign. + */ + CampaignId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetCampaignVersionsResponse { + CampaignsResponse: CampaignsResponse; + } + export interface GetCampaignsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetCampaignsResponse { + CampaignsResponse: CampaignsResponse; + } + export interface GetChannelsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetChannelsResponse { + ChannelsResponse: ChannelsResponse; + } + export interface GetEmailChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetEmailChannelResponse { + EmailChannelResponse: EmailChannelResponse; + } + export interface GetEndpointRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the endpoint. + */ + EndpointId: __string; + } + export interface GetEndpointResponse { + EndpointResponse: EndpointResponse; + } + export interface GetEventStreamRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetEventStreamResponse { + EventStream: EventStream; + } + export interface GetExportJobRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the job. + */ + JobId: __string; + } + export interface GetExportJobResponse { + ExportJobResponse: ExportJobResponse; + } + export interface GetExportJobsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetExportJobsResponse { + ExportJobsResponse: ExportJobsResponse; + } + export interface GetGcmChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetGcmChannelResponse { + GCMChannelResponse: GCMChannelResponse; + } + export interface GetImportJobRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the job. + */ + JobId: __string; + } + export interface GetImportJobResponse { + ImportJobResponse: ImportJobResponse; + } + export interface GetImportJobsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetImportJobsResponse { + ImportJobsResponse: ImportJobsResponse; + } + export interface GetSegmentExportJobsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The unique ID of the segment. + */ + SegmentId: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetSegmentExportJobsResponse { + ExportJobsResponse: ExportJobsResponse; + } + export interface GetSegmentImportJobsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The unique ID of the segment. + */ + SegmentId: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetSegmentImportJobsResponse { + ImportJobsResponse: ImportJobsResponse; + } + export interface GetSegmentRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the segment. + */ + SegmentId: __string; + } + export interface GetSegmentResponse { + SegmentResponse: SegmentResponse; + } + export interface GetSegmentVersionRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the segment. + */ + SegmentId: __string; + /** + * The segment version. + */ + Version: __string; + } + export interface GetSegmentVersionResponse { + SegmentResponse: SegmentResponse; + } + export interface GetSegmentVersionsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The unique ID of the segment. + */ + SegmentId: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetSegmentVersionsResponse { + SegmentsResponse: SegmentsResponse; + } + export interface GetSegmentsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The number of entries you want on each page in the response. + */ + PageSize?: __string; + /** + * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. + */ + Token?: __string; + } + export interface GetSegmentsResponse { + SegmentsResponse: SegmentsResponse; + } + export interface GetSmsChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetSmsChannelResponse { + SMSChannelResponse: SMSChannelResponse; + } + export interface GetUserEndpointsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the user. + */ + UserId: __string; + } + export interface GetUserEndpointsResponse { + EndpointsResponse: EndpointsResponse; + } + export interface GetVoiceChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface GetVoiceChannelResponse { + VoiceChannelResponse: VoiceChannelResponse; + } + export interface ImportJobRequest { + /** + * Sets whether the endpoints create a segment when they are imported. + */ + DefineSegment?: __boolean; + /** + * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint. + */ + ExternalId?: __string; + /** + * The format of the files that contain the endpoint definitions. +Valid values: CSV, JSON + */ + Format?: Format; + /** + * Sets whether the endpoints are registered with Amazon Pinpoint when they are imported. + */ + RegisterEndpoints?: __boolean; + /** + * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import. + */ + RoleArn?: __string; + /** + * The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name + +Amazon Pinpoint imports endpoints from this location and any subfolders it contains. + */ + S3Url?: __string; + /** + * The ID of the segment to update if the import job is meant to update an existing segment. + */ + SegmentId?: __string; + /** + * A custom name for the segment created by the import job. Use if DefineSegment is true. + */ + SegmentName?: __string; + } + export interface ImportJobResource { + /** + * Sets whether the endpoints create a segment when they are imported. + */ + DefineSegment?: __boolean; + /** + * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint. + */ + ExternalId?: __string; + /** + * The format of the files that contain the endpoint definitions. +Valid values: CSV, JSON + */ + Format?: Format; + /** + * Sets whether the endpoints are registered with Amazon Pinpoint when they are imported. + */ + RegisterEndpoints?: __boolean; + /** + * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import. + */ + RoleArn?: __string; + /** + * The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name + +Amazon Pinpoint imports endpoints from this location and any subfolders it contains. + */ + S3Url?: __string; + /** + * The ID of the segment to update if the import job is meant to update an existing segment. + */ + SegmentId?: __string; + /** + * A custom name for the segment created by the import job. Use if DefineSegment is true. + */ + SegmentName?: __string; + } + export interface ImportJobResponse { + /** + * The unique ID of the application to which the import job applies. + */ + ApplicationId?: __string; + /** + * The number of pieces that have successfully imported as of the time of the request. + */ + CompletedPieces?: __integer; + /** + * The date the import job completed in ISO 8601 format. + */ + CompletionDate?: __string; + /** + * The date the import job was created in ISO 8601 format. + */ + CreationDate?: __string; + /** + * The import job settings. + */ + Definition?: ImportJobResource; + /** + * The number of pieces that have failed to import as of the time of the request. + */ + FailedPieces?: __integer; + /** + * Provides up to 100 of the first failed entries for the job, if any exist. + */ + Failures?: ListOf__string; + /** + * The unique ID of the import job. + */ + Id?: __string; + /** + * The status of the import job. +Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED + +The job status is FAILED if one or more pieces failed to import. + */ + JobStatus?: JobStatus; + /** + * The number of endpoints that failed to import; for example, because of syntax errors. + */ + TotalFailures?: __integer; + /** + * The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import. + */ + TotalPieces?: __integer; + /** + * The number of endpoints that were processed by the import job. + */ + TotalProcessed?: __integer; + /** + * The job type. Will be Import. + */ + Type?: __string; + } + export interface ImportJobsResponse { + /** + * A list of import jobs for the application. + */ + Item?: ListOfImportJobResponse; + /** + * The string that you use in a subsequent request to get the next page of results in a paginated response. + */ + NextToken?: __string; + } + export type Include = "ALL"|"ANY"|"NONE"|string; + export interface ItemResponse { + /** + * The response received after the endpoint was accepted. + */ + EndpointItemResponse?: EndpointItemResponse; + /** + * A multipart response object that contains a key and value for each event ID in the request. In each object, the event ID is the key, and an EventItemResponse object is the value. + */ + EventsItemResponse?: MapOfEventItemResponse; + } + export type JobStatus = "CREATED"|"INITIALIZING"|"PROCESSING"|"COMPLETING"|"COMPLETED"|"FAILING"|"FAILED"|string; + export interface ListTagsForResourceRequest { + ResourceArn: __string; + } + export interface ListTagsForResourceResponse { + TagsModel: TagsModel; + } + export interface Message { + /** + * The action that occurs if the user taps a push notification delivered by the campaign: +OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. + +DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. + +URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. + */ + Action?: Action; + /** + * The message body. Can include up to 140 characters. + */ + Body?: __string; + /** + * The URL that points to the icon image for the push notification icon, for example, the app icon. + */ + ImageIconUrl?: __string; + /** + * The URL that points to the small icon image for the push notification icon, for example, the app icon. + */ + ImageSmallIconUrl?: __string; + /** + * The URL that points to an image used in the push notification. + */ + ImageUrl?: __string; + /** + * The JSON payload used for a silent push. + */ + JsonBody?: __string; + /** + * A URL that refers to the location of an image or video that you want to display in the push notification. + */ + MediaUrl?: __string; + /** + * The Raw JSON formatted string to be used as the payload. This value overrides the message. + */ + RawContent?: __string; + /** + * Indicates if the message should display on the users device. + +Silent pushes can be used for Remote Configuration and Phone Home use cases. + */ + SilentPush?: __boolean; + /** + * This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM + */ + TimeToLive?: __integer; + /** + * The message title that displays above the message on the user's device. + */ + Title?: __string; + /** + * The URL to open in the user's mobile browser. Used if the value for Action is URL. + */ + Url?: __string; + } + export interface MessageBody { + /** + * The error message that's returned from the API. + */ + Message?: __string; + /** + * The unique message body ID. + */ + RequestID?: __string; + } + export interface MessageConfiguration { + /** + * The message that the campaign delivers to ADM channels. Overrides the default message. + */ + ADMMessage?: Message; + /** + * The message that the campaign delivers to APNS channels. Overrides the default message. + */ + APNSMessage?: Message; + /** + * The message that the campaign delivers to Baidu channels. Overrides the default message. + */ + BaiduMessage?: Message; + /** + * The default message for all channels. + */ + DefaultMessage?: Message; + /** + * The email message configuration. + */ + EmailMessage?: CampaignEmailMessage; + /** + * The message that the campaign delivers to GCM channels. Overrides the default message. + */ + GCMMessage?: Message; + /** + * The SMS message configuration. + */ + SMSMessage?: CampaignSmsMessage; + } + export interface MessageRequest { + /** + * A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. + */ + Addresses?: MapOfAddressConfiguration; + /** + * A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes. + */ + Context?: MapOf__string; + /** + * A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions. + */ + Endpoints?: MapOfEndpointSendConfiguration; + /** + * Message configuration. + */ + MessageConfiguration?: DirectMessageConfiguration; + /** + * A unique ID that you can use to trace a message. This ID is visible to recipients. + */ + TraceId?: __string; + } + export interface MessageResponse { + /** + * Application id of the message. + */ + ApplicationId?: __string; + /** + * A map containing a multi part response for each address, with the endpointId as the key and the result as the value. + */ + EndpointResult?: MapOfEndpointMessageResult; + /** + * Original request Id for which this message was delivered. + */ + RequestId?: __string; + /** + * A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value. + */ + Result?: MapOfMessageResult; + } + export interface MessageResult { + /** + * The delivery status of the message. Possible values: + +SUCCESS - The message was successfully delivered to the endpoint. + +TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. + +FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. + +TIMEOUT - The message couldn't be sent within the timeout period. + +QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. + +DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. + +HOLDOUT - The endpoint was in a hold out treatment for the campaign. + +THROTTLED - Amazon Pinpoint throttled sending to this endpoint. + +EXPIRED - The endpoint address is expired. + +CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. + +SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. + +UNKNOWN - An unknown error occurred. + */ + DeliveryStatus?: DeliveryStatus; + /** + * Unique message identifier associated with the message that was sent. + */ + MessageId?: __string; + /** + * Downstream service status code. + */ + StatusCode?: __integer; + /** + * Status message for message delivery. + */ + StatusMessage?: __string; + /** + * If token was updated as part of delivery. (This is GCM Specific) + */ + UpdatedToken?: __string; + } + export type MessageType = "TRANSACTIONAL"|"PROMOTIONAL"|string; + export interface MetricDimension { + /** + * The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL + */ + ComparisonOperator?: __string; + /** + * The value to be compared. + */ + Value?: __double; + } + export type Mode = "DELIVERY"|"FILTER"|string; + export interface NumberValidateRequest { + /** + * (Optional) The two-character ISO country code for the country or region where the phone number was originally registered. + */ + IsoCountryCode?: __string; + /** + * The phone number to get information about. The phone number that you provide should include a country code. If the number doesn't include a valid country code, the operation might result in an error. + */ + PhoneNumber?: __string; + } + export interface NumberValidateResponse { + /** + * The carrier or servive provider that the phone number is currently registered with. + */ + Carrier?: __string; + /** + * The city where the phone number was originally registered. + */ + City?: __string; + /** + * The cleansed phone number, shown in E.164 format. + */ + CleansedPhoneNumberE164?: __string; + /** + * The cleansed phone number, shown in the local phone number format. + */ + CleansedPhoneNumberNational?: __string; + /** + * The country or region where the phone number was originally registered. + */ + Country?: __string; + /** + * The two-character ISO code for the country or region where the phone number was originally registered. + */ + CountryCodeIso2?: __string; + /** + * The numeric code for the country or region where the phone number was originally registered. + */ + CountryCodeNumeric?: __string; + /** + * The county where the phone number was originally registered. + */ + County?: __string; + /** + * The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body. + */ + OriginalCountryCodeIso2?: __string; + /** + * The phone number that you included in the request body. + */ + OriginalPhoneNumber?: __string; + /** + * A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER. + */ + PhoneType?: __string; + /** + * The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID). + */ + PhoneTypeCode?: __integer; + /** + * The time zone for the location where the phone number was originally registered. + */ + Timezone?: __string; + /** + * The postal code for the location where the phone number was originally registered. + */ + ZipCode?: __string; + } + export interface PhoneNumberValidateRequest { + NumberValidateRequest: NumberValidateRequest; + } + export interface PhoneNumberValidateResponse { + NumberValidateResponse: NumberValidateResponse; + } + export interface PublicEndpoint { + /** + * The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number. + */ + Address?: __string; + /** + * Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment. + */ + Attributes?: MapOfListOf__string; + /** + * The channel type. + +Valid values: APNS, GCM + */ + ChannelType?: ChannelType; + /** + * The endpoint demographic attributes. + */ + Demographic?: EndpointDemographic; + /** + * The date and time when the endpoint was last updated, in ISO 8601 format. + */ + EffectiveDate?: __string; + /** + * The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE. + */ + EndpointStatus?: __string; + /** + * The endpoint location attributes. + */ + Location?: EndpointLocation; + /** + * Custom metrics that your app reports to Amazon Pinpoint. + */ + Metrics?: MapOf__double; + /** + * Indicates whether a user has opted out of receiving messages with one of the following values: + +ALL - User has opted out of all messages. + +NONE - Users has not opted out and receives all messages. + */ + OptOut?: __string; + /** + * A unique identifier that is generated each time the endpoint is updated. + */ + RequestId?: __string; + /** + * Custom user-specific attributes that your app reports to Amazon Pinpoint. + */ + User?: EndpointUser; + } + export interface PutEventStreamRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + WriteEventStream: WriteEventStream; + } + export interface PutEventStreamResponse { + EventStream: EventStream; + } + export interface PutEventsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + EventsRequest: EventsRequest; + } + export interface PutEventsResponse { + EventsResponse: EventsResponse; + } + export interface QuietTime { + /** + * The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. + */ + End?: __string; + /** + * The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. + */ + Start?: __string; + } + export interface RawEmail { + /** + * The raw email message itself. Then entire message must be base64-encoded. + */ + Data?: __blob; + } + export type __blob = Buffer|Uint8Array|Blob|string; + export interface RecencyDimension { + /** + * The length of time during which users have been active or inactive with your app. + +Valid values: HR_24, DAY_7, DAY_14, DAY_30 + */ + Duration?: Duration; + /** + * The recency dimension type: + +ACTIVE - Users who have used your app within the specified duration are included in the segment. + +INACTIVE - Users who have not used your app within the specified duration are included in the segment. + */ + RecencyType?: RecencyType; + } + export type RecencyType = "ACTIVE"|"INACTIVE"|string; + export interface RemoveAttributesRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * Type of attribute. Can be endpoint-custom-attributes, endpoint-custom-metrics, endpoint-user-attributes. + */ + AttributeType: __string; + UpdateAttributesRequest: UpdateAttributesRequest; + } + export interface RemoveAttributesResponse { + AttributesResource: AttributesResource; + } + export interface SMSChannelRequest { + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Sender identifier of your messages. + */ + SenderId?: __string; + /** + * ShortCode registered with phone provider. + */ + ShortCode?: __string; + } + export interface SMSChannelResponse { + /** + * The unique ID of the application to which the SMS channel belongs. + */ + ApplicationId?: __string; + /** + * The date that the settings were last updated in ISO 8601 format. + */ + CreationDate?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + /** + * Not used. Retained for backwards compatibility. + */ + HasCredential?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who last updated this entry + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * Platform type. Will be "SMS" + */ + Platform?: __string; + /** + * Promotional messages per second that can be sent + */ + PromotionalMessagesPerSecond?: __integer; + /** + * Sender identifier of your messages. + */ + SenderId?: __string; + /** + * The short code registered with the phone provider. + */ + ShortCode?: __string; + /** + * Transactional messages per second that can be sent + */ + TransactionalMessagesPerSecond?: __integer; + /** + * Version of channel + */ + Version?: __integer; + } + export interface SMSMessage { + /** + * The body of the SMS message. + */ + Body?: __string; + /** + * The SMS program name that you provided to AWS Support when you requested your dedicated number. + */ + Keyword?: __string; + /** + * Is this a transaction priority message or lower priority. + */ + MessageType?: MessageType; + /** + * The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code. + */ + OriginationNumber?: __string; + /** + * The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region. + */ + SenderId?: __string; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + } + export interface Schedule { + /** + * The scheduled time that the campaign ends in ISO 8601 format. + */ + EndTime?: __string; + /** + * Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT. + */ + EventFilter?: CampaignEventFilter; + /** + * How often the campaign delivers messages. + +Valid values: + +ONCE + +HOURLY + +DAILY + +WEEKLY + +MONTHLY + +EVENT + */ + Frequency?: Frequency; + /** + * Indicates whether the campaign schedule takes effect according to each user's local time. + */ + IsLocalTime?: __boolean; + /** + * The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. + +Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. + +When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: +- The endpoint includes a valid Demographic.Timezone attribute. +- The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. +- The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign. + */ + QuietTime?: QuietTime; + /** + * The scheduled time that the campaign begins in ISO 8601 format. + */ + StartTime?: __string; + /** + * The starting UTC offset for the schedule if the value for isLocalTime is true + +Valid values: +UTC +UTC+01 +UTC+02 +UTC+03 +UTC+03:30 +UTC+04 +UTC+04:30 +UTC+05 +UTC+05:30 +UTC+05:45 +UTC+06 +UTC+06:30 +UTC+07 +UTC+08 +UTC+09 +UTC+09:30 +UTC+10 +UTC+10:30 +UTC+11 +UTC+12 +UTC+13 +UTC-02 +UTC-03 +UTC-04 +UTC-05 +UTC-06 +UTC-07 +UTC-08 +UTC-09 +UTC-10 +UTC-11 + */ + Timezone?: __string; + } + export interface SegmentBehaviors { + /** + * The recency of use. + */ + Recency?: RecencyDimension; + } + export interface SegmentDemographics { + /** + * The app version criteria for the segment. + */ + AppVersion?: SetDimension; + /** + * The channel criteria for the segment. + */ + Channel?: SetDimension; + /** + * The device type criteria for the segment. + */ + DeviceType?: SetDimension; + /** + * The device make criteria for the segment. + */ + Make?: SetDimension; + /** + * The device model criteria for the segment. + */ + Model?: SetDimension; + /** + * The device platform criteria for the segment. + */ + Platform?: SetDimension; + } + export interface SegmentDimensions { + /** + * Custom segment attributes. + */ + Attributes?: MapOfAttributeDimension; + /** + * The segment behaviors attributes. + */ + Behavior?: SegmentBehaviors; + /** + * The segment demographics attributes. + */ + Demographic?: SegmentDemographics; + /** + * The segment location attributes. + */ + Location?: SegmentLocation; + /** + * Custom segment metrics. + */ + Metrics?: MapOfMetricDimension; + /** + * Custom segment user attributes. + */ + UserAttributes?: MapOfAttributeDimension; + } + export interface SegmentGroup { + /** + * List of dimensions to include or exclude. + */ + Dimensions?: ListOfSegmentDimensions; + /** + * The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. + +NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it. + */ + SourceSegments?: ListOfSegmentReference; + /** + * Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. + */ + SourceType?: SourceType; + /** + * Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. + */ + Type?: Type; + } + export interface SegmentGroupList { + /** + * A set of segment criteria to evaluate. + */ + Groups?: ListOfSegmentGroup; + /** + * Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. + */ + Include?: Include; + } + export interface SegmentImportResource { + /** + * The number of channel types in the imported segment. + */ + ChannelCounts?: MapOf__integer; + /** + * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint. + */ + ExternalId?: __string; + /** + * The format of the endpoint files that were imported to create this segment. +Valid values: CSV, JSON + */ + Format?: Format; + /** + * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3. + */ + RoleArn?: __string; + /** + * The URL of the S3 bucket that the segment was imported from. + */ + S3Url?: __string; + /** + * The number of endpoints that were successfully imported to create this segment. + */ + Size?: __integer; + } + export interface SegmentLocation { + /** + * The country or region, in ISO 3166-1 alpha-2 format. + */ + Country?: SetDimension; + /** + * The GPS Point dimension. + */ + GPSPoint?: GPSPointDimension; + } + export interface SegmentReference { + /** + * A unique identifier for the segment. + */ + Id?: __string; + /** + * If specified contains a specific version of the segment included. + */ + Version?: __integer; + } + export interface SegmentResponse { + /** + * The ID of the application that the segment applies to. + */ + ApplicationId?: __string; + /** + * The arn for the segment. + */ + Arn?: __string; + /** + * The date and time when the segment was created. + */ + CreationDate?: __string; + /** + * The segment dimensions attributes. + */ + Dimensions?: SegmentDimensions; + /** + * The unique segment ID. + */ + Id?: __string; + /** + * The import job settings. + */ + ImportDefinition?: SegmentImportResource; + /** + * The date and time when the segment was last modified. + */ + LastModifiedDate?: __string; + /** + * The name of the segment. + */ + Name?: __string; + /** + * A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. + */ + SegmentGroups?: SegmentGroupList; + /** + * The segment type: +DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. +IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. + */ + SegmentType?: SegmentType; + /** + * The Tags for the segment. + */ + tags?: MapOf__string; + /** + * The segment version number. + */ + Version?: __integer; + } + export type SegmentType = "DIMENSIONAL"|"IMPORT"|string; + export interface SegmentsResponse { + /** + * The list of segments. + */ + Item?: ListOfSegmentResponse; + /** + * An identifier used to retrieve the next page of results. The token is null if no additional pages exist. + */ + NextToken?: __string; + } + export interface SendMessagesRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + MessageRequest: MessageRequest; + } + export interface SendMessagesResponse { + MessageResponse: MessageResponse; + } + export interface SendUsersMessageRequest { + /** + * A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries. + */ + Context?: MapOf__string; + /** + * Message definitions for the default message and any messages that are tailored for specific channels. + */ + MessageConfiguration?: DirectMessageConfiguration; + /** + * A unique ID that you can use to trace a message. This ID is visible to recipients. + */ + TraceId?: __string; + /** + * A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions. + */ + Users?: MapOfEndpointSendConfiguration; + } + export interface SendUsersMessageResponse { + /** + * The unique ID of the Amazon Pinpoint project used to send the message. + */ + ApplicationId?: __string; + /** + * The unique ID assigned to the users-messages request. + */ + RequestId?: __string; + /** + * An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object. + */ + Result?: MapOfMapOfEndpointMessageResult; + } + export interface SendUsersMessagesRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + SendUsersMessageRequest: SendUsersMessageRequest; + } + export interface SendUsersMessagesResponse { + SendUsersMessageResponse: SendUsersMessageResponse; + } + export interface Session { + /** + * The duration of the session, in milliseconds. + */ + Duration?: __integer; + /** + * A unique identifier for the session. + */ + Id?: __string; + /** + * The date and time when the session began. + */ + StartTimestamp?: __string; + /** + * The date and time when the session ended. + */ + StopTimestamp?: __string; + } + export interface SetDimension { + /** + * The type of dimension: + +INCLUSIVE - Endpoints that match the criteria are included in the segment. + +EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. + */ + DimensionType?: DimensionType; + /** + * The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. + */ + Values?: ListOf__string; + } + export interface SimpleEmail { + /** + * The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message. + */ + HtmlPart?: SimpleEmailPart; + /** + * The subject of the message: A short summary of the content, which will appear in the recipient's inbox. + */ + Subject?: SimpleEmailPart; + /** + * The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices). + */ + TextPart?: SimpleEmailPart; + } + export interface SimpleEmailPart { + /** + * The character set of the content. + */ + Charset?: __string; + /** + * The textual data of the content. + */ + Data?: __string; + } + export type SourceType = "ALL"|"ANY"|"NONE"|string; + export interface TagResourceRequest { + ResourceArn: __string; + TagsModel: TagsModel; + } + export interface TagsModel { + tags: MapOf__string; + } + export interface TreatmentResource { + /** + * The unique treatment ID. + */ + Id?: __string; + /** + * The message configuration settings. + */ + MessageConfiguration?: MessageConfiguration; + /** + * The campaign schedule. + */ + Schedule?: Schedule; + /** + * The allocated percentage of users for this treatment. + */ + SizePercent?: __integer; + /** + * The treatment status. + */ + State?: CampaignState; + /** + * A custom description for the treatment. + */ + TreatmentDescription?: __string; + /** + * The custom name of a variation of the campaign used for A/B testing. + */ + TreatmentName?: __string; + } + export type Type = "ALL"|"ANY"|"NONE"|string; + export interface UntagResourceRequest { + ResourceArn: __string; + /** + * The key(s) of tag to be deleted + */ + TagKeys: ListOf__string; + } + export interface UpdateAdmChannelRequest { + ADMChannelRequest: ADMChannelRequest; + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface UpdateAdmChannelResponse { + ADMChannelResponse: ADMChannelResponse; + } + export interface UpdateApnsChannelRequest { + APNSChannelRequest: APNSChannelRequest; + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface UpdateApnsChannelResponse { + APNSChannelResponse: APNSChannelResponse; + } + export interface UpdateApnsSandboxChannelRequest { + APNSSandboxChannelRequest: APNSSandboxChannelRequest; + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface UpdateApnsSandboxChannelResponse { + APNSSandboxChannelResponse: APNSSandboxChannelResponse; + } + export interface UpdateApnsVoipChannelRequest { + APNSVoipChannelRequest: APNSVoipChannelRequest; + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface UpdateApnsVoipChannelResponse { + APNSVoipChannelResponse: APNSVoipChannelResponse; + } + export interface UpdateApnsVoipSandboxChannelRequest { + APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest; + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + } + export interface UpdateApnsVoipSandboxChannelResponse { + APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse; + } + export interface UpdateApplicationSettingsRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + WriteApplicationSettingsRequest: WriteApplicationSettingsRequest; + } + export interface UpdateApplicationSettingsResponse { + ApplicationSettingsResource: ApplicationSettingsResource; + } + export interface UpdateAttributesRequest { + /** + * The GLOB wildcard for removing the attributes in the application + */ + Blacklist?: ListOf__string; + } + export interface UpdateBaiduChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + BaiduChannelRequest: BaiduChannelRequest; + } + export interface UpdateBaiduChannelResponse { + BaiduChannelResponse: BaiduChannelResponse; + } + export interface UpdateCampaignRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the campaign. + */ + CampaignId: __string; + WriteCampaignRequest: WriteCampaignRequest; + } + export interface UpdateCampaignResponse { + CampaignResponse: CampaignResponse; + } + export interface UpdateEmailChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + EmailChannelRequest: EmailChannelRequest; + } + export interface UpdateEmailChannelResponse { + EmailChannelResponse: EmailChannelResponse; + } + export interface UpdateEndpointRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the endpoint. + */ + EndpointId: __string; + EndpointRequest: EndpointRequest; + } + export interface UpdateEndpointResponse { + MessageBody: MessageBody; + } + export interface UpdateEndpointsBatchRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + EndpointBatchRequest: EndpointBatchRequest; + } + export interface UpdateEndpointsBatchResponse { + MessageBody: MessageBody; + } + export interface UpdateGcmChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + GCMChannelRequest: GCMChannelRequest; + } + export interface UpdateGcmChannelResponse { + GCMChannelResponse: GCMChannelResponse; + } + export interface UpdateSegmentRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + /** + * The unique ID of the segment. + */ + SegmentId: __string; + WriteSegmentRequest: WriteSegmentRequest; + } + export interface UpdateSegmentResponse { + SegmentResponse: SegmentResponse; + } + export interface UpdateSmsChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + SMSChannelRequest: SMSChannelRequest; + } + export interface UpdateSmsChannelResponse { + SMSChannelResponse: SMSChannelResponse; + } + export interface UpdateVoiceChannelRequest { + /** + * The unique ID of your Amazon Pinpoint application. + */ + ApplicationId: __string; + VoiceChannelRequest: VoiceChannelRequest; + } + export interface UpdateVoiceChannelResponse { + VoiceChannelResponse: VoiceChannelResponse; + } + export interface VoiceChannelRequest { + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + } + export interface VoiceChannelResponse { + /** + * Application id + */ + ApplicationId?: __string; + /** + * The date that the settings were last updated in ISO 8601 format. + */ + CreationDate?: __string; + /** + * If the channel is enabled for sending messages. + */ + Enabled?: __boolean; + HasCredential?: __boolean; + /** + * Channel ID. Not used, only for backwards compatibility. + */ + Id?: __string; + /** + * Is this channel archived + */ + IsArchived?: __boolean; + /** + * Who made the last change + */ + LastModifiedBy?: __string; + /** + * Last date this was updated + */ + LastModifiedDate?: __string; + /** + * Platform type. Will be "Voice" + */ + Platform?: __string; + /** + * Version of channel + */ + Version?: __integer; + } + export interface VoiceMessage { + /** + * The message body of the notification, the email body or the text message. + */ + Body?: __string; + /** + * Language of sent message + */ + LanguageCode?: __string; + /** + * Is the number from the pool or messaging service to send from. + */ + OriginationNumber?: __string; + /** + * Default message substitutions. Can be overridden by individual address substitutions. + */ + Substitutions?: MapOfListOf__string; + /** + * Voice ID of sent message. + */ + VoiceId?: __string; + } + export interface WriteApplicationSettingsRequest { + /** + * Default campaign hook information. + */ + CampaignHook?: CampaignHook; + /** + * The CloudWatchMetrics settings for the app. + */ + CloudWatchMetricsEnabled?: __boolean; + /** + * The limits that apply to each campaign in the project by default. Campaigns can also have their own limits, which override the settings at the project level. + */ + Limits?: CampaignLimits; + /** + * The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time. + +Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. + +When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: +- The endpoint includes a valid Demographic.Timezone attribute. +- The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). +- The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable). + +Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level. + */ + QuietTime?: QuietTime; + } + export interface WriteCampaignRequest { + /** + * Treatments that are defined in addition to the default treatment. + */ + AdditionalTreatments?: ListOfWriteTreatmentResource; + /** + * A description of the campaign. + */ + Description?: __string; + /** + * The allocated percentage of end users who will not receive messages from this campaign. + */ + HoldoutPercent?: __integer; + /** + * Campaign hook information. + */ + Hook?: CampaignHook; + /** + * Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false. + */ + IsPaused?: __boolean; + /** + * The campaign limits settings. + */ + Limits?: CampaignLimits; + /** + * The message configuration settings. + */ + MessageConfiguration?: MessageConfiguration; + /** + * The custom name of the campaign. + */ + Name?: __string; + /** + * The campaign schedule. + */ + Schedule?: Schedule; + /** + * The ID of the segment to which the campaign sends messages. + */ + SegmentId?: __string; + /** + * The version of the segment to which the campaign sends messages. + */ + SegmentVersion?: __integer; + /** + * The Tags for the campaign. + */ + tags?: MapOf__string; + /** + * A custom description for the treatment. + */ + TreatmentDescription?: __string; + /** + * The custom name of a variation of the campaign used for A/B testing. + */ + TreatmentName?: __string; + } + export interface WriteEventStream { + /** + * The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. + Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME + Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME + */ + DestinationStreamArn?: __string; + /** + * The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account. + */ + RoleArn?: __string; + } + export interface WriteSegmentRequest { + /** + * The segment dimensions attributes. + */ + Dimensions?: SegmentDimensions; + /** + * The name of segment + */ + Name?: __string; + /** + * A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both. + */ + SegmentGroups?: SegmentGroupList; + /** + * The Tags for the segments. + */ + tags?: MapOf__string; + } + export interface WriteTreatmentResource { + /** + * The message configuration settings. + */ + MessageConfiguration?: MessageConfiguration; + /** + * The campaign schedule. + */ + Schedule?: Schedule; + /** + * The allocated percentage of users for this treatment. + */ + SizePercent?: __integer; + /** + * A custom description for the treatment. + */ + TreatmentDescription?: __string; + /** + * The custom name of a variation of the campaign used for A/B testing. + */ + TreatmentName?: __string; + } + export type __boolean = boolean; + export type __double = number; + export type __integer = number; + export type ListOfActivityResponse = ActivityResponse[]; + export type ListOfApplicationResponse = ApplicationResponse[]; + export type ListOfCampaignResponse = CampaignResponse[]; + export type ListOfEndpointBatchItem = EndpointBatchItem[]; + export type ListOfEndpointResponse = EndpointResponse[]; + export type ListOfExportJobResponse = ExportJobResponse[]; + export type ListOfImportJobResponse = ImportJobResponse[]; + export type ListOfSegmentDimensions = SegmentDimensions[]; + export type ListOfSegmentGroup = SegmentGroup[]; + export type ListOfSegmentReference = SegmentReference[]; + export type ListOfSegmentResponse = SegmentResponse[]; + export type ListOfTreatmentResource = TreatmentResource[]; + export type ListOfWriteTreatmentResource = WriteTreatmentResource[]; + export type ListOf__string = __string[]; + export type MapOfAddressConfiguration = {[key: string]: AddressConfiguration}; + export type MapOfAttributeDimension = {[key: string]: AttributeDimension}; + export type MapOfChannelResponse = {[key: string]: ChannelResponse}; + export type MapOfEndpointMessageResult = {[key: string]: EndpointMessageResult}; + export type MapOfEndpointSendConfiguration = {[key: string]: EndpointSendConfiguration}; + export type MapOfEvent = {[key: string]: Event}; + export type MapOfEventItemResponse = {[key: string]: EventItemResponse}; + export type MapOfEventsBatch = {[key: string]: EventsBatch}; + export type MapOfItemResponse = {[key: string]: ItemResponse}; + export type MapOfMessageResult = {[key: string]: MessageResult}; + export type MapOfMetricDimension = {[key: string]: MetricDimension}; + export type MapOf__double = {[key: string]: __double}; + export type MapOf__integer = {[key: string]: __integer}; + export type MapOfListOf__string = {[key: string]: ListOf__string}; + export type MapOfMapOfEndpointMessageResult = {[key: string]: MapOfEndpointMessageResult}; + export type MapOf__string = {[key: string]: __string}; + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-12-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Pinpoint client. + */ + export import Types = Pinpoint; +} +export = Pinpoint; diff --git a/node_modules/aws-sdk/clients/pinpoint.js b/node_modules/aws-sdk/clients/pinpoint.js new file mode 100644 index 0000000..2996368 --- /dev/null +++ b/node_modules/aws-sdk/clients/pinpoint.js @@ -0,0 +1,17 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['pinpoint'] = {}; +AWS.Pinpoint = Service.defineService('pinpoint', ['2016-12-01']); +Object.defineProperty(apiLoader.services['pinpoint'], '2016-12-01', { + get: function get() { + var model = require('../apis/pinpoint-2016-12-01.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Pinpoint; diff --git a/node_modules/aws-sdk/clients/pinpointemail.d.ts b/node_modules/aws-sdk/clients/pinpointemail.d.ts new file mode 100644 index 0000000..1d0f6d6 --- /dev/null +++ b/node_modules/aws-sdk/clients/pinpointemail.d.ts @@ -0,0 +1,1484 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class PinpointEmail extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: PinpointEmail.Types.ClientConfiguration) + config: Config & PinpointEmail.Types.ClientConfiguration; + /** + * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + createConfigurationSet(params: PinpointEmail.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateConfigurationSetResponse) => void): Request; + /** + * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + createConfigurationSet(callback?: (err: AWSError, data: PinpointEmail.Types.CreateConfigurationSetResponse) => void): Request; + /** + * Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination. + */ + createConfigurationSetEventDestination(params: PinpointEmail.Types.CreateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination. + */ + createConfigurationSetEventDestination(callback?: (err: AWSError, data: PinpointEmail.Types.CreateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool. + */ + createDedicatedIpPool(params: PinpointEmail.Types.CreateDedicatedIpPoolRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateDedicatedIpPoolResponse) => void): Request; + /** + * Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool. + */ + createDedicatedIpPool(callback?: (err: AWSError, data: PinpointEmail.Types.CreateDedicatedIpPoolResponse) => void): Request; + /** + * Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test. + */ + createDeliverabilityTestReport(params: PinpointEmail.Types.CreateDeliverabilityTestReportRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateDeliverabilityTestReportResponse) => void): Request; + /** + * Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test. + */ + createDeliverabilityTestReport(callback?: (err: AWSError, data: PinpointEmail.Types.CreateDeliverabilityTestReportResponse) => void): Request; + /** + * Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process. + */ + createEmailIdentity(params: PinpointEmail.Types.CreateEmailIdentityRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateEmailIdentityResponse) => void): Request; + /** + * Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process. + */ + createEmailIdentity(callback?: (err: AWSError, data: PinpointEmail.Types.CreateEmailIdentityResponse) => void): Request; + /** + * Delete an existing configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + deleteConfigurationSet(params: PinpointEmail.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteConfigurationSetResponse) => void): Request; + /** + * Delete an existing configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + deleteConfigurationSet(callback?: (err: AWSError, data: PinpointEmail.Types.DeleteConfigurationSetResponse) => void): Request; + /** + * Delete an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. + */ + deleteConfigurationSetEventDestination(params: PinpointEmail.Types.DeleteConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request; + /** + * Delete an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. + */ + deleteConfigurationSetEventDestination(callback?: (err: AWSError, data: PinpointEmail.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request; + /** + * Delete a dedicated IP pool. + */ + deleteDedicatedIpPool(params: PinpointEmail.Types.DeleteDedicatedIpPoolRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteDedicatedIpPoolResponse) => void): Request; + /** + * Delete a dedicated IP pool. + */ + deleteDedicatedIpPool(callback?: (err: AWSError, data: PinpointEmail.Types.DeleteDedicatedIpPoolResponse) => void): Request; + /** + * Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name. + */ + deleteEmailIdentity(params: PinpointEmail.Types.DeleteEmailIdentityRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteEmailIdentityResponse) => void): Request; + /** + * Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name. + */ + deleteEmailIdentity(callback?: (err: AWSError, data: PinpointEmail.Types.DeleteEmailIdentityResponse) => void): Request; + /** + * Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region. + */ + getAccount(params: PinpointEmail.Types.GetAccountRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetAccountResponse) => void): Request; + /** + * Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region. + */ + getAccount(callback?: (err: AWSError, data: PinpointEmail.Types.GetAccountResponse) => void): Request; + /** + * Retrieve a list of the blacklists that your dedicated IP addresses appear on. + */ + getBlacklistReports(params: PinpointEmail.Types.GetBlacklistReportsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetBlacklistReportsResponse) => void): Request; + /** + * Retrieve a list of the blacklists that your dedicated IP addresses appear on. + */ + getBlacklistReports(callback?: (err: AWSError, data: PinpointEmail.Types.GetBlacklistReportsResponse) => void): Request; + /** + * Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + getConfigurationSet(params: PinpointEmail.Types.GetConfigurationSetRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetResponse) => void): Request; + /** + * Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + getConfigurationSet(callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetResponse) => void): Request; + /** + * Retrieve a list of event destinations that are associated with a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. + */ + getConfigurationSetEventDestinations(params: PinpointEmail.Types.GetConfigurationSetEventDestinationsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetEventDestinationsResponse) => void): Request; + /** + * Retrieve a list of event destinations that are associated with a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. + */ + getConfigurationSetEventDestinations(callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetEventDestinationsResponse) => void): Request; + /** + * Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address. + */ + getDedicatedIp(params: PinpointEmail.Types.GetDedicatedIpRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpResponse) => void): Request; + /** + * Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address. + */ + getDedicatedIp(callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpResponse) => void): Request; + /** + * List the dedicated IP addresses that are associated with your Amazon Pinpoint account. + */ + getDedicatedIps(params: PinpointEmail.Types.GetDedicatedIpsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpsResponse) => void): Request; + /** + * List the dedicated IP addresses that are associated with your Amazon Pinpoint account. + */ + getDedicatedIps(callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpsResponse) => void): Request; + /** + * Show the status of the Deliverability dashboard. When the Deliverability dashboard is enabled, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, AWS prorates the monthly charge based on how many days have elapsed in the current calendar month. + */ + getDeliverabilityDashboardOptions(params: PinpointEmail.Types.GetDeliverabilityDashboardOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityDashboardOptionsResponse) => void): Request; + /** + * Show the status of the Deliverability dashboard. When the Deliverability dashboard is enabled, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, AWS prorates the monthly charge based on how many days have elapsed in the current calendar month. + */ + getDeliverabilityDashboardOptions(callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityDashboardOptionsResponse) => void): Request; + /** + * Retrieve the results of a predictive inbox placement test. + */ + getDeliverabilityTestReport(params: PinpointEmail.Types.GetDeliverabilityTestReportRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityTestReportResponse) => void): Request; + /** + * Retrieve the results of a predictive inbox placement test. + */ + getDeliverabilityTestReport(callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityTestReportResponse) => void): Request; + /** + * Retrieve inbox placement and engagement rates for the domains that you use to send email. + */ + getDomainStatisticsReport(params: PinpointEmail.Types.GetDomainStatisticsReportRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDomainStatisticsReportResponse) => void): Request; + /** + * Retrieve inbox placement and engagement rates for the domains that you use to send email. + */ + getDomainStatisticsReport(callback?: (err: AWSError, data: PinpointEmail.Types.GetDomainStatisticsReportResponse) => void): Request; + /** + * Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings. + */ + getEmailIdentity(params: PinpointEmail.Types.GetEmailIdentityRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetEmailIdentityResponse) => void): Request; + /** + * Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings. + */ + getEmailIdentity(callback?: (err: AWSError, data: PinpointEmail.Types.GetEmailIdentityResponse) => void): Request; + /** + * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + listConfigurationSets(params: PinpointEmail.Types.ListConfigurationSetsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListConfigurationSetsResponse) => void): Request; + /** + * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. + */ + listConfigurationSets(callback?: (err: AWSError, data: PinpointEmail.Types.ListConfigurationSetsResponse) => void): Request; + /** + * List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region. + */ + listDedicatedIpPools(params: PinpointEmail.Types.ListDedicatedIpPoolsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListDedicatedIpPoolsResponse) => void): Request; + /** + * List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region. + */ + listDedicatedIpPools(callback?: (err: AWSError, data: PinpointEmail.Types.ListDedicatedIpPoolsResponse) => void): Request; + /** + * Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results. + */ + listDeliverabilityTestReports(params: PinpointEmail.Types.ListDeliverabilityTestReportsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListDeliverabilityTestReportsResponse) => void): Request; + /** + * Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results. + */ + listDeliverabilityTestReports(callback?: (err: AWSError, data: PinpointEmail.Types.ListDeliverabilityTestReportsResponse) => void): Request; + /** + * Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. + */ + listEmailIdentities(params: PinpointEmail.Types.ListEmailIdentitiesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListEmailIdentitiesResponse) => void): Request; + /** + * Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. + */ + listEmailIdentities(callback?: (err: AWSError, data: PinpointEmail.Types.ListEmailIdentitiesResponse) => void): Request; + /** + * Retrieve a list of the tags (keys and values) that are associated with a specific resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. + */ + listTagsForResource(params: PinpointEmail.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListTagsForResourceResponse) => void): Request; + /** + * Retrieve a list of the tags (keys and values) that are associated with a specific resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. + */ + listTagsForResource(callback?: (err: AWSError, data: PinpointEmail.Types.ListTagsForResourceResponse) => void): Request; + /** + * Enable or disable the automatic warm-up feature for dedicated IP addresses. + */ + putAccountDedicatedIpWarmupAttributes(params: PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesResponse) => void): Request; + /** + * Enable or disable the automatic warm-up feature for dedicated IP addresses. + */ + putAccountDedicatedIpWarmupAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesResponse) => void): Request; + /** + * Enable or disable the ability of your account to send email. + */ + putAccountSendingAttributes(params: PinpointEmail.Types.PutAccountSendingAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountSendingAttributesResponse) => void): Request; + /** + * Enable or disable the ability of your account to send email. + */ + putAccountSendingAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountSendingAttributesResponse) => void): Request; + /** + * Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email. + */ + putConfigurationSetDeliveryOptions(params: PinpointEmail.Types.PutConfigurationSetDeliveryOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request; + /** + * Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email. + */ + putConfigurationSetDeliveryOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request; + /** + * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region. + */ + putConfigurationSetReputationOptions(params: PinpointEmail.Types.PutConfigurationSetReputationOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetReputationOptionsResponse) => void): Request; + /** + * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region. + */ + putConfigurationSetReputationOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetReputationOptionsResponse) => void): Request; + /** + * Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region. + */ + putConfigurationSetSendingOptions(params: PinpointEmail.Types.PutConfigurationSetSendingOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetSendingOptionsResponse) => void): Request; + /** + * Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region. + */ + putConfigurationSetSendingOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetSendingOptionsResponse) => void): Request; + /** + * Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint. + */ + putConfigurationSetTrackingOptions(params: PinpointEmail.Types.PutConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint. + */ + putConfigurationSetTrackingOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation. + */ + putDedicatedIpInPool(params: PinpointEmail.Types.PutDedicatedIpInPoolRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpInPoolResponse) => void): Request; + /** + * Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation. + */ + putDedicatedIpInPool(callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpInPoolResponse) => void): Request; + /** + * + */ + putDedicatedIpWarmupAttributes(params: PinpointEmail.Types.PutDedicatedIpWarmupAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpWarmupAttributesResponse) => void): Request; + /** + * + */ + putDedicatedIpWarmupAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpWarmupAttributesResponse) => void): Request; + /** + * Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, we prorate the monthly charge based on how many days have elapsed in the current calendar month. + */ + putDeliverabilityDashboardOption(params: PinpointEmail.Types.PutDeliverabilityDashboardOptionRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutDeliverabilityDashboardOptionResponse) => void): Request; + /** + * Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, we prorate the monthly charge based on how many days have elapsed in the current calendar month. + */ + putDeliverabilityDashboardOption(callback?: (err: AWSError, data: PinpointEmail.Types.PutDeliverabilityDashboardOptionResponse) => void): Request; + /** + * Used to enable or disable DKIM authentication for an email identity. + */ + putEmailIdentityDkimAttributes(params: PinpointEmail.Types.PutEmailIdentityDkimAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityDkimAttributesResponse) => void): Request; + /** + * Used to enable or disable DKIM authentication for an email identity. + */ + putEmailIdentityDkimAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityDkimAttributesResponse) => void): Request; + /** + * Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled). + */ + putEmailIdentityFeedbackAttributes(params: PinpointEmail.Types.PutEmailIdentityFeedbackAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityFeedbackAttributesResponse) => void): Request; + /** + * Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled). + */ + putEmailIdentityFeedbackAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityFeedbackAttributesResponse) => void): Request; + /** + * Used to enable or disable the custom Mail-From domain configuration for an email identity. + */ + putEmailIdentityMailFromAttributes(params: PinpointEmail.Types.PutEmailIdentityMailFromAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityMailFromAttributesResponse) => void): Request; + /** + * Used to enable or disable the custom Mail-From domain configuration for an email identity. + */ + putEmailIdentityMailFromAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityMailFromAttributesResponse) => void): Request; + /** + * Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you. Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message. + */ + sendEmail(params: PinpointEmail.Types.SendEmailRequest, callback?: (err: AWSError, data: PinpointEmail.Types.SendEmailResponse) => void): Request; + /** + * Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you. Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message. + */ + sendEmail(callback?: (err: AWSError, data: PinpointEmail.Types.SendEmailResponse) => void): Request; + /** + * Add one or more tags (keys and values) to one or more specified resources. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. + */ + tagResource(params: PinpointEmail.Types.TagResourceRequest, callback?: (err: AWSError, data: PinpointEmail.Types.TagResourceResponse) => void): Request; + /** + * Add one or more tags (keys and values) to one or more specified resources. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. + */ + tagResource(callback?: (err: AWSError, data: PinpointEmail.Types.TagResourceResponse) => void): Request; + /** + * Remove one or more tags (keys and values) from a specified resource. + */ + untagResource(params: PinpointEmail.Types.UntagResourceRequest, callback?: (err: AWSError, data: PinpointEmail.Types.UntagResourceResponse) => void): Request; + /** + * Remove one or more tags (keys and values) from a specified resource. + */ + untagResource(callback?: (err: AWSError, data: PinpointEmail.Types.UntagResourceResponse) => void): Request; + /** + * Update the configuration of an event destination for a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. + */ + updateConfigurationSetEventDestination(params: PinpointEmail.Types.UpdateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointEmail.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Update the configuration of an event destination for a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. + */ + updateConfigurationSetEventDestination(callback?: (err: AWSError, data: PinpointEmail.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request; +} +declare namespace PinpointEmail { + export type AmazonResourceName = string; + export type BehaviorOnMxFailure = "USE_DEFAULT_VALUE"|"REJECT_MESSAGE"|string; + export type BlacklistEntries = BlacklistEntry[]; + export interface BlacklistEntry { + /** + * The name of the blacklist that the IP address appears on. + */ + RblName?: RblName; + /** + * The time when the blacklisting event occurred, shown in Unix time format. + */ + ListingTime?: Timestamp; + /** + * Additional information about the blacklisting event, as provided by the blacklist maintainer. + */ + Description?: BlacklistingDescription; + } + export type BlacklistItemName = string; + export type BlacklistItemNames = BlacklistItemName[]; + export type BlacklistReport = {[key: string]: BlacklistEntries}; + export type BlacklistingDescription = string; + export interface Body { + /** + * An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering. + */ + Text?: Content; + /** + * An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more. + */ + Html?: Content; + } + export type Charset = string; + export interface CloudWatchDestination { + /** + * An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch. + */ + DimensionConfigurations: CloudWatchDimensionConfigurations; + } + export interface CloudWatchDimensionConfiguration { + /** + * The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). It can contain no more than 256 characters. + */ + DimensionName: DimensionName; + /** + * The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags. + */ + DimensionValueSource: DimensionValueSource; + /** + * The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). It can contain no more than 256 characters. + */ + DefaultDimensionValue: DefaultDimensionValue; + } + export type CloudWatchDimensionConfigurations = CloudWatchDimensionConfiguration[]; + export type ConfigurationSetName = string; + export type ConfigurationSetNameList = ConfigurationSetName[]; + export interface Content { + /** + * The content of the message itself. + */ + Data: MessageData; + /** + * The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS. + */ + Charset?: Charset; + } + export interface CreateConfigurationSetEventDestinationRequest { + /** + * The name of the configuration set that you want to add an event destination to. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * A name that identifies the event destination within the configuration set. + */ + EventDestinationName: EventDestinationName; + /** + * An object that defines the event destination. + */ + EventDestination: EventDestinationDefinition; + } + export interface CreateConfigurationSetEventDestinationResponse { + } + export interface CreateConfigurationSetRequest { + /** + * The name of the configuration set. + */ + ConfigurationSetName?: ConfigurationSetName; + /** + * An object that defines the open and click tracking options for emails that you send using the configuration set. + */ + TrackingOptions?: TrackingOptions; + /** + * An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. + */ + DeliveryOptions?: DeliveryOptions; + /** + * An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set. + */ + ReputationOptions?: ReputationOptions; + /** + * An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set. + */ + SendingOptions?: SendingOptions; + /** + * An object that defines the tags (keys and values) that you want to associate with the configuration set. + */ + Tags?: TagList; + } + export interface CreateConfigurationSetResponse { + } + export interface CreateDedicatedIpPoolRequest { + /** + * The name of the dedicated IP pool. + */ + PoolName: PoolName; + /** + * An object that defines the tags (keys and values) that you want to associate with the pool. + */ + Tags?: TagList; + } + export interface CreateDedicatedIpPoolResponse { + } + export interface CreateDeliverabilityTestReportRequest { + /** + * A unique name that helps you to identify the predictive inbox placement test when you retrieve the results. + */ + ReportName?: ReportName; + /** + * The email address that the predictive inbox placement test email was sent from. + */ + FromEmailAddress: EmailAddress; + /** + * The HTML body of the message that you sent when you performed the predictive inbox placement test. + */ + Content: EmailContent; + /** + * An object that defines the tags (keys and values) that you want to associate with the predictive inbox placement test. + */ + Tags?: TagList; + } + export interface CreateDeliverabilityTestReportResponse { + /** + * A unique string that identifies the predictive inbox placement test. + */ + ReportId: ReportId; + /** + * The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test. + */ + DeliverabilityTestStatus: DeliverabilityTestStatus; + } + export interface CreateEmailIdentityRequest { + /** + * The email address or domain that you want to verify. + */ + EmailIdentity: Identity; + /** + * An object that defines the tags (keys and values) that you want to associate with the email identity. + */ + Tags?: TagList; + } + export interface CreateEmailIdentityResponse { + /** + * The email identity type. + */ + IdentityType?: IdentityType; + /** + * Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide. + */ + VerifiedForSendingStatus?: Enabled; + /** + * An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process. + */ + DkimAttributes?: DkimAttributes; + } + export type CustomRedirectDomain = string; + export interface DailyVolume { + /** + * The date that the DailyVolume metrics apply to, in Unix time. + */ + StartDate?: Timestamp; + /** + * An object that contains inbox placement metrics for a specific day in the analysis period. + */ + VolumeStatistics?: VolumeStatistics; + /** + * An object that contains inbox placement metrics for a specifid day in the analysis period, broken out by the recipient's email provider. + */ + DomainIspPlacements?: DomainIspPlacements; + } + export type DailyVolumes = DailyVolume[]; + export interface DedicatedIp { + /** + * An IP address that is reserved for use by your Amazon Pinpoint account. + */ + Ip: Ip; + /** + * The warm-up status of a dedicated IP address. The status can have one of the following values: IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing. DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use. + */ + WarmupStatus: WarmupStatus; + /** + * Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use. + */ + WarmupPercentage: Percentage100Wrapper; + /** + * The name of the dedicated IP pool that the IP address is associated with. + */ + PoolName?: PoolName; + } + export type DedicatedIpList = DedicatedIp[]; + export type DefaultDimensionValue = string; + export interface DeleteConfigurationSetEventDestinationRequest { + /** + * The name of the configuration set that contains the event destination that you want to delete. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * The name of the event destination that you want to delete. + */ + EventDestinationName: EventDestinationName; + } + export interface DeleteConfigurationSetEventDestinationResponse { + } + export interface DeleteConfigurationSetRequest { + /** + * The name of the configuration set that you want to delete. + */ + ConfigurationSetName: ConfigurationSetName; + } + export interface DeleteConfigurationSetResponse { + } + export interface DeleteDedicatedIpPoolRequest { + /** + * The name of the dedicated IP pool that you want to delete. + */ + PoolName: PoolName; + } + export interface DeleteDedicatedIpPoolResponse { + } + export interface DeleteEmailIdentityRequest { + /** + * The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account. + */ + EmailIdentity: Identity; + } + export interface DeleteEmailIdentityResponse { + } + export interface DeliverabilityTestReport { + /** + * A unique string that identifies the predictive inbox placement test. + */ + ReportId?: ReportId; + /** + * A name that helps you identify a predictive inbox placement test report. + */ + ReportName?: ReportName; + /** + * The subject line for an email that you submitted in a predictive inbox placement test. + */ + Subject?: DeliverabilityTestSubject; + /** + * The sender address that you specified for the predictive inbox placement test. + */ + FromEmailAddress?: EmailAddress; + /** + * The date and time when the predictive inbox placement test was created, in Unix time format. + */ + CreateDate?: Timestamp; + /** + * The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test. + */ + DeliverabilityTestStatus?: DeliverabilityTestStatus; + } + export type DeliverabilityTestReports = DeliverabilityTestReport[]; + export type DeliverabilityTestStatus = "IN_PROGRESS"|"COMPLETED"|string; + export type DeliverabilityTestSubject = string; + export interface DeliveryOptions { + /** + * The name of the dedicated IP pool that you want to associate with the configuration set. + */ + SendingPoolName?: PoolName; + } + export interface Destination { + /** + * An array that contains the email addresses of the "To" recipients for the email. + */ + ToAddresses?: EmailAddressList; + /** + * An array that contains the email addresses of the "CC" (carbon copy) recipients for the email. + */ + CcAddresses?: EmailAddressList; + /** + * An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email. + */ + BccAddresses?: EmailAddressList; + } + export type DimensionName = string; + export type DimensionValueSource = "MESSAGE_TAG"|"EMAIL_HEADER"|"LINK_TAG"|string; + export interface DkimAttributes { + /** + * If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed. + */ + SigningEnabled?: Enabled; + /** + * Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following: PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them. SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity. FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them. TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain. NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain. + */ + Status?: DkimStatus; + /** + * A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain. + */ + Tokens?: DnsTokenList; + } + export type DkimStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|"NOT_STARTED"|string; + export type DnsToken = string; + export type DnsTokenList = DnsToken[]; + export interface DomainIspPlacement { + /** + * The name of the email provider that the inbox placement data applies to. + */ + IspName?: IspName; + /** + * The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes. + */ + InboxRawCount?: Volume; + /** + * The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders. + */ + SpamRawCount?: Volume; + /** + * The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes. + */ + InboxPercentage?: Percentage; + /** + * The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders. + */ + SpamPercentage?: Percentage; + } + export type DomainIspPlacements = DomainIspPlacement[]; + export type EmailAddress = string; + export type EmailAddressList = EmailAddress[]; + export interface EmailContent { + /** + * The simple email message. The message consists of a subject and a message body. + */ + Simple?: Message; + /** + * The raw email message. The message has to meet the following criteria: The message has to contain a header and a body, separated by one blank line. All of the required header fields must be present in the message. Each part of a multipart MIME message must be formatted properly. If you include attachments, they must be in a file format that Amazon Pinpoint supports. The entire message must be Base64 encoded. If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly. The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321. + */ + Raw?: RawMessage; + } + export type Enabled = boolean; + export interface EventDestination { + /** + * A name that identifies the event destination. + */ + Name: EventDestinationName; + /** + * If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition. If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations. + */ + Enabled?: Enabled; + /** + * The types of events that Amazon Pinpoint sends to the specified event destinations. + */ + MatchingEventTypes: EventTypes; + /** + * An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. + */ + KinesisFirehoseDestination?: KinesisFirehoseDestination; + /** + * An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. + */ + CloudWatchDestination?: CloudWatchDestination; + /** + * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. + */ + SnsDestination?: SnsDestination; + /** + * An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns. + */ + PinpointDestination?: PinpointDestination; + } + export interface EventDestinationDefinition { + /** + * If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition. If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations. + */ + Enabled?: Enabled; + /** + * An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition. + */ + MatchingEventTypes?: EventTypes; + /** + * An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. + */ + KinesisFirehoseDestination?: KinesisFirehoseDestination; + /** + * An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. + */ + CloudWatchDestination?: CloudWatchDestination; + /** + * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. + */ + SnsDestination?: SnsDestination; + /** + * An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns. + */ + PinpointDestination?: PinpointDestination; + } + export type EventDestinationName = string; + export type EventDestinations = EventDestination[]; + export type EventType = "SEND"|"REJECT"|"BOUNCE"|"COMPLAINT"|"DELIVERY"|"OPEN"|"CLICK"|"RENDERING_FAILURE"|string; + export type EventTypes = EventType[]; + export type GeneralEnforcementStatus = string; + export interface GetAccountRequest { + } + export interface GetAccountResponse { + /** + * An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region. + */ + SendQuota?: SendQuota; + /** + * Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region. + */ + SendingEnabled?: Enabled; + /** + * Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account. + */ + DedicatedIpAutoWarmupEnabled?: Enabled; + /** + * The reputation status of your Amazon Pinpoint account. The status can be one of the following: HEALTHY – There are no reputation-related issues that currently impact your account. PROBATION – We've identified some issues with your Amazon Pinpoint account. We're placing your account under review while you work on correcting these issues. SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed. + */ + EnforcementStatus?: GeneralEnforcementStatus; + /** + * Indicates whether or not your account has production access in the current AWS Region. If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1. If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case. + */ + ProductionAccessEnabled?: Enabled; + } + export interface GetBlacklistReportsRequest { + /** + * A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES. + */ + BlacklistItemNames: BlacklistItemNames; + } + export interface GetBlacklistReportsResponse { + /** + * An object that contains information about a blacklist that one of your dedicated IP addresses appears on. + */ + BlacklistReport: BlacklistReport; + } + export interface GetConfigurationSetEventDestinationsRequest { + /** + * The name of the configuration set that contains the event destination. + */ + ConfigurationSetName: ConfigurationSetName; + } + export interface GetConfigurationSetEventDestinationsResponse { + /** + * An array that includes all of the events destinations that have been configured for the configuration set. + */ + EventDestinations?: EventDestinations; + } + export interface GetConfigurationSetRequest { + /** + * The name of the configuration set that you want to obtain more information about. + */ + ConfigurationSetName: ConfigurationSetName; + } + export interface GetConfigurationSetResponse { + /** + * The name of the configuration set. + */ + ConfigurationSetName?: ConfigurationSetName; + /** + * An object that defines the open and click tracking options for emails that you send using the configuration set. + */ + TrackingOptions?: TrackingOptions; + /** + * An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. + */ + DeliveryOptions?: DeliveryOptions; + /** + * An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set. + */ + ReputationOptions?: ReputationOptions; + /** + * An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set. + */ + SendingOptions?: SendingOptions; + } + export interface GetDedicatedIpRequest { + /** + * The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account. + */ + Ip: Ip; + } + export interface GetDedicatedIpResponse { + /** + * An object that contains information about a dedicated IP address. + */ + DedicatedIp?: DedicatedIp; + } + export interface GetDedicatedIpsRequest { + /** + * The name of the IP pool that the dedicated IP address is associated with. + */ + PoolName?: PoolName; + /** + * A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools. + */ + NextToken?: NextToken; + /** + * The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. + */ + PageSize?: MaxItems; + } + export interface GetDedicatedIpsResponse { + /** + * A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account. + */ + DedicatedIps?: DedicatedIpList; + /** + * A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter. + */ + NextToken?: NextToken; + } + export interface GetDeliverabilityDashboardOptionsRequest { + } + export interface GetDeliverabilityDashboardOptionsResponse { + /** + * Indicates whether the Deliverability dashboard is enabled. If the value is true, then the dashboard is enabled. + */ + DashboardEnabled: Enabled; + } + export interface GetDeliverabilityTestReportRequest { + /** + * A unique string that identifies the predictive inbox placement test. + */ + ReportId: ReportId; + } + export interface GetDeliverabilityTestReportResponse { + /** + * An object that contains the results of the predictive inbox placement test. + */ + DeliverabilityTestReport: DeliverabilityTestReport; + /** + * An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered. + */ + OverallPlacement: PlacementStatistics; + /** + * An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others. + */ + IspPlacements: IspPlacements; + /** + * An object that contains the message that you sent when you performed this predictive inbox placement test. + */ + Message?: MessageContent; + } + export interface GetDomainStatisticsReportRequest { + /** + * The domain that you want to obtain deliverability metrics for. + */ + Domain: Identity; + /** + * The first day (in Unix time) that you want to obtain domain deliverability metrics for. + */ + StartDate: Timestamp; + /** + * The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate. + */ + EndDate: Timestamp; + } + export interface GetDomainStatisticsReportResponse { + /** + * An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate. + */ + OverallVolume: OverallVolume; + /** + * An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate. + */ + DailyVolumes: DailyVolumes; + } + export interface GetEmailIdentityRequest { + /** + * The email identity that you want to retrieve details for. + */ + EmailIdentity: Identity; + } + export interface GetEmailIdentityResponse { + /** + * The email identity type. + */ + IdentityType?: IdentityType; + /** + * The feedback forwarding configuration for the identity. If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled). + */ + FeedbackForwardingStatus?: Enabled; + /** + * Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide. + */ + VerifiedForSendingStatus?: Enabled; + /** + * An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process. + */ + DkimAttributes?: DkimAttributes; + /** + * An object that contains information about the Mail-From attributes for the email identity. + */ + MailFromAttributes?: MailFromAttributes; + } + export type Identity = string; + export interface IdentityInfo { + /** + * The email identity type. The identity type can be one of the following: EMAIL_ADDRESS – The identity is an email address. DOMAIN – The identity is a domain. MANAGED_DOMAIN – The identity is a domain that is managed by AWS. + */ + IdentityType?: IdentityType; + /** + * The address or domain of the identity. + */ + IdentityName?: Identity; + /** + * Indicates whether or not you can send email from the identity. In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity. + */ + SendingEnabled?: Enabled; + } + export type IdentityInfoList = IdentityInfo[]; + export type IdentityType = "EMAIL_ADDRESS"|"DOMAIN"|"MANAGED_DOMAIN"|string; + export type Ip = string; + export type IspName = string; + export interface IspPlacement { + /** + * The name of the email provider that the inbox placement data applies to. + */ + IspName?: IspName; + /** + * An object that contains inbox placement metrics for a specific email provider. + */ + PlacementStatistics?: PlacementStatistics; + } + export type IspPlacements = IspPlacement[]; + export interface KinesisFirehoseDestination { + /** + * The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream. + */ + IamRoleArn: AmazonResourceName; + /** + * The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to. + */ + DeliveryStreamArn: AmazonResourceName; + } + export type LastFreshStart = Date; + export interface ListConfigurationSetsRequest { + /** + * A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets. + */ + NextToken?: NextToken; + /** + * The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. + */ + PageSize?: MaxItems; + } + export interface ListConfigurationSetsResponse { + /** + * An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region. + */ + ConfigurationSets?: ConfigurationSetNameList; + /** + * A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter. + */ + NextToken?: NextToken; + } + export interface ListDedicatedIpPoolsRequest { + /** + * A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools. + */ + NextToken?: NextToken; + /** + * The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. + */ + PageSize?: MaxItems; + } + export interface ListDedicatedIpPoolsResponse { + /** + * A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account. + */ + DedicatedIpPools?: ListOfDedicatedIpPools; + /** + * A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter. + */ + NextToken?: NextToken; + } + export interface ListDeliverabilityTestReportsRequest { + /** + * A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests. + */ + NextToken?: NextToken; + /** + * The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 0, and can be no more than 1000. + */ + PageSize?: MaxItems; + } + export interface ListDeliverabilityTestReportsResponse { + /** + * An object that contains a lists of predictive inbox placement tests that you've performed. + */ + DeliverabilityTestReports: DeliverabilityTestReports; + /** + * A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter. + */ + NextToken?: NextToken; + } + export interface ListEmailIdentitiesRequest { + /** + * A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities. + */ + NextToken?: NextToken; + /** + * The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 0, and can be no more than 1000. + */ + PageSize?: MaxItems; + } + export interface ListEmailIdentitiesResponse { + /** + * An array that includes all of the identities associated with your Amazon Pinpoint account. + */ + EmailIdentities?: IdentityInfoList; + /** + * A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter. + */ + NextToken?: NextToken; + } + export type ListOfDedicatedIpPools = PoolName[]; + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for. + */ + ResourceArn: AmazonResourceName; + } + export interface ListTagsForResourceResponse { + /** + * An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value) + */ + Tags: TagList; + } + export interface MailFromAttributes { + /** + * The name of a domain that an email identity uses as a custom MAIL FROM domain. + */ + MailFromDomain: MailFromDomainName; + /** + * The status of the MAIL FROM domain. This status can have the following values: PENDING – Amazon Pinpoint hasn't started searching for the MX record yet. SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain. FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists. TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain. + */ + MailFromDomainStatus: MailFromDomainStatus; + /** + * The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email. These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states. + */ + BehaviorOnMxFailure: BehaviorOnMxFailure; + } + export type MailFromDomainName = string; + export type MailFromDomainStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|string; + export type Max24HourSend = number; + export type MaxItems = number; + export type MaxSendRate = number; + export interface Message { + /** + * The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047. + */ + Subject: Content; + /** + * The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both. + */ + Body: Body; + } + export type MessageContent = string; + export type MessageData = string; + export interface MessageTag { + /** + * The name of the message tag. The message tag name has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters. + */ + Name: MessageTagName; + /** + * The value of the message tag. The message tag value has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters. + */ + Value: MessageTagValue; + } + export type MessageTagList = MessageTag[]; + export type MessageTagName = string; + export type MessageTagValue = string; + export type NextToken = string; + export type OutboundMessageId = string; + export interface OverallVolume { + /** + * An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders. + */ + VolumeStatistics?: VolumeStatistics; + /** + * The percentage of emails that were sent from the domain that were read by their recipients. + */ + ReadRatePercent?: Percentage; + /** + * An object that contains inbox and junk mail placement metrics for individual email providers. + */ + DomainIspPlacements?: DomainIspPlacements; + } + export type Percentage = number; + export type Percentage100Wrapper = number; + export interface PinpointDestination { + /** + * The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to. + */ + ApplicationArn?: AmazonResourceName; + } + export interface PlacementStatistics { + /** + * The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test. + */ + InboxPercentage?: Percentage; + /** + * The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test. + */ + SpamPercentage?: Percentage; + /** + * The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test. + */ + MissingPercentage?: Percentage; + /** + * The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test. + */ + SpfPercentage?: Percentage; + /** + * The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test. + */ + DkimPercentage?: Percentage; + } + export type PoolName = string; + export interface PutAccountDedicatedIpWarmupAttributesRequest { + /** + * Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it. + */ + AutoWarmupEnabled?: Enabled; + } + export interface PutAccountDedicatedIpWarmupAttributesResponse { + } + export interface PutAccountSendingAttributesRequest { + /** + * Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending. If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email. + */ + SendingEnabled?: Enabled; + } + export interface PutAccountSendingAttributesResponse { + } + export interface PutConfigurationSetDeliveryOptionsRequest { + /** + * The name of the configuration set that you want to associate with a dedicated IP pool. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * The name of the dedicated IP pool that you want to associate with the configuration set. + */ + SendingPoolName?: SendingPoolName; + } + export interface PutConfigurationSetDeliveryOptionsResponse { + } + export interface PutConfigurationSetReputationOptionsRequest { + /** + * The name of the configuration set that you want to enable or disable reputation metric tracking for. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set. + */ + ReputationMetricsEnabled?: Enabled; + } + export interface PutConfigurationSetReputationOptionsResponse { + } + export interface PutConfigurationSetSendingOptionsRequest { + /** + * The name of the configuration set that you want to enable or disable email sending for. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set. + */ + SendingEnabled?: Enabled; + } + export interface PutConfigurationSetSendingOptionsResponse { + } + export interface PutConfigurationSetTrackingOptionsRequest { + /** + * The name of the configuration set that you want to add a custom tracking domain to. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * The domain that you want to use to track open and click events. + */ + CustomRedirectDomain?: CustomRedirectDomain; + } + export interface PutConfigurationSetTrackingOptionsResponse { + } + export interface PutDedicatedIpInPoolRequest { + /** + * The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Pinpoint account. + */ + Ip: Ip; + /** + * The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists. + */ + DestinationPoolName: PoolName; + } + export interface PutDedicatedIpInPoolResponse { + } + export interface PutDedicatedIpWarmupAttributesRequest { + /** + * The dedicated IP address that you want to update the warm-up attributes for. + */ + Ip: Ip; + /** + * The warm-up percentage that you want to associate with the dedicated IP address. + */ + WarmupPercentage: Percentage100Wrapper; + } + export interface PutDedicatedIpWarmupAttributesResponse { + } + export interface PutDeliverabilityDashboardOptionRequest { + /** + * Indicates whether the Deliverability dashboard is enabled. If the value is true, then the dashboard is enabled. + */ + DashboardEnabled: Enabled; + } + export interface PutDeliverabilityDashboardOptionResponse { + } + export interface PutEmailIdentityDkimAttributesRequest { + /** + * The email identity that you want to change the DKIM settings for. + */ + EmailIdentity: Identity; + /** + * Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed. + */ + SigningEnabled?: Enabled; + } + export interface PutEmailIdentityDkimAttributesResponse { + } + export interface PutEmailIdentityFeedbackAttributesRequest { + /** + * The email identity that you want to configure bounce and complaint feedback forwarding for. + */ + EmailIdentity: Identity; + /** + * Sets the feedback forwarding configuration for the identity. If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled). + */ + EmailForwardingEnabled?: Enabled; + } + export interface PutEmailIdentityFeedbackAttributesResponse { + } + export interface PutEmailIdentityMailFromAttributesRequest { + /** + * The verified email identity that you want to set up the custom MAIL FROM domain for. + */ + EmailIdentity: Identity; + /** + * The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria: It has to be a subdomain of the verified identity. It can't be used to receive email. It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails. + */ + MailFromDomain?: MailFromDomainName; + /** + * The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email. These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states. + */ + BehaviorOnMxFailure?: BehaviorOnMxFailure; + } + export interface PutEmailIdentityMailFromAttributesResponse { + } + export interface RawMessage { + /** + * The raw email message. The message has to meet the following criteria: The message has to contain a header and a body, separated by one blank line. All of the required header fields must be present in the message. Each part of a multipart MIME message must be formatted properly. Attachments must be in a file format that Amazon Pinpoint supports. The entire message must be Base64 encoded. If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly. The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321. + */ + Data: RawMessageData; + } + export type RawMessageData = Buffer|Uint8Array|Blob|string; + export type RblName = string; + export type ReportId = string; + export type ReportName = string; + export interface ReputationOptions { + /** + * If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set. + */ + ReputationMetricsEnabled?: Enabled; + /** + * The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start. + */ + LastFreshStart?: LastFreshStart; + } + export interface SendEmailRequest { + /** + * The email address that you want to use as the "From" address for the email. The address that you specify has to be verified. + */ + FromEmailAddress?: EmailAddress; + /** + * An object that contains the recipients of the email message. + */ + Destination: Destination; + /** + * The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply. + */ + ReplyToAddresses?: EmailAddressList; + /** + * The address that Amazon Pinpoint should send bounce and complaint notifications to. + */ + FeedbackForwardingEmailAddress?: EmailAddress; + /** + * An object that contains the body of the message. You can send either a Simple message or a Raw message. + */ + Content: EmailContent; + /** + * A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. + */ + EmailTags?: MessageTagList; + /** + * The name of the configuration set that you want to use when sending the email. + */ + ConfigurationSetName?: ConfigurationSetName; + } + export interface SendEmailResponse { + /** + * A unique identifier for the message that is generated when Amazon Pinpoint accepts the message. It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example. + */ + MessageId?: OutboundMessageId; + } + export interface SendQuota { + /** + * The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota. + */ + Max24HourSend?: Max24HourSend; + /** + * The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate. + */ + MaxSendRate?: MaxSendRate; + /** + * The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours. + */ + SentLast24Hours?: SentLast24Hours; + } + export interface SendingOptions { + /** + * If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set. + */ + SendingEnabled?: Enabled; + } + export type SendingPoolName = string; + export type SentLast24Hours = number; + export interface SnsDestination { + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicArn: AmazonResourceName; + } + export interface Tag { + /** + * One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. + */ + Key: TagKey; + /** + * The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to. + */ + ResourceArn: AmazonResourceName; + /** + * A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type Timestamp = Date; + export interface TrackingOptions { + /** + * The domain that you want to use for tracking open and click events. + */ + CustomRedirectDomain: CustomRedirectDomain; + } + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from. + */ + ResourceArn: AmazonResourceName; + /** + * The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value. To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2 + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateConfigurationSetEventDestinationRequest { + /** + * The name of the configuration set that contains the event destination that you want to modify. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * The name of the event destination that you want to modify. + */ + EventDestinationName: EventDestinationName; + /** + * An object that defines the event destination. + */ + EventDestination: EventDestinationDefinition; + } + export interface UpdateConfigurationSetEventDestinationResponse { + } + export type Volume = number; + export interface VolumeStatistics { + /** + * The total number of emails that arrived in recipients' inboxes. + */ + InboxRawCount?: Volume; + /** + * The total number of emails that arrived in recipients' spam or junk mail folders. + */ + SpamRawCount?: Volume; + /** + * An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes. + */ + ProjectedInbox?: Volume; + /** + * An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders. + */ + ProjectedSpam?: Volume; + } + export type WarmupStatus = "IN_PROGRESS"|"DONE"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-07-26"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the PinpointEmail client. + */ + export import Types = PinpointEmail; +} +export = PinpointEmail; diff --git a/node_modules/aws-sdk/clients/pinpointemail.js b/node_modules/aws-sdk/clients/pinpointemail.js new file mode 100644 index 0000000..be45dc3 --- /dev/null +++ b/node_modules/aws-sdk/clients/pinpointemail.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['pinpointemail'] = {}; +AWS.PinpointEmail = Service.defineService('pinpointemail', ['2018-07-26']); +Object.defineProperty(apiLoader.services['pinpointemail'], '2018-07-26', { + get: function get() { + var model = require('../apis/pinpoint-email-2018-07-26.min.json'); + model.paginators = require('../apis/pinpoint-email-2018-07-26.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.PinpointEmail; diff --git a/node_modules/aws-sdk/clients/pinpointsmsvoice.d.ts b/node_modules/aws-sdk/clients/pinpointsmsvoice.d.ts new file mode 100644 index 0000000..8d8b4a8 --- /dev/null +++ b/node_modules/aws-sdk/clients/pinpointsmsvoice.d.ts @@ -0,0 +1,303 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class PinpointSMSVoice extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: PinpointSMSVoice.Types.ClientConfiguration) + config: Config & PinpointSMSVoice.Types.ClientConfiguration; + /** + * Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it. + */ + createConfigurationSet(params: PinpointSMSVoice.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.CreateConfigurationSetResponse) => void): Request; + /** + * Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it. + */ + createConfigurationSet(callback?: (err: AWSError, data: PinpointSMSVoice.Types.CreateConfigurationSetResponse) => void): Request; + /** + * Create a new event destination in a configuration set. + */ + createConfigurationSetEventDestination(params: PinpointSMSVoice.Types.CreateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.CreateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Create a new event destination in a configuration set. + */ + createConfigurationSetEventDestination(callback?: (err: AWSError, data: PinpointSMSVoice.Types.CreateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Deletes an existing configuration set. + */ + deleteConfigurationSet(params: PinpointSMSVoice.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.DeleteConfigurationSetResponse) => void): Request; + /** + * Deletes an existing configuration set. + */ + deleteConfigurationSet(callback?: (err: AWSError, data: PinpointSMSVoice.Types.DeleteConfigurationSetResponse) => void): Request; + /** + * Deletes an event destination in a configuration set. + */ + deleteConfigurationSetEventDestination(params: PinpointSMSVoice.Types.DeleteConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request; + /** + * Deletes an event destination in a configuration set. + */ + deleteConfigurationSetEventDestination(callback?: (err: AWSError, data: PinpointSMSVoice.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request; + /** + * Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination. + */ + getConfigurationSetEventDestinations(params: PinpointSMSVoice.Types.GetConfigurationSetEventDestinationsRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.GetConfigurationSetEventDestinationsResponse) => void): Request; + /** + * Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination. + */ + getConfigurationSetEventDestinations(callback?: (err: AWSError, data: PinpointSMSVoice.Types.GetConfigurationSetEventDestinationsResponse) => void): Request; + /** + * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. + */ + listConfigurationSets(params: PinpointSMSVoice.Types.ListConfigurationSetsRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.ListConfigurationSetsResponse) => void): Request; + /** + * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. + */ + listConfigurationSets(callback?: (err: AWSError, data: PinpointSMSVoice.Types.ListConfigurationSetsResponse) => void): Request; + /** + * Create a new voice message and send it to a recipient's phone number. + */ + sendVoiceMessage(params: PinpointSMSVoice.Types.SendVoiceMessageRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.SendVoiceMessageResponse) => void): Request; + /** + * Create a new voice message and send it to a recipient's phone number. + */ + sendVoiceMessage(callback?: (err: AWSError, data: PinpointSMSVoice.Types.SendVoiceMessageResponse) => void): Request; + /** + * Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails. + */ + updateConfigurationSetEventDestination(params: PinpointSMSVoice.Types.UpdateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointSMSVoice.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails. + */ + updateConfigurationSetEventDestination(callback?: (err: AWSError, data: PinpointSMSVoice.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request; +} +declare namespace PinpointSMSVoice { + export type Boolean = boolean; + export interface CallInstructionsMessageType { + /** + * The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide. + */ + Text?: NonEmptyString; + } + export interface CloudWatchLogsDestination { + /** + * The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination. + */ + IamRoleArn?: String; + /** + * The name of the Amazon CloudWatch Log Group that you want to record events in. + */ + LogGroupArn?: String; + } + export type ConfigurationSets = WordCharactersWithDelimiters[]; + export interface CreateConfigurationSetEventDestinationRequest { + /** + * ConfigurationSetName + */ + ConfigurationSetName: __string; + EventDestination?: EventDestinationDefinition; + /** + * A name that identifies the event destination. + */ + EventDestinationName?: NonEmptyString; + } + export interface CreateConfigurationSetEventDestinationResponse { + } + export interface CreateConfigurationSetRequest { + /** + * The name that you want to give the configuration set. + */ + ConfigurationSetName?: WordCharactersWithDelimiters; + } + export interface CreateConfigurationSetResponse { + } + export interface DeleteConfigurationSetEventDestinationRequest { + /** + * ConfigurationSetName + */ + ConfigurationSetName: __string; + /** + * EventDestinationName + */ + EventDestinationName: __string; + } + export interface DeleteConfigurationSetEventDestinationResponse { + } + export interface DeleteConfigurationSetRequest { + /** + * ConfigurationSetName + */ + ConfigurationSetName: __string; + } + export interface DeleteConfigurationSetResponse { + } + export interface EventDestination { + CloudWatchLogsDestination?: CloudWatchLogsDestination; + /** + * Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination. + */ + Enabled?: Boolean; + KinesisFirehoseDestination?: KinesisFirehoseDestination; + MatchingEventTypes?: EventTypes; + /** + * A name that identifies the event destination configuration. + */ + Name?: String; + SnsDestination?: SnsDestination; + } + export interface EventDestinationDefinition { + CloudWatchLogsDestination?: CloudWatchLogsDestination; + /** + * Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination. + */ + Enabled?: Boolean; + KinesisFirehoseDestination?: KinesisFirehoseDestination; + MatchingEventTypes?: EventTypes; + SnsDestination?: SnsDestination; + } + export type EventDestinations = EventDestination[]; + export type EventType = "INITIATED_CALL"|"RINGING"|"ANSWERED"|"COMPLETED_CALL"|"BUSY"|"FAILED"|"NO_ANSWER"|string; + export type EventTypes = EventType[]; + export interface GetConfigurationSetEventDestinationsRequest { + /** + * ConfigurationSetName + */ + ConfigurationSetName: __string; + } + export interface GetConfigurationSetEventDestinationsResponse { + EventDestinations?: EventDestinations; + } + export interface KinesisFirehoseDestination { + /** + * The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream. + */ + DeliveryStreamArn?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination. + */ + IamRoleArn?: String; + } + export interface ListConfigurationSetsRequest { + /** + * A token returned from a previous call to the API that indicates the position in the list of results. + */ + NextToken?: __string; + /** + * Used to specify the number of items that should be returned in the response. + */ + PageSize?: __string; + } + export interface ListConfigurationSetsResponse { + /** + * An object that contains a list of configuration sets for your account in the current region. + */ + ConfigurationSets?: ConfigurationSets; + /** + * A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets. + */ + NextToken?: NextTokenString; + } + export type NextTokenString = string; + export type NonEmptyString = string; + export interface PlainTextMessageType { + /** + * The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide. + */ + LanguageCode?: String; + /** + * The plain (not SSML-formatted) text to deliver to the recipient. + */ + Text?: NonEmptyString; + /** + * The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide. + */ + VoiceId?: String; + } + export interface SSMLMessageType { + /** + * The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide. + */ + LanguageCode?: String; + /** + * The SSML-formatted text to deliver to the recipient. + */ + Text?: NonEmptyString; + /** + * The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide. + */ + VoiceId?: String; + } + export interface SendVoiceMessageRequest { + /** + * The phone number that appears on recipients' devices when they receive the message. + */ + CallerId?: String; + /** + * The name of the configuration set that you want to use to send the message. + */ + ConfigurationSetName?: WordCharactersWithDelimiters; + Content?: VoiceMessageContent; + /** + * The phone number that you want to send the voice message to. + */ + DestinationPhoneNumber?: NonEmptyString; + /** + * The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request. + */ + OriginationPhoneNumber?: NonEmptyString; + } + export interface SendVoiceMessageResponse { + /** + * A unique identifier for the voice message. + */ + MessageId?: String; + } + export interface SnsDestination { + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to. + */ + TopicArn?: String; + } + export type String = string; + export interface UpdateConfigurationSetEventDestinationRequest { + /** + * ConfigurationSetName + */ + ConfigurationSetName: __string; + EventDestination?: EventDestinationDefinition; + /** + * EventDestinationName + */ + EventDestinationName: __string; + } + export interface UpdateConfigurationSetEventDestinationResponse { + } + export interface VoiceMessageContent { + CallInstructionsMessage?: CallInstructionsMessageType; + PlainTextMessage?: PlainTextMessageType; + SSMLMessage?: SSMLMessageType; + } + export type WordCharactersWithDelimiters = string; + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-09-05"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the PinpointSMSVoice client. + */ + export import Types = PinpointSMSVoice; +} +export = PinpointSMSVoice; diff --git a/node_modules/aws-sdk/clients/pinpointsmsvoice.js b/node_modules/aws-sdk/clients/pinpointsmsvoice.js new file mode 100644 index 0000000..ea68a6c --- /dev/null +++ b/node_modules/aws-sdk/clients/pinpointsmsvoice.js @@ -0,0 +1,17 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['pinpointsmsvoice'] = {}; +AWS.PinpointSMSVoice = Service.defineService('pinpointsmsvoice', ['2018-09-05']); +Object.defineProperty(apiLoader.services['pinpointsmsvoice'], '2018-09-05', { + get: function get() { + var model = require('../apis/sms-voice-2018-09-05.min.json'); + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.PinpointSMSVoice; diff --git a/node_modules/aws-sdk/clients/polly.d.ts b/node_modules/aws-sdk/clients/polly.d.ts new file mode 100644 index 0000000..73d5ded --- /dev/null +++ b/node_modules/aws-sdk/clients/polly.d.ts @@ -0,0 +1,488 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {PollyCustomizations} from '../lib/services/polly'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Presigner as presigner} from '../lib/polly/presigner'; +import {Readable} from 'stream'; +interface Blob {} +declare class Polly extends PollyCustomizations { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Polly.Types.ClientConfiguration) + config: Config & Polly.Types.ClientConfiguration; + /** + * Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs. For more information, see Managing Lexicons. + */ + deleteLexicon(params: Polly.Types.DeleteLexiconInput, callback?: (err: AWSError, data: Polly.Types.DeleteLexiconOutput) => void): Request; + /** + * Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs. For more information, see Managing Lexicons. + */ + deleteLexicon(callback?: (err: AWSError, data: Polly.Types.DeleteLexiconOutput) => void): Request; + /** + * Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name. When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices. For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from. You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices. This operation requires permissions to perform the polly:DescribeVoices action. + */ + describeVoices(params: Polly.Types.DescribeVoicesInput, callback?: (err: AWSError, data: Polly.Types.DescribeVoicesOutput) => void): Request; + /** + * Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name. When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices. For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from. You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices. This operation requires permissions to perform the polly:DescribeVoices action. + */ + describeVoices(callback?: (err: AWSError, data: Polly.Types.DescribeVoicesOutput) => void): Request; + /** + * Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons. + */ + getLexicon(params: Polly.Types.GetLexiconInput, callback?: (err: AWSError, data: Polly.Types.GetLexiconOutput) => void): Request; + /** + * Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons. + */ + getLexicon(callback?: (err: AWSError, data: Polly.Types.GetLexiconOutput) => void): Request; + /** + * Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task. + */ + getSpeechSynthesisTask(params: Polly.Types.GetSpeechSynthesisTaskInput, callback?: (err: AWSError, data: Polly.Types.GetSpeechSynthesisTaskOutput) => void): Request; + /** + * Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task. + */ + getSpeechSynthesisTask(callback?: (err: AWSError, data: Polly.Types.GetSpeechSynthesisTaskOutput) => void): Request; + /** + * Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons. + */ + listLexicons(params: Polly.Types.ListLexiconsInput, callback?: (err: AWSError, data: Polly.Types.ListLexiconsOutput) => void): Request; + /** + * Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons. + */ + listLexicons(callback?: (err: AWSError, data: Polly.Types.ListLexiconsOutput) => void): Request; + /** + * Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed. + */ + listSpeechSynthesisTasks(params: Polly.Types.ListSpeechSynthesisTasksInput, callback?: (err: AWSError, data: Polly.Types.ListSpeechSynthesisTasksOutput) => void): Request; + /** + * Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed. + */ + listSpeechSynthesisTasks(callback?: (err: AWSError, data: Polly.Types.ListSpeechSynthesisTasksOutput) => void): Request; + /** + * Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation. For more information, see Managing Lexicons. + */ + putLexicon(params: Polly.Types.PutLexiconInput, callback?: (err: AWSError, data: Polly.Types.PutLexiconOutput) => void): Request; + /** + * Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation. For more information, see Managing Lexicons. + */ + putLexicon(callback?: (err: AWSError, data: Polly.Types.PutLexiconOutput) => void): Request; + /** + * Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. + */ + startSpeechSynthesisTask(params: Polly.Types.StartSpeechSynthesisTaskInput, callback?: (err: AWSError, data: Polly.Types.StartSpeechSynthesisTaskOutput) => void): Request; + /** + * Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. + */ + startSpeechSynthesisTask(callback?: (err: AWSError, data: Polly.Types.StartSpeechSynthesisTaskOutput) => void): Request; + /** + * Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works. + */ + synthesizeSpeech(params: Polly.Types.SynthesizeSpeechInput, callback?: (err: AWSError, data: Polly.Types.SynthesizeSpeechOutput) => void): Request; + /** + * Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works. + */ + synthesizeSpeech(callback?: (err: AWSError, data: Polly.Types.SynthesizeSpeechOutput) => void): Request; +} +declare namespace Polly { + export import Presigner = presigner; +} +declare namespace Polly { + export type Alphabet = string; + export type AudioStream = Buffer|Uint8Array|Blob|string|Readable; + export type ContentType = string; + export type DateTime = Date; + export interface DeleteLexiconInput { + /** + * The name of the lexicon to delete. Must be an existing lexicon in the region. + */ + Name: LexiconName; + } + export interface DeleteLexiconOutput { + } + export interface DescribeVoicesInput { + /** + * The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned. + */ + LanguageCode?: LanguageCode; + /** + * Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no. + */ + IncludeAdditionalLanguageCodes?: IncludeAdditionalLanguageCodes; + /** + * An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing. + */ + NextToken?: NextToken; + } + export interface DescribeVoicesOutput { + /** + * A list of voices with their properties. + */ + Voices?: VoiceList; + /** + * The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated. + */ + NextToken?: NextToken; + } + export type Gender = "Female"|"Male"|string; + export interface GetLexiconInput { + /** + * Name of the lexicon. + */ + Name: LexiconName; + } + export interface GetLexiconOutput { + /** + * Lexicon object that provides name and the string content of the lexicon. + */ + Lexicon?: Lexicon; + /** + * Metadata of the lexicon, including phonetic alphabetic used, language code, lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon in bytes. + */ + LexiconAttributes?: LexiconAttributes; + } + export interface GetSpeechSynthesisTaskInput { + /** + * The Amazon Polly generated identifier for a speech synthesis task. + */ + TaskId: TaskId; + } + export interface GetSpeechSynthesisTaskOutput { + /** + * SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on. + */ + SynthesisTask?: SynthesisTask; + } + export type IncludeAdditionalLanguageCodes = boolean; + export type LanguageCode = "arb"|"cmn-CN"|"cy-GB"|"da-DK"|"de-DE"|"en-AU"|"en-GB"|"en-GB-WLS"|"en-IN"|"en-US"|"es-ES"|"es-MX"|"es-US"|"fr-CA"|"fr-FR"|"is-IS"|"it-IT"|"ja-JP"|"hi-IN"|"ko-KR"|"nb-NO"|"nl-NL"|"pl-PL"|"pt-BR"|"pt-PT"|"ro-RO"|"ru-RU"|"sv-SE"|"tr-TR"|string; + export type LanguageCodeList = LanguageCode[]; + export type LanguageName = string; + export type LastModified = Date; + export type LexemesCount = number; + export interface Lexicon { + /** + * Lexicon content in string format. The content of a lexicon must be in PLS format. + */ + Content?: LexiconContent; + /** + * Name of the lexicon. + */ + Name?: LexiconName; + } + export type LexiconArn = string; + export interface LexiconAttributes { + /** + * Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa. + */ + Alphabet?: Alphabet; + /** + * Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on. + */ + LanguageCode?: LanguageCode; + /** + * Date lexicon was last modified (a timestamp value). + */ + LastModified?: LastModified; + /** + * Amazon Resource Name (ARN) of the lexicon. + */ + LexiconArn?: LexiconArn; + /** + * Number of lexemes in the lexicon. + */ + LexemesCount?: LexemesCount; + /** + * Total size of the lexicon, in characters. + */ + Size?: Size; + } + export type LexiconContent = string; + export interface LexiconDescription { + /** + * Name of the lexicon. + */ + Name?: LexiconName; + /** + * Provides lexicon metadata. + */ + Attributes?: LexiconAttributes; + } + export type LexiconDescriptionList = LexiconDescription[]; + export type LexiconName = string; + export type LexiconNameList = LexiconName[]; + export interface ListLexiconsInput { + /** + * An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons. + */ + NextToken?: NextToken; + } + export interface ListLexiconsOutput { + /** + * A list of lexicon names and attributes. + */ + Lexicons?: LexiconDescriptionList; + /** + * The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated. + */ + NextToken?: NextToken; + } + export interface ListSpeechSynthesisTasksInput { + /** + * Maximum number of speech synthesis tasks returned in a List operation. + */ + MaxResults?: MaxResults; + /** + * The pagination token to use in the next request to continue the listing of speech synthesis tasks. + */ + NextToken?: NextToken; + /** + * Status of the speech synthesis tasks returned in a List operation + */ + Status?: TaskStatus; + } + export interface ListSpeechSynthesisTasksOutput { + /** + * An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing. + */ + NextToken?: NextToken; + /** + * List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on. + */ + SynthesisTasks?: SynthesisTasks; + } + export type MaxResults = number; + export type NextToken = string; + export type OutputFormat = "json"|"mp3"|"ogg_vorbis"|"pcm"|string; + export type OutputS3BucketName = string; + export type OutputS3KeyPrefix = string; + export type OutputUri = string; + export interface PutLexiconInput { + /** + * Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long. + */ + Name: LexiconName; + /** + * Content of the PLS lexicon as string data. + */ + Content: LexiconContent; + } + export interface PutLexiconOutput { + } + export type RequestCharacters = number; + export type SampleRate = string; + export type Size = number; + export type SnsTopicArn = string; + export type SpeechMarkType = "sentence"|"ssml"|"viseme"|"word"|string; + export type SpeechMarkTypeList = SpeechMarkType[]; + export interface StartSpeechSynthesisTaskInput { + /** + * List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. + */ + LexiconNames?: LexiconNameList; + /** + * The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. + */ + OutputFormat: OutputFormat; + /** + * Amazon S3 bucket name to which the output file will be saved. + */ + OutputS3BucketName: OutputS3BucketName; + /** + * The Amazon S3 key prefix for the output speech file. + */ + OutputS3KeyPrefix?: OutputS3KeyPrefix; + /** + * The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050". Valid values for pcm are "8000" and "16000" The default value is "16000". + */ + SampleRate?: SampleRate; + /** + * ARN for the SNS topic optionally used for providing status notification for a speech synthesis task. + */ + SnsTopicArn?: SnsTopicArn; + /** + * The type of speech marks returned for the input text. + */ + SpeechMarkTypes?: SpeechMarkTypeList; + /** + * The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text. + */ + Text: Text; + /** + * Specifies whether the input text is plain text or SSML. The default value is plain text. + */ + TextType?: TextType; + /** + * Voice ID to use for the synthesis. + */ + VoiceId: VoiceId; + /** + * Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi. + */ + LanguageCode?: LanguageCode; + } + export interface StartSpeechSynthesisTaskOutput { + /** + * SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task. + */ + SynthesisTask?: SynthesisTask; + } + export interface SynthesisTask { + /** + * The Amazon Polly generated identifier for a speech synthesis task. + */ + TaskId?: TaskId; + /** + * Current status of the individual speech synthesis task. + */ + TaskStatus?: TaskStatus; + /** + * Reason for the current status of a specific speech synthesis task, including errors if the task has failed. + */ + TaskStatusReason?: TaskStatusReason; + /** + * Pathway for the output speech file. + */ + OutputUri?: OutputUri; + /** + * Timestamp for the time the synthesis task was started. + */ + CreationTime?: DateTime; + /** + * Number of billable characters synthesized. + */ + RequestCharacters?: RequestCharacters; + /** + * ARN for the SNS topic optionally used for providing status notification for a speech synthesis task. + */ + SnsTopicArn?: SnsTopicArn; + /** + * List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. + */ + LexiconNames?: LexiconNameList; + /** + * The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. + */ + OutputFormat?: OutputFormat; + /** + * The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050". Valid values for pcm are "8000" and "16000" The default value is "16000". + */ + SampleRate?: SampleRate; + /** + * The type of speech marks returned for the input text. + */ + SpeechMarkTypes?: SpeechMarkTypeList; + /** + * Specifies whether the input text is plain text or SSML. The default value is plain text. + */ + TextType?: TextType; + /** + * Voice ID to use for the synthesis. + */ + VoiceId?: VoiceId; + /** + * Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi. + */ + LanguageCode?: LanguageCode; + } + export type SynthesisTasks = SynthesisTask[]; + export interface SynthesizeSpeechInput { + /** + * List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon. + */ + LexiconNames?: LexiconNameList; + /** + * The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format. + */ + OutputFormat: OutputFormat; + /** + * The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050". Valid values for pcm are "8000" and "16000" The default value is "16000". + */ + SampleRate?: SampleRate; + /** + * The type of speech marks returned for the input text. + */ + SpeechMarkTypes?: SpeechMarkTypeList; + /** + * Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text. + */ + Text: Text; + /** + * Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML. + */ + TextType?: TextType; + /** + * Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation. + */ + VoiceId: VoiceId; + /** + * Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi. + */ + LanguageCode?: LanguageCode; + } + export interface SynthesizeSpeechOutput { + /** + * Stream containing the synthesized speech. + */ + AudioStream?: AudioStream; + /** + * Specifies the type audio stream. This should reflect the OutputFormat parameter in your request. If you request mp3 as the OutputFormat, the ContentType returned is audio/mpeg. If you request ogg_vorbis as the OutputFormat, the ContentType returned is audio/ogg. If you request pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format. If you request json as the OutputFormat, the ContentType returned is audio/json. + */ + ContentType?: ContentType; + /** + * Number of characters synthesized. + */ + RequestCharacters?: RequestCharacters; + } + export type TaskId = string; + export type TaskStatus = "scheduled"|"inProgress"|"completed"|"failed"|string; + export type TaskStatusReason = string; + export type Text = string; + export type TextType = "ssml"|"text"|string; + export interface Voice { + /** + * Gender of the voice. + */ + Gender?: Gender; + /** + * Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation. + */ + Id?: VoiceId; + /** + * Language code of the voice. + */ + LanguageCode?: LanguageCode; + /** + * Human readable name of the language in English. + */ + LanguageName?: LanguageName; + /** + * Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application. + */ + Name?: VoiceName; + /** + * Additional codes for languages available for the specified voice in addition to its default language. For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN. + */ + AdditionalLanguageCodes?: LanguageCodeList; + } + export type VoiceId = "Aditi"|"Amy"|"Astrid"|"Bianca"|"Brian"|"Carla"|"Carmen"|"Celine"|"Chantal"|"Conchita"|"Cristiano"|"Dora"|"Emma"|"Enrique"|"Ewa"|"Filiz"|"Geraint"|"Giorgio"|"Gwyneth"|"Hans"|"Ines"|"Ivy"|"Jacek"|"Jan"|"Joanna"|"Joey"|"Justin"|"Karl"|"Kendra"|"Kimberly"|"Lea"|"Liv"|"Lotte"|"Lucia"|"Mads"|"Maja"|"Marlene"|"Mathieu"|"Matthew"|"Maxim"|"Mia"|"Miguel"|"Mizuki"|"Naja"|"Nicole"|"Penelope"|"Raveena"|"Ricardo"|"Ruben"|"Russell"|"Salli"|"Seoyeon"|"Takumi"|"Tatyana"|"Vicki"|"Vitoria"|"Zeina"|"Zhiyu"|string; + export type VoiceList = Voice[]; + export type VoiceName = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-06-10"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Polly client. + */ + export import Types = Polly; +} +export = Polly; diff --git a/node_modules/aws-sdk/clients/polly.js b/node_modules/aws-sdk/clients/polly.js new file mode 100644 index 0000000..6bf4cf8 --- /dev/null +++ b/node_modules/aws-sdk/clients/polly.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['polly'] = {}; +AWS.Polly = Service.defineService('polly', ['2016-06-10']); +require('../lib/services/polly'); +Object.defineProperty(apiLoader.services['polly'], '2016-06-10', { + get: function get() { + var model = require('../apis/polly-2016-06-10.min.json'); + model.paginators = require('../apis/polly-2016-06-10.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Polly; diff --git a/node_modules/aws-sdk/clients/pricing.d.ts b/node_modules/aws-sdk/clients/pricing.d.ts new file mode 100644 index 0000000..33727b2 --- /dev/null +++ b/node_modules/aws-sdk/clients/pricing.d.ts @@ -0,0 +1,191 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Pricing extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Pricing.Types.ClientConfiguration) + config: Config & Pricing.Types.ClientConfiguration; + /** + * Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge. + */ + describeServices(params: Pricing.Types.DescribeServicesRequest, callback?: (err: AWSError, data: Pricing.Types.DescribeServicesResponse) => void): Request; + /** + * Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge. + */ + describeServices(callback?: (err: AWSError, data: Pricing.Types.DescribeServicesResponse) => void): Request; + /** + * Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the AWS Billing and Cost Management User Guide. + */ + getAttributeValues(params: Pricing.Types.GetAttributeValuesRequest, callback?: (err: AWSError, data: Pricing.Types.GetAttributeValuesResponse) => void): Request; + /** + * Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the AWS Billing and Cost Management User Guide. + */ + getAttributeValues(callback?: (err: AWSError, data: Pricing.Types.GetAttributeValuesResponse) => void): Request; + /** + * Returns a list of all products that match the filter criteria. + */ + getProducts(params: Pricing.Types.GetProductsRequest, callback?: (err: AWSError, data: Pricing.Types.GetProductsResponse) => void): Request; + /** + * Returns a list of all products that match the filter criteria. + */ + getProducts(callback?: (err: AWSError, data: Pricing.Types.GetProductsResponse) => void): Request; +} +declare namespace Pricing { + export type AttributeNameList = String[]; + export interface AttributeValue { + /** + * The specific value of an attributeName. + */ + Value?: String; + } + export type AttributeValueList = AttributeValue[]; + export type BoxedInteger = number; + export interface DescribeServicesRequest { + /** + * The code for the service whose information you want to retrieve, such as AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To retrieve a list of all services, leave this blank. + */ + ServiceCode?: String; + /** + * The format version that you want the response to be in. Valid values are: aws_v1 + */ + FormatVersion?: String; + /** + * The pagination token that indicates the next set of results that you want to retrieve. + */ + NextToken?: String; + /** + * The maximum number of results that you want returned in the response. + */ + MaxResults?: BoxedInteger; + } + export interface DescribeServicesResponse { + /** + * The service metadata for the service or services in the response. + */ + Services?: ServiceList; + /** + * The format version of the response. For example, aws_v1. + */ + FormatVersion?: String; + /** + * The pagination token for the next set of retreivable results. + */ + NextToken?: String; + } + export interface Filter { + /** + * The type of filter that you want to use. Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value. + */ + Type: FilterType; + /** + * The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields. Valid values include: ServiceCode, and all attribute names For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes. + */ + Field: String; + /** + * The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume. + */ + Value: String; + } + export type FilterType = "TERM_MATCH"|string; + export type Filters = Filter[]; + export interface GetAttributeValuesRequest { + /** + * The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use AmazonEC2. + */ + ServiceCode: String; + /** + * The name of the attribute that you want to retrieve the values for, such as volumeType. + */ + AttributeName: String; + /** + * The pagination token that indicates the next set of results that you want to retrieve. + */ + NextToken?: String; + /** + * The maximum number of results to return in response. + */ + MaxResults?: BoxedInteger; + } + export interface GetAttributeValuesResponse { + /** + * The list of values for an attribute. For example, Throughput Optimized HDD and Provisioned IOPS are two available values for the AmazonEC2 volumeType. + */ + AttributeValues?: AttributeValueList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: String; + } + export interface GetProductsRequest { + /** + * The code for the service whose products you want to retrieve. + */ + ServiceCode?: String; + /** + * The list of filters that limit the returned products. only products that match all filters are returned. + */ + Filters?: Filters; + /** + * The format version that you want the response to be in. Valid values are: aws_v1 + */ + FormatVersion?: String; + /** + * The pagination token that indicates the next set of results that you want to retrieve. + */ + NextToken?: String; + /** + * The maximum number of results to return in the response. + */ + MaxResults?: BoxedInteger; + } + export interface GetProductsResponse { + /** + * The format version of the response. For example, aws_v1. + */ + FormatVersion?: String; + /** + * The list of products that match your filters. The list contains both the product metadata and the price information. + */ + PriceList?: PriceList; + /** + * The pagination token that indicates the next set of results to retrieve. + */ + NextToken?: String; + } + export type PriceList = PriceListItemJSON[]; + export type PriceListItemJSON = string; + export interface Service { + /** + * The code for the AWS service. + */ + ServiceCode?: String; + /** + * The attributes that are available for this service. + */ + AttributeNames?: AttributeNameList; + } + export type ServiceList = Service[]; + export type String = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-10-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Pricing client. + */ + export import Types = Pricing; +} +export = Pricing; diff --git a/node_modules/aws-sdk/clients/pricing.js b/node_modules/aws-sdk/clients/pricing.js new file mode 100644 index 0000000..79afb12 --- /dev/null +++ b/node_modules/aws-sdk/clients/pricing.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['pricing'] = {}; +AWS.Pricing = Service.defineService('pricing', ['2017-10-15']); +Object.defineProperty(apiLoader.services['pricing'], '2017-10-15', { + get: function get() { + var model = require('../apis/pricing-2017-10-15.min.json'); + model.paginators = require('../apis/pricing-2017-10-15.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Pricing; diff --git a/node_modules/aws-sdk/clients/quicksight.d.ts b/node_modules/aws-sdk/clients/quicksight.d.ts new file mode 100644 index 0000000..a5af0c8 --- /dev/null +++ b/node_modules/aws-sdk/clients/quicksight.d.ts @@ -0,0 +1,769 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class QuickSight extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: QuickSight.Types.ClientConfiguration) + config: Config & QuickSight.Types.ClientConfiguration; + /** + * Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting" + */ + createGroup(params: QuickSight.Types.CreateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request; + /** + * Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting" + */ + createGroup(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request; + /** + * Adds an Amazon QuickSight user to an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. The response is the group member object. CLI Sample: aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat + */ + createGroupMembership(params: QuickSight.Types.CreateGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request; + /** + * Adds an Amazon QuickSight user to an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. The response is the group member object. CLI Sample: aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat + */ + createGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request; + /** + * Removes a user group from Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . CLI Sample: aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management + */ + deleteGroup(params: QuickSight.Types.DeleteGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request; + /** + * Removes a user group from Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . CLI Sample: aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management + */ + deleteGroup(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request; + /** + * Removes a user from a group so that the user is no longer a member of the group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. CLI Sample: aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie + */ + deleteGroupMembership(params: QuickSight.Types.DeleteGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request; + /** + * Removes a user from a group so that the user is no longer a member of the group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The condition resource is the user name. The condition key is quicksight:UserName. CLI Sample: aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie + */ + deleteGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request; + /** + * Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . CLI Sample: aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat + */ + deleteUser(params: QuickSight.Types.DeleteUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request; + /** + * Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . CLI Sample: aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat + */ + deleteUser(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request; + /** + * Deletes a user after locating the user by its principal ID. + */ + deleteUserByPrincipalId(params: QuickSight.Types.DeleteUserByPrincipalIdRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request; + /** + * Deletes a user after locating the user by its principal ID. + */ + deleteUserByPrincipalId(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request; + /** + * Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is the group object. CLI Sample: aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales + */ + describeGroup(params: QuickSight.Types.DescribeGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request; + /** + * Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is the group object. CLI Sample: aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales + */ + describeGroup(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request; + /** + * Returns information about a user, given the user name. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat + */ + describeUser(params: QuickSight.Types.DescribeUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request; + /** + * Returns information about a user, given the user name. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat + */ + describeUser(callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request; + /** + * Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards. Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser. CLI Sample: Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml. aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession If the user does not exist in QuickSight, register the user: aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1 Get the URL for the embedded dashboard aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM + */ + getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request; + /** + * Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards. Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser. CLI Sample: Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml. aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession If the user does not exist in QuickSight, register the user: aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1 Get the URL for the embedded dashboard aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM + */ + getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request; + /** + * Lists member users in a group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a list of group member objects. CLI Sample: aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default + */ + listGroupMemberships(params: QuickSight.Types.ListGroupMembershipsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request; + /** + * Lists member users in a group. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a list of group member objects. CLI Sample: aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default + */ + listGroupMemberships(callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request; + /** + * Lists all user groups in Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*. The response is a list of group objects. CLI Sample: aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default + */ + listGroups(params: QuickSight.Types.ListGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request; + /** + * Lists all user groups in Amazon QuickSight. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*. The response is a list of group objects. CLI Sample: aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default + */ + listGroups(callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request; + /** + * Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a one or more group objects. CLI Sample: aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1 + */ + listUserGroups(params: QuickSight.Types.ListUserGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request; + /** + * Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a one or more group objects. CLI Sample: aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1 + */ + listUserGroups(callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request; + /** + * Returns a list of all of the Amazon QuickSight users belonging to this account. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* . The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight list-users --aws-account-id=111122223333 --namespace=default + */ + listUsers(params: QuickSight.Types.ListUsersRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request; + /** + * Returns a list of all of the Amazon QuickSight users belonging to this account. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* . The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: aws quicksight list-users --aws-account-id=111122223333 --namespace=default + */ + listUsers(callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request; + /** + * Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name. The condition keys are quicksight:IamArn and quicksight:SessionName. CLI Sample: aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat + */ + registerUser(params: QuickSight.Types.RegisterUserRequest, callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request; + /** + * Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name. The condition keys are quicksight:IamArn and quicksight:SessionName. CLI Sample: aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat + */ + registerUser(callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request; + /** + * Changes a group description. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards" + */ + updateGroup(params: QuickSight.Types.UpdateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request; + /** + * Changes a group description. The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> . The response is a group object. CLI Sample: aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards" + */ + updateGroup(callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request; + /** + * Updates an Amazon QuickSight user. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN). CLI Sample: aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1 + */ + updateUser(params: QuickSight.Types.UpdateUserRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request; + /** + * Updates an Amazon QuickSight user. The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> . The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN). CLI Sample: aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1 + */ + updateUser(callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request; +} +declare namespace QuickSight { + export type Arn = string; + export type AwsAccountId = string; + export type Boolean = boolean; + export interface CreateGroupMembershipRequest { + /** + * The name of the user that you want to add to the group membership. + */ + MemberName: GroupMemberName; + /** + * The name of the group that you want to add the user to. + */ + GroupName: GroupName; + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface CreateGroupMembershipResponse { + /** + * The group member. + */ + GroupMember?: GroupMember; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface CreateGroupRequest { + /** + * A name for the group that you want to create. + */ + GroupName: GroupName; + /** + * A description for the group that you want to create. + */ + Description?: GroupDescription; + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface CreateGroupResponse { + /** + * The name of the group. + */ + Group?: Group; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface DeleteGroupMembershipRequest { + /** + * The name of the user that you want to delete from the group membership. + */ + MemberName: GroupMemberName; + /** + * The name of the group that you want to delete the user from. + */ + GroupName: GroupName; + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface DeleteGroupMembershipResponse { + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface DeleteGroupRequest { + /** + * The name of the group that you want to delete. + */ + GroupName: GroupName; + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface DeleteGroupResponse { + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface DeleteUserByPrincipalIdRequest { + /** + * The principal ID of the user. + */ + PrincipalId: String; + /** + * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface DeleteUserByPrincipalIdResponse { + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface DeleteUserRequest { + /** + * The name of the user that you want to delete. + */ + UserName: UserName; + /** + * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface DeleteUserResponse { + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface DescribeGroupRequest { + /** + * The name of the group that you want to describe. + */ + GroupName: GroupName; + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface DescribeGroupResponse { + /** + * The name of the group. + */ + Group?: Group; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface DescribeUserRequest { + /** + * The name of the user that you want to describe. + */ + UserName: UserName; + /** + * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface DescribeUserResponse { + /** + * The user name. + */ + User?: User; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export type EmbeddingUrl = string; + export interface GetDashboardEmbedUrlRequest { + /** + * AWS account ID that contains the dashboard you are embedding. + */ + AwsAccountId: AwsAccountId; + /** + * The ID for the dashboard, also added to IAM policy + */ + DashboardId: String; + /** + * The authentication method the user uses to sign in (IAM only). + */ + IdentityType: IdentityType; + /** + * How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes. + */ + SessionLifetimeInMinutes?: SessionLifetimeInMinutes; + /** + * Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button. + */ + UndoRedoDisabled?: boolean; + /** + * Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button. + */ + ResetDisabled?: boolean; + } + export interface GetDashboardEmbedUrlResponse { + /** + * URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session. + */ + EmbedUrl?: EmbeddingUrl; + /** + * The http status of the request. + */ + Status?: StatusCode; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + } + export interface Group { + /** + * The Amazon Resource Name (ARN) for the group. + */ + Arn?: Arn; + /** + * The name of the group. + */ + GroupName?: GroupName; + /** + * The group description. + */ + Description?: GroupDescription; + /** + * The principal ID of the group. + */ + PrincipalId?: String; + } + export type GroupDescription = string; + export type GroupList = Group[]; + export interface GroupMember { + /** + * The Amazon Resource Name (ARN) for the group member (user). + */ + Arn?: Arn; + /** + * The name of the group member (user). + */ + MemberName?: GroupMemberName; + } + export type GroupMemberList = GroupMember[]; + export type GroupMemberName = string; + export type GroupName = string; + export type IdentityType = "IAM"|"QUICKSIGHT"|string; + export interface ListGroupMembershipsRequest { + /** + * The name of the group that you want to see a membership list of. + */ + GroupName: GroupName; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The maximum number of results to return from this request. + */ + MaxResults?: MaxResults; + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface ListGroupMembershipsResponse { + /** + * The list of the members of the group. + */ + GroupMemberList?: GroupMemberList; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface ListGroupsRequest { + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The maximum number of results to return. + */ + MaxResults?: MaxResults; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface ListGroupsResponse { + /** + * The list of the groups. + */ + GroupList?: GroupList; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface ListUserGroupsRequest { + /** + * The Amazon QuickSight user name that you want to list group memberships for. + */ + UserName: UserName; + /** + * The AWS Account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The maximum number of results to return from this request. + */ + MaxResults?: MaxResults; + } + export interface ListUserGroupsResponse { + /** + * The list of groups the user is a member of. + */ + GroupList?: GroupList; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The HTTP status of the request. + */ + Status?: StatusCode; + } + export interface ListUsersRequest { + /** + * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The maximum number of results to return from this request. + */ + MaxResults?: MaxResults; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface ListUsersResponse { + /** + * The list of users. + */ + UserList?: UserList; + /** + * A pagination token that can be used in a subsequent request. + */ + NextToken?: String; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export type MaxResults = number; + export type Namespace = string; + export interface RegisterUserRequest { + /** + * Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values: IAM: A user whose identity maps to an existing IAM user or role. QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight. + */ + IdentityType: IdentityType; + /** + * The email address of the user that you want to register. + */ + Email: String; + /** + * The Amazon QuickSight role of the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, data sets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. + */ + UserRole: UserRole; + /** + * The ARN of the IAM user or role that you are registering with Amazon QuickSight. + */ + IamArn?: String; + /** + * The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference. + */ + SessionName?: RoleSessionName; + /** + * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + /** + * The Amazon QuickSight user name that you want to create for the user you are registering. + */ + UserName?: UserName; + } + export interface RegisterUserResponse { + /** + * The user name. + */ + User?: User; + /** + * The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT. + */ + UserInvitationUrl?: String; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export type RoleSessionName = string; + export type SessionLifetimeInMinutes = number; + export type StatusCode = number; + export type String = string; + export interface UpdateGroupRequest { + /** + * The name of the group that you want to update. + */ + GroupName: GroupName; + /** + * The description for the group that you want to update. + */ + Description?: GroupDescription; + /** + * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + } + export interface UpdateGroupResponse { + /** + * The name of the group. + */ + Group?: Group; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface UpdateUserRequest { + /** + * The Amazon QuickSight user name that you want to update. + */ + UserName: UserName; + /** + * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. + */ + AwsAccountId: AwsAccountId; + /** + * The namespace. Currently, you should set this to default. + */ + Namespace: Namespace; + /** + * The email address of the user that you want to update. + */ + Email: String; + /** + * The Amazon QuickSight role of the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, data sets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. + */ + Role: UserRole; + } + export interface UpdateUserResponse { + /** + * The Amazon QuickSight user. + */ + User?: User; + /** + * The AWS request ID for this operation. + */ + RequestId?: String; + /** + * The http status of the request. + */ + Status?: StatusCode; + } + export interface User { + /** + * The Amazon Resource Name (ARN) for the user. + */ + Arn?: Arn; + /** + * The user's user name. + */ + UserName?: UserName; + /** + * The user's email address. + */ + Email?: String; + /** + * The Amazon QuickSight role for the user. + */ + Role?: UserRole; + /** + * The type of identity authentication used by the user. + */ + IdentityType?: IdentityType; + /** + * Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password + */ + Active?: Boolean; + /** + * The principal ID of the user. + */ + PrincipalId?: String; + } + export type UserList = User[]; + export type UserName = string; + export type UserRole = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-04-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the QuickSight client. + */ + export import Types = QuickSight; +} +export = QuickSight; diff --git a/node_modules/aws-sdk/clients/quicksight.js b/node_modules/aws-sdk/clients/quicksight.js new file mode 100644 index 0000000..40c6c77 --- /dev/null +++ b/node_modules/aws-sdk/clients/quicksight.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['quicksight'] = {}; +AWS.QuickSight = Service.defineService('quicksight', ['2018-04-01']); +Object.defineProperty(apiLoader.services['quicksight'], '2018-04-01', { + get: function get() { + var model = require('../apis/quicksight-2018-04-01.min.json'); + model.paginators = require('../apis/quicksight-2018-04-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.QuickSight; diff --git a/node_modules/aws-sdk/clients/ram.d.ts b/node_modules/aws-sdk/clients/ram.d.ts new file mode 100644 index 0000000..c7a4396 --- /dev/null +++ b/node_modules/aws-sdk/clients/ram.d.ts @@ -0,0 +1,793 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class RAM extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: RAM.Types.ClientConfiguration) + config: Config & RAM.Types.ClientConfiguration; + /** + * Accepts an invitation to a resource share from another AWS account. + */ + acceptResourceShareInvitation(params: RAM.Types.AcceptResourceShareInvitationRequest, callback?: (err: AWSError, data: RAM.Types.AcceptResourceShareInvitationResponse) => void): Request; + /** + * Accepts an invitation to a resource share from another AWS account. + */ + acceptResourceShareInvitation(callback?: (err: AWSError, data: RAM.Types.AcceptResourceShareInvitationResponse) => void): Request; + /** + * Associates the specified resource share with the specified principals and resources. + */ + associateResourceShare(params: RAM.Types.AssociateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.AssociateResourceShareResponse) => void): Request; + /** + * Associates the specified resource share with the specified principals and resources. + */ + associateResourceShare(callback?: (err: AWSError, data: RAM.Types.AssociateResourceShareResponse) => void): Request; + /** + * Creates a resource share. + */ + createResourceShare(params: RAM.Types.CreateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.CreateResourceShareResponse) => void): Request; + /** + * Creates a resource share. + */ + createResourceShare(callback?: (err: AWSError, data: RAM.Types.CreateResourceShareResponse) => void): Request; + /** + * Deletes the specified resource share. + */ + deleteResourceShare(params: RAM.Types.DeleteResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.DeleteResourceShareResponse) => void): Request; + /** + * Deletes the specified resource share. + */ + deleteResourceShare(callback?: (err: AWSError, data: RAM.Types.DeleteResourceShareResponse) => void): Request; + /** + * Disassociates the specified principals or resources from the specified resource share. + */ + disassociateResourceShare(params: RAM.Types.DisassociateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.DisassociateResourceShareResponse) => void): Request; + /** + * Disassociates the specified principals or resources from the specified resource share. + */ + disassociateResourceShare(callback?: (err: AWSError, data: RAM.Types.DisassociateResourceShareResponse) => void): Request; + /** + * Enables resource sharing within your organization. + */ + enableSharingWithAwsOrganization(params: RAM.Types.EnableSharingWithAwsOrganizationRequest, callback?: (err: AWSError, data: RAM.Types.EnableSharingWithAwsOrganizationResponse) => void): Request; + /** + * Enables resource sharing within your organization. + */ + enableSharingWithAwsOrganization(callback?: (err: AWSError, data: RAM.Types.EnableSharingWithAwsOrganizationResponse) => void): Request; + /** + * Gets the policies for the specifies resources. + */ + getResourcePolicies(params: RAM.Types.GetResourcePoliciesRequest, callback?: (err: AWSError, data: RAM.Types.GetResourcePoliciesResponse) => void): Request; + /** + * Gets the policies for the specifies resources. + */ + getResourcePolicies(callback?: (err: AWSError, data: RAM.Types.GetResourcePoliciesResponse) => void): Request; + /** + * Gets the associations for the specified resource share. + */ + getResourceShareAssociations(params: RAM.Types.GetResourceShareAssociationsRequest, callback?: (err: AWSError, data: RAM.Types.GetResourceShareAssociationsResponse) => void): Request; + /** + * Gets the associations for the specified resource share. + */ + getResourceShareAssociations(callback?: (err: AWSError, data: RAM.Types.GetResourceShareAssociationsResponse) => void): Request; + /** + * Gets the specified invitations for resource sharing. + */ + getResourceShareInvitations(params: RAM.Types.GetResourceShareInvitationsRequest, callback?: (err: AWSError, data: RAM.Types.GetResourceShareInvitationsResponse) => void): Request; + /** + * Gets the specified invitations for resource sharing. + */ + getResourceShareInvitations(callback?: (err: AWSError, data: RAM.Types.GetResourceShareInvitationsResponse) => void): Request; + /** + * Gets the specified resource shares or all of your resource shares. + */ + getResourceShares(params: RAM.Types.GetResourceSharesRequest, callback?: (err: AWSError, data: RAM.Types.GetResourceSharesResponse) => void): Request; + /** + * Gets the specified resource shares or all of your resource shares. + */ + getResourceShares(callback?: (err: AWSError, data: RAM.Types.GetResourceSharesResponse) => void): Request; + /** + * Lists the principals with access to the specified resource. + */ + listPrincipals(params: RAM.Types.ListPrincipalsRequest, callback?: (err: AWSError, data: RAM.Types.ListPrincipalsResponse) => void): Request; + /** + * Lists the principals with access to the specified resource. + */ + listPrincipals(callback?: (err: AWSError, data: RAM.Types.ListPrincipalsResponse) => void): Request; + /** + * Lists the resources that the specified principal can access. + */ + listResources(params: RAM.Types.ListResourcesRequest, callback?: (err: AWSError, data: RAM.Types.ListResourcesResponse) => void): Request; + /** + * Lists the resources that the specified principal can access. + */ + listResources(callback?: (err: AWSError, data: RAM.Types.ListResourcesResponse) => void): Request; + /** + * Rejects an invitation to a resource share from another AWS account. + */ + rejectResourceShareInvitation(params: RAM.Types.RejectResourceShareInvitationRequest, callback?: (err: AWSError, data: RAM.Types.RejectResourceShareInvitationResponse) => void): Request; + /** + * Rejects an invitation to a resource share from another AWS account. + */ + rejectResourceShareInvitation(callback?: (err: AWSError, data: RAM.Types.RejectResourceShareInvitationResponse) => void): Request; + /** + * Adds the specified tags to the specified resource share. + */ + tagResource(params: RAM.Types.TagResourceRequest, callback?: (err: AWSError, data: RAM.Types.TagResourceResponse) => void): Request; + /** + * Adds the specified tags to the specified resource share. + */ + tagResource(callback?: (err: AWSError, data: RAM.Types.TagResourceResponse) => void): Request; + /** + * Removes the specified tags from the specified resource share. + */ + untagResource(params: RAM.Types.UntagResourceRequest, callback?: (err: AWSError, data: RAM.Types.UntagResourceResponse) => void): Request; + /** + * Removes the specified tags from the specified resource share. + */ + untagResource(callback?: (err: AWSError, data: RAM.Types.UntagResourceResponse) => void): Request; + /** + * Updates the specified resource share. + */ + updateResourceShare(params: RAM.Types.UpdateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.UpdateResourceShareResponse) => void): Request; + /** + * Updates the specified resource share. + */ + updateResourceShare(callback?: (err: AWSError, data: RAM.Types.UpdateResourceShareResponse) => void): Request; +} +declare namespace RAM { + export interface AcceptResourceShareInvitationRequest { + /** + * The Amazon Resource Name (ARN) of the invitation. + */ + resourceShareInvitationArn: String; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface AcceptResourceShareInvitationResponse { + /** + * Information about the invitation. + */ + resourceShareInvitation?: ResourceShareInvitation; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface AssociateResourceShareRequest { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn: String; + /** + * The Amazon Resource Names (ARN) of the resources. + */ + resourceArns?: ResourceArnList; + /** + * The principals. + */ + principals?: PrincipalArnOrIdList; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface AssociateResourceShareResponse { + /** + * Information about the associations. + */ + resourceShareAssociations?: ResourceShareAssociationList; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export type Boolean = boolean; + export interface CreateResourceShareRequest { + /** + * The name of the resource share. + */ + name: String; + /** + * The Amazon Resource Names (ARN) of the resources to associate with the resource share. + */ + resourceArns?: ResourceArnList; + /** + * The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations. + */ + principals?: PrincipalArnOrIdList; + /** + * One or more tags. + */ + tags?: TagList; + /** + * Indicates whether principals outside your organization can be associated with a resource share. + */ + allowExternalPrincipals?: Boolean; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface CreateResourceShareResponse { + /** + * Information about the resource share. + */ + resourceShare?: ResourceShare; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export type DateTime = Date; + export interface DeleteResourceShareRequest { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn: String; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface DeleteResourceShareResponse { + /** + * Indicates whether the request succeeded. + */ + returnValue?: Boolean; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface DisassociateResourceShareRequest { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn: String; + /** + * The Amazon Resource Names (ARN) of the resources. + */ + resourceArns?: ResourceArnList; + /** + * The principals. + */ + principals?: PrincipalArnOrIdList; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface DisassociateResourceShareResponse { + /** + * Information about the associations. + */ + resourceShareAssociations?: ResourceShareAssociationList; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface EnableSharingWithAwsOrganizationRequest { + } + export interface EnableSharingWithAwsOrganizationResponse { + /** + * Indicates whether the request succeeded. + */ + returnValue?: Boolean; + } + export interface GetResourcePoliciesRequest { + /** + * The Amazon Resource Names (ARN) of the resources. + */ + resourceArns: ResourceArnList; + /** + * The principal. + */ + principal?: String; + /** + * The token for the next page of results. + */ + nextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + maxResults?: MaxResults; + } + export interface GetResourcePoliciesResponse { + /** + * A key policy document, in JSON format. + */ + policies?: PolicyList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface GetResourceShareAssociationsRequest { + /** + * The association type. + */ + associationType: ResourceShareAssociationType; + /** + * The Amazon Resource Names (ARN) of the resource shares. + */ + resourceShareArns?: ResourceShareArnList; + /** + * The Amazon Resource Name (ARN) of the resource. + */ + resourceArn?: String; + /** + * The principal. + */ + principal?: String; + /** + * The status of the association. + */ + associationStatus?: ResourceShareAssociationStatus; + /** + * The token for the next page of results. + */ + nextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + maxResults?: MaxResults; + } + export interface GetResourceShareAssociationsResponse { + /** + * Information about the association. + */ + resourceShareAssociations?: ResourceShareAssociationList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface GetResourceShareInvitationsRequest { + /** + * The Amazon Resource Names (ARN) of the invitations. + */ + resourceShareInvitationArns?: ResourceShareInvitationArnList; + /** + * The Amazon Resource Names (ARN) of the resource shares. + */ + resourceShareArns?: ResourceShareArnList; + /** + * The token for the next page of results. + */ + nextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + maxResults?: MaxResults; + } + export interface GetResourceShareInvitationsResponse { + /** + * Information about the invitations. + */ + resourceShareInvitations?: ResourceShareInvitationList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface GetResourceSharesRequest { + /** + * The Amazon Resource Names (ARN) of the resource shares. + */ + resourceShareArns?: ResourceShareArnList; + /** + * The status of the resource share. + */ + resourceShareStatus?: ResourceShareStatus; + /** + * The type of owner. + */ + resourceOwner: ResourceOwner; + /** + * The name of the resource share. + */ + name?: String; + /** + * One or more tag filters. + */ + tagFilters?: TagFilters; + /** + * The token for the next page of results. + */ + nextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + maxResults?: MaxResults; + } + export interface GetResourceSharesResponse { + /** + * Information about the resource shares. + */ + resourceShares?: ResourceShareList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListPrincipalsRequest { + /** + * The type of owner. + */ + resourceOwner: ResourceOwner; + /** + * The Amazon Resource Name (ARN) of the resource. + */ + resourceArn?: String; + /** + * The principals. + */ + principals?: PrincipalArnOrIdList; + /** + * The resource type. + */ + resourceType?: String; + /** + * The Amazon Resource Names (ARN) of the resource shares. + */ + resourceShareArns?: ResourceShareArnList; + /** + * The token for the next page of results. + */ + nextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + maxResults?: MaxResults; + } + export interface ListPrincipalsResponse { + /** + * The principals. + */ + principals?: PrincipalList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export interface ListResourcesRequest { + /** + * The type of owner. + */ + resourceOwner: ResourceOwner; + /** + * The principal. + */ + principal?: String; + /** + * The resource type. + */ + resourceType?: String; + /** + * The Amazon Resource Names (ARN) of the resources. + */ + resourceArns?: ResourceArnList; + /** + * The Amazon Resource Names (ARN) of the resource shares. + */ + resourceShareArns?: ResourceShareArnList; + /** + * The token for the next page of results. + */ + nextToken?: String; + /** + * The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. + */ + maxResults?: MaxResults; + } + export interface ListResourcesResponse { + /** + * Information about the resources. + */ + resources?: ResourceList; + /** + * The token to use to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: String; + } + export type MaxResults = number; + export type Policy = string; + export type PolicyList = Policy[]; + export interface Principal { + /** + * The ID of the principal. + */ + id?: String; + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn?: String; + /** + * The time when the principal was associated with the resource share. + */ + creationTime?: DateTime; + /** + * The time when the association was last updated. + */ + lastUpdatedTime?: DateTime; + /** + * Indicates whether the principal belongs to the same organization as the AWS account that owns the resource share. + */ + external?: Boolean; + } + export type PrincipalArnOrIdList = String[]; + export type PrincipalList = Principal[]; + export interface RejectResourceShareInvitationRequest { + /** + * The Amazon Resource Name (ARN) of the invitation. + */ + resourceShareInvitationArn: String; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface RejectResourceShareInvitationResponse { + /** + * Information about the invitation. + */ + resourceShareInvitation?: ResourceShareInvitation; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface Resource { + /** + * The Amazon Resource Name (ARN) of the resource. + */ + arn?: String; + /** + * The resource type. + */ + type?: String; + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn?: String; + /** + * The status of the resource. + */ + status?: ResourceStatus; + /** + * A message about the status of the resource. + */ + statusMessage?: String; + /** + * The time when the resource was associated with the resource share. + */ + creationTime?: DateTime; + /** + * The time when the association was last updated. + */ + lastUpdatedTime?: DateTime; + } + export type ResourceArnList = String[]; + export type ResourceList = Resource[]; + export type ResourceOwner = "SELF"|"OTHER-ACCOUNTS"|string; + export interface ResourceShare { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn?: String; + /** + * The name of the resource share. + */ + name?: String; + /** + * The ID of the AWS account that owns the resource share. + */ + owningAccountId?: String; + /** + * Indicates whether principals outside your organization can be associated with a resource share. + */ + allowExternalPrincipals?: Boolean; + /** + * The status of the resource share. + */ + status?: ResourceShareStatus; + /** + * A message about the status of the resource share. + */ + statusMessage?: String; + /** + * The tags for the resource share. + */ + tags?: TagList; + /** + * The time when the resource share was created. + */ + creationTime?: DateTime; + /** + * The time when the resource share was last updated. + */ + lastUpdatedTime?: DateTime; + } + export type ResourceShareArnList = String[]; + export interface ResourceShareAssociation { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn?: String; + /** + * The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations. + */ + associatedEntity?: String; + /** + * The association type. + */ + associationType?: ResourceShareAssociationType; + /** + * The status of the association. + */ + status?: ResourceShareAssociationStatus; + /** + * A message about the status of the association. + */ + statusMessage?: String; + /** + * The time when the association was created. + */ + creationTime?: DateTime; + /** + * The time when the association was last updated. + */ + lastUpdatedTime?: DateTime; + /** + * Indicates whether the principal belongs to the same organization as the AWS account that owns the resource share. + */ + external?: Boolean; + } + export type ResourceShareAssociationList = ResourceShareAssociation[]; + export type ResourceShareAssociationStatus = "ASSOCIATING"|"ASSOCIATED"|"FAILED"|"DISASSOCIATING"|"DISASSOCIATED"|string; + export type ResourceShareAssociationType = "PRINCIPAL"|"RESOURCE"|string; + export interface ResourceShareInvitation { + /** + * The Amazon Resource Name (ARN) of the invitation. + */ + resourceShareInvitationArn?: String; + /** + * The name of the resource share. + */ + resourceShareName?: String; + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn?: String; + /** + * The ID of the AWS account that sent the invitation. + */ + senderAccountId?: String; + /** + * The ID of the AWS account that received the invitation. + */ + receiverAccountId?: String; + /** + * The date and time when the invitation was sent. + */ + invitationTimestamp?: DateTime; + /** + * The status of the invitation. + */ + status?: ResourceShareInvitationStatus; + /** + * The resources associated with the resource share. + */ + resourceShareAssociations?: ResourceShareAssociationList; + } + export type ResourceShareInvitationArnList = String[]; + export type ResourceShareInvitationList = ResourceShareInvitation[]; + export type ResourceShareInvitationStatus = "PENDING"|"ACCEPTED"|"REJECTED"|"EXPIRED"|string; + export type ResourceShareList = ResourceShare[]; + export type ResourceShareStatus = "PENDING"|"ACTIVE"|"FAILED"|"DELETING"|"DELETED"|string; + export type ResourceStatus = "AVAILABLE"|"ZONAL_RESOURCE_INACCESSIBLE"|"LIMIT_EXCEEDED"|"UNAVAILABLE"|string; + export type String = string; + export interface Tag { + /** + * The key of the tag. + */ + key?: TagKey; + /** + * The value of the tag. + */ + value?: TagValue; + } + export interface TagFilter { + /** + * The tag key. + */ + tagKey?: TagKey; + /** + * The tag values. + */ + tagValues?: TagValueList; + } + export type TagFilters = TagFilter[]; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn: String; + /** + * One or more tags. + */ + tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export type TagValueList = TagValue[]; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn: String; + /** + * The tag keys of the tags to remove. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateResourceShareRequest { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + resourceShareArn: String; + /** + * The name of the resource share. + */ + name?: String; + /** + * Indicates whether principals outside your organization can be associated with a resource share. + */ + allowExternalPrincipals?: Boolean; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + export interface UpdateResourceShareResponse { + /** + * Information about the resource share. + */ + resourceShare?: ResourceShare; + /** + * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientToken?: String; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-01-04"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the RAM client. + */ + export import Types = RAM; +} +export = RAM; diff --git a/node_modules/aws-sdk/clients/ram.js b/node_modules/aws-sdk/clients/ram.js new file mode 100644 index 0000000..64ad99e --- /dev/null +++ b/node_modules/aws-sdk/clients/ram.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['ram'] = {}; +AWS.RAM = Service.defineService('ram', ['2018-01-04']); +Object.defineProperty(apiLoader.services['ram'], '2018-01-04', { + get: function get() { + var model = require('../apis/ram-2018-01-04.min.json'); + model.paginators = require('../apis/ram-2018-01-04.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.RAM; diff --git a/node_modules/aws-sdk/clients/rds.d.ts b/node_modules/aws-sdk/clients/rds.d.ts new file mode 100644 index 0000000..5879286 --- /dev/null +++ b/node_modules/aws-sdk/clients/rds.d.ts @@ -0,0 +1,6623 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {Signer as signer} from '../lib/rds/signer'; +interface Blob {} +declare class RDS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: RDS.Types.ClientConfiguration) + config: Config & RDS.Types.ClientConfiguration; + /** + * Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + addRoleToDBCluster(params: RDS.Types.AddRoleToDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an AWS Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. + */ + addRoleToDBInstance(params: RDS.Types.AddRoleToDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Associates an AWS Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. + */ + addRoleToDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds a source identifier to an existing RDS event notification subscription. + */ + addSourceIdentifierToSubscription(params: RDS.Types.AddSourceIdentifierToSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request; + /** + * Adds a source identifier to an existing RDS event notification subscription. + */ + addSourceIdentifierToSubscription(callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request; + /** + * Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources. + */ + addTagsToResource(params: RDS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources. + */ + addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Applies a pending maintenance action to a resource (for example, to a DB instance). + */ + applyPendingMaintenanceAction(params: RDS.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request; + /** + * Applies a pending maintenance action to a resource (for example, to a DB instance). + */ + applyPendingMaintenanceAction(callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request; + /** + * Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial. + */ + authorizeDBSecurityGroupIngress(params: RDS.Types.AuthorizeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request; + /** + * Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial. + */ + authorizeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request; + /** + * Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + backtrackDBCluster(params: RDS.Types.BacktrackDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request; + /** + * Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + backtrackDBCluster(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request; + /** + * Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters. + */ + copyDBClusterParameterGroup(params: RDS.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request; + /** + * Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters. + */ + copyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request; + /** + * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + copyDBClusterSnapshot(params: RDS.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request; + /** + * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + copyDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request; + /** + * Copies the specified DB parameter group. + */ + copyDBParameterGroup(params: RDS.Types.CopyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request; + /** + * Copies the specified DB parameter group. + */ + copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request; + /** + * Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide. + */ + copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request; + /** + * Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide. + */ + copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request; + /** + * Copies the specified option group. + */ + copyOptionGroup(params: RDS.Types.CopyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request; + /** + * Copies the specified option group. + */ + copyOptionGroup(callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request; + /** + * Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + createDBCluster(params: RDS.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request; + /** + * Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + createDBCluster(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request; + /** + * Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + createDBClusterEndpoint(params: RDS.Types.CreateDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request; + /** + * Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + createDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request; + /** + * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + createDBClusterParameterGroup(params: RDS.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request; + /** + * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + createDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request; + /** + * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + createDBClusterSnapshot(params: RDS.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request; + /** + * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + createDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request; + /** + * Creates a new DB instance. + */ + createDBInstance(params: RDS.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request; + /** + * Creates a new DB instance. + */ + createDBInstance(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request; + /** + * Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster. All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following. Your source DB instance must have backup retention enabled. + */ + createDBInstanceReadReplica(params: RDS.Types.CreateDBInstanceReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request; + /** + * Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster. All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following. Your source DB instance must have backup retention enabled. + */ + createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request; + /** + * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + createDBParameterGroup(params: RDS.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request; + /** + * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + createDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request; + /** + * Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC. + */ + createDBSecurityGroup(params: RDS.Types.CreateDBSecurityGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request; + /** + * Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC. + */ + createDBSecurityGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request; + /** + * Creates a DBSnapshot. The source DBInstance must be in "available" state. + */ + createDBSnapshot(params: RDS.Types.CreateDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request; + /** + * Creates a DBSnapshot. The source DBInstance must be in "available" state. + */ + createDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request; + /** + * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + createDBSubnetGroup(params: RDS.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request; + /** + * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + createDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request; + /** + * Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account. + */ + createEventSubscription(params: RDS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request; + /** + * Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account. + */ + createEventSubscription(callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request; + /** + * Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only applies to Aurora DB clusters. + */ + createGlobalCluster(params: RDS.Types.CreateGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request; + /** + * Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only applies to Aurora DB clusters. + */ + createGlobalCluster(callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request; + /** + * Creates a new option group. You can create up to 20 option groups. + */ + createOptionGroup(params: RDS.Types.CreateOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request; + /** + * Creates a new option group. You can create up to 20 option groups. + */ + createOptionGroup(callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request; + /** + * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + deleteDBCluster(params: RDS.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request; + /** + * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + deleteDBCluster(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request; + /** + * Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + deleteDBClusterEndpoint(params: RDS.Types.DeleteDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request; + /** + * Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + deleteDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request; + /** + * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + deleteDBClusterParameterGroup(params: RDS.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + deleteDBClusterSnapshot(params: RDS.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request; + /** + * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + deleteDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request; + /** + * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true: The DB cluster is a Read Replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster. + */ + deleteDBInstance(params: RDS.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request; + /** + * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true: The DB cluster is a Read Replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster. + */ + deleteDBInstance(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request; + /** + * Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID. + */ + deleteDBInstanceAutomatedBackup(params: RDS.Types.DeleteDBInstanceAutomatedBackupMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request; + /** + * Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID. + */ + deleteDBInstanceAutomatedBackup(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request; + /** + * Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances. + */ + deleteDBParameterGroup(params: RDS.Types.DeleteDBParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances. + */ + deleteDBParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB security group. The specified DB security group must not be associated with any DB instances. + */ + deleteDBSecurityGroup(params: RDS.Types.DeleteDBSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB security group. The specified DB security group must not be associated with any DB instances. + */ + deleteDBSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted. + */ + deleteDBSnapshot(params: RDS.Types.DeleteDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request; + /** + * Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted. + */ + deleteDBSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request; + /** + * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. + */ + deleteDBSubnetGroup(params: RDS.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. + */ + deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an RDS event notification subscription. + */ + deleteEventSubscription(params: RDS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request; + /** + * Deletes an RDS event notification subscription. + */ + deleteEventSubscription(callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request; + /** + * Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters. + */ + deleteGlobalCluster(params: RDS.Types.DeleteGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request; + /** + * Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters. + */ + deleteGlobalCluster(callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request; + /** + * Deletes an existing option group. + */ + deleteOptionGroup(params: RDS.Types.DeleteOptionGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing option group. + */ + deleteOptionGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command doesn't take any parameters. + */ + describeAccountAttributes(params: RDS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request; + /** + * Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command doesn't take any parameters. + */ + describeAccountAttributes(callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request; + /** + * Lists the set of CA certificates provided by Amazon RDS for this AWS account. + */ + describeCertificates(params: RDS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request; + /** + * Lists the set of CA certificates provided by Amazon RDS for this AWS account. + */ + describeCertificates(callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request; + /** + * Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterBacktracks(params: RDS.Types.DescribeDBClusterBacktracksMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request; + /** + * Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterBacktracks(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request; + /** + * Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + describeDBClusterEndpoints(params: RDS.Types.DescribeDBClusterEndpointsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request; + /** + * Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + describeDBClusterEndpoints(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request; + /** + * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterParameterGroups(params: RDS.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request; + /** + * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request; + /** + * Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterParameters(params: RDS.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request; + /** + * Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterParameters(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request; + /** + * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. This action only applies to Aurora DB clusters. + */ + describeDBClusterSnapshotAttributes(params: RDS.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request; + /** + * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. This action only applies to Aurora DB clusters. + */ + describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request; + /** + * Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterSnapshots(params: RDS.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request; + /** + * Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusterSnapshots(callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request; + /** + * Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusters(params: RDS.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request; + /** + * Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeDBClusters(callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request; + /** + * Returns a list of the available DB engines. + */ + describeDBEngineVersions(params: RDS.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request; + /** + * Returns a list of the available DB engines. + */ + describeDBEngineVersions(callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request; + /** + * Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are optional. + */ + describeDBInstanceAutomatedBackups(params: RDS.Types.DescribeDBInstanceAutomatedBackupsMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request; + /** + * Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are optional. + */ + describeDBInstanceAutomatedBackups(callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request; + /** + * Returns information about provisioned RDS instances. This API supports pagination. + */ + describeDBInstances(params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request; + /** + * Returns information about provisioned RDS instances. This API supports pagination. + */ + describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request; + /** + * Returns a list of DB log files for the DB instance. + */ + describeDBLogFiles(params: RDS.Types.DescribeDBLogFilesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request; + /** + * Returns a list of DB log files for the DB instance. + */ + describeDBLogFiles(callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request; + /** + * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group. + */ + describeDBParameterGroups(params: RDS.Types.DescribeDBParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request; + /** + * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group. + */ + describeDBParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request; + /** + * Returns the detailed parameter list for a particular DB parameter group. + */ + describeDBParameters(params: RDS.Types.DescribeDBParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request; + /** + * Returns the detailed parameter list for a particular DB parameter group. + */ + describeDBParameters(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request; + /** + * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group. + */ + describeDBSecurityGroups(params: RDS.Types.DescribeDBSecurityGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request; + /** + * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group. + */ + describeDBSecurityGroups(callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request; + /** + * Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action. + */ + describeDBSnapshotAttributes(params: RDS.Types.DescribeDBSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request; + /** + * Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action. + */ + describeDBSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request; + /** + * Returns information about DB snapshots. This API action supports pagination. + */ + describeDBSnapshots(params: RDS.Types.DescribeDBSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request; + /** + * Returns information about DB snapshots. This API action supports pagination. + */ + describeDBSnapshots(callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request; + /** + * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. + */ + describeDBSubnetGroups(params: RDS.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request; + /** + * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. + */ + describeDBSubnetGroups(callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request; + /** + * Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. + */ + describeEngineDefaultClusterParameters(params: RDS.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. + */ + describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the specified database engine. + */ + describeEngineDefaultParameters(params: RDS.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request; + /** + * Returns the default engine and system parameter information for the specified database engine. + */ + describeEngineDefaultParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request; + /** + * Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide. + */ + describeEventCategories(params: RDS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request; + /** + * Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide. + */ + describeEventCategories(callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request; + /** + * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. + */ + describeEventSubscriptions(params: RDS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request; + /** + * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. + */ + describeEventSubscriptions(callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request; + /** + * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. + */ + describeEvents(params: RDS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request; + /** + * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. + */ + describeEvents(callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request; + /** + * Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeGlobalClusters(params: RDS.Types.DescribeGlobalClustersMessage, callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request; + /** + * Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + describeGlobalClusters(callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request; + /** + * Describes all available options. + */ + describeOptionGroupOptions(params: RDS.Types.DescribeOptionGroupOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request; + /** + * Describes all available options. + */ + describeOptionGroupOptions(callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request; + /** + * Describes the available option groups. + */ + describeOptionGroups(params: RDS.Types.DescribeOptionGroupsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request; + /** + * Describes the available option groups. + */ + describeOptionGroups(callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request; + /** + * Returns a list of orderable DB instance options for the specified engine. + */ + describeOrderableDBInstanceOptions(params: RDS.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request; + /** + * Returns a list of orderable DB instance options for the specified engine. + */ + describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request; + /** + * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. + */ + describePendingMaintenanceActions(params: RDS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request; + /** + * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. + */ + describePendingMaintenanceActions(callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request; + /** + * Returns information about reserved DB instances for this account, or about a specified reserved DB instance. + */ + describeReservedDBInstances(params: RDS.Types.DescribeReservedDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request; + /** + * Returns information about reserved DB instances for this account, or about a specified reserved DB instance. + */ + describeReservedDBInstances(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request; + /** + * Lists available reserved DB instance offerings. + */ + describeReservedDBInstancesOfferings(params: RDS.Types.DescribeReservedDBInstancesOfferingsMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request; + /** + * Lists available reserved DB instance offerings. + */ + describeReservedDBInstancesOfferings(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request; + /** + * Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination. + */ + describeSourceRegions(params: RDS.Types.DescribeSourceRegionsMessage, callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request; + /** + * Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination. + */ + describeSourceRegions(callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request; + /** + * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. + */ + describeValidDBInstanceModifications(params: RDS.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request; + /** + * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. + */ + describeValidDBInstanceModifications(callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request; + /** + * Downloads all or a portion of the specified log file, up to 1 MB in size. + */ + downloadDBLogFilePortion(params: RDS.Types.DownloadDBLogFilePortionMessage, callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request; + /** + * Downloads all or a portion of the specified log file, up to 1 MB in size. + */ + downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request; + /** + * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + failoverDBCluster(params: RDS.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request; + /** + * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + failoverDBCluster(callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request; + /** + * Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. + */ + listTagsForResource(params: RDS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request; + /** + * Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. + */ + listTagsForResource(callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request; + /** + * Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + modifyCurrentDBClusterCapacity(params: RDS.Types.ModifyCurrentDBClusterCapacityMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request; + /** + * Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + modifyCurrentDBClusterCapacity(callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request; + /** + * Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + modifyDBCluster(params: RDS.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request; + /** + * Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + modifyDBCluster(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request; + /** + * Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + modifyDBClusterEndpoint(params: RDS.Types.ModifyDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request; + /** + * Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. + */ + modifyDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. This action only applies to Aurora DB clusters. + */ + modifyDBClusterParameterGroup(params: RDS.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. This action only applies to Aurora DB clusters. + */ + modifyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action. This action only applies to Aurora DB clusters. + */ + modifyDBClusterSnapshotAttribute(params: RDS.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action. This action only applies to Aurora DB clusters. + */ + modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request; + /** + * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance. + */ + modifyDBInstance(params: RDS.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request; + /** + * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance. + */ + modifyDBInstance(callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request; + /** + * Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + modifyDBParameterGroup(params: RDS.Types.ModifyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. + */ + modifyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. Amazon RDS supports upgrading DB snapshots for MySQL and Oracle. + */ + modifyDBSnapshot(params: RDS.Types.ModifyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request; + /** + * Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. Amazon RDS supports upgrading DB snapshots for MySQL and Oracle. + */ + modifyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. + */ + modifyDBSnapshotAttribute(params: RDS.Types.ModifyDBSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request; + /** + * Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. + */ + modifyDBSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request; + /** + * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + modifyDBSubnetGroup(params: RDS.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request; + /** + * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. + */ + modifyDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request; + /** + * Modifies an existing RDS event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. + */ + modifyEventSubscription(params: RDS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request; + /** + * Modifies an existing RDS event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. + */ + modifyEventSubscription(callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request; + /** + * Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + modifyGlobalCluster(params: RDS.Types.ModifyGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request; + /** + * Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + modifyGlobalCluster(callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request; + /** + * Modifies an existing option group. + */ + modifyOptionGroup(params: RDS.Types.ModifyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request; + /** + * Modifies an existing option group. + */ + modifyOptionGroup(callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request; + /** + * Promotes a Read Replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. + */ + promoteReadReplica(params: RDS.Types.PromoteReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request; + /** + * Promotes a Read Replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. + */ + promoteReadReplica(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request; + /** + * Promotes a Read Replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters. + */ + promoteReadReplicaDBCluster(params: RDS.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request; + /** + * Promotes a Read Replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters. + */ + promoteReadReplicaDBCluster(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request; + /** + * Purchases a reserved DB instance offering. + */ + purchaseReservedDBInstancesOffering(params: RDS.Types.PurchaseReservedDBInstancesOfferingMessage, callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request; + /** + * Purchases a reserved DB instance offering. + */ + purchaseReservedDBInstancesOffering(callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request; + /** + * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. + */ + rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request; + /** + * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. + */ + rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request; + /** + * Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region. This action only applies to Aurora DB clusters. + */ + removeFromGlobalCluster(params: RDS.Types.RemoveFromGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request; + /** + * Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region. This action only applies to Aurora DB clusters. + */ + removeFromGlobalCluster(callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request; + /** + * Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + removeRoleFromDBCluster(params: RDS.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates an AWS Identity and Access Management (IAM) role from a DB instance. + */ + removeRoleFromDBInstance(params: RDS.Types.RemoveRoleFromDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Disassociates an AWS Identity and Access Management (IAM) role from a DB instance. + */ + removeRoleFromDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a source identifier from an existing RDS event notification subscription. + */ + removeSourceIdentifierFromSubscription(params: RDS.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request; + /** + * Removes a source identifier from an existing RDS event notification subscription. + */ + removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request; + /** + * Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. + */ + removeTagsFromResource(params: RDS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. + */ + removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + resetDBClusterParameterGroup(params: RDS.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + resetDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. + */ + resetDBParameterGroup(params: RDS.Types.ResetDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. + */ + resetDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request; + /** + * Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + restoreDBClusterFromS3(params: RDS.Types.RestoreDBClusterFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request; + /** + * Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + restoreDBClusterFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request; + /** + * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + restoreDBClusterFromSnapshot(params: RDS.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request; + /** + * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request; + /** + * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + restoreDBClusterToPointInTime(params: RDS.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request; + /** + * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + restoreDBClusterToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request; + /** + * Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot. + */ + restoreDBInstanceFromDBSnapshot(params: RDS.Types.RestoreDBInstanceFromDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request; + /** + * Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot. + */ + restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request; + /** + * Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide. + */ + restoreDBInstanceFromS3(params: RDS.Types.RestoreDBInstanceFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request; + /** + * Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide. + */ + restoreDBInstanceFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request; + /** + * Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime. + */ + restoreDBInstanceToPointInTime(params: RDS.Types.RestoreDBInstanceToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request; + /** + * Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime. + */ + restoreDBInstanceToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request; + /** + * Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). + */ + revokeDBSecurityGroupIngress(params: RDS.Types.RevokeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request; + /** + * Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). + */ + revokeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request; + /** + * Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + startDBCluster(params: RDS.Types.StartDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request; + /** + * Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + startDBCluster(callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request; + /** + * Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead. + */ + startDBInstance(params: RDS.Types.StartDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request; + /** + * Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead. + */ + startDBInstance(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request; + /** + * Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + stopDBCluster(params: RDS.Types.StopDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request; + /** + * Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. + */ + stopDBCluster(callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request; + /** + * Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead. + */ + stopDBInstance(params: RDS.Types.StopDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request; + /** + * Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead. + */ + stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request; + /** + * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceAvailable", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceDeleted", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request; + /** + * Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBSnapshotAvailable", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request; + /** + * Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBSnapshotAvailable", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request; + /** + * Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBSnapshotDeleted", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request; + /** + * Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "dBSnapshotDeleted", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request; +} +declare namespace RDS { + export import Signer = signer; +} +declare namespace RDS { + export interface AccountAttributesMessage { + /** + * A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota. + */ + AccountQuotas?: AccountQuotaList; + } + export interface AccountQuota { + /** + * The name of the Amazon RDS quota for this AWS account. + */ + AccountQuotaName?: String; + /** + * The amount currently used toward the quota maximum. + */ + Used?: Long; + /** + * The maximum allowed value for the quota. + */ + Max?: Long; + } + export type AccountQuotaList = AccountQuota[]; + export interface AddRoleToDBClusterMessage { + /** + * The name of the DB cluster to associate the IAM role with. + */ + DBClusterIdentifier: String; + /** + * The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. + */ + RoleArn: String; + /** + * The name of the feature for the DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion. + */ + FeatureName?: String; + } + export interface AddRoleToDBInstanceMessage { + /** + * The name of the DB instance to associate the IAM role with. + */ + DBInstanceIdentifier: String; + /** + * The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole. + */ + RoleArn: String; + /** + * The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion. + */ + FeatureName: String; + } + export interface AddSourceIdentifierToSubscriptionMessage { + /** + * The name of the RDS event notification subscription you want to add a source identifier to. + */ + SubscriptionName: String; + /** + * The identifier of the event source to be added. Constraints: If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied. + */ + SourceIdentifier: String; + } + export interface AddSourceIdentifierToSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface AddTagsToResourceMessage { + /** + * The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). + */ + ResourceName: String; + /** + * The tags to be assigned to the Amazon RDS resource. + */ + Tags: TagList; + } + export type ApplyMethod = "immediate"|"pending-reboot"|string; + export interface ApplyPendingMaintenanceActionMessage { + /** + * The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). + */ + ResourceIdentifier: String; + /** + * The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade, hardware-maintenance + */ + ApplyAction: String; + /** + * A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests. + */ + OptInType: String; + } + export interface ApplyPendingMaintenanceActionResult { + ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions; + } + export type AttributeValueList = String[]; + export interface AuthorizeDBSecurityGroupIngressMessage { + /** + * The name of the DB security group to add authorization to. + */ + DBSecurityGroupName: String; + /** + * The IP range to authorize. + */ + CIDRIP?: String; + /** + * Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + */ + EC2SecurityGroupName?: String; + /** + * Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + */ + EC2SecurityGroupId?: String; + /** + * AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + */ + EC2SecurityGroupOwnerId?: String; + } + export interface AuthorizeDBSecurityGroupIngressResult { + DBSecurityGroup?: DBSecurityGroup; + } + export interface AvailabilityZone { + /** + * The name of the Availability Zone. + */ + Name?: String; + } + export type AvailabilityZoneList = AvailabilityZone[]; + export type AvailabilityZones = String[]; + export interface AvailableProcessorFeature { + /** + * The name of the processor feature. Valid names are coreCount and threadsPerCore. + */ + Name?: String; + /** + * The default value for the processor feature of the DB instance class. + */ + DefaultValue?: String; + /** + * The allowed values for the processor feature of the DB instance class. + */ + AllowedValues?: String; + } + export type AvailableProcessorFeatureList = AvailableProcessorFeature[]; + export interface BacktrackDBClusterMessage { + /** + * The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1 + */ + DBClusterIdentifier: String; + /** + * The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page. If the specified time is not a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster. Constraints: Must contain a valid ISO 8601 timestamp. Can't contain a timestamp set in the future. Example: 2017-07-08T18:00Z + */ + BacktrackTo: TStamp; + /** + * A value that, if specified, forces the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled. + */ + Force?: BooleanOptional; + /** + * If BacktrackTo is set to a timestamp earlier than the earliest backtrack time, this value backtracks the DB cluster to the earliest possible backtrack time. Otherwise, an error occurs. + */ + UseEarliestTimeOnPointInTimeUnavailable?: BooleanOptional; + } + export type Boolean = boolean; + export type BooleanOptional = boolean; + export interface Certificate { + /** + * The unique key that identifies a certificate. + */ + CertificateIdentifier?: String; + /** + * The type of the certificate. + */ + CertificateType?: String; + /** + * The thumbprint of the certificate. + */ + Thumbprint?: String; + /** + * The starting date from which the certificate is valid. + */ + ValidFrom?: TStamp; + /** + * The final date that the certificate continues to be valid. + */ + ValidTill?: TStamp; + /** + * The Amazon Resource Name (ARN) for the certificate. + */ + CertificateArn?: String; + } + export type CertificateList = Certificate[]; + export interface CertificateMessage { + /** + * The list of Certificate objects for the AWS account. + */ + Certificates?: CertificateList; + /** + * An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export interface CharacterSet { + /** + * The name of the character set. + */ + CharacterSetName?: String; + /** + * The description of the character set. + */ + CharacterSetDescription?: String; + } + export interface CloudwatchLogsExportConfiguration { + /** + * The list of log types to enable. + */ + EnableLogTypes?: LogTypeList; + /** + * The list of log types to disable. + */ + DisableLogTypes?: LogTypeList; + } + export interface CopyDBClusterParameterGroupMessage { + /** + * The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide. Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1. + */ + SourceDBClusterParameterGroupIdentifier: String; + /** + * The identifier for the copied DB cluster parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster-param-group1 + */ + TargetDBClusterParameterGroupIdentifier: String; + /** + * A description for the copied DB cluster parameter group. + */ + TargetDBClusterParameterGroupDescription: String; + Tags?: TagList; + } + export interface CopyDBClusterParameterGroupResult { + DBClusterParameterGroup?: DBClusterParameterGroup; + } + export interface CopyDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: Must specify a valid system snapshot in the "available" state. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide. Example: my-cluster-snapshot1 + */ + SourceDBClusterSnapshotIdentifier: String; + /** + * The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2 + */ + TargetDBClusterSnapshotIdentifier: String; + /** + * The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned. + */ + KmsKeyId?: String; + /** + * The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf. + */ + PreSignedUrl?: String; + /** + * True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false. + */ + CopyTags?: BooleanOptional; + Tags?: TagList; + /** + * The ID of the region that contains the snapshot to be copied. + */ + SourceRegion?: String; + } + export interface CopyDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface CopyDBParameterGroupMessage { + /** + * The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN. + */ + SourceDBParameterGroupIdentifier: String; + /** + * The identifier for the copied DB parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-db-parameter-group + */ + TargetDBParameterGroupIdentifier: String; + /** + * A description for the copied DB parameter group. + */ + TargetDBParameterGroupDescription: String; + Tags?: TagList; + } + export interface CopyDBParameterGroupResult { + DBParameterGroup?: DBParameterGroup; + } + export interface CopyDBSnapshotMessage { + /** + * The identifier for the source DB snapshot. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805. If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805. If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter. Constraints: Must specify a valid system snapshot in the "available" state. Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 + */ + SourceDBSnapshotIdentifier: String; + /** + * The identifier for the copy of the snapshot. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot + */ + TargetDBSnapshotIdentifier: String; + /** + * The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. + */ + KmsKeyId?: String; + Tags?: TagList; + /** + * True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false. + */ + CopyTags?: BooleanOptional; + /** + * The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf. + */ + PreSignedUrl?: String; + /** + * The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide. + */ + OptionGroupName?: String; + /** + * The ID of the region that contains the snapshot to be copied. + */ + SourceRegion?: String; + } + export interface CopyDBSnapshotResult { + DBSnapshot?: DBSnapshot; + } + export interface CopyOptionGroupMessage { + /** + * The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. Constraints: Must specify a valid option group. If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN. If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options. + */ + SourceOptionGroupIdentifier: String; + /** + * The identifier for the copied option group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-option-group + */ + TargetOptionGroupIdentifier: String; + /** + * The description for the copied option group. + */ + TargetOptionGroupDescription: String; + Tags?: TagList; + } + export interface CopyOptionGroupResult { + OptionGroup?: OptionGroup; + } + export interface CreateDBClusterEndpointMessage { + /** + * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. + */ + DBClusterIdentifier: String; + /** + * The identifier to use for the new endpoint. This parameter is stored as a lowercase string. + */ + DBClusterEndpointIdentifier: String; + /** + * The type of the endpoint. One of: READER, ANY. + */ + EndpointType: String; + /** + * List of DB instance identifiers that are part of the custom endpoint group. + */ + StaticMembers?: StringList; + /** + * List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. + */ + ExcludedMembers?: StringList; + } + export interface CreateDBClusterMessage { + /** + * A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35 + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * A value that indicates that the DB cluster should be associated with the specified CharacterSet. + */ + CharacterSetName?: String; + /** + * The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating. + */ + DatabaseName?: String; + /** + * The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1 + */ + DBClusterIdentifier: String; + /** + * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. + */ + DBClusterParameterGroupName?: String; + /** + * A list of EC2 VPC security groups to associate with this DB cluster. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql + */ + Engine: String; + /** + * The version number of the database engine to use. Aurora MySQL Example: 5.6.10a, 5.7.12 Aurora PostgreSQL Example: 9.6.3 + */ + EngineVersion?: String; + /** + * The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql. + */ + Port?: IntegerOptional; + /** + * The name of the master user for the DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. + */ + MasterUsername?: String; + /** + * The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword?: String; + /** + * A value that indicates that the DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster. + */ + OptionGroupName?: String; + /** + * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. + */ + ReplicationSourceIdentifier?: String; + Tags?: TagList; + /** + * Specifies whether the DB cluster is encrypted. + */ + StorageEncrypted?: BooleanOptional; + /** + * The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key. If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS 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. If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region. + */ + KmsKeyId?: String; + /** + * A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in. ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf. + */ + PreSignedUrl?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). + */ + BacktrackWindow?: LongOptional; + /** + * The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global. + */ + EngineMode?: String; + /** + * For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. + */ + ScalingConfiguration?: ScalingConfiguration; + /** + * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. + */ + DeletionProtection?: BooleanOptional; + /** + * The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. + */ + GlobalClusterIdentifier?: String; + /** + * True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * The ID of the region that contains the source for the read replica. + */ + SourceRegion?: String; + } + export interface CreateDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must match the name of an existing DB cluster parameter group. This value is stored as a lowercase string. + */ + DBClusterParameterGroupName: String; + /** + * The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora5.6, aurora-mysql5.7 Aurora PostgreSQL Example: aurora-postgresql9.6 + */ + DBParameterGroupFamily: String; + /** + * The description for the DB cluster parameter group. + */ + Description: String; + Tags?: TagList; + } + export interface CreateDBClusterParameterGroupResult { + DBClusterParameterGroup?: DBClusterParameterGroup; + } + export interface CreateDBClusterResult { + DBCluster?: DBCluster; + } + export interface CreateDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1 + */ + DBClusterSnapshotIdentifier: String; + /** + * The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster1 + */ + DBClusterIdentifier: String; + /** + * The tags to be assigned to the DB cluster snapshot. + */ + Tags?: TagList; + } + export interface CreateDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface CreateDBInstanceMessage { + /** + * The meaning of this parameter differs according to the database engine you use. Type: String MySQL The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Can't be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance. Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can't be longer than 8 characters SQL Server Not applicable. Must be null. Amazon Aurora The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Can't be a word reserved by the specified database engine + */ + DBName?: String; + /** + * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance + */ + DBInstanceIdentifier: String; + /** + * The amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024. + */ + AllocatedStorage?: IntegerOptional; + /** + * The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. + */ + DBInstanceClass: String; + /** + * The name of the database engine to be used for this instance. Not every database engine is available for every AWS Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web + */ + Engine: String; + /** + * The name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster. MariaDB Constraints: Required for MariaDB. Must be 1 to 16 letters or numbers. Can't be a reserved word for the chosen database engine. Microsoft SQL Server Constraints: Required for SQL Server. Must be 1 to 128 letters or numbers. The first character must be a letter. Can't be a reserved word for the chosen database engine. MySQL Constraints: Required for MySQL. Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. Oracle Constraints: Required for Oracle. Must be 1 to 30 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. PostgreSQL Constraints: Required for PostgreSQL. Must be 1 to 63 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. + */ + MasterUsername?: String; + /** + * The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster. MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. + */ + MasterUserPassword?: String; + /** + * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. + */ + DBSecurityGroups?: DBSecurityGroupNameList; + /** + * A list of Amazon EC2 VPC security groups to associate with this DB instance. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC security group for the DB subnet group's VPC. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The EC2 Availability Zone that the DB instance is created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint. + */ + AvailabilityZone?: String; + /** + * A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance. + */ + DBSubnetGroupName?: String; + /** + * The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window. Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens + */ + DBParameterGroupName?: String; + /** + * The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster. Default: 1 Constraints: Must be a value from 0 to 35 Can't be set to 0 if the DB instance is a source to Read Replicas + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The port number on which the database accepts connections. MySQL Default: 3306 Valid Values: 1150-65535 Type: Integer MariaDB Default: 3306 Valid Values: 1150-65535 Type: Integer PostgreSQL Default: 5432 Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: 1150-65535 SQL Server Default: 1433 Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156. Amazon Aurora Default: 3306 Valid Values: 1150-65535 Type: Integer + */ + Port?: IntegerOptional; + /** + * A value that specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true. + */ + MultiAZ?: BooleanOptional; + /** + * The version number of the database engine to use. For a list of valid engine versions, call DescribeDBEngineVersions. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. + */ + EngineVersion?: String; + /** + * Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license + */ + LicenseModel?: String; + /** + * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance. + */ + Iops?: IntegerOptional; + /** + * Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance + */ + OptionGroupName?: String; + /** + * For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster. + */ + CharacterSetName?: String; + /** + * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies: If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private. If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public. If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies: If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private. If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public. + */ + PubliclyAccessible?: BooleanOptional; + Tags?: TagList; + /** + * The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String + */ + DBClusterIdentifier?: String; + /** + * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise standard + */ + StorageType?: String; + /** + * The ARN from the key store with which to associate the instance for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * The password for the given ARN from the key store in order to access the device. + */ + TdeCredentialPassword?: String; + /** + * Specifies whether the DB instance is encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster. Default: false + */ + StorageEncrypted?: BooleanOptional; + /** + * The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS 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. + */ + KmsKeyId?: String; + /** + * Specify the Active Directory Domain to create the instance in. + */ + Domain?: String; + /** + * True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see CreateDBCluster. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 + */ + MonitoringInterval?: IntegerOptional; + /** + * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. + */ + MonitoringRoleArn?: String; + /** + * Specify the name of the IAM role to be used when making API calls to the Directory Service. + */ + DomainIAMRoleName?: String; + /** + * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15 + */ + PromotionTier?: IntegerOptional; + /** + * The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server. + */ + Timezone?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines: Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster. MySQL For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * True to enable Performance Insights for the DB instance, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide. + */ + EnablePerformanceInsights?: BooleanOptional; + /** + * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). + */ + PerformanceInsightsRetentionPeriod?: IntegerOptional; + /** + * The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance. + */ + DeletionProtection?: BooleanOptional; + } + export interface CreateDBInstanceReadReplicaMessage { + /** + * The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string. + */ + DBInstanceIdentifier: String; + /** + * The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, Oracle, or PostgreSQL DB instance. Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later. For the limitations of Oracle Read Replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier. If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. + */ + SourceDBInstanceIdentifier: String; + /** + * The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits from the source DB instance. + */ + DBInstanceClass?: String; + /** + * The Amazon EC2 Availability Zone that the Read Replica is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d + */ + AvailabilityZone?: String; + /** + * The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535 + */ + Port?: IntegerOptional; + /** + * Specifies whether the Read Replica is in a Multi-AZ deployment. You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance. + */ + MultiAZ?: BooleanOptional; + /** + * Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. + */ + Iops?: IntegerOptional; + /** + * The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used. + */ + OptionGroupName?: String; + /** + * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. + */ + PubliclyAccessible?: BooleanOptional; + Tags?: TagList; + /** + * Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC. Constraints: Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. If supplied, must match the name of an existing DBSubnetGroup. The specified DB subnet group must be in the same AWS Region in which the operation is running. All Read Replicas in one AWS Region that are created from the same source DB instance must either:> Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC. Not specify a DB subnet group. All these Read Replicas are created outside of any VPC. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * A list of EC2 VPC security groups to associate with the Read Replica. Default: The default EC2 VPC security group for the DB subnet group's VPC. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * Specifies the storage type to be associated with the Read Replica. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise standard + */ + StorageType?: String; + /** + * True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 + */ + MonitoringInterval?: IntegerOptional; + /** + * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. + */ + MonitoringRoleArn?: String; + /** + * The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance. If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. You can't create an encrypted Read Replica from an unencrypted DB instance. + */ + KmsKeyId?: String; + /** + * The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf. + */ + PreSignedUrl?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Aurora MySQL 5.6 or higher Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * True to enable Performance Insights for the Read Replica, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. + */ + EnablePerformanceInsights?: BooleanOptional; + /** + * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). + */ + PerformanceInsightsRetentionPeriod?: IntegerOptional; + /** + * The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * A value that specifies that the DB instance class of the DB instance uses its default processor features. + */ + UseDefaultProcessorFeatures?: BooleanOptional; + /** + * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance. + */ + DeletionProtection?: BooleanOptional; + /** + * The ID of the region that contains the source for the read replica. + */ + SourceRegion?: String; + } + export interface CreateDBInstanceReadReplicaResult { + DBInstance?: DBInstance; + } + export interface CreateDBInstanceResult { + DBInstance?: DBInstance; + } + export interface CreateDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. + */ + DBParameterGroupName: String; + /** + * The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. + */ + DBParameterGroupFamily: String; + /** + * The description for the DB parameter group. + */ + Description: String; + Tags?: TagList; + } + export interface CreateDBParameterGroupResult { + DBParameterGroup?: DBParameterGroup; + } + export interface CreateDBSecurityGroupMessage { + /** + * The name for the DB security group. This value is stored as a lowercase string. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Must not be "Default" Example: mysecuritygroup + */ + DBSecurityGroupName: String; + /** + * The description for the DB security group. + */ + DBSecurityGroupDescription: String; + Tags?: TagList; + } + export interface CreateDBSecurityGroupResult { + DBSecurityGroup?: DBSecurityGroup; + } + export interface CreateDBSnapshotMessage { + /** + * The identifier for the DB snapshot. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id + */ + DBSnapshotIdentifier: String; + /** + * The identifier of the DB instance that you want to create the snapshot of. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + Tags?: TagList; + } + export interface CreateDBSnapshotResult { + DBSnapshot?: DBSnapshot; + } + export interface CreateDBSubnetGroupMessage { + /** + * The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + /** + * The description for the DB subnet group. + */ + DBSubnetGroupDescription: String; + /** + * The EC2 Subnet IDs for the DB subnet group. + */ + SubnetIds: SubnetIdentifierList; + Tags?: TagList; + } + export interface CreateDBSubnetGroupResult { + DBSubnetGroup?: DBSubnetGroup; + } + export interface CreateEventSubscriptionMessage { + /** + * The name of the subscription. Constraints: The name must be less than 255 characters. + */ + SubscriptionName: String; + /** + * The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + */ + SnsTopicArn: String; + /** + * The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot + */ + SourceType?: String; + /** + * A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. + */ + EventCategories?: EventCategoriesList; + /** + * The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are supplied, SourceType must also be provided. If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied. + */ + SourceIds?: SourceIdsList; + /** + * A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. + */ + Enabled?: BooleanOptional; + Tags?: TagList; + } + export interface CreateEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface CreateGlobalClusterMessage { + /** + * The cluster identifier of the new global database cluster. + */ + GlobalClusterIdentifier?: String; + /** + * The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. + */ + SourceDBClusterIdentifier?: String; + /** + * Provides the name of the database engine to be used for this DB cluster. + */ + Engine?: String; + /** + * The engine version of the Aurora global database. + */ + EngineVersion?: String; + /** + * The deletion protection setting for the new global database. The global database can't be deleted when this value is set to true. + */ + DeletionProtection?: BooleanOptional; + /** + * The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating. + */ + DatabaseName?: String; + /** + * The storage encryption setting for the new global database cluster. + */ + StorageEncrypted?: BooleanOptional; + } + export interface CreateGlobalClusterResult { + GlobalCluster?: GlobalCluster; + } + export interface CreateOptionGroupMessage { + /** + * Specifies the name of the option group to be created. Constraints: Must be 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: myoptiongroup + */ + OptionGroupName: String; + /** + * Specifies the name of the engine that this option group should be associated with. + */ + EngineName: String; + /** + * Specifies the major version of the engine that this option group should be associated with. + */ + MajorEngineVersion: String; + /** + * The description of the option group. + */ + OptionGroupDescription: String; + Tags?: TagList; + } + export interface CreateOptionGroupResult { + OptionGroup?: OptionGroup; + } + export interface DBCluster { + /** + * For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed. + */ + AllocatedStorage?: IntegerOptional; + /** + * Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * Specifies the number of days for which automatic DB snapshots are retained. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * If present, specifies the name of the character set that this cluster is associated with. + */ + CharacterSetName?: String; + /** + * Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster. + */ + DatabaseName?: String; + /** + * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. + */ + DBClusterIdentifier?: String; + /** + * Specifies the name of the DB cluster parameter group for the DB cluster. + */ + DBClusterParameterGroup?: String; + /** + * Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. + */ + DBSubnetGroup?: String; + /** + * Specifies the current state of this DB cluster. + */ + Status?: String; + /** + * Specifies the progress of the operation as a percentage. + */ + PercentProgress?: String; + /** + * The earliest time to which a database can be restored with point-in-time restore. + */ + EarliestRestorableTime?: TStamp; + /** + * Specifies the connection endpoint for the primary instance of the DB cluster. + */ + Endpoint?: String; + /** + * The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. + */ + ReaderEndpoint?: String; + /** + * Identifies all custom endpoints associated with the cluster. + */ + CustomEndpoints?: StringList; + /** + * Specifies whether the DB cluster has instances in multiple Availability Zones. + */ + MultiAZ?: Boolean; + /** + * Provides the name of the database engine to be used for this DB cluster. + */ + Engine?: String; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * Specifies the latest time to which a database can be restored with point-in-time restore. + */ + LatestRestorableTime?: TStamp; + /** + * Specifies the port that the database engine is listening on. + */ + Port?: IntegerOptional; + /** + * Contains the master username for the DB cluster. + */ + MasterUsername?: String; + /** + * Provides the list of option group memberships for this DB cluster. + */ + DBClusterOptionGroupMemberships?: DBClusterOptionGroupMemberships; + /** + * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. + */ + PreferredBackupWindow?: String; + /** + * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + */ + PreferredMaintenanceWindow?: String; + /** + * Contains the identifier of the source DB cluster if this DB cluster is a Read Replica. + */ + ReplicationSourceIdentifier?: String; + /** + * Contains one or more identifiers of the Read Replicas associated with this DB cluster. + */ + ReadReplicaIdentifiers?: ReadReplicaIdentifierList; + /** + * Provides the list of instances that make up the DB cluster. + */ + DBClusterMembers?: DBClusterMemberList; + /** + * Provides a list of VPC security groups that the DB cluster belongs to. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + */ + HostedZoneId?: String; + /** + * Specifies whether the DB cluster is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster. + */ + KmsKeyId?: String; + /** + * The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. + */ + DbClusterResourceId?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster. + */ + DBClusterArn?: String; + /** + * Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + */ + AssociatedRoles?: DBClusterRoles; + /** + * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + /** + * Identifies the clone group to which the DB cluster is associated. + */ + CloneGroupId?: String; + /** + * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). + */ + ClusterCreateTime?: TStamp; + /** + * The earliest time to which a DB cluster can be backtracked. + */ + EarliestBacktrackTime?: TStamp; + /** + * The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. + */ + BacktrackWindow?: LongOptional; + /** + * The number of change records stored for Backtrack. + */ + BacktrackConsumedChangeRecords?: LongOptional; + /** + * A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide. + */ + EnabledCloudwatchLogsExports?: LogTypeList; + /** + * The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. + */ + Capacity?: IntegerOptional; + /** + * The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery. + */ + EngineMode?: String; + ScalingConfigurationInfo?: ScalingConfigurationInfo; + /** + * Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true. + */ + DeletionProtection?: Boolean; + /** + * HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change. Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. + */ + HttpEndpointEnabled?: Boolean; + /** + * Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster. + */ + CopyTagsToSnapshot?: Boolean; + } + export interface DBClusterBacktrack { + /** + * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. + */ + DBClusterIdentifier?: String; + /** + * Contains the backtrack identifier. + */ + BacktrackIdentifier?: String; + /** + * The timestamp of the time to which the DB cluster was backtracked. + */ + BacktrackTo?: TStamp; + /** + * The timestamp of the time from which the DB cluster was backtracked. + */ + BacktrackedFrom?: TStamp; + /** + * The timestamp of the time at which the backtrack was requested. + */ + BacktrackRequestCreationTime?: TStamp; + /** + * The status of the backtrack. This property returns one of the following values: applying - The backtrack is currently being applied to or rolled back from the DB cluster. completed - The backtrack has successfully been applied to or rolled back from the DB cluster. failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster. pending - The backtrack is currently pending application to or rollback from the DB cluster. + */ + Status?: String; + } + export type DBClusterBacktrackList = DBClusterBacktrack[]; + export interface DBClusterBacktrackMessage { + /** + * A pagination token that can be used in a subsequent DescribeDBClusterBacktracks request. + */ + Marker?: String; + /** + * Contains a list of backtracks for the user. + */ + DBClusterBacktracks?: DBClusterBacktrackList; + } + export interface DBClusterCapacityInfo { + /** + * A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. + */ + DBClusterIdentifier?: String; + /** + * A value that specifies the capacity that the DB cluster scales to next. + */ + PendingCapacity?: IntegerOptional; + /** + * The current capacity of the DB cluster. + */ + CurrentCapacity?: IntegerOptional; + /** + * The number of seconds before a call to ModifyCurrentDBClusterCapacity times out. + */ + SecondsBeforeTimeout?: IntegerOptional; + /** + * The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange. + */ + TimeoutAction?: String; + } + export interface DBClusterEndpoint { + /** + * The identifier associated with the endpoint. This parameter is stored as a lowercase string. + */ + DBClusterEndpointIdentifier?: String; + /** + * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. + */ + DBClusterIdentifier?: String; + /** + * A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint. + */ + DBClusterEndpointResourceIdentifier?: String; + /** + * The DNS address of the endpoint. + */ + Endpoint?: String; + /** + * The current status of the endpoint. One of: creating, available, deleting, modifying. + */ + Status?: String; + /** + * The type of the endpoint. One of: READER, WRITER, CUSTOM. + */ + EndpointType?: String; + /** + * The type associated with a custom endpoint. One of: READER, ANY. + */ + CustomEndpointType?: String; + /** + * List of DB instance identifiers that are part of the custom endpoint group. + */ + StaticMembers?: StringList; + /** + * List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. + */ + ExcludedMembers?: StringList; + /** + * The Amazon Resource Name (ARN) for the endpoint. + */ + DBClusterEndpointArn?: String; + } + export type DBClusterEndpointList = DBClusterEndpoint[]; + export interface DBClusterEndpointMessage { + /** + * An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * Contains the details of the endpoints associated with the cluster and matching any filter conditions. + */ + DBClusterEndpoints?: DBClusterEndpointList; + } + export type DBClusterList = DBCluster[]; + export interface DBClusterMember { + /** + * Specifies the instance identifier for this member of the DB cluster. + */ + DBInstanceIdentifier?: String; + /** + * Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise. + */ + IsClusterWriter?: Boolean; + /** + * Specifies the status of the DB cluster parameter group for this member of the DB cluster. + */ + DBClusterParameterGroupStatus?: String; + /** + * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. + */ + PromotionTier?: IntegerOptional; + } + export type DBClusterMemberList = DBClusterMember[]; + export interface DBClusterMessage { + /** + * A pagination token that can be used in a subsequent DescribeDBClusters request. + */ + Marker?: String; + /** + * Contains a list of DB clusters for the user. + */ + DBClusters?: DBClusterList; + } + export type DBClusterOptionGroupMemberships = DBClusterOptionGroupStatus[]; + export interface DBClusterOptionGroupStatus { + /** + * Specifies the name of the DB cluster option group. + */ + DBClusterOptionGroupName?: String; + /** + * Specifies the status of the DB cluster option group. + */ + Status?: String; + } + export interface DBClusterParameterGroup { + /** + * Provides the name of the DB cluster parameter group. + */ + DBClusterParameterGroupName?: String; + /** + * Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with. + */ + DBParameterGroupFamily?: String; + /** + * Provides the customer-specified description for this DB cluster parameter group. + */ + Description?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster parameter group. + */ + DBClusterParameterGroupArn?: String; + } + export interface DBClusterParameterGroupDetails { + /** + * Provides a list of parameters for the DB cluster parameter group. + */ + Parameters?: ParametersList; + /** + * An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export type DBClusterParameterGroupList = DBClusterParameterGroup[]; + export interface DBClusterParameterGroupNameMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. + */ + DBClusterParameterGroupName?: String; + } + export interface DBClusterParameterGroupsMessage { + /** + * An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * A list of DB cluster parameter groups. + */ + DBClusterParameterGroups?: DBClusterParameterGroupList; + } + export interface DBClusterRole { + /** + * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. + */ + RoleArn?: String; + /** + * Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf. PENDING - the IAM role ARN is being associated with the DB cluster. INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf. + */ + Status?: String; + /** + * The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion. + */ + FeatureName?: String; + } + export type DBClusterRoles = DBClusterRole[]; + export interface DBClusterSnapshot { + /** + * Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * Specifies the identifier for the DB cluster snapshot. + */ + DBClusterSnapshotIdentifier?: String; + /** + * Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. + */ + DBClusterIdentifier?: String; + /** + * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). + */ + SnapshotCreateTime?: TStamp; + /** + * Specifies the name of the database engine. + */ + Engine?: String; + /** + * Specifies the allocated storage size in gibibytes (GiB). + */ + AllocatedStorage?: Integer; + /** + * Specifies the status of this DB cluster snapshot. + */ + Status?: String; + /** + * Specifies the port that the DB cluster was listening on at the time of the snapshot. + */ + Port?: Integer; + /** + * Provides the VPC ID associated with the DB cluster snapshot. + */ + VpcId?: String; + /** + * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). + */ + ClusterCreateTime?: TStamp; + /** + * Provides the master username for the DB cluster snapshot. + */ + MasterUsername?: String; + /** + * Provides the version of the database engine for this DB cluster snapshot. + */ + EngineVersion?: String; + /** + * Provides the license model information for this DB cluster snapshot. + */ + LicenseModel?: String; + /** + * Provides the type of the DB cluster snapshot. + */ + SnapshotType?: String; + /** + * Specifies the percentage of the estimated data that has been transferred. + */ + PercentProgress?: Integer; + /** + * Specifies whether the DB cluster snapshot is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. + */ + KmsKeyId?: String; + /** + * The Amazon Resource Name (ARN) for the DB cluster snapshot. + */ + DBClusterSnapshotArn?: String; + /** + * If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value. + */ + SourceDBClusterSnapshotArn?: String; + /** + * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + } + export interface DBClusterSnapshotAttribute { + /** + * The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action. + */ + AttributeName?: String; + /** + * The value(s) for the manual DB cluster snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore. + */ + AttributeValues?: AttributeValueList; + } + export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[]; + export interface DBClusterSnapshotAttributesResult { + /** + * The identifier of the manual DB cluster snapshot that the attributes apply to. + */ + DBClusterSnapshotIdentifier?: String; + /** + * The list of attributes and values for the manual DB cluster snapshot. + */ + DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList; + } + export type DBClusterSnapshotList = DBClusterSnapshot[]; + export interface DBClusterSnapshotMessage { + /** + * An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * Provides a list of DB cluster snapshots for the user. + */ + DBClusterSnapshots?: DBClusterSnapshotList; + } + export interface DBEngineVersion { + /** + * The name of the database engine. + */ + Engine?: String; + /** + * The version number of the database engine. + */ + EngineVersion?: String; + /** + * The name of the DB parameter group family for the database engine. + */ + DBParameterGroupFamily?: String; + /** + * The description of the database engine. + */ + DBEngineDescription?: String; + /** + * The description of the database engine version. + */ + DBEngineVersionDescription?: String; + /** + * The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified. + */ + DefaultCharacterSet?: CharacterSet; + /** + * A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action. + */ + SupportedCharacterSets?: SupportedCharacterSetsList; + /** + * A list of engine versions that this database engine version can be upgraded to. + */ + ValidUpgradeTarget?: ValidUpgradeTargetList; + /** + * A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action. + */ + SupportedTimezones?: SupportedTimezonesList; + /** + * The types of logs that the database engine has available for export to CloudWatch Logs. + */ + ExportableLogTypes?: LogTypeList; + /** + * A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. + */ + SupportsLogExportsToCloudwatchLogs?: Boolean; + /** + * Indicates whether the database engine version supports Read Replicas. + */ + SupportsReadReplica?: Boolean; + /** + * A list of the supported DB engine modes. + */ + SupportedEngineModes?: EngineModeList; + /** + * A list of features supported by the DB engine. Supported feature names include the following. s3Import + */ + SupportedFeatureNames?: FeatureNameList; + } + export type DBEngineVersionList = DBEngineVersion[]; + export interface DBEngineVersionMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBEngineVersion elements. + */ + DBEngineVersions?: DBEngineVersionList; + } + export interface DBInstance { + /** + * Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. + */ + DBInstanceIdentifier?: String; + /** + * Contains the name of the compute and memory capacity class of the DB instance. + */ + DBInstanceClass?: String; + /** + * Provides the name of the database engine to be used for this DB instance. + */ + Engine?: String; + /** + * Specifies the current state of this database. + */ + DBInstanceStatus?: String; + /** + * Contains the master username for the DB instance. + */ + MasterUsername?: String; + /** + * The meaning of this parameter differs according to the database engine you use. MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance. + */ + DBName?: String; + /** + * Specifies the connection endpoint. + */ + Endpoint?: Endpoint; + /** + * Specifies the allocated storage size specified in gibibytes. + */ + AllocatedStorage?: Integer; + /** + * Provides the date and time the DB instance was created. + */ + InstanceCreateTime?: TStamp; + /** + * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. + */ + PreferredBackupWindow?: String; + /** + * Specifies the number of days for which automatic DB snapshots are retained. + */ + BackupRetentionPeriod?: Integer; + /** + * Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements. + */ + DBSecurityGroups?: DBSecurityGroupMembershipList; + /** + * Provides a list of VPC security group elements that the DB instance belongs to. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * Provides the list of DB parameter groups applied to this DB instance. + */ + DBParameterGroups?: DBParameterGroupStatusList; + /** + * Specifies the name of the Availability Zone the DB instance is located in. + */ + AvailabilityZone?: String; + /** + * Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group. + */ + DBSubnetGroup?: DBSubnetGroup; + /** + * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + */ + PreferredMaintenanceWindow?: String; + /** + * Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. + */ + PendingModifiedValues?: PendingModifiedValues; + /** + * Specifies the latest time to which a database can be restored with point-in-time restore. + */ + LatestRestorableTime?: TStamp; + /** + * Specifies if the DB instance is a Multi-AZ deployment. + */ + MultiAZ?: Boolean; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * Indicates that minor version patches are applied automatically. + */ + AutoMinorVersionUpgrade?: Boolean; + /** + * Contains the identifier of the source DB instance if this DB instance is a Read Replica. + */ + ReadReplicaSourceDBInstanceIdentifier?: String; + /** + * Contains one or more identifiers of the Read Replicas associated with this DB instance. + */ + ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList; + /** + * Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas. Currently, each RDS DB instance can have only one Aurora Read Replica. + */ + ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList; + /** + * License model information for this DB instance. + */ + LicenseModel?: String; + /** + * Specifies the Provisioned IOPS (I/O operations per second) value. + */ + Iops?: IntegerOptional; + /** + * Provides the list of option group memberships for this DB instance. + */ + OptionGroupMemberships?: OptionGroupMembershipList; + /** + * If present, specifies the name of the character set that this instance is associated with. + */ + CharacterSetName?: String; + /** + * If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. + */ + SecondaryAvailabilityZone?: String; + /** + * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. + */ + PubliclyAccessible?: Boolean; + /** + * The status of a Read Replica. If the instance is not a Read Replica, this is blank. + */ + StatusInfos?: DBInstanceStatusInfoList; + /** + * Specifies the storage type associated with DB instance. + */ + StorageType?: String; + /** + * The ARN from the key store with which the instance is associated for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port. + */ + DbInstancePort?: Integer; + /** + * If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. + */ + DBClusterIdentifier?: String; + /** + * Specifies whether the DB instance is encrypted. + */ + StorageEncrypted?: Boolean; + /** + * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance. + */ + KmsKeyId?: String; + /** + * The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. + */ + DbiResourceId?: String; + /** + * The identifier of the CA certificate for this DB instance. + */ + CACertificateIdentifier?: String; + /** + * The Active Directory Domain membership records associated with the DB instance. + */ + DomainMemberships?: DomainMembershipList; + /** + * Specifies whether tags are copied from the DB instance to snapshots of the DB instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster. + */ + CopyTagsToSnapshot?: Boolean; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. + */ + MonitoringInterval?: IntegerOptional; + /** + * The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance. + */ + EnhancedMonitoringResourceArn?: String; + /** + * The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. + */ + MonitoringRoleArn?: String; + /** + * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. + */ + PromotionTier?: IntegerOptional; + /** + * The Amazon Resource Name (ARN) for the DB instance. + */ + DBInstanceArn?: String; + /** + * The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified. + */ + Timezone?: String; + /** + * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. IAM database authentication can be enabled for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + /** + * True if Performance Insights is enabled for the DB instance, and otherwise false. + */ + PerformanceInsightsEnabled?: BooleanOptional; + /** + * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). + */ + PerformanceInsightsRetentionPeriod?: IntegerOptional; + /** + * A list of log types that this DB instance is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide. + */ + EnabledCloudwatchLogsExports?: LogTypeList; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance. + */ + DeletionProtection?: Boolean; + /** + * The AWS Identity and Access Management (IAM) roles associated with the DB instance. + */ + AssociatedRoles?: DBInstanceRoles; + /** + * Specifies the listener connection endpoint for SQL Server Always On. + */ + ListenerEndpoint?: Endpoint; + } + export interface DBInstanceAutomatedBackup { + /** + * The Amazon Resource Name (ARN) for the automated backup. + */ + DBInstanceArn?: String; + /** + * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region. + */ + DbiResourceId?: String; + /** + * The AWS Region associated with the automated backup. + */ + Region?: String; + /** + * The customer id of the instance that is/was associated with the automated backup. + */ + DBInstanceIdentifier?: String; + /** + * Earliest and latest time an instance can be restored to. + */ + RestoreWindow?: RestoreWindow; + /** + * Specifies the allocated storage size in gibibytes (GiB). + */ + AllocatedStorage?: Integer; + /** + * Provides a list of status information for an automated backup: active - automated backups for current instances retained - automated backups for deleted instances creating - automated backups that are waiting for the first automated snapshot to be available. + */ + Status?: String; + /** + * The port number that the automated backup used for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535 + */ + Port?: Integer; + /** + * The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones. + */ + AvailabilityZone?: String; + /** + * Provides the VPC ID associated with the DB instance + */ + VpcId?: String; + /** + * Provides the date and time that the DB instance was created. + */ + InstanceCreateTime?: TStamp; + /** + * The license model of an automated backup. + */ + MasterUsername?: String; + /** + * The name of the database engine for this automated backup. + */ + Engine?: String; + /** + * The version of the database engine for the automated backup. + */ + EngineVersion?: String; + /** + * License model information for the automated backup. + */ + LicenseModel?: String; + /** + * The IOPS (I/O operations per second) value for the automated backup. + */ + Iops?: IntegerOptional; + /** + * The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used. + */ + OptionGroupName?: String; + /** + * The ARN from the key store with which the automated backup is associated for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * Specifies whether the automated backup is encrypted. + */ + Encrypted?: Boolean; + /** + * Specifies the storage type associated with the automated backup. + */ + StorageType?: String; + /** + * The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + KmsKeyId?: String; + /** + * The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified. + */ + Timezone?: String; + /** + * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + } + export type DBInstanceAutomatedBackupList = DBInstanceAutomatedBackup[]; + export interface DBInstanceAutomatedBackupMessage { + /** + * 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 MaxRecords . + */ + Marker?: String; + /** + * A list of DBInstanceAutomatedBackup instances. + */ + DBInstanceAutomatedBackups?: DBInstanceAutomatedBackupList; + } + export type DBInstanceList = DBInstance[]; + export interface DBInstanceMessage { + /** + * 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 MaxRecords . + */ + Marker?: String; + /** + * A list of DBInstance instances. + */ + DBInstances?: DBInstanceList; + } + export interface DBInstanceRole { + /** + * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. + */ + RoleArn?: String; + /** + * The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion. + */ + FeatureName?: String; + /** + * Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf. PENDING - the IAM role ARN is being associated with the DB instance. INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf. + */ + Status?: String; + } + export type DBInstanceRoles = DBInstanceRole[]; + export interface DBInstanceStatusInfo { + /** + * This value is currently "read replication." + */ + StatusType?: String; + /** + * Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. + */ + Normal?: Boolean; + /** + * Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated. + */ + Status?: String; + /** + * Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank. + */ + Message?: String; + } + export type DBInstanceStatusInfoList = DBInstanceStatusInfo[]; + export interface DBParameterGroup { + /** + * Provides the name of the DB parameter group. + */ + DBParameterGroupName?: String; + /** + * Provides the name of the DB parameter group family that this DB parameter group is compatible with. + */ + DBParameterGroupFamily?: String; + /** + * Provides the customer-specified description for this DB parameter group. + */ + Description?: String; + /** + * The Amazon Resource Name (ARN) for the DB parameter group. + */ + DBParameterGroupArn?: String; + } + export interface DBParameterGroupDetails { + /** + * A list of Parameter values. + */ + Parameters?: ParametersList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export type DBParameterGroupList = DBParameterGroup[]; + export interface DBParameterGroupNameMessage { + /** + * Provides the name of the DB parameter group. + */ + DBParameterGroupName?: String; + } + export interface DBParameterGroupStatus { + /** + * The name of the DP parameter group. + */ + DBParameterGroupName?: String; + /** + * The status of parameter updates. + */ + ParameterApplyStatus?: String; + } + export type DBParameterGroupStatusList = DBParameterGroupStatus[]; + export interface DBParameterGroupsMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBParameterGroup instances. + */ + DBParameterGroups?: DBParameterGroupList; + } + export interface DBSecurityGroup { + /** + * Provides the AWS ID of the owner of a specific DB security group. + */ + OwnerId?: String; + /** + * Specifies the name of the DB security group. + */ + DBSecurityGroupName?: String; + /** + * Provides the description of the DB security group. + */ + DBSecurityGroupDescription?: String; + /** + * Provides the VpcId of the DB security group. + */ + VpcId?: String; + /** + * Contains a list of EC2SecurityGroup elements. + */ + EC2SecurityGroups?: EC2SecurityGroupList; + /** + * Contains a list of IPRange elements. + */ + IPRanges?: IPRangeList; + /** + * The Amazon Resource Name (ARN) for the DB security group. + */ + DBSecurityGroupArn?: String; + } + export interface DBSecurityGroupMembership { + /** + * The name of the DB security group. + */ + DBSecurityGroupName?: String; + /** + * The status of the DB security group. + */ + Status?: String; + } + export type DBSecurityGroupMembershipList = DBSecurityGroupMembership[]; + export interface DBSecurityGroupMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBSecurityGroup instances. + */ + DBSecurityGroups?: DBSecurityGroups; + } + export type DBSecurityGroupNameList = String[]; + export type DBSecurityGroups = DBSecurityGroup[]; + export interface DBSnapshot { + /** + * Specifies the identifier for the DB snapshot. + */ + DBSnapshotIdentifier?: String; + /** + * Specifies the DB instance identifier of the DB instance this DB snapshot was created from. + */ + DBInstanceIdentifier?: String; + /** + * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). + */ + SnapshotCreateTime?: TStamp; + /** + * Specifies the name of the database engine. + */ + Engine?: String; + /** + * Specifies the allocated storage size in gibibytes (GiB). + */ + AllocatedStorage?: Integer; + /** + * Specifies the status of this DB snapshot. + */ + Status?: String; + /** + * Specifies the port that the database engine was listening on at the time of the snapshot. + */ + Port?: Integer; + /** + * Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot. + */ + AvailabilityZone?: String; + /** + * Provides the VPC ID associated with the DB snapshot. + */ + VpcId?: String; + /** + * Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC). + */ + InstanceCreateTime?: TStamp; + /** + * Provides the master username for the DB snapshot. + */ + MasterUsername?: String; + /** + * Specifies the version of the database engine. + */ + EngineVersion?: String; + /** + * License model information for the restored DB instance. + */ + LicenseModel?: String; + /** + * Provides the type of the DB snapshot. + */ + SnapshotType?: String; + /** + * Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot. + */ + Iops?: IntegerOptional; + /** + * Provides the option group name for the DB snapshot. + */ + OptionGroupName?: String; + /** + * The percentage of the estimated data that has been transferred. + */ + PercentProgress?: Integer; + /** + * The AWS Region that the DB snapshot was created in or copied from. + */ + SourceRegion?: String; + /** + * The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy. + */ + SourceDBSnapshotIdentifier?: String; + /** + * Specifies the storage type associated with DB snapshot. + */ + StorageType?: String; + /** + * The ARN from the key store with which to associate the instance for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * Specifies whether the DB snapshot is encrypted. + */ + Encrypted?: Boolean; + /** + * If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot. + */ + KmsKeyId?: String; + /** + * The Amazon Resource Name (ARN) for the DB snapshot. + */ + DBSnapshotArn?: String; + /** + * The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. + */ + Timezone?: String; + /** + * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. + */ + IAMDatabaseAuthenticationEnabled?: Boolean; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region. + */ + DbiResourceId?: String; + } + export interface DBSnapshotAttribute { + /** + * The name of the manual DB snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action. + */ + AttributeName?: String; + /** + * The value or values for the manual DB snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore. + */ + AttributeValues?: AttributeValueList; + } + export type DBSnapshotAttributeList = DBSnapshotAttribute[]; + export interface DBSnapshotAttributesResult { + /** + * The identifier of the manual DB snapshot that the attributes apply to. + */ + DBSnapshotIdentifier?: String; + /** + * The list of attributes and values for the manual DB snapshot. + */ + DBSnapshotAttributes?: DBSnapshotAttributeList; + } + export type DBSnapshotList = DBSnapshot[]; + export interface DBSnapshotMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBSnapshot instances. + */ + DBSnapshots?: DBSnapshotList; + } + export interface DBSubnetGroup { + /** + * The name of the DB subnet group. + */ + DBSubnetGroupName?: String; + /** + * Provides the description of the DB subnet group. + */ + DBSubnetGroupDescription?: String; + /** + * Provides the VpcId of the DB subnet group. + */ + VpcId?: String; + /** + * Provides the status of the DB subnet group. + */ + SubnetGroupStatus?: String; + /** + * Contains a list of Subnet elements. + */ + Subnets?: SubnetList; + /** + * The Amazon Resource Name (ARN) for the DB subnet group. + */ + DBSubnetGroupArn?: String; + } + export interface DBSubnetGroupMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of DBSubnetGroup instances. + */ + DBSubnetGroups?: DBSubnetGroups; + } + export type DBSubnetGroups = DBSubnetGroup[]; + export interface DeleteDBClusterEndpointMessage { + /** + * The identifier associated with the custom endpoint. This parameter is stored as a lowercase string. + */ + DBClusterEndpointIdentifier: String; + } + export interface DeleteDBClusterMessage { + /** + * The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: Must match an existing DBClusterIdentifier. + */ + DBClusterIdentifier: String; + /** + * Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted. You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false. Default: false + */ + SkipFinalSnapshot?: Boolean; + /** + * The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens + */ + FinalDBSnapshotIdentifier?: String; + } + export interface DeleteDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You can't delete a default DB cluster parameter group. Can't be associated with any DB clusters. + */ + DBClusterParameterGroupName: String; + } + export interface DeleteDBClusterResult { + DBCluster?: DBCluster; + } + export interface DeleteDBClusterSnapshotMessage { + /** + * The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state. + */ + DBClusterSnapshotIdentifier: String; + } + export interface DeleteDBClusterSnapshotResult { + DBClusterSnapshot?: DBClusterSnapshot; + } + export interface DeleteDBInstanceAutomatedBackupMessage { + /** + * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region. + */ + DbiResourceId: String; + } + export interface DeleteDBInstanceAutomatedBackupResult { + DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup; + } + export interface DeleteDBInstanceMessage { + /** + * The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: Must match the name of an existing DB instance. + */ + DBInstanceIdentifier: String; + /** + * A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted. When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. Specify true when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false. Default: false + */ + SkipFinalSnapshot?: Boolean; + /** + * The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Can't be specified when deleting a Read Replica. + */ + FinalDBSnapshotIdentifier?: String; + /** + * A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. This parameter defaults to true. + */ + DeleteAutomatedBackups?: BooleanOptional; + } + export interface DeleteDBInstanceResult { + DBInstance?: DBInstance; + } + export interface DeleteDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: Must be the name of an existing DB parameter group You can't delete a default DB parameter group Can't be associated with any DB instances + */ + DBParameterGroupName: String; + } + export interface DeleteDBSecurityGroupMessage { + /** + * The name of the DB security group to delete. You can't delete the default DB security group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Must not be "Default" + */ + DBSecurityGroupName: String; + } + export interface DeleteDBSnapshotMessage { + /** + * The DB snapshot identifier. Constraints: Must be the name of an existing DB snapshot in the available state. + */ + DBSnapshotIdentifier: String; + } + export interface DeleteDBSnapshotResult { + DBSnapshot?: DBSnapshot; + } + export interface DeleteDBSubnetGroupMessage { + /** + * The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + } + export interface DeleteEventSubscriptionMessage { + /** + * The name of the RDS event notification subscription you want to delete. + */ + SubscriptionName: String; + } + export interface DeleteEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface DeleteGlobalClusterMessage { + /** + * The cluster identifier of the global database cluster being deleted. + */ + GlobalClusterIdentifier: String; + } + export interface DeleteGlobalClusterResult { + GlobalCluster?: GlobalCluster; + } + export interface DeleteOptionGroupMessage { + /** + * The name of the option group to be deleted. You can't delete default option groups. + */ + OptionGroupName: String; + } + export interface DescribeAccountAttributesMessage { + } + export interface DescribeCertificatesMessage { + /** + * The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive. Constraints: Must match an existing CertificateIdentifier. + */ + CertificateIdentifier?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterBacktracksMessage { + /** + * The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1 + */ + DBClusterIdentifier: String; + /** + * If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace. Example: 123e4567-e89b-12d3-a456-426655440000 + */ + BacktrackIdentifier?: String; + /** + * A filter that specifies one or more DB clusters to describe. Supported filters include the following: db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers. db-cluster-backtrack-status - Accepts any of the following backtrack status values: applying completed failed pending The results list includes information about only the backtracks identified by these values. For more information about backtrack status values, see DBClusterBacktrack. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterEndpointsMessage { + /** + * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. + */ + DBClusterIdentifier?: String; + /** + * The identifier of the endpoint to describe. This parameter is stored as a lowercase string. + */ + DBClusterEndpointIdentifier?: String; + /** + * A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterParameterGroupsMessage { + /** + * The name of a specific DB cluster parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterParametersMessage { + /** + * The name of a specific DB cluster parameter group to return parameter details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName: String; + /** + * A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer. + */ + Source?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBClusterSnapshotAttributesMessage { + /** + * The identifier for the DB cluster snapshot to describe the attributes for. + */ + DBClusterSnapshotIdentifier: String; + } + export interface DescribeDBClusterSnapshotAttributesResult { + DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; + } + export interface DescribeDBClusterSnapshotsMessage { + /** + * The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier?: String; + /** + * A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified. + */ + DBClusterSnapshotIdentifier?: String; + /** + * The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB cluster snapshots that have been taken by my AWS account. shared - Return all manual DB cluster snapshots that have been shared to my AWS account. public - Return all DB cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public. + */ + SnapshotType?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false. You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action. + */ + IncludeShared?: Boolean; + /** + * True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. The default is false. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. + */ + IncludePublic?: Boolean; + } + export interface DescribeDBClustersMessage { + /** + * The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match an existing DBClusterIdentifier. + */ + DBClusterIdentifier?: String; + /** + * A filter that specifies one or more DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBEngineVersionsMessage { + /** + * The database engine to return. + */ + Engine?: String; + /** + * The database engine version to return. Example: 5.1.49 + */ + EngineVersion?: String; + /** + * The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DBParameterGroupFamily. + */ + DBParameterGroupFamily?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * Indicates that only the default version of the specified engine or engine and major version combination is returned. + */ + DefaultOnly?: Boolean; + /** + * If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version. + */ + ListSupportedCharacterSets?: BooleanOptional; + /** + * If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version. + */ + ListSupportedTimezones?: BooleanOptional; + } + export interface DescribeDBInstanceAutomatedBackupsMessage { + /** + * The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive. + */ + DbiResourceId?: String; + /** + * (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive. + */ + DBInstanceIdentifier?: String; + /** + * A filter that specifies which resources to return based on status. Supported filters are the following: status active - automated backups for current instances retained - automated backups for deleted instances creating - automated backups that are waiting for the first automated snapshot to be available db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs. dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance resources identified by these ARNs. Returns all resources by default. The status for each resource is specified in the response. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. + */ + MaxRecords?: IntegerOptional; + /** + * The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBInstancesMessage { + /** + * The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier?: String; + /** + * A filter that specifies one or more DB instances to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBLogFilesDetails { + /** + * The name of the log file for the specified DB instance. + */ + LogFileName?: String; + /** + * A POSIX timestamp when the last log entry was written. + */ + LastWritten?: Long; + /** + * The size, in bytes, of the log file for the specified DB instance. + */ + Size?: Long; + } + export type DescribeDBLogFilesList = DescribeDBLogFilesDetails[]; + export interface DescribeDBLogFilesMessage { + /** + * The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * Filters the available log files for log file names that contain the specified string. + */ + FilenameContains?: String; + /** + * Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds. + */ + FileLastWritten?: Long; + /** + * Filters the available log files for files larger than the specified size. + */ + FileSize?: Long; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. + */ + MaxRecords?: IntegerOptional; + /** + * The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBLogFilesResponse { + /** + * The DB log files returned. + */ + DescribeDBLogFiles?: DescribeDBLogFilesList; + /** + * A pagination token that can be used in a subsequent DescribeDBLogFiles request. + */ + Marker?: String; + } + export interface DescribeDBParameterGroupsMessage { + /** + * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBParameterGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBParametersMessage { + /** + * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBParameterGroup. + */ + DBParameterGroupName: String; + /** + * The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default + */ + Source?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBSecurityGroupsMessage { + /** + * The name of the DB security group to return details for. + */ + DBSecurityGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeDBSnapshotAttributesMessage { + /** + * The identifier for the DB snapshot to describe the attributes for. + */ + DBSnapshotIdentifier: String; + } + export interface DescribeDBSnapshotAttributesResult { + DBSnapshotAttributesResult?: DBSnapshotAttributesResult; + } + export interface DescribeDBSnapshotsMessage { + /** + * The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier?: String; + /** + * A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified. + */ + DBSnapshotIdentifier?: String; + /** + * The type of snapshots to be returned. You can specify one of the following values: automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB snapshots that have been taken by my AWS account. shared - Return all manual DB snapshots that have been shared to my AWS account. public - Return all DB snapshots that have been marked as public. awsbackup - Return the DB snapshots managed by the AWS Backup service. For information about AWS Backup, see the AWS Backup Developer Guide. The awsbackup type does not apply to Aurora. If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public. + */ + SnapshotType?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false. You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action. + */ + IncludeShared?: Boolean; + /** + * True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. + */ + IncludePublic?: Boolean; + /** + * A specific DB resource ID to describe. + */ + DbiResourceId?: String; + } + export interface DescribeDBSubnetGroupsMessage { + /** + * The name of the DB subnet group to return details for. + */ + DBSubnetGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultClusterParametersMessage { + /** + * The name of the DB cluster parameter group family to return engine parameter information for. + */ + DBParameterGroupFamily: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultClusterParametersResult { + EngineDefaults?: EngineDefaults; + } + export interface DescribeEngineDefaultParametersMessage { + /** + * The name of the DB parameter group family. + */ + DBParameterGroupFamily: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeEngineDefaultParametersResult { + EngineDefaults?: EngineDefaults; + } + export interface DescribeEventCategoriesMessage { + /** + * The type of source that is generating the events. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot + */ + SourceType?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + } + export interface DescribeEventSubscriptionsMessage { + /** + * The name of the RDS event notification subscription you want to describe. + */ + SubscriptionName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export interface DescribeEventsMessage { + /** + * The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. If the source type is DBInstance, then a DBInstanceIdentifier must be supplied. If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied. If the source type is DBParameterGroup, a DBParameterGroupName must be supplied. If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied. Can't end with a hyphen or contain two consecutive hyphens. + */ + SourceIdentifier?: String; + /** + * The event source to retrieve events for. If no value is specified, all events are returned. + */ + SourceType?: SourceType; + /** + * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z + */ + StartTime?: TStamp; + /** + * The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z + */ + EndTime?: TStamp; + /** + * The number of minutes to retrieve events for. Default: 60 + */ + Duration?: IntegerOptional; + /** + * A list of event categories that trigger notifications for a event notification subscription. + */ + EventCategories?: EventCategoriesList; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeGlobalClustersMessage { + /** + * The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match an existing DBClusterIdentifier. + */ + GlobalClusterIdentifier?: String; + /** + * A filter that specifies one or more global DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + } + export interface DescribeOptionGroupOptionsMessage { + /** + * A required parameter. Options available for the given engine name are described. + */ + EngineName: String; + /** + * If specified, filters the results to include only options for the specified major engine version. + */ + MajorEngineVersion?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeOptionGroupsMessage { + /** + * The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion. + */ + OptionGroupName?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * Filters the list of option groups to only include groups associated with a specific database engine. + */ + EngineName?: String; + /** + * Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified. + */ + MajorEngineVersion?: String; + } + export interface DescribeOrderableDBInstanceOptionsMessage { + /** + * The name of the engine to retrieve DB instance options for. + */ + Engine: String; + /** + * The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. + */ + EngineVersion?: String; + /** + * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. + */ + DBInstanceClass?: String; + /** + * The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. + */ + LicenseModel?: String; + /** + * The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. + */ + Vpc?: BooleanOptional; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export interface DescribePendingMaintenanceActionsMessage { + /** + * The ARN of a resource to return pending maintenance actions for. + */ + ResourceIdentifier?: String; + /** + * A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs. + */ + Filters?: FilterList; + /** + * An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords. + */ + Marker?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + } + export interface DescribeReservedDBInstancesMessage { + /** + * The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. + */ + ReservedDBInstanceId?: String; + /** + * The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. + */ + ReservedDBInstancesOfferingId?: String; + /** + * The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. + */ + DBInstanceClass?: String; + /** + * The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000 + */ + Duration?: String; + /** + * The product description filter value. Specify this parameter to show only those reservations matching the specified product description. + */ + ProductDescription?: String; + /** + * The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront" + */ + OfferingType?: String; + /** + * The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter. + */ + MultiAZ?: BooleanOptional; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeReservedDBInstancesOfferingsMessage { + /** + * The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 + */ + ReservedDBInstancesOfferingId?: String; + /** + * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. + */ + DBInstanceClass?: String; + /** + * Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000 + */ + Duration?: String; + /** + * Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description. The results show offerings that partially match the filter value. + */ + ProductDescription?: String; + /** + * The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront" + */ + OfferingType?: String; + /** + * The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter. + */ + MultiAZ?: BooleanOptional; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + /** + * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface DescribeSourceRegionsMessage { + /** + * The source AWS Region name. For example, us-east-1. Constraints: Must specify a valid AWS Region name. + */ + RegionName?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + } + export interface DescribeValidDBInstanceModificationsMessage { + /** + * The customer identifier or the ARN of your DB instance. + */ + DBInstanceIdentifier: String; + } + export interface DescribeValidDBInstanceModificationsResult { + ValidDBInstanceModificationsMessage?: ValidDBInstanceModificationsMessage; + } + export interface DomainMembership { + /** + * The identifier of the Active Directory Domain. + */ + Domain?: String; + /** + * The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc). + */ + Status?: String; + /** + * The fully qualified domain name of the Active Directory Domain. + */ + FQDN?: String; + /** + * The name of the IAM role to be used when making API calls to the Directory Service. + */ + IAMRoleName?: String; + } + export type DomainMembershipList = DomainMembership[]; + export type Double = number; + export type DoubleOptional = number; + export interface DoubleRange { + /** + * The minimum value in the range. + */ + From?: Double; + /** + * The maximum value in the range. + */ + To?: Double; + } + export type DoubleRangeList = DoubleRange[]; + export interface DownloadDBLogFilePortionDetails { + /** + * Entries from the specified log file. + */ + LogFileData?: String; + /** + * A pagination token that can be used in a subsequent DownloadDBLogFilePortion request. + */ + Marker?: String; + /** + * Boolean value that if true, indicates there is more data to be downloaded. + */ + AdditionalDataPending?: Boolean; + } + export interface DownloadDBLogFilePortionMessage { + /** + * The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * The name of the log file to be downloaded. + */ + LogFileName: String; + /** + * The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines. + */ + Marker?: String; + /** + * The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size. If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first. If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned. If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned. You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false. + */ + NumberOfLines?: Integer; + } + export interface EC2SecurityGroup { + /** + * Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked". + */ + Status?: String; + /** + * Specifies the name of the EC2 security group. + */ + EC2SecurityGroupName?: String; + /** + * Specifies the id of the EC2 security group. + */ + EC2SecurityGroupId?: String; + /** + * Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field. + */ + EC2SecurityGroupOwnerId?: String; + } + export type EC2SecurityGroupList = EC2SecurityGroup[]; + export interface Endpoint { + /** + * Specifies the DNS address of the DB instance. + */ + Address?: String; + /** + * Specifies the port that the database engine is listening on. + */ + Port?: Integer; + /** + * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + */ + HostedZoneId?: String; + } + export interface EngineDefaults { + /** + * Specifies the name of the DB parameter group family that the engine default parameters apply to. + */ + DBParameterGroupFamily?: String; + /** + * An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + /** + * Contains a list of engine default parameters. + */ + Parameters?: ParametersList; + } + export type EngineModeList = String[]; + export interface Event { + /** + * Provides the identifier for the source of the event. + */ + SourceIdentifier?: String; + /** + * Specifies the source type for this event. + */ + SourceType?: SourceType; + /** + * Provides the text of this event. + */ + Message?: String; + /** + * Specifies the category for the event. + */ + EventCategories?: EventCategoriesList; + /** + * Specifies the date and time of the event. + */ + Date?: TStamp; + /** + * The Amazon Resource Name (ARN) for the event. + */ + SourceArn?: String; + } + export type EventCategoriesList = String[]; + export interface EventCategoriesMap { + /** + * The source type that the returned categories belong to + */ + SourceType?: String; + /** + * The event categories for the specified source type + */ + EventCategories?: EventCategoriesList; + } + export type EventCategoriesMapList = EventCategoriesMap[]; + export interface EventCategoriesMessage { + /** + * A list of EventCategoriesMap data types. + */ + EventCategoriesMapList?: EventCategoriesMapList; + } + export type EventList = Event[]; + export interface EventSubscription { + /** + * The AWS customer account associated with the RDS event notification subscription. + */ + CustomerAwsId?: String; + /** + * The RDS event notification subscription Id. + */ + CustSubscriptionId?: String; + /** + * The topic ARN of the RDS event notification subscription. + */ + SnsTopicArn?: String; + /** + * The status of the RDS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. + */ + Status?: String; + /** + * The time the RDS event notification subscription was created. + */ + SubscriptionCreationTime?: String; + /** + * The source type for the RDS event notification subscription. + */ + SourceType?: String; + /** + * A list of source IDs for the RDS event notification subscription. + */ + SourceIdsList?: SourceIdsList; + /** + * A list of event categories for the RDS event notification subscription. + */ + EventCategoriesList?: EventCategoriesList; + /** + * A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled. + */ + Enabled?: Boolean; + /** + * The Amazon Resource Name (ARN) for the event subscription. + */ + EventSubscriptionArn?: String; + } + export type EventSubscriptionsList = EventSubscription[]; + export interface EventSubscriptionsMessage { + /** + * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * A list of EventSubscriptions data types. + */ + EventSubscriptionsList?: EventSubscriptionsList; + } + export interface EventsMessage { + /** + * An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + /** + * A list of Event instances. + */ + Events?: EventList; + } + export interface FailoverDBClusterMessage { + /** + * A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier: String; + /** + * The name of the instance to promote to the primary instance. You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1. + */ + TargetDBInstanceIdentifier?: String; + } + export interface FailoverDBClusterResult { + DBCluster?: DBCluster; + } + export type FeatureNameList = String[]; + export interface Filter { + /** + * The name of the filter. Filter names are case-sensitive. + */ + Name: String; + /** + * One or more filter values. Filter values are case-sensitive. + */ + Values: FilterValueList; + } + export type FilterList = Filter[]; + export type FilterValueList = String[]; + export interface GlobalCluster { + /** + * Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. + */ + GlobalClusterIdentifier?: String; + /** + * The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. + */ + GlobalClusterResourceId?: String; + /** + * The Amazon Resource Name (ARN) for the global database cluster. + */ + GlobalClusterArn?: String; + /** + * Specifies the current state of this global database cluster. + */ + Status?: String; + /** + * The Aurora database engine used by the global database cluster. + */ + Engine?: String; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * The default database name within the new global database cluster. + */ + DatabaseName?: String; + /** + * The storage encryption setting for the global database cluster. + */ + StorageEncrypted?: BooleanOptional; + /** + * The deletion protection setting for the new global database cluster. + */ + DeletionProtection?: BooleanOptional; + /** + * The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item. + */ + GlobalClusterMembers?: GlobalClusterMemberList; + } + export type GlobalClusterList = GlobalCluster[]; + export interface GlobalClusterMember { + /** + * The Amazon Resource Name (ARN) for each Aurora cluster. + */ + DBClusterArn?: String; + /** + * The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database. + */ + Readers?: ReadersArnList; + /** + * Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated. + */ + IsWriter?: Boolean; + } + export type GlobalClusterMemberList = GlobalClusterMember[]; + export interface GlobalClustersMessage { + /** + * An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. + */ + Marker?: String; + /** + * The list of global clusters returned by this request. + */ + GlobalClusters?: GlobalClusterList; + } + export interface IPRange { + /** + * Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked". + */ + Status?: String; + /** + * Specifies the IP range. + */ + CIDRIP?: String; + } + export type IPRangeList = IPRange[]; + export type Integer = number; + export type IntegerOptional = number; + export type KeyList = String[]; + export interface ListTagsForResourceMessage { + /** + * The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. + */ + ResourceName: String; + /** + * This parameter is not currently supported. + */ + Filters?: FilterList; + } + export type LogTypeList = String[]; + export type Long = number; + export type LongOptional = number; + export interface MinimumEngineVersionPerAllowedValue { + /** + * The allowed value for an option setting. + */ + AllowedValue?: String; + /** + * The minimum DB engine version required for the allowed value. + */ + MinimumEngineVersion?: String; + } + export type MinimumEngineVersionPerAllowedValueList = MinimumEngineVersionPerAllowedValue[]; + export interface ModifyCurrentDBClusterCapacityMessage { + /** + * The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DB cluster. + */ + DBClusterIdentifier: String; + /** + * The DB cluster capacity. When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes. Constraints: Value must be 2, 4, 8, 16, 32, 64, 128, or 256. + */ + Capacity?: IntegerOptional; + /** + * The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Value must be from 10 through 600. + */ + SecondsBeforeTimeout?: IntegerOptional; + /** + * The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible. RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period. + */ + TimeoutAction?: String; + } + export interface ModifyDBClusterEndpointMessage { + /** + * The identifier of the endpoint to modify. This parameter is stored as a lowercase string. + */ + DBClusterEndpointIdentifier: String; + /** + * The type of the endpoint. One of: READER, ANY. + */ + EndpointType?: String; + /** + * List of DB instance identifiers that are part of the custom endpoint group. + */ + StaticMembers?: StringList; + /** + * List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. + */ + ExcludedMembers?: StringList; + } + export interface ModifyDBClusterMessage { + /** + * The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster. + */ + DBClusterIdentifier: String; + /** + * The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2 + */ + NewDBClusterIdentifier?: String; + /** + * A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. Default: false + */ + ApplyImmediately?: Boolean; + /** + * The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35 + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The name of the DB cluster parameter group to use for the DB cluster. + */ + DBClusterParameterGroupName?: String; + /** + * A list of VPC security groups that the DB cluster will belong to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster. + */ + Port?: IntegerOptional; + /** + * The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword?: String; + /** + * A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster. + */ + OptionGroupName?: String; + /** + * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). + */ + BacktrackWindow?: LongOptional; + /** + * The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. + */ + CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration; + /** + * The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true. For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions. + */ + EngineVersion?: String; + /** + * The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode. + */ + ScalingConfiguration?: ScalingConfiguration; + /** + * Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true. + */ + DeletionProtection?: BooleanOptional; + /** + * HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change. A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. + */ + EnableHttpEndpoint?: BooleanOptional; + /** + * True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + } + export interface ModifyDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group to modify. + */ + DBClusterParameterGroupName: String; + /** + * A list of parameters in the DB cluster parameter group to modify. + */ + Parameters: ParametersList; + } + export interface ModifyDBClusterResult { + DBCluster?: DBCluster; + } + export interface ModifyDBClusterSnapshotAttributeMessage { + /** + * The identifier for the DB cluster snapshot to modify the attributes for. + */ + DBClusterSnapshotIdentifier: String; + /** + * The name of the DB cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore. + */ + AttributeName: String; + /** + * A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. + */ + ValuesToAdd?: AttributeValueList; + /** + * A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot. + */ + ValuesToRemove?: AttributeValueList; + } + export interface ModifyDBClusterSnapshotAttributeResult { + DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; + } + export interface ModifyDBInstanceMessage { + /** + * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * The new amount of storage (in gibibytes) to allocate for the DB instance. For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. For the valid values for allocated storage for each engine, see CreateDBInstance. + */ + AllocatedStorage?: IntegerOptional; + /** + * The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request. Default: Uses existing setting + */ + DBInstanceClass?: String; + /** + * The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup + */ + DBSubnetGroupName?: String; + /** + * A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups. + */ + DBSecurityGroups?: DBSecurityGroupNameList; + /** + * A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes are applied. Default: false + */ + ApplyImmediately?: Boolean; + /** + * The new password for the master user. The password can include any printable ASCII character except "/", """, or "@". Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked. + */ + MasterUserPassword?: String; + /** + * The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance. + */ + DBParameterGroupName?: String; + /** + * The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting Constraints: Must be a value from 0 to 35 Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 or later Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5 Can't be set to 0 if the DB instance is a source to Read Replicas + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: Must be in the format hh24:mi-hh24:mi Must be in Universal Time Coordinated (UTC) Must not conflict with the preferred maintenance window Must be at least 30 minutes + */ + PreferredBackupWindow?: String; + /** + * The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes + */ + PreferredMaintenanceWindow?: String; + /** + * Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. + */ + MultiAZ?: BooleanOptional; + /** + * The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. + */ + EngineVersion?: String; + /** + * Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. + */ + AllowMajorVersionUpgrade?: Boolean; + /** + * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license + */ + LicenseModel?: String; + /** + * The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Default: Uses existing setting + */ + Iops?: IntegerOptional; + /** + * Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance + */ + OptionGroupName?: String; + /** + * The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance + */ + NewDBInstanceIdentifier?: String; + /** + * Specifies the storage type to be associated with the DB instance. If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. Valid values: standard | gp2 | io1 Default: io1 if the Iops parameter is specified, otherwise standard + */ + StorageType?: String; + /** + * The ARN from the key store with which to associate the instance for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * The password for the given ARN from the key store in order to access the device. + */ + TdeCredentialPassword?: String; + /** + * Indicates the certificate that needs to be associated with the instance. + */ + CACertificateIdentifier?: String; + /** + * The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain. + */ + Domain?: String; + /** + * True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 + */ + MonitoringInterval?: IntegerOptional; + /** + * The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter. MySQL Default: 3306 Valid Values: 1150-65535 MariaDB Default: 3306 Valid Values: 1150-65535 PostgreSQL Default: 5432 Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: 1150-65535 SQL Server Default: 1433 Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156. Amazon Aurora Default: 3306 Valid Values: 1150-65535 + */ + DBPortNumber?: IntegerOptional; + /** + * Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address. PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter. Default: false + */ + PubliclyAccessible?: BooleanOptional; + /** + * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. + */ + MonitoringRoleArn?: String; + /** + * The name of the IAM role to use when making API calls to the Directory Service. + */ + DomainIAMRoleName?: String; + /** + * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15 + */ + PromotionTier?: IntegerOptional; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster. MySQL For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * True to enable Performance Insights for the DB instance, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide. + */ + EnablePerformanceInsights?: BooleanOptional; + /** + * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). + */ + PerformanceInsightsRetentionPeriod?: IntegerOptional; + /** + * The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect. + */ + CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * A value that specifies that the DB instance class of the DB instance uses its default processor features. + */ + UseDefaultProcessorFeatures?: BooleanOptional; + /** + * Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance. + */ + DeletionProtection?: BooleanOptional; + } + export interface ModifyDBInstanceResult { + DBInstance?: DBInstance; + } + export interface ModifyDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: If supplied, must match the name of an existing DBParameterGroup. + */ + DBParameterGroupName: String; + /** + * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. + */ + Parameters: ParametersList; + } + export interface ModifyDBSnapshotAttributeMessage { + /** + * The identifier for the DB snapshot to modify the attributes for. + */ + DBSnapshotIdentifier: String; + /** + * The name of the DB snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore. + */ + AttributeName: String; + /** + * A list of DB snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. + */ + ValuesToAdd?: AttributeValueList; + /** + * A list of DB snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot. + */ + ValuesToRemove?: AttributeValueList; + } + export interface ModifyDBSnapshotAttributeResult { + DBSnapshotAttributesResult?: DBSnapshotAttributesResult; + } + export interface ModifyDBSnapshotMessage { + /** + * The identifier of the DB snapshot to modify. + */ + DBSnapshotIdentifier: String; + /** + * The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. MySQL 5.5.46 (supported for 5.1 DB snapshots) Oracle 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) + */ + EngineVersion?: String; + /** + * The option group to identify with the upgraded DB snapshot. You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide. + */ + OptionGroupName?: String; + } + export interface ModifyDBSnapshotResult { + DBSnapshot?: DBSnapshot; + } + export interface ModifyDBSubnetGroupMessage { + /** + * The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + */ + DBSubnetGroupName: String; + /** + * The description for the DB subnet group. + */ + DBSubnetGroupDescription?: String; + /** + * The EC2 subnet IDs for the DB subnet group. + */ + SubnetIds: SubnetIdentifierList; + } + export interface ModifyDBSubnetGroupResult { + DBSubnetGroup?: DBSubnetGroup; + } + export interface ModifyEventSubscriptionMessage { + /** + * The name of the RDS event notification subscription. + */ + SubscriptionName: String; + /** + * The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + */ + SnsTopicArn?: String; + /** + * The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot + */ + SourceType?: String; + /** + * A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. + */ + EventCategories?: EventCategoriesList; + /** + * A Boolean value; set to true to activate the subscription. + */ + Enabled?: BooleanOptional; + } + export interface ModifyEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface ModifyGlobalClusterMessage { + /** + * The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing global database cluster. + */ + GlobalClusterIdentifier?: String; + /** + * The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2 + */ + NewGlobalClusterIdentifier?: String; + /** + * Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when this value is set to true. + */ + DeletionProtection?: BooleanOptional; + } + export interface ModifyGlobalClusterResult { + GlobalCluster?: GlobalCluster; + } + export interface ModifyOptionGroupMessage { + /** + * The name of the option group to be modified. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance + */ + OptionGroupName: String; + /** + * Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration. + */ + OptionsToInclude?: OptionConfigurationList; + /** + * Options in this list are removed from the option group. + */ + OptionsToRemove?: OptionNamesList; + /** + * Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group. + */ + ApplyImmediately?: Boolean; + } + export interface ModifyOptionGroupResult { + OptionGroup?: OptionGroup; + } + export interface Option { + /** + * The name of the option. + */ + OptionName?: String; + /** + * The description of the option. + */ + OptionDescription?: String; + /** + * Indicate if this option is persistent. + */ + Persistent?: Boolean; + /** + * Indicate if this option is permanent. + */ + Permanent?: Boolean; + /** + * If required, the port configured for this option to use. + */ + Port?: IntegerOptional; + /** + * The version of the option. + */ + OptionVersion?: String; + /** + * The option settings for this option. + */ + OptionSettings?: OptionSettingConfigurationList; + /** + * If the option requires access to a port, then this DB security group allows access to the port. + */ + DBSecurityGroupMemberships?: DBSecurityGroupMembershipList; + /** + * If the option requires access to a port, then this VPC security group allows access to the port. + */ + VpcSecurityGroupMemberships?: VpcSecurityGroupMembershipList; + } + export interface OptionConfiguration { + /** + * The configuration of options to include in a group. + */ + OptionName: String; + /** + * The optional port for the option. + */ + Port?: IntegerOptional; + /** + * The version for the option. + */ + OptionVersion?: String; + /** + * A list of DBSecurityGroupMembership name strings used for this option. + */ + DBSecurityGroupMemberships?: DBSecurityGroupNameList; + /** + * A list of VpcSecurityGroupMembership name strings used for this option. + */ + VpcSecurityGroupMemberships?: VpcSecurityGroupIdList; + /** + * The option settings to include in an option group. + */ + OptionSettings?: OptionSettingsList; + } + export type OptionConfigurationList = OptionConfiguration[]; + export interface OptionGroup { + /** + * Specifies the name of the option group. + */ + OptionGroupName?: String; + /** + * Provides a description of the option group. + */ + OptionGroupDescription?: String; + /** + * Indicates the name of the engine that this option group can be applied to. + */ + EngineName?: String; + /** + * Indicates the major engine version associated with this option group. + */ + MajorEngineVersion?: String; + /** + * Indicates what options are available in the option group. + */ + Options?: OptionsList; + /** + * Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances. + */ + AllowsVpcAndNonVpcInstanceMemberships?: Boolean; + /** + * If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field. + */ + VpcId?: String; + /** + * The Amazon Resource Name (ARN) for the option group. + */ + OptionGroupArn?: String; + } + export interface OptionGroupMembership { + /** + * The name of the option group that the instance belongs to. + */ + OptionGroupName?: String; + /** + * The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed. + */ + Status?: String; + } + export type OptionGroupMembershipList = OptionGroupMembership[]; + export interface OptionGroupOption { + /** + * The name of the option. + */ + Name?: String; + /** + * The description of the option. + */ + Description?: String; + /** + * The name of the engine that this option can be applied to. + */ + EngineName?: String; + /** + * Indicates the major engine version that the option is available for. + */ + MajorEngineVersion?: String; + /** + * The minimum required engine version for the option to be applied. + */ + MinimumRequiredMinorEngineVersion?: String; + /** + * Specifies whether the option requires a port. + */ + PortRequired?: Boolean; + /** + * If the option requires a port, specifies the default port for the option. + */ + DefaultPort?: IntegerOptional; + /** + * The options that are prerequisites for this option. + */ + OptionsDependedOn?: OptionsDependedOn; + /** + * The options that conflict with this option. + */ + OptionsConflictsWith?: OptionsConflictsWith; + /** + * Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group. + */ + Persistent?: Boolean; + /** + * Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance. + */ + Permanent?: Boolean; + /** + * If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later. + */ + RequiresAutoMinorEngineVersionUpgrade?: Boolean; + /** + * If true, you can only use this option with a DB instance that is in a VPC. + */ + VpcOnly?: Boolean; + /** + * If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available. + */ + SupportsOptionVersionDowngrade?: BooleanOptional; + /** + * The option settings that are available (and the default value) for each option in an option group. + */ + OptionGroupOptionSettings?: OptionGroupOptionSettingsList; + /** + * The versions that are available for the option. + */ + OptionGroupOptionVersions?: OptionGroupOptionVersionsList; + } + export interface OptionGroupOptionSetting { + /** + * The name of the option group option. + */ + SettingName?: String; + /** + * The description of the option group option. + */ + SettingDescription?: String; + /** + * The default value for the option group option. + */ + DefaultValue?: String; + /** + * The DB engine specific parameter type for the option group option. + */ + ApplyType?: String; + /** + * Indicates the acceptable values for the option group option. + */ + AllowedValues?: String; + /** + * Boolean value where true indicates that this option group option can be changed from the default value. + */ + IsModifiable?: Boolean; + /** + * Boolean value where true indicates that a value must be specified for this option setting of the option group option. + */ + IsRequired?: Boolean; + /** + * The minimum DB engine version required for the corresponding allowed value for this option setting. + */ + MinimumEngineVersionPerAllowedValue?: MinimumEngineVersionPerAllowedValueList; + } + export type OptionGroupOptionSettingsList = OptionGroupOptionSetting[]; + export type OptionGroupOptionVersionsList = OptionVersion[]; + export type OptionGroupOptionsList = OptionGroupOption[]; + export interface OptionGroupOptionsMessage { + OptionGroupOptions?: OptionGroupOptionsList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export interface OptionGroups { + /** + * List of option groups. + */ + OptionGroupsList?: OptionGroupsList; + /** + * 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 MaxRecords. + */ + Marker?: String; + } + export type OptionGroupsList = OptionGroup[]; + export type OptionNamesList = String[]; + export interface OptionSetting { + /** + * The name of the option that has settings that you can set. + */ + Name?: String; + /** + * The current value of the option setting. + */ + Value?: String; + /** + * The default value of the option setting. + */ + DefaultValue?: String; + /** + * The description of the option setting. + */ + Description?: String; + /** + * The DB engine specific parameter type. + */ + ApplyType?: String; + /** + * The data type of the option setting. + */ + DataType?: String; + /** + * The allowed values of the option setting. + */ + AllowedValues?: String; + /** + * A Boolean value that, when true, indicates the option setting can be modified from the default. + */ + IsModifiable?: Boolean; + /** + * Indicates if the option setting is part of a collection. + */ + IsCollection?: Boolean; + } + export type OptionSettingConfigurationList = OptionSetting[]; + export type OptionSettingsList = OptionSetting[]; + export interface OptionVersion { + /** + * The version of the option. + */ + Version?: String; + /** + * True if the version is the default version of the option, and otherwise false. + */ + IsDefault?: Boolean; + } + export type OptionsConflictsWith = String[]; + export type OptionsDependedOn = String[]; + export type OptionsList = Option[]; + export interface OrderableDBInstanceOption { + /** + * The engine type of a DB instance. + */ + Engine?: String; + /** + * The engine version of a DB instance. + */ + EngineVersion?: String; + /** + * The DB instance class for a DB instance. + */ + DBInstanceClass?: String; + /** + * The license model for a DB instance. + */ + LicenseModel?: String; + /** + * A list of Availability Zones for a DB instance. + */ + AvailabilityZones?: AvailabilityZoneList; + /** + * Indicates whether a DB instance is Multi-AZ capable. + */ + MultiAZCapable?: Boolean; + /** + * Indicates whether a DB instance can have a Read Replica. + */ + ReadReplicaCapable?: Boolean; + /** + * Indicates whether a DB instance is in a VPC. + */ + Vpc?: Boolean; + /** + * Indicates whether a DB instance supports encrypted storage. + */ + SupportsStorageEncryption?: Boolean; + /** + * Indicates the storage type for a DB instance. + */ + StorageType?: String; + /** + * Indicates whether a DB instance supports provisioned IOPS. + */ + SupportsIops?: Boolean; + /** + * Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds. + */ + SupportsEnhancedMonitoring?: Boolean; + /** + * Indicates whether a DB instance supports IAM database authentication. + */ + SupportsIAMDatabaseAuthentication?: Boolean; + /** + * True if a DB instance supports Performance Insights, otherwise false. + */ + SupportsPerformanceInsights?: Boolean; + /** + * Minimum storage size for a DB instance. + */ + MinStorageSize?: IntegerOptional; + /** + * Maximum storage size for a DB instance. + */ + MaxStorageSize?: IntegerOptional; + /** + * Minimum total provisioned IOPS for a DB instance. + */ + MinIopsPerDbInstance?: IntegerOptional; + /** + * Maximum total provisioned IOPS for a DB instance. + */ + MaxIopsPerDbInstance?: IntegerOptional; + /** + * Minimum provisioned IOPS per GiB for a DB instance. + */ + MinIopsPerGib?: DoubleOptional; + /** + * Maximum provisioned IOPS per GiB for a DB instance. + */ + MaxIopsPerGib?: DoubleOptional; + /** + * A list of the available processor features for the DB instance class of a DB instance. + */ + AvailableProcessorFeatures?: AvailableProcessorFeatureList; + /** + * A list of the supported DB engine modes. + */ + SupportedEngineModes?: EngineModeList; + } + export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[]; + export interface OrderableDBInstanceOptionsMessage { + /** + * An OrderableDBInstanceOption structure containing information about orderable options for the DB instance. + */ + OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList; + /** + * An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords . + */ + Marker?: String; + } + export interface Parameter { + /** + * Specifies the name of the parameter. + */ + ParameterName?: String; + /** + * Specifies the value of the parameter. + */ + ParameterValue?: String; + /** + * Provides a description of the parameter. + */ + Description?: String; + /** + * Indicates the source of the parameter value. + */ + Source?: String; + /** + * Specifies the engine specific parameters type. + */ + ApplyType?: String; + /** + * Specifies the valid data type for the parameter. + */ + DataType?: String; + /** + * Specifies the valid range of values for the parameter. + */ + AllowedValues?: String; + /** + * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. + */ + IsModifiable?: Boolean; + /** + * The earliest engine version to which the parameter can apply. + */ + MinimumEngineVersion?: String; + /** + * Indicates when to apply parameter updates. + */ + ApplyMethod?: ApplyMethod; + /** + * The valid DB engine modes. + */ + SupportedEngineModes?: EngineModeList; + } + export type ParametersList = Parameter[]; + export interface PendingCloudwatchLogsExports { + /** + * Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. + */ + LogTypesToEnable?: LogTypeList; + /** + * Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. + */ + LogTypesToDisable?: LogTypeList; + } + export interface PendingMaintenanceAction { + /** + * The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, and hardware-maintenance. + */ + Action?: String; + /** + * The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored. + */ + AutoAppliedAfterDate?: TStamp; + /** + * The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored. + */ + ForcedApplyDate?: TStamp; + /** + * Indicates the type of opt-in request that has been received for the resource. + */ + OptInStatus?: String; + /** + * The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate. + */ + CurrentApplyDate?: TStamp; + /** + * A description providing more detail about the maintenance action. + */ + Description?: String; + } + export type PendingMaintenanceActionDetails = PendingMaintenanceAction[]; + export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[]; + export interface PendingMaintenanceActionsMessage { + /** + * A list of the pending maintenance actions for the resource. + */ + PendingMaintenanceActions?: PendingMaintenanceActions; + /** + * An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords. + */ + Marker?: String; + } + export interface PendingModifiedValues { + /** + * Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied. + */ + DBInstanceClass?: String; + /** + * Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied. + */ + AllocatedStorage?: IntegerOptional; + /** + * Contains the pending or currently-in-progress change of the master credentials for the DB instance. + */ + MasterUserPassword?: String; + /** + * Specifies the pending port for the DB instance. + */ + Port?: IntegerOptional; + /** + * Specifies the pending number of days for which automated backups are retained. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. + */ + MultiAZ?: BooleanOptional; + /** + * Indicates the database engine version. + */ + EngineVersion?: String; + /** + * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license + */ + LicenseModel?: String; + /** + * Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied. + */ + Iops?: IntegerOptional; + /** + * Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied. + */ + DBInstanceIdentifier?: String; + /** + * Specifies the storage type to be associated with the DB instance. + */ + StorageType?: String; + /** + * Specifies the identifier of the CA certificate for the DB instance. + */ + CACertificateIdentifier?: String; + /** + * The new DB subnet group for the DB instance. + */ + DBSubnetGroupName?: String; + PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + } + export interface ProcessorFeature { + /** + * The name of the processor feature. Valid names are coreCount and threadsPerCore. + */ + Name?: String; + /** + * The value of a processor feature name. + */ + Value?: String; + } + export type ProcessorFeatureList = ProcessorFeature[]; + export interface PromoteReadReplicaDBClusterMessage { + /** + * The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster Read Replica. Example: my-cluster-replica1 + */ + DBClusterIdentifier: String; + } + export interface PromoteReadReplicaDBClusterResult { + DBCluster?: DBCluster; + } + export interface PromoteReadReplicaMessage { + /** + * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing Read Replica DB instance. Example: mydbinstance + */ + DBInstanceIdentifier: String; + /** + * The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: Must be a value from 0 to 8 + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + } + export interface PromoteReadReplicaResult { + DBInstance?: DBInstance; + } + export interface PurchaseReservedDBInstancesOfferingMessage { + /** + * The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 + */ + ReservedDBInstancesOfferingId: String; + /** + * Customer-specified identifier to track this reservation. Example: myreservationID + */ + ReservedDBInstanceId?: String; + /** + * The number of instances to reserve. Default: 1 + */ + DBInstanceCount?: IntegerOptional; + Tags?: TagList; + } + export interface PurchaseReservedDBInstancesOfferingResult { + ReservedDBInstance?: ReservedDBInstance; + } + export interface Range { + /** + * The minimum value in the range. + */ + From?: Integer; + /** + * The maximum value in the range. + */ + To?: Integer; + /** + * The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000... + */ + Step?: IntegerOptional; + } + export type RangeList = Range[]; + export type ReadReplicaDBClusterIdentifierList = String[]; + export type ReadReplicaDBInstanceIdentifierList = String[]; + export type ReadReplicaIdentifierList = String[]; + export type ReadersArnList = String[]; + export interface RebootDBInstanceMessage { + /** + * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. + */ + DBInstanceIdentifier: String; + /** + * When true, the reboot is conducted through a MultiAZ failover. Constraint: You can't specify true if the instance is not configured for MultiAZ. + */ + ForceFailover?: BooleanOptional; + } + export interface RebootDBInstanceResult { + DBInstance?: DBInstance; + } + export interface RecurringCharge { + /** + * The amount of the recurring charge. + */ + RecurringChargeAmount?: Double; + /** + * The frequency of the recurring charge. + */ + RecurringChargeFrequency?: String; + } + export type RecurringChargeList = RecurringCharge[]; + export interface RemoveFromGlobalClusterMessage { + /** + * The cluster identifier to detach from the Aurora global database cluster. + */ + GlobalClusterIdentifier?: String; + /** + * The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster. + */ + DbClusterIdentifier?: String; + } + export interface RemoveFromGlobalClusterResult { + GlobalCluster?: GlobalCluster; + } + export interface RemoveRoleFromDBClusterMessage { + /** + * The name of the DB cluster to disassociate the IAM role from. + */ + DBClusterIdentifier: String; + /** + * The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. + */ + RoleArn: String; + /** + * The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion. + */ + FeatureName?: String; + } + export interface RemoveRoleFromDBInstanceMessage { + /** + * The name of the DB instance to disassociate the IAM role from. + */ + DBInstanceIdentifier: String; + /** + * The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole. + */ + RoleArn: String; + /** + * The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion. + */ + FeatureName: String; + } + export interface RemoveSourceIdentifierFromSubscriptionMessage { + /** + * The name of the RDS event notification subscription you want to remove a source identifier from. + */ + SubscriptionName: String; + /** + * The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group. + */ + SourceIdentifier: String; + } + export interface RemoveSourceIdentifierFromSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface RemoveTagsFromResourceMessage { + /** + * The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. + */ + ResourceName: String; + /** + * The tag key (name) of the tag to be removed. + */ + TagKeys: KeyList; + } + export interface ReservedDBInstance { + /** + * The unique identifier for the reservation. + */ + ReservedDBInstanceId?: String; + /** + * The offering identifier. + */ + ReservedDBInstancesOfferingId?: String; + /** + * The DB instance class for the reserved DB instance. + */ + DBInstanceClass?: String; + /** + * The time the reservation started. + */ + StartTime?: TStamp; + /** + * The duration of the reservation in seconds. + */ + Duration?: Integer; + /** + * The fixed price charged for this reserved DB instance. + */ + FixedPrice?: Double; + /** + * The hourly price charged for this reserved DB instance. + */ + UsagePrice?: Double; + /** + * The currency code for the reserved DB instance. + */ + CurrencyCode?: String; + /** + * The number of reserved DB instances. + */ + DBInstanceCount?: Integer; + /** + * The description of the reserved DB instance. + */ + ProductDescription?: String; + /** + * The offering type of this reserved DB instance. + */ + OfferingType?: String; + /** + * Indicates if the reservation applies to Multi-AZ deployments. + */ + MultiAZ?: Boolean; + /** + * The state of the reserved DB instance. + */ + State?: String; + /** + * The recurring price charged to run this reserved DB instance. + */ + RecurringCharges?: RecurringChargeList; + /** + * The Amazon Resource Name (ARN) for the reserved DB instance. + */ + ReservedDBInstanceArn?: String; + } + export type ReservedDBInstanceList = ReservedDBInstance[]; + export interface ReservedDBInstanceMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of reserved DB instances. + */ + ReservedDBInstances?: ReservedDBInstanceList; + } + export interface ReservedDBInstancesOffering { + /** + * The offering identifier. + */ + ReservedDBInstancesOfferingId?: String; + /** + * The DB instance class for the reserved DB instance. + */ + DBInstanceClass?: String; + /** + * The duration of the offering in seconds. + */ + Duration?: Integer; + /** + * The fixed price charged for this offering. + */ + FixedPrice?: Double; + /** + * The hourly price charged for this offering. + */ + UsagePrice?: Double; + /** + * The currency code for the reserved DB instance offering. + */ + CurrencyCode?: String; + /** + * The database engine used by the offering. + */ + ProductDescription?: String; + /** + * The offering type. + */ + OfferingType?: String; + /** + * Indicates if the offering applies to Multi-AZ deployments. + */ + MultiAZ?: Boolean; + /** + * The recurring price charged to run this reserved DB instance. + */ + RecurringCharges?: RecurringChargeList; + } + export type ReservedDBInstancesOfferingList = ReservedDBInstancesOffering[]; + export interface ReservedDBInstancesOfferingMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of reserved DB instance offerings. + */ + ReservedDBInstancesOfferings?: ReservedDBInstancesOfferingList; + } + export interface ResetDBClusterParameterGroupMessage { + /** + * The name of the DB cluster parameter group to reset. + */ + DBClusterParameterGroupName: String; + /** + * A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter. + */ + ResetAllParameters?: Boolean; + /** + * A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true. + */ + Parameters?: ParametersList; + } + export interface ResetDBParameterGroupMessage { + /** + * The name of the DB parameter group. Constraints: Must match the name of an existing DBParameterGroup. + */ + DBParameterGroupName: String; + /** + * Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values. Default: true + */ + ResetAllParameters?: Boolean; + /** + * To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request. MySQL Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots. MariaDB Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots. Oracle Valid Values (for Apply method): pending-reboot + */ + Parameters?: ParametersList; + } + export interface ResourcePendingMaintenanceActions { + /** + * The ARN of the resource that has pending maintenance actions. + */ + ResourceIdentifier?: String; + /** + * A list that provides details about the pending maintenance actions for the resource. + */ + PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails; + } + export interface RestoreDBClusterFromS3Message { + /** + * A list of EC2 Availability Zones that instances in the restored DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35 + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * A value that indicates that the restored DB cluster should be associated with the specified CharacterSet. + */ + CharacterSetName?: String; + /** + * The database name for the restored DB cluster. + */ + DatabaseName?: String; + /** + * The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1 + */ + DBClusterIdentifier: String; + /** + * The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup. + */ + DBClusterParameterGroupName?: String; + /** + * A list of EC2 VPC security groups to associate with the restored DB cluster. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * The name of the database engine to be used for the restored DB cluster. Valid Values: aurora, aurora-postgresql + */ + Engine: String; + /** + * The version number of the database engine to use. Aurora MySQL Example: 5.6.10a Aurora PostgreSQL Example: 9.6.3 + */ + EngineVersion?: String; + /** + * The port number on which the instances in the restored DB cluster accept connections. Default: 3306 + */ + Port?: IntegerOptional; + /** + * The name of the master user for the restored DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. + */ + MasterUsername: String; + /** + * The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword: String; + /** + * A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster. + */ + OptionGroupName?: String; + /** + * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + Tags?: TagList; + /** + * Specifies whether the restored DB cluster is encrypted. + */ + StorageEncrypted?: BooleanOptional; + /** + * The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS 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. + */ + KmsKeyId?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: mysql + */ + SourceEngine: String; + /** + * The version of the database that the backup files were created from. MySQL version 5.5 and 5.6 are supported. Example: 5.6.22 + */ + SourceEngineVersion: String; + /** + * The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster. + */ + S3BucketName: String; + /** + * The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket. + */ + S3Prefix?: String; + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf. + */ + S3IngestionRoleArn: String; + /** + * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). + */ + BacktrackWindow?: LongOptional; + /** + * The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. + */ + DeletionProtection?: BooleanOptional; + /** + * True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + } + export interface RestoreDBClusterFromS3Result { + DBCluster?: DBCluster; + } + export interface RestoreDBClusterFromSnapshotMessage { + /** + * Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in. + */ + AvailabilityZones?: AvailabilityZones; + /** + * The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id + */ + DBClusterIdentifier: String; + /** + * The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot. + */ + SnapshotIdentifier: String; + /** + * The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source + */ + Engine: String; + /** + * The version of the database engine to use for the new DB cluster. + */ + EngineVersion?: String; + /** + * The port number on which the new DB cluster accepts connections. Constraints: This value must be 1150-65535 Default: The same port as the original DB cluster. + */ + Port?: IntegerOptional; + /** + * The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DB subnet group. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * The database name for the restored DB cluster. + */ + DatabaseName?: String; + /** + * The name of the option group to use for the restored DB cluster. + */ + OptionGroupName?: String; + /** + * A list of VPC security groups that the new DB cluster will belong to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The tags to be assigned to the restored DB cluster. + */ + Tags?: TagList; + /** + * The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted. + */ + KmsKeyId?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). + */ + BacktrackWindow?: LongOptional; + /** + * The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery. + */ + EngineMode?: String; + /** + * For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. + */ + ScalingConfiguration?: ScalingConfiguration; + /** + * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing default DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. + */ + DBClusterParameterGroupName?: String; + /** + * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. + */ + DeletionProtection?: BooleanOptional; + /** + * True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + } + export interface RestoreDBClusterFromSnapshotResult { + DBCluster?: DBCluster; + } + export interface RestoreDBClusterToPointInTimeMessage { + /** + * The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens + */ + DBClusterIdentifier: String; + /** + * The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full copy of the source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster. + */ + RestoreType?: String; + /** + * The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster. + */ + SourceDBClusterIdentifier: String; + /** + * The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Must be specified if UseLatestRestorableTime parameter is not provided Can't be specified if UseLatestRestorableTime parameter is true Can't be specified if RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z + */ + RestoreToTime?: TStamp; + /** + * A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Can't be specified if RestoreToTime parameter is provided. + */ + UseLatestRestorableTime?: Boolean; + /** + * The port number on which the new DB cluster accepts connections. Constraints: A value from 1150-65535. Default: The default port for the engine. + */ + Port?: IntegerOptional; + /** + * The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * The name of the option group for the new DB cluster. + */ + OptionGroupName?: String; + /** + * A list of VPC security groups that the new DB cluster belongs to. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + Tags?: TagList; + /** + * The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter. If you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. If the DB cluster is not encrypted, then the restored DB cluster is not encrypted. If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected. + */ + KmsKeyId?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). + */ + BacktrackWindow?: LongOptional; + /** + * The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. + */ + DBClusterParameterGroupName?: String; + /** + * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. + */ + DeletionProtection?: BooleanOptional; + /** + * True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + } + export interface RestoreDBClusterToPointInTimeResult { + DBCluster?: DBCluster; + } + export interface RestoreDBInstanceFromDBSnapshotMessage { + /** + * Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 numbers, letters, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id + */ + DBInstanceIdentifier: String; + /** + * The identifier for the DB snapshot to restore from. Constraints: Must match the identifier of an existing DBSnapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. + */ + DBSnapshotIdentifier: String; + /** + * The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance. + */ + DBInstanceClass?: String; + /** + * The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be 1150-65535 + */ + Port?: IntegerOptional; + /** + * The EC2 Availability Zone that the DB instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a + */ + AvailabilityZone?: String; + /** + * The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * Specifies if the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. + */ + MultiAZ?: BooleanOptional; + /** + * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. + */ + PubliclyAccessible?: BooleanOptional; + /** + * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license + */ + LicenseModel?: String; + /** + * The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. + */ + DBName?: String; + /** + * The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web + */ + Engine?: String; + /** + * Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: Must be an integer greater than 1000. + */ + Iops?: IntegerOptional; + /** + * The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance + */ + OptionGroupName?: String; + Tags?: TagList; + /** + * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise standard + */ + StorageType?: String; + /** + * The ARN from the key store with which to associate the instance for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * The password for the given ARN from the key store in order to access the device. + */ + TdeCredentialPassword?: String; + /** + * A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * Specify the Active Directory Domain to restore the instance in. + */ + Domain?: String; + /** + * True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * Specify the name of the IAM role to be used when making API calls to the Directory Service. + */ + DomainIAMRoleName?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * A value that specifies that the DB instance class of the DB instance uses its default processor features. + */ + UseDefaultProcessorFeatures?: BooleanOptional; + /** + * The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. + */ + DBParameterGroupName?: String; + /** + * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance. + */ + DeletionProtection?: BooleanOptional; + } + export interface RestoreDBInstanceFromDBSnapshotResult { + DBInstance?: DBInstance; + } + export interface RestoreDBInstanceFromS3Message { + /** + * The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance. + */ + DBName?: String; + /** + * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance + */ + DBInstanceIdentifier: String; + /** + * The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth. + */ + AllocatedStorage?: IntegerOptional; + /** + * The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Importing from Amazon S3 is not supported on the db.t2.micro DB instance class. + */ + DBInstanceClass: String; + /** + * The name of the database engine to be used for this instance. Valid Values: mysql + */ + Engine: String; + /** + * The name for the master user. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. + */ + MasterUsername?: String; + /** + * The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. + */ + MasterUserPassword?: String; + /** + * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. + */ + DBSecurityGroups?: DBSecurityGroupNameList; + /** + * A list of VPC security groups to associate with this DB instance. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint. + */ + AvailabilityZone?: String; + /** + * A DB subnet group to associate with this DB instance. + */ + DBSubnetGroupName?: String; + /** + * The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred backup window. Must be at least 30 minutes. + */ + PreferredMaintenanceWindow?: String; + /** + * The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used. + */ + DBParameterGroupName?: String; + /** + * The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance. + */ + BackupRetentionPeriod?: IntegerOptional; + /** + * The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. + */ + PreferredBackupWindow?: String; + /** + * The port number on which the database accepts connections. Type: Integer Valid Values: 1150-65535 Default: 3306 + */ + Port?: IntegerOptional; + /** + * Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter. + */ + MultiAZ?: BooleanOptional; + /** + * The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. + */ + EngineVersion?: String; + /** + * True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false. Default: true + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * The license model for this DB instance. Use general-public-license. + */ + LicenseModel?: String; + /** + * The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. + */ + Iops?: IntegerOptional; + /** + * The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used. + */ + OptionGroupName?: String; + /** + * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. + */ + PubliclyAccessible?: BooleanOptional; + /** + * A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. + */ + Tags?: TagList; + /** + * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard + */ + StorageType?: String; + /** + * Specifies whether the new DB instance is encrypted or not. + */ + StorageEncrypted?: BooleanOptional; + /** + * The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS 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. + */ + KmsKeyId?: String; + /** + * True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. Default: false. + */ + CopyTagsToSnapshot?: BooleanOptional; + /** + * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Default: 0 + */ + MonitoringInterval?: IntegerOptional; + /** + * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. + */ + MonitoringRoleArn?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The name of the engine of your source database. Valid Values: mysql + */ + SourceEngine: String; + /** + * The engine version of your source database. Valid Values: 5.6 + */ + SourceEngineVersion: String; + /** + * The name of your Amazon S3 bucket that contains your database backup file. + */ + S3BucketName: String; + /** + * The prefix of your Amazon S3 bucket. + */ + S3Prefix?: String; + /** + * An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. + */ + S3IngestionRoleArn: String; + /** + * True to enable Performance Insights for the DB instance, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide. + */ + EnablePerformanceInsights?: BooleanOptional; + /** + * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. + */ + PerformanceInsightsKMSKeyId?: String; + /** + * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). + */ + PerformanceInsightsRetentionPeriod?: IntegerOptional; + /** + * The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * A value that specifies that the DB instance class of the DB instance uses its default processor features. + */ + UseDefaultProcessorFeatures?: BooleanOptional; + /** + * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance. + */ + DeletionProtection?: BooleanOptional; + } + export interface RestoreDBInstanceFromS3Result { + DBInstance?: DBInstance; + } + export interface RestoreDBInstanceToPointInTimeMessage { + /** + * The identifier of the source DB instance from which to restore. Constraints: Must match the identifier of an existing DB instance. + */ + SourceDBInstanceIdentifier?: String; + /** + * The name of the new DB instance to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens + */ + TargetDBInstanceIdentifier: String; + /** + * The date and time to restore from. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Can't be specified if UseLatestRestorableTime parameter is true Example: 2009-09-07T23:45:00Z + */ + RestoreTime?: TStamp; + /** + * Specifies whether (true) or not (false) the DB instance is restored from the latest backup time. Default: false Constraints: Can't be specified if RestoreTime parameter is provided. + */ + UseLatestRestorableTime?: Boolean; + /** + * The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance. + */ + DBInstanceClass?: String; + /** + * The port number on which the database accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB instance. + */ + Port?: IntegerOptional; + /** + * The EC2 Availability Zone that the DB instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a + */ + AvailabilityZone?: String; + /** + * The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup + */ + DBSubnetGroupName?: String; + /** + * Specifies if the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. + */ + MultiAZ?: BooleanOptional; + /** + * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. + */ + PubliclyAccessible?: BooleanOptional; + /** + * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. + */ + AutoMinorVersionUpgrade?: BooleanOptional; + /** + * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license + */ + LicenseModel?: String; + /** + * The database name for the restored DB instance. This parameter is not used for the MySQL or MariaDB engines. + */ + DBName?: String; + /** + * The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web + */ + Engine?: String; + /** + * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000. SQL Server Setting the IOPS value for the SQL Server database engine is not supported. + */ + Iops?: IntegerOptional; + /** + * The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance + */ + OptionGroupName?: String; + /** + * True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false. + */ + CopyTagsToSnapshot?: BooleanOptional; + Tags?: TagList; + /** + * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise standard + */ + StorageType?: String; + /** + * The ARN from the key store with which to associate the instance for TDE encryption. + */ + TdeCredentialArn?: String; + /** + * The password for the given ARN from the key store in order to access the device. + */ + TdeCredentialPassword?: String; + /** + * A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * Specify the Active Directory Domain to restore the instance in. + */ + Domain?: String; + /** + * Specify the name of the IAM role to be used when making API calls to the Directory Service. + */ + DomainIAMRoleName?: String; + /** + * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false + */ + EnableIAMDatabaseAuthentication?: BooleanOptional; + /** + * The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. + */ + EnableCloudwatchLogsExports?: LogTypeList; + /** + * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + */ + ProcessorFeatures?: ProcessorFeatureList; + /** + * A value that specifies that the DB instance class of the DB instance uses its default processor features. + */ + UseDefaultProcessorFeatures?: BooleanOptional; + /** + * The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. + */ + DBParameterGroupName?: String; + /** + * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance. + */ + DeletionProtection?: BooleanOptional; + /** + * The resource ID of the source DB instance from which to restore. + */ + SourceDbiResourceId?: String; + } + export interface RestoreDBInstanceToPointInTimeResult { + DBInstance?: DBInstance; + } + export interface RestoreWindow { + /** + * The earliest time you can restore an instance to. + */ + EarliestTime?: TStamp; + /** + * The latest time you can restore an instance to. + */ + LatestTime?: TStamp; + } + export interface RevokeDBSecurityGroupIngressMessage { + /** + * The name of the DB security group to revoke ingress from. + */ + DBSecurityGroupName: String; + /** + * The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided. + */ + CIDRIP?: String; + /** + * The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + */ + EC2SecurityGroupName?: String; + /** + * The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + */ + EC2SecurityGroupId?: String; + /** + * The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. + */ + EC2SecurityGroupOwnerId?: String; + } + export interface RevokeDBSecurityGroupIngressResult { + DBSecurityGroup?: DBSecurityGroup; + } + export interface ScalingConfiguration { + /** + * The minimum capacity for an Aurora DB cluster in serverless DB engine mode. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256. The minimum capacity must be less than or equal to the maximum capacity. + */ + MinCapacity?: IntegerOptional; + /** + * The maximum capacity for an Aurora DB cluster in serverless DB engine mode. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256. The maximum capacity must be greater than or equal to the minimum capacity. + */ + MaxCapacity?: IntegerOptional; + /** + * A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. + */ + AutoPause?: BooleanOptional; + /** + * The time, in seconds, before an Aurora DB cluster in serverless mode is paused. + */ + SecondsUntilAutoPause?: IntegerOptional; + /** + * The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible. RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period. For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. + */ + TimeoutAction?: String; + } + export interface ScalingConfigurationInfo { + /** + * The maximum capacity for the Aurora DB cluster in serverless DB engine mode. + */ + MinCapacity?: IntegerOptional; + /** + * The maximum capacity for an Aurora DB cluster in serverless DB engine mode. + */ + MaxCapacity?: IntegerOptional; + /** + * A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode. When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes. + */ + AutoPause?: BooleanOptional; + /** + * The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections). + */ + SecondsUntilAutoPause?: IntegerOptional; + /** + * The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange. + */ + TimeoutAction?: String; + } + export type SourceIdsList = String[]; + export interface SourceRegion { + /** + * The name of the source AWS Region. + */ + RegionName?: String; + /** + * The endpoint for the source AWS Region endpoint. + */ + Endpoint?: String; + /** + * The status of the source AWS Region. + */ + Status?: String; + } + export type SourceRegionList = SourceRegion[]; + export interface SourceRegionMessage { + /** + * 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 MaxRecords. + */ + Marker?: String; + /** + * A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from. + */ + SourceRegions?: SourceRegionList; + } + export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string; + export interface StartDBClusterMessage { + /** + * The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string. + */ + DBClusterIdentifier: String; + } + export interface StartDBClusterResult { + DBCluster?: DBCluster; + } + export interface StartDBInstanceMessage { + /** + * The user-supplied instance identifier. + */ + DBInstanceIdentifier: String; + } + export interface StartDBInstanceResult { + DBInstance?: DBInstance; + } + export interface StopDBClusterMessage { + /** + * The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string. + */ + DBClusterIdentifier: String; + } + export interface StopDBClusterResult { + DBCluster?: DBCluster; + } + export interface StopDBInstanceMessage { + /** + * The user-supplied instance identifier. + */ + DBInstanceIdentifier: String; + /** + * The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped. + */ + DBSnapshotIdentifier?: String; + } + export interface StopDBInstanceResult { + DBInstance?: DBInstance; + } + export type String = string; + export type StringList = String[]; + export interface Subnet { + /** + * Specifies the identifier of the subnet. + */ + SubnetIdentifier?: String; + SubnetAvailabilityZone?: AvailabilityZone; + /** + * Specifies the status of the subnet. + */ + SubnetStatus?: String; + } + export type SubnetIdentifierList = String[]; + export type SubnetList = Subnet[]; + export type SupportedCharacterSetsList = CharacterSet[]; + export type SupportedTimezonesList = Timezone[]; + export type TStamp = Date; + export interface Tag { + /** + * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Key?: String; + /** + * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + */ + Value?: String; + } + export type TagList = Tag[]; + export interface TagListMessage { + /** + * List of tags returned by the ListTagsForResource operation. + */ + TagList?: TagList; + } + export interface Timezone { + /** + * The name of the time zone. + */ + TimezoneName?: String; + } + export interface UpgradeTarget { + /** + * The name of the upgrade target database engine. + */ + Engine?: String; + /** + * The version number of the upgrade target database engine. + */ + EngineVersion?: String; + /** + * The version of the database engine that a DB instance can be upgraded to. + */ + Description?: String; + /** + * A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true. + */ + AutoUpgrade?: Boolean; + /** + * A value that indicates whether a database engine is upgraded to a major version. + */ + IsMajorVersionUpgrade?: Boolean; + } + export interface ValidDBInstanceModificationsMessage { + /** + * Valid storage options for your DB instance. + */ + Storage?: ValidStorageOptionsList; + /** + * Valid processor features for your DB instance. + */ + ValidProcessorFeatures?: AvailableProcessorFeatureList; + } + export interface ValidStorageOptions { + /** + * The valid storage types for your DB instance. For example, gp2, io1. + */ + StorageType?: String; + /** + * The valid range of storage in gibibytes. For example, 100 to 16384. + */ + StorageSize?: RangeList; + /** + * The valid range of provisioned IOPS. For example, 1000-20000. + */ + ProvisionedIops?: RangeList; + /** + * The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage. + */ + IopsToStorageRatio?: DoubleRangeList; + } + export type ValidStorageOptionsList = ValidStorageOptions[]; + export type ValidUpgradeTargetList = UpgradeTarget[]; + export type VpcSecurityGroupIdList = String[]; + export interface VpcSecurityGroupMembership { + /** + * The name of the VPC security group. + */ + VpcSecurityGroupId?: String; + /** + * The status of the VPC security group. + */ + Status?: String; + } + export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-01-10"|"2013-02-12"|"2013-09-09"|"2014-09-01"|"2014-09-01"|"2014-10-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the RDS client. + */ + export import Types = RDS; +} +export = RDS; diff --git a/node_modules/aws-sdk/clients/rds.js b/node_modules/aws-sdk/clients/rds.js new file mode 100644 index 0000000..f9876b2 --- /dev/null +++ b/node_modules/aws-sdk/clients/rds.js @@ -0,0 +1,57 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['rds'] = {}; +AWS.RDS = Service.defineService('rds', ['2013-01-10', '2013-02-12', '2013-09-09', '2014-09-01', '2014-09-01*', '2014-10-31']); +require('../lib/services/rds'); +Object.defineProperty(apiLoader.services['rds'], '2013-01-10', { + get: function get() { + var model = require('../apis/rds-2013-01-10.min.json'); + model.paginators = require('../apis/rds-2013-01-10.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['rds'], '2013-02-12', { + get: function get() { + var model = require('../apis/rds-2013-02-12.min.json'); + model.paginators = require('../apis/rds-2013-02-12.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['rds'], '2013-09-09', { + get: function get() { + var model = require('../apis/rds-2013-09-09.min.json'); + model.paginators = require('../apis/rds-2013-09-09.paginators.json').pagination; + model.waiters = require('../apis/rds-2013-09-09.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['rds'], '2014-09-01', { + get: function get() { + var model = require('../apis/rds-2014-09-01.min.json'); + model.paginators = require('../apis/rds-2014-09-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); +Object.defineProperty(apiLoader.services['rds'], '2014-10-31', { + get: function get() { + var model = require('../apis/rds-2014-10-31.min.json'); + model.paginators = require('../apis/rds-2014-10-31.paginators.json').pagination; + model.waiters = require('../apis/rds-2014-10-31.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.RDS; diff --git a/node_modules/aws-sdk/clients/rdsdataservice.d.ts b/node_modules/aws-sdk/clients/rdsdataservice.d.ts new file mode 100644 index 0000000..cd39f7a --- /dev/null +++ b/node_modules/aws-sdk/clients/rdsdataservice.d.ts @@ -0,0 +1,225 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class RDSDataService extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: RDSDataService.Types.ClientConfiguration) + config: Config & RDSDataService.Types.ClientConfiguration; + /** + * Executes any SQL statement on the target database synchronously + */ + executeSql(params: RDSDataService.Types.ExecuteSqlRequest, callback?: (err: AWSError, data: RDSDataService.Types.ExecuteSqlResponse) => void): Request; + /** + * Executes any SQL statement on the target database synchronously + */ + executeSql(callback?: (err: AWSError, data: RDSDataService.Types.ExecuteSqlResponse) => void): Request; +} +declare namespace RDSDataService { + export type Boolean = boolean; + export interface Value { + /** + * Arbitrarily nested arrays + */ + arrayValues?: ArrayValues; + /** + * Long value + */ + bigIntValue?: Long; + /** + * Bit value + */ + bitValue?: Boolean; + /** + * Blob value + */ + blobValue?: _Blob; + /** + * Double value + */ + doubleValue?: Double; + /** + * Integer value + */ + intValue?: Integer; + /** + * Is column null + */ + isNull?: Boolean; + /** + * Float value + */ + realValue?: Float; + /** + * String value + */ + stringValue?: String; + /** + * Struct or UDT + */ + structValue?: StructValue; + } + export type SqlStatementResults = SqlStatementResult[]; + export type ColumnMetadataList = ColumnMetadata[]; + export interface ResultFrame { + /** + * ResultSet Metadata. + */ + records?: Records; + /** + * ResultSet Metadata. + */ + resultSetMetadata?: ResultSetMetadata; + } + export type Long = number; + export type Row = Value[]; + export type String = string; + export type ArrayValues = Value[]; + export type Float = number; + export interface ExecuteSqlResponse { + /** + * Results returned by executing the sql statement(s) + */ + sqlStatementResults: SqlStatementResults; + } + export interface SqlStatementResult { + /** + * Number of rows updated. + */ + numberOfRecordsUpdated?: Long; + /** + * ResultFrame returned by executing the sql statement + */ + resultFrame?: ResultFrame; + } + export interface ResultSetMetadata { + /** + * Number of columns + */ + columnCount?: Long; + /** + * List of columns and their types + */ + columnMetadata?: ColumnMetadataList; + } + export type Records = Record[]; + export interface ExecuteSqlRequest { + /** + * ARN of the db credentials in AWS Secret Store or the friendly secret name + */ + awsSecretStoreArn: Arn; + /** + * Target DB name + */ + database?: DbName; + /** + * ARN of the target db cluster or instance + */ + dbClusterOrInstanceArn: Arn; + /** + * Target Schema name + */ + schema?: DbName; + /** + * SQL statement(s) to be executed. Statements can be chained by using semicolons + */ + sqlStatements: SqlStatement; + } + export type Arn = string; + export interface StructValue { + /** + * Struct or UDT + */ + attributes?: ArrayValues; + } + export type _Blob = Buffer|Uint8Array|Blob|string; + export type SqlStatement = string; + export type Double = number; + export interface ColumnMetadata { + /** + * Homogenous array base SQL type from java.sql.Types. + */ + arrayBaseColumnType?: Integer; + /** + * Whether the designated column is automatically numbered + */ + isAutoIncrement?: Boolean; + /** + * Whether values in the designated column's case matters + */ + isCaseSensitive?: Boolean; + /** + * Whether values in the designated column is a cash value + */ + isCurrency?: Boolean; + /** + * Whether values in the designated column are signed numbers + */ + isSigned?: Boolean; + /** + * Usually specified by the SQL AS. If not specified, return column name. + */ + label?: String; + /** + * Name of the column. + */ + name?: String; + /** + * Indicates the nullability of values in the designated column. One of columnNoNulls (0), columnNullable (1), columnNullableUnknown (2) + */ + nullable?: Integer; + /** + * Get the designated column's specified column size.For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable. + */ + precision?: Integer; + /** + * Designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable. + */ + scale?: Integer; + /** + * Designated column's table's schema + */ + schemaName?: String; + /** + * Designated column's table name + */ + tableName?: String; + /** + * SQL type from java.sql.Types. + */ + type?: Integer; + /** + * Database-specific type name. + */ + typeName?: String; + } + export type Integer = number; + export type DbName = string; + export interface Record { + /** + * Record + */ + values?: Row; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-08-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the RDSDataService client. + */ + export import Types = RDSDataService; +} +export = RDSDataService; diff --git a/node_modules/aws-sdk/clients/rdsdataservice.js b/node_modules/aws-sdk/clients/rdsdataservice.js new file mode 100644 index 0000000..9711b0f --- /dev/null +++ b/node_modules/aws-sdk/clients/rdsdataservice.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['rdsdataservice'] = {}; +AWS.RDSDataService = Service.defineService('rdsdataservice', ['2018-08-01']); +Object.defineProperty(apiLoader.services['rdsdataservice'], '2018-08-01', { + get: function get() { + var model = require('../apis/rds-data-2018-08-01.min.json'); + model.paginators = require('../apis/rds-data-2018-08-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.RDSDataService; diff --git a/node_modules/aws-sdk/clients/redshift.d.ts b/node_modules/aws-sdk/clients/redshift.d.ts new file mode 100644 index 0000000..4d80763 --- /dev/null +++ b/node_modules/aws-sdk/clients/redshift.d.ts @@ -0,0 +1,4045 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Redshift extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Redshift.Types.ClientConfiguration) + config: Config & Redshift.Types.ClientConfiguration; + /** + * Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs. + */ + acceptReservedNodeExchange(params: Redshift.Types.AcceptReservedNodeExchangeInputMessage, callback?: (err: AWSError, data: Redshift.Types.AcceptReservedNodeExchangeOutputMessage) => void): Request; + /** + * Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs. + */ + acceptReservedNodeExchange(callback?: (err: AWSError, data: Redshift.Types.AcceptReservedNodeExchangeOutputMessage) => void): Request; + /** + * Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide. + */ + authorizeClusterSecurityGroupIngress(params: Redshift.Types.AuthorizeClusterSecurityGroupIngressMessage, callback?: (err: AWSError, data: Redshift.Types.AuthorizeClusterSecurityGroupIngressResult) => void): Request; + /** + * Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide. + */ + authorizeClusterSecurityGroupIngress(callback?: (err: AWSError, data: Redshift.Types.AuthorizeClusterSecurityGroupIngressResult) => void): Request; + /** + * Authorizes the specified AWS customer account to restore the specified snapshot. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + authorizeSnapshotAccess(params: Redshift.Types.AuthorizeSnapshotAccessMessage, callback?: (err: AWSError, data: Redshift.Types.AuthorizeSnapshotAccessResult) => void): Request; + /** + * Authorizes the specified AWS customer account to restore the specified snapshot. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + authorizeSnapshotAccess(callback?: (err: AWSError, data: Redshift.Types.AuthorizeSnapshotAccessResult) => void): Request; + /** + * Deletes a set of cluster snapshots. + */ + batchDeleteClusterSnapshots(params: Redshift.Types.BatchDeleteClusterSnapshotsRequest, callback?: (err: AWSError, data: Redshift.Types.BatchDeleteClusterSnapshotsResult) => void): Request; + /** + * Deletes a set of cluster snapshots. + */ + batchDeleteClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.BatchDeleteClusterSnapshotsResult) => void): Request; + /** + * Modifies the settings for a list of snapshots. + */ + batchModifyClusterSnapshots(params: Redshift.Types.BatchModifyClusterSnapshotsMessage, callback?: (err: AWSError, data: Redshift.Types.BatchModifyClusterSnapshotsOutputMessage) => void): Request; + /** + * Modifies the settings for a list of snapshots. + */ + batchModifyClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.BatchModifyClusterSnapshotsOutputMessage) => void): Request; + /** + * Cancels a resize operation. + */ + cancelResize(params: Redshift.Types.CancelResizeMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request; + /** + * Cancels a resize operation. + */ + cancelResize(callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request; + /** + * Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + copyClusterSnapshot(params: Redshift.Types.CopyClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.CopyClusterSnapshotResult) => void): Request; + /** + * Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + copyClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.CopyClusterSnapshotResult) => void): Request; + /** + * Creates a new cluster. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + createCluster(params: Redshift.Types.CreateClusterMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterResult) => void): Request; + /** + * Creates a new cluster. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + createCluster(callback?: (err: AWSError, data: Redshift.Types.CreateClusterResult) => void): Request; + /** + * Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster. Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + createClusterParameterGroup(params: Redshift.Types.CreateClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterParameterGroupResult) => void): Request; + /** + * Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster. Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + createClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterParameterGroupResult) => void): Request; + /** + * Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. + */ + createClusterSecurityGroup(params: Redshift.Types.CreateClusterSecurityGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSecurityGroupResult) => void): Request; + /** + * Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. + */ + createClusterSecurityGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSecurityGroupResult) => void): Request; + /** + * Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + createClusterSnapshot(params: Redshift.Types.CreateClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSnapshotResult) => void): Request; + /** + * Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + createClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSnapshotResult) => void): Request; + /** + * Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide. + */ + createClusterSubnetGroup(params: Redshift.Types.CreateClusterSubnetGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSubnetGroupResult) => void): Request; + /** + * Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide. + */ + createClusterSubnetGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSubnetGroupResult) => void): Request; + /** + * Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID. + */ + createEventSubscription(params: Redshift.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: Redshift.Types.CreateEventSubscriptionResult) => void): Request; + /** + * Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID. + */ + createEventSubscription(callback?: (err: AWSError, data: Redshift.Types.CreateEventSubscriptionResult) => void): Request; + /** + * Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide. + */ + createHsmClientCertificate(params: Redshift.Types.CreateHsmClientCertificateMessage, callback?: (err: AWSError, data: Redshift.Types.CreateHsmClientCertificateResult) => void): Request; + /** + * Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide. + */ + createHsmClientCertificate(callback?: (err: AWSError, data: Redshift.Types.CreateHsmClientCertificateResult) => void): Request; + /** + * Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide. + */ + createHsmConfiguration(params: Redshift.Types.CreateHsmConfigurationMessage, callback?: (err: AWSError, data: Redshift.Types.CreateHsmConfigurationResult) => void): Request; + /** + * Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide. + */ + createHsmConfiguration(callback?: (err: AWSError, data: Redshift.Types.CreateHsmConfigurationResult) => void): Request; + /** + * Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide. + */ + createSnapshotCopyGrant(params: Redshift.Types.CreateSnapshotCopyGrantMessage, callback?: (err: AWSError, data: Redshift.Types.CreateSnapshotCopyGrantResult) => void): Request; + /** + * Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide. + */ + createSnapshotCopyGrant(callback?: (err: AWSError, data: Redshift.Types.CreateSnapshotCopyGrantResult) => void): Request; + /** + * Creates a new snapshot schedule. + */ + createSnapshotSchedule(params: Redshift.Types.CreateSnapshotScheduleMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request; + /** + * Creates a new snapshot schedule. + */ + createSnapshotSchedule(callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request; + /** + * Adds one or more tags to a specified resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource, the value for that key will be updated with the new value. + */ + createTags(params: Redshift.Types.CreateTagsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds one or more tags to a specified resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource, the value for that key will be updated with the new value. + */ + createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + deleteCluster(params: Redshift.Types.DeleteClusterMessage, callback?: (err: AWSError, data: Redshift.Types.DeleteClusterResult) => void): Request; + /** + * Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + deleteCluster(callback?: (err: AWSError, data: Redshift.Types.DeleteClusterResult) => void): Request; + /** + * Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster. + */ + deleteClusterParameterGroup(params: Redshift.Types.DeleteClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster. + */ + deleteClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. + */ + deleteClusterSecurityGroup(params: Redshift.Types.DeleteClusterSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. + */ + deleteClusterSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot. + */ + deleteClusterSnapshot(params: Redshift.Types.DeleteClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.DeleteClusterSnapshotResult) => void): Request; + /** + * Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot. + */ + deleteClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.DeleteClusterSnapshotResult) => void): Request; + /** + * Deletes the specified cluster subnet group. + */ + deleteClusterSubnetGroup(params: Redshift.Types.DeleteClusterSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified cluster subnet group. + */ + deleteClusterSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Amazon Redshift event notification subscription. + */ + deleteEventSubscription(params: Redshift.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Amazon Redshift event notification subscription. + */ + deleteEventSubscription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified HSM client certificate. + */ + deleteHsmClientCertificate(params: Redshift.Types.DeleteHsmClientCertificateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified HSM client certificate. + */ + deleteHsmClientCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Amazon Redshift HSM configuration. + */ + deleteHsmConfiguration(params: Redshift.Types.DeleteHsmConfigurationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Amazon Redshift HSM configuration. + */ + deleteHsmConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified snapshot copy grant. + */ + deleteSnapshotCopyGrant(params: Redshift.Types.DeleteSnapshotCopyGrantMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified snapshot copy grant. + */ + deleteSnapshotCopyGrant(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a snapshot schedule. + */ + deleteSnapshotSchedule(params: Redshift.Types.DeleteSnapshotScheduleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a snapshot schedule. + */ + deleteSnapshotSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. + */ + deleteTags(params: Redshift.Types.DeleteTagsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. + */ + deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns a list of attributes attached to an account + */ + describeAccountAttributes(params: Redshift.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: Redshift.Types.AccountAttributeList) => void): Request; + /** + * Returns a list of attributes attached to an account + */ + describeAccountAttributes(callback?: (err: AWSError, data: Redshift.Types.AccountAttributeList) => void): Request; + /** + * Returns an array of ClusterDbRevision objects. + */ + describeClusterDbRevisions(params: Redshift.Types.DescribeClusterDbRevisionsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterDbRevisionsMessage) => void): Request; + /** + * Returns an array of ClusterDbRevision objects. + */ + describeClusterDbRevisions(callback?: (err: AWSError, data: Redshift.Types.ClusterDbRevisionsMessage) => void): Request; + /** + * Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterParameterGroups(params: Redshift.Types.DescribeClusterParameterGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupsMessage) => void): Request; + /** + * Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterParameterGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupsMessage) => void): Request; + /** + * Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + describeClusterParameters(params: Redshift.Types.DescribeClusterParametersMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupDetails) => void): Request; + /** + * Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + describeClusterParameters(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupDetails) => void): Request; + /** + * Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterSecurityGroups(params: Redshift.Types.DescribeClusterSecurityGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterSecurityGroupMessage) => void): Request; + /** + * Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterSecurityGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterSecurityGroupMessage) => void): Request; + /** + * Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterSnapshots(params: Redshift.Types.DescribeClusterSnapshotsMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request; + /** + * Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request; + /** + * Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterSubnetGroups(params: Redshift.Types.DescribeClusterSubnetGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterSubnetGroupMessage) => void): Request; + /** + * Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusterSubnetGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterSubnetGroupMessage) => void): Request; + /** + * Returns a list of all the available maintenance tracks. + */ + describeClusterTracks(params: Redshift.Types.DescribeClusterTracksMessage, callback?: (err: AWSError, data: Redshift.Types.TrackListMessage) => void): Request; + /** + * Returns a list of all the available maintenance tracks. + */ + describeClusterTracks(callback?: (err: AWSError, data: Redshift.Types.TrackListMessage) => void): Request; + /** + * Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + describeClusterVersions(params: Redshift.Types.DescribeClusterVersionsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterVersionsMessage) => void): Request; + /** + * Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + describeClusterVersions(callback?: (err: AWSError, data: Redshift.Types.ClusterVersionsMessage) => void): Request; + /** + * Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusters(params: Redshift.Types.DescribeClustersMessage, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. + */ + describeClusters(callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + describeDefaultClusterParameters(params: Redshift.Types.DescribeDefaultClusterParametersMessage, callback?: (err: AWSError, data: Redshift.Types.DescribeDefaultClusterParametersResult) => void): Request; + /** + * Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + describeDefaultClusterParameters(callback?: (err: AWSError, data: Redshift.Types.DescribeDefaultClusterParametersResult) => void): Request; + /** + * Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications. + */ + describeEventCategories(params: Redshift.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: Redshift.Types.EventCategoriesMessage) => void): Request; + /** + * Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications. + */ + describeEventCategories(callback?: (err: AWSError, data: Redshift.Types.EventCategoriesMessage) => void): Request; + /** + * Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them. + */ + describeEventSubscriptions(params: Redshift.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: Redshift.Types.EventSubscriptionsMessage) => void): Request; + /** + * Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them. + */ + describeEventSubscriptions(callback?: (err: AWSError, data: Redshift.Types.EventSubscriptionsMessage) => void): Request; + /** + * Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. + */ + describeEvents(params: Redshift.Types.DescribeEventsMessage, callback?: (err: AWSError, data: Redshift.Types.EventsMessage) => void): Request; + /** + * Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. + */ + describeEvents(callback?: (err: AWSError, data: Redshift.Types.EventsMessage) => void): Request; + /** + * Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. + */ + describeHsmClientCertificates(params: Redshift.Types.DescribeHsmClientCertificatesMessage, callback?: (err: AWSError, data: Redshift.Types.HsmClientCertificateMessage) => void): Request; + /** + * Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. + */ + describeHsmClientCertificates(callback?: (err: AWSError, data: Redshift.Types.HsmClientCertificateMessage) => void): Request; + /** + * Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. + */ + describeHsmConfigurations(params: Redshift.Types.DescribeHsmConfigurationsMessage, callback?: (err: AWSError, data: Redshift.Types.HsmConfigurationMessage) => void): Request; + /** + * Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. + */ + describeHsmConfigurations(callback?: (err: AWSError, data: Redshift.Types.HsmConfigurationMessage) => void): Request; + /** + * Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. + */ + describeLoggingStatus(params: Redshift.Types.DescribeLoggingStatusMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request; + /** + * Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. + */ + describeLoggingStatus(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request; + /** + * Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + describeOrderableClusterOptions(params: Redshift.Types.DescribeOrderableClusterOptionsMessage, callback?: (err: AWSError, data: Redshift.Types.OrderableClusterOptionsMessage) => void): Request; + /** + * Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + describeOrderableClusterOptions(callback?: (err: AWSError, data: Redshift.Types.OrderableClusterOptionsMessage) => void): Request; + /** + * Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. + */ + describeReservedNodeOfferings(params: Redshift.Types.DescribeReservedNodeOfferingsMessage, callback?: (err: AWSError, data: Redshift.Types.ReservedNodeOfferingsMessage) => void): Request; + /** + * Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. + */ + describeReservedNodeOfferings(callback?: (err: AWSError, data: Redshift.Types.ReservedNodeOfferingsMessage) => void): Request; + /** + * Returns the descriptions of the reserved nodes. + */ + describeReservedNodes(params: Redshift.Types.DescribeReservedNodesMessage, callback?: (err: AWSError, data: Redshift.Types.ReservedNodesMessage) => void): Request; + /** + * Returns the descriptions of the reserved nodes. + */ + describeReservedNodes(callback?: (err: AWSError, data: Redshift.Types.ReservedNodesMessage) => void): Request; + /** + * Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize. A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster. + */ + describeResize(params: Redshift.Types.DescribeResizeMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request; + /** + * Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize. A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster. + */ + describeResize(callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request; + /** + * Returns a list of snapshot copy grants owned by the AWS account in the destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide. + */ + describeSnapshotCopyGrants(params: Redshift.Types.DescribeSnapshotCopyGrantsMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotCopyGrantMessage) => void): Request; + /** + * Returns a list of snapshot copy grants owned by the AWS account in the destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide. + */ + describeSnapshotCopyGrants(callback?: (err: AWSError, data: Redshift.Types.SnapshotCopyGrantMessage) => void): Request; + /** + * Returns a list of snapshot schedules. + */ + describeSnapshotSchedules(params: Redshift.Types.DescribeSnapshotSchedulesMessage, callback?: (err: AWSError, data: Redshift.Types.DescribeSnapshotSchedulesOutputMessage) => void): Request; + /** + * Returns a list of snapshot schedules. + */ + describeSnapshotSchedules(callback?: (err: AWSError, data: Redshift.Types.DescribeSnapshotSchedulesOutputMessage) => void): Request; + /** + * Returns the total amount of snapshot usage and provisioned storage for a user in megabytes. + */ + describeStorage(callback?: (err: AWSError, data: Redshift.Types.CustomerStorageMessage) => void): Request; + /** + * Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId. + */ + describeTableRestoreStatus(params: Redshift.Types.DescribeTableRestoreStatusMessage, callback?: (err: AWSError, data: Redshift.Types.TableRestoreStatusMessage) => void): Request; + /** + * Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId. + */ + describeTableRestoreStatus(callback?: (err: AWSError, data: Redshift.Types.TableRestoreStatusMessage) => void): Request; + /** + * Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations for DescribeTags: You cannot specify an ARN and a resource-type value together in the same request. You cannot use the MaxRecords and Marker parameters together with the ARN parameter. The MaxRecords parameter can be a range from 10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them. + */ + describeTags(params: Redshift.Types.DescribeTagsMessage, callback?: (err: AWSError, data: Redshift.Types.TaggedResourceListMessage) => void): Request; + /** + * Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations for DescribeTags: You cannot specify an ARN and a resource-type value together in the same request. You cannot use the MaxRecords and Marker parameters together with the ARN parameter. The MaxRecords parameter can be a range from 10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them. + */ + describeTags(callback?: (err: AWSError, data: Redshift.Types.TaggedResourceListMessage) => void): Request; + /** + * Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. + */ + disableLogging(params: Redshift.Types.DisableLoggingMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request; + /** + * Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. + */ + disableLogging(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request; + /** + * Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region. + */ + disableSnapshotCopy(params: Redshift.Types.DisableSnapshotCopyMessage, callback?: (err: AWSError, data: Redshift.Types.DisableSnapshotCopyResult) => void): Request; + /** + * Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region. + */ + disableSnapshotCopy(callback?: (err: AWSError, data: Redshift.Types.DisableSnapshotCopyResult) => void): Request; + /** + * Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. + */ + enableLogging(params: Redshift.Types.EnableLoggingMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request; + /** + * Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. + */ + enableLogging(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request; + /** + * Enables the automatic copy of snapshots from one region to another region for a specified cluster. + */ + enableSnapshotCopy(params: Redshift.Types.EnableSnapshotCopyMessage, callback?: (err: AWSError, data: Redshift.Types.EnableSnapshotCopyResult) => void): Request; + /** + * Enables the automatic copy of snapshots from one region to another region for a specified cluster. + */ + enableSnapshotCopy(callback?: (err: AWSError, data: Redshift.Types.EnableSnapshotCopyResult) => void): Request; + /** + * Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name. + */ + getClusterCredentials(params: Redshift.Types.GetClusterCredentialsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterCredentials) => void): Request; + /** + * Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name. + */ + getClusterCredentials(callback?: (err: AWSError, data: Redshift.Types.ClusterCredentials) => void): Request; + /** + * Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node. + */ + getReservedNodeExchangeOfferings(params: Redshift.Types.GetReservedNodeExchangeOfferingsInputMessage, callback?: (err: AWSError, data: Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage) => void): Request; + /** + * Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node. + */ + getReservedNodeExchangeOfferings(callback?: (err: AWSError, data: Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage) => void): Request; + /** + * Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. + */ + modifyCluster(params: Redshift.Types.ModifyClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterResult) => void): Request; + /** + * Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. + */ + modifyCluster(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterResult) => void): Request; + /** + * Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster. + */ + modifyClusterDbRevision(params: Redshift.Types.ModifyClusterDbRevisionMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterDbRevisionResult) => void): Request; + /** + * Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster. + */ + modifyClusterDbRevision(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterDbRevisionResult) => void): Request; + /** + * Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time. + */ + modifyClusterIamRoles(params: Redshift.Types.ModifyClusterIamRolesMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterIamRolesResult) => void): Request; + /** + * Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time. + */ + modifyClusterIamRoles(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterIamRolesResult) => void): Request; + /** + * Modifies the maintenance settings of a cluster. For example, you can defer a maintenance window. You can also update or cancel a deferment. + */ + modifyClusterMaintenance(params: Redshift.Types.ModifyClusterMaintenanceMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterMaintenanceResult) => void): Request; + /** + * Modifies the maintenance settings of a cluster. For example, you can defer a maintenance window. You can also update or cancel a deferment. + */ + modifyClusterMaintenance(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterMaintenanceResult) => void): Request; + /** + * Modifies the parameters of a parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + modifyClusterParameterGroup(params: Redshift.Types.ModifyClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the parameters of a parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + modifyClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request; + /** + * Modifies the settings for a snapshot. + */ + modifyClusterSnapshot(params: Redshift.Types.ModifyClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSnapshotResult) => void): Request; + /** + * Modifies the settings for a snapshot. + */ + modifyClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSnapshotResult) => void): Request; + /** + * Modifies a snapshot schedule for a cluster. + */ + modifyClusterSnapshotSchedule(params: Redshift.Types.ModifyClusterSnapshotScheduleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies a snapshot schedule for a cluster. + */ + modifyClusterSnapshotSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets. + */ + modifyClusterSubnetGroup(params: Redshift.Types.ModifyClusterSubnetGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSubnetGroupResult) => void): Request; + /** + * Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets. + */ + modifyClusterSubnetGroup(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSubnetGroupResult) => void): Request; + /** + * Modifies an existing Amazon Redshift event notification subscription. + */ + modifyEventSubscription(params: Redshift.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyEventSubscriptionResult) => void): Request; + /** + * Modifies an existing Amazon Redshift event notification subscription. + */ + modifyEventSubscription(callback?: (err: AWSError, data: Redshift.Types.ModifyEventSubscriptionResult) => void): Request; + /** + * Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period. + */ + modifySnapshotCopyRetentionPeriod(params: Redshift.Types.ModifySnapshotCopyRetentionPeriodMessage, callback?: (err: AWSError, data: Redshift.Types.ModifySnapshotCopyRetentionPeriodResult) => void): Request; + /** + * Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period. + */ + modifySnapshotCopyRetentionPeriod(callback?: (err: AWSError, data: Redshift.Types.ModifySnapshotCopyRetentionPeriodResult) => void): Request; + /** + * Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously. + */ + modifySnapshotSchedule(params: Redshift.Types.ModifySnapshotScheduleMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request; + /** + * Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously. + */ + modifySnapshotSchedule(callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request; + /** + * Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. + */ + purchaseReservedNodeOffering(params: Redshift.Types.PurchaseReservedNodeOfferingMessage, callback?: (err: AWSError, data: Redshift.Types.PurchaseReservedNodeOfferingResult) => void): Request; + /** + * Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. + */ + purchaseReservedNodeOffering(callback?: (err: AWSError, data: Redshift.Types.PurchaseReservedNodeOfferingResult) => void): Request; + /** + * Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + rebootCluster(params: Redshift.Types.RebootClusterMessage, callback?: (err: AWSError, data: Redshift.Types.RebootClusterResult) => void): Request; + /** + * Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. + */ + rebootCluster(callback?: (err: AWSError, data: Redshift.Types.RebootClusterResult) => void): Request; + /** + * Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters. + */ + resetClusterParameterGroup(params: Redshift.Types.ResetClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request; + /** + * Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters. + */ + resetClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request; + /** + * Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge The type of nodes that you add must match the node type for the cluster. + */ + resizeCluster(params: Redshift.Types.ResizeClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeClusterResult) => void): Request; + /** + * Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge The type of nodes that you add must match the node type for the cluster. + */ + resizeCluster(callback?: (err: AWSError, data: Redshift.Types.ResizeClusterResult) => void): Request; + /** + * Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + restoreFromClusterSnapshot(params: Redshift.Types.RestoreFromClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.RestoreFromClusterSnapshotResult) => void): Request; + /** + * Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + restoreFromClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.RestoreFromClusterSnapshotResult) => void): Request; + /** + * Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot. + */ + restoreTableFromClusterSnapshot(params: Redshift.Types.RestoreTableFromClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.RestoreTableFromClusterSnapshotResult) => void): Request; + /** + * Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot. + */ + restoreTableFromClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.RestoreTableFromClusterSnapshotResult) => void): Request; + /** + * Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. + */ + revokeClusterSecurityGroupIngress(params: Redshift.Types.RevokeClusterSecurityGroupIngressMessage, callback?: (err: AWSError, data: Redshift.Types.RevokeClusterSecurityGroupIngressResult) => void): Request; + /** + * Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. + */ + revokeClusterSecurityGroupIngress(callback?: (err: AWSError, data: Redshift.Types.RevokeClusterSecurityGroupIngressResult) => void): Request; + /** + * Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + revokeSnapshotAccess(params: Redshift.Types.RevokeSnapshotAccessMessage, callback?: (err: AWSError, data: Redshift.Types.RevokeSnapshotAccessResult) => void): Request; + /** + * Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. + */ + revokeSnapshotAccess(callback?: (err: AWSError, data: Redshift.Types.RevokeSnapshotAccessResult) => void): Request; + /** + * Rotates the encryption keys for a cluster. + */ + rotateEncryptionKey(params: Redshift.Types.RotateEncryptionKeyMessage, callback?: (err: AWSError, data: Redshift.Types.RotateEncryptionKeyResult) => void): Request; + /** + * Rotates the encryption keys for a cluster. + */ + rotateEncryptionKey(callback?: (err: AWSError, data: Redshift.Types.RotateEncryptionKeyResult) => void): Request; + /** + * Waits for the clusterAvailable state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times). + */ + waitFor(state: "clusterAvailable", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Waits for the clusterAvailable state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times). + */ + waitFor(state: "clusterAvailable", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Waits for the clusterDeleted state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times). + */ + waitFor(state: "clusterDeleted", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Waits for the clusterDeleted state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times). + */ + waitFor(state: "clusterDeleted", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Waits for the clusterRestored state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times). + */ + waitFor(state: "clusterRestored", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Waits for the clusterRestored state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times). + */ + waitFor(state: "clusterRestored", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request; + /** + * Waits for the snapshotAvailable state by periodically calling the underlying Redshift.describeClusterSnapshotsoperation every 15 seconds (at most 20 times). + */ + waitFor(state: "snapshotAvailable", params: Redshift.Types.DescribeClusterSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request; + /** + * Waits for the snapshotAvailable state by periodically calling the underlying Redshift.describeClusterSnapshotsoperation every 15 seconds (at most 20 times). + */ + waitFor(state: "snapshotAvailable", callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request; +} +declare namespace Redshift { + export interface AcceptReservedNodeExchangeInputMessage { + /** + * A string representing the node identifier of the DC1 Reserved Node to be exchanged. + */ + ReservedNodeId: String; + /** + * The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings + */ + TargetReservedNodeOfferingId: String; + } + export interface AcceptReservedNodeExchangeOutputMessage { + /** + * + */ + ExchangedReservedNode?: ReservedNode; + } + export interface AccountAttribute { + /** + * The name of the attribute. + */ + AttributeName?: String; + /** + * A list of attribute values. + */ + AttributeValues?: AttributeValueList; + } + export interface AccountAttributeList { + /** + * A list of attributes assigned to an account. + */ + AccountAttributes?: AttributeList; + } + export interface AccountWithRestoreAccess { + /** + * The identifier of an AWS customer account authorized to restore a snapshot. + */ + AccountId?: String; + /** + * The identifier of an AWS support account authorized to restore a snapshot. For AWS support, the identifier is amazon-redshift-support. + */ + AccountAlias?: String; + } + export type AccountsWithRestoreAccessList = AccountWithRestoreAccess[]; + export type AssociatedClusterList = ClusterAssociatedToSchedule[]; + export type AttributeList = AccountAttribute[]; + export type AttributeNameList = String[]; + export type AttributeValueList = AttributeValueTarget[]; + export interface AttributeValueTarget { + /** + * The value of the attribute. + */ + AttributeValue?: String; + } + export interface AuthorizeClusterSecurityGroupIngressMessage { + /** + * The name of the security group to which the ingress rule is added. + */ + ClusterSecurityGroupName: String; + /** + * The IP range to be added the Amazon Redshift security group. + */ + CIDRIP?: String; + /** + * The EC2 security group to be added the Amazon Redshift security group. + */ + EC2SecurityGroupName?: String; + /** + * The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: 111122223333 + */ + EC2SecurityGroupOwnerId?: String; + } + export interface AuthorizeClusterSecurityGroupIngressResult { + ClusterSecurityGroup?: ClusterSecurityGroup; + } + export interface AuthorizeSnapshotAccessMessage { + /** + * The identifier of the snapshot the account is authorized to restore. + */ + SnapshotIdentifier: String; + /** + * The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + */ + SnapshotClusterIdentifier?: String; + /** + * The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support. + */ + AccountWithRestoreAccess: String; + } + export interface AuthorizeSnapshotAccessResult { + Snapshot?: Snapshot; + } + export interface AvailabilityZone { + /** + * The name of the availability zone. + */ + Name?: String; + /** + * + */ + SupportedPlatforms?: SupportedPlatformsList; + } + export type AvailabilityZoneList = AvailabilityZone[]; + export interface BatchDeleteClusterSnapshotsRequest { + /** + * A list of identifiers for the snapshots that you want to delete. + */ + Identifiers: DeleteClusterSnapshotMessageList; + } + export interface BatchDeleteClusterSnapshotsResult { + /** + * A list of the snapshot identifiers that were deleted. + */ + Resources?: SnapshotIdentifierList; + /** + * A list of any errors returned. + */ + Errors?: BatchSnapshotOperationErrorList; + } + export interface BatchModifyClusterSnapshotsMessage { + /** + * A list of snapshot identifiers you want to modify. + */ + SnapshotIdentifierList: SnapshotIdentifierList; + /** + * The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + /** + * A boolean value indicating whether to override an exception if the retention period has passed. + */ + Force?: Boolean; + } + export interface BatchModifyClusterSnapshotsOutputMessage { + /** + * A list of the snapshots that were modified. + */ + Resources?: SnapshotIdentifierList; + /** + * A list of any errors returned. + */ + Errors?: BatchSnapshotOperationErrors; + } + export type BatchSnapshotOperationErrorList = SnapshotErrorMessage[]; + export type BatchSnapshotOperationErrors = SnapshotErrorMessage[]; + export type Boolean = boolean; + export type BooleanOptional = boolean; + export interface CancelResizeMessage { + /** + * The unique identifier for the cluster that you want to cancel a resize operation for. + */ + ClusterIdentifier: String; + } + export interface Cluster { + /** + * The unique identifier of the cluster. + */ + ClusterIdentifier?: String; + /** + * The node type for the nodes in the cluster. + */ + NodeType?: String; + /** + * The current state of the cluster. Possible values are the following: available available, prep-for-resize available, resize-cleanup cancelling-resize creating deleting final-snapshot hardware-failure incompatible-hsm incompatible-network incompatible-parameters incompatible-restore modifying rebooting renaming resizing rotating-keys storage-full updating-hsm + */ + ClusterStatus?: String; + /** + * The status of a modify operation, if any, initiated for the cluster. + */ + ModifyStatus?: String; + /** + * The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter. + */ + MasterUsername?: String; + /** + * The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default. + */ + DBName?: String; + /** + * The connection endpoint. + */ + Endpoint?: Endpoint; + /** + * The date and time that the cluster was created. + */ + ClusterCreateTime?: TStamp; + /** + * The number of days that automatic cluster snapshots are retained. + */ + AutomatedSnapshotRetentionPeriod?: Integer; + /** + * The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653. + */ + ManualSnapshotRetentionPeriod?: Integer; + /** + * A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter. + */ + ClusterSecurityGroups?: ClusterSecurityGroupMembershipList; + /** + * A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC. + */ + VpcSecurityGroups?: VpcSecurityGroupMembershipList; + /** + * The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status. + */ + ClusterParameterGroups?: ClusterParameterGroupStatusList; + /** + * The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC. + */ + ClusterSubnetGroupName?: String; + /** + * The identifier of the VPC the cluster is in, if the cluster is in a VPC. + */ + VpcId?: String; + /** + * The name of the Availability Zone in which the cluster is located. + */ + AvailabilityZone?: String; + /** + * The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. + */ + PreferredMaintenanceWindow?: String; + /** + * A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements. + */ + PendingModifiedValues?: PendingModifiedValues; + /** + * The version ID of the Amazon Redshift engine that is running on the cluster. + */ + ClusterVersion?: String; + /** + * A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. + */ + AllowVersionUpgrade?: Boolean; + /** + * The number of compute nodes in the cluster. + */ + NumberOfNodes?: Integer; + /** + * A boolean value that, if true, indicates that the cluster can be accessed from a public network. + */ + PubliclyAccessible?: Boolean; + /** + * A boolean value that, if true, indicates that data in the cluster is encrypted at rest. + */ + Encrypted?: Boolean; + /** + * A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot. + */ + RestoreStatus?: RestoreStatus; + /** + * + */ + DataTransferProgress?: DataTransferProgress; + /** + * A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command. Values: active, applying + */ + HsmStatus?: HsmStatus; + /** + * A value that returns the destination region and retention period that are configured for cross-region snapshot copy. + */ + ClusterSnapshotCopyStatus?: ClusterSnapshotCopyStatus; + /** + * The public key for the cluster. + */ + ClusterPublicKey?: String; + /** + * The nodes in the cluster. + */ + ClusterNodes?: ClusterNodesList; + /** + * The status of the elastic IP (EIP) address. + */ + ElasticIpStatus?: ElasticIpStatus; + /** + * The specific revision number of the database in the cluster. + */ + ClusterRevisionNumber?: String; + /** + * The list of tags for the cluster. + */ + Tags?: TagList; + /** + * The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster. + */ + KmsKeyId?: String; + /** + * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false + */ + EnhancedVpcRouting?: Boolean; + /** + * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. + */ + IamRoles?: ClusterIamRoleList; + /** + * Cluster operations that are waiting to be started. + */ + PendingActions?: PendingActionsList; + /** + * The name of the maintenance track for the cluster. + */ + MaintenanceTrackName?: String; + /** + * The number of nodes that you can resize the cluster to with the elastic resize method. + */ + ElasticResizeNumberOfNodeOptions?: String; + /** + * Describes a group of DeferredMaintenanceWindow objects. + */ + DeferredMaintenanceWindows?: DeferredMaintenanceWindowsList; + /** + * A unique identifier for the cluster snapshot schedule. + */ + SnapshotScheduleIdentifier?: String; + /** + * The current state of the cluster snapshot schedule. + */ + SnapshotScheduleState?: ScheduleState; + /** + * Returns the following: AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. ResizeType: Returns ClassicResize + */ + ResizeInfo?: ResizeInfo; + } + export interface ClusterAssociatedToSchedule { + /** + * + */ + ClusterIdentifier?: String; + /** + * + */ + ScheduleAssociationState?: ScheduleState; + } + export interface ClusterCredentials { + /** + * A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials. + */ + DbUser?: String; + /** + * A temporary password that authorizes the user name returned by DbUser to log on to the database DbName. + */ + DbPassword?: SensitiveString; + /** + * The date and time the password in DbPassword expires. + */ + Expiration?: TStamp; + } + export interface ClusterDbRevision { + /** + * The unique identifier of the cluster. + */ + ClusterIdentifier?: String; + /** + * A string representing the current cluster version. + */ + CurrentDatabaseRevision?: String; + /** + * The date on which the database revision was released. + */ + DatabaseRevisionReleaseDate?: TStamp; + /** + * A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to. + */ + RevisionTargets?: RevisionTargetsList; + } + export type ClusterDbRevisionsList = ClusterDbRevision[]; + export interface ClusterDbRevisionsMessage { + /** + * A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned. + */ + Marker?: String; + /** + * A list of revisions. + */ + ClusterDbRevisions?: ClusterDbRevisionsList; + } + export interface ClusterIamRole { + /** + * The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload. + */ + IamRoleArn?: String; + /** + * A value that describes the status of the IAM role's association with an Amazon Redshift cluster. The following are possible statuses and descriptions. in-sync: The role is available for use by the cluster. adding: The role is in the process of being associated with the cluster. removing: The role is in the process of being disassociated with the cluster. + */ + ApplyStatus?: String; + } + export type ClusterIamRoleList = ClusterIamRole[]; + export type ClusterList = Cluster[]; + export interface ClusterNode { + /** + * Whether the node is a leader node or a compute node. + */ + NodeRole?: String; + /** + * The private IP address of a node within a cluster. + */ + PrivateIPAddress?: String; + /** + * The public IP address of a node within a cluster. + */ + PublicIPAddress?: String; + } + export type ClusterNodesList = ClusterNode[]; + export interface ClusterParameterGroup { + /** + * The name of the cluster parameter group. + */ + ParameterGroupName?: String; + /** + * The name of the cluster parameter group family that this cluster parameter group is compatible with. + */ + ParameterGroupFamily?: String; + /** + * The description of the parameter group. + */ + Description?: String; + /** + * The list of tags for the cluster parameter group. + */ + Tags?: TagList; + } + export interface ClusterParameterGroupDetails { + /** + * A list of Parameter instances. Each instance lists the parameters of one cluster parameter group. + */ + Parameters?: ParametersList; + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + } + export interface ClusterParameterGroupNameMessage { + /** + * The name of the cluster parameter group. + */ + ParameterGroupName?: String; + /** + * The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster. + */ + ParameterGroupStatus?: String; + } + export interface ClusterParameterGroupStatus { + /** + * The name of the cluster parameter group. + */ + ParameterGroupName?: String; + /** + * The status of parameter updates. + */ + ParameterApplyStatus?: String; + /** + * The list of parameter statuses. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + ClusterParameterStatusList?: ClusterParameterStatusList; + } + export type ClusterParameterGroupStatusList = ClusterParameterGroupStatus[]; + export interface ClusterParameterGroupsMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group. + */ + ParameterGroups?: ParameterGroupList; + } + export interface ClusterParameterStatus { + /** + * The name of the parameter. + */ + ParameterName?: String; + /** + * The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied. The following are possible statuses and descriptions. in-sync: The parameter value is in sync with the database. pending-reboot: The parameter value will be applied after the cluster reboots. applying: The parameter value is being applied to the database. invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax. apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots. apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots. unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots. + */ + ParameterApplyStatus?: String; + /** + * The error that prevented the parameter from being applied to the database. + */ + ParameterApplyErrorDescription?: String; + } + export type ClusterParameterStatusList = ClusterParameterStatus[]; + export interface ClusterSecurityGroup { + /** + * The name of the cluster security group to which the operation was applied. + */ + ClusterSecurityGroupName?: String; + /** + * A description of the security group. + */ + Description?: String; + /** + * A list of EC2 security groups that are permitted to access clusters associated with this cluster security group. + */ + EC2SecurityGroups?: EC2SecurityGroupList; + /** + * A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group. + */ + IPRanges?: IPRangeList; + /** + * The list of tags for the cluster security group. + */ + Tags?: TagList; + } + export interface ClusterSecurityGroupMembership { + /** + * The name of the cluster security group. + */ + ClusterSecurityGroupName?: String; + /** + * The status of the cluster security group. + */ + Status?: String; + } + export type ClusterSecurityGroupMembershipList = ClusterSecurityGroupMembership[]; + export interface ClusterSecurityGroupMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of ClusterSecurityGroup instances. + */ + ClusterSecurityGroups?: ClusterSecurityGroups; + } + export type ClusterSecurityGroupNameList = String[]; + export type ClusterSecurityGroups = ClusterSecurityGroup[]; + export interface ClusterSnapshotCopyStatus { + /** + * The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. + */ + DestinationRegion?: String; + /** + * The number of days that automated snapshots are retained in the destination region after they are copied from a source region. + */ + RetentionPeriod?: Long; + /** + * The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. + */ + ManualSnapshotRetentionPeriod?: Integer; + /** + * The name of the snapshot copy grant. + */ + SnapshotCopyGrantName?: String; + } + export interface ClusterSubnetGroup { + /** + * The name of the cluster subnet group. + */ + ClusterSubnetGroupName?: String; + /** + * The description of the cluster subnet group. + */ + Description?: String; + /** + * The VPC ID of the cluster subnet group. + */ + VpcId?: String; + /** + * The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid. + */ + SubnetGroupStatus?: String; + /** + * A list of the VPC Subnet elements. + */ + Subnets?: SubnetList; + /** + * The list of tags for the cluster subnet group. + */ + Tags?: TagList; + } + export interface ClusterSubnetGroupMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of ClusterSubnetGroup instances. + */ + ClusterSubnetGroups?: ClusterSubnetGroups; + } + export type ClusterSubnetGroups = ClusterSubnetGroup[]; + export interface ClusterVersion { + /** + * The version number used by the cluster. + */ + ClusterVersion?: String; + /** + * The name of the cluster parameter group family for the cluster. + */ + ClusterParameterGroupFamily?: String; + /** + * The description of the cluster version. + */ + Description?: String; + } + export type ClusterVersionList = ClusterVersion[]; + export interface ClusterVersionsMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of Version elements. + */ + ClusterVersions?: ClusterVersionList; + } + export interface ClustersMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of Cluster objects, where each object describes one cluster. + */ + Clusters?: ClusterList; + } + export interface CopyClusterSnapshotMessage { + /** + * The identifier for the source snapshot. Constraints: Must be the identifier for a valid automated snapshot whose state is available. + */ + SourceSnapshotIdentifier: String; + /** + * The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the identifier for a valid cluster. + */ + SourceSnapshotClusterIdentifier?: String; + /** + * The identifier given to the new manual snapshot. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for the AWS account that is making the request. + */ + TargetSnapshotIdentifier: String; + /** + * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + } + export interface CopyClusterSnapshotResult { + Snapshot?: Snapshot; + } + export interface CreateClusterMessage { + /** + * The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. + */ + DBName?: String; + /** + * A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: myexamplecluster + */ + ClusterIdentifier: String; + /** + * The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node + */ + ClusterType?: String; + /** + * The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | ds2.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge + */ + NodeType: String; + /** + * The user name associated with the master user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC. First character must be a letter. Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. + */ + MasterUsername: String; + /** + * The password associated with the master user account for the cluster that is being created. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space. + */ + MasterUserPassword: String; + /** + * A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. + */ + ClusterSecurityGroups?: ClusterSecurityGroupNameList; + /** + * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC). + */ + ClusterSubnetGroupName?: String; + /** + * The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: us-east-1d Constraint: The specified Availability Zone must be in the same region as the current endpoint. + */ + AvailabilityZone?: String; + /** + * The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + ClusterParameterGroupName?: String; + /** + * The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: 1 Constraints: Must be a value from 0 to 35. + */ + AutomatedSnapshotRetentionPeriod?: IntegerOptional; + /** + * The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + /** + * The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: 1150-65535 + */ + Port?: IntegerOptional; + /** + * The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: 1.0 + */ + ClusterVersion?: String; + /** + * If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true + */ + AllowVersionUpgrade?: BooleanOptional; + /** + * The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than 100. + */ + NumberOfNodes?: IntegerOptional; + /** + * If true, the cluster can be accessed from a public network. + */ + PubliclyAccessible?: BooleanOptional; + /** + * If true, the data in the cluster is encrypted at rest. Default: false + */ + Encrypted?: BooleanOptional; + /** + * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. + */ + HsmClientCertificateIdentifier?: String; + /** + * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + */ + HsmConfigurationIdentifier?: String; + /** + * The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide. + */ + ElasticIp?: String; + /** + * A list of tag instances. + */ + Tags?: TagList; + /** + * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. + */ + KmsKeyId?: String; + /** + * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false + */ + EnhancedVpcRouting?: BooleanOptional; + /** + * Reserved. + */ + AdditionalInfo?: String; + /** + * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time. + */ + IamRoles?: IamRoleArnList; + /** + * An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track. + */ + MaintenanceTrackName?: String; + /** + * A unique identifier for the snapshot schedule. + */ + SnapshotScheduleIdentifier?: String; + } + export interface CreateClusterParameterGroupMessage { + /** + * The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique withing your AWS account. This value is stored as a lower-case string. + */ + ParameterGroupName: String; + /** + * The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0". + */ + ParameterGroupFamily: String; + /** + * A description of the parameter group. + */ + Description: String; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateClusterParameterGroupResult { + ClusterParameterGroup?: ClusterParameterGroup; + } + export interface CreateClusterResult { + Cluster?: Cluster; + } + export interface CreateClusterSecurityGroupMessage { + /** + * The name for the security group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all security groups that are created by your AWS account. Example: examplesecuritygroup + */ + ClusterSecurityGroupName: String; + /** + * A description for the security group. + */ + Description: String; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateClusterSecurityGroupResult { + ClusterSecurityGroup?: ClusterSecurityGroup; + } + export interface CreateClusterSnapshotMessage { + /** + * A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id + */ + SnapshotIdentifier: String; + /** + * The cluster identifier for which you want a snapshot. + */ + ClusterIdentifier: String; + /** + * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateClusterSnapshotResult { + Snapshot?: Snapshot; + } + export interface CreateClusterSubnetGroupMessage { + /** + * The name for the subnet group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all subnet groups that are created by your AWS account. Example: examplesubnetgroup + */ + ClusterSubnetGroupName: String; + /** + * A description for the subnet group. + */ + Description: String; + /** + * An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. + */ + SubnetIds: SubnetIdentifierList; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateClusterSubnetGroupResult { + ClusterSubnetGroup?: ClusterSubnetGroup; + } + export interface CreateEventSubscriptionMessage { + /** + * The name of the event subscription to be created. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + SubscriptionName: String; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + */ + SnsTopicArn: String; + /** + * The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot. + */ + SourceType?: String; + /** + * A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010 + */ + SourceIds?: SourceIdsList; + /** + * Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security + */ + EventCategories?: EventCategoriesList; + /** + * Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO + */ + Severity?: String; + /** + * A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. + */ + Enabled?: BooleanOptional; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface CreateHsmClientCertificateMessage { + /** + * The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys. + */ + HsmClientCertificateIdentifier: String; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateHsmClientCertificateResult { + HsmClientCertificate?: HsmClientCertificate; + } + export interface CreateHsmConfigurationMessage { + /** + * The identifier to be assigned to the new Amazon Redshift HSM configuration. + */ + HsmConfigurationIdentifier: String; + /** + * A text description of the HSM configuration to be created. + */ + Description: String; + /** + * The IP address that the Amazon Redshift cluster must use to access the HSM. + */ + HsmIpAddress: String; + /** + * The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys. + */ + HsmPartitionName: String; + /** + * The password required to access the HSM partition. + */ + HsmPartitionPassword: String; + /** + * The HSMs public certificate file. When using Cloud HSM, the file name is server.pem. + */ + HsmServerPublicCertificate: String; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateHsmConfigurationResult { + HsmConfiguration?: HsmConfiguration; + } + export interface CreateSnapshotCopyGrantMessage { + /** + * The name of the snapshot copy grant. This name must be unique in the region for the AWS account. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. + */ + SnapshotCopyGrantName: String; + /** + * The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used. + */ + KmsKeyId?: String; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export interface CreateSnapshotCopyGrantResult { + SnapshotCopyGrant?: SnapshotCopyGrant; + } + export interface CreateSnapshotScheduleMessage { + /** + * The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)". + */ + ScheduleDefinitions?: ScheduleDefinitionList; + /** + * A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier. + */ + ScheduleIdentifier?: String; + /** + * The description of the snapshot schedule. + */ + ScheduleDescription?: String; + /** + * An optional set of tags you can use to search for the schedule. + */ + Tags?: TagList; + /** + * + */ + DryRun?: BooleanOptional; + /** + * + */ + NextInvocations?: IntegerOptional; + } + export interface CreateTagsMessage { + /** + * The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1. + */ + ResourceName: String; + /** + * One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0". + */ + Tags: TagList; + } + export interface CustomerStorageMessage { + /** + * The total amount of storage currently used for snapshots. + */ + TotalBackupSizeInMegaBytes?: Double; + /** + * The total amount of storage currently provisioned. + */ + TotalProvisionedStorageInMegaBytes?: Double; + } + export interface DataTransferProgress { + /** + * Describes the status of the cluster. While the transfer is in progress the status is transferringdata. + */ + Status?: String; + /** + * Describes the data transfer rate in MB's per second. + */ + CurrentRateInMegaBytesPerSecond?: DoubleOptional; + /** + * Describes the total amount of data to be transfered in megabytes. + */ + TotalDataInMegaBytes?: Long; + /** + * Describes the total amount of data that has been transfered in MB's. + */ + DataTransferredInMegaBytes?: Long; + /** + * Describes the estimated number of seconds remaining to complete the transfer. + */ + EstimatedTimeToCompletionInSeconds?: LongOptional; + /** + * Describes the number of seconds that have elapsed during the data transfer. + */ + ElapsedTimeInSeconds?: LongOptional; + } + export type DbGroupList = String[]; + export interface DefaultClusterParameters { + /** + * The name of the cluster parameter group family to which the engine default parameters apply. + */ + ParameterGroupFamily?: String; + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * The list of cluster default parameters. + */ + Parameters?: ParametersList; + } + export interface DeferredMaintenanceWindow { + /** + * A unique identifier for the maintenance window. + */ + DeferMaintenanceIdentifier?: String; + /** + * A timestamp for the beginning of the time period when we defer maintenance. + */ + DeferMaintenanceStartTime?: TStamp; + /** + * A timestamp for the end of the time period when we defer maintenance. + */ + DeferMaintenanceEndTime?: TStamp; + } + export type DeferredMaintenanceWindowsList = DeferredMaintenanceWindow[]; + export interface DeleteClusterMessage { + /** + * The identifier of the cluster to be deleted. Constraints: Must contain lowercase characters. Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + ClusterIdentifier: String; + /** + * Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false. Default: false + */ + SkipFinalClusterSnapshot?: Boolean; + /** + * The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false. Constraints: Must be 1 to 255 alphanumeric characters. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + FinalClusterSnapshotIdentifier?: String; + /** + * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1. + */ + FinalClusterSnapshotRetentionPeriod?: IntegerOptional; + } + export interface DeleteClusterParameterGroupMessage { + /** + * The name of the parameter group to be deleted. Constraints: Must be the name of an existing cluster parameter group. Cannot delete a default cluster parameter group. + */ + ParameterGroupName: String; + } + export interface DeleteClusterResult { + Cluster?: Cluster; + } + export interface DeleteClusterSecurityGroupMessage { + /** + * The name of the cluster security group to be deleted. + */ + ClusterSecurityGroupName: String; + } + export interface DeleteClusterSnapshotMessage { + /** + * The unique identifier of the manual snapshot to be deleted. Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state. + */ + SnapshotIdentifier: String; + /** + * The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the name of valid cluster. + */ + SnapshotClusterIdentifier?: String; + } + export type DeleteClusterSnapshotMessageList = DeleteClusterSnapshotMessage[]; + export interface DeleteClusterSnapshotResult { + Snapshot?: Snapshot; + } + export interface DeleteClusterSubnetGroupMessage { + /** + * The name of the cluster subnet group name to be deleted. + */ + ClusterSubnetGroupName: String; + } + export interface DeleteEventSubscriptionMessage { + /** + * The name of the Amazon Redshift event notification subscription to be deleted. + */ + SubscriptionName: String; + } + export interface DeleteHsmClientCertificateMessage { + /** + * The identifier of the HSM client certificate to be deleted. + */ + HsmClientCertificateIdentifier: String; + } + export interface DeleteHsmConfigurationMessage { + /** + * The identifier of the Amazon Redshift HSM configuration to be deleted. + */ + HsmConfigurationIdentifier: String; + } + export interface DeleteSnapshotCopyGrantMessage { + /** + * The name of the snapshot copy grant to delete. + */ + SnapshotCopyGrantName: String; + } + export interface DeleteSnapshotScheduleMessage { + /** + * A unique identifier of the snapshot schedule to delete. + */ + ScheduleIdentifier: String; + } + export interface DeleteTagsMessage { + /** + * The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1. + */ + ResourceName: String; + /** + * The tag key that you want to delete. + */ + TagKeys: TagKeyList; + } + export interface DescribeAccountAttributesMessage { + /** + * A list of attribute names. + */ + AttributeNames?: AttributeNameList; + } + export interface DescribeClusterDbRevisionsMessage { + /** + * A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default. + */ + ClusterIdentifier?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both. + */ + Marker?: String; + } + export interface DescribeClusterParameterGroupsMessage { + /** + * The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned. + */ + ParameterGroupName?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeClusterParametersMessage { + /** + * The name of a cluster parameter group for which to return details. + */ + ParameterGroupName: String; + /** + * The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default + */ + Source?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeClusterSecurityGroupsMessage { + /** + * The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. Example: securitygroup1 + */ + ClusterSecurityGroupName?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeClusterSnapshotsMessage { + /** + * The identifier of the cluster which generated the requested snapshots. + */ + ClusterIdentifier?: String; + /** + * The snapshot identifier of the snapshot about which to return information. + */ + SnapshotIdentifier?: String; + /** + * The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. Valid Values: automated | manual + */ + SnapshotType?: String; + /** + * A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z + */ + StartTime?: TStamp; + /** + * A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z + */ + EndTime?: TStamp; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + /** + * The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter. + */ + OwnerAccount?: String; + /** + * A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + /** + * A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows: If ClusterExists is set to true, ClusterIdentifier is required. If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned. If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned. If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned. + */ + ClusterExists?: BooleanOptional; + /** + * + */ + SortingEntities?: SnapshotSortingEntityList; + } + export interface DescribeClusterSubnetGroupsMessage { + /** + * The name of the cluster subnet group for which information is requested. + */ + ClusterSubnetGroupName?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeClusterTracksMessage { + /** + * The name of the maintenance track. + */ + MaintenanceTrackName?: String; + /** + * An integer value for the maximum number of maintenance tracks to return. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeClusterVersionsMessage { + /** + * The specific cluster version to return. Example: 1.0 + */ + ClusterVersion?: String; + /** + * The name of a specific cluster parameter group family to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens + */ + ClusterParameterGroupFamily?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeClustersMessage { + /** + * The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned. + */ + ClusterIdentifier?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeDefaultClusterParametersMessage { + /** + * The name of the cluster parameter group family. + */ + ParameterGroupFamily: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeDefaultClusterParametersResult { + DefaultClusterParameters?: DefaultClusterParameters; + } + export interface DescribeEventCategoriesMessage { + /** + * The source type, such as cluster or parameter group, to which the described event categories apply. Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group. + */ + SourceType?: String; + } + export interface DescribeEventSubscriptionsMessage { + /** + * The name of the Amazon Redshift event notification subscription to be described. + */ + SubscriptionName?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeEventsMessage { + /** + * The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. Specify a cluster identifier when SourceType is cluster. Specify a cluster security group name when SourceType is cluster-security-group. Specify a cluster parameter group name when SourceType is cluster-parameter-group. Specify a cluster snapshot identifier when SourceType is cluster-snapshot. + */ + SourceIdentifier?: String; + /** + * The event source to retrieve events for. If no value is specified, all events are returned. Constraints: If SourceType is supplied, SourceIdentifier must also be provided. Specify cluster when SourceIdentifier is a cluster identifier. Specify cluster-security-group when SourceIdentifier is a cluster security group name. Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name. Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier. + */ + SourceType?: SourceType; + /** + * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z + */ + StartTime?: TStamp; + /** + * The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z + */ + EndTime?: TStamp; + /** + * The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. Default: 60 + */ + Duration?: IntegerOptional; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeHsmClientCertificatesMessage { + /** + * The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account. + */ + HsmClientCertificateIdentifier?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeHsmConfigurationsMessage { + /** + * The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account. + */ + HsmConfigurationIdentifier?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeLoggingStatusMessage { + /** + * The identifier of the cluster from which to get the logging status. Example: examplecluster + */ + ClusterIdentifier: String; + } + export interface DescribeOrderableClusterOptionsMessage { + /** + * The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from DescribeClusterVersions. + */ + ClusterVersion?: String; + /** + * The node type filter value. Specify this parameter to show only the available offerings matching the specified node type. + */ + NodeType?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeReservedNodeOfferingsMessage { + /** + * The unique identifier for the offering. + */ + ReservedNodeOfferingId?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeReservedNodesMessage { + /** + * Identifier for the node reservation. + */ + ReservedNodeId?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface DescribeResizeMessage { + /** + * The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an AWS account are returned. + */ + ClusterIdentifier: String; + } + export interface DescribeSnapshotCopyGrantsMessage { + /** + * The name of the snapshot copy grant. + */ + SnapshotCopyGrantName?: String; + /** + * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. + */ + MaxRecords?: IntegerOptional; + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DescribeSnapshotSchedulesMessage { + /** + * The unique identifier for the cluster whose snapshot schedules you want to view. + */ + ClusterIdentifier?: String; + /** + * A unique identifier for a snapshot schedule. + */ + ScheduleIdentifier?: String; + /** + * The key value for a snapshot schedule tag. + */ + TagKeys?: TagKeyList; + /** + * The value corresponding to the key of the snapshot schedule tag. + */ + TagValues?: TagValueList; + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. + */ + MaxRecords?: IntegerOptional; + } + export interface DescribeSnapshotSchedulesOutputMessage { + /** + * A list of SnapshotSchedules. + */ + SnapshotSchedules?: SnapshotScheduleList; + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + } + export interface DescribeTableRestoreStatusMessage { + /** + * The Amazon Redshift cluster that the table is being restored to. + */ + ClusterIdentifier?: String; + /** + * The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests. + */ + TableRestoreRequestId?: String; + /** + * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. + */ + MaxRecords?: IntegerOptional; + /** + * An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. + */ + Marker?: String; + } + export interface DescribeTagsMessage { + /** + * The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1. + */ + ResourceName?: String; + /** + * The type of resource with which you want to view tags. Valid resource types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group Snapshot copy grant For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide. + */ + ResourceType?: String; + /** + * The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. + */ + MaxRecords?: IntegerOptional; + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them. + */ + TagKeys?: TagKeyList; + /** + * A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them. + */ + TagValues?: TagValueList; + } + export interface DisableLoggingMessage { + /** + * The identifier of the cluster on which logging is to be stopped. Example: examplecluster + */ + ClusterIdentifier: String; + } + export interface DisableSnapshotCopyMessage { + /** + * The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. + */ + ClusterIdentifier: String; + } + export interface DisableSnapshotCopyResult { + Cluster?: Cluster; + } + export type Double = number; + export type DoubleOptional = number; + export interface EC2SecurityGroup { + /** + * The status of the EC2 security group. + */ + Status?: String; + /** + * The name of the EC2 Security Group. + */ + EC2SecurityGroupName?: String; + /** + * The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field. + */ + EC2SecurityGroupOwnerId?: String; + /** + * The list of tags for the EC2 security group. + */ + Tags?: TagList; + } + export type EC2SecurityGroupList = EC2SecurityGroup[]; + export interface ElasticIpStatus { + /** + * The elastic IP (EIP) address for the cluster. + */ + ElasticIp?: String; + /** + * The status of the elastic IP (EIP) address. + */ + Status?: String; + } + export type EligibleTracksToUpdateList = UpdateTarget[]; + export interface EnableLoggingMessage { + /** + * The identifier of the cluster on which logging is to be started. Example: examplecluster + */ + ClusterIdentifier: String; + /** + * The name of an existing S3 bucket where the log files are to be stored. Constraints: Must be in the same region as the cluster The cluster must have read bucket and put object permissions + */ + BucketName: String; + /** + * The prefix applied to the log file names. Constraints: Cannot exceed 512 characters Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: x00 to x20 x22 x27 x5c x7f or larger + */ + S3KeyPrefix?: String; + } + export interface EnableSnapshotCopyMessage { + /** + * The unique identifier of the source cluster to copy snapshots from. Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled. + */ + ClusterIdentifier: String; + /** + * The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference. + */ + DestinationRegion: String; + /** + * The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default: 7. Constraints: Must be at least 1 and no more than 35. + */ + RetentionPeriod?: IntegerOptional; + /** + * The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + */ + SnapshotCopyGrantName?: String; + /** + * The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + } + export interface EnableSnapshotCopyResult { + Cluster?: Cluster; + } + export interface Endpoint { + /** + * The DNS address of the Cluster. + */ + Address?: String; + /** + * The port that the database engine is listening on. + */ + Port?: Integer; + } + export interface Event { + /** + * The identifier for the source of the event. + */ + SourceIdentifier?: String; + /** + * The source type for this event. + */ + SourceType?: SourceType; + /** + * The text of this event. + */ + Message?: String; + /** + * A list of the event categories. Values: Configuration, Management, Monitoring, Security + */ + EventCategories?: EventCategoriesList; + /** + * The severity of the event. Values: ERROR, INFO + */ + Severity?: String; + /** + * The date and time of the event. + */ + Date?: TStamp; + /** + * The identifier of the event. + */ + EventId?: String; + } + export type EventCategoriesList = String[]; + export interface EventCategoriesMap { + /** + * The source type, such as cluster or cluster-snapshot, that the returned categories belong to. + */ + SourceType?: String; + /** + * The events in the event category. + */ + Events?: EventInfoMapList; + } + export type EventCategoriesMapList = EventCategoriesMap[]; + export interface EventCategoriesMessage { + /** + * A list of event categories descriptions. + */ + EventCategoriesMapList?: EventCategoriesMapList; + } + export interface EventInfoMap { + /** + * The identifier of an Amazon Redshift event. + */ + EventId?: String; + /** + * The category of an Amazon Redshift event. + */ + EventCategories?: EventCategoriesList; + /** + * The description of an Amazon Redshift event. + */ + EventDescription?: String; + /** + * The severity of the event. Values: ERROR, INFO + */ + Severity?: String; + } + export type EventInfoMapList = EventInfoMap[]; + export type EventList = Event[]; + export interface EventSubscription { + /** + * The AWS customer account associated with the Amazon Redshift event notification subscription. + */ + CustomerAwsId?: String; + /** + * The name of the Amazon Redshift event notification subscription. + */ + CustSubscriptionId?: String; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription. + */ + SnsTopicArn?: String; + /** + * The status of the Amazon Redshift event notification subscription. Constraints: Can be one of the following: active | no-permission | topic-not-exist The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. + */ + Status?: String; + /** + * The date and time the Amazon Redshift event notification subscription was created. + */ + SubscriptionCreationTime?: TStamp; + /** + * The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot. + */ + SourceType?: String; + /** + * A list of the sources that publish events to the Amazon Redshift event notification subscription. + */ + SourceIdsList?: SourceIdsList; + /** + * The list of Amazon Redshift event categories specified in the event notification subscription. Values: Configuration, Management, Monitoring, Security + */ + EventCategoriesList?: EventCategoriesList; + /** + * The event severity specified in the Amazon Redshift event notification subscription. Values: ERROR, INFO + */ + Severity?: String; + /** + * A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled. + */ + Enabled?: Boolean; + /** + * The list of tags for the event subscription. + */ + Tags?: TagList; + } + export type EventSubscriptionsList = EventSubscription[]; + export interface EventSubscriptionsMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of event subscriptions. + */ + EventSubscriptionsList?: EventSubscriptionsList; + } + export interface EventsMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of Event instances. + */ + Events?: EventList; + } + export interface GetClusterCredentialsMessage { + /** + * The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database. For more information, see CREATE USER in the Amazon Redshift Database Developer Guide. Constraints: Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. + */ + DbUser: String; + /** + * The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database. Constraints: Must be 1 to 64 alphanumeric characters or hyphens Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. + */ + DbName?: String; + /** + * The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive. + */ + ClusterIdentifier: String; + /** + * The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900 + */ + DurationSeconds?: IntegerOptional; + /** + * Create a database user with the name specified for the user named in DbUser if one does not exist. + */ + AutoCreate?: BooleanOptional; + /** + * A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints Must be 1 to 64 alphanumeric characters or hyphens Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide. + */ + DbGroups?: DbGroupList; + } + export interface GetReservedNodeExchangeOfferingsInputMessage { + /** + * A string representing the node identifier for the DC1 Reserved Node to be exchanged. + */ + ReservedNodeId: String; + /** + * An integer setting the maximum number of ReservedNodeOfferings to retrieve. + */ + MaxRecords?: IntegerOptional; + /** + * A value that indicates the starting point for the next set of ReservedNodeOfferings. + */ + Marker?: String; + } + export interface GetReservedNodeExchangeOfferingsOutputMessage { + /** + * An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. + */ + Marker?: String; + /** + * Returns an array of ReservedNodeOffering objects. + */ + ReservedNodeOfferings?: ReservedNodeOfferingList; + } + export interface HsmClientCertificate { + /** + * The identifier of the HSM client certificate. + */ + HsmClientCertificateIdentifier?: String; + /** + * The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM. + */ + HsmClientCertificatePublicKey?: String; + /** + * The list of tags for the HSM client certificate. + */ + Tags?: TagList; + } + export type HsmClientCertificateList = HsmClientCertificate[]; + export interface HsmClientCertificateMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM. + */ + HsmClientCertificates?: HsmClientCertificateList; + } + export interface HsmConfiguration { + /** + * The name of the Amazon Redshift HSM configuration. + */ + HsmConfigurationIdentifier?: String; + /** + * A text description of the HSM configuration. + */ + Description?: String; + /** + * The IP address that the Amazon Redshift cluster must use to access the HSM. + */ + HsmIpAddress?: String; + /** + * The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys. + */ + HsmPartitionName?: String; + /** + * The list of tags for the HSM configuration. + */ + Tags?: TagList; + } + export type HsmConfigurationList = HsmConfiguration[]; + export interface HsmConfigurationMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of HsmConfiguration objects. + */ + HsmConfigurations?: HsmConfigurationList; + } + export interface HsmStatus { + /** + * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. + */ + HsmClientCertificateIdentifier?: String; + /** + * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + */ + HsmConfigurationIdentifier?: String; + /** + * Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Values: active, applying + */ + Status?: String; + } + export interface IPRange { + /** + * The status of the IP range, for example, "authorized". + */ + Status?: String; + /** + * The IP range in Classless Inter-Domain Routing (CIDR) notation. + */ + CIDRIP?: String; + /** + * The list of tags for the IP range. + */ + Tags?: TagList; + } + export type IPRangeList = IPRange[]; + export type IamRoleArnList = String[]; + export type ImportTablesCompleted = String[]; + export type ImportTablesInProgress = String[]; + export type ImportTablesNotStarted = String[]; + export type Integer = number; + export type IntegerOptional = number; + export interface LoggingStatus { + /** + * true if logging is on, false if logging is off. + */ + LoggingEnabled?: Boolean; + /** + * The name of the S3 bucket where the log files are stored. + */ + BucketName?: String; + /** + * The prefix applied to the log file names. + */ + S3KeyPrefix?: String; + /** + * The last time that logs were delivered. + */ + LastSuccessfulDeliveryTime?: TStamp; + /** + * The last time when logs failed to be delivered. + */ + LastFailureTime?: TStamp; + /** + * The message indicating that logs failed to be delivered. + */ + LastFailureMessage?: String; + } + export type Long = number; + export type LongOptional = number; + export interface MaintenanceTrack { + /** + * The name of the maintenance track. Possible values are current and trailing. + */ + MaintenanceTrackName?: String; + /** + * The version number for the cluster release. + */ + DatabaseVersion?: String; + /** + * An array of UpdateTarget objects to update with the maintenance track. + */ + UpdateTargets?: EligibleTracksToUpdateList; + } + export interface ModifyClusterDbRevisionMessage { + /** + * The unique identifier of a cluster whose database revision you want to modify. Example: examplecluster + */ + ClusterIdentifier: String; + /** + * The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. + */ + RevisionTarget: String; + } + export interface ModifyClusterDbRevisionResult { + Cluster?: Cluster; + } + export interface ModifyClusterIamRolesMessage { + /** + * The unique identifier of the cluster for which you want to associate or disassociate IAM roles. + */ + ClusterIdentifier: String; + /** + * Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request. + */ + AddIamRoles?: IamRoleArnList; + /** + * Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request. + */ + RemoveIamRoles?: IamRoleArnList; + } + export interface ModifyClusterIamRolesResult { + Cluster?: Cluster; + } + export interface ModifyClusterMaintenanceMessage { + /** + * A unique identifier for the cluster. + */ + ClusterIdentifier: String; + /** + * A boolean indicating whether to enable the deferred maintenance window. + */ + DeferMaintenance?: BooleanOptional; + /** + * A unique identifier for the deferred maintenance window. + */ + DeferMaintenanceIdentifier?: String; + /** + * A timestamp indicating the start time for the deferred maintenance window. + */ + DeferMaintenanceStartTime?: TStamp; + /** + * A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. + */ + DeferMaintenanceEndTime?: TStamp; + /** + * An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. + */ + DeferMaintenanceDuration?: IntegerOptional; + } + export interface ModifyClusterMaintenanceResult { + Cluster?: Cluster; + } + export interface ModifyClusterMessage { + /** + * The unique identifier of the cluster to be modified. Example: examplecluster + */ + ClusterIdentifier: String; + /** + * The new cluster type. When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request. Valid Values: multi-node | single-node + */ + ClusterType?: String; + /** + * The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request. Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge + */ + NodeType?: String; + /** + * The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request. Valid Values: Integer greater than 0. + */ + NumberOfNodes?: IntegerOptional; + /** + * A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible. Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens + */ + ClusterSecurityGroups?: ClusterSecurityGroupNameList; + /** + * A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. Default: Uses existing setting. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space. + */ + MasterUserPassword?: String; + /** + * The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster. Default: Uses existing setting. Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version. + */ + ClusterParameterGroupName?: String; + /** + * The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted. Default: Uses existing setting. Constraints: Must be a value from 0 to 35. + */ + AutomatedSnapshotRetentionPeriod?: IntegerOptional; + /** + * The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots. The value must be either -1 or an integer between 1 and 3,653. The default value is -1. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + /** + * The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied. Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes. + */ + PreferredMaintenanceWindow?: String; + /** + * The new version number of the Amazon Redshift engine to upgrade to. For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. Example: 1.0 + */ + ClusterVersion?: String; + /** + * If true, major version upgrades will be applied automatically to the cluster during the maintenance window. Default: false + */ + AllowVersionUpgrade?: BooleanOptional; + /** + * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. + */ + HsmClientCertificateIdentifier?: String; + /** + * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + */ + HsmConfigurationIdentifier?: String; + /** + * The new identifier for the cluster. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: examplecluster + */ + NewClusterIdentifier?: String; + /** + * If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available. + */ + PubliclyAccessible?: BooleanOptional; + /** + * The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide. + */ + ElasticIp?: String; + /** + * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false + */ + EnhancedVpcRouting?: BooleanOptional; + /** + * The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. + */ + MaintenanceTrackName?: String; + /** + * Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the KmsKeyId parameter, we will encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted. + */ + Encrypted?: BooleanOptional; + /** + * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. + */ + KmsKeyId?: String; + } + export interface ModifyClusterParameterGroupMessage { + /** + * The name of the parameter group to be modified. + */ + ParameterGroupName: String; + /** + * An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. + */ + Parameters: ParametersList; + } + export interface ModifyClusterResult { + Cluster?: Cluster; + } + export interface ModifyClusterSnapshotMessage { + /** + * The identifier of the snapshot whose setting you want to modify. + */ + SnapshotIdentifier: String; + /** + * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot. The value must be either -1 or an integer between 1 and 3,653. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + /** + * A Boolean option to override an exception if the retention period has already passed. + */ + Force?: Boolean; + } + export interface ModifyClusterSnapshotResult { + Snapshot?: Snapshot; + } + export interface ModifyClusterSnapshotScheduleMessage { + /** + * A unique identifier for the cluster whose snapshot schedule you want to modify. + */ + ClusterIdentifier: String; + /** + * A unique alphanumeric identifier for the schedule that you want to associate with the cluster. + */ + ScheduleIdentifier?: String; + /** + * A boolean to indicate whether to remove the assoiciation between the cluster and the schedule. + */ + DisassociateSchedule?: BooleanOptional; + } + export interface ModifyClusterSubnetGroupMessage { + /** + * The name of the subnet group to be modified. + */ + ClusterSubnetGroupName: String; + /** + * A text description of the subnet group to be modified. + */ + Description?: String; + /** + * An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. + */ + SubnetIds: SubnetIdentifierList; + } + export interface ModifyClusterSubnetGroupResult { + ClusterSubnetGroup?: ClusterSubnetGroup; + } + export interface ModifyEventSubscriptionMessage { + /** + * The name of the modified Amazon Redshift event notification subscription. + */ + SubscriptionName: String; + /** + * The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription. + */ + SnsTopicArn?: String; + /** + * The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot. + */ + SourceType?: String; + /** + * A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010 + */ + SourceIds?: SourceIdsList; + /** + * Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security + */ + EventCategories?: EventCategoriesList; + /** + * Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO + */ + Severity?: String; + /** + * A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled + */ + Enabled?: BooleanOptional; + } + export interface ModifyEventSubscriptionResult { + EventSubscription?: EventSubscription; + } + export interface ModifySnapshotCopyRetentionPeriodMessage { + /** + * The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. + */ + ClusterIdentifier: String; + /** + * The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this only changes the retention period of copied automated snapshots. If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35 for automated snapshots. If you specify the manual option, only newly copied manual snapshots will have the new retention period. If you specify the value of -1 newly copied manual snapshots are retained indefinitely. Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots. + */ + RetentionPeriod: Integer; + /** + * Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. + */ + Manual?: Boolean; + } + export interface ModifySnapshotCopyRetentionPeriodResult { + Cluster?: Cluster; + } + export interface ModifySnapshotScheduleMessage { + /** + * A unique alphanumeric identifier of the schedule to modify. + */ + ScheduleIdentifier: String; + /** + * An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)". + */ + ScheduleDefinitions: ScheduleDefinitionList; + } + export interface OrderableClusterOption { + /** + * The version of the orderable cluster. + */ + ClusterVersion?: String; + /** + * The cluster type, for example multi-node. + */ + ClusterType?: String; + /** + * The node type for the orderable cluster. + */ + NodeType?: String; + /** + * A list of availability zones for the orderable cluster. + */ + AvailabilityZones?: AvailabilityZoneList; + } + export type OrderableClusterOptionsList = OrderableClusterOption[]; + export interface OrderableClusterOptionsMessage { + /** + * An OrderableClusterOption structure containing information about orderable options for the cluster. + */ + OrderableClusterOptions?: OrderableClusterOptionsList; + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + } + export interface Parameter { + /** + * The name of the parameter. + */ + ParameterName?: String; + /** + * The value of the parameter. + */ + ParameterValue?: String; + /** + * A description of the parameter. + */ + Description?: String; + /** + * The source of the parameter value, such as "engine-default" or "user". + */ + Source?: String; + /** + * The data type of the parameter. + */ + DataType?: String; + /** + * The valid range of values for the parameter. + */ + AllowedValues?: String; + /** + * Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. + */ + ApplyType?: ParameterApplyType; + /** + * If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. + */ + IsModifiable?: Boolean; + /** + * The earliest engine version to which the parameter can apply. + */ + MinimumEngineVersion?: String; + } + export type ParameterApplyType = "static"|"dynamic"|string; + export type ParameterGroupList = ClusterParameterGroup[]; + export type ParametersList = Parameter[]; + export type PendingActionsList = String[]; + export interface PendingModifiedValues { + /** + * The pending or in-progress change of the master user password for the cluster. + */ + MasterUserPassword?: String; + /** + * The pending or in-progress change of the cluster's node type. + */ + NodeType?: String; + /** + * The pending or in-progress change of the number of nodes in the cluster. + */ + NumberOfNodes?: IntegerOptional; + /** + * The pending or in-progress change of the cluster type. + */ + ClusterType?: String; + /** + * The pending or in-progress change of the service version. + */ + ClusterVersion?: String; + /** + * The pending or in-progress change of the automated snapshot retention period. + */ + AutomatedSnapshotRetentionPeriod?: IntegerOptional; + /** + * The pending or in-progress change of the new identifier for the cluster. + */ + ClusterIdentifier?: String; + /** + * The pending or in-progress change of the ability to connect to the cluster from the public network. + */ + PubliclyAccessible?: BooleanOptional; + /** + * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false + */ + EnhancedVpcRouting?: BooleanOptional; + /** + * The name of the maintenance track that the cluster will change to during the next maintenance window. + */ + MaintenanceTrackName?: String; + /** + * The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy. + */ + EncryptionType?: String; + } + export interface PurchaseReservedNodeOfferingMessage { + /** + * The unique identifier of the reserved node offering you want to purchase. + */ + ReservedNodeOfferingId: String; + /** + * The number of reserved nodes that you want to purchase. Default: 1 + */ + NodeCount?: IntegerOptional; + } + export interface PurchaseReservedNodeOfferingResult { + ReservedNode?: ReservedNode; + } + export interface RebootClusterMessage { + /** + * The cluster identifier. + */ + ClusterIdentifier: String; + } + export interface RebootClusterResult { + Cluster?: Cluster; + } + export interface RecurringCharge { + /** + * The amount charged per the period of time specified by the recurring charge frequency. + */ + RecurringChargeAmount?: Double; + /** + * The frequency at which the recurring charge amount is applied. + */ + RecurringChargeFrequency?: String; + } + export type RecurringChargeList = RecurringCharge[]; + export interface ReservedNode { + /** + * The unique identifier for the reservation. + */ + ReservedNodeId?: String; + /** + * The identifier for the reserved node offering. + */ + ReservedNodeOfferingId?: String; + /** + * The node type of the reserved node. + */ + NodeType?: String; + /** + * The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration. + */ + StartTime?: TStamp; + /** + * The duration of the node reservation in seconds. + */ + Duration?: Integer; + /** + * The fixed cost Amazon Redshift charges you for this reserved node. + */ + FixedPrice?: Double; + /** + * The hourly rate Amazon Redshift charges you for this reserved node. + */ + UsagePrice?: Double; + /** + * The currency code for the reserved cluster. + */ + CurrencyCode?: String; + /** + * The number of reserved compute nodes. + */ + NodeCount?: Integer; + /** + * The state of the reserved compute node. Possible Values: pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed. active-This reserved node is owned by the caller and is available for use. payment-failed-Payment failed for the purchase attempt. retired-The reserved node is no longer available. exchanging-The owner is exchanging the reserved node for another reserved node. + */ + State?: String; + /** + * The anticipated utilization of the reserved node, as defined in the reserved node offering. + */ + OfferingType?: String; + /** + * The recurring charges for the reserved node. + */ + RecurringCharges?: RecurringChargeList; + /** + * + */ + ReservedNodeOfferingType?: ReservedNodeOfferingType; + } + export type ReservedNodeList = ReservedNode[]; + export interface ReservedNodeOffering { + /** + * The offering identifier. + */ + ReservedNodeOfferingId?: String; + /** + * The node type offered by the reserved node offering. + */ + NodeType?: String; + /** + * The duration, in seconds, for which the offering will reserve the node. + */ + Duration?: Integer; + /** + * The upfront fixed charge you will pay to purchase the specific reserved node offering. + */ + FixedPrice?: Double; + /** + * The rate you are charged for each hour the cluster that is using the offering is running. + */ + UsagePrice?: Double; + /** + * The currency code for the compute nodes offering. + */ + CurrencyCode?: String; + /** + * The anticipated utilization of the reserved node, as defined in the reserved node offering. + */ + OfferingType?: String; + /** + * The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes. + */ + RecurringCharges?: RecurringChargeList; + /** + * + */ + ReservedNodeOfferingType?: ReservedNodeOfferingType; + } + export type ReservedNodeOfferingList = ReservedNodeOffering[]; + export type ReservedNodeOfferingType = "Regular"|"Upgradable"|string; + export interface ReservedNodeOfferingsMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of ReservedNodeOffering objects. + */ + ReservedNodeOfferings?: ReservedNodeOfferingList; + } + export interface ReservedNodesMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * The list of ReservedNode objects. + */ + ReservedNodes?: ReservedNodeList; + } + export interface ResetClusterParameterGroupMessage { + /** + * The name of the cluster parameter group to be reset. + */ + ParameterGroupName: String; + /** + * If true, all parameters in the specified parameter group will be reset to their default values. Default: true + */ + ResetAllParameters?: Boolean; + /** + * An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied. Constraints: A maximum of 20 parameters can be reset in a single request. + */ + Parameters?: ParametersList; + } + export interface ResizeClusterMessage { + /** + * The unique identifier for the cluster to resize. + */ + ClusterIdentifier: String; + /** + * The new cluster type for the specified cluster. + */ + ClusterType?: String; + /** + * The new node type for the nodes you are adding. + */ + NodeType?: String; + /** + * The new number of nodes for the cluster. + */ + NumberOfNodes: Integer; + /** + * A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic. + */ + Classic?: BooleanOptional; + } + export interface ResizeClusterResult { + Cluster?: Cluster; + } + export interface ResizeInfo { + /** + * Returns the value ClassicResize. + */ + ResizeType?: String; + /** + * A boolean value indicating if the resize operation can be cancelled. + */ + AllowCancelResize?: Boolean; + } + export interface ResizeProgressMessage { + /** + * The node type that the cluster will have after the resize operation is complete. + */ + TargetNodeType?: String; + /** + * The number of nodes that the cluster will have after the resize operation is complete. + */ + TargetNumberOfNodes?: IntegerOptional; + /** + * The cluster type after the resize operation is complete. Valid Values: multi-node | single-node + */ + TargetClusterType?: String; + /** + * The status of the resize operation. Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING + */ + Status?: String; + /** + * The names of tables that have been completely imported . Valid Values: List of table names. + */ + ImportTablesCompleted?: ImportTablesCompleted; + /** + * The names of tables that are being currently imported. Valid Values: List of table names. + */ + ImportTablesInProgress?: ImportTablesInProgress; + /** + * The names of tables that have not been yet imported. Valid Values: List of table names + */ + ImportTablesNotStarted?: ImportTablesNotStarted; + /** + * The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation. + */ + AvgResizeRateInMegaBytesPerSecond?: DoubleOptional; + /** + * The estimated total amount of data, in megabytes, on the cluster before the resize operation began. + */ + TotalResizeDataInMegaBytes?: LongOptional; + /** + * While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize). + */ + ProgressInMegaBytes?: LongOptional; + /** + * The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation. + */ + ElapsedTimeInSeconds?: LongOptional; + /** + * The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0. + */ + EstimatedTimeToCompletionInSeconds?: LongOptional; + /** + * An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed. + */ + ResizeType?: String; + /** + * An optional string to provide additional details about the resize action. + */ + Message?: String; + /** + * The type of encryption for the cluster after the resize is complete. Possible values are KMS and None. In the China region possible values are: Legacy and None. + */ + TargetEncryptionType?: String; + /** + * The percent of data transferred from source cluster to target cluster. + */ + DataTransferProgressPercent?: DoubleOptional; + } + export type RestorableNodeTypeList = String[]; + export interface RestoreFromClusterSnapshotMessage { + /** + * The identifier of the cluster that will be created from restoring the snapshot. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. + */ + ClusterIdentifier: String; + /** + * The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. Example: my-snapshot-id + */ + SnapshotIdentifier: String; + /** + * The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + */ + SnapshotClusterIdentifier?: String; + /** + * The port number on which the cluster accepts connections. Default: The same port as the original cluster. Constraints: Must be between 1115 and 65535. + */ + Port?: IntegerOptional; + /** + * The Amazon EC2 Availability Zone in which to restore the cluster. Default: A random, system-chosen Availability Zone. Example: us-east-1a + */ + AvailabilityZone?: String; + /** + * If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default: true + */ + AllowVersionUpgrade?: BooleanOptional; + /** + * The name of the subnet group where you want to cluster restored. A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored. + */ + ClusterSubnetGroupName?: String; + /** + * If true, the cluster can be accessed from a public network. + */ + PubliclyAccessible?: BooleanOptional; + /** + * The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. + */ + OwnerAccount?: String; + /** + * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. + */ + HsmClientCertificateIdentifier?: String; + /** + * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + */ + HsmConfigurationIdentifier?: String; + /** + * The elastic IP (EIP) address for the cluster. + */ + ElasticIp?: String; + /** + * The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups. Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. + */ + ClusterParameterGroupName?: String; + /** + * A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. Cluster security groups only apply to clusters outside of VPCs. + */ + ClusterSecurityGroups?: ClusterSecurityGroupNameList; + /** + * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. VPC security groups only apply to clusters in VPCs. + */ + VpcSecurityGroupIds?: VpcSecurityGroupIdList; + /** + * The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. + */ + PreferredMaintenanceWindow?: String; + /** + * The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: The value selected for the cluster from which the snapshot was taken. Constraints: Must be a value from 0 to 35. + */ + AutomatedSnapshotRetentionPeriod?: IntegerOptional; + /** + * The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + /** + * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot. + */ + KmsKeyId?: String; + /** + * The node type that the restored cluster will be provisioned with. Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlareg cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide. + */ + NodeType?: String; + /** + * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false + */ + EnhancedVpcRouting?: BooleanOptional; + /** + * Reserved. + */ + AdditionalInfo?: String; + /** + * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated at any time. + */ + IamRoles?: IamRoleArnList; + /** + * The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks. + */ + MaintenanceTrackName?: String; + /** + * A unique identifier for the snapshot schedule. + */ + SnapshotScheduleIdentifier?: String; + } + export interface RestoreFromClusterSnapshotResult { + Cluster?: Cluster; + } + export interface RestoreStatus { + /** + * The status of the restore action. Returns starting, restoring, completed, or failed. + */ + Status?: String; + /** + * The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. + */ + CurrentRestoreRateInMegaBytesPerSecond?: Double; + /** + * The size of the set of snapshot data used to restore the cluster. + */ + SnapshotSizeInMegaBytes?: Long; + /** + * The number of megabytes that have been transferred from snapshot storage. + */ + ProgressInMegaBytes?: Long; + /** + * The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. + */ + ElapsedTimeInSeconds?: Long; + /** + * The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. + */ + EstimatedTimeToCompletionInSeconds?: Long; + } + export interface RestoreTableFromClusterSnapshotMessage { + /** + * The identifier of the Amazon Redshift cluster to restore the table to. + */ + ClusterIdentifier: String; + /** + * The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter. + */ + SnapshotIdentifier: String; + /** + * The name of the source database that contains the table to restore from. + */ + SourceDatabaseName: String; + /** + * The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public. + */ + SourceSchemaName?: String; + /** + * The name of the source table to restore from. + */ + SourceTableName: String; + /** + * The name of the database to restore the table to. + */ + TargetDatabaseName?: String; + /** + * The name of the schema to restore the table to. + */ + TargetSchemaName?: String; + /** + * The name of the table to create as a result of the current request. + */ + NewTableName: String; + } + export interface RestoreTableFromClusterSnapshotResult { + TableRestoreStatus?: TableRestoreStatus; + } + export interface RevisionTarget { + /** + * A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision. + */ + DatabaseRevision?: String; + /** + * A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision. + */ + Description?: String; + /** + * The date on which the database revision was released. + */ + DatabaseRevisionReleaseDate?: TStamp; + } + export type RevisionTargetsList = RevisionTarget[]; + export interface RevokeClusterSecurityGroupIngressMessage { + /** + * The name of the security Group from which to revoke the ingress rule. + */ + ClusterSecurityGroupName: String; + /** + * The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided. + */ + CIDRIP?: String; + /** + * The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided. + */ + EC2SecurityGroupName?: String; + /** + * The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. Example: 111122223333 + */ + EC2SecurityGroupOwnerId?: String; + } + export interface RevokeClusterSecurityGroupIngressResult { + ClusterSecurityGroup?: ClusterSecurityGroup; + } + export interface RevokeSnapshotAccessMessage { + /** + * The identifier of the snapshot that the account can no longer access. + */ + SnapshotIdentifier: String; + /** + * The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + */ + SnapshotClusterIdentifier?: String; + /** + * The identifier of the AWS customer account that can no longer restore the specified snapshot. + */ + AccountWithRestoreAccess: String; + } + export interface RevokeSnapshotAccessResult { + Snapshot?: Snapshot; + } + export interface RotateEncryptionKeyMessage { + /** + * The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled. + */ + ClusterIdentifier: String; + } + export interface RotateEncryptionKeyResult { + Cluster?: Cluster; + } + export type ScheduleDefinitionList = String[]; + export type ScheduleState = "MODIFYING"|"ACTIVE"|"FAILED"|string; + export type ScheduledSnapshotTimeList = TStamp[]; + export type SensitiveString = string; + export interface Snapshot { + /** + * The snapshot identifier that is provided in the request. + */ + SnapshotIdentifier?: String; + /** + * The identifier of the cluster for which the snapshot was taken. + */ + ClusterIdentifier?: String; + /** + * The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time. + */ + SnapshotCreateTime?: TStamp; + /** + * The snapshot status. The value of the status depends on the API operation used: CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating". DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed". DeleteClusterSnapshot returns status as "deleted". + */ + Status?: String; + /** + * The port that the cluster is listening on. + */ + Port?: Integer; + /** + * The Availability Zone in which the cluster was created. + */ + AvailabilityZone?: String; + /** + * The time (UTC) when the cluster was originally created. + */ + ClusterCreateTime?: TStamp; + /** + * The master user name for the cluster. + */ + MasterUsername?: String; + /** + * The version ID of the Amazon Redshift engine that is running on the cluster. + */ + ClusterVersion?: String; + /** + * The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual". + */ + SnapshotType?: String; + /** + * The node type of the nodes in the cluster. + */ + NodeType?: String; + /** + * The number of nodes in the cluster. + */ + NumberOfNodes?: Integer; + /** + * The name of the database that was created when the cluster was created. + */ + DBName?: String; + /** + * The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output. + */ + VpcId?: String; + /** + * If true, the data in the snapshot is encrypted at rest. + */ + Encrypted?: Boolean; + /** + * The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken. + */ + KmsKeyId?: String; + /** + * A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys. + */ + EncryptedWithHSM?: Boolean; + /** + * A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner. + */ + AccountsWithRestoreAccess?: AccountsWithRestoreAccessList; + /** + * For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot. + */ + OwnerAccount?: String; + /** + * The size of the complete set of backup data that would be used to restore the cluster. + */ + TotalBackupSizeInMegaBytes?: Double; + /** + * The size of the incremental backup. + */ + ActualIncrementalBackupSizeInMegaBytes?: Double; + /** + * The number of megabytes that have been transferred to the snapshot backup. + */ + BackupProgressInMegaBytes?: Double; + /** + * The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup. + */ + CurrentBackupRateInMegaBytesPerSecond?: Double; + /** + * The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. + */ + EstimatedSecondsToCompletion?: Long; + /** + * The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish. + */ + ElapsedTimeInSeconds?: Long; + /** + * The source region from which the snapshot was copied. + */ + SourceRegion?: String; + /** + * The list of tags for the cluster snapshot. + */ + Tags?: TagList; + /** + * The list of node types that this cluster snapshot is able to restore into. + */ + RestorableNodeTypes?: RestorableNodeTypeList; + /** + * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false + */ + EnhancedVpcRouting?: Boolean; + /** + * The name of the maintenance track for the snapshot. + */ + MaintenanceTrackName?: String; + /** + * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. + */ + ManualSnapshotRetentionPeriod?: IntegerOptional; + /** + * The number of days until a manual snapshot will pass its retention period. + */ + ManualSnapshotRemainingDays?: IntegerOptional; + /** + * A timestamp representing the start of the retention period for the snapshot. + */ + SnapshotRetentionStartTime?: TStamp; + } + export type SnapshotAttributeToSortBy = "SOURCE_TYPE"|"TOTAL_SIZE"|"CREATE_TIME"|string; + export interface SnapshotCopyGrant { + /** + * The name of the snapshot copy grant. + */ + SnapshotCopyGrantName?: String; + /** + * The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission. + */ + KmsKeyId?: String; + /** + * A list of tag instances. + */ + Tags?: TagList; + } + export type SnapshotCopyGrantList = SnapshotCopyGrant[]; + export interface SnapshotCopyGrantMessage { + /** + * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both. + */ + Marker?: String; + /** + * The list of SnapshotCopyGrant objects. + */ + SnapshotCopyGrants?: SnapshotCopyGrantList; + } + export interface SnapshotErrorMessage { + /** + * A unique identifier for the snapshot returning the error. + */ + SnapshotIdentifier?: String; + /** + * A unique identifier for the cluster. + */ + SnapshotClusterIdentifier?: String; + /** + * The failure code for the error. + */ + FailureCode?: String; + /** + * The text message describing the error. + */ + FailureReason?: String; + } + export type SnapshotIdentifierList = String[]; + export type SnapshotList = Snapshot[]; + export interface SnapshotMessage { + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + /** + * A list of Snapshot instances. + */ + Snapshots?: SnapshotList; + } + export interface SnapshotSchedule { + /** + * A list of ScheduleDefinitions. + */ + ScheduleDefinitions?: ScheduleDefinitionList; + /** + * A unique identifier for the schedule. + */ + ScheduleIdentifier?: String; + /** + * The description of the schedule. + */ + ScheduleDescription?: String; + /** + * An optional set of tags describing the schedule. + */ + Tags?: TagList; + /** + * + */ + NextInvocations?: ScheduledSnapshotTimeList; + /** + * The number of clusters associated with the schedule. + */ + AssociatedClusterCount?: IntegerOptional; + /** + * A list of clusters associated with the schedule. A maximum of 100 clusters is returned. + */ + AssociatedClusters?: AssociatedClusterList; + } + export type SnapshotScheduleList = SnapshotSchedule[]; + export interface SnapshotSortingEntity { + /** + * The category for sorting the snapshots. + */ + Attribute: SnapshotAttributeToSortBy; + /** + * The order for listing the attributes. + */ + SortOrder?: SortByOrder; + } + export type SnapshotSortingEntityList = SnapshotSortingEntity[]; + export type SortByOrder = "ASC"|"DESC"|string; + export type SourceIdsList = String[]; + export type SourceType = "cluster"|"cluster-parameter-group"|"cluster-security-group"|"cluster-snapshot"|string; + export type String = string; + export interface Subnet { + /** + * The identifier of the subnet. + */ + SubnetIdentifier?: String; + /** + * + */ + SubnetAvailabilityZone?: AvailabilityZone; + /** + * The status of the subnet. + */ + SubnetStatus?: String; + } + export type SubnetIdentifierList = String[]; + export type SubnetList = Subnet[]; + export interface SupportedOperation { + /** + * A list of the supported operations. + */ + OperationName?: String; + } + export type SupportedOperationList = SupportedOperation[]; + export interface SupportedPlatform { + /** + * + */ + Name?: String; + } + export type SupportedPlatformsList = SupportedPlatform[]; + export type TStamp = Date; + export interface TableRestoreStatus { + /** + * The unique identifier for the table restore request. + */ + TableRestoreRequestId?: String; + /** + * A value that describes the current state of the table restore request. Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS + */ + Status?: TableRestoreStatusType; + /** + * A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS. + */ + Message?: String; + /** + * The time that the table restore request was made, in Universal Coordinated Time (UTC). + */ + RequestTime?: TStamp; + /** + * The amount of data restored to the new table so far, in megabytes (MB). + */ + ProgressInMegaBytes?: LongOptional; + /** + * The total amount of data to restore to the new table, in megabytes (MB). + */ + TotalDataInMegaBytes?: LongOptional; + /** + * The identifier of the Amazon Redshift cluster that the table is being restored to. + */ + ClusterIdentifier?: String; + /** + * The identifier of the snapshot that the table is being restored from. + */ + SnapshotIdentifier?: String; + /** + * The name of the source database that contains the table being restored. + */ + SourceDatabaseName?: String; + /** + * The name of the source schema that contains the table being restored. + */ + SourceSchemaName?: String; + /** + * The name of the source table being restored. + */ + SourceTableName?: String; + /** + * The name of the database to restore the table to. + */ + TargetDatabaseName?: String; + /** + * The name of the schema to restore the table to. + */ + TargetSchemaName?: String; + /** + * The name of the table to create as a result of the table restore request. + */ + NewTableName?: String; + } + export type TableRestoreStatusList = TableRestoreStatus[]; + export interface TableRestoreStatusMessage { + /** + * A list of status details for one or more table restore requests. + */ + TableRestoreStatusDetails?: TableRestoreStatusList; + /** + * A pagination token that can be used in a subsequent DescribeTableRestoreStatus request. + */ + Marker?: String; + } + export type TableRestoreStatusType = "PENDING"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"CANCELED"|string; + export interface Tag { + /** + * The key, or name, for the resource tag. + */ + Key?: String; + /** + * The value for the resource tag. + */ + Value?: String; + } + export type TagKeyList = String[]; + export type TagList = Tag[]; + export type TagValueList = String[]; + export interface TaggedResource { + /** + * The tag for the resource. + */ + Tag?: Tag; + /** + * The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-1:123456789:cluster:t1. + */ + ResourceName?: String; + /** + * The type of resource with which the tag is associated. Valid resource types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide. + */ + ResourceType?: String; + } + export type TaggedResourceList = TaggedResource[]; + export interface TaggedResourceListMessage { + /** + * A list of tags with their associated resources. + */ + TaggedResources?: TaggedResourceList; + /** + * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. + */ + Marker?: String; + } + export type TrackList = MaintenanceTrack[]; + export interface TrackListMessage { + /** + * A list of maintenance tracks output by the DescribeClusterTracks operation. + */ + MaintenanceTracks?: TrackList; + /** + * The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. + */ + Marker?: String; + } + export interface UpdateTarget { + /** + * The name of the new maintenance track. + */ + MaintenanceTrackName?: String; + /** + * The cluster version for the new maintenance track. + */ + DatabaseVersion?: String; + /** + * A list of operations supported by the maintenance track. + */ + SupportedOperations?: SupportedOperationList; + } + export type VpcSecurityGroupIdList = String[]; + export interface VpcSecurityGroupMembership { + /** + * The identifier of the VPC security group. + */ + VpcSecurityGroupId?: String; + /** + * The status of the VPC security group. + */ + Status?: String; + } + export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-12-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Redshift client. + */ + export import Types = Redshift; +} +export = Redshift; diff --git a/node_modules/aws-sdk/clients/redshift.js b/node_modules/aws-sdk/clients/redshift.js new file mode 100644 index 0000000..f26f394 --- /dev/null +++ b/node_modules/aws-sdk/clients/redshift.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['redshift'] = {}; +AWS.Redshift = Service.defineService('redshift', ['2012-12-01']); +Object.defineProperty(apiLoader.services['redshift'], '2012-12-01', { + get: function get() { + var model = require('../apis/redshift-2012-12-01.min.json'); + model.paginators = require('../apis/redshift-2012-12-01.paginators.json').pagination; + model.waiters = require('../apis/redshift-2012-12-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Redshift; diff --git a/node_modules/aws-sdk/clients/rekognition.d.ts b/node_modules/aws-sdk/clients/rekognition.d.ts new file mode 100644 index 0000000..0e8b3b2 --- /dev/null +++ b/node_modules/aws-sdk/clients/rekognition.d.ts @@ -0,0 +1,1949 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Rekognition extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Rekognition.Types.ClientConfiguration) + config: Config & Rekognition.Types.ClientConfiguration; + /** + * Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action. + */ + compareFaces(params: Rekognition.Types.CompareFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request; + /** + * Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action. + */ + compareFaces(callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request; + /** + * Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation. For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. When you create a collection, it is associated with the latest version of the face model version. Collection names are case-sensitive. This operation requires permissions to perform the rekognition:CreateCollection action. + */ + createCollection(params: Rekognition.Types.CreateCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateCollectionResponse) => void): Request; + /** + * Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation. For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. When you create a collection, it is associated with the latest version of the face model version. Collection names are case-sensitive. This operation requires permissions to perform the rekognition:CreateCollection action. + */ + createCollection(callback?: (err: AWSError, data: Rekognition.Types.CreateCollectionResponse) => void): Request; + /** + * Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video. Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams. You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor. + */ + createStreamProcessor(params: Rekognition.Types.CreateStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateStreamProcessorResponse) => void): Request; + /** + * Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video. Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams. You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor. + */ + createStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.CreateStreamProcessorResponse) => void): Request; + /** + * Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure. This operation requires permissions to perform the rekognition:DeleteCollection action. + */ + deleteCollection(params: Rekognition.Types.DeleteCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteCollectionResponse) => void): Request; + /** + * Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure. This operation requires permissions to perform the rekognition:DeleteCollection action. + */ + deleteCollection(callback?: (err: AWSError, data: Rekognition.Types.DeleteCollectionResponse) => void): Request; + /** + * Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to perform the rekognition:DeleteFaces action. + */ + deleteFaces(params: Rekognition.Types.DeleteFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteFacesResponse) => void): Request; + /** + * Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to perform the rekognition:DeleteFaces action. + */ + deleteFaces(callback?: (err: AWSError, data: Rekognition.Types.DeleteFacesResponse) => void): Request; + /** + * Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor. + */ + deleteStreamProcessor(params: Rekognition.Types.DeleteStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteStreamProcessorResponse) => void): Request; + /** + * Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor. + */ + deleteStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.DeleteStreamProcessorResponse) => void): Request; + /** + * Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection. For more information, see Describing a Collection in the Amazon Rekognition Developer Guide. + */ + describeCollection(params: Rekognition.Types.DescribeCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeCollectionResponse) => void): Request; + /** + * Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection. For more information, see Describing a Collection in the Amazon Rekognition Developer Guide. + */ + describeCollection(callback?: (err: AWSError, data: Rekognition.Types.DescribeCollectionResponse) => void): Request; + /** + * Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor. + */ + describeStreamProcessor(params: Rekognition.Types.DescribeStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeStreamProcessorResponse) => void): Request; + /** + * Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor. + */ + describeStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.DescribeStreamProcessorResponse) => void): Request; + /** + * Detects faces within an image that is provided as input. DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, and so on. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectFaces action. + */ + detectFaces(params: Rekognition.Types.DetectFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectFacesResponse) => void): Request; + /** + * Detects faces within an image that is provided as input. DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, and so on. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectFaces action. + */ + detectFaces(callback?: (err: AWSError, data: Rekognition.Types.DetectFacesResponse) => void): Request; + /** + * Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide. DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide. You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object. {Name: lighthouse, Confidence: 98.4629} {Name: rock,Confidence: 79.2097} {Name: sea,Confidence: 75.061} In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. {Name: flower,Confidence: 99.0562} {Name: plant,Confidence: 99.0562} {Name: tulip,Confidence: 99.0562} In this example, the detection algorithm more precisely identifies the flower as a tulip. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides. DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected. DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectLabels action. + */ + detectLabels(params: Rekognition.Types.DetectLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectLabelsResponse) => void): Request; + /** + * Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide. DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide. You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object. {Name: lighthouse, Confidence: 98.4629} {Name: rock,Confidence: 79.2097} {Name: sea,Confidence: 75.061} In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. {Name: flower,Confidence: 99.0562} {Name: plant,Confidence: 99.0562} {Name: tulip,Confidence: 99.0562} In this example, the detection algorithm more precisely identifies the flower as a tulip. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides. DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected. DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectLabels action. + */ + detectLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectLabelsResponse) => void): Request; + /** + * Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate. For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. + */ + detectModerationLabels(params: Rekognition.Types.DetectModerationLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectModerationLabelsResponse) => void): Request; + /** + * Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate. For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. + */ + detectModerationLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectModerationLabelsResponse) => void): Request; + /** + * Detects text in the input image and converts it into machine-readable text. Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file. The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image. A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image. A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines. To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field. To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. For more information, see DetectText in the Amazon Rekognition Developer Guide. + */ + detectText(params: Rekognition.Types.DetectTextRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectTextResponse) => void): Request; + /** + * Detects text in the input image and converts it into machine-readable text. Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file. The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image. A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image. A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines. To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field. To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. For more information, see DetectText in the Amazon Rekognition Developer Guide. + */ + detectText(callback?: (err: AWSError, data: Rekognition.Types.DetectTextResponse) => void): Request; + /** + * Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:GetCelebrityInfo action. + */ + getCelebrityInfo(params: Rekognition.Types.GetCelebrityInfoRequest, callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityInfoResponse) => void): Request; + /** + * Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:GetCelebrityInfo action. + */ + getCelebrityInfo(callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityInfoResponse) => void): Request; + /** + * Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition. Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection. For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide. GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter. The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer. No information is returned for faces not recognized as celebrities. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition. + */ + getCelebrityRecognition(params: Rekognition.Types.GetCelebrityRecognitionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityRecognitionResponse) => void): Request; + /** + * Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition. Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection. For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide. GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter. The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer. No information is returned for faces not recognized as celebrities. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition. + */ + getCelebrityRecognition(callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityRecognitionResponse) => void): Request; + /** + * Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. Content moderation analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide. GetContentModeration returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects. By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter. Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. + */ + getContentModeration(params: Rekognition.Types.GetContentModerationRequest, callback?: (err: AWSError, data: Rekognition.Types.GetContentModerationResponse) => void): Request; + /** + * Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. Content moderation analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide. GetContentModeration returns detected content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects. By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter. Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. + */ + getContentModeration(callback?: (err: AWSError, data: Rekognition.Types.GetContentModerationResponse) => void): Request; + /** + * Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection. Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection. + */ + getFaceDetection(params: Rekognition.Types.GetFaceDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetFaceDetectionResponse) => void): Request; + /** + * Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection. Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection. + */ + getFaceDetection(callback?: (err: AWSError, data: Rekognition.Types.GetFaceDetectionResponse) => void): Request; + /** + * Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video. Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video. GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter. + */ + getFaceSearch(params: Rekognition.Types.GetFaceSearchRequest, callback?: (err: AWSError, data: Rekognition.Types.GetFaceSearchResponse) => void): Request; + /** + * Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video. Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video. GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter. + */ + getFaceSearch(callback?: (err: AWSError, data: Rekognition.Types.GetFaceSearchResponse) => void): Request; + /** + * Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection. The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video. The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection. + */ + getLabelDetection(params: Rekognition.Types.GetLabelDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetLabelDetectionResponse) => void): Request; + /** + * Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection. The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video. The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection. + */ + getLabelDetection(callback?: (err: AWSError, data: Rekognition.Types.GetLabelDetectionResponse) => void): Request; + /** + * Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking. The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking. To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking. GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video. GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter. Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking. + */ + getPersonTracking(params: Rekognition.Types.GetPersonTrackingRequest, callback?: (err: AWSError, data: Rekognition.Types.GetPersonTrackingResponse) => void): Request; + /** + * Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking. The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking. To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking. GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video. GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter. Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking. + */ + getPersonTracking(callback?: (err: AWSError, data: Rekognition.Types.GetPersonTrackingResponse) => void): Request; + /** + * Detects faces in the input image and adds them to the specified collection. Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations. For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide. To get the number of faces in a collection, call DescribeCollection. If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field. To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces For more information, see Model Versioning in the Amazon Rekognition Developer Guide. If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background. The QualityFilter input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces filters detected faces. You can also explicitly filter detected faces by specifying AUTO for the value of QualityFilter. If you do not want to filter detected faces, specify NONE. To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call DescribeCollection. Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as: The number of faces detected exceeds the value of the MaxFaces request parameter. The face is too small compared to the image dimensions. The face is too blurry. The image is too dark. The face has an extreme pose. In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes: The bounding box, BoundingBox, of the detected face. A confidence value, Confidence, which indicates the confidence that the bounding box contains a face. A face ID, FaceId, assigned by the service for each face that's detected and stored. An image ID, ImageId, assigned by the service for the input image. If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata. The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. This operation requires permissions to perform the rekognition:IndexFaces action. + */ + indexFaces(params: Rekognition.Types.IndexFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.IndexFacesResponse) => void): Request; + /** + * Detects faces in the input image and adds them to the specified collection. Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations. For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide. To get the number of faces in a collection, call DescribeCollection. If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field. To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces For more information, see Model Versioning in the Amazon Rekognition Developer Guide. If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background. The QualityFilter input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces filters detected faces. You can also explicitly filter detected faces by specifying AUTO for the value of QualityFilter. If you do not want to filter detected faces, specify NONE. To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call DescribeCollection. Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as: The number of faces detected exceeds the value of the MaxFaces request parameter. The face is too small compared to the image dimensions. The face is too blurry. The image is too dark. The face has an extreme pose. In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes: The bounding box, BoundingBox, of the detected face. A confidence value, Confidence, which indicates the confidence that the bounding box contains a face. A face ID, FaceId, assigned by the service for each face that's detected and stored. An image ID, ImageId, assigned by the service for the input image. If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata. The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. This operation requires permissions to perform the rekognition:IndexFaces action. + */ + indexFaces(callback?: (err: AWSError, data: Rekognition.Types.IndexFacesResponse) => void): Request; + /** + * Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs. For an example, see Listing Collections in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListCollections action. + */ + listCollections(params: Rekognition.Types.ListCollectionsRequest, callback?: (err: AWSError, data: Rekognition.Types.ListCollectionsResponse) => void): Request; + /** + * Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs. For an example, see Listing Collections in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListCollections action. + */ + listCollections(callback?: (err: AWSError, data: Rekognition.Types.ListCollectionsResponse) => void): Request; + /** + * Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListFaces action. + */ + listFaces(params: Rekognition.Types.ListFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.ListFacesResponse) => void): Request; + /** + * Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListFaces action. + */ + listFaces(callback?: (err: AWSError, data: Rekognition.Types.ListFacesResponse) => void): Request; + /** + * Gets a list of stream processors that you have created with CreateStreamProcessor. + */ + listStreamProcessors(params: Rekognition.Types.ListStreamProcessorsRequest, callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request; + /** + * Gets a list of stream processors that you have created with CreateStreamProcessor. + */ + listStreamProcessors(callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request; + /** + * Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 100 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation. + */ + recognizeCelebrities(params: Rekognition.Types.RecognizeCelebritiesRequest, callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request; + /** + * Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 100 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation. + */ + recognizeCelebrities(callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request; + /** + * For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the SearchFacesByImage operation. The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face. For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFaces action. + */ + searchFaces(params: Rekognition.Types.SearchFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.SearchFacesResponse) => void): Request; + /** + * For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the SearchFacesByImage operation. The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face. For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFaces action. + */ + searchFaces(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesResponse) => void): Request; + /** + * For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFacesByImage action. + */ + searchFacesByImage(params: Rekognition.Types.SearchFacesByImageRequest, callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request; + /** + * For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFacesByImage action. + */ + searchFacesByImage(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request; + /** + * Starts asynchronous recognition of celebrities in a stored video. Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. + */ + startCelebrityRecognition(params: Rekognition.Types.StartCelebrityRecognitionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartCelebrityRecognitionResponse) => void): Request; + /** + * Starts asynchronous recognition of celebrities in a stored video. Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. + */ + startCelebrityRecognition(callback?: (err: AWSError, data: Rekognition.Types.StartCelebrityRecognitionResponse) => void): Request; + /** + * Starts asynchronous detection of explicit or suggestive adult content in a stored video. Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When content moderation analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. + */ + startContentModeration(params: Rekognition.Types.StartContentModerationRequest, callback?: (err: AWSError, data: Rekognition.Types.StartContentModerationResponse) => void): Request; + /** + * Starts asynchronous detection of explicit or suggestive adult content in a stored video. Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When content moderation analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. + */ + startContentModeration(callback?: (err: AWSError, data: Rekognition.Types.StartContentModerationResponse) => void): Request; + /** + * Starts asynchronous detection of faces in a stored video. Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide. + */ + startFaceDetection(params: Rekognition.Types.StartFaceDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartFaceDetectionResponse) => void): Request; + /** + * Starts asynchronous detection of faces in a stored video. Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide. + */ + startFaceDetection(callback?: (err: AWSError, data: Rekognition.Types.StartFaceDetectionResponse) => void): Request; + /** + * Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos. + */ + startFaceSearch(params: Rekognition.Types.StartFaceSearchRequest, callback?: (err: AWSError, data: Rekognition.Types.StartFaceSearchResponse) => void): Request; + /** + * Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos. + */ + startFaceSearch(callback?: (err: AWSError, data: Rekognition.Types.StartFaceSearchResponse) => void): Request; + /** + * Starts asynchronous detection of labels in a stored video. Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. + */ + startLabelDetection(params: Rekognition.Types.StartLabelDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartLabelDetectionResponse) => void): Request; + /** + * Starts asynchronous detection of labels in a stored video. Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. + */ + startLabelDetection(callback?: (err: AWSError, data: Rekognition.Types.StartLabelDetectionResponse) => void): Request; + /** + * Starts the asynchronous tracking of a person's path in a stored video. Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking. + */ + startPersonTracking(params: Rekognition.Types.StartPersonTrackingRequest, callback?: (err: AWSError, data: Rekognition.Types.StartPersonTrackingResponse) => void): Request; + /** + * Starts the asynchronous tracking of a person's path in a stored video. Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking. + */ + startPersonTracking(callback?: (err: AWSError, data: Rekognition.Types.StartPersonTrackingResponse) => void): Request; + /** + * Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor. + */ + startStreamProcessor(params: Rekognition.Types.StartStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.StartStreamProcessorResponse) => void): Request; + /** + * Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor. + */ + startStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StartStreamProcessorResponse) => void): Request; + /** + * Stops a running stream processor that was created by CreateStreamProcessor. + */ + stopStreamProcessor(params: Rekognition.Types.StopStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request; + /** + * Stops a running stream processor that was created by CreateStreamProcessor. + */ + stopStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request; +} +declare namespace Rekognition { + export interface AgeRange { + /** + * The lowest estimated age. + */ + Low?: UInteger; + /** + * The highest estimated age. + */ + High?: UInteger; + } + export type Attribute = "DEFAULT"|"ALL"|string; + export type Attributes = Attribute[]; + export interface Beard { + /** + * Boolean value that indicates whether the face has beard or not. + */ + Value?: Boolean; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export type Boolean = boolean; + export interface BoundingBox { + /** + * Width of the bounding box as a ratio of the overall image width. + */ + Width?: Float; + /** + * Height of the bounding box as a ratio of the overall image height. + */ + Height?: Float; + /** + * Left coordinate of the bounding box as a ratio of overall image width. + */ + Left?: Float; + /** + * Top coordinate of the bounding box as a ratio of overall image height. + */ + Top?: Float; + } + export interface Celebrity { + /** + * An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty. + */ + Urls?: Urls; + /** + * The name of the celebrity. + */ + Name?: String; + /** + * A unique identifier for the celebrity. + */ + Id?: RekognitionUniqueId; + /** + * Provides information about the celebrity's face, such as its location on the image. + */ + Face?: ComparedFace; + /** + * The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity. + */ + MatchConfidence?: Percent; + } + export interface CelebrityDetail { + /** + * An array of URLs pointing to additional celebrity information. + */ + Urls?: Urls; + /** + * The name of the celebrity. + */ + Name?: String; + /** + * The unique identifier for the celebrity. + */ + Id?: RekognitionUniqueId; + /** + * The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity. + */ + Confidence?: Percent; + /** + * Bounding box around the body of a celebrity. + */ + BoundingBox?: BoundingBox; + /** + * Face details for the recognized celebrity. + */ + Face?: FaceDetail; + } + export type CelebrityList = Celebrity[]; + export interface CelebrityRecognition { + /** + * The time, in milliseconds from the start of the video, that the celebrity was recognized. + */ + Timestamp?: Timestamp; + /** + * Information about a recognized celebrity. + */ + Celebrity?: CelebrityDetail; + } + export type CelebrityRecognitionSortBy = "ID"|"TIMESTAMP"|string; + export type CelebrityRecognitions = CelebrityRecognition[]; + export type ClientRequestToken = string; + export type CollectionId = string; + export type CollectionIdList = CollectionId[]; + export interface CompareFacesMatch { + /** + * Level of confidence that the faces match. + */ + Similarity?: Percent; + /** + * Provides face metadata (bounding box and confidence that the bounding box actually contains a face). + */ + Face?: ComparedFace; + } + export type CompareFacesMatchList = CompareFacesMatch[]; + export interface CompareFacesRequest { + /** + * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + SourceImage: Image; + /** + * The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + TargetImage: Image; + /** + * The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array. + */ + SimilarityThreshold?: Percent; + } + export interface CompareFacesResponse { + /** + * The face in the source image that was used for comparison. + */ + SourceImageFace?: ComparedSourceImageFace; + /** + * An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image. + */ + FaceMatches?: CompareFacesMatchList; + /** + * An array of faces in the target image that did not match the source image face. + */ + UnmatchedFaces?: CompareFacesUnmatchList; + /** + * The value of SourceImageOrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. + */ + SourceImageOrientationCorrection?: OrientationCorrection; + /** + * The value of TargetImageOrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. + */ + TargetImageOrientationCorrection?: OrientationCorrection; + } + export type CompareFacesUnmatchList = ComparedFace[]; + export interface ComparedFace { + /** + * Bounding box of the face. + */ + BoundingBox?: BoundingBox; + /** + * Level of confidence that what the bounding box contains is a face. + */ + Confidence?: Percent; + /** + * An array of facial landmarks. + */ + Landmarks?: Landmarks; + /** + * Indicates the pose of the face as determined by its pitch, roll, and yaw. + */ + Pose?: Pose; + /** + * Identifies face image brightness and sharpness. + */ + Quality?: ImageQuality; + } + export type ComparedFaceList = ComparedFace[]; + export interface ComparedSourceImageFace { + /** + * Bounding box of the face. + */ + BoundingBox?: BoundingBox; + /** + * Confidence level that the selected bounding box contains a face. + */ + Confidence?: Percent; + } + export interface ContentModerationDetection { + /** + * Time, in milliseconds from the beginning of the video, that the moderation label was detected. + */ + Timestamp?: Timestamp; + /** + * The moderation label detected by in the stored video. + */ + ModerationLabel?: ModerationLabel; + } + export type ContentModerationDetections = ContentModerationDetection[]; + export type ContentModerationSortBy = "NAME"|"TIMESTAMP"|string; + export interface CreateCollectionRequest { + /** + * ID for the collection that you are creating. + */ + CollectionId: CollectionId; + } + export interface CreateCollectionResponse { + /** + * HTTP status code indicating the result of the operation. + */ + StatusCode?: UInteger; + /** + * Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources. + */ + CollectionArn?: String; + /** + * Version number of the face detection model associated with the collection you are creating. + */ + FaceModelVersion?: String; + } + export interface CreateStreamProcessorRequest { + /** + * Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. + */ + Input: StreamProcessorInput; + /** + * Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. + */ + Output: StreamProcessorOutput; + /** + * An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent. + */ + Name: StreamProcessorName; + /** + * Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect. + */ + Settings: StreamProcessorSettings; + /** + * ARN of the IAM role that allows access to the stream processor. + */ + RoleArn: RoleArn; + } + export interface CreateStreamProcessorResponse { + /** + * ARN for the newly create stream processor. + */ + StreamProcessorArn?: StreamProcessorArn; + } + export type DateTime = Date; + export type Degree = number; + export interface DeleteCollectionRequest { + /** + * ID of the collection to delete. + */ + CollectionId: CollectionId; + } + export interface DeleteCollectionResponse { + /** + * HTTP status code that indicates the result of the operation. + */ + StatusCode?: UInteger; + } + export interface DeleteFacesRequest { + /** + * Collection from which to remove the specific faces. + */ + CollectionId: CollectionId; + /** + * An array of face IDs to delete. + */ + FaceIds: FaceIdList; + } + export interface DeleteFacesResponse { + /** + * An array of strings (face IDs) of the faces that were deleted. + */ + DeletedFaces?: FaceIdList; + } + export interface DeleteStreamProcessorRequest { + /** + * The name of the stream processor you want to delete. + */ + Name: StreamProcessorName; + } + export interface DeleteStreamProcessorResponse { + } + export interface DescribeCollectionRequest { + /** + * The ID of the collection to describe. + */ + CollectionId: CollectionId; + } + export interface DescribeCollectionResponse { + /** + * The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces. + */ + FaceCount?: ULong; + /** + * The version of the face model that's used by the collection for face detection. For more information, see Model Versioning in the Amazon Rekognition Developer Guide. + */ + FaceModelVersion?: String; + /** + * The Amazon Resource Name (ARN) of the collection. + */ + CollectionARN?: String; + /** + * The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970. + */ + CreationTimestamp?: DateTime; + } + export interface DescribeStreamProcessorRequest { + /** + * Name of the stream processor for which you want information. + */ + Name: StreamProcessorName; + } + export interface DescribeStreamProcessorResponse { + /** + * Name of the stream processor. + */ + Name?: StreamProcessorName; + /** + * ARN of the stream processor. + */ + StreamProcessorArn?: StreamProcessorArn; + /** + * Current status of the stream processor. + */ + Status?: StreamProcessorStatus; + /** + * Detailed status message about the stream processor. + */ + StatusMessage?: String; + /** + * Date and time the stream processor was created + */ + CreationTimestamp?: DateTime; + /** + * The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor. + */ + LastUpdateTimestamp?: DateTime; + /** + * Kinesis video stream that provides the source streaming video. + */ + Input?: StreamProcessorInput; + /** + * Kinesis data stream to which Amazon Rekognition Video puts the analysis results. + */ + Output?: StreamProcessorOutput; + /** + * ARN of the IAM role that allows access to the stream processor. + */ + RoleArn?: RoleArn; + /** + * Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect. + */ + Settings?: StreamProcessorSettings; + } + export interface DetectFacesRequest { + /** + * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + Image: Image; + /** + * An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete. If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). + */ + Attributes?: Attributes; + } + export interface DetectFacesResponse { + /** + * Details of each face found in the image. + */ + FaceDetails?: FaceDetailList; + /** + * The value of OrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. + */ + OrientationCorrection?: OrientationCorrection; + } + export interface DetectLabelsRequest { + /** + * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + Image: Image; + /** + * Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. + */ + MaxLabels?: UInteger; + /** + * Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value. If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent. + */ + MinConfidence?: Percent; + } + export interface DetectLabelsResponse { + /** + * An array of labels for the real-world objects detected. + */ + Labels?: Labels; + /** + * The value of OrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. + */ + OrientationCorrection?: OrientationCorrection; + /** + * Version number of the label detection model that was used to detect labels. + */ + LabelModelVersion?: String; + } + export interface DetectModerationLabelsRequest { + /** + * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + Image: Image; + /** + * Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value. If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent. + */ + MinConfidence?: Percent; + } + export interface DetectModerationLabelsResponse { + /** + * Array of detected Moderation labels and the time, in millseconds from the start of the video, they were detected. + */ + ModerationLabels?: ModerationLabels; + /** + * Version number of the moderation detection model that was used to detect unsafe content. + */ + ModerationModelVersion?: String; + } + export interface DetectTextRequest { + /** + * The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + Image: Image; + } + export interface DetectTextResponse { + /** + * An array of text that was detected in the input image. + */ + TextDetections?: TextDetectionList; + } + export interface Emotion { + /** + * Type of emotion detected. + */ + Type?: EmotionName; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export type EmotionName = "HAPPY"|"SAD"|"ANGRY"|"CONFUSED"|"DISGUSTED"|"SURPRISED"|"CALM"|"UNKNOWN"|string; + export type Emotions = Emotion[]; + export type ExternalImageId = string; + export interface EyeOpen { + /** + * Boolean value that indicates whether the eyes on the face are open. + */ + Value?: Boolean; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export interface Eyeglasses { + /** + * Boolean value that indicates whether the face is wearing eye glasses or not. + */ + Value?: Boolean; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export interface Face { + /** + * Unique identifier that Amazon Rekognition assigns to the face. + */ + FaceId?: FaceId; + /** + * Bounding box of the face. + */ + BoundingBox?: BoundingBox; + /** + * Unique identifier that Amazon Rekognition assigns to the input image. + */ + ImageId?: ImageId; + /** + * Identifier that you assign to all the faces in the input image. + */ + ExternalImageId?: ExternalImageId; + /** + * Confidence level that the bounding box contains a face (and not a different object such as a tree). + */ + Confidence?: Percent; + } + export type FaceAttributes = "DEFAULT"|"ALL"|string; + export interface FaceDetail { + /** + * Bounding box of the face. Default attribute. + */ + BoundingBox?: BoundingBox; + /** + * The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age. + */ + AgeRange?: AgeRange; + /** + * Indicates whether or not the face is smiling, and the confidence level in the determination. + */ + Smile?: Smile; + /** + * Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination. + */ + Eyeglasses?: Eyeglasses; + /** + * Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination. + */ + Sunglasses?: Sunglasses; + /** + * Gender of the face and the confidence level in the determination. + */ + Gender?: Gender; + /** + * Indicates whether or not the face has a beard, and the confidence level in the determination. + */ + Beard?: Beard; + /** + * Indicates whether or not the face has a mustache, and the confidence level in the determination. + */ + Mustache?: Mustache; + /** + * Indicates whether or not the eyes on the face are open, and the confidence level in the determination. + */ + EyesOpen?: EyeOpen; + /** + * Indicates whether or not the mouth on the face is open, and the confidence level in the determination. + */ + MouthOpen?: MouthOpen; + /** + * The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY. + */ + Emotions?: Emotions; + /** + * Indicates the location of landmarks on the face. Default attribute. + */ + Landmarks?: Landmarks; + /** + * Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute. + */ + Pose?: Pose; + /** + * Identifies image brightness and sharpness. Default attribute. + */ + Quality?: ImageQuality; + /** + * Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute. + */ + Confidence?: Percent; + } + export type FaceDetailList = FaceDetail[]; + export interface FaceDetection { + /** + * Time, in milliseconds from the start of the video, that the face was detected. + */ + Timestamp?: Timestamp; + /** + * The face properties for the detected face. + */ + Face?: FaceDetail; + } + export type FaceDetections = FaceDetection[]; + export type FaceId = string; + export type FaceIdList = FaceId[]; + export type FaceList = Face[]; + export interface FaceMatch { + /** + * Confidence in the match of this face with the input face. + */ + Similarity?: Percent; + /** + * Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned. + */ + Face?: Face; + } + export type FaceMatchList = FaceMatch[]; + export type FaceModelVersionList = String[]; + export interface FaceRecord { + /** + * Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned. + */ + Face?: Face; + /** + * Structure containing attributes of the face that the algorithm detected. + */ + FaceDetail?: FaceDetail; + } + export type FaceRecordList = FaceRecord[]; + export interface FaceSearchSettings { + /** + * The ID of a collection that contains faces that you want to search for. + */ + CollectionId?: CollectionId; + /** + * Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence. + */ + FaceMatchThreshold?: Percent; + } + export type FaceSearchSortBy = "INDEX"|"TIMESTAMP"|string; + export type Float = number; + export interface Gender { + /** + * Gender of the face. + */ + Value?: GenderType; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export type GenderType = "Male"|"Female"|string; + export interface Geometry { + /** + * An axis-aligned coarse representation of the detected text's location on the image. + */ + BoundingBox?: BoundingBox; + /** + * Within the bounding box, a fine-grained polygon around the detected text. + */ + Polygon?: Polygon; + } + export interface GetCelebrityInfoRequest { + /** + * The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image. + */ + Id: RekognitionUniqueId; + } + export interface GetCelebrityInfoResponse { + /** + * An array of URLs pointing to additional celebrity information. + */ + Urls?: Urls; + /** + * The name of the celebrity. + */ + Name?: String; + } + export interface GetCelebrityRecognitionRequest { + /** + * Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition. + */ + JobId: JobId; + /** + * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities. + */ + NextToken?: PaginationToken; + /** + * Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized. + */ + SortBy?: CelebrityRecognitionSortBy; + } + export interface GetCelebrityRecognitionResponse { + /** + * The current status of the celebrity recognition job. + */ + JobStatus?: VideoJobStatus; + /** + * If the job fails, StatusMessage provides a descriptive error message. + */ + StatusMessage?: StatusMessage; + /** + * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation. + */ + VideoMetadata?: VideoMetadata; + /** + * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities. + */ + NextToken?: PaginationToken; + /** + * Array of celebrities recognized in the video. + */ + Celebrities?: CelebrityRecognitions; + } + export interface GetContentModerationRequest { + /** + * The identifier for the content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration. + */ + JobId: JobId; + /** + * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels. + */ + NextToken?: PaginationToken; + /** + * Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP. + */ + SortBy?: ContentModerationSortBy; + } + export interface GetContentModerationResponse { + /** + * The current status of the content moderation job. + */ + JobStatus?: VideoJobStatus; + /** + * If the job fails, StatusMessage provides a descriptive error message. + */ + StatusMessage?: StatusMessage; + /** + * Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration. + */ + VideoMetadata?: VideoMetadata; + /** + * The detected moderation labels and the time(s) they were detected. + */ + ModerationLabels?: ContentModerationDetections; + /** + * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of moderation labels. + */ + NextToken?: PaginationToken; + /** + * Version number of the moderation detection model that was used to detect unsafe content. + */ + ModerationModelVersion?: String; + } + export interface GetFaceDetectionRequest { + /** + * Unique identifier for the face detection job. The JobId is returned from StartFaceDetection. + */ + JobId: JobId; + /** + * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces. + */ + NextToken?: PaginationToken; + } + export interface GetFaceDetectionResponse { + /** + * The current status of the face detection job. + */ + JobStatus?: VideoJobStatus; + /** + * If the job fails, StatusMessage provides a descriptive error message. + */ + StatusMessage?: StatusMessage; + /** + * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation. + */ + VideoMetadata?: VideoMetadata; + /** + * If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces. + */ + NextToken?: PaginationToken; + /** + * An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected. + */ + Faces?: FaceDetections; + } + export interface GetFaceSearchRequest { + /** + * The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch. + */ + JobId: JobId; + /** + * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results. + */ + NextToken?: PaginationToken; + /** + * Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces. + */ + SortBy?: FaceSearchSortBy; + } + export interface GetFaceSearchResponse { + /** + * The current status of the face search job. + */ + JobStatus?: VideoJobStatus; + /** + * If the job fails, StatusMessage provides a descriptive error message. + */ + StatusMessage?: StatusMessage; + /** + * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results. + */ + NextToken?: PaginationToken; + /** + * Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation. + */ + VideoMetadata?: VideoMetadata; + /** + * An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person. + */ + Persons?: PersonMatches; + } + export interface GetLabelDetectionRequest { + /** + * Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection. + */ + JobId: JobId; + /** + * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels. + */ + NextToken?: PaginationToken; + /** + * Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP. + */ + SortBy?: LabelDetectionSortBy; + } + export interface GetLabelDetectionResponse { + /** + * The current status of the label detection job. + */ + JobStatus?: VideoJobStatus; + /** + * If the job fails, StatusMessage provides a descriptive error message. + */ + StatusMessage?: StatusMessage; + /** + * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation. + */ + VideoMetadata?: VideoMetadata; + /** + * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels. + */ + NextToken?: PaginationToken; + /** + * An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected. + */ + Labels?: LabelDetections; + /** + * Version number of the label detection model that was used to detect labels. + */ + LabelModelVersion?: String; + } + export interface GetPersonTrackingRequest { + /** + * The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking. + */ + JobId: JobId; + /** + * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons. + */ + NextToken?: PaginationToken; + /** + * Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP. + */ + SortBy?: PersonTrackingSortBy; + } + export interface GetPersonTrackingResponse { + /** + * The current status of the person tracking job. + */ + JobStatus?: VideoJobStatus; + /** + * If the job fails, StatusMessage provides a descriptive error message. + */ + StatusMessage?: StatusMessage; + /** + * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation. + */ + VideoMetadata?: VideoMetadata; + /** + * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons. + */ + NextToken?: PaginationToken; + /** + * An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked. + */ + Persons?: PersonDetections; + } + export interface Image { + /** + * Blob of image bytes up to 5 MBs. + */ + Bytes?: ImageBlob; + /** + * Identifies an S3 object as the image source. + */ + S3Object?: S3Object; + } + export type ImageBlob = Buffer|Uint8Array|Blob|string; + export type ImageId = string; + export interface ImageQuality { + /** + * Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image. + */ + Brightness?: Float; + /** + * Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image. + */ + Sharpness?: Float; + } + export interface IndexFacesRequest { + /** + * The ID of an existing collection to which you want to add the faces that are detected in the input images. + */ + CollectionId: CollectionId; + /** + * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + Image: Image; + /** + * The ID you want to assign to all the faces detected in the image. + */ + ExternalImageId?: ExternalImageId; + /** + * An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete. If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). + */ + DetectionAttributes?: Attributes; + /** + * The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces. If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array. The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order. MaxFaces can be used with a collection associated with any version of the face model. + */ + MaxFaces?: MaxFacesToIndex; + /** + * A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered faces aren't indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is AUTO. To use quality filtering, the collection you are using must be associated with version 3 of the face model. + */ + QualityFilter?: QualityFilter; + } + export interface IndexFacesResponse { + /** + * An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. + */ + FaceRecords?: FaceRecordList; + /** + * If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned. If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies: If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection is null. If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection. + */ + OrientationCorrection?: OrientationCorrection; + /** + * The version number of the face detection model that's associated with the input collection (CollectionId). + */ + FaceModelVersion?: String; + /** + * An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter. + */ + UnindexedFaces?: UnindexedFaces; + } + export interface Instance { + /** + * The position of the label instance on the image. + */ + BoundingBox?: BoundingBox; + /** + * The confidence that Amazon Rekognition has in the accuracy of the bounding box. + */ + Confidence?: Percent; + } + export type Instances = Instance[]; + export type JobId = string; + export type JobTag = string; + export type KinesisDataArn = string; + export interface KinesisDataStream { + /** + * ARN of the output Amazon Kinesis Data Streams stream. + */ + Arn?: KinesisDataArn; + } + export type KinesisVideoArn = string; + export interface KinesisVideoStream { + /** + * ARN of the Kinesis video stream stream that streams the source video. + */ + Arn?: KinesisVideoArn; + } + export interface Label { + /** + * The name (label) of the object or scene. + */ + Name?: String; + /** + * Level of confidence. + */ + Confidence?: Percent; + /** + * If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets. + */ + Instances?: Instances; + /** + * The parent labels for a label. The response includes all ancestor labels. + */ + Parents?: Parents; + } + export interface LabelDetection { + /** + * Time, in milliseconds from the start of the video, that the label was detected. + */ + Timestamp?: Timestamp; + /** + * Details about the detected label. + */ + Label?: Label; + } + export type LabelDetectionSortBy = "NAME"|"TIMESTAMP"|string; + export type LabelDetections = LabelDetection[]; + export type Labels = Label[]; + export interface Landmark { + /** + * Type of landmark. + */ + Type?: LandmarkType; + /** + * The x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. + */ + X?: Float; + /** + * The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5. + */ + Y?: Float; + } + export type LandmarkType = "eyeLeft"|"eyeRight"|"nose"|"mouthLeft"|"mouthRight"|"leftEyeBrowLeft"|"leftEyeBrowRight"|"leftEyeBrowUp"|"rightEyeBrowLeft"|"rightEyeBrowRight"|"rightEyeBrowUp"|"leftEyeLeft"|"leftEyeRight"|"leftEyeUp"|"leftEyeDown"|"rightEyeLeft"|"rightEyeRight"|"rightEyeUp"|"rightEyeDown"|"noseLeft"|"noseRight"|"mouthUp"|"mouthDown"|"leftPupil"|"rightPupil"|"upperJawlineLeft"|"midJawlineLeft"|"chinBottom"|"midJawlineRight"|"upperJawlineRight"|string; + export type Landmarks = Landmark[]; + export interface ListCollectionsRequest { + /** + * Pagination token from the previous response. + */ + NextToken?: PaginationToken; + /** + * Maximum number of collection IDs to return. + */ + MaxResults?: PageSize; + } + export interface ListCollectionsResponse { + /** + * An array of collection IDs. + */ + CollectionIds?: CollectionIdList; + /** + * If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs. + */ + NextToken?: PaginationToken; + /** + * Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2]. + */ + FaceModelVersions?: FaceModelVersionList; + } + export interface ListFacesRequest { + /** + * ID of the collection from which to list the faces. + */ + CollectionId: CollectionId; + /** + * If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces. + */ + NextToken?: PaginationToken; + /** + * Maximum number of faces to return. + */ + MaxResults?: PageSize; + } + export interface ListFacesResponse { + /** + * An array of Face objects. + */ + Faces?: FaceList; + /** + * If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces. + */ + NextToken?: String; + /** + * Version number of the face detection model associated with the input collection (CollectionId). + */ + FaceModelVersion?: String; + } + export interface ListStreamProcessorsRequest { + /** + * If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors. + */ + NextToken?: PaginationToken; + /** + * Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000. + */ + MaxResults?: MaxResults; + } + export interface ListStreamProcessorsResponse { + /** + * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors. + */ + NextToken?: PaginationToken; + /** + * List of stream processors that you have created. + */ + StreamProcessors?: StreamProcessorList; + } + export type MaxFaces = number; + export type MaxFacesToIndex = number; + export type MaxResults = number; + export interface ModerationLabel { + /** + * Specifies the confidence that Amazon Rekognition has that the label has been correctly identified. If you don't specify the MinConfidence parameter in the call to DetectModerationLabels, the operation returns labels with a confidence value greater than or equal to 50 percent. + */ + Confidence?: Percent; + /** + * The label name for the type of content detected in the image. + */ + Name?: String; + /** + * The name for the parent label. Labels at the top level of the hierarchy have the parent label "". + */ + ParentName?: String; + } + export type ModerationLabels = ModerationLabel[]; + export interface MouthOpen { + /** + * Boolean value that indicates whether the mouth on the face is open or not. + */ + Value?: Boolean; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export interface Mustache { + /** + * Boolean value that indicates whether the face has mustache or not. + */ + Value?: Boolean; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export interface NotificationChannel { + /** + * The Amazon SNS topic to which Amazon Rekognition to posts the completion status. + */ + SNSTopicArn: SNSTopicArn; + /** + * The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. + */ + RoleArn: RoleArn; + } + export type OrientationCorrection = "ROTATE_0"|"ROTATE_90"|"ROTATE_180"|"ROTATE_270"|string; + export type PageSize = number; + export type PaginationToken = string; + export interface Parent { + /** + * The name of the parent label. + */ + Name?: String; + } + export type Parents = Parent[]; + export type Percent = number; + export interface PersonDetail { + /** + * Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition. + */ + Index?: PersonIndex; + /** + * Bounding box around the detected person. + */ + BoundingBox?: BoundingBox; + /** + * Face details for the detected person. + */ + Face?: FaceDetail; + } + export interface PersonDetection { + /** + * The time, in milliseconds from the start of the video, that the person's path was tracked. + */ + Timestamp?: Timestamp; + /** + * Details about a person whose path was tracked in a video. + */ + Person?: PersonDetail; + } + export type PersonDetections = PersonDetection[]; + export type PersonIndex = number; + export interface PersonMatch { + /** + * The time, in milliseconds from the beginning of the video, that the person was matched in the video. + */ + Timestamp?: Timestamp; + /** + * Information about the matched person. + */ + Person?: PersonDetail; + /** + * Information about the faces in the input collection that match the face of a person in the video. + */ + FaceMatches?: FaceMatchList; + } + export type PersonMatches = PersonMatch[]; + export type PersonTrackingSortBy = "INDEX"|"TIMESTAMP"|string; + export interface Point { + /** + * The value of the X coordinate for a point on a Polygon. + */ + X?: Float; + /** + * The value of the Y coordinate for a point on a Polygon. + */ + Y?: Float; + } + export type Polygon = Point[]; + export interface Pose { + /** + * Value representing the face rotation on the roll axis. + */ + Roll?: Degree; + /** + * Value representing the face rotation on the yaw axis. + */ + Yaw?: Degree; + /** + * Value representing the face rotation on the pitch axis. + */ + Pitch?: Degree; + } + export type QualityFilter = "NONE"|"AUTO"|string; + export type Reason = "EXCEEDS_MAX_FACES"|"EXTREME_POSE"|"LOW_BRIGHTNESS"|"LOW_SHARPNESS"|"LOW_CONFIDENCE"|"SMALL_BOUNDING_BOX"|string; + export type Reasons = Reason[]; + export interface RecognizeCelebritiesRequest { + /** + * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + Image: Image; + } + export interface RecognizeCelebritiesResponse { + /** + * Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image. + */ + CelebrityFaces?: CelebrityList; + /** + * Details about each unrecognized face in the image. + */ + UnrecognizedFaces?: ComparedFaceList; + /** + * The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces represent face locations before the image orientation is corrected. If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. + */ + OrientationCorrection?: OrientationCorrection; + } + export type RekognitionUniqueId = string; + export type RoleArn = string; + export type S3Bucket = string; + export interface S3Object { + /** + * Name of the S3 bucket. + */ + Bucket?: S3Bucket; + /** + * S3 object key name. + */ + Name?: S3ObjectName; + /** + * If the bucket is versioning enabled, you can specify the object version. + */ + Version?: S3ObjectVersion; + } + export type S3ObjectName = string; + export type S3ObjectVersion = string; + export type SNSTopicArn = string; + export interface SearchFacesByImageRequest { + /** + * ID of the collection to search. + */ + CollectionId: CollectionId; + /** + * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide. + */ + Image: Image; + /** + * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match. + */ + MaxFaces?: MaxFaces; + /** + * (Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. + */ + FaceMatchThreshold?: Percent; + } + export interface SearchFacesByImageResponse { + /** + * The bounding box around the face in the input image that Amazon Rekognition used for the search. + */ + SearchedFaceBoundingBox?: BoundingBox; + /** + * The level of confidence that the searchedFaceBoundingBox, contains a face. + */ + SearchedFaceConfidence?: Percent; + /** + * An array of faces that match the input face, along with the confidence in the match. + */ + FaceMatches?: FaceMatchList; + /** + * Version number of the face detection model associated with the input collection (CollectionId). + */ + FaceModelVersion?: String; + } + export interface SearchFacesRequest { + /** + * ID of the collection the face belongs to. + */ + CollectionId: CollectionId; + /** + * ID of a face to find matches for in the collection. + */ + FaceId: FaceId; + /** + * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match. + */ + MaxFaces?: MaxFaces; + /** + * Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. + */ + FaceMatchThreshold?: Percent; + } + export interface SearchFacesResponse { + /** + * ID of the face that was searched for matches in a collection. + */ + SearchedFaceId?: FaceId; + /** + * An array of faces that matched the input face, along with the confidence in the match. + */ + FaceMatches?: FaceMatchList; + /** + * Version number of the face detection model associated with the input collection (CollectionId). + */ + FaceModelVersion?: String; + } + export interface Smile { + /** + * Boolean value that indicates whether the face is smiling or not. + */ + Value?: Boolean; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export interface StartCelebrityRecognitionRequest { + /** + * The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket. + */ + Video: Video; + /** + * Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. + */ + NotificationChannel?: NotificationChannel; + /** + * Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. + */ + JobTag?: JobTag; + } + export interface StartCelebrityRecognitionResponse { + /** + * The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition. + */ + JobId?: JobId; + } + export interface StartContentModerationRequest { + /** + * The video in which you want to moderate content. The video must be stored in an Amazon S3 bucket. + */ + Video: Video; + /** + * Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level lower than this specified value. If you don't specify MinConfidence, GetContentModeration returns labels with confidence values greater than or equal to 50 percent. + */ + MinConfidence?: Percent; + /** + * Idempotent token used to identify the start request. If you use the same token with multiple StartContentModeration requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content moderation analysis to. + */ + NotificationChannel?: NotificationChannel; + /** + * Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. + */ + JobTag?: JobTag; + } + export interface StartContentModerationResponse { + /** + * The identifier for the content moderation analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration. + */ + JobId?: JobId; + } + export interface StartFaceDetectionRequest { + /** + * The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket. + */ + Video: Video; + /** + * Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. + */ + NotificationChannel?: NotificationChannel; + /** + * The face attributes you want returned. DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. ALL - All facial attributes are returned. + */ + FaceAttributes?: FaceAttributes; + /** + * Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. + */ + JobTag?: JobTag; + } + export interface StartFaceDetectionResponse { + /** + * The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection. + */ + JobId?: JobId; + } + export interface StartFaceSearchRequest { + /** + * The video you want to search. The video must be stored in an Amazon S3 bucket. + */ + Video: Video; + /** + * Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. + */ + FaceMatchThreshold?: Percent; + /** + * ID of the collection that contains the faces you want to search for. + */ + CollectionId: CollectionId; + /** + * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. + */ + NotificationChannel?: NotificationChannel; + /** + * Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. + */ + JobTag?: JobTag; + } + export interface StartFaceSearchResponse { + /** + * The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch. + */ + JobId?: JobId; + } + export interface StartLabelDetectionRequest { + /** + * The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket. + */ + Video: Video; + /** + * Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value. If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent. + */ + MinConfidence?: Percent; + /** + * The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to. + */ + NotificationChannel?: NotificationChannel; + /** + * Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. + */ + JobTag?: JobTag; + } + export interface StartLabelDetectionResponse { + /** + * The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection. + */ + JobId?: JobId; + } + export interface StartPersonTrackingRequest { + /** + * The video in which you want to detect people. The video must be stored in an Amazon S3 bucket. + */ + Video: Video; + /** + * Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. + */ + NotificationChannel?: NotificationChannel; + /** + * Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. + */ + JobTag?: JobTag; + } + export interface StartPersonTrackingResponse { + /** + * The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking. + */ + JobId?: JobId; + } + export interface StartStreamProcessorRequest { + /** + * The name of the stream processor to start processing. + */ + Name: StreamProcessorName; + } + export interface StartStreamProcessorResponse { + } + export type StatusMessage = string; + export interface StopStreamProcessorRequest { + /** + * The name of a stream processor created by CreateStreamProcessor. + */ + Name: StreamProcessorName; + } + export interface StopStreamProcessorResponse { + } + export interface StreamProcessor { + /** + * Name of the Amazon Rekognition stream processor. + */ + Name?: StreamProcessorName; + /** + * Current status of the Amazon Rekognition stream processor. + */ + Status?: StreamProcessorStatus; + } + export type StreamProcessorArn = string; + export interface StreamProcessorInput { + /** + * The Kinesis video stream input stream for the source streaming video. + */ + KinesisVideoStream?: KinesisVideoStream; + } + export type StreamProcessorList = StreamProcessor[]; + export type StreamProcessorName = string; + export interface StreamProcessorOutput { + /** + * The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results. + */ + KinesisDataStream?: KinesisDataStream; + } + export interface StreamProcessorSettings { + /** + * Face search settings to use on a streaming video. + */ + FaceSearch?: FaceSearchSettings; + } + export type StreamProcessorStatus = "STOPPED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|string; + export type String = string; + export interface Sunglasses { + /** + * Boolean value that indicates whether the face is wearing sunglasses or not. + */ + Value?: Boolean; + /** + * Level of confidence in the determination. + */ + Confidence?: Percent; + } + export interface TextDetection { + /** + * The word or line of text recognized by Amazon Rekognition. + */ + DetectedText?: String; + /** + * The type of text that was detected. + */ + Type?: TextTypes; + /** + * The identifier for the detected text. The identifier is only unique for a single call to DetectText. + */ + Id?: UInteger; + /** + * The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null. + */ + ParentId?: UInteger; + /** + * The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text. + */ + Confidence?: Percent; + /** + * The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information. + */ + Geometry?: Geometry; + } + export type TextDetectionList = TextDetection[]; + export type TextTypes = "LINE"|"WORD"|string; + export type Timestamp = number; + export type UInteger = number; + export type ULong = number; + export interface UnindexedFace { + /** + * An array of reasons that specify why a face wasn't indexed. EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera. EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces. LOW_BRIGHTNESS - The image is too dark. LOW_SHARPNESS - The image is too blurry. LOW_CONFIDENCE - The face was detected with a low confidence. SMALL_BOUNDING_BOX - The bounding box around the face is too small. + */ + Reasons?: Reasons; + /** + * The structure that contains attributes of a face that IndexFacesdetected, but didn't index. + */ + FaceDetail?: FaceDetail; + } + export type UnindexedFaces = UnindexedFace[]; + export type Url = string; + export type Urls = Url[]; + export interface Video { + /** + * The Amazon S3 bucket name and file name for the video. + */ + S3Object?: S3Object; + } + export type VideoJobStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string; + export interface VideoMetadata { + /** + * Type of compression used in the analyzed video. + */ + Codec?: String; + /** + * Length of the video in milliseconds. + */ + DurationMillis?: ULong; + /** + * Format of the analyzed video. Possible values are MP4, MOV and AVI. + */ + Format?: String; + /** + * Number of frames per second in the video. + */ + FrameRate?: Float; + /** + * Vertical pixel dimension of the video. + */ + FrameHeight?: ULong; + /** + * Horizontal pixel dimension of the video. + */ + FrameWidth?: ULong; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-06-27"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Rekognition client. + */ + export import Types = Rekognition; +} +export = Rekognition; diff --git a/node_modules/aws-sdk/clients/rekognition.js b/node_modules/aws-sdk/clients/rekognition.js new file mode 100644 index 0000000..93bea6e --- /dev/null +++ b/node_modules/aws-sdk/clients/rekognition.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['rekognition'] = {}; +AWS.Rekognition = Service.defineService('rekognition', ['2016-06-27']); +Object.defineProperty(apiLoader.services['rekognition'], '2016-06-27', { + get: function get() { + var model = require('../apis/rekognition-2016-06-27.min.json'); + model.paginators = require('../apis/rekognition-2016-06-27.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Rekognition; diff --git a/node_modules/aws-sdk/clients/resourcegroups.d.ts b/node_modules/aws-sdk/clients/resourcegroups.d.ts new file mode 100644 index 0000000..e908547 --- /dev/null +++ b/node_modules/aws-sdk/clients/resourcegroups.d.ts @@ -0,0 +1,483 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ResourceGroups extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ResourceGroups.Types.ClientConfiguration) + config: Config & ResourceGroups.Types.ClientConfiguration; + /** + * Creates a group with a specified name, description, and resource query. + */ + createGroup(params: ResourceGroups.Types.CreateGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.CreateGroupOutput) => void): Request; + /** + * Creates a group with a specified name, description, and resource query. + */ + createGroup(callback?: (err: AWSError, data: ResourceGroups.Types.CreateGroupOutput) => void): Request; + /** + * Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure. + */ + deleteGroup(params: ResourceGroups.Types.DeleteGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.DeleteGroupOutput) => void): Request; + /** + * Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure. + */ + deleteGroup(callback?: (err: AWSError, data: ResourceGroups.Types.DeleteGroupOutput) => void): Request; + /** + * Returns information about a specified resource group. + */ + getGroup(params: ResourceGroups.Types.GetGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupOutput) => void): Request; + /** + * Returns information about a specified resource group. + */ + getGroup(callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupOutput) => void): Request; + /** + * Returns the resource query associated with the specified resource group. + */ + getGroupQuery(params: ResourceGroups.Types.GetGroupQueryInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupQueryOutput) => void): Request; + /** + * Returns the resource query associated with the specified resource group. + */ + getGroupQuery(callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupQueryOutput) => void): Request; + /** + * Returns a list of tags that are associated with a resource group, specified by an ARN. + */ + getTags(params: ResourceGroups.Types.GetTagsInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetTagsOutput) => void): Request; + /** + * Returns a list of tags that are associated with a resource group, specified by an ARN. + */ + getTags(callback?: (err: AWSError, data: ResourceGroups.Types.GetTagsOutput) => void): Request; + /** + * Returns a list of ARNs of resources that are members of a specified resource group. + */ + listGroupResources(params: ResourceGroups.Types.ListGroupResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupResourcesOutput) => void): Request; + /** + * Returns a list of ARNs of resources that are members of a specified resource group. + */ + listGroupResources(callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupResourcesOutput) => void): Request; + /** + * Returns a list of existing resource groups in your account. + */ + listGroups(params: ResourceGroups.Types.ListGroupsInput, callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupsOutput) => void): Request; + /** + * Returns a list of existing resource groups in your account. + */ + listGroups(callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupsOutput) => void): Request; + /** + * Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. + */ + searchResources(params: ResourceGroups.Types.SearchResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.SearchResourcesOutput) => void): Request; + /** + * Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. + */ + searchResources(callback?: (err: AWSError, data: ResourceGroups.Types.SearchResourcesOutput) => void): Request; + /** + * Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters. + */ + tag(params: ResourceGroups.Types.TagInput, callback?: (err: AWSError, data: ResourceGroups.Types.TagOutput) => void): Request; + /** + * Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters. + */ + tag(callback?: (err: AWSError, data: ResourceGroups.Types.TagOutput) => void): Request; + /** + * Deletes specified tags from a specified resource. + */ + untag(params: ResourceGroups.Types.UntagInput, callback?: (err: AWSError, data: ResourceGroups.Types.UntagOutput) => void): Request; + /** + * Deletes specified tags from a specified resource. + */ + untag(callback?: (err: AWSError, data: ResourceGroups.Types.UntagOutput) => void): Request; + /** + * Updates an existing group with a new or changed description. You cannot update the name of a resource group. + */ + updateGroup(params: ResourceGroups.Types.UpdateGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupOutput) => void): Request; + /** + * Updates an existing group with a new or changed description. You cannot update the name of a resource group. + */ + updateGroup(callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupOutput) => void): Request; + /** + * Updates the resource query of a group. + */ + updateGroupQuery(params: ResourceGroups.Types.UpdateGroupQueryInput, callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupQueryOutput) => void): Request; + /** + * Updates the resource query of a group. + */ + updateGroupQuery(callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupQueryOutput) => void): Request; +} +declare namespace ResourceGroups { + export interface CreateGroupInput { + /** + * The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with AWS or aws; these are reserved. A resource group name must be unique within your account. + */ + Name: GroupName; + /** + * The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces. + */ + Description?: GroupDescription; + /** + * The resource query that determines which AWS resources are members of this group. + */ + ResourceQuery: ResourceQuery; + /** + * The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + Tags?: Tags; + } + export interface CreateGroupOutput { + /** + * A full description of the resource group after it is created. + */ + Group?: Group; + /** + * The resource query associated with the group. + */ + ResourceQuery?: ResourceQuery; + /** + * The tags associated with the group. + */ + Tags?: Tags; + } + export interface DeleteGroupInput { + /** + * The name of the resource group to delete. + */ + GroupName: GroupName; + } + export interface DeleteGroupOutput { + /** + * A full description of the deleted resource group. + */ + Group?: Group; + } + export interface GetGroupInput { + /** + * The name of the resource group. + */ + GroupName: GroupName; + } + export interface GetGroupOutput { + /** + * A full description of the resource group. + */ + Group?: Group; + } + export interface GetGroupQueryInput { + /** + * The name of the resource group. + */ + GroupName: GroupName; + } + export interface GetGroupQueryOutput { + /** + * The resource query associated with the specified group. + */ + GroupQuery?: GroupQuery; + } + export interface GetTagsInput { + /** + * The ARN of the resource group for which you want a list of tags. The resource must exist within the account you are using. + */ + Arn: GroupArn; + } + export interface GetTagsOutput { + /** + * The ARN of the tagged resource group. + */ + Arn?: GroupArn; + /** + * The tags associated with the specified resource group. + */ + Tags?: Tags; + } + export interface Group { + /** + * The ARN of a resource group. + */ + GroupArn: GroupArn; + /** + * The name of a resource group. + */ + Name: GroupName; + /** + * The description of the resource group. + */ + Description?: GroupDescription; + } + export type GroupArn = string; + export type GroupDescription = string; + export interface GroupFilter { + /** + * The name of the filter. Filter names are case-sensitive. + */ + Name: GroupFilterName; + /** + * One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive. + */ + Values: GroupFilterValues; + } + export type GroupFilterList = GroupFilter[]; + export type GroupFilterName = "resource-type"|string; + export type GroupFilterValue = string; + export type GroupFilterValues = GroupFilterValue[]; + export interface GroupIdentifier { + /** + * The name of a resource group. + */ + GroupName?: GroupName; + /** + * The ARN of a resource group. + */ + GroupArn?: GroupArn; + } + export type GroupIdentifierList = GroupIdentifier[]; + export type GroupList = Group[]; + export type GroupName = string; + export interface GroupQuery { + /** + * The name of a resource group that is associated with a specific resource query. + */ + GroupName: GroupName; + /** + * The resource query which determines which AWS resources are members of the associated resource group. + */ + ResourceQuery: ResourceQuery; + } + export interface ListGroupResourcesInput { + /** + * The name of the resource group. + */ + GroupName: GroupName; + /** + * Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket. + */ + Filters?: ResourceFilterList; + /** + * The maximum number of group member ARNs that are returned in a single call by ListGroupResources, in paginated output. By default, this number is 50. + */ + MaxResults?: MaxResults; + /** + * The NextToken value that is returned in a paginated ListGroupResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. + */ + NextToken?: NextToken; + } + export interface ListGroupResourcesOutput { + /** + * The ARNs and resource types of resources that are members of the group that you specified. + */ + ResourceIdentifiers?: ResourceIdentifierList; + /** + * The NextToken value to include in a subsequent ListGroupResources request, to get more results. + */ + NextToken?: NextToken; + /** + * A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING. + */ + QueryErrors?: QueryErrorList; + } + export interface ListGroupsInput { + /** + * Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation. resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket. + */ + Filters?: GroupFilterList; + /** + * The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50. + */ + MaxResults?: MaxResults; + /** + * The NextToken value that is returned in a paginated ListGroups request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. + */ + NextToken?: NextToken; + } + export interface ListGroupsOutput { + /** + * A list of GroupIdentifier objects. Each identifier is an object that contains both the GroupName and the GroupArn. + */ + GroupIdentifiers?: GroupIdentifierList; + /** + * A list of resource groups. + */ + Groups?: GroupList; + /** + * The NextToken value to include in a subsequent ListGroups request, to get more results. + */ + NextToken?: NextToken; + } + export type MaxResults = number; + export type NextToken = string; + export type Query = string; + export interface QueryError { + /** + * Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING. + */ + ErrorCode?: QueryErrorCode; + /** + * A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED. + */ + Message?: QueryErrorMessage; + } + export type QueryErrorCode = "CLOUDFORMATION_STACK_INACTIVE"|"CLOUDFORMATION_STACK_NOT_EXISTING"|string; + export type QueryErrorList = QueryError[]; + export type QueryErrorMessage = string; + export type QueryType = "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0"|string; + export type ResourceArn = string; + export interface ResourceFilter { + /** + * The name of the filter. Filter names are case-sensitive. + */ + Name: ResourceFilterName; + /** + * One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive. + */ + Values: ResourceFilterValues; + } + export type ResourceFilterList = ResourceFilter[]; + export type ResourceFilterName = "resource-type"|string; + export type ResourceFilterValue = string; + export type ResourceFilterValues = ResourceFilterValue[]; + export interface ResourceIdentifier { + /** + * The ARN of a resource. + */ + ResourceArn?: ResourceArn; + /** + * The resource type of a resource, such as AWS::EC2::Instance. + */ + ResourceType?: ResourceType; + } + export type ResourceIdentifierList = ResourceIdentifier[]; + export interface ResourceQuery { + /** + * The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0. TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]) The results of this query might include the following. An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"} An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"} The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter. An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"}. An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"4"} CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN. + */ + Type: QueryType; + /** + * The query that defines a group or a search. + */ + Query: Query; + } + export type ResourceType = string; + export interface SearchResourcesInput { + /** + * The search query, using the same formats that are supported for resource group definition. + */ + ResourceQuery: ResourceQuery; + /** + * The maximum number of group member ARNs returned by SearchResources in paginated output. By default, this number is 50. + */ + MaxResults?: MaxResults; + /** + * The NextToken value that is returned in a paginated SearchResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value. + */ + NextToken?: NextToken; + } + export interface SearchResourcesOutput { + /** + * The ARNs and resource types of resources that are members of the group that you specified. + */ + ResourceIdentifiers?: ResourceIdentifierList; + /** + * The NextToken value to include in a subsequent SearchResources request, to get more results. + */ + NextToken?: NextToken; + /** + * A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING. + */ + QueryErrors?: QueryErrorList; + } + export interface TagInput { + /** + * The ARN of the resource to which to add tags. + */ + Arn: GroupArn; + /** + * The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + */ + Tags: Tags; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export interface TagOutput { + /** + * The ARN of the tagged resource. + */ + Arn?: GroupArn; + /** + * The tags that have been added to the specified resource. + */ + Tags?: Tags; + } + export type TagValue = string; + export type Tags = {[key: string]: TagValue}; + export interface UntagInput { + /** + * The ARN of the resource from which to remove tags. + */ + Arn: GroupArn; + /** + * The keys of the tags to be removed. + */ + Keys: TagKeyList; + } + export interface UntagOutput { + /** + * The ARN of the resource from which tags have been removed. + */ + Arn?: GroupArn; + /** + * The keys of tags that have been removed. + */ + Keys?: TagKeyList; + } + export interface UpdateGroupInput { + /** + * The name of the resource group for which you want to update its description. + */ + GroupName: GroupName; + /** + * The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces. + */ + Description?: GroupDescription; + } + export interface UpdateGroupOutput { + /** + * The full description of the resource group after it has been updated. + */ + Group?: Group; + } + export interface UpdateGroupQueryInput { + /** + * The name of the resource group for which you want to edit the query. + */ + GroupName: GroupName; + /** + * The resource query that determines which AWS resources are members of the resource group. + */ + ResourceQuery: ResourceQuery; + } + export interface UpdateGroupQueryOutput { + /** + * The resource query associated with the resource group after the update. + */ + GroupQuery?: GroupQuery; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-11-27"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ResourceGroups client. + */ + export import Types = ResourceGroups; +} +export = ResourceGroups; diff --git a/node_modules/aws-sdk/clients/resourcegroups.js b/node_modules/aws-sdk/clients/resourcegroups.js new file mode 100644 index 0000000..537afb6 --- /dev/null +++ b/node_modules/aws-sdk/clients/resourcegroups.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['resourcegroups'] = {}; +AWS.ResourceGroups = Service.defineService('resourcegroups', ['2017-11-27']); +Object.defineProperty(apiLoader.services['resourcegroups'], '2017-11-27', { + get: function get() { + var model = require('../apis/resource-groups-2017-11-27.min.json'); + model.paginators = require('../apis/resource-groups-2017-11-27.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ResourceGroups; diff --git a/node_modules/aws-sdk/clients/resourcegroupstaggingapi.d.ts b/node_modules/aws-sdk/clients/resourcegroupstaggingapi.d.ts new file mode 100644 index 0000000..4633cfb --- /dev/null +++ b/node_modules/aws-sdk/clients/resourcegroupstaggingapi.d.ts @@ -0,0 +1,237 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ResourceGroupsTaggingAPI extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ResourceGroupsTaggingAPI.Types.ClientConfiguration) + config: Config & ResourceGroupsTaggingAPI.Types.ClientConfiguration; + /** + * Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags. + */ + getResources(params: ResourceGroupsTaggingAPI.Types.GetResourcesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetResourcesOutput) => void): Request; + /** + * Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags. + */ + getResources(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetResourcesOutput) => void): Request; + /** + * Returns all tag keys in the specified region for the AWS account. + */ + getTagKeys(params: ResourceGroupsTaggingAPI.Types.GetTagKeysInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagKeysOutput) => void): Request; + /** + * Returns all tag keys in the specified region for the AWS account. + */ + getTagKeys(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagKeysOutput) => void): Request; + /** + * Returns all tag values for the specified key in the specified region for the AWS account. + */ + getTagValues(params: ResourceGroupsTaggingAPI.Types.GetTagValuesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagValuesOutput) => void): Request; + /** + * Returns all tag values for the specified key in the specified region for the AWS account. + */ + getTagValues(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagValuesOutput) => void): Request; + /** + * Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide. Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances. You can only tag resources that are located in the specified region for the AWS account. To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide. + */ + tagResources(params: ResourceGroupsTaggingAPI.Types.TagResourcesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.TagResourcesOutput) => void): Request; + /** + * Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide. Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances. You can only tag resources that are located in the specified region for the AWS account. To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide. + */ + tagResources(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.TagResourcesOutput) => void): Request; + /** + * Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide. You can only tag resources that are located in the specified region for the AWS account. + */ + untagResources(params: ResourceGroupsTaggingAPI.Types.UntagResourcesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.UntagResourcesOutput) => void): Request; + /** + * Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide. You can only tag resources that are located in the specified region for the AWS account. + */ + untagResources(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.UntagResourcesOutput) => void): Request; +} +declare namespace ResourceGroupsTaggingAPI { + export type AmazonResourceType = string; + export type ErrorCode = "InternalServiceException"|"InvalidParameterException"|string; + export type ErrorMessage = string; + export type FailedResourcesMap = {[key: string]: FailureInfo}; + export interface FailureInfo { + /** + * The HTTP status code of the common error. + */ + StatusCode?: StatusCode; + /** + * The code of the common error. Valid values include InternalServiceException, InvalidParameterException, and any valid error code returned by the AWS service that hosts the resource that you want to tag. + */ + ErrorCode?: ErrorCode; + /** + * The message of the common error. + */ + ErrorMessage?: ErrorMessage; + } + export interface GetResourcesInput { + /** + * A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. + */ + PaginationToken?: PaginationToken; + /** + * A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values. If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter. If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters. + */ + TagFilters?: TagFilterList; + /** + * A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items. + */ + ResourcesPerPage?: ResourcesPerPage; + /** + * A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair). GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags. You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items. + */ + TagsPerPage?: TagsPerPage; + /** + * The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following: For a list of service name strings, see AWS Service Namespaces. For resource type strings, see Example ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. + */ + ResourceTypeFilters?: ResourceTypeFilterList; + } + export interface GetResourcesOutput { + /** + * A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request. + */ + PaginationToken?: PaginationToken; + /** + * A list of resource ARNs and the tags (keys and values) associated with each. + */ + ResourceTagMappingList?: ResourceTagMappingList; + } + export interface GetTagKeysInput { + /** + * A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. + */ + PaginationToken?: PaginationToken; + } + export interface GetTagKeysOutput { + /** + * A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request. + */ + PaginationToken?: PaginationToken; + /** + * A list of all tag keys in the AWS account. + */ + TagKeys?: TagKeyList; + } + export interface GetTagValuesInput { + /** + * A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. + */ + PaginationToken?: PaginationToken; + /** + * The key for which you want to list all existing values in the specified region for the AWS account. + */ + Key: TagKey; + } + export interface GetTagValuesOutput { + /** + * A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request. + */ + PaginationToken?: PaginationToken; + /** + * A list of all tag values for the specified key in the AWS account. + */ + TagValues?: TagValuesOutputList; + } + export type PaginationToken = string; + export type ResourceARN = string; + export type ResourceARNList = ResourceARN[]; + export interface ResourceTagMapping { + /** + * An array of resource ARN(s). + */ + ResourceARN?: ResourceARN; + /** + * The tags that have been applied to one or more AWS resources. + */ + Tags?: TagList; + } + export type ResourceTagMappingList = ResourceTagMapping[]; + export type ResourceTypeFilterList = AmazonResourceType[]; + export type ResourcesPerPage = number; + export type StatusCode = number; + export interface Tag { + /** + * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. + */ + Key: TagKey; + /** + * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). + */ + Value: TagValue; + } + export interface TagFilter { + /** + * One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. + */ + Key?: TagKey; + /** + * The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). + */ + Values?: TagValueList; + } + export type TagFilterList = TagFilter[]; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagKeyListForUntag = TagKey[]; + export type TagList = Tag[]; + export type TagMap = {[key: string]: TagValue}; + export interface TagResourcesInput { + /** + * A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + ResourceARNList: ResourceARNList; + /** + * The tags that you want to add to the specified resources. A tag consists of a key and a value that you define. + */ + Tags: TagMap; + } + export interface TagResourcesOutput { + /** + * Details of resources that could not be tagged. An error code, status code, and error message are returned for each failed item. + */ + FailedResourcesMap?: FailedResourcesMap; + } + export type TagValue = string; + export type TagValueList = TagValue[]; + export type TagValuesOutputList = TagValue[]; + export type TagsPerPage = number; + export interface UntagResourcesInput { + /** + * A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference. + */ + ResourceARNList: ResourceARNList; + /** + * A list of the tag keys that you want to remove from the specified resources. + */ + TagKeys: TagKeyListForUntag; + } + export interface UntagResourcesOutput { + /** + * Details of resources that could not be untagged. An error code, status code, and error message are returned for each failed item. + */ + FailedResourcesMap?: FailedResourcesMap; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-01-26"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ResourceGroupsTaggingAPI client. + */ + export import Types = ResourceGroupsTaggingAPI; +} +export = ResourceGroupsTaggingAPI; diff --git a/node_modules/aws-sdk/clients/resourcegroupstaggingapi.js b/node_modules/aws-sdk/clients/resourcegroupstaggingapi.js new file mode 100644 index 0000000..e5bdbb0 --- /dev/null +++ b/node_modules/aws-sdk/clients/resourcegroupstaggingapi.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['resourcegroupstaggingapi'] = {}; +AWS.ResourceGroupsTaggingAPI = Service.defineService('resourcegroupstaggingapi', ['2017-01-26']); +Object.defineProperty(apiLoader.services['resourcegroupstaggingapi'], '2017-01-26', { + get: function get() { + var model = require('../apis/resourcegroupstaggingapi-2017-01-26.min.json'); + model.paginators = require('../apis/resourcegroupstaggingapi-2017-01-26.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ResourceGroupsTaggingAPI; diff --git a/node_modules/aws-sdk/clients/robomaker.d.ts b/node_modules/aws-sdk/clients/robomaker.d.ts new file mode 100644 index 0000000..326aa07 --- /dev/null +++ b/node_modules/aws-sdk/clients/robomaker.d.ts @@ -0,0 +1,2050 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class RoboMaker extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: RoboMaker.Types.ClientConfiguration) + config: Config & RoboMaker.Types.ClientConfiguration; + /** + * Describes one or more simulation jobs. + */ + batchDescribeSimulationJob(params: RoboMaker.Types.BatchDescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request; + /** + * Describes one or more simulation jobs. + */ + batchDescribeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request; + /** + * Cancels the specified simulation job. + */ + cancelSimulationJob(params: RoboMaker.Types.CancelSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request; + /** + * Cancels the specified simulation job. + */ + cancelSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request; + /** + * Deploys a specific version of a robot application to robots in a fleet. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible. + */ + createDeploymentJob(params: RoboMaker.Types.CreateDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request; + /** + * Deploys a specific version of a robot application to robots in a fleet. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible. + */ + createDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request; + /** + * Creates a fleet, a logical group of robots running the same robot application. + */ + createFleet(params: RoboMaker.Types.CreateFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request; + /** + * Creates a fleet, a logical group of robots running the same robot application. + */ + createFleet(callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request; + /** + * Creates a robot. + */ + createRobot(params: RoboMaker.Types.CreateRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request; + /** + * Creates a robot. + */ + createRobot(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request; + /** + * Creates a robot application. + */ + createRobotApplication(params: RoboMaker.Types.CreateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request; + /** + * Creates a robot application. + */ + createRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request; + /** + * Creates a version of a robot application. + */ + createRobotApplicationVersion(params: RoboMaker.Types.CreateRobotApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request; + /** + * Creates a version of a robot application. + */ + createRobotApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request; + /** + * Creates a simulation application. + */ + createSimulationApplication(params: RoboMaker.Types.CreateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request; + /** + * Creates a simulation application. + */ + createSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request; + /** + * Creates a simulation application with a specific revision id. + */ + createSimulationApplicationVersion(params: RoboMaker.Types.CreateSimulationApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request; + /** + * Creates a simulation application with a specific revision id. + */ + createSimulationApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request; + /** + * Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. + */ + createSimulationJob(params: RoboMaker.Types.CreateSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request; + /** + * Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. + */ + createSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request; + /** + * Deletes a fleet. + */ + deleteFleet(params: RoboMaker.Types.DeleteFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request; + /** + * Deletes a fleet. + */ + deleteFleet(callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request; + /** + * Deletes a robot. + */ + deleteRobot(params: RoboMaker.Types.DeleteRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request; + /** + * Deletes a robot. + */ + deleteRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request; + /** + * Deletes a robot application. + */ + deleteRobotApplication(params: RoboMaker.Types.DeleteRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request; + /** + * Deletes a robot application. + */ + deleteRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request; + /** + * Deletes a simulation application. + */ + deleteSimulationApplication(params: RoboMaker.Types.DeleteSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request; + /** + * Deletes a simulation application. + */ + deleteSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request; + /** + * Deregisters a robot. + */ + deregisterRobot(params: RoboMaker.Types.DeregisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request; + /** + * Deregisters a robot. + */ + deregisterRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request; + /** + * Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?] + */ + describeDeploymentJob(params: RoboMaker.Types.DescribeDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request; + /** + * Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?] + */ + describeDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request; + /** + * Describes a fleet. + */ + describeFleet(params: RoboMaker.Types.DescribeFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request; + /** + * Describes a fleet. + */ + describeFleet(callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request; + /** + * Describes a robot. + */ + describeRobot(params: RoboMaker.Types.DescribeRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request; + /** + * Describes a robot. + */ + describeRobot(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request; + /** + * Describes a robot application. + */ + describeRobotApplication(params: RoboMaker.Types.DescribeRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request; + /** + * Describes a robot application. + */ + describeRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request; + /** + * Describes a simulation application. + */ + describeSimulationApplication(params: RoboMaker.Types.DescribeSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request; + /** + * Describes a simulation application. + */ + describeSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request; + /** + * Describes a simulation job. + */ + describeSimulationJob(params: RoboMaker.Types.DescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request; + /** + * Describes a simulation job. + */ + describeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request; + /** + * Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. + */ + listDeploymentJobs(params: RoboMaker.Types.ListDeploymentJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request; + /** + * Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. + */ + listDeploymentJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request; + /** + * Returns a list of fleets. You can optionally provide filters to retrieve specific fleets. + */ + listFleets(params: RoboMaker.Types.ListFleetsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request; + /** + * Returns a list of fleets. You can optionally provide filters to retrieve specific fleets. + */ + listFleets(callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request; + /** + * Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications. + */ + listRobotApplications(params: RoboMaker.Types.ListRobotApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request; + /** + * Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications. + */ + listRobotApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request; + /** + * Returns a list of robots. You can optionally provide filters to retrieve specific robots. + */ + listRobots(params: RoboMaker.Types.ListRobotsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request; + /** + * Returns a list of robots. You can optionally provide filters to retrieve specific robots. + */ + listRobots(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request; + /** + * Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. + */ + listSimulationApplications(params: RoboMaker.Types.ListSimulationApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request; + /** + * Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. + */ + listSimulationApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request; + /** + * Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs. + */ + listSimulationJobs(params: RoboMaker.Types.ListSimulationJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request; + /** + * Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs. + */ + listSimulationJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request; + /** + * Lists all tags on a AWS RoboMaker resource. + */ + listTagsForResource(params: RoboMaker.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists all tags on a AWS RoboMaker resource. + */ + listTagsForResource(callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request; + /** + * Registers a robot with a fleet. + */ + registerRobot(params: RoboMaker.Types.RegisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request; + /** + * Registers a robot with a fleet. + */ + registerRobot(callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request; + /** + * Restarts a running simulation job. + */ + restartSimulationJob(params: RoboMaker.Types.RestartSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request; + /** + * Restarts a running simulation job. + */ + restartSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request; + /** + * Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment. + */ + syncDeploymentJob(params: RoboMaker.Types.SyncDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request; + /** + * Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment. + */ + syncDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request; + /** + * Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide. + */ + tagResource(params: RoboMaker.Types.TagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request; + /** + * Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide. + */ + tagResource(callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request; + /** + * Removes the specified tags from the specified AWS RoboMaker resource. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource . + */ + untagResource(params: RoboMaker.Types.UntagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request; + /** + * Removes the specified tags from the specified AWS RoboMaker resource. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource . + */ + untagResource(callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request; + /** + * Updates a robot application. + */ + updateRobotApplication(params: RoboMaker.Types.UpdateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request; + /** + * Updates a robot application. + */ + updateRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request; + /** + * Updates a simulation application. + */ + updateSimulationApplication(params: RoboMaker.Types.UpdateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request; + /** + * Updates a simulation application. + */ + updateSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request; +} +declare namespace RoboMaker { + export type Architecture = "X86_64"|"ARM64"|"ARMHF"|string; + export type Arn = string; + export type Arns = Arn[]; + export interface BatchDescribeSimulationJobRequest { + /** + * A list of Amazon Resource Names (ARNs) of simulation jobs to describe. + */ + jobs: Arns; + } + export interface BatchDescribeSimulationJobResponse { + /** + * A list of simulation jobs. + */ + jobs?: SimulationJobs; + /** + * A list of unprocessed simulation job Amazon Resource Names (ARNs). + */ + unprocessedJobs?: Arns; + } + export type Boolean = boolean; + export interface CancelSimulationJobRequest { + /** + * The simulation job ARN to cancel. + */ + job: Arn; + } + export interface CancelSimulationJobResponse { + } + export type ClientRequestToken = string; + export type Command = string; + export interface CreateDeploymentJobRequest { + /** + * The requested deployment configuration. + */ + deploymentConfig?: DeploymentConfig; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken: ClientRequestToken; + /** + * The Amazon Resource Name (ARN) of the fleet to deploy. + */ + fleet: Arn; + /** + * The deployment application configuration. + */ + deploymentApplicationConfigs: DeploymentApplicationConfigs; + /** + * A map that contains tag keys and tag values that are attached to the deployment job. + */ + tags?: TagMap; + } + export interface CreateDeploymentJobResponse { + /** + * The Amazon Resource Name (ARN) of the deployment job. + */ + arn?: Arn; + /** + * The target fleet for the deployment job. + */ + fleet?: Arn; + /** + * The status of the deployment job. + */ + status?: DeploymentStatus; + /** + * The deployment application configuration. + */ + deploymentApplicationConfigs?: DeploymentApplicationConfigs; + /** + * The failure reason of the deployment job if it failed. + */ + failureReason?: GenericString; + /** + * The failure code of the simulation job if it failed: BadPermissionError AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy. ExtractingBundleFailure The robot application could not be extracted from the bundle. FailureThresholdBreached The percentage of robots that could not be updated exceeded the percentage set for the deployment. GreengrassDeploymentFailed The robot application could not be deployed to the robot. GreengrassGroupVersionDoesNotExist The AWS Greengrass group or version associated with a robot is missing. InternalServerError An internal error has occurred. Retry your request, but if the problem persists, contact us with details. MissingRobotApplicationArchitecture The robot application does not have a source that matches the architecture of the robot. MissingRobotDeploymentResource One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file? PostLaunchFileFailure The post-launch script failed. PreLaunchFileFailure The pre-launch script failed. ResourceNotFound One or more deployment resources are missing. For example, do robot application source bundles still exist? RobotDeploymentNoResponse There is no response from the robot. It might not be powered on or connected to the internet. + */ + failureCode?: DeploymentJobErrorCode; + /** + * The time, in milliseconds since the epoch, when the fleet was created. + */ + createdAt?: CreatedAt; + /** + * The deployment configuration. + */ + deploymentConfig?: DeploymentConfig; + /** + * The list of all tags added to the deployment job. + */ + tags?: TagMap; + } + export interface CreateFleetRequest { + /** + * The name of the fleet. + */ + name: Name; + /** + * A map that contains tag keys and tag values that are attached to the fleet. + */ + tags?: TagMap; + } + export interface CreateFleetResponse { + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + arn?: Arn; + /** + * The name of the fleet. + */ + name?: Name; + /** + * The time, in milliseconds since the epoch, when the fleet was created. + */ + createdAt?: CreatedAt; + /** + * The list of all tags added to the fleet. + */ + tags?: TagMap; + } + export interface CreateRobotApplicationRequest { + /** + * The name of the robot application. + */ + name: Name; + /** + * The sources of the robot application. + */ + sources: SourceConfigs; + /** + * The robot software suite used by the robot application. + */ + robotSoftwareSuite: RobotSoftwareSuite; + /** + * A map that contains tag keys and tag values that are attached to the robot application. + */ + tags?: TagMap; + } + export interface CreateRobotApplicationResponse { + /** + * The Amazon Resource Name (ARN) of the robot application. + */ + arn?: Arn; + /** + * The name of the robot application. + */ + name?: Name; + /** + * The version of the robot application. + */ + version?: Version; + /** + * The sources of the robot application. + */ + sources?: Sources; + /** + * The robot software suite used by the robot application. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The time, in milliseconds since the epoch, when the robot application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The revision id of the robot application. + */ + revisionId?: RevisionId; + /** + * The list of all tags added to the robot application. + */ + tags?: TagMap; + } + export interface CreateRobotApplicationVersionRequest { + /** + * The application information for the robot application. + */ + application: Arn; + /** + * The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created. + */ + currentRevisionId?: RevisionId; + } + export interface CreateRobotApplicationVersionResponse { + /** + * The Amazon Resource Name (ARN) of the robot application. + */ + arn?: Arn; + /** + * The name of the robot application. + */ + name?: Name; + /** + * The version of the robot application. + */ + version?: Version; + /** + * The sources of the robot application. + */ + sources?: Sources; + /** + * The robot software suite used by the robot application. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The time, in milliseconds since the epoch, when the robot application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The revision id of the robot application. + */ + revisionId?: RevisionId; + } + export interface CreateRobotRequest { + /** + * The name for the robot. + */ + name: Name; + /** + * The target architecture of the robot. + */ + architecture: Architecture; + /** + * The Greengrass group id. + */ + greengrassGroupId: Id; + /** + * A map that contains tag keys and tag values that are attached to the robot. + */ + tags?: TagMap; + } + export interface CreateRobotResponse { + /** + * The Amazon Resource Name (ARN) of the robot. + */ + arn?: Arn; + /** + * The name of the robot. + */ + name?: Name; + /** + * The time, in milliseconds since the epoch, when the robot was created. + */ + createdAt?: CreatedAt; + /** + * The Amazon Resource Name (ARN) of the Greengrass group associated with the robot. + */ + greengrassGroupId?: Id; + /** + * The target architecture of the robot. + */ + architecture?: Architecture; + /** + * The list of all tags added to the robot. + */ + tags?: TagMap; + } + export interface CreateSimulationApplicationRequest { + /** + * The name of the simulation application. + */ + name: Name; + /** + * The sources of the simulation application. + */ + sources: SourceConfigs; + /** + * The simulation software suite used by the simulation application. + */ + simulationSoftwareSuite: SimulationSoftwareSuite; + /** + * The robot software suite of the simulation application. + */ + robotSoftwareSuite: RobotSoftwareSuite; + /** + * The rendering engine for the simulation application. + */ + renderingEngine: RenderingEngine; + /** + * A map that contains tag keys and tag values that are attached to the simulation application. + */ + tags?: TagMap; + } + export interface CreateSimulationApplicationResponse { + /** + * The Amazon Resource Name (ARN) of the simulation application. + */ + arn?: Arn; + /** + * The name of the simulation application. + */ + name?: Name; + /** + * The version of the simulation application. + */ + version?: Version; + /** + * The sources of the simulation application. + */ + sources?: Sources; + /** + * The simulation software suite used by the simulation application. + */ + simulationSoftwareSuite?: SimulationSoftwareSuite; + /** + * Information about the robot software suite. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The rendering engine for the simulation application. + */ + renderingEngine?: RenderingEngine; + /** + * The time, in milliseconds since the epoch, when the simulation application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The revision id of the simulation application. + */ + revisionId?: RevisionId; + /** + * The list of all tags added to the simulation application. + */ + tags?: TagMap; + } + export interface CreateSimulationApplicationVersionRequest { + /** + * The application information for the simulation application. + */ + application: Arn; + /** + * The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created. + */ + currentRevisionId?: RevisionId; + } + export interface CreateSimulationApplicationVersionResponse { + /** + * The Amazon Resource Name (ARN) of the simulation application. + */ + arn?: Arn; + /** + * The name of the simulation application. + */ + name?: Name; + /** + * The version of the simulation application. + */ + version?: Version; + /** + * The sources of the simulation application. + */ + sources?: Sources; + /** + * The simulation software suite used by the simulation application. + */ + simulationSoftwareSuite?: SimulationSoftwareSuite; + /** + * Information about the robot software suite. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The rendering engine for the simulation application. + */ + renderingEngine?: RenderingEngine; + /** + * The time, in milliseconds since the epoch, when the simulation application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The revision ID of the simulation application. + */ + revisionId?: RevisionId; + } + export interface CreateSimulationJobRequest { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken?: ClientRequestToken; + /** + * Location for output files generated by the simulation job. + */ + outputLocation?: OutputLocation; + /** + * The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed. + */ + maxJobDurationInSeconds: JobDuration; + /** + * The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. + */ + iamRole: IamRole; + /** + * The failure behavior the simulation job. Continue Restart the simulation job in the same host instance. Fail Stop the simulation job and terminate the instance. + */ + failureBehavior?: FailureBehavior; + /** + * The robot application to use in the simulation job. + */ + robotApplications?: RobotApplicationConfigs; + /** + * The simulation application to use in the simulation job. + */ + simulationApplications?: SimulationApplicationConfigs; + /** + * A map that contains tag keys and tag values that are attached to the simulation job. + */ + tags?: TagMap; + /** + * If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID. + */ + vpcConfig?: VPCConfig; + } + export interface CreateSimulationJobResponse { + /** + * The Amazon Resource Name (ARN) of the simulation job. + */ + arn?: Arn; + /** + * The status of the simulation job. + */ + status?: SimulationJobStatus; + /** + * The time, in milliseconds since the epoch, when the simulation job was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * the failure behavior for the simulation job. + */ + failureBehavior?: FailureBehavior; + /** + * The failure code of the simulation job if it failed: InternalServiceError Internal service error. RobotApplicationCrash Robot application exited abnormally. SimulationApplicationCrash Simulation application exited abnormally. BadPermissionsRobotApplication Robot application bundle could not be downloaded. BadPermissionsSimulationApplication Simulation application bundle could not be downloaded. BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP limit exceeded. ENILimitExceeded ENI limit exceeded. BadPermissionsUserCredentials Unable to use the Role provided. InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, bundling error, or other issue). InvalidBundleSimulationApplication Simulation bundle cannot be extracted (invalid format, bundling error, or other issue). RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match value during version creation. SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does not match value during version creation. + */ + failureCode?: SimulationJobErrorCode; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken?: ClientRequestToken; + /** + * Simulation job output files location. + */ + outputLocation?: OutputLocation; + /** + * The maximum simulation job duration in seconds. + */ + maxJobDurationInSeconds?: JobDuration; + /** + * The simulation job execution duration in milliseconds. + */ + simulationTimeMillis?: SimulationTimeMillis; + /** + * The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf. + */ + iamRole?: IamRole; + /** + * The robot application used by the simulation job. + */ + robotApplications?: RobotApplicationConfigs; + /** + * The simulation application used by the simulation job. + */ + simulationApplications?: SimulationApplicationConfigs; + /** + * The list of all tags added to the simulation job. + */ + tags?: TagMap; + /** + * Information about the vpc configuration. + */ + vpcConfig?: VPCConfigResponse; + } + export type CreatedAt = Date; + export interface DeleteFleetRequest { + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet: Arn; + } + export interface DeleteFleetResponse { + } + export interface DeleteRobotApplicationRequest { + /** + * The Amazon Resource Name (ARN) of the the robot application. + */ + application: Arn; + /** + * The version of the robot application to delete. + */ + applicationVersion?: Version; + } + export interface DeleteRobotApplicationResponse { + } + export interface DeleteRobotRequest { + /** + * The Amazon Resource Name (ARN) of the robot. + */ + robot: Arn; + } + export interface DeleteRobotResponse { + } + export interface DeleteSimulationApplicationRequest { + /** + * The application information for the simulation application to delete. + */ + application: Arn; + /** + * The version of the simulation application to delete. + */ + applicationVersion?: Version; + } + export interface DeleteSimulationApplicationResponse { + } + export interface DeploymentApplicationConfig { + /** + * The Amazon Resource Name (ARN) of the robot application. + */ + application: Arn; + /** + * The version of the application. + */ + applicationVersion: DeploymentVersion; + /** + * The launch configuration. + */ + launchConfig: DeploymentLaunchConfig; + } + export type DeploymentApplicationConfigs = DeploymentApplicationConfig[]; + export interface DeploymentConfig { + /** + * The percentage of robots receiving the deployment at the same time. + */ + concurrentDeploymentPercentage?: Percentage; + /** + * The percentage of deployments that need to fail before stopping deployment. + */ + failureThresholdPercentage?: Percentage; + } + export interface DeploymentJob { + /** + * The Amazon Resource Name (ARN) of the deployment job. + */ + arn?: Arn; + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet?: Arn; + /** + * The status of the deployment job. + */ + status?: DeploymentStatus; + /** + * The deployment application configuration. + */ + deploymentApplicationConfigs?: DeploymentApplicationConfigs; + /** + * The deployment configuration. + */ + deploymentConfig?: DeploymentConfig; + /** + * A short description of the reason why the deployment job failed. + */ + failureReason?: GenericString; + /** + * The deployment job failure code. + */ + failureCode?: DeploymentJobErrorCode; + /** + * The time, in milliseconds since the epoch, when the deployment job was created. + */ + createdAt?: CreatedAt; + } + export type DeploymentJobErrorCode = "ResourceNotFound"|"EnvironmentSetupError"|"EtagMismatch"|"FailureThresholdBreached"|"RobotDeploymentNoResponse"|"RobotAgentConnectionTimeout"|"GreengrassDeploymentFailed"|"MissingRobotArchitecture"|"MissingRobotApplicationArchitecture"|"MissingRobotDeploymentResource"|"GreengrassGroupVersionDoesNotExist"|"ExtractingBundleFailure"|"PreLaunchFileFailure"|"PostLaunchFileFailure"|"BadPermissionError"|"InternalServerError"|string; + export type DeploymentJobs = DeploymentJob[]; + export interface DeploymentLaunchConfig { + /** + * The package name. + */ + packageName: Command; + /** + * The deployment pre-launch file. This file will be executed prior to the launch file. + */ + preLaunchFile?: Path; + /** + * The launch file name. + */ + launchFile: Command; + /** + * The deployment post-launch file. This file will be executed after the launch file. + */ + postLaunchFile?: Path; + /** + * An array of key/value pairs specifying environment variables for the robot application + */ + environmentVariables?: EnvironmentVariableMap; + } + export type DeploymentStatus = "Pending"|"Preparing"|"InProgress"|"Failed"|"Succeeded"|string; + export type DeploymentVersion = string; + export interface DeregisterRobotRequest { + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet: Arn; + /** + * The Amazon Resource Name (ARN) of the robot. + */ + robot: Arn; + } + export interface DeregisterRobotResponse { + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet?: Arn; + /** + * The Amazon Resource Name (ARN) of the robot. + */ + robot?: Arn; + } + export interface DescribeDeploymentJobRequest { + /** + * The Amazon Resource Name (ARN) of the deployment job. + */ + job: Arn; + } + export interface DescribeDeploymentJobResponse { + /** + * The Amazon Resource Name (ARN) of the deployment job. + */ + arn?: Arn; + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet?: Arn; + /** + * The status of the deployment job. + */ + status?: DeploymentStatus; + /** + * The deployment configuration. + */ + deploymentConfig?: DeploymentConfig; + /** + * The deployment application configuration. + */ + deploymentApplicationConfigs?: DeploymentApplicationConfigs; + /** + * A short description of the reason why the deployment job failed. + */ + failureReason?: GenericString; + /** + * The deployment job failure code. + */ + failureCode?: DeploymentJobErrorCode; + /** + * The time, in milliseconds since the epoch, when the deployment job was created. + */ + createdAt?: CreatedAt; + /** + * A list of robot deployment summaries. + */ + robotDeploymentSummary?: RobotDeploymentSummary; + /** + * The list of all tags added to the specified deployment job. + */ + tags?: TagMap; + } + export interface DescribeFleetRequest { + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet: Arn; + } + export interface DescribeFleetResponse { + /** + * The name of the fleet. + */ + name?: Name; + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + arn?: Arn; + /** + * A list of robots. + */ + robots?: Robots; + /** + * The time, in milliseconds since the epoch, when the fleet was created. + */ + createdAt?: CreatedAt; + /** + * The status of the last deployment. + */ + lastDeploymentStatus?: DeploymentStatus; + /** + * The Amazon Resource Name (ARN) of the last deployment job. + */ + lastDeploymentJob?: Arn; + /** + * The time of the last deployment. + */ + lastDeploymentTime?: CreatedAt; + /** + * The list of all tags added to the specified fleet. + */ + tags?: TagMap; + } + export interface DescribeRobotApplicationRequest { + /** + * The Amazon Resource Name (ARN) of the robot application. + */ + application: Arn; + /** + * The version of the robot application to describe. + */ + applicationVersion?: Version; + } + export interface DescribeRobotApplicationResponse { + /** + * The Amazon Resource Name (ARN) of the robot application. + */ + arn?: Arn; + /** + * The name of the robot application. + */ + name?: Name; + /** + * The version of the robot application. + */ + version?: Version; + /** + * The sources of the robot application. + */ + sources?: Sources; + /** + * The robot software suite used by the robot application. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The revision id of the robot application. + */ + revisionId?: RevisionId; + /** + * The time, in milliseconds since the epoch, when the robot application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The list of all tags added to the specified robot application. + */ + tags?: TagMap; + } + export interface DescribeRobotRequest { + /** + * The Amazon Resource Name (ARN) of the robot to be described. + */ + robot: Arn; + } + export interface DescribeRobotResponse { + /** + * The Amazon Resource Name (ARN) of the robot. + */ + arn?: Arn; + /** + * The name of the robot. + */ + name?: Name; + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleetArn?: Arn; + /** + * The status of the fleet. + */ + status?: RobotStatus; + /** + * The Greengrass group id. + */ + greengrassGroupId?: Id; + /** + * The time, in milliseconds since the epoch, when the robot was created. + */ + createdAt?: CreatedAt; + /** + * The target architecture of the robot application. + */ + architecture?: Architecture; + /** + * The Amazon Resource Name (ARN) of the last deployment job. + */ + lastDeploymentJob?: Arn; + /** + * The time of the last deployment job. + */ + lastDeploymentTime?: CreatedAt; + /** + * The list of all tags added to the specified robot. + */ + tags?: TagMap; + } + export interface DescribeSimulationApplicationRequest { + /** + * The application information for the simulation application. + */ + application: Arn; + /** + * The version of the simulation application to describe. + */ + applicationVersion?: Version; + } + export interface DescribeSimulationApplicationResponse { + /** + * The Amazon Resource Name (ARN) of the robot simulation application. + */ + arn?: Arn; + /** + * The name of the simulation application. + */ + name?: Name; + /** + * The version of the simulation application. + */ + version?: Version; + /** + * The sources of the simulation application. + */ + sources?: Sources; + /** + * The simulation software suite used by the simulation application. + */ + simulationSoftwareSuite?: SimulationSoftwareSuite; + /** + * Information about the robot software suite. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The rendering engine for the simulation application. + */ + renderingEngine?: RenderingEngine; + /** + * The revision id of the simulation application. + */ + revisionId?: RevisionId; + /** + * The time, in milliseconds since the epoch, when the simulation application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The list of all tags added to the specified simulation application. + */ + tags?: TagMap; + } + export interface DescribeSimulationJobRequest { + /** + * The Amazon Resource Name (ARN) of the simulation job to be described. + */ + job: Arn; + } + export interface DescribeSimulationJobResponse { + /** + * The Amazon Resource Name (ARN) of the simulation job. + */ + arn?: Arn; + /** + * The name of the simulation job. + */ + name?: Name; + /** + * The status of the simulation job. + */ + status?: SimulationJobStatus; + /** + * The time, in milliseconds since the epoch, when the simulation job was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The failure behavior for the simulation job. + */ + failureBehavior?: FailureBehavior; + /** + * The failure code of the simulation job if it failed: InternalServiceError Internal service error. RobotApplicationCrash Robot application exited abnormally. SimulationApplicationCrash Simulation application exited abnormally. BadPermissionsRobotApplication Robot application bundle could not be downloaded. BadPermissionsSimulationApplication Simulation application bundle could not be downloaded. BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP limit exceeded. ENILimitExceeded ENI limit exceeded. BadPermissionsUserCredentials Unable to use the Role provided. InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, bundling error, or other issue). InvalidBundleSimulationApplication Simulation bundle cannot be extracted (invalid format, bundling error, or other issue). RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match value during version creation. SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does not match value during version creation. + */ + failureCode?: SimulationJobErrorCode; + /** + * Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting. + */ + failureReason?: GenericString; + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken?: ClientRequestToken; + /** + * Location for output files generated by the simulation job. + */ + outputLocation?: OutputLocation; + /** + * The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less. + */ + maxJobDurationInSeconds?: JobDuration; + /** + * The simulation job execution duration in milliseconds. + */ + simulationTimeMillis?: SimulationTimeMillis; + /** + * The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. + */ + iamRole?: IamRole; + /** + * A list of robot applications. + */ + robotApplications?: RobotApplicationConfigs; + /** + * A list of simulation applications. + */ + simulationApplications?: SimulationApplicationConfigs; + /** + * The list of all tags added to the specified simulation job. + */ + tags?: TagMap; + /** + * The VPC configuration. + */ + vpcConfig?: VPCConfigResponse; + } + export type EnvironmentVariableKey = string; + export type EnvironmentVariableMap = {[key: string]: EnvironmentVariableValue}; + export type EnvironmentVariableValue = string; + export type FailureBehavior = "Fail"|"Continue"|string; + export interface Filter { + /** + * The name of the filter. + */ + name?: Name; + /** + * A list of values. + */ + values?: FilterValues; + } + export type FilterValues = Name[]; + export type Filters = Filter[]; + export interface Fleet { + /** + * The name of the fleet. + */ + name?: Name; + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + arn?: Arn; + /** + * The time, in milliseconds since the epoch, when the fleet was created. + */ + createdAt?: CreatedAt; + /** + * The status of the last fleet deployment. + */ + lastDeploymentStatus?: DeploymentStatus; + /** + * The Amazon Resource Name (ARN) of the last deployment job. + */ + lastDeploymentJob?: Arn; + /** + * The time of the last deployment. + */ + lastDeploymentTime?: CreatedAt; + } + export type Fleets = Fleet[]; + export type GenericInteger = number; + export type GenericString = string; + export type IamRole = string; + export type Id = string; + export type JobDuration = number; + export type LastUpdatedAt = Date; + export interface LaunchConfig { + /** + * The package name. + */ + packageName: Command; + /** + * The launch file name. + */ + launchFile: Command; + /** + * The environment variables for the application launch. + */ + environmentVariables?: EnvironmentVariableMap; + } + export interface ListDeploymentJobsRequest { + /** + * Optional filters to limit results. The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending. + */ + filters?: Filters; + /** + * The nextToken value returned from a previous paginated ListDeploymentJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: PaginationToken; + /** + * The maximum number of deployment job results returned by ListDeploymentJobs in paginated output. When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListDeploymentJobs returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: MaxResults; + } + export interface ListDeploymentJobsResponse { + /** + * A list of deployment jobs that meet the criteria of the request. + */ + deploymentJobs?: DeploymentJobs; + /** + * The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListDeploymentJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: PaginationToken; + } + export interface ListFleetsRequest { + /** + * The nextToken value returned from a previous paginated ListFleets request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: PaginationToken; + /** + * The maximum number of deployment job results returned by ListFleets in paginated output. When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListFleets returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: MaxResults; + /** + * Optional filters to limit results. The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters. + */ + filters?: Filters; + } + export interface ListFleetsResponse { + /** + * A list of fleet details meeting the request criteria. + */ + fleetDetails?: Fleets; + /** + * The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListFleets request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: PaginationToken; + } + export interface ListRobotApplicationsRequest { + /** + * The version qualifier of the robot application. + */ + versionQualifier?: VersionQualifier; + /** + * The nextToken value returned from a previous paginated ListRobotApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: PaginationToken; + /** + * The maximum number of deployment job results returned by ListRobotApplications in paginated output. When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: MaxResults; + /** + * Optional filters to limit results. The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters. + */ + filters?: Filters; + } + export interface ListRobotApplicationsResponse { + /** + * A list of robot application summaries that meet the criteria of the request. + */ + robotApplicationSummaries?: RobotApplicationSummaries; + /** + * The nextToken value to include in a future ListRobotApplications request. When the results of a ListRobotApplications request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: PaginationToken; + } + export interface ListRobotsRequest { + /** + * The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: PaginationToken; + /** + * The maximum number of deployment job results returned by ListRobots in paginated output. When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobots returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: MaxResults; + /** + * Optional filters to limit results. The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available. + */ + filters?: Filters; + } + export interface ListRobotsResponse { + /** + * A list of robots that meet the criteria of the request. + */ + robots?: Robots; + /** + * The nextToken value to include in a future ListRobots request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: PaginationToken; + } + export interface ListSimulationApplicationsRequest { + /** + * The version qualifier of the simulation application. + */ + versionQualifier?: VersionQualifier; + /** + * The nextToken value returned from a previous paginated ListSimulationApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: PaginationToken; + /** + * The maximum number of deployment job results returned by ListSimulationApplications in paginated output. When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: MaxResults; + /** + * Optional list of filters to limit results. The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters. + */ + filters?: Filters; + } + export interface ListSimulationApplicationsResponse { + /** + * A list of simulation application summaries that meet the criteria of the request. + */ + simulationApplicationSummaries?: SimulationApplicationSummaries; + /** + * The nextToken value to include in a future ListSimulationApplications request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: PaginationToken; + } + export interface ListSimulationJobsRequest { + /** + * The nextToken value returned from a previous paginated ListSimulationJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. + */ + nextToken?: PaginationToken; + /** + * The maximum number of deployment job results returned by ListSimulationJobs in paginated output. When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationJobs returns up to 100 results and a nextToken value if applicable. + */ + maxResults?: MaxResults; + /** + * Optional filters to limit results. The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running. + */ + filters?: Filters; + } + export interface ListSimulationJobsResponse { + /** + * A list of simulation job summaries that meet the criteria of the request. + */ + simulationJobSummaries: SimulationJobSummaries; + /** + * The nextToken value to include in a future ListSimulationJobs request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. + */ + nextToken?: PaginationToken; + } + export interface ListTagsForResourceRequest { + /** + * The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed. + */ + resourceArn: Arn; + } + export interface ListTagsForResourceResponse { + /** + * The list of all tags added to the specified resource. + */ + tags?: TagMap; + } + export type MaxResults = number; + export type Name = string; + export interface OutputLocation { + /** + * The S3 bucket for output. + */ + s3Bucket?: S3Bucket; + /** + * The S3 folder in the s3Bucket where output files will be placed. + */ + s3Prefix?: S3Key; + } + export type PaginationToken = string; + export type Path = string; + export type PercentDone = number; + export type Percentage = number; + export interface ProgressDetail { + /** + * The current progress status. Validating Validating the deployment. Downloading/Extracting Downloading and extracting the bundle on the robot. Executing pre-launch script(s) Executing pre-launch script(s) if provided. Launching Launching the robot application. Executing post-launch script(s) Executing post-launch script(s) if provided. Finished Deployment is complete. + */ + currentProgress?: RobotDeploymentStep; + /** + * Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps. + */ + percentDone?: PercentDone; + /** + * Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps. + */ + estimatedTimeRemainingSeconds?: GenericInteger; + /** + * The Amazon Resource Name (ARN) of the deployment job. + */ + targetResource?: GenericString; + } + export interface RegisterRobotRequest { + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet: Arn; + /** + * The Amazon Resource Name (ARN) of the robot. + */ + robot: Arn; + } + export interface RegisterRobotResponse { + /** + * The Amazon Resource Name (ARN) of the fleet that the robot will join. + */ + fleet?: Arn; + /** + * Information about the robot registration. + */ + robot?: Arn; + } + export interface RenderingEngine { + /** + * The name of the rendering engine. + */ + name?: RenderingEngineType; + /** + * The version of the rendering engine. + */ + version?: RenderingEngineVersionType; + } + export type RenderingEngineType = "OGRE"|string; + export type RenderingEngineVersionType = string; + export interface RestartSimulationJobRequest { + /** + * The Amazon Resource Name (ARN) of the simulation job. + */ + job: Arn; + } + export interface RestartSimulationJobResponse { + } + export type RevisionId = string; + export interface Robot { + /** + * The Amazon Resource Name (ARN) of the robot. + */ + arn?: Arn; + /** + * The name of the robot. + */ + name?: Name; + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleetArn?: Arn; + /** + * The status of the robot. + */ + status?: RobotStatus; + /** + * The Greengrass group associated with the robot. + */ + greenGrassGroupId?: Id; + /** + * The time, in milliseconds since the epoch, when the robot was created. + */ + createdAt?: CreatedAt; + /** + * The architecture of the robot. + */ + architecture?: Architecture; + /** + * The Amazon Resource Name (ARN) of the last deployment job. + */ + lastDeploymentJob?: Arn; + /** + * The time of the last deployment. + */ + lastDeploymentTime?: CreatedAt; + } + export interface RobotApplicationConfig { + /** + * The application information for the robot application. + */ + application: Arn; + /** + * The version of the robot application. + */ + applicationVersion?: Version; + /** + * The launch configuration for the robot application. + */ + launchConfig: LaunchConfig; + } + export type RobotApplicationConfigs = RobotApplicationConfig[]; + export type RobotApplicationNames = Name[]; + export type RobotApplicationSummaries = RobotApplicationSummary[]; + export interface RobotApplicationSummary { + /** + * The name of the robot application. + */ + name?: Name; + /** + * The Amazon Resource Name (ARN) of the robot. + */ + arn?: Arn; + /** + * The version of the robot application. + */ + version?: Version; + /** + * The time, in milliseconds since the epoch, when the robot application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + } + export interface RobotDeployment { + /** + * The robot deployment Amazon Resource Name (ARN). + */ + arn?: Arn; + /** + * The time, in milliseconds since the epoch, when the deployment was started. + */ + deploymentStartTime?: CreatedAt; + /** + * The time, in milliseconds since the epoch, when the deployment finished. + */ + deploymentFinishTime?: CreatedAt; + /** + * The status of the robot deployment. + */ + status?: RobotStatus; + /** + * Information about how the deployment is progressing. + */ + progressDetail?: ProgressDetail; + /** + * A short description of the reason why the robot deployment failed. + */ + failureReason?: GenericString; + /** + * The robot deployment failure code. + */ + failureCode?: DeploymentJobErrorCode; + } + export type RobotDeploymentStep = "Validating"|"DownloadingExtracting"|"ExecutingPreLaunch"|"Launching"|"ExecutingPostLaunch"|"Finished"|string; + export type RobotDeploymentSummary = RobotDeployment[]; + export interface RobotSoftwareSuite { + /** + * The name of the robot software suite. + */ + name?: RobotSoftwareSuiteType; + /** + * The version of the robot software suite. + */ + version?: RobotSoftwareSuiteVersionType; + } + export type RobotSoftwareSuiteType = "ROS"|string; + export type RobotSoftwareSuiteVersionType = "Kinetic"|string; + export type RobotStatus = "Available"|"Registered"|"PendingNewDeployment"|"Deploying"|"Failed"|"InSync"|"NoResponse"|string; + export type Robots = Robot[]; + export type S3Bucket = string; + export type S3Etag = string; + export type S3Key = string; + export type SecurityGroups = GenericString[]; + export interface SimulationApplicationConfig { + /** + * The application information for the simulation application. + */ + application: Arn; + /** + * The version of the simulation application. + */ + applicationVersion?: Version; + /** + * The launch configuration for the simulation application. + */ + launchConfig: LaunchConfig; + } + export type SimulationApplicationConfigs = SimulationApplicationConfig[]; + export type SimulationApplicationNames = Name[]; + export type SimulationApplicationSummaries = SimulationApplicationSummary[]; + export interface SimulationApplicationSummary { + /** + * The name of the simulation application. + */ + name?: Name; + /** + * The Amazon Resource Name (ARN) of the simulation application. + */ + arn?: Arn; + /** + * The version of the simulation application. + */ + version?: Version; + /** + * The time, in milliseconds since the epoch, when the simulation application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + } + export interface SimulationJob { + /** + * The Amazon Resource Name (ARN) of the simulation job. + */ + arn?: Arn; + /** + * The name of the simulation job. + */ + name?: Name; + /** + * Status of the simulation job. + */ + status?: SimulationJobStatus; + /** + * The time, in milliseconds since the epoch, when the simulation job was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The failure behavior the simulation job. Continue Restart the simulation job in the same host instance. Fail Stop the simulation job and terminate the instance. + */ + failureBehavior?: FailureBehavior; + /** + * The failure code of the simulation job if it failed. + */ + failureCode?: SimulationJobErrorCode; + /** + * The reason why the simulation job failed. + */ + failureReason?: GenericString; + /** + * A unique identifier for this SimulationJob request. + */ + clientRequestToken?: ClientRequestToken; + /** + * Location for output files generated by the simulation job. + */ + outputLocation?: OutputLocation; + /** + * The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less. + */ + maxJobDurationInSeconds?: JobDuration; + /** + * The simulation job execution duration in milliseconds. + */ + simulationTimeMillis?: SimulationTimeMillis; + /** + * The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. See how to specify AWS security credentials for your application. + */ + iamRole?: IamRole; + /** + * A list of robot applications. + */ + robotApplications?: RobotApplicationConfigs; + /** + * A list of simulation applications. + */ + simulationApplications?: SimulationApplicationConfigs; + /** + * A map that contains tag keys and tag values that are attached to the simulation job. + */ + tags?: TagMap; + /** + * VPC configuration information. + */ + vpcConfig?: VPCConfigResponse; + } + export type SimulationJobErrorCode = "InternalServiceError"|"RobotApplicationCrash"|"SimulationApplicationCrash"|"BadPermissionsRobotApplication"|"BadPermissionsSimulationApplication"|"BadPermissionsS3Output"|"BadPermissionsCloudwatchLogs"|"SubnetIpLimitExceeded"|"ENILimitExceeded"|"BadPermissionsUserCredentials"|"InvalidBundleRobotApplication"|"InvalidBundleSimulationApplication"|"RobotApplicationVersionMismatchedEtag"|"SimulationApplicationVersionMismatchedEtag"|"WrongRegionS3Output"|"WrongRegionRobotApplication"|"WrongRegionSimulationApplication"|string; + export type SimulationJobStatus = "Pending"|"Preparing"|"Running"|"Restarting"|"Completed"|"Failed"|"RunningFailed"|"Terminating"|"Terminated"|"Canceled"|string; + export type SimulationJobSummaries = SimulationJobSummary[]; + export interface SimulationJobSummary { + /** + * The Amazon Resource Name (ARN) of the simulation job. + */ + arn?: Arn; + /** + * The time, in milliseconds since the epoch, when the simulation job was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The name of the simulation job. + */ + name?: Name; + /** + * The status of the simulation job. + */ + status?: SimulationJobStatus; + /** + * A list of simulation job simulation application names. + */ + simulationApplicationNames?: SimulationApplicationNames; + /** + * A list of simulation job robot application names. + */ + robotApplicationNames?: RobotApplicationNames; + } + export type SimulationJobs = SimulationJob[]; + export interface SimulationSoftwareSuite { + /** + * The name of the simulation software suite. + */ + name?: SimulationSoftwareSuiteType; + /** + * The version of the simulation software suite. + */ + version?: SimulationSoftwareSuiteVersionType; + } + export type SimulationSoftwareSuiteType = "Gazebo"|string; + export type SimulationSoftwareSuiteVersionType = string; + export type SimulationTimeMillis = number; + export interface Source { + /** + * The s3 bucket name. + */ + s3Bucket?: S3Bucket; + /** + * The s3 object key. + */ + s3Key?: S3Key; + /** + * A hash of the object specified by s3Bucket and s3Key. + */ + etag?: S3Etag; + /** + * The taget processor architecture for the application. + */ + architecture?: Architecture; + } + export interface SourceConfig { + /** + * The Amazon S3 bucket name. + */ + s3Bucket?: S3Bucket; + /** + * The s3 object key. + */ + s3Key?: S3Key; + /** + * The target processor architecture for the application. + */ + architecture?: Architecture; + } + export type SourceConfigs = SourceConfig[]; + export type Sources = Source[]; + export type Subnets = GenericString[]; + export interface SyncDeploymentJobRequest { + /** + * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + */ + clientRequestToken: ClientRequestToken; + /** + * The target fleet for the synchronization. + */ + fleet: Arn; + } + export interface SyncDeploymentJobResponse { + /** + * The Amazon Resource Name (ARN) of the synchronization request. + */ + arn?: Arn; + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + fleet?: Arn; + /** + * The status of the synchronization job. + */ + status?: DeploymentStatus; + /** + * Information about the deployment configuration. + */ + deploymentConfig?: DeploymentConfig; + /** + * Information about the deployment application configurations. + */ + deploymentApplicationConfigs?: DeploymentApplicationConfigs; + /** + * The failure reason if the job fails. + */ + failureReason?: GenericString; + /** + * The failure code if the job fails: InternalServiceError Internal service error. RobotApplicationCrash Robot application exited abnormally. SimulationApplicationCrash Simulation application exited abnormally. BadPermissionsRobotApplication Robot application bundle could not be downloaded. BadPermissionsSimulationApplication Simulation application bundle could not be downloaded. BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP limit exceeded. ENILimitExceeded ENI limit exceeded. BadPermissionsUserCredentials Unable to use the Role provided. InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, bundling error, or other issue). InvalidBundleSimulationApplication Simulation bundle cannot be extracted (invalid format, bundling error, or other issue). RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match value during version creation. SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does not match value during version creation. + */ + failureCode?: DeploymentJobErrorCode; + /** + * The time, in milliseconds since the epoch, when the fleet was created. + */ + createdAt?: CreatedAt; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagMap = {[key: string]: TagValue}; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging. + */ + resourceArn: Arn; + /** + * A map that contains tag keys and tag values that are attached to the resource. + */ + tags: TagMap; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags. + */ + resourceArn: Arn; + /** + * A map that contains tag keys and tag values that will be unattached from the resource. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateRobotApplicationRequest { + /** + * The application information for the robot application. + */ + application: Arn; + /** + * The sources of the robot application. + */ + sources: SourceConfigs; + /** + * The robot software suite used by the robot application. + */ + robotSoftwareSuite: RobotSoftwareSuite; + /** + * The revision id for the robot application. + */ + currentRevisionId?: RevisionId; + } + export interface UpdateRobotApplicationResponse { + /** + * The Amazon Resource Name (ARN) of the updated robot application. + */ + arn?: Arn; + /** + * The name of the robot application. + */ + name?: Name; + /** + * The version of the robot application. + */ + version?: Version; + /** + * The sources of the robot application. + */ + sources?: Sources; + /** + * The robot software suite used by the robot application. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The time, in milliseconds since the epoch, when the robot application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The revision id of the robot application. + */ + revisionId?: RevisionId; + } + export interface UpdateSimulationApplicationRequest { + /** + * The application information for the simulation application. + */ + application: Arn; + /** + * The sources of the simulation application. + */ + sources: SourceConfigs; + /** + * The simulation software suite used by the simulation application. + */ + simulationSoftwareSuite: SimulationSoftwareSuite; + /** + * Information about the robot software suite. + */ + robotSoftwareSuite: RobotSoftwareSuite; + /** + * The rendering engine for the simulation application. + */ + renderingEngine: RenderingEngine; + /** + * The revision id for the robot application. + */ + currentRevisionId?: RevisionId; + } + export interface UpdateSimulationApplicationResponse { + /** + * The Amazon Resource Name (ARN) of the updated simulation application. + */ + arn?: Arn; + /** + * The name of the simulation application. + */ + name?: Name; + /** + * The version of the robot application. + */ + version?: Version; + /** + * The sources of the simulation application. + */ + sources?: Sources; + /** + * The simulation software suite used by the simulation application. + */ + simulationSoftwareSuite?: SimulationSoftwareSuite; + /** + * Information about the robot software suite. + */ + robotSoftwareSuite?: RobotSoftwareSuite; + /** + * The rendering engine for the simulation application. + */ + renderingEngine?: RenderingEngine; + /** + * The time, in milliseconds since the epoch, when the simulation application was last updated. + */ + lastUpdatedAt?: LastUpdatedAt; + /** + * The revision id of the simulation application. + */ + revisionId?: RevisionId; + } + export interface VPCConfig { + /** + * A list of one or more subnet IDs in your VPC. + */ + subnets: Subnets; + /** + * A list of one or more security groups IDs in your VPC. + */ + securityGroups?: SecurityGroups; + /** + * A boolean indicating whether to assign a public IP address. + */ + assignPublicIp?: Boolean; + } + export interface VPCConfigResponse { + /** + * A list of subnet IDs associated with the simulation job. + */ + subnets?: Subnets; + /** + * A list of security group IDs associated with the simulation job. + */ + securityGroups?: SecurityGroups; + /** + * The VPC ID associated with your simulation job. + */ + vpcId?: GenericString; + /** + * A boolean indicating if a public IP was assigned. + */ + assignPublicIp?: Boolean; + } + export type Version = string; + export type VersionQualifier = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-06-29"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the RoboMaker client. + */ + export import Types = RoboMaker; +} +export = RoboMaker; diff --git a/node_modules/aws-sdk/clients/robomaker.js b/node_modules/aws-sdk/clients/robomaker.js new file mode 100644 index 0000000..3fa223e --- /dev/null +++ b/node_modules/aws-sdk/clients/robomaker.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['robomaker'] = {}; +AWS.RoboMaker = Service.defineService('robomaker', ['2018-06-29']); +Object.defineProperty(apiLoader.services['robomaker'], '2018-06-29', { + get: function get() { + var model = require('../apis/robomaker-2018-06-29.min.json'); + model.paginators = require('../apis/robomaker-2018-06-29.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.RoboMaker; diff --git a/node_modules/aws-sdk/clients/route53.d.ts b/node_modules/aws-sdk/clients/route53.d.ts new file mode 100644 index 0000000..7a044ff --- /dev/null +++ b/node_modules/aws-sdk/clients/route53.d.ts @@ -0,0 +1,2434 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Route53 extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Route53.Types.ClientConfiguration) + config: Config & Route53.Types.ClientConfiguration; + /** + * Associates an Amazon VPC with a private hosted zone. To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone. If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request. + */ + associateVPCWithHostedZone(params: Route53.Types.AssociateVPCWithHostedZoneRequest, callback?: (err: AWSError, data: Route53.Types.AssociateVPCWithHostedZoneResponse) => void): Request; + /** + * Associates an Amazon VPC with a private hosted zone. To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone. If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request. + */ + associateVPCWithHostedZone(callback?: (err: AWSError, data: Route53.Types.AssociateVPCWithHostedZoneResponse) => void): Request; + /** + * Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44. Change Batches and Transactional Changes The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Route 53 either makes all or none of the changes in a change batch request. This ensures that Route 53 never partially implements the intended changes to the resource record sets in a hosted zone. For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist. Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error. Traffic Flow To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide. Create, Delete, and Upsert Use ChangeResourceRecordsSetsRequest to perform the following actions: CREATE: Creates a resource record set that has the specified values. DELETE: Deletes an existing resource record set that has the specified values. UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request. Syntaxes for Creating, Updating, and Deleting Resource Record Sets The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. For an example for each type of resource record set, see "Examples." Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets. Change Propagation to Route 53 DNS Servers When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange. Limits on ChangeResourceRecordSets Requests For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide. + */ + changeResourceRecordSets(params: Route53.Types.ChangeResourceRecordSetsRequest, callback?: (err: AWSError, data: Route53.Types.ChangeResourceRecordSetsResponse) => void): Request; + /** + * Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44. Change Batches and Transactional Changes The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Route 53 either makes all or none of the changes in a change batch request. This ensures that Route 53 never partially implements the intended changes to the resource record sets in a hosted zone. For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist. Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error. Traffic Flow To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide. Create, Delete, and Upsert Use ChangeResourceRecordsSetsRequest to perform the following actions: CREATE: Creates a resource record set that has the specified values. DELETE: Deletes an existing resource record set that has the specified values. UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request. Syntaxes for Creating, Updating, and Deleting Resource Record Sets The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. For an example for each type of resource record set, see "Examples." Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets. Change Propagation to Route 53 DNS Servers When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange. Limits on ChangeResourceRecordSets Requests For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide. + */ + changeResourceRecordSets(callback?: (err: AWSError, data: Route53.Types.ChangeResourceRecordSetsResponse) => void): Request; + /** + * Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + changeTagsForResource(params: Route53.Types.ChangeTagsForResourceRequest, callback?: (err: AWSError, data: Route53.Types.ChangeTagsForResourceResponse) => void): Request; + /** + * Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + changeTagsForResource(callback?: (err: AWSError, data: Route53.Types.ChangeTagsForResourceResponse) => void): Request; + /** + * Creates a new health check. For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets. ELB Load Balancers If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check. Private Hosted Zones You can associate health checks with failover resource record sets in a private hosted zone. Note the following: Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC. You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server. You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide. + */ + createHealthCheck(params: Route53.Types.CreateHealthCheckRequest, callback?: (err: AWSError, data: Route53.Types.CreateHealthCheckResponse) => void): Request; + /** + * Creates a new health check. For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets. ELB Load Balancers If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check. Private Hosted Zones You can associate health checks with failover resource record sets in a private hosted zone. Note the following: Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC. You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server. You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide. + */ + createHealthCheck(callback?: (err: AWSError, data: Route53.Types.CreateHealthCheckResponse) => void): Request; + /** + * Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets. For more information about charges for hosted zones, see Amazon Route 53 Pricing. Note the following: You can't create a hosted zone for a top-level domain (TLD) such as .com. For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide. If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element. If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC. + */ + createHostedZone(params: Route53.Types.CreateHostedZoneRequest, callback?: (err: AWSError, data: Route53.Types.CreateHostedZoneResponse) => void): Request; + /** + * Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets. For more information about charges for hosted zones, see Amazon Route 53 Pricing. Note the following: You can't create a hosted zone for a top-level domain (TLD) such as .com. For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide. If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element. If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC. + */ + createHostedZone(callback?: (err: AWSError, data: Route53.Types.CreateHostedZoneResponse) => void): Request; + /** + * Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: Route 53 edge location that responded to the DNS query Domain or subdomain that was requested DNS record type, such as A or AAAA DNS response code, such as NoError or ServFail Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI. Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. + */ + createQueryLoggingConfig(params: Route53.Types.CreateQueryLoggingConfigRequest, callback?: (err: AWSError, data: Route53.Types.CreateQueryLoggingConfigResponse) => void): Request; + /** + * Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: Route 53 edge location that responded to the DNS query Domain or subdomain that was requested DNS record type, such as A or AAAA DNS response code, such as NoError or ServFail Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI. Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. + */ + createQueryLoggingConfig(callback?: (err: AWSError, data: Route53.Types.CreateQueryLoggingConfigResponse) => void): Request; + /** + * Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable. You can't associate a reusable delegation set with a private hosted zone. For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers. The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps: Create a reusable delegation set. Recreate hosted zones, and reduce the TTL to 60 seconds or less. Recreate resource record sets in the new hosted zones. Change the registrar's name servers to use the name servers for the new hosted zones. Monitor traffic for the website or application. Change TTLs back to their original values. If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following: For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones. For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set. For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set. + */ + createReusableDelegationSet(params: Route53.Types.CreateReusableDelegationSetRequest, callback?: (err: AWSError, data: Route53.Types.CreateReusableDelegationSetResponse) => void): Request; + /** + * Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable. You can't associate a reusable delegation set with a private hosted zone. For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers. The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps: Create a reusable delegation set. Recreate hosted zones, and reduce the TTL to 60 seconds or less. Recreate resource record sets in the new hosted zones. Change the registrar's name servers to use the name servers for the new hosted zones. Monitor traffic for the website or application. Change TTLs back to their original values. If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following: For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones. For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set. For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set. + */ + createReusableDelegationSet(callback?: (err: AWSError, data: Route53.Types.CreateReusableDelegationSetResponse) => void): Request; + /** + * Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). + */ + createTrafficPolicy(params: Route53.Types.CreateTrafficPolicyRequest, callback?: (err: AWSError, data: Route53.Types.CreateTrafficPolicyResponse) => void): Request; + /** + * Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). + */ + createTrafficPolicy(callback?: (err: AWSError, data: Route53.Types.CreateTrafficPolicyResponse) => void): Request; + /** + * Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created. + */ + createTrafficPolicyInstance(params: Route53.Types.CreateTrafficPolicyInstanceRequest, callback?: (err: AWSError, data: Route53.Types.CreateTrafficPolicyInstanceResponse) => void): Request; + /** + * Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created. + */ + createTrafficPolicyInstance(callback?: (err: AWSError, data: Route53.Types.CreateTrafficPolicyInstanceResponse) => void): Request; + /** + * Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy. + */ + createTrafficPolicyVersion(params: Route53.Types.CreateTrafficPolicyVersionRequest, callback?: (err: AWSError, data: Route53.Types.CreateTrafficPolicyVersionResponse) => void): Request; + /** + * Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy. + */ + createTrafficPolicyVersion(callback?: (err: AWSError, data: Route53.Types.CreateTrafficPolicyVersionResponse) => void): Request; + /** + * Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request. If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC. + */ + createVPCAssociationAuthorization(params: Route53.Types.CreateVPCAssociationAuthorizationRequest, callback?: (err: AWSError, data: Route53.Types.CreateVPCAssociationAuthorizationResponse) => void): Request; + /** + * Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request. If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC. + */ + createVPCAssociationAuthorization(callback?: (err: AWSError, data: Route53.Types.CreateVPCAssociationAuthorizationResponse) => void): Request; + /** + * Deletes a health check. Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide. + */ + deleteHealthCheck(params: Route53.Types.DeleteHealthCheckRequest, callback?: (err: AWSError, data: Route53.Types.DeleteHealthCheckResponse) => void): Request; + /** + * Deletes a health check. Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide. + */ + deleteHealthCheck(callback?: (err: AWSError, data: Route53.Types.DeleteHealthCheckResponse) => void): Request; + /** + * Deletes a hosted zone. If the hosted zone was created by another service, such as AWS Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.) If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone. If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name. If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on "free DNS service." You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets. To verify that the hosted zone has been deleted, do one of the following: Use the GetHostedZone action to request information about the hosted zone. Use the ListHostedZones action to get a list of the hosted zones associated with the current AWS account. + */ + deleteHostedZone(params: Route53.Types.DeleteHostedZoneRequest, callback?: (err: AWSError, data: Route53.Types.DeleteHostedZoneResponse) => void): Request; + /** + * Deletes a hosted zone. If the hosted zone was created by another service, such as AWS Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.) If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone. If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name. If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on "free DNS service." You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets. To verify that the hosted zone has been deleted, do one of the following: Use the GetHostedZone action to request information about the hosted zone. Use the ListHostedZones action to get a list of the hosted zones associated with the current AWS account. + */ + deleteHostedZone(callback?: (err: AWSError, data: Route53.Types.DeleteHostedZoneResponse) => void): Request; + /** + * Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs. For more information about DNS query logs, see CreateQueryLoggingConfig. + */ + deleteQueryLoggingConfig(params: Route53.Types.DeleteQueryLoggingConfigRequest, callback?: (err: AWSError, data: Route53.Types.DeleteQueryLoggingConfigResponse) => void): Request; + /** + * Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs. For more information about DNS query logs, see CreateQueryLoggingConfig. + */ + deleteQueryLoggingConfig(callback?: (err: AWSError, data: Route53.Types.DeleteQueryLoggingConfigResponse) => void): Request; + /** + * Deletes a reusable delegation set. You can delete a reusable delegation set only if it isn't associated with any hosted zones. To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete. + */ + deleteReusableDelegationSet(params: Route53.Types.DeleteReusableDelegationSetRequest, callback?: (err: AWSError, data: Route53.Types.DeleteReusableDelegationSetResponse) => void): Request; + /** + * Deletes a reusable delegation set. You can delete a reusable delegation set only if it isn't associated with any hosted zones. To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete. + */ + deleteReusableDelegationSet(callback?: (err: AWSError, data: Route53.Types.DeleteReusableDelegationSetResponse) => void): Request; + /** + * Deletes a traffic policy. + */ + deleteTrafficPolicy(params: Route53.Types.DeleteTrafficPolicyRequest, callback?: (err: AWSError, data: Route53.Types.DeleteTrafficPolicyResponse) => void): Request; + /** + * Deletes a traffic policy. + */ + deleteTrafficPolicy(callback?: (err: AWSError, data: Route53.Types.DeleteTrafficPolicyResponse) => void): Request; + /** + * Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance. In the Route 53 console, traffic policy instances are known as policy records. + */ + deleteTrafficPolicyInstance(params: Route53.Types.DeleteTrafficPolicyInstanceRequest, callback?: (err: AWSError, data: Route53.Types.DeleteTrafficPolicyInstanceResponse) => void): Request; + /** + * Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance. In the Route 53 console, traffic policy instances are known as policy records. + */ + deleteTrafficPolicyInstance(callback?: (err: AWSError, data: Route53.Types.DeleteTrafficPolicyInstanceResponse) => void): Request; + /** + * Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request. Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone. + */ + deleteVPCAssociationAuthorization(params: Route53.Types.DeleteVPCAssociationAuthorizationRequest, callback?: (err: AWSError, data: Route53.Types.DeleteVPCAssociationAuthorizationResponse) => void): Request; + /** + * Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request. Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone. + */ + deleteVPCAssociationAuthorization(callback?: (err: AWSError, data: Route53.Types.DeleteVPCAssociationAuthorizationResponse) => void): Request; + /** + * Disassociates a VPC from a Amazon Route 53 private hosted zone. Note the following: You can't disassociate the last VPC from a private hosted zone. You can't convert a private hosted zone into a public hosted zone. You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the VPC. + */ + disassociateVPCFromHostedZone(params: Route53.Types.DisassociateVPCFromHostedZoneRequest, callback?: (err: AWSError, data: Route53.Types.DisassociateVPCFromHostedZoneResponse) => void): Request; + /** + * Disassociates a VPC from a Amazon Route 53 private hosted zone. Note the following: You can't disassociate the last VPC from a private hosted zone. You can't convert a private hosted zone into a public hosted zone. You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the VPC. + */ + disassociateVPCFromHostedZone(callback?: (err: AWSError, data: Route53.Types.DisassociateVPCFromHostedZoneResponse) => void): Request; + /** + * Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. You can also view account limits in AWS Trusted Advisor. Sign in to the AWS Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane. + */ + getAccountLimit(params: Route53.Types.GetAccountLimitRequest, callback?: (err: AWSError, data: Route53.Types.GetAccountLimitResponse) => void): Request; + /** + * Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. You can also view account limits in AWS Trusted Advisor. Sign in to the AWS Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane. + */ + getAccountLimit(callback?: (err: AWSError, data: Route53.Types.GetAccountLimitResponse) => void): Request; + /** + * Returns the current status of a change batch request. The status is one of the following values: PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests. INSYNC indicates that the changes have propagated to all Route 53 DNS servers. + */ + getChange(params: Route53.Types.GetChangeRequest, callback?: (err: AWSError, data: Route53.Types.GetChangeResponse) => void): Request; + /** + * Returns the current status of a change batch request. The status is one of the following values: PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests. INSYNC indicates that the changes have propagated to all Route 53 DNS servers. + */ + getChange(callback?: (err: AWSError, data: Route53.Types.GetChangeResponse) => void): Request; + /** + * GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide. + */ + getCheckerIpRanges(params: Route53.Types.GetCheckerIpRangesRequest, callback?: (err: AWSError, data: Route53.Types.GetCheckerIpRangesResponse) => void): Request; + /** + * GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide. + */ + getCheckerIpRanges(callback?: (err: AWSError, data: Route53.Types.GetCheckerIpRangesResponse) => void): Request; + /** + * Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets. Use the following syntax to determine whether a continent is supported for geolocation: GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent Use the following syntax to determine whether a country is supported for geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code Use the following syntax to determine whether a subdivision of a country is supported for geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code + */ + getGeoLocation(params: Route53.Types.GetGeoLocationRequest, callback?: (err: AWSError, data: Route53.Types.GetGeoLocationResponse) => void): Request; + /** + * Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets. Use the following syntax to determine whether a continent is supported for geolocation: GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent Use the following syntax to determine whether a country is supported for geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code Use the following syntax to determine whether a subdivision of a country is supported for geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code + */ + getGeoLocation(callback?: (err: AWSError, data: Route53.Types.GetGeoLocationResponse) => void): Request; + /** + * Gets information about a specified health check. + */ + getHealthCheck(params: Route53.Types.GetHealthCheckRequest, callback?: (err: AWSError, data: Route53.Types.GetHealthCheckResponse) => void): Request; + /** + * Gets information about a specified health check. + */ + getHealthCheck(callback?: (err: AWSError, data: Route53.Types.GetHealthCheckResponse) => void): Request; + /** + * Retrieves the number of health checks that are associated with the current AWS account. + */ + getHealthCheckCount(params: Route53.Types.GetHealthCheckCountRequest, callback?: (err: AWSError, data: Route53.Types.GetHealthCheckCountResponse) => void): Request; + /** + * Retrieves the number of health checks that are associated with the current AWS account. + */ + getHealthCheckCount(callback?: (err: AWSError, data: Route53.Types.GetHealthCheckCountResponse) => void): Request; + /** + * Gets the reason that a specified health check failed most recently. + */ + getHealthCheckLastFailureReason(params: Route53.Types.GetHealthCheckLastFailureReasonRequest, callback?: (err: AWSError, data: Route53.Types.GetHealthCheckLastFailureReasonResponse) => void): Request; + /** + * Gets the reason that a specified health check failed most recently. + */ + getHealthCheckLastFailureReason(callback?: (err: AWSError, data: Route53.Types.GetHealthCheckLastFailureReasonResponse) => void): Request; + /** + * Gets status of a specified health check. + */ + getHealthCheckStatus(params: Route53.Types.GetHealthCheckStatusRequest, callback?: (err: AWSError, data: Route53.Types.GetHealthCheckStatusResponse) => void): Request; + /** + * Gets status of a specified health check. + */ + getHealthCheckStatus(callback?: (err: AWSError, data: Route53.Types.GetHealthCheckStatusResponse) => void): Request; + /** + * Gets information about a specified hosted zone including the four name servers assigned to the hosted zone. + */ + getHostedZone(params: Route53.Types.GetHostedZoneRequest, callback?: (err: AWSError, data: Route53.Types.GetHostedZoneResponse) => void): Request; + /** + * Gets information about a specified hosted zone including the four name servers assigned to the hosted zone. + */ + getHostedZone(callback?: (err: AWSError, data: Route53.Types.GetHostedZoneResponse) => void): Request; + /** + * Retrieves the number of hosted zones that are associated with the current AWS account. + */ + getHostedZoneCount(params: Route53.Types.GetHostedZoneCountRequest, callback?: (err: AWSError, data: Route53.Types.GetHostedZoneCountResponse) => void): Request; + /** + * Retrieves the number of hosted zones that are associated with the current AWS account. + */ + getHostedZoneCount(callback?: (err: AWSError, data: Route53.Types.GetHostedZoneCountResponse) => void): Request; + /** + * Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. + */ + getHostedZoneLimit(params: Route53.Types.GetHostedZoneLimitRequest, callback?: (err: AWSError, data: Route53.Types.GetHostedZoneLimitResponse) => void): Request; + /** + * Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. + */ + getHostedZoneLimit(callback?: (err: AWSError, data: Route53.Types.GetHostedZoneLimitResponse) => void): Request; + /** + * Gets information about a specified configuration for DNS query logging. For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries. + */ + getQueryLoggingConfig(params: Route53.Types.GetQueryLoggingConfigRequest, callback?: (err: AWSError, data: Route53.Types.GetQueryLoggingConfigResponse) => void): Request; + /** + * Gets information about a specified configuration for DNS query logging. For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries. + */ + getQueryLoggingConfig(callback?: (err: AWSError, data: Route53.Types.GetQueryLoggingConfigResponse) => void): Request; + /** + * Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set. + */ + getReusableDelegationSet(params: Route53.Types.GetReusableDelegationSetRequest, callback?: (err: AWSError, data: Route53.Types.GetReusableDelegationSetResponse) => void): Request; + /** + * Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set. + */ + getReusableDelegationSet(callback?: (err: AWSError, data: Route53.Types.GetReusableDelegationSetResponse) => void): Request; + /** + * Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. + */ + getReusableDelegationSetLimit(params: Route53.Types.GetReusableDelegationSetLimitRequest, callback?: (err: AWSError, data: Route53.Types.GetReusableDelegationSetLimitResponse) => void): Request; + /** + * Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. + */ + getReusableDelegationSetLimit(callback?: (err: AWSError, data: Route53.Types.GetReusableDelegationSetLimitResponse) => void): Request; + /** + * Gets information about a specific traffic policy version. + */ + getTrafficPolicy(params: Route53.Types.GetTrafficPolicyRequest, callback?: (err: AWSError, data: Route53.Types.GetTrafficPolicyResponse) => void): Request; + /** + * Gets information about a specific traffic policy version. + */ + getTrafficPolicy(callback?: (err: AWSError, data: Route53.Types.GetTrafficPolicyResponse) => void): Request; + /** + * Gets information about a specified traffic policy instance. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. In the Route 53 console, traffic policy instances are known as policy records. + */ + getTrafficPolicyInstance(params: Route53.Types.GetTrafficPolicyInstanceRequest, callback?: (err: AWSError, data: Route53.Types.GetTrafficPolicyInstanceResponse) => void): Request; + /** + * Gets information about a specified traffic policy instance. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. In the Route 53 console, traffic policy instances are known as policy records. + */ + getTrafficPolicyInstance(callback?: (err: AWSError, data: Route53.Types.GetTrafficPolicyInstanceResponse) => void): Request; + /** + * Gets the number of traffic policy instances that are associated with the current AWS account. + */ + getTrafficPolicyInstanceCount(params: Route53.Types.GetTrafficPolicyInstanceCountRequest, callback?: (err: AWSError, data: Route53.Types.GetTrafficPolicyInstanceCountResponse) => void): Request; + /** + * Gets the number of traffic policy instances that are associated with the current AWS account. + */ + getTrafficPolicyInstanceCount(callback?: (err: AWSError, data: Route53.Types.GetTrafficPolicyInstanceCountResponse) => void): Request; + /** + * Retrieves a list of supported geographic locations. Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country. + */ + listGeoLocations(params: Route53.Types.ListGeoLocationsRequest, callback?: (err: AWSError, data: Route53.Types.ListGeoLocationsResponse) => void): Request; + /** + * Retrieves a list of supported geographic locations. Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country. + */ + listGeoLocations(callback?: (err: AWSError, data: Route53.Types.ListGeoLocationsResponse) => void): Request; + /** + * Retrieve a list of the health checks that are associated with the current AWS account. + */ + listHealthChecks(params: Route53.Types.ListHealthChecksRequest, callback?: (err: AWSError, data: Route53.Types.ListHealthChecksResponse) => void): Request; + /** + * Retrieve a list of the health checks that are associated with the current AWS account. + */ + listHealthChecks(callback?: (err: AWSError, data: Route53.Types.ListHealthChecksResponse) => void): Request; + /** + * Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100. + */ + listHostedZones(params: Route53.Types.ListHostedZonesRequest, callback?: (err: AWSError, data: Route53.Types.ListHostedZonesResponse) => void): Request; + /** + * Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100. + */ + listHostedZones(callback?: (err: AWSError, data: Route53.Types.ListHostedZonesResponse) => void): Request; + /** + * Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account. ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example: com.example.www. Note the trailing dot, which can change the sort order in some circumstances. If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as: com.ex\344mple. The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide. Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next: The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response. The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response. If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account. If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response. The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. + */ + listHostedZonesByName(params: Route53.Types.ListHostedZonesByNameRequest, callback?: (err: AWSError, data: Route53.Types.ListHostedZonesByNameResponse) => void): Request; + /** + * Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account. ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example: com.example.www. Note the trailing dot, which can change the sort order in some circumstances. If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as: com.ex\344mple. The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide. Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next: The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response. The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response. If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account. If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response. The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. + */ + listHostedZonesByName(callback?: (err: AWSError, data: Route53.Types.ListHostedZonesByNameResponse) => void): Request; + /** + * Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone. For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide. + */ + listQueryLoggingConfigs(params: Route53.Types.ListQueryLoggingConfigsRequest, callback?: (err: AWSError, data: Route53.Types.ListQueryLoggingConfigsResponse) => void): Request; + /** + * Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone. For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide. + */ + listQueryLoggingConfigs(callback?: (err: AWSError, data: Route53.Types.ListQueryLoggingConfigsResponse) => void): Request; + /** + * Lists the resource record sets in a specified hosted zone. ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. Sort order ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example: com.example.www. Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! " # $ % & ' ( ) * + , - When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type. Specifying where to start listing records You can use the name and type elements to specify the resource record set that the list begins with: If you do not specify Name or Type The results begin with the first resource record set that the hosted zone contains. If you specify Name but not Type The results begin with the first resource record set in the list whose name is greater than or equal to Name. If you specify Type but not Name Amazon Route 53 returns the InvalidInput error. If you specify both Name and Type The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type. Resource record sets that are PENDING This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers. Changing resource record sets To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes. Displaying the next page of results If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier. + */ + listResourceRecordSets(params: Route53.Types.ListResourceRecordSetsRequest, callback?: (err: AWSError, data: Route53.Types.ListResourceRecordSetsResponse) => void): Request; + /** + * Lists the resource record sets in a specified hosted zone. ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. Sort order ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example: com.example.www. Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! " # $ % & ' ( ) * + , - When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type. Specifying where to start listing records You can use the name and type elements to specify the resource record set that the list begins with: If you do not specify Name or Type The results begin with the first resource record set that the hosted zone contains. If you specify Name but not Type The results begin with the first resource record set in the list whose name is greater than or equal to Name. If you specify Type but not Name Amazon Route 53 returns the InvalidInput error. If you specify both Name and Type The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type. Resource record sets that are PENDING This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers. Changing resource record sets To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes. Displaying the next page of results If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier. + */ + listResourceRecordSets(callback?: (err: AWSError, data: Route53.Types.ListResourceRecordSetsResponse) => void): Request; + /** + * Retrieves a list of the reusable delegation sets that are associated with the current AWS account. + */ + listReusableDelegationSets(params: Route53.Types.ListReusableDelegationSetsRequest, callback?: (err: AWSError, data: Route53.Types.ListReusableDelegationSetsResponse) => void): Request; + /** + * Retrieves a list of the reusable delegation sets that are associated with the current AWS account. + */ + listReusableDelegationSets(callback?: (err: AWSError, data: Route53.Types.ListReusableDelegationSetsResponse) => void): Request; + /** + * Lists tags for one health check or hosted zone. For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + listTagsForResource(params: Route53.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Route53.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists tags for one health check or hosted zone. For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + listTagsForResource(callback?: (err: AWSError, data: Route53.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists tags for up to 10 health checks or hosted zones. For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + listTagsForResources(params: Route53.Types.ListTagsForResourcesRequest, callback?: (err: AWSError, data: Route53.Types.ListTagsForResourcesResponse) => void): Request; + /** + * Lists tags for up to 10 health checks or hosted zones. For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + listTagsForResources(callback?: (err: AWSError, data: Route53.Types.ListTagsForResourcesResponse) => void): Request; + /** + * Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order that they were created in. + */ + listTrafficPolicies(params: Route53.Types.ListTrafficPoliciesRequest, callback?: (err: AWSError, data: Route53.Types.ListTrafficPoliciesResponse) => void): Request; + /** + * Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order that they were created in. + */ + listTrafficPolicies(callback?: (err: AWSError, data: Route53.Types.ListTrafficPoliciesResponse) => void): Request; + /** + * Gets information about the traffic policy instances that you created by using the current AWS account. After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. + */ + listTrafficPolicyInstances(params: Route53.Types.ListTrafficPolicyInstancesRequest, callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyInstancesResponse) => void): Request; + /** + * Gets information about the traffic policy instances that you created by using the current AWS account. After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. + */ + listTrafficPolicyInstances(callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyInstancesResponse) => void): Request; + /** + * Gets information about the traffic policy instances that you created in a specified hosted zone. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. + */ + listTrafficPolicyInstancesByHostedZone(params: Route53.Types.ListTrafficPolicyInstancesByHostedZoneRequest, callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyInstancesByHostedZoneResponse) => void): Request; + /** + * Gets information about the traffic policy instances that you created in a specified hosted zone. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. + */ + listTrafficPolicyInstancesByHostedZone(callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyInstancesByHostedZoneResponse) => void): Request; + /** + * Gets information about the traffic policy instances that you created by using a specify traffic policy version. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. + */ + listTrafficPolicyInstancesByPolicy(params: Route53.Types.ListTrafficPolicyInstancesByPolicyRequest, callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyInstancesByPolicyResponse) => void): Request; + /** + * Gets information about the traffic policy instances that you created by using a specify traffic policy version. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. + */ + listTrafficPolicyInstancesByPolicy(callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyInstancesByPolicyResponse) => void): Request; + /** + * Gets information about all of the versions for a specified traffic policy. Traffic policy versions are listed in numerical order by VersionNumber. + */ + listTrafficPolicyVersions(params: Route53.Types.ListTrafficPolicyVersionsRequest, callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyVersionsResponse) => void): Request; + /** + * Gets information about all of the versions for a specified traffic policy. Traffic policy versions are listed in numerical order by VersionNumber. + */ + listTrafficPolicyVersions(callback?: (err: AWSError, data: Route53.Types.ListTrafficPolicyVersionsResponse) => void): Request; + /** + * Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests. The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone. + */ + listVPCAssociationAuthorizations(params: Route53.Types.ListVPCAssociationAuthorizationsRequest, callback?: (err: AWSError, data: Route53.Types.ListVPCAssociationAuthorizationsResponse) => void): Request; + /** + * Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests. The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone. + */ + listVPCAssociationAuthorizations(callback?: (err: AWSError, data: Route53.Types.ListVPCAssociationAuthorizationsResponse) => void): Request; + /** + * Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. + */ + testDNSAnswer(params: Route53.Types.TestDNSAnswerRequest, callback?: (err: AWSError, data: Route53.Types.TestDNSAnswerResponse) => void): Request; + /** + * Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. + */ + testDNSAnswer(callback?: (err: AWSError, data: Route53.Types.TestDNSAnswerResponse) => void): Request; + /** + * Updates an existing health check. Note that some values can't be updated. For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide. + */ + updateHealthCheck(params: Route53.Types.UpdateHealthCheckRequest, callback?: (err: AWSError, data: Route53.Types.UpdateHealthCheckResponse) => void): Request; + /** + * Updates an existing health check. Note that some values can't be updated. For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide. + */ + updateHealthCheck(callback?: (err: AWSError, data: Route53.Types.UpdateHealthCheckResponse) => void): Request; + /** + * Updates the comment for a specified hosted zone. + */ + updateHostedZoneComment(params: Route53.Types.UpdateHostedZoneCommentRequest, callback?: (err: AWSError, data: Route53.Types.UpdateHostedZoneCommentResponse) => void): Request; + /** + * Updates the comment for a specified hosted zone. + */ + updateHostedZoneComment(callback?: (err: AWSError, data: Route53.Types.UpdateHostedZoneCommentResponse) => void): Request; + /** + * Updates the comment for a specified traffic policy version. + */ + updateTrafficPolicyComment(params: Route53.Types.UpdateTrafficPolicyCommentRequest, callback?: (err: AWSError, data: Route53.Types.UpdateTrafficPolicyCommentResponse) => void): Request; + /** + * Updates the comment for a specified traffic policy version. + */ + updateTrafficPolicyComment(callback?: (err: AWSError, data: Route53.Types.UpdateTrafficPolicyCommentResponse) => void): Request; + /** + * Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version. When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations: Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets. When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets. Route 53 deletes the old group of resource record sets that are associated with the root resource record set name. + */ + updateTrafficPolicyInstance(params: Route53.Types.UpdateTrafficPolicyInstanceRequest, callback?: (err: AWSError, data: Route53.Types.UpdateTrafficPolicyInstanceResponse) => void): Request; + /** + * Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version. When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations: Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets. When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets. Route 53 deletes the old group of resource record sets that are associated with the root resource record set name. + */ + updateTrafficPolicyInstance(callback?: (err: AWSError, data: Route53.Types.UpdateTrafficPolicyInstanceResponse) => void): Request; + /** + * Waits for the resourceRecordSetsChanged state by periodically calling the underlying Route53.getChangeoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "resourceRecordSetsChanged", params: Route53.Types.GetChangeRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Route53.Types.GetChangeResponse) => void): Request; + /** + * Waits for the resourceRecordSetsChanged state by periodically calling the underlying Route53.getChangeoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "resourceRecordSetsChanged", callback?: (err: AWSError, data: Route53.Types.GetChangeResponse) => void): Request; +} +declare namespace Route53 { + export interface AccountLimit { + /** + * The limit that you requested. Valid values include the following: MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account. MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account. MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account. MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account. MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.) + */ + Type: AccountLimitType; + /** + * The current value for the limit that is specified by Type. + */ + Value: LimitValue; + } + export type AccountLimitType = "MAX_HEALTH_CHECKS_BY_OWNER"|"MAX_HOSTED_ZONES_BY_OWNER"|"MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER"|"MAX_REUSABLE_DELEGATION_SETS_BY_OWNER"|"MAX_TRAFFIC_POLICIES_BY_OWNER"|string; + export interface AlarmIdentifier { + /** + * For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference. + */ + Region: CloudWatchRegion; + /** + * The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. Route 53 supports CloudWatch alarms with the following features: Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide. Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported. + */ + Name: AlarmName; + } + export type AlarmName = string; + export type AliasHealthEnabled = boolean; + export interface AliasTarget { + /** + * Alias resource records sets only: The value used depends on where you want to route traffic: Amazon API Gateway custom regional APIs and edge-optimized APIs Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names: For regional APIs, specify the value of regionalHostedZoneId. For edge-optimized APIs, specify the value of distributionHostedZoneId. Amazon Virtual Private Cloud interface VPC endpoint Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints. CloudFront distribution Specify Z2FDTNDATAQYW2. Alias resource record sets for CloudFront can't be created in a private zone. Elastic Beanstalk environment Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference. ELB load balancer Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: Elastic Load Balancing table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide: Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId. Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId. AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide: Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId. Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId. An Amazon S3 bucket configured as a static website Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference. Another Route 53 resource record set in your hosted zone Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.) + */ + HostedZoneId: ResourceId; + /** + * Alias resource record sets only: The value that you specify depends on where you want to route queries: Amazon API Gateway custom regional APIs and edge-optimized APIs Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names: For regional APIs, specify the value of regionalDomainName. For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net. The name of the record that you're creating must match a custom domain name for your API, such as api.example.com. Amazon Virtual Private Cloud interface VPC endpoint Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints. CloudFront distribution Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide. You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution. For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. Elastic Beanstalk environment If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name. For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment. For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute: AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide. Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference. AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS Command Line Interface Reference. ELB load balancer Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide: Classic Load Balancers: DescribeLoadBalancers Application and Network Load Balancers: DescribeLoadBalancers AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide: Classic Load Balancers: describe-load-balancers Application and Network Load Balancers: describe-load-balancers Amazon S3 bucket that is configured as a static website Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide. Another Route 53 resource record set Specify the value of the Name element for a resource record set in the current hosted zone. If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. + */ + DNSName: DNSName; + /** + * Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone. Note the following: CloudFront distributions You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution. Elastic Beanstalk environments that have regionalized subdomains If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. If the environment contains a single Amazon EC2 instance, there are no special requirements. ELB load balancers Health checking behavior depends on the type of load balancer: Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. A target group that has no registered targets is considered unhealthy. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. S3 buckets There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket. Other records in the same hosted zone If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide. For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide. + */ + EvaluateTargetHealth: AliasHealthEnabled; + } + export type AssociateVPCComment = string; + export interface AssociateVPCWithHostedZoneRequest { + /** + * The ID of the private hosted zone that you want to associate an Amazon VPC with. Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association. + */ + HostedZoneId: ResourceId; + /** + * A complex type that contains information about the VPC that you want to associate with a private hosted zone. + */ + VPC: VPC; + /** + * Optional: A comment about the association request. + */ + Comment?: AssociateVPCComment; + } + export interface AssociateVPCWithHostedZoneResponse { + /** + * A complex type that describes the changes made to your hosted zone. + */ + ChangeInfo: ChangeInfo; + } + export interface Change { + /** + * The action to perform: CREATE: Creates a resource record set that has the specified values. DELETE: Deletes a existing resource record set. To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. UPSERT: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request. + */ + Action: ChangeAction; + /** + * Information about the resource record set to create, delete, or update. + */ + ResourceRecordSet: ResourceRecordSet; + } + export type ChangeAction = "CREATE"|"DELETE"|"UPSERT"|string; + export interface ChangeBatch { + /** + * Optional: Any comments you want to include about a change batch request. + */ + Comment?: ResourceDescription; + /** + * Information about the changes to make to the record sets. + */ + Changes: Changes; + } + export interface ChangeInfo { + /** + * The ID of the request. + */ + Id: ResourceId; + /** + * The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. + */ + Status: ChangeStatus; + /** + * The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC. + */ + SubmittedAt: TimeStamp; + /** + * A complex type that describes change information about changes made to your hosted zone. This element contains an ID that you use when performing a GetChange action to get detailed information about the change. + */ + Comment?: ResourceDescription; + } + export interface ChangeResourceRecordSetsRequest { + /** + * The ID of the hosted zone that contains the resource record sets that you want to change. + */ + HostedZoneId: ResourceId; + /** + * A complex type that contains an optional comment and the Changes element. + */ + ChangeBatch: ChangeBatch; + } + export interface ChangeResourceRecordSetsResponse { + /** + * A complex type that contains information about changes made to your hosted zone. This element contains an ID that you use when performing a GetChange action to get detailed information about the change. + */ + ChangeInfo: ChangeInfo; + } + export type ChangeStatus = "PENDING"|"INSYNC"|string; + export interface ChangeTagsForResourceRequest { + /** + * The type of the resource. The resource type for health checks is healthcheck. The resource type for hosted zones is hostedzone. + */ + ResourceType: TagResourceType; + /** + * The ID of the resource for which you want to add, change, or delete tags. + */ + ResourceId: TagResourceId; + /** + * A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit Value for. You can add a maximum of 10 tags to a health check or a hosted zone. + */ + AddTags?: TagList; + /** + * A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys. + */ + RemoveTagKeys?: TagKeyList; + } + export interface ChangeTagsForResourceResponse { + } + export type Changes = Change[]; + export type CheckerIpRanges = IPAddressCidr[]; + export type ChildHealthCheckList = HealthCheckId[]; + export interface CloudWatchAlarmConfiguration { + /** + * For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold. + */ + EvaluationPeriods: EvaluationPeriods; + /** + * For the metric that the CloudWatch alarm is associated with, the value the metric is compared with. + */ + Threshold: Threshold; + /** + * For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison. + */ + ComparisonOperator: ComparisonOperator; + /** + * For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds. + */ + Period: Period; + /** + * The name of the CloudWatch metric that the alarm is associated with. + */ + MetricName: MetricName; + /** + * The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide. + */ + Namespace: Namespace; + /** + * For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric. + */ + Statistic: Statistic; + /** + * For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide. + */ + Dimensions?: DimensionList; + } + export type CloudWatchLogsLogGroupArn = string; + export type CloudWatchRegion = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"ca-central-1"|"eu-central-1"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"ap-east-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"eu-north-1"|"sa-east-1"|"cn-northwest-1"|"cn-north-1"|string; + export type ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|string; + export interface CreateHealthCheckRequest { + /** + * A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks: If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check. If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error. If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error. If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check. + */ + CallerReference: HealthCheckNonce; + /** + * A complex type that contains settings for a new health check. + */ + HealthCheckConfig: HealthCheckConfig; + } + export interface CreateHealthCheckResponse { + /** + * A complex type that contains identifying information about the health check. + */ + HealthCheck: HealthCheck; + /** + * The unique URL representing the new health check. + */ + Location: ResourceURI; + } + export interface CreateHostedZoneRequest { + /** + * The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet. + */ + Name: DNSName; + /** + * (Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone. You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone. + */ + VPC?: VPC; + /** + * A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp. + */ + CallerReference: Nonce; + /** + * (Optional) A complex type that contains the following optional values: For public and private hosted zones, an optional comment For private hosted zones, an optional PrivateZone element If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements. + */ + HostedZoneConfig?: HostedZoneConfig; + /** + * If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet. + */ + DelegationSetId?: ResourceId; + } + export interface CreateHostedZoneResponse { + /** + * A complex type that contains general information about the hosted zone. + */ + HostedZone: HostedZone; + /** + * A complex type that contains information about the CreateHostedZone request. + */ + ChangeInfo: ChangeInfo; + /** + * A complex type that describes the name servers for this hosted zone. + */ + DelegationSet: DelegationSet; + /** + * A complex type that contains information about an Amazon VPC that you associated with this hosted zone. + */ + VPC?: VPC; + /** + * The unique URL representing the new hosted zone. + */ + Location: ResourceURI; + } + export interface CreateQueryLoggingConfigRequest { + /** + * The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones. + */ + HostedZoneId: ResourceId; + /** + * The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN: arn:aws:logs:region:account-id:log-group:log_group_name To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the AWS SDKs. + */ + CloudWatchLogsLogGroupArn: CloudWatchLogsLogGroupArn; + } + export interface CreateQueryLoggingConfigResponse { + /** + * A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to. + */ + QueryLoggingConfig: QueryLoggingConfig; + /** + * The unique URL representing the new query logging configuration. + */ + Location: ResourceURI; + } + export interface CreateReusableDelegationSetRequest { + /** + * A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a date/time stamp. + */ + CallerReference: Nonce; + /** + * If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. + */ + HostedZoneId?: ResourceId; + } + export interface CreateReusableDelegationSetResponse { + /** + * A complex type that contains name server information. + */ + DelegationSet: DelegationSet; + /** + * The unique URL representing the new reusable delegation set. + */ + Location: ResourceURI; + } + export interface CreateTrafficPolicyInstanceRequest { + /** + * The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy. + */ + HostedZoneId: ResourceId; + /** + * The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance. + */ + Name: DNSName; + /** + * (Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone. + */ + TTL: TTL; + /** + * The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone. + */ + TrafficPolicyId: TrafficPolicyId; + /** + * The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone. + */ + TrafficPolicyVersion: TrafficPolicyVersion; + } + export interface CreateTrafficPolicyInstanceResponse { + /** + * A complex type that contains settings for the new traffic policy instance. + */ + TrafficPolicyInstance: TrafficPolicyInstance; + /** + * A unique URL that represents a new traffic policy instance. + */ + Location: ResourceURI; + } + export interface CreateTrafficPolicyRequest { + /** + * The name of the traffic policy. + */ + Name: TrafficPolicyName; + /** + * The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format. + */ + Document: TrafficPolicyDocument; + /** + * (Optional) Any comments that you want to include about the traffic policy. + */ + Comment?: TrafficPolicyComment; + } + export interface CreateTrafficPolicyResponse { + /** + * A complex type that contains settings for the new traffic policy. + */ + TrafficPolicy: TrafficPolicy; + /** + * A unique URL that represents a new traffic policy. + */ + Location: ResourceURI; + } + export interface CreateTrafficPolicyVersionRequest { + /** + * The ID of the traffic policy for which you want to create a new version. + */ + Id: TrafficPolicyId; + /** + * The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy. + */ + Document: TrafficPolicyDocument; + /** + * The comment that you specified in the CreateTrafficPolicyVersion request, if any. + */ + Comment?: TrafficPolicyComment; + } + export interface CreateTrafficPolicyVersionResponse { + /** + * A complex type that contains settings for the new version of the traffic policy. + */ + TrafficPolicy: TrafficPolicy; + /** + * A unique URL that represents a new traffic policy version. + */ + Location: ResourceURI; + } + export interface CreateVPCAssociationAuthorizationRequest { + /** + * The ID of the private hosted zone that you want to authorize associating a VPC with. + */ + HostedZoneId: ResourceId; + /** + * A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone. + */ + VPC: VPC; + } + export interface CreateVPCAssociationAuthorizationResponse { + /** + * The ID of the hosted zone that you authorized associating a VPC with. + */ + HostedZoneId: ResourceId; + /** + * The VPC that you authorized associating with a hosted zone. + */ + VPC: VPC; + } + export type DNSName = string; + export type DNSRCode = string; + export interface DelegationSet { + /** + * The ID that Amazon Route 53 assigns to a reusable delegation set. + */ + Id?: ResourceId; + /** + * The value that you specified for CallerReference when you created the reusable delegation set. + */ + CallerReference?: Nonce; + /** + * A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set. + */ + NameServers: DelegationSetNameServers; + } + export type DelegationSetNameServers = DNSName[]; + export type DelegationSets = DelegationSet[]; + export interface DeleteHealthCheckRequest { + /** + * The ID of the health check that you want to delete. + */ + HealthCheckId: HealthCheckId; + } + export interface DeleteHealthCheckResponse { + } + export interface DeleteHostedZoneRequest { + /** + * The ID of the hosted zone you want to delete. + */ + Id: ResourceId; + } + export interface DeleteHostedZoneResponse { + /** + * A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone. + */ + ChangeInfo: ChangeInfo; + } + export interface DeleteQueryLoggingConfigRequest { + /** + * The ID of the configuration that you want to delete. + */ + Id: QueryLoggingConfigId; + } + export interface DeleteQueryLoggingConfigResponse { + } + export interface DeleteReusableDelegationSetRequest { + /** + * The ID of the reusable delegation set that you want to delete. + */ + Id: ResourceId; + } + export interface DeleteReusableDelegationSetResponse { + } + export interface DeleteTrafficPolicyInstanceRequest { + /** + * The ID of the traffic policy instance that you want to delete. When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance. + */ + Id: TrafficPolicyInstanceId; + } + export interface DeleteTrafficPolicyInstanceResponse { + } + export interface DeleteTrafficPolicyRequest { + /** + * The ID of the traffic policy that you want to delete. + */ + Id: TrafficPolicyId; + /** + * The version number of the traffic policy that you want to delete. + */ + Version: TrafficPolicyVersion; + } + export interface DeleteTrafficPolicyResponse { + } + export interface DeleteVPCAssociationAuthorizationRequest { + /** + * When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone. + */ + HostedZoneId: ResourceId; + /** + * When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC. + */ + VPC: VPC; + } + export interface DeleteVPCAssociationAuthorizationResponse { + } + export interface Dimension { + /** + * For the metric that the CloudWatch alarm is associated with, the name of one dimension. + */ + Name: DimensionField; + /** + * For the metric that the CloudWatch alarm is associated with, the value of one dimension. + */ + Value: DimensionField; + } + export type DimensionField = string; + export type DimensionList = Dimension[]; + export type Disabled = boolean; + export type DisassociateVPCComment = string; + export interface DisassociateVPCFromHostedZoneRequest { + /** + * The ID of the private hosted zone that you want to disassociate a VPC from. + */ + HostedZoneId: ResourceId; + /** + * A complex type that contains information about the VPC that you're disassociating from the specified hosted zone. + */ + VPC: VPC; + /** + * Optional: A comment about the disassociation request. + */ + Comment?: DisassociateVPCComment; + } + export interface DisassociateVPCFromHostedZoneResponse { + /** + * A complex type that describes the changes made to the specified private hosted zone. + */ + ChangeInfo: ChangeInfo; + } + export type EnableSNI = boolean; + export type EvaluationPeriods = number; + export type FailureThreshold = number; + export type FullyQualifiedDomainName = string; + export interface GeoLocation { + /** + * The two-letter code for the continent. Valid values: AF | AN | AS | EU | OC | NA | SA Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error. + */ + ContinentCode?: GeoLocationContinentCode; + /** + * The two-letter code for the country. + */ + CountryCode?: GeoLocationCountryCode; + /** + * The code for the subdivision. Route 53 currently supports only states in the United States. + */ + SubdivisionCode?: GeoLocationSubdivisionCode; + } + export type GeoLocationContinentCode = string; + export type GeoLocationContinentName = string; + export type GeoLocationCountryCode = string; + export type GeoLocationCountryName = string; + export interface GeoLocationDetails { + /** + * The two-letter code for the continent. + */ + ContinentCode?: GeoLocationContinentCode; + /** + * The full name of the continent. + */ + ContinentName?: GeoLocationContinentName; + /** + * The two-letter code for the country. + */ + CountryCode?: GeoLocationCountryCode; + /** + * The name of the country. + */ + CountryName?: GeoLocationCountryName; + /** + * The code for the subdivision. Route 53 currently supports only states in the United States. + */ + SubdivisionCode?: GeoLocationSubdivisionCode; + /** + * The full name of the subdivision. Route 53 currently supports only states in the United States. + */ + SubdivisionName?: GeoLocationSubdivisionName; + } + export type GeoLocationDetailsList = GeoLocationDetails[]; + export type GeoLocationSubdivisionCode = string; + export type GeoLocationSubdivisionName = string; + export interface GetAccountLimitRequest { + /** + * The limit that you want to get. Valid values include the following: MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account. MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account. MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account. MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account. MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.) + */ + Type: AccountLimitType; + } + export interface GetAccountLimitResponse { + /** + * The current setting for the specified limit. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Limit is the maximum number of health checks that you can create using the current account. + */ + Limit: AccountLimit; + /** + * The current number of entities that you have created of the specified type. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Count is the current number of health checks that you have created using the current account. + */ + Count: UsageCount; + } + export interface GetChangeRequest { + /** + * The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request. + */ + Id: ResourceId; + } + export interface GetChangeResponse { + /** + * A complex type that contains information about the specified change batch. + */ + ChangeInfo: ChangeInfo; + } + export interface GetCheckerIpRangesRequest { + } + export interface GetCheckerIpRangesResponse { + /** + * A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers. + */ + CheckerIpRanges: CheckerIpRanges; + } + export interface GetGeoLocationRequest { + /** + * Amazon Route 53 supports the following continent codes: AF: Africa AN: Antarctica AS: Asia EU: Europe OC: Oceania NA: North America SA: South America + */ + ContinentCode?: GeoLocationContinentCode; + /** + * Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2. + */ + CountryCode?: GeoLocationCountryCode; + /** + * Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in ISO standard 3166-1 alpha-2. Route 53 doesn't support subdivision codes for all countries. If you specify subdivisioncode, you must also specify countrycode. + */ + SubdivisionCode?: GeoLocationSubdivisionCode; + } + export interface GetGeoLocationResponse { + /** + * A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code. + */ + GeoLocationDetails: GeoLocationDetails; + } + export interface GetHealthCheckCountRequest { + } + export interface GetHealthCheckCountResponse { + /** + * The number of health checks associated with the current AWS account. + */ + HealthCheckCount: HealthCheckCount; + } + export interface GetHealthCheckLastFailureReasonRequest { + /** + * The ID for the health check for which you want the last failure reason. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element. If you want to get the last failure reason for a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckLastFailureReason for a calculated health check. + */ + HealthCheckId: HealthCheckId; + } + export interface GetHealthCheckLastFailureReasonResponse { + /** + * A list that contains one Observation element for each Amazon Route 53 health checker that is reporting a last failure reason. + */ + HealthCheckObservations: HealthCheckObservations; + } + export interface GetHealthCheckRequest { + /** + * The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. + */ + HealthCheckId: HealthCheckId; + } + export interface GetHealthCheckResponse { + /** + * A complex type that contains information about one health check that is associated with the current AWS account. + */ + HealthCheck: HealthCheck; + } + export interface GetHealthCheckStatusRequest { + /** + * The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element. If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check. + */ + HealthCheckId: HealthCheckId; + } + export interface GetHealthCheckStatusResponse { + /** + * A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint. + */ + HealthCheckObservations: HealthCheckObservations; + } + export interface GetHostedZoneCountRequest { + } + export interface GetHostedZoneCountResponse { + /** + * The total number of public and private hosted zones that are associated with the current AWS account. + */ + HostedZoneCount: HostedZoneCount; + } + export interface GetHostedZoneLimitRequest { + /** + * The limit that you want to get. Valid values include the following: MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone. MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone. + */ + Type: HostedZoneLimitType; + /** + * The ID of the hosted zone that you want to get a limit for. + */ + HostedZoneId: ResourceId; + } + export interface GetHostedZoneLimitResponse { + /** + * The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Limit is the maximum number of records that you can create in the specified hosted zone. + */ + Limit: HostedZoneLimit; + /** + * The current number of entities that you have created of the specified type. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count is the current number of records that you have created in the specified hosted zone. + */ + Count: UsageCount; + } + export interface GetHostedZoneRequest { + /** + * The ID of the hosted zone that you want to get information about. + */ + Id: ResourceId; + } + export interface GetHostedZoneResponse { + /** + * A complex type that contains general information about the specified hosted zone. + */ + HostedZone: HostedZone; + /** + * A complex type that lists the Amazon Route 53 name servers for the specified hosted zone. + */ + DelegationSet?: DelegationSet; + /** + * A complex type that contains information about the VPCs that are associated with the specified hosted zone. + */ + VPCs?: VPCs; + } + export interface GetQueryLoggingConfigRequest { + /** + * The ID of the configuration for DNS query logging that you want to get information about. + */ + Id: QueryLoggingConfigId; + } + export interface GetQueryLoggingConfigResponse { + /** + * A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request. + */ + QueryLoggingConfig: QueryLoggingConfig; + } + export interface GetReusableDelegationSetLimitRequest { + /** + * Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of hosted zones that you can associate with the specified reusable delegation set. + */ + Type: ReusableDelegationSetLimitType; + /** + * The ID of the delegation set that you want to get the limit for. + */ + DelegationSetId: ResourceId; + } + export interface GetReusableDelegationSetLimitResponse { + /** + * The current setting for the limit on hosted zones that you can associate with the specified reusable delegation set. + */ + Limit: ReusableDelegationSetLimit; + /** + * The current number of hosted zones that you can associate with the specified reusable delegation set. + */ + Count: UsageCount; + } + export interface GetReusableDelegationSetRequest { + /** + * The ID of the reusable delegation set that you want to get a list of name servers for. + */ + Id: ResourceId; + } + export interface GetReusableDelegationSetResponse { + /** + * A complex type that contains information about the reusable delegation set. + */ + DelegationSet: DelegationSet; + } + export interface GetTrafficPolicyInstanceCountRequest { + } + export interface GetTrafficPolicyInstanceCountResponse { + /** + * The number of traffic policy instances that are associated with the current AWS account. + */ + TrafficPolicyInstanceCount: TrafficPolicyInstanceCount; + } + export interface GetTrafficPolicyInstanceRequest { + /** + * The ID of the traffic policy instance that you want to get information about. + */ + Id: TrafficPolicyInstanceId; + } + export interface GetTrafficPolicyInstanceResponse { + /** + * A complex type that contains settings for the traffic policy instance. + */ + TrafficPolicyInstance: TrafficPolicyInstance; + } + export interface GetTrafficPolicyRequest { + /** + * The ID of the traffic policy that you want to get information about. + */ + Id: TrafficPolicyId; + /** + * The version number of the traffic policy that you want to get information about. + */ + Version: TrafficPolicyVersion; + } + export interface GetTrafficPolicyResponse { + /** + * A complex type that contains settings for the specified traffic policy. + */ + TrafficPolicy: TrafficPolicy; + } + export interface HealthCheck { + /** + * The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. + */ + Id: HealthCheckId; + /** + * A unique string that you specified when you created the health check. + */ + CallerReference: HealthCheckNonce; + /** + * If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53. + */ + LinkedService?: LinkedService; + /** + * A complex type that contains detailed information about one health check. + */ + HealthCheckConfig: HealthCheckConfig; + /** + * The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check. + */ + HealthCheckVersion: HealthCheckVersion; + /** + * A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check. + */ + CloudWatchAlarmConfiguration?: CloudWatchAlarmConfiguration; + } + export interface HealthCheckConfig { + /** + * The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint. Use one of the following formats for the value of IPAddress: IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44. IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345. If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change. For more information, see FullyQualifiedDomainName. Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: RFC 5735, Special Use IPv4 Addresses RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space RFC 5156, Special-Use IPv6 Addresses When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress. + */ + IPAddress?: IPAddress; + /** + * The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress. + */ + Port?: Port; + /** + * The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy. You can't change the value of Type after you create a health check. You can create the following types of health checks: HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later. HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString. HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString. TCP: Route 53 tries to establish a TCP connection. CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus. CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide. + */ + Type: HealthCheckType; + /** + * The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y. + */ + ResourcePath?: ResourcePath; + /** + * Amazon Route 53 behavior depends on whether you specify a value for IPAddress. If you specify a value for IPAddress: Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. When Route 53 checks the health of an endpoint, here is how it constructs the Host header: If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header. If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases. If you don't specify a value for IPAddress : Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint. If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error. If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com). In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable. In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header. + */ + FullyQualifiedDomainName?: FullyQualifiedDomainName; + /** + * If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. Route 53 considers case when searching for SearchString in the response body. + */ + SearchString?: SearchString; + /** + * The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval. You can't change the value of RequestInterval after you create a health check. If you don't specify a value for RequestInterval, the default value is 30 seconds. + */ + RequestInterval?: RequestInterval; + /** + * The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide. If you don't specify a value for FailureThreshold, the default value is three health checks. + */ + FailureThreshold?: FailureThreshold; + /** + * Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console. You can't change the value of MeasureLatency after you create a health check. + */ + MeasureLatency?: MeasureLatency; + /** + * Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. + */ + Inverted?: Inverted; + /** + * Stops Route 53 from performing health checks. When you disable a health check, here's what happens: Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource. Calculated health checks: Route 53 stops aggregating the status of the referenced health checks. Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics. After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted. Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing. + */ + Disabled?: Disabled; + /** + * The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks element. Note the following: If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy. If you specify 0, Route 53 always considers this health check to be healthy. + */ + HealthThreshold?: HealthThreshold; + /** + * (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check. + */ + ChildHealthChecks?: ChildHealthCheckList; + /** + * Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate. Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message. + */ + EnableSNI?: EnableSNI; + /** + * A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint. If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values. If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions). + */ + Regions?: HealthCheckRegionList; + /** + * A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. + */ + AlarmIdentifier?: AlarmIdentifier; + /** + * When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: Healthy: Route 53 considers the health check to be healthy. Unhealthy: Route 53 considers the health check to be unhealthy. LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. + */ + InsufficientDataHealthStatus?: InsufficientDataHealthStatus; + } + export type HealthCheckCount = number; + export type HealthCheckId = string; + export type HealthCheckNonce = string; + export interface HealthCheckObservation { + /** + * The region of the Amazon Route 53 health checker that provided the status in StatusReport. + */ + Region?: HealthCheckRegion; + /** + * The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport. + */ + IPAddress?: IPAddress; + /** + * A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check. + */ + StatusReport?: StatusReport; + } + export type HealthCheckObservations = HealthCheckObservation[]; + export type HealthCheckRegion = "us-east-1"|"us-west-1"|"us-west-2"|"eu-west-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"sa-east-1"|string; + export type HealthCheckRegionList = HealthCheckRegion[]; + export type HealthCheckType = "HTTP"|"HTTPS"|"HTTP_STR_MATCH"|"HTTPS_STR_MATCH"|"TCP"|"CALCULATED"|"CLOUDWATCH_METRIC"|string; + export type HealthCheckVersion = number; + export type HealthChecks = HealthCheck[]; + export type HealthThreshold = number; + export interface HostedZone { + /** + * The ID that Amazon Route 53 assigned to the hosted zone when you created it. + */ + Id: ResourceId; + /** + * The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar. For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone. + */ + Name: DNSName; + /** + * The value that you specified for CallerReference when you created the hosted zone. + */ + CallerReference: Nonce; + /** + * A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response. + */ + Config?: HostedZoneConfig; + /** + * The number of resource record sets in the hosted zone. + */ + ResourceRecordSetCount?: HostedZoneRRSetCount; + /** + * If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53. + */ + LinkedService?: LinkedService; + } + export interface HostedZoneConfig { + /** + * Any comments that you want to include about the hosted zone. + */ + Comment?: ResourceDescription; + /** + * A value that indicates whether this is a private hosted zone. + */ + PrivateZone?: IsPrivateZone; + } + export type HostedZoneCount = number; + export interface HostedZoneLimit { + /** + * The limit that you requested. Valid values include the following: MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone. MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone. + */ + Type: HostedZoneLimitType; + /** + * The current value for the limit that is specified by Type. + */ + Value: LimitValue; + } + export type HostedZoneLimitType = "MAX_RRSETS_BY_ZONE"|"MAX_VPCS_ASSOCIATED_BY_ZONE"|string; + export type HostedZoneRRSetCount = number; + export type HostedZones = HostedZone[]; + export type IPAddress = string; + export type IPAddressCidr = string; + export type InsufficientDataHealthStatus = "Healthy"|"Unhealthy"|"LastKnownStatus"|string; + export type Inverted = boolean; + export type IsPrivateZone = boolean; + export type LimitValue = number; + export interface LinkedService { + /** + * If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. + */ + ServicePrincipal?: ServicePrincipal; + /** + * If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. + */ + Description?: ResourceDescription; + } + export interface ListGeoLocationsRequest { + /** + * The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in startcontinentcode to return the next page of results. Include startcontinentcode only if you want to list continents. Don't include startcontinentcode when you're listing countries or countries with their subdivisions. + */ + StartContinentCode?: GeoLocationContinentCode; + /** + * The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results. Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2. + */ + StartCountryCode?: GeoLocationCountryCode; + /** + * The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode to return the next page of results. To list subdivisions of a country, you must include both startcountrycode and startsubdivisioncode. + */ + StartSubdivisionCode?: GeoLocationSubdivisionCode; + /** + * (Optional) The maximum number of geolocations to be included in the response body for this request. If more than maxitems geolocations remain to be listed, then the value of the IsTruncated element in the response is true. + */ + MaxItems?: PageMaxItems; + } + export interface ListGeoLocationsResponse { + /** + * A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation. + */ + GeoLocationDetailsList: GeoLocationDetailsList; + /** + * A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, NextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and startsubdivisioncode, as applicable. + */ + IsTruncated: PageTruncated; + /** + * If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the startcontinentcode parameter in another ListGeoLocations request. + */ + NextContinentCode?: GeoLocationContinentCode; + /** + * If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the startcountrycode parameter in another ListGeoLocations request. + */ + NextCountryCode?: GeoLocationCountryCode; + /** + * If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request. + */ + NextSubdivisionCode?: GeoLocationSubdivisionCode; + /** + * The value that you specified for MaxItems in the request. + */ + MaxItems: PageMaxItems; + } + export interface ListHealthChecksRequest { + /** + * If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request. For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false, there are no more health checks to get. + */ + Marker?: PageMarker; + /** + * The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks. + */ + MaxItems?: PageMaxItems; + } + export interface ListHealthChecksResponse { + /** + * A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account. + */ + HealthChecks: HealthChecks; + /** + * For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request. + */ + Marker: PageMarker; + /** + * A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter. + */ + IsTruncated: PageTruncated; + /** + * If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter. + */ + NextMarker?: PageMarker; + /** + * The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListHostedZonesByNameRequest { + /** + * (Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response. + */ + DNSName?: DNSName; + /** + * (Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter. If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response. + */ + HostedZoneId?: ResourceId; + /** + * The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones. + */ + MaxItems?: PageMaxItems; + } + export interface ListHostedZonesByNameResponse { + /** + * A complex type that contains general information about the hosted zone. + */ + HostedZones: HostedZones; + /** + * For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response. + */ + DNSName?: DNSName; + /** + * The ID that Amazon Route 53 assigned to the hosted zone when you created it. + */ + HostedZoneId?: ResourceId; + /** + * A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters. + */ + IsTruncated: PageTruncated; + /** + * If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. This element is present only if IsTruncated is true. + */ + NextDNSName?: DNSName; + /** + * If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. This element is present only if IsTruncated is true. + */ + NextHostedZoneId?: ResourceId; + /** + * The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListHostedZonesRequest { + /** + * If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request. For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false, there are no more hosted zones to get. + */ + Marker?: PageMarker; + /** + * (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request. + */ + MaxItems?: PageMaxItems; + /** + * If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set. + */ + DelegationSetId?: ResourceId; + } + export interface ListHostedZonesResponse { + /** + * A complex type that contains general information about the hosted zone. + */ + HostedZones: HostedZones; + /** + * For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response. + */ + Marker: PageMarker; + /** + * A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter. + */ + IsTruncated: PageTruncated; + /** + * If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter. This element is present only if IsTruncated is true. + */ + NextMarker?: PageMarker; + /** + * The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListQueryLoggingConfigsRequest { + /** + * (Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId. If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current AWS account. + */ + HostedZoneId?: ResourceId; + /** + * (Optional) If the current AWS account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results. For the first ListQueryLoggingConfigs request, omit this value. For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. + */ + NextToken?: PaginationToken; + /** + * (Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current AWS account has more than MaxResults configurations, use the value of NextToken in the response to get the next page of results. If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations. + */ + MaxResults?: MaxResults; + } + export interface ListQueryLoggingConfigsResponse { + /** + * An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current AWS account. + */ + QueryLoggingConfigs: QueryLoggingConfigs; + /** + * If a response includes the last of the query logging configurations that are associated with the current AWS account, NextToken doesn't appear in the response. If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request. + */ + NextToken?: PaginationToken; + } + export interface ListResourceRecordSetsRequest { + /** + * The ID of the hosted zone that contains the resource record sets that you want to list. + */ + HostedZoneId: ResourceId; + /** + * The first name in the lexicographic ordering of resource record sets that you want to list. + */ + StartRecordName?: DNSName; + /** + * The type of resource record set to begin the record listing from. Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT Values for alias resource record sets: API Gateway custom regional API or edge-optimized API: A CloudFront distribution: A or AAAA Elastic Beanstalk environment that has a regionalized subdomain: A Elastic Load Balancing load balancer: A | AAAA Amazon S3 bucket: A Amazon VPC interface VPC endpoint: A Another resource record set in this hosted zone: The type of the resource record set that the alias references. Constraint: Specifying type without specifying name returns an InvalidInput error. + */ + StartRecordType?: RRType; + /** + * Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type. + */ + StartRecordIdentifier?: ResourceRecordSetIdentifier; + /** + * (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets. + */ + MaxItems?: PageMaxItems; + } + export interface ListResourceRecordSetsResponse { + /** + * Information about multiple resource record sets. + */ + ResourceRecordSets: ResourceRecordSets; + /** + * A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element. + */ + IsTruncated: PageTruncated; + /** + * If the results were truncated, the name of the next record in the list. This element is present only if IsTruncated is true. + */ + NextRecordName?: DNSName; + /** + * If the results were truncated, the type of the next record in the list. This element is present only if IsTruncated is true. + */ + NextRecordType?: RRType; + /** + * Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type. For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide. + */ + NextRecordIdentifier?: ResourceRecordSetIdentifier; + /** + * The maximum number of records you requested. + */ + MaxItems: PageMaxItems; + } + export interface ListReusableDelegationSetsRequest { + /** + * If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. To get another group, submit another ListReusableDelegationSets request. For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get. + */ + Marker?: PageMarker; + /** + * The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets. + */ + MaxItems?: PageMaxItems; + } + export interface ListReusableDelegationSetsResponse { + /** + * A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current AWS account. + */ + DelegationSets: DelegationSets; + /** + * For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified for the marker parameter in the request that produced the current response. + */ + Marker: PageMarker; + /** + * A flag that indicates whether there are more reusable delegation sets to be listed. + */ + IsTruncated: PageTruncated; + /** + * If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set that Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker in the marker parameter. + */ + NextMarker?: PageMarker; + /** + * The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListTagsForResourceRequest { + /** + * The type of the resource. The resource type for health checks is healthcheck. The resource type for hosted zones is hostedzone. + */ + ResourceType: TagResourceType; + /** + * The ID of the resource for which you want to retrieve tags. + */ + ResourceId: TagResourceId; + } + export interface ListTagsForResourceResponse { + /** + * A ResourceTagSet containing tags associated with the specified resource. + */ + ResourceTagSet: ResourceTagSet; + } + export interface ListTagsForResourcesRequest { + /** + * The type of the resources. The resource type for health checks is healthcheck. The resource type for hosted zones is hostedzone. + */ + ResourceType: TagResourceType; + /** + * A complex type that contains the ResourceId element for each resource for which you want to get a list of tags. + */ + ResourceIds: TagResourceIdList; + } + export interface ListTagsForResourcesResponse { + /** + * A list of ResourceTagSets containing tags associated with the specified resources. + */ + ResourceTagSets: ResourceTagSetList; + } + export interface ListTrafficPoliciesRequest { + /** + * (Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker parameter. If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response. + */ + TrafficPolicyIdMarker?: TrafficPolicyId; + /** + * (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request. + */ + MaxItems?: PageMaxItems; + } + export interface ListTrafficPoliciesResponse { + /** + * A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account. + */ + TrafficPolicySummaries: TrafficPolicySummaries; + /** + * A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter. + */ + IsTruncated: PageTruncated; + /** + * If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. + */ + TrafficPolicyIdMarker: TrafficPolicyId; + /** + * The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListTrafficPolicyInstancesByHostedZoneRequest { + /** + * The ID of the hosted zone that you want to list traffic policy instances for. + */ + HostedZoneId: ResourceId; + /** + * If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + TrafficPolicyInstanceNameMarker?: DNSName; + /** + * If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + TrafficPolicyInstanceTypeMarker?: RRType; + /** + * The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. + */ + MaxItems?: PageMaxItems; + } + export interface ListTrafficPolicyInstancesByHostedZoneResponse { + /** + * A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request. + */ + TrafficPolicyInstances: TrafficPolicyInstances; + /** + * If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances. + */ + TrafficPolicyInstanceNameMarker?: DNSName; + /** + * If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances. + */ + TrafficPolicyInstanceTypeMarker?: RRType; + /** + * A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters. + */ + IsTruncated: PageTruncated; + /** + * The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListTrafficPolicyInstancesByPolicyRequest { + /** + * The ID of the traffic policy for which you want to list traffic policy instances. + */ + TrafficPolicyId: TrafficPolicyId; + /** + * The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId. + */ + TrafficPolicyVersion: TrafficPolicyVersion; + /** + * If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request. For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + HostedZoneIdMarker?: ResourceId; + /** + * If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + TrafficPolicyInstanceNameMarker?: DNSName; + /** + * If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + TrafficPolicyInstanceTypeMarker?: RRType; + /** + * The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. + */ + MaxItems?: PageMaxItems; + } + export interface ListTrafficPolicyInstancesByPolicyResponse { + /** + * A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request. + */ + TrafficPolicyInstances: TrafficPolicyInstances; + /** + * If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances. + */ + HostedZoneIdMarker?: ResourceId; + /** + * If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances. + */ + TrafficPolicyInstanceNameMarker?: DNSName; + /** + * If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances. + */ + TrafficPolicyInstanceTypeMarker?: RRType; + /** + * A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters. + */ + IsTruncated: PageTruncated; + /** + * The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListTrafficPolicyInstancesRequest { + /** + * If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + HostedZoneIdMarker?: ResourceId; + /** + * If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + TrafficPolicyInstanceNameMarker?: DNSName; + /** + * If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get. + */ + TrafficPolicyInstanceTypeMarker?: RRType; + /** + * The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances. + */ + MaxItems?: PageMaxItems; + } + export interface ListTrafficPolicyInstancesResponse { + /** + * A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request. + */ + TrafficPolicyInstances: TrafficPolicyInstances; + /** + * If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request. + */ + HostedZoneIdMarker?: ResourceId; + /** + * If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request. + */ + TrafficPolicyInstanceNameMarker?: DNSName; + /** + * If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request. + */ + TrafficPolicyInstanceTypeMarker?: RRType; + /** + * A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters. + */ + IsTruncated: PageTruncated; + /** + * The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListTrafficPolicyVersionsRequest { + /** + * Specify the value of Id of the traffic policy for which you want to list all versions. + */ + Id: TrafficPolicyId; + /** + * For your first request to ListTrafficPolicyVersions, don't include the TrafficPolicyVersionMarker parameter. If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous response. + */ + TrafficPolicyVersionMarker?: TrafficPolicyVersionMarker; + /** + * The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit another request. + */ + MaxItems?: PageMaxItems; + } + export interface ListTrafficPolicyVersionsResponse { + /** + * A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy. + */ + TrafficPolicies: TrafficPolicies; + /** + * A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter. + */ + IsTruncated: PageTruncated; + /** + * If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter. This element is present only if IsTruncated is true. + */ + TrafficPolicyVersionMarker: TrafficPolicyVersionMarker; + /** + * The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response. + */ + MaxItems: PageMaxItems; + } + export interface ListVPCAssociationAuthorizationsRequest { + /** + * The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone. + */ + HostedZoneId: ResourceId; + /** + * Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of NextToken from the response in the nexttoken parameter in another ListVPCAssociationAuthorizations request. + */ + NextToken?: PaginationToken; + /** + * Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page. + */ + MaxResults?: MaxResults; + } + export interface ListVPCAssociationAuthorizationsResponse { + /** + * The ID of the hosted zone that you can associate the listed VPCs with. + */ + HostedZoneId: ResourceId; + /** + * When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the nexttoken request parameter. + */ + NextToken?: PaginationToken; + /** + * The list of VPCs that are authorized to be associated with the specified hosted zone. + */ + VPCs: VPCs; + } + export type MaxResults = string; + export type MeasureLatency = boolean; + export type Message = string; + export type MetricName = string; + export type Nameserver = string; + export type Namespace = string; + export type Nonce = string; + export type PageMarker = string; + export type PageMaxItems = string; + export type PageTruncated = boolean; + export type PaginationToken = string; + export type Period = number; + export type Port = number; + export interface QueryLoggingConfig { + /** + * The ID for a configuration for DNS query logging. + */ + Id: QueryLoggingConfigId; + /** + * The ID of the hosted zone that CloudWatch Logs is logging queries for. + */ + HostedZoneId: ResourceId; + /** + * The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. + */ + CloudWatchLogsLogGroupArn: CloudWatchLogsLogGroupArn; + } + export type QueryLoggingConfigId = string; + export type QueryLoggingConfigs = QueryLoggingConfig[]; + export type RData = string; + export type RRType = "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"NAPTR"|"PTR"|"SRV"|"SPF"|"AAAA"|"CAA"|string; + export type RecordData = RecordDataEntry[]; + export type RecordDataEntry = string; + export type RequestInterval = number; + export type ResettableElementName = "FullyQualifiedDomainName"|"Regions"|"ResourcePath"|"ChildHealthChecks"|string; + export type ResettableElementNameList = ResettableElementName[]; + export type ResourceDescription = string; + export type ResourceId = string; + export type ResourcePath = string; + export interface ResourceRecord { + /** + * The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide. You can specify more than one value for all record types except CNAME and SOA. If you're creating an alias resource record set, omit Value. + */ + Value: RData; + } + export interface ResourceRecordSet { + /** + * For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone. ChangeResourceRecordSets Only Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide. You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following: The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com. The * can't replace any of the middle labels, for example, marketing.*.example.com. If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard. You can't use the * wildcard for resource records sets that have a type of NS. You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com. + */ + Name: DNSName; + /** + * The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide. Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group. Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type. Values for alias resource record sets: Amazon API Gateway custom regional APIs and edge-optimized APIs: A CloudFront distributions: A If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA. AWS Elastic Beanstalk environment that has a regionalized subdomain: A ELB load balancers: A | AAAA Amazon S3 buckets: A Amazon Virtual Private Cloud interface VPC endpoints A Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA. If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. + */ + Type: RRType; + /** + * Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set. For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide. + */ + SetIdentifier?: ResourceRecordSetIdentifier; + /** + * Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following: You must specify a value for the Weight element for every weighted resource record set. You can only specify one ResourceRecord per weighted resource record set. You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets. You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements. For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide. + */ + Weight?: ResourceRecordSetWeight; + /** + * Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. Creating latency and latency alias resource record sets in private hosted zones is not supported. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. Note the following: You can only specify one ResourceRecord per latency resource record set. You can only create one latency resource record set for each Amazon EC2 Region. You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for. You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets. + */ + Region?: ResourceRecordSetRegion; + /** + * Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF. Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported. If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource. You can't create two geolocation resource record sets that specify the same geographic location. The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements. Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations. You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets. + */ + GeoLocation?: GeoLocation; + /** + * Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set. Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets: When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set. When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set. When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set. If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint. You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets. For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true. For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide: Route 53 Health Checks and DNS Failover Configuring Failover in a Private Hosted Zone + */ + Failover?: ResourceRecordSetFailover; + /** + * Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following: If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy. If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy. Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records. If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records. When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records. If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response. You can't create multivalue answer alias records. + */ + MultiValueAnswer?: ResourceRecordSetMultiValueAnswer; + /** + * The resource record cache time to live (TTL), in seconds. Note the following: If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target. If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status. All of the resource record sets in a group of weighted resource record sets must have the same value for TTL. If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight. + */ + TTL?: TTL; + /** + * Information about the resource records to act upon. If you're creating an alias resource record set, omit ResourceRecords. + */ + ResourceRecords?: ResourceRecords; + /** + * Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. If you're creating resource records sets for a private hosted zone, note the following: You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution. Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported. For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide. + */ + AliasTarget?: AliasTarget; + /** + * If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check. Route 53 determines whether a resource record set is healthy based on one of the following: By periodically sending a request to the endpoint that is specified in the health check By aggregating the status of a specified group of health checks (calculated health checks) By determining the current state of a CloudWatch alarm (CloudWatch metric health checks) Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. For more information, see the following topics in the Amazon Route 53 Developer Guide: How Amazon Route 53 Determines Whether an Endpoint Is Healthy Route 53 Health Checks and DNS Failover Configuring Failover in a Private Hosted Zone When to Specify HealthCheckId Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations: Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. Alias resource record sets: You specify the following settings: You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone. You specify a health check ID for the non-alias resource record set. If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with. If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set. The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets. Geolocation Routing For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy: The United States North America The default resource record set Specifying the Health Check Endpoint by Domain Name If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com). Health check results will be unpredictable if you do the following: Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set. Associate that health check with the resource record set. + */ + HealthCheckId?: HealthCheckId; + /** + * When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for. To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. + */ + TrafficPolicyInstanceId?: TrafficPolicyInstanceId; + } + export type ResourceRecordSetFailover = "PRIMARY"|"SECONDARY"|string; + export type ResourceRecordSetIdentifier = string; + export type ResourceRecordSetMultiValueAnswer = boolean; + export type ResourceRecordSetRegion = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"ca-central-1"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"eu-north-1"|"sa-east-1"|"cn-north-1"|"cn-northwest-1"|"ap-east-1"|"ap-south-1"|string; + export type ResourceRecordSetWeight = number; + export type ResourceRecordSets = ResourceRecordSet[]; + export type ResourceRecords = ResourceRecord[]; + export interface ResourceTagSet { + /** + * The type of the resource. The resource type for health checks is healthcheck. The resource type for hosted zones is hostedzone. + */ + ResourceType?: TagResourceType; + /** + * The ID for the specified resource. + */ + ResourceId?: TagResourceId; + /** + * The tags associated with the specified resource. + */ + Tags?: TagList; + } + export type ResourceTagSetList = ResourceTagSet[]; + export type ResourceURI = string; + export interface ReusableDelegationSetLimit { + /** + * The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the maximum number of hosted zones that you can associate with the specified reusable delegation set. + */ + Type: ReusableDelegationSetLimitType; + /** + * The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET limit. + */ + Value: LimitValue; + } + export type ReusableDelegationSetLimitType = "MAX_ZONES_BY_REUSABLE_DELEGATION_SET"|string; + export type SearchString = string; + export type ServicePrincipal = string; + export type Statistic = "Average"|"Sum"|"SampleCount"|"Maximum"|"Minimum"|string; + export type Status = string; + export interface StatusReport { + /** + * A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers. + */ + Status?: Status; + /** + * The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC. + */ + CheckedTime?: TimeStamp; + } + export type SubnetMask = string; + export type TTL = number; + export interface Tag { + /** + * The value of Key depends on the operation that you want to perform: Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag. Edit a tag: Key is the name of the tag that you want to change the Value for. Delete a key: Key is the name of the tag you want to remove. Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check. + */ + Key?: TagKey; + /** + * The value of Value depends on the operation that you want to perform: Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag. Edit a tag: Value is the new value that you want to assign the tag. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export type TagResourceId = string; + export type TagResourceIdList = TagResourceId[]; + export type TagResourceType = "healthcheck"|"hostedzone"|string; + export type TagValue = string; + export interface TestDNSAnswerRequest { + /** + * The ID of the hosted zone that you want Amazon Route 53 to simulate a query for. + */ + HostedZoneId: ResourceId; + /** + * The name of the resource record set that you want Amazon Route 53 to simulate a query for. + */ + RecordName: DNSName; + /** + * The type of the resource record set. + */ + RecordType: RRType; + /** + * If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region (us-east-1). + */ + ResolverIP?: IPAddress; + /** + * If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334. + */ + EDNS0ClientSubnetIP?: IPAddress; + /** + * If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses. The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address: IPv4: Specify a value between 0 and 32 IPv6: Specify a value between 0 and 128 + */ + EDNS0ClientSubnetMask?: SubnetMask; + } + export interface TestDNSAnswerResponse { + /** + * The Amazon Route 53 name server used to respond to the request. + */ + Nameserver: Nameserver; + /** + * The name of the resource record set that you submitted a request for. + */ + RecordName: DNSName; + /** + * The type of the resource record set that you submitted a request for. + */ + RecordType: RRType; + /** + * A list that contains values that Amazon Route 53 returned for this resource record set. + */ + RecordData: RecordData; + /** + * A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website. + */ + ResponseCode: DNSRCode; + /** + * The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP. + */ + Protocol: TransportProtocol; + } + export type Threshold = number; + export type TimeStamp = Date; + export type TrafficPolicies = TrafficPolicy[]; + export interface TrafficPolicy { + /** + * The ID that Amazon Route 53 assigned to a traffic policy when you created it. + */ + Id: TrafficPolicyId; + /** + * The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1. + */ + Version: TrafficPolicyVersion; + /** + * The name that you specified when you created the traffic policy. + */ + Name: TrafficPolicyName; + /** + * The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance. + */ + Type: RRType; + /** + * The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format. + */ + Document: TrafficPolicyDocument; + /** + * The comment that you specify in the CreateTrafficPolicy request, if any. + */ + Comment?: TrafficPolicyComment; + } + export type TrafficPolicyComment = string; + export type TrafficPolicyDocument = string; + export type TrafficPolicyId = string; + export interface TrafficPolicyInstance { + /** + * The ID that Amazon Route 53 assigned to the new traffic policy instance. + */ + Id: TrafficPolicyInstanceId; + /** + * The ID of the hosted zone that Amazon Route 53 created resource record sets in. + */ + HostedZoneId: ResourceId; + /** + * The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance. + */ + Name: DNSName; + /** + * The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone. + */ + TTL: TTL; + /** + * The value of State is one of the following values: Applied Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations. Creating Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully. Failed Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail. + */ + State: TrafficPolicyInstanceState; + /** + * If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty. + */ + Message: Message; + /** + * The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. + */ + TrafficPolicyId: TrafficPolicyId; + /** + * The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. + */ + TrafficPolicyVersion: TrafficPolicyVersion; + /** + * The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance. + */ + TrafficPolicyType: RRType; + } + export type TrafficPolicyInstanceCount = number; + export type TrafficPolicyInstanceId = string; + export type TrafficPolicyInstanceState = string; + export type TrafficPolicyInstances = TrafficPolicyInstance[]; + export type TrafficPolicyName = string; + export type TrafficPolicySummaries = TrafficPolicySummary[]; + export interface TrafficPolicySummary { + /** + * The ID that Amazon Route 53 assigned to the traffic policy when you created it. + */ + Id: TrafficPolicyId; + /** + * The name that you specified for the traffic policy when you created it. + */ + Name: TrafficPolicyName; + /** + * The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance. + */ + Type: RRType; + /** + * The version number of the latest version of the traffic policy. + */ + LatestVersion: TrafficPolicyVersion; + /** + * The number of traffic policies that are associated with the current AWS account. + */ + TrafficPolicyCount: TrafficPolicyVersion; + } + export type TrafficPolicyVersion = number; + export type TrafficPolicyVersionMarker = string; + export type TransportProtocol = string; + export interface UpdateHealthCheckRequest { + /** + * The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element. + */ + HealthCheckId: HealthCheckId; + /** + * A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check. We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update: If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings. If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error. + */ + HealthCheckVersion?: HealthCheckVersion; + /** + * The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint. Use one of the following formats for the value of IPAddress: IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44. IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345. If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation: Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress. For more information, see FullyQualifiedDomainName. Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: RFC 5735, Special Use IPv4 Addresses RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space RFC 5156, Special-Use IPv6 Addresses + */ + IPAddress?: IPAddress; + /** + * The port on the endpoint on which you want Amazon Route 53 to perform health checks. + */ + Port?: Port; + /** + * The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y. Specify this value only if you want to change it. + */ + ResourcePath?: ResourcePath; + /** + * Amazon Route 53 behavior depends on whether you specify a value for IPAddress. If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress. If you specify a value for IPAddress: Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. When Route 53 checks the health of an endpoint, here is how it constructs the Host header: If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header. If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header. If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases. If you don't specify a value for IPAddress: If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint. If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error. If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com). In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable. In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header. + */ + FullyQualifiedDomainName?: FullyQualifiedDomainName; + /** + * If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.) + */ + SearchString?: SearchString; + /** + * The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide. If you don't specify a value for FailureThreshold, the default value is three health checks. + */ + FailureThreshold?: FailureThreshold; + /** + * Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. + */ + Inverted?: Inverted; + /** + * Stops Route 53 from performing health checks. When you disable a health check, here's what happens: Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource. Calculated health checks: Route 53 stops aggregating the status of the referenced health checks. Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics. After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted. Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing. + */ + Disabled?: Disabled; + /** + * The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements. Note the following: If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy. If you specify 0, Route 53 always considers this health check to be healthy. + */ + HealthThreshold?: HealthThreshold; + /** + * A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check. + */ + ChildHealthChecks?: ChildHealthCheckList; + /** + * Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate. Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message. + */ + EnableSNI?: EnableSNI; + /** + * A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from. + */ + Regions?: HealthCheckRegionList; + /** + * A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. + */ + AlarmIdentifier?: AlarmIdentifier; + /** + * When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: Healthy: Route 53 considers the health check to be healthy. Unhealthy: Route 53 considers the health check to be unhealthy. LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. + */ + InsufficientDataHealthStatus?: InsufficientDataHealthStatus; + /** + * A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following: ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. Regions: Route 53 resets the Regions list to the default set of regions. ResourcePath: Route 53 resets ResourcePath to null. + */ + ResetElements?: ResettableElementNameList; + } + export interface UpdateHealthCheckResponse { + /** + * A complex type that contains the response to an UpdateHealthCheck request. + */ + HealthCheck: HealthCheck; + } + export interface UpdateHostedZoneCommentRequest { + /** + * The ID for the hosted zone that you want to update the comment for. + */ + Id: ResourceId; + /** + * The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any. + */ + Comment?: ResourceDescription; + } + export interface UpdateHostedZoneCommentResponse { + /** + * A complex type that contains the response to the UpdateHostedZoneComment request. + */ + HostedZone: HostedZone; + } + export interface UpdateTrafficPolicyCommentRequest { + /** + * The value of Id for the traffic policy that you want to update the comment for. + */ + Id: TrafficPolicyId; + /** + * The value of Version for the traffic policy that you want to update the comment for. + */ + Version: TrafficPolicyVersion; + /** + * The new comment for the specified traffic policy and version. + */ + Comment: TrafficPolicyComment; + } + export interface UpdateTrafficPolicyCommentResponse { + /** + * A complex type that contains settings for the specified traffic policy. + */ + TrafficPolicy: TrafficPolicy; + } + export interface UpdateTrafficPolicyInstanceRequest { + /** + * The ID of the traffic policy instance that you want to update. + */ + Id: TrafficPolicyInstanceId; + /** + * The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets. + */ + TTL: TTL; + /** + * The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. + */ + TrafficPolicyId: TrafficPolicyId; + /** + * The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. + */ + TrafficPolicyVersion: TrafficPolicyVersion; + } + export interface UpdateTrafficPolicyInstanceResponse { + /** + * A complex type that contains settings for the updated traffic policy instance. + */ + TrafficPolicyInstance: TrafficPolicyInstance; + } + export type UsageCount = number; + export interface VPC { + /** + * (Private hosted zones only) The region that an Amazon VPC was created in. + */ + VPCRegion?: VPCRegion; + VPCId?: VPCId; + } + export type VPCId = string; + export type VPCRegion = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ap-east-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-south-1"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"eu-north-1"|"sa-east-1"|"ca-central-1"|"cn-north-1"|string; + export type VPCs = VPC[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-04-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Route53 client. + */ + export import Types = Route53; +} +export = Route53; diff --git a/node_modules/aws-sdk/clients/route53.js b/node_modules/aws-sdk/clients/route53.js new file mode 100644 index 0000000..41ef174 --- /dev/null +++ b/node_modules/aws-sdk/clients/route53.js @@ -0,0 +1,20 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['route53'] = {}; +AWS.Route53 = Service.defineService('route53', ['2013-04-01']); +require('../lib/services/route53'); +Object.defineProperty(apiLoader.services['route53'], '2013-04-01', { + get: function get() { + var model = require('../apis/route53-2013-04-01.min.json'); + model.paginators = require('../apis/route53-2013-04-01.paginators.json').pagination; + model.waiters = require('../apis/route53-2013-04-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Route53; diff --git a/node_modules/aws-sdk/clients/route53domains.d.ts b/node_modules/aws-sdk/clients/route53domains.d.ts new file mode 100644 index 0000000..2d46c1a --- /dev/null +++ b/node_modules/aws-sdk/clients/route53domains.d.ts @@ -0,0 +1,1000 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Route53Domains extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Route53Domains.Types.ClientConfiguration) + config: Config & Route53Domains.Types.ClientConfiguration; + /** + * This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. + */ + checkDomainAvailability(params: Route53Domains.Types.CheckDomainAvailabilityRequest, callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainAvailabilityResponse) => void): Request; + /** + * This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. + */ + checkDomainAvailability(callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainAvailabilityResponse) => void): Request; + /** + * Checks whether a domain name can be transferred to Amazon Route 53. + */ + checkDomainTransferability(params: Route53Domains.Types.CheckDomainTransferabilityRequest, callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainTransferabilityResponse) => void): Request; + /** + * Checks whether a domain name can be transferred to Amazon Route 53. + */ + checkDomainTransferability(callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainTransferabilityResponse) => void): Request; + /** + * This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. + */ + deleteTagsForDomain(params: Route53Domains.Types.DeleteTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.DeleteTagsForDomainResponse) => void): Request; + /** + * This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. + */ + deleteTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.DeleteTagsForDomainResponse) => void): Request; + /** + * This operation disables automatic renewal of domain registration for the specified domain. + */ + disableDomainAutoRenew(params: Route53Domains.Types.DisableDomainAutoRenewRequest, callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainAutoRenewResponse) => void): Request; + /** + * This operation disables automatic renewal of domain registration for the specified domain. + */ + disableDomainAutoRenew(callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainAutoRenewResponse) => void): Request; + /** + * This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + disableDomainTransferLock(params: Route53Domains.Types.DisableDomainTransferLockRequest, callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainTransferLockResponse) => void): Request; + /** + * This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + disableDomainTransferLock(callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainTransferLockResponse) => void): Request; + /** + * This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our registrar associate, Gandi. Amazon Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. + */ + enableDomainAutoRenew(params: Route53Domains.Types.EnableDomainAutoRenewRequest, callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainAutoRenewResponse) => void): Request; + /** + * This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our registrar associate, Gandi. Amazon Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. + */ + enableDomainAutoRenew(callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainAutoRenewResponse) => void): Request; + /** + * This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + enableDomainTransferLock(params: Route53Domains.Types.EnableDomainTransferLockRequest, callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainTransferLockResponse) => void): Request; + /** + * This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + enableDomainTransferLock(callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainTransferLockResponse) => void): Request; + /** + * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the ResendContactReachabilityEmail operation. + */ + getContactReachabilityStatus(params: Route53Domains.Types.GetContactReachabilityStatusRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetContactReachabilityStatusResponse) => void): Request; + /** + * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the ResendContactReachabilityEmail operation. + */ + getContactReachabilityStatus(callback?: (err: AWSError, data: Route53Domains.Types.GetContactReachabilityStatusResponse) => void): Request; + /** + * This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output. + */ + getDomainDetail(params: Route53Domains.Types.GetDomainDetailRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetDomainDetailResponse) => void): Request; + /** + * This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output. + */ + getDomainDetail(callback?: (err: AWSError, data: Route53Domains.Types.GetDomainDetailResponse) => void): Request; + /** + * The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces). + */ + getDomainSuggestions(params: Route53Domains.Types.GetDomainSuggestionsRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetDomainSuggestionsResponse) => void): Request; + /** + * The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces). + */ + getDomainSuggestions(callback?: (err: AWSError, data: Route53Domains.Types.GetDomainSuggestionsResponse) => void): Request; + /** + * This operation returns the current status of an operation that is not completed. + */ + getOperationDetail(params: Route53Domains.Types.GetOperationDetailRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetOperationDetailResponse) => void): Request; + /** + * This operation returns the current status of an operation that is not completed. + */ + getOperationDetail(callback?: (err: AWSError, data: Route53Domains.Types.GetOperationDetailResponse) => void): Request; + /** + * This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. + */ + listDomains(params: Route53Domains.Types.ListDomainsRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListDomainsResponse) => void): Request; + /** + * This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. + */ + listDomains(callback?: (err: AWSError, data: Route53Domains.Types.ListDomainsResponse) => void): Request; + /** + * This operation returns the operation IDs of operations that are not yet complete. + */ + listOperations(params: Route53Domains.Types.ListOperationsRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListOperationsResponse) => void): Request; + /** + * This operation returns the operation IDs of operations that are not yet complete. + */ + listOperations(callback?: (err: AWSError, data: Route53Domains.Types.ListOperationsResponse) => void): Request; + /** + * This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. + */ + listTagsForDomain(params: Route53Domains.Types.ListTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListTagsForDomainResponse) => void): Request; + /** + * This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. + */ + listTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.ListTagsForDomainResponse) => void): Request; + /** + * This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts. If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email. Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing. + */ + registerDomain(params: Route53Domains.Types.RegisterDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.RegisterDomainResponse) => void): Request; + /** + * This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts. If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email. Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing. + */ + registerDomain(callback?: (err: AWSError, data: Route53Domains.Types.RegisterDomainResponse) => void): Request; + /** + * This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide. + */ + renewDomain(params: Route53Domains.Types.RenewDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.RenewDomainResponse) => void): Request; + /** + * This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide. + */ + renewDomain(callback?: (err: AWSError, data: Route53Domains.Types.RenewDomainResponse) => void): Request; + /** + * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact. + */ + resendContactReachabilityEmail(params: Route53Domains.Types.ResendContactReachabilityEmailRequest, callback?: (err: AWSError, data: Route53Domains.Types.ResendContactReachabilityEmailResponse) => void): Request; + /** + * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact. + */ + resendContactReachabilityEmail(callback?: (err: AWSError, data: Route53Domains.Types.ResendContactReachabilityEmailResponse) => void): Request; + /** + * This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. + */ + retrieveDomainAuthCode(params: Route53Domains.Types.RetrieveDomainAuthCodeRequest, callback?: (err: AWSError, data: Route53Domains.Types.RetrieveDomainAuthCodeResponse) => void): Request; + /** + * This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. + */ + retrieveDomainAuthCode(callback?: (err: AWSError, data: Route53Domains.Types.RetrieveDomainAuthCodeResponse) => void): Request; + /** + * This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs). For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable. If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email. + */ + transferDomain(params: Route53Domains.Types.TransferDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainResponse) => void): Request; + /** + * This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs). For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable. If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email. + */ + transferDomain(callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainResponse) => void): Request; + /** + * This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical. If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + updateDomainContact(params: Route53Domains.Types.UpdateDomainContactRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactResponse) => void): Request; + /** + * This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical. If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + updateDomainContact(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactResponse) => void): Request; + /** + * This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi. This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email. + */ + updateDomainContactPrivacy(params: Route53Domains.Types.UpdateDomainContactPrivacyRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactPrivacyResponse) => void): Request; + /** + * This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi. This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email. + */ + updateDomainContactPrivacy(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactPrivacyResponse) => void): Request; + /** + * This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + updateDomainNameservers(params: Route53Domains.Types.UpdateDomainNameserversRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainNameserversResponse) => void): Request; + /** + * This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. + */ + updateDomainNameservers(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainNameserversResponse) => void): Request; + /** + * This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. + */ + updateTagsForDomain(params: Route53Domains.Types.UpdateTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateTagsForDomainResponse) => void): Request; + /** + * This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. + */ + updateTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.UpdateTagsForDomainResponse) => void): Request; + /** + * Returns all the domain-related billing records for the current AWS account for a specified period + */ + viewBilling(params: Route53Domains.Types.ViewBillingRequest, callback?: (err: AWSError, data: Route53Domains.Types.ViewBillingResponse) => void): Request; + /** + * Returns all the domain-related billing records for the current AWS account for a specified period + */ + viewBilling(callback?: (err: AWSError, data: Route53Domains.Types.ViewBillingResponse) => void): Request; +} +declare namespace Route53Domains { + export type AddressLine = string; + export interface BillingRecord { + /** + * The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guidezzz. + */ + DomainName?: DomainName; + /** + * The operation that you were charged for. + */ + Operation?: OperationType; + /** + * The ID of the invoice that is associated with the billing record. + */ + InvoiceId?: InvoiceId; + /** + * The date that the operation was billed, in Unix format. + */ + BillDate?: Timestamp; + /** + * The price that you were charged for the operation, in US dollars. Example value: 12.0 + */ + Price?: Price; + } + export type BillingRecords = BillingRecord[]; + export type Boolean = boolean; + export interface CheckDomainAvailabilityRequest { + /** + * The name of the domain that you want to get availability for. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. + */ + DomainName: DomainName; + /** + * Reserved for future use. + */ + IdnLangCode?: LangCode; + } + export interface CheckDomainAvailabilityResponse { + /** + * Whether the domain name is available for registering. You can register only domains designated as AVAILABLE. Valid values: AVAILABLE The domain name is available. AVAILABLE_RESERVED The domain name is reserved under specific conditions. AVAILABLE_PREORDER The domain name is available and can be preordered. DONT_KNOW The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later. PENDING The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately. RESERVED The domain name has been reserved for another person or organization. UNAVAILABLE The domain name is not available. UNAVAILABLE_PREMIUM The domain name is not available. UNAVAILABLE_RESTRICTED The domain name is forbidden. + */ + Availability: DomainAvailability; + } + export interface CheckDomainTransferabilityRequest { + /** + * The name of the domain that you want to transfer to Amazon Route 53. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. + */ + DomainName: DomainName; + /** + * If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain. + */ + AuthCode?: DomainAuthCode; + } + export interface CheckDomainTransferabilityResponse { + /** + * A complex type that contains information about whether the specified domain can be transferred to Amazon Route 53. + */ + Transferability: DomainTransferability; + } + export type City = string; + export interface ContactDetail { + /** + * First name of contact. + */ + FirstName?: ContactName; + /** + * Last name of contact. + */ + LastName?: ContactName; + /** + * Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact. + */ + ContactType?: ContactType; + /** + * Name of the organization for contact types other than PERSON. + */ + OrganizationName?: ContactName; + /** + * First line of the contact's address. + */ + AddressLine1?: AddressLine; + /** + * Second line of contact's address, if any. + */ + AddressLine2?: AddressLine; + /** + * The city of the contact's address. + */ + City?: City; + /** + * The state or province of the contact's city. + */ + State?: State; + /** + * Code for the country of the contact's address. + */ + CountryCode?: CountryCode; + /** + * The zip or postal code of the contact's address. + */ + ZipCode?: ZipCode; + /** + * The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890". + */ + PhoneNumber?: ContactNumber; + /** + * Email address of the contact. + */ + Email?: Email; + /** + * Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890". + */ + Fax?: ContactNumber; + /** + * A list of name-value pairs for parameters required by certain top-level domains. + */ + ExtraParams?: ExtraParamList; + } + export type ContactName = string; + export type ContactNumber = string; + export type ContactType = "PERSON"|"COMPANY"|"ASSOCIATION"|"PUBLIC_BODY"|"RESELLER"|string; + export type CountryCode = "AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BR"|"BS"|"BT"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GH"|"GI"|"GL"|"GM"|"GN"|"GQ"|"GR"|"GT"|"GU"|"GW"|"GY"|"HK"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IQ"|"IR"|"IS"|"IT"|"JM"|"JO"|"JP"|"KE"|"KG"|"KH"|"KI"|"KM"|"KN"|"KP"|"KR"|"KW"|"KY"|"KZ"|"LA"|"LB"|"LC"|"LI"|"LK"|"LR"|"LS"|"LT"|"LU"|"LV"|"LY"|"MA"|"MC"|"MD"|"ME"|"MF"|"MG"|"MH"|"MK"|"ML"|"MM"|"MN"|"MO"|"MP"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PT"|"PW"|"PY"|"QA"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"ST"|"SV"|"SY"|"SZ"|"TC"|"TD"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TR"|"TT"|"TV"|"TW"|"TZ"|"UA"|"UG"|"US"|"UY"|"UZ"|"VA"|"VC"|"VE"|"VG"|"VI"|"VN"|"VU"|"WF"|"WS"|"YE"|"YT"|"ZA"|"ZM"|"ZW"|string; + export type CurrentExpiryYear = number; + export type DNSSec = string; + export interface DeleteTagsForDomainRequest { + /** + * The domain for which you want to delete one or more tags. + */ + DomainName: DomainName; + /** + * A list of tag keys to delete. + */ + TagsToDelete: TagKeyList; + } + export interface DeleteTagsForDomainResponse { + } + export interface DisableDomainAutoRenewRequest { + /** + * The name of the domain that you want to disable automatic renewal for. + */ + DomainName: DomainName; + } + export interface DisableDomainAutoRenewResponse { + } + export interface DisableDomainTransferLockRequest { + /** + * The name of the domain that you want to remove the transfer lock for. + */ + DomainName: DomainName; + } + export interface DisableDomainTransferLockResponse { + /** + * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export type DomainAuthCode = string; + export type DomainAvailability = "AVAILABLE"|"AVAILABLE_RESERVED"|"AVAILABLE_PREORDER"|"UNAVAILABLE"|"UNAVAILABLE_PREMIUM"|"UNAVAILABLE_RESTRICTED"|"RESERVED"|"DONT_KNOW"|string; + export type DomainName = string; + export type DomainStatus = string; + export type DomainStatusList = DomainStatus[]; + export interface DomainSuggestion { + /** + * A suggested domain name. + */ + DomainName?: DomainName; + /** + * Whether the domain name is available for registering. You can register only the domains that are designated as AVAILABLE. Valid values: AVAILABLE The domain name is available. AVAILABLE_RESERVED The domain name is reserved under specific conditions. AVAILABLE_PREORDER The domain name is available and can be preordered. DONT_KNOW The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later. PENDING The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately. RESERVED The domain name has been reserved for another person or organization. UNAVAILABLE The domain name is not available. UNAVAILABLE_PREMIUM The domain name is not available. UNAVAILABLE_RESTRICTED The domain name is forbidden. + */ + Availability?: String; + } + export type DomainSuggestionsList = DomainSuggestion[]; + export interface DomainSummary { + /** + * The name of the domain that the summary information applies to. + */ + DomainName: DomainName; + /** + * Indicates whether the domain is automatically renewed upon expiration. + */ + AutoRenew?: Boolean; + /** + * Indicates whether a domain is locked from unauthorized transfer to another party. + */ + TransferLock?: Boolean; + /** + * Expiration date of the domain in Coordinated Universal Time (UTC). + */ + Expiry?: Timestamp; + } + export type DomainSummaryList = DomainSummary[]; + export interface DomainTransferability { + Transferable?: Transferable; + } + export type DurationInYears = number; + export type Email = string; + export interface EnableDomainAutoRenewRequest { + /** + * The name of the domain that you want to enable automatic renewal for. + */ + DomainName: DomainName; + } + export interface EnableDomainAutoRenewResponse { + } + export interface EnableDomainTransferLockRequest { + /** + * The name of the domain that you want to set the transfer lock for. + */ + DomainName: DomainName; + } + export interface EnableDomainTransferLockResponse { + /** + * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export type ErrorMessage = string; + export interface ExtraParam { + /** + * Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require: .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA .se: BIRTH_COUNTRY and SE_ID_NUMBER .sg: SG_ID_NUMBER .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER In addition, many TLDs require VAT_NUMBER. + */ + Name: ExtraParamName; + /** + * Values corresponding to the additional parameter names required by some top-level domains. + */ + Value: ExtraParamValue; + } + export type ExtraParamList = ExtraParam[]; + export type ExtraParamName = "DUNS_NUMBER"|"BRAND_NUMBER"|"BIRTH_DEPARTMENT"|"BIRTH_DATE_IN_YYYY_MM_DD"|"BIRTH_COUNTRY"|"BIRTH_CITY"|"DOCUMENT_NUMBER"|"AU_ID_NUMBER"|"AU_ID_TYPE"|"CA_LEGAL_TYPE"|"CA_BUSINESS_ENTITY_TYPE"|"ES_IDENTIFICATION"|"ES_IDENTIFICATION_TYPE"|"ES_LEGAL_FORM"|"FI_BUSINESS_NUMBER"|"FI_ID_NUMBER"|"FI_NATIONALITY"|"FI_ORGANIZATION_TYPE"|"IT_PIN"|"IT_REGISTRANT_ENTITY_TYPE"|"RU_PASSPORT_DATA"|"SE_ID_NUMBER"|"SG_ID_NUMBER"|"VAT_NUMBER"|"UK_CONTACT_TYPE"|"UK_COMPANY_NUMBER"|string; + export type ExtraParamValue = string; + export type FIAuthKey = string; + export interface GetContactReachabilityStatusRequest { + /** + * The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid. + */ + domainName?: DomainName; + } + export interface GetContactReachabilityStatusResponse { + /** + * The domain name for which you requested the reachability status. + */ + domainName?: DomainName; + /** + * Whether the registrant contact has responded. Values include the following: PENDING We sent the confirmation email and haven't received a response yet. DONE We sent the email and got confirmation from the registrant contact. EXPIRED The time limit expired before the registrant contact responded. + */ + status?: ReachabilityStatus; + } + export interface GetDomainDetailRequest { + /** + * The name of the domain that you want to get detailed information about. + */ + DomainName: DomainName; + } + export interface GetDomainDetailResponse { + /** + * The name of a domain. + */ + DomainName: DomainName; + /** + * The name of the domain. + */ + Nameservers: NameserverList; + /** + * Specifies whether the domain registration is set to renew automatically. + */ + AutoRenew?: Boolean; + /** + * Provides details about the domain administrative contact. + */ + AdminContact: ContactDetail; + /** + * Provides details about the domain registrant. + */ + RegistrantContact: ContactDetail; + /** + * Provides details about the domain technical contact. + */ + TechContact: ContactDetail; + /** + * Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the admin contact. + */ + AdminPrivacy?: Boolean; + /** + * Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the registrant contact (domain owner). + */ + RegistrantPrivacy?: Boolean; + /** + * Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the technical contact. + */ + TechPrivacy?: Boolean; + /** + * Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by Gandi is "GANDI SAS". + */ + RegistrarName?: RegistrarName; + /** + * The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain. + */ + WhoIsServer?: RegistrarWhoIsServer; + /** + * Web address of the registrar. + */ + RegistrarUrl?: RegistrarUrl; + /** + * Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse. + */ + AbuseContactEmail?: Email; + /** + * Phone number for reporting abuse. + */ + AbuseContactPhone?: ContactNumber; + /** + * Reserved for future use. + */ + RegistryDomainId?: RegistryDomainId; + /** + * The date when the domain was created as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC). + */ + CreationDate?: Timestamp; + /** + * The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC). + */ + UpdatedDate?: Timestamp; + /** + * The date when the registration for the domain is set to expire. The date and time is in Coordinated Universal time (UTC). + */ + ExpirationDate?: Timestamp; + /** + * Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have "Amazon" as the reseller. + */ + Reseller?: Reseller; + /** + * Reserved for future use. + */ + DnsSec?: DNSSec; + /** + * An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes. ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes. For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.) + */ + StatusList?: DomainStatusList; + } + export interface GetDomainSuggestionsRequest { + /** + * A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. + */ + DomainName: DomainName; + /** + * The number of suggested domain names that you want Amazon Route 53 to return. + */ + SuggestionCount: Integer; + /** + * If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false, Amazon Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion. + */ + OnlyAvailable: Boolean; + } + export interface GetDomainSuggestionsResponse { + /** + * A list of possible domain names. If you specified true for OnlyAvailable in the request, the list contains only domains that are available for registration. + */ + SuggestionsList?: DomainSuggestionsList; + } + export interface GetOperationDetailRequest { + /** + * The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request. + */ + OperationId: OperationId; + } + export interface GetOperationDetailResponse { + /** + * The identifier for the operation. + */ + OperationId?: OperationId; + /** + * The current status of the requested operation in the system. + */ + Status?: OperationStatus; + /** + * Detailed information on the status including possible errors. + */ + Message?: ErrorMessage; + /** + * The name of a domain. + */ + DomainName?: DomainName; + /** + * The type of operation that was requested. + */ + Type?: OperationType; + /** + * The date when the request was submitted. + */ + SubmittedDate?: Timestamp; + } + export type GlueIp = string; + export type GlueIpList = GlueIp[]; + export type HostName = string; + export type Integer = number; + export type InvoiceId = string; + export type LangCode = string; + export interface ListDomainsRequest { + /** + * For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element. Constraints: The marker must match the value specified in the previous request. + */ + Marker?: PageMarker; + /** + * Number of domains to be returned. Default: 20 + */ + MaxItems?: PageMaxItems; + } + export interface ListDomainsResponse { + /** + * A summary of domains. + */ + Domains: DomainSummaryList; + /** + * If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker. + */ + NextPageMarker?: PageMarker; + } + export interface ListOperationsRequest { + /** + * An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Coordinated Universal time (UTC). + */ + SubmittedSince?: Timestamp; + /** + * For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element. + */ + Marker?: PageMarker; + /** + * Number of domains to be returned. Default: 20 + */ + MaxItems?: PageMaxItems; + } + export interface ListOperationsResponse { + /** + * Lists summaries of the operations. + */ + Operations: OperationSummaryList; + /** + * If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker. + */ + NextPageMarker?: PageMarker; + } + export interface ListTagsForDomainRequest { + /** + * The domain for which you want to get a list of tags. + */ + DomainName: DomainName; + } + export interface ListTagsForDomainResponse { + /** + * A list of the tags that are associated with the specified domain. + */ + TagList: TagList; + } + export interface Nameserver { + /** + * The fully qualified host name of the name server. Constraint: Maximum 255 characters + */ + Name: HostName; + /** + * Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com. Constraints: The list can contain only one IPv4 and one IPv6 address. + */ + GlueIps?: GlueIpList; + } + export type NameserverList = Nameserver[]; + export type OperationId = string; + export type OperationStatus = "SUBMITTED"|"IN_PROGRESS"|"ERROR"|"SUCCESSFUL"|"FAILED"|string; + export interface OperationSummary { + /** + * Identifier returned to track the requested action. + */ + OperationId: OperationId; + /** + * The current status of the requested operation in the system. + */ + Status: OperationStatus; + /** + * Type of the action requested. + */ + Type: OperationType; + /** + * The date when the request was submitted. + */ + SubmittedDate: Timestamp; + } + export type OperationSummaryList = OperationSummary[]; + export type OperationType = "REGISTER_DOMAIN"|"DELETE_DOMAIN"|"TRANSFER_IN_DOMAIN"|"UPDATE_DOMAIN_CONTACT"|"UPDATE_NAMESERVER"|"CHANGE_PRIVACY_PROTECTION"|"DOMAIN_LOCK"|"ENABLE_AUTORENEW"|"DISABLE_AUTORENEW"|"ADD_DNSSEC"|"REMOVE_DNSSEC"|"EXPIRE_DOMAIN"|"TRANSFER_OUT_DOMAIN"|"CHANGE_DOMAIN_OWNER"|"RENEW_DOMAIN"|"PUSH_DOMAIN"|string; + export type PageMarker = string; + export type PageMaxItems = number; + export type Price = number; + export type ReachabilityStatus = "PENDING"|"DONE"|"EXPIRED"|string; + export interface RegisterDomainRequest { + /** + * The domain name that you want to register. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. + */ + DomainName: DomainName; + /** + * Reserved for future use. + */ + IdnLangCode?: LangCode; + /** + * The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Default: 1 + */ + DurationInYears: DurationInYears; + /** + * Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. Default: true + */ + AutoRenew?: Boolean; + /** + * Provides detailed contact information. + */ + AdminContact: ContactDetail; + /** + * Provides detailed contact information. + */ + RegistrantContact: ContactDetail; + /** + * Provides detailed contact information. + */ + TechContact: ContactDetail; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the admin contact. Default: true + */ + PrivacyProtectAdminContact?: Boolean; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the registrant contact (the domain owner). Default: true + */ + PrivacyProtectRegistrantContact?: Boolean; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the technical contact. Default: true + */ + PrivacyProtectTechContact?: Boolean; + } + export interface RegisterDomainResponse { + /** + * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export type RegistrarName = string; + export type RegistrarUrl = string; + export type RegistrarWhoIsServer = string; + export type RegistryDomainId = string; + export interface RenewDomainRequest { + /** + * The name of the domain that you want to renew. + */ + DomainName: DomainName; + /** + * The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Default: 1 + */ + DurationInYears?: DurationInYears; + /** + * The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain. + */ + CurrentExpiryYear: CurrentExpiryYear; + } + export interface RenewDomainResponse { + /** + * The identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export type Reseller = string; + export interface ResendContactReachabilityEmailRequest { + /** + * The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact. + */ + domainName?: DomainName; + } + export interface ResendContactReachabilityEmailResponse { + /** + * The domain name for which you requested a confirmation email. + */ + domainName?: DomainName; + /** + * The email address for the registrant contact at the time that we sent the verification email. + */ + emailAddress?: Email; + /** + * True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email. + */ + isAlreadyVerified?: Boolean; + } + export interface RetrieveDomainAuthCodeRequest { + /** + * The name of the domain that you want to get an authorization code for. + */ + DomainName: DomainName; + } + export interface RetrieveDomainAuthCodeResponse { + /** + * The authorization code for the domain. + */ + AuthCode: DomainAuthCode; + } + export type State = string; + export type String = string; + export interface Tag { + /** + * The key (name) of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints: Each key can be 1-128 characters long. + */ + Key?: TagKey; + /** + * The value of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints: Each value can be 0-256 characters long. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export type TagValue = string; + export type Timestamp = Date; + export interface TransferDomainRequest { + /** + * The name of the domain that you want to transfer to Amazon Route 53. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. + */ + DomainName: DomainName; + /** + * Reserved for future use. + */ + IdnLangCode?: LangCode; + /** + * The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Default: 1 + */ + DurationInYears: DurationInYears; + /** + * Contains details for the host and glue IP addresses. + */ + Nameservers?: NameserverList; + /** + * The authorization code for the domain. You get this value from the current registrar. + */ + AuthCode?: DomainAuthCode; + /** + * Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. Default: true + */ + AutoRenew?: Boolean; + /** + * Provides detailed contact information. + */ + AdminContact: ContactDetail; + /** + * Provides detailed contact information. + */ + RegistrantContact: ContactDetail; + /** + * Provides detailed contact information. + */ + TechContact: ContactDetail; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the admin contact. Default: true + */ + PrivacyProtectAdminContact?: Boolean; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner). Default: true + */ + PrivacyProtectRegistrantContact?: Boolean; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the technical contact. Default: true + */ + PrivacyProtectTechContact?: Boolean; + } + export interface TransferDomainResponse { + /** + * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export type Transferable = "TRANSFERABLE"|"UNTRANSFERABLE"|"DONT_KNOW"|string; + export interface UpdateDomainContactPrivacyRequest { + /** + * The name of the domain that you want to update the privacy setting for. + */ + DomainName: DomainName; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the admin contact. + */ + AdminPrivacy?: Boolean; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner). + */ + RegistrantPrivacy?: Boolean; + /** + * Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the technical contact. + */ + TechPrivacy?: Boolean; + } + export interface UpdateDomainContactPrivacyResponse { + /** + * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export interface UpdateDomainContactRequest { + /** + * The name of the domain that you want to update contact information for. + */ + DomainName: DomainName; + /** + * Provides detailed contact information. + */ + AdminContact?: ContactDetail; + /** + * Provides detailed contact information. + */ + RegistrantContact?: ContactDetail; + /** + * Provides detailed contact information. + */ + TechContact?: ContactDetail; + } + export interface UpdateDomainContactResponse { + /** + * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export interface UpdateDomainNameserversRequest { + /** + * The name of the domain that you want to change name servers for. + */ + DomainName: DomainName; + /** + * The authorization key for .fi domains + */ + FIAuthKey?: FIAuthKey; + /** + * A list of new name servers for the domain. + */ + Nameservers: NameserverList; + } + export interface UpdateDomainNameserversResponse { + /** + * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. + */ + OperationId: OperationId; + } + export interface UpdateTagsForDomainRequest { + /** + * The domain for which you want to add or update tags. + */ + DomainName: DomainName; + /** + * A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced. + */ + TagsToUpdate?: TagList; + } + export interface UpdateTagsForDomainResponse { + } + export interface ViewBillingRequest { + /** + * The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC). + */ + Start?: Timestamp; + /** + * The end date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC). + */ + End?: Timestamp; + /** + * For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for MaxItems, you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element. Constraints: The marker must match the value of NextPageMarker that was returned in the previous response. + */ + Marker?: PageMarker; + /** + * The number of billing records to be returned. Default: 20 + */ + MaxItems?: PageMaxItems; + } + export interface ViewBillingResponse { + /** + * If there are more billing records than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker. + */ + NextPageMarker?: PageMarker; + /** + * A summary of billing records. + */ + BillingRecords?: BillingRecords; + } + export type ZipCode = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-05-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Route53Domains client. + */ + export import Types = Route53Domains; +} +export = Route53Domains; diff --git a/node_modules/aws-sdk/clients/route53domains.js b/node_modules/aws-sdk/clients/route53domains.js new file mode 100644 index 0000000..3020d77 --- /dev/null +++ b/node_modules/aws-sdk/clients/route53domains.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['route53domains'] = {}; +AWS.Route53Domains = Service.defineService('route53domains', ['2014-05-15']); +Object.defineProperty(apiLoader.services['route53domains'], '2014-05-15', { + get: function get() { + var model = require('../apis/route53domains-2014-05-15.min.json'); + model.paginators = require('../apis/route53domains-2014-05-15.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Route53Domains; diff --git a/node_modules/aws-sdk/clients/route53resolver.d.ts b/node_modules/aws-sdk/clients/route53resolver.d.ts new file mode 100644 index 0000000..c2bbe22 --- /dev/null +++ b/node_modules/aws-sdk/clients/route53resolver.d.ts @@ -0,0 +1,886 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Route53Resolver extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Route53Resolver.Types.ClientConfiguration) + config: Config & Route53Resolver.Types.ClientConfiguration; + /** + * Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address. To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress. + */ + associateResolverEndpointIpAddress(params: Route53Resolver.Types.AssociateResolverEndpointIpAddressRequest, callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverEndpointIpAddressResponse) => void): Request; + /** + * Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address. To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress. + */ + associateResolverEndpointIpAddress(callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverEndpointIpAddressResponse) => void): Request; + /** + * Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule. + */ + associateResolverRule(params: Route53Resolver.Types.AssociateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverRuleResponse) => void): Request; + /** + * Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule. + */ + associateResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.AssociateResolverRuleResponse) => void): Request; + /** + * Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC. An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC. + */ + createResolverEndpoint(params: Route53Resolver.Types.CreateResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverEndpointResponse) => void): Request; + /** + * Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound: An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC. An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC. + */ + createResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverEndpointResponse) => void): Request; + /** + * For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. + */ + createResolverRule(params: Route53Resolver.Types.CreateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverRuleResponse) => void): Request; + /** + * For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. + */ + createResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.CreateResolverRuleResponse) => void): Request; + /** + * Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint: Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC. Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC. + */ + deleteResolverEndpoint(params: Route53Resolver.Types.DeleteResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverEndpointResponse) => void): Request; + /** + * Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint: Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC. Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC. + */ + deleteResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverEndpointResponse) => void): Request; + /** + * Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule. + */ + deleteResolverRule(params: Route53Resolver.Types.DeleteResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverRuleResponse) => void): Request; + /** + * Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule. + */ + deleteResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.DeleteResolverRuleResponse) => void): Request; + /** + * Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address. To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress. + */ + disassociateResolverEndpointIpAddress(params: Route53Resolver.Types.DisassociateResolverEndpointIpAddressRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverEndpointIpAddressResponse) => void): Request; + /** + * Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address. To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress. + */ + disassociateResolverEndpointIpAddress(callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverEndpointIpAddressResponse) => void): Request; + /** + * Removes the association between a specified resolver rule and a specified VPC. If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule. + */ + disassociateResolverRule(params: Route53Resolver.Types.DisassociateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverRuleResponse) => void): Request; + /** + * Removes the association between a specified resolver rule and a specified VPC. If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule. + */ + disassociateResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.DisassociateResolverRuleResponse) => void): Request; + /** + * Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint. + */ + getResolverEndpoint(params: Route53Resolver.Types.GetResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverEndpointResponse) => void): Request; + /** + * Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint. + */ + getResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverEndpointResponse) => void): Request; + /** + * Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with. + */ + getResolverRule(params: Route53Resolver.Types.GetResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleResponse) => void): Request; + /** + * Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with. + */ + getResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleResponse) => void): Request; + /** + * Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule. + */ + getResolverRuleAssociation(params: Route53Resolver.Types.GetResolverRuleAssociationRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleAssociationResponse) => void): Request; + /** + * Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule. + */ + getResolverRuleAssociation(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRuleAssociationResponse) => void): Request; + /** + * Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use. + */ + getResolverRulePolicy(params: Route53Resolver.Types.GetResolverRulePolicyRequest, callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRulePolicyResponse) => void): Request; + /** + * Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use. + */ + getResolverRulePolicy(callback?: (err: AWSError, data: Route53Resolver.Types.GetResolverRulePolicyResponse) => void): Request; + /** + * Gets the IP addresses for a specified resolver endpoint. + */ + listResolverEndpointIpAddresses(params: Route53Resolver.Types.ListResolverEndpointIpAddressesRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointIpAddressesResponse) => void): Request; + /** + * Gets the IP addresses for a specified resolver endpoint. + */ + listResolverEndpointIpAddresses(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointIpAddressesResponse) => void): Request; + /** + * Lists all the resolver endpoints that were created using the current AWS account. + */ + listResolverEndpoints(params: Route53Resolver.Types.ListResolverEndpointsRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointsResponse) => void): Request; + /** + * Lists all the resolver endpoints that were created using the current AWS account. + */ + listResolverEndpoints(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverEndpointsResponse) => void): Request; + /** + * Lists the associations that were created between resolver rules and VPCs using the current AWS account. + */ + listResolverRuleAssociations(params: Route53Resolver.Types.ListResolverRuleAssociationsRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRuleAssociationsResponse) => void): Request; + /** + * Lists the associations that were created between resolver rules and VPCs using the current AWS account. + */ + listResolverRuleAssociations(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRuleAssociationsResponse) => void): Request; + /** + * Lists the resolver rules that were created using the current AWS account. + */ + listResolverRules(params: Route53Resolver.Types.ListResolverRulesRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRulesResponse) => void): Request; + /** + * Lists the resolver rules that were created using the current AWS account. + */ + listResolverRules(callback?: (err: AWSError, data: Route53Resolver.Types.ListResolverRulesResponse) => void): Request; + /** + * Lists the tags that you associated with the specified resource. + */ + listTagsForResource(params: Route53Resolver.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Route53Resolver.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the tags that you associated with the specified resource. + */ + listTagsForResource(callback?: (err: AWSError, data: Route53Resolver.Types.ListTagsForResourceResponse) => void): Request; + /** + * Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use. + */ + putResolverRulePolicy(params: Route53Resolver.Types.PutResolverRulePolicyRequest, callback?: (err: AWSError, data: Route53Resolver.Types.PutResolverRulePolicyResponse) => void): Request; + /** + * Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use. + */ + putResolverRulePolicy(callback?: (err: AWSError, data: Route53Resolver.Types.PutResolverRulePolicyResponse) => void): Request; + /** + * Adds one or more tags to a specified resource. + */ + tagResource(params: Route53Resolver.Types.TagResourceRequest, callback?: (err: AWSError, data: Route53Resolver.Types.TagResourceResponse) => void): Request; + /** + * Adds one or more tags to a specified resource. + */ + tagResource(callback?: (err: AWSError, data: Route53Resolver.Types.TagResourceResponse) => void): Request; + /** + * Removes one or more tags from a specified resource. + */ + untagResource(params: Route53Resolver.Types.UntagResourceRequest, callback?: (err: AWSError, data: Route53Resolver.Types.UntagResourceResponse) => void): Request; + /** + * Removes one or more tags from a specified resource. + */ + untagResource(callback?: (err: AWSError, data: Route53Resolver.Types.UntagResourceResponse) => void): Request; + /** + * Updates the name of an inbound or an outbound resolver endpoint. + */ + updateResolverEndpoint(params: Route53Resolver.Types.UpdateResolverEndpointRequest, callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverEndpointResponse) => void): Request; + /** + * Updates the name of an inbound or an outbound resolver endpoint. + */ + updateResolverEndpoint(callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverEndpointResponse) => void): Request; + /** + * Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value. + */ + updateResolverRule(params: Route53Resolver.Types.UpdateResolverRuleRequest, callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverRuleResponse) => void): Request; + /** + * Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value. + */ + updateResolverRule(callback?: (err: AWSError, data: Route53Resolver.Types.UpdateResolverRuleResponse) => void): Request; +} +declare namespace Route53Resolver { + export type AccountId = string; + export type Arn = string; + export interface AssociateResolverEndpointIpAddressRequest { + /** + * The ID of the resolver endpoint that you want to associate IP addresses with. + */ + ResolverEndpointId: ResourceId; + /** + * Either the IPv4 address that you want to add to a resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet. + */ + IpAddress: IpAddressUpdate; + } + export interface AssociateResolverEndpointIpAddressResponse { + /** + * The response to an AssociateResolverEndpointIpAddress request. + */ + ResolverEndpoint?: ResolverEndpoint; + } + export interface AssociateResolverRuleRequest { + /** + * The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use ListResolverRules. + */ + ResolverRuleId: ResourceId; + /** + * A name for the association that you're creating between a resolver rule and a VPC. + */ + Name?: Name; + /** + * The ID of the VPC that you want to associate the resolver rule with. + */ + VPCId: ResourceId; + } + export interface AssociateResolverRuleResponse { + /** + * Information about the AssociateResolverRule request, including the status of the request. + */ + ResolverRuleAssociation?: ResolverRuleAssociation; + } + export type Boolean = boolean; + export interface CreateResolverEndpointRequest { + /** + * A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId: CreatorRequestId; + /** + * A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console. + */ + Name?: Name; + /** + * The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound resolver endpoints) or outbound rules (for outbound resolver endpoints). + */ + SecurityGroupIds: SecurityGroupIds; + /** + * Specify the applicable value: INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC + */ + Direction: ResolverEndpointDirection; + /** + * The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound resolver endpoints). + */ + IpAddresses: IpAddressesRequest; + /** + * A list of the tag keys and values that you want to associate with the endpoint. + */ + Tags?: TagList; + } + export interface CreateResolverEndpointResponse { + /** + * Information about the CreateResolverEndpoint request, including the status of the request. + */ + ResolverEndpoint?: ResolverEndpoint; + } + export interface CreateResolverRuleRequest { + /** + * A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId: CreatorRequestId; + /** + * A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console. + */ + Name?: Name; + /** + * Specify FORWARD. Other resolver rule types aren't supported. + */ + RuleType: RuleTypeOption; + /** + * DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), outbound DNS queries are routed using the resolver rule that contains the most specific domain name (www.example.com). + */ + DomainName: DomainName; + /** + * The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma. + */ + TargetIps?: TargetList; + /** + * The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps. + */ + ResolverEndpointId?: ResourceId; + /** + * A list of the tag keys and values that you want to associate with the endpoint. + */ + Tags?: TagList; + } + export interface CreateResolverRuleResponse { + /** + * Information about the CreateResolverRule request, including the status of the request. + */ + ResolverRule?: ResolverRule; + } + export type CreatorRequestId = string; + export interface DeleteResolverEndpointRequest { + /** + * The ID of the resolver endpoint that you want to delete. + */ + ResolverEndpointId: ResourceId; + } + export interface DeleteResolverEndpointResponse { + /** + * Information about the DeleteResolverEndpoint request, including the status of the request. + */ + ResolverEndpoint?: ResolverEndpoint; + } + export interface DeleteResolverRuleRequest { + /** + * The ID of the resolver rule that you want to delete. + */ + ResolverRuleId: ResourceId; + } + export interface DeleteResolverRuleResponse { + /** + * Information about the DeleteResolverRule request, including the status of the request. + */ + ResolverRule?: ResolverRule; + } + export interface DisassociateResolverEndpointIpAddressRequest { + /** + * The ID of the resolver endpoint that you want to disassociate an IP address from. + */ + ResolverEndpointId: ResourceId; + /** + * The IPv4 address that you want to remove from a resolver endpoint. + */ + IpAddress: IpAddressUpdate; + } + export interface DisassociateResolverEndpointIpAddressResponse { + /** + * The response to an DisassociateResolverEndpointIpAddress request. + */ + ResolverEndpoint?: ResolverEndpoint; + } + export interface DisassociateResolverRuleRequest { + /** + * The ID of the VPC that you want to disassociate the resolver rule from. + */ + VPCId: ResourceId; + /** + * The ID of the resolver rule that you want to disassociate from the specified VPC. + */ + ResolverRuleId: ResourceId; + } + export interface DisassociateResolverRuleResponse { + /** + * Information about the DisassociateResolverRule request, including the status of the request. + */ + ResolverRuleAssociation?: ResolverRuleAssociation; + } + export type DomainName = string; + export interface Filter { + /** + * When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name. + */ + Name?: FilterName; + /** + * When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values. + */ + Values?: FilterValues; + } + export type FilterName = string; + export type FilterValue = string; + export type FilterValues = FilterValue[]; + export type Filters = Filter[]; + export interface GetResolverEndpointRequest { + /** + * The ID of the resolver endpoint that you want to get information about. + */ + ResolverEndpointId: ResourceId; + } + export interface GetResolverEndpointResponse { + /** + * Information about the resolver endpoint that you specified in a GetResolverEndpoint request. + */ + ResolverEndpoint?: ResolverEndpoint; + } + export interface GetResolverRuleAssociationRequest { + /** + * The ID of the resolver rule association that you want to get information about. + */ + ResolverRuleAssociationId: ResourceId; + } + export interface GetResolverRuleAssociationResponse { + /** + * Information about the resolver rule association that you specified in a GetResolverRuleAssociation request. + */ + ResolverRuleAssociation?: ResolverRuleAssociation; + } + export interface GetResolverRulePolicyRequest { + /** + * The ID of the resolver rule policy that you want to get information about. + */ + Arn: Arn; + } + export interface GetResolverRulePolicyResponse { + /** + * Information about the resolver rule policy that you specified in a GetResolverRulePolicy request. + */ + ResolverRulePolicy?: ResolverRulePolicy; + } + export interface GetResolverRuleRequest { + /** + * The ID of the resolver rule that you want to get information about. + */ + ResolverRuleId: ResourceId; + } + export interface GetResolverRuleResponse { + /** + * Information about the resolver rule that you specified in a GetResolverRule request. + */ + ResolverRule?: ResolverRule; + } + export type Ip = string; + export type IpAddressCount = number; + export interface IpAddressRequest { + /** + * The subnet that contains the IP address. + */ + SubnetId: SubnetId; + /** + * The IP address that you want to use for DNS queries. + */ + Ip?: Ip; + } + export interface IpAddressResponse { + /** + * The ID of one IP address. + */ + IpId?: ResourceId; + /** + * The ID of one subnet. + */ + SubnetId?: SubnetId; + /** + * One IP address that the resolver endpoint uses for DNS queries. + */ + Ip?: Ip; + /** + * A status code that gives the current status of the request. + */ + Status?: IpAddressStatus; + /** + * A message that provides additional information about the status of the request. + */ + StatusMessage?: StatusMessage; + /** + * The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC). + */ + CreationTime?: Rfc3339TimeString; + /** + * The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC). + */ + ModificationTime?: Rfc3339TimeString; + } + export type IpAddressStatus = "CREATING"|"FAILED_CREATION"|"ATTACHING"|"ATTACHED"|"REMAP_DETACHING"|"REMAP_ATTACHING"|"DETACHING"|"FAILED_RESOURCE_GONE"|"DELETING"|"DELETE_FAILED_FAS_EXPIRED"|string; + export interface IpAddressUpdate { + /** + * Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint. + */ + IpId?: ResourceId; + /** + * The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint. + */ + SubnetId?: SubnetId; + /** + * The new IP address. + */ + Ip?: Ip; + } + export type IpAddressesRequest = IpAddressRequest[]; + export type IpAddressesResponse = IpAddressResponse[]; + export interface ListResolverEndpointIpAddressesRequest { + /** + * The ID of the resolver endpoint that you want to get IP addresses for. + */ + ResolverEndpointId: ResourceId; + /** + * The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults, Resolver returns up to 100 IP addresses. + */ + MaxResults?: MaxResults; + /** + * For the first ListResolverEndpointIpAddresses request, omit this value. If the specified resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + } + export interface ListResolverEndpointIpAddressesResponse { + /** + * If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + /** + * The value that you specified for MaxResults in the request. + */ + MaxResults?: MaxResults; + /** + * The IP addresses that DNS queries pass through on their way to your network (outbound endpoint) or on the way to Resolver (inbound endpoint). + */ + IpAddresses?: IpAddressesResponse; + } + export interface ListResolverEndpointsRequest { + /** + * The maximum number of resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver endpoints. + */ + MaxResults?: MaxResults; + /** + * For the first ListResolverEndpoints request, omit this value. If you have more than MaxResults resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of resolver endpoints. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + /** + * An optional specification to return a subset of resolver endpoints, such as all inbound resolver endpoints. If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request. + */ + Filters?: Filters; + } + export interface ListResolverEndpointsResponse { + /** + * If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + /** + * The value that you specified for MaxResults in the request. + */ + MaxResults?: MaxResults; + /** + * The resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any. + */ + ResolverEndpoints?: ResolverEndpoints; + } + export interface ListResolverRuleAssociationsRequest { + /** + * The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 rule associations. + */ + MaxResults?: MaxResults; + /** + * For the first ListResolverRuleAssociation request, omit this value. If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + /** + * An optional specification to return a subset of resolver rules, such as resolver rules that are associated with the same VPC ID. If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request. + */ + Filters?: Filters; + } + export interface ListResolverRuleAssociationsResponse { + /** + * If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + /** + * The value that you specified for MaxResults in the request. + */ + MaxResults?: MaxResults; + /** + * The associations that were created between resolver rules and VPCs using the current AWS account, and that match the specified filters, if any. + */ + ResolverRuleAssociations?: ResolverRuleAssociations; + } + export interface ListResolverRulesRequest { + /** + * The maximum number of resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver rules. + */ + MaxResults?: MaxResults; + /** + * For the first ListResolverRules request, omit this value. If you have more than MaxResults resolver rules, you can submit another ListResolverRules request to get the next group of resolver rules. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + /** + * An optional specification to return a subset of resolver rules, such as all resolver rules that are associated with the same resolver endpoint. If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request. + */ + Filters?: Filters; + } + export interface ListResolverRulesResponse { + /** + * If more than MaxResults resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + /** + * The value that you specified for MaxResults in the request. + */ + MaxResults?: MaxResults; + /** + * The resolver rules that were created using the current AWS account and that match the specified filters, if any. + */ + ResolverRules?: ResolverRules; + } + export interface ListTagsForResourceRequest { + /** + * The Amazon Resource Name (ARN) for the resource that you want to list tags for. + */ + ResourceArn: Arn; + /** + * The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns up to 100 tags. + */ + MaxResults?: MaxResults; + /** + * For the first ListTagsForResource request, omit this value. If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceResponse { + /** + * The tags that are associated with the resource that you specified in the ListTagsForResource request. + */ + Tags?: TagList; + /** + * If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response. + */ + NextToken?: NextToken; + } + export type MaxResults = number; + export type Name = string; + export type NextToken = string; + export type Port = number; + export interface PutResolverRulePolicyRequest { + /** + * The Amazon Resource Name (ARN) of the account that you want to grant permissions to. + */ + Arn: Arn; + /** + * An AWS Identity and Access Management policy statement that lists the permissions that you want to grant to another AWS account. + */ + ResolverRulePolicy: ResolverRulePolicy; + } + export interface PutResolverRulePolicyResponse { + /** + * Whether the PutResolverRulePolicy request was successful. + */ + ReturnValue?: Boolean; + } + export interface ResolverEndpoint { + /** + * The ID of the resolver endpoint. + */ + Id?: ResourceId; + /** + * A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: CreatorRequestId; + /** + * The ARN (Amazon Resource Name) for the resolver endpoint. + */ + Arn?: Arn; + /** + * The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request. + */ + Name?: Name; + /** + * The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules. + */ + SecurityGroupIds?: SecurityGroupIds; + /** + * Indicates whether the resolver endpoint allows inbound or outbound DNS queries: INBOUND: allows DNS queries to your VPC from your network or another VPC OUTBOUND: allows DNS queries from your VPC to your network or another VPC + */ + Direction?: ResolverEndpointDirection; + /** + * The number of IP addresses that the resolver endpoint can use for DNS queries. + */ + IpAddressCount?: IpAddressCount; + /** + * The ID of the VPC that you want to create the resolver endpoint in. + */ + HostVPCId?: ResourceId; + /** + * A code that specifies the current status of the resolver endpoint. + */ + Status?: ResolverEndpointStatus; + /** + * A detailed description of the status of the resolver endpoint. + */ + StatusMessage?: StatusMessage; + /** + * The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC). + */ + CreationTime?: Rfc3339TimeString; + /** + * The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC). + */ + ModificationTime?: Rfc3339TimeString; + } + export type ResolverEndpointDirection = "INBOUND"|"OUTBOUND"|string; + export type ResolverEndpointStatus = "CREATING"|"OPERATIONAL"|"UPDATING"|"AUTO_RECOVERING"|"ACTION_NEEDED"|"DELETING"|string; + export type ResolverEndpoints = ResolverEndpoint[]; + export interface ResolverRule { + /** + * The ID that Resolver assigned to the resolver rule when you created it. + */ + Id?: ResourceId; + /** + * A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice. + */ + CreatorRequestId?: CreatorRequestId; + /** + * The ARN (Amazon Resource Name) for the resolver rule specified by Id. + */ + Arn?: Arn; + /** + * DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), the query is routed using the resolver rule that contains the most specific domain name (www.example.com). + */ + DomainName?: DomainName; + /** + * A code that specifies the current status of the resolver rule. + */ + Status?: ResolverRuleStatus; + /** + * A detailed description of the status of a resolver rule. + */ + StatusMessage?: StatusMessage; + /** + * This value is always FORWARD. Other resolver rule types aren't supported. + */ + RuleType?: RuleTypeOption; + /** + * The name for the resolver rule, which you specified when you created the resolver rule. + */ + Name?: Name; + /** + * An array that contains the IP addresses and ports that you want to forward + */ + TargetIps?: TargetList; + /** + * The ID of the endpoint that the rule is associated with. + */ + ResolverEndpointId?: ResourceId; + /** + * When a rule is shared with another AWS account, the account ID of the account that the rule is shared with. + */ + OwnerId?: AccountId; + /** + * Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account. + */ + ShareStatus?: ShareStatus; + } + export interface ResolverRuleAssociation { + /** + * The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request. + */ + Id?: ResourceId; + /** + * The ID of the resolver rule that you associated with the VPC that is specified by VPCId. + */ + ResolverRuleId?: ResourceId; + /** + * The name of an association between a resolver rule and a VPC. + */ + Name?: Name; + /** + * The ID of the VPC that you associated the resolver rule with. + */ + VPCId?: ResourceId; + /** + * A code that specifies the current status of the association between a resolver rule and a VPC. + */ + Status?: ResolverRuleAssociationStatus; + /** + * A detailed description of the status of the association between a resolver rule and a VPC. + */ + StatusMessage?: StatusMessage; + } + export type ResolverRuleAssociationStatus = "CREATING"|"COMPLETE"|"DELETING"|"FAILED"|"OVERRIDDEN"|string; + export type ResolverRuleAssociations = ResolverRuleAssociation[]; + export interface ResolverRuleConfig { + /** + * The new name for the resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console. + */ + Name?: Name; + /** + * For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to. + */ + TargetIps?: TargetList; + /** + * The ID of the new outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps. + */ + ResolverEndpointId?: ResourceId; + } + export type ResolverRulePolicy = string; + export type ResolverRuleStatus = "COMPLETE"|"DELETING"|"UPDATING"|"FAILED"|string; + export type ResolverRules = ResolverRule[]; + export type ResourceId = string; + export type Rfc3339TimeString = string; + export type RuleTypeOption = "FORWARD"|"SYSTEM"|"RECURSIVE"|string; + export type SecurityGroupIds = ResourceId[]; + export type ShareStatus = "NOT_SHARED"|"SHARED_WITH_ME"|"SHARED_BY_ME"|string; + export type StatusMessage = string; + export type SubnetId = string; + export interface Tag { + /** + * The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id. + */ + Key?: TagKey; + /** + * The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command: GetResolverEndpoint GetResolverRule GetResolverRuleAssociation ListResolverEndpoints ListResolverRuleAssociations ListResolverRules + */ + ResourceArn: Arn; + /** + * The tags that you want to add to the specified resource. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export interface TargetAddress { + /** + * One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses. + */ + Ip: Ip; + /** + * The port at Ip that you want to forward DNS queries to. + */ + Port?: Port; + } + export type TargetList = TargetAddress[]; + export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command: GetResolverEndpoint GetResolverRule GetResolverRuleAssociation ListResolverEndpoints ListResolverRuleAssociations ListResolverRules + */ + ResourceArn: Arn; + /** + * The tags that you want to remove to the specified resource. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export interface UpdateResolverEndpointRequest { + /** + * The ID of the resolver endpoint that you want to update. + */ + ResolverEndpointId: ResourceId; + /** + * The name of the resolver endpoint that you want to update. + */ + Name?: Name; + } + export interface UpdateResolverEndpointResponse { + /** + * The response to an UpdateResolverEndpoint request. + */ + ResolverEndpoint?: ResolverEndpoint; + } + export interface UpdateResolverRuleRequest { + /** + * The ID of the resolver rule that you want to update. + */ + ResolverRuleId: ResourceId; + /** + * The new settings for the resolver rule. + */ + Config: ResolverRuleConfig; + } + export interface UpdateResolverRuleResponse { + /** + * The response to an UpdateResolverRule request. + */ + ResolverRule?: ResolverRule; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-04-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Route53Resolver client. + */ + export import Types = Route53Resolver; +} +export = Route53Resolver; diff --git a/node_modules/aws-sdk/clients/route53resolver.js b/node_modules/aws-sdk/clients/route53resolver.js new file mode 100644 index 0000000..4330004 --- /dev/null +++ b/node_modules/aws-sdk/clients/route53resolver.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['route53resolver'] = {}; +AWS.Route53Resolver = Service.defineService('route53resolver', ['2018-04-01']); +Object.defineProperty(apiLoader.services['route53resolver'], '2018-04-01', { + get: function get() { + var model = require('../apis/route53resolver-2018-04-01.min.json'); + model.paginators = require('../apis/route53resolver-2018-04-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Route53Resolver; diff --git a/node_modules/aws-sdk/clients/s3.d.ts b/node_modules/aws-sdk/clients/s3.d.ts new file mode 100644 index 0000000..10d878b --- /dev/null +++ b/node_modules/aws-sdk/clients/s3.d.ts @@ -0,0 +1,5066 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {S3Customizations} from '../lib/services/s3'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {UseDualstackConfigOptions} from '../lib/config_use_dualstack'; +import {EventStream} from '../lib/event-stream/event-stream'; +import {ManagedUpload as managed_upload} from '../lib/s3/managed_upload'; +import {PresignedPost as presigned_post} from '../lib/s3/presigned_post'; +import {Readable} from 'stream'; +interface Blob {} +declare class S3 extends S3Customizations { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: S3.Types.ClientConfiguration) + config: Config & S3.Types.ClientConfiguration; + /** + * Aborts a multipart upload. To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. + */ + abortMultipartUpload(params: S3.Types.AbortMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.AbortMultipartUploadOutput) => void): Request; + /** + * Aborts a multipart upload. To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. + */ + abortMultipartUpload(callback?: (err: AWSError, data: S3.Types.AbortMultipartUploadOutput) => void): Request; + /** + * Completes a multipart upload by assembling previously uploaded parts. + */ + completeMultipartUpload(params: S3.Types.CompleteMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.CompleteMultipartUploadOutput) => void): Request; + /** + * Completes a multipart upload by assembling previously uploaded parts. + */ + completeMultipartUpload(callback?: (err: AWSError, data: S3.Types.CompleteMultipartUploadOutput) => void): Request; + /** + * Creates a copy of an object that is already stored in Amazon S3. + */ + copyObject(params: S3.Types.CopyObjectRequest, callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request; + /** + * Creates a copy of an object that is already stored in Amazon S3. + */ + copyObject(callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request; + /** + * Creates a new bucket. + */ + createBucket(params: S3.Types.CreateBucketRequest, callback?: (err: AWSError, data: S3.Types.CreateBucketOutput) => void): Request; + /** + * Creates a new bucket. + */ + createBucket(callback?: (err: AWSError, data: S3.Types.CreateBucketOutput) => void): Request; + /** + * Initiates a multipart upload and returns an upload ID. Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. + */ + createMultipartUpload(params: S3.Types.CreateMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request; + /** + * Initiates a multipart upload and returns an upload ID. Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. + */ + createMultipartUpload(callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request; + /** + * Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted. + */ + deleteBucket(params: S3.Types.DeleteBucketRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted. + */ + deleteBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). + */ + deleteBucketAnalyticsConfiguration(params: S3.Types.DeleteBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). + */ + deleteBucketAnalyticsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the CORS configuration information set for the bucket. + */ + deleteBucketCors(params: S3.Types.DeleteBucketCorsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the CORS configuration information set for the bucket. + */ + deleteBucketCors(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the server-side encryption configuration from the bucket. + */ + deleteBucketEncryption(params: S3.Types.DeleteBucketEncryptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the server-side encryption configuration from the bucket. + */ + deleteBucketEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an inventory configuration (identified by the inventory ID) from the bucket. + */ + deleteBucketInventoryConfiguration(params: S3.Types.DeleteBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an inventory configuration (identified by the inventory ID) from the bucket. + */ + deleteBucketInventoryConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the lifecycle configuration from the bucket. + */ + deleteBucketLifecycle(params: S3.Types.DeleteBucketLifecycleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the lifecycle configuration from the bucket. + */ + deleteBucketLifecycle(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. + */ + deleteBucketMetricsConfiguration(params: S3.Types.DeleteBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. + */ + deleteBucketMetricsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the policy from the bucket. + */ + deleteBucketPolicy(params: S3.Types.DeleteBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the policy from the bucket. + */ + deleteBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide. + */ + deleteBucketReplication(params: S3.Types.DeleteBucketReplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide. + */ + deleteBucketReplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the tags from the bucket. + */ + deleteBucketTagging(params: S3.Types.DeleteBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the tags from the bucket. + */ + deleteBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation removes the website configuration from the bucket. + */ + deleteBucketWebsite(params: S3.Types.DeleteBucketWebsiteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation removes the website configuration from the bucket. + */ + deleteBucketWebsite(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. + */ + deleteObject(params: S3.Types.DeleteObjectRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectOutput) => void): Request; + /** + * Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. + */ + deleteObject(callback?: (err: AWSError, data: S3.Types.DeleteObjectOutput) => void): Request; + /** + * Removes the tag-set from an existing object. + */ + deleteObjectTagging(params: S3.Types.DeleteObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectTaggingOutput) => void): Request; + /** + * Removes the tag-set from an existing object. + */ + deleteObjectTagging(callback?: (err: AWSError, data: S3.Types.DeleteObjectTaggingOutput) => void): Request; + /** + * This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys. + */ + deleteObjects(params: S3.Types.DeleteObjectsRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectsOutput) => void): Request; + /** + * This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys. + */ + deleteObjects(callback?: (err: AWSError, data: S3.Types.DeleteObjectsOutput) => void): Request; + /** + * Removes the PublicAccessBlock configuration from an Amazon S3 bucket. + */ + deletePublicAccessBlock(params: S3.Types.DeletePublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the PublicAccessBlock configuration from an Amazon S3 bucket. + */ + deletePublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns the accelerate configuration of a bucket. + */ + getBucketAccelerateConfiguration(params: S3.Types.GetBucketAccelerateConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAccelerateConfigurationOutput) => void): Request; + /** + * Returns the accelerate configuration of a bucket. + */ + getBucketAccelerateConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketAccelerateConfigurationOutput) => void): Request; + /** + * Gets the access control policy for the bucket. + */ + getBucketAcl(params: S3.Types.GetBucketAclRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAclOutput) => void): Request; + /** + * Gets the access control policy for the bucket. + */ + getBucketAcl(callback?: (err: AWSError, data: S3.Types.GetBucketAclOutput) => void): Request; + /** + * Gets an analytics configuration for the bucket (specified by the analytics configuration ID). + */ + getBucketAnalyticsConfiguration(params: S3.Types.GetBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAnalyticsConfigurationOutput) => void): Request; + /** + * Gets an analytics configuration for the bucket (specified by the analytics configuration ID). + */ + getBucketAnalyticsConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketAnalyticsConfigurationOutput) => void): Request; + /** + * Returns the CORS configuration for the bucket. + */ + getBucketCors(params: S3.Types.GetBucketCorsRequest, callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request; + /** + * Returns the CORS configuration for the bucket. + */ + getBucketCors(callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request; + /** + * Returns the server-side encryption configuration of a bucket. + */ + getBucketEncryption(params: S3.Types.GetBucketEncryptionRequest, callback?: (err: AWSError, data: S3.Types.GetBucketEncryptionOutput) => void): Request; + /** + * Returns the server-side encryption configuration of a bucket. + */ + getBucketEncryption(callback?: (err: AWSError, data: S3.Types.GetBucketEncryptionOutput) => void): Request; + /** + * Returns an inventory configuration (identified by the inventory ID) from the bucket. + */ + getBucketInventoryConfiguration(params: S3.Types.GetBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketInventoryConfigurationOutput) => void): Request; + /** + * Returns an inventory configuration (identified by the inventory ID) from the bucket. + */ + getBucketInventoryConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketInventoryConfigurationOutput) => void): Request; + /** + * No longer used, see the GetBucketLifecycleConfiguration operation. + */ + getBucketLifecycle(params: S3.Types.GetBucketLifecycleRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleOutput) => void): Request; + /** + * No longer used, see the GetBucketLifecycleConfiguration operation. + */ + getBucketLifecycle(callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleOutput) => void): Request; + /** + * Returns the lifecycle configuration information set on the bucket. + */ + getBucketLifecycleConfiguration(params: S3.Types.GetBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleConfigurationOutput) => void): Request; + /** + * Returns the lifecycle configuration information set on the bucket. + */ + getBucketLifecycleConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleConfigurationOutput) => void): Request; + /** + * Returns the region the bucket resides in. + */ + getBucketLocation(params: S3.Types.GetBucketLocationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLocationOutput) => void): Request; + /** + * Returns the region the bucket resides in. + */ + getBucketLocation(callback?: (err: AWSError, data: S3.Types.GetBucketLocationOutput) => void): Request; + /** + * Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. + */ + getBucketLogging(params: S3.Types.GetBucketLoggingRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLoggingOutput) => void): Request; + /** + * Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. + */ + getBucketLogging(callback?: (err: AWSError, data: S3.Types.GetBucketLoggingOutput) => void): Request; + /** + * Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. + */ + getBucketMetricsConfiguration(params: S3.Types.GetBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketMetricsConfigurationOutput) => void): Request; + /** + * Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. + */ + getBucketMetricsConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketMetricsConfigurationOutput) => void): Request; + /** + * No longer used, see the GetBucketNotificationConfiguration operation. + */ + getBucketNotification(params: S3.Types.GetBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: S3.Types.NotificationConfigurationDeprecated) => void): Request; + /** + * No longer used, see the GetBucketNotificationConfiguration operation. + */ + getBucketNotification(callback?: (err: AWSError, data: S3.Types.NotificationConfigurationDeprecated) => void): Request; + /** + * Returns the notification configuration of a bucket. + */ + getBucketNotificationConfiguration(params: S3.Types.GetBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: S3.Types.NotificationConfiguration) => void): Request; + /** + * Returns the notification configuration of a bucket. + */ + getBucketNotificationConfiguration(callback?: (err: AWSError, data: S3.Types.NotificationConfiguration) => void): Request; + /** + * Returns the policy of a specified bucket. + */ + getBucketPolicy(params: S3.Types.GetBucketPolicyRequest, callback?: (err: AWSError, data: S3.Types.GetBucketPolicyOutput) => void): Request; + /** + * Returns the policy of a specified bucket. + */ + getBucketPolicy(callback?: (err: AWSError, data: S3.Types.GetBucketPolicyOutput) => void): Request; + /** + * Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. + */ + getBucketPolicyStatus(params: S3.Types.GetBucketPolicyStatusRequest, callback?: (err: AWSError, data: S3.Types.GetBucketPolicyStatusOutput) => void): Request; + /** + * Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. + */ + getBucketPolicyStatus(callback?: (err: AWSError, data: S3.Types.GetBucketPolicyStatusOutput) => void): Request; + /** + * Returns the replication configuration of a bucket. It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. + */ + getBucketReplication(params: S3.Types.GetBucketReplicationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketReplicationOutput) => void): Request; + /** + * Returns the replication configuration of a bucket. It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. + */ + getBucketReplication(callback?: (err: AWSError, data: S3.Types.GetBucketReplicationOutput) => void): Request; + /** + * Returns the request payment configuration of a bucket. + */ + getBucketRequestPayment(params: S3.Types.GetBucketRequestPaymentRequest, callback?: (err: AWSError, data: S3.Types.GetBucketRequestPaymentOutput) => void): Request; + /** + * Returns the request payment configuration of a bucket. + */ + getBucketRequestPayment(callback?: (err: AWSError, data: S3.Types.GetBucketRequestPaymentOutput) => void): Request; + /** + * Returns the tag set associated with the bucket. + */ + getBucketTagging(params: S3.Types.GetBucketTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request; + /** + * Returns the tag set associated with the bucket. + */ + getBucketTagging(callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request; + /** + * Returns the versioning state of a bucket. + */ + getBucketVersioning(params: S3.Types.GetBucketVersioningRequest, callback?: (err: AWSError, data: S3.Types.GetBucketVersioningOutput) => void): Request; + /** + * Returns the versioning state of a bucket. + */ + getBucketVersioning(callback?: (err: AWSError, data: S3.Types.GetBucketVersioningOutput) => void): Request; + /** + * Returns the website configuration for a bucket. + */ + getBucketWebsite(params: S3.Types.GetBucketWebsiteRequest, callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request; + /** + * Returns the website configuration for a bucket. + */ + getBucketWebsite(callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request; + /** + * Retrieves objects from Amazon S3. + */ + getObject(params: S3.Types.GetObjectRequest, callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request; + /** + * Retrieves objects from Amazon S3. + */ + getObject(callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request; + /** + * Returns the access control list (ACL) of an object. + */ + getObjectAcl(params: S3.Types.GetObjectAclRequest, callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request; + /** + * Returns the access control list (ACL) of an object. + */ + getObjectAcl(callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request; + /** + * Gets an object's current Legal Hold status. + */ + getObjectLegalHold(params: S3.Types.GetObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request; + /** + * Gets an object's current Legal Hold status. + */ + getObjectLegalHold(callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request; + /** + * Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. + */ + getObjectLockConfiguration(params: S3.Types.GetObjectLockConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request; + /** + * Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. + */ + getObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request; + /** + * Retrieves an object's retention settings. + */ + getObjectRetention(params: S3.Types.GetObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request; + /** + * Retrieves an object's retention settings. + */ + getObjectRetention(callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request; + /** + * Returns the tag-set of an object. + */ + getObjectTagging(params: S3.Types.GetObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request; + /** + * Returns the tag-set of an object. + */ + getObjectTagging(callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request; + /** + * Return torrent files from a bucket. + */ + getObjectTorrent(params: S3.Types.GetObjectTorrentRequest, callback?: (err: AWSError, data: S3.Types.GetObjectTorrentOutput) => void): Request; + /** + * Return torrent files from a bucket. + */ + getObjectTorrent(callback?: (err: AWSError, data: S3.Types.GetObjectTorrentOutput) => void): Request; + /** + * Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. + */ + getPublicAccessBlock(params: S3.Types.GetPublicAccessBlockRequest, callback?: (err: AWSError, data: S3.Types.GetPublicAccessBlockOutput) => void): Request; + /** + * Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. + */ + getPublicAccessBlock(callback?: (err: AWSError, data: S3.Types.GetPublicAccessBlockOutput) => void): Request; + /** + * This operation is useful to determine if a bucket exists and you have permission to access it. + */ + headBucket(params: S3.Types.HeadBucketRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * This operation is useful to determine if a bucket exists and you have permission to access it. + */ + headBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. + */ + headObject(params: S3.Types.HeadObjectRequest, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request; + /** + * The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. + */ + headObject(callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request; + /** + * Lists the analytics configurations for the bucket. + */ + listBucketAnalyticsConfigurations(params: S3.Types.ListBucketAnalyticsConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketAnalyticsConfigurationsOutput) => void): Request; + /** + * Lists the analytics configurations for the bucket. + */ + listBucketAnalyticsConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketAnalyticsConfigurationsOutput) => void): Request; + /** + * Returns a list of inventory configurations for the bucket. + */ + listBucketInventoryConfigurations(params: S3.Types.ListBucketInventoryConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketInventoryConfigurationsOutput) => void): Request; + /** + * Returns a list of inventory configurations for the bucket. + */ + listBucketInventoryConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketInventoryConfigurationsOutput) => void): Request; + /** + * Lists the metrics configurations for the bucket. + */ + listBucketMetricsConfigurations(params: S3.Types.ListBucketMetricsConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketMetricsConfigurationsOutput) => void): Request; + /** + * Lists the metrics configurations for the bucket. + */ + listBucketMetricsConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketMetricsConfigurationsOutput) => void): Request; + /** + * Returns a list of all buckets owned by the authenticated sender of the request. + */ + listBuckets(callback?: (err: AWSError, data: S3.Types.ListBucketsOutput) => void): Request; + /** + * This operation lists in-progress multipart uploads. + */ + listMultipartUploads(params: S3.Types.ListMultipartUploadsRequest, callback?: (err: AWSError, data: S3.Types.ListMultipartUploadsOutput) => void): Request; + /** + * This operation lists in-progress multipart uploads. + */ + listMultipartUploads(callback?: (err: AWSError, data: S3.Types.ListMultipartUploadsOutput) => void): Request; + /** + * Returns metadata about all of the versions of objects in a bucket. + */ + listObjectVersions(params: S3.Types.ListObjectVersionsRequest, callback?: (err: AWSError, data: S3.Types.ListObjectVersionsOutput) => void): Request; + /** + * Returns metadata about all of the versions of objects in a bucket. + */ + listObjectVersions(callback?: (err: AWSError, data: S3.Types.ListObjectVersionsOutput) => void): Request; + /** + * Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. + */ + listObjects(params: S3.Types.ListObjectsRequest, callback?: (err: AWSError, data: S3.Types.ListObjectsOutput) => void): Request; + /** + * Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. + */ + listObjects(callback?: (err: AWSError, data: S3.Types.ListObjectsOutput) => void): Request; + /** + * Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development. + */ + listObjectsV2(params: S3.Types.ListObjectsV2Request, callback?: (err: AWSError, data: S3.Types.ListObjectsV2Output) => void): Request; + /** + * Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development. + */ + listObjectsV2(callback?: (err: AWSError, data: S3.Types.ListObjectsV2Output) => void): Request; + /** + * Lists the parts that have been uploaded for a specific multipart upload. + */ + listParts(params: S3.Types.ListPartsRequest, callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request; + /** + * Lists the parts that have been uploaded for a specific multipart upload. + */ + listParts(callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request; + /** + * Sets the accelerate configuration of an existing bucket. + */ + putBucketAccelerateConfiguration(params: S3.Types.PutBucketAccelerateConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the accelerate configuration of an existing bucket. + */ + putBucketAccelerateConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the permissions on a bucket using access control lists (ACL). + */ + putBucketAcl(params: S3.Types.PutBucketAclRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the permissions on a bucket using access control lists (ACL). + */ + putBucketAcl(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets an analytics configuration for the bucket (specified by the analytics configuration ID). + */ + putBucketAnalyticsConfiguration(params: S3.Types.PutBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets an analytics configuration for the bucket (specified by the analytics configuration ID). + */ + putBucketAnalyticsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the CORS configuration for a bucket. + */ + putBucketCors(params: S3.Types.PutBucketCorsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the CORS configuration for a bucket. + */ + putBucketCors(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new server-side encryption configuration (or replaces an existing one, if present). + */ + putBucketEncryption(params: S3.Types.PutBucketEncryptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new server-side encryption configuration (or replaces an existing one, if present). + */ + putBucketEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds an inventory configuration (identified by the inventory ID) from the bucket. + */ + putBucketInventoryConfiguration(params: S3.Types.PutBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds an inventory configuration (identified by the inventory ID) from the bucket. + */ + putBucketInventoryConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * No longer used, see the PutBucketLifecycleConfiguration operation. + */ + putBucketLifecycle(params: S3.Types.PutBucketLifecycleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * No longer used, see the PutBucketLifecycleConfiguration operation. + */ + putBucketLifecycle(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. + */ + putBucketLifecycleConfiguration(params: S3.Types.PutBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. + */ + putBucketLifecycleConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner. + */ + putBucketLogging(params: S3.Types.PutBucketLoggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner. + */ + putBucketLogging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. + */ + putBucketMetricsConfiguration(params: S3.Types.PutBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. + */ + putBucketMetricsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * No longer used, see the PutBucketNotificationConfiguration operation. + */ + putBucketNotification(params: S3.Types.PutBucketNotificationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * No longer used, see the PutBucketNotificationConfiguration operation. + */ + putBucketNotification(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables notifications of specified events for a bucket. + */ + putBucketNotificationConfiguration(params: S3.Types.PutBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables notifications of specified events for a bucket. + */ + putBucketNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. + */ + putBucketPolicy(params: S3.Types.PutBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. + */ + putBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide. + */ + putBucketReplication(params: S3.Types.PutBucketReplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide. + */ + putBucketReplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html + */ + putBucketRequestPayment(params: S3.Types.PutBucketRequestPaymentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html + */ + putBucketRequestPayment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the tags for a bucket. + */ + putBucketTagging(params: S3.Types.PutBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the tags for a bucket. + */ + putBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. + */ + putBucketVersioning(params: S3.Types.PutBucketVersioningRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. + */ + putBucketVersioning(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Set the website configuration for a bucket. + */ + putBucketWebsite(params: S3.Types.PutBucketWebsiteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Set the website configuration for a bucket. + */ + putBucketWebsite(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds an object to a bucket. + */ + putObject(params: S3.Types.PutObjectRequest, callback?: (err: AWSError, data: S3.Types.PutObjectOutput) => void): Request; + /** + * Adds an object to a bucket. + */ + putObject(callback?: (err: AWSError, data: S3.Types.PutObjectOutput) => void): Request; + /** + * uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket + */ + putObjectAcl(params: S3.Types.PutObjectAclRequest, callback?: (err: AWSError, data: S3.Types.PutObjectAclOutput) => void): Request; + /** + * uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket + */ + putObjectAcl(callback?: (err: AWSError, data: S3.Types.PutObjectAclOutput) => void): Request; + /** + * Applies a Legal Hold configuration to the specified object. + */ + putObjectLegalHold(params: S3.Types.PutObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request; + /** + * Applies a Legal Hold configuration to the specified object. + */ + putObjectLegalHold(callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request; + /** + * Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. + */ + putObjectLockConfiguration(params: S3.Types.PutObjectLockConfigurationRequest, callback?: (err: AWSError, data: S3.Types.PutObjectLockConfigurationOutput) => void): Request; + /** + * Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. + */ + putObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.PutObjectLockConfigurationOutput) => void): Request; + /** + * Places an Object Retention configuration on an object. + */ + putObjectRetention(params: S3.Types.PutObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request; + /** + * Places an Object Retention configuration on an object. + */ + putObjectRetention(callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request; + /** + * Sets the supplied tag-set to an object that already exists in a bucket + */ + putObjectTagging(params: S3.Types.PutObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.PutObjectTaggingOutput) => void): Request; + /** + * Sets the supplied tag-set to an object that already exists in a bucket + */ + putObjectTagging(callback?: (err: AWSError, data: S3.Types.PutObjectTaggingOutput) => void): Request; + /** + * Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. + */ + putPublicAccessBlock(params: S3.Types.PutPublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. + */ + putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Restores an archived copy of an object back into Amazon S3 + */ + restoreObject(params: S3.Types.RestoreObjectRequest, callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request; + /** + * Restores an archived copy of an object back into Amazon S3 + */ + restoreObject(callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request; + /** + * This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. + */ + selectObjectContent(params: S3.Types.SelectObjectContentRequest, callback?: (err: AWSError, data: S3.Types.SelectObjectContentOutput) => void): Request; + /** + * This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. + */ + selectObjectContent(callback?: (err: AWSError, data: S3.Types.SelectObjectContentOutput) => void): Request; + /** + * Uploads a part in a multipart upload. Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. + */ + uploadPart(params: S3.Types.UploadPartRequest, callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request; + /** + * Uploads a part in a multipart upload. Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. + */ + uploadPart(callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request; + /** + * Uploads a part by copying data from an existing object as data source. + */ + uploadPartCopy(params: S3.Types.UploadPartCopyRequest, callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request; + /** + * Uploads a part by copying data from an existing object as data source. + */ + uploadPartCopy(callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request; + /** + * Waits for the bucketExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "bucketExists", params: S3.Types.HeadBucketRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the bucketExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "bucketExists", callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the bucketNotExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "bucketNotExists", params: S3.Types.HeadBucketRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the bucketNotExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "bucketNotExists", callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Waits for the objectExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "objectExists", params: S3.Types.HeadObjectRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request; + /** + * Waits for the objectExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "objectExists", callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request; + /** + * Waits for the objectNotExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "objectNotExists", params: S3.Types.HeadObjectRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request; + /** + * Waits for the objectNotExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times). + */ + waitFor(state: "objectNotExists", callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request; +} +declare namespace S3 { + export import ManagedUpload = managed_upload; + export import PresignedPost = presigned_post; +} +declare namespace S3 { + export type AbortDate = Date; + export interface AbortIncompleteMultipartUpload { + /** + * Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload. + */ + DaysAfterInitiation?: DaysAfterInitiation; + } + export interface AbortMultipartUploadOutput { + RequestCharged?: RequestCharged; + } + export interface AbortMultipartUploadRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * + */ + UploadId: MultipartUploadId; + RequestPayer?: RequestPayer; + } + export type AbortRuleId = string; + export interface AccelerateConfiguration { + /** + * The accelerate configuration of the bucket. + */ + Status?: BucketAccelerateStatus; + } + export type AcceptRanges = string; + export interface AccessControlPolicy { + /** + * A list of grants. + */ + Grants?: Grants; + /** + * + */ + Owner?: Owner; + } + export interface AccessControlTranslation { + /** + * The override value for the owner of the replica object. + */ + Owner: OwnerOverride; + } + export type AccountId = string; + export type AllowQuotedRecordDelimiter = boolean; + export type AllowedHeader = string; + export type AllowedHeaders = AllowedHeader[]; + export type AllowedMethod = string; + export type AllowedMethods = AllowedMethod[]; + export type AllowedOrigin = string; + export type AllowedOrigins = AllowedOrigin[]; + export interface AnalyticsAndOperator { + /** + * The prefix to use when evaluating an AND predicate. + */ + Prefix?: Prefix; + /** + * The list of tags to use when evaluating an AND predicate. + */ + Tags?: TagSet; + } + export interface AnalyticsConfiguration { + /** + * The identifier used to represent an analytics configuration. + */ + Id: AnalyticsId; + /** + * The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis. + */ + Filter?: AnalyticsFilter; + /** + * If present, it indicates that data related to access patterns will be collected and made available to analyze the tradeoffs between different storage classes. + */ + StorageClassAnalysis: StorageClassAnalysis; + } + export type AnalyticsConfigurationList = AnalyticsConfiguration[]; + export interface AnalyticsExportDestination { + /** + * A destination signifying output to an S3 bucket. + */ + S3BucketDestination: AnalyticsS3BucketDestination; + } + export interface AnalyticsFilter { + /** + * The prefix to use when evaluating an analytics filter. + */ + Prefix?: Prefix; + /** + * The tag to use when evaluating an analytics filter. + */ + Tag?: Tag; + /** + * A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates. + */ + And?: AnalyticsAndOperator; + } + export type AnalyticsId = string; + export interface AnalyticsS3BucketDestination { + /** + * The file format used when exporting data to Amazon S3. + */ + Format: AnalyticsS3ExportFileFormat; + /** + * The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. + */ + BucketAccountId?: AccountId; + /** + * The Amazon resource name (ARN) of the bucket to which data is exported. + */ + Bucket: BucketName; + /** + * The prefix to use when exporting data. The exported data begins with this prefix. + */ + Prefix?: Prefix; + } + export type AnalyticsS3ExportFileFormat = "CSV"|string; + export type Body = Buffer|Uint8Array|Blob|string|Readable; + export interface Bucket { + /** + * The name of the bucket. + */ + Name?: BucketName; + /** + * Date the bucket was created. + */ + CreationDate?: CreationDate; + } + export type BucketAccelerateStatus = "Enabled"|"Suspended"|string; + export type BucketCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|string; + export interface BucketLifecycleConfiguration { + /** + * + */ + Rules: LifecycleRules; + } + export type BucketLocationConstraint = "EU"|"eu-west-1"|"us-west-1"|"us-west-2"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"sa-east-1"|"cn-north-1"|"eu-central-1"|string; + export interface BucketLoggingStatus { + LoggingEnabled?: LoggingEnabled; + } + export type BucketLogsPermission = "FULL_CONTROL"|"READ"|"WRITE"|string; + export type BucketName = string; + export type BucketVersioningStatus = "Enabled"|"Suspended"|string; + export type Buckets = Bucket[]; + export type BypassGovernanceRetention = boolean; + export type BytesProcessed = number; + export type BytesReturned = number; + export type BytesScanned = number; + export interface CORSConfiguration { + /** + * + */ + CORSRules: CORSRules; + } + export interface CORSRule { + /** + * Specifies which headers are allowed in a pre-flight OPTIONS request. + */ + AllowedHeaders?: AllowedHeaders; + /** + * Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute. + */ + AllowedMethods: AllowedMethods; + /** + * One or more origins you want customers to be able to access the bucket from. + */ + AllowedOrigins: AllowedOrigins; + /** + * One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object). + */ + ExposeHeaders?: ExposeHeaders; + /** + * The time in seconds that your browser is to cache the preflight response for the specified resource. + */ + MaxAgeSeconds?: MaxAgeSeconds; + } + export type CORSRules = CORSRule[]; + export interface CSVInput { + /** + * Describes the first line of input. Valid values: None, Ignore, Use. + */ + FileHeaderInfo?: FileHeaderInfo; + /** + * The single character used to indicate a row should be ignored when present at the start of a row. + */ + Comments?: Comments; + /** + * The single character used for escaping the quote character inside an already escaped value. + */ + QuoteEscapeCharacter?: QuoteEscapeCharacter; + /** + * The value used to separate individual records. + */ + RecordDelimiter?: RecordDelimiter; + /** + * The value used to separate individual fields in a record. + */ + FieldDelimiter?: FieldDelimiter; + /** + * Value used for escaping where the field delimiter is part of the value. + */ + QuoteCharacter?: QuoteCharacter; + /** + * Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance. + */ + AllowQuotedRecordDelimiter?: AllowQuotedRecordDelimiter; + } + export interface CSVOutput { + /** + * Indicates whether or not all output fields should be quoted. + */ + QuoteFields?: QuoteFields; + /** + * Th single character used for escaping the quote character inside an already escaped value. + */ + QuoteEscapeCharacter?: QuoteEscapeCharacter; + /** + * The value used to separate individual records. + */ + RecordDelimiter?: RecordDelimiter; + /** + * The value used to separate individual fields in a record. + */ + FieldDelimiter?: FieldDelimiter; + /** + * The value used for escaping where the field delimiter is part of the value. + */ + QuoteCharacter?: QuoteCharacter; + } + export type CacheControl = string; + export type CloudFunction = string; + export interface CloudFunctionConfiguration { + Id?: NotificationId; + Event?: Event; + /** + * + */ + Events?: EventList; + /** + * + */ + CloudFunction?: CloudFunction; + /** + * + */ + InvocationRole?: CloudFunctionInvocationRole; + } + export type CloudFunctionInvocationRole = string; + export type Code = string; + export type Comments = string; + export interface CommonPrefix { + /** + * + */ + Prefix?: Prefix; + } + export type CommonPrefixList = CommonPrefix[]; + export interface CompleteMultipartUploadOutput { + /** + * + */ + Location?: Location; + /** + * + */ + Bucket?: BucketName; + /** + * + */ + Key?: ObjectKey; + /** + * If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded. + */ + Expiration?: Expiration; + /** + * Entity tag of the object. + */ + ETag?: ETag; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * Version of the object. + */ + VersionId?: ObjectVersionId; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestCharged?: RequestCharged; + } + export interface CompleteMultipartUploadRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * + */ + MultipartUpload?: CompletedMultipartUpload; + /** + * + */ + UploadId: MultipartUploadId; + RequestPayer?: RequestPayer; + } + export interface CompletedMultipartUpload { + /** + * + */ + Parts?: CompletedPartList; + } + export interface CompletedPart { + /** + * Entity tag returned when the part was uploaded. + */ + ETag?: ETag; + /** + * Part number that identifies the part. This is a positive integer between 1 and 10,000. + */ + PartNumber?: PartNumber; + } + export type CompletedPartList = CompletedPart[]; + export type CompressionType = "NONE"|"GZIP"|"BZIP2"|string; + export interface Condition { + /** + * The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied. + */ + HttpErrorCodeReturnedEquals?: HttpErrorCodeReturnedEquals; + /** + * The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied. + */ + KeyPrefixEquals?: KeyPrefixEquals; + } + export type ConfirmRemoveSelfBucketAccess = boolean; + export type ContentDisposition = string; + export type ContentEncoding = string; + export type ContentLanguage = string; + export type ContentLength = number; + export type ContentMD5 = string; + export type ContentRange = string; + export type ContentType = string; + export interface ContinuationEvent { + } + export interface CopyObjectOutput { + /** + * + */ + CopyObjectResult?: CopyObjectResult; + /** + * If the object expiration is configured, the response includes this header. + */ + Expiration?: Expiration; + /** + * + */ + CopySourceVersionId?: CopySourceVersionId; + /** + * Version ID of the newly created copy. + */ + VersionId?: ObjectVersionId; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestCharged?: RequestCharged; + } + export interface CopyObjectRequest { + /** + * The canned ACL to apply to the object. + */ + ACL?: ObjectCannedACL; + /** + * + */ + Bucket: BucketName; + /** + * Specifies caching behavior along the request/reply chain. + */ + CacheControl?: CacheControl; + /** + * Specifies presentational information for the object. + */ + ContentDisposition?: ContentDisposition; + /** + * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. + */ + ContentEncoding?: ContentEncoding; + /** + * The language the content is in. + */ + ContentLanguage?: ContentLanguage; + /** + * A standard MIME type describing the format of the object data. + */ + ContentType?: ContentType; + /** + * The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded. + */ + CopySource: CopySource; + /** + * Copies the object if its entity tag (ETag) matches the specified tag. + */ + CopySourceIfMatch?: CopySourceIfMatch; + /** + * Copies the object if it has been modified since the specified time. + */ + CopySourceIfModifiedSince?: CopySourceIfModifiedSince; + /** + * Copies the object if its entity tag (ETag) is different than the specified ETag. + */ + CopySourceIfNoneMatch?: CopySourceIfNoneMatch; + /** + * Copies the object if it hasn't been modified since the specified time. + */ + CopySourceIfUnmodifiedSince?: CopySourceIfUnmodifiedSince; + /** + * The date and time at which the object is no longer cacheable. + */ + Expires?: Expires; + /** + * Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. + */ + GrantFullControl?: GrantFullControl; + /** + * Allows grantee to read the object data and its metadata. + */ + GrantRead?: GrantRead; + /** + * Allows grantee to read the object ACL. + */ + GrantReadACP?: GrantReadACP; + /** + * Allows grantee to write the ACL for the applicable object. + */ + GrantWriteACP?: GrantWriteACP; + /** + * + */ + Key: ObjectKey; + /** + * A map of metadata to store with the object in S3. + */ + Metadata?: Metadata; + /** + * Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. + */ + MetadataDirective?: MetadataDirective; + /** + * Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. + */ + TaggingDirective?: TaggingDirective; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * The type of storage to use for the object. Defaults to 'STANDARD'. + */ + StorageClass?: StorageClass; + /** + * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. + */ + WebsiteRedirectLocation?: WebsiteRedirectLocation; + /** + * Specifies the algorithm to use to when encrypting the object (e.g., AES256). + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. + */ + SSECustomerKey?: SSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version + */ + SSEKMSKeyId?: SSEKMSKeyId; + /** + * Specifies the algorithm to use when decrypting the source object (e.g., AES256). + */ + CopySourceSSECustomerAlgorithm?: CopySourceSSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created. + */ + CopySourceSSECustomerKey?: CopySourceSSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + CopySourceSSECustomerKeyMD5?: CopySourceSSECustomerKeyMD5; + RequestPayer?: RequestPayer; + /** + * The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters + */ + Tagging?: TaggingHeader; + /** + * The Object Lock mode that you want to apply to the copied object. + */ + ObjectLockMode?: ObjectLockMode; + /** + * The date and time when you want the copied object's Object Lock to expire. + */ + ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate; + /** + * Specifies whether you want to apply a Legal Hold to the copied object. + */ + ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus; + } + export interface CopyObjectResult { + /** + * + */ + ETag?: ETag; + /** + * + */ + LastModified?: LastModified; + } + export interface CopyPartResult { + /** + * Entity tag of the object. + */ + ETag?: ETag; + /** + * Date and time at which the object was uploaded. + */ + LastModified?: LastModified; + } + export type CopySource = string; + export type CopySourceIfMatch = string; + export type CopySourceIfModifiedSince = Date; + export type CopySourceIfNoneMatch = string; + export type CopySourceIfUnmodifiedSince = Date; + export type CopySourceRange = string; + export type CopySourceSSECustomerAlgorithm = string; + export type CopySourceSSECustomerKey = Buffer|Uint8Array|Blob|string; + export type CopySourceSSECustomerKeyMD5 = string; + export type CopySourceVersionId = string; + export interface CreateBucketConfiguration { + /** + * Specifies the region where the bucket will be created. If you don't specify a region, the bucket is created in US East (N. Virginia) Region (us-east-1). + */ + LocationConstraint?: BucketLocationConstraint; + } + export interface CreateBucketOutput { + /** + * + */ + Location?: Location; + } + export interface CreateBucketRequest { + /** + * The canned ACL to apply to the bucket. + */ + ACL?: BucketCannedACL; + /** + * + */ + Bucket: BucketName; + /** + * + */ + CreateBucketConfiguration?: CreateBucketConfiguration; + /** + * Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. + */ + GrantFullControl?: GrantFullControl; + /** + * Allows grantee to list the objects in the bucket. + */ + GrantRead?: GrantRead; + /** + * Allows grantee to read the bucket ACL. + */ + GrantReadACP?: GrantReadACP; + /** + * Allows grantee to create, overwrite, and delete any object in the bucket. + */ + GrantWrite?: GrantWrite; + /** + * Allows grantee to write the ACL for the applicable bucket. + */ + GrantWriteACP?: GrantWriteACP; + /** + * Specifies whether you want S3 Object Lock to be enabled for the new bucket. + */ + ObjectLockEnabledForBucket?: ObjectLockEnabledForBucket; + } + export interface CreateMultipartUploadOutput { + /** + * Date when multipart upload will become eligible for abort operation by lifecycle. + */ + AbortDate?: AbortDate; + /** + * Id of the lifecycle rule that makes a multipart upload eligible for abort operation. + */ + AbortRuleId?: AbortRuleId; + /** + * Name of the bucket to which the multipart upload was initiated. + */ + Bucket?: BucketName; + /** + * Object key for which the multipart upload was initiated. + */ + Key?: ObjectKey; + /** + * ID for the initiated multipart upload. + */ + UploadId?: MultipartUploadId; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestCharged?: RequestCharged; + } + export interface CreateMultipartUploadRequest { + /** + * The canned ACL to apply to the object. + */ + ACL?: ObjectCannedACL; + /** + * + */ + Bucket: BucketName; + /** + * Specifies caching behavior along the request/reply chain. + */ + CacheControl?: CacheControl; + /** + * Specifies presentational information for the object. + */ + ContentDisposition?: ContentDisposition; + /** + * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. + */ + ContentEncoding?: ContentEncoding; + /** + * The language the content is in. + */ + ContentLanguage?: ContentLanguage; + /** + * A standard MIME type describing the format of the object data. + */ + ContentType?: ContentType; + /** + * The date and time at which the object is no longer cacheable. + */ + Expires?: Expires; + /** + * Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. + */ + GrantFullControl?: GrantFullControl; + /** + * Allows grantee to read the object data and its metadata. + */ + GrantRead?: GrantRead; + /** + * Allows grantee to read the object ACL. + */ + GrantReadACP?: GrantReadACP; + /** + * Allows grantee to write the ACL for the applicable object. + */ + GrantWriteACP?: GrantWriteACP; + /** + * + */ + Key: ObjectKey; + /** + * A map of metadata to store with the object in S3. + */ + Metadata?: Metadata; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * The type of storage to use for the object. Defaults to 'STANDARD'. + */ + StorageClass?: StorageClass; + /** + * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. + */ + WebsiteRedirectLocation?: WebsiteRedirectLocation; + /** + * Specifies the algorithm to use to when encrypting the object (e.g., AES256). + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. + */ + SSECustomerKey?: SSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestPayer?: RequestPayer; + /** + * The tag-set for the object. The tag-set must be encoded as URL Query parameters + */ + Tagging?: TaggingHeader; + /** + * Specifies the Object Lock mode that you want to apply to the uploaded object. + */ + ObjectLockMode?: ObjectLockMode; + /** + * Specifies the date and time when you want the Object Lock to expire. + */ + ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate; + /** + * Specifies whether you want to apply a Legal Hold to the uploaded object. + */ + ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus; + } + export type CreationDate = Date; + export type _Date = Date; + export type Days = number; + export type DaysAfterInitiation = number; + export interface DefaultRetention { + /** + * The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. + */ + Mode?: ObjectLockRetentionMode; + /** + * The number of days that you want to specify for the default retention period. + */ + Days?: Days; + /** + * The number of years that you want to specify for the default retention period. + */ + Years?: Years; + } + export interface Delete { + /** + * + */ + Objects: ObjectIdentifierList; + /** + * Element to enable quiet mode for the request. When you add this element, you must set its value to true. + */ + Quiet?: Quiet; + } + export interface DeleteBucketAnalyticsConfigurationRequest { + /** + * The name of the bucket from which an analytics configuration is deleted. + */ + Bucket: BucketName; + /** + * The identifier used to represent an analytics configuration. + */ + Id: AnalyticsId; + } + export interface DeleteBucketCorsRequest { + /** + * + */ + Bucket: BucketName; + } + export interface DeleteBucketEncryptionRequest { + /** + * The name of the bucket containing the server-side encryption configuration to delete. + */ + Bucket: BucketName; + } + export interface DeleteBucketInventoryConfigurationRequest { + /** + * The name of the bucket containing the inventory configuration to delete. + */ + Bucket: BucketName; + /** + * The ID used to identify the inventory configuration. + */ + Id: InventoryId; + } + export interface DeleteBucketLifecycleRequest { + /** + * + */ + Bucket: BucketName; + } + export interface DeleteBucketMetricsConfigurationRequest { + /** + * The name of the bucket containing the metrics configuration to delete. + */ + Bucket: BucketName; + /** + * The ID used to identify the metrics configuration. + */ + Id: MetricsId; + } + export interface DeleteBucketPolicyRequest { + /** + * + */ + Bucket: BucketName; + } + export interface DeleteBucketReplicationRequest { + /** + * The bucket name. It can take a while to propagate the deletion of a replication configuration to all Amazon S3 systems. + */ + Bucket: BucketName; + } + export interface DeleteBucketRequest { + /** + * + */ + Bucket: BucketName; + } + export interface DeleteBucketTaggingRequest { + /** + * + */ + Bucket: BucketName; + } + export interface DeleteBucketWebsiteRequest { + /** + * + */ + Bucket: BucketName; + } + export type DeleteMarker = boolean; + export interface DeleteMarkerEntry { + /** + * + */ + Owner?: Owner; + /** + * The object key. + */ + Key?: ObjectKey; + /** + * Version ID of an object. + */ + VersionId?: ObjectVersionId; + /** + * Specifies whether the object is (true) or is not (false) the latest version of an object. + */ + IsLatest?: IsLatest; + /** + * Date and time the object was last modified. + */ + LastModified?: LastModified; + } + export interface DeleteMarkerReplication { + /** + * The status of the delete marker replication. In the current implementation, Amazon S3 doesn't replicate the delete markers. The status must be Disabled. + */ + Status?: DeleteMarkerReplicationStatus; + } + export type DeleteMarkerReplicationStatus = "Enabled"|"Disabled"|string; + export type DeleteMarkerVersionId = string; + export type DeleteMarkers = DeleteMarkerEntry[]; + export interface DeleteObjectOutput { + /** + * Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. + */ + DeleteMarker?: DeleteMarker; + /** + * Returns the version ID of the delete marker created as a result of the DELETE operation. + */ + VersionId?: ObjectVersionId; + RequestCharged?: RequestCharged; + } + export interface DeleteObjectRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. + */ + MFA?: MFA; + /** + * VersionId used to reference a specific version of the object. + */ + VersionId?: ObjectVersionId; + RequestPayer?: RequestPayer; + /** + * Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. + */ + BypassGovernanceRetention?: BypassGovernanceRetention; + } + export interface DeleteObjectTaggingOutput { + /** + * The versionId of the object the tag-set was removed from. + */ + VersionId?: ObjectVersionId; + } + export interface DeleteObjectTaggingRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * The versionId of the object that the tag-set will be removed from. + */ + VersionId?: ObjectVersionId; + } + export interface DeleteObjectsOutput { + /** + * + */ + Deleted?: DeletedObjects; + RequestCharged?: RequestCharged; + /** + * + */ + Errors?: Errors; + } + export interface DeleteObjectsRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Delete: Delete; + /** + * The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. + */ + MFA?: MFA; + RequestPayer?: RequestPayer; + /** + * Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation. + */ + BypassGovernanceRetention?: BypassGovernanceRetention; + } + export interface DeletePublicAccessBlockRequest { + /** + * The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete. + */ + Bucket: BucketName; + } + export interface DeletedObject { + /** + * + */ + Key?: ObjectKey; + /** + * + */ + VersionId?: ObjectVersionId; + /** + * + */ + DeleteMarker?: DeleteMarker; + /** + * + */ + DeleteMarkerVersionId?: DeleteMarkerVersionId; + } + export type DeletedObjects = DeletedObject[]; + export type Delimiter = string; + export type Description = string; + export interface Destination { + /** + * The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule. If there are multiple rules in your replication configuration, all rules must specify the same bucket as the destination. A replication configuration can replicate objects to only one destination bucket. + */ + Bucket: BucketName; + /** + * The account ID of the destination bucket. Currently, Amazon S3 verifies this value only if Access Control Translation is enabled. In a cross-account scenario, if you change replica ownership to the AWS account that owns the destination bucket by adding the AccessControlTranslation element, this is the account ID of the owner of the destination bucket. + */ + Account?: AccountId; + /** + * The class of storage used to store the object. By default Amazon S3 uses storage class of the source object when creating a replica. + */ + StorageClass?: StorageClass; + /** + * A container for information about access control for replicas. Use this element only in a cross-account scenario where source and destination bucket owners are not the same to change replica ownership to the AWS account that owns the destination bucket. If you don't add this element to the replication configuration, the replicas are owned by same AWS account that owns the source object. + */ + AccessControlTranslation?: AccessControlTranslation; + /** + * A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element. + */ + EncryptionConfiguration?: EncryptionConfiguration; + } + export type DisplayName = string; + export type ETag = string; + export type EmailAddress = string; + export type EnableRequestProgress = boolean; + export type EncodingType = "url"|string; + export interface Encryption { + /** + * The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms). + */ + EncryptionType: ServerSideEncryption; + /** + * If the encryption type is aws:kms, this optional value specifies the AWS KMS key ID to use for encryption of job results. + */ + KMSKeyId?: SSEKMSKeyId; + /** + * If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results. + */ + KMSContext?: KMSContext; + } + export interface EncryptionConfiguration { + /** + * The ID of the AWS KMS key for the AWS Region where the destination bucket resides. Amazon S3 uses this key to encrypt the replica object. + */ + ReplicaKmsKeyID?: ReplicaKmsKeyID; + } + export interface EndEvent { + } + export interface Error { + /** + * + */ + Key?: ObjectKey; + /** + * + */ + VersionId?: ObjectVersionId; + /** + * + */ + Code?: Code; + /** + * + */ + Message?: Message; + } + export interface ErrorDocument { + /** + * The object key name to use when a 4XX class error occurs. + */ + Key: ObjectKey; + } + export type Errors = Error[]; + export type Event = "s3:ReducedRedundancyLostObject"|"s3:ObjectCreated:*"|"s3:ObjectCreated:Put"|"s3:ObjectCreated:Post"|"s3:ObjectCreated:Copy"|"s3:ObjectCreated:CompleteMultipartUpload"|"s3:ObjectRemoved:*"|"s3:ObjectRemoved:Delete"|"s3:ObjectRemoved:DeleteMarkerCreated"|"s3:ObjectRestore:Post"|"s3:ObjectRestore:Completed"|string; + export type EventList = Event[]; + export type Expiration = string; + export type ExpirationStatus = "Enabled"|"Disabled"|string; + export type ExpiredObjectDeleteMarker = boolean; + export type Expires = Date; + export type ExposeHeader = string; + export type ExposeHeaders = ExposeHeader[]; + export type Expression = string; + export type ExpressionType = "SQL"|string; + export type FetchOwner = boolean; + export type FieldDelimiter = string; + export type FileHeaderInfo = "USE"|"IGNORE"|"NONE"|string; + export interface FilterRule { + /** + * The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum prefix length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide. + */ + Name?: FilterRuleName; + /** + * + */ + Value?: FilterRuleValue; + } + export type FilterRuleList = FilterRule[]; + export type FilterRuleName = "prefix"|"suffix"|string; + export type FilterRuleValue = string; + export interface GetBucketAccelerateConfigurationOutput { + /** + * The accelerate configuration of the bucket. + */ + Status?: BucketAccelerateStatus; + } + export interface GetBucketAccelerateConfigurationRequest { + /** + * Name of the bucket for which the accelerate configuration is retrieved. + */ + Bucket: BucketName; + } + export interface GetBucketAclOutput { + /** + * + */ + Owner?: Owner; + /** + * A list of grants. + */ + Grants?: Grants; + } + export interface GetBucketAclRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketAnalyticsConfigurationOutput { + /** + * The configuration and any analyses for the analytics filter. + */ + AnalyticsConfiguration?: AnalyticsConfiguration; + } + export interface GetBucketAnalyticsConfigurationRequest { + /** + * The name of the bucket from which an analytics configuration is retrieved. + */ + Bucket: BucketName; + /** + * The identifier used to represent an analytics configuration. + */ + Id: AnalyticsId; + } + export interface GetBucketCorsOutput { + /** + * + */ + CORSRules?: CORSRules; + } + export interface GetBucketCorsRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketEncryptionOutput { + ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration; + } + export interface GetBucketEncryptionRequest { + /** + * The name of the bucket from which the server-side encryption configuration is retrieved. + */ + Bucket: BucketName; + } + export interface GetBucketInventoryConfigurationOutput { + /** + * Specifies the inventory configuration. + */ + InventoryConfiguration?: InventoryConfiguration; + } + export interface GetBucketInventoryConfigurationRequest { + /** + * The name of the bucket containing the inventory configuration to retrieve. + */ + Bucket: BucketName; + /** + * The ID used to identify the inventory configuration. + */ + Id: InventoryId; + } + export interface GetBucketLifecycleConfigurationOutput { + /** + * + */ + Rules?: LifecycleRules; + } + export interface GetBucketLifecycleConfigurationRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketLifecycleOutput { + /** + * + */ + Rules?: Rules; + } + export interface GetBucketLifecycleRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketLocationOutput { + /** + * + */ + LocationConstraint?: BucketLocationConstraint; + } + export interface GetBucketLocationRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketLoggingOutput { + LoggingEnabled?: LoggingEnabled; + } + export interface GetBucketLoggingRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketMetricsConfigurationOutput { + /** + * Specifies the metrics configuration. + */ + MetricsConfiguration?: MetricsConfiguration; + } + export interface GetBucketMetricsConfigurationRequest { + /** + * The name of the bucket containing the metrics configuration to retrieve. + */ + Bucket: BucketName; + /** + * The ID used to identify the metrics configuration. + */ + Id: MetricsId; + } + export interface GetBucketNotificationConfigurationRequest { + /** + * Name of the bucket to get the notification configuration for. + */ + Bucket: BucketName; + } + export interface GetBucketPolicyOutput { + /** + * The bucket policy as a JSON document. + */ + Policy?: Policy; + } + export interface GetBucketPolicyRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketPolicyStatusOutput { + /** + * The policy status for the specified bucket. + */ + PolicyStatus?: PolicyStatus; + } + export interface GetBucketPolicyStatusRequest { + /** + * The name of the Amazon S3 bucket whose policy status you want to retrieve. + */ + Bucket: BucketName; + } + export interface GetBucketReplicationOutput { + ReplicationConfiguration?: ReplicationConfiguration; + } + export interface GetBucketReplicationRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketRequestPaymentOutput { + /** + * Specifies who pays for the download and request fees. + */ + Payer?: Payer; + } + export interface GetBucketRequestPaymentRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketTaggingOutput { + /** + * + */ + TagSet: TagSet; + } + export interface GetBucketTaggingRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketVersioningOutput { + /** + * The versioning state of the bucket. + */ + Status?: BucketVersioningStatus; + /** + * Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned. + */ + MFADelete?: MFADeleteStatus; + } + export interface GetBucketVersioningRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetBucketWebsiteOutput { + /** + * + */ + RedirectAllRequestsTo?: RedirectAllRequestsTo; + /** + * + */ + IndexDocument?: IndexDocument; + /** + * + */ + ErrorDocument?: ErrorDocument; + /** + * + */ + RoutingRules?: RoutingRules; + } + export interface GetBucketWebsiteRequest { + /** + * + */ + Bucket: BucketName; + } + export interface GetObjectAclOutput { + /** + * + */ + Owner?: Owner; + /** + * A list of grants. + */ + Grants?: Grants; + RequestCharged?: RequestCharged; + } + export interface GetObjectAclRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * VersionId used to reference a specific version of the object. + */ + VersionId?: ObjectVersionId; + RequestPayer?: RequestPayer; + } + export interface GetObjectLegalHoldOutput { + /** + * The current Legal Hold status for the specified object. + */ + LegalHold?: ObjectLockLegalHold; + } + export interface GetObjectLegalHoldRequest { + /** + * The bucket containing the object whose Legal Hold status you want to retrieve. + */ + Bucket: BucketName; + /** + * The key name for the object whose Legal Hold status you want to retrieve. + */ + Key: ObjectKey; + /** + * The version ID of the object whose Legal Hold status you want to retrieve. + */ + VersionId?: ObjectVersionId; + RequestPayer?: RequestPayer; + } + export interface GetObjectLockConfigurationOutput { + /** + * The specified bucket's Object Lock configuration. + */ + ObjectLockConfiguration?: ObjectLockConfiguration; + } + export interface GetObjectLockConfigurationRequest { + /** + * The bucket whose Object Lock configuration you want to retrieve. + */ + Bucket: BucketName; + } + export interface GetObjectOutput { + /** + * Object data. + */ + Body?: Body; + /** + * Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response. + */ + DeleteMarker?: DeleteMarker; + /** + * + */ + AcceptRanges?: AcceptRanges; + /** + * If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded. + */ + Expiration?: Expiration; + /** + * Provides information about object restoration operation and expiration time of the restored object copy. + */ + Restore?: Restore; + /** + * Last modified date of the object + */ + LastModified?: LastModified; + /** + * Size of the body in bytes. + */ + ContentLength?: ContentLength; + /** + * An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL + */ + ETag?: ETag; + /** + * This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers. + */ + MissingMeta?: MissingMeta; + /** + * Version of the object. + */ + VersionId?: ObjectVersionId; + /** + * Specifies caching behavior along the request/reply chain. + */ + CacheControl?: CacheControl; + /** + * Specifies presentational information for the object. + */ + ContentDisposition?: ContentDisposition; + /** + * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. + */ + ContentEncoding?: ContentEncoding; + /** + * The language the content is in. + */ + ContentLanguage?: ContentLanguage; + /** + * The portion of the object returned in the response. + */ + ContentRange?: ContentRange; + /** + * A standard MIME type describing the format of the object data. + */ + ContentType?: ContentType; + /** + * The date and time at which the object is no longer cacheable. + */ + Expires?: Expires; + /** + * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. + */ + WebsiteRedirectLocation?: WebsiteRedirectLocation; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * A map of metadata to store with the object in S3. + */ + Metadata?: Metadata; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + /** + * + */ + StorageClass?: StorageClass; + RequestCharged?: RequestCharged; + /** + * + */ + ReplicationStatus?: ReplicationStatus; + /** + * The count of parts this object has. + */ + PartsCount?: PartsCount; + /** + * The number of tags, if any, on the object. + */ + TagCount?: TagCount; + /** + * The Object Lock mode currently in place for this object. + */ + ObjectLockMode?: ObjectLockMode; + /** + * The date and time when this object's Object Lock will expire. + */ + ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate; + /** + * Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status. + */ + ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus; + } + export interface GetObjectRequest { + /** + * + */ + Bucket: BucketName; + /** + * Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed). + */ + IfMatch?: IfMatch; + /** + * Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified). + */ + IfModifiedSince?: IfModifiedSince; + /** + * Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified). + */ + IfNoneMatch?: IfNoneMatch; + /** + * Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed). + */ + IfUnmodifiedSince?: IfUnmodifiedSince; + /** + * + */ + Key: ObjectKey; + /** + * Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. + */ + Range?: Range; + /** + * Sets the Cache-Control header of the response. + */ + ResponseCacheControl?: ResponseCacheControl; + /** + * Sets the Content-Disposition header of the response + */ + ResponseContentDisposition?: ResponseContentDisposition; + /** + * Sets the Content-Encoding header of the response. + */ + ResponseContentEncoding?: ResponseContentEncoding; + /** + * Sets the Content-Language header of the response. + */ + ResponseContentLanguage?: ResponseContentLanguage; + /** + * Sets the Content-Type header of the response. + */ + ResponseContentType?: ResponseContentType; + /** + * Sets the Expires header of the response. + */ + ResponseExpires?: ResponseExpires; + /** + * VersionId used to reference a specific version of the object. + */ + VersionId?: ObjectVersionId; + /** + * Specifies the algorithm to use to when encrypting the object (e.g., AES256). + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. + */ + SSECustomerKey?: SSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + RequestPayer?: RequestPayer; + /** + * Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object. + */ + PartNumber?: PartNumber; + } + export interface GetObjectRetentionOutput { + /** + * The container element for an object's retention settings. + */ + Retention?: ObjectLockRetention; + } + export interface GetObjectRetentionRequest { + /** + * The bucket containing the object whose retention settings you want to retrieve. + */ + Bucket: BucketName; + /** + * The key name for the object whose retention settings you want to retrieve. + */ + Key: ObjectKey; + /** + * The version ID for the object whose retention settings you want to retrieve. + */ + VersionId?: ObjectVersionId; + RequestPayer?: RequestPayer; + } + export interface GetObjectTaggingOutput { + /** + * + */ + VersionId?: ObjectVersionId; + /** + * + */ + TagSet: TagSet; + } + export interface GetObjectTaggingRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * + */ + VersionId?: ObjectVersionId; + } + export interface GetObjectTorrentOutput { + /** + * + */ + Body?: Body; + RequestCharged?: RequestCharged; + } + export interface GetObjectTorrentRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + RequestPayer?: RequestPayer; + } + export interface GetPublicAccessBlockOutput { + /** + * The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket. + */ + PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration; + } + export interface GetPublicAccessBlockRequest { + /** + * The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve. + */ + Bucket: BucketName; + } + export interface GlacierJobParameters { + /** + * Glacier retrieval tier at which the restore will be processed. + */ + Tier: Tier; + } + export interface Grant { + /** + * + */ + Grantee?: Grantee; + /** + * Specifies the permission given to the grantee. + */ + Permission?: Permission; + } + export type GrantFullControl = string; + export type GrantRead = string; + export type GrantReadACP = string; + export type GrantWrite = string; + export type GrantWriteACP = string; + export interface Grantee { + /** + * Screen name of the grantee. + */ + DisplayName?: DisplayName; + /** + * Email address of the grantee. + */ + EmailAddress?: EmailAddress; + /** + * The canonical user ID of the grantee. + */ + ID?: ID; + /** + * Type of grantee + */ + Type: Type; + /** + * URI of the grantee group. + */ + URI?: URI; + } + export type Grants = Grant[]; + export interface HeadBucketRequest { + /** + * + */ + Bucket: BucketName; + } + export interface HeadObjectOutput { + /** + * Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response. + */ + DeleteMarker?: DeleteMarker; + /** + * + */ + AcceptRanges?: AcceptRanges; + /** + * If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded. + */ + Expiration?: Expiration; + /** + * Provides information about object restoration operation and expiration time of the restored object copy. + */ + Restore?: Restore; + /** + * Last modified date of the object + */ + LastModified?: LastModified; + /** + * Size of the body in bytes. + */ + ContentLength?: ContentLength; + /** + * An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL + */ + ETag?: ETag; + /** + * This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers. + */ + MissingMeta?: MissingMeta; + /** + * Version of the object. + */ + VersionId?: ObjectVersionId; + /** + * Specifies caching behavior along the request/reply chain. + */ + CacheControl?: CacheControl; + /** + * Specifies presentational information for the object. + */ + ContentDisposition?: ContentDisposition; + /** + * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. + */ + ContentEncoding?: ContentEncoding; + /** + * The language the content is in. + */ + ContentLanguage?: ContentLanguage; + /** + * A standard MIME type describing the format of the object data. + */ + ContentType?: ContentType; + /** + * The date and time at which the object is no longer cacheable. + */ + Expires?: Expires; + /** + * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. + */ + WebsiteRedirectLocation?: WebsiteRedirectLocation; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * A map of metadata to store with the object in S3. + */ + Metadata?: Metadata; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + /** + * + */ + StorageClass?: StorageClass; + RequestCharged?: RequestCharged; + /** + * + */ + ReplicationStatus?: ReplicationStatus; + /** + * The count of parts this object has. + */ + PartsCount?: PartsCount; + /** + * The Object Lock mode currently in place for this object. + */ + ObjectLockMode?: ObjectLockMode; + /** + * The date and time when this object's Object Lock will expire. + */ + ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate; + /** + * The Legal Hold status for the specified object. + */ + ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus; + } + export interface HeadObjectRequest { + /** + * + */ + Bucket: BucketName; + /** + * Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed). + */ + IfMatch?: IfMatch; + /** + * Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified). + */ + IfModifiedSince?: IfModifiedSince; + /** + * Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified). + */ + IfNoneMatch?: IfNoneMatch; + /** + * Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed). + */ + IfUnmodifiedSince?: IfUnmodifiedSince; + /** + * + */ + Key: ObjectKey; + /** + * Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. + */ + Range?: Range; + /** + * VersionId used to reference a specific version of the object. + */ + VersionId?: ObjectVersionId; + /** + * Specifies the algorithm to use to when encrypting the object (e.g., AES256). + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. + */ + SSECustomerKey?: SSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + RequestPayer?: RequestPayer; + /** + * Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object. + */ + PartNumber?: PartNumber; + } + export type HostName = string; + export type HttpErrorCodeReturnedEquals = string; + export type HttpRedirectCode = string; + export type ID = string; + export type IfMatch = string; + export type IfModifiedSince = Date; + export type IfNoneMatch = string; + export type IfUnmodifiedSince = Date; + export interface IndexDocument { + /** + * A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character. + */ + Suffix: Suffix; + } + export type Initiated = Date; + export interface Initiator { + /** + * If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value. + */ + ID?: ID; + /** + * Name of the Principal. + */ + DisplayName?: DisplayName; + } + export interface InputSerialization { + /** + * Describes the serialization of a CSV-encoded object. + */ + CSV?: CSVInput; + /** + * Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE. + */ + CompressionType?: CompressionType; + /** + * Specifies JSON as object's input serialization format. + */ + JSON?: JSONInput; + /** + * Specifies Parquet as object's input serialization format. + */ + Parquet?: ParquetInput; + } + export interface InventoryConfiguration { + /** + * Contains information about where to publish the inventory results. + */ + Destination: InventoryDestination; + /** + * Specifies whether the inventory is enabled or disabled. + */ + IsEnabled: IsEnabled; + /** + * Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria. + */ + Filter?: InventoryFilter; + /** + * The ID used to identify the inventory configuration. + */ + Id: InventoryId; + /** + * Specifies which object version(s) to included in the inventory results. + */ + IncludedObjectVersions: InventoryIncludedObjectVersions; + /** + * Contains the optional fields that are included in the inventory results. + */ + OptionalFields?: InventoryOptionalFields; + /** + * Specifies the schedule for generating inventory results. + */ + Schedule: InventorySchedule; + } + export type InventoryConfigurationList = InventoryConfiguration[]; + export interface InventoryDestination { + /** + * Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published. + */ + S3BucketDestination: InventoryS3BucketDestination; + } + export interface InventoryEncryption { + /** + * Specifies the use of SSE-S3 to encrypt delivered Inventory reports. + */ + SSES3?: SSES3; + /** + * Specifies the use of SSE-KMS to encrypt delivered Inventory reports. + */ + SSEKMS?: SSEKMS; + } + export interface InventoryFilter { + /** + * The prefix that an object must have to be included in the inventory results. + */ + Prefix: Prefix; + } + export type InventoryFormat = "CSV"|"ORC"|"Parquet"|string; + export type InventoryFrequency = "Daily"|"Weekly"|string; + export type InventoryId = string; + export type InventoryIncludedObjectVersions = "All"|"Current"|string; + export type InventoryOptionalField = "Size"|"LastModifiedDate"|"StorageClass"|"ETag"|"IsMultipartUploaded"|"ReplicationStatus"|"EncryptionStatus"|"ObjectLockRetainUntilDate"|"ObjectLockMode"|"ObjectLockLegalHoldStatus"|string; + export type InventoryOptionalFields = InventoryOptionalField[]; + export interface InventoryS3BucketDestination { + /** + * The ID of the account that owns the destination bucket. + */ + AccountId?: AccountId; + /** + * The Amazon resource name (ARN) of the bucket where inventory results will be published. + */ + Bucket: BucketName; + /** + * Specifies the output format of the inventory results. + */ + Format: InventoryFormat; + /** + * The prefix that is prepended to all inventory results. + */ + Prefix?: Prefix; + /** + * Contains the type of server-side encryption used to encrypt the inventory results. + */ + Encryption?: InventoryEncryption; + } + export interface InventorySchedule { + /** + * Specifies how frequently inventory results are produced. + */ + Frequency: InventoryFrequency; + } + export type IsEnabled = boolean; + export type IsLatest = boolean; + export type IsPublic = boolean; + export type IsTruncated = boolean; + export interface JSONInput { + /** + * The type of JSON. Valid values: Document, Lines. + */ + Type?: JSONType; + } + export interface JSONOutput { + /** + * The value used to separate individual records in the output. + */ + RecordDelimiter?: RecordDelimiter; + } + export type JSONType = "DOCUMENT"|"LINES"|string; + export type KMSContext = string; + export type KeyCount = number; + export type KeyMarker = string; + export type KeyPrefixEquals = string; + export type LambdaFunctionArn = string; + export interface LambdaFunctionConfiguration { + Id?: NotificationId; + /** + * The Amazon Resource Name (ARN) of the Lambda cloud function that Amazon S3 can invoke when it detects events of the specified type. + */ + LambdaFunctionArn: LambdaFunctionArn; + /** + * + */ + Events: EventList; + Filter?: NotificationConfigurationFilter; + } + export type LambdaFunctionConfigurationList = LambdaFunctionConfiguration[]; + export type LastModified = Date; + export interface LifecycleConfiguration { + /** + * + */ + Rules: Rules; + } + export interface LifecycleExpiration { + /** + * Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. + */ + Date?: _Date; + /** + * Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. + */ + Days?: Days; + /** + * Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. + */ + ExpiredObjectDeleteMarker?: ExpiredObjectDeleteMarker; + } + export interface LifecycleRule { + /** + * + */ + Expiration?: LifecycleExpiration; + /** + * Unique identifier for the rule. The value cannot be longer than 255 characters. + */ + ID?: ID; + /** + * Prefix identifying one or more objects to which the rule applies. This is No longer used; use Filter instead. + */ + Prefix?: Prefix; + Filter?: LifecycleRuleFilter; + /** + * If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. + */ + Status: ExpirationStatus; + /** + * + */ + Transitions?: TransitionList; + /** + * + */ + NoncurrentVersionTransitions?: NoncurrentVersionTransitionList; + NoncurrentVersionExpiration?: NoncurrentVersionExpiration; + AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload; + } + export interface LifecycleRuleAndOperator { + /** + * + */ + Prefix?: Prefix; + /** + * All of these tags must exist in the object's tag set in order for the rule to apply. + */ + Tags?: TagSet; + } + export interface LifecycleRuleFilter { + /** + * Prefix identifying one or more objects to which the rule applies. + */ + Prefix?: Prefix; + /** + * This tag must exist in the object's tag set in order for the rule to apply. + */ + Tag?: Tag; + And?: LifecycleRuleAndOperator; + } + export type LifecycleRules = LifecycleRule[]; + export interface ListBucketAnalyticsConfigurationsOutput { + /** + * Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. + */ + IsTruncated?: IsTruncated; + /** + * The ContinuationToken that represents where this request began. + */ + ContinuationToken?: Token; + /** + * NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value. + */ + NextContinuationToken?: NextToken; + /** + * The list of analytics configurations for a bucket. + */ + AnalyticsConfigurationList?: AnalyticsConfigurationList; + } + export interface ListBucketAnalyticsConfigurationsRequest { + /** + * The name of the bucket from which analytics configurations are retrieved. + */ + Bucket: BucketName; + /** + * The ContinuationToken that represents a placeholder from where this request should begin. + */ + ContinuationToken?: Token; + } + export interface ListBucketInventoryConfigurationsOutput { + /** + * If sent in the request, the marker that is used as a starting point for this inventory configuration list response. + */ + ContinuationToken?: Token; + /** + * The list of inventory configurations for a bucket. + */ + InventoryConfigurationList?: InventoryConfigurationList; + /** + * Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated. + */ + IsTruncated?: IsTruncated; + /** + * The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands. + */ + NextContinuationToken?: NextToken; + } + export interface ListBucketInventoryConfigurationsRequest { + /** + * The name of the bucket containing the inventory configurations to retrieve. + */ + Bucket: BucketName; + /** + * The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. + */ + ContinuationToken?: Token; + } + export interface ListBucketMetricsConfigurationsOutput { + /** + * Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request. + */ + IsTruncated?: IsTruncated; + /** + * The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request. + */ + ContinuationToken?: Token; + /** + * The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. + */ + NextContinuationToken?: NextToken; + /** + * The list of metrics configurations for a bucket. + */ + MetricsConfigurationList?: MetricsConfigurationList; + } + export interface ListBucketMetricsConfigurationsRequest { + /** + * The name of the bucket containing the metrics configurations to retrieve. + */ + Bucket: BucketName; + /** + * The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. + */ + ContinuationToken?: Token; + } + export interface ListBucketsOutput { + /** + * + */ + Buckets?: Buckets; + /** + * + */ + Owner?: Owner; + } + export interface ListMultipartUploadsOutput { + /** + * Name of the bucket to which the multipart upload was initiated. + */ + Bucket?: BucketName; + /** + * The key at or after which the listing began. + */ + KeyMarker?: KeyMarker; + /** + * Upload ID after which listing began. + */ + UploadIdMarker?: UploadIdMarker; + /** + * When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request. + */ + NextKeyMarker?: NextKeyMarker; + /** + * When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix. + */ + Prefix?: Prefix; + /** + * + */ + Delimiter?: Delimiter; + /** + * When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request. + */ + NextUploadIdMarker?: NextUploadIdMarker; + /** + * Maximum number of multipart uploads that could have been included in the response. + */ + MaxUploads?: MaxUploads; + /** + * Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads. + */ + IsTruncated?: IsTruncated; + /** + * + */ + Uploads?: MultipartUploadList; + /** + * + */ + CommonPrefixes?: CommonPrefixList; + /** + * Encoding type used by Amazon S3 to encode object keys in the response. + */ + EncodingType?: EncodingType; + } + export interface ListMultipartUploadsRequest { + /** + * + */ + Bucket: BucketName; + /** + * Character you use to group keys. + */ + Delimiter?: Delimiter; + EncodingType?: EncodingType; + /** + * Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. + */ + KeyMarker?: KeyMarker; + /** + * Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response. + */ + MaxUploads?: MaxUploads; + /** + * Lists in-progress uploads only for those keys that begin with the specified prefix. + */ + Prefix?: Prefix; + /** + * Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. + */ + UploadIdMarker?: UploadIdMarker; + } + export interface ListObjectVersionsOutput { + /** + * A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results. + */ + IsTruncated?: IsTruncated; + /** + * Marks the last Key returned in a truncated response. + */ + KeyMarker?: KeyMarker; + /** + * + */ + VersionIdMarker?: VersionIdMarker; + /** + * Use this value for the key marker request parameter in a subsequent request. + */ + NextKeyMarker?: NextKeyMarker; + /** + * Use this value for the next version id marker parameter in a subsequent request. + */ + NextVersionIdMarker?: NextVersionIdMarker; + /** + * + */ + Versions?: ObjectVersionList; + /** + * + */ + DeleteMarkers?: DeleteMarkers; + /** + * + */ + Name?: BucketName; + /** + * + */ + Prefix?: Prefix; + /** + * + */ + Delimiter?: Delimiter; + /** + * + */ + MaxKeys?: MaxKeys; + /** + * + */ + CommonPrefixes?: CommonPrefixList; + /** + * Encoding type used by Amazon S3 to encode object keys in the response. + */ + EncodingType?: EncodingType; + } + export interface ListObjectVersionsRequest { + /** + * + */ + Bucket: BucketName; + /** + * A delimiter is a character you use to group keys. + */ + Delimiter?: Delimiter; + EncodingType?: EncodingType; + /** + * Specifies the key to start with when listing objects in a bucket. + */ + KeyMarker?: KeyMarker; + /** + * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. + */ + MaxKeys?: MaxKeys; + /** + * Limits the response to keys that begin with the specified prefix. + */ + Prefix?: Prefix; + /** + * Specifies the object version you want to start listing from. + */ + VersionIdMarker?: VersionIdMarker; + } + export interface ListObjectsOutput { + /** + * A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. + */ + IsTruncated?: IsTruncated; + /** + * + */ + Marker?: Marker; + /** + * When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys. + */ + NextMarker?: NextMarker; + /** + * + */ + Contents?: ObjectList; + /** + * + */ + Name?: BucketName; + /** + * + */ + Prefix?: Prefix; + /** + * + */ + Delimiter?: Delimiter; + /** + * + */ + MaxKeys?: MaxKeys; + /** + * + */ + CommonPrefixes?: CommonPrefixList; + /** + * Encoding type used by Amazon S3 to encode object keys in the response. + */ + EncodingType?: EncodingType; + } + export interface ListObjectsRequest { + /** + * + */ + Bucket: BucketName; + /** + * A delimiter is a character you use to group keys. + */ + Delimiter?: Delimiter; + EncodingType?: EncodingType; + /** + * Specifies the key to start with when listing objects in a bucket. + */ + Marker?: Marker; + /** + * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. + */ + MaxKeys?: MaxKeys; + /** + * Limits the response to keys that begin with the specified prefix. + */ + Prefix?: Prefix; + /** + * Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests. + */ + RequestPayer?: RequestPayer; + } + export interface ListObjectsV2Output { + /** + * A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. + */ + IsTruncated?: IsTruncated; + /** + * Metadata about each object returned. + */ + Contents?: ObjectList; + /** + * Name of the bucket to list. + */ + Name?: BucketName; + /** + * Limits the response to keys that begin with the specified prefix. + */ + Prefix?: Prefix; + /** + * A delimiter is a character you use to group keys. + */ + Delimiter?: Delimiter; + /** + * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. + */ + MaxKeys?: MaxKeys; + /** + * CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter + */ + CommonPrefixes?: CommonPrefixList; + /** + * Encoding type used by Amazon S3 to encode object keys in the response. + */ + EncodingType?: EncodingType; + /** + * KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys + */ + KeyCount?: KeyCount; + /** + * ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key + */ + ContinuationToken?: Token; + /** + * NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key + */ + NextContinuationToken?: NextToken; + /** + * StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket + */ + StartAfter?: StartAfter; + } + export interface ListObjectsV2Request { + /** + * Name of the bucket to list. + */ + Bucket: BucketName; + /** + * A delimiter is a character you use to group keys. + */ + Delimiter?: Delimiter; + /** + * Encoding type used by Amazon S3 to encode object keys in the response. + */ + EncodingType?: EncodingType; + /** + * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. + */ + MaxKeys?: MaxKeys; + /** + * Limits the response to keys that begin with the specified prefix. + */ + Prefix?: Prefix; + /** + * ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key + */ + ContinuationToken?: Token; + /** + * The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true + */ + FetchOwner?: FetchOwner; + /** + * StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket + */ + StartAfter?: StartAfter; + /** + * Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests. + */ + RequestPayer?: RequestPayer; + } + export interface ListPartsOutput { + /** + * Date when multipart upload will become eligible for abort operation by lifecycle. + */ + AbortDate?: AbortDate; + /** + * Id of the lifecycle rule that makes a multipart upload eligible for abort operation. + */ + AbortRuleId?: AbortRuleId; + /** + * Name of the bucket to which the multipart upload was initiated. + */ + Bucket?: BucketName; + /** + * Object key for which the multipart upload was initiated. + */ + Key?: ObjectKey; + /** + * Upload ID identifying the multipart upload whose parts are being listed. + */ + UploadId?: MultipartUploadId; + /** + * Part number after which listing begins. + */ + PartNumberMarker?: PartNumberMarker; + /** + * When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request. + */ + NextPartNumberMarker?: NextPartNumberMarker; + /** + * Maximum number of parts that were allowed in the response. + */ + MaxParts?: MaxParts; + /** + * Indicates whether the returned list of parts is truncated. + */ + IsTruncated?: IsTruncated; + /** + * + */ + Parts?: Parts; + /** + * Identifies who initiated the multipart upload. + */ + Initiator?: Initiator; + /** + * + */ + Owner?: Owner; + /** + * The class of storage used to store the object. + */ + StorageClass?: StorageClass; + RequestCharged?: RequestCharged; + } + export interface ListPartsRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * Sets the maximum number of parts to return. + */ + MaxParts?: MaxParts; + /** + * Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. + */ + PartNumberMarker?: PartNumberMarker; + /** + * Upload ID identifying the multipart upload whose parts are being listed. + */ + UploadId: MultipartUploadId; + RequestPayer?: RequestPayer; + } + export type Location = string; + export type LocationPrefix = string; + export interface LoggingEnabled { + /** + * Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. + */ + TargetBucket: TargetBucket; + /** + * + */ + TargetGrants?: TargetGrants; + /** + * This element lets you specify a prefix for the keys that the log files will be stored under. + */ + TargetPrefix: TargetPrefix; + } + export type MFA = string; + export type MFADelete = "Enabled"|"Disabled"|string; + export type MFADeleteStatus = "Enabled"|"Disabled"|string; + export type Marker = string; + export type MaxAgeSeconds = number; + export type MaxKeys = number; + export type MaxParts = number; + export type MaxUploads = number; + export type Message = string; + export type Metadata = {[key: string]: MetadataValue}; + export type MetadataDirective = "COPY"|"REPLACE"|string; + export interface MetadataEntry { + /** + * + */ + Name?: MetadataKey; + /** + * + */ + Value?: MetadataValue; + } + export type MetadataKey = string; + export type MetadataValue = string; + export interface MetricsAndOperator { + /** + * The prefix used when evaluating an AND predicate. + */ + Prefix?: Prefix; + /** + * The list of tags used when evaluating an AND predicate. + */ + Tags?: TagSet; + } + export interface MetricsConfiguration { + /** + * The ID used to identify the metrics configuration. + */ + Id: MetricsId; + /** + * Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator). + */ + Filter?: MetricsFilter; + } + export type MetricsConfigurationList = MetricsConfiguration[]; + export interface MetricsFilter { + /** + * The prefix used when evaluating a metrics filter. + */ + Prefix?: Prefix; + /** + * The tag used when evaluating a metrics filter. + */ + Tag?: Tag; + /** + * A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply. + */ + And?: MetricsAndOperator; + } + export type MetricsId = string; + export type MissingMeta = number; + export interface MultipartUpload { + /** + * Upload ID that identifies the multipart upload. + */ + UploadId?: MultipartUploadId; + /** + * Key of the object for which the multipart upload was initiated. + */ + Key?: ObjectKey; + /** + * Date and time at which the multipart upload was initiated. + */ + Initiated?: Initiated; + /** + * The class of storage used to store the object. + */ + StorageClass?: StorageClass; + /** + * + */ + Owner?: Owner; + /** + * Identifies who initiated the multipart upload. + */ + Initiator?: Initiator; + } + export type MultipartUploadId = string; + export type MultipartUploadList = MultipartUpload[]; + export type NextKeyMarker = string; + export type NextMarker = string; + export type NextPartNumberMarker = number; + export type NextToken = string; + export type NextUploadIdMarker = string; + export type NextVersionIdMarker = string; + export interface NoncurrentVersionExpiration { + /** + * Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide. + */ + NoncurrentDays?: Days; + } + export interface NoncurrentVersionTransition { + /** + * Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide. + */ + NoncurrentDays?: Days; + /** + * The class of storage used to store the object. + */ + StorageClass?: TransitionStorageClass; + } + export type NoncurrentVersionTransitionList = NoncurrentVersionTransition[]; + export interface NotificationConfiguration { + /** + * + */ + TopicConfigurations?: TopicConfigurationList; + /** + * + */ + QueueConfigurations?: QueueConfigurationList; + /** + * + */ + LambdaFunctionConfigurations?: LambdaFunctionConfigurationList; + } + export interface NotificationConfigurationDeprecated { + /** + * + */ + TopicConfiguration?: TopicConfigurationDeprecated; + /** + * + */ + QueueConfiguration?: QueueConfigurationDeprecated; + /** + * + */ + CloudFunctionConfiguration?: CloudFunctionConfiguration; + } + export interface NotificationConfigurationFilter { + Key?: S3KeyFilter; + } + export type NotificationId = string; + export interface Object { + /** + * + */ + Key?: ObjectKey; + /** + * + */ + LastModified?: LastModified; + /** + * + */ + ETag?: ETag; + /** + * + */ + Size?: Size; + /** + * The class of storage used to store the object. + */ + StorageClass?: ObjectStorageClass; + /** + * + */ + Owner?: Owner; + } + export type ObjectCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"aws-exec-read"|"bucket-owner-read"|"bucket-owner-full-control"|string; + export interface ObjectIdentifier { + /** + * Key name of the object to delete. + */ + Key: ObjectKey; + /** + * VersionId for the specific version of the object to delete. + */ + VersionId?: ObjectVersionId; + } + export type ObjectIdentifierList = ObjectIdentifier[]; + export type ObjectKey = string; + export type ObjectList = Object[]; + export interface ObjectLockConfiguration { + /** + * Indicates whether this bucket has an Object Lock configuration enabled. + */ + ObjectLockEnabled?: ObjectLockEnabled; + /** + * The Object Lock rule in place for the specified object. + */ + Rule?: ObjectLockRule; + } + export type ObjectLockEnabled = "Enabled"|string; + export type ObjectLockEnabledForBucket = boolean; + export interface ObjectLockLegalHold { + /** + * Indicates whether the specified object has a Legal Hold in place. + */ + Status?: ObjectLockLegalHoldStatus; + } + export type ObjectLockLegalHoldStatus = "ON"|"OFF"|string; + export type ObjectLockMode = "GOVERNANCE"|"COMPLIANCE"|string; + export type ObjectLockRetainUntilDate = Date; + export interface ObjectLockRetention { + /** + * Indicates the Retention mode for the specified object. + */ + Mode?: ObjectLockRetentionMode; + /** + * The date on which this Object Lock Retention will expire. + */ + RetainUntilDate?: _Date; + } + export type ObjectLockRetentionMode = "GOVERNANCE"|"COMPLIANCE"|string; + export interface ObjectLockRule { + /** + * The default retention period that you want to apply to new objects placed in the specified bucket. + */ + DefaultRetention?: DefaultRetention; + } + export type ObjectLockToken = string; + export type ObjectStorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string; + export interface ObjectVersion { + /** + * + */ + ETag?: ETag; + /** + * Size in bytes of the object. + */ + Size?: Size; + /** + * The class of storage used to store the object. + */ + StorageClass?: ObjectVersionStorageClass; + /** + * The object key. + */ + Key?: ObjectKey; + /** + * Version ID of an object. + */ + VersionId?: ObjectVersionId; + /** + * Specifies whether the object is (true) or is not (false) the latest version of an object. + */ + IsLatest?: IsLatest; + /** + * Date and time the object was last modified. + */ + LastModified?: LastModified; + /** + * + */ + Owner?: Owner; + } + export type ObjectVersionId = string; + export type ObjectVersionList = ObjectVersion[]; + export type ObjectVersionStorageClass = "STANDARD"|string; + export interface OutputLocation { + /** + * Describes an S3 location that will receive the results of the restore request. + */ + S3?: S3Location; + } + export interface OutputSerialization { + /** + * Describes the serialization of CSV-encoded Select results. + */ + CSV?: CSVOutput; + /** + * Specifies JSON as request's output serialization format. + */ + JSON?: JSONOutput; + } + export interface Owner { + /** + * + */ + DisplayName?: DisplayName; + /** + * + */ + ID?: ID; + } + export type OwnerOverride = "Destination"|string; + export interface ParquetInput { + } + export interface Part { + /** + * Part number identifying the part. This is a positive integer between 1 and 10,000. + */ + PartNumber?: PartNumber; + /** + * Date and time at which the part was uploaded. + */ + LastModified?: LastModified; + /** + * Entity tag returned when the part was uploaded. + */ + ETag?: ETag; + /** + * Size in bytes of the uploaded part data. + */ + Size?: Size; + } + export type PartNumber = number; + export type PartNumberMarker = number; + export type Parts = Part[]; + export type PartsCount = number; + export type Payer = "Requester"|"BucketOwner"|string; + export type Permission = "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"|string; + export type Policy = string; + export interface PolicyStatus { + /** + * The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public. + */ + IsPublic?: IsPublic; + } + export type Prefix = string; + export type Priority = number; + export interface Progress { + /** + * The current number of object bytes scanned. + */ + BytesScanned?: BytesScanned; + /** + * The current number of uncompressed object bytes processed. + */ + BytesProcessed?: BytesProcessed; + /** + * The current number of bytes of records payload data returned. + */ + BytesReturned?: BytesReturned; + } + export interface ProgressEvent { + /** + * The Progress event details. + */ + Details?: Progress; + } + export type Protocol = "http"|"https"|string; + export interface PublicAccessBlockConfiguration { + /** + * Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. PUT Object calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. + */ + BlockPublicAcls?: Setting; + /** + * Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. + */ + IgnorePublicAcls?: Setting; + /** + * Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. + */ + BlockPublicPolicy?: Setting; + /** + * Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. + */ + RestrictPublicBuckets?: Setting; + } + export interface PutBucketAccelerateConfigurationRequest { + /** + * Name of the bucket for which the accelerate configuration is set. + */ + Bucket: BucketName; + /** + * Specifies the Accelerate Configuration you want to set for the bucket. + */ + AccelerateConfiguration: AccelerateConfiguration; + } + export interface PutBucketAclRequest { + /** + * The canned ACL to apply to the bucket. + */ + ACL?: BucketCannedACL; + /** + * + */ + AccessControlPolicy?: AccessControlPolicy; + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. + */ + GrantFullControl?: GrantFullControl; + /** + * Allows grantee to list the objects in the bucket. + */ + GrantRead?: GrantRead; + /** + * Allows grantee to read the bucket ACL. + */ + GrantReadACP?: GrantReadACP; + /** + * Allows grantee to create, overwrite, and delete any object in the bucket. + */ + GrantWrite?: GrantWrite; + /** + * Allows grantee to write the ACL for the applicable bucket. + */ + GrantWriteACP?: GrantWriteACP; + } + export interface PutBucketAnalyticsConfigurationRequest { + /** + * The name of the bucket to which an analytics configuration is stored. + */ + Bucket: BucketName; + /** + * The identifier used to represent an analytics configuration. + */ + Id: AnalyticsId; + /** + * The configuration and any analyses for the analytics filter. + */ + AnalyticsConfiguration: AnalyticsConfiguration; + } + export interface PutBucketCorsRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + CORSConfiguration: CORSConfiguration; + /** + * + */ + ContentMD5?: ContentMD5; + } + export interface PutBucketEncryptionRequest { + /** + * The name of the bucket for which the server-side encryption configuration is set. + */ + Bucket: BucketName; + /** + * The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. This parameter is auto-populated when using the command from the CLI + */ + ContentMD5?: ContentMD5; + ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration; + } + export interface PutBucketInventoryConfigurationRequest { + /** + * The name of the bucket where the inventory configuration will be stored. + */ + Bucket: BucketName; + /** + * The ID used to identify the inventory configuration. + */ + Id: InventoryId; + /** + * Specifies the inventory configuration. + */ + InventoryConfiguration: InventoryConfiguration; + } + export interface PutBucketLifecycleConfigurationRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + LifecycleConfiguration?: BucketLifecycleConfiguration; + } + export interface PutBucketLifecycleRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * + */ + LifecycleConfiguration?: LifecycleConfiguration; + } + export interface PutBucketLoggingRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + BucketLoggingStatus: BucketLoggingStatus; + /** + * + */ + ContentMD5?: ContentMD5; + } + export interface PutBucketMetricsConfigurationRequest { + /** + * The name of the bucket for which the metrics configuration is set. + */ + Bucket: BucketName; + /** + * The ID used to identify the metrics configuration. + */ + Id: MetricsId; + /** + * Specifies the metrics configuration. + */ + MetricsConfiguration: MetricsConfiguration; + } + export interface PutBucketNotificationConfigurationRequest { + /** + * + */ + Bucket: BucketName; + NotificationConfiguration: NotificationConfiguration; + } + export interface PutBucketNotificationRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * + */ + NotificationConfiguration: NotificationConfigurationDeprecated; + } + export interface PutBucketPolicyRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future. + */ + ConfirmRemoveSelfBucketAccess?: ConfirmRemoveSelfBucketAccess; + /** + * The bucket policy as a JSON document. + */ + Policy: Policy; + } + export interface PutBucketReplicationRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + ReplicationConfiguration: ReplicationConfiguration; + } + export interface PutBucketRequestPaymentRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * + */ + RequestPaymentConfiguration: RequestPaymentConfiguration; + } + export interface PutBucketTaggingRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * + */ + Tagging: Tagging; + } + export interface PutBucketVersioningRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. + */ + MFA?: MFA; + /** + * + */ + VersioningConfiguration: VersioningConfiguration; + } + export interface PutBucketWebsiteRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * + */ + WebsiteConfiguration: WebsiteConfiguration; + } + export interface PutObjectAclOutput { + RequestCharged?: RequestCharged; + } + export interface PutObjectAclRequest { + /** + * The canned ACL to apply to the object. + */ + ACL?: ObjectCannedACL; + /** + * + */ + AccessControlPolicy?: AccessControlPolicy; + /** + * + */ + Bucket: BucketName; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. + */ + GrantFullControl?: GrantFullControl; + /** + * Allows grantee to list the objects in the bucket. + */ + GrantRead?: GrantRead; + /** + * Allows grantee to read the bucket ACL. + */ + GrantReadACP?: GrantReadACP; + /** + * Allows grantee to create, overwrite, and delete any object in the bucket. + */ + GrantWrite?: GrantWrite; + /** + * Allows grantee to write the ACL for the applicable bucket. + */ + GrantWriteACP?: GrantWriteACP; + /** + * + */ + Key: ObjectKey; + RequestPayer?: RequestPayer; + /** + * VersionId used to reference a specific version of the object. + */ + VersionId?: ObjectVersionId; + } + export interface PutObjectLegalHoldOutput { + RequestCharged?: RequestCharged; + } + export interface PutObjectLegalHoldRequest { + /** + * The bucket containing the object that you want to place a Legal Hold on. + */ + Bucket: BucketName; + /** + * The key name for the object that you want to place a Legal Hold on. + */ + Key: ObjectKey; + /** + * Container element for the Legal Hold configuration you want to apply to the specified object. + */ + LegalHold?: ObjectLockLegalHold; + RequestPayer?: RequestPayer; + /** + * The version ID of the object that you want to place a Legal Hold on. + */ + VersionId?: ObjectVersionId; + /** + * The MD5 hash for the request body. + */ + ContentMD5?: ContentMD5; + } + export interface PutObjectLockConfigurationOutput { + RequestCharged?: RequestCharged; + } + export interface PutObjectLockConfigurationRequest { + /** + * The bucket whose Object Lock configuration you want to create or replace. + */ + Bucket: BucketName; + /** + * The Object Lock configuration that you want to apply to the specified bucket. + */ + ObjectLockConfiguration?: ObjectLockConfiguration; + RequestPayer?: RequestPayer; + /** + * A token to allow Object Lock to be enabled for an existing bucket. + */ + Token?: ObjectLockToken; + /** + * The MD5 hash for the request body. + */ + ContentMD5?: ContentMD5; + } + export interface PutObjectOutput { + /** + * If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded. + */ + Expiration?: Expiration; + /** + * Entity tag for the uploaded object. + */ + ETag?: ETag; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * Version of the object. + */ + VersionId?: ObjectVersionId; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestCharged?: RequestCharged; + } + export interface PutObjectRequest { + /** + * The canned ACL to apply to the object. + */ + ACL?: ObjectCannedACL; + /** + * Object data. + */ + Body?: Body; + /** + * Name of the bucket to which the PUT operation was initiated. + */ + Bucket: BucketName; + /** + * Specifies caching behavior along the request/reply chain. + */ + CacheControl?: CacheControl; + /** + * Specifies presentational information for the object. + */ + ContentDisposition?: ContentDisposition; + /** + * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. + */ + ContentEncoding?: ContentEncoding; + /** + * The language the content is in. + */ + ContentLanguage?: ContentLanguage; + /** + * Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. + */ + ContentLength?: ContentLength; + /** + * The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI + */ + ContentMD5?: ContentMD5; + /** + * A standard MIME type describing the format of the object data. + */ + ContentType?: ContentType; + /** + * The date and time at which the object is no longer cacheable. + */ + Expires?: Expires; + /** + * Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. + */ + GrantFullControl?: GrantFullControl; + /** + * Allows grantee to read the object data and its metadata. + */ + GrantRead?: GrantRead; + /** + * Allows grantee to read the object ACL. + */ + GrantReadACP?: GrantReadACP; + /** + * Allows grantee to write the ACL for the applicable object. + */ + GrantWriteACP?: GrantWriteACP; + /** + * Object key for which the PUT operation was initiated. + */ + Key: ObjectKey; + /** + * A map of metadata to store with the object in S3. + */ + Metadata?: Metadata; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * The type of storage to use for the object. Defaults to 'STANDARD'. + */ + StorageClass?: StorageClass; + /** + * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. + */ + WebsiteRedirectLocation?: WebsiteRedirectLocation; + /** + * Specifies the algorithm to use to when encrypting the object (e.g., AES256). + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. + */ + SSECustomerKey?: SSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestPayer?: RequestPayer; + /** + * The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1") + */ + Tagging?: TaggingHeader; + /** + * The Object Lock mode that you want to apply to this object. + */ + ObjectLockMode?: ObjectLockMode; + /** + * The date and time when you want this object's Object Lock to expire. + */ + ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate; + /** + * The Legal Hold status that you want to apply to the specified object. + */ + ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus; + } + export interface PutObjectRetentionOutput { + RequestCharged?: RequestCharged; + } + export interface PutObjectRetentionRequest { + /** + * The bucket that contains the object you want to apply this Object Retention configuration to. + */ + Bucket: BucketName; + /** + * The key name for the object that you want to apply this Object Retention configuration to. + */ + Key: ObjectKey; + /** + * The container element for the Object Retention configuration. + */ + Retention?: ObjectLockRetention; + RequestPayer?: RequestPayer; + /** + * The version ID for the object that you want to apply this Object Retention configuration to. + */ + VersionId?: ObjectVersionId; + /** + * Indicates whether this operation should bypass Governance-mode restrictions.j + */ + BypassGovernanceRetention?: BypassGovernanceRetention; + /** + * The MD5 hash for the request body. + */ + ContentMD5?: ContentMD5; + } + export interface PutObjectTaggingOutput { + /** + * + */ + VersionId?: ObjectVersionId; + } + export interface PutObjectTaggingRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * + */ + VersionId?: ObjectVersionId; + /** + * + */ + ContentMD5?: ContentMD5; + /** + * + */ + Tagging: Tagging; + } + export interface PutPublicAccessBlockRequest { + /** + * The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set. + */ + Bucket: BucketName; + /** + * The MD5 hash of the PutPublicAccessBlock request body. + */ + ContentMD5?: ContentMD5; + /** + * The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide. + */ + PublicAccessBlockConfiguration: PublicAccessBlockConfiguration; + } + export type QueueArn = string; + export interface QueueConfiguration { + Id?: NotificationId; + /** + * The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 will publish a message when it detects events of the specified type. + */ + QueueArn: QueueArn; + /** + * + */ + Events: EventList; + Filter?: NotificationConfigurationFilter; + } + export interface QueueConfigurationDeprecated { + Id?: NotificationId; + Event?: Event; + /** + * + */ + Events?: EventList; + /** + * + */ + Queue?: QueueArn; + } + export type QueueConfigurationList = QueueConfiguration[]; + export type Quiet = boolean; + export type QuoteCharacter = string; + export type QuoteEscapeCharacter = string; + export type QuoteFields = "ALWAYS"|"ASNEEDED"|string; + export type Range = string; + export type RecordDelimiter = string; + export interface RecordsEvent { + /** + * The byte array of partial, one or more result records. + */ + Payload?: Buffer; + } + export interface Redirect { + /** + * The host name to use in the redirect request. + */ + HostName?: HostName; + /** + * The HTTP redirect code to use on the response. Not required if one of the siblings is present. + */ + HttpRedirectCode?: HttpRedirectCode; + /** + * Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. + */ + Protocol?: Protocol; + /** + * The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. + */ + ReplaceKeyPrefixWith?: ReplaceKeyPrefixWith; + /** + * The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided. + */ + ReplaceKeyWith?: ReplaceKeyWith; + } + export interface RedirectAllRequestsTo { + /** + * Name of the host where requests will be redirected. + */ + HostName: HostName; + /** + * Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. + */ + Protocol?: Protocol; + } + export type ReplaceKeyPrefixWith = string; + export type ReplaceKeyWith = string; + export type ReplicaKmsKeyID = string; + export interface ReplicationConfiguration { + /** + * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 can assume when replicating the objects. + */ + Role: Role; + /** + * A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules. + */ + Rules: ReplicationRules; + } + export interface ReplicationRule { + /** + * A unique identifier for the rule. The maximum value is 255 characters. + */ + ID?: ID; + /** + * The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example: Same object quality prefix based filter criteria If prefixes you specified in multiple rules overlap Same object qualify tag based filter criteria specified in multiple rules For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide. + */ + Priority?: Priority; + /** + * An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. + */ + Prefix?: Prefix; + Filter?: ReplicationRuleFilter; + /** + * If status isn't enabled, the rule is ignored. + */ + Status: ReplicationRuleStatus; + /** + * A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS). If you want Amazon S3 to replicate objects created with server-side encryption using AWS KMS-Managed Keys. + */ + SourceSelectionCriteria?: SourceSelectionCriteria; + /** + * A container for information about the replication destination. + */ + Destination: Destination; + DeleteMarkerReplication?: DeleteMarkerReplication; + } + export interface ReplicationRuleAndOperator { + /** + * + */ + Prefix?: Prefix; + /** + * + */ + Tags?: TagSet; + } + export interface ReplicationRuleFilter { + /** + * An object keyname prefix that identifies the subset of objects to which the rule applies. + */ + Prefix?: Prefix; + /** + * A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set. + */ + Tag?: Tag; + /** + * A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: If you specify both a Prefix and a Tag filter, wrap these filters in an And tag. If you specify a filter based on multiple tags, wrap the Tag elements in an And tag. + */ + And?: ReplicationRuleAndOperator; + } + export type ReplicationRuleStatus = "Enabled"|"Disabled"|string; + export type ReplicationRules = ReplicationRule[]; + export type ReplicationStatus = "COMPLETE"|"PENDING"|"FAILED"|"REPLICA"|string; + export type RequestCharged = "requester"|string; + export type RequestPayer = "requester"|string; + export interface RequestPaymentConfiguration { + /** + * Specifies who pays for the download and request fees. + */ + Payer: Payer; + } + export interface RequestProgress { + /** + * Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE. + */ + Enabled?: EnableRequestProgress; + } + export type ResponseCacheControl = string; + export type ResponseContentDisposition = string; + export type ResponseContentEncoding = string; + export type ResponseContentLanguage = string; + export type ResponseContentType = string; + export type ResponseExpires = Date; + export type Restore = string; + export interface RestoreObjectOutput { + RequestCharged?: RequestCharged; + /** + * Indicates the path in the provided S3 output location where Select results will be restored to. + */ + RestoreOutputPath?: RestoreOutputPath; + } + export interface RestoreObjectRequest { + /** + * + */ + Bucket: BucketName; + /** + * + */ + Key: ObjectKey; + /** + * + */ + VersionId?: ObjectVersionId; + RestoreRequest?: RestoreRequest; + RequestPayer?: RequestPayer; + } + export type RestoreOutputPath = string; + export interface RestoreRequest { + /** + * Lifetime of the active copy in days. Do not use with restores that specify OutputLocation. + */ + Days?: Days; + /** + * Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation. + */ + GlacierJobParameters?: GlacierJobParameters; + /** + * Type of restore request. + */ + Type?: RestoreRequestType; + /** + * Glacier retrieval tier at which the restore will be processed. + */ + Tier?: Tier; + /** + * The optional description for the job. + */ + Description?: Description; + /** + * Describes the parameters for Select job types. + */ + SelectParameters?: SelectParameters; + /** + * Describes the location where the restore job's output is stored. + */ + OutputLocation?: OutputLocation; + } + export type RestoreRequestType = "SELECT"|string; + export type Role = string; + export interface RoutingRule { + /** + * A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. + */ + Condition?: Condition; + /** + * Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. + */ + Redirect: Redirect; + } + export type RoutingRules = RoutingRule[]; + export interface Rule { + /** + * + */ + Expiration?: LifecycleExpiration; + /** + * Unique identifier for the rule. The value cannot be longer than 255 characters. + */ + ID?: ID; + /** + * Prefix identifying one or more objects to which the rule applies. + */ + Prefix: Prefix; + /** + * If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. + */ + Status: ExpirationStatus; + /** + * + */ + Transition?: Transition; + NoncurrentVersionTransition?: NoncurrentVersionTransition; + NoncurrentVersionExpiration?: NoncurrentVersionExpiration; + AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload; + } + export type Rules = Rule[]; + export interface S3KeyFilter { + FilterRules?: FilterRuleList; + } + export interface S3Location { + /** + * The name of the bucket where the restore results will be placed. + */ + BucketName: BucketName; + /** + * The prefix that is prepended to the restore results for this request. + */ + Prefix: LocationPrefix; + Encryption?: Encryption; + /** + * The canned ACL to apply to the restore results. + */ + CannedACL?: ObjectCannedACL; + /** + * A list of grants that control access to the staged results. + */ + AccessControlList?: Grants; + /** + * The tag-set that is applied to the restore results. + */ + Tagging?: Tagging; + /** + * A list of metadata to store with the restore results in S3. + */ + UserMetadata?: UserMetadata; + /** + * The class of storage used to store the restore results. + */ + StorageClass?: StorageClass; + } + export type SSECustomerAlgorithm = string; + export type SSECustomerKey = Buffer|Uint8Array|Blob|string; + export type SSECustomerKeyMD5 = string; + export interface SSEKMS { + /** + * Specifies the ID of the AWS Key Management Service (KMS) master encryption key to use for encrypting Inventory reports. + */ + KeyId: SSEKMSKeyId; + } + export type SSEKMSKeyId = string; + export interface SSES3 { + } + export type SelectObjectContentEventStream = EventStream<{Records?:RecordsEvent,Stats?:StatsEvent,Progress?:ProgressEvent,Cont?:ContinuationEvent,End?:EndEvent}>; + export interface SelectObjectContentOutput { + /** + * + */ + Payload?: SelectObjectContentEventStream; + } + export interface SelectObjectContentRequest { + /** + * The S3 bucket. + */ + Bucket: BucketName; + /** + * The object key. + */ + Key: ObjectKey; + /** + * The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys. + */ + SSECustomerKey?: SSECustomerKey; + /** + * The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * The expression that is used to query the object. + */ + Expression: Expression; + /** + * The type of the provided expression (for example., SQL). + */ + ExpressionType: ExpressionType; + /** + * Specifies if periodic request progress information should be enabled. + */ + RequestProgress?: RequestProgress; + /** + * Describes the format of the data in the object that is being queried. + */ + InputSerialization: InputSerialization; + /** + * Describes the format of the data that you want Amazon S3 to return in response. + */ + OutputSerialization: OutputSerialization; + } + export interface SelectParameters { + /** + * Describes the serialization format of the object. + */ + InputSerialization: InputSerialization; + /** + * The type of the provided expression (e.g., SQL). + */ + ExpressionType: ExpressionType; + /** + * The expression that is used to query the object. + */ + Expression: Expression; + /** + * Describes how the results of the Select job are serialized. + */ + OutputSerialization: OutputSerialization; + } + export type ServerSideEncryption = "AES256"|"aws:kms"|string; + export interface ServerSideEncryptionByDefault { + /** + * Server-side encryption algorithm to use for the default encryption. + */ + SSEAlgorithm: ServerSideEncryption; + /** + * KMS master key ID to use for the default encryption. This parameter is allowed if SSEAlgorithm is aws:kms. + */ + KMSMasterKeyID?: SSEKMSKeyId; + } + export interface ServerSideEncryptionConfiguration { + /** + * Container for information about a particular server-side encryption configuration rule. + */ + Rules: ServerSideEncryptionRules; + } + export interface ServerSideEncryptionRule { + /** + * Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied. + */ + ApplyServerSideEncryptionByDefault?: ServerSideEncryptionByDefault; + } + export type ServerSideEncryptionRules = ServerSideEncryptionRule[]; + export type Setting = boolean; + export type Size = number; + export interface SourceSelectionCriteria { + /** + * A container for filter information for the selection of S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required. + */ + SseKmsEncryptedObjects?: SseKmsEncryptedObjects; + } + export interface SseKmsEncryptedObjects { + /** + * If the status is not Enabled, replication for S3 objects encrypted with AWS KMS is disabled. + */ + Status: SseKmsEncryptedObjectsStatus; + } + export type SseKmsEncryptedObjectsStatus = "Enabled"|"Disabled"|string; + export type StartAfter = string; + export interface Stats { + /** + * The total number of object bytes scanned. + */ + BytesScanned?: BytesScanned; + /** + * The total number of uncompressed object bytes processed. + */ + BytesProcessed?: BytesProcessed; + /** + * The total number of bytes of records payload data returned. + */ + BytesReturned?: BytesReturned; + } + export interface StatsEvent { + /** + * The Stats event details. + */ + Details?: Stats; + } + export type StorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER"|"DEEP_ARCHIVE"|string; + export interface StorageClassAnalysis { + /** + * A container used to describe how data related to the storage class analysis should be exported. + */ + DataExport?: StorageClassAnalysisDataExport; + } + export interface StorageClassAnalysisDataExport { + /** + * The version of the output schema to use when exporting data. Must be V_1. + */ + OutputSchemaVersion: StorageClassAnalysisSchemaVersion; + /** + * The place to store the data for an analysis. + */ + Destination: AnalyticsExportDestination; + } + export type StorageClassAnalysisSchemaVersion = "V_1"|string; + export type Suffix = string; + export interface Tag { + /** + * Name of the tag. + */ + Key: ObjectKey; + /** + * Value of the tag. + */ + Value: Value; + } + export type TagCount = number; + export type TagSet = Tag[]; + export interface Tagging { + /** + * + */ + TagSet: TagSet; + } + export type TaggingDirective = "COPY"|"REPLACE"|string; + export type TaggingHeader = string; + export type TargetBucket = string; + export interface TargetGrant { + /** + * + */ + Grantee?: Grantee; + /** + * Logging permissions assigned to the Grantee for the bucket. + */ + Permission?: BucketLogsPermission; + } + export type TargetGrants = TargetGrant[]; + export type TargetPrefix = string; + export type Tier = "Standard"|"Bulk"|"Expedited"|string; + export type Token = string; + export type TopicArn = string; + export interface TopicConfiguration { + Id?: NotificationId; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 will publish a message when it detects events of the specified type. + */ + TopicArn: TopicArn; + /** + * + */ + Events: EventList; + Filter?: NotificationConfigurationFilter; + } + export interface TopicConfigurationDeprecated { + Id?: NotificationId; + /** + * + */ + Events?: EventList; + /** + * Bucket event for which to send notifications. + */ + Event?: Event; + /** + * Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket. + */ + Topic?: TopicArn; + } + export type TopicConfigurationList = TopicConfiguration[]; + export interface Transition { + /** + * Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format. + */ + Date?: _Date; + /** + * Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer. + */ + Days?: Days; + /** + * The class of storage used to store the object. + */ + StorageClass?: TransitionStorageClass; + } + export type TransitionList = Transition[]; + export type TransitionStorageClass = "GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string; + export type Type = "CanonicalUser"|"AmazonCustomerByEmail"|"Group"|string; + export type URI = string; + export type UploadIdMarker = string; + export interface UploadPartCopyOutput { + /** + * The version of the source object that was copied, if you have enabled versioning on the source bucket. + */ + CopySourceVersionId?: CopySourceVersionId; + /** + * + */ + CopyPartResult?: CopyPartResult; + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestCharged?: RequestCharged; + } + export interface UploadPartCopyRequest { + /** + * + */ + Bucket: BucketName; + /** + * The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded. + */ + CopySource: CopySource; + /** + * Copies the object if its entity tag (ETag) matches the specified tag. + */ + CopySourceIfMatch?: CopySourceIfMatch; + /** + * Copies the object if it has been modified since the specified time. + */ + CopySourceIfModifiedSince?: CopySourceIfModifiedSince; + /** + * Copies the object if its entity tag (ETag) is different than the specified ETag. + */ + CopySourceIfNoneMatch?: CopySourceIfNoneMatch; + /** + * Copies the object if it hasn't been modified since the specified time. + */ + CopySourceIfUnmodifiedSince?: CopySourceIfUnmodifiedSince; + /** + * The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 MB. + */ + CopySourceRange?: CopySourceRange; + /** + * + */ + Key: ObjectKey; + /** + * Part number of part being copied. This is a positive integer between 1 and 10,000. + */ + PartNumber: PartNumber; + /** + * Upload ID identifying the multipart upload whose part is being copied. + */ + UploadId: MultipartUploadId; + /** + * Specifies the algorithm to use to when encrypting the object (e.g., AES256). + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request. + */ + SSECustomerKey?: SSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * Specifies the algorithm to use when decrypting the source object (e.g., AES256). + */ + CopySourceSSECustomerAlgorithm?: CopySourceSSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created. + */ + CopySourceSSECustomerKey?: CopySourceSSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + CopySourceSSECustomerKeyMD5?: CopySourceSSECustomerKeyMD5; + RequestPayer?: RequestPayer; + } + export interface UploadPartOutput { + /** + * The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). + */ + ServerSideEncryption?: ServerSideEncryption; + /** + * Entity tag for the uploaded object. + */ + ETag?: ETag; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used. + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + /** + * If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object. + */ + SSEKMSKeyId?: SSEKMSKeyId; + RequestCharged?: RequestCharged; + } + export interface UploadPartRequest { + /** + * Object data. + */ + Body?: Body; + /** + * Name of the bucket to which the multipart upload was initiated. + */ + Bucket: BucketName; + /** + * Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. + */ + ContentLength?: ContentLength; + /** + * The base64-encoded 128-bit MD5 digest of the part data. + */ + ContentMD5?: ContentMD5; + /** + * Object key for which the multipart upload was initiated. + */ + Key: ObjectKey; + /** + * Part number of part being uploaded. This is a positive integer between 1 and 10,000. + */ + PartNumber: PartNumber; + /** + * Upload ID identifying the multipart upload whose part is being uploaded. + */ + UploadId: MultipartUploadId; + /** + * Specifies the algorithm to use to when encrypting the object (e.g., AES256). + */ + SSECustomerAlgorithm?: SSECustomerAlgorithm; + /** + * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request. + */ + SSECustomerKey?: SSECustomerKey; + /** + * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error. + */ + SSECustomerKeyMD5?: SSECustomerKeyMD5; + RequestPayer?: RequestPayer; + } + export type UserMetadata = MetadataEntry[]; + export type Value = string; + export type VersionIdMarker = string; + export interface VersioningConfiguration { + /** + * Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned. + */ + MFADelete?: MFADelete; + /** + * The versioning state of the bucket. + */ + Status?: BucketVersioningStatus; + } + export interface WebsiteConfiguration { + /** + * + */ + ErrorDocument?: ErrorDocument; + /** + * + */ + IndexDocument?: IndexDocument; + /** + * + */ + RedirectAllRequestsTo?: RedirectAllRequestsTo; + /** + * + */ + RoutingRules?: RoutingRules; + } + export type WebsiteRedirectLocation = string; + export type Years = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2006-03-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & UseDualstackConfigOptions & ClientApiVersions; + /** + * Contains interfaces for use with the S3 client. + */ + export import Types = S3; +} +export = S3; diff --git a/node_modules/aws-sdk/clients/s3.js b/node_modules/aws-sdk/clients/s3.js new file mode 100644 index 0000000..7ad1507 --- /dev/null +++ b/node_modules/aws-sdk/clients/s3.js @@ -0,0 +1,20 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['s3'] = {}; +AWS.S3 = Service.defineService('s3', ['2006-03-01']); +require('../lib/services/s3'); +Object.defineProperty(apiLoader.services['s3'], '2006-03-01', { + get: function get() { + var model = require('../apis/s3-2006-03-01.min.json'); + model.paginators = require('../apis/s3-2006-03-01.paginators.json').pagination; + model.waiters = require('../apis/s3-2006-03-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.S3; diff --git a/node_modules/aws-sdk/clients/s3control.d.ts b/node_modules/aws-sdk/clients/s3control.d.ts new file mode 100644 index 0000000..beec155 --- /dev/null +++ b/node_modules/aws-sdk/clients/s3control.d.ts @@ -0,0 +1,740 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +import {UseDualstackConfigOptions} from '../lib/config_use_dualstack'; +interface Blob {} +declare class S3Control extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: S3Control.Types.ClientConfiguration) + config: Config & S3Control.Types.ClientConfiguration; + /** + * Creates an Amazon S3 batch operations job. + */ + createJob(params: S3Control.Types.CreateJobRequest, callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request; + /** + * Creates an Amazon S3 batch operations job. + */ + createJob(callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request; + /** + * Deletes the block public access configuration for the specified account. + */ + deletePublicAccessBlock(params: S3Control.Types.DeletePublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the block public access configuration for the specified account. + */ + deletePublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves the configuration parameters and status for a batch operations job. + */ + describeJob(params: S3Control.Types.DescribeJobRequest, callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request; + /** + * Retrieves the configuration parameters and status for a batch operations job. + */ + describeJob(callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request; + /** + * + */ + getPublicAccessBlock(params: S3Control.Types.GetPublicAccessBlockRequest, callback?: (err: AWSError, data: S3Control.Types.GetPublicAccessBlockOutput) => void): Request; + /** + * + */ + getPublicAccessBlock(callback?: (err: AWSError, data: S3Control.Types.GetPublicAccessBlockOutput) => void): Request; + /** + * Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request. + */ + listJobs(params: S3Control.Types.ListJobsRequest, callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request; + /** + * Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request. + */ + listJobs(callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request; + /** + * + */ + putPublicAccessBlock(params: S3Control.Types.PutPublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * + */ + putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates an existing job's priority. + */ + updateJobPriority(params: S3Control.Types.UpdateJobPriorityRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request; + /** + * Updates an existing job's priority. + */ + updateJobPriority(callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request; + /** + * Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. + */ + updateJobStatus(params: S3Control.Types.UpdateJobStatusRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request; + /** + * Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. + */ + updateJobStatus(callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request; +} +declare namespace S3Control { + export type AccountId = string; + export type Boolean = boolean; + export type ConfirmationRequired = boolean; + export interface CreateJobRequest { + /** + * + */ + AccountId: AccountId; + /** + * Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console. + */ + ConfirmationRequired?: ConfirmationRequired; + /** + * The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations in the Amazon Simple Storage Service Developer Guide. + */ + Operation: JobOperation; + /** + * Configuration parameters for the optional job-completion report. + */ + Report: JobReport; + /** + * An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length. + */ + ClientRequestToken: NonEmptyMaxLength64String; + /** + * Configuration parameters for the manifest. + */ + Manifest: JobManifest; + /** + * A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs. + */ + Description?: NonEmptyMaxLength256String; + /** + * The numerical priority for this job. Higher numbers indicate higher priority. + */ + Priority: JobPriority; + /** + * The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest. + */ + RoleArn: IAMRoleArn; + } + export interface CreateJobResult { + /** + * The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request. + */ + JobId?: JobId; + } + export interface DeletePublicAccessBlockRequest { + /** + * The account ID for the AWS account whose block public access configuration you want to delete. + */ + AccountId: AccountId; + } + export interface DescribeJobRequest { + /** + * + */ + AccountId: AccountId; + /** + * The ID for the job whose information you want to retrieve. + */ + JobId: JobId; + } + export interface DescribeJobResult { + /** + * Contains the configuration parameters and status for the job specified in the Describe Job request. + */ + Job?: JobDescriptor; + } + export interface GetPublicAccessBlockOutput { + /** + * + */ + PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration; + } + export interface GetPublicAccessBlockRequest { + /** + * + */ + AccountId: AccountId; + } + export type IAMRoleArn = string; + export type JobArn = string; + export type JobCreationTime = Date; + export interface JobDescriptor { + /** + * The ID for the specified job. + */ + JobId?: JobId; + /** + * Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console. + */ + ConfirmationRequired?: ConfirmationRequired; + /** + * The description for this job, if one was provided in this job's Create Job request. + */ + Description?: NonEmptyMaxLength256String; + /** + * The Amazon Resource Name (ARN) for this job. + */ + JobArn?: JobArn; + /** + * The current status of the specified job. + */ + Status?: JobStatus; + /** + * The configuration information for the specified job's manifest object. + */ + Manifest?: JobManifest; + /** + * The operation that the specified job is configured to execute on the objects listed in the manifest. + */ + Operation?: JobOperation; + /** + * The priority of the specified job. + */ + Priority?: JobPriority; + /** + * Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed. + */ + ProgressSummary?: JobProgressSummary; + /** + * + */ + StatusUpdateReason?: JobStatusUpdateReason; + /** + * If the specified job failed, this field contains information describing the failure. + */ + FailureReasons?: JobFailureList; + /** + * Contains the configuration information for the job-completion report if you requested one in the Create Job request. + */ + Report?: JobReport; + /** + * A timestamp indicating when this job was created. + */ + CreationTime?: JobCreationTime; + /** + * A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled. + */ + TerminationDate?: JobTerminationDate; + /** + * The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job. + */ + RoleArn?: IAMRoleArn; + /** + * The timestamp when this job was suspended, if it has been suspended. + */ + SuspendedDate?: SuspendedDate; + /** + * The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state. + */ + SuspendedCause?: SuspendedCause; + } + export interface JobFailure { + /** + * The failure code, if any, for the specified job. + */ + FailureCode?: JobFailureCode; + /** + * The failure reason, if any, for the specified job. + */ + FailureReason?: JobFailureReason; + } + export type JobFailureCode = string; + export type JobFailureList = JobFailure[]; + export type JobFailureReason = string; + export type JobId = string; + export interface JobListDescriptor { + /** + * The ID for the specified job. + */ + JobId?: JobId; + /** + * The user-specified description that was included in the specified job's Create Job request. + */ + Description?: NonEmptyMaxLength256String; + /** + * The operation that the specified job is configured to run on each object listed in the manifest. + */ + Operation?: OperationName; + /** + * The current priority for the specified job. + */ + Priority?: JobPriority; + /** + * The specified job's current status. + */ + Status?: JobStatus; + /** + * A timestamp indicating when the specified job was created. + */ + CreationTime?: JobCreationTime; + /** + * A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled. + */ + TerminationDate?: JobTerminationDate; + /** + * Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed. + */ + ProgressSummary?: JobProgressSummary; + } + export type JobListDescriptorList = JobListDescriptor[]; + export interface JobManifest { + /** + * Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest. + */ + Spec: JobManifestSpec; + /** + * Contains the information required to locate the specified job's manifest. + */ + Location: JobManifestLocation; + } + export type JobManifestFieldList = JobManifestFieldName[]; + export type JobManifestFieldName = "Ignore"|"Bucket"|"Key"|"VersionId"|string; + export type JobManifestFormat = "S3BatchOperations_CSV_20180820"|"S3InventoryReport_CSV_20161130"|string; + export interface JobManifestLocation { + /** + * The Amazon Resource Name (ARN) for a manifest object. + */ + ObjectArn: S3KeyArnString; + /** + * The optional version ID to identify a specific version of the manifest object. + */ + ObjectVersionId?: S3ObjectVersionId; + /** + * The ETag for the specified manifest object. + */ + ETag: NonEmptyMaxLength1024String; + } + export interface JobManifestSpec { + /** + * Indicates which of the available formats the specified manifest uses. + */ + Format: JobManifestFormat; + /** + * If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data. + */ + Fields?: JobManifestFieldList; + } + export type JobNumberOfTasksFailed = number; + export type JobNumberOfTasksSucceeded = number; + export interface JobOperation { + /** + * Directs the specified job to invoke an AWS Lambda function on each object in the manifest. + */ + LambdaInvoke?: LambdaInvokeOperation; + /** + * Directs the specified job to execute a PUT Copy object call on each object in the manifest. + */ + S3PutObjectCopy?: S3CopyObjectOperation; + /** + * Directs the specified job to execute a PUT Object acl call on each object in the manifest. + */ + S3PutObjectAcl?: S3SetObjectAclOperation; + /** + * Directs the specified job to execute a PUT Object tagging call on each object in the manifest. + */ + S3PutObjectTagging?: S3SetObjectTaggingOperation; + /** + * Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest. + */ + S3InitiateRestoreObject?: S3InitiateRestoreObjectOperation; + } + export type JobPriority = number; + export interface JobProgressSummary { + /** + * + */ + TotalNumberOfTasks?: JobTotalNumberOfTasks; + /** + * + */ + NumberOfTasksSucceeded?: JobNumberOfTasksSucceeded; + /** + * + */ + NumberOfTasksFailed?: JobNumberOfTasksFailed; + } + export interface JobReport { + /** + * The bucket where specified job-completion report will be stored. + */ + Bucket?: S3BucketArnString; + /** + * The format of the specified job-completion report. + */ + Format?: JobReportFormat; + /** + * Indicates whether the specified job will generate a job-completion report. + */ + Enabled: Boolean; + /** + * An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 will store the job-completion report at <prefix>/job-<job-id>/report.json. + */ + Prefix?: ReportPrefixString; + /** + * Indicates whether the job-completion report will include details of all tasks or only failed tasks. + */ + ReportScope?: JobReportScope; + } + export type JobReportFormat = "Report_CSV_20180820"|string; + export type JobReportScope = "AllTasks"|"FailedTasksOnly"|string; + export type JobStatus = "Active"|"Cancelled"|"Cancelling"|"Complete"|"Completing"|"Failed"|"Failing"|"New"|"Paused"|"Pausing"|"Preparing"|"Ready"|"Suspended"|string; + export type JobStatusList = JobStatus[]; + export type JobStatusUpdateReason = string; + export type JobTerminationDate = Date; + export type JobTotalNumberOfTasks = number; + export type KmsKeyArnString = string; + export interface LambdaInvokeOperation { + /** + * The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest. + */ + FunctionArn?: NonEmptyMaxLength1024String; + } + export interface ListJobsRequest { + /** + * + */ + AccountId: AccountId; + /** + * The List Jobs request returns jobs that match the statuses listed in this element. + */ + JobStatuses?: JobStatusList; + /** + * A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request. + */ + NextToken?: NonEmptyMaxLength1024String; + /** + * The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results. + */ + MaxResults?: MaxResults; + } + export interface ListJobsResult { + /** + * If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results. + */ + NextToken?: NonEmptyMaxLength1024String; + /** + * The list of current jobs and jobs that have ended within the last 30 days. + */ + Jobs?: JobListDescriptorList; + } + export type MaxLength1024String = string; + export type MaxResults = number; + export type NonEmptyMaxLength1024String = string; + export type NonEmptyMaxLength2048String = string; + export type NonEmptyMaxLength256String = string; + export type NonEmptyMaxLength64String = string; + export type OperationName = "LambdaInvoke"|"S3PutObjectCopy"|"S3PutObjectAcl"|"S3PutObjectTagging"|"S3InitiateRestoreObject"|string; + export interface PublicAccessBlockConfiguration { + /** + * + */ + BlockPublicAcls?: Setting; + /** + * + */ + IgnorePublicAcls?: Setting; + /** + * + */ + BlockPublicPolicy?: Setting; + /** + * + */ + RestrictPublicBuckets?: Setting; + } + export interface PutPublicAccessBlockRequest { + /** + * + */ + PublicAccessBlockConfiguration: PublicAccessBlockConfiguration; + /** + * + */ + AccountId: AccountId; + } + export type ReportPrefixString = string; + export type RequestedJobStatus = "Cancelled"|"Ready"|string; + export interface S3AccessControlList { + /** + * + */ + Owner: S3ObjectOwner; + /** + * + */ + Grants?: S3GrantList; + } + export interface S3AccessControlPolicy { + /** + * + */ + AccessControlList?: S3AccessControlList; + /** + * + */ + CannedAccessControlList?: S3CannedAccessControlList; + } + export type S3BucketArnString = string; + export type S3CannedAccessControlList = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|string; + export type S3ContentLength = number; + export interface S3CopyObjectOperation { + /** + * + */ + TargetResource?: S3BucketArnString; + /** + * + */ + CannedAccessControlList?: S3CannedAccessControlList; + /** + * + */ + AccessControlGrants?: S3GrantList; + /** + * + */ + MetadataDirective?: S3MetadataDirective; + /** + * + */ + ModifiedSinceConstraint?: TimeStamp; + /** + * + */ + NewObjectMetadata?: S3ObjectMetadata; + /** + * + */ + NewObjectTagging?: S3TagSet; + /** + * + */ + RedirectLocation?: NonEmptyMaxLength2048String; + /** + * + */ + RequesterPays?: Boolean; + /** + * + */ + StorageClass?: S3StorageClass; + /** + * + */ + UnModifiedSinceConstraint?: TimeStamp; + /** + * + */ + SSEAwsKmsKeyId?: KmsKeyArnString; + TargetKeyPrefix?: NonEmptyMaxLength1024String; + ObjectLockLegalHoldStatus?: S3ObjectLockLegalHoldStatus; + ObjectLockMode?: S3ObjectLockMode; + ObjectLockRetainUntilDate?: TimeStamp; + } + export type S3ExpirationInDays = number; + export type S3GlacierJobTier = "BULK"|"STANDARD"|string; + export interface S3Grant { + /** + * + */ + Grantee?: S3Grantee; + /** + * + */ + Permission?: S3Permission; + } + export type S3GrantList = S3Grant[]; + export interface S3Grantee { + /** + * + */ + TypeIdentifier?: S3GranteeTypeIdentifier; + /** + * + */ + Identifier?: NonEmptyMaxLength1024String; + /** + * + */ + DisplayName?: NonEmptyMaxLength1024String; + } + export type S3GranteeTypeIdentifier = "id"|"emailAddress"|"uri"|string; + export interface S3InitiateRestoreObjectOperation { + /** + * + */ + ExpirationInDays?: S3ExpirationInDays; + /** + * + */ + GlacierJobTier?: S3GlacierJobTier; + } + export type S3KeyArnString = string; + export type S3MetadataDirective = "COPY"|"REPLACE"|string; + export type S3ObjectLockLegalHoldStatus = "OFF"|"ON"|string; + export type S3ObjectLockMode = "COMPLIANCE"|"GOVERNANCE"|string; + export interface S3ObjectMetadata { + /** + * + */ + CacheControl?: NonEmptyMaxLength1024String; + /** + * + */ + ContentDisposition?: NonEmptyMaxLength1024String; + /** + * + */ + ContentEncoding?: NonEmptyMaxLength1024String; + /** + * + */ + ContentLanguage?: NonEmptyMaxLength1024String; + /** + * + */ + UserMetadata?: S3UserMetadata; + /** + * + */ + ContentLength?: S3ContentLength; + /** + * + */ + ContentMD5?: NonEmptyMaxLength1024String; + /** + * + */ + ContentType?: NonEmptyMaxLength1024String; + /** + * + */ + HttpExpiresDate?: TimeStamp; + /** + * + */ + RequesterCharged?: Boolean; + /** + * + */ + SSEAlgorithm?: S3SSEAlgorithm; + } + export interface S3ObjectOwner { + /** + * + */ + ID?: NonEmptyMaxLength1024String; + /** + * + */ + DisplayName?: NonEmptyMaxLength1024String; + } + export type S3ObjectVersionId = string; + export type S3Permission = "FULL_CONTROL"|"READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"|string; + export type S3SSEAlgorithm = "AES256"|"KMS"|string; + export interface S3SetObjectAclOperation { + /** + * + */ + AccessControlPolicy?: S3AccessControlPolicy; + } + export interface S3SetObjectTaggingOperation { + /** + * + */ + TagSet?: S3TagSet; + } + export type S3StorageClass = "STANDARD"|"STANDARD_IA"|"ONEZONE_IA"|"GLACIER"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string; + export interface S3Tag { + /** + * + */ + Key: NonEmptyMaxLength1024String; + /** + * + */ + Value: MaxLength1024String; + } + export type S3TagSet = S3Tag[]; + export type S3UserMetadata = {[key: string]: MaxLength1024String}; + export type Setting = boolean; + export type SuspendedCause = string; + export type SuspendedDate = Date; + export type TimeStamp = Date; + export interface UpdateJobPriorityRequest { + /** + * + */ + AccountId: AccountId; + /** + * The ID for the job whose priority you want to update. + */ + JobId: JobId; + /** + * The priority you want to assign to this job. + */ + Priority: JobPriority; + } + export interface UpdateJobPriorityResult { + /** + * The ID for the job whose priority Amazon S3 updated. + */ + JobId: JobId; + /** + * The new priority assigned to the specified job. + */ + Priority: JobPriority; + } + export interface UpdateJobStatusRequest { + /** + * + */ + AccountId: AccountId; + /** + * The ID of the job whose status you want to update. + */ + JobId: JobId; + /** + * The status that you want to move the specified job to. + */ + RequestedJobStatus: RequestedJobStatus; + /** + * A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length. + */ + StatusUpdateReason?: JobStatusUpdateReason; + } + export interface UpdateJobStatusResult { + /** + * The ID for the job whose status was updated. + */ + JobId?: JobId; + /** + * The current status for the specified job. + */ + Status?: JobStatus; + /** + * The reason that the specified job's status was updated. + */ + StatusUpdateReason?: JobStatusUpdateReason; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-08-20"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & UseDualstackConfigOptions & ClientApiVersions; + /** + * Contains interfaces for use with the S3Control client. + */ + export import Types = S3Control; +} +export = S3Control; diff --git a/node_modules/aws-sdk/clients/s3control.js b/node_modules/aws-sdk/clients/s3control.js new file mode 100644 index 0000000..aef47a1 --- /dev/null +++ b/node_modules/aws-sdk/clients/s3control.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['s3control'] = {}; +AWS.S3Control = Service.defineService('s3control', ['2018-08-20']); +require('../lib/services/s3control'); +Object.defineProperty(apiLoader.services['s3control'], '2018-08-20', { + get: function get() { + var model = require('../apis/s3control-2018-08-20.min.json'); + model.paginators = require('../apis/s3control-2018-08-20.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.S3Control; diff --git a/node_modules/aws-sdk/clients/sagemaker.d.ts b/node_modules/aws-sdk/clients/sagemaker.d.ts new file mode 100644 index 0000000..26249cf --- /dev/null +++ b/node_modules/aws-sdk/clients/sagemaker.d.ts @@ -0,0 +1,5195 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SageMaker extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SageMaker.Types.ClientConfiguration) + config: Config & SageMaker.Types.ClientConfiguration; + /** + * Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, models, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see AWS Tagging Strategies. Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob + */ + addTags(params: SageMaker.Types.AddTagsInput, callback?: (err: AWSError, data: SageMaker.Types.AddTagsOutput) => void): Request; + /** + * Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, models, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see AWS Tagging Strategies. Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob + */ + addTags(callback?: (err: AWSError, data: SageMaker.Types.AddTagsOutput) => void): Request; + /** + * Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace. + */ + createAlgorithm(params: SageMaker.Types.CreateAlgorithmInput, callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request; + /** + * Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace. + */ + createAlgorithm(callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request; + /** + * Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. The repository can be hosted either in AWS CodeCommit or in any other Git repository. + */ + createCodeRepository(params: SageMaker.Types.CreateCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request; + /** + * Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. The repository can be hosted either in AWS CodeCommit or in any other Git repository. + */ + createCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request; + /** + * Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource. In the request body, you provide the following: A name for the compilation job Information about the input model artifacts The output location for the compiled model and the device (target) that the model runs on The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job. To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs. + */ + createCompilationJob(params: SageMaker.Types.CreateCompilationJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateCompilationJobResponse) => void): Request; + /** + * Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource. In the request body, you provide the following: A name for the compilation job Information about the input model artifacts The output location for the compiled model and the device (target) that the model runs on The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job. To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs. + */ + createCompilationJob(callback?: (err: AWSError, data: SageMaker.Types.CreateCompilationJobResponse) => void): Request; + /** + * Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API only for hosting models using Amazon SageMaker hosting services. The endpoint name must be unique within an AWS Region in your AWS account. When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker. If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide. + */ + createEndpoint(params: SageMaker.Types.CreateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request; + /** + * Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API only for hosting models using Amazon SageMaker hosting services. The endpoint name must be unique within an AWS Region in your AWS account. When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker. If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide. + */ + createEndpoint(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request; + /** + * Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API. Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production. In the request, you define one or more ProductionVariants, each of which identifies a model. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy. If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. + */ + createEndpointConfig(params: SageMaker.Types.CreateEndpointConfigInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request; + /** + * Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API. Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production. In the request, you define one or more ProductionVariants, each of which identifies a model. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy. If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. + */ + createEndpointConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request; + /** + * Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose. + */ + createHyperParameterTuningJob(params: SageMaker.Types.CreateHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateHyperParameterTuningJobResponse) => void): Request; + /** + * Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose. + */ + createHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.CreateHyperParameterTuningJobResponse) => void): Request; + /** + * Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models. You can select your workforce from one of three providers: A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required. One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas. The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information. You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling. The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data. The output can be used as the manifest file for another labeling job or as training data for your machine learning models. + */ + createLabelingJob(params: SageMaker.Types.CreateLabelingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateLabelingJobResponse) => void): Request; + /** + * Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models. You can select your workforce from one of three providers: A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required. One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas. The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information. You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling. The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data. The output can be used as the manifest file for another labeling job or as training data for your machine learning models. + */ + createLabelingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateLabelingJobResponse) => void): Request; + /** + * Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the docker image containing inference code, artifacts (from prior training), and custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job. To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment. To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. In the CreateModel request, you must define a container with the PrimaryContainer parameter. In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role. + */ + createModel(params: SageMaker.Types.CreateModelInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request; + /** + * Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the docker image containing inference code, artifacts (from prior training), and custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job. To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment. To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. In the CreateModel request, you must define a container with the PrimaryContainer parameter. In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role. + */ + createModel(callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request; + /** + * Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification. + */ + createModelPackage(params: SageMaker.Types.CreateModelPackageInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request; + /** + * Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification. + */ + createModelPackage(callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request; + /** + * Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework. After receiving the request, Amazon SageMaker does the following: Creates a network interface in the Amazon SageMaker VPC. (Option) If you specified SubnetId, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC. Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it. After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models. For more information, see How It Works. + */ + createNotebookInstance(params: SageMaker.Types.CreateNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request; + /** + * Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework. After receiving the request, Amazon SageMaker does the following: Creates a network interface in the Amazon SageMaker VPC. (Option) If you specified SubnetId, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC. Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it. After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models. For more information, see How It Works. + */ + createNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request; + /** + * Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance. Each lifecycle configuration script has a limit of 16384 characters. The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin. View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook]. Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. + */ + createNotebookInstanceLifecycleConfig(params: SageMaker.Types.CreateNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput) => void): Request; + /** + * Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance. Each lifecycle configuration script has a limit of 16384 characters. The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin. View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook]. Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. + */ + createNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput) => void): Request; + /** + * Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. To restrict access, attach an IAM policy that denies access to this API unless the call comes from an IP address in the specified list to every AWS Identity and Access Management user, group, or role used to access the notebook instance. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address. + */ + createPresignedNotebookInstanceUrl(params: SageMaker.Types.CreatePresignedNotebookInstanceUrlInput, callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request; + /** + * Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. To restrict access, attach an IAM policy that denies access to this API unless the call comes from an IP address in the specified list to every AWS Identity and Access Management user, group, or role used to access the notebook instance. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address. + */ + createPresignedNotebookInstanceUrl(callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request; + /** + * Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inferences. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to influence the quality of the final model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3 location where it is stored. OutputDataConfig - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. RoleARN - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. StoppingCondition - Sets a duration for training. Use this parameter to cap model training costs. For more information about Amazon SageMaker, see How It Works. + */ + createTrainingJob(params: SageMaker.Types.CreateTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request; + /** + * Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inferences. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to influence the quality of the final model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3 location where it is stored. OutputDataConfig - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. RoleARN - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. StoppingCondition - Sets a duration for training. Use this parameter to cap model training costs. For more information about Amazon SageMaker, see How It Works. + */ + createTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request; + /** + * Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify. To perform batch transformations, you create a transform job and use the data that you have readily available. In the request body, you provide the following: TransformJobName - Identifies the transform job. The name must be unique within an AWS Region in an AWS account. ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see CreateModel. TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored. TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. TransformResources - Identifies the ML compute instances for the transform job. For more information about how batch transformation works Amazon SageMaker, see How It Works. + */ + createTransformJob(params: SageMaker.Types.CreateTransformJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTransformJobResponse) => void): Request; + /** + * Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify. To perform batch transformations, you create a transform job and use the data that you have readily available. In the request body, you provide the following: TransformJobName - Identifies the transform job. The name must be unique within an AWS Region in an AWS account. ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see CreateModel. TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored. TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. TransformResources - Identifies the ML compute instances for the transform job. For more information about how batch transformation works Amazon SageMaker, see How It Works. + */ + createTransformJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTransformJobResponse) => void): Request; + /** + * Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team. You cannot create more than 25 work teams in an account and region. + */ + createWorkteam(params: SageMaker.Types.CreateWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateWorkteamResponse) => void): Request; + /** + * Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team. You cannot create more than 25 work teams in an account and region. + */ + createWorkteam(callback?: (err: AWSError, data: SageMaker.Types.CreateWorkteamResponse) => void): Request; + /** + * Removes the specified algorithm from your account. + */ + deleteAlgorithm(params: SageMaker.Types.DeleteAlgorithmInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the specified algorithm from your account. + */ + deleteAlgorithm(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Git repository from your account. + */ + deleteCodeRepository(params: SageMaker.Types.DeleteCodeRepositoryInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified Git repository from your account. + */ + deleteCodeRepository(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created. Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call. + */ + deleteEndpoint(params: SageMaker.Types.DeleteEndpointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created. Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call. + */ + deleteEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration. + */ + deleteEndpointConfig(params: SageMaker.Types.DeleteEndpointConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration. + */ + deleteEndpointConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model. + */ + deleteModel(params: SageMaker.Types.DeleteModelInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model. + */ + deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a model package. A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker. + */ + deleteModelPackage(params: SageMaker.Types.DeleteModelPackageInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a model package. A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker. + */ + deleteModelPackage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API. When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance. + */ + deleteNotebookInstance(params: SageMaker.Types.DeleteNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API. When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance. + */ + deleteNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a notebook instance lifecycle configuration. + */ + deleteNotebookInstanceLifecycleConfig(params: SageMaker.Types.DeleteNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a notebook instance lifecycle configuration. + */ + deleteNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified tags from an Amazon SageMaker resource. To list a resource's tags, use the ListTags API. When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API. + */ + deleteTags(params: SageMaker.Types.DeleteTagsInput, callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request; + /** + * Deletes the specified tags from an Amazon SageMaker resource. To list a resource's tags, use the ListTags API. When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API. + */ + deleteTags(callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request; + /** + * Deletes an existing work team. This operation can't be undone. + */ + deleteWorkteam(params: SageMaker.Types.DeleteWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DeleteWorkteamResponse) => void): Request; + /** + * Deletes an existing work team. This operation can't be undone. + */ + deleteWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DeleteWorkteamResponse) => void): Request; + /** + * Returns a description of the specified algorithm that is in your account. + */ + describeAlgorithm(params: SageMaker.Types.DescribeAlgorithmInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeAlgorithmOutput) => void): Request; + /** + * Returns a description of the specified algorithm that is in your account. + */ + describeAlgorithm(callback?: (err: AWSError, data: SageMaker.Types.DescribeAlgorithmOutput) => void): Request; + /** + * Gets details about the specified Git repository. + */ + describeCodeRepository(params: SageMaker.Types.DescribeCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeCodeRepositoryOutput) => void): Request; + /** + * Gets details about the specified Git repository. + */ + describeCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.DescribeCodeRepositoryOutput) => void): Request; + /** + * Returns information about a model compilation job. To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs. + */ + describeCompilationJob(params: SageMaker.Types.DescribeCompilationJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeCompilationJobResponse) => void): Request; + /** + * Returns information about a model compilation job. To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs. + */ + describeCompilationJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeCompilationJobResponse) => void): Request; + /** + * Returns the description of an endpoint. + */ + describeEndpoint(params: SageMaker.Types.DescribeEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request; + /** + * Returns the description of an endpoint. + */ + describeEndpoint(callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request; + /** + * Returns the description of an endpoint configuration created using the CreateEndpointConfig API. + */ + describeEndpointConfig(params: SageMaker.Types.DescribeEndpointConfigInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointConfigOutput) => void): Request; + /** + * Returns the description of an endpoint configuration created using the CreateEndpointConfig API. + */ + describeEndpointConfig(callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointConfigOutput) => void): Request; + /** + * Gets a description of a hyperparameter tuning job. + */ + describeHyperParameterTuningJob(params: SageMaker.Types.DescribeHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeHyperParameterTuningJobResponse) => void): Request; + /** + * Gets a description of a hyperparameter tuning job. + */ + describeHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeHyperParameterTuningJobResponse) => void): Request; + /** + * Gets information about a labeling job. + */ + describeLabelingJob(params: SageMaker.Types.DescribeLabelingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeLabelingJobResponse) => void): Request; + /** + * Gets information about a labeling job. + */ + describeLabelingJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeLabelingJobResponse) => void): Request; + /** + * Describes a model that you created using the CreateModel API. + */ + describeModel(params: SageMaker.Types.DescribeModelInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeModelOutput) => void): Request; + /** + * Describes a model that you created using the CreateModel API. + */ + describeModel(callback?: (err: AWSError, data: SageMaker.Types.DescribeModelOutput) => void): Request; + /** + * Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace. To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace. + */ + describeModelPackage(params: SageMaker.Types.DescribeModelPackageInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeModelPackageOutput) => void): Request; + /** + * Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace. To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace. + */ + describeModelPackage(callback?: (err: AWSError, data: SageMaker.Types.DescribeModelPackageOutput) => void): Request; + /** + * Returns information about a notebook instance. + */ + describeNotebookInstance(params: SageMaker.Types.DescribeNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Returns information about a notebook instance. + */ + describeNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Returns a description of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. + */ + describeNotebookInstanceLifecycleConfig(params: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput) => void): Request; + /** + * Returns a description of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. + */ + describeNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput) => void): Request; + /** + * Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace. + */ + describeSubscribedWorkteam(params: SageMaker.Types.DescribeSubscribedWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeSubscribedWorkteamResponse) => void): Request; + /** + * Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace. + */ + describeSubscribedWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DescribeSubscribedWorkteamResponse) => void): Request; + /** + * Returns information about a training job. + */ + describeTrainingJob(params: SageMaker.Types.DescribeTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request; + /** + * Returns information about a training job. + */ + describeTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request; + /** + * Returns information about a transform job. + */ + describeTransformJob(params: SageMaker.Types.DescribeTransformJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request; + /** + * Returns information about a transform job. + */ + describeTransformJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request; + /** + * Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN). + */ + describeWorkteam(params: SageMaker.Types.DescribeWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkteamResponse) => void): Request; + /** + * Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN). + */ + describeWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkteamResponse) => void): Request; + /** + * An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics. + */ + getSearchSuggestions(params: SageMaker.Types.GetSearchSuggestionsRequest, callback?: (err: AWSError, data: SageMaker.Types.GetSearchSuggestionsResponse) => void): Request; + /** + * An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics. + */ + getSearchSuggestions(callback?: (err: AWSError, data: SageMaker.Types.GetSearchSuggestionsResponse) => void): Request; + /** + * Lists the machine learning algorithms that have been created. + */ + listAlgorithms(params: SageMaker.Types.ListAlgorithmsInput, callback?: (err: AWSError, data: SageMaker.Types.ListAlgorithmsOutput) => void): Request; + /** + * Lists the machine learning algorithms that have been created. + */ + listAlgorithms(callback?: (err: AWSError, data: SageMaker.Types.ListAlgorithmsOutput) => void): Request; + /** + * Gets a list of the Git repositories in your account. + */ + listCodeRepositories(params: SageMaker.Types.ListCodeRepositoriesInput, callback?: (err: AWSError, data: SageMaker.Types.ListCodeRepositoriesOutput) => void): Request; + /** + * Gets a list of the Git repositories in your account. + */ + listCodeRepositories(callback?: (err: AWSError, data: SageMaker.Types.ListCodeRepositoriesOutput) => void): Request; + /** + * Lists model compilation jobs that satisfy various filters. To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob. + */ + listCompilationJobs(params: SageMaker.Types.ListCompilationJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListCompilationJobsResponse) => void): Request; + /** + * Lists model compilation jobs that satisfy various filters. To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob. + */ + listCompilationJobs(callback?: (err: AWSError, data: SageMaker.Types.ListCompilationJobsResponse) => void): Request; + /** + * Lists endpoint configurations. + */ + listEndpointConfigs(params: SageMaker.Types.ListEndpointConfigsInput, callback?: (err: AWSError, data: SageMaker.Types.ListEndpointConfigsOutput) => void): Request; + /** + * Lists endpoint configurations. + */ + listEndpointConfigs(callback?: (err: AWSError, data: SageMaker.Types.ListEndpointConfigsOutput) => void): Request; + /** + * Lists endpoints. + */ + listEndpoints(params: SageMaker.Types.ListEndpointsInput, callback?: (err: AWSError, data: SageMaker.Types.ListEndpointsOutput) => void): Request; + /** + * Lists endpoints. + */ + listEndpoints(callback?: (err: AWSError, data: SageMaker.Types.ListEndpointsOutput) => void): Request; + /** + * Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account. + */ + listHyperParameterTuningJobs(params: SageMaker.Types.ListHyperParameterTuningJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListHyperParameterTuningJobsResponse) => void): Request; + /** + * Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account. + */ + listHyperParameterTuningJobs(callback?: (err: AWSError, data: SageMaker.Types.ListHyperParameterTuningJobsResponse) => void): Request; + /** + * Gets a list of labeling jobs. + */ + listLabelingJobs(params: SageMaker.Types.ListLabelingJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsResponse) => void): Request; + /** + * Gets a list of labeling jobs. + */ + listLabelingJobs(callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsResponse) => void): Request; + /** + * Gets a list of labeling jobs assigned to a specified work team. + */ + listLabelingJobsForWorkteam(params: SageMaker.Types.ListLabelingJobsForWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsForWorkteamResponse) => void): Request; + /** + * Gets a list of labeling jobs assigned to a specified work team. + */ + listLabelingJobsForWorkteam(callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsForWorkteamResponse) => void): Request; + /** + * Lists the model packages that have been created. + */ + listModelPackages(params: SageMaker.Types.ListModelPackagesInput, callback?: (err: AWSError, data: SageMaker.Types.ListModelPackagesOutput) => void): Request; + /** + * Lists the model packages that have been created. + */ + listModelPackages(callback?: (err: AWSError, data: SageMaker.Types.ListModelPackagesOutput) => void): Request; + /** + * Lists models created with the CreateModel API. + */ + listModels(params: SageMaker.Types.ListModelsInput, callback?: (err: AWSError, data: SageMaker.Types.ListModelsOutput) => void): Request; + /** + * Lists models created with the CreateModel API. + */ + listModels(callback?: (err: AWSError, data: SageMaker.Types.ListModelsOutput) => void): Request; + /** + * Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API. + */ + listNotebookInstanceLifecycleConfigs(params: SageMaker.Types.ListNotebookInstanceLifecycleConfigsInput, callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput) => void): Request; + /** + * Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API. + */ + listNotebookInstanceLifecycleConfigs(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput) => void): Request; + /** + * Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region. + */ + listNotebookInstances(params: SageMaker.Types.ListNotebookInstancesInput, callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request; + /** + * Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region. + */ + listNotebookInstances(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request; + /** + * Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter. + */ + listSubscribedWorkteams(params: SageMaker.Types.ListSubscribedWorkteamsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListSubscribedWorkteamsResponse) => void): Request; + /** + * Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter. + */ + listSubscribedWorkteams(callback?: (err: AWSError, data: SageMaker.Types.ListSubscribedWorkteamsResponse) => void): Request; + /** + * Returns the tags for the specified Amazon SageMaker resource. + */ + listTags(params: SageMaker.Types.ListTagsInput, callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request; + /** + * Returns the tags for the specified Amazon SageMaker resource. + */ + listTags(callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request; + /** + * Lists training jobs. + */ + listTrainingJobs(params: SageMaker.Types.ListTrainingJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsResponse) => void): Request; + /** + * Lists training jobs. + */ + listTrainingJobs(callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsResponse) => void): Request; + /** + * Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched. + */ + listTrainingJobsForHyperParameterTuningJob(params: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse) => void): Request; + /** + * Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched. + */ + listTrainingJobsForHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse) => void): Request; + /** + * Lists transform jobs. + */ + listTransformJobs(params: SageMaker.Types.ListTransformJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTransformJobsResponse) => void): Request; + /** + * Lists transform jobs. + */ + listTransformJobs(callback?: (err: AWSError, data: SageMaker.Types.ListTransformJobsResponse) => void): Request; + /** + * Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter. + */ + listWorkteams(params: SageMaker.Types.ListWorkteamsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListWorkteamsResponse) => void): Request; + /** + * Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter. + */ + listWorkteams(callback?: (err: AWSError, data: SageMaker.Types.ListWorkteamsResponse) => void): Request; + /** + * Renders the UI template so that you can preview the worker's experience. + */ + renderUiTemplate(params: SageMaker.Types.RenderUiTemplateRequest, callback?: (err: AWSError, data: SageMaker.Types.RenderUiTemplateResponse) => void): Request; + /** + * Renders the UI template so that you can preview the worker's experience. + */ + renderUiTemplate(callback?: (err: AWSError, data: SageMaker.Types.RenderUiTemplateResponse) => void): Request; + /** + * Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order. You can query against the following value types: numerical, text, Booleans, and timestamps. + */ + search(params: SageMaker.Types.SearchRequest, callback?: (err: AWSError, data: SageMaker.Types.SearchResponse) => void): Request; + /** + * Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order. You can query against the following value types: numerical, text, Booleans, and timestamps. + */ + search(callback?: (err: AWSError, data: SageMaker.Types.SearchResponse) => void): Request; + /** + * Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook. + */ + startNotebookInstance(params: SageMaker.Types.StartNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook. + */ + startNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a model compilation job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal. When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped. + */ + stopCompilationJob(params: SageMaker.Types.StopCompilationJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a model compilation job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal. When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped. + */ + stopCompilationJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched. All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job. + */ + stopHyperParameterTuningJob(params: SageMaker.Types.StopHyperParameterTuningJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched. All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job. + */ + stopHyperParameterTuningJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket. + */ + stopLabelingJob(params: SageMaker.Types.StopLabelingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket. + */ + stopLabelingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work. + */ + stopNotebookInstance(params: SageMaker.Types.StopNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work. + */ + stopNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped. + */ + stopTrainingJob(params: SageMaker.Types.StopTrainingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped. + */ + stopTrainingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a transform job. When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3. + */ + stopTransformJob(params: SageMaker.Types.StopTransformJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Stops a transform job. When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3. + */ + stopTransformJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the specified Git repository with the specified values. + */ + updateCodeRepository(params: SageMaker.Types.UpdateCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateCodeRepositoryOutput) => void): Request; + /** + * Updates the specified Git repository with the specified values. + */ + updateCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.UpdateCodeRepositoryOutput) => void): Request; + /** + * Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. You cannot update an endpoint with the current EndpointConfig. To update an endpoint, you must create a new EndpointConfig. + */ + updateEndpoint(params: SageMaker.Types.UpdateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request; + /** + * Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. You cannot update an endpoint with the current EndpointConfig. To update an endpoint, you must create a new EndpointConfig. + */ + updateEndpoint(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request; + /** + * Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. + */ + updateEndpointWeightsAndCapacities(params: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request; + /** + * Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. + */ + updateEndpointWeightsAndCapacities(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request; + /** + * Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements. You can also update the VPC security groups. + */ + updateNotebookInstance(params: SageMaker.Types.UpdateNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceOutput) => void): Request; + /** + * Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements. You can also update the VPC security groups. + */ + updateNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceOutput) => void): Request; + /** + * Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API. + */ + updateNotebookInstanceLifecycleConfig(params: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput) => void): Request; + /** + * Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API. + */ + updateNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput) => void): Request; + /** + * Updates an existing work team with new member definitions or description. + */ + updateWorkteam(params: SageMaker.Types.UpdateWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkteamResponse) => void): Request; + /** + * Updates an existing work team with new member definitions or description. + */ + updateWorkteam(callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkteamResponse) => void): Request; + /** + * Waits for the notebookInstanceInService state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "notebookInstanceInService", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Waits for the notebookInstanceInService state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "notebookInstanceInService", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Waits for the notebookInstanceStopped state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "notebookInstanceStopped", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Waits for the notebookInstanceStopped state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "notebookInstanceStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Waits for the notebookInstanceDeleted state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "notebookInstanceDeleted", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Waits for the notebookInstanceDeleted state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "notebookInstanceDeleted", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request; + /** + * Waits for the trainingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTrainingJoboperation every 120 seconds (at most 180 times). + */ + waitFor(state: "trainingJobCompletedOrStopped", params: SageMaker.Types.DescribeTrainingJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request; + /** + * Waits for the trainingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTrainingJoboperation every 120 seconds (at most 180 times). + */ + waitFor(state: "trainingJobCompletedOrStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request; + /** + * Waits for the endpointInService state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 120 times). + */ + waitFor(state: "endpointInService", params: SageMaker.Types.DescribeEndpointInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request; + /** + * Waits for the endpointInService state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 120 times). + */ + waitFor(state: "endpointInService", callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request; + /** + * Waits for the endpointDeleted state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "endpointDeleted", params: SageMaker.Types.DescribeEndpointInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request; + /** + * Waits for the endpointDeleted state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 60 times). + */ + waitFor(state: "endpointDeleted", callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request; + /** + * Waits for the transformJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTransformJoboperation every 60 seconds (at most 60 times). + */ + waitFor(state: "transformJobCompletedOrStopped", params: SageMaker.Types.DescribeTransformJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request; + /** + * Waits for the transformJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTransformJoboperation every 60 seconds (at most 60 times). + */ + waitFor(state: "transformJobCompletedOrStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request; +} +declare namespace SageMaker { + export type Accept = string; + export type AccountId = string; + export interface AddTagsInput { + /** + * The Amazon Resource Name (ARN) of the resource that you want to tag. + */ + ResourceArn: ResourceArn; + /** + * An array of Tag objects. Each tag is a key-value pair. Only the key parameter is required. If you don't specify a value, Amazon SageMaker sets the value to an empty string. + */ + Tags: TagList; + } + export interface AddTagsOutput { + /** + * A list of tags associated with the Amazon SageMaker resource. + */ + Tags?: TagList; + } + export type AdditionalCodeRepositoryNamesOrUrls = CodeRepositoryNameOrUrl[]; + export type AlgorithmArn = string; + export type AlgorithmImage = string; + export type AlgorithmSortBy = "Name"|"CreationTime"|string; + export interface AlgorithmSpecification { + /** + * The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker. + */ + TrainingImage?: AlgorithmImage; + /** + * The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage. + */ + AlgorithmName?: ArnOrName; + /** + * The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container. In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any. For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training. + */ + TrainingInputMode: TrainingInputMode; + /** + * A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch. + */ + MetricDefinitions?: MetricDefinitionList; + } + export type AlgorithmStatus = "Pending"|"InProgress"|"Completed"|"Failed"|"Deleting"|string; + export interface AlgorithmStatusDetails { + /** + * The status of algorithm validation. + */ + ValidationStatuses?: AlgorithmStatusItemList; + /** + * The status of the scan of the algorithm's Docker image container. + */ + ImageScanStatuses?: AlgorithmStatusItemList; + } + export interface AlgorithmStatusItem { + /** + * The name of the algorithm for which the overall status is being reported. + */ + Name: EntityName; + /** + * The current status. + */ + Status: DetailedAlgorithmStatus; + /** + * if the overall status is Failed, the reason for the failure. + */ + FailureReason?: String; + } + export type AlgorithmStatusItemList = AlgorithmStatusItem[]; + export interface AlgorithmSummary { + /** + * The name of the algorithm that is described by the summary. + */ + AlgorithmName: EntityName; + /** + * The Amazon Resource Name (ARN) of the algorithm. + */ + AlgorithmArn: AlgorithmArn; + /** + * A brief description of the algorithm. + */ + AlgorithmDescription?: EntityDescription; + /** + * A timestamp that shows when the algorithm was created. + */ + CreationTime: CreationTime; + /** + * The overall status of the algorithm. + */ + AlgorithmStatus: AlgorithmStatus; + } + export type AlgorithmSummaryList = AlgorithmSummary[]; + export interface AlgorithmValidationProfile { + /** + * The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). + */ + ProfileName: EntityName; + /** + * The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm. + */ + TrainingJobDefinition: TrainingJobDefinition; + /** + * The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm. + */ + TransformJobDefinition?: TransformJobDefinition; + } + export type AlgorithmValidationProfiles = AlgorithmValidationProfile[]; + export interface AlgorithmValidationSpecification { + /** + * The IAM roles that Amazon SageMaker uses to run the training jobs. + */ + ValidationRole: RoleArn; + /** + * An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm. + */ + ValidationProfiles: AlgorithmValidationProfiles; + } + export interface AnnotationConsolidationConfig { + /** + * The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation. For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions: Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes. arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label. arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass For more information, see Annotation Consolidation. + */ + AnnotationConsolidationLambdaArn: LambdaFunctionArn; + } + export type ArnOrName = string; + export type AssemblyType = "None"|"Line"|string; + export type AttributeName = string; + export type AttributeNames = AttributeName[]; + export type BatchStrategy = "MultiRecord"|"SingleRecord"|string; + export type Boolean = boolean; + export type BooleanOperator = "And"|"Or"|string; + export type Branch = string; + export interface CategoricalParameterRange { + /** + * The name of the categorical hyperparameter to tune. + */ + Name: ParameterKey; + /** + * A list of the categories for the hyperparameter. + */ + Values: ParameterValues; + } + export interface CategoricalParameterRangeSpecification { + /** + * The allowed categories for the hyperparameter. + */ + Values: ParameterValues; + } + export type CategoricalParameterRanges = CategoricalParameterRange[]; + export type Cents = number; + export type CertifyForMarketplace = boolean; + export interface Channel { + /** + * The name of the channel. + */ + ChannelName: ChannelName; + /** + * The location of the channel data. + */ + DataSource: DataSource; + /** + * The MIME type of the data. + */ + ContentType?: ContentType; + /** + * If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None. + */ + CompressionType?: CompressionType; + /** + * Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO. In File mode, leave this field unset or set it to None. + */ + RecordWrapperType?: RecordWrapper; + /** + * (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode. To use a model for incremental training, choose File input model. + */ + InputMode?: TrainingInputMode; + /** + * A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value. For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch. + */ + ShuffleConfig?: ShuffleConfig; + } + export type ChannelName = string; + export interface ChannelSpecification { + /** + * The name of the channel. + */ + Name: ChannelName; + /** + * A brief description of the channel. + */ + Description?: EntityDescription; + /** + * Indicates whether the channel is required by the algorithm. + */ + IsRequired?: Boolean; + /** + * The supported MIME types for the data. + */ + SupportedContentTypes: ContentTypes; + /** + * The allowed compression types, if data compression is used. + */ + SupportedCompressionTypes?: CompressionTypes; + /** + * The allowed input mode, either FILE or PIPE. In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume. + */ + SupportedInputModes: InputModes; + } + export type ChannelSpecifications = ChannelSpecification[]; + export type CodeRepositoryArn = string; + export type CodeRepositoryContains = string; + export type CodeRepositoryNameContains = string; + export type CodeRepositoryNameOrUrl = string; + export type CodeRepositorySortBy = "Name"|"CreationTime"|"LastModifiedTime"|string; + export type CodeRepositorySortOrder = "Ascending"|"Descending"|string; + export interface CodeRepositorySummary { + /** + * The name of the Git repository. + */ + CodeRepositoryName: EntityName; + /** + * The Amazon Resource Name (ARN) of the Git repository. + */ + CodeRepositoryArn: CodeRepositoryArn; + /** + * The date and time that the Git repository was created. + */ + CreationTime: CreationTime; + /** + * The date and time that the Git repository was last modified. + */ + LastModifiedTime: LastModifiedTime; + /** + * Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository. + */ + GitConfig?: GitConfig; + } + export type CodeRepositorySummaryList = CodeRepositorySummary[]; + export type CognitoClientId = string; + export interface CognitoMemberDefinition { + /** + * An identifier for a user pool. The user pool must be in the same region as the service that you are calling. + */ + UserPool: CognitoUserPool; + /** + * An identifier for a user group. + */ + UserGroup: CognitoUserGroup; + /** + * An identifier for an application client. You must create the app client ID using Amazon Cognito. + */ + ClientId: CognitoClientId; + } + export type CognitoUserGroup = string; + export type CognitoUserPool = string; + export type CompilationJobArn = string; + export type CompilationJobStatus = "INPROGRESS"|"COMPLETED"|"FAILED"|"STARTING"|"STOPPING"|"STOPPED"|string; + export type CompilationJobSummaries = CompilationJobSummary[]; + export interface CompilationJobSummary { + /** + * The name of the model compilation job that you want a summary for. + */ + CompilationJobName: EntityName; + /** + * The Amazon Resource Name (ARN) of the model compilation job. + */ + CompilationJobArn: CompilationJobArn; + /** + * The time when the model compilation job was created. + */ + CreationTime: CreationTime; + /** + * The time when the model compilation job started. + */ + CompilationStartTime?: Timestamp; + /** + * The time when the model compilation job completed. + */ + CompilationEndTime?: Timestamp; + /** + * The type of device that the model will run on after compilation has completed. + */ + CompilationTargetDevice: TargetDevice; + /** + * The time when the model compilation job was last modified. + */ + LastModifiedTime?: LastModifiedTime; + /** + * The status of the model compilation job. + */ + CompilationJobStatus: CompilationJobStatus; + } + export type CompressionType = "None"|"Gzip"|string; + export type CompressionTypes = CompressionType[]; + export interface ContainerDefinition { + /** + * This parameter is ignored. + */ + ContainerHostname?: ContainerHostname; + /** + * The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker + */ + Image?: Image; + /** + * The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. + */ + ModelDataUrl?: Url; + /** + * The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map. + */ + Environment?: EnvironmentMap; + /** + * The name of the model package to use to create the model. + */ + ModelPackageName?: ArnOrName; + } + export type ContainerDefinitionList = ContainerDefinition[]; + export type ContainerHostname = string; + export type ContentClassifier = "FreeOfPersonallyIdentifiableInformation"|"FreeOfAdultContent"|string; + export type ContentClassifiers = ContentClassifier[]; + export type ContentType = string; + export type ContentTypes = ContentType[]; + export interface ContinuousParameterRange { + /** + * The name of the continuous hyperparameter to tune. + */ + Name: ParameterKey; + /** + * The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning. + */ + MinValue: ParameterValue; + /** + * The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning. + */ + MaxValue: ParameterValue; + /** + * The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Range Scaling. One of the following values: Auto Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. Linear Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. Logarithmic Hyperparemeter tuning searches the values in the hyperparameter range by using a logarithmic scale. Logarithmic scaling works only for ranges that have only values greater than 0. ReverseLogarithmic Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0. + */ + ScalingType?: HyperParameterScalingType; + } + export interface ContinuousParameterRangeSpecification { + /** + * The minimum floating-point value allowed. + */ + MinValue: ParameterValue; + /** + * The maximum floating-point value allowed. + */ + MaxValue: ParameterValue; + } + export type ContinuousParameterRanges = ContinuousParameterRange[]; + export interface CreateAlgorithmInput { + /** + * The name of the algorithm. + */ + AlgorithmName: EntityName; + /** + * A description of the algorithm. + */ + AlgorithmDescription?: EntityDescription; + /** + * Specifies details about training jobs run by this algorithm, including the following: The Amazon ECR path of the container and the version digest of the algorithm. The hyperparameters that the algorithm supports. The instance types that the algorithm supports for training. Whether the algorithm supports distributed training. The metrics that the algorithm emits to Amazon CloudWatch. Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs. The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels. + */ + TrainingSpecification: TrainingSpecification; + /** + * Specifies details about inference jobs that the algorithm runs, including the following: The Amazon ECR paths of containers that contain the inference code and model artifacts. The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference. The input and output content formats that the algorithm supports for inference. + */ + InferenceSpecification?: InferenceSpecification; + /** + * Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code. + */ + ValidationSpecification?: AlgorithmValidationSpecification; + /** + * Whether to certify the algorithm so that it can be listed in AWS Marketplace. + */ + CertifyForMarketplace?: CertifyForMarketplace; + } + export interface CreateAlgorithmOutput { + /** + * The Amazon Resource Name (ARN) of the new algorithm. + */ + AlgorithmArn: AlgorithmArn; + } + export interface CreateCodeRepositoryInput { + /** + * The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). + */ + CodeRepositoryName: EntityName; + /** + * Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository. + */ + GitConfig: GitConfig; + } + export interface CreateCodeRepositoryOutput { + /** + * The Amazon Resource Name (ARN) of the new repository. + */ + CodeRepositoryArn: CodeRepositoryArn; + } + export interface CreateCompilationJobRequest { + /** + * A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account. + */ + CompilationJobName: EntityName; + /** + * The Amazon Resource Name (ARN) of an IIAMAM role that enables Amazon SageMaker to perform tasks on your behalf. During model compilation, Amazon SageMaker needs your permission to: Read input data from an S3 bucket Write model artifacts to an S3 bucket Write logs to Amazon CloudWatch Logs Publish metrics to Amazon CloudWatch You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles. + */ + RoleArn: RoleArn; + /** + * Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained. + */ + InputConfig: InputConfig; + /** + * Provides information about the output location for the compiled model and the target device the model runs on. + */ + OutputConfig: OutputConfig; + /** + * The duration allowed for model compilation. + */ + StoppingCondition: StoppingCondition; + } + export interface CreateCompilationJobResponse { + /** + * If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format: CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job. + */ + CompilationJobArn: CompilationJobArn; + } + export interface CreateEndpointConfigInput { + /** + * The name of the endpoint configuration. You specify this name in a CreateEndpoint request. + */ + EndpointConfigName: EndpointConfigName; + /** + * An array of ProductionVariant objects, one for each model that you want to host at this endpoint. + */ + ProductionVariants: ProductionVariantList; + /** + * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + /** + * The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. + */ + KmsKeyId?: KmsKeyId; + } + export interface CreateEndpointConfigOutput { + /** + * The Amazon Resource Name (ARN) of the endpoint configuration. + */ + EndpointConfigArn: EndpointConfigArn; + } + export interface CreateEndpointInput { + /** + * The name of the endpoint. The name must be unique within an AWS Region in your AWS account. + */ + EndpointName: EndpointName; + /** + * The name of an endpoint configuration. For more information, see CreateEndpointConfig. + */ + EndpointConfigName: EndpointConfigName; + /** + * An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + } + export interface CreateEndpointOutput { + /** + * The Amazon Resource Name (ARN) of the endpoint. + */ + EndpointArn: EndpointArn; + } + export interface CreateHyperParameterTuningJobRequest { + /** + * The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive. + */ + HyperParameterTuningJobName: HyperParameterTuningJobName; + /** + * The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see automatic-model-tuning + */ + HyperParameterTuningJobConfig: HyperParameterTuningJobConfig; + /** + * The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition. + */ + TrainingJobDefinition: HyperParameterTrainingJobDefinition; + /** + * Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job. All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job. All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job. + */ + WarmStartConfig?: HyperParameterTuningJobWarmStartConfig; + /** + * An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see AWS Tagging Strategies. Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches. + */ + Tags?: TagList; + } + export interface CreateHyperParameterTuningJobResponse { + /** + * The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it. + */ + HyperParameterTuningJobArn: HyperParameterTuningJobArn; + } + export interface CreateLabelingJobRequest { + /** + * The name of the labeling job. This name is used to identify the job in a list of labeling jobs. + */ + LabelingJobName: LabelingJobName; + /** + * The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref". + */ + LabelAttributeName: LabelAttributeName; + /** + * Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects. + */ + InputConfig: LabelingJobInputConfig; + /** + * The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any. + */ + OutputConfig: LabelingJobOutputConfig; + /** + * The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling. + */ + RoleArn: RoleArn; + /** + * The S3 URL of the file that defines the categories used to label the data objects. The file is a JSON structure in the following format: { "document-version": "2018-11-28" "labels": [ { "label": "label 1" }, { "label": "label 2" }, ... { "label": "label n" } ] } + */ + LabelCategoryConfigS3Uri?: S3Uri; + /** + * A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling. + */ + StoppingConditions?: LabelingJobStoppingConditions; + /** + * Configures the information required to perform automated data labeling. + */ + LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig; + /** + * Configures the information required for human workers to complete a labeling task. + */ + HumanTaskConfig: HumanTaskConfig; + /** + * An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + } + export interface CreateLabelingJobResponse { + /** + * The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job. + */ + LabelingJobArn: LabelingJobArn; + } + export interface CreateModelInput { + /** + * The name of the new model. + */ + ModelName: ModelName; + /** + * The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions. + */ + PrimaryContainer?: ContainerDefinition; + /** + * Specifies the containers in the inference pipeline. + */ + Containers?: ContainerDefinitionList; + /** + * The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. + */ + ExecutionRoleArn: RoleArn; + /** + * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + /** + * A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud. + */ + VpcConfig?: VpcConfig; + /** + * Isolates the model container. No inbound or outbound network calls can be made to or from the model container. The Semantic Segmentation built-in algorithm does not support network isolation. + */ + EnableNetworkIsolation?: Boolean; + } + export interface CreateModelOutput { + /** + * The ARN of the model created in Amazon SageMaker. + */ + ModelArn: ModelArn; + } + export interface CreateModelPackageInput { + /** + * The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). + */ + ModelPackageName: EntityName; + /** + * A description of the model package. + */ + ModelPackageDescription?: EntityDescription; + /** + * Specifies details about inference jobs that can be run with models based on this model package, including the following: The Amazon ECR paths of containers that contain the inference code and model artifacts. The instance types that the model package supports for transform jobs and real-time endpoints used for inference. The input and output content formats that the model package supports for inference. + */ + InferenceSpecification?: InferenceSpecification; + /** + * Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package. + */ + ValidationSpecification?: ModelPackageValidationSpecification; + /** + * Details about the algorithm that was used to create the model package. + */ + SourceAlgorithmSpecification?: SourceAlgorithmSpecification; + /** + * Whether to certify the model package for listing on AWS Marketplace. + */ + CertifyForMarketplace?: CertifyForMarketplace; + } + export interface CreateModelPackageOutput { + /** + * The Amazon Resource Name (ARN) of the new model package. + */ + ModelPackageArn: ModelPackageArn; + } + export interface CreateNotebookInstanceInput { + /** + * The name of the new notebook instance. + */ + NotebookInstanceName: NotebookInstanceName; + /** + * The type of ML compute instance to launch for the notebook instance. + */ + InstanceType: InstanceType; + /** + * The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. + */ + SubnetId?: SubnetId; + /** + * The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet. + */ + SecurityGroupIds?: SecurityGroupIds; + /** + * When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. + */ + RoleArn: RoleArn; + /** + * If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide. + */ + KmsKeyId?: KmsKeyId; + /** + * A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API. + */ + Tags?: TagList; + /** + * The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. + */ + LifecycleConfigName?: NotebookInstanceLifecycleConfigName; + /** + * Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC. For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter. + */ + DirectInternetAccess?: DirectInternetAccess; + /** + * The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. + */ + VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB; + /** + * A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker. + */ + AcceleratorTypes?: NotebookInstanceAcceleratorTypes; + /** + * A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + DefaultCodeRepository?: CodeRepositoryNameOrUrl; + /** + * An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls; + /** + * Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users. + */ + RootAccess?: RootAccess; + } + export interface CreateNotebookInstanceLifecycleConfigInput { + /** + * The name of the lifecycle configuration. + */ + NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName; + /** + * A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string. + */ + OnCreate?: NotebookInstanceLifecycleConfigList; + /** + * A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string. + */ + OnStart?: NotebookInstanceLifecycleConfigList; + } + export interface CreateNotebookInstanceLifecycleConfigOutput { + /** + * The Amazon Resource Name (ARN) of the lifecycle configuration. + */ + NotebookInstanceLifecycleConfigArn?: NotebookInstanceLifecycleConfigArn; + } + export interface CreateNotebookInstanceOutput { + /** + * The Amazon Resource Name (ARN) of the notebook instance. + */ + NotebookInstanceArn?: NotebookInstanceArn; + } + export interface CreatePresignedNotebookInstanceUrlInput { + /** + * The name of the notebook instance. + */ + NotebookInstanceName: NotebookInstanceName; + /** + * The duration of the session, in seconds. The default is 12 hours. + */ + SessionExpirationDurationInSeconds?: SessionExpirationDurationInSeconds; + } + export interface CreatePresignedNotebookInstanceUrlOutput { + /** + * A JSON object that contains the URL string. + */ + AuthorizedUrl?: NotebookInstanceUrl; + } + export interface CreateTrainingJobRequest { + /** + * The name of the training job. The name must be unique within an AWS Region in an AWS account. + */ + TrainingJobName: TrainingJobName; + /** + * Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint. + */ + HyperParameters?: HyperParameters; + /** + * The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker. + */ + AlgorithmSpecification: AlgorithmSpecification; + /** + * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. + */ + RoleArn: RoleArn; + /** + * An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location. Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3 location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. + */ + InputDataConfig?: InputDataConfig; + /** + * Specifies the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts. + */ + OutputDataConfig: OutputDataConfig; + /** + * The resources, including the ML compute instances and ML storage volumes, to use for model training. ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1. + */ + ResourceConfig: ResourceConfig; + /** + * A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud. + */ + VpcConfig?: VpcConfig; + /** + * Sets a duration for training. Use this parameter to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts. When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job. This intermediate data is a valid model artifact. You can use it to create a model using the CreateModel API. + */ + StoppingCondition: StoppingCondition; + /** + * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + /** + * Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. The Semantic Segmentation built-in algorithm does not support network isolation. + */ + EnableNetworkIsolation?: Boolean; + /** + * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job. + */ + EnableInterContainerTrafficEncryption?: Boolean; + } + export interface CreateTrainingJobResponse { + /** + * The Amazon Resource Name (ARN) of the training job. + */ + TrainingJobArn: TrainingJobArn; + } + export interface CreateTransformJobRequest { + /** + * The name of the transform job. The name must be unique within an AWS Region in an AWS account. + */ + TransformJobName: TransformJobName; + /** + * The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account. + */ + ModelName: ModelName; + /** + * The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1. To allow Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, set the value to 0. + */ + MaxConcurrentTransforms?: MaxConcurrentTransforms; + /** + * The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding. + */ + MaxPayloadInMB?: MaxPayloadInMB; + /** + * Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record. To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord. To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line. To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line. + */ + BatchStrategy?: BatchStrategy; + /** + * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. + */ + Environment?: TransformEnvironmentMap; + /** + * Describes the input source and the way the transform job consumes it. + */ + TransformInput: TransformInput; + /** + * Describes the results of the transform job. + */ + TransformOutput: TransformOutput; + /** + * Describes the resources, including ML instance types and ML instance count, to use for the transform job. + */ + TransformResources: TransformResources; + /** + * (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + } + export interface CreateTransformJobResponse { + /** + * The Amazon Resource Name (ARN) of the transform job. + */ + TransformJobArn: TransformJobArn; + } + export interface CreateWorkteamRequest { + /** + * The name of the work team. Use this name to identify the work team. + */ + WorkteamName: WorkteamName; + /** + * A list of MemberDefinition objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User Pools. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. + */ + MemberDefinitions: MemberDefinitions; + /** + * A description of the work team. + */ + Description: String200; + /** + * + */ + Tags?: TagList; + } + export interface CreateWorkteamResponse { + /** + * The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team. + */ + WorkteamArn?: WorkteamArn; + } + export type CreationTime = Date; + export type DataInputConfig = string; + export interface DataSource { + /** + * The S3 location of the data source that is associated with a channel. + */ + S3DataSource: S3DataSource; + } + export interface DeleteAlgorithmInput { + /** + * The name of the algorithm to delete. + */ + AlgorithmName: EntityName; + } + export interface DeleteCodeRepositoryInput { + /** + * The name of the Git repository to delete. + */ + CodeRepositoryName: EntityName; + } + export interface DeleteEndpointConfigInput { + /** + * The name of the endpoint configuration that you want to delete. + */ + EndpointConfigName: EndpointConfigName; + } + export interface DeleteEndpointInput { + /** + * The name of the endpoint that you want to delete. + */ + EndpointName: EndpointName; + } + export interface DeleteModelInput { + /** + * The name of the model to delete. + */ + ModelName: ModelName; + } + export interface DeleteModelPackageInput { + /** + * The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). + */ + ModelPackageName: EntityName; + } + export interface DeleteNotebookInstanceInput { + /** + * The name of the Amazon SageMaker notebook instance to delete. + */ + NotebookInstanceName: NotebookInstanceName; + } + export interface DeleteNotebookInstanceLifecycleConfigInput { + /** + * The name of the lifecycle configuration to delete. + */ + NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName; + } + export interface DeleteTagsInput { + /** + * The Amazon Resource Name (ARN) of the resource whose tags you want to delete. + */ + ResourceArn: ResourceArn; + /** + * An array or one or more tag keys to delete. + */ + TagKeys: TagKeyList; + } + export interface DeleteTagsOutput { + } + export interface DeleteWorkteamRequest { + /** + * The name of the work team to delete. + */ + WorkteamName: WorkteamName; + } + export interface DeleteWorkteamResponse { + /** + * Returns true if the work team was successfully deleted; otherwise, returns false. + */ + Success: Success; + } + export interface DeployedImage { + /** + * The image path you specified when you created the model. + */ + SpecifiedImage?: Image; + /** + * The specific digest path of the image hosted in this ProductionVariant. + */ + ResolvedImage?: Image; + /** + * The date and time when the image path for the model resolved to the ResolvedImage + */ + ResolutionTime?: Timestamp; + } + export type DeployedImages = DeployedImage[]; + export interface DescribeAlgorithmInput { + /** + * The name of the algorithm to describe. + */ + AlgorithmName: ArnOrName; + } + export interface DescribeAlgorithmOutput { + /** + * The name of the algorithm being described. + */ + AlgorithmName: EntityName; + /** + * The Amazon Resource Name (ARN) of the algorithm. + */ + AlgorithmArn: AlgorithmArn; + /** + * A brief summary about the algorithm. + */ + AlgorithmDescription?: EntityDescription; + /** + * A timestamp specifying when the algorithm was created. + */ + CreationTime: CreationTime; + /** + * Details about training jobs run by this algorithm. + */ + TrainingSpecification: TrainingSpecification; + /** + * Details about inference jobs that the algorithm runs. + */ + InferenceSpecification?: InferenceSpecification; + /** + * Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm. + */ + ValidationSpecification?: AlgorithmValidationSpecification; + /** + * The current status of the algorithm. + */ + AlgorithmStatus: AlgorithmStatus; + /** + * Details about the current status of the algorithm. + */ + AlgorithmStatusDetails: AlgorithmStatusDetails; + /** + * The product identifier of the algorithm. + */ + ProductId?: ProductId; + /** + * Whether the algorithm is certified to be listed in AWS Marketplace. + */ + CertifyForMarketplace?: CertifyForMarketplace; + } + export interface DescribeCodeRepositoryInput { + /** + * The name of the Git repository to describe. + */ + CodeRepositoryName: EntityName; + } + export interface DescribeCodeRepositoryOutput { + /** + * The name of the Git repository. + */ + CodeRepositoryName: EntityName; + /** + * The Amazon Resource Name (ARN) of the Git repository. + */ + CodeRepositoryArn: CodeRepositoryArn; + /** + * The date and time that the repository was created. + */ + CreationTime: CreationTime; + /** + * The date and time that the repository was last changed. + */ + LastModifiedTime: LastModifiedTime; + /** + * Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository. + */ + GitConfig?: GitConfig; + } + export interface DescribeCompilationJobRequest { + /** + * The name of the model compilation job that you want information about. + */ + CompilationJobName: EntityName; + } + export interface DescribeCompilationJobResponse { + /** + * The name of the model compilation job. + */ + CompilationJobName: EntityName; + /** + * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job. + */ + CompilationJobArn: CompilationJobArn; + /** + * The status of the model compilation job. + */ + CompilationJobStatus: CompilationJobStatus; + /** + * The time when the model compilation job started the CompilationJob instances. You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container. + */ + CompilationStartTime?: Timestamp; + /** + * The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed. + */ + CompilationEndTime?: Timestamp; + /** + * The duration allowed for model compilation. + */ + StoppingCondition: StoppingCondition; + /** + * The time that the model compilation job was created. + */ + CreationTime: CreationTime; + /** + * The time that the status of the model compilation job was last modified. + */ + LastModifiedTime: LastModifiedTime; + /** + * If a model compilation job failed, the reason it failed. + */ + FailureReason: FailureReason; + /** + * Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job. + */ + ModelArtifacts: ModelArtifacts; + /** + * The Amazon Resource Name (ARN) of the model compilation job. + */ + RoleArn: RoleArn; + /** + * Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained. + */ + InputConfig: InputConfig; + /** + * Information about the output location for the compiled model and the target device that the model runs on. + */ + OutputConfig: OutputConfig; + } + export interface DescribeEndpointConfigInput { + /** + * The name of the endpoint configuration. + */ + EndpointConfigName: EndpointConfigName; + } + export interface DescribeEndpointConfigOutput { + /** + * Name of the Amazon SageMaker endpoint configuration. + */ + EndpointConfigName: EndpointConfigName; + /** + * The Amazon Resource Name (ARN) of the endpoint configuration. + */ + EndpointConfigArn: EndpointConfigArn; + /** + * An array of ProductionVariant objects, one for each model that you want to host at this endpoint. + */ + ProductionVariants: ProductionVariantList; + /** + * AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance. + */ + KmsKeyId?: KmsKeyId; + /** + * A timestamp that shows when the endpoint configuration was created. + */ + CreationTime: Timestamp; + } + export interface DescribeEndpointInput { + /** + * The name of the endpoint. + */ + EndpointName: EndpointName; + } + export interface DescribeEndpointOutput { + /** + * Name of the endpoint. + */ + EndpointName: EndpointName; + /** + * The Amazon Resource Name (ARN) of the endpoint. + */ + EndpointArn: EndpointArn; + /** + * The name of the endpoint configuration associated with this endpoint. + */ + EndpointConfigName: EndpointConfigName; + /** + * An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint. + */ + ProductionVariants?: ProductionVariantSummaryList; + /** + * The status of the endpoint. OutOfService: Endpoint is not available to take incoming requests. Creating: CreateEndpoint is executing. Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. InService: Endpoint is available to process incoming requests. Deleting: DeleteEndpoint is executing. Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. + */ + EndpointStatus: EndpointStatus; + /** + * If the status of the endpoint is Failed, the reason why it failed. + */ + FailureReason?: FailureReason; + /** + * A timestamp that shows when the endpoint was created. + */ + CreationTime: Timestamp; + /** + * A timestamp that shows when the endpoint was last modified. + */ + LastModifiedTime: Timestamp; + } + export interface DescribeHyperParameterTuningJobRequest { + /** + * The name of the tuning job to describe. + */ + HyperParameterTuningJobName: HyperParameterTuningJobName; + } + export interface DescribeHyperParameterTuningJobResponse { + /** + * The name of the tuning job. + */ + HyperParameterTuningJobName: HyperParameterTuningJobName; + /** + * The Amazon Resource Name (ARN) of the tuning job. + */ + HyperParameterTuningJobArn: HyperParameterTuningJobArn; + /** + * The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job. + */ + HyperParameterTuningJobConfig: HyperParameterTuningJobConfig; + /** + * The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches. + */ + TrainingJobDefinition: HyperParameterTrainingJobDefinition; + /** + * The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped. + */ + HyperParameterTuningJobStatus: HyperParameterTuningJobStatus; + /** + * The date and time that the tuning job started. + */ + CreationTime: Timestamp; + /** + * The date and time that the tuning job ended. + */ + HyperParameterTuningEndTime?: Timestamp; + /** + * The date and time that the status of the tuning job was modified. + */ + LastModifiedTime?: Timestamp; + /** + * The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched. + */ + TrainingJobStatusCounters: TrainingJobStatusCounters; + /** + * The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched. + */ + ObjectiveStatusCounters: ObjectiveStatusCounters; + /** + * A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective. + */ + BestTrainingJob?: HyperParameterTrainingJobSummary; + /** + * If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job. + */ + OverallBestTrainingJob?: HyperParameterTrainingJobSummary; + /** + * The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job. + */ + WarmStartConfig?: HyperParameterTuningJobWarmStartConfig; + /** + * If the tuning job failed, the reason it failed. + */ + FailureReason?: FailureReason; + } + export interface DescribeLabelingJobRequest { + /** + * The name of the labeling job to return information for. + */ + LabelingJobName: LabelingJobName; + } + export interface DescribeLabelingJobResponse { + /** + * The processing status of the labeling job. + */ + LabelingJobStatus: LabelingJobStatus; + /** + * Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled. + */ + LabelCounters: LabelCounters; + /** + * If the job failed, the reason that it failed. + */ + FailureReason?: FailureReason; + /** + * The date and time that the labeling job was created. + */ + CreationTime: Timestamp; + /** + * The date and time that the labeling job was last updated. + */ + LastModifiedTime: Timestamp; + /** + * A unique identifier for work done as part of a labeling job. + */ + JobReferenceCode: JobReferenceCode; + /** + * The name assigned to the labeling job when it was created. + */ + LabelingJobName: LabelingJobName; + /** + * The Amazon Resource Name (ARN) of the labeling job. + */ + LabelingJobArn: LabelingJobArn; + /** + * The attribute used as the label in the output manifest file. + */ + LabelAttributeName?: LabelAttributeName; + /** + * Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects. + */ + InputConfig: LabelingJobInputConfig; + /** + * The location of the job's output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any. + */ + OutputConfig: LabelingJobOutputConfig; + /** + * The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. + */ + RoleArn: RoleArn; + /** + * The S3 location of the JSON file that defines the categories used to label data objects. The file is a JSON structure in the following format: { "document-version": "2018-11-28" "labels": [ { "label": "label 1" }, { "label": "label 2" }, ... { "label": "label n" } ] } + */ + LabelCategoryConfigS3Uri?: S3Uri; + /** + * A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. + */ + StoppingConditions?: LabelingJobStoppingConditions; + /** + * Configuration information for automated data labeling. + */ + LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig; + /** + * Configuration information required for human workers to complete a labeling task. + */ + HumanTaskConfig: HumanTaskConfig; + /** + * An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + /** + * The location of the output produced by the labeling job. + */ + LabelingJobOutput?: LabelingJobOutput; + } + export interface DescribeModelInput { + /** + * The name of the model. + */ + ModelName: ModelName; + } + export interface DescribeModelOutput { + /** + * Name of the Amazon SageMaker model. + */ + ModelName: ModelName; + /** + * The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production. + */ + PrimaryContainer?: ContainerDefinition; + /** + * The containers in the inference pipeline. + */ + Containers?: ContainerDefinitionList; + /** + * The Amazon Resource Name (ARN) of the IAM role that you specified for the model. + */ + ExecutionRoleArn: RoleArn; + /** + * A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud + */ + VpcConfig?: VpcConfig; + /** + * A timestamp that shows when the model was created. + */ + CreationTime: Timestamp; + /** + * The Amazon Resource Name (ARN) of the model. + */ + ModelArn: ModelArn; + /** + * If True, no inbound or outbound network calls can be made to or from the model container. The Semantic Segmentation built-in algorithm does not support network isolation. + */ + EnableNetworkIsolation?: Boolean; + } + export interface DescribeModelPackageInput { + /** + * The name of the model package to describe. + */ + ModelPackageName: ArnOrName; + } + export interface DescribeModelPackageOutput { + /** + * The name of the model package being described. + */ + ModelPackageName: EntityName; + /** + * The Amazon Resource Name (ARN) of the model package. + */ + ModelPackageArn: ModelPackageArn; + /** + * A brief summary of the model package. + */ + ModelPackageDescription?: EntityDescription; + /** + * A timestamp specifying when the model package was created. + */ + CreationTime: CreationTime; + /** + * Details about inference jobs that can be run with models based on this model package. + */ + InferenceSpecification?: InferenceSpecification; + /** + * Details about the algorithm that was used to create the model package. + */ + SourceAlgorithmSpecification?: SourceAlgorithmSpecification; + /** + * Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package. + */ + ValidationSpecification?: ModelPackageValidationSpecification; + /** + * The current status of the model package. + */ + ModelPackageStatus: ModelPackageStatus; + /** + * Details about the current status of the model package. + */ + ModelPackageStatusDetails: ModelPackageStatusDetails; + /** + * Whether the model package is certified for listing on AWS Marketplace. + */ + CertifyForMarketplace?: CertifyForMarketplace; + } + export interface DescribeNotebookInstanceInput { + /** + * The name of the notebook instance that you want information about. + */ + NotebookInstanceName: NotebookInstanceName; + } + export interface DescribeNotebookInstanceLifecycleConfigInput { + /** + * The name of the lifecycle configuration to describe. + */ + NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName; + } + export interface DescribeNotebookInstanceLifecycleConfigOutput { + /** + * The Amazon Resource Name (ARN) of the lifecycle configuration. + */ + NotebookInstanceLifecycleConfigArn?: NotebookInstanceLifecycleConfigArn; + /** + * The name of the lifecycle configuration. + */ + NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName; + /** + * The shell script that runs only once, when you create a notebook instance. + */ + OnCreate?: NotebookInstanceLifecycleConfigList; + /** + * The shell script that runs every time you start a notebook instance, including when you create the notebook instance. + */ + OnStart?: NotebookInstanceLifecycleConfigList; + /** + * A timestamp that tells when the lifecycle configuration was last modified. + */ + LastModifiedTime?: LastModifiedTime; + /** + * A timestamp that tells when the lifecycle configuration was created. + */ + CreationTime?: CreationTime; + } + export interface DescribeNotebookInstanceOutput { + /** + * The Amazon Resource Name (ARN) of the notebook instance. + */ + NotebookInstanceArn?: NotebookInstanceArn; + /** + * The name of the Amazon SageMaker notebook instance. + */ + NotebookInstanceName?: NotebookInstanceName; + /** + * The status of the notebook instance. + */ + NotebookInstanceStatus?: NotebookInstanceStatus; + /** + * If status is Failed, the reason it failed. + */ + FailureReason?: FailureReason; + /** + * The URL that you use to connect to the Jupyter notebook that is running in your notebook instance. + */ + Url?: NotebookInstanceUrl; + /** + * The type of ML compute instance running on the notebook instance. + */ + InstanceType?: InstanceType; + /** + * The ID of the VPC subnet. + */ + SubnetId?: SubnetId; + /** + * The IDs of the VPC security groups. + */ + SecurityGroups?: SecurityGroupIds; + /** + * The Amazon Resource Name (ARN) of the IAM role associated with the instance. + */ + RoleArn?: RoleArn; + /** + * The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance. + */ + KmsKeyId?: KmsKeyId; + /** + * The network interface IDs that Amazon SageMaker created at the time of creating the instance. + */ + NetworkInterfaceId?: NetworkInterfaceId; + /** + * A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified. + */ + LastModifiedTime?: LastModifiedTime; + /** + * A timestamp. Use this parameter to return the time when the notebook instance was created + */ + CreationTime?: CreationTime; + /** + * Returns the name of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance + */ + NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName; + /** + * Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services. For more information, see Notebook Instances Are Internet-Enabled by Default. + */ + DirectInternetAccess?: DirectInternetAccess; + /** + * The size, in GB, of the ML storage volume attached to the notebook instance. + */ + VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB; + /** + * A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker. + */ + AcceleratorTypes?: NotebookInstanceAcceleratorTypes; + /** + * The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + DefaultCodeRepository?: CodeRepositoryNameOrUrl; + /** + * An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls; + /** + * Whether root access is enabled or disabled for users of the notebook instance. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users. + */ + RootAccess?: RootAccess; + } + export interface DescribeSubscribedWorkteamRequest { + /** + * The Amazon Resource Name (ARN) of the subscribed work team to describe. + */ + WorkteamArn: WorkteamArn; + } + export interface DescribeSubscribedWorkteamResponse { + /** + * A Workteam instance that contains information about the work team. + */ + SubscribedWorkteam: SubscribedWorkteam; + } + export interface DescribeTrainingJobRequest { + /** + * The name of the training job. + */ + TrainingJobName: TrainingJobName; + } + export interface DescribeTrainingJobResponse { + /** + * Name of the model training job. + */ + TrainingJobName: TrainingJobName; + /** + * The Amazon Resource Name (ARN) of the training job. + */ + TrainingJobArn: TrainingJobArn; + /** + * The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job. + */ + TuningJobArn?: HyperParameterTuningJobArn; + /** + * The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job. + */ + LabelingJobArn?: LabelingJobArn; + /** + * Information about the Amazon S3 location that is configured for storing model artifacts. + */ + ModelArtifacts: ModelArtifacts; + /** + * The status of the training job. Amazon SageMaker provides the following training job statuses: InProgress - The training is in progress. Completed - The training job has completed. Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call. Stopping - The training job is stopping. Stopped - The training job has stopped. For more detailed information, see SecondaryStatus. + */ + TrainingJobStatus: TrainingJobStatus; + /** + * Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition. Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. Valid values for SecondaryStatus are subject to change. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage + */ + SecondaryStatus: SecondaryStatus; + /** + * If the training job failed, the reason it failed. + */ + FailureReason?: FailureReason; + /** + * Algorithm-specific parameters. + */ + HyperParameters?: HyperParameters; + /** + * Information about the algorithm used for training, and algorithm metadata. + */ + AlgorithmSpecification: AlgorithmSpecification; + /** + * The AWS Identity and Access Management (IAM) role configured for the training job. + */ + RoleArn?: RoleArn; + /** + * An array of Channel objects that describes each data input channel. + */ + InputDataConfig?: InputDataConfig; + /** + * The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts. + */ + OutputDataConfig?: OutputDataConfig; + /** + * Resources, including ML compute instances and ML storage volumes, that are configured for model training. + */ + ResourceConfig: ResourceConfig; + /** + * A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud. + */ + VpcConfig?: VpcConfig; + /** + * The condition under which to stop the training job. + */ + StoppingCondition: StoppingCondition; + /** + * A timestamp that indicates when the training job was created. + */ + CreationTime: Timestamp; + /** + * Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container. + */ + TrainingStartTime?: Timestamp; + /** + * Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure. + */ + TrainingEndTime?: Timestamp; + /** + * A timestamp that indicates when the status of the training job was last modified. + */ + LastModifiedTime?: Timestamp; + /** + * A history of all of the secondary statuses that the training job has transitioned through. + */ + SecondaryStatusTransitions?: SecondaryStatusTransitions; + /** + * A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch. + */ + FinalMetricDataList?: FinalMetricDataList; + /** + * If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. The Semantic Segmentation built-in algorithm does not support network isolation. + */ + EnableNetworkIsolation?: Boolean; + /** + * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. + */ + EnableInterContainerTrafficEncryption?: Boolean; + } + export interface DescribeTransformJobRequest { + /** + * The name of the transform job that you want to view details of. + */ + TransformJobName: TransformJobName; + } + export interface DescribeTransformJobResponse { + /** + * The name of the transform job. + */ + TransformJobName: TransformJobName; + /** + * The Amazon Resource Name (ARN) of the transform job. + */ + TransformJobArn: TransformJobArn; + /** + * The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field. + */ + TransformJobStatus: TransformJobStatus; + /** + * If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch. + */ + FailureReason?: FailureReason; + /** + * The name of the model used in the transform job. + */ + ModelName: ModelName; + /** + * The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1. + */ + MaxConcurrentTransforms?: MaxConcurrentTransforms; + /** + * The maximum payload size, in MB, used in the transform job. + */ + MaxPayloadInMB?: MaxPayloadInMB; + /** + * Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record. To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord. + */ + BatchStrategy?: BatchStrategy; + /** + * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. + */ + Environment?: TransformEnvironmentMap; + /** + * Describes the dataset to be transformed and the Amazon S3 location where it is stored. + */ + TransformInput: TransformInput; + /** + * Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. + */ + TransformOutput?: TransformOutput; + /** + * Describes the resources, including ML instance types and ML instance count, to use for the transform job. + */ + TransformResources: TransformResources; + /** + * A timestamp that shows when the transform Job was created. + */ + CreationTime: Timestamp; + /** + * Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime. + */ + TransformStartTime?: Timestamp; + /** + * Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime. + */ + TransformEndTime?: Timestamp; + /** + * The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job. + */ + LabelingJobArn?: LabelingJobArn; + } + export interface DescribeWorkteamRequest { + /** + * The name of the work team to return a description of. + */ + WorkteamName: WorkteamName; + } + export interface DescribeWorkteamResponse { + /** + * A Workteam instance that contains information about the work team. + */ + Workteam: Workteam; + } + export interface DesiredWeightAndCapacity { + /** + * The name of the variant to update. + */ + VariantName: VariantName; + /** + * The variant's weight. + */ + DesiredWeight?: VariantWeight; + /** + * The variant's capacity. + */ + DesiredInstanceCount?: TaskCount; + } + export type DesiredWeightAndCapacityList = DesiredWeightAndCapacity[]; + export type DetailedAlgorithmStatus = "NotStarted"|"InProgress"|"Completed"|"Failed"|string; + export type DetailedModelPackageStatus = "NotStarted"|"InProgress"|"Completed"|"Failed"|string; + export type DirectInternetAccess = "Enabled"|"Disabled"|string; + export type DisassociateAdditionalCodeRepositories = boolean; + export type DisassociateDefaultCodeRepository = boolean; + export type DisassociateNotebookInstanceAcceleratorTypes = boolean; + export type DisassociateNotebookInstanceLifecycleConfig = boolean; + export type Dollars = number; + export type EndpointArn = string; + export type EndpointConfigArn = string; + export type EndpointConfigName = string; + export type EndpointConfigNameContains = string; + export type EndpointConfigSortKey = "Name"|"CreationTime"|string; + export interface EndpointConfigSummary { + /** + * The name of the endpoint configuration. + */ + EndpointConfigName: EndpointConfigName; + /** + * The Amazon Resource Name (ARN) of the endpoint configuration. + */ + EndpointConfigArn: EndpointConfigArn; + /** + * A timestamp that shows when the endpoint configuration was created. + */ + CreationTime: Timestamp; + } + export type EndpointConfigSummaryList = EndpointConfigSummary[]; + export type EndpointName = string; + export type EndpointNameContains = string; + export type EndpointSortKey = "Name"|"CreationTime"|"Status"|string; + export type EndpointStatus = "OutOfService"|"Creating"|"Updating"|"SystemUpdating"|"RollingBack"|"InService"|"Deleting"|"Failed"|string; + export interface EndpointSummary { + /** + * The name of the endpoint. + */ + EndpointName: EndpointName; + /** + * The Amazon Resource Name (ARN) of the endpoint. + */ + EndpointArn: EndpointArn; + /** + * A timestamp that shows when the endpoint was created. + */ + CreationTime: Timestamp; + /** + * A timestamp that shows when the endpoint was last modified. + */ + LastModifiedTime: Timestamp; + /** + * The status of the endpoint. OutOfService: Endpoint is not available to take incoming requests. Creating: CreateEndpoint is executing. Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. InService: Endpoint is available to process incoming requests. Deleting: DeleteEndpoint is executing. Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter. + */ + EndpointStatus: EndpointStatus; + } + export type EndpointSummaryList = EndpointSummary[]; + export type EntityDescription = string; + export type EntityName = string; + export type EnvironmentKey = string; + export type EnvironmentMap = {[key: string]: EnvironmentValue}; + export type EnvironmentValue = string; + export type FailureReason = string; + export interface Filter { + /** + * A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource. + */ + Name: ResourcePropertyName; + /** + * A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values: Equals The specified resource in Name equals the specified Value. NotEquals The specified resource in Name does not equal the specified Value. GreaterThan The specified resource in Name is greater than the specified Value. Not supported for text-based properties. GreaterThanOrEqualTo The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties. LessThan The specified resource in Name is less than the specified Value. Not supported for text-based properties. LessThanOrEqualTo The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties. Contains Only supported for text-based properties. The word-list of the property contains the specified Value. If you have specified a filter Value, the default is Equals. + */ + Operator?: Operator; + /** + * A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS. + */ + Value?: FilterValue; + } + export type FilterList = Filter[]; + export type FilterValue = string; + export interface FinalHyperParameterTuningJobObjectiveMetric { + /** + * Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize. + */ + Type?: HyperParameterTuningJobObjectiveType; + /** + * The name of the objective metric. + */ + MetricName: MetricName; + /** + * The value of the objective metric. + */ + Value: MetricValue; + } + export type FinalMetricDataList = MetricData[]; + export type Float = number; + export type Framework = "TENSORFLOW"|"MXNET"|"ONNX"|"PYTORCH"|"XGBOOST"|string; + export interface GetSearchSuggestionsRequest { + /** + * The name of the Amazon SageMaker resource to Search for. The only valid Resource value is TrainingJob. + */ + Resource: ResourceType; + /** + * Limits the property names that are included in the response. + */ + SuggestionQuery?: SuggestionQuery; + } + export interface GetSearchSuggestionsResponse { + /** + * A list of property names for a Resource that match a SuggestionQuery. + */ + PropertyNameSuggestions?: PropertyNameSuggestionList; + } + export interface GitConfig { + /** + * The URL where the Git repository is located. + */ + RepositoryUrl: GitConfigUrl; + /** + * The default branch for the Git repository. + */ + Branch?: Branch; + /** + * The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format: {"username": UserName, "password": Password} + */ + SecretArn?: SecretArn; + } + export interface GitConfigForUpdate { + /** + * The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format: {"username": UserName, "password": Password} + */ + SecretArn?: SecretArn; + } + export type GitConfigUrl = string; + export interface HumanTaskConfig { + /** + * The Amazon Resource Name (ARN) of the work team assigned to complete the tasks. + */ + WorkteamArn: WorkteamArn; + /** + * Information about the user interface that workers use to complete the labeling task. + */ + UiConfig: UiConfig; + /** + * The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job. For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions: US East (Northern Virginia) (us-east-1): arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass US East (Ohio) (us-east-2): arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass US West (Oregon) (us-west-2): arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass EU (Ireland) (eu-west-1): arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass Asia Pacific (Tokyo (ap-northeast-1): arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass + */ + PreHumanTaskLambdaArn: LambdaFunctionArn; + /** + * Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task. + */ + TaskKeywords?: TaskKeywords; + /** + * A title for the task for your human workers. + */ + TaskTitle: TaskTitle; + /** + * A description of the task for your human workers. + */ + TaskDescription: TaskDescription; + /** + * The number of human workers that will label an object. + */ + NumberOfHumanWorkersPerDataObject: NumberOfHumanWorkersPerDataObject; + /** + * The amount of time that a worker has to complete a task. + */ + TaskTimeLimitInSeconds: TaskTimeLimitInSeconds; + /** + * The length of time that a task remains available for labelling by human workers. + */ + TaskAvailabilityLifetimeInSeconds?: TaskAvailabilityLifetimeInSeconds; + /** + * Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time. + */ + MaxConcurrentTaskCount?: MaxConcurrentTaskCount; + /** + * Configures how labels are consolidated across human workers. + */ + AnnotationConsolidationConfig: AnnotationConsolidationConfig; + /** + * The price that you pay for each task performed by a public worker. + */ + PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice; + } + export interface HyperParameterAlgorithmSpecification { + /** + * The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker. + */ + TrainingImage?: AlgorithmImage; + /** + * The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container. If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information. For more information about input modes, see Algorithms. + */ + TrainingInputMode: TrainingInputMode; + /** + * The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage. + */ + AlgorithmName?: ArnOrName; + /** + * An array of MetricDefinition objects that specify the metrics that the algorithm emits. + */ + MetricDefinitions?: MetricDefinitionList; + } + export type HyperParameterScalingType = "Auto"|"Linear"|"Logarithmic"|"ReverseLogarithmic"|string; + export interface HyperParameterSpecification { + /** + * The name of this hyperparameter. The name must be unique. + */ + Name: ParameterName; + /** + * A brief description of the hyperparameter. + */ + Description?: EntityDescription; + /** + * The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText. + */ + Type: ParameterType; + /** + * The allowed range for this hyperparameter. + */ + Range?: ParameterRange; + /** + * Indicates whether this hyperparameter is tunable in a hyperparameter tuning job. + */ + IsTunable?: Boolean; + /** + * Indicates whether this hyperparameter is required. + */ + IsRequired?: Boolean; + /** + * The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required. + */ + DefaultValue?: ParameterValue; + } + export type HyperParameterSpecifications = HyperParameterSpecification[]; + export interface HyperParameterTrainingJobDefinition { + /** + * Specifies the values of hyperparameters that do not change for the tuning job. + */ + StaticHyperParameters?: HyperParameters; + /** + * The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches. + */ + AlgorithmSpecification: HyperParameterAlgorithmSpecification; + /** + * The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches. + */ + RoleArn: RoleArn; + /** + * An array of Channel objects that specify the input for the training jobs that the tuning job launches. + */ + InputDataConfig?: InputDataConfig; + /** + * The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud. + */ + VpcConfig?: VpcConfig; + /** + * Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches. + */ + OutputDataConfig: OutputDataConfig; + /** + * The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches. Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1. + */ + ResourceConfig: ResourceConfig; + /** + * Sets a maximum duration for the training jobs that the tuning job launches. Use this parameter to limit model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts. When Amazon SageMaker terminates a job because the stopping condition has been met, training algorithms provided by Amazon SageMaker save the intermediate results of the job. + */ + StoppingCondition: StoppingCondition; + /** + * Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. The Semantic Segmentation built-in algorithm does not support network isolation. + */ + EnableNetworkIsolation?: Boolean; + /** + * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. + */ + EnableInterContainerTrafficEncryption?: Boolean; + } + export type HyperParameterTrainingJobSummaries = HyperParameterTrainingJobSummary[]; + export interface HyperParameterTrainingJobSummary { + /** + * The name of the training job. + */ + TrainingJobName: TrainingJobName; + /** + * The Amazon Resource Name (ARN) of the training job. + */ + TrainingJobArn: TrainingJobArn; + /** + * The HyperParameter tuning job that launched the training job. + */ + TuningJobName?: HyperParameterTuningJobName; + /** + * The date and time that the training job was created. + */ + CreationTime: Timestamp; + /** + * The date and time that the training job started. + */ + TrainingStartTime?: Timestamp; + /** + * Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure. + */ + TrainingEndTime?: Timestamp; + /** + * The status of the training job. + */ + TrainingJobStatus: TrainingJobStatus; + /** + * A list of the hyperparameters for which you specified ranges to search. + */ + TunedHyperParameters: HyperParameters; + /** + * The reason that the training job failed. + */ + FailureReason?: FailureReason; + /** + * The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job. + */ + FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric; + /** + * The status of the objective metric for the training job: Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process. Pending: The training job is in progress and evaluation of its final objective metric is pending. Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric. + */ + ObjectiveStatus?: ObjectiveStatus; + } + export type HyperParameterTuningJobArn = string; + export interface HyperParameterTuningJobConfig { + /** + * Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works. + */ + Strategy: HyperParameterTuningJobStrategyType; + /** + * The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job. + */ + HyperParameterTuningJobObjective: HyperParameterTuningJobObjective; + /** + * The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job. + */ + ResourceLimits: ResourceLimits; + /** + * The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches. + */ + ParameterRanges: ParameterRanges; + /** + * Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF): OFF Training jobs launched by the hyperparameter tuning job do not use early stopping. AUTO Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early. + */ + TrainingJobEarlyStoppingType?: TrainingJobEarlyStoppingType; + } + export type HyperParameterTuningJobName = string; + export interface HyperParameterTuningJobObjective { + /** + * Whether to minimize or maximize the objective metric. + */ + Type: HyperParameterTuningJobObjectiveType; + /** + * The name of the metric to use for the objective metric. + */ + MetricName: MetricName; + } + export type HyperParameterTuningJobObjectiveType = "Maximize"|"Minimize"|string; + export type HyperParameterTuningJobObjectives = HyperParameterTuningJobObjective[]; + export type HyperParameterTuningJobSortByOptions = "Name"|"Status"|"CreationTime"|string; + export type HyperParameterTuningJobStatus = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|string; + export type HyperParameterTuningJobStrategyType = "Bayesian"|"Random"|string; + export type HyperParameterTuningJobSummaries = HyperParameterTuningJobSummary[]; + export interface HyperParameterTuningJobSummary { + /** + * The name of the tuning job. + */ + HyperParameterTuningJobName: HyperParameterTuningJobName; + /** + * The Amazon Resource Name (ARN) of the tuning job. + */ + HyperParameterTuningJobArn: HyperParameterTuningJobArn; + /** + * The status of the tuning job. + */ + HyperParameterTuningJobStatus: HyperParameterTuningJobStatus; + /** + * Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian. + */ + Strategy: HyperParameterTuningJobStrategyType; + /** + * The date and time that the tuning job was created. + */ + CreationTime: Timestamp; + /** + * The date and time that the tuning job ended. + */ + HyperParameterTuningEndTime?: Timestamp; + /** + * The date and time that the tuning job was modified. + */ + LastModifiedTime?: Timestamp; + /** + * The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched. + */ + TrainingJobStatusCounters: TrainingJobStatusCounters; + /** + * The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched. + */ + ObjectiveStatusCounters: ObjectiveStatusCounters; + /** + * The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job. + */ + ResourceLimits?: ResourceLimits; + } + export interface HyperParameterTuningJobWarmStartConfig { + /** + * An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point. Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs. + */ + ParentHyperParameterTuningJobs: ParentHyperParameterTuningJobs; + /** + * Specifies one of the following: IDENTICAL_DATA_AND_ALGORITHM The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs. TRANSFER_LEARNING The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs. + */ + WarmStartType: HyperParameterTuningJobWarmStartType; + } + export type HyperParameterTuningJobWarmStartType = "IdenticalDataAndAlgorithm"|"TransferLearning"|string; + export type HyperParameters = {[key: string]: ParameterValue}; + export type Image = string; + export type ImageDigest = string; + export interface InferenceSpecification { + /** + * The Amazon ECR registry path of the Docker image that contains the inference code. + */ + Containers: ModelPackageContainerDefinitionList; + /** + * A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. + */ + SupportedTransformInstanceTypes: TransformInstanceTypes; + /** + * A list of the instance types that are used to generate inferences in real-time. + */ + SupportedRealtimeInferenceInstanceTypes: RealtimeInferenceInstanceTypes; + /** + * The supported MIME types for the input data. + */ + SupportedContentTypes: ContentTypes; + /** + * The supported MIME types for the output data. + */ + SupportedResponseMIMETypes: ResponseMIMETypes; + } + export interface InputConfig { + /** + * The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). + */ + S3Uri: S3Uri; + /** + * Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific. TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"input":[1,1024,1024,3]} If using the CLI, {\"input\":[1,1024,1024,3]} Examples for two inputs: If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]} If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]} MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"data":[1,3,1024,1024]} If using the CLI, {\"data\":[1,3,1024,1024]} Examples for two inputs: If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]} If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]} PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same. Examples for one input in dictionary format: If using the console, {"input0":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224]} Example for one input in list format: [[1,3,224,224]] Examples for two inputs in dictionary format: If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]] XGBOOST: input data name and shape are not needed. + */ + DataInputConfig: DataInputConfig; + /** + * Identifies the framework in which the model was trained. For example: TENSORFLOW. + */ + Framework: Framework; + } + export type InputDataConfig = Channel[]; + export type InputModes = TrainingInputMode[]; + export type InstanceType = "ml.t2.medium"|"ml.t2.large"|"ml.t2.xlarge"|"ml.t2.2xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5d.xlarge"|"ml.c5d.2xlarge"|"ml.c5d.4xlarge"|"ml.c5d.9xlarge"|"ml.c5d.18xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|string; + export interface IntegerParameterRange { + /** + * The name of the hyperparameter to search. + */ + Name: ParameterKey; + /** + * The minimum value of the hyperparameter to search. + */ + MinValue: ParameterValue; + /** + * The maximum value of the hyperparameter to search. + */ + MaxValue: ParameterValue; + /** + * The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Range Scaling. One of the following values: Auto Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. Linear Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. Logarithmic Hyperparemeter tuning searches the values in the hyperparameter range by using a logarithmic scale. Logarithmic scaling works only for ranges that have only values greater than 0. + */ + ScalingType?: HyperParameterScalingType; + } + export interface IntegerParameterRangeSpecification { + /** + * The minimum integer value allowed. + */ + MinValue: ParameterValue; + /** + * The maximum integer value allowed. + */ + MaxValue: ParameterValue; + } + export type IntegerParameterRanges = IntegerParameterRange[]; + export type JobReferenceCode = string; + export type JobReferenceCodeContains = string; + export type KmsKeyId = string; + export type LabelAttributeName = string; + export type LabelCounter = number; + export interface LabelCounters { + /** + * The total number of objects labeled. + */ + TotalLabeled?: LabelCounter; + /** + * The total number of objects labeled by a human worker. + */ + HumanLabeled?: LabelCounter; + /** + * The total number of objects labeled by automated data labeling. + */ + MachineLabeled?: LabelCounter; + /** + * The total number of objects that could not be labeled due to an error. + */ + FailedNonRetryableError?: LabelCounter; + /** + * The total number of objects not yet labeled. + */ + Unlabeled?: LabelCounter; + } + export interface LabelCountersForWorkteam { + /** + * The total number of data objects labeled by a human worker. + */ + HumanLabeled?: LabelCounter; + /** + * The total number of data objects that need to be labeled by a human worker. + */ + PendingHuman?: LabelCounter; + /** + * The total number of tasks in the labeling job. + */ + Total?: LabelCounter; + } + export type LabelingJobAlgorithmSpecificationArn = string; + export interface LabelingJobAlgorithmsConfig { + /** + * Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs: Image classification arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification Text classification arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification Object detection arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection + */ + LabelingJobAlgorithmSpecificationArn: LabelingJobAlgorithmSpecificationArn; + /** + * At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here. + */ + InitialActiveLearningModelArn?: ModelArn; + /** + * Provides configuration information for a labeling job. + */ + LabelingJobResourceConfig?: LabelingJobResourceConfig; + } + export type LabelingJobArn = string; + export interface LabelingJobDataAttributes { + /** + * Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information. + */ + ContentClassifiers?: ContentClassifiers; + } + export interface LabelingJobDataSource { + /** + * The Amazon S3 location of the input data objects. + */ + S3DataSource: LabelingJobS3DataSource; + } + export interface LabelingJobForWorkteamSummary { + /** + * The name of the labeling job that the work team is assigned to. + */ + LabelingJobName?: LabelingJobName; + /** + * A unique identifier for a labeling job. You can use this to refer to a specific labeling job. + */ + JobReferenceCode: JobReferenceCode; + /** + * + */ + WorkRequesterAccountId: AccountId; + /** + * The date and time that the labeling job was created. + */ + CreationTime: Timestamp; + /** + * Provides information about the progress of a labeling job. + */ + LabelCounters?: LabelCountersForWorkteam; + } + export type LabelingJobForWorkteamSummaryList = LabelingJobForWorkteamSummary[]; + export interface LabelingJobInputConfig { + /** + * The location of the input data. + */ + DataSource: LabelingJobDataSource; + /** + * Attributes of the data specified by the customer. + */ + DataAttributes?: LabelingJobDataAttributes; + } + export type LabelingJobName = string; + export interface LabelingJobOutput { + /** + * The Amazon S3 bucket location of the manifest file for labeled data. + */ + OutputDatasetS3Uri: S3Uri; + /** + * The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling. + */ + FinalActiveLearningModelArn?: ModelArn; + } + export interface LabelingJobOutputConfig { + /** + * The Amazon S3 location to write output data. + */ + S3OutputPath: S3Uri; + /** + * The AWS Key Management Service ID of the key used to encrypt the output data, if any. + */ + KmsKeyId?: KmsKeyId; + } + export interface LabelingJobResourceConfig { + /** + * The AWS Key Management Service key ID for the key used to encrypt the output data, if any. + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface LabelingJobS3DataSource { + /** + * The Amazon S3 location of the manifest file that describes the input data objects. + */ + ManifestS3Uri: S3Uri; + } + export type LabelingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string; + export interface LabelingJobStoppingConditions { + /** + * The maximum number of objects that can be labeled by human workers. + */ + MaxHumanLabeledObjectCount?: MaxHumanLabeledObjectCount; + /** + * The maximum number of input data objects that should be labeled. + */ + MaxPercentageOfInputDatasetLabeled?: MaxPercentageOfInputDatasetLabeled; + } + export interface LabelingJobSummary { + /** + * The name of the labeling job. + */ + LabelingJobName: LabelingJobName; + /** + * The Amazon Resource Name (ARN) assigned to the labeling job when it was created. + */ + LabelingJobArn: LabelingJobArn; + /** + * The date and time that the job was created (timestamp). + */ + CreationTime: Timestamp; + /** + * The date and time that the job was last modified (timestamp). + */ + LastModifiedTime: Timestamp; + /** + * The current status of the labeling job. + */ + LabelingJobStatus: LabelingJobStatus; + /** + * Counts showing the progress of the labeling job. + */ + LabelCounters: LabelCounters; + /** + * The Amazon Resource Name (ARN) of the work team assigned to the job. + */ + WorkteamArn: WorkteamArn; + /** + * The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker. + */ + PreHumanTaskLambdaArn: LambdaFunctionArn; + /** + * The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation. + */ + AnnotationConsolidationLambdaArn?: LambdaFunctionArn; + /** + * If the LabelingJobStatus field is Failed, this field contains a description of the error. + */ + FailureReason?: FailureReason; + /** + * The location of the output produced by the labeling job. + */ + LabelingJobOutput?: LabelingJobOutput; + /** + * Input configuration for the labeling job. + */ + InputConfig?: LabelingJobInputConfig; + } + export type LabelingJobSummaryList = LabelingJobSummary[]; + export type LambdaFunctionArn = string; + export type LastModifiedTime = Date; + export interface ListAlgorithmsInput { + /** + * A filter that returns only algorithms created after the specified time (timestamp). + */ + CreationTimeAfter?: CreationTime; + /** + * A filter that returns only algorithms created before the specified time (timestamp). + */ + CreationTimeBefore?: CreationTime; + /** + * The maximum number of algorithms to return in the response. + */ + MaxResults?: MaxResults; + /** + * A string in the algorithm name. This filter returns only algorithms whose name contains the specified string. + */ + NameContains?: NameContains; + /** + * If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The parameter by which to sort the results. The default is CreationTime. + */ + SortBy?: AlgorithmSortBy; + /** + * The sort order for the results. The default is Ascending. + */ + SortOrder?: SortOrder; + } + export interface ListAlgorithmsOutput { + /** + * >An array of AlgorithmSummary objects, each of which lists an algorithm. + */ + AlgorithmSummaryList: AlgorithmSummaryList; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request. + */ + NextToken?: NextToken; + } + export interface ListCodeRepositoriesInput { + /** + * A filter that returns only Git repositories that were created after the specified time. + */ + CreationTimeAfter?: CreationTime; + /** + * A filter that returns only Git repositories that were created before the specified time. + */ + CreationTimeBefore?: CreationTime; + /** + * A filter that returns only Git repositories that were last modified after the specified time. + */ + LastModifiedTimeAfter?: Timestamp; + /** + * A filter that returns only Git repositories that were last modified before the specified time. + */ + LastModifiedTimeBefore?: Timestamp; + /** + * The maximum number of Git repositories to return in the response. + */ + MaxResults?: MaxResults; + /** + * A string in the Git repositories name. This filter returns only repositories whose name contains the specified string. + */ + NameContains?: CodeRepositoryNameContains; + /** + * If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The field to sort results by. The default is Name. + */ + SortBy?: CodeRepositorySortBy; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: CodeRepositorySortOrder; + } + export interface ListCodeRepositoriesOutput { + /** + * Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository: Name Amazon Resource Name (ARN) Creation time Last modified time Configuration information, including the URL location of the repository and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository. + */ + CodeRepositorySummaryList: CodeRepositorySummaryList; + /** + * If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request. + */ + NextToken?: NextToken; + } + export interface ListCompilationJobsRequest { + /** + * If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of model compilation jobs to return in the response. + */ + MaxResults?: MaxResults; + /** + * A filter that returns the model compilation jobs that were created after a specified time. + */ + CreationTimeAfter?: CreationTime; + /** + * A filter that returns the model compilation jobs that were created before a specified time. + */ + CreationTimeBefore?: CreationTime; + /** + * A filter that returns the model compilation jobs that were modified after a specified time. + */ + LastModifiedTimeAfter?: LastModifiedTime; + /** + * A filter that returns the model compilation jobs that were modified before a specified time. + */ + LastModifiedTimeBefore?: LastModifiedTime; + /** + * A filter that returns the model compilation jobs whose name contains a specified string. + */ + NameContains?: NameContains; + /** + * A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status. + */ + StatusEquals?: CompilationJobStatus; + /** + * The field by which to sort results. The default is CreationTime. + */ + SortBy?: ListCompilationJobsSortBy; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: SortOrder; + } + export interface ListCompilationJobsResponse { + /** + * An array of CompilationJobSummary objects, each describing a model compilation job. + */ + CompilationJobSummaries: CompilationJobSummaries; + /** + * If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request. + */ + NextToken?: NextToken; + } + export type ListCompilationJobsSortBy = "Name"|"CreationTime"|"Status"|string; + export interface ListEndpointConfigsInput { + /** + * The field to sort results by. The default is CreationTime. + */ + SortBy?: EndpointConfigSortKey; + /** + * The sort order for results. The default is Descending. + */ + SortOrder?: OrderKey; + /** + * If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request. + */ + NextToken?: PaginationToken; + /** + * The maximum number of training jobs to return in the response. + */ + MaxResults?: MaxResults; + /** + * A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string. + */ + NameContains?: EndpointConfigNameContains; + /** + * A filter that returns only endpoint configurations created before the specified time (timestamp). + */ + CreationTimeBefore?: Timestamp; + /** + * A filter that returns only endpoint configurations created after the specified time (timestamp). + */ + CreationTimeAfter?: Timestamp; + } + export interface ListEndpointConfigsOutput { + /** + * An array of endpoint configurations. + */ + EndpointConfigs: EndpointConfigSummaryList; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request + */ + NextToken?: PaginationToken; + } + export interface ListEndpointsInput { + /** + * Sorts the list of results. The default is CreationTime. + */ + SortBy?: EndpointSortKey; + /** + * The sort order for results. The default is Descending. + */ + SortOrder?: OrderKey; + /** + * If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request. + */ + NextToken?: PaginationToken; + /** + * The maximum number of endpoints to return in the response. + */ + MaxResults?: MaxResults; + /** + * A string in endpoint names. This filter returns only endpoints whose name contains the specified string. + */ + NameContains?: EndpointNameContains; + /** + * A filter that returns only endpoints that were created before the specified time (timestamp). + */ + CreationTimeBefore?: Timestamp; + /** + * A filter that returns only endpoints that were created after the specified time (timestamp). + */ + CreationTimeAfter?: Timestamp; + /** + * A filter that returns only endpoints that were modified before the specified timestamp. + */ + LastModifiedTimeBefore?: Timestamp; + /** + * A filter that returns only endpoints that were modified after the specified timestamp. + */ + LastModifiedTimeAfter?: Timestamp; + /** + * A filter that returns only endpoints with the specified status. + */ + StatusEquals?: EndpointStatus; + } + export interface ListEndpointsOutput { + /** + * An array or endpoint objects. + */ + Endpoints: EndpointSummaryList; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request. + */ + NextToken?: PaginationToken; + } + export interface ListHyperParameterTuningJobsRequest { + /** + * If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of tuning jobs to return. The default value is 10. + */ + MaxResults?: MaxResults; + /** + * The field to sort results by. The default is Name. + */ + SortBy?: HyperParameterTuningJobSortByOptions; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: SortOrder; + /** + * A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string. + */ + NameContains?: NameContains; + /** + * A filter that returns only tuning jobs that were created after the specified time. + */ + CreationTimeAfter?: Timestamp; + /** + * A filter that returns only tuning jobs that were created before the specified time. + */ + CreationTimeBefore?: Timestamp; + /** + * A filter that returns only tuning jobs that were modified after the specified time. + */ + LastModifiedTimeAfter?: Timestamp; + /** + * A filter that returns only tuning jobs that were modified before the specified time. + */ + LastModifiedTimeBefore?: Timestamp; + /** + * A filter that returns only tuning jobs with the specified status. + */ + StatusEquals?: HyperParameterTuningJobStatus; + } + export interface ListHyperParameterTuningJobsResponse { + /** + * A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned. + */ + HyperParameterTuningJobSummaries: HyperParameterTuningJobSummaries; + /** + * If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request. + */ + NextToken?: NextToken; + } + export interface ListLabelingJobsForWorkteamRequest { + /** + * The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for. + */ + WorkteamArn: WorkteamArn; + /** + * The maximum number of labeling jobs to return in each page of the response. + */ + MaxResults?: MaxResults; + /** + * If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * A filter that returns only labeling jobs created after the specified time (timestamp). + */ + CreationTimeAfter?: Timestamp; + /** + * A filter that returns only labeling jobs created before the specified time (timestamp). + */ + CreationTimeBefore?: Timestamp; + /** + * A filter the limits jobs to only the ones whose job reference code contains the specified string. + */ + JobReferenceCodeContains?: JobReferenceCodeContains; + /** + * The field to sort results by. The default is CreationTime. + */ + SortBy?: ListLabelingJobsForWorkteamSortByOptions; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: SortOrder; + } + export interface ListLabelingJobsForWorkteamResponse { + /** + * An array of LabelingJobSummary objects, each describing a labeling job. + */ + LabelingJobSummaryList: LabelingJobForWorkteamSummaryList; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request. + */ + NextToken?: NextToken; + } + export type ListLabelingJobsForWorkteamSortByOptions = "CreationTime"|string; + export interface ListLabelingJobsRequest { + /** + * A filter that returns only labeling jobs created after the specified time (timestamp). + */ + CreationTimeAfter?: Timestamp; + /** + * A filter that returns only labeling jobs created before the specified time (timestamp). + */ + CreationTimeBefore?: Timestamp; + /** + * A filter that returns only labeling jobs modified after the specified time (timestamp). + */ + LastModifiedTimeAfter?: Timestamp; + /** + * A filter that returns only labeling jobs modified before the specified time (timestamp). + */ + LastModifiedTimeBefore?: Timestamp; + /** + * The maximum number of labeling jobs to return in each page of the response. + */ + MaxResults?: MaxResults; + /** + * If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string. + */ + NameContains?: NameContains; + /** + * The field to sort results by. The default is CreationTime. + */ + SortBy?: SortBy; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: SortOrder; + /** + * A filter that retrieves only labeling jobs with a specific status. + */ + StatusEquals?: LabelingJobStatus; + } + export interface ListLabelingJobsResponse { + /** + * An array of LabelingJobSummary objects, each describing a labeling job. + */ + LabelingJobSummaryList?: LabelingJobSummaryList; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request. + */ + NextToken?: NextToken; + } + export interface ListModelPackagesInput { + /** + * A filter that returns only model packages created after the specified time (timestamp). + */ + CreationTimeAfter?: CreationTime; + /** + * A filter that returns only model packages created before the specified time (timestamp). + */ + CreationTimeBefore?: CreationTime; + /** + * The maximum number of model packages to return in the response. + */ + MaxResults?: MaxResults; + /** + * A string in the model package name. This filter returns only model packages whose name contains the specified string. + */ + NameContains?: NameContains; + /** + * If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The parameter by which to sort the results. The default is CreationTime. + */ + SortBy?: ModelPackageSortBy; + /** + * The sort order for the results. The default is Ascending. + */ + SortOrder?: SortOrder; + } + export interface ListModelPackagesOutput { + /** + * An array of ModelPackageSummary objects, each of which lists a model package. + */ + ModelPackageSummaryList: ModelPackageSummaryList; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request. + */ + NextToken?: NextToken; + } + export interface ListModelsInput { + /** + * Sorts the list of results. The default is CreationTime. + */ + SortBy?: ModelSortKey; + /** + * The sort order for results. The default is Descending. + */ + SortOrder?: OrderKey; + /** + * If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request. + */ + NextToken?: PaginationToken; + /** + * The maximum number of models to return in the response. + */ + MaxResults?: MaxResults; + /** + * A string in the training job name. This filter returns only models in the training job whose name contains the specified string. + */ + NameContains?: ModelNameContains; + /** + * A filter that returns only models created before the specified time (timestamp). + */ + CreationTimeBefore?: Timestamp; + /** + * A filter that returns only models created after the specified time (timestamp). + */ + CreationTimeAfter?: Timestamp; + } + export interface ListModelsOutput { + /** + * An array of ModelSummary objects, each of which lists a model. + */ + Models: ModelSummaryList; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request. + */ + NextToken?: PaginationToken; + } + export interface ListNotebookInstanceLifecycleConfigsInput { + /** + * If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of lifecycle configurations to return in the response. + */ + MaxResults?: MaxResults; + /** + * Sorts the list of results. The default is CreationTime. + */ + SortBy?: NotebookInstanceLifecycleConfigSortKey; + /** + * The sort order for results. + */ + SortOrder?: NotebookInstanceLifecycleConfigSortOrder; + /** + * A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string. + */ + NameContains?: NotebookInstanceLifecycleConfigNameContains; + /** + * A filter that returns only lifecycle configurations that were created before the specified time (timestamp). + */ + CreationTimeBefore?: CreationTime; + /** + * A filter that returns only lifecycle configurations that were created after the specified time (timestamp). + */ + CreationTimeAfter?: CreationTime; + /** + * A filter that returns only lifecycle configurations that were modified before the specified time (timestamp). + */ + LastModifiedTimeBefore?: LastModifiedTime; + /** + * A filter that returns only lifecycle configurations that were modified after the specified time (timestamp). + */ + LastModifiedTimeAfter?: LastModifiedTime; + } + export interface ListNotebookInstanceLifecycleConfigsOutput { + /** + * If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request. + */ + NextToken?: NextToken; + /** + * An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration. + */ + NotebookInstanceLifecycleConfigs?: NotebookInstanceLifecycleConfigSummaryList; + } + export interface ListNotebookInstancesInput { + /** + * If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances. You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of notebook instances to return. + */ + MaxResults?: MaxResults; + /** + * The field to sort results by. The default is Name. + */ + SortBy?: NotebookInstanceSortKey; + /** + * The sort order for results. + */ + SortOrder?: NotebookInstanceSortOrder; + /** + * A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string. + */ + NameContains?: NotebookInstanceNameContains; + /** + * A filter that returns only notebook instances that were created before the specified time (timestamp). + */ + CreationTimeBefore?: CreationTime; + /** + * A filter that returns only notebook instances that were created after the specified time (timestamp). + */ + CreationTimeAfter?: CreationTime; + /** + * A filter that returns only notebook instances that were modified before the specified time (timestamp). + */ + LastModifiedTimeBefore?: LastModifiedTime; + /** + * A filter that returns only notebook instances that were modified after the specified time (timestamp). + */ + LastModifiedTimeAfter?: LastModifiedTime; + /** + * A filter that returns only notebook instances with the specified status. + */ + StatusEquals?: NotebookInstanceStatus; + /** + * A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string. + */ + NotebookInstanceLifecycleConfigNameContains?: NotebookInstanceLifecycleConfigName; + /** + * A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string. + */ + DefaultCodeRepositoryContains?: CodeRepositoryContains; + /** + * A filter that returns only notebook instances with associated with the specified git repository. + */ + AdditionalCodeRepositoryEquals?: CodeRepositoryNameOrUrl; + } + export interface ListNotebookInstancesOutput { + /** + * If the response to the previous ListNotebookInstances request was truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request. + */ + NextToken?: NextToken; + /** + * An array of NotebookInstanceSummary objects, one for each notebook instance. + */ + NotebookInstances?: NotebookInstanceSummaryList; + } + export interface ListSubscribedWorkteamsRequest { + /** + * A string in the work team name. This filter returns only work teams whose name contains the specified string. + */ + NameContains?: WorkteamName; + /** + * If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of work teams to return in each page of the response. + */ + MaxResults?: MaxResults; + } + export interface ListSubscribedWorkteamsResponse { + /** + * An array of Workteam objects, each describing a work team. + */ + SubscribedWorkteams: SubscribedWorkteams; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request. + */ + NextToken?: NextToken; + } + export interface ListTagsInput { + /** + * The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. + */ + ResourceArn: ResourceArn; + /** + * If the response to the previous ListTags request is truncated, Amazon SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request. + */ + NextToken?: NextToken; + /** + * Maximum number of tags to return. + */ + MaxResults?: ListTagsMaxResults; + } + export type ListTagsMaxResults = number; + export interface ListTagsOutput { + /** + * An array of Tag objects, each with a tag key and a value. + */ + Tags?: TagList; + /** + * If response is truncated, Amazon SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens. + */ + NextToken?: NextToken; + } + export interface ListTrainingJobsForHyperParameterTuningJobRequest { + /** + * The name of the tuning job whose training jobs you want to list. + */ + HyperParameterTuningJobName: HyperParameterTuningJobName; + /** + * If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of training jobs to return. The default value is 10. + */ + MaxResults?: MaxResults; + /** + * A filter that returns only training jobs with the specified status. + */ + StatusEquals?: TrainingJobStatus; + /** + * The field to sort results by. The default is Name. If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed. + */ + SortBy?: TrainingJobSortByOptions; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: SortOrder; + } + export interface ListTrainingJobsForHyperParameterTuningJobResponse { + /** + * A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned. + */ + TrainingJobSummaries: HyperParameterTrainingJobSummaries; + /** + * If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request. + */ + NextToken?: NextToken; + } + export interface ListTrainingJobsRequest { + /** + * If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of training jobs to return in the response. + */ + MaxResults?: MaxResults; + /** + * A filter that returns only training jobs created after the specified time (timestamp). + */ + CreationTimeAfter?: Timestamp; + /** + * A filter that returns only training jobs created before the specified time (timestamp). + */ + CreationTimeBefore?: Timestamp; + /** + * A filter that returns only training jobs modified after the specified time (timestamp). + */ + LastModifiedTimeAfter?: Timestamp; + /** + * A filter that returns only training jobs modified before the specified time (timestamp). + */ + LastModifiedTimeBefore?: Timestamp; + /** + * A string in the training job name. This filter returns only training jobs whose name contains the specified string. + */ + NameContains?: NameContains; + /** + * A filter that retrieves only training jobs with a specific status. + */ + StatusEquals?: TrainingJobStatus; + /** + * The field to sort results by. The default is CreationTime. + */ + SortBy?: SortBy; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: SortOrder; + } + export interface ListTrainingJobsResponse { + /** + * An array of TrainingJobSummary objects, each listing a training job. + */ + TrainingJobSummaries: TrainingJobSummaries; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request. + */ + NextToken?: NextToken; + } + export interface ListTransformJobsRequest { + /** + * A filter that returns only transform jobs created after the specified time. + */ + CreationTimeAfter?: Timestamp; + /** + * A filter that returns only transform jobs created before the specified time. + */ + CreationTimeBefore?: Timestamp; + /** + * A filter that returns only transform jobs modified after the specified time. + */ + LastModifiedTimeAfter?: Timestamp; + /** + * A filter that returns only transform jobs modified before the specified time. + */ + LastModifiedTimeBefore?: Timestamp; + /** + * A string in the transform job name. This filter returns only transform jobs whose name contains the specified string. + */ + NameContains?: NameContains; + /** + * A filter that retrieves only transform jobs with a specific status. + */ + StatusEquals?: TransformJobStatus; + /** + * The field to sort results by. The default is CreationTime. + */ + SortBy?: SortBy; + /** + * The sort order for results. The default is Descending. + */ + SortOrder?: SortOrder; + /** + * If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of transform jobs to return in the response. The default value is 10. + */ + MaxResults?: MaxResults; + } + export interface ListTransformJobsResponse { + /** + * An array of TransformJobSummary objects. + */ + TransformJobSummaries: TransformJobSummaries; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request. + */ + NextToken?: NextToken; + } + export interface ListWorkteamsRequest { + /** + * The field to sort results by. The default is CreationTime. + */ + SortBy?: ListWorkteamsSortByOptions; + /** + * The sort order for results. The default is Ascending. + */ + SortOrder?: SortOrder; + /** + * A string in the work team's name. This filter returns only work teams whose name contains the specified string. + */ + NameContains?: WorkteamName; + /** + * If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of work teams to return in each page of the response. + */ + MaxResults?: MaxResults; + } + export interface ListWorkteamsResponse { + /** + * An array of Workteam objects, each describing a work team. + */ + Workteams: Workteams; + /** + * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request. + */ + NextToken?: NextToken; + } + export type ListWorkteamsSortByOptions = "Name"|"CreateDate"|string; + export type MaxConcurrentTaskCount = number; + export type MaxConcurrentTransforms = number; + export type MaxHumanLabeledObjectCount = number; + export type MaxNumberOfTrainingJobs = number; + export type MaxParallelTrainingJobs = number; + export type MaxPayloadInMB = number; + export type MaxPercentageOfInputDatasetLabeled = number; + export type MaxResults = number; + export type MaxRuntimeInSeconds = number; + export interface MemberDefinition { + /** + * The Amazon Cognito user group that is part of the work team. + */ + CognitoMemberDefinition?: CognitoMemberDefinition; + } + export type MemberDefinitions = MemberDefinition[]; + export interface MetricData { + /** + * The name of the metric. + */ + MetricName?: MetricName; + /** + * The value of the metric. + */ + Value?: Float; + /** + * The date and time that the algorithm emitted the metric. + */ + Timestamp?: Timestamp; + } + export interface MetricDefinition { + /** + * The name of the metric. + */ + Name: MetricName; + /** + * A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics. + */ + Regex: MetricRegex; + } + export type MetricDefinitionList = MetricDefinition[]; + export type MetricName = string; + export type MetricRegex = string; + export type MetricValue = number; + export type ModelArn = string; + export interface ModelArtifacts { + /** + * The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz. + */ + S3ModelArtifacts: S3Uri; + } + export type ModelName = string; + export type ModelNameContains = string; + export type ModelPackageArn = string; + export interface ModelPackageContainerDefinition { + /** + * The DNS host name for the Docker container. + */ + ContainerHostname?: ContainerHostname; + /** + * The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker. + */ + Image: Image; + /** + * An MD5 hash of the training algorithm that identifies the Docker image used for training. + */ + ImageDigest?: ImageDigest; + /** + * The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). + */ + ModelDataUrl?: Url; + /** + * The AWS Marketplace product ID of the model package. + */ + ProductId?: ProductId; + } + export type ModelPackageContainerDefinitionList = ModelPackageContainerDefinition[]; + export type ModelPackageSortBy = "Name"|"CreationTime"|string; + export type ModelPackageStatus = "Pending"|"InProgress"|"Completed"|"Failed"|"Deleting"|string; + export interface ModelPackageStatusDetails { + /** + * The validation status of the model package. + */ + ValidationStatuses: ModelPackageStatusItemList; + /** + * The status of the scan of the Docker image container for the model package. + */ + ImageScanStatuses?: ModelPackageStatusItemList; + } + export interface ModelPackageStatusItem { + /** + * The name of the model package for which the overall status is being reported. + */ + Name: EntityName; + /** + * The current status. + */ + Status: DetailedModelPackageStatus; + /** + * if the overall status is Failed, the reason for the failure. + */ + FailureReason?: String; + } + export type ModelPackageStatusItemList = ModelPackageStatusItem[]; + export interface ModelPackageSummary { + /** + * The name of the model package. + */ + ModelPackageName: EntityName; + /** + * The Amazon Resource Name (ARN) of the model package. + */ + ModelPackageArn: ModelPackageArn; + /** + * A brief description of the model package. + */ + ModelPackageDescription?: EntityDescription; + /** + * A timestamp that shows when the model package was created. + */ + CreationTime: CreationTime; + /** + * The overall status of the model package. + */ + ModelPackageStatus: ModelPackageStatus; + } + export type ModelPackageSummaryList = ModelPackageSummary[]; + export interface ModelPackageValidationProfile { + /** + * The name of the profile for the model package. + */ + ProfileName: EntityName; + /** + * The TransformJobDefinition object that describes the transform job used for the validation of the model package. + */ + TransformJobDefinition: TransformJobDefinition; + } + export type ModelPackageValidationProfiles = ModelPackageValidationProfile[]; + export interface ModelPackageValidationSpecification { + /** + * The IAM roles to be used for the validation of the model package. + */ + ValidationRole: RoleArn; + /** + * An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package. + */ + ValidationProfiles: ModelPackageValidationProfiles; + } + export type ModelSortKey = "Name"|"CreationTime"|string; + export interface ModelSummary { + /** + * The name of the model that you want a summary for. + */ + ModelName: ModelName; + /** + * The Amazon Resource Name (ARN) of the model. + */ + ModelArn: ModelArn; + /** + * A timestamp that indicates when the model was created. + */ + CreationTime: Timestamp; + } + export type ModelSummaryList = ModelSummary[]; + export type NameContains = string; + export interface NestedFilters { + /** + * The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig. + */ + NestedPropertyName: ResourcePropertyName; + /** + * A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri. + */ + Filters: FilterList; + } + export type NestedFiltersList = NestedFilters[]; + export type NetworkInterfaceId = string; + export type NextToken = string; + export type NotebookInstanceAcceleratorType = "ml.eia1.medium"|"ml.eia1.large"|"ml.eia1.xlarge"|string; + export type NotebookInstanceAcceleratorTypes = NotebookInstanceAcceleratorType[]; + export type NotebookInstanceArn = string; + export type NotebookInstanceLifecycleConfigArn = string; + export type NotebookInstanceLifecycleConfigContent = string; + export type NotebookInstanceLifecycleConfigList = NotebookInstanceLifecycleHook[]; + export type NotebookInstanceLifecycleConfigName = string; + export type NotebookInstanceLifecycleConfigNameContains = string; + export type NotebookInstanceLifecycleConfigSortKey = "Name"|"CreationTime"|"LastModifiedTime"|string; + export type NotebookInstanceLifecycleConfigSortOrder = "Ascending"|"Descending"|string; + export interface NotebookInstanceLifecycleConfigSummary { + /** + * The name of the lifecycle configuration. + */ + NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName; + /** + * The Amazon Resource Name (ARN) of the lifecycle configuration. + */ + NotebookInstanceLifecycleConfigArn: NotebookInstanceLifecycleConfigArn; + /** + * A timestamp that tells when the lifecycle configuration was created. + */ + CreationTime?: CreationTime; + /** + * A timestamp that tells when the lifecycle configuration was last modified. + */ + LastModifiedTime?: LastModifiedTime; + } + export type NotebookInstanceLifecycleConfigSummaryList = NotebookInstanceLifecycleConfigSummary[]; + export interface NotebookInstanceLifecycleHook { + /** + * A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration. + */ + Content?: NotebookInstanceLifecycleConfigContent; + } + export type NotebookInstanceName = string; + export type NotebookInstanceNameContains = string; + export type NotebookInstanceSortKey = "Name"|"CreationTime"|"Status"|string; + export type NotebookInstanceSortOrder = "Ascending"|"Descending"|string; + export type NotebookInstanceStatus = "Pending"|"InService"|"Stopping"|"Stopped"|"Failed"|"Deleting"|"Updating"|string; + export interface NotebookInstanceSummary { + /** + * The name of the notebook instance that you want a summary for. + */ + NotebookInstanceName: NotebookInstanceName; + /** + * The Amazon Resource Name (ARN) of the notebook instance. + */ + NotebookInstanceArn: NotebookInstanceArn; + /** + * The status of the notebook instance. + */ + NotebookInstanceStatus?: NotebookInstanceStatus; + /** + * The URL that you use to connect to the Jupyter instance running in your notebook instance. + */ + Url?: NotebookInstanceUrl; + /** + * The type of ML compute instance that the notebook instance is running on. + */ + InstanceType?: InstanceType; + /** + * A timestamp that shows when the notebook instance was created. + */ + CreationTime?: CreationTime; + /** + * A timestamp that shows when the notebook instance was last modified. + */ + LastModifiedTime?: LastModifiedTime; + /** + * The name of a notebook instance lifecycle configuration associated with this notebook instance. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. + */ + NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName; + /** + * The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + DefaultCodeRepository?: CodeRepositoryNameOrUrl; + /** + * An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls; + } + export type NotebookInstanceSummaryList = NotebookInstanceSummary[]; + export type NotebookInstanceUrl = string; + export type NotebookInstanceVolumeSizeInGB = number; + export type NumberOfHumanWorkersPerDataObject = number; + export type ObjectiveStatus = "Succeeded"|"Pending"|"Failed"|string; + export type ObjectiveStatusCounter = number; + export interface ObjectiveStatusCounters { + /** + * The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process. + */ + Succeeded?: ObjectiveStatusCounter; + /** + * The number of training jobs that are in progress and pending evaluation of their final objective metric. + */ + Pending?: ObjectiveStatusCounter; + /** + * The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric. + */ + Failed?: ObjectiveStatusCounter; + } + export type Operator = "Equals"|"NotEquals"|"GreaterThan"|"GreaterThanOrEqualTo"|"LessThan"|"LessThanOrEqualTo"|"Contains"|string; + export type OrderKey = "Ascending"|"Descending"|string; + export interface OutputConfig { + /** + * Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix. + */ + S3OutputLocation: S3Uri; + /** + * Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5. + */ + TargetDevice: TargetDevice; + } + export interface OutputDataConfig { + /** + * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide. + */ + KmsKeyId?: KmsKeyId; + /** + * Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix. + */ + S3OutputPath: S3Uri; + } + export type PaginationToken = string; + export type ParameterKey = string; + export type ParameterName = string; + export interface ParameterRange { + /** + * A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter. + */ + IntegerParameterRangeSpecification?: IntegerParameterRangeSpecification; + /** + * A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter. + */ + ContinuousParameterRangeSpecification?: ContinuousParameterRangeSpecification; + /** + * A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter. + */ + CategoricalParameterRangeSpecification?: CategoricalParameterRangeSpecification; + } + export interface ParameterRanges { + /** + * The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches. + */ + IntegerParameterRanges?: IntegerParameterRanges; + /** + * The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches. + */ + ContinuousParameterRanges?: ContinuousParameterRanges; + /** + * The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches. + */ + CategoricalParameterRanges?: CategoricalParameterRanges; + } + export type ParameterType = "Integer"|"Continuous"|"Categorical"|"FreeText"|string; + export type ParameterValue = string; + export type ParameterValues = ParameterValue[]; + export interface ParentHyperParameterTuningJob { + /** + * The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job. + */ + HyperParameterTuningJobName?: HyperParameterTuningJobName; + } + export type ParentHyperParameterTuningJobs = ParentHyperParameterTuningJob[]; + export type ProductId = string; + export type ProductListings = String[]; + export interface ProductionVariant { + /** + * The name of the production variant. + */ + VariantName: VariantName; + /** + * The name of the model that you want to host. This is the name that you specified when creating the model. + */ + ModelName: ModelName; + /** + * Number of instances to launch initially. + */ + InitialInstanceCount: TaskCount; + /** + * The ML compute instance type. + */ + InstanceType: ProductionVariantInstanceType; + /** + * Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0. + */ + InitialVariantWeight?: VariantWeight; + /** + * The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker. For more information, see Using Elastic Inference in Amazon SageMaker. + */ + AcceleratorType?: ProductionVariantAcceleratorType; + } + export type ProductionVariantAcceleratorType = "ml.eia1.medium"|"ml.eia1.large"|"ml.eia1.xlarge"|string; + export type ProductionVariantInstanceType = "ml.t2.medium"|"ml.t2.large"|"ml.t2.xlarge"|"ml.t2.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.large"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|string; + export type ProductionVariantList = ProductionVariant[]; + export interface ProductionVariantSummary { + /** + * The name of the variant. + */ + VariantName: VariantName; + /** + * An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant. + */ + DeployedImages?: DeployedImages; + /** + * The weight associated with the variant. + */ + CurrentWeight?: VariantWeight; + /** + * The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request. + */ + DesiredWeight?: VariantWeight; + /** + * The number of instances associated with the variant. + */ + CurrentInstanceCount?: TaskCount; + /** + * The number of instances requested in the UpdateEndpointWeightsAndCapacities request. + */ + DesiredInstanceCount?: TaskCount; + } + export type ProductionVariantSummaryList = ProductionVariantSummary[]; + export type PropertyNameHint = string; + export interface PropertyNameQuery { + /** + * Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the PropertyNameHint. + */ + PropertyNameHint: PropertyNameHint; + } + export interface PropertyNameSuggestion { + /** + * A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console. + */ + PropertyName?: ResourcePropertyName; + } + export type PropertyNameSuggestionList = PropertyNameSuggestion[]; + export interface PublicWorkforceTaskPrice { + /** + * Defines the amount of money paid to a worker in United States dollars. + */ + AmountInUsd?: USD; + } + export type RealtimeInferenceInstanceTypes = ProductionVariantInstanceType[]; + export type RecordWrapper = "None"|"RecordIO"|string; + export interface RenderUiTemplateRequest { + /** + * A Template object containing the worker UI template to render. + */ + UiTemplate: UiTemplate; + /** + * A RenderableTask object containing a representative task to render. + */ + Task: RenderableTask; + /** + * The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template. + */ + RoleArn: RoleArn; + } + export interface RenderUiTemplateResponse { + /** + * A Liquid template that renders the HTML for the worker UI. + */ + RenderedContent: String; + /** + * A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty. + */ + Errors: RenderingErrorList; + } + export interface RenderableTask { + /** + * A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text". + */ + Input: TaskInput; + } + export interface RenderingError { + /** + * A unique identifier for a specific class of errors. + */ + Code: String; + /** + * A human-readable message describing the error. + */ + Message: String; + } + export type RenderingErrorList = RenderingError[]; + export type ResourceArn = string; + export interface ResourceConfig { + /** + * The ML compute instance type. + */ + InstanceType: TrainingInstanceType; + /** + * The number of ML compute instances to use. For distributed training, provide a value greater than 1. + */ + InstanceCount: TrainingInstanceCount; + /** + * The size of the ML storage volume that you want to provision. ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification. You must specify sufficient ML storage for your scenario. Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type. + */ + VolumeSizeInGB: VolumeSizeInGB; + /** + * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface ResourceLimits { + /** + * The maximum number of training jobs that a hyperparameter tuning job can launch. + */ + MaxNumberOfTrainingJobs: MaxNumberOfTrainingJobs; + /** + * The maximum number of concurrent training jobs that a hyperparameter tuning job can launch. + */ + MaxParallelTrainingJobs: MaxParallelTrainingJobs; + } + export type ResourcePropertyName = string; + export type ResourceType = "TrainingJob"|string; + export type ResponseMIMEType = string; + export type ResponseMIMETypes = ResponseMIMEType[]; + export type RoleArn = string; + export type RootAccess = "Enabled"|"Disabled"|string; + export type S3DataDistribution = "FullyReplicated"|"ShardedByS3Key"|string; + export interface S3DataSource { + /** + * If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training. If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe. + */ + S3DataType: S3DataType; + /** + * Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example: A key name prefix might look like this: s3://bucketname/exampleprefix. A manifest might look like this: s3://bucketname/example.manifest The manifest is an S3 object which is a JSON file with the following format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... ] The preceding JSON matches the following s3Uris: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf. + */ + S3Uri: S3Uri; + /** + * If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated. If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data. Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms. In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects. + */ + S3DataDistributionType?: S3DataDistribution; + /** + * A list of one or more attribute names to use that are found in a specified augmented manifest file. + */ + AttributeNames?: AttributeNames; + } + export type S3DataType = "ManifestFile"|"S3Prefix"|"AugmentedManifestFile"|string; + export type S3Uri = string; + export interface SearchExpression { + /** + * A list of filter objects. + */ + Filters?: FilterList; + /** + * A list of nested filter objects. + */ + NestedFilters?: NestedFiltersList; + /** + * A list of search expression objects. + */ + SubExpressions?: SearchExpressionList; + /** + * A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And. + */ + Operator?: BooleanOperator; + } + export type SearchExpressionList = SearchExpression[]; + export interface SearchRecord { + /** + * A TrainingJob object that is returned as part of a Search request. + */ + TrainingJob?: TrainingJob; + } + export interface SearchRequest { + /** + * The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob. + */ + Resource: ResourceType; + /** + * A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50. + */ + SearchExpression?: SearchExpression; + /** + * The name of the resource property used to sort the SearchResults. The default is LastModifiedTime. + */ + SortBy?: ResourcePropertyName; + /** + * How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending. + */ + SortOrder?: SearchSortOrder; + /** + * If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a SearchResponse. + */ + MaxResults?: MaxResults; + } + export interface SearchResponse { + /** + * A list of SearchResult objects. + */ + Results?: SearchResultsList; + /** + * If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. + */ + NextToken?: NextToken; + } + export type SearchResultsList = SearchRecord[]; + export type SearchSortOrder = "Ascending"|"Descending"|string; + export type SecondaryStatus = "Starting"|"LaunchingMLInstances"|"PreparingTrainingStack"|"Downloading"|"DownloadingTrainingImage"|"Training"|"Uploading"|"Stopping"|"Stopped"|"MaxRuntimeExceeded"|"Completed"|"Failed"|string; + export interface SecondaryStatusTransition { + /** + * Contains a secondary status information from a training job. Status might be one of the following secondary statuses: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage + */ + Status: SecondaryStatus; + /** + * A timestamp that shows when the training job transitioned to the current secondary status state. + */ + StartTime: Timestamp; + /** + * A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended. + */ + EndTime?: Timestamp; + /** + * A detailed description of the progress within a secondary status. Amazon SageMaker provides secondary statuses and status messages that apply to each of them: Starting Starting the training job. Launching requested ML instances. Insufficient capacity error from EC2 while launching instances, retrying! Launched instance was unhealthy, replacing it! Preparing the instances for training. Training Downloading the training image. Training image download completed. Training in progress. Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements. To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJobResponse, and StatusMessage together. For example, at the start of a training job, you might see the following: TrainingJobStatus - InProgress SecondaryStatus - Training StatusMessage - Downloading the training image + */ + StatusMessage?: StatusMessage; + } + export type SecondaryStatusTransitions = SecondaryStatusTransition[]; + export type SecretArn = string; + export type SecurityGroupId = string; + export type SecurityGroupIds = SecurityGroupId[]; + export type Seed = number; + export type SessionExpirationDurationInSeconds = number; + export interface ShuffleConfig { + /** + * Determines the shuffling order in ShuffleConfig value. + */ + Seed: Seed; + } + export type SortBy = "Name"|"CreationTime"|"Status"|string; + export type SortOrder = "Ascending"|"Descending"|string; + export interface SourceAlgorithm { + /** + * The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). + */ + ModelDataUrl?: Url; + /** + * The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. + */ + AlgorithmName: ArnOrName; + } + export type SourceAlgorithmList = SourceAlgorithm[]; + export interface SourceAlgorithmSpecification { + /** + * A list of the algorithms that were used to create a model package. + */ + SourceAlgorithms: SourceAlgorithmList; + } + export type SplitType = "None"|"Line"|"RecordIO"|"TFRecord"|string; + export interface StartNotebookInstanceInput { + /** + * The name of the notebook instance to start. + */ + NotebookInstanceName: NotebookInstanceName; + } + export type StatusMessage = string; + export interface StopCompilationJobRequest { + /** + * The name of the model compilation job to stop. + */ + CompilationJobName: EntityName; + } + export interface StopHyperParameterTuningJobRequest { + /** + * The name of the tuning job to stop. + */ + HyperParameterTuningJobName: HyperParameterTuningJobName; + } + export interface StopLabelingJobRequest { + /** + * The name of the labeling job to stop. + */ + LabelingJobName: LabelingJobName; + } + export interface StopNotebookInstanceInput { + /** + * The name of the notebook instance to terminate. + */ + NotebookInstanceName: NotebookInstanceName; + } + export interface StopTrainingJobRequest { + /** + * The name of the training job to stop. + */ + TrainingJobName: TrainingJobName; + } + export interface StopTransformJobRequest { + /** + * The name of the transform job to stop. + */ + TransformJobName: TransformJobName; + } + export interface StoppingCondition { + /** + * The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 28 days. + */ + MaxRuntimeInSeconds?: MaxRuntimeInSeconds; + } + export type String = string; + export type String200 = string; + export type SubnetId = string; + export type Subnets = SubnetId[]; + export interface SubscribedWorkteam { + /** + * The Amazon Resource Name (ARN) of the vendor that you have subscribed. + */ + WorkteamArn: WorkteamArn; + /** + * The title of the service provided by the vendor in the Amazon Marketplace. + */ + MarketplaceTitle?: String200; + /** + * The name of the vendor in the Amazon Marketplace. + */ + SellerName?: String; + /** + * The description of the vendor from the Amazon Marketplace. + */ + MarketplaceDescription?: String200; + /** + * + */ + ListingId?: String; + } + export type SubscribedWorkteams = SubscribedWorkteam[]; + export type Success = boolean; + export interface SuggestionQuery { + /** + * A type of SuggestionQuery. Defines a property name hint. Only property names that match the specified hint are included in the response. + */ + PropertyNameQuery?: PropertyNameQuery; + } + export interface Tag { + /** + * The tag key. + */ + Key: TagKey; + /** + * The tag value. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export type TagValue = string; + export type TargetDevice = "ml_m4"|"ml_m5"|"ml_c4"|"ml_c5"|"ml_p2"|"ml_p3"|"jetson_tx1"|"jetson_tx2"|"rasp3b"|"deeplens"|"rk3399"|"rk3288"|string; + export type TaskAvailabilityLifetimeInSeconds = number; + export type TaskCount = number; + export type TaskDescription = string; + export type TaskInput = string; + export type TaskKeyword = string; + export type TaskKeywords = TaskKeyword[]; + export type TaskTimeLimitInSeconds = number; + export type TaskTitle = string; + export type TemplateContent = string; + export type TenthFractionsOfACent = number; + export type Timestamp = Date; + export type TrainingInputMode = "Pipe"|"File"|string; + export type TrainingInstanceCount = number; + export type TrainingInstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|string; + export type TrainingInstanceTypes = TrainingInstanceType[]; + export interface TrainingJob { + /** + * The name of the training job. + */ + TrainingJobName?: TrainingJobName; + /** + * The Amazon Resource Name (ARN) of the training job. + */ + TrainingJobArn?: TrainingJobArn; + /** + * The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job. + */ + TuningJobArn?: HyperParameterTuningJobArn; + /** + * The Amazon Resource Name (ARN) of the labeling job. + */ + LabelingJobArn?: LabelingJobArn; + /** + * Information about the Amazon S3 location that is configured for storing model artifacts. + */ + ModelArtifacts?: ModelArtifacts; + /** + * The status of the training job. Training job statuses are: InProgress - The training is in progress. Completed - The training job has completed. Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call. Stopping - The training job is stopping. Stopped - The training job has stopped. For more detailed information, see SecondaryStatus. + */ + TrainingJobStatus?: TrainingJobStatus; + /** + * Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition. Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. Valid values for SecondaryStatus are subject to change. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage + */ + SecondaryStatus?: SecondaryStatus; + /** + * If the training job failed, the reason it failed. + */ + FailureReason?: FailureReason; + /** + * Algorithm-specific parameters. + */ + HyperParameters?: HyperParameters; + /** + * Information about the algorithm used for training, and algorithm metadata. + */ + AlgorithmSpecification?: AlgorithmSpecification; + /** + * The AWS Identity and Access Management (IAM) role configured for the training job. + */ + RoleArn?: RoleArn; + /** + * An array of Channel objects that describes each data input channel. + */ + InputDataConfig?: InputDataConfig; + /** + * The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts. + */ + OutputDataConfig?: OutputDataConfig; + /** + * Resources, including ML compute instances and ML storage volumes, that are configured for model training. + */ + ResourceConfig?: ResourceConfig; + /** + * A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud. + */ + VpcConfig?: VpcConfig; + /** + * The condition under which to stop the training job. + */ + StoppingCondition?: StoppingCondition; + /** + * A timestamp that indicates when the training job was created. + */ + CreationTime?: Timestamp; + /** + * Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container. + */ + TrainingStartTime?: Timestamp; + /** + * Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure. + */ + TrainingEndTime?: Timestamp; + /** + * A timestamp that indicates when the status of the training job was last modified. + */ + LastModifiedTime?: Timestamp; + /** + * A history of all of the secondary statuses that the training job has transitioned through. + */ + SecondaryStatusTransitions?: SecondaryStatusTransitions; + /** + * A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics. + */ + FinalMetricDataList?: FinalMetricDataList; + /** + * If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in. + */ + EnableNetworkIsolation?: Boolean; + /** + * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. + */ + EnableInterContainerTrafficEncryption?: Boolean; + /** + * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. + */ + Tags?: TagList; + } + export type TrainingJobArn = string; + export interface TrainingJobDefinition { + /** + * The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container. + */ + TrainingInputMode: TrainingInputMode; + /** + * The hyperparameters used for the training job. + */ + HyperParameters?: HyperParameters; + /** + * An array of Channel objects, each of which specifies an input source. + */ + InputDataConfig: InputDataConfig; + /** + * the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts. + */ + OutputDataConfig: OutputDataConfig; + /** + * The resources, including the ML compute instances and ML storage volumes, to use for model training. + */ + ResourceConfig: ResourceConfig; + /** + * Sets a duration for training. Use this parameter to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts. + */ + StoppingCondition: StoppingCondition; + } + export type TrainingJobEarlyStoppingType = "Off"|"Auto"|string; + export type TrainingJobName = string; + export type TrainingJobSortByOptions = "Name"|"CreationTime"|"Status"|"FinalObjectiveMetricValue"|string; + export type TrainingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string; + export type TrainingJobStatusCounter = number; + export interface TrainingJobStatusCounters { + /** + * The number of completed training jobs launched by the hyperparameter tuning job. + */ + Completed?: TrainingJobStatusCounter; + /** + * The number of in-progress training jobs launched by a hyperparameter tuning job. + */ + InProgress?: TrainingJobStatusCounter; + /** + * The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred. + */ + RetryableError?: TrainingJobStatusCounter; + /** + * The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred. + */ + NonRetryableError?: TrainingJobStatusCounter; + /** + * The number of training jobs launched by a hyperparameter tuning job that were manually stopped. + */ + Stopped?: TrainingJobStatusCounter; + } + export type TrainingJobSummaries = TrainingJobSummary[]; + export interface TrainingJobSummary { + /** + * The name of the training job that you want a summary for. + */ + TrainingJobName: TrainingJobName; + /** + * The Amazon Resource Name (ARN) of the training job. + */ + TrainingJobArn: TrainingJobArn; + /** + * A timestamp that shows when the training job was created. + */ + CreationTime: Timestamp; + /** + * A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped). + */ + TrainingEndTime?: Timestamp; + /** + * Timestamp when the training job was last modified. + */ + LastModifiedTime?: Timestamp; + /** + * The status of the training job. + */ + TrainingJobStatus: TrainingJobStatus; + } + export interface TrainingSpecification { + /** + * The Amazon ECR registry path of the Docker image that contains the training algorithm. + */ + TrainingImage: Image; + /** + * An MD5 hash of the training algorithm that identifies the Docker image used for training. + */ + TrainingImageDigest?: ImageDigest; + /** + * A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.> + */ + SupportedHyperParameters?: HyperParameterSpecifications; + /** + * A list of the instance types that this algorithm can use for training. + */ + SupportedTrainingInstanceTypes: TrainingInstanceTypes; + /** + * Indicates whether the algorithm supports distributed training. If set to false, buyers can’t request more than one instance during training. + */ + SupportsDistributedTraining?: Boolean; + /** + * A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm. + */ + MetricDefinitions?: MetricDefinitionList; + /** + * A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm. + */ + TrainingChannels: ChannelSpecifications; + /** + * A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job. + */ + SupportedTuningJobObjectiveMetrics?: HyperParameterTuningJobObjectives; + } + export interface TransformDataSource { + /** + * The S3 location of the data source that is associated with a channel. + */ + S3DataSource: TransformS3DataSource; + } + export type TransformEnvironmentKey = string; + export type TransformEnvironmentMap = {[key: string]: TransformEnvironmentValue}; + export type TransformEnvironmentValue = string; + export interface TransformInput { + /** + * Describes the location of the channel data, which is, the S3 location of the input data that the model can consume. + */ + DataSource: TransformDataSource; + /** + * The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job. + */ + ContentType?: ContentType; + /** + * If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None. + */ + CompressionType?: CompressionType; + /** + * The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request. Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation. + */ + SplitType?: SplitType; + } + export type TransformInstanceCount = number; + export type TransformInstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|string; + export type TransformInstanceTypes = TransformInstanceType[]; + export type TransformJobArn = string; + export interface TransformJobDefinition { + /** + * The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1. + */ + MaxConcurrentTransforms?: MaxConcurrentTransforms; + /** + * The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). + */ + MaxPayloadInMB?: MaxPayloadInMB; + /** + * A string that determines the number of records included in a single mini-batch. SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit. + */ + BatchStrategy?: BatchStrategy; + /** + * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. + */ + Environment?: TransformEnvironmentMap; + /** + * A description of the input source and the way the transform job consumes it. + */ + TransformInput: TransformInput; + /** + * Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. + */ + TransformOutput: TransformOutput; + /** + * Identifies the ML compute instances for the transform job. + */ + TransformResources: TransformResources; + } + export type TransformJobName = string; + export type TransformJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string; + export type TransformJobSummaries = TransformJobSummary[]; + export interface TransformJobSummary { + /** + * The name of the transform job. + */ + TransformJobName: TransformJobName; + /** + * The Amazon Resource Name (ARN) of the transform job. + */ + TransformJobArn: TransformJobArn; + /** + * A timestamp that shows when the transform Job was created. + */ + CreationTime: Timestamp; + /** + * Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed. + */ + TransformEndTime?: Timestamp; + /** + * Indicates when the transform job was last modified. + */ + LastModifiedTime?: Timestamp; + /** + * The status of the transform job. + */ + TransformJobStatus: TransformJobStatus; + /** + * If the transform job failed, the reason it failed. + */ + FailureReason?: FailureReason; + } + export interface TransformOutput { + /** + * The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix. For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation. + */ + S3OutputPath: S3Uri; + /** + * The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job. + */ + Accept?: Accept; + /** + * Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line. + */ + AssembleWith?: AssemblyType; + /** + * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide. + */ + KmsKeyId?: KmsKeyId; + } + export interface TransformResources { + /** + * The ML compute instance type for the transform job. For using built-in algorithms to transform moderately sized datasets, ml.m4.xlarge or ml.m5.large should suffice. There is no default value for InstanceType. + */ + InstanceType: TransformInstanceType; + /** + * The number of ML compute instances to use in the transform job. For distributed transform, provide a value greater than 1. The default value is 1. + */ + InstanceCount: TransformInstanceCount; + /** + * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + */ + VolumeKmsKeyId?: KmsKeyId; + } + export interface TransformS3DataSource { + /** + * If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform. + */ + S3DataType: S3DataType; + /** + * Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example: A key name prefix might look like this: s3://bucketname/exampleprefix. A manifest might look like this: s3://bucketname/example.manifest The manifest is an S3 object which is a JSON file with the following format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... ] The preceding JSON matches the following S3Uris: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-1 ... The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf. + */ + S3Uri: S3Uri; + } + export interface USD { + /** + * The whole number of dollars in the amount. + */ + Dollars?: Dollars; + /** + * The fractional portion, in cents, of the amount. + */ + Cents?: Cents; + /** + * Fractions of a cent, in tenths. + */ + TenthFractionsOfACent?: TenthFractionsOfACent; + } + export interface UiConfig { + /** + * The Amazon S3 bucket location of the UI template. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template. + */ + UiTemplateS3Uri: S3Uri; + } + export interface UiTemplate { + /** + * The content of the Liquid template for the worker user interface. + */ + Content: TemplateContent; + } + export interface UpdateCodeRepositoryInput { + /** + * The name of the Git repository to update. + */ + CodeRepositoryName: EntityName; + /** + * The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format: {"username": UserName, "password": Password} + */ + GitConfig?: GitConfigForUpdate; + } + export interface UpdateCodeRepositoryOutput { + /** + * The ARN of the Git repository. + */ + CodeRepositoryArn: CodeRepositoryArn; + } + export interface UpdateEndpointInput { + /** + * The name of the endpoint whose configuration you want to update. + */ + EndpointName: EndpointName; + /** + * The name of the new endpoint configuration. + */ + EndpointConfigName: EndpointConfigName; + } + export interface UpdateEndpointOutput { + /** + * The Amazon Resource Name (ARN) of the endpoint. + */ + EndpointArn: EndpointArn; + } + export interface UpdateEndpointWeightsAndCapacitiesInput { + /** + * The name of an existing Amazon SageMaker endpoint. + */ + EndpointName: EndpointName; + /** + * An object that provides new capacity and weight values for a variant. + */ + DesiredWeightsAndCapacities: DesiredWeightAndCapacityList; + } + export interface UpdateEndpointWeightsAndCapacitiesOutput { + /** + * The Amazon Resource Name (ARN) of the updated endpoint. + */ + EndpointArn: EndpointArn; + } + export interface UpdateNotebookInstanceInput { + /** + * The name of the notebook instance to update. + */ + NotebookInstanceName: NotebookInstanceName; + /** + * The Amazon ML compute instance type. + */ + InstanceType?: InstanceType; + /** + * The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. + */ + RoleArn?: RoleArn; + /** + * The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. + */ + LifecycleConfigName?: NotebookInstanceLifecycleConfigName; + /** + * Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. + */ + DisassociateLifecycleConfig?: DisassociateNotebookInstanceLifecycleConfig; + /** + * The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. + */ + VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB; + /** + * The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + DefaultCodeRepository?: CodeRepositoryNameOrUrl; + /** + * An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances. + */ + AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls; + /** + * A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker. + */ + AcceleratorTypes?: NotebookInstanceAcceleratorTypes; + /** + * A list of the Elastic Inference (EI) instance types to remove from this notebook instance. + */ + DisassociateAcceleratorTypes?: DisassociateNotebookInstanceAcceleratorTypes; + /** + * The name or URL of the default Git repository to remove from this notebook instance. + */ + DisassociateDefaultCodeRepository?: DisassociateDefaultCodeRepository; + /** + * A list of names or URLs of the default Git repositories to remove from this notebook instance. + */ + DisassociateAdditionalCodeRepositories?: DisassociateAdditionalCodeRepositories; + /** + * Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions. + */ + RootAccess?: RootAccess; + } + export interface UpdateNotebookInstanceLifecycleConfigInput { + /** + * The name of the lifecycle configuration. + */ + NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName; + /** + * The shell script that runs only once, when you create a notebook instance + */ + OnCreate?: NotebookInstanceLifecycleConfigList; + /** + * The shell script that runs every time you start a notebook instance, including when you create the notebook instance. + */ + OnStart?: NotebookInstanceLifecycleConfigList; + } + export interface UpdateNotebookInstanceLifecycleConfigOutput { + } + export interface UpdateNotebookInstanceOutput { + } + export interface UpdateWorkteamRequest { + /** + * The name of the work team to update. + */ + WorkteamName: WorkteamName; + /** + * A list of MemberDefinition objects that contain the updated work team members. + */ + MemberDefinitions?: MemberDefinitions; + /** + * An updated description for the work team. + */ + Description?: String200; + } + export interface UpdateWorkteamResponse { + /** + * A Workteam object that describes the updated work team. + */ + Workteam: Workteam; + } + export type Url = string; + export type VariantName = string; + export type VariantWeight = number; + export type VolumeSizeInGB = number; + export interface VpcConfig { + /** + * The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field. + */ + SecurityGroupIds: VpcSecurityGroupIds; + /** + * The ID of the subnets in the VPC to which you want to connect your training job or model. + */ + Subnets: Subnets; + } + export type VpcSecurityGroupIds = SecurityGroupId[]; + export interface Workteam { + /** + * The name of the work team. + */ + WorkteamName: WorkteamName; + /** + * The Amazon Cognito user groups that make up the work team. + */ + MemberDefinitions: MemberDefinitions; + /** + * The Amazon Resource Name (ARN) that identifies the work team. + */ + WorkteamArn: WorkteamArn; + /** + * The Amazon Marketplace identifier for a vendor's work team. + */ + ProductListingIds?: ProductListings; + /** + * A description of the work team. + */ + Description: String200; + /** + * The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects. + */ + SubDomain?: String; + /** + * The date and time that the work team was created (timestamp). + */ + CreateDate?: Timestamp; + /** + * The date and time that the work team was last updated (timestamp). + */ + LastUpdatedDate?: Timestamp; + } + export type WorkteamArn = string; + export type WorkteamName = string; + export type Workteams = Workteam[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-07-24"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SageMaker client. + */ + export import Types = SageMaker; +} +export = SageMaker; diff --git a/node_modules/aws-sdk/clients/sagemaker.js b/node_modules/aws-sdk/clients/sagemaker.js new file mode 100644 index 0000000..4fbf270 --- /dev/null +++ b/node_modules/aws-sdk/clients/sagemaker.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['sagemaker'] = {}; +AWS.SageMaker = Service.defineService('sagemaker', ['2017-07-24']); +Object.defineProperty(apiLoader.services['sagemaker'], '2017-07-24', { + get: function get() { + var model = require('../apis/sagemaker-2017-07-24.min.json'); + model.paginators = require('../apis/sagemaker-2017-07-24.paginators.json').pagination; + model.waiters = require('../apis/sagemaker-2017-07-24.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SageMaker; diff --git a/node_modules/aws-sdk/clients/sagemakerruntime.d.ts b/node_modules/aws-sdk/clients/sagemakerruntime.d.ts new file mode 100644 index 0000000..45dc81a --- /dev/null +++ b/node_modules/aws-sdk/clients/sagemakerruntime.d.ts @@ -0,0 +1,84 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SageMakerRuntime extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SageMakerRuntime.Types.ClientConfiguration) + config: Config & SageMakerRuntime.Types.ClientConfiguration; + /** + * After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint. For an overview of Amazon SageMaker, see How It Works. Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Cals to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference. Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller. + */ + invokeEndpoint(params: SageMakerRuntime.Types.InvokeEndpointInput, callback?: (err: AWSError, data: SageMakerRuntime.Types.InvokeEndpointOutput) => void): Request; + /** + * After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint. For an overview of Amazon SageMaker, see How It Works. Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Cals to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference. Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller. + */ + invokeEndpoint(callback?: (err: AWSError, data: SageMakerRuntime.Types.InvokeEndpointOutput) => void): Request; +} +declare namespace SageMakerRuntime { + export type BodyBlob = Buffer|Uint8Array|Blob|string; + export type CustomAttributesHeader = string; + export type EndpointName = string; + export type Header = string; + export interface InvokeEndpointInput { + /** + * The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API. + */ + EndpointName: EndpointName; + /** + * Provides input data, in the format specified in the ContentType request header. Amazon SageMaker passes all of the data in the body to the model. For information about the format of the request body, see Common Data Formats—Inference. + */ + Body: BodyBlob; + /** + * The MIME type of the input data in the request body. + */ + ContentType?: Header; + /** + * The desired MIME type of the inference in the response. + */ + Accept?: Header; + /** + * + */ + CustomAttributes?: CustomAttributesHeader; + } + export interface InvokeEndpointOutput { + /** + * Includes the inference provided by the model. For information about the format of the response body, see Common Data Formats—Inference. + */ + Body: BodyBlob; + /** + * The MIME type of the inference returned in the response body. + */ + ContentType?: Header; + /** + * Identifies the production variant that was invoked. + */ + InvokedProductionVariant?: Header; + /** + * + */ + CustomAttributes?: CustomAttributesHeader; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-05-13"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SageMakerRuntime client. + */ + export import Types = SageMakerRuntime; +} +export = SageMakerRuntime; diff --git a/node_modules/aws-sdk/clients/sagemakerruntime.js b/node_modules/aws-sdk/clients/sagemakerruntime.js new file mode 100644 index 0000000..1a2f4b9 --- /dev/null +++ b/node_modules/aws-sdk/clients/sagemakerruntime.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['sagemakerruntime'] = {}; +AWS.SageMakerRuntime = Service.defineService('sagemakerruntime', ['2017-05-13']); +Object.defineProperty(apiLoader.services['sagemakerruntime'], '2017-05-13', { + get: function get() { + var model = require('../apis/runtime.sagemaker-2017-05-13.min.json'); + model.paginators = require('../apis/runtime.sagemaker-2017-05-13.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SageMakerRuntime; diff --git a/node_modules/aws-sdk/clients/secretsmanager.d.ts b/node_modules/aws-sdk/clients/secretsmanager.d.ts new file mode 100644 index 0000000..e4b6797 --- /dev/null +++ b/node_modules/aws-sdk/clients/secretsmanager.d.ts @@ -0,0 +1,830 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SecretsManager extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SecretsManager.Types.ClientConfiguration) + config: Config & SecretsManager.Types.ClientConfiguration; + /** + * Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress. To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule. If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field. To successfully start a rotation, the staging label AWSPENDING must be in one of the following states: Not be attached to any version at all Attached to the same version as the staging label AWSCURRENT If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails. Minimum permissions To run this command, you must have the following permissions: secretsmanager:CancelRotateSecret Related operations To configure rotation for a secret or to manually trigger a rotation, use RotateSecret. To get the rotation configuration details for a secret, use DescribeSecret. To list all of the currently available secrets, use ListSecrets. To list all of the versions currently associated with a secret, use ListSecretVersionIds. + */ + cancelRotateSecret(params: SecretsManager.Types.CancelRotateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.CancelRotateSecretResponse) => void): Request; + /** + * Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress. To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule. If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field. To successfully start a rotation, the staging label AWSPENDING must be in one of the following states: Not be attached to any version at all Attached to the same version as the staging label AWSCURRENT If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails. Minimum permissions To run this command, you must have the following permissions: secretsmanager:CancelRotateSecret Related operations To configure rotation for a secret or to manually trigger a rotation, use RotateSecret. To get the rotation configuration details for a secret, use DescribeSecret. To list all of the currently available secrets, use ListSecrets. To list all of the versions currently associated with a secret, use ListSecretVersionIds. + */ + cancelRotateSecret(callback?: (err: AWSError, data: SecretsManager.Types.CancelRotateSecretResponse) => void): Request; + /** + * Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret. Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more "staging labels" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list. You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version. If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result. If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations. Minimum permissions To run this command, you must have the following permissions: secretsmanager:CreateSecret kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. secretsmanager:TagResource - needed only if you include the Tags parameter. Related operations To delete a secret, use DeleteSecret. To modify an existing secret, use UpdateSecret. To create a new version of a secret, use PutSecretValue. To retrieve the encrypted secure string and secure binary values, use GetSecretValue. To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values. To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value. + */ + createSecret(params: SecretsManager.Types.CreateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.CreateSecretResponse) => void): Request; + /** + * Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret. Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more "staging labels" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list. You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version. If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result. If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations. Minimum permissions To run this command, you must have the following permissions: secretsmanager:CreateSecret kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. secretsmanager:TagResource - needed only if you include the Tags parameter. Related operations To delete a secret, use DeleteSecret. To modify an existing secret, use UpdateSecret. To create a new version of a secret, use PutSecretValue. To retrieve the encrypted secure string and secure binary values, use GetSecretValue. To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values. To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value. + */ + createSecret(callback?: (err: AWSError, data: SecretsManager.Types.CreateSecretResponse) => void): Request; + /** + * Deletes the resource-based permission policy that's attached to the secret. Minimum permissions To run this command, you must have the following permissions: secretsmanager:DeleteResourcePolicy Related operations To attach a resource policy to a secret, use PutResourcePolicy. To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy. To list all of the currently available secrets, use ListSecrets. + */ + deleteResourcePolicy(params: SecretsManager.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: SecretsManager.Types.DeleteResourcePolicyResponse) => void): Request; + /** + * Deletes the resource-based permission policy that's attached to the secret. Minimum permissions To run this command, you must have the following permissions: secretsmanager:DeleteResourcePolicy Related operations To attach a resource policy to a secret, use PutResourcePolicy. To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy. To list all of the currently available secrets, use ListSecrets. + */ + deleteResourcePolicy(callback?: (err: AWSError, data: SecretsManager.Types.DeleteResourcePolicyResponse) => void): Request; + /** + * Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently. At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret. You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information. There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated. The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur. Minimum permissions To run this command, you must have the following permissions: secretsmanager:DeleteSecret Related operations To create a secret, use CreateSecret. To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret. + */ + deleteSecret(params: SecretsManager.Types.DeleteSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.DeleteSecretResponse) => void): Request; + /** + * Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently. At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret. You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information. There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated. The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur. Minimum permissions To run this command, you must have the following permissions: secretsmanager:DeleteSecret Related operations To create a secret, use CreateSecret. To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret. + */ + deleteSecret(callback?: (err: AWSError, data: SecretsManager.Types.DeleteSecretResponse) => void): Request; + /** + * Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response. Minimum permissions To run this command, you must have the following permissions: secretsmanager:DescribeSecret Related operations To create a secret, use CreateSecret. To modify a secret, use UpdateSecret. To retrieve the encrypted secret information in a version of the secret, use GetSecretValue. To list all of the secrets in the AWS account, use ListSecrets. + */ + describeSecret(params: SecretsManager.Types.DescribeSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.DescribeSecretResponse) => void): Request; + /** + * Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response. Minimum permissions To run this command, you must have the following permissions: secretsmanager:DescribeSecret Related operations To create a secret, use CreateSecret. To modify a secret, use UpdateSecret. To retrieve the encrypted secret information in a version of the secret, use GetSecretValue. To list all of the secrets in the AWS account, use ListSecrets. + */ + describeSecret(callback?: (err: AWSError, data: SecretsManager.Types.DescribeSecretResponse) => void): Request; + /** + * Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Minimum permissions To run this command, you must have the following permissions: secretsmanager:GetRandomPassword + */ + getRandomPassword(params: SecretsManager.Types.GetRandomPasswordRequest, callback?: (err: AWSError, data: SecretsManager.Types.GetRandomPasswordResponse) => void): Request; + /** + * Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Minimum permissions To run this command, you must have the following permissions: secretsmanager:GetRandomPassword + */ + getRandomPassword(callback?: (err: AWSError, data: SecretsManager.Types.GetRandomPasswordResponse) => void): Request; + /** + * Retrieves the JSON text of the resource-based policy document that's attached to the specified secret. The JSON request string input and response output are shown formatted with white space and line breaks for better readability. Submit your input as a single line JSON string. Minimum permissions To run this command, you must have the following permissions: secretsmanager:GetResourcePolicy Related operations To attach a resource policy to a secret, use PutResourcePolicy. To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy. To list all of the currently available secrets, use ListSecrets. + */ + getResourcePolicy(params: SecretsManager.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: SecretsManager.Types.GetResourcePolicyResponse) => void): Request; + /** + * Retrieves the JSON text of the resource-based policy document that's attached to the specified secret. The JSON request string input and response output are shown formatted with white space and line breaks for better readability. Submit your input as a single line JSON string. Minimum permissions To run this command, you must have the following permissions: secretsmanager:GetResourcePolicy Related operations To attach a resource policy to a secret, use PutResourcePolicy. To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy. To list all of the currently available secrets, use ListSecrets. + */ + getResourcePolicy(callback?: (err: AWSError, data: SecretsManager.Types.GetResourcePolicyResponse) => void): Request; + /** + * Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. Minimum permissions To run this command, you must have the following permissions: secretsmanager:GetSecretValue kms:Decrypt - required only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. Related operations To create a new version of the secret with different encrypted information, use PutSecretValue. To retrieve the non-encrypted details for the secret, use DescribeSecret. + */ + getSecretValue(params: SecretsManager.Types.GetSecretValueRequest, callback?: (err: AWSError, data: SecretsManager.Types.GetSecretValueResponse) => void): Request; + /** + * Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. Minimum permissions To run this command, you must have the following permissions: secretsmanager:GetSecretValue kms:Decrypt - required only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. Related operations To create a new version of the secret with different encrypted information, use PutSecretValue. To retrieve the non-encrypted details for the secret, use DescribeSecret. + */ + getSecretValue(callback?: (err: AWSError, data: SecretsManager.Types.GetSecretValueResponse) => void): Request; + /** + * Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached. Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list. Minimum permissions To run this command, you must have the following permissions: secretsmanager:ListSecretVersionIds Related operations To list the secrets in an account, use ListSecrets. + */ + listSecretVersionIds(params: SecretsManager.Types.ListSecretVersionIdsRequest, callback?: (err: AWSError, data: SecretsManager.Types.ListSecretVersionIdsResponse) => void): Request; + /** + * Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached. Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list. Minimum permissions To run this command, you must have the following permissions: secretsmanager:ListSecretVersionIds Related operations To list the secrets in an account, use ListSecrets. + */ + listSecretVersionIds(callback?: (err: AWSError, data: SecretsManager.Types.ListSecretVersionIdsResponse) => void): Request; + /** + * Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation. Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list. Minimum permissions To run this command, you must have the following permissions: secretsmanager:ListSecrets Related operations To list the versions attached to a secret, use ListSecretVersionIds. + */ + listSecrets(params: SecretsManager.Types.ListSecretsRequest, callback?: (err: AWSError, data: SecretsManager.Types.ListSecretsResponse) => void): Request; + /** + * Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation. Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list. Minimum permissions To run this command, you must have the following permissions: secretsmanager:ListSecrets Related operations To list the versions attached to a secret, use ListSecretVersionIds. + */ + listSecrets(callback?: (err: AWSError, data: SecretsManager.Types.ListSecretsResponse) => void): Request; + /** + * Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide. Minimum permissions To run this command, you must have the following permissions: secretsmanager:PutResourcePolicy Related operations To retrieve the resource policy that's attached to a secret, use GetResourcePolicy. To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy. To list all of the currently available secrets, use ListSecrets. + */ + putResourcePolicy(params: SecretsManager.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: SecretsManager.Types.PutResourcePolicyResponse) => void): Request; + /** + * Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide. Minimum permissions To run this command, you must have the following permissions: secretsmanager:PutResourcePolicy Related operations To retrieve the resource policy that's attached to a secret, use GetResourcePolicy. To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy. To list all of the currently available secrets, use ListSecrets. + */ + putResourcePolicy(callback?: (err: AWSError, data: SecretsManager.Types.PutResourcePolicyResponse) => void): Request; + /** + * Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version. The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs. If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version. If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter. If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones. If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result. If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations. Minimum permissions To run this command, you must have the following permissions: secretsmanager:PutSecretValue kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. Related operations To retrieve the encrypted value you store in the version of a secret, use GetSecretValue. To create a secret, use CreateSecret. To get the details for a secret, use DescribeSecret. To list the versions attached to a secret, use ListSecretVersionIds. + */ + putSecretValue(params: SecretsManager.Types.PutSecretValueRequest, callback?: (err: AWSError, data: SecretsManager.Types.PutSecretValueResponse) => void): Request; + /** + * Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version. The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs. If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version. If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter. If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones. If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result. If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations. Minimum permissions To run this command, you must have the following permissions: secretsmanager:PutSecretValue kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager. Related operations To retrieve the encrypted value you store in the version of a secret, use GetSecretValue. To create a secret, use CreateSecret. To get the details for a secret, use DescribeSecret. To list the versions attached to a secret, use ListSecretVersionIds. + */ + putSecretValue(callback?: (err: AWSError, data: SecretsManager.Types.PutSecretValueResponse) => void): Request; + /** + * Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again. Minimum permissions To run this command, you must have the following permissions: secretsmanager:RestoreSecret Related operations To delete a secret, use DeleteSecret. + */ + restoreSecret(params: SecretsManager.Types.RestoreSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.RestoreSecretResponse) => void): Request; + /** + * Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again. Minimum permissions To run this command, you must have the following permissions: secretsmanager:RestoreSecret Related operations To delete a secret, use DeleteSecret. + */ + restoreSecret(callback?: (err: AWSError, data: SecretsManager.Types.RestoreSecretResponse) => void): Request; + /** + * Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret. This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide. Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load. The rotation function must end with the versions of the secret in one of two states: The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or The AWSPENDING staging label is not attached to any version of the secret. If instead the AWSPENDING staging label is present but is not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. Minimum permissions To run this command, you must have the following permissions: secretsmanager:RotateSecret lambda:InvokeFunction (on the function specified in the secret's metadata) Related operations To list the secrets in your account, use ListSecrets. To get the details for a version of a secret, use DescribeSecret. To create a new version of a secret, use CreateSecret. To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage. + */ + rotateSecret(params: SecretsManager.Types.RotateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.RotateSecretResponse) => void): Request; + /** + * Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret. This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide. Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load. The rotation function must end with the versions of the secret in one of two states: The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or The AWSPENDING staging label is not attached to any version of the secret. If instead the AWSPENDING staging label is present but is not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. Minimum permissions To run this command, you must have the following permissions: secretsmanager:RotateSecret lambda:InvokeFunction (on the function specified in the secret's metadata) Related operations To list the secrets in your account, use ListSecrets. To get the details for a version of a secret, use DescribeSecret. To create a new version of a secret, use CreateSecret. To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage. + */ + rotateSecret(callback?: (err: AWSError, data: SecretsManager.Types.RotateSecretResponse) => void): Request; + /** + * Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource. The following basic restrictions apply to tags: Maximum number of tags per secret—50 Maximum key length—127 Unicode characters in UTF-8 Maximum value length—255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error. Minimum permissions To run this command, you must have the following permissions: secretsmanager:TagResource Related operations To remove one or more tags from the collection attached to a secret, use UntagResource. To view the list of tags attached to a secret, use DescribeSecret. + */ + tagResource(params: SecretsManager.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource. The following basic restrictions apply to tags: Maximum number of tags per secret—50 Maximum key length—127 Unicode characters in UTF-8 Maximum value length—255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error. Minimum permissions To run this command, you must have the following permissions: secretsmanager:TagResource Related operations To remove one or more tags from the collection attached to a secret, use UntagResource. To view the list of tags attached to a secret, use DescribeSecret. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes one or more tags from the specified secret. This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged. If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error. Minimum permissions To run this command, you must have the following permissions: secretsmanager:UntagResource Related operations To add one or more tags to the collection attached to a secret, use TagResource. To view the list of tags attached to a secret, use DescribeSecret. + */ + untagResource(params: SecretsManager.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes one or more tags from the specified secret. This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged. If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error. Minimum permissions To run this command, you must have the following permissions: secretsmanager:UntagResource Related operations To add one or more tags to the collection attached to a secret, use TagResource. To view the list of tags attached to a secret, use DescribeSecret. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies many of the details of the specified secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret. To modify the rotation configuration of a secret, use RotateSecret instead. The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version. If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version. If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result. If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations. Minimum permissions To run this command, you must have the following permissions: secretsmanager:UpdateSecret kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager. kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager. Related operations To create a new secret, use CreateSecret. To add only a new version to an existing secret, use PutSecretValue. To get the details for a secret, use DescribeSecret. To list the versions contained in a secret, use ListSecretVersionIds. + */ + updateSecret(params: SecretsManager.Types.UpdateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretResponse) => void): Request; + /** + * Modifies many of the details of the specified secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret. To modify the rotation configuration of a secret, use RotateSecret instead. The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version. If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version. If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result. If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations. Minimum permissions To run this command, you must have the following permissions: secretsmanager:UpdateSecret kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager. kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager. Related operations To create a new secret, use CreateSecret. To add only a new version to an existing secret, use PutSecretValue. To get the details for a secret, use DescribeSecret. To list the versions contained in a secret, use ListSecretVersionIds. + */ + updateSecret(callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretResponse) => void): Request; + /** + * Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide. The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it. You can move the AWSCURRENT staging label to this version by including it in this call. Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from. If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager. Minimum permissions To run this command, you must have the following permissions: secretsmanager:UpdateSecretVersionStage Related operations To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value. + */ + updateSecretVersionStage(params: SecretsManager.Types.UpdateSecretVersionStageRequest, callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretVersionStageResponse) => void): Request; + /** + * Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide. The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it. You can move the AWSCURRENT staging label to this version by including it in this call. Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from. If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager. Minimum permissions To run this command, you must have the following permissions: secretsmanager:UpdateSecretVersionStage Related operations To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value. + */ + updateSecretVersionStage(callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretVersionStageResponse) => void): Request; +} +declare namespace SecretsManager { + export type AutomaticallyRotateAfterDaysType = number; + export type BooleanType = boolean; + export interface CancelRotateSecretRequest { + /** + * Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + } + export interface CancelRotateSecretResponse { + /** + * The ARN of the secret for which rotation was canceled. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret for which rotation was canceled. + */ + Name?: SecretNameType; + /** + * The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations. + */ + VersionId?: SecretVersionIdType; + } + export type ClientRequestTokenType = string; + export interface CreateSecretRequest { + /** + * Specifies the friendly name of the new secret. The secret name must be ASCII letters, digits, or the following characters : /_+=.@- Don't end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. This is because Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN. + */ + Name: NameType; + /** + * (Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include that value in the request. This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret. If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created. If a version with this value already exists and that version's SecretString and SecretBinary values are the same as those in the request, then the request is ignored (the operation is idempotent). If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version. This value becomes the VersionId of the new version. + */ + ClientRequestToken?: ClientRequestTokenType; + /** + * (Optional) Specifies a user-provided description of the secret. + */ + Description?: DescriptionType; + /** + * (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret. You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields. You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field. + */ + KmsKeyId?: KmsKeyIdType; + /** + * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs. + */ + SecretBinary?: SecretBinaryType; + /** + * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example: [{"username":"bob"},{"password":"abc123xyz456"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. + */ + SecretString?: SecretStringType; + /** + * (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource. Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc". If you check tags in IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error. This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example: [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following basic restrictions apply to tags: Maximum number of tags per secret—50 Maximum key length—127 Unicode characters in UTF-8 Maximum value length—255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. + */ + Tags?: TagListType; + } + export interface CreateSecretResponse { + /** + * The Amazon Resource Name (ARN) of the secret that you just created. Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret that you just created. + */ + Name?: SecretNameType; + /** + * The unique identifier that's associated with the version of the secret you just created. + */ + VersionId?: SecretVersionIdType; + } + export type CreatedDateType = Date; + export interface DeleteResourcePolicyRequest { + /** + * Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + } + export interface DeleteResourcePolicyResponse { + /** + * The ARN of the secret that the resource-based policy was deleted for. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret that the resource-based policy was deleted for. + */ + Name?: NameType; + } + export interface DeleteSecretRequest { + /** + * Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * (Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call. This value can range from 7 to 30 days. The default value is 30. + */ + RecoveryWindowInDays?: RecoveryWindowInDaysType; + /** + * (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic. Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. It is permanently lost. + */ + ForceDeleteWithoutRecovery?: BooleanType; + } + export interface DeleteSecretResponse { + /** + * The ARN of the secret that is now scheduled for deletion. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret that is now scheduled for deletion. + */ + Name?: SecretNameType; + /** + * The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays. + */ + DeletionDate?: DeletionDateType; + } + export type DeletedDateType = Date; + export type DeletionDateType = Date; + export interface DescribeSecretRequest { + /** + * The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + } + export interface DescribeSecretResponse { + /** + * The ARN of the secret. + */ + ARN?: SecretARNType; + /** + * The user-provided friendly name of the secret. + */ + Name?: SecretNameType; + /** + * The user-provided description of the secret. + */ + Description?: DescriptionType; + /** + * The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString or SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default AWS KMS CMK (the one named awssecretsmanager) for this account. + */ + KmsKeyId?: KmsKeyIdType; + /** + * Specifies whether automatic rotation is enabled for this secret. To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. To disable rotation, use CancelRotateSecret. + */ + RotationEnabled?: RotationEnabledType; + /** + * The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret. + */ + RotationLambdaARN?: RotationLambdaARNType; + /** + * A structure that contains the rotation configuration for this secret. + */ + RotationRules?: RotationRulesType; + /** + * The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated. + */ + LastRotatedDate?: LastRotatedDateType; + /** + * The last date and time that this secret was modified in any way. + */ + LastChangedDate?: LastChangedDateType; + /** + * The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time. + */ + LastAccessedDate?: LastAccessedDateType; + /** + * This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions. If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + */ + DeletedDate?: DeletedDateType; + /** + * The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource. + */ + Tags?: TagListType; + /** + * A list of all of the currently assigned VersionStage staging labels and the VersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list. + */ + VersionIdsToStages?: SecretVersionsToStagesMapType; + } + export type DescriptionType = string; + export type ExcludeCharactersType = string; + export type ExcludeLowercaseType = boolean; + export type ExcludeNumbersType = boolean; + export type ExcludePunctuationType = boolean; + export type ExcludeUppercaseType = boolean; + export interface GetRandomPasswordRequest { + /** + * The desired length of the generated password. The default value if you do not include this parameter is 32 characters. + */ + PasswordLength?: PasswordLengthType; + /** + * A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. + */ + ExcludeCharacters?: ExcludeCharactersType; + /** + * Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included. + */ + ExcludeNumbers?: ExcludeNumbersType; + /** + * Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included. The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ + */ + ExcludePunctuation?: ExcludePunctuationType; + /** + * Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included. + */ + ExcludeUppercase?: ExcludeUppercaseType; + /** + * Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included. + */ + ExcludeLowercase?: ExcludeLowercaseType; + /** + * Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included. + */ + IncludeSpace?: IncludeSpaceType; + /** + * A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type. + */ + RequireEachIncludedType?: RequireEachIncludedTypeType; + } + export interface GetRandomPasswordResponse { + /** + * A string with the generated password. + */ + RandomPassword?: RandomPasswordType; + } + export interface GetResourcePolicyRequest { + /** + * Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + } + export interface GetResourcePolicyResponse { + /** + * The ARN of the secret that the resource-based policy was retrieved for. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret that the resource-based policy was retrieved for. + */ + Name?: NameType; + /** + * A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for AWS Secrets Manager in the AWS Secrets Manager User Guide. + */ + ResourcePolicy?: NonEmptyResourcePolicyType; + } + export interface GetSecretValueRequest { + /** + * Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits. + */ + VersionId?: SecretVersionIdType; + /** + * Specifies the secret version that you want to retrieve by the staging label attached to the version. Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. + */ + VersionStage?: SecretVersionStageType; + } + export interface GetSecretValueResponse { + /** + * The ARN of the secret. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret. + */ + Name?: SecretNameType; + /** + * The unique identifier of this version of the secret. + */ + VersionId?: SecretVersionIdType; + /** + * The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string. This parameter is not used if the secret is created by the Secrets Manager console. If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields. + */ + SecretBinary?: SecretBinaryType; + /** + * The decrypted part of the protected secret information that was originally provided as a string. If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse. If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values. + */ + SecretString?: SecretStringType; + /** + * A list of all of the staging labels currently attached to this version of the secret. + */ + VersionStages?: SecretVersionStagesType; + /** + * The date and time that this version of the secret was created. + */ + CreatedDate?: CreatedDateType; + } + export type IncludeSpaceType = boolean; + export type KmsKeyIdType = string; + export type LastAccessedDateType = Date; + export type LastChangedDateType = Date; + export type LastRotatedDateType = Date; + export interface ListSecretVersionIdsRequest { + /** + * The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResultsType; + /** + * (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextTokenType; + /** + * (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed. + */ + IncludeDeprecated?: BooleanType; + } + export interface ListSecretVersionIdsResponse { + /** + * The list of the currently available versions of the specified secret. + */ + Versions?: SecretVersionsListType; + /** + * If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null). + */ + NextToken?: NextTokenType; + /** + * The Amazon Resource Name (ARN) for the secret. Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret. + */ + Name?: SecretNameType; + } + export interface ListSecretsRequest { + /** + * (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results. + */ + MaxResults?: MaxResultsType; + /** + * (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. + */ + NextToken?: NextTokenType; + } + export interface ListSecretsResponse { + /** + * A list of the secrets in the account. + */ + SecretList?: SecretListType; + /** + * If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null). + */ + NextToken?: NextTokenType; + } + export type MaxResultsType = number; + export type NameType = string; + export type NextTokenType = string; + export type NonEmptyResourcePolicyType = string; + export type PasswordLengthType = number; + export interface PutResourcePolicyRequest { + /** + * Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. + */ + ResourcePolicy: NonEmptyResourcePolicyType; + } + export interface PutResourcePolicyResponse { + /** + * The ARN of the secret that the resource-based policy was retrieved for. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret that the resource-based policy was retrieved for. + */ + Name?: NameType; + } + export interface PutSecretValueRequest { + /** + * Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * (Optional) Specifies a unique identifier for the new version of the secret. If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request. This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret. If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created. If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent). If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values. This value becomes the VersionId of the new version. + */ + ClientRequestToken?: ClientRequestTokenType; + /** + * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console. + */ + SecretBinary?: SecretBinaryType; + /** + * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example: [{"username":"bob"},{"password":"abc123xyz456"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. + */ + SecretString?: SecretStringType; + /** + * (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version. + */ + VersionStages?: SecretVersionStagesType; + } + export interface PutSecretValueResponse { + /** + * The Amazon Resource Name (ARN) for the secret for which you just created a version. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret for which you just created or updated a version. + */ + Name?: SecretNameType; + /** + * The unique identifier of the version of the secret you just created or updated. + */ + VersionId?: SecretVersionIdType; + /** + * The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. + */ + VersionStages?: SecretVersionStagesType; + } + export type RandomPasswordType = string; + export type RecoveryWindowInDaysType = number; + export type RequireEachIncludedTypeType = boolean; + export interface RestoreSecretRequest { + /** + * Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + } + export interface RestoreSecretResponse { + /** + * The ARN of the secret that was restored. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret that was restored. + */ + Name?: SecretNameType; + } + export interface RotateSecretRequest { + /** + * Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency. If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request. You only need to specify your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version. + */ + ClientRequestToken?: ClientRequestTokenType; + /** + * (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + */ + RotationLambdaARN?: RotationLambdaARNType; + /** + * A structure that defines the rotation configuration for this secret. + */ + RotationRules?: RotationRulesType; + } + export interface RotateSecretResponse { + /** + * The ARN of the secret. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret. + */ + Name?: SecretNameType; + /** + * The ID of the new version of the secret created by the rotation started by this request. + */ + VersionId?: SecretVersionIdType; + } + export type RotationEnabledType = boolean; + export type RotationLambdaARNType = string; + export interface RotationRulesType { + /** + * Specifies the number of days between automatic scheduled rotations of the secret. Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load. + */ + AutomaticallyAfterDays?: AutomaticallyRotateAfterDaysType; + } + export type SecretARNType = string; + export type SecretBinaryType = Buffer|Uint8Array|Blob|string; + export type SecretIdType = string; + export interface SecretListEntry { + /** + * The Amazon Resource Name (ARN) of the secret. For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod. + */ + Name?: SecretNameType; + /** + * The user-provided description of the secret. + */ + Description?: DescriptionType; + /** + * The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager) for this account. + */ + KmsKeyId?: KmsKeyIdType; + /** + * Indicated whether automatic, scheduled rotation is enabled for this secret. + */ + RotationEnabled?: RotationEnabledType; + /** + * The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret. + */ + RotationLambdaARN?: RotationLambdaARNType; + /** + * A structure that defines the rotation configuration for the secret. + */ + RotationRules?: RotationRulesType; + /** + * The last date and time that the rotation process for this secret was invoked. + */ + LastRotatedDate?: LastRotatedDateType; + /** + * The last date and time that this secret was modified in any way. + */ + LastChangedDate?: LastChangedDateType; + /** + * The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time. + */ + LastAccessedDate?: LastAccessedDateType; + /** + * The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation. + */ + DeletedDate?: DeletedDateType; + /** + * The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource. + */ + Tags?: TagListType; + /** + * A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list. + */ + SecretVersionsToStages?: SecretVersionsToStagesMapType; + } + export type SecretListType = SecretListEntry[]; + export type SecretNameType = string; + export type SecretStringType = string; + export type SecretVersionIdType = string; + export type SecretVersionStageType = string; + export type SecretVersionStagesType = SecretVersionStageType[]; + export interface SecretVersionsListEntry { + /** + * The unique version identifier of this version of the secret. + */ + VersionId?: SecretVersionIdType; + /** + * An array of staging labels that are currently associated with this version of the secret. + */ + VersionStages?: SecretVersionStagesType; + /** + * The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time. + */ + LastAccessedDate?: LastAccessedDateType; + /** + * The date and time this version of the secret was created. + */ + CreatedDate?: CreatedDateType; + } + export type SecretVersionsListType = SecretVersionsListEntry[]; + export type SecretVersionsToStagesMapType = {[key: string]: SecretVersionStagesType}; + export interface Tag { + /** + * The key identifier, or name, of the tag. + */ + Key?: TagKeyType; + /** + * The string value that's associated with the key of the tag. + */ + Value?: TagValueType; + } + export type TagKeyListType = TagKeyType[]; + export type TagKeyType = string; + export type TagListType = Tag[]; + export interface TagResourceRequest { + /** + * The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * The tags to attach to the secret. Each element in the list consists of a Key and a Value. This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax: --Tags Key="Key1",Value="Value1",Key="Key2",Value="Value2"[,…] + */ + Tags: TagListType; + } + export type TagValueType = string; + export interface UntagResourceRequest { + /** + * The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. + */ + TagKeys: TagKeyListType; + } + export interface UpdateSecretRequest { + /** + * Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * (Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency. If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request. You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created. If a version with this value already exists and that version's SecretString and SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent). If a version with this value already exists and that version's SecretString and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value. This value becomes the VersionId of the new version. + */ + ClientRequestToken?: ClientRequestTokenType; + /** + * (Optional) Specifies an updated user-provided description of the secret. + */ + Description?: DescriptionType; + /** + * (Optional) Specifies an updated ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the protected text in new versions of this secret. You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts. + */ + KmsKeyId?: KmsKeyIdType; + /** + * (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console. + */ + SecretBinary?: SecretBinaryType; + /** + * (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example: [{"username":"bob"},{"password":"abc123xyz456"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. You can also 'escape' the double quote character in the embedded JSON text by prefacing each with a backslash. For example, the following string is surrounded by double-quotes. All of the embedded double quotes are escaped: "[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]" + */ + SecretString?: SecretStringType; + } + export interface UpdateSecretResponse { + /** + * The ARN of the secret that was updated. Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret that was updated. + */ + Name?: SecretNameType; + /** + * If a new version of the secret was created by this operation, then VersionId contains the unique identifier of the new version. + */ + VersionId?: SecretVersionIdType; + } + export interface UpdateSecretVersionStageRequest { + /** + * Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters. + */ + SecretId: SecretIdType; + /** + * The staging label to add to this version. + */ + VersionStage: SecretVersionStageType; + /** + * Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails. + */ + RemoveFromVersionId?: SecretVersionIdType; + /** + * (Optional) The secret version ID that you want to add the staging label to. If you want to remove a label from a version, then do not specify this parameter. If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter. + */ + MoveToVersionId?: SecretVersionIdType; + } + export interface UpdateSecretVersionStageResponse { + /** + * The ARN of the secret with the staging label that was modified. + */ + ARN?: SecretARNType; + /** + * The friendly name of the secret with the staging label that was modified. + */ + Name?: SecretNameType; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-10-17"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SecretsManager client. + */ + export import Types = SecretsManager; +} +export = SecretsManager; diff --git a/node_modules/aws-sdk/clients/secretsmanager.js b/node_modules/aws-sdk/clients/secretsmanager.js new file mode 100644 index 0000000..67027de --- /dev/null +++ b/node_modules/aws-sdk/clients/secretsmanager.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['secretsmanager'] = {}; +AWS.SecretsManager = Service.defineService('secretsmanager', ['2017-10-17']); +Object.defineProperty(apiLoader.services['secretsmanager'], '2017-10-17', { + get: function get() { + var model = require('../apis/secretsmanager-2017-10-17.min.json'); + model.paginators = require('../apis/secretsmanager-2017-10-17.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SecretsManager; diff --git a/node_modules/aws-sdk/clients/securityhub.d.ts b/node_modules/aws-sdk/clients/securityhub.d.ts new file mode 100644 index 0000000..061df3a --- /dev/null +++ b/node_modules/aws-sdk/clients/securityhub.d.ts @@ -0,0 +1,1723 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SecurityHub extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SecurityHub.Types.ClientConfiguration) + config: Config & SecurityHub.Types.ClientConfiguration; + /** + * Accepts the invitation to be monitored by a master SecurityHub account. + */ + acceptInvitation(params: SecurityHub.Types.AcceptInvitationRequest, callback?: (err: AWSError, data: SecurityHub.Types.AcceptInvitationResponse) => void): Request; + /** + * Accepts the invitation to be monitored by a master SecurityHub account. + */ + acceptInvitation(callback?: (err: AWSError, data: SecurityHub.Types.AcceptInvitationResponse) => void): Request; + /** + * Disables the standards specified by the standards subscription ARNs. In the context of Security Hub, supported standards (for example, CIS AWS Foundations) are automated and continuous checks that help determine your compliance status against security industry (including AWS) best practices. + */ + batchDisableStandards(params: SecurityHub.Types.BatchDisableStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchDisableStandardsResponse) => void): Request; + /** + * Disables the standards specified by the standards subscription ARNs. In the context of Security Hub, supported standards (for example, CIS AWS Foundations) are automated and continuous checks that help determine your compliance status against security industry (including AWS) best practices. + */ + batchDisableStandards(callback?: (err: AWSError, data: SecurityHub.Types.BatchDisableStandardsResponse) => void): Request; + /** + * Enables the standards specified by the standards ARNs. In the context of Security Hub, supported standards (for example, CIS AWS Foundations) are automated and continuous checks that help determine your compliance status against security industry (including AWS) best practices. + */ + batchEnableStandards(params: SecurityHub.Types.BatchEnableStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchEnableStandardsResponse) => void): Request; + /** + * Enables the standards specified by the standards ARNs. In the context of Security Hub, supported standards (for example, CIS AWS Foundations) are automated and continuous checks that help determine your compliance status against security industry (including AWS) best practices. + */ + batchEnableStandards(callback?: (err: AWSError, data: SecurityHub.Types.BatchEnableStandardsResponse) => void): Request; + /** + * Imports security findings that are generated by the integrated third-party products into Security Hub. + */ + batchImportFindings(params: SecurityHub.Types.BatchImportFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchImportFindingsResponse) => void): Request; + /** + * Imports security findings that are generated by the integrated third-party products into Security Hub. + */ + batchImportFindings(callback?: (err: AWSError, data: SecurityHub.Types.BatchImportFindingsResponse) => void): Request; + /** + * Creates an insight, which is a consolidation of findings that identifies a security area that requires attention or intervention. + */ + createInsight(params: SecurityHub.Types.CreateInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateInsightResponse) => void): Request; + /** + * Creates an insight, which is a consolidation of findings that identifies a security area that requires attention or intervention. + */ + createInsight(callback?: (err: AWSError, data: SecurityHub.Types.CreateInsightResponse) => void): Request; + /** + * Creates member Security Hub accounts in the current AWS account (which becomes the master Security Hub account) that has Security Hub enabled. + */ + createMembers(params: SecurityHub.Types.CreateMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateMembersResponse) => void): Request; + /** + * Creates member Security Hub accounts in the current AWS account (which becomes the master Security Hub account) that has Security Hub enabled. + */ + createMembers(callback?: (err: AWSError, data: SecurityHub.Types.CreateMembersResponse) => void): Request; + /** + * Declines invitations that are sent to this AWS account (invitee) by the AWS accounts (inviters) that are specified by the account IDs. + */ + declineInvitations(params: SecurityHub.Types.DeclineInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeclineInvitationsResponse) => void): Request; + /** + * Declines invitations that are sent to this AWS account (invitee) by the AWS accounts (inviters) that are specified by the account IDs. + */ + declineInvitations(callback?: (err: AWSError, data: SecurityHub.Types.DeclineInvitationsResponse) => void): Request; + /** + * Deletes an insight that is specified by the insight ARN. + */ + deleteInsight(params: SecurityHub.Types.DeleteInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteInsightResponse) => void): Request; + /** + * Deletes an insight that is specified by the insight ARN. + */ + deleteInsight(callback?: (err: AWSError, data: SecurityHub.Types.DeleteInsightResponse) => void): Request; + /** + * Deletes invitations that are sent to this AWS account (invitee) by the AWS accounts (inviters) that are specified by their account IDs. + */ + deleteInvitations(params: SecurityHub.Types.DeleteInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteInvitationsResponse) => void): Request; + /** + * Deletes invitations that are sent to this AWS account (invitee) by the AWS accounts (inviters) that are specified by their account IDs. + */ + deleteInvitations(callback?: (err: AWSError, data: SecurityHub.Types.DeleteInvitationsResponse) => void): Request; + /** + * Deletes the Security Hub member accounts that are specified by the account IDs. + */ + deleteMembers(params: SecurityHub.Types.DeleteMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteMembersResponse) => void): Request; + /** + * Deletes the Security Hub member accounts that are specified by the account IDs. + */ + deleteMembers(callback?: (err: AWSError, data: SecurityHub.Types.DeleteMembersResponse) => void): Request; + /** + * Cancels the subscription that allows a findings-generating solution (product) to import its findings into Security Hub. + */ + disableImportFindingsForProduct(params: SecurityHub.Types.DisableImportFindingsForProductRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisableImportFindingsForProductResponse) => void): Request; + /** + * Cancels the subscription that allows a findings-generating solution (product) to import its findings into Security Hub. + */ + disableImportFindingsForProduct(callback?: (err: AWSError, data: SecurityHub.Types.DisableImportFindingsForProductResponse) => void): Request; + /** + * Disables the AWS Security Hub Service. + */ + disableSecurityHub(params: SecurityHub.Types.DisableSecurityHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisableSecurityHubResponse) => void): Request; + /** + * Disables the AWS Security Hub Service. + */ + disableSecurityHub(callback?: (err: AWSError, data: SecurityHub.Types.DisableSecurityHubResponse) => void): Request; + /** + * Disassociates the current Security Hub member account from its master account. + */ + disassociateFromMasterAccount(params: SecurityHub.Types.DisassociateFromMasterAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromMasterAccountResponse) => void): Request; + /** + * Disassociates the current Security Hub member account from its master account. + */ + disassociateFromMasterAccount(callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromMasterAccountResponse) => void): Request; + /** + * Disassociates the Security Hub member accounts that are specified by the account IDs from their master account. + */ + disassociateMembers(params: SecurityHub.Types.DisassociateMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisassociateMembersResponse) => void): Request; + /** + * Disassociates the Security Hub member accounts that are specified by the account IDs from their master account. + */ + disassociateMembers(callback?: (err: AWSError, data: SecurityHub.Types.DisassociateMembersResponse) => void): Request; + /** + * Sets up the subscription that enables a findings-generating solution (product) to import its findings into Security Hub. + */ + enableImportFindingsForProduct(params: SecurityHub.Types.EnableImportFindingsForProductRequest, callback?: (err: AWSError, data: SecurityHub.Types.EnableImportFindingsForProductResponse) => void): Request; + /** + * Sets up the subscription that enables a findings-generating solution (product) to import its findings into Security Hub. + */ + enableImportFindingsForProduct(callback?: (err: AWSError, data: SecurityHub.Types.EnableImportFindingsForProductResponse) => void): Request; + /** + * Enables the AWS Security Hub service. + */ + enableSecurityHub(params: SecurityHub.Types.EnableSecurityHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.EnableSecurityHubResponse) => void): Request; + /** + * Enables the AWS Security Hub service. + */ + enableSecurityHub(callback?: (err: AWSError, data: SecurityHub.Types.EnableSecurityHubResponse) => void): Request; + /** + * Lists and describes enabled standards. + */ + getEnabledStandards(params: SecurityHub.Types.GetEnabledStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetEnabledStandardsResponse) => void): Request; + /** + * Lists and describes enabled standards. + */ + getEnabledStandards(callback?: (err: AWSError, data: SecurityHub.Types.GetEnabledStandardsResponse) => void): Request; + /** + * Lists and describes Security Hub-aggregated findings that are specified by filter attributes. + */ + getFindings(params: SecurityHub.Types.GetFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetFindingsResponse) => void): Request; + /** + * Lists and describes Security Hub-aggregated findings that are specified by filter attributes. + */ + getFindings(callback?: (err: AWSError, data: SecurityHub.Types.GetFindingsResponse) => void): Request; + /** + * Lists the results of the Security Hub insight specified by the insight ARN. + */ + getInsightResults(params: SecurityHub.Types.GetInsightResultsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInsightResultsResponse) => void): Request; + /** + * Lists the results of the Security Hub insight specified by the insight ARN. + */ + getInsightResults(callback?: (err: AWSError, data: SecurityHub.Types.GetInsightResultsResponse) => void): Request; + /** + * Lists and describes insights that are specified by insight ARNs. + */ + getInsights(params: SecurityHub.Types.GetInsightsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInsightsResponse) => void): Request; + /** + * Lists and describes insights that are specified by insight ARNs. + */ + getInsights(callback?: (err: AWSError, data: SecurityHub.Types.GetInsightsResponse) => void): Request; + /** + * Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation. + */ + getInvitationsCount(params: SecurityHub.Types.GetInvitationsCountRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInvitationsCountResponse) => void): Request; + /** + * Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation. + */ + getInvitationsCount(callback?: (err: AWSError, data: SecurityHub.Types.GetInvitationsCountResponse) => void): Request; + /** + * Provides the details for the Security Hub master account to the current member account. + */ + getMasterAccount(params: SecurityHub.Types.GetMasterAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetMasterAccountResponse) => void): Request; + /** + * Provides the details for the Security Hub master account to the current member account. + */ + getMasterAccount(callback?: (err: AWSError, data: SecurityHub.Types.GetMasterAccountResponse) => void): Request; + /** + * Returns the details on the Security Hub member accounts that are specified by the account IDs. + */ + getMembers(params: SecurityHub.Types.GetMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetMembersResponse) => void): Request; + /** + * Returns the details on the Security Hub member accounts that are specified by the account IDs. + */ + getMembers(callback?: (err: AWSError, data: SecurityHub.Types.GetMembersResponse) => void): Request; + /** + * Invites other AWS accounts to enable Security Hub and become Security Hub member accounts. When an account accepts the invitation and becomes a member account, the master account can view Security Hub findings of the member account. + */ + inviteMembers(params: SecurityHub.Types.InviteMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.InviteMembersResponse) => void): Request; + /** + * Invites other AWS accounts to enable Security Hub and become Security Hub member accounts. When an account accepts the invitation and becomes a member account, the master account can view Security Hub findings of the member account. + */ + inviteMembers(callback?: (err: AWSError, data: SecurityHub.Types.InviteMembersResponse) => void): Request; + /** + * Lists all findings-generating solutions (products) whose findings you've subscribed to receive in Security Hub. + */ + listEnabledProductsForImport(params: SecurityHub.Types.ListEnabledProductsForImportRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListEnabledProductsForImportResponse) => void): Request; + /** + * Lists all findings-generating solutions (products) whose findings you've subscribed to receive in Security Hub. + */ + listEnabledProductsForImport(callback?: (err: AWSError, data: SecurityHub.Types.ListEnabledProductsForImportResponse) => void): Request; + /** + * Lists all Security Hub membership invitations that were sent to the current AWS account. + */ + listInvitations(params: SecurityHub.Types.ListInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListInvitationsResponse) => void): Request; + /** + * Lists all Security Hub membership invitations that were sent to the current AWS account. + */ + listInvitations(callback?: (err: AWSError, data: SecurityHub.Types.ListInvitationsResponse) => void): Request; + /** + * Lists details about all member accounts for the current Security Hub master account. + */ + listMembers(params: SecurityHub.Types.ListMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListMembersResponse) => void): Request; + /** + * Lists details about all member accounts for the current Security Hub master account. + */ + listMembers(callback?: (err: AWSError, data: SecurityHub.Types.ListMembersResponse) => void): Request; + /** + * Updates the AWS Security Hub-aggregated findings specified by the filter attributes. + */ + updateFindings(params: SecurityHub.Types.UpdateFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingsResponse) => void): Request; + /** + * Updates the AWS Security Hub-aggregated findings specified by the filter attributes. + */ + updateFindings(callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingsResponse) => void): Request; + /** + * Updates the AWS Security Hub insight specified by the insight ARN. + */ + updateInsight(params: SecurityHub.Types.UpdateInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateInsightResponse) => void): Request; + /** + * Updates the AWS Security Hub insight specified by the insight ARN. + */ + updateInsight(callback?: (err: AWSError, data: SecurityHub.Types.UpdateInsightResponse) => void): Request; +} +declare namespace SecurityHub { + export interface AcceptInvitationRequest { + /** + * The account ID of the master Security Hub account whose invitation you're accepting. + */ + MasterId?: NonEmptyString; + /** + * The ID of the invitation that is sent to the AWS account by the Security Hub master account. + */ + InvitationId?: NonEmptyString; + } + export interface AcceptInvitationResponse { + } + export interface AccountDetails { + /** + * The ID of an AWS account. + */ + AccountId?: AccountId; + /** + * The email of an AWS account. + */ + Email?: NonEmptyString; + } + export type AccountDetailsList = AccountDetails[]; + export type AccountId = string; + export type AccountIdList = NonEmptyString[]; + export type ArnList = NonEmptyString[]; + export interface AwsEc2InstanceDetails { + /** + * The instance type of the instance. + */ + Type?: NonEmptyString; + /** + * The Amazon Machine Image (AMI) ID of the instance. + */ + ImageId?: NonEmptyString; + /** + * The IPv4 addresses associated with the instance. + */ + IpV4Addresses?: StringList; + /** + * The IPv6 addresses associated with the instance. + */ + IpV6Addresses?: StringList; + /** + * The key name associated with the instance. + */ + KeyName?: NonEmptyString; + /** + * The IAM profile ARN of the instance. + */ + IamInstanceProfileArn?: NonEmptyString; + /** + * The identifier of the VPC in which the instance was launched. + */ + VpcId?: NonEmptyString; + /** + * The identifier of the subnet in which the instance was launched. + */ + SubnetId?: NonEmptyString; + /** + * The date/time the instance was launched. + */ + LaunchedAt?: NonEmptyString; + } + export interface AwsIamAccessKeyDetails { + /** + * The user associated with the IAM access key related to a finding. + */ + UserName?: NonEmptyString; + /** + * The status of the IAM access key related to a finding. + */ + Status?: AwsIamAccessKeyStatus; + /** + * The creation date/time of the IAM access key related to a finding. + */ + CreatedAt?: NonEmptyString; + } + export type AwsIamAccessKeyStatus = "Active"|"Inactive"|string; + export interface AwsS3BucketDetails { + /** + * The canonical user ID of the owner of the S3 bucket. + */ + OwnerId?: NonEmptyString; + /** + * The display name of the owner of the S3 bucket. + */ + OwnerName?: NonEmptyString; + } + export interface AwsSecurityFinding { + /** + * The schema version for which a finding is formatted. + */ + SchemaVersion: NonEmptyString; + /** + * The security findings provider-specific identifier for a finding. + */ + Id: NonEmptyString; + /** + * The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) once this provider's product (solution that generates findings) is registered with Security Hub. + */ + ProductArn: NonEmptyString; + /** + * This is the identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings provider's solutions, this generator can be called a rule, a check, a detector, a plug-in, etc. + */ + GeneratorId: NonEmptyString; + /** + * The AWS account ID in which a finding is generated. + */ + AwsAccountId: NonEmptyString; + /** + * One or more finding types in the format of 'namespace/category/classifier' that classify a finding. Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications + */ + Types: TypeList; + /** + * An ISO8601-formatted timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings provider. + */ + FirstObservedAt?: NonEmptyString; + /** + * An ISO8601-formatted timestamp that indicates when the potential security issue captured by a finding was most recently observed by the security findings provider. + */ + LastObservedAt?: NonEmptyString; + /** + * An ISO8601-formatted timestamp that indicates when the potential security issue captured by a finding was created by the security findings provider. + */ + CreatedAt: NonEmptyString; + /** + * An ISO8601-formatted timestamp that indicates when the finding record was last updated by the security findings provider. + */ + UpdatedAt: NonEmptyString; + /** + * A finding's severity. + */ + Severity: Severity; + /** + * A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale. 0 equates zero percent confidence and 100 equates to 100 percent confidence. + */ + Confidence?: Integer; + /** + * The level of importance assigned to the resources associated with the finding. A score of 0 means the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. + */ + Criticality?: Integer; + /** + * A finding's title. In this release, Title is a required property. + */ + Title?: NonEmptyString; + /** + * A finding's description. In this release, Description is a required property. + */ + Description?: NonEmptyString; + /** + * An data type that describes the remediation options for a finding. + */ + Remediation?: Remediation; + /** + * A URL that links to a page about the current finding in the security findings provider's solution. + */ + SourceUrl?: NonEmptyString; + /** + * A data type where security findings providers can include additional solution-specific details that are not part of the defined AwsSecurityFinding format. + */ + ProductFields?: FieldMap; + /** + * A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding. + */ + UserDefinedFields?: FieldMap; + /** + * A list of malware related to a finding. + */ + Malware?: MalwareList; + /** + * The details of network-related information about a finding. + */ + Network?: Network; + /** + * The details of process-related information about a finding. + */ + Process?: ProcessDetails; + /** + * Threat intel details related to a finding. + */ + ThreatIntelIndicators?: ThreatIntelIndicatorList; + /** + * A set of resource data types that describe the resources to which the finding refers. + */ + Resources: ResourceList; + /** + * This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, AWS CIS Foundations). Contains compliance-related finding details. + */ + Compliance?: Compliance; + /** + * Indicates the veracity of a finding. + */ + VerificationState?: VerificationState; + /** + * The workflow state of a finding. + */ + WorkflowState?: WorkflowState; + /** + * The record state of a finding. + */ + RecordState?: RecordState; + /** + * A list of related findings. + */ + RelatedFindings?: RelatedFindingList; + /** + * A user-defined note added to a finding. + */ + Note?: Note; + } + export interface AwsSecurityFindingFilters { + /** + * The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) once this provider's product (solution that generates findings) is registered with Security Hub. + */ + ProductArn?: StringFilterList; + /** + * The AWS account ID in which a finding is generated. + */ + AwsAccountId?: StringFilterList; + /** + * The security findings provider-specific identifier for a finding. + */ + Id?: StringFilterList; + /** + * This is the identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings provider's solutions, this generator can be called a rule, a check, a detector, a plug-in, etc. + */ + GeneratorId?: StringFilterList; + /** + * A finding type in the format of 'namespace/category/classifier' that classifies a finding. + */ + Type?: StringFilterList; + /** + * An ISO8601-formatted timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings provider. + */ + FirstObservedAt?: DateFilterList; + /** + * An ISO8601-formatted timestamp that indicates when the potential security issue captured by a finding was most recently observed by the security findings provider. + */ + LastObservedAt?: DateFilterList; + /** + * An ISO8601-formatted timestamp that indicates when the potential security issue captured by a finding was created by the security findings provider. + */ + CreatedAt?: DateFilterList; + /** + * An ISO8601-formatted timestamp that indicates when the finding record was last updated by the security findings provider. + */ + UpdatedAt?: DateFilterList; + /** + * The native severity as defined by the security findings provider's solution that generated the finding. + */ + SeverityProduct?: NumberFilterList; + /** + * The normalized severity of a finding. + */ + SeverityNormalized?: NumberFilterList; + /** + * The label of a finding's severity. + */ + SeverityLabel?: StringFilterList; + /** + * A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale. 0 equates zero percent confidence and 100 equates to 100 percent confidence. + */ + Confidence?: NumberFilterList; + /** + * The level of importance assigned to the resources associated with the finding. A score of 0 means the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. + */ + Criticality?: NumberFilterList; + /** + * A finding's title. + */ + Title?: StringFilterList; + /** + * A finding's description. + */ + Description?: StringFilterList; + /** + * The recommendation of what to do about the issue described in a finding. + */ + RecommendationText?: StringFilterList; + /** + * A URL that links to a page about the current finding in the security findings provider's solution. + */ + SourceUrl?: StringFilterList; + /** + * A data type where security findings providers can include additional solution-specific details that are not part of the defined AwsSecurityFinding format. + */ + ProductFields?: MapFilterList; + /** + * The name of the solution (product) that generates findings. + */ + ProductName?: StringFilterList; + /** + * The name of the findings provider (company) that owns the solution (product) that generates findings. + */ + CompanyName?: StringFilterList; + /** + * A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding. + */ + UserDefinedFields?: MapFilterList; + /** + * The name of the malware that was observed. + */ + MalwareName?: StringFilterList; + /** + * The type of the malware that was observed. + */ + MalwareType?: StringFilterList; + /** + * The filesystem path of the malware that was observed. + */ + MalwarePath?: StringFilterList; + /** + * The state of the malware that was observed. + */ + MalwareState?: StringFilterList; + /** + * Indicates the direction of network traffic associated with a finding. + */ + NetworkDirection?: StringFilterList; + /** + * The protocol of network-related information about a finding. + */ + NetworkProtocol?: StringFilterList; + /** + * The source IPv4 address of network-related information about a finding. + */ + NetworkSourceIpV4?: IpFilterList; + /** + * The source IPv6 address of network-related information about a finding. + */ + NetworkSourceIpV6?: IpFilterList; + /** + * The source port of network-related information about a finding. + */ + NetworkSourcePort?: NumberFilterList; + /** + * The source domain of network-related information about a finding. + */ + NetworkSourceDomain?: StringFilterList; + /** + * The source media access control (MAC) address of network-related information about a finding. + */ + NetworkSourceMac?: StringFilterList; + /** + * The destination IPv4 address of network-related information about a finding. + */ + NetworkDestinationIpV4?: IpFilterList; + /** + * The destination IPv6 address of network-related information about a finding. + */ + NetworkDestinationIpV6?: IpFilterList; + /** + * The destination port of network-related information about a finding. + */ + NetworkDestinationPort?: NumberFilterList; + /** + * The destination domain of network-related information about a finding. + */ + NetworkDestinationDomain?: StringFilterList; + /** + * The name of the process. + */ + ProcessName?: StringFilterList; + /** + * The path to the process executable. + */ + ProcessPath?: StringFilterList; + /** + * The process ID. + */ + ProcessPid?: NumberFilterList; + /** + * The parent process ID. + */ + ProcessParentPid?: NumberFilterList; + /** + * The date/time that the process was launched. + */ + ProcessLaunchedAt?: DateFilterList; + /** + * The date/time that the process was terminated. + */ + ProcessTerminatedAt?: DateFilterList; + /** + * The type of a threat intel indicator. + */ + ThreatIntelIndicatorType?: StringFilterList; + /** + * The value of a threat intel indicator. + */ + ThreatIntelIndicatorValue?: StringFilterList; + /** + * The category of a threat intel indicator. + */ + ThreatIntelIndicatorCategory?: StringFilterList; + /** + * The date/time of the last observation of a threat intel indicator. + */ + ThreatIntelIndicatorLastObservedAt?: DateFilterList; + /** + * The source of the threat intel. + */ + ThreatIntelIndicatorSource?: StringFilterList; + /** + * The URL for more details from the source of the threat intel. + */ + ThreatIntelIndicatorSourceUrl?: StringFilterList; + /** + * Specifies the type of the resource for which details are provided. + */ + ResourceType?: StringFilterList; + /** + * The canonical identifier for the given resource type. + */ + ResourceId?: StringFilterList; + /** + * The canonical AWS partition name to which the region is assigned. + */ + ResourcePartition?: StringFilterList; + /** + * The canonical AWS external region name where this resource is located. + */ + ResourceRegion?: StringFilterList; + /** + * A list of AWS tags associated with a resource at the time the finding was processed. + */ + ResourceTags?: MapFilterList; + /** + * The instance type of the instance. + */ + ResourceAwsEc2InstanceType?: StringFilterList; + /** + * The Amazon Machine Image (AMI) ID of the instance. + */ + ResourceAwsEc2InstanceImageId?: StringFilterList; + /** + * The IPv4 addresses associated with the instance. + */ + ResourceAwsEc2InstanceIpV4Addresses?: IpFilterList; + /** + * The IPv6 addresses associated with the instance. + */ + ResourceAwsEc2InstanceIpV6Addresses?: IpFilterList; + /** + * The key name associated with the instance. + */ + ResourceAwsEc2InstanceKeyName?: StringFilterList; + /** + * The IAM profile ARN of the instance. + */ + ResourceAwsEc2InstanceIamInstanceProfileArn?: StringFilterList; + /** + * The identifier of the VPC in which the instance was launched. + */ + ResourceAwsEc2InstanceVpcId?: StringFilterList; + /** + * The identifier of the subnet in which the instance was launched. + */ + ResourceAwsEc2InstanceSubnetId?: StringFilterList; + /** + * The date/time the instance was launched. + */ + ResourceAwsEc2InstanceLaunchedAt?: DateFilterList; + /** + * The canonical user ID of the owner of the S3 bucket. + */ + ResourceAwsS3BucketOwnerId?: StringFilterList; + /** + * The display name of the owner of the S3 bucket. + */ + ResourceAwsS3BucketOwnerName?: StringFilterList; + /** + * The user associated with the IAM access key related to a finding. + */ + ResourceAwsIamAccessKeyUserName?: StringFilterList; + /** + * The status of the IAM access key related to a finding. + */ + ResourceAwsIamAccessKeyStatus?: StringFilterList; + /** + * The creation date/time of the IAM access key related to a finding. + */ + ResourceAwsIamAccessKeyCreatedAt?: DateFilterList; + /** + * The name of the container related to a finding. + */ + ResourceContainerName?: StringFilterList; + /** + * The identifier of the image related to a finding. + */ + ResourceContainerImageId?: StringFilterList; + /** + * The name of the image related to a finding. + */ + ResourceContainerImageName?: StringFilterList; + /** + * The date/time that the container was started. + */ + ResourceContainerLaunchedAt?: DateFilterList; + /** + * The details of a resource that does not have a specific sub-field for the resource type defined. + */ + ResourceDetailsOther?: MapFilterList; + /** + * Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, AWS CIS Foundations). Contains compliance-related finding details. + */ + ComplianceStatus?: StringFilterList; + /** + * Indicates the veracity of a finding. + */ + VerificationState?: StringFilterList; + /** + * The workflow state of a finding. + */ + WorkflowState?: StringFilterList; + /** + * The updated record state for the finding. + */ + RecordState?: StringFilterList; + /** + * The ARN of the solution that generated a related finding. + */ + RelatedFindingsProductArn?: StringFilterList; + /** + * The solution-generated identifier for a related finding. + */ + RelatedFindingsId?: StringFilterList; + /** + * The text of a note. + */ + NoteText?: StringFilterList; + /** + * The timestamp of when the note was updated. + */ + NoteUpdatedAt?: DateFilterList; + /** + * The principal that created a note. + */ + NoteUpdatedBy?: StringFilterList; + /** + * A keyword for a finding. + */ + Keyword?: KeywordFilterList; + } + export type AwsSecurityFindingList = AwsSecurityFinding[]; + export interface BatchDisableStandardsRequest { + /** + * The ARNS of the standards subscriptions that you want to disable. + */ + StandardsSubscriptionArns: StandardsSubscriptionArns; + } + export interface BatchDisableStandardsResponse { + /** + * The details of the standards subscriptions that were disabled. + */ + StandardsSubscriptions?: StandardsSubscriptions; + } + export interface BatchEnableStandardsRequest { + /** + * The list of standards that you want to enable. In this release, Security Hub only supports the CIS AWS Foundations standard. Its ARN is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0. + */ + StandardsSubscriptionRequests: StandardsSubscriptionRequests; + } + export interface BatchEnableStandardsResponse { + /** + * The details of the standards subscriptions that were enabled. + */ + StandardsSubscriptions?: StandardsSubscriptions; + } + export interface BatchImportFindingsRequest { + /** + * A list of findings that you want to import. Must be submitted in the AWSSecurityFinding format. + */ + Findings: AwsSecurityFindingList; + } + export interface BatchImportFindingsResponse { + /** + * The number of findings that cannot be imported. + */ + FailedCount: Integer; + /** + * The number of findings that were successfully imported + */ + SuccessCount: Integer; + /** + * The list of the findings that cannot be imported. + */ + FailedFindings?: ImportFindingsErrorList; + } + export type Boolean = boolean; + export interface Compliance { + /** + * Indicates the result of a compliance check. + */ + Status?: ComplianceStatus; + } + export type ComplianceStatus = "PASSED"|"WARNING"|"FAILED"|"NOT_AVAILABLE"|string; + export interface ContainerDetails { + /** + * The name of the container related to a finding. + */ + Name?: NonEmptyString; + /** + * The identifier of the image related to a finding. + */ + ImageId?: NonEmptyString; + /** + * The name of the image related to a finding. + */ + ImageName?: NonEmptyString; + /** + * The date/time that the container was started. + */ + LaunchedAt?: NonEmptyString; + } + export interface CreateInsightRequest { + /** + * The user-defined name that identifies the insight that you want to create. + */ + Name: NonEmptyString; + /** + * A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight. + */ + Filters: AwsSecurityFindingFilters; + /** + * The attribute by which the insight's findings are grouped. This attribute is used as a findings aggregator for the purposes of viewing and managing multiple related findings under a single operand. + */ + GroupByAttribute: NonEmptyString; + } + export interface CreateInsightResponse { + /** + * The ARN Of the created insight. + */ + InsightArn: NonEmptyString; + } + export interface CreateMembersRequest { + /** + * A list of account ID and email address pairs of the accounts that you want to associate with the master Security Hub account. + */ + AccountDetails?: AccountDetailsList; + } + export interface CreateMembersResponse { + /** + * A list of account ID and email address pairs of the AWS accounts that could not be processed. + */ + UnprocessedAccounts?: ResultList; + } + export interface DateFilter { + /** + * A start date for the date filter. + */ + Start?: NonEmptyString; + /** + * An end date for the date filter. + */ + End?: NonEmptyString; + /** + * A date range for the date filter. + */ + DateRange?: DateRange; + } + export type DateFilterList = DateFilter[]; + export interface DateRange { + /** + * A date range value for the date filter. + */ + Value?: Integer; + /** + * A date range unit for the date filter. + */ + Unit?: DateRangeUnit; + } + export type DateRangeUnit = "DAYS"|string; + export interface DeclineInvitationsRequest { + /** + * A list of account IDs specifying accounts whose invitations to Security Hub you want to decline. + */ + AccountIds?: AccountIdList; + } + export interface DeclineInvitationsResponse { + /** + * A list of account ID and email address pairs of the AWS accounts that could not be processed. + */ + UnprocessedAccounts?: ResultList; + } + export interface DeleteInsightRequest { + /** + * The ARN of the insight that you want to delete. + */ + InsightArn: NonEmptyString; + } + export interface DeleteInsightResponse { + /** + * The ARN of the insight that was deleted. + */ + InsightArn: NonEmptyString; + } + export interface DeleteInvitationsRequest { + /** + * A list of account IDs specifying accounts whose invitations to Security Hub you want to delete. + */ + AccountIds?: AccountIdList; + } + export interface DeleteInvitationsResponse { + /** + * A list of account ID and email address pairs of the AWS accounts that could not be processed. + */ + UnprocessedAccounts?: ResultList; + } + export interface DeleteMembersRequest { + /** + * A list of account IDs of the Security Hub member accounts that you want to delete. + */ + AccountIds?: AccountIdList; + } + export interface DeleteMembersResponse { + /** + * A list of account ID and email address pairs of the AWS accounts that could not be processed. + */ + UnprocessedAccounts?: ResultList; + } + export interface DisableImportFindingsForProductRequest { + /** + * The ARN of a resource that represents your subscription to a supported product. + */ + ProductSubscriptionArn: NonEmptyString; + } + export interface DisableImportFindingsForProductResponse { + } + export interface DisableSecurityHubRequest { + } + export interface DisableSecurityHubResponse { + } + export interface DisassociateFromMasterAccountRequest { + } + export interface DisassociateFromMasterAccountResponse { + } + export interface DisassociateMembersRequest { + /** + * The account IDs of the member accounts that you want to disassociate from the master account. + */ + AccountIds?: AccountIdList; + } + export interface DisassociateMembersResponse { + } + export type Double = number; + export interface EnableImportFindingsForProductRequest { + /** + * The ARN of the product that generates findings that you want to import into Security Hub. + */ + ProductArn: NonEmptyString; + } + export interface EnableImportFindingsForProductResponse { + /** + * The ARN of a resource that represents your subscription to the product that generates the findings that you want to import into Security Hub. + */ + ProductSubscriptionArn?: NonEmptyString; + } + export interface EnableSecurityHubRequest { + } + export interface EnableSecurityHubResponse { + } + export type FieldMap = {[key: string]: NonEmptyString}; + export interface GetEnabledStandardsRequest { + /** + * The list of standards subscription ARNS that you want to list and describe. + */ + StandardsSubscriptionArns?: StandardsSubscriptionArns; + /** + * Paginates results. Set the value of this parameter to NULL on your first call to the GetEnabledStandards operation. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + NextToken?: NextToken; + /** + * Indicates the maximum number of items that you want in the response. + */ + MaxResults?: MaxResults; + } + export interface GetEnabledStandardsResponse { + /** + * The standards subscription details returned by the operation. + */ + StandardsSubscriptions?: StandardsSubscriptions; + /** + * The token that is required for pagination. + */ + NextToken?: NextToken; + } + export interface GetFindingsRequest { + /** + * A collection of attributes that is use for querying findings. + */ + Filters?: AwsSecurityFindingFilters; + /** + * A collection of attributes used for sorting findings. + */ + SortCriteria?: SortCriteria; + /** + * Paginates results. Set the value of this parameter to NULL on your first call to the GetFindings operation. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + NextToken?: NextToken; + /** + * Indicates the maximum number of items that you want in the response. + */ + MaxResults?: MaxResults; + } + export interface GetFindingsResponse { + /** + * Findings details returned by the operation. + */ + Findings: AwsSecurityFindingList; + /** + * The token that is required for pagination. + */ + NextToken?: NextToken; + } + export interface GetInsightResultsRequest { + /** + * The ARN of the insight whose results you want to see. + */ + InsightArn: NonEmptyString; + } + export interface GetInsightResultsResponse { + /** + * The insight results returned by the operation. + */ + InsightResults: InsightResults; + } + export interface GetInsightsRequest { + /** + * The ARNS of the insights that you want to describe. + */ + InsightArns?: ArnList; + /** + * Paginates results. Set the value of this parameter to NULL on your first call to the GetInsights operation. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data. + */ + NextToken?: NextToken; + /** + * Indicates the maximum number of items that you want in the response. + */ + MaxResults?: MaxResults; + } + export interface GetInsightsResponse { + /** + * The insights returned by the operation. + */ + Insights: InsightList; + /** + * The token that is required for pagination. + */ + NextToken?: NextToken; + } + export interface GetInvitationsCountRequest { + } + export interface GetInvitationsCountResponse { + /** + * The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation. + */ + InvitationsCount?: Integer; + } + export interface GetMasterAccountRequest { + } + export interface GetMasterAccountResponse { + /** + * A list of details about the Security Hub master account for the current member account. + */ + Master?: Invitation; + } + export interface GetMembersRequest { + /** + * A list of account IDs for the Security Hub member accounts on which you want to return the details. + */ + AccountIds: AccountIdList; + } + export interface GetMembersResponse { + /** + * A list of details about the Security Hub member accounts. + */ + Members?: MemberList; + /** + * A list of account ID and email address pairs of the AWS accounts that could not be processed. + */ + UnprocessedAccounts?: ResultList; + } + export interface ImportFindingsError { + /** + * The id of the error made during the BatchImportFindings operation. + */ + Id: NonEmptyString; + /** + * The code of the error made during the BatchImportFindings operation. + */ + ErrorCode: NonEmptyString; + /** + * The message of the error made during the BatchImportFindings operation. + */ + ErrorMessage: NonEmptyString; + } + export type ImportFindingsErrorList = ImportFindingsError[]; + export interface Insight { + /** + * The ARN of a Security Hub insight. + */ + InsightArn: NonEmptyString; + /** + * The name of a Security Hub insight. + */ + Name: NonEmptyString; + /** + * A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight. + */ + Filters: AwsSecurityFindingFilters; + /** + * The attribute by which the insight's findings are grouped. This attribute is used as a findings aggregator for the purposes of viewing and managing multiple related findings under a single operand. + */ + GroupByAttribute: NonEmptyString; + } + export type InsightList = Insight[]; + export interface InsightResultValue { + /** + * The value of the attribute by which the findings are grouped for the insight's whose results are returned by the GetInsightResults operation. + */ + GroupByAttributeValue: NonEmptyString; + /** + * The number of findings returned for each GroupByAttributeValue. + */ + Count: Integer; + } + export type InsightResultValueList = InsightResultValue[]; + export interface InsightResults { + /** + * The ARN of the insight whose results are returned by the GetInsightResults operation. + */ + InsightArn: NonEmptyString; + /** + * The attribute by which the findings are grouped for the insight's whose results are returned by the GetInsightResults operation. + */ + GroupByAttribute: NonEmptyString; + /** + * The list of insight result values returned by the GetInsightResults operation. + */ + ResultValues: InsightResultValueList; + } + export type Integer = number; + export interface Invitation { + /** + * The account ID of the master Security Hub account who sent the invitation. + */ + AccountId?: AccountId; + /** + * The ID of the invitation sent by the master Security Hub account. + */ + InvitationId?: NonEmptyString; + /** + * The timestamp of when the invitation was sent. + */ + InvitedAt?: Timestamp; + /** + * The current relationship status between the inviter and invitee accounts. + */ + MemberStatus?: NonEmptyString; + } + export type InvitationList = Invitation[]; + export interface InviteMembersRequest { + /** + * A list of IDs of the AWS accounts that you want to invite to Security Hub as members. + */ + AccountIds?: AccountIdList; + } + export interface InviteMembersResponse { + /** + * A list of account ID and email address pairs of the AWS accounts that could not be processed. + */ + UnprocessedAccounts?: ResultList; + } + export interface IpFilter { + /** + * Finding's CIDR value. + */ + Cidr?: NonEmptyString; + } + export type IpFilterList = IpFilter[]; + export interface KeywordFilter { + /** + * A value for the keyword. + */ + Value?: NonEmptyString; + } + export type KeywordFilterList = KeywordFilter[]; + export interface ListEnabledProductsForImportRequest { + /** + * Paginates results. Set the value of this parameter to NULL on your first call to the ListEnabledProductsForImport operation. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + NextToken?: NextToken; + /** + * Indicates the maximum number of items that you want in the response. + */ + MaxResults?: MaxResults; + } + export interface ListEnabledProductsForImportResponse { + /** + * A list of ARNs for the resources that represent your subscriptions to products. + */ + ProductSubscriptions?: ProductSubscriptionArnList; + /** + * The token that is required for pagination. + */ + NextToken?: NextToken; + } + export interface ListInvitationsRequest { + /** + * Indicates the maximum number of items that you want in the response. + */ + MaxResults?: MaxResults; + /** + * Paginates results. Set the value of this parameter to NULL on your first call to the ListInvitations operation. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + NextToken?: NextToken; + } + export interface ListInvitationsResponse { + /** + * The details of the invitations returned by the operation. + */ + Invitations?: InvitationList; + /** + * The token that is required for pagination. + */ + NextToken?: NonEmptyString; + } + export interface ListMembersRequest { + /** + * Specifies what member accounts the response includes based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the master is set to ENABLED or DISABLED. If onlyAssociated is set to FALSE, the response includes all existing member accounts. + */ + OnlyAssociated?: Boolean; + /** + * Indicates the maximum number of items that you want in the response. + */ + MaxResults?: MaxResults; + /** + * Paginates results. Set the value of this parameter to NULL on your first call to the ListMembers operation. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data. + */ + NextToken?: NextToken; + } + export interface ListMembersResponse { + /** + * Member details returned by the operation. + */ + Members?: MemberList; + /** + * The token that is required for pagination. + */ + NextToken?: NonEmptyString; + } + export interface Malware { + /** + * The name of the malware that was observed. + */ + Name: NonEmptyString; + /** + * The type of the malware that was observed. + */ + Type?: MalwareType; + /** + * The filesystem path of the malware that was observed. + */ + Path?: NonEmptyString; + /** + * The state of the malware that was observed. + */ + State?: MalwareState; + } + export type MalwareList = Malware[]; + export type MalwareState = "OBSERVED"|"REMOVAL_FAILED"|"REMOVED"|string; + export type MalwareType = "ADWARE"|"BLENDED_THREAT"|"BOTNET_AGENT"|"COIN_MINER"|"EXPLOIT_KIT"|"KEYLOGGER"|"MACRO"|"POTENTIALLY_UNWANTED"|"SPYWARE"|"RANSOMWARE"|"REMOTE_ACCESS"|"ROOTKIT"|"TROJAN"|"VIRUS"|"WORM"|string; + export interface MapFilter { + /** + * The key of the map filter. + */ + Key?: NonEmptyString; + /** + * The value for the key in the map filter. + */ + Value?: NonEmptyString; + /** + * Represents the condition to be applied to a key value when querying for findings with a map filter. + */ + Comparison?: MapFilterComparison; + } + export type MapFilterComparison = "CONTAINS"|string; + export type MapFilterList = MapFilter[]; + export type MaxResults = number; + export interface Member { + /** + * The AWS account ID of a Security Hub member account. + */ + AccountId?: AccountId; + /** + * The email of a Security Hub member account. + */ + Email?: NonEmptyString; + /** + * The AWS account ID of the master Security Hub account to this member account. + */ + MasterId?: NonEmptyString; + /** + * The status of the relationship between the member account and its master account. + */ + MemberStatus?: NonEmptyString; + /** + * Time stamp at which the member account was invited to Security Hub. + */ + InvitedAt?: Timestamp; + /** + * Time stamp at which this member account was updated. + */ + UpdatedAt?: Timestamp; + } + export type MemberList = Member[]; + export interface Network { + /** + * Indicates the direction of network traffic associated with a finding. + */ + Direction?: NetworkDirection; + /** + * The protocol of network-related information about a finding. + */ + Protocol?: NonEmptyString; + /** + * The source IPv4 address of network-related information about a finding. + */ + SourceIpV4?: NonEmptyString; + /** + * The source IPv6 address of network-related information about a finding. + */ + SourceIpV6?: NonEmptyString; + /** + * The source port of network-related information about a finding. + */ + SourcePort?: Integer; + /** + * The source domain of network-related information about a finding. + */ + SourceDomain?: NonEmptyString; + /** + * The source media access control (MAC) address of network-related information about a finding. + */ + SourceMac?: NonEmptyString; + /** + * The destination IPv4 address of network-related information about a finding. + */ + DestinationIpV4?: NonEmptyString; + /** + * The destination IPv6 address of network-related information about a finding. + */ + DestinationIpV6?: NonEmptyString; + /** + * The destination port of network-related information about a finding. + */ + DestinationPort?: Integer; + /** + * The destination domain of network-related information about a finding. + */ + DestinationDomain?: NonEmptyString; + } + export type NetworkDirection = "IN"|"OUT"|string; + export type NextToken = string; + export type NonEmptyString = string; + export interface Note { + /** + * The text of a note. + */ + Text: NonEmptyString; + /** + * The principal that created a note. + */ + UpdatedBy: NonEmptyString; + /** + * The timestamp of when the note was updated. + */ + UpdatedAt: NonEmptyString; + } + export interface NoteUpdate { + /** + * The updated note text. + */ + Text: NonEmptyString; + /** + * The principal that updated the note. + */ + UpdatedBy: NonEmptyString; + } + export interface NumberFilter { + /** + * Represents the "greater than equal" condition to be applied to a single field when querying for findings. + */ + Gte?: Double; + /** + * Represents the "less than equal" condition to be applied to a single field when querying for findings. + */ + Lte?: Double; + /** + * Represents the "equal to" condition to be applied to a single field when querying for findings. + */ + Eq?: Double; + } + export type NumberFilterList = NumberFilter[]; + export type Partition = "aws"|"aws-cn"|"aws-us-gov"|string; + export interface ProcessDetails { + /** + * The name of the process. + */ + Name?: NonEmptyString; + /** + * The path to the process executable. + */ + Path?: NonEmptyString; + /** + * The process ID. + */ + Pid?: Integer; + /** + * The parent process ID. + */ + ParentPid?: Integer; + /** + * The date/time that the process was launched. + */ + LaunchedAt?: NonEmptyString; + /** + * The date/time that the process was terminated. + */ + TerminatedAt?: NonEmptyString; + } + export type ProductSubscriptionArnList = NonEmptyString[]; + export interface Recommendation { + /** + * The recommendation of what to do about the issue described in a finding. + */ + Text?: NonEmptyString; + /** + * A URL to link to general remediation information for the finding type of a finding. + */ + Url?: NonEmptyString; + } + export type RecordState = "ACTIVE"|"ARCHIVED"|string; + export interface RelatedFinding { + /** + * The ARN of the solution that generated a related finding. + */ + ProductArn: NonEmptyString; + /** + * The solution-generated identifier for a related finding. + */ + Id: NonEmptyString; + } + export type RelatedFindingList = RelatedFinding[]; + export interface Remediation { + /** + * Provides a recommendation on how to remediate the issue identified within a finding. + */ + Recommendation?: Recommendation; + } + export interface Resource { + /** + * Specifies the type of the resource for which details are provided. + */ + Type: NonEmptyString; + /** + * The canonical identifier for the given resource type. + */ + Id: NonEmptyString; + /** + * The canonical AWS partition name to which the region is assigned. + */ + Partition?: Partition; + /** + * The canonical AWS external region name where this resource is located. + */ + Region?: NonEmptyString; + /** + * A list of AWS tags associated with a resource at the time the finding was processed. + */ + Tags?: FieldMap; + /** + * Provides additional details about the resource. + */ + Details?: ResourceDetails; + } + export interface ResourceDetails { + /** + * The details of an AWS EC2 instance. + */ + AwsEc2Instance?: AwsEc2InstanceDetails; + /** + * The details of an AWS S3 Bucket. + */ + AwsS3Bucket?: AwsS3BucketDetails; + /** + * AWS IAM access key details related to a finding. + */ + AwsIamAccessKey?: AwsIamAccessKeyDetails; + /** + * Container details related to a finding. + */ + Container?: ContainerDetails; + /** + * The details of a resource that does not have a specific sub-field for the resource type defined. + */ + Other?: FieldMap; + } + export type ResourceList = Resource[]; + export interface Result { + /** + * An ID of the AWS account that could not be processed. + */ + AccountId?: AccountId; + /** + * The reason for why an account could not be processed. + */ + ProcessingResult?: NonEmptyString; + } + export type ResultList = Result[]; + export interface Severity { + /** + * The native severity as defined by the security findings provider's solution that generated the finding. + */ + Product?: Double; + /** + * The normalized severity of a finding. + */ + Normalized: Integer; + } + export type SortCriteria = SortCriterion[]; + export interface SortCriterion { + /** + * The finding attribute used for sorting findings. + */ + Field?: NonEmptyString; + /** + * The order used for sorting findings. + */ + SortOrder?: SortOrder; + } + export type SortOrder = "asc"|"desc"|string; + export type StandardsInputParameterMap = {[key: string]: NonEmptyString}; + export type StandardsStatus = "PENDING"|"READY"|"FAILED"|"DELETING"|string; + export interface StandardsSubscription { + /** + * The ARN of a resource that represents your subscription to a supported standard. + */ + StandardsSubscriptionArn: NonEmptyString; + /** + * The ARN of a standard. In this release, Security Hub only supports the CIS AWS Foundations standard. Its ARN is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0. + */ + StandardsArn: NonEmptyString; + /** + * + */ + StandardsInput: StandardsInputParameterMap; + /** + * The standard's status. + */ + StandardsStatus: StandardsStatus; + } + export type StandardsSubscriptionArns = NonEmptyString[]; + export interface StandardsSubscriptionRequest { + /** + * The ARN of the standard that you want to enable. In this release, Security Hub only supports the CIS AWS Foundations standard. Its ARN is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0. + */ + StandardsArn: NonEmptyString; + /** + * + */ + StandardsInput?: StandardsInputParameterMap; + } + export type StandardsSubscriptionRequests = StandardsSubscriptionRequest[]; + export type StandardsSubscriptions = StandardsSubscription[]; + export interface StringFilter { + /** + * The string filter value. + */ + Value?: NonEmptyString; + /** + * Represents the condition to be applied to a string value when querying for findings. + */ + Comparison?: StringFilterComparison; + } + export type StringFilterComparison = "EQUALS"|"CONTAINS"|"PREFIX"|string; + export type StringFilterList = StringFilter[]; + export type StringList = NonEmptyString[]; + export interface ThreatIntelIndicator { + /** + * The type of a threat intel indicator. + */ + Type?: ThreatIntelIndicatorType; + /** + * The value of a threat intel indicator. + */ + Value?: NonEmptyString; + /** + * The category of a threat intel indicator. + */ + Category?: ThreatIntelIndicatorCategory; + /** + * The date/time of the last observation of a threat intel indicator. + */ + LastObservedAt?: NonEmptyString; + /** + * The source of the threat intel. + */ + Source?: NonEmptyString; + /** + * The URL for more details from the source of the threat intel. + */ + SourceUrl?: NonEmptyString; + } + export type ThreatIntelIndicatorCategory = "BACKDOOR"|"CARD_STEALER"|"COMMAND_AND_CONTROL"|"DROP_SITE"|"EXPLOIT_SITE"|"KEYLOGGER"|string; + export type ThreatIntelIndicatorList = ThreatIntelIndicator[]; + export type ThreatIntelIndicatorType = "DOMAIN"|"EMAIL_ADDRESS"|"HASH_MD5"|"HASH_SHA1"|"HASH_SHA256"|"HASH_SHA512"|"IPV4_ADDRESS"|"IPV6_ADDRESS"|"MUTEX"|"PROCESS"|"URL"|string; + export type Timestamp = Date; + export type TypeList = NonEmptyString[]; + export interface UpdateFindingsRequest { + /** + * A collection of attributes that specify what findings you want to update. + */ + Filters: AwsSecurityFindingFilters; + /** + * The updated note for the finding. + */ + Note?: NoteUpdate; + /** + * The updated record state for the finding. + */ + RecordState?: RecordState; + } + export interface UpdateFindingsResponse { + } + export interface UpdateInsightRequest { + /** + * The ARN of the insight that you want to update. + */ + InsightArn: NonEmptyString; + /** + * The updated name for the insight. + */ + Name?: NonEmptyString; + /** + * The updated filters that define this insight. + */ + Filters?: AwsSecurityFindingFilters; + /** + * The updated GroupBy attribute that defines this insight. + */ + GroupByAttribute?: NonEmptyString; + } + export interface UpdateInsightResponse { + } + export type VerificationState = "UNKNOWN"|"TRUE_POSITIVE"|"FALSE_POSITIVE"|"BENIGN_POSITIVE"|string; + export type WorkflowState = "NEW"|"ASSIGNED"|"IN_PROGRESS"|"DEFERRED"|"RESOLVED"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-10-26"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SecurityHub client. + */ + export import Types = SecurityHub; +} +export = SecurityHub; diff --git a/node_modules/aws-sdk/clients/securityhub.js b/node_modules/aws-sdk/clients/securityhub.js new file mode 100644 index 0000000..458a88b --- /dev/null +++ b/node_modules/aws-sdk/clients/securityhub.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['securityhub'] = {}; +AWS.SecurityHub = Service.defineService('securityhub', ['2018-10-26']); +Object.defineProperty(apiLoader.services['securityhub'], '2018-10-26', { + get: function get() { + var model = require('../apis/securityhub-2018-10-26.min.json'); + model.paginators = require('../apis/securityhub-2018-10-26.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SecurityHub; diff --git a/node_modules/aws-sdk/clients/serverlessapplicationrepository.d.ts b/node_modules/aws-sdk/clients/serverlessapplicationrepository.d.ts new file mode 100644 index 0000000..6572939 --- /dev/null +++ b/node_modules/aws-sdk/clients/serverlessapplicationrepository.d.ts @@ -0,0 +1,1058 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ServerlessApplicationRepository extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ServerlessApplicationRepository.Types.ClientConfiguration) + config: Config & ServerlessApplicationRepository.Types.ClientConfiguration; + /** + * Creates an application, optionally including an AWS SAM file to create the first application version in the same call. + */ + createApplication(params: ServerlessApplicationRepository.Types.CreateApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationResponse) => void): Request; + /** + * Creates an application, optionally including an AWS SAM file to create the first application version in the same call. + */ + createApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationResponse) => void): Request; + /** + * Creates an application version. + */ + createApplicationVersion(params: ServerlessApplicationRepository.Types.CreateApplicationVersionRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationVersionResponse) => void): Request; + /** + * Creates an application version. + */ + createApplicationVersion(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateApplicationVersionResponse) => void): Request; + /** + * Creates an AWS CloudFormation change set for the given application. + */ + createCloudFormationChangeSet(params: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse) => void): Request; + /** + * Creates an AWS CloudFormation change set for the given application. + */ + createCloudFormationChangeSet(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationChangeSetResponse) => void): Request; + /** + * Creates an AWS CloudFormation template. + */ + createCloudFormationTemplate(params: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse) => void): Request; + /** + * Creates an AWS CloudFormation template. + */ + createCloudFormationTemplate(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.CreateCloudFormationTemplateResponse) => void): Request; + /** + * Deletes the specified application. + */ + deleteApplication(params: ServerlessApplicationRepository.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified application. + */ + deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets the specified application. + */ + getApplication(params: ServerlessApplicationRepository.Types.GetApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationResponse) => void): Request; + /** + * Gets the specified application. + */ + getApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationResponse) => void): Request; + /** + * Retrieves the policy for the application. + */ + getApplicationPolicy(params: ServerlessApplicationRepository.Types.GetApplicationPolicyRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationPolicyResponse) => void): Request; + /** + * Retrieves the policy for the application. + */ + getApplicationPolicy(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetApplicationPolicyResponse) => void): Request; + /** + * Gets the specified AWS CloudFormation template. + */ + getCloudFormationTemplate(params: ServerlessApplicationRepository.Types.GetCloudFormationTemplateRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse) => void): Request; + /** + * Gets the specified AWS CloudFormation template. + */ + getCloudFormationTemplate(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.GetCloudFormationTemplateResponse) => void): Request; + /** + * Retrieves the list of applications nested in the containing application. + */ + listApplicationDependencies(params: ServerlessApplicationRepository.Types.ListApplicationDependenciesRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse) => void): Request; + /** + * Retrieves the list of applications nested in the containing application. + */ + listApplicationDependencies(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationDependenciesResponse) => void): Request; + /** + * Lists versions for the specified application. + */ + listApplicationVersions(params: ServerlessApplicationRepository.Types.ListApplicationVersionsRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationVersionsResponse) => void): Request; + /** + * Lists versions for the specified application. + */ + listApplicationVersions(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationVersionsResponse) => void): Request; + /** + * Lists applications owned by the requester. + */ + listApplications(params: ServerlessApplicationRepository.Types.ListApplicationsRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationsResponse) => void): Request; + /** + * Lists applications owned by the requester. + */ + listApplications(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.ListApplicationsResponse) => void): Request; + /** + * Sets the permission policy for an application. For the list of actions supported for this operation, see + Application + Permissions + . + */ + putApplicationPolicy(params: ServerlessApplicationRepository.Types.PutApplicationPolicyRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.PutApplicationPolicyResponse) => void): Request; + /** + * Sets the permission policy for an application. For the list of actions supported for this operation, see + Application + Permissions + . + */ + putApplicationPolicy(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.PutApplicationPolicyResponse) => void): Request; + /** + * Updates the specified application. + */ + updateApplication(params: ServerlessApplicationRepository.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.UpdateApplicationResponse) => void): Request; + /** + * Updates the specified application. + */ + updateApplication(callback?: (err: AWSError, data: ServerlessApplicationRepository.Types.UpdateApplicationResponse) => void): Request; +} +declare namespace ServerlessApplicationRepository { + export interface ApplicationDependencySummary { + /** + * The Amazon Resource Name (ARN) of the nested application. + */ + ApplicationId: __string; + /** + * The semantic version of the nested application. + */ + SemanticVersion: __string; + } + export interface ApplicationPolicyStatement { + /** + * For the list of actions supported for this operation, see Application + Permissions. + */ + Actions: __listOf__string; + /** + * An array of AWS account IDs, or * to make the application public. + */ + Principals: __listOf__string; + /** + * A unique ID for the statement. + */ + StatementId?: __string; + } + export interface ApplicationSummary { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId: __string; + /** + * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + */ + Author: __string; + /** + * The date and time this resource was created. + */ + CreationTime?: __string; + /** + * The description of the application.Minimum length=1. Maximum length=256 + */ + Description: __string; + /** + * A URL with more information about the application, for example the location of your GitHub repository for the application. + */ + HomePageUrl?: __string; + /** + * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + */ + Labels?: __listOf__string; + /** + * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+"; + */ + Name: __string; + /** + * A valid identifier from https://spdx.org/licenses/. + */ + SpdxLicenseId?: __string; + } + export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|"CAPABILITY_RESOURCE_POLICY"|string; + export interface CreateApplicationRequest { + /** + * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + */ + Author: __string; + /** + * The description of the application.Minimum length=1. Maximum length=256 + */ + Description: __string; + /** + * A URL with more information about the application, for example the location of your GitHub repository for the application. + */ + HomePageUrl?: __string; + /** + * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + */ + Labels?: __listOf__string; + /** + * A local text file that contains the license of the app that matches the spdxLicenseID value of your application. + The file has the format file://<path>/<filename>.Maximum size 5 MBYou can specify only one of licenseBody and licenseUrl; otherwise, an error results. + */ + LicenseBody?: __string; + /** + * A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.Maximum size 5 MBYou can specify only one of licenseBody and licenseUrl; otherwise, an error results. + */ + LicenseUrl?: __string; + /** + * The name of the application that you want to publish.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+"; + */ + Name: __string; + /** + * A local text readme file in Markdown language that contains a more detailed description of the application and how it works. + The file has the format file://<path>/<filename>.Maximum size 5 MBYou can specify only one of readmeBody and readmeUrl; otherwise, an error results. + */ + ReadmeBody?: __string; + /** + * A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MBYou can specify only one of readmeBody and readmeUrl; otherwise, an error results. + */ + ReadmeUrl?: __string; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion?: __string; + /** + * A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB + */ + SourceCodeArchiveUrl?: __string; + /** + * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit. + */ + SourceCodeUrl?: __string; + /** + * A valid identifier from https://spdx.org/licenses/. + */ + SpdxLicenseId?: __string; + /** + * The local raw packaged AWS SAM template file of your application. + The file has the format file://<path>/<filename>.You can specify only one of templateBody and templateUrl; otherwise an error results. + */ + TemplateBody?: __string; + /** + * A link to the S3 object containing the packaged AWS SAM template of your application.You can specify only one of templateBody and templateUrl; otherwise an error results. + */ + TemplateUrl?: __string; + } + export interface CreateApplicationResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId?: __string; + /** + * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + */ + Author?: __string; + /** + * The date and time this resource was created. + */ + CreationTime?: __string; + /** + * The description of the application.Minimum length=1. Maximum length=256 + */ + Description?: __string; + /** + * A URL with more information about the application, for example the location of your GitHub repository for the application. + */ + HomePageUrl?: __string; + /** + * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + */ + Labels?: __listOf__string; + /** + * A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB + */ + LicenseUrl?: __string; + /** + * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+"; + */ + Name?: __string; + /** + * A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB + */ + ReadmeUrl?: __string; + /** + * A valid identifier from https://spdx.org/licenses/. + */ + SpdxLicenseId?: __string; + /** + * Version information about the application. + */ + Version?: Version; + } + export interface CreateApplicationVersionRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * The semantic version of the new version. + */ + SemanticVersion: __string; + /** + * A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB + */ + SourceCodeArchiveUrl?: __string; + /** + * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit. + */ + SourceCodeUrl?: __string; + /** + * The raw packaged AWS SAM template of your application. + */ + TemplateBody?: __string; + /** + * A link to the packaged AWS SAM template of your application. + */ + TemplateUrl?: __string; + } + export interface CreateApplicationVersionResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId?: __string; + /** + * The date and time this resource was created. + */ + CreationTime?: __string; + /** + * An array of parameter types supported by the application. + */ + ParameterDefinitions?: __listOfParameterDefinition; + /** + * A list of values that you must specify before you can deploy certain applications. + Some applications might include resources that can affect permissions in your AWS + account, for example, by creating new AWS Identity and Access Management (IAM) users. + For those applications, you must explicitly acknowledge their capabilities by + specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, + CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or + CAPABILITY_NAMED_IAM: + AWS::IAM::Group, + AWS::IAM::InstanceProfile, + AWS::IAM::Policy, and + AWS::IAM::Role. + If the application contains IAM resources, you can specify either CAPABILITY_IAM + or CAPABILITY_NAMED_IAM. If the application contains IAM resources + with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY: + AWS::Lambda::Permission, + AWS::IAM:Policy, + AWS::ApplicationAutoScaling::ScalingPolicy, + AWS::S3::BucketPolicy, + AWS::SQS::QueuePolicy, and + AWS::SNS::TopicPolicy.Applications that contain one or more nested applications require you to specify + CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review + all permissions associated with the application before deploying. If you don't specify + this parameter for an application that requires capabilities, the call will fail. + */ + RequiredCapabilities?: __listOfCapability; + /** + * Whether all of the AWS resources contained in this application are supported in the region + in which it is being retrieved. + */ + ResourcesSupported?: __boolean; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion?: __string; + /** + * A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB + */ + SourceCodeArchiveUrl?: __string; + /** + * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit. + */ + SourceCodeUrl?: __string; + /** + * A link to the packaged AWS SAM template of your application. + */ + TemplateUrl?: __string; + } + export interface CreateCloudFormationChangeSetRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * A list of values that you must specify before you can deploy certain applications. + Some applications might include resources that can affect permissions in your AWS + account, for example, by creating new AWS Identity and Access Management (IAM) users. + For those applications, you must explicitly acknowledge their capabilities by + specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, + CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or + CAPABILITY_NAMED_IAM: + AWS::IAM::Group, + AWS::IAM::InstanceProfile, + AWS::IAM::Policy, and + AWS::IAM::Role. + If the application contains IAM resources, you can specify either CAPABILITY_IAM + or CAPABILITY_NAMED_IAM. If the application contains IAM resources + with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY: + AWS::Lambda::Permission, + AWS::IAM:Policy, + AWS::ApplicationAutoScaling::ScalingPolicy, + AWS::S3::BucketPolicy, + AWS::SQS::QueuePolicy, and + AWS::SNS:TopicPolicy.Applications that contain one or more nested applications require you to specify + CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review + all permissions associated with the application before deploying. If you don't specify + this parameter for an application that requires capabilities, the call will fail. + */ + Capabilities?: __listOf__string; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + ChangeSetName?: __string; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + ClientToken?: __string; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + Description?: __string; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + NotificationArns?: __listOf__string; + /** + * A list of parameter values for the parameters of the application. + */ + ParameterOverrides?: __listOfParameterValue; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + ResourceTypes?: __listOf__string; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + RollbackConfiguration?: RollbackConfiguration; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion?: __string; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + StackName: __string; + /** + * This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet + API. + */ + Tags?: __listOfTag; + /** + * The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} + */ + TemplateId?: __string; + } + export interface CreateCloudFormationChangeSetResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId?: __string; + /** + * The Amazon Resource Name (ARN) of the change set.Length constraints: Minimum length of 1.Pattern: ARN:[-a-zA-Z0-9:/]* + */ + ChangeSetId?: __string; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion?: __string; + /** + * The unique ID of the stack. + */ + StackId?: __string; + } + export interface CreateCloudFormationTemplateRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion?: __string; + } + export interface CreateCloudFormationTemplateResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId?: __string; + /** + * The date and time this resource was created. + */ + CreationTime?: __string; + /** + * The date and time this template expires. Templates + expire 1 hour after creation. + */ + ExpirationTime?: __string; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion?: __string; + /** + * Status of the template creation workflow.Possible values: PREPARING | ACTIVE | EXPIRED + + */ + Status?: Status; + /** + * The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} + */ + TemplateId?: __string; + /** + * A link to the template that can be used to deploy the application using + AWS CloudFormation. + */ + TemplateUrl?: __string; + } + export interface DeleteApplicationRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + } + export interface GetApplicationPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + } + export interface GetApplicationPolicyResponse { + /** + * An array of policy statements applied to the application. + */ + Statements?: __listOfApplicationPolicyStatement; + } + export interface GetApplicationRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * The semantic version of the application to get. + */ + SemanticVersion?: __string; + } + export interface GetApplicationResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId?: __string; + /** + * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + */ + Author?: __string; + /** + * The date and time this resource was created. + */ + CreationTime?: __string; + /** + * The description of the application.Minimum length=1. Maximum length=256 + */ + Description?: __string; + /** + * A URL with more information about the application, for example the location of your GitHub repository for the application. + */ + HomePageUrl?: __string; + /** + * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + */ + Labels?: __listOf__string; + /** + * A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB + */ + LicenseUrl?: __string; + /** + * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+"; + */ + Name?: __string; + /** + * A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB + */ + ReadmeUrl?: __string; + /** + * A valid identifier from https://spdx.org/licenses/. + */ + SpdxLicenseId?: __string; + /** + * Version information about the application. + */ + Version?: Version; + } + export interface GetCloudFormationTemplateRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} + */ + TemplateId: __string; + } + export interface GetCloudFormationTemplateResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId?: __string; + /** + * The date and time this resource was created. + */ + CreationTime?: __string; + /** + * The date and time this template expires. Templates + expire 1 hour after creation. + */ + ExpirationTime?: __string; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion?: __string; + /** + * Status of the template creation workflow.Possible values: PREPARING | ACTIVE | EXPIRED + + */ + Status?: Status; + /** + * The UUID returned by CreateCloudFormationTemplate.Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} + */ + TemplateId?: __string; + /** + * A link to the template that can be used to deploy the application using + AWS CloudFormation. + */ + TemplateUrl?: __string; + } + export interface ListApplicationDependenciesRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * The total number of items to return. + */ + MaxItems?: MaxItems; + /** + * A token to specify where to start paginating. + */ + NextToken?: __string; + /** + * The semantic version of the application to get. + */ + SemanticVersion?: __string; + } + export interface ListApplicationDependenciesResponse { + /** + * An array of application summaries nested in the application. + */ + Dependencies?: __listOfApplicationDependencySummary; + /** + * The token to request the next page of results. + */ + NextToken?: __string; + } + export interface ListApplicationVersionsRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * The total number of items to return. + */ + MaxItems?: MaxItems; + /** + * A token to specify where to start paginating. + */ + NextToken?: __string; + } + export interface ListApplicationVersionsResponse { + /** + * The token to request the next page of results. + */ + NextToken?: __string; + /** + * An array of version summaries for the application. + */ + Versions?: __listOfVersionSummary; + } + export interface ListApplicationsRequest { + /** + * The total number of items to return. + */ + MaxItems?: MaxItems; + /** + * A token to specify where to start paginating. + */ + NextToken?: __string; + } + export interface ListApplicationsResponse { + /** + * An array of application summaries. + */ + Applications?: __listOfApplicationSummary; + /** + * The token to request the next page of results. + */ + NextToken?: __string; + } + export type MaxItems = number; + export interface ParameterDefinition { + /** + * A regular expression that represents the patterns to allow for String types. + */ + AllowedPattern?: __string; + /** + * An array containing the list of values allowed for the parameter. + */ + AllowedValues?: __listOf__string; + /** + * A string that explains a constraint when the constraint is violated. For example, without a constraint description, + a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user + specifies an invalid value: + Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+ + By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display + the following customized error message: + Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers. + + */ + ConstraintDescription?: __string; + /** + * A value of the appropriate type for the template to use if no value is specified when a stack is created. + If you define constraints for the parameter, you must specify a value that adheres to those constraints. + */ + DefaultValue?: __string; + /** + * A string of up to 4,000 characters that describes the parameter. + */ + Description?: __string; + /** + * An integer value that determines the largest number of characters that you want to allow for String types. + */ + MaxLength?: __integer; + /** + * A numeric value that determines the largest numeric value that you want to allow for Number types. + */ + MaxValue?: __integer; + /** + * An integer value that determines the smallest number of characters that you want to allow for String types. + */ + MinLength?: __integer; + /** + * A numeric value that determines the smallest numeric value that you want to allow for Number types. + */ + MinValue?: __integer; + /** + * The name of the parameter. + */ + Name: __string; + /** + * Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the + value to true, the parameter value is masked with asterisks (*****). + */ + NoEcho?: __boolean; + /** + * A list of AWS SAM resources that use this parameter. + */ + ReferencedByResources: __listOf__string; + /** + * The type of the parameter.Valid values: String | Number | List<Number> | CommaDelimitedList + + String: A literal string.For example, users can specify "MyUserName". + Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the + parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.For example, users might specify "8888". + List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when + you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.For example, users might specify "80,20", and then Ref results in ["80","20"]. + CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. + Also, each member string is space-trimmed.For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"]. + */ + Type?: __string; + } + export interface ParameterValue { + /** + * The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation + uses the default value that is specified in your template. + */ + Name: __string; + /** + * The input value associated with the parameter. + */ + Value: __string; + } + export interface PutApplicationPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * An array of policy statements applied to the application. + */ + Statements: __listOfApplicationPolicyStatement; + } + export interface PutApplicationPolicyResponse { + /** + * An array of policy statements applied to the application. + */ + Statements?: __listOfApplicationPolicyStatement; + } + export interface RollbackConfiguration { + /** + * This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration + Data Type. + */ + MonitoringTimeInMinutes?: __integer; + /** + * This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration + Data Type. + */ + RollbackTriggers?: __listOfRollbackTrigger; + } + export interface RollbackTrigger { + /** + * This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger + Data Type. + */ + Arn: __string; + /** + * This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger + Data Type. + */ + Type: __string; + } + export type Status = "PREPARING"|"ACTIVE"|"EXPIRED"|string; + export interface Tag { + /** + * This property corresponds to the content of the same name for the AWS CloudFormation Tag + Data Type. + */ + Key: __string; + /** + * This property corresponds to the content of the same name for the AWS CloudFormation + Tag + + Data Type. + */ + Value: __string; + } + export interface UpdateApplicationRequest { + /** + * The Amazon Resource Name (ARN) of the application. + */ + ApplicationId: __string; + /** + * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + */ + Author?: __string; + /** + * The description of the application.Minimum length=1. Maximum length=256 + */ + Description?: __string; + /** + * A URL with more information about the application, for example the location of your GitHub repository for the application. + */ + HomePageUrl?: __string; + /** + * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + */ + Labels?: __listOf__string; + /** + * A text readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB + */ + ReadmeBody?: __string; + /** + * A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB + */ + ReadmeUrl?: __string; + } + export interface UpdateApplicationResponse { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId?: __string; + /** + * The name of the author publishing the app.Minimum length=1. Maximum length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + */ + Author?: __string; + /** + * The date and time this resource was created. + */ + CreationTime?: __string; + /** + * The description of the application.Minimum length=1. Maximum length=256 + */ + Description?: __string; + /** + * A URL with more information about the application, for example the location of your GitHub repository for the application. + */ + HomePageUrl?: __string; + /** + * Labels to improve discovery of apps in search results.Minimum length=1. Maximum length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + */ + Labels?: __listOf__string; + /** + * A link to a license file of the app that matches the spdxLicenseID value of your application.Maximum size 5 MB + */ + LicenseUrl?: __string; + /** + * The name of the application.Minimum length=1. Maximum length=140Pattern: "[a-zA-Z0-9\\-]+"; + */ + Name?: __string; + /** + * A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.Maximum size 5 MB + */ + ReadmeUrl?: __string; + /** + * A valid identifier from https://spdx.org/licenses/. + */ + SpdxLicenseId?: __string; + /** + * Version information about the application. + */ + Version?: Version; + } + export interface Version { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId: __string; + /** + * The date and time this resource was created. + */ + CreationTime: __string; + /** + * An array of parameter types supported by the application. + */ + ParameterDefinitions: __listOfParameterDefinition; + /** + * A list of values that you must specify before you can deploy certain applications. + Some applications might include resources that can affect permissions in your AWS + account, for example, by creating new AWS Identity and Access Management (IAM) users. + For those applications, you must explicitly acknowledge their capabilities by + specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, + CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you to specify CAPABILITY_IAM or + CAPABILITY_NAMED_IAM: + AWS::IAM::Group, + AWS::IAM::InstanceProfile, + AWS::IAM::Policy, and + AWS::IAM::Role. + If the application contains IAM resources, you can specify either CAPABILITY_IAM + or CAPABILITY_NAMED_IAM. If the application contains IAM resources + with custom names, you must specify CAPABILITY_NAMED_IAM.The following resources require you to specify CAPABILITY_RESOURCE_POLICY: + AWS::Lambda::Permission, + AWS::IAM:Policy, + AWS::ApplicationAutoScaling::ScalingPolicy, + AWS::S3::BucketPolicy, + AWS::SQS::QueuePolicy, and + AWS::SNS::TopicPolicy.Applications that contain one or more nested applications require you to specify + CAPABILITY_AUTO_EXPAND.If your application template contains any of the above resources, we recommend that you review + all permissions associated with the application before deploying. If you don't specify + this parameter for an application that requires capabilities, the call will fail. + */ + RequiredCapabilities: __listOfCapability; + /** + * Whether all of the AWS resources contained in this application are supported in the region + in which it is being retrieved. + */ + ResourcesSupported: __boolean; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion: __string; + /** + * A link to the S3 object that contains the ZIP archive of the source code for this version of your application.Maximum size 50 MB + */ + SourceCodeArchiveUrl?: __string; + /** + * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit. + */ + SourceCodeUrl?: __string; + /** + * A link to the packaged AWS SAM template of your application. + */ + TemplateUrl: __string; + } + export interface VersionSummary { + /** + * The application Amazon Resource Name (ARN). + */ + ApplicationId: __string; + /** + * The date and time this resource was created. + */ + CreationTime: __string; + /** + * The semantic version of the application: + https://semver.org/ + + */ + SemanticVersion: __string; + /** + * A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit. + */ + SourceCodeUrl?: __string; + } + export type __boolean = boolean; + export type __integer = number; + export type __listOfApplicationDependencySummary = ApplicationDependencySummary[]; + export type __listOfApplicationPolicyStatement = ApplicationPolicyStatement[]; + export type __listOfApplicationSummary = ApplicationSummary[]; + export type __listOfCapability = Capability[]; + export type __listOfParameterDefinition = ParameterDefinition[]; + export type __listOfParameterValue = ParameterValue[]; + export type __listOfRollbackTrigger = RollbackTrigger[]; + export type __listOfTag = Tag[]; + export type __listOfVersionSummary = VersionSummary[]; + export type __listOf__string = __string[]; + export type __string = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-09-08"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ServerlessApplicationRepository client. + */ + export import Types = ServerlessApplicationRepository; +} +export = ServerlessApplicationRepository; diff --git a/node_modules/aws-sdk/clients/serverlessapplicationrepository.js b/node_modules/aws-sdk/clients/serverlessapplicationrepository.js new file mode 100644 index 0000000..660a368 --- /dev/null +++ b/node_modules/aws-sdk/clients/serverlessapplicationrepository.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['serverlessapplicationrepository'] = {}; +AWS.ServerlessApplicationRepository = Service.defineService('serverlessapplicationrepository', ['2017-09-08']); +Object.defineProperty(apiLoader.services['serverlessapplicationrepository'], '2017-09-08', { + get: function get() { + var model = require('../apis/serverlessrepo-2017-09-08.min.json'); + model.paginators = require('../apis/serverlessrepo-2017-09-08.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ServerlessApplicationRepository; diff --git a/node_modules/aws-sdk/clients/servicecatalog.d.ts b/node_modules/aws-sdk/clients/servicecatalog.d.ts new file mode 100644 index 0000000..457c325 --- /dev/null +++ b/node_modules/aws-sdk/clients/servicecatalog.d.ts @@ -0,0 +1,3873 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ServiceCatalog extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ServiceCatalog.Types.ClientConfiguration) + config: Config & ServiceCatalog.Types.ClientConfiguration; + /** + * Accepts an offer to share the specified portfolio. + */ + acceptPortfolioShare(params: ServiceCatalog.Types.AcceptPortfolioShareInput, callback?: (err: AWSError, data: ServiceCatalog.Types.AcceptPortfolioShareOutput) => void): Request; + /** + * Accepts an offer to share the specified portfolio. + */ + acceptPortfolioShare(callback?: (err: AWSError, data: ServiceCatalog.Types.AcceptPortfolioShareOutput) => void): Request; + /** + * Associates the specified budget with the specified resource. + */ + associateBudgetWithResource(params: ServiceCatalog.Types.AssociateBudgetWithResourceInput, callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateBudgetWithResourceOutput) => void): Request; + /** + * Associates the specified budget with the specified resource. + */ + associateBudgetWithResource(callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateBudgetWithResourceOutput) => void): Request; + /** + * Associates the specified principal ARN with the specified portfolio. + */ + associatePrincipalWithPortfolio(params: ServiceCatalog.Types.AssociatePrincipalWithPortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.AssociatePrincipalWithPortfolioOutput) => void): Request; + /** + * Associates the specified principal ARN with the specified portfolio. + */ + associatePrincipalWithPortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.AssociatePrincipalWithPortfolioOutput) => void): Request; + /** + * Associates the specified product with the specified portfolio. + */ + associateProductWithPortfolio(params: ServiceCatalog.Types.AssociateProductWithPortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateProductWithPortfolioOutput) => void): Request; + /** + * Associates the specified product with the specified portfolio. + */ + associateProductWithPortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateProductWithPortfolioOutput) => void): Request; + /** + * Associates a self-service action with a provisioning artifact. + */ + associateServiceActionWithProvisioningArtifact(params: ServiceCatalog.Types.AssociateServiceActionWithProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateServiceActionWithProvisioningArtifactOutput) => void): Request; + /** + * Associates a self-service action with a provisioning artifact. + */ + associateServiceActionWithProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateServiceActionWithProvisioningArtifactOutput) => void): Request; + /** + * Associate the specified TagOption with the specified portfolio or product. + */ + associateTagOptionWithResource(params: ServiceCatalog.Types.AssociateTagOptionWithResourceInput, callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateTagOptionWithResourceOutput) => void): Request; + /** + * Associate the specified TagOption with the specified portfolio or product. + */ + associateTagOptionWithResource(callback?: (err: AWSError, data: ServiceCatalog.Types.AssociateTagOptionWithResourceOutput) => void): Request; + /** + * Associates multiple self-service actions with provisioning artifacts. + */ + batchAssociateServiceActionWithProvisioningArtifact(params: ServiceCatalog.Types.BatchAssociateServiceActionWithProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.BatchAssociateServiceActionWithProvisioningArtifactOutput) => void): Request; + /** + * Associates multiple self-service actions with provisioning artifacts. + */ + batchAssociateServiceActionWithProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.BatchAssociateServiceActionWithProvisioningArtifactOutput) => void): Request; + /** + * Disassociates a batch of self-service actions from the specified provisioning artifact. + */ + batchDisassociateServiceActionFromProvisioningArtifact(params: ServiceCatalog.Types.BatchDisassociateServiceActionFromProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.BatchDisassociateServiceActionFromProvisioningArtifactOutput) => void): Request; + /** + * Disassociates a batch of self-service actions from the specified provisioning artifact. + */ + batchDisassociateServiceActionFromProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.BatchDisassociateServiceActionFromProvisioningArtifactOutput) => void): Request; + /** + * Copies the specified source product to the specified target product or a new product. You can copy a product to the same account or another account. You can copy a product to the same region or another region. This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus. + */ + copyProduct(params: ServiceCatalog.Types.CopyProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CopyProductOutput) => void): Request; + /** + * Copies the specified source product to the specified target product or a new product. You can copy a product to the same account or another account. You can copy a product to the same region or another region. This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus. + */ + copyProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.CopyProductOutput) => void): Request; + /** + * Creates a constraint. + */ + createConstraint(params: ServiceCatalog.Types.CreateConstraintInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreateConstraintOutput) => void): Request; + /** + * Creates a constraint. + */ + createConstraint(callback?: (err: AWSError, data: ServiceCatalog.Types.CreateConstraintOutput) => void): Request; + /** + * Creates a portfolio. + */ + createPortfolio(params: ServiceCatalog.Types.CreatePortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreatePortfolioOutput) => void): Request; + /** + * Creates a portfolio. + */ + createPortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.CreatePortfolioOutput) => void): Request; + /** + * Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. + */ + createPortfolioShare(params: ServiceCatalog.Types.CreatePortfolioShareInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreatePortfolioShareOutput) => void): Request; + /** + * Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. + */ + createPortfolioShare(callback?: (err: AWSError, data: ServiceCatalog.Types.CreatePortfolioShareOutput) => void): Request; + /** + * Creates a product. + */ + createProduct(params: ServiceCatalog.Types.CreateProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreateProductOutput) => void): Request; + /** + * Creates a product. + */ + createProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.CreateProductOutput) => void): Request; + /** + * Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed. You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED. To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan. + */ + createProvisionedProductPlan(params: ServiceCatalog.Types.CreateProvisionedProductPlanInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreateProvisionedProductPlanOutput) => void): Request; + /** + * Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed. You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED. To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan. + */ + createProvisionedProductPlan(callback?: (err: AWSError, data: ServiceCatalog.Types.CreateProvisionedProductPlanOutput) => void): Request; + /** + * Creates a provisioning artifact (also known as a version) for the specified product. You cannot create a provisioning artifact for a product that was shared with you. + */ + createProvisioningArtifact(params: ServiceCatalog.Types.CreateProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreateProvisioningArtifactOutput) => void): Request; + /** + * Creates a provisioning artifact (also known as a version) for the specified product. You cannot create a provisioning artifact for a product that was shared with you. + */ + createProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.CreateProvisioningArtifactOutput) => void): Request; + /** + * Creates a self-service action. + */ + createServiceAction(params: ServiceCatalog.Types.CreateServiceActionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreateServiceActionOutput) => void): Request; + /** + * Creates a self-service action. + */ + createServiceAction(callback?: (err: AWSError, data: ServiceCatalog.Types.CreateServiceActionOutput) => void): Request; + /** + * Creates a TagOption. + */ + createTagOption(params: ServiceCatalog.Types.CreateTagOptionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.CreateTagOptionOutput) => void): Request; + /** + * Creates a TagOption. + */ + createTagOption(callback?: (err: AWSError, data: ServiceCatalog.Types.CreateTagOptionOutput) => void): Request; + /** + * Deletes the specified constraint. + */ + deleteConstraint(params: ServiceCatalog.Types.DeleteConstraintInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteConstraintOutput) => void): Request; + /** + * Deletes the specified constraint. + */ + deleteConstraint(callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteConstraintOutput) => void): Request; + /** + * Deletes the specified portfolio. You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts. + */ + deletePortfolio(params: ServiceCatalog.Types.DeletePortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeletePortfolioOutput) => void): Request; + /** + * Deletes the specified portfolio. You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts. + */ + deletePortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.DeletePortfolioOutput) => void): Request; + /** + * Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the master account of an Organization. + */ + deletePortfolioShare(params: ServiceCatalog.Types.DeletePortfolioShareInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeletePortfolioShareOutput) => void): Request; + /** + * Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the master account of an Organization. + */ + deletePortfolioShare(callback?: (err: AWSError, data: ServiceCatalog.Types.DeletePortfolioShareOutput) => void): Request; + /** + * Deletes the specified product. You cannot delete a product if it was shared with you or is associated with a portfolio. + */ + deleteProduct(params: ServiceCatalog.Types.DeleteProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteProductOutput) => void): Request; + /** + * Deletes the specified product. You cannot delete a product if it was shared with you or is associated with a portfolio. + */ + deleteProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteProductOutput) => void): Request; + /** + * Deletes the specified plan. + */ + deleteProvisionedProductPlan(params: ServiceCatalog.Types.DeleteProvisionedProductPlanInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteProvisionedProductPlanOutput) => void): Request; + /** + * Deletes the specified plan. + */ + deleteProvisionedProductPlan(callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteProvisionedProductPlanOutput) => void): Request; + /** + * Deletes the specified provisioning artifact (also known as a version) for the specified product. You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact. + */ + deleteProvisioningArtifact(params: ServiceCatalog.Types.DeleteProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteProvisioningArtifactOutput) => void): Request; + /** + * Deletes the specified provisioning artifact (also known as a version) for the specified product. You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact. + */ + deleteProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteProvisioningArtifactOutput) => void): Request; + /** + * Deletes a self-service action. + */ + deleteServiceAction(params: ServiceCatalog.Types.DeleteServiceActionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteServiceActionOutput) => void): Request; + /** + * Deletes a self-service action. + */ + deleteServiceAction(callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteServiceActionOutput) => void): Request; + /** + * Deletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio. + */ + deleteTagOption(params: ServiceCatalog.Types.DeleteTagOptionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteTagOptionOutput) => void): Request; + /** + * Deletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio. + */ + deleteTagOption(callback?: (err: AWSError, data: ServiceCatalog.Types.DeleteTagOptionOutput) => void): Request; + /** + * Gets information about the specified constraint. + */ + describeConstraint(params: ServiceCatalog.Types.DescribeConstraintInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeConstraintOutput) => void): Request; + /** + * Gets information about the specified constraint. + */ + describeConstraint(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeConstraintOutput) => void): Request; + /** + * Gets the status of the specified copy product operation. + */ + describeCopyProductStatus(params: ServiceCatalog.Types.DescribeCopyProductStatusInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeCopyProductStatusOutput) => void): Request; + /** + * Gets the status of the specified copy product operation. + */ + describeCopyProductStatus(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeCopyProductStatusOutput) => void): Request; + /** + * Gets information about the specified portfolio. + */ + describePortfolio(params: ServiceCatalog.Types.DescribePortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribePortfolioOutput) => void): Request; + /** + * Gets information about the specified portfolio. + */ + describePortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribePortfolioOutput) => void): Request; + /** + * Gets the status of the specified portfolio share operation. This API can only be called by the master account in the organization. + */ + describePortfolioShareStatus(params: ServiceCatalog.Types.DescribePortfolioShareStatusInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribePortfolioShareStatusOutput) => void): Request; + /** + * Gets the status of the specified portfolio share operation. This API can only be called by the master account in the organization. + */ + describePortfolioShareStatus(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribePortfolioShareStatusOutput) => void): Request; + /** + * Gets information about the specified product. + */ + describeProduct(params: ServiceCatalog.Types.DescribeProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProductOutput) => void): Request; + /** + * Gets information about the specified product. + */ + describeProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProductOutput) => void): Request; + /** + * Gets information about the specified product. This operation is run with administrator access. + */ + describeProductAsAdmin(params: ServiceCatalog.Types.DescribeProductAsAdminInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProductAsAdminOutput) => void): Request; + /** + * Gets information about the specified product. This operation is run with administrator access. + */ + describeProductAsAdmin(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProductAsAdminOutput) => void): Request; + /** + * Gets information about the specified product. + */ + describeProductView(params: ServiceCatalog.Types.DescribeProductViewInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProductViewOutput) => void): Request; + /** + * Gets information about the specified product. + */ + describeProductView(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProductViewOutput) => void): Request; + /** + * Gets information about the specified provisioned product. + */ + describeProvisionedProduct(params: ServiceCatalog.Types.DescribeProvisionedProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisionedProductOutput) => void): Request; + /** + * Gets information about the specified provisioned product. + */ + describeProvisionedProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisionedProductOutput) => void): Request; + /** + * Gets information about the resource changes for the specified plan. + */ + describeProvisionedProductPlan(params: ServiceCatalog.Types.DescribeProvisionedProductPlanInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisionedProductPlanOutput) => void): Request; + /** + * Gets information about the resource changes for the specified plan. + */ + describeProvisionedProductPlan(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisionedProductPlanOutput) => void): Request; + /** + * Gets information about the specified provisioning artifact (also known as a version) for the specified product. + */ + describeProvisioningArtifact(params: ServiceCatalog.Types.DescribeProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisioningArtifactOutput) => void): Request; + /** + * Gets information about the specified provisioning artifact (also known as a version) for the specified product. + */ + describeProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisioningArtifactOutput) => void): Request; + /** + * Gets information about the configuration required to provision the specified product using the specified provisioning artifact. If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId. + */ + describeProvisioningParameters(params: ServiceCatalog.Types.DescribeProvisioningParametersInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisioningParametersOutput) => void): Request; + /** + * Gets information about the configuration required to provision the specified product using the specified provisioning artifact. If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId. + */ + describeProvisioningParameters(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeProvisioningParametersOutput) => void): Request; + /** + * Gets information about the specified request operation. Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct). + */ + describeRecord(params: ServiceCatalog.Types.DescribeRecordInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeRecordOutput) => void): Request; + /** + * Gets information about the specified request operation. Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct). + */ + describeRecord(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeRecordOutput) => void): Request; + /** + * Describes a self-service action. + */ + describeServiceAction(params: ServiceCatalog.Types.DescribeServiceActionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeServiceActionOutput) => void): Request; + /** + * Describes a self-service action. + */ + describeServiceAction(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeServiceActionOutput) => void): Request; + /** + * Gets information about the specified TagOption. + */ + describeTagOption(params: ServiceCatalog.Types.DescribeTagOptionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeTagOptionOutput) => void): Request; + /** + * Gets information about the specified TagOption. + */ + describeTagOption(callback?: (err: AWSError, data: ServiceCatalog.Types.DescribeTagOptionOutput) => void): Request; + /** + * Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the master account in the organization. + */ + disableAWSOrganizationsAccess(params: ServiceCatalog.Types.DisableAWSOrganizationsAccessInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DisableAWSOrganizationsAccessOutput) => void): Request; + /** + * Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the master account in the organization. + */ + disableAWSOrganizationsAccess(callback?: (err: AWSError, data: ServiceCatalog.Types.DisableAWSOrganizationsAccessOutput) => void): Request; + /** + * Disassociates the specified budget from the specified resource. + */ + disassociateBudgetFromResource(params: ServiceCatalog.Types.DisassociateBudgetFromResourceInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateBudgetFromResourceOutput) => void): Request; + /** + * Disassociates the specified budget from the specified resource. + */ + disassociateBudgetFromResource(callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateBudgetFromResourceOutput) => void): Request; + /** + * Disassociates a previously associated principal ARN from a specified portfolio. + */ + disassociatePrincipalFromPortfolio(params: ServiceCatalog.Types.DisassociatePrincipalFromPortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociatePrincipalFromPortfolioOutput) => void): Request; + /** + * Disassociates a previously associated principal ARN from a specified portfolio. + */ + disassociatePrincipalFromPortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociatePrincipalFromPortfolioOutput) => void): Request; + /** + * Disassociates the specified product from the specified portfolio. + */ + disassociateProductFromPortfolio(params: ServiceCatalog.Types.DisassociateProductFromPortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateProductFromPortfolioOutput) => void): Request; + /** + * Disassociates the specified product from the specified portfolio. + */ + disassociateProductFromPortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateProductFromPortfolioOutput) => void): Request; + /** + * Disassociates the specified self-service action association from the specified provisioning artifact. + */ + disassociateServiceActionFromProvisioningArtifact(params: ServiceCatalog.Types.DisassociateServiceActionFromProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateServiceActionFromProvisioningArtifactOutput) => void): Request; + /** + * Disassociates the specified self-service action association from the specified provisioning artifact. + */ + disassociateServiceActionFromProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateServiceActionFromProvisioningArtifactOutput) => void): Request; + /** + * Disassociates the specified TagOption from the specified resource. + */ + disassociateTagOptionFromResource(params: ServiceCatalog.Types.DisassociateTagOptionFromResourceInput, callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateTagOptionFromResourceOutput) => void): Request; + /** + * Disassociates the specified TagOption from the specified resource. + */ + disassociateTagOptionFromResource(callback?: (err: AWSError, data: ServiceCatalog.Types.DisassociateTagOptionFromResourceOutput) => void): Request; + /** + * Enable portfolio sharing feature through AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the master account in the organization. By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure. + */ + enableAWSOrganizationsAccess(params: ServiceCatalog.Types.EnableAWSOrganizationsAccessInput, callback?: (err: AWSError, data: ServiceCatalog.Types.EnableAWSOrganizationsAccessOutput) => void): Request; + /** + * Enable portfolio sharing feature through AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the master account in the organization. By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure. + */ + enableAWSOrganizationsAccess(callback?: (err: AWSError, data: ServiceCatalog.Types.EnableAWSOrganizationsAccessOutput) => void): Request; + /** + * Provisions or modifies a product based on the resource changes for the specified plan. + */ + executeProvisionedProductPlan(params: ServiceCatalog.Types.ExecuteProvisionedProductPlanInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ExecuteProvisionedProductPlanOutput) => void): Request; + /** + * Provisions or modifies a product based on the resource changes for the specified plan. + */ + executeProvisionedProductPlan(callback?: (err: AWSError, data: ServiceCatalog.Types.ExecuteProvisionedProductPlanOutput) => void): Request; + /** + * Executes a self-service action against a provisioned product. + */ + executeProvisionedProductServiceAction(params: ServiceCatalog.Types.ExecuteProvisionedProductServiceActionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ExecuteProvisionedProductServiceActionOutput) => void): Request; + /** + * Executes a self-service action against a provisioned product. + */ + executeProvisionedProductServiceAction(callback?: (err: AWSError, data: ServiceCatalog.Types.ExecuteProvisionedProductServiceActionOutput) => void): Request; + /** + * Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the master account in the organization. + */ + getAWSOrganizationsAccessStatus(params: ServiceCatalog.Types.GetAWSOrganizationsAccessStatusInput, callback?: (err: AWSError, data: ServiceCatalog.Types.GetAWSOrganizationsAccessStatusOutput) => void): Request; + /** + * Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the master account in the organization. + */ + getAWSOrganizationsAccessStatus(callback?: (err: AWSError, data: ServiceCatalog.Types.GetAWSOrganizationsAccessStatusOutput) => void): Request; + /** + * Lists all portfolios for which sharing was accepted by this account. + */ + listAcceptedPortfolioShares(params: ServiceCatalog.Types.ListAcceptedPortfolioSharesInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListAcceptedPortfolioSharesOutput) => void): Request; + /** + * Lists all portfolios for which sharing was accepted by this account. + */ + listAcceptedPortfolioShares(callback?: (err: AWSError, data: ServiceCatalog.Types.ListAcceptedPortfolioSharesOutput) => void): Request; + /** + * Lists all the budgets associated to the specified resource. + */ + listBudgetsForResource(params: ServiceCatalog.Types.ListBudgetsForResourceInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListBudgetsForResourceOutput) => void): Request; + /** + * Lists all the budgets associated to the specified resource. + */ + listBudgetsForResource(callback?: (err: AWSError, data: ServiceCatalog.Types.ListBudgetsForResourceOutput) => void): Request; + /** + * Lists the constraints for the specified portfolio and product. + */ + listConstraintsForPortfolio(params: ServiceCatalog.Types.ListConstraintsForPortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListConstraintsForPortfolioOutput) => void): Request; + /** + * Lists the constraints for the specified portfolio and product. + */ + listConstraintsForPortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.ListConstraintsForPortfolioOutput) => void): Request; + /** + * Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product. + */ + listLaunchPaths(params: ServiceCatalog.Types.ListLaunchPathsInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListLaunchPathsOutput) => void): Request; + /** + * Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product. + */ + listLaunchPaths(callback?: (err: AWSError, data: ServiceCatalog.Types.ListLaunchPathsOutput) => void): Request; + /** + * Lists the organization nodes that have access to the specified portfolio. This API can only be called by the master account in the organization. + */ + listOrganizationPortfolioAccess(params: ServiceCatalog.Types.ListOrganizationPortfolioAccessInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListOrganizationPortfolioAccessOutput) => void): Request; + /** + * Lists the organization nodes that have access to the specified portfolio. This API can only be called by the master account in the organization. + */ + listOrganizationPortfolioAccess(callback?: (err: AWSError, data: ServiceCatalog.Types.ListOrganizationPortfolioAccessOutput) => void): Request; + /** + * Lists the account IDs that have access to the specified portfolio. + */ + listPortfolioAccess(params: ServiceCatalog.Types.ListPortfolioAccessInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListPortfolioAccessOutput) => void): Request; + /** + * Lists the account IDs that have access to the specified portfolio. + */ + listPortfolioAccess(callback?: (err: AWSError, data: ServiceCatalog.Types.ListPortfolioAccessOutput) => void): Request; + /** + * Lists all portfolios in the catalog. + */ + listPortfolios(params: ServiceCatalog.Types.ListPortfoliosInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListPortfoliosOutput) => void): Request; + /** + * Lists all portfolios in the catalog. + */ + listPortfolios(callback?: (err: AWSError, data: ServiceCatalog.Types.ListPortfoliosOutput) => void): Request; + /** + * Lists all portfolios that the specified product is associated with. + */ + listPortfoliosForProduct(params: ServiceCatalog.Types.ListPortfoliosForProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListPortfoliosForProductOutput) => void): Request; + /** + * Lists all portfolios that the specified product is associated with. + */ + listPortfoliosForProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.ListPortfoliosForProductOutput) => void): Request; + /** + * Lists all principal ARNs associated with the specified portfolio. + */ + listPrincipalsForPortfolio(params: ServiceCatalog.Types.ListPrincipalsForPortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListPrincipalsForPortfolioOutput) => void): Request; + /** + * Lists all principal ARNs associated with the specified portfolio. + */ + listPrincipalsForPortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.ListPrincipalsForPortfolioOutput) => void): Request; + /** + * Lists the plans for the specified provisioned product or all plans to which the user has access. + */ + listProvisionedProductPlans(params: ServiceCatalog.Types.ListProvisionedProductPlansInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListProvisionedProductPlansOutput) => void): Request; + /** + * Lists the plans for the specified provisioned product or all plans to which the user has access. + */ + listProvisionedProductPlans(callback?: (err: AWSError, data: ServiceCatalog.Types.ListProvisionedProductPlansOutput) => void): Request; + /** + * Lists all provisioning artifacts (also known as versions) for the specified product. + */ + listProvisioningArtifacts(params: ServiceCatalog.Types.ListProvisioningArtifactsInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListProvisioningArtifactsOutput) => void): Request; + /** + * Lists all provisioning artifacts (also known as versions) for the specified product. + */ + listProvisioningArtifacts(callback?: (err: AWSError, data: ServiceCatalog.Types.ListProvisioningArtifactsOutput) => void): Request; + /** + * Lists all provisioning artifacts (also known as versions) for the specified self-service action. + */ + listProvisioningArtifactsForServiceAction(params: ServiceCatalog.Types.ListProvisioningArtifactsForServiceActionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListProvisioningArtifactsForServiceActionOutput) => void): Request; + /** + * Lists all provisioning artifacts (also known as versions) for the specified self-service action. + */ + listProvisioningArtifactsForServiceAction(callback?: (err: AWSError, data: ServiceCatalog.Types.ListProvisioningArtifactsForServiceActionOutput) => void): Request; + /** + * Lists the specified requests or all performed requests. + */ + listRecordHistory(params: ServiceCatalog.Types.ListRecordHistoryInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListRecordHistoryOutput) => void): Request; + /** + * Lists the specified requests or all performed requests. + */ + listRecordHistory(callback?: (err: AWSError, data: ServiceCatalog.Types.ListRecordHistoryOutput) => void): Request; + /** + * Lists the resources associated with the specified TagOption. + */ + listResourcesForTagOption(params: ServiceCatalog.Types.ListResourcesForTagOptionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListResourcesForTagOptionOutput) => void): Request; + /** + * Lists the resources associated with the specified TagOption. + */ + listResourcesForTagOption(callback?: (err: AWSError, data: ServiceCatalog.Types.ListResourcesForTagOptionOutput) => void): Request; + /** + * Lists all self-service actions. + */ + listServiceActions(params: ServiceCatalog.Types.ListServiceActionsInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListServiceActionsOutput) => void): Request; + /** + * Lists all self-service actions. + */ + listServiceActions(callback?: (err: AWSError, data: ServiceCatalog.Types.ListServiceActionsOutput) => void): Request; + /** + * Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID. + */ + listServiceActionsForProvisioningArtifact(params: ServiceCatalog.Types.ListServiceActionsForProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListServiceActionsForProvisioningArtifactOutput) => void): Request; + /** + * Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID. + */ + listServiceActionsForProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.ListServiceActionsForProvisioningArtifactOutput) => void): Request; + /** + * Lists the specified TagOptions or all TagOptions. + */ + listTagOptions(params: ServiceCatalog.Types.ListTagOptionsInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ListTagOptionsOutput) => void): Request; + /** + * Lists the specified TagOptions or all TagOptions. + */ + listTagOptions(callback?: (err: AWSError, data: ServiceCatalog.Types.ListTagOptionsOutput) => void): Request; + /** + * Provisions the specified product. A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord. If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". + */ + provisionProduct(params: ServiceCatalog.Types.ProvisionProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ProvisionProductOutput) => void): Request; + /** + * Provisions the specified product. A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord. If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". + */ + provisionProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.ProvisionProductOutput) => void): Request; + /** + * Rejects an offer to share the specified portfolio. + */ + rejectPortfolioShare(params: ServiceCatalog.Types.RejectPortfolioShareInput, callback?: (err: AWSError, data: ServiceCatalog.Types.RejectPortfolioShareOutput) => void): Request; + /** + * Rejects an offer to share the specified portfolio. + */ + rejectPortfolioShare(callback?: (err: AWSError, data: ServiceCatalog.Types.RejectPortfolioShareOutput) => void): Request; + /** + * Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts. + */ + scanProvisionedProducts(params: ServiceCatalog.Types.ScanProvisionedProductsInput, callback?: (err: AWSError, data: ServiceCatalog.Types.ScanProvisionedProductsOutput) => void): Request; + /** + * Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts. + */ + scanProvisionedProducts(callback?: (err: AWSError, data: ServiceCatalog.Types.ScanProvisionedProductsOutput) => void): Request; + /** + * Gets information about the products to which the caller has access. + */ + searchProducts(params: ServiceCatalog.Types.SearchProductsInput, callback?: (err: AWSError, data: ServiceCatalog.Types.SearchProductsOutput) => void): Request; + /** + * Gets information about the products to which the caller has access. + */ + searchProducts(callback?: (err: AWSError, data: ServiceCatalog.Types.SearchProductsOutput) => void): Request; + /** + * Gets information about the products for the specified portfolio or all products. + */ + searchProductsAsAdmin(params: ServiceCatalog.Types.SearchProductsAsAdminInput, callback?: (err: AWSError, data: ServiceCatalog.Types.SearchProductsAsAdminOutput) => void): Request; + /** + * Gets information about the products for the specified portfolio or all products. + */ + searchProductsAsAdmin(callback?: (err: AWSError, data: ServiceCatalog.Types.SearchProductsAsAdminOutput) => void): Request; + /** + * Gets information about the provisioned products that meet the specified criteria. + */ + searchProvisionedProducts(params: ServiceCatalog.Types.SearchProvisionedProductsInput, callback?: (err: AWSError, data: ServiceCatalog.Types.SearchProvisionedProductsOutput) => void): Request; + /** + * Gets information about the provisioned products that meet the specified criteria. + */ + searchProvisionedProducts(callback?: (err: AWSError, data: ServiceCatalog.Types.SearchProvisionedProductsOutput) => void): Request; + /** + * Terminates the specified provisioned product. This operation does not delete any records associated with the provisioned product. You can check the status of this request using DescribeRecord. + */ + terminateProvisionedProduct(params: ServiceCatalog.Types.TerminateProvisionedProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.TerminateProvisionedProductOutput) => void): Request; + /** + * Terminates the specified provisioned product. This operation does not delete any records associated with the provisioned product. You can check the status of this request using DescribeRecord. + */ + terminateProvisionedProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.TerminateProvisionedProductOutput) => void): Request; + /** + * Updates the specified constraint. + */ + updateConstraint(params: ServiceCatalog.Types.UpdateConstraintInput, callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateConstraintOutput) => void): Request; + /** + * Updates the specified constraint. + */ + updateConstraint(callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateConstraintOutput) => void): Request; + /** + * Updates the specified portfolio. You cannot update a product that was shared with you. + */ + updatePortfolio(params: ServiceCatalog.Types.UpdatePortfolioInput, callback?: (err: AWSError, data: ServiceCatalog.Types.UpdatePortfolioOutput) => void): Request; + /** + * Updates the specified portfolio. You cannot update a product that was shared with you. + */ + updatePortfolio(callback?: (err: AWSError, data: ServiceCatalog.Types.UpdatePortfolioOutput) => void): Request; + /** + * Updates the specified product. + */ + updateProduct(params: ServiceCatalog.Types.UpdateProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateProductOutput) => void): Request; + /** + * Updates the specified product. + */ + updateProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateProductOutput) => void): Request; + /** + * Requests updates to the configuration of the specified provisioned product. If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely. You can check the status of this request using DescribeRecord. + */ + updateProvisionedProduct(params: ServiceCatalog.Types.UpdateProvisionedProductInput, callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateProvisionedProductOutput) => void): Request; + /** + * Requests updates to the configuration of the specified provisioned product. If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely. You can check the status of this request using DescribeRecord. + */ + updateProvisionedProduct(callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateProvisionedProductOutput) => void): Request; + /** + * Updates the specified provisioning artifact (also known as a version) for the specified product. You cannot update a provisioning artifact for a product that was shared with you. + */ + updateProvisioningArtifact(params: ServiceCatalog.Types.UpdateProvisioningArtifactInput, callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateProvisioningArtifactOutput) => void): Request; + /** + * Updates the specified provisioning artifact (also known as a version) for the specified product. You cannot update a provisioning artifact for a product that was shared with you. + */ + updateProvisioningArtifact(callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateProvisioningArtifactOutput) => void): Request; + /** + * Updates a self-service action. + */ + updateServiceAction(params: ServiceCatalog.Types.UpdateServiceActionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateServiceActionOutput) => void): Request; + /** + * Updates a self-service action. + */ + updateServiceAction(callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateServiceActionOutput) => void): Request; + /** + * Updates the specified TagOption. + */ + updateTagOption(params: ServiceCatalog.Types.UpdateTagOptionInput, callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateTagOptionOutput) => void): Request; + /** + * Updates the specified TagOption. + */ + updateTagOption(callback?: (err: AWSError, data: ServiceCatalog.Types.UpdateTagOptionOutput) => void): Request; +} +declare namespace ServiceCatalog { + export type AcceptLanguage = string; + export interface AcceptPortfolioShareInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The type of shared portfolios to accept. The default is to accept imported portfolios. AWS_ORGANIZATIONS - Accept portfolios shared by the master account of your organization. IMPORTED - Accept imported portfolios. AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) For example, aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS + */ + PortfolioShareType?: PortfolioShareType; + } + export interface AcceptPortfolioShareOutput { + } + export interface AccessLevelFilter { + /** + * The access level. Account - Filter results based on the account. Role - Filter results based on the federated role of the specified user. User - Filter results based on the specified user. + */ + Key?: AccessLevelFilterKey; + /** + * The user to which the access level applies. The only supported value is Self. + */ + Value?: AccessLevelFilterValue; + } + export type AccessLevelFilterKey = "Account"|"Role"|"User"|string; + export type AccessLevelFilterValue = string; + export type AccessStatus = "ENABLED"|"UNDER_CHANGE"|"DISABLED"|string; + export type AccountId = string; + export type AccountIds = AccountId[]; + export type AddTags = Tag[]; + export type AllowedValue = string; + export type AllowedValues = AllowedValue[]; + export type ApproximateCount = number; + export interface AssociateBudgetWithResourceInput { + /** + * The name of the budget you want to associate. + */ + BudgetName: BudgetName; + /** + * The resource identifier. Either a portfolio-id or a product-id. + */ + ResourceId: Id; + } + export interface AssociateBudgetWithResourceOutput { + } + export interface AssociatePrincipalWithPortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The ARN of the principal (IAM user, role, or group). + */ + PrincipalARN: PrincipalARN; + /** + * The principal type. The supported value is IAM. + */ + PrincipalType: PrincipalType; + } + export interface AssociatePrincipalWithPortfolioOutput { + } + export interface AssociateProductWithPortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The identifier of the source portfolio. + */ + SourcePortfolioId?: Id; + } + export interface AssociateProductWithPortfolioOutput { + } + export interface AssociateServiceActionWithProvisioningArtifactInput { + /** + * The product identifier. For example, prod-abcdzk7xy33qa. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + */ + ProvisioningArtifactId: Id; + /** + * The self-service action identifier. For example, act-fs7abcd89wxyz. + */ + ServiceActionId: Id; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface AssociateServiceActionWithProvisioningArtifactOutput { + } + export interface AssociateTagOptionWithResourceInput { + /** + * The resource identifier. + */ + ResourceId: ResourceId; + /** + * The TagOption identifier. + */ + TagOptionId: TagOptionId; + } + export interface AssociateTagOptionWithResourceOutput { + } + export type AttributeValue = string; + export interface BatchAssociateServiceActionWithProvisioningArtifactInput { + /** + * One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID. + */ + ServiceActionAssociations: ServiceActionAssociations; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface BatchAssociateServiceActionWithProvisioningArtifactOutput { + /** + * An object that contains a list of errors, along with information to help you identify the self-service action. + */ + FailedServiceActionAssociations?: FailedServiceActionAssociations; + } + export interface BatchDisassociateServiceActionFromProvisioningArtifactInput { + /** + * One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID. + */ + ServiceActionAssociations: ServiceActionAssociations; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface BatchDisassociateServiceActionFromProvisioningArtifactOutput { + /** + * An object that contains a list of errors, along with information to help you identify the self-service action. + */ + FailedServiceActionAssociations?: FailedServiceActionAssociations; + } + export interface BudgetDetail { + /** + * Name of the associated budget. + */ + BudgetName?: BudgetName; + } + export type BudgetName = string; + export type Budgets = BudgetDetail[]; + export type CausingEntity = string; + export type ChangeAction = "ADD"|"MODIFY"|"REMOVE"|string; + export interface CloudWatchDashboard { + /** + * The name of the CloudWatch dashboard. + */ + Name?: CloudWatchDashboardName; + } + export type CloudWatchDashboardName = string; + export type CloudWatchDashboards = CloudWatchDashboard[]; + export type ConstraintDescription = string; + export interface ConstraintDetail { + /** + * The identifier of the constraint. + */ + ConstraintId?: Id; + /** + * The type of constraint. LAUNCH NOTIFICATION STACKSET TEMPLATE + */ + Type?: ConstraintType; + /** + * The description of the constraint. + */ + Description?: ConstraintDescription; + /** + * The owner of the constraint. + */ + Owner?: AccountId; + } + export type ConstraintDetails = ConstraintDetail[]; + export type ConstraintParameters = string; + export type ConstraintSummaries = ConstraintSummary[]; + export interface ConstraintSummary { + /** + * The type of constraint. LAUNCH NOTIFICATION STACKSET TEMPLATE + */ + Type?: ConstraintType; + /** + * The description of the constraint. + */ + Description?: ConstraintDescription; + } + export type ConstraintType = string; + export type CopyOption = "CopyTags"|string; + export type CopyOptions = CopyOption[]; + export interface CopyProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The Amazon Resource Name (ARN) of the source product. + */ + SourceProductArn: ProductArn; + /** + * The identifier of the target product. By default, a new product is created. + */ + TargetProductId?: Id; + /** + * A name for the target product. The default is the name of the source product. + */ + TargetProductName?: ProductViewName; + /** + * The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied. + */ + SourceProvisioningArtifactIdentifiers?: SourceProvisioningArtifactProperties; + /** + * The copy options. If the value is CopyTags, the tags from the source product are copied to the target product. + */ + CopyOptions?: CopyOptions; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CopyProductOutput { + /** + * The token to use to track the progress of the operation. + */ + CopyProductToken?: Id; + } + export type CopyProductStatus = "SUCCEEDED"|"IN_PROGRESS"|"FAILED"|string; + export interface CreateConstraintInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The constraint parameters, in JSON format. The syntax depends on the constraint type as follows: LAUNCH Specify the RoleArn property as follows: {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"} You cannot have both a LAUNCH and a STACKSET constraint. You also cannot have more than one LAUNCH constraint on a product and portfolio. NOTIFICATION Specify the NotificationArns property as follows: {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} RESOURCE_UPDATE Specify the TagUpdatesOnProvisionedProduct property as follows: {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}} The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED. STACKSET Specify the Parameters property as follows: {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}} You cannot have both a LAUNCH and a STACKSET constraint. You also cannot have more than one STACKSET constraint on a product and portfolio. Products with a STACKSET constraint will launch an AWS CloudFormation stack set. TEMPLATE Specify the Rules property. For more information, see Template Constraint Rules. + */ + Parameters: ConstraintParameters; + /** + * The type of constraint. LAUNCH NOTIFICATION RESOURCE_UPDATE STACKSET TEMPLATE + */ + Type: ConstraintType; + /** + * The description of the constraint. + */ + Description?: ConstraintDescription; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreateConstraintOutput { + /** + * Information about the constraint. + */ + ConstraintDetail?: ConstraintDetail; + /** + * The constraint parameters. + */ + ConstraintParameters?: ConstraintParameters; + /** + * The status of the current request. + */ + Status?: Status; + } + export interface CreatePortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The name to use for display purposes. + */ + DisplayName: PortfolioDisplayName; + /** + * The description of the portfolio. + */ + Description?: PortfolioDescription; + /** + * The name of the portfolio provider. + */ + ProviderName: ProviderName; + /** + * One or more tags. + */ + Tags?: AddTags; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreatePortfolioOutput { + /** + * Information about the portfolio. + */ + PortfolioDetail?: PortfolioDetail; + /** + * Information about the tags associated with the portfolio. + */ + Tags?: Tags; + } + export interface CreatePortfolioShareInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The AWS account ID. For example, 123456789012. + */ + AccountId?: AccountId; + /** + * The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node and its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process. + */ + OrganizationNode?: OrganizationNode; + } + export interface CreatePortfolioShareOutput { + /** + * The portfolio share unique identifier. This will only be returned if portfolio is shared to an organization node. + */ + PortfolioShareToken?: Id; + } + export interface CreateProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The name of the product. + */ + Name: ProductViewName; + /** + * The owner of the product. + */ + Owner: ProductViewOwner; + /** + * The description of the product. + */ + Description?: ProductViewShortDescription; + /** + * The distributor of the product. + */ + Distributor?: ProductViewOwner; + /** + * The support information about the product. + */ + SupportDescription?: SupportDescription; + /** + * The contact email for product support. + */ + SupportEmail?: SupportEmail; + /** + * The contact URL for product support. + */ + SupportUrl?: SupportUrl; + /** + * The type of product. + */ + ProductType: ProductType; + /** + * One or more tags. + */ + Tags?: AddTags; + /** + * The configuration of the provisioning artifact. + */ + ProvisioningArtifactParameters: ProvisioningArtifactProperties; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreateProductOutput { + /** + * Information about the product view. + */ + ProductViewDetail?: ProductViewDetail; + /** + * Information about the provisioning artifact. + */ + ProvisioningArtifactDetail?: ProvisioningArtifactDetail; + /** + * Information about the tags associated with the product. + */ + Tags?: Tags; + } + export interface CreateProvisionedProductPlanInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The name of the plan. + */ + PlanName: ProvisionedProductPlanName; + /** + * The plan type. + */ + PlanType: ProvisionedProductPlanType; + /** + * Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. + */ + NotificationArns?: NotificationArns; + /** + * The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. + */ + PathId?: Id; + /** + * The product identifier. + */ + ProductId: Id; + /** + * A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned. + */ + ProvisionedProductName: ProvisionedProductName; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId: Id; + /** + * Parameters specified by the administrator that are required for provisioning the product. + */ + ProvisioningParameters?: UpdateProvisioningParameters; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + /** + * One or more tags. + */ + Tags?: Tags; + } + export interface CreateProvisionedProductPlanOutput { + /** + * The name of the plan. + */ + PlanName?: ProvisionedProductPlanName; + /** + * The plan identifier. + */ + PlanId?: Id; + /** + * The product identifier. + */ + ProvisionProductId?: Id; + /** + * The user-friendly name of the provisioned product. + */ + ProvisionedProductName?: ProvisionedProductName; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId?: Id; + } + export interface CreateProvisioningArtifactInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The configuration for the provisioning artifact. + */ + Parameters: ProvisioningArtifactProperties; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreateProvisioningArtifactOutput { + /** + * Information about the provisioning artifact. + */ + ProvisioningArtifactDetail?: ProvisioningArtifactDetail; + /** + * The URL of the CloudFormation template in Amazon S3, in JSON format. + */ + Info?: ProvisioningArtifactInfo; + /** + * The status of the current request. + */ + Status?: Status; + } + export interface CreateServiceActionInput { + /** + * The self-service action name. + */ + Name: ServiceActionName; + /** + * The service action definition type. For example, SSM_AUTOMATION. + */ + DefinitionType: ServiceActionDefinitionType; + /** + * The self-service action definition. Can be one of the following: Name The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance. Version The AWS Systems Manager automation document version. For example, "Version": "1" AssumeRole The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole". To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE". Parameters The list of parameters in JSON format. For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}]. + */ + Definition: ServiceActionDefinitionMap; + /** + * The self-service action description. + */ + Description?: ServiceActionDescription; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface CreateServiceActionOutput { + /** + * An object containing information about the self-service action. + */ + ServiceActionDetail?: ServiceActionDetail; + } + export interface CreateTagOptionInput { + /** + * The TagOption key. + */ + Key: TagOptionKey; + /** + * The TagOption value. + */ + Value: TagOptionValue; + } + export interface CreateTagOptionOutput { + /** + * Information about the TagOption. + */ + TagOptionDetail?: TagOptionDetail; + } + export type CreatedTime = Date; + export type CreationTime = Date; + export type DefaultValue = string; + export interface DeleteConstraintInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The identifier of the constraint. + */ + Id: Id; + } + export interface DeleteConstraintOutput { + } + export interface DeletePortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + Id: Id; + } + export interface DeletePortfolioOutput { + } + export interface DeletePortfolioShareInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The AWS account ID. + */ + AccountId?: AccountId; + /** + * The organization node to whom you are going to stop sharing. + */ + OrganizationNode?: OrganizationNode; + } + export interface DeletePortfolioShareOutput { + /** + * The portfolio share unique identifier. This will only be returned if delete is made to an organization node. + */ + PortfolioShareToken?: Id; + } + export interface DeleteProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + Id: Id; + } + export interface DeleteProductOutput { + } + export interface DeleteProvisionedProductPlanInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The plan identifier. + */ + PlanId: Id; + /** + * If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. + */ + IgnoreErrors?: IgnoreErrors; + } + export interface DeleteProvisionedProductPlanOutput { + } + export interface DeleteProvisioningArtifactInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId: Id; + } + export interface DeleteProvisioningArtifactOutput { + } + export interface DeleteServiceActionInput { + /** + * The self-service action identifier. For example, act-fs7abcd89wxyz. + */ + Id: Id; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface DeleteServiceActionOutput { + } + export interface DeleteTagOptionInput { + /** + * The TagOption identifier. + */ + Id: TagOptionId; + } + export interface DeleteTagOptionOutput { + } + export interface DescribeConstraintInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The identifier of the constraint. + */ + Id: Id; + } + export interface DescribeConstraintOutput { + /** + * Information about the constraint. + */ + ConstraintDetail?: ConstraintDetail; + /** + * The constraint parameters. + */ + ConstraintParameters?: ConstraintParameters; + /** + * The status of the current request. + */ + Status?: Status; + } + export interface DescribeCopyProductStatusInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The token for the copy product operation. This token is returned by CopyProduct. + */ + CopyProductToken: Id; + } + export interface DescribeCopyProductStatusOutput { + /** + * The status of the copy product operation. + */ + CopyProductStatus?: CopyProductStatus; + /** + * The identifier of the copied product. + */ + TargetProductId?: Id; + /** + * The status message. + */ + StatusDetail?: StatusDetail; + } + export interface DescribePortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + Id: Id; + } + export interface DescribePortfolioOutput { + /** + * Information about the portfolio. + */ + PortfolioDetail?: PortfolioDetail; + /** + * Information about the tags associated with the portfolio. + */ + Tags?: Tags; + /** + * Information about the TagOptions associated with the portfolio. + */ + TagOptions?: TagOptionDetails; + /** + * Information about the associated budgets. + */ + Budgets?: Budgets; + } + export interface DescribePortfolioShareStatusInput { + /** + * The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare. + */ + PortfolioShareToken: Id; + } + export interface DescribePortfolioShareStatusOutput { + /** + * The token for the portfolio share operation. For example, share-6v24abcdefghi. + */ + PortfolioShareToken?: Id; + /** + * The portfolio identifier. + */ + PortfolioId?: Id; + /** + * Organization node identifier. It can be either account id, organizational unit id or organization id. + */ + OrganizationNodeValue?: OrganizationNodeValue; + /** + * Status of the portfolio share operation. + */ + Status?: ShareStatus; + /** + * Information about the portfolio share operation. + */ + ShareDetails?: ShareDetails; + } + export interface DescribeProductAsAdminInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + Id: Id; + } + export interface DescribeProductAsAdminOutput { + /** + * Information about the product view. + */ + ProductViewDetail?: ProductViewDetail; + /** + * Information about the provisioning artifacts (also known as versions) for the specified product. + */ + ProvisioningArtifactSummaries?: ProvisioningArtifactSummaries; + /** + * Information about the tags associated with the product. + */ + Tags?: Tags; + /** + * Information about the TagOptions associated with the product. + */ + TagOptions?: TagOptionDetails; + /** + * Information about the associated budgets. + */ + Budgets?: Budgets; + } + export interface DescribeProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + Id: Id; + } + export interface DescribeProductOutput { + /** + * Summary information about the product view. + */ + ProductViewSummary?: ProductViewSummary; + /** + * Information about the provisioning artifacts for the specified product. + */ + ProvisioningArtifacts?: ProvisioningArtifacts; + /** + * Information about the associated budgets. + */ + Budgets?: Budgets; + } + export interface DescribeProductViewInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product view identifier. + */ + Id: Id; + } + export interface DescribeProductViewOutput { + /** + * Summary information about the product. + */ + ProductViewSummary?: ProductViewSummary; + /** + * Information about the provisioning artifacts for the product. + */ + ProvisioningArtifacts?: ProvisioningArtifacts; + } + export interface DescribeProvisionedProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The provisioned product identifier. + */ + Id: Id; + } + export interface DescribeProvisionedProductOutput { + /** + * Information about the provisioned product. + */ + ProvisionedProductDetail?: ProvisionedProductDetail; + /** + * Any CloudWatch dashboards that were created when provisioning the product. + */ + CloudWatchDashboards?: CloudWatchDashboards; + } + export interface DescribeProvisionedProductPlanInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The plan identifier. + */ + PlanId: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface DescribeProvisionedProductPlanOutput { + /** + * Information about the plan. + */ + ProvisionedProductPlanDetails?: ProvisionedProductPlanDetails; + /** + * Information about the resource changes that will occur when the plan is executed. + */ + ResourceChanges?: ResourceChanges; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface DescribeProvisioningArtifactInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId: Id; + /** + * The product identifier. + */ + ProductId: Id; + /** + * Indicates whether a verbose level of detail is enabled. + */ + Verbose?: Verbose; + } + export interface DescribeProvisioningArtifactOutput { + /** + * Information about the provisioning artifact. + */ + ProvisioningArtifactDetail?: ProvisioningArtifactDetail; + /** + * The URL of the CloudFormation template in Amazon S3. + */ + Info?: ProvisioningArtifactInfo; + /** + * The status of the current request. + */ + Status?: Status; + } + export interface DescribeProvisioningParametersInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId: Id; + /** + * The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. + */ + PathId?: Id; + } + export interface DescribeProvisioningParametersOutput { + /** + * Information about the parameters used to provision the product. + */ + ProvisioningArtifactParameters?: ProvisioningArtifactParameters; + /** + * Information about the constraints used to provision the product. + */ + ConstraintSummaries?: ConstraintSummaries; + /** + * Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template. + */ + UsageInstructions?: UsageInstructions; + /** + * Information about the TagOptions associated with the resource. + */ + TagOptions?: TagOptionSummaries; + /** + * An object that contains information about preferences, such as regions and accounts, for the provisioning artifact. + */ + ProvisioningArtifactPreferences?: ProvisioningArtifactPreferences; + } + export interface DescribeRecordInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The record identifier of the provisioned product. This identifier is returned by the request operation. + */ + Id: Id; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + } + export interface DescribeRecordOutput { + /** + * Information about the product. + */ + RecordDetail?: RecordDetail; + /** + * Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL. + */ + RecordOutputs?: RecordOutputs; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface DescribeServiceActionInput { + /** + * The self-service action identifier. + */ + Id: Id; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface DescribeServiceActionOutput { + /** + * Detailed information about the self-service action. + */ + ServiceActionDetail?: ServiceActionDetail; + } + export interface DescribeTagOptionInput { + /** + * The TagOption identifier. + */ + Id: TagOptionId; + } + export interface DescribeTagOptionOutput { + /** + * Information about the TagOption. + */ + TagOptionDetail?: TagOptionDetail; + } + export type Description = string; + export interface DisableAWSOrganizationsAccessInput { + } + export interface DisableAWSOrganizationsAccessOutput { + } + export type DisableTemplateValidation = boolean; + export interface DisassociateBudgetFromResourceInput { + /** + * The name of the budget you want to disassociate. + */ + BudgetName: BudgetName; + /** + * The resource identifier you want to disassociate from. Either a portfolio-id or a product-id. + */ + ResourceId: Id; + } + export interface DisassociateBudgetFromResourceOutput { + } + export interface DisassociatePrincipalFromPortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The ARN of the principal (IAM user, role, or group). + */ + PrincipalARN: PrincipalARN; + } + export interface DisassociatePrincipalFromPortfolioOutput { + } + export interface DisassociateProductFromPortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + } + export interface DisassociateProductFromPortfolioOutput { + } + export interface DisassociateServiceActionFromProvisioningArtifactInput { + /** + * The product identifier. For example, prod-abcdzk7xy33qa. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + */ + ProvisioningArtifactId: Id; + /** + * The self-service action identifier. For example, act-fs7abcd89wxyz. + */ + ServiceActionId: Id; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface DisassociateServiceActionFromProvisioningArtifactOutput { + } + export interface DisassociateTagOptionFromResourceInput { + /** + * The resource identifier. + */ + ResourceId: ResourceId; + /** + * The TagOption identifier. + */ + TagOptionId: TagOptionId; + } + export interface DisassociateTagOptionFromResourceOutput { + } + export interface EnableAWSOrganizationsAccessInput { + } + export interface EnableAWSOrganizationsAccessOutput { + } + export type Error = string; + export type ErrorCode = string; + export type ErrorDescription = string; + export type EvaluationType = "STATIC"|"DYNAMIC"|string; + export interface ExecuteProvisionedProductPlanInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The plan identifier. + */ + PlanId: Id; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken: IdempotencyToken; + } + export interface ExecuteProvisionedProductPlanOutput { + /** + * Information about the result of provisioning the product. + */ + RecordDetail?: RecordDetail; + } + export interface ExecuteProvisionedProductServiceActionInput { + /** + * The identifier of the provisioned product. + */ + ProvisionedProductId: Id; + /** + * The self-service action identifier. For example, act-fs7abcd89wxyz. + */ + ServiceActionId: Id; + /** + * An idempotency token that uniquely identifies the execute request. + */ + ExecuteToken: IdempotencyToken; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface ExecuteProvisionedProductServiceActionOutput { + /** + * An object containing detailed information about the result of provisioning the product. + */ + RecordDetail?: RecordDetail; + } + export interface FailedServiceActionAssociation { + /** + * The self-service action identifier. For example, act-fs7abcd89wxyz. + */ + ServiceActionId?: Id; + /** + * The product identifier. For example, prod-abcdzk7xy33qa. + */ + ProductId?: Id; + /** + * The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + */ + ProvisioningArtifactId?: Id; + /** + * The error code. Valid values are listed below. + */ + ErrorCode?: ServiceActionAssociationErrorCode; + /** + * A text description of the error. + */ + ErrorMessage?: ServiceActionAssociationErrorMessage; + } + export type FailedServiceActionAssociations = FailedServiceActionAssociation[]; + export interface GetAWSOrganizationsAccessStatusInput { + } + export interface GetAWSOrganizationsAccessStatusOutput { + /** + * The status of the portfolio share feature. + */ + AccessStatus?: AccessStatus; + } + export type HasDefaultPath = boolean; + export type Id = string; + export type IdempotencyToken = string; + export type IgnoreErrors = boolean; + export type InstructionType = string; + export type InstructionValue = string; + export type LastRequestId = string; + export type LaunchPathSummaries = LaunchPathSummary[]; + export interface LaunchPathSummary { + /** + * The identifier of the product path. + */ + Id?: Id; + /** + * The constraints on the portfolio-product relationship. + */ + ConstraintSummaries?: ConstraintSummaries; + /** + * The tags associated with this product path. + */ + Tags?: Tags; + /** + * The name of the portfolio to which the user was assigned. + */ + Name?: PortfolioName; + } + export interface ListAcceptedPortfolioSharesInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The type of shared portfolios to list. The default is to list imported portfolios. AWS_ORGANIZATIONS - List portfolios shared by the master account of your organization AWS_SERVICECATALOG - List default portfolios IMPORTED - List imported portfolios + */ + PortfolioShareType?: PortfolioShareType; + } + export interface ListAcceptedPortfolioSharesOutput { + /** + * Information about the portfolios. + */ + PortfolioDetails?: PortfolioDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListBudgetsForResourceInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The resource identifier. + */ + ResourceId: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListBudgetsForResourceOutput { + /** + * Information about the associated budgets. + */ + Budgets?: Budgets; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListConstraintsForPortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The product identifier. + */ + ProductId?: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListConstraintsForPortfolioOutput { + /** + * Information about the constraints. + */ + ConstraintDetails?: ConstraintDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListLaunchPathsInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListLaunchPathsOutput { + /** + * Information about the launch path. + */ + LaunchPathSummaries?: LaunchPathSummaries; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListOrganizationPortfolioAccessInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. For example, port-2abcdext3y5fk. + */ + PortfolioId: Id; + /** + * The organization node type that will be returned in the output. ORGANIZATION - Organization that has access to the portfolio. ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization. ACCOUNT - Account that has access to the portfolio within your organization. + */ + OrganizationNodeType: OrganizationNodeType; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + } + export interface ListOrganizationPortfolioAccessOutput { + /** + * Displays information about the organization nodes. + */ + OrganizationNodes?: OrganizationNodes; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListPortfolioAccessInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + } + export interface ListPortfolioAccessOutput { + /** + * Information about the AWS accounts with access to the portfolio. + */ + AccountIds?: AccountIds; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListPortfoliosForProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + } + export interface ListPortfoliosForProductOutput { + /** + * Information about the portfolios. + */ + PortfolioDetails?: PortfolioDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListPortfoliosInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + } + export interface ListPortfoliosOutput { + /** + * Information about the portfolios. + */ + PortfolioDetails?: PortfolioDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListPrincipalsForPortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListPrincipalsForPortfolioOutput { + /** + * The IAM principals (users or roles) associated with the portfolio. + */ + Principals?: Principals; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListProvisionedProductPlansInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProvisionProductId?: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The access level to use to obtain results. The default is User. + */ + AccessLevelFilter?: AccessLevelFilter; + } + export interface ListProvisionedProductPlansOutput { + /** + * Information about the plans. + */ + ProvisionedProductPlans?: ProvisionedProductPlans; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListProvisioningArtifactsForServiceActionInput { + /** + * The self-service action identifier. For example, act-fs7abcd89wxyz. + */ + ServiceActionId: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface ListProvisioningArtifactsForServiceActionOutput { + /** + * An array of objects with information about product views and provisioning artifacts. + */ + ProvisioningArtifactViews?: ProvisioningArtifactViews; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListProvisioningArtifactsInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + } + export interface ListProvisioningArtifactsOutput { + /** + * Information about the provisioning artifacts. + */ + ProvisioningArtifactDetails?: ProvisioningArtifactDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListRecordHistoryInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The access level to use to obtain results. The default is User. + */ + AccessLevelFilter?: AccessLevelFilter; + /** + * The search filter to scope the results. + */ + SearchFilter?: ListRecordHistorySearchFilter; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListRecordHistoryOutput { + /** + * The records, in reverse chronological order. + */ + RecordDetails?: RecordDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListRecordHistorySearchFilter { + /** + * The filter key. product - Filter results based on the specified product identifier. provisionedproduct - Filter results based on the provisioned product identifier. + */ + Key?: SearchFilterKey; + /** + * The filter value. + */ + Value?: SearchFilterValue; + } + export interface ListResourcesForTagOptionInput { + /** + * The TagOption identifier. + */ + TagOptionId: TagOptionId; + /** + * The resource type. Portfolio Product + */ + ResourceType?: ResourceType; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListResourcesForTagOptionOutput { + /** + * Information about the resources. + */ + ResourceDetails?: ResourceDetails; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListServiceActionsForProvisioningArtifactInput { + /** + * The product identifier. For example, prod-abcdzk7xy33qa. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + */ + ProvisioningArtifactId: Id; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface ListServiceActionsForProvisioningArtifactOutput { + /** + * An object containing information about the self-service actions associated with the provisioning artifact. + */ + ServiceActionSummaries?: ServiceActionSummaries; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListServiceActionsInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListServiceActionsOutput { + /** + * An object containing information about the service actions associated with the provisioning artifact. + */ + ServiceActionSummaries?: ServiceActionSummaries; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface ListTagOptionsFilters { + /** + * The TagOption key. + */ + Key?: TagOptionKey; + /** + * The TagOption value. + */ + Value?: TagOptionValue; + /** + * The active state. + */ + Active?: TagOptionActive; + } + export interface ListTagOptionsInput { + /** + * The search filters. If no search filters are specified, the output includes all TagOptions. + */ + Filters?: ListTagOptionsFilters; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ListTagOptionsOutput { + /** + * Information about the TagOptions. + */ + TagOptionDetails?: TagOptionDetails; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export type LogicalResourceId = string; + export type Message = string; + export type Namespaces = AccountId[]; + export type NoEcho = boolean; + export type NotificationArn = string; + export type NotificationArns = NotificationArn[]; + export interface OrganizationNode { + /** + * The organization node type. + */ + Type?: OrganizationNodeType; + /** + * The identifier of the organization node. + */ + Value?: OrganizationNodeValue; + } + export type OrganizationNodeType = "ORGANIZATION"|"ORGANIZATIONAL_UNIT"|"ACCOUNT"|string; + export type OrganizationNodeValue = string; + export type OrganizationNodes = OrganizationNode[]; + export type OutputKey = string; + export type OutputValue = string; + export type PageSize = number; + export type PageToken = string; + export interface ParameterConstraints { + /** + * The values that the administrator has allowed for the parameter. + */ + AllowedValues?: AllowedValues; + } + export type ParameterKey = string; + export type ParameterType = string; + export type ParameterValue = string; + export type PhysicalId = string; + export type PhysicalResourceId = string; + export type PlanResourceType = string; + export type PortfolioDescription = string; + export interface PortfolioDetail { + /** + * The portfolio identifier. + */ + Id?: Id; + /** + * The ARN assigned to the portfolio. + */ + ARN?: ResourceARN; + /** + * The name to use for display purposes. + */ + DisplayName?: PortfolioDisplayName; + /** + * The description of the portfolio. + */ + Description?: PortfolioDescription; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: CreationTime; + /** + * The name of the portfolio provider. + */ + ProviderName?: ProviderName; + } + export type PortfolioDetails = PortfolioDetail[]; + export type PortfolioDisplayName = string; + export type PortfolioName = string; + export type PortfolioShareType = "IMPORTED"|"AWS_SERVICECATALOG"|"AWS_ORGANIZATIONS"|string; + export interface Principal { + /** + * The ARN of the principal (IAM user, role, or group). + */ + PrincipalARN?: PrincipalARN; + /** + * The principal type. The supported value is IAM. + */ + PrincipalType?: PrincipalType; + } + export type PrincipalARN = string; + export type PrincipalType = "IAM"|string; + export type Principals = Principal[]; + export type ProductArn = string; + export type ProductSource = "ACCOUNT"|string; + export type ProductType = "CLOUD_FORMATION_TEMPLATE"|"MARKETPLACE"|string; + export type ProductViewAggregationType = string; + export interface ProductViewAggregationValue { + /** + * The value of the product view aggregation. + */ + Value?: AttributeValue; + /** + * An approximate count of the products that match the value. + */ + ApproximateCount?: ApproximateCount; + } + export type ProductViewAggregationValues = ProductViewAggregationValue[]; + export type ProductViewAggregations = {[key: string]: ProductViewAggregationValues}; + export interface ProductViewDetail { + /** + * Summary information about the product view. + */ + ProductViewSummary?: ProductViewSummary; + /** + * The status of the product. AVAILABLE - The product is ready for use. CREATING - Product creation has started; the product is not ready for use. FAILED - An action failed. + */ + Status?: Status; + /** + * The ARN of the product. + */ + ProductARN?: ResourceARN; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: CreatedTime; + } + export type ProductViewDetails = ProductViewDetail[]; + export type ProductViewDistributor = string; + export type ProductViewFilterBy = "FullTextSearch"|"Owner"|"ProductType"|"SourceProductId"|string; + export type ProductViewFilterValue = string; + export type ProductViewFilterValues = ProductViewFilterValue[]; + export type ProductViewFilters = {[key: string]: ProductViewFilterValues}; + export type ProductViewName = string; + export type ProductViewOwner = string; + export type ProductViewShortDescription = string; + export type ProductViewSortBy = "Title"|"VersionCount"|"CreationDate"|string; + export type ProductViewSummaries = ProductViewSummary[]; + export interface ProductViewSummary { + /** + * The product view identifier. + */ + Id?: Id; + /** + * The product identifier. + */ + ProductId?: Id; + /** + * The name of the product. + */ + Name?: ProductViewName; + /** + * The owner of the product. Contact the product administrator for the significance of this value. + */ + Owner?: ProductViewOwner; + /** + * Short description of the product. + */ + ShortDescription?: ProductViewShortDescription; + /** + * The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace. + */ + Type?: ProductType; + /** + * The distributor of the product. Contact the product administrator for the significance of this value. + */ + Distributor?: ProductViewDistributor; + /** + * Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters. + */ + HasDefaultPath?: HasDefaultPath; + /** + * The email contact information to obtain support for this Product. + */ + SupportEmail?: SupportEmail; + /** + * The description of the support for this Product. + */ + SupportDescription?: SupportDescription; + /** + * The URL information to obtain support for this Product. + */ + SupportUrl?: SupportUrl; + } + export type PropertyName = string; + export type ProviderName = string; + export interface ProvisionProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId: Id; + /** + * The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. + */ + PathId?: Id; + /** + * A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned. + */ + ProvisionedProductName: ProvisionedProductName; + /** + * Parameters specified by the administrator that are required for provisioning the product. + */ + ProvisioningParameters?: ProvisioningParameters; + /** + * An object that contains information about the provisioning preferences for a stack set. + */ + ProvisioningPreferences?: ProvisioningPreferences; + /** + * One or more tags. + */ + Tags?: Tags; + /** + * Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. + */ + NotificationArns?: NotificationArns; + /** + * An idempotency token that uniquely identifies the provisioning request. + */ + ProvisionToken: IdempotencyToken; + } + export interface ProvisionProductOutput { + /** + * Information about the result of provisioning the product. + */ + RecordDetail?: RecordDetail; + } + export interface ProvisionedProductAttribute { + /** + * The user-friendly name of the provisioned product. + */ + Name?: ProvisionedProductNameOrArn; + /** + * The ARN of the provisioned product. + */ + Arn?: ProvisionedProductNameOrArn; + /** + * The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET. + */ + Type?: ProvisionedProductType; + /** + * The identifier of the provisioned product. + */ + Id?: Id; + /** + * The current status of the provisioned product. AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed. UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations. TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack. PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations. + */ + Status?: ProvisionedProductStatus; + /** + * The current status message of the provisioned product. + */ + StatusMessage?: ProvisionedProductStatusMessage; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: CreatedTime; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken?: IdempotencyToken; + /** + * The record identifier of the last request performed on this provisioned product. + */ + LastRecordId?: Id; + /** + * One or more tags. + */ + Tags?: Tags; + /** + * The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name. + */ + PhysicalId?: PhysicalId; + /** + * The product identifier. + */ + ProductId?: Id; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId?: Id; + /** + * The Amazon Resource Name (ARN) of the IAM user. + */ + UserArn?: UserArn; + /** + * The ARN of the IAM user in the session. This ARN might contain a session ID. + */ + UserArnSession?: UserArnSession; + } + export type ProvisionedProductAttributes = ProvisionedProductAttribute[]; + export interface ProvisionedProductDetail { + /** + * The user-friendly name of the provisioned product. + */ + Name?: ProvisionedProductNameOrArn; + /** + * The ARN of the provisioned product. + */ + Arn?: ProvisionedProductNameOrArn; + /** + * The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET. + */ + Type?: ProvisionedProductType; + /** + * The identifier of the provisioned product. + */ + Id?: ProvisionedProductId; + /** + * The current status of the provisioned product. AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed. UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations. TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack. PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations. + */ + Status?: ProvisionedProductStatus; + /** + * The current status message of the provisioned product. + */ + StatusMessage?: ProvisionedProductStatusMessage; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: CreatedTime; + /** + * A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request. + */ + IdempotencyToken?: IdempotencyToken; + /** + * The record identifier of the last request performed on this provisioned product. + */ + LastRecordId?: LastRequestId; + /** + * The product identifier. For example, prod-abcdzk7xy33qa. + */ + ProductId?: Id; + /** + * The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + */ + ProvisioningArtifactId?: Id; + } + export type ProvisionedProductDetails = ProvisionedProductDetail[]; + export type ProvisionedProductFilters = {[key: string]: ProvisionedProductViewFilterValues}; + export type ProvisionedProductId = string; + export type ProvisionedProductName = string; + export type ProvisionedProductNameOrArn = string; + export interface ProvisionedProductPlanDetails { + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: CreatedTime; + /** + * The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. + */ + PathId?: Id; + /** + * The product identifier. + */ + ProductId?: Id; + /** + * The name of the plan. + */ + PlanName?: ProvisionedProductPlanName; + /** + * The plan identifier. + */ + PlanId?: Id; + /** + * The product identifier. + */ + ProvisionProductId?: Id; + /** + * The user-friendly name of the provisioned product. + */ + ProvisionProductName?: ProvisionedProductName; + /** + * The plan type. + */ + PlanType?: ProvisionedProductPlanType; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId?: Id; + /** + * The status. + */ + Status?: ProvisionedProductPlanStatus; + /** + * The time when the plan was last updated. + */ + UpdatedTime?: UpdatedTime; + /** + * Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. + */ + NotificationArns?: NotificationArns; + /** + * Parameters specified by the administrator that are required for provisioning the product. + */ + ProvisioningParameters?: UpdateProvisioningParameters; + /** + * One or more tags. + */ + Tags?: Tags; + /** + * The status message. + */ + StatusMessage?: StatusMessage; + } + export type ProvisionedProductPlanName = string; + export type ProvisionedProductPlanStatus = "CREATE_IN_PROGRESS"|"CREATE_SUCCESS"|"CREATE_FAILED"|"EXECUTE_IN_PROGRESS"|"EXECUTE_SUCCESS"|"EXECUTE_FAILED"|string; + export interface ProvisionedProductPlanSummary { + /** + * The name of the plan. + */ + PlanName?: ProvisionedProductPlanName; + /** + * The plan identifier. + */ + PlanId?: Id; + /** + * The product identifier. + */ + ProvisionProductId?: Id; + /** + * The user-friendly name of the provisioned product. + */ + ProvisionProductName?: ProvisionedProductName; + /** + * The plan type. + */ + PlanType?: ProvisionedProductPlanType; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId?: Id; + } + export type ProvisionedProductPlanType = "CLOUDFORMATION"|string; + export type ProvisionedProductPlans = ProvisionedProductPlanSummary[]; + export type ProvisionedProductStatus = "AVAILABLE"|"UNDER_CHANGE"|"TAINTED"|"ERROR"|"PLAN_IN_PROGRESS"|string; + export type ProvisionedProductStatusMessage = string; + export type ProvisionedProductType = string; + export type ProvisionedProductViewFilterBy = "SearchQuery"|string; + export type ProvisionedProductViewFilterValue = string; + export type ProvisionedProductViewFilterValues = ProvisionedProductViewFilterValue[]; + export interface ProvisioningArtifact { + /** + * The identifier of the provisioning artifact. + */ + Id?: Id; + /** + * The name of the provisioning artifact. + */ + Name?: ProvisioningArtifactName; + /** + * The description of the provisioning artifact. + */ + Description?: ProvisioningArtifactDescription; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: ProvisioningArtifactCreatedTime; + } + export type ProvisioningArtifactActive = boolean; + export type ProvisioningArtifactCreatedTime = Date; + export type ProvisioningArtifactDescription = string; + export interface ProvisioningArtifactDetail { + /** + * The identifier of the provisioning artifact. + */ + Id?: Id; + /** + * The name of the provisioning artifact. + */ + Name?: ProvisioningArtifactName; + /** + * The description of the provisioning artifact. + */ + Description?: ProvisioningArtifactName; + /** + * The type of provisioning artifact. CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template MARKETPLACE_AMI - AWS Marketplace AMI MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources + */ + Type?: ProvisioningArtifactType; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: CreationTime; + /** + * Indicates whether the product version is active. + */ + Active?: ProvisioningArtifactActive; + } + export type ProvisioningArtifactDetails = ProvisioningArtifactDetail[]; + export type ProvisioningArtifactInfo = {[key: string]: ProvisioningArtifactInfoValue}; + export type ProvisioningArtifactInfoKey = string; + export type ProvisioningArtifactInfoValue = string; + export type ProvisioningArtifactName = string; + export interface ProvisioningArtifactParameter { + /** + * The parameter key. + */ + ParameterKey?: ParameterKey; + /** + * The default value. + */ + DefaultValue?: DefaultValue; + /** + * The parameter type. + */ + ParameterType?: ParameterType; + /** + * If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information. + */ + IsNoEcho?: NoEcho; + /** + * The description of the parameter. + */ + Description?: Description; + /** + * Constraints that the administrator has put on a parameter. + */ + ParameterConstraints?: ParameterConstraints; + } + export type ProvisioningArtifactParameters = ProvisioningArtifactParameter[]; + export interface ProvisioningArtifactPreferences { + /** + * One or more AWS accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts. Applicable only to a CFN_STACKSET provisioned product type. + */ + StackSetAccounts?: StackSetAccounts; + /** + * One or more AWS Regions where stack instances are deployed from the stack set. These regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions. Applicable only to a CFN_STACKSET provisioned product type. + */ + StackSetRegions?: StackSetRegions; + } + export interface ProvisioningArtifactProperties { + /** + * The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed. + */ + Name?: ProvisioningArtifactName; + /** + * The description of the provisioning artifact, including how it differs from the previous provisioning artifact. + */ + Description?: ProvisioningArtifactDescription; + /** + * The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows: "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." + */ + Info: ProvisioningArtifactInfo; + /** + * The type of provisioning artifact. CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template MARKETPLACE_AMI - AWS Marketplace AMI MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources + */ + Type?: ProvisioningArtifactType; + /** + * If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid. + */ + DisableTemplateValidation?: DisableTemplateValidation; + } + export type ProvisioningArtifactPropertyName = "Id"|string; + export type ProvisioningArtifactPropertyValue = string; + export type ProvisioningArtifactSummaries = ProvisioningArtifactSummary[]; + export interface ProvisioningArtifactSummary { + /** + * The identifier of the provisioning artifact. + */ + Id?: Id; + /** + * The name of the provisioning artifact. + */ + Name?: ProvisioningArtifactName; + /** + * The description of the provisioning artifact. + */ + Description?: ProvisioningArtifactDescription; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: ProvisioningArtifactCreatedTime; + /** + * The metadata for the provisioning artifact. This is used with AWS Marketplace products. + */ + ProvisioningArtifactMetadata?: ProvisioningArtifactInfo; + } + export type ProvisioningArtifactType = "CLOUD_FORMATION_TEMPLATE"|"MARKETPLACE_AMI"|"MARKETPLACE_CAR"|string; + export interface ProvisioningArtifactView { + /** + * Summary information about a product view. + */ + ProductViewSummary?: ProductViewSummary; + /** + * Information about a provisioning artifact. A provisioning artifact is also known as a product version. + */ + ProvisioningArtifact?: ProvisioningArtifact; + } + export type ProvisioningArtifactViews = ProvisioningArtifactView[]; + export type ProvisioningArtifacts = ProvisioningArtifact[]; + export interface ProvisioningParameter { + /** + * The parameter key. + */ + Key?: ParameterKey; + /** + * The parameter value. + */ + Value?: ParameterValue; + } + export type ProvisioningParameters = ProvisioningParameter[]; + export interface ProvisioningPreferences { + /** + * One or more AWS accounts that will have access to the provisioned product. Applicable only to a CFN_STACKSET provisioned product type. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation. If no values are specified, the default value is all accounts from the STACKSET constraint. + */ + StackSetAccounts?: StackSetAccounts; + /** + * One or more AWS Regions where the provisioned product will be available. Applicable only to a CFN_STACKSET provisioned product type. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation. If no values are specified, the default value is all regions from the STACKSET constraint. + */ + StackSetRegions?: StackSetRegions; + /** + * The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. The default value is 0 if no value is specified. + */ + StackSetFailureToleranceCount?: StackSetFailureToleranceCount; + /** + * The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. + */ + StackSetFailureTolerancePercentage?: StackSetFailureTolerancePercentage; + /** + * The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both. + */ + StackSetMaxConcurrencyCount?: StackSetMaxConcurrencyCount; + /** + * The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both. + */ + StackSetMaxConcurrencyPercentage?: StackSetMaxConcurrencyPercentage; + } + export interface RecordDetail { + /** + * The identifier of the record. + */ + RecordId?: Id; + /** + * The user-friendly name of the provisioned product. + */ + ProvisionedProductName?: ProvisionedProductName; + /** + * The status of the provisioned product. CREATED - The request was created but the operation has not started. IN_PROGRESS - The requested operation is in progress. IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback. SUCCEEDED - The requested operation has successfully completed. FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned. + */ + Status?: RecordStatus; + /** + * The UTC time stamp of the creation time. + */ + CreatedTime?: CreatedTime; + /** + * The time when the record was last updated. + */ + UpdatedTime?: UpdatedTime; + /** + * The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET. + */ + ProvisionedProductType?: ProvisionedProductType; + /** + * The record type. PROVISION_PRODUCT UPDATE_PROVISIONED_PRODUCT TERMINATE_PROVISIONED_PRODUCT + */ + RecordType?: RecordType; + /** + * The identifier of the provisioned product. + */ + ProvisionedProductId?: Id; + /** + * The product identifier. + */ + ProductId?: Id; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId?: Id; + /** + * The path identifier. + */ + PathId?: Id; + /** + * The errors that occurred. + */ + RecordErrors?: RecordErrors; + /** + * One or more tags. + */ + RecordTags?: RecordTags; + } + export type RecordDetails = RecordDetail[]; + export interface RecordError { + /** + * The numeric value of the error. + */ + Code?: ErrorCode; + /** + * The description of the error. + */ + Description?: ErrorDescription; + } + export type RecordErrors = RecordError[]; + export interface RecordOutput { + /** + * The output key. + */ + OutputKey?: OutputKey; + /** + * The output value. + */ + OutputValue?: OutputValue; + /** + * The description of the output. + */ + Description?: Description; + } + export type RecordOutputs = RecordOutput[]; + export type RecordStatus = "CREATED"|"IN_PROGRESS"|"IN_PROGRESS_IN_ERROR"|"SUCCEEDED"|"FAILED"|string; + export interface RecordTag { + /** + * The key for this tag. + */ + Key?: RecordTagKey; + /** + * The value for this tag. + */ + Value?: RecordTagValue; + } + export type RecordTagKey = string; + export type RecordTagValue = string; + export type RecordTags = RecordTag[]; + export type RecordType = string; + export type Region = string; + export interface RejectPortfolioShareInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId: Id; + /** + * The type of shared portfolios to reject. The default is to reject imported portfolios. AWS_ORGANIZATIONS - Reject portfolios shared by the master account of your organization. IMPORTED - Reject imported portfolios. AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) For example, aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS + */ + PortfolioShareType?: PortfolioShareType; + } + export interface RejectPortfolioShareOutput { + } + export type Replacement = "TRUE"|"FALSE"|"CONDITIONAL"|string; + export type RequiresRecreation = "NEVER"|"CONDITIONALLY"|"ALWAYS"|string; + export type ResourceARN = string; + export type ResourceAttribute = "PROPERTIES"|"METADATA"|"CREATIONPOLICY"|"UPDATEPOLICY"|"DELETIONPOLICY"|"TAGS"|string; + export interface ResourceChange { + /** + * The change action. + */ + Action?: ChangeAction; + /** + * The ID of the resource, as defined in the CloudFormation template. + */ + LogicalResourceId?: LogicalResourceId; + /** + * The ID of the resource, if it was already created. + */ + PhysicalResourceId?: PhysicalResourceId; + /** + * The type of resource. + */ + ResourceType?: PlanResourceType; + /** + * If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one. + */ + Replacement?: Replacement; + /** + * The change scope. + */ + Scope?: Scope; + /** + * Information about the resource changes. + */ + Details?: ResourceChangeDetails; + } + export interface ResourceChangeDetail { + /** + * Information about the resource attribute to be modified. + */ + Target?: ResourceTargetDefinition; + /** + * For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated. + */ + Evaluation?: EvaluationType; + /** + * The ID of the entity that caused the change. + */ + CausingEntity?: CausingEntity; + } + export type ResourceChangeDetails = ResourceChangeDetail[]; + export type ResourceChanges = ResourceChange[]; + export interface ResourceDetail { + /** + * The identifier of the resource. + */ + Id?: ResourceDetailId; + /** + * The ARN of the resource. + */ + ARN?: ResourceDetailARN; + /** + * The name of the resource. + */ + Name?: ResourceDetailName; + /** + * The description of the resource. + */ + Description?: ResourceDetailDescription; + /** + * The creation time of the resource. + */ + CreatedTime?: ResourceDetailCreatedTime; + } + export type ResourceDetailARN = string; + export type ResourceDetailCreatedTime = Date; + export type ResourceDetailDescription = string; + export type ResourceDetailId = string; + export type ResourceDetailName = string; + export type ResourceDetails = ResourceDetail[]; + export type ResourceId = string; + export interface ResourceTargetDefinition { + /** + * The attribute to be changed. + */ + Attribute?: ResourceAttribute; + /** + * If the attribute is Properties, the value is the name of the property. Otherwise, the value is null. + */ + Name?: PropertyName; + /** + * If the attribute is Properties, indicates whether a change to this property causes the resource to be re-created. + */ + RequiresRecreation?: RequiresRecreation; + } + export type ResourceType = string; + export interface ScanProvisionedProductsInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The access level to use to obtain results. The default is User. + */ + AccessLevelFilter?: AccessLevelFilter; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface ScanProvisionedProductsOutput { + /** + * Information about the provisioned products. + */ + ProvisionedProducts?: ProvisionedProductDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export type Scope = ResourceAttribute[]; + export type SearchFilterKey = string; + export type SearchFilterValue = string; + export interface SearchProductsAsAdminInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + PortfolioId?: Id; + /** + * The search filters. If no search filters are specified, the output includes all products to which the administrator has access. + */ + Filters?: ProductViewFilters; + /** + * The sort field. If no value is specified, the results are not sorted. + */ + SortBy?: ProductViewSortBy; + /** + * The sort order. If no value is specified, the results are not sorted. + */ + SortOrder?: SortOrder; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * Access level of the source of the product. + */ + ProductSource?: ProductSource; + } + export interface SearchProductsAsAdminOutput { + /** + * Information about the product views. + */ + ProductViewDetails?: ProductViewDetails; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface SearchProductsInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The search filters. If no search filters are specified, the output includes all products to which the caller has access. + */ + Filters?: ProductViewFilters; + /** + * The maximum number of items to return with this call. + */ + PageSize?: PageSize; + /** + * The sort field. If no value is specified, the results are not sorted. + */ + SortBy?: ProductViewSortBy; + /** + * The sort order. If no value is specified, the results are not sorted. + */ + SortOrder?: SortOrder; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface SearchProductsOutput { + /** + * Information about the product views. + */ + ProductViewSummaries?: ProductViewSummaries; + /** + * The product view aggregations. + */ + ProductViewAggregations?: ProductViewAggregations; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export interface SearchProvisionedProductsInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The access level to use to obtain results. The default is User. + */ + AccessLevelFilter?: AccessLevelFilter; + /** + * The search filters. When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, and userArnSession. Example: "SearchQuery":["status:AVAILABLE"] + */ + Filters?: ProvisionedProductFilters; + /** + * The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId. + */ + SortBy?: SortField; + /** + * The sort order. If no value is specified, the results are not sorted. + */ + SortOrder?: SortOrder; + /** + * The maximum number of items to return with this call. + */ + PageSize?: SearchProvisionedProductsPageSize; + /** + * The page token for the next set of results. To retrieve the first set of results, use null. + */ + PageToken?: PageToken; + } + export interface SearchProvisionedProductsOutput { + /** + * Information about the provisioned products. + */ + ProvisionedProducts?: ProvisionedProductAttributes; + /** + * The number of provisioned products found. + */ + TotalResultsCount?: TotalResultsCount; + /** + * The page token to use to retrieve the next set of results. If there are no additional results, this value is null. + */ + NextPageToken?: PageToken; + } + export type SearchProvisionedProductsPageSize = number; + export interface ServiceActionAssociation { + /** + * The self-service action identifier. For example, act-fs7abcd89wxyz. + */ + ServiceActionId: Id; + /** + * The product identifier. For example, prod-abcdzk7xy33qa. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + */ + ProvisioningArtifactId: Id; + } + export type ServiceActionAssociationErrorCode = "DUPLICATE_RESOURCE"|"INTERNAL_FAILURE"|"LIMIT_EXCEEDED"|"RESOURCE_NOT_FOUND"|"THROTTLING"|string; + export type ServiceActionAssociationErrorMessage = string; + export type ServiceActionAssociations = ServiceActionAssociation[]; + export type ServiceActionDefinitionKey = "Name"|"Version"|"AssumeRole"|"Parameters"|string; + export type ServiceActionDefinitionMap = {[key: string]: ServiceActionDefinitionValue}; + export type ServiceActionDefinitionType = "SSM_AUTOMATION"|string; + export type ServiceActionDefinitionValue = string; + export type ServiceActionDescription = string; + export interface ServiceActionDetail { + /** + * Summary information about the self-service action. + */ + ServiceActionSummary?: ServiceActionSummary; + /** + * A map that defines the self-service action. + */ + Definition?: ServiceActionDefinitionMap; + } + export type ServiceActionName = string; + export type ServiceActionSummaries = ServiceActionSummary[]; + export interface ServiceActionSummary { + /** + * The self-service action identifier. + */ + Id?: Id; + /** + * The self-service action name. + */ + Name?: ServiceActionName; + /** + * The self-service action description. + */ + Description?: ServiceActionDescription; + /** + * The self-service action definition type. For example, SSM_AUTOMATION. + */ + DefinitionType?: ServiceActionDefinitionType; + } + export interface ShareDetails { + /** + * List of accounts for whom the operation succeeded. + */ + SuccessfulShares?: SuccessfulShares; + /** + * List of errors. + */ + ShareErrors?: ShareErrors; + } + export interface ShareError { + /** + * List of accounts impacted by the error. + */ + Accounts?: Namespaces; + /** + * Information about the error. + */ + Message?: Message; + /** + * Error type that happened when processing the operation. + */ + Error?: Error; + } + export type ShareErrors = ShareError[]; + export type ShareStatus = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"ERROR"|string; + export type SortField = string; + export type SortOrder = "ASCENDING"|"DESCENDING"|string; + export type SourceProvisioningArtifactProperties = SourceProvisioningArtifactPropertiesMap[]; + export type SourceProvisioningArtifactPropertiesMap = {[key: string]: ProvisioningArtifactPropertyValue}; + export type StackSetAccounts = AccountId[]; + export type StackSetFailureToleranceCount = number; + export type StackSetFailureTolerancePercentage = number; + export type StackSetMaxConcurrencyCount = number; + export type StackSetMaxConcurrencyPercentage = number; + export type StackSetOperationType = "CREATE"|"UPDATE"|"DELETE"|string; + export type StackSetRegions = Region[]; + export type Status = "AVAILABLE"|"CREATING"|"FAILED"|string; + export type StatusDetail = string; + export type StatusMessage = string; + export type SuccessfulShares = AccountId[]; + export type SupportDescription = string; + export type SupportEmail = string; + export type SupportUrl = string; + export interface Tag { + /** + * The tag key. + */ + Key: TagKey; + /** + * The value for this key. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeys = TagKey[]; + export type TagOptionActive = boolean; + export interface TagOptionDetail { + /** + * The TagOption key. + */ + Key?: TagOptionKey; + /** + * The TagOption value. + */ + Value?: TagOptionValue; + /** + * The TagOption active state. + */ + Active?: TagOptionActive; + /** + * The TagOption identifier. + */ + Id?: TagOptionId; + } + export type TagOptionDetails = TagOptionDetail[]; + export type TagOptionId = string; + export type TagOptionKey = string; + export type TagOptionSummaries = TagOptionSummary[]; + export interface TagOptionSummary { + /** + * The TagOption key. + */ + Key?: TagOptionKey; + /** + * The TagOption value. + */ + Values?: TagOptionValues; + } + export type TagOptionValue = string; + export type TagOptionValues = TagOptionValue[]; + export type TagValue = string; + export type Tags = Tag[]; + export interface TerminateProvisionedProductInput { + /** + * The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId. + */ + ProvisionedProductName?: ProvisionedProductNameOrArn; + /** + * The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId. + */ + ProvisionedProductId?: Id; + /** + * An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound. + */ + TerminateToken: IdempotencyToken; + /** + * If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. + */ + IgnoreErrors?: IgnoreErrors; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface TerminateProvisionedProductOutput { + /** + * Information about the result of this request. + */ + RecordDetail?: RecordDetail; + } + export type TotalResultsCount = number; + export interface UpdateConstraintInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The identifier of the constraint. + */ + Id: Id; + /** + * The updated description of the constraint. + */ + Description?: ConstraintDescription; + } + export interface UpdateConstraintOutput { + /** + * Information about the constraint. + */ + ConstraintDetail?: ConstraintDetail; + /** + * The constraint parameters. + */ + ConstraintParameters?: ConstraintParameters; + /** + * The status of the current request. + */ + Status?: Status; + } + export interface UpdatePortfolioInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The portfolio identifier. + */ + Id: Id; + /** + * The name to use for display purposes. + */ + DisplayName?: PortfolioDisplayName; + /** + * The updated description of the portfolio. + */ + Description?: PortfolioDescription; + /** + * The updated name of the portfolio provider. + */ + ProviderName?: ProviderName; + /** + * The tags to add. + */ + AddTags?: AddTags; + /** + * The tags to remove. + */ + RemoveTags?: TagKeys; + } + export interface UpdatePortfolioOutput { + /** + * Information about the portfolio. + */ + PortfolioDetail?: PortfolioDetail; + /** + * Information about the tags associated with the portfolio. + */ + Tags?: Tags; + } + export interface UpdateProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + Id: Id; + /** + * The updated product name. + */ + Name?: ProductViewName; + /** + * The updated owner of the product. + */ + Owner?: ProductViewOwner; + /** + * The updated description of the product. + */ + Description?: ProductViewShortDescription; + /** + * The updated distributor of the product. + */ + Distributor?: ProductViewOwner; + /** + * The updated support description for the product. + */ + SupportDescription?: SupportDescription; + /** + * The updated support email for the product. + */ + SupportEmail?: SupportEmail; + /** + * The updated support URL for the product. + */ + SupportUrl?: SupportUrl; + /** + * The tags to add to the product. + */ + AddTags?: AddTags; + /** + * The tags to remove from the product. + */ + RemoveTags?: TagKeys; + } + export interface UpdateProductOutput { + /** + * Information about the product view. + */ + ProductViewDetail?: ProductViewDetail; + /** + * Information about the tags associated with the product. + */ + Tags?: Tags; + } + export interface UpdateProvisionedProductInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The updated name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId. + */ + ProvisionedProductName?: ProvisionedProductNameOrArn; + /** + * The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId. + */ + ProvisionedProductId?: Id; + /** + * The identifier of the product. + */ + ProductId?: Id; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId?: Id; + /** + * The new path identifier. This value is optional if the product has a default path, and required if the product has more than one path. + */ + PathId?: Id; + /** + * The new parameters. + */ + ProvisioningParameters?: UpdateProvisioningParameters; + /** + * An object that contains information about the provisioning preferences for a stack set. + */ + ProvisioningPreferences?: UpdateProvisioningPreferences; + /** + * One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. + */ + Tags?: Tags; + /** + * The idempotency token that uniquely identifies the provisioning update request. + */ + UpdateToken: IdempotencyToken; + } + export interface UpdateProvisionedProductOutput { + /** + * Information about the result of the request. + */ + RecordDetail?: RecordDetail; + } + export interface UpdateProvisioningArtifactInput { + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + /** + * The product identifier. + */ + ProductId: Id; + /** + * The identifier of the provisioning artifact. + */ + ProvisioningArtifactId: Id; + /** + * The updated name of the provisioning artifact. + */ + Name?: ProvisioningArtifactName; + /** + * The updated description of the provisioning artifact. + */ + Description?: ProvisioningArtifactDescription; + /** + * Indicates whether the product version is active. + */ + Active?: ProvisioningArtifactActive; + } + export interface UpdateProvisioningArtifactOutput { + /** + * Information about the provisioning artifact. + */ + ProvisioningArtifactDetail?: ProvisioningArtifactDetail; + /** + * The URL of the CloudFormation template in Amazon S3. + */ + Info?: ProvisioningArtifactInfo; + /** + * The status of the current request. + */ + Status?: Status; + } + export interface UpdateProvisioningParameter { + /** + * The parameter key. + */ + Key?: ParameterKey; + /** + * The parameter value. + */ + Value?: ParameterValue; + /** + * If set to true, Value is ignored and the previous parameter value is kept. + */ + UsePreviousValue?: UsePreviousValue; + } + export type UpdateProvisioningParameters = UpdateProvisioningParameter[]; + export interface UpdateProvisioningPreferences { + /** + * One or more AWS accounts that will have access to the provisioned product. Applicable only to a CFN_STACKSET provisioned product type. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation. If no values are specified, the default value is all accounts from the STACKSET constraint. + */ + StackSetAccounts?: StackSetAccounts; + /** + * One or more AWS Regions where the provisioned product will be available. Applicable only to a CFN_STACKSET provisioned product type. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation. If no values are specified, the default value is all regions from the STACKSET constraint. + */ + StackSetRegions?: StackSetRegions; + /** + * The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. The default value is 0 if no value is specified. + */ + StackSetFailureToleranceCount?: StackSetFailureToleranceCount; + /** + * The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both. + */ + StackSetFailureTolerancePercentage?: StackSetFailureTolerancePercentage; + /** + * The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both. + */ + StackSetMaxConcurrencyCount?: StackSetMaxConcurrencyCount; + /** + * The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Applicable only to a CFN_STACKSET provisioned product type. Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both. + */ + StackSetMaxConcurrencyPercentage?: StackSetMaxConcurrencyPercentage; + /** + * Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified. Applicable only to a CFN_STACKSET provisioned product type. CREATE Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored. UPDATE Updates the stack set represented by the provisioned product and also its stack instances. DELETE Deletes a stack instance in the stack set represented by the provisioned product. + */ + StackSetOperationType?: StackSetOperationType; + } + export interface UpdateServiceActionInput { + /** + * The self-service action identifier. + */ + Id: Id; + /** + * The self-service action name. + */ + Name?: ServiceActionName; + /** + * A map that defines the self-service action. + */ + Definition?: ServiceActionDefinitionMap; + /** + * The self-service action description. + */ + Description?: ServiceActionDescription; + /** + * The language code. en - English (default) jp - Japanese zh - Chinese + */ + AcceptLanguage?: AcceptLanguage; + } + export interface UpdateServiceActionOutput { + /** + * Detailed information about the self-service action. + */ + ServiceActionDetail?: ServiceActionDetail; + } + export interface UpdateTagOptionInput { + /** + * The TagOption identifier. + */ + Id: TagOptionId; + /** + * The updated value. + */ + Value?: TagOptionValue; + /** + * The updated active state. + */ + Active?: TagOptionActive; + } + export interface UpdateTagOptionOutput { + /** + * Information about the TagOption. + */ + TagOptionDetail?: TagOptionDetail; + } + export type UpdatedTime = Date; + export interface UsageInstruction { + /** + * The usage instruction type for the value. + */ + Type?: InstructionType; + /** + * The usage instruction value for this type. + */ + Value?: InstructionValue; + } + export type UsageInstructions = UsageInstruction[]; + export type UsePreviousValue = boolean; + export type UserArn = string; + export type UserArnSession = string; + export type Verbose = boolean; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-12-10"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ServiceCatalog client. + */ + export import Types = ServiceCatalog; +} +export = ServiceCatalog; diff --git a/node_modules/aws-sdk/clients/servicecatalog.js b/node_modules/aws-sdk/clients/servicecatalog.js new file mode 100644 index 0000000..d005048 --- /dev/null +++ b/node_modules/aws-sdk/clients/servicecatalog.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['servicecatalog'] = {}; +AWS.ServiceCatalog = Service.defineService('servicecatalog', ['2015-12-10']); +Object.defineProperty(apiLoader.services['servicecatalog'], '2015-12-10', { + get: function get() { + var model = require('../apis/servicecatalog-2015-12-10.min.json'); + model.paginators = require('../apis/servicecatalog-2015-12-10.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ServiceCatalog; diff --git a/node_modules/aws-sdk/clients/servicediscovery.d.ts b/node_modules/aws-sdk/clients/servicediscovery.d.ts new file mode 100644 index 0000000..7f06701 --- /dev/null +++ b/node_modules/aws-sdk/clients/servicediscovery.d.ts @@ -0,0 +1,991 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class ServiceDiscovery extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: ServiceDiscovery.Types.ClientConfiguration) + config: Config & ServiceDiscovery.Types.ClientConfiguration; + /** + * Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createHttpNamespace(params: ServiceDiscovery.Types.CreateHttpNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateHttpNamespaceResponse) => void): Request; + /** + * Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createHttpNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateHttpNamespaceResponse) => void): Request; + /** + * Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createPrivateDnsNamespace(params: ServiceDiscovery.Types.CreatePrivateDnsNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePrivateDnsNamespaceResponse) => void): Request; + /** + * Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createPrivateDnsNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePrivateDnsNamespaceResponse) => void): Request; + /** + * Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createPublicDnsNamespace(params: ServiceDiscovery.Types.CreatePublicDnsNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePublicDnsNamespaceResponse) => void): Request; + /** + * Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createPublicDnsNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreatePublicDnsNamespaceResponse) => void): Request; + /** + * Creates a service, which defines the configuration for the following entities: For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: A AAAA A and AAAA SRV CNAME Optionally, a health check After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities. For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createService(params: ServiceDiscovery.Types.CreateServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateServiceResponse) => void): Request; + /** + * Creates a service, which defines the configuration for the following entities: For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: A AAAA A and AAAA SRV CNAME Optionally, a health check After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities. For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + createService(callback?: (err: AWSError, data: ServiceDiscovery.Types.CreateServiceResponse) => void): Request; + /** + * Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails. + */ + deleteNamespace(params: ServiceDiscovery.Types.DeleteNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteNamespaceResponse) => void): Request; + /** + * Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails. + */ + deleteNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteNamespaceResponse) => void): Request; + /** + * Deletes a specified service. If the service still contains one or more registered instances, the request fails. + */ + deleteService(params: ServiceDiscovery.Types.DeleteServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteServiceResponse) => void): Request; + /** + * Deletes a specified service. If the service still contains one or more registered instances, the request fails. + */ + deleteService(callback?: (err: AWSError, data: ServiceDiscovery.Types.DeleteServiceResponse) => void): Request; + /** + * Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance. + */ + deregisterInstance(params: ServiceDiscovery.Types.DeregisterInstanceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DeregisterInstanceResponse) => void): Request; + /** + * Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance. + */ + deregisterInstance(callback?: (err: AWSError, data: ServiceDiscovery.Types.DeregisterInstanceResponse) => void): Request; + /** + * Discovers registered instances for a specified namespace and service. + */ + discoverInstances(params: ServiceDiscovery.Types.DiscoverInstancesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.DiscoverInstancesResponse) => void): Request; + /** + * Discovers registered instances for a specified namespace and service. + */ + discoverInstances(callback?: (err: AWSError, data: ServiceDiscovery.Types.DiscoverInstancesResponse) => void): Request; + /** + * Gets information about a specified instance. + */ + getInstance(params: ServiceDiscovery.Types.GetInstanceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstanceResponse) => void): Request; + /** + * Gets information about a specified instance. + */ + getInstance(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstanceResponse) => void): Request; + /** + * Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service. There is a brief delay between when you register an instance and when the health status for the instance is available. + */ + getInstancesHealthStatus(params: ServiceDiscovery.Types.GetInstancesHealthStatusRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstancesHealthStatusResponse) => void): Request; + /** + * Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service. There is a brief delay between when you register an instance and when the health status for the instance is available. + */ + getInstancesHealthStatus(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetInstancesHealthStatusResponse) => void): Request; + /** + * Gets information about a namespace. + */ + getNamespace(params: ServiceDiscovery.Types.GetNamespaceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetNamespaceResponse) => void): Request; + /** + * Gets information about a namespace. + */ + getNamespace(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetNamespaceResponse) => void): Request; + /** + * Gets information about any operation that returns an operation ID in the response, such as a CreateService request. To get a list of operations that match specified criteria, see ListOperations. + */ + getOperation(params: ServiceDiscovery.Types.GetOperationRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetOperationResponse) => void): Request; + /** + * Gets information about any operation that returns an operation ID in the response, such as a CreateService request. To get a list of operations that match specified criteria, see ListOperations. + */ + getOperation(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetOperationResponse) => void): Request; + /** + * Gets the settings for a specified service. + */ + getService(params: ServiceDiscovery.Types.GetServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.GetServiceResponse) => void): Request; + /** + * Gets the settings for a specified service. + */ + getService(callback?: (err: AWSError, data: ServiceDiscovery.Types.GetServiceResponse) => void): Request; + /** + * Lists summary information about the instances that you registered by using a specified service. + */ + listInstances(params: ServiceDiscovery.Types.ListInstancesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListInstancesResponse) => void): Request; + /** + * Lists summary information about the instances that you registered by using a specified service. + */ + listInstances(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListInstancesResponse) => void): Request; + /** + * Lists summary information about the namespaces that were created by the current AWS account. + */ + listNamespaces(params: ServiceDiscovery.Types.ListNamespacesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListNamespacesResponse) => void): Request; + /** + * Lists summary information about the namespaces that were created by the current AWS account. + */ + listNamespaces(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListNamespacesResponse) => void): Request; + /** + * Lists operations that match the criteria that you specify. + */ + listOperations(params: ServiceDiscovery.Types.ListOperationsRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListOperationsResponse) => void): Request; + /** + * Lists operations that match the criteria that you specify. + */ + listOperations(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListOperationsResponse) => void): Request; + /** + * Lists summary information for all the services that are associated with one or more specified namespaces. + */ + listServices(params: ServiceDiscovery.Types.ListServicesRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.ListServicesResponse) => void): Request; + /** + * Lists summary information for all the services that are associated with one or more specified namespaces. + */ + listServices(callback?: (err: AWSError, data: ServiceDiscovery.Types.ListServicesResponse) => void): Request; + /** + * Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs: For each DNS record that you define in the service that is specified by ServiceId, a record is created or updated in the hosted zone that is associated with the corresponding namespace. If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration. The health check, if any, is associated with each of the new or updated records. One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID. For more information, see CreateService. When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value: If the health check is healthy: returns all the records If the health check is unhealthy: returns the applicable value for the last healthy instance If you didn't specify a health check configuration: returns all the records For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + registerInstance(params: ServiceDiscovery.Types.RegisterInstanceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.RegisterInstanceResponse) => void): Request; + /** + * Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs: For each DNS record that you define in the service that is specified by ServiceId, a record is created or updated in the hosted zone that is associated with the corresponding namespace. If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration. The health check, if any, is associated with each of the new or updated records. One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID. For more information, see CreateService. When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value: If the health check is healthy: returns all the records If the health check is unhealthy: returns the applicable value for the last healthy instance If you didn't specify a health check configuration: returns all the records For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide. + */ + registerInstance(callback?: (err: AWSError, data: ServiceDiscovery.Types.RegisterInstanceResponse) => void): Request; + /** + * Submits a request to change the health status of a custom health check to healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig. For more information, see HealthCheckCustomConfig. + */ + updateInstanceCustomHealthStatus(params: ServiceDiscovery.Types.UpdateInstanceCustomHealthStatusRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Submits a request to change the health status of a custom health check to healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig. For more information, see HealthCheckCustomConfig. + */ + updateInstanceCustomHealthStatus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Submits a request to perform the following operations: Add or delete DnsRecords configurations Update the TTL setting for existing DnsRecords configurations Add, update, or delete HealthCheckConfig for a specified service For public and private DNS namespaces, you must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted. When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service. + */ + updateService(params: ServiceDiscovery.Types.UpdateServiceRequest, callback?: (err: AWSError, data: ServiceDiscovery.Types.UpdateServiceResponse) => void): Request; + /** + * Submits a request to perform the following operations: Add or delete DnsRecords configurations Update the TTL setting for existing DnsRecords configurations Add, update, or delete HealthCheckConfig for a specified service For public and private DNS namespaces, you must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted. When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service. + */ + updateService(callback?: (err: AWSError, data: ServiceDiscovery.Types.UpdateServiceResponse) => void): Request; +} +declare namespace ServiceDiscovery { + export type Arn = string; + export type AttrKey = string; + export type AttrValue = string; + export type Attributes = {[key: string]: AttrValue}; + export type Code = string; + export interface CreateHttpNamespaceRequest { + /** + * The name that you want to assign to this namespace. + */ + Name: NamespaceName; + /** + * A unique string that identifies the request and that allows failed CreateHttpNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId?: ResourceId; + /** + * A description for the namespace. + */ + Description?: ResourceDescription; + } + export interface CreateHttpNamespaceResponse { + /** + * A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation. + */ + OperationId?: OperationId; + } + export interface CreatePrivateDnsNamespaceRequest { + /** + * The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace. + */ + Name: NamespaceName; + /** + * A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId?: ResourceId; + /** + * A description for the namespace. + */ + Description?: ResourceDescription; + /** + * The ID of the Amazon VPC that you want to associate the namespace with. + */ + Vpc: ResourceId; + } + export interface CreatePrivateDnsNamespaceResponse { + /** + * A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation. + */ + OperationId?: OperationId; + } + export interface CreatePublicDnsNamespaceRequest { + /** + * The name that you want to assign to this namespace. + */ + Name: NamespaceName; + /** + * A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId?: ResourceId; + /** + * A description for the namespace. + */ + Description?: ResourceDescription; + } + export interface CreatePublicDnsNamespaceResponse { + /** + * A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation. + */ + OperationId?: OperationId; + } + export interface CreateServiceRequest { + /** + * The name that you want to assign to the service. + */ + Name: ServiceName; + /** + * The ID of the namespace that you want to use to create the service. + */ + NamespaceId?: ResourceId; + /** + * A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId?: ResourceId; + /** + * A description for the service. + */ + Description?: ResourceDescription; + /** + * A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance. + */ + DnsConfig?: DnsConfig; + /** + * Public DNS namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig. If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. For information about the charges for health checks, see AWS Cloud Map Pricing. + */ + HealthCheckConfig?: HealthCheckConfig; + /** + * A complex type that contains information about an optional custom health check. If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. + */ + HealthCheckCustomConfig?: HealthCheckCustomConfig; + } + export interface CreateServiceResponse { + /** + * A complex type that contains information about the new service. + */ + Service?: Service; + } + export type CustomHealthStatus = "HEALTHY"|"UNHEALTHY"|string; + export interface DeleteNamespaceRequest { + /** + * The ID of the namespace that you want to delete. + */ + Id: ResourceId; + } + export interface DeleteNamespaceResponse { + /** + * A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation. + */ + OperationId?: OperationId; + } + export interface DeleteServiceRequest { + /** + * The ID of the service that you want to delete. + */ + Id: ResourceId; + } + export interface DeleteServiceResponse { + } + export interface DeregisterInstanceRequest { + /** + * The ID of the service that the instance is associated with. + */ + ServiceId: ResourceId; + /** + * The value that you specified for Id in the RegisterInstance request. + */ + InstanceId: ResourceId; + } + export interface DeregisterInstanceResponse { + /** + * A value that you can use to determine whether the request completed successfully. For more information, see GetOperation. + */ + OperationId?: OperationId; + } + export interface DiscoverInstancesRequest { + /** + * The name of the namespace that you specified when you registered the instance. + */ + NamespaceName: NamespaceName; + /** + * The name of the service that you specified when you registered the instance. + */ + ServiceName: ServiceName; + /** + * The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances. + */ + MaxResults?: MaxResults; + /** + * A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned. + */ + QueryParameters?: Attributes; + /** + * The health status of the instances that you want to discover. + */ + HealthStatus?: HealthStatusFilter; + } + export interface DiscoverInstancesResponse { + /** + * A complex type that contains one HttpInstanceSummary for each registered instance. + */ + Instances?: HttpInstanceSummaryList; + } + export interface DnsConfig { + /** + * The ID of the namespace to use for DNS configuration. + */ + NamespaceId?: ResourceId; + /** + * The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service. If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy. You can specify the following values: MULTIVALUE If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances. For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances. If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances. For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide. WEIGHTED Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances. For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy. If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance. For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide. + */ + RoutingPolicy?: RoutingPolicy; + /** + * An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance. + */ + DnsRecords: DnsRecordList; + } + export interface DnsConfigChange { + /** + * An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to create when you register an instance. + */ + DnsRecords: DnsRecordList; + } + export interface DnsProperties { + /** + * The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace. + */ + HostedZoneId?: ResourceId; + } + export interface DnsRecord { + /** + * The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. Note the following: A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination. CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS: you can't create a CNAME record and any other type of record that has the same name as a CNAME record. Alias records: If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type. All records: You specify settings other than TTL and Type when you register an instance. The following values are supported: A Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44. AAAA Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345. CNAME Route 53 returns the domain name of the resource, such as www.example.com. Note the following: You specify the domain name that you want to route traffic to when you register an instance. For more information, see RegisterInstanceRequest$Attributes. You must specify WEIGHTED for the value of RoutingPolicy. You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error. SRV Route 53 returns the value for an SRV record. The value for an SRV record uses the following values: priority weight port service-hostname Note the following about the values: The values of priority and weight are both set to 1 and can't be changed. The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request. The value of service-hostname is a concatenation of the following values: The value that you specify for InstanceId when you register an instance. The name of the service. The name of the namespace. For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is: test.backend.example.com If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records. + */ + Type: RecordType; + /** + * The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record. Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records. + */ + TTL: RecordTTL; + } + export type DnsRecordList = DnsRecord[]; + export type FailureThreshold = number; + export type FilterCondition = "EQ"|"IN"|"BETWEEN"|string; + export type FilterValue = string; + export type FilterValues = FilterValue[]; + export interface GetInstanceRequest { + /** + * The ID of the service that the instance is associated with. + */ + ServiceId: ResourceId; + /** + * The ID of the instance that you want to get information about. + */ + InstanceId: ResourceId; + } + export interface GetInstanceResponse { + /** + * A complex type that contains information about a specified instance. + */ + Instance?: Instance; + } + export interface GetInstancesHealthStatusRequest { + /** + * The ID of the service that the instance is associated with. + */ + ServiceId: ResourceId; + /** + * An array that contains the IDs of all the instances that you want to get the health status for. If you omit Instances, AWS Cloud Map returns the health status for all the instances that are associated with the specified service. To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request. + */ + Instances?: InstanceIdList; + /** + * The maximum number of instances that you want AWS Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances. + */ + MaxResults?: MaxResults; + /** + * For the first GetInstancesHealthStatus request, omit this value. If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request. + */ + NextToken?: NextToken; + } + export interface GetInstancesHealthStatusResponse { + /** + * A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request. + */ + Status?: InstanceHealthStatusMap; + /** + * If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request. + */ + NextToken?: NextToken; + } + export interface GetNamespaceRequest { + /** + * The ID of the namespace that you want to get information about. + */ + Id: ResourceId; + } + export interface GetNamespaceResponse { + /** + * A complex type that contains information about the specified namespace. + */ + Namespace?: Namespace; + } + export interface GetOperationRequest { + /** + * The ID of the operation that you want to get more information about. + */ + OperationId: ResourceId; + } + export interface GetOperationResponse { + /** + * A complex type that contains information about the operation. + */ + Operation?: Operation; + } + export interface GetServiceRequest { + /** + * The ID of the service that you want to get settings for. + */ + Id: ResourceId; + } + export interface GetServiceResponse { + /** + * A complex type that contains information about the service. + */ + Service?: Service; + } + export interface HealthCheckConfig { + /** + * The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. You can't change the value of Type after you create a health check. You can create the following types of health checks: HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later. TCP: Route 53 tries to establish a TCP connection. If you specify TCP for Type, don't specify a value for ResourcePath. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide. + */ + Type: HealthCheckType; + /** + * The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /. If you specify TCP for Type, you must not specify a value for ResourcePath. + */ + ResourcePath?: ResourcePath; + /** + * The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide. + */ + FailureThreshold?: FailureThreshold; + } + export interface HealthCheckCustomConfig { + /** + * The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request. Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change. + */ + FailureThreshold?: FailureThreshold; + } + export type HealthCheckType = "HTTP"|"HTTPS"|"TCP"|string; + export type HealthStatus = "HEALTHY"|"UNHEALTHY"|"UNKNOWN"|string; + export type HealthStatusFilter = "HEALTHY"|"UNHEALTHY"|"ALL"|string; + export interface HttpInstanceSummary { + /** + * The ID of an instance that matches the values that you specified in the request. + */ + InstanceId?: ResourceId; + /** + * The name of the namespace that you specified when you registered the instance. + */ + NamespaceName?: NamespaceName; + /** + * The name of the service that you specified when you registered the instance. + */ + ServiceName?: ServiceName; + /** + * If you configured health checking in the service, the current health status of the service instance. + */ + HealthStatus?: HealthStatus; + /** + * If you included any attributes when you registered the instance, the values of those attributes. + */ + Attributes?: Attributes; + } + export type HttpInstanceSummaryList = HttpInstanceSummary[]; + export interface HttpProperties { + /** + * The name of an HTTP namespace. + */ + HttpName?: NamespaceName; + } + export interface Instance { + /** + * An identifier that you want to associate with the instance. Note the following: If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord$Type. You can use this value to update an existing instance. To register a new instance, you must specify a value that is unique among instances that you register by using the same service. If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one. The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example. + */ + Id: ResourceId; + /** + * A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId?: ResourceId; + /** + * A string map that contains the following information for the service that you specify in ServiceId: The attributes that apply to the records that are defined in the service. For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget. Note the following: The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both. In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED. If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record. Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers. If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes. AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record. AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44. This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_PORT If the service includes an SRV record, the value that you want Route 53 to return for the port. If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to. This value is required if you specified settings for an SRV record when you created the service. + */ + Attributes?: Attributes; + } + export type InstanceHealthStatusMap = {[key: string]: HealthStatus}; + export type InstanceIdList = ResourceId[]; + export interface InstanceSummary { + /** + * The ID for an instance that you created by using a specified service. + */ + Id?: ResourceId; + /** + * A string map that contains the following information: The attributes that are associate with the instance. For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the load balancer. AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example, example.com. AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example, 192.0.2.44. AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to. + */ + Attributes?: Attributes; + } + export type InstanceSummaryList = InstanceSummary[]; + export interface ListInstancesRequest { + /** + * The ID of the service that you want to list instances for. + */ + ServiceId: ResourceId; + /** + * For the first ListInstances request, omit this value. If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request. + */ + NextToken?: NextToken; + /** + * The maximum number of instances that you want AWS Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances. + */ + MaxResults?: MaxResults; + } + export interface ListInstancesResponse { + /** + * Summary information about the instances that are associated with the specified service. + */ + Instances?: InstanceSummaryList; + /** + * If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request. + */ + NextToken?: NextToken; + } + export interface ListNamespacesRequest { + /** + * For the first ListNamespaces request, omit this value. If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria. + */ + NextToken?: NextToken; + /** + * The maximum number of namespaces that you want AWS Cloud Map to return in the response to a ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 namespaces. + */ + MaxResults?: MaxResults; + /** + * A complex type that contains specifications for the namespaces that you want to list. If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces. + */ + Filters?: NamespaceFilters; + } + export interface ListNamespacesResponse { + /** + * An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria. + */ + Namespaces?: NamespaceSummariesList; + /** + * If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria. + */ + NextToken?: NextToken; + } + export interface ListOperationsRequest { + /** + * For the first ListOperations request, omit this value. If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria. + */ + NextToken?: NextToken; + /** + * The maximum number of items that you want AWS Cloud Map to return in the response to a ListOperations request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 operations. + */ + MaxResults?: MaxResults; + /** + * A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date. If you specify more than one filter, an operation must match all filters to be returned by ListOperations. + */ + Filters?: OperationFilters; + } + export interface ListOperationsResponse { + /** + * Summary information about the operations that match the specified criteria. + */ + Operations?: OperationSummaryList; + /** + * If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria. + */ + NextToken?: NextToken; + } + export interface ListServicesRequest { + /** + * For the first ListServices request, omit this value. If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria. + */ + NextToken?: NextToken; + /** + * The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services. + */ + MaxResults?: MaxResults; + /** + * A complex type that contains specifications for the namespaces that you want to list services for. If you specify more than one filter, an operation must match all filters to be returned by ListServices. + */ + Filters?: ServiceFilters; + } + export interface ListServicesResponse { + /** + * An array that contains one ServiceSummary object for each service that matches the specified filter criteria. + */ + Services?: ServiceSummariesList; + /** + * If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request. AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria. + */ + NextToken?: NextToken; + } + export type MaxResults = number; + export type Message = string; + export interface Namespace { + /** + * The ID of a namespace. + */ + Id?: ResourceId; + /** + * The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it. + */ + Arn?: Arn; + /** + * The name of the namespace, such as example.com. + */ + Name?: NamespaceName; + /** + * The type of the namespace. Valid values are DNS_PUBLIC and DNS_PRIVATE. + */ + Type?: NamespaceType; + /** + * The description that you specify for the namespace when you create it. + */ + Description?: ResourceDescription; + /** + * The number of services that are associated with the namespace. + */ + ServiceCount?: ResourceCount; + /** + * A complex type that contains information that's specific to the type of the namespace. + */ + Properties?: NamespaceProperties; + /** + * The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreateDate?: Timestamp; + /** + * A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice. + */ + CreatorRequestId?: ResourceId; + } + export interface NamespaceFilter { + /** + * Specify TYPE. + */ + Name: NamespaceFilterName; + /** + * If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE. If you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE, or both. + */ + Values: FilterValues; + /** + * The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include: EQ: When you specify EQ for the condition, you can choose to list only public namespaces or private namespaces, but not both. EQ is the default condition and can be omitted. IN: When you specify IN for the condition, you can choose to list public namespaces, private namespaces, or both. BETWEEN: Not applicable + */ + Condition?: FilterCondition; + } + export type NamespaceFilterName = "TYPE"|string; + export type NamespaceFilters = NamespaceFilter[]; + export type NamespaceName = string; + export interface NamespaceProperties { + /** + * A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace. + */ + DnsProperties?: DnsProperties; + /** + * A complex type that contains the name of an HTTP namespace. + */ + HttpProperties?: HttpProperties; + } + export type NamespaceSummariesList = NamespaceSummary[]; + export interface NamespaceSummary { + /** + * The ID of the namespace. + */ + Id?: ResourceId; + /** + * The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it. + */ + Arn?: Arn; + /** + * The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace. + */ + Name?: NamespaceName; + /** + * The type of the namespace, either public or private. + */ + Type?: NamespaceType; + /** + * A description for the namespace. + */ + Description?: ResourceDescription; + /** + * The number of services that were created using the namespace. + */ + ServiceCount?: ResourceCount; + Properties?: NamespaceProperties; + /** + * The date and time that the namespace was created. + */ + CreateDate?: Timestamp; + } + export type NamespaceType = "DNS_PUBLIC"|"DNS_PRIVATE"|"HTTP"|string; + export type NextToken = string; + export interface Operation { + /** + * The ID of the operation that you want to get information about. + */ + Id?: OperationId; + /** + * The name of the operation that is associated with the specified ID. + */ + Type?: OperationType; + /** + * The status of the operation. Values include the following: SUBMITTED: This is the initial state immediately after you submit a request. PENDING: AWS Cloud Map is performing the operation. SUCCESS: The operation succeeded. FAIL: The operation failed. For the failure reason, see ErrorMessage. + */ + Status?: OperationStatus; + /** + * If the value of Status is FAIL, the reason that the operation failed. + */ + ErrorMessage?: Message; + /** + * The code associated with ErrorMessage. Values for ErrorCode include the following: ACCESS_DENIED CANNOT_CREATE_HOSTED_ZONE EXPIRED_TOKEN HOSTED_ZONE_NOT_FOUND INTERNAL_FAILURE INVALID_CHANGE_BATCH THROTTLED_REQUEST + */ + ErrorCode?: Code; + /** + * The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreateDate?: Timestamp; + /** + * The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + UpdateDate?: Timestamp; + /** + * The name of the target entity that is associated with the operation: NAMESPACE: The namespace ID is returned in the ResourceId property. SERVICE: The service ID is returned in the ResourceId property. INSTANCE: The instance ID is returned in the ResourceId property. + */ + Targets?: OperationTargetsMap; + } + export interface OperationFilter { + /** + * Specify the operations that you want to get: NAMESPACE_ID: Gets operations related to specified namespaces. SERVICE_ID: Gets operations related to specified services. STATUS: Gets operations based on the status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL. TYPE: Gets specified types of operation. UPDATE_DATE: Gets operations that changed status during a specified date/time range. + */ + Name: OperationFilterName; + /** + * Specify values that are applicable to the value that you specify for Name: NAMESPACE_ID: Specify one namespace ID. SERVICE_ID: Specify one service ID. STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or FAIL. TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE. UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. + */ + Values: FilterValues; + /** + * The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include: EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted. IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. An operation must match one of the specified values to be returned in the response. BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE. + */ + Condition?: FilterCondition; + } + export type OperationFilterName = "NAMESPACE_ID"|"SERVICE_ID"|"STATUS"|"TYPE"|"UPDATE_DATE"|string; + export type OperationFilters = OperationFilter[]; + export type OperationId = string; + export type OperationStatus = "SUBMITTED"|"PENDING"|"SUCCESS"|"FAIL"|string; + export interface OperationSummary { + /** + * The ID for an operation. + */ + Id?: OperationId; + /** + * The status of the operation. Values include the following: SUBMITTED: This is the initial state immediately after you submit a request. PENDING: AWS Cloud Map is performing the operation. SUCCESS: The operation succeeded. FAIL: The operation failed. For the failure reason, see ErrorMessage. + */ + Status?: OperationStatus; + } + export type OperationSummaryList = OperationSummary[]; + export type OperationTargetType = "NAMESPACE"|"SERVICE"|"INSTANCE"|string; + export type OperationTargetsMap = {[key: string]: ResourceId}; + export type OperationType = "CREATE_NAMESPACE"|"DELETE_NAMESPACE"|"UPDATE_SERVICE"|"REGISTER_INSTANCE"|"DEREGISTER_INSTANCE"|string; + export type RecordTTL = number; + export type RecordType = "SRV"|"A"|"AAAA"|"CNAME"|string; + export interface RegisterInstanceRequest { + /** + * The ID of the service that you want to use for settings for the instance. + */ + ServiceId: ResourceId; + /** + * An identifier that you want to associate with the instance. Note the following: If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord$Type. You can use this value to update an existing instance. To register a new instance, you must specify a value that is unique among instances that you register by using the same service. If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one. The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example. + */ + InstanceId: ResourceId; + /** + * A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId?: ResourceId; + /** + * A string map that contains the following information for the service that you specify in ServiceId: The attributes that apply to the records that are defined in the service. For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget in the Route 53 API Reference. Note the following: The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both. In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED. If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the Route 53 health check, but it won't associate the health check with the alias record. Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers. If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes. AWS_INIT_HEALTH_STATUS If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY. AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record. AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44. This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_PORT If the service includes an SRV record, the value that you want Route 53 to return for the port. If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to. This value is required if you specified settings for an SRV record when you created the service. Custom attributes You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters. + */ + Attributes: Attributes; + } + export interface RegisterInstanceResponse { + /** + * A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation. + */ + OperationId?: OperationId; + } + export type ResourceCount = number; + export type ResourceDescription = string; + export type ResourceId = string; + export type ResourcePath = string; + export type RoutingPolicy = "MULTIVALUE"|"WEIGHTED"|string; + export interface Service { + /** + * The ID that AWS Cloud Map assigned to the service when you created it. + */ + Id?: ResourceId; + /** + * The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it. + */ + Arn?: Arn; + /** + * The name of the service. + */ + Name?: ServiceName; + /** + * The ID of the namespace that was used to create the service. + */ + NamespaceId?: ResourceId; + /** + * The description of the service. + */ + Description?: ResourceDescription; + /** + * The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. + */ + InstanceCount?: ResourceCount; + /** + * A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. + */ + DnsConfig?: DnsConfig; + /** + * Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. For information about the charges for health checks, see Amazon Route 53 Pricing. + */ + HealthCheckConfig?: HealthCheckConfig; + /** + * A complex type that contains information about an optional custom health check. If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. + */ + HealthCheckCustomConfig?: HealthCheckCustomConfig; + /** + * The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + */ + CreateDate?: Timestamp; + /** + * A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. + */ + CreatorRequestId?: ResourceId; + } + export interface ServiceChange { + /** + * A description for the service. + */ + Description?: ResourceDescription; + /** + * A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance. + */ + DnsConfig: DnsConfigChange; + HealthCheckConfig?: HealthCheckConfig; + } + export interface ServiceFilter { + /** + * Specify NAMESPACE_ID. + */ + Name: ServiceFilterName; + /** + * The values that are applicable to the value that you specify for Condition to filter the list of services. + */ + Values: FilterValues; + /** + * The operator that you want to use to determine whether a service is returned by ListServices. Valid values for Condition include the following: EQ: When you specify EQ, specify one namespace ID for Values. EQ is the default condition and can be omitted. IN: When you specify IN, specify a list of the IDs for the namespaces that you want ListServices to return a list of services for. BETWEEN: Not applicable. + */ + Condition?: FilterCondition; + } + export type ServiceFilterName = "NAMESPACE_ID"|string; + export type ServiceFilters = ServiceFilter[]; + export type ServiceName = string; + export type ServiceSummariesList = ServiceSummary[]; + export interface ServiceSummary { + /** + * The ID that AWS Cloud Map assigned to the service when you created it. + */ + Id?: ResourceId; + /** + * The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it. + */ + Arn?: Arn; + /** + * The name of the service. + */ + Name?: ServiceName; + /** + * The description that you specify when you create the service. + */ + Description?: ResourceDescription; + /** + * The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. + */ + InstanceCount?: ResourceCount; + DnsConfig?: DnsConfig; + HealthCheckConfig?: HealthCheckConfig; + HealthCheckCustomConfig?: HealthCheckCustomConfig; + /** + * The date and time that the service was created. + */ + CreateDate?: Timestamp; + } + export type Timestamp = Date; + export interface UpdateInstanceCustomHealthStatusRequest { + /** + * The ID of the service that includes the configuration for the custom health check that you want to change the status for. + */ + ServiceId: ResourceId; + /** + * The ID of the instance that you want to change the health status for. + */ + InstanceId: ResourceId; + /** + * The new status of the instance, HEALTHY or UNHEALTHY. + */ + Status: CustomHealthStatus; + } + export interface UpdateServiceRequest { + /** + * The ID of the service that you want to update. + */ + Id: ResourceId; + /** + * A complex type that contains the new settings for the service. + */ + Service: ServiceChange; + } + export interface UpdateServiceResponse { + /** + * A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation. + */ + OperationId?: OperationId; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-03-14"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the ServiceDiscovery client. + */ + export import Types = ServiceDiscovery; +} +export = ServiceDiscovery; diff --git a/node_modules/aws-sdk/clients/servicediscovery.js b/node_modules/aws-sdk/clients/servicediscovery.js new file mode 100644 index 0000000..e293fbe --- /dev/null +++ b/node_modules/aws-sdk/clients/servicediscovery.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['servicediscovery'] = {}; +AWS.ServiceDiscovery = Service.defineService('servicediscovery', ['2017-03-14']); +Object.defineProperty(apiLoader.services['servicediscovery'], '2017-03-14', { + get: function get() { + var model = require('../apis/servicediscovery-2017-03-14.min.json'); + model.paginators = require('../apis/servicediscovery-2017-03-14.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.ServiceDiscovery; diff --git a/node_modules/aws-sdk/clients/ses.d.ts b/node_modules/aws-sdk/clients/ses.d.ts new file mode 100644 index 0000000..ba28868 --- /dev/null +++ b/node_modules/aws-sdk/clients/ses.d.ts @@ -0,0 +1,2297 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SES extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SES.Types.ClientConfiguration) + config: Config & SES.Types.ClientConfiguration; + /** + * Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + cloneReceiptRuleSet(params: SES.Types.CloneReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.CloneReceiptRuleSetResponse) => void): Request; + /** + * Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + cloneReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.CloneReceiptRuleSetResponse) => void): Request; + /** + * Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createConfigurationSet(params: SES.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetResponse) => void): Request; + /** + * Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createConfigurationSet(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetResponse) => void): Request; + /** + * Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createConfigurationSetEventDestination(params: SES.Types.CreateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. + */ + createConfigurationSetTrackingOptions(params: SES.Types.CreateConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. + */ + createConfigurationSetTrackingOptions(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createCustomVerificationEmailTemplate(params: SES.Types.CreateCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createCustomVerificationEmailTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createReceiptFilter(params: SES.Types.CreateReceiptFilterRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptFilterResponse) => void): Request; + /** + * Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createReceiptFilter(callback?: (err: AWSError, data: SES.Types.CreateReceiptFilterResponse) => void): Request; + /** + * Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createReceiptRule(params: SES.Types.CreateReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleResponse) => void): Request; + /** + * Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createReceiptRule(callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleResponse) => void): Request; + /** + * Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createReceiptRuleSet(params: SES.Types.CreateReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleSetResponse) => void): Request; + /** + * Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleSetResponse) => void): Request; + /** + * Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createTemplate(params: SES.Types.CreateTemplateRequest, callback?: (err: AWSError, data: SES.Types.CreateTemplateResponse) => void): Request; + /** + * Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + createTemplate(callback?: (err: AWSError, data: SES.Types.CreateTemplateResponse) => void): Request; + /** + * Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteConfigurationSet(params: SES.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetResponse) => void): Request; + /** + * Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteConfigurationSet(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetResponse) => void): Request; + /** + * Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteConfigurationSetEventDestination(params: SES.Types.DeleteConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request; + /** + * Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request; + /** + * Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains. + */ + deleteConfigurationSetTrackingOptions(params: SES.Types.DeleteConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains. + */ + deleteConfigurationSetTrackingOptions(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteCustomVerificationEmailTemplate(params: SES.Types.DeleteCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteCustomVerificationEmailTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second. + */ + deleteIdentity(params: SES.Types.DeleteIdentityRequest, callback?: (err: AWSError, data: SES.Types.DeleteIdentityResponse) => void): Request; + /** + * Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second. + */ + deleteIdentity(callback?: (err: AWSError, data: SES.Types.DeleteIdentityResponse) => void): Request; + /** + * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteIdentityPolicy(params: SES.Types.DeleteIdentityPolicyRequest, callback?: (err: AWSError, data: SES.Types.DeleteIdentityPolicyResponse) => void): Request; + /** + * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteIdentityPolicy(callback?: (err: AWSError, data: SES.Types.DeleteIdentityPolicyResponse) => void): Request; + /** + * Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteReceiptFilter(params: SES.Types.DeleteReceiptFilterRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptFilterResponse) => void): Request; + /** + * Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteReceiptFilter(callback?: (err: AWSError, data: SES.Types.DeleteReceiptFilterResponse) => void): Request; + /** + * Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteReceiptRule(params: SES.Types.DeleteReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleResponse) => void): Request; + /** + * Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteReceiptRule(callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleResponse) => void): Request; + /** + * Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteReceiptRuleSet(params: SES.Types.DeleteReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleSetResponse) => void): Request; + /** + * Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + deleteReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleSetResponse) => void): Request; + /** + * Deletes an email template. You can execute this operation no more than once per second. + */ + deleteTemplate(params: SES.Types.DeleteTemplateRequest, callback?: (err: AWSError, data: SES.Types.DeleteTemplateResponse) => void): Request; + /** + * Deletes an email template. You can execute this operation no more than once per second. + */ + deleteTemplate(callback?: (err: AWSError, data: SES.Types.DeleteTemplateResponse) => void): Request; + /** + * Deprecated. Use the DeleteIdentity operation to delete email addresses and domains. + */ + deleteVerifiedEmailAddress(params: SES.Types.DeleteVerifiedEmailAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecated. Use the DeleteIdentity operation to delete email addresses and domains. + */ + deleteVerifiedEmailAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeActiveReceiptRuleSet(params: SES.Types.DescribeActiveReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeActiveReceiptRuleSetResponse) => void): Request; + /** + * Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeActiveReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DescribeActiveReceiptRuleSetResponse) => void): Request; + /** + * Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeConfigurationSet(params: SES.Types.DescribeConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeConfigurationSetResponse) => void): Request; + /** + * Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeConfigurationSet(callback?: (err: AWSError, data: SES.Types.DescribeConfigurationSetResponse) => void): Request; + /** + * Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeReceiptRule(params: SES.Types.DescribeReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleResponse) => void): Request; + /** + * Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeReceiptRule(callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleResponse) => void): Request; + /** + * Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeReceiptRuleSet(params: SES.Types.DescribeReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleSetResponse) => void): Request; + /** + * Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + describeReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleSetResponse) => void): Request; + /** + * Returns the email sending status of the Amazon SES account for the current region. You can execute this operation no more than once per second. + */ + getAccountSendingEnabled(callback?: (err: AWSError, data: SES.Types.GetAccountSendingEnabledResponse) => void): Request; + /** + * Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + getCustomVerificationEmailTemplate(params: SES.Types.GetCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: SES.Types.GetCustomVerificationEmailTemplateResponse) => void): Request; + /** + * Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + getCustomVerificationEmailTemplate(callback?: (err: AWSError, data: SES.Types.GetCustomVerificationEmailTemplateResponse) => void): Request; + /** + * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This operation takes a list of identities as input and returns the following information for each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. + */ + getIdentityDkimAttributes(params: SES.Types.GetIdentityDkimAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityDkimAttributesResponse) => void): Request; + /** + * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This operation takes a list of identities as input and returns the following information for each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. + */ + getIdentityDkimAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityDkimAttributesResponse) => void): Request; + /** + * Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains). This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time. + */ + getIdentityMailFromDomainAttributes(params: SES.Types.GetIdentityMailFromDomainAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityMailFromDomainAttributesResponse) => void): Request; + /** + * Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains). This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time. + */ + getIdentityMailFromDomainAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityMailFromDomainAttributesResponse) => void): Request; + /** + * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. + */ + getIdentityNotificationAttributes(params: SES.Types.GetIdentityNotificationAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityNotificationAttributesResponse) => void): Request; + /** + * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. + */ + getIdentityNotificationAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityNotificationAttributesResponse) => void): Request; + /** + * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + getIdentityPolicies(params: SES.Types.GetIdentityPoliciesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityPoliciesResponse) => void): Request; + /** + * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + getIdentityPolicies(callback?: (err: AWSError, data: SES.Types.GetIdentityPoliciesResponse) => void): Request; + /** + * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning. For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning. This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. + */ + getIdentityVerificationAttributes(params: SES.Types.GetIdentityVerificationAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request; + /** + * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning. For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning. This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. + */ + getIdentityVerificationAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request; + /** + * Provides the sending limits for the Amazon SES account. You can execute this operation no more than once per second. + */ + getSendQuota(callback?: (err: AWSError, data: SES.Types.GetSendQuotaResponse) => void): Request; + /** + * Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time. You can execute this operation no more than once per second. + */ + getSendStatistics(callback?: (err: AWSError, data: SES.Types.GetSendStatisticsResponse) => void): Request; + /** + * Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second. + */ + getTemplate(params: SES.Types.GetTemplateRequest, callback?: (err: AWSError, data: SES.Types.GetTemplateResponse) => void): Request; + /** + * Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second. + */ + getTemplate(callback?: (err: AWSError, data: SES.Types.GetTemplateResponse) => void): Request; + /** + * Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results. + */ + listConfigurationSets(params: SES.Types.ListConfigurationSetsRequest, callback?: (err: AWSError, data: SES.Types.ListConfigurationSetsResponse) => void): Request; + /** + * Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results. + */ + listConfigurationSets(callback?: (err: AWSError, data: SES.Types.ListConfigurationSetsResponse) => void): Request; + /** + * Lists the existing custom verification email templates for your account in the current AWS Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listCustomVerificationEmailTemplates(params: SES.Types.ListCustomVerificationEmailTemplatesRequest, callback?: (err: AWSError, data: SES.Types.ListCustomVerificationEmailTemplatesResponse) => void): Request; + /** + * Lists the existing custom verification email templates for your account in the current AWS Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listCustomVerificationEmailTemplates(callback?: (err: AWSError, data: SES.Types.ListCustomVerificationEmailTemplatesResponse) => void): Request; + /** + * Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status. You can execute this operation no more than once per second. + */ + listIdentities(params: SES.Types.ListIdentitiesRequest, callback?: (err: AWSError, data: SES.Types.ListIdentitiesResponse) => void): Request; + /** + * Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status. You can execute this operation no more than once per second. + */ + listIdentities(callback?: (err: AWSError, data: SES.Types.ListIdentitiesResponse) => void): Request; + /** + * Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listIdentityPolicies(params: SES.Types.ListIdentityPoliciesRequest, callback?: (err: AWSError, data: SES.Types.ListIdentityPoliciesResponse) => void): Request; + /** + * Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listIdentityPolicies(callback?: (err: AWSError, data: SES.Types.ListIdentityPoliciesResponse) => void): Request; + /** + * Lists the IP address filters associated with your AWS account in the current AWS Region. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listReceiptFilters(params: SES.Types.ListReceiptFiltersRequest, callback?: (err: AWSError, data: SES.Types.ListReceiptFiltersResponse) => void): Request; + /** + * Lists the IP address filters associated with your AWS account in the current AWS Region. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listReceiptFilters(callback?: (err: AWSError, data: SES.Types.ListReceiptFiltersResponse) => void): Request; + /** + * Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listReceiptRuleSets(params: SES.Types.ListReceiptRuleSetsRequest, callback?: (err: AWSError, data: SES.Types.ListReceiptRuleSetsResponse) => void): Request; + /** + * Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + listReceiptRuleSets(callback?: (err: AWSError, data: SES.Types.ListReceiptRuleSetsResponse) => void): Request; + /** + * Lists the email templates present in your Amazon SES account in the current AWS Region. You can execute this operation no more than once per second. + */ + listTemplates(params: SES.Types.ListTemplatesRequest, callback?: (err: AWSError, data: SES.Types.ListTemplatesResponse) => void): Request; + /** + * Lists the email templates present in your Amazon SES account in the current AWS Region. You can execute this operation no more than once per second. + */ + listTemplates(callback?: (err: AWSError, data: SES.Types.ListTemplatesResponse) => void): Request; + /** + * Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account. + */ + listVerifiedEmailAddresses(callback?: (err: AWSError, data: SES.Types.ListVerifiedEmailAddressesResponse) => void): Request; + /** + * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + putIdentityPolicy(params: SES.Types.PutIdentityPolicyRequest, callback?: (err: AWSError, data: SES.Types.PutIdentityPolicyResponse) => void): Request; + /** + * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + putIdentityPolicy(callback?: (err: AWSError, data: SES.Types.PutIdentityPolicyResponse) => void): Request; + /** + * Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + reorderReceiptRuleSet(params: SES.Types.ReorderReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.ReorderReceiptRuleSetResponse) => void): Request; + /** + * Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + reorderReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.ReorderReceiptRuleSetResponse) => void): Request; + /** + * Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + sendBounce(params: SES.Types.SendBounceRequest, callback?: (err: AWSError, data: SES.Types.SendBounceResponse) => void): Request; + /** + * Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + sendBounce(callback?: (err: AWSError, data: SES.Types.SendBounceResponse) => void): Request; + /** + * Composes an email message to multiple destinations. The message body is created using an email template. In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group. The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate. + */ + sendBulkTemplatedEmail(params: SES.Types.SendBulkTemplatedEmailRequest, callback?: (err: AWSError, data: SES.Types.SendBulkTemplatedEmailResponse) => void): Request; + /** + * Composes an email message to multiple destinations. The message body is created using an email template. In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group. The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate. + */ + sendBulkTemplatedEmail(callback?: (err: AWSError, data: SES.Types.SendBulkTemplatedEmailResponse) => void): Request; + /** + * Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + sendCustomVerificationEmail(params: SES.Types.SendCustomVerificationEmailRequest, callback?: (err: AWSError, data: SES.Types.SendCustomVerificationEmailResponse) => void): Request; + /** + * Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + sendCustomVerificationEmail(callback?: (err: AWSError, data: SES.Types.SendCustomVerificationEmailResponse) => void): Request; + /** + * Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements: The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide. + */ + sendEmail(params: SES.Types.SendEmailRequest, callback?: (err: AWSError, data: SES.Types.SendEmailResponse) => void): Request; + /** + * Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements: The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide. + */ + sendEmail(callback?: (err: AWSError, data: SES.Types.SendEmailResponse) => void): Request; + /** + * Composes an email message and immediately queues it for sending. This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments. The SendRawEmail operation has the following requirements: You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator. The maximum message size, including attachments, is 10 MB. Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines. If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid. Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group. Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide. Additionally, keep the following considerations in mind when using the SendRawEmail operation: Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides. If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email. For most common sending authorization scenarios, we recommend that you specify the SourceIdentityArn parameter and not the FromIdentityArn or ReturnPathIdentityArn parameters. If you only specify the SourceIdentityArn parameter, Amazon SES will set the From and Return Path addresses to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide. + */ + sendRawEmail(params: SES.Types.SendRawEmailRequest, callback?: (err: AWSError, data: SES.Types.SendRawEmailResponse) => void): Request; + /** + * Composes an email message and immediately queues it for sending. This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments. The SendRawEmail operation has the following requirements: You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator. The maximum message size, including attachments, is 10 MB. Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines. If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid. Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group. Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide. Additionally, keep the following considerations in mind when using the SendRawEmail operation: Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides. If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email. For most common sending authorization scenarios, we recommend that you specify the SourceIdentityArn parameter and not the FromIdentityArn or ReturnPathIdentityArn parameters. If you only specify the SourceIdentityArn parameter, Amazon SES will set the From and Return Path addresses to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide. + */ + sendRawEmail(callback?: (err: AWSError, data: SES.Types.SendRawEmailResponse) => void): Request; + /** + * Composes an email message using an email template and immediately queues it for sending. In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email. For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide. + */ + sendTemplatedEmail(params: SES.Types.SendTemplatedEmailRequest, callback?: (err: AWSError, data: SES.Types.SendTemplatedEmailResponse) => void): Request; + /** + * Composes an email message using an email template and immediately queues it for sending. In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email. For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide. + */ + sendTemplatedEmail(callback?: (err: AWSError, data: SES.Types.SendTemplatedEmailResponse) => void): Request; + /** + * Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + setActiveReceiptRuleSet(params: SES.Types.SetActiveReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.SetActiveReceiptRuleSetResponse) => void): Request; + /** + * Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + setActiveReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.SetActiveReceiptRuleSetResponse) => void): Request; + /** + * Enables or disables Easy DKIM signing of email sent from an identity: If Easy DKIM signing is enabled for a domain name identity (such as example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (for example, user@example.com). If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address. For email addresses (for example, user@example.com), you can only enable Easy DKIM signing if the corresponding domain (in this case, example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim operation. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. + */ + setIdentityDkimEnabled(params: SES.Types.SetIdentityDkimEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityDkimEnabledResponse) => void): Request; + /** + * Enables or disables Easy DKIM signing of email sent from an identity: If Easy DKIM signing is enabled for a domain name identity (such as example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (for example, user@example.com). If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address. For email addresses (for example, user@example.com), you can only enable Easy DKIM signing if the corresponding domain (in this case, example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim operation. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. + */ + setIdentityDkimEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityDkimEnabledResponse) => void): Request; + /** + * Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. + */ + setIdentityFeedbackForwardingEnabled(params: SES.Types.SetIdentityFeedbackForwardingEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityFeedbackForwardingEnabledResponse) => void): Request; + /** + * Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. + */ + setIdentityFeedbackForwardingEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityFeedbackForwardingEnabledResponse) => void): Request; + /** + * Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. + */ + setIdentityHeadersInNotificationsEnabled(params: SES.Types.SetIdentityHeadersInNotificationsEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityHeadersInNotificationsEnabledResponse) => void): Request; + /** + * Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. + */ + setIdentityHeadersInNotificationsEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityHeadersInNotificationsEnabledResponse) => void): Request; + /** + * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + setIdentityMailFromDomain(params: SES.Types.SetIdentityMailFromDomainRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityMailFromDomainResponse) => void): Request; + /** + * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + setIdentityMailFromDomain(callback?: (err: AWSError, data: SES.Types.SetIdentityMailFromDomainResponse) => void): Request; + /** + * Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify. You can execute this operation no more than once per second. For more information about feedback notification, see the Amazon SES Developer Guide. + */ + setIdentityNotificationTopic(params: SES.Types.SetIdentityNotificationTopicRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityNotificationTopicResponse) => void): Request; + /** + * Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify. You can execute this operation no more than once per second. For more information about feedback notification, see the Amazon SES Developer Guide. + */ + setIdentityNotificationTopic(callback?: (err: AWSError, data: SES.Types.SetIdentityNotificationTopicResponse) => void): Request; + /** + * Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + setReceiptRulePosition(params: SES.Types.SetReceiptRulePositionRequest, callback?: (err: AWSError, data: SES.Types.SetReceiptRulePositionResponse) => void): Request; + /** + * Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + setReceiptRulePosition(callback?: (err: AWSError, data: SES.Types.SetReceiptRulePositionResponse) => void): Request; + /** + * Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second. + */ + testRenderTemplate(params: SES.Types.TestRenderTemplateRequest, callback?: (err: AWSError, data: SES.Types.TestRenderTemplateResponse) => void): Request; + /** + * Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second. + */ + testRenderTemplate(callback?: (err: AWSError, data: SES.Types.TestRenderTemplateResponse) => void): Request; + /** + * Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds. You can execute this operation no more than once per second. + */ + updateAccountSendingEnabled(params: SES.Types.UpdateAccountSendingEnabledRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds. You can execute this operation no more than once per second. + */ + updateAccountSendingEnabled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second. + */ + updateConfigurationSetEventDestination(params: SES.Types.UpdateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second. + */ + updateConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request; + /** + * Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds. You can execute this operation no more than once per second. + */ + updateConfigurationSetReputationMetricsEnabled(params: SES.Types.UpdateConfigurationSetReputationMetricsEnabledRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds. You can execute this operation no more than once per second. + */ + updateConfigurationSetReputationMetricsEnabled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds. You can execute this operation no more than once per second. + */ + updateConfigurationSetSendingEnabled(params: SES.Types.UpdateConfigurationSetSendingEnabledRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds. You can execute this operation no more than once per second. + */ + updateConfigurationSetSendingEnabled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. + */ + updateConfigurationSetTrackingOptions(params: SES.Types.UpdateConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. + */ + updateConfigurationSetTrackingOptions(callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetTrackingOptionsResponse) => void): Request; + /** + * Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + updateCustomVerificationEmailTemplate(params: SES.Types.UpdateCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + updateCustomVerificationEmailTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + updateReceiptRule(params: SES.Types.UpdateReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.UpdateReceiptRuleResponse) => void): Request; + /** + * Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + updateReceiptRule(callback?: (err: AWSError, data: SES.Types.UpdateReceiptRuleResponse) => void): Request; + /** + * Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + updateTemplate(params: SES.Types.UpdateTemplateRequest, callback?: (err: AWSError, data: SES.Types.UpdateTemplateResponse) => void): Request; + /** + * Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + updateTemplate(callback?: (err: AWSError, data: SES.Types.UpdateTemplateResponse) => void): Request; + /** + * Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. You can execute this operation no more than once per second. To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled operation. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. + */ + verifyDomainDkim(params: SES.Types.VerifyDomainDkimRequest, callback?: (err: AWSError, data: SES.Types.VerifyDomainDkimResponse) => void): Request; + /** + * Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. You can execute this operation no more than once per second. To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled operation. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. + */ + verifyDomainDkim(callback?: (err: AWSError, data: SES.Types.VerifyDomainDkimResponse) => void): Request; + /** + * Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + verifyDomainIdentity(params: SES.Types.VerifyDomainIdentityRequest, callback?: (err: AWSError, data: SES.Types.VerifyDomainIdentityResponse) => void): Request; + /** + * Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. You can execute this operation no more than once per second. + */ + verifyDomainIdentity(callback?: (err: AWSError, data: SES.Types.VerifyDomainIdentityResponse) => void): Request; + /** + * Deprecated. Use the VerifyEmailIdentity operation to verify a new email address. + */ + verifyEmailAddress(params: SES.Types.VerifyEmailAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecated. Use the VerifyEmailIdentity operation to verify a new email address. + */ + verifyEmailAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address. You can execute this operation no more than once per second. + */ + verifyEmailIdentity(params: SES.Types.VerifyEmailIdentityRequest, callback?: (err: AWSError, data: SES.Types.VerifyEmailIdentityResponse) => void): Request; + /** + * Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address. You can execute this operation no more than once per second. + */ + verifyEmailIdentity(callback?: (err: AWSError, data: SES.Types.VerifyEmailIdentityResponse) => void): Request; + /** + * Waits for the identityExists state by periodically calling the underlying SES.getIdentityVerificationAttributesoperation every 3 seconds (at most 20 times). + */ + waitFor(state: "identityExists", params: SES.Types.GetIdentityVerificationAttributesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request; + /** + * Waits for the identityExists state by periodically calling the underlying SES.getIdentityVerificationAttributesoperation every 3 seconds (at most 20 times). + */ + waitFor(state: "identityExists", callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request; +} +declare namespace SES { + export interface AddHeaderAction { + /** + * The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only. + */ + HeaderName: HeaderName; + /** + * Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n"). + */ + HeaderValue: HeaderValue; + } + export type Address = string; + export type AddressList = Address[]; + export type AmazonResourceName = string; + export type ArrivalDate = Date; + export type BehaviorOnMXFailure = "UseDefaultValue"|"RejectMessage"|string; + export interface Body { + /** + * The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices). + */ + Text?: Content; + /** + * The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message. + */ + Html?: Content; + } + export interface BounceAction { + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicArn?: AmazonResourceName; + /** + * The SMTP reply code, as defined by RFC 5321. + */ + SmtpReplyCode: BounceSmtpReplyCode; + /** + * The SMTP enhanced status code, as defined by RFC 3463. + */ + StatusCode?: BounceStatusCode; + /** + * Human-readable text to include in the bounce message. + */ + Message: BounceMessage; + /** + * The email address of the sender of the bounced email. This is the address from which the bounce message will be sent. + */ + Sender: Address; + } + export type BounceMessage = string; + export type BounceSmtpReplyCode = string; + export type BounceStatusCode = string; + export type BounceType = "DoesNotExist"|"MessageTooLarge"|"ExceededQuota"|"ContentRejected"|"Undefined"|"TemporaryFailure"|string; + export interface BouncedRecipientInfo { + /** + * The email address of the recipient of the bounced email. + */ + Recipient: Address; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + RecipientArn?: AmazonResourceName; + /** + * The reason for the bounce. You must provide either this parameter or RecipientDsnFields. + */ + BounceType?: BounceType; + /** + * Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType. + */ + RecipientDsnFields?: RecipientDsnFields; + } + export type BouncedRecipientInfoList = BouncedRecipientInfo[]; + export interface BulkEmailDestination { + Destination: Destination; + /** + * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. + */ + ReplacementTags?: MessageTagList; + /** + * A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. + */ + ReplacementTemplateData?: TemplateData; + } + export type BulkEmailDestinationList = BulkEmailDestination[]; + export interface BulkEmailDestinationStatus { + /** + * The status of a message sent using the SendBulkTemplatedEmail operation. Possible values for this parameter include: Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients. MessageRejected: The message was rejected because it contained a virus. MailFromDomainNotVerified: The sender's email address or domain was not verified. ConfigurationSetDoesNotExist: The configuration set you specified does not exist. TemplateDoesNotExist: The template you specified does not exist. AccountSuspended: Your account has been shut down because of issues related to your email sending practices. AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit. AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period. InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist. AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation. ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation. InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information. TransientFailure: Amazon SES was unable to process your request because of a temporary issue. Failed: Amazon SES was unable to process your request. See the error message for additional information. + */ + Status?: BulkEmailStatus; + /** + * A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation. + */ + Error?: Error; + /** + * The unique message identifier returned from the SendBulkTemplatedEmail operation. + */ + MessageId?: MessageId; + } + export type BulkEmailDestinationStatusList = BulkEmailDestinationStatus[]; + export type BulkEmailStatus = "Success"|"MessageRejected"|"MailFromDomainNotVerified"|"ConfigurationSetDoesNotExist"|"TemplateDoesNotExist"|"AccountSuspended"|"AccountThrottled"|"AccountDailyQuotaExceeded"|"InvalidSendingPoolName"|"AccountSendingPaused"|"ConfigurationSetSendingPaused"|"InvalidParameterValue"|"TransientFailure"|"Failed"|string; + export type Charset = string; + export type Cidr = string; + export interface CloneReceiptRuleSetRequest { + /** + * The name of the rule set to create. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. + */ + RuleSetName: ReceiptRuleSetName; + /** + * The name of the rule set to clone. + */ + OriginalRuleSetName: ReceiptRuleSetName; + } + export interface CloneReceiptRuleSetResponse { + } + export interface CloudWatchDestination { + /** + * A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. + */ + DimensionConfigurations: CloudWatchDimensionConfigurations; + } + export interface CloudWatchDimensionConfiguration { + /** + * The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. + */ + DimensionName: DimensionName; + /** + * The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader. + */ + DimensionValueSource: DimensionValueSource; + /** + * The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. + */ + DefaultDimensionValue: DefaultDimensionValue; + } + export type CloudWatchDimensionConfigurations = CloudWatchDimensionConfiguration[]; + export interface ConfigurationSet { + /** + * The name of the configuration set. The name must meet the following requirements: Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain 64 characters or fewer. + */ + Name: ConfigurationSetName; + } + export type ConfigurationSetAttribute = "eventDestinations"|"trackingOptions"|"reputationOptions"|string; + export type ConfigurationSetAttributeList = ConfigurationSetAttribute[]; + export type ConfigurationSetName = string; + export type ConfigurationSets = ConfigurationSet[]; + export interface Content { + /** + * The textual data of the content. + */ + Data: MessageData; + /** + * The character set of the content. + */ + Charset?: Charset; + } + export type Counter = number; + export interface CreateConfigurationSetEventDestinationRequest { + /** + * The name of the configuration set that the event destination should be associated with. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * An object that describes the AWS service that email sending event information will be published to. + */ + EventDestination: EventDestination; + } + export interface CreateConfigurationSetEventDestinationResponse { + } + export interface CreateConfigurationSetRequest { + /** + * A data structure that contains the name of the configuration set. + */ + ConfigurationSet: ConfigurationSet; + } + export interface CreateConfigurationSetResponse { + } + export interface CreateConfigurationSetTrackingOptionsRequest { + /** + * The name of the configuration set that the tracking options should be associated with. + */ + ConfigurationSetName: ConfigurationSetName; + TrackingOptions: TrackingOptions; + } + export interface CreateConfigurationSetTrackingOptionsResponse { + } + export interface CreateCustomVerificationEmailTemplateRequest { + /** + * The name of the custom verification email template. + */ + TemplateName: TemplateName; + /** + * The email address that the custom verification email is sent from. + */ + FromEmailAddress: FromAddress; + /** + * The subject line of the custom verification email. + */ + TemplateSubject: Subject; + /** + * The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide. + */ + TemplateContent: TemplateContent; + /** + * The URL that the recipient of the verification email is sent to if his or her address is successfully verified. + */ + SuccessRedirectionURL: SuccessRedirectionURL; + /** + * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. + */ + FailureRedirectionURL: FailureRedirectionURL; + } + export interface CreateReceiptFilterRequest { + /** + * A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it. + */ + Filter: ReceiptFilter; + } + export interface CreateReceiptFilterResponse { + } + export interface CreateReceiptRuleRequest { + /** + * The name of the rule set that the receipt rule will be added to. + */ + RuleSetName: ReceiptRuleSetName; + /** + * The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list. + */ + After?: ReceiptRuleName; + /** + * A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy. + */ + Rule: ReceiptRule; + } + export interface CreateReceiptRuleResponse { + } + export interface CreateReceiptRuleSetRequest { + /** + * The name of the rule set to create. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. + */ + RuleSetName: ReceiptRuleSetName; + } + export interface CreateReceiptRuleSetResponse { + } + export interface CreateTemplateRequest { + /** + * The content of the email, composed of a subject line, an HTML part, and a text-only part. + */ + Template: Template; + } + export interface CreateTemplateResponse { + } + export type CustomMailFromStatus = "Pending"|"Success"|"Failed"|"TemporaryFailure"|string; + export type CustomRedirectDomain = string; + export interface CustomVerificationEmailTemplate { + /** + * The name of the custom verification email template. + */ + TemplateName?: TemplateName; + /** + * The email address that the custom verification email is sent from. + */ + FromEmailAddress?: FromAddress; + /** + * The subject line of the custom verification email. + */ + TemplateSubject?: Subject; + /** + * The URL that the recipient of the verification email is sent to if his or her address is successfully verified. + */ + SuccessRedirectionURL?: SuccessRedirectionURL; + /** + * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. + */ + FailureRedirectionURL?: FailureRedirectionURL; + } + export type CustomVerificationEmailTemplates = CustomVerificationEmailTemplate[]; + export type DefaultDimensionValue = string; + export interface DeleteConfigurationSetEventDestinationRequest { + /** + * The name of the configuration set from which to delete the event destination. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * The name of the event destination to delete. + */ + EventDestinationName: EventDestinationName; + } + export interface DeleteConfigurationSetEventDestinationResponse { + } + export interface DeleteConfigurationSetRequest { + /** + * The name of the configuration set to delete. + */ + ConfigurationSetName: ConfigurationSetName; + } + export interface DeleteConfigurationSetResponse { + } + export interface DeleteConfigurationSetTrackingOptionsRequest { + /** + * The name of the configuration set from which you want to delete the tracking options. + */ + ConfigurationSetName: ConfigurationSetName; + } + export interface DeleteConfigurationSetTrackingOptionsResponse { + } + export interface DeleteCustomVerificationEmailTemplateRequest { + /** + * The name of the custom verification email template that you want to delete. + */ + TemplateName: TemplateName; + } + export interface DeleteIdentityPolicyRequest { + /** + * The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. + */ + Identity: Identity; + /** + * The name of the policy to be deleted. + */ + PolicyName: PolicyName; + } + export interface DeleteIdentityPolicyResponse { + } + export interface DeleteIdentityRequest { + /** + * The identity to be removed from the list of identities for the AWS Account. + */ + Identity: Identity; + } + export interface DeleteIdentityResponse { + } + export interface DeleteReceiptFilterRequest { + /** + * The name of the IP address filter to delete. + */ + FilterName: ReceiptFilterName; + } + export interface DeleteReceiptFilterResponse { + } + export interface DeleteReceiptRuleRequest { + /** + * The name of the receipt rule set that contains the receipt rule to delete. + */ + RuleSetName: ReceiptRuleSetName; + /** + * The name of the receipt rule to delete. + */ + RuleName: ReceiptRuleName; + } + export interface DeleteReceiptRuleResponse { + } + export interface DeleteReceiptRuleSetRequest { + /** + * The name of the receipt rule set to delete. + */ + RuleSetName: ReceiptRuleSetName; + } + export interface DeleteReceiptRuleSetResponse { + } + export interface DeleteTemplateRequest { + /** + * The name of the template to be deleted. + */ + TemplateName: TemplateName; + } + export interface DeleteTemplateResponse { + } + export interface DeleteVerifiedEmailAddressRequest { + /** + * An email address to be removed from the list of verified addresses. + */ + EmailAddress: Address; + } + export interface DescribeActiveReceiptRuleSetRequest { + } + export interface DescribeActiveReceiptRuleSetResponse { + /** + * The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created. + */ + Metadata?: ReceiptRuleSetMetadata; + /** + * The receipt rules that belong to the active rule set. + */ + Rules?: ReceiptRulesList; + } + export interface DescribeConfigurationSetRequest { + /** + * The name of the configuration set to describe. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * A list of configuration set attributes to return. + */ + ConfigurationSetAttributeNames?: ConfigurationSetAttributeList; + } + export interface DescribeConfigurationSetResponse { + /** + * The configuration set object associated with the specified configuration set. + */ + ConfigurationSet?: ConfigurationSet; + /** + * A list of event destinations associated with the configuration set. + */ + EventDestinations?: EventDestinations; + /** + * The name of the custom open and click tracking domain associated with the configuration set. + */ + TrackingOptions?: TrackingOptions; + /** + * An object that represents the reputation settings for the configuration set. + */ + ReputationOptions?: ReputationOptions; + } + export interface DescribeReceiptRuleRequest { + /** + * The name of the receipt rule set that the receipt rule belongs to. + */ + RuleSetName: ReceiptRuleSetName; + /** + * The name of the receipt rule. + */ + RuleName: ReceiptRuleName; + } + export interface DescribeReceiptRuleResponse { + /** + * A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy. + */ + Rule?: ReceiptRule; + } + export interface DescribeReceiptRuleSetRequest { + /** + * The name of the receipt rule set to describe. + */ + RuleSetName: ReceiptRuleSetName; + } + export interface DescribeReceiptRuleSetResponse { + /** + * The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created. + */ + Metadata?: ReceiptRuleSetMetadata; + /** + * A list of the receipt rules that belong to the specified receipt rule set. + */ + Rules?: ReceiptRulesList; + } + export interface Destination { + /** + * The To: field(s) of the message. + */ + ToAddresses?: AddressList; + /** + * The CC: field(s) of the message. + */ + CcAddresses?: AddressList; + /** + * The BCC: field(s) of the message. + */ + BccAddresses?: AddressList; + } + export type DiagnosticCode = string; + export type DimensionName = string; + export type DimensionValueSource = "messageTag"|"emailHeader"|"linkTag"|string; + export type DkimAttributes = {[key: string]: IdentityDkimAttributes}; + export type Domain = string; + export type DsnAction = "failed"|"delayed"|"delivered"|"relayed"|"expanded"|string; + export type DsnStatus = string; + export type Enabled = boolean; + export type Error = string; + export interface EventDestination { + /** + * The name of the event destination. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 64 characters. + */ + Name: EventDestinationName; + /** + * Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. + */ + Enabled?: Enabled; + /** + * The type of email sending events to publish to the event destination. + */ + MatchingEventTypes: EventTypes; + /** + * An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination. + */ + KinesisFirehoseDestination?: KinesisFirehoseDestination; + /** + * An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination. + */ + CloudWatchDestination?: CloudWatchDestination; + /** + * An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination. + */ + SNSDestination?: SNSDestination; + } + export type EventDestinationName = string; + export type EventDestinations = EventDestination[]; + export type EventType = "send"|"reject"|"bounce"|"complaint"|"delivery"|"open"|"click"|"renderingFailure"|string; + export type EventTypes = EventType[]; + export type Explanation = string; + export interface ExtensionField { + /** + * The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only. + */ + Name: ExtensionFieldName; + /** + * The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n"). + */ + Value: ExtensionFieldValue; + } + export type ExtensionFieldList = ExtensionField[]; + export type ExtensionFieldName = string; + export type ExtensionFieldValue = string; + export type FailureRedirectionURL = string; + export type FromAddress = string; + export interface GetAccountSendingEnabledResponse { + /** + * Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region. + */ + Enabled?: Enabled; + } + export interface GetCustomVerificationEmailTemplateRequest { + /** + * The name of the custom verification email template that you want to retrieve. + */ + TemplateName: TemplateName; + } + export interface GetCustomVerificationEmailTemplateResponse { + /** + * The name of the custom verification email template. + */ + TemplateName?: TemplateName; + /** + * The email address that the custom verification email is sent from. + */ + FromEmailAddress?: FromAddress; + /** + * The subject line of the custom verification email. + */ + TemplateSubject?: Subject; + /** + * The content of the custom verification email. + */ + TemplateContent?: TemplateContent; + /** + * The URL that the recipient of the verification email is sent to if his or her address is successfully verified. + */ + SuccessRedirectionURL?: SuccessRedirectionURL; + /** + * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. + */ + FailureRedirectionURL?: FailureRedirectionURL; + } + export interface GetIdentityDkimAttributesRequest { + /** + * A list of one or more verified identities - email addresses, domains, or both. + */ + Identities: IdentityList; + } + export interface GetIdentityDkimAttributesResponse { + /** + * The DKIM attributes for an email address or a domain. + */ + DkimAttributes: DkimAttributes; + } + export interface GetIdentityMailFromDomainAttributesRequest { + /** + * A list of one or more identities. + */ + Identities: IdentityList; + } + export interface GetIdentityMailFromDomainAttributesResponse { + /** + * A map of identities to custom MAIL FROM attributes. + */ + MailFromDomainAttributes: MailFromDomainAttributes; + } + export interface GetIdentityNotificationAttributesRequest { + /** + * A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + */ + Identities: IdentityList; + } + export interface GetIdentityNotificationAttributesResponse { + /** + * A map of Identity to IdentityNotificationAttributes. + */ + NotificationAttributes: NotificationAttributes; + } + export interface GetIdentityPoliciesRequest { + /** + * The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. + */ + Identity: Identity; + /** + * A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies. + */ + PolicyNames: PolicyNameList; + } + export interface GetIdentityPoliciesResponse { + /** + * A map of policy names to policies. + */ + Policies: PolicyMap; + } + export interface GetIdentityVerificationAttributesRequest { + /** + * A list of identities. + */ + Identities: IdentityList; + } + export interface GetIdentityVerificationAttributesResponse { + /** + * A map of Identities to IdentityVerificationAttributes objects. + */ + VerificationAttributes: VerificationAttributes; + } + export interface GetSendQuotaResponse { + /** + * The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota. + */ + Max24HourSend?: Max24HourSend; + /** + * The maximum number of emails that Amazon SES can accept from the user's account per second. The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate. + */ + MaxSendRate?: MaxSendRate; + /** + * The number of emails sent during the previous 24 hours. + */ + SentLast24Hours?: SentLast24Hours; + } + export interface GetSendStatisticsResponse { + /** + * A list of data points, each of which represents 15 minutes of activity. + */ + SendDataPoints?: SendDataPointList; + } + export interface GetTemplateRequest { + /** + * The name of the template you want to retrieve. + */ + TemplateName: TemplateName; + } + export interface GetTemplateResponse { + Template?: Template; + } + export type HeaderName = string; + export type HeaderValue = string; + export type HtmlPart = string; + export type Identity = string; + export interface IdentityDkimAttributes { + /** + * True if DKIM signing is enabled for email sent from the identity; false otherwise. The default value is true. + */ + DkimEnabled: Enabled; + /** + * Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.) + */ + DkimVerificationStatus: VerificationStatus; + /** + * A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.) For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. + */ + DkimTokens?: VerificationTokenList; + } + export type IdentityList = Identity[]; + export interface IdentityMailFromDomainAttributes { + /** + * The custom MAIL FROM domain that the identity is configured to use. + */ + MailFromDomain: MailFromDomainName; + /** + * The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure. + */ + MailFromDomainStatus: CustomMailFromStatus; + /** + * The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email. The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure. + */ + BehaviorOnMXFailure: BehaviorOnMXFailure; + } + export interface IdentityNotificationAttributes { + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications. + */ + BounceTopic: NotificationTopic; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications. + */ + ComplaintTopic: NotificationTopic; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications. + */ + DeliveryTopic: NotificationTopic; + /** + * Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics. + */ + ForwardingEnabled: Enabled; + /** + * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications. + */ + HeadersInBounceNotificationsEnabled?: Enabled; + /** + * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications. + */ + HeadersInComplaintNotificationsEnabled?: Enabled; + /** + * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications. + */ + HeadersInDeliveryNotificationsEnabled?: Enabled; + } + export type IdentityType = "EmailAddress"|"Domain"|string; + export interface IdentityVerificationAttributes { + /** + * The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure". + */ + VerificationStatus: VerificationStatus; + /** + * The verification token for a domain identity. Null for email address identities. + */ + VerificationToken?: VerificationToken; + } + export type InvocationType = "Event"|"RequestResponse"|string; + export interface KinesisFirehoseDestination { + /** + * The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. + */ + IAMRoleARN: AmazonResourceName; + /** + * The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to. + */ + DeliveryStreamARN: AmazonResourceName; + } + export interface LambdaAction { + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicArn?: AmazonResourceName; + /** + * The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide. + */ + FunctionArn: AmazonResourceName; + /** + * The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set. + */ + InvocationType?: InvocationType; + } + export type LastAttemptDate = Date; + export type LastFreshStart = Date; + export interface ListConfigurationSetsRequest { + /** + * A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list. + */ + NextToken?: NextToken; + /** + * The number of configuration sets to return. + */ + MaxItems?: MaxItems; + } + export interface ListConfigurationSetsResponse { + /** + * A list of configuration sets. + */ + ConfigurationSets?: ConfigurationSets; + /** + * A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets. + */ + NextToken?: NextToken; + } + export interface ListCustomVerificationEmailTemplatesRequest { + /** + * An array the contains the name and creation time stamp for each template in your Amazon SES account. + */ + NextToken?: NextToken; + /** + * The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results. + */ + MaxResults?: MaxResults; + } + export interface ListCustomVerificationEmailTemplatesResponse { + /** + * A list of the custom verification email templates that exist in your account. + */ + CustomVerificationEmailTemplates?: CustomVerificationEmailTemplates; + /** + * A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom verification email templates. + */ + NextToken?: NextToken; + } + export interface ListIdentitiesRequest { + /** + * The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed. + */ + IdentityType?: IdentityType; + /** + * The token to use for pagination. + */ + NextToken?: NextToken; + /** + * The maximum number of identities per page. Possible values are 1-1000 inclusive. + */ + MaxItems?: MaxItems; + } + export interface ListIdentitiesResponse { + /** + * A list of identities. + */ + Identities: IdentityList; + /** + * The token used for pagination. + */ + NextToken?: NextToken; + } + export interface ListIdentityPoliciesRequest { + /** + * The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. + */ + Identity: Identity; + } + export interface ListIdentityPoliciesResponse { + /** + * A list of names of policies that apply to the specified identity. + */ + PolicyNames: PolicyNameList; + } + export interface ListReceiptFiltersRequest { + } + export interface ListReceiptFiltersResponse { + /** + * A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it. + */ + Filters?: ReceiptFilterList; + } + export interface ListReceiptRuleSetsRequest { + /** + * A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list. + */ + NextToken?: NextToken; + } + export interface ListReceiptRuleSetsResponse { + /** + * The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created. + */ + RuleSets?: ReceiptRuleSetsLists; + /** + * A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time. + */ + NextToken?: NextToken; + } + export interface ListTemplatesRequest { + /** + * A token returned from a previous call to ListTemplates to indicate the position in the list of email templates. + */ + NextToken?: NextToken; + /** + * The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results. + */ + MaxItems?: MaxItems; + } + export interface ListTemplatesResponse { + /** + * An array the contains the name and creation time stamp for each template in your Amazon SES account. + */ + TemplatesMetadata?: TemplateMetadataList; + /** + * A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates. + */ + NextToken?: NextToken; + } + export interface ListVerifiedEmailAddressesResponse { + /** + * A list of email addresses that have been verified. + */ + VerifiedEmailAddresses?: AddressList; + } + export type MailFromDomainAttributes = {[key: string]: IdentityMailFromDomainAttributes}; + export type MailFromDomainName = string; + export type Max24HourSend = number; + export type MaxItems = number; + export type MaxResults = number; + export type MaxSendRate = number; + export interface Message { + /** + * The subject of the message: A short summary of the content, which will appear in the recipient's inbox. + */ + Subject: Content; + /** + * The message body. + */ + Body: Body; + } + export type MessageData = string; + export interface MessageDsn { + /** + * The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com. + */ + ReportingMta: ReportingMta; + /** + * When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format. + */ + ArrivalDate?: ArrivalDate; + /** + * Additional X-headers to include in the DSN. + */ + ExtensionFields?: ExtensionFieldList; + } + export type MessageId = string; + export interface MessageTag { + /** + * The name of the tag. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. + */ + Name: MessageTagName; + /** + * The value of the tag. The value must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. + */ + Value: MessageTagValue; + } + export type MessageTagList = MessageTag[]; + export type MessageTagName = string; + export type MessageTagValue = string; + export type NextToken = string; + export type NotificationAttributes = {[key: string]: IdentityNotificationAttributes}; + export type NotificationTopic = string; + export type NotificationType = "Bounce"|"Complaint"|"Delivery"|string; + export type Policy = string; + export type PolicyMap = {[key: string]: Policy}; + export type PolicyName = string; + export type PolicyNameList = PolicyName[]; + export interface PutIdentityPolicyRequest { + /** + * The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. + */ + Identity: Identity; + /** + * The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores. + */ + PolicyName: PolicyName; + /** + * The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide. + */ + Policy: Policy; + } + export interface PutIdentityPolicyResponse { + } + export interface RawMessage { + /** + * The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail. Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For more information, go to the Amazon SES Developer Guide. + */ + Data: RawMessageData; + } + export type RawMessageData = Buffer|Uint8Array|Blob|string; + export interface ReceiptAction { + /** + * Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS. + */ + S3Action?: S3Action; + /** + * Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). + */ + BounceAction?: BounceAction; + /** + * Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS. + */ + WorkmailAction?: WorkmailAction; + /** + * Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS. + */ + LambdaAction?: LambdaAction; + /** + * Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS. + */ + StopAction?: StopAction; + /** + * Adds a header to the received email. + */ + AddHeaderAction?: AddHeaderAction; + /** + * Publishes the email content within a notification to Amazon SNS. + */ + SNSAction?: SNSAction; + } + export type ReceiptActionsList = ReceiptAction[]; + export interface ReceiptFilter { + /** + * The name of the IP address filter. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. + */ + Name: ReceiptFilterName; + /** + * A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them. + */ + IpFilter: ReceiptIpFilter; + } + export type ReceiptFilterList = ReceiptFilter[]; + export type ReceiptFilterName = string; + export type ReceiptFilterPolicy = "Block"|"Allow"|string; + export interface ReceiptIpFilter { + /** + * Indicates whether to block or allow incoming mail from the specified IP addresses. + */ + Policy: ReceiptFilterPolicy; + /** + * A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317. + */ + Cidr: Cidr; + } + export interface ReceiptRule { + /** + * The name of the receipt rule. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. + */ + Name: ReceiptRuleName; + /** + * If true, the receipt rule is active. The default value is false. + */ + Enabled?: Enabled; + /** + * Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional. + */ + TlsPolicy?: TlsPolicy; + /** + * The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains. + */ + Recipients?: RecipientsList; + /** + * An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. + */ + Actions?: ReceiptActionsList; + /** + * If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false. + */ + ScanEnabled?: Enabled; + } + export type ReceiptRuleName = string; + export type ReceiptRuleNamesList = ReceiptRuleName[]; + export interface ReceiptRuleSetMetadata { + /** + * The name of the receipt rule set. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. + */ + Name?: ReceiptRuleSetName; + /** + * The date and time the receipt rule set was created. + */ + CreatedTimestamp?: Timestamp; + } + export type ReceiptRuleSetName = string; + export type ReceiptRuleSetsLists = ReceiptRuleSetMetadata[]; + export type ReceiptRulesList = ReceiptRule[]; + export type Recipient = string; + export interface RecipientDsnFields { + /** + * The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message. Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798. + */ + FinalRecipient?: Address; + /** + * The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464. + */ + Action: DsnAction; + /** + * The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces. + */ + RemoteMta?: RemoteMta; + /** + * The status code that indicates what went wrong. This is required by RFC 3464. + */ + Status: DsnStatus; + /** + * An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter. + */ + DiagnosticCode?: DiagnosticCode; + /** + * The time the final delivery attempt was made, in RFC 822 date-time format. + */ + LastAttemptDate?: LastAttemptDate; + /** + * Additional X-headers to include in the DSN. + */ + ExtensionFields?: ExtensionFieldList; + } + export type RecipientsList = Recipient[]; + export type RemoteMta = string; + export type RenderedTemplate = string; + export interface ReorderReceiptRuleSetRequest { + /** + * The name of the receipt rule set to reorder. + */ + RuleSetName: ReceiptRuleSetName; + /** + * A list of the specified receipt rule set's receipt rules in the order that you want to put them. + */ + RuleNames: ReceiptRuleNamesList; + } + export interface ReorderReceiptRuleSetResponse { + } + export type ReportingMta = string; + export interface ReputationOptions { + /** + * Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES will send emails that use the configuration set. If the value is false, Amazon SES will not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled. + */ + SendingEnabled?: Enabled; + /** + * Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false. + */ + ReputationMetricsEnabled?: Enabled; + /** + * The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start. When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset. If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null. + */ + LastFreshStart?: LastFreshStart; + } + export interface S3Action { + /** + * The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicArn?: AmazonResourceName; + /** + * The name of the Amazon S3 bucket that incoming email will be saved to. + */ + BucketName: S3BucketName; + /** + * The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket. + */ + ObjectKeyPrefix?: S3KeyPrefix; + /** + * The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows: To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide. + */ + KmsKeyArn?: AmazonResourceName; + } + export type S3BucketName = string; + export type S3KeyPrefix = string; + export interface SNSAction { + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicArn: AmazonResourceName; + /** + * The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8. + */ + Encoding?: SNSActionEncoding; + } + export type SNSActionEncoding = "UTF-8"|"Base64"|string; + export interface SNSDestination { + /** + * The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicARN: AmazonResourceName; + } + export interface SendBounceRequest { + /** + * The message ID of the message to be bounced. + */ + OriginalMessageId: MessageId; + /** + * The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES. + */ + BounceSender: Address; + /** + * Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information. + */ + Explanation?: Explanation; + /** + * Message-related DSN fields. If not specified, Amazon SES will choose the values. + */ + MessageDsn?: MessageDsn; + /** + * A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list. + */ + BouncedRecipientInfoList: BouncedRecipientInfoList; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + BounceSenderArn?: AmazonResourceName; + } + export interface SendBounceResponse { + /** + * The message ID of the bounce message. + */ + MessageId?: MessageId; + } + export interface SendBulkTemplatedEmailRequest { + /** + * The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide. Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. + */ + Source: Address; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + SourceArn?: AmazonResourceName; + /** + * The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. + */ + ReplyToAddresses?: AddressList; + /** + * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. + */ + ReturnPath?: Address; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + ReturnPathArn?: AmazonResourceName; + /** + * The name of the configuration set to use when you send an email using SendBulkTemplatedEmail. + */ + ConfigurationSetName?: ConfigurationSetName; + /** + * A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail. + */ + DefaultTags?: MessageTagList; + /** + * The template to use when sending this email. + */ + Template: TemplateName; + /** + * The ARN of the template to use when sending this email. + */ + TemplateArn?: AmazonResourceName; + /** + * A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available. The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. + */ + DefaultTemplateData?: TemplateData; + /** + * One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array. + */ + Destinations: BulkEmailDestinationList; + } + export interface SendBulkTemplatedEmailResponse { + /** + * The unique message identifier returned from the SendBulkTemplatedEmail action. + */ + Status: BulkEmailDestinationStatusList; + } + export interface SendCustomVerificationEmailRequest { + /** + * The email address to verify. + */ + EmailAddress: Address; + /** + * The name of the custom verification email template to use when sending the verification email. + */ + TemplateName: TemplateName; + /** + * Name of a configuration set to use when sending the verification email. + */ + ConfigurationSetName?: ConfigurationSetName; + } + export interface SendCustomVerificationEmailResponse { + /** + * The unique message identifier returned from the SendCustomVerificationEmail operation. + */ + MessageId?: MessageId; + } + export interface SendDataPoint { + /** + * Time of the data point. + */ + Timestamp?: Timestamp; + /** + * Number of emails that have been sent. + */ + DeliveryAttempts?: Counter; + /** + * Number of emails that have bounced. + */ + Bounces?: Counter; + /** + * Number of unwanted emails that were rejected by recipients. + */ + Complaints?: Counter; + /** + * Number of emails rejected by Amazon SES. + */ + Rejects?: Counter; + } + export type SendDataPointList = SendDataPoint[]; + export interface SendEmailRequest { + /** + * The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide. Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. + */ + Source: Address; + /** + * The destination for this email, composed of To:, CC:, and BCC: fields. + */ + Destination: Destination; + /** + * The message to be sent. + */ + Message: Message; + /** + * The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. + */ + ReplyToAddresses?: AddressList; + /** + * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. + */ + ReturnPath?: Address; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + SourceArn?: AmazonResourceName; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + ReturnPathArn?: AmazonResourceName; + /** + * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. + */ + Tags?: MessageTagList; + /** + * The name of the configuration set to use when you send an email using SendEmail. + */ + ConfigurationSetName?: ConfigurationSetName; + } + export interface SendEmailResponse { + /** + * The unique message identifier returned from the SendEmail action. + */ + MessageId: MessageId; + } + export interface SendRawEmailRequest { + /** + * The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.) Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message. + */ + Source?: Address; + /** + * A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. + */ + Destinations?: AddressList; + /** + * The raw email message itself. The message has to meet the following criteria: The message has to contain a header and a body, separated by a blank line. All of the required header fields must be present in the message. Each part of a multipart MIME message must be formatted properly. Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide. The entire message must be base64-encoded. If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide. Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters. + */ + RawMessage: RawMessage; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email. Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide. + */ + FromArn?: AmazonResourceName; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide. + */ + SourceArn?: AmazonResourceName; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide. + */ + ReturnPathArn?: AmazonResourceName; + /** + * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. + */ + Tags?: MessageTagList; + /** + * The name of the configuration set to use when you send an email using SendRawEmail. + */ + ConfigurationSetName?: ConfigurationSetName; + } + export interface SendRawEmailResponse { + /** + * The unique message identifier returned from the SendRawEmail action. + */ + MessageId: MessageId; + } + export interface SendTemplatedEmailRequest { + /** + * The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide. Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. + */ + Source: Address; + /** + * The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields. + */ + Destination: Destination; + /** + * The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. + */ + ReplyToAddresses?: AddressList; + /** + * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. + */ + ReturnPath?: Address; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + SourceArn?: AmazonResourceName; + /** + * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. + */ + ReturnPathArn?: AmazonResourceName; + /** + * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. + */ + Tags?: MessageTagList; + /** + * The name of the configuration set to use when you send an email using SendTemplatedEmail. + */ + ConfigurationSetName?: ConfigurationSetName; + /** + * The template to use when sending this email. + */ + Template: TemplateName; + /** + * The ARN of the template to use when sending this email. + */ + TemplateArn?: AmazonResourceName; + /** + * A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. + */ + TemplateData: TemplateData; + } + export interface SendTemplatedEmailResponse { + /** + * The unique message identifier returned from the SendTemplatedEmail action. + */ + MessageId: MessageId; + } + export type SentLast24Hours = number; + export interface SetActiveReceiptRuleSetRequest { + /** + * The name of the receipt rule set to make active. Setting this value to null disables all email receiving. + */ + RuleSetName?: ReceiptRuleSetName; + } + export interface SetActiveReceiptRuleSetResponse { + } + export interface SetIdentityDkimEnabledRequest { + /** + * The identity for which DKIM signing should be enabled or disabled. + */ + Identity: Identity; + /** + * Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it. + */ + DkimEnabled: Enabled; + } + export interface SetIdentityDkimEnabledResponse { + } + export interface SetIdentityFeedbackForwardingEnabledRequest { + /** + * The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com. + */ + Identity: Identity; + /** + * Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types. + */ + ForwardingEnabled: Enabled; + } + export interface SetIdentityFeedbackForwardingEnabledResponse { + } + export interface SetIdentityHeadersInNotificationsEnabledRequest { + /** + * The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com. + */ + Identity: Identity; + /** + * The notification type for which to enable or disable headers in notifications. + */ + NotificationType: NotificationType; + /** + * Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications. This value can only be set when NotificationType is already set to use a particular Amazon SNS topic. + */ + Enabled: Enabled; + } + export interface SetIdentityHeadersInNotificationsEnabledResponse { + } + export interface SetIdentityMailFromDomainRequest { + /** + * The verified identity for which you want to enable or disable the specified custom MAIL FROM domain. + */ + Identity: Identity; + /** + * The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity. + */ + MailFromDomain?: MailFromDomainName; + /** + * The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email. The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states. + */ + BehaviorOnMXFailure?: BehaviorOnMXFailure; + } + export interface SetIdentityMailFromDomainResponse { + } + export interface SetIdentityNotificationTopicRequest { + /** + * The identity (email address or domain) that you want to set the Amazon SNS topic for. You can only specify a verified identity for this parameter. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + */ + Identity: Identity; + /** + * The type of notifications that will be published to the specified Amazon SNS topic. + */ + NotificationType: NotificationType; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled. + */ + SnsTopic?: NotificationTopic; + } + export interface SetIdentityNotificationTopicResponse { + } + export interface SetReceiptRulePositionRequest { + /** + * The name of the receipt rule set that contains the receipt rule to reposition. + */ + RuleSetName: ReceiptRuleSetName; + /** + * The name of the receipt rule to reposition. + */ + RuleName: ReceiptRuleName; + /** + * The name of the receipt rule after which to place the specified receipt rule. + */ + After?: ReceiptRuleName; + } + export interface SetReceiptRulePositionResponse { + } + export interface StopAction { + /** + * The name of the RuleSet that is being stopped. + */ + Scope: StopScope; + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicArn?: AmazonResourceName; + } + export type StopScope = "RuleSet"|string; + export type Subject = string; + export type SubjectPart = string; + export type SuccessRedirectionURL = string; + export interface Template { + /** + * The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. + */ + TemplateName: TemplateName; + /** + * The subject line of the email. + */ + SubjectPart?: SubjectPart; + /** + * The email body that will be visible to recipients whose email clients do not display HTML. + */ + TextPart?: TextPart; + /** + * The HTML body of the email. + */ + HtmlPart?: HtmlPart; + } + export type TemplateContent = string; + export type TemplateData = string; + export interface TemplateMetadata { + /** + * The name of the template. + */ + Name?: TemplateName; + /** + * The time and date the template was created. + */ + CreatedTimestamp?: Timestamp; + } + export type TemplateMetadataList = TemplateMetadata[]; + export type TemplateName = string; + export interface TestRenderTemplateRequest { + /** + * The name of the template that you want to render. + */ + TemplateName: TemplateName; + /** + * A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. + */ + TemplateData: TemplateData; + } + export interface TestRenderTemplateResponse { + /** + * The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter. + */ + RenderedTemplate?: RenderedTemplate; + } + export type TextPart = string; + export type Timestamp = Date; + export type TlsPolicy = "Require"|"Optional"|string; + export interface TrackingOptions { + /** + * The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain. + */ + CustomRedirectDomain?: CustomRedirectDomain; + } + export interface UpdateAccountSendingEnabledRequest { + /** + * Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region. + */ + Enabled?: Enabled; + } + export interface UpdateConfigurationSetEventDestinationRequest { + /** + * The name of the configuration set that contains the event destination that you want to update. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * The event destination object that you want to apply to the specified configuration set. + */ + EventDestination: EventDestination; + } + export interface UpdateConfigurationSetEventDestinationResponse { + } + export interface UpdateConfigurationSetReputationMetricsEnabledRequest { + /** + * The name of the configuration set that you want to update. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * Describes whether or not Amazon SES will publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. + */ + Enabled: Enabled; + } + export interface UpdateConfigurationSetSendingEnabledRequest { + /** + * The name of the configuration set that you want to update. + */ + ConfigurationSetName: ConfigurationSetName; + /** + * Describes whether email sending is enabled or disabled for the configuration set. + */ + Enabled: Enabled; + } + export interface UpdateConfigurationSetTrackingOptionsRequest { + /** + * The name of the configuration set for which you want to update the custom tracking domain. + */ + ConfigurationSetName: ConfigurationSetName; + TrackingOptions: TrackingOptions; + } + export interface UpdateConfigurationSetTrackingOptionsResponse { + } + export interface UpdateCustomVerificationEmailTemplateRequest { + /** + * The name of the custom verification email template that you want to update. + */ + TemplateName: TemplateName; + /** + * The email address that the custom verification email is sent from. + */ + FromEmailAddress?: FromAddress; + /** + * The subject line of the custom verification email. + */ + TemplateSubject?: Subject; + /** + * The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide. + */ + TemplateContent?: TemplateContent; + /** + * The URL that the recipient of the verification email is sent to if his or her address is successfully verified. + */ + SuccessRedirectionURL?: SuccessRedirectionURL; + /** + * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. + */ + FailureRedirectionURL?: FailureRedirectionURL; + } + export interface UpdateReceiptRuleRequest { + /** + * The name of the receipt rule set that the receipt rule belongs to. + */ + RuleSetName: ReceiptRuleSetName; + /** + * A data structure that contains the updated receipt rule information. + */ + Rule: ReceiptRule; + } + export interface UpdateReceiptRuleResponse { + } + export interface UpdateTemplateRequest { + Template: Template; + } + export interface UpdateTemplateResponse { + } + export type VerificationAttributes = {[key: string]: IdentityVerificationAttributes}; + export type VerificationStatus = "Pending"|"Success"|"Failed"|"TemporaryFailure"|"NotStarted"|string; + export type VerificationToken = string; + export type VerificationTokenList = VerificationToken[]; + export interface VerifyDomainDkimRequest { + /** + * The name of the domain to be verified for Easy DKIM signing. + */ + Domain: Domain; + } + export interface VerifyDomainDkimResponse { + /** + * A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. + */ + DkimTokens: VerificationTokenList; + } + export interface VerifyDomainIdentityRequest { + /** + * The domain to be verified. + */ + Domain: Domain; + } + export interface VerifyDomainIdentityResponse { + /** + * A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES. As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning. + */ + VerificationToken: VerificationToken; + } + export interface VerifyEmailAddressRequest { + /** + * The email address to be verified. + */ + EmailAddress: Address; + } + export interface VerifyEmailIdentityRequest { + /** + * The email address to be verified. + */ + EmailAddress: Address; + } + export interface VerifyEmailIdentityResponse { + } + export interface WorkmailAction { + /** + * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. + */ + TopicArn?: AmazonResourceName; + /** + * The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide. + */ + OrganizationArn: AmazonResourceName; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2010-12-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SES client. + */ + export import Types = SES; +} +export = SES; diff --git a/node_modules/aws-sdk/clients/ses.js b/node_modules/aws-sdk/clients/ses.js new file mode 100644 index 0000000..3bb7479 --- /dev/null +++ b/node_modules/aws-sdk/clients/ses.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['ses'] = {}; +AWS.SES = Service.defineService('ses', ['2010-12-01']); +Object.defineProperty(apiLoader.services['ses'], '2010-12-01', { + get: function get() { + var model = require('../apis/email-2010-12-01.min.json'); + model.paginators = require('../apis/email-2010-12-01.paginators.json').pagination; + model.waiters = require('../apis/email-2010-12-01.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SES; diff --git a/node_modules/aws-sdk/clients/shield.d.ts b/node_modules/aws-sdk/clients/shield.d.ts new file mode 100644 index 0000000..cdda1f2 --- /dev/null +++ b/node_modules/aws-sdk/clients/shield.d.ts @@ -0,0 +1,619 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Shield extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Shield.Types.ClientConfiguration) + config: Config & Shield.Types.ClientConfiguration; + /** + * Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs. You can associate up to 10 Amazon S3 buckets with your subscription. To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. + */ + associateDRTLogBucket(params: Shield.Types.AssociateDRTLogBucketRequest, callback?: (err: AWSError, data: Shield.Types.AssociateDRTLogBucketResponse) => void): Request; + /** + * Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs. You can associate up to 10 Amazon S3 buckets with your subscription. To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. + */ + associateDRTLogBucket(callback?: (err: AWSError, data: Shield.Types.AssociateDRTLogBucketResponse) => void): Request; + /** + * Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs. You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal. The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you. You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service. To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. + */ + associateDRTRole(params: Shield.Types.AssociateDRTRoleRequest, callback?: (err: AWSError, data: Shield.Types.AssociateDRTRoleResponse) => void): Request; + /** + * Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs. You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal. The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you. You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service. To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. + */ + associateDRTRole(callback?: (err: AWSError, data: Shield.Types.AssociateDRTRoleResponse) => void): Request; + /** + * Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone. You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources. + */ + createProtection(params: Shield.Types.CreateProtectionRequest, callback?: (err: AWSError, data: Shield.Types.CreateProtectionResponse) => void): Request; + /** + * Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone. You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources. + */ + createProtection(callback?: (err: AWSError, data: Shield.Types.CreateProtectionResponse) => void): Request; + /** + * Activates AWS Shield Advanced for an account. As part of this request you can specify EmergencySettings that automaticaly grant the DDoS response team (DRT) needed permissions to assist you during a suspected DDoS attack. For more information see Authorize the DDoS Response Team to Create Rules and Web ACLs on Your Behalf. When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. + */ + createSubscription(params: Shield.Types.CreateSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.CreateSubscriptionResponse) => void): Request; + /** + * Activates AWS Shield Advanced for an account. As part of this request you can specify EmergencySettings that automaticaly grant the DDoS response team (DRT) needed permissions to assist you during a suspected DDoS attack. For more information see Authorize the DDoS Response Team to Create Rules and Web ACLs on Your Behalf. When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. + */ + createSubscription(callback?: (err: AWSError, data: Shield.Types.CreateSubscriptionResponse) => void): Request; + /** + * Deletes an AWS Shield Advanced Protection. + */ + deleteProtection(params: Shield.Types.DeleteProtectionRequest, callback?: (err: AWSError, data: Shield.Types.DeleteProtectionResponse) => void): Request; + /** + * Deletes an AWS Shield Advanced Protection. + */ + deleteProtection(callback?: (err: AWSError, data: Shield.Types.DeleteProtectionResponse) => void): Request; + /** + * Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment. + */ + deleteSubscription(params: Shield.Types.DeleteSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.DeleteSubscriptionResponse) => void): Request; + /** + * Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment. + */ + deleteSubscription(callback?: (err: AWSError, data: Shield.Types.DeleteSubscriptionResponse) => void): Request; + /** + * Describes the details of a DDoS attack. + */ + describeAttack(params: Shield.Types.DescribeAttackRequest, callback?: (err: AWSError, data: Shield.Types.DescribeAttackResponse) => void): Request; + /** + * Describes the details of a DDoS attack. + */ + describeAttack(callback?: (err: AWSError, data: Shield.Types.DescribeAttackResponse) => void): Request; + /** + * Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation. + */ + describeDRTAccess(params: Shield.Types.DescribeDRTAccessRequest, callback?: (err: AWSError, data: Shield.Types.DescribeDRTAccessResponse) => void): Request; + /** + * Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation. + */ + describeDRTAccess(callback?: (err: AWSError, data: Shield.Types.DescribeDRTAccessResponse) => void): Request; + /** + * Lists the email addresses that the DRT can use to contact you during a suspected attack. + */ + describeEmergencyContactSettings(params: Shield.Types.DescribeEmergencyContactSettingsRequest, callback?: (err: AWSError, data: Shield.Types.DescribeEmergencyContactSettingsResponse) => void): Request; + /** + * Lists the email addresses that the DRT can use to contact you during a suspected attack. + */ + describeEmergencyContactSettings(callback?: (err: AWSError, data: Shield.Types.DescribeEmergencyContactSettingsResponse) => void): Request; + /** + * Lists the details of a Protection object. + */ + describeProtection(params: Shield.Types.DescribeProtectionRequest, callback?: (err: AWSError, data: Shield.Types.DescribeProtectionResponse) => void): Request; + /** + * Lists the details of a Protection object. + */ + describeProtection(callback?: (err: AWSError, data: Shield.Types.DescribeProtectionResponse) => void): Request; + /** + * Provides details about the AWS Shield Advanced subscription for an account. + */ + describeSubscription(params: Shield.Types.DescribeSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.DescribeSubscriptionResponse) => void): Request; + /** + * Provides details about the AWS Shield Advanced subscription for an account. + */ + describeSubscription(callback?: (err: AWSError, data: Shield.Types.DescribeSubscriptionResponse) => void): Request; + /** + * Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs. To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access. + */ + disassociateDRTLogBucket(params: Shield.Types.DisassociateDRTLogBucketRequest, callback?: (err: AWSError, data: Shield.Types.DisassociateDRTLogBucketResponse) => void): Request; + /** + * Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs. To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access. + */ + disassociateDRTLogBucket(callback?: (err: AWSError, data: Shield.Types.DisassociateDRTLogBucketResponse) => void): Request; + /** + * Removes the DDoS Response team's (DRT) access to your AWS account. To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access. + */ + disassociateDRTRole(params: Shield.Types.DisassociateDRTRoleRequest, callback?: (err: AWSError, data: Shield.Types.DisassociateDRTRoleResponse) => void): Request; + /** + * Removes the DDoS Response team's (DRT) access to your AWS account. To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access. + */ + disassociateDRTRole(callback?: (err: AWSError, data: Shield.Types.DisassociateDRTRoleResponse) => void): Request; + /** + * Returns the SubscriptionState, either Active or Inactive. + */ + getSubscriptionState(params: Shield.Types.GetSubscriptionStateRequest, callback?: (err: AWSError, data: Shield.Types.GetSubscriptionStateResponse) => void): Request; + /** + * Returns the SubscriptionState, either Active or Inactive. + */ + getSubscriptionState(callback?: (err: AWSError, data: Shield.Types.GetSubscriptionStateResponse) => void): Request; + /** + * Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period. + */ + listAttacks(params: Shield.Types.ListAttacksRequest, callback?: (err: AWSError, data: Shield.Types.ListAttacksResponse) => void): Request; + /** + * Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period. + */ + listAttacks(callback?: (err: AWSError, data: Shield.Types.ListAttacksResponse) => void): Request; + /** + * Lists all Protection objects for the account. + */ + listProtections(params: Shield.Types.ListProtectionsRequest, callback?: (err: AWSError, data: Shield.Types.ListProtectionsResponse) => void): Request; + /** + * Lists all Protection objects for the account. + */ + listProtections(callback?: (err: AWSError, data: Shield.Types.ListProtectionsResponse) => void): Request; + /** + * Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack. + */ + updateEmergencyContactSettings(params: Shield.Types.UpdateEmergencyContactSettingsRequest, callback?: (err: AWSError, data: Shield.Types.UpdateEmergencyContactSettingsResponse) => void): Request; + /** + * Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack. + */ + updateEmergencyContactSettings(callback?: (err: AWSError, data: Shield.Types.UpdateEmergencyContactSettingsResponse) => void): Request; + /** + * Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated. + */ + updateSubscription(params: Shield.Types.UpdateSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.UpdateSubscriptionResponse) => void): Request; + /** + * Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated. + */ + updateSubscription(callback?: (err: AWSError, data: Shield.Types.UpdateSubscriptionResponse) => void): Request; +} +declare namespace Shield { + export interface AssociateDRTLogBucketRequest { + /** + * The Amazon S3 bucket that contains your flow logs. + */ + LogBucket: LogBucket; + } + export interface AssociateDRTLogBucketResponse { + } + export interface AssociateDRTRoleRequest { + /** + * The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies. + */ + RoleArn: RoleArn; + } + export interface AssociateDRTRoleResponse { + } + export interface AttackDetail { + /** + * The unique identifier (ID) of the attack. + */ + AttackId?: AttackId; + /** + * The ARN (Amazon Resource Name) of the resource that was attacked. + */ + ResourceArn?: ResourceArn; + /** + * If applicable, additional detail about the resource being attacked, for example, IP address or URL. + */ + SubResources?: SubResourceSummaryList; + /** + * The time the attack started, in Unix time in seconds. For more information see timestamp. + */ + StartTime?: AttackTimestamp; + /** + * The time the attack ended, in Unix time in seconds. For more information see timestamp. + */ + EndTime?: AttackTimestamp; + /** + * List of counters that describe the attack for the specified time period. + */ + AttackCounters?: SummarizedCounterList; + /** + * The array of AttackProperty objects. + */ + AttackProperties?: AttackProperties; + /** + * List of mitigation actions taken for the attack. + */ + Mitigations?: MitigationList; + } + export type AttackId = string; + export type AttackLayer = "NETWORK"|"APPLICATION"|string; + export type AttackProperties = AttackProperty[]; + export interface AttackProperty { + /** + * The type of DDoS event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events. + */ + AttackLayer?: AttackLayer; + /** + * Defines the DDoS attack property information that is provided. + */ + AttackPropertyIdentifier?: AttackPropertyIdentifier; + /** + * The array of Contributor objects that includes the top five contributors to an attack. + */ + TopContributors?: TopContributors; + /** + * The unit of the Value of the contributions. + */ + Unit?: Unit; + /** + * The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list. + */ + Total?: Long; + } + export type AttackPropertyIdentifier = "DESTINATION_URL"|"REFERRER"|"SOURCE_ASN"|"SOURCE_COUNTRY"|"SOURCE_IP_ADDRESS"|"SOURCE_USER_AGENT"|string; + export type AttackSummaries = AttackSummary[]; + export interface AttackSummary { + /** + * The unique identifier (ID) of the attack. + */ + AttackId?: String; + /** + * The ARN (Amazon Resource Name) of the resource that was attacked. + */ + ResourceArn?: String; + /** + * The start time of the attack, in Unix time in seconds. For more information see timestamp. + */ + StartTime?: AttackTimestamp; + /** + * The end time of the attack, in Unix time in seconds. For more information see timestamp. + */ + EndTime?: AttackTimestamp; + /** + * The list of attacks for a specified time period. + */ + AttackVectors?: AttackVectorDescriptionList; + } + export type AttackTimestamp = Date; + export interface AttackVectorDescription { + /** + * The attack type. Valid values: UDP_TRAFFIC UDP_FRAGMENT GENERIC_UDP_REFLECTION DNS_REFLECTION NTP_REFLECTION CHARGEN_REFLECTION SSDP_REFLECTION PORT_MAPPER RIP_REFLECTION SNMP_REFLECTION MSSQL_REFLECTION NET_BIOS_REFLECTION SYN_FLOOD ACK_FLOOD REQUEST_FLOOD + */ + VectorType: String; + } + export type AttackVectorDescriptionList = AttackVectorDescription[]; + export type AutoRenew = "ENABLED"|"DISABLED"|string; + export interface Contributor { + /** + * The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States. + */ + Name?: String; + /** + * The contribution of this contributor expressed in Protection units. For example 10,000. + */ + Value?: Long; + } + export interface CreateProtectionRequest { + /** + * Friendly name for the Protection you are creating. + */ + Name: ProtectionName; + /** + * The ARN (Amazon Resource Name) of the resource to be protected. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id + */ + ResourceArn: ResourceArn; + } + export interface CreateProtectionResponse { + /** + * The unique identifier (ID) for the Protection object that is created. + */ + ProtectionId?: ProtectionId; + } + export interface CreateSubscriptionRequest { + } + export interface CreateSubscriptionResponse { + } + export interface DeleteProtectionRequest { + /** + * The unique identifier (ID) for the Protection object to be deleted. + */ + ProtectionId: ProtectionId; + } + export interface DeleteProtectionResponse { + } + export interface DeleteSubscriptionRequest { + } + export interface DeleteSubscriptionResponse { + } + export interface DescribeAttackRequest { + /** + * The unique identifier (ID) for the attack that to be described. + */ + AttackId: AttackId; + } + export interface DescribeAttackResponse { + /** + * The attack that is described. + */ + Attack?: AttackDetail; + } + export interface DescribeDRTAccessRequest { + } + export interface DescribeDRTAccessResponse { + /** + * The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account. + */ + RoleArn?: RoleArn; + /** + * The list of Amazon S3 buckets accessed by the DRT. + */ + LogBucketList?: LogBucketList; + } + export interface DescribeEmergencyContactSettingsRequest { + } + export interface DescribeEmergencyContactSettingsResponse { + /** + * A list of email addresses that the DRT can use to contact you during a suspected attack. + */ + EmergencyContactList?: EmergencyContactList; + } + export interface DescribeProtectionRequest { + /** + * The unique identifier (ID) for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both. + */ + ProtectionId?: ProtectionId; + /** + * The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both. + */ + ResourceArn?: ResourceArn; + } + export interface DescribeProtectionResponse { + /** + * The Protection object that is described. + */ + Protection?: Protection; + } + export interface DescribeSubscriptionRequest { + } + export interface DescribeSubscriptionResponse { + /** + * The AWS Shield Advanced subscription details for an account. + */ + Subscription?: Subscription; + } + export interface DisassociateDRTLogBucketRequest { + /** + * The Amazon S3 bucket that contains your flow logs. + */ + LogBucket: LogBucket; + } + export interface DisassociateDRTLogBucketResponse { + } + export interface DisassociateDRTRoleRequest { + } + export interface DisassociateDRTRoleResponse { + } + export type Double = number; + export type DurationInSeconds = number; + export type EmailAddress = string; + export interface EmergencyContact { + /** + * An email address that the DRT can use to contact you during a suspected attack. + */ + EmailAddress: EmailAddress; + } + export type EmergencyContactList = EmergencyContact[]; + export interface GetSubscriptionStateRequest { + } + export interface GetSubscriptionStateResponse { + /** + * The status of the subscription. + */ + SubscriptionState: SubscriptionState; + } + export type Integer = number; + export interface Limit { + /** + * The type of protection. + */ + Type?: String; + /** + * The maximum number of protections that can be created for the specified Type. + */ + Max?: Long; + } + export type Limits = Limit[]; + export interface ListAttacksRequest { + /** + * The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included. + */ + ResourceArns?: ResourceArnFilterList; + /** + * The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed. + */ + StartTime?: TimeRange; + /** + * The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed. + */ + EndTime?: TimeRange; + /** + * The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call. + */ + NextToken?: Token; + /** + * The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned. This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of AttackSummary objects returned could be less than MaxResults, even if there are still more AttackSummary objects yet to return. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken. + */ + MaxResults?: MaxResults; + } + export interface ListAttacksResponse { + /** + * The attack information for the specified time range. + */ + AttackSummaries?: AttackSummaries; + /** + * The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items. AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken. + */ + NextToken?: Token; + } + export interface ListProtectionsRequest { + /** + * The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call. + */ + NextToken?: Token; + /** + * The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned. This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of Protection objects returned could be less than MaxResults, even if there are still more Protection objects yet to return. If there are more Protection objects to return, AWS WAF will always also return a NextToken. + */ + MaxResults?: MaxResults; + } + export interface ListProtectionsResponse { + /** + * The array of enabled Protection objects. + */ + Protections?: Protections; + /** + * If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections. AWS WAF might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a NextToken. + */ + NextToken?: Token; + } + export type LogBucket = string; + export type LogBucketList = LogBucket[]; + export type Long = number; + export type MaxResults = number; + export interface Mitigation { + /** + * The name of the mitigation taken for this attack. + */ + MitigationName?: String; + } + export type MitigationList = Mitigation[]; + export interface Protection { + /** + * The unique identifier (ID) of the protection. + */ + Id?: ProtectionId; + /** + * The friendly name of the protection. For example, My CloudFront distributions. + */ + Name?: ProtectionName; + /** + * The ARN (Amazon Resource Name) of the AWS resource that is protected. + */ + ResourceArn?: ResourceArn; + } + export type ProtectionId = string; + export type ProtectionName = string; + export type Protections = Protection[]; + export type ResourceArn = string; + export type ResourceArnFilterList = ResourceArn[]; + export type RoleArn = string; + export type String = string; + export interface SubResourceSummary { + /** + * The SubResource type. + */ + Type?: SubResourceType; + /** + * The unique identifier (ID) of the SubResource. + */ + Id?: String; + /** + * The list of attack types and associated counters. + */ + AttackVectors?: SummarizedAttackVectorList; + /** + * The counters that describe the details of the attack. + */ + Counters?: SummarizedCounterList; + } + export type SubResourceSummaryList = SubResourceSummary[]; + export type SubResourceType = "IP"|"URL"|string; + export interface Subscription { + /** + * The start time of the subscription, in Unix time in seconds. For more information see timestamp. + */ + StartTime?: Timestamp; + /** + * The date and time your subscription will end. + */ + EndTime?: Timestamp; + /** + * The length, in seconds, of the AWS Shield Advanced subscription for the account. + */ + TimeCommitmentInSeconds?: DurationInSeconds; + /** + * If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged. + */ + AutoRenew?: AutoRenew; + /** + * Specifies how many protections of a given type you can create. + */ + Limits?: Limits; + } + export type SubscriptionState = "ACTIVE"|"INACTIVE"|string; + export interface SummarizedAttackVector { + /** + * The attack type, for example, SNMP reflection or SYN flood. + */ + VectorType: String; + /** + * The list of counters that describe the details of the attack. + */ + VectorCounters?: SummarizedCounterList; + } + export type SummarizedAttackVectorList = SummarizedAttackVector[]; + export interface SummarizedCounter { + /** + * The counter name. + */ + Name?: String; + /** + * The maximum value of the counter for a specified time period. + */ + Max?: Double; + /** + * The average value of the counter for a specified time period. + */ + Average?: Double; + /** + * The total of counter values for a specified time period. + */ + Sum?: Double; + /** + * The number of counters for a specified time period. + */ + N?: Integer; + /** + * The unit of the counters. + */ + Unit?: String; + } + export type SummarizedCounterList = SummarizedCounter[]; + export interface TimeRange { + /** + * The start time, in Unix time in seconds. For more information see timestamp. + */ + FromInclusive?: AttackTimestamp; + /** + * The end time, in Unix time in seconds. For more information see timestamp. + */ + ToExclusive?: AttackTimestamp; + } + export type Timestamp = Date; + export type Token = string; + export type TopContributors = Contributor[]; + export type Unit = "BITS"|"BYTES"|"PACKETS"|"REQUESTS"|string; + export interface UpdateEmergencyContactSettingsRequest { + /** + * A list of email addresses that the DRT can use to contact you during a suspected attack. + */ + EmergencyContactList?: EmergencyContactList; + } + export interface UpdateEmergencyContactSettingsResponse { + } + export interface UpdateSubscriptionRequest { + /** + * When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged. + */ + AutoRenew?: AutoRenew; + } + export interface UpdateSubscriptionResponse { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-06-02"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Shield client. + */ + export import Types = Shield; +} +export = Shield; diff --git a/node_modules/aws-sdk/clients/shield.js b/node_modules/aws-sdk/clients/shield.js new file mode 100644 index 0000000..3d1c737 --- /dev/null +++ b/node_modules/aws-sdk/clients/shield.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['shield'] = {}; +AWS.Shield = Service.defineService('shield', ['2016-06-02']); +Object.defineProperty(apiLoader.services['shield'], '2016-06-02', { + get: function get() { + var model = require('../apis/shield-2016-06-02.min.json'); + model.paginators = require('../apis/shield-2016-06-02.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Shield; diff --git a/node_modules/aws-sdk/clients/signer.d.ts b/node_modules/aws-sdk/clients/signer.d.ts new file mode 100644 index 0000000..673afda --- /dev/null +++ b/node_modules/aws-sdk/clients/signer.d.ts @@ -0,0 +1,619 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {WaiterConfiguration} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Signer extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Signer.Types.ClientConfiguration) + config: Config & Signer.Types.ClientConfiguration; + /** + * Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation. + */ + cancelSigningProfile(params: Signer.Types.CancelSigningProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation. + */ + cancelSigningProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation. + */ + describeSigningJob(params: Signer.Types.DescribeSigningJobRequest, callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request; + /** + * Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation. + */ + describeSigningJob(callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request; + /** + * Returns information on a specific signing platform. + */ + getSigningPlatform(params: Signer.Types.GetSigningPlatformRequest, callback?: (err: AWSError, data: Signer.Types.GetSigningPlatformResponse) => void): Request; + /** + * Returns information on a specific signing platform. + */ + getSigningPlatform(callback?: (err: AWSError, data: Signer.Types.GetSigningPlatformResponse) => void): Request; + /** + * Returns information on a specific signing profile. + */ + getSigningProfile(params: Signer.Types.GetSigningProfileRequest, callback?: (err: AWSError, data: Signer.Types.GetSigningProfileResponse) => void): Request; + /** + * Returns information on a specific signing profile. + */ + getSigningProfile(callback?: (err: AWSError, data: Signer.Types.GetSigningProfileResponse) => void): Request; + /** + * Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned. + */ + listSigningJobs(params: Signer.Types.ListSigningJobsRequest, callback?: (err: AWSError, data: Signer.Types.ListSigningJobsResponse) => void): Request; + /** + * Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned. + */ + listSigningJobs(callback?: (err: AWSError, data: Signer.Types.ListSigningJobsResponse) => void): Request; + /** + * Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned. + */ + listSigningPlatforms(params: Signer.Types.ListSigningPlatformsRequest, callback?: (err: AWSError, data: Signer.Types.ListSigningPlatformsResponse) => void): Request; + /** + * Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned. + */ + listSigningPlatforms(callback?: (err: AWSError, data: Signer.Types.ListSigningPlatformsResponse) => void): Request; + /** + * Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned. + */ + listSigningProfiles(params: Signer.Types.ListSigningProfilesRequest, callback?: (err: AWSError, data: Signer.Types.ListSigningProfilesResponse) => void): Request; + /** + * Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned. + */ + listSigningProfiles(callback?: (err: AWSError, data: Signer.Types.ListSigningProfilesResponse) => void): Request; + /** + * Creates a signing profile. A signing profile is an AWS Signer template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html + */ + putSigningProfile(params: Signer.Types.PutSigningProfileRequest, callback?: (err: AWSError, data: Signer.Types.PutSigningProfileResponse) => void): Request; + /** + * Creates a signing profile. A signing profile is an AWS Signer template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html + */ + putSigningProfile(callback?: (err: AWSError, data: Signer.Types.PutSigningProfileResponse) => void): Request; + /** + * Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements: You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide. Your S3 source bucket must be version enabled. You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code. You specify the name of the source and destination buckets when calling the StartSigningJob operation. You must also specify a request token that identifies your request to AWS Signer. You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob. For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/ + */ + startSigningJob(params: Signer.Types.StartSigningJobRequest, callback?: (err: AWSError, data: Signer.Types.StartSigningJobResponse) => void): Request; + /** + * Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements: You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide. Your S3 source bucket must be version enabled. You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code. You specify the name of the source and destination buckets when calling the StartSigningJob operation. You must also specify a request token that identifies your request to AWS Signer. You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob. For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/ + */ + startSigningJob(callback?: (err: AWSError, data: Signer.Types.StartSigningJobResponse) => void): Request; + /** + * Waits for the successfulSigningJob state by periodically calling the underlying Signer.describeSigningJoboperation every 20 seconds (at most 25 times). + */ + waitFor(state: "successfulSigningJob", params: Signer.Types.DescribeSigningJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request; + /** + * Waits for the successfulSigningJob state by periodically calling the underlying Signer.describeSigningJoboperation every 20 seconds (at most 25 times). + */ + waitFor(state: "successfulSigningJob", callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request; +} +declare namespace Signer { + export type key = string; + export type BucketName = string; + export interface CancelSigningProfileRequest { + /** + * The name of the signing profile to be canceled. + */ + profileName: ProfileName; + } + export type Category = "AWSIoT"|string; + export type CertificateArn = string; + export type ClientRequestToken = string; + export type CompletedAt = Date; + export type CreatedAt = Date; + export interface DescribeSigningJobRequest { + /** + * The ID of the signing job on input. + */ + jobId: JobId; + } + export interface DescribeSigningJobResponse { + /** + * The ID of the signing job on output. + */ + jobId?: JobId; + /** + * The object that contains the name of your S3 bucket or your raw code. + */ + source?: Source; + /** + * Amazon Resource Name (ARN) of your code signing certificate. + */ + signingMaterial?: SigningMaterial; + /** + * The microcontroller platform to which your signed code image will be distributed. + */ + platformId?: PlatformId; + /** + * The name of the profile that initiated the signing operation. + */ + profileName?: ProfileName; + /** + * A list of any overrides that were applied to the signing operation. + */ + overrides?: SigningPlatformOverrides; + /** + * Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job. + */ + signingParameters?: SigningParameters; + /** + * Date and time that the signing job was created. + */ + createdAt?: CreatedAt; + /** + * Date and time that the signing job was completed. + */ + completedAt?: CompletedAt; + /** + * The IAM principal that requested the signing job. + */ + requestedBy?: RequestedBy; + /** + * Status of the signing job. + */ + status?: SigningStatus; + /** + * String value that contains the status reason. + */ + statusReason?: StatusReason; + /** + * Name of the S3 bucket where the signed code image is saved by AWS Signer. + */ + signedObject?: SignedObject; + } + export interface Destination { + /** + * The S3Destination object. + */ + s3?: S3Destination; + } + export type DisplayName = string; + export type EncryptionAlgorithm = "RSA"|"ECDSA"|string; + export interface EncryptionAlgorithmOptions { + /** + * The set of accepted encryption algorithms that are allowed in an AWS Signer job. + */ + allowedValues: EncryptionAlgorithms; + /** + * The default encryption algorithm that is used by an AWS Signer job. + */ + defaultValue: EncryptionAlgorithm; + } + export type EncryptionAlgorithms = EncryptionAlgorithm[]; + export interface GetSigningPlatformRequest { + /** + * The ID of the target signing platform. + */ + platformId: PlatformId; + } + export interface GetSigningPlatformResponse { + /** + * The ID of the target signing platform. + */ + platformId?: PlatformId; + /** + * The display name of the target signing platform. + */ + displayName?: DisplayName; + /** + * A list of partner entities that use the target signing platform. + */ + partner?: String; + /** + * The validation template that is used by the target signing platform. + */ + target?: String; + /** + * The category type of the target signing platform. + */ + category?: Category; + /** + * A list of configurations applied to the target platform at signing. + */ + signingConfiguration?: SigningConfiguration; + /** + * The format of the target platform's signing image. + */ + signingImageFormat?: SigningImageFormat; + /** + * The maximum size (in MB) of the payload that can be signed by the target platform. + */ + maxSizeInMB?: MaxSizeInMB; + } + export interface GetSigningProfileRequest { + /** + * The name of the target signing profile. + */ + profileName: ProfileName; + } + export interface GetSigningProfileResponse { + /** + * The name of the target signing profile. + */ + profileName?: ProfileName; + /** + * The ARN of the certificate that the target profile uses for signing operations. + */ + signingMaterial?: SigningMaterial; + /** + * The ID of the platform that is used by the target signing profile. + */ + platformId?: PlatformId; + /** + * A list of overrides applied by the target signing profile for signing operations. + */ + overrides?: SigningPlatformOverrides; + /** + * A map of key-value pairs for signing operations that is attached to the target signing profile. + */ + signingParameters?: SigningParameters; + /** + * The status of the target signing profile. + */ + status?: SigningProfileStatus; + } + export type HashAlgorithm = "SHA1"|"SHA256"|string; + export interface HashAlgorithmOptions { + /** + * The set of accepted hash algorithms allowed in an AWS Signer job. + */ + allowedValues: HashAlgorithms; + /** + * The default hash algorithm that is used in an AWS Signer job. + */ + defaultValue: HashAlgorithm; + } + export type HashAlgorithms = HashAlgorithm[]; + export type ImageFormat = "JSON"|string; + export type ImageFormats = ImageFormat[]; + export type JobId = string; + export type Key = string; + export interface ListSigningJobsRequest { + /** + * A status value with which to filter your results. + */ + status?: SigningStatus; + /** + * The ID of microcontroller platform that you specified for the distribution of your code image. + */ + platformId?: PlatformId; + /** + * The IAM principal that requested the signing job. + */ + requestedBy?: RequestedBy; + /** + * Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items. + */ + maxResults?: MaxResults; + /** + * String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received. + */ + nextToken?: NextToken; + } + export interface ListSigningJobsResponse { + /** + * A list of your signing jobs. + */ + jobs?: SigningJobs; + /** + * String for specifying the next set of paginated results. + */ + nextToken?: NextToken; + } + export interface ListSigningPlatformsRequest { + /** + * The category type of a signing platform. + */ + category?: String; + /** + * Any partner entities connected to a signing platform. + */ + partner?: String; + /** + * The validation template that is used by the target signing platform. + */ + target?: String; + /** + * The maximum number of results to be returned by this operation. + */ + maxResults?: MaxResults; + /** + * Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received. + */ + nextToken?: String; + } + export interface ListSigningPlatformsResponse { + /** + * A list of all platforms that match the request parameters. + */ + platforms?: SigningPlatforms; + /** + * Value for specifying the next set of paginated results to return. + */ + nextToken?: String; + } + export interface ListSigningProfilesRequest { + /** + * Designates whether to include profiles with the status of CANCELED. + */ + includeCanceled?: bool; + /** + * The maximum number of profiles to be returned. + */ + maxResults?: MaxResults; + /** + * Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received. + */ + nextToken?: NextToken; + } + export interface ListSigningProfilesResponse { + /** + * A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true. + */ + profiles?: SigningProfiles; + /** + * Value for specifying the next set of paginated results to return. + */ + nextToken?: NextToken; + } + export type MaxResults = number; + export type MaxSizeInMB = number; + export type NextToken = string; + export type PlatformId = string; + export type Prefix = string; + export type ProfileName = string; + export interface PutSigningProfileRequest { + /** + * The name of the signing profile to be created. + */ + profileName: ProfileName; + /** + * The AWS Certificate Manager certificate that will be used to sign code with the new signing profile. + */ + signingMaterial: SigningMaterial; + /** + * The ID of the signing profile to be created. + */ + platformId: PlatformId; + /** + * A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm). + */ + overrides?: SigningPlatformOverrides; + /** + * Map of key-value pairs for signing. These can include any information that you want to use during signing. + */ + signingParameters?: SigningParameters; + } + export interface PutSigningProfileResponse { + /** + * The Amazon Resource Name (ARN) of the signing profile created. + */ + arn?: string; + } + export type RequestedBy = string; + export interface S3Destination { + /** + * Name of the S3 bucket. + */ + bucketName?: BucketName; + /** + * An Amazon S3 prefix that you can use to limit responses to those that begin with the specified prefix. + */ + prefix?: Prefix; + } + export interface S3SignedObject { + /** + * Name of the S3 bucket. + */ + bucketName?: BucketName; + /** + * Key name that uniquely identifies a signed code image in your bucket. + */ + key?: key; + } + export interface S3Source { + /** + * Name of the S3 bucket. + */ + bucketName: BucketName; + /** + * Key name of the bucket object that contains your unsigned code. + */ + key: Key; + /** + * Version of your source image in your version enabled S3 bucket. + */ + version: Version; + } + export interface SignedObject { + /** + * The S3SignedObject. + */ + s3?: S3SignedObject; + } + export interface SigningConfiguration { + /** + * The encryption algorithm options that are available for an AWS Signer job. + */ + encryptionAlgorithmOptions: EncryptionAlgorithmOptions; + /** + * The hash algorithm options that are available for an AWS Signer job. + */ + hashAlgorithmOptions: HashAlgorithmOptions; + } + export interface SigningConfigurationOverrides { + /** + * A specified override of the default encryption algorithm that is used in an AWS Signer job. + */ + encryptionAlgorithm?: EncryptionAlgorithm; + /** + * A specified override of the default hash algorithm that is used in an AWS Signer job. + */ + hashAlgorithm?: HashAlgorithm; + } + export interface SigningImageFormat { + /** + * The supported formats of an AWS Signer signing image. + */ + supportedFormats: ImageFormats; + /** + * The default format of an AWS Signer signing image. + */ + defaultFormat: ImageFormat; + } + export interface SigningJob { + /** + * The ID of the signing job. + */ + jobId?: JobId; + /** + * A Source that contains information about a signing job's code image source. + */ + source?: Source; + /** + * A SignedObject structure that contains information about a signing job's signed code image. + */ + signedObject?: SignedObject; + /** + * A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job. + */ + signingMaterial?: SigningMaterial; + /** + * The date and time that the signing job was created. + */ + createdAt?: CreatedAt; + /** + * The status of the signing job. + */ + status?: SigningStatus; + } + export type SigningJobs = SigningJob[]; + export interface SigningMaterial { + /** + * The Amazon Resource Name (ARN) of the certificates that is used to sign your code. + */ + certificateArn: CertificateArn; + } + export type SigningParameterKey = string; + export type SigningParameterValue = string; + export type SigningParameters = {[key: string]: SigningParameterValue}; + export interface SigningPlatform { + /** + * The ID of an AWS Signer platform. + */ + platformId?: String; + /** + * The display name of an AWS Signer platform. + */ + displayName?: String; + /** + * Any partner entities linked to an AWS Signer platform. + */ + partner?: String; + /** + * The types of targets that can be signed by an AWS Signer platform. + */ + target?: String; + /** + * The category of an AWS Signer platform. + */ + category?: Category; + /** + * The configuration of an AWS Signer platform. This includes the designated hash algorithm and encryption algorithm of a signing platform. + */ + signingConfiguration?: SigningConfiguration; + /** + * The signing image format that is used by an AWS Signer platform. + */ + signingImageFormat?: SigningImageFormat; + /** + * The maximum size (in MB) of code that can be signed by a AWS Signer platform. + */ + maxSizeInMB?: MaxSizeInMB; + } + export interface SigningPlatformOverrides { + signingConfiguration?: SigningConfigurationOverrides; + } + export type SigningPlatforms = SigningPlatform[]; + export interface SigningProfile { + /** + * The name of the AWS Signer profile. + */ + profileName?: ProfileName; + /** + * The ACM certificate that is available for use by a signing profile. + */ + signingMaterial?: SigningMaterial; + /** + * The ID of a platform that is available for use by a signing profile. + */ + platformId?: PlatformId; + /** + * The parameters that are available for use by an AWS Signer user. + */ + signingParameters?: SigningParameters; + /** + * The status of an AWS Signer profile. + */ + status?: SigningProfileStatus; + } + export type SigningProfileStatus = "Active"|"Canceled"|string; + export type SigningProfiles = SigningProfile[]; + export type SigningStatus = "InProgress"|"Failed"|"Succeeded"|string; + export interface Source { + /** + * The S3Source object. + */ + s3?: S3Source; + } + export interface StartSigningJobRequest { + /** + * The S3 bucket that contains the object to sign or a BLOB that contains your raw code. + */ + source: Source; + /** + * The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix. + */ + destination: Destination; + /** + * The name of the signing profile. + */ + profileName?: ProfileName; + /** + * String that identifies the signing request. All calls after the first that use this token return the same response as the first call. + */ + clientRequestToken: ClientRequestToken; + } + export interface StartSigningJobResponse { + /** + * The ID of your signing job. + */ + jobId?: JobId; + } + export type StatusReason = string; + export type String = string; + export type Version = string; + export type bool = boolean; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-08-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Signer client. + */ + export import Types = Signer; +} +export = Signer; diff --git a/node_modules/aws-sdk/clients/signer.js b/node_modules/aws-sdk/clients/signer.js new file mode 100644 index 0000000..70e483a --- /dev/null +++ b/node_modules/aws-sdk/clients/signer.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['signer'] = {}; +AWS.Signer = Service.defineService('signer', ['2017-08-25']); +Object.defineProperty(apiLoader.services['signer'], '2017-08-25', { + get: function get() { + var model = require('../apis/signer-2017-08-25.min.json'); + model.paginators = require('../apis/signer-2017-08-25.paginators.json').pagination; + model.waiters = require('../apis/signer-2017-08-25.waiters2.json').waiters; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Signer; diff --git a/node_modules/aws-sdk/clients/simpledb.d.ts b/node_modules/aws-sdk/clients/simpledb.d.ts new file mode 100644 index 0000000..1ac2709 --- /dev/null +++ b/node_modules/aws-sdk/clients/simpledb.d.ts @@ -0,0 +1,380 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SimpleDB extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SimpleDB.Types.ClientConfiguration) + config: Config & SimpleDB.Types.ClientConfiguration; + /** + * Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput. If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted. BatchDeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute doesn't result in an error. The BatchDeleteAttributes operation succeeds or fails in its entirety. There are no partial deletes. You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses. This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. The following limitations are enforced for this operation: 1 MB request size 25 item limit per BatchDeleteAttributes operation + */ + batchDeleteAttributes(params: SimpleDB.Types.BatchDeleteAttributesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput. If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted. BatchDeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute doesn't result in an error. The BatchDeleteAttributes operation succeeds or fails in its entirety. There are no partial deletes. You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses. This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. The following limitations are enforced for this operation: 1 MB request size 25 item limit per BatchDeleteAttributes operation + */ + batchDeleteAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput. The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on. Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", "second_value" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same. Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value. You cannot specify an empty string as an item or as an attribute name. The BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts. This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses. The following limitations are enforced for this operation: 256 attribute name-value pairs per item 1 MB request size 1 billion attributes per domain 10 GB of total user data storage per domain 25 item limit per BatchPutAttributes operation + */ + batchPutAttributes(params: SimpleDB.Types.BatchPutAttributesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput. The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on. Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", "second_value" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same. Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value. You cannot specify an empty string as an item or as an attribute name. The BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts. This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses. The following limitations are enforced for this operation: 256 attribute name-value pairs per item 1 MB request size 1 billion attributes per domain 10 GB of total user data storage per domain 25 item limit per BatchPutAttributes operation + */ + batchPutAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete. CreateDomain is an idempotent operation; running it multiple times using the same domain name will not result in an error response. The client can create up to 100 domains per account. If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/. + */ + createDomain(params: SimpleDB.Types.CreateDomainRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete. CreateDomain is an idempotent operation; running it multiple times using the same domain name will not result in an error response. The client can create up to 100 domains per account. If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/. + */ + createDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted. If DeleteAttributes is called without being passed any attributes or values specified, all the attributes for the item are deleted. DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data. + */ + deleteAttributes(params: SimpleDB.Types.DeleteAttributesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted. If DeleteAttributes is called without being passed any attributes or values specified, all the attributes for the item are deleted. DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data. + */ + deleteAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete. Running DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response. + */ + deleteDomain(params: SimpleDB.Types.DeleteDomainRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete. Running DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response. + */ + deleteDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values. + */ + domainMetadata(params: SimpleDB.Types.DomainMetadataRequest, callback?: (err: AWSError, data: SimpleDB.Types.DomainMetadataResult) => void): Request; + /** + * Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values. + */ + domainMetadata(callback?: (err: AWSError, data: SimpleDB.Types.DomainMetadataResult) => void): Request; + /** + * Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter. If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas. If GetAttributes is called without being passed any attribute names, all the attributes for the item are returned. + */ + getAttributes(params: SimpleDB.Types.GetAttributesRequest, callback?: (err: AWSError, data: SimpleDB.Types.GetAttributesResult) => void): Request; + /** + * Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter. If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas. If GetAttributes is called without being passed any attribute names, all the attributes for the item are returned. + */ + getAttributes(callback?: (err: AWSError, data: SimpleDB.Types.GetAttributesResult) => void): Request; + /** + * The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call. + */ + listDomains(params: SimpleDB.Types.ListDomainsRequest, callback?: (err: AWSError, data: SimpleDB.Types.ListDomainsResult) => void): Request; + /** + * The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call. + */ + listDomains(callback?: (err: AWSError, data: SimpleDB.Types.ListDomainsResult) => void): Request; + /** + * The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on. Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", second_value" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same. Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value. Using PutAttributes to replace attribute values that do not exist will not result in an error response. You cannot specify an empty string as an attribute name. Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data. The following limitations are enforced for this operation: 256 total attribute name-value pairs per item One billion attributes per domain 10 GB of total user data storage per domain + */ + putAttributes(params: SimpleDB.Types.PutAttributesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on. Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", second_value" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same. Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value. Using PutAttributes to replace attribute values that do not exist will not result in an error response. You cannot specify an empty string as an attribute name. Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data. The following limitations are enforced for this operation: 256 total attribute name-value pairs per item One billion attributes per domain 10 GB of total user data storage per domain + */ + putAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement. The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results. For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide. + */ + select(params: SimpleDB.Types.SelectRequest, callback?: (err: AWSError, data: SimpleDB.Types.SelectResult) => void): Request; + /** + * The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement. The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results. For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide. + */ + select(callback?: (err: AWSError, data: SimpleDB.Types.SelectResult) => void): Request; +} +declare namespace SimpleDB { + export interface Attribute { + /** + * The name of the attribute. + */ + Name: String; + /** + * + */ + AlternateNameEncoding?: String; + /** + * The value of the attribute. + */ + Value: String; + /** + * + */ + AlternateValueEncoding?: String; + } + export type AttributeList = Attribute[]; + export type AttributeNameList = String[]; + export interface BatchDeleteAttributesRequest { + /** + * The name of the domain in which the attributes are being deleted. + */ + DomainName: String; + /** + * A list of items on which to perform the operation. + */ + Items: DeletableItemList; + } + export interface BatchPutAttributesRequest { + /** + * The name of the domain in which the attributes are being stored. + */ + DomainName: String; + /** + * A list of items on which to perform the operation. + */ + Items: ReplaceableItemList; + } + export type Boolean = boolean; + export interface CreateDomainRequest { + /** + * The name of the domain to create. The name can range between 3 and 255 characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'. + */ + DomainName: String; + } + export interface DeletableAttribute { + /** + * The name of the attribute. + */ + Name: String; + /** + * The value of the attribute. + */ + Value?: String; + } + export type DeletableAttributeList = DeletableAttribute[]; + export interface DeletableItem { + Name: String; + Attributes?: DeletableAttributeList; + } + export type DeletableItemList = DeletableItem[]; + export interface DeleteAttributesRequest { + /** + * The name of the domain in which to perform the operation. + */ + DomainName: String; + /** + * The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs. + */ + ItemName: String; + /** + * A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items. + */ + Attributes?: DeletableAttributeList; + /** + * The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted. + */ + Expected?: UpdateCondition; + } + export interface DeleteDomainRequest { + /** + * The name of the domain to delete. + */ + DomainName: String; + } + export interface DomainMetadataRequest { + /** + * The name of the domain for which to display the metadata of. + */ + DomainName: String; + } + export interface DomainMetadataResult { + /** + * The number of all items in the domain. + */ + ItemCount?: Integer; + /** + * The total size of all item names in the domain, in bytes. + */ + ItemNamesSizeBytes?: Long; + /** + * The number of unique attribute names in the domain. + */ + AttributeNameCount?: Integer; + /** + * The total size of all unique attribute names in the domain, in bytes. + */ + AttributeNamesSizeBytes?: Long; + /** + * The number of all attribute name/value pairs in the domain. + */ + AttributeValueCount?: Integer; + /** + * The total size of all attribute values in the domain, in bytes. + */ + AttributeValuesSizeBytes?: Long; + /** + * The data and time when metadata was calculated, in Epoch (UNIX) seconds. + */ + Timestamp?: Integer; + } + export type DomainNameList = String[]; + export interface GetAttributesRequest { + /** + * The name of the domain in which to perform the operation. + */ + DomainName: String; + /** + * The name of the item. + */ + ItemName: String; + /** + * The names of the attributes. + */ + AttributeNames?: AttributeNameList; + /** + * Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read. + */ + ConsistentRead?: Boolean; + } + export interface GetAttributesResult { + /** + * The list of attributes returned by the operation. + */ + Attributes?: AttributeList; + } + export type Integer = number; + export interface Item { + /** + * The name of the item. + */ + Name: String; + /** + * + */ + AlternateNameEncoding?: String; + /** + * A list of attributes. + */ + Attributes: AttributeList; + } + export type ItemList = Item[]; + export interface ListDomainsRequest { + /** + * The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100. + */ + MaxNumberOfDomains?: Integer; + /** + * A string informing Amazon SimpleDB where to start the next list of domain names. + */ + NextToken?: String; + } + export interface ListDomainsResult { + /** + * A list of domain names that match the expression. + */ + DomainNames?: DomainNameList; + /** + * An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available. + */ + NextToken?: String; + } + export type Long = number; + export interface PutAttributesRequest { + /** + * The name of the domain in which to perform the operation. + */ + DomainName: String; + /** + * The name of the item. + */ + ItemName: String; + /** + * The list of attributes. + */ + Attributes: ReplaceableAttributeList; + /** + * The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated. + */ + Expected?: UpdateCondition; + } + export interface ReplaceableAttribute { + /** + * The name of the replaceable attribute. + */ + Name: String; + /** + * The value of the replaceable attribute. + */ + Value: String; + /** + * A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is false. + */ + Replace?: Boolean; + } + export type ReplaceableAttributeList = ReplaceableAttribute[]; + export interface ReplaceableItem { + /** + * The name of the replaceable item. + */ + Name: String; + /** + * The list of attributes for a replaceable item. + */ + Attributes: ReplaceableAttributeList; + } + export type ReplaceableItemList = ReplaceableItem[]; + export interface SelectRequest { + /** + * The expression used to query the domain. + */ + SelectExpression: String; + /** + * A string informing Amazon SimpleDB where to start the next list of ItemNames. + */ + NextToken?: String; + /** + * Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read. + */ + ConsistentRead?: Boolean; + } + export interface SelectResult { + /** + * A list of items that match the select expression. + */ + Items?: ItemList; + /** + * An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds. + */ + NextToken?: String; + } + export type String = string; + export interface UpdateCondition { + /** + * The name of the attribute involved in the condition. + */ + Name?: String; + /** + * The value of an attribute. This value can only be specified when the Exists parameter is equal to true. + */ + Value?: String; + /** + * A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied. + */ + Exists?: Boolean; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2009-04-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SimpleDB client. + */ + export import Types = SimpleDB; +} +export = SimpleDB; diff --git a/node_modules/aws-sdk/clients/simpledb.js b/node_modules/aws-sdk/clients/simpledb.js new file mode 100644 index 0000000..2baa3a4 --- /dev/null +++ b/node_modules/aws-sdk/clients/simpledb.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['simpledb'] = {}; +AWS.SimpleDB = Service.defineService('simpledb', ['2009-04-15']); +Object.defineProperty(apiLoader.services['simpledb'], '2009-04-15', { + get: function get() { + var model = require('../apis/sdb-2009-04-15.min.json'); + model.paginators = require('../apis/sdb-2009-04-15.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SimpleDB; diff --git a/node_modules/aws-sdk/clients/sms.d.ts b/node_modules/aws-sdk/clients/sms.d.ts new file mode 100644 index 0000000..3e1d2fb --- /dev/null +++ b/node_modules/aws-sdk/clients/sms.d.ts @@ -0,0 +1,1298 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SMS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SMS.Types.ClientConfiguration) + config: Config & SMS.Types.ClientConfiguration; + /** + * Creates an application. An application consists of one or more server groups. Each server group contain one or more servers. + */ + createApp(params: SMS.Types.CreateAppRequest, callback?: (err: AWSError, data: SMS.Types.CreateAppResponse) => void): Request; + /** + * Creates an application. An application consists of one or more server groups. Each server group contain one or more servers. + */ + createApp(callback?: (err: AWSError, data: SMS.Types.CreateAppResponse) => void): Request; + /** + * Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI). + */ + createReplicationJob(params: SMS.Types.CreateReplicationJobRequest, callback?: (err: AWSError, data: SMS.Types.CreateReplicationJobResponse) => void): Request; + /** + * Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI). + */ + createReplicationJob(callback?: (err: AWSError, data: SMS.Types.CreateReplicationJobResponse) => void): Request; + /** + * Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application. + */ + deleteApp(params: SMS.Types.DeleteAppRequest, callback?: (err: AWSError, data: SMS.Types.DeleteAppResponse) => void): Request; + /** + * Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application. + */ + deleteApp(callback?: (err: AWSError, data: SMS.Types.DeleteAppResponse) => void): Request; + /** + * Deletes existing launch configuration for an application. + */ + deleteAppLaunchConfiguration(params: SMS.Types.DeleteAppLaunchConfigurationRequest, callback?: (err: AWSError, data: SMS.Types.DeleteAppLaunchConfigurationResponse) => void): Request; + /** + * Deletes existing launch configuration for an application. + */ + deleteAppLaunchConfiguration(callback?: (err: AWSError, data: SMS.Types.DeleteAppLaunchConfigurationResponse) => void): Request; + /** + * Deletes existing replication configuration for an application. + */ + deleteAppReplicationConfiguration(params: SMS.Types.DeleteAppReplicationConfigurationRequest, callback?: (err: AWSError, data: SMS.Types.DeleteAppReplicationConfigurationResponse) => void): Request; + /** + * Deletes existing replication configuration for an application. + */ + deleteAppReplicationConfiguration(callback?: (err: AWSError, data: SMS.Types.DeleteAppReplicationConfigurationResponse) => void): Request; + /** + * Deletes the specified replication job. After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted. + */ + deleteReplicationJob(params: SMS.Types.DeleteReplicationJobRequest, callback?: (err: AWSError, data: SMS.Types.DeleteReplicationJobResponse) => void): Request; + /** + * Deletes the specified replication job. After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted. + */ + deleteReplicationJob(callback?: (err: AWSError, data: SMS.Types.DeleteReplicationJobResponse) => void): Request; + /** + * Deletes all servers from your server catalog. + */ + deleteServerCatalog(params: SMS.Types.DeleteServerCatalogRequest, callback?: (err: AWSError, data: SMS.Types.DeleteServerCatalogResponse) => void): Request; + /** + * Deletes all servers from your server catalog. + */ + deleteServerCatalog(callback?: (err: AWSError, data: SMS.Types.DeleteServerCatalogResponse) => void): Request; + /** + * Disassociates the specified connector from AWS SMS. After you disassociate a connector, it is no longer available to support replication jobs. + */ + disassociateConnector(params: SMS.Types.DisassociateConnectorRequest, callback?: (err: AWSError, data: SMS.Types.DisassociateConnectorResponse) => void): Request; + /** + * Disassociates the specified connector from AWS SMS. After you disassociate a connector, it is no longer available to support replication jobs. + */ + disassociateConnector(callback?: (err: AWSError, data: SMS.Types.DisassociateConnectorResponse) => void): Request; + /** + * Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. + */ + generateChangeSet(params: SMS.Types.GenerateChangeSetRequest, callback?: (err: AWSError, data: SMS.Types.GenerateChangeSetResponse) => void): Request; + /** + * Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. + */ + generateChangeSet(callback?: (err: AWSError, data: SMS.Types.GenerateChangeSetResponse) => void): Request; + /** + * Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. + */ + generateTemplate(params: SMS.Types.GenerateTemplateRequest, callback?: (err: AWSError, data: SMS.Types.GenerateTemplateResponse) => void): Request; + /** + * Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. + */ + generateTemplate(callback?: (err: AWSError, data: SMS.Types.GenerateTemplateResponse) => void): Request; + /** + * Retrieve information about an application. + */ + getApp(params: SMS.Types.GetAppRequest, callback?: (err: AWSError, data: SMS.Types.GetAppResponse) => void): Request; + /** + * Retrieve information about an application. + */ + getApp(callback?: (err: AWSError, data: SMS.Types.GetAppResponse) => void): Request; + /** + * Retrieves the application launch configuration associated with an application. + */ + getAppLaunchConfiguration(params: SMS.Types.GetAppLaunchConfigurationRequest, callback?: (err: AWSError, data: SMS.Types.GetAppLaunchConfigurationResponse) => void): Request; + /** + * Retrieves the application launch configuration associated with an application. + */ + getAppLaunchConfiguration(callback?: (err: AWSError, data: SMS.Types.GetAppLaunchConfigurationResponse) => void): Request; + /** + * Retrieves an application replication configuration associatd with an application. + */ + getAppReplicationConfiguration(params: SMS.Types.GetAppReplicationConfigurationRequest, callback?: (err: AWSError, data: SMS.Types.GetAppReplicationConfigurationResponse) => void): Request; + /** + * Retrieves an application replication configuration associatd with an application. + */ + getAppReplicationConfiguration(callback?: (err: AWSError, data: SMS.Types.GetAppReplicationConfigurationResponse) => void): Request; + /** + * Describes the connectors registered with the AWS SMS. + */ + getConnectors(params: SMS.Types.GetConnectorsRequest, callback?: (err: AWSError, data: SMS.Types.GetConnectorsResponse) => void): Request; + /** + * Describes the connectors registered with the AWS SMS. + */ + getConnectors(callback?: (err: AWSError, data: SMS.Types.GetConnectorsResponse) => void): Request; + /** + * Describes the specified replication job or all of your replication jobs. + */ + getReplicationJobs(params: SMS.Types.GetReplicationJobsRequest, callback?: (err: AWSError, data: SMS.Types.GetReplicationJobsResponse) => void): Request; + /** + * Describes the specified replication job or all of your replication jobs. + */ + getReplicationJobs(callback?: (err: AWSError, data: SMS.Types.GetReplicationJobsResponse) => void): Request; + /** + * Describes the replication runs for the specified replication job. + */ + getReplicationRuns(params: SMS.Types.GetReplicationRunsRequest, callback?: (err: AWSError, data: SMS.Types.GetReplicationRunsResponse) => void): Request; + /** + * Describes the replication runs for the specified replication job. + */ + getReplicationRuns(callback?: (err: AWSError, data: SMS.Types.GetReplicationRunsResponse) => void): Request; + /** + * Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog. + */ + getServers(params: SMS.Types.GetServersRequest, callback?: (err: AWSError, data: SMS.Types.GetServersResponse) => void): Request; + /** + * Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog. + */ + getServers(callback?: (err: AWSError, data: SMS.Types.GetServersResponse) => void): Request; + /** + * Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import. This call returns immediately, but might take additional time to retrieve all the servers. + */ + importServerCatalog(params: SMS.Types.ImportServerCatalogRequest, callback?: (err: AWSError, data: SMS.Types.ImportServerCatalogResponse) => void): Request; + /** + * Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import. This call returns immediately, but might take additional time to retrieve all the servers. + */ + importServerCatalog(callback?: (err: AWSError, data: SMS.Types.ImportServerCatalogResponse) => void): Request; + /** + * Launches an application stack. + */ + launchApp(params: SMS.Types.LaunchAppRequest, callback?: (err: AWSError, data: SMS.Types.LaunchAppResponse) => void): Request; + /** + * Launches an application stack. + */ + launchApp(callback?: (err: AWSError, data: SMS.Types.LaunchAppResponse) => void): Request; + /** + * Returns a list of summaries for all applications. + */ + listApps(params: SMS.Types.ListAppsRequest, callback?: (err: AWSError, data: SMS.Types.ListAppsResponse) => void): Request; + /** + * Returns a list of summaries for all applications. + */ + listApps(callback?: (err: AWSError, data: SMS.Types.ListAppsResponse) => void): Request; + /** + * Creates a launch configuration for an application. + */ + putAppLaunchConfiguration(params: SMS.Types.PutAppLaunchConfigurationRequest, callback?: (err: AWSError, data: SMS.Types.PutAppLaunchConfigurationResponse) => void): Request; + /** + * Creates a launch configuration for an application. + */ + putAppLaunchConfiguration(callback?: (err: AWSError, data: SMS.Types.PutAppLaunchConfigurationResponse) => void): Request; + /** + * Creates or updates a replication configuration for an application. + */ + putAppReplicationConfiguration(params: SMS.Types.PutAppReplicationConfigurationRequest, callback?: (err: AWSError, data: SMS.Types.PutAppReplicationConfigurationResponse) => void): Request; + /** + * Creates or updates a replication configuration for an application. + */ + putAppReplicationConfiguration(callback?: (err: AWSError, data: SMS.Types.PutAppReplicationConfigurationResponse) => void): Request; + /** + * Starts replicating an application. + */ + startAppReplication(params: SMS.Types.StartAppReplicationRequest, callback?: (err: AWSError, data: SMS.Types.StartAppReplicationResponse) => void): Request; + /** + * Starts replicating an application. + */ + startAppReplication(callback?: (err: AWSError, data: SMS.Types.StartAppReplicationResponse) => void): Request; + /** + * Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled. There is a limit on the number of on-demand replications runs you can request in a 24-hour period. + */ + startOnDemandReplicationRun(params: SMS.Types.StartOnDemandReplicationRunRequest, callback?: (err: AWSError, data: SMS.Types.StartOnDemandReplicationRunResponse) => void): Request; + /** + * Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled. There is a limit on the number of on-demand replications runs you can request in a 24-hour period. + */ + startOnDemandReplicationRun(callback?: (err: AWSError, data: SMS.Types.StartOnDemandReplicationRunResponse) => void): Request; + /** + * Stops replicating an application. + */ + stopAppReplication(params: SMS.Types.StopAppReplicationRequest, callback?: (err: AWSError, data: SMS.Types.StopAppReplicationResponse) => void): Request; + /** + * Stops replicating an application. + */ + stopAppReplication(callback?: (err: AWSError, data: SMS.Types.StopAppReplicationResponse) => void): Request; + /** + * Terminates the stack for an application. + */ + terminateApp(params: SMS.Types.TerminateAppRequest, callback?: (err: AWSError, data: SMS.Types.TerminateAppResponse) => void): Request; + /** + * Terminates the stack for an application. + */ + terminateApp(callback?: (err: AWSError, data: SMS.Types.TerminateAppResponse) => void): Request; + /** + * Updates an application. + */ + updateApp(params: SMS.Types.UpdateAppRequest, callback?: (err: AWSError, data: SMS.Types.UpdateAppResponse) => void): Request; + /** + * Updates an application. + */ + updateApp(callback?: (err: AWSError, data: SMS.Types.UpdateAppResponse) => void): Request; + /** + * Updates the specified settings for the specified replication job. + */ + updateReplicationJob(params: SMS.Types.UpdateReplicationJobRequest, callback?: (err: AWSError, data: SMS.Types.UpdateReplicationJobResponse) => void): Request; + /** + * Updates the specified settings for the specified replication job. + */ + updateReplicationJob(callback?: (err: AWSError, data: SMS.Types.UpdateReplicationJobResponse) => void): Request; +} +declare namespace SMS { + export type AmiId = string; + export type AppDescription = string; + export type AppId = string; + export type AppIds = AppId[]; + export type AppLaunchStatus = "READY_FOR_CONFIGURATION"|"CONFIGURATION_IN_PROGRESS"|"CONFIGURATION_INVALID"|"READY_FOR_LAUNCH"|"VALIDATION_IN_PROGRESS"|"LAUNCH_PENDING"|"LAUNCH_IN_PROGRESS"|"LAUNCHED"|"DELTA_LAUNCH_IN_PROGRESS"|"DELTA_LAUNCH_FAILED"|"LAUNCH_FAILED"|"TERMINATE_IN_PROGRESS"|"TERMINATE_FAILED"|"TERMINATED"|string; + export type AppLaunchStatusMessage = string; + export type AppName = string; + export type AppReplicationStatus = "READY_FOR_CONFIGURATION"|"CONFIGURATION_IN_PROGRESS"|"CONFIGURATION_INVALID"|"READY_FOR_REPLICATION"|"VALIDATION_IN_PROGRESS"|"REPLICATION_PENDING"|"REPLICATION_IN_PROGRESS"|"REPLICATED"|"DELTA_REPLICATION_IN_PROGRESS"|"DELTA_REPLICATED"|"DELTA_REPLICATION_FAILED"|"REPLICATION_FAILED"|"REPLICATION_STOPPING"|"REPLICATION_STOP_FAILED"|"REPLICATION_STOPPED"|string; + export type AppReplicationStatusMessage = string; + export type AppStatus = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"DELETED"|"DELETE_FAILED"|string; + export type AppStatusMessage = string; + export interface AppSummary { + /** + * Unique ID of the application. + */ + appId?: AppId; + /** + * Name of the application. + */ + name?: AppName; + /** + * Description of the application. + */ + description?: AppDescription; + /** + * Status of the application. + */ + status?: AppStatus; + /** + * A message related to the status of the application + */ + statusMessage?: AppStatusMessage; + /** + * Replication status of the application. + */ + replicationStatus?: AppReplicationStatus; + /** + * A message related to the replication status of the application. + */ + replicationStatusMessage?: AppReplicationStatusMessage; + /** + * Timestamp of the application's most recent successful replication. + */ + latestReplicationTime?: Timestamp; + /** + * Launch status of the application. + */ + launchStatus?: AppLaunchStatus; + /** + * A message related to the launch status of the application. + */ + launchStatusMessage?: AppLaunchStatusMessage; + /** + * Details about the latest launch of the application. + */ + launchDetails?: LaunchDetails; + /** + * Time of creation of this application. + */ + creationTime?: Timestamp; + /** + * Timestamp of the application's creation. + */ + lastModified?: Timestamp; + /** + * Name of the service role in the customer's account used by AWS SMS. + */ + roleName?: RoleName; + /** + * Number of server groups present in the application. + */ + totalServerGroups?: TotalServerGroups; + /** + * Number of servers present in the application. + */ + totalServers?: TotalServers; + } + export type Apps = AppSummary[]; + export type AssociatePublicIpAddress = boolean; + export type BucketName = string; + export type ClientToken = string; + export interface Connector { + /** + * The identifier of the connector. + */ + connectorId?: ConnectorId; + /** + * The connector version. + */ + version?: ConnectorVersion; + /** + * The status of the connector. + */ + status?: ConnectorStatus; + /** + * The capabilities of the connector. + */ + capabilityList?: ConnectorCapabilityList; + /** + * The name of the VM manager. + */ + vmManagerName?: VmManagerName; + /** + * The VM management product. + */ + vmManagerType?: VmManagerType; + /** + * The identifier of the VM manager. + */ + vmManagerId?: VmManagerId; + /** + * The IP address of the connector. + */ + ipAddress?: IpAddress; + /** + * The MAC address of the connector. + */ + macAddress?: MacAddress; + /** + * The time the connector was associated. + */ + associatedOn?: Timestamp; + } + export type ConnectorCapability = "VSPHERE"|"SCVMM"|"HYPERV-MANAGER"|"SNAPSHOT_BATCHING"|string; + export type ConnectorCapabilityList = ConnectorCapability[]; + export type ConnectorId = string; + export type ConnectorList = Connector[]; + export type ConnectorStatus = "HEALTHY"|"UNHEALTHY"|string; + export type ConnectorVersion = string; + export interface CreateAppRequest { + /** + * Name of the new application. + */ + name?: AppName; + /** + * Description of the new application + */ + description?: AppDescription; + /** + * Name of service role in customer's account to be used by AWS SMS. + */ + roleName?: RoleName; + /** + * A unique, case-sensitive identifier you provide to ensure idempotency of application creation. + */ + clientToken?: ClientToken; + /** + * List of server groups to include in the application. + */ + serverGroups?: ServerGroups; + /** + * List of tags to be associated with the application. + */ + tags?: Tags; + } + export interface CreateAppResponse { + /** + * Summary description of the application. + */ + appSummary?: AppSummary; + /** + * List of server groups included in the application. + */ + serverGroups?: ServerGroups; + /** + * List of taags associated with the application. + */ + tags?: Tags; + } + export interface CreateReplicationJobRequest { + /** + * The identifier of the server. + */ + serverId: ServerId; + /** + * The seed replication time. + */ + seedReplicationTime: Timestamp; + /** + * The time between consecutive replication runs, in hours. + */ + frequency?: Frequency; + /** + * + */ + runOnce?: RunOnce; + /** + * The license type to be used for the AMI created by a successful replication run. + */ + licenseType?: LicenseType; + /** + * The name of the IAM role to be used by the AWS SMS. + */ + roleName?: RoleName; + /** + * The description of the replication job. + */ + description?: Description; + /** + * The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created. + */ + numberOfRecentAmisToKeep?: NumberOfRecentAmisToKeep; + /** + * When true, the replication job produces encrypted AMIs. See also KmsKeyId below. + */ + encrypted?: Encrypted; + /** + * KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: KMS key ID KMS key alias ARN referring to KMS key ID ARN referring to KMS key alias If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used. + */ + kmsKeyId?: KmsKeyId; + } + export interface CreateReplicationJobResponse { + /** + * The unique identifier of the replication job. + */ + replicationJobId?: ReplicationJobId; + } + export interface DeleteAppLaunchConfigurationRequest { + /** + * ID of the application associated with the launch configuration. + */ + appId?: AppId; + } + export interface DeleteAppLaunchConfigurationResponse { + } + export interface DeleteAppReplicationConfigurationRequest { + /** + * ID of the application associated with the replication configuration. + */ + appId?: AppId; + } + export interface DeleteAppReplicationConfigurationResponse { + } + export interface DeleteAppRequest { + /** + * ID of the application to delete. + */ + appId?: AppId; + /** + * While deleting the application, stop all replication jobs corresponding to the servers in the application. + */ + forceStopAppReplication?: ForceStopAppReplication; + /** + * While deleting the application, terminate the stack corresponding to the application. + */ + forceTerminateApp?: ForceTerminateApp; + } + export interface DeleteAppResponse { + } + export interface DeleteReplicationJobRequest { + /** + * The identifier of the replication job. + */ + replicationJobId: ReplicationJobId; + } + export interface DeleteReplicationJobResponse { + } + export interface DeleteServerCatalogRequest { + } + export interface DeleteServerCatalogResponse { + } + export type Description = string; + export interface DisassociateConnectorRequest { + /** + * The identifier of the connector. + */ + connectorId: ConnectorId; + } + export interface DisassociateConnectorResponse { + } + export type EC2KeyName = string; + export type Encrypted = boolean; + export type ForceStopAppReplication = boolean; + export type ForceTerminateApp = boolean; + export type Frequency = number; + export interface GenerateChangeSetRequest { + /** + * ID of the application associated with the change set. + */ + appId?: AppId; + /** + * Format for the change set. + */ + changesetFormat?: OutputFormat; + } + export interface GenerateChangeSetResponse { + /** + * Location of the Amazon S3 object. + */ + s3Location?: S3Location; + } + export interface GenerateTemplateRequest { + /** + * ID of the application associated with the Amazon CloudFormation template. + */ + appId?: AppId; + /** + * Format for generating the Amazon CloudFormation template. + */ + templateFormat?: OutputFormat; + } + export interface GenerateTemplateResponse { + /** + * Location of the Amazon S3 object. + */ + s3Location?: S3Location; + } + export interface GetAppLaunchConfigurationRequest { + /** + * ID of the application launch configuration. + */ + appId?: AppId; + } + export interface GetAppLaunchConfigurationResponse { + /** + * ID of the application associated with the launch configuration. + */ + appId?: AppId; + /** + * Name of the service role in the customer's account that Amazon CloudFormation uses to launch the application. + */ + roleName?: RoleName; + /** + * List of launch configurations for server groups in this application. + */ + serverGroupLaunchConfigurations?: ServerGroupLaunchConfigurations; + } + export interface GetAppReplicationConfigurationRequest { + /** + * ID of the application associated with the replication configuration. + */ + appId?: AppId; + } + export interface GetAppReplicationConfigurationResponse { + /** + * Replication configurations associated with server groups in this application. + */ + serverGroupReplicationConfigurations?: ServerGroupReplicationConfigurations; + } + export interface GetAppRequest { + /** + * ID of the application whose information is being retrieved. + */ + appId?: AppId; + } + export interface GetAppResponse { + /** + * Information about the application. + */ + appSummary?: AppSummary; + /** + * List of server groups belonging to the application. + */ + serverGroups?: ServerGroups; + /** + * List of tags associated with the application. + */ + tags?: Tags; + } + export interface GetConnectorsRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value. + */ + maxResults?: MaxResults; + } + export interface GetConnectorsResponse { + /** + * Information about the registered connectors. + */ + connectorList?: ConnectorList; + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export interface GetReplicationJobsRequest { + /** + * The identifier of the replication job. + */ + replicationJobId?: ReplicationJobId; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value. + */ + maxResults?: MaxResults; + } + export interface GetReplicationJobsResponse { + /** + * Information about the replication jobs. + */ + replicationJobList?: ReplicationJobList; + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export interface GetReplicationRunsRequest { + /** + * The identifier of the replication job. + */ + replicationJobId: ReplicationJobId; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value. + */ + maxResults?: MaxResults; + } + export interface GetReplicationRunsResponse { + /** + * Information about the replication job. + */ + replicationJob?: ReplicationJob; + /** + * Information about the replication runs. + */ + replicationRunList?: ReplicationRunList; + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export interface GetServersRequest { + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value. + */ + maxResults?: MaxResults; + /** + * List of VmServerAddress objects + */ + vmServerAddressList?: VmServerAddressList; + } + export interface GetServersResponse { + /** + * The time when the server was last modified. + */ + lastModifiedOn?: Timestamp; + /** + * The status of the server catalog. + */ + serverCatalogStatus?: ServerCatalogStatus; + /** + * Information about the servers. + */ + serverList?: ServerList; + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export interface ImportServerCatalogRequest { + } + export interface ImportServerCatalogResponse { + } + export type InstanceType = string; + export type IpAddress = string; + export type KeyName = string; + export type KmsKeyId = string; + export interface LaunchAppRequest { + /** + * ID of the application to launch. + */ + appId?: AppId; + } + export interface LaunchAppResponse { + } + export interface LaunchDetails { + /** + * Latest time this application was launched successfully. + */ + latestLaunchTime?: Timestamp; + /** + * Name of the latest stack launched for this application. + */ + stackName?: StackName; + /** + * Identifier of the latest stack launched for this application. + */ + stackId?: StackId; + } + export type LaunchOrder = number; + export type LicenseType = "AWS"|"BYOL"|string; + export interface ListAppsRequest { + /** + * + */ + appIds?: AppIds; + /** + * The token for the next set of results. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value. + */ + maxResults?: MaxResults; + } + export interface ListAppsResponse { + /** + * A list of application summaries. + */ + apps?: Apps; + /** + * The token required to retrieve the next set of results. This value is null when there are no more results to return. + */ + nextToken?: NextToken; + } + export type LogicalId = string; + export type MacAddress = string; + export type MaxResults = number; + export type NextToken = string; + export type NumberOfRecentAmisToKeep = number; + export type OutputFormat = "JSON"|"YAML"|string; + export interface PutAppLaunchConfigurationRequest { + /** + * ID of the application associated with the launch configuration. + */ + appId?: AppId; + /** + * Name of service role in the customer's account that Amazon CloudFormation uses to launch the application. + */ + roleName?: RoleName; + /** + * Launch configurations for server groups in the application. + */ + serverGroupLaunchConfigurations?: ServerGroupLaunchConfigurations; + } + export interface PutAppLaunchConfigurationResponse { + } + export interface PutAppReplicationConfigurationRequest { + /** + * ID of the application tassociated with the replication configuration. + */ + appId?: AppId; + /** + * Replication configurations for server groups in the application. + */ + serverGroupReplicationConfigurations?: ServerGroupReplicationConfigurations; + } + export interface PutAppReplicationConfigurationResponse { + } + export interface ReplicationJob { + /** + * The identifier of the replication job. + */ + replicationJobId?: ReplicationJobId; + /** + * The identifier of the server. + */ + serverId?: ServerId; + /** + * The type of server. + */ + serverType?: ServerType; + /** + * Information about the VM server. + */ + vmServer?: VmServer; + /** + * The seed replication time. + */ + seedReplicationTime?: Timestamp; + /** + * The time between consecutive replication runs, in hours. + */ + frequency?: Frequency; + /** + * + */ + runOnce?: RunOnce; + /** + * The start time of the next replication run. + */ + nextReplicationRunStartTime?: Timestamp; + /** + * The license type to be used for the AMI created by a successful replication run. + */ + licenseType?: LicenseType; + /** + * The name of the IAM role to be used by the Server Migration Service. + */ + roleName?: RoleName; + /** + * The ID of the latest Amazon Machine Image (AMI). + */ + latestAmiId?: AmiId; + /** + * The state of the replication job. + */ + state?: ReplicationJobState; + /** + * The description of the current status of the replication job. + */ + statusMessage?: ReplicationJobStatusMessage; + /** + * The description of the replication job. + */ + description?: Description; + /** + * Number of recent AMIs to keep in the customer's account for a replication job. By default the value is set to zero, meaning that all AMIs are kept. + */ + numberOfRecentAmisToKeep?: NumberOfRecentAmisToKeep; + /** + * Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below. + */ + encrypted?: Encrypted; + /** + * KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: KMS key ID KMS key alias ARN referring to KMS key ID ARN referring to KMS key alias If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used. + */ + kmsKeyId?: KmsKeyId; + /** + * Information about the replication runs. + */ + replicationRunList?: ReplicationRunList; + } + export type ReplicationJobId = string; + export type ReplicationJobList = ReplicationJob[]; + export type ReplicationJobState = "PENDING"|"ACTIVE"|"FAILED"|"DELETING"|"DELETED"|"COMPLETED"|"PAUSED_ON_FAILURE"|"FAILING"|string; + export type ReplicationJobStatusMessage = string; + export type ReplicationJobTerminated = boolean; + export interface ReplicationRun { + /** + * The identifier of the replication run. + */ + replicationRunId?: ReplicationRunId; + /** + * The state of the replication run. + */ + state?: ReplicationRunState; + /** + * The type of replication run. + */ + type?: ReplicationRunType; + /** + * Details of the current stage of the replication run. + */ + stageDetails?: ReplicationRunStageDetails; + /** + * The description of the current status of the replication job. + */ + statusMessage?: ReplicationRunStatusMessage; + /** + * The identifier of the Amazon Machine Image (AMI) from the replication run. + */ + amiId?: AmiId; + /** + * The start time of the next replication run. + */ + scheduledStartTime?: Timestamp; + /** + * The completion time of the last replication run. + */ + completedTime?: Timestamp; + /** + * The description of the replication run. + */ + description?: Description; + /** + * Whether the replication run should produce encrypted AMI or not. See also KmsKeyId below. + */ + encrypted?: Encrypted; + /** + * KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: KMS key ID KMS key alias ARN referring to KMS key ID ARN referring to KMS key alias If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used. + */ + kmsKeyId?: KmsKeyId; + } + export type ReplicationRunId = string; + export type ReplicationRunList = ReplicationRun[]; + export type ReplicationRunStage = string; + export interface ReplicationRunStageDetails { + /** + * String describing the current stage of a replication run. + */ + stage?: ReplicationRunStage; + /** + * String describing the progress of the current stage of a replication run. + */ + stageProgress?: ReplicationRunStageProgress; + } + export type ReplicationRunStageProgress = string; + export type ReplicationRunState = "PENDING"|"MISSED"|"ACTIVE"|"FAILED"|"COMPLETED"|"DELETING"|"DELETED"|string; + export type ReplicationRunStatusMessage = string; + export type ReplicationRunType = "ON_DEMAND"|"AUTOMATIC"|string; + export type RoleName = string; + export type RunOnce = boolean; + export interface S3Location { + /** + * Amazon S3 bucket name. + */ + bucket?: BucketName; + /** + * Amazon S3 bucket key. + */ + key?: KeyName; + } + export type SecurityGroup = string; + export interface Server { + /** + * The identifier of the server. + */ + serverId?: ServerId; + /** + * The type of server. + */ + serverType?: ServerType; + /** + * Information about the VM server. + */ + vmServer?: VmServer; + /** + * The identifier of the replication job. + */ + replicationJobId?: ReplicationJobId; + /** + * Indicates whether the replication job is deleted or failed. + */ + replicationJobTerminated?: ReplicationJobTerminated; + } + export type ServerCatalogStatus = "NOT_IMPORTED"|"IMPORTING"|"AVAILABLE"|"DELETED"|"EXPIRED"|string; + export interface ServerGroup { + /** + * Identifier of a server group. + */ + serverGroupId?: ServerGroupId; + /** + * Name of a server group. + */ + name?: ServerGroupName; + /** + * List of servers belonging to a server group. + */ + serverList?: ServerList; + } + export type ServerGroupId = string; + export interface ServerGroupLaunchConfiguration { + /** + * Identifier of the server group the launch configuration is associated with. + */ + serverGroupId?: ServerGroupId; + /** + * Launch order of servers in the server group. + */ + launchOrder?: LaunchOrder; + /** + * Launch configuration for servers in the server group. + */ + serverLaunchConfigurations?: ServerLaunchConfigurations; + } + export type ServerGroupLaunchConfigurations = ServerGroupLaunchConfiguration[]; + export type ServerGroupName = string; + export interface ServerGroupReplicationConfiguration { + /** + * Identifier of the server group this replication configuration is associated with. + */ + serverGroupId?: ServerGroupId; + /** + * Replication configuration for servers in the server group. + */ + serverReplicationConfigurations?: ServerReplicationConfigurations; + } + export type ServerGroupReplicationConfigurations = ServerGroupReplicationConfiguration[]; + export type ServerGroups = ServerGroup[]; + export type ServerId = string; + export interface ServerLaunchConfiguration { + /** + * Identifier of the server the launch configuration is associated with. + */ + server?: Server; + /** + * Logical ID of the server in the Amazon CloudFormation template. + */ + logicalId?: LogicalId; + /** + * Identifier of the VPC the server should be launched into. + */ + vpc?: VPC; + /** + * Identifier of the subnet the server should be launched into. + */ + subnet?: Subnet; + /** + * Identifier of the security group that applies to the launched server. + */ + securityGroup?: SecurityGroup; + /** + * Name of the EC2 SSH Key to be used for connecting to the launched server. + */ + ec2KeyName?: EC2KeyName; + /** + * Location of the user-data script to be executed when launching the server. + */ + userData?: UserData; + /** + * Instance type to be used for launching the server. + */ + instanceType?: InstanceType; + /** + * If true, a publicly accessible IP address is created when launching the server. + */ + associatePublicIpAddress?: AssociatePublicIpAddress; + } + export type ServerLaunchConfigurations = ServerLaunchConfiguration[]; + export type ServerList = Server[]; + export interface ServerReplicationConfiguration { + /** + * Identifier of the server this replication configuration is associated with. + */ + server?: Server; + /** + * Parameters for replicating the server. + */ + serverReplicationParameters?: ServerReplicationParameters; + } + export type ServerReplicationConfigurations = ServerReplicationConfiguration[]; + export interface ServerReplicationParameters { + /** + * Seed time for creating a replication job for the server. + */ + seedTime?: Timestamp; + /** + * Frequency of creating replication jobs for the server. + */ + frequency?: Frequency; + /** + * + */ + runOnce?: RunOnce; + /** + * License type for creating a replication job for the server. + */ + licenseType?: LicenseType; + /** + * Number of recent AMIs to keep when creating a replication job for this server. + */ + numberOfRecentAmisToKeep?: NumberOfRecentAmisToKeep; + /** + * When true, the replication job produces encrypted AMIs. See also KmsKeyId below. + */ + encrypted?: Encrypted; + /** + * KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: KMS key ID KMS key alias ARN referring to KMS key ID ARN referring to KMS key alias If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used. + */ + kmsKeyId?: KmsKeyId; + } + export type ServerType = "VIRTUAL_MACHINE"|string; + export type StackId = string; + export type StackName = string; + export interface StartAppReplicationRequest { + /** + * ID of the application to replicate. + */ + appId?: AppId; + } + export interface StartAppReplicationResponse { + } + export interface StartOnDemandReplicationRunRequest { + /** + * The identifier of the replication job. + */ + replicationJobId: ReplicationJobId; + /** + * The description of the replication run. + */ + description?: Description; + } + export interface StartOnDemandReplicationRunResponse { + /** + * The identifier of the replication run. + */ + replicationRunId?: ReplicationRunId; + } + export interface StopAppReplicationRequest { + /** + * ID of the application to stop replicating. + */ + appId?: AppId; + } + export interface StopAppReplicationResponse { + } + export type Subnet = string; + export interface Tag { + /** + * Tag key. + */ + key?: TagKey; + /** + * Tag value. + */ + value?: TagValue; + } + export type TagKey = string; + export type TagValue = string; + export type Tags = Tag[]; + export interface TerminateAppRequest { + /** + * ID of the application to terminate. + */ + appId?: AppId; + } + export interface TerminateAppResponse { + } + export type Timestamp = Date; + export type TotalServerGroups = number; + export type TotalServers = number; + export interface UpdateAppRequest { + /** + * ID of the application to update. + */ + appId?: AppId; + /** + * New name of the application. + */ + name?: AppName; + /** + * New description of the application. + */ + description?: AppDescription; + /** + * Name of the service role in the customer's account used by AWS SMS. + */ + roleName?: RoleName; + /** + * List of server groups in the application to update. + */ + serverGroups?: ServerGroups; + /** + * List of tags to associate with the application. + */ + tags?: Tags; + } + export interface UpdateAppResponse { + /** + * Summary description of the application. + */ + appSummary?: AppSummary; + /** + * List of updated server groups in the application. + */ + serverGroups?: ServerGroups; + /** + * List of tags associated with the application. + */ + tags?: Tags; + } + export interface UpdateReplicationJobRequest { + /** + * The identifier of the replication job. + */ + replicationJobId: ReplicationJobId; + /** + * The time between consecutive replication runs, in hours. + */ + frequency?: Frequency; + /** + * The start time of the next replication run. + */ + nextReplicationRunStartTime?: Timestamp; + /** + * The license type to be used for the AMI created by a successful replication run. + */ + licenseType?: LicenseType; + /** + * The name of the IAM role to be used by AWS SMS. + */ + roleName?: RoleName; + /** + * The description of the replication job. + */ + description?: Description; + /** + * The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created. + */ + numberOfRecentAmisToKeep?: NumberOfRecentAmisToKeep; + /** + * When true, the replication job produces encrypted AMIs . See also KmsKeyId below. + */ + encrypted?: Encrypted; + /** + * KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: KMS key ID KMS key alias ARN referring to KMS key ID ARN referring to KMS key alias If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used. + */ + kmsKeyId?: KmsKeyId; + } + export interface UpdateReplicationJobResponse { + } + export interface UserData { + /** + * Amazon S3 location of the user-data script. + */ + s3Location?: S3Location; + } + export type VPC = string; + export type VmId = string; + export type VmManagerId = string; + export type VmManagerName = string; + export type VmManagerType = "VSPHERE"|"SCVMM"|"HYPERV-MANAGER"|string; + export type VmName = string; + export type VmPath = string; + export interface VmServer { + /** + * Information about the VM server location. + */ + vmServerAddress?: VmServerAddress; + /** + * The name of the VM. + */ + vmName?: VmName; + /** + * The name of the VM manager. + */ + vmManagerName?: VmManagerName; + /** + * The type of VM management product. + */ + vmManagerType?: VmManagerType; + /** + * The VM folder path in the vCenter Server virtual machine inventory tree. + */ + vmPath?: VmPath; + } + export interface VmServerAddress { + /** + * The identifier of the VM manager. + */ + vmManagerId?: VmManagerId; + /** + * The identifier of the VM. + */ + vmId?: VmId; + } + export type VmServerAddressList = VmServerAddress[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-10-24"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SMS client. + */ + export import Types = SMS; +} +export = SMS; diff --git a/node_modules/aws-sdk/clients/sms.js b/node_modules/aws-sdk/clients/sms.js new file mode 100644 index 0000000..9dc4ba9 --- /dev/null +++ b/node_modules/aws-sdk/clients/sms.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['sms'] = {}; +AWS.SMS = Service.defineService('sms', ['2016-10-24']); +Object.defineProperty(apiLoader.services['sms'], '2016-10-24', { + get: function get() { + var model = require('../apis/sms-2016-10-24.min.json'); + model.paginators = require('../apis/sms-2016-10-24.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SMS; diff --git a/node_modules/aws-sdk/clients/snowball.d.ts b/node_modules/aws-sdk/clients/snowball.d.ts new file mode 100644 index 0000000..056d0d8 --- /dev/null +++ b/node_modules/aws-sdk/clients/snowball.d.ts @@ -0,0 +1,964 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Snowball extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Snowball.Types.ClientConfiguration) + config: Config & Snowball.Types.ClientConfiguration; + /** + * Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it. + */ + cancelCluster(params: Snowball.Types.CancelClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request; + /** + * Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it. + */ + cancelCluster(callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request; + /** + * Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned. + */ + cancelJob(params: Snowball.Types.CancelJobRequest, callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request; + /** + * Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned. + */ + cancelJob(callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request; + /** + * Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. + */ + createAddress(params: Snowball.Types.CreateAddressRequest, callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request; + /** + * Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. + */ + createAddress(callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request; + /** + * Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. + */ + createCluster(params: Snowball.Types.CreateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request; + /** + * Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. + */ + createCluster(callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request; + /** + * Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. + */ + createJob(params: Snowball.Types.CreateJobRequest, callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request; + /** + * Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. + */ + createJob(callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request; + /** + * Takes an AddressId and returns specific details about that address in the form of an Address object. + */ + describeAddress(params: Snowball.Types.DescribeAddressRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request; + /** + * Takes an AddressId and returns specific details about that address in the form of an Address object. + */ + describeAddress(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request; + /** + * Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions. + */ + describeAddresses(params: Snowball.Types.DescribeAddressesRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request; + /** + * Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions. + */ + describeAddresses(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request; + /** + * Returns information about a specific cluster including shipping information, cluster status, and other important metadata. + */ + describeCluster(params: Snowball.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request; + /** + * Returns information about a specific cluster including shipping information, cluster status, and other important metadata. + */ + describeCluster(callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request; + /** + * Returns information about a specific job including shipping information, job status, and other important metadata. + */ + describeJob(params: Snowball.Types.DescribeJobRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request; + /** + * Returns information about a specific job including shipping information, job status, and other important metadata. + */ + describeJob(callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request; + /** + * Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created. + */ + getJobManifest(params: Snowball.Types.GetJobManifestRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request; + /** + * Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created. + */ + getJobManifest(callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request; + /** + * Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. + */ + getJobUnlockCode(params: Snowball.Types.GetJobUnlockCodeRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request; + /** + * Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. + */ + getJobUnlockCode(callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request; + /** + * Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. + */ + getSnowballUsage(params: Snowball.Types.GetSnowballUsageRequest, callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request; + /** + * Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. + */ + getSnowballUsage(callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request; + /** + * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information. + */ + listClusterJobs(params: Snowball.Types.ListClusterJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request; + /** + * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information. + */ + listClusterJobs(callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request; + /** + * Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. + */ + listClusters(params: Snowball.Types.ListClustersRequest, callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request; + /** + * Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. + */ + listClusters(callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request; + /** + * This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on EDGE, EDGE_C, and EDGE_CG devices. For more information on compatible AMIs, see Using Amazon EC2 Compute Instances in the AWS Snowball Developer Guide. + */ + listCompatibleImages(params: Snowball.Types.ListCompatibleImagesRequest, callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request; + /** + * This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on EDGE, EDGE_C, and EDGE_CG devices. For more information on compatible AMIs, see Using Amazon EC2 Compute Instances in the AWS Snowball Developer Guide. + */ + listCompatibleImages(callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request; + /** + * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions. + */ + listJobs(params: Snowball.Types.ListJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request; + /** + * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions. + */ + listJobs(callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request; + /** + * While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. + */ + updateCluster(params: Snowball.Types.UpdateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request; + /** + * While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. + */ + updateCluster(callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request; + /** + * While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. + */ + updateJob(params: Snowball.Types.UpdateJobRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request; + /** + * While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. + */ + updateJob(callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request; +} +declare namespace Snowball { + export interface Address { + /** + * The unique ID for an address. + */ + AddressId?: AddressId; + /** + * The name of a person to receive a Snowball at an address. + */ + Name?: String; + /** + * The name of the company to receive a Snowball at an address. + */ + Company?: String; + /** + * The first line in a street address that a Snowball is to be delivered to. + */ + Street1?: String; + /** + * The second line in a street address that a Snowball is to be delivered to. + */ + Street2?: String; + /** + * The third line in a street address that a Snowball is to be delivered to. + */ + Street3?: String; + /** + * The city in an address that a Snowball is to be delivered to. + */ + City?: String; + /** + * The state or province in an address that a Snowball is to be delivered to. + */ + StateOrProvince?: String; + /** + * This field is no longer used and the value is ignored. + */ + PrefectureOrDistrict?: String; + /** + * This field is no longer used and the value is ignored. + */ + Landmark?: String; + /** + * The country in an address that a Snowball is to be delivered to. + */ + Country?: String; + /** + * The postal code in an address that a Snowball is to be delivered to. + */ + PostalCode?: String; + /** + * The phone number associated with an address that a Snowball is to be delivered to. + */ + PhoneNumber?: String; + /** + * If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions. + */ + IsRestricted?: Boolean; + } + export type AddressId = string; + export type AddressList = Address[]; + export type AmiId = string; + export type Boolean = boolean; + export interface CancelClusterRequest { + /** + * The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000. + */ + ClusterId: ClusterId; + } + export interface CancelClusterResult { + } + export interface CancelJobRequest { + /** + * The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId: JobId; + } + export interface CancelJobResult { + } + export type ClusterId = string; + export interface ClusterListEntry { + /** + * The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. + */ + ClusterId?: String; + /** + * The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState. + */ + ClusterState?: ClusterState; + /** + * The creation date for this cluster. + */ + CreationDate?: Timestamp; + /** + * Defines an optional description of the cluster, for example Environmental Data Cluster-01. + */ + Description?: String; + } + export type ClusterListEntryList = ClusterListEntry[]; + export interface ClusterMetadata { + /** + * The automatically generated ID for a cluster. + */ + ClusterId?: String; + /** + * The optional description of the cluster. + */ + Description?: String; + /** + * The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS). + */ + KmsKeyARN?: KmsKeyARN; + /** + * The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM). + */ + RoleARN?: RoleARN; + /** + * The current status of the cluster. + */ + ClusterState?: ClusterState; + /** + * The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE. + */ + JobType?: JobType; + /** + * The type of AWS Snowball device to use for this cluster. The only supported device types for cluster jobs are EDGE, EDGE_C, and EDGE_CG. + */ + SnowballType?: SnowballType; + /** + * The creation date for this cluster. + */ + CreationDate?: Timestamp; + /** + * The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. + */ + Resources?: JobResource; + /** + * The automatically generated ID for a specific address. + */ + AddressId?: AddressId; + /** + * The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, devices are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping. + */ + ShippingOption?: ShippingOption; + /** + * The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster. + */ + Notification?: Notification; + /** + * The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions. + */ + ForwardingAddressId?: AddressId; + } + export type ClusterState = "AwaitingQuorum"|"Pending"|"InUse"|"Complete"|"Cancelled"|string; + export interface CompatibleImage { + /** + * The unique identifier for an individual Snowball Edge AMI. + */ + AmiId?: String; + /** + * The optional name of a compatible image. + */ + Name?: String; + } + export type CompatibleImageList = CompatibleImage[]; + export interface CreateAddressRequest { + /** + * The address that you want the Snowball shipped to. + */ + Address: Address; + } + export interface CreateAddressResult { + /** + * The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snowball for that job shipped to. + */ + AddressId?: String; + } + export interface CreateClusterRequest { + /** + * The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE. + */ + JobType: JobType; + /** + * The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language. + */ + Resources: JobResource; + /** + * An optional description of this specific cluster, for example Environmental Data Cluster-01. + */ + Description?: String; + /** + * The ID for the address that you want the cluster shipped to. + */ + AddressId: AddressId; + /** + * The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS). + */ + KmsKeyARN?: KmsKeyARN; + /** + * The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM). + */ + RoleARN: RoleARN; + /** + * The type of AWS Snowball device to use for this cluster. The only supported device types for cluster jobs are EDGE, EDGE_C, and EDGE_CG. + */ + SnowballType?: SnowballType; + /** + * The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, devices are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping. + */ + ShippingOption: ShippingOption; + /** + * The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster. + */ + Notification?: Notification; + /** + * The forwarding address ID for a cluster. This field is not supported in most regions. + */ + ForwardingAddressId?: AddressId; + } + export interface CreateClusterResult { + /** + * The automatically generated ID for a cluster. + */ + ClusterId?: ClusterId; + } + export interface CreateJobRequest { + /** + * Defines the type of job that you're creating. + */ + JobType?: JobType; + /** + * Defines the Amazon S3 buckets associated with this job. With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into. With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted. + */ + Resources?: JobResource; + /** + * Defines an optional description of this specific job, for example Important Photos 2016-08-11. + */ + Description?: String; + /** + * The ID for the address that you want the Snowball shipped to. + */ + AddressId?: AddressId; + /** + * The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action. + */ + KmsKeyARN?: KmsKeyARN; + /** + * The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action. + */ + RoleARN?: RoleARN; + /** + * If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity. + */ + SnowballCapacityPreference?: SnowballCapacity; + /** + * The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowballs are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping. + */ + ShippingOption?: ShippingOption; + /** + * Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job. + */ + Notification?: Notification; + /** + * The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster. + */ + ClusterId?: ClusterId; + /** + * The type of AWS Snowball device to use for this job. The only supported device types for cluster jobs are EDGE, EDGE_C, and EDGE_CG. + */ + SnowballType?: SnowballType; + /** + * The forwarding address ID for a job. This field is not supported in most regions. + */ + ForwardingAddressId?: AddressId; + } + export interface CreateJobResult { + /** + * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId?: JobId; + } + export interface DataTransfer { + /** + * The number of bytes transferred between a Snowball and Amazon S3. + */ + BytesTransferred?: Long; + /** + * The number of objects transferred between a Snowball and Amazon S3. + */ + ObjectsTransferred?: Long; + /** + * The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. + */ + TotalBytes?: Long; + /** + * The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. + */ + TotalObjects?: Long; + } + export interface DescribeAddressRequest { + /** + * The automatically generated ID for a specific address. + */ + AddressId: AddressId; + } + export interface DescribeAddressResult { + /** + * The address that you want the Snowball or Snowballs associated with a specific job to be shipped to. + */ + Address?: Address; + } + export interface DescribeAddressesRequest { + /** + * The number of ADDRESS objects to return. + */ + MaxResults?: ListLimit; + /** + * HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses. + */ + NextToken?: String; + } + export interface DescribeAddressesResult { + /** + * The Snowball shipping addresses that were created for this account. + */ + Addresses?: AddressList; + /** + * HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array. + */ + NextToken?: String; + } + export interface DescribeClusterRequest { + /** + * The automatically generated ID for a cluster. + */ + ClusterId: ClusterId; + } + export interface DescribeClusterResult { + /** + * Information about a specific cluster, including shipping information, cluster status, and other important metadata. + */ + ClusterMetadata?: ClusterMetadata; + } + export interface DescribeJobRequest { + /** + * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId: JobId; + } + export interface DescribeJobResult { + /** + * Information about a specific job, including shipping information, job status, and other important metadata. + */ + JobMetadata?: JobMetadata; + /** + * Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata. + */ + SubJobMetadata?: JobMetadataList; + } + export interface Ec2AmiResource { + /** + * The ID of the AMI in Amazon EC2. + */ + AmiId: AmiId; + /** + * The ID of the AMI on the supported device. + */ + SnowballAmiId?: String; + } + export type Ec2AmiResourceList = Ec2AmiResource[]; + export interface EventTriggerDefinition { + /** + * The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job. + */ + EventResourceARN?: ResourceARN; + } + export type EventTriggerDefinitionList = EventTriggerDefinition[]; + export interface GetJobManifestRequest { + /** + * The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId: JobId; + } + export interface GetJobManifestResult { + /** + * The Amazon S3 presigned URL for the manifest file associated with the specified JobId value. + */ + ManifestURI?: String; + } + export interface GetJobUnlockCodeRequest { + /** + * The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId: JobId; + } + export interface GetJobUnlockCodeResult { + /** + * The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 90 days after the job has been created. + */ + UnlockCode?: String; + } + export interface GetSnowballUsageRequest { + } + export interface GetSnowballUsageResult { + /** + * The service limit for number of Snowballs this account can have at once. The default service limit is 1 (one). + */ + SnowballLimit?: Integer; + /** + * The number of Snowballs that this account is currently using. + */ + SnowballsInUse?: Integer; + } + export type Integer = number; + export type JobId = string; + export interface JobListEntry { + /** + * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId?: String; + /** + * The current state of this job. + */ + JobState?: JobState; + /** + * A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular master job are listed, because they are created after the master job is created. + */ + IsMaster?: Boolean; + /** + * The type of job. + */ + JobType?: JobType; + /** + * The type of device used with this job. + */ + SnowballType?: SnowballType; + /** + * The creation date for this job. + */ + CreationDate?: Timestamp; + /** + * The optional description of this specific job, for example Important Photos 2016-08-11. + */ + Description?: String; + } + export type JobListEntryList = JobListEntry[]; + export interface JobLogs { + /** + * A link to an Amazon S3 presigned URL where the job completion report is located. + */ + JobCompletionReportURI?: String; + /** + * A link to an Amazon S3 presigned URL where the job success log is located. + */ + JobSuccessLogURI?: String; + /** + * A link to an Amazon S3 presigned URL where the job failure log is located. + */ + JobFailureLogURI?: String; + } + export interface JobMetadata { + /** + * The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId?: String; + /** + * The current status of the jobs. + */ + JobState?: JobState; + /** + * The type of job. + */ + JobType?: JobType; + /** + * The type of device used with this job. + */ + SnowballType?: SnowballType; + /** + * The creation date for this job. + */ + CreationDate?: Timestamp; + /** + * An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. + */ + Resources?: JobResource; + /** + * The description of the job, provided at job creation. + */ + Description?: String; + /** + * The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS. + */ + KmsKeyARN?: KmsKeyARN; + /** + * The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM). + */ + RoleARN?: RoleARN; + /** + * The ID for the address that you want the Snowball shipped to. + */ + AddressId?: AddressId; + /** + * A job's shipping information, including inbound and outbound tracking numbers and shipping speed options. + */ + ShippingDetails?: ShippingDetails; + /** + * The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs. + */ + SnowballCapacityPreference?: SnowballCapacity; + /** + * The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. + */ + Notification?: Notification; + /** + * A value that defines the real-time status of a Snowball's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs. + */ + DataTransferProgress?: DataTransfer; + /** + * Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you. + */ + JobLogInfo?: JobLogs; + /** + * The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000. + */ + ClusterId?: String; + /** + * The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions. + */ + ForwardingAddressId?: AddressId; + } + export type JobMetadataList = JobMetadata[]; + export interface JobResource { + /** + * An array of S3Resource objects. + */ + S3Resources?: S3ResourceList; + /** + * The Python-language Lambda functions for this job. + */ + LambdaResources?: LambdaResourceList; + /** + * The Amazon Machine Images (AMIs) associated with this job. + */ + Ec2AmiResources?: Ec2AmiResourceList; + } + export type JobState = "New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWSSortingFacility"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending"|string; + export type JobStateList = JobState[]; + export type JobType = "IMPORT"|"EXPORT"|"LOCAL_USE"|string; + export interface KeyRange { + /** + * The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. + */ + BeginMarker?: String; + /** + * The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted. + */ + EndMarker?: String; + } + export type KmsKeyARN = string; + export interface LambdaResource { + /** + * An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource. + */ + LambdaArn?: ResourceARN; + /** + * The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job. + */ + EventTriggers?: EventTriggerDefinitionList; + } + export type LambdaResourceList = LambdaResource[]; + export interface ListClusterJobsRequest { + /** + * The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. + */ + ClusterId: ClusterId; + /** + * The number of JobListEntry objects to return. + */ + MaxResults?: ListLimit; + /** + * HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. + */ + NextToken?: String; + } + export interface ListClusterJobsResult { + /** + * Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. + */ + JobListEntries?: JobListEntryList; + /** + * HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array. + */ + NextToken?: String; + } + export interface ListClustersRequest { + /** + * The number of ClusterListEntry objects to return. + */ + MaxResults?: ListLimit; + /** + * HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. + */ + NextToken?: String; + } + export interface ListClustersResult { + /** + * Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. + */ + ClusterListEntries?: ClusterListEntryList; + /** + * HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array. + */ + NextToken?: String; + } + export interface ListCompatibleImagesRequest { + /** + * The maximum number of results for the list of compatible images. Currently, each supported device can store 10 AMIs. + */ + MaxResults?: ListLimit; + /** + * HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for NextToken as the starting point for your list of returned images. + */ + NextToken?: String; + } + export interface ListCompatibleImagesResult { + /** + * A JSON-formatted object that describes a compatible AMI. + */ + CompatibleImages?: CompatibleImageList; + /** + * Because HTTP requests are stateless, this is the starting point for your next list of returned images. + */ + NextToken?: String; + } + export interface ListJobsRequest { + /** + * The number of JobListEntry objects to return. + */ + MaxResults?: ListLimit; + /** + * HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. + */ + NextToken?: String; + } + export interface ListJobsResult { + /** + * Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. + */ + JobListEntries?: JobListEntryList; + /** + * HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array. + */ + NextToken?: String; + } + export type ListLimit = number; + export type Long = number; + export interface Notification { + /** + * The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action. + */ + SnsTopicARN?: SnsTopicARN; + /** + * The list of job states that will trigger a notification for this job. + */ + JobStatesToNotify?: JobStateList; + /** + * Any change in job state will trigger a notification for this job. + */ + NotifyAll?: Boolean; + } + export type ResourceARN = string; + export type RoleARN = string; + export interface S3Resource { + /** + * The Amazon Resource Name (ARN) of an Amazon S3 bucket. + */ + BucketArn?: ResourceARN; + /** + * For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted. + */ + KeyRange?: KeyRange; + } + export type S3ResourceList = S3Resource[]; + export interface Shipment { + /** + * Status information for a shipment. + */ + Status?: String; + /** + * The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it. For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier. + */ + TrackingNumber?: String; + } + export interface ShippingDetails { + /** + * The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snowball from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowballs are delivered in one to seven days. In the United States of America (US), you have access to one-day shipping and two-day shipping. + */ + ShippingOption?: ShippingOption; + /** + * The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job. + */ + InboundShipment?: Shipment; + /** + * The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job. + */ + OutboundShipment?: Shipment; + } + export type ShippingOption = "SECOND_DAY"|"NEXT_DAY"|"EXPRESS"|"STANDARD"|string; + export type SnowballCapacity = "T50"|"T80"|"T100"|"T42"|"NoPreference"|string; + export type SnowballType = "STANDARD"|"EDGE"|"EDGE_C"|"EDGE_CG"|string; + export type SnsTopicARN = string; + export type String = string; + export type Timestamp = Date; + export interface UpdateClusterRequest { + /** + * The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000. + */ + ClusterId: ClusterId; + /** + * The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM). + */ + RoleARN?: RoleARN; + /** + * The updated description of this cluster. + */ + Description?: String; + /** + * The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. + */ + Resources?: JobResource; + /** + * The ID of the updated Address object. + */ + AddressId?: AddressId; + /** + * The updated shipping option value of this cluster's ShippingDetails object. + */ + ShippingOption?: ShippingOption; + /** + * The new or updated Notification object. + */ + Notification?: Notification; + /** + * The updated ID for the forwarding address for a cluster. This field is not supported in most regions. + */ + ForwardingAddressId?: AddressId; + } + export interface UpdateClusterResult { + } + export interface UpdateJobRequest { + /** + * The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000. + */ + JobId: JobId; + /** + * The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleAWS Identity and Access Management (IAM) API action. + */ + RoleARN?: RoleARN; + /** + * The new or updated Notification object. + */ + Notification?: Notification; + /** + * The updated JobResource object, or the updated JobResource object. + */ + Resources?: JobResource; + /** + * The ID of the updated Address object. + */ + AddressId?: AddressId; + /** + * The updated shipping option value of this job's ShippingDetails object. + */ + ShippingOption?: ShippingOption; + /** + * The updated description of this job's JobMetadata object. + */ + Description?: String; + /** + * The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions. + */ + SnowballCapacityPreference?: SnowballCapacity; + /** + * The updated ID for the forwarding address for a job. This field is not supported in most regions. + */ + ForwardingAddressId?: AddressId; + } + export interface UpdateJobResult { + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-06-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Snowball client. + */ + export import Types = Snowball; +} +export = Snowball; diff --git a/node_modules/aws-sdk/clients/snowball.js b/node_modules/aws-sdk/clients/snowball.js new file mode 100644 index 0000000..25892ec --- /dev/null +++ b/node_modules/aws-sdk/clients/snowball.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['snowball'] = {}; +AWS.Snowball = Service.defineService('snowball', ['2016-06-30']); +Object.defineProperty(apiLoader.services['snowball'], '2016-06-30', { + get: function get() { + var model = require('../apis/snowball-2016-06-30.min.json'); + model.paginators = require('../apis/snowball-2016-06-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Snowball; diff --git a/node_modules/aws-sdk/clients/sns.d.ts b/node_modules/aws-sdk/clients/sns.d.ts new file mode 100644 index 0000000..5b22e22 --- /dev/null +++ b/node_modules/aws-sdk/clients/sns.d.ts @@ -0,0 +1,882 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SNS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SNS.Types.ClientConfiguration) + config: Config & SNS.Types.ClientConfiguration; + /** + * Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. + */ + addPermission(params: SNS.Types.AddPermissionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. + */ + addPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out. To resume sending messages, you can opt in the number by using the OptInPhoneNumber action. + */ + checkIfPhoneNumberIsOptedOut(params: SNS.Types.CheckIfPhoneNumberIsOptedOutInput, callback?: (err: AWSError, data: SNS.Types.CheckIfPhoneNumberIsOptedOutResponse) => void): Request; + /** + * Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out. To resume sending messages, you can opt in the number by using the OptInPhoneNumber action. + */ + checkIfPhoneNumberIsOptedOut(callback?: (err: AWSError, data: SNS.Types.CheckIfPhoneNumberIsOptedOutResponse) => void): Request; + /** + * Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true". + */ + confirmSubscription(params: SNS.Types.ConfirmSubscriptionInput, callback?: (err: AWSError, data: SNS.Types.ConfirmSubscriptionResponse) => void): Request; + /** + * Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true". + */ + confirmSubscription(callback?: (err: AWSError, data: SNS.Types.ConfirmSubscriptionResponse) => void): Request; + /** + * Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key". For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS. + */ + createPlatformApplication(params: SNS.Types.CreatePlatformApplicationInput, callback?: (err: AWSError, data: SNS.Types.CreatePlatformApplicationResponse) => void): Request; + /** + * Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key". For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS. + */ + createPlatformApplication(callback?: (err: AWSError, data: SNS.Types.CreatePlatformApplicationResponse) => void): Request; + /** + * Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications. When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu. + */ + createPlatformEndpoint(params: SNS.Types.CreatePlatformEndpointInput, callback?: (err: AWSError, data: SNS.Types.CreateEndpointResponse) => void): Request; + /** + * Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications. When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu. + */ + createPlatformEndpoint(callback?: (err: AWSError, data: SNS.Types.CreateEndpointResponse) => void): Request; + /** + * Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. + */ + createTopic(params: SNS.Types.CreateTopicInput, callback?: (err: AWSError, data: SNS.Types.CreateTopicResponse) => void): Request; + /** + * Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. + */ + createTopic(callback?: (err: AWSError, data: SNS.Types.CreateTopicResponse) => void): Request; + /** + * Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications. When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic. + */ + deleteEndpoint(params: SNS.Types.DeleteEndpointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications. When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic. + */ + deleteEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + deletePlatformApplication(params: SNS.Types.DeletePlatformApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + deletePlatformApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. + */ + deleteTopic(params: SNS.Types.DeleteTopicInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. + */ + deleteTopic(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + getEndpointAttributes(params: SNS.Types.GetEndpointAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetEndpointAttributesResponse) => void): Request; + /** + * Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + getEndpointAttributes(callback?: (err: AWSError, data: SNS.Types.GetEndpointAttributesResponse) => void): Request; + /** + * Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + getPlatformApplicationAttributes(params: SNS.Types.GetPlatformApplicationAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetPlatformApplicationAttributesResponse) => void): Request; + /** + * Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + getPlatformApplicationAttributes(callback?: (err: AWSError, data: SNS.Types.GetPlatformApplicationAttributesResponse) => void): Request; + /** + * Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action. + */ + getSMSAttributes(params: SNS.Types.GetSMSAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetSMSAttributesResponse) => void): Request; + /** + * Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action. + */ + getSMSAttributes(callback?: (err: AWSError, data: SNS.Types.GetSMSAttributesResponse) => void): Request; + /** + * Returns all of the properties of a subscription. + */ + getSubscriptionAttributes(params: SNS.Types.GetSubscriptionAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetSubscriptionAttributesResponse) => void): Request; + /** + * Returns all of the properties of a subscription. + */ + getSubscriptionAttributes(callback?: (err: AWSError, data: SNS.Types.GetSubscriptionAttributesResponse) => void): Request; + /** + * Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. + */ + getTopicAttributes(params: SNS.Types.GetTopicAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetTopicAttributesResponse) => void): Request; + /** + * Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. + */ + getTopicAttributes(callback?: (err: AWSError, data: SNS.Types.GetTopicAttributesResponse) => void): Request; + /** + * Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 30 transactions per second (TPS). + */ + listEndpointsByPlatformApplication(params: SNS.Types.ListEndpointsByPlatformApplicationInput, callback?: (err: AWSError, data: SNS.Types.ListEndpointsByPlatformApplicationResponse) => void): Request; + /** + * Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 30 transactions per second (TPS). + */ + listEndpointsByPlatformApplication(callback?: (err: AWSError, data: SNS.Types.ListEndpointsByPlatformApplicationResponse) => void): Request; + /** + * Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. + */ + listPhoneNumbersOptedOut(params: SNS.Types.ListPhoneNumbersOptedOutInput, callback?: (err: AWSError, data: SNS.Types.ListPhoneNumbersOptedOutResponse) => void): Request; + /** + * Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. + */ + listPhoneNumbersOptedOut(callback?: (err: AWSError, data: SNS.Types.ListPhoneNumbersOptedOutResponse) => void): Request; + /** + * Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 15 transactions per second (TPS). + */ + listPlatformApplications(params: SNS.Types.ListPlatformApplicationsInput, callback?: (err: AWSError, data: SNS.Types.ListPlatformApplicationsResponse) => void): Request; + /** + * Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 15 transactions per second (TPS). + */ + listPlatformApplications(callback?: (err: AWSError, data: SNS.Types.ListPlatformApplicationsResponse) => void): Request; + /** + * Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results. This action is throttled at 30 transactions per second (TPS). + */ + listSubscriptions(params: SNS.Types.ListSubscriptionsInput, callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsResponse) => void): Request; + /** + * Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results. This action is throttled at 30 transactions per second (TPS). + */ + listSubscriptions(callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsResponse) => void): Request; + /** + * Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results. This action is throttled at 30 transactions per second (TPS). + */ + listSubscriptionsByTopic(params: SNS.Types.ListSubscriptionsByTopicInput, callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsByTopicResponse) => void): Request; + /** + * Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results. This action is throttled at 30 transactions per second (TPS). + */ + listSubscriptionsByTopic(callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsByTopicResponse) => void): Request; + /** + * List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide. + */ + listTagsForResource(params: SNS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SNS.Types.ListTagsForResourceResponse) => void): Request; + /** + * List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide. + */ + listTagsForResource(callback?: (err: AWSError, data: SNS.Types.ListTagsForResourceResponse) => void): Request; + /** + * Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results. This action is throttled at 30 transactions per second (TPS). + */ + listTopics(params: SNS.Types.ListTopicsInput, callback?: (err: AWSError, data: SNS.Types.ListTopicsResponse) => void): Request; + /** + * Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results. This action is throttled at 30 transactions per second (TPS). + */ + listTopics(callback?: (err: AWSError, data: SNS.Types.ListTopicsResponse) => void): Request; + /** + * Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number. You can opt in a phone number only once every 30 days. + */ + optInPhoneNumber(params: SNS.Types.OptInPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.OptInPhoneNumberResponse) => void): Request; + /** + * Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number. You can opt in a phone number only once every 30 days. + */ + optInPhoneNumber(callback?: (err: AWSError, data: SNS.Types.OptInPhoneNumberResponse) => void): Request; + /** + * Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number. If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly. To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices. + */ + publish(params: SNS.Types.PublishInput, callback?: (err: AWSError, data: SNS.Types.PublishResponse) => void): Request; + /** + * Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number. If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly. To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices. + */ + publish(callback?: (err: AWSError, data: SNS.Types.PublishResponse) => void): Request; + /** + * Removes a statement from a topic's access control policy. + */ + removePermission(params: SNS.Types.RemovePermissionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes a statement from a topic's access control policy. + */ + removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + setEndpointAttributes(params: SNS.Types.SetEndpointAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. + */ + setEndpointAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status. + */ + setPlatformApplicationAttributes(params: SNS.Types.SetPlatformApplicationAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status. + */ + setPlatformApplicationAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports. You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide. + */ + setSMSAttributes(params: SNS.Types.SetSMSAttributesInput, callback?: (err: AWSError, data: SNS.Types.SetSMSAttributesResponse) => void): Request; + /** + * Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports. You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide. + */ + setSMSAttributes(callback?: (err: AWSError, data: SNS.Types.SetSMSAttributesResponse) => void): Request; + /** + * Allows a subscription owner to set an attribute of the subscription to a new value. + */ + setSubscriptionAttributes(params: SNS.Types.SetSubscriptionAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Allows a subscription owner to set an attribute of the subscription to a new value. + */ + setSubscriptionAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Allows a topic owner to set an attribute of the topic to a new value. + */ + setTopicAttributes(params: SNS.Types.SetTopicAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Allows a topic owner to set an attribute of the topic to a new value. + */ + setTopicAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days. This action is throttled at 100 transactions per second (TPS). + */ + subscribe(params: SNS.Types.SubscribeInput, callback?: (err: AWSError, data: SNS.Types.SubscribeResponse) => void): Request; + /** + * Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days. This action is throttled at 100 transactions per second (TPS). + */ + subscribe(callback?: (err: AWSError, data: SNS.Types.SubscribeResponse) => void): Request; + /** + * Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. When you use topic tags, keep the following guidelines in mind: Adding more than 50 tags to a topic isn't recommended. Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 10 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Topics in the Amazon SNS Developer Guide. + */ + tagResource(params: SNS.Types.TagResourceRequest, callback?: (err: AWSError, data: SNS.Types.TagResourceResponse) => void): Request; + /** + * Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. When you use topic tags, keep the following guidelines in mind: Adding more than 50 tags to a topic isn't recommended. Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 10 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Topics in the Amazon SNS Developer Guide. + */ + tagResource(callback?: (err: AWSError, data: SNS.Types.TagResourceResponse) => void): Request; + /** + * Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended. This action is throttled at 100 transactions per second (TPS). + */ + unsubscribe(params: SNS.Types.UnsubscribeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended. This action is throttled at 100 transactions per second (TPS). + */ + unsubscribe(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. + */ + untagResource(params: SNS.Types.UntagResourceRequest, callback?: (err: AWSError, data: SNS.Types.UntagResourceResponse) => void): Request; + /** + * Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. + */ + untagResource(callback?: (err: AWSError, data: SNS.Types.UntagResourceResponse) => void): Request; +} +declare namespace SNS { + export type ActionsList = action[]; + export interface AddPermissionInput { + /** + * The ARN of the topic whose access control policy you wish to modify. + */ + TopicArn: topicARN; + /** + * A unique identifier for the new policy statement. + */ + Label: label; + /** + * The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. + */ + AWSAccountId: DelegatesList; + /** + * The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name. + */ + ActionName: ActionsList; + } + export type AmazonResourceName = string; + export type Binary = Buffer|Uint8Array|Blob|string; + export interface CheckIfPhoneNumberIsOptedOutInput { + /** + * The phone number for which you want to check the opt out status. + */ + phoneNumber: PhoneNumber; + } + export interface CheckIfPhoneNumberIsOptedOutResponse { + /** + * Indicates whether the phone number is opted out: true – The phone number is opted out, meaning you cannot publish SMS messages to it. false – The phone number is opted in, meaning you can publish SMS messages to it. + */ + isOptedOut?: boolean; + } + export interface ConfirmSubscriptionInput { + /** + * The ARN of the topic for which you wish to confirm a subscription. + */ + TopicArn: topicARN; + /** + * Short-lived token sent to an endpoint during the Subscribe action. + */ + Token: token; + /** + * Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. + */ + AuthenticateOnUnsubscribe?: authenticateOnUnsubscribe; + } + export interface ConfirmSubscriptionResponse { + /** + * The ARN of the created subscription. + */ + SubscriptionArn?: subscriptionARN; + } + export interface CreateEndpointResponse { + /** + * EndpointArn returned from CreateEndpoint action. + */ + EndpointArn?: String; + } + export interface CreatePlatformApplicationInput { + /** + * Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. + */ + Name: String; + /** + * The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging). + */ + Platform: String; + /** + * For a list of attributes, see SetPlatformApplicationAttributes + */ + Attributes: MapStringToString; + } + export interface CreatePlatformApplicationResponse { + /** + * PlatformApplicationArn is returned. + */ + PlatformApplicationArn?: String; + } + export interface CreatePlatformEndpointInput { + /** + * PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. + */ + PlatformApplicationArn: String; + /** + * Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID. + */ + Token: String; + /** + * Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. + */ + CustomUserData?: String; + /** + * For a list of attributes, see SetEndpointAttributes. + */ + Attributes?: MapStringToString; + } + export interface CreateTopicInput { + /** + * The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. + */ + Name: topicName; + /** + * A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with SMS subscriptions. Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. The following attribute applies only to server-side-encryption: KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. + */ + Attributes?: TopicAttributesMap; + /** + * The list of tags to add to a new topic. + */ + Tags?: TagList; + } + export interface CreateTopicResponse { + /** + * The Amazon Resource Name (ARN) assigned to the created topic. + */ + TopicArn?: topicARN; + } + export type DelegatesList = delegate[]; + export interface DeleteEndpointInput { + /** + * EndpointArn of endpoint to delete. + */ + EndpointArn: String; + } + export interface DeletePlatformApplicationInput { + /** + * PlatformApplicationArn of platform application object to delete. + */ + PlatformApplicationArn: String; + } + export interface DeleteTopicInput { + /** + * The ARN of the topic you want to delete. + */ + TopicArn: topicARN; + } + export interface Endpoint { + /** + * EndpointArn for mobile app and device. + */ + EndpointArn?: String; + /** + * Attributes for endpoint. + */ + Attributes?: MapStringToString; + } + export interface GetEndpointAttributesInput { + /** + * EndpointArn for GetEndpointAttributes input. + */ + EndpointArn: String; + } + export interface GetEndpointAttributesResponse { + /** + * Attributes include the following: CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. + */ + Attributes?: MapStringToString; + } + export interface GetPlatformApplicationAttributesInput { + /** + * PlatformApplicationArn for GetPlatformApplicationAttributesInput. + */ + PlatformApplicationArn: String; + } + export interface GetPlatformApplicationAttributesResponse { + /** + * Attributes include the following: EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent. EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent. EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent. EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. + */ + Attributes?: MapStringToString; + } + export interface GetSMSAttributesInput { + /** + * A list of the individual attribute names, such as MonthlySpendLimit, for which you want values. For all attribute names, see SetSMSAttributes. If you don't use this parameter, Amazon SNS returns all SMS attributes. + */ + attributes?: ListString; + } + export interface GetSMSAttributesResponse { + /** + * The SMS attribute names and their values. + */ + attributes?: MapStringToString; + } + export interface GetSubscriptionAttributesInput { + /** + * The ARN of the subscription whose properties you want to get. + */ + SubscriptionArn: subscriptionARN; + } + export interface GetSubscriptionAttributesResponse { + /** + * A map of the subscription's attributes. Attributes in this map include the following: ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated. DeliveryPolicy – The JSON serialization of the subscription's delivery policy. EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults. FilterPolicy – The filter policy JSON that is assigned to the subscription. Owner – The AWS account ID of the subscription's owner. PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token. RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints. SubscriptionArn – The subscription's ARN. TopicArn – The topic ARN that the subscription is associated with. + */ + Attributes?: SubscriptionAttributesMap; + } + export interface GetTopicAttributesInput { + /** + * The ARN of the topic whose properties you want to get. + */ + TopicArn: topicARN; + } + export interface GetTopicAttributesResponse { + /** + * A map of the topic's attributes. Attributes in this map include the following: TopicArn – the topic's ARN Owner – the AWS account ID of the topic's owner Policy – the JSON serialization of the topic's access control policy DisplayName – the human-readable name used in the "From" field for notifications to email and email-json endpoints SubscriptionsPending – the number of subscriptions pending confirmation on this topic SubscriptionsConfirmed – the number of confirmed subscriptions on this topic SubscriptionsDeleted – the number of deleted subscriptions on this topic DeliveryPolicy – the JSON serialization of the topic's delivery policy EffectiveDeliveryPolicy – the JSON serialization of the effective delivery policy that takes into account system defaults + */ + Attributes?: TopicAttributesMap; + } + export interface ListEndpointsByPlatformApplicationInput { + /** + * PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. + */ + PlatformApplicationArn: String; + /** + * NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. + */ + NextToken?: String; + } + export interface ListEndpointsByPlatformApplicationResponse { + /** + * Endpoints returned for ListEndpointsByPlatformApplication action. + */ + Endpoints?: ListOfEndpoints; + /** + * NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results. + */ + NextToken?: String; + } + export type ListOfEndpoints = Endpoint[]; + export type ListOfPlatformApplications = PlatformApplication[]; + export interface ListPhoneNumbersOptedOutInput { + /** + * A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results. + */ + nextToken?: string; + } + export interface ListPhoneNumbersOptedOutResponse { + /** + * A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers. + */ + phoneNumbers?: PhoneNumberList; + /** + * A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results. + */ + nextToken?: string; + } + export interface ListPlatformApplicationsInput { + /** + * NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. + */ + NextToken?: String; + } + export interface ListPlatformApplicationsResponse { + /** + * Platform applications returned when calling ListPlatformApplications action. + */ + PlatformApplications?: ListOfPlatformApplications; + /** + * NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results. + */ + NextToken?: String; + } + export type ListString = String[]; + export interface ListSubscriptionsByTopicInput { + /** + * The ARN of the topic for which you wish to find subscriptions. + */ + TopicArn: topicARN; + /** + * Token returned by the previous ListSubscriptionsByTopic request. + */ + NextToken?: nextToken; + } + export interface ListSubscriptionsByTopicResponse { + /** + * A list of subscriptions. + */ + Subscriptions?: SubscriptionsList; + /** + * Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve. + */ + NextToken?: nextToken; + } + export interface ListSubscriptionsInput { + /** + * Token returned by the previous ListSubscriptions request. + */ + NextToken?: nextToken; + } + export interface ListSubscriptionsResponse { + /** + * A list of subscriptions. + */ + Subscriptions?: SubscriptionsList; + /** + * Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve. + */ + NextToken?: nextToken; + } + export interface ListTagsForResourceRequest { + /** + * The ARN of the topic for which to list tags. + */ + ResourceArn: AmazonResourceName; + } + export interface ListTagsForResourceResponse { + /** + * The tags associated with the specified topic. + */ + Tags?: TagList; + } + export interface ListTopicsInput { + /** + * Token returned by the previous ListTopics request. + */ + NextToken?: nextToken; + } + export interface ListTopicsResponse { + /** + * A list of topic ARNs. + */ + Topics?: TopicsList; + /** + * Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve. + */ + NextToken?: nextToken; + } + export type MapStringToString = {[key: string]: String}; + export type MessageAttributeMap = {[key: string]: MessageAttributeValue}; + export interface MessageAttributeValue { + /** + * Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. + */ + DataType: String; + /** + * Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters. + */ + StringValue?: String; + /** + * Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. + */ + BinaryValue?: Binary; + } + export interface OptInPhoneNumberInput { + /** + * The phone number to opt in. + */ + phoneNumber: PhoneNumber; + } + export interface OptInPhoneNumberResponse { + } + export type PhoneNumber = string; + export type PhoneNumberList = PhoneNumber[]; + export interface PlatformApplication { + /** + * PlatformApplicationArn for platform application object. + */ + PlatformApplicationArn?: String; + /** + * Attributes for platform application object. + */ + Attributes?: MapStringToString; + } + export interface PublishInput { + /** + * The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. + */ + TopicArn?: topicARN; + /** + * If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters. + */ + TargetArn?: String; + /** + * The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters. + */ + PhoneNumber?: String; + /** + * The message you want to send. The Message parameter is always a string. If you set MessageStructure to json, you must string-encode the Message parameter. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. Constraints: With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters). For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters. JSON-specific constraints: Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. The values will be parsed (unescaped) before they are used in outgoing messages. Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). Values have a minimum length of 0 (the empty string, "", is allowed). Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). Non-string values will cause the key to be ignored. Keys that do not correspond to supported transport protocols are ignored. Duplicate keys are not allowed. Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery). + */ + Message: message; + /** + * Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long. + */ + Subject?: subject; + /** + * Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must: be a syntactically valid JSON object; and contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide. Valid value: json + */ + MessageStructure?: messageStructure; + /** + * Message attributes for Publish action. + */ + MessageAttributes?: MessageAttributeMap; + } + export interface PublishResponse { + /** + * Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters + */ + MessageId?: messageId; + } + export interface RemovePermissionInput { + /** + * The ARN of the topic whose access control policy you wish to modify. + */ + TopicArn: topicARN; + /** + * The unique label of the statement you want to remove. + */ + Label: label; + } + export interface SetEndpointAttributesInput { + /** + * EndpointArn used for SetEndpointAttributes action. + */ + EndpointArn: String; + /** + * A map of the endpoint attributes. Attributes in this map include the following: CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. + */ + Attributes: MapStringToString; + } + export interface SetPlatformApplicationAttributesInput { + /** + * PlatformApplicationArn for SetPlatformApplicationAttributes action. + */ + PlatformApplicationArn: String; + /** + * A map of the platform application attributes. Attributes in this map include the following: PlatformCredential – The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". PlatformPrincipal – The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent. EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent. EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent. EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages. + */ + Attributes: MapStringToString; + } + export interface SetSMSAttributesInput { + /** + * The default settings for sending SMS messages from your account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes. Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit. By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase. DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information. DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10. DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter. DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values: Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost. Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability. UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account: Time that the message was published (in UTC) Message ID Destination phone number Message type Delivery status Message price (in USD) Part number (a message is split into multiple parts if it is too long for a single message) Total number of parts To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions. For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide. + */ + attributes: MapStringToString; + } + export interface SetSMSAttributesResponse { + } + export interface SetSubscriptionAttributesInput { + /** + * The ARN of the subscription to modify. + */ + SubscriptionArn: subscriptionARN; + /** + * A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic. RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata. + */ + AttributeName: attributeName; + /** + * The new value for the attribute in JSON format. + */ + AttributeValue?: attributeValue; + } + export interface SetTopicAttributesInput { + /** + * The ARN of the topic to modify. + */ + TopicArn: topicARN; + /** + * A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with SMS subscriptions. Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. The following attribute applies only to server-side-encryption: KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. + */ + AttributeName: attributeName; + /** + * The new value for the attribute. + */ + AttributeValue?: attributeValue; + } + export type String = string; + export interface SubscribeInput { + /** + * The ARN of the topic you want to subscribe to. + */ + TopicArn: topicARN; + /** + * The protocol you want to use. Supported protocols include: http – delivery of JSON-encoded message via HTTP POST https – delivery of JSON-encoded message via HTTPS POST email – delivery of message via SMTP email-json – delivery of JSON-encoded message via SMTP sms – delivery of message via SMS sqs – delivery of JSON-encoded message to an Amazon SQS queue application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device. lambda – delivery of JSON-encoded message to an AWS Lambda function. + */ + Protocol: protocol; + /** + * The endpoint that you want to receive notifications. Endpoints vary by protocol: For the http protocol, the endpoint is an URL beginning with "https://" For the https protocol, the endpoint is a URL beginning with "https://" For the email protocol, the endpoint is an email address For the email-json protocol, the endpoint is an email address For the sms protocol, the endpoint is a phone number of an SMS-enabled device For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue For the application protocol, the endpoint is the EndpointArn of a mobile app and device. For the lambda protocol, the endpoint is the ARN of an AWS Lambda function. + */ + Endpoint?: endpoint; + /** + * A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic. RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata. + */ + Attributes?: SubscriptionAttributesMap; + /** + * Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed. If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token. If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. The default value is false. + */ + ReturnSubscriptionArn?: boolean; + } + export interface SubscribeResponse { + /** + * The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation. + */ + SubscriptionArn?: subscriptionARN; + } + export interface Subscription { + /** + * The subscription's ARN. + */ + SubscriptionArn?: subscriptionARN; + /** + * The subscription's owner. + */ + Owner?: account; + /** + * The subscription's protocol. + */ + Protocol?: protocol; + /** + * The subscription's endpoint (format depends on the protocol). + */ + Endpoint?: endpoint; + /** + * The ARN of the subscription's topic. + */ + TopicArn?: topicARN; + } + export type SubscriptionAttributesMap = {[key: string]: attributeValue}; + export type SubscriptionsList = Subscription[]; + export interface Tag { + /** + * The required key portion of the tag. + */ + Key: TagKey; + /** + * The optional value portion of the tag. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceRequest { + /** + * The ARN of the topic to which to add tags. + */ + ResourceArn: AmazonResourceName; + /** + * The tags to be added to the specified topic. A tag consists of a required key and an optional value. + */ + Tags: TagList; + } + export interface TagResourceResponse { + } + export type TagValue = string; + export interface Topic { + /** + * The topic's ARN. + */ + TopicArn?: topicARN; + } + export type TopicAttributesMap = {[key: string]: attributeValue}; + export type TopicsList = Topic[]; + export interface UnsubscribeInput { + /** + * The ARN of the subscription to be deleted. + */ + SubscriptionArn: subscriptionARN; + } + export interface UntagResourceRequest { + /** + * The ARN of the topic from which to remove tags. + */ + ResourceArn: AmazonResourceName; + /** + * The list of tag keys to remove from the specified topic. + */ + TagKeys: TagKeyList; + } + export interface UntagResourceResponse { + } + export type account = string; + export type action = string; + export type attributeName = string; + export type attributeValue = string; + export type authenticateOnUnsubscribe = string; + export type delegate = string; + export type endpoint = string; + export type label = string; + export type message = string; + export type messageId = string; + export type messageStructure = string; + export type nextToken = string; + export type protocol = string; + export type subject = string; + export type subscriptionARN = string; + export type token = string; + export type topicARN = string; + export type topicName = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2010-03-31"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SNS client. + */ + export import Types = SNS; +} +export = SNS; diff --git a/node_modules/aws-sdk/clients/sns.js b/node_modules/aws-sdk/clients/sns.js new file mode 100644 index 0000000..716d948 --- /dev/null +++ b/node_modules/aws-sdk/clients/sns.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['sns'] = {}; +AWS.SNS = Service.defineService('sns', ['2010-03-31']); +Object.defineProperty(apiLoader.services['sns'], '2010-03-31', { + get: function get() { + var model = require('../apis/sns-2010-03-31.min.json'); + model.paginators = require('../apis/sns-2010-03-31.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SNS; diff --git a/node_modules/aws-sdk/clients/sqs.d.ts b/node_modules/aws-sdk/clients/sqs.d.ts new file mode 100644 index 0000000..f52abd2 --- /dev/null +++ b/node_modules/aws-sdk/clients/sqs.d.ts @@ -0,0 +1,693 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SQS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SQS.Types.ClientConfiguration) + config: Config & SQS.Types.ClientConfiguration; + /** + * Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide. AddPermission writes an Amazon-SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide. An Amazon SQS policy can have a maximum of 7 actions. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + addPermission(params: SQS.Types.AddPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide. AddPermission writes an Amazon-SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide. An Amazon SQS policy can have a maximum of 7 actions. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + addPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected. A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue. For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages. If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time. Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received. + */ + changeMessageVisibility(params: SQS.Types.ChangeMessageVisibilityRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected. A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue. For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages. If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time. Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received. + */ + changeMessageVisibility(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + changeMessageVisibilityBatch(params: SQS.Types.ChangeMessageVisibilityBatchRequest, callback?: (err: AWSError, data: SQS.Types.ChangeMessageVisibilityBatchResult) => void): Request; + /** + * Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + changeMessageVisibilityBatch(callback?: (err: AWSError, data: SQS.Types.ChangeMessageVisibilityBatchResult) => void): Request; + /** + * Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind: If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide. If you don't provide a value for an attribute, the queue is created with the default value for the attribute. If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues. To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names: If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + createQueue(params: SQS.Types.CreateQueueRequest, callback?: (err: AWSError, data: SQS.Types.CreateQueueResult) => void): Request; + /** + * Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind: If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide. If you don't provide a value for an attribute, the queue is created with the default value for the attribute. If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues. To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names: If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + createQueue(callback?: (err: AWSError, data: SQS.Types.CreateQueueResult) => void): Request; + /** + * Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue. The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted). For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues. + */ + deleteMessage(params: SQS.Types.DeleteMessageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue. The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted). For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues. + */ + deleteMessage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + deleteMessageBatch(params: SQS.Types.DeleteMessageBatchRequest, callback?: (err: AWSError, data: SQS.Types.DeleteMessageBatchResult) => void): Request; + /** + * Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + deleteMessageBatch(callback?: (err: AWSError, data: SQS.Types.DeleteMessageBatchResult) => void): Request; + /** + * Deletes the queue specified by the QueueUrl, regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response. Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available. When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist. When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + deleteQueue(params: SQS.Types.DeleteQueueRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the queue specified by the QueueUrl, regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response. Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available. When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist. When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + deleteQueue(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Gets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + getQueueAttributes(params: SQS.Types.GetQueueAttributesRequest, callback?: (err: AWSError, data: SQS.Types.GetQueueAttributesResult) => void): Request; + /** + * Gets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + getQueueAttributes(callback?: (err: AWSError, data: SQS.Types.GetQueueAttributesResult) => void): Request; + /** + * Returns the URL of an existing Amazon SQS queue. To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide. + */ + getQueueUrl(params: SQS.Types.GetQueueUrlRequest, callback?: (err: AWSError, data: SQS.Types.GetQueueUrlResult) => void): Request; + /** + * Returns the URL of an existing Amazon SQS queue. To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide. + */ + getQueueUrl(callback?: (err: AWSError, data: SQS.Types.GetQueueUrlResult) => void): Request; + /** + * Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue. For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. + */ + listDeadLetterSourceQueues(params: SQS.Types.ListDeadLetterSourceQueuesRequest, callback?: (err: AWSError, data: SQS.Types.ListDeadLetterSourceQueuesResult) => void): Request; + /** + * Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue. For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. + */ + listDeadLetterSourceQueues(callback?: (err: AWSError, data: SQS.Types.ListDeadLetterSourceQueuesResult) => void): Request; + /** + * List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide. When you use queue tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + listQueueTags(params: SQS.Types.ListQueueTagsRequest, callback?: (err: AWSError, data: SQS.Types.ListQueueTagsResult) => void): Request; + /** + * List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide. When you use queue tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + listQueueTags(callback?: (err: AWSError, data: SQS.Types.ListQueueTagsResult) => void): Request; + /** + * Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + listQueues(params: SQS.Types.ListQueuesRequest, callback?: (err: AWSError, data: SQS.Types.ListQueuesResult) => void): Request; + /** + * Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + listQueues(callback?: (err: AWSError, data: SQS.Types.ListQueuesResult) => void): Request; + /** + * Deletes the messages in a queue specified by the QueueURL parameter. When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue. The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size. Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute. Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged. + */ + purgeQueue(params: SQS.Types.PurgeQueueRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the messages in a queue specified by the QueueURL parameter. When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue. The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size. Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute. Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged. + */ + purgeQueue(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide. Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request. For each message returned, the response includes the following: The message body. An MD5 digest of the message body. For information about MD5, see RFC1321. The MessageId you received when you sent the message to the queue. The receipt handle. The message attributes. An MD5 digest of the message attributes. The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide. You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. + */ + receiveMessage(params: SQS.Types.ReceiveMessageRequest, callback?: (err: AWSError, data: SQS.Types.ReceiveMessageResult) => void): Request; + /** + * Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide. Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request. For each message returned, the response includes the following: The message body. An MD5 digest of the message body. For information about MD5, see RFC1321. The MessageId you received when you sent the message to the queue. The receipt handle. The message attributes. An MD5 digest of the message attributes. The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide. You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. + */ + receiveMessage(callback?: (err: AWSError, data: SQS.Types.ReceiveMessageResult) => void): Request; + /** + * Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of a queue can remove permissions from it. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + removePermission(params: SQS.Types.RemovePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of a queue can remove permissions from it. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Delivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. + */ + sendMessage(params: SQS.Types.SendMessageRequest, callback?: (err: AWSError, data: SQS.Types.SendMessageResult) => void): Request; + /** + * Delivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. + */ + sendMessage(callback?: (err: AWSError, data: SQS.Types.SendMessageResult) => void): Request; + /** + * Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent. The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + sendMessageBatch(params: SQS.Types.SendMessageBatchRequest, callback?: (err: AWSError, data: SQS.Types.SendMessageBatchResult) => void): Request; + /** + * Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent. The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=first &Attribute.2=second + */ + sendMessageBatch(callback?: (err: AWSError, data: SQS.Types.SendMessageBatchResult) => void): Request; + /** + * Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + setQueueAttributes(params: SQS.Types.SetQueueAttributesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + setQueueAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide. When you use queue tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + tagQueue(params: SQS.Types.TagQueueRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide. When you use queue tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + tagQueue(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide. When you use queue tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + untagQueue(params: SQS.Types.UntagQueueRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide. When you use queue tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request. For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide. + */ + untagQueue(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace SQS { + export type AWSAccountIdList = String[]; + export type ActionNameList = String[]; + export interface AddPermissionRequest { + /** + * The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_). + */ + Label: String; + /** + * The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide. + */ + AWSAccountIds: AWSAccountIdList; + /** + * The action the client wants to allow for the specified principal. Valid values: the name of any action or *. For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon Simple Queue Service Developer Guide. Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch. + */ + Actions: ActionNameList; + } + export type AttributeNameList = QueueAttributeName[]; + export interface BatchResultErrorEntry { + /** + * The Id of an entry in a batch request. + */ + Id: String; + /** + * Specifies whether the error happened due to the producer. + */ + SenderFault: Boolean; + /** + * An error code representing why the action failed on this entry. + */ + Code: String; + /** + * A message explaining why the action failed on this entry. + */ + Message?: String; + } + export type BatchResultErrorEntryList = BatchResultErrorEntry[]; + export type Binary = Buffer|Uint8Array|Blob|string; + export type BinaryList = Binary[]; + export type Boolean = boolean; + export interface ChangeMessageVisibilityBatchRequest { + /** + * The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * A list of receipt handles of the messages for which the visibility timeout must be changed. + */ + Entries: ChangeMessageVisibilityBatchRequestEntryList; + } + export interface ChangeMessageVisibilityBatchRequestEntry { + /** + * An identifier for this particular receipt handle used to communicate the result. The Ids of a batch request need to be unique within a request + */ + Id: String; + /** + * A receipt handle. + */ + ReceiptHandle: String; + /** + * The new value (in seconds) for the message's visibility timeout. + */ + VisibilityTimeout?: Integer; + } + export type ChangeMessageVisibilityBatchRequestEntryList = ChangeMessageVisibilityBatchRequestEntry[]; + export interface ChangeMessageVisibilityBatchResult { + /** + * A list of ChangeMessageVisibilityBatchResultEntry items. + */ + Successful: ChangeMessageVisibilityBatchResultEntryList; + /** + * A list of BatchResultErrorEntry items. + */ + Failed: BatchResultErrorEntryList; + } + export interface ChangeMessageVisibilityBatchResultEntry { + /** + * Represents a message whose visibility timeout has been changed successfully. + */ + Id: String; + } + export type ChangeMessageVisibilityBatchResultEntryList = ChangeMessageVisibilityBatchResultEntry[]; + export interface ChangeMessageVisibilityRequest { + /** + * The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action. + */ + ReceiptHandle: String; + /** + * The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours. + */ + VisibilityTimeout: Integer; + } + export interface CreateQueueRequest { + /** + * The name of the new queue. The following limits apply to this name: A queue name can have up to 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_). A FIFO queue name must end with the .fifo suffix. Queue URLs and names are case-sensitive. + */ + QueueName: String; + /** + * A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses: DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference. KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue - Designates a queue as FIFO. Valid values: true, false. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide. ContentBasedDeduplication - Enables content-based deduplication. Valid values: true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide. Every message must have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. + */ + Attributes?: QueueAttributeMap; + } + export interface CreateQueueResult { + /** + * The URL of the created Amazon SQS queue. + */ + QueueUrl?: String; + } + export interface DeleteMessageBatchRequest { + /** + * The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * A list of receipt handles for the messages to be deleted. + */ + Entries: DeleteMessageBatchRequestEntryList; + } + export interface DeleteMessageBatchRequestEntry { + /** + * An identifier for this particular receipt handle. This is used to communicate the result. The Ids of a batch request need to be unique within a request + */ + Id: String; + /** + * A receipt handle. + */ + ReceiptHandle: String; + } + export type DeleteMessageBatchRequestEntryList = DeleteMessageBatchRequestEntry[]; + export interface DeleteMessageBatchResult { + /** + * A list of DeleteMessageBatchResultEntry items. + */ + Successful: DeleteMessageBatchResultEntryList; + /** + * A list of BatchResultErrorEntry items. + */ + Failed: BatchResultErrorEntryList; + } + export interface DeleteMessageBatchResultEntry { + /** + * Represents a successfully deleted message. + */ + Id: String; + } + export type DeleteMessageBatchResultEntryList = DeleteMessageBatchResultEntry[]; + export interface DeleteMessageRequest { + /** + * The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * The receipt handle associated with the message to delete. + */ + ReceiptHandle: String; + } + export interface DeleteQueueRequest { + /** + * The URL of the Amazon SQS queue to delete. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + } + export interface GetQueueAttributesRequest { + /** + * The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * A list of attributes for which to retrieve information. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported: All - Returns all values. ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue. ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window. CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time). DelaySeconds - Returns the default delay on the queue in seconds. LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time). MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message. Policy - Returns the policy of the queue. QueueArn - Returns the Amazon resource name (ARN) of the queue. ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive. RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix. ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide. + */ + AttributeNames?: AttributeNameList; + } + export interface GetQueueAttributesResult { + /** + * A map of attributes to their respective values. + */ + Attributes?: QueueAttributeMap; + } + export interface GetQueueUrlRequest { + /** + * The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_). Queue URLs and names are case-sensitive. + */ + QueueName: String; + /** + * The AWS account ID of the account that created the queue. + */ + QueueOwnerAWSAccountId?: String; + } + export interface GetQueueUrlResult { + /** + * The URL of the queue. + */ + QueueUrl?: String; + } + export type Integer = number; + export interface ListDeadLetterSourceQueuesRequest { + /** + * The URL of a dead-letter queue. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + } + export interface ListDeadLetterSourceQueuesResult { + /** + * A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue. + */ + queueUrls: QueueUrlList; + } + export interface ListQueueTagsRequest { + /** + * The URL of the queue. + */ + QueueUrl: String; + } + export interface ListQueueTagsResult { + /** + * The list of all tags added to the specified queue. + */ + Tags?: TagMap; + } + export interface ListQueuesRequest { + /** + * A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. + */ + QueueNamePrefix?: String; + } + export interface ListQueuesResult { + /** + * A list of queue URLs, up to 1,000 entries. + */ + QueueUrls?: QueueUrlList; + } + export interface Message { + /** + * A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time. + */ + MessageId?: String; + /** + * An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message. + */ + ReceiptHandle?: String; + /** + * An MD5 digest of the non-URL-encoded message body string. + */ + MD5OfBody?: String; + /** + * The message's contents (not URL-encoded). + */ + Body?: String; + /** + * A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes: ApproximateReceiveCount ApproximateFirstReceiveTimestamp MessageDeduplicationId MessageGroupId SenderId SentTimestamp SequenceNumber ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds. + */ + Attributes?: MessageSystemAttributeMap; + /** + * An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. + */ + MD5OfMessageAttributes?: String; + /** + * Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide. + */ + MessageAttributes?: MessageBodyAttributeMap; + } + export type MessageAttributeName = string; + export type MessageAttributeNameList = MessageAttributeName[]; + export interface MessageAttributeValue { + /** + * Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters. + */ + StringValue?: String; + /** + * Binary type attributes can store any binary data, such as compressed data, encrypted data, or images. + */ + BinaryValue?: Binary; + /** + * Not implemented. Reserved for future use. + */ + StringListValues?: StringList; + /** + * Not implemented. Reserved for future use. + */ + BinaryListValues?: BinaryList; + /** + * Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue. You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide. + */ + DataType: String; + } + export type MessageBodyAttributeMap = {[key: string]: MessageAttributeValue}; + export type MessageList = Message[]; + export type MessageSystemAttributeMap = {[key: string]: String}; + export type MessageSystemAttributeName = "SenderId"|"SentTimestamp"|"ApproximateReceiveCount"|"ApproximateFirstReceiveTimestamp"|"SequenceNumber"|"MessageDeduplicationId"|"MessageGroupId"|string; + export interface PurgeQueueRequest { + /** + * The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + } + export type QueueAttributeMap = {[key: string]: String}; + export type QueueAttributeName = "All"|"Policy"|"VisibilityTimeout"|"MaximumMessageSize"|"MessageRetentionPeriod"|"ApproximateNumberOfMessages"|"ApproximateNumberOfMessagesNotVisible"|"CreatedTimestamp"|"LastModifiedTimestamp"|"QueueArn"|"ApproximateNumberOfMessagesDelayed"|"DelaySeconds"|"ReceiveMessageWaitTimeSeconds"|"RedrivePolicy"|"FifoQueue"|"ContentBasedDeduplication"|"KmsMasterKeyId"|"KmsDataKeyReusePeriodSeconds"|string; + export type QueueUrlList = String[]; + export interface ReceiveMessageRequest { + /** + * The URL of the Amazon SQS queue from which messages are received. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * A list of s that need to be returned along with each message. These attributes include: All - Returns all values. ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds). ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted. SenderId For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R. For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds). MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action. MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence. SequenceNumber - Returns the value provided by Amazon SQS. + */ + AttributeNames?: AttributeNameList; + /** + * The name of the message attribute, where N is the index. The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.). The name is case-sensitive and must be unique among all attribute names for the message. The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants). The name must not start or end with a period (.), and it should not have periods in succession (..). The name can be up to 256 characters long. When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*. + */ + MessageAttributeNames?: MessageAttributeNameList; + /** + * The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1. + */ + MaxNumberOfMessages?: Integer; + /** + * The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. + */ + VisibilityTimeout?: Integer; + /** + * The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages. + */ + WaitTimeSeconds?: Integer; + /** + * This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired. You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action. When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly. If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId. You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes). During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error. To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary. While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible. If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order. The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide. + */ + ReceiveRequestAttemptId?: String; + } + export interface ReceiveMessageResult { + /** + * A list of messages. + */ + Messages?: MessageList; + } + export interface RemovePermissionRequest { + /** + * The URL of the Amazon SQS queue from which permissions are removed. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * The identification of the permission to remove. This is the label added using the AddPermission action. + */ + Label: String; + } + export interface SendMessageBatchRequest { + /** + * The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * A list of SendMessageBatchRequestEntry items. + */ + Entries: SendMessageBatchRequestEntryList; + } + export interface SendMessageBatchRequestEntry { + /** + * An identifier for a message in this batch used to communicate the result. The Ids of a batch request need to be unique within a request This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). + */ + Id: String; + /** + * The body of the message. + */ + MessageBody: String; + /** + * The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied. When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level. + */ + DelaySeconds?: Integer; + /** + * Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide. + */ + MessageAttributes?: MessageBodyAttributeMap; + /** + * This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide. Every message must have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages. Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide. + */ + MessageDeduplicationId?: String; + /** + * This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails. ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId. The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide. MessageGroupId is required for FIFO queues. You can't use it for Standard queues. + */ + MessageGroupId?: String; + } + export type SendMessageBatchRequestEntryList = SendMessageBatchRequestEntry[]; + export interface SendMessageBatchResult { + /** + * A list of SendMessageBatchResultEntry items. + */ + Successful: SendMessageBatchResultEntryList; + /** + * A list of BatchResultErrorEntry items with error details about each message that can't be enqueued. + */ + Failed: BatchResultErrorEntryList; + } + export interface SendMessageBatchResultEntry { + /** + * An identifier for the message in this batch. + */ + Id: String; + /** + * An identifier for the message. + */ + MessageId: String; + /** + * An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. + */ + MD5OfMessageBody: String; + /** + * An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. + */ + MD5OfMessageAttributes?: String; + /** + * This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message. The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId. + */ + SequenceNumber?: String; + } + export type SendMessageBatchResultEntryList = SendMessageBatchResultEntry[]; + export interface SendMessageRequest { + /** + * The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * The message to send. The maximum string size is 256 KB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. + */ + MessageBody: String; + /** + * The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies. When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level. + */ + DelaySeconds?: Integer; + /** + * Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide. + */ + MessageAttributes?: MessageBodyAttributeMap; + /** + * This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide. Every message must have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages. Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide. + */ + MessageDeduplicationId?: String; + /** + * This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails. ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId. The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide. MessageGroupId is required for FIFO queues. You can't use it for Standard queues. + */ + MessageGroupId?: String; + } + export interface SendMessageResult { + /** + * An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. + */ + MD5OfMessageBody?: String; + /** + * An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. + */ + MD5OfMessageAttributes?: String; + /** + * An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide. + */ + MessageId?: String; + /** + * This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId. + */ + SequenceNumber?: String; + } + export interface SetQueueAttributesRequest { + /** + * The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names are case-sensitive. + */ + QueueUrl: String; + /** + * A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses: DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0. MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). Default: 0. RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: an integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference. KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attribute applies only to FIFO (first-in-first-out) queues: ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide. Every message must have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. + */ + Attributes: QueueAttributeMap; + } + export type String = string; + export type StringList = String[]; + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagMap = {[key: string]: TagValue}; + export interface TagQueueRequest { + /** + * The URL of the queue. + */ + QueueUrl: String; + /** + * The list of tags to be added to the specified queue. + */ + Tags: TagMap; + } + export type TagValue = string; + export interface UntagQueueRequest { + /** + * The URL of the queue. + */ + QueueUrl: String; + /** + * The list of tags to be removed from the specified queue. + */ + TagKeys: TagKeyList; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-11-05"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SQS client. + */ + export import Types = SQS; +} +export = SQS; diff --git a/node_modules/aws-sdk/clients/sqs.js b/node_modules/aws-sdk/clients/sqs.js new file mode 100644 index 0000000..a9d0e16 --- /dev/null +++ b/node_modules/aws-sdk/clients/sqs.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['sqs'] = {}; +AWS.SQS = Service.defineService('sqs', ['2012-11-05']); +require('../lib/services/sqs'); +Object.defineProperty(apiLoader.services['sqs'], '2012-11-05', { + get: function get() { + var model = require('../apis/sqs-2012-11-05.min.json'); + model.paginators = require('../apis/sqs-2012-11-05.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SQS; diff --git a/node_modules/aws-sdk/clients/ssm.d.ts b/node_modules/aws-sdk/clients/ssm.d.ts new file mode 100644 index 0000000..39adb41 --- /dev/null +++ b/node_modules/aws-sdk/clients/ssm.d.ts @@ -0,0 +1,7776 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SSM extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SSM.Types.ClientConfiguration) + config: Config & SSM.Types.ClientConfiguration; + /** + * Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your 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. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 50 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide. + */ + addTagsToResource(params: SSM.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: SSM.Types.AddTagsToResourceResult) => void): Request; + /** + * Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your 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. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 50 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide. + */ + addTagsToResource(callback?: (err: AWSError, data: SSM.Types.AddTagsToResourceResult) => void): Request; + /** + * Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. + */ + cancelCommand(params: SSM.Types.CancelCommandRequest, callback?: (err: AWSError, data: SSM.Types.CancelCommandResult) => void): Request; + /** + * Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. + */ + cancelCommand(callback?: (err: AWSError, data: SSM.Types.CancelCommandResult) => void): Request; + /** + * Stops a Maintenance Window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.) + */ + cancelMaintenanceWindowExecution(params: SSM.Types.CancelMaintenanceWindowExecutionRequest, callback?: (err: AWSError, data: SSM.Types.CancelMaintenanceWindowExecutionResult) => void): Request; + /** + * Stops a Maintenance Window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.) + */ + cancelMaintenanceWindowExecution(callback?: (err: AWSError, data: SSM.Types.CancelMaintenanceWindowExecutionResult) => void): Request; + /** + * Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments. + */ + createActivation(params: SSM.Types.CreateActivationRequest, callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request; + /** + * Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments. + */ + createActivation(callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request; + /** + * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception. + */ + createAssociation(params: SSM.Types.CreateAssociationRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request; + /** + * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception. + */ + createAssociation(callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request; + /** + * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception. + */ + createAssociationBatch(params: SSM.Types.CreateAssociationBatchRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request; + /** + * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception. + */ + createAssociationBatch(callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request; + /** + * Creates a Systems Manager document. After you create a document, you can use CreateAssociation to associate it with one or more running instances. + */ + createDocument(params: SSM.Types.CreateDocumentRequest, callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request; + /** + * Creates a Systems Manager document. After you create a document, you can use CreateAssociation to associate it with one or more running instances. + */ + createDocument(callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request; + /** + * Creates a new Maintenance Window. + */ + createMaintenanceWindow(params: SSM.Types.CreateMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.CreateMaintenanceWindowResult) => void): Request; + /** + * Creates a new Maintenance Window. + */ + createMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.CreateMaintenanceWindowResult) => void): Request; + /** + * Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter. + */ + createPatchBaseline(params: SSM.Types.CreatePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.CreatePatchBaselineResult) => void): Request; + /** + * Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter. + */ + createPatchBaseline(callback?: (err: AWSError, data: SSM.Types.CreatePatchBaselineResult) => void): Request; + /** + * Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide. + */ + createResourceDataSync(params: SSM.Types.CreateResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.CreateResourceDataSyncResult) => void): Request; + /** + * Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide. + */ + createResourceDataSync(callback?: (err: AWSError, data: SSM.Types.CreateResourceDataSyncResult) => void): Request; + /** + * Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances. + */ + deleteActivation(params: SSM.Types.DeleteActivationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request; + /** + * Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances. + */ + deleteActivation(callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request; + /** + * Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. + */ + deleteAssociation(params: SSM.Types.DeleteAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request; + /** + * Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. + */ + deleteAssociation(callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request; + /** + * Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document. + */ + deleteDocument(params: SSM.Types.DeleteDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request; + /** + * Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document. + */ + deleteDocument(callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request; + /** + * Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema. + */ + deleteInventory(params: SSM.Types.DeleteInventoryRequest, callback?: (err: AWSError, data: SSM.Types.DeleteInventoryResult) => void): Request; + /** + * Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema. + */ + deleteInventory(callback?: (err: AWSError, data: SSM.Types.DeleteInventoryResult) => void): Request; + /** + * Deletes a Maintenance Window. + */ + deleteMaintenanceWindow(params: SSM.Types.DeleteMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeleteMaintenanceWindowResult) => void): Request; + /** + * Deletes a Maintenance Window. + */ + deleteMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeleteMaintenanceWindowResult) => void): Request; + /** + * Delete a parameter from the system. + */ + deleteParameter(params: SSM.Types.DeleteParameterRequest, callback?: (err: AWSError, data: SSM.Types.DeleteParameterResult) => void): Request; + /** + * Delete a parameter from the system. + */ + deleteParameter(callback?: (err: AWSError, data: SSM.Types.DeleteParameterResult) => void): Request; + /** + * Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console. + */ + deleteParameters(params: SSM.Types.DeleteParametersRequest, callback?: (err: AWSError, data: SSM.Types.DeleteParametersResult) => void): Request; + /** + * Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console. + */ + deleteParameters(callback?: (err: AWSError, data: SSM.Types.DeleteParametersResult) => void): Request; + /** + * Deletes a patch baseline. + */ + deletePatchBaseline(params: SSM.Types.DeletePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.DeletePatchBaselineResult) => void): Request; + /** + * Deletes a patch baseline. + */ + deletePatchBaseline(callback?: (err: AWSError, data: SSM.Types.DeletePatchBaselineResult) => void): Request; + /** + * Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket. + */ + deleteResourceDataSync(params: SSM.Types.DeleteResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.DeleteResourceDataSyncResult) => void): Request; + /** + * Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket. + */ + deleteResourceDataSync(callback?: (err: AWSError, data: SSM.Types.DeleteResourceDataSyncResult) => void): Request; + /** + * Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first. + */ + deregisterManagedInstance(params: SSM.Types.DeregisterManagedInstanceRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request; + /** + * Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first. + */ + deregisterManagedInstance(callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request; + /** + * Removes a patch group from a patch baseline. + */ + deregisterPatchBaselineForPatchGroup(params: SSM.Types.DeregisterPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterPatchBaselineForPatchGroupResult) => void): Request; + /** + * Removes a patch group from a patch baseline. + */ + deregisterPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.DeregisterPatchBaselineForPatchGroupResult) => void): Request; + /** + * Removes a target from a Maintenance Window. + */ + deregisterTargetFromMaintenanceWindow(params: SSM.Types.DeregisterTargetFromMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterTargetFromMaintenanceWindowResult) => void): Request; + /** + * Removes a target from a Maintenance Window. + */ + deregisterTargetFromMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeregisterTargetFromMaintenanceWindowResult) => void): Request; + /** + * Removes a task from a Maintenance Window. + */ + deregisterTaskFromMaintenanceWindow(params: SSM.Types.DeregisterTaskFromMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterTaskFromMaintenanceWindowResult) => void): Request; + /** + * Removes a task from a Maintenance Window. + */ + deregisterTaskFromMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeregisterTaskFromMaintenanceWindowResult) => void): Request; + /** + * Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration. + */ + describeActivations(params: SSM.Types.DescribeActivationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request; + /** + * Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration. + */ + describeActivations(callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request; + /** + * Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID. + */ + describeAssociation(params: SSM.Types.DescribeAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request; + /** + * Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID. + */ + describeAssociation(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request; + /** + * Use this API action to view information about a specific execution of a specific association. + */ + describeAssociationExecutionTargets(params: SSM.Types.DescribeAssociationExecutionTargetsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionTargetsResult) => void): Request; + /** + * Use this API action to view information about a specific execution of a specific association. + */ + describeAssociationExecutionTargets(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionTargetsResult) => void): Request; + /** + * Use this API action to view all executions for a specific association ID. + */ + describeAssociationExecutions(params: SSM.Types.DescribeAssociationExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionsResult) => void): Request; + /** + * Use this API action to view all executions for a specific association ID. + */ + describeAssociationExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionsResult) => void): Request; + /** + * Provides details about all active and terminated Automation executions. + */ + describeAutomationExecutions(params: SSM.Types.DescribeAutomationExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAutomationExecutionsResult) => void): Request; + /** + * Provides details about all active and terminated Automation executions. + */ + describeAutomationExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAutomationExecutionsResult) => void): Request; + /** + * Information about all active and terminated step executions in an Automation workflow. + */ + describeAutomationStepExecutions(params: SSM.Types.DescribeAutomationStepExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAutomationStepExecutionsResult) => void): Request; + /** + * Information about all active and terminated step executions in an Automation workflow. + */ + describeAutomationStepExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAutomationStepExecutionsResult) => void): Request; + /** + * Lists all patches that could possibly be included in a patch baseline. + */ + describeAvailablePatches(params: SSM.Types.DescribeAvailablePatchesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAvailablePatchesResult) => void): Request; + /** + * Lists all patches that could possibly be included in a patch baseline. + */ + describeAvailablePatches(callback?: (err: AWSError, data: SSM.Types.DescribeAvailablePatchesResult) => void): Request; + /** + * Describes the specified Systems Manager document. + */ + describeDocument(params: SSM.Types.DescribeDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request; + /** + * Describes the specified Systems Manager document. + */ + describeDocument(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request; + /** + * Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All). + */ + describeDocumentPermission(params: SSM.Types.DescribeDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request; + /** + * Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All). + */ + describeDocumentPermission(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request; + /** + * All associations for the instance(s). + */ + describeEffectiveInstanceAssociations(params: SSM.Types.DescribeEffectiveInstanceAssociationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeEffectiveInstanceAssociationsResult) => void): Request; + /** + * All associations for the instance(s). + */ + describeEffectiveInstanceAssociations(callback?: (err: AWSError, data: SSM.Types.DescribeEffectiveInstanceAssociationsResult) => void): Request; + /** + * Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines. + */ + describeEffectivePatchesForPatchBaseline(params: SSM.Types.DescribeEffectivePatchesForPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.DescribeEffectivePatchesForPatchBaselineResult) => void): Request; + /** + * Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines. + */ + describeEffectivePatchesForPatchBaseline(callback?: (err: AWSError, data: SSM.Types.DescribeEffectivePatchesForPatchBaselineResult) => void): Request; + /** + * The status of the associations for the instance(s). + */ + describeInstanceAssociationsStatus(params: SSM.Types.DescribeInstanceAssociationsStatusRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstanceAssociationsStatusResult) => void): Request; + /** + * The status of the associations for the instance(s). + */ + describeInstanceAssociationsStatus(callback?: (err: AWSError, data: SSM.Types.DescribeInstanceAssociationsStatusResult) => void): Request; + /** + * Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances. + */ + describeInstanceInformation(params: SSM.Types.DescribeInstanceInformationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request; + /** + * Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances. + */ + describeInstanceInformation(callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request; + /** + * Retrieves the high-level patch state of one or more instances. + */ + describeInstancePatchStates(params: SSM.Types.DescribeInstancePatchStatesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesResult) => void): Request; + /** + * Retrieves the high-level patch state of one or more instances. + */ + describeInstancePatchStates(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesResult) => void): Request; + /** + * Retrieves the high-level patch state for the instances in the specified patch group. + */ + describeInstancePatchStatesForPatchGroup(params: SSM.Types.DescribeInstancePatchStatesForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesForPatchGroupResult) => void): Request; + /** + * Retrieves the high-level patch state for the instances in the specified patch group. + */ + describeInstancePatchStatesForPatchGroup(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesForPatchGroupResult) => void): Request; + /** + * Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance. + */ + describeInstancePatches(params: SSM.Types.DescribeInstancePatchesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchesResult) => void): Request; + /** + * Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance. + */ + describeInstancePatches(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchesResult) => void): Request; + /** + * Describes a specific delete inventory operation. + */ + describeInventoryDeletions(params: SSM.Types.DescribeInventoryDeletionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInventoryDeletionsResult) => void): Request; + /** + * Describes a specific delete inventory operation. + */ + describeInventoryDeletions(callback?: (err: AWSError, data: SSM.Types.DescribeInventoryDeletionsResult) => void): Request; + /** + * Retrieves the individual task executions (one per target) for a particular task run as part of a Maintenance Window execution. + */ + describeMaintenanceWindowExecutionTaskInvocations(params: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult) => void): Request; + /** + * Retrieves the individual task executions (one per target) for a particular task run as part of a Maintenance Window execution. + */ + describeMaintenanceWindowExecutionTaskInvocations(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult) => void): Request; + /** + * For a given Maintenance Window execution, lists the tasks that were run. + */ + describeMaintenanceWindowExecutionTasks(params: SSM.Types.DescribeMaintenanceWindowExecutionTasksRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTasksResult) => void): Request; + /** + * For a given Maintenance Window execution, lists the tasks that were run. + */ + describeMaintenanceWindowExecutionTasks(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTasksResult) => void): Request; + /** + * Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window. + */ + describeMaintenanceWindowExecutions(params: SSM.Types.DescribeMaintenanceWindowExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionsResult) => void): Request; + /** + * Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window. + */ + describeMaintenanceWindowExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionsResult) => void): Request; + /** + * Retrieves information about upcoming executions of a Maintenance Window. + */ + describeMaintenanceWindowSchedule(params: SSM.Types.DescribeMaintenanceWindowScheduleRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowScheduleResult) => void): Request; + /** + * Retrieves information about upcoming executions of a Maintenance Window. + */ + describeMaintenanceWindowSchedule(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowScheduleResult) => void): Request; + /** + * Lists the targets registered with the Maintenance Window. + */ + describeMaintenanceWindowTargets(params: SSM.Types.DescribeMaintenanceWindowTargetsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTargetsResult) => void): Request; + /** + * Lists the targets registered with the Maintenance Window. + */ + describeMaintenanceWindowTargets(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTargetsResult) => void): Request; + /** + * Lists the tasks in a Maintenance Window. + */ + describeMaintenanceWindowTasks(params: SSM.Types.DescribeMaintenanceWindowTasksRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTasksResult) => void): Request; + /** + * Lists the tasks in a Maintenance Window. + */ + describeMaintenanceWindowTasks(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTasksResult) => void): Request; + /** + * Retrieves the Maintenance Windows in an AWS account. + */ + describeMaintenanceWindows(params: SSM.Types.DescribeMaintenanceWindowsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsResult) => void): Request; + /** + * Retrieves the Maintenance Windows in an AWS account. + */ + describeMaintenanceWindows(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsResult) => void): Request; + /** + * Retrieves information about the Maintenance Windows targets or tasks that an instance is associated with. + */ + describeMaintenanceWindowsForTarget(params: SSM.Types.DescribeMaintenanceWindowsForTargetRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsForTargetResult) => void): Request; + /** + * Retrieves information about the Maintenance Windows targets or tasks that an instance is associated with. + */ + describeMaintenanceWindowsForTarget(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsForTargetResult) => void): Request; + /** + * Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. + */ + describeParameters(params: SSM.Types.DescribeParametersRequest, callback?: (err: AWSError, data: SSM.Types.DescribeParametersResult) => void): Request; + /** + * Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. + */ + describeParameters(callback?: (err: AWSError, data: SSM.Types.DescribeParametersResult) => void): Request; + /** + * Lists the patch baselines in your AWS account. + */ + describePatchBaselines(params: SSM.Types.DescribePatchBaselinesRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchBaselinesResult) => void): Request; + /** + * Lists the patch baselines in your AWS account. + */ + describePatchBaselines(callback?: (err: AWSError, data: SSM.Types.DescribePatchBaselinesResult) => void): Request; + /** + * Returns high-level aggregated patch compliance state for a patch group. + */ + describePatchGroupState(params: SSM.Types.DescribePatchGroupStateRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupStateResult) => void): Request; + /** + * Returns high-level aggregated patch compliance state for a patch group. + */ + describePatchGroupState(callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupStateResult) => void): Request; + /** + * Lists all patch groups that have been registered with patch baselines. + */ + describePatchGroups(params: SSM.Types.DescribePatchGroupsRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupsResult) => void): Request; + /** + * Lists all patch groups that have been registered with patch baselines. + */ + describePatchGroups(callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupsResult) => void): Request; + /** + * Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines. The following section lists the properties that can be used in filters for each major operating system type: WINDOWS Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY AMAZON_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT, CLASSIFICATION, SEVERITY UBUNTU Valid properties: PRODUCT, PRIORITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY SUSE Valid properties: PRODUCT, CLASSIFICATION, SEVERITY CENTOS Valid properties: PRODUCT, CLASSIFICATION, SEVERITY + */ + describePatchProperties(params: SSM.Types.DescribePatchPropertiesRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchPropertiesResult) => void): Request; + /** + * Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines. The following section lists the properties that can be used in filters for each major operating system type: WINDOWS Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY AMAZON_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT, CLASSIFICATION, SEVERITY UBUNTU Valid properties: PRODUCT, PRIORITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY SUSE Valid properties: PRODUCT, CLASSIFICATION, SEVERITY CENTOS Valid properties: PRODUCT, CLASSIFICATION, SEVERITY + */ + describePatchProperties(callback?: (err: AWSError, data: SSM.Types.DescribePatchPropertiesResult) => void): Request; + /** + * Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days. + */ + describeSessions(params: SSM.Types.DescribeSessionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeSessionsResponse) => void): Request; + /** + * Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days. + */ + describeSessions(callback?: (err: AWSError, data: SSM.Types.DescribeSessionsResponse) => void): Request; + /** + * Get detailed information about a particular Automation execution. + */ + getAutomationExecution(params: SSM.Types.GetAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.GetAutomationExecutionResult) => void): Request; + /** + * Get detailed information about a particular Automation execution. + */ + getAutomationExecution(callback?: (err: AWSError, data: SSM.Types.GetAutomationExecutionResult) => void): Request; + /** + * Returns detailed information about command execution for an invocation or plugin. + */ + getCommandInvocation(params: SSM.Types.GetCommandInvocationRequest, callback?: (err: AWSError, data: SSM.Types.GetCommandInvocationResult) => void): Request; + /** + * Returns detailed information about command execution for an invocation or plugin. + */ + getCommandInvocation(callback?: (err: AWSError, data: SSM.Types.GetCommandInvocationResult) => void): Request; + /** + * Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections. + */ + getConnectionStatus(params: SSM.Types.GetConnectionStatusRequest, callback?: (err: AWSError, data: SSM.Types.GetConnectionStatusResponse) => void): Request; + /** + * Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections. + */ + getConnectionStatus(callback?: (err: AWSError, data: SSM.Types.GetConnectionStatusResponse) => void): Request; + /** + * Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned. + */ + getDefaultPatchBaseline(params: SSM.Types.GetDefaultPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.GetDefaultPatchBaselineResult) => void): Request; + /** + * Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned. + */ + getDefaultPatchBaseline(callback?: (err: AWSError, data: SSM.Types.GetDefaultPatchBaselineResult) => void): Request; + /** + * Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document. + */ + getDeployablePatchSnapshotForInstance(params: SSM.Types.GetDeployablePatchSnapshotForInstanceRequest, callback?: (err: AWSError, data: SSM.Types.GetDeployablePatchSnapshotForInstanceResult) => void): Request; + /** + * Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document. + */ + getDeployablePatchSnapshotForInstance(callback?: (err: AWSError, data: SSM.Types.GetDeployablePatchSnapshotForInstanceResult) => void): Request; + /** + * Gets the contents of the specified Systems Manager document. + */ + getDocument(params: SSM.Types.GetDocumentRequest, callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request; + /** + * Gets the contents of the specified Systems Manager document. + */ + getDocument(callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request; + /** + * Query inventory information. + */ + getInventory(params: SSM.Types.GetInventoryRequest, callback?: (err: AWSError, data: SSM.Types.GetInventoryResult) => void): Request; + /** + * Query inventory information. + */ + getInventory(callback?: (err: AWSError, data: SSM.Types.GetInventoryResult) => void): Request; + /** + * Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type. + */ + getInventorySchema(params: SSM.Types.GetInventorySchemaRequest, callback?: (err: AWSError, data: SSM.Types.GetInventorySchemaResult) => void): Request; + /** + * Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type. + */ + getInventorySchema(callback?: (err: AWSError, data: SSM.Types.GetInventorySchemaResult) => void): Request; + /** + * Retrieves a Maintenance Window. + */ + getMaintenanceWindow(params: SSM.Types.GetMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowResult) => void): Request; + /** + * Retrieves a Maintenance Window. + */ + getMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowResult) => void): Request; + /** + * Retrieves details about a specific task run as part of a Maintenance Window execution. + */ + getMaintenanceWindowExecution(params: SSM.Types.GetMaintenanceWindowExecutionRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionResult) => void): Request; + /** + * Retrieves details about a specific task run as part of a Maintenance Window execution. + */ + getMaintenanceWindowExecution(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionResult) => void): Request; + /** + * Retrieves the details about a specific task run as part of a Maintenance Window execution. + */ + getMaintenanceWindowExecutionTask(params: SSM.Types.GetMaintenanceWindowExecutionTaskRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskResult) => void): Request; + /** + * Retrieves the details about a specific task run as part of a Maintenance Window execution. + */ + getMaintenanceWindowExecutionTask(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskResult) => void): Request; + /** + * Retrieves a task invocation. A task invocation is a specific task running on a specific target. Maintenance Windows report status for all invocations. + */ + getMaintenanceWindowExecutionTaskInvocation(params: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult) => void): Request; + /** + * Retrieves a task invocation. A task invocation is a specific task running on a specific target. Maintenance Windows report status for all invocations. + */ + getMaintenanceWindowExecutionTaskInvocation(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult) => void): Request; + /** + * Lists the tasks in a Maintenance Window. + */ + getMaintenanceWindowTask(params: SSM.Types.GetMaintenanceWindowTaskRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowTaskResult) => void): Request; + /** + * Lists the tasks in a Maintenance Window. + */ + getMaintenanceWindowTask(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowTaskResult) => void): Request; + /** + * Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action. + */ + getParameter(params: SSM.Types.GetParameterRequest, callback?: (err: AWSError, data: SSM.Types.GetParameterResult) => void): Request; + /** + * Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action. + */ + getParameter(callback?: (err: AWSError, data: SSM.Types.GetParameterResult) => void): Request; + /** + * Query a list of all parameters used by the AWS account. + */ + getParameterHistory(params: SSM.Types.GetParameterHistoryRequest, callback?: (err: AWSError, data: SSM.Types.GetParameterHistoryResult) => void): Request; + /** + * Query a list of all parameters used by the AWS account. + */ + getParameterHistory(callback?: (err: AWSError, data: SSM.Types.GetParameterHistoryResult) => void): Request; + /** + * Get details of a parameter. Don't confuse this API action with the GetParameter API action. + */ + getParameters(params: SSM.Types.GetParametersRequest, callback?: (err: AWSError, data: SSM.Types.GetParametersResult) => void): Request; + /** + * Get details of a parameter. Don't confuse this API action with the GetParameter API action. + */ + getParameters(callback?: (err: AWSError, data: SSM.Types.GetParametersResult) => void): Request; + /** + * Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. This API action doesn't support filtering by tags. + */ + getParametersByPath(params: SSM.Types.GetParametersByPathRequest, callback?: (err: AWSError, data: SSM.Types.GetParametersByPathResult) => void): Request; + /** + * Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. This API action doesn't support filtering by tags. + */ + getParametersByPath(callback?: (err: AWSError, data: SSM.Types.GetParametersByPathResult) => void): Request; + /** + * Retrieves information about a patch baseline. + */ + getPatchBaseline(params: SSM.Types.GetPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineResult) => void): Request; + /** + * Retrieves information about a patch baseline. + */ + getPatchBaseline(callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineResult) => void): Request; + /** + * Retrieves the patch baseline that should be used for the specified patch group. + */ + getPatchBaselineForPatchGroup(params: SSM.Types.GetPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineForPatchGroupResult) => void): Request; + /** + * Retrieves the patch baseline that should be used for the specified patch group. + */ + getPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineForPatchGroupResult) => void): Request; + /** + * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Query the current service setting for the account. + */ + getServiceSetting(params: SSM.Types.GetServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.GetServiceSettingResult) => void): Request; + /** + * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Query the current service setting for the account. + */ + getServiceSetting(callback?: (err: AWSError, data: SSM.Types.GetServiceSettingResult) => void): Request; + /** + * A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels. + */ + labelParameterVersion(params: SSM.Types.LabelParameterVersionRequest, callback?: (err: AWSError, data: SSM.Types.LabelParameterVersionResult) => void): Request; + /** + * A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels. + */ + labelParameterVersion(callback?: (err: AWSError, data: SSM.Types.LabelParameterVersionResult) => void): Request; + /** + * Retrieves all versions of an association for a specific association ID. + */ + listAssociationVersions(params: SSM.Types.ListAssociationVersionsRequest, callback?: (err: AWSError, data: SSM.Types.ListAssociationVersionsResult) => void): Request; + /** + * Retrieves all versions of an association for a specific association ID. + */ + listAssociationVersions(callback?: (err: AWSError, data: SSM.Types.ListAssociationVersionsResult) => void): Request; + /** + * Lists the associations for the specified Systems Manager document or instance. + */ + listAssociations(params: SSM.Types.ListAssociationsRequest, callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request; + /** + * Lists the associations for the specified Systems Manager document or instance. + */ + listAssociations(callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request; + /** + * An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. + */ + listCommandInvocations(params: SSM.Types.ListCommandInvocationsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request; + /** + * An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. + */ + listCommandInvocations(callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request; + /** + * Lists the commands requested by users of the AWS account. + */ + listCommands(params: SSM.Types.ListCommandsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request; + /** + * Lists the commands requested by users of the AWS account. + */ + listCommands(callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request; + /** + * For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter. + */ + listComplianceItems(params: SSM.Types.ListComplianceItemsRequest, callback?: (err: AWSError, data: SSM.Types.ListComplianceItemsResult) => void): Request; + /** + * For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter. + */ + listComplianceItems(callback?: (err: AWSError, data: SSM.Types.ListComplianceItemsResult) => void): Request; + /** + * Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify. + */ + listComplianceSummaries(params: SSM.Types.ListComplianceSummariesRequest, callback?: (err: AWSError, data: SSM.Types.ListComplianceSummariesResult) => void): Request; + /** + * Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify. + */ + listComplianceSummaries(callback?: (err: AWSError, data: SSM.Types.ListComplianceSummariesResult) => void): Request; + /** + * List all versions for a document. + */ + listDocumentVersions(params: SSM.Types.ListDocumentVersionsRequest, callback?: (err: AWSError, data: SSM.Types.ListDocumentVersionsResult) => void): Request; + /** + * List all versions for a document. + */ + listDocumentVersions(callback?: (err: AWSError, data: SSM.Types.ListDocumentVersionsResult) => void): Request; + /** + * Describes one or more of your Systems Manager documents. + */ + listDocuments(params: SSM.Types.ListDocumentsRequest, callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request; + /** + * Describes one or more of your Systems Manager documents. + */ + listDocuments(callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request; + /** + * A list of inventory items returned by the request. + */ + listInventoryEntries(params: SSM.Types.ListInventoryEntriesRequest, callback?: (err: AWSError, data: SSM.Types.ListInventoryEntriesResult) => void): Request; + /** + * A list of inventory items returned by the request. + */ + listInventoryEntries(callback?: (err: AWSError, data: SSM.Types.ListInventoryEntriesResult) => void): Request; + /** + * Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify. + */ + listResourceComplianceSummaries(params: SSM.Types.ListResourceComplianceSummariesRequest, callback?: (err: AWSError, data: SSM.Types.ListResourceComplianceSummariesResult) => void): Request; + /** + * Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify. + */ + listResourceComplianceSummaries(callback?: (err: AWSError, data: SSM.Types.ListResourceComplianceSummariesResult) => void): Request; + /** + * Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call. + */ + listResourceDataSync(params: SSM.Types.ListResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.ListResourceDataSyncResult) => void): Request; + /** + * Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call. + */ + listResourceDataSync(callback?: (err: AWSError, data: SSM.Types.ListResourceDataSyncResult) => void): Request; + /** + * Returns a list of the tags assigned to the specified resource. + */ + listTagsForResource(params: SSM.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request; + /** + * Returns a list of the tags assigned to the specified resource. + */ + listTagsForResource(callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request; + /** + * Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID. + */ + modifyDocumentPermission(params: SSM.Types.ModifyDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request; + /** + * Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID. + */ + modifyDocumentPermission(callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request; + /** + * Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, critical. DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z' + */ + putComplianceItems(params: SSM.Types.PutComplianceItemsRequest, callback?: (err: AWSError, data: SSM.Types.PutComplianceItemsResult) => void): Request; + /** + * Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, critical. DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z' + */ + putComplianceItems(callback?: (err: AWSError, data: SSM.Types.PutComplianceItemsResult) => void): Request; + /** + * Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist. + */ + putInventory(params: SSM.Types.PutInventoryRequest, callback?: (err: AWSError, data: SSM.Types.PutInventoryResult) => void): Request; + /** + * Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist. + */ + putInventory(callback?: (err: AWSError, data: SSM.Types.PutInventoryResult) => void): Request; + /** + * Add a parameter to the system. + */ + putParameter(params: SSM.Types.PutParameterRequest, callback?: (err: AWSError, data: SSM.Types.PutParameterResult) => void): Request; + /** + * Add a parameter to the system. + */ + putParameter(callback?: (err: AWSError, data: SSM.Types.PutParameterResult) => void): Request; + /** + * Defines the default patch baseline. + */ + registerDefaultPatchBaseline(params: SSM.Types.RegisterDefaultPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.RegisterDefaultPatchBaselineResult) => void): Request; + /** + * Defines the default patch baseline. + */ + registerDefaultPatchBaseline(callback?: (err: AWSError, data: SSM.Types.RegisterDefaultPatchBaselineResult) => void): Request; + /** + * Registers a patch baseline for a patch group. + */ + registerPatchBaselineForPatchGroup(params: SSM.Types.RegisterPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.RegisterPatchBaselineForPatchGroupResult) => void): Request; + /** + * Registers a patch baseline for a patch group. + */ + registerPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.RegisterPatchBaselineForPatchGroupResult) => void): Request; + /** + * Registers a target with a Maintenance Window. + */ + registerTargetWithMaintenanceWindow(params: SSM.Types.RegisterTargetWithMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.RegisterTargetWithMaintenanceWindowResult) => void): Request; + /** + * Registers a target with a Maintenance Window. + */ + registerTargetWithMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.RegisterTargetWithMaintenanceWindowResult) => void): Request; + /** + * Adds a new task to a Maintenance Window. + */ + registerTaskWithMaintenanceWindow(params: SSM.Types.RegisterTaskWithMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.RegisterTaskWithMaintenanceWindowResult) => void): Request; + /** + * Adds a new task to a Maintenance Window. + */ + registerTaskWithMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.RegisterTaskWithMaintenanceWindowResult) => void): Request; + /** + * Removes all tags from the specified resource. + */ + removeTagsFromResource(params: SSM.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request; + /** + * Removes all tags from the specified resource. + */ + removeTagsFromResource(callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request; + /** + * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting. Reset the service setting for the account to the default value as provisioned by the AWS service team. + */ + resetServiceSetting(params: SSM.Types.ResetServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.ResetServiceSettingResult) => void): Request; + /** + * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting. Reset the service setting for the account to the default value as provisioned by the AWS service team. + */ + resetServiceSetting(callback?: (err: AWSError, data: SSM.Types.ResetServiceSettingResult) => void): Request; + /** + * Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use. + */ + resumeSession(params: SSM.Types.ResumeSessionRequest, callback?: (err: AWSError, data: SSM.Types.ResumeSessionResponse) => void): Request; + /** + * Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use. + */ + resumeSession(callback?: (err: AWSError, data: SSM.Types.ResumeSessionResponse) => void): Request; + /** + * Sends a signal to an Automation execution to change the current behavior or status of the execution. + */ + sendAutomationSignal(params: SSM.Types.SendAutomationSignalRequest, callback?: (err: AWSError, data: SSM.Types.SendAutomationSignalResult) => void): Request; + /** + * Sends a signal to an Automation execution to change the current behavior or status of the execution. + */ + sendAutomationSignal(callback?: (err: AWSError, data: SSM.Types.SendAutomationSignalResult) => void): Request; + /** + * Runs commands on one or more managed instances. + */ + sendCommand(params: SSM.Types.SendCommandRequest, callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request; + /** + * Runs commands on one or more managed instances. + */ + sendCommand(callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request; + /** + * Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations. + */ + startAssociationsOnce(params: SSM.Types.StartAssociationsOnceRequest, callback?: (err: AWSError, data: SSM.Types.StartAssociationsOnceResult) => void): Request; + /** + * Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations. + */ + startAssociationsOnce(callback?: (err: AWSError, data: SSM.Types.StartAssociationsOnceResult) => void): Request; + /** + * Initiates execution of an Automation document. + */ + startAutomationExecution(params: SSM.Types.StartAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.StartAutomationExecutionResult) => void): Request; + /** + * Initiates execution of an Automation document. + */ + startAutomationExecution(callback?: (err: AWSError, data: SSM.Types.StartAutomationExecutionResult) => void): Request; + /** + * Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide. + */ + startSession(params: SSM.Types.StartSessionRequest, callback?: (err: AWSError, data: SSM.Types.StartSessionResponse) => void): Request; + /** + * Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide. + */ + startSession(callback?: (err: AWSError, data: SSM.Types.StartSessionResponse) => void): Request; + /** + * Stop an Automation that is currently running. + */ + stopAutomationExecution(params: SSM.Types.StopAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.StopAutomationExecutionResult) => void): Request; + /** + * Stop an Automation that is currently running. + */ + stopAutomationExecution(callback?: (err: AWSError, data: SSM.Types.StopAutomationExecutionResult) => void): Request; + /** + * Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed. + */ + terminateSession(params: SSM.Types.TerminateSessionRequest, callback?: (err: AWSError, data: SSM.Types.TerminateSessionResponse) => void): Request; + /** + * Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed. + */ + terminateSession(callback?: (err: AWSError, data: SSM.Types.TerminateSessionResponse) => void): Request; + /** + * Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. When you update an association, the association immediately runs against the specified targets. + */ + updateAssociation(params: SSM.Types.UpdateAssociationRequest, callback?: (err: AWSError, data: SSM.Types.UpdateAssociationResult) => void): Request; + /** + * Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. When you update an association, the association immediately runs against the specified targets. + */ + updateAssociation(callback?: (err: AWSError, data: SSM.Types.UpdateAssociationResult) => void): Request; + /** + * Updates the status of the Systems Manager document associated with the specified instance. + */ + updateAssociationStatus(params: SSM.Types.UpdateAssociationStatusRequest, callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request; + /** + * Updates the status of the Systems Manager document associated with the specified instance. + */ + updateAssociationStatus(callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request; + /** + * The document you want to update. + */ + updateDocument(params: SSM.Types.UpdateDocumentRequest, callback?: (err: AWSError, data: SSM.Types.UpdateDocumentResult) => void): Request; + /** + * The document you want to update. + */ + updateDocument(callback?: (err: AWSError, data: SSM.Types.UpdateDocumentResult) => void): Request; + /** + * Set the default version of a document. + */ + updateDocumentDefaultVersion(params: SSM.Types.UpdateDocumentDefaultVersionRequest, callback?: (err: AWSError, data: SSM.Types.UpdateDocumentDefaultVersionResult) => void): Request; + /** + * Set the default version of a document. + */ + updateDocumentDefaultVersion(callback?: (err: AWSError, data: SSM.Types.UpdateDocumentDefaultVersionResult) => void): Request; + /** + * Updates an existing Maintenance Window. Only specified parameters are modified. + */ + updateMaintenanceWindow(params: SSM.Types.UpdateMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowResult) => void): Request; + /** + * Updates an existing Maintenance Window. Only specified parameters are modified. + */ + updateMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowResult) => void): Request; + /** + * Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following: The target from being an ID target to a Tag target, or a Tag target to an ID target. IDs for an ID target. Tags for a Tag target. Owner. Name. Description. If a parameter is null, then the corresponding field is not modified. + */ + updateMaintenanceWindowTarget(params: SSM.Types.UpdateMaintenanceWindowTargetRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTargetResult) => void): Request; + /** + * Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following: The target from being an ID target to a Tag target, or a Tag target to an ID target. IDs for an ID target. Tags for a Tag target. Owner. Name. Description. If a parameter is null, then the corresponding field is not modified. + */ + updateMaintenanceWindowTarget(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTargetResult) => void): Request; + /** + * Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null. + */ + updateMaintenanceWindowTask(params: SSM.Types.UpdateMaintenanceWindowTaskRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTaskResult) => void): Request; + /** + * Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null. + */ + updateMaintenanceWindowTask(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTaskResult) => void): Request; + /** + * Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance. + */ + updateManagedInstanceRole(params: SSM.Types.UpdateManagedInstanceRoleRequest, callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request; + /** + * Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance. + */ + updateManagedInstanceRole(callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request; + /** + * Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter. + */ + updatePatchBaseline(params: SSM.Types.UpdatePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.UpdatePatchBaselineResult) => void): Request; + /** + * Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter. + */ + updatePatchBaseline(callback?: (err: AWSError, data: SSM.Types.UpdatePatchBaselineResult) => void): Request; + /** + * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Update the service setting for the account. + */ + updateServiceSetting(params: SSM.Types.UpdateServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.UpdateServiceSettingResult) => void): Request; + /** + * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Update the service setting for the account. + */ + updateServiceSetting(callback?: (err: AWSError, data: SSM.Types.UpdateServiceSettingResult) => void): Request; +} +declare namespace SSM { + export type Account = string; + export type AccountId = string; + export type AccountIdList = AccountId[]; + export type Accounts = Account[]; + export interface Activation { + /** + * The ID created by Systems Manager when you submitted the activation. + */ + ActivationId?: ActivationId; + /** + * A user defined description of the activation. + */ + Description?: ActivationDescription; + /** + * A name for the managed instance when it is created. + */ + DefaultInstanceName?: DefaultInstanceName; + /** + * The Amazon Identity and Access Management (IAM) role to assign to the managed instance. + */ + IamRole?: IamRole; + /** + * The maximum number of managed instances that can be registered using this activation. + */ + RegistrationLimit?: RegistrationLimit; + /** + * The number of managed instances already registered with this activation. + */ + RegistrationsCount?: RegistrationsCount; + /** + * The date when this activation can no longer be used to register managed instances. + */ + ExpirationDate?: ExpirationDate; + /** + * Whether or not the activation is expired. + */ + Expired?: Boolean; + /** + * The date the activation was created. + */ + CreatedDate?: CreatedDate; + /** + * Tags assigned to the activation. + */ + Tags?: TagList; + } + export type ActivationCode = string; + export type ActivationDescription = string; + export type ActivationId = string; + export type ActivationList = Activation[]; + export interface AddTagsToResourceRequest { + /** + * Specifies the type of resource you are tagging. The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f. + */ + ResourceType: ResourceTypeForTagging; + /** + * The resource ID you want to tag. Use the ID of the resource. Here are some examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde For the Document and Parameter values, use the name of the resource. The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f. + */ + ResourceId: ResourceId; + /** + * One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. Do not enter personally identifiable information in this field. + */ + Tags: TagList; + } + export interface AddTagsToResourceResult { + } + export type AgentErrorCode = string; + export type AggregatorSchemaOnly = boolean; + export type AllowedPattern = string; + export type ApproveAfterDays = number; + export interface Association { + /** + * The name of the Systems Manager document. + */ + Name?: DocumentARN; + /** + * The ID of the instance. + */ + InstanceId?: InstanceId; + /** + * The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule. + */ + AssociationId?: AssociationId; + /** + * The association version. + */ + AssociationVersion?: AssociationVersion; + /** + * The version of the document used in the association. + */ + DocumentVersion?: DocumentVersion; + /** + * The instances targeted by the request to create an association. + */ + Targets?: Targets; + /** + * The date on which the association was last run. + */ + LastExecutionDate?: DateTime; + /** + * Information about the association. + */ + Overview?: AssociationOverview; + /** + * A cron expression that specifies a schedule when the association runs. + */ + ScheduleExpression?: ScheduleExpression; + /** + * The association name. + */ + AssociationName?: AssociationName; + } + export type AssociationComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"UNSPECIFIED"|string; + export interface AssociationDescription { + /** + * The name of the Systems Manager document. + */ + Name?: DocumentARN; + /** + * The ID of the instance. + */ + InstanceId?: InstanceId; + /** + * The association version. + */ + AssociationVersion?: AssociationVersion; + /** + * The date when the association was made. + */ + Date?: DateTime; + /** + * The date when the association was last updated. + */ + LastUpdateAssociationDate?: DateTime; + /** + * The association status. + */ + Status?: AssociationStatus; + /** + * Information about the association. + */ + Overview?: AssociationOverview; + /** + * The document version. + */ + DocumentVersion?: DocumentVersion; + /** + * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. + */ + AutomationTargetParameterName?: AutomationTargetParameterName; + /** + * A description of the parameters for a document. + */ + Parameters?: Parameters; + /** + * The association ID. + */ + AssociationId?: AssociationId; + /** + * The instances targeted by the request. + */ + Targets?: Targets; + /** + * A cron expression that specifies a schedule when the association runs. + */ + ScheduleExpression?: ScheduleExpression; + /** + * An Amazon S3 bucket where you want to store the output details of the request. + */ + OutputLocation?: InstanceAssociationOutputLocation; + /** + * The date on which the association was last run. + */ + LastExecutionDate?: DateTime; + /** + * The last date on which the association was successfully run. + */ + LastSuccessfulExecutionDate?: DateTime; + /** + * The association name. + */ + AssociationName?: AssociationName; + /** + * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time. + */ + MaxErrors?: MaxErrors; + /** + * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The severity level that is assigned to the association. + */ + ComplianceSeverity?: AssociationComplianceSeverity; + } + export type AssociationDescriptionList = AssociationDescription[]; + export interface AssociationExecution { + /** + * The association ID. + */ + AssociationId?: AssociationId; + /** + * The association version. + */ + AssociationVersion?: AssociationVersion; + /** + * The execution ID for the association. + */ + ExecutionId?: AssociationExecutionId; + /** + * The status of the association execution. + */ + Status?: StatusName; + /** + * Detailed status information about the execution. + */ + DetailedStatus?: StatusName; + /** + * The time the execution started. + */ + CreatedTime?: DateTime; + /** + * The date of the last execution. + */ + LastExecutionDate?: DateTime; + /** + * An aggregate status of the resources in the execution based on the status type. + */ + ResourceCountByStatus?: ResourceCountByStatus; + } + export interface AssociationExecutionFilter { + /** + * The key value used in the request. + */ + Key: AssociationExecutionFilterKey; + /** + * The value specified for the key. + */ + Value: AssociationExecutionFilterValue; + /** + * The filter type specified in the request. + */ + Type: AssociationFilterOperatorType; + } + export type AssociationExecutionFilterKey = "ExecutionId"|"Status"|"CreatedTime"|string; + export type AssociationExecutionFilterList = AssociationExecutionFilter[]; + export type AssociationExecutionFilterValue = string; + export type AssociationExecutionId = string; + export interface AssociationExecutionTarget { + /** + * The association ID. + */ + AssociationId?: AssociationId; + /** + * The association version. + */ + AssociationVersion?: AssociationVersion; + /** + * The execution ID. + */ + ExecutionId?: AssociationExecutionId; + /** + * The resource ID, for example, the instance ID where the association ran. + */ + ResourceId?: AssociationResourceId; + /** + * The resource type, for example, instance. + */ + ResourceType?: AssociationResourceType; + /** + * The association execution status. + */ + Status?: StatusName; + /** + * Detailed information about the execution status. + */ + DetailedStatus?: StatusName; + /** + * The date of the last execution. + */ + LastExecutionDate?: DateTime; + /** + * The location where the association details are saved. + */ + OutputSource?: OutputSource; + } + export interface AssociationExecutionTargetsFilter { + /** + * The key value used in the request. + */ + Key: AssociationExecutionTargetsFilterKey; + /** + * The value specified for the key. + */ + Value: AssociationExecutionTargetsFilterValue; + } + export type AssociationExecutionTargetsFilterKey = "Status"|"ResourceId"|"ResourceType"|string; + export type AssociationExecutionTargetsFilterList = AssociationExecutionTargetsFilter[]; + export type AssociationExecutionTargetsFilterValue = string; + export type AssociationExecutionTargetsList = AssociationExecutionTarget[]; + export type AssociationExecutionsList = AssociationExecution[]; + export interface AssociationFilter { + /** + * The name of the filter. + */ + key: AssociationFilterKey; + /** + * The filter value. + */ + value: AssociationFilterValue; + } + export type AssociationFilterKey = "InstanceId"|"Name"|"AssociationId"|"AssociationStatusName"|"LastExecutedBefore"|"LastExecutedAfter"|"AssociationName"|string; + export type AssociationFilterList = AssociationFilter[]; + export type AssociationFilterOperatorType = "EQUAL"|"LESS_THAN"|"GREATER_THAN"|string; + export type AssociationFilterValue = string; + export type AssociationId = string; + export type AssociationIdList = AssociationId[]; + export type AssociationList = Association[]; + export type AssociationName = string; + export interface AssociationOverview { + /** + * The status of the association. Status can be: Pending, Success, or Failed. + */ + Status?: StatusName; + /** + * A detailed status of the association. + */ + DetailedStatus?: StatusName; + /** + * Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status. + */ + AssociationStatusAggregatedCount?: AssociationStatusAggregatedCount; + } + export type AssociationResourceId = string; + export type AssociationResourceType = string; + export interface AssociationStatus { + /** + * The date when the status changed. + */ + Date: DateTime; + /** + * The status. + */ + Name: AssociationStatusName; + /** + * The reason for the status. + */ + Message: StatusMessage; + /** + * A user-defined string. + */ + AdditionalInfo?: StatusAdditionalInfo; + } + export type AssociationStatusAggregatedCount = {[key: string]: InstanceCount}; + export type AssociationStatusName = "Pending"|"Success"|"Failed"|string; + export type AssociationVersion = string; + export interface AssociationVersionInfo { + /** + * The ID created by the system when the association was created. + */ + AssociationId?: AssociationId; + /** + * The association version. + */ + AssociationVersion?: AssociationVersion; + /** + * The date the association version was created. + */ + CreatedDate?: DateTime; + /** + * The name specified when the association was created. + */ + Name?: DocumentARN; + /** + * The version of a Systems Manager document used when the association version was created. + */ + DocumentVersion?: DocumentVersion; + /** + * Parameters specified when the association version was created. + */ + Parameters?: Parameters; + /** + * The targets specified for the association when the association version was created. + */ + Targets?: Targets; + /** + * The cron or rate schedule specified for the association when the association version was created. + */ + ScheduleExpression?: ScheduleExpression; + /** + * The location in Amazon S3 specified for the association when the association version was created. + */ + OutputLocation?: InstanceAssociationOutputLocation; + /** + * The name specified for the association version when the association version was created. + */ + AssociationName?: AssociationName; + /** + * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time. + */ + MaxErrors?: MaxErrors; + /** + * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The severity level that is assigned to the association. + */ + ComplianceSeverity?: AssociationComplianceSeverity; + } + export type AssociationVersionList = AssociationVersionInfo[]; + export interface AttachmentContent { + /** + * The name of an attachment. + */ + Name?: AttachmentName; + /** + * The size of an attachment in bytes. + */ + Size?: ContentLength; + /** + * The cryptographic hash value of the document content. + */ + Hash?: AttachmentHash; + /** + * The hash algorithm used to calculate the hash value. + */ + HashType?: AttachmentHashType; + /** + * The URL location of the attachment content. + */ + Url?: AttachmentUrl; + } + export type AttachmentContentList = AttachmentContent[]; + export type AttachmentHash = string; + export type AttachmentHashType = "Sha256"|string; + export interface AttachmentInformation { + /** + * The name of the attachment. + */ + Name?: AttachmentName; + } + export type AttachmentInformationList = AttachmentInformation[]; + export type AttachmentName = string; + export type AttachmentUrl = string; + export interface AttachmentsSource { + /** + * The key of a key and value pair that identifies the location of an attachment to a document. + */ + Key?: AttachmentsSourceKey; + /** + * The URL of the location of a document attachment, such as the URL of an Amazon S3 bucket. + */ + Values?: AttachmentsSourceValues; + } + export type AttachmentsSourceKey = "SourceUrl"|string; + export type AttachmentsSourceList = AttachmentsSource[]; + export type AttachmentsSourceValue = string; + export type AttachmentsSourceValues = AttachmentsSourceValue[]; + export type AttributeName = string; + export type AttributeValue = string; + export type AutomationActionName = string; + export interface AutomationExecution { + /** + * The execution ID. + */ + AutomationExecutionId?: AutomationExecutionId; + /** + * The name of the Automation document used during the execution. + */ + DocumentName?: DocumentName; + /** + * The version of the document to use during execution. + */ + DocumentVersion?: DocumentVersion; + /** + * The time the execution started. + */ + ExecutionStartTime?: DateTime; + /** + * The time the execution finished. + */ + ExecutionEndTime?: DateTime; + /** + * The execution status of the Automation. + */ + AutomationExecutionStatus?: AutomationExecutionStatus; + /** + * A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order. + */ + StepExecutions?: StepExecutionList; + /** + * A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions. + */ + StepExecutionsTruncated?: Boolean; + /** + * The key-value map of execution parameters, which were supplied when calling StartAutomationExecution. + */ + Parameters?: AutomationParameterMap; + /** + * The list of execution outputs as defined in the automation document. + */ + Outputs?: AutomationParameterMap; + /** + * A message describing why an execution has failed, if the status is set to Failed. + */ + FailureMessage?: String; + /** + * The automation execution mode. + */ + Mode?: ExecutionMode; + /** + * The AutomationExecutionId of the parent automation. + */ + ParentAutomationExecutionId?: AutomationExecutionId; + /** + * The Amazon Resource Name (ARN) of the user who ran the automation. + */ + ExecutedBy?: String; + /** + * The name of the step that is currently running. + */ + CurrentStepName?: String; + /** + * The action of the step that is currently running. + */ + CurrentAction?: String; + /** + * The parameter name. + */ + TargetParameterName?: AutomationParameterKey; + /** + * The specified targets. + */ + Targets?: Targets; + /** + * The specified key-value mapping of document parameters to target resources. + */ + TargetMaps?: TargetMaps; + /** + * A list of resolved targets in the rate control execution. + */ + ResolvedTargets?: ResolvedTargets; + /** + * The MaxConcurrency value specified by the user when the execution started. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The MaxErrors value specified by the user when the execution started. + */ + MaxErrors?: MaxErrors; + /** + * The target of the execution. + */ + Target?: String; + /** + * The combination of AWS Regions and/or AWS accounts where you want to run the Automation. + */ + TargetLocations?: TargetLocations; + /** + * An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution. + */ + ProgressCounters?: ProgressCounters; + } + export interface AutomationExecutionFilter { + /** + * One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter. + */ + Key: AutomationExecutionFilterKey; + /** + * The values used to limit the execution information associated with the filter's key. + */ + Values: AutomationExecutionFilterValueList; + } + export type AutomationExecutionFilterKey = "DocumentNamePrefix"|"ExecutionStatus"|"ExecutionId"|"ParentExecutionId"|"CurrentAction"|"StartTimeBefore"|"StartTimeAfter"|"AutomationType"|string; + export type AutomationExecutionFilterList = AutomationExecutionFilter[]; + export type AutomationExecutionFilterValue = string; + export type AutomationExecutionFilterValueList = AutomationExecutionFilterValue[]; + export type AutomationExecutionId = string; + export interface AutomationExecutionMetadata { + /** + * The execution ID. + */ + AutomationExecutionId?: AutomationExecutionId; + /** + * The name of the Automation document used during execution. + */ + DocumentName?: DocumentName; + /** + * The document version used during the execution. + */ + DocumentVersion?: DocumentVersion; + /** + * The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled. + */ + AutomationExecutionStatus?: AutomationExecutionStatus; + /** + * The time the execution started.> + */ + ExecutionStartTime?: DateTime; + /** + * The time the execution finished. This is not populated if the execution is still in progress. + */ + ExecutionEndTime?: DateTime; + /** + * The IAM role ARN of the user who ran the Automation. + */ + ExecutedBy?: String; + /** + * An Amazon S3 bucket where execution information is stored. + */ + LogFile?: String; + /** + * The list of execution outputs as defined in the Automation document. + */ + Outputs?: AutomationParameterMap; + /** + * The Automation execution mode. + */ + Mode?: ExecutionMode; + /** + * The ExecutionId of the parent Automation. + */ + ParentAutomationExecutionId?: AutomationExecutionId; + /** + * The name of the step that is currently running. + */ + CurrentStepName?: String; + /** + * The action of the step that is currently running. + */ + CurrentAction?: String; + /** + * The list of execution outputs as defined in the Automation document. + */ + FailureMessage?: String; + /** + * The list of execution outputs as defined in the Automation document. + */ + TargetParameterName?: AutomationParameterKey; + /** + * The targets defined by the user when starting the Automation. + */ + Targets?: Targets; + /** + * The specified key-value mapping of document parameters to target resources. + */ + TargetMaps?: TargetMaps; + /** + * A list of targets that resolved during the execution. + */ + ResolvedTargets?: ResolvedTargets; + /** + * The MaxConcurrency value specified by the user when starting the Automation. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The MaxErrors value specified by the user when starting the Automation. + */ + MaxErrors?: MaxErrors; + /** + * The list of execution outputs as defined in the Automation document. + */ + Target?: String; + /** + * Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide. + */ + AutomationType?: AutomationType; + } + export type AutomationExecutionMetadataList = AutomationExecutionMetadata[]; + export type AutomationExecutionStatus = "Pending"|"InProgress"|"Waiting"|"Success"|"TimedOut"|"Cancelling"|"Cancelled"|"Failed"|string; + export type AutomationParameterKey = string; + export type AutomationParameterMap = {[key: string]: AutomationParameterValueList}; + export type AutomationParameterValue = string; + export type AutomationParameterValueList = AutomationParameterValue[]; + export type AutomationTargetParameterName = string; + export type AutomationType = "CrossAccount"|"Local"|string; + export type BaselineDescription = string; + export type BaselineId = string; + export type BaselineName = string; + export type BatchErrorMessage = string; + export type Boolean = boolean; + export interface CancelCommandRequest { + /** + * The ID of the command you want to cancel. + */ + CommandId: CommandId; + /** + * (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested. + */ + InstanceIds?: InstanceIdList; + } + export interface CancelCommandResult { + } + export interface CancelMaintenanceWindowExecutionRequest { + /** + * The ID of the Maintenance Window execution to stop. + */ + WindowExecutionId: MaintenanceWindowExecutionId; + } + export interface CancelMaintenanceWindowExecutionResult { + /** + * The ID of the Maintenance Window execution that has been stopped. + */ + WindowExecutionId?: MaintenanceWindowExecutionId; + } + export type ClientToken = string; + export type CloudWatchLogGroupName = string; + export interface CloudWatchOutputConfig { + /** + * The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName. + */ + CloudWatchLogGroupName?: CloudWatchLogGroupName; + /** + * Enables Systems Manager to send command output to CloudWatch Logs. + */ + CloudWatchOutputEnabled?: CloudWatchOutputEnabled; + } + export type CloudWatchOutputEnabled = boolean; + export interface Command { + /** + * A unique identifier for this command. + */ + CommandId?: CommandId; + /** + * The name of the document requested for execution. + */ + DocumentName?: DocumentName; + /** + * The SSM document version. + */ + DocumentVersion?: DocumentVersion; + /** + * User-specified information about the command, such as a brief description of what the command should do. + */ + Comment?: Comment; + /** + * If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API. + */ + ExpiresAfter?: DateTime; + /** + * The parameter values to be inserted in the document when running the command. + */ + Parameters?: Parameters; + /** + * The instance IDs against which this command was requested. + */ + InstanceIds?: InstanceIdList; + /** + * An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. + */ + Targets?: Targets; + /** + * The date and time the command was requested. + */ + RequestedDateTime?: DateTime; + /** + * The status of the command. + */ + Status?: CommandStatus; + /** + * A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to any instances. In Progress: The command has been sent to at least one instance but has not reached a final state on all instances. Success: The command successfully ran on all invocations. This is a terminal state. Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state. Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state. Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state. + */ + StatusDetails?: StatusDetails; + /** + * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. + */ + OutputS3Region?: S3Region; + /** + * The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. + */ + OutputS3BucketName?: S3BucketName; + /** + * The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. + */ + OutputS3KeyPrefix?: S3KeyPrefix; + /** + * The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide. + */ + MaxErrors?: MaxErrors; + /** + * The number of targets for the command. + */ + TargetCount?: TargetCount; + /** + * The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable. + */ + CompletedCount?: CompletedCount; + /** + * The number of targets for which the status is Failed or Execution Timed Out. + */ + ErrorCount?: ErrorCount; + /** + * The number of targets for which the status is Delivery Timed Out. + */ + DeliveryTimedOutCount?: DeliveryTimedOutCount; + /** + * The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes. + */ + ServiceRole?: ServiceRole; + /** + * Configurations for sending notifications about command status changes. + */ + NotificationConfig?: NotificationConfig; + /** + * CloudWatch Logs information where you want Systems Manager to send the command output. + */ + CloudWatchOutputConfig?: CloudWatchOutputConfig; + } + export interface CommandFilter { + /** + * The name of the filter. + */ + key: CommandFilterKey; + /** + * The filter value. Valid values for each filter key are as follows: InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later. InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018. Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include: Pending InProgress Success Cancelled Failed TimedOut Cancelling DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances. ExecutionStage: Specify one of the following values: Executing: Returns a list of command executions that are currently still running. Complete: Returns a list of command executions that have already completed. + */ + value: CommandFilterValue; + } + export type CommandFilterKey = "InvokedAfter"|"InvokedBefore"|"Status"|"ExecutionStage"|"DocumentName"|string; + export type CommandFilterList = CommandFilter[]; + export type CommandFilterValue = string; + export type CommandId = string; + export interface CommandInvocation { + /** + * The command against which this invocation was requested. + */ + CommandId?: CommandId; + /** + * The instance ID in which this invocation was requested. + */ + InstanceId?: InstanceId; + /** + * The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance. + */ + InstanceName?: InstanceTagName; + /** + * User-specified information about the command, such as a brief description of what the command should do. + */ + Comment?: Comment; + /** + * The document name that was requested for execution. + */ + DocumentName?: DocumentName; + /** + * The SSM document version. + */ + DocumentVersion?: DocumentVersion; + /** + * The time and date the request was sent to this instance. + */ + RequestedDateTime?: DateTime; + /** + * Whether or not the invocation succeeded, failed, or is pending. + */ + Status?: CommandInvocationStatus; + /** + * A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Success: The execution of the command or plugin was successfully completed. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state. + */ + StatusDetails?: StatusDetails; + /** + * Gets the trace output sent by the agent. + */ + TraceOutput?: InvocationTraceOutput; + /** + * The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command. + */ + StandardOutputUrl?: Url; + /** + * The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command. + */ + StandardErrorUrl?: Url; + CommandPlugins?: CommandPluginList; + /** + * The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis. + */ + ServiceRole?: ServiceRole; + /** + * Configurations for sending notifications about command status changes on a per instance basis. + */ + NotificationConfig?: NotificationConfig; + /** + * CloudWatch Logs information where you want Systems Manager to send the command output. + */ + CloudWatchOutputConfig?: CloudWatchOutputConfig; + } + export type CommandInvocationList = CommandInvocation[]; + export type CommandInvocationStatus = "Pending"|"InProgress"|"Delayed"|"Success"|"Cancelled"|"TimedOut"|"Failed"|"Cancelling"|string; + export type CommandList = Command[]; + export type CommandMaxResults = number; + export interface CommandPlugin { + /** + * The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent. + */ + Name?: CommandPluginName; + /** + * The status of this plugin. You can run a document with multiple plugins. + */ + Status?: CommandPluginStatus; + /** + * A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Success: The execution of the command or plugin was successfully completed. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state. + */ + StatusDetails?: StatusDetails; + /** + * A numeric response code generated after running the plugin. + */ + ResponseCode?: ResponseCode; + /** + * The time the plugin started running. + */ + ResponseStartDateTime?: DateTime; + /** + * The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent. + */ + ResponseFinishDateTime?: DateTime; + /** + * Output of the plugin execution. + */ + Output?: CommandPluginOutput; + /** + * The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty. + */ + StandardOutputUrl?: Url; + /** + * The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty. + */ + StandardErrorUrl?: Url; + /** + * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. + */ + OutputS3Region?: S3Region; + /** + * The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript test_folder is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin. + */ + OutputS3BucketName?: S3BucketName; + /** + * The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript test_folder is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin. + */ + OutputS3KeyPrefix?: S3KeyPrefix; + } + export type CommandPluginList = CommandPlugin[]; + export type CommandPluginName = string; + export type CommandPluginOutput = string; + export type CommandPluginStatus = "Pending"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string; + export type CommandStatus = "Pending"|"InProgress"|"Success"|"Cancelled"|"Failed"|"TimedOut"|"Cancelling"|string; + export type Comment = string; + export type CompletedCount = number; + export type ComplianceExecutionId = string; + export interface ComplianceExecutionSummary { + /** + * The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. + */ + ExecutionTime: DateTime; + /** + * An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls. + */ + ExecutionId?: ComplianceExecutionId; + /** + * The type of execution. For example, Command is a valid execution type. + */ + ExecutionType?: ComplianceExecutionType; + } + export type ComplianceExecutionType = string; + export type ComplianceFilterValue = string; + export interface ComplianceItem { + /** + * The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types. + */ + ComplianceType?: ComplianceTypeName; + /** + * The type of resource. ManagedInstance is currently the only supported resource type. + */ + ResourceType?: ComplianceResourceType; + /** + * An ID for the resource. For a managed instance, this is the instance ID. + */ + ResourceId?: ComplianceResourceId; + /** + * An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320. + */ + Id?: ComplianceItemId; + /** + * A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services. + */ + Title?: ComplianceItemTitle; + /** + * The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT. + */ + Status?: ComplianceStatus; + /** + * The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified. + */ + Severity?: ComplianceSeverity; + /** + * A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time. + */ + ExecutionSummary?: ComplianceExecutionSummary; + /** + * A "Key": "Value" tag combination for the compliance item. + */ + Details?: ComplianceItemDetails; + } + export type ComplianceItemContentHash = string; + export type ComplianceItemDetails = {[key: string]: AttributeValue}; + export interface ComplianceItemEntry { + /** + * The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article. + */ + Id?: ComplianceItemId; + /** + * The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services. + */ + Title?: ComplianceItemTitle; + /** + * The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified. + */ + Severity: ComplianceSeverity; + /** + * The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT. + */ + Status: ComplianceStatus; + /** + * A "Key": "Value" tag combination for the compliance item. + */ + Details?: ComplianceItemDetails; + } + export type ComplianceItemEntryList = ComplianceItemEntry[]; + export type ComplianceItemId = string; + export type ComplianceItemList = ComplianceItem[]; + export type ComplianceItemTitle = string; + export type ComplianceQueryOperatorType = "EQUAL"|"NOT_EQUAL"|"BEGIN_WITH"|"LESS_THAN"|"GREATER_THAN"|string; + export type ComplianceResourceId = string; + export type ComplianceResourceIdList = ComplianceResourceId[]; + export type ComplianceResourceType = string; + export type ComplianceResourceTypeList = ComplianceResourceType[]; + export type ComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED"|string; + export type ComplianceStatus = "COMPLIANT"|"NON_COMPLIANT"|string; + export interface ComplianceStringFilter { + /** + * The name of the filter. + */ + Key?: ComplianceStringFilterKey; + /** + * The value for which to search. + */ + Values?: ComplianceStringFilterValueList; + /** + * The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan. + */ + Type?: ComplianceQueryOperatorType; + } + export type ComplianceStringFilterKey = string; + export type ComplianceStringFilterList = ComplianceStringFilter[]; + export type ComplianceStringFilterValueList = ComplianceFilterValue[]; + export type ComplianceSummaryCount = number; + export interface ComplianceSummaryItem { + /** + * The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string. + */ + ComplianceType?: ComplianceTypeName; + /** + * A list of COMPLIANT items for the specified compliance type. + */ + CompliantSummary?: CompliantSummary; + /** + * A list of NON_COMPLIANT items for the specified compliance type. + */ + NonCompliantSummary?: NonCompliantSummary; + } + export type ComplianceSummaryItemList = ComplianceSummaryItem[]; + export type ComplianceTypeName = string; + export interface CompliantSummary { + /** + * The total number of resources that are compliant. + */ + CompliantCount?: ComplianceSummaryCount; + /** + * A summary of the compliance severity by compliance type. + */ + SeveritySummary?: SeveritySummary; + } + export type ComputerName = string; + export type ConnectionStatus = "Connected"|"NotConnected"|string; + export type ContentLength = number; + export interface CreateActivationRequest { + /** + * A user-defined description of the resource that you want to register with Amazon EC2. Do not enter personally identifiable information in this field. + */ + Description?: ActivationDescription; + /** + * The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources. Do not enter personally identifiable information in this field. + */ + DefaultInstanceName?: DefaultInstanceName; + /** + * The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. + */ + IamRole: IamRole; + /** + * Specify the maximum number of managed instances you want to register. The default value is 1 instance. + */ + RegistrationLimit?: RegistrationLimit; + /** + * The date by which this activation request should expire. The default value is 24 hours. + */ + ExpirationDate?: ExpirationDate; + /** + * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs: Key=OS,Value=Windows Key=Environment,Value=Production When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs. You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource. + */ + Tags?: TagList; + } + export interface CreateActivationResult { + /** + * The ID number generated by the system when it processed the activation. The activation ID functions like a user name. + */ + ActivationId?: ActivationId; + /** + * The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID. + */ + ActivationCode?: ActivationCode; + } + export interface CreateAssociationBatchRequest { + /** + * One or more associations. + */ + Entries: CreateAssociationBatchRequestEntries; + } + export type CreateAssociationBatchRequestEntries = CreateAssociationBatchRequestEntry[]; + export interface CreateAssociationBatchRequestEntry { + /** + * The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:aws:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document. + */ + Name: DocumentARN; + /** + * The ID of the instance. + */ + InstanceId?: InstanceId; + /** + * A description of the parameters for a document. + */ + Parameters?: Parameters; + /** + * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. + */ + AutomationTargetParameterName?: AutomationTargetParameterName; + /** + * The document version. + */ + DocumentVersion?: DocumentVersion; + /** + * The instances targeted by the request. + */ + Targets?: Targets; + /** + * A cron expression that specifies a schedule when the association runs. + */ + ScheduleExpression?: ScheduleExpression; + /** + * An Amazon S3 bucket where you want to store the results of this request. + */ + OutputLocation?: InstanceAssociationOutputLocation; + /** + * Specify a descriptive name for the association. + */ + AssociationName?: AssociationName; + /** + * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time. + */ + MaxErrors?: MaxErrors; + /** + * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The severity level to assign to the association. + */ + ComplianceSeverity?: AssociationComplianceSeverity; + } + export interface CreateAssociationBatchResult { + /** + * Information about the associations that succeeded. + */ + Successful?: AssociationDescriptionList; + /** + * Information about the associations that failed. + */ + Failed?: FailedCreateAssociationList; + } + export interface CreateAssociationRequest { + /** + * The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:partition:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document. + */ + Name: DocumentARN; + /** + * The document version you want to associate with the target(s). Can be a specific version or the default version. + */ + DocumentVersion?: DocumentVersion; + /** + * The instance ID. + */ + InstanceId?: InstanceId; + /** + * The parameters for the runtime configuration of the document. + */ + Parameters?: Parameters; + /** + * The targets (either instances or tags) for the association. + */ + Targets?: Targets; + /** + * A cron expression when the association will be applied to the target(s). + */ + ScheduleExpression?: ScheduleExpression; + /** + * An Amazon S3 bucket where you want to store the output details of the request. + */ + OutputLocation?: InstanceAssociationOutputLocation; + /** + * Specify a descriptive name for the association. + */ + AssociationName?: AssociationName; + /** + * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. + */ + AutomationTargetParameterName?: AutomationTargetParameterName; + /** + * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time. + */ + MaxErrors?: MaxErrors; + /** + * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The severity level to assign to the association. + */ + ComplianceSeverity?: AssociationComplianceSeverity; + } + export interface CreateAssociationResult { + /** + * Information about the association. + */ + AssociationDescription?: AssociationDescription; + } + export interface CreateDocumentRequest { + /** + * A valid JSON or YAML string. + */ + Content: DocumentContent; + /** + * A list of key and value pairs that describe attachments to a version of a document. + */ + Attachments?: AttachmentsSourceList; + /** + * A name for the Systems Manager document. Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes: aws amazon amzn + */ + Name: DocumentName; + /** + * An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed. + */ + VersionName?: DocumentVersionName; + /** + * The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package. + */ + DocumentType?: DocumentType; + /** + * Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format. + */ + DocumentFormat?: DocumentFormat; + /** + * Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide. + */ + TargetType?: TargetType; + /** + * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs: Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing SSM document, use the AddTagsToResource action. + */ + Tags?: TagList; + } + export interface CreateDocumentResult { + /** + * Information about the Systems Manager document. + */ + DocumentDescription?: DocumentDescription; + } + export interface CreateMaintenanceWindowRequest { + /** + * The name of the Maintenance Window. + */ + Name: MaintenanceWindowName; + /** + * An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows. + */ + Description?: MaintenanceWindowDescription; + /** + * The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date. + */ + StartDate?: MaintenanceWindowStringDateTime; + /** + * The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive. EndDate allows you to set a date and time in the future when the Maintenance Window will no longer run. + */ + EndDate?: MaintenanceWindowStringDateTime; + /** + * The schedule of the Maintenance Window in the form of a cron or rate expression. + */ + Schedule: MaintenanceWindowSchedule; + /** + * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. + */ + ScheduleTimezone?: MaintenanceWindowTimezone; + /** + * The duration of the Maintenance Window in hours. + */ + Duration: MaintenanceWindowDurationHours; + /** + * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. + */ + Cutoff: MaintenanceWindowCutoff; + /** + * Enables a Maintenance Window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window. + */ + AllowUnassociatedTargets: MaintenanceWindowAllowUnassociatedTargets; + /** + * User-provided idempotency token. + */ + ClientToken?: ClientToken; + /** + * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Maintenance Window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs: Key=TaskType,Value=AgentUpdate Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing Maintenance Window, use the AddTagsToResource action. + */ + Tags?: TagList; + } + export interface CreateMaintenanceWindowResult { + /** + * The ID of the created Maintenance Window. + */ + WindowId?: MaintenanceWindowId; + } + export interface CreatePatchBaselineRequest { + /** + * Defines the operating system the patch baseline applies to. The Default value is WINDOWS. + */ + OperatingSystem?: OperatingSystem; + /** + * The name of the patch baseline. + */ + Name: BaselineName; + /** + * A set of global filters used to include patches in the baseline. + */ + GlobalFilters?: PatchFilterGroup; + /** + * A set of rules used to include patches in the baseline. + */ + ApprovalRules?: PatchRuleGroup; + /** + * A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide. + */ + ApprovedPatches?: PatchIdList; + /** + * Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED. + */ + ApprovedPatchesComplianceLevel?: PatchComplianceLevel; + /** + * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only. + */ + ApprovedPatchesEnableNonSecurity?: Boolean; + /** + * A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide. + */ + RejectedPatches?: PatchIdList; + /** + * The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected. + */ + RejectedPatchesAction?: PatchAction; + /** + * A description of the patch baseline. + */ + Description?: BaselineDescription; + /** + * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only. + */ + Sources?: PatchSourceList; + /** + * User-provided idempotency token. + */ + ClientToken?: ClientToken; + /** + * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs: Key=PatchSeverity,Value=Critical Key=OS,Value=Windows To add tags to an existing patch baseline, use the AddTagsToResource action. + */ + Tags?: TagList; + } + export interface CreatePatchBaselineResult { + /** + * The ID of the created patch baseline. + */ + BaselineId?: BaselineId; + } + export interface CreateResourceDataSyncRequest { + /** + * A name for the configuration. + */ + SyncName: ResourceDataSyncName; + /** + * Amazon S3 configuration details for the sync. + */ + S3Destination: ResourceDataSyncS3Destination; + } + export interface CreateResourceDataSyncResult { + } + export type CreatedDate = Date; + export type DateTime = Date; + export type DefaultBaseline = boolean; + export type DefaultInstanceName = string; + export interface DeleteActivationRequest { + /** + * The ID of the activation that you want to delete. + */ + ActivationId: ActivationId; + } + export interface DeleteActivationResult { + } + export interface DeleteAssociationRequest { + /** + * The name of the Systems Manager document. + */ + Name?: DocumentARN; + /** + * The ID of the instance. + */ + InstanceId?: InstanceId; + /** + * The association ID that you want to delete. + */ + AssociationId?: AssociationId; + } + export interface DeleteAssociationResult { + } + export interface DeleteDocumentRequest { + /** + * The name of the document. + */ + Name: DocumentName; + } + export interface DeleteDocumentResult { + } + export interface DeleteInventoryRequest { + /** + * The name of the custom inventory type for which you want to delete either all previously collected data, or the inventory type itself. + */ + TypeName: InventoryItemTypeName; + /** + * Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options: DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disbled version. DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want. + */ + SchemaDeleteOption?: InventorySchemaDeleteOption; + /** + * Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option. + */ + DryRun?: DryRun; + /** + * User-provided idempotency token. + */ + ClientToken?: ClientToken; + } + export interface DeleteInventoryResult { + /** + * Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions. + */ + DeletionId?: InventoryDeletionId; + /** + * The name of the inventory data type specified in the request. + */ + TypeName?: InventoryItemTypeName; + /** + * A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide. + */ + DeletionSummary?: InventoryDeletionSummary; + } + export interface DeleteMaintenanceWindowRequest { + /** + * The ID of the Maintenance Window to delete. + */ + WindowId: MaintenanceWindowId; + } + export interface DeleteMaintenanceWindowResult { + /** + * The ID of the deleted Maintenance Window. + */ + WindowId?: MaintenanceWindowId; + } + export interface DeleteParameterRequest { + /** + * The name of the parameter to delete. + */ + Name: PSParameterName; + } + export interface DeleteParameterResult { + } + export interface DeleteParametersRequest { + /** + * The names of the parameters to delete. + */ + Names: ParameterNameList; + } + export interface DeleteParametersResult { + /** + * The names of the deleted parameters. + */ + DeletedParameters?: ParameterNameList; + /** + * The names of parameters that weren't deleted because the parameters are not valid. + */ + InvalidParameters?: ParameterNameList; + } + export interface DeletePatchBaselineRequest { + /** + * The ID of the patch baseline to delete. + */ + BaselineId: BaselineId; + } + export interface DeletePatchBaselineResult { + /** + * The ID of the deleted patch baseline. + */ + BaselineId?: BaselineId; + } + export interface DeleteResourceDataSyncRequest { + /** + * The name of the configuration to delete. + */ + SyncName: ResourceDataSyncName; + } + export interface DeleteResourceDataSyncResult { + } + export type DeliveryTimedOutCount = number; + export interface DeregisterManagedInstanceRequest { + /** + * The ID assigned to the managed instance when you registered it using the activation process. + */ + InstanceId: ManagedInstanceId; + } + export interface DeregisterManagedInstanceResult { + } + export interface DeregisterPatchBaselineForPatchGroupRequest { + /** + * The ID of the patch baseline to deregister the patch group from. + */ + BaselineId: BaselineId; + /** + * The name of the patch group that should be deregistered from the patch baseline. + */ + PatchGroup: PatchGroup; + } + export interface DeregisterPatchBaselineForPatchGroupResult { + /** + * The ID of the patch baseline the patch group was deregistered from. + */ + BaselineId?: BaselineId; + /** + * The name of the patch group deregistered from the patch baseline. + */ + PatchGroup?: PatchGroup; + } + export interface DeregisterTargetFromMaintenanceWindowRequest { + /** + * The ID of the Maintenance Window the target should be removed from. + */ + WindowId: MaintenanceWindowId; + /** + * The ID of the target definition to remove. + */ + WindowTargetId: MaintenanceWindowTargetId; + /** + * The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the Maintenance Window. + */ + Safe?: Boolean; + } + export interface DeregisterTargetFromMaintenanceWindowResult { + /** + * The ID of the Maintenance Window the target was removed from. + */ + WindowId?: MaintenanceWindowId; + /** + * The ID of the removed target definition. + */ + WindowTargetId?: MaintenanceWindowTargetId; + } + export interface DeregisterTaskFromMaintenanceWindowRequest { + /** + * The ID of the Maintenance Window the task should be removed from. + */ + WindowId: MaintenanceWindowId; + /** + * The ID of the task to remove from the Maintenance Window. + */ + WindowTaskId: MaintenanceWindowTaskId; + } + export interface DeregisterTaskFromMaintenanceWindowResult { + /** + * The ID of the Maintenance Window the task was removed from. + */ + WindowId?: MaintenanceWindowId; + /** + * The ID of the task removed from the Maintenance Window. + */ + WindowTaskId?: MaintenanceWindowTaskId; + } + export interface DescribeActivationsFilter { + /** + * The name of the filter. + */ + FilterKey?: DescribeActivationsFilterKeys; + /** + * The filter values. + */ + FilterValues?: StringList; + } + export type DescribeActivationsFilterKeys = "ActivationIds"|"DefaultInstanceName"|"IamRole"|string; + export type DescribeActivationsFilterList = DescribeActivationsFilter[]; + export interface DescribeActivationsRequest { + /** + * A filter to view information about your activations. + */ + Filters?: DescribeActivationsFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeActivationsResult { + /** + * A list of activations for your AWS account. + */ + ActivationList?: ActivationList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeAssociationExecutionTargetsRequest { + /** + * The association ID that includes the execution for which you want to view details. + */ + AssociationId: AssociationId; + /** + * The execution ID for which you want to view details. + */ + ExecutionId: AssociationExecutionId; + /** + * Filters for the request. You can specify the following filters and values. Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL) + */ + Filters?: AssociationExecutionTargetsFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeAssociationExecutionTargetsResult { + /** + * Information about the execution. + */ + AssociationExecutionTargets?: AssociationExecutionTargetsList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeAssociationExecutionsRequest { + /** + * The association ID for which you want to view execution history details. + */ + AssociationId: AssociationId; + /** + * Filters for the request. You can specify the following filters and values. ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN) + */ + Filters?: AssociationExecutionFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeAssociationExecutionsResult { + /** + * A list of the executions for the specified association ID. + */ + AssociationExecutions?: AssociationExecutionsList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeAssociationRequest { + /** + * The name of the Systems Manager document. + */ + Name?: DocumentARN; + /** + * The instance ID. + */ + InstanceId?: InstanceId; + /** + * The association ID for which you want information. + */ + AssociationId?: AssociationId; + /** + * Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions. + */ + AssociationVersion?: AssociationVersion; + } + export interface DescribeAssociationResult { + /** + * Information about the association. + */ + AssociationDescription?: AssociationDescription; + } + export interface DescribeAutomationExecutionsRequest { + /** + * Filters used to limit the scope of executions that are requested. + */ + Filters?: AutomationExecutionFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeAutomationExecutionsResult { + /** + * The list of details about each automation execution which has occurred which matches the filter specification, if any. + */ + AutomationExecutionMetadataList?: AutomationExecutionMetadataList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeAutomationStepExecutionsRequest { + /** + * The Automation execution ID for which you want step execution descriptions. + */ + AutomationExecutionId: AutomationExecutionId; + /** + * One or more filters to limit the number of step executions returned by the request. + */ + Filters?: StepExecutionFilterList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * A boolean that indicates whether to list step executions in reverse order by start time. The default value is false. + */ + ReverseOrder?: Boolean; + } + export interface DescribeAutomationStepExecutionsResult { + /** + * A list of details about the current state of all steps that make up an execution. + */ + StepExecutions?: StepExecutionList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeAvailablePatchesRequest { + /** + * Filters used to scope down the returned patches. + */ + Filters?: PatchOrchestratorFilterList; + /** + * The maximum number of patches to return (per page). + */ + MaxResults?: PatchBaselineMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeAvailablePatchesResult { + /** + * An array of patches. Each entry in the array is a patch structure. + */ + Patches?: PatchList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeDocumentPermissionRequest { + /** + * The name of the document for which you are the owner. + */ + Name: DocumentName; + /** + * The permission type for the document. The permission type can be Share. + */ + PermissionType: DocumentPermissionType; + } + export interface DescribeDocumentPermissionResponse { + /** + * The account IDs that have permission to use this document. The ID can be either an AWS account or All. + */ + AccountIds?: AccountIdList; + } + export interface DescribeDocumentRequest { + /** + * The name of the Systems Manager document. + */ + Name: DocumentARN; + /** + * The document version for which you want information. Can be a specific version or the default version. + */ + DocumentVersion?: DocumentVersion; + /** + * An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed. + */ + VersionName?: DocumentVersionName; + } + export interface DescribeDocumentResult { + /** + * Information about the Systems Manager document. + */ + Document?: DocumentDescription; + } + export interface DescribeEffectiveInstanceAssociationsRequest { + /** + * The instance ID for which you want to view all associations. + */ + InstanceId: InstanceId; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: EffectiveInstanceAssociationMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeEffectiveInstanceAssociationsResult { + /** + * The associations for the requested instance. + */ + Associations?: InstanceAssociationList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeEffectivePatchesForPatchBaselineRequest { + /** + * The ID of the patch baseline to retrieve the effective patches for. + */ + BaselineId: BaselineId; + /** + * The maximum number of patches to return (per page). + */ + MaxResults?: PatchBaselineMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeEffectivePatchesForPatchBaselineResult { + /** + * An array of patches and patch status. + */ + EffectivePatches?: EffectivePatchList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeInstanceAssociationsStatusRequest { + /** + * The instance IDs for which you want association status information. + */ + InstanceId: InstanceId; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeInstanceAssociationsStatusResult { + /** + * Status information about the association. + */ + InstanceAssociationStatusInfos?: InstanceAssociationStatusInfos; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeInstanceInformationRequest { + /** + * This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping. If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes an exception error. + */ + InstanceInformationFilterList?: InstanceInformationFilterList; + /** + * One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping. + */ + Filters?: InstanceInformationStringFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResultsEC2Compatible; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeInstanceInformationResult { + /** + * The instance information list. + */ + InstanceInformationList?: InstanceInformationList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeInstancePatchStatesForPatchGroupRequest { + /** + * The name of the patch group for which the patch state information should be retrieved. + */ + PatchGroup: PatchGroup; + /** + * Each entry in the array is a structure containing: Key (string between 1 and 200 characters) Values (array containing a single string) Type (string "Equal", "NotEqual", "LessThan", "GreaterThan") + */ + Filters?: InstancePatchStateFilterList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * The maximum number of patches to return (per page). + */ + MaxResults?: PatchComplianceMaxResults; + } + export interface DescribeInstancePatchStatesForPatchGroupResult { + /** + * The high-level patch state for the requested instances. + */ + InstancePatchStates?: InstancePatchStatesList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeInstancePatchStatesRequest { + /** + * The ID of the instance whose patch state information should be retrieved. + */ + InstanceIds: InstanceIdList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * The maximum number of instances to return (per page). + */ + MaxResults?: PatchComplianceMaxResults; + } + export interface DescribeInstancePatchStatesResult { + /** + * The high-level patch state for the requested instances. + */ + InstancePatchStates?: InstancePatchStateList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeInstancePatchesRequest { + /** + * The ID of the instance whose patch state information should be retrieved. + */ + InstanceId: InstanceId; + /** + * Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string between 1 and 256 characters) + */ + Filters?: PatchOrchestratorFilterList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * The maximum number of patches to return (per page). + */ + MaxResults?: PatchComplianceMaxResults; + } + export interface DescribeInstancePatchesResult { + /** + * Each entry in the array is a structure containing: Title (string) KBId (string) Classification (string) Severity (string) State (string, such as "INSTALLED" or "FAILED") InstalledTime (DateTime) InstalledBy (string) + */ + Patches?: PatchComplianceDataList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeInventoryDeletionsRequest { + /** + * Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action. + */ + DeletionId?: InventoryDeletionId; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface DescribeInventoryDeletionsResult { + /** + * A list of status items for deleted inventory. + */ + InventoryDeletions?: InventoryDeletionsList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowExecutionTaskInvocationsRequest { + /** + * The ID of the Maintenance Window execution the task is part of. + */ + WindowExecutionId: MaintenanceWindowExecutionId; + /** + * The ID of the specific task in the Maintenance Window task that should be retrieved. + */ + TaskId: MaintenanceWindowExecutionTaskId; + /** + * Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. + */ + Filters?: MaintenanceWindowFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowExecutionTaskInvocationsResult { + /** + * Information about the task invocation results per invocation. + */ + WindowExecutionTaskInvocationIdentities?: MaintenanceWindowExecutionTaskInvocationIdentityList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowExecutionTasksRequest { + /** + * The ID of the Maintenance Window execution whose task executions should be retrieved. + */ + WindowExecutionId: MaintenanceWindowExecutionId; + /** + * Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. + */ + Filters?: MaintenanceWindowFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowExecutionTasksResult { + /** + * Information about the task executions. + */ + WindowExecutionTaskIdentities?: MaintenanceWindowExecutionTaskIdentityList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowExecutionsRequest { + /** + * The ID of the Maintenance Window whose executions should be retrieved. + */ + WindowId: MaintenanceWindowId; + /** + * Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string is between 1 and 256 characters) The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z. + */ + Filters?: MaintenanceWindowFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowExecutionsResult { + /** + * Information about the Maintenance Windows execution. + */ + WindowExecutions?: MaintenanceWindowExecutionList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowScheduleRequest { + /** + * The ID of the Maintenance Window to retrieve information about. + */ + WindowId?: MaintenanceWindowId; + /** + * The instance ID or key/value pair to retrieve information about. + */ + Targets?: Targets; + /** + * The type of resource you want to retrieve information about. For example, "INSTANCE". + */ + ResourceType?: MaintenanceWindowResourceType; + /** + * Filters used to limit the range of results. For example, you can limit Maintenance Window executions to only those scheduled before or after a certain date and time. + */ + Filters?: PatchOrchestratorFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowSearchMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowScheduleResult { + /** + * Information about Maintenance Window executions scheduled for the specified time range. + */ + ScheduledWindowExecutions?: ScheduledWindowExecutionList; + /** + * The token for the next set of items to return. (You use this token in the next call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowTargetsRequest { + /** + * The ID of the Maintenance Window whose targets should be retrieved. + */ + WindowId: MaintenanceWindowId; + /** + * Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation. + */ + Filters?: MaintenanceWindowFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowTargetsResult { + /** + * Information about the targets in the Maintenance Window. + */ + Targets?: MaintenanceWindowTargetList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowTasksRequest { + /** + * The ID of the Maintenance Window whose tasks should be retrieved. + */ + WindowId: MaintenanceWindowId; + /** + * Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType. + */ + Filters?: MaintenanceWindowFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowTasksResult { + /** + * Information about the tasks in the Maintenance Window. + */ + Tasks?: MaintenanceWindowTaskList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowsForTargetRequest { + /** + * The instance ID or key/value pair to retrieve information about. + */ + Targets: Targets; + /** + * The type of resource you want to retrieve information about. For example, "INSTANCE". + */ + ResourceType: MaintenanceWindowResourceType; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowSearchMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowsForTargetResult { + /** + * Information about the Maintenance Window targets and tasks an instance is associated with. + */ + WindowIdentities?: MaintenanceWindowsForTargetList; + /** + * The token for the next set of items to return. (You use this token in the next call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowsRequest { + /** + * Optional filters used to narrow down the scope of the returned Maintenance Windows. Supported filter keys are Name and Enabled. + */ + Filters?: MaintenanceWindowFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaintenanceWindowMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeMaintenanceWindowsResult { + /** + * Information about the Maintenance Windows. + */ + WindowIdentities?: MaintenanceWindowIdentityList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribeParametersRequest { + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: ParametersFilterList; + /** + * Filters to limit the request results. + */ + ParameterFilters?: ParameterStringFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribeParametersResult { + /** + * Parameters returned by the request. + */ + Parameters?: ParameterMetadataList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribePatchBaselinesRequest { + /** + * Each element in the array is a structure containing: Key: (string, "NAME_PREFIX" or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255 characters) + */ + Filters?: PatchOrchestratorFilterList; + /** + * The maximum number of patch baselines to return (per page). + */ + MaxResults?: PatchBaselineMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribePatchBaselinesResult { + /** + * An array of PatchBaselineIdentity elements. + */ + BaselineIdentities?: PatchBaselineIdentityList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribePatchGroupStateRequest { + /** + * The name of the patch group whose patch snapshot should be retrieved. + */ + PatchGroup: PatchGroup; + } + export interface DescribePatchGroupStateResult { + /** + * The number of instances in the patch group. + */ + Instances?: Integer; + /** + * The number of instances with installed patches. + */ + InstancesWithInstalledPatches?: Integer; + /** + * The number of instances with patches installed that aren't defined in the patch baseline. + */ + InstancesWithInstalledOtherPatches?: Integer; + /** + * The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list. If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero). + */ + InstancesWithInstalledRejectedPatches?: InstancesCount; + /** + * The number of instances with missing patches from the patch baseline. + */ + InstancesWithMissingPatches?: Integer; + /** + * The number of instances with patches from the patch baseline that failed to install. + */ + InstancesWithFailedPatches?: Integer; + /** + * The number of instances with patches that aren't applicable. + */ + InstancesWithNotApplicablePatches?: Integer; + /** + * The number of instances with NotApplicable patches beyond the supported limit, which are not reported by name to Systems Manager Inventory. + */ + InstancesWithUnreportedNotApplicablePatches?: Integer; + } + export interface DescribePatchGroupsRequest { + /** + * The maximum number of patch groups to return (per page). + */ + MaxResults?: PatchBaselineMaxResults; + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: PatchOrchestratorFilterList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribePatchGroupsResult { + /** + * Each entry in the array contains: PatchGroup: string (between 1 and 256 characters, Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$) PatchBaselineIdentity: A PatchBaselineIdentity element. + */ + Mappings?: PatchGroupPatchBaselineMappingList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface DescribePatchPropertiesRequest { + /** + * The operating system type for which to list patches. + */ + OperatingSystem: OperatingSystem; + /** + * The patch property for which you want to view patch details. + */ + Property: PatchProperty; + /** + * Indicates whether to list patches for the Windows operating system or for Microsoft applications. Not applicable for Linux operating systems. + */ + PatchSet?: PatchSet; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface DescribePatchPropertiesResult { + /** + * A list of the properties for patches matching the filter request parameters. + */ + Properties?: PatchPropertiesList; + /** + * The token for the next set of items to return. (You use this token in the next call.) + */ + NextToken?: NextToken; + } + export interface DescribeSessionsRequest { + /** + * The session status to retrieve a list of sessions for. For example, "Active". + */ + State: SessionState; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: SessionMaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * One or more filters to limit the type of sessions returned by the request. + */ + Filters?: SessionFilterList; + } + export interface DescribeSessionsResponse { + /** + * A list of sessions meeting the request parameters. + */ + Sessions?: SessionList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export type DescriptionInDocument = string; + export type DocumentARN = string; + export type DocumentContent = string; + export interface DocumentDefaultVersionDescription { + /** + * The name of the document. + */ + Name?: DocumentName; + /** + * The default version of the document. + */ + DefaultVersion?: DocumentVersion; + /** + * The default version of the artifact associated with the document. + */ + DefaultVersionName?: DocumentVersionName; + } + export interface DocumentDescription { + /** + * The SHA1 hash of the document, which you can use for verification. + */ + Sha1?: DocumentSha1; + /** + * The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated. + */ + Hash?: DocumentHash; + /** + * The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes have been deprecated. + */ + HashType?: DocumentHashType; + /** + * The name of the Systems Manager document. + */ + Name?: DocumentARN; + /** + * The version of the artifact associated with the document. + */ + VersionName?: DocumentVersionName; + /** + * The AWS user account that created the document. + */ + Owner?: DocumentOwner; + /** + * The date when the document was created. + */ + CreatedDate?: DateTime; + /** + * The status of the Systems Manager document. + */ + Status?: DocumentStatus; + /** + * A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct." + */ + StatusInformation?: DocumentStatusInformation; + /** + * The document version. + */ + DocumentVersion?: DocumentVersion; + /** + * A description of the document. + */ + Description?: DescriptionInDocument; + /** + * A description of the parameters for a document. + */ + Parameters?: DocumentParameterList; + /** + * The list of OS platforms compatible with this Systems Manager document. + */ + PlatformTypes?: PlatformTypeList; + /** + * The type of document. + */ + DocumentType?: DocumentType; + /** + * The schema version. + */ + SchemaVersion?: DocumentSchemaVersion; + /** + * The latest version of the document. + */ + LatestVersion?: DocumentVersion; + /** + * The default version. + */ + DefaultVersion?: DocumentVersion; + /** + * The document format, either JSON or YAML. + */ + DocumentFormat?: DocumentFormat; + /** + * The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide. + */ + TargetType?: TargetType; + /** + * The tags, or metadata, that have been applied to the document. + */ + Tags?: TagList; + /** + * Details about the document attachments, including names, locations, sizes, etc. + */ + AttachmentsInformation?: AttachmentInformationList; + } + export interface DocumentFilter { + /** + * The name of the filter. + */ + key: DocumentFilterKey; + /** + * The value of the filter. + */ + value: DocumentFilterValue; + } + export type DocumentFilterKey = "Name"|"Owner"|"PlatformTypes"|"DocumentType"|string; + export type DocumentFilterList = DocumentFilter[]; + export type DocumentFilterValue = string; + export type DocumentFormat = "YAML"|"JSON"|string; + export type DocumentHash = string; + export type DocumentHashType = "Sha256"|"Sha1"|string; + export interface DocumentIdentifier { + /** + * The name of the Systems Manager document. + */ + Name?: DocumentARN; + /** + * The AWS user account that created the document. + */ + Owner?: DocumentOwner; + /** + * An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed. + */ + VersionName?: DocumentVersionName; + /** + * The operating system platform. + */ + PlatformTypes?: PlatformTypeList; + /** + * The document version. + */ + DocumentVersion?: DocumentVersion; + /** + * The document type. + */ + DocumentType?: DocumentType; + /** + * The schema version. + */ + SchemaVersion?: DocumentSchemaVersion; + /** + * The document format, either JSON or YAML. + */ + DocumentFormat?: DocumentFormat; + /** + * The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide. + */ + TargetType?: TargetType; + /** + * The tags, or metadata, that have been applied to the document. + */ + Tags?: TagList; + } + export type DocumentIdentifierList = DocumentIdentifier[]; + export interface DocumentKeyValuesFilter { + /** + * The name of the filter key. + */ + Key?: DocumentKeyValuesFilterKey; + /** + * The value for the filter key. + */ + Values?: DocumentKeyValuesFilterValues; + } + export type DocumentKeyValuesFilterKey = string; + export type DocumentKeyValuesFilterList = DocumentKeyValuesFilter[]; + export type DocumentKeyValuesFilterValue = string; + export type DocumentKeyValuesFilterValues = DocumentKeyValuesFilterValue[]; + export type DocumentName = string; + export type DocumentOwner = string; + export interface DocumentParameter { + /** + * The name of the parameter. + */ + Name?: DocumentParameterName; + /** + * The type of parameter. The type can be either String or StringList. + */ + Type?: DocumentParameterType; + /** + * A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional. + */ + Description?: DocumentParameterDescrption; + /** + * If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional. + */ + DefaultValue?: DocumentParameterDefaultValue; + } + export type DocumentParameterDefaultValue = string; + export type DocumentParameterDescrption = string; + export type DocumentParameterList = DocumentParameter[]; + export type DocumentParameterName = string; + export type DocumentParameterType = "String"|"StringList"|string; + export type DocumentPermissionType = "Share"|string; + export type DocumentSchemaVersion = string; + export type DocumentSha1 = string; + export type DocumentStatus = "Creating"|"Active"|"Updating"|"Deleting"|"Failed"|string; + export type DocumentStatusInformation = string; + export type DocumentType = "Command"|"Policy"|"Automation"|"Session"|"Package"|string; + export type DocumentVersion = string; + export interface DocumentVersionInfo { + /** + * The document name. + */ + Name?: DocumentName; + /** + * The document version. + */ + DocumentVersion?: DocumentVersion; + /** + * The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed. + */ + VersionName?: DocumentVersionName; + /** + * The date the document was created. + */ + CreatedDate?: DateTime; + /** + * An identifier for the default version of the document. + */ + IsDefaultVersion?: Boolean; + /** + * The document format, either JSON or YAML. + */ + DocumentFormat?: DocumentFormat; + /** + * The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting. + */ + Status?: DocumentStatus; + /** + * A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct." + */ + StatusInformation?: DocumentStatusInformation; + } + export type DocumentVersionList = DocumentVersionInfo[]; + export type DocumentVersionName = string; + export type DocumentVersionNumber = string; + export type DryRun = boolean; + export type EffectiveInstanceAssociationMaxResults = number; + export interface EffectivePatch { + /** + * Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch. + */ + Patch?: Patch; + /** + * The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved. + */ + PatchStatus?: PatchStatus; + } + export type EffectivePatchList = EffectivePatch[]; + export type ErrorCount = number; + export type ExecutionMode = "Auto"|"Interactive"|string; + export type ExecutionRoleName = string; + export type ExpirationDate = Date; + export interface FailedCreateAssociation { + /** + * The association. + */ + Entry?: CreateAssociationBatchRequestEntry; + /** + * A description of the failure. + */ + Message?: BatchErrorMessage; + /** + * The source of the failure. + */ + Fault?: Fault; + } + export type FailedCreateAssociationList = FailedCreateAssociation[]; + export interface FailureDetails { + /** + * The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification. + */ + FailureStage?: String; + /** + * The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal. + */ + FailureType?: String; + /** + * Detailed information about the Automation step failure. + */ + Details?: AutomationParameterMap; + } + export type Fault = "Client"|"Server"|"Unknown"|string; + export interface GetAutomationExecutionRequest { + /** + * The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated. + */ + AutomationExecutionId: AutomationExecutionId; + } + export interface GetAutomationExecutionResult { + /** + * Detailed information about the current state of an automation execution. + */ + AutomationExecution?: AutomationExecution; + } + export interface GetCommandInvocationRequest { + /** + * (Required) The parent command ID of the invocation plugin. + */ + CommandId: CommandId; + /** + * (Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager. + */ + InstanceId: InstanceId; + /** + * (Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned. + */ + PluginName?: CommandPluginName; + } + export interface GetCommandInvocationResult { + /** + * The parent command ID of the invocation plugin. + */ + CommandId?: CommandId; + /** + * The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager. + */ + InstanceId?: InstanceId; + /** + * The comment text for the command. + */ + Comment?: Comment; + /** + * The name of the document that was run. For example, AWS-RunShellScript. + */ + DocumentName?: DocumentName; + /** + * The SSM document version used in the request. + */ + DocumentVersion?: DocumentVersion; + /** + * The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin. + */ + PluginName?: CommandPluginName; + /** + * The error level response code for the plugin script. If the response code is -1, then the command has not started running on the instance, or it was not received by the instance. + */ + ResponseCode?: ResponseCode; + /** + * The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter. aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If the plugin has not started to run, the string is empty. + */ + ExecutionStartDateTime?: StringDateTime; + /** + * Duration since ExecutionStartDateTime. + */ + ExecutionElapsedTime?: StringDateTime; + /** + * The date and time the plugin was finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter. aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If the plugin has not started to run, the string is empty. + */ + ExecutionEndDateTime?: StringDateTime; + /** + * The status of this invocation plugin. This status can be different than StatusDetails. + */ + Status?: CommandInvocationStatus; + /** + * A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again. Success: The command or plugin was run successfully. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: The command started to run on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state. + */ + StatusDetails?: StatusDetails; + /** + * The first 24,000 characters written by the plugin to stdout. If the command has not finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty. + */ + StandardOutputContent?: StandardOutputContent; + /** + * The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty. + */ + StandardOutputUrl?: Url; + /** + * The first 8,000 characters written by the plugin to stderr. If the command has not finished running, then this string is empty. + */ + StandardErrorContent?: StandardErrorContent; + /** + * The URL for the complete text written by the plugin to stderr. If the command has not finished running, then this string is empty. + */ + StandardErrorUrl?: Url; + /** + * CloudWatch Logs information where Systems Manager sent the command output. + */ + CloudWatchOutputConfig?: CloudWatchOutputConfig; + } + export interface GetConnectionStatusRequest { + /** + * The ID of the instance. + */ + Target: SessionTarget; + } + export interface GetConnectionStatusResponse { + /** + * The ID of the instance to check connection status. + */ + Target?: SessionTarget; + /** + * The status of the connection to the instance. For example, 'Connected' or 'Not Connected'. + */ + Status?: ConnectionStatus; + } + export interface GetDefaultPatchBaselineRequest { + /** + * Returns the default patch baseline for the specified operating system. + */ + OperatingSystem?: OperatingSystem; + } + export interface GetDefaultPatchBaselineResult { + /** + * The ID of the default patch baseline. + */ + BaselineId?: BaselineId; + /** + * The operating system for the returned patch baseline. + */ + OperatingSystem?: OperatingSystem; + } + export interface GetDeployablePatchSnapshotForInstanceRequest { + /** + * The ID of the instance for which the appropriate patch snapshot should be retrieved. + */ + InstanceId: InstanceId; + /** + * The user-defined snapshot ID. + */ + SnapshotId: SnapshotId; + } + export interface GetDeployablePatchSnapshotForInstanceResult { + /** + * The ID of the instance. + */ + InstanceId?: InstanceId; + /** + * The user-defined snapshot ID. + */ + SnapshotId?: SnapshotId; + /** + * A pre-signed Amazon S3 URL that can be used to download the patch snapshot. + */ + SnapshotDownloadUrl?: SnapshotDownloadUrl; + /** + * Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot. + */ + Product?: Product; + } + export interface GetDocumentRequest { + /** + * The name of the Systems Manager document. + */ + Name: DocumentARN; + /** + * An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed. + */ + VersionName?: DocumentVersionName; + /** + * The document version for which you want information. + */ + DocumentVersion?: DocumentVersion; + /** + * Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format. + */ + DocumentFormat?: DocumentFormat; + } + export interface GetDocumentResult { + /** + * The name of the Systems Manager document. + */ + Name?: DocumentARN; + /** + * The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed. + */ + VersionName?: DocumentVersionName; + /** + * The document version. + */ + DocumentVersion?: DocumentVersion; + /** + * The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting. + */ + Status?: DocumentStatus; + /** + * A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct." + */ + StatusInformation?: DocumentStatusInformation; + /** + * The contents of the Systems Manager document. + */ + Content?: DocumentContent; + /** + * The document type. + */ + DocumentType?: DocumentType; + /** + * The document format, either JSON or YAML. + */ + DocumentFormat?: DocumentFormat; + /** + * A description of the document attachments, including names, locations, sizes, etc. + */ + AttachmentsContent?: AttachmentContentList; + } + export interface GetInventoryRequest { + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: InventoryFilterList; + /** + * Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet. + */ + Aggregators?: InventoryAggregatorList; + /** + * The list of inventory item types to return. + */ + ResultAttributes?: ResultAttributeList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface GetInventoryResult { + /** + * Collection of inventory entities such as a collection of instance inventory. + */ + Entities?: InventoryResultEntityList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export type GetInventorySchemaMaxResults = number; + export interface GetInventorySchemaRequest { + /** + * The type of inventory item to return. + */ + TypeName?: InventoryItemTypeNameFilter; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: GetInventorySchemaMaxResults; + /** + * Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes. + */ + Aggregator?: AggregatorSchemaOnly; + /** + * Returns the sub-type schema for a specified inventory type. + */ + SubType?: IsSubTypeSchema; + } + export interface GetInventorySchemaResult { + /** + * Inventory schemas returned by the request. + */ + Schemas?: InventoryItemSchemaResultList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface GetMaintenanceWindowExecutionRequest { + /** + * The ID of the Maintenance Window execution that includes the task. + */ + WindowExecutionId: MaintenanceWindowExecutionId; + } + export interface GetMaintenanceWindowExecutionResult { + /** + * The ID of the Maintenance Window execution. + */ + WindowExecutionId?: MaintenanceWindowExecutionId; + /** + * The ID of the task executions from the Maintenance Window execution. + */ + TaskIds?: MaintenanceWindowExecutionTaskIdList; + /** + * The status of the Maintenance Window execution. + */ + Status?: MaintenanceWindowExecutionStatus; + /** + * The details explaining the Status. Only available for certain status values. + */ + StatusDetails?: MaintenanceWindowExecutionStatusDetails; + /** + * The time the Maintenance Window started running. + */ + StartTime?: DateTime; + /** + * The time the Maintenance Window finished running. + */ + EndTime?: DateTime; + } + export interface GetMaintenanceWindowExecutionTaskInvocationRequest { + /** + * The ID of the Maintenance Window execution for which the task is a part. + */ + WindowExecutionId: MaintenanceWindowExecutionId; + /** + * The ID of the specific task in the Maintenance Window task that should be retrieved. + */ + TaskId: MaintenanceWindowExecutionTaskId; + /** + * The invocation ID to retrieve. + */ + InvocationId: MaintenanceWindowExecutionTaskInvocationId; + } + export interface GetMaintenanceWindowExecutionTaskInvocationResult { + /** + * The Maintenance Window execution ID. + */ + WindowExecutionId?: MaintenanceWindowExecutionId; + /** + * The task execution ID. + */ + TaskExecutionId?: MaintenanceWindowExecutionTaskId; + /** + * The invocation ID. + */ + InvocationId?: MaintenanceWindowExecutionTaskInvocationId; + /** + * The execution ID. + */ + ExecutionId?: MaintenanceWindowExecutionTaskExecutionId; + /** + * Retrieves the task type for a Maintenance Window. Task types include the following: LAMBDA, STEP_FUNCTION, AUTOMATION, RUN_COMMAND. + */ + TaskType?: MaintenanceWindowTaskType; + /** + * The parameters used at the time that the task ran. + */ + Parameters?: MaintenanceWindowExecutionTaskInvocationParameters; + /** + * The task status for an invocation. + */ + Status?: MaintenanceWindowExecutionStatus; + /** + * The details explaining the status. Details are only available for certain status values. + */ + StatusDetails?: MaintenanceWindowExecutionStatusDetails; + /** + * The time that the task started running on the target. + */ + StartTime?: DateTime; + /** + * The time that the task finished running on the target. + */ + EndTime?: DateTime; + /** + * User-provided value to be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window. + */ + OwnerInformation?: OwnerInformation; + /** + * The Maintenance Window target ID. + */ + WindowTargetId?: MaintenanceWindowTaskTargetId; + } + export interface GetMaintenanceWindowExecutionTaskRequest { + /** + * The ID of the Maintenance Window execution that includes the task. + */ + WindowExecutionId: MaintenanceWindowExecutionId; + /** + * The ID of the specific task execution in the Maintenance Window task that should be retrieved. + */ + TaskId: MaintenanceWindowExecutionTaskId; + } + export interface GetMaintenanceWindowExecutionTaskResult { + /** + * The ID of the Maintenance Window execution that includes the task. + */ + WindowExecutionId?: MaintenanceWindowExecutionId; + /** + * The ID of the specific task execution in the Maintenance Window task that was retrieved. + */ + TaskExecutionId?: MaintenanceWindowExecutionTaskId; + /** + * The ARN of the task that ran. + */ + TaskArn?: MaintenanceWindowTaskArn; + /** + * The role that was assumed when running the task. + */ + ServiceRole?: ServiceRole; + /** + * The type of task that was run. + */ + Type?: MaintenanceWindowTaskType; + /** + * The parameters passed to the task when it was run. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters + */ + TaskParameters?: MaintenanceWindowTaskParametersList; + /** + * The priority of the task. + */ + Priority?: MaintenanceWindowTaskPriority; + /** + * The defined maximum number of task executions that could be run in parallel. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped. + */ + MaxErrors?: MaxErrors; + /** + * The status of the task. + */ + Status?: MaintenanceWindowExecutionStatus; + /** + * The details explaining the Status. Only available for certain status values. + */ + StatusDetails?: MaintenanceWindowExecutionStatusDetails; + /** + * The time the task execution started. + */ + StartTime?: DateTime; + /** + * The time the task execution completed. + */ + EndTime?: DateTime; + } + export interface GetMaintenanceWindowRequest { + /** + * The ID of the desired Maintenance Window. + */ + WindowId: MaintenanceWindowId; + } + export interface GetMaintenanceWindowResult { + /** + * The ID of the created Maintenance Window. + */ + WindowId?: MaintenanceWindowId; + /** + * The name of the Maintenance Window. + */ + Name?: MaintenanceWindowName; + /** + * The description of the Maintenance Window. + */ + Description?: MaintenanceWindowDescription; + /** + * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become active. The Maintenance Window will not run before this specified time. + */ + StartDate?: MaintenanceWindowStringDateTime; + /** + * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become inactive. The Maintenance Window will not run after this specified time. + */ + EndDate?: MaintenanceWindowStringDateTime; + /** + * The schedule of the Maintenance Window in the form of a cron or rate expression. + */ + Schedule?: MaintenanceWindowSchedule; + /** + * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. + */ + ScheduleTimezone?: MaintenanceWindowTimezone; + /** + * The next time the Maintenance Window will actually run, taking into account any specified times for the Maintenance Window to become active or inactive. + */ + NextExecutionTime?: MaintenanceWindowStringDateTime; + /** + * The duration of the Maintenance Window in hours. + */ + Duration?: MaintenanceWindowDurationHours; + /** + * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. + */ + Cutoff?: MaintenanceWindowCutoff; + /** + * Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets. + */ + AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets; + /** + * Whether the Maintenance Windows is enabled. + */ + Enabled?: MaintenanceWindowEnabled; + /** + * The date the Maintenance Window was created. + */ + CreatedDate?: DateTime; + /** + * The date the Maintenance Window was last modified. + */ + ModifiedDate?: DateTime; + } + export interface GetMaintenanceWindowTaskRequest { + /** + * The Maintenance Window ID that includes the task to retrieve. + */ + WindowId: MaintenanceWindowId; + /** + * The Maintenance Window task ID to retrieve. + */ + WindowTaskId: MaintenanceWindowTaskId; + } + export interface GetMaintenanceWindowTaskResult { + /** + * The retrieved Maintenance Window ID. + */ + WindowId?: MaintenanceWindowId; + /** + * The retrieved Maintenance Window task ID. + */ + WindowTaskId?: MaintenanceWindowTaskId; + /** + * The targets where the task should run. + */ + Targets?: Targets; + /** + * The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN. + */ + TaskArn?: MaintenanceWindowTaskArn; + /** + * The IAM service role to assume during task execution. + */ + ServiceRoleArn?: ServiceRole; + /** + * The type of task to run. + */ + TaskType?: MaintenanceWindowTaskType; + /** + * The parameters to pass to the task when it runs. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + TaskParameters?: MaintenanceWindowTaskParameters; + /** + * The parameters to pass to the task when it runs. + */ + TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters; + /** + * The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. + */ + Priority?: MaintenanceWindowTaskPriority; + /** + * The maximum number of targets allowed to run this task in parallel. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The maximum number of errors allowed before the task stops being scheduled. + */ + MaxErrors?: MaxErrors; + /** + * The location in Amazon S3 where the task results are logged. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + LoggingInfo?: LoggingInfo; + /** + * The retrieved task name. + */ + Name?: MaintenanceWindowName; + /** + * The retrieved task description. + */ + Description?: MaintenanceWindowDescription; + } + export interface GetParameterHistoryRequest { + /** + * The name of a parameter you want to query. + */ + Name: PSParameterName; + /** + * Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. + */ + WithDecryption?: Boolean; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface GetParameterHistoryResult { + /** + * A list of parameters returned by the request. + */ + Parameters?: ParameterHistoryList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface GetParameterRequest { + /** + * The name of the parameter you want to query. + */ + Name: PSParameterName; + /** + * Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. + */ + WithDecryption?: Boolean; + } + export interface GetParameterResult { + /** + * Information about a parameter. + */ + Parameter?: Parameter; + } + export type GetParametersByPathMaxResults = number; + export interface GetParametersByPathRequest { + /** + * The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33 + */ + Path: PSParameterName; + /** + * Retrieve all parameters within a hierarchy. If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b. + */ + Recursive?: Boolean; + /** + * Filters to limit the request results. You can't filter using the parameter name. + */ + ParameterFilters?: ParameterStringFilterList; + /** + * Retrieve all parameters in a hierarchy with their value decrypted. + */ + WithDecryption?: Boolean; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: GetParametersByPathMaxResults; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface GetParametersByPathResult { + /** + * A list of parameters found in the specified hierarchy. + */ + Parameters?: ParameterList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface GetParametersRequest { + /** + * Names of the parameters for which you want to query information. + */ + Names: ParameterNameList; + /** + * Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. + */ + WithDecryption?: Boolean; + } + export interface GetParametersResult { + /** + * A list of details for a parameter. + */ + Parameters?: ParameterList; + /** + * A list of parameters that are not formatted correctly or do not run when executed. + */ + InvalidParameters?: ParameterNameList; + } + export interface GetPatchBaselineForPatchGroupRequest { + /** + * The name of the patch group whose patch baseline should be retrieved. + */ + PatchGroup: PatchGroup; + /** + * Returns he operating system rule specified for patch groups using the patch baseline. + */ + OperatingSystem?: OperatingSystem; + } + export interface GetPatchBaselineForPatchGroupResult { + /** + * The ID of the patch baseline that should be used for the patch group. + */ + BaselineId?: BaselineId; + /** + * The name of the patch group. + */ + PatchGroup?: PatchGroup; + /** + * The operating system rule specified for patch groups using the patch baseline. + */ + OperatingSystem?: OperatingSystem; + } + export interface GetPatchBaselineRequest { + /** + * The ID of the patch baseline to retrieve. + */ + BaselineId: BaselineId; + } + export interface GetPatchBaselineResult { + /** + * The ID of the retrieved patch baseline. + */ + BaselineId?: BaselineId; + /** + * The name of the patch baseline. + */ + Name?: BaselineName; + /** + * Returns the operating system specified for the patch baseline. + */ + OperatingSystem?: OperatingSystem; + /** + * A set of global filters used to exclude patches from the baseline. + */ + GlobalFilters?: PatchFilterGroup; + /** + * A set of rules used to include patches in the baseline. + */ + ApprovalRules?: PatchRuleGroup; + /** + * A list of explicitly approved patches for the baseline. + */ + ApprovedPatches?: PatchIdList; + /** + * Returns the specified compliance severity level for approved patches in the patch baseline. + */ + ApprovedPatchesComplianceLevel?: PatchComplianceLevel; + /** + * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only. + */ + ApprovedPatchesEnableNonSecurity?: Boolean; + /** + * A list of explicitly rejected patches for the baseline. + */ + RejectedPatches?: PatchIdList; + /** + * The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency. + */ + RejectedPatchesAction?: PatchAction; + /** + * Patch groups included in the patch baseline. + */ + PatchGroups?: PatchGroupList; + /** + * The date the patch baseline was created. + */ + CreatedDate?: DateTime; + /** + * The date the patch baseline was last modified. + */ + ModifiedDate?: DateTime; + /** + * A description of the patch baseline. + */ + Description?: BaselineDescription; + /** + * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only. + */ + Sources?: PatchSourceList; + } + export interface GetServiceSettingRequest { + /** + * The ID of the service setting to get. + */ + SettingId: ServiceSettingId; + } + export interface GetServiceSettingResult { + /** + * The query result of the current service setting. + */ + ServiceSetting?: ServiceSetting; + } + export type IPAddress = string; + export type IamRole = string; + export type IdempotencyToken = string; + export type InstallOverrideList = string; + export interface InstanceAggregatedAssociationOverview { + /** + * Detailed status information about the aggregated associations. + */ + DetailedStatus?: StatusName; + /** + * The number of associations for the instance(s). + */ + InstanceAssociationStatusAggregatedCount?: InstanceAssociationStatusAggregatedCount; + } + export interface InstanceAssociation { + /** + * The association ID. + */ + AssociationId?: AssociationId; + /** + * The instance ID. + */ + InstanceId?: InstanceId; + /** + * The content of the association document for the instance(s). + */ + Content?: DocumentContent; + /** + * Version information for the association on the instance. + */ + AssociationVersion?: AssociationVersion; + } + export type InstanceAssociationExecutionSummary = string; + export type InstanceAssociationList = InstanceAssociation[]; + export interface InstanceAssociationOutputLocation { + /** + * An Amazon S3 bucket where you want to store the results of this request. + */ + S3Location?: S3OutputLocation; + } + export interface InstanceAssociationOutputUrl { + /** + * The URL of Amazon S3 bucket where you want to store the results of this request. + */ + S3OutputUrl?: S3OutputUrl; + } + export type InstanceAssociationStatusAggregatedCount = {[key: string]: InstanceCount}; + export interface InstanceAssociationStatusInfo { + /** + * The association ID. + */ + AssociationId?: AssociationId; + /** + * The name of the association. + */ + Name?: DocumentARN; + /** + * The association document verions. + */ + DocumentVersion?: DocumentVersion; + /** + * The version of the association applied to the instance. + */ + AssociationVersion?: AssociationVersion; + /** + * The instance ID where the association was created. + */ + InstanceId?: InstanceId; + /** + * The date the instance association ran. + */ + ExecutionDate?: DateTime; + /** + * Status information about the instance association. + */ + Status?: StatusName; + /** + * Detailed status information about the instance association. + */ + DetailedStatus?: StatusName; + /** + * Summary information about association execution. + */ + ExecutionSummary?: InstanceAssociationExecutionSummary; + /** + * An error code returned by the request to create the association. + */ + ErrorCode?: AgentErrorCode; + /** + * A URL for an Amazon S3 bucket where you want to store the results of this request. + */ + OutputUrl?: InstanceAssociationOutputUrl; + /** + * The name of the association applied to the instance. + */ + AssociationName?: AssociationName; + } + export type InstanceAssociationStatusInfos = InstanceAssociationStatusInfo[]; + export type InstanceCount = number; + export type InstanceId = string; + export type InstanceIdList = InstanceId[]; + export interface InstanceInformation { + /** + * The instance ID. + */ + InstanceId?: InstanceId; + /** + * Connection status of SSM Agent. + */ + PingStatus?: PingStatus; + /** + * The date and time when agent last pinged Systems Manager service. + */ + LastPingDateTime?: DateTime; + /** + * The version of SSM Agent running on your Linux instance. + */ + AgentVersion?: Version; + /** + * Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances. + */ + IsLatestVersion?: Boolean; + /** + * The operating system platform type. + */ + PlatformType?: PlatformType; + /** + * The name of the operating system platform running on your instance. + */ + PlatformName?: String; + /** + * The version of the OS platform running on your instance. + */ + PlatformVersion?: String; + /** + * The activation ID created by Systems Manager when the server or VM was registered. + */ + ActivationId?: ActivationId; + /** + * The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances. + */ + IamRole?: IamRole; + /** + * The date the server or VM was registered with AWS as a managed instance. + */ + RegistrationDate?: DateTime; + /** + * The type of instance. Instances are either EC2 instances or managed instances. + */ + ResourceType?: ResourceType; + /** + * The name of the managed instance. + */ + Name?: String; + /** + * The IP address of the managed instance. + */ + IPAddress?: IPAddress; + /** + * The fully qualified host name of the managed instance. + */ + ComputerName?: ComputerName; + /** + * The status of the association. + */ + AssociationStatus?: StatusName; + /** + * The date the association was last run. + */ + LastAssociationExecutionDate?: DateTime; + /** + * The last date the association was successfully run. + */ + LastSuccessfulAssociationExecutionDate?: DateTime; + /** + * Information about the association. + */ + AssociationOverview?: InstanceAggregatedAssociationOverview; + } + export interface InstanceInformationFilter { + /** + * The name of the filter. + */ + key: InstanceInformationFilterKey; + /** + * The filter values. + */ + valueSet: InstanceInformationFilterValueSet; + } + export type InstanceInformationFilterKey = "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|string; + export type InstanceInformationFilterList = InstanceInformationFilter[]; + export type InstanceInformationFilterValue = string; + export type InstanceInformationFilterValueSet = InstanceInformationFilterValue[]; + export type InstanceInformationList = InstanceInformation[]; + export interface InstanceInformationStringFilter { + /** + * The filter key name to describe your instances. For example: "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|"Tag Key" + */ + Key: InstanceInformationStringFilterKey; + /** + * The filter values. + */ + Values: InstanceInformationFilterValueSet; + } + export type InstanceInformationStringFilterKey = string; + export type InstanceInformationStringFilterList = InstanceInformationStringFilter[]; + export interface InstancePatchState { + /** + * The ID of the managed instance the high-level patch compliance information was collected for. + */ + InstanceId: InstanceId; + /** + * The name of the patch group the managed instance belongs to. + */ + PatchGroup: PatchGroup; + /** + * The ID of the patch baseline used to patch the instance. + */ + BaselineId: BaselineId; + /** + * The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected. + */ + SnapshotId?: SnapshotId; + /** + * An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline. For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide. + */ + InstallOverrideList?: InstallOverrideList; + /** + * Placeholder information. This field will always be empty in the current release of the service. + */ + OwnerInformation?: OwnerInformation; + /** + * The number of patches from the patch baseline that are installed on the instance. + */ + InstalledCount?: PatchInstalledCount; + /** + * The number of patches not specified in the patch baseline that are installed on the instance. + */ + InstalledOtherCount?: PatchInstalledOtherCount; + /** + * The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list. If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero). + */ + InstalledRejectedCount?: PatchInstalledRejectedCount; + /** + * The number of patches from the patch baseline that are applicable for the instance but aren't currently installed. + */ + MissingCount?: PatchMissingCount; + /** + * The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install. + */ + FailedCount?: PatchFailedCount; + /** + * The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory. + */ + UnreportedNotApplicableCount?: PatchUnreportedNotApplicableCount; + /** + * The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount. + */ + NotApplicableCount?: PatchNotApplicableCount; + /** + * The time the most recent patching operation was started on the instance. + */ + OperationStartTime: DateTime; + /** + * The time the most recent patching operation completed on the instance. + */ + OperationEndTime: DateTime; + /** + * The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches). + */ + Operation: PatchOperationType; + } + export interface InstancePatchStateFilter { + /** + * The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount. + */ + Key: InstancePatchStateFilterKey; + /** + * The value for the filter, must be an integer greater than or equal to 0. + */ + Values: InstancePatchStateFilterValues; + /** + * The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan. + */ + Type: InstancePatchStateOperatorType; + } + export type InstancePatchStateFilterKey = string; + export type InstancePatchStateFilterList = InstancePatchStateFilter[]; + export type InstancePatchStateFilterValue = string; + export type InstancePatchStateFilterValues = InstancePatchStateFilterValue[]; + export type InstancePatchStateList = InstancePatchState[]; + export type InstancePatchStateOperatorType = "Equal"|"NotEqual"|"LessThan"|"GreaterThan"|string; + export type InstancePatchStatesList = InstancePatchState[]; + export type InstanceTagName = string; + export type InstancesCount = number; + export type Integer = number; + export interface InventoryAggregator { + /** + * The inventory type and attribute name for aggregation. + */ + Expression?: InventoryAggregatorExpression; + /** + * Nested aggregators to further refine aggregation for an inventory type. + */ + Aggregators?: InventoryAggregatorList; + /** + * A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria. + */ + Groups?: InventoryGroupList; + } + export type InventoryAggregatorExpression = string; + export type InventoryAggregatorList = InventoryAggregator[]; + export type InventoryAttributeDataType = "string"|"number"|string; + export type InventoryDeletionId = string; + export type InventoryDeletionLastStatusMessage = string; + export type InventoryDeletionLastStatusUpdateTime = Date; + export type InventoryDeletionStartTime = Date; + export type InventoryDeletionStatus = "InProgress"|"Complete"|string; + export interface InventoryDeletionStatusItem { + /** + * The deletion ID returned by the DeleteInventory action. + */ + DeletionId?: InventoryDeletionId; + /** + * The name of the inventory data type. + */ + TypeName?: InventoryItemTypeName; + /** + * The UTC timestamp when the delete operation started. + */ + DeletionStartTime?: InventoryDeletionStartTime; + /** + * The status of the operation. Possible values are InProgress and Complete. + */ + LastStatus?: InventoryDeletionStatus; + /** + * Information about the status. + */ + LastStatusMessage?: InventoryDeletionLastStatusMessage; + /** + * Information about the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide. + */ + DeletionSummary?: InventoryDeletionSummary; + /** + * The UTC timestamp of when the last status report. + */ + LastStatusUpdateTime?: InventoryDeletionLastStatusUpdateTime; + } + export interface InventoryDeletionSummary { + /** + * The total number of items to delete. This count does not change during the delete operation. + */ + TotalCount?: TotalCount; + /** + * Remaining number of items to delete. + */ + RemainingCount?: RemainingCount; + /** + * A list of counts and versions for deleted items. + */ + SummaryItems?: InventoryDeletionSummaryItems; + } + export interface InventoryDeletionSummaryItem { + /** + * The inventory type version. + */ + Version?: InventoryItemSchemaVersion; + /** + * A count of the number of deleted items. + */ + Count?: ResourceCount; + /** + * The remaining number of items to delete. + */ + RemainingCount?: RemainingCount; + } + export type InventoryDeletionSummaryItems = InventoryDeletionSummaryItem[]; + export type InventoryDeletionsList = InventoryDeletionStatusItem[]; + export interface InventoryFilter { + /** + * The name of the filter key. + */ + Key: InventoryFilterKey; + /** + * Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal + */ + Values: InventoryFilterValueList; + /** + * The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan" + */ + Type?: InventoryQueryOperatorType; + } + export type InventoryFilterKey = string; + export type InventoryFilterList = InventoryFilter[]; + export type InventoryFilterValue = string; + export type InventoryFilterValueList = InventoryFilterValue[]; + export interface InventoryGroup { + /** + * The name of the group. + */ + Name: InventoryGroupName; + /** + * Filters define the criteria for the group. The matchingCount field displays the number of resources that match the criteria. The notMatchingCount field displays the number of resources that don't match the criteria. + */ + Filters: InventoryFilterList; + } + export type InventoryGroupList = InventoryGroup[]; + export type InventoryGroupName = string; + export interface InventoryItem { + /** + * The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate. + */ + TypeName: InventoryItemTypeName; + /** + * The schema version for the inventory item. + */ + SchemaVersion: InventoryItemSchemaVersion; + /** + * The time the inventory information was collected. + */ + CaptureTime: InventoryItemCaptureTime; + /** + * MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update. + */ + ContentHash?: InventoryItemContentHash; + /** + * The inventory data of the inventory type. + */ + Content?: InventoryItemEntryList; + /** + * A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem type. + */ + Context?: InventoryItemContentContext; + } + export interface InventoryItemAttribute { + /** + * Name of the inventory item attribute. + */ + Name: InventoryItemAttributeName; + /** + * The data type of the inventory item attribute. + */ + DataType: InventoryAttributeDataType; + } + export type InventoryItemAttributeList = InventoryItemAttribute[]; + export type InventoryItemAttributeName = string; + export type InventoryItemCaptureTime = string; + export type InventoryItemContentContext = {[key: string]: AttributeValue}; + export type InventoryItemContentHash = string; + export type InventoryItemEntry = {[key: string]: AttributeValue}; + export type InventoryItemEntryList = InventoryItemEntry[]; + export type InventoryItemList = InventoryItem[]; + export interface InventoryItemSchema { + /** + * The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate. + */ + TypeName: InventoryItemTypeName; + /** + * The schema version for the inventory item. + */ + Version?: InventoryItemSchemaVersion; + /** + * The schema attributes for inventory. This contains data type and attribute name. + */ + Attributes: InventoryItemAttributeList; + /** + * The alias name of the inventory type. The alias name is used for display purposes. + */ + DisplayName?: InventoryTypeDisplayName; + } + export type InventoryItemSchemaResultList = InventoryItemSchema[]; + export type InventoryItemSchemaVersion = string; + export type InventoryItemTypeName = string; + export type InventoryItemTypeNameFilter = string; + export type InventoryQueryOperatorType = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"|string; + export interface InventoryResultEntity { + /** + * ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID. + */ + Id?: InventoryResultEntityId; + /** + * The data section in the inventory result entity JSON. + */ + Data?: InventoryResultItemMap; + } + export type InventoryResultEntityId = string; + export type InventoryResultEntityList = InventoryResultEntity[]; + export interface InventoryResultItem { + /** + * The name of the inventory result item type. + */ + TypeName: InventoryItemTypeName; + /** + * The schema version for the inventory result item/ + */ + SchemaVersion: InventoryItemSchemaVersion; + /** + * The time inventory item data was captured. + */ + CaptureTime?: InventoryItemCaptureTime; + /** + * MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update. + */ + ContentHash?: InventoryItemContentHash; + /** + * Contains all the inventory data of the item type. Results include attribute names and values. + */ + Content: InventoryItemEntryList; + } + export type InventoryResultItemKey = string; + export type InventoryResultItemMap = {[key: string]: InventoryResultItem}; + export type InventorySchemaDeleteOption = "DisableSchema"|"DeleteSchema"|string; + export type InventoryTypeDisplayName = string; + export type InvocationTraceOutput = string; + export type IsSubTypeSchema = boolean; + export type KeyList = TagKey[]; + export interface LabelParameterVersionRequest { + /** + * The parameter name on which you want to attach one or more labels. + */ + Name: PSParameterName; + /** + * The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.) + */ + ParameterVersion?: PSParameterVersion; + /** + * One or more labels to attach to the specified parameter version. + */ + Labels: ParameterLabelList; + } + export interface LabelParameterVersionResult { + /** + * The label does not meet the requirements. For information about parameter label requirements, see Labeling Parameters in the AWS Systems Manager User Guide. + */ + InvalidLabels?: ParameterLabelList; + } + export type LastResourceDataSyncMessage = string; + export type LastResourceDataSyncStatus = "Successful"|"Failed"|"InProgress"|string; + export type LastResourceDataSyncTime = Date; + export type LastSuccessfulResourceDataSyncTime = Date; + export interface ListAssociationVersionsRequest { + /** + * The association ID for which you want to view all versions. + */ + AssociationId: AssociationId; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface ListAssociationVersionsResult { + /** + * Information about all versions of the association for the specified association ID. + */ + AssociationVersions?: AssociationVersionList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface ListAssociationsRequest { + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + AssociationFilterList?: AssociationFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface ListAssociationsResult { + /** + * The associations. + */ + Associations?: AssociationList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface ListCommandInvocationsRequest { + /** + * (Optional) The invocations for a specific command ID. + */ + CommandId?: CommandId; + /** + * (Optional) The command execution details for a specific instance ID. + */ + InstanceId?: InstanceId; + /** + * (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: CommandMaxResults; + /** + * (Optional) The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * (Optional) One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: CommandFilterList; + /** + * (Optional) If set this returns the response of the command executions and any command output. By default this is set to False. + */ + Details?: Boolean; + } + export interface ListCommandInvocationsResult { + /** + * (Optional) A list of all invocations. + */ + CommandInvocations?: CommandInvocationList; + /** + * (Optional) The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface ListCommandsRequest { + /** + * (Optional) If provided, lists only the specified command. + */ + CommandId?: CommandId; + /** + * (Optional) Lists commands issued against this instance ID. + */ + InstanceId?: InstanceId; + /** + * (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: CommandMaxResults; + /** + * (Optional) The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * (Optional) One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: CommandFilterList; + } + export interface ListCommandsResult { + /** + * (Optional) The list of commands requested by the user. + */ + Commands?: CommandList; + /** + * (Optional) The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface ListComplianceItemsRequest { + /** + * One or more compliance filters. Use a filter to return a more specific list of results. + */ + Filters?: ComplianceStringFilterList; + /** + * The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID. + */ + ResourceIds?: ComplianceResourceIdList; + /** + * The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance. + */ + ResourceTypes?: ComplianceResourceTypeList; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface ListComplianceItemsResult { + /** + * A list of compliance information for the specified resource ID. + */ + ComplianceItems?: ComplianceItemList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface ListComplianceSummariesRequest { + /** + * One or more compliance or inventory filters. Use a filter to return a more specific list of results. + */ + Filters?: ComplianceStringFilterList; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface ListComplianceSummariesResult { + /** + * A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified. + */ + ComplianceSummaryItems?: ComplianceSummaryItemList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface ListDocumentVersionsRequest { + /** + * The name of the document about which you want version information. + */ + Name: DocumentName; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface ListDocumentVersionsResult { + /** + * The document versions. + */ + DocumentVersions?: DocumentVersionList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface ListDocumentsRequest { + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + DocumentFilterList?: DocumentFilterList; + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: DocumentKeyValuesFilterList; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + } + export interface ListDocumentsResult { + /** + * The names of the Systems Manager documents. + */ + DocumentIdentifiers?: DocumentIdentifierList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface ListInventoryEntriesRequest { + /** + * The instance ID for which you want inventory information. + */ + InstanceId: InstanceId; + /** + * The type of inventory item for which you want information. + */ + TypeName: InventoryItemTypeName; + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: InventoryFilterList; + /** + * The token for the next set of items to return. (You received this token from a previous call.) + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface ListInventoryEntriesResult { + /** + * The type of inventory item returned by the request. + */ + TypeName?: InventoryItemTypeName; + /** + * The instance ID targeted by the request to query inventory information. + */ + InstanceId?: InstanceId; + /** + * The inventory schema version used by the instance(s). + */ + SchemaVersion?: InventoryItemSchemaVersion; + /** + * The time that inventory information was collected for the instance(s). + */ + CaptureTime?: InventoryItemCaptureTime; + /** + * A list of inventory items on the instance(s). + */ + Entries?: InventoryItemEntryList; + /** + * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. + */ + NextToken?: NextToken; + } + export interface ListResourceComplianceSummariesRequest { + /** + * One or more filters. Use a filter to return a more specific list of results. + */ + Filters?: ComplianceStringFilterList; + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface ListResourceComplianceSummariesResult { + /** + * A summary count for specified or targeted managed instances. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify. + */ + ResourceComplianceSummaryItems?: ResourceComplianceSummaryItemList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface ListResourceDataSyncRequest { + /** + * A token to start the list. Use this token to get the next set of results. + */ + NextToken?: NextToken; + /** + * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. + */ + MaxResults?: MaxResults; + } + export interface ListResourceDataSyncResult { + /** + * A list of your current Resource Data Sync configurations and their statuses. + */ + ResourceDataSyncItems?: ResourceDataSyncItemList; + /** + * The token for the next set of items to return. Use this token to get the next set of results. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceRequest { + /** + * Returns a list of tags for a specific resource type. + */ + ResourceType: ResourceTypeForTagging; + /** + * The resource ID for which you want to see a list of tags. + */ + ResourceId: ResourceId; + } + export interface ListTagsForResourceResult { + /** + * A list of tags. + */ + TagList?: TagList; + } + export interface LoggingInfo { + /** + * The name of an Amazon S3 bucket where execution logs are stored . + */ + S3BucketName: S3BucketName; + /** + * (Optional) The Amazon S3 bucket subfolder. + */ + S3KeyPrefix?: S3KeyPrefix; + /** + * The region where the Amazon S3 bucket is located. + */ + S3Region: S3Region; + } + export type Long = number; + export type MaintenanceWindowAllowUnassociatedTargets = boolean; + export interface MaintenanceWindowAutomationParameters { + /** + * The version of an Automation document to use during task execution. + */ + DocumentVersion?: DocumentVersion; + /** + * The parameters for the AUTOMATION task. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. For AUTOMATION task types, Systems Manager ignores any values specified for these parameters. + */ + Parameters?: AutomationParameterMap; + } + export type MaintenanceWindowCutoff = number; + export type MaintenanceWindowDescription = string; + export type MaintenanceWindowDurationHours = number; + export type MaintenanceWindowEnabled = boolean; + export interface MaintenanceWindowExecution { + /** + * The ID of the Maintenance Window. + */ + WindowId?: MaintenanceWindowId; + /** + * The ID of the Maintenance Window execution. + */ + WindowExecutionId?: MaintenanceWindowExecutionId; + /** + * The status of the execution. + */ + Status?: MaintenanceWindowExecutionStatus; + /** + * The details explaining the Status. Only available for certain status values. + */ + StatusDetails?: MaintenanceWindowExecutionStatusDetails; + /** + * The time the execution started. + */ + StartTime?: DateTime; + /** + * The time the execution finished. + */ + EndTime?: DateTime; + } + export type MaintenanceWindowExecutionId = string; + export type MaintenanceWindowExecutionList = MaintenanceWindowExecution[]; + export type MaintenanceWindowExecutionStatus = "PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|"TIMED_OUT"|"CANCELLING"|"CANCELLED"|"SKIPPED_OVERLAPPING"|string; + export type MaintenanceWindowExecutionStatusDetails = string; + export type MaintenanceWindowExecutionTaskExecutionId = string; + export type MaintenanceWindowExecutionTaskId = string; + export type MaintenanceWindowExecutionTaskIdList = MaintenanceWindowExecutionTaskId[]; + export interface MaintenanceWindowExecutionTaskIdentity { + /** + * The ID of the Maintenance Window execution that ran the task. + */ + WindowExecutionId?: MaintenanceWindowExecutionId; + /** + * The ID of the specific task execution in the Maintenance Window execution. + */ + TaskExecutionId?: MaintenanceWindowExecutionTaskId; + /** + * The status of the task execution. + */ + Status?: MaintenanceWindowExecutionStatus; + /** + * The details explaining the status of the task execution. Only available for certain status values. + */ + StatusDetails?: MaintenanceWindowExecutionStatusDetails; + /** + * The time the task execution started. + */ + StartTime?: DateTime; + /** + * The time the task execution finished. + */ + EndTime?: DateTime; + /** + * The ARN of the task that ran. + */ + TaskArn?: MaintenanceWindowTaskArn; + /** + * The type of task that ran. + */ + TaskType?: MaintenanceWindowTaskType; + } + export type MaintenanceWindowExecutionTaskIdentityList = MaintenanceWindowExecutionTaskIdentity[]; + export type MaintenanceWindowExecutionTaskInvocationId = string; + export interface MaintenanceWindowExecutionTaskInvocationIdentity { + /** + * The ID of the Maintenance Window execution that ran the task. + */ + WindowExecutionId?: MaintenanceWindowExecutionId; + /** + * The ID of the specific task execution in the Maintenance Window execution. + */ + TaskExecutionId?: MaintenanceWindowExecutionTaskId; + /** + * The ID of the task invocation. + */ + InvocationId?: MaintenanceWindowExecutionTaskInvocationId; + /** + * The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID. + */ + ExecutionId?: MaintenanceWindowExecutionTaskExecutionId; + /** + * The task type. + */ + TaskType?: MaintenanceWindowTaskType; + /** + * The parameters that were provided for the invocation when it was run. + */ + Parameters?: MaintenanceWindowExecutionTaskInvocationParameters; + /** + * The status of the task invocation. + */ + Status?: MaintenanceWindowExecutionStatus; + /** + * The details explaining the status of the task invocation. Only available for certain Status values. + */ + StatusDetails?: MaintenanceWindowExecutionStatusDetails; + /** + * The time the invocation started. + */ + StartTime?: DateTime; + /** + * The time the invocation finished. + */ + EndTime?: DateTime; + /** + * User-provided value that was specified when the target was registered with the Maintenance Window. This was also included in any CloudWatch events raised during the task invocation. + */ + OwnerInformation?: OwnerInformation; + /** + * The ID of the target definition in this Maintenance Window the invocation was performed for. + */ + WindowTargetId?: MaintenanceWindowTaskTargetId; + } + export type MaintenanceWindowExecutionTaskInvocationIdentityList = MaintenanceWindowExecutionTaskInvocationIdentity[]; + export type MaintenanceWindowExecutionTaskInvocationParameters = string; + export interface MaintenanceWindowFilter { + /** + * The name of the filter. + */ + Key?: MaintenanceWindowFilterKey; + /** + * The filter values. + */ + Values?: MaintenanceWindowFilterValues; + } + export type MaintenanceWindowFilterKey = string; + export type MaintenanceWindowFilterList = MaintenanceWindowFilter[]; + export type MaintenanceWindowFilterValue = string; + export type MaintenanceWindowFilterValues = MaintenanceWindowFilterValue[]; + export type MaintenanceWindowId = string; + export interface MaintenanceWindowIdentity { + /** + * The ID of the Maintenance Window. + */ + WindowId?: MaintenanceWindowId; + /** + * The name of the Maintenance Window. + */ + Name?: MaintenanceWindowName; + /** + * A description of the Maintenance Window. + */ + Description?: MaintenanceWindowDescription; + /** + * Whether the Maintenance Window is enabled. + */ + Enabled?: MaintenanceWindowEnabled; + /** + * The duration of the Maintenance Window in hours. + */ + Duration?: MaintenanceWindowDurationHours; + /** + * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. + */ + Cutoff?: MaintenanceWindowCutoff; + /** + * The schedule of the Maintenance Window in the form of a cron or rate expression. + */ + Schedule?: MaintenanceWindowSchedule; + /** + * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. + */ + ScheduleTimezone?: MaintenanceWindowTimezone; + /** + * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become inactive. + */ + EndDate?: MaintenanceWindowStringDateTime; + /** + * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become active. + */ + StartDate?: MaintenanceWindowStringDateTime; + /** + * The next time the Maintenance Window will actually run, taking into account any specified times for the Maintenance Window to become active or inactive. + */ + NextExecutionTime?: MaintenanceWindowStringDateTime; + } + export interface MaintenanceWindowIdentityForTarget { + /** + * The ID of the Maintenance Window. + */ + WindowId?: MaintenanceWindowId; + /** + * The name of the Maintenance Window. + */ + Name?: MaintenanceWindowName; + } + export type MaintenanceWindowIdentityList = MaintenanceWindowIdentity[]; + export type MaintenanceWindowLambdaClientContext = string; + export interface MaintenanceWindowLambdaParameters { + /** + * Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. + */ + ClientContext?: MaintenanceWindowLambdaClientContext; + /** + * (Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points. + */ + Qualifier?: MaintenanceWindowLambdaQualifier; + /** + * JSON to provide to your Lambda function as input. + */ + Payload?: MaintenanceWindowLambdaPayload; + } + export type MaintenanceWindowLambdaPayload = Buffer|Uint8Array|Blob|string; + export type MaintenanceWindowLambdaQualifier = string; + export type MaintenanceWindowMaxResults = number; + export type MaintenanceWindowName = string; + export type MaintenanceWindowResourceType = "INSTANCE"|string; + export interface MaintenanceWindowRunCommandParameters { + /** + * Information about the command(s) to run. + */ + Comment?: Comment; + /** + * The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated. + */ + DocumentHash?: DocumentHash; + /** + * SHA-256 or SHA-1. SHA-1 hashes have been deprecated. + */ + DocumentHashType?: DocumentHashType; + /** + * Configurations for sending notifications about command status changes on a per-instance basis. + */ + NotificationConfig?: NotificationConfig; + /** + * The name of the Amazon S3 bucket. + */ + OutputS3BucketName?: S3BucketName; + /** + * The Amazon S3 bucket subfolder. + */ + OutputS3KeyPrefix?: S3KeyPrefix; + /** + * The parameters for the RUN_COMMAND task execution. + */ + Parameters?: Parameters; + /** + * The IAM service role to assume during task execution. + */ + ServiceRoleArn?: ServiceRole; + /** + * If this time is reached and the command has not already started running, it doesn't run. + */ + TimeoutSeconds?: TimeoutSeconds; + } + export type MaintenanceWindowSchedule = string; + export type MaintenanceWindowSearchMaxResults = number; + export type MaintenanceWindowStepFunctionsInput = string; + export type MaintenanceWindowStepFunctionsName = string; + export interface MaintenanceWindowStepFunctionsParameters { + /** + * The inputs for the STEP_FUNCTION task. + */ + Input?: MaintenanceWindowStepFunctionsInput; + /** + * The name of the STEP_FUNCTION task. + */ + Name?: MaintenanceWindowStepFunctionsName; + } + export type MaintenanceWindowStringDateTime = string; + export interface MaintenanceWindowTarget { + /** + * The ID of the Maintenance Window to register the target with. + */ + WindowId?: MaintenanceWindowId; + /** + * The ID of the target. + */ + WindowTargetId?: MaintenanceWindowTargetId; + /** + * The type of target that is being registered with the Maintenance Window. + */ + ResourceType?: MaintenanceWindowResourceType; + /** + * The targets, either instances or tags. Specify instances using the following format: Key=instanceids,Values=<instanceid1>,<instanceid2> Tags are specified using the following format: Key=<tag name>,Values=<tag value>. + */ + Targets?: Targets; + /** + * A user-provided value that will be included in any CloudWatch events that are raised while running tasks for these targets in this Maintenance Window. + */ + OwnerInformation?: OwnerInformation; + /** + * The target name. + */ + Name?: MaintenanceWindowName; + /** + * A description for the target. + */ + Description?: MaintenanceWindowDescription; + } + export type MaintenanceWindowTargetId = string; + export type MaintenanceWindowTargetList = MaintenanceWindowTarget[]; + export interface MaintenanceWindowTask { + /** + * The ID of the Maintenance Window where the task is registered. + */ + WindowId?: MaintenanceWindowId; + /** + * The task ID. + */ + WindowTaskId?: MaintenanceWindowTaskId; + /** + * The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN. + */ + TaskArn?: MaintenanceWindowTaskArn; + /** + * The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION. + */ + Type?: MaintenanceWindowTaskType; + /** + * The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>. + */ + Targets?: Targets; + /** + * The parameters that should be passed to the task when it is run. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + TaskParameters?: MaintenanceWindowTaskParameters; + /** + * The priority of the task in the Maintenance Window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. + */ + Priority?: MaintenanceWindowTaskPriority; + /** + * Information about an Amazon S3 bucket to write task-level logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + LoggingInfo?: LoggingInfo; + /** + * The role that should be assumed when running the task. + */ + ServiceRoleArn?: ServiceRole; + /** + * The maximum number of targets this task can be run for, in parallel. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The maximum number of errors allowed before this task stops being scheduled. + */ + MaxErrors?: MaxErrors; + /** + * The task name. + */ + Name?: MaintenanceWindowName; + /** + * A description of the task. + */ + Description?: MaintenanceWindowDescription; + } + export type MaintenanceWindowTaskArn = string; + export type MaintenanceWindowTaskId = string; + export interface MaintenanceWindowTaskInvocationParameters { + /** + * The parameters for a RUN_COMMAND task type. + */ + RunCommand?: MaintenanceWindowRunCommandParameters; + /** + * The parameters for an AUTOMATION task type. + */ + Automation?: MaintenanceWindowAutomationParameters; + /** + * The parameters for a STEP_FUNCTION task type. + */ + StepFunctions?: MaintenanceWindowStepFunctionsParameters; + /** + * The parameters for a LAMBDA task type. + */ + Lambda?: MaintenanceWindowLambdaParameters; + } + export type MaintenanceWindowTaskList = MaintenanceWindowTask[]; + export type MaintenanceWindowTaskParameterName = string; + export type MaintenanceWindowTaskParameterValue = string; + export interface MaintenanceWindowTaskParameterValueExpression { + /** + * This field contains an array of 0 or more strings, each 1 to 255 characters in length. + */ + Values?: MaintenanceWindowTaskParameterValueList; + } + export type MaintenanceWindowTaskParameterValueList = MaintenanceWindowTaskParameterValue[]; + export type MaintenanceWindowTaskParameters = {[key: string]: MaintenanceWindowTaskParameterValueExpression}; + export type MaintenanceWindowTaskParametersList = MaintenanceWindowTaskParameters[]; + export type MaintenanceWindowTaskPriority = number; + export type MaintenanceWindowTaskTargetId = string; + export type MaintenanceWindowTaskType = "RUN_COMMAND"|"AUTOMATION"|"STEP_FUNCTIONS"|"LAMBDA"|string; + export type MaintenanceWindowTimezone = string; + export type MaintenanceWindowsForTargetList = MaintenanceWindowIdentityForTarget[]; + export type ManagedInstanceId = string; + export type MaxConcurrency = string; + export type MaxErrors = string; + export type MaxResults = number; + export type MaxResultsEC2Compatible = number; + export interface ModifyDocumentPermissionRequest { + /** + * The name of the document that you want to share. + */ + Name: DocumentName; + /** + * The permission type for the document. The permission type can be Share. + */ + PermissionType: DocumentPermissionType; + /** + * The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All. + */ + AccountIdsToAdd?: AccountIdList; + /** + * The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document. + */ + AccountIdsToRemove?: AccountIdList; + } + export interface ModifyDocumentPermissionResponse { + } + export type NextToken = string; + export interface NonCompliantSummary { + /** + * The total number of compliance items that are not compliant. + */ + NonCompliantCount?: ComplianceSummaryCount; + /** + * A summary of the non-compliance severity by compliance type + */ + SeveritySummary?: SeveritySummary; + } + export type NormalStringMap = {[key: string]: String}; + export type NotificationArn = string; + export interface NotificationConfig { + /** + * An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic. + */ + NotificationArn?: NotificationArn; + /** + * The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide. + */ + NotificationEvents?: NotificationEventList; + /** + * Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. + */ + NotificationType?: NotificationType; + } + export type NotificationEvent = "All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string; + export type NotificationEventList = NotificationEvent[]; + export type NotificationType = "Command"|"Invocation"|string; + export type OperatingSystem = "WINDOWS"|"AMAZON_LINUX"|"AMAZON_LINUX_2"|"UBUNTU"|"REDHAT_ENTERPRISE_LINUX"|"SUSE"|"CENTOS"|string; + export interface OutputSource { + /** + * The ID of the output source, for example the URL of an Amazon S3 bucket. + */ + OutputSourceId?: OutputSourceId; + /** + * The type of source where the association execution details are stored, for example, Amazon S3. + */ + OutputSourceType?: OutputSourceType; + } + export type OutputSourceId = string; + export type OutputSourceType = string; + export type OwnerInformation = string; + export type PSParameterName = string; + export type PSParameterSelector = string; + export type PSParameterValue = string; + export type PSParameterVersion = number; + export interface Parameter { + /** + * The name of the parameter. + */ + Name?: PSParameterName; + /** + * The type of parameter. Valid values include the following: String, String list, Secure string. + */ + Type?: ParameterType; + /** + * The parameter value. + */ + Value?: PSParameterValue; + /** + * The parameter version. + */ + Version?: PSParameterVersion; + /** + * Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats: parameter_name:version parameter_name:label + */ + Selector?: PSParameterSelector; + /** + * Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source. + */ + SourceResult?: String; + /** + * Date the parameter was last changed or updated and the parameter version was created. + */ + LastModifiedDate?: DateTime; + /** + * The Amazon Resource Name (ARN) of the parameter. + */ + ARN?: String; + } + export type ParameterDescription = string; + export interface ParameterHistory { + /** + * The name of the parameter. + */ + Name?: PSParameterName; + /** + * The type of parameter used. + */ + Type?: ParameterType; + /** + * The ID of the query key used for this parameter. + */ + KeyId?: ParameterKeyId; + /** + * Date the parameter was last changed or updated. + */ + LastModifiedDate?: DateTime; + /** + * Amazon Resource Name (ARN) of the AWS user who last changed the parameter. + */ + LastModifiedUser?: String; + /** + * Information about the parameter. + */ + Description?: ParameterDescription; + /** + * The parameter value. + */ + Value?: PSParameterValue; + /** + * Parameter names can include the following letters and symbols. a-zA-Z0-9_.- + */ + AllowedPattern?: AllowedPattern; + /** + * The parameter version. + */ + Version?: PSParameterVersion; + /** + * Labels assigned to the parameter version. + */ + Labels?: ParameterLabelList; + /** + * The parameter tier. + */ + Tier?: ParameterTier; + /** + * Information about the policies assigned to a parameter. + */ + Policies?: ParameterPolicyList; + } + export type ParameterHistoryList = ParameterHistory[]; + export interface ParameterInlinePolicy { + /** + * The JSON text of the policy. + */ + PolicyText?: String; + /** + * The type of policy. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification. + */ + PolicyType?: String; + /** + * The status of the policy. Policies report the following statuses: Pending (the policy has not been enforced or applied yet), Finished (the policy was applied), Failed (the policy was not applied), or InProgress (the policy is being applied now). + */ + PolicyStatus?: String; + } + export type ParameterKeyId = string; + export type ParameterLabel = string; + export type ParameterLabelList = ParameterLabel[]; + export type ParameterList = Parameter[]; + export interface ParameterMetadata { + /** + * The parameter name. + */ + Name?: PSParameterName; + /** + * The type of parameter. Valid parameter types include the following: String, String list, Secure string. + */ + Type?: ParameterType; + /** + * The ID of the query key used for this parameter. + */ + KeyId?: ParameterKeyId; + /** + * Date the parameter was last changed or updated. + */ + LastModifiedDate?: DateTime; + /** + * Amazon Resource Name (ARN) of the AWS user who last changed the parameter. + */ + LastModifiedUser?: String; + /** + * Description of the parameter actions. + */ + Description?: ParameterDescription; + /** + * A parameter name can include only the following letters and symbols. a-zA-Z0-9_.- + */ + AllowedPattern?: AllowedPattern; + /** + * The parameter version. + */ + Version?: PSParameterVersion; + /** + * The parameter tier. + */ + Tier?: ParameterTier; + /** + * A list of policies associated with a parameter. + */ + Policies?: ParameterPolicyList; + } + export type ParameterMetadataList = ParameterMetadata[]; + export type ParameterName = string; + export type ParameterNameList = PSParameterName[]; + export type ParameterPolicies = string; + export type ParameterPolicyList = ParameterInlinePolicy[]; + export interface ParameterStringFilter { + /** + * The name of the filter. + */ + Key: ParameterStringFilterKey; + /** + * Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel. + */ + Option?: ParameterStringQueryOption; + /** + * The value you want to search for. + */ + Values?: ParameterStringFilterValueList; + } + export type ParameterStringFilterKey = string; + export type ParameterStringFilterList = ParameterStringFilter[]; + export type ParameterStringFilterValue = string; + export type ParameterStringFilterValueList = ParameterStringFilterValue[]; + export type ParameterStringQueryOption = string; + export type ParameterTier = "Standard"|"Advanced"|string; + export type ParameterType = "String"|"StringList"|"SecureString"|string; + export type ParameterValue = string; + export type ParameterValueList = ParameterValue[]; + export type Parameters = {[key: string]: ParameterValueList}; + export interface ParametersFilter { + /** + * The name of the filter. + */ + Key: ParametersFilterKey; + /** + * The filter values. + */ + Values: ParametersFilterValueList; + } + export type ParametersFilterKey = "Name"|"Type"|"KeyId"|string; + export type ParametersFilterList = ParametersFilter[]; + export type ParametersFilterValue = string; + export type ParametersFilterValueList = ParametersFilterValue[]; + export interface Patch { + /** + * The ID of the patch (this is different than the Microsoft Knowledge Base ID). + */ + Id?: PatchId; + /** + * The date the patch was released. + */ + ReleaseDate?: DateTime; + /** + * The title of the patch. + */ + Title?: PatchTitle; + /** + * The description of the patch. + */ + Description?: PatchDescription; + /** + * The URL where more information can be obtained about the patch. + */ + ContentUrl?: PatchContentUrl; + /** + * The name of the vendor providing the patch. + */ + Vendor?: PatchVendor; + /** + * The product family the patch is applicable for (for example, Windows). + */ + ProductFamily?: PatchProductFamily; + /** + * The specific product the patch is applicable for (for example, WindowsServer2016). + */ + Product?: PatchProduct; + /** + * The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates). + */ + Classification?: PatchClassification; + /** + * The severity of the patch (for example Critical, Important, Moderate). + */ + MsrcSeverity?: PatchMsrcSeverity; + /** + * The Microsoft Knowledge Base ID of the patch. + */ + KbNumber?: PatchKbNumber; + /** + * The ID of the MSRC bulletin the patch is related to. + */ + MsrcNumber?: PatchMsrcNumber; + /** + * The language of the patch if it's language-specific. + */ + Language?: PatchLanguage; + } + export type PatchAction = "ALLOW_AS_DEPENDENCY"|"BLOCK"|string; + export interface PatchBaselineIdentity { + /** + * The ID of the patch baseline. + */ + BaselineId?: BaselineId; + /** + * The name of the patch baseline. + */ + BaselineName?: BaselineName; + /** + * Defines the operating system the patch baseline applies to. The Default value is WINDOWS. + */ + OperatingSystem?: OperatingSystem; + /** + * The description of the patch baseline. + */ + BaselineDescription?: BaselineDescription; + /** + * Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. + */ + DefaultBaseline?: DefaultBaseline; + } + export type PatchBaselineIdentityList = PatchBaselineIdentity[]; + export type PatchBaselineMaxResults = number; + export type PatchClassification = string; + export interface PatchComplianceData { + /** + * The title of the patch. + */ + Title: PatchTitle; + /** + * The operating system-specific ID of the patch. + */ + KBId: PatchKbNumber; + /** + * The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates). + */ + Classification: PatchClassification; + /** + * The severity of the patch (for example, Critical, Important, Moderate). + */ + Severity: PatchSeverity; + /** + * The state of the patch on the instance, such as INSTALLED or FAILED. For descriptions of each patch state, see About Patch Compliance in the AWS Systems Manager User Guide. + */ + State: PatchComplianceDataState; + /** + * The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information. + */ + InstalledTime: DateTime; + } + export type PatchComplianceDataList = PatchComplianceData[]; + export type PatchComplianceDataState = "INSTALLED"|"INSTALLED_OTHER"|"INSTALLED_REJECTED"|"MISSING"|"NOT_APPLICABLE"|"FAILED"|string; + export type PatchComplianceLevel = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED"|string; + export type PatchComplianceMaxResults = number; + export type PatchContentUrl = string; + export type PatchDeploymentStatus = "APPROVED"|"PENDING_APPROVAL"|"EXPLICIT_APPROVED"|"EXPLICIT_REJECTED"|string; + export type PatchDescription = string; + export type PatchFailedCount = number; + export interface PatchFilter { + /** + * The key for the filter. Run the DescribePatchProperties command to view lists of valid keys for each operating system type. + */ + Key: PatchFilterKey; + /** + * The value for the filter key. Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type. + */ + Values: PatchFilterValueList; + } + export interface PatchFilterGroup { + /** + * The set of patch filters that make up the group. + */ + PatchFilters: PatchFilterList; + } + export type PatchFilterKey = "PATCH_SET"|"PRODUCT"|"PRODUCT_FAMILY"|"CLASSIFICATION"|"MSRC_SEVERITY"|"PATCH_ID"|"SECTION"|"PRIORITY"|"SEVERITY"|string; + export type PatchFilterList = PatchFilter[]; + export type PatchFilterValue = string; + export type PatchFilterValueList = PatchFilterValue[]; + export type PatchGroup = string; + export type PatchGroupList = PatchGroup[]; + export interface PatchGroupPatchBaselineMapping { + /** + * The name of the patch group registered with the patch baseline. + */ + PatchGroup?: PatchGroup; + /** + * The patch baseline the patch group is registered with. + */ + BaselineIdentity?: PatchBaselineIdentity; + } + export type PatchGroupPatchBaselineMappingList = PatchGroupPatchBaselineMapping[]; + export type PatchId = string; + export type PatchIdList = PatchId[]; + export type PatchInstalledCount = number; + export type PatchInstalledOtherCount = number; + export type PatchInstalledRejectedCount = number; + export type PatchKbNumber = string; + export type PatchLanguage = string; + export type PatchList = Patch[]; + export type PatchMissingCount = number; + export type PatchMsrcNumber = string; + export type PatchMsrcSeverity = string; + export type PatchNotApplicableCount = number; + export type PatchOperationType = "Scan"|"Install"|string; + export interface PatchOrchestratorFilter { + /** + * The key for the filter. + */ + Key?: PatchOrchestratorFilterKey; + /** + * The value for the filter. + */ + Values?: PatchOrchestratorFilterValues; + } + export type PatchOrchestratorFilterKey = string; + export type PatchOrchestratorFilterList = PatchOrchestratorFilter[]; + export type PatchOrchestratorFilterValue = string; + export type PatchOrchestratorFilterValues = PatchOrchestratorFilterValue[]; + export type PatchProduct = string; + export type PatchProductFamily = string; + export type PatchPropertiesList = PatchPropertyEntry[]; + export type PatchProperty = "PRODUCT"|"PRODUCT_FAMILY"|"CLASSIFICATION"|"MSRC_SEVERITY"|"PRIORITY"|"SEVERITY"|string; + export type PatchPropertyEntry = {[key: string]: AttributeValue}; + export interface PatchRule { + /** + * The patch filter group that defines the criteria for the rule. + */ + PatchFilterGroup: PatchFilterGroup; + /** + * A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational. + */ + ComplianceLevel?: PatchComplianceLevel; + /** + * The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. + */ + ApproveAfterDays: ApproveAfterDays; + /** + * For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only. + */ + EnableNonSecurity?: Boolean; + } + export interface PatchRuleGroup { + /** + * The rules that make up the rule group. + */ + PatchRules: PatchRuleList; + } + export type PatchRuleList = PatchRule[]; + export type PatchSet = "OS"|"APPLICATION"|string; + export type PatchSeverity = string; + export interface PatchSource { + /** + * The name specified to identify the patch source. + */ + Name: PatchSourceName; + /** + * The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter. + */ + Products: PatchSourceProductList; + /** + * The value of the yum repo configuration. For example: [main] cachedir=/var/cache/yum/$basesearch$releasever keepcache=0 debuglevel=2 + */ + Configuration: PatchSourceConfiguration; + } + export type PatchSourceConfiguration = string; + export type PatchSourceList = PatchSource[]; + export type PatchSourceName = string; + export type PatchSourceProduct = string; + export type PatchSourceProductList = PatchSourceProduct[]; + export interface PatchStatus { + /** + * The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED). + */ + DeploymentStatus?: PatchDeploymentStatus; + /** + * The compliance severity level for a patch. + */ + ComplianceLevel?: PatchComplianceLevel; + /** + * The date the patch was approved (or will be approved if the status is PENDING_APPROVAL). + */ + ApprovalDate?: DateTime; + } + export type PatchTitle = string; + export type PatchUnreportedNotApplicableCount = number; + export type PatchVendor = string; + export type PingStatus = "Online"|"ConnectionLost"|"Inactive"|string; + export type PlatformType = "Windows"|"Linux"|string; + export type PlatformTypeList = PlatformType[]; + export type Product = string; + export interface ProgressCounters { + /** + * The total number of steps run in all specified AWS Regions and accounts for the current Automation execution. + */ + TotalSteps?: Integer; + /** + * The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution. + */ + SuccessSteps?: Integer; + /** + * The total number of steps that failed to run in all specified AWS Regions and accounts for the current Automation execution. + */ + FailedSteps?: Integer; + /** + * The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution. + */ + CancelledSteps?: Integer; + /** + * The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution. + */ + TimedOutSteps?: Integer; + } + export interface PutComplianceItemsRequest { + /** + * Specify an ID for this resource. For a managed instance, this is the instance ID. + */ + ResourceId: ComplianceResourceId; + /** + * Specify the type of resource. ManagedInstance is currently the only supported resource type. + */ + ResourceType: ComplianceResourceType; + /** + * Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string. + */ + ComplianceType: ComplianceTypeName; + /** + * A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. + */ + ExecutionSummary: ComplianceExecutionSummary; + /** + * Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, etc. + */ + Items: ComplianceItemEntryList; + /** + * MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored. + */ + ItemContentHash?: ComplianceItemContentHash; + } + export interface PutComplianceItemsResult { + } + export type PutInventoryMessage = string; + export interface PutInventoryRequest { + /** + * One or more instance IDs where you want to add or update inventory items. + */ + InstanceId: InstanceId; + /** + * The inventory items that you want to add or update on instances. + */ + Items: InventoryItemList; + } + export interface PutInventoryResult { + /** + * Information about the request. + */ + Message?: PutInventoryMessage; + } + export interface PutParameterRequest { + /** + * The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13 Naming Constraints: Parameter names are case sensitive. A parameter name must be unique within an AWS Region A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive). Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/ A parameter name can't include spaces. Parameter hierarchies are limited to a maximum depth of fifteen levels. For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide. The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters. + */ + Name: PSParameterName; + /** + * Information about the parameter that you want to add to the system. Optional but recommended. Do not enter personally identifiable information in this field. + */ + Description?: ParameterDescription; + /** + * The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. + */ + Value: PSParameterValue; + /** + * The type of parameter that you want to add to the system. Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type. SecureString is not currently supported for AWS CloudFormation templates or in the China Regions. + */ + Type: ParameterType; + /** + * The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account. To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key. To use a custom KMS key, choose the SecureString data type with the Key ID parameter. + */ + KeyId?: ParameterKeyId; + /** + * Overwrite an existing parameter. If not specified, will default to "false". + */ + Overwrite?: Boolean; + /** + * A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$ + */ + AllowedPattern?: AllowedPattern; + /** + * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs: Key=Resource,Value=S3bucket Key=OS,Value=Windows Key=ParameterType,Value=LicenseKey To add tags to an existing Systems Manager parameter, use the AddTagsToResource action. + */ + Tags?: TagList; + /** + * Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost. Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge. If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters. If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide. + */ + Tier?: ParameterTier; + /** + * One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types: Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter. ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours. NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed. All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies. + */ + Policies?: ParameterPolicies; + } + export interface PutParameterResult { + /** + * The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called. + */ + Version?: PSParameterVersion; + } + export type Region = string; + export type Regions = Region[]; + export interface RegisterDefaultPatchBaselineRequest { + /** + * The ID of the patch baseline that should be the default patch baseline. + */ + BaselineId: BaselineId; + } + export interface RegisterDefaultPatchBaselineResult { + /** + * The ID of the default patch baseline. + */ + BaselineId?: BaselineId; + } + export interface RegisterPatchBaselineForPatchGroupRequest { + /** + * The ID of the patch baseline to register the patch group with. + */ + BaselineId: BaselineId; + /** + * The name of the patch group that should be registered with the patch baseline. + */ + PatchGroup: PatchGroup; + } + export interface RegisterPatchBaselineForPatchGroupResult { + /** + * The ID of the patch baseline the patch group was registered with. + */ + BaselineId?: BaselineId; + /** + * The name of the patch group registered with the patch baseline. + */ + PatchGroup?: PatchGroup; + } + export interface RegisterTargetWithMaintenanceWindowRequest { + /** + * The ID of the Maintenance Window the target should be registered with. + */ + WindowId: MaintenanceWindowId; + /** + * The type of target being registered with the Maintenance Window. + */ + ResourceType: MaintenanceWindowResourceType; + /** + * The targets (either instances or tags). Specify instances using the following format: Key=InstanceIds,Values=<instance-id-1>,<instance-id-2> Specify tags using either of the following formats: Key=tag:<tag-key>,Values=<tag-value-1>,<tag-value-2> Key=tag-key,Values=<tag-key-1>,<tag-key-2> + */ + Targets: Targets; + /** + * User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window. + */ + OwnerInformation?: OwnerInformation; + /** + * An optional name for the target. + */ + Name?: MaintenanceWindowName; + /** + * An optional description for the target. + */ + Description?: MaintenanceWindowDescription; + /** + * User-provided idempotency token. + */ + ClientToken?: ClientToken; + } + export interface RegisterTargetWithMaintenanceWindowResult { + /** + * The ID of the target definition in this Maintenance Window. + */ + WindowTargetId?: MaintenanceWindowTargetId; + } + export interface RegisterTaskWithMaintenanceWindowRequest { + /** + * The ID of the Maintenance Window the task should be added to. + */ + WindowId: MaintenanceWindowId; + /** + * The targets (either instances or Maintenance Window targets). Specify instances using the following format: Key=InstanceIds,Values=<instance-id-1>,<instance-id-2> Specify Maintenance Window targets using the following format: Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2> + */ + Targets: Targets; + /** + * The ARN of the task to run. + */ + TaskArn: MaintenanceWindowTaskArn; + /** + * The role to assume when running the Maintenance Window task. If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN. For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide. + */ + ServiceRoleArn?: ServiceRole; + /** + * The type of task being registered. + */ + TaskType: MaintenanceWindowTaskType; + /** + * The parameters that should be passed to the task when it is run. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + TaskParameters?: MaintenanceWindowTaskParameters; + /** + * The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty. + */ + TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters; + /** + * The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel. + */ + Priority?: MaintenanceWindowTaskPriority; + /** + * The maximum number of targets this task can be run for in parallel. + */ + MaxConcurrency: MaxConcurrency; + /** + * The maximum number of errors allowed before this task stops being scheduled. + */ + MaxErrors: MaxErrors; + /** + * A structure containing information about an Amazon S3 bucket to write instance-level logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + LoggingInfo?: LoggingInfo; + /** + * An optional name for the task. + */ + Name?: MaintenanceWindowName; + /** + * An optional description for the task. + */ + Description?: MaintenanceWindowDescription; + /** + * User-provided idempotency token. + */ + ClientToken?: ClientToken; + } + export interface RegisterTaskWithMaintenanceWindowResult { + /** + * The ID of the task in the Maintenance Window. + */ + WindowTaskId?: MaintenanceWindowTaskId; + } + export type RegistrationLimit = number; + export type RegistrationsCount = number; + export type RemainingCount = number; + export interface RemoveTagsFromResourceRequest { + /** + * The type of resource of which you want to remove a tag. The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f. + */ + ResourceType: ResourceTypeForTagging; + /** + * The resource ID for which you want to remove tags. Use the ID of the resource. Here are some examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde For the Document and Parameter values, use the name of the resource. The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f. + */ + ResourceId: ResourceId; + /** + * Tag keys that you want to remove from the specified resource. + */ + TagKeys: KeyList; + } + export interface RemoveTagsFromResourceResult { + } + export interface ResetServiceSettingRequest { + /** + * The ID of the service setting to reset. + */ + SettingId: ServiceSettingId; + } + export interface ResetServiceSettingResult { + /** + * The current, effective service setting after calling the ResetServiceSetting API action. + */ + ServiceSetting?: ServiceSetting; + } + export interface ResolvedTargets { + /** + * A list of parameter values sent to targets that resolved during the Automation execution. + */ + ParameterValues?: TargetParameterList; + /** + * A boolean value indicating whether the resolved target list is truncated. + */ + Truncated?: Boolean; + } + export interface ResourceComplianceSummaryItem { + /** + * The compliance type. + */ + ComplianceType?: ComplianceTypeName; + /** + * The resource type. + */ + ResourceType?: ComplianceResourceType; + /** + * The resource ID. + */ + ResourceId?: ComplianceResourceId; + /** + * The compliance status for the resource. + */ + Status?: ComplianceStatus; + /** + * The highest severity item found for the resource. The resource is compliant for this item. + */ + OverallSeverity?: ComplianceSeverity; + /** + * Information about the execution. + */ + ExecutionSummary?: ComplianceExecutionSummary; + /** + * A list of items that are compliant for the resource. + */ + CompliantSummary?: CompliantSummary; + /** + * A list of items that aren't compliant for the resource. + */ + NonCompliantSummary?: NonCompliantSummary; + } + export type ResourceComplianceSummaryItemList = ResourceComplianceSummaryItem[]; + export type ResourceCount = number; + export type ResourceCountByStatus = string; + export type ResourceDataSyncAWSKMSKeyARN = string; + export type ResourceDataSyncCreatedTime = Date; + export interface ResourceDataSyncItem { + /** + * The name of the Resource Data Sync. + */ + SyncName?: ResourceDataSyncName; + /** + * Configuration information for the target Amazon S3 bucket. + */ + S3Destination?: ResourceDataSyncS3Destination; + /** + * The last time the configuration attempted to sync (UTC). + */ + LastSyncTime?: LastResourceDataSyncTime; + /** + * The last time the sync operations returned a status of SUCCESSFUL (UTC). + */ + LastSuccessfulSyncTime?: LastSuccessfulResourceDataSyncTime; + /** + * The status reported by the last sync. + */ + LastStatus?: LastResourceDataSyncStatus; + /** + * The date and time the configuration was created (UTC). + */ + SyncCreatedTime?: ResourceDataSyncCreatedTime; + /** + * The status message details reported by the last sync. + */ + LastSyncStatusMessage?: LastResourceDataSyncMessage; + } + export type ResourceDataSyncItemList = ResourceDataSyncItem[]; + export type ResourceDataSyncName = string; + export type ResourceDataSyncS3BucketName = string; + export interface ResourceDataSyncS3Destination { + /** + * The name of the Amazon S3 bucket where the aggregated data is stored. + */ + BucketName: ResourceDataSyncS3BucketName; + /** + * An Amazon S3 prefix for the bucket. + */ + Prefix?: ResourceDataSyncS3Prefix; + /** + * A supported sync format. The following format is currently supported: JsonSerDe + */ + SyncFormat: ResourceDataSyncS3Format; + /** + * The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync. + */ + Region: ResourceDataSyncS3Region; + /** + * The ARN of an encryption key for a destination in Amazon S3. Must belong to the same region as the destination Amazon S3 bucket. + */ + AWSKMSKeyARN?: ResourceDataSyncAWSKMSKeyARN; + } + export type ResourceDataSyncS3Format = "JsonSerDe"|string; + export type ResourceDataSyncS3Prefix = string; + export type ResourceDataSyncS3Region = string; + export type ResourceId = string; + export type ResourceType = "ManagedInstance"|"Document"|"EC2Instance"|string; + export type ResourceTypeForTagging = "Document"|"ManagedInstance"|"MaintenanceWindow"|"Parameter"|"PatchBaseline"|string; + export type ResponseCode = number; + export interface ResultAttribute { + /** + * Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation. + */ + TypeName: InventoryItemTypeName; + } + export type ResultAttributeList = ResultAttribute[]; + export interface ResumeSessionRequest { + /** + * The ID of the disconnected session to resume. + */ + SessionId: SessionId; + } + export interface ResumeSessionResponse { + /** + * The ID of the session. + */ + SessionId?: SessionId; + /** + * An encrypted token value containing session and caller information. Used to authenticate the connection to the instance. + */ + TokenValue?: TokenValue; + /** + * A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssm-messages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output). region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE. + */ + StreamUrl?: StreamUrl; + } + export type S3BucketName = string; + export type S3KeyPrefix = string; + export interface S3OutputLocation { + /** + * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. + */ + OutputS3Region?: S3Region; + /** + * The name of the Amazon S3 bucket. + */ + OutputS3BucketName?: S3BucketName; + /** + * The Amazon S3 bucket subfolder. + */ + OutputS3KeyPrefix?: S3KeyPrefix; + } + export interface S3OutputUrl { + /** + * A URL for an Amazon S3 bucket where you want to store the results of this request. + */ + OutputUrl?: Url; + } + export type S3Region = string; + export type ScheduleExpression = string; + export interface ScheduledWindowExecution { + /** + * The ID of the Maintenance Window to be run. + */ + WindowId?: MaintenanceWindowId; + /** + * The name of the Maintenance Window to be run. + */ + Name?: MaintenanceWindowName; + /** + * The time, in ISO-8601 Extended format, that the Maintenance Window is scheduled to be run. + */ + ExecutionTime?: MaintenanceWindowStringDateTime; + } + export type ScheduledWindowExecutionList = ScheduledWindowExecution[]; + export interface SendAutomationSignalRequest { + /** + * The unique identifier for an existing Automation execution that you want to send the signal to. + */ + AutomationExecutionId: AutomationExecutionId; + /** + * The type of signal. Valid signal types include the following: Approve and Reject + */ + SignalType: SignalType; + /** + * The data sent with the signal. The data schema depends on the type of signal used in the request. + */ + Payload?: AutomationParameterMap; + } + export interface SendAutomationSignalResult { + } + export interface SendCommandRequest { + /** + * The instance IDs where the command should run. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide. + */ + InstanceIds?: InstanceIdList; + /** + * (Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide. + */ + Targets?: Targets; + /** + * Required. The name of the Systems Manager document to run. This can be a public document or a custom document. + */ + DocumentName: DocumentARN; + /** + * The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example: --document-version "\$DEFAULT" --document-version "\$LATEST" --document-version "3" + */ + DocumentVersion?: DocumentVersion; + /** + * The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated. + */ + DocumentHash?: DocumentHash; + /** + * Sha256 or Sha1. Sha1 hashes have been deprecated. + */ + DocumentHashType?: DocumentHashType; + /** + * If this time is reached and the command has not already started running, it will not run. + */ + TimeoutSeconds?: TimeoutSeconds; + /** + * User-specified information about the command, such as a brief description of what the command should do. + */ + Comment?: Comment; + /** + * The required and optional parameters specified in the document being run. + */ + Parameters?: Parameters; + /** + * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. + */ + OutputS3Region?: S3Region; + /** + * The name of the S3 bucket where command execution responses should be stored. + */ + OutputS3BucketName?: S3BucketName; + /** + * The directory structure within the S3 bucket where the responses should be stored. + */ + OutputS3KeyPrefix?: S3KeyPrefix; + /** + * (Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls in the AWS Systems Manager User Guide. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using Error Controls in the AWS Systems Manager User Guide. + */ + MaxErrors?: MaxErrors; + /** + * The IAM role that Systems Manager uses to send notifications. + */ + ServiceRoleArn?: ServiceRole; + /** + * Configurations for sending notifications. + */ + NotificationConfig?: NotificationConfig; + /** + * Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs. + */ + CloudWatchOutputConfig?: CloudWatchOutputConfig; + } + export interface SendCommandResult { + /** + * The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request. + */ + Command?: Command; + } + export type ServiceRole = string; + export interface ServiceSetting { + /** + * The ID of the service setting. + */ + SettingId?: ServiceSettingId; + /** + * The value of the service setting. + */ + SettingValue?: ServiceSettingValue; + /** + * The last time the service setting was modified. + */ + LastModifiedDate?: DateTime; + /** + * The ARN of the last modified user. This field is populated only if the setting value was overwritten. + */ + LastModifiedUser?: String; + /** + * The ARN of the service setting. + */ + ARN?: String; + /** + * The status of the service setting. The value can be Default, Customized or PendingUpdate. Default: The current setting uses a default value provisioned by the AWS service team. Customized: The current setting use a custom value specified by the customer. PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval. + */ + Status?: String; + } + export type ServiceSettingId = string; + export type ServiceSettingValue = string; + export interface Session { + /** + * The ID of the session. + */ + SessionId?: SessionId; + /** + * The instance that the Session Manager session connected to. + */ + Target?: SessionTarget; + /** + * The status of the session. For example, "Connected" or "Terminated". + */ + Status?: SessionStatus; + /** + * The date and time, in ISO-8601 Extended format, when the session began. + */ + StartDate?: DateTime; + /** + * The date and time, in ISO-8601 Extended format, when the session was terminated. + */ + EndDate?: DateTime; + /** + * The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. + */ + DocumentName?: DocumentName; + /** + * The ID of the AWS user account that started the session. + */ + Owner?: SessionOwner; + /** + * Reserved for future use. + */ + Details?: SessionDetails; + /** + * Reserved for future use. + */ + OutputUrl?: SessionManagerOutputUrl; + } + export type SessionDetails = string; + export interface SessionFilter { + /** + * The name of the filter. + */ + key: SessionFilterKey; + /** + * The filter value. Valid values for each filter key are as follows: InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later. InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018. Target: Specify an instance to which session connections have been made. Owner: Specify an AWS user account to see a list of sessions started by that user. Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include: Connected Connecting Disconnected Terminated Terminating Failed + */ + value: SessionFilterValue; + } + export type SessionFilterKey = "InvokedAfter"|"InvokedBefore"|"Target"|"Owner"|"Status"|string; + export type SessionFilterList = SessionFilter[]; + export type SessionFilterValue = string; + export type SessionId = string; + export type SessionList = Session[]; + export type SessionManagerCloudWatchOutputUrl = string; + export interface SessionManagerOutputUrl { + /** + * Reserved for future use. + */ + S3OutputUrl?: SessionManagerS3OutputUrl; + /** + * Reserved for future use. + */ + CloudWatchOutputUrl?: SessionManagerCloudWatchOutputUrl; + } + export type SessionManagerParameterName = string; + export type SessionManagerParameterValue = string; + export type SessionManagerParameterValueList = SessionManagerParameterValue[]; + export type SessionManagerParameters = {[key: string]: SessionManagerParameterValueList}; + export type SessionManagerS3OutputUrl = string; + export type SessionMaxResults = number; + export type SessionOwner = string; + export type SessionState = "Active"|"History"|string; + export type SessionStatus = "Connected"|"Connecting"|"Disconnected"|"Terminated"|"Terminating"|"Failed"|string; + export type SessionTarget = string; + export interface SeveritySummary { + /** + * The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items. + */ + CriticalCount?: ComplianceSummaryCount; + /** + * The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items. + */ + HighCount?: ComplianceSummaryCount; + /** + * The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items. + */ + MediumCount?: ComplianceSummaryCount; + /** + * The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items. + */ + LowCount?: ComplianceSummaryCount; + /** + * The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items. + */ + InformationalCount?: ComplianceSummaryCount; + /** + * The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items. + */ + UnspecifiedCount?: ComplianceSummaryCount; + } + export type SignalType = "Approve"|"Reject"|"StartStep"|"StopStep"|"Resume"|string; + export type SnapshotDownloadUrl = string; + export type SnapshotId = string; + export type StandardErrorContent = string; + export type StandardOutputContent = string; + export interface StartAssociationsOnceRequest { + /** + * The association IDs that you want to run immediately and only one time. + */ + AssociationIds: AssociationIdList; + } + export interface StartAssociationsOnceResult { + } + export interface StartAutomationExecutionRequest { + /** + * The name of the Automation document to use for this execution. + */ + DocumentName: DocumentARN; + /** + * The version of the Automation document to use for this execution. + */ + DocumentVersion?: DocumentVersion; + /** + * A key-value map of execution parameters, which match the declared parameters in the Automation document. + */ + Parameters?: AutomationParameterMap; + /** + * User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused. + */ + ClientToken?: IdempotencyToken; + /** + * The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto. + */ + Mode?: ExecutionMode; + /** + * The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets. + */ + TargetParameterName?: AutomationParameterKey; + /** + * A key-value mapping to target resources. Required if you specify TargetParameterName. + */ + Targets?: Targets; + /** + * A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together. + */ + TargetMaps?: TargetMaps; + /** + * The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received. Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time. + */ + MaxErrors?: MaxErrors; + /** + * A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide. + */ + TargetLocations?: TargetLocations; + } + export interface StartAutomationExecutionResult { + /** + * The unique ID of a newly scheduled automation execution. + */ + AutomationExecutionId?: AutomationExecutionId; + } + export interface StartSessionRequest { + /** + * The instance to connect to for the session. + */ + Target: SessionTarget; + /** + * The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. If no document name is provided, a shell to the instance is launched by default. + */ + DocumentName?: DocumentARN; + /** + * Reserved for future use. + */ + Parameters?: SessionManagerParameters; + } + export interface StartSessionResponse { + /** + * The ID of the session. + */ + SessionId?: SessionId; + /** + * An encrypted token value containing session and caller information. Used to authenticate the connection to the instance. + */ + TokenValue?: TokenValue; + /** + * A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssm-messages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE. + */ + StreamUrl?: StreamUrl; + } + export type StatusAdditionalInfo = string; + export type StatusDetails = string; + export type StatusMessage = string; + export type StatusName = string; + export interface StepExecution { + /** + * The name of this execution step. + */ + StepName?: String; + /** + * The action this step performs. The action determines the behavior of the step. + */ + Action?: AutomationActionName; + /** + * The timeout seconds of the step. + */ + TimeoutSeconds?: Long; + /** + * The action to take if the step fails. The default value is Abort. + */ + OnFailure?: String; + /** + * The maximum number of tries to run the action of the step. The default value is 1. + */ + MaxAttempts?: Integer; + /** + * If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated. + */ + ExecutionStartTime?: DateTime; + /** + * If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated. + */ + ExecutionEndTime?: DateTime; + /** + * The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut. + */ + StepStatus?: AutomationExecutionStatus; + /** + * The response code returned by the execution of the step. + */ + ResponseCode?: String; + /** + * Fully-resolved values passed into the step before execution. + */ + Inputs?: NormalStringMap; + /** + * Returned values from the execution of the step. + */ + Outputs?: AutomationParameterMap; + /** + * A message associated with the response code for an execution. + */ + Response?: String; + /** + * If a step failed, this message explains why the execution failed. + */ + FailureMessage?: String; + /** + * Information about the Automation failure. + */ + FailureDetails?: FailureDetails; + /** + * The unique ID of a step execution. + */ + StepExecutionId?: String; + /** + * A user-specified list of parameters to override when running a step. + */ + OverriddenParameters?: AutomationParameterMap; + /** + * The flag which can be used to end automation no matter whether the step succeeds or fails. + */ + IsEnd?: Boolean; + /** + * The next step after the step succeeds. + */ + NextStep?: String; + /** + * The flag which can be used to help decide whether the failure of current step leads to the Automation failure. + */ + IsCritical?: Boolean; + /** + * Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step. + */ + ValidNextSteps?: ValidNextStepList; + /** + * The targets for the step execution. + */ + Targets?: Targets; + /** + * The combination of AWS Regions and accounts targeted by the current Automation execution. + */ + TargetLocation?: TargetLocation; + } + export interface StepExecutionFilter { + /** + * One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter. + */ + Key: StepExecutionFilterKey; + /** + * The values of the filter key. + */ + Values: StepExecutionFilterValueList; + } + export type StepExecutionFilterKey = "StartTimeBefore"|"StartTimeAfter"|"StepExecutionStatus"|"StepExecutionId"|"StepName"|"Action"|string; + export type StepExecutionFilterList = StepExecutionFilter[]; + export type StepExecutionFilterValue = string; + export type StepExecutionFilterValueList = StepExecutionFilterValue[]; + export type StepExecutionList = StepExecution[]; + export interface StopAutomationExecutionRequest { + /** + * The execution ID of the Automation to stop. + */ + AutomationExecutionId: AutomationExecutionId; + /** + * The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel. + */ + Type?: StopType; + } + export interface StopAutomationExecutionResult { + } + export type StopType = "Complete"|"Cancel"|string; + export type StreamUrl = string; + export type String = string; + export type StringDateTime = string; + export type StringList = String[]; + export interface Tag { + /** + * The name of the tag. + */ + Key: TagKey; + /** + * The value of the tag. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagList = Tag[]; + export type TagValue = string; + export interface Target { + /** + * User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide. + */ + Key?: TargetKey; + /** + * User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide. + */ + Values?: TargetValues; + } + export type TargetCount = number; + export type TargetKey = string; + export interface TargetLocation { + /** + * The AWS accounts targeted by the current Automation execution. + */ + Accounts?: Accounts; + /** + * The AWS Regions targeted by the current Automation execution. + */ + Regions?: Regions; + /** + * The maxium number of AWS accounts and AWS regions allowed to run the Automation concurrently + */ + TargetLocationMaxConcurrency?: MaxConcurrency; + /** + * The maxium number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. + */ + TargetLocationMaxErrors?: MaxErrors; + /** + * The Automation execution role used by the currently running Automation. + */ + ExecutionRoleName?: ExecutionRoleName; + } + export type TargetLocations = TargetLocation[]; + export type TargetMap = {[key: string]: TargetMapValueList}; + export type TargetMapKey = string; + export type TargetMapValue = string; + export type TargetMapValueList = TargetMapValue[]; + export type TargetMaps = TargetMap[]; + export type TargetParameterList = ParameterValue[]; + export type TargetType = string; + export type TargetValue = string; + export type TargetValues = TargetValue[]; + export type Targets = Target[]; + export interface TerminateSessionRequest { + /** + * The ID of the session to terminate. + */ + SessionId: SessionId; + } + export interface TerminateSessionResponse { + /** + * The ID of the session that has been terminated. + */ + SessionId?: SessionId; + } + export type TimeoutSeconds = number; + export type TokenValue = string; + export type TotalCount = number; + export interface UpdateAssociationRequest { + /** + * The ID of the association you want to update. + */ + AssociationId: AssociationId; + /** + * The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}} + */ + Parameters?: Parameters; + /** + * The document version you want update for the association. + */ + DocumentVersion?: DocumentVersion; + /** + * The cron expression used to schedule the association that you want to update. + */ + ScheduleExpression?: ScheduleExpression; + /** + * An Amazon S3 bucket where you want to store the results of this request. + */ + OutputLocation?: InstanceAssociationOutputLocation; + /** + * The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:aws:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document. + */ + Name?: DocumentARN; + /** + * The targets of the association. + */ + Targets?: Targets; + /** + * The name of the association that you want to update. + */ + AssociationName?: AssociationName; + /** + * This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter. + */ + AssociationVersion?: AssociationVersion; + /** + * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. + */ + AutomationTargetParameterName?: AutomationTargetParameterName; + /** + * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time. + */ + MaxErrors?: MaxErrors; + /** + * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The severity level to assign to the association. + */ + ComplianceSeverity?: AssociationComplianceSeverity; + } + export interface UpdateAssociationResult { + /** + * The description of the association that was updated. + */ + AssociationDescription?: AssociationDescription; + } + export interface UpdateAssociationStatusRequest { + /** + * The name of the Systems Manager document. + */ + Name: DocumentARN; + /** + * The ID of the instance. + */ + InstanceId: InstanceId; + /** + * The association status. + */ + AssociationStatus: AssociationStatus; + } + export interface UpdateAssociationStatusResult { + /** + * Information about the association. + */ + AssociationDescription?: AssociationDescription; + } + export interface UpdateDocumentDefaultVersionRequest { + /** + * The name of a custom document that you want to set as the default version. + */ + Name: DocumentName; + /** + * The version of a custom document that you want to set as the default version. + */ + DocumentVersion: DocumentVersionNumber; + } + export interface UpdateDocumentDefaultVersionResult { + /** + * The description of a custom document that you want to set as the default version. + */ + Description?: DocumentDefaultVersionDescription; + } + export interface UpdateDocumentRequest { + /** + * A valid JSON or YAML string. + */ + Content: DocumentContent; + /** + * A list of key and value pairs that describe attachments to a version of a document. + */ + Attachments?: AttachmentsSourceList; + /** + * The name of the document that you want to update. + */ + Name: DocumentName; + /** + * An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed. + */ + VersionName?: DocumentVersionName; + /** + * The version of the document that you want to update. + */ + DocumentVersion?: DocumentVersion; + /** + * Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format. + */ + DocumentFormat?: DocumentFormat; + /** + * Specify a new target type for the document. + */ + TargetType?: TargetType; + } + export interface UpdateDocumentResult { + /** + * A description of the document that was updated. + */ + DocumentDescription?: DocumentDescription; + } + export interface UpdateMaintenanceWindowRequest { + /** + * The ID of the Maintenance Window to update. + */ + WindowId: MaintenanceWindowId; + /** + * The name of the Maintenance Window. + */ + Name?: MaintenanceWindowName; + /** + * An optional description for the update request. + */ + Description?: MaintenanceWindowDescription; + /** + * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. + */ + StartDate?: MaintenanceWindowStringDateTime; + /** + * The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive. EndDate allows you to set a date and time in the future when the Maintenance Window will no longer run. + */ + EndDate?: MaintenanceWindowStringDateTime; + /** + * The schedule of the Maintenance Window in the form of a cron or rate expression. + */ + Schedule?: MaintenanceWindowSchedule; + /** + * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. + */ + ScheduleTimezone?: MaintenanceWindowTimezone; + /** + * The duration of the Maintenance Window in hours. + */ + Duration?: MaintenanceWindowDurationHours; + /** + * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. + */ + Cutoff?: MaintenanceWindowCutoff; + /** + * Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets. + */ + AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets; + /** + * Whether the Maintenance Window is enabled. + */ + Enabled?: MaintenanceWindowEnabled; + /** + * If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null. + */ + Replace?: Boolean; + } + export interface UpdateMaintenanceWindowResult { + /** + * The ID of the created Maintenance Window. + */ + WindowId?: MaintenanceWindowId; + /** + * The name of the Maintenance Window. + */ + Name?: MaintenanceWindowName; + /** + * An optional description of the update. + */ + Description?: MaintenanceWindowDescription; + /** + * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become active. The Maintenance Window will not run before this specified time. + */ + StartDate?: MaintenanceWindowStringDateTime; + /** + * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become inactive. The Maintenance Window will not run after this specified time. + */ + EndDate?: MaintenanceWindowStringDateTime; + /** + * The schedule of the Maintenance Window in the form of a cron or rate expression. + */ + Schedule?: MaintenanceWindowSchedule; + /** + * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. + */ + ScheduleTimezone?: MaintenanceWindowTimezone; + /** + * The duration of the Maintenance Window in hours. + */ + Duration?: MaintenanceWindowDurationHours; + /** + * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. + */ + Cutoff?: MaintenanceWindowCutoff; + /** + * Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets. + */ + AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets; + /** + * Whether the Maintenance Window is enabled. + */ + Enabled?: MaintenanceWindowEnabled; + } + export interface UpdateMaintenanceWindowTargetRequest { + /** + * The Maintenance Window ID with which to modify the target. + */ + WindowId: MaintenanceWindowId; + /** + * The target ID to modify. + */ + WindowTargetId: MaintenanceWindowTargetId; + /** + * The targets to add or replace. + */ + Targets?: Targets; + /** + * User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window. + */ + OwnerInformation?: OwnerInformation; + /** + * A name for the update. + */ + Name?: MaintenanceWindowName; + /** + * An optional description for the update. + */ + Description?: MaintenanceWindowDescription; + /** + * If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null. + */ + Replace?: Boolean; + } + export interface UpdateMaintenanceWindowTargetResult { + /** + * The Maintenance Window ID specified in the update request. + */ + WindowId?: MaintenanceWindowId; + /** + * The target ID specified in the update request. + */ + WindowTargetId?: MaintenanceWindowTargetId; + /** + * The updated targets. + */ + Targets?: Targets; + /** + * The updated owner. + */ + OwnerInformation?: OwnerInformation; + /** + * The updated name. + */ + Name?: MaintenanceWindowName; + /** + * The updated description. + */ + Description?: MaintenanceWindowDescription; + } + export interface UpdateMaintenanceWindowTaskRequest { + /** + * The Maintenance Window ID that contains the task to modify. + */ + WindowId: MaintenanceWindowId; + /** + * The task ID to modify. + */ + WindowTaskId: MaintenanceWindowTaskId; + /** + * The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value. + */ + Targets?: Targets; + /** + * The task ARN to modify. + */ + TaskArn?: MaintenanceWindowTaskArn; + /** + * The IAM service role ARN to modify. The system assumes this role during task execution. If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN. For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide. + */ + ServiceRoleArn?: ServiceRole; + /** + * The parameters to modify. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters + */ + TaskParameters?: MaintenanceWindowTaskParameters; + /** + * The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty. + */ + TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters; + /** + * The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. + */ + Priority?: MaintenanceWindowTaskPriority; + /** + * The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled. + */ + MaxErrors?: MaxErrors; + /** + * The new logging location in Amazon S3 to specify. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + LoggingInfo?: LoggingInfo; + /** + * The new task name to specify. + */ + Name?: MaintenanceWindowName; + /** + * The new task description to specify. + */ + Description?: MaintenanceWindowDescription; + /** + * If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null. + */ + Replace?: Boolean; + } + export interface UpdateMaintenanceWindowTaskResult { + /** + * The ID of the Maintenance Window that was updated. + */ + WindowId?: MaintenanceWindowId; + /** + * The task ID of the Maintenance Window that was updated. + */ + WindowTaskId?: MaintenanceWindowTaskId; + /** + * The updated target values. + */ + Targets?: Targets; + /** + * The updated task ARN value. + */ + TaskArn?: MaintenanceWindowTaskArn; + /** + * The updated service role ARN value. + */ + ServiceRoleArn?: ServiceRole; + /** + * The updated parameter values. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + TaskParameters?: MaintenanceWindowTaskParameters; + /** + * The updated parameter values. + */ + TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters; + /** + * The updated priority value. + */ + Priority?: MaintenanceWindowTaskPriority; + /** + * The updated MaxConcurrency value. + */ + MaxConcurrency?: MaxConcurrency; + /** + * The updated MaxErrors value. + */ + MaxErrors?: MaxErrors; + /** + * The updated logging information in Amazon S3. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. + */ + LoggingInfo?: LoggingInfo; + /** + * The updated task name. + */ + Name?: MaintenanceWindowName; + /** + * The updated task description. + */ + Description?: MaintenanceWindowDescription; + } + export interface UpdateManagedInstanceRoleRequest { + /** + * The ID of the managed instance where you want to update the role. + */ + InstanceId: ManagedInstanceId; + /** + * The IAM role you want to assign or change. + */ + IamRole: IamRole; + } + export interface UpdateManagedInstanceRoleResult { + } + export interface UpdatePatchBaselineRequest { + /** + * The ID of the patch baseline to update. + */ + BaselineId: BaselineId; + /** + * The name of the patch baseline. + */ + Name?: BaselineName; + /** + * A set of global filters used to include patches in the baseline. + */ + GlobalFilters?: PatchFilterGroup; + /** + * A set of rules used to include patches in the baseline. + */ + ApprovalRules?: PatchRuleGroup; + /** + * A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide. + */ + ApprovedPatches?: PatchIdList; + /** + * Assigns a new compliance severity level to an existing patch baseline. + */ + ApprovedPatchesComplianceLevel?: PatchComplianceLevel; + /** + * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only. + */ + ApprovedPatchesEnableNonSecurity?: Boolean; + /** + * A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide. + */ + RejectedPatches?: PatchIdList; + /** + * The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected. + */ + RejectedPatchesAction?: PatchAction; + /** + * A description of the patch baseline. + */ + Description?: BaselineDescription; + /** + * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only. + */ + Sources?: PatchSourceList; + /** + * If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null. + */ + Replace?: Boolean; + } + export interface UpdatePatchBaselineResult { + /** + * The ID of the deleted patch baseline. + */ + BaselineId?: BaselineId; + /** + * The name of the patch baseline. + */ + Name?: BaselineName; + /** + * The operating system rule used by the updated patch baseline. + */ + OperatingSystem?: OperatingSystem; + /** + * A set of global filters used to exclude patches from the baseline. + */ + GlobalFilters?: PatchFilterGroup; + /** + * A set of rules used to include patches in the baseline. + */ + ApprovalRules?: PatchRuleGroup; + /** + * A list of explicitly approved patches for the baseline. + */ + ApprovedPatches?: PatchIdList; + /** + * The compliance severity level assigned to the patch baseline after the update completed. + */ + ApprovedPatchesComplianceLevel?: PatchComplianceLevel; + /** + * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only. + */ + ApprovedPatchesEnableNonSecurity?: Boolean; + /** + * A list of explicitly rejected patches for the baseline. + */ + RejectedPatches?: PatchIdList; + /** + * The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency. + */ + RejectedPatchesAction?: PatchAction; + /** + * The date when the patch baseline was created. + */ + CreatedDate?: DateTime; + /** + * The date when the patch baseline was last modified. + */ + ModifiedDate?: DateTime; + /** + * A description of the Patch Baseline. + */ + Description?: BaselineDescription; + /** + * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only. + */ + Sources?: PatchSourceList; + } + export interface UpdateServiceSettingRequest { + /** + * The ID of the service setting to update. + */ + SettingId: ServiceSettingId; + /** + * The new value to specify for the service setting. + */ + SettingValue: ServiceSettingValue; + } + export interface UpdateServiceSettingResult { + } + export type Url = string; + export type ValidNextStep = string; + export type ValidNextStepList = ValidNextStep[]; + export type Version = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2014-11-06"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SSM client. + */ + export import Types = SSM; +} +export = SSM; diff --git a/node_modules/aws-sdk/clients/ssm.js b/node_modules/aws-sdk/clients/ssm.js new file mode 100644 index 0000000..84b33d2 --- /dev/null +++ b/node_modules/aws-sdk/clients/ssm.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['ssm'] = {}; +AWS.SSM = Service.defineService('ssm', ['2014-11-06']); +Object.defineProperty(apiLoader.services['ssm'], '2014-11-06', { + get: function get() { + var model = require('../apis/ssm-2014-11-06.min.json'); + model.paginators = require('../apis/ssm-2014-11-06.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SSM; diff --git a/node_modules/aws-sdk/clients/stepfunctions.d.ts b/node_modules/aws-sdk/clients/stepfunctions.d.ts new file mode 100644 index 0000000..5072663 --- /dev/null +++ b/node_modules/aws-sdk/clients/stepfunctions.d.ts @@ -0,0 +1,1128 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class StepFunctions extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: StepFunctions.Types.ClientConfiguration) + config: Config & StepFunctions.Types.ClientConfiguration; + /** + * Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + createActivity(params: StepFunctions.Types.CreateActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request; + /** + * Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + createActivity(callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request; + /** + * Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + createStateMachine(params: StepFunctions.Types.CreateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request; + /** + * Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + createStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request; + /** + * Deletes an activity. + */ + deleteActivity(params: StepFunctions.Types.DeleteActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request; + /** + * Deletes an activity. + */ + deleteActivity(callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request; + /** + * Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted. + */ + deleteStateMachine(params: StepFunctions.Types.DeleteStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request; + /** + * Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted. + */ + deleteStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request; + /** + * Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeActivity(params: StepFunctions.Types.DescribeActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request; + /** + * Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeActivity(callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request; + /** + * Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeExecution(params: StepFunctions.Types.DescribeExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request; + /** + * Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request; + /** + * Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeStateMachine(params: StepFunctions.Types.DescribeStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request; + /** + * Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request; + /** + * Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeStateMachineForExecution(params: StepFunctions.Types.DescribeStateMachineForExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request; + /** + * Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + describeStateMachineForExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request; + /** + * Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide. + */ + getActivityTask(params: StepFunctions.Types.GetActivityTaskInput, callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request; + /** + * Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide. + */ + getActivityTask(callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request; + /** + * Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + getExecutionHistory(params: StepFunctions.Types.GetExecutionHistoryInput, callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request; + /** + * Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + getExecutionHistory(callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request; + /** + * Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + listActivities(params: StepFunctions.Types.ListActivitiesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request; + /** + * Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + listActivities(callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request; + /** + * Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + listExecutions(params: StepFunctions.Types.ListExecutionsInput, callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request; + /** + * Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + listExecutions(callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request; + /** + * Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + listStateMachines(params: StepFunctions.Types.ListStateMachinesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request; + /** + * Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. + */ + listStateMachines(callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request; + /** + * List tags for a given resource. + */ + listTagsForResource(params: StepFunctions.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request; + /** + * List tags for a given resource. + */ + listTagsForResource(callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request; + /** + * Used by workers to report that the task identified by the taskToken failed. + */ + sendTaskFailure(params: StepFunctions.Types.SendTaskFailureInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request; + /** + * Used by workers to report that the task identified by the taskToken failed. + */ + sendTaskFailure(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request; + /** + * Used by workers to report to the service that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut event. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. This operation is only useful for long-lived tasks to report the liveliness of the task. + */ + sendTaskHeartbeat(params: StepFunctions.Types.SendTaskHeartbeatInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request; + /** + * Used by workers to report to the service that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut event. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. This operation is only useful for long-lived tasks to report the liveliness of the task. + */ + sendTaskHeartbeat(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request; + /** + * Used by workers to report that the task identified by the taskToken completed successfully. + */ + sendTaskSuccess(params: StepFunctions.Types.SendTaskSuccessInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request; + /** + * Used by workers to report that the task identified by the taskToken completed successfully. + */ + sendTaskSuccess(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request; + /** + * Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days. + */ + startExecution(params: StepFunctions.Types.StartExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request; + /** + * Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days. + */ + startExecution(callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request; + /** + * Stops an execution. + */ + stopExecution(params: StepFunctions.Types.StopExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request; + /** + * Stops an execution. + */ + stopExecution(callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request; + /** + * Add a tag to a Step Functions resource. + */ + tagResource(params: StepFunctions.Types.TagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request; + /** + * Add a tag to a Step Functions resource. + */ + tagResource(callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request; + /** + * Remove a tag from a Step Functions resource + */ + untagResource(params: StepFunctions.Types.UntagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request; + /** + * Remove a tag from a Step Functions resource + */ + untagResource(callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request; + /** + * Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn. + */ + updateStateMachine(params: StepFunctions.Types.UpdateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request; + /** + * Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn. + */ + updateStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request; +} +declare namespace StepFunctions { + export interface ActivityFailedEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export type ActivityList = ActivityListItem[]; + export interface ActivityListItem { + /** + * The Amazon Resource Name (ARN) that identifies the activity. + */ + activityArn: Arn; + /** + * The name of the activity. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The date the activity is created. + */ + creationDate: Timestamp; + } + export interface ActivityScheduleFailedEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface ActivityScheduledEventDetails { + /** + * The Amazon Resource Name (ARN) of the scheduled activity. + */ + resource: Arn; + /** + * The JSON data input to the activity task. + */ + input?: SensitiveData; + /** + * The maximum allowed duration of the activity task. + */ + timeoutInSeconds?: TimeoutInSeconds; + /** + * The maximum allowed duration between two heartbeats for the activity task. + */ + heartbeatInSeconds?: TimeoutInSeconds; + } + export interface ActivityStartedEventDetails { + /** + * The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask. + */ + workerName?: Identity; + } + export interface ActivitySucceededEventDetails { + /** + * The JSON data output by the activity task. + */ + output?: SensitiveData; + } + export interface ActivityTimedOutEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the timeout. + */ + cause?: SensitiveCause; + } + export type Arn = string; + export type ConnectorParameters = string; + export interface CreateActivityInput { + /** + * The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The list of tags to add to a resource. + */ + tags?: TagList; + } + export interface CreateActivityOutput { + /** + * The Amazon Resource Name (ARN) that identifies the created activity. + */ + activityArn: Arn; + /** + * The date the activity is created. + */ + creationDate: Timestamp; + } + export interface CreateStateMachineInput { + /** + * The name of the state machine. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The Amazon States Language definition of the state machine. See Amazon States Language. + */ + definition: Definition; + /** + * The Amazon Resource Name (ARN) of the IAM role to use for this state machine. + */ + roleArn: Arn; + /** + * Tags to be added when creating a state machine. + */ + tags?: TagList; + } + export interface CreateStateMachineOutput { + /** + * The Amazon Resource Name (ARN) that identifies the created state machine. + */ + stateMachineArn: Arn; + /** + * The date the state machine is created. + */ + creationDate: Timestamp; + } + export type Definition = string; + export interface DeleteActivityInput { + /** + * The Amazon Resource Name (ARN) of the activity to delete. + */ + activityArn: Arn; + } + export interface DeleteActivityOutput { + } + export interface DeleteStateMachineInput { + /** + * The Amazon Resource Name (ARN) of the state machine to delete. + */ + stateMachineArn: Arn; + } + export interface DeleteStateMachineOutput { + } + export interface DescribeActivityInput { + /** + * The Amazon Resource Name (ARN) of the activity to describe. + */ + activityArn: Arn; + } + export interface DescribeActivityOutput { + /** + * The Amazon Resource Name (ARN) that identifies the activity. + */ + activityArn: Arn; + /** + * The name of the activity. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The date the activity is created. + */ + creationDate: Timestamp; + } + export interface DescribeExecutionInput { + /** + * The Amazon Resource Name (ARN) of the execution to describe. + */ + executionArn: Arn; + } + export interface DescribeExecutionOutput { + /** + * The Amazon Resource Name (ARN) that identifies the execution. + */ + executionArn: Arn; + /** + * The Amazon Resource Name (ARN) of the executed stated machine. + */ + stateMachineArn: Arn; + /** + * The name of the execution. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name?: Name; + /** + * The current status of the execution. + */ + status: ExecutionStatus; + /** + * The date the execution is started. + */ + startDate: Timestamp; + /** + * If the execution has already ended, the date the execution stopped. + */ + stopDate?: Timestamp; + /** + * The string that contains the JSON input data of the execution. + */ + input: SensitiveData; + /** + * The JSON output data of the execution. This field is set only if the execution succeeds. If the execution fails, this field is null. + */ + output?: SensitiveData; + } + export interface DescribeStateMachineForExecutionInput { + /** + * The Amazon Resource Name (ARN) of the execution you want state machine information for. + */ + executionArn: Arn; + } + export interface DescribeStateMachineForExecutionOutput { + /** + * The Amazon Resource Name (ARN) of the state machine associated with the execution. + */ + stateMachineArn: Arn; + /** + * The name of the state machine associated with the execution. + */ + name: Name; + /** + * The Amazon States Language definition of the state machine. See Amazon States Language. + */ + definition: Definition; + /** + * The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. + */ + roleArn: Arn; + /** + * The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date. + */ + updateDate: Timestamp; + } + export interface DescribeStateMachineInput { + /** + * The Amazon Resource Name (ARN) of the state machine to describe. + */ + stateMachineArn: Arn; + } + export interface DescribeStateMachineOutput { + /** + * The Amazon Resource Name (ARN) that identifies the state machine. + */ + stateMachineArn: Arn; + /** + * The name of the state machine. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The current status of the state machine. + */ + status?: StateMachineStatus; + /** + * The Amazon States Language definition of the state machine. See Amazon States Language. + */ + definition: Definition; + /** + * The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.) + */ + roleArn: Arn; + /** + * The date the state machine is created. + */ + creationDate: Timestamp; + } + export type EventId = number; + export interface ExecutionAbortedEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface ExecutionFailedEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export type ExecutionList = ExecutionListItem[]; + export interface ExecutionListItem { + /** + * The Amazon Resource Name (ARN) that identifies the execution. + */ + executionArn: Arn; + /** + * The Amazon Resource Name (ARN) of the executed state machine. + */ + stateMachineArn: Arn; + /** + * The name of the execution. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The current status of the execution. + */ + status: ExecutionStatus; + /** + * The date the execution started. + */ + startDate: Timestamp; + /** + * If the execution already ended, the date the execution stopped. + */ + stopDate?: Timestamp; + } + export interface ExecutionStartedEventDetails { + /** + * The JSON data input to the execution. + */ + input?: SensitiveData; + /** + * The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks. + */ + roleArn?: Arn; + } + export type ExecutionStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"ABORTED"|string; + export interface ExecutionSucceededEventDetails { + /** + * The JSON data output by the execution. + */ + output?: SensitiveData; + } + export interface ExecutionTimedOutEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the timeout. + */ + cause?: SensitiveCause; + } + export interface GetActivityTaskInput { + /** + * The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.) + */ + activityArn: Arn; + /** + * You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history. + */ + workerName?: Name; + } + export interface GetActivityTaskOutput { + /** + * A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task. + */ + taskToken?: TaskToken; + /** + * The string that contains the JSON input data for the task. + */ + input?: SensitiveDataJobInput; + } + export interface GetExecutionHistoryInput { + /** + * The Amazon Resource Name (ARN) of the execution. + */ + executionArn: Arn; + /** + * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. + */ + maxResults?: PageSize; + /** + * Lists events in descending order of their timeStamp. + */ + reverseOrder?: ReverseOrder; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface GetExecutionHistoryOutput { + /** + * The list of events that occurred in the execution. + */ + events: HistoryEventList; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface HistoryEvent { + /** + * The date and time the event occurred. + */ + timestamp: Timestamp; + /** + * The type of the event. + */ + type: HistoryEventType; + /** + * The id of the event. Events are numbered sequentially, starting at one. + */ + id: EventId; + /** + * The id of the previous event. + */ + previousEventId?: EventId; + activityFailedEventDetails?: ActivityFailedEventDetails; + /** + * Contains details about an activity schedule event that failed during an execution. + */ + activityScheduleFailedEventDetails?: ActivityScheduleFailedEventDetails; + activityScheduledEventDetails?: ActivityScheduledEventDetails; + activityStartedEventDetails?: ActivityStartedEventDetails; + activitySucceededEventDetails?: ActivitySucceededEventDetails; + activityTimedOutEventDetails?: ActivityTimedOutEventDetails; + /** + * Contains details about the failure of a task. + */ + taskFailedEventDetails?: TaskFailedEventDetails; + /** + * Contains details about a task that was scheduled. + */ + taskScheduledEventDetails?: TaskScheduledEventDetails; + /** + * Contains details about a task that failed to start. + */ + taskStartFailedEventDetails?: TaskStartFailedEventDetails; + /** + * Contains details about a task that was started. + */ + taskStartedEventDetails?: TaskStartedEventDetails; + /** + * Contains details about a task that where the submit failed. + */ + taskSubmitFailedEventDetails?: TaskSubmitFailedEventDetails; + /** + * Contains details about a submitted task. + */ + taskSubmittedEventDetails?: TaskSubmittedEventDetails; + /** + * Contains details about a task that succeeded. + */ + taskSucceededEventDetails?: TaskSucceededEventDetails; + /** + * Contains details about a task that timed out. + */ + taskTimedOutEventDetails?: TaskTimedOutEventDetails; + executionFailedEventDetails?: ExecutionFailedEventDetails; + executionStartedEventDetails?: ExecutionStartedEventDetails; + executionSucceededEventDetails?: ExecutionSucceededEventDetails; + executionAbortedEventDetails?: ExecutionAbortedEventDetails; + executionTimedOutEventDetails?: ExecutionTimedOutEventDetails; + lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails; + lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails; + lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails; + /** + * Contains details about a lambda function that failed to start during an execution. + */ + lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails; + /** + * Contains details about a lambda function that terminated successfully during an execution. + */ + lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails; + lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails; + stateEnteredEventDetails?: StateEnteredEventDetails; + stateExitedEventDetails?: StateExitedEventDetails; + } + export type HistoryEventList = HistoryEvent[]; + export type HistoryEventType = "ActivityFailed"|"ActivityScheduleFailed"|"ActivityScheduled"|"ActivityStarted"|"ActivitySucceeded"|"ActivityTimedOut"|"ChoiceStateEntered"|"ChoiceStateExited"|"TaskFailed"|"TaskScheduled"|"TaskStartFailed"|"TaskStarted"|"TaskSubmitFailed"|"TaskSubmitted"|"TaskSucceeded"|"TaskTimedOut"|"ExecutionFailed"|"ExecutionStarted"|"ExecutionSucceeded"|"ExecutionAborted"|"ExecutionTimedOut"|"FailStateEntered"|"LambdaFunctionFailed"|"LambdaFunctionScheduleFailed"|"LambdaFunctionScheduled"|"LambdaFunctionStartFailed"|"LambdaFunctionStarted"|"LambdaFunctionSucceeded"|"LambdaFunctionTimedOut"|"SucceedStateEntered"|"SucceedStateExited"|"TaskStateAborted"|"TaskStateEntered"|"TaskStateExited"|"PassStateEntered"|"PassStateExited"|"ParallelStateAborted"|"ParallelStateEntered"|"ParallelStateExited"|"ParallelStateFailed"|"ParallelStateStarted"|"ParallelStateSucceeded"|"WaitStateAborted"|"WaitStateEntered"|"WaitStateExited"|string; + export type Identity = string; + export interface LambdaFunctionFailedEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface LambdaFunctionScheduleFailedEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface LambdaFunctionScheduledEventDetails { + /** + * The Amazon Resource Name (ARN) of the scheduled lambda function. + */ + resource: Arn; + /** + * The JSON data input to the lambda function. + */ + input?: SensitiveData; + /** + * The maximum allowed duration of the lambda function. + */ + timeoutInSeconds?: TimeoutInSeconds; + } + export interface LambdaFunctionStartFailedEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface LambdaFunctionSucceededEventDetails { + /** + * The JSON data output by the lambda function. + */ + output?: SensitiveData; + } + export interface LambdaFunctionTimedOutEventDetails { + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the timeout. + */ + cause?: SensitiveCause; + } + export interface ListActivitiesInput { + /** + * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. + */ + maxResults?: PageSize; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface ListActivitiesOutput { + /** + * The list of activities. + */ + activities: ActivityList; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface ListExecutionsInput { + /** + * The Amazon Resource Name (ARN) of the state machine whose executions is listed. + */ + stateMachineArn: Arn; + /** + * If specified, only list the executions whose current execution status matches the given filter. + */ + statusFilter?: ExecutionStatus; + /** + * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. + */ + maxResults?: PageSize; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface ListExecutionsOutput { + /** + * The list of matching executions. + */ + executions: ExecutionList; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface ListStateMachinesInput { + /** + * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. + */ + maxResults?: PageSize; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface ListStateMachinesOutput { + stateMachines: StateMachineList; + /** + * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. + */ + nextToken?: PageToken; + } + export interface ListTagsForResourceInput { + /** + * The Amazon Resource Name (ARN) for the Step Functions state machine or activity. + */ + resourceArn: Arn; + } + export interface ListTagsForResourceOutput { + /** + * An array of tags associated with the resource. + */ + tags?: TagList; + } + export type Name = string; + export type PageSize = number; + export type PageToken = string; + export type ReverseOrder = boolean; + export interface SendTaskFailureInput { + /** + * The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken). + */ + taskToken: TaskToken; + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface SendTaskFailureOutput { + } + export interface SendTaskHeartbeatInput { + /** + * The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken). + */ + taskToken: TaskToken; + } + export interface SendTaskHeartbeatOutput { + } + export interface SendTaskSuccessInput { + /** + * The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken). + */ + taskToken: TaskToken; + /** + * The JSON output of the task. + */ + output: SensitiveData; + } + export interface SendTaskSuccessOutput { + } + export type SensitiveCause = string; + export type SensitiveData = string; + export type SensitiveDataJobInput = string; + export type SensitiveError = string; + export interface StartExecutionInput { + /** + * The Amazon Resource Name (ARN) of the state machine to execute. + */ + stateMachineArn: Arn; + /** + * The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name?: Name; + /** + * The string that contains the JSON input data for the execution, for example: "input": "{\"first_name\" : \"test\"}" If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}" + */ + input?: SensitiveData; + } + export interface StartExecutionOutput { + /** + * The Amazon Resource Name (ARN) that identifies the execution. + */ + executionArn: Arn; + /** + * The date the execution is started. + */ + startDate: Timestamp; + } + export interface StateEnteredEventDetails { + /** + * The name of the state. + */ + name: Name; + /** + * The string that contains the JSON input data for the state. + */ + input?: SensitiveData; + } + export interface StateExitedEventDetails { + /** + * The name of the state. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The JSON output data of the state. + */ + output?: SensitiveData; + } + export type StateMachineList = StateMachineListItem[]; + export interface StateMachineListItem { + /** + * The Amazon Resource Name (ARN) that identifies the state machine. + */ + stateMachineArn: Arn; + /** + * The name of the state machine. A name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) + */ + name: Name; + /** + * The date the state machine is created. + */ + creationDate: Timestamp; + } + export type StateMachineStatus = "ACTIVE"|"DELETING"|string; + export interface StopExecutionInput { + /** + * The Amazon Resource Name (ARN) of the execution to stop. + */ + executionArn: Arn; + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface StopExecutionOutput { + /** + * The date the execution is stopped. + */ + stopDate: Timestamp; + } + export interface Tag { + /** + * The key of a tag. + */ + key?: TagKey; + /** + * The value of a tag. + */ + value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = TagKey[]; + export type TagList = Tag[]; + export interface TagResourceInput { + /** + * The Amazon Resource Name (ARN) for the Step Functions state machine or activity. + */ + resourceArn: Arn; + /** + * The list of tags to add to a resource. Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @. + */ + tags: TagList; + } + export interface TagResourceOutput { + } + export type TagValue = string; + export interface TaskFailedEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface TaskScheduledEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + /** + * The region of the scheduled task + */ + region: Name; + /** + * The JSON data passed to the resource referenced in a task state. + */ + parameters: ConnectorParameters; + /** + * The maximum allowed duration of the task. + */ + timeoutInSeconds?: TimeoutInSeconds; + } + export interface TaskStartFailedEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface TaskStartedEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + } + export interface TaskSubmitFailedEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export interface TaskSubmittedEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + /** + * The response from a resource when a task has started. + */ + output?: SensitiveData; + } + export interface TaskSucceededEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + /** + * The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task. + */ + output?: SensitiveData; + } + export interface TaskTimedOutEventDetails { + /** + * The action of the resource called by a task state. + */ + resourceType: Name; + /** + * The service name of the resource in a task state. + */ + resource: Name; + /** + * The error code of the failure. + */ + error?: SensitiveError; + /** + * A more detailed explanation of the cause of the failure. + */ + cause?: SensitiveCause; + } + export type TaskToken = string; + export type TimeoutInSeconds = number; + export type Timestamp = Date; + export interface UntagResourceInput { + /** + * The Amazon Resource Name (ARN) for the Step Functions state machine or activity. + */ + resourceArn: Arn; + /** + * The list of tags to remove from the resource. + */ + tagKeys: TagKeyList; + } + export interface UntagResourceOutput { + } + export interface UpdateStateMachineInput { + /** + * The Amazon Resource Name (ARN) of the state machine. + */ + stateMachineArn: Arn; + /** + * The Amazon States Language definition of the state machine. See Amazon States Language. + */ + definition?: Definition; + /** + * The Amazon Resource Name (ARN) of the IAM role of the state machine. + */ + roleArn?: Arn; + } + export interface UpdateStateMachineOutput { + /** + * The date and time the state machine was updated. + */ + updateDate: Timestamp; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-11-23"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the StepFunctions client. + */ + export import Types = StepFunctions; +} +export = StepFunctions; diff --git a/node_modules/aws-sdk/clients/stepfunctions.js b/node_modules/aws-sdk/clients/stepfunctions.js new file mode 100644 index 0000000..dd55bae --- /dev/null +++ b/node_modules/aws-sdk/clients/stepfunctions.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['stepfunctions'] = {}; +AWS.StepFunctions = Service.defineService('stepfunctions', ['2016-11-23']); +Object.defineProperty(apiLoader.services['stepfunctions'], '2016-11-23', { + get: function get() { + var model = require('../apis/states-2016-11-23.min.json'); + model.paginators = require('../apis/states-2016-11-23.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.StepFunctions; diff --git a/node_modules/aws-sdk/clients/storagegateway.d.ts b/node_modules/aws-sdk/clients/storagegateway.d.ts new file mode 100644 index 0000000..6cf2b92 --- /dev/null +++ b/node_modules/aws-sdk/clients/storagegateway.d.ts @@ -0,0 +1,2795 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class StorageGateway extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: StorageGateway.Types.ClientConfiguration) + config: Config & StorageGateway.Types.ClientConfiguration; + /** + * Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation. You must turn on the gateway VM before you can activate your gateway. + */ + activateGateway(params: StorageGateway.Types.ActivateGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.ActivateGatewayOutput) => void): Request; + /** + * Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation. You must turn on the gateway VM before you can activate your gateway. + */ + activateGateway(callback?: (err: AWSError, data: StorageGateway.Types.ActivateGatewayOutput) => void): Request; + /** + * Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. + */ + addCache(params: StorageGateway.Types.AddCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.AddCacheOutput) => void): Request; + /** + * Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. + */ + addCache(callback?: (err: AWSError, data: StorageGateway.Types.AddCacheOutput) => void): Request; + /** + * Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: Storage gateways of all types Storage volumes Virtual tapes NFS and SMB file shares You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. + */ + addTagsToResource(params: StorageGateway.Types.AddTagsToResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.AddTagsToResourceOutput) => void): Request; + /** + * Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: Storage gateways of all types Storage volumes Virtual tapes NFS and SMB file shares You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. + */ + addTagsToResource(callback?: (err: AWSError, data: StorageGateway.Types.AddTagsToResourceOutput) => void): Request; + /** + * Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. + */ + addUploadBuffer(params: StorageGateway.Types.AddUploadBufferInput, callback?: (err: AWSError, data: StorageGateway.Types.AddUploadBufferOutput) => void): Request; + /** + * Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. + */ + addUploadBuffer(callback?: (err: AWSError, data: StorageGateway.Types.AddUploadBufferOutput) => void): Request; + /** + * Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. + */ + addWorkingStorage(params: StorageGateway.Types.AddWorkingStorageInput, callback?: (err: AWSError, data: StorageGateway.Types.AddWorkingStorageOutput) => void): Request; + /** + * Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. + */ + addWorkingStorage(callback?: (err: AWSError, data: StorageGateway.Types.AddWorkingStorageOutput) => void): Request; + /** + * Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. + */ + attachVolume(params: StorageGateway.Types.AttachVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.AttachVolumeOutput) => void): Request; + /** + * Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. + */ + attachVolume(callback?: (err: AWSError, data: StorageGateway.Types.AttachVolumeOutput) => void): Request; + /** + * Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type. + */ + cancelArchival(params: StorageGateway.Types.CancelArchivalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request; + /** + * Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type. + */ + cancelArchival(callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request; + /** + * Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type. + */ + cancelRetrieval(params: StorageGateway.Types.CancelRetrievalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request; + /** + * Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type. + */ + cancelRetrieval(callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request; + /** + * Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes. + */ + createCachediSCSIVolume(params: StorageGateway.Types.CreateCachediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request; + /** + * Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes. + */ + createCachediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request; + /** + * Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways. File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateway does not support creating hard or symbolic links on a file share. + */ + createNFSFileShare(params: StorageGateway.Types.CreateNFSFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateNFSFileShareOutput) => void): Request; + /** + * Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways. File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateway does not support creating hard or symbolic links on a file share. + */ + createNFSFileShare(callback?: (err: AWSError, data: StorageGateway.Types.CreateNFSFileShareOutput) => void): Request; + /** + * Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share. + */ + createSMBFileShare(params: StorageGateway.Types.CreateSMBFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSMBFileShareOutput) => void): Request; + /** + * Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share. + */ + createSMBFileShare(callback?: (err: AWSError, data: StorageGateway.Types.CreateSMBFileShareOutput) => void): Request; + /** + * Initiates a snapshot of a volume. AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule. In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference. Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page. + */ + createSnapshot(params: StorageGateway.Types.CreateSnapshotInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request; + /** + * Initiates a snapshot of a volume. AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule. In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference. Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page. + */ + createSnapshot(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request; + /** + * Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference. + */ + createSnapshotFromVolumeRecoveryPoint(params: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request; + /** + * Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference. + */ + createSnapshotFromVolumeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request; + /** + * Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. + */ + createStorediSCSIVolume(params: StorageGateway.Types.CreateStorediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request; + /** + * Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. + */ + createStorediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request; + /** + * Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway. + */ + createTapeWithBarcode(params: StorageGateway.Types.CreateTapeWithBarcodeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request; + /** + * Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway. + */ + createTapeWithBarcode(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request; + /** + * Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway. + */ + createTapes(params: StorageGateway.Types.CreateTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request; + /** + * Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway. + */ + createTapes(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request; + /** + * Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + deleteBandwidthRateLimit(params: StorageGateway.Types.DeleteBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request; + /** + * Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + deleteBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request; + /** + * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. + */ + deleteChapCredentials(params: StorageGateway.Types.DeleteChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request; + /** + * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. + */ + deleteChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request; + /** + * Deletes a file share from a file gateway. This operation is only supported for file gateways. + */ + deleteFileShare(params: StorageGateway.Types.DeleteFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteFileShareOutput) => void): Request; + /** + * Deletes a file share from a file gateway. This operation is only supported for file gateways. + */ + deleteFileShare(callback?: (err: AWSError, data: StorageGateway.Types.DeleteFileShareOutput) => void): Request; + /** + * Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page. + */ + deleteGateway(params: StorageGateway.Types.DeleteGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request; + /** + * Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page. + */ + deleteGateway(callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request; + /** + * Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference. + */ + deleteSnapshotSchedule(params: StorageGateway.Types.DeleteSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request; + /** + * Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference. + */ + deleteSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request; + /** + * Deletes the specified virtual tape. This operation is only supported in the tape gateway type. + */ + deleteTape(params: StorageGateway.Types.DeleteTapeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request; + /** + * Deletes the specified virtual tape. This operation is only supported in the tape gateway type. + */ + deleteTape(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request; + /** + * Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. + */ + deleteTapeArchive(params: StorageGateway.Types.DeleteTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request; + /** + * Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. + */ + deleteTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request; + /** + * Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. + */ + deleteVolume(params: StorageGateway.Types.DeleteVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request; + /** + * Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. + */ + deleteVolume(callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request; + /** + * Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + describeBandwidthRateLimit(params: StorageGateway.Types.DescribeBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request; + /** + * Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + describeBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request; + /** + * Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. + */ + describeCache(params: StorageGateway.Types.DescribeCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request; + /** + * Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. + */ + describeCache(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request; + /** + * Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). + */ + describeCachediSCSIVolumes(params: StorageGateway.Types.DescribeCachediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request; + /** + * Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). + */ + describeCachediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request; + /** + * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. + */ + describeChapCredentials(params: StorageGateway.Types.DescribeChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request; + /** + * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. + */ + describeChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request; + /** + * Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + describeGatewayInformation(params: StorageGateway.Types.DescribeGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request; + /** + * Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + describeGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request; + /** + * Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. + */ + describeMaintenanceStartTime(params: StorageGateway.Types.DescribeMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request; + /** + * Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. + */ + describeMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request; + /** + * Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways. + */ + describeNFSFileShares(params: StorageGateway.Types.DescribeNFSFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeNFSFileSharesOutput) => void): Request; + /** + * Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways. + */ + describeNFSFileShares(callback?: (err: AWSError, data: StorageGateway.Types.DescribeNFSFileSharesOutput) => void): Request; + /** + * Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways. + */ + describeSMBFileShares(params: StorageGateway.Types.DescribeSMBFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBFileSharesOutput) => void): Request; + /** + * Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways. + */ + describeSMBFileShares(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBFileSharesOutput) => void): Request; + /** + * Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways. + */ + describeSMBSettings(params: StorageGateway.Types.DescribeSMBSettingsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBSettingsOutput) => void): Request; + /** + * Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways. + */ + describeSMBSettings(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBSettingsOutput) => void): Request; + /** + * Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types. + */ + describeSnapshotSchedule(params: StorageGateway.Types.DescribeSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request; + /** + * Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types. + */ + describeSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request; + /** + * Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type. + */ + describeStorediSCSIVolumes(params: StorageGateway.Types.DescribeStorediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request; + /** + * Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type. + */ + describeStorediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request; + /** + * Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. + */ + describeTapeArchives(params: StorageGateway.Types.DescribeTapeArchivesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request; + /** + * Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. + */ + describeTapeArchives(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request; + /** + * Returns a list of virtual tape recovery points that are available for the specified tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type. + */ + describeTapeRecoveryPoints(params: StorageGateway.Types.DescribeTapeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request; + /** + * Returns a list of virtual tape recovery points that are available for the specified tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type. + */ + describeTapeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request; + /** + * Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type. + */ + describeTapes(params: StorageGateway.Types.DescribeTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request; + /** + * Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type. + */ + describeTapes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request; + /** + * Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. + */ + describeUploadBuffer(params: StorageGateway.Types.DescribeUploadBufferInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request; + /** + * Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. + */ + describeUploadBuffer(callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request; + /** + * Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type. + */ + describeVTLDevices(params: StorageGateway.Types.DescribeVTLDevicesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request; + /** + * Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type. + */ + describeVTLDevices(callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request; + /** + * Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. + */ + describeWorkingStorage(params: StorageGateway.Types.DescribeWorkingStorageInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request; + /** + * Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. + */ + describeWorkingStorage(callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request; + /** + * Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. + */ + detachVolume(params: StorageGateway.Types.DetachVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.DetachVolumeOutput) => void): Request; + /** + * Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. + */ + detachVolume(callback?: (err: AWSError, data: StorageGateway.Types.DetachVolumeOutput) => void): Request; + /** + * Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. Once a gateway is disabled it cannot be enabled. + */ + disableGateway(params: StorageGateway.Types.DisableGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request; + /** + * Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. Once a gateway is disabled it cannot be enabled. + */ + disableGateway(callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request; + /** + * Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol. + */ + joinDomain(params: StorageGateway.Types.JoinDomainInput, callback?: (err: AWSError, data: StorageGateway.Types.JoinDomainOutput) => void): Request; + /** + * Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol. + */ + joinDomain(callback?: (err: AWSError, data: StorageGateway.Types.JoinDomainOutput) => void): Request; + /** + * Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways. + */ + listFileShares(params: StorageGateway.Types.ListFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListFileSharesOutput) => void): Request; + /** + * Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways. + */ + listFileShares(callback?: (err: AWSError, data: StorageGateway.Types.ListFileSharesOutput) => void): Request; + /** + * Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways. + */ + listGateways(params: StorageGateway.Types.ListGatewaysInput, callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request; + /** + * Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways. + */ + listGateways(callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request; + /** + * Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). + */ + listLocalDisks(params: StorageGateway.Types.ListLocalDisksInput, callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request; + /** + * Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). + */ + listLocalDisks(callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request; + /** + * Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type. + */ + listTagsForResource(params: StorageGateway.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request; + /** + * Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type. + */ + listTagsForResource(callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request; + /** + * Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type. + */ + listTapes(params: StorageGateway.Types.ListTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request; + /** + * Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type. + */ + listTapes(callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request; + /** + * Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types. + */ + listVolumeInitiators(params: StorageGateway.Types.ListVolumeInitiatorsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request; + /** + * Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types. + */ + listVolumeInitiators(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request; + /** + * Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation. + */ + listVolumeRecoveryPoints(params: StorageGateway.Types.ListVolumeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request; + /** + * Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation. + */ + listVolumeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request; + /** + * Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types. + */ + listVolumes(params: StorageGateway.Types.ListVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request; + /** + * Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types. + */ + listVolumes(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request; + /** + * Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3. AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways. For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification). + */ + notifyWhenUploaded(params: StorageGateway.Types.NotifyWhenUploadedInput, callback?: (err: AWSError, data: StorageGateway.Types.NotifyWhenUploadedOutput) => void): Request; + /** + * Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3. AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways. For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification). + */ + notifyWhenUploaded(callback?: (err: AWSError, data: StorageGateway.Types.NotifyWhenUploadedOutput) => void): Request; + /** + * Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations. When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes. + */ + refreshCache(params: StorageGateway.Types.RefreshCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.RefreshCacheOutput) => void): Request; + /** + * Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations. When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes. + */ + refreshCache(callback?: (err: AWSError, data: StorageGateway.Types.RefreshCacheOutput) => void): Request; + /** + * Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types. + */ + removeTagsFromResource(params: StorageGateway.Types.RemoveTagsFromResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request; + /** + * Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types. + */ + removeTagsFromResource(callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request; + /** + * Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. + */ + resetCache(params: StorageGateway.Types.ResetCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request; + /** + * Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. + */ + resetCache(callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request; + /** + * Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type. Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type. + */ + retrieveTapeArchive(params: StorageGateway.Types.RetrieveTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request; + /** + * Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type. Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type. + */ + retrieveTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request; + /** + * Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points. + */ + retrieveTapeRecoveryPoint(params: StorageGateway.Types.RetrieveTapeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request; + /** + * Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points. + */ + retrieveTapeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request; + /** + * Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password. + */ + setLocalConsolePassword(params: StorageGateway.Types.SetLocalConsolePasswordInput, callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request; + /** + * Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password. + */ + setLocalConsolePassword(callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request; + /** + * Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. + */ + setSMBGuestPassword(params: StorageGateway.Types.SetSMBGuestPasswordInput, callback?: (err: AWSError, data: StorageGateway.Types.SetSMBGuestPasswordOutput) => void): Request; + /** + * Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. + */ + setSMBGuestPassword(callback?: (err: AWSError, data: StorageGateway.Types.SetSMBGuestPasswordOutput) => void): Request; + /** + * Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway. + */ + shutdownGateway(params: StorageGateway.Types.ShutdownGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request; + /** + * Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway. + */ + shutdownGateway(callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request; + /** + * Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + startGateway(params: StorageGateway.Types.StartGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request; + /** + * Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + startGateway(callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request; + /** + * Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + updateBandwidthRateLimit(params: StorageGateway.Types.UpdateBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request; + /** + * Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. + */ + updateBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request; + /** + * Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. + */ + updateChapCredentials(params: StorageGateway.Types.UpdateChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request; + /** + * Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. + */ + updateChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request; + /** + * Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. + */ + updateGatewayInformation(params: StorageGateway.Types.UpdateGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request; + /** + * Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. + */ + updateGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request; + /** + * Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state. A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively. + */ + updateGatewaySoftwareNow(params: StorageGateway.Types.UpdateGatewaySoftwareNowInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request; + /** + * Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state. A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively. + */ + updateGatewaySoftwareNow(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request; + /** + * Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. + */ + updateMaintenanceStartTime(params: StorageGateway.Types.UpdateMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request; + /** + * Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. + */ + updateMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request; + /** + * Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type. To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share setting: Default storage class for your S3 bucket Metadata defaults for your S3 bucket Allowed NFS clients for your file share Squash settings Write status of your file share To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways. + */ + updateNFSFileShare(params: StorageGateway.Types.UpdateNFSFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateNFSFileShareOutput) => void): Request; + /** + * Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type. To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share setting: Default storage class for your S3 bucket Metadata defaults for your S3 bucket Allowed NFS clients for your file share Squash settings Write status of your file share To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways. + */ + updateNFSFileShare(callback?: (err: AWSError, data: StorageGateway.Types.UpdateNFSFileShareOutput) => void): Request; + /** + * Updates a Server Message Block (SMB) file share. To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share. + */ + updateSMBFileShare(params: StorageGateway.Types.UpdateSMBFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBFileShareOutput) => void): Request; + /** + * Updates a Server Message Block (SMB) file share. To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share. + */ + updateSMBFileShare(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBFileShareOutput) => void): Request; + /** + * Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. + */ + updateSnapshotSchedule(params: StorageGateway.Types.UpdateSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request; + /** + * Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. + */ + updateSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request; + /** + * Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type. + */ + updateVTLDeviceType(params: StorageGateway.Types.UpdateVTLDeviceTypeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request; + /** + * Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type. + */ + updateVTLDeviceType(callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request; +} +declare namespace StorageGateway { + export interface ActivateGatewayInput { + /** + * Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway. For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide. + */ + ActivationKey: ActivationKey; + /** + * The name you configured for your gateway. + */ + GatewayName: GatewayName; + /** + * A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule. + */ + GatewayTimezone: GatewayTimezone; + /** + * A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary. Valid Values: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference. + */ + GatewayRegion: RegionId; + /** + * A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED. Valid Values: "STORED", "CACHED", "VTL", "FILE_S3" + */ + GatewayType?: GatewayType; + /** + * The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5" + */ + TapeDriveType?: TapeDriveType; + /** + * The value that indicates the type of medium changer to use for tape gateway. This field is optional. Valid Values: "STK-L700", "AWS-Gateway-VTL" + */ + MediumChangerType?: MediumChangerType; + /** + * A list of up to 50 tags that can be assigned to the gateway. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags?: Tags; + } + export interface ActivateGatewayOutput { + GatewayARN?: GatewayARN; + } + export type ActivationKey = string; + export interface AddCacheInput { + GatewayARN: GatewayARN; + /** + * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. + */ + DiskIds: DiskIds; + } + export interface AddCacheOutput { + GatewayARN?: GatewayARN; + } + export interface AddTagsToResourceInput { + /** + * The Amazon Resource Name (ARN) of the resource you want to add tags to. + */ + ResourceARN: ResourceARN; + /** + * The key-value pair that represents the tag you want to add to the resource. The value can be an empty string. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags: Tags; + } + export interface AddTagsToResourceOutput { + /** + * The Amazon Resource Name (ARN) of the resource you want to add tags to. + */ + ResourceARN?: ResourceARN; + } + export interface AddUploadBufferInput { + GatewayARN: GatewayARN; + /** + * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. + */ + DiskIds: DiskIds; + } + export interface AddUploadBufferOutput { + GatewayARN?: GatewayARN; + } + export interface AddWorkingStorageInput { + GatewayARN: GatewayARN; + /** + * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. + */ + DiskIds: DiskIds; + } + export interface AddWorkingStorageOutput { + GatewayARN?: GatewayARN; + } + export interface AttachVolumeInput { + /** + * The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to. + */ + GatewayARN: GatewayARN; + /** + * The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. + */ + TargetName?: TargetName; + /** + * The Amazon Resource Name (ARN) of the volume to attach to the specified gateway. + */ + VolumeARN: VolumeARN; + /** + * The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. + */ + NetworkInterfaceId: NetworkInterfaceId; + /** + * The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume. + */ + DiskId?: DiskId; + } + export interface AttachVolumeOutput { + /** + * The Amazon Resource Name (ARN) of the volume that was attached to the gateway. + */ + VolumeARN?: VolumeARN; + /** + * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target. + */ + TargetARN?: TargetARN; + } + export type Authentication = string; + export type BandwidthDownloadRateLimit = number; + export type BandwidthType = string; + export type BandwidthUploadRateLimit = number; + export type Boolean = boolean; + export interface CachediSCSIVolume { + /** + * The Amazon Resource Name (ARN) of the storage volume. + */ + VolumeARN?: VolumeARN; + /** + * The unique identifier of the volume, e.g. vol-AE4B946D. + */ + VolumeId?: VolumeId; + /** + * One of the VolumeType enumeration values that describes the type of the volume. + */ + VolumeType?: VolumeType; + /** + * One of the VolumeStatus values that indicates the state of the storage volume. + */ + VolumeStatus?: VolumeStatus; + /** + * A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving Your Volumes to a Different Gateway. + */ + VolumeAttachmentStatus?: VolumeAttachmentStatus; + /** + * The size, in bytes, of the volume capacity. + */ + VolumeSizeInBytes?: long; + /** + * Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping. + */ + VolumeProgress?: DoubleObject; + /** + * If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included. + */ + SourceSnapshotId?: SnapshotId; + /** + * An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. + */ + VolumeiSCSIAttributes?: VolumeiSCSIAttributes; + /** + * The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp. + */ + CreatedDate?: CreatedDate; + /** + * The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill. This value is not available for volumes created prior to May 13, 2015, until you store data on the volume. + */ + VolumeUsedInBytes?: VolumeUsedInBytes; + KMSKey?: KMSKey; + /** + * The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. + */ + TargetName?: TargetName; + } + export type CachediSCSIVolumes = CachediSCSIVolume[]; + export interface CancelArchivalInput { + GatewayARN: GatewayARN; + /** + * The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for. + */ + TapeARN: TapeARN; + } + export interface CancelArchivalOutput { + /** + * The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled. + */ + TapeARN?: TapeARN; + } + export interface CancelRetrievalInput { + GatewayARN: GatewayARN; + /** + * The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for. + */ + TapeARN: TapeARN; + } + export interface CancelRetrievalOutput { + /** + * The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled. + */ + TapeARN?: TapeARN; + } + export type ChapCredentials = ChapInfo[]; + export interface ChapInfo { + /** + * The Amazon Resource Name (ARN) of the volume. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). + */ + TargetARN?: TargetARN; + /** + * The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. + */ + SecretToAuthenticateInitiator?: ChapSecret; + /** + * The iSCSI initiator that connects to the target. + */ + InitiatorName?: IqnName; + /** + * The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). + */ + SecretToAuthenticateTarget?: ChapSecret; + } + export type ChapSecret = string; + export type ClientToken = string; + export interface CreateCachediSCSIVolumeInput { + GatewayARN: GatewayARN; + /** + * The size of the volume in bytes. + */ + VolumeSizeInBytes: long; + /** + * The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. + */ + SnapshotId?: SnapshotId; + /** + * The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. + */ + TargetName: TargetName; + /** + * The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes. + */ + SourceVolumeARN?: VolumeARN; + /** + * The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. + */ + NetworkInterfaceId: NetworkInterfaceId; + /** + * A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request. + */ + ClientToken: ClientToken; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * A list of up to 50 tags that can be assigned to a cached volume. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags?: Tags; + } + export interface CreateCachediSCSIVolumeOutput { + /** + * The Amazon Resource Name (ARN) of the configured volume. + */ + VolumeARN?: VolumeARN; + /** + * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target. + */ + TargetARN?: TargetARN; + } + export interface CreateNFSFileShareInput { + /** + * A unique string value that you supply that is used by file gateway to ensure idempotent file share creation. + */ + ClientToken: ClientToken; + /** + * File share default values. Optional. + */ + NFSFileShareDefaults?: NFSFileShareDefaults; + /** + * The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share. + */ + GatewayARN: GatewayARN; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage. + */ + Role: Role; + /** + * The ARN of the backed storage used for storing file data. + */ + LocationARN: LocationARN; + /** + * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. + */ + DefaultStorageClass?: StorageClass; + /** + * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private". + */ + ObjectACL?: ObjectACL; + /** + * The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. + */ + ClientList?: FileShareClientList; + /** + * A value that maps a user to anonymous user. Valid options are the following: RootSquash - Only root is mapped to anonymous user. NoSquash - No one is mapped to anonymous user AllSquash - Everyone is mapped to anonymous user. + */ + Squash?: Squash; + /** + * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false. + */ + ReadOnly?: Boolean; + /** + * A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true. + */ + GuessMIMETypeEnabled?: Boolean; + /** + * A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration. + */ + RequesterPays?: Boolean; + /** + * A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags?: Tags; + } + export interface CreateNFSFileShareOutput { + /** + * The Amazon Resource Name (ARN) of the newly created file share. + */ + FileShareARN?: FileShareARN; + } + export interface CreateSMBFileShareInput { + /** + * A unique string value that you supply that is used by file gateway to ensure idempotent file share creation. + */ + ClientToken: ClientToken; + /** + * The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share. + */ + GatewayARN: GatewayARN; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage. + */ + Role: Role; + /** + * The ARN of the backed storage used for storing file data. + */ + LocationARN: LocationARN; + /** + * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. + */ + DefaultStorageClass?: StorageClass; + /** + * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private". + */ + ObjectACL?: ObjectACL; + /** + * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false. + */ + ReadOnly?: Boolean; + /** + * A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true. + */ + GuessMIMETypeEnabled?: Boolean; + /** + * A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration. + */ + RequesterPays?: Boolean; + /** + * Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions. + */ + SMBACLEnabled?: Boolean; + /** + * A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + AdminUserList?: FileShareUserList; + /** + * A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + ValidUserList?: FileShareUserList; + /** + * A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + InvalidUserList?: FileShareUserList; + /** + * The authentication method that users use to access the file share. Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory. + */ + Authentication?: Authentication; + /** + * A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags?: Tags; + } + export interface CreateSMBFileShareOutput { + /** + * The Amazon Resource Name (ARN) of the newly created file share. + */ + FileShareARN?: FileShareARN; + } + export interface CreateSnapshotFromVolumeRecoveryPointInput { + /** + * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN. + */ + VolumeARN: VolumeARN; + /** + * Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field + */ + SnapshotDescription: SnapshotDescription; + } + export interface CreateSnapshotFromVolumeRecoveryPointOutput { + /** + * The ID of the snapshot. + */ + SnapshotId?: SnapshotId; + /** + * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN. + */ + VolumeARN?: VolumeARN; + /** + * The time the volume was created from the recovery point. + */ + VolumeRecoveryPointTime?: string; + } + export interface CreateSnapshotInput { + /** + * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. + */ + VolumeARN: VolumeARN; + /** + * Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field + */ + SnapshotDescription: SnapshotDescription; + } + export interface CreateSnapshotOutput { + /** + * The Amazon Resource Name (ARN) of the volume of which the snapshot was taken. + */ + VolumeARN?: VolumeARN; + /** + * The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume). + */ + SnapshotId?: SnapshotId; + } + export interface CreateStorediSCSIVolumeInput { + GatewayARN: GatewayARN; + /** + * The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway. + */ + DiskId: DiskId; + /** + * The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. + */ + SnapshotId?: SnapshotId; + /** + * Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume. Valid Values: true, false + */ + PreserveExistingData: boolean; + /** + * The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. + */ + TargetName: TargetName; + /** + * The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. + */ + NetworkInterfaceId: NetworkInterfaceId; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags?: Tags; + } + export interface CreateStorediSCSIVolumeOutput { + /** + * The Amazon Resource Name (ARN) of the configured volume. + */ + VolumeARN?: VolumeARN; + /** + * The size of the volume in bytes. + */ + VolumeSizeInBytes?: long; + /** + * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target. + */ + TargetARN?: TargetARN; + } + export interface CreateTapeWithBarcodeInput { + /** + * The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and region. + */ + GatewayARN: GatewayARN; + /** + * The size, in bytes, of the virtual tape that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). + */ + TapeSizeInBytes: TapeSize; + /** + * The barcode that you want to assign to the tape. Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted. + */ + TapeBarcode: TapeBarcode; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE" + */ + PoolId?: PoolId; + /** + * A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags?: Tags; + } + export interface CreateTapeWithBarcodeOutput { + /** + * A unique Amazon Resource Name (ARN) that represents the virtual tape that was created. + */ + TapeARN?: TapeARN; + } + export interface CreateTapesInput { + /** + * The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region. + */ + GatewayARN: GatewayARN; + /** + * The size, in bytes, of the virtual tapes that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). + */ + TapeSizeInBytes: TapeSize; + /** + * A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request. Using the same ClientToken prevents creating the tape multiple times. + */ + ClientToken: ClientToken; + /** + * The number of virtual tapes that you want to create. + */ + NumTapesToCreate: NumTapesToCreate; + /** + * A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique. The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z. + */ + TapeBarcodePrefix: TapeBarcodePrefix; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE" + */ + PoolId?: PoolId; + /** + * A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256. + */ + Tags?: Tags; + } + export interface CreateTapesOutput { + /** + * A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created. + */ + TapeARNs?: TapeARNs; + } + export type CreatedDate = Date; + export type DayOfMonth = number; + export type DayOfWeek = number; + export interface DeleteBandwidthRateLimitInput { + GatewayARN: GatewayARN; + /** + * One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete. Valid Values: Upload, Download, All. + */ + BandwidthType: BandwidthType; + } + export interface DeleteBandwidthRateLimitOutput { + GatewayARN?: GatewayARN; + } + export interface DeleteChapCredentialsInput { + /** + * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN. + */ + TargetARN: TargetARN; + /** + * The iSCSI initiator that connects to the target. + */ + InitiatorName: IqnName; + } + export interface DeleteChapCredentialsOutput { + /** + * The Amazon Resource Name (ARN) of the target. + */ + TargetARN?: TargetARN; + /** + * The iSCSI initiator that connects to the target. + */ + InitiatorName?: IqnName; + } + export interface DeleteFileShareInput { + /** + * The Amazon Resource Name (ARN) of the file share to be deleted. + */ + FileShareARN: FileShareARN; + /** + * If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status. + */ + ForceDelete?: boolean; + } + export interface DeleteFileShareOutput { + /** + * The Amazon Resource Name (ARN) of the deleted file share. + */ + FileShareARN?: FileShareARN; + } + export interface DeleteGatewayInput { + GatewayARN: GatewayARN; + } + export interface DeleteGatewayOutput { + GatewayARN?: GatewayARN; + } + export interface DeleteSnapshotScheduleInput { + /** + * The volume which snapshot schedule to delete. + */ + VolumeARN: VolumeARN; + } + export interface DeleteSnapshotScheduleOutput { + /** + * The volume which snapshot schedule was deleted. + */ + VolumeARN?: VolumeARN; + } + export interface DeleteTapeArchiveInput { + /** + * The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS). + */ + TapeARN: TapeARN; + } + export interface DeleteTapeArchiveOutput { + /** + * The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS). + */ + TapeARN?: TapeARN; + } + export interface DeleteTapeInput { + /** + * The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region. + */ + GatewayARN: GatewayARN; + /** + * The Amazon Resource Name (ARN) of the virtual tape to delete. + */ + TapeARN: TapeARN; + } + export interface DeleteTapeOutput { + /** + * The Amazon Resource Name (ARN) of the deleted virtual tape. + */ + TapeARN?: TapeARN; + } + export interface DeleteVolumeInput { + /** + * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. + */ + VolumeARN: VolumeARN; + } + export interface DeleteVolumeOutput { + /** + * The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request. + */ + VolumeARN?: VolumeARN; + } + export interface DescribeBandwidthRateLimitInput { + GatewayARN: GatewayARN; + } + export interface DescribeBandwidthRateLimitOutput { + GatewayARN?: GatewayARN; + /** + * The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set. + */ + AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit; + /** + * The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set. + */ + AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit; + } + export interface DescribeCacheInput { + GatewayARN: GatewayARN; + } + export interface DescribeCacheOutput { + GatewayARN?: GatewayARN; + /** + * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. + */ + DiskIds?: DiskIds; + /** + * The amount of cache in bytes allocated to the a gateway. + */ + CacheAllocatedInBytes?: long; + /** + * Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period. + */ + CacheUsedPercentage?: double; + /** + * The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to AWS. The sample is taken at the end of the reporting period. + */ + CacheDirtyPercentage?: double; + /** + * Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period. + */ + CacheHitPercentage?: double; + /** + * Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period. + */ + CacheMissPercentage?: double; + } + export interface DescribeCachediSCSIVolumesInput { + /** + * An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway. + */ + VolumeARNs: VolumeARNs; + } + export interface DescribeCachediSCSIVolumesOutput { + /** + * An array of objects where each object contains metadata about one cached volume. + */ + CachediSCSIVolumes?: CachediSCSIVolumes; + } + export interface DescribeChapCredentialsInput { + /** + * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN. + */ + TargetARN: TargetARN; + } + export interface DescribeChapCredentialsOutput { + /** + * An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields: InitiatorName: The iSCSI initiator that connects to the target. SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). TargetARN: The Amazon Resource Name (ARN) of the storage volume. + */ + ChapCredentials?: ChapCredentials; + } + export interface DescribeGatewayInformationInput { + GatewayARN: GatewayARN; + } + export interface DescribeGatewayInformationOutput { + GatewayARN?: GatewayARN; + /** + * The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations. + */ + GatewayId?: GatewayId; + /** + * The name you configured for your gateway. + */ + GatewayName?: string; + /** + * A value that indicates the time zone configured for the gateway. + */ + GatewayTimezone?: GatewayTimezone; + /** + * A value that indicates the operating state of the gateway. + */ + GatewayState?: GatewayState; + /** + * A NetworkInterface array that contains descriptions of the gateway network interfaces. + */ + GatewayNetworkInterfaces?: GatewayNetworkInterfaces; + /** + * The type of the gateway. + */ + GatewayType?: GatewayType; + /** + * The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response. + */ + NextUpdateAvailabilityDate?: NextUpdateAvailabilityDate; + /** + * The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. + */ + LastSoftwareUpdate?: LastSoftwareUpdate; + /** + * The ID of the Amazon EC2 instance that was used to launch the gateway. + */ + Ec2InstanceId?: Ec2InstanceId; + /** + * The AWS Region where the Amazon EC2 instance is located. + */ + Ec2InstanceRegion?: Ec2InstanceRegion; + /** + * A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation. + */ + Tags?: Tags; + } + export interface DescribeMaintenanceStartTimeInput { + GatewayARN: GatewayARN; + } + export interface DescribeMaintenanceStartTimeOutput { + GatewayARN?: GatewayARN; + /** + * The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway. + */ + HourOfDay?: HourOfDay; + /** + * The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway. + */ + MinuteOfHour?: MinuteOfHour; + /** + * An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway. + */ + DayOfWeek?: DayOfWeek; + /** + * The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month. This value is only available for tape and volume gateways. + */ + DayOfMonth?: DayOfMonth; + /** + * A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway. + */ + Timezone?: GatewayTimezone; + } + export interface DescribeNFSFileSharesInput { + /** + * An array containing the Amazon Resource Name (ARN) of each file share to be described. + */ + FileShareARNList: FileShareARNList; + } + export interface DescribeNFSFileSharesOutput { + /** + * An array containing a description for each requested file share. + */ + NFSFileShareInfoList?: NFSFileShareInfoList; + } + export interface DescribeSMBFileSharesInput { + /** + * An array containing the Amazon Resource Name (ARN) of each file share to be described. + */ + FileShareARNList: FileShareARNList; + } + export interface DescribeSMBFileSharesOutput { + /** + * An array containing a description for each requested file share. + */ + SMBFileShareInfoList?: SMBFileShareInfoList; + } + export interface DescribeSMBSettingsInput { + GatewayARN: GatewayARN; + } + export interface DescribeSMBSettingsOutput { + GatewayARN?: GatewayARN; + /** + * The name of the domain that the gateway is joined to. + */ + DomainName?: DomainName; + /** + * This value is true if a password for the guest user “smbguest” is set, and otherwise false. + */ + SMBGuestPasswordSet?: Boolean; + } + export interface DescribeSnapshotScheduleInput { + /** + * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. + */ + VolumeARN: VolumeARN; + } + export interface DescribeSnapshotScheduleOutput { + /** + * The Amazon Resource Name (ARN) of the volume that was specified in the request. + */ + VolumeARN?: VolumeARN; + /** + * The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway. + */ + StartAt?: HourOfDay; + /** + * The number of hours between snapshots. + */ + RecurrenceInHours?: RecurrenceInHours; + /** + * The snapshot description. + */ + Description?: Description; + /** + * A value that indicates the time zone of the gateway. + */ + Timezone?: GatewayTimezone; + } + export interface DescribeStorediSCSIVolumesInput { + /** + * An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway. + */ + VolumeARNs: VolumeARNs; + } + export interface DescribeStorediSCSIVolumesOutput { + /** + * Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned: ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target. LunNumber: The logical disk number. NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target. NetworkInterfacePort: The port used to communicate with iSCSI targets. PreservedExistingData: Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included. StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume. TargetARN: The Amazon Resource Name (ARN) of the volume target. VolumeARN: The Amazon Resource Name (ARN) of the stored volume. VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation. VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB. VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping. VolumeSizeInBytes: The size of the volume in bytes. VolumeStatus: One of the VolumeStatus values that indicates the state of the volume. VolumeType: One of the enumeration values describing the type of the volume. Currently, on STORED volumes are supported. + */ + StorediSCSIVolumes?: StorediSCSIVolumes; + } + export interface DescribeTapeArchivesInput { + /** + * Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. + */ + TapeARNs?: TapeARNs; + /** + * An opaque string that indicates the position at which to begin describing virtual tapes. + */ + Marker?: Marker; + /** + * Specifies that the number of virtual tapes descried be limited to the specified number. + */ + Limit?: PositiveIntObject; + } + export interface DescribeTapeArchivesOutput { + /** + * An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode. + */ + TapeArchives?: TapeArchives; + /** + * An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response. + */ + Marker?: Marker; + } + export interface DescribeTapeRecoveryPointsInput { + GatewayARN: GatewayARN; + /** + * An opaque string that indicates the position at which to begin describing the virtual tape recovery points. + */ + Marker?: Marker; + /** + * Specifies that the number of virtual tape recovery points that are described be limited to the specified number. + */ + Limit?: PositiveIntObject; + } + export interface DescribeTapeRecoveryPointsOutput { + GatewayARN?: GatewayARN; + /** + * An array of TapeRecoveryPointInfos that are available for the specified gateway. + */ + TapeRecoveryPointInfos?: TapeRecoveryPointInfos; + /** + * An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended. Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response. + */ + Marker?: Marker; + } + export interface DescribeTapesInput { + GatewayARN: GatewayARN; + /** + * Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway. + */ + TapeARNs?: TapeARNs; + /** + * A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve. If not specified, the first page of results is retrieved. + */ + Marker?: Marker; + /** + * Specifies that the number of virtual tapes described be limited to the specified number. Amazon Web Services may impose its own limit, if this field is not set. + */ + Limit?: PositiveIntObject; + } + export interface DescribeTapesOutput { + /** + * An array of virtual tape descriptions. + */ + Tapes?: Tapes; + /** + * An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results. If a response does not contain a marker, then there are no more results to be retrieved. + */ + Marker?: Marker; + } + export interface DescribeUploadBufferInput { + GatewayARN: GatewayARN; + } + export interface DescribeUploadBufferOutput { + GatewayARN?: GatewayARN; + /** + * An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty. + */ + DiskIds?: DiskIds; + /** + * The total number of bytes being used in the gateway's upload buffer. + */ + UploadBufferUsedInBytes?: long; + /** + * The total number of bytes allocated in the gateway's as upload buffer. + */ + UploadBufferAllocatedInBytes?: long; + } + export interface DescribeVTLDevicesInput { + GatewayARN: GatewayARN; + /** + * An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway. + */ + VTLDeviceARNs?: VTLDeviceARNs; + /** + * An opaque string that indicates the position at which to begin describing the VTL devices. + */ + Marker?: Marker; + /** + * Specifies that the number of VTL devices described be limited to the specified number. + */ + Limit?: PositiveIntObject; + } + export interface DescribeVTLDevicesOutput { + GatewayARN?: GatewayARN; + /** + * An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices. + */ + VTLDevices?: VTLDevices; + /** + * An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response. + */ + Marker?: Marker; + } + export interface DescribeWorkingStorageInput { + GatewayARN: GatewayARN; + } + export interface DescribeWorkingStorageOutput { + GatewayARN?: GatewayARN; + /** + * An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty. + */ + DiskIds?: DiskIds; + /** + * The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0. + */ + WorkingStorageUsedInBytes?: long; + /** + * The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0. + */ + WorkingStorageAllocatedInBytes?: long; + } + export type Description = string; + export interface DetachVolumeInput { + /** + * The Amazon Resource Name (ARN) of the volume to detach from the gateway. + */ + VolumeARN: VolumeARN; + /** + * Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume. + */ + ForceDetach?: Boolean; + } + export interface DetachVolumeOutput { + /** + * The Amazon Resource Name (ARN) of the volume that was detached. + */ + VolumeARN?: VolumeARN; + } + export type DeviceType = string; + export interface DeviceiSCSIAttributes { + /** + * Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target. + */ + TargetARN?: TargetARN; + /** + * The network interface identifier of the VTL device. + */ + NetworkInterfaceId?: NetworkInterfaceId; + /** + * The port used to communicate with iSCSI VTL device targets. + */ + NetworkInterfacePort?: integer; + /** + * Indicates whether mutual CHAP is enabled for the iSCSI target. + */ + ChapEnabled?: boolean; + } + export interface DisableGatewayInput { + GatewayARN: GatewayARN; + } + export interface DisableGatewayOutput { + /** + * The unique Amazon Resource Name (ARN) of the disabled gateway. + */ + GatewayARN?: GatewayARN; + } + export interface Disk { + /** + * The unique device ID or other distinguishing data that identifies a local disk. + */ + DiskId?: DiskId; + /** + * The path of a local disk in the gateway virtual machine (VM). + */ + DiskPath?: string; + /** + * The device node of a local disk as assigned by the virtualization environment. + */ + DiskNode?: string; + /** + * A value that represents the status of a local disk. + */ + DiskStatus?: string; + /** + * The local disk size in bytes. + */ + DiskSizeInBytes?: long; + DiskAllocationType?: DiskAllocationType; + /** + * The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId. + */ + DiskAllocationResource?: string; + DiskAttributeList?: DiskAttributeList; + } + export type DiskAllocationType = string; + export type DiskAttribute = string; + export type DiskAttributeList = DiskAttribute[]; + export type DiskId = string; + export type DiskIds = DiskId[]; + export type Disks = Disk[]; + export type DomainName = string; + export type DomainUserName = string; + export type DomainUserPassword = string; + export type DoubleObject = number; + export type Ec2InstanceId = string; + export type Ec2InstanceRegion = string; + export type FileShareARN = string; + export type FileShareARNList = FileShareARN[]; + export type FileShareClientList = IPV4AddressCIDR[]; + export type FileShareId = string; + export interface FileShareInfo { + FileShareType?: FileShareType; + FileShareARN?: FileShareARN; + FileShareId?: FileShareId; + FileShareStatus?: FileShareStatus; + GatewayARN?: GatewayARN; + } + export type FileShareInfoList = FileShareInfo[]; + export type FileShareStatus = string; + export type FileShareType = "NFS"|"SMB"|string; + export type FileShareUser = string; + export type FileShareUserList = FileShareUser[]; + export type Folder = string; + export type FolderList = Folder[]; + export type GatewayARN = string; + export type GatewayId = string; + export interface GatewayInfo { + /** + * The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations. + */ + GatewayId?: GatewayId; + /** + * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. + */ + GatewayARN?: GatewayARN; + /** + * The type of the gateway. + */ + GatewayType?: GatewayType; + /** + * The state of the gateway. Valid Values: DISABLED or ACTIVE + */ + GatewayOperationalState?: GatewayOperationalState; + /** + * The name of the gateway. + */ + GatewayName?: string; + /** + * The ID of the Amazon EC2 instance that was used to launch the gateway. + */ + Ec2InstanceId?: Ec2InstanceId; + /** + * The AWS Region where the Amazon EC2 instance is located. + */ + Ec2InstanceRegion?: Ec2InstanceRegion; + } + export type GatewayName = string; + export type GatewayNetworkInterfaces = NetworkInterface[]; + export type GatewayOperationalState = string; + export type GatewayState = string; + export type GatewayTimezone = string; + export type GatewayType = string; + export type Gateways = GatewayInfo[]; + export type Host = string; + export type Hosts = Host[]; + export type HourOfDay = number; + export type IPV4AddressCIDR = string; + export type Initiator = string; + export type Initiators = Initiator[]; + export type IqnName = string; + export interface JoinDomainInput { + /** + * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. + */ + GatewayARN: GatewayARN; + /** + * The name of the domain that you want the gateway to join. + */ + DomainName: DomainName; + /** + * The organizational unit (OU) is a container with an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain. + */ + OrganizationalUnit?: OrganizationalUnit; + /** + * List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389. + */ + DomainControllers?: Hosts; + /** + * Sets the user name of user who has permission to add the gateway to the Active Directory domain. + */ + UserName: DomainUserName; + /** + * Sets the password of the user who has permission to add the gateway to the Active Directory domain. + */ + Password: DomainUserPassword; + } + export interface JoinDomainOutput { + /** + * The unique Amazon Resource Name (ARN) of the gateway that joined the domain. + */ + GatewayARN?: GatewayARN; + } + export type KMSKey = string; + export type LastSoftwareUpdate = string; + export interface ListFileSharesInput { + /** + * The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed. + */ + GatewayARN?: GatewayARN; + /** + * The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional. + */ + Limit?: PositiveIntObject; + /** + * Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional. + */ + Marker?: Marker; + } + export interface ListFileSharesOutput { + /** + * If the request includes Marker, the response returns that value in this field. + */ + Marker?: Marker; + /** + * If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares. + */ + NextMarker?: Marker; + /** + * An array of information about the file gateway's file shares. + */ + FileShareInfoList?: FileShareInfoList; + } + export interface ListGatewaysInput { + /** + * An opaque string that indicates the position at which to begin the returned list of gateways. + */ + Marker?: Marker; + /** + * Specifies that the list of gateways returned be limited to the specified number of items. + */ + Limit?: PositiveIntObject; + } + export interface ListGatewaysOutput { + /** + * An array of GatewayInfo objects. + */ + Gateways?: Gateways; + /** + * Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response. + */ + Marker?: Marker; + } + export interface ListLocalDisksInput { + GatewayARN: GatewayARN; + } + export interface ListLocalDisksOutput { + GatewayARN?: GatewayARN; + /** + * A JSON object containing the following fields: ListLocalDisksOutput$Disks + */ + Disks?: Disks; + } + export interface ListTagsForResourceInput { + /** + * The Amazon Resource Name (ARN) of the resource for which you want to list tags. + */ + ResourceARN: ResourceARN; + /** + * An opaque string that indicates the position at which to begin returning the list of tags. + */ + Marker?: Marker; + /** + * Specifies that the list of tags returned be limited to the specified number of items. + */ + Limit?: PositiveIntObject; + } + export interface ListTagsForResourceOutput { + /** + * he Amazon Resource Name (ARN) of the resource for which you want to list tags. + */ + ResourceARN?: ResourceARN; + /** + * An opaque string that indicates the position at which to stop returning the list of tags. + */ + Marker?: Marker; + /** + * An array that contains the tags for the specified resource. + */ + Tags?: Tags; + } + export interface ListTapesInput { + TapeARNs?: TapeARNs; + /** + * A string that indicates the position at which to begin the returned list of tapes. + */ + Marker?: Marker; + /** + * An optional number limit for the tapes in the list returned by this call. + */ + Limit?: PositiveIntObject; + } + export interface ListTapesOutput { + TapeInfos?: TapeInfos; + /** + * A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body. + */ + Marker?: Marker; + } + export interface ListVolumeInitiatorsInput { + /** + * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway. + */ + VolumeARN: VolumeARN; + } + export interface ListVolumeInitiatorsOutput { + /** + * The host names and port numbers of all iSCSI initiators that are connected to the gateway. + */ + Initiators?: Initiators; + } + export interface ListVolumeRecoveryPointsInput { + GatewayARN: GatewayARN; + } + export interface ListVolumeRecoveryPointsOutput { + GatewayARN?: GatewayARN; + /** + * An array of VolumeRecoveryPointInfo objects. + */ + VolumeRecoveryPointInfos?: VolumeRecoveryPointInfos; + } + export interface ListVolumesInput { + GatewayARN?: GatewayARN; + /** + * A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request. + */ + Marker?: Marker; + /** + * Specifies that the list of volumes returned be limited to the specified number of items. + */ + Limit?: PositiveIntObject; + } + export interface ListVolumesOutput { + GatewayARN?: GatewayARN; + /** + * Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body. + */ + Marker?: Marker; + /** + * An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]". + */ + VolumeInfos?: VolumeInfos; + } + export type LocalConsolePassword = string; + export type LocationARN = string; + export type Marker = string; + export type MediumChangerType = string; + export type MinuteOfHour = number; + export interface NFSFileShareDefaults { + /** + * The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666. + */ + FileMode?: PermissionMode; + /** + * The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777. + */ + DirectoryMode?: PermissionMode; + /** + * The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. + */ + GroupId?: PermissionId; + /** + * The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. + */ + OwnerId?: PermissionId; + } + export interface NFSFileShareInfo { + NFSFileShareDefaults?: NFSFileShareDefaults; + FileShareARN?: FileShareARN; + FileShareId?: FileShareId; + FileShareStatus?: FileShareStatus; + GatewayARN?: GatewayARN; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: boolean; + KMSKey?: KMSKey; + Path?: Path; + Role?: Role; + LocationARN?: LocationARN; + /** + * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. + */ + DefaultStorageClass?: StorageClass; + ObjectACL?: ObjectACL; + ClientList?: FileShareClientList; + Squash?: Squash; + /** + * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false. + */ + ReadOnly?: Boolean; + /** + * A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true. + */ + GuessMIMETypeEnabled?: Boolean; + /** + * A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration. + */ + RequesterPays?: Boolean; + /** + * A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation. + */ + Tags?: Tags; + } + export type NFSFileShareInfoList = NFSFileShareInfo[]; + export interface NetworkInterface { + /** + * The Internet Protocol version 4 (IPv4) address of the interface. + */ + Ipv4Address?: string; + /** + * The Media Access Control (MAC) address of the interface. This is currently unsupported and will not be returned in output. + */ + MacAddress?: string; + /** + * The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported. + */ + Ipv6Address?: string; + } + export type NetworkInterfaceId = string; + export type NextUpdateAvailabilityDate = string; + export type NotificationId = string; + export interface NotifyWhenUploadedInput { + FileShareARN: FileShareARN; + } + export interface NotifyWhenUploadedOutput { + FileShareARN?: FileShareARN; + NotificationId?: NotificationId; + } + export type NumTapesToCreate = number; + export type ObjectACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"aws-exec-read"|string; + export type OrganizationalUnit = string; + export type Path = string; + export type PermissionId = number; + export type PermissionMode = string; + export type PoolId = string; + export type PositiveIntObject = number; + export type RecurrenceInHours = number; + export interface RefreshCacheInput { + /** + * The Amazon Resource Name (ARN) of the file share you want to refresh. + */ + FileShareARN: FileShareARN; + /** + * A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to "true", the entire S3 bucket that the file share has access to is refreshed. + */ + FolderList?: FolderList; + /** + * A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to "true", each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is "true". + */ + Recursive?: Boolean; + } + export interface RefreshCacheOutput { + FileShareARN?: FileShareARN; + NotificationId?: NotificationId; + } + export type RegionId = string; + export interface RemoveTagsFromResourceInput { + /** + * The Amazon Resource Name (ARN) of the resource you want to remove the tags from. + */ + ResourceARN: ResourceARN; + /** + * The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair. + */ + TagKeys: TagKeys; + } + export interface RemoveTagsFromResourceOutput { + /** + * The Amazon Resource Name (ARN) of the resource that the tags were removed from. + */ + ResourceARN?: ResourceARN; + } + export interface ResetCacheInput { + GatewayARN: GatewayARN; + } + export interface ResetCacheOutput { + GatewayARN?: GatewayARN; + } + export type ResourceARN = string; + export interface RetrieveTapeArchiveInput { + /** + * The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS). + */ + TapeARN: TapeARN; + /** + * The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region. You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway. + */ + GatewayARN: GatewayARN; + } + export interface RetrieveTapeArchiveOutput { + /** + * The Amazon Resource Name (ARN) of the retrieved virtual tape. + */ + TapeARN?: TapeARN; + } + export interface RetrieveTapeRecoveryPointInput { + /** + * The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point. + */ + TapeARN: TapeARN; + GatewayARN: GatewayARN; + } + export interface RetrieveTapeRecoveryPointOutput { + /** + * The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved. + */ + TapeARN?: TapeARN; + } + export type Role = string; + export interface SMBFileShareInfo { + FileShareARN?: FileShareARN; + FileShareId?: FileShareId; + FileShareStatus?: FileShareStatus; + GatewayARN?: GatewayARN; + /** + * True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: boolean; + KMSKey?: KMSKey; + /** + * The file share path used by the SMB client to identify the mount point. + */ + Path?: Path; + Role?: Role; + LocationARN?: LocationARN; + /** + * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. + */ + DefaultStorageClass?: StorageClass; + ObjectACL?: ObjectACL; + /** + * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false. + */ + ReadOnly?: Boolean; + /** + * A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true. + */ + GuessMIMETypeEnabled?: Boolean; + /** + * A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration. + */ + RequesterPays?: Boolean; + /** + * If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to "false", it indicates that file and directory permissions are mapped to the POSIX permission. + */ + SMBACLEnabled?: Boolean; + /** + * A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + AdminUserList?: FileShareUserList; + /** + * A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + ValidUserList?: FileShareUserList; + /** + * A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + InvalidUserList?: FileShareUserList; + Authentication?: Authentication; + /** + * A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation. + */ + Tags?: Tags; + } + export type SMBFileShareInfoList = SMBFileShareInfo[]; + export type SMBGuestPassword = string; + export interface SetLocalConsolePasswordInput { + GatewayARN: GatewayARN; + /** + * The password you want to set for your VM local console. + */ + LocalConsolePassword: LocalConsolePassword; + } + export interface SetLocalConsolePasswordOutput { + GatewayARN?: GatewayARN; + } + export interface SetSMBGuestPasswordInput { + /** + * The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated with. + */ + GatewayARN: GatewayARN; + /** + * The password that you want to set for your SMB Server. + */ + Password: SMBGuestPassword; + } + export interface SetSMBGuestPasswordOutput { + GatewayARN?: GatewayARN; + } + export interface ShutdownGatewayInput { + GatewayARN: GatewayARN; + } + export interface ShutdownGatewayOutput { + GatewayARN?: GatewayARN; + } + export type SnapshotDescription = string; + export type SnapshotId = string; + export type Squash = string; + export interface StartGatewayInput { + GatewayARN: GatewayARN; + } + export interface StartGatewayOutput { + GatewayARN?: GatewayARN; + } + export type StorageClass = string; + export interface StorediSCSIVolume { + /** + * The Amazon Resource Name (ARN) of the storage volume. + */ + VolumeARN?: VolumeARN; + /** + * The unique identifier of the volume, e.g. vol-AE4B946D. + */ + VolumeId?: VolumeId; + /** + * One of the VolumeType enumeration values describing the type of the volume. + */ + VolumeType?: VolumeType; + /** + * One of the VolumeStatus values that indicates the state of the storage volume. + */ + VolumeStatus?: VolumeStatus; + /** + * A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving Your Volumes to a Different Gateway. + */ + VolumeAttachmentStatus?: VolumeAttachmentStatus; + /** + * The size of the volume in bytes. + */ + VolumeSizeInBytes?: long; + /** + * Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping. + */ + VolumeProgress?: DoubleObject; + /** + * The ID of the local disk that was specified in the CreateStorediSCSIVolume operation. + */ + VolumeDiskId?: DiskId; + /** + * If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included. + */ + SourceSnapshotId?: SnapshotId; + /** + * Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. Valid Values: true, false + */ + PreservedExistingData?: boolean; + /** + * An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. + */ + VolumeiSCSIAttributes?: VolumeiSCSIAttributes; + /** + * The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp. + */ + CreatedDate?: CreatedDate; + /** + * The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill. This value is not available for volumes created prior to May 13, 2015, until you store data on the volume. + */ + VolumeUsedInBytes?: VolumeUsedInBytes; + KMSKey?: KMSKey; + /** + * The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. + */ + TargetName?: TargetName; + } + export type StorediSCSIVolumes = StorediSCSIVolume[]; + export interface Tag { + /** + * Tag key (String). The key can't start with aws:. + */ + Key: TagKey; + /** + * Value of the tag key. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeys = TagKey[]; + export type TagValue = string; + export type Tags = Tag[]; + export interface Tape { + /** + * The Amazon Resource Name (ARN) of the virtual tape. + */ + TapeARN?: TapeARN; + /** + * The barcode that identifies a specific virtual tape. + */ + TapeBarcode?: TapeBarcode; + /** + * The date the virtual tape was created. + */ + TapeCreatedDate?: Time; + /** + * The size, in bytes, of the virtual tape capacity. + */ + TapeSizeInBytes?: TapeSize; + /** + * The current state of the virtual tape. + */ + TapeStatus?: TapeStatus; + /** + * The virtual tape library (VTL) device that the virtual tape is associated with. + */ + VTLDevice?: VTLDeviceARN; + /** + * For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete. Range: 0 (not started) to 100 (complete). + */ + Progress?: DoubleObject; + /** + * The size, in bytes, of data stored on the virtual tape. This value is not available for tapes created prior to May 13, 2015. + */ + TapeUsedInBytes?: TapeUsage; + KMSKey?: KMSKey; + /** + * The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE" + */ + PoolId?: PoolId; + } + export type TapeARN = string; + export type TapeARNs = TapeARN[]; + export interface TapeArchive { + /** + * The Amazon Resource Name (ARN) of an archived virtual tape. + */ + TapeARN?: TapeARN; + /** + * The barcode that identifies the archived virtual tape. + */ + TapeBarcode?: TapeBarcode; + /** + * The date the virtual tape was created. + */ + TapeCreatedDate?: Time; + /** + * The size, in bytes, of the archived virtual tape. + */ + TapeSizeInBytes?: TapeSize; + /** + * The time that the archiving of the virtual tape was completed. The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. + */ + CompletionTime?: Time; + /** + * The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to. The virtual tape is retrieved from the virtual tape shelf (VTS). + */ + RetrievedTo?: GatewayARN; + /** + * The current state of the archived virtual tape. + */ + TapeStatus?: TapeArchiveStatus; + /** + * The size, in bytes, of data stored on the virtual tape. This value is not available for tapes created prior to May 13, 2015. + */ + TapeUsedInBytes?: TapeUsage; + KMSKey?: KMSKey; + /** + * The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool. Valid values: "GLACIER", "DEEP_ARCHIVE" + */ + PoolId?: PoolId; + } + export type TapeArchiveStatus = string; + export type TapeArchives = TapeArchive[]; + export type TapeBarcode = string; + export type TapeBarcodePrefix = string; + export type TapeDriveType = string; + export interface TapeInfo { + /** + * The Amazon Resource Name (ARN) of a virtual tape. + */ + TapeARN?: TapeARN; + /** + * The barcode that identifies a specific virtual tape. + */ + TapeBarcode?: TapeBarcode; + /** + * The size, in bytes, of a virtual tape. + */ + TapeSizeInBytes?: TapeSize; + /** + * The status of the tape. + */ + TapeStatus?: TapeStatus; + /** + * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. + */ + GatewayARN?: GatewayARN; + /** + * The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE" + */ + PoolId?: PoolId; + } + export type TapeInfos = TapeInfo[]; + export interface TapeRecoveryPointInfo { + /** + * The Amazon Resource Name (ARN) of the virtual tape. + */ + TapeARN?: TapeARN; + /** + * The time when the point-in-time view of the virtual tape was replicated for later recovery. The default time stamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. + */ + TapeRecoveryPointTime?: Time; + /** + * The size, in bytes, of the virtual tapes to recover. + */ + TapeSizeInBytes?: TapeSize; + /** + * The status of the virtual tapes. + */ + TapeStatus?: TapeRecoveryPointStatus; + } + export type TapeRecoveryPointInfos = TapeRecoveryPointInfo[]; + export type TapeRecoveryPointStatus = string; + export type TapeSize = number; + export type TapeStatus = string; + export type TapeUsage = number; + export type Tapes = Tape[]; + export type TargetARN = string; + export type TargetName = string; + export type Time = Date; + export interface UpdateBandwidthRateLimitInput { + GatewayARN: GatewayARN; + /** + * The average upload bandwidth rate limit in bits per second. + */ + AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit; + /** + * The average download bandwidth rate limit in bits per second. + */ + AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit; + } + export interface UpdateBandwidthRateLimitOutput { + GatewayARN?: GatewayARN; + } + export interface UpdateChapCredentialsInput { + /** + * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN. + */ + TargetARN: TargetARN; + /** + * The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. The secret key must be between 12 and 16 bytes when encoded in UTF-8. + */ + SecretToAuthenticateInitiator: ChapSecret; + /** + * The iSCSI initiator that connects to the target. + */ + InitiatorName: IqnName; + /** + * The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. Maximum bytes of 16. The secret key must be between 12 and 16 bytes when encoded in UTF-8. + */ + SecretToAuthenticateTarget?: ChapSecret; + } + export interface UpdateChapCredentialsOutput { + /** + * The Amazon Resource Name (ARN) of the target. This is the same target specified in the request. + */ + TargetARN?: TargetARN; + /** + * The iSCSI initiator that connects to the target. This is the same initiator name specified in the request. + */ + InitiatorName?: IqnName; + } + export interface UpdateGatewayInformationInput { + GatewayARN: GatewayARN; + GatewayName?: GatewayName; + /** + * A value that indicates the time zone of the gateway. + */ + GatewayTimezone?: GatewayTimezone; + } + export interface UpdateGatewayInformationOutput { + GatewayARN?: GatewayARN; + /** + * The name you configured for your gateway. + */ + GatewayName?: string; + } + export interface UpdateGatewaySoftwareNowInput { + GatewayARN: GatewayARN; + } + export interface UpdateGatewaySoftwareNowOutput { + GatewayARN?: GatewayARN; + } + export interface UpdateMaintenanceStartTimeInput { + GatewayARN: GatewayARN; + /** + * The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway. + */ + HourOfDay: HourOfDay; + /** + * The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway. + */ + MinuteOfHour: MinuteOfHour; + /** + * The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday. + */ + DayOfWeek?: DayOfWeek; + /** + * The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month. This value is only available for tape and volume gateways. + */ + DayOfMonth?: DayOfMonth; + } + export interface UpdateMaintenanceStartTimeOutput { + GatewayARN?: GatewayARN; + } + export interface UpdateNFSFileShareInput { + /** + * The Amazon Resource Name (ARN) of the file share to be updated. + */ + FileShareARN: FileShareARN; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * The default values for the file share. Optional. + */ + NFSFileShareDefaults?: NFSFileShareDefaults; + /** + * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. + */ + DefaultStorageClass?: StorageClass; + /** + * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private". + */ + ObjectACL?: ObjectACL; + /** + * The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. + */ + ClientList?: FileShareClientList; + /** + * The user mapped to anonymous user. Valid options are the following: RootSquash - Only root is mapped to anonymous user. NoSquash - No one is mapped to anonymous user AllSquash - Everyone is mapped to anonymous user. + */ + Squash?: Squash; + /** + * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false. + */ + ReadOnly?: Boolean; + /** + * A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true. + */ + GuessMIMETypeEnabled?: Boolean; + /** + * A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration. + */ + RequesterPays?: Boolean; + } + export interface UpdateNFSFileShareOutput { + /** + * The Amazon Resource Name (ARN) of the updated file share. + */ + FileShareARN?: FileShareARN; + } + export interface UpdateSMBFileShareInput { + /** + * The Amazon Resource Name (ARN) of the SMB file share that you want to update. + */ + FileShareARN: FileShareARN; + /** + * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. + */ + KMSEncrypted?: Boolean; + /** + * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional. + */ + KMSKey?: KMSKey; + /** + * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. + */ + DefaultStorageClass?: StorageClass; + /** + * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private". + */ + ObjectACL?: ObjectACL; + /** + * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false. + */ + ReadOnly?: Boolean; + /** + * A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true. + */ + GuessMIMETypeEnabled?: Boolean; + /** + * A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration. + */ + RequesterPays?: Boolean; + /** + * Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions. + */ + SMBACLEnabled?: Boolean; + /** + * A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + AdminUserList?: FileShareUserList; + /** + * A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + ValidUserList?: FileShareUserList; + /** + * A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory. + */ + InvalidUserList?: FileShareUserList; + } + export interface UpdateSMBFileShareOutput { + /** + * The Amazon Resource Name (ARN) of the updated SMB file share. + */ + FileShareARN?: FileShareARN; + } + export interface UpdateSnapshotScheduleInput { + /** + * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. + */ + VolumeARN: VolumeARN; + /** + * The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway. + */ + StartAt: HourOfDay; + /** + * Frequency of snapshots. Specify the number of hours between snapshots. + */ + RecurrenceInHours: RecurrenceInHours; + /** + * Optional description of the snapshot that overwrites the existing description. + */ + Description?: Description; + } + export interface UpdateSnapshotScheduleOutput { + /** + * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. + */ + VolumeARN?: VolumeARN; + } + export interface UpdateVTLDeviceTypeInput { + /** + * The Amazon Resource Name (ARN) of the medium changer you want to select. + */ + VTLDeviceARN: VTLDeviceARN; + /** + * The type of medium changer you want to select. Valid Values: "STK-L700", "AWS-Gateway-VTL" + */ + DeviceType: DeviceType; + } + export interface UpdateVTLDeviceTypeOutput { + /** + * The Amazon Resource Name (ARN) of the medium changer you have selected. + */ + VTLDeviceARN?: VTLDeviceARN; + } + export interface VTLDevice { + /** + * Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer). + */ + VTLDeviceARN?: VTLDeviceARN; + /** + * Specifies the type of device that the VTL device emulates. + */ + VTLDeviceType?: VTLDeviceType; + /** + * Specifies the vendor of the device that the VTL device object emulates. + */ + VTLDeviceVendor?: VTLDeviceVendor; + /** + * Specifies the model number of device that the VTL device emulates. + */ + VTLDeviceProductIdentifier?: VTLDeviceProductIdentifier; + /** + * A list of iSCSI information about a VTL device. + */ + DeviceiSCSIAttributes?: DeviceiSCSIAttributes; + } + export type VTLDeviceARN = string; + export type VTLDeviceARNs = VTLDeviceARN[]; + export type VTLDeviceProductIdentifier = string; + export type VTLDeviceType = string; + export type VTLDeviceVendor = string; + export type VTLDevices = VTLDevice[]; + export type VolumeARN = string; + export type VolumeARNs = VolumeARN[]; + export type VolumeAttachmentStatus = string; + export type VolumeId = string; + export interface VolumeInfo { + /** + * The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN: arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). + */ + VolumeARN?: VolumeARN; + /** + * The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). + */ + VolumeId?: VolumeId; + GatewayARN?: GatewayARN; + /** + * The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). + */ + GatewayId?: GatewayId; + /** + * One of the VolumeType enumeration values describing the type of the volume. + */ + VolumeType?: VolumeType; + /** + * The size of the volume in bytes. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). + */ + VolumeSizeInBytes?: long; + /** + * One of the VolumeStatus values that indicates the state of the storage volume. + */ + VolumeAttachmentStatus?: VolumeAttachmentStatus; + } + export type VolumeInfos = VolumeInfo[]; + export interface VolumeRecoveryPointInfo { + /** + * The Amazon Resource Name (ARN) of the volume target. + */ + VolumeARN?: VolumeARN; + /** + * The size of the volume in bytes. + */ + VolumeSizeInBytes?: long; + /** + * The size of the data stored on the volume in bytes. This value is not available for volumes created prior to May 13, 2015, until you store data on the volume. + */ + VolumeUsageInBytes?: long; + /** + * The time the recovery point was taken. + */ + VolumeRecoveryPointTime?: string; + } + export type VolumeRecoveryPointInfos = VolumeRecoveryPointInfo[]; + export type VolumeStatus = string; + export type VolumeType = string; + export type VolumeUsedInBytes = number; + export interface VolumeiSCSIAttributes { + /** + * The Amazon Resource Name (ARN) of the volume target. + */ + TargetARN?: TargetARN; + /** + * The network interface identifier. + */ + NetworkInterfaceId?: NetworkInterfaceId; + /** + * The port used to communicate with iSCSI targets. + */ + NetworkInterfacePort?: integer; + /** + * The logical disk number. + */ + LunNumber?: PositiveIntObject; + /** + * Indicates whether mutual CHAP is enabled for the iSCSI target. + */ + ChapEnabled?: boolean; + } + export type double = number; + export type integer = number; + export type long = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-06-30"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the StorageGateway client. + */ + export import Types = StorageGateway; +} +export = StorageGateway; diff --git a/node_modules/aws-sdk/clients/storagegateway.js b/node_modules/aws-sdk/clients/storagegateway.js new file mode 100644 index 0000000..62168c0 --- /dev/null +++ b/node_modules/aws-sdk/clients/storagegateway.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['storagegateway'] = {}; +AWS.StorageGateway = Service.defineService('storagegateway', ['2013-06-30']); +Object.defineProperty(apiLoader.services['storagegateway'], '2013-06-30', { + get: function get() { + var model = require('../apis/storagegateway-2013-06-30.min.json'); + model.paginators = require('../apis/storagegateway-2013-06-30.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.StorageGateway; diff --git a/node_modules/aws-sdk/clients/sts.d.ts b/node_modules/aws-sdk/clients/sts.d.ts new file mode 100644 index 0000000..34febf5 --- /dev/null +++ b/node_modules/aws-sdk/clients/sts.d.ts @@ -0,0 +1,383 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class STS extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: STS.Types.ClientConfiguration) + config: Config & STS.Types.ClientConfiguration; + /** + * Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole for cross-account access or federation. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. You cannot use AWS account root user credentials to call AssumeRole. You must use credentials for an IAM user or an IAM role to call AssumeRole. For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles (Delegation and Federation) in the IAM User Guide. For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your network, you don't have to recreate identities in AWS in order to grant them access to AWS. Instead, after a user has been authenticated, you call AssumeRole (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL from which users can access the console. For more information, see Common Scenarios for Temporary Credentials in the IAM User Guide. By default, the temporary security credentials created by AssumeRole last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: You cannot call the AWS STS service's GetFederationToken or GetSessionToken API operations. (Optional) You can pass an IAM permissions policy to this operation. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role. The user who wants to access the role must also have permissions delegated from the role's administrator. If the user and the role are in a different account, then the user's administrator must attach a policy. That attached policy must allow the user to call AssumeRole for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following: Attach a policy to the user (identical to the previous user in a different account) Add the user as a principal directly in the role's trust policy. In this case, the trust policy acts as the only resource-based policy in IAM. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide. Using MFA with AssumeRole (Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide. To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces. + */ + assumeRole(params: STS.Types.AssumeRoleRequest, callback?: (err: AWSError, data: STS.Types.AssumeRoleResponse) => void): Request; + /** + * Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole for cross-account access or federation. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. You cannot use AWS account root user credentials to call AssumeRole. You must use credentials for an IAM user or an IAM role to call AssumeRole. For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles (Delegation and Federation) in the IAM User Guide. For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your network, you don't have to recreate identities in AWS in order to grant them access to AWS. Instead, after a user has been authenticated, you call AssumeRole (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL from which users can access the console. For more information, see Common Scenarios for Temporary Credentials in the IAM User Guide. By default, the temporary security credentials created by AssumeRole last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: You cannot call the AWS STS service's GetFederationToken or GetSessionToken API operations. (Optional) You can pass an IAM permissions policy to this operation. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role. The user who wants to access the role must also have permissions delegated from the role's administrator. If the user and the role are in a different account, then the user's administrator must attach a policy. That attached policy must allow the user to call AssumeRole for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following: Attach a policy to the user (identical to the previous user in a different account) Add the user as a principal directly in the role's trust policy. In this case, the trust policy acts as the only resource-based policy in IAM. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide. Using MFA with AssumeRole (Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide. To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces. + */ + assumeRole(callback?: (err: AWSError, data: STS.Types.AssumeRoleResponse) => void): Request; + /** + * Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken API operations. Optionally, you can pass an IAM permissions policy to this operation. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy. Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). For more information, see the following resources: About SAML 2.0-based Federation in the IAM User Guide. Creating SAML Identity Providers in the IAM User Guide. Configuring a Relying Party and Claims in the IAM User Guide. Creating a Role for SAML 2.0 Federation in the IAM User Guide. + */ + assumeRoleWithSAML(params: STS.Types.AssumeRoleWithSAMLRequest, callback?: (err: AWSError, data: STS.Types.AssumeRoleWithSAMLResponse) => void): Request; + /** + * Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken API operations. Optionally, you can pass an IAM permissions policy to this operation. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy. Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). For more information, see the following resources: About SAML 2.0-based Federation in the IAM User Guide. Creating SAML Identity Providers in the IAM User Guide. Configuring a Relying Party and Claims in the IAM User Guide. Creating a Role for SAML 2.0 Federation in the IAM User Guide. + */ + assumeRoleWithSAML(callback?: (err: AWSError, data: STS.Types.AssumeRoleWithSAMLResponse) => void): Request; + /** + * Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application. To learn more about Amazon Cognito, see Amazon Cognito Overview in the AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide. Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application. You also don't need to deploy server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service API operations. By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken API operations. (Optional) You can pass an IAM permissions policy to this operation. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification. For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources: Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider. Web Identity Federation Playground. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. AWS SDK for iOS Developer Guide and AWS SDK for Android Developer Guide. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. + */ + assumeRoleWithWebIdentity(params: STS.Types.AssumeRoleWithWebIdentityRequest, callback?: (err: AWSError, data: STS.Types.AssumeRoleWithWebIdentityResponse) => void): Request; + /** + * Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application. To learn more about Amazon Cognito, see Amazon Cognito Overview in the AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide. Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application. You also don't need to deploy server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service API operations. By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken API operations. (Optional) You can pass an IAM permissions policy to this operation. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification. For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources: Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider. Web Identity Federation Playground. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. AWS SDK for iOS Developer Guide and AWS SDK for Android Developer Guide. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. + */ + assumeRoleWithWebIdentity(callback?: (err: AWSError, data: STS.Types.AssumeRoleWithWebIdentityResponse) => void): Request; + /** + * Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure. Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code. The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action. The decoded message includes the following type of information: Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide. The principal who made the request. The requested action. The requested resource. The values of condition keys in the context of the user's request. + */ + decodeAuthorizationMessage(params: STS.Types.DecodeAuthorizationMessageRequest, callback?: (err: AWSError, data: STS.Types.DecodeAuthorizationMessageResponse) => void): Request; + /** + * Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure. Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code. The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action. The decoded message includes the following type of information: Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide. The principal who made the request. The requested action. The requested resource. The values of condition keys in the context of the user's request. + */ + decodeAuthorizationMessage(callback?: (err: AWSError, data: STS.Types.DecodeAuthorizationMessageResponse) => void): Request; + /** + * Returns details about the IAM identity whose credentials are used to call the API. + */ + getCallerIdentity(params: STS.Types.GetCallerIdentityRequest, callback?: (err: AWSError, data: STS.Types.GetCallerIdentityResponse) => void): Request; + /** + * Returns details about the IAM identity whose credentials are used to call the API. + */ + getCallerIdentity(callback?: (err: AWSError, data: STS.Types.GetCallerIdentityResponse) => void): Request; + /** + * Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider. You can also call GetFederationToken using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide. The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour). The temporary security credentials created by GetFederationToken can be used to make API calls to any AWS service with the following exceptions: You cannot use these credentials to call any IAM API operations. You cannot call any STS API operations except GetCallerIdentity. Permissions You must pass an IAM permissions policy to GetFederationToken. When you pass a policy to this operation, the resulting temporary credentials are defined by the intersection of your IAM user policies and the passed policy . The passed policy defines the permissions of the federated user. AWS allows the federated user's request only when both the attached policy and the IAM user policy explicitly allow the federated user to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. For more information about how permissions work, see Permissions for GetFederationToken. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker. + */ + getFederationToken(params: STS.Types.GetFederationTokenRequest, callback?: (err: AWSError, data: STS.Types.GetFederationTokenResponse) => void): Request; + /** + * Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider. You can also call GetFederationToken using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide. The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour). The temporary security credentials created by GetFederationToken can be used to make API calls to any AWS service with the following exceptions: You cannot use these credentials to call any IAM API operations. You cannot call any STS API operations except GetCallerIdentity. Permissions You must pass an IAM permissions policy to GetFederationToken. When you pass a policy to this operation, the resulting temporary credentials are defined by the intersection of your IAM user policies and the passed policy . The passed policy defines the permissions of the federated user. AWS allows the federated user's request only when both the attached policy and the IAM user policy explicitly allow the federated user to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. For more information about how permissions work, see Permissions for GetFederationToken. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker. + */ + getFederationToken(callback?: (err: AWSError, data: STS.Types.GetFederationTokenResponse) => void): Request; + /** + * Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to API operations that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. The GetSessionToken operation must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3,600 seconds (1 hour), with a default of 1 hour. The temporary security credentials created by GetSessionToken can be used to make API calls to any AWS service with the following exceptions: You cannot call any IAM API operations unless MFA authentication information is included in the request. You cannot call any STS API except AssumeRole or GetCallerIdentity. We recommend that you do not call GetSessionToken with AWS account root user credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. The permissions associated with the temporary security credentials returned by GetSessionToken are based on the permissions associated with account or IAM user whose credentials are used to call the operation. If GetSessionToken is called using AWS account root user credentials, the temporary credentials have root user permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide. + */ + getSessionToken(params: STS.Types.GetSessionTokenRequest, callback?: (err: AWSError, data: STS.Types.GetSessionTokenResponse) => void): Request; + /** + * Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to API operations that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide. The GetSessionToken operation must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3,600 seconds (1 hour), with a default of 1 hour. The temporary security credentials created by GetSessionToken can be used to make API calls to any AWS service with the following exceptions: You cannot call any IAM API operations unless MFA authentication information is included in the request. You cannot call any STS API except AssumeRole or GetCallerIdentity. We recommend that you do not call GetSessionToken with AWS account root user credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. The permissions associated with the temporary security credentials returned by GetSessionToken are based on the permissions associated with account or IAM user whose credentials are used to call the operation. If GetSessionToken is called using AWS account root user credentials, the temporary credentials have root user permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide. + */ + getSessionToken(callback?: (err: AWSError, data: STS.Types.GetSessionTokenResponse) => void): Request; +} +declare namespace STS { + export interface AssumeRoleRequest { + /** + * The Amazon Resource Name (ARN) of the role to assume. + */ + RoleArn: arnType; + /** + * An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- + */ + RoleSessionName: roleSessionNameType; + /** + * An IAM policy in JSON format. This parameter is optional. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plaintext must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, where 100 percent is the maximum allowed size. + */ + Policy?: sessionPolicyDocumentType; + /** + * The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. By default, the value is set to 3600 seconds. The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide. + */ + DurationSeconds?: roleDurationSecondsType; + /** + * A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. Because a cross-account role is usually set up to trust everyone in an account, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- + */ + ExternalId?: externalIdType; + /** + * The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- + */ + SerialNumber?: serialNumberType; + /** + * The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an "access denied" error. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. + */ + TokenCode?: tokenCodeType; + } + export interface AssumeRoleResponse { + /** + * The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. + */ + Credentials?: Credentials; + /** + * The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole. + */ + AssumedRoleUser?: AssumedRoleUser; + /** + * A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space. + */ + PackedPolicySize?: nonNegativeIntegerType; + } + export interface AssumeRoleWithSAMLRequest { + /** + * The Amazon Resource Name (ARN) of the role that the caller is assuming. + */ + RoleArn: arnType; + /** + * The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. + */ + PrincipalArn: arnType; + /** + * The base-64 encoded SAML authentication response provided by the IdP. For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide. + */ + SAMLAssertion: SAMLAssertionType; + /** + * An IAM policy in JSON format. The policy parameter is optional. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plaintext must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, where 100 percent is the maximum allowed size. + */ + Policy?: sessionPolicyDocumentType; + /** + * The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. By default, the value is set to 3600 seconds. The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide. + */ + DurationSeconds?: roleDurationSecondsType; + } + export interface AssumeRoleWithSAMLResponse { + /** + * The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. + */ + Credentials?: Credentials; + /** + * The identifiers for the temporary security credentials that the operation returns. + */ + AssumedRoleUser?: AssumedRoleUser; + /** + * A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space. + */ + PackedPolicySize?: nonNegativeIntegerType; + /** + * The value of the NameID element in the Subject element of the SAML assertion. + */ + Subject?: Subject; + /** + * The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent. If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications. + */ + SubjectType?: SubjectType; + /** + * The value of the Issuer element of the SAML assertion. + */ + Issuer?: Issuer; + /** + * The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion. + */ + Audience?: Audience; + /** + * A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user. The following pseudocode shows how the hash value is calculated: BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) ) + */ + NameQualifier?: NameQualifier; + } + export interface AssumeRoleWithWebIdentityRequest { + /** + * The Amazon Resource Name (ARN) of the role that the caller is assuming. + */ + RoleArn: arnType; + /** + * An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- + */ + RoleSessionName: roleSessionNameType; + /** + * The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call. + */ + WebIdentityToken: clientTokenType; + /** + * The fully qualified host component of the domain name of the identity provider. Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers. Do not specify this value for OpenID Connect ID tokens. + */ + ProviderId?: urlType; + /** + * An IAM policy in JSON format. The policy parameter is optional. If you pass a policy to this operation, the resulting temporary credentials have the permissions of the assumed role and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the permissions policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plaintext must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, where 100 percent is the maximum allowed size. + */ + Policy?: sessionPolicyDocumentType; + /** + * The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. By default, the value is set to 3600 seconds. The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide. + */ + DurationSeconds?: roleDurationSecondsType; + } + export interface AssumeRoleWithWebIdentityResponse { + /** + * The temporary security credentials, which include an access key ID, a secret access key, and a security token. The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. + */ + Credentials?: Credentials; + /** + * The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim. + */ + SubjectFromWebIdentityToken?: webIdentitySubjectType; + /** + * The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole. + */ + AssumedRoleUser?: AssumedRoleUser; + /** + * A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space. + */ + PackedPolicySize?: nonNegativeIntegerType; + /** + * The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request. + */ + Provider?: Issuer; + /** + * The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token. + */ + Audience?: Audience; + } + export interface AssumedRoleUser { + /** + * A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created. + */ + AssumedRoleId: assumedRoleIdType; + /** + * The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM. + */ + Arn: arnType; + } + export type Audience = string; + export interface Credentials { + /** + * The access key ID that identifies the temporary security credentials. + */ + AccessKeyId: accessKeyIdType; + /** + * The secret access key that can be used to sign requests. + */ + SecretAccessKey: accessKeySecretType; + /** + * The token that users must pass to the service API to use the temporary credentials. + */ + SessionToken: tokenType; + /** + * The date on which the current credentials expire. + */ + Expiration: dateType; + } + export interface DecodeAuthorizationMessageRequest { + /** + * The encoded message that was returned with the response. + */ + EncodedMessage: encodedMessageType; + } + export interface DecodeAuthorizationMessageResponse { + /** + * An XML document that contains the decoded message. + */ + DecodedMessage?: decodedMessageType; + } + export interface FederatedUser { + /** + * The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user. + */ + FederatedUserId: federatedIdType; + /** + * The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM. + */ + Arn: arnType; + } + export interface GetCallerIdentityRequest { + } + export interface GetCallerIdentityResponse { + /** + * The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the IAM User Guide. + */ + UserId?: userIdType; + /** + * The AWS account ID number of the account that owns or contains the calling entity. + */ + Account?: accountType; + /** + * The AWS ARN associated with the calling entity. + */ + Arn?: arnType; + } + export interface GetFederationTokenRequest { + /** + * The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- + */ + Name: userNameType; + /** + * An IAM policy in JSON format. You must pass an IAM permissions policy to GetFederationToken. When you pass a policy to this operation, the resulting temporary credentials are defined by the intersection of your IAM user policies and the policy that you pass. The passed policy defines the permissions of the federated user. AWS allows the federated user's request only when both the attached policy and the IAM user policy explicitly allow the federated user to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plaintext must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, where 100 percent is the maximum allowed size. For more information about how permissions work, see Permissions for GetFederationToken. + */ + Policy?: sessionPolicyDocumentType; + /** + * The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour. + */ + DurationSeconds?: durationSecondsType; + } + export interface GetFederationTokenResponse { + /** + * The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. + */ + Credentials?: Credentials; + /** + * Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy. + */ + FederatedUser?: FederatedUser; + /** + * A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value. + */ + PackedPolicySize?: nonNegativeIntegerType; + } + export interface GetSessionTokenRequest { + /** + * The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. + */ + DurationSeconds?: durationSecondsType; + /** + * The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- + */ + SerialNumber?: serialNumberType; + /** + * The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. + */ + TokenCode?: tokenCodeType; + } + export interface GetSessionTokenResponse { + /** + * The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. + */ + Credentials?: Credentials; + } + export type Issuer = string; + export type NameQualifier = string; + export type SAMLAssertionType = string; + export type Subject = string; + export type SubjectType = string; + export type accessKeyIdType = string; + export type accessKeySecretType = string; + export type accountType = string; + export type arnType = string; + export type assumedRoleIdType = string; + export type clientTokenType = string; + export type dateType = Date; + export type decodedMessageType = string; + export type durationSecondsType = number; + export type encodedMessageType = string; + export type externalIdType = string; + export type federatedIdType = string; + export type nonNegativeIntegerType = number; + export type roleDurationSecondsType = number; + export type roleSessionNameType = string; + export type serialNumberType = string; + export type sessionPolicyDocumentType = string; + export type tokenCodeType = string; + export type tokenType = string; + export type urlType = string; + export type userIdType = string; + export type userNameType = string; + export type webIdentitySubjectType = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2011-06-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the STS client. + */ + export import Types = STS; +} +export = STS; diff --git a/node_modules/aws-sdk/clients/sts.js b/node_modules/aws-sdk/clients/sts.js new file mode 100644 index 0000000..b1d9cd7 --- /dev/null +++ b/node_modules/aws-sdk/clients/sts.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['sts'] = {}; +AWS.STS = Service.defineService('sts', ['2011-06-15']); +require('../lib/services/sts'); +Object.defineProperty(apiLoader.services['sts'], '2011-06-15', { + get: function get() { + var model = require('../apis/sts-2011-06-15.min.json'); + model.paginators = require('../apis/sts-2011-06-15.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.STS; diff --git a/node_modules/aws-sdk/clients/support.d.ts b/node_modules/aws-sdk/clients/support.d.ts new file mode 100644 index 0000000..08ce0dd --- /dev/null +++ b/node_modules/aws-sdk/clients/support.d.ts @@ -0,0 +1,755 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Support extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Support.Types.ClientConfiguration) + config: Config & Support.Types.ClientConfiguration; + /** + * Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. + */ + addAttachmentsToSet(params: Support.Types.AddAttachmentsToSetRequest, callback?: (err: AWSError, data: Support.Types.AddAttachmentsToSetResponse) => void): Request; + /** + * Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. + */ + addAttachmentsToSet(callback?: (err: AWSError, data: Support.Types.AddAttachmentsToSetResponse) => void): Request; + /** + * Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication. The response indicates the success or failure of the request. This operation implements a subset of the features of the AWS Support Center. + */ + addCommunicationToCase(params: Support.Types.AddCommunicationToCaseRequest, callback?: (err: AWSError, data: Support.Types.AddCommunicationToCaseResponse) => void): Request; + /** + * Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication. The response indicates the success or failure of the request. This operation implements a subset of the features of the AWS Support Center. + */ + addCommunicationToCase(callback?: (err: AWSError, data: Support.Types.AddCommunicationToCaseResponse) => void): Request; + /** + * Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information: issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices. categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes. severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels. subject. The Subject field on the AWS Support Center Create Case page. communicationBody. The Description field on the AWS Support Center Create Case page. attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet. language. The human language in which AWS Support handles the case. English and Japanese are currently supported. ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK. To add additional communication or attachments to an existing case, use AddCommunicationToCase. A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases. + */ + createCase(params: Support.Types.CreateCaseRequest, callback?: (err: AWSError, data: Support.Types.CreateCaseResponse) => void): Request; + /** + * Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information: issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices. categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes. severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels. subject. The Subject field on the AWS Support Center Create Case page. communicationBody. The Description field on the AWS Support Center Create Case page. attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet. language. The human language in which AWS Support handles the case. English and Japanese are currently supported. ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK. To add additional communication or attachments to an existing case, use AddCommunicationToCase. A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases. + */ + createCase(callback?: (err: AWSError, data: Support.Types.CreateCaseResponse) => void): Request; + /** + * Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation. + */ + describeAttachment(params: Support.Types.DescribeAttachmentRequest, callback?: (err: AWSError, data: Support.Types.DescribeAttachmentResponse) => void): Request; + /** + * Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation. + */ + describeAttachment(callback?: (err: AWSError, data: Support.Types.DescribeAttachmentResponse) => void): Request; + /** + * Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. The response returns the following in JSON format: One or more CaseDetails data types. One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. + */ + describeCases(params: Support.Types.DescribeCasesRequest, callback?: (err: AWSError, data: Support.Types.DescribeCasesResponse) => void): Request; + /** + * Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. The response returns the following in JSON format: One or more CaseDetails data types. One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. + */ + describeCases(callback?: (err: AWSError, data: Support.Types.DescribeCasesResponse) => void): Request; + /** + * Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. You can use the maxResults and nextToken parameters to control the pagination of the result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination. + */ + describeCommunications(params: Support.Types.DescribeCommunicationsRequest, callback?: (err: AWSError, data: Support.Types.DescribeCommunicationsResponse) => void): Request; + /** + * Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. You can use the maxResults and nextToken parameters to control the pagination of the result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination. + */ + describeCommunications(callback?: (err: AWSError, data: Support.Types.DescribeCommunicationsResponse) => void): Request; + /** + * Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories. The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. + */ + describeServices(params: Support.Types.DescribeServicesRequest, callback?: (err: AWSError, data: Support.Types.DescribeServicesResponse) => void): Request; + /** + * Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories. The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. + */ + describeServices(callback?: (err: AWSError, data: Support.Types.DescribeServicesResponse) => void): Request; + /** + * Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request. + */ + describeSeverityLevels(params: Support.Types.DescribeSeverityLevelsRequest, callback?: (err: AWSError, data: Support.Types.DescribeSeverityLevelsResponse) => void): Request; + /** + * Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request. + */ + describeSeverityLevels(callback?: (err: AWSError, data: Support.Types.DescribeSeverityLevelsResponse) => void): Request; + /** + * Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error. + */ + describeTrustedAdvisorCheckRefreshStatuses(params: Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesResponse) => void): Request; + /** + * Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error. + */ + describeTrustedAdvisorCheckRefreshStatuses(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesResponse) => void): Request; + /** + * Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail TrustedAdvisorResourcesSummary In addition, the response contains these fields: status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". timestamp. The time of the last refresh of the check. checkId. The unique identifier for the check. + */ + describeTrustedAdvisorCheckResult(params: Support.Types.DescribeTrustedAdvisorCheckResultRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckResultResponse) => void): Request; + /** + * Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail TrustedAdvisorResourcesSummary In addition, the response contains these fields: status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". timestamp. The time of the last refresh of the check. checkId. The unique identifier for the check. + */ + describeTrustedAdvisorCheckResult(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckResultResponse) => void): Request; + /** + * Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains an array of TrustedAdvisorCheckSummary objects. + */ + describeTrustedAdvisorCheckSummaries(params: Support.Types.DescribeTrustedAdvisorCheckSummariesRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckSummariesResponse) => void): Request; + /** + * Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains an array of TrustedAdvisorCheckSummary objects. + */ + describeTrustedAdvisorCheckSummaries(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckSummariesResponse) => void): Request; + /** + * Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check. + */ + describeTrustedAdvisorChecks(params: Support.Types.DescribeTrustedAdvisorChecksRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorChecksResponse) => void): Request; + /** + * Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check. + */ + describeTrustedAdvisorChecks(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorChecksResponse) => void): Request; + /** + * Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error. The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields: status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned". millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh. checkId. The unique identifier for the check. + */ + refreshTrustedAdvisorCheck(params: Support.Types.RefreshTrustedAdvisorCheckRequest, callback?: (err: AWSError, data: Support.Types.RefreshTrustedAdvisorCheckResponse) => void): Request; + /** + * Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error. The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields: status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned". millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh. checkId. The unique identifier for the check. + */ + refreshTrustedAdvisorCheck(callback?: (err: AWSError, data: Support.Types.RefreshTrustedAdvisorCheckResponse) => void): Request; + /** + * Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed. + */ + resolveCase(params: Support.Types.ResolveCaseRequest, callback?: (err: AWSError, data: Support.Types.ResolveCaseResponse) => void): Request; + /** + * Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed. + */ + resolveCase(callback?: (err: AWSError, data: Support.Types.ResolveCaseResponse) => void): Request; +} +declare namespace Support { + export interface AddAttachmentsToSetRequest { + /** + * The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. + */ + attachmentSetId?: AttachmentSetId; + /** + * One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment. + */ + attachments: Attachments; + } + export interface AddAttachmentsToSetResponse { + /** + * The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists. + */ + attachmentSetId?: AttachmentSetId; + /** + * The time and date when the attachment set expires. + */ + expiryTime?: ExpiryTime; + } + export interface AddCommunicationToCaseRequest { + /** + * The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 + */ + caseId?: CaseId; + /** + * The body of an email communication to add to the support case. + */ + communicationBody: CommunicationBody; + /** + * The email addresses in the CC line of an email to be added to the support case. + */ + ccEmailAddresses?: CcEmailAddressList; + /** + * The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet + */ + attachmentSetId?: AttachmentSetId; + } + export interface AddCommunicationToCaseResponse { + /** + * True if AddCommunicationToCase succeeds. Otherwise, returns an error. + */ + result?: Result; + } + export type AfterTime = string; + export interface Attachment { + /** + * The name of the attachment file. + */ + fileName?: FileName; + /** + * The content of the attachment file. + */ + data?: Data; + } + export interface AttachmentDetails { + /** + * The ID of the attachment. + */ + attachmentId?: AttachmentId; + /** + * The file name of the attachment. + */ + fileName?: FileName; + } + export type AttachmentId = string; + export type AttachmentSet = AttachmentDetails[]; + export type AttachmentSetId = string; + export type Attachments = Attachment[]; + export type BeforeTime = string; + export type Boolean = boolean; + export interface CaseDetails { + /** + * The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 + */ + caseId?: CaseId; + /** + * The ID displayed for the case in the AWS Support Center. This is a numeric string. + */ + displayId?: DisplayId; + /** + * The subject line for the case in the AWS Support Center. + */ + subject?: Subject; + /** + * The status of the case. + */ + status?: Status; + /** + * The code for the AWS service returned by the call to DescribeServices. + */ + serviceCode?: ServiceCode; + /** + * The category of problem for the AWS Support case. + */ + categoryCode?: CategoryCode; + /** + * The code for the severity level returned by the call to DescribeSeverityLevels. + */ + severityCode?: SeverityCode; + /** + * The email address of the account that submitted the case. + */ + submittedBy?: SubmittedBy; + /** + * The time that the case was case created in the AWS Support Center. + */ + timeCreated?: TimeCreated; + /** + * The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications. + */ + recentCommunications?: RecentCaseCommunications; + /** + * The email addresses that receive copies of communication about the case. + */ + ccEmailAddresses?: CcEmailAddressList; + /** + * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. + */ + language?: Language; + } + export type CaseId = string; + export type CaseIdList = CaseId[]; + export type CaseList = CaseDetails[]; + export type CaseStatus = string; + export interface Category { + /** + * The category code for the support case. + */ + code?: CategoryCode; + /** + * The category name for the support case. + */ + name?: CategoryName; + } + export type CategoryCode = string; + export type CategoryList = Category[]; + export type CategoryName = string; + export type CcEmailAddress = string; + export type CcEmailAddressList = CcEmailAddress[]; + export interface Communication { + /** + * The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 + */ + caseId?: CaseId; + /** + * The text of the communication between the customer and AWS Support. + */ + body?: CommunicationBody; + /** + * The email address of the account that submitted the AWS Support case. + */ + submittedBy?: SubmittedBy; + /** + * The time the communication was created. + */ + timeCreated?: TimeCreated; + /** + * Information about the attachments to the case communication. + */ + attachmentSet?: AttachmentSet; + } + export type CommunicationBody = string; + export type CommunicationList = Communication[]; + export interface CreateCaseRequest { + /** + * The title of the AWS Support case. + */ + subject: Subject; + /** + * The code for the AWS service returned by the call to DescribeServices. + */ + serviceCode?: ServiceCode; + /** + * The code for the severity level returned by the call to DescribeSeverityLevels. The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time. + */ + severityCode?: SeverityCode; + /** + * The category of problem for the AWS Support case. + */ + categoryCode?: CategoryCode; + /** + * The communication body text when you create an AWS Support case by calling CreateCase. + */ + communicationBody: CommunicationBody; + /** + * A list of email addresses that AWS Support copies on case correspondence. + */ + ccEmailAddresses?: CcEmailAddressList; + /** + * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. + */ + language?: Language; + /** + * The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." + */ + issueType?: IssueType; + /** + * The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet. + */ + attachmentSetId?: AttachmentSetId; + } + export interface CreateCaseResponse { + /** + * The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 + */ + caseId?: CaseId; + } + export type Data = Buffer|Uint8Array|Blob|string; + export interface DescribeAttachmentRequest { + /** + * The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation. + */ + attachmentId: AttachmentId; + } + export interface DescribeAttachmentResponse { + /** + * The attachment content and file name. + */ + attachment?: Attachment; + } + export interface DescribeCasesRequest { + /** + * A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. + */ + caseIdList?: CaseIdList; + /** + * The ID displayed for a case in the AWS Support Center user interface. + */ + displayId?: DisplayId; + /** + * The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. + */ + afterTime?: AfterTime; + /** + * The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. + */ + beforeTime?: BeforeTime; + /** + * Specifies whether resolved support cases should be included in the DescribeCases results. The default is false. + */ + includeResolvedCases?: IncludeResolvedCases; + /** + * A resumption point for pagination. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return before paginating. + */ + maxResults?: MaxResults; + /** + * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. + */ + language?: Language; + /** + * Specifies whether communications should be included in the DescribeCases results. The default is true. + */ + includeCommunications?: IncludeCommunications; + } + export interface DescribeCasesResponse { + /** + * The details for the cases that match the request. + */ + cases?: CaseList; + /** + * A resumption point for pagination. + */ + nextToken?: NextToken; + } + export interface DescribeCommunicationsRequest { + /** + * The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 + */ + caseId: CaseId; + /** + * The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. + */ + beforeTime?: BeforeTime; + /** + * The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. + */ + afterTime?: AfterTime; + /** + * A resumption point for pagination. + */ + nextToken?: NextToken; + /** + * The maximum number of results to return before paginating. + */ + maxResults?: MaxResults; + } + export interface DescribeCommunicationsResponse { + /** + * The communications for the case. + */ + communications?: CommunicationList; + /** + * A resumption point for pagination. + */ + nextToken?: NextToken; + } + export interface DescribeServicesRequest { + /** + * A JSON-formatted list of service codes available for AWS services. + */ + serviceCodeList?: ServiceCodeList; + /** + * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. + */ + language?: Language; + } + export interface DescribeServicesResponse { + /** + * A JSON-formatted list of AWS services. + */ + services?: ServiceList; + } + export interface DescribeSeverityLevelsRequest { + /** + * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. + */ + language?: Language; + } + export interface DescribeSeverityLevelsResponse { + /** + * The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS. + */ + severityLevels?: SeverityLevelsList; + } + export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest { + /** + * The IDs of the Trusted Advisor checks to get the status of. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error. + */ + checkIds: StringList; + } + export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse { + /** + * The refresh status of the specified Trusted Advisor checks. + */ + statuses: TrustedAdvisorCheckRefreshStatusList; + } + export interface DescribeTrustedAdvisorCheckResultRequest { + /** + * The unique identifier for the Trusted Advisor check. + */ + checkId: String; + /** + * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. + */ + language?: String; + } + export interface DescribeTrustedAdvisorCheckResultResponse { + /** + * The detailed results of the Trusted Advisor check. + */ + result?: TrustedAdvisorCheckResult; + } + export interface DescribeTrustedAdvisorCheckSummariesRequest { + /** + * The IDs of the Trusted Advisor checks. + */ + checkIds: StringList; + } + export interface DescribeTrustedAdvisorCheckSummariesResponse { + /** + * The summary information for the requested Trusted Advisor checks. + */ + summaries: TrustedAdvisorCheckSummaryList; + } + export interface DescribeTrustedAdvisorChecksRequest { + /** + * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. + */ + language: String; + } + export interface DescribeTrustedAdvisorChecksResponse { + /** + * Information about all available Trusted Advisor checks. + */ + checks: TrustedAdvisorCheckList; + } + export type DisplayId = string; + export type Double = number; + export type ExpiryTime = string; + export type FileName = string; + export type IncludeCommunications = boolean; + export type IncludeResolvedCases = boolean; + export type IssueType = string; + export type Language = string; + export type Long = number; + export type MaxResults = number; + export type NextToken = string; + export interface RecentCaseCommunications { + /** + * The five most recent communications associated with the case. + */ + communications?: CommunicationList; + /** + * A resumption point for pagination. + */ + nextToken?: NextToken; + } + export interface RefreshTrustedAdvisorCheckRequest { + /** + * The unique identifier for the Trusted Advisor check to refresh. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error. + */ + checkId: String; + } + export interface RefreshTrustedAdvisorCheckResponse { + /** + * The current refresh status for a check, including the amount of time until the check is eligible for refresh. + */ + status: TrustedAdvisorCheckRefreshStatus; + } + export interface ResolveCaseRequest { + /** + * The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 + */ + caseId?: CaseId; + } + export interface ResolveCaseResponse { + /** + * The status of the case when the ResolveCase request was sent. + */ + initialCaseStatus?: CaseStatus; + /** + * The status of the case after the ResolveCase request was processed. + */ + finalCaseStatus?: CaseStatus; + } + export type Result = boolean; + export interface Service { + /** + * The code for an AWS service returned by the DescribeServices response. The name element contains the corresponding friendly name. + */ + code?: ServiceCode; + /** + * The friendly name for an AWS service. The code element contains the corresponding code. + */ + name?: ServiceName; + /** + * A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase. + */ + categories?: CategoryList; + } + export type ServiceCode = string; + export type ServiceCodeList = ServiceCode[]; + export type ServiceList = Service[]; + export type ServiceName = string; + export type SeverityCode = string; + export interface SeverityLevel { + /** + * One of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in severityLevel.name. + */ + code?: SeverityLevelCode; + /** + * The name of the severity level that corresponds to the severity level code. + */ + name?: SeverityLevelName; + } + export type SeverityLevelCode = string; + export type SeverityLevelName = string; + export type SeverityLevelsList = SeverityLevel[]; + export type Status = string; + export type String = string; + export type StringList = String[]; + export type Subject = string; + export type SubmittedBy = string; + export type TimeCreated = string; + export interface TrustedAdvisorCategorySpecificSummary { + /** + * The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category. + */ + costOptimizing?: TrustedAdvisorCostOptimizingSummary; + } + export interface TrustedAdvisorCheckDescription { + /** + * The unique identifier for the Trusted Advisor check. + */ + id: String; + /** + * The display name for the Trusted Advisor check. + */ + name: String; + /** + * The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup). + */ + description: String; + /** + * The category of the Trusted Advisor check. + */ + category: String; + /** + * The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. + */ + metadata: StringList; + } + export type TrustedAdvisorCheckList = TrustedAdvisorCheckDescription[]; + export interface TrustedAdvisorCheckRefreshStatus { + /** + * The unique identifier for the Trusted Advisor check. + */ + checkId: String; + /** + * The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned". + */ + status: String; + /** + * The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh. + */ + millisUntilNextRefreshable: Long; + } + export type TrustedAdvisorCheckRefreshStatusList = TrustedAdvisorCheckRefreshStatus[]; + export interface TrustedAdvisorCheckResult { + /** + * The unique identifier for the Trusted Advisor check. + */ + checkId: String; + /** + * The time of the last refresh of the check. + */ + timestamp: String; + /** + * The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". + */ + status: String; + resourcesSummary: TrustedAdvisorResourcesSummary; + /** + * Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. + */ + categorySpecificSummary: TrustedAdvisorCategorySpecificSummary; + /** + * The details about each resource listed in the check result. + */ + flaggedResources: TrustedAdvisorResourceDetailList; + } + export interface TrustedAdvisorCheckSummary { + /** + * The unique identifier for the Trusted Advisor check. + */ + checkId: String; + /** + * The time of the last refresh of the check. + */ + timestamp: String; + /** + * The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". + */ + status: String; + /** + * Specifies whether the Trusted Advisor check has flagged resources. + */ + hasFlaggedResources?: Boolean; + resourcesSummary: TrustedAdvisorResourcesSummary; + /** + * Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. + */ + categorySpecificSummary: TrustedAdvisorCategorySpecificSummary; + } + export type TrustedAdvisorCheckSummaryList = TrustedAdvisorCheckSummary[]; + export interface TrustedAdvisorCostOptimizingSummary { + /** + * The estimated monthly savings that might be realized if the recommended actions are taken. + */ + estimatedMonthlySavings: Double; + /** + * The estimated percentage of savings that might be realized if the recommended actions are taken. + */ + estimatedPercentMonthlySavings: Double; + } + export interface TrustedAdvisorResourceDetail { + /** + * The status code for the resource identified in the Trusted Advisor check. + */ + status: String; + /** + * The AWS region in which the identified resource is located. + */ + region?: String; + /** + * The unique identifier for the identified resource. + */ + resourceId: String; + /** + * Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user. + */ + isSuppressed?: Boolean; + /** + * Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. + */ + metadata: StringList; + } + export type TrustedAdvisorResourceDetailList = TrustedAdvisorResourceDetail[]; + export interface TrustedAdvisorResourcesSummary { + /** + * The number of AWS resources that were analyzed by the Trusted Advisor check. + */ + resourcesProcessed: Long; + /** + * The number of AWS resources that were flagged (listed) by the Trusted Advisor check. + */ + resourcesFlagged: Long; + /** + * The number of AWS resources ignored by Trusted Advisor because information was unavailable. + */ + resourcesIgnored: Long; + /** + * The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user. + */ + resourcesSuppressed: Long; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2013-04-15"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Support client. + */ + export import Types = Support; +} +export = Support; diff --git a/node_modules/aws-sdk/clients/support.js b/node_modules/aws-sdk/clients/support.js new file mode 100644 index 0000000..2b032ef --- /dev/null +++ b/node_modules/aws-sdk/clients/support.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['support'] = {}; +AWS.Support = Service.defineService('support', ['2013-04-15']); +Object.defineProperty(apiLoader.services['support'], '2013-04-15', { + get: function get() { + var model = require('../apis/support-2013-04-15.min.json'); + model.paginators = require('../apis/support-2013-04-15.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Support; diff --git a/node_modules/aws-sdk/clients/swf.d.ts b/node_modules/aws-sdk/clients/swf.d.ts new file mode 100644 index 0000000..023bffa --- /dev/null +++ b/node_modules/aws-sdk/clients/swf.d.ts @@ -0,0 +1,2924 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class SWF extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: SWF.Types.ClientConfiguration) + config: Config & SWF.Types.ClientConfiguration; + /** + * Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countClosedWorkflowExecutions(params: SWF.Types.CountClosedWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request; + /** + * Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countClosedWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request; + /** + * Returns the number of open workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countOpenWorkflowExecutions(params: SWF.Types.CountOpenWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request; + /** + * Returns the number of open workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countOpenWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionCount) => void): Request; + /** + * Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countPendingActivityTasks(params: SWF.Types.CountPendingActivityTasksInput, callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request; + /** + * Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countPendingActivityTasks(callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request; + /** + * Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countPendingDecisionTasks(params: SWF.Types.CountPendingDecisionTasksInput, callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request; + /** + * Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + countPendingDecisionTasks(callback?: (err: AWSError, data: SWF.Types.PendingTaskCount) => void): Request; + /** + * Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + deprecateActivityType(params: SWF.Types.DeprecateActivityTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + deprecateActivityType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + deprecateDomain(params: SWF.Types.DeprecateDomainInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + deprecateDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + deprecateWorkflowType(params: SWF.Types.DeprecateWorkflowTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + deprecateWorkflowType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeActivityType(params: SWF.Types.DescribeActivityTypeInput, callback?: (err: AWSError, data: SWF.Types.ActivityTypeDetail) => void): Request; + /** + * Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeActivityType(callback?: (err: AWSError, data: SWF.Types.ActivityTypeDetail) => void): Request; + /** + * Returns information about the specified domain, including description and status. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeDomain(params: SWF.Types.DescribeDomainInput, callback?: (err: AWSError, data: SWF.Types.DomainDetail) => void): Request; + /** + * Returns information about the specified domain, including description and status. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeDomain(callback?: (err: AWSError, data: SWF.Types.DomainDetail) => void): Request; + /** + * Returns information about the specified workflow execution including its type and some statistics. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeWorkflowExecution(params: SWF.Types.DescribeWorkflowExecutionInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionDetail) => void): Request; + /** + * Returns information about the specified workflow execution including its type and some statistics. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeWorkflowExecution(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionDetail) => void): Request; + /** + * Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeWorkflowType(params: SWF.Types.DescribeWorkflowTypeInput, callback?: (err: AWSError, data: SWF.Types.WorkflowTypeDetail) => void): Request; + /** + * Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + describeWorkflowType(callback?: (err: AWSError, data: SWF.Types.WorkflowTypeDetail) => void): Request; + /** + * Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + getWorkflowExecutionHistory(params: SWF.Types.GetWorkflowExecutionHistoryInput, callback?: (err: AWSError, data: SWF.Types.History) => void): Request; + /** + * Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + getWorkflowExecutionHistory(callback?: (err: AWSError, data: SWF.Types.History) => void): Request; + /** + * Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listActivityTypes(params: SWF.Types.ListActivityTypesInput, callback?: (err: AWSError, data: SWF.Types.ActivityTypeInfos) => void): Request; + /** + * Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listActivityTypes(callback?: (err: AWSError, data: SWF.Types.ActivityTypeInfos) => void): Request; + /** + * Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listClosedWorkflowExecutions(params: SWF.Types.ListClosedWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request; + /** + * Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listClosedWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request; + /** + * Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listDomains(params: SWF.Types.ListDomainsInput, callback?: (err: AWSError, data: SWF.Types.DomainInfos) => void): Request; + /** + * Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listDomains(callback?: (err: AWSError, data: SWF.Types.DomainInfos) => void): Request; + /** + * Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listOpenWorkflowExecutions(params: SWF.Types.ListOpenWorkflowExecutionsInput, callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request; + /** + * Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listOpenWorkflowExecutions(callback?: (err: AWSError, data: SWF.Types.WorkflowExecutionInfos) => void): Request; + /** + * Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listWorkflowTypes(params: SWF.Types.ListWorkflowTypesInput, callback?: (err: AWSError, data: SWF.Types.WorkflowTypeInfos) => void): Request; + /** + * Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + listWorkflowTypes(callback?: (err: AWSError, data: SWF.Types.WorkflowTypeInfos) => void): Request; + /** + * Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly. Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request). Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + pollForActivityTask(params: SWF.Types.PollForActivityTaskInput, callback?: (err: AWSError, data: SWF.Types.ActivityTask) => void): Request; + /** + * Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly. Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request). Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + pollForActivityTask(callback?: (err: AWSError, data: SWF.Types.ActivityTask) => void): Request; + /** + * Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task. This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string. Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + pollForDecisionTask(params: SWF.Types.PollForDecisionTaskInput, callback?: (err: AWSError, data: SWF.Types.DecisionTask) => void): Request; + /** + * Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task. This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string. Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + pollForDecisionTask(callback?: (err: AWSError, data: SWF.Types.DecisionTask) => void): Request; + /** + * Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true. This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType. This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker. The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + recordActivityTaskHeartbeat(params: SWF.Types.RecordActivityTaskHeartbeatInput, callback?: (err: AWSError, data: SWF.Types.ActivityTaskStatus) => void): Request; + /** + * Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true. This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType. This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker. The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + recordActivityTaskHeartbeat(callback?: (err: AWSError, data: SWF.Types.ActivityTaskStatus) => void): Request; + /** + * Registers a new activity type along with its configuration settings in the specified domain. A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + registerActivityType(params: SWF.Types.RegisterActivityTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers a new activity type along with its configuration settings in the specified domain. A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + registerActivityType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers a new domain. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + registerDomain(params: SWF.Types.RegisterDomainInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers a new domain. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + registerDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers a new workflow type and its configuration settings in the specified domain. The retention period for the workflow history is set by the RegisterDomain action. If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + registerWorkflowType(params: SWF.Types.RegisterWorkflowTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Registers a new workflow type and its configuration settings in the specified domain. The retention period for the workflow history is set by the RegisterDomain action. If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + registerWorkflowType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event. If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + requestCancelWorkflowExecution(params: SWF.Types.RequestCancelWorkflowExecutionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event. If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + requestCancelWorkflowExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument. These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history. Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondActivityTaskCanceled(params: SWF.Types.RespondActivityTaskCanceledInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument. These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history. Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondActivityTaskCanceled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history. If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondActivityTaskCompleted(params: SWF.Types.RespondActivityTaskCompletedInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history. If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondActivityTaskCompleted(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondActivityTaskFailed(params: SWF.Types.RespondActivityTaskFailedInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondActivityTaskFailed(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task. A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history. Access Control If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondDecisionTaskCompleted(params: SWF.Types.RespondDecisionTaskCompletedInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task. A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history. Access Control If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + respondDecisionTaskCompleted(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution isn't open, this method fails with UnknownResource. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + signalWorkflowExecution(params: SWF.Types.SignalWorkflowExecutionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution isn't open, this method fails with UnknownResource. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + signalWorkflowExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Starts an execution of the workflow type in the specified domain using the provided workflowId and input data. This action returns the newly started workflow execution. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0. tagList.member.1: The key is swf:tagList.member.1. tagList.member.2: The key is swf:tagList.member.2. tagList.member.3: The key is swf:tagList.member.3. tagList.member.4: The key is swf:tagList.member.4. taskList: String constraint. The key is swf:taskList.name. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + startWorkflowExecution(params: SWF.Types.StartWorkflowExecutionInput, callback?: (err: AWSError, data: SWF.Types.Run) => void): Request; + /** + * Starts an execution of the workflow type in the specified domain using the provided workflowId and input data. This action returns the newly started workflow execution. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0. tagList.member.1: The key is swf:tagList.member.1. tagList.member.2: The key is swf:tagList.member.2. tagList.member.3: The key is swf:tagList.member.3. tagList.member.4: The key is swf:tagList.member.4. taskList: String constraint. The key is swf:taskList.name. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + startWorkflowExecution(callback?: (err: AWSError, data: SWF.Types.Run) => void): Request; + /** + * Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution. If the identified workflow execution was in progress, it is terminated immediately. If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + terminateWorkflowExecution(params: SWF.Types.TerminateWorkflowExecutionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution. If the identified workflow execution was in progress, it is terminated immediately. If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + terminateWorkflowExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; +} +declare namespace SWF { + export type ActivityId = string; + export interface ActivityTask { + /** + * The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task. + */ + taskToken: TaskToken; + /** + * The unique ID of the task. + */ + activityId: ActivityId; + /** + * The ID of the ActivityTaskStarted event recorded in the history. + */ + startedEventId: EventId; + /** + * The workflow execution that started this activity task. + */ + workflowExecution: WorkflowExecution; + /** + * The type of this activity task. + */ + activityType: ActivityType; + /** + * The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation. + */ + input?: Data; + } + export interface ActivityTaskCancelRequestedEventAttributes { + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + /** + * The unique ID of the task. + */ + activityId: ActivityId; + } + export interface ActivityTaskCanceledEventAttributes { + /** + * Details of the cancellation. + */ + details?: Data; + /** + * The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + /** + * If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + latestCancelRequestedEventId?: EventId; + } + export interface ActivityTaskCompletedEventAttributes { + /** + * The results of the activity task. + */ + result?: Data; + /** + * The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export interface ActivityTaskFailedEventAttributes { + /** + * The reason provided for the failure. + */ + reason?: FailureReason; + /** + * The details of the failure. + */ + details?: Data; + /** + * The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export interface ActivityTaskScheduledEventAttributes { + /** + * The type of the activity task. + */ + activityType: ActivityType; + /** + * The unique ID of the activity task. + */ + activityId: ActivityId; + /** + * The input provided to the activity task. + */ + input?: Data; + /** + * Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity. + */ + control?: Data; + /** + * The maximum amount of time the activity task can wait to be assigned to a worker. + */ + scheduleToStartTimeout?: DurationInSecondsOptional; + /** + * The maximum amount of time for this activity task. + */ + scheduleToCloseTimeout?: DurationInSecondsOptional; + /** + * The maximum amount of time a worker may take to process the activity task. + */ + startToCloseTimeout?: DurationInSecondsOptional; + /** + * The task list in which the activity task has been scheduled. + */ + taskList: TaskList; + /** + * The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + /** + * The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored. + */ + heartbeatTimeout?: DurationInSecondsOptional; + } + export interface ActivityTaskStartedEventAttributes { + /** + * Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined. + */ + identity?: Identity; + /** + * The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + } + export interface ActivityTaskStatus { + /** + * Set to true if cancellation of the task is requested. + */ + cancelRequested: Canceled; + } + export interface ActivityTaskTimedOutEventAttributes { + /** + * The type of the timeout that caused this event. + */ + timeoutType: ActivityTaskTimeoutType; + /** + * The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + /** + * Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat. + */ + details?: LimitedData; + } + export type ActivityTaskTimeoutType = "START_TO_CLOSE"|"SCHEDULE_TO_START"|"SCHEDULE_TO_CLOSE"|"HEARTBEAT"|string; + export interface ActivityType { + /** + * The name of this activity. The combination of activity type name and version must be unique within a domain. + */ + name: Name; + /** + * The version of this activity. The combination of activity type name and version must be unique with in a domain. + */ + version: Version; + } + export interface ActivityTypeConfiguration { + /** + * The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat. You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskHeartbeatTimeout?: DurationInSecondsOptional; + /** + * The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision. + */ + defaultTaskList?: TaskList; + /** + * The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + defaultTaskPriority?: TaskPriority; + /** + * The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskScheduleToStartTimeout?: DurationInSecondsOptional; + /** + * The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskScheduleToCloseTimeout?: DurationInSecondsOptional; + } + export interface ActivityTypeDetail { + /** + * General information about the activity type. The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following. REGISTERED – The type is registered and available. Workers supporting this type should be running. DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type. + */ + typeInfo: ActivityTypeInfo; + /** + * The configuration settings registered with the activity type. + */ + configuration: ActivityTypeConfiguration; + } + export interface ActivityTypeInfo { + /** + * The ActivityType type structure representing the activity type. + */ + activityType: ActivityType; + /** + * The current status of the activity type. + */ + status: RegistrationStatus; + /** + * The description of the activity type provided in RegisterActivityType. + */ + description?: Description; + /** + * The date and time this activity type was created through RegisterActivityType. + */ + creationDate: Timestamp; + /** + * If DEPRECATED, the date and time DeprecateActivityType was called. + */ + deprecationDate?: Timestamp; + } + export type ActivityTypeInfoList = ActivityTypeInfo[]; + export interface ActivityTypeInfos { + /** + * List of activity type information. + */ + typeInfos: ActivityTypeInfoList; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + } + export type Arn = string; + export interface CancelTimerDecisionAttributes { + /** + * The unique ID of the timer to cancel. + */ + timerId: TimerId; + } + export type CancelTimerFailedCause = "TIMER_ID_UNKNOWN"|"OPERATION_NOT_PERMITTED"|string; + export interface CancelTimerFailedEventAttributes { + /** + * The timerId provided in the CancelTimer decision that failed. + */ + timerId: TimerId; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: CancelTimerFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface CancelWorkflowExecutionDecisionAttributes { + /** + * Details of the cancellation. + */ + details?: Data; + } + export type CancelWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"OPERATION_NOT_PERMITTED"|string; + export interface CancelWorkflowExecutionFailedEventAttributes { + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: CancelWorkflowExecutionFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export type Canceled = boolean; + export type CauseMessage = string; + export type ChildPolicy = "TERMINATE"|"REQUEST_CANCEL"|"ABANDON"|string; + export interface ChildWorkflowExecutionCanceledEventAttributes { + /** + * The child workflow execution that was canceled. + */ + workflowExecution: WorkflowExecution; + /** + * The type of the child workflow execution. + */ + workflowType: WorkflowType; + /** + * Details of the cancellation (if provided). + */ + details?: Data; + /** + * The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + /** + * The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export interface ChildWorkflowExecutionCompletedEventAttributes { + /** + * The child workflow execution that was completed. + */ + workflowExecution: WorkflowExecution; + /** + * The type of the child workflow execution. + */ + workflowType: WorkflowType; + /** + * The result of the child workflow execution. + */ + result?: Data; + /** + * The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + /** + * The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export interface ChildWorkflowExecutionFailedEventAttributes { + /** + * The child workflow execution that failed. + */ + workflowExecution: WorkflowExecution; + /** + * The type of the child workflow execution. + */ + workflowType: WorkflowType; + /** + * The reason for the failure (if provided). + */ + reason?: FailureReason; + /** + * The details of the failure (if provided). + */ + details?: Data; + /** + * The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + /** + * The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export interface ChildWorkflowExecutionStartedEventAttributes { + /** + * The child workflow execution that was started. + */ + workflowExecution: WorkflowExecution; + /** + * The type of the child workflow execution. + */ + workflowType: WorkflowType; + /** + * The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + } + export interface ChildWorkflowExecutionTerminatedEventAttributes { + /** + * The child workflow execution that was terminated. + */ + workflowExecution: WorkflowExecution; + /** + * The type of the child workflow execution. + */ + workflowType: WorkflowType; + /** + * The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + /** + * The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export interface ChildWorkflowExecutionTimedOutEventAttributes { + /** + * The child workflow execution that timed out. + */ + workflowExecution: WorkflowExecution; + /** + * The type of the child workflow execution. + */ + workflowType: WorkflowType; + /** + * The type of the timeout that caused the child workflow execution to time out. + */ + timeoutType: WorkflowExecutionTimeoutType; + /** + * The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + /** + * The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export type CloseStatus = "COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"|string; + export interface CloseStatusFilter { + /** + * The close status that must match the close status of an execution for it to meet the criteria of this filter. + */ + status: CloseStatus; + } + export interface CompleteWorkflowExecutionDecisionAttributes { + /** + * The result of the workflow execution. The form of the result is implementation defined. + */ + result?: Data; + } + export type CompleteWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"OPERATION_NOT_PERMITTED"|string; + export interface CompleteWorkflowExecutionFailedEventAttributes { + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: CompleteWorkflowExecutionFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface ContinueAsNewWorkflowExecutionDecisionAttributes { + /** + * The input provided to the new workflow execution. + */ + input?: Data; + /** + * If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned. + */ + executionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The task list to use for the decisions of the new (continued) workflow execution. + */ + taskList?: TaskList; + /** + * The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned. + */ + taskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned. + */ + childPolicy?: ChildPolicy; + /** + * The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter. + */ + tagList?: TagList; + /** + * The version of the workflow to start. + */ + workflowTypeVersion?: Version; + /** + * The IAM role to attach to the new (continued) execution. + */ + lambdaRole?: Arn; + } + export type ContinueAsNewWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"WORKFLOW_TYPE_DEPRECATED"|"WORKFLOW_TYPE_DOES_NOT_EXIST"|"DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_TASK_LIST_UNDEFINED"|"DEFAULT_CHILD_POLICY_UNDEFINED"|"CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string; + export interface ContinueAsNewWorkflowExecutionFailedEventAttributes { + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: ContinueAsNewWorkflowExecutionFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export type Count = number; + export interface CountClosedWorkflowExecutionsInput { + /** + * The name of the domain containing the workflow executions to count. + */ + domain: DomainName; + /** + * If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both. + */ + startTimeFilter?: ExecutionTimeFilter; + /** + * If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both. + */ + closeTimeFilter?: ExecutionTimeFilter; + /** + * If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + executionFilter?: WorkflowExecutionFilter; + /** + * If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + typeFilter?: WorkflowTypeFilter; + /** + * If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + tagFilter?: TagFilter; + /** + * If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + closeStatusFilter?: CloseStatusFilter; + } + export interface CountOpenWorkflowExecutionsInput { + /** + * The name of the domain containing the workflow executions to count. + */ + domain: DomainName; + /** + * Specifies the start time criteria that workflow executions must meet in order to be counted. + */ + startTimeFilter: ExecutionTimeFilter; + /** + * Specifies the type of the workflow executions to be counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + typeFilter?: WorkflowTypeFilter; + /** + * If specified, only executions that have a tag that matches the filter are counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + tagFilter?: TagFilter; + /** + * If specified, only workflow executions matching the WorkflowId in the filter are counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + executionFilter?: WorkflowExecutionFilter; + } + export interface CountPendingActivityTasksInput { + /** + * The name of the domain that contains the task list. + */ + domain: DomainName; + /** + * The name of the task list. + */ + taskList: TaskList; + } + export interface CountPendingDecisionTasksInput { + /** + * The name of the domain that contains the task list. + */ + domain: DomainName; + /** + * The name of the task list. + */ + taskList: TaskList; + } + export type Data = string; + export interface Decision { + /** + * Specifies the type of the decision. + */ + decisionType: DecisionType; + /** + * Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types. + */ + scheduleActivityTaskDecisionAttributes?: ScheduleActivityTaskDecisionAttributes; + /** + * Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types. + */ + requestCancelActivityTaskDecisionAttributes?: RequestCancelActivityTaskDecisionAttributes; + /** + * Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types. + */ + completeWorkflowExecutionDecisionAttributes?: CompleteWorkflowExecutionDecisionAttributes; + /** + * Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types. + */ + failWorkflowExecutionDecisionAttributes?: FailWorkflowExecutionDecisionAttributes; + /** + * Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types. + */ + cancelWorkflowExecutionDecisionAttributes?: CancelWorkflowExecutionDecisionAttributes; + /** + * Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types. + */ + continueAsNewWorkflowExecutionDecisionAttributes?: ContinueAsNewWorkflowExecutionDecisionAttributes; + /** + * Provides the details of the RecordMarker decision. It isn't set for other decision types. + */ + recordMarkerDecisionAttributes?: RecordMarkerDecisionAttributes; + /** + * Provides the details of the StartTimer decision. It isn't set for other decision types. + */ + startTimerDecisionAttributes?: StartTimerDecisionAttributes; + /** + * Provides the details of the CancelTimer decision. It isn't set for other decision types. + */ + cancelTimerDecisionAttributes?: CancelTimerDecisionAttributes; + /** + * Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types. + */ + signalExternalWorkflowExecutionDecisionAttributes?: SignalExternalWorkflowExecutionDecisionAttributes; + /** + * Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types. + */ + requestCancelExternalWorkflowExecutionDecisionAttributes?: RequestCancelExternalWorkflowExecutionDecisionAttributes; + /** + * Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types. + */ + startChildWorkflowExecutionDecisionAttributes?: StartChildWorkflowExecutionDecisionAttributes; + /** + * Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types. + */ + scheduleLambdaFunctionDecisionAttributes?: ScheduleLambdaFunctionDecisionAttributes; + } + export type DecisionList = Decision[]; + export interface DecisionTask { + /** + * The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task. + */ + taskToken: TaskToken; + /** + * The ID of the DecisionTaskStarted event recorded in the history. + */ + startedEventId: EventId; + /** + * The workflow execution for which this decision task was created. + */ + workflowExecution: WorkflowExecution; + /** + * The type of the workflow execution for which this decision task was created. + */ + workflowType: WorkflowType; + /** + * A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task. + */ + events: HistoryEventList; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + /** + * The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider. + */ + previousStartedEventId?: EventId; + } + export interface DecisionTaskCompletedEventAttributes { + /** + * User defined context for the workflow execution. + */ + executionContext?: Data; + /** + * The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export interface DecisionTaskScheduledEventAttributes { + /** + * The name of the task list in which the decision task was scheduled. + */ + taskList: TaskList; + /** + * A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + startToCloseTimeout?: DurationInSecondsOptional; + } + export interface DecisionTaskStartedEventAttributes { + /** + * Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined. + */ + identity?: Identity; + /** + * The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + } + export interface DecisionTaskTimedOutEventAttributes { + /** + * The type of timeout that expired before the decision task could be completed. + */ + timeoutType: DecisionTaskTimeoutType; + /** + * The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export type DecisionTaskTimeoutType = "START_TO_CLOSE"|string; + export type DecisionType = "ScheduleActivityTask"|"RequestCancelActivityTask"|"CompleteWorkflowExecution"|"FailWorkflowExecution"|"CancelWorkflowExecution"|"ContinueAsNewWorkflowExecution"|"RecordMarker"|"StartTimer"|"CancelTimer"|"SignalExternalWorkflowExecution"|"RequestCancelExternalWorkflowExecution"|"StartChildWorkflowExecution"|"ScheduleLambdaFunction"|string; + export interface DeprecateActivityTypeInput { + /** + * The name of the domain in which the activity type is registered. + */ + domain: DomainName; + /** + * The activity type to deprecate. + */ + activityType: ActivityType; + } + export interface DeprecateDomainInput { + /** + * The name of the domain to deprecate. + */ + name: DomainName; + } + export interface DeprecateWorkflowTypeInput { + /** + * The name of the domain in which the workflow type is registered. + */ + domain: DomainName; + /** + * The workflow type to deprecate. + */ + workflowType: WorkflowType; + } + export interface DescribeActivityTypeInput { + /** + * The name of the domain in which the activity type is registered. + */ + domain: DomainName; + /** + * The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered. + */ + activityType: ActivityType; + } + export interface DescribeDomainInput { + /** + * The name of the domain to describe. + */ + name: DomainName; + } + export interface DescribeWorkflowExecutionInput { + /** + * The name of the domain containing the workflow execution. + */ + domain: DomainName; + /** + * The workflow execution to describe. + */ + execution: WorkflowExecution; + } + export interface DescribeWorkflowTypeInput { + /** + * The name of the domain in which this workflow type is registered. + */ + domain: DomainName; + /** + * The workflow type to describe. + */ + workflowType: WorkflowType; + } + export type Description = string; + export interface DomainConfiguration { + /** + * The retention period for workflow executions in this domain. + */ + workflowExecutionRetentionPeriodInDays: DurationInDays; + } + export interface DomainDetail { + /** + * The basic information about a domain, such as its name, status, and description. + */ + domainInfo: DomainInfo; + /** + * The domain configuration. Currently, this includes only the domain's retention period. + */ + configuration: DomainConfiguration; + } + export interface DomainInfo { + /** + * The name of the domain. This name is unique within the account. + */ + name: DomainName; + /** + * The status of the domain: REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions. DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain. + */ + status: RegistrationStatus; + /** + * The description of the domain provided through RegisterDomain. + */ + description?: Description; + } + export type DomainInfoList = DomainInfo[]; + export interface DomainInfos { + /** + * A list of DomainInfo structures. + */ + domainInfos: DomainInfoList; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + } + export type DomainName = string; + export type DurationInDays = string; + export type DurationInSeconds = string; + export type DurationInSecondsOptional = string; + export type EventId = number; + export type EventType = "WorkflowExecutionStarted"|"WorkflowExecutionCancelRequested"|"WorkflowExecutionCompleted"|"CompleteWorkflowExecutionFailed"|"WorkflowExecutionFailed"|"FailWorkflowExecutionFailed"|"WorkflowExecutionTimedOut"|"WorkflowExecutionCanceled"|"CancelWorkflowExecutionFailed"|"WorkflowExecutionContinuedAsNew"|"ContinueAsNewWorkflowExecutionFailed"|"WorkflowExecutionTerminated"|"DecisionTaskScheduled"|"DecisionTaskStarted"|"DecisionTaskCompleted"|"DecisionTaskTimedOut"|"ActivityTaskScheduled"|"ScheduleActivityTaskFailed"|"ActivityTaskStarted"|"ActivityTaskCompleted"|"ActivityTaskFailed"|"ActivityTaskTimedOut"|"ActivityTaskCanceled"|"ActivityTaskCancelRequested"|"RequestCancelActivityTaskFailed"|"WorkflowExecutionSignaled"|"MarkerRecorded"|"RecordMarkerFailed"|"TimerStarted"|"StartTimerFailed"|"TimerFired"|"TimerCanceled"|"CancelTimerFailed"|"StartChildWorkflowExecutionInitiated"|"StartChildWorkflowExecutionFailed"|"ChildWorkflowExecutionStarted"|"ChildWorkflowExecutionCompleted"|"ChildWorkflowExecutionFailed"|"ChildWorkflowExecutionTimedOut"|"ChildWorkflowExecutionCanceled"|"ChildWorkflowExecutionTerminated"|"SignalExternalWorkflowExecutionInitiated"|"SignalExternalWorkflowExecutionFailed"|"ExternalWorkflowExecutionSignaled"|"RequestCancelExternalWorkflowExecutionInitiated"|"RequestCancelExternalWorkflowExecutionFailed"|"ExternalWorkflowExecutionCancelRequested"|"LambdaFunctionScheduled"|"LambdaFunctionStarted"|"LambdaFunctionCompleted"|"LambdaFunctionFailed"|"LambdaFunctionTimedOut"|"ScheduleLambdaFunctionFailed"|"StartLambdaFunctionFailed"|string; + export type ExecutionStatus = "OPEN"|"CLOSED"|string; + export interface ExecutionTimeFilter { + /** + * Specifies the oldest start or close date and time to return. + */ + oldestDate: Timestamp; + /** + * Specifies the latest start or close date and time to return. + */ + latestDate?: Timestamp; + } + export interface ExternalWorkflowExecutionCancelRequestedEventAttributes { + /** + * The external workflow execution to which the cancellation request was delivered. + */ + workflowExecution: WorkflowExecution; + /** + * The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + } + export interface ExternalWorkflowExecutionSignaledEventAttributes { + /** + * The external workflow execution that the signal was delivered to. + */ + workflowExecution: WorkflowExecution; + /** + * The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + } + export interface FailWorkflowExecutionDecisionAttributes { + /** + * A descriptive reason for the failure that may help in diagnostics. + */ + reason?: FailureReason; + /** + * Details of the failure. + */ + details?: Data; + } + export type FailWorkflowExecutionFailedCause = "UNHANDLED_DECISION"|"OPERATION_NOT_PERMITTED"|string; + export interface FailWorkflowExecutionFailedEventAttributes { + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: FailWorkflowExecutionFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export type FailureReason = string; + export type FunctionId = string; + export type FunctionInput = string; + export type FunctionName = string; + export interface GetWorkflowExecutionHistoryInput { + /** + * The name of the domain containing the workflow execution. + */ + domain: DomainName; + /** + * Specifies the workflow execution for which to return the history. + */ + execution: WorkflowExecution; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + /** + * The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. + */ + maximumPageSize?: PageSize; + /** + * When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events. + */ + reverseOrder?: ReverseOrder; + } + export interface History { + /** + * The list of history events. + */ + events: HistoryEventList; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + } + export interface HistoryEvent { + /** + * The date and time when the event occurred. + */ + eventTimestamp: Timestamp; + /** + * The type of the history event. + */ + eventType: EventType; + /** + * The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history. + */ + eventId: EventId; + /** + * If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionStartedEventAttributes?: WorkflowExecutionStartedEventAttributes; + /** + * If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionCompletedEventAttributes?: WorkflowExecutionCompletedEventAttributes; + /** + * If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + completeWorkflowExecutionFailedEventAttributes?: CompleteWorkflowExecutionFailedEventAttributes; + /** + * If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionFailedEventAttributes?: WorkflowExecutionFailedEventAttributes; + /** + * If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + failWorkflowExecutionFailedEventAttributes?: FailWorkflowExecutionFailedEventAttributes; + /** + * If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionTimedOutEventAttributes?: WorkflowExecutionTimedOutEventAttributes; + /** + * If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionCanceledEventAttributes?: WorkflowExecutionCanceledEventAttributes; + /** + * If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + cancelWorkflowExecutionFailedEventAttributes?: CancelWorkflowExecutionFailedEventAttributes; + /** + * If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionContinuedAsNewEventAttributes?: WorkflowExecutionContinuedAsNewEventAttributes; + /** + * If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + continueAsNewWorkflowExecutionFailedEventAttributes?: ContinueAsNewWorkflowExecutionFailedEventAttributes; + /** + * If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionTerminatedEventAttributes?: WorkflowExecutionTerminatedEventAttributes; + /** + * If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionCancelRequestedEventAttributes?: WorkflowExecutionCancelRequestedEventAttributes; + /** + * If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + decisionTaskScheduledEventAttributes?: DecisionTaskScheduledEventAttributes; + /** + * If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + decisionTaskStartedEventAttributes?: DecisionTaskStartedEventAttributes; + /** + * If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + decisionTaskCompletedEventAttributes?: DecisionTaskCompletedEventAttributes; + /** + * If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + decisionTaskTimedOutEventAttributes?: DecisionTaskTimedOutEventAttributes; + /** + * If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + activityTaskScheduledEventAttributes?: ActivityTaskScheduledEventAttributes; + /** + * If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + activityTaskStartedEventAttributes?: ActivityTaskStartedEventAttributes; + /** + * If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + activityTaskCompletedEventAttributes?: ActivityTaskCompletedEventAttributes; + /** + * If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + activityTaskFailedEventAttributes?: ActivityTaskFailedEventAttributes; + /** + * If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + activityTaskTimedOutEventAttributes?: ActivityTaskTimedOutEventAttributes; + /** + * If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + activityTaskCanceledEventAttributes?: ActivityTaskCanceledEventAttributes; + /** + * If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + activityTaskCancelRequestedEventAttributes?: ActivityTaskCancelRequestedEventAttributes; + /** + * If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + workflowExecutionSignaledEventAttributes?: WorkflowExecutionSignaledEventAttributes; + /** + * If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + markerRecordedEventAttributes?: MarkerRecordedEventAttributes; + /** + * If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + recordMarkerFailedEventAttributes?: RecordMarkerFailedEventAttributes; + /** + * If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + timerStartedEventAttributes?: TimerStartedEventAttributes; + /** + * If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + timerFiredEventAttributes?: TimerFiredEventAttributes; + /** + * If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + timerCanceledEventAttributes?: TimerCanceledEventAttributes; + /** + * If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + startChildWorkflowExecutionInitiatedEventAttributes?: StartChildWorkflowExecutionInitiatedEventAttributes; + /** + * If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + childWorkflowExecutionStartedEventAttributes?: ChildWorkflowExecutionStartedEventAttributes; + /** + * If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + childWorkflowExecutionCompletedEventAttributes?: ChildWorkflowExecutionCompletedEventAttributes; + /** + * If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + childWorkflowExecutionFailedEventAttributes?: ChildWorkflowExecutionFailedEventAttributes; + /** + * If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + childWorkflowExecutionTimedOutEventAttributes?: ChildWorkflowExecutionTimedOutEventAttributes; + /** + * If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + childWorkflowExecutionCanceledEventAttributes?: ChildWorkflowExecutionCanceledEventAttributes; + /** + * If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + childWorkflowExecutionTerminatedEventAttributes?: ChildWorkflowExecutionTerminatedEventAttributes; + /** + * If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + signalExternalWorkflowExecutionInitiatedEventAttributes?: SignalExternalWorkflowExecutionInitiatedEventAttributes; + /** + * If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + externalWorkflowExecutionSignaledEventAttributes?: ExternalWorkflowExecutionSignaledEventAttributes; + /** + * If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + signalExternalWorkflowExecutionFailedEventAttributes?: SignalExternalWorkflowExecutionFailedEventAttributes; + /** + * If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + externalWorkflowExecutionCancelRequestedEventAttributes?: ExternalWorkflowExecutionCancelRequestedEventAttributes; + /** + * If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + requestCancelExternalWorkflowExecutionInitiatedEventAttributes?: RequestCancelExternalWorkflowExecutionInitiatedEventAttributes; + /** + * If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + requestCancelExternalWorkflowExecutionFailedEventAttributes?: RequestCancelExternalWorkflowExecutionFailedEventAttributes; + /** + * If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + scheduleActivityTaskFailedEventAttributes?: ScheduleActivityTaskFailedEventAttributes; + /** + * If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + requestCancelActivityTaskFailedEventAttributes?: RequestCancelActivityTaskFailedEventAttributes; + /** + * If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + startTimerFailedEventAttributes?: StartTimerFailedEventAttributes; + /** + * If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + cancelTimerFailedEventAttributes?: CancelTimerFailedEventAttributes; + /** + * If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types. + */ + startChildWorkflowExecutionFailedEventAttributes?: StartChildWorkflowExecutionFailedEventAttributes; + /** + * Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types. + */ + lambdaFunctionScheduledEventAttributes?: LambdaFunctionScheduledEventAttributes; + /** + * Provides the details of the LambdaFunctionStarted event. It isn't set for other event types. + */ + lambdaFunctionStartedEventAttributes?: LambdaFunctionStartedEventAttributes; + /** + * Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types. + */ + lambdaFunctionCompletedEventAttributes?: LambdaFunctionCompletedEventAttributes; + /** + * Provides the details of the LambdaFunctionFailed event. It isn't set for other event types. + */ + lambdaFunctionFailedEventAttributes?: LambdaFunctionFailedEventAttributes; + /** + * Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types. + */ + lambdaFunctionTimedOutEventAttributes?: LambdaFunctionTimedOutEventAttributes; + /** + * Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types. + */ + scheduleLambdaFunctionFailedEventAttributes?: ScheduleLambdaFunctionFailedEventAttributes; + /** + * Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types. + */ + startLambdaFunctionFailedEventAttributes?: StartLambdaFunctionFailedEventAttributes; + } + export type HistoryEventList = HistoryEvent[]; + export type Identity = string; + export interface LambdaFunctionCompletedEventAttributes { + /** + * The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + startedEventId: EventId; + /** + * The results of the Lambda task. + */ + result?: Data; + } + export interface LambdaFunctionFailedEventAttributes { + /** + * The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + startedEventId: EventId; + /** + * The reason provided for the failure. + */ + reason?: FailureReason; + /** + * The details of the failure. + */ + details?: Data; + } + export interface LambdaFunctionScheduledEventAttributes { + /** + * The unique ID of the Lambda task. + */ + id: FunctionId; + /** + * The name of the Lambda function. + */ + name: FunctionName; + /** + * Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task. + */ + control?: Data; + /** + * The input provided to the Lambda task. + */ + input?: FunctionInput; + /** + * The maximum amount of time a worker can take to process the Lambda task. + */ + startToCloseTimeout?: DurationInSecondsOptional; + /** + * The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface LambdaFunctionStartedEventAttributes { + /** + * The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + } + export interface LambdaFunctionTimedOutEventAttributes { + /** + * The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + scheduledEventId: EventId; + /** + * The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + startedEventId: EventId; + /** + * The type of the timeout that caused this event. + */ + timeoutType?: LambdaFunctionTimeoutType; + } + export type LambdaFunctionTimeoutType = "START_TO_CLOSE"|string; + export type LimitedData = string; + export interface ListActivityTypesInput { + /** + * The name of the domain in which the activity types have been registered. + */ + domain: DomainName; + /** + * If specified, only lists the activity types that have this name. + */ + name?: Name; + /** + * Specifies the registration status of the activity types to list. + */ + registrationStatus: RegistrationStatus; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + /** + * The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. + */ + maximumPageSize?: PageSize; + /** + * When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types. + */ + reverseOrder?: ReverseOrder; + } + export interface ListClosedWorkflowExecutionsInput { + /** + * The name of the domain that contains the workflow executions to list. + */ + domain: DomainName; + /** + * If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both. + */ + startTimeFilter?: ExecutionTimeFilter; + /** + * If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both. + */ + closeTimeFilter?: ExecutionTimeFilter; + /** + * If specified, only workflow executions matching the workflow ID specified in the filter are returned. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + executionFilter?: WorkflowExecutionFilter; + /** + * If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + closeStatusFilter?: CloseStatusFilter; + /** + * If specified, only executions of the type specified in the filter are returned. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + typeFilter?: WorkflowTypeFilter; + /** + * If specified, only executions that have the matching tag are listed. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + tagFilter?: TagFilter; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + /** + * The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. + */ + maximumPageSize?: PageSize; + /** + * When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions. + */ + reverseOrder?: ReverseOrder; + } + export interface ListDomainsInput { + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + /** + * Specifies the registration status of the domains to list. + */ + registrationStatus: RegistrationStatus; + /** + * The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. + */ + maximumPageSize?: PageSize; + /** + * When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains. + */ + reverseOrder?: ReverseOrder; + } + export interface ListOpenWorkflowExecutionsInput { + /** + * The name of the domain that contains the workflow executions to list. + */ + domain: DomainName; + /** + * Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. + */ + startTimeFilter: ExecutionTimeFilter; + /** + * If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + typeFilter?: WorkflowTypeFilter; + /** + * If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + tagFilter?: TagFilter; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + /** + * The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. + */ + maximumPageSize?: PageSize; + /** + * When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions. + */ + reverseOrder?: ReverseOrder; + /** + * If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request. + */ + executionFilter?: WorkflowExecutionFilter; + } + export interface ListWorkflowTypesInput { + /** + * The name of the domain in which the workflow types have been registered. + */ + domain: DomainName; + /** + * If specified, lists the workflow type with this name. + */ + name?: Name; + /** + * Specifies the registration status of the workflow types to list. + */ + registrationStatus: RegistrationStatus; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + /** + * The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. + */ + maximumPageSize?: PageSize; + /** + * When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types. + */ + reverseOrder?: ReverseOrder; + } + export type MarkerName = string; + export interface MarkerRecordedEventAttributes { + /** + * The name of the marker. + */ + markerName: MarkerName; + /** + * The details of the marker. + */ + details?: Data; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export type Name = string; + export type OpenDecisionTasksCount = number; + export type PageSize = number; + export type PageToken = string; + export interface PendingTaskCount { + /** + * The number of tasks in the task list. + */ + count: Count; + /** + * If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value. + */ + truncated?: Truncated; + } + export interface PollForActivityTaskInput { + /** + * The name of the domain that contains the task lists being polled. + */ + domain: DomainName; + /** + * Specifies the task list to poll for activity tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + taskList: TaskList; + /** + * Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined. + */ + identity?: Identity; + } + export interface PollForDecisionTaskInput { + /** + * The name of the domain containing the task lists to poll. + */ + domain: DomainName; + /** + * Specifies the task list to poll for decision tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + taskList: TaskList; + /** + * Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined. + */ + identity?: Identity; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task. + */ + nextPageToken?: PageToken; + /** + * The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. + */ + maximumPageSize?: PageSize; + /** + * When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events. + */ + reverseOrder?: ReverseOrder; + } + export interface RecordActivityTaskHeartbeatInput { + /** + * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. + */ + taskToken: TaskToken; + /** + * If specified, contains details about the progress of the task. + */ + details?: LimitedData; + } + export interface RecordMarkerDecisionAttributes { + /** + * The name of the marker. + */ + markerName: MarkerName; + /** + * The details of the marker. + */ + details?: Data; + } + export type RecordMarkerFailedCause = "OPERATION_NOT_PERMITTED"|string; + export interface RecordMarkerFailedEventAttributes { + /** + * The marker's name. + */ + markerName: MarkerName; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: RecordMarkerFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface RegisterActivityTypeInput { + /** + * The name of the domain in which this activity is to be registered. + */ + domain: DomainName; + /** + * The name of the activity type within the domain. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + name: Name; + /** + * The version of the activity type. The activity type consists of the name and version, the combination of which must be unique within the domain. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + version: Version; + /** + * A textual description of the activity type. + */ + description?: Description; + /** + * If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskHeartbeatTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. + */ + defaultTaskList?: TaskList; + /** + * The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide.. + */ + defaultTaskPriority?: TaskPriority; + /** + * If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskScheduleToStartTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskScheduleToCloseTimeout?: DurationInSecondsOptional; + } + export interface RegisterDomainInput { + /** + * Name of the domain to register. The name must be unique in the region that the domain is registered in. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + name: DomainName; + /** + * A text description of the domain. + */ + description?: Description; + /** + * The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls. If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted. The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide. + */ + workflowExecutionRetentionPeriodInDays: DurationInDays; + } + export interface RegisterWorkflowTypeInput { + /** + * The name of the domain in which to register the workflow type. + */ + domain: DomainName; + /** + * The name of the workflow type. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + name: Name; + /** + * The version of the workflow type. The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + version: Version; + /** + * Textual description of the workflow type. + */ + description?: Description; + /** + * If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision. The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out. + */ + defaultExecutionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision. + */ + defaultTaskList?: TaskList; + /** + * The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + defaultTaskPriority?: TaskPriority; + /** + * If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + defaultChildPolicy?: ChildPolicy; + /** + * The default IAM role attached to this workflow type. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide. + */ + defaultLambdaRole?: Arn; + } + export type RegistrationStatus = "REGISTERED"|"DEPRECATED"|string; + export interface RequestCancelActivityTaskDecisionAttributes { + /** + * The activityId of the activity task to be canceled. + */ + activityId: ActivityId; + } + export type RequestCancelActivityTaskFailedCause = "ACTIVITY_ID_UNKNOWN"|"OPERATION_NOT_PERMITTED"|string; + export interface RequestCancelActivityTaskFailedEventAttributes { + /** + * The activityId provided in the RequestCancelActivityTask decision that failed. + */ + activityId: ActivityId; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: RequestCancelActivityTaskFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface RequestCancelExternalWorkflowExecutionDecisionAttributes { + /** + * The workflowId of the external workflow execution to cancel. + */ + workflowId: WorkflowId; + /** + * The runId of the external workflow execution to cancel. + */ + runId?: WorkflowRunIdOptional; + /** + * The data attached to the event that can be used by the decider in subsequent workflow tasks. + */ + control?: Data; + } + export type RequestCancelExternalWorkflowExecutionFailedCause = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"|"REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string; + export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes { + /** + * The workflowId of the external workflow to which the cancel request was to be delivered. + */ + workflowId: WorkflowId; + /** + * The runId of the external workflow execution. + */ + runId?: WorkflowRunIdOptional; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: RequestCancelExternalWorkflowExecutionFailedCause; + /** + * The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + /** + * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution. + */ + control?: Data; + } + export interface RequestCancelExternalWorkflowExecutionInitiatedEventAttributes { + /** + * The workflowId of the external workflow execution to be canceled. + */ + workflowId: WorkflowId; + /** + * The runId of the external workflow execution to be canceled. + */ + runId?: WorkflowRunIdOptional; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + /** + * Data attached to the event that can be used by the decider in subsequent workflow tasks. + */ + control?: Data; + } + export interface RequestCancelWorkflowExecutionInput { + /** + * The name of the domain containing the workflow execution to cancel. + */ + domain: DomainName; + /** + * The workflowId of the workflow execution to cancel. + */ + workflowId: WorkflowId; + /** + * The runId of the workflow execution to cancel. + */ + runId?: WorkflowRunIdOptional; + } + export interface RespondActivityTaskCanceledInput { + /** + * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. + */ + taskToken: TaskToken; + /** + * Information about the cancellation. + */ + details?: Data; + } + export interface RespondActivityTaskCompletedInput { + /** + * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. + */ + taskToken: TaskToken; + /** + * The result of the activity task. It is a free form string that is implementation specific. + */ + result?: Data; + } + export interface RespondActivityTaskFailedInput { + /** + * The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. + */ + taskToken: TaskToken; + /** + * Description of the error that may assist in diagnostics. + */ + reason?: FailureReason; + /** + * Detailed information about the failure. + */ + details?: Data; + } + export interface RespondDecisionTaskCompletedInput { + /** + * The taskToken from the DecisionTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. + */ + taskToken: TaskToken; + /** + * The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details. + */ + decisions?: DecisionList; + /** + * User defined context to add to workflow execution. + */ + executionContext?: Data; + } + export type ReverseOrder = boolean; + export interface Run { + /** + * The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain. + */ + runId?: WorkflowRunId; + } + export interface ScheduleActivityTaskDecisionAttributes { + /** + * The type of the activity task to schedule. + */ + activityType: ActivityType; + /** + * The activityId of the activity task. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + activityId: ActivityId; + /** + * Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity. + */ + control?: Data; + /** + * The input provided to the activity task. + */ + input?: Data; + /** + * The maximum duration for this activity task. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned. + */ + scheduleToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used. A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + taskList?: TaskList; + /** + * If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned. + */ + scheduleToStartTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned. + */ + startToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + heartbeatTimeout?: DurationInSecondsOptional; + } + export type ScheduleActivityTaskFailedCause = "ACTIVITY_TYPE_DEPRECATED"|"ACTIVITY_TYPE_DOES_NOT_EXIST"|"ACTIVITY_ID_ALREADY_IN_USE"|"OPEN_ACTIVITIES_LIMIT_EXCEEDED"|"ACTIVITY_CREATION_RATE_EXCEEDED"|"DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_TASK_LIST_UNDEFINED"|"DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED"|"DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED"|"OPERATION_NOT_PERMITTED"|string; + export interface ScheduleActivityTaskFailedEventAttributes { + /** + * The activity type provided in the ScheduleActivityTask decision that failed. + */ + activityType: ActivityType; + /** + * The activityId provided in the ScheduleActivityTask decision that failed. + */ + activityId: ActivityId; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: ScheduleActivityTaskFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface ScheduleLambdaFunctionDecisionAttributes { + /** + * A string that identifies the Lambda function execution in the event history. + */ + id: FunctionId; + /** + * The name, or ARN, of the Lambda function to schedule. + */ + name: FunctionName; + /** + * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task. + */ + control?: Data; + /** + * The optional input data to be supplied to the Lambda function. + */ + input?: FunctionInput; + /** + * The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed. + */ + startToCloseTimeout?: DurationInSecondsOptional; + } + export type ScheduleLambdaFunctionFailedCause = "ID_ALREADY_IN_USE"|"OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED"|"LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED"|"LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"|string; + export interface ScheduleLambdaFunctionFailedEventAttributes { + /** + * The ID provided in the ScheduleLambdaFunction decision that failed. + */ + id: FunctionId; + /** + * The name of the Lambda function. + */ + name: FunctionName; + /** + * The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: ScheduleLambdaFunctionFailedCause; + /** + * The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface SignalExternalWorkflowExecutionDecisionAttributes { + /** + * The workflowId of the workflow execution to be signaled. + */ + workflowId: WorkflowId; + /** + * The runId of the workflow execution to be signaled. + */ + runId?: WorkflowRunIdOptional; + /** + * The name of the signal.The target workflow execution uses the signal name and input to process the signal. + */ + signalName: SignalName; + /** + * The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal. + */ + input?: Data; + /** + * The data attached to the event that can be used by the decider in subsequent decision tasks. + */ + control?: Data; + } + export type SignalExternalWorkflowExecutionFailedCause = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"|"SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string; + export interface SignalExternalWorkflowExecutionFailedEventAttributes { + /** + * The workflowId of the external workflow execution that the signal was being delivered to. + */ + workflowId: WorkflowId; + /** + * The runId of the external workflow execution that the signal was being delivered to. + */ + runId?: WorkflowRunIdOptional; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: SignalExternalWorkflowExecutionFailedCause; + /** + * The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + initiatedEventId: EventId; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + /** + * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution. + */ + control?: Data; + } + export interface SignalExternalWorkflowExecutionInitiatedEventAttributes { + /** + * The workflowId of the external workflow execution. + */ + workflowId: WorkflowId; + /** + * The runId of the external workflow execution to send the signal to. + */ + runId?: WorkflowRunIdOptional; + /** + * The name of the signal. + */ + signalName: SignalName; + /** + * The input provided to the signal. + */ + input?: Data; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + /** + * Data attached to the event that can be used by the decider in subsequent decision tasks. + */ + control?: Data; + } + export type SignalName = string; + export interface SignalWorkflowExecutionInput { + /** + * The name of the domain containing the workflow execution to signal. + */ + domain: DomainName; + /** + * The workflowId of the workflow execution to signal. + */ + workflowId: WorkflowId; + /** + * The runId of the workflow execution to signal. + */ + runId?: WorkflowRunIdOptional; + /** + * The name of the signal. This name must be meaningful to the target workflow. + */ + signalName: SignalName; + /** + * Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history. + */ + input?: Data; + } + export interface StartChildWorkflowExecutionDecisionAttributes { + /** + * The type of the workflow execution to be started. + */ + workflowType: WorkflowType; + /** + * The workflowId of the workflow execution. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + workflowId: WorkflowId; + /** + * The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution. + */ + control?: Data; + /** + * The input to be provided to the workflow execution. + */ + input?: Data; + /** + * The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned. + */ + executionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The name of the task list to be used for decision tasks of the child workflow execution. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + taskList?: TaskList; + /** + * A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned. + */ + taskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned. + */ + childPolicy?: ChildPolicy; + /** + * The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter. + */ + tagList?: TagList; + /** + * The IAM role attached to the child workflow execution. + */ + lambdaRole?: Arn; + } + export type StartChildWorkflowExecutionFailedCause = "WORKFLOW_TYPE_DOES_NOT_EXIST"|"WORKFLOW_TYPE_DEPRECATED"|"OPEN_CHILDREN_LIMIT_EXCEEDED"|"OPEN_WORKFLOWS_LIMIT_EXCEEDED"|"CHILD_CREATION_RATE_EXCEEDED"|"WORKFLOW_ALREADY_RUNNING"|"DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_TASK_LIST_UNDEFINED"|"DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"|"DEFAULT_CHILD_POLICY_UNDEFINED"|"OPERATION_NOT_PERMITTED"|string; + export interface StartChildWorkflowExecutionFailedEventAttributes { + /** + * The workflow type provided in the StartChildWorkflowExecution Decision that failed. + */ + workflowType: WorkflowType; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: StartChildWorkflowExecutionFailedCause; + /** + * The workflowId of the child workflow execution. + */ + workflowId: WorkflowId; + /** + * When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event. When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist. + */ + initiatedEventId: EventId; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events. + */ + decisionTaskCompletedEventId: EventId; + /** + * The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution. + */ + control?: Data; + } + export interface StartChildWorkflowExecutionInitiatedEventAttributes { + /** + * The workflowId of the child workflow execution. + */ + workflowId: WorkflowId; + /** + * The type of the child workflow execution. + */ + workflowType: WorkflowType; + /** + * Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity. + */ + control?: Data; + /** + * The inputs provided to the child workflow execution. + */ + input?: Data; + /** + * The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + executionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The name of the task list used for the decision tasks of the child workflow execution. + */ + taskList: TaskList; + /** + * The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events. + */ + decisionTaskCompletedEventId: EventId; + /** + * The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + childPolicy: ChildPolicy; + /** + * The maximum duration allowed for the decision tasks for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + taskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The list of tags to associated with the child workflow execution. + */ + tagList?: TagList; + /** + * The IAM role to attach to the child workflow execution. + */ + lambdaRole?: Arn; + } + export type StartLambdaFunctionFailedCause = "ASSUME_ROLE_FAILED"|string; + export interface StartLambdaFunctionFailedEventAttributes { + /** + * The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event. + */ + scheduledEventId?: EventId; + /** + * The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide. + */ + cause?: StartLambdaFunctionFailedCause; + /** + * A description that can help diagnose the cause of the fault. + */ + message?: CauseMessage; + } + export interface StartTimerDecisionAttributes { + /** + * The unique ID of the timer. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + timerId: TimerId; + /** + * The data attached to the event that can be used by the decider in subsequent workflow tasks. + */ + control?: Data; + /** + * The duration to wait before firing the timer. The duration is specified in seconds, an integer greater than or equal to 0. + */ + startToFireTimeout: DurationInSeconds; + } + export type StartTimerFailedCause = "TIMER_ID_ALREADY_IN_USE"|"OPEN_TIMERS_LIMIT_EXCEEDED"|"TIMER_CREATION_RATE_EXCEEDED"|"OPERATION_NOT_PERMITTED"|string; + export interface StartTimerFailedEventAttributes { + /** + * The timerId provided in the StartTimer decision that failed. + */ + timerId: TimerId; + /** + * The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. + */ + cause: StartTimerFailedCause; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface StartWorkflowExecutionInput { + /** + * The name of the domain in which the workflow execution is created. + */ + domain: DomainName; + /** + * The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + workflowId: WorkflowId; + /** + * The type of the workflow to start. + */ + workflowType: WorkflowType; + /** + * The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn. + */ + taskList?: TaskList; + /** + * The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event. + */ + input?: Data; + /** + * The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run. An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned. + */ + executionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter. + */ + tagList?: TagList; + /** + * Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned. + */ + taskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned. + */ + childPolicy?: ChildPolicy; + /** + * The IAM role to attach to this workflow execution. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide. + */ + lambdaRole?: Arn; + } + export type Tag = string; + export interface TagFilter { + /** + * Specifies the tag that must be associated with the execution for it to meet the filter criteria. + */ + tag: Tag; + } + export type TagList = Tag[]; + export interface TaskList { + /** + * The name of the task list. + */ + name: Name; + } + export type TaskPriority = string; + export type TaskToken = string; + export type TerminateReason = string; + export interface TerminateWorkflowExecutionInput { + /** + * The domain of the workflow execution to terminate. + */ + domain: DomainName; + /** + * The workflowId of the workflow execution to terminate. + */ + workflowId: WorkflowId; + /** + * The runId of the workflow execution to terminate. + */ + runId?: WorkflowRunIdOptional; + /** + * A descriptive reason for terminating the workflow execution. + */ + reason?: TerminateReason; + /** + * Details for terminating the workflow execution. + */ + details?: Data; + /** + * If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned. + */ + childPolicy?: ChildPolicy; + } + export interface TimerCanceledEventAttributes { + /** + * The unique ID of the timer that was canceled. + */ + timerId: TimerId; + /** + * The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface TimerFiredEventAttributes { + /** + * The unique ID of the timer that fired. + */ + timerId: TimerId; + /** + * The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + startedEventId: EventId; + } + export type TimerId = string; + export interface TimerStartedEventAttributes { + /** + * The unique ID of the timer that was started. + */ + timerId: TimerId; + /** + * Data attached to the event that can be used by the decider in subsequent workflow tasks. + */ + control?: Data; + /** + * The duration of time after which the timer fires. The duration is specified in seconds, an integer greater than or equal to 0. + */ + startToFireTimeout: DurationInSeconds; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export type Timestamp = Date; + export type Truncated = boolean; + export type Version = string; + export type VersionOptional = string; + export interface WorkflowExecution { + /** + * The user defined identifier associated with the workflow execution. + */ + workflowId: WorkflowId; + /** + * A system-generated unique identifier for the workflow execution. + */ + runId: WorkflowRunId; + } + export type WorkflowExecutionCancelRequestedCause = "CHILD_POLICY_APPLIED"|string; + export interface WorkflowExecutionCancelRequestedEventAttributes { + /** + * The external workflow execution for which the cancellation was requested. + */ + externalWorkflowExecution?: WorkflowExecution; + /** + * The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + externalInitiatedEventId?: EventId; + /** + * If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions. + */ + cause?: WorkflowExecutionCancelRequestedCause; + } + export interface WorkflowExecutionCanceledEventAttributes { + /** + * The details of the cancellation. + */ + details?: Data; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface WorkflowExecutionCompletedEventAttributes { + /** + * The result produced by the workflow execution upon successful completion. + */ + result?: Data; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface WorkflowExecutionConfiguration { + /** + * The maximum duration allowed for decision tasks for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + taskStartToCloseTimeout: DurationInSeconds; + /** + * The total duration for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + executionStartToCloseTimeout: DurationInSeconds; + /** + * The task list used for the decision tasks generated for this workflow execution. + */ + taskList: TaskList; + /** + * The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + taskPriority?: TaskPriority; + /** + * The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + childPolicy: ChildPolicy; + /** + * The IAM role attached to the child workflow execution. + */ + lambdaRole?: Arn; + } + export interface WorkflowExecutionContinuedAsNewEventAttributes { + /** + * The input provided to the new workflow execution. + */ + input?: Data; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + /** + * The runId of the new workflow execution. + */ + newExecutionRunId: WorkflowRunId; + /** + * The total duration allowed for the new workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + executionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The task list to use for the decisions of the new (continued) workflow execution. + */ + taskList: TaskList; + /** + * The priority of the task to use for the decisions of the new (continued) workflow execution. + */ + taskPriority?: TaskPriority; + /** + * The maximum duration of decision tasks for the new workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + taskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + childPolicy: ChildPolicy; + /** + * The list of tags associated with the new workflow execution. + */ + tagList?: TagList; + /** + * The workflow type of this execution. + */ + workflowType: WorkflowType; + /** + * The IAM role to attach to the new (continued) workflow execution. + */ + lambdaRole?: Arn; + } + export interface WorkflowExecutionCount { + /** + * The number of workflow executions. + */ + count: Count; + /** + * If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value. + */ + truncated?: Truncated; + } + export interface WorkflowExecutionDetail { + /** + * Information about the workflow execution. + */ + executionInfo: WorkflowExecutionInfo; + /** + * The configuration settings for this workflow execution including timeout values, tasklist etc. + */ + executionConfiguration: WorkflowExecutionConfiguration; + /** + * The number of tasks for this workflow execution. This includes open and closed tasks of all types. + */ + openCounts: WorkflowExecutionOpenCounts; + /** + * The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action. + */ + latestActivityTaskTimestamp?: Timestamp; + /** + * The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted. + */ + latestExecutionContext?: Data; + } + export interface WorkflowExecutionFailedEventAttributes { + /** + * The descriptive reason provided for the failure. + */ + reason?: FailureReason; + /** + * The details of the failure. + */ + details?: Data; + /** + * The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + decisionTaskCompletedEventId: EventId; + } + export interface WorkflowExecutionFilter { + /** + * The workflowId to pass of match the criteria of this filter. + */ + workflowId: WorkflowId; + } + export interface WorkflowExecutionInfo { + /** + * The workflow execution this information is about. + */ + execution: WorkflowExecution; + /** + * The type of the workflow execution. + */ + workflowType: WorkflowType; + /** + * The time when the execution was started. + */ + startTimestamp: Timestamp; + /** + * The time when the workflow execution was closed. Set only if the execution status is CLOSED. + */ + closeTimestamp?: Timestamp; + /** + * The current status of the execution. + */ + executionStatus: ExecutionStatus; + /** + * If the execution status is closed then this specifies how the execution was closed: COMPLETED – the execution was successfully completed. CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed. TERMINATED – the execution was force terminated. FAILED – the execution failed to complete. TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out. CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow. + */ + closeStatus?: CloseStatus; + /** + * If this workflow execution is a child of another execution then contains the workflow execution that started this execution. + */ + parent?: WorkflowExecution; + /** + * The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags. + */ + tagList?: TagList; + /** + * Set to true if a cancellation is requested for this workflow execution. + */ + cancelRequested?: Canceled; + } + export type WorkflowExecutionInfoList = WorkflowExecutionInfo[]; + export interface WorkflowExecutionInfos { + /** + * The list of workflow information structures. + */ + executionInfos: WorkflowExecutionInfoList; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + } + export interface WorkflowExecutionOpenCounts { + /** + * The count of activity tasks whose status is OPEN. + */ + openActivityTasks: Count; + /** + * The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task. + */ + openDecisionTasks: OpenDecisionTasksCount; + /** + * The count of timers started by this workflow execution that have not fired yet. + */ + openTimers: Count; + /** + * The count of child workflow executions whose status is OPEN. + */ + openChildWorkflowExecutions: Count; + /** + * The count of Lambda tasks whose status is OPEN. + */ + openLambdaFunctions?: Count; + } + export interface WorkflowExecutionSignaledEventAttributes { + /** + * The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal. + */ + signalName: SignalName; + /** + * The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal. + */ + input?: Data; + /** + * The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution. + */ + externalWorkflowExecution?: WorkflowExecution; + /** + * The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution. + */ + externalInitiatedEventId?: EventId; + } + export interface WorkflowExecutionStartedEventAttributes { + /** + * The input provided to the workflow execution. + */ + input?: Data; + /** + * The maximum duration for this workflow execution. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + executionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The maximum duration of decision tasks for this workflow type. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + taskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + childPolicy: ChildPolicy; + /** + * The name of the task list for scheduling the decision tasks for this workflow execution. + */ + taskList: TaskList; + /** + * The priority of the decision tasks in the workflow execution. + */ + taskPriority?: TaskPriority; + /** + * The workflow type of this execution. + */ + workflowType: WorkflowType; + /** + * The list of tags associated with this workflow execution. An execution can have up to 5 tags. + */ + tagList?: TagList; + /** + * If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution. + */ + continuedExecutionRunId?: WorkflowRunIdOptional; + /** + * The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow. + */ + parentWorkflowExecution?: WorkflowExecution; + /** + * The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. + */ + parentInitiatedEventId?: EventId; + /** + * The IAM role attached to the workflow execution. + */ + lambdaRole?: Arn; + } + export type WorkflowExecutionTerminatedCause = "CHILD_POLICY_APPLIED"|"EVENT_LIMIT_EXCEEDED"|"OPERATOR_INITIATED"|string; + export interface WorkflowExecutionTerminatedEventAttributes { + /** + * The reason provided for the termination. + */ + reason?: TerminateReason; + /** + * The details provided for the termination. + */ + details?: Data; + /** + * The policy used for the child workflow executions of this workflow execution. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + childPolicy: ChildPolicy; + /** + * If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions. + */ + cause?: WorkflowExecutionTerminatedCause; + } + export interface WorkflowExecutionTimedOutEventAttributes { + /** + * The type of timeout that caused this event. + */ + timeoutType: WorkflowExecutionTimeoutType; + /** + * The policy used for the child workflow executions of this workflow execution. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + childPolicy: ChildPolicy; + } + export type WorkflowExecutionTimeoutType = "START_TO_CLOSE"|string; + export type WorkflowId = string; + export type WorkflowRunId = string; + export type WorkflowRunIdOptional = string; + export interface WorkflowType { + /** + * The name of the workflow type. The combination of workflow type name and version must be unique with in a domain. + */ + name: Name; + /** + * The version of the workflow type. The combination of workflow type name and version must be unique with in a domain. + */ + version: Version; + } + export interface WorkflowTypeConfiguration { + /** + * The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultTaskStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration. + */ + defaultExecutionStartToCloseTimeout?: DurationInSecondsOptional; + /** + * The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. + */ + defaultTaskList?: TaskList; + /** + * The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide. + */ + defaultTaskPriority?: TaskPriority; + /** + * The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The supported child policies are: TERMINATE – The child executions are terminated. REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. ABANDON – No action is taken. The child executions continue to run. + */ + defaultChildPolicy?: ChildPolicy; + /** + * The default IAM role attached to this workflow type. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide. + */ + defaultLambdaRole?: Arn; + } + export interface WorkflowTypeDetail { + /** + * General information about the workflow type. The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following. REGISTERED – The type is registered and available. Workers supporting this type should be running. DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type. + */ + typeInfo: WorkflowTypeInfo; + /** + * Configuration settings of the workflow type registered through RegisterWorkflowType + */ + configuration: WorkflowTypeConfiguration; + } + export interface WorkflowTypeFilter { + /** + * Name of the workflow type. + */ + name: Name; + /** + * Version of the workflow type. + */ + version?: VersionOptional; + } + export interface WorkflowTypeInfo { + /** + * The workflow type this information is about. + */ + workflowType: WorkflowType; + /** + * The current status of the workflow type. + */ + status: RegistrationStatus; + /** + * The description of the type registered through RegisterWorkflowType. + */ + description?: Description; + /** + * The date when this type was registered. + */ + creationDate: Timestamp; + /** + * If the type is in deprecated state, then it is set to the date when the type was deprecated. + */ + deprecationDate?: Timestamp; + } + export type WorkflowTypeInfoList = WorkflowTypeInfo[]; + export interface WorkflowTypeInfos { + /** + * The list of workflow type information. + */ + typeInfos: WorkflowTypeInfoList; + /** + * If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call. + */ + nextPageToken?: PageToken; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2012-01-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the SWF client. + */ + export import Types = SWF; +} +export = SWF; diff --git a/node_modules/aws-sdk/clients/swf.js b/node_modules/aws-sdk/clients/swf.js new file mode 100644 index 0000000..b9cd99e --- /dev/null +++ b/node_modules/aws-sdk/clients/swf.js @@ -0,0 +1,19 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['swf'] = {}; +AWS.SWF = Service.defineService('swf', ['2012-01-25']); +require('../lib/services/swf'); +Object.defineProperty(apiLoader.services['swf'], '2012-01-25', { + get: function get() { + var model = require('../apis/swf-2012-01-25.min.json'); + model.paginators = require('../apis/swf-2012-01-25.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.SWF; diff --git a/node_modules/aws-sdk/clients/textract.d.ts b/node_modules/aws-sdk/clients/textract.d.ts new file mode 100644 index 0000000..8cd43c4 --- /dev/null +++ b/node_modules/aws-sdk/clients/textract.d.ts @@ -0,0 +1,438 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Textract extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Textract.Types.ClientConfiguration) + config: Config & Textract.Types.ClientConfiguration; + /** + * Analyzes an input document for relationships between detected items. The types of information returned are as follows: Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element. Lines and words of text. A LINE Block object contains one or more WORD Block objects. You can choose which type of analysis to perform by specifying the FeatureTypes list. The output is returned in a list of BLOCK objects. AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis. For more information, see Document Text Analysis. + */ + analyzeDocument(params: Textract.Types.AnalyzeDocumentRequest, callback?: (err: AWSError, data: Textract.Types.AnalyzeDocumentResponse) => void): Request; + /** + * Analyzes an input document for relationships between detected items. The types of information returned are as follows: Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element. Lines and words of text. A LINE Block object contains one or more WORD Block objects. You can choose which type of analysis to perform by specifying the FeatureTypes list. The output is returned in a list of BLOCK objects. AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis. For more information, see Document Text Analysis. + */ + analyzeDocument(callback?: (err: AWSError, data: Textract.Types.AnalyzeDocumentResponse) => void): Request; + /** + * Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection. For more information, see Document Text Detection. + */ + detectDocumentText(params: Textract.Types.DetectDocumentTextRequest, callback?: (err: AWSError, data: Textract.Types.DetectDocumentTextResponse) => void): Request; + /** + * Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection. For more information, see Document Text Detection. + */ + detectDocumentText(callback?: (err: AWSError, data: Textract.Types.DetectDocumentTextResponse) => void): Request; + /** + * Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document. You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. GetDocumentAnalysis returns an array of Block objects. The following types of information are returned: Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element. Lines and words of text. A LINE Block object contains one or more WORD Block objects. Use the MaxResults parameter to limit the number of blocks returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis. For more information, see Document Text Analysis. + */ + getDocumentAnalysis(params: Textract.Types.GetDocumentAnalysisRequest, callback?: (err: AWSError, data: Textract.Types.GetDocumentAnalysisResponse) => void): Request; + /** + * Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document. You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. GetDocumentAnalysis returns an array of Block objects. The following types of information are returned: Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element. Lines and words of text. A LINE Block object contains one or more WORD Block objects. Use the MaxResults parameter to limit the number of blocks returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis. For more information, see Document Text Analysis. + */ + getDocumentAnalysis(callback?: (err: AWSError, data: Textract.Types.GetDocumentAnalysisResponse) => void): Request; + /** + * Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection. GetDocumentTextDetection returns an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection. For more information, see Document Text Detection. + */ + getDocumentTextDetection(params: Textract.Types.GetDocumentTextDetectionRequest, callback?: (err: AWSError, data: Textract.Types.GetDocumentTextDetectionResponse) => void): Request; + /** + * Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection. GetDocumentTextDetection returns an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection. For more information, see Document Text Detection. + */ + getDocumentTextDetection(callback?: (err: AWSError, data: Textract.Types.GetDocumentTextDetectionResponse) => void): Request; + /** + * Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document. StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. For more information, see Document Text Analysis. + */ + startDocumentAnalysis(params: Textract.Types.StartDocumentAnalysisRequest, callback?: (err: AWSError, data: Textract.Types.StartDocumentAnalysisResponse) => void): Request; + /** + * Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document. StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. For more information, see Document Text Analysis. + */ + startDocumentAnalysis(callback?: (err: AWSError, data: Textract.Types.StartDocumentAnalysisResponse) => void): Request; + /** + * Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. StartDocumentTextDetection can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document. StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection. For more information, see Document Text Detection. + */ + startDocumentTextDetection(params: Textract.Types.StartDocumentTextDetectionRequest, callback?: (err: AWSError, data: Textract.Types.StartDocumentTextDetectionResponse) => void): Request; + /** + * Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. StartDocumentTextDetection can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document. StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection. For more information, see Document Text Detection. + */ + startDocumentTextDetection(callback?: (err: AWSError, data: Textract.Types.StartDocumentTextDetectionResponse) => void): Request; +} +declare namespace Textract { + export interface AnalyzeDocumentRequest { + /** + * The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPG or PNG format. If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field. + */ + Document: Document; + /** + * A list of the types of analysis to perform. Add TABLES to the list to return information about the tables detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. + */ + FeatureTypes: FeatureTypes; + } + export interface AnalyzeDocumentResponse { + /** + * Metadata about the analyzed document. An example is the number of pages. + */ + DocumentMetadata?: DocumentMetadata; + /** + * The text that's detected and analyzed by AnalyzeDocument. + */ + Blocks?: BlockList; + } + export interface Block { + /** + * The type of text that's recognized in a block. In text-detection operations, the following types are returned: PAGE - Contains a list of the LINE Block objects that are detected on a document page. WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that's detected on a document page. In text analysis operations, the following types are returned: PAGE - Contains a list of child Block objects that are detected on a document page. KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object. WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces that's detected on a document page. LINE - A string of tab-delimited, contiguous words that's detected on a document page. TABLE - A table that's detected on a document page. A table is any grid-based information with 2 or more rows or columns with a cell span of 1 row and 1 column each. CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell. SELECTION_ELEMENT - A selectable element such as a radio button or checkbox that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element. + */ + BlockType?: BlockType; + /** + * The confidence that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text. + */ + Confidence?: Percent; + /** + * The word or line of text that's recognized by Amazon Textract. + */ + Text?: String; + /** + * The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. + */ + RowIndex?: UInteger; + /** + * The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. + */ + ColumnIndex?: UInteger; + /** + * The number of rows that a table spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. + */ + RowSpan?: UInteger; + /** + * The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. + */ + ColumnSpan?: UInteger; + /** + * The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information. + */ + Geometry?: Geometry; + /** + * The identifier for the recognized text. The identifier is only unique for a single operation. + */ + Id?: NonEmptyString; + /** + * A list of child blocks of the current block. For example a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following: 0 - The block has no child blocks. 1 - The block has child blocks. + */ + Relationships?: RelationshipList; + /** + * The type of entity. The following can be returned: KEY - An identifier for a field on the document. VALUE - The field text. EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection. + */ + EntityTypes?: EntityTypes; + /** + * The selection status of a selectable element such as a radio button or checkbox. + */ + SelectionStatus?: SelectionStatus; + /** + * The page in which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multi-page documents that are in PDF format. A scanned image (JPG/PNG), even if it contains multiple document pages, is always considered to be a single-page document and the value of Page is always 1. Synchronous operations don't return Page as every input document is considered to be a single-page document. + */ + Page?: UInteger; + } + export type BlockList = Block[]; + export type BlockType = "KEY_VALUE_SET"|"PAGE"|"LINE"|"WORD"|"TABLE"|"CELL"|"SELECTION_ELEMENT"|string; + export interface BoundingBox { + /** + * The width of the bounding box as a ratio of the overall document page width. + */ + Width?: Float; + /** + * The height of the bounding box as a ratio of the overall document page height. + */ + Height?: Float; + /** + * The left coordinate of the bounding box as a ratio of overall document page width. + */ + Left?: Float; + /** + * The top coordinate of the bounding box as a ratio of overall document page height. + */ + Top?: Float; + } + export type ClientRequestToken = string; + export interface DetectDocumentTextRequest { + /** + * The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPG or PNG format. If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field. + */ + Document: Document; + } + export interface DetectDocumentTextResponse { + /** + * Metadata about the document. Contains the number of pages that are detected in the document. + */ + DocumentMetadata?: DocumentMetadata; + /** + * An array of Block objects containing the text detected in the document. + */ + Blocks?: BlockList; + } + export interface Document { + /** + * A blob of base-64 encoded documents bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPG format. If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field. + */ + Bytes?: ImageBlob; + /** + * Identifies an S3 object as the document source. The maximum size of a document stored in an S3 bucket is 5 MB. + */ + S3Object?: S3Object; + } + export interface DocumentLocation { + /** + * The Amazon S3 bucket that contains the input document. + */ + S3Object?: S3Object; + } + export interface DocumentMetadata { + /** + * The number of pages detected in the document. + */ + Pages?: UInteger; + } + export type EntityType = "KEY"|"VALUE"|string; + export type EntityTypes = EntityType[]; + export type ErrorCode = string; + export type FeatureType = "TABLES"|"FORMS"|string; + export type FeatureTypes = FeatureType[]; + export type Float = number; + export interface Geometry { + /** + * An axis-aligned coarse representation of the location of the recognized text on the document page. + */ + BoundingBox?: BoundingBox; + /** + * Within the bounding box, a fine-grained polygon around the recognized text. + */ + Polygon?: Polygon; + } + export interface GetDocumentAnalysisRequest { + /** + * A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. + */ + JobId: JobId; + /** + * The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks. + */ + NextToken?: PaginationToken; + } + export interface GetDocumentAnalysisResponse { + /** + * Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation. + */ + DocumentMetadata?: DocumentMetadata; + /** + * The current status of the text detection job. + */ + JobStatus?: JobStatus; + /** + * If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results. + */ + NextToken?: PaginationToken; + /** + * The results of the text analysis operation. + */ + Blocks?: BlockList; + /** + * A list of warnings that occurred during the document analysis operation. + */ + Warnings?: Warnings; + /** + * The current status of an asynchronous document analysis operation. + */ + StatusMessage?: StatusMessage; + } + export interface GetDocumentTextDetectionRequest { + /** + * A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. + */ + JobId: JobId; + /** + * The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000. + */ + MaxResults?: MaxResults; + /** + * If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks. + */ + NextToken?: PaginationToken; + } + export interface GetDocumentTextDetectionResponse { + /** + * Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation. + */ + DocumentMetadata?: DocumentMetadata; + /** + * The current status of the text detection job. + */ + JobStatus?: JobStatus; + /** + * If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results. + */ + NextToken?: PaginationToken; + /** + * The results of the text-detection operation. + */ + Blocks?: BlockList; + /** + * A list of warnings that occurred during the document text-detection operation. + */ + Warnings?: Warnings; + /** + * The current status of an asynchronous document text-detection operation. + */ + StatusMessage?: StatusMessage; + } + export type IdList = NonEmptyString[]; + export type ImageBlob = Buffer|Uint8Array|Blob|string; + export type JobId = string; + export type JobStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"PARTIAL_SUCCESS"|string; + export type JobTag = string; + export type MaxResults = number; + export type NonEmptyString = string; + export interface NotificationChannel { + /** + * The Amazon SNS topic that Amazon Textract posts the completion status to. + */ + SNSTopicArn: SNSTopicArn; + /** + * The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. + */ + RoleArn: RoleArn; + } + export type Pages = UInteger[]; + export type PaginationToken = string; + export type Percent = number; + export interface Point { + /** + * The value of the X coordinate for a point on a Polygon. + */ + X?: Float; + /** + * The value of the Y coordinate for a point on a Polygon. + */ + Y?: Float; + } + export type Polygon = Point[]; + export interface Relationship { + /** + * The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. + */ + Type?: RelationshipType; + /** + * An array of IDs for related blocks. You can get the type of the relationship from the Type element. + */ + Ids?: IdList; + } + export type RelationshipList = Relationship[]; + export type RelationshipType = "VALUE"|"CHILD"|string; + export type RoleArn = string; + export type S3Bucket = string; + export interface S3Object { + /** + * The name of the S3 bucket. + */ + Bucket?: S3Bucket; + /** + * The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files. + */ + Name?: S3ObjectName; + /** + * If the bucket has versioning enabled, you can specify the object version. + */ + Version?: S3ObjectVersion; + } + export type S3ObjectName = string; + export type S3ObjectVersion = string; + export type SNSTopicArn = string; + export type SelectionStatus = "SELECTED"|"NOT_SELECTED"|string; + export interface StartDocumentAnalysisRequest { + /** + * The location of the document to be processed. + */ + DocumentLocation: DocumentLocation; + /** + * A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes. + */ + FeatureTypes: FeatureTypes; + /** + * The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to. + */ + JobTag?: JobTag; + /** + * The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. + */ + NotificationChannel?: NotificationChannel; + } + export interface StartDocumentAnalysisResponse { + /** + * The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis. + */ + JobId?: JobId; + } + export interface StartDocumentTextDetectionRequest { + /** + * The location of the document to be processed. + */ + DocumentLocation: DocumentLocation; + /** + * The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. + */ + ClientRequestToken?: ClientRequestToken; + /** + * An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to. + */ + JobTag?: JobTag; + /** + * The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. + */ + NotificationChannel?: NotificationChannel; + } + export interface StartDocumentTextDetectionResponse { + /** + * The identifier for the document text-detection job. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection. + */ + JobId?: JobId; + } + export type StatusMessage = string; + export type String = string; + export type UInteger = number; + export interface Warning { + /** + * The error code for the warning. + */ + ErrorCode?: ErrorCode; + /** + * A list of the pages that the warning applies to. + */ + Pages?: Pages; + } + export type Warnings = Warning[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-06-27"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Textract client. + */ + export import Types = Textract; +} +export = Textract; diff --git a/node_modules/aws-sdk/clients/textract.js b/node_modules/aws-sdk/clients/textract.js new file mode 100644 index 0000000..5168592 --- /dev/null +++ b/node_modules/aws-sdk/clients/textract.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['textract'] = {}; +AWS.Textract = Service.defineService('textract', ['2018-06-27']); +Object.defineProperty(apiLoader.services['textract'], '2018-06-27', { + get: function get() { + var model = require('../apis/textract-2018-06-27.min.json'); + model.paginators = require('../apis/textract-2018-06-27.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Textract; diff --git a/node_modules/aws-sdk/clients/transcribeservice.d.ts b/node_modules/aws-sdk/clients/transcribeservice.d.ts new file mode 100644 index 0000000..7aca4a4 --- /dev/null +++ b/node_modules/aws-sdk/clients/transcribeservice.d.ts @@ -0,0 +1,480 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class TranscribeService extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: TranscribeService.Types.ClientConfiguration) + config: Config & TranscribeService.Types.ClientConfiguration; + /** + * Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file. + */ + createVocabulary(params: TranscribeService.Types.CreateVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyResponse) => void): Request; + /** + * Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file. + */ + createVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyResponse) => void): Request; + /** + * Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on. + */ + deleteTranscriptionJob(params: TranscribeService.Types.DeleteTranscriptionJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on. + */ + deleteTranscriptionJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a vocabulary from Amazon Transcribe. + */ + deleteVocabulary(params: TranscribeService.Types.DeleteVocabularyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a vocabulary from Amazon Transcribe. + */ + deleteVocabulary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field. + */ + getTranscriptionJob(params: TranscribeService.Types.GetTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetTranscriptionJobResponse) => void): Request; + /** + * Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field. + */ + getTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.GetTranscriptionJobResponse) => void): Request; + /** + * Gets information about a vocabulary. + */ + getVocabulary(params: TranscribeService.Types.GetVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyResponse) => void): Request; + /** + * Gets information about a vocabulary. + */ + getVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyResponse) => void): Request; + /** + * Lists transcription jobs with the specified status. + */ + listTranscriptionJobs(params: TranscribeService.Types.ListTranscriptionJobsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListTranscriptionJobsResponse) => void): Request; + /** + * Lists transcription jobs with the specified status. + */ + listTranscriptionJobs(callback?: (err: AWSError, data: TranscribeService.Types.ListTranscriptionJobsResponse) => void): Request; + /** + * Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies. + */ + listVocabularies(params: TranscribeService.Types.ListVocabulariesRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListVocabulariesResponse) => void): Request; + /** + * Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies. + */ + listVocabularies(callback?: (err: AWSError, data: TranscribeService.Types.ListVocabulariesResponse) => void): Request; + /** + * Starts an asynchronous job to transcribe speech to text. + */ + startTranscriptionJob(params: TranscribeService.Types.StartTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request; + /** + * Starts an asynchronous job to transcribe speech to text. + */ + startTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request; + /** + * Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request. + */ + updateVocabulary(params: TranscribeService.Types.UpdateVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyResponse) => void): Request; + /** + * Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request. + */ + updateVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyResponse) => void): Request; +} +declare namespace TranscribeService { + export type Boolean = boolean; + export interface CreateVocabularyRequest { + /** + * The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive. + */ + VocabularyName: VocabularyName; + /** + * The language code of the vocabulary entries. + */ + LanguageCode: LanguageCode; + /** + * An array of strings that contains the vocabulary entries. + */ + Phrases?: Phrases; + /** + * The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> For example: https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies, see Custom Vocabularies. + */ + VocabularyFileUri?: Uri; + } + export interface CreateVocabularyResponse { + /** + * The name of the vocabulary. + */ + VocabularyName?: VocabularyName; + /** + * The language code of the vocabulary entries. + */ + LanguageCode?: LanguageCode; + /** + * The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request. + */ + VocabularyState?: VocabularyState; + /** + * The date and time that the vocabulary was created. + */ + LastModifiedTime?: DateTime; + /** + * If the VocabularyState field is FAILED, this field contains information about why the job failed. + */ + FailureReason?: FailureReason; + } + export type DateTime = Date; + export interface DeleteTranscriptionJobRequest { + /** + * The name of the transcription job to be deleted. + */ + TranscriptionJobName: TranscriptionJobName; + } + export interface DeleteVocabularyRequest { + /** + * The name of the vocabulary to delete. + */ + VocabularyName: VocabularyName; + } + export type FailureReason = string; + export interface GetTranscriptionJobRequest { + /** + * The name of the job. + */ + TranscriptionJobName: TranscriptionJobName; + } + export interface GetTranscriptionJobResponse { + /** + * An object that contains the results of the transcription job. + */ + TranscriptionJob?: TranscriptionJob; + } + export interface GetVocabularyRequest { + /** + * The name of the vocabulary to return information about. The name is case-sensitive. + */ + VocabularyName: VocabularyName; + } + export interface GetVocabularyResponse { + /** + * The name of the vocabulary to return. + */ + VocabularyName?: VocabularyName; + /** + * The language code of the vocabulary entries. + */ + LanguageCode?: LanguageCode; + /** + * The processing state of the vocabulary. + */ + VocabularyState?: VocabularyState; + /** + * The date and time that the vocabulary was last modified. + */ + LastModifiedTime?: DateTime; + /** + * If the VocabularyState field is FAILED, this field contains information about why the job failed. + */ + FailureReason?: FailureReason; + /** + * The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time. + */ + DownloadUri?: Uri; + } + export type LanguageCode = "en-US"|"es-US"|"en-AU"|"fr-CA"|"en-GB"|"de-DE"|"pt-BR"|"fr-FR"|"it-IT"|"ko-KR"|"es-ES"|string; + export interface ListTranscriptionJobsRequest { + /** + * When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date. + */ + Status?: TranscriptionJobStatus; + /** + * When specified, the jobs returned in the list are limited to jobs whose name contains the specified string. + */ + JobNameContains?: TranscriptionJobName; + /** + * If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs. + */ + NextToken?: NextToken; + /** + * The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results. + */ + MaxResults?: MaxResults; + } + export interface ListTranscriptionJobsResponse { + /** + * The requested status of the jobs returned. + */ + Status?: TranscriptionJobStatus; + /** + * The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs. + */ + NextToken?: NextToken; + /** + * A list of objects containing summary information for a transcription job. + */ + TranscriptionJobSummaries?: TranscriptionJobSummaries; + } + export interface ListVocabulariesRequest { + /** + * If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs. + */ + NextToken?: NextToken; + /** + * The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results. + */ + MaxResults?: MaxResults; + /** + * When specified, only returns vocabularies with the VocabularyState field equal to the specified state. + */ + StateEquals?: VocabularyState; + /** + * When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both "vocabularyname" and "VocabularyName" in the response list. + */ + NameContains?: VocabularyName; + } + export interface ListVocabulariesResponse { + /** + * The requested vocabulary state. + */ + Status?: TranscriptionJobStatus; + /** + * The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularies operation to return in the next page of jobs. + */ + NextToken?: NextToken; + /** + * A list of objects that describe the vocabularies that match the search criteria in the request. + */ + Vocabularies?: Vocabularies; + } + export type MaxResults = number; + export type MaxSpeakers = number; + export interface Media { + /** + * The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is: https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> For example: https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4 https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4 For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. + */ + MediaFileUri?: Uri; + } + export type MediaFormat = "mp3"|"mp4"|"wav"|"flac"|string; + export type MediaSampleRateHertz = number; + export type NextToken = string; + export type OutputBucketName = string; + export type OutputLocationType = "CUSTOMER_BUCKET"|"SERVICE_BUCKET"|string; + export type Phrase = string; + export type Phrases = Phrase[]; + export interface Settings { + /** + * The name of a vocabulary to use when processing the transcription job. + */ + VocabularyName?: VocabularyName; + /** + * Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field. You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException. + */ + ShowSpeakerLabels?: Boolean; + /** + * The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true. + */ + MaxSpeakerLabels?: MaxSpeakers; + /** + * Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription. Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription. You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException. + */ + ChannelIdentification?: Boolean; + } + export interface StartTranscriptionJobRequest { + /** + * The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account. + */ + TranscriptionJobName: TranscriptionJobName; + /** + * The language code for the language used in the input media file. + */ + LanguageCode: LanguageCode; + /** + * The sample rate, in Hertz, of the audio track in the input media file. + */ + MediaSampleRateHertz?: MediaSampleRateHertz; + /** + * The format of the input media file. + */ + MediaFormat: MediaFormat; + /** + * An object that describes the input media for a transcription job. + */ + Media: Media; + /** + * The location where the transcription is stored. If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles. Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key. If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription. + */ + OutputBucketName?: OutputBucketName; + /** + * A Settings object that provides optional settings for a transcription job. + */ + Settings?: Settings; + } + export interface StartTranscriptionJobResponse { + /** + * An object containing details of the asynchronous transcription job. + */ + TranscriptionJob?: TranscriptionJob; + } + export interface Transcript { + /** + * The location where the transcription is stored. Use this URI to access the transcription. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location. + */ + TranscriptFileUri?: Uri; + } + export interface TranscriptionJob { + /** + * The name of the transcription job. + */ + TranscriptionJobName?: TranscriptionJobName; + /** + * The status of the transcription job. + */ + TranscriptionJobStatus?: TranscriptionJobStatus; + /** + * The language code for the input speech. + */ + LanguageCode?: LanguageCode; + /** + * The sample rate, in Hertz, of the audio track in the input media file. + */ + MediaSampleRateHertz?: MediaSampleRateHertz; + /** + * The format of the input media file. + */ + MediaFormat?: MediaFormat; + /** + * An object that describes the input media for the transcription job. + */ + Media?: Media; + /** + * An object that describes the output of the transcription job. + */ + Transcript?: Transcript; + /** + * A timestamp that shows when the job was created. + */ + CreationTime?: DateTime; + /** + * A timestamp that shows when the job was completed. + */ + CompletionTime?: DateTime; + /** + * If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed. The FailureReason field can contain one of the following values: Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values. The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match. Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz. The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match. Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide. Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference. + */ + FailureReason?: FailureReason; + /** + * Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job. + */ + Settings?: Settings; + } + export type TranscriptionJobName = string; + export type TranscriptionJobStatus = "IN_PROGRESS"|"FAILED"|"COMPLETED"|string; + export type TranscriptionJobSummaries = TranscriptionJobSummary[]; + export interface TranscriptionJobSummary { + /** + * The name of the transcription job. + */ + TranscriptionJobName?: TranscriptionJobName; + /** + * A timestamp that shows when the job was created. + */ + CreationTime?: DateTime; + /** + * A timestamp that shows when the job was completed. + */ + CompletionTime?: DateTime; + /** + * The language code for the input speech. + */ + LanguageCode?: LanguageCode; + /** + * The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription. + */ + TranscriptionJobStatus?: TranscriptionJobStatus; + /** + * If the TranscriptionJobStatus field is FAILED, a description of the error. + */ + FailureReason?: FailureReason; + /** + * Indicates the location of the output of the transcription job. If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation. If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field. + */ + OutputLocationType?: OutputLocationType; + } + export interface UpdateVocabularyRequest { + /** + * The name of the vocabulary to update. The name is case-sensitive. + */ + VocabularyName: VocabularyName; + /** + * The language code of the vocabulary entries. + */ + LanguageCode: LanguageCode; + /** + * An array of strings containing the vocabulary entries. + */ + Phrases?: Phrases; + /** + * The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> For example: https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies, see Custom Vocabularies. + */ + VocabularyFileUri?: Uri; + } + export interface UpdateVocabularyResponse { + /** + * The name of the vocabulary that was updated. + */ + VocabularyName?: VocabularyName; + /** + * The language code of the vocabulary entries. + */ + LanguageCode?: LanguageCode; + /** + * The date and time that the vocabulary was updated. + */ + LastModifiedTime?: DateTime; + /** + * The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request. + */ + VocabularyState?: VocabularyState; + } + export type Uri = string; + export type Vocabularies = VocabularyInfo[]; + export interface VocabularyInfo { + /** + * The name of the vocabulary. + */ + VocabularyName?: VocabularyName; + /** + * The language code of the vocabulary entries. + */ + LanguageCode?: LanguageCode; + /** + * The date and time that the vocabulary was last modified. + */ + LastModifiedTime?: DateTime; + /** + * The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request. + */ + VocabularyState?: VocabularyState; + } + export type VocabularyName = string; + export type VocabularyState = "PENDING"|"READY"|"FAILED"|string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-10-26"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the TranscribeService client. + */ + export import Types = TranscribeService; +} +export = TranscribeService; diff --git a/node_modules/aws-sdk/clients/transcribeservice.js b/node_modules/aws-sdk/clients/transcribeservice.js new file mode 100644 index 0000000..bbb3f40 --- /dev/null +++ b/node_modules/aws-sdk/clients/transcribeservice.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['transcribeservice'] = {}; +AWS.TranscribeService = Service.defineService('transcribeservice', ['2017-10-26']); +Object.defineProperty(apiLoader.services['transcribeservice'], '2017-10-26', { + get: function get() { + var model = require('../apis/transcribe-2017-10-26.min.json'); + model.paginators = require('../apis/transcribe-2017-10-26.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.TranscribeService; diff --git a/node_modules/aws-sdk/clients/transfer.d.ts b/node_modules/aws-sdk/clients/transfer.d.ts new file mode 100644 index 0000000..be65e07 --- /dev/null +++ b/node_modules/aws-sdk/clients/transfer.d.ts @@ -0,0 +1,741 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Transfer extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Transfer.Types.ClientConfiguration) + config: Config & Transfer.Types.ClientConfiguration; + /** + * Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users. The response returns the ServerId value for the newly created server. + */ + createServer(params: Transfer.Types.CreateServerRequest, callback?: (err: AWSError, data: Transfer.Types.CreateServerResponse) => void): Request; + /** + * Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users. The response returns the ServerId value for the newly created server. + */ + createServer(callback?: (err: AWSError, data: Transfer.Types.CreateServerResponse) => void): Request; + /** + * Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. The response returns the UserName and ServerId values of the new user for that server. + */ + createUser(params: Transfer.Types.CreateUserRequest, callback?: (err: AWSError, data: Transfer.Types.CreateUserResponse) => void): Request; + /** + * Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users. The response returns the UserName and ServerId values of the new user for that server. + */ + createUser(callback?: (err: AWSError, data: Transfer.Types.CreateUserResponse) => void): Request; + /** + * Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used SERVICE_MANAGED as your IdentityProviderType, you need to delete all users associated with this server before deleting the server itself No response returns from this call. + */ + deleteServer(params: Transfer.Types.DeleteServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used SERVICE_MANAGED as your IdentityProviderType, you need to delete all users associated with this server before deleting the server itself No response returns from this call. + */ + deleteServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a user's Secure Shell (SSH) public key. No response is returned from this call. + */ + deleteSshPublicKey(params: Transfer.Types.DeleteSshPublicKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes a user's Secure Shell (SSH) public key. No response is returned from this call. + */ + deleteSshPublicKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the user belonging to the server you specify. No response returns from this call. When you delete a user from a server, the user's information is lost. + */ + deleteUser(params: Transfer.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the user belonging to the server you specify. No response returns from this call. When you delete a user from a server, the user's information is lost. + */ + deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describes the server that you specify by passing the ServerId parameter. The response contains a description of the server's properties. + */ + describeServer(params: Transfer.Types.DescribeServerRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeServerResponse) => void): Request; + /** + * Describes the server that you specify by passing the ServerId parameter. The response contains a description of the server's properties. + */ + describeServer(callback?: (err: AWSError, data: Transfer.Types.DescribeServerResponse) => void): Request; + /** + * Describes the user assigned to a specific server, as identified by its ServerId property. The response from this call returns the properties of the user associated with the ServerId value that was specified. + */ + describeUser(params: Transfer.Types.DescribeUserRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeUserResponse) => void): Request; + /** + * Describes the user assigned to a specific server, as identified by its ServerId property. The response from this call returns the properties of the user associated with the ServerId value that was specified. + */ + describeUser(callback?: (err: AWSError, data: Transfer.Types.DescribeUserResponse) => void): Request; + /** + * Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId. + */ + importSshPublicKey(params: Transfer.Types.ImportSshPublicKeyRequest, callback?: (err: AWSError, data: Transfer.Types.ImportSshPublicKeyResponse) => void): Request; + /** + * Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId. + */ + importSshPublicKey(callback?: (err: AWSError, data: Transfer.Types.ImportSshPublicKeyResponse) => void): Request; + /** + * Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account. + */ + listServers(params: Transfer.Types.ListServersRequest, callback?: (err: AWSError, data: Transfer.Types.ListServersResponse) => void): Request; + /** + * Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account. + */ + listServers(callback?: (err: AWSError, data: Transfer.Types.ListServersResponse) => void): Request; + /** + * Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role. + */ + listTagsForResource(params: Transfer.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Transfer.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role. + */ + listTagsForResource(callback?: (err: AWSError, data: Transfer.Types.ListTagsForResourceResponse) => void): Request; + /** + * Lists the users for the server that you specify by passing the ServerId parameter. + */ + listUsers(params: Transfer.Types.ListUsersRequest, callback?: (err: AWSError, data: Transfer.Types.ListUsersResponse) => void): Request; + /** + * Lists the users for the server that you specify by passing the ServerId parameter. + */ + listUsers(callback?: (err: AWSError, data: Transfer.Types.ListUsersResponse) => void): Request; + /** + * Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs. The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition. No response is returned from this call. + */ + startServer(params: Transfer.Types.StartServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs. The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition. No response is returned from this call. + */ + startServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing. The states of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition. No response is returned from this call. + */ + stopServer(params: Transfer.Types.StopServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing. The states of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition. No response is returned from this call. + */ + stopServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call. + */ + tagResource(params: Transfer.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call. + */ + tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service. + */ + testIdentityProvider(params: Transfer.Types.TestIdentityProviderRequest, callback?: (err: AWSError, data: Transfer.Types.TestIdentityProviderResponse) => void): Request; + /** + * If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service. + */ + testIdentityProvider(callback?: (err: AWSError, data: Transfer.Types.TestIdentityProviderResponse) => void): Request; + /** + * Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call. + */ + untagResource(params: Transfer.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call. + */ + untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the server properties after that server has been created. The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated. + */ + updateServer(params: Transfer.Types.UpdateServerRequest, callback?: (err: AWSError, data: Transfer.Types.UpdateServerResponse) => void): Request; + /** + * Updates the server properties after that server has been created. The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated. + */ + updateServer(callback?: (err: AWSError, data: Transfer.Types.UpdateServerResponse) => void): Request; + /** + * Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify. The response returns the ServerId and the UserName for the updated user. + */ + updateUser(params: Transfer.Types.UpdateUserRequest, callback?: (err: AWSError, data: Transfer.Types.UpdateUserResponse) => void): Request; + /** + * Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify. The response returns the ServerId and the UserName for the updated user. + */ + updateUser(callback?: (err: AWSError, data: Transfer.Types.UpdateUserResponse) => void): Request; +} +declare namespace Transfer { + export type Arn = string; + export interface CreateServerRequest { + /** + * The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. + */ + EndpointDetails?: EndpointDetails; + /** + * The type of VPC endpoint that you want your SFTP server connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet. + */ + EndpointType?: EndpointType; + /** + * The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see change-host-key in the AWS SFTP User Guide. + */ + HostKey?: HostKey; + /** + * An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method. + */ + IdentityProviderDetails?: IdentityProviderDetails; + /** + * The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice. + */ + IdentityProviderType?: IdentityProviderType; + /** + * A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes. + */ + LoggingRole?: Role; + /** + * Key-value pairs that can be used to group and search for servers. + */ + Tags?: Tags; + } + export interface CreateServerResponse { + /** + * The service-assigned ID of the SFTP server that is created. + */ + ServerId: ServerId; + } + export interface CreateUserRequest { + /** + * The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is /home/username . + */ + HomeDirectory?: HomeDirectory; + /** + * A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. + */ + Policy?: Policy; + /** + * The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests. + */ + Role: Role; + /** + * A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to. + */ + ServerId: ServerId; + /** + * The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server. + */ + SshPublicKeyBody?: SshPublicKeyBody; + /** + * Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose. + */ + Tags?: Tags; + /** + * A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen. + */ + UserName: UserName; + } + export interface CreateUserResponse { + /** + * The ID of the SFTP server that the user is attached to. + */ + ServerId: ServerId; + /** + * A unique string that identifies a user account associated with an SFTP server. + */ + UserName: UserName; + } + export type DateImported = Date; + export interface DeleteServerRequest { + /** + * A unique system-assigned identifier for an SFTP server instance. + */ + ServerId: ServerId; + } + export interface DeleteSshPublicKeyRequest { + /** + * A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it. + */ + ServerId: ServerId; + /** + * A unique identifier used to reference your user's specific SSH key. + */ + SshPublicKeyId: SshPublicKeyId; + /** + * A unique string that identifies a user whose public key is being deleted. + */ + UserName: UserName; + } + export interface DeleteUserRequest { + /** + * A system-assigned unique identifier for an SFTP server instance that has the user assigned to it. + */ + ServerId: ServerId; + /** + * A unique string that identifies a user that is being deleted from the server. + */ + UserName: UserName; + } + export interface DescribeServerRequest { + /** + * A system-assigned unique identifier for an SFTP server. + */ + ServerId: ServerId; + } + export interface DescribeServerResponse { + /** + * An array containing the properties of the server with the ServerID you specified. + */ + Server: DescribedServer; + } + export interface DescribeUserRequest { + /** + * A system-assigned unique identifier for an SFTP server that has this user assigned. + */ + ServerId: ServerId; + /** + * The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer service and perform file transfer tasks. + */ + UserName: UserName; + } + export interface DescribeUserResponse { + /** + * A system-assigned unique identifier for an SFTP server that has this user assigned. + */ + ServerId: ServerId; + /** + * An array containing the properties of the user account for the ServerID value that you specified. + */ + User: DescribedUser; + } + export interface DescribedServer { + /** + * Specifies the unique Amazon Resource Name (ARN) for the server to be described. + */ + Arn: Arn; + /** + * The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server. + */ + EndpointDetails?: EndpointDetails; + /** + * The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet. + */ + EndpointType?: EndpointType; + /** + * This value contains the Message-Digest Algorithm (MD5) hash of the server's host key. This value is equivalent to the output of ssh-keygen -l -E md5 -f my-new-server-key command. + */ + HostKeyFingerprint?: HostKeyFingerprint; + /** + * Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>. + */ + IdentityProviderDetails?: IdentityProviderDetails; + /** + * This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service. + */ + IdentityProviderType?: IdentityProviderType; + /** + * This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs. + */ + LoggingRole?: Role; + /** + * This property is a unique system assigned identifier for the SFTP server that you instantiate. + */ + ServerId?: ServerId; + /** + * The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition. + */ + State?: State; + /** + * This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described. + */ + Tags?: Tags; + /** + * The number of users that are assigned to the SFTP server you specified with the ServerId. + */ + UserCount?: UserCount; + } + export interface DescribedUser { + /** + * This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described. + */ + Arn: Arn; + /** + * This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: /bucket_name/home/username . + */ + HomeDirectory?: HomeDirectory; + /** + * Specifies the name of the policy in use for the described user. + */ + Policy?: Policy; + /** + * This property specifies the IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests. + */ + Role?: Role; + /** + * This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user. + */ + SshPublicKeys?: SshPublicKeys; + /** + * This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes. + */ + Tags?: Tags; + /** + * This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server. + */ + UserName?: UserName; + } + export interface EndpointDetails { + /** + * The ID of the VPC endpoint. + */ + VpcEndpointId?: VpcEndpointId; + } + export type EndpointType = "PUBLIC"|"VPC_ENDPOINT"|string; + export type HomeDirectory = string; + export type HostKey = string; + export type HostKeyFingerprint = string; + export interface IdentityProviderDetails { + /** + * The IdentityProviderDetail parameter contains the location of the service endpoint used to authenticate users. + */ + Url?: Url; + /** + * The Role parameter provides the type of InvocationRole used to authenticate the user account. + */ + InvocationRole?: Role; + } + export type IdentityProviderType = "SERVICE_MANAGED"|"API_GATEWAY"|string; + export interface ImportSshPublicKeyRequest { + /** + * A system-assigned unique identifier for an SFTP server. + */ + ServerId: ServerId; + /** + * The public key portion of an SSH key pair. + */ + SshPublicKeyBody: SshPublicKeyBody; + /** + * The name of the user account that is assigned to one or more servers. + */ + UserName: UserName; + } + export interface ImportSshPublicKeyResponse { + /** + * A system-assigned unique identifier for an SFTP server. + */ + ServerId: ServerId; + /** + * This identifier is the name given to a public key by the system that was imported. + */ + SshPublicKeyId: SshPublicKeyId; + /** + * A user name assigned to the ServerID value that you specified. + */ + UserName: UserName; + } + export interface ListServersRequest { + /** + * Specifies the number of servers to return as a response to the ListServers query. + */ + MaxResults?: MaxResults; + /** + * When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers. + */ + NextToken?: NextToken; + } + export interface ListServersResponse { + /** + * When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers. + */ + NextToken?: NextToken; + /** + * An array of servers that were listed. + */ + Servers: ListedServers; + } + export interface ListTagsForResourceRequest { + /** + * Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role. + */ + Arn: Arn; + /** + * Specifies the number of tags to return as a response to the ListTagsForResource request. + */ + MaxResults?: MaxResults; + /** + * When you request additional results from the ListTagsForResource call, a NextToken parameter is returned in the input. You can then pass in a subsequent command the NextToken parameter to continue listing additional tags. + */ + NextToken?: NextToken; + } + export interface ListTagsForResourceResponse { + /** + * This value is the ARN you specified to list the tags of. + */ + Arn?: Arn; + /** + * When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional tags. + */ + NextToken?: NextToken; + /** + * Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define that you can use for any purpose. + */ + Tags?: Tags; + } + export interface ListUsersRequest { + /** + * Specifies the number of users to return as a response to the ListUsers request. + */ + MaxResults?: MaxResults; + /** + * When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional users. + */ + NextToken?: NextToken; + /** + * A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it. + */ + ServerId: ServerId; + } + export interface ListUsersResponse { + /** + * When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional users. + */ + NextToken?: NextToken; + /** + * A system-assigned unique identifier for an SFTP server that the users are assigned to. + */ + ServerId: ServerId; + /** + * Returns the user accounts and their properties for the ServerId value that you specify. + */ + Users: ListedUsers; + } + export interface ListedServer { + /** + * The unique Amazon Resource Name (ARN) for the server to be listed. + */ + Arn: Arn; + /** + * The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY. + */ + IdentityProviderType?: IdentityProviderType; + /** + * The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet. + */ + EndpointType?: EndpointType; + /** + * The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging. + */ + LoggingRole?: Role; + /** + * This value is the unique system assigned identifier for the SFTP servers that were listed. + */ + ServerId?: ServerId; + /** + * This property describes the condition of the SFTP server for the server that was described. A value of ONLINE> indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition. + */ + State?: State; + /** + * This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId. + */ + UserCount?: UserCount; + } + export type ListedServers = ListedServer[]; + export interface ListedUser { + /** + * This property is the unique Amazon Resource Name (ARN) for the user that you wish to learn about. + */ + Arn: Arn; + /** + * This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN. + */ + HomeDirectory?: HomeDirectory; + /** + * The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that in this case allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket. + */ + Role?: Role; + /** + * This value is the number of SSH public keys stored for the user you specified. + */ + SshPublicKeyCount?: SshPublicKeyCount; + /** + * The name of the user whose ARN was specified. User names are used for authentication purposes. + */ + UserName?: UserName; + } + export type ListedUsers = ListedUser[]; + export type MaxResults = number; + export type Message = string; + export type NextToken = string; + export type NullableRole = string; + export type Policy = string; + export type Role = string; + export type ServerId = string; + export interface SshPublicKey { + /** + * The date that the public key was added to the user account. + */ + DateImported: DateImported; + /** + * The content of the SSH public key as specified by the PublicKeyId. + */ + SshPublicKeyBody: SshPublicKeyBody; + /** + * The SshPublicKeyId parameter contains the identifier of the public key. + */ + SshPublicKeyId: SshPublicKeyId; + } + export type SshPublicKeyBody = string; + export type SshPublicKeyCount = number; + export type SshPublicKeyId = string; + export type SshPublicKeys = SshPublicKey[]; + export interface StartServerRequest { + /** + * A system-assigned unique identifier for an SFTP server that you start. + */ + ServerId: ServerId; + } + export type State = "OFFLINE"|"ONLINE"|"STARTING"|"STOPPING"|"START_FAILED"|"STOP_FAILED"|string; + export type StatusCode = number; + export interface StopServerRequest { + /** + * A system-assigned unique identifier for an SFTP server that you stopped. + */ + ServerId: ServerId; + } + export interface Tag { + /** + * The name assigned to the tag that you create. + */ + Key: TagKey; + /** + * This property contains one or more values that you assigned to the key name you create. + */ + Value: TagValue; + } + export type TagKey = string; + export type TagKeys = TagKey[]; + export interface TagResourceRequest { + /** + * An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role. + */ + Arn: Arn; + /** + * Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose. + */ + Tags: Tags; + } + export type TagValue = string; + export type Tags = Tag[]; + export interface TestIdentityProviderRequest { + /** + * A system assigned identifier for a specific server. That server's user authentication method is tested with a user name and password. + */ + ServerId: ServerId; + /** + * This request parameter is name of the user account to be tested. + */ + UserName: UserName; + /** + * The password of the user account to be tested. + */ + UserPassword?: UserPassword; + } + export interface TestIdentityProviderResponse { + /** + * The result of the authorization test as a message. + */ + Message?: Message; + /** + * The HTTP status code that is the response from your API Gateway. + */ + StatusCode: StatusCode; + /** + * The endpoint of the service used to authenticate a user. + */ + Url: Url; + } + export interface UntagResourceRequest { + /** + * This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role. + */ + Arn: Arn; + /** + * TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose. + */ + TagKeys: TagKeys; + } + export interface UpdateServerRequest { + /** + * The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet. + */ + EndpointDetails?: EndpointDetails; + /** + * The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet. + */ + EndpointType?: EndpointType; + /** + * The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see change-host-key in the AWS SFTP User Guide. + */ + HostKey?: HostKey; + /** + * This response parameter is an array containing all of the information required to call a customer's authentication API method. + */ + IdentityProviderDetails?: IdentityProviderDetails; + /** + * A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off. + */ + LoggingRole?: NullableRole; + /** + * A system-assigned unique identifier for an SFTP server instance that the user account is assigned to. + */ + ServerId: ServerId; + } + export interface UpdateServerResponse { + /** + * A system-assigned unique identifier for an SFTP server that the user account is assigned to. + */ + ServerId: ServerId; + } + export interface UpdateUserRequest { + /** + * The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: /home/username . + */ + HomeDirectory?: HomeDirectory; + /** + * Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. + */ + Policy?: Policy; + /** + * The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests. + */ + Role?: Role; + /** + * A system-assigned unique identifier for an SFTP server instance that the user account is assigned to. + */ + ServerId: ServerId; + /** + * A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen. + */ + UserName: UserName; + } + export interface UpdateUserResponse { + /** + * A system-assigned unique identifier for an SFTP server instance that the user account is assigned to. + */ + ServerId: ServerId; + /** + * The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request. + */ + UserName: UserName; + } + export type Url = string; + export type UserCount = number; + export type UserName = string; + export type UserPassword = string; + export type VpcEndpointId = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-11-05"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Transfer client. + */ + export import Types = Transfer; +} +export = Transfer; diff --git a/node_modules/aws-sdk/clients/transfer.js b/node_modules/aws-sdk/clients/transfer.js new file mode 100644 index 0000000..30ffc65 --- /dev/null +++ b/node_modules/aws-sdk/clients/transfer.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['transfer'] = {}; +AWS.Transfer = Service.defineService('transfer', ['2018-11-05']); +Object.defineProperty(apiLoader.services['transfer'], '2018-11-05', { + get: function get() { + var model = require('../apis/transfer-2018-11-05.min.json'); + model.paginators = require('../apis/transfer-2018-11-05.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Transfer; diff --git a/node_modules/aws-sdk/clients/translate.d.ts b/node_modules/aws-sdk/clients/translate.d.ts new file mode 100644 index 0000000..86723e3 --- /dev/null +++ b/node_modules/aws-sdk/clients/translate.d.ts @@ -0,0 +1,294 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class Translate extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: Translate.Types.ClientConfiguration) + config: Config & Translate.Types.ClientConfiguration; + /** + * A synchronous action that deletes a custom terminology. + */ + deleteTerminology(params: Translate.Types.DeleteTerminologyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * A synchronous action that deletes a custom terminology. + */ + deleteTerminology(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Retrieves a custom terminology. + */ + getTerminology(params: Translate.Types.GetTerminologyRequest, callback?: (err: AWSError, data: Translate.Types.GetTerminologyResponse) => void): Request; + /** + * Retrieves a custom terminology. + */ + getTerminology(callback?: (err: AWSError, data: Translate.Types.GetTerminologyResponse) => void): Request; + /** + * Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name. If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations. + */ + importTerminology(params: Translate.Types.ImportTerminologyRequest, callback?: (err: AWSError, data: Translate.Types.ImportTerminologyResponse) => void): Request; + /** + * Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name. If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations. + */ + importTerminology(callback?: (err: AWSError, data: Translate.Types.ImportTerminologyResponse) => void): Request; + /** + * Provides a list of custom terminologies associated with your account. + */ + listTerminologies(params: Translate.Types.ListTerminologiesRequest, callback?: (err: AWSError, data: Translate.Types.ListTerminologiesResponse) => void): Request; + /** + * Provides a list of custom terminologies associated with your account. + */ + listTerminologies(callback?: (err: AWSError, data: Translate.Types.ListTerminologiesResponse) => void): Request; + /** + * Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs. Arabic (ar) Chinese (Simplified) (zh) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (en) Finnish (fi) French (fr) German (de) Hebrew (he) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Polish (pl) Portuguese (pt) Russian (ru) Spanish (es) Swedish (sv) Turkish (tr) To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language. + */ + translateText(params: Translate.Types.TranslateTextRequest, callback?: (err: AWSError, data: Translate.Types.TranslateTextResponse) => void): Request; + /** + * Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs. Arabic (ar) Chinese (Simplified) (zh) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (en) Finnish (fi) French (fr) German (de) Hebrew (he) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Polish (pl) Portuguese (pt) Russian (ru) Spanish (es) Swedish (sv) Turkish (tr) To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language. + */ + translateText(callback?: (err: AWSError, data: Translate.Types.TranslateTextResponse) => void): Request; +} +declare namespace Translate { + export interface AppliedTerminology { + /** + * The name of the custom terminology applied to the input text by Amazon Translate for the translated text response. + */ + Name?: ResourceName; + /** + * The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text. + */ + Terms?: TermList; + } + export type AppliedTerminologyList = AppliedTerminology[]; + export type BoundedLengthString = string; + export interface DeleteTerminologyRequest { + /** + * The name of the custom terminology being deleted. + */ + Name: ResourceName; + } + export type Description = string; + export interface EncryptionKey { + /** + * The type of encryption key used by Amazon Translate to encrypt custom terminologies. + */ + Type: EncryptionKeyType; + /** + * The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology. + */ + Id: EncryptionKeyID; + } + export type EncryptionKeyID = string; + export type EncryptionKeyType = "KMS"|string; + export interface GetTerminologyRequest { + /** + * The name of the custom terminology being retrieved. + */ + Name: ResourceName; + /** + * The data format of the custom terminology being retrieved, either CSV or TMX. + */ + TerminologyDataFormat: TerminologyDataFormat; + } + export interface GetTerminologyResponse { + /** + * The properties of the custom terminology being retrieved. + */ + TerminologyProperties?: TerminologyProperties; + /** + * The data location of the custom terminology being retrieved. The custom terminology file is returned in a presigned url that has a 30 minute expiration. + */ + TerminologyDataLocation?: TerminologyDataLocation; + } + export interface ImportTerminologyRequest { + /** + * The name of the custom terminology being imported. + */ + Name: ResourceName; + /** + * The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name. + */ + MergeStrategy: MergeStrategy; + /** + * The description of the custom terminology being imported. + */ + Description?: Description; + /** + * The terminology data for the custom terminology being imported. + */ + TerminologyData: TerminologyData; + /** + * The encryption key for the custom terminology being imported. + */ + EncryptionKey?: EncryptionKey; + } + export interface ImportTerminologyResponse { + /** + * The properties of the custom terminology being imported. + */ + TerminologyProperties?: TerminologyProperties; + } + export type Integer = number; + export type LanguageCodeString = string; + export type LanguageCodeStringList = LanguageCodeString[]; + export interface ListTerminologiesRequest { + /** + * If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies. + */ + NextToken?: NextToken; + /** + * The maximum number of custom terminologies returned per list request. + */ + MaxResults?: MaxResultsInteger; + } + export interface ListTerminologiesResponse { + /** + * The properties list of the custom terminologies returned on the list request. + */ + TerminologyPropertiesList?: TerminologyPropertiesList; + /** + * If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies. + */ + NextToken?: NextToken; + } + export type MaxResultsInteger = number; + export type MergeStrategy = "OVERWRITE"|string; + export type NextToken = string; + export type ResourceName = string; + export type ResourceNameList = ResourceName[]; + export type String = string; + export interface Term { + /** + * The source text of the term being translated by the custom terminology. + */ + SourceText?: String; + /** + * The target text of the term being translated by the custom terminology. + */ + TargetText?: String; + } + export type TermList = Term[]; + export type TerminologyArn = string; + export interface TerminologyData { + /** + * The file containing the custom terminology data. + */ + File: TerminologyFile; + /** + * The data format of the custom terminology. Either CSV or TMX. + */ + Format: TerminologyDataFormat; + } + export type TerminologyDataFormat = "CSV"|"TMX"|string; + export interface TerminologyDataLocation { + /** + * The repository type for the custom terminology data. + */ + RepositoryType: String; + /** + * The location of the custom terminology data. + */ + Location: String; + } + export type TerminologyFile = Buffer|Uint8Array|Blob|string; + export interface TerminologyProperties { + /** + * The name of the custom terminology. + */ + Name?: ResourceName; + /** + * The description of the custom terminology properties. + */ + Description?: Description; + /** + * The Amazon Resource Name (ARN) of the custom terminology. + */ + Arn?: TerminologyArn; + /** + * The language code for the source text of the translation request for which the custom terminology is being used. + */ + SourceLanguageCode?: LanguageCodeString; + /** + * The language codes for the target languages available with the custom terminology file. All possible target languages are returned in array. + */ + TargetLanguageCodes?: LanguageCodeStringList; + /** + * The encryption key for the custom terminology. + */ + EncryptionKey?: EncryptionKey; + /** + * The size of the file used when importing a custom terminology. + */ + SizeBytes?: Integer; + /** + * The number of terms included in the custom terminology. + */ + TermCount?: Integer; + /** + * The time at which the custom terminology was created, based on the timestamp. + */ + CreatedAt?: Timestamp; + /** + * The time at which the custom terminology was last update, based on the timestamp. + */ + LastUpdatedAt?: Timestamp; + } + export type TerminologyPropertiesList = TerminologyProperties[]; + export type Timestamp = Date; + export interface TranslateTextRequest { + /** + * The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters. + */ + Text: BoundedLengthString; + /** + * The TerminologyNames list that is taken as input to the TranslateText request. This has a minimum length of 0 and a maximum length of 1. + */ + TerminologyNames?: ResourceNameList; + /** + * The language code for the language of the source text. The language must be a language supported by Amazon Translate. To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language. + */ + SourceLanguageCode: LanguageCodeString; + /** + * The language code requested for the language of the target text. The language must be a language supported by Amazon Translate. + */ + TargetLanguageCode: LanguageCodeString; + } + export interface TranslateTextResponse { + /** + * The the translated text. The maximum length of this text is 5kb. + */ + TranslatedText: String; + /** + * The language code for the language of the source text. + */ + SourceLanguageCode: LanguageCodeString; + /** + * The language code for the language of the target text. + */ + TargetLanguageCode: LanguageCodeString; + /** + * The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response. + */ + AppliedTerminologies?: AppliedTerminologyList; + } + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-07-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the Translate client. + */ + export import Types = Translate; +} +export = Translate; diff --git a/node_modules/aws-sdk/clients/translate.js b/node_modules/aws-sdk/clients/translate.js new file mode 100644 index 0000000..179b056 --- /dev/null +++ b/node_modules/aws-sdk/clients/translate.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['translate'] = {}; +AWS.Translate = Service.defineService('translate', ['2017-07-01']); +Object.defineProperty(apiLoader.services['translate'], '2017-07-01', { + get: function get() { + var model = require('../apis/translate-2017-07-01.min.json'); + model.paginators = require('../apis/translate-2017-07-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.Translate; diff --git a/node_modules/aws-sdk/clients/waf.d.ts b/node_modules/aws-sdk/clients/waf.d.ts new file mode 100644 index 0000000..6aeefb7 --- /dev/null +++ b/node_modules/aws-sdk/clients/waf.d.ts @@ -0,0 +1,2661 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class WAF extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: WAF.Types.ClientConfiguration) + config: Config & WAF.Types.ClientConfiguration; + /** + * Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createByteMatchSet(params: WAF.Types.CreateByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateByteMatchSetResponse) => void): Request; + /** + * Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createByteMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateByteMatchSetResponse) => void): Request; + /** + * Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createGeoMatchSet(params: WAF.Types.CreateGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateGeoMatchSetResponse) => void): Request; + /** + * Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateGeoMatchSetResponse) => void): Request; + /** + * Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createIPSet(params: WAF.Types.CreateIPSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateIPSetResponse) => void): Request; + /** + * Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createIPSet(callback?: (err: AWSError, data: WAF.Types.CreateIPSetResponse) => void): Request; + /** + * Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRateBasedRule(params: WAF.Types.CreateRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.CreateRateBasedRuleResponse) => void): Request; + /** + * Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRateBasedRule(callback?: (err: AWSError, data: WAF.Types.CreateRateBasedRuleResponse) => void): Request; + /** + * Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexMatchSet(params: WAF.Types.CreateRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateRegexMatchSetResponse) => void): Request; + /** + * Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateRegexMatchSetResponse) => void): Request; + /** + * Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexPatternSet(params: WAF.Types.CreateRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateRegexPatternSetResponse) => void): Request; + /** + * Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.CreateRegexPatternSetResponse) => void): Request; + /** + * Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRule(params: WAF.Types.CreateRuleRequest, callback?: (err: AWSError, data: WAF.Types.CreateRuleResponse) => void): Request; + /** + * Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRule(callback?: (err: AWSError, data: WAF.Types.CreateRuleResponse) => void): Request; + /** + * Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRuleGroup(params: WAF.Types.CreateRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.CreateRuleGroupResponse) => void): Request; + /** + * Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRuleGroup(callback?: (err: AWSError, data: WAF.Types.CreateRuleGroupResponse) => void): Request; + /** + * Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSizeConstraintSet(params: WAF.Types.CreateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateSizeConstraintSetResponse) => void): Request; + /** + * Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.CreateSizeConstraintSetResponse) => void): Request; + /** + * Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSqlInjectionMatchSet(params: WAF.Types.CreateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateSqlInjectionMatchSetResponse) => void): Request; + /** + * Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateSqlInjectionMatchSetResponse) => void): Request; + /** + * Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide. + */ + createWebACL(params: WAF.Types.CreateWebACLRequest, callback?: (err: AWSError, data: WAF.Types.CreateWebACLResponse) => void): Request; + /** + * Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide. + */ + createWebACL(callback?: (err: AWSError, data: WAF.Types.CreateWebACLResponse) => void): Request; + /** + * Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createXssMatchSet(params: WAF.Types.CreateXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateXssMatchSetResponse) => void): Request; + /** + * Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createXssMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateXssMatchSetResponse) => void): Request; + /** + * Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request. + */ + deleteByteMatchSet(params: WAF.Types.DeleteByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteByteMatchSetResponse) => void): Request; + /** + * Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request. + */ + deleteByteMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteByteMatchSetResponse) => void): Request; + /** + * Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request. + */ + deleteGeoMatchSet(params: WAF.Types.DeleteGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteGeoMatchSetResponse) => void): Request; + /** + * Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request. + */ + deleteGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteGeoMatchSetResponse) => void): Request; + /** + * Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request. + */ + deleteIPSet(params: WAF.Types.DeleteIPSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteIPSetResponse) => void): Request; + /** + * Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request. + */ + deleteIPSet(callback?: (err: AWSError, data: WAF.Types.DeleteIPSetResponse) => void): Request; + /** + * Permanently deletes the LoggingConfiguration from the specified web ACL. + */ + deleteLoggingConfiguration(params: WAF.Types.DeleteLoggingConfigurationRequest, callback?: (err: AWSError, data: WAF.Types.DeleteLoggingConfigurationResponse) => void): Request; + /** + * Permanently deletes the LoggingConfiguration from the specified web ACL. + */ + deleteLoggingConfiguration(callback?: (err: AWSError, data: WAF.Types.DeleteLoggingConfigurationResponse) => void): Request; + /** + * Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup. + */ + deletePermissionPolicy(params: WAF.Types.DeletePermissionPolicyRequest, callback?: (err: AWSError, data: WAF.Types.DeletePermissionPolicyResponse) => void): Request; + /** + * Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup. + */ + deletePermissionPolicy(callback?: (err: AWSError, data: WAF.Types.DeletePermissionPolicyResponse) => void): Request; + /** + * Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request. + */ + deleteRateBasedRule(params: WAF.Types.DeleteRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRateBasedRuleResponse) => void): Request; + /** + * Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request. + */ + deleteRateBasedRule(callback?: (err: AWSError, data: WAF.Types.DeleteRateBasedRuleResponse) => void): Request; + /** + * Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request. + */ + deleteRegexMatchSet(params: WAF.Types.DeleteRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRegexMatchSetResponse) => void): Request; + /** + * Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request. + */ + deleteRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteRegexMatchSetResponse) => void): Request; + /** + * Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty. + */ + deleteRegexPatternSet(params: WAF.Types.DeleteRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRegexPatternSetResponse) => void): Request; + /** + * Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty. + */ + deleteRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.DeleteRegexPatternSetResponse) => void): Request; + /** + * Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request. + */ + deleteRule(params: WAF.Types.DeleteRuleRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRuleResponse) => void): Request; + /** + * Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request. + */ + deleteRule(callback?: (err: AWSError, data: WAF.Types.DeleteRuleResponse) => void): Request; + /** + * Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request. + */ + deleteRuleGroup(params: WAF.Types.DeleteRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRuleGroupResponse) => void): Request; + /** + * Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request. + */ + deleteRuleGroup(callback?: (err: AWSError, data: WAF.Types.DeleteRuleGroupResponse) => void): Request; + /** + * Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request. + */ + deleteSizeConstraintSet(params: WAF.Types.DeleteSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteSizeConstraintSetResponse) => void): Request; + /** + * Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request. + */ + deleteSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.DeleteSizeConstraintSetResponse) => void): Request; + /** + * Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request. + */ + deleteSqlInjectionMatchSet(params: WAF.Types.DeleteSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteSqlInjectionMatchSetResponse) => void): Request; + /** + * Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request. + */ + deleteSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteSqlInjectionMatchSetResponse) => void): Request; + /** + * Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request. + */ + deleteWebACL(params: WAF.Types.DeleteWebACLRequest, callback?: (err: AWSError, data: WAF.Types.DeleteWebACLResponse) => void): Request; + /** + * Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request. + */ + deleteWebACL(callback?: (err: AWSError, data: WAF.Types.DeleteWebACLResponse) => void): Request; + /** + * Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request. + */ + deleteXssMatchSet(params: WAF.Types.DeleteXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteXssMatchSetResponse) => void): Request; + /** + * Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request. + */ + deleteXssMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteXssMatchSetResponse) => void): Request; + /** + * Returns the ByteMatchSet specified by ByteMatchSetId. + */ + getByteMatchSet(params: WAF.Types.GetByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetByteMatchSetResponse) => void): Request; + /** + * Returns the ByteMatchSet specified by ByteMatchSetId. + */ + getByteMatchSet(callback?: (err: AWSError, data: WAF.Types.GetByteMatchSetResponse) => void): Request; + /** + * When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token. + */ + getChangeToken(params: WAF.Types.GetChangeTokenRequest, callback?: (err: AWSError, data: WAF.Types.GetChangeTokenResponse) => void): Request; + /** + * When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token. + */ + getChangeToken(callback?: (err: AWSError, data: WAF.Types.GetChangeTokenResponse) => void): Request; + /** + * Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete. + */ + getChangeTokenStatus(params: WAF.Types.GetChangeTokenStatusRequest, callback?: (err: AWSError, data: WAF.Types.GetChangeTokenStatusResponse) => void): Request; + /** + * Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete. + */ + getChangeTokenStatus(callback?: (err: AWSError, data: WAF.Types.GetChangeTokenStatusResponse) => void): Request; + /** + * Returns the GeoMatchSet that is specified by GeoMatchSetId. + */ + getGeoMatchSet(params: WAF.Types.GetGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetGeoMatchSetResponse) => void): Request; + /** + * Returns the GeoMatchSet that is specified by GeoMatchSetId. + */ + getGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.GetGeoMatchSetResponse) => void): Request; + /** + * Returns the IPSet that is specified by IPSetId. + */ + getIPSet(params: WAF.Types.GetIPSetRequest, callback?: (err: AWSError, data: WAF.Types.GetIPSetResponse) => void): Request; + /** + * Returns the IPSet that is specified by IPSetId. + */ + getIPSet(callback?: (err: AWSError, data: WAF.Types.GetIPSetResponse) => void): Request; + /** + * Returns the LoggingConfiguration for the specified web ACL. + */ + getLoggingConfiguration(params: WAF.Types.GetLoggingConfigurationRequest, callback?: (err: AWSError, data: WAF.Types.GetLoggingConfigurationResponse) => void): Request; + /** + * Returns the LoggingConfiguration for the specified web ACL. + */ + getLoggingConfiguration(callback?: (err: AWSError, data: WAF.Types.GetLoggingConfigurationResponse) => void): Request; + /** + * Returns the IAM policy attached to the RuleGroup. + */ + getPermissionPolicy(params: WAF.Types.GetPermissionPolicyRequest, callback?: (err: AWSError, data: WAF.Types.GetPermissionPolicyResponse) => void): Request; + /** + * Returns the IAM policy attached to the RuleGroup. + */ + getPermissionPolicy(callback?: (err: AWSError, data: WAF.Types.GetPermissionPolicyResponse) => void): Request; + /** + * Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request. + */ + getRateBasedRule(params: WAF.Types.GetRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleResponse) => void): Request; + /** + * Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request. + */ + getRateBasedRule(callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleResponse) => void): Request; + /** + * Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked. + */ + getRateBasedRuleManagedKeys(params: WAF.Types.GetRateBasedRuleManagedKeysRequest, callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleManagedKeysResponse) => void): Request; + /** + * Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked. + */ + getRateBasedRuleManagedKeys(callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleManagedKeysResponse) => void): Request; + /** + * Returns the RegexMatchSet specified by RegexMatchSetId. + */ + getRegexMatchSet(params: WAF.Types.GetRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetRegexMatchSetResponse) => void): Request; + /** + * Returns the RegexMatchSet specified by RegexMatchSetId. + */ + getRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.GetRegexMatchSetResponse) => void): Request; + /** + * Returns the RegexPatternSet specified by RegexPatternSetId. + */ + getRegexPatternSet(params: WAF.Types.GetRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.GetRegexPatternSetResponse) => void): Request; + /** + * Returns the RegexPatternSet specified by RegexPatternSetId. + */ + getRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.GetRegexPatternSetResponse) => void): Request; + /** + * Returns the Rule that is specified by the RuleId that you included in the GetRule request. + */ + getRule(params: WAF.Types.GetRuleRequest, callback?: (err: AWSError, data: WAF.Types.GetRuleResponse) => void): Request; + /** + * Returns the Rule that is specified by the RuleId that you included in the GetRule request. + */ + getRule(callback?: (err: AWSError, data: WAF.Types.GetRuleResponse) => void): Request; + /** + * Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup. + */ + getRuleGroup(params: WAF.Types.GetRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.GetRuleGroupResponse) => void): Request; + /** + * Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup. + */ + getRuleGroup(callback?: (err: AWSError, data: WAF.Types.GetRuleGroupResponse) => void): Request; + /** + * Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. + */ + getSampledRequests(params: WAF.Types.GetSampledRequestsRequest, callback?: (err: AWSError, data: WAF.Types.GetSampledRequestsResponse) => void): Request; + /** + * Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. + */ + getSampledRequests(callback?: (err: AWSError, data: WAF.Types.GetSampledRequestsResponse) => void): Request; + /** + * Returns the SizeConstraintSet specified by SizeConstraintSetId. + */ + getSizeConstraintSet(params: WAF.Types.GetSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.GetSizeConstraintSetResponse) => void): Request; + /** + * Returns the SizeConstraintSet specified by SizeConstraintSetId. + */ + getSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.GetSizeConstraintSetResponse) => void): Request; + /** + * Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. + */ + getSqlInjectionMatchSet(params: WAF.Types.GetSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetSqlInjectionMatchSetResponse) => void): Request; + /** + * Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. + */ + getSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.GetSqlInjectionMatchSetResponse) => void): Request; + /** + * Returns the WebACL that is specified by WebACLId. + */ + getWebACL(params: WAF.Types.GetWebACLRequest, callback?: (err: AWSError, data: WAF.Types.GetWebACLResponse) => void): Request; + /** + * Returns the WebACL that is specified by WebACLId. + */ + getWebACL(callback?: (err: AWSError, data: WAF.Types.GetWebACLResponse) => void): Request; + /** + * Returns the XssMatchSet that is specified by XssMatchSetId. + */ + getXssMatchSet(params: WAF.Types.GetXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetXssMatchSetResponse) => void): Request; + /** + * Returns the XssMatchSet that is specified by XssMatchSetId. + */ + getXssMatchSet(callback?: (err: AWSError, data: WAF.Types.GetXssMatchSetResponse) => void): Request; + /** + * Returns an array of ActivatedRule objects. + */ + listActivatedRulesInRuleGroup(params: WAF.Types.ListActivatedRulesInRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.ListActivatedRulesInRuleGroupResponse) => void): Request; + /** + * Returns an array of ActivatedRule objects. + */ + listActivatedRulesInRuleGroup(callback?: (err: AWSError, data: WAF.Types.ListActivatedRulesInRuleGroupResponse) => void): Request; + /** + * Returns an array of ByteMatchSetSummary objects. + */ + listByteMatchSets(params: WAF.Types.ListByteMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListByteMatchSetsResponse) => void): Request; + /** + * Returns an array of ByteMatchSetSummary objects. + */ + listByteMatchSets(callback?: (err: AWSError, data: WAF.Types.ListByteMatchSetsResponse) => void): Request; + /** + * Returns an array of GeoMatchSetSummary objects in the response. + */ + listGeoMatchSets(params: WAF.Types.ListGeoMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListGeoMatchSetsResponse) => void): Request; + /** + * Returns an array of GeoMatchSetSummary objects in the response. + */ + listGeoMatchSets(callback?: (err: AWSError, data: WAF.Types.ListGeoMatchSetsResponse) => void): Request; + /** + * Returns an array of IPSetSummary objects in the response. + */ + listIPSets(params: WAF.Types.ListIPSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListIPSetsResponse) => void): Request; + /** + * Returns an array of IPSetSummary objects in the response. + */ + listIPSets(callback?: (err: AWSError, data: WAF.Types.ListIPSetsResponse) => void): Request; + /** + * Returns an array of LoggingConfiguration objects. + */ + listLoggingConfigurations(params: WAF.Types.ListLoggingConfigurationsRequest, callback?: (err: AWSError, data: WAF.Types.ListLoggingConfigurationsResponse) => void): Request; + /** + * Returns an array of LoggingConfiguration objects. + */ + listLoggingConfigurations(callback?: (err: AWSError, data: WAF.Types.ListLoggingConfigurationsResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRateBasedRules(params: WAF.Types.ListRateBasedRulesRequest, callback?: (err: AWSError, data: WAF.Types.ListRateBasedRulesResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRateBasedRules(callback?: (err: AWSError, data: WAF.Types.ListRateBasedRulesResponse) => void): Request; + /** + * Returns an array of RegexMatchSetSummary objects. + */ + listRegexMatchSets(params: WAF.Types.ListRegexMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListRegexMatchSetsResponse) => void): Request; + /** + * Returns an array of RegexMatchSetSummary objects. + */ + listRegexMatchSets(callback?: (err: AWSError, data: WAF.Types.ListRegexMatchSetsResponse) => void): Request; + /** + * Returns an array of RegexPatternSetSummary objects. + */ + listRegexPatternSets(params: WAF.Types.ListRegexPatternSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListRegexPatternSetsResponse) => void): Request; + /** + * Returns an array of RegexPatternSetSummary objects. + */ + listRegexPatternSets(callback?: (err: AWSError, data: WAF.Types.ListRegexPatternSetsResponse) => void): Request; + /** + * Returns an array of RuleGroup objects. + */ + listRuleGroups(params: WAF.Types.ListRuleGroupsRequest, callback?: (err: AWSError, data: WAF.Types.ListRuleGroupsResponse) => void): Request; + /** + * Returns an array of RuleGroup objects. + */ + listRuleGroups(callback?: (err: AWSError, data: WAF.Types.ListRuleGroupsResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRules(params: WAF.Types.ListRulesRequest, callback?: (err: AWSError, data: WAF.Types.ListRulesResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRules(callback?: (err: AWSError, data: WAF.Types.ListRulesResponse) => void): Request; + /** + * Returns an array of SizeConstraintSetSummary objects. + */ + listSizeConstraintSets(params: WAF.Types.ListSizeConstraintSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListSizeConstraintSetsResponse) => void): Request; + /** + * Returns an array of SizeConstraintSetSummary objects. + */ + listSizeConstraintSets(callback?: (err: AWSError, data: WAF.Types.ListSizeConstraintSetsResponse) => void): Request; + /** + * Returns an array of SqlInjectionMatchSet objects. + */ + listSqlInjectionMatchSets(params: WAF.Types.ListSqlInjectionMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListSqlInjectionMatchSetsResponse) => void): Request; + /** + * Returns an array of SqlInjectionMatchSet objects. + */ + listSqlInjectionMatchSets(callback?: (err: AWSError, data: WAF.Types.ListSqlInjectionMatchSetsResponse) => void): Request; + /** + * Returns an array of RuleGroup objects that you are subscribed to. + */ + listSubscribedRuleGroups(params: WAF.Types.ListSubscribedRuleGroupsRequest, callback?: (err: AWSError, data: WAF.Types.ListSubscribedRuleGroupsResponse) => void): Request; + /** + * Returns an array of RuleGroup objects that you are subscribed to. + */ + listSubscribedRuleGroups(callback?: (err: AWSError, data: WAF.Types.ListSubscribedRuleGroupsResponse) => void): Request; + /** + * Returns an array of WebACLSummary objects in the response. + */ + listWebACLs(params: WAF.Types.ListWebACLsRequest, callback?: (err: AWSError, data: WAF.Types.ListWebACLsResponse) => void): Request; + /** + * Returns an array of WebACLSummary objects in the response. + */ + listWebACLs(callback?: (err: AWSError, data: WAF.Types.ListWebACLsResponse) => void): Request; + /** + * Returns an array of XssMatchSet objects. + */ + listXssMatchSets(params: WAF.Types.ListXssMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListXssMatchSetsResponse) => void): Request; + /** + * Returns an array of XssMatchSet objects. + */ + listXssMatchSets(callback?: (err: AWSError, data: WAF.Types.ListXssMatchSetsResponse) => void): Request; + /** + * Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose . Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide. + */ + putLoggingConfiguration(params: WAF.Types.PutLoggingConfigurationRequest, callback?: (err: AWSError, data: WAF.Types.PutLoggingConfigurationResponse) => void): Request; + /** + * Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose . Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide. + */ + putLoggingConfiguration(callback?: (err: AWSError, data: WAF.Types.PutLoggingConfigurationResponse) => void): Request; + /** + * Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below. + */ + putPermissionPolicy(params: WAF.Types.PutPermissionPolicyRequest, callback?: (err: AWSError, data: WAF.Types.PutPermissionPolicyResponse) => void): Request; + /** + * Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below. + */ + putPermissionPolicy(callback?: (err: AWSError, data: WAF.Types.PutPermissionPolicyResponse) => void): Request; + /** + * Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateByteMatchSet(params: WAF.Types.UpdateByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateByteMatchSetResponse) => void): Request; + /** + * Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateByteMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateByteMatchSetResponse) => void): Request; + /** + * Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateGeoMatchSet(params: WAF.Types.UpdateGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateGeoMatchSetResponse) => void): Request; + /** + * Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateGeoMatchSetResponse) => void): Request; + /** + * Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateIPSet(params: WAF.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateIPSetResponse) => void): Request; + /** + * Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateIPSet(callback?: (err: AWSError, data: WAF.Types.UpdateIPSetResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. + */ + updateRateBasedRule(params: WAF.Types.UpdateRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRateBasedRuleResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. + */ + updateRateBasedRule(callback?: (err: AWSError, data: WAF.Types.UpdateRateBasedRuleResponse) => void): Request; + /** + * Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexMatchSet(params: WAF.Types.UpdateRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRegexMatchSetResponse) => void): Request; + /** + * Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateRegexMatchSetResponse) => void): Request; + /** + * Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexPatternSet(params: WAF.Types.UpdateRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRegexPatternSetResponse) => void): Request; + /** + * Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.UpdateRegexPatternSetResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRule(params: WAF.Types.UpdateRuleRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRuleResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRule(callback?: (err: AWSError, data: WAF.Types.UpdateRuleResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRuleGroup(params: WAF.Types.UpdateRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRuleGroupResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRuleGroup(callback?: (err: AWSError, data: WAF.Types.UpdateRuleGroupResponse) => void): Request; + /** + * Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSizeConstraintSet(params: WAF.Types.UpdateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateSizeConstraintSetResponse) => void): Request; + /** + * Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.UpdateSizeConstraintSetResponse) => void): Request; + /** + * Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSqlInjectionMatchSet(params: WAF.Types.UpdateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateSqlInjectionMatchSetResponse) => void): Request; + /** + * Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateSqlInjectionMatchSetResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateWebACL(params: WAF.Types.UpdateWebACLRequest, callback?: (err: AWSError, data: WAF.Types.UpdateWebACLResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateWebACL(callback?: (err: AWSError, data: WAF.Types.UpdateWebACLResponse) => void): Request; + /** + * Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateXssMatchSet(params: WAF.Types.UpdateXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateXssMatchSetResponse) => void): Request; + /** + * Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateXssMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateXssMatchSetResponse) => void): Request; +} +declare namespace WAF { + export type Action = string; + export interface ActivatedRule { + /** + * Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive. + */ + Priority: RulePriority; + /** + * The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following: ALLOW: CloudFront responds with the requested object. BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code. COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + */ + Action?: WafAction; + /** + * Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + */ + OverrideAction?: WafOverrideAction; + /** + * The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist. + */ + Type?: WafRuleType; + /** + * An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule. If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps: Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information. Submit an UpdateWebACL request that has two actions: The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude. The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude. + */ + ExcludedRules?: ExcludedRules; + } + export type ActivatedRules = ActivatedRule[]; + export interface ByteMatchSet { + /** + * The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + */ + Name?: ResourceName; + /** + * Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. + */ + ByteMatchTuples: ByteMatchTuples; + } + export type ByteMatchSetSummaries = ByteMatchSetSummary[]; + export interface ByteMatchSetSummary { + /** + * The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + */ + Name: ResourceName; + } + export interface ByteMatchSetUpdate { + /** + * Specifies whether to insert or delete a ByteMatchTuple. + */ + Action: ChangeAction; + /** + * Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet. + */ + ByteMatchTuple: ByteMatchTuple; + } + export type ByteMatchSetUpdates = ByteMatchSetUpdate[]; + export type ByteMatchTargetString = Buffer|Uint8Array|Blob|string; + export interface ByteMatchTuple { + /** + * The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch. + */ + FieldToMatch: FieldToMatch; + /** + * The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes. Valid values depend on the values that you specified for FieldToMatch: HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header. METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg. BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. If you're using the AWS WAF API Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or one of the AWS SDKs The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value. + */ + TargetString: ByteMatchTargetString; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + /** + * Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following: CONTAINS The specified part of the web request must include the value of TargetString, but the location doesn't matter. CONTAINS_WORD The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following: TargetString exactly matches the value of the specified part of the web request, such as the value of a header. TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;. TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot. TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;. EXACTLY The value of the specified part of the web request must exactly match the value of TargetString. STARTS_WITH The value of TargetString must appear at the beginning of the specified part of the web request. ENDS_WITH The value of TargetString must appear at the end of the specified part of the web request. + */ + PositionalConstraint: PositionalConstraint; + } + export type ByteMatchTuples = ByteMatchTuple[]; + export type ChangeAction = "INSERT"|"DELETE"|string; + export type ChangeToken = string; + export type ChangeTokenStatus = "PROVISIONED"|"PENDING"|"INSYNC"|string; + export type ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|string; + export type Country = string; + export interface CreateByteMatchSetRequest { + /** + * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateByteMatchSetResponse { + /** + * A ByteMatchSet that contains no ByteMatchTuple objects. + */ + ByteMatchSet?: ByteMatchSet; + /** + * The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateGeoMatchSetRequest { + /** + * A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateGeoMatchSetResponse { + /** + * The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints. + */ + GeoMatchSet?: GeoMatchSet; + /** + * The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateIPSetRequest { + /** + * A friendly name or description of the IPSet. You can't change Name after you create the IPSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateIPSetResponse { + /** + * The IPSet returned in the CreateIPSet response. + */ + IPSet?: IPSet; + /** + * The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRateBasedRuleRequest { + /** + * A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule. + */ + MetricName: MetricName; + /** + * The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule. + */ + RateKey: RateKey; + /** + * The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. + */ + RateLimit: RateLimit; + /** + * The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken: ChangeToken; + } + export interface CreateRateBasedRuleResponse { + /** + * The RateBasedRule that is returned in the CreateRateBasedRule response. + */ + Rule?: RateBasedRule; + /** + * The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRegexMatchSetRequest { + /** + * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRegexMatchSetResponse { + /** + * A RegexMatchSet that contains no RegexMatchTuple objects. + */ + RegexMatchSet?: RegexMatchSet; + /** + * The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRegexPatternSetRequest { + /** + * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRegexPatternSetResponse { + /** + * A RegexPatternSet that contains no objects. + */ + RegexPatternSet?: RegexPatternSet; + /** + * The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRuleGroupRequest { + /** + * A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup. + */ + MetricName: MetricName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRuleGroupResponse { + /** + * An empty RuleGroup. + */ + RuleGroup?: RuleGroup; + /** + * The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRuleRequest { + /** + * A friendly name or description of the Rule. You can't change the name of a Rule after you create it. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change the name of the metric after you create the Rule. + */ + MetricName: MetricName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRuleResponse { + /** + * The Rule returned in the CreateRule response. + */ + Rule?: Rule; + /** + * The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateSizeConstraintSetRequest { + /** + * A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateSizeConstraintSetResponse { + /** + * A SizeConstraintSet that contains no SizeConstraint objects. + */ + SizeConstraintSet?: SizeConstraintSet; + /** + * The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateSqlInjectionMatchSetRequest { + /** + * A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateSqlInjectionMatchSetResponse { + /** + * A SqlInjectionMatchSet. + */ + SqlInjectionMatchSet?: SqlInjectionMatchSet; + /** + * The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateWebACLRequest { + /** + * A friendly name or description of the WebACL. You can't change Name after you create the WebACL. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change MetricName after you create the WebACL. + */ + MetricName: MetricName; + /** + * The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL. + */ + DefaultAction: WafAction; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateWebACLResponse { + /** + * The WebACL returned in the CreateWebACL response. + */ + WebACL?: WebACL; + /** + * The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateXssMatchSetRequest { + /** + * A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateXssMatchSetResponse { + /** + * An XssMatchSet. + */ + XssMatchSet?: XssMatchSet; + /** + * The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteByteMatchSetRequest { + /** + * The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteByteMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteGeoMatchSetRequest { + /** + * The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteGeoMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteIPSetRequest { + /** + * The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteIPSetResponse { + /** + * The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteLoggingConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration. + */ + ResourceArn: ResourceArn; + } + export interface DeleteLoggingConfigurationResponse { + } + export interface DeletePermissionPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy. The user making the request must be the owner of the RuleGroup. + */ + ResourceArn: ResourceArn; + } + export interface DeletePermissionPolicyResponse { + } + export interface DeleteRateBasedRuleRequest { + /** + * The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRateBasedRuleResponse { + /** + * The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRegexMatchSetRequest { + /** + * The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRegexMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRegexPatternSetRequest { + /** + * The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRegexPatternSetResponse { + /** + * The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRuleGroupResponse { + /** + * The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRuleRequest { + /** + * The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRuleResponse { + /** + * The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteSizeConstraintSetRequest { + /** + * The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteSizeConstraintSetResponse { + /** + * The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteSqlInjectionMatchSetRequest { + /** + * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteSqlInjectionMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteWebACLRequest { + /** + * The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteWebACLResponse { + /** + * The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteXssMatchSetRequest { + /** + * The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteXssMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface ExcludedRule { + /** + * The unique identifier for the rule to exclude from the rule group. + */ + RuleId: ResourceId; + } + export type ExcludedRules = ExcludedRule[]; + export interface FieldToMatch { + /** + * The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + */ + Type: MatchFieldType; + /** + * When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data. + */ + Data?: MatchFieldData; + } + export interface GeoMatchConstraint { + /** + * The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value. + */ + Type: GeoMatchConstraintType; + /** + * The country that you want AWS WAF to search for. + */ + Value: GeoMatchConstraintValue; + } + export type GeoMatchConstraintType = "Country"|string; + export type GeoMatchConstraintValue = "AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CD"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KP"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"US"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW"|string; + export type GeoMatchConstraints = GeoMatchConstraint[]; + export interface GeoMatchSet { + /** + * The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + /** + * A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. + */ + Name?: ResourceName; + /** + * An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for. + */ + GeoMatchConstraints: GeoMatchConstraints; + } + export type GeoMatchSetSummaries = GeoMatchSetSummary[]; + export interface GeoMatchSetSummary { + /** + * The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet. + */ + GeoMatchSetId: ResourceId; + /** + * A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. + */ + Name: ResourceName; + } + export interface GeoMatchSetUpdate { + /** + * Specifies whether to insert or delete a country with UpdateGeoMatchSet. + */ + Action: ChangeAction; + /** + * The country from which web requests originate that you want AWS WAF to search for. + */ + GeoMatchConstraint: GeoMatchConstraint; + } + export type GeoMatchSetUpdates = GeoMatchSetUpdate[]; + export interface GetByteMatchSetRequest { + /** + * The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + } + export interface GetByteMatchSetResponse { + /** + * Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics: ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type + */ + ByteMatchSet?: ByteMatchSet; + } + export interface GetChangeTokenRequest { + } + export interface GetChangeTokenResponse { + /** + * The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request. + */ + ChangeToken?: ChangeToken; + } + export interface GetChangeTokenStatusRequest { + /** + * The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response. + */ + ChangeToken: ChangeToken; + } + export interface GetChangeTokenStatusResponse { + /** + * The status of the change token. + */ + ChangeTokenStatus?: ChangeTokenStatus; + } + export interface GetGeoMatchSetRequest { + /** + * The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + } + export interface GetGeoMatchSetResponse { + /** + * Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country. + */ + GeoMatchSet?: GeoMatchSet; + } + export interface GetIPSetRequest { + /** + * The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + } + export interface GetIPSetResponse { + /** + * Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics: IPSet: Contains IPSetDescriptors, IPSetId, and Name IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value + */ + IPSet?: IPSet; + } + export interface GetLoggingConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. + */ + ResourceArn: ResourceArn; + } + export interface GetLoggingConfigurationResponse { + /** + * The LoggingConfiguration for the specified web ACL. + */ + LoggingConfiguration?: LoggingConfiguration; + } + export interface GetPermissionPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy. + */ + ResourceArn: ResourceArn; + } + export interface GetPermissionPolicyResponse { + /** + * The IAM policy attached to the specified RuleGroup. + */ + Policy?: PolicyString; + } + export interface GetRateBasedRuleManagedKeysRequest { + /** + * The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + /** + * A null value and not currently used. Do not include this in your request. + */ + NextMarker?: NextMarker; + } + export interface GetRateBasedRuleManagedKeysResponse { + /** + * An array of IP addresses that currently are blocked by the specified RateBasedRule. + */ + ManagedKeys?: ManagedKeys; + /** + * A null value and not currently used. + */ + NextMarker?: NextMarker; + } + export interface GetRateBasedRuleRequest { + /** + * The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + } + export interface GetRateBasedRuleResponse { + /** + * Information about the RateBasedRule that you specified in the GetRateBasedRule request. + */ + Rule?: RateBasedRule; + } + export interface GetRegexMatchSetRequest { + /** + * The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + } + export interface GetRegexMatchSetResponse { + /** + * Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple. + */ + RegexMatchSet?: RegexMatchSet; + } + export interface GetRegexPatternSetRequest { + /** + * The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + } + export interface GetRegexPatternSetResponse { + /** + * Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for. + */ + RegexPatternSet?: RegexPatternSet; + } + export interface GetRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + } + export interface GetRuleGroupResponse { + /** + * Information about the RuleGroup that you specified in the GetRuleGroup request. + */ + RuleGroup?: RuleGroup; + } + export interface GetRuleRequest { + /** + * The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + } + export interface GetRuleResponse { + /** + * Information about the Rule that you specified in the GetRule request. For more information, see the following topics: Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId Predicate: Each Predicate object contains DataId, Negated, and Type + */ + Rule?: Rule; + } + export type GetSampledRequestsMaxItems = number; + export interface GetSampledRequestsRequest { + /** + * The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests. + */ + WebAclId: ResourceId; + /** + * RuleId is one of three values: The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests. Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL. + */ + RuleId: ResourceId; + /** + * The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + */ + TimeWindow: TimeWindow; + /** + * The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them. + */ + MaxItems: GetSampledRequestsMaxItems; + } + export interface GetSampledRequestsResponse { + /** + * A complex type that contains detailed information about each of the requests in the sample. + */ + SampledRequests?: SampledHTTPRequests; + /** + * The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range. + */ + PopulationSize?: PopulationSize; + /** + * Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. + */ + TimeWindow?: TimeWindow; + } + export interface GetSizeConstraintSetRequest { + /** + * The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + } + export interface GetSizeConstraintSetResponse { + /** + * Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics: SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name SizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type + */ + SizeConstraintSet?: SizeConstraintSet; + } + export interface GetSqlInjectionMatchSetRequest { + /** + * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + } + export interface GetSqlInjectionMatchSetResponse { + /** + * Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics: SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objects SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + SqlInjectionMatchSet?: SqlInjectionMatchSet; + } + export interface GetWebACLRequest { + /** + * The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + } + export interface GetWebACLResponse { + /** + * Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics: WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId DefaultAction (Data type is WafAction): Contains Type Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId Action: Contains Type + */ + WebACL?: WebACL; + } + export interface GetXssMatchSetRequest { + /** + * The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + } + export interface GetXssMatchSetResponse { + /** + * Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics: XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + XssMatchSet?: XssMatchSet; + } + export interface HTTPHeader { + /** + * The name of one of the headers in the sampled web request. + */ + Name?: HeaderName; + /** + * The value of one of the headers in the sampled web request. + */ + Value?: HeaderValue; + } + export type HTTPHeaders = HTTPHeader[]; + export type HTTPMethod = string; + export interface HTTPRequest { + /** + * The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs: c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request + */ + ClientIP?: IPString; + /** + * The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2. + */ + Country?: Country; + /** + * The part of a web request that identifies the resource, for example, /images/daily-ad.jpg. + */ + URI?: URIString; + /** + * The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. + */ + Method?: HTTPMethod; + /** + * The HTTP version specified in the sampled web request, for example, HTTP/1.1. + */ + HTTPVersion?: HTTPVersion; + /** + * A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header. + */ + Headers?: HTTPHeaders; + } + export type HTTPVersion = string; + export type HeaderName = string; + export type HeaderValue = string; + export interface IPSet { + /** + * The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet). IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + /** + * A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. + */ + Name?: ResourceName; + /** + * The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs. + */ + IPSetDescriptors: IPSetDescriptors; + } + export interface IPSetDescriptor { + /** + * Specify IPV4 or IPV6. + */ + Type: IPSetDescriptorType; + /** + * Specify an IPv4 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Specify an IPv6 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. + */ + Value: IPSetDescriptorValue; + } + export type IPSetDescriptorType = "IPV4"|"IPV6"|string; + export type IPSetDescriptorValue = string; + export type IPSetDescriptors = IPSetDescriptor[]; + export type IPSetSummaries = IPSetSummary[]; + export interface IPSetSummary { + /** + * The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet. + */ + IPSetId: ResourceId; + /** + * A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. + */ + Name: ResourceName; + } + export interface IPSetUpdate { + /** + * Specifies whether to insert or delete an IP address with UpdateIPSet. + */ + Action: ChangeAction; + /** + * The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. + */ + IPSetDescriptor: IPSetDescriptor; + } + export type IPSetUpdates = IPSetUpdate[]; + export type IPString = string; + export interface ListActivatedRulesInRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects. + */ + RuleGroupId?: ResourceId; + /** + * If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules. + */ + Limit?: PaginationLimit; + } + export interface ListActivatedRulesInRuleGroupResponse { + /** + * If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of ActivatedRules objects. + */ + ActivatedRules?: ActivatedRules; + } + export interface ListByteMatchSetsRequest { + /** + * If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListByteMatchSetsResponse { + /** + * If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of ByteMatchSetSummary objects. + */ + ByteMatchSets?: ByteMatchSetSummaries; + } + export interface ListGeoMatchSetsRequest { + /** + * If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListGeoMatchSetsResponse { + /** + * If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of GeoMatchSetSummary objects. + */ + GeoMatchSets?: GeoMatchSetSummaries; + } + export interface ListIPSetsRequest { + /** + * If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListIPSetsResponse { + /** + * If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of IPSetSummary objects. + */ + IPSets?: IPSetSummaries; + } + export interface ListLoggingConfigurationsRequest { + /** + * If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations. + */ + Limit?: PaginationLimit; + } + export interface ListLoggingConfigurationsResponse { + /** + * An array of LoggingConfiguration objects. + */ + LoggingConfigurations?: LoggingConfigurations; + /** + * If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + } + export interface ListRateBasedRulesRequest { + /** + * If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListRateBasedRulesResponse { + /** + * If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleSummary objects. + */ + Rules?: RuleSummaries; + } + export interface ListRegexMatchSetsRequest { + /** + * If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListRegexMatchSetsResponse { + /** + * If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RegexMatchSetSummary objects. + */ + RegexMatchSets?: RegexMatchSetSummaries; + } + export interface ListRegexPatternSetsRequest { + /** + * If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListRegexPatternSetsResponse { + /** + * If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RegexPatternSetSummary objects. + */ + RegexPatternSets?: RegexPatternSetSummaries; + } + export interface ListRuleGroupsRequest { + /** + * If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups. + */ + Limit?: PaginationLimit; + } + export interface ListRuleGroupsResponse { + /** + * If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleGroup objects. + */ + RuleGroups?: RuleGroupSummaries; + } + export interface ListRulesRequest { + /** + * If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListRulesResponse { + /** + * If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleSummary objects. + */ + Rules?: RuleSummaries; + } + export interface ListSizeConstraintSetsRequest { + /** + * If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListSizeConstraintSetsResponse { + /** + * If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of SizeConstraintSetSummary objects. + */ + SizeConstraintSets?: SizeConstraintSetSummaries; + } + export interface ListSqlInjectionMatchSetsRequest { + /** + * If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListSqlInjectionMatchSetsResponse { + /** + * If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of SqlInjectionMatchSetSummary objects. + */ + SqlInjectionMatchSets?: SqlInjectionMatchSetSummaries; + } + export interface ListSubscribedRuleGroupsRequest { + /** + * If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects. + */ + Limit?: PaginationLimit; + } + export interface ListSubscribedRuleGroupsResponse { + /** + * If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleGroup objects. + */ + RuleGroups?: SubscribedRuleGroupSummaries; + } + export interface ListWebACLsRequest { + /** + * If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects. + */ + Limit?: PaginationLimit; + } + export interface ListWebACLsResponse { + /** + * If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of WebACLSummary objects. + */ + WebACLs?: WebACLSummaries; + } + export interface ListXssMatchSetsRequest { + /** + * If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListXssMatchSetsResponse { + /** + * If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of XssMatchSetSummary objects. + */ + XssMatchSets?: XssMatchSetSummaries; + } + export type LogDestinationConfigs = ResourceArn[]; + export interface LoggingConfiguration { + /** + * The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. + */ + ResourceArn: ResourceArn; + /** + * An array of Amazon Kinesis Data Firehose ARNs. + */ + LogDestinationConfigs: LogDestinationConfigs; + /** + * The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx. + */ + RedactedFields?: RedactedFields; + } + export type LoggingConfigurations = LoggingConfiguration[]; + export type ManagedKey = string; + export type ManagedKeys = ManagedKey[]; + export type MatchFieldData = string; + export type MatchFieldType = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS"|string; + export type MetricName = string; + export type Negated = boolean; + export type NextMarker = string; + export type PaginationLimit = number; + export type PolicyString = string; + export type PopulationSize = number; + export type PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD"|string; + export interface Predicate { + /** + * Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44. + */ + Negated: Negated; + /** + * The type of predicate in a Rule, such as ByteMatch or IPSet. + */ + Type: PredicateType; + /** + * A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command. + */ + DataId: ResourceId; + } + export type PredicateType = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch"|string; + export type Predicates = Predicate[]; + export interface PutLoggingConfigurationRequest { + /** + * The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor. + */ + LoggingConfiguration: LoggingConfiguration; + } + export interface PutLoggingConfigurationResponse { + /** + * The LoggingConfiguration that you submitted in the request. + */ + LoggingConfiguration?: LoggingConfiguration; + } + export interface PutPermissionPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy. + */ + ResourceArn: ResourceArn; + /** + * The policy to attach to the specified RuleGroup. + */ + Policy: PolicyString; + } + export interface PutPermissionPolicyResponse { + } + export interface RateBasedRule { + /** + * A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule). + */ + RuleId: ResourceId; + /** + * A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule. + */ + MetricName?: MetricName; + /** + * The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule. + */ + MatchPredicates: Predicates; + /** + * The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule. + */ + RateKey: RateKey; + /** + * The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. + */ + RateLimit: RateLimit; + } + export type RateKey = "IP"|string; + export type RateLimit = number; + export type RedactedFields = FieldToMatch[]; + export interface RegexMatchSet { + /** + * The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId?: ResourceId; + /** + * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. + */ + Name?: ResourceName; + /** + * Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains: The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. + */ + RegexMatchTuples?: RegexMatchTuples; + } + export type RegexMatchSetSummaries = RegexMatchSetSummary[]; + export interface RegexMatchSetSummary { + /** + * The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + /** + * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. + */ + Name: ResourceName; + } + export interface RegexMatchSetUpdate { + /** + * Specifies whether to insert or delete a RegexMatchTuple. + */ + Action: ChangeAction; + /** + * Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet. + */ + RegexMatchTuple: RegexMatchTuple; + } + export type RegexMatchSetUpdates = RegexMatchSetUpdate[]; + export interface RegexMatchTuple { + /** + * Specifies where in a web request to look for the RegexPatternSet. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + /** + * The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + } + export type RegexMatchTuples = RegexMatchTuple[]; + export interface RegexPatternSet { + /** + * The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. + */ + Name?: ResourceName; + /** + * Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t. + */ + RegexPatternStrings: RegexPatternStrings; + } + export type RegexPatternSetSummaries = RegexPatternSetSummary[]; + export interface RegexPatternSetSummary { + /** + * The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. + */ + Name: ResourceName; + } + export interface RegexPatternSetUpdate { + /** + * Specifies whether to insert or delete a RegexPatternString. + */ + Action: ChangeAction; + /** + * Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. + */ + RegexPatternString: RegexPatternString; + } + export type RegexPatternSetUpdates = RegexPatternSetUpdate[]; + export type RegexPatternString = string; + export type RegexPatternStrings = RegexPatternString[]; + export type ResourceArn = string; + export type ResourceId = string; + export type ResourceName = string; + export interface Rule { + /** + * A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * The friendly name or description for the Rule. You can't change the name of a Rule after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the Rule. + */ + MetricName?: MetricName; + /** + * The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. + */ + Predicates: Predicates; + } + export interface RuleGroup { + /** + * A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup. + */ + MetricName?: MetricName; + } + export type RuleGroupSummaries = RuleGroupSummary[]; + export interface RuleGroupSummary { + /** + * A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. + */ + Name: ResourceName; + } + export interface RuleGroupUpdate { + /** + * Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup. + */ + Action: ChangeAction; + /** + * The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). + */ + ActivatedRule: ActivatedRule; + } + export type RuleGroupUpdates = RuleGroupUpdate[]; + export type RulePriority = number; + export type RuleSummaries = RuleSummary[]; + export interface RuleSummary { + /** + * A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * A friendly name or description of the Rule. You can't change the name of a Rule after you create it. + */ + Name: ResourceName; + } + export interface RuleUpdate { + /** + * Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule. + */ + Action: ChangeAction; + /** + * The ID of the Predicate (such as an IPSet) that you want to add to a Rule. + */ + Predicate: Predicate; + } + export type RuleUpdates = RuleUpdate[]; + export type SampleWeight = number; + export interface SampledHTTPRequest { + /** + * A complex type that contains detailed information about the request. + */ + Request: HTTPRequest; + /** + * A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1. + */ + Weight: SampleWeight; + /** + * The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds). + */ + Timestamp?: Timestamp; + /** + * The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. + */ + Action?: Action; + /** + * This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response. + */ + RuleWithinRuleGroup?: ResourceId; + } + export type SampledHTTPRequests = SampledHTTPRequest[]; + export type Size = number; + export interface SizeConstraint { + /** + * Specifies where in a web request to look for the size constraint. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. NONE Specify NONE if you don't want to perform any text transformations. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. + */ + TextTransformation: TextTransformation; + /** + * The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. EQ: Used to test if the Size is equal to the size of the FieldToMatch NE: Used to test if the Size is not equal to the size of the FieldToMatch LE: Used to test if the Size is less than or equal to the size of the FieldToMatch LT: Used to test if the Size is strictly less than the size of the FieldToMatch GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch GT: Used to test if the Size is strictly greater than the size of the FieldToMatch + */ + ComparisonOperator: ComparisonOperator; + /** + * The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + */ + Size: Size; + } + export interface SizeConstraintSet { + /** + * A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The name, if any, of the SizeConstraintSet. + */ + Name?: ResourceName; + /** + * Specifies the parts of web requests that you want to inspect the size of. + */ + SizeConstraints: SizeConstraints; + } + export type SizeConstraintSetSummaries = SizeConstraintSetSummary[]; + export interface SizeConstraintSetSummary { + /** + * A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The name of the SizeConstraintSet, if any. + */ + Name: ResourceName; + } + export interface SizeConstraintSetUpdate { + /** + * Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet. + */ + Action: ChangeAction; + /** + * Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. + */ + SizeConstraint: SizeConstraint; + } + export type SizeConstraintSetUpdates = SizeConstraintSetUpdate[]; + export type SizeConstraints = SizeConstraint[]; + export interface SqlInjectionMatchSet { + /** + * A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The name, if any, of the SqlInjectionMatchSet. + */ + Name?: ResourceName; + /** + * Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code. + */ + SqlInjectionMatchTuples: SqlInjectionMatchTuples; + } + export type SqlInjectionMatchSetSummaries = SqlInjectionMatchSetSummary[]; + export interface SqlInjectionMatchSetSummary { + /** + * A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The name of the SqlInjectionMatchSet, if any, specified by Id. + */ + Name: ResourceName; + } + export interface SqlInjectionMatchSetUpdate { + /** + * Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet. + */ + Action: ChangeAction; + /** + * Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. + */ + SqlInjectionMatchTuple: SqlInjectionMatchTuple; + } + export type SqlInjectionMatchSetUpdates = SqlInjectionMatchSetUpdate[]; + export interface SqlInjectionMatchTuple { + /** + * Specifies where in a web request to look for snippets of malicious SQL code. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + } + export type SqlInjectionMatchTuples = SqlInjectionMatchTuple[]; + export type SubscribedRuleGroupSummaries = SubscribedRuleGroupSummary[]; + export interface SubscribedRuleGroupSummary { + /** + * A unique identifier for a RuleGroup. + */ + RuleGroupId: ResourceId; + /** + * A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup. + */ + MetricName: MetricName; + } + export type TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE"|string; + export interface TimeWindow { + /** + * The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + */ + StartTime: Timestamp; + /** + * The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + */ + EndTime: Timestamp; + } + export type Timestamp = Date; + export type URIString = string; + export interface UpdateByteMatchSetRequest { + /** + * The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types: ByteMatchSetUpdate: Contains Action and ByteMatchTuple ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type + */ + Updates: ByteMatchSetUpdates; + } + export interface UpdateByteMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateGeoMatchSetRequest { + /** + * The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types: GeoMatchSetUpdate: Contains Action and GeoMatchConstraint GeoMatchConstraint: Contains Type and Value You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request. + */ + Updates: GeoMatchSetUpdates; + } + export interface UpdateGeoMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateIPSetRequest { + /** + * The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types: IPSetUpdate: Contains Action and IPSetDescriptor IPSetDescriptor: Contains Type and Value You can insert a maximum of 1000 addresses in a single request. + */ + Updates: IPSetUpdates; + } + export interface UpdateIPSetResponse { + /** + * The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRateBasedRuleRequest { + /** + * The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule. + */ + Updates: RuleUpdates; + /** + * The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. + */ + RateLimit: RateLimit; + } + export interface UpdateRateBasedRuleResponse { + /** + * The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRegexMatchSetRequest { + /** + * The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + /** + * An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple. + */ + Updates: RegexMatchSetUpdates; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface UpdateRegexMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRegexPatternSetRequest { + /** + * The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet. + */ + Updates: RegexPatternSetUpdates; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface UpdateRegexPatternSetResponse { + /** + * The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup. You can only insert REGULAR rules into a rule group. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + */ + Updates: RuleGroupUpdates; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface UpdateRuleGroupResponse { + /** + * The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRuleRequest { + /** + * The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types: RuleUpdate: Contains Action and Predicate Predicate: Contains DataId, Negated, and Type FieldToMatch: Contains Data and Type + */ + Updates: RuleUpdates; + } + export interface UpdateRuleResponse { + /** + * The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateSizeConstraintSetRequest { + /** + * The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types: SizeConstraintSetUpdate: Contains Action and SizeConstraint SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type + */ + Updates: SizeConstraintSetUpdates; + } + export interface UpdateSizeConstraintSetResponse { + /** + * The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateSqlInjectionMatchSetRequest { + /** + * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types: SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + Updates: SqlInjectionMatchSetUpdates; + } + export interface UpdateSqlInjectionMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateWebACLRequest { + /** + * The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of updates to make to the WebACL. An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types: WebACLUpdate: Contains Action and ActivatedRule ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. WafAction: Contains Type + */ + Updates?: WebACLUpdates; + /** + * A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL. + */ + DefaultAction?: WafAction; + } + export interface UpdateWebACLResponse { + /** + * The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateXssMatchSetRequest { + /** + * The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types: XssMatchSetUpdate: Contains Action and XssMatchTuple XssMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + Updates: XssMatchSetUpdates; + } + export interface UpdateXssMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface WafAction { + /** + * Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following: ALLOW: AWS WAF allows requests BLOCK: AWS WAF blocks requests COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL. + */ + Type: WafActionType; + } + export type WafActionType = "BLOCK"|"ALLOW"|"COUNT"|string; + export interface WafOverrideAction { + /** + * COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place. + */ + Type: WafOverrideActionType; + } + export type WafOverrideActionType = "NONE"|"COUNT"|string; + export type WafRuleType = "REGULAR"|"RATE_BASED"|"GROUP"|string; + export interface WebACL { + /** + * A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL. + */ + MetricName?: MetricName; + /** + * The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object. + */ + DefaultAction: WafAction; + /** + * An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule. + */ + Rules: ActivatedRules; + /** + * Tha Amazon Resource Name (ARN) of the web ACL. + */ + WebACLArn?: ResourceArn; + } + export type WebACLSummaries = WebACLSummary[]; + export interface WebACLSummary { + /** + * A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. + */ + Name: ResourceName; + } + export interface WebACLUpdate { + /** + * Specifies whether to insert a Rule into or delete a Rule from a WebACL. + */ + Action: ChangeAction; + /** + * The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). + */ + ActivatedRule: ActivatedRule; + } + export type WebACLUpdates = WebACLUpdate[]; + export interface XssMatchSet { + /** + * A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The name, if any, of the XssMatchSet. + */ + Name?: ResourceName; + /** + * Specifies the parts of web requests that you want to inspect for cross-site scripting attacks. + */ + XssMatchTuples: XssMatchTuples; + } + export type XssMatchSetSummaries = XssMatchSetSummary[]; + export interface XssMatchSetSummary { + /** + * A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The name of the XssMatchSet, if any, specified by Id. + */ + Name: ResourceName; + } + export interface XssMatchSetUpdate { + /** + * Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet. + */ + Action: ChangeAction; + /** + * Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. + */ + XssMatchTuple: XssMatchTuple; + } + export type XssMatchSetUpdates = XssMatchSetUpdate[]; + export interface XssMatchTuple { + /** + * Specifies where in a web request to look for cross-site scripting attacks. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + } + export type XssMatchTuples = XssMatchTuple[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-08-24"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the WAF client. + */ + export import Types = WAF; +} +export = WAF; diff --git a/node_modules/aws-sdk/clients/waf.js b/node_modules/aws-sdk/clients/waf.js new file mode 100644 index 0000000..b31040a --- /dev/null +++ b/node_modules/aws-sdk/clients/waf.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['waf'] = {}; +AWS.WAF = Service.defineService('waf', ['2015-08-24']); +Object.defineProperty(apiLoader.services['waf'], '2015-08-24', { + get: function get() { + var model = require('../apis/waf-2015-08-24.min.json'); + model.paginators = require('../apis/waf-2015-08-24.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.WAF; diff --git a/node_modules/aws-sdk/clients/wafregional.d.ts b/node_modules/aws-sdk/clients/wafregional.d.ts new file mode 100644 index 0000000..7f8f22c --- /dev/null +++ b/node_modules/aws-sdk/clients/wafregional.d.ts @@ -0,0 +1,2743 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class WAFRegional extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: WAFRegional.Types.ClientConfiguration) + config: Config & WAFRegional.Types.ClientConfiguration; + /** + * Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage. + */ + associateWebACL(params: WAFRegional.Types.AssociateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.AssociateWebACLResponse) => void): Request; + /** + * Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage. + */ + associateWebACL(callback?: (err: AWSError, data: WAFRegional.Types.AssociateWebACLResponse) => void): Request; + /** + * Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createByteMatchSet(params: WAFRegional.Types.CreateByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateByteMatchSetResponse) => void): Request; + /** + * Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateByteMatchSetResponse) => void): Request; + /** + * Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createGeoMatchSet(params: WAFRegional.Types.CreateGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateGeoMatchSetResponse) => void): Request; + /** + * Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateGeoMatchSetResponse) => void): Request; + /** + * Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createIPSet(params: WAFRegional.Types.CreateIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateIPSetResponse) => void): Request; + /** + * Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createIPSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateIPSetResponse) => void): Request; + /** + * Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRateBasedRule(params: WAFRegional.Types.CreateRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRateBasedRuleResponse) => void): Request; + /** + * Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.CreateRateBasedRuleResponse) => void): Request; + /** + * Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexMatchSet(params: WAFRegional.Types.CreateRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexMatchSetResponse) => void): Request; + /** + * Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexMatchSetResponse) => void): Request; + /** + * Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexPatternSet(params: WAFRegional.Types.CreateRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexPatternSetResponse) => void): Request; + /** + * Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateRegexPatternSetResponse) => void): Request; + /** + * Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRule(params: WAFRegional.Types.CreateRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleResponse) => void): Request; + /** + * Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRule(callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleResponse) => void): Request; + /** + * Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRuleGroup(params: WAFRegional.Types.CreateRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleGroupResponse) => void): Request; + /** + * Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.CreateRuleGroupResponse) => void): Request; + /** + * Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSizeConstraintSet(params: WAFRegional.Types.CreateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateSizeConstraintSetResponse) => void): Request; + /** + * Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateSizeConstraintSetResponse) => void): Request; + /** + * Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSqlInjectionMatchSet(params: WAFRegional.Types.CreateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateSqlInjectionMatchSetResponse) => void): Request; + /** + * Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateSqlInjectionMatchSetResponse) => void): Request; + /** + * Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide. + */ + createWebACL(params: WAFRegional.Types.CreateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateWebACLResponse) => void): Request; + /** + * Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide. + */ + createWebACL(callback?: (err: AWSError, data: WAFRegional.Types.CreateWebACLResponse) => void): Request; + /** + * Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createXssMatchSet(params: WAFRegional.Types.CreateXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.CreateXssMatchSetResponse) => void): Request; + /** + * Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + createXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.CreateXssMatchSetResponse) => void): Request; + /** + * Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request. + */ + deleteByteMatchSet(params: WAFRegional.Types.DeleteByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteByteMatchSetResponse) => void): Request; + /** + * Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request. + */ + deleteByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteByteMatchSetResponse) => void): Request; + /** + * Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request. + */ + deleteGeoMatchSet(params: WAFRegional.Types.DeleteGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteGeoMatchSetResponse) => void): Request; + /** + * Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request. + */ + deleteGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteGeoMatchSetResponse) => void): Request; + /** + * Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request. + */ + deleteIPSet(params: WAFRegional.Types.DeleteIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteIPSetResponse) => void): Request; + /** + * Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request. + */ + deleteIPSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteIPSetResponse) => void): Request; + /** + * Permanently deletes the LoggingConfiguration from the specified web ACL. + */ + deleteLoggingConfiguration(params: WAFRegional.Types.DeleteLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteLoggingConfigurationResponse) => void): Request; + /** + * Permanently deletes the LoggingConfiguration from the specified web ACL. + */ + deleteLoggingConfiguration(callback?: (err: AWSError, data: WAFRegional.Types.DeleteLoggingConfigurationResponse) => void): Request; + /** + * Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup. + */ + deletePermissionPolicy(params: WAFRegional.Types.DeletePermissionPolicyRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeletePermissionPolicyResponse) => void): Request; + /** + * Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup. + */ + deletePermissionPolicy(callback?: (err: AWSError, data: WAFRegional.Types.DeletePermissionPolicyResponse) => void): Request; + /** + * Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request. + */ + deleteRateBasedRule(params: WAFRegional.Types.DeleteRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRateBasedRuleResponse) => void): Request; + /** + * Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request. + */ + deleteRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRateBasedRuleResponse) => void): Request; + /** + * Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request. + */ + deleteRegexMatchSet(params: WAFRegional.Types.DeleteRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexMatchSetResponse) => void): Request; + /** + * Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request. + */ + deleteRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexMatchSetResponse) => void): Request; + /** + * Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty. + */ + deleteRegexPatternSet(params: WAFRegional.Types.DeleteRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexPatternSetResponse) => void): Request; + /** + * Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty. + */ + deleteRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRegexPatternSetResponse) => void): Request; + /** + * Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request. + */ + deleteRule(params: WAFRegional.Types.DeleteRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleResponse) => void): Request; + /** + * Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request. + */ + deleteRule(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleResponse) => void): Request; + /** + * Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request. + */ + deleteRuleGroup(params: WAFRegional.Types.DeleteRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleGroupResponse) => void): Request; + /** + * Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request. + */ + deleteRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.DeleteRuleGroupResponse) => void): Request; + /** + * Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request. + */ + deleteSizeConstraintSet(params: WAFRegional.Types.DeleteSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteSizeConstraintSetResponse) => void): Request; + /** + * Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request. + */ + deleteSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteSizeConstraintSetResponse) => void): Request; + /** + * Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request. + */ + deleteSqlInjectionMatchSet(params: WAFRegional.Types.DeleteSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteSqlInjectionMatchSetResponse) => void): Request; + /** + * Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request. + */ + deleteSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteSqlInjectionMatchSetResponse) => void): Request; + /** + * Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request. + */ + deleteWebACL(params: WAFRegional.Types.DeleteWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteWebACLResponse) => void): Request; + /** + * Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request. + */ + deleteWebACL(callback?: (err: AWSError, data: WAFRegional.Types.DeleteWebACLResponse) => void): Request; + /** + * Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request. + */ + deleteXssMatchSet(params: WAFRegional.Types.DeleteXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.DeleteXssMatchSetResponse) => void): Request; + /** + * Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request. + */ + deleteXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.DeleteXssMatchSetResponse) => void): Request; + /** + * Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage. + */ + disassociateWebACL(params: WAFRegional.Types.DisassociateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.DisassociateWebACLResponse) => void): Request; + /** + * Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage. + */ + disassociateWebACL(callback?: (err: AWSError, data: WAFRegional.Types.DisassociateWebACLResponse) => void): Request; + /** + * Returns the ByteMatchSet specified by ByteMatchSetId. + */ + getByteMatchSet(params: WAFRegional.Types.GetByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetByteMatchSetResponse) => void): Request; + /** + * Returns the ByteMatchSet specified by ByteMatchSetId. + */ + getByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetByteMatchSetResponse) => void): Request; + /** + * When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token. + */ + getChangeToken(params: WAFRegional.Types.GetChangeTokenRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenResponse) => void): Request; + /** + * When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token. + */ + getChangeToken(callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenResponse) => void): Request; + /** + * Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete. + */ + getChangeTokenStatus(params: WAFRegional.Types.GetChangeTokenStatusRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenStatusResponse) => void): Request; + /** + * Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete. + */ + getChangeTokenStatus(callback?: (err: AWSError, data: WAFRegional.Types.GetChangeTokenStatusResponse) => void): Request; + /** + * Returns the GeoMatchSet that is specified by GeoMatchSetId. + */ + getGeoMatchSet(params: WAFRegional.Types.GetGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetGeoMatchSetResponse) => void): Request; + /** + * Returns the GeoMatchSet that is specified by GeoMatchSetId. + */ + getGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetGeoMatchSetResponse) => void): Request; + /** + * Returns the IPSet that is specified by IPSetId. + */ + getIPSet(params: WAFRegional.Types.GetIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetIPSetResponse) => void): Request; + /** + * Returns the IPSet that is specified by IPSetId. + */ + getIPSet(callback?: (err: AWSError, data: WAFRegional.Types.GetIPSetResponse) => void): Request; + /** + * Returns the LoggingConfiguration for the specified web ACL. + */ + getLoggingConfiguration(params: WAFRegional.Types.GetLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetLoggingConfigurationResponse) => void): Request; + /** + * Returns the LoggingConfiguration for the specified web ACL. + */ + getLoggingConfiguration(callback?: (err: AWSError, data: WAFRegional.Types.GetLoggingConfigurationResponse) => void): Request; + /** + * Returns the IAM policy attached to the RuleGroup. + */ + getPermissionPolicy(params: WAFRegional.Types.GetPermissionPolicyRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetPermissionPolicyResponse) => void): Request; + /** + * Returns the IAM policy attached to the RuleGroup. + */ + getPermissionPolicy(callback?: (err: AWSError, data: WAFRegional.Types.GetPermissionPolicyResponse) => void): Request; + /** + * Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request. + */ + getRateBasedRule(params: WAFRegional.Types.GetRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleResponse) => void): Request; + /** + * Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request. + */ + getRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleResponse) => void): Request; + /** + * Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked. + */ + getRateBasedRuleManagedKeys(params: WAFRegional.Types.GetRateBasedRuleManagedKeysRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleManagedKeysResponse) => void): Request; + /** + * Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked. + */ + getRateBasedRuleManagedKeys(callback?: (err: AWSError, data: WAFRegional.Types.GetRateBasedRuleManagedKeysResponse) => void): Request; + /** + * Returns the RegexMatchSet specified by RegexMatchSetId. + */ + getRegexMatchSet(params: WAFRegional.Types.GetRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRegexMatchSetResponse) => void): Request; + /** + * Returns the RegexMatchSet specified by RegexMatchSetId. + */ + getRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetRegexMatchSetResponse) => void): Request; + /** + * Returns the RegexPatternSet specified by RegexPatternSetId. + */ + getRegexPatternSet(params: WAFRegional.Types.GetRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRegexPatternSetResponse) => void): Request; + /** + * Returns the RegexPatternSet specified by RegexPatternSetId. + */ + getRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.GetRegexPatternSetResponse) => void): Request; + /** + * Returns the Rule that is specified by the RuleId that you included in the GetRule request. + */ + getRule(params: WAFRegional.Types.GetRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRuleResponse) => void): Request; + /** + * Returns the Rule that is specified by the RuleId that you included in the GetRule request. + */ + getRule(callback?: (err: AWSError, data: WAFRegional.Types.GetRuleResponse) => void): Request; + /** + * Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup. + */ + getRuleGroup(params: WAFRegional.Types.GetRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetRuleGroupResponse) => void): Request; + /** + * Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup. + */ + getRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.GetRuleGroupResponse) => void): Request; + /** + * Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. + */ + getSampledRequests(params: WAFRegional.Types.GetSampledRequestsRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetSampledRequestsResponse) => void): Request; + /** + * Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. + */ + getSampledRequests(callback?: (err: AWSError, data: WAFRegional.Types.GetSampledRequestsResponse) => void): Request; + /** + * Returns the SizeConstraintSet specified by SizeConstraintSetId. + */ + getSizeConstraintSet(params: WAFRegional.Types.GetSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetSizeConstraintSetResponse) => void): Request; + /** + * Returns the SizeConstraintSet specified by SizeConstraintSetId. + */ + getSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.GetSizeConstraintSetResponse) => void): Request; + /** + * Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. + */ + getSqlInjectionMatchSet(params: WAFRegional.Types.GetSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetSqlInjectionMatchSetResponse) => void): Request; + /** + * Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. + */ + getSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetSqlInjectionMatchSetResponse) => void): Request; + /** + * Returns the WebACL that is specified by WebACLId. + */ + getWebACL(params: WAFRegional.Types.GetWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLResponse) => void): Request; + /** + * Returns the WebACL that is specified by WebACLId. + */ + getWebACL(callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLResponse) => void): Request; + /** + * Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage. + */ + getWebACLForResource(params: WAFRegional.Types.GetWebACLForResourceRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLForResourceResponse) => void): Request; + /** + * Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage. + */ + getWebACLForResource(callback?: (err: AWSError, data: WAFRegional.Types.GetWebACLForResourceResponse) => void): Request; + /** + * Returns the XssMatchSet that is specified by XssMatchSetId. + */ + getXssMatchSet(params: WAFRegional.Types.GetXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.GetXssMatchSetResponse) => void): Request; + /** + * Returns the XssMatchSet that is specified by XssMatchSetId. + */ + getXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.GetXssMatchSetResponse) => void): Request; + /** + * Returns an array of ActivatedRule objects. + */ + listActivatedRulesInRuleGroup(params: WAFRegional.Types.ListActivatedRulesInRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListActivatedRulesInRuleGroupResponse) => void): Request; + /** + * Returns an array of ActivatedRule objects. + */ + listActivatedRulesInRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.ListActivatedRulesInRuleGroupResponse) => void): Request; + /** + * Returns an array of ByteMatchSetSummary objects. + */ + listByteMatchSets(params: WAFRegional.Types.ListByteMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListByteMatchSetsResponse) => void): Request; + /** + * Returns an array of ByteMatchSetSummary objects. + */ + listByteMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListByteMatchSetsResponse) => void): Request; + /** + * Returns an array of GeoMatchSetSummary objects in the response. + */ + listGeoMatchSets(params: WAFRegional.Types.ListGeoMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListGeoMatchSetsResponse) => void): Request; + /** + * Returns an array of GeoMatchSetSummary objects in the response. + */ + listGeoMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListGeoMatchSetsResponse) => void): Request; + /** + * Returns an array of IPSetSummary objects in the response. + */ + listIPSets(params: WAFRegional.Types.ListIPSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListIPSetsResponse) => void): Request; + /** + * Returns an array of IPSetSummary objects in the response. + */ + listIPSets(callback?: (err: AWSError, data: WAFRegional.Types.ListIPSetsResponse) => void): Request; + /** + * Returns an array of LoggingConfiguration objects. + */ + listLoggingConfigurations(params: WAFRegional.Types.ListLoggingConfigurationsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListLoggingConfigurationsResponse) => void): Request; + /** + * Returns an array of LoggingConfiguration objects. + */ + listLoggingConfigurations(callback?: (err: AWSError, data: WAFRegional.Types.ListLoggingConfigurationsResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRateBasedRules(params: WAFRegional.Types.ListRateBasedRulesRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRateBasedRulesResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRateBasedRules(callback?: (err: AWSError, data: WAFRegional.Types.ListRateBasedRulesResponse) => void): Request; + /** + * Returns an array of RegexMatchSetSummary objects. + */ + listRegexMatchSets(params: WAFRegional.Types.ListRegexMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRegexMatchSetsResponse) => void): Request; + /** + * Returns an array of RegexMatchSetSummary objects. + */ + listRegexMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListRegexMatchSetsResponse) => void): Request; + /** + * Returns an array of RegexPatternSetSummary objects. + */ + listRegexPatternSets(params: WAFRegional.Types.ListRegexPatternSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRegexPatternSetsResponse) => void): Request; + /** + * Returns an array of RegexPatternSetSummary objects. + */ + listRegexPatternSets(callback?: (err: AWSError, data: WAFRegional.Types.ListRegexPatternSetsResponse) => void): Request; + /** + * Returns an array of resources associated with the specified web ACL. + */ + listResourcesForWebACL(params: WAFRegional.Types.ListResourcesForWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListResourcesForWebACLResponse) => void): Request; + /** + * Returns an array of resources associated with the specified web ACL. + */ + listResourcesForWebACL(callback?: (err: AWSError, data: WAFRegional.Types.ListResourcesForWebACLResponse) => void): Request; + /** + * Returns an array of RuleGroup objects. + */ + listRuleGroups(params: WAFRegional.Types.ListRuleGroupsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRuleGroupsResponse) => void): Request; + /** + * Returns an array of RuleGroup objects. + */ + listRuleGroups(callback?: (err: AWSError, data: WAFRegional.Types.ListRuleGroupsResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRules(params: WAFRegional.Types.ListRulesRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListRulesResponse) => void): Request; + /** + * Returns an array of RuleSummary objects. + */ + listRules(callback?: (err: AWSError, data: WAFRegional.Types.ListRulesResponse) => void): Request; + /** + * Returns an array of SizeConstraintSetSummary objects. + */ + listSizeConstraintSets(params: WAFRegional.Types.ListSizeConstraintSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListSizeConstraintSetsResponse) => void): Request; + /** + * Returns an array of SizeConstraintSetSummary objects. + */ + listSizeConstraintSets(callback?: (err: AWSError, data: WAFRegional.Types.ListSizeConstraintSetsResponse) => void): Request; + /** + * Returns an array of SqlInjectionMatchSet objects. + */ + listSqlInjectionMatchSets(params: WAFRegional.Types.ListSqlInjectionMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListSqlInjectionMatchSetsResponse) => void): Request; + /** + * Returns an array of SqlInjectionMatchSet objects. + */ + listSqlInjectionMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListSqlInjectionMatchSetsResponse) => void): Request; + /** + * Returns an array of RuleGroup objects that you are subscribed to. + */ + listSubscribedRuleGroups(params: WAFRegional.Types.ListSubscribedRuleGroupsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListSubscribedRuleGroupsResponse) => void): Request; + /** + * Returns an array of RuleGroup objects that you are subscribed to. + */ + listSubscribedRuleGroups(callback?: (err: AWSError, data: WAFRegional.Types.ListSubscribedRuleGroupsResponse) => void): Request; + /** + * Returns an array of WebACLSummary objects in the response. + */ + listWebACLs(params: WAFRegional.Types.ListWebACLsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListWebACLsResponse) => void): Request; + /** + * Returns an array of WebACLSummary objects in the response. + */ + listWebACLs(callback?: (err: AWSError, data: WAFRegional.Types.ListWebACLsResponse) => void): Request; + /** + * Returns an array of XssMatchSet objects. + */ + listXssMatchSets(params: WAFRegional.Types.ListXssMatchSetsRequest, callback?: (err: AWSError, data: WAFRegional.Types.ListXssMatchSetsResponse) => void): Request; + /** + * Returns an array of XssMatchSet objects. + */ + listXssMatchSets(callback?: (err: AWSError, data: WAFRegional.Types.ListXssMatchSetsResponse) => void): Request; + /** + * Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose . Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide. + */ + putLoggingConfiguration(params: WAFRegional.Types.PutLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFRegional.Types.PutLoggingConfigurationResponse) => void): Request; + /** + * Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose . Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide. + */ + putLoggingConfiguration(callback?: (err: AWSError, data: WAFRegional.Types.PutLoggingConfigurationResponse) => void): Request; + /** + * Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below. + */ + putPermissionPolicy(params: WAFRegional.Types.PutPermissionPolicyRequest, callback?: (err: AWSError, data: WAFRegional.Types.PutPermissionPolicyResponse) => void): Request; + /** + * Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below. + */ + putPermissionPolicy(callback?: (err: AWSError, data: WAFRegional.Types.PutPermissionPolicyResponse) => void): Request; + /** + * Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateByteMatchSet(params: WAFRegional.Types.UpdateByteMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateByteMatchSetResponse) => void): Request; + /** + * Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateByteMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateByteMatchSetResponse) => void): Request; + /** + * Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateGeoMatchSet(params: WAFRegional.Types.UpdateGeoMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateGeoMatchSetResponse) => void): Request; + /** + * Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateGeoMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateGeoMatchSetResponse) => void): Request; + /** + * Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateIPSet(params: WAFRegional.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateIPSetResponse) => void): Request; + /** + * Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateIPSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateIPSetResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. + */ + updateRateBasedRule(params: WAFRegional.Types.UpdateRateBasedRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRateBasedRuleResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. + */ + updateRateBasedRule(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRateBasedRuleResponse) => void): Request; + /** + * Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexMatchSet(params: WAFRegional.Types.UpdateRegexMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexMatchSetResponse) => void): Request; + /** + * Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexMatchSetResponse) => void): Request; + /** + * Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexPatternSet(params: WAFRegional.Types.UpdateRegexPatternSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexPatternSetResponse) => void): Request; + /** + * Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRegexPatternSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRegexPatternSetResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRule(params: WAFRegional.Types.UpdateRuleRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleResponse) => void): Request; + /** + * Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRule(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRuleGroup(params: WAFRegional.Types.UpdateRuleGroupRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleGroupResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateRuleGroup(callback?: (err: AWSError, data: WAFRegional.Types.UpdateRuleGroupResponse) => void): Request; + /** + * Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSizeConstraintSet(params: WAFRegional.Types.UpdateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateSizeConstraintSetResponse) => void): Request; + /** + * Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSizeConstraintSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateSizeConstraintSetResponse) => void): Request; + /** + * Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSqlInjectionMatchSet(params: WAFRegional.Types.UpdateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateSqlInjectionMatchSetResponse) => void): Request; + /** + * Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateSqlInjectionMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateSqlInjectionMatchSetResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateWebACL(params: WAFRegional.Types.UpdateWebACLRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateWebACLResponse) => void): Request; + /** + * Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateWebACL(callback?: (err: AWSError, data: WAFRegional.Types.UpdateWebACLResponse) => void): Request; + /** + * Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateXssMatchSet(params: WAFRegional.Types.UpdateXssMatchSetRequest, callback?: (err: AWSError, data: WAFRegional.Types.UpdateXssMatchSetResponse) => void): Request; + /** + * Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. + */ + updateXssMatchSet(callback?: (err: AWSError, data: WAFRegional.Types.UpdateXssMatchSetResponse) => void): Request; +} +declare namespace WAFRegional { + export type Action = string; + export interface ActivatedRule { + /** + * Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive. + */ + Priority: RulePriority; + /** + * The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following: ALLOW: CloudFront responds with the requested object. BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code. COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + */ + Action?: WafAction; + /** + * Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + */ + OverrideAction?: WafOverrideAction; + /** + * The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist. + */ + Type?: WafRuleType; + /** + * An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule. If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps: Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information. Submit an UpdateWebACL request that has two actions: The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude. The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude. + */ + ExcludedRules?: ExcludedRules; + } + export type ActivatedRules = ActivatedRule[]; + export interface AssociateWebACLRequest { + /** + * A unique identifier (ID) for the web ACL. + */ + WebACLId: ResourceId; + /** + * The ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + */ + ResourceArn: ResourceArn; + } + export interface AssociateWebACLResponse { + } + export interface ByteMatchSet { + /** + * The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + */ + Name?: ResourceName; + /** + * Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. + */ + ByteMatchTuples: ByteMatchTuples; + } + export type ByteMatchSetSummaries = ByteMatchSetSummary[]; + export interface ByteMatchSetSummary { + /** + * The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + */ + Name: ResourceName; + } + export interface ByteMatchSetUpdate { + /** + * Specifies whether to insert or delete a ByteMatchTuple. + */ + Action: ChangeAction; + /** + * Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet. + */ + ByteMatchTuple: ByteMatchTuple; + } + export type ByteMatchSetUpdates = ByteMatchSetUpdate[]; + export type ByteMatchTargetString = Buffer|Uint8Array|Blob|string; + export interface ByteMatchTuple { + /** + * The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch. + */ + FieldToMatch: FieldToMatch; + /** + * The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes. Valid values depend on the values that you specified for FieldToMatch: HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header. METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg. BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. If you're using the AWS WAF API Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or one of the AWS SDKs The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value. + */ + TargetString: ByteMatchTargetString; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + /** + * Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following: CONTAINS The specified part of the web request must include the value of TargetString, but the location doesn't matter. CONTAINS_WORD The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following: TargetString exactly matches the value of the specified part of the web request, such as the value of a header. TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;. TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot. TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;. EXACTLY The value of the specified part of the web request must exactly match the value of TargetString. STARTS_WITH The value of TargetString must appear at the beginning of the specified part of the web request. ENDS_WITH The value of TargetString must appear at the end of the specified part of the web request. + */ + PositionalConstraint: PositionalConstraint; + } + export type ByteMatchTuples = ByteMatchTuple[]; + export type ChangeAction = "INSERT"|"DELETE"|string; + export type ChangeToken = string; + export type ChangeTokenStatus = "PROVISIONED"|"PENDING"|"INSYNC"|string; + export type ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|string; + export type Country = string; + export interface CreateByteMatchSetRequest { + /** + * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateByteMatchSetResponse { + /** + * A ByteMatchSet that contains no ByteMatchTuple objects. + */ + ByteMatchSet?: ByteMatchSet; + /** + * The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateGeoMatchSetRequest { + /** + * A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateGeoMatchSetResponse { + /** + * The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints. + */ + GeoMatchSet?: GeoMatchSet; + /** + * The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateIPSetRequest { + /** + * A friendly name or description of the IPSet. You can't change Name after you create the IPSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateIPSetResponse { + /** + * The IPSet returned in the CreateIPSet response. + */ + IPSet?: IPSet; + /** + * The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRateBasedRuleRequest { + /** + * A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule. + */ + MetricName: MetricName; + /** + * The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule. + */ + RateKey: RateKey; + /** + * The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. + */ + RateLimit: RateLimit; + /** + * The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken: ChangeToken; + } + export interface CreateRateBasedRuleResponse { + /** + * The RateBasedRule that is returned in the CreateRateBasedRule response. + */ + Rule?: RateBasedRule; + /** + * The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRegexMatchSetRequest { + /** + * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRegexMatchSetResponse { + /** + * A RegexMatchSet that contains no RegexMatchTuple objects. + */ + RegexMatchSet?: RegexMatchSet; + /** + * The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRegexPatternSetRequest { + /** + * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRegexPatternSetResponse { + /** + * A RegexPatternSet that contains no objects. + */ + RegexPatternSet?: RegexPatternSet; + /** + * The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRuleGroupRequest { + /** + * A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup. + */ + MetricName: MetricName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRuleGroupResponse { + /** + * An empty RuleGroup. + */ + RuleGroup?: RuleGroup; + /** + * The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateRuleRequest { + /** + * A friendly name or description of the Rule. You can't change the name of a Rule after you create it. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change the name of the metric after you create the Rule. + */ + MetricName: MetricName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateRuleResponse { + /** + * The Rule returned in the CreateRule response. + */ + Rule?: Rule; + /** + * The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateSizeConstraintSetRequest { + /** + * A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateSizeConstraintSetResponse { + /** + * A SizeConstraintSet that contains no SizeConstraint objects. + */ + SizeConstraintSet?: SizeConstraintSet; + /** + * The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateSqlInjectionMatchSetRequest { + /** + * A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateSqlInjectionMatchSetResponse { + /** + * A SqlInjectionMatchSet. + */ + SqlInjectionMatchSet?: SqlInjectionMatchSet; + /** + * The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateWebACLRequest { + /** + * A friendly name or description of the WebACL. You can't change Name after you create the WebACL. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change MetricName after you create the WebACL. + */ + MetricName: MetricName; + /** + * The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL. + */ + DefaultAction: WafAction; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateWebACLResponse { + /** + * The WebACL returned in the CreateWebACL response. + */ + WebACL?: WebACL; + /** + * The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface CreateXssMatchSetRequest { + /** + * A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet. + */ + Name: ResourceName; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface CreateXssMatchSetResponse { + /** + * An XssMatchSet. + */ + XssMatchSet?: XssMatchSet; + /** + * The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteByteMatchSetRequest { + /** + * The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteByteMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteGeoMatchSetRequest { + /** + * The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteGeoMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteIPSetRequest { + /** + * The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteIPSetResponse { + /** + * The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteLoggingConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration. + */ + ResourceArn: ResourceArn; + } + export interface DeleteLoggingConfigurationResponse { + } + export interface DeletePermissionPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy. The user making the request must be the owner of the RuleGroup. + */ + ResourceArn: ResourceArn; + } + export interface DeletePermissionPolicyResponse { + } + export interface DeleteRateBasedRuleRequest { + /** + * The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRateBasedRuleResponse { + /** + * The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRegexMatchSetRequest { + /** + * The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRegexMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRegexPatternSetRequest { + /** + * The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRegexPatternSetResponse { + /** + * The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRuleGroupResponse { + /** + * The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteRuleRequest { + /** + * The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteRuleResponse { + /** + * The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteSizeConstraintSetRequest { + /** + * The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteSizeConstraintSetResponse { + /** + * The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteSqlInjectionMatchSetRequest { + /** + * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteSqlInjectionMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteWebACLRequest { + /** + * The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteWebACLResponse { + /** + * The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DeleteXssMatchSetRequest { + /** + * The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface DeleteXssMatchSetResponse { + /** + * The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface DisassociateWebACLRequest { + /** + * The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + */ + ResourceArn: ResourceArn; + } + export interface DisassociateWebACLResponse { + } + export interface ExcludedRule { + /** + * The unique identifier for the rule to exclude from the rule group. + */ + RuleId: ResourceId; + } + export type ExcludedRules = ExcludedRule[]; + export interface FieldToMatch { + /** + * The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. + */ + Type: MatchFieldType; + /** + * When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data. + */ + Data?: MatchFieldData; + } + export interface GeoMatchConstraint { + /** + * The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value. + */ + Type: GeoMatchConstraintType; + /** + * The country that you want AWS WAF to search for. + */ + Value: GeoMatchConstraintValue; + } + export type GeoMatchConstraintType = "Country"|string; + export type GeoMatchConstraintValue = "AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CD"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KP"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"US"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW"|string; + export type GeoMatchConstraints = GeoMatchConstraint[]; + export interface GeoMatchSet { + /** + * The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + /** + * A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. + */ + Name?: ResourceName; + /** + * An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for. + */ + GeoMatchConstraints: GeoMatchConstraints; + } + export type GeoMatchSetSummaries = GeoMatchSetSummary[]; + export interface GeoMatchSetSummary { + /** + * The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet. + */ + GeoMatchSetId: ResourceId; + /** + * A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. + */ + Name: ResourceName; + } + export interface GeoMatchSetUpdate { + /** + * Specifies whether to insert or delete a country with UpdateGeoMatchSet. + */ + Action: ChangeAction; + /** + * The country from which web requests originate that you want AWS WAF to search for. + */ + GeoMatchConstraint: GeoMatchConstraint; + } + export type GeoMatchSetUpdates = GeoMatchSetUpdate[]; + export interface GetByteMatchSetRequest { + /** + * The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + } + export interface GetByteMatchSetResponse { + /** + * Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics: ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type + */ + ByteMatchSet?: ByteMatchSet; + } + export interface GetChangeTokenRequest { + } + export interface GetChangeTokenResponse { + /** + * The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request. + */ + ChangeToken?: ChangeToken; + } + export interface GetChangeTokenStatusRequest { + /** + * The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response. + */ + ChangeToken: ChangeToken; + } + export interface GetChangeTokenStatusResponse { + /** + * The status of the change token. + */ + ChangeTokenStatus?: ChangeTokenStatus; + } + export interface GetGeoMatchSetRequest { + /** + * The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + } + export interface GetGeoMatchSetResponse { + /** + * Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country. + */ + GeoMatchSet?: GeoMatchSet; + } + export interface GetIPSetRequest { + /** + * The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + } + export interface GetIPSetResponse { + /** + * Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics: IPSet: Contains IPSetDescriptors, IPSetId, and Name IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value + */ + IPSet?: IPSet; + } + export interface GetLoggingConfigurationRequest { + /** + * The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. + */ + ResourceArn: ResourceArn; + } + export interface GetLoggingConfigurationResponse { + /** + * The LoggingConfiguration for the specified web ACL. + */ + LoggingConfiguration?: LoggingConfiguration; + } + export interface GetPermissionPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy. + */ + ResourceArn: ResourceArn; + } + export interface GetPermissionPolicyResponse { + /** + * The IAM policy attached to the specified RuleGroup. + */ + Policy?: PolicyString; + } + export interface GetRateBasedRuleManagedKeysRequest { + /** + * The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + /** + * A null value and not currently used. Do not include this in your request. + */ + NextMarker?: NextMarker; + } + export interface GetRateBasedRuleManagedKeysResponse { + /** + * An array of IP addresses that currently are blocked by the specified RateBasedRule. + */ + ManagedKeys?: ManagedKeys; + /** + * A null value and not currently used. + */ + NextMarker?: NextMarker; + } + export interface GetRateBasedRuleRequest { + /** + * The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + } + export interface GetRateBasedRuleResponse { + /** + * Information about the RateBasedRule that you specified in the GetRateBasedRule request. + */ + Rule?: RateBasedRule; + } + export interface GetRegexMatchSetRequest { + /** + * The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + } + export interface GetRegexMatchSetResponse { + /** + * Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple. + */ + RegexMatchSet?: RegexMatchSet; + } + export interface GetRegexPatternSetRequest { + /** + * The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + } + export interface GetRegexPatternSetResponse { + /** + * Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for. + */ + RegexPatternSet?: RegexPatternSet; + } + export interface GetRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + } + export interface GetRuleGroupResponse { + /** + * Information about the RuleGroup that you specified in the GetRuleGroup request. + */ + RuleGroup?: RuleGroup; + } + export interface GetRuleRequest { + /** + * The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + } + export interface GetRuleResponse { + /** + * Information about the Rule that you specified in the GetRule request. For more information, see the following topics: Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId Predicate: Each Predicate object contains DataId, Negated, and Type + */ + Rule?: Rule; + } + export type GetSampledRequestsMaxItems = number; + export interface GetSampledRequestsRequest { + /** + * The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests. + */ + WebAclId: ResourceId; + /** + * RuleId is one of three values: The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests. Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL. + */ + RuleId: ResourceId; + /** + * The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + */ + TimeWindow: TimeWindow; + /** + * The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them. + */ + MaxItems: GetSampledRequestsMaxItems; + } + export interface GetSampledRequestsResponse { + /** + * A complex type that contains detailed information about each of the requests in the sample. + */ + SampledRequests?: SampledHTTPRequests; + /** + * The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range. + */ + PopulationSize?: PopulationSize; + /** + * Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. + */ + TimeWindow?: TimeWindow; + } + export interface GetSizeConstraintSetRequest { + /** + * The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + } + export interface GetSizeConstraintSetResponse { + /** + * Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics: SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name SizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type + */ + SizeConstraintSet?: SizeConstraintSet; + } + export interface GetSqlInjectionMatchSetRequest { + /** + * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + } + export interface GetSqlInjectionMatchSetResponse { + /** + * Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics: SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objects SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + SqlInjectionMatchSet?: SqlInjectionMatchSet; + } + export interface GetWebACLForResourceRequest { + /** + * The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + */ + ResourceArn: ResourceArn; + } + export interface GetWebACLForResourceResponse { + /** + * Information about the web ACL that you specified in the GetWebACLForResource request. If there is no associated resource, a null WebACLSummary is returned. + */ + WebACLSummary?: WebACLSummary; + } + export interface GetWebACLRequest { + /** + * The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + } + export interface GetWebACLResponse { + /** + * Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics: WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId DefaultAction (Data type is WafAction): Contains Type Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId Action: Contains Type + */ + WebACL?: WebACL; + } + export interface GetXssMatchSetRequest { + /** + * The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + } + export interface GetXssMatchSetResponse { + /** + * Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics: XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + XssMatchSet?: XssMatchSet; + } + export interface HTTPHeader { + /** + * The name of one of the headers in the sampled web request. + */ + Name?: HeaderName; + /** + * The value of one of the headers in the sampled web request. + */ + Value?: HeaderValue; + } + export type HTTPHeaders = HTTPHeader[]; + export type HTTPMethod = string; + export interface HTTPRequest { + /** + * The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs: c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request + */ + ClientIP?: IPString; + /** + * The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2. + */ + Country?: Country; + /** + * The part of a web request that identifies the resource, for example, /images/daily-ad.jpg. + */ + URI?: URIString; + /** + * The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. + */ + Method?: HTTPMethod; + /** + * The HTTP version specified in the sampled web request, for example, HTTP/1.1. + */ + HTTPVersion?: HTTPVersion; + /** + * A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header. + */ + Headers?: HTTPHeaders; + } + export type HTTPVersion = string; + export type HeaderName = string; + export type HeaderValue = string; + export interface IPSet { + /** + * The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet). IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + /** + * A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. + */ + Name?: ResourceName; + /** + * The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs. + */ + IPSetDescriptors: IPSetDescriptors; + } + export interface IPSetDescriptor { + /** + * Specify IPV4 or IPV6. + */ + Type: IPSetDescriptorType; + /** + * Specify an IPv4 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Specify an IPv6 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. + */ + Value: IPSetDescriptorValue; + } + export type IPSetDescriptorType = "IPV4"|"IPV6"|string; + export type IPSetDescriptorValue = string; + export type IPSetDescriptors = IPSetDescriptor[]; + export type IPSetSummaries = IPSetSummary[]; + export interface IPSetSummary { + /** + * The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet. + */ + IPSetId: ResourceId; + /** + * A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. + */ + Name: ResourceName; + } + export interface IPSetUpdate { + /** + * Specifies whether to insert or delete an IP address with UpdateIPSet. + */ + Action: ChangeAction; + /** + * The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. + */ + IPSetDescriptor: IPSetDescriptor; + } + export type IPSetUpdates = IPSetUpdate[]; + export type IPString = string; + export interface ListActivatedRulesInRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects. + */ + RuleGroupId?: ResourceId; + /** + * If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules. + */ + Limit?: PaginationLimit; + } + export interface ListActivatedRulesInRuleGroupResponse { + /** + * If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of ActivatedRules objects. + */ + ActivatedRules?: ActivatedRules; + } + export interface ListByteMatchSetsRequest { + /** + * If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListByteMatchSetsResponse { + /** + * If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of ByteMatchSetSummary objects. + */ + ByteMatchSets?: ByteMatchSetSummaries; + } + export interface ListGeoMatchSetsRequest { + /** + * If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListGeoMatchSetsResponse { + /** + * If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of GeoMatchSetSummary objects. + */ + GeoMatchSets?: GeoMatchSetSummaries; + } + export interface ListIPSetsRequest { + /** + * If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListIPSetsResponse { + /** + * If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of IPSetSummary objects. + */ + IPSets?: IPSetSummaries; + } + export interface ListLoggingConfigurationsRequest { + /** + * If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations. + */ + Limit?: PaginationLimit; + } + export interface ListLoggingConfigurationsResponse { + /** + * An array of LoggingConfiguration objects. + */ + LoggingConfigurations?: LoggingConfigurations; + /** + * If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + } + export interface ListRateBasedRulesRequest { + /** + * If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListRateBasedRulesResponse { + /** + * If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleSummary objects. + */ + Rules?: RuleSummaries; + } + export interface ListRegexMatchSetsRequest { + /** + * If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListRegexMatchSetsResponse { + /** + * If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RegexMatchSetSummary objects. + */ + RegexMatchSets?: RegexMatchSetSummaries; + } + export interface ListRegexPatternSetsRequest { + /** + * If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListRegexPatternSetsResponse { + /** + * If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RegexPatternSetSummary objects. + */ + RegexPatternSets?: RegexPatternSetSummaries; + } + export interface ListResourcesForWebACLRequest { + /** + * The unique identifier (ID) of the web ACL for which to list the associated resources. + */ + WebACLId: ResourceId; + /** + * The type of resource to list, either an application load balancer or Amazon API Gateway. + */ + ResourceType?: ResourceType; + } + export interface ListResourcesForWebACLResponse { + /** + * An array of ARNs (Amazon Resource Names) of the resources associated with the specified web ACL. An array with zero elements is returned if there are no resources associated with the web ACL. + */ + ResourceArns?: ResourceArns; + } + export interface ListRuleGroupsRequest { + /** + * If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups. + */ + Limit?: PaginationLimit; + } + export interface ListRuleGroupsResponse { + /** + * If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleGroup objects. + */ + RuleGroups?: RuleGroupSummaries; + } + export interface ListRulesRequest { + /** + * If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListRulesResponse { + /** + * If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleSummary objects. + */ + Rules?: RuleSummaries; + } + export interface ListSizeConstraintSetsRequest { + /** + * If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects. + */ + Limit?: PaginationLimit; + } + export interface ListSizeConstraintSetsResponse { + /** + * If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of SizeConstraintSetSummary objects. + */ + SizeConstraintSets?: SizeConstraintSetSummaries; + } + export interface ListSqlInjectionMatchSetsRequest { + /** + * If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListSqlInjectionMatchSetsResponse { + /** + * If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of SqlInjectionMatchSetSummary objects. + */ + SqlInjectionMatchSets?: SqlInjectionMatchSetSummaries; + } + export interface ListSubscribedRuleGroupsRequest { + /** + * If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects. + */ + Limit?: PaginationLimit; + } + export interface ListSubscribedRuleGroupsResponse { + /** + * If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of RuleGroup objects. + */ + RuleGroups?: SubscribedRuleGroupSummaries; + } + export interface ListWebACLsRequest { + /** + * If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects. + */ + Limit?: PaginationLimit; + } + export interface ListWebACLsResponse { + /** + * If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of WebACLSummary objects. + */ + WebACLs?: WebACLSummaries; + } + export interface ListXssMatchSetsRequest { + /** + * If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets. + */ + NextMarker?: NextMarker; + /** + * Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. + */ + Limit?: PaginationLimit; + } + export interface ListXssMatchSetsResponse { + /** + * If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. + */ + NextMarker?: NextMarker; + /** + * An array of XssMatchSetSummary objects. + */ + XssMatchSets?: XssMatchSetSummaries; + } + export type LogDestinationConfigs = ResourceArn[]; + export interface LoggingConfiguration { + /** + * The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. + */ + ResourceArn: ResourceArn; + /** + * An array of Amazon Kinesis Data Firehose ARNs. + */ + LogDestinationConfigs: LogDestinationConfigs; + /** + * The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx. + */ + RedactedFields?: RedactedFields; + } + export type LoggingConfigurations = LoggingConfiguration[]; + export type ManagedKey = string; + export type ManagedKeys = ManagedKey[]; + export type MatchFieldData = string; + export type MatchFieldType = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS"|string; + export type MetricName = string; + export type Negated = boolean; + export type NextMarker = string; + export type PaginationLimit = number; + export type PolicyString = string; + export type PopulationSize = number; + export type PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD"|string; + export interface Predicate { + /** + * Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44. + */ + Negated: Negated; + /** + * The type of predicate in a Rule, such as ByteMatch or IPSet. + */ + Type: PredicateType; + /** + * A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command. + */ + DataId: ResourceId; + } + export type PredicateType = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch"|string; + export type Predicates = Predicate[]; + export interface PutLoggingConfigurationRequest { + /** + * The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor. + */ + LoggingConfiguration: LoggingConfiguration; + } + export interface PutLoggingConfigurationResponse { + /** + * The LoggingConfiguration that you submitted in the request. + */ + LoggingConfiguration?: LoggingConfiguration; + } + export interface PutPermissionPolicyRequest { + /** + * The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy. + */ + ResourceArn: ResourceArn; + /** + * The policy to attach to the specified RuleGroup. + */ + Policy: PolicyString; + } + export interface PutPermissionPolicyResponse { + } + export interface RateBasedRule { + /** + * A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule). + */ + RuleId: ResourceId; + /** + * A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule. + */ + MetricName?: MetricName; + /** + * The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule. + */ + MatchPredicates: Predicates; + /** + * The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule. + */ + RateKey: RateKey; + /** + * The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. + */ + RateLimit: RateLimit; + } + export type RateKey = "IP"|string; + export type RateLimit = number; + export type RedactedFields = FieldToMatch[]; + export interface RegexMatchSet { + /** + * The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId?: ResourceId; + /** + * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. + */ + Name?: ResourceName; + /** + * Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains: The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. + */ + RegexMatchTuples?: RegexMatchTuples; + } + export type RegexMatchSetSummaries = RegexMatchSetSummary[]; + export interface RegexMatchSetSummary { + /** + * The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + /** + * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. + */ + Name: ResourceName; + } + export interface RegexMatchSetUpdate { + /** + * Specifies whether to insert or delete a RegexMatchTuple. + */ + Action: ChangeAction; + /** + * Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet. + */ + RegexMatchTuple: RegexMatchTuple; + } + export type RegexMatchSetUpdates = RegexMatchSetUpdate[]; + export interface RegexMatchTuple { + /** + * Specifies where in a web request to look for the RegexPatternSet. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + /** + * The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + } + export type RegexMatchTuples = RegexMatchTuple[]; + export interface RegexPatternSet { + /** + * The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. + */ + Name?: ResourceName; + /** + * Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t. + */ + RegexPatternStrings: RegexPatternStrings; + } + export type RegexPatternSetSummaries = RegexPatternSetSummary[]; + export interface RegexPatternSetSummary { + /** + * The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. + */ + Name: ResourceName; + } + export interface RegexPatternSetUpdate { + /** + * Specifies whether to insert or delete a RegexPatternString. + */ + Action: ChangeAction; + /** + * Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. + */ + RegexPatternString: RegexPatternString; + } + export type RegexPatternSetUpdates = RegexPatternSetUpdate[]; + export type RegexPatternString = string; + export type RegexPatternStrings = RegexPatternString[]; + export type ResourceArn = string; + export type ResourceArns = ResourceArn[]; + export type ResourceId = string; + export type ResourceName = string; + export type ResourceType = "APPLICATION_LOAD_BALANCER"|"API_GATEWAY"|string; + export interface Rule { + /** + * A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * The friendly name or description for the Rule. You can't change the name of a Rule after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the Rule. + */ + MetricName?: MetricName; + /** + * The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. + */ + Predicates: Predicates; + } + export interface RuleGroup { + /** + * A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup. + */ + MetricName?: MetricName; + } + export type RuleGroupSummaries = RuleGroupSummary[]; + export interface RuleGroupSummary { + /** + * A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. + */ + Name: ResourceName; + } + export interface RuleGroupUpdate { + /** + * Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup. + */ + Action: ChangeAction; + /** + * The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). + */ + ActivatedRule: ActivatedRule; + } + export type RuleGroupUpdates = RuleGroupUpdate[]; + export type RulePriority = number; + export type RuleSummaries = RuleSummary[]; + export interface RuleSummary { + /** + * A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * A friendly name or description of the Rule. You can't change the name of a Rule after you create it. + */ + Name: ResourceName; + } + export interface RuleUpdate { + /** + * Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule. + */ + Action: ChangeAction; + /** + * The ID of the Predicate (such as an IPSet) that you want to add to a Rule. + */ + Predicate: Predicate; + } + export type RuleUpdates = RuleUpdate[]; + export type SampleWeight = number; + export interface SampledHTTPRequest { + /** + * A complex type that contains detailed information about the request. + */ + Request: HTTPRequest; + /** + * A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1. + */ + Weight: SampleWeight; + /** + * The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds). + */ + Timestamp?: Timestamp; + /** + * The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. + */ + Action?: Action; + /** + * This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response. + */ + RuleWithinRuleGroup?: ResourceId; + } + export type SampledHTTPRequests = SampledHTTPRequest[]; + export type Size = number; + export interface SizeConstraint { + /** + * Specifies where in a web request to look for the size constraint. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. NONE Specify NONE if you don't want to perform any text transformations. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. + */ + TextTransformation: TextTransformation; + /** + * The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. EQ: Used to test if the Size is equal to the size of the FieldToMatch NE: Used to test if the Size is not equal to the size of the FieldToMatch LE: Used to test if the Size is less than or equal to the size of the FieldToMatch LT: Used to test if the Size is strictly less than the size of the FieldToMatch GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch GT: Used to test if the Size is strictly greater than the size of the FieldToMatch + */ + ComparisonOperator: ComparisonOperator; + /** + * The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. + */ + Size: Size; + } + export interface SizeConstraintSet { + /** + * A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The name, if any, of the SizeConstraintSet. + */ + Name?: ResourceName; + /** + * Specifies the parts of web requests that you want to inspect the size of. + */ + SizeConstraints: SizeConstraints; + } + export type SizeConstraintSetSummaries = SizeConstraintSetSummary[]; + export interface SizeConstraintSetSummary { + /** + * A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The name of the SizeConstraintSet, if any. + */ + Name: ResourceName; + } + export interface SizeConstraintSetUpdate { + /** + * Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet. + */ + Action: ChangeAction; + /** + * Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. + */ + SizeConstraint: SizeConstraint; + } + export type SizeConstraintSetUpdates = SizeConstraintSetUpdate[]; + export type SizeConstraints = SizeConstraint[]; + export interface SqlInjectionMatchSet { + /** + * A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The name, if any, of the SqlInjectionMatchSet. + */ + Name?: ResourceName; + /** + * Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code. + */ + SqlInjectionMatchTuples: SqlInjectionMatchTuples; + } + export type SqlInjectionMatchSetSummaries = SqlInjectionMatchSetSummary[]; + export interface SqlInjectionMatchSetSummary { + /** + * A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The name of the SqlInjectionMatchSet, if any, specified by Id. + */ + Name: ResourceName; + } + export interface SqlInjectionMatchSetUpdate { + /** + * Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet. + */ + Action: ChangeAction; + /** + * Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. + */ + SqlInjectionMatchTuple: SqlInjectionMatchTuple; + } + export type SqlInjectionMatchSetUpdates = SqlInjectionMatchSetUpdate[]; + export interface SqlInjectionMatchTuple { + /** + * Specifies where in a web request to look for snippets of malicious SQL code. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + } + export type SqlInjectionMatchTuples = SqlInjectionMatchTuple[]; + export type SubscribedRuleGroupSummaries = SubscribedRuleGroupSummary[]; + export interface SubscribedRuleGroupSummary { + /** + * A unique identifier for a RuleGroup. + */ + RuleGroupId: ResourceId; + /** + * A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. + */ + Name: ResourceName; + /** + * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup. + */ + MetricName: MetricName; + } + export type TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE"|string; + export interface TimeWindow { + /** + * The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + */ + StartTime: Timestamp; + /** + * The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours. + */ + EndTime: Timestamp; + } + export type Timestamp = Date; + export type URIString = string; + export interface UpdateByteMatchSetRequest { + /** + * The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. + */ + ByteMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types: ByteMatchSetUpdate: Contains Action and ByteMatchTuple ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type + */ + Updates: ByteMatchSetUpdates; + } + export interface UpdateByteMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateGeoMatchSetRequest { + /** + * The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + */ + GeoMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types: GeoMatchSetUpdate: Contains Action and GeoMatchConstraint GeoMatchConstraint: Contains Type and Value You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request. + */ + Updates: GeoMatchSetUpdates; + } + export interface UpdateGeoMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateIPSetRequest { + /** + * The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets. + */ + IPSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types: IPSetUpdate: Contains Action and IPSetDescriptor IPSetDescriptor: Contains Type and Value You can insert a maximum of 1000 addresses in a single request. + */ + Updates: IPSetUpdates; + } + export interface UpdateIPSetResponse { + /** + * The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRateBasedRuleRequest { + /** + * The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule. + */ + Updates: RuleUpdates; + /** + * The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. + */ + RateLimit: RateLimit; + } + export interface UpdateRateBasedRuleResponse { + /** + * The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRegexMatchSetRequest { + /** + * The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + */ + RegexMatchSetId: ResourceId; + /** + * An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple. + */ + Updates: RegexMatchSetUpdates; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface UpdateRegexMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRegexPatternSetRequest { + /** + * The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. + */ + RegexPatternSetId: ResourceId; + /** + * An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet. + */ + Updates: RegexPatternSetUpdates; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface UpdateRegexPatternSetResponse { + /** + * The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRuleGroupRequest { + /** + * The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + */ + RuleGroupId: ResourceId; + /** + * An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup. You can only insert REGULAR rules into a rule group. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + */ + Updates: RuleGroupUpdates; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + } + export interface UpdateRuleGroupResponse { + /** + * The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateRuleRequest { + /** + * The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules. + */ + RuleId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types: RuleUpdate: Contains Action and Predicate Predicate: Contains DataId, Negated, and Type FieldToMatch: Contains Data and Type + */ + Updates: RuleUpdates; + } + export interface UpdateRuleResponse { + /** + * The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateSizeConstraintSetRequest { + /** + * The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. + */ + SizeConstraintSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types: SizeConstraintSetUpdate: Contains Action and SizeConstraint SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type + */ + Updates: SizeConstraintSetUpdates; + } + export interface UpdateSizeConstraintSetResponse { + /** + * The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateSqlInjectionMatchSetRequest { + /** + * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. + */ + SqlInjectionMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types: SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + Updates: SqlInjectionMatchSetUpdates; + } + export interface UpdateSqlInjectionMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateWebACLRequest { + /** + * The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of updates to make to the WebACL. An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types: WebACLUpdate: Contains Action and ActivatedRule ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. WafAction: Contains Type + */ + Updates?: WebACLUpdates; + /** + * A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL. + */ + DefaultAction?: WafAction; + } + export interface UpdateWebACLResponse { + /** + * The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface UpdateXssMatchSetRequest { + /** + * The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The value returned by the most recent call to GetChangeToken. + */ + ChangeToken: ChangeToken; + /** + * An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types: XssMatchSetUpdate: Contains Action and XssMatchTuple XssMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type + */ + Updates: XssMatchSetUpdates; + } + export interface UpdateXssMatchSetResponse { + /** + * The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. + */ + ChangeToken?: ChangeToken; + } + export interface WafAction { + /** + * Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following: ALLOW: AWS WAF allows requests BLOCK: AWS WAF blocks requests COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL. + */ + Type: WafActionType; + } + export type WafActionType = "BLOCK"|"ALLOW"|"COUNT"|string; + export interface WafOverrideAction { + /** + * COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place. + */ + Type: WafOverrideActionType; + } + export type WafOverrideActionType = "NONE"|"COUNT"|string; + export type WafRuleType = "REGULAR"|"RATE_BASED"|"GROUP"|string; + export interface WebACL { + /** + * A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. + */ + Name?: ResourceName; + /** + * A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL. + */ + MetricName?: MetricName; + /** + * The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object. + */ + DefaultAction: WafAction; + /** + * An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule. + */ + Rules: ActivatedRules; + /** + * Tha Amazon Resource Name (ARN) of the web ACL. + */ + WebACLArn?: ResourceArn; + } + export type WebACLSummaries = WebACLSummary[]; + export interface WebACLSummary { + /** + * A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. + */ + WebACLId: ResourceId; + /** + * A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. + */ + Name: ResourceName; + } + export interface WebACLUpdate { + /** + * Specifies whether to insert a Rule into or delete a Rule from a WebACL. + */ + Action: ChangeAction; + /** + * The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). + */ + ActivatedRule: ActivatedRule; + } + export type WebACLUpdates = WebACLUpdate[]; + export interface XssMatchSet { + /** + * A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The name, if any, of the XssMatchSet. + */ + Name?: ResourceName; + /** + * Specifies the parts of web requests that you want to inspect for cross-site scripting attacks. + */ + XssMatchTuples: XssMatchTuples; + } + export type XssMatchSetSummaries = XssMatchSetSummary[]; + export interface XssMatchSetSummary { + /** + * A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. + */ + XssMatchSetId: ResourceId; + /** + * The name of the XssMatchSet, if any, specified by Id. + */ + Name: ResourceName; + } + export interface XssMatchSetUpdate { + /** + * Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet. + */ + Action: ChangeAction; + /** + * Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. + */ + XssMatchTuple: XssMatchTuple; + } + export type XssMatchSetUpdates = XssMatchSetUpdate[]; + export interface XssMatchTuple { + /** + * Specifies where in a web request to look for cross-site scripting attacks. + */ + FieldToMatch: FieldToMatch; + /** + * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. + */ + TextTransformation: TextTransformation; + } + export type XssMatchTuples = XssMatchTuple[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-11-28"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the WAFRegional client. + */ + export import Types = WAFRegional; +} +export = WAFRegional; diff --git a/node_modules/aws-sdk/clients/wafregional.js b/node_modules/aws-sdk/clients/wafregional.js new file mode 100644 index 0000000..8e806aa --- /dev/null +++ b/node_modules/aws-sdk/clients/wafregional.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['wafregional'] = {}; +AWS.WAFRegional = Service.defineService('wafregional', ['2016-11-28']); +Object.defineProperty(apiLoader.services['wafregional'], '2016-11-28', { + get: function get() { + var model = require('../apis/waf-regional-2016-11-28.min.json'); + model.paginators = require('../apis/waf-regional-2016-11-28.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.WAFRegional; diff --git a/node_modules/aws-sdk/clients/workdocs.d.ts b/node_modules/aws-sdk/clients/workdocs.d.ts new file mode 100644 index 0000000..841caa3 --- /dev/null +++ b/node_modules/aws-sdk/clients/workdocs.d.ts @@ -0,0 +1,1979 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class WorkDocs extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: WorkDocs.Types.ClientConfiguration) + config: Config & WorkDocs.Types.ClientConfiguration; + /** + * Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so. + */ + abortDocumentVersionUpload(params: WorkDocs.Types.AbortDocumentVersionUploadRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so. + */ + abortDocumentVersionUpload(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Activates the specified user. Only active users can access Amazon WorkDocs. + */ + activateUser(params: WorkDocs.Types.ActivateUserRequest, callback?: (err: AWSError, data: WorkDocs.Types.ActivateUserResponse) => void): Request; + /** + * Activates the specified user. Only active users can access Amazon WorkDocs. + */ + activateUser(callback?: (err: AWSError, data: WorkDocs.Types.ActivateUserResponse) => void): Request; + /** + * Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions. + */ + addResourcePermissions(params: WorkDocs.Types.AddResourcePermissionsRequest, callback?: (err: AWSError, data: WorkDocs.Types.AddResourcePermissionsResponse) => void): Request; + /** + * Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions. + */ + addResourcePermissions(callback?: (err: AWSError, data: WorkDocs.Types.AddResourcePermissionsResponse) => void): Request; + /** + * Adds a new comment to the specified document version. + */ + createComment(params: WorkDocs.Types.CreateCommentRequest, callback?: (err: AWSError, data: WorkDocs.Types.CreateCommentResponse) => void): Request; + /** + * Adds a new comment to the specified document version. + */ + createComment(callback?: (err: AWSError, data: WorkDocs.Types.CreateCommentResponse) => void): Request; + /** + * Adds one or more custom properties to the specified resource (a folder, document, or version). + */ + createCustomMetadata(params: WorkDocs.Types.CreateCustomMetadataRequest, callback?: (err: AWSError, data: WorkDocs.Types.CreateCustomMetadataResponse) => void): Request; + /** + * Adds one or more custom properties to the specified resource (a folder, document, or version). + */ + createCustomMetadata(callback?: (err: AWSError, data: WorkDocs.Types.CreateCustomMetadataResponse) => void): Request; + /** + * Creates a folder with the specified name and parent folder. + */ + createFolder(params: WorkDocs.Types.CreateFolderRequest, callback?: (err: AWSError, data: WorkDocs.Types.CreateFolderResponse) => void): Request; + /** + * Creates a folder with the specified name and parent folder. + */ + createFolder(callback?: (err: AWSError, data: WorkDocs.Types.CreateFolderResponse) => void): Request; + /** + * Adds the specified list of labels to the given resource (a document or folder) + */ + createLabels(params: WorkDocs.Types.CreateLabelsRequest, callback?: (err: AWSError, data: WorkDocs.Types.CreateLabelsResponse) => void): Request; + /** + * Adds the specified list of labels to the given resource (a document or folder) + */ + createLabels(callback?: (err: AWSError, data: WorkDocs.Types.CreateLabelsResponse) => void): Request; + /** + * Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide. + */ + createNotificationSubscription(params: WorkDocs.Types.CreateNotificationSubscriptionRequest, callback?: (err: AWSError, data: WorkDocs.Types.CreateNotificationSubscriptionResponse) => void): Request; + /** + * Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide. + */ + createNotificationSubscription(callback?: (err: AWSError, data: WorkDocs.Types.CreateNotificationSubscriptionResponse) => void): Request; + /** + * Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs. + */ + createUser(params: WorkDocs.Types.CreateUserRequest, callback?: (err: AWSError, data: WorkDocs.Types.CreateUserResponse) => void): Request; + /** + * Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs. + */ + createUser(callback?: (err: AWSError, data: WorkDocs.Types.CreateUserResponse) => void): Request; + /** + * Deactivates the specified user, which revokes the user's access to Amazon WorkDocs. + */ + deactivateUser(params: WorkDocs.Types.DeactivateUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deactivates the specified user, which revokes the user's access to Amazon WorkDocs. + */ + deactivateUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified comment from the document version. + */ + deleteComment(params: WorkDocs.Types.DeleteCommentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified comment from the document version. + */ + deleteComment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes custom metadata from the specified resource. + */ + deleteCustomMetadata(params: WorkDocs.Types.DeleteCustomMetadataRequest, callback?: (err: AWSError, data: WorkDocs.Types.DeleteCustomMetadataResponse) => void): Request; + /** + * Deletes custom metadata from the specified resource. + */ + deleteCustomMetadata(callback?: (err: AWSError, data: WorkDocs.Types.DeleteCustomMetadataResponse) => void): Request; + /** + * Permanently deletes the specified document and its associated metadata. + */ + deleteDocument(params: WorkDocs.Types.DeleteDocumentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Permanently deletes the specified document and its associated metadata. + */ + deleteDocument(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Permanently deletes the specified folder and its contents. + */ + deleteFolder(params: WorkDocs.Types.DeleteFolderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Permanently deletes the specified folder and its contents. + */ + deleteFolder(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the contents of the specified folder. + */ + deleteFolderContents(params: WorkDocs.Types.DeleteFolderContentsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the contents of the specified folder. + */ + deleteFolderContents(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified list of labels from a resource. + */ + deleteLabels(params: WorkDocs.Types.DeleteLabelsRequest, callback?: (err: AWSError, data: WorkDocs.Types.DeleteLabelsResponse) => void): Request; + /** + * Deletes the specified list of labels from a resource. + */ + deleteLabels(callback?: (err: AWSError, data: WorkDocs.Types.DeleteLabelsResponse) => void): Request; + /** + * Deletes the specified subscription from the specified organization. + */ + deleteNotificationSubscription(params: WorkDocs.Types.DeleteNotificationSubscriptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified subscription from the specified organization. + */ + deleteNotificationSubscription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified user from a Simple AD or Microsoft AD directory. + */ + deleteUser(params: WorkDocs.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Deletes the specified user from a Simple AD or Microsoft AD directory. + */ + deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Describes the user activities in a specified time period. + */ + describeActivities(params: WorkDocs.Types.DescribeActivitiesRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeActivitiesResponse) => void): Request; + /** + * Describes the user activities in a specified time period. + */ + describeActivities(callback?: (err: AWSError, data: WorkDocs.Types.DescribeActivitiesResponse) => void): Request; + /** + * List all the comments for the specified document version. + */ + describeComments(params: WorkDocs.Types.DescribeCommentsRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeCommentsResponse) => void): Request; + /** + * List all the comments for the specified document version. + */ + describeComments(callback?: (err: AWSError, data: WorkDocs.Types.DescribeCommentsResponse) => void): Request; + /** + * Retrieves the document versions for the specified document. By default, only active versions are returned. + */ + describeDocumentVersions(params: WorkDocs.Types.DescribeDocumentVersionsRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeDocumentVersionsResponse) => void): Request; + /** + * Retrieves the document versions for the specified document. By default, only active versions are returned. + */ + describeDocumentVersions(callback?: (err: AWSError, data: WorkDocs.Types.DescribeDocumentVersionsResponse) => void): Request; + /** + * Describes the contents of the specified folder, including its documents and subfolders. By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents. + */ + describeFolderContents(params: WorkDocs.Types.DescribeFolderContentsRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeFolderContentsResponse) => void): Request; + /** + * Describes the contents of the specified folder, including its documents and subfolders. By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents. + */ + describeFolderContents(callback?: (err: AWSError, data: WorkDocs.Types.DescribeFolderContentsResponse) => void): Request; + /** + * Describes the groups specified by the query. Groups are defined by the underlying Active Directory. + */ + describeGroups(params: WorkDocs.Types.DescribeGroupsRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeGroupsResponse) => void): Request; + /** + * Describes the groups specified by the query. Groups are defined by the underlying Active Directory. + */ + describeGroups(callback?: (err: AWSError, data: WorkDocs.Types.DescribeGroupsResponse) => void): Request; + /** + * Lists the specified notification subscriptions. + */ + describeNotificationSubscriptions(params: WorkDocs.Types.DescribeNotificationSubscriptionsRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeNotificationSubscriptionsResponse) => void): Request; + /** + * Lists the specified notification subscriptions. + */ + describeNotificationSubscriptions(callback?: (err: AWSError, data: WorkDocs.Types.DescribeNotificationSubscriptionsResponse) => void): Request; + /** + * Describes the permissions of a specified resource. + */ + describeResourcePermissions(params: WorkDocs.Types.DescribeResourcePermissionsRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeResourcePermissionsResponse) => void): Request; + /** + * Describes the permissions of a specified resource. + */ + describeResourcePermissions(callback?: (err: AWSError, data: WorkDocs.Types.DescribeResourcePermissionsResponse) => void): Request; + /** + * Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide. + */ + describeRootFolders(params: WorkDocs.Types.DescribeRootFoldersRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeRootFoldersResponse) => void): Request; + /** + * Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide. + */ + describeRootFolders(callback?: (err: AWSError, data: WorkDocs.Types.DescribeRootFoldersResponse) => void): Request; + /** + * Describes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results. + */ + describeUsers(params: WorkDocs.Types.DescribeUsersRequest, callback?: (err: AWSError, data: WorkDocs.Types.DescribeUsersResponse) => void): Request; + /** + * Describes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results. + */ + describeUsers(callback?: (err: AWSError, data: WorkDocs.Types.DescribeUsersResponse) => void): Request; + /** + * Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. + */ + getCurrentUser(params: WorkDocs.Types.GetCurrentUserRequest, callback?: (err: AWSError, data: WorkDocs.Types.GetCurrentUserResponse) => void): Request; + /** + * Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. + */ + getCurrentUser(callback?: (err: AWSError, data: WorkDocs.Types.GetCurrentUserResponse) => void): Request; + /** + * Retrieves details of a document. + */ + getDocument(params: WorkDocs.Types.GetDocumentRequest, callback?: (err: AWSError, data: WorkDocs.Types.GetDocumentResponse) => void): Request; + /** + * Retrieves details of a document. + */ + getDocument(callback?: (err: AWSError, data: WorkDocs.Types.GetDocumentResponse) => void): Request; + /** + * Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders. + */ + getDocumentPath(params: WorkDocs.Types.GetDocumentPathRequest, callback?: (err: AWSError, data: WorkDocs.Types.GetDocumentPathResponse) => void): Request; + /** + * Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders. + */ + getDocumentPath(callback?: (err: AWSError, data: WorkDocs.Types.GetDocumentPathResponse) => void): Request; + /** + * Retrieves version metadata for the specified document. + */ + getDocumentVersion(params: WorkDocs.Types.GetDocumentVersionRequest, callback?: (err: AWSError, data: WorkDocs.Types.GetDocumentVersionResponse) => void): Request; + /** + * Retrieves version metadata for the specified document. + */ + getDocumentVersion(callback?: (err: AWSError, data: WorkDocs.Types.GetDocumentVersionResponse) => void): Request; + /** + * Retrieves the metadata of the specified folder. + */ + getFolder(params: WorkDocs.Types.GetFolderRequest, callback?: (err: AWSError, data: WorkDocs.Types.GetFolderResponse) => void): Request; + /** + * Retrieves the metadata of the specified folder. + */ + getFolder(callback?: (err: AWSError, data: WorkDocs.Types.GetFolderResponse) => void): Request; + /** + * Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names. + */ + getFolderPath(params: WorkDocs.Types.GetFolderPathRequest, callback?: (err: AWSError, data: WorkDocs.Types.GetFolderPathResponse) => void): Request; + /** + * Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names. + */ + getFolderPath(callback?: (err: AWSError, data: WorkDocs.Types.GetFolderPathResponse) => void): Request; + /** + * Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME. + */ + getResources(params: WorkDocs.Types.GetResourcesRequest, callback?: (err: AWSError, data: WorkDocs.Types.GetResourcesResponse) => void): Request; + /** + * Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME. + */ + getResources(callback?: (err: AWSError, data: WorkDocs.Types.GetResourcesResponse) => void): Request; + /** + * Creates a new document object and version object. The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion. To cancel the document upload, call AbortDocumentVersionUpload. + */ + initiateDocumentVersionUpload(params: WorkDocs.Types.InitiateDocumentVersionUploadRequest, callback?: (err: AWSError, data: WorkDocs.Types.InitiateDocumentVersionUploadResponse) => void): Request; + /** + * Creates a new document object and version object. The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion. To cancel the document upload, call AbortDocumentVersionUpload. + */ + initiateDocumentVersionUpload(callback?: (err: AWSError, data: WorkDocs.Types.InitiateDocumentVersionUploadResponse) => void): Request; + /** + * Removes all the permissions from the specified resource. + */ + removeAllResourcePermissions(params: WorkDocs.Types.RemoveAllResourcePermissionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes all the permissions from the specified resource. + */ + removeAllResourcePermissions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the permission for the specified principal from the specified resource. + */ + removeResourcePermission(params: WorkDocs.Types.RemoveResourcePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Removes the permission for the specified principal from the specified resource. + */ + removeResourcePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable. + */ + updateDocument(params: WorkDocs.Types.UpdateDocumentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable. + */ + updateDocument(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload. + */ + updateDocumentVersion(params: WorkDocs.Types.UpdateDocumentVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload. + */ + updateDocumentVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable. + */ + updateFolder(params: WorkDocs.Types.UpdateFolderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable. + */ + updateFolder(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; + /** + * Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site. + */ + updateUser(params: WorkDocs.Types.UpdateUserRequest, callback?: (err: AWSError, data: WorkDocs.Types.UpdateUserResponse) => void): Request; + /** + * Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site. + */ + updateUser(callback?: (err: AWSError, data: WorkDocs.Types.UpdateUserResponse) => void): Request; +} +declare namespace WorkDocs { + export interface AbortDocumentVersionUploadRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The ID of the version. + */ + VersionId: DocumentVersionIdType; + } + export interface ActivateUserRequest { + /** + * The ID of the user. + */ + UserId: IdType; + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + } + export interface ActivateUserResponse { + /** + * The user information. + */ + User?: User; + } + export interface Activity { + /** + * The activity type. + */ + Type?: ActivityType; + /** + * The timestamp when the action was performed. + */ + TimeStamp?: TimestampType; + /** + * Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity). + */ + IsIndirectActivity?: BooleanType; + /** + * The ID of the organization. + */ + OrganizationId?: IdType; + /** + * The user who performed the action. + */ + Initiator?: UserMetadata; + /** + * The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED. + */ + Participants?: Participants; + /** + * The metadata of the resource involved in the user action. + */ + ResourceMetadata?: ResourceMetadata; + /** + * The original parent of the resource. This is an optional field and is filled for move activities. + */ + OriginalParent?: ResourceMetadata; + /** + * Metadata of the commenting activity. This is an optional field and is filled for commenting activities. + */ + CommentMetadata?: CommentMetadata; + } + export type ActivityNamesFilterType = string; + export type ActivityType = "DOCUMENT_CHECKED_IN"|"DOCUMENT_CHECKED_OUT"|"DOCUMENT_RENAMED"|"DOCUMENT_VERSION_UPLOADED"|"DOCUMENT_VERSION_DELETED"|"DOCUMENT_VERSION_VIEWED"|"DOCUMENT_VERSION_DOWNLOADED"|"DOCUMENT_RECYCLED"|"DOCUMENT_RESTORED"|"DOCUMENT_REVERTED"|"DOCUMENT_SHARED"|"DOCUMENT_UNSHARED"|"DOCUMENT_SHARE_PERMISSION_CHANGED"|"DOCUMENT_SHAREABLE_LINK_CREATED"|"DOCUMENT_SHAREABLE_LINK_REMOVED"|"DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED"|"DOCUMENT_MOVED"|"DOCUMENT_COMMENT_ADDED"|"DOCUMENT_COMMENT_DELETED"|"DOCUMENT_ANNOTATION_ADDED"|"DOCUMENT_ANNOTATION_DELETED"|"FOLDER_CREATED"|"FOLDER_DELETED"|"FOLDER_RENAMED"|"FOLDER_RECYCLED"|"FOLDER_RESTORED"|"FOLDER_SHARED"|"FOLDER_UNSHARED"|"FOLDER_SHARE_PERMISSION_CHANGED"|"FOLDER_SHAREABLE_LINK_CREATED"|"FOLDER_SHAREABLE_LINK_REMOVED"|"FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED"|"FOLDER_MOVED"|string; + export interface AddResourcePermissionsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the resource. + */ + ResourceId: ResourceIdType; + /** + * The users, groups, or organization being granted permission. + */ + Principals: SharePrincipalList; + /** + * The notification options. + */ + NotificationOptions?: NotificationOptions; + } + export interface AddResourcePermissionsResponse { + /** + * The share results. + */ + ShareResults?: ShareResultsList; + } + export type AuthenticationHeaderType = string; + export type BooleanEnumType = "TRUE"|"FALSE"|string; + export type BooleanType = boolean; + export interface Comment { + /** + * The ID of the comment. + */ + CommentId: CommentIdType; + /** + * The ID of the parent comment. + */ + ParentId?: CommentIdType; + /** + * The ID of the root comment in the thread. + */ + ThreadId?: CommentIdType; + /** + * The text of the comment. + */ + Text?: CommentTextType; + /** + * The details of the user who made the comment. + */ + Contributor?: User; + /** + * The time that the comment was created. + */ + CreatedTimestamp?: TimestampType; + /** + * The status of the comment. + */ + Status?: CommentStatusType; + /** + * The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors. + */ + Visibility?: CommentVisibilityType; + /** + * If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to. + */ + RecipientId?: IdType; + } + export type CommentIdType = string; + export type CommentList = Comment[]; + export interface CommentMetadata { + /** + * The ID of the comment. + */ + CommentId?: CommentIdType; + /** + * The user who made the comment. + */ + Contributor?: User; + /** + * The timestamp that the comment was created. + */ + CreatedTimestamp?: TimestampType; + /** + * The status of the comment. + */ + CommentStatus?: CommentStatusType; + /** + * The ID of the user being replied to. + */ + RecipientId?: IdType; + } + export type CommentStatusType = "DRAFT"|"PUBLISHED"|"DELETED"|string; + export type CommentTextType = string; + export type CommentVisibilityType = "PUBLIC"|"PRIVATE"|string; + export interface CreateCommentRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The ID of the document version. + */ + VersionId: DocumentVersionIdType; + /** + * The ID of the parent comment. + */ + ParentId?: CommentIdType; + /** + * The ID of the root comment in the thread. + */ + ThreadId?: CommentIdType; + /** + * The text of the comment. + */ + Text: CommentTextType; + /** + * The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors. + */ + Visibility?: CommentVisibilityType; + /** + * Set this parameter to TRUE to send an email out to the document collaborators after the comment is created. + */ + NotifyCollaborators?: BooleanType; + } + export interface CreateCommentResponse { + /** + * The comment that has been created. + */ + Comment?: Comment; + } + export interface CreateCustomMetadataRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the resource. + */ + ResourceId: ResourceIdType; + /** + * The ID of the version, if the custom metadata is being added to a document version. + */ + VersionId?: DocumentVersionIdType; + /** + * Custom metadata in the form of name-value pairs. + */ + CustomMetadata: CustomMetadataMap; + } + export interface CreateCustomMetadataResponse { + } + export interface CreateFolderRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The name of the new folder. + */ + Name?: ResourceNameType; + /** + * The ID of the parent folder. + */ + ParentFolderId: ResourceIdType; + } + export interface CreateFolderResponse { + /** + * The metadata of the folder. + */ + Metadata?: FolderMetadata; + } + export interface CreateLabelsRequest { + /** + * The ID of the resource. + */ + ResourceId: ResourceIdType; + /** + * List of labels to add to the resource. + */ + Labels: SharedLabels; + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + } + export interface CreateLabelsResponse { + } + export interface CreateNotificationSubscriptionRequest { + /** + * The ID of the organization. + */ + OrganizationId: IdType; + /** + * The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https. + */ + Endpoint: SubscriptionEndPointType; + /** + * The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST. + */ + Protocol: SubscriptionProtocolType; + /** + * The notification type. + */ + SubscriptionType: SubscriptionType; + } + export interface CreateNotificationSubscriptionResponse { + /** + * The subscription. + */ + Subscription?: Subscription; + } + export interface CreateUserRequest { + /** + * The ID of the organization. + */ + OrganizationId?: IdType; + /** + * The login name of the user. + */ + Username: UsernameType; + /** + * The email address of the user. + */ + EmailAddress?: EmailAddressType; + /** + * The given name of the user. + */ + GivenName: UserAttributeValueType; + /** + * The surname of the user. + */ + Surname: UserAttributeValueType; + /** + * The password of the user. + */ + Password: PasswordType; + /** + * The time zone ID of the user. + */ + TimeZoneId?: TimeZoneIdType; + /** + * The amount of storage for the user. + */ + StorageRule?: StorageRuleType; + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + } + export interface CreateUserResponse { + /** + * The user information. + */ + User?: User; + } + export type CustomMetadataKeyList = CustomMetadataKeyType[]; + export type CustomMetadataKeyType = string; + export type CustomMetadataMap = {[key: string]: CustomMetadataValueType}; + export type CustomMetadataValueType = string; + export interface DeactivateUserRequest { + /** + * The ID of the user. + */ + UserId: IdType; + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + } + export interface DeleteCommentRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The ID of the document version. + */ + VersionId: DocumentVersionIdType; + /** + * The ID of the comment. + */ + CommentId: CommentIdType; + } + export interface DeleteCustomMetadataRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the resource, either a document or folder. + */ + ResourceId: ResourceIdType; + /** + * The ID of the version, if the custom metadata is being deleted from a document version. + */ + VersionId?: DocumentVersionIdType; + /** + * List of properties to remove. + */ + Keys?: CustomMetadataKeyList; + /** + * Flag to indicate removal of all custom metadata properties from the specified resource. + */ + DeleteAll?: BooleanType; + } + export interface DeleteCustomMetadataResponse { + } + export interface DeleteDocumentRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + } + export interface DeleteFolderContentsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the folder. + */ + FolderId: ResourceIdType; + } + export interface DeleteFolderRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the folder. + */ + FolderId: ResourceIdType; + } + export interface DeleteLabelsRequest { + /** + * The ID of the resource. + */ + ResourceId: ResourceIdType; + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * List of labels to delete from the resource. + */ + Labels?: SharedLabels; + /** + * Flag to request removal of all labels from the specified resource. + */ + DeleteAll?: BooleanType; + } + export interface DeleteLabelsResponse { + } + export interface DeleteNotificationSubscriptionRequest { + /** + * The ID of the subscription. + */ + SubscriptionId: IdType; + /** + * The ID of the organization. + */ + OrganizationId: IdType; + } + export interface DeleteUserRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the user. + */ + UserId: IdType; + } + export interface DescribeActivitiesRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp. + */ + StartTime?: TimestampType; + /** + * The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp. + */ + EndTime?: TimestampType; + /** + * The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests. + */ + OrganizationId?: IdType; + /** + * Specifies which activity types to include in the response. If this field is left empty, all activity types are returned. + */ + ActivityTypes?: ActivityNamesFilterType; + /** + * The document or folder ID for which to describe activity types. + */ + ResourceId?: IdType; + /** + * The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests. + */ + UserId?: IdType; + /** + * Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity). + */ + IncludeIndirectActivities?: BooleanType; + /** + * The maximum number of items to return. + */ + Limit?: LimitType; + /** + * The marker for the next set of results. + */ + Marker?: MarkerType; + } + export interface DescribeActivitiesResponse { + /** + * The list of activities for the specified user and time period. + */ + UserActivities?: UserActivities; + /** + * The marker for the next set of results. + */ + Marker?: MarkerType; + } + export interface DescribeCommentsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The ID of the document version. + */ + VersionId: DocumentVersionIdType; + /** + * The maximum number of items to return. + */ + Limit?: LimitType; + /** + * The marker for the next set of results. This marker was received from a previous call. + */ + Marker?: MarkerType; + } + export interface DescribeCommentsResponse { + /** + * The list of comments for the specified document version. + */ + Comments?: CommentList; + /** + * The marker for the next set of results. This marker was received from a previous call. + */ + Marker?: MarkerType; + } + export interface DescribeDocumentVersionsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: PageMarkerType; + /** + * The maximum number of versions to return with this call. + */ + Limit?: LimitType; + /** + * A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions. + */ + Include?: FieldNamesType; + /** + * Specify "SOURCE" to include initialized versions and a URL for the source document. + */ + Fields?: FieldNamesType; + } + export interface DescribeDocumentVersionsResponse { + /** + * The document versions. + */ + DocumentVersions?: DocumentVersionMetadataList; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + Marker?: PageMarkerType; + } + export interface DescribeFolderContentsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the folder. + */ + FolderId: ResourceIdType; + /** + * The sorting criteria. + */ + Sort?: ResourceSortType; + /** + * The order for the contents of the folder. + */ + Order?: OrderType; + /** + * The maximum number of items to return with this call. + */ + Limit?: LimitType; + /** + * The marker for the next set of results. This marker was received from a previous call. + */ + Marker?: PageMarkerType; + /** + * The type of items. + */ + Type?: FolderContentType; + /** + * The contents to include. Specify "INITIALIZED" to include initialized documents. + */ + Include?: FieldNamesType; + } + export interface DescribeFolderContentsResponse { + /** + * The subfolders in the specified folder. + */ + Folders?: FolderMetadataList; + /** + * The documents in the specified folder. + */ + Documents?: DocumentMetadataList; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + Marker?: PageMarkerType; + } + export interface DescribeGroupsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * A query to describe groups by group name. + */ + SearchQuery: SearchQueryType; + /** + * The ID of the organization. + */ + OrganizationId?: IdType; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: MarkerType; + /** + * The maximum number of items to return with this call. + */ + Limit?: PositiveIntegerType; + } + export interface DescribeGroupsResponse { + /** + * The list of groups. + */ + Groups?: GroupMetadataList; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + Marker?: MarkerType; + } + export interface DescribeNotificationSubscriptionsRequest { + /** + * The ID of the organization. + */ + OrganizationId: IdType; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: PageMarkerType; + /** + * The maximum number of items to return with this call. + */ + Limit?: LimitType; + } + export interface DescribeNotificationSubscriptionsResponse { + /** + * The subscriptions. + */ + Subscriptions?: SubscriptionList; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + Marker?: PageMarkerType; + } + export interface DescribeResourcePermissionsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the resource. + */ + ResourceId: ResourceIdType; + /** + * The ID of the principal to filter permissions by. + */ + PrincipalId?: IdType; + /** + * The maximum number of items to return with this call. + */ + Limit?: LimitType; + /** + * The marker for the next set of results. (You received this marker from a previous call) + */ + Marker?: PageMarkerType; + } + export interface DescribeResourcePermissionsResponse { + /** + * The principals. + */ + Principals?: PrincipalList; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + Marker?: PageMarkerType; + } + export interface DescribeRootFoldersRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken: AuthenticationHeaderType; + /** + * The maximum number of items to return. + */ + Limit?: LimitType; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: PageMarkerType; + } + export interface DescribeRootFoldersResponse { + /** + * The user's special folders. + */ + Folders?: FolderMetadataList; + /** + * The marker for the next set of results. + */ + Marker?: PageMarkerType; + } + export interface DescribeUsersRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the organization. + */ + OrganizationId?: IdType; + /** + * The IDs of the users. + */ + UserIds?: UserIdsType; + /** + * A query to filter users by user name. + */ + Query?: SearchQueryType; + /** + * The state of the users. Specify "ALL" to include inactive users. + */ + Include?: UserFilterType; + /** + * The order for the results. + */ + Order?: OrderType; + /** + * The sorting criteria. + */ + Sort?: UserSortType; + /** + * The marker for the next set of results. (You received this marker from a previous call.) + */ + Marker?: PageMarkerType; + /** + * The maximum number of items to return. + */ + Limit?: LimitType; + /** + * A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information. + */ + Fields?: FieldNamesType; + } + export interface DescribeUsersResponse { + /** + * The users. + */ + Users?: OrganizationUserList; + /** + * The total number of users included in the results. + */ + TotalNumberOfUsers?: SizeType; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + Marker?: PageMarkerType; + } + export type DocumentContentType = string; + export interface DocumentMetadata { + /** + * The ID of the document. + */ + Id?: ResourceIdType; + /** + * The ID of the creator. + */ + CreatorId?: IdType; + /** + * The ID of the parent folder. + */ + ParentFolderId?: ResourceIdType; + /** + * The time when the document was created. + */ + CreatedTimestamp?: TimestampType; + /** + * The time when the document was updated. + */ + ModifiedTimestamp?: TimestampType; + /** + * The latest version of the document. + */ + LatestVersionMetadata?: DocumentVersionMetadata; + /** + * The resource state. + */ + ResourceState?: ResourceStateType; + /** + * List of labels on the document. + */ + Labels?: SharedLabels; + } + export type DocumentMetadataList = DocumentMetadata[]; + export type DocumentSourceType = "ORIGINAL"|"WITH_COMMENTS"|string; + export type DocumentSourceUrlMap = {[key: string]: UrlType}; + export type DocumentStatusType = "INITIALIZED"|"ACTIVE"|string; + export type DocumentThumbnailType = "SMALL"|"SMALL_HQ"|"LARGE"|string; + export type DocumentThumbnailUrlMap = {[key: string]: UrlType}; + export type DocumentVersionIdType = string; + export interface DocumentVersionMetadata { + /** + * The ID of the version. + */ + Id?: DocumentVersionIdType; + /** + * The name of the version. + */ + Name?: ResourceNameType; + /** + * The content type of the document. + */ + ContentType?: DocumentContentType; + /** + * The size of the document, in bytes. + */ + Size?: SizeType; + /** + * The signature of the document. + */ + Signature?: HashType; + /** + * The status of the document. + */ + Status?: DocumentStatusType; + /** + * The timestamp when the document was first uploaded. + */ + CreatedTimestamp?: TimestampType; + /** + * The timestamp when the document was last uploaded. + */ + ModifiedTimestamp?: TimestampType; + /** + * The timestamp when the content of the document was originally created. + */ + ContentCreatedTimestamp?: TimestampType; + /** + * The timestamp when the content of the document was modified. + */ + ContentModifiedTimestamp?: TimestampType; + /** + * The ID of the creator. + */ + CreatorId?: IdType; + /** + * The thumbnail of the document. + */ + Thumbnail?: DocumentThumbnailUrlMap; + /** + * The source of the document. + */ + Source?: DocumentSourceUrlMap; + } + export type DocumentVersionMetadataList = DocumentVersionMetadata[]; + export type DocumentVersionStatus = "ACTIVE"|string; + export type EmailAddressType = string; + export type FieldNamesType = string; + export type FolderContentType = "ALL"|"DOCUMENT"|"FOLDER"|string; + export interface FolderMetadata { + /** + * The ID of the folder. + */ + Id?: ResourceIdType; + /** + * The name of the folder. + */ + Name?: ResourceNameType; + /** + * The ID of the creator. + */ + CreatorId?: IdType; + /** + * The ID of the parent folder. + */ + ParentFolderId?: ResourceIdType; + /** + * The time when the folder was created. + */ + CreatedTimestamp?: TimestampType; + /** + * The time when the folder was updated. + */ + ModifiedTimestamp?: TimestampType; + /** + * The resource state of the folder. + */ + ResourceState?: ResourceStateType; + /** + * The unique identifier created from the subfolders and documents of the folder. + */ + Signature?: HashType; + /** + * List of labels on the folder. + */ + Labels?: SharedLabels; + /** + * The size of the folder metadata. + */ + Size?: SizeType; + /** + * The size of the latest version of the folder metadata. + */ + LatestVersionSize?: SizeType; + } + export type FolderMetadataList = FolderMetadata[]; + export interface GetCurrentUserRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken: AuthenticationHeaderType; + } + export interface GetCurrentUserResponse { + /** + * Metadata of the user. + */ + User?: User; + } + export interface GetDocumentPathRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: IdType; + /** + * The maximum number of levels in the hierarchy to return. + */ + Limit?: LimitType; + /** + * A comma-separated list of values. Specify NAME to include the names of the parent folders. + */ + Fields?: FieldNamesType; + /** + * This value is not supported. + */ + Marker?: PageMarkerType; + } + export interface GetDocumentPathResponse { + /** + * The path information. + */ + Path?: ResourcePath; + } + export interface GetDocumentRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * Set this to TRUE to include custom metadata in the response. + */ + IncludeCustomMetadata?: BooleanType; + } + export interface GetDocumentResponse { + /** + * The metadata details of the document. + */ + Metadata?: DocumentMetadata; + /** + * The custom metadata on the document. + */ + CustomMetadata?: CustomMetadataMap; + } + export interface GetDocumentVersionRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The version ID of the document. + */ + VersionId: DocumentVersionIdType; + /** + * A comma-separated list of values. Specify "SOURCE" to include a URL for the source document. + */ + Fields?: FieldNamesType; + /** + * Set this to TRUE to include custom metadata in the response. + */ + IncludeCustomMetadata?: BooleanType; + } + export interface GetDocumentVersionResponse { + /** + * The version metadata. + */ + Metadata?: DocumentVersionMetadata; + /** + * The custom metadata on the document version. + */ + CustomMetadata?: CustomMetadataMap; + } + export interface GetFolderPathRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the folder. + */ + FolderId: IdType; + /** + * The maximum number of levels in the hierarchy to return. + */ + Limit?: LimitType; + /** + * A comma-separated list of values. Specify "NAME" to include the names of the parent folders. + */ + Fields?: FieldNamesType; + /** + * This value is not supported. + */ + Marker?: PageMarkerType; + } + export interface GetFolderPathResponse { + /** + * The path information. + */ + Path?: ResourcePath; + } + export interface GetFolderRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the folder. + */ + FolderId: ResourceIdType; + /** + * Set to TRUE to include custom metadata in the response. + */ + IncludeCustomMetadata?: BooleanType; + } + export interface GetFolderResponse { + /** + * The metadata of the folder. + */ + Metadata?: FolderMetadata; + /** + * The custom metadata on the folder. + */ + CustomMetadata?: CustomMetadataMap; + } + export interface GetResourcesRequest { + /** + * The Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API operation using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials. + */ + UserId?: IdType; + /** + * The collection type. + */ + CollectionType?: ResourceCollectionType; + /** + * The maximum number of resources to return. + */ + Limit?: LimitType; + /** + * The marker for the next set of results. This marker was received from a previous call. + */ + Marker?: PageMarkerType; + } + export interface GetResourcesResponse { + /** + * The folders in the specified folder. + */ + Folders?: FolderMetadataList; + /** + * The documents in the specified collection. + */ + Documents?: DocumentMetadataList; + /** + * The marker to use when requesting the next set of results. If there are no additional results, the string is empty. + */ + Marker?: PageMarkerType; + } + export interface GroupMetadata { + /** + * The ID of the user group. + */ + Id?: IdType; + /** + * The name of the group. + */ + Name?: GroupNameType; + } + export type GroupMetadataList = GroupMetadata[]; + export type GroupNameType = string; + export type HashType = string; + export type HeaderNameType = string; + export type HeaderValueType = string; + export type IdType = string; + export interface InitiateDocumentVersionUploadRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + Id?: ResourceIdType; + /** + * The name of the document. + */ + Name?: ResourceNameType; + /** + * The timestamp when the content of the document was originally created. + */ + ContentCreatedTimestamp?: TimestampType; + /** + * The timestamp when the content of the document was modified. + */ + ContentModifiedTimestamp?: TimestampType; + /** + * The content type of the document. + */ + ContentType?: DocumentContentType; + /** + * The size of the document, in bytes. + */ + DocumentSizeInBytes?: SizeType; + /** + * The ID of the parent folder. + */ + ParentFolderId: ResourceIdType; + } + export interface InitiateDocumentVersionUploadResponse { + /** + * The document metadata. + */ + Metadata?: DocumentMetadata; + /** + * The upload metadata. + */ + UploadMetadata?: UploadMetadata; + } + export type LimitType = number; + export type LocaleType = "en"|"fr"|"ko"|"de"|"es"|"ja"|"ru"|"zh_CN"|"zh_TW"|"pt_BR"|"default"|string; + export type MarkerType = string; + export type MessageType = string; + export interface NotificationOptions { + /** + * Boolean value to indicate an email notification should be sent to the receipients. + */ + SendEmail?: BooleanType; + /** + * Text value to be included in the email body. + */ + EmailMessage?: MessageType; + } + export type OrderType = "ASCENDING"|"DESCENDING"|string; + export type OrganizationUserList = User[]; + export type PageMarkerType = string; + export interface Participants { + /** + * The list of users. + */ + Users?: UserMetadataList; + /** + * The list of user groups. + */ + Groups?: GroupMetadataList; + } + export type PasswordType = string; + export interface PermissionInfo { + /** + * The role of the user. + */ + Role?: RoleType; + /** + * The type of permissions. + */ + Type?: RolePermissionType; + } + export type PermissionInfoList = PermissionInfo[]; + export type PositiveIntegerType = number; + export type PositiveSizeType = number; + export interface Principal { + /** + * The ID of the resource. + */ + Id?: IdType; + /** + * The type of resource. + */ + Type?: PrincipalType; + /** + * The permission information for the resource. + */ + Roles?: PermissionInfoList; + } + export type PrincipalList = Principal[]; + export type PrincipalType = "USER"|"GROUP"|"INVITE"|"ANONYMOUS"|"ORGANIZATION"|string; + export interface RemoveAllResourcePermissionsRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the resource. + */ + ResourceId: ResourceIdType; + } + export interface RemoveResourcePermissionRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the resource. + */ + ResourceId: ResourceIdType; + /** + * The principal ID of the resource. + */ + PrincipalId: IdType; + /** + * The principal type of the resource. + */ + PrincipalType?: PrincipalType; + } + export type ResourceCollectionType = "SHARED_WITH_ME"|string; + export type ResourceIdType = string; + export interface ResourceMetadata { + /** + * The type of resource. + */ + Type?: ResourceType; + /** + * The name of the resource. + */ + Name?: ResourceNameType; + /** + * The original name of the resource before a rename operation. + */ + OriginalName?: ResourceNameType; + /** + * The ID of the resource. + */ + Id?: ResourceIdType; + /** + * The version ID of the resource. This is an optional field and is filled for action on document version. + */ + VersionId?: DocumentVersionIdType; + /** + * The owner of the resource. + */ + Owner?: UserMetadata; + /** + * The parent ID of the resource before a rename operation. + */ + ParentId?: ResourceIdType; + } + export type ResourceNameType = string; + export interface ResourcePath { + /** + * The components of the resource path. + */ + Components?: ResourcePathComponentList; + } + export interface ResourcePathComponent { + /** + * The ID of the resource path. + */ + Id?: IdType; + /** + * The name of the resource path. + */ + Name?: ResourceNameType; + } + export type ResourcePathComponentList = ResourcePathComponent[]; + export type ResourceSortType = "DATE"|"NAME"|string; + export type ResourceStateType = "ACTIVE"|"RESTORING"|"RECYCLING"|"RECYCLED"|string; + export type ResourceType = "FOLDER"|"DOCUMENT"|string; + export type RolePermissionType = "DIRECT"|"INHERITED"|string; + export type RoleType = "VIEWER"|"CONTRIBUTOR"|"OWNER"|"COOWNER"|string; + export type SearchQueryType = string; + export interface SharePrincipal { + /** + * The ID of the recipient. + */ + Id: IdType; + /** + * The type of the recipient. + */ + Type: PrincipalType; + /** + * The role of the recipient. + */ + Role: RoleType; + } + export type SharePrincipalList = SharePrincipal[]; + export interface ShareResult { + /** + * The ID of the principal. + */ + PrincipalId?: IdType; + /** + * The ID of the invited user. + */ + InviteePrincipalId?: IdType; + /** + * The role. + */ + Role?: RoleType; + /** + * The status. + */ + Status?: ShareStatusType; + /** + * The ID of the resource that was shared. + */ + ShareId?: ResourceIdType; + /** + * The status message. + */ + StatusMessage?: MessageType; + } + export type ShareResultsList = ShareResult[]; + export type ShareStatusType = "SUCCESS"|"FAILURE"|string; + export type SharedLabel = string; + export type SharedLabels = SharedLabel[]; + export type SignedHeaderMap = {[key: string]: HeaderValueType}; + export type SizeType = number; + export interface StorageRuleType { + /** + * The amount of storage allocated, in bytes. + */ + StorageAllocatedInBytes?: PositiveSizeType; + /** + * The type of storage. + */ + StorageType?: StorageType; + } + export type StorageType = "UNLIMITED"|"QUOTA"|string; + export interface Subscription { + /** + * The ID of the subscription. + */ + SubscriptionId?: IdType; + /** + * The endpoint of the subscription. + */ + EndPoint?: SubscriptionEndPointType; + /** + * The protocol of the subscription. + */ + Protocol?: SubscriptionProtocolType; + } + export type SubscriptionEndPointType = string; + export type SubscriptionList = Subscription[]; + export type SubscriptionProtocolType = "HTTPS"|string; + export type SubscriptionType = "ALL"|string; + export type TimeZoneIdType = string; + export type TimestampType = Date; + export interface UpdateDocumentRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The name of the document. + */ + Name?: ResourceNameType; + /** + * The ID of the parent folder. + */ + ParentFolderId?: ResourceIdType; + /** + * The resource state of the document. Only ACTIVE and RECYCLED are supported. + */ + ResourceState?: ResourceStateType; + } + export interface UpdateDocumentVersionRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the document. + */ + DocumentId: ResourceIdType; + /** + * The version ID of the document. + */ + VersionId: DocumentVersionIdType; + /** + * The status of the version. + */ + VersionStatus?: DocumentVersionStatus; + } + export interface UpdateFolderRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the folder. + */ + FolderId: ResourceIdType; + /** + * The name of the folder. + */ + Name?: ResourceNameType; + /** + * The ID of the parent folder. + */ + ParentFolderId?: ResourceIdType; + /** + * The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API. + */ + ResourceState?: ResourceStateType; + } + export interface UpdateUserRequest { + /** + * Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials. + */ + AuthenticationToken?: AuthenticationHeaderType; + /** + * The ID of the user. + */ + UserId: IdType; + /** + * The given name of the user. + */ + GivenName?: UserAttributeValueType; + /** + * The surname of the user. + */ + Surname?: UserAttributeValueType; + /** + * The type of the user. + */ + Type?: UserType; + /** + * The amount of storage for the user. + */ + StorageRule?: StorageRuleType; + /** + * The time zone ID of the user. + */ + TimeZoneId?: TimeZoneIdType; + /** + * The locale of the user. + */ + Locale?: LocaleType; + /** + * Boolean value to determine whether the user is granted Poweruser privileges. + */ + GrantPoweruserPrivileges?: BooleanEnumType; + } + export interface UpdateUserResponse { + /** + * The user information. + */ + User?: User; + } + export interface UploadMetadata { + /** + * The URL of the upload. + */ + UploadUrl?: UrlType; + /** + * The signed headers. + */ + SignedHeaders?: SignedHeaderMap; + } + export type UrlType = string; + export interface User { + /** + * The ID of the user. + */ + Id?: IdType; + /** + * The login name of the user. + */ + Username?: UsernameType; + /** + * The email address of the user. + */ + EmailAddress?: EmailAddressType; + /** + * The given name of the user. + */ + GivenName?: UserAttributeValueType; + /** + * The surname of the user. + */ + Surname?: UserAttributeValueType; + /** + * The ID of the organization. + */ + OrganizationId?: IdType; + /** + * The ID of the root folder. + */ + RootFolderId?: ResourceIdType; + /** + * The ID of the recycle bin folder. + */ + RecycleBinFolderId?: ResourceIdType; + /** + * The status of the user. + */ + Status?: UserStatusType; + /** + * The type of user. + */ + Type?: UserType; + /** + * The time when the user was created. + */ + CreatedTimestamp?: TimestampType; + /** + * The time when the user was modified. + */ + ModifiedTimestamp?: TimestampType; + /** + * The time zone ID of the user. + */ + TimeZoneId?: TimeZoneIdType; + /** + * The locale of the user. + */ + Locale?: LocaleType; + /** + * The storage for the user. + */ + Storage?: UserStorageMetadata; + } + export type UserActivities = Activity[]; + export type UserAttributeValueType = string; + export type UserFilterType = "ALL"|"ACTIVE_PENDING"|string; + export type UserIdsType = string; + export interface UserMetadata { + /** + * The ID of the user. + */ + Id?: IdType; + /** + * The name of the user. + */ + Username?: UsernameType; + /** + * The given name of the user before a rename operation. + */ + GivenName?: UserAttributeValueType; + /** + * The surname of the user. + */ + Surname?: UserAttributeValueType; + /** + * The email address of the user. + */ + EmailAddress?: EmailAddressType; + } + export type UserMetadataList = UserMetadata[]; + export type UserSortType = "USER_NAME"|"FULL_NAME"|"STORAGE_LIMIT"|"USER_STATUS"|"STORAGE_USED"|string; + export type UserStatusType = "ACTIVE"|"INACTIVE"|"PENDING"|string; + export interface UserStorageMetadata { + /** + * The amount of storage used, in bytes. + */ + StorageUtilizedInBytes?: SizeType; + /** + * The storage for a user. + */ + StorageRule?: StorageRuleType; + } + export type UserType = "USER"|"ADMIN"|"POWERUSER"|"MINIMALUSER"|"WORKSPACESUSER"|string; + export type UsernameType = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-05-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the WorkDocs client. + */ + export import Types = WorkDocs; +} +export = WorkDocs; diff --git a/node_modules/aws-sdk/clients/workdocs.js b/node_modules/aws-sdk/clients/workdocs.js new file mode 100644 index 0000000..4ac56f8 --- /dev/null +++ b/node_modules/aws-sdk/clients/workdocs.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['workdocs'] = {}; +AWS.WorkDocs = Service.defineService('workdocs', ['2016-05-01']); +Object.defineProperty(apiLoader.services['workdocs'], '2016-05-01', { + get: function get() { + var model = require('../apis/workdocs-2016-05-01.min.json'); + model.paginators = require('../apis/workdocs-2016-05-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.WorkDocs; diff --git a/node_modules/aws-sdk/clients/worklink.d.ts b/node_modules/aws-sdk/clients/worklink.d.ts new file mode 100644 index 0000000..cbeec9e --- /dev/null +++ b/node_modules/aws-sdk/clients/worklink.d.ts @@ -0,0 +1,862 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class WorkLink extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: WorkLink.Types.ClientConfiguration) + config: Config & WorkLink.Types.ClientConfiguration; + /** + * Specifies a domain to be associated to Amazon WorkLink. + */ + associateDomain(params: WorkLink.Types.AssociateDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateDomainResponse) => void): Request; + /** + * Specifies a domain to be associated to Amazon WorkLink. + */ + associateDomain(callback?: (err: AWSError, data: WorkLink.Types.AssociateDomainResponse) => void): Request; + /** + * Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network. + */ + associateWebsiteCertificateAuthority(params: WorkLink.Types.AssociateWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse) => void): Request; + /** + * Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network. + */ + associateWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.AssociateWebsiteCertificateAuthorityResponse) => void): Request; + /** + * Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app. + */ + createFleet(params: WorkLink.Types.CreateFleetRequest, callback?: (err: AWSError, data: WorkLink.Types.CreateFleetResponse) => void): Request; + /** + * Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app. + */ + createFleet(callback?: (err: AWSError, data: WorkLink.Types.CreateFleetResponse) => void): Request; + /** + * Deletes a fleet. Prevents users from accessing previously associated websites. + */ + deleteFleet(params: WorkLink.Types.DeleteFleetRequest, callback?: (err: AWSError, data: WorkLink.Types.DeleteFleetResponse) => void): Request; + /** + * Deletes a fleet. Prevents users from accessing previously associated websites. + */ + deleteFleet(callback?: (err: AWSError, data: WorkLink.Types.DeleteFleetResponse) => void): Request; + /** + * Describes the configuration for delivering audit streams to the customer account. + */ + describeAuditStreamConfiguration(params: WorkLink.Types.DescribeAuditStreamConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeAuditStreamConfigurationResponse) => void): Request; + /** + * Describes the configuration for delivering audit streams to the customer account. + */ + describeAuditStreamConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeAuditStreamConfigurationResponse) => void): Request; + /** + * Describes the networking configuration to access the internal websites associated with the specified fleet. + */ + describeCompanyNetworkConfiguration(params: WorkLink.Types.DescribeCompanyNetworkConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeCompanyNetworkConfigurationResponse) => void): Request; + /** + * Describes the networking configuration to access the internal websites associated with the specified fleet. + */ + describeCompanyNetworkConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeCompanyNetworkConfigurationResponse) => void): Request; + /** + * Provides information about a user's device. + */ + describeDevice(params: WorkLink.Types.DescribeDeviceRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDeviceResponse) => void): Request; + /** + * Provides information about a user's device. + */ + describeDevice(callback?: (err: AWSError, data: WorkLink.Types.DescribeDeviceResponse) => void): Request; + /** + * Describes the device policy configuration for the specified fleet. + */ + describeDevicePolicyConfiguration(params: WorkLink.Types.DescribeDevicePolicyConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDevicePolicyConfigurationResponse) => void): Request; + /** + * Describes the device policy configuration for the specified fleet. + */ + describeDevicePolicyConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeDevicePolicyConfigurationResponse) => void): Request; + /** + * Provides information about the domain. + */ + describeDomain(params: WorkLink.Types.DescribeDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeDomainResponse) => void): Request; + /** + * Provides information about the domain. + */ + describeDomain(callback?: (err: AWSError, data: WorkLink.Types.DescribeDomainResponse) => void): Request; + /** + * Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details. + */ + describeFleetMetadata(params: WorkLink.Types.DescribeFleetMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeFleetMetadataResponse) => void): Request; + /** + * Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details. + */ + describeFleetMetadata(callback?: (err: AWSError, data: WorkLink.Types.DescribeFleetMetadataResponse) => void): Request; + /** + * Describes the identity provider configuration of the specified fleet. + */ + describeIdentityProviderConfiguration(params: WorkLink.Types.DescribeIdentityProviderConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeIdentityProviderConfigurationResponse) => void): Request; + /** + * Describes the identity provider configuration of the specified fleet. + */ + describeIdentityProviderConfiguration(callback?: (err: AWSError, data: WorkLink.Types.DescribeIdentityProviderConfigurationResponse) => void): Request; + /** + * Provides information about the certificate authority. + */ + describeWebsiteCertificateAuthority(params: WorkLink.Types.DescribeWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse) => void): Request; + /** + * Provides information about the certificate authority. + */ + describeWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.DescribeWebsiteCertificateAuthorityResponse) => void): Request; + /** + * Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink. + */ + disassociateDomain(params: WorkLink.Types.DisassociateDomainRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateDomainResponse) => void): Request; + /** + * Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink. + */ + disassociateDomain(callback?: (err: AWSError, data: WorkLink.Types.DisassociateDomainResponse) => void): Request; + /** + * Removes a certificate authority (CA). + */ + disassociateWebsiteCertificateAuthority(params: WorkLink.Types.DisassociateWebsiteCertificateAuthorityRequest, callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse) => void): Request; + /** + * Removes a certificate authority (CA). + */ + disassociateWebsiteCertificateAuthority(callback?: (err: AWSError, data: WorkLink.Types.DisassociateWebsiteCertificateAuthorityResponse) => void): Request; + /** + * Retrieves a list of devices registered with the specified fleet. + */ + listDevices(params: WorkLink.Types.ListDevicesRequest, callback?: (err: AWSError, data: WorkLink.Types.ListDevicesResponse) => void): Request; + /** + * Retrieves a list of devices registered with the specified fleet. + */ + listDevices(callback?: (err: AWSError, data: WorkLink.Types.ListDevicesResponse) => void): Request; + /** + * Retrieves a list of domains associated to a specified fleet. + */ + listDomains(params: WorkLink.Types.ListDomainsRequest, callback?: (err: AWSError, data: WorkLink.Types.ListDomainsResponse) => void): Request; + /** + * Retrieves a list of domains associated to a specified fleet. + */ + listDomains(callback?: (err: AWSError, data: WorkLink.Types.ListDomainsResponse) => void): Request; + /** + * Retrieves a list of fleets for the current account and Region. + */ + listFleets(params: WorkLink.Types.ListFleetsRequest, callback?: (err: AWSError, data: WorkLink.Types.ListFleetsResponse) => void): Request; + /** + * Retrieves a list of fleets for the current account and Region. + */ + listFleets(callback?: (err: AWSError, data: WorkLink.Types.ListFleetsResponse) => void): Request; + /** + * Retrieves a list of certificate authorities added for the current account and Region. + */ + listWebsiteCertificateAuthorities(params: WorkLink.Types.ListWebsiteCertificateAuthoritiesRequest, callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse) => void): Request; + /** + * Retrieves a list of certificate authorities added for the current account and Region. + */ + listWebsiteCertificateAuthorities(callback?: (err: AWSError, data: WorkLink.Types.ListWebsiteCertificateAuthoritiesResponse) => void): Request; + /** + * Moves a domain to ACTIVE status if it was in the INACTIVE status. + */ + restoreDomainAccess(params: WorkLink.Types.RestoreDomainAccessRequest, callback?: (err: AWSError, data: WorkLink.Types.RestoreDomainAccessResponse) => void): Request; + /** + * Moves a domain to ACTIVE status if it was in the INACTIVE status. + */ + restoreDomainAccess(callback?: (err: AWSError, data: WorkLink.Types.RestoreDomainAccessResponse) => void): Request; + /** + * Moves a domain to INACTIVE status if it was in the ACTIVE status. + */ + revokeDomainAccess(params: WorkLink.Types.RevokeDomainAccessRequest, callback?: (err: AWSError, data: WorkLink.Types.RevokeDomainAccessResponse) => void): Request; + /** + * Moves a domain to INACTIVE status if it was in the ACTIVE status. + */ + revokeDomainAccess(callback?: (err: AWSError, data: WorkLink.Types.RevokeDomainAccessResponse) => void): Request; + /** + * Signs the user out from all of their devices. The user can sign in again if they have valid credentials. + */ + signOutUser(params: WorkLink.Types.SignOutUserRequest, callback?: (err: AWSError, data: WorkLink.Types.SignOutUserResponse) => void): Request; + /** + * Signs the user out from all of their devices. The user can sign in again if they have valid credentials. + */ + signOutUser(callback?: (err: AWSError, data: WorkLink.Types.SignOutUserResponse) => void): Request; + /** + * Updates the audit stream configuration for the fleet. + */ + updateAuditStreamConfiguration(params: WorkLink.Types.UpdateAuditStreamConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateAuditStreamConfigurationResponse) => void): Request; + /** + * Updates the audit stream configuration for the fleet. + */ + updateAuditStreamConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateAuditStreamConfigurationResponse) => void): Request; + /** + * Updates the company network configuration for the fleet. + */ + updateCompanyNetworkConfiguration(params: WorkLink.Types.UpdateCompanyNetworkConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateCompanyNetworkConfigurationResponse) => void): Request; + /** + * Updates the company network configuration for the fleet. + */ + updateCompanyNetworkConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateCompanyNetworkConfigurationResponse) => void): Request; + /** + * Updates the device policy configuration for the fleet. + */ + updateDevicePolicyConfiguration(params: WorkLink.Types.UpdateDevicePolicyConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateDevicePolicyConfigurationResponse) => void): Request; + /** + * Updates the device policy configuration for the fleet. + */ + updateDevicePolicyConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateDevicePolicyConfigurationResponse) => void): Request; + /** + * Updates domain metadata, such as DisplayName. + */ + updateDomainMetadata(params: WorkLink.Types.UpdateDomainMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateDomainMetadataResponse) => void): Request; + /** + * Updates domain metadata, such as DisplayName. + */ + updateDomainMetadata(callback?: (err: AWSError, data: WorkLink.Types.UpdateDomainMetadataResponse) => void): Request; + /** + * Updates fleet metadata, such as DisplayName. + */ + updateFleetMetadata(params: WorkLink.Types.UpdateFleetMetadataRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateFleetMetadataResponse) => void): Request; + /** + * Updates fleet metadata, such as DisplayName. + */ + updateFleetMetadata(callback?: (err: AWSError, data: WorkLink.Types.UpdateFleetMetadataResponse) => void): Request; + /** + * Updates the identity provider configuration for the fleet. + */ + updateIdentityProviderConfiguration(params: WorkLink.Types.UpdateIdentityProviderConfigurationRequest, callback?: (err: AWSError, data: WorkLink.Types.UpdateIdentityProviderConfigurationResponse) => void): Request; + /** + * Updates the identity provider configuration for the fleet. + */ + updateIdentityProviderConfiguration(callback?: (err: AWSError, data: WorkLink.Types.UpdateIdentityProviderConfigurationResponse) => void): Request; +} +declare namespace WorkLink { + export type AcmCertificateArn = string; + export interface AssociateDomainRequest { + /** + * The Amazon Resource Name (ARN) of the fleet. + */ + FleetArn: FleetArn; + /** + * The fully qualified domain name (FQDN). + */ + DomainName: DomainName; + /** + * The ARN of an issued ACM certificate that is valid for the domain being associated. + */ + AcmCertificateArn: AcmCertificateArn; + /** + * The name to display. + */ + DisplayName?: DisplayName; + } + export interface AssociateDomainResponse { + } + export interface AssociateWebsiteCertificateAuthorityRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The root certificate of the CA. + */ + Certificate: Certificate; + /** + * The certificate name to display. + */ + DisplayName?: DisplayName; + } + export interface AssociateWebsiteCertificateAuthorityResponse { + /** + * A unique identifier for the CA. + */ + WebsiteCaId?: Id; + } + export type AuditStreamArn = string; + export type Boolean = boolean; + export type Certificate = string; + export type CertificateChain = string; + export type CompanyCode = string; + export interface CreateFleetRequest { + /** + * A unique name for the fleet. + */ + FleetName: FleetName; + /** + * The fleet name to display. + */ + DisplayName?: DisplayName; + /** + * The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. + */ + OptimizeForEndUserLocation?: Boolean; + } + export interface CreateFleetResponse { + /** + * The ARN of the fleet. + */ + FleetArn?: FleetArn; + } + export type DateTime = Date; + export interface DeleteFleetRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + } + export interface DeleteFleetResponse { + } + export interface DescribeAuditStreamConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + } + export interface DescribeAuditStreamConfigurationResponse { + /** + * The ARN of the Amazon Kinesis data stream that will receive the audit events. + */ + AuditStreamArn?: AuditStreamArn; + } + export interface DescribeCompanyNetworkConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + } + export interface DescribeCompanyNetworkConfigurationResponse { + /** + * The VPC with connectivity to associated websites. + */ + VpcId?: VpcId; + /** + * The subnets used for X-ENI connections from Amazon WorkLink rendering containers. + */ + SubnetIds?: SubnetIds; + /** + * The security groups associated with access to the provided subnets. + */ + SecurityGroupIds?: SecurityGroupIds; + } + export interface DescribeDevicePolicyConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + } + export interface DescribeDevicePolicyConfigurationResponse { + /** + * The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates. + */ + DeviceCaCertificate?: Certificate; + } + export interface DescribeDeviceRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * A unique identifier for a registered user's device. + */ + DeviceId: Id; + } + export interface DescribeDeviceResponse { + /** + * The current state of the device. + */ + Status?: DeviceStatus; + /** + * The model of the device. + */ + Model?: DeviceModel; + /** + * The manufacturer of the device. + */ + Manufacturer?: DeviceManufacturer; + /** + * The operating system of the device. + */ + OperatingSystem?: DeviceOperatingSystemName; + /** + * The operating system version of the device. + */ + OperatingSystemVersion?: DeviceOperatingSystemVersion; + /** + * The operating system patch level of the device. + */ + PatchLevel?: DevicePatchLevel; + /** + * The date that the device first signed in to Amazon WorkLink. + */ + FirstAccessedTime?: DateTime; + /** + * The date that the device last accessed Amazon WorkLink. + */ + LastAccessedTime?: DateTime; + /** + * The user name associated with the device. + */ + Username?: Username; + } + export interface DescribeDomainRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The name of the domain. + */ + DomainName: DomainName; + } + export interface DescribeDomainResponse { + /** + * The name to display. + */ + DisplayName?: DisplayName; + /** + * The time that the domain was added. + */ + CreatedTime?: DateTime; + /** + * The current state for the domain. + */ + DomainStatus?: DomainStatus; + } + export interface DescribeFleetMetadataRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + } + export interface DescribeFleetMetadataResponse { + /** + * The time that the fleet was created. + */ + CreatedTime?: DateTime; + /** + * The time that the fleet was last updated. + */ + LastUpdatedTime?: DateTime; + /** + * The name of the fleet. + */ + FleetName?: FleetName; + /** + * The name to display. + */ + DisplayName?: DisplayName; + /** + * The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. + */ + OptimizeForEndUserLocation?: Boolean; + /** + * The identifier used by users to sign in to the Amazon WorkLink app. + */ + CompanyCode?: CompanyCode; + /** + * The current state of the fleet. + */ + FleetStatus?: FleetStatus; + } + export interface DescribeIdentityProviderConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + } + export interface DescribeIdentityProviderConfigurationResponse { + /** + * The type of identity provider. + */ + IdentityProviderType?: IdentityProviderType; + /** + * The SAML metadata document uploaded to the user’s identity provider. + */ + ServiceProviderSamlMetadata?: SamlMetadata; + /** + * The SAML metadata document provided by the user’s identity provider. + */ + IdentityProviderSamlMetadata?: SamlMetadata; + } + export interface DescribeWebsiteCertificateAuthorityRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * A unique identifier for the certificate authority. + */ + WebsiteCaId: Id; + } + export interface DescribeWebsiteCertificateAuthorityResponse { + /** + * The root certificate of the certificate authority. + */ + Certificate?: Certificate; + /** + * The time that the certificate authority was added. + */ + CreatedTime?: DateTime; + /** + * The certificate name to display. + */ + DisplayName?: DisplayName; + } + export type DeviceManufacturer = string; + export type DeviceModel = string; + export type DeviceOperatingSystemName = string; + export type DeviceOperatingSystemVersion = string; + export type DevicePatchLevel = string; + export type DeviceStatus = "ACTIVE"|"SIGNED_OUT"|string; + export interface DeviceSummary { + /** + * The ID of the device. + */ + DeviceId?: Id; + /** + * The status of the device. + */ + DeviceStatus?: DeviceStatus; + } + export type DeviceSummaryList = DeviceSummary[]; + export interface DisassociateDomainRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The name of the domain. + */ + DomainName: DomainName; + } + export interface DisassociateDomainResponse { + } + export interface DisassociateWebsiteCertificateAuthorityRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * A unique identifier for the CA. + */ + WebsiteCaId: Id; + } + export interface DisassociateWebsiteCertificateAuthorityResponse { + } + export type DisplayName = string; + export type DomainName = string; + export type DomainStatus = "PENDING_VALIDATION"|"ASSOCIATING"|"ACTIVE"|"INACTIVE"|"DISASSOCIATING"|"DISASSOCIATED"|"FAILED_TO_ASSOCIATE"|"FAILED_TO_DISASSOCIATE"|string; + export interface DomainSummary { + /** + * The name of the domain. + */ + DomainName: DomainName; + /** + * The time that the domain was created. + */ + CreatedTime: DateTime; + /** + * The status of the domain. + */ + DomainStatus: DomainStatus; + /** + * The name to display. + */ + DisplayName?: DisplayName; + } + export type DomainSummaryList = DomainSummary[]; + export type FleetArn = string; + export type FleetName = string; + export type FleetStatus = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|"FAILED_TO_CREATE"|"FAILED_TO_DELETE"|string; + export interface FleetSummary { + /** + * The ARN of the fleet. + */ + FleetArn?: FleetArn; + /** + * The time when the fleet was created. + */ + CreatedTime?: DateTime; + /** + * The time when the fleet was last updated. + */ + LastUpdatedTime?: DateTime; + /** + * The name of the fleet. + */ + FleetName?: FleetName; + /** + * The name to display. + */ + DisplayName?: DisplayName; + /** + * The identifier used by users to sign into the Amazon WorkLink app. + */ + CompanyCode?: CompanyCode; + /** + * The status of the fleet. + */ + FleetStatus?: FleetStatus; + } + export type FleetSummaryList = FleetSummary[]; + export type Id = string; + export type IdentityProviderType = "SAML"|string; + export interface ListDevicesRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be included in the next page. + */ + MaxResults?: MaxResults; + } + export interface ListDevicesResponse { + /** + * Information about the devices. + */ + Devices?: DeviceSummaryList; + /** + * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: NextToken; + } + export interface ListDomainsRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be included in the next page. + */ + MaxResults?: MaxResults; + } + export interface ListDomainsResponse { + /** + * Information about the domains. + */ + Domains?: DomainSummaryList; + /** + * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: NextToken; + } + export interface ListFleetsRequest { + /** + * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: NextToken; + /** + * The maximum number of results to be included in the next page. + */ + MaxResults?: MaxResults; + } + export interface ListFleetsResponse { + /** + * The summary list of the fleets. + */ + FleetSummaryList?: FleetSummaryList; + /** + * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: NextToken; + } + export interface ListWebsiteCertificateAuthoritiesRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The maximum number of results to be included in the next page. + */ + MaxResults?: MaxResults; + /** + * The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. + */ + NextToken?: NextToken; + } + export interface ListWebsiteCertificateAuthoritiesResponse { + /** + * Information about the certificates. + */ + WebsiteCertificateAuthorities?: WebsiteCaSummaryList; + /** + * The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null. + */ + NextToken?: NextToken; + } + export type MaxResults = number; + export type NextToken = string; + export interface RestoreDomainAccessRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The name of the domain. + */ + DomainName: DomainName; + } + export interface RestoreDomainAccessResponse { + } + export interface RevokeDomainAccessRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The name of the domain. + */ + DomainName: DomainName; + } + export interface RevokeDomainAccessResponse { + } + export type SamlMetadata = string; + export type SecurityGroupId = string; + export type SecurityGroupIds = SecurityGroupId[]; + export interface SignOutUserRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The name of the user. + */ + Username: Username; + } + export interface SignOutUserResponse { + } + export type SubnetId = string; + export type SubnetIds = SubnetId[]; + export interface UpdateAuditStreamConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The ARN of the Amazon Kinesis data stream that receives the audit events. + */ + AuditStreamArn?: AuditStreamArn; + } + export interface UpdateAuditStreamConfigurationResponse { + } + export interface UpdateCompanyNetworkConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The VPC with connectivity to associated websites. + */ + VpcId: VpcId; + /** + * The subnets used for X-ENI connections from Amazon WorkLink rendering containers. + */ + SubnetIds: SubnetIds; + /** + * The security groups associated with access to the provided subnets. + */ + SecurityGroupIds: SecurityGroupIds; + } + export interface UpdateCompanyNetworkConfigurationResponse { + } + export interface UpdateDevicePolicyConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates. + */ + DeviceCaCertificate?: CertificateChain; + } + export interface UpdateDevicePolicyConfigurationResponse { + } + export interface UpdateDomainMetadataRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The name of the domain. + */ + DomainName: DomainName; + /** + * The name to display. + */ + DisplayName?: DisplayName; + } + export interface UpdateDomainMetadataResponse { + } + export interface UpdateFleetMetadataRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The fleet name to display. The existing DisplayName is unset if null is passed. + */ + DisplayName?: DisplayName; + /** + * The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. + */ + OptimizeForEndUserLocation?: Boolean; + } + export interface UpdateFleetMetadataResponse { + } + export interface UpdateIdentityProviderConfigurationRequest { + /** + * The ARN of the fleet. + */ + FleetArn: FleetArn; + /** + * The type of identity provider. + */ + IdentityProviderType: IdentityProviderType; + /** + * The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed. + */ + IdentityProviderSamlMetadata?: SamlMetadata; + } + export interface UpdateIdentityProviderConfigurationResponse { + } + export type Username = string; + export type VpcId = string; + export interface WebsiteCaSummary { + /** + * A unique identifier for the CA. + */ + WebsiteCaId?: Id; + /** + * The time when the CA was added. + */ + CreatedTime?: DateTime; + /** + * The name to display. + */ + DisplayName?: DisplayName; + } + export type WebsiteCaSummaryList = WebsiteCaSummary[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2018-09-25"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the WorkLink client. + */ + export import Types = WorkLink; +} +export = WorkLink; diff --git a/node_modules/aws-sdk/clients/worklink.js b/node_modules/aws-sdk/clients/worklink.js new file mode 100644 index 0000000..3fef564 --- /dev/null +++ b/node_modules/aws-sdk/clients/worklink.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['worklink'] = {}; +AWS.WorkLink = Service.defineService('worklink', ['2018-09-25']); +Object.defineProperty(apiLoader.services['worklink'], '2018-09-25', { + get: function get() { + var model = require('../apis/worklink-2018-09-25.min.json'); + model.paginators = require('../apis/worklink-2018-09-25.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.WorkLink; diff --git a/node_modules/aws-sdk/clients/workmail.d.ts b/node_modules/aws-sdk/clients/workmail.d.ts new file mode 100644 index 0000000..66c35eb --- /dev/null +++ b/node_modules/aws-sdk/clients/workmail.d.ts @@ -0,0 +1,1210 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class WorkMail extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: WorkMail.Types.ClientConfiguration) + config: Config & WorkMail.Types.ClientConfiguration; + /** + * Adds a member (user or group) to the resource's set of delegates. + */ + associateDelegateToResource(params: WorkMail.Types.AssociateDelegateToResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.AssociateDelegateToResourceResponse) => void): Request; + /** + * Adds a member (user or group) to the resource's set of delegates. + */ + associateDelegateToResource(callback?: (err: AWSError, data: WorkMail.Types.AssociateDelegateToResourceResponse) => void): Request; + /** + * Adds a member (user or group) to the group's set. + */ + associateMemberToGroup(params: WorkMail.Types.AssociateMemberToGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.AssociateMemberToGroupResponse) => void): Request; + /** + * Adds a member (user or group) to the group's set. + */ + associateMemberToGroup(callback?: (err: AWSError, data: WorkMail.Types.AssociateMemberToGroupResponse) => void): Request; + /** + * Adds an alias to the set of a given member (user or group) of Amazon WorkMail. + */ + createAlias(params: WorkMail.Types.CreateAliasRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateAliasResponse) => void): Request; + /** + * Adds an alias to the set of a given member (user or group) of Amazon WorkMail. + */ + createAlias(callback?: (err: AWSError, data: WorkMail.Types.CreateAliasResponse) => void): Request; + /** + * Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation. + */ + createGroup(params: WorkMail.Types.CreateGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateGroupResponse) => void): Request; + /** + * Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation. + */ + createGroup(callback?: (err: AWSError, data: WorkMail.Types.CreateGroupResponse) => void): Request; + /** + * Creates a new Amazon WorkMail resource. + */ + createResource(params: WorkMail.Types.CreateResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateResourceResponse) => void): Request; + /** + * Creates a new Amazon WorkMail resource. + */ + createResource(callback?: (err: AWSError, data: WorkMail.Types.CreateResourceResponse) => void): Request; + /** + * Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation. + */ + createUser(params: WorkMail.Types.CreateUserRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateUserResponse) => void): Request; + /** + * Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation. + */ + createUser(callback?: (err: AWSError, data: WorkMail.Types.CreateUserResponse) => void): Request; + /** + * Remove one or more specified aliases from a set of aliases for a given user. + */ + deleteAlias(params: WorkMail.Types.DeleteAliasRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteAliasResponse) => void): Request; + /** + * Remove one or more specified aliases from a set of aliases for a given user. + */ + deleteAlias(callback?: (err: AWSError, data: WorkMail.Types.DeleteAliasResponse) => void): Request; + /** + * Deletes a group from Amazon WorkMail. + */ + deleteGroup(params: WorkMail.Types.DeleteGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteGroupResponse) => void): Request; + /** + * Deletes a group from Amazon WorkMail. + */ + deleteGroup(callback?: (err: AWSError, data: WorkMail.Types.DeleteGroupResponse) => void): Request; + /** + * Deletes permissions granted to a member (user or group). + */ + deleteMailboxPermissions(params: WorkMail.Types.DeleteMailboxPermissionsRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteMailboxPermissionsResponse) => void): Request; + /** + * Deletes permissions granted to a member (user or group). + */ + deleteMailboxPermissions(callback?: (err: AWSError, data: WorkMail.Types.DeleteMailboxPermissionsResponse) => void): Request; + /** + * Deletes the specified resource. + */ + deleteResource(params: WorkMail.Types.DeleteResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteResourceResponse) => void): Request; + /** + * Deletes the specified resource. + */ + deleteResource(callback?: (err: AWSError, data: WorkMail.Types.DeleteResourceResponse) => void): Request; + /** + * Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed. + */ + deleteUser(params: WorkMail.Types.DeleteUserRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteUserResponse) => void): Request; + /** + * Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed. + */ + deleteUser(callback?: (err: AWSError, data: WorkMail.Types.DeleteUserResponse) => void): Request; + /** + * Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable. + */ + deregisterFromWorkMail(params: WorkMail.Types.DeregisterFromWorkMailRequest, callback?: (err: AWSError, data: WorkMail.Types.DeregisterFromWorkMailResponse) => void): Request; + /** + * Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable. + */ + deregisterFromWorkMail(callback?: (err: AWSError, data: WorkMail.Types.DeregisterFromWorkMailResponse) => void): Request; + /** + * Returns the data available for the group. + */ + describeGroup(params: WorkMail.Types.DescribeGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeGroupResponse) => void): Request; + /** + * Returns the data available for the group. + */ + describeGroup(callback?: (err: AWSError, data: WorkMail.Types.DescribeGroupResponse) => void): Request; + /** + * Provides more information regarding a given organization based on its identifier. + */ + describeOrganization(params: WorkMail.Types.DescribeOrganizationRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeOrganizationResponse) => void): Request; + /** + * Provides more information regarding a given organization based on its identifier. + */ + describeOrganization(callback?: (err: AWSError, data: WorkMail.Types.DescribeOrganizationResponse) => void): Request; + /** + * Returns the data available for the resource. + */ + describeResource(params: WorkMail.Types.DescribeResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeResourceResponse) => void): Request; + /** + * Returns the data available for the resource. + */ + describeResource(callback?: (err: AWSError, data: WorkMail.Types.DescribeResourceResponse) => void): Request; + /** + * Provides information regarding the user. + */ + describeUser(params: WorkMail.Types.DescribeUserRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeUserResponse) => void): Request; + /** + * Provides information regarding the user. + */ + describeUser(callback?: (err: AWSError, data: WorkMail.Types.DescribeUserResponse) => void): Request; + /** + * Removes a member from the resource's set of delegates. + */ + disassociateDelegateFromResource(params: WorkMail.Types.DisassociateDelegateFromResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.DisassociateDelegateFromResourceResponse) => void): Request; + /** + * Removes a member from the resource's set of delegates. + */ + disassociateDelegateFromResource(callback?: (err: AWSError, data: WorkMail.Types.DisassociateDelegateFromResourceResponse) => void): Request; + /** + * Removes a member from a group. + */ + disassociateMemberFromGroup(params: WorkMail.Types.DisassociateMemberFromGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.DisassociateMemberFromGroupResponse) => void): Request; + /** + * Removes a member from a group. + */ + disassociateMemberFromGroup(callback?: (err: AWSError, data: WorkMail.Types.DisassociateMemberFromGroupResponse) => void): Request; + /** + * Requests a user's mailbox details for a specified organization and user. + */ + getMailboxDetails(params: WorkMail.Types.GetMailboxDetailsRequest, callback?: (err: AWSError, data: WorkMail.Types.GetMailboxDetailsResponse) => void): Request; + /** + * Requests a user's mailbox details for a specified organization and user. + */ + getMailboxDetails(callback?: (err: AWSError, data: WorkMail.Types.GetMailboxDetailsResponse) => void): Request; + /** + * Creates a paginated call to list the aliases associated with a given entity. + */ + listAliases(params: WorkMail.Types.ListAliasesRequest, callback?: (err: AWSError, data: WorkMail.Types.ListAliasesResponse) => void): Request; + /** + * Creates a paginated call to list the aliases associated with a given entity. + */ + listAliases(callback?: (err: AWSError, data: WorkMail.Types.ListAliasesResponse) => void): Request; + /** + * Returns an overview of the members of a group. Users and groups can be members of a group. + */ + listGroupMembers(params: WorkMail.Types.ListGroupMembersRequest, callback?: (err: AWSError, data: WorkMail.Types.ListGroupMembersResponse) => void): Request; + /** + * Returns an overview of the members of a group. Users and groups can be members of a group. + */ + listGroupMembers(callback?: (err: AWSError, data: WorkMail.Types.ListGroupMembersResponse) => void): Request; + /** + * Returns summaries of the organization's groups. + */ + listGroups(params: WorkMail.Types.ListGroupsRequest, callback?: (err: AWSError, data: WorkMail.Types.ListGroupsResponse) => void): Request; + /** + * Returns summaries of the organization's groups. + */ + listGroups(callback?: (err: AWSError, data: WorkMail.Types.ListGroupsResponse) => void): Request; + /** + * Lists the mailbox permissions associated with a user, group, or resource mailbox. + */ + listMailboxPermissions(params: WorkMail.Types.ListMailboxPermissionsRequest, callback?: (err: AWSError, data: WorkMail.Types.ListMailboxPermissionsResponse) => void): Request; + /** + * Lists the mailbox permissions associated with a user, group, or resource mailbox. + */ + listMailboxPermissions(callback?: (err: AWSError, data: WorkMail.Types.ListMailboxPermissionsResponse) => void): Request; + /** + * Returns summaries of the customer's non-deleted organizations. + */ + listOrganizations(params: WorkMail.Types.ListOrganizationsRequest, callback?: (err: AWSError, data: WorkMail.Types.ListOrganizationsResponse) => void): Request; + /** + * Returns summaries of the customer's non-deleted organizations. + */ + listOrganizations(callback?: (err: AWSError, data: WorkMail.Types.ListOrganizationsResponse) => void): Request; + /** + * Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource. + */ + listResourceDelegates(params: WorkMail.Types.ListResourceDelegatesRequest, callback?: (err: AWSError, data: WorkMail.Types.ListResourceDelegatesResponse) => void): Request; + /** + * Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource. + */ + listResourceDelegates(callback?: (err: AWSError, data: WorkMail.Types.ListResourceDelegatesResponse) => void): Request; + /** + * Returns summaries of the organization's resources. + */ + listResources(params: WorkMail.Types.ListResourcesRequest, callback?: (err: AWSError, data: WorkMail.Types.ListResourcesResponse) => void): Request; + /** + * Returns summaries of the organization's resources. + */ + listResources(callback?: (err: AWSError, data: WorkMail.Types.ListResourcesResponse) => void): Request; + /** + * Returns summaries of the organization's users. + */ + listUsers(params: WorkMail.Types.ListUsersRequest, callback?: (err: AWSError, data: WorkMail.Types.ListUsersResponse) => void): Request; + /** + * Returns summaries of the organization's users. + */ + listUsers(callback?: (err: AWSError, data: WorkMail.Types.ListUsersResponse) => void): Request; + /** + * Sets permissions for a user, group, or resource. This replaces any pre-existing permissions. + */ + putMailboxPermissions(params: WorkMail.Types.PutMailboxPermissionsRequest, callback?: (err: AWSError, data: WorkMail.Types.PutMailboxPermissionsResponse) => void): Request; + /** + * Sets permissions for a user, group, or resource. This replaces any pre-existing permissions. + */ + putMailboxPermissions(callback?: (err: AWSError, data: WorkMail.Types.PutMailboxPermissionsResponse) => void): Request; + /** + * Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail. + */ + registerToWorkMail(params: WorkMail.Types.RegisterToWorkMailRequest, callback?: (err: AWSError, data: WorkMail.Types.RegisterToWorkMailResponse) => void): Request; + /** + * Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail. + */ + registerToWorkMail(callback?: (err: AWSError, data: WorkMail.Types.RegisterToWorkMailResponse) => void): Request; + /** + * Allows the administrator to reset the password for a user. + */ + resetPassword(params: WorkMail.Types.ResetPasswordRequest, callback?: (err: AWSError, data: WorkMail.Types.ResetPasswordResponse) => void): Request; + /** + * Allows the administrator to reset the password for a user. + */ + resetPassword(callback?: (err: AWSError, data: WorkMail.Types.ResetPasswordResponse) => void): Request; + /** + * Updates a user's current mailbox quota for a specified organization and user. + */ + updateMailboxQuota(params: WorkMail.Types.UpdateMailboxQuotaRequest, callback?: (err: AWSError, data: WorkMail.Types.UpdateMailboxQuotaResponse) => void): Request; + /** + * Updates a user's current mailbox quota for a specified organization and user. + */ + updateMailboxQuota(callback?: (err: AWSError, data: WorkMail.Types.UpdateMailboxQuotaResponse) => void): Request; + /** + * Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary. + */ + updatePrimaryEmailAddress(params: WorkMail.Types.UpdatePrimaryEmailAddressRequest, callback?: (err: AWSError, data: WorkMail.Types.UpdatePrimaryEmailAddressResponse) => void): Request; + /** + * Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary. + */ + updatePrimaryEmailAddress(callback?: (err: AWSError, data: WorkMail.Types.UpdatePrimaryEmailAddressResponse) => void): Request; + /** + * Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call. + */ + updateResource(params: WorkMail.Types.UpdateResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.UpdateResourceResponse) => void): Request; + /** + * Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call. + */ + updateResource(callback?: (err: AWSError, data: WorkMail.Types.UpdateResourceResponse) => void): Request; +} +declare namespace WorkMail { + export type Aliases = EmailAddress[]; + export interface AssociateDelegateToResourceRequest { + /** + * The organization under which the resource exists. + */ + OrganizationId: OrganizationId; + /** + * The resource for which members (users or groups) are associated. + */ + ResourceId: ResourceId; + /** + * The member (user or group) to associate to the resource. + */ + EntityId: WorkMailIdentifier; + } + export interface AssociateDelegateToResourceResponse { + } + export interface AssociateMemberToGroupRequest { + /** + * The organization under which the group exists. + */ + OrganizationId: OrganizationId; + /** + * The group to which the member (user or group) is associated. + */ + GroupId: WorkMailIdentifier; + /** + * The member (user or group) to associate to the group. + */ + MemberId: WorkMailIdentifier; + } + export interface AssociateMemberToGroupResponse { + } + export interface BookingOptions { + /** + * The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource. + */ + AutoAcceptRequests?: Boolean; + /** + * The resource's ability to automatically decline any recurring requests. + */ + AutoDeclineRecurringRequests?: Boolean; + /** + * The resource's ability to automatically decline any conflicting requests. + */ + AutoDeclineConflictingRequests?: Boolean; + } + export type Boolean = boolean; + export interface CreateAliasRequest { + /** + * The organization under which the member (user or group) exists. + */ + OrganizationId: OrganizationId; + /** + * The member (user or group) to which this alias is added. + */ + EntityId: WorkMailIdentifier; + /** + * The alias to add to the member set. + */ + Alias: EmailAddress; + } + export interface CreateAliasResponse { + } + export interface CreateGroupRequest { + /** + * The organization under which the group is to be created. + */ + OrganizationId: OrganizationId; + /** + * The name of the group. + */ + Name: GroupName; + } + export interface CreateGroupResponse { + /** + * The identifier of the group. + */ + GroupId?: WorkMailIdentifier; + } + export interface CreateResourceRequest { + /** + * The identifier associated with the organization for which the resource is created. + */ + OrganizationId: OrganizationId; + /** + * The name of the new resource. + */ + Name: ResourceName; + /** + * The type of the new resource. The available types are equipment and room. + */ + Type: ResourceType; + } + export interface CreateResourceResponse { + /** + * The identifier of the new resource. + */ + ResourceId?: ResourceId; + } + export interface CreateUserRequest { + /** + * The identifier of the organization for which the user is created. + */ + OrganizationId: OrganizationId; + /** + * The name for the new user. Simple AD or AD Connector user names have a maximum length of 20. All others have a maximum length of 64. + */ + Name: UserName; + /** + * The display name for the new user. + */ + DisplayName: String; + /** + * The password for the new user. + */ + Password: Password; + } + export interface CreateUserResponse { + /** + * The identifier for the new user. + */ + UserId?: WorkMailIdentifier; + } + export interface Delegate { + /** + * The identifier for the user or group associated as the resource's delegate. + */ + Id: String; + /** + * The type of the delegate: user or group. + */ + Type: MemberType; + } + export interface DeleteAliasRequest { + /** + * The identifier for the organization under which the user exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the member (user or group) from which to have the aliases removed. + */ + EntityId: WorkMailIdentifier; + /** + * The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set). + */ + Alias: EmailAddress; + } + export interface DeleteAliasResponse { + } + export interface DeleteGroupRequest { + /** + * The organization that contains the group. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the group to be deleted. + */ + GroupId: WorkMailIdentifier; + } + export interface DeleteGroupResponse { + } + export interface DeleteMailboxPermissionsRequest { + /** + * The identifier of the organization under which the member (user or group) exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the member (user or group)that owns the mailbox. + */ + EntityId: WorkMailIdentifier; + /** + * The identifier of the member (user or group) for which to delete granted permissions. + */ + GranteeId: WorkMailIdentifier; + } + export interface DeleteMailboxPermissionsResponse { + } + export interface DeleteResourceRequest { + /** + * The identifier associated with the organization from which the resource is deleted. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the resource to be deleted. + */ + ResourceId: ResourceId; + } + export interface DeleteResourceResponse { + } + export interface DeleteUserRequest { + /** + * The organization that contains the user to be deleted. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the user to be deleted. + */ + UserId: WorkMailIdentifier; + } + export interface DeleteUserResponse { + } + export interface DeregisterFromWorkMailRequest { + /** + * The identifier for the organization under which the Amazon WorkMail entity exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the member (user or group) to be updated. + */ + EntityId: WorkMailIdentifier; + } + export interface DeregisterFromWorkMailResponse { + } + export interface DescribeGroupRequest { + /** + * The identifier for the organization under which the group exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the group to be described. + */ + GroupId: WorkMailIdentifier; + } + export interface DescribeGroupResponse { + /** + * The identifier of the described group. + */ + GroupId?: WorkMailIdentifier; + /** + * The name of the described group. + */ + Name?: GroupName; + /** + * The email of the described group. + */ + Email?: EmailAddress; + /** + * The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail). + */ + State?: EntityState; + /** + * The date and time when a user was registered to WorkMail, in UNIX epoch time format. + */ + EnabledDate?: Timestamp; + /** + * The date and time when a user was deregistered from WorkMail, in UNIX epoch time format. + */ + DisabledDate?: Timestamp; + } + export interface DescribeOrganizationRequest { + /** + * The identifier for the organization to be described. + */ + OrganizationId: OrganizationId; + } + export interface DescribeOrganizationResponse { + /** + * The identifier of an organization. + */ + OrganizationId?: OrganizationId; + /** + * The alias for an organization. + */ + Alias?: OrganizationName; + /** + * The state of an organization. + */ + State?: String; + /** + * The identifier for the directory associated with an Amazon WorkMail organization. + */ + DirectoryId?: String; + /** + * The type of directory associated with the WorkMail organization. + */ + DirectoryType?: String; + /** + * The default mail domain associated with the organization. + */ + DefaultMailDomain?: String; + /** + * The date at which the organization became usable in the WorkMail context, in UNIX epoch time format. + */ + CompletedDate?: Timestamp; + /** + * (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization. + */ + ErrorMessage?: String; + } + export interface DescribeResourceRequest { + /** + * The identifier associated with the organization for which the resource is described. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the resource to be described. + */ + ResourceId: ResourceId; + } + export interface DescribeResourceResponse { + /** + * The identifier of the described resource. + */ + ResourceId?: ResourceId; + /** + * The email of the described resource. + */ + Email?: EmailAddress; + /** + * The name of the described resource. + */ + Name?: ResourceName; + /** + * The type of the described resource. + */ + Type?: ResourceType; + /** + * The booking options for the described resource. + */ + BookingOptions?: BookingOptions; + /** + * The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail). + */ + State?: EntityState; + /** + * The date and time when a resource was enabled for WorkMail, in UNIX epoch time format. + */ + EnabledDate?: Timestamp; + /** + * The date and time when a resource was disabled from WorkMail, in UNIX epoch time format. + */ + DisabledDate?: Timestamp; + } + export interface DescribeUserRequest { + /** + * The identifier for the organization under which the user exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the user to be described. + */ + UserId: WorkMailIdentifier; + } + export interface DescribeUserResponse { + /** + * The identifier for the described user. + */ + UserId?: WorkMailIdentifier; + /** + * The name for the user. + */ + Name?: UserName; + /** + * The email of the user. + */ + Email?: EmailAddress; + /** + * The display name of the user. + */ + DisplayName?: String; + /** + * The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail). + */ + State?: EntityState; + /** + * In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER. + */ + UserRole?: UserRole; + /** + * The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format. + */ + EnabledDate?: Timestamp; + /** + * The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format. + */ + DisabledDate?: Timestamp; + } + export interface DisassociateDelegateFromResourceRequest { + /** + * The identifier for the organization under which the resource exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the resource from which delegates' set members are removed. + */ + ResourceId: ResourceId; + /** + * The identifier for the member (user, group) to be removed from the resource's delegates. + */ + EntityId: WorkMailIdentifier; + } + export interface DisassociateDelegateFromResourceResponse { + } + export interface DisassociateMemberFromGroupRequest { + /** + * The identifier for the organization under which the group exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the group from which members are removed. + */ + GroupId: WorkMailIdentifier; + /** + * The identifier for the member to be removed to the group. + */ + MemberId: WorkMailIdentifier; + } + export interface DisassociateMemberFromGroupResponse { + } + export type EmailAddress = string; + export type EntityState = "ENABLED"|"DISABLED"|"DELETED"|string; + export interface GetMailboxDetailsRequest { + /** + * The identifier for the organization that contains the user whose mailbox details are being requested. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the user whose mailbox details are being requested. + */ + UserId: WorkMailIdentifier; + } + export interface GetMailboxDetailsResponse { + /** + * The maximum allowed mailbox size, in MB, for the specified user. + */ + MailboxQuota?: MailboxQuota; + /** + * The current mailbox size, in MB, for the specified user. + */ + MailboxSize?: MailboxSize; + } + export interface Group { + /** + * The identifier of the group. + */ + Id?: WorkMailIdentifier; + /** + * The email of the group. + */ + Email?: EmailAddress; + /** + * The name of the group. + */ + Name?: GroupName; + /** + * The state of the group, which can be ENABLED, DISABLED, or DELETED. + */ + State?: EntityState; + /** + * The date indicating when the group was enabled for Amazon WorkMail use. + */ + EnabledDate?: Timestamp; + /** + * The date indicating when the group was disabled from Amazon WorkMail use. + */ + DisabledDate?: Timestamp; + } + export type GroupName = string; + export type Groups = Group[]; + export interface ListAliasesRequest { + /** + * The identifier for the organization under which the entity exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the entity for which to list the aliases. + */ + EntityId: WorkMailIdentifier; + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface ListAliasesResponse { + /** + * The entity's paginated aliases. + */ + Aliases?: Aliases; + /** + * The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface ListGroupMembersRequest { + /** + * The identifier for the organization under which the group exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the group to which the members (users or groups) are associated. + */ + GroupId: WorkMailIdentifier; + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface ListGroupMembersResponse { + /** + * The members associated to the group. + */ + Members?: Members; + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + } + export interface ListGroupsRequest { + /** + * The identifier for the organization under which the groups exist. + */ + OrganizationId: OrganizationId; + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface ListGroupsResponse { + /** + * The overview of groups for an organization. + */ + Groups?: Groups; + /** + * The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface ListMailboxPermissionsRequest { + /** + * The identifier of the organization under which the user, group, or resource exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the user, group, or resource for which to list mailbox permissions. + */ + EntityId: WorkMailIdentifier; + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface ListMailboxPermissionsResponse { + /** + * One page of the user, group, or resource mailbox permissions. + */ + Permissions?: Permissions; + /** + * The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface ListOrganizationsRequest { + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface ListOrganizationsResponse { + /** + * The overview of owned organizations presented as a list of organization summaries. + */ + OrganizationSummaries?: OrganizationSummaries; + /** + * The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. + */ + NextToken?: NextToken; + } + export interface ListResourceDelegatesRequest { + /** + * The identifier for the organization that contains the resource for which delegates are listed. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the resource whose delegates are listed. + */ + ResourceId: WorkMailIdentifier; + /** + * The token used to paginate through the delegates associated with a resource. + */ + NextToken?: NextToken; + /** + * The number of maximum results in a page. + */ + MaxResults?: MaxResults; + } + export interface ListResourceDelegatesResponse { + /** + * One page of the resource's delegates. + */ + Delegates?: ResourceDelegates; + /** + * The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty. + */ + NextToken?: NextToken; + } + export interface ListResourcesRequest { + /** + * The identifier for the organization under which the resources exist. + */ + OrganizationId: OrganizationId; + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface ListResourcesResponse { + /** + * One page of the organization's resource representation. + */ + Resources?: Resources; + /** + * The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty. + */ + NextToken?: NextToken; + } + export interface ListUsersRequest { + /** + * The identifier for the organization under which the users exist. + */ + OrganizationId: OrganizationId; + /** + * The token to use to retrieve the next page of results. The first call does not contain any tokens. + */ + NextToken?: NextToken; + /** + * The maximum number of results to return in a single call. + */ + MaxResults?: MaxResults; + } + export interface ListUsersResponse { + /** + * The overview of users for an organization. + */ + Users?: Users; + /** + * The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. + */ + NextToken?: NextToken; + } + export type MailboxQuota = number; + export type MailboxSize = number; + export type MaxResults = number; + export interface Member { + /** + * The identifier of the member. + */ + Id?: String; + /** + * The name of the member. + */ + Name?: String; + /** + * A member can be a user or group. + */ + Type?: MemberType; + /** + * The state of the member, which can be ENABLED, DISABLED, or DELETED. + */ + State?: EntityState; + /** + * The date indicating when the member was enabled for Amazon WorkMail use. + */ + EnabledDate?: Timestamp; + /** + * The date indicating when the member was disabled from Amazon WorkMail use. + */ + DisabledDate?: Timestamp; + } + export type MemberType = "GROUP"|"USER"|string; + export type Members = Member[]; + export type NextToken = string; + export type OrganizationId = string; + export type OrganizationName = string; + export type OrganizationSummaries = OrganizationSummary[]; + export interface OrganizationSummary { + /** + * The identifier associated with the organization. + */ + OrganizationId?: OrganizationId; + /** + * The alias associated with the organization. + */ + Alias?: OrganizationName; + /** + * The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior. + */ + ErrorMessage?: String; + /** + * The state associated with the organization. + */ + State?: String; + } + export type Password = string; + export interface Permission { + /** + * The identifier of the user, group, or resource to which the permissions are granted. + */ + GranteeId: WorkMailIdentifier; + /** + * The type of user, group, or resource referred to in GranteeId. + */ + GranteeType: MemberType; + /** + * The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox. + */ + PermissionValues: PermissionValues; + } + export type PermissionType = "FULL_ACCESS"|"SEND_AS"|"SEND_ON_BEHALF"|string; + export type PermissionValues = PermissionType[]; + export type Permissions = Permission[]; + export interface PutMailboxPermissionsRequest { + /** + * The identifier of the organization under which the user, group, or resource exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the user, group, or resource for which to update mailbox permissions. + */ + EntityId: WorkMailIdentifier; + /** + * The identifier of the user, group, or resource to which to grant the permissions. + */ + GranteeId: WorkMailIdentifier; + /** + * The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox. + */ + PermissionValues: PermissionValues; + } + export interface PutMailboxPermissionsResponse { + } + export interface RegisterToWorkMailRequest { + /** + * The identifier for the organization under which the user, group, or resource exists. + */ + OrganizationId: OrganizationId; + /** + * The identifier for the user, group, or resource to be updated. + */ + EntityId: WorkMailIdentifier; + /** + * The email for the user, group, or resource to be updated. + */ + Email: EmailAddress; + } + export interface RegisterToWorkMailResponse { + } + export interface ResetPasswordRequest { + /** + * The identifier of the organization that contains the user for which the password is reset. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the user for whom the password is reset. + */ + UserId: WorkMailIdentifier; + /** + * The new password for the user. + */ + Password: Password; + } + export interface ResetPasswordResponse { + } + export interface Resource { + /** + * The identifier of the resource. + */ + Id?: WorkMailIdentifier; + /** + * The email of the resource. + */ + Email?: EmailAddress; + /** + * The name of the resource. + */ + Name?: ResourceName; + /** + * The type of the resource: equipment or room. + */ + Type?: ResourceType; + /** + * The state of the resource, which can be ENABLED, DISABLED, or DELETED. + */ + State?: EntityState; + /** + * The date indicating when the resource was enabled for Amazon WorkMail use. + */ + EnabledDate?: Timestamp; + /** + * The date indicating when the resource was disabled from Amazon WorkMail use. + */ + DisabledDate?: Timestamp; + } + export type ResourceDelegates = Delegate[]; + export type ResourceId = string; + export type ResourceName = string; + export type ResourceType = "ROOM"|"EQUIPMENT"|string; + export type Resources = Resource[]; + export type String = string; + export type Timestamp = Date; + export interface UpdateMailboxQuotaRequest { + /** + * The identifier for the organization that contains the user for whom to update the mailbox quota. + */ + OrganizationId: OrganizationId; + /** + * The identifer for the user for whom to update the mailbox quota. + */ + UserId: WorkMailIdentifier; + /** + * The updated mailbox quota, in MB, for the specified user. + */ + MailboxQuota: MailboxQuota; + } + export interface UpdateMailboxQuotaResponse { + } + export interface UpdatePrimaryEmailAddressRequest { + /** + * The organization that contains the user, group, or resource to update. + */ + OrganizationId: OrganizationId; + /** + * The user, group, or resource to update. + */ + EntityId: WorkMailIdentifier; + /** + * The value of the email to be updated as primary. + */ + Email: EmailAddress; + } + export interface UpdatePrimaryEmailAddressResponse { + } + export interface UpdateResourceRequest { + /** + * The identifier associated with the organization for which the resource is updated. + */ + OrganizationId: OrganizationId; + /** + * The identifier of the resource to be updated. + */ + ResourceId: ResourceId; + /** + * The name of the resource to be updated. + */ + Name?: ResourceName; + /** + * The resource's booking options to be updated. + */ + BookingOptions?: BookingOptions; + } + export interface UpdateResourceResponse { + } + export interface User { + /** + * The identifier of the user. + */ + Id?: WorkMailIdentifier; + /** + * The email of the user. + */ + Email?: EmailAddress; + /** + * The name of the user. + */ + Name?: UserName; + /** + * The display name of the user. + */ + DisplayName?: String; + /** + * The state of the user, which can be ENABLED, DISABLED, or DELETED. + */ + State?: EntityState; + /** + * The role of the user. + */ + UserRole?: UserRole; + /** + * The date indicating when the user was enabled for Amazon WorkMail use. + */ + EnabledDate?: Timestamp; + /** + * The date indicating when the user was disabled from Amazon WorkMail use. + */ + DisabledDate?: Timestamp; + } + export type UserName = string; + export type UserRole = "USER"|"RESOURCE"|"SYSTEM_USER"|string; + export type Users = User[]; + export type WorkMailIdentifier = string; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2017-10-01"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the WorkMail client. + */ + export import Types = WorkMail; +} +export = WorkMail; diff --git a/node_modules/aws-sdk/clients/workmail.js b/node_modules/aws-sdk/clients/workmail.js new file mode 100644 index 0000000..28a6861 --- /dev/null +++ b/node_modules/aws-sdk/clients/workmail.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['workmail'] = {}; +AWS.WorkMail = Service.defineService('workmail', ['2017-10-01']); +Object.defineProperty(apiLoader.services['workmail'], '2017-10-01', { + get: function get() { + var model = require('../apis/workmail-2017-10-01.min.json'); + model.paginators = require('../apis/workmail-2017-10-01.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.WorkMail; diff --git a/node_modules/aws-sdk/clients/workspaces.d.ts b/node_modules/aws-sdk/clients/workspaces.d.ts new file mode 100644 index 0000000..06cf533 --- /dev/null +++ b/node_modules/aws-sdk/clients/workspaces.d.ts @@ -0,0 +1,1333 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class WorkSpaces extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: WorkSpaces.Types.ClientConfiguration) + config: Config & WorkSpaces.Types.ClientConfiguration; + /** + * Associates the specified IP access control group with the specified directory. + */ + associateIpGroups(params: WorkSpaces.Types.AssociateIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.AssociateIpGroupsResult) => void): Request; + /** + * Associates the specified IP access control group with the specified directory. + */ + associateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.AssociateIpGroupsResult) => void): Request; + /** + * Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules. + */ + authorizeIpRules(params: WorkSpaces.Types.AuthorizeIpRulesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.AuthorizeIpRulesResult) => void): Request; + /** + * Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules. + */ + authorizeIpRules(callback?: (err: AWSError, data: WorkSpaces.Types.AuthorizeIpRulesResult) => void): Request; + /** + * Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory. + */ + createIpGroup(params: WorkSpaces.Types.CreateIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateIpGroupResult) => void): Request; + /** + * Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory. + */ + createIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.CreateIpGroupResult) => void): Request; + /** + * Creates the specified tags for the specified WorkSpaces resource. + */ + createTags(params: WorkSpaces.Types.CreateTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request; + /** + * Creates the specified tags for the specified WorkSpaces resource. + */ + createTags(callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request; + /** + * Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. + */ + createWorkspaces(params: WorkSpaces.Types.CreateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request; + /** + * Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. + */ + createWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request; + /** + * Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory. + */ + deleteIpGroup(params: WorkSpaces.Types.DeleteIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteIpGroupResult) => void): Request; + /** + * Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory. + */ + deleteIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteIpGroupResult) => void): Request; + /** + * Deletes the specified tags from the specified WorkSpaces resource. + */ + deleteTags(params: WorkSpaces.Types.DeleteTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request; + /** + * Deletes the specified tags from the specified WorkSpaces resource. + */ + deleteTags(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request; + /** + * Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image. + */ + deleteWorkspaceImage(params: WorkSpaces.Types.DeleteWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteWorkspaceImageResult) => void): Request; + /** + * Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image. + */ + deleteWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteWorkspaceImageResult) => void): Request; + /** + * Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account. + */ + describeAccount(params: WorkSpaces.Types.DescribeAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request; + /** + * Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account. + */ + describeAccount(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request; + /** + * Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account. + */ + describeAccountModifications(params: WorkSpaces.Types.DescribeAccountModificationsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request; + /** + * Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account. + */ + describeAccountModifications(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request; + /** + * Retrieves a list that describes one or more specified Amazon WorkSpaces clients. + */ + describeClientProperties(params: WorkSpaces.Types.DescribeClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request; + /** + * Retrieves a list that describes one or more specified Amazon WorkSpaces clients. + */ + describeClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request; + /** + * Describes one or more of your IP access control groups. + */ + describeIpGroups(params: WorkSpaces.Types.DescribeIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request; + /** + * Describes one or more of your IP access control groups. + */ + describeIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request; + /** + * Describes the specified tags for the specified WorkSpaces resource. + */ + describeTags(params: WorkSpaces.Types.DescribeTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request; + /** + * Describes the specified tags for the specified WorkSpaces resource. + */ + describeTags(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request; + /** + * Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both. + */ + describeWorkspaceBundles(params: WorkSpaces.Types.DescribeWorkspaceBundlesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request; + /** + * Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both. + */ + describeWorkspaceBundles(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request; + /** + * Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces. + */ + describeWorkspaceDirectories(params: WorkSpaces.Types.DescribeWorkspaceDirectoriesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request; + /** + * Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces. + */ + describeWorkspaceDirectories(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request; + /** + * Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. + */ + describeWorkspaceImages(params: WorkSpaces.Types.DescribeWorkspaceImagesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request; + /** + * Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. + */ + describeWorkspaceImages(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request; + /** + * Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time. + */ + describeWorkspaces(params: WorkSpaces.Types.DescribeWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request; + /** + * Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time. + */ + describeWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request; + /** + * Describes the connection status of the specified WorkSpaces. + */ + describeWorkspacesConnectionStatus(params: WorkSpaces.Types.DescribeWorkspacesConnectionStatusRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request; + /** + * Describes the connection status of the specified WorkSpaces. + */ + describeWorkspacesConnectionStatus(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request; + /** + * Disassociates the specified IP access control group from the specified directory. + */ + disassociateIpGroups(params: WorkSpaces.Types.DisassociateIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request; + /** + * Disassociates the specified IP access control group from the specified directory. + */ + disassociateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request; + /** + * Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image. + */ + importWorkspaceImage(params: WorkSpaces.Types.ImportWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request; + /** + * Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image. + */ + importWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request; + /** + * Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL). The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. + */ + listAvailableManagementCidrRanges(params: WorkSpaces.Types.ListAvailableManagementCidrRangesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request; + /** + * Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL). The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. + */ + listAvailableManagementCidrRanges(callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request; + /** + * Modifies the configuration of bring your own license (BYOL) for the specified account. + */ + modifyAccount(params: WorkSpaces.Types.ModifyAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request; + /** + * Modifies the configuration of bring your own license (BYOL) for the specified account. + */ + modifyAccount(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request; + /** + * Modifies the properties of the specified Amazon WorkSpaces clients. + */ + modifyClientProperties(params: WorkSpaces.Types.ModifyClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request; + /** + * Modifies the properties of the specified Amazon WorkSpaces clients. + */ + modifyClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request; + /** + * Modifies the specified WorkSpace properties. + */ + modifyWorkspaceProperties(params: WorkSpaces.Types.ModifyWorkspacePropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request; + /** + * Modifies the specified WorkSpace properties. + */ + modifyWorkspaceProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request; + /** + * Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE state. + */ + modifyWorkspaceState(params: WorkSpaces.Types.ModifyWorkspaceStateRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request; + /** + * Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE state. + */ + modifyWorkspaceState(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request; + /** + * Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the WorkSpaces have rebooted. + */ + rebootWorkspaces(params: WorkSpaces.Types.RebootWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request; + /** + * Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the WorkSpaces have rebooted. + */ + rebootWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request; + /** + * Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. + */ + rebuildWorkspaces(params: WorkSpaces.Types.RebuildWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request; + /** + * Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. + */ + rebuildWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request; + /** + * Removes one or more rules from the specified IP access control group. + */ + revokeIpRules(params: WorkSpaces.Types.RevokeIpRulesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request; + /** + * Removes one or more rules from the specified IP access control group. + */ + revokeIpRules(callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request; + /** + * Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED. + */ + startWorkspaces(params: WorkSpaces.Types.StartWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request; + /** + * Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED. + */ + startWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request; + /** + * Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. + */ + stopWorkspaces(params: WorkSpaces.Types.StopWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request; + /** + * Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. + */ + stopWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request; + /** + * Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. + */ + terminateWorkspaces(params: WorkSpaces.Types.TerminateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request; + /** + * Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. + */ + terminateWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request; + /** + * Replaces the current rules of the specified IP access control group with the specified rules. + */ + updateRulesOfIpGroup(params: WorkSpaces.Types.UpdateRulesOfIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request; + /** + * Replaces the current rules of the specified IP access control group with the specified rules. + */ + updateRulesOfIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request; +} +declare namespace WorkSpaces { + export type ARN = string; + export interface AccountModification { + /** + * The state of the modification to the configuration of BYOL. + */ + ModificationState?: DedicatedTenancyModificationStateEnum; + /** + * The status of BYOL (whether BYOL is being enabled or disabled). + */ + DedicatedTenancySupport?: DedicatedTenancySupportResultEnum; + /** + * The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account. + */ + DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange; + /** + * The timestamp when the modification of the BYOL configuration was started. + */ + StartTime?: Timestamp; + /** + * The error code that is returned if the configuration of BYOL cannot be modified. + */ + ErrorCode?: WorkspaceErrorCode; + /** + * The text of the error message that is returned if the configuration of BYOL cannot be modified. + */ + ErrorMessage?: Description; + } + export type AccountModificationList = AccountModification[]; + export type AdditionalInfo = string; + export type Alias = string; + export interface AssociateIpGroupsRequest { + /** + * The identifier of the directory. + */ + DirectoryId: DirectoryId; + /** + * The identifiers of one or more IP access control groups. + */ + GroupIds: IpGroupIdList; + } + export interface AssociateIpGroupsResult { + } + export interface AuthorizeIpRulesRequest { + /** + * The identifier of the group. + */ + GroupId: IpGroupId; + /** + * The rules to add to the group. + */ + UserRules: IpRuleList; + } + export interface AuthorizeIpRulesResult { + } + export type BooleanObject = boolean; + export type BundleId = string; + export type BundleIdList = BundleId[]; + export type BundleList = WorkspaceBundle[]; + export type BundleOwner = string; + export interface ClientProperties { + /** + * Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials. + */ + ReconnectEnabled?: ReconnectEnum; + } + export type ClientPropertiesList = ClientPropertiesResult[]; + export interface ClientPropertiesResult { + /** + * The resource identifier, in the form of a directory ID. + */ + ResourceId?: NonEmptyString; + /** + * Information about the Amazon WorkSpaces client. + */ + ClientProperties?: ClientProperties; + } + export type Compute = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|string; + export interface ComputeType { + /** + * The compute type. + */ + Name?: Compute; + } + export type ComputerName = string; + export type ConnectionState = "CONNECTED"|"DISCONNECTED"|"UNKNOWN"|string; + export interface CreateIpGroupRequest { + /** + * The name of the group. + */ + GroupName: IpGroupName; + /** + * The description of the group. + */ + GroupDesc?: IpGroupDesc; + /** + * The rules to add to the group. + */ + UserRules?: IpRuleList; + /** + * The tags. Each WorkSpaces resource can have a maximum of 50 tags. + */ + Tags?: TagList; + } + export interface CreateIpGroupResult { + /** + * The identifier of the group. + */ + GroupId?: IpGroupId; + } + export interface CreateTagsRequest { + /** + * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups. + */ + ResourceId: NonEmptyString; + /** + * The tags. Each WorkSpaces resource can have a maximum of 50 tags. + */ + Tags: TagList; + } + export interface CreateTagsResult { + } + export interface CreateWorkspacesRequest { + /** + * The WorkSpaces to create. You can specify up to 25 WorkSpaces. + */ + Workspaces: WorkspaceRequestList; + } + export interface CreateWorkspacesResult { + /** + * Information about the WorkSpaces that could not be created. + */ + FailedRequests?: FailedCreateWorkspaceRequests; + /** + * Information about the WorkSpaces that were created. Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete. + */ + PendingRequests?: WorkspaceList; + } + export type DedicatedTenancyCidrRangeList = DedicatedTenancyManagementCidrRange[]; + export type DedicatedTenancyManagementCidrRange = string; + export type DedicatedTenancyModificationStateEnum = "PENDING"|"COMPLETED"|"FAILED"|string; + export type DedicatedTenancySupportEnum = "ENABLED"|string; + export type DedicatedTenancySupportResultEnum = "ENABLED"|"DISABLED"|string; + export type DefaultOu = string; + export interface DefaultWorkspaceCreationProperties { + /** + * Specifies whether the directory is enabled for Amazon WorkDocs. + */ + EnableWorkDocs?: BooleanObject; + /** + * The public IP address to attach to all WorkSpaces that are created or rebuilt. + */ + EnableInternetAccess?: BooleanObject; + /** + * The organizational unit (OU) in the directory for the WorkSpace machine accounts. + */ + DefaultOu?: DefaultOu; + /** + * The identifier of any security groups to apply to WorkSpaces when they are created. + */ + CustomSecurityGroupId?: SecurityGroupId; + /** + * Specifies whether the WorkSpace user is an administrator on the WorkSpace. + */ + UserEnabledAsLocalAdministrator?: BooleanObject; + } + export interface DeleteIpGroupRequest { + /** + * The identifier of the IP access control group. + */ + GroupId: IpGroupId; + } + export interface DeleteIpGroupResult { + } + export interface DeleteTagsRequest { + /** + * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups. + */ + ResourceId: NonEmptyString; + /** + * The tag keys. + */ + TagKeys: TagKeyList; + } + export interface DeleteTagsResult { + } + export interface DeleteWorkspaceImageRequest { + /** + * The identifier of the image. + */ + ImageId: WorkspaceImageId; + } + export interface DeleteWorkspaceImageResult { + } + export interface DescribeAccountModificationsRequest { + /** + * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. + */ + NextToken?: PaginationToken; + } + export interface DescribeAccountModificationsResult { + /** + * The list of modifications to the configuration of BYOL. + */ + AccountModifications?: AccountModificationList; + /** + * The token to use to retrieve the next set of results, or null if no more results are available. + */ + NextToken?: PaginationToken; + } + export interface DescribeAccountRequest { + } + export interface DescribeAccountResult { + /** + * The status of BYOL (whether BYOL is enabled or disabled). + */ + DedicatedTenancySupport?: DedicatedTenancySupportResultEnum; + /** + * The IP address range, specified as an IPv4 CIDR block, used for the management network interface. The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. + */ + DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange; + } + export interface DescribeClientPropertiesRequest { + /** + * The resource identifier, in the form of directory IDs. + */ + ResourceIds: ResourceIdList; + } + export interface DescribeClientPropertiesResult { + /** + * Information about the specified Amazon WorkSpaces clients. + */ + ClientPropertiesList?: ClientPropertiesList; + } + export interface DescribeIpGroupsRequest { + /** + * The identifiers of one or more IP access control groups. + */ + GroupIds?: IpGroupIdList; + /** + * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. + */ + NextToken?: PaginationToken; + /** + * The maximum number of items to return. + */ + MaxResults?: Limit; + } + export interface DescribeIpGroupsResult { + /** + * Information about the IP access control groups. + */ + Result?: WorkspacesIpGroupsList; + /** + * The token to use to retrieve the next set of results, or null if no more results are available. + */ + NextToken?: PaginationToken; + } + export interface DescribeTagsRequest { + /** + * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups. + */ + ResourceId: NonEmptyString; + } + export interface DescribeTagsResult { + /** + * The tags. + */ + TagList?: TagList; + } + export interface DescribeWorkspaceBundlesRequest { + /** + * The identifiers of the bundles. You cannot combine this parameter with any other filter. + */ + BundleIds?: BundleIdList; + /** + * The owner of the bundles. You cannot combine this parameter with any other filter. Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account. + */ + Owner?: BundleOwner; + /** + * The token for the next set of results. (You received this token from a previous call.) + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspaceBundlesResult { + /** + * Information about the bundles. + */ + Bundles?: BundleList; + /** + * The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame. + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspaceDirectoriesRequest { + /** + * The identifiers of the directories. If the value is null, all directories are retrieved. + */ + DirectoryIds?: DirectoryIdList; + /** + * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspaceDirectoriesResult { + /** + * Information about the directories. + */ + Directories?: DirectoryList; + /** + * The token to use to retrieve the next set of results, or null if no more results are available. + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspaceImagesRequest { + /** + * The identifier of the image. + */ + ImageIds?: WorkspaceImageIdList; + /** + * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. + */ + NextToken?: PaginationToken; + /** + * The maximum number of items to return. + */ + MaxResults?: Limit; + } + export interface DescribeWorkspaceImagesResult { + /** + * Information about the images. + */ + Images?: WorkspaceImageList; + /** + * The token to use to retrieve the next set of results, or null if no more results are available. + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspacesConnectionStatusRequest { + /** + * The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces. + */ + WorkspaceIds?: WorkspaceIdList; + /** + * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspacesConnectionStatusResult { + /** + * Information about the connection status of the WorkSpace. + */ + WorkspacesConnectionStatus?: WorkspaceConnectionStatusList; + /** + * The token to use to retrieve the next set of results, or null if no more results are available. + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspacesRequest { + /** + * The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter. Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned. + */ + WorkspaceIds?: WorkspaceIdList; + /** + * The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter. + */ + DirectoryId?: DirectoryId; + /** + * The name of the directory user. You must specify this parameter with DirectoryId. + */ + UserName?: UserName; + /** + * The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter. + */ + BundleId?: BundleId; + /** + * The maximum number of items to return. + */ + Limit?: Limit; + /** + * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. + */ + NextToken?: PaginationToken; + } + export interface DescribeWorkspacesResult { + /** + * Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete. + */ + Workspaces?: WorkspaceList; + /** + * The token to use to retrieve the next set of results, or null if no more results are available. + */ + NextToken?: PaginationToken; + } + export type Description = string; + export type DirectoryId = string; + export type DirectoryIdList = DirectoryId[]; + export type DirectoryList = WorkspaceDirectory[]; + export type DirectoryName = string; + export interface DisassociateIpGroupsRequest { + /** + * The identifier of the directory. + */ + DirectoryId: DirectoryId; + /** + * The identifiers of one or more IP access control groups. + */ + GroupIds: IpGroupIdList; + } + export interface DisassociateIpGroupsResult { + } + export type DnsIpAddresses = IpAddress[]; + export type Ec2ImageId = string; + export type ErrorType = string; + export interface FailedCreateWorkspaceRequest { + /** + * Information about the WorkSpace. + */ + WorkspaceRequest?: WorkspaceRequest; + /** + * The error code that is returned if the WorkSpace cannot be created. + */ + ErrorCode?: ErrorType; + /** + * The text of the error message that is returned if the WorkSpace cannot be created. + */ + ErrorMessage?: Description; + } + export type FailedCreateWorkspaceRequests = FailedCreateWorkspaceRequest[]; + export type FailedRebootWorkspaceRequests = FailedWorkspaceChangeRequest[]; + export type FailedRebuildWorkspaceRequests = FailedWorkspaceChangeRequest[]; + export type FailedStartWorkspaceRequests = FailedWorkspaceChangeRequest[]; + export type FailedStopWorkspaceRequests = FailedWorkspaceChangeRequest[]; + export type FailedTerminateWorkspaceRequests = FailedWorkspaceChangeRequest[]; + export interface FailedWorkspaceChangeRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId?: WorkspaceId; + /** + * The error code that is returned if the WorkSpace cannot be rebooted. + */ + ErrorCode?: ErrorType; + /** + * The text of the error message that is returned if the WorkSpace cannot be rebooted. + */ + ErrorMessage?: Description; + } + export interface ImportWorkspaceImageRequest { + /** + * The identifier of the EC2 image. + */ + Ec2ImageId: Ec2ImageId; + /** + * The ingestion process to be used when importing the image. + */ + IngestionProcess: WorkspaceImageIngestionProcess; + /** + * The name of the WorkSpace image. + */ + ImageName: WorkspaceImageName; + /** + * The description of the WorkSpace image. + */ + ImageDescription: WorkspaceImageDescription; + /** + * The tags. Each WorkSpaces resource can have a maximum of 50 tags. + */ + Tags?: TagList; + } + export interface ImportWorkspaceImageResult { + /** + * The identifier of the WorkSpace image. + */ + ImageId?: WorkspaceImageId; + } + export type IpAddress = string; + export type IpGroupDesc = string; + export type IpGroupId = string; + export type IpGroupIdList = IpGroupId[]; + export type IpGroupName = string; + export type IpRevokedRuleList = IpRule[]; + export type IpRule = string; + export type IpRuleDesc = string; + export interface IpRuleItem { + /** + * The IP address range, in CIDR notation. + */ + ipRule?: IpRule; + /** + * The description. + */ + ruleDesc?: IpRuleDesc; + } + export type IpRuleList = IpRuleItem[]; + export type Limit = number; + export interface ListAvailableManagementCidrRangesRequest { + /** + * The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). + */ + ManagementCidrRangeConstraint: ManagementCidrRangeConstraint; + /** + * The maximum number of items to return. + */ + MaxResults?: ManagementCidrRangeMaxResults; + /** + * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. + */ + NextToken?: PaginationToken; + } + export interface ListAvailableManagementCidrRangesResult { + /** + * The list of available IP address ranges, specified as IPv4 CIDR blocks. + */ + ManagementCidrRanges?: DedicatedTenancyCidrRangeList; + /** + * The token to use to retrieve the next set of results, or null if no more results are available. + */ + NextToken?: PaginationToken; + } + export type ManagementCidrRangeConstraint = string; + export type ManagementCidrRangeMaxResults = number; + export type ModificationResourceEnum = "ROOT_VOLUME"|"USER_VOLUME"|"COMPUTE_TYPE"|string; + export interface ModificationState { + /** + * The resource. + */ + Resource?: ModificationResourceEnum; + /** + * The modification state. + */ + State?: ModificationStateEnum; + } + export type ModificationStateEnum = "UPDATE_INITIATED"|"UPDATE_IN_PROGRESS"|string; + export type ModificationStateList = ModificationState[]; + export interface ModifyAccountRequest { + /** + * The status of BYOL. + */ + DedicatedTenancySupport?: DedicatedTenancySupportEnum; + /** + * The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation. + */ + DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange; + } + export interface ModifyAccountResult { + } + export interface ModifyClientPropertiesRequest { + /** + * The resource identifiers, in the form of directory IDs. + */ + ResourceId: NonEmptyString; + /** + * Information about the Amazon WorkSpaces client. + */ + ClientProperties: ClientProperties; + } + export interface ModifyClientPropertiesResult { + } + export interface ModifyWorkspacePropertiesRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId: WorkspaceId; + /** + * The properties of the WorkSpace. + */ + WorkspaceProperties: WorkspaceProperties; + } + export interface ModifyWorkspacePropertiesResult { + } + export interface ModifyWorkspaceStateRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId: WorkspaceId; + /** + * The WorkSpace state. + */ + WorkspaceState: TargetWorkspaceState; + } + export interface ModifyWorkspaceStateResult { + } + export type NonEmptyString = string; + export interface OperatingSystem { + /** + * The operating system. + */ + Type?: OperatingSystemType; + } + export type OperatingSystemType = "WINDOWS"|"LINUX"|string; + export type PaginationToken = string; + export interface RebootRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId: WorkspaceId; + } + export type RebootWorkspaceRequests = RebootRequest[]; + export interface RebootWorkspacesRequest { + /** + * The WorkSpaces to reboot. You can specify up to 25 WorkSpaces. + */ + RebootWorkspaceRequests: RebootWorkspaceRequests; + } + export interface RebootWorkspacesResult { + /** + * Information about the WorkSpaces that could not be rebooted. + */ + FailedRequests?: FailedRebootWorkspaceRequests; + } + export interface RebuildRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId: WorkspaceId; + } + export type RebuildWorkspaceRequests = RebuildRequest[]; + export interface RebuildWorkspacesRequest { + /** + * The WorkSpace to rebuild. You can specify a single WorkSpace. + */ + RebuildWorkspaceRequests: RebuildWorkspaceRequests; + /** + * Reserved. + */ + AdditionalInfo?: AdditionalInfo; + } + export interface RebuildWorkspacesResult { + /** + * Information about the WorkSpace that could not be rebuilt. + */ + FailedRequests?: FailedRebuildWorkspaceRequests; + } + export type ReconnectEnum = "ENABLED"|"DISABLED"|string; + export type RegistrationCode = string; + export type ResourceIdList = NonEmptyString[]; + export interface RevokeIpRulesRequest { + /** + * The identifier of the group. + */ + GroupId: IpGroupId; + /** + * The rules to remove from the group. + */ + UserRules: IpRevokedRuleList; + } + export interface RevokeIpRulesResult { + } + export interface RootStorage { + /** + * The size of the root volume. + */ + Capacity?: NonEmptyString; + } + export type RootVolumeSizeGib = number; + export type RunningMode = "AUTO_STOP"|"ALWAYS_ON"|string; + export type RunningModeAutoStopTimeoutInMinutes = number; + export type SecurityGroupId = string; + export interface StartRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId?: WorkspaceId; + } + export type StartWorkspaceRequests = StartRequest[]; + export interface StartWorkspacesRequest { + /** + * The WorkSpaces to start. You can specify up to 25 WorkSpaces. + */ + StartWorkspaceRequests: StartWorkspaceRequests; + } + export interface StartWorkspacesResult { + /** + * Information about the WorkSpaces that could not be started. + */ + FailedRequests?: FailedStartWorkspaceRequests; + } + export interface StopRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId?: WorkspaceId; + } + export type StopWorkspaceRequests = StopRequest[]; + export interface StopWorkspacesRequest { + /** + * The WorkSpaces to stop. You can specify up to 25 WorkSpaces. + */ + StopWorkspaceRequests: StopWorkspaceRequests; + } + export interface StopWorkspacesResult { + /** + * Information about the WorkSpaces that could not be stopped. + */ + FailedRequests?: FailedStopWorkspaceRequests; + } + export type SubnetId = string; + export type SubnetIds = SubnetId[]; + export interface Tag { + /** + * The key of the tag. + */ + Key: TagKey; + /** + * The value of the tag. + */ + Value?: TagValue; + } + export type TagKey = string; + export type TagKeyList = NonEmptyString[]; + export type TagList = Tag[]; + export type TagValue = string; + export type TargetWorkspaceState = "AVAILABLE"|"ADMIN_MAINTENANCE"|string; + export interface TerminateRequest { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId: WorkspaceId; + } + export type TerminateWorkspaceRequests = TerminateRequest[]; + export interface TerminateWorkspacesRequest { + /** + * The WorkSpaces to terminate. You can specify up to 25 WorkSpaces. + */ + TerminateWorkspaceRequests: TerminateWorkspaceRequests; + } + export interface TerminateWorkspacesResult { + /** + * Information about the WorkSpaces that could not be terminated. + */ + FailedRequests?: FailedTerminateWorkspaceRequests; + } + export type Timestamp = Date; + export interface UpdateRulesOfIpGroupRequest { + /** + * The identifier of the group. + */ + GroupId: IpGroupId; + /** + * One or more rules. + */ + UserRules: IpRuleList; + } + export interface UpdateRulesOfIpGroupResult { + } + export type UserName = string; + export interface UserStorage { + /** + * The size of the user storage. + */ + Capacity?: NonEmptyString; + } + export type UserVolumeSizeGib = number; + export type VolumeEncryptionKey = string; + export interface Workspace { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId?: WorkspaceId; + /** + * The identifier of the AWS Directory Service directory for the WorkSpace. + */ + DirectoryId?: DirectoryId; + /** + * The user for the WorkSpace. + */ + UserName?: UserName; + /** + * The IP address of the WorkSpace. + */ + IpAddress?: IpAddress; + /** + * The operational state of the WorkSpace. + */ + State?: WorkspaceState; + /** + * The identifier of the bundle used to create the WorkSpace. + */ + BundleId?: BundleId; + /** + * The identifier of the subnet for the WorkSpace. + */ + SubnetId?: SubnetId; + /** + * The text of the error message that is returned if the WorkSpace cannot be created. + */ + ErrorMessage?: Description; + /** + * The error code that is returned if the WorkSpace cannot be created. + */ + ErrorCode?: WorkspaceErrorCode; + /** + * The name of the WorkSpace, as seen by the operating system. + */ + ComputerName?: ComputerName; + /** + * The KMS key used to encrypt data stored on your WorkSpace. + */ + VolumeEncryptionKey?: VolumeEncryptionKey; + /** + * Indicates whether the data stored on the user volume is encrypted. + */ + UserVolumeEncryptionEnabled?: BooleanObject; + /** + * Indicates whether the data stored on the root volume is encrypted. + */ + RootVolumeEncryptionEnabled?: BooleanObject; + /** + * The properties of the WorkSpace. + */ + WorkspaceProperties?: WorkspaceProperties; + /** + * The modification states of the WorkSpace. + */ + ModificationStates?: ModificationStateList; + } + export interface WorkspaceBundle { + /** + * The bundle identifier. + */ + BundleId?: BundleId; + /** + * The name of the bundle. + */ + Name?: NonEmptyString; + /** + * The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS. + */ + Owner?: BundleOwner; + /** + * A description. + */ + Description?: Description; + /** + * The size of the root volume. + */ + RootStorage?: RootStorage; + /** + * The size of the user storage. + */ + UserStorage?: UserStorage; + /** + * The compute type. For more information, see Amazon WorkSpaces Bundles. + */ + ComputeType?: ComputeType; + } + export interface WorkspaceConnectionStatus { + /** + * The identifier of the WorkSpace. + */ + WorkspaceId?: WorkspaceId; + /** + * The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped. + */ + ConnectionState?: ConnectionState; + /** + * The timestamp of the connection status check. + */ + ConnectionStateCheckTimestamp?: Timestamp; + /** + * The timestamp of the last known user connection. + */ + LastKnownUserConnectionTimestamp?: Timestamp; + } + export type WorkspaceConnectionStatusList = WorkspaceConnectionStatus[]; + export interface WorkspaceDirectory { + /** + * The directory identifier. + */ + DirectoryId?: DirectoryId; + /** + * The directory alias. + */ + Alias?: Alias; + /** + * The name of the directory. + */ + DirectoryName?: DirectoryName; + /** + * The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory. + */ + RegistrationCode?: RegistrationCode; + /** + * The identifiers of the subnets used with the directory. + */ + SubnetIds?: SubnetIds; + /** + * The IP addresses of the DNS servers for the directory. + */ + DnsIpAddresses?: DnsIpAddresses; + /** + * The user name for the service account. + */ + CustomerUserName?: UserName; + /** + * The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf. + */ + IamRoleId?: ARN; + /** + * The directory type. + */ + DirectoryType?: WorkspaceDirectoryType; + /** + * The identifier of the security group that is assigned to new WorkSpaces. + */ + WorkspaceSecurityGroupId?: SecurityGroupId; + /** + * The state of the directory's registration with Amazon WorkSpaces + */ + State?: WorkspaceDirectoryState; + /** + * The default creation properties for all WorkSpaces in the directory. + */ + WorkspaceCreationProperties?: DefaultWorkspaceCreationProperties; + /** + * The identifiers of the IP access control groups associated with the directory. + */ + ipGroupIds?: IpGroupIdList; + } + export type WorkspaceDirectoryState = "REGISTERING"|"REGISTERED"|"DEREGISTERING"|"DEREGISTERED"|"ERROR"|string; + export type WorkspaceDirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|string; + export type WorkspaceErrorCode = string; + export type WorkspaceId = string; + export type WorkspaceIdList = WorkspaceId[]; + export interface WorkspaceImage { + /** + * The identifier of the image. + */ + ImageId?: WorkspaceImageId; + /** + * The name of the image. + */ + Name?: WorkspaceImageName; + /** + * The description of the image. + */ + Description?: WorkspaceImageDescription; + /** + * The operating system that the image is running. + */ + OperatingSystem?: OperatingSystem; + /** + * The status of the image. + */ + State?: WorkspaceImageState; + /** + * Specifies whether the image is running on dedicated hardware. When bring your own license (BYOL) is enabled, this value is set to DEDICATED. + */ + RequiredTenancy?: WorkspaceImageRequiredTenancy; + /** + * The error code that is returned for the image. + */ + ErrorCode?: WorkspaceImageErrorCode; + /** + * The text of the error message that is returned for the image. + */ + ErrorMessage?: Description; + } + export type WorkspaceImageDescription = string; + export type WorkspaceImageErrorCode = string; + export type WorkspaceImageId = string; + export type WorkspaceImageIdList = WorkspaceImageId[]; + export type WorkspaceImageIngestionProcess = "BYOL_REGULAR"|"BYOL_GRAPHICS"|"BYOL_GRAPHICSPRO"|string; + export type WorkspaceImageList = WorkspaceImage[]; + export type WorkspaceImageName = string; + export type WorkspaceImageRequiredTenancy = "DEFAULT"|"DEDICATED"|string; + export type WorkspaceImageState = "AVAILABLE"|"PENDING"|"ERROR"|string; + export type WorkspaceList = Workspace[]; + export interface WorkspaceProperties { + /** + * The running mode. For more information, see Manage the WorkSpace Running Mode. + */ + RunningMode?: RunningMode; + /** + * The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals. + */ + RunningModeAutoStopTimeoutInMinutes?: RunningModeAutoStopTimeoutInMinutes; + /** + * The size of the root volume. + */ + RootVolumeSizeGib?: RootVolumeSizeGib; + /** + * The size of the user storage. + */ + UserVolumeSizeGib?: UserVolumeSizeGib; + /** + * The compute type. For more information, see Amazon WorkSpaces Bundles. + */ + ComputeTypeName?: Compute; + } + export interface WorkspaceRequest { + /** + * The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories. + */ + DirectoryId: DirectoryId; + /** + * The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace. + */ + UserName: UserName; + /** + * The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles. + */ + BundleId: BundleId; + /** + * The KMS key used to encrypt data stored on your WorkSpace. + */ + VolumeEncryptionKey?: VolumeEncryptionKey; + /** + * Indicates whether the data stored on the user volume is encrypted. + */ + UserVolumeEncryptionEnabled?: BooleanObject; + /** + * Indicates whether the data stored on the root volume is encrypted. + */ + RootVolumeEncryptionEnabled?: BooleanObject; + /** + * The WorkSpace properties. + */ + WorkspaceProperties?: WorkspaceProperties; + /** + * The tags for the WorkSpace. + */ + Tags?: TagList; + } + export type WorkspaceRequestList = WorkspaceRequest[]; + export type WorkspaceState = "PENDING"|"AVAILABLE"|"IMPAIRED"|"UNHEALTHY"|"REBOOTING"|"STARTING"|"REBUILDING"|"MAINTENANCE"|"ADMIN_MAINTENANCE"|"TERMINATING"|"TERMINATED"|"SUSPENDED"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR"|string; + export interface WorkspacesIpGroup { + /** + * The identifier of the group. + */ + groupId?: IpGroupId; + /** + * The name of the group. + */ + groupName?: IpGroupName; + /** + * The description of the group. + */ + groupDesc?: IpGroupDesc; + /** + * The rules. + */ + userRules?: IpRuleList; + } + export type WorkspacesIpGroupsList = WorkspacesIpGroup[]; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2015-04-08"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the WorkSpaces client. + */ + export import Types = WorkSpaces; +} +export = WorkSpaces; diff --git a/node_modules/aws-sdk/clients/workspaces.js b/node_modules/aws-sdk/clients/workspaces.js new file mode 100644 index 0000000..0a5ef89 --- /dev/null +++ b/node_modules/aws-sdk/clients/workspaces.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['workspaces'] = {}; +AWS.WorkSpaces = Service.defineService('workspaces', ['2015-04-08']); +Object.defineProperty(apiLoader.services['workspaces'], '2015-04-08', { + get: function get() { + var model = require('../apis/workspaces-2015-04-08.min.json'); + model.paginators = require('../apis/workspaces-2015-04-08.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.WorkSpaces; diff --git a/node_modules/aws-sdk/clients/xray.d.ts b/node_modules/aws-sdk/clients/xray.d.ts new file mode 100644 index 0000000..8a80651 --- /dev/null +++ b/node_modules/aws-sdk/clients/xray.d.ts @@ -0,0 +1,1532 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class XRay extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: XRay.Types.ClientConfiguration) + config: Config & XRay.Types.ClientConfiguration; + /** + * Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs. + */ + batchGetTraces(params: XRay.Types.BatchGetTracesRequest, callback?: (err: AWSError, data: XRay.Types.BatchGetTracesResult) => void): Request; + /** + * Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs. + */ + batchGetTraces(callback?: (err: AWSError, data: XRay.Types.BatchGetTracesResult) => void): Request; + /** + * Creates a group resource with a name and a filter expression. + */ + createGroup(params: XRay.Types.CreateGroupRequest, callback?: (err: AWSError, data: XRay.Types.CreateGroupResult) => void): Request; + /** + * Creates a group resource with a name and a filter expression. + */ + createGroup(callback?: (err: AWSError, data: XRay.Types.CreateGroupResult) => void): Request; + /** + * Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir. + */ + createSamplingRule(params: XRay.Types.CreateSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.CreateSamplingRuleResult) => void): Request; + /** + * Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir. + */ + createSamplingRule(callback?: (err: AWSError, data: XRay.Types.CreateSamplingRuleResult) => void): Request; + /** + * Deletes a group resource. + */ + deleteGroup(params: XRay.Types.DeleteGroupRequest, callback?: (err: AWSError, data: XRay.Types.DeleteGroupResult) => void): Request; + /** + * Deletes a group resource. + */ + deleteGroup(callback?: (err: AWSError, data: XRay.Types.DeleteGroupResult) => void): Request; + /** + * Deletes a sampling rule. + */ + deleteSamplingRule(params: XRay.Types.DeleteSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.DeleteSamplingRuleResult) => void): Request; + /** + * Deletes a sampling rule. + */ + deleteSamplingRule(callback?: (err: AWSError, data: XRay.Types.DeleteSamplingRuleResult) => void): Request; + /** + * Retrieves the current encryption configuration for X-Ray data. + */ + getEncryptionConfig(params: XRay.Types.GetEncryptionConfigRequest, callback?: (err: AWSError, data: XRay.Types.GetEncryptionConfigResult) => void): Request; + /** + * Retrieves the current encryption configuration for X-Ray data. + */ + getEncryptionConfig(callback?: (err: AWSError, data: XRay.Types.GetEncryptionConfigResult) => void): Request; + /** + * Retrieves group resource details. + */ + getGroup(params: XRay.Types.GetGroupRequest, callback?: (err: AWSError, data: XRay.Types.GetGroupResult) => void): Request; + /** + * Retrieves group resource details. + */ + getGroup(callback?: (err: AWSError, data: XRay.Types.GetGroupResult) => void): Request; + /** + * Retrieves all active group details. + */ + getGroups(params: XRay.Types.GetGroupsRequest, callback?: (err: AWSError, data: XRay.Types.GetGroupsResult) => void): Request; + /** + * Retrieves all active group details. + */ + getGroups(callback?: (err: AWSError, data: XRay.Types.GetGroupsResult) => void): Request; + /** + * Retrieves all sampling rules. + */ + getSamplingRules(params: XRay.Types.GetSamplingRulesRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingRulesResult) => void): Request; + /** + * Retrieves all sampling rules. + */ + getSamplingRules(callback?: (err: AWSError, data: XRay.Types.GetSamplingRulesResult) => void): Request; + /** + * Retrieves information about recent sampling results for all sampling rules. + */ + getSamplingStatisticSummaries(params: XRay.Types.GetSamplingStatisticSummariesRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingStatisticSummariesResult) => void): Request; + /** + * Retrieves information about recent sampling results for all sampling rules. + */ + getSamplingStatisticSummaries(callback?: (err: AWSError, data: XRay.Types.GetSamplingStatisticSummariesResult) => void): Request; + /** + * Requests a sampling quota for rules that the service is using to sample requests. + */ + getSamplingTargets(params: XRay.Types.GetSamplingTargetsRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingTargetsResult) => void): Request; + /** + * Requests a sampling quota for rules that the service is using to sample requests. + */ + getSamplingTargets(callback?: (err: AWSError, data: XRay.Types.GetSamplingTargetsResult) => void): Request; + /** + * Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases. + */ + getServiceGraph(params: XRay.Types.GetServiceGraphRequest, callback?: (err: AWSError, data: XRay.Types.GetServiceGraphResult) => void): Request; + /** + * Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases. + */ + getServiceGraph(callback?: (err: AWSError, data: XRay.Types.GetServiceGraphResult) => void): Request; + /** + * Get an aggregation of service statistics defined by a specific time range. + */ + getTimeSeriesServiceStatistics(params: XRay.Types.GetTimeSeriesServiceStatisticsRequest, callback?: (err: AWSError, data: XRay.Types.GetTimeSeriesServiceStatisticsResult) => void): Request; + /** + * Get an aggregation of service statistics defined by a specific time range. + */ + getTimeSeriesServiceStatistics(callback?: (err: AWSError, data: XRay.Types.GetTimeSeriesServiceStatisticsResult) => void): Request; + /** + * Retrieves a service graph for one or more specific trace IDs. + */ + getTraceGraph(params: XRay.Types.GetTraceGraphRequest, callback?: (err: AWSError, data: XRay.Types.GetTraceGraphResult) => void): Request; + /** + * Retrieves a service graph for one or more specific trace IDs. + */ + getTraceGraph(callback?: (err: AWSError, data: XRay.Types.GetTraceGraphResult) => void): Request; + /** + * Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide. + */ + getTraceSummaries(params: XRay.Types.GetTraceSummariesRequest, callback?: (err: AWSError, data: XRay.Types.GetTraceSummariesResult) => void): Request; + /** + * Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide. + */ + getTraceSummaries(callback?: (err: AWSError, data: XRay.Types.GetTraceSummariesResult) => void): Request; + /** + * Updates the encryption configuration for X-Ray data. + */ + putEncryptionConfig(params: XRay.Types.PutEncryptionConfigRequest, callback?: (err: AWSError, data: XRay.Types.PutEncryptionConfigResult) => void): Request; + /** + * Updates the encryption configuration for X-Ray data. + */ + putEncryptionConfig(callback?: (err: AWSError, data: XRay.Types.PutEncryptionConfigResult) => void): Request; + /** + * Used by the AWS X-Ray daemon to upload telemetry. + */ + putTelemetryRecords(params: XRay.Types.PutTelemetryRecordsRequest, callback?: (err: AWSError, data: XRay.Types.PutTelemetryRecordsResult) => void): Request; + /** + * Used by the AWS X-Ray daemon to upload telemetry. + */ + putTelemetryRecords(callback?: (err: AWSError, data: XRay.Types.PutTelemetryRecordsResult) => void): Request; + /** + * Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide. Required Segment Document Fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, i.e. 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. + */ + putTraceSegments(params: XRay.Types.PutTraceSegmentsRequest, callback?: (err: AWSError, data: XRay.Types.PutTraceSegmentsResult) => void): Request; + /** + * Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide. Required Segment Document Fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, i.e. 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. + */ + putTraceSegments(callback?: (err: AWSError, data: XRay.Types.PutTraceSegmentsResult) => void): Request; + /** + * Updates a group resource. + */ + updateGroup(params: XRay.Types.UpdateGroupRequest, callback?: (err: AWSError, data: XRay.Types.UpdateGroupResult) => void): Request; + /** + * Updates a group resource. + */ + updateGroup(callback?: (err: AWSError, data: XRay.Types.UpdateGroupResult) => void): Request; + /** + * Modifies a sampling rule's configuration. + */ + updateSamplingRule(params: XRay.Types.UpdateSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.UpdateSamplingRuleResult) => void): Request; + /** + * Modifies a sampling rule's configuration. + */ + updateSamplingRule(callback?: (err: AWSError, data: XRay.Types.UpdateSamplingRuleResult) => void): Request; +} +declare namespace XRay { + export interface Alias { + /** + * The canonical name of the alias. + */ + Name?: String; + /** + * A list of names for the alias, including the canonical name. + */ + Names?: AliasNames; + /** + * The type of the alias. + */ + Type?: String; + } + export type AliasList = Alias[]; + export type AliasNames = String[]; + export type AnnotationKey = string; + export interface AnnotationValue { + /** + * Value for a Number annotation. + */ + NumberValue?: NullableDouble; + /** + * Value for a Boolean annotation. + */ + BooleanValue?: NullableBoolean; + /** + * Value for a String annotation. + */ + StringValue?: String; + } + export type Annotations = {[key: string]: ValuesWithServiceIds}; + export type AttributeKey = string; + export type AttributeMap = {[key: string]: AttributeValue}; + export type AttributeValue = string; + export interface AvailabilityZoneDetail { + /** + * The name of a corresponding availability zone. + */ + Name?: String; + } + export interface BackendConnectionErrors { + /** + * + */ + TimeoutCount?: NullableInteger; + /** + * + */ + ConnectionRefusedCount?: NullableInteger; + /** + * + */ + HTTPCode4XXCount?: NullableInteger; + /** + * + */ + HTTPCode5XXCount?: NullableInteger; + /** + * + */ + UnknownHostCount?: NullableInteger; + /** + * + */ + OtherCount?: NullableInteger; + } + export interface BatchGetTracesRequest { + /** + * Specify the trace IDs of requests for which to retrieve segments. + */ + TraceIds: TraceIdList; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface BatchGetTracesResult { + /** + * Full traces for the specified requests. + */ + Traces?: TraceList; + /** + * Trace IDs of requests that haven't been processed. + */ + UnprocessedTraceIds?: UnprocessedTraceIdList; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export type Boolean = boolean; + export type BorrowCount = number; + export type ClientID = string; + export interface CreateGroupRequest { + /** + * The case-sensitive name of the new group. Default is a reserved name and names must be unique. + */ + GroupName: GroupName; + /** + * The filter expression defining criteria by which to group traces. + */ + FilterExpression?: FilterExpression; + } + export interface CreateGroupResult { + /** + * The group that was created. Contains the name of the group that was created, the ARN of the group that was generated based on the group name, and the filter expression that was assigned to the group. + */ + Group?: Group; + } + export interface CreateSamplingRuleRequest { + /** + * The rule definition. + */ + SamplingRule: SamplingRule; + } + export interface CreateSamplingRuleResult { + /** + * The saved rule definition and metadata. + */ + SamplingRuleRecord?: SamplingRuleRecord; + } + export interface DeleteGroupRequest { + /** + * The case-sensitive name of the group. + */ + GroupName?: GroupName; + /** + * The ARN of the group that was generated on creation. + */ + GroupARN?: GroupARN; + } + export interface DeleteGroupResult { + } + export interface DeleteSamplingRuleRequest { + /** + * The name of the sampling rule. Specify a rule by either name or ARN, but not both. + */ + RuleName?: String; + /** + * The ARN of the sampling rule. Specify a rule by either name or ARN, but not both. + */ + RuleARN?: String; + } + export interface DeleteSamplingRuleResult { + /** + * The deleted rule definition and metadata. + */ + SamplingRuleRecord?: SamplingRuleRecord; + } + export type Double = number; + export type EC2InstanceId = string; + export interface Edge { + /** + * Identifier of the edge. Unique within a service map. + */ + ReferenceId?: NullableInteger; + /** + * The start time of the first segment on the edge. + */ + StartTime?: Timestamp; + /** + * The end time of the last segment on the edge. + */ + EndTime?: Timestamp; + /** + * Response statistics for segments on the edge. + */ + SummaryStatistics?: EdgeStatistics; + /** + * A histogram that maps the spread of client response times on an edge. + */ + ResponseTimeHistogram?: Histogram; + /** + * Aliases for the edge. + */ + Aliases?: AliasList; + } + export type EdgeList = Edge[]; + export interface EdgeStatistics { + /** + * The number of requests that completed with a 2xx Success status code. + */ + OkCount?: NullableLong; + /** + * Information about requests that failed with a 4xx Client Error status code. + */ + ErrorStatistics?: ErrorStatistics; + /** + * Information about requests that failed with a 5xx Server Error status code. + */ + FaultStatistics?: FaultStatistics; + /** + * The total number of completed requests. + */ + TotalCount?: NullableLong; + /** + * The aggregate response time of completed requests. + */ + TotalResponseTime?: NullableDouble; + } + export interface EncryptionConfig { + /** + * The ID of the customer master key (CMK) used for encryption, if applicable. + */ + KeyId?: String; + /** + * The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings. + */ + Status?: EncryptionStatus; + /** + * The type of encryption. Set to KMS for encryption with CMKs. Set to NONE for default encryption. + */ + Type?: EncryptionType; + } + export type EncryptionKeyId = string; + export type EncryptionStatus = "UPDATING"|"ACTIVE"|string; + export type EncryptionType = "NONE"|"KMS"|string; + export type EntitySelectorExpression = string; + export interface ErrorRootCause { + /** + * A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag. + */ + Services?: ErrorRootCauseServices; + } + export interface ErrorRootCauseEntity { + /** + * The name of the entity. + */ + Name?: String; + /** + * The types and messages of the exceptions. + */ + Exceptions?: RootCauseExceptions; + /** + * A flag that denotes a remote subsegment. + */ + Remote?: NullableBoolean; + } + export type ErrorRootCauseEntityPath = ErrorRootCauseEntity[]; + export interface ErrorRootCauseService { + /** + * The service name. + */ + Name?: String; + /** + * A collection of associated service names. + */ + Names?: ServiceNames; + /** + * The type associated to the service. + */ + Type?: String; + /** + * The account ID associated to the service. + */ + AccountId?: String; + /** + * The path of root cause entities found on the service. + */ + EntityPath?: ErrorRootCauseEntityPath; + /** + * A Boolean value indicating if the service is inferred from the trace. + */ + Inferred?: NullableBoolean; + } + export type ErrorRootCauseServices = ErrorRootCauseService[]; + export type ErrorRootCauses = ErrorRootCause[]; + export interface ErrorStatistics { + /** + * The number of requests that failed with a 419 throttling status code. + */ + ThrottleCount?: NullableLong; + /** + * The number of requests that failed with untracked 4xx Client Error status codes. + */ + OtherCount?: NullableLong; + /** + * The total number of requests that failed with a 4xx Client Error status code. + */ + TotalCount?: NullableLong; + } + export interface FaultRootCause { + /** + * A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag. + */ + Services?: FaultRootCauseServices; + } + export interface FaultRootCauseEntity { + /** + * The name of the entity. + */ + Name?: String; + /** + * The types and messages of the exceptions. + */ + Exceptions?: RootCauseExceptions; + /** + * A flag that denotes a remote subsegment. + */ + Remote?: NullableBoolean; + } + export type FaultRootCauseEntityPath = FaultRootCauseEntity[]; + export interface FaultRootCauseService { + /** + * The service name. + */ + Name?: String; + /** + * A collection of associated service names. + */ + Names?: ServiceNames; + /** + * The type associated to the service. + */ + Type?: String; + /** + * The account ID associated to the service. + */ + AccountId?: String; + /** + * The path of root cause entities found on the service. + */ + EntityPath?: FaultRootCauseEntityPath; + /** + * A Boolean value indicating if the service is inferred from the trace. + */ + Inferred?: NullableBoolean; + } + export type FaultRootCauseServices = FaultRootCauseService[]; + export type FaultRootCauses = FaultRootCause[]; + export interface FaultStatistics { + /** + * The number of requests that failed with untracked 5xx Server Error status codes. + */ + OtherCount?: NullableLong; + /** + * The total number of requests that failed with a 5xx Server Error status code. + */ + TotalCount?: NullableLong; + } + export type FilterExpression = string; + export type FixedRate = number; + export interface GetEncryptionConfigRequest { + } + export interface GetEncryptionConfigResult { + /** + * The encryption configuration document. + */ + EncryptionConfig?: EncryptionConfig; + } + export interface GetGroupRequest { + /** + * The case-sensitive name of the group. + */ + GroupName?: GroupName; + /** + * The ARN of the group that was generated on creation. + */ + GroupARN?: GroupARN; + } + export interface GetGroupResult { + /** + * The group that was requested. Contains the name of the group, the ARN of the group, and the filter expression that assigned to the group. + */ + Group?: Group; + } + export type GetGroupsNextToken = string; + export interface GetGroupsRequest { + /** + * Pagination token. Not used. + */ + NextToken?: GetGroupsNextToken; + } + export interface GetGroupsResult { + /** + * The collection of all active groups. + */ + Groups?: GroupSummaryList; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetSamplingRulesRequest { + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetSamplingRulesResult { + /** + * Rule definitions and metadata. + */ + SamplingRuleRecords?: SamplingRuleRecordList; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetSamplingStatisticSummariesRequest { + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetSamplingStatisticSummariesResult { + /** + * Information about the number of requests instrumented for each sampling rule. + */ + SamplingStatisticSummaries?: SamplingStatisticSummaryList; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetSamplingTargetsRequest { + /** + * Information about rules that the service is using to sample requests. + */ + SamplingStatisticsDocuments: SamplingStatisticsDocumentList; + } + export interface GetSamplingTargetsResult { + /** + * Updated rules that the service should use to sample requests. + */ + SamplingTargetDocuments?: SamplingTargetDocumentList; + /** + * The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version. + */ + LastRuleModification?: Timestamp; + /** + * Information about SamplingStatisticsDocument that X-Ray could not process. + */ + UnprocessedStatistics?: UnprocessedStatisticsList; + } + export interface GetServiceGraphRequest { + /** + * The start of the time frame for which to generate a graph. + */ + StartTime: Timestamp; + /** + * The end of the timeframe for which to generate a graph. + */ + EndTime: Timestamp; + /** + * The name of a group to generate a graph based on. + */ + GroupName?: GroupName; + /** + * The ARN of a group to generate a graph based on. + */ + GroupARN?: GroupARN; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetServiceGraphResult { + /** + * The start of the time frame for which the graph was generated. + */ + StartTime?: Timestamp; + /** + * The end of the time frame for which the graph was generated. + */ + EndTime?: Timestamp; + /** + * The services that have processed a traced request during the specified time frame. + */ + Services?: ServiceList; + /** + * A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression. + */ + ContainsOldGroupVersions?: Boolean; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetTimeSeriesServiceStatisticsRequest { + /** + * The start of the time frame for which to aggregate statistics. + */ + StartTime: Timestamp; + /** + * The end of the time frame for which to aggregate statistics. + */ + EndTime: Timestamp; + /** + * The case-sensitive name of the group for which to pull statistics from. + */ + GroupName?: GroupName; + /** + * The ARN of the group for which to pull statistics from. + */ + GroupARN?: GroupARN; + /** + * A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned. + */ + EntitySelectorExpression?: EntitySelectorExpression; + /** + * Aggregation period in seconds. + */ + Period?: NullableInteger; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetTimeSeriesServiceStatisticsResult { + /** + * The collection of statistics. + */ + TimeSeriesServiceStatistics?: TimeSeriesServiceStatisticsList; + /** + * A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation may show statistics from an older version of the group's filter expression. + */ + ContainsOldGroupVersions?: Boolean; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetTraceGraphRequest { + /** + * Trace IDs of requests for which to generate a service graph. + */ + TraceIds: TraceIdList; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetTraceGraphResult { + /** + * The services that have processed one of the specified requests. + */ + Services?: ServiceList; + /** + * Pagination token. Not used. + */ + NextToken?: String; + } + export interface GetTraceSummariesRequest { + /** + * The start of the time frame for which to retrieve traces. + */ + StartTime: Timestamp; + /** + * The end of the time frame for which to retrieve traces. + */ + EndTime: Timestamp; + /** + * A parameter to indicate whether to query trace summaries by TraceId or Event time. + */ + TimeRangeType?: TimeRangeType; + /** + * Set to true to get summaries for only a subset of available traces. + */ + Sampling?: NullableBoolean; + /** + * A paramater to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value. + */ + SamplingStrategy?: SamplingStrategy; + /** + * Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements. + */ + FilterExpression?: FilterExpression; + /** + * Specify the pagination token returned by a previous request to retrieve the next page of results. + */ + NextToken?: String; + } + export interface GetTraceSummariesResult { + /** + * Trace IDs and metadata for traces that were found in the specified time frame. + */ + TraceSummaries?: TraceSummaryList; + /** + * The start time of this page of results. + */ + ApproximateTime?: Timestamp; + /** + * The total number of traces processed, including traces that did not match the specified filter expression. + */ + TracesProcessedCount?: NullableLong; + /** + * If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most most recent results, closest to the end of the time frame. + */ + NextToken?: String; + } + export interface Group { + /** + * The unique case-sensitive name of the group. + */ + GroupName?: String; + /** + * The ARN of the group generated based on the GroupName. + */ + GroupARN?: String; + /** + * The filter expression defining the parameters to include traces. + */ + FilterExpression?: String; + } + export type GroupARN = string; + export type GroupName = string; + export interface GroupSummary { + /** + * The unique case-sensitive name of the group. + */ + GroupName?: String; + /** + * The ARN of the group generated based on the GroupName. + */ + GroupARN?: String; + /** + * The filter expression defining the parameters to include traces. + */ + FilterExpression?: String; + } + export type GroupSummaryList = GroupSummary[]; + export type HTTPMethod = string; + export type Histogram = HistogramEntry[]; + export interface HistogramEntry { + /** + * The value of the entry. + */ + Value?: Double; + /** + * The prevalence of the entry. + */ + Count?: Integer; + } + export type Host = string; + export type Hostname = string; + export interface Http { + /** + * The request URL. + */ + HttpURL?: String; + /** + * The response status. + */ + HttpStatus?: NullableInteger; + /** + * The request method. + */ + HttpMethod?: String; + /** + * The request's user agent string. + */ + UserAgent?: String; + /** + * The IP address of the requestor. + */ + ClientIp?: String; + } + export interface InstanceIdDetail { + /** + * The ID of a corresponding EC2 instance. + */ + Id?: String; + } + export type Integer = number; + export type NullableBoolean = boolean; + export type NullableDouble = number; + export type NullableInteger = number; + export type NullableLong = number; + export type Priority = number; + export interface PutEncryptionConfigRequest { + /** + * An AWS KMS customer master key (CMK) in one of the following formats: Alias - The name of the key. For example, alias/MyKey. Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account. Omit this key if you set Type to NONE. + */ + KeyId?: EncryptionKeyId; + /** + * The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption. + */ + Type: EncryptionType; + } + export interface PutEncryptionConfigResult { + /** + * The new encryption configuration. + */ + EncryptionConfig?: EncryptionConfig; + } + export interface PutTelemetryRecordsRequest { + /** + * + */ + TelemetryRecords: TelemetryRecordList; + /** + * + */ + EC2InstanceId?: EC2InstanceId; + /** + * + */ + Hostname?: Hostname; + /** + * + */ + ResourceARN?: ResourceARN; + } + export interface PutTelemetryRecordsResult { + } + export interface PutTraceSegmentsRequest { + /** + * A string containing a JSON document defining one or more segments or subsegments. + */ + TraceSegmentDocuments: TraceSegmentDocumentList; + } + export interface PutTraceSegmentsResult { + /** + * Segments that failed processing. + */ + UnprocessedTraceSegments?: UnprocessedTraceSegmentList; + } + export type RequestCount = number; + export type ReservoirSize = number; + export type ResourceARN = string; + export interface ResourceARNDetail { + /** + * The ARN of a corresponding resource. + */ + ARN?: String; + } + export interface ResponseTimeRootCause { + /** + * A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag. + */ + Services?: ResponseTimeRootCauseServices; + } + export interface ResponseTimeRootCauseEntity { + /** + * The name of the entity. + */ + Name?: String; + /** + * The types and messages of the exceptions. + */ + Coverage?: NullableDouble; + /** + * A flag that denotes a remote subsegment. + */ + Remote?: NullableBoolean; + } + export type ResponseTimeRootCauseEntityPath = ResponseTimeRootCauseEntity[]; + export interface ResponseTimeRootCauseService { + /** + * The service name. + */ + Name?: String; + /** + * A collection of associated service names. + */ + Names?: ServiceNames; + /** + * The type associated to the service. + */ + Type?: String; + /** + * The account ID associated to the service. + */ + AccountId?: String; + /** + * The path of root cause entities found on the service. + */ + EntityPath?: ResponseTimeRootCauseEntityPath; + /** + * A Boolean value indicating if the service is inferred from the trace. + */ + Inferred?: NullableBoolean; + } + export type ResponseTimeRootCauseServices = ResponseTimeRootCauseService[]; + export type ResponseTimeRootCauses = ResponseTimeRootCause[]; + export interface RootCauseException { + /** + * The name of the exception. + */ + Name?: String; + /** + * The message of the exception. + */ + Message?: String; + } + export type RootCauseExceptions = RootCauseException[]; + export type RuleName = string; + export type SampledCount = number; + export interface SamplingRule { + /** + * The name of the sampling rule. Specify a rule by either name or ARN, but not both. + */ + RuleName?: RuleName; + /** + * The ARN of the sampling rule. Specify a rule by either name or ARN, but not both. + */ + RuleARN?: String; + /** + * Matches the ARN of the AWS resource on which the service runs. + */ + ResourceARN: ResourceARN; + /** + * The priority of the sampling rule. + */ + Priority: Priority; + /** + * The percentage of matching requests to instrument, after the reservoir is exhausted. + */ + FixedRate: FixedRate; + /** + * A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively. + */ + ReservoirSize: ReservoirSize; + /** + * Matches the name that the service uses to identify itself in segments. + */ + ServiceName: ServiceName; + /** + * Matches the origin that the service uses to identify its type in segments. + */ + ServiceType: ServiceType; + /** + * Matches the hostname from a request URL. + */ + Host: Host; + /** + * Matches the HTTP method of a request. + */ + HTTPMethod: HTTPMethod; + /** + * Matches the path from a request URL. + */ + URLPath: URLPath; + /** + * The version of the sampling rule format (1). + */ + Version: Version; + /** + * Matches attributes derived from the request. + */ + Attributes?: AttributeMap; + } + export interface SamplingRuleRecord { + /** + * The sampling rule. + */ + SamplingRule?: SamplingRule; + /** + * When the rule was created. + */ + CreatedAt?: Timestamp; + /** + * When the rule was last modified. + */ + ModifiedAt?: Timestamp; + } + export type SamplingRuleRecordList = SamplingRuleRecord[]; + export interface SamplingRuleUpdate { + /** + * The name of the sampling rule. Specify a rule by either name or ARN, but not both. + */ + RuleName?: RuleName; + /** + * The ARN of the sampling rule. Specify a rule by either name or ARN, but not both. + */ + RuleARN?: String; + /** + * Matches the ARN of the AWS resource on which the service runs. + */ + ResourceARN?: ResourceARN; + /** + * The priority of the sampling rule. + */ + Priority?: NullableInteger; + /** + * The percentage of matching requests to instrument, after the reservoir is exhausted. + */ + FixedRate?: NullableDouble; + /** + * A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively. + */ + ReservoirSize?: NullableInteger; + /** + * Matches the hostname from a request URL. + */ + Host?: Host; + /** + * Matches the name that the service uses to identify itself in segments. + */ + ServiceName?: ServiceName; + /** + * Matches the origin that the service uses to identify its type in segments. + */ + ServiceType?: ServiceType; + /** + * Matches the HTTP method of a request. + */ + HTTPMethod?: HTTPMethod; + /** + * Matches the path from a request URL. + */ + URLPath?: URLPath; + /** + * Matches attributes derived from the request. + */ + Attributes?: AttributeMap; + } + export interface SamplingStatisticSummary { + /** + * The name of the sampling rule. + */ + RuleName?: String; + /** + * The start time of the reporting window. + */ + Timestamp?: Timestamp; + /** + * The number of requests that matched the rule. + */ + RequestCount?: Integer; + /** + * The number of requests recorded with borrowed reservoir quota. + */ + BorrowCount?: Integer; + /** + * The number of requests recorded. + */ + SampledCount?: Integer; + } + export type SamplingStatisticSummaryList = SamplingStatisticSummary[]; + export interface SamplingStatisticsDocument { + /** + * The name of the sampling rule. + */ + RuleName: RuleName; + /** + * A unique identifier for the service in hexadecimal. + */ + ClientID: ClientID; + /** + * The current time. + */ + Timestamp: Timestamp; + /** + * The number of requests that matched the rule. + */ + RequestCount: RequestCount; + /** + * The number of requests recorded. + */ + SampledCount: SampledCount; + /** + * The number of requests recorded with borrowed reservoir quota. + */ + BorrowCount?: BorrowCount; + } + export type SamplingStatisticsDocumentList = SamplingStatisticsDocument[]; + export interface SamplingStrategy { + /** + * The name of a sampling rule. + */ + Name?: SamplingStrategyName; + /** + * The value of a sampling rule. + */ + Value?: NullableDouble; + } + export type SamplingStrategyName = "PartialScan"|"FixedRate"|string; + export interface SamplingTargetDocument { + /** + * The name of the sampling rule. + */ + RuleName?: String; + /** + * The percentage of matching requests to instrument, after the reservoir is exhausted. + */ + FixedRate?: Double; + /** + * The number of requests per second that X-Ray allocated this service. + */ + ReservoirQuota?: NullableInteger; + /** + * When the reservoir quota expires. + */ + ReservoirQuotaTTL?: Timestamp; + /** + * The number of seconds for the service to wait before getting sampling targets again. + */ + Interval?: NullableInteger; + } + export type SamplingTargetDocumentList = SamplingTargetDocument[]; + export interface Segment { + /** + * The segment's ID. + */ + Id?: SegmentId; + /** + * The segment document. + */ + Document?: SegmentDocument; + } + export type SegmentDocument = string; + export type SegmentId = string; + export type SegmentList = Segment[]; + export interface Service { + /** + * Identifier for the service. Unique within the service map. + */ + ReferenceId?: NullableInteger; + /** + * The canonical name of the service. + */ + Name?: String; + /** + * A list of names for the service, including the canonical name. + */ + Names?: ServiceNames; + /** + * Indicates that the service was the first service to process a request. + */ + Root?: NullableBoolean; + /** + * Identifier of the AWS account in which the service runs. + */ + AccountId?: String; + /** + * The type of service. AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. AWS Service - The type of an AWS service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table. client - Represents the clients that sent requests to a root service. remote - A downstream service of indeterminate type. + */ + Type?: String; + /** + * The service's state. + */ + State?: String; + /** + * The start time of the first segment that the service generated. + */ + StartTime?: Timestamp; + /** + * The end time of the last segment that the service generated. + */ + EndTime?: Timestamp; + /** + * Connections to downstream services. + */ + Edges?: EdgeList; + /** + * Aggregated statistics for the service. + */ + SummaryStatistics?: ServiceStatistics; + /** + * A histogram that maps the spread of service durations. + */ + DurationHistogram?: Histogram; + /** + * A histogram that maps the spread of service response times. + */ + ResponseTimeHistogram?: Histogram; + } + export interface ServiceId { + /** + * + */ + Name?: String; + /** + * + */ + Names?: ServiceNames; + /** + * + */ + AccountId?: String; + /** + * + */ + Type?: String; + } + export type ServiceIds = ServiceId[]; + export type ServiceList = Service[]; + export type ServiceName = string; + export type ServiceNames = String[]; + export interface ServiceStatistics { + /** + * The number of requests that completed with a 2xx Success status code. + */ + OkCount?: NullableLong; + /** + * Information about requests that failed with a 4xx Client Error status code. + */ + ErrorStatistics?: ErrorStatistics; + /** + * Information about requests that failed with a 5xx Server Error status code. + */ + FaultStatistics?: FaultStatistics; + /** + * The total number of completed requests. + */ + TotalCount?: NullableLong; + /** + * The aggregate response time of completed requests. + */ + TotalResponseTime?: NullableDouble; + } + export type ServiceType = string; + export type String = string; + export interface TelemetryRecord { + /** + * + */ + Timestamp: Timestamp; + /** + * + */ + SegmentsReceivedCount?: NullableInteger; + /** + * + */ + SegmentsSentCount?: NullableInteger; + /** + * + */ + SegmentsSpilloverCount?: NullableInteger; + /** + * + */ + SegmentsRejectedCount?: NullableInteger; + /** + * + */ + BackendConnectionErrors?: BackendConnectionErrors; + } + export type TelemetryRecordList = TelemetryRecord[]; + export type TimeRangeType = "TraceId"|"Event"|string; + export interface TimeSeriesServiceStatistics { + /** + * Timestamp of the window for which statistics are aggregated. + */ + Timestamp?: Timestamp; + EdgeSummaryStatistics?: EdgeStatistics; + ServiceSummaryStatistics?: ServiceStatistics; + /** + * The response time histogram for the selected entities. + */ + ResponseTimeHistogram?: Histogram; + } + export type TimeSeriesServiceStatisticsList = TimeSeriesServiceStatistics[]; + export type Timestamp = Date; + export interface Trace { + /** + * The unique identifier for the request that generated the trace's segments and subsegments. + */ + Id?: TraceId; + /** + * The length of time in seconds between the start time of the root segment and the end time of the last segment that completed. + */ + Duration?: NullableDouble; + /** + * Segment documents for the segments and subsegments that comprise the trace. + */ + Segments?: SegmentList; + } + export type TraceAvailabilityZones = AvailabilityZoneDetail[]; + export type TraceId = string; + export type TraceIdList = TraceId[]; + export type TraceInstanceIds = InstanceIdDetail[]; + export type TraceList = Trace[]; + export type TraceResourceARNs = ResourceARNDetail[]; + export type TraceSegmentDocument = string; + export type TraceSegmentDocumentList = TraceSegmentDocument[]; + export interface TraceSummary { + /** + * The unique identifier for the request that generated the trace's segments and subsegments. + */ + Id?: TraceId; + /** + * The length of time in seconds between the start time of the root segment and the end time of the last segment that completed. + */ + Duration?: NullableDouble; + /** + * The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes. + */ + ResponseTime?: NullableDouble; + /** + * One or more of the segment documents has a 500 series error. + */ + HasFault?: NullableBoolean; + /** + * One or more of the segment documents has a 400 series error. + */ + HasError?: NullableBoolean; + /** + * One or more of the segment documents has a 429 throttling error. + */ + HasThrottle?: NullableBoolean; + /** + * One or more of the segment documents is in progress. + */ + IsPartial?: NullableBoolean; + /** + * Information about the HTTP request served by the trace. + */ + Http?: Http; + /** + * Annotations from the trace's segment documents. + */ + Annotations?: Annotations; + /** + * Users from the trace's segment documents. + */ + Users?: TraceUsers; + /** + * Service IDs from the trace's segment documents. + */ + ServiceIds?: ServiceIds; + /** + * A list of resource ARNs for any resource corresponding to the trace segments. + */ + ResourceARNs?: TraceResourceARNs; + /** + * A list of EC2 instance IDs for any instance corresponding to the trace segments. + */ + InstanceIds?: TraceInstanceIds; + /** + * A list of availability zones for any zone corresponding to the trace segments. + */ + AvailabilityZones?: TraceAvailabilityZones; + /** + * The root of a trace. + */ + EntryPoint?: ServiceId; + /** + * A collection of FaultRootCause structures corresponding to the the trace segments. + */ + FaultRootCauses?: FaultRootCauses; + /** + * A collection of ErrorRootCause structures corresponding to the trace segments. + */ + ErrorRootCauses?: ErrorRootCauses; + /** + * A collection of ResponseTimeRootCause structures corresponding to the trace segments. + */ + ResponseTimeRootCauses?: ResponseTimeRootCauses; + /** + * The revision number of a trace. + */ + Revision?: Integer; + /** + * The matched time stamp of a defined event. + */ + MatchedEventTime?: Timestamp; + } + export type TraceSummaryList = TraceSummary[]; + export interface TraceUser { + /** + * The user's name. + */ + UserName?: String; + /** + * Services that the user's request hit. + */ + ServiceIds?: ServiceIds; + } + export type TraceUsers = TraceUser[]; + export type URLPath = string; + export interface UnprocessedStatistics { + /** + * The name of the sampling rule. + */ + RuleName?: String; + /** + * The error code. + */ + ErrorCode?: String; + /** + * The error message. + */ + Message?: String; + } + export type UnprocessedStatisticsList = UnprocessedStatistics[]; + export type UnprocessedTraceIdList = TraceId[]; + export interface UnprocessedTraceSegment { + /** + * The segment's ID. + */ + Id?: String; + /** + * The error that caused processing to fail. + */ + ErrorCode?: String; + /** + * The error message. + */ + Message?: String; + } + export type UnprocessedTraceSegmentList = UnprocessedTraceSegment[]; + export interface UpdateGroupRequest { + /** + * The case-sensitive name of the group. + */ + GroupName?: GroupName; + /** + * The ARN that was generated upon creation. + */ + GroupARN?: GroupARN; + /** + * The updated filter expression defining criteria by which to group traces. + */ + FilterExpression?: FilterExpression; + } + export interface UpdateGroupResult { + /** + * The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, and the updated filter expression assigned to the group. + */ + Group?: Group; + } + export interface UpdateSamplingRuleRequest { + /** + * The rule and fields to change. + */ + SamplingRuleUpdate: SamplingRuleUpdate; + } + export interface UpdateSamplingRuleResult { + /** + * The updated rule definition and metadata. + */ + SamplingRuleRecord?: SamplingRuleRecord; + } + export interface ValueWithServiceIds { + /** + * Values of the annotation. + */ + AnnotationValue?: AnnotationValue; + /** + * Services to which the annotation applies. + */ + ServiceIds?: ServiceIds; + } + export type ValuesWithServiceIds = ValueWithServiceIds[]; + export type Version = number; + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + export type apiVersion = "2016-04-12"|"latest"|string; + export interface ClientApiVersions { + /** + * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. + */ + apiVersion?: apiVersion; + } + export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; + /** + * Contains interfaces for use with the XRay client. + */ + export import Types = XRay; +} +export = XRay; diff --git a/node_modules/aws-sdk/clients/xray.js b/node_modules/aws-sdk/clients/xray.js new file mode 100644 index 0000000..7ad27b8 --- /dev/null +++ b/node_modules/aws-sdk/clients/xray.js @@ -0,0 +1,18 @@ +require('../lib/node_loader'); +var AWS = require('../lib/core'); +var Service = AWS.Service; +var apiLoader = AWS.apiLoader; + +apiLoader.services['xray'] = {}; +AWS.XRay = Service.defineService('xray', ['2016-04-12']); +Object.defineProperty(apiLoader.services['xray'], '2016-04-12', { + get: function get() { + var model = require('../apis/xray-2016-04-12.min.json'); + model.paginators = require('../apis/xray-2016-04-12.paginators.json').pagination; + return model; + }, + enumerable: true, + configurable: true +}); + +module.exports = AWS.XRay; diff --git a/node_modules/aws-sdk/dist-tools/browser-builder.js b/node_modules/aws-sdk/dist-tools/browser-builder.js new file mode 100755 index 0000000..902e56b --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/browser-builder.js @@ -0,0 +1,56 @@ +#!/usr/bin/env node + +var path = require('path'); + +var AWS = require('../index'); + +var license = [ + '// AWS SDK for JavaScript v' + AWS.VERSION, + '// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.', + '// License at https://sdk.amazonaws.com/js/BUNDLE_LICENSE.txt' +].join('\n') + '\n'; + +function minify(code) { + var uglify = require('uglify-js'); + var minified = uglify.minify(code, {fromString: true}); + return minified.code; +} + +function build(options, callback) { + if (arguments.length === 1) { + callback = options; + options = {}; + } + + var img = require('insert-module-globals'); + img.vars.process = function() { return '{browser:true}'; }; + + if (options.services) process.env.AWS_SERVICES = options.services; + + var browserify = require('browserify'); + var brOpts = { basedir: path.resolve(__dirname, '..') }; + browserify(brOpts).add('./').ignore('domain').bundle(function(err, data) { + if (err) return callback(err); + + var code = (data || '').toString(); + if (options.minify) code = minify(code); + + code = license + code; + callback(null, code); + }); +} + +// run if we called this tool directly +if (require.main === module) { + var opts = { + services: process.argv[2] || process.env.SERVICES, + minify: process.env.MINIFY ? true : false + }; + build(opts, function(err, code) { + if (err) console.error(err.message); + else console.log(code); + }); +} + +build.license = license; +module.exports = build; diff --git a/node_modules/aws-sdk/dist-tools/client-creator.js b/node_modules/aws-sdk/dist-tools/client-creator.js new file mode 100644 index 0000000..156089e --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/client-creator.js @@ -0,0 +1,214 @@ +var fs = require('fs'); +var path = require('path'); + +// Generate service clients +function ClientCreator() { + this._metadata = require('../apis/metadata'); + this._apisFolderPath = path.join(__dirname, '..', 'apis'); + this._clientFolderPath = path.join(__dirname, '..', 'clients'); + this._serviceCustomizationsFolderPath = path.join(__dirname, '..', 'lib', 'services'); + this._packageJsonPath = path.join(__dirname, '..', 'package.json'); + this._apiFileNames = null; +} + +ClientCreator.prototype.getAllApiFilenames = function getAllApiFilenames() { + if (this._apiFileNames) { + return this._apiFileNames; + } + var apiFileNames = fs.readdirSync(this._apisFolderPath); + // filter out metadata + this._apiFileNames = apiFileNames.filter(function(name) { + return name !== 'metadata.json'; + }); + return this._apiFileNames; +}; + +ClientCreator.prototype.getAllApiFilenamesForService = function getAllApiFilenamesForService(modelName) { + var serviceRegex = new RegExp('(^' + modelName + '-([\\d]{4}-[\\d]{2}-[\\d]{2})\\.([\\w]+))\\.json$'); + var modelRegex = /(([\d]{4}-[\d]{2}-[\d]{2})\.([\w]+))\.json$/; + + var models = {}; + var versions = {}; + this.getAllApiFilenames().filter(function(name) { + return name.search(serviceRegex) === 0; + }).forEach(function(name) { + var matches = name.match(serviceRegex); + if (!matches) { + return; + } + var model = matches[1]; + var version = matches[2]; + var modelType = matches[3]; + if (!versions.hasOwnProperty(version)) { + versions[version] = {}; + } + var versionInfo = versions[version]; + switch (modelType) { + case 'min': + versionInfo.api = model; + break; + case 'paginators': + versionInfo.paginators = model; + break; + case 'waiters2': + versionInfo.waiters = model; + break; + default: + return; + } + }); + models.versions = versions; + return models; +}; + +ClientCreator.prototype.customizationsExist = function customizationsExist(serviceName) { + var customizationsFolder = this._serviceCustomizationsFolderPath; + return fs.existsSync(path.join(customizationsFolder, serviceName + '.js')); +}; + +ClientCreator.prototype.generateClientFileSource = function generateClientFileSource(serviceMetadata, specifiedVersion) { + var clientFolderPath = this._clientFolderPath; + var className = serviceMetadata.name; + var serviceName = className.toLowerCase(); + var modelName = serviceMetadata.prefix || serviceName; + specifiedVersion = specifiedVersion || '*'; + + // get models for the service + var models = this.getAllApiFilenamesForService(modelName); + + var modelVersions = models && models.versions; + if (!modelVersions) { + throw new Error('Unable to get models for ' + modelName); + } + var obsoleteVersions = serviceMetadata.versions || []; + var versionNumbers = Object.keys(modelVersions); + var tab = ' '; + var code = ''; + code += 'require(\'../lib/node_loader\');\n'; + code += 'var AWS = require(\'../lib/core\');\n'; + code += 'var Service = AWS.Service;\n'; + code += 'var apiLoader = AWS.apiLoader;\n\n'; + code += 'apiLoader.services[\'' + serviceName +'\'] = {};\n'; + code += 'AWS.' + className + ' = Service.defineService(\'' + serviceName + '\', [\'' + [].concat(obsoleteVersions, versionNumbers).sort().join('\', \'') + '\']);\n'; + // pull in service customizations + if (this.customizationsExist(serviceName)) { + code += 'require(\'../lib/services/' + serviceName + '\');\n'; + } + versionNumbers.forEach(function(version) { + // check version + if (specifiedVersion !== '*' && specifiedVersion !== version) { + return; + } + var versionInfo = modelVersions[version]; + if (!versionInfo.hasOwnProperty('api')) { + throw new Error('No API model for ' + serviceName + '-' + version); + } + code += 'Object.defineProperty(apiLoader.services[\'' + serviceName +'\'], \'' + version + '\', {\n'; + code += tab + 'get: function get() {\n'; + code += tab + tab + 'var model = require(\'../apis/' + versionInfo.api + '.json\');\n'; + if (versionInfo.hasOwnProperty('paginators')) { + code += tab + tab + 'model.paginators = require(\'../apis/' + versionInfo.paginators + '.json\').pagination;\n'; + } + if (versionInfo.hasOwnProperty('waiters')) { + code += tab + tab + 'model.waiters = require(\'../apis/' + versionInfo.waiters + '.json\').waiters;\n'; + } + code += tab + tab + 'return model;\n'; + code += tab + '},\n'; + code += tab + 'enumerable: true,\n'; + code += tab + 'configurable: true\n'; + code += '});\n'; + }); + + code += '\n'; + code += 'module.exports = AWS.' + className + ';\n'; + return { + code: code, + path: path.join(clientFolderPath, serviceName + '.js'), + service: serviceName, + }; +}; + +ClientCreator.prototype.tabs = function tabs(count) { + var tab = ''; + for (var i = 0; i < count; i++) { + tab += ' '; + } + return tab; +}; + +ClientCreator.prototype.generateDefinePropertySource = function generateDefinePropertySource(objName, serviceName, className) { + var tabs = this.tabs; + var code = ''; + code += 'var ' + serviceName + ' = null;\n'; + code += 'Object.defineProperty(' + objName + ', \'' + className + '\', {\n'; + code += tabs(1) + 'get: function get() {\n'; + code += tabs(2) + 'return ' + serviceName + ' || require(\'./' + serviceName + '\');\n'; + code += tabs(1) + '},\n'; + code += tabs(1) + 'set: function set(svc) {\n'; + code += tabs(2) + serviceName + ' = svc;\n'; + code += tabs(1) + '},\n'; + code += tabs(1) + 'enumerable: true,\n'; + code += tabs(1) + 'configurable: true\n'; + code += '});\n'; + + return code; +}; + +ClientCreator.prototype.generateAllServicesSource = function generateAllServicesSource(services, fileName) { + var metadata = this._metadata; + var self = this; + var code = ''; + code += 'require(\'../lib/node_loader\');\n'; + code += 'module.exports = {\n'; + + services.forEach(function(service, idx) { + var className = metadata[service].name; + var tab = ' '; + var isLast = idx === services.length - 1; + code += self.tabs(1) + className + ': require(\'./' + service + '\')' + (isLast ? '' : ',') + '\n'; + }); + code += '};'; + return { + code: code, + path: path.join(this._clientFolderPath, fileName + '.js'), + service: fileName + }; +}; + +ClientCreator.prototype.getDefaultServices = function getDefaultServices() { + var metadata = this._metadata; + var services = []; + for (var key in metadata) { + if (!metadata.hasOwnProperty(key)) { + continue; + } + var className = metadata[key].name; + var serviceName = className.toLowerCase(); + services.push(serviceName); + } + return services; +}; + +ClientCreator.prototype.writeClientServices = function writeClientServices() { + var metadata = this._metadata; + var services = []; + var corsServices = []; + for (var key in metadata) { + if (!metadata.hasOwnProperty(key)) { + continue; + } + var clientInfo = this.generateClientFileSource(metadata[key]); + fs.writeFileSync(clientInfo.path, clientInfo.code); + services.push(clientInfo.service); + // check if service supports CORS + if (metadata[key].cors === true) { + corsServices.push(clientInfo.service); + } + } + var allClientInfo = this.generateAllServicesSource(services, 'all'); + fs.writeFileSync(allClientInfo.path, allClientInfo.code); + var browserClientInfo = this.generateAllServicesSource(corsServices, 'browser_default'); + fs.writeFileSync(browserClientInfo.path, browserClientInfo.code); +}; + +module.exports = ClientCreator; diff --git a/node_modules/aws-sdk/dist-tools/create-all-services.js b/node_modules/aws-sdk/dist-tools/create-all-services.js new file mode 100644 index 0000000..fdf00c8 --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/create-all-services.js @@ -0,0 +1,6 @@ +var ClientCreator = require('./client-creator'); + +var cc = new ClientCreator(); + +cc.writeClientServices(); +console.log('Finished updating services.'); diff --git a/node_modules/aws-sdk/dist-tools/service-collector.js b/node_modules/aws-sdk/dist-tools/service-collector.js new file mode 100644 index 0000000..0b09a41 --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/service-collector.js @@ -0,0 +1,168 @@ +var fs = require('fs'); +var util = require('util'); +var path = require('path'); + +var AWS = require('../'); +var apis = require('../lib/api_loader'); +var metadata = require('../apis/metadata'); +var ClientCreator = require('./client-creator'); + +var clientCreator = new ClientCreator(); +var defaultServices = clientCreator.getDefaultServices().join(','); +var sanitizeRegex = /[^a-zA-Z0-9,-]/; + +var serviceClasses = {}; +Object.keys(AWS).forEach(function(name) { + if (AWS[name].serviceIdentifier) { + serviceClasses[AWS[name].serviceIdentifier] = AWS[name]; + } +}); + +function getServiceHeader(service) { + if (service === 'all') { + return Object.keys(serviceClasses).map(function(name) { + return getServiceHeader(name); + }).join('\n'); + } + + if (!serviceClasses[service]) return null; + var versions = serviceClasses[service].apiVersions.map(function(version) { + return version.indexOf('*') >= 0 ? null : version; + }).filter(function(c) { return c !== null; }); + + var file = util.format( + 'if (!Object.prototype.hasOwnProperty.call(AWS, \'' + metadata[service].name + '\')) {\n' + + ' AWS.apiLoader.services[\'%s\'] = {};\n' + + ' AWS.%s = AWS.Service.defineService(\'%s\', %s);\n', + service, metadata[service].name, service, util.inspect(versions)); + var svcPath = path.join(__dirname, '..', 'lib', 'services', service + '.js'); + if (fs.existsSync(svcPath)) { + file += ' require(\'./services/' + service + '\');\n'; + } + file += '}\n'; + + return file; +} + +function getService(service, version) { + if (service === 'all') { + return Object.keys(serviceClasses).map(function(name) { + var out = serviceClasses[name].apiVersions.map(function(svcVersion) { + if (svcVersion.indexOf('*') >= 0) return null; + return getService(name, svcVersion); + }).filter(function(c) { return c !== null; }).join('\n'); + + return out; + }).join('\n'); + } + + var svc, api; + if (!serviceClasses[service]) { + return null; + } + + try { + var ClassName = serviceClasses[service]; + svc = new ClassName({apiVersion: version, endpoint: 'localhost'}); + api = svc.api; + } catch (e) { + return null; + } + + var serviceFileName = metadata[service].prefix || service; + var lines = []; + var line = util.format( + 'AWS.apiLoader.services[\'%s\'][\'%s\'] = %s;\n', + service, svc.api.apiVersion, 'require(\'../apis/' + serviceFileName + '-' + svc.api.apiVersion + '.min\')'); + lines.push(line); + if (Object.prototype.hasOwnProperty.call(api, 'paginators') && Object.keys(api.paginators).length) { + line = util.format( + 'AWS.apiLoader.services[\'%s\'][\'%s\'].paginators = %s;\n', + service, svc.api.apiVersion, 'require(\'../apis/' + serviceFileName + '-' + svc.api.apiVersion + '.paginators\').pagination'); + lines.push(line); + } + if (Object.prototype.hasOwnProperty.call(api, 'waiters') && Object.keys(api.waiters).length) { + line = util.format( + 'AWS.apiLoader.services[\'%s\'][\'%s\'].waiters = %s;\n', + service, svc.api.apiVersion, 'require(\'../apis/' + serviceFileName + '-' + svc.api.apiVersion + '.waiters2\').waiters'); + lines.push(line); + } + return lines.join(''); +} + +function ServiceCollector(services) { + var builtServices = {}; + + function buildService(name, usingDefaultServices) { + var match = name.match(/^(.+?)(?:-(.+?))?$/); + var service = match[1], version = match[2] || 'latest'; + var contents = []; + var lines, err; + + if (!builtServices[service]) { + builtServices[service] = {}; + + lines = getServiceHeader(service); + if (lines === null) { + if (!usingDefaultServices) { + err = new Error('Invalid module: ' + service); + err.name = 'InvalidModuleError'; + throw err; + } + } else { + contents.push(lines); + } + } + + if (!builtServices[service][version]) { + builtServices[service][version] = true; + + lines = getService(service, version); + if (lines === null) { + if (!usingDefaultServices) { + err = new Error('Invalid module: ' + service + '-' + version); + err.name = 'InvalidModuleError'; + throw err; + } + } else { + contents.push(lines); + } + } + + return contents.join(''); + } + + var serviceCode = ''; + var usingDefaultServicesToggle = false; + if (!services) { + usingDefaultServicesToggle = true; + services = defaultServices; + } + if (services.match(sanitizeRegex)) { + throw new Error('Incorrectly formatted service names'); + } + + var invalidModules = []; + var stsIncluded = false; + services.split(',').sort().forEach(function(name) { + if (name.match(/^sts\b/) || name === 'all') stsIncluded = true; + try { + serviceCode += buildService(name, usingDefaultServicesToggle) + '\n'; + } catch (e) { + if (e.name === 'InvalidModuleError') invalidModules.push(name); + else throw e; + } + }); + + if (!stsIncluded) { + serviceCode += buildService('sts') + '\n'; + } + + if (invalidModules.length > 0) { + throw new Error('Missing modules: ' + invalidModules.join(', ')); + } + + return serviceCode; +} + +module.exports = ServiceCollector; diff --git a/node_modules/aws-sdk/dist-tools/transform.js b/node_modules/aws-sdk/dist-tools/transform.js new file mode 100644 index 0000000..ff7d2fc --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/transform.js @@ -0,0 +1,43 @@ +var Transform = require('stream').Transform; +var collector = require('./service-collector'); +var license = require('./browser-builder').license; + +module.exports = function(file) { + var stream = new Transform(); + + var didDefineServices = !!process.env.AWS_SERVICES; + + var isEntryPoint = !!file.match(/[\/\\]lib[\/\\]browser\.js$/); + + stream._transform = function(data, encoding, callback) { + callback(null, data); + }; + + if (isEntryPoint) { + if (didDefineServices) { + // We need to strip out the default requires statement + stream._transform = function(data, encoding, callback) { + var code = data.toString(); + code = code.trim(); + var lines = code.split('\n'); + lines = lines.filter(function(line) { + return !line.match(/^require\(.+browser_default['"]\);$/); + }); + + code = lines.join('\n'); + data = new Buffer(code); + callback(null, data); + }; + + var src = collector(process.env.AWS_SERVICES); + stream._flush = function(callback) { + stream.push(src); + callback(); + }; + } + + stream.push(license); + } + + return stream; +}; diff --git a/node_modules/aws-sdk/dist-tools/webpack.config.rn-core.js b/node_modules/aws-sdk/dist-tools/webpack.config.rn-core.js new file mode 100644 index 0000000..8184257 --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/webpack.config.rn-core.js @@ -0,0 +1,32 @@ +// import path for resolving file paths +var path = require('path'); +module.exports = { + // Specify the entry point for our app. + entry: [ + path.join(__dirname, '..', 'lib', 'core.js'), + ], + // Specify the output file containing our bundled code + output: { + path: path.join(__dirname, '..', 'dist'), + filename: 'aws-sdk-core-react-native.js', + libraryTarget: 'umd', + library: 'AWS' + }, + resolve: {}, + module: { + /** + * Tell webpack how to load 'json' files. + * By default, webpack only knows how to handle + * JavaScript files. + * When webpack comes across a 'require()' statement + * where a json file is being imported, it will use + * the json-loader. + */ + loaders: [ + { + test: /\.json$/, + loaders: ['json'] + } + ] + } +}; diff --git a/node_modules/aws-sdk/dist-tools/webpack.config.rn-dep.js b/node_modules/aws-sdk/dist-tools/webpack.config.rn-dep.js new file mode 100644 index 0000000..ed6057d --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/webpack.config.rn-dep.js @@ -0,0 +1,31 @@ +// import path for resolving file paths +var path = require('path'); +module.exports = { + // Specify the entry point for our app. + entry: [ + 'xml2js' + ], + // Specify the output file containing our bundled code + output: { + path: path.join(__dirname, '..', 'dist'), + filename: 'xml2js.js', + libraryTarget: 'commonjs2', + }, + resolve: {}, + module: { + /** + * Tell webpack how to load 'json' files. + * By default, webpack only knows how to handle + * JavaScript files. + * When webpack comes across a 'require()' statement + * where a json file is being imported, it will use + * the json-loader. + */ + loaders: [ + { + test: /\.json$/, + loaders: ['json'] + } + ] + } +}; diff --git a/node_modules/aws-sdk/dist-tools/webpack.config.rn.js b/node_modules/aws-sdk/dist-tools/webpack.config.rn.js new file mode 100644 index 0000000..605ec80 --- /dev/null +++ b/node_modules/aws-sdk/dist-tools/webpack.config.rn.js @@ -0,0 +1,34 @@ +// import path for resolving file paths +var path = require('path'); +module.exports = { + // Specify the entry point for our app. + entry: [ + path.join(__dirname, '..', 'react-native.js') + ], + // Specify the output file containing our bundled code + output: { + path: path.join(__dirname, '..', 'dist'), + filename: 'aws-sdk-react-native.js', + libraryTarget: 'umd', + library: 'AWS' + }, + resolve: { + packageAlias: 'react-native' + }, + module: { + /** + * Tell webpack how to load 'json' files. + * By default, webpack only knows how to handle + * JavaScript files. + * When webpack comes across a 'require()' statement + * where a json file is being imported, it will use + * the json-loader. + */ + loaders: [ + { + test: /\.json$/, + loaders: ['json'] + } + ] + } +}; diff --git a/node_modules/aws-sdk/dist/BUNDLE_LICENSE.txt b/node_modules/aws-sdk/dist/BUNDLE_LICENSE.txt new file mode 100644 index 0000000..59783ab --- /dev/null +++ b/node_modules/aws-sdk/dist/BUNDLE_LICENSE.txt @@ -0,0 +1,96 @@ +The bundled package of the AWS SDK for JavaScript is available under the +Apache License, Version 2.0: + + Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"). You + may not use this file except in compliance with the License. A copy of + the License is located at + + http://aws.amazon.com/apache2.0/ + + or in the "license" file accompanying this file. This file is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF + ANY KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. + +This product bundles browserify, which is available under a +"3-clause BSD" license: + + Copyright Joyent, Inc. and other Node contributors. + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to permit + persons to whom the Software is furnished to do so, subject to the + following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN + NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR + OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE + USE OR OTHER DEALINGS IN THE SOFTWARE. + +This product bundles crypto-browserify, which is available under +the MIT license: + + Copyright (c) 2013 Dominic Tarr + + Permission is hereby granted, free of charge, + to any person obtaining a copy of this software and + associated documentation files (the "Software"), to + deal in the Software without restriction, including + without limitation the rights to use, copy, modify, + merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom + the Software is furnished to do so, + subject to the following conditions: + + The above copyright notice and this permission notice + shall be included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR + ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +This product bundles MD5, SHA-1, and SHA-256 hashing algorithm components, +which are available under a BSD license: + + Copyright (c) 1998 - 2009, Paul Johnston & Contributors + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + Redistributions of source code must retain the above copyrightnotice, + this list of conditions and the following disclaimer. Redistributions + in binary form must reproduce the above copyright notice, this list of + conditions and the following disclaimer in the documentation and/or + other materials provided with the distribution. + + Neither the name of the author nor the names of its contributors may + be used to endorse or promote products derived from this software + without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. diff --git a/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js b/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js new file mode 100644 index 0000000..6dcb19d --- /dev/null +++ b/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js @@ -0,0 +1,11945 @@ +(function webpackUniversalModuleDefinition(root, factory) { + if(typeof exports === 'object' && typeof module === 'object') + module.exports = factory(); + else if(typeof define === 'function' && define.amd) + define([], factory); + else if(typeof exports === 'object') + exports["AWS"] = factory(); + else + root["AWS"] = factory(); +})(this, function() { +return /******/ (function(modules) { // webpackBootstrap +/******/ // The module cache +/******/ var installedModules = {}; + +/******/ // The require function +/******/ function __webpack_require__(moduleId) { + +/******/ // Check if module is in cache +/******/ if(installedModules[moduleId]) +/******/ return installedModules[moduleId].exports; + +/******/ // Create a new module (and put it into the cache) +/******/ var module = installedModules[moduleId] = { +/******/ exports: {}, +/******/ id: moduleId, +/******/ loaded: false +/******/ }; + +/******/ // Execute the module function +/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); + +/******/ // Flag the module as loaded +/******/ module.loaded = true; + +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } + + +/******/ // expose the modules object (__webpack_modules__) +/******/ __webpack_require__.m = modules; + +/******/ // expose the module cache +/******/ __webpack_require__.c = installedModules; + +/******/ // __webpack_public_path__ +/******/ __webpack_require__.p = ""; + +/******/ // Load entry module and return exports +/******/ return __webpack_require__(0); +/******/ }) +/************************************************************************/ +/******/ ([ +/* 0 */ +/***/ (function(module, exports, __webpack_require__) { + + module.exports = __webpack_require__(1); + + +/***/ }), +/* 1 */ +/***/ (function(module, exports, __webpack_require__) { + + /** + * The main AWS namespace + */ + var AWS = { util: __webpack_require__(2) }; + + /** + * @api private + * @!macro [new] nobrowser + * @note This feature is not supported in the browser environment of the SDK. + */ + var _hidden = {}; _hidden.toString(); // hack to parse macro + + /** + * @api private + */ + module.exports = AWS; + + AWS.util.update(AWS, { + + /** + * @constant + */ + VERSION: '2.451.0', + + /** + * @api private + */ + Signers: {}, + + /** + * @api private + */ + Protocol: { + Json: __webpack_require__(13), + Query: __webpack_require__(17), + Rest: __webpack_require__(21), + RestJson: __webpack_require__(22), + RestXml: __webpack_require__(23) + }, + + /** + * @api private + */ + XML: { + Builder: __webpack_require__(24), + Parser: null // conditionally set based on environment + }, + + /** + * @api private + */ + JSON: { + Builder: __webpack_require__(14), + Parser: __webpack_require__(15) + }, + + /** + * @api private + */ + Model: { + Api: __webpack_require__(29), + Operation: __webpack_require__(30), + Shape: __webpack_require__(19), + Paginator: __webpack_require__(31), + ResourceWaiter: __webpack_require__(32) + }, + + /** + * @api private + */ + apiLoader: __webpack_require__(33), + + /** + * @api private + */ + EndpointCache: __webpack_require__(34).EndpointCache + }); + __webpack_require__(36); + __webpack_require__(37); + __webpack_require__(40); + __webpack_require__(43); + __webpack_require__(44); + __webpack_require__(49); + __webpack_require__(52); + __webpack_require__(53); + __webpack_require__(54); + __webpack_require__(62); + + /** + * @readonly + * @return [AWS.SequentialExecutor] a collection of global event listeners that + * are attached to every sent request. + * @see AWS.Request AWS.Request for a list of events to listen for + * @example Logging the time taken to send a request + * AWS.events.on('send', function startSend(resp) { + * resp.startTime = new Date().getTime(); + * }).on('complete', function calculateTime(resp) { + * var time = (new Date().getTime() - resp.startTime) / 1000; + * console.log('Request took ' + time + ' seconds'); + * }); + * + * new AWS.S3().listBuckets(); // prints 'Request took 0.285 seconds' + */ + AWS.events = new AWS.SequentialExecutor(); + + //create endpoint cache lazily + AWS.util.memoizedProperty(AWS, 'endpointCache', function() { + return new AWS.EndpointCache(AWS.config.endpointCacheSize); + }, true); + + +/***/ }), +/* 2 */ +/***/ (function(module, exports, __webpack_require__) { + + /* WEBPACK VAR INJECTION */(function(process, setImmediate) {/* eslint guard-for-in:0 */ + var AWS; + + /** + * A set of utility methods for use with the AWS SDK. + * + * @!attribute abort + * Return this value from an iterator function {each} or {arrayEach} + * to break out of the iteration. + * @example Breaking out of an iterator function + * AWS.util.each({a: 1, b: 2, c: 3}, function(key, value) { + * if (key == 'b') return AWS.util.abort; + * }); + * @see each + * @see arrayEach + * @api private + */ + var util = { + environment: 'nodejs', + engine: function engine() { + if (util.isBrowser() && typeof navigator !== 'undefined') { + return navigator.userAgent; + } else { + var engine = process.platform + '/' + process.version; + if (process.env.AWS_EXECUTION_ENV) { + engine += ' exec-env/' + process.env.AWS_EXECUTION_ENV; + } + return engine; + } + }, + + userAgent: function userAgent() { + var name = util.environment; + var agent = 'aws-sdk-' + name + '/' + __webpack_require__(1).VERSION; + if (name === 'nodejs') agent += ' ' + util.engine(); + return agent; + }, + + uriEscape: function uriEscape(string) { + var output = encodeURIComponent(string); + output = output.replace(/[^A-Za-z0-9_.~\-%]+/g, escape); + + // AWS percent-encodes some extra non-standard characters in a URI + output = output.replace(/[*]/g, function(ch) { + return '%' + ch.charCodeAt(0).toString(16).toUpperCase(); + }); + + return output; + }, + + uriEscapePath: function uriEscapePath(string) { + var parts = []; + util.arrayEach(string.split('/'), function (part) { + parts.push(util.uriEscape(part)); + }); + return parts.join('/'); + }, + + urlParse: function urlParse(url) { + return util.url.parse(url); + }, + + urlFormat: function urlFormat(url) { + return util.url.format(url); + }, + + queryStringParse: function queryStringParse(qs) { + return util.querystring.parse(qs); + }, + + queryParamsToString: function queryParamsToString(params) { + var items = []; + var escape = util.uriEscape; + var sortedKeys = Object.keys(params).sort(); + + util.arrayEach(sortedKeys, function(name) { + var value = params[name]; + var ename = escape(name); + var result = ename + '='; + if (Array.isArray(value)) { + var vals = []; + util.arrayEach(value, function(item) { vals.push(escape(item)); }); + result = ename + '=' + vals.sort().join('&' + ename + '='); + } else if (value !== undefined && value !== null) { + result = ename + '=' + escape(value); + } + items.push(result); + }); + + return items.join('&'); + }, + + readFileSync: function readFileSync(path) { + if (util.isBrowser()) return null; + return __webpack_require__(6).readFileSync(path, 'utf-8'); + }, + + base64: { + encode: function encode64(string) { + if (typeof string === 'number') { + throw util.error(new Error('Cannot base64 encode number ' + string)); + } + if (string === null || typeof string === 'undefined') { + return string; + } + var buf = (typeof util.Buffer.from === 'function' && util.Buffer.from !== Uint8Array.from) ? util.Buffer.from(string) : new util.Buffer(string); + return buf.toString('base64'); + }, + + decode: function decode64(string) { + if (typeof string === 'number') { + throw util.error(new Error('Cannot base64 decode number ' + string)); + } + if (string === null || typeof string === 'undefined') { + return string; + } + return (typeof util.Buffer.from === 'function' && util.Buffer.from !== Uint8Array.from) ? util.Buffer.from(string, 'base64') : new util.Buffer(string, 'base64'); + } + + }, + + buffer: { + toStream: function toStream(buffer) { + if (!util.Buffer.isBuffer(buffer)) buffer = new util.Buffer(buffer); + + var readable = new (util.stream.Readable)(); + var pos = 0; + readable._read = function(size) { + if (pos >= buffer.length) return readable.push(null); + + var end = pos + size; + if (end > buffer.length) end = buffer.length; + readable.push(buffer.slice(pos, end)); + pos = end; + }; + + return readable; + }, + + /** + * Concatenates a list of Buffer objects. + */ + concat: function(buffers) { + var length = 0, + offset = 0, + buffer = null, i; + + for (i = 0; i < buffers.length; i++) { + length += buffers[i].length; + } + + buffer = new util.Buffer(length); + + for (i = 0; i < buffers.length; i++) { + buffers[i].copy(buffer, offset); + offset += buffers[i].length; + } + + return buffer; + } + }, + + string: { + byteLength: function byteLength(string) { + if (string === null || string === undefined) return 0; + if (typeof string === 'string') string = new util.Buffer(string); + + if (typeof string.byteLength === 'number') { + return string.byteLength; + } else if (typeof string.length === 'number') { + return string.length; + } else if (typeof string.size === 'number') { + return string.size; + } else if (typeof string.path === 'string') { + return __webpack_require__(6).lstatSync(string.path).size; + } else { + throw util.error(new Error('Cannot determine length of ' + string), + { object: string }); + } + }, + + upperFirst: function upperFirst(string) { + return string[0].toUpperCase() + string.substr(1); + }, + + lowerFirst: function lowerFirst(string) { + return string[0].toLowerCase() + string.substr(1); + } + }, + + ini: { + parse: function string(ini) { + var currentSection, map = {}; + util.arrayEach(ini.split(/\r?\n/), function(line) { + line = line.split(/(^|\s)[;#]/)[0]; // remove comments + var section = line.match(/^\s*\[([^\[\]]+)\]\s*$/); + if (section) { + currentSection = section[1]; + } else if (currentSection) { + var item = line.match(/^\s*(.+?)\s*=\s*(.+?)\s*$/); + if (item) { + map[currentSection] = map[currentSection] || {}; + map[currentSection][item[1]] = item[2]; + } + } + }); + + return map; + } + }, + + fn: { + noop: function() {}, + callback: function (err) { if (err) throw err; }, + + /** + * Turn a synchronous function into as "async" function by making it call + * a callback. The underlying function is called with all but the last argument, + * which is treated as the callback. The callback is passed passed a first argument + * of null on success to mimick standard node callbacks. + */ + makeAsync: function makeAsync(fn, expectedArgs) { + if (expectedArgs && expectedArgs <= fn.length) { + return fn; + } + + return function() { + var args = Array.prototype.slice.call(arguments, 0); + var callback = args.pop(); + var result = fn.apply(null, args); + callback(result); + }; + } + }, + + /** + * Date and time utility functions. + */ + date: { + + /** + * @return [Date] the current JavaScript date object. Since all + * AWS services rely on this date object, you can override + * this function to provide a special time value to AWS service + * requests. + */ + getDate: function getDate() { + if (!AWS) AWS = __webpack_require__(1); + if (AWS.config.systemClockOffset) { // use offset when non-zero + return new Date(new Date().getTime() + AWS.config.systemClockOffset); + } else { + return new Date(); + } + }, + + /** + * @return [String] the date in ISO-8601 format + */ + iso8601: function iso8601(date) { + if (date === undefined) { date = util.date.getDate(); } + return date.toISOString().replace(/\.\d{3}Z$/, 'Z'); + }, + + /** + * @return [String] the date in RFC 822 format + */ + rfc822: function rfc822(date) { + if (date === undefined) { date = util.date.getDate(); } + return date.toUTCString(); + }, + + /** + * @return [Integer] the UNIX timestamp value for the current time + */ + unixTimestamp: function unixTimestamp(date) { + if (date === undefined) { date = util.date.getDate(); } + return date.getTime() / 1000; + }, + + /** + * @param [String,number,Date] date + * @return [Date] + */ + from: function format(date) { + if (typeof date === 'number') { + return new Date(date * 1000); // unix timestamp + } else { + return new Date(date); + } + }, + + /** + * Given a Date or date-like value, this function formats the + * date into a string of the requested value. + * @param [String,number,Date] date + * @param [String] formatter Valid formats are: + # * 'iso8601' + # * 'rfc822' + # * 'unixTimestamp' + * @return [String] + */ + format: function format(date, formatter) { + if (!formatter) formatter = 'iso8601'; + return util.date[formatter](util.date.from(date)); + }, + + parseTimestamp: function parseTimestamp(value) { + if (typeof value === 'number') { // unix timestamp (number) + return new Date(value * 1000); + } else if (value.match(/^\d+$/)) { // unix timestamp + return new Date(value * 1000); + } else if (value.match(/^\d{4}/)) { // iso8601 + return new Date(value); + } else if (value.match(/^\w{3},/)) { // rfc822 + return new Date(value); + } else { + throw util.error( + new Error('unhandled timestamp format: ' + value), + {code: 'TimestampParserError'}); + } + } + + }, + + crypto: { + crc32Table: [ + 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, + 0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4, + 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, + 0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, + 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856, + 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, + 0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4, + 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, + 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, + 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC, 0x51DE003A, + 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, + 0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, + 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, 0x76DC4190, + 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, + 0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E, + 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, + 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, + 0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950, + 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, + 0xFBD44C65, 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, + 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A, + 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, + 0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010, + 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, + 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, + 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6, + 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, + 0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, + 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344, + 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, + 0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, + 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, + 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, + 0xA6BC5767, 0x3FB506DD, 0x48B2364B, 0xD80D2BDA, 0xAF0A1B4C, + 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, + 0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, + 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE, + 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, + 0x2CD99E8B, 0x5BDEAE1D, 0x9B64C2B0, 0xEC63F226, 0x756AA39C, + 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, + 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, + 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242, + 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, + 0x18B74777, 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, + 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278, + 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, + 0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, + 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, + 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, + 0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8, + 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, + 0x2D02EF8D], + + crc32: function crc32(data) { + var tbl = util.crypto.crc32Table; + var crc = 0 ^ -1; + + if (typeof data === 'string') { + data = new util.Buffer(data); + } + + for (var i = 0; i < data.length; i++) { + var code = data.readUInt8(i); + crc = (crc >>> 8) ^ tbl[(crc ^ code) & 0xFF]; + } + return (crc ^ -1) >>> 0; + }, + + hmac: function hmac(key, string, digest, fn) { + if (!digest) digest = 'binary'; + if (digest === 'buffer') { digest = undefined; } + if (!fn) fn = 'sha256'; + if (typeof string === 'string') string = new util.Buffer(string); + return util.crypto.lib.createHmac(fn, key).update(string).digest(digest); + }, + + md5: function md5(data, digest, callback) { + return util.crypto.hash('md5', data, digest, callback); + }, + + sha256: function sha256(data, digest, callback) { + return util.crypto.hash('sha256', data, digest, callback); + }, + + hash: function(algorithm, data, digest, callback) { + var hash = util.crypto.createHash(algorithm); + if (!digest) { digest = 'binary'; } + if (digest === 'buffer') { digest = undefined; } + if (typeof data === 'string') data = new util.Buffer(data); + var sliceFn = util.arraySliceFn(data); + var isBuffer = util.Buffer.isBuffer(data); + //Identifying objects with an ArrayBuffer as buffers + if (util.isBrowser() && typeof ArrayBuffer !== 'undefined' && data && data.buffer instanceof ArrayBuffer) isBuffer = true; + + if (callback && typeof data === 'object' && + typeof data.on === 'function' && !isBuffer) { + data.on('data', function(chunk) { hash.update(chunk); }); + data.on('error', function(err) { callback(err); }); + data.on('end', function() { callback(null, hash.digest(digest)); }); + } else if (callback && sliceFn && !isBuffer && + typeof FileReader !== 'undefined') { + // this might be a File/Blob + var index = 0, size = 1024 * 512; + var reader = new FileReader(); + reader.onerror = function() { + callback(new Error('Failed to read data.')); + }; + reader.onload = function() { + var buf = new util.Buffer(new Uint8Array(reader.result)); + hash.update(buf); + index += buf.length; + reader._continueReading(); + }; + reader._continueReading = function() { + if (index >= data.size) { + callback(null, hash.digest(digest)); + return; + } + + var back = index + size; + if (back > data.size) back = data.size; + reader.readAsArrayBuffer(sliceFn.call(data, index, back)); + }; + + reader._continueReading(); + } else { + if (util.isBrowser() && typeof data === 'object' && !isBuffer) { + data = new util.Buffer(new Uint8Array(data)); + } + var out = hash.update(data).digest(digest); + if (callback) callback(null, out); + return out; + } + }, + + toHex: function toHex(data) { + var out = []; + for (var i = 0; i < data.length; i++) { + out.push(('0' + data.charCodeAt(i).toString(16)).substr(-2, 2)); + } + return out.join(''); + }, + + createHash: function createHash(algorithm) { + return util.crypto.lib.createHash(algorithm); + } + + }, + + /** @!ignore */ + + /* Abort constant */ + abort: {}, + + each: function each(object, iterFunction) { + for (var key in object) { + if (Object.prototype.hasOwnProperty.call(object, key)) { + var ret = iterFunction.call(this, key, object[key]); + if (ret === util.abort) break; + } + } + }, + + arrayEach: function arrayEach(array, iterFunction) { + for (var idx in array) { + if (Object.prototype.hasOwnProperty.call(array, idx)) { + var ret = iterFunction.call(this, array[idx], parseInt(idx, 10)); + if (ret === util.abort) break; + } + } + }, + + update: function update(obj1, obj2) { + util.each(obj2, function iterator(key, item) { + obj1[key] = item; + }); + return obj1; + }, + + merge: function merge(obj1, obj2) { + return util.update(util.copy(obj1), obj2); + }, + + copy: function copy(object) { + if (object === null || object === undefined) return object; + var dupe = {}; + // jshint forin:false + for (var key in object) { + dupe[key] = object[key]; + } + return dupe; + }, + + isEmpty: function isEmpty(obj) { + for (var prop in obj) { + if (Object.prototype.hasOwnProperty.call(obj, prop)) { + return false; + } + } + return true; + }, + + arraySliceFn: function arraySliceFn(obj) { + var fn = obj.slice || obj.webkitSlice || obj.mozSlice; + return typeof fn === 'function' ? fn : null; + }, + + isType: function isType(obj, type) { + // handle cross-"frame" objects + if (typeof type === 'function') type = util.typeName(type); + return Object.prototype.toString.call(obj) === '[object ' + type + ']'; + }, + + typeName: function typeName(type) { + if (Object.prototype.hasOwnProperty.call(type, 'name')) return type.name; + var str = type.toString(); + var match = str.match(/^\s*function (.+)\(/); + return match ? match[1] : str; + }, + + error: function error(err, options) { + var originalError = null; + if (typeof err.message === 'string' && err.message !== '') { + if (typeof options === 'string' || (options && options.message)) { + originalError = util.copy(err); + originalError.message = err.message; + } + } + err.message = err.message || null; + + if (typeof options === 'string') { + err.message = options; + } else if (typeof options === 'object' && options !== null) { + util.update(err, options); + if (options.message) + err.message = options.message; + if (options.code || options.name) + err.code = options.code || options.name; + if (options.stack) + err.stack = options.stack; + } + + if (typeof Object.defineProperty === 'function') { + Object.defineProperty(err, 'name', {writable: true, enumerable: false}); + Object.defineProperty(err, 'message', {enumerable: true}); + } + + err.name = options && options.name || err.name || err.code || 'Error'; + err.time = new Date(); + + if (originalError) err.originalError = originalError; + + return err; + }, + + /** + * @api private + */ + inherit: function inherit(klass, features) { + var newObject = null; + if (features === undefined) { + features = klass; + klass = Object; + newObject = {}; + } else { + var ctor = function ConstructorWrapper() {}; + ctor.prototype = klass.prototype; + newObject = new ctor(); + } + + // constructor not supplied, create pass-through ctor + if (features.constructor === Object) { + features.constructor = function() { + if (klass !== Object) { + return klass.apply(this, arguments); + } + }; + } + + features.constructor.prototype = newObject; + util.update(features.constructor.prototype, features); + features.constructor.__super__ = klass; + return features.constructor; + }, + + /** + * @api private + */ + mixin: function mixin() { + var klass = arguments[0]; + for (var i = 1; i < arguments.length; i++) { + // jshint forin:false + for (var prop in arguments[i].prototype) { + var fn = arguments[i].prototype[prop]; + if (prop !== 'constructor') { + klass.prototype[prop] = fn; + } + } + } + return klass; + }, + + /** + * @api private + */ + hideProperties: function hideProperties(obj, props) { + if (typeof Object.defineProperty !== 'function') return; + + util.arrayEach(props, function (key) { + Object.defineProperty(obj, key, { + enumerable: false, writable: true, configurable: true }); + }); + }, + + /** + * @api private + */ + property: function property(obj, name, value, enumerable, isValue) { + var opts = { + configurable: true, + enumerable: enumerable !== undefined ? enumerable : true + }; + if (typeof value === 'function' && !isValue) { + opts.get = value; + } + else { + opts.value = value; opts.writable = true; + } + + Object.defineProperty(obj, name, opts); + }, + + /** + * @api private + */ + memoizedProperty: function memoizedProperty(obj, name, get, enumerable) { + var cachedValue = null; + + // build enumerable attribute for each value with lazy accessor. + util.property(obj, name, function() { + if (cachedValue === null) { + cachedValue = get(); + } + return cachedValue; + }, enumerable); + }, + + /** + * TODO Remove in major version revision + * This backfill populates response data without the + * top-level payload name. + * + * @api private + */ + hoistPayloadMember: function hoistPayloadMember(resp) { + var req = resp.request; + var operationName = req.operation; + var operation = req.service.api.operations[operationName]; + var output = operation.output; + if (output.payload && !operation.hasEventOutput) { + var payloadMember = output.members[output.payload]; + var responsePayload = resp.data[output.payload]; + if (payloadMember.type === 'structure') { + util.each(responsePayload, function(key, value) { + util.property(resp.data, key, value, false); + }); + } + } + }, + + /** + * Compute SHA-256 checksums of streams + * + * @api private + */ + computeSha256: function computeSha256(body, done) { + if (util.isNode()) { + var Stream = util.stream.Stream; + var fs = __webpack_require__(6); + if (typeof Stream === 'function' && body instanceof Stream) { + if (typeof body.path === 'string') { // assume file object + var settings = {}; + if (typeof body.start === 'number') { + settings.start = body.start; + } + if (typeof body.end === 'number') { + settings.end = body.end; + } + body = fs.createReadStream(body.path, settings); + } else { // TODO support other stream types + return done(new Error('Non-file stream objects are ' + + 'not supported with SigV4')); + } + } + } + + util.crypto.sha256(body, 'hex', function(err, sha) { + if (err) done(err); + else done(null, sha); + }); + }, + + /** + * @api private + */ + isClockSkewed: function isClockSkewed(serverTime) { + if (serverTime) { + util.property(AWS.config, 'isClockSkewed', + Math.abs(new Date().getTime() - serverTime) >= 300000, false); + return AWS.config.isClockSkewed; + } + }, + + applyClockOffset: function applyClockOffset(serverTime) { + if (serverTime) + AWS.config.systemClockOffset = serverTime - new Date().getTime(); + }, + + /** + * @api private + */ + extractRequestId: function extractRequestId(resp) { + var requestId = resp.httpResponse.headers['x-amz-request-id'] || + resp.httpResponse.headers['x-amzn-requestid']; + + if (!requestId && resp.data && resp.data.ResponseMetadata) { + requestId = resp.data.ResponseMetadata.RequestId; + } + + if (requestId) { + resp.requestId = requestId; + } + + if (resp.error) { + resp.error.requestId = requestId; + } + }, + + /** + * @api private + */ + addPromises: function addPromises(constructors, PromiseDependency) { + var deletePromises = false; + if (PromiseDependency === undefined && AWS && AWS.config) { + PromiseDependency = AWS.config.getPromisesDependency(); + } + if (PromiseDependency === undefined && typeof Promise !== 'undefined') { + PromiseDependency = Promise; + } + if (typeof PromiseDependency !== 'function') deletePromises = true; + if (!Array.isArray(constructors)) constructors = [constructors]; + + for (var ind = 0; ind < constructors.length; ind++) { + var constructor = constructors[ind]; + if (deletePromises) { + if (constructor.deletePromisesFromClass) { + constructor.deletePromisesFromClass(); + } + } else if (constructor.addPromisesToClass) { + constructor.addPromisesToClass(PromiseDependency); + } + } + }, + + /** + * @api private + */ + promisifyMethod: function promisifyMethod(methodName, PromiseDependency) { + return function promise() { + var self = this; + return new PromiseDependency(function(resolve, reject) { + self[methodName](function(err, data) { + if (err) { + reject(err); + } else { + resolve(data); + } + }); + }); + }; + }, + + /** + * @api private + */ + isDualstackAvailable: function isDualstackAvailable(service) { + if (!service) return false; + var metadata = __webpack_require__(7); + if (typeof service !== 'string') service = service.serviceIdentifier; + if (typeof service !== 'string' || !metadata.hasOwnProperty(service)) return false; + return !!metadata[service].dualstackAvailable; + }, + + /** + * @api private + */ + calculateRetryDelay: function calculateRetryDelay(retryCount, retryDelayOptions) { + if (!retryDelayOptions) retryDelayOptions = {}; + var customBackoff = retryDelayOptions.customBackoff || null; + if (typeof customBackoff === 'function') { + return customBackoff(retryCount); + } + var base = typeof retryDelayOptions.base === 'number' ? retryDelayOptions.base : 100; + var delay = Math.random() * (Math.pow(2, retryCount) * base); + return delay; + }, + + /** + * @api private + */ + handleRequestWithRetries: function handleRequestWithRetries(httpRequest, options, cb) { + if (!options) options = {}; + var http = AWS.HttpClient.getInstance(); + var httpOptions = options.httpOptions || {}; + var retryCount = 0; + + var errCallback = function(err) { + var maxRetries = options.maxRetries || 0; + if (err && err.code === 'TimeoutError') err.retryable = true; + if (err && err.retryable && retryCount < maxRetries) { + retryCount++; + var delay = util.calculateRetryDelay(retryCount, options.retryDelayOptions); + setTimeout(sendRequest, delay + (err.retryAfter || 0)); + } else { + cb(err); + } + }; + + var sendRequest = function() { + var data = ''; + http.handleRequest(httpRequest, httpOptions, function(httpResponse) { + httpResponse.on('data', function(chunk) { data += chunk.toString(); }); + httpResponse.on('end', function() { + var statusCode = httpResponse.statusCode; + if (statusCode < 300) { + cb(null, data); + } else { + var retryAfter = parseInt(httpResponse.headers['retry-after'], 10) * 1000 || 0; + var err = util.error(new Error(), + { retryable: statusCode >= 500 || statusCode === 429 } + ); + if (retryAfter && err.retryable) err.retryAfter = retryAfter; + errCallback(err); + } + }); + }, errCallback); + }; + + AWS.util.defer(sendRequest); + }, + + /** + * @api private + */ + uuid: { + v4: function uuidV4() { + return __webpack_require__(8).v4(); + } + }, + + /** + * @api private + */ + convertPayloadToString: function convertPayloadToString(resp) { + var req = resp.request; + var operation = req.operation; + var rules = req.service.api.operations[operation].output || {}; + if (rules.payload && resp.data[rules.payload]) { + resp.data[rules.payload] = resp.data[rules.payload].toString(); + } + }, + + /** + * @api private + */ + defer: function defer(callback) { + if (typeof process === 'object' && typeof process.nextTick === 'function') { + process.nextTick(callback); + } else if (typeof setImmediate === 'function') { + setImmediate(callback); + } else { + setTimeout(callback, 0); + } + }, + + /** + * @api private + */ + defaultProfile: 'default', + + /** + * @api private + */ + configOptInEnv: 'AWS_SDK_LOAD_CONFIG', + + /** + * @api private + */ + sharedCredentialsFileEnv: 'AWS_SHARED_CREDENTIALS_FILE', + + /** + * @api private + */ + sharedConfigFileEnv: 'AWS_CONFIG_FILE', + + /** + * @api private + */ + imdsDisabledEnv: 'AWS_EC2_METADATA_DISABLED' + }; + + /** + * @api private + */ + module.exports = util; + + /* WEBPACK VAR INJECTION */}.call(exports, __webpack_require__(3), __webpack_require__(4).setImmediate)) + +/***/ }), +/* 3 */ +/***/ (function(module, exports) { + + // shim for using process in browser + var process = module.exports = {}; + + // cached from whatever global is present so that test runners that stub it + // don't break things. But we need to wrap it in a try catch in case it is + // wrapped in strict mode code which doesn't define any globals. It's inside a + // function because try/catches deoptimize in certain engines. + + var cachedSetTimeout; + var cachedClearTimeout; + + function defaultSetTimout() { + throw new Error('setTimeout has not been defined'); + } + function defaultClearTimeout () { + throw new Error('clearTimeout has not been defined'); + } + (function () { + try { + if (typeof setTimeout === 'function') { + cachedSetTimeout = setTimeout; + } else { + cachedSetTimeout = defaultSetTimout; + } + } catch (e) { + cachedSetTimeout = defaultSetTimout; + } + try { + if (typeof clearTimeout === 'function') { + cachedClearTimeout = clearTimeout; + } else { + cachedClearTimeout = defaultClearTimeout; + } + } catch (e) { + cachedClearTimeout = defaultClearTimeout; + } + } ()) + function runTimeout(fun) { + if (cachedSetTimeout === setTimeout) { + //normal enviroments in sane situations + return setTimeout(fun, 0); + } + // if setTimeout wasn't available but was latter defined + if ((cachedSetTimeout === defaultSetTimout || !cachedSetTimeout) && setTimeout) { + cachedSetTimeout = setTimeout; + return setTimeout(fun, 0); + } + try { + // when when somebody has screwed with setTimeout but no I.E. maddness + return cachedSetTimeout(fun, 0); + } catch(e){ + try { + // When we are in I.E. but the script has been evaled so I.E. doesn't trust the global object when called normally + return cachedSetTimeout.call(null, fun, 0); + } catch(e){ + // same as above but when it's a version of I.E. that must have the global object for 'this', hopfully our context correct otherwise it will throw a global error + return cachedSetTimeout.call(this, fun, 0); + } + } + + + } + function runClearTimeout(marker) { + if (cachedClearTimeout === clearTimeout) { + //normal enviroments in sane situations + return clearTimeout(marker); + } + // if clearTimeout wasn't available but was latter defined + if ((cachedClearTimeout === defaultClearTimeout || !cachedClearTimeout) && clearTimeout) { + cachedClearTimeout = clearTimeout; + return clearTimeout(marker); + } + try { + // when when somebody has screwed with setTimeout but no I.E. maddness + return cachedClearTimeout(marker); + } catch (e){ + try { + // When we are in I.E. but the script has been evaled so I.E. doesn't trust the global object when called normally + return cachedClearTimeout.call(null, marker); + } catch (e){ + // same as above but when it's a version of I.E. that must have the global object for 'this', hopfully our context correct otherwise it will throw a global error. + // Some versions of I.E. have different rules for clearTimeout vs setTimeout + return cachedClearTimeout.call(this, marker); + } + } + + + + } + var queue = []; + var draining = false; + var currentQueue; + var queueIndex = -1; + + function cleanUpNextTick() { + if (!draining || !currentQueue) { + return; + } + draining = false; + if (currentQueue.length) { + queue = currentQueue.concat(queue); + } else { + queueIndex = -1; + } + if (queue.length) { + drainQueue(); + } + } + + function drainQueue() { + if (draining) { + return; + } + var timeout = runTimeout(cleanUpNextTick); + draining = true; + + var len = queue.length; + while(len) { + currentQueue = queue; + queue = []; + while (++queueIndex < len) { + if (currentQueue) { + currentQueue[queueIndex].run(); + } + } + queueIndex = -1; + len = queue.length; + } + currentQueue = null; + draining = false; + runClearTimeout(timeout); + } + + process.nextTick = function (fun) { + var args = new Array(arguments.length - 1); + if (arguments.length > 1) { + for (var i = 1; i < arguments.length; i++) { + args[i - 1] = arguments[i]; + } + } + queue.push(new Item(fun, args)); + if (queue.length === 1 && !draining) { + runTimeout(drainQueue); + } + }; + + // v8 likes predictible objects + function Item(fun, array) { + this.fun = fun; + this.array = array; + } + Item.prototype.run = function () { + this.fun.apply(null, this.array); + }; + process.title = 'browser'; + process.browser = true; + process.env = {}; + process.argv = []; + process.version = ''; // empty string to avoid regexp issues + process.versions = {}; + + function noop() {} + + process.on = noop; + process.addListener = noop; + process.once = noop; + process.off = noop; + process.removeListener = noop; + process.removeAllListeners = noop; + process.emit = noop; + process.prependListener = noop; + process.prependOnceListener = noop; + + process.listeners = function (name) { return [] } + + process.binding = function (name) { + throw new Error('process.binding is not supported'); + }; + + process.cwd = function () { return '/' }; + process.chdir = function (dir) { + throw new Error('process.chdir is not supported'); + }; + process.umask = function() { return 0; }; + + +/***/ }), +/* 4 */ +/***/ (function(module, exports, __webpack_require__) { + + /* WEBPACK VAR INJECTION */(function(global) {var scope = (typeof global !== "undefined" && global) || + (typeof self !== "undefined" && self) || + window; + var apply = Function.prototype.apply; + + // DOM APIs, for completeness + + exports.setTimeout = function() { + return new Timeout(apply.call(setTimeout, scope, arguments), clearTimeout); + }; + exports.setInterval = function() { + return new Timeout(apply.call(setInterval, scope, arguments), clearInterval); + }; + exports.clearTimeout = + exports.clearInterval = function(timeout) { + if (timeout) { + timeout.close(); + } + }; + + function Timeout(id, clearFn) { + this._id = id; + this._clearFn = clearFn; + } + Timeout.prototype.unref = Timeout.prototype.ref = function() {}; + Timeout.prototype.close = function() { + this._clearFn.call(scope, this._id); + }; + + // Does not start the time, just sets up the members needed. + exports.enroll = function(item, msecs) { + clearTimeout(item._idleTimeoutId); + item._idleTimeout = msecs; + }; + + exports.unenroll = function(item) { + clearTimeout(item._idleTimeoutId); + item._idleTimeout = -1; + }; + + exports._unrefActive = exports.active = function(item) { + clearTimeout(item._idleTimeoutId); + + var msecs = item._idleTimeout; + if (msecs >= 0) { + item._idleTimeoutId = setTimeout(function onTimeout() { + if (item._onTimeout) + item._onTimeout(); + }, msecs); + } + }; + + // setimmediate attaches itself to the global object + __webpack_require__(5); + // On some exotic environments, it's not clear which object `setimmediate` was + // able to install onto. Search each possibility in the same order as the + // `setimmediate` library. + exports.setImmediate = (typeof self !== "undefined" && self.setImmediate) || + (typeof global !== "undefined" && global.setImmediate) || + (this && this.setImmediate); + exports.clearImmediate = (typeof self !== "undefined" && self.clearImmediate) || + (typeof global !== "undefined" && global.clearImmediate) || + (this && this.clearImmediate); + + /* WEBPACK VAR INJECTION */}.call(exports, (function() { return this; }()))) + +/***/ }), +/* 5 */ +/***/ (function(module, exports, __webpack_require__) { + + /* WEBPACK VAR INJECTION */(function(global, process) {(function (global, undefined) { + "use strict"; + + if (global.setImmediate) { + return; + } + + var nextHandle = 1; // Spec says greater than zero + var tasksByHandle = {}; + var currentlyRunningATask = false; + var doc = global.document; + var registerImmediate; + + function setImmediate(callback) { + // Callback can either be a function or a string + if (typeof callback !== "function") { + callback = new Function("" + callback); + } + // Copy function arguments + var args = new Array(arguments.length - 1); + for (var i = 0; i < args.length; i++) { + args[i] = arguments[i + 1]; + } + // Store and register the task + var task = { callback: callback, args: args }; + tasksByHandle[nextHandle] = task; + registerImmediate(nextHandle); + return nextHandle++; + } + + function clearImmediate(handle) { + delete tasksByHandle[handle]; + } + + function run(task) { + var callback = task.callback; + var args = task.args; + switch (args.length) { + case 0: + callback(); + break; + case 1: + callback(args[0]); + break; + case 2: + callback(args[0], args[1]); + break; + case 3: + callback(args[0], args[1], args[2]); + break; + default: + callback.apply(undefined, args); + break; + } + } + + function runIfPresent(handle) { + // From the spec: "Wait until any invocations of this algorithm started before this one have completed." + // So if we're currently running a task, we'll need to delay this invocation. + if (currentlyRunningATask) { + // Delay by doing a setTimeout. setImmediate was tried instead, but in Firefox 7 it generated a + // "too much recursion" error. + setTimeout(runIfPresent, 0, handle); + } else { + var task = tasksByHandle[handle]; + if (task) { + currentlyRunningATask = true; + try { + run(task); + } finally { + clearImmediate(handle); + currentlyRunningATask = false; + } + } + } + } + + function installNextTickImplementation() { + registerImmediate = function(handle) { + process.nextTick(function () { runIfPresent(handle); }); + }; + } + + function canUsePostMessage() { + // The test against `importScripts` prevents this implementation from being installed inside a web worker, + // where `global.postMessage` means something completely different and can't be used for this purpose. + if (global.postMessage && !global.importScripts) { + var postMessageIsAsynchronous = true; + var oldOnMessage = global.onmessage; + global.onmessage = function() { + postMessageIsAsynchronous = false; + }; + global.postMessage("", "*"); + global.onmessage = oldOnMessage; + return postMessageIsAsynchronous; + } + } + + function installPostMessageImplementation() { + // Installs an event handler on `global` for the `message` event: see + // * https://developer.mozilla.org/en/DOM/window.postMessage + // * http://www.whatwg.org/specs/web-apps/current-work/multipage/comms.html#crossDocumentMessages + + var messagePrefix = "setImmediate$" + Math.random() + "$"; + var onGlobalMessage = function(event) { + if (event.source === global && + typeof event.data === "string" && + event.data.indexOf(messagePrefix) === 0) { + runIfPresent(+event.data.slice(messagePrefix.length)); + } + }; + + if (global.addEventListener) { + global.addEventListener("message", onGlobalMessage, false); + } else { + global.attachEvent("onmessage", onGlobalMessage); + } + + registerImmediate = function(handle) { + global.postMessage(messagePrefix + handle, "*"); + }; + } + + function installMessageChannelImplementation() { + var channel = new MessageChannel(); + channel.port1.onmessage = function(event) { + var handle = event.data; + runIfPresent(handle); + }; + + registerImmediate = function(handle) { + channel.port2.postMessage(handle); + }; + } + + function installReadyStateChangeImplementation() { + var html = doc.documentElement; + registerImmediate = function(handle) { + // Create a ` + +## methods + +`base64js` has three exposed functions, `byteLength`, `toByteArray` and `fromByteArray`, which both take a single argument. + +* `byteLength` - Takes a base64 string and returns length of byte array +* `toByteArray` - Takes a base64 string and returns a byte array +* `fromByteArray` - Takes a byte array and returns a base64 string + +## license + +MIT diff --git a/node_modules/base64-js/base64js.min.js b/node_modules/base64-js/base64js.min.js new file mode 100644 index 0000000..0c621d3 --- /dev/null +++ b/node_modules/base64-js/base64js.min.js @@ -0,0 +1 @@ +(function(r){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=r()}else if(typeof define==="function"&&define.amd){define([],r)}else{var e;if(typeof window!=="undefined"){e=window}else if(typeof global!=="undefined"){e=global}else if(typeof self!=="undefined"){e=self}else{e=this}e.base64js=r()}})(function(){var r,e,n;return function(){function r(e,n,t){function o(f,i){if(!n[f]){if(!e[f]){var u="function"==typeof require&&require;if(!i&&u)return u(f,!0);if(a)return a(f,!0);var v=new Error("Cannot find module '"+f+"'");throw v.code="MODULE_NOT_FOUND",v}var d=n[f]={exports:{}};e[f][0].call(d.exports,function(r){var n=e[f][1][r];return o(n||r)},d,d.exports,r,e,n,t)}return n[f].exports}for(var a="function"==typeof require&&require,f=0;f0){throw new Error("Invalid string. Length must be a multiple of 4")}var n=r.indexOf("=");if(n===-1)n=e;var t=n===e?0:4-n%4;return[n,t]}function d(r){var e=v(r);var n=e[0];var t=e[1];return(n+t)*3/4-t}function c(r,e,n){return(e+n)*3/4-n}function h(r){var e;var n=v(r);var t=n[0];var f=n[1];var i=new a(c(r,t,f));var u=0;var d=f>0?t-4:t;for(var h=0;h>16&255;i[u++]=e>>8&255;i[u++]=e&255}if(f===2){e=o[r.charCodeAt(h)]<<2|o[r.charCodeAt(h+1)]>>4;i[u++]=e&255}if(f===1){e=o[r.charCodeAt(h)]<<10|o[r.charCodeAt(h+1)]<<4|o[r.charCodeAt(h+2)]>>2;i[u++]=e>>8&255;i[u++]=e&255}return i}function s(r){return t[r>>18&63]+t[r>>12&63]+t[r>>6&63]+t[r&63]}function l(r,e,n){var t;var o=[];for(var a=e;au?u:i+f))}if(o===1){e=r[n-1];a.push(t[e>>2]+t[e<<4&63]+"==")}else if(o===2){e=(r[n-2]<<8)+r[n-1];a.push(t[e>>10]+t[e>>4&63]+t[e<<2&63]+"=")}return a.join("")}},{}]},{},[])("/")}); diff --git a/node_modules/base64-js/index.js b/node_modules/base64-js/index.js new file mode 100644 index 0000000..44c6766 --- /dev/null +++ b/node_modules/base64-js/index.js @@ -0,0 +1,151 @@ +'use strict' + +exports.byteLength = byteLength +exports.toByteArray = toByteArray +exports.fromByteArray = fromByteArray + +var lookup = [] +var revLookup = [] +var Arr = typeof Uint8Array !== 'undefined' ? Uint8Array : Array + +var code = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/' +for (var i = 0, len = code.length; i < len; ++i) { + lookup[i] = code[i] + revLookup[code.charCodeAt(i)] = i +} + +// Support decoding URL-safe base64 strings, as Node.js does. +// See: https://en.wikipedia.org/wiki/Base64#URL_applications +revLookup['-'.charCodeAt(0)] = 62 +revLookup['_'.charCodeAt(0)] = 63 + +function getLens (b64) { + var len = b64.length + + if (len % 4 > 0) { + throw new Error('Invalid string. Length must be a multiple of 4') + } + + // Trim off extra bytes after placeholder bytes are found + // See: https://github.com/beatgammit/base64-js/issues/42 + var validLen = b64.indexOf('=') + if (validLen === -1) validLen = len + + var placeHoldersLen = validLen === len + ? 0 + : 4 - (validLen % 4) + + return [validLen, placeHoldersLen] +} + +// base64 is 4/3 + up to two characters of the original data +function byteLength (b64) { + var lens = getLens(b64) + var validLen = lens[0] + var placeHoldersLen = lens[1] + return ((validLen + placeHoldersLen) * 3 / 4) - placeHoldersLen +} + +function _byteLength (b64, validLen, placeHoldersLen) { + return ((validLen + placeHoldersLen) * 3 / 4) - placeHoldersLen +} + +function toByteArray (b64) { + var tmp + var lens = getLens(b64) + var validLen = lens[0] + var placeHoldersLen = lens[1] + + var arr = new Arr(_byteLength(b64, validLen, placeHoldersLen)) + + var curByte = 0 + + // if there are placeholders, only get up to the last complete 4 chars + var len = placeHoldersLen > 0 + ? validLen - 4 + : validLen + + for (var i = 0; i < len; i += 4) { + tmp = + (revLookup[b64.charCodeAt(i)] << 18) | + (revLookup[b64.charCodeAt(i + 1)] << 12) | + (revLookup[b64.charCodeAt(i + 2)] << 6) | + revLookup[b64.charCodeAt(i + 3)] + arr[curByte++] = (tmp >> 16) & 0xFF + arr[curByte++] = (tmp >> 8) & 0xFF + arr[curByte++] = tmp & 0xFF + } + + if (placeHoldersLen === 2) { + tmp = + (revLookup[b64.charCodeAt(i)] << 2) | + (revLookup[b64.charCodeAt(i + 1)] >> 4) + arr[curByte++] = tmp & 0xFF + } + + if (placeHoldersLen === 1) { + tmp = + (revLookup[b64.charCodeAt(i)] << 10) | + (revLookup[b64.charCodeAt(i + 1)] << 4) | + (revLookup[b64.charCodeAt(i + 2)] >> 2) + arr[curByte++] = (tmp >> 8) & 0xFF + arr[curByte++] = tmp & 0xFF + } + + return arr +} + +function tripletToBase64 (num) { + return lookup[num >> 18 & 0x3F] + + lookup[num >> 12 & 0x3F] + + lookup[num >> 6 & 0x3F] + + lookup[num & 0x3F] +} + +function encodeChunk (uint8, start, end) { + var tmp + var output = [] + for (var i = start; i < end; i += 3) { + tmp = + ((uint8[i] << 16) & 0xFF0000) + + ((uint8[i + 1] << 8) & 0xFF00) + + (uint8[i + 2] & 0xFF) + output.push(tripletToBase64(tmp)) + } + return output.join('') +} + +function fromByteArray (uint8) { + var tmp + var len = uint8.length + var extraBytes = len % 3 // if we have 1 byte left, pad 2 bytes + var parts = [] + var maxChunkLength = 16383 // must be multiple of 3 + + // go through the array every three bytes, we'll deal with trailing stuff later + for (var i = 0, len2 = len - extraBytes; i < len2; i += maxChunkLength) { + parts.push(encodeChunk( + uint8, i, (i + maxChunkLength) > len2 ? len2 : (i + maxChunkLength) + )) + } + + // pad the end with zeros, but make sure to not forget the extra bytes + if (extraBytes === 1) { + tmp = uint8[len - 1] + parts.push( + lookup[tmp >> 2] + + lookup[(tmp << 4) & 0x3F] + + '==' + ) + } else if (extraBytes === 2) { + tmp = (uint8[len - 2] << 8) + uint8[len - 1] + parts.push( + lookup[tmp >> 10] + + lookup[(tmp >> 4) & 0x3F] + + lookup[(tmp << 2) & 0x3F] + + '=' + ) + } + + return parts.join('') +} diff --git a/node_modules/base64-js/package.json b/node_modules/base64-js/package.json new file mode 100644 index 0000000..9bb908e --- /dev/null +++ b/node_modules/base64-js/package.json @@ -0,0 +1,65 @@ +{ + "_from": "base64-js@^1.0.2", + "_id": "base64-js@1.3.0", + "_inBundle": false, + "_integrity": "sha512-ccav/yGvoa80BQDljCxsmmQ3Xvx60/UpBIij5QN21W3wBi/hhIC9OoO+KLpu9IJTS9j4DRVJ3aDDF9cMSoa2lw==", + "_location": "/base64-js", + "_phantomChildren": {}, + "_requested": { + "type": "range", + "registry": true, + "raw": "base64-js@^1.0.2", + "name": "base64-js", + "escapedName": "base64-js", + "rawSpec": "^1.0.2", + "saveSpec": null, + "fetchSpec": "^1.0.2" + }, + "_requiredBy": [ + "/buffer" + ], + "_resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.3.0.tgz", + "_shasum": "cab1e6118f051095e58b5281aea8c1cd22bfc0e3", + "_spec": "base64-js@^1.0.2", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/buffer", + "author": { + "name": "T. Jameson Little", + "email": "t.jameson.little@gmail.com" + }, + "bugs": { + "url": "https://github.com/beatgammit/base64-js/issues" + }, + "bundleDependencies": false, + "deprecated": false, + "description": "Base64 encoding/decoding in pure JS", + "devDependencies": { + "benchmark": "^2.1.4", + "browserify": "^14.0.0", + "standard": "*", + "tape": "4.x", + "uglify-js": "^2.8.29" + }, + "files": [ + "test", + "index.js", + "base64js.min.js" + ], + "homepage": "https://github.com/beatgammit/base64-js", + "keywords": [ + "base64" + ], + "license": "MIT", + "main": "index.js", + "name": "base64-js", + "repository": { + "type": "git", + "url": "git://github.com/beatgammit/base64-js.git" + }, + "scripts": { + "build": "browserify -s base64js -r ./ | uglifyjs -m > base64js.min.js", + "lint": "standard", + "test": "npm run lint && npm run unit", + "unit": "tape test/*.js" + }, + "version": "1.3.0" +} diff --git a/node_modules/base64-js/test/big-data.js b/node_modules/base64-js/test/big-data.js new file mode 100644 index 0000000..107e09e --- /dev/null +++ b/node_modules/base64-js/test/big-data.js @@ -0,0 +1,25 @@ +var test = require('tape') +var b64 = require('../') + +test('convert big data to base64', function (t) { + var b64str, arr, i, length + var big = new Uint8Array(64 * 1024 * 1024) + for (i = 0, length = big.length; i < length; ++i) { + big[i] = i % 256 + } + b64str = b64.fromByteArray(big) + arr = b64.toByteArray(b64str) + t.ok(equal(arr, big)) + t.equal(b64.byteLength(b64str), arr.length) + t.end() +}) + +function equal (a, b) { + var i + var length = a.length + if (length !== b.length) return false + for (i = 0; i < length; ++i) { + if (a[i] !== b[i]) return false + } + return true +} diff --git a/node_modules/base64-js/test/convert.js b/node_modules/base64-js/test/convert.js new file mode 100644 index 0000000..017a133 --- /dev/null +++ b/node_modules/base64-js/test/convert.js @@ -0,0 +1,88 @@ +var test = require('tape') +var b64 = require('../') +var checks = [ + 'a', + 'aa', + 'aaa', + 'hi', + 'hi!', + 'hi!!', + 'sup', + 'sup?', + 'sup?!' +] + +test('convert to base64 and back', function (t) { + t.plan(checks.length * 2) + + for (var i = 0; i < checks.length; i++) { + var check = checks[i] + var b64Str, arr, str + + b64Str = b64.fromByteArray(map(check, function (char) { return char.charCodeAt(0) })) + + arr = b64.toByteArray(b64Str) + str = map(arr, function (byte) { return String.fromCharCode(byte) }).join('') + + t.equal(check, str, 'Checked ' + check) + t.equal(b64.byteLength(b64Str), arr.length, 'Checked length for ' + check) + } +}) + +var data = [ + [[0, 0, 0], 'AAAA'], + [[0, 0, 1], 'AAAB'], + [[0, 1, -1], 'AAH/'], + [[1, 1, 1], 'AQEB'], + [[0, -73, 23], 'ALcX'] +] + +test('convert known data to string', function (t) { + for (var i = 0; i < data.length; i++) { + var bytes = data[i][0] + var expected = data[i][1] + var actual = b64.fromByteArray(bytes) + t.equal(actual, expected, 'Ensure that ' + bytes + ' serialise to ' + expected) + } + t.end() +}) + +test('convert known data from string', function (t) { + for (var i = 0; i < data.length; i++) { + var expected = data[i][0] + var string = data[i][1] + var actual = b64.toByteArray(string) + t.ok(equal(actual, expected), 'Ensure that ' + string + ' deserialise to ' + expected) + var length = b64.byteLength(string) + t.equal(length, expected.length, 'Ensure that ' + string + ' has byte lentgh of ' + expected.length) + } + t.end() +}) + +function equal (a, b) { + var i + var length = a.length + if (length !== b.length) return false + for (i = 0; i < length; ++i) { + if ((a[i] & 0xFF) !== (b[i] & 0xFF)) return false + } + return true +} + +function map (arr, callback) { + var res = [] + var kValue, mappedValue + + for (var k = 0, len = arr.length; k < len; k++) { + if ((typeof arr === 'string' && !!arr.charAt(k))) { + kValue = arr.charAt(k) + mappedValue = callback(kValue, k, arr) + res[k] = mappedValue + } else if (typeof arr !== 'string' && k in arr) { + kValue = arr[k] + mappedValue = callback(kValue, k, arr) + res[k] = mappedValue + } + } + return res +} diff --git a/node_modules/base64-js/test/corrupt.js b/node_modules/base64-js/test/corrupt.js new file mode 100644 index 0000000..44c6e71 --- /dev/null +++ b/node_modules/base64-js/test/corrupt.js @@ -0,0 +1,10 @@ +var test = require('tape') +var b64 = require('../') + +test('padding bytes found inside base64 string', function (t) { + // See https://github.com/beatgammit/base64-js/issues/42 + var str = 'SQ==QU0=' + t.deepEqual(b64.toByteArray(str), new Uint8Array([73])) + t.equal(b64.byteLength(str), 1) + t.end() +}) diff --git a/node_modules/base64-js/test/url-safe.js b/node_modules/base64-js/test/url-safe.js new file mode 100644 index 0000000..4382e06 --- /dev/null +++ b/node_modules/base64-js/test/url-safe.js @@ -0,0 +1,24 @@ +var test = require('tape') +var b64 = require('../') + +test('decode url-safe style base64 strings', function (t) { + var expected = [0xff, 0xff, 0xbe, 0xff, 0xef, 0xbf, 0xfb, 0xef, 0xff] + + var str = '//++/++/++//' + var actual = b64.toByteArray(str) + for (var i = 0; i < actual.length; i++) { + t.equal(actual[i], expected[i]) + } + + t.equal(b64.byteLength(str), actual.length) + + str = '__--_--_--__' + actual = b64.toByteArray(str) + for (i = 0; i < actual.length; i++) { + t.equal(actual[i], expected[i]) + } + + t.equal(b64.byteLength(str), actual.length) + + t.end() +}) diff --git a/node_modules/buffer/.npmignore b/node_modules/buffer/.npmignore new file mode 100644 index 0000000..a274035 --- /dev/null +++ b/node_modules/buffer/.npmignore @@ -0,0 +1,2 @@ +.zuul.yml +perf/ diff --git a/node_modules/buffer/.travis.yml b/node_modules/buffer/.travis.yml new file mode 100644 index 0000000..6789094 --- /dev/null +++ b/node_modules/buffer/.travis.yml @@ -0,0 +1,8 @@ +language: node_js +node_js: +- 'node' +sudo: false +env: + global: + - secure: AUsK+8fYSpwIMHcVt8Mu9SpG9RPHp4XDAwCQfpU3d5U65q8OVVC6C+XjvnNmEd2PoEJRHem8ZXEyRVfGM1sttKZLZP70TEKZOpOiRQnZiTQCAJ92TfGsDj/F4LoWSjUZUpfeg9b3iSp8G5dVw3+q9QZPIu6eykASK6bfcg//Cyg= + - secure: eQBKJWu7XbhAN4ZvOOhMenC0IPpoYj+wZVVzzsLwUppfJqlrHV0CUW8rJdvZNiaGhYhoyHTnAcynpTE5kZfg3XjevOvF8PGY5wUYCki9BI+rp+pvVPZE/DNUAQpFR2gd2nxMJ4kYv7GVb6i/DfuqJa0h8IuY4zcMuKWwbQd3Az8= diff --git a/node_modules/buffer/AUTHORS.md b/node_modules/buffer/AUTHORS.md new file mode 100644 index 0000000..8df343a --- /dev/null +++ b/node_modules/buffer/AUTHORS.md @@ -0,0 +1,44 @@ +# Authors + +#### Ordered by first contribution. + +- Romain Beauxis (toots@rastageeks.org) +- Tobias Koppers (tobias.koppers@googlemail.com) +- Janus (ysangkok@gmail.com) +- Rainer Dreyer (rdrey1@gmail.com) +- Tõnis Tiigi (tonistiigi@gmail.com) +- James Halliday (mail@substack.net) +- Michael Williamson (mike@zwobble.org) +- elliottcable (github@elliottcable.name) +- rafael (rvalle@livelens.net) +- Andrew Kelley (superjoe30@gmail.com) +- Andreas Madsen (amwebdk@gmail.com) +- Mike Brevoort (mike.brevoort@pearson.com) +- Brian White (mscdex@mscdex.net) +- Feross Aboukhadijeh (feross@feross.org) +- Ruben Verborgh (ruben@verborgh.org) +- eliang (eliang.cs@gmail.com) +- Jesse Tane (jesse.tane@gmail.com) +- Alfonso Boza (alfonso@cloud.com) +- Mathias Buus (mathiasbuus@gmail.com) +- Devon Govett (devongovett@gmail.com) +- Daniel Cousens (github@dcousens.com) +- Joseph Dykstra (josephdykstra@gmail.com) +- Parsha Pourkhomami (parshap+git@gmail.com) +- Damjan Košir (damjan.kosir@gmail.com) +- daverayment (dave.rayment@gmail.com) +- kawanet (u-suke@kawa.net) +- Linus Unnebäck (linus@folkdatorn.se) +- Nolan Lawson (nolan.lawson@gmail.com) +- Calvin Metcalf (calvin.metcalf@gmail.com) +- Koki Takahashi (hakatasiloving@gmail.com) +- Guy Bedford (guybedford@gmail.com) +- Jan Schär (jscissr@gmail.com) +- RaulTsc (tomescu.raul@gmail.com) +- Matthieu Monsch (monsch@alum.mit.edu) +- Dan Ehrenberg (littledan@chromium.org) +- Kirill Fomichev (fanatid@ya.ru) +- Yusuke Kawasaki (u-suke@kawa.net) +- DC (dcposch@dcpos.ch) + +#### Generated by bin/update-authors.sh. diff --git a/node_modules/buffer/LICENSE b/node_modules/buffer/LICENSE new file mode 100644 index 0000000..d6bf75d --- /dev/null +++ b/node_modules/buffer/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Feross Aboukhadijeh, and other contributors. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/buffer/README.md b/node_modules/buffer/README.md new file mode 100644 index 0000000..d3b82f6 --- /dev/null +++ b/node_modules/buffer/README.md @@ -0,0 +1,378 @@ +# buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][npm-url] + +#### The buffer module from [node.js](https://nodejs.org/), for the browser. + +[![saucelabs][saucelabs-image]][saucelabs-url] + +[travis-image]: https://img.shields.io/travis/feross/buffer/master.svg +[travis-url]: https://travis-ci.org/feross/buffer +[npm-image]: https://img.shields.io/npm/v/buffer.svg +[npm-url]: https://npmjs.org/package/buffer +[downloads-image]: https://img.shields.io/npm/dm/buffer.svg +[saucelabs-image]: https://saucelabs.com/browser-matrix/buffer.svg +[saucelabs-url]: https://saucelabs.com/u/buffer + +With [browserify](http://browserify.org), simply `require('buffer')` or use the `Buffer` global and you will get this module. + +The goal is to provide an API that is 100% identical to +[node's Buffer API](https://nodejs.org/api/buffer.html). Read the +[official docs](https://nodejs.org/api/buffer.html) for the full list of properties, +instance methods, and class methods that are supported. + +## features + +- Manipulate binary data like a boss, in all browsers -- even IE6! +- Super fast. Backed by Typed Arrays (`Uint8Array`/`ArrayBuffer`, not `Object`) +- Extremely small bundle size (**5.04KB minified + gzipped**, 35.5KB with comments) +- Excellent browser support (IE 6+, Chrome 4+, Firefox 3+, Safari 5.1+, Opera 11+, iOS, etc.) +- Preserves Node API exactly, with one minor difference (see below) +- Square-bracket `buf[4]` notation works, even in old browsers like IE6! +- Does not modify any browser prototypes or put anything on `window` +- Comprehensive test suite (including all buffer tests from node.js core) + + +## install + +To use this module directly (without browserify), install it: + +```bash +npm install buffer +``` + +This module was previously called **native-buffer-browserify**, but please use **buffer** +from now on. + +A standalone bundle is available [here](https://wzrd.in/standalone/buffer), for non-browserify users. + + +## usage + +The module's API is identical to node's `Buffer` API. Read the +[official docs](https://nodejs.org/api/buffer.html) for the full list of properties, +instance methods, and class methods that are supported. + +As mentioned above, `require('buffer')` or use the `Buffer` global with +[browserify](http://browserify.org) and this module will automatically be included +in your bundle. Almost any npm module will work in the browser, even if it assumes that +the node `Buffer` API will be available. + +To depend on this module explicitly (without browserify), require it like this: + +```js +var Buffer = require('buffer/').Buffer // note: the trailing slash is important! +``` + +To require this module explicitly, use `require('buffer/')` which tells the node.js module +lookup algorithm (also used by browserify) to use the **npm module** named `buffer` +instead of the **node.js core** module named `buffer`! + + +## how does it work? + +The Buffer constructor returns instances of `Uint8Array` that have their prototype +changed to `Buffer.prototype`. Furthermore, `Buffer` is a subclass of `Uint8Array`, +so the returned instances will have all the node `Buffer` methods and the +`Uint8Array` methods. Square bracket notation works as expected -- it returns a +single octet. + +The `Uint8Array` prototype remains unmodified. + + +## one minor difference + +#### In old browsers, `buf.slice()` does not modify parent buffer's memory + +If you only support modern browsers (specifically, those with typed array support), +then this issue does not affect you. If you support super old browsers, then read on. + +In node, the `slice()` method returns a new `Buffer` that shares underlying memory +with the original Buffer. When you modify one buffer, you modify the other. +[Read more.](https://nodejs.org/api/buffer.html#buffer_buf_slice_start_end) + +In browsers with typed array support, this `Buffer` implementation supports this +behavior. In browsers without typed arrays, an alternate buffer implementation is +used that is based on `Object` which has no mechanism to point separate +`Buffer`s to the same underlying slab of memory. + +You can see which browser versions lack typed array support +[here](https://github.com/feross/buffer/blob/master/index.js#L22-L48). + + +## tracking the latest node api + +This module tracks the Buffer API in the latest (unstable) version of node.js. The Buffer +API is considered **stable** in the +[node stability index](https://nodejs.org/docs/latest/api/documentation.html#documentation_stability_index), +so it is unlikely that there will ever be breaking changes. +Nonetheless, when/if the Buffer API changes in node, this module's API will change +accordingly. + +## related packages + +- [`buffer-equals`](https://www.npmjs.com/package/buffer-equals) - Node.js 0.12 buffer.equals() ponyfill +- [`buffer-reverse`](https://www.npmjs.com/package/buffer-reverse) - A lite module for reverse-operations on buffers +- [`buffer-xor`](https://www.npmjs.com/package/buffer-xor) - A simple module for bitwise-xor on buffers +- [`is-buffer`](https://www.npmjs.com/package/is-buffer) - Determine if an object is a Buffer without including the whole `Buffer` package +- [`typedarray-to-buffer`](https://www.npmjs.com/package/typedarray-to-buffer) - Convert a typed array to a Buffer without a copy + +## performance + +See perf tests in `/perf`. + +`BrowserBuffer` is the browser `buffer` module (this repo). `Uint8Array` is included as a +sanity check (since `BrowserBuffer` uses `Uint8Array` under the hood, `Uint8Array` will +always be at least a bit faster). Finally, `NodeBuffer` is the node.js buffer module, +which is included to compare against. + +NOTE: Performance has improved since these benchmarks were taken. PR welcoem to update the README. + +### Chrome 38 + +| Method | Operations | Accuracy | Sampled | Fastest | +|:-------|:-----------|:---------|:--------|:-------:| +| BrowserBuffer#bracket-notation | 11,457,464 ops/sec | ±0.86% | 66 | ✓ | +| Uint8Array#bracket-notation | 10,824,332 ops/sec | ±0.74% | 65 | | +| | | | | +| BrowserBuffer#concat | 450,532 ops/sec | ±0.76% | 68 | | +| Uint8Array#concat | 1,368,911 ops/sec | ±1.50% | 62 | ✓ | +| | | | | +| BrowserBuffer#copy(16000) | 903,001 ops/sec | ±0.96% | 67 | | +| Uint8Array#copy(16000) | 1,422,441 ops/sec | ±1.04% | 66 | ✓ | +| | | | | +| BrowserBuffer#copy(16) | 11,431,358 ops/sec | ±0.46% | 69 | | +| Uint8Array#copy(16) | 13,944,163 ops/sec | ±1.12% | 68 | ✓ | +| | | | | +| BrowserBuffer#new(16000) | 106,329 ops/sec | ±6.70% | 44 | | +| Uint8Array#new(16000) | 131,001 ops/sec | ±2.85% | 31 | ✓ | +| | | | | +| BrowserBuffer#new(16) | 1,554,491 ops/sec | ±1.60% | 65 | | +| Uint8Array#new(16) | 6,623,930 ops/sec | ±1.66% | 65 | ✓ | +| | | | | +| BrowserBuffer#readDoubleBE | 112,830 ops/sec | ±0.51% | 69 | ✓ | +| DataView#getFloat64 | 93,500 ops/sec | ±0.57% | 68 | | +| | | | | +| BrowserBuffer#readFloatBE | 146,678 ops/sec | ±0.95% | 68 | ✓ | +| DataView#getFloat32 | 99,311 ops/sec | ±0.41% | 67 | | +| | | | | +| BrowserBuffer#readUInt32LE | 843,214 ops/sec | ±0.70% | 69 | ✓ | +| DataView#getUint32 | 103,024 ops/sec | ±0.64% | 67 | | +| | | | | +| BrowserBuffer#slice | 1,013,941 ops/sec | ±0.75% | 67 | | +| Uint8Array#subarray | 1,903,928 ops/sec | ±0.53% | 67 | ✓ | +| | | | | +| BrowserBuffer#writeFloatBE | 61,387 ops/sec | ±0.90% | 67 | | +| DataView#setFloat32 | 141,249 ops/sec | ±0.40% | 66 | ✓ | + + +### Firefox 33 + +| Method | Operations | Accuracy | Sampled | Fastest | +|:-------|:-----------|:---------|:--------|:-------:| +| BrowserBuffer#bracket-notation | 20,800,421 ops/sec | ±1.84% | 60 | | +| Uint8Array#bracket-notation | 20,826,235 ops/sec | ±2.02% | 61 | ✓ | +| | | | | +| BrowserBuffer#concat | 153,076 ops/sec | ±2.32% | 61 | | +| Uint8Array#concat | 1,255,674 ops/sec | ±8.65% | 52 | ✓ | +| | | | | +| BrowserBuffer#copy(16000) | 1,105,312 ops/sec | ±1.16% | 63 | | +| Uint8Array#copy(16000) | 1,615,911 ops/sec | ±0.55% | 66 | ✓ | +| | | | | +| BrowserBuffer#copy(16) | 16,357,599 ops/sec | ±0.73% | 68 | | +| Uint8Array#copy(16) | 31,436,281 ops/sec | ±1.05% | 68 | ✓ | +| | | | | +| BrowserBuffer#new(16000) | 52,995 ops/sec | ±6.01% | 35 | | +| Uint8Array#new(16000) | 87,686 ops/sec | ±5.68% | 45 | ✓ | +| | | | | +| BrowserBuffer#new(16) | 252,031 ops/sec | ±1.61% | 66 | | +| Uint8Array#new(16) | 8,477,026 ops/sec | ±0.49% | 68 | ✓ | +| | | | | +| BrowserBuffer#readDoubleBE | 99,871 ops/sec | ±0.41% | 69 | | +| DataView#getFloat64 | 285,663 ops/sec | ±0.70% | 68 | ✓ | +| | | | | +| BrowserBuffer#readFloatBE | 115,540 ops/sec | ±0.42% | 69 | | +| DataView#getFloat32 | 288,722 ops/sec | ±0.82% | 68 | ✓ | +| | | | | +| BrowserBuffer#readUInt32LE | 633,926 ops/sec | ±1.08% | 67 | ✓ | +| DataView#getUint32 | 294,808 ops/sec | ±0.79% | 64 | | +| | | | | +| BrowserBuffer#slice | 349,425 ops/sec | ±0.46% | 69 | | +| Uint8Array#subarray | 5,965,819 ops/sec | ±0.60% | 65 | ✓ | +| | | | | +| BrowserBuffer#writeFloatBE | 59,980 ops/sec | ±0.41% | 67 | | +| DataView#setFloat32 | 317,634 ops/sec | ±0.63% | 68 | ✓ | + +### Safari 8 + +| Method | Operations | Accuracy | Sampled | Fastest | +|:-------|:-----------|:---------|:--------|:-------:| +| BrowserBuffer#bracket-notation | 10,279,729 ops/sec | ±2.25% | 56 | ✓ | +| Uint8Array#bracket-notation | 10,030,767 ops/sec | ±2.23% | 59 | | +| | | | | +| BrowserBuffer#concat | 144,138 ops/sec | ±1.38% | 65 | | +| Uint8Array#concat | 4,950,764 ops/sec | ±1.70% | 63 | ✓ | +| | | | | +| BrowserBuffer#copy(16000) | 1,058,548 ops/sec | ±1.51% | 64 | | +| Uint8Array#copy(16000) | 1,409,666 ops/sec | ±1.17% | 65 | ✓ | +| | | | | +| BrowserBuffer#copy(16) | 6,282,529 ops/sec | ±1.88% | 58 | | +| Uint8Array#copy(16) | 11,907,128 ops/sec | ±2.87% | 58 | ✓ | +| | | | | +| BrowserBuffer#new(16000) | 101,663 ops/sec | ±3.89% | 57 | | +| Uint8Array#new(16000) | 22,050,818 ops/sec | ±6.51% | 46 | ✓ | +| | | | | +| BrowserBuffer#new(16) | 176,072 ops/sec | ±2.13% | 64 | | +| Uint8Array#new(16) | 24,385,731 ops/sec | ±5.01% | 51 | ✓ | +| | | | | +| BrowserBuffer#readDoubleBE | 41,341 ops/sec | ±1.06% | 67 | | +| DataView#getFloat64 | 322,280 ops/sec | ±0.84% | 68 | ✓ | +| | | | | +| BrowserBuffer#readFloatBE | 46,141 ops/sec | ±1.06% | 65 | | +| DataView#getFloat32 | 337,025 ops/sec | ±0.43% | 69 | ✓ | +| | | | | +| BrowserBuffer#readUInt32LE | 151,551 ops/sec | ±1.02% | 66 | | +| DataView#getUint32 | 308,278 ops/sec | ±0.94% | 67 | ✓ | +| | | | | +| BrowserBuffer#slice | 197,365 ops/sec | ±0.95% | 66 | | +| Uint8Array#subarray | 9,558,024 ops/sec | ±3.08% | 58 | ✓ | +| | | | | +| BrowserBuffer#writeFloatBE | 17,518 ops/sec | ±1.03% | 63 | | +| DataView#setFloat32 | 319,751 ops/sec | ±0.48% | 68 | ✓ | + + +### Node 0.11.14 + +| Method | Operations | Accuracy | Sampled | Fastest | +|:-------|:-----------|:---------|:--------|:-------:| +| BrowserBuffer#bracket-notation | 10,489,828 ops/sec | ±3.25% | 90 | | +| Uint8Array#bracket-notation | 10,534,884 ops/sec | ±0.81% | 92 | ✓ | +| NodeBuffer#bracket-notation | 10,389,910 ops/sec | ±0.97% | 87 | | +| | | | | +| BrowserBuffer#concat | 487,830 ops/sec | ±2.58% | 88 | | +| Uint8Array#concat | 1,814,327 ops/sec | ±1.28% | 88 | ✓ | +| NodeBuffer#concat | 1,636,523 ops/sec | ±1.88% | 73 | | +| | | | | +| BrowserBuffer#copy(16000) | 1,073,665 ops/sec | ±0.77% | 90 | | +| Uint8Array#copy(16000) | 1,348,517 ops/sec | ±0.84% | 89 | ✓ | +| NodeBuffer#copy(16000) | 1,289,533 ops/sec | ±0.82% | 93 | | +| | | | | +| BrowserBuffer#copy(16) | 12,782,706 ops/sec | ±0.74% | 85 | | +| Uint8Array#copy(16) | 14,180,427 ops/sec | ±0.93% | 92 | ✓ | +| NodeBuffer#copy(16) | 11,083,134 ops/sec | ±1.06% | 89 | | +| | | | | +| BrowserBuffer#new(16000) | 141,678 ops/sec | ±3.30% | 67 | | +| Uint8Array#new(16000) | 161,491 ops/sec | ±2.96% | 60 | | +| NodeBuffer#new(16000) | 292,699 ops/sec | ±3.20% | 55 | ✓ | +| | | | | +| BrowserBuffer#new(16) | 1,655,466 ops/sec | ±2.41% | 82 | | +| Uint8Array#new(16) | 14,399,926 ops/sec | ±0.91% | 94 | ✓ | +| NodeBuffer#new(16) | 3,894,696 ops/sec | ±0.88% | 92 | | +| | | | | +| BrowserBuffer#readDoubleBE | 109,582 ops/sec | ±0.75% | 93 | ✓ | +| DataView#getFloat64 | 91,235 ops/sec | ±0.81% | 90 | | +| NodeBuffer#readDoubleBE | 88,593 ops/sec | ±0.96% | 81 | | +| | | | | +| BrowserBuffer#readFloatBE | 139,854 ops/sec | ±1.03% | 85 | ✓ | +| DataView#getFloat32 | 98,744 ops/sec | ±0.80% | 89 | | +| NodeBuffer#readFloatBE | 92,769 ops/sec | ±0.94% | 93 | | +| | | | | +| BrowserBuffer#readUInt32LE | 710,861 ops/sec | ±0.82% | 92 | | +| DataView#getUint32 | 117,893 ops/sec | ±0.84% | 91 | | +| NodeBuffer#readUInt32LE | 851,412 ops/sec | ±0.72% | 93 | ✓ | +| | | | | +| BrowserBuffer#slice | 1,673,877 ops/sec | ±0.73% | 94 | | +| Uint8Array#subarray | 6,919,243 ops/sec | ±0.67% | 90 | ✓ | +| NodeBuffer#slice | 4,617,604 ops/sec | ±0.79% | 93 | | +| | | | | +| BrowserBuffer#writeFloatBE | 66,011 ops/sec | ±0.75% | 93 | | +| DataView#setFloat32 | 127,760 ops/sec | ±0.72% | 93 | ✓ | +| NodeBuffer#writeFloatBE | 103,352 ops/sec | ±0.83% | 93 | | + +### iojs 1.8.1 + +| Method | Operations | Accuracy | Sampled | Fastest | +|:-------|:-----------|:---------|:--------|:-------:| +| BrowserBuffer#bracket-notation | 10,990,488 ops/sec | ±1.11% | 91 | | +| Uint8Array#bracket-notation | 11,268,757 ops/sec | ±0.65% | 97 | | +| NodeBuffer#bracket-notation | 11,353,260 ops/sec | ±0.83% | 94 | ✓ | +| | | | | +| BrowserBuffer#concat | 378,954 ops/sec | ±0.74% | 94 | | +| Uint8Array#concat | 1,358,288 ops/sec | ±0.97% | 87 | | +| NodeBuffer#concat | 1,934,050 ops/sec | ±1.11% | 78 | ✓ | +| | | | | +| BrowserBuffer#copy(16000) | 894,538 ops/sec | ±0.56% | 84 | | +| Uint8Array#copy(16000) | 1,442,656 ops/sec | ±0.71% | 96 | | +| NodeBuffer#copy(16000) | 1,457,898 ops/sec | ±0.53% | 92 | ✓ | +| | | | | +| BrowserBuffer#copy(16) | 12,870,457 ops/sec | ±0.67% | 95 | | +| Uint8Array#copy(16) | 16,643,989 ops/sec | ±0.61% | 93 | ✓ | +| NodeBuffer#copy(16) | 14,885,848 ops/sec | ±0.74% | 94 | | +| | | | | +| BrowserBuffer#new(16000) | 109,264 ops/sec | ±4.21% | 63 | | +| Uint8Array#new(16000) | 138,916 ops/sec | ±1.87% | 61 | | +| NodeBuffer#new(16000) | 281,449 ops/sec | ±3.58% | 51 | ✓ | +| | | | | +| BrowserBuffer#new(16) | 1,362,935 ops/sec | ±0.56% | 99 | | +| Uint8Array#new(16) | 6,193,090 ops/sec | ±0.64% | 95 | ✓ | +| NodeBuffer#new(16) | 4,745,425 ops/sec | ±1.56% | 90 | | +| | | | | +| BrowserBuffer#readDoubleBE | 118,127 ops/sec | ±0.59% | 93 | ✓ | +| DataView#getFloat64 | 107,332 ops/sec | ±0.65% | 91 | | +| NodeBuffer#readDoubleBE | 116,274 ops/sec | ±0.94% | 95 | | +| | | | | +| BrowserBuffer#readFloatBE | 150,326 ops/sec | ±0.58% | 95 | ✓ | +| DataView#getFloat32 | 110,541 ops/sec | ±0.57% | 98 | | +| NodeBuffer#readFloatBE | 121,599 ops/sec | ±0.60% | 87 | | +| | | | | +| BrowserBuffer#readUInt32LE | 814,147 ops/sec | ±0.62% | 93 | | +| DataView#getUint32 | 137,592 ops/sec | ±0.64% | 90 | | +| NodeBuffer#readUInt32LE | 931,650 ops/sec | ±0.71% | 96 | ✓ | +| | | | | +| BrowserBuffer#slice | 878,590 ops/sec | ±0.68% | 93 | | +| Uint8Array#subarray | 2,843,308 ops/sec | ±1.02% | 90 | | +| NodeBuffer#slice | 4,998,316 ops/sec | ±0.68% | 90 | ✓ | +| | | | | +| BrowserBuffer#writeFloatBE | 65,927 ops/sec | ±0.74% | 93 | | +| DataView#setFloat32 | 139,823 ops/sec | ±0.97% | 89 | ✓ | +| NodeBuffer#writeFloatBE | 135,763 ops/sec | ±0.65% | 96 | | +| | | | | + +## Testing the project + +First, install the project: + + npm install + +Then, to run tests in Node.js, run: + + npm run test-node + +To test locally in a browser, you can run: + + npm run test-browser-local + +This will print out a URL that you can then open in a browser to run the tests, using [Zuul](https://github.com/defunctzombie/zuul). + +To run automated browser tests using Saucelabs, ensure that your `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables are set, then run: + + npm test + +This is what's run in Travis, to check against various browsers. The list of browsers is kept in the `.zuul.yml` file. + +## JavaScript Standard Style + +This module uses [JavaScript Standard Style](https://github.com/feross/standard). + +[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) + +To test that the code conforms to the style, `npm install` and run: + + ./node_modules/.bin/standard + +## credit + +This was originally forked from [buffer-browserify](https://github.com/toots/buffer-browserify). + + +## license + +MIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org), and other contributors. Originally forked from an MIT-licensed module by Romain Beauxis. diff --git a/node_modules/buffer/bin/download-node-tests.js b/node_modules/buffer/bin/download-node-tests.js new file mode 100755 index 0000000..97efde0 --- /dev/null +++ b/node_modules/buffer/bin/download-node-tests.js @@ -0,0 +1,106 @@ +#!/usr/bin/env node + +var concat = require('concat-stream') +var cp = require('child_process') +var fs = require('fs') +var hyperquest = require('hyperquest') +var path = require('path') +var split = require('split') +var through = require('through2') + +var url = 'https://api.github.com/repos/nodejs/node/contents' +var dirs = [ + '/test/parallel', + '/test/pummel' +] + +cp.execSync('rm -rf node/*.js', { cwd: path.join(__dirname, '../test') }) + +var httpOpts = { + headers: { + 'User-Agent': null + // auth if github rate-limits you... + // 'Authorization': 'Basic ' + Buffer('username:password').toString('base64'), + } +} + +dirs.forEach(function (dir) { + var req = hyperquest(url + dir, httpOpts) + req.pipe(concat(function (data) { + if (req.response.statusCode !== 200) { + throw new Error(url + dir + ': ' + data.toString()) + } + downloadBufferTests(dir, JSON.parse(data)) + })) +}) + +function downloadBufferTests (dir, files) { + files.forEach(function (file) { + if (!/test-buffer.*/.test(file.name)) return + + if (file.name === 'test-buffer-fakes.js') { + // These teses only apply to node, where they're calling into C++ and need to + // ensure the prototype can't be faked, or else there will be a segfault. + return + } + + console.log(file.download_url) + + var out = path.join(__dirname, '../test/node', file.name) + hyperquest(file.download_url, httpOpts) + .pipe(split()) + .pipe(testfixer(file.name)) + .pipe(fs.createWriteStream(out)) + .on('finish', function () { + console.log('wrote ' + file.name) + }) + }) +} + +function testfixer (filename) { + var firstline = true + + return through(function (line, enc, cb) { + line = line.toString() + + if (firstline) { + // require buffer explicitly + var preamble = 'var Buffer = require(\'../../\').Buffer;\n' + if (/use strict/.test(line)) line += '\n' + preamble + else line + preamble + '\n' + line + firstline = false + } + + // use `var` instead of `const`/`let` + line = line.replace(/(const|let) /g, 'var ') + + // make `var common = require('common')` work + line = line.replace(/(var common = require.*)/g, 'var common = { skip: function () {} };') + + // make `require('../common')` work + line = line.replace(/require\('\.\.\/common'\);/g, '') + + // require browser buffer + line = line.replace(/(.*)require\('buffer'\)(.*)/g, '$1require(\'../../\')$2') + + // comment out console logs + line = line.replace(/(.*console\..*)/g, '// $1') + + // we can't reliably test typed array max-sizes in the browser + if (filename === 'test-buffer-big.js') { + line = line.replace(/(.*new Int8Array.*RangeError.*)/, '// $1') + line = line.replace(/(.*new ArrayBuffer.*RangeError.*)/, '// $1') + line = line.replace(/(.*new Float64Array.*RangeError.*)/, '// $1') + } + + // https://github.com/nodejs/node/blob/v0.12/test/parallel/test-buffer.js#L1138 + // unfortunately we can't run this because crypto-browserify doesn't work in old + // versions of ie + if (filename === 'test-buffer.js') { + line = line.replace(/^(\s*)(var crypto = require.*)/, '$1// $2') + line = line.replace(/(crypto.createHash.*\))/, '1 /*$1*/') + } + + cb(null, line + '\n') + }) +} diff --git a/node_modules/buffer/bin/test.js b/node_modules/buffer/bin/test.js new file mode 100644 index 0000000..5a86f1b --- /dev/null +++ b/node_modules/buffer/bin/test.js @@ -0,0 +1,41 @@ +#!/usr/bin/env node + +var cp = require('child_process') +var fs = require('fs') +var path = require('path') + +var shouldRunBrowserTests = !process.env.TRAVIS_PULL_REQUEST || + process.env.TRAVIS_PULL_REQUEST === 'false' + +var node = cp.spawn('npm', ['run', 'test-node'], { stdio: 'inherit' }) +node.on('close', function (code) { + if (code === 0 && shouldRunBrowserTests) { + runBrowserTests() + } else { + process.exit(code) + } +}) + +function runBrowserTests () { + var zuulYmlPath = path.join(__dirname, '..', '.zuul.yml') + + writeES5ZuulYml() + cp.spawn('npm', ['run', 'test-browser-es5'], { stdio: 'inherit' }) + .on('close', function (code) { + if (code !== 0) process.exit(code) + writeES6ZuulYml() + cp.spawn('npm', ['run', 'test-browser-es6'], { stdio: 'inherit' }) + .on('close', function (code) { + process.exit(code) + }) + }) + + function writeES5ZuulYml () { + fs.writeFileSync(zuulYmlPath, fs.readFileSync(path.join(__dirname, 'zuul-es5.yml'))) + } + + function writeES6ZuulYml () { + fs.writeFileSync(zuulYmlPath, fs.readFileSync(path.join(__dirname, 'zuul-es6.yml'))) + } +} + diff --git a/node_modules/buffer/bin/update-authors.sh b/node_modules/buffer/bin/update-authors.sh new file mode 100755 index 0000000..efcbc78 --- /dev/null +++ b/node_modules/buffer/bin/update-authors.sh @@ -0,0 +1,21 @@ +#!/bin/sh +# Update AUTHORS.md based on git history. + +git log --reverse --format='%aN (%aE)' | perl -we ' +BEGIN { + %seen = (), @authors = (); +} +while (<>) { + next if $seen{$_}; + next if /(support\@greenkeeper.io)/; + next if /(dcousens\@users.noreply.github.com)/; + next if /(cmetcalf\@appgeo.com)/; + $seen{$_} = push @authors, "- ", $_; +} +END { + print "# Authors\n\n"; + print "#### Ordered by first contribution.\n\n"; + print @authors, "\n"; + print "#### Generated by bin/update-authors.sh.\n"; +} +' > AUTHORS.md diff --git a/node_modules/buffer/bin/zuul-es5.yml b/node_modules/buffer/bin/zuul-es5.yml new file mode 100644 index 0000000..3673bcc --- /dev/null +++ b/node_modules/buffer/bin/zuul-es5.yml @@ -0,0 +1,14 @@ +ui: tape +scripts: + - ./test/_polyfill.js +browsers: + - name: safari + version: latest + - name: ie + version: 8..latest + - name: microsoftedge + version: 13..latest + - name: android + version: 4.4..latest + - name: iphone + version: latest diff --git a/node_modules/buffer/bin/zuul-es6.yml b/node_modules/buffer/bin/zuul-es6.yml new file mode 100644 index 0000000..8054ad6 --- /dev/null +++ b/node_modules/buffer/bin/zuul-es6.yml @@ -0,0 +1,6 @@ +ui: tape +browsers: + - name: chrome + version: '-1..latest' + - name: firefox + version: '-1..latest' diff --git a/node_modules/buffer/index.js b/node_modules/buffer/index.js new file mode 100644 index 0000000..0fcd80a --- /dev/null +++ b/node_modules/buffer/index.js @@ -0,0 +1,1789 @@ +/*! + * The buffer module from node.js, for the browser. + * + * @author Feross Aboukhadijeh + * @license MIT + */ +/* eslint-disable no-proto */ + +'use strict' + +var base64 = require('base64-js') +var ieee754 = require('ieee754') +var isArray = require('isarray') + +exports.Buffer = Buffer +exports.SlowBuffer = SlowBuffer +exports.INSPECT_MAX_BYTES = 50 + +/** + * If `Buffer.TYPED_ARRAY_SUPPORT`: + * === true Use Uint8Array implementation (fastest) + * === false Use Object implementation (most compatible, even IE6) + * + * Browsers that support typed arrays are IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, + * Opera 11.6+, iOS 4.2+. + * + * Due to various browser bugs, sometimes the Object implementation will be used even + * when the browser supports typed arrays. + * + * Note: + * + * - Firefox 4-29 lacks support for adding new properties to `Uint8Array` instances, + * See: https://bugzilla.mozilla.org/show_bug.cgi?id=695438. + * + * - Chrome 9-10 is missing the `TypedArray.prototype.subarray` function. + * + * - IE10 has a broken `TypedArray.prototype.subarray` function which returns arrays of + * incorrect length in some situations. + + * We detect these buggy browsers and set `Buffer.TYPED_ARRAY_SUPPORT` to `false` so they + * get the Object implementation, which is slower but behaves correctly. + */ +Buffer.TYPED_ARRAY_SUPPORT = global.TYPED_ARRAY_SUPPORT !== undefined + ? global.TYPED_ARRAY_SUPPORT + : typedArraySupport() + +/* + * Export kMaxLength after typed array support is determined. + */ +exports.kMaxLength = kMaxLength() + +function typedArraySupport () { + try { + var arr = new Uint8Array(1) + arr.__proto__ = {__proto__: Uint8Array.prototype, foo: function () { return 42 }} + return arr.foo() === 42 && // typed array instances can be augmented + typeof arr.subarray === 'function' && // chrome 9-10 lack `subarray` + arr.subarray(1, 1).byteLength === 0 // ie10 has broken `subarray` + } catch (e) { + return false + } +} + +function kMaxLength () { + return Buffer.TYPED_ARRAY_SUPPORT + ? 0x7fffffff + : 0x3fffffff +} + +function createBuffer (that, length) { + if (kMaxLength() < length) { + throw new RangeError('Invalid typed array length') + } + if (Buffer.TYPED_ARRAY_SUPPORT) { + // Return an augmented `Uint8Array` instance, for best performance + that = new Uint8Array(length) + that.__proto__ = Buffer.prototype + } else { + // Fallback: Return an object instance of the Buffer class + if (that === null) { + that = new Buffer(length) + } + that.length = length + } + + return that +} + +/** + * The Buffer constructor returns instances of `Uint8Array` that have their + * prototype changed to `Buffer.prototype`. Furthermore, `Buffer` is a subclass of + * `Uint8Array`, so the returned instances will have all the node `Buffer` methods + * and the `Uint8Array` methods. Square bracket notation works as expected -- it + * returns a single octet. + * + * The `Uint8Array` prototype remains unmodified. + */ + +function Buffer (arg, encodingOrOffset, length) { + if (!Buffer.TYPED_ARRAY_SUPPORT && !(this instanceof Buffer)) { + return new Buffer(arg, encodingOrOffset, length) + } + + // Common case. + if (typeof arg === 'number') { + if (typeof encodingOrOffset === 'string') { + throw new Error( + 'If encoding is specified then the first argument must be a string' + ) + } + return allocUnsafe(this, arg) + } + return from(this, arg, encodingOrOffset, length) +} + +Buffer.poolSize = 8192 // not used by this implementation + +// TODO: Legacy, not needed anymore. Remove in next major version. +Buffer._augment = function (arr) { + arr.__proto__ = Buffer.prototype + return arr +} + +function from (that, value, encodingOrOffset, length) { + if (typeof value === 'number') { + throw new TypeError('"value" argument must not be a number') + } + + if (typeof ArrayBuffer !== 'undefined' && value instanceof ArrayBuffer) { + return fromArrayBuffer(that, value, encodingOrOffset, length) + } + + if (typeof value === 'string') { + return fromString(that, value, encodingOrOffset) + } + + return fromObject(that, value) +} + +/** + * Functionally equivalent to Buffer(arg, encoding) but throws a TypeError + * if value is a number. + * Buffer.from(str[, encoding]) + * Buffer.from(array) + * Buffer.from(buffer) + * Buffer.from(arrayBuffer[, byteOffset[, length]]) + **/ +Buffer.from = function (value, encodingOrOffset, length) { + return from(null, value, encodingOrOffset, length) +} + +if (Buffer.TYPED_ARRAY_SUPPORT) { + Buffer.prototype.__proto__ = Uint8Array.prototype + Buffer.__proto__ = Uint8Array + if (typeof Symbol !== 'undefined' && Symbol.species && + Buffer[Symbol.species] === Buffer) { + // Fix subarray() in ES2016. See: https://github.com/feross/buffer/pull/97 + Object.defineProperty(Buffer, Symbol.species, { + value: null, + configurable: true + }) + } +} + +function assertSize (size) { + if (typeof size !== 'number') { + throw new TypeError('"size" argument must be a number') + } else if (size < 0) { + throw new RangeError('"size" argument must not be negative') + } +} + +function alloc (that, size, fill, encoding) { + assertSize(size) + if (size <= 0) { + return createBuffer(that, size) + } + if (fill !== undefined) { + // Only pay attention to encoding if it's a string. This + // prevents accidentally sending in a number that would + // be interpretted as a start offset. + return typeof encoding === 'string' + ? createBuffer(that, size).fill(fill, encoding) + : createBuffer(that, size).fill(fill) + } + return createBuffer(that, size) +} + +/** + * Creates a new filled Buffer instance. + * alloc(size[, fill[, encoding]]) + **/ +Buffer.alloc = function (size, fill, encoding) { + return alloc(null, size, fill, encoding) +} + +function allocUnsafe (that, size) { + assertSize(size) + that = createBuffer(that, size < 0 ? 0 : checked(size) | 0) + if (!Buffer.TYPED_ARRAY_SUPPORT) { + for (var i = 0; i < size; ++i) { + that[i] = 0 + } + } + return that +} + +/** + * Equivalent to Buffer(num), by default creates a non-zero-filled Buffer instance. + * */ +Buffer.allocUnsafe = function (size) { + return allocUnsafe(null, size) +} +/** + * Equivalent to SlowBuffer(num), by default creates a non-zero-filled Buffer instance. + */ +Buffer.allocUnsafeSlow = function (size) { + return allocUnsafe(null, size) +} + +function fromString (that, string, encoding) { + if (typeof encoding !== 'string' || encoding === '') { + encoding = 'utf8' + } + + if (!Buffer.isEncoding(encoding)) { + throw new TypeError('"encoding" must be a valid string encoding') + } + + var length = byteLength(string, encoding) | 0 + that = createBuffer(that, length) + + var actual = that.write(string, encoding) + + if (actual !== length) { + // Writing a hex string, for example, that contains invalid characters will + // cause everything after the first invalid character to be ignored. (e.g. + // 'abxxcd' will be treated as 'ab') + that = that.slice(0, actual) + } + + return that +} + +function fromArrayLike (that, array) { + var length = array.length < 0 ? 0 : checked(array.length) | 0 + that = createBuffer(that, length) + for (var i = 0; i < length; i += 1) { + that[i] = array[i] & 255 + } + return that +} + +function fromArrayBuffer (that, array, byteOffset, length) { + array.byteLength // this throws if `array` is not a valid ArrayBuffer + + if (byteOffset < 0 || array.byteLength < byteOffset) { + throw new RangeError('\'offset\' is out of bounds') + } + + if (array.byteLength < byteOffset + (length || 0)) { + throw new RangeError('\'length\' is out of bounds') + } + + if (byteOffset === undefined && length === undefined) { + array = new Uint8Array(array) + } else if (length === undefined) { + array = new Uint8Array(array, byteOffset) + } else { + array = new Uint8Array(array, byteOffset, length) + } + + if (Buffer.TYPED_ARRAY_SUPPORT) { + // Return an augmented `Uint8Array` instance, for best performance + that = array + that.__proto__ = Buffer.prototype + } else { + // Fallback: Return an object instance of the Buffer class + that = fromArrayLike(that, array) + } + return that +} + +function fromObject (that, obj) { + if (Buffer.isBuffer(obj)) { + var len = checked(obj.length) | 0 + that = createBuffer(that, len) + + if (that.length === 0) { + return that + } + + obj.copy(that, 0, 0, len) + return that + } + + if (obj) { + if ((typeof ArrayBuffer !== 'undefined' && + obj.buffer instanceof ArrayBuffer) || 'length' in obj) { + if (typeof obj.length !== 'number' || isnan(obj.length)) { + return createBuffer(that, 0) + } + return fromArrayLike(that, obj) + } + + if (obj.type === 'Buffer' && isArray(obj.data)) { + return fromArrayLike(that, obj.data) + } + } + + throw new TypeError('First argument must be a string, Buffer, ArrayBuffer, Array, or array-like object.') +} + +function checked (length) { + // Note: cannot use `length < kMaxLength()` here because that fails when + // length is NaN (which is otherwise coerced to zero.) + if (length >= kMaxLength()) { + throw new RangeError('Attempt to allocate Buffer larger than maximum ' + + 'size: 0x' + kMaxLength().toString(16) + ' bytes') + } + return length | 0 +} + +function SlowBuffer (length) { + if (+length != length) { // eslint-disable-line eqeqeq + length = 0 + } + return Buffer.alloc(+length) +} + +Buffer.isBuffer = function isBuffer (b) { + return !!(b != null && b._isBuffer) +} + +Buffer.compare = function compare (a, b) { + if (!Buffer.isBuffer(a) || !Buffer.isBuffer(b)) { + throw new TypeError('Arguments must be Buffers') + } + + if (a === b) return 0 + + var x = a.length + var y = b.length + + for (var i = 0, len = Math.min(x, y); i < len; ++i) { + if (a[i] !== b[i]) { + x = a[i] + y = b[i] + break + } + } + + if (x < y) return -1 + if (y < x) return 1 + return 0 +} + +Buffer.isEncoding = function isEncoding (encoding) { + switch (String(encoding).toLowerCase()) { + case 'hex': + case 'utf8': + case 'utf-8': + case 'ascii': + case 'latin1': + case 'binary': + case 'base64': + case 'ucs2': + case 'ucs-2': + case 'utf16le': + case 'utf-16le': + return true + default: + return false + } +} + +Buffer.concat = function concat (list, length) { + if (!isArray(list)) { + throw new TypeError('"list" argument must be an Array of Buffers') + } + + if (list.length === 0) { + return Buffer.alloc(0) + } + + var i + if (length === undefined) { + length = 0 + for (i = 0; i < list.length; ++i) { + length += list[i].length + } + } + + var buffer = Buffer.allocUnsafe(length) + var pos = 0 + for (i = 0; i < list.length; ++i) { + var buf = list[i] + if (!Buffer.isBuffer(buf)) { + throw new TypeError('"list" argument must be an Array of Buffers') + } + buf.copy(buffer, pos) + pos += buf.length + } + return buffer +} + +function byteLength (string, encoding) { + if (Buffer.isBuffer(string)) { + return string.length + } + if (typeof ArrayBuffer !== 'undefined' && typeof ArrayBuffer.isView === 'function' && + (ArrayBuffer.isView(string) || string instanceof ArrayBuffer)) { + return string.byteLength + } + if (typeof string !== 'string') { + string = '' + string + } + + var len = string.length + if (len === 0) return 0 + + // Use a for loop to avoid recursion + var loweredCase = false + for (;;) { + switch (encoding) { + case 'ascii': + case 'latin1': + case 'binary': + return len + case 'utf8': + case 'utf-8': + case undefined: + return utf8ToBytes(string).length + case 'ucs2': + case 'ucs-2': + case 'utf16le': + case 'utf-16le': + return len * 2 + case 'hex': + return len >>> 1 + case 'base64': + return base64ToBytes(string).length + default: + if (loweredCase) return utf8ToBytes(string).length // assume utf8 + encoding = ('' + encoding).toLowerCase() + loweredCase = true + } + } +} +Buffer.byteLength = byteLength + +function slowToString (encoding, start, end) { + var loweredCase = false + + // No need to verify that "this.length <= MAX_UINT32" since it's a read-only + // property of a typed array. + + // This behaves neither like String nor Uint8Array in that we set start/end + // to their upper/lower bounds if the value passed is out of range. + // undefined is handled specially as per ECMA-262 6th Edition, + // Section 13.3.3.7 Runtime Semantics: KeyedBindingInitialization. + if (start === undefined || start < 0) { + start = 0 + } + // Return early if start > this.length. Done here to prevent potential uint32 + // coercion fail below. + if (start > this.length) { + return '' + } + + if (end === undefined || end > this.length) { + end = this.length + } + + if (end <= 0) { + return '' + } + + // Force coersion to uint32. This will also coerce falsey/NaN values to 0. + end >>>= 0 + start >>>= 0 + + if (end <= start) { + return '' + } + + if (!encoding) encoding = 'utf8' + + while (true) { + switch (encoding) { + case 'hex': + return hexSlice(this, start, end) + + case 'utf8': + case 'utf-8': + return utf8Slice(this, start, end) + + case 'ascii': + return asciiSlice(this, start, end) + + case 'latin1': + case 'binary': + return latin1Slice(this, start, end) + + case 'base64': + return base64Slice(this, start, end) + + case 'ucs2': + case 'ucs-2': + case 'utf16le': + case 'utf-16le': + return utf16leSlice(this, start, end) + + default: + if (loweredCase) throw new TypeError('Unknown encoding: ' + encoding) + encoding = (encoding + '').toLowerCase() + loweredCase = true + } + } +} + +// The property is used by `Buffer.isBuffer` and `is-buffer` (in Safari 5-7) to detect +// Buffer instances. +Buffer.prototype._isBuffer = true + +function swap (b, n, m) { + var i = b[n] + b[n] = b[m] + b[m] = i +} + +Buffer.prototype.swap16 = function swap16 () { + var len = this.length + if (len % 2 !== 0) { + throw new RangeError('Buffer size must be a multiple of 16-bits') + } + for (var i = 0; i < len; i += 2) { + swap(this, i, i + 1) + } + return this +} + +Buffer.prototype.swap32 = function swap32 () { + var len = this.length + if (len % 4 !== 0) { + throw new RangeError('Buffer size must be a multiple of 32-bits') + } + for (var i = 0; i < len; i += 4) { + swap(this, i, i + 3) + swap(this, i + 1, i + 2) + } + return this +} + +Buffer.prototype.swap64 = function swap64 () { + var len = this.length + if (len % 8 !== 0) { + throw new RangeError('Buffer size must be a multiple of 64-bits') + } + for (var i = 0; i < len; i += 8) { + swap(this, i, i + 7) + swap(this, i + 1, i + 6) + swap(this, i + 2, i + 5) + swap(this, i + 3, i + 4) + } + return this +} + +Buffer.prototype.toString = function toString () { + var length = this.length | 0 + if (length === 0) return '' + if (arguments.length === 0) return utf8Slice(this, 0, length) + return slowToString.apply(this, arguments) +} + +Buffer.prototype.equals = function equals (b) { + if (!Buffer.isBuffer(b)) throw new TypeError('Argument must be a Buffer') + if (this === b) return true + return Buffer.compare(this, b) === 0 +} + +Buffer.prototype.inspect = function inspect () { + var str = '' + var max = exports.INSPECT_MAX_BYTES + if (this.length > 0) { + str = this.toString('hex', 0, max).match(/.{2}/g).join(' ') + if (this.length > max) str += ' ... ' + } + return '' +} + +Buffer.prototype.compare = function compare (target, start, end, thisStart, thisEnd) { + if (!Buffer.isBuffer(target)) { + throw new TypeError('Argument must be a Buffer') + } + + if (start === undefined) { + start = 0 + } + if (end === undefined) { + end = target ? target.length : 0 + } + if (thisStart === undefined) { + thisStart = 0 + } + if (thisEnd === undefined) { + thisEnd = this.length + } + + if (start < 0 || end > target.length || thisStart < 0 || thisEnd > this.length) { + throw new RangeError('out of range index') + } + + if (thisStart >= thisEnd && start >= end) { + return 0 + } + if (thisStart >= thisEnd) { + return -1 + } + if (start >= end) { + return 1 + } + + start >>>= 0 + end >>>= 0 + thisStart >>>= 0 + thisEnd >>>= 0 + + if (this === target) return 0 + + var x = thisEnd - thisStart + var y = end - start + var len = Math.min(x, y) + + var thisCopy = this.slice(thisStart, thisEnd) + var targetCopy = target.slice(start, end) + + for (var i = 0; i < len; ++i) { + if (thisCopy[i] !== targetCopy[i]) { + x = thisCopy[i] + y = targetCopy[i] + break + } + } + + if (x < y) return -1 + if (y < x) return 1 + return 0 +} + +// Finds either the first index of `val` in `buffer` at offset >= `byteOffset`, +// OR the last index of `val` in `buffer` at offset <= `byteOffset`. +// +// Arguments: +// - buffer - a Buffer to search +// - val - a string, Buffer, or number +// - byteOffset - an index into `buffer`; will be clamped to an int32 +// - encoding - an optional encoding, relevant is val is a string +// - dir - true for indexOf, false for lastIndexOf +function bidirectionalIndexOf (buffer, val, byteOffset, encoding, dir) { + // Empty buffer means no match + if (buffer.length === 0) return -1 + + // Normalize byteOffset + if (typeof byteOffset === 'string') { + encoding = byteOffset + byteOffset = 0 + } else if (byteOffset > 0x7fffffff) { + byteOffset = 0x7fffffff + } else if (byteOffset < -0x80000000) { + byteOffset = -0x80000000 + } + byteOffset = +byteOffset // Coerce to Number. + if (isNaN(byteOffset)) { + // byteOffset: it it's undefined, null, NaN, "foo", etc, search whole buffer + byteOffset = dir ? 0 : (buffer.length - 1) + } + + // Normalize byteOffset: negative offsets start from the end of the buffer + if (byteOffset < 0) byteOffset = buffer.length + byteOffset + if (byteOffset >= buffer.length) { + if (dir) return -1 + else byteOffset = buffer.length - 1 + } else if (byteOffset < 0) { + if (dir) byteOffset = 0 + else return -1 + } + + // Normalize val + if (typeof val === 'string') { + val = Buffer.from(val, encoding) + } + + // Finally, search either indexOf (if dir is true) or lastIndexOf + if (Buffer.isBuffer(val)) { + // Special case: looking for empty string/buffer always fails + if (val.length === 0) { + return -1 + } + return arrayIndexOf(buffer, val, byteOffset, encoding, dir) + } else if (typeof val === 'number') { + val = val & 0xFF // Search for a byte value [0-255] + if (Buffer.TYPED_ARRAY_SUPPORT && + typeof Uint8Array.prototype.indexOf === 'function') { + if (dir) { + return Uint8Array.prototype.indexOf.call(buffer, val, byteOffset) + } else { + return Uint8Array.prototype.lastIndexOf.call(buffer, val, byteOffset) + } + } + return arrayIndexOf(buffer, [ val ], byteOffset, encoding, dir) + } + + throw new TypeError('val must be string, number or Buffer') +} + +function arrayIndexOf (arr, val, byteOffset, encoding, dir) { + var indexSize = 1 + var arrLength = arr.length + var valLength = val.length + + if (encoding !== undefined) { + encoding = String(encoding).toLowerCase() + if (encoding === 'ucs2' || encoding === 'ucs-2' || + encoding === 'utf16le' || encoding === 'utf-16le') { + if (arr.length < 2 || val.length < 2) { + return -1 + } + indexSize = 2 + arrLength /= 2 + valLength /= 2 + byteOffset /= 2 + } + } + + function read (buf, i) { + if (indexSize === 1) { + return buf[i] + } else { + return buf.readUInt16BE(i * indexSize) + } + } + + var i + if (dir) { + var foundIndex = -1 + for (i = byteOffset; i < arrLength; i++) { + if (read(arr, i) === read(val, foundIndex === -1 ? 0 : i - foundIndex)) { + if (foundIndex === -1) foundIndex = i + if (i - foundIndex + 1 === valLength) return foundIndex * indexSize + } else { + if (foundIndex !== -1) i -= i - foundIndex + foundIndex = -1 + } + } + } else { + if (byteOffset + valLength > arrLength) byteOffset = arrLength - valLength + for (i = byteOffset; i >= 0; i--) { + var found = true + for (var j = 0; j < valLength; j++) { + if (read(arr, i + j) !== read(val, j)) { + found = false + break + } + } + if (found) return i + } + } + + return -1 +} + +Buffer.prototype.includes = function includes (val, byteOffset, encoding) { + return this.indexOf(val, byteOffset, encoding) !== -1 +} + +Buffer.prototype.indexOf = function indexOf (val, byteOffset, encoding) { + return bidirectionalIndexOf(this, val, byteOffset, encoding, true) +} + +Buffer.prototype.lastIndexOf = function lastIndexOf (val, byteOffset, encoding) { + return bidirectionalIndexOf(this, val, byteOffset, encoding, false) +} + +function hexWrite (buf, string, offset, length) { + offset = Number(offset) || 0 + var remaining = buf.length - offset + if (!length) { + length = remaining + } else { + length = Number(length) + if (length > remaining) { + length = remaining + } + } + + // must be an even number of digits + var strLen = string.length + if (strLen % 2 !== 0) throw new TypeError('Invalid hex string') + + if (length > strLen / 2) { + length = strLen / 2 + } + for (var i = 0; i < length; ++i) { + var parsed = parseInt(string.substr(i * 2, 2), 16) + if (isNaN(parsed)) return i + buf[offset + i] = parsed + } + return i +} + +function utf8Write (buf, string, offset, length) { + return blitBuffer(utf8ToBytes(string, buf.length - offset), buf, offset, length) +} + +function asciiWrite (buf, string, offset, length) { + return blitBuffer(asciiToBytes(string), buf, offset, length) +} + +function latin1Write (buf, string, offset, length) { + return asciiWrite(buf, string, offset, length) +} + +function base64Write (buf, string, offset, length) { + return blitBuffer(base64ToBytes(string), buf, offset, length) +} + +function ucs2Write (buf, string, offset, length) { + return blitBuffer(utf16leToBytes(string, buf.length - offset), buf, offset, length) +} + +Buffer.prototype.write = function write (string, offset, length, encoding) { + // Buffer#write(string) + if (offset === undefined) { + encoding = 'utf8' + length = this.length + offset = 0 + // Buffer#write(string, encoding) + } else if (length === undefined && typeof offset === 'string') { + encoding = offset + length = this.length + offset = 0 + // Buffer#write(string, offset[, length][, encoding]) + } else if (isFinite(offset)) { + offset = offset | 0 + if (isFinite(length)) { + length = length | 0 + if (encoding === undefined) encoding = 'utf8' + } else { + encoding = length + length = undefined + } + // legacy write(string, encoding, offset, length) - remove in v0.13 + } else { + throw new Error( + 'Buffer.write(string, encoding, offset[, length]) is no longer supported' + ) + } + + var remaining = this.length - offset + if (length === undefined || length > remaining) length = remaining + + if ((string.length > 0 && (length < 0 || offset < 0)) || offset > this.length) { + throw new RangeError('Attempt to write outside buffer bounds') + } + + if (!encoding) encoding = 'utf8' + + var loweredCase = false + for (;;) { + switch (encoding) { + case 'hex': + return hexWrite(this, string, offset, length) + + case 'utf8': + case 'utf-8': + return utf8Write(this, string, offset, length) + + case 'ascii': + return asciiWrite(this, string, offset, length) + + case 'latin1': + case 'binary': + return latin1Write(this, string, offset, length) + + case 'base64': + // Warning: maxLength not taken into account in base64Write + return base64Write(this, string, offset, length) + + case 'ucs2': + case 'ucs-2': + case 'utf16le': + case 'utf-16le': + return ucs2Write(this, string, offset, length) + + default: + if (loweredCase) throw new TypeError('Unknown encoding: ' + encoding) + encoding = ('' + encoding).toLowerCase() + loweredCase = true + } + } +} + +Buffer.prototype.toJSON = function toJSON () { + return { + type: 'Buffer', + data: Array.prototype.slice.call(this._arr || this, 0) + } +} + +function base64Slice (buf, start, end) { + if (start === 0 && end === buf.length) { + return base64.fromByteArray(buf) + } else { + return base64.fromByteArray(buf.slice(start, end)) + } +} + +function utf8Slice (buf, start, end) { + end = Math.min(buf.length, end) + var res = [] + + var i = start + while (i < end) { + var firstByte = buf[i] + var codePoint = null + var bytesPerSequence = (firstByte > 0xEF) ? 4 + : (firstByte > 0xDF) ? 3 + : (firstByte > 0xBF) ? 2 + : 1 + + if (i + bytesPerSequence <= end) { + var secondByte, thirdByte, fourthByte, tempCodePoint + + switch (bytesPerSequence) { + case 1: + if (firstByte < 0x80) { + codePoint = firstByte + } + break + case 2: + secondByte = buf[i + 1] + if ((secondByte & 0xC0) === 0x80) { + tempCodePoint = (firstByte & 0x1F) << 0x6 | (secondByte & 0x3F) + if (tempCodePoint > 0x7F) { + codePoint = tempCodePoint + } + } + break + case 3: + secondByte = buf[i + 1] + thirdByte = buf[i + 2] + if ((secondByte & 0xC0) === 0x80 && (thirdByte & 0xC0) === 0x80) { + tempCodePoint = (firstByte & 0xF) << 0xC | (secondByte & 0x3F) << 0x6 | (thirdByte & 0x3F) + if (tempCodePoint > 0x7FF && (tempCodePoint < 0xD800 || tempCodePoint > 0xDFFF)) { + codePoint = tempCodePoint + } + } + break + case 4: + secondByte = buf[i + 1] + thirdByte = buf[i + 2] + fourthByte = buf[i + 3] + if ((secondByte & 0xC0) === 0x80 && (thirdByte & 0xC0) === 0x80 && (fourthByte & 0xC0) === 0x80) { + tempCodePoint = (firstByte & 0xF) << 0x12 | (secondByte & 0x3F) << 0xC | (thirdByte & 0x3F) << 0x6 | (fourthByte & 0x3F) + if (tempCodePoint > 0xFFFF && tempCodePoint < 0x110000) { + codePoint = tempCodePoint + } + } + } + } + + if (codePoint === null) { + // we did not generate a valid codePoint so insert a + // replacement char (U+FFFD) and advance only 1 byte + codePoint = 0xFFFD + bytesPerSequence = 1 + } else if (codePoint > 0xFFFF) { + // encode to utf16 (surrogate pair dance) + codePoint -= 0x10000 + res.push(codePoint >>> 10 & 0x3FF | 0xD800) + codePoint = 0xDC00 | codePoint & 0x3FF + } + + res.push(codePoint) + i += bytesPerSequence + } + + return decodeCodePointsArray(res) +} + +// Based on http://stackoverflow.com/a/22747272/680742, the browser with +// the lowest limit is Chrome, with 0x10000 args. +// We go 1 magnitude less, for safety +var MAX_ARGUMENTS_LENGTH = 0x1000 + +function decodeCodePointsArray (codePoints) { + var len = codePoints.length + if (len <= MAX_ARGUMENTS_LENGTH) { + return String.fromCharCode.apply(String, codePoints) // avoid extra slice() + } + + // Decode in chunks to avoid "call stack size exceeded". + var res = '' + var i = 0 + while (i < len) { + res += String.fromCharCode.apply( + String, + codePoints.slice(i, i += MAX_ARGUMENTS_LENGTH) + ) + } + return res +} + +function asciiSlice (buf, start, end) { + var ret = '' + end = Math.min(buf.length, end) + + for (var i = start; i < end; ++i) { + ret += String.fromCharCode(buf[i] & 0x7F) + } + return ret +} + +function latin1Slice (buf, start, end) { + var ret = '' + end = Math.min(buf.length, end) + + for (var i = start; i < end; ++i) { + ret += String.fromCharCode(buf[i]) + } + return ret +} + +function hexSlice (buf, start, end) { + var len = buf.length + + if (!start || start < 0) start = 0 + if (!end || end < 0 || end > len) end = len + + var out = '' + for (var i = start; i < end; ++i) { + out += toHex(buf[i]) + } + return out +} + +function utf16leSlice (buf, start, end) { + var bytes = buf.slice(start, end) + var res = '' + for (var i = 0; i < bytes.length; i += 2) { + res += String.fromCharCode(bytes[i] + bytes[i + 1] * 256) + } + return res +} + +Buffer.prototype.slice = function slice (start, end) { + var len = this.length + start = ~~start + end = end === undefined ? len : ~~end + + if (start < 0) { + start += len + if (start < 0) start = 0 + } else if (start > len) { + start = len + } + + if (end < 0) { + end += len + if (end < 0) end = 0 + } else if (end > len) { + end = len + } + + if (end < start) end = start + + var newBuf + if (Buffer.TYPED_ARRAY_SUPPORT) { + newBuf = this.subarray(start, end) + newBuf.__proto__ = Buffer.prototype + } else { + var sliceLen = end - start + newBuf = new Buffer(sliceLen, undefined) + for (var i = 0; i < sliceLen; ++i) { + newBuf[i] = this[i + start] + } + } + + return newBuf +} + +/* + * Need to make sure that buffer isn't trying to write out of bounds. + */ +function checkOffset (offset, ext, length) { + if ((offset % 1) !== 0 || offset < 0) throw new RangeError('offset is not uint') + if (offset + ext > length) throw new RangeError('Trying to access beyond buffer length') +} + +Buffer.prototype.readUIntLE = function readUIntLE (offset, byteLength, noAssert) { + offset = offset | 0 + byteLength = byteLength | 0 + if (!noAssert) checkOffset(offset, byteLength, this.length) + + var val = this[offset] + var mul = 1 + var i = 0 + while (++i < byteLength && (mul *= 0x100)) { + val += this[offset + i] * mul + } + + return val +} + +Buffer.prototype.readUIntBE = function readUIntBE (offset, byteLength, noAssert) { + offset = offset | 0 + byteLength = byteLength | 0 + if (!noAssert) { + checkOffset(offset, byteLength, this.length) + } + + var val = this[offset + --byteLength] + var mul = 1 + while (byteLength > 0 && (mul *= 0x100)) { + val += this[offset + --byteLength] * mul + } + + return val +} + +Buffer.prototype.readUInt8 = function readUInt8 (offset, noAssert) { + if (!noAssert) checkOffset(offset, 1, this.length) + return this[offset] +} + +Buffer.prototype.readUInt16LE = function readUInt16LE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 2, this.length) + return this[offset] | (this[offset + 1] << 8) +} + +Buffer.prototype.readUInt16BE = function readUInt16BE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 2, this.length) + return (this[offset] << 8) | this[offset + 1] +} + +Buffer.prototype.readUInt32LE = function readUInt32LE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 4, this.length) + + return ((this[offset]) | + (this[offset + 1] << 8) | + (this[offset + 2] << 16)) + + (this[offset + 3] * 0x1000000) +} + +Buffer.prototype.readUInt32BE = function readUInt32BE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 4, this.length) + + return (this[offset] * 0x1000000) + + ((this[offset + 1] << 16) | + (this[offset + 2] << 8) | + this[offset + 3]) +} + +Buffer.prototype.readIntLE = function readIntLE (offset, byteLength, noAssert) { + offset = offset | 0 + byteLength = byteLength | 0 + if (!noAssert) checkOffset(offset, byteLength, this.length) + + var val = this[offset] + var mul = 1 + var i = 0 + while (++i < byteLength && (mul *= 0x100)) { + val += this[offset + i] * mul + } + mul *= 0x80 + + if (val >= mul) val -= Math.pow(2, 8 * byteLength) + + return val +} + +Buffer.prototype.readIntBE = function readIntBE (offset, byteLength, noAssert) { + offset = offset | 0 + byteLength = byteLength | 0 + if (!noAssert) checkOffset(offset, byteLength, this.length) + + var i = byteLength + var mul = 1 + var val = this[offset + --i] + while (i > 0 && (mul *= 0x100)) { + val += this[offset + --i] * mul + } + mul *= 0x80 + + if (val >= mul) val -= Math.pow(2, 8 * byteLength) + + return val +} + +Buffer.prototype.readInt8 = function readInt8 (offset, noAssert) { + if (!noAssert) checkOffset(offset, 1, this.length) + if (!(this[offset] & 0x80)) return (this[offset]) + return ((0xff - this[offset] + 1) * -1) +} + +Buffer.prototype.readInt16LE = function readInt16LE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 2, this.length) + var val = this[offset] | (this[offset + 1] << 8) + return (val & 0x8000) ? val | 0xFFFF0000 : val +} + +Buffer.prototype.readInt16BE = function readInt16BE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 2, this.length) + var val = this[offset + 1] | (this[offset] << 8) + return (val & 0x8000) ? val | 0xFFFF0000 : val +} + +Buffer.prototype.readInt32LE = function readInt32LE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 4, this.length) + + return (this[offset]) | + (this[offset + 1] << 8) | + (this[offset + 2] << 16) | + (this[offset + 3] << 24) +} + +Buffer.prototype.readInt32BE = function readInt32BE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 4, this.length) + + return (this[offset] << 24) | + (this[offset + 1] << 16) | + (this[offset + 2] << 8) | + (this[offset + 3]) +} + +Buffer.prototype.readFloatLE = function readFloatLE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 4, this.length) + return ieee754.read(this, offset, true, 23, 4) +} + +Buffer.prototype.readFloatBE = function readFloatBE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 4, this.length) + return ieee754.read(this, offset, false, 23, 4) +} + +Buffer.prototype.readDoubleLE = function readDoubleLE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 8, this.length) + return ieee754.read(this, offset, true, 52, 8) +} + +Buffer.prototype.readDoubleBE = function readDoubleBE (offset, noAssert) { + if (!noAssert) checkOffset(offset, 8, this.length) + return ieee754.read(this, offset, false, 52, 8) +} + +function checkInt (buf, value, offset, ext, max, min) { + if (!Buffer.isBuffer(buf)) throw new TypeError('"buffer" argument must be a Buffer instance') + if (value > max || value < min) throw new RangeError('"value" argument is out of bounds') + if (offset + ext > buf.length) throw new RangeError('Index out of range') +} + +Buffer.prototype.writeUIntLE = function writeUIntLE (value, offset, byteLength, noAssert) { + value = +value + offset = offset | 0 + byteLength = byteLength | 0 + if (!noAssert) { + var maxBytes = Math.pow(2, 8 * byteLength) - 1 + checkInt(this, value, offset, byteLength, maxBytes, 0) + } + + var mul = 1 + var i = 0 + this[offset] = value & 0xFF + while (++i < byteLength && (mul *= 0x100)) { + this[offset + i] = (value / mul) & 0xFF + } + + return offset + byteLength +} + +Buffer.prototype.writeUIntBE = function writeUIntBE (value, offset, byteLength, noAssert) { + value = +value + offset = offset | 0 + byteLength = byteLength | 0 + if (!noAssert) { + var maxBytes = Math.pow(2, 8 * byteLength) - 1 + checkInt(this, value, offset, byteLength, maxBytes, 0) + } + + var i = byteLength - 1 + var mul = 1 + this[offset + i] = value & 0xFF + while (--i >= 0 && (mul *= 0x100)) { + this[offset + i] = (value / mul) & 0xFF + } + + return offset + byteLength +} + +Buffer.prototype.writeUInt8 = function writeUInt8 (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 1, 0xff, 0) + if (!Buffer.TYPED_ARRAY_SUPPORT) value = Math.floor(value) + this[offset] = (value & 0xff) + return offset + 1 +} + +function objectWriteUInt16 (buf, value, offset, littleEndian) { + if (value < 0) value = 0xffff + value + 1 + for (var i = 0, j = Math.min(buf.length - offset, 2); i < j; ++i) { + buf[offset + i] = (value & (0xff << (8 * (littleEndian ? i : 1 - i)))) >>> + (littleEndian ? i : 1 - i) * 8 + } +} + +Buffer.prototype.writeUInt16LE = function writeUInt16LE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 2, 0xffff, 0) + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset] = (value & 0xff) + this[offset + 1] = (value >>> 8) + } else { + objectWriteUInt16(this, value, offset, true) + } + return offset + 2 +} + +Buffer.prototype.writeUInt16BE = function writeUInt16BE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 2, 0xffff, 0) + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset] = (value >>> 8) + this[offset + 1] = (value & 0xff) + } else { + objectWriteUInt16(this, value, offset, false) + } + return offset + 2 +} + +function objectWriteUInt32 (buf, value, offset, littleEndian) { + if (value < 0) value = 0xffffffff + value + 1 + for (var i = 0, j = Math.min(buf.length - offset, 4); i < j; ++i) { + buf[offset + i] = (value >>> (littleEndian ? i : 3 - i) * 8) & 0xff + } +} + +Buffer.prototype.writeUInt32LE = function writeUInt32LE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 4, 0xffffffff, 0) + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset + 3] = (value >>> 24) + this[offset + 2] = (value >>> 16) + this[offset + 1] = (value >>> 8) + this[offset] = (value & 0xff) + } else { + objectWriteUInt32(this, value, offset, true) + } + return offset + 4 +} + +Buffer.prototype.writeUInt32BE = function writeUInt32BE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 4, 0xffffffff, 0) + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset] = (value >>> 24) + this[offset + 1] = (value >>> 16) + this[offset + 2] = (value >>> 8) + this[offset + 3] = (value & 0xff) + } else { + objectWriteUInt32(this, value, offset, false) + } + return offset + 4 +} + +Buffer.prototype.writeIntLE = function writeIntLE (value, offset, byteLength, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) { + var limit = Math.pow(2, 8 * byteLength - 1) + + checkInt(this, value, offset, byteLength, limit - 1, -limit) + } + + var i = 0 + var mul = 1 + var sub = 0 + this[offset] = value & 0xFF + while (++i < byteLength && (mul *= 0x100)) { + if (value < 0 && sub === 0 && this[offset + i - 1] !== 0) { + sub = 1 + } + this[offset + i] = ((value / mul) >> 0) - sub & 0xFF + } + + return offset + byteLength +} + +Buffer.prototype.writeIntBE = function writeIntBE (value, offset, byteLength, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) { + var limit = Math.pow(2, 8 * byteLength - 1) + + checkInt(this, value, offset, byteLength, limit - 1, -limit) + } + + var i = byteLength - 1 + var mul = 1 + var sub = 0 + this[offset + i] = value & 0xFF + while (--i >= 0 && (mul *= 0x100)) { + if (value < 0 && sub === 0 && this[offset + i + 1] !== 0) { + sub = 1 + } + this[offset + i] = ((value / mul) >> 0) - sub & 0xFF + } + + return offset + byteLength +} + +Buffer.prototype.writeInt8 = function writeInt8 (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 1, 0x7f, -0x80) + if (!Buffer.TYPED_ARRAY_SUPPORT) value = Math.floor(value) + if (value < 0) value = 0xff + value + 1 + this[offset] = (value & 0xff) + return offset + 1 +} + +Buffer.prototype.writeInt16LE = function writeInt16LE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 2, 0x7fff, -0x8000) + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset] = (value & 0xff) + this[offset + 1] = (value >>> 8) + } else { + objectWriteUInt16(this, value, offset, true) + } + return offset + 2 +} + +Buffer.prototype.writeInt16BE = function writeInt16BE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 2, 0x7fff, -0x8000) + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset] = (value >>> 8) + this[offset + 1] = (value & 0xff) + } else { + objectWriteUInt16(this, value, offset, false) + } + return offset + 2 +} + +Buffer.prototype.writeInt32LE = function writeInt32LE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 4, 0x7fffffff, -0x80000000) + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset] = (value & 0xff) + this[offset + 1] = (value >>> 8) + this[offset + 2] = (value >>> 16) + this[offset + 3] = (value >>> 24) + } else { + objectWriteUInt32(this, value, offset, true) + } + return offset + 4 +} + +Buffer.prototype.writeInt32BE = function writeInt32BE (value, offset, noAssert) { + value = +value + offset = offset | 0 + if (!noAssert) checkInt(this, value, offset, 4, 0x7fffffff, -0x80000000) + if (value < 0) value = 0xffffffff + value + 1 + if (Buffer.TYPED_ARRAY_SUPPORT) { + this[offset] = (value >>> 24) + this[offset + 1] = (value >>> 16) + this[offset + 2] = (value >>> 8) + this[offset + 3] = (value & 0xff) + } else { + objectWriteUInt32(this, value, offset, false) + } + return offset + 4 +} + +function checkIEEE754 (buf, value, offset, ext, max, min) { + if (offset + ext > buf.length) throw new RangeError('Index out of range') + if (offset < 0) throw new RangeError('Index out of range') +} + +function writeFloat (buf, value, offset, littleEndian, noAssert) { + if (!noAssert) { + checkIEEE754(buf, value, offset, 4, 3.4028234663852886e+38, -3.4028234663852886e+38) + } + ieee754.write(buf, value, offset, littleEndian, 23, 4) + return offset + 4 +} + +Buffer.prototype.writeFloatLE = function writeFloatLE (value, offset, noAssert) { + return writeFloat(this, value, offset, true, noAssert) +} + +Buffer.prototype.writeFloatBE = function writeFloatBE (value, offset, noAssert) { + return writeFloat(this, value, offset, false, noAssert) +} + +function writeDouble (buf, value, offset, littleEndian, noAssert) { + if (!noAssert) { + checkIEEE754(buf, value, offset, 8, 1.7976931348623157E+308, -1.7976931348623157E+308) + } + ieee754.write(buf, value, offset, littleEndian, 52, 8) + return offset + 8 +} + +Buffer.prototype.writeDoubleLE = function writeDoubleLE (value, offset, noAssert) { + return writeDouble(this, value, offset, true, noAssert) +} + +Buffer.prototype.writeDoubleBE = function writeDoubleBE (value, offset, noAssert) { + return writeDouble(this, value, offset, false, noAssert) +} + +// copy(targetBuffer, targetStart=0, sourceStart=0, sourceEnd=buffer.length) +Buffer.prototype.copy = function copy (target, targetStart, start, end) { + if (!start) start = 0 + if (!end && end !== 0) end = this.length + if (targetStart >= target.length) targetStart = target.length + if (!targetStart) targetStart = 0 + if (end > 0 && end < start) end = start + + // Copy 0 bytes; we're done + if (end === start) return 0 + if (target.length === 0 || this.length === 0) return 0 + + // Fatal error conditions + if (targetStart < 0) { + throw new RangeError('targetStart out of bounds') + } + if (start < 0 || start >= this.length) throw new RangeError('sourceStart out of bounds') + if (end < 0) throw new RangeError('sourceEnd out of bounds') + + // Are we oob? + if (end > this.length) end = this.length + if (target.length - targetStart < end - start) { + end = target.length - targetStart + start + } + + var len = end - start + var i + + if (this === target && start < targetStart && targetStart < end) { + // descending copy from end + for (i = len - 1; i >= 0; --i) { + target[i + targetStart] = this[i + start] + } + } else if (len < 1000 || !Buffer.TYPED_ARRAY_SUPPORT) { + // ascending copy from start + for (i = 0; i < len; ++i) { + target[i + targetStart] = this[i + start] + } + } else { + Uint8Array.prototype.set.call( + target, + this.subarray(start, start + len), + targetStart + ) + } + + return len +} + +// Usage: +// buffer.fill(number[, offset[, end]]) +// buffer.fill(buffer[, offset[, end]]) +// buffer.fill(string[, offset[, end]][, encoding]) +Buffer.prototype.fill = function fill (val, start, end, encoding) { + // Handle string cases: + if (typeof val === 'string') { + if (typeof start === 'string') { + encoding = start + start = 0 + end = this.length + } else if (typeof end === 'string') { + encoding = end + end = this.length + } + if (val.length === 1) { + var code = val.charCodeAt(0) + if (code < 256) { + val = code + } + } + if (encoding !== undefined && typeof encoding !== 'string') { + throw new TypeError('encoding must be a string') + } + if (typeof encoding === 'string' && !Buffer.isEncoding(encoding)) { + throw new TypeError('Unknown encoding: ' + encoding) + } + } else if (typeof val === 'number') { + val = val & 255 + } + + // Invalid ranges are not set to a default, so can range check early. + if (start < 0 || this.length < start || this.length < end) { + throw new RangeError('Out of range index') + } + + if (end <= start) { + return this + } + + start = start >>> 0 + end = end === undefined ? this.length : end >>> 0 + + if (!val) val = 0 + + var i + if (typeof val === 'number') { + for (i = start; i < end; ++i) { + this[i] = val + } + } else { + var bytes = Buffer.isBuffer(val) + ? val + : utf8ToBytes(new Buffer(val, encoding).toString()) + var len = bytes.length + for (i = 0; i < end - start; ++i) { + this[i + start] = bytes[i % len] + } + } + + return this +} + +// HELPER FUNCTIONS +// ================ + +var INVALID_BASE64_RE = /[^+\/0-9A-Za-z-_]/g + +function base64clean (str) { + // Node strips out invalid characters like \n and \t from the string, base64-js does not + str = stringtrim(str).replace(INVALID_BASE64_RE, '') + // Node converts strings with length < 2 to '' + if (str.length < 2) return '' + // Node allows for non-padded base64 strings (missing trailing ===), base64-js does not + while (str.length % 4 !== 0) { + str = str + '=' + } + return str +} + +function stringtrim (str) { + if (str.trim) return str.trim() + return str.replace(/^\s+|\s+$/g, '') +} + +function toHex (n) { + if (n < 16) return '0' + n.toString(16) + return n.toString(16) +} + +function utf8ToBytes (string, units) { + units = units || Infinity + var codePoint + var length = string.length + var leadSurrogate = null + var bytes = [] + + for (var i = 0; i < length; ++i) { + codePoint = string.charCodeAt(i) + + // is surrogate component + if (codePoint > 0xD7FF && codePoint < 0xE000) { + // last char was a lead + if (!leadSurrogate) { + // no lead yet + if (codePoint > 0xDBFF) { + // unexpected trail + if ((units -= 3) > -1) bytes.push(0xEF, 0xBF, 0xBD) + continue + } else if (i + 1 === length) { + // unpaired lead + if ((units -= 3) > -1) bytes.push(0xEF, 0xBF, 0xBD) + continue + } + + // valid lead + leadSurrogate = codePoint + + continue + } + + // 2 leads in a row + if (codePoint < 0xDC00) { + if ((units -= 3) > -1) bytes.push(0xEF, 0xBF, 0xBD) + leadSurrogate = codePoint + continue + } + + // valid surrogate pair + codePoint = (leadSurrogate - 0xD800 << 10 | codePoint - 0xDC00) + 0x10000 + } else if (leadSurrogate) { + // valid bmp char, but last char was a lead + if ((units -= 3) > -1) bytes.push(0xEF, 0xBF, 0xBD) + } + + leadSurrogate = null + + // encode utf8 + if (codePoint < 0x80) { + if ((units -= 1) < 0) break + bytes.push(codePoint) + } else if (codePoint < 0x800) { + if ((units -= 2) < 0) break + bytes.push( + codePoint >> 0x6 | 0xC0, + codePoint & 0x3F | 0x80 + ) + } else if (codePoint < 0x10000) { + if ((units -= 3) < 0) break + bytes.push( + codePoint >> 0xC | 0xE0, + codePoint >> 0x6 & 0x3F | 0x80, + codePoint & 0x3F | 0x80 + ) + } else if (codePoint < 0x110000) { + if ((units -= 4) < 0) break + bytes.push( + codePoint >> 0x12 | 0xF0, + codePoint >> 0xC & 0x3F | 0x80, + codePoint >> 0x6 & 0x3F | 0x80, + codePoint & 0x3F | 0x80 + ) + } else { + throw new Error('Invalid code point') + } + } + + return bytes +} + +function asciiToBytes (str) { + var byteArray = [] + for (var i = 0; i < str.length; ++i) { + // Node's code seems to be doing this and not & 0x7F.. + byteArray.push(str.charCodeAt(i) & 0xFF) + } + return byteArray +} + +function utf16leToBytes (str, units) { + var c, hi, lo + var byteArray = [] + for (var i = 0; i < str.length; ++i) { + if ((units -= 2) < 0) break + + c = str.charCodeAt(i) + hi = c >> 8 + lo = c % 256 + byteArray.push(lo) + byteArray.push(hi) + } + + return byteArray +} + +function base64ToBytes (str) { + return base64.toByteArray(base64clean(str)) +} + +function blitBuffer (src, dst, offset, length) { + for (var i = 0; i < length; ++i) { + if ((i + offset >= dst.length) || (i >= src.length)) break + dst[i + offset] = src[i] + } + return i +} + +function isnan (val) { + return val !== val // eslint-disable-line no-self-compare +} diff --git a/node_modules/buffer/package.json b/node_modules/buffer/package.json new file mode 100644 index 0000000..bfecc51 --- /dev/null +++ b/node_modules/buffer/package.json @@ -0,0 +1,108 @@ +{ + "_from": "buffer@4.9.1", + "_id": "buffer@4.9.1", + "_inBundle": false, + "_integrity": "sha1-bRu2AbB6TvztlwlBMgkwJ8lbwpg=", + "_location": "/buffer", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "buffer@4.9.1", + "name": "buffer", + "escapedName": "buffer", + "rawSpec": "4.9.1", + "saveSpec": null, + "fetchSpec": "4.9.1" + }, + "_requiredBy": [ + "/aws-sdk" + ], + "_resolved": "https://registry.npmjs.org/buffer/-/buffer-4.9.1.tgz", + "_shasum": "6d1bb601b07a4efced97094132093027c95bc298", + "_spec": "buffer@4.9.1", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/aws-sdk", + "author": { + "name": "Feross Aboukhadijeh", + "email": "feross@feross.org", + "url": "http://feross.org" + }, + "bugs": { + "url": "https://github.com/feross/buffer/issues" + }, + "bundleDependencies": false, + "contributors": [ + { + "name": "Romain Beauxis", + "email": "toots@rastageeks.org" + }, + { + "name": "James Halliday", + "email": "mail@substack.net" + } + ], + "dependencies": { + "base64-js": "^1.0.2", + "ieee754": "^1.1.4", + "isarray": "^1.0.0" + }, + "deprecated": false, + "description": "Node.js Buffer API, for the browser", + "devDependencies": { + "benchmark": "^2.0.0", + "browserify": "^13.0.0", + "concat-stream": "^1.4.7", + "hyperquest": "^2.0.0", + "is-buffer": "^1.1.1", + "is-nan": "^1.0.1", + "split": "^1.0.0", + "standard": "^7.0.0", + "tape": "^4.0.0", + "through2": "^2.0.0", + "zuul": "^3.0.0" + }, + "homepage": "https://github.com/feross/buffer", + "jspm": { + "map": { + "./index.js": { + "node": "@node/buffer" + } + } + }, + "keywords": [ + "arraybuffer", + "browser", + "browserify", + "buffer", + "compatible", + "dataview", + "uint8array" + ], + "license": "MIT", + "main": "index.js", + "name": "buffer", + "repository": { + "type": "git", + "url": "git://github.com/feross/buffer.git" + }, + "scripts": { + "perf": "browserify --debug perf/bracket-notation.js > perf/bundle.js && open perf/index.html", + "perf-node": "node perf/bracket-notation.js && node perf/concat.js && node perf/copy-big.js && node perf/copy.js && node perf/new-big.js && node perf/new.js && node perf/readDoubleBE.js && node perf/readFloatBE.js && node perf/readUInt32LE.js && node perf/slice.js && node perf/writeFloatBE.js", + "size": "browserify -r ./ | uglifyjs -c -m | gzip | wc -c", + "test": "standard && node ./bin/test.js", + "test-browser-es5": "zuul --ui tape -- test/*.js", + "test-browser-es5-local": "zuul --ui tape --local -- test/*.js", + "test-browser-es6": "zuul --ui tape -- test/*.js test/node/*.js", + "test-browser-es6-local": "zuul --ui tape --local -- test/*.js test/node/*.js", + "test-node": "tape test/*.js test/node/*.js && OBJECT_IMPL=true tape test/*.js", + "update-authors": "./bin/update-authors.sh" + }, + "standard": { + "ignore": [ + "test/node/*.js", + "test/_polyfill.js", + "perf/*.js" + ] + }, + "version": "4.9.1" +} diff --git a/node_modules/buffer/test/_polyfill.js b/node_modules/buffer/test/_polyfill.js new file mode 100644 index 0000000..61f9c18 --- /dev/null +++ b/node_modules/buffer/test/_polyfill.js @@ -0,0 +1,150 @@ +if (!Array.prototype.forEach) { + + Array.prototype.forEach = function(callback, thisArg) { + + var T, k; + + if (this == null) { + throw new TypeError(' this is null or not defined'); + } + + // 1. Let O be the result of calling ToObject passing the |this| value as the argument. + var O = Object(this); + + // 2. Let lenValue be the result of calling the Get internal method of O with the argument "length". + // 3. Let len be ToUint32(lenValue). + var len = O.length >>> 0; + + // 4. If IsCallable(callback) is false, throw a TypeError exception. + // See: http://es5.github.com/#x9.11 + if (typeof callback !== "function") { + throw new TypeError(callback + ' is not a function'); + } + + // 5. If thisArg was supplied, let T be thisArg; else let T be undefined. + if (arguments.length > 1) { + T = thisArg; + } + + // 6. Let k be 0 + k = 0; + + // 7. Repeat, while k < len + while (k < len) { + + var kValue; + + // a. Let Pk be ToString(k). + // This is implicit for LHS operands of the in operator + // b. Let kPresent be the result of calling the HasProperty internal method of O with argument Pk. + // This step can be combined with c + // c. If kPresent is true, then + if (k in O) { + + // i. Let kValue be the result of calling the Get internal method of O with argument Pk. + kValue = O[k]; + + // ii. Call the Call internal method of callback with T as the this value and + // argument list containing kValue, k, and O. + callback.call(T, kValue, k, O); + } + // d. Increase k by 1. + k++; + } + // 8. return undefined + }; +} + +if (!Array.isArray) { + Array.isArray = function(arg) { + return Object.prototype.toString.call(arg) === '[object Array]'; + }; +} + +if (!Array.prototype.map) { + + Array.prototype.map = function(callback, thisArg) { + + var T, A, k; + + if (this == null) { + throw new TypeError(' this is null or not defined'); + } + + // 1. Let O be the result of calling ToObject passing the |this| + // value as the argument. + var O = Object(this); + + // 2. Let lenValue be the result of calling the Get internal + // method of O with the argument "length". + // 3. Let len be ToUint32(lenValue). + var len = O.length >>> 0; + + // 4. If IsCallable(callback) is false, throw a TypeError exception. + // See: http://es5.github.com/#x9.11 + if (typeof callback !== 'function') { + throw new TypeError(callback + ' is not a function'); + } + + // 5. If thisArg was supplied, let T be thisArg; else let T be undefined. + if (arguments.length > 1) { + T = thisArg; + } + + // 6. Let A be a new array created as if by the expression new Array(len) + // where Array is the standard built-in constructor with that name and + // len is the value of len. + A = new Array(len); + + // 7. Let k be 0 + k = 0; + + // 8. Repeat, while k < len + while (k < len) { + + var kValue, mappedValue; + + // a. Let Pk be ToString(k). + // This is implicit for LHS operands of the in operator + // b. Let kPresent be the result of calling the HasProperty internal + // method of O with argument Pk. + // This step can be combined with c + // c. If kPresent is true, then + if (k in O) { + + // i. Let kValue be the result of calling the Get internal + // method of O with argument Pk. + kValue = O[k]; + + // ii. Let mappedValue be the result of calling the Call internal + // method of callback with T as the this value and argument + // list containing kValue, k, and O. + mappedValue = callback.call(T, kValue, k, O); + + // iii. Call the DefineOwnProperty internal method of A with arguments + // Pk, Property Descriptor + // { Value: mappedValue, + // Writable: true, + // Enumerable: true, + // Configurable: true }, + // and false. + + // In browsers that support Object.defineProperty, use the following: + // Object.defineProperty(A, k, { + // value: mappedValue, + // writable: true, + // enumerable: true, + // configurable: true + // }); + + // For best browser support, use the following: + A[k] = mappedValue; + } + // d. Increase k by 1. + k++; + } + + // 9. return A + return A; + }; +} diff --git a/node_modules/buffer/test/base64.js b/node_modules/buffer/test/base64.js new file mode 100644 index 0000000..e4ecc56 --- /dev/null +++ b/node_modules/buffer/test/base64.js @@ -0,0 +1,47 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('base64: ignore whitespace', function (t) { + var text = '\n YW9ldQ== ' + var buf = new B(text, 'base64') + t.equal(buf.toString(), 'aoeu') + t.end() +}) + +test('base64: strings without padding', function (t) { + t.equal((new B('YW9ldQ', 'base64').toString()), 'aoeu') + t.end() +}) + +test('base64: newline in utf8 -- should not be an issue', function (t) { + t.equal( + new B('LS0tCnRpdGxlOiBUaHJlZSBkYXNoZXMgbWFya3MgdGhlIHNwb3QKdGFnczoK', 'base64').toString('utf8'), + '---\ntitle: Three dashes marks the spot\ntags:\n' + ) + t.end() +}) + +test('base64: newline in base64 -- should get stripped', function (t) { + t.equal( + new B('LS0tCnRpdGxlOiBUaHJlZSBkYXNoZXMgbWFya3MgdGhlIHNwb3QKdGFnczoK\nICAtIHlhbWwKICAtIGZyb250LW1hdHRlcgogIC0gZGFzaGVzCmV4cGFuZWQt', 'base64').toString('utf8'), + '---\ntitle: Three dashes marks the spot\ntags:\n - yaml\n - front-matter\n - dashes\nexpaned-' + ) + t.end() +}) + +test('base64: tab characters in base64 - should get stripped', function (t) { + t.equal( + new B('LS0tCnRpdGxlOiBUaHJlZSBkYXNoZXMgbWFya3MgdGhlIHNwb3QKdGFnczoK\t\t\t\tICAtIHlhbWwKICAtIGZyb250LW1hdHRlcgogIC0gZGFzaGVzCmV4cGFuZWQt', 'base64').toString('utf8'), + '---\ntitle: Three dashes marks the spot\ntags:\n - yaml\n - front-matter\n - dashes\nexpaned-' + ) + t.end() +}) + +test('base64: invalid non-alphanumeric characters -- should be stripped', function (t) { + t.equal( + new B('!"#$%&\'()*,.:;<=>?@[\\]^`{|}~', 'base64').toString('utf8'), + '' + ) + t.end() +}) diff --git a/node_modules/buffer/test/basic.js b/node_modules/buffer/test/basic.js new file mode 100644 index 0000000..0368ed9 --- /dev/null +++ b/node_modules/buffer/test/basic.js @@ -0,0 +1,85 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('instanceof Buffer', function (t) { + var buf = new B([1, 2]) + t.ok(buf instanceof B) + t.end() +}) + +test('convert to Uint8Array in modern browsers', function (t) { + if (B.TYPED_ARRAY_SUPPORT) { + var buf = new B([1, 2]) + var uint8array = new Uint8Array(buf.buffer) + t.ok(uint8array instanceof Uint8Array) + t.equal(uint8array[0], 1) + t.equal(uint8array[1], 2) + } else { + t.pass('object impl: skipping test') + } + t.end() +}) + +test('indexes from a string', function (t) { + var buf = new B('abc') + t.equal(buf[0], 97) + t.equal(buf[1], 98) + t.equal(buf[2], 99) + t.end() +}) + +test('indexes from an array', function (t) { + var buf = new B([ 97, 98, 99 ]) + t.equal(buf[0], 97) + t.equal(buf[1], 98) + t.equal(buf[2], 99) + t.end() +}) + +test('setting index value should modify buffer contents', function (t) { + var buf = new B([ 97, 98, 99 ]) + t.equal(buf[2], 99) + t.equal(buf.toString(), 'abc') + + buf[2] += 10 + t.equal(buf[2], 109) + t.equal(buf.toString(), 'abm') + t.end() +}) + +test('storing negative number should cast to unsigned', function (t) { + var buf = new B(1) + + if (B.TYPED_ARRAY_SUPPORT) { + // This does not work with the object implementation -- nothing we can do! + buf[0] = -3 + t.equal(buf[0], 253) + } + + buf = new B(1) + buf.writeInt8(-3, 0) + t.equal(buf[0], 253) + + t.end() +}) + +test('test that memory is copied from array-like', function (t) { + if (B.TYPED_ARRAY_SUPPORT) { + var u = new Uint8Array(4) + var b = new B(u) + b[0] = 1 + b[1] = 2 + b[2] = 3 + b[3] = 4 + + t.equal(u[0], 0) + t.equal(u[1], 0) + t.equal(u[2], 0) + t.equal(u[3], 0) + } else { + t.pass('object impl: skipping test') + } + + t.end() +}) diff --git a/node_modules/buffer/test/compare.js b/node_modules/buffer/test/compare.js new file mode 100644 index 0000000..62b478c --- /dev/null +++ b/node_modules/buffer/test/compare.js @@ -0,0 +1,59 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('buffer.compare', function (t) { + var b = new B(1).fill('a') + var c = new B(1).fill('c') + var d = new B(2).fill('aa') + + t.equal(b.compare(c), -1) + t.equal(c.compare(d), 1) + t.equal(d.compare(b), 1) + t.equal(b.compare(d), -1) + + // static method + t.equal(B.compare(b, c), -1) + t.equal(B.compare(c, d), 1) + t.equal(B.compare(d, b), 1) + t.equal(B.compare(b, d), -1) + t.end() +}) + +test('buffer.compare argument validation', function (t) { + t.throws(function () { + var b = new B(1) + B.compare(b, 'abc') + }) + + t.throws(function () { + var b = new B(1) + B.compare('abc', b) + }) + + t.throws(function () { + var b = new B(1) + b.compare('abc') + }) + t.end() +}) + +test('buffer.equals', function (t) { + var b = new B(5).fill('abcdf') + var c = new B(5).fill('abcdf') + var d = new B(5).fill('abcde') + var e = new B(6).fill('abcdef') + + t.ok(b.equals(c)) + t.ok(!c.equals(d)) + t.ok(!d.equals(e)) + t.end() +}) + +test('buffer.equals argument validation', function (t) { + t.throws(function () { + var b = new B(1) + b.equals('abc') + }) + t.end() +}) diff --git a/node_modules/buffer/test/constructor.js b/node_modules/buffer/test/constructor.js new file mode 100644 index 0000000..cec5cdc --- /dev/null +++ b/node_modules/buffer/test/constructor.js @@ -0,0 +1,193 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('new buffer from array', function (t) { + t.equal( + new B([1, 2, 3]).toString(), + '\u0001\u0002\u0003' + ) + t.end() +}) + +test('new buffer from array w/ negatives', function (t) { + t.equal( + new B([-1, -2, -3]).toString('hex'), + 'fffefd' + ) + t.end() +}) + +test('new buffer from array with mixed signed input', function (t) { + t.equal( + new B([-255, 255, -128, 128, 512, -512, 511, -511]).toString('hex'), + '01ff80800000ff01' + ) + t.end() +}) + +test('new buffer from string', function (t) { + t.equal( + new B('hey', 'utf8').toString(), + 'hey' + ) + t.end() +}) + +test('new buffer from buffer', function (t) { + var b1 = new B('asdf') + var b2 = new B(b1) + t.equal(b1.toString('hex'), b2.toString('hex')) + t.end() +}) + +test('new buffer from ArrayBuffer', function (t) { + if (typeof ArrayBuffer !== 'undefined') { + var arraybuffer = new Uint8Array([0, 1, 2, 3]).buffer + var b = new B(arraybuffer) + t.equal(b.length, 4) + t.equal(b[0], 0) + t.equal(b[1], 1) + t.equal(b[2], 2) + t.equal(b[3], 3) + t.equal(b[4], undefined) + } + t.end() +}) + +test('new buffer from ArrayBuffer, shares memory', function (t) { + if (Buffer.TYPED_ARRAY_SUPPORT) { + var u = new Uint8Array([0, 1, 2, 3]) + var arraybuffer = u.buffer + var b = new B(arraybuffer) + t.equal(b.length, 4) + t.equal(b[0], 0) + t.equal(b[1], 1) + t.equal(b[2], 2) + t.equal(b[3], 3) + t.equal(b[4], undefined) + + // changing the Uint8Array (and thus the ArrayBuffer), changes the Buffer + u[0] = 10 + t.equal(b[0], 10) + u[1] = 11 + t.equal(b[1], 11) + u[2] = 12 + t.equal(b[2], 12) + u[3] = 13 + t.equal(b[3], 13) + } + t.end() +}) + +test('new buffer from Uint8Array', function (t) { + if (typeof Uint8Array !== 'undefined') { + var b1 = new Uint8Array([0, 1, 2, 3]) + var b2 = new B(b1) + t.equal(b1.length, b2.length) + t.equal(b1[0], 0) + t.equal(b1[1], 1) + t.equal(b1[2], 2) + t.equal(b1[3], 3) + t.equal(b1[4], undefined) + } + t.end() +}) + +test('new buffer from Uint16Array', function (t) { + if (typeof Uint16Array !== 'undefined') { + var b1 = new Uint16Array([0, 1, 2, 3]) + var b2 = new B(b1) + t.equal(b1.length, b2.length) + t.equal(b1[0], 0) + t.equal(b1[1], 1) + t.equal(b1[2], 2) + t.equal(b1[3], 3) + t.equal(b1[4], undefined) + } + t.end() +}) + +test('new buffer from Uint32Array', function (t) { + if (typeof Uint32Array !== 'undefined') { + var b1 = new Uint32Array([0, 1, 2, 3]) + var b2 = new B(b1) + t.equal(b1.length, b2.length) + t.equal(b1[0], 0) + t.equal(b1[1], 1) + t.equal(b1[2], 2) + t.equal(b1[3], 3) + t.equal(b1[4], undefined) + } + t.end() +}) + +test('new buffer from Int16Array', function (t) { + if (typeof Int16Array !== 'undefined') { + var b1 = new Int16Array([0, 1, 2, 3]) + var b2 = new B(b1) + t.equal(b1.length, b2.length) + t.equal(b1[0], 0) + t.equal(b1[1], 1) + t.equal(b1[2], 2) + t.equal(b1[3], 3) + t.equal(b1[4], undefined) + } + t.end() +}) + +test('new buffer from Int32Array', function (t) { + if (typeof Int32Array !== 'undefined') { + var b1 = new Int32Array([0, 1, 2, 3]) + var b2 = new B(b1) + t.equal(b1.length, b2.length) + t.equal(b1[0], 0) + t.equal(b1[1], 1) + t.equal(b1[2], 2) + t.equal(b1[3], 3) + t.equal(b1[4], undefined) + } + t.end() +}) + +test('new buffer from Float32Array', function (t) { + if (typeof Float32Array !== 'undefined') { + var b1 = new Float32Array([0, 1, 2, 3]) + var b2 = new B(b1) + t.equal(b1.length, b2.length) + t.equal(b1[0], 0) + t.equal(b1[1], 1) + t.equal(b1[2], 2) + t.equal(b1[3], 3) + t.equal(b1[4], undefined) + } + t.end() +}) + +test('new buffer from Float64Array', function (t) { + if (typeof Float64Array !== 'undefined') { + var b1 = new Float64Array([0, 1, 2, 3]) + var b2 = new B(b1) + t.equal(b1.length, b2.length) + t.equal(b1[0], 0) + t.equal(b1[1], 1) + t.equal(b1[2], 2) + t.equal(b1[3], 3) + t.equal(b1[4], undefined) + } + t.end() +}) + +test('new buffer from buffer.toJSON() output', function (t) { + if (typeof JSON === 'undefined') { + // ie6, ie7 lack support + t.end() + return + } + var buf = new B('test') + var json = JSON.stringify(buf) + var obj = JSON.parse(json) + var copy = new B(obj) + t.ok(buf.equals(copy)) + t.end() +}) diff --git a/node_modules/buffer/test/from-string.js b/node_modules/buffer/test/from-string.js new file mode 100644 index 0000000..e25db26 --- /dev/null +++ b/node_modules/buffer/test/from-string.js @@ -0,0 +1,132 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('detect utf16 surrogate pairs', function (t) { + var text = '\uD83D\uDE38' + '\uD83D\uDCAD' + '\uD83D\uDC4D' + var buf = new B(text) + t.equal(text, buf.toString()) + t.end() +}) + +test('detect utf16 surrogate pairs over U+20000 until U+10FFFF', function (t) { + var text = '\uD842\uDFB7' + '\uD93D\uDCAD' + '\uDBFF\uDFFF' + var buf = new B(text) + t.equal(text, buf.toString()) + t.end() +}) + +test('replace orphaned utf16 surrogate lead code point', function (t) { + var text = '\uD83D\uDE38' + '\uD83D' + '\uD83D\uDC4D' + var buf = new B(text) + t.deepEqual(buf, new B([ 0xf0, 0x9f, 0x98, 0xb8, 0xef, 0xbf, 0xbd, 0xf0, 0x9f, 0x91, 0x8d ])) + t.end() +}) + +test('replace orphaned utf16 surrogate trail code point', function (t) { + var text = '\uD83D\uDE38' + '\uDCAD' + '\uD83D\uDC4D' + var buf = new B(text) + t.deepEqual(buf, new B([ 0xf0, 0x9f, 0x98, 0xb8, 0xef, 0xbf, 0xbd, 0xf0, 0x9f, 0x91, 0x8d ])) + t.end() +}) + +test('do not write partial utf16 code units', function (t) { + var f = new B([0, 0, 0, 0, 0]) + t.equal(f.length, 5) + var size = f.write('あいうえお', 'utf16le') + t.equal(size, 4) + t.deepEqual(f, new B([0x42, 0x30, 0x44, 0x30, 0x00])) + t.end() +}) + +test('handle partial utf16 code points when encoding to utf8 the way node does', function (t) { + var text = '\uD83D\uDE38' + '\uD83D\uDC4D' + + var buf = new B(8) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0xf0, 0x9f, 0x98, 0xb8, 0xf0, 0x9f, 0x91, 0x8d ])) + + buf = new B(7) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0xf0, 0x9f, 0x98, 0xb8, 0x00, 0x00, 0x00 ])) + + buf = new B(6) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0xf0, 0x9f, 0x98, 0xb8, 0x00, 0x00 ])) + + buf = new B(5) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0xf0, 0x9f, 0x98, 0xb8, 0x00 ])) + + buf = new B(4) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0xf0, 0x9f, 0x98, 0xb8 ])) + + buf = new B(3) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x00, 0x00, 0x00 ])) + + buf = new B(2) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x00, 0x00 ])) + + buf = new B(1) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x00 ])) + + t.end() +}) + +test('handle invalid utf16 code points when encoding to utf8 the way node does', function (t) { + var text = 'a' + '\uDE38\uD83D' + 'b' + + var buf = new B(8) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61, 0xef, 0xbf, 0xbd, 0xef, 0xbf, 0xbd, 0x62 ])) + + buf = new B(7) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61, 0xef, 0xbf, 0xbd, 0xef, 0xbf, 0xbd ])) + + buf = new B(6) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61, 0xef, 0xbf, 0xbd, 0x00, 0x00 ])) + + buf = new B(5) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61, 0xef, 0xbf, 0xbd, 0x00 ])) + + buf = new B(4) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61, 0xef, 0xbf, 0xbd ])) + + buf = new B(3) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61, 0x00, 0x00 ])) + + buf = new B(2) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61, 0x00 ])) + + buf = new B(1) + buf.fill(0) + buf.write(text) + t.deepEqual(buf, new B([ 0x61 ])) + + t.end() +}) diff --git a/node_modules/buffer/test/is-buffer.js b/node_modules/buffer/test/is-buffer.js new file mode 100644 index 0000000..3744b23 --- /dev/null +++ b/node_modules/buffer/test/is-buffer.js @@ -0,0 +1,22 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var isBuffer = require('is-buffer') +var test = require('tape') + +test('is-buffer tests', function (t) { + t.ok(isBuffer(new B(4)), 'new Buffer(4)') + + t.notOk(isBuffer(undefined), 'undefined') + t.notOk(isBuffer(null), 'null') + t.notOk(isBuffer(''), 'empty string') + t.notOk(isBuffer(true), 'true') + t.notOk(isBuffer(false), 'false') + t.notOk(isBuffer(0), '0') + t.notOk(isBuffer(1), '1') + t.notOk(isBuffer(1.0), '1.0') + t.notOk(isBuffer('string'), 'string') + t.notOk(isBuffer({}), '{}') + t.notOk(isBuffer(function foo () {}), 'function foo () {}') + + t.end() +}) diff --git a/node_modules/buffer/test/methods.js b/node_modules/buffer/test/methods.js new file mode 100644 index 0000000..f4bd3f2 --- /dev/null +++ b/node_modules/buffer/test/methods.js @@ -0,0 +1,127 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('buffer.toJSON', function (t) { + var data = [1, 2, 3, 4] + t.deepEqual( + new B(data).toJSON(), + { type: 'Buffer', data: [ 1, 2, 3, 4 ] } + ) + t.end() +}) + +test('buffer.copy', function (t) { + // copied from nodejs.org example + var buf1 = new B(26) + var buf2 = new B(26) + + for (var i = 0; i < 26; i++) { + buf1[i] = i + 97 // 97 is ASCII a + buf2[i] = 33 // ASCII ! + } + + buf1.copy(buf2, 8, 16, 20) + + t.equal( + buf2.toString('ascii', 0, 25), + '!!!!!!!!qrst!!!!!!!!!!!!!' + ) + t.end() +}) + +test('test offset returns are correct', function (t) { + var b = new B(16) + t.equal(4, b.writeUInt32LE(0, 0)) + t.equal(6, b.writeUInt16LE(0, 4)) + t.equal(7, b.writeUInt8(0, 6)) + t.equal(8, b.writeInt8(0, 7)) + t.equal(16, b.writeDoubleLE(0, 8)) + t.end() +}) + +test('concat() a varying number of buffers', function (t) { + var zero = [] + var one = [ new B('asdf') ] + var long = [] + for (var i = 0; i < 10; i++) { + long.push(new B('asdf')) + } + + var flatZero = B.concat(zero) + var flatOne = B.concat(one) + var flatLong = B.concat(long) + var flatLongLen = B.concat(long, 40) + + t.equal(flatZero.length, 0) + t.equal(flatOne.toString(), 'asdf') + t.deepEqual(flatOne, one[0]) + t.equal(flatLong.toString(), (new Array(10 + 1).join('asdf'))) + t.equal(flatLongLen.toString(), (new Array(10 + 1).join('asdf'))) + t.end() +}) + +test('fill', function (t) { + var b = new B(10) + b.fill(2) + t.equal(b.toString('hex'), '02020202020202020202') + t.end() +}) + +test('fill (string)', function (t) { + var b = new B(10) + b.fill('abc') + t.equal(b.toString(), 'abcabcabca') + b.fill('է') + t.equal(b.toString(), 'էէէէէ') + t.end() +}) + +test('copy() empty buffer with sourceEnd=0', function (t) { + var source = new B([42]) + var destination = new B([43]) + source.copy(destination, 0, 0, 0) + t.equal(destination.readUInt8(0), 43) + t.end() +}) + +test('copy() after slice()', function (t) { + var source = new B(200) + var dest = new B(200) + var expected = new B(200) + for (var i = 0; i < 200; i++) { + source[i] = i + dest[i] = 0 + } + + source.slice(2).copy(dest) + source.copy(expected, 0, 2) + t.deepEqual(dest, expected) + t.end() +}) + +test('copy() ascending', function (t) { + var b = new B('abcdefghij') + b.copy(b, 0, 3, 10) + t.equal(b.toString(), 'defghijhij') + t.end() +}) + +test('copy() descending', function (t) { + var b = new B('abcdefghij') + b.copy(b, 3, 0, 7) + t.equal(b.toString(), 'abcabcdefg') + t.end() +}) + +test('buffer.slice sets indexes', function (t) { + t.equal((new B('hallo')).slice(0, 5).toString(), 'hallo') + t.end() +}) + +test('buffer.slice out of range', function (t) { + t.plan(2) + t.equal((new B('hallo')).slice(0, 10).toString(), 'hallo') + t.equal((new B('hallo')).slice(10, 2).toString(), '') + t.end() +}) diff --git a/node_modules/buffer/test/node/test-buffer-alloc.js b/node_modules/buffer/test/node/test-buffer-alloc.js new file mode 100644 index 0000000..b524f51 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-alloc.js @@ -0,0 +1,1501 @@ +'use strict'; +var Buffer = require('../../').Buffer; + +var common = { skip: function () {} }; +var assert = require('assert'); + +var Buffer = require('../../').Buffer; + +// counter to ensure unique value is always copied +var cntr = 0; + +var b = Buffer.allocUnsafe(1024); + +// console.log('b.length == %d', b.length); +assert.strictEqual(1024, b.length); + +b[0] = -1; +assert.strictEqual(b[0], 255); + +for (var i = 0; i < 1024; i++) { + b[i] = i % 256; +} + +for (var i = 0; i < 1024; i++) { + assert.strictEqual(i % 256, b[i]); +} + +var c = Buffer.allocUnsafe(512); +// console.log('c.length == %d', c.length); +assert.strictEqual(512, c.length); + +var d = Buffer.from([]); +assert.strictEqual(0, d.length); + +var ui32 = new Uint32Array(4).fill(42); +var e = Buffer.from(ui32); +for (var [index, value] of e.entries()) { + assert.strictEqual(value, ui32[index]); +} + +// First check Buffer#fill() works as expected. + +assert.throws(function() { + Buffer.allocUnsafe(8).fill('a', -1); +}); + +assert.throws(function() { + Buffer.allocUnsafe(8).fill('a', 0, 9); +}); + +// Make sure this doesn't hang indefinitely. +Buffer.allocUnsafe(8).fill(''); +Buffer.alloc(8, ''); + +{ + var buf = Buffer.alloc(64, 10); + for (var i = 0; i < buf.length; i++) + assert.equal(buf[i], 10); + + buf.fill(11, 0, buf.length >> 1); + for (var i = 0; i < buf.length >> 1; i++) + assert.equal(buf[i], 11); + for (var i = (buf.length >> 1) + 1; i < buf.length; i++) + assert.equal(buf[i], 10); + + buf.fill('h'); + for (var i = 0; i < buf.length; i++) + assert.equal('h'.charCodeAt(0), buf[i]); + + buf.fill(0); + for (var i = 0; i < buf.length; i++) + assert.equal(0, buf[i]); + + buf.fill(null); + for (var i = 0; i < buf.length; i++) + assert.equal(0, buf[i]); + + buf.fill(1, 16, 32); + for (var i = 0; i < 16; i++) + assert.equal(0, buf[i]); + for (var i = 16; i < 32; i++) + assert.equal(1, buf[i]); + for (var i = 32; i < buf.length; i++) + assert.equal(0, buf[i]); +} + +{ + var buf = Buffer.alloc(10, 'abc'); + assert.equal(buf.toString(), 'abcabcabca'); + buf.fill('է'); + assert.equal(buf.toString(), 'էէէէէ'); +} + +{ + // copy 512 bytes, from 0 to 512. + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, 0, 512); +// console.log('copied %d bytes from b into c', copied); + assert.strictEqual(512, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +{ + // copy c into b, without specifying sourceEnd + b.fill(++cntr); + c.fill(++cntr); + var copied = c.copy(b, 0, 0); +// console.log('copied %d bytes from c into b w/o sourceEnd', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(c[i], b[i]); + } +} + +{ + // copy c into b, without specifying sourceStart + b.fill(++cntr); + c.fill(++cntr); + var copied = c.copy(b, 0); +// console.log('copied %d bytes from c into b w/o sourceStart', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(c[i], b[i]); + } +} + +{ + // copy longer buffer b to shorter c without targetStart + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c); +// console.log('copied %d bytes from b into c w/o targetStart', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +{ + // copy starting near end of b to c + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, b.length - Math.floor(c.length / 2)); +// console.log('copied %d bytes from end of b into beginning of c', copied); + assert.strictEqual(Math.floor(c.length / 2), copied); + for (var i = 0; i < Math.floor(c.length / 2); i++) { + assert.strictEqual(b[b.length - Math.floor(c.length / 2) + i], c[i]); + } + for (var i = Math.floor(c.length / 2) + 1; i < c.length; i++) { + assert.strictEqual(c[c.length - 1], c[i]); + } +} + +{ + // try to copy 513 bytes, and check we don't overrun c + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, 0, 513); +// console.log('copied %d bytes from b trying to overrun c', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +{ + // copy 768 bytes from b into b + b.fill(++cntr); + b.fill(++cntr, 256); + var copied = b.copy(b, 0, 256, 1024); +// console.log('copied %d bytes from b into b', copied); + assert.strictEqual(768, copied); + for (var i = 0; i < b.length; i++) { + assert.strictEqual(cntr, b[i]); + } +} + +// copy string longer than buffer length (failure will segfault) +var bb = Buffer.allocUnsafe(10); +bb.fill('hello crazy world'); + + +// try to copy from before the beginning of b +assert.doesNotThrow(() => { b.copy(c, 0, 100, 10); }); + +// copy throws at negative sourceStart +assert.throws(function() { + Buffer.allocUnsafe(5).copy(Buffer.allocUnsafe(5), 0, -1); +}, RangeError); + +{ + // check sourceEnd resets to targetEnd if former is greater than the latter + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, 0, 1025); +// console.log('copied %d bytes from b into c', copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +// throw with negative sourceEnd +// console.log('test copy at negative sourceEnd'); +assert.throws(function() { + b.copy(c, 0, 0, -1); +}, RangeError); + +// when sourceStart is greater than sourceEnd, zero copied +assert.equal(b.copy(c, 0, 100, 10), 0); + +// when targetStart > targetLength, zero copied +assert.equal(b.copy(c, 512, 0, 10), 0); + +var caught_error; + +// invalid encoding for Buffer.toString +caught_error = null; +try { + b.toString('invalid'); +} catch (err) { + caught_error = err; +} +assert.strictEqual('Unknown encoding: invalid', caught_error.message); + +// invalid encoding for Buffer.write +caught_error = null; +try { + b.write('test string', 0, 5, 'invalid'); +} catch (err) { + caught_error = err; +} +assert.strictEqual('Unknown encoding: invalid', caught_error.message); + +// try to create 0-length buffers +Buffer.from(''); +Buffer.from('', 'ascii'); +Buffer.from('', 'latin1'); +Buffer.alloc(0); +Buffer.allocUnsafe(0); + +// try to write a 0-length string beyond the end of b +assert.throws(function() { + b.write('', 2048); +}, RangeError); + +// throw when writing to negative offset +assert.throws(function() { + b.write('a', -1); +}, RangeError); + +// throw when writing past bounds from the pool +assert.throws(function() { + b.write('a', 2048); +}, RangeError); + +// throw when writing to negative offset +assert.throws(function() { + b.write('a', -1); +}, RangeError); + +// try to copy 0 bytes worth of data into an empty buffer +b.copy(Buffer.alloc(0), 0, 0, 0); + +// try to copy 0 bytes past the end of the target buffer +b.copy(Buffer.alloc(0), 1, 1, 1); +b.copy(Buffer.alloc(1), 1, 1, 1); + +// try to copy 0 bytes from past the end of the source buffer +b.copy(Buffer.alloc(1), 0, 2048, 2048); + +var rangeBuffer = Buffer.from('abc'); + +// if start >= buffer's length, empty string will be returned +assert.equal(rangeBuffer.toString('ascii', 3), ''); +assert.equal(rangeBuffer.toString('ascii', +Infinity), ''); +assert.equal(rangeBuffer.toString('ascii', 3.14, 3), ''); +assert.equal(rangeBuffer.toString('ascii', 'Infinity', 3), ''); + +// if end <= 0, empty string will be returned +assert.equal(rangeBuffer.toString('ascii', 1, 0), ''); +assert.equal(rangeBuffer.toString('ascii', 1, -1.2), ''); +assert.equal(rangeBuffer.toString('ascii', 1, -100), ''); +assert.equal(rangeBuffer.toString('ascii', 1, -Infinity), ''); + +// if start < 0, start will be taken as zero +assert.equal(rangeBuffer.toString('ascii', -1, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', -1.99, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', -Infinity, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '-1', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '-1.99', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '-Infinity', 3), 'abc'); + +// if start is an invalid integer, start will be taken as zero +assert.equal(rangeBuffer.toString('ascii', 'node.js', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', {}, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', [], 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', NaN, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', null, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', undefined, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', false, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '', 3), 'abc'); + +// but, if start is an integer when coerced, then it will be coerced and used. +assert.equal(rangeBuffer.toString('ascii', '-1', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '1', 3), 'bc'); +assert.equal(rangeBuffer.toString('ascii', '-Infinity', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '3', 3), ''); +assert.equal(rangeBuffer.toString('ascii', Number(3), 3), ''); +assert.equal(rangeBuffer.toString('ascii', '3.14', 3), ''); +assert.equal(rangeBuffer.toString('ascii', '1.99', 3), 'bc'); +assert.equal(rangeBuffer.toString('ascii', '-1.99', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 1.99, 3), 'bc'); +assert.equal(rangeBuffer.toString('ascii', true, 3), 'bc'); + +// if end > buffer's length, end will be taken as buffer's length +assert.equal(rangeBuffer.toString('ascii', 0, 5), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, 6.99), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, Infinity), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '5'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '6.99'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, 'Infinity'), 'abc'); + +// if end is an invalid integer, end will be taken as buffer's length +assert.equal(rangeBuffer.toString('ascii', 0, 'node.js'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, {}), ''); +assert.equal(rangeBuffer.toString('ascii', 0, NaN), ''); +assert.equal(rangeBuffer.toString('ascii', 0, undefined), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, null), ''); +assert.equal(rangeBuffer.toString('ascii', 0, []), ''); +assert.equal(rangeBuffer.toString('ascii', 0, false), ''); +assert.equal(rangeBuffer.toString('ascii', 0, ''), ''); + +// but, if end is an integer when coerced, then it will be coerced and used. +assert.equal(rangeBuffer.toString('ascii', 0, '-1'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, '1'), 'a'); +assert.equal(rangeBuffer.toString('ascii', 0, '-Infinity'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, '3'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, Number(3)), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '3.14'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '1.99'), 'a'); +assert.equal(rangeBuffer.toString('ascii', 0, '-1.99'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, 1.99), 'a'); +assert.equal(rangeBuffer.toString('ascii', 0, true), 'a'); + +// try toString() with a object as a encoding +assert.equal(rangeBuffer.toString({toString: function() { + return 'ascii'; +}}), 'abc'); + +// testing for smart defaults and ability to pass string values as offset +var writeTest = Buffer.from('abcdes'); +writeTest.write('n', 'ascii'); +writeTest.write('o', '1', 'ascii'); +writeTest.write('d', '2', 'ascii'); +writeTest.write('e', 3, 'ascii'); +writeTest.write('j', 4, 'ascii'); +assert.equal(writeTest.toString(), 'nodejs'); + +// ASCII slice test +{ + var asciiString = 'hello world'; + + for (var i = 0; i < asciiString.length; i++) { + b[i] = asciiString.charCodeAt(i); + } + var asciiSlice = b.toString('ascii', 0, asciiString.length); + assert.equal(asciiString, asciiSlice); +} + +{ + var asciiString = 'hello world'; + var offset = 100; + + var written = b.write(asciiString, offset, 'ascii'); + assert.equal(asciiString.length, written); + var asciiSlice = b.toString('ascii', offset, offset + asciiString.length); + assert.equal(asciiString, asciiSlice); +} + +{ + var asciiString = 'hello world'; + var offset = 100; + + var sliceA = b.slice(offset, offset + asciiString.length); + var sliceB = b.slice(offset, offset + asciiString.length); + for (var i = 0; i < asciiString.length; i++) { + assert.equal(sliceA[i], sliceB[i]); + } +} + +// UTF-8 slice test + +var utf8String = '¡hέlló wôrld!'; +var offset = 100; + +b.write(utf8String, 0, Buffer.byteLength(utf8String), 'utf8'); +var utf8Slice = b.toString('utf8', 0, Buffer.byteLength(utf8String)); +assert.equal(utf8String, utf8Slice); + +var written = b.write(utf8String, offset, 'utf8'); +assert.equal(Buffer.byteLength(utf8String), written); +utf8Slice = b.toString('utf8', offset, offset + Buffer.byteLength(utf8String)); +assert.equal(utf8String, utf8Slice); + +var sliceA = b.slice(offset, offset + Buffer.byteLength(utf8String)); +var sliceB = b.slice(offset, offset + Buffer.byteLength(utf8String)); +for (var i = 0; i < Buffer.byteLength(utf8String); i++) { + assert.equal(sliceA[i], sliceB[i]); +} + +{ + var slice = b.slice(100, 150); + assert.equal(50, slice.length); + for (var i = 0; i < 50; i++) { + assert.equal(b[100 + i], slice[i]); + } +} + +{ + // make sure only top level parent propagates from allocPool + var b = Buffer.allocUnsafe(5); + var c = b.slice(0, 4); + var d = c.slice(0, 2); + assert.equal(b.parent, c.parent); + assert.equal(b.parent, d.parent); +} + +{ + // also from a non-pooled instance + var b = Buffer.allocUnsafeSlow(5); + var c = b.slice(0, 4); + var d = c.slice(0, 2); + assert.equal(c.parent, d.parent); +} + +{ + // Bug regression test + var testValue = '\u00F6\u65E5\u672C\u8A9E'; // ö日本語 + var buffer = Buffer.allocUnsafe(32); + var size = buffer.write(testValue, 0, 'utf8'); +// console.log('bytes written to buffer: ' + size); + var slice = buffer.toString('utf8', 0, size); + assert.equal(slice, testValue); +} + +{ + // Test triple slice + var a = Buffer.allocUnsafe(8); + for (var i = 0; i < 8; i++) a[i] = i; + var b = a.slice(4, 8); + assert.equal(4, b[0]); + assert.equal(5, b[1]); + assert.equal(6, b[2]); + assert.equal(7, b[3]); + var c = b.slice(2, 4); + assert.equal(6, c[0]); + assert.equal(7, c[1]); +} + +{ + var d = Buffer.from([23, 42, 255]); + assert.equal(d.length, 3); + assert.equal(d[0], 23); + assert.equal(d[1], 42); + assert.equal(d[2], 255); + assert.deepStrictEqual(d, Buffer.from(d)); +} + +{ + var e = Buffer.from('über'); +// console.error('uber: \'%s\'', e.toString()); + assert.deepStrictEqual(e, Buffer.from([195, 188, 98, 101, 114])); +} + +{ + var f = Buffer.from('über', 'ascii'); +// console.error('f.length: %d (should be 4)', f.length); + assert.deepStrictEqual(f, Buffer.from([252, 98, 101, 114])); +} + +['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { + { + var f = Buffer.from('über', encoding); +// console.error('f.length: %d (should be 8)', f.length); + assert.deepStrictEqual(f, Buffer.from([252, 0, 98, 0, 101, 0, 114, 0])); + } + + { + var f = Buffer.from('привет', encoding); +// console.error('f.length: %d (should be 12)', f.length); + assert.deepStrictEqual(f, + Buffer.from([63, 4, 64, 4, 56, 4, 50, 4, 53, 4, 66, 4])); + assert.equal(f.toString(encoding), 'привет'); + } + + { + var f = Buffer.from([0, 0, 0, 0, 0]); + assert.equal(f.length, 5); + var size = f.write('あいうえお', encoding); +// console.error('bytes written to buffer: %d (should be 4)', size); + assert.equal(size, 4); + assert.deepStrictEqual(f, Buffer.from([0x42, 0x30, 0x44, 0x30, 0x00])); + } +}); + +{ + var f = Buffer.from('\uD83D\uDC4D', 'utf-16le'); // THUMBS UP SIGN (U+1F44D) + assert.equal(f.length, 4); + assert.deepStrictEqual(f, Buffer.from('3DD84DDC', 'hex')); +} + + +var arrayIsh = {0: 0, 1: 1, 2: 2, 3: 3, length: 4}; +var g = Buffer.from(arrayIsh); +assert.deepStrictEqual(g, Buffer.from([0, 1, 2, 3])); +var strArrayIsh = {0: '0', 1: '1', 2: '2', 3: '3', length: 4}; +g = Buffer.from(strArrayIsh); +assert.deepStrictEqual(g, Buffer.from([0, 1, 2, 3])); + + +// +// Test toString('base64') +// +assert.equal('TWFu', (Buffer.from('Man')).toString('base64')); + +{ + // test that regular and URL-safe base64 both work + var expected = [0xff, 0xff, 0xbe, 0xff, 0xef, 0xbf, 0xfb, 0xef, 0xff]; + assert.deepStrictEqual(Buffer.from('//++/++/++//', 'base64'), + Buffer.from(expected)); + assert.deepStrictEqual(Buffer.from('__--_--_--__', 'base64'), + Buffer.from(expected)); +} + +{ + // big example + var quote = 'Man is distinguished, not only by his reason, but by this ' + + 'singular passion from other animals, which is a lust ' + + 'of the mind, that by a perseverance of delight in the ' + + 'continued and indefatigable generation of knowledge, ' + + 'exceeds the short vehemence of any carnal pleasure.'; + var expected = 'TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb' + + '24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlci' + + 'BhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQ' + + 'gYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu' + + 'dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZ' + + 'GdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm' + + '5hbCBwbGVhc3VyZS4='; + assert.equal(expected, (Buffer.from(quote)).toString('base64')); + + var b = Buffer.allocUnsafe(1024); + var bytesWritten = b.write(expected, 0, 'base64'); + assert.equal(quote.length, bytesWritten); + assert.equal(quote, b.toString('ascii', 0, quote.length)); + + // check that the base64 decoder ignores whitespace + var expectedWhite = expected.slice(0, 60) + ' \n' + + expected.slice(60, 120) + ' \n' + + expected.slice(120, 180) + ' \n' + + expected.slice(180, 240) + ' \n' + + expected.slice(240, 300) + '\n' + + expected.slice(300, 360) + '\n'; + b = Buffer.allocUnsafe(1024); + bytesWritten = b.write(expectedWhite, 0, 'base64'); + assert.equal(quote.length, bytesWritten); + assert.equal(quote, b.toString('ascii', 0, quote.length)); + + // check that the base64 decoder on the constructor works + // even in the presence of whitespace. + b = Buffer.from(expectedWhite, 'base64'); + assert.equal(quote.length, b.length); + assert.equal(quote, b.toString('ascii', 0, quote.length)); + + // check that the base64 decoder ignores illegal chars + var expectedIllegal = expected.slice(0, 60) + ' \x80' + + expected.slice(60, 120) + ' \xff' + + expected.slice(120, 180) + ' \x00' + + expected.slice(180, 240) + ' \x98' + + expected.slice(240, 300) + '\x03' + + expected.slice(300, 360); + b = Buffer.from(expectedIllegal, 'base64'); + assert.equal(quote.length, b.length); + assert.equal(quote, b.toString('ascii', 0, quote.length)); +} + +assert.equal(Buffer.from('', 'base64').toString(), ''); +assert.equal(Buffer.from('K', 'base64').toString(), ''); + +// multiple-of-4 with padding +assert.equal(Buffer.from('Kg==', 'base64').toString(), '*'); +assert.equal(Buffer.from('Kio=', 'base64').toString(), '**'); +assert.equal(Buffer.from('Kioq', 'base64').toString(), '***'); +assert.equal(Buffer.from('KioqKg==', 'base64').toString(), '****'); +assert.equal(Buffer.from('KioqKio=', 'base64').toString(), '*****'); +assert.equal(Buffer.from('KioqKioq', 'base64').toString(), '******'); +assert.equal(Buffer.from('KioqKioqKg==', 'base64').toString(), '*******'); +assert.equal(Buffer.from('KioqKioqKio=', 'base64').toString(), '********'); +assert.equal(Buffer.from('KioqKioqKioq', 'base64').toString(), '*********'); +assert.equal(Buffer.from('KioqKioqKioqKg==', 'base64').toString(), + '**********'); +assert.equal(Buffer.from('KioqKioqKioqKio=', 'base64').toString(), + '***********'); +assert.equal(Buffer.from('KioqKioqKioqKioq', 'base64').toString(), + '************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKg==', 'base64').toString(), + '*************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKio=', 'base64').toString(), + '**************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioq', 'base64').toString(), + '***************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKg==', 'base64').toString(), + '****************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKio=', 'base64').toString(), + '*****************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioq', 'base64').toString(), + '******************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKg==', 'base64').toString(), + '*******************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKio=', 'base64').toString(), + '********************'); + +// no padding, not a multiple of 4 +assert.equal(Buffer.from('Kg', 'base64').toString(), '*'); +assert.equal(Buffer.from('Kio', 'base64').toString(), '**'); +assert.equal(Buffer.from('KioqKg', 'base64').toString(), '****'); +assert.equal(Buffer.from('KioqKio', 'base64').toString(), '*****'); +assert.equal(Buffer.from('KioqKioqKg', 'base64').toString(), '*******'); +assert.equal(Buffer.from('KioqKioqKio', 'base64').toString(), '********'); +assert.equal(Buffer.from('KioqKioqKioqKg', 'base64').toString(), '**********'); +assert.equal(Buffer.from('KioqKioqKioqKio', 'base64').toString(), + '***********'); +assert.equal(Buffer.from('KioqKioqKioqKioqKg', 'base64').toString(), + '*************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKio', 'base64').toString(), + '**************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKg', 'base64').toString(), + '****************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKio', 'base64').toString(), + '*****************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKg', 'base64').toString(), + '*******************'); +assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKio', 'base64').toString(), + '********************'); + +// handle padding graciously, multiple-of-4 or not +assert.equal( + Buffer.from('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw==', 'base64').length, + 32 +); +assert.equal( + Buffer.from('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw=', 'base64').length, + 32 +); +assert.equal( + Buffer.from('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw', 'base64').length, + 32 +); +assert.equal( + Buffer.from('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg==', 'base64').length, + 31 +); +assert.equal( + Buffer.from('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg=', 'base64').length, + 31 +); +assert.equal( + Buffer.from('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg', 'base64').length, + 31 +); + +// This string encodes single '.' character in UTF-16 +var dot = Buffer.from('//4uAA==', 'base64'); +assert.equal(dot[0], 0xff); +assert.equal(dot[1], 0xfe); +assert.equal(dot[2], 0x2e); +assert.equal(dot[3], 0x00); +assert.equal(dot.toString('base64'), '//4uAA=='); + +{ + // Writing base64 at a position > 0 should not mangle the result. + // + // https://github.com/joyent/node/issues/402 + var segments = ['TWFkbmVzcz8h', 'IFRoaXM=', 'IGlz', 'IG5vZGUuanMh']; + var b = Buffer.allocUnsafe(64); + var pos = 0; + + for (var i = 0; i < segments.length; ++i) { + pos += b.write(segments[i], pos, 'base64'); + } + assert.equal(b.toString('latin1', 0, pos), 'Madness?! This is node.js!'); +} + +// Regression test for https://github.com/nodejs/node/issues/3496. +// assert.equal(Buffer.from('=bad'.repeat(1e4), 'base64').length, 0); + +{ + // Creating buffers larger than pool size. + var l = Buffer.poolSize + 5; + var s = ''; + for (var i = 0; i < l; i++) { + s += 'h'; + } + + var b = Buffer.from(s); + + for (var i = 0; i < l; i++) { + assert.equal('h'.charCodeAt(0), b[i]); + } + + var sb = b.toString(); + assert.equal(sb.length, s.length); + assert.equal(sb, s); +} + +{ + // Single argument slice + var b = Buffer.from('abcde'); + assert.equal('bcde', b.slice(1).toString()); +} + +// slice(0,0).length === 0 +assert.equal(0, Buffer.from('hello').slice(0, 0).length); + +// test hex toString +// console.log('Create hex string from buffer'); +var hexb = Buffer.allocUnsafe(256); +for (var i = 0; i < 256; i++) { + hexb[i] = i; +} +var hexStr = hexb.toString('hex'); +assert.equal(hexStr, + '000102030405060708090a0b0c0d0e0f' + + '101112131415161718191a1b1c1d1e1f' + + '202122232425262728292a2b2c2d2e2f' + + '303132333435363738393a3b3c3d3e3f' + + '404142434445464748494a4b4c4d4e4f' + + '505152535455565758595a5b5c5d5e5f' + + '606162636465666768696a6b6c6d6e6f' + + '707172737475767778797a7b7c7d7e7f' + + '808182838485868788898a8b8c8d8e8f' + + '909192939495969798999a9b9c9d9e9f' + + 'a0a1a2a3a4a5a6a7a8a9aaabacadaeaf' + + 'b0b1b2b3b4b5b6b7b8b9babbbcbdbebf' + + 'c0c1c2c3c4c5c6c7c8c9cacbcccdcecf' + + 'd0d1d2d3d4d5d6d7d8d9dadbdcdddedf' + + 'e0e1e2e3e4e5e6e7e8e9eaebecedeeef' + + 'f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff'); + +// console.log('Create buffer from hex string'); +var hexb2 = Buffer.from(hexStr, 'hex'); +for (var i = 0; i < 256; i++) { + assert.equal(hexb2[i], hexb[i]); +} + +{ + // test an invalid slice end. +// console.log('Try to slice off the end of the buffer'); + var b = Buffer.from([1, 2, 3, 4, 5]); + var b2 = b.toString('hex', 1, 10000); + var b3 = b.toString('hex', 1, 5); + var b4 = b.toString('hex', 1); + assert.equal(b2, b3); + assert.equal(b2, b4); +} + +function buildBuffer(data) { + if (Array.isArray(data)) { + var buffer = Buffer.allocUnsafe(data.length); + data.forEach(function(v, k) { + buffer[k] = v; + }); + return buffer; + } + return null; +} + +var x = buildBuffer([0x81, 0xa3, 0x66, 0x6f, 0x6f, 0xa3, 0x62, 0x61, 0x72]); + +// console.log(x.inspect()); +assert.equal('', x.inspect()); + +{ + var z = x.slice(4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(5, z.length); + assert.equal(0x6f, z[0]); + assert.equal(0xa3, z[1]); + assert.equal(0x62, z[2]); + assert.equal(0x61, z[3]); + assert.equal(0x72, z[4]); +} + +{ + var z = x.slice(0); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(z.length, x.length); +} + +{ + var z = x.slice(0, 4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(4, z.length); + assert.equal(0x81, z[0]); + assert.equal(0xa3, z[1]); +} + +{ + var z = x.slice(0, 9); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(9, z.length); +} + +{ + var z = x.slice(1, 4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(3, z.length); + assert.equal(0xa3, z[0]); +} + +{ + var z = x.slice(2, 4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(2, z.length); + assert.equal(0x66, z[0]); + assert.equal(0x6f, z[1]); +} + +assert.equal(0, Buffer.from('hello').slice(0, 0).length); + +['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { + var b = Buffer.allocUnsafe(10); + b.write('あいうえお', encoding); + assert.equal(b.toString(encoding), 'あいうえお'); +}); + +{ + // Binary encoding should write only one byte per character. + var b = Buffer.from([0xde, 0xad, 0xbe, 0xef]); + var s = String.fromCharCode(0xffff); + b.write(s, 0, 'latin1'); + assert.equal(0xff, b[0]); + assert.equal(0xad, b[1]); + assert.equal(0xbe, b[2]); + assert.equal(0xef, b[3]); + s = String.fromCharCode(0xaaee); + b.write(s, 0, 'latin1'); + assert.equal(0xee, b[0]); + assert.equal(0xad, b[1]); + assert.equal(0xbe, b[2]); + assert.equal(0xef, b[3]); +} + +{ + // #1210 Test UTF-8 string includes null character + var buf = Buffer.from('\0'); + assert.equal(buf.length, 1); + buf = Buffer.from('\0\0'); + assert.equal(buf.length, 2); +} + +{ + var buf = Buffer.allocUnsafe(2); + var written = buf.write(''); // 0byte + assert.equal(written, 0); + written = buf.write('\0'); // 1byte (v8 adds null terminator) + assert.equal(written, 1); + written = buf.write('a\0'); // 1byte * 2 + assert.equal(written, 2); + written = buf.write('あ'); // 3bytes + assert.equal(written, 0); + written = buf.write('\0あ'); // 1byte + 3bytes + assert.equal(written, 1); + written = buf.write('\0\0あ'); // 1byte * 2 + 3bytes + assert.equal(written, 2); +} + +{ + var buf = Buffer.allocUnsafe(10); + written = buf.write('あいう'); // 3bytes * 3 (v8 adds null terminator) + assert.equal(written, 9); + written = buf.write('あいう\0'); // 3bytes * 3 + 1byte + assert.equal(written, 10); +} + +{ + // #243 Test write() with maxLength + var buf = Buffer.allocUnsafe(4); + buf.fill(0xFF); + var written = buf.write('abcd', 1, 2, 'utf8'); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0x61); + assert.equal(buf[2], 0x62); + assert.equal(buf[3], 0xFF); + + buf.fill(0xFF); + written = buf.write('abcd', 1, 4); +// console.log(buf); + assert.equal(written, 3); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0x61); + assert.equal(buf[2], 0x62); + assert.equal(buf[3], 0x63); + + buf.fill(0xFF); + written = buf.write('abcd', 1, 2, 'utf8'); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0x61); + assert.equal(buf[2], 0x62); + assert.equal(buf[3], 0xFF); + + buf.fill(0xFF); + written = buf.write('abcdef', 1, 2, 'hex'); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0xAB); + assert.equal(buf[2], 0xCD); + assert.equal(buf[3], 0xFF); + + ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { + buf.fill(0xFF); + written = buf.write('abcd', 0, 2, encoding); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0x61); + assert.equal(buf[1], 0x00); + assert.equal(buf[2], 0xFF); + assert.equal(buf[3], 0xFF); + }); +} + +{ + // test offset returns are correct + var b = Buffer.allocUnsafe(16); + assert.equal(4, b.writeUInt32LE(0, 0)); + assert.equal(6, b.writeUInt16LE(0, 4)); + assert.equal(7, b.writeUInt8(0, 6)); + assert.equal(8, b.writeInt8(0, 7)); + assert.equal(16, b.writeDoubleLE(0, 8)); +} + +{ + // test unmatched surrogates not producing invalid utf8 output + // ef bf bd = utf-8 representation of unicode replacement character + // see https://codereview.chromium.org/121173009/ + var buf = Buffer.from('ab\ud800cd', 'utf8'); + assert.equal(buf[0], 0x61); + assert.equal(buf[1], 0x62); + assert.equal(buf[2], 0xef); + assert.equal(buf[3], 0xbf); + assert.equal(buf[4], 0xbd); + assert.equal(buf[5], 0x63); + assert.equal(buf[6], 0x64); +} + +{ + // test for buffer overrun + var buf = Buffer.from([0, 0, 0, 0, 0]); // length: 5 + var sub = buf.slice(0, 4); // length: 4 + written = sub.write('12345', 'latin1'); + assert.equal(written, 4); + assert.equal(buf[4], 0); +} + +// Check for fractional length args, junk length args, etc. +// https://github.com/joyent/node/issues/1758 + +// Call .fill() first, stops valgrind warning about uninitialized memory reads. +Buffer.allocUnsafe(3.3).fill().toString(); + // throws bad argument error in commit 43cb4ec +Buffer.alloc(3.3).fill().toString(); +assert.equal(Buffer.allocUnsafe(NaN).length, 0); +assert.equal(Buffer.allocUnsafe(3.3).length, 3); +assert.equal(Buffer.from({length: 3.3}).length, 3); +assert.equal(Buffer.from({length: 'BAM'}).length, 0); + +// Make sure that strings are not coerced to numbers. +assert.equal(Buffer.from('99').length, 2); +assert.equal(Buffer.from('13.37').length, 5); + +// Ensure that the length argument is respected. +'ascii utf8 hex base64 latin1'.split(' ').forEach(function(enc) { + assert.equal(Buffer.allocUnsafe(1).write('aaaaaa', 0, 1, enc), 1); +}); + +{ + // Regression test, guard against buffer overrun in the base64 decoder. + var a = Buffer.allocUnsafe(3); + var b = Buffer.from('xxx'); + a.write('aaaaaaaa', 'base64'); + assert.equal(b.toString(), 'xxx'); +} + +// issue GH-3416 +Buffer.from(Buffer.allocUnsafe(0), 0, 0); + +[ 'hex', + 'utf8', + 'utf-8', + 'ascii', + 'latin1', + 'binary', + 'base64', + 'ucs2', + 'ucs-2', + 'utf16le', + 'utf-16le' ].forEach(function(enc) { + assert.equal(Buffer.isEncoding(enc), true); + }); + +[ 'utf9', + 'utf-7', + 'Unicode-FTW', + 'new gnu gun', + false, + NaN, + {}, + Infinity, + [], + 1, + 0, + -1 ].forEach(function(enc) { + assert.equal(Buffer.isEncoding(enc), false); + }); + + +// GH-5110 +{ + var buffer = Buffer.from('test'); + var string = JSON.stringify(buffer); + + assert.strictEqual(string, '{"type":"Buffer","data":[116,101,115,116]}'); + + assert.deepStrictEqual(buffer, JSON.parse(string, function(key, value) { + return value && value.type === 'Buffer' + ? Buffer.from(value.data) + : value; + })); +} + +// issue GH-7849 +{ + var buf = Buffer.from('test'); + var json = JSON.stringify(buf); + var obj = JSON.parse(json); + var copy = Buffer.from(obj); + + assert(buf.equals(copy)); +} + +// issue GH-4331 +assert.throws(function() { + Buffer.allocUnsafe(0xFFFFFFFF); +}, RangeError); +assert.throws(function() { + Buffer.allocUnsafe(0xFFFFFFFFF); +}, RangeError); + + +// attempt to overflow buffers, similar to previous bug in array buffers +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.readFloatLE(0xffffffff); +}, RangeError); + +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.writeFloatLE(0.0, 0xffffffff); +}, RangeError); + +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.readFloatLE(0xffffffff); +}, RangeError); + +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.writeFloatLE(0.0, 0xffffffff); +}, RangeError); + + +// ensure negative values can't get past offset +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.readFloatLE(-1); +}, RangeError); + +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.writeFloatLE(0.0, -1); +}, RangeError); + +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.readFloatLE(-1); +}, RangeError); + +assert.throws(function() { + var buf = Buffer.allocUnsafe(8); + buf.writeFloatLE(0.0, -1); +}, RangeError); + +// offset checks +{ + var buf = Buffer.allocUnsafe(0); + + assert.throws(function() { buf.readUInt8(0); }, RangeError); + assert.throws(function() { buf.readInt8(0); }, RangeError); +} + +{ + var buf = Buffer.from([0xFF]); + + assert.equal(buf.readUInt8(0), 255); + assert.equal(buf.readInt8(0), -1); +} + +[16, 32].forEach(function(bits) { + var buf = Buffer.allocUnsafe(bits / 8 - 1); + + assert.throws(function() { buf['readUInt' + bits + 'BE'](0); }, + RangeError, + 'readUInt' + bits + 'BE'); + + assert.throws(function() { buf['readUInt' + bits + 'LE'](0); }, + RangeError, + 'readUInt' + bits + 'LE'); + + assert.throws(function() { buf['readInt' + bits + 'BE'](0); }, + RangeError, + 'readInt' + bits + 'BE()'); + + assert.throws(function() { buf['readInt' + bits + 'LE'](0); }, + RangeError, + 'readInt' + bits + 'LE()'); +}); + +[16, 32].forEach(function(bits) { + var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF]); + + assert.equal(buf['readUInt' + bits + 'BE'](0), + (0xFFFFFFFF >>> (32 - bits))); + + assert.equal(buf['readUInt' + bits + 'LE'](0), + (0xFFFFFFFF >>> (32 - bits))); + + assert.equal(buf['readInt' + bits + 'BE'](0), + (0xFFFFFFFF >> (32 - bits))); + + assert.equal(buf['readInt' + bits + 'LE'](0), + (0xFFFFFFFF >> (32 - bits))); +}); + +// test for common read(U)IntLE/BE +{ + var buf = Buffer.from([0x01, 0x02, 0x03, 0x04, 0x05, 0x06]); + + assert.strictEqual(buf.readUIntLE(0, 1), 0x01); + assert.strictEqual(buf.readUIntBE(0, 1), 0x01); + assert.strictEqual(buf.readUIntLE(0, 3), 0x030201); + assert.strictEqual(buf.readUIntBE(0, 3), 0x010203); + assert.strictEqual(buf.readUIntLE(0, 5), 0x0504030201); + assert.strictEqual(buf.readUIntBE(0, 5), 0x0102030405); + assert.strictEqual(buf.readUIntLE(0, 6), 0x060504030201); + assert.strictEqual(buf.readUIntBE(0, 6), 0x010203040506); + assert.strictEqual(buf.readIntLE(0, 1), 0x01); + assert.strictEqual(buf.readIntBE(0, 1), 0x01); + assert.strictEqual(buf.readIntLE(0, 3), 0x030201); + assert.strictEqual(buf.readIntBE(0, 3), 0x010203); + assert.strictEqual(buf.readIntLE(0, 5), 0x0504030201); + assert.strictEqual(buf.readIntBE(0, 5), 0x0102030405); + assert.strictEqual(buf.readIntLE(0, 6), 0x060504030201); + assert.strictEqual(buf.readIntBE(0, 6), 0x010203040506); +} + +// test for common write(U)IntLE/BE +{ + var buf = Buffer.allocUnsafe(3); + buf.writeUIntLE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); + assert.equal(buf.readUIntLE(0, 3), 0x123456); + + buf = Buffer.allocUnsafe(3); + buf.writeUIntBE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); + assert.equal(buf.readUIntBE(0, 3), 0x123456); + + buf = Buffer.allocUnsafe(3); + buf.writeIntLE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); + assert.equal(buf.readIntLE(0, 3), 0x123456); + + buf = Buffer.allocUnsafe(3); + buf.writeIntBE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); + assert.equal(buf.readIntBE(0, 3), 0x123456); + + buf = Buffer.allocUnsafe(3); + buf.writeIntLE(-0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xaa, 0xcb, 0xed]); + assert.equal(buf.readIntLE(0, 3), -0x123456); + + buf = Buffer.allocUnsafe(3); + buf.writeIntBE(-0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xed, 0xcb, 0xaa]); + assert.equal(buf.readIntBE(0, 3), -0x123456); + + buf = Buffer.allocUnsafe(3); + buf.writeIntLE(-0x123400, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x00, 0xcc, 0xed]); + assert.equal(buf.readIntLE(0, 3), -0x123400); + + buf = Buffer.allocUnsafe(3); + buf.writeIntBE(-0x123400, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xed, 0xcc, 0x00]); + assert.equal(buf.readIntBE(0, 3), -0x123400); + + buf = Buffer.allocUnsafe(3); + buf.writeIntLE(-0x120000, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x00, 0x00, 0xee]); + assert.equal(buf.readIntLE(0, 3), -0x120000); + + buf = Buffer.allocUnsafe(3); + buf.writeIntBE(-0x120000, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xee, 0x00, 0x00]); + assert.equal(buf.readIntBE(0, 3), -0x120000); + + buf = Buffer.allocUnsafe(5); + buf.writeUIntLE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); + assert.equal(buf.readUIntLE(0, 5), 0x1234567890); + + buf = Buffer.allocUnsafe(5); + buf.writeUIntBE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); + assert.equal(buf.readUIntBE(0, 5), 0x1234567890); + + buf = Buffer.allocUnsafe(5); + buf.writeIntLE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); + assert.equal(buf.readIntLE(0, 5), 0x1234567890); + + buf = Buffer.allocUnsafe(5); + buf.writeIntBE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); + assert.equal(buf.readIntBE(0, 5), 0x1234567890); + + buf = Buffer.allocUnsafe(5); + buf.writeIntLE(-0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x70, 0x87, 0xa9, 0xcb, 0xed]); + assert.equal(buf.readIntLE(0, 5), -0x1234567890); + + buf = Buffer.allocUnsafe(5); + buf.writeIntBE(-0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0xed, 0xcb, 0xa9, 0x87, 0x70]); + assert.equal(buf.readIntBE(0, 5), -0x1234567890); + + buf = Buffer.allocUnsafe(5); + buf.writeIntLE(-0x0012000000, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x00, 0x00, 0x00, 0xee, 0xff]); + assert.equal(buf.readIntLE(0, 5), -0x0012000000); + + buf = Buffer.allocUnsafe(5); + buf.writeIntBE(-0x0012000000, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0xff, 0xee, 0x00, 0x00, 0x00]); + assert.equal(buf.readIntBE(0, 5), -0x0012000000); +} + +// test Buffer slice +{ + var buf = Buffer.from('0123456789'); + assert.equal(buf.slice(-10, 10), '0123456789'); + assert.equal(buf.slice(-20, 10), '0123456789'); + assert.equal(buf.slice(-20, -10), ''); + assert.equal(buf.slice(), '0123456789'); + assert.equal(buf.slice(0), '0123456789'); + assert.equal(buf.slice(0, 0), ''); + assert.equal(buf.slice(undefined), '0123456789'); + assert.equal(buf.slice('foobar'), '0123456789'); + assert.equal(buf.slice(undefined, undefined), '0123456789'); + + assert.equal(buf.slice(2), '23456789'); + assert.equal(buf.slice(5), '56789'); + assert.equal(buf.slice(10), ''); + assert.equal(buf.slice(5, 8), '567'); + assert.equal(buf.slice(8, -1), '8'); + assert.equal(buf.slice(-10), '0123456789'); + assert.equal(buf.slice(0, -9), '0'); + assert.equal(buf.slice(0, -10), ''); + assert.equal(buf.slice(0, -1), '012345678'); + assert.equal(buf.slice(2, -2), '234567'); + assert.equal(buf.slice(0, 65536), '0123456789'); + assert.equal(buf.slice(65536, 0), ''); + assert.equal(buf.slice(-5, -8), ''); + assert.equal(buf.slice(-5, -3), '56'); + assert.equal(buf.slice(-10, 10), '0123456789'); + for (var i = 0, s = buf.toString(); i < buf.length; ++i) { + assert.equal(buf.slice(i), s.slice(i)); + assert.equal(buf.slice(0, i), s.slice(0, i)); + assert.equal(buf.slice(-i), s.slice(-i)); + assert.equal(buf.slice(0, -i), s.slice(0, -i)); + } + + var utf16Buf = Buffer.from('0123456789', 'utf16le'); + // assert.deepStrictEqual(utf16Buf.slice(0, 6), Buffer.from('012', 'utf16le')); + + assert.equal(buf.slice('0', '1'), '0'); + assert.equal(buf.slice('-5', '10'), '56789'); + assert.equal(buf.slice('-10', '10'), '0123456789'); + assert.equal(buf.slice('-10', '-5'), '01234'); + assert.equal(buf.slice('-10', '-0'), ''); + assert.equal(buf.slice('111'), ''); + assert.equal(buf.slice('0', '-111'), ''); + + // try to slice a zero length Buffer + // see https://github.com/joyent/node/issues/5881 + Buffer.alloc(0).slice(0, 1); +} + +// Regression test for #5482: should throw but not assert in C++ land. +assert.throws(function() { + Buffer.from('', 'buffer'); +}, TypeError); + +// Regression test for #6111. Constructing a buffer from another buffer +// should a) work, and b) not corrupt the source buffer. +{ + var a = [0]; + for (var i = 0; i < 7; ++i) a = a.concat(a); + a = a.map(function(_, i) { return i; }); + var b = Buffer.from(a); + var c = Buffer.from(b); + assert.strictEqual(b.length, a.length); + assert.strictEqual(c.length, a.length); + for (var i = 0, k = a.length; i < k; ++i) { + assert.strictEqual(a[i], i); + assert.strictEqual(b[i], i); + assert.strictEqual(c[i], i); + } +} + + +assert.throws(function() { + Buffer.allocUnsafe((-1 >>> 0) + 1); +}, RangeError); + +assert.throws(function() { + Buffer.allocUnsafeSlow((-1 >>> 0) + 1); +}, RangeError); + +if (common.hasCrypto) { + // Test truncation after decode + var crypto = require('crypto'); + + var b1 = Buffer.from('YW55=======', 'base64'); + var b2 = Buffer.from('YW55', 'base64'); + + assert.equal( + crypto.createHash('sha1').update(b1).digest('hex'), + crypto.createHash('sha1').update(b2).digest('hex') + ); +} else { + common.skip('missing crypto'); +} + +// Test Compare +{ + var b = Buffer.alloc(1, 'a'); + var c = Buffer.alloc(1, 'c'); + var d = Buffer.alloc(2, 'aa'); + + assert.equal(b.compare(c), -1); + assert.equal(c.compare(d), 1); + assert.equal(d.compare(b), 1); + assert.equal(b.compare(d), -1); + assert.equal(b.compare(b), 0); + + assert.equal(Buffer.compare(b, c), -1); + assert.equal(Buffer.compare(c, d), 1); + assert.equal(Buffer.compare(d, b), 1); + assert.equal(Buffer.compare(b, d), -1); + assert.equal(Buffer.compare(c, c), 0); + + assert.equal(Buffer.compare(Buffer.alloc(0), Buffer.alloc(0)), 0); + assert.equal(Buffer.compare(Buffer.alloc(0), Buffer.alloc(1)), -1); + assert.equal(Buffer.compare(Buffer.alloc(1), Buffer.alloc(0)), 1); +} + +assert.throws(function() { + var b = Buffer.allocUnsafe(1); + Buffer.compare(b, 'abc'); +}); + +assert.throws(function() { + var b = Buffer.allocUnsafe(1); + Buffer.compare('abc', b); +}); + +assert.throws(function() { + var b = Buffer.allocUnsafe(1); + b.compare('abc'); +}); + +// Test Equals +{ + var b = Buffer.alloc(5, 'abcdf'); + var c = Buffer.alloc(5, 'abcdf'); + var d = Buffer.alloc(5, 'abcde'); + var e = Buffer.alloc(6, 'abcdef'); + + assert.ok(b.equals(c)); + assert.ok(!c.equals(d)); + assert.ok(!d.equals(e)); + assert.ok(d.equals(d)); +} + +assert.throws(function() { + var b = Buffer.allocUnsafe(1); + b.equals('abc'); +}); + +// Regression test for https://github.com/nodejs/node/issues/649. +assert.throws(() => { Buffer.allocUnsafe(1422561062959).toString('utf8');}); + +var ps = Buffer.poolSize; +Buffer.poolSize = 0; +assert.equal(Buffer.allocUnsafe(1).parent, undefined); +Buffer.poolSize = ps; + +// Test Buffer.copy() segfault +assert.throws(function() { + Buffer.allocUnsafe(10).copy(); +}); + +var regErrorMsg = new RegExp('First argument must be a string, Buffer, ' + + 'ArrayBuffer, Array, or array-like object.'); + +assert.throws(function() { + Buffer.from(); +}, regErrorMsg); + +assert.throws(function() { + Buffer.from(null); +}, regErrorMsg); + + +// Test that ParseArrayIndex handles full uint32 +assert.throws(function() { + Buffer.from(new ArrayBuffer(0), -1 >>> 0); +}, /RangeError: 'offset' is out of bounds/); + +// ParseArrayIndex() should reject values that don't fit in a 32 bits size_t. +assert.throws(() => { + var a = Buffer(1).fill(0); + var b = Buffer(1).fill(0); + a.copy(b, 0, 0x100000000, 0x100000001); +}), /out of range index/; + +// Unpooled buffer (replaces SlowBuffer) +var ubuf = Buffer.allocUnsafeSlow(10); +assert(ubuf); +assert(ubuf.buffer); +assert.equal(ubuf.buffer.byteLength, 10); + +// Regression test +assert.doesNotThrow(() => { + Buffer.from(new ArrayBuffer()); +}); + +assert.throws(() => Buffer.alloc(-Buffer.poolSize), + '"size" argument must not be negative'); +assert.throws(() => Buffer.alloc(-100), + '"size" argument must not be negative'); +assert.throws(() => Buffer.allocUnsafe(-Buffer.poolSize), + '"size" argument must not be negative'); +assert.throws(() => Buffer.allocUnsafe(-100), + '"size" argument must not be negative'); +assert.throws(() => Buffer.allocUnsafeSlow(-Buffer.poolSize), + '"size" argument must not be negative'); +assert.throws(() => Buffer.allocUnsafeSlow(-100), + '"size" argument must not be negative'); + +assert.throws(() => Buffer.alloc({ valueOf: () => 1 }), + /"size" argument must be a number/); +assert.throws(() => Buffer.alloc({ valueOf: () => -1 }), + /"size" argument must be a number/); + diff --git a/node_modules/buffer/test/node/test-buffer-arraybuffer.js b/node_modules/buffer/test/node/test-buffer-arraybuffer.js new file mode 100644 index 0000000..a418752 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-arraybuffer.js @@ -0,0 +1,112 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); + +var Buffer = require('../../').Buffer; +var LENGTH = 16; + +var ab = new ArrayBuffer(LENGTH); +var dv = new DataView(ab); +var ui = new Uint8Array(ab); +var buf = Buffer.from(ab); + + +assert.ok(buf instanceof Buffer); +// For backwards compatibility of old .parent property test that if buf is not +// a slice then .parent should be undefined. +assert.equal(buf.parent, undefined); +assert.equal(buf.buffer, ab); +assert.equal(buf.length, ab.byteLength); + + +buf.fill(0xC); +for (var i = 0; i < LENGTH; i++) { + assert.equal(ui[i], 0xC); + ui[i] = 0xF; + assert.equal(buf[i], 0xF); +} + +buf.writeUInt32LE(0xF00, 0); +buf.writeUInt32BE(0xB47, 4); +buf.writeDoubleLE(3.1415, 8); + +assert.equal(dv.getUint32(0, true), 0xF00); +assert.equal(dv.getUint32(4), 0xB47); +assert.equal(dv.getFloat64(8, true), 3.1415); + + +// Now test protecting users from doing stupid things + +assert.throws(function() { + function AB() { } + Object.setPrototypeOf(AB, ArrayBuffer); + Object.setPrototypeOf(AB.prototype, ArrayBuffer.prototype); + Buffer.from(new AB()); +}, TypeError); + +// write{Double,Float}{LE,BE} with noAssert should not crash, cf. #3766 +var b = Buffer.allocUnsafe(1); +b.writeFloatLE(11.11, 0, true); +b.writeFloatBE(11.11, 0, true); +b.writeDoubleLE(11.11, 0, true); +b.writeDoubleBE(11.11, 0, true); + +// Test the byteOffset and length arguments +{ + var ab = new Uint8Array(5); + ab[0] = 1; + ab[1] = 2; + ab[2] = 3; + ab[3] = 4; + ab[4] = 5; + var buf = Buffer.from(ab.buffer, 1, 3); + assert.equal(buf.length, 3); + assert.equal(buf[0], 2); + assert.equal(buf[1], 3); + assert.equal(buf[2], 4); + buf[0] = 9; + assert.equal(ab[1], 9); + + assert.throws(() => Buffer.from(ab.buffer, 6), (err) => { + assert(err instanceof RangeError); + assert(/'offset' is out of bounds/.test(err.message)); + return true; + }); + assert.throws(() => Buffer.from(ab.buffer, 3, 6), (err) => { + assert(err instanceof RangeError); + assert(/'length' is out of bounds/.test(err.message)); + return true; + }); +} + +// Test the deprecated Buffer() version also +{ + var ab = new Uint8Array(5); + ab[0] = 1; + ab[1] = 2; + ab[2] = 3; + ab[3] = 4; + ab[4] = 5; + var buf = Buffer(ab.buffer, 1, 3); + assert.equal(buf.length, 3); + assert.equal(buf[0], 2); + assert.equal(buf[1], 3); + assert.equal(buf[2], 4); + buf[0] = 9; + assert.equal(ab[1], 9); + + assert.throws(() => Buffer(ab.buffer, 6), (err) => { + assert(err instanceof RangeError); + assert(/'offset' is out of bounds/.test(err.message)); + return true; + }); + assert.throws(() => Buffer(ab.buffer, 3, 6), (err) => { + assert(err instanceof RangeError); + assert(/'length' is out of bounds/.test(err.message)); + return true; + }); +} + diff --git a/node_modules/buffer/test/node/test-buffer-ascii.js b/node_modules/buffer/test/node/test-buffer-ascii.js new file mode 100644 index 0000000..4a06098 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-ascii.js @@ -0,0 +1,28 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); + +// ASCII conversion in node.js simply masks off the high bits, +// it doesn't do transliteration. +assert.equal(Buffer.from('hérité').toString('ascii'), 'hC)ritC)'); + +// 71 characters, 78 bytes. The ’ character is a triple-byte sequence. +var input = 'C’est, graphiquement, la réunion d’un accent aigu ' + + 'et d’un accent grave.'; + +var expected = 'Cb\u0000\u0019est, graphiquement, la rC)union ' + + 'db\u0000\u0019un accent aigu et db\u0000\u0019un ' + + 'accent grave.'; + +var buf = Buffer.from(input); + +for (var i = 0; i < expected.length; ++i) { + assert.equal(buf.slice(i).toString('ascii'), expected.slice(i)); + + // Skip remainder of multi-byte sequence. + if (input.charCodeAt(i) > 65535) ++i; + if (input.charCodeAt(i) > 127) ++i; +} + diff --git a/node_modules/buffer/test/node/test-buffer-bad-overload.js b/node_modules/buffer/test/node/test-buffer-bad-overload.js new file mode 100644 index 0000000..282227d --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-bad-overload.js @@ -0,0 +1,18 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); + +assert.doesNotThrow(function() { + Buffer.allocUnsafe(10); +}); + +assert.throws(function() { + Buffer.from(10, 'hex'); +}); + +assert.doesNotThrow(function() { + Buffer.from('deadbeaf', 'hex'); +}); + diff --git a/node_modules/buffer/test/node/test-buffer-badhex.js b/node_modules/buffer/test/node/test-buffer-badhex.js new file mode 100644 index 0000000..fd7851d --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-badhex.js @@ -0,0 +1,46 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); +var Buffer = require('../../').Buffer; + +// Test hex strings and bad hex strings +{ + var buf1 = Buffer.alloc(4); + assert.strictEqual(buf1.length, 4); + assert.deepStrictEqual(buf1, new Buffer([0, 0, 0, 0])); + assert.strictEqual(buf1.write('abcdxx', 0, 'hex'), 2); + assert.deepStrictEqual(buf1, new Buffer([0xab, 0xcd, 0x00, 0x00])); + assert.strictEqual(buf1.toString('hex'), 'abcd0000'); + assert.strictEqual(buf1.write('abcdef01', 0, 'hex'), 4); + assert.deepStrictEqual(buf1, new Buffer([0xab, 0xcd, 0xef, 0x01])); + assert.strictEqual(buf1.toString('hex'), 'abcdef01'); + + var buf2 = Buffer.from(buf1.toString('hex'), 'hex'); + assert.strictEqual(buf1.toString('hex'), buf2.toString('hex')); + + var buf3 = Buffer.alloc(5); + assert.strictEqual(buf3.write('abcdxx', 1, 'hex'), 2); + assert.strictEqual(buf3.toString('hex'), '00abcd0000'); + + var buf4 = Buffer.alloc(4); + assert.deepStrictEqual(buf4, new Buffer([0, 0, 0, 0])); + assert.strictEqual(buf4.write('xxabcd', 0, 'hex'), 0); + assert.deepStrictEqual(buf4, new Buffer([0, 0, 0, 0])); + assert.strictEqual(buf4.write('xxab', 1, 'hex'), 0); + assert.deepStrictEqual(buf4, new Buffer([0, 0, 0, 0])); + assert.strictEqual(buf4.write('cdxxab', 0, 'hex'), 1); + assert.deepStrictEqual(buf4, new Buffer([0xcd, 0, 0, 0])); + + var buf5 = Buffer.alloc(256); + for (var i = 0; i < 256; i++) + buf5[i] = i; + + var hex = buf5.toString('hex'); + assert.deepStrictEqual(Buffer.from(hex, 'hex'), buf5); + + var badHex = hex.slice(0, 256) + 'xx' + hex.slice(256, 510); + assert.deepStrictEqual(Buffer.from(badHex, 'hex'), buf5.slice(0, 128)); +} + diff --git a/node_modules/buffer/test/node/test-buffer-bytelength.js b/node_modules/buffer/test/node/test-buffer-bytelength.js new file mode 100644 index 0000000..8d7dc35 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-bytelength.js @@ -0,0 +1,90 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); +var Buffer = require('../../').Buffer; +var SlowBuffer = require('../../').SlowBuffer; + +// coerce values to string +assert.equal(Buffer.byteLength(32, 'latin1'), 2); +assert.equal(Buffer.byteLength(NaN, 'utf8'), 3); +assert.equal(Buffer.byteLength({}, 'latin1'), 15); +assert.equal(Buffer.byteLength(), 9); + +var buff = new Buffer(10); +assert(ArrayBuffer.isView(buff)); +var slowbuff = new SlowBuffer(10); +assert(ArrayBuffer.isView(slowbuff)); + +// buffer +var incomplete = Buffer.from([0xe4, 0xb8, 0xad, 0xe6, 0x96]); +assert.equal(Buffer.byteLength(incomplete), 5); +var ascii = Buffer.from('abc'); +assert.equal(Buffer.byteLength(ascii), 3); + +// ArrayBuffer +var buffer = new ArrayBuffer(8); +assert.equal(Buffer.byteLength(buffer), 8); + +// TypedArray +var int8 = new Int8Array(8); +assert.equal(Buffer.byteLength(int8), 8); +var uint8 = new Uint8Array(8); +assert.equal(Buffer.byteLength(uint8), 8); +var uintc8 = new Uint8ClampedArray(2); +assert.equal(Buffer.byteLength(uintc8), 2); +var int16 = new Int16Array(8); +assert.equal(Buffer.byteLength(int16), 16); +var uint16 = new Uint16Array(8); +assert.equal(Buffer.byteLength(uint16), 16); +var int32 = new Int32Array(8); +assert.equal(Buffer.byteLength(int32), 32); +var uint32 = new Uint32Array(8); +assert.equal(Buffer.byteLength(uint32), 32); +var float32 = new Float32Array(8); +assert.equal(Buffer.byteLength(float32), 32); +var float64 = new Float64Array(8); +assert.equal(Buffer.byteLength(float64), 64); + +// DataView +var dv = new DataView(new ArrayBuffer(2)); +assert.equal(Buffer.byteLength(dv), 2); + +// special case: zero length string +assert.equal(Buffer.byteLength('', 'ascii'), 0); +assert.equal(Buffer.byteLength('', 'HeX'), 0); + +// utf8 +assert.equal(Buffer.byteLength('∑éllö wørl∂!', 'utf-8'), 19); +assert.equal(Buffer.byteLength('κλμνξο', 'utf8'), 12); +assert.equal(Buffer.byteLength('挵挶挷挸挹', 'utf-8'), 15); +assert.equal(Buffer.byteLength('𠝹𠱓𠱸', 'UTF8'), 12); +// without an encoding, utf8 should be assumed +assert.equal(Buffer.byteLength('hey there'), 9); +assert.equal(Buffer.byteLength('𠱸挶νξ#xx :)'), 17); +assert.equal(Buffer.byteLength('hello world', ''), 11); +// it should also be assumed with unrecognized encoding +assert.equal(Buffer.byteLength('hello world', 'abc'), 11); +assert.equal(Buffer.byteLength('ßœ∑≈', 'unkn0wn enc0ding'), 10); + +// base64 +assert.equal(Buffer.byteLength('aGVsbG8gd29ybGQ=', 'base64'), 11); +assert.equal(Buffer.byteLength('bm9kZS5qcyByb2NrcyE=', 'base64'), 14); +assert.equal(Buffer.byteLength('aGkk', 'base64'), 3); +assert.equal(Buffer.byteLength('bHNrZGZsa3NqZmtsc2xrZmFqc2RsZmtqcw==', + 'base64'), 25); +// special padding +assert.equal(Buffer.byteLength('aaa=', 'base64'), 2); +assert.equal(Buffer.byteLength('aaaa==', 'base64'), 3); + +assert.equal(Buffer.byteLength('Il était tué'), 14); +assert.equal(Buffer.byteLength('Il était tué', 'utf8'), 14); +assert.equal(Buffer.byteLength('Il était tué', 'ascii'), 12); +assert.equal(Buffer.byteLength('Il était tué', 'latin1'), 12); +assert.equal(Buffer.byteLength('Il était tué', 'binary'), 12); +['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { + assert.equal(24, Buffer.byteLength('Il était tué', encoding)); +}); + diff --git a/node_modules/buffer/test/node/test-buffer-compare-offset.js b/node_modules/buffer/test/node/test-buffer-compare-offset.js new file mode 100644 index 0000000..f1984ed --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-compare-offset.js @@ -0,0 +1,66 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); + +var a = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9, 0]); +var b = Buffer.from([5, 6, 7, 8, 9, 0, 1, 2, 3, 4]); + +assert.equal(-1, a.compare(b)); + +// Equivalent to a.compare(b). +assert.equal(-1, a.compare(b, 0)); +assert.equal(-1, a.compare(b, '0')); + +// Equivalent to a.compare(b). +assert.equal(-1, a.compare(b, 0, undefined, 0)); + +// Zero-length targer, return 1 +assert.equal(1, a.compare(b, 0, 0, 0)); +assert.equal(1, a.compare(b, '0', '0', '0')); + +// Equivalent to Buffer.compare(a, b.slice(6, 10)) +assert.equal(1, a.compare(b, 6, 10)); + +// Zero-length source, return -1 +assert.equal(-1, a.compare(b, 6, 10, 0, 0)); + +// Equivalent to Buffer.compare(a.slice(4), b.slice(0, 5)) +assert.equal(1, a.compare(b, 0, 5, 4)); + +// Equivalent to Buffer.compare(a.slice(1), b.slice(5)) +assert.equal(1, a.compare(b, 5, undefined, 1)); + +// Equivalent to Buffer.compare(a.slice(2), b.slice(2, 4)) +assert.equal(-1, a.compare(b, 2, 4, 2)); + +// Equivalent to Buffer.compare(a.slice(4), b.slice(0, 7)) +assert.equal(-1, a.compare(b, 0, 7, 4)); + +// Equivalent to Buffer.compare(a.slice(4, 6), b.slice(0, 7)); +assert.equal(-1, a.compare(b, 0, 7, 4, 6)); + +// zero length target +assert.equal(1, a.compare(b, 0, null)); + +// coerces to targetEnd == 5 +assert.equal(-1, a.compare(b, 0, {valueOf: () => 5})); + +// zero length target +assert.equal(1, a.compare(b, Infinity, -Infinity)); + +// zero length target because default for targetEnd <= targetSource +assert.equal(1, a.compare(b, '0xff')); + +var oor = /out of range index/; + +assert.throws(() => a.compare(b, 0, 100, 0), oor); +assert.throws(() => a.compare(b, 0, 1, 0, 100), oor); +assert.throws(() => a.compare(b, -1), oor); +assert.throws(() => a.compare(b, 0, '0xff'), oor); +assert.throws(() => a.compare(b, 0, Infinity), oor); +assert.throws(() => a.compare(b, -Infinity, Infinity), oor); +assert.throws(() => a.compare(), /Argument must be a Buffer/); + diff --git a/node_modules/buffer/test/node/test-buffer-concat.js b/node_modules/buffer/test/node/test-buffer-concat.js new file mode 100644 index 0000000..c0dc4da --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-concat.js @@ -0,0 +1,40 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); + +var zero = []; +var one = [ Buffer.from('asdf') ]; +var long = []; +for (var i = 0; i < 10; i++) long.push(Buffer.from('asdf')); + +var flatZero = Buffer.concat(zero); +var flatOne = Buffer.concat(one); +var flatLong = Buffer.concat(long); +var flatLongLen = Buffer.concat(long, 40); + +assert(flatZero.length === 0); +assert(flatOne.toString() === 'asdf'); +// A special case where concat used to return the first item, +// if the length is one. This check is to make sure that we don't do that. +assert(flatOne !== one[0]); +assert(flatLong.toString() === (new Array(10 + 1).join('asdf'))); +assert(flatLongLen.toString() === (new Array(10 + 1).join('asdf'))); + +assertWrongList(); +assertWrongList(null); +assertWrongList(Buffer.from('hello')); +assertWrongList([42]); +assertWrongList(['hello', 'world']); +assertWrongList(['hello', Buffer.from('world')]); + +function assertWrongList(value) { + assert.throws(function() { + Buffer.concat(value); + }, function(err) { + return err instanceof TypeError && + err.message === '"list" argument must be an Array of Buffers'; + }); +} + diff --git a/node_modules/buffer/test/node/test-buffer-fill.js b/node_modules/buffer/test/node/test-buffer-fill.js new file mode 100644 index 0000000..7138094 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-fill.js @@ -0,0 +1,272 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); +var os = require('os'); +var SIZE = 28; + +var buf1 = Buffer.allocUnsafe(SIZE); +var buf2 = Buffer.allocUnsafe(SIZE); + + +// Default encoding +testBufs('abc'); +testBufs('\u0222aa'); +testBufs('a\u0234b\u0235c\u0236'); +testBufs('abc', 4); +testBufs('abc', 5); +testBufs('abc', SIZE); +testBufs('\u0222aa', 2); +testBufs('\u0222aa', 8); +testBufs('a\u0234b\u0235c\u0236', 4); +testBufs('a\u0234b\u0235c\u0236', 12); +testBufs('abc', 4, -1); +testBufs('abc', 4, 1); +testBufs('abc', 5, 1); +testBufs('\u0222aa', 2, -1); +testBufs('\u0222aa', 8, 1); +testBufs('a\u0234b\u0235c\u0236', 4, -1); +testBufs('a\u0234b\u0235c\u0236', 4, 1); +testBufs('a\u0234b\u0235c\u0236', 12, 1); + + +// UTF8 +testBufs('abc', 'utf8'); +testBufs('\u0222aa', 'utf8'); +testBufs('a\u0234b\u0235c\u0236', 'utf8'); +testBufs('abc', 4, 'utf8'); +testBufs('abc', 5, 'utf8'); +testBufs('abc', SIZE, 'utf8'); +testBufs('\u0222aa', 2, 'utf8'); +testBufs('\u0222aa', 8, 'utf8'); +testBufs('a\u0234b\u0235c\u0236', 4, 'utf8'); +testBufs('a\u0234b\u0235c\u0236', 12, 'utf8'); +testBufs('abc', 4, -1, 'utf8'); +testBufs('abc', 4, 1, 'utf8'); +testBufs('abc', 5, 1, 'utf8'); +testBufs('\u0222aa', 2, -1, 'utf8'); +testBufs('\u0222aa', 8, 1, 'utf8'); +testBufs('a\u0234b\u0235c\u0236', 4, -1, 'utf8'); +testBufs('a\u0234b\u0235c\u0236', 4, 1, 'utf8'); +testBufs('a\u0234b\u0235c\u0236', 12, 1, 'utf8'); +assert.equal(Buffer.allocUnsafe(1).fill(0).fill('\u0222')[0], 0xc8); + + +// BINARY +testBufs('abc', 'binary'); +testBufs('\u0222aa', 'binary'); +testBufs('a\u0234b\u0235c\u0236', 'binary'); +testBufs('abc', 4, 'binary'); +testBufs('abc', 5, 'binary'); +testBufs('abc', SIZE, 'binary'); +testBufs('\u0222aa', 2, 'binary'); +testBufs('\u0222aa', 8, 'binary'); +testBufs('a\u0234b\u0235c\u0236', 4, 'binary'); +testBufs('a\u0234b\u0235c\u0236', 12, 'binary'); +testBufs('abc', 4, -1, 'binary'); +testBufs('abc', 4, 1, 'binary'); +testBufs('abc', 5, 1, 'binary'); +testBufs('\u0222aa', 2, -1, 'binary'); +testBufs('\u0222aa', 8, 1, 'binary'); +testBufs('a\u0234b\u0235c\u0236', 4, -1, 'binary'); +testBufs('a\u0234b\u0235c\u0236', 4, 1, 'binary'); +testBufs('a\u0234b\u0235c\u0236', 12, 1, 'binary'); + + +// LATIN1 +testBufs('abc', 'latin1'); +testBufs('\u0222aa', 'latin1'); +testBufs('a\u0234b\u0235c\u0236', 'latin1'); +testBufs('abc', 4, 'latin1'); +testBufs('abc', 5, 'latin1'); +testBufs('abc', SIZE, 'latin1'); +testBufs('\u0222aa', 2, 'latin1'); +testBufs('\u0222aa', 8, 'latin1'); +testBufs('a\u0234b\u0235c\u0236', 4, 'latin1'); +testBufs('a\u0234b\u0235c\u0236', 12, 'latin1'); +testBufs('abc', 4, -1, 'latin1'); +testBufs('abc', 4, 1, 'latin1'); +testBufs('abc', 5, 1, 'latin1'); +testBufs('\u0222aa', 2, -1, 'latin1'); +testBufs('\u0222aa', 8, 1, 'latin1'); +testBufs('a\u0234b\u0235c\u0236', 4, -1, 'latin1'); +testBufs('a\u0234b\u0235c\u0236', 4, 1, 'latin1'); +testBufs('a\u0234b\u0235c\u0236', 12, 1, 'latin1'); + + +// UCS2 +testBufs('abc', 'ucs2'); +testBufs('\u0222aa', 'ucs2'); +testBufs('a\u0234b\u0235c\u0236', 'ucs2'); +testBufs('abc', 4, 'ucs2'); +testBufs('abc', SIZE, 'ucs2'); +testBufs('\u0222aa', 2, 'ucs2'); +testBufs('\u0222aa', 8, 'ucs2'); +testBufs('a\u0234b\u0235c\u0236', 4, 'ucs2'); +testBufs('a\u0234b\u0235c\u0236', 12, 'ucs2'); +testBufs('abc', 4, -1, 'ucs2'); +testBufs('abc', 4, 1, 'ucs2'); +testBufs('abc', 5, 1, 'ucs2'); +testBufs('\u0222aa', 2, -1, 'ucs2'); +testBufs('\u0222aa', 8, 1, 'ucs2'); +testBufs('a\u0234b\u0235c\u0236', 4, -1, 'ucs2'); +testBufs('a\u0234b\u0235c\u0236', 4, 1, 'ucs2'); +testBufs('a\u0234b\u0235c\u0236', 12, 1, 'ucs2'); +assert.equal(Buffer.allocUnsafe(1).fill('\u0222', 'ucs2')[0], + os.endianness() === 'LE' ? 0x22 : 0x02); + + +// HEX +testBufs('616263', 'hex'); +testBufs('c8a26161', 'hex'); +testBufs('61c8b462c8b563c8b6', 'hex'); +testBufs('616263', 4, 'hex'); +testBufs('616263', 5, 'hex'); +testBufs('616263', SIZE, 'hex'); +testBufs('c8a26161', 2, 'hex'); +testBufs('c8a26161', 8, 'hex'); +testBufs('61c8b462c8b563c8b6', 4, 'hex'); +testBufs('61c8b462c8b563c8b6', 12, 'hex'); +testBufs('616263', 4, -1, 'hex'); +testBufs('616263', 4, 1, 'hex'); +testBufs('616263', 5, 1, 'hex'); +testBufs('c8a26161', 2, -1, 'hex'); +testBufs('c8a26161', 8, 1, 'hex'); +testBufs('61c8b462c8b563c8b6', 4, -1, 'hex'); +testBufs('61c8b462c8b563c8b6', 4, 1, 'hex'); +testBufs('61c8b462c8b563c8b6', 12, 1, 'hex'); +// Make sure this operation doesn't go on forever +buf1.fill('yKJh', 'hex'); +assert.throws(() => buf1.fill('\u0222', 'hex')); + + +// BASE64 +testBufs('YWJj', 'ucs2'); +testBufs('yKJhYQ==', 'ucs2'); +testBufs('Yci0Ysi1Y8i2', 'ucs2'); +testBufs('YWJj', 4, 'ucs2'); +testBufs('YWJj', SIZE, 'ucs2'); +testBufs('yKJhYQ==', 2, 'ucs2'); +testBufs('yKJhYQ==', 8, 'ucs2'); +testBufs('Yci0Ysi1Y8i2', 4, 'ucs2'); +testBufs('Yci0Ysi1Y8i2', 12, 'ucs2'); +testBufs('YWJj', 4, -1, 'ucs2'); +testBufs('YWJj', 4, 1, 'ucs2'); +testBufs('YWJj', 5, 1, 'ucs2'); +testBufs('yKJhYQ==', 2, -1, 'ucs2'); +testBufs('yKJhYQ==', 8, 1, 'ucs2'); +testBufs('Yci0Ysi1Y8i2', 4, -1, 'ucs2'); +testBufs('Yci0Ysi1Y8i2', 4, 1, 'ucs2'); +testBufs('Yci0Ysi1Y8i2', 12, 1, 'ucs2'); + + +// Buffer +function deepStrictEqualValues(buf, arr) { + for (var [index, value] of buf.entries()) { + assert.deepStrictEqual(value, arr[index]); + } +} + + +var buf2Fill = Buffer.allocUnsafe(1).fill(2); +deepStrictEqualValues(genBuffer(4, [buf2Fill]), [2, 2, 2, 2]); +deepStrictEqualValues(genBuffer(4, [buf2Fill, 1]), [0, 2, 2, 2]); +deepStrictEqualValues(genBuffer(4, [buf2Fill, 1, 3]), [0, 2, 2, 0]); +deepStrictEqualValues(genBuffer(4, [buf2Fill, 1, 1]), [0, 0, 0, 0]); +deepStrictEqualValues(genBuffer(4, [buf2Fill, 1, -1]), [0, 0, 0, 0]); +var hexBufFill = Buffer.allocUnsafe(2).fill(0).fill('0102', 'hex'); +deepStrictEqualValues(genBuffer(4, [hexBufFill]), [1, 2, 1, 2]); +deepStrictEqualValues(genBuffer(4, [hexBufFill, 1]), [0, 1, 2, 1]); +deepStrictEqualValues(genBuffer(4, [hexBufFill, 1, 3]), [0, 1, 2, 0]); +deepStrictEqualValues(genBuffer(4, [hexBufFill, 1, 1]), [0, 0, 0, 0]); +deepStrictEqualValues(genBuffer(4, [hexBufFill, 1, -1]), [0, 0, 0, 0]); + + +// Check exceptions +assert.throws(() => buf1.fill(0, -1)); +assert.throws(() => buf1.fill(0, 0, buf1.length + 1)); +assert.throws(() => buf1.fill('', -1)); +assert.throws(() => buf1.fill('', 0, buf1.length + 1)); +assert.throws(() => buf1.fill('a', 0, buf1.length, 'node rocks!')); +assert.throws(() => buf1.fill('a', 0, 0, NaN)); +assert.throws(() => buf1.fill('a', 0, 0, null)); +assert.throws(() => buf1.fill('a', 0, 0, 'foo')); + + +function genBuffer(size, args) { + var b = Buffer.allocUnsafe(size); + return b.fill(0).fill.apply(b, args); +} + + +function bufReset() { + buf1.fill(0); + buf2.fill(0); +} + + +// This is mostly accurate. Except write() won't write partial bytes to the +// string while fill() blindly copies bytes into memory. To account for that an +// error will be thrown if not all the data can be written, and the SIZE has +// been massaged to work with the input characters. +function writeToFill(string, offset, end, encoding) { + if (typeof offset === 'string') { + encoding = offset; + offset = 0; + end = buf2.length; + } else if (typeof end === 'string') { + encoding = end; + end = buf2.length; + } else if (end === undefined) { + end = buf2.length; + } + + if (offset < 0 || end > buf2.length) + throw new RangeError('Out of range index'); + + if (end <= offset) + return buf2; + + offset >>>= 0; + end >>>= 0; + assert(offset <= buf2.length); + + // Convert "end" to "length" (which write understands). + var length = end - offset < 0 ? 0 : end - offset; + + var wasZero = false; + do { + var written = buf2.write(string, offset, length, encoding); + offset += written; + // Safety check in case write falls into infinite loop. + if (written === 0) { + if (wasZero) + throw new Error('Could not write all data to Buffer'); + else + wasZero = true; + } + } while (offset < buf2.length); + + // Correction for UCS2 operations. + if (os.endianness() === 'BE' && encoding === 'ucs2') { + for (var i = 0; i < buf2.length; i += 2) { + var tmp = buf2[i]; + buf2[i] = buf2[i + 1]; + buf2[i + 1] = tmp; + } + } + + return buf2; +} + + +function testBufs(string, offset, length, encoding) { + bufReset(); + buf1.fill.apply(buf1, arguments); + // Swap bytes on BE archs for ucs2 encoding. + assert.deepStrictEqual(buf1.fill.apply(buf1, arguments), + writeToFill.apply(null, arguments)); +} + diff --git a/node_modules/buffer/test/node/test-buffer-includes.js b/node_modules/buffer/test/node/test-buffer-includes.js new file mode 100644 index 0000000..2096a34 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-includes.js @@ -0,0 +1,305 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); + +var Buffer = require('../../').Buffer; + +var b = Buffer.from('abcdef'); +var buf_a = Buffer.from('a'); +var buf_bc = Buffer.from('bc'); +var buf_f = Buffer.from('f'); +var buf_z = Buffer.from('z'); +var buf_empty = Buffer.from(''); + +assert(b.includes('a')); +assert(!b.includes('a', 1)); +assert(!b.includes('a', -1)); +assert(!b.includes('a', -4)); +assert(b.includes('a', -b.length)); +assert(b.includes('a', NaN)); +assert(b.includes('a', -Infinity)); +assert(!b.includes('a', Infinity)); +assert(b.includes('bc')); +assert(!b.includes('bc', 2)); +assert(!b.includes('bc', -1)); +assert(!b.includes('bc', -3)); +assert(b.includes('bc', -5)); +assert(b.includes('bc', NaN)); +assert(b.includes('bc', -Infinity)); +assert(!b.includes('bc', Infinity)); +assert(b.includes('f'), b.length - 1); +assert(!b.includes('z')); +assert(!b.includes('')); +assert(!b.includes('', 1)); +assert(!b.includes('', b.length + 1)); +assert(!b.includes('', Infinity)); +assert(b.includes(buf_a)); +assert(!b.includes(buf_a, 1)); +assert(!b.includes(buf_a, -1)); +assert(!b.includes(buf_a, -4)); +assert(b.includes(buf_a, -b.length)); +assert(b.includes(buf_a, NaN)); +assert(b.includes(buf_a, -Infinity)); +assert(!b.includes(buf_a, Infinity)); +assert(b.includes(buf_bc)); +assert(!b.includes(buf_bc, 2)); +assert(!b.includes(buf_bc, -1)); +assert(!b.includes(buf_bc, -3)); +assert(b.includes(buf_bc, -5)); +assert(b.includes(buf_bc, NaN)); +assert(b.includes(buf_bc, -Infinity)); +assert(!b.includes(buf_bc, Infinity)); +assert(b.includes(buf_f), b.length - 1); +assert(!b.includes(buf_z)); +assert(!b.includes(buf_empty)); +assert(!b.includes(buf_empty, 1)); +assert(!b.includes(buf_empty, b.length + 1)); +assert(!b.includes(buf_empty, Infinity)); +assert(b.includes(0x61)); +assert(!b.includes(0x61, 1)); +assert(!b.includes(0x61, -1)); +assert(!b.includes(0x61, -4)); +assert(b.includes(0x61, -b.length)); +assert(b.includes(0x61, NaN)); +assert(b.includes(0x61, -Infinity)); +assert(!b.includes(0x61, Infinity)); +assert(!b.includes(0x0)); + +// test offsets +assert(b.includes('d', 2)); +assert(b.includes('f', 5)); +assert(b.includes('f', -1)); +assert(!b.includes('f', 6)); + +assert(b.includes(Buffer.from('d'), 2)); +assert(b.includes(Buffer.from('f'), 5)); +assert(b.includes(Buffer.from('f'), -1)); +assert(!b.includes(Buffer.from('f'), 6)); + +assert(!Buffer.from('ff').includes(Buffer.from('f'), 1, 'ucs2')); + +// test hex encoding +assert.strictEqual( + Buffer.from(b.toString('hex'), 'hex') + .includes('64', 0, 'hex'), + true +); +assert.strictEqual( + Buffer.from(b.toString('hex'), 'hex') + .includes(Buffer.from('64', 'hex'), 0, 'hex'), + true +); + +// test base64 encoding +assert.strictEqual( + Buffer.from(b.toString('base64'), 'base64') + .includes('ZA==', 0, 'base64'), + true +); +assert.strictEqual( + Buffer.from(b.toString('base64'), 'base64') + .includes(Buffer.from('ZA==', 'base64'), 0, 'base64'), + true +); + +// test ascii encoding +assert.strictEqual( + Buffer.from(b.toString('ascii'), 'ascii') + .includes('d', 0, 'ascii'), + true +); +assert.strictEqual( + Buffer.from(b.toString('ascii'), 'ascii') + .includes(Buffer.from('d', 'ascii'), 0, 'ascii'), + true +); + +// test latin1 encoding +assert.strictEqual( + Buffer.from(b.toString('latin1'), 'latin1') + .includes('d', 0, 'latin1'), + true +); +assert.strictEqual( + Buffer.from(b.toString('latin1'), 'latin1') + .includes(Buffer.from('d', 'latin1'), 0, 'latin1'), + true +); + +// test binary encoding +assert.strictEqual( + Buffer.from(b.toString('binary'), 'binary') + .includes('d', 0, 'binary'), + true +); +assert.strictEqual( + Buffer.from(b.toString('binary'), 'binary') + .includes(Buffer.from('d', 'binary'), 0, 'binary'), + true +); + + +// test usc2 encoding +var twoByteString = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2'); + +assert(twoByteString.includes('\u0395', 4, 'ucs2')); +assert(twoByteString.includes('\u03a3', -4, 'ucs2')); +assert(twoByteString.includes('\u03a3', -6, 'ucs2')); +assert(twoByteString.includes( + Buffer.from('\u03a3', 'ucs2'), -6, 'ucs2')); +assert(!twoByteString.includes('\u03a3', -2, 'ucs2')); + +var mixedByteStringUcs2 = + Buffer.from('\u039a\u0391abc\u03a3\u03a3\u0395', 'ucs2'); +assert(mixedByteStringUcs2.includes('bc', 0, 'ucs2')); +assert(mixedByteStringUcs2.includes('\u03a3', 0, 'ucs2')); +assert(!mixedByteStringUcs2.includes('\u0396', 0, 'ucs2')); + +assert( + 6, mixedByteStringUcs2.includes(Buffer.from('bc', 'ucs2'), 0, 'ucs2')); +assert( + 10, mixedByteStringUcs2.includes(Buffer.from('\u03a3', 'ucs2'), + 0, 'ucs2')); +assert( + -1, mixedByteStringUcs2.includes(Buffer.from('\u0396', 'ucs2'), + 0, 'ucs2')); + +twoByteString = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2'); + +// Test single char pattern +assert(twoByteString.includes('\u039a', 0, 'ucs2')); +assert(twoByteString.includes('\u0391', 0, 'ucs2'), 'Alpha'); +assert(twoByteString.includes('\u03a3', 0, 'ucs2'), 'First Sigma'); +assert(twoByteString.includes('\u03a3', 6, 'ucs2'), 'Second Sigma'); +assert(twoByteString.includes('\u0395', 0, 'ucs2'), 'Epsilon'); +assert(!twoByteString.includes('\u0392', 0, 'ucs2'), 'Not beta'); + +// Test multi-char pattern +assert(twoByteString.includes('\u039a\u0391', 0, 'ucs2'), 'Lambda Alpha'); +assert(twoByteString.includes('\u0391\u03a3', 0, 'ucs2'), 'Alpha Sigma'); +assert(twoByteString.includes('\u03a3\u03a3', 0, 'ucs2'), 'Sigma Sigma'); +assert(twoByteString.includes('\u03a3\u0395', 0, 'ucs2'), 'Sigma Epsilon'); + +var mixedByteStringUtf8 = Buffer.from('\u039a\u0391abc\u03a3\u03a3\u0395'); +assert(mixedByteStringUtf8.includes('bc')); +assert(mixedByteStringUtf8.includes('bc', 5)); +assert(mixedByteStringUtf8.includes('bc', -8)); +assert(mixedByteStringUtf8.includes('\u03a3')); +assert(!mixedByteStringUtf8.includes('\u0396')); + + +// Test complex string includes algorithms. Only trigger for long strings. +// Long string that isn't a simple repeat of a shorter string. +var longString = 'A'; +for (var i = 66; i < 76; i++) { // from 'B' to 'K' + longString = longString + String.fromCharCode(i) + longString; +} + +var longBufferString = Buffer.from(longString); + +// pattern of 15 chars, repeated every 16 chars in long +var pattern = 'ABACABADABACABA'; +for (var i = 0; i < longBufferString.length - pattern.length; i += 7) { + var includes = longBufferString.includes(pattern, i); + assert(includes, 'Long ABACABA...-string at index ' + i); +} +assert(longBufferString.includes('AJABACA'), 'Long AJABACA, First J'); +assert(longBufferString.includes('AJABACA', 511), 'Long AJABACA, Second J'); + +pattern = 'JABACABADABACABA'; +assert(longBufferString.includes(pattern), 'Long JABACABA..., First J'); +assert(longBufferString.includes(pattern, 512), 'Long JABACABA..., Second J'); + +// Search for a non-ASCII string in a pure ASCII string. +var asciiString = Buffer.from( + 'arglebargleglopglyfarglebargleglopglyfarglebargleglopglyf'); +assert(!asciiString.includes('\x2061')); +assert(asciiString.includes('leb', 0)); + +// Search in string containing many non-ASCII chars. +var allCodePoints = []; +for (var i = 0; i < 65536; i++) allCodePoints[i] = i; +var allCharsString = String.fromCharCode.apply(String, allCodePoints); +var allCharsBufferUtf8 = Buffer.from(allCharsString); +var allCharsBufferUcs2 = Buffer.from(allCharsString, 'ucs2'); + +// Search for string long enough to trigger complex search with ASCII pattern +// and UC16 subject. +assert(!allCharsBufferUtf8.includes('notfound')); +assert(!allCharsBufferUcs2.includes('notfound')); + +// Find substrings in Utf8. +var lengths = [1, 3, 15]; // Single char, simple and complex. +var indices = [0x5, 0x60, 0x400, 0x680, 0x7ee, 0xFF02, 0x16610, 0x2f77b]; +for (var lengthIndex = 0; lengthIndex < lengths.length; lengthIndex++) { + for (var i = 0; i < indices.length; i++) { + var index = indices[i]; + var length = lengths[lengthIndex]; + + if (index + length > 0x7F) { + length = 2 * length; + } + + if (index + length > 0x7FF) { + length = 3 * length; + } + + if (index + length > 0xFFFF) { + length = 4 * length; + } + + var patternBufferUtf8 = allCharsBufferUtf8.slice(index, index + length); + assert(index, allCharsBufferUtf8.includes(patternBufferUtf8)); + + var patternStringUtf8 = patternBufferUtf8.toString(); + assert(index, allCharsBufferUtf8.includes(patternStringUtf8)); + } +} + +// Find substrings in Usc2. +lengths = [2, 4, 16]; // Single char, simple and complex. +indices = [0x5, 0x65, 0x105, 0x205, 0x285, 0x2005, 0x2085, 0xfff0]; +for (var lengthIndex = 0; lengthIndex < lengths.length; lengthIndex++) { + for (var i = 0; i < indices.length; i++) { + var index = indices[i] * 2; + var length = lengths[lengthIndex]; + + var patternBufferUcs2 = + allCharsBufferUcs2.slice(index, index + length); + assert( + index, allCharsBufferUcs2.includes(patternBufferUcs2, 0, 'ucs2')); + + var patternStringUcs2 = patternBufferUcs2.toString('ucs2'); + assert( + index, allCharsBufferUcs2.includes(patternStringUcs2, 0, 'ucs2')); + } +} + +assert.throws(function() { + b.includes(function() { }); +}); +assert.throws(function() { + b.includes({}); +}); +assert.throws(function() { + b.includes([]); +}); + +// test truncation of Number arguments to uint8 +{ + var buf = Buffer.from('this is a test'); + assert.ok(buf.includes(0x6973)); + assert.ok(buf.includes(0x697320)); + assert.ok(buf.includes(0x69732069)); + assert.ok(buf.includes(0x697374657374)); + assert.ok(buf.includes(0x69737374)); + assert.ok(buf.includes(0x69737465)); + assert.ok(buf.includes(0x69737465)); + assert.ok(buf.includes(-140)); + assert.ok(buf.includes(-152)); + assert.ok(!buf.includes(0xff)); + assert.ok(!buf.includes(0xffff)); +} + diff --git a/node_modules/buffer/test/node/test-buffer-indexof.js b/node_modules/buffer/test/node/test-buffer-indexof.js new file mode 100644 index 0000000..24502c3 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-indexof.js @@ -0,0 +1,523 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); + +var Buffer = require('../../').Buffer; + +var b = Buffer.from('abcdef'); +var buf_a = Buffer.from('a'); +var buf_bc = Buffer.from('bc'); +var buf_f = Buffer.from('f'); +var buf_z = Buffer.from('z'); +var buf_empty = Buffer.from(''); + +assert.equal(b.indexOf('a'), 0); +assert.equal(b.indexOf('a', 1), -1); +assert.equal(b.indexOf('a', -1), -1); +assert.equal(b.indexOf('a', -4), -1); +assert.equal(b.indexOf('a', -b.length), 0); +assert.equal(b.indexOf('a', NaN), 0); +assert.equal(b.indexOf('a', -Infinity), 0); +assert.equal(b.indexOf('a', Infinity), -1); +assert.equal(b.indexOf('bc'), 1); +assert.equal(b.indexOf('bc', 2), -1); +assert.equal(b.indexOf('bc', -1), -1); +assert.equal(b.indexOf('bc', -3), -1); +assert.equal(b.indexOf('bc', -5), 1); +assert.equal(b.indexOf('bc', NaN), 1); +assert.equal(b.indexOf('bc', -Infinity), 1); +assert.equal(b.indexOf('bc', Infinity), -1); +assert.equal(b.indexOf('f'), b.length - 1); +assert.equal(b.indexOf('z'), -1); +assert.equal(b.indexOf(''), -1); +assert.equal(b.indexOf('', 1), -1); +assert.equal(b.indexOf('', b.length + 1), -1); +assert.equal(b.indexOf('', Infinity), -1); +assert.equal(b.indexOf(buf_a), 0); +assert.equal(b.indexOf(buf_a, 1), -1); +assert.equal(b.indexOf(buf_a, -1), -1); +assert.equal(b.indexOf(buf_a, -4), -1); +assert.equal(b.indexOf(buf_a, -b.length), 0); +assert.equal(b.indexOf(buf_a, NaN), 0); +assert.equal(b.indexOf(buf_a, -Infinity), 0); +assert.equal(b.indexOf(buf_a, Infinity), -1); +assert.equal(b.indexOf(buf_bc), 1); +assert.equal(b.indexOf(buf_bc, 2), -1); +assert.equal(b.indexOf(buf_bc, -1), -1); +assert.equal(b.indexOf(buf_bc, -3), -1); +assert.equal(b.indexOf(buf_bc, -5), 1); +assert.equal(b.indexOf(buf_bc, NaN), 1); +assert.equal(b.indexOf(buf_bc, -Infinity), 1); +assert.equal(b.indexOf(buf_bc, Infinity), -1); +assert.equal(b.indexOf(buf_f), b.length - 1); +assert.equal(b.indexOf(buf_z), -1); +assert.equal(b.indexOf(buf_empty), -1); +assert.equal(b.indexOf(buf_empty, 1), -1); +assert.equal(b.indexOf(buf_empty, b.length + 1), -1); +assert.equal(b.indexOf(buf_empty, Infinity), -1); +assert.equal(b.indexOf(0x61), 0); +assert.equal(b.indexOf(0x61, 1), -1); +assert.equal(b.indexOf(0x61, -1), -1); +assert.equal(b.indexOf(0x61, -4), -1); +assert.equal(b.indexOf(0x61, -b.length), 0); +assert.equal(b.indexOf(0x61, NaN), 0); +assert.equal(b.indexOf(0x61, -Infinity), 0); +assert.equal(b.indexOf(0x61, Infinity), -1); +assert.equal(b.indexOf(0x0), -1); + +// test offsets +assert.equal(b.indexOf('d', 2), 3); +assert.equal(b.indexOf('f', 5), 5); +assert.equal(b.indexOf('f', -1), 5); +assert.equal(b.indexOf('f', 6), -1); + +assert.equal(b.indexOf(Buffer.from('d'), 2), 3); +assert.equal(b.indexOf(Buffer.from('f'), 5), 5); +assert.equal(b.indexOf(Buffer.from('f'), -1), 5); +assert.equal(b.indexOf(Buffer.from('f'), 6), -1); + +assert.equal(Buffer.from('ff').indexOf(Buffer.from('f'), 1, 'ucs2'), -1); + +// test hex encoding +assert.strictEqual( + Buffer.from(b.toString('hex'), 'hex') + .indexOf('64', 0, 'hex'), + 3 +); +assert.strictEqual( + Buffer.from(b.toString('hex'), 'hex') + .indexOf(Buffer.from('64', 'hex'), 0, 'hex'), + 3 +); + +// test base64 encoding +assert.strictEqual( + Buffer.from(b.toString('base64'), 'base64') + .indexOf('ZA==', 0, 'base64'), + 3 +); +assert.strictEqual( + Buffer.from(b.toString('base64'), 'base64') + .indexOf(Buffer.from('ZA==', 'base64'), 0, 'base64'), + 3 +); + +// test ascii encoding +assert.strictEqual( + Buffer.from(b.toString('ascii'), 'ascii') + .indexOf('d', 0, 'ascii'), + 3 +); +assert.strictEqual( + Buffer.from(b.toString('ascii'), 'ascii') + .indexOf(Buffer.from('d', 'ascii'), 0, 'ascii'), + 3 +); + +// test latin1 encoding +assert.strictEqual( + Buffer.from(b.toString('latin1'), 'latin1') + .indexOf('d', 0, 'latin1'), + 3 +); +assert.strictEqual( + Buffer.from(b.toString('latin1'), 'latin1') + .indexOf(Buffer.from('d', 'latin1'), 0, 'latin1'), + 3 +); +assert.strictEqual( + Buffer.from('aa\u00e8aa', 'latin1') + .indexOf('\u00e8', 'latin1'), + 2 +); +assert.strictEqual( + Buffer.from('\u00e8', 'latin1') + .indexOf('\u00e8', 'latin1'), + 0 +); +assert.strictEqual( + Buffer.from('\u00e8', 'latin1') + .indexOf(Buffer.from('\u00e8', 'latin1'), 'latin1'), + 0 +); + +// test binary encoding +assert.strictEqual( + Buffer.from(b.toString('binary'), 'binary') + .indexOf('d', 0, 'binary'), + 3 +); +assert.strictEqual( + Buffer.from(b.toString('binary'), 'binary') + .indexOf(Buffer.from('d', 'binary'), 0, 'binary'), + 3 +); +assert.strictEqual( + Buffer.from('aa\u00e8aa', 'binary') + .indexOf('\u00e8', 'binary'), + 2 +); +assert.strictEqual( + Buffer.from('\u00e8', 'binary') + .indexOf('\u00e8', 'binary'), + 0 +); +assert.strictEqual( + Buffer.from('\u00e8', 'binary') + .indexOf(Buffer.from('\u00e8', 'binary'), 'binary'), + 0 +); + + +// test optional offset with passed encoding +assert.equal(Buffer.from('aaaa0').indexOf('30', 'hex'), 4); +assert.equal(Buffer.from('aaaa00a').indexOf('3030', 'hex'), 4); + +{ + // test usc2 encoding + var twoByteString = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2'); + + assert.equal(8, twoByteString.indexOf('\u0395', 4, 'ucs2')); + assert.equal(6, twoByteString.indexOf('\u03a3', -4, 'ucs2')); + assert.equal(4, twoByteString.indexOf('\u03a3', -6, 'ucs2')); + assert.equal(4, twoByteString.indexOf( + Buffer.from('\u03a3', 'ucs2'), -6, 'ucs2')); + assert.equal(-1, twoByteString.indexOf('\u03a3', -2, 'ucs2')); +} + +var mixedByteStringUcs2 = + Buffer.from('\u039a\u0391abc\u03a3\u03a3\u0395', 'ucs2'); +assert.equal(6, mixedByteStringUcs2.indexOf('bc', 0, 'ucs2')); +assert.equal(10, mixedByteStringUcs2.indexOf('\u03a3', 0, 'ucs2')); +assert.equal(-1, mixedByteStringUcs2.indexOf('\u0396', 0, 'ucs2')); + +assert.equal( + 6, mixedByteStringUcs2.indexOf(Buffer.from('bc', 'ucs2'), 0, 'ucs2')); +assert.equal( + 10, mixedByteStringUcs2.indexOf(Buffer.from('\u03a3', 'ucs2'), 0, 'ucs2')); +assert.equal( + -1, mixedByteStringUcs2.indexOf(Buffer.from('\u0396', 'ucs2'), 0, 'ucs2')); + +{ + var twoByteString = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2'); + + // Test single char pattern + assert.equal(0, twoByteString.indexOf('\u039a', 0, 'ucs2')); + assert.equal(2, twoByteString.indexOf('\u0391', 0, 'ucs2'), 'Alpha'); + assert.equal(4, twoByteString.indexOf('\u03a3', 0, 'ucs2'), 'First Sigma'); + assert.equal(6, twoByteString.indexOf('\u03a3', 6, 'ucs2'), 'Second Sigma'); + assert.equal(8, twoByteString.indexOf('\u0395', 0, 'ucs2'), 'Epsilon'); + assert.equal(-1, twoByteString.indexOf('\u0392', 0, 'ucs2'), 'Not beta'); + + // Test multi-char pattern + assert.equal( + 0, twoByteString.indexOf('\u039a\u0391', 0, 'ucs2'), 'Lambda Alpha'); + assert.equal( + 2, twoByteString.indexOf('\u0391\u03a3', 0, 'ucs2'), 'Alpha Sigma'); + assert.equal( + 4, twoByteString.indexOf('\u03a3\u03a3', 0, 'ucs2'), 'Sigma Sigma'); + assert.equal( + 6, twoByteString.indexOf('\u03a3\u0395', 0, 'ucs2'), 'Sigma Epsilon'); +} + +var mixedByteStringUtf8 = Buffer.from('\u039a\u0391abc\u03a3\u03a3\u0395'); +assert.equal(5, mixedByteStringUtf8.indexOf('bc')); +assert.equal(5, mixedByteStringUtf8.indexOf('bc', 5)); +assert.equal(5, mixedByteStringUtf8.indexOf('bc', -8)); +assert.equal(7, mixedByteStringUtf8.indexOf('\u03a3')); +assert.equal(-1, mixedByteStringUtf8.indexOf('\u0396')); + + +// Test complex string indexOf algorithms. Only trigger for long strings. +// Long string that isn't a simple repeat of a shorter string. +var longString = 'A'; +for (var i = 66; i < 76; i++) { // from 'B' to 'K' + longString = longString + String.fromCharCode(i) + longString; +} + +var longBufferString = Buffer.from(longString); + +// pattern of 15 chars, repeated every 16 chars in long +var pattern = 'ABACABADABACABA'; +for (var i = 0; i < longBufferString.length - pattern.length; i += 7) { + var index = longBufferString.indexOf(pattern, i); + assert.equal((i + 15) & ~0xf, index, 'Long ABACABA...-string at index ' + i); +} +assert.equal(510, longBufferString.indexOf('AJABACA'), 'Long AJABACA, First J'); +assert.equal( + 1534, longBufferString.indexOf('AJABACA', 511), 'Long AJABACA, Second J'); + +pattern = 'JABACABADABACABA'; +assert.equal( + 511, longBufferString.indexOf(pattern), 'Long JABACABA..., First J'); +assert.equal( + 1535, longBufferString.indexOf(pattern, 512), 'Long JABACABA..., Second J'); + +// Search for a non-ASCII string in a pure ASCII string. +var asciiString = Buffer.from( + 'arglebargleglopglyfarglebargleglopglyfarglebargleglopglyf'); +assert.equal(-1, asciiString.indexOf('\x2061')); +assert.equal(3, asciiString.indexOf('leb', 0)); + +// Search in string containing many non-ASCII chars. +var allCodePoints = []; +for (var i = 0; i < 65536; i++) allCodePoints[i] = i; +var allCharsString = String.fromCharCode.apply(String, allCodePoints); +var allCharsBufferUtf8 = Buffer.from(allCharsString); +var allCharsBufferUcs2 = Buffer.from(allCharsString, 'ucs2'); + +// Search for string long enough to trigger complex search with ASCII pattern +// and UC16 subject. +assert.equal(-1, allCharsBufferUtf8.indexOf('notfound')); +assert.equal(-1, allCharsBufferUcs2.indexOf('notfound')); + +// Needle is longer than haystack, but only because it's encoded as UTF-16 +assert.strictEqual(Buffer.from('aaaa').indexOf('a'.repeat(4), 'ucs2'), -1); + +assert.strictEqual(Buffer.from('aaaa').indexOf('a'.repeat(4), 'utf8'), 0); +assert.strictEqual(Buffer.from('aaaa').indexOf('你好', 'ucs2'), -1); + +// Haystack has odd length, but the needle is UCS2. +// assert.strictEqual(Buffer.from('aaaaa').indexOf('b', 'ucs2'), -1); + +{ + // Find substrings in Utf8. + var lengths = [1, 3, 15]; // Single char, simple and complex. + var indices = [0x5, 0x60, 0x400, 0x680, 0x7ee, 0xFF02, 0x16610, 0x2f77b]; + for (var lengthIndex = 0; lengthIndex < lengths.length; lengthIndex++) { + for (var i = 0; i < indices.length; i++) { + var index = indices[i]; + var length = lengths[lengthIndex]; + + if (index + length > 0x7F) { + length = 2 * length; + } + + if (index + length > 0x7FF) { + length = 3 * length; + } + + if (index + length > 0xFFFF) { + length = 4 * length; + } + + var patternBufferUtf8 = allCharsBufferUtf8.slice(index, index + length); + assert.equal(index, allCharsBufferUtf8.indexOf(patternBufferUtf8)); + + var patternStringUtf8 = patternBufferUtf8.toString(); + assert.equal(index, allCharsBufferUtf8.indexOf(patternStringUtf8)); + } + } +} + +{ + // Find substrings in Usc2. + var lengths = [2, 4, 16]; // Single char, simple and complex. + var indices = [0x5, 0x65, 0x105, 0x205, 0x285, 0x2005, 0x2085, 0xfff0]; + for (var lengthIndex = 0; lengthIndex < lengths.length; lengthIndex++) { + for (var i = 0; i < indices.length; i++) { + var index = indices[i] * 2; + var length = lengths[lengthIndex]; + + var patternBufferUcs2 = + allCharsBufferUcs2.slice(index, index + length); + assert.equal( + index, allCharsBufferUcs2.indexOf(patternBufferUcs2, 0, 'ucs2')); + + var patternStringUcs2 = patternBufferUcs2.toString('ucs2'); + assert.equal( + index, allCharsBufferUcs2.indexOf(patternStringUcs2, 0, 'ucs2')); + } + } +} + +assert.throws(function() { + b.indexOf(function() { }); +}); +assert.throws(function() { + b.indexOf({}); +}); +assert.throws(function() { + b.indexOf([]); +}); + +// All code for handling encodings is shared between Buffer.indexOf and +// Buffer.lastIndexOf, so only testing the separate lastIndexOf semantics. + +// Test lastIndexOf basic functionality; Buffer b contains 'abcdef'. +// lastIndexOf string: +assert.equal(b.lastIndexOf('a'), 0); +assert.equal(b.lastIndexOf('a', 1), 0); +assert.equal(b.lastIndexOf('b', 1), 1); +assert.equal(b.lastIndexOf('c', 1), -1); +assert.equal(b.lastIndexOf('a', -1), 0); +assert.equal(b.lastIndexOf('a', -4), 0); +assert.equal(b.lastIndexOf('a', -b.length), 0); +assert.equal(b.lastIndexOf('a', -b.length - 1), -1); +assert.equal(b.lastIndexOf('a', NaN), 0); +assert.equal(b.lastIndexOf('a', -Infinity), -1); +assert.equal(b.lastIndexOf('a', Infinity), 0); +// lastIndexOf Buffer: +assert.equal(b.lastIndexOf(buf_a), 0); +assert.equal(b.lastIndexOf(buf_a, 1), 0); +assert.equal(b.lastIndexOf(buf_a, -1), 0); +assert.equal(b.lastIndexOf(buf_a, -4), 0); +assert.equal(b.lastIndexOf(buf_a, -b.length), 0); +assert.equal(b.lastIndexOf(buf_a, -b.length - 1), -1); +assert.equal(b.lastIndexOf(buf_a, NaN), 0); +assert.equal(b.lastIndexOf(buf_a, -Infinity), -1); +assert.equal(b.lastIndexOf(buf_a, Infinity), 0); +assert.equal(b.lastIndexOf(buf_bc), 1); +assert.equal(b.lastIndexOf(buf_bc, 2), 1); +assert.equal(b.lastIndexOf(buf_bc, -1), 1); +assert.equal(b.lastIndexOf(buf_bc, -3), 1); +assert.equal(b.lastIndexOf(buf_bc, -5), 1); +assert.equal(b.lastIndexOf(buf_bc, -6), -1); +assert.equal(b.lastIndexOf(buf_bc, NaN), 1); +assert.equal(b.lastIndexOf(buf_bc, -Infinity), -1); +assert.equal(b.lastIndexOf(buf_bc, Infinity), 1); +assert.equal(b.lastIndexOf(buf_f), b.length - 1); +assert.equal(b.lastIndexOf(buf_z), -1); +assert.equal(b.lastIndexOf(buf_empty), -1); +assert.equal(b.lastIndexOf(buf_empty, 1), -1); +assert.equal(b.lastIndexOf(buf_empty, b.length + 1), -1); +assert.equal(b.lastIndexOf(buf_empty, Infinity), -1); +// lastIndexOf number: +assert.equal(b.lastIndexOf(0x61), 0); +assert.equal(b.lastIndexOf(0x61, 1), 0); +assert.equal(b.lastIndexOf(0x61, -1), 0); +assert.equal(b.lastIndexOf(0x61, -4), 0); +assert.equal(b.lastIndexOf(0x61, -b.length), 0); +assert.equal(b.lastIndexOf(0x61, -b.length - 1), -1); +assert.equal(b.lastIndexOf(0x61, NaN), 0); +assert.equal(b.lastIndexOf(0x61, -Infinity), -1); +assert.equal(b.lastIndexOf(0x61, Infinity), 0); +assert.equal(b.lastIndexOf(0x0), -1); + +// Test weird offset arguments. +// Behaviour should match String.lastIndexOf: +assert.equal(b.lastIndexOf('b', 0), -1); +assert.equal(b.lastIndexOf('b', undefined), 1); +assert.equal(b.lastIndexOf('b', null), -1); +assert.equal(b.lastIndexOf('b', {}), 1); +assert.equal(b.lastIndexOf('b', []), -1); +assert.equal(b.lastIndexOf('b', [2]), 1); + +// Test needles longer than the haystack. +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 'ucs2'), -1); +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 'utf8'), -1); +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 'latin1'), -1); +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 'binary'), -1); +assert.strictEqual(b.lastIndexOf(Buffer.from('aaaaaaaaaaaaaaa')), -1); +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 2, 'ucs2'), -1); +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 3, 'utf8'), -1); +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 5, 'latin1'), -1); +assert.strictEqual(b.lastIndexOf('aaaaaaaaaaaaaaa', 5, 'binary'), -1); +assert.strictEqual(b.lastIndexOf(Buffer.from('aaaaaaaaaaaaaaa'), 7), -1); + +// 你好 expands to a total of 6 bytes using UTF-8 and 4 bytes using UTF-16 +assert.strictEqual(buf_bc.lastIndexOf('你好', 'ucs2'), -1); +assert.strictEqual(buf_bc.lastIndexOf('你好', 'utf8'), -1); +assert.strictEqual(buf_bc.lastIndexOf('你好', 'latin1'), -1); +assert.strictEqual(buf_bc.lastIndexOf('你好', 'binary'), -1); +assert.strictEqual(buf_bc.lastIndexOf(Buffer.from('你好')), -1); +assert.strictEqual(buf_bc.lastIndexOf('你好', 2, 'ucs2'), -1); +assert.strictEqual(buf_bc.lastIndexOf('你好', 3, 'utf8'), -1); +assert.strictEqual(buf_bc.lastIndexOf('你好', 5, 'latin1'), -1); +assert.strictEqual(buf_bc.lastIndexOf('你好', 5, 'binary'), -1); +assert.strictEqual(buf_bc.lastIndexOf(Buffer.from('你好'), 7), -1); + +// Test lastIndexOf on a longer buffer: +var bufferString = new Buffer('a man a plan a canal panama'); +assert.equal(15, bufferString.lastIndexOf('canal')); +assert.equal(21, bufferString.lastIndexOf('panama')); +assert.equal(0, bufferString.lastIndexOf('a man a plan a canal panama')); +assert.equal(-1, bufferString.lastIndexOf('a man a plan a canal mexico')); +assert.equal(-1, bufferString.lastIndexOf('a man a plan a canal mexico city')); +assert.equal(-1, bufferString.lastIndexOf(Buffer.from('a'.repeat(1000)))); +assert.equal(0, bufferString.lastIndexOf('a man a plan', 4)); +assert.equal(13, bufferString.lastIndexOf('a ')); +assert.equal(13, bufferString.lastIndexOf('a ', 13)); +assert.equal(6, bufferString.lastIndexOf('a ', 12)); +assert.equal(0, bufferString.lastIndexOf('a ', 5)); +assert.equal(13, bufferString.lastIndexOf('a ', -1)); +assert.equal(0, bufferString.lastIndexOf('a ', -27)); +assert.equal(-1, bufferString.lastIndexOf('a ', -28)); + +// Test lastIndexOf for the case that the first character can be found, +// but in a part of the buffer that does not make search to search +// due do length constraints. +var abInUCS2 = Buffer.from('ab', 'ucs2'); +assert.strictEqual(-1, Buffer.from('µaaaa¶bbbb', 'latin1').lastIndexOf('µ')); +assert.strictEqual(-1, Buffer.from('µaaaa¶bbbb', 'binary').lastIndexOf('µ')); +assert.strictEqual(-1, Buffer.from('bc').lastIndexOf('ab')); +assert.strictEqual(-1, Buffer.from('abc').lastIndexOf('qa')); +assert.strictEqual(-1, Buffer.from('abcdef').lastIndexOf('qabc')); +assert.strictEqual(-1, Buffer.from('bc').lastIndexOf(Buffer.from('ab'))); +assert.strictEqual(-1, Buffer.from('bc', 'ucs2').lastIndexOf('ab', 'ucs2')); +assert.strictEqual(-1, Buffer.from('bc', 'ucs2').lastIndexOf(abInUCS2)); + +assert.strictEqual(0, Buffer.from('abc').lastIndexOf('ab')); +assert.strictEqual(0, Buffer.from('abc').lastIndexOf('ab', 1)); +assert.strictEqual(0, Buffer.from('abc').lastIndexOf('ab', 2)); +assert.strictEqual(0, Buffer.from('abc').lastIndexOf('ab', 3)); + +// The above tests test the LINEAR and SINGLE-CHAR strategies. +// Now, we test the BOYER-MOORE-HORSPOOL strategy. +// Test lastIndexOf on a long buffer w multiple matches: +pattern = 'JABACABADABACABA'; +assert.equal(1535, longBufferString.lastIndexOf(pattern)); +assert.equal(1535, longBufferString.lastIndexOf(pattern, 1535)); +assert.equal(511, longBufferString.lastIndexOf(pattern, 1534)); + +// Finally, give it a really long input to trigger fallback from BMH to +// regular BOYER-MOORE (which has better worst-case complexity). + +// Generate a really long Thue-Morse sequence of 'yolo' and 'swag', +// "yolo swag swag yolo swag yolo yolo swag" ..., goes on for about 5MB. +// This is hard to search because it all looks similar, but never repeats. + +// countBits returns the number of bits in the binary reprsentation of n. +function countBits(n) { + for (var count = 0; n > 0; count++) { + n = n & (n - 1); // remove top bit + } + return count; +} +var parts = []; +for (var i = 0; i < 1000000; i++) { + parts.push((countBits(i) % 2 === 0) ? 'yolo' : 'swag'); +} +var reallyLong = new Buffer(parts.join(' ')); +assert.equal('yolo swag swag yolo', reallyLong.slice(0, 19).toString()); + +// Expensive reverse searches. Stress test lastIndexOf: +pattern = reallyLong.slice(0, 100000); // First 1/50th of the pattern. +assert.equal(4751360, reallyLong.lastIndexOf(pattern)); +assert.equal(3932160, reallyLong.lastIndexOf(pattern, 4000000)); +assert.equal(2949120, reallyLong.lastIndexOf(pattern, 3000000)); +pattern = reallyLong.slice(100000, 200000); // Second 1/50th. +assert.equal(4728480, reallyLong.lastIndexOf(pattern)); +pattern = reallyLong.slice(0, 1000000); // First 1/5th. +assert.equal(3932160, reallyLong.lastIndexOf(pattern)); +pattern = reallyLong.slice(0, 2000000); // first 2/5ths. +assert.equal(0, reallyLong.lastIndexOf(pattern)); + +// test truncation of Number arguments to uint8 +{ + var buf = Buffer.from('this is a test'); + assert.strictEqual(buf.indexOf(0x6973), 3); + assert.strictEqual(buf.indexOf(0x697320), 4); + assert.strictEqual(buf.indexOf(0x69732069), 2); + assert.strictEqual(buf.indexOf(0x697374657374), 0); + assert.strictEqual(buf.indexOf(0x69737374), 0); + assert.strictEqual(buf.indexOf(0x69737465), 11); + assert.strictEqual(buf.indexOf(0x69737465), 11); + assert.strictEqual(buf.indexOf(-140), 0); + assert.strictEqual(buf.indexOf(-152), 1); + assert.strictEqual(buf.indexOf(0xff), -1); + assert.strictEqual(buf.indexOf(0xffff), -1); +} + diff --git a/node_modules/buffer/test/node/test-buffer-inheritance.js b/node_modules/buffer/test/node/test-buffer-inheritance.js new file mode 100644 index 0000000..711d9f2 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-inheritance.js @@ -0,0 +1,42 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); + + +function T(n) { + var ui8 = new Uint8Array(n); + Object.setPrototypeOf(ui8, T.prototype); + return ui8; +} +Object.setPrototypeOf(T.prototype, Buffer.prototype); +Object.setPrototypeOf(T, Buffer); + +T.prototype.sum = function sum() { + var cntr = 0; + for (var i = 0; i < this.length; i++) + cntr += this[i]; + return cntr; +}; + + +var vals = [new T(4), T(4)]; + +vals.forEach(function(t) { + assert.equal(t.constructor, T); + assert.equal(Object.getPrototypeOf(t), T.prototype); + assert.equal(Object.getPrototypeOf(Object.getPrototypeOf(t)), + Buffer.prototype); + + t.fill(5); + var cntr = 0; + for (var i = 0; i < t.length; i++) + cntr += t[i]; + assert.equal(t.length * 5, cntr); + + // Check this does not throw + t.toString(); +}); + diff --git a/node_modules/buffer/test/node/test-buffer-inspect.js b/node_modules/buffer/test/node/test-buffer-inspect.js new file mode 100644 index 0000000..d0ed590 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-inspect.js @@ -0,0 +1,41 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); + +var util = require('util'); + +var buffer = require('../../'); + +buffer.INSPECT_MAX_BYTES = 2; + +var b = Buffer.allocUnsafe(4); +b.fill('1234'); + +var s = buffer.SlowBuffer(4); +s.fill('1234'); + +var expected = ''; + +assert.strictEqual(util.inspect(b), expected); +assert.strictEqual(util.inspect(s), expected); + +b = Buffer.allocUnsafe(2); +b.fill('12'); + +s = buffer.SlowBuffer(2); +s.fill('12'); + +expected = ''; + +assert.strictEqual(util.inspect(b), expected); +assert.strictEqual(util.inspect(s), expected); + +buffer.INSPECT_MAX_BYTES = Infinity; + +assert.doesNotThrow(function() { + assert.strictEqual(util.inspect(b), expected); + assert.strictEqual(util.inspect(s), expected); +}); + diff --git a/node_modules/buffer/test/node/test-buffer-iterator.js b/node_modules/buffer/test/node/test-buffer-iterator.js new file mode 100644 index 0000000..f27709f --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-iterator.js @@ -0,0 +1,65 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + +var assert = require('assert'); + +var buffer = Buffer.from([1, 2, 3, 4, 5]); +var arr; +var b; + +// buffers should be iterable + +arr = []; + +for (b of buffer) + arr.push(b); + +assert.deepStrictEqual(arr, [1, 2, 3, 4, 5]); + + +// buffer iterators should be iterable + +arr = []; + +for (b of buffer[Symbol.iterator]()) + arr.push(b); + +assert.deepStrictEqual(arr, [1, 2, 3, 4, 5]); + + +// buffer#values() should return iterator for values + +arr = []; + +for (b of buffer.values()) + arr.push(b); + +assert.deepStrictEqual(arr, [1, 2, 3, 4, 5]); + + +// buffer#keys() should return iterator for keys + +arr = []; + +for (b of buffer.keys()) + arr.push(b); + +assert.deepStrictEqual(arr, [0, 1, 2, 3, 4]); + + +// buffer#entries() should return iterator for entries + +arr = []; + +for (b of buffer.entries()) + arr.push(b); + +assert.deepStrictEqual(arr, [ + [0, 1], + [1, 2], + [2, 3], + [3, 4], + [4, 5] +]); + diff --git a/node_modules/buffer/test/node/test-buffer-safe-unsafe.js b/node_modules/buffer/test/node/test-buffer-safe-unsafe.js new file mode 100644 index 0000000..22ba29e --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-safe-unsafe.js @@ -0,0 +1,27 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); + +var safe = Buffer.alloc(10); + +function isZeroFilled(buf) { + for (var n = 0; n < buf.length; n++) + if (buf[n] !== 0) return false; + return true; +} + +assert(isZeroFilled(safe)); + +// Test that unsafe allocations doesn't affect subsequent safe allocations +Buffer.allocUnsafe(10); +assert(isZeroFilled(new Float64Array(10))); + +new Buffer(10); +assert(isZeroFilled(new Float64Array(10))); + +Buffer.allocUnsafe(10); +assert(isZeroFilled(Buffer.alloc(10))); + diff --git a/node_modules/buffer/test/node/test-buffer-slow.js b/node_modules/buffer/test/node/test-buffer-slow.js new file mode 100644 index 0000000..65cea21 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-slow.js @@ -0,0 +1,63 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); +var buffer = require('../../'); +var Buffer = buffer.Buffer; +var SlowBuffer = buffer.SlowBuffer; + +var ones = [1, 1, 1, 1]; + +// should create a Buffer +var sb = SlowBuffer(4); +assert(sb instanceof Buffer); +assert.strictEqual(sb.length, 4); +sb.fill(1); +for (var [key, value] of sb.entries()) { + assert.deepStrictEqual(value, ones[key]); +} + +// underlying ArrayBuffer should have the same length +assert.strictEqual(sb.buffer.byteLength, 4); + +// should work without new +sb = SlowBuffer(4); +assert(sb instanceof Buffer); +assert.strictEqual(sb.length, 4); +sb.fill(1); +for (var [key, value] of sb.entries()) { + assert.deepStrictEqual(value, ones[key]); +} + +// should work with edge cases +assert.strictEqual(SlowBuffer(0).length, 0); +try { + assert.strictEqual( + SlowBuffer(buffer.kMaxLength).length, buffer.kMaxLength); +} catch (e) { + assert.equal(e.message, 'Array buffer allocation failed'); +} + +// should work with number-coercible values +assert.strictEqual(SlowBuffer('6').length, 6); +assert.strictEqual(SlowBuffer(true).length, 1); + +// should create zero-length buffer if parameter is not a number +assert.strictEqual(SlowBuffer().length, 0); +assert.strictEqual(SlowBuffer(NaN).length, 0); +assert.strictEqual(SlowBuffer({}).length, 0); +assert.strictEqual(SlowBuffer('string').length, 0); + +// should throw with invalid length +assert.throws(function() { + SlowBuffer(Infinity); +}, 'invalid Buffer length'); +assert.throws(function() { + SlowBuffer(-1); +}, 'invalid Buffer length'); +assert.throws(function() { + SlowBuffer(buffer.kMaxLength + 1); +}, 'invalid Buffer length'); + diff --git a/node_modules/buffer/test/node/test-buffer-swap.js b/node_modules/buffer/test/node/test-buffer-swap.js new file mode 100644 index 0000000..2ec1a7a --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-swap.js @@ -0,0 +1,141 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); + +// Test buffers small enough to use the JS implementation +var buf = Buffer.from([0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, + 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10]); + +assert.strictEqual(buf, buf.swap16()); +assert.deepStrictEqual(buf, Buffer.from([0x02, 0x01, 0x04, 0x03, 0x06, 0x05, + 0x08, 0x07, 0x0a, 0x09, 0x0c, 0x0b, + 0x0e, 0x0d, 0x10, 0x0f])); +buf.swap16(); // restore + +assert.strictEqual(buf, buf.swap32()); +assert.deepStrictEqual(buf, Buffer.from([0x04, 0x03, 0x02, 0x01, 0x08, 0x07, + 0x06, 0x05, 0x0c, 0x0b, 0x0a, 0x09, + 0x10, 0x0f, 0x0e, 0x0d])); +buf.swap32(); // restore + +assert.strictEqual(buf, buf.swap64()); +assert.deepStrictEqual(buf, Buffer.from([0x08, 0x07, 0x06, 0x05, 0x04, 0x03, + 0x02, 0x01, 0x10, 0x0f, 0x0e, 0x0d, + 0x0c, 0x0b, 0x0a, 0x09])); + +// Operates in-place +var buf3 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7]); +buf3.slice(1, 5).swap32(); +assert.deepStrictEqual(buf3, Buffer.from([0x1, 0x5, 0x4, 0x3, 0x2, 0x6, 0x7])); + +buf3.slice(1, 5).swap16(); +assert.deepStrictEqual(buf3, Buffer.from([0x1, 0x4, 0x5, 0x2, 0x3, 0x6, 0x7])); + +var buf3_64 = Buffer.from([0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, + 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, + 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, + 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10]); +buf3_64.slice(2, 18).swap64(); +assert.deepStrictEqual(buf3_64, Buffer.from([0x01, 0x02, 0x0a, 0x09, 0x08, 0x07, + 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, + 0x10, 0x0f, 0x0e, 0x0d, 0x0c, 0x0b, + 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, + 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, + 0x0f, 0x10])); + +// Force use of native code (Buffer size above threshold limit for js impl) +var buf4A = new Uint32Array(256).fill(0x04030201); +var buf4 = Buffer.from(buf4A.buffer, buf4A.byteOffset); +var buf5A = new Uint32Array(256).fill(0x03040102); +var buf5 = Buffer.from(buf5A.buffer, buf5A.byteOffset); + +buf4.swap16(); +assert.deepStrictEqual(buf4, buf5); + +var buf6A = new Uint32Array(256).fill(0x04030201); +var buf6 = Buffer.from(buf6A.buffer); +var bu7A = new Uint32Array(256).fill(0x01020304); +var buf7 = Buffer.from(bu7A.buffer, bu7A.byteOffset); + +buf6.swap32(); +assert.deepStrictEqual(buf6, buf7); + +var buf8A = new Uint8Array(256 * 8); +var buf9A = new Uint8Array(256 * 8); +for (var i = 0; i < buf8A.length; i++) { + buf8A[i] = i % 8; + buf9A[buf9A.length - i - 1] = i % 8; +} +var buf8 = Buffer.from(buf8A.buffer, buf8A.byteOffset); +var buf9 = Buffer.from(buf9A.buffer, buf9A.byteOffset); + +buf8.swap64(); +assert.deepStrictEqual(buf8, buf9); + +// Test native code with buffers that are not memory-aligned +var buf10A = new Uint8Array(256 * 8); +var buf11A = new Uint8Array(256 * 8 - 2); +for (var i = 0; i < buf10A.length; i++) { + buf10A[i] = i % 2; +} +for (var i = 1; i < buf11A.length; i++) { + buf11A[buf11A.length - i] = (i + 1) % 2; +} +var buf10 = Buffer.from(buf10A.buffer, buf10A.byteOffset); +// 0|1 0|1 0|1... +var buf11 = Buffer.from(buf11A.buffer, buf11A.byteOffset); +// 0|0 1|0 1|0... + +buf10.slice(1, buf10.length - 1).swap16(); +assert.deepStrictEqual(buf10.slice(0, buf11.length), buf11); + + +var buf12A = new Uint8Array(256 * 8); +var buf13A = new Uint8Array(256 * 8 - 4); +for (var i = 0; i < buf12A.length; i++) { + buf12A[i] = i % 4; +} +for (var i = 1; i < buf13A.length; i++) { + buf13A[buf13A.length - i] = (i + 1) % 4; +} +var buf12 = Buffer.from(buf12A.buffer, buf12A.byteOffset); +// 0|1 2 3 0|1 2 3... +var buf13 = Buffer.from(buf13A.buffer, buf13A.byteOffset); +// 0|0 3 2 1|0 3 2... + +buf12.slice(1, buf12.length - 3).swap32(); +assert.deepStrictEqual(buf12.slice(0, buf13.length), buf13); + + +var buf14A = new Uint8Array(256 * 8); +var buf15A = new Uint8Array(256 * 8 - 8); +for (var i = 0; i < buf14A.length; i++) { + buf14A[i] = i % 8; +} +for (var i = 1; i < buf15A.length; i++) { + buf15A[buf15A.length - i] = (i + 1) % 8; +} +var buf14 = Buffer.from(buf14A.buffer, buf14A.byteOffset); +// 0|1 2 3 4 5 6 7 0|1 2 3 4... +var buf15 = Buffer.from(buf15A.buffer, buf15A.byteOffset); +// 0|0 7 6 5 4 3 2 1|0 7 6 5... + +buf14.slice(1, buf14.length - 7).swap64(); +assert.deepStrictEqual(buf14.slice(0, buf15.length), buf15); + +// Length assertions +var re16 = /Buffer size must be a multiple of 16-bits/; +var re32 = /Buffer size must be a multiple of 32-bits/; +var re64 = /Buffer size must be a multiple of 64-bits/; + +assert.throws(() => Buffer.from(buf3).swap16(), re16); +assert.throws(() => Buffer.alloc(1025).swap16(), re16); +assert.throws(() => Buffer.from(buf3).swap32(), re32); +assert.throws(() => buf3.slice(1, 3).swap32(), re32); +assert.throws(() => Buffer.alloc(1025).swap32(), re32); +assert.throws(() => buf3.slice(1, 3).swap64(), re64); +assert.throws(() => Buffer.alloc(1025).swap64(), re64); + diff --git a/node_modules/buffer/test/node/test-buffer-zero-fill-cli.js b/node_modules/buffer/test/node/test-buffer-zero-fill-cli.js new file mode 100644 index 0000000..744b334 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-zero-fill-cli.js @@ -0,0 +1,35 @@ +'use strict'; +var Buffer = require('../../').Buffer; + +// Flags: --zero-fill-buffers + +// when using --zero-fill-buffers, every Buffer and SlowBuffer +// instance must be zero filled upon creation + + +var SlowBuffer = require('../../').SlowBuffer; +var assert = require('assert'); + +function isZeroFilled(buf) { + for (var n = 0; n < buf.length; n++) + if (buf[n] > 0) return false; + return true; +} + +// This can be somewhat unreliable because the +// allocated memory might just already happen to +// contain all zeroes. The test is run multiple +// times to improve the reliability. +for (var i = 0; i < 50; i++) { + var bufs = [ + Buffer.alloc(20), + Buffer.allocUnsafe(20), + SlowBuffer(20), + Buffer(20), + new SlowBuffer(20) + ]; + for (var buf of bufs) { + assert(isZeroFilled(buf)); + } +} + diff --git a/node_modules/buffer/test/node/test-buffer-zero-fill-reset.js b/node_modules/buffer/test/node/test-buffer-zero-fill-reset.js new file mode 100644 index 0000000..b21a6b2 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer-zero-fill-reset.js @@ -0,0 +1,22 @@ +'use strict'; +var Buffer = require('../../').Buffer; + + + +var assert = require('assert'); + + +function testUint8Array(ui) { + var length = ui.length; + for (var i = 0; i < length; i++) + if (ui[i] !== 0) return false; + return true; +} + + +for (var i = 0; i < 100; i++) { + Buffer.alloc(0); + var ui = new Uint8Array(65); + assert.ok(testUint8Array(ui), 'Uint8Array is not zero-filled'); +} + diff --git a/node_modules/buffer/test/node/test-buffer.js b/node_modules/buffer/test/node/test-buffer.js new file mode 100644 index 0000000..2e94de2 --- /dev/null +++ b/node_modules/buffer/test/node/test-buffer.js @@ -0,0 +1,1534 @@ +'use strict'; +var Buffer = require('../../').Buffer; + +var common = { skip: function () {} }; +var assert = require('assert'); + +var Buffer = require('../../').Buffer; +var SlowBuffer = require('../../').SlowBuffer; + +// counter to ensure unique value is always copied +var cntr = 0; + +var b = Buffer(1024); // safe constructor + +// console.log('b.length == %d', b.length); +assert.strictEqual(1024, b.length); + +b[0] = -1; +assert.strictEqual(b[0], 255); + +for (var i = 0; i < 1024; i++) { + b[i] = i % 256; +} + +for (var i = 0; i < 1024; i++) { + assert.strictEqual(i % 256, b[i]); +} + +var c = Buffer(512); +// console.log('c.length == %d', c.length); +assert.strictEqual(512, c.length); + +var d = new Buffer([]); +assert.strictEqual(0, d.length); + +var ui32 = new Uint32Array(4).fill(42); +var e = Buffer(ui32); +for (var [key, value] of e.entries()) { + assert.deepStrictEqual(value, ui32[key]); +} + +// First check Buffer#fill() works as expected. + +assert.throws(function() { + Buffer(8).fill('a', -1); +}); + +assert.throws(function() { + Buffer(8).fill('a', 0, 9); +}); + +// Make sure this doesn't hang indefinitely. +Buffer(8).fill(''); + +{ + var buf = new Buffer(64); + buf.fill(10); + for (var i = 0; i < buf.length; i++) + assert.equal(buf[i], 10); + + buf.fill(11, 0, buf.length >> 1); + for (var i = 0; i < buf.length >> 1; i++) + assert.equal(buf[i], 11); + for (var i = (buf.length >> 1) + 1; i < buf.length; i++) + assert.equal(buf[i], 10); + + buf.fill('h'); + for (var i = 0; i < buf.length; i++) + assert.equal('h'.charCodeAt(0), buf[i]); + + buf.fill(0); + for (var i = 0; i < buf.length; i++) + assert.equal(0, buf[i]); + + buf.fill(null); + for (var i = 0; i < buf.length; i++) + assert.equal(0, buf[i]); + + buf.fill(1, 16, 32); + for (var i = 0; i < 16; i++) + assert.equal(0, buf[i]); + for (var i = 16; i < 32; i++) + assert.equal(1, buf[i]); + for (var i = 32; i < buf.length; i++) + assert.equal(0, buf[i]); +} + +{ + var buf = new Buffer(10); + buf.fill('abc'); + assert.equal(buf.toString(), 'abcabcabca'); + buf.fill('է'); + assert.equal(buf.toString(), 'էէէէէ'); +} + +{ + // copy 512 bytes, from 0 to 512. + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, 0, 512); +// console.log('copied %d bytes from b into c', copied); + assert.strictEqual(512, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +{ + // copy c into b, without specifying sourceEnd + b.fill(++cntr); + c.fill(++cntr); + var copied = c.copy(b, 0, 0); +// console.log('copied %d bytes from c into b w/o sourceEnd', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(c[i], b[i]); + } +} + +{ + // copy c into b, without specifying sourceStart + b.fill(++cntr); + c.fill(++cntr); + var copied = c.copy(b, 0); +// console.log('copied %d bytes from c into b w/o sourceStart', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(c[i], b[i]); + } +} + +{ + // copy longer buffer b to shorter c without targetStart + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c); +// console.log('copied %d bytes from b into c w/o targetStart', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +{ + // copy starting near end of b to c + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, b.length - Math.floor(c.length / 2)); +// console.log('copied %d bytes from end of b into beginning of c', copied); + assert.strictEqual(Math.floor(c.length / 2), copied); + for (var i = 0; i < Math.floor(c.length / 2); i++) { + assert.strictEqual(b[b.length - Math.floor(c.length / 2) + i], c[i]); + } + for (var i = Math.floor(c.length / 2) + 1; i < c.length; i++) { + assert.strictEqual(c[c.length - 1], c[i]); + } +} + +{ + // try to copy 513 bytes, and check we don't overrun c + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, 0, 513); +// console.log('copied %d bytes from b trying to overrun c', copied); + assert.strictEqual(c.length, copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +{ + // copy 768 bytes from b into b + b.fill(++cntr); + b.fill(++cntr, 256); + var copied = b.copy(b, 0, 256, 1024); +// console.log('copied %d bytes from b into b', copied); + assert.strictEqual(768, copied); + for (var i = 0; i < b.length; i++) { + assert.strictEqual(cntr, b[i]); + } +} + +// copy string longer than buffer length (failure will segfault) +var bb = Buffer(10); +bb.fill('hello crazy world'); + + +// try to copy from before the beginning of b +assert.doesNotThrow(() => { b.copy(c, 0, 100, 10); }); + +// copy throws at negative sourceStart +assert.throws(function() { + Buffer(5).copy(Buffer(5), 0, -1); +}, RangeError); + +{ + // check sourceEnd resets to targetEnd if former is greater than the latter + b.fill(++cntr); + c.fill(++cntr); + var copied = b.copy(c, 0, 0, 1025); +// console.log('copied %d bytes from b into c', copied); + for (var i = 0; i < c.length; i++) { + assert.strictEqual(b[i], c[i]); + } +} + +// throw with negative sourceEnd +// console.log('test copy at negative sourceEnd'); +assert.throws(function() { + b.copy(c, 0, 0, -1); +}, RangeError); + +// when sourceStart is greater than sourceEnd, zero copied +assert.equal(b.copy(c, 0, 100, 10), 0); + +// when targetStart > targetLength, zero copied +assert.equal(b.copy(c, 512, 0, 10), 0); + +var caught_error; + +// invalid encoding for Buffer.toString +caught_error = null; +try { + b.toString('invalid'); +} catch (err) { + caught_error = err; +} +assert.strictEqual('Unknown encoding: invalid', caught_error.message); + +// invalid encoding for Buffer.write +caught_error = null; +try { + b.write('test string', 0, 5, 'invalid'); +} catch (err) { + caught_error = err; +} +assert.strictEqual('Unknown encoding: invalid', caught_error.message); + +// try to create 0-length buffers +new Buffer(''); +new Buffer('', 'ascii'); +new Buffer('', 'latin1'); +new Buffer('', 'binary'); +Buffer(0); + +// try to write a 0-length string beyond the end of b +assert.throws(function() { + b.write('', 2048); +}, RangeError); + +// throw when writing to negative offset +assert.throws(function() { + b.write('a', -1); +}, RangeError); + +// throw when writing past bounds from the pool +assert.throws(function() { + b.write('a', 2048); +}, RangeError); + +// throw when writing to negative offset +assert.throws(function() { + b.write('a', -1); +}, RangeError); + +// try to copy 0 bytes worth of data into an empty buffer +b.copy(Buffer(0), 0, 0, 0); + +// try to copy 0 bytes past the end of the target buffer +b.copy(Buffer(0), 1, 1, 1); +b.copy(Buffer(1), 1, 1, 1); + +// try to copy 0 bytes from past the end of the source buffer +b.copy(Buffer(1), 0, 2048, 2048); + +var rangeBuffer = new Buffer('abc'); + +// if start >= buffer's length, empty string will be returned +assert.equal(rangeBuffer.toString('ascii', 3), ''); +assert.equal(rangeBuffer.toString('ascii', +Infinity), ''); +assert.equal(rangeBuffer.toString('ascii', 3.14, 3), ''); +assert.equal(rangeBuffer.toString('ascii', 'Infinity', 3), ''); + +// if end <= 0, empty string will be returned +assert.equal(rangeBuffer.toString('ascii', 1, 0), ''); +assert.equal(rangeBuffer.toString('ascii', 1, -1.2), ''); +assert.equal(rangeBuffer.toString('ascii', 1, -100), ''); +assert.equal(rangeBuffer.toString('ascii', 1, -Infinity), ''); + +// if start < 0, start will be taken as zero +assert.equal(rangeBuffer.toString('ascii', -1, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', -1.99, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', -Infinity, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '-1', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '-1.99', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '-Infinity', 3), 'abc'); + +// if start is an invalid integer, start will be taken as zero +assert.equal(rangeBuffer.toString('ascii', 'node.js', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', {}, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', [], 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', NaN, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', null, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', undefined, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', false, 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '', 3), 'abc'); + +// but, if start is an integer when coerced, then it will be coerced and used. +assert.equal(rangeBuffer.toString('ascii', '-1', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '1', 3), 'bc'); +assert.equal(rangeBuffer.toString('ascii', '-Infinity', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', '3', 3), ''); +assert.equal(rangeBuffer.toString('ascii', Number(3), 3), ''); +assert.equal(rangeBuffer.toString('ascii', '3.14', 3), ''); +assert.equal(rangeBuffer.toString('ascii', '1.99', 3), 'bc'); +assert.equal(rangeBuffer.toString('ascii', '-1.99', 3), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 1.99, 3), 'bc'); +assert.equal(rangeBuffer.toString('ascii', true, 3), 'bc'); + +// if end > buffer's length, end will be taken as buffer's length +assert.equal(rangeBuffer.toString('ascii', 0, 5), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, 6.99), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, Infinity), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '5'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '6.99'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, 'Infinity'), 'abc'); + +// if end is an invalid integer, end will be taken as buffer's length +assert.equal(rangeBuffer.toString('ascii', 0, 'node.js'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, {}), ''); +assert.equal(rangeBuffer.toString('ascii', 0, NaN), ''); +assert.equal(rangeBuffer.toString('ascii', 0, undefined), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, null), ''); +assert.equal(rangeBuffer.toString('ascii', 0, []), ''); +assert.equal(rangeBuffer.toString('ascii', 0, false), ''); +assert.equal(rangeBuffer.toString('ascii', 0, ''), ''); + +// but, if end is an integer when coerced, then it will be coerced and used. +assert.equal(rangeBuffer.toString('ascii', 0, '-1'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, '1'), 'a'); +assert.equal(rangeBuffer.toString('ascii', 0, '-Infinity'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, '3'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, Number(3)), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '3.14'), 'abc'); +assert.equal(rangeBuffer.toString('ascii', 0, '1.99'), 'a'); +assert.equal(rangeBuffer.toString('ascii', 0, '-1.99'), ''); +assert.equal(rangeBuffer.toString('ascii', 0, 1.99), 'a'); +assert.equal(rangeBuffer.toString('ascii', 0, true), 'a'); + +// try toString() with a object as a encoding +assert.equal(rangeBuffer.toString({toString: function() { + return 'ascii'; +}}), 'abc'); + +// testing for smart defaults and ability to pass string values as offset +var writeTest = new Buffer('abcdes'); +writeTest.write('n', 'ascii'); +writeTest.write('o', '1', 'ascii'); +writeTest.write('d', '2', 'ascii'); +writeTest.write('e', 3, 'ascii'); +writeTest.write('j', 4, 'ascii'); +assert.equal(writeTest.toString(), 'nodejs'); + +// ASCII slice test +{ + var asciiString = 'hello world'; + + for (var i = 0; i < asciiString.length; i++) { + b[i] = asciiString.charCodeAt(i); + } + var asciiSlice = b.toString('ascii', 0, asciiString.length); + assert.equal(asciiString, asciiSlice); +} + +{ + var asciiString = 'hello world'; + var offset = 100; + + var written = b.write(asciiString, offset, 'ascii'); + assert.equal(asciiString.length, written); + var asciiSlice = b.toString('ascii', offset, offset + asciiString.length); + assert.equal(asciiString, asciiSlice); +} + +{ + var asciiString = 'hello world'; + var offset = 100; + + var sliceA = b.slice(offset, offset + asciiString.length); + var sliceB = b.slice(offset, offset + asciiString.length); + for (var i = 0; i < asciiString.length; i++) { + assert.equal(sliceA[i], sliceB[i]); + } +} + +// UTF-8 slice test + +var utf8String = '¡hέlló wôrld!'; +var offset = 100; + +b.write(utf8String, 0, Buffer.byteLength(utf8String), 'utf8'); +var utf8Slice = b.toString('utf8', 0, Buffer.byteLength(utf8String)); +assert.equal(utf8String, utf8Slice); + +var written = b.write(utf8String, offset, 'utf8'); +assert.equal(Buffer.byteLength(utf8String), written); +utf8Slice = b.toString('utf8', offset, offset + Buffer.byteLength(utf8String)); +assert.equal(utf8String, utf8Slice); + +var sliceA = b.slice(offset, offset + Buffer.byteLength(utf8String)); +var sliceB = b.slice(offset, offset + Buffer.byteLength(utf8String)); +for (var i = 0; i < Buffer.byteLength(utf8String); i++) { + assert.equal(sliceA[i], sliceB[i]); +} + +{ + var slice = b.slice(100, 150); + assert.equal(50, slice.length); + for (var i = 0; i < 50; i++) { + assert.equal(b[100 + i], slice[i]); + } +} + +{ + // make sure only top level parent propagates from allocPool + var b = new Buffer(5); + var c = b.slice(0, 4); + var d = c.slice(0, 2); + assert.equal(b.parent, c.parent); + assert.equal(b.parent, d.parent); +} + +{ + // also from a non-pooled instance + var b = new SlowBuffer(5); + var c = b.slice(0, 4); + var d = c.slice(0, 2); + assert.equal(c.parent, d.parent); +} + +{ + // Bug regression test + var testValue = '\u00F6\u65E5\u672C\u8A9E'; // ö日本語 + var buffer = new Buffer(32); + var size = buffer.write(testValue, 0, 'utf8'); +// console.log('bytes written to buffer: ' + size); + var slice = buffer.toString('utf8', 0, size); + assert.equal(slice, testValue); +} + +{ + // Test triple slice + var a = new Buffer(8); + for (var i = 0; i < 8; i++) a[i] = i; + var b = a.slice(4, 8); + assert.equal(4, b[0]); + assert.equal(5, b[1]); + assert.equal(6, b[2]); + assert.equal(7, b[3]); + var c = b.slice(2, 4); + assert.equal(6, c[0]); + assert.equal(7, c[1]); +} + +{ + var d = new Buffer([23, 42, 255]); + assert.equal(d.length, 3); + assert.equal(d[0], 23); + assert.equal(d[1], 42); + assert.equal(d[2], 255); + assert.deepStrictEqual(d, new Buffer(d)); +} + +{ + var e = new Buffer('über'); +// console.error('uber: \'%s\'', e.toString()); + assert.deepStrictEqual(e, new Buffer([195, 188, 98, 101, 114])); +} + +{ + var f = new Buffer('über', 'ascii'); +// console.error('f.length: %d (should be 4)', f.length); + assert.deepStrictEqual(f, new Buffer([252, 98, 101, 114])); +} + +['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { + { + var f = new Buffer('über', encoding); +// console.error('f.length: %d (should be 8)', f.length); + assert.deepStrictEqual(f, new Buffer([252, 0, 98, 0, 101, 0, 114, 0])); + } + + { + var f = new Buffer('привет', encoding); +// console.error('f.length: %d (should be 12)', f.length); + var expected = new Buffer([63, 4, 64, 4, 56, 4, 50, 4, 53, 4, 66, 4]); + assert.deepStrictEqual(f, expected); + assert.equal(f.toString(encoding), 'привет'); + } + + { + var f = new Buffer([0, 0, 0, 0, 0]); + assert.equal(f.length, 5); + var size = f.write('あいうえお', encoding); +// console.error('bytes written to buffer: %d (should be 4)', size); + assert.equal(size, 4); + assert.deepStrictEqual(f, new Buffer([0x42, 0x30, 0x44, 0x30, 0x00])); + } +}); + +{ + var f = new Buffer('\uD83D\uDC4D', 'utf-16le'); // THUMBS UP SIGN (U+1F44D) + assert.equal(f.length, 4); + assert.deepStrictEqual(f, new Buffer('3DD84DDC', 'hex')); +} + + +var arrayIsh = {0: 0, 1: 1, 2: 2, 3: 3, length: 4}; +var g = new Buffer(arrayIsh); +assert.deepStrictEqual(g, new Buffer([0, 1, 2, 3])); +var strArrayIsh = {0: '0', 1: '1', 2: '2', 3: '3', length: 4}; +g = new Buffer(strArrayIsh); +assert.deepStrictEqual(g, new Buffer([0, 1, 2, 3])); + + +// +// Test toString('base64') +// +assert.equal('TWFu', (new Buffer('Man')).toString('base64')); + +{ + // test that regular and URL-safe base64 both work + var expected = [0xff, 0xff, 0xbe, 0xff, 0xef, 0xbf, 0xfb, 0xef, 0xff]; + assert.deepStrictEqual(Buffer('//++/++/++//', 'base64'), Buffer(expected)); + assert.deepStrictEqual(Buffer('__--_--_--__', 'base64'), Buffer(expected)); +} + +{ + // big example + var quote = 'Man is distinguished, not only by his reason, but by this ' + + 'singular passion from other animals, which is a lust ' + + 'of the mind, that by a perseverance of delight in the ' + + 'continued and indefatigable generation of knowledge, ' + + 'exceeds the short vehemence of any carnal pleasure.'; + var expected = 'TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb' + + '24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlci' + + 'BhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQ' + + 'gYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu' + + 'dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZ' + + 'GdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm' + + '5hbCBwbGVhc3VyZS4='; + assert.equal(expected, (new Buffer(quote)).toString('base64')); + + var b = new Buffer(1024); + var bytesWritten = b.write(expected, 0, 'base64'); + assert.equal(quote.length, bytesWritten); + assert.equal(quote, b.toString('ascii', 0, quote.length)); + + // check that the base64 decoder ignores whitespace + var expectedWhite = expected.slice(0, 60) + ' \n' + + expected.slice(60, 120) + ' \n' + + expected.slice(120, 180) + ' \n' + + expected.slice(180, 240) + ' \n' + + expected.slice(240, 300) + '\n' + + expected.slice(300, 360) + '\n'; + b = new Buffer(1024); + bytesWritten = b.write(expectedWhite, 0, 'base64'); + assert.equal(quote.length, bytesWritten); + assert.equal(quote, b.toString('ascii', 0, quote.length)); + + // check that the base64 decoder on the constructor works + // even in the presence of whitespace. + b = new Buffer(expectedWhite, 'base64'); + assert.equal(quote.length, b.length); + assert.equal(quote, b.toString('ascii', 0, quote.length)); + + // check that the base64 decoder ignores illegal chars + var expectedIllegal = expected.slice(0, 60) + ' \x80' + + expected.slice(60, 120) + ' \xff' + + expected.slice(120, 180) + ' \x00' + + expected.slice(180, 240) + ' \x98' + + expected.slice(240, 300) + '\x03' + + expected.slice(300, 360); + b = new Buffer(expectedIllegal, 'base64'); + assert.equal(quote.length, b.length); + assert.equal(quote, b.toString('ascii', 0, quote.length)); +} + +assert.equal(new Buffer('', 'base64').toString(), ''); +assert.equal(new Buffer('K', 'base64').toString(), ''); + +// multiple-of-4 with padding +assert.equal(new Buffer('Kg==', 'base64').toString(), '*'); +assert.equal(new Buffer('Kio=', 'base64').toString(), '**'); +assert.equal(new Buffer('Kioq', 'base64').toString(), '***'); +assert.equal(new Buffer('KioqKg==', 'base64').toString(), '****'); +assert.equal(new Buffer('KioqKio=', 'base64').toString(), '*****'); +assert.equal(new Buffer('KioqKioq', 'base64').toString(), '******'); +assert.equal(new Buffer('KioqKioqKg==', 'base64').toString(), '*******'); +assert.equal(new Buffer('KioqKioqKio=', 'base64').toString(), '********'); +assert.equal(new Buffer('KioqKioqKioq', 'base64').toString(), '*********'); +assert.equal(new Buffer('KioqKioqKioqKg==', 'base64').toString(), + '**********'); +assert.equal(new Buffer('KioqKioqKioqKio=', 'base64').toString(), + '***********'); +assert.equal(new Buffer('KioqKioqKioqKioq', 'base64').toString(), + '************'); +assert.equal(new Buffer('KioqKioqKioqKioqKg==', 'base64').toString(), + '*************'); +assert.equal(new Buffer('KioqKioqKioqKioqKio=', 'base64').toString(), + '**************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioq', 'base64').toString(), + '***************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKg==', 'base64').toString(), + '****************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKio=', 'base64').toString(), + '*****************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKioq', 'base64').toString(), + '******************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKg==', 'base64').toString(), + '*******************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKio=', 'base64').toString(), + '********************'); + +// no padding, not a multiple of 4 +assert.equal(new Buffer('Kg', 'base64').toString(), '*'); +assert.equal(new Buffer('Kio', 'base64').toString(), '**'); +assert.equal(new Buffer('KioqKg', 'base64').toString(), '****'); +assert.equal(new Buffer('KioqKio', 'base64').toString(), '*****'); +assert.equal(new Buffer('KioqKioqKg', 'base64').toString(), '*******'); +assert.equal(new Buffer('KioqKioqKio', 'base64').toString(), '********'); +assert.equal(new Buffer('KioqKioqKioqKg', 'base64').toString(), '**********'); +assert.equal(new Buffer('KioqKioqKioqKio', 'base64').toString(), '***********'); +assert.equal(new Buffer('KioqKioqKioqKioqKg', 'base64').toString(), + '*************'); +assert.equal(new Buffer('KioqKioqKioqKioqKio', 'base64').toString(), + '**************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKg', 'base64').toString(), + '****************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKio', 'base64').toString(), + '*****************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKg', 'base64').toString(), + '*******************'); +assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKio', 'base64').toString(), + '********************'); + +// handle padding graciously, multiple-of-4 or not +assert.equal( + new Buffer('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw==', 'base64').length, + 32 +); +assert.equal( + new Buffer('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw=', 'base64').length, + 32 +); +assert.equal( + new Buffer('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw', 'base64').length, + 32 +); +assert.equal( + new Buffer('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg==', 'base64').length, + 31 +); +assert.equal( + new Buffer('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg=', 'base64').length, + 31 +); +assert.equal( + new Buffer('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg', 'base64').length, + 31 +); + +// This string encodes single '.' character in UTF-16 +var dot = new Buffer('//4uAA==', 'base64'); +assert.equal(dot[0], 0xff); +assert.equal(dot[1], 0xfe); +assert.equal(dot[2], 0x2e); +assert.equal(dot[3], 0x00); +assert.equal(dot.toString('base64'), '//4uAA=='); + +{ + // Writing base64 at a position > 0 should not mangle the result. + // + // https://github.com/joyent/node/issues/402 + var segments = ['TWFkbmVzcz8h', 'IFRoaXM=', 'IGlz', 'IG5vZGUuanMh']; + var b = new Buffer(64); + var pos = 0; + + for (var i = 0; i < segments.length; ++i) { + pos += b.write(segments[i], pos, 'base64'); + } + assert.equal(b.toString('latin1', 0, pos), 'Madness?! This is node.js!'); + assert.equal(b.toString('binary', 0, pos), 'Madness?! This is node.js!'); +} + +// Regression test for https://github.com/nodejs/node/issues/3496. +// assert.equal(Buffer('=bad'.repeat(1e4), 'base64').length, 0); + +{ + // Creating buffers larger than pool size. + var l = Buffer.poolSize + 5; + var s = 'h'.repeat(l); + + var b = new Buffer(s); + + for (var i = 0; i < l; i++) { + assert.equal('h'.charCodeAt(0), b[i]); + } + + var sb = b.toString(); + assert.equal(sb.length, s.length); + assert.equal(sb, s); +} + +{ + // Single argument slice + var b = new Buffer('abcde'); + assert.equal('bcde', b.slice(1).toString()); +} + +// slice(0,0).length === 0 +assert.equal(0, Buffer('hello').slice(0, 0).length); + +// test hex toString +// console.log('Create hex string from buffer'); +var hexb = new Buffer(256); +for (var i = 0; i < 256; i++) { + hexb[i] = i; +} +var hexStr = hexb.toString('hex'); +assert.equal(hexStr, + '000102030405060708090a0b0c0d0e0f' + + '101112131415161718191a1b1c1d1e1f' + + '202122232425262728292a2b2c2d2e2f' + + '303132333435363738393a3b3c3d3e3f' + + '404142434445464748494a4b4c4d4e4f' + + '505152535455565758595a5b5c5d5e5f' + + '606162636465666768696a6b6c6d6e6f' + + '707172737475767778797a7b7c7d7e7f' + + '808182838485868788898a8b8c8d8e8f' + + '909192939495969798999a9b9c9d9e9f' + + 'a0a1a2a3a4a5a6a7a8a9aaabacadaeaf' + + 'b0b1b2b3b4b5b6b7b8b9babbbcbdbebf' + + 'c0c1c2c3c4c5c6c7c8c9cacbcccdcecf' + + 'd0d1d2d3d4d5d6d7d8d9dadbdcdddedf' + + 'e0e1e2e3e4e5e6e7e8e9eaebecedeeef' + + 'f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff'); + +// console.log('Create buffer from hex string'); +var hexb2 = new Buffer(hexStr, 'hex'); +for (var i = 0; i < 256; i++) { + assert.equal(hexb2[i], hexb[i]); +} + +// Test single hex character throws TypeError +// - https://github.com/nodejs/node/issues/6770 +assert.throws(function() { + Buffer.from('A', 'hex'); +}, TypeError); + +// Test single base64 char encodes as 0 +// assert.strictEqual(Buffer.from('A', 'base64').length, 0); + +{ + // test an invalid slice end. +// console.log('Try to slice off the end of the buffer'); + var b = new Buffer([1, 2, 3, 4, 5]); + var b2 = b.toString('hex', 1, 10000); + var b3 = b.toString('hex', 1, 5); + var b4 = b.toString('hex', 1); + assert.equal(b2, b3); + assert.equal(b2, b4); +} + +function buildBuffer(data) { + if (Array.isArray(data)) { + var buffer = Buffer(data.length); + data.forEach(function(v, k) { + buffer[k] = v; + }); + return buffer; + } + return null; +} + +var x = buildBuffer([0x81, 0xa3, 0x66, 0x6f, 0x6f, 0xa3, 0x62, 0x61, 0x72]); + +// console.log(x.inspect()); +assert.equal('', x.inspect()); + +{ + var z = x.slice(4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(5, z.length); + assert.equal(0x6f, z[0]); + assert.equal(0xa3, z[1]); + assert.equal(0x62, z[2]); + assert.equal(0x61, z[3]); + assert.equal(0x72, z[4]); +} + +{ + var z = x.slice(0); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(z.length, x.length); +} + +{ + var z = x.slice(0, 4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(4, z.length); + assert.equal(0x81, z[0]); + assert.equal(0xa3, z[1]); +} + +{ + var z = x.slice(0, 9); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(9, z.length); +} + +{ + var z = x.slice(1, 4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(3, z.length); + assert.equal(0xa3, z[0]); +} + +{ + var z = x.slice(2, 4); +// console.log(z.inspect()); +// console.log(z.length); + assert.equal(2, z.length); + assert.equal(0x66, z[0]); + assert.equal(0x6f, z[1]); +} + +assert.equal(0, Buffer('hello').slice(0, 0).length); + +['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { + var b = new Buffer(10); + b.write('あいうえお', encoding); + assert.equal(b.toString(encoding), 'あいうえお'); +}); + +{ + // latin1 encoding should write only one byte per character. + var b = Buffer([0xde, 0xad, 0xbe, 0xef]); + var s = String.fromCharCode(0xffff); + b.write(s, 0, 'latin1'); + assert.equal(0xff, b[0]); + assert.equal(0xad, b[1]); + assert.equal(0xbe, b[2]); + assert.equal(0xef, b[3]); + s = String.fromCharCode(0xaaee); + b.write(s, 0, 'latin1'); + assert.equal(0xee, b[0]); + assert.equal(0xad, b[1]); + assert.equal(0xbe, b[2]); + assert.equal(0xef, b[3]); +} + +{ + // Binary encoding should write only one byte per character. + var b = Buffer([0xde, 0xad, 0xbe, 0xef]); + var s = String.fromCharCode(0xffff); + b.write(s, 0, 'binary'); + assert.equal(0xff, b[0]); + assert.equal(0xad, b[1]); + assert.equal(0xbe, b[2]); + assert.equal(0xef, b[3]); + s = String.fromCharCode(0xaaee); + b.write(s, 0, 'binary'); + assert.equal(0xee, b[0]); + assert.equal(0xad, b[1]); + assert.equal(0xbe, b[2]); + assert.equal(0xef, b[3]); +} + +{ + // #1210 Test UTF-8 string includes null character + var buf = new Buffer('\0'); + assert.equal(buf.length, 1); + buf = new Buffer('\0\0'); + assert.equal(buf.length, 2); +} + +{ + var buf = new Buffer(2); + var written = buf.write(''); // 0byte + assert.equal(written, 0); + written = buf.write('\0'); // 1byte (v8 adds null terminator) + assert.equal(written, 1); + written = buf.write('a\0'); // 1byte * 2 + assert.equal(written, 2); + written = buf.write('あ'); // 3bytes + assert.equal(written, 0); + written = buf.write('\0あ'); // 1byte + 3bytes + assert.equal(written, 1); + written = buf.write('\0\0あ'); // 1byte * 2 + 3bytes + assert.equal(written, 2); +} + +{ + var buf = new Buffer(10); + written = buf.write('あいう'); // 3bytes * 3 (v8 adds null terminator) + assert.equal(written, 9); + written = buf.write('あいう\0'); // 3bytes * 3 + 1byte + assert.equal(written, 10); +} + +{ + // #243 Test write() with maxLength + var buf = new Buffer(4); + buf.fill(0xFF); + var written = buf.write('abcd', 1, 2, 'utf8'); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0x61); + assert.equal(buf[2], 0x62); + assert.equal(buf[3], 0xFF); + + buf.fill(0xFF); + written = buf.write('abcd', 1, 4); +// console.log(buf); + assert.equal(written, 3); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0x61); + assert.equal(buf[2], 0x62); + assert.equal(buf[3], 0x63); + + buf.fill(0xFF); + written = buf.write('abcd', 1, 2, 'utf8'); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0x61); + assert.equal(buf[2], 0x62); + assert.equal(buf[3], 0xFF); + + buf.fill(0xFF); + written = buf.write('abcdef', 1, 2, 'hex'); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0xFF); + assert.equal(buf[1], 0xAB); + assert.equal(buf[2], 0xCD); + assert.equal(buf[3], 0xFF); + + ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { + buf.fill(0xFF); + written = buf.write('abcd', 0, 2, encoding); +// console.log(buf); + assert.equal(written, 2); + assert.equal(buf[0], 0x61); + assert.equal(buf[1], 0x00); + assert.equal(buf[2], 0xFF); + assert.equal(buf[3], 0xFF); + }); +} + +{ + // test offset returns are correct + var b = new Buffer(16); + assert.equal(4, b.writeUInt32LE(0, 0)); + assert.equal(6, b.writeUInt16LE(0, 4)); + assert.equal(7, b.writeUInt8(0, 6)); + assert.equal(8, b.writeInt8(0, 7)); + assert.equal(16, b.writeDoubleLE(0, 8)); +} + +{ + // test unmatched surrogates not producing invalid utf8 output + // ef bf bd = utf-8 representation of unicode replacement character + // see https://codereview.chromium.org/121173009/ + var buf = new Buffer('ab\ud800cd', 'utf8'); + assert.equal(buf[0], 0x61); + assert.equal(buf[1], 0x62); + assert.equal(buf[2], 0xef); + assert.equal(buf[3], 0xbf); + assert.equal(buf[4], 0xbd); + assert.equal(buf[5], 0x63); + assert.equal(buf[6], 0x64); +} + +{ + // test for buffer overrun + var buf = new Buffer([0, 0, 0, 0, 0]); // length: 5 + var sub = buf.slice(0, 4); // length: 4 + written = sub.write('12345', 'latin1'); + assert.equal(written, 4); + assert.equal(buf[4], 0); + written = sub.write('12345', 'binary'); + assert.equal(written, 4); + assert.equal(buf[4], 0); +} + +// Check for fractional length args, junk length args, etc. +// https://github.com/joyent/node/issues/1758 + +// Call .fill() first, stops valgrind warning about uninitialized memory reads. +Buffer(3.3).fill().toString(); // throws bad argument error in commit 43cb4ec +assert.equal(Buffer(NaN).length, 0); +assert.equal(Buffer(3.3).length, 3); +assert.equal(Buffer({length: 3.3}).length, 3); +assert.equal(Buffer({length: 'BAM'}).length, 0); + +// Make sure that strings are not coerced to numbers. +assert.equal(Buffer('99').length, 2); +assert.equal(Buffer('13.37').length, 5); + +// Ensure that the length argument is respected. +'ascii utf8 hex base64 latin1 binary'.split(' ').forEach(function(enc) { + assert.equal(Buffer(1).write('aaaaaa', 0, 1, enc), 1); +}); + +{ + // Regression test, guard against buffer overrun in the base64 decoder. + var a = Buffer(3); + var b = Buffer('xxx'); + a.write('aaaaaaaa', 'base64'); + assert.equal(b.toString(), 'xxx'); +} + +// issue GH-3416 +Buffer(Buffer(0), 0, 0); + +[ 'hex', + 'utf8', + 'utf-8', + 'ascii', + 'latin1', + 'binary', + 'base64', + 'ucs2', + 'ucs-2', + 'utf16le', + 'utf-16le' ].forEach(function(enc) { + assert.equal(Buffer.isEncoding(enc), true); + }); + +[ 'utf9', + 'utf-7', + 'Unicode-FTW', + 'new gnu gun' ].forEach(function(enc) { + assert.equal(Buffer.isEncoding(enc), false); + }); + + +// GH-5110 +{ + var buffer = new Buffer('test'); + var string = JSON.stringify(buffer); + + assert.strictEqual(string, '{"type":"Buffer","data":[116,101,115,116]}'); + + assert.deepStrictEqual(buffer, JSON.parse(string, function(key, value) { + return value && value.type === 'Buffer' + ? new Buffer(value.data) + : value; + })); +} + +// issue GH-7849 +{ + var buf = new Buffer('test'); + var json = JSON.stringify(buf); + var obj = JSON.parse(json); + var copy = new Buffer(obj); + + assert(buf.equals(copy)); +} + +// issue GH-4331 +assert.throws(function() { + Buffer(0xFFFFFFFF); +}, RangeError); +assert.throws(function() { + Buffer(0xFFFFFFFFF); +}, RangeError); + +// issue GH-5587 +assert.throws(function() { + var buf = new Buffer(8); + buf.writeFloatLE(0, 5); +}, RangeError); +assert.throws(function() { + var buf = new Buffer(16); + buf.writeDoubleLE(0, 9); +}, RangeError); + + +// attempt to overflow buffers, similar to previous bug in array buffers +assert.throws(function() { + var buf = Buffer(8); + buf.readFloatLE(0xffffffff); +}, RangeError); + +assert.throws(function() { + var buf = Buffer(8); + buf.writeFloatLE(0.0, 0xffffffff); +}, RangeError); + +assert.throws(function() { + var buf = Buffer(8); + buf.readFloatLE(0xffffffff); +}, RangeError); + +assert.throws(function() { + var buf = Buffer(8); + buf.writeFloatLE(0.0, 0xffffffff); +}, RangeError); + + +// ensure negative values can't get past offset +assert.throws(function() { + var buf = Buffer(8); + buf.readFloatLE(-1); +}, RangeError); + +assert.throws(function() { + var buf = Buffer(8); + buf.writeFloatLE(0.0, -1); +}, RangeError); + +assert.throws(function() { + var buf = Buffer(8); + buf.readFloatLE(-1); +}, RangeError); + +assert.throws(function() { + var buf = Buffer(8); + buf.writeFloatLE(0.0, -1); +}, RangeError); + +// offset checks +{ + var buf = new Buffer(0); + + assert.throws(function() { buf.readUInt8(0); }, RangeError); + assert.throws(function() { buf.readInt8(0); }, RangeError); +} + +{ + var buf = new Buffer([0xFF]); + + assert.equal(buf.readUInt8(0), 255); + assert.equal(buf.readInt8(0), -1); +} + +[16, 32].forEach(function(bits) { + var buf = new Buffer(bits / 8 - 1); + + assert.throws(function() { buf['readUInt' + bits + 'BE'](0); }, + RangeError, + 'readUInt' + bits + 'BE'); + + assert.throws(function() { buf['readUInt' + bits + 'LE'](0); }, + RangeError, + 'readUInt' + bits + 'LE'); + + assert.throws(function() { buf['readInt' + bits + 'BE'](0); }, + RangeError, + 'readInt' + bits + 'BE()'); + + assert.throws(function() { buf['readInt' + bits + 'LE'](0); }, + RangeError, + 'readInt' + bits + 'LE()'); +}); + +[16, 32].forEach(function(bits) { + var buf = new Buffer([0xFF, 0xFF, 0xFF, 0xFF]); + + assert.equal(buf['readUInt' + bits + 'BE'](0), + (0xFFFFFFFF >>> (32 - bits))); + + assert.equal(buf['readUInt' + bits + 'LE'](0), + (0xFFFFFFFF >>> (32 - bits))); + + assert.equal(buf['readInt' + bits + 'BE'](0), + (0xFFFFFFFF >> (32 - bits))); + + assert.equal(buf['readInt' + bits + 'LE'](0), + (0xFFFFFFFF >> (32 - bits))); +}); + +// test for common read(U)IntLE/BE +{ + var buf = new Buffer([0x01, 0x02, 0x03, 0x04, 0x05, 0x06]); + + assert.strictEqual(buf.readUIntLE(0, 1), 0x01); + assert.strictEqual(buf.readUIntBE(0, 1), 0x01); + assert.strictEqual(buf.readUIntLE(0, 3), 0x030201); + assert.strictEqual(buf.readUIntBE(0, 3), 0x010203); + assert.strictEqual(buf.readUIntLE(0, 5), 0x0504030201); + assert.strictEqual(buf.readUIntBE(0, 5), 0x0102030405); + assert.strictEqual(buf.readUIntLE(0, 6), 0x060504030201); + assert.strictEqual(buf.readUIntBE(0, 6), 0x010203040506); + assert.strictEqual(buf.readIntLE(0, 1), 0x01); + assert.strictEqual(buf.readIntBE(0, 1), 0x01); + assert.strictEqual(buf.readIntLE(0, 3), 0x030201); + assert.strictEqual(buf.readIntBE(0, 3), 0x010203); + assert.strictEqual(buf.readIntLE(0, 5), 0x0504030201); + assert.strictEqual(buf.readIntBE(0, 5), 0x0102030405); + assert.strictEqual(buf.readIntLE(0, 6), 0x060504030201); + assert.strictEqual(buf.readIntBE(0, 6), 0x010203040506); +} + +// test for common write(U)IntLE/BE +{ + var buf = Buffer(3); + buf.writeUIntLE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); + assert.equal(buf.readUIntLE(0, 3), 0x123456); + + buf = Buffer(3); + buf.writeUIntBE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); + assert.equal(buf.readUIntBE(0, 3), 0x123456); + + buf = Buffer(3); + buf.writeIntLE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); + assert.equal(buf.readIntLE(0, 3), 0x123456); + + buf = Buffer(3); + buf.writeIntBE(0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); + assert.equal(buf.readIntBE(0, 3), 0x123456); + + buf = Buffer(3); + buf.writeIntLE(-0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xaa, 0xcb, 0xed]); + assert.equal(buf.readIntLE(0, 3), -0x123456); + + buf = Buffer(3); + buf.writeIntBE(-0x123456, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xed, 0xcb, 0xaa]); + assert.equal(buf.readIntBE(0, 3), -0x123456); + + buf = Buffer(3); + buf.writeIntLE(-0x123400, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x00, 0xcc, 0xed]); + assert.equal(buf.readIntLE(0, 3), -0x123400); + + buf = Buffer(3); + buf.writeIntBE(-0x123400, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xed, 0xcc, 0x00]); + assert.equal(buf.readIntBE(0, 3), -0x123400); + + buf = Buffer(3); + buf.writeIntLE(-0x120000, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0x00, 0x00, 0xee]); + assert.equal(buf.readIntLE(0, 3), -0x120000); + + buf = Buffer(3); + buf.writeIntBE(-0x120000, 0, 3); + assert.deepStrictEqual(buf.toJSON().data, [0xee, 0x00, 0x00]); + assert.equal(buf.readIntBE(0, 3), -0x120000); + + buf = Buffer(5); + buf.writeUIntLE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); + assert.equal(buf.readUIntLE(0, 5), 0x1234567890); + + buf = Buffer(5); + buf.writeUIntBE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); + assert.equal(buf.readUIntBE(0, 5), 0x1234567890); + + buf = Buffer(5); + buf.writeIntLE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); + assert.equal(buf.readIntLE(0, 5), 0x1234567890); + + buf = Buffer(5); + buf.writeIntBE(0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); + assert.equal(buf.readIntBE(0, 5), 0x1234567890); + + buf = Buffer(5); + buf.writeIntLE(-0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x70, 0x87, 0xa9, 0xcb, 0xed]); + assert.equal(buf.readIntLE(0, 5), -0x1234567890); + + buf = Buffer(5); + buf.writeIntBE(-0x1234567890, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0xed, 0xcb, 0xa9, 0x87, 0x70]); + assert.equal(buf.readIntBE(0, 5), -0x1234567890); + + buf = Buffer(5); + buf.writeIntLE(-0x0012000000, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0x00, 0x00, 0x00, 0xee, 0xff]); + assert.equal(buf.readIntLE(0, 5), -0x0012000000); + + buf = Buffer(5); + buf.writeIntBE(-0x0012000000, 0, 5); + assert.deepStrictEqual(buf.toJSON().data, [0xff, 0xee, 0x00, 0x00, 0x00]); + assert.equal(buf.readIntBE(0, 5), -0x0012000000); +} + +// test Buffer slice +{ + var buf = new Buffer('0123456789'); + assert.equal(buf.slice(-10, 10), '0123456789'); + assert.equal(buf.slice(-20, 10), '0123456789'); + assert.equal(buf.slice(-20, -10), ''); + assert.equal(buf.slice(), '0123456789'); + assert.equal(buf.slice(0), '0123456789'); + assert.equal(buf.slice(0, 0), ''); + assert.equal(buf.slice(undefined), '0123456789'); + assert.equal(buf.slice('foobar'), '0123456789'); + assert.equal(buf.slice(undefined, undefined), '0123456789'); + + assert.equal(buf.slice(2), '23456789'); + assert.equal(buf.slice(5), '56789'); + assert.equal(buf.slice(10), ''); + assert.equal(buf.slice(5, 8), '567'); + assert.equal(buf.slice(8, -1), '8'); + assert.equal(buf.slice(-10), '0123456789'); + assert.equal(buf.slice(0, -9), '0'); + assert.equal(buf.slice(0, -10), ''); + assert.equal(buf.slice(0, -1), '012345678'); + assert.equal(buf.slice(2, -2), '234567'); + assert.equal(buf.slice(0, 65536), '0123456789'); + assert.equal(buf.slice(65536, 0), ''); + assert.equal(buf.slice(-5, -8), ''); + assert.equal(buf.slice(-5, -3), '56'); + assert.equal(buf.slice(-10, 10), '0123456789'); + for (var i = 0, s = buf.toString(); i < buf.length; ++i) { + assert.equal(buf.slice(i), s.slice(i)); + assert.equal(buf.slice(0, i), s.slice(0, i)); + assert.equal(buf.slice(-i), s.slice(-i)); + assert.equal(buf.slice(0, -i), s.slice(0, -i)); + } + + var utf16Buf = new Buffer('0123456789', 'utf16le'); + assert.deepStrictEqual(utf16Buf.slice(0, 6), Buffer('012', 'utf16le')); + + assert.equal(buf.slice('0', '1'), '0'); + assert.equal(buf.slice('-5', '10'), '56789'); + assert.equal(buf.slice('-10', '10'), '0123456789'); + assert.equal(buf.slice('-10', '-5'), '01234'); + assert.equal(buf.slice('-10', '-0'), ''); + assert.equal(buf.slice('111'), ''); + assert.equal(buf.slice('0', '-111'), ''); + + // try to slice a zero length Buffer + // see https://github.com/joyent/node/issues/5881 + SlowBuffer(0).slice(0, 1); +} + +// Regression test for #5482: should throw but not assert in C++ land. +assert.throws(function() { + Buffer('', 'buffer'); +}, TypeError); + +// Regression test for #6111. Constructing a buffer from another buffer +// should a) work, and b) not corrupt the source buffer. +{ + var a = [0]; + for (var i = 0; i < 7; ++i) a = a.concat(a); + a = a.map(function(_, i) { return i; }); + var b = Buffer(a); + var c = Buffer(b); + assert.strictEqual(b.length, a.length); + assert.strictEqual(c.length, a.length); + for (var i = 0, k = a.length; i < k; ++i) { + assert.strictEqual(a[i], i); + assert.strictEqual(b[i], i); + assert.strictEqual(c[i], i); + } +} + + +assert.throws(function() { + new Buffer((-1 >>> 0) + 1); +}, RangeError); + +assert.throws(function() { + SlowBuffer((-1 >>> 0) + 1); +}, RangeError); + +if (common.hasCrypto) { + // Test truncation after decode + // var crypto = require('crypto'); + + var b1 = new Buffer('YW55=======', 'base64'); + var b2 = new Buffer('YW55', 'base64'); + + assert.equal( + 1 /*crypto.createHash('sha1').update(b1).digest('hex')*/, + 1 /*crypto.createHash('sha1').update(b2).digest('hex')*/ + ); +} else { + common.skip('missing crypto'); +} + +// Test Compare +{ + var b = new Buffer(1).fill('a'); + var c = new Buffer(1).fill('c'); + var d = new Buffer(2).fill('aa'); + + assert.equal(b.compare(c), -1); + assert.equal(c.compare(d), 1); + assert.equal(d.compare(b), 1); + assert.equal(b.compare(d), -1); + assert.equal(b.compare(b), 0); + + assert.equal(Buffer.compare(b, c), -1); + assert.equal(Buffer.compare(c, d), 1); + assert.equal(Buffer.compare(d, b), 1); + assert.equal(Buffer.compare(b, d), -1); + assert.equal(Buffer.compare(c, c), 0); + + assert.equal(Buffer.compare(Buffer(0), Buffer(0)), 0); + assert.equal(Buffer.compare(Buffer(0), Buffer(1)), -1); + assert.equal(Buffer.compare(Buffer(1), Buffer(0)), 1); +} + +assert.throws(function() { + var b = Buffer(1); + Buffer.compare(b, 'abc'); +}); + +assert.throws(function() { + var b = Buffer(1); + Buffer.compare('abc', b); +}); + +assert.throws(function() { + var b = Buffer(1); + b.compare('abc'); +}); + +// Test Equals +{ + var b = new Buffer(5).fill('abcdf'); + var c = new Buffer(5).fill('abcdf'); + var d = new Buffer(5).fill('abcde'); + var e = new Buffer(6).fill('abcdef'); + + assert.ok(b.equals(c)); + assert.ok(!c.equals(d)); + assert.ok(!d.equals(e)); + assert.ok(d.equals(d)); +} + +assert.throws(function() { + var b = Buffer(1); + b.equals('abc'); +}); + +// Regression test for https://github.com/nodejs/node/issues/649. +assert.throws(function() { Buffer(1422561062959).toString('utf8'); }); + +var ps = Buffer.poolSize; +Buffer.poolSize = 0; +assert.equal(Buffer(1).parent, undefined); +Buffer.poolSize = ps; + +// Test Buffer.copy() segfault +assert.throws(function() { + Buffer(10).copy(); +}); + +var regErrorMsg = new RegExp('First argument must be a string, Buffer, ' + + 'ArrayBuffer, Array, or array-like object.'); + +assert.throws(function() { + new Buffer(); +}, regErrorMsg); + +assert.throws(function() { + new Buffer(null); +}, regErrorMsg); + + +// Test prototype getters don't throw +assert.equal(Buffer.prototype.parent, undefined); +assert.equal(Buffer.prototype.offset, undefined); +assert.equal(SlowBuffer.prototype.parent, undefined); +assert.equal(SlowBuffer.prototype.offset, undefined); + +{ + // Test that large negative Buffer length inputs don't affect the pool offset. + // Use the fromArrayLike() variant here because it's more lenient + // about its input and passes the length directly to allocate(). + assert.deepStrictEqual(Buffer({ length: -Buffer.poolSize }), Buffer.from('')); + assert.deepStrictEqual(Buffer({ length: -100 }), Buffer.from('')); + + // Check pool offset after that by trying to write string into the pool. + assert.doesNotThrow(() => Buffer.from('abc')); +} + + +// Test failed or zero-sized Buffer allocations not affecting typed arrays +{ + var zeroArray = new Uint32Array(10).fill(0); + var sizes = [1e10, 0, 0.1, -1, 'a', undefined, null, NaN]; + var allocators = [ + Buffer, + SlowBuffer, + Buffer.alloc, + Buffer.allocUnsafe, + Buffer.allocUnsafeSlow + ]; + for (var allocator of allocators) { + for (var size of sizes) { + try { + allocator(size); + } catch (e) { + assert.deepStrictEqual(new Uint32Array(10), zeroArray); + } + } + } +} + +// Test that large negative Buffer length inputs throw errors. +assert.throws(() => Buffer(-Buffer.poolSize), + '"size" argument must not be negative'); +assert.throws(() => Buffer(-100), + '"size" argument must not be negative'); +assert.throws(() => Buffer(-1), + '"size" argument must not be negative'); + diff --git a/node_modules/buffer/test/slice.js b/node_modules/buffer/test/slice.js new file mode 100644 index 0000000..25c111c --- /dev/null +++ b/node_modules/buffer/test/slice.js @@ -0,0 +1,37 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('modifying buffer created by .slice() modifies original memory', function (t) { + if (!B.TYPED_ARRAY_SUPPORT) return t.end() + + var buf1 = new B(26) + for (var i = 0; i < 26; i++) { + buf1[i] = i + 97 // 97 is ASCII a + } + + var buf2 = buf1.slice(0, 3) + t.equal(buf2.toString('ascii', 0, buf2.length), 'abc') + + buf2[0] = '!'.charCodeAt(0) + t.equal(buf1.toString('ascii', 0, buf2.length), '!bc') + + t.end() +}) + +test('modifying parent buffer modifies .slice() buffer\'s memory', function (t) { + if (!B.TYPED_ARRAY_SUPPORT) return t.end() + + var buf1 = new B(26) + for (var i = 0; i < 26; i++) { + buf1[i] = i + 97 // 97 is ASCII a + } + + var buf2 = buf1.slice(0, 3) + t.equal(buf2.toString('ascii', 0, buf2.length), 'abc') + + buf1[0] = '!'.charCodeAt(0) + t.equal(buf2.toString('ascii', 0, buf2.length), '!bc') + + t.end() +}) diff --git a/node_modules/buffer/test/static.js b/node_modules/buffer/test/static.js new file mode 100644 index 0000000..4de900b --- /dev/null +++ b/node_modules/buffer/test/static.js @@ -0,0 +1,17 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('Buffer.isEncoding', function (t) { + t.equal(B.isEncoding('HEX'), true) + t.equal(B.isEncoding('hex'), true) + t.equal(B.isEncoding('bad'), false) + t.end() +}) + +test('Buffer.isBuffer', function (t) { + t.equal(B.isBuffer(new B('hey', 'utf8')), true) + t.equal(B.isBuffer(new B([1, 2, 3], 'utf8')), true) + t.equal(B.isBuffer('hey'), false) + t.end() +}) diff --git a/node_modules/buffer/test/to-string.js b/node_modules/buffer/test/to-string.js new file mode 100644 index 0000000..2950d4d --- /dev/null +++ b/node_modules/buffer/test/to-string.js @@ -0,0 +1,233 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('utf8 buffer to base64', function (t) { + t.equal( + new B('Ձאab', 'utf8').toString('base64'), + '1YHXkGFi' + ) + t.end() +}) + +test('utf8 buffer to hex', function (t) { + t.equal( + new B('Ձאab', 'utf8').toString('hex'), + 'd581d7906162' + ) + t.end() +}) + +test('utf8 to utf8', function (t) { + t.equal( + new B('öäüõÖÄÜÕ', 'utf8').toString('utf8'), + 'öäüõÖÄÜÕ' + ) + t.end() +}) + +test('utf16le to utf16', function (t) { + t.equal( + new B(new B('abcd', 'utf8').toString('utf16le'), 'utf16le').toString('utf8'), + 'abcd' + ) + t.end() +}) + +test('utf16le to hex', function (t) { + t.equal( + new B('abcd', 'utf16le').toString('hex'), + '6100620063006400' + ) + t.end() +}) + +test('ascii buffer to base64', function (t) { + t.equal( + new B('123456!@#$%^', 'ascii').toString('base64'), + 'MTIzNDU2IUAjJCVe' + ) + t.end() +}) + +test('ascii buffer to hex', function (t) { + t.equal( + new B('123456!@#$%^', 'ascii').toString('hex'), + '31323334353621402324255e' + ) + t.end() +}) + +test('base64 buffer to utf8', function (t) { + t.equal( + new B('1YHXkGFi', 'base64').toString('utf8'), + 'Ձאab' + ) + t.end() +}) + +test('hex buffer to utf8', function (t) { + t.equal( + new B('d581d7906162', 'hex').toString('utf8'), + 'Ձאab' + ) + t.end() +}) + +test('base64 buffer to ascii', function (t) { + t.equal( + new B('MTIzNDU2IUAjJCVe', 'base64').toString('ascii'), + '123456!@#$%^' + ) + t.end() +}) + +test('hex buffer to ascii', function (t) { + t.equal( + new B('31323334353621402324255e', 'hex').toString('ascii'), + '123456!@#$%^' + ) + t.end() +}) + +test('base64 buffer to binary', function (t) { + t.equal( + new B('MTIzNDU2IUAjJCVe', 'base64').toString('binary'), + '123456!@#$%^' + ) + t.end() +}) + +test('hex buffer to binary', function (t) { + t.equal( + new B('31323334353621402324255e', 'hex').toString('binary'), + '123456!@#$%^' + ) + t.end() +}) + +test('utf8 to binary', function (t) { + /* jshint -W100 */ + t.equal( + new B('öäüõÖÄÜÕ', 'utf8').toString('binary'), + 'öäüõÖÄÜÕ' + ) + /* jshint +W100 */ + t.end() +}) + +test('utf8 replacement chars (1 byte sequence)', function (t) { + t.equal( + new B([ 0x80 ]).toString(), + '\uFFFD' + ) + t.equal( + new B([ 0x7F ]).toString(), + '\u007F' + ) + t.end() +}) + +test('utf8 replacement chars (2 byte sequences)', function (t) { + t.equal( + new B([ 0xC7 ]).toString(), + '\uFFFD' + ) + t.equal( + new B([ 0xC7, 0xB1 ]).toString(), + '\u01F1' + ) + t.equal( + new B([ 0xC0, 0xB1 ]).toString(), + '\uFFFD\uFFFD' + ) + t.equal( + new B([ 0xC1, 0xB1 ]).toString(), + '\uFFFD\uFFFD' + ) + t.end() +}) + +test('utf8 replacement chars (3 byte sequences)', function (t) { + t.equal( + new B([ 0xE0 ]).toString(), + '\uFFFD' + ) + t.equal( + new B([ 0xE0, 0xAC ]).toString(), + '\uFFFD\uFFFD' + ) + t.equal( + new B([ 0xE0, 0xAC, 0xB9 ]).toString(), + '\u0B39' + ) + t.end() +}) + +test('utf8 replacement chars (4 byte sequences)', function (t) { + t.equal( + new B([ 0xF4 ]).toString(), + '\uFFFD' + ) + t.equal( + new B([ 0xF4, 0x8F ]).toString(), + '\uFFFD\uFFFD' + ) + t.equal( + new B([ 0xF4, 0x8F, 0x80 ]).toString(), + '\uFFFD\uFFFD\uFFFD' + ) + t.equal( + new B([ 0xF4, 0x8F, 0x80, 0x84 ]).toString(), + '\uDBFC\uDC04' + ) + t.equal( + new B([ 0xFF ]).toString(), + '\uFFFD' + ) + t.equal( + new B([ 0xFF, 0x8F, 0x80, 0x84 ]).toString(), + '\uFFFD\uFFFD\uFFFD\uFFFD' + ) + t.end() +}) + +test('utf8 replacement chars on 256 random bytes', function (t) { + t.equal( + new B([ 152, 130, 206, 23, 243, 238, 197, 44, 27, 86, 208, 36, 163, 184, 164, 21, 94, 242, 178, 46, 25, 26, 253, 178, 72, 147, 207, 112, 236, 68, 179, 190, 29, 83, 239, 147, 125, 55, 143, 19, 157, 68, 157, 58, 212, 224, 150, 39, 128, 24, 94, 225, 120, 121, 75, 192, 112, 19, 184, 142, 203, 36, 43, 85, 26, 147, 227, 139, 242, 186, 57, 78, 11, 102, 136, 117, 180, 210, 241, 92, 3, 215, 54, 167, 249, 1, 44, 225, 146, 86, 2, 42, 68, 21, 47, 238, 204, 153, 216, 252, 183, 66, 222, 255, 15, 202, 16, 51, 134, 1, 17, 19, 209, 76, 238, 38, 76, 19, 7, 103, 249, 5, 107, 137, 64, 62, 170, 57, 16, 85, 179, 193, 97, 86, 166, 196, 36, 148, 138, 193, 210, 69, 187, 38, 242, 97, 195, 219, 252, 244, 38, 1, 197, 18, 31, 246, 53, 47, 134, 52, 105, 72, 43, 239, 128, 203, 73, 93, 199, 75, 222, 220, 166, 34, 63, 236, 11, 212, 76, 243, 171, 110, 78, 39, 205, 204, 6, 177, 233, 212, 243, 0, 33, 41, 122, 118, 92, 252, 0, 157, 108, 120, 70, 137, 100, 223, 243, 171, 232, 66, 126, 111, 142, 33, 3, 39, 117, 27, 107, 54, 1, 217, 227, 132, 13, 166, 3, 73, 53, 127, 225, 236, 134, 219, 98, 214, 125, 148, 24, 64, 142, 111, 231, 194, 42, 150, 185, 10, 182, 163, 244, 19, 4, 59, 135, 16 ]).toString(), + '\uFFFD\uFFFD\uFFFD\u0017\uFFFD\uFFFD\uFFFD\u002C\u001B\u0056\uFFFD\u0024\uFFFD\uFFFD\uFFFD\u0015\u005E\uFFFD\uFFFD\u002E\u0019\u001A\uFFFD\uFFFD\u0048\uFFFD\uFFFD\u0070\uFFFD\u0044\uFFFD\uFFFD\u001D\u0053\uFFFD\uFFFD\u007D\u0037\uFFFD\u0013\uFFFD\u0044\uFFFD\u003A\uFFFD\uFFFD\uFFFD\u0027\uFFFD\u0018\u005E\uFFFD\u0078\u0079\u004B\uFFFD\u0070\u0013\uFFFD\uFFFD\uFFFD\u0024\u002B\u0055\u001A\uFFFD\uFFFD\uFFFD\uFFFD\uFFFD\u0039\u004E\u000B\u0066\uFFFD\u0075\uFFFD\uFFFD\uFFFD\u005C\u0003\uFFFD\u0036\uFFFD\uFFFD\u0001\u002C\uFFFD\uFFFD\u0056\u0002\u002A\u0044\u0015\u002F\uFFFD\u0319\uFFFD\uFFFD\uFFFD\u0042\uFFFD\uFFFD\u000F\uFFFD\u0010\u0033\uFFFD\u0001\u0011\u0013\uFFFD\u004C\uFFFD\u0026\u004C\u0013\u0007\u0067\uFFFD\u0005\u006B\uFFFD\u0040\u003E\uFFFD\u0039\u0010\u0055\uFFFD\uFFFD\u0061\u0056\uFFFD\uFFFD\u0024\uFFFD\uFFFD\uFFFD\uFFFD\u0045\uFFFD\u0026\uFFFD\u0061\uFFFD\uFFFD\uFFFD\uFFFD\u0026\u0001\uFFFD\u0012\u001F\uFFFD\u0035\u002F\uFFFD\u0034\u0069\u0048\u002B\uFFFD\uFFFD\uFFFD\u0049\u005D\uFFFD\u004B\uFFFD\u0726\u0022\u003F\uFFFD\u000B\uFFFD\u004C\uFFFD\uFFFD\u006E\u004E\u0027\uFFFD\uFFFD\u0006\uFFFD\uFFFD\uFFFD\uFFFD\u0000\u0021\u0029\u007A\u0076\u005C\uFFFD\u0000\uFFFD\u006C\u0078\u0046\uFFFD\u0064\uFFFD\uFFFD\uFFFD\uFFFD\u0042\u007E\u006F\uFFFD\u0021\u0003\u0027\u0075\u001B\u006B\u0036\u0001\uFFFD\uFFFD\uFFFD\u000D\uFFFD\u0003\u0049\u0035\u007F\uFFFD\uFFFD\uFFFD\uFFFD\u0062\uFFFD\u007D\uFFFD\u0018\u0040\uFFFD\u006F\uFFFD\uFFFD\u002A\uFFFD\uFFFD\u000A\uFFFD\uFFFD\uFFFD\u0013\u0004\u003B\uFFFD\u0010' + ) + t.end() +}) + +test('utf8 replacement chars for anything in the surrogate pair range', function (t) { + t.equal( + new B([ 0xED, 0x9F, 0xBF ]).toString(), + '\uD7FF' + ) + t.equal( + new B([ 0xED, 0xA0, 0x80 ]).toString(), + '\uFFFD\uFFFD\uFFFD' + ) + t.equal( + new B([ 0xED, 0xBE, 0x8B ]).toString(), + '\uFFFD\uFFFD\uFFFD' + ) + t.equal( + new B([ 0xED, 0xBF, 0xBF ]).toString(), + '\uFFFD\uFFFD\uFFFD' + ) + t.equal( + new B([ 0xEE, 0x80, 0x80 ]).toString(), + '\uE000' + ) + t.end() +}) + +test('utf8 don\'t replace the replacement char', function (t) { + t.equal( + new B('\uFFFD').toString(), + '\uFFFD' + ) + t.end() +}) diff --git a/node_modules/buffer/test/write.js b/node_modules/buffer/test/write.js new file mode 100644 index 0000000..5841806 --- /dev/null +++ b/node_modules/buffer/test/write.js @@ -0,0 +1,131 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') +var isnan = require('is-nan') + +test('buffer.write string should get parsed as number', function (t) { + var b = new B(64) + b.writeUInt16LE('1003', 0) + t.equal(b.readUInt16LE(0), 1003) + t.end() +}) + +test('buffer.writeUInt8 a fractional number will get Math.floored', function (t) { + // Some extra work is necessary to make this test pass with the Object implementation + + var b = new B(1) + b.writeInt8(5.5, 0) + t.equal(b[0], 5) + t.end() +}) + +test('writeUint8 with a negative number throws', function (t) { + var buf = new B(1) + + t.throws(function () { + buf.writeUInt8(-3, 0) + }) + + t.end() +}) + +test('hex of write{Uint,Int}{8,16,32}{LE,BE}', function (t) { + t.plan(2 * (2 * 2 * 2 + 2)) + var hex = [ + '03', '0300', '0003', '03000000', '00000003', + 'fd', 'fdff', 'fffd', 'fdffffff', 'fffffffd' + ] + var reads = [ 3, 3, 3, 3, 3, -3, -3, -3, -3, -3 ] + var xs = ['UInt', 'Int'] + var ys = [8, 16, 32] + for (var i = 0; i < xs.length; i++) { + var x = xs[i] + for (var j = 0; j < ys.length; j++) { + var y = ys[j] + var endianesses = (y === 8) ? [''] : ['LE', 'BE'] + for (var k = 0; k < endianesses.length; k++) { + var z = endianesses[k] + + var v1 = new B(y / 8) + var writefn = 'write' + x + y + z + var val = (x === 'Int') ? -3 : 3 + v1[writefn](val, 0) + t.equal( + v1.toString('hex'), + hex.shift() + ) + var readfn = 'read' + x + y + z + t.equal( + v1[readfn](0), + reads.shift() + ) + } + } + } + t.end() +}) + +test('hex of write{Uint,Int}{8,16,32}{LE,BE} with overflow', function (t) { + if (!B.TYPED_ARRAY_SUPPORT) { + t.pass('object impl: skipping overflow test') + t.end() + return + } + + t.plan(3 * (2 * 2 * 2 + 2)) + var hex = [ + '', '03', '00', '030000', '000000', + '', 'fd', 'ff', 'fdffff', 'ffffff' + ] + var reads = [ + undefined, 3, 0, NaN, 0, + undefined, 253, -256, 16777213, -256 + ] + var xs = ['UInt', 'Int'] + var ys = [8, 16, 32] + for (var i = 0; i < xs.length; i++) { + var x = xs[i] + for (var j = 0; j < ys.length; j++) { + var y = ys[j] + var endianesses = (y === 8) ? [''] : ['LE', 'BE'] + for (var k = 0; k < endianesses.length; k++) { + var z = endianesses[k] + + var v1 = new B(y / 8 - 1) + var next = new B(4) + next.writeUInt32BE(0, 0) + var writefn = 'write' + x + y + z + var val = (x === 'Int') ? -3 : 3 + v1[writefn](val, 0, true) + t.equal( + v1.toString('hex'), + hex.shift() + ) + // check that nothing leaked to next buffer. + t.equal(next.readUInt32BE(0), 0) + // check that no bytes are read from next buffer. + next.writeInt32BE(~0, 0) + var readfn = 'read' + x + y + z + var r = reads.shift() + if (isnan(r)) t.pass('equal') + else t.equal(v1[readfn](0, true), r) + } + } + } + t.end() +}) +test('large values do not improperly roll over (ref #80)', function (t) { + var nums = [-25589992, -633756690, -898146932] + var out = new B(12) + out.fill(0) + out.writeInt32BE(nums[0], 0) + var newNum = out.readInt32BE(0) + t.equal(nums[0], newNum) + out.writeInt32BE(nums[1], 4) + newNum = out.readInt32BE(4) + t.equal(nums[1], newNum) + out.writeInt32BE(nums[2], 8) + newNum = out.readInt32BE(8) + t.equal(nums[2], newNum) + t.end() +}) diff --git a/node_modules/buffer/test/write_infinity.js b/node_modules/buffer/test/write_infinity.js new file mode 100644 index 0000000..17d606a --- /dev/null +++ b/node_modules/buffer/test/write_infinity.js @@ -0,0 +1,45 @@ +if (process.env.OBJECT_IMPL) global.TYPED_ARRAY_SUPPORT = false +var B = require('../').Buffer +var test = require('tape') + +test('write/read Infinity as a float', function (t) { + var buf = new B(4) + t.equal(buf.writeFloatBE(Infinity, 0), 4) + t.equal(buf.readFloatBE(0), Infinity) + t.end() +}) + +test('write/read -Infinity as a float', function (t) { + var buf = new B(4) + t.equal(buf.writeFloatBE(-Infinity, 0), 4) + t.equal(buf.readFloatBE(0), -Infinity) + t.end() +}) + +test('write/read Infinity as a double', function (t) { + var buf = new B(8) + t.equal(buf.writeDoubleBE(Infinity, 0), 8) + t.equal(buf.readDoubleBE(0), Infinity) + t.end() +}) + +test('write/read -Infinity as a double', function (t) { + var buf = new B(8) + t.equal(buf.writeDoubleBE(-Infinity, 0), 8) + t.equal(buf.readDoubleBE(0), -Infinity) + t.end() +}) + +test('write/read float greater than max', function (t) { + var buf = new B(4) + t.equal(buf.writeFloatBE(4e38, 0), 4) + t.equal(buf.readFloatBE(0), Infinity) + t.end() +}) + +test('write/read float less than min', function (t) { + var buf = new B(4) + t.equal(buf.writeFloatBE(-4e40, 0), 4) + t.equal(buf.readFloatBE(0), -Infinity) + t.end() +}) diff --git a/node_modules/dotenv/CHANGELOG.md b/node_modules/dotenv/CHANGELOG.md new file mode 100644 index 0000000..0626508 --- /dev/null +++ b/node_modules/dotenv/CHANGELOG.md @@ -0,0 +1,144 @@ +# Change Log + +All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. + +# [8.0.0](https://github.com/motdotla/dotenv/compare/v7.0.0...v8.0.0) (2019-05-02) + +- Drop support for Node v6 (#392) ([2e9636a](https://github.com/motdotla/dotenv/commit/2e9636a)), closes [#392](https://github.com/motdotla/dotenv/issues/392) + +### BREAKING CHANGES + +- dropping Node v6 support because end-of-life + +## [7.0.0] - 2019-03-12 + +### Fixed + +- Fix removing unbalanced quotes ([#376](https://github.com/motdotla/dotenv/pull/376)) + +### Removed + +- Removed `load` alias for `config` for consistency throughout code and documentation. + +## [6.2.0] - 2018-12-03 + +### Added + +- Support preload configuration via environment variables ([#351](https://github.com/motdotla/dotenv/issues/351)) + +## [6.1.0] - 2018-10-08 + +### Added + +- `debug` option for `config` and `parse` methods will turn on logging + +## [6.0.0] - 2018-06-02 + +### Changed + +- _Breaking:_ drop support for Node v4 ([#304](https://github.com/motdotla/dotenv/pull/304)) + +## [5.0.0] - 2018-01-29 + +### Added + +- Testing against Node v8 and v9 +- Documentation on trim behavior of values +- Documentation on how to use with `import` + +### Changed + +- _Breaking_: default `path` is now `path.resolve(process.cwd(), '.env')` +- _Breaking_: does not write over keys already in `process.env` if the key has a falsy value +- using `const` and `let` instead of `var` + +### Removed + +- Testing against Node v7 + +## [4.0.0] - 2016-12-23 + +### Changed + +- Return Object with parsed content or error instead of false ([#165](https://github.com/motdotla/dotenv/pull/165)). + +### Removed + +- `verbose` option removed in favor of returning result. + +## [3.0.0] - 2016-12-20 + +### Added + +- `verbose` option will log any error messages. Off by default. +- parses email addresses correctly +- allow importing config method directly in ES6 + +### Changed + +- Suppress error messages by default ([#154](https://github.com/motdotla/dotenv/pull/154)) +- Ignoring more files for NPM to make package download smaller + +### Fixed + +- False positive test due to case-sensitive variable ([#124](https://github.com/motdotla/dotenv/pull/124)) + +### Removed + +- `silent` option removed in favor of `verbose` + +## [2.0.0] - 2016-01-20 + +### Added + +- CHANGELOG to ["make it easier for users and contributors to see precisely what notable changes have been made between each release"](http://keepachangelog.com/). Linked to from README +- LICENSE to be more explicit about what was defined in `package.json`. Linked to from README +- Testing nodejs v4 on travis-ci +- added examples of how to use dotenv in different ways +- return parsed object on success rather than boolean true + +### Changed + +- README has shorter description not referencing ruby gem since we don't have or want feature parity + +### Removed + +- Variable expansion and escaping so environment variables are encouraged to be fully orthogonal + +## [1.2.0] - 2015-06-20 + +### Added + +- Preload hook to require dotenv without including it in your code + +### Changed + +- clarified license to be "BSD-2-Clause" in `package.json` + +### Fixed + +- retain spaces in string vars + +## [1.1.0] - 2015-03-31 + +### Added + +- Silent option to silence `console.log` when `.env` missing + +## [1.0.0] - 2015-03-13 + +### Removed + +- support for multiple `.env` files. should always use one `.env` file for the current environment + +[7.0.0]: https://github.com/motdotla/dotenv/compare/v6.2.0...v7.0.0 +[6.2.0]: https://github.com/motdotla/dotenv/compare/v6.1.0...v6.2.0 +[6.1.0]: https://github.com/motdotla/dotenv/compare/v6.0.0...v6.1.0 +[6.0.0]: https://github.com/motdotla/dotenv/compare/v5.0.0...v6.0.0 +[5.0.0]: https://github.com/motdotla/dotenv/compare/v4.0.0...v5.0.0 +[4.0.0]: https://github.com/motdotla/dotenv/compare/v3.0.0...v4.0.0 +[3.0.0]: https://github.com/motdotla/dotenv/compare/v2.0.0...v3.0.0 +[2.0.0]: https://github.com/motdotla/dotenv/compare/v1.2.0...v2.0.0 +[1.2.0]: https://github.com/motdotla/dotenv/compare/v1.1.0...v1.2.0 +[1.1.0]: https://github.com/motdotla/dotenv/compare/v1.0.0...v1.1.0 +[1.0.0]: https://github.com/motdotla/dotenv/compare/v0.4.0...v1.0.0 diff --git a/node_modules/dotenv/LICENSE b/node_modules/dotenv/LICENSE new file mode 100644 index 0000000..c430ad8 --- /dev/null +++ b/node_modules/dotenv/LICENSE @@ -0,0 +1,23 @@ +Copyright (c) 2015, Scott Motte +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/node_modules/dotenv/README.md b/node_modules/dotenv/README.md new file mode 100644 index 0000000..daa5e87 --- /dev/null +++ b/node_modules/dotenv/README.md @@ -0,0 +1,271 @@ +# dotenv + +dotenv + +Dotenv is a zero-dependency module that loads environment variables from a `.env` file into [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env). Storing configuration in the environment separate from code is based on [The Twelve-Factor App](http://12factor.net/config) methodology. + +[![BuildStatus](https://img.shields.io/travis/motdotla/dotenv/master.svg?style=flat-square)](https://travis-ci.org/motdotla/dotenv) +[![Build status](https://ci.appveyor.com/api/projects/status/github/motdotla/dotenv?svg=true)](https://ci.appveyor.com/project/motdotla/dotenv/branch/master) +[![NPM version](https://img.shields.io/npm/v/dotenv.svg?style=flat-square)](https://www.npmjs.com/package/dotenv) +[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard) +[![Coverage Status](https://img.shields.io/coveralls/motdotla/dotenv/master.svg?style=flat-square)](https://coveralls.io/github/motdotla/dotenv?branch=coverall-intergration) +[![LICENSE](https://img.shields.io/github/license/motdotla/dotenv.svg)](LICENSE) +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) + +## Install + +```bash +# with npm +npm install dotenv + +# or with Yarn +yarn add dotenv +``` + +## Usage + +As early as possible in your application, require and configure dotenv. + +```javascript +require('dotenv').config() +``` + +Create a `.env` file in the root directory of your project. Add +environment-specific variables on new lines in the form of `NAME=VALUE`. +For example: + +```dosini +DB_HOST=localhost +DB_USER=root +DB_PASS=s1mpl3 +``` + +`process.env` now has the keys and values you defined in your `.env` file. + +```javascript +const db = require('db') +db.connect({ + host: process.env.DB_HOST, + username: process.env.DB_USER, + password: process.env.DB_PASS +}) +``` + +### Preload + +You can use the `--require` (`-r`) [command line option](https://nodejs.org/api/cli.html#cli_r_require_module) to preload dotenv. By doing this, you do not need to require and load dotenv in your application code. This is the preferred approach when using `import` instead of `require`. + +```bash +$ node -r dotenv/config your_script.js +``` + +The configuration options below are supported as command line arguments in the format `dotenv_config_
+
+

JSONPath Online Evaluator

+
+

Author: Kazuki Hamasaki [ashphy@ashphy.com]

+

This evaluator uses JSONPath - XPath for JSON

+
+
+
+
+

Inputs

+
+ + + Example '$.phoneNumbers[*].type' See also JSONPath expressions + + +
+
+
+

Evaluation Results

+ 
false
+
+
+
+ + + + + + + + + + + + diff --git a/node_modules/jmespath/james.html b/node_modules/jmespath/james.html new file mode 100644 index 0000000..be8d3ab --- /dev/null +++ b/node_modules/jmespath/james.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/node_modules/jmespath/jmespath.js b/node_modules/jmespath/jmespath.js new file mode 100644 index 0000000..f59e8e4 --- /dev/null +++ b/node_modules/jmespath/jmespath.js @@ -0,0 +1,1667 @@ +(function(exports) { + "use strict"; + + function isArray(obj) { + if (obj !== null) { + return Object.prototype.toString.call(obj) === "[object Array]"; + } else { + return false; + } + } + + function isObject(obj) { + if (obj !== null) { + return Object.prototype.toString.call(obj) === "[object Object]"; + } else { + return false; + } + } + + function strictDeepEqual(first, second) { + // Check the scalar case first. + if (first === second) { + return true; + } + + // Check if they are the same type. + var firstType = Object.prototype.toString.call(first); + if (firstType !== Object.prototype.toString.call(second)) { + return false; + } + // We know that first and second have the same type so we can just check the + // first type from now on. + if (isArray(first) === true) { + // Short circuit if they're not the same length; + if (first.length !== second.length) { + return false; + } + for (var i = 0; i < first.length; i++) { + if (strictDeepEqual(first[i], second[i]) === false) { + return false; + } + } + return true; + } + if (isObject(first) === true) { + // An object is equal if it has the same key/value pairs. + var keysSeen = {}; + for (var key in first) { + if (hasOwnProperty.call(first, key)) { + if (strictDeepEqual(first[key], second[key]) === false) { + return false; + } + keysSeen[key] = true; + } + } + // Now check that there aren't any keys in second that weren't + // in first. + for (var key2 in second) { + if (hasOwnProperty.call(second, key2)) { + if (keysSeen[key2] !== true) { + return false; + } + } + } + return true; + } + return false; + } + + function isFalse(obj) { + // From the spec: + // A false value corresponds to the following values: + // Empty list + // Empty object + // Empty string + // False boolean + // null value + + // First check the scalar values. + if (obj === "" || obj === false || obj === null) { + return true; + } else if (isArray(obj) && obj.length === 0) { + // Check for an empty array. + return true; + } else if (isObject(obj)) { + // Check for an empty object. + for (var key in obj) { + // If there are any keys, then + // the object is not empty so the object + // is not false. + if (obj.hasOwnProperty(key)) { + return false; + } + } + return true; + } else { + return false; + } + } + + function objValues(obj) { + var keys = Object.keys(obj); + var values = []; + for (var i = 0; i < keys.length; i++) { + values.push(obj[keys[i]]); + } + return values; + } + + function merge(a, b) { + var merged = {}; + for (var key in a) { + merged[key] = a[key]; + } + for (var key2 in b) { + merged[key2] = b[key2]; + } + return merged; + } + + var trimLeft; + if (typeof String.prototype.trimLeft === "function") { + trimLeft = function(str) { + return str.trimLeft(); + }; + } else { + trimLeft = function(str) { + return str.match(/^\s*(.*)/)[1]; + }; + } + + // Type constants used to define functions. + var TYPE_NUMBER = 0; + var TYPE_ANY = 1; + var TYPE_STRING = 2; + var TYPE_ARRAY = 3; + var TYPE_OBJECT = 4; + var TYPE_BOOLEAN = 5; + var TYPE_EXPREF = 6; + var TYPE_NULL = 7; + var TYPE_ARRAY_NUMBER = 8; + var TYPE_ARRAY_STRING = 9; + + var TOK_EOF = "EOF"; + var TOK_UNQUOTEDIDENTIFIER = "UnquotedIdentifier"; + var TOK_QUOTEDIDENTIFIER = "QuotedIdentifier"; + var TOK_RBRACKET = "Rbracket"; + var TOK_RPAREN = "Rparen"; + var TOK_COMMA = "Comma"; + var TOK_COLON = "Colon"; + var TOK_RBRACE = "Rbrace"; + var TOK_NUMBER = "Number"; + var TOK_CURRENT = "Current"; + var TOK_EXPREF = "Expref"; + var TOK_PIPE = "Pipe"; + var TOK_OR = "Or"; + var TOK_AND = "And"; + var TOK_EQ = "EQ"; + var TOK_GT = "GT"; + var TOK_LT = "LT"; + var TOK_GTE = "GTE"; + var TOK_LTE = "LTE"; + var TOK_NE = "NE"; + var TOK_FLATTEN = "Flatten"; + var TOK_STAR = "Star"; + var TOK_FILTER = "Filter"; + var TOK_DOT = "Dot"; + var TOK_NOT = "Not"; + var TOK_LBRACE = "Lbrace"; + var TOK_LBRACKET = "Lbracket"; + var TOK_LPAREN= "Lparen"; + var TOK_LITERAL= "Literal"; + + // The "&", "[", "<", ">" tokens + // are not in basicToken because + // there are two token variants + // ("&&", "[?", "<=", ">="). This is specially handled + // below. + + var basicTokens = { + ".": TOK_DOT, + "*": TOK_STAR, + ",": TOK_COMMA, + ":": TOK_COLON, + "{": TOK_LBRACE, + "}": TOK_RBRACE, + "]": TOK_RBRACKET, + "(": TOK_LPAREN, + ")": TOK_RPAREN, + "@": TOK_CURRENT + }; + + var operatorStartToken = { + "<": true, + ">": true, + "=": true, + "!": true + }; + + var skipChars = { + " ": true, + "\t": true, + "\n": true + }; + + + function isAlpha(ch) { + return (ch >= "a" && ch <= "z") || + (ch >= "A" && ch <= "Z") || + ch === "_"; + } + + function isNum(ch) { + return (ch >= "0" && ch <= "9") || + ch === "-"; + } + function isAlphaNum(ch) { + return (ch >= "a" && ch <= "z") || + (ch >= "A" && ch <= "Z") || + (ch >= "0" && ch <= "9") || + ch === "_"; + } + + function Lexer() { + } + Lexer.prototype = { + tokenize: function(stream) { + var tokens = []; + this._current = 0; + var start; + var identifier; + var token; + while (this._current < stream.length) { + if (isAlpha(stream[this._current])) { + start = this._current; + identifier = this._consumeUnquotedIdentifier(stream); + tokens.push({type: TOK_UNQUOTEDIDENTIFIER, + value: identifier, + start: start}); + } else if (basicTokens[stream[this._current]] !== undefined) { + tokens.push({type: basicTokens[stream[this._current]], + value: stream[this._current], + start: this._current}); + this._current++; + } else if (isNum(stream[this._current])) { + token = this._consumeNumber(stream); + tokens.push(token); + } else if (stream[this._current] === "[") { + // No need to increment this._current. This happens + // in _consumeLBracket + token = this._consumeLBracket(stream); + tokens.push(token); + } else if (stream[this._current] === "\"") { + start = this._current; + identifier = this._consumeQuotedIdentifier(stream); + tokens.push({type: TOK_QUOTEDIDENTIFIER, + value: identifier, + start: start}); + } else if (stream[this._current] === "'") { + start = this._current; + identifier = this._consumeRawStringLiteral(stream); + tokens.push({type: TOK_LITERAL, + value: identifier, + start: start}); + } else if (stream[this._current] === "`") { + start = this._current; + var literal = this._consumeLiteral(stream); + tokens.push({type: TOK_LITERAL, + value: literal, + start: start}); + } else if (operatorStartToken[stream[this._current]] !== undefined) { + tokens.push(this._consumeOperator(stream)); + } else if (skipChars[stream[this._current]] !== undefined) { + // Ignore whitespace. + this._current++; + } else if (stream[this._current] === "&") { + start = this._current; + this._current++; + if (stream[this._current] === "&") { + this._current++; + tokens.push({type: TOK_AND, value: "&&", start: start}); + } else { + tokens.push({type: TOK_EXPREF, value: "&", start: start}); + } + } else if (stream[this._current] === "|") { + start = this._current; + this._current++; + if (stream[this._current] === "|") { + this._current++; + tokens.push({type: TOK_OR, value: "||", start: start}); + } else { + tokens.push({type: TOK_PIPE, value: "|", start: start}); + } + } else { + var error = new Error("Unknown character:" + stream[this._current]); + error.name = "LexerError"; + throw error; + } + } + return tokens; + }, + + _consumeUnquotedIdentifier: function(stream) { + var start = this._current; + this._current++; + while (this._current < stream.length && isAlphaNum(stream[this._current])) { + this._current++; + } + return stream.slice(start, this._current); + }, + + _consumeQuotedIdentifier: function(stream) { + var start = this._current; + this._current++; + var maxLength = stream.length; + while (stream[this._current] !== "\"" && this._current < maxLength) { + // You can escape a double quote and you can escape an escape. + var current = this._current; + if (stream[current] === "\\" && (stream[current + 1] === "\\" || + stream[current + 1] === "\"")) { + current += 2; + } else { + current++; + } + this._current = current; + } + this._current++; + return JSON.parse(stream.slice(start, this._current)); + }, + + _consumeRawStringLiteral: function(stream) { + var start = this._current; + this._current++; + var maxLength = stream.length; + while (stream[this._current] !== "'" && this._current < maxLength) { + // You can escape a single quote and you can escape an escape. + var current = this._current; + if (stream[current] === "\\" && (stream[current + 1] === "\\" || + stream[current + 1] === "'")) { + current += 2; + } else { + current++; + } + this._current = current; + } + this._current++; + var literal = stream.slice(start + 1, this._current - 1); + return literal.replace("\\'", "'"); + }, + + _consumeNumber: function(stream) { + var start = this._current; + this._current++; + var maxLength = stream.length; + while (isNum(stream[this._current]) && this._current < maxLength) { + this._current++; + } + var value = parseInt(stream.slice(start, this._current)); + return {type: TOK_NUMBER, value: value, start: start}; + }, + + _consumeLBracket: function(stream) { + var start = this._current; + this._current++; + if (stream[this._current] === "?") { + this._current++; + return {type: TOK_FILTER, value: "[?", start: start}; + } else if (stream[this._current] === "]") { + this._current++; + return {type: TOK_FLATTEN, value: "[]", start: start}; + } else { + return {type: TOK_LBRACKET, value: "[", start: start}; + } + }, + + _consumeOperator: function(stream) { + var start = this._current; + var startingChar = stream[start]; + this._current++; + if (startingChar === "!") { + if (stream[this._current] === "=") { + this._current++; + return {type: TOK_NE, value: "!=", start: start}; + } else { + return {type: TOK_NOT, value: "!", start: start}; + } + } else if (startingChar === "<") { + if (stream[this._current] === "=") { + this._current++; + return {type: TOK_LTE, value: "<=", start: start}; + } else { + return {type: TOK_LT, value: "<", start: start}; + } + } else if (startingChar === ">") { + if (stream[this._current] === "=") { + this._current++; + return {type: TOK_GTE, value: ">=", start: start}; + } else { + return {type: TOK_GT, value: ">", start: start}; + } + } else if (startingChar === "=") { + if (stream[this._current] === "=") { + this._current++; + return {type: TOK_EQ, value: "==", start: start}; + } + } + }, + + _consumeLiteral: function(stream) { + this._current++; + var start = this._current; + var maxLength = stream.length; + var literal; + while(stream[this._current] !== "`" && this._current < maxLength) { + // You can escape a literal char or you can escape the escape. + var current = this._current; + if (stream[current] === "\\" && (stream[current + 1] === "\\" || + stream[current + 1] === "`")) { + current += 2; + } else { + current++; + } + this._current = current; + } + var literalString = trimLeft(stream.slice(start, this._current)); + literalString = literalString.replace("\\`", "`"); + if (this._looksLikeJSON(literalString)) { + literal = JSON.parse(literalString); + } else { + // Try to JSON parse it as "" + literal = JSON.parse("\"" + literalString + "\""); + } + // +1 gets us to the ending "`", +1 to move on to the next char. + this._current++; + return literal; + }, + + _looksLikeJSON: function(literalString) { + var startingChars = "[{\""; + var jsonLiterals = ["true", "false", "null"]; + var numberLooking = "-0123456789"; + + if (literalString === "") { + return false; + } else if (startingChars.indexOf(literalString[0]) >= 0) { + return true; + } else if (jsonLiterals.indexOf(literalString) >= 0) { + return true; + } else if (numberLooking.indexOf(literalString[0]) >= 0) { + try { + JSON.parse(literalString); + return true; + } catch (ex) { + return false; + } + } else { + return false; + } + } + }; + + var bindingPower = {}; + bindingPower[TOK_EOF] = 0; + bindingPower[TOK_UNQUOTEDIDENTIFIER] = 0; + bindingPower[TOK_QUOTEDIDENTIFIER] = 0; + bindingPower[TOK_RBRACKET] = 0; + bindingPower[TOK_RPAREN] = 0; + bindingPower[TOK_COMMA] = 0; + bindingPower[TOK_RBRACE] = 0; + bindingPower[TOK_NUMBER] = 0; + bindingPower[TOK_CURRENT] = 0; + bindingPower[TOK_EXPREF] = 0; + bindingPower[TOK_PIPE] = 1; + bindingPower[TOK_OR] = 2; + bindingPower[TOK_AND] = 3; + bindingPower[TOK_EQ] = 5; + bindingPower[TOK_GT] = 5; + bindingPower[TOK_LT] = 5; + bindingPower[TOK_GTE] = 5; + bindingPower[TOK_LTE] = 5; + bindingPower[TOK_NE] = 5; + bindingPower[TOK_FLATTEN] = 9; + bindingPower[TOK_STAR] = 20; + bindingPower[TOK_FILTER] = 21; + bindingPower[TOK_DOT] = 40; + bindingPower[TOK_NOT] = 45; + bindingPower[TOK_LBRACE] = 50; + bindingPower[TOK_LBRACKET] = 55; + bindingPower[TOK_LPAREN] = 60; + + function Parser() { + } + + Parser.prototype = { + parse: function(expression) { + this._loadTokens(expression); + this.index = 0; + var ast = this.expression(0); + if (this._lookahead(0) !== TOK_EOF) { + var t = this._lookaheadToken(0); + var error = new Error( + "Unexpected token type: " + t.type + ", value: " + t.value); + error.name = "ParserError"; + throw error; + } + return ast; + }, + + _loadTokens: function(expression) { + var lexer = new Lexer(); + var tokens = lexer.tokenize(expression); + tokens.push({type: TOK_EOF, value: "", start: expression.length}); + this.tokens = tokens; + }, + + expression: function(rbp) { + var leftToken = this._lookaheadToken(0); + this._advance(); + var left = this.nud(leftToken); + var currentToken = this._lookahead(0); + while (rbp < bindingPower[currentToken]) { + this._advance(); + left = this.led(currentToken, left); + currentToken = this._lookahead(0); + } + return left; + }, + + _lookahead: function(number) { + return this.tokens[this.index + number].type; + }, + + _lookaheadToken: function(number) { + return this.tokens[this.index + number]; + }, + + _advance: function() { + this.index++; + }, + + nud: function(token) { + var left; + var right; + var expression; + switch (token.type) { + case TOK_LITERAL: + return {type: "Literal", value: token.value}; + case TOK_UNQUOTEDIDENTIFIER: + return {type: "Field", name: token.value}; + case TOK_QUOTEDIDENTIFIER: + var node = {type: "Field", name: token.value}; + if (this._lookahead(0) === TOK_LPAREN) { + throw new Error("Quoted identifier not allowed for function names."); + } else { + return node; + } + break; + case TOK_NOT: + right = this.expression(bindingPower.Not); + return {type: "NotExpression", children: [right]}; + case TOK_STAR: + left = {type: "Identity"}; + right = null; + if (this._lookahead(0) === TOK_RBRACKET) { + // This can happen in a multiselect, + // [a, b, *] + right = {type: "Identity"}; + } else { + right = this._parseProjectionRHS(bindingPower.Star); + } + return {type: "ValueProjection", children: [left, right]}; + case TOK_FILTER: + return this.led(token.type, {type: "Identity"}); + case TOK_LBRACE: + return this._parseMultiselectHash(); + case TOK_FLATTEN: + left = {type: TOK_FLATTEN, children: [{type: "Identity"}]}; + right = this._parseProjectionRHS(bindingPower.Flatten); + return {type: "Projection", children: [left, right]}; + case TOK_LBRACKET: + if (this._lookahead(0) === TOK_NUMBER || this._lookahead(0) === TOK_COLON) { + right = this._parseIndexExpression(); + return this._projectIfSlice({type: "Identity"}, right); + } else if (this._lookahead(0) === TOK_STAR && + this._lookahead(1) === TOK_RBRACKET) { + this._advance(); + this._advance(); + right = this._parseProjectionRHS(bindingPower.Star); + return {type: "Projection", + children: [{type: "Identity"}, right]}; + } else { + return this._parseMultiselectList(); + } + break; + case TOK_CURRENT: + return {type: TOK_CURRENT}; + case TOK_EXPREF: + expression = this.expression(bindingPower.Expref); + return {type: "ExpressionReference", children: [expression]}; + case TOK_LPAREN: + var args = []; + while (this._lookahead(0) !== TOK_RPAREN) { + if (this._lookahead(0) === TOK_CURRENT) { + expression = {type: TOK_CURRENT}; + this._advance(); + } else { + expression = this.expression(0); + } + args.push(expression); + } + this._match(TOK_RPAREN); + return args[0]; + default: + this._errorToken(token); + } + }, + + led: function(tokenName, left) { + var right; + switch(tokenName) { + case TOK_DOT: + var rbp = bindingPower.Dot; + if (this._lookahead(0) !== TOK_STAR) { + right = this._parseDotRHS(rbp); + return {type: "Subexpression", children: [left, right]}; + } else { + // Creating a projection. + this._advance(); + right = this._parseProjectionRHS(rbp); + return {type: "ValueProjection", children: [left, right]}; + } + break; + case TOK_PIPE: + right = this.expression(bindingPower.Pipe); + return {type: TOK_PIPE, children: [left, right]}; + case TOK_OR: + right = this.expression(bindingPower.Or); + return {type: "OrExpression", children: [left, right]}; + case TOK_AND: + right = this.expression(bindingPower.And); + return {type: "AndExpression", children: [left, right]}; + case TOK_LPAREN: + var name = left.name; + var args = []; + var expression, node; + while (this._lookahead(0) !== TOK_RPAREN) { + if (this._lookahead(0) === TOK_CURRENT) { + expression = {type: TOK_CURRENT}; + this._advance(); + } else { + expression = this.expression(0); + } + if (this._lookahead(0) === TOK_COMMA) { + this._match(TOK_COMMA); + } + args.push(expression); + } + this._match(TOK_RPAREN); + node = {type: "Function", name: name, children: args}; + return node; + case TOK_FILTER: + var condition = this.expression(0); + this._match(TOK_RBRACKET); + if (this._lookahead(0) === TOK_FLATTEN) { + right = {type: "Identity"}; + } else { + right = this._parseProjectionRHS(bindingPower.Filter); + } + return {type: "FilterProjection", children: [left, right, condition]}; + case TOK_FLATTEN: + var leftNode = {type: TOK_FLATTEN, children: [left]}; + var rightNode = this._parseProjectionRHS(bindingPower.Flatten); + return {type: "Projection", children: [leftNode, rightNode]}; + case TOK_EQ: + case TOK_NE: + case TOK_GT: + case TOK_GTE: + case TOK_LT: + case TOK_LTE: + return this._parseComparator(left, tokenName); + case TOK_LBRACKET: + var token = this._lookaheadToken(0); + if (token.type === TOK_NUMBER || token.type === TOK_COLON) { + right = this._parseIndexExpression(); + return this._projectIfSlice(left, right); + } else { + this._match(TOK_STAR); + this._match(TOK_RBRACKET); + right = this._parseProjectionRHS(bindingPower.Star); + return {type: "Projection", children: [left, right]}; + } + break; + default: + this._errorToken(this._lookaheadToken(0)); + } + }, + + _match: function(tokenType) { + if (this._lookahead(0) === tokenType) { + this._advance(); + } else { + var t = this._lookaheadToken(0); + var error = new Error("Expected " + tokenType + ", got: " + t.type); + error.name = "ParserError"; + throw error; + } + }, + + _errorToken: function(token) { + var error = new Error("Invalid token (" + + token.type + "): \"" + + token.value + "\""); + error.name = "ParserError"; + throw error; + }, + + + _parseIndexExpression: function() { + if (this._lookahead(0) === TOK_COLON || this._lookahead(1) === TOK_COLON) { + return this._parseSliceExpression(); + } else { + var node = { + type: "Index", + value: this._lookaheadToken(0).value}; + this._advance(); + this._match(TOK_RBRACKET); + return node; + } + }, + + _projectIfSlice: function(left, right) { + var indexExpr = {type: "IndexExpression", children: [left, right]}; + if (right.type === "Slice") { + return { + type: "Projection", + children: [indexExpr, this._parseProjectionRHS(bindingPower.Star)] + }; + } else { + return indexExpr; + } + }, + + _parseSliceExpression: function() { + // [start:end:step] where each part is optional, as well as the last + // colon. + var parts = [null, null, null]; + var index = 0; + var currentToken = this._lookahead(0); + while (currentToken !== TOK_RBRACKET && index < 3) { + if (currentToken === TOK_COLON) { + index++; + this._advance(); + } else if (currentToken === TOK_NUMBER) { + parts[index] = this._lookaheadToken(0).value; + this._advance(); + } else { + var t = this._lookahead(0); + var error = new Error("Syntax error, unexpected token: " + + t.value + "(" + t.type + ")"); + error.name = "Parsererror"; + throw error; + } + currentToken = this._lookahead(0); + } + this._match(TOK_RBRACKET); + return { + type: "Slice", + children: parts + }; + }, + + _parseComparator: function(left, comparator) { + var right = this.expression(bindingPower[comparator]); + return {type: "Comparator", name: comparator, children: [left, right]}; + }, + + _parseDotRHS: function(rbp) { + var lookahead = this._lookahead(0); + var exprTokens = [TOK_UNQUOTEDIDENTIFIER, TOK_QUOTEDIDENTIFIER, TOK_STAR]; + if (exprTokens.indexOf(lookahead) >= 0) { + return this.expression(rbp); + } else if (lookahead === TOK_LBRACKET) { + this._match(TOK_LBRACKET); + return this._parseMultiselectList(); + } else if (lookahead === TOK_LBRACE) { + this._match(TOK_LBRACE); + return this._parseMultiselectHash(); + } + }, + + _parseProjectionRHS: function(rbp) { + var right; + if (bindingPower[this._lookahead(0)] < 10) { + right = {type: "Identity"}; + } else if (this._lookahead(0) === TOK_LBRACKET) { + right = this.expression(rbp); + } else if (this._lookahead(0) === TOK_FILTER) { + right = this.expression(rbp); + } else if (this._lookahead(0) === TOK_DOT) { + this._match(TOK_DOT); + right = this._parseDotRHS(rbp); + } else { + var t = this._lookaheadToken(0); + var error = new Error("Sytanx error, unexpected token: " + + t.value + "(" + t.type + ")"); + error.name = "ParserError"; + throw error; + } + return right; + }, + + _parseMultiselectList: function() { + var expressions = []; + while (this._lookahead(0) !== TOK_RBRACKET) { + var expression = this.expression(0); + expressions.push(expression); + if (this._lookahead(0) === TOK_COMMA) { + this._match(TOK_COMMA); + if (this._lookahead(0) === TOK_RBRACKET) { + throw new Error("Unexpected token Rbracket"); + } + } + } + this._match(TOK_RBRACKET); + return {type: "MultiSelectList", children: expressions}; + }, + + _parseMultiselectHash: function() { + var pairs = []; + var identifierTypes = [TOK_UNQUOTEDIDENTIFIER, TOK_QUOTEDIDENTIFIER]; + var keyToken, keyName, value, node; + for (;;) { + keyToken = this._lookaheadToken(0); + if (identifierTypes.indexOf(keyToken.type) < 0) { + throw new Error("Expecting an identifier token, got: " + + keyToken.type); + } + keyName = keyToken.value; + this._advance(); + this._match(TOK_COLON); + value = this.expression(0); + node = {type: "KeyValuePair", name: keyName, value: value}; + pairs.push(node); + if (this._lookahead(0) === TOK_COMMA) { + this._match(TOK_COMMA); + } else if (this._lookahead(0) === TOK_RBRACE) { + this._match(TOK_RBRACE); + break; + } + } + return {type: "MultiSelectHash", children: pairs}; + } + }; + + + function TreeInterpreter(runtime) { + this.runtime = runtime; + } + + TreeInterpreter.prototype = { + search: function(node, value) { + return this.visit(node, value); + }, + + visit: function(node, value) { + var matched, current, result, first, second, field, left, right, collected, i; + switch (node.type) { + case "Field": + if (value === null ) { + return null; + } else if (isObject(value)) { + field = value[node.name]; + if (field === undefined) { + return null; + } else { + return field; + } + } else { + return null; + } + break; + case "Subexpression": + result = this.visit(node.children[0], value); + for (i = 1; i < node.children.length; i++) { + result = this.visit(node.children[1], result); + if (result === null) { + return null; + } + } + return result; + case "IndexExpression": + left = this.visit(node.children[0], value); + right = this.visit(node.children[1], left); + return right; + case "Index": + if (!isArray(value)) { + return null; + } + var index = node.value; + if (index < 0) { + index = value.length + index; + } + result = value[index]; + if (result === undefined) { + result = null; + } + return result; + case "Slice": + if (!isArray(value)) { + return null; + } + var sliceParams = node.children.slice(0); + var computed = this.computeSliceParams(value.length, sliceParams); + var start = computed[0]; + var stop = computed[1]; + var step = computed[2]; + result = []; + if (step > 0) { + for (i = start; i < stop; i += step) { + result.push(value[i]); + } + } else { + for (i = start; i > stop; i += step) { + result.push(value[i]); + } + } + return result; + case "Projection": + // Evaluate left child. + var base = this.visit(node.children[0], value); + if (!isArray(base)) { + return null; + } + collected = []; + for (i = 0; i < base.length; i++) { + current = this.visit(node.children[1], base[i]); + if (current !== null) { + collected.push(current); + } + } + return collected; + case "ValueProjection": + // Evaluate left child. + base = this.visit(node.children[0], value); + if (!isObject(base)) { + return null; + } + collected = []; + var values = objValues(base); + for (i = 0; i < values.length; i++) { + current = this.visit(node.children[1], values[i]); + if (current !== null) { + collected.push(current); + } + } + return collected; + case "FilterProjection": + base = this.visit(node.children[0], value); + if (!isArray(base)) { + return null; + } + var filtered = []; + var finalResults = []; + for (i = 0; i < base.length; i++) { + matched = this.visit(node.children[2], base[i]); + if (!isFalse(matched)) { + filtered.push(base[i]); + } + } + for (var j = 0; j < filtered.length; j++) { + current = this.visit(node.children[1], filtered[j]); + if (current !== null) { + finalResults.push(current); + } + } + return finalResults; + case "Comparator": + first = this.visit(node.children[0], value); + second = this.visit(node.children[1], value); + switch(node.name) { + case TOK_EQ: + result = strictDeepEqual(first, second); + break; + case TOK_NE: + result = !strictDeepEqual(first, second); + break; + case TOK_GT: + result = first > second; + break; + case TOK_GTE: + result = first >= second; + break; + case TOK_LT: + result = first < second; + break; + case TOK_LTE: + result = first <= second; + break; + default: + throw new Error("Unknown comparator: " + node.name); + } + return result; + case TOK_FLATTEN: + var original = this.visit(node.children[0], value); + if (!isArray(original)) { + return null; + } + var merged = []; + for (i = 0; i < original.length; i++) { + current = original[i]; + if (isArray(current)) { + merged.push.apply(merged, current); + } else { + merged.push(current); + } + } + return merged; + case "Identity": + return value; + case "MultiSelectList": + if (value === null) { + return null; + } + collected = []; + for (i = 0; i < node.children.length; i++) { + collected.push(this.visit(node.children[i], value)); + } + return collected; + case "MultiSelectHash": + if (value === null) { + return null; + } + collected = {}; + var child; + for (i = 0; i < node.children.length; i++) { + child = node.children[i]; + collected[child.name] = this.visit(child.value, value); + } + return collected; + case "OrExpression": + matched = this.visit(node.children[0], value); + if (isFalse(matched)) { + matched = this.visit(node.children[1], value); + } + return matched; + case "AndExpression": + first = this.visit(node.children[0], value); + + if (isFalse(first) === true) { + return first; + } + return this.visit(node.children[1], value); + case "NotExpression": + first = this.visit(node.children[0], value); + return isFalse(first); + case "Literal": + return node.value; + case TOK_PIPE: + left = this.visit(node.children[0], value); + return this.visit(node.children[1], left); + case TOK_CURRENT: + return value; + case "Function": + var resolvedArgs = []; + for (i = 0; i < node.children.length; i++) { + resolvedArgs.push(this.visit(node.children[i], value)); + } + return this.runtime.callFunction(node.name, resolvedArgs); + case "ExpressionReference": + var refNode = node.children[0]; + // Tag the node with a specific attribute so the type + // checker verify the type. + refNode.jmespathType = TOK_EXPREF; + return refNode; + default: + throw new Error("Unknown node type: " + node.type); + } + }, + + computeSliceParams: function(arrayLength, sliceParams) { + var start = sliceParams[0]; + var stop = sliceParams[1]; + var step = sliceParams[2]; + var computed = [null, null, null]; + if (step === null) { + step = 1; + } else if (step === 0) { + var error = new Error("Invalid slice, step cannot be 0"); + error.name = "RuntimeError"; + throw error; + } + var stepValueNegative = step < 0 ? true : false; + + if (start === null) { + start = stepValueNegative ? arrayLength - 1 : 0; + } else { + start = this.capSliceRange(arrayLength, start, step); + } + + if (stop === null) { + stop = stepValueNegative ? -1 : arrayLength; + } else { + stop = this.capSliceRange(arrayLength, stop, step); + } + computed[0] = start; + computed[1] = stop; + computed[2] = step; + return computed; + }, + + capSliceRange: function(arrayLength, actualValue, step) { + if (actualValue < 0) { + actualValue += arrayLength; + if (actualValue < 0) { + actualValue = step < 0 ? -1 : 0; + } + } else if (actualValue >= arrayLength) { + actualValue = step < 0 ? arrayLength - 1 : arrayLength; + } + return actualValue; + } + + }; + + function Runtime(interpreter) { + this._interpreter = interpreter; + this.functionTable = { + // name: [function, ] + // The can be: + // + // { + // args: [[type1, type2], [type1, type2]], + // variadic: true|false + // } + // + // Each arg in the arg list is a list of valid types + // (if the function is overloaded and supports multiple + // types. If the type is "any" then no type checking + // occurs on the argument. Variadic is optional + // and if not provided is assumed to be false. + abs: {_func: this._functionAbs, _signature: [{types: [TYPE_NUMBER]}]}, + avg: {_func: this._functionAvg, _signature: [{types: [TYPE_ARRAY_NUMBER]}]}, + ceil: {_func: this._functionCeil, _signature: [{types: [TYPE_NUMBER]}]}, + contains: { + _func: this._functionContains, + _signature: [{types: [TYPE_STRING, TYPE_ARRAY]}, + {types: [TYPE_ANY]}]}, + "ends_with": { + _func: this._functionEndsWith, + _signature: [{types: [TYPE_STRING]}, {types: [TYPE_STRING]}]}, + floor: {_func: this._functionFloor, _signature: [{types: [TYPE_NUMBER]}]}, + length: { + _func: this._functionLength, + _signature: [{types: [TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT]}]}, + map: { + _func: this._functionMap, + _signature: [{types: [TYPE_EXPREF]}, {types: [TYPE_ARRAY]}]}, + max: { + _func: this._functionMax, + _signature: [{types: [TYPE_ARRAY_NUMBER, TYPE_ARRAY_STRING]}]}, + "merge": { + _func: this._functionMerge, + _signature: [{types: [TYPE_OBJECT], variadic: true}] + }, + "max_by": { + _func: this._functionMaxBy, + _signature: [{types: [TYPE_ARRAY]}, {types: [TYPE_EXPREF]}] + }, + sum: {_func: this._functionSum, _signature: [{types: [TYPE_ARRAY_NUMBER]}]}, + "starts_with": { + _func: this._functionStartsWith, + _signature: [{types: [TYPE_STRING]}, {types: [TYPE_STRING]}]}, + min: { + _func: this._functionMin, + _signature: [{types: [TYPE_ARRAY_NUMBER, TYPE_ARRAY_STRING]}]}, + "min_by": { + _func: this._functionMinBy, + _signature: [{types: [TYPE_ARRAY]}, {types: [TYPE_EXPREF]}] + }, + type: {_func: this._functionType, _signature: [{types: [TYPE_ANY]}]}, + keys: {_func: this._functionKeys, _signature: [{types: [TYPE_OBJECT]}]}, + values: {_func: this._functionValues, _signature: [{types: [TYPE_OBJECT]}]}, + sort: {_func: this._functionSort, _signature: [{types: [TYPE_ARRAY_STRING, TYPE_ARRAY_NUMBER]}]}, + "sort_by": { + _func: this._functionSortBy, + _signature: [{types: [TYPE_ARRAY]}, {types: [TYPE_EXPREF]}] + }, + join: { + _func: this._functionJoin, + _signature: [ + {types: [TYPE_STRING]}, + {types: [TYPE_ARRAY_STRING]} + ] + }, + reverse: { + _func: this._functionReverse, + _signature: [{types: [TYPE_STRING, TYPE_ARRAY]}]}, + "to_array": {_func: this._functionToArray, _signature: [{types: [TYPE_ANY]}]}, + "to_string": {_func: this._functionToString, _signature: [{types: [TYPE_ANY]}]}, + "to_number": {_func: this._functionToNumber, _signature: [{types: [TYPE_ANY]}]}, + "not_null": { + _func: this._functionNotNull, + _signature: [{types: [TYPE_ANY], variadic: true}] + } + }; + } + + Runtime.prototype = { + callFunction: function(name, resolvedArgs) { + var functionEntry = this.functionTable[name]; + if (functionEntry === undefined) { + throw new Error("Unknown function: " + name + "()"); + } + this._validateArgs(name, resolvedArgs, functionEntry._signature); + return functionEntry._func.call(this, resolvedArgs); + }, + + _validateArgs: function(name, args, signature) { + // Validating the args requires validating + // the correct arity and the correct type of each arg. + // If the last argument is declared as variadic, then we need + // a minimum number of args to be required. Otherwise it has to + // be an exact amount. + var pluralized; + if (signature[signature.length - 1].variadic) { + if (args.length < signature.length) { + pluralized = signature.length === 1 ? " argument" : " arguments"; + throw new Error("ArgumentError: " + name + "() " + + "takes at least" + signature.length + pluralized + + " but received " + args.length); + } + } else if (args.length !== signature.length) { + pluralized = signature.length === 1 ? " argument" : " arguments"; + throw new Error("ArgumentError: " + name + "() " + + "takes " + signature.length + pluralized + + " but received " + args.length); + } + var currentSpec; + var actualType; + var typeMatched; + for (var i = 0; i < signature.length; i++) { + typeMatched = false; + currentSpec = signature[i].types; + actualType = this._getTypeName(args[i]); + for (var j = 0; j < currentSpec.length; j++) { + if (this._typeMatches(actualType, currentSpec[j], args[i])) { + typeMatched = true; + break; + } + } + if (!typeMatched) { + throw new Error("TypeError: " + name + "() " + + "expected argument " + (i + 1) + + " to be type " + currentSpec + + " but received type " + actualType + + " instead."); + } + } + }, + + _typeMatches: function(actual, expected, argValue) { + if (expected === TYPE_ANY) { + return true; + } + if (expected === TYPE_ARRAY_STRING || + expected === TYPE_ARRAY_NUMBER || + expected === TYPE_ARRAY) { + // The expected type can either just be array, + // or it can require a specific subtype (array of numbers). + // + // The simplest case is if "array" with no subtype is specified. + if (expected === TYPE_ARRAY) { + return actual === TYPE_ARRAY; + } else if (actual === TYPE_ARRAY) { + // Otherwise we need to check subtypes. + // I think this has potential to be improved. + var subtype; + if (expected === TYPE_ARRAY_NUMBER) { + subtype = TYPE_NUMBER; + } else if (expected === TYPE_ARRAY_STRING) { + subtype = TYPE_STRING; + } + for (var i = 0; i < argValue.length; i++) { + if (!this._typeMatches( + this._getTypeName(argValue[i]), subtype, + argValue[i])) { + return false; + } + } + return true; + } + } else { + return actual === expected; + } + }, + _getTypeName: function(obj) { + switch (Object.prototype.toString.call(obj)) { + case "[object String]": + return TYPE_STRING; + case "[object Number]": + return TYPE_NUMBER; + case "[object Array]": + return TYPE_ARRAY; + case "[object Boolean]": + return TYPE_BOOLEAN; + case "[object Null]": + return TYPE_NULL; + case "[object Object]": + // Check if it's an expref. If it has, it's been + // tagged with a jmespathType attr of 'Expref'; + if (obj.jmespathType === TOK_EXPREF) { + return TYPE_EXPREF; + } else { + return TYPE_OBJECT; + } + } + }, + + _functionStartsWith: function(resolvedArgs) { + return resolvedArgs[0].lastIndexOf(resolvedArgs[1]) === 0; + }, + + _functionEndsWith: function(resolvedArgs) { + var searchStr = resolvedArgs[0]; + var suffix = resolvedArgs[1]; + return searchStr.indexOf(suffix, searchStr.length - suffix.length) !== -1; + }, + + _functionReverse: function(resolvedArgs) { + var typeName = this._getTypeName(resolvedArgs[0]); + if (typeName === TYPE_STRING) { + var originalStr = resolvedArgs[0]; + var reversedStr = ""; + for (var i = originalStr.length - 1; i >= 0; i--) { + reversedStr += originalStr[i]; + } + return reversedStr; + } else { + var reversedArray = resolvedArgs[0].slice(0); + reversedArray.reverse(); + return reversedArray; + } + }, + + _functionAbs: function(resolvedArgs) { + return Math.abs(resolvedArgs[0]); + }, + + _functionCeil: function(resolvedArgs) { + return Math.ceil(resolvedArgs[0]); + }, + + _functionAvg: function(resolvedArgs) { + var sum = 0; + var inputArray = resolvedArgs[0]; + for (var i = 0; i < inputArray.length; i++) { + sum += inputArray[i]; + } + return sum / inputArray.length; + }, + + _functionContains: function(resolvedArgs) { + return resolvedArgs[0].indexOf(resolvedArgs[1]) >= 0; + }, + + _functionFloor: function(resolvedArgs) { + return Math.floor(resolvedArgs[0]); + }, + + _functionLength: function(resolvedArgs) { + if (!isObject(resolvedArgs[0])) { + return resolvedArgs[0].length; + } else { + // As far as I can tell, there's no way to get the length + // of an object without O(n) iteration through the object. + return Object.keys(resolvedArgs[0]).length; + } + }, + + _functionMap: function(resolvedArgs) { + var mapped = []; + var interpreter = this._interpreter; + var exprefNode = resolvedArgs[0]; + var elements = resolvedArgs[1]; + for (var i = 0; i < elements.length; i++) { + mapped.push(interpreter.visit(exprefNode, elements[i])); + } + return mapped; + }, + + _functionMerge: function(resolvedArgs) { + var merged = {}; + for (var i = 0; i < resolvedArgs.length; i++) { + var current = resolvedArgs[i]; + for (var key in current) { + merged[key] = current[key]; + } + } + return merged; + }, + + _functionMax: function(resolvedArgs) { + if (resolvedArgs[0].length > 0) { + var typeName = this._getTypeName(resolvedArgs[0][0]); + if (typeName === TYPE_NUMBER) { + return Math.max.apply(Math, resolvedArgs[0]); + } else { + var elements = resolvedArgs[0]; + var maxElement = elements[0]; + for (var i = 1; i < elements.length; i++) { + if (maxElement.localeCompare(elements[i]) < 0) { + maxElement = elements[i]; + } + } + return maxElement; + } + } else { + return null; + } + }, + + _functionMin: function(resolvedArgs) { + if (resolvedArgs[0].length > 0) { + var typeName = this._getTypeName(resolvedArgs[0][0]); + if (typeName === TYPE_NUMBER) { + return Math.min.apply(Math, resolvedArgs[0]); + } else { + var elements = resolvedArgs[0]; + var minElement = elements[0]; + for (var i = 1; i < elements.length; i++) { + if (elements[i].localeCompare(minElement) < 0) { + minElement = elements[i]; + } + } + return minElement; + } + } else { + return null; + } + }, + + _functionSum: function(resolvedArgs) { + var sum = 0; + var listToSum = resolvedArgs[0]; + for (var i = 0; i < listToSum.length; i++) { + sum += listToSum[i]; + } + return sum; + }, + + _functionType: function(resolvedArgs) { + switch (this._getTypeName(resolvedArgs[0])) { + case TYPE_NUMBER: + return "number"; + case TYPE_STRING: + return "string"; + case TYPE_ARRAY: + return "array"; + case TYPE_OBJECT: + return "object"; + case TYPE_BOOLEAN: + return "boolean"; + case TYPE_EXPREF: + return "expref"; + case TYPE_NULL: + return "null"; + } + }, + + _functionKeys: function(resolvedArgs) { + return Object.keys(resolvedArgs[0]); + }, + + _functionValues: function(resolvedArgs) { + var obj = resolvedArgs[0]; + var keys = Object.keys(obj); + var values = []; + for (var i = 0; i < keys.length; i++) { + values.push(obj[keys[i]]); + } + return values; + }, + + _functionJoin: function(resolvedArgs) { + var joinChar = resolvedArgs[0]; + var listJoin = resolvedArgs[1]; + return listJoin.join(joinChar); + }, + + _functionToArray: function(resolvedArgs) { + if (this._getTypeName(resolvedArgs[0]) === TYPE_ARRAY) { + return resolvedArgs[0]; + } else { + return [resolvedArgs[0]]; + } + }, + + _functionToString: function(resolvedArgs) { + if (this._getTypeName(resolvedArgs[0]) === TYPE_STRING) { + return resolvedArgs[0]; + } else { + return JSON.stringify(resolvedArgs[0]); + } + }, + + _functionToNumber: function(resolvedArgs) { + var typeName = this._getTypeName(resolvedArgs[0]); + var convertedValue; + if (typeName === TYPE_NUMBER) { + return resolvedArgs[0]; + } else if (typeName === TYPE_STRING) { + convertedValue = +resolvedArgs[0]; + if (!isNaN(convertedValue)) { + return convertedValue; + } + } + return null; + }, + + _functionNotNull: function(resolvedArgs) { + for (var i = 0; i < resolvedArgs.length; i++) { + if (this._getTypeName(resolvedArgs[i]) !== TYPE_NULL) { + return resolvedArgs[i]; + } + } + return null; + }, + + _functionSort: function(resolvedArgs) { + var sortedArray = resolvedArgs[0].slice(0); + sortedArray.sort(); + return sortedArray; + }, + + _functionSortBy: function(resolvedArgs) { + var sortedArray = resolvedArgs[0].slice(0); + if (sortedArray.length === 0) { + return sortedArray; + } + var interpreter = this._interpreter; + var exprefNode = resolvedArgs[1]; + var requiredType = this._getTypeName( + interpreter.visit(exprefNode, sortedArray[0])); + if ([TYPE_NUMBER, TYPE_STRING].indexOf(requiredType) < 0) { + throw new Error("TypeError"); + } + var that = this; + // In order to get a stable sort out of an unstable + // sort algorithm, we decorate/sort/undecorate (DSU) + // by creating a new list of [index, element] pairs. + // In the cmp function, if the evaluated elements are + // equal, then the index will be used as the tiebreaker. + // After the decorated list has been sorted, it will be + // undecorated to extract the original elements. + var decorated = []; + for (var i = 0; i < sortedArray.length; i++) { + decorated.push([i, sortedArray[i]]); + } + decorated.sort(function(a, b) { + var exprA = interpreter.visit(exprefNode, a[1]); + var exprB = interpreter.visit(exprefNode, b[1]); + if (that._getTypeName(exprA) !== requiredType) { + throw new Error( + "TypeError: expected " + requiredType + ", received " + + that._getTypeName(exprA)); + } else if (that._getTypeName(exprB) !== requiredType) { + throw new Error( + "TypeError: expected " + requiredType + ", received " + + that._getTypeName(exprB)); + } + if (exprA > exprB) { + return 1; + } else if (exprA < exprB) { + return -1; + } else { + // If they're equal compare the items by their + // order to maintain relative order of equal keys + // (i.e. to get a stable sort). + return a[0] - b[0]; + } + }); + // Undecorate: extract out the original list elements. + for (var j = 0; j < decorated.length; j++) { + sortedArray[j] = decorated[j][1]; + } + return sortedArray; + }, + + _functionMaxBy: function(resolvedArgs) { + var exprefNode = resolvedArgs[1]; + var resolvedArray = resolvedArgs[0]; + var keyFunction = this.createKeyFunction(exprefNode, [TYPE_NUMBER, TYPE_STRING]); + var maxNumber = -Infinity; + var maxRecord; + var current; + for (var i = 0; i < resolvedArray.length; i++) { + current = keyFunction(resolvedArray[i]); + if (current > maxNumber) { + maxNumber = current; + maxRecord = resolvedArray[i]; + } + } + return maxRecord; + }, + + _functionMinBy: function(resolvedArgs) { + var exprefNode = resolvedArgs[1]; + var resolvedArray = resolvedArgs[0]; + var keyFunction = this.createKeyFunction(exprefNode, [TYPE_NUMBER, TYPE_STRING]); + var minNumber = Infinity; + var minRecord; + var current; + for (var i = 0; i < resolvedArray.length; i++) { + current = keyFunction(resolvedArray[i]); + if (current < minNumber) { + minNumber = current; + minRecord = resolvedArray[i]; + } + } + return minRecord; + }, + + createKeyFunction: function(exprefNode, allowedTypes) { + var that = this; + var interpreter = this._interpreter; + var keyFunc = function(x) { + var current = interpreter.visit(exprefNode, x); + if (allowedTypes.indexOf(that._getTypeName(current)) < 0) { + var msg = "TypeError: expected one of " + allowedTypes + + ", received " + that._getTypeName(current); + throw new Error(msg); + } + return current; + }; + return keyFunc; + } + + }; + + function compile(stream) { + var parser = new Parser(); + var ast = parser.parse(stream); + return ast; + } + + function tokenize(stream) { + var lexer = new Lexer(); + return lexer.tokenize(stream); + } + + function search(data, expression) { + var parser = new Parser(); + // This needs to be improved. Both the interpreter and runtime depend on + // each other. The runtime needs the interpreter to support exprefs. + // There's likely a clean way to avoid the cyclic dependency. + var runtime = new Runtime(); + var interpreter = new TreeInterpreter(runtime); + runtime._interpreter = interpreter; + var node = parser.parse(expression); + return interpreter.search(node, data); + } + + exports.tokenize = tokenize; + exports.compile = compile; + exports.search = search; + exports.strictDeepEqual = strictDeepEqual; +})(typeof exports === "undefined" ? this.jmespath = {} : exports); diff --git a/node_modules/jmespath/jp.js b/node_modules/jmespath/jp.js new file mode 100755 index 0000000..c152108 --- /dev/null +++ b/node_modules/jmespath/jp.js @@ -0,0 +1,23 @@ +#!/usr/bin/env node +jmespath = require('./jmespath'); + +process.stdin.setEncoding('utf-8'); + + +if (process.argv.length < 2) { + console.log("Must provide a jmespath expression."); + process.exit(1); +} +var inputJSON = ""; + +process.stdin.on('readable', function() { + var chunk = process.stdin.read(); + if (chunk !== null) { + inputJSON += chunk; + } +}); + +process.stdin.on('end', function() { + var parsedInput = JSON.parse(inputJSON); + console.log(JSON.stringify(jmespath.search(parsedInput, process.argv[2]))); +}); diff --git a/node_modules/jmespath/l.js b/node_modules/jmespath/l.js new file mode 100644 index 0000000..27bf6dd --- /dev/null +++ b/node_modules/jmespath/l.js @@ -0,0 +1,189 @@ +'use strict'; + +var Lexer = exports.Lexer = function() { + this.pos = 0; + this.buf = null; + this.buflen = 0; + + // Operator table, mapping operator -> token name + this.optable = { + '+': 'PLUS', + '-': 'MINUS', + '*': 'MULTIPLY', + '.': 'PERIOD', + '\\': 'BACKSLASH', + ':': 'COLON', + '%': 'PERCENT', + '|': 'PIPE', + '!': 'EXCLAMATION', + '?': 'QUESTION', + '#': 'POUND', + '&': 'AMPERSAND', + ';': 'SEMI', + ',': 'COMMA', + '(': 'L_PAREN', + ')': 'R_PAREN', + '<': 'L_ANG', + '>': 'R_ANG', + '{': 'L_BRACE', + '}': 'R_BRACE', + '[': 'L_BRACKET', + ']': 'R_BRACKET', + '=': 'EQUALS' + }; +} + +// Initialize the Lexer's buffer. This resets the lexer's internal +// state and subsequent tokens will be returned starting with the +// beginning of the new buffer. +Lexer.prototype.input = function(buf) { + this.pos = 0; + this.buf = buf; + this.buflen = buf.length; +} + +// Get the next token from the current buffer. A token is an object with +// the following properties: +// - name: name of the pattern that this token matched (taken from rules). +// - value: actual string value of the token. +// - pos: offset in the current buffer where the token starts. +// +// If there are no more tokens in the buffer, returns null. In case of +// an error throws Error. +Lexer.prototype.token = function() { + this._skipnontokens(); + if (this.pos >= this.buflen) { + return null; + } + + // The char at this.pos is part of a real token. Figure out which. + var c = this.buf.charAt(this.pos); + + // '/' is treated specially, because it starts a comment if followed by + // another '/'. If not followed by another '/', it's the DIVIDE + // operator. + if (c === '/') { + var next_c = this.buf.charAt(this.pos + 1); + if (next_c === '/') { + return this._process_comment(); + } else { + return {name: 'DIVIDE', value: '/', pos: this.pos++}; + } + } else { + // Look it up in the table of operators + var op = this.optable[c]; + if (op !== undefined) { + return {name: op, value: c, pos: this.pos++}; + } else { + // Not an operator - so it's the beginning of another token. + if (Lexer._isalpha(c)) { + return this._process_identifier(); + } else if (Lexer._isdigit(c)) { + return this._process_number(); + } else if (c === '"') { + return this._process_quote(); + } else { + throw Error('Token error at ' + this.pos); + } + } + } +} + +Lexer._isnewline = function(c) { + return c === '\r' || c === '\n'; +} + +Lexer._isdigit = function(c) { + return c >= '0' && c <= '9'; +} + +Lexer._isalpha = function(c) { + return (c >= 'a' && c <= 'z') || + (c >= 'A' && c <= 'Z') || + c === '_' || c === '$'; +} + +Lexer._isalphanum = function(c) { + return (c >= 'a' && c <= 'z') || + (c >= 'A' && c <= 'Z') || + (c >= '0' && c <= '9') || + c === '_' || c === '$'; +} + +Lexer.prototype._process_number = function() { + var endpos = this.pos + 1; + while (endpos < this.buflen && + Lexer._isdigit(this.buf.charAt(endpos))) { + endpos++; + } + + var tok = { + name: 'NUMBER', + value: this.buf.substring(this.pos, endpos), + pos: this.pos + }; + this.pos = endpos; + return tok; +} + +Lexer.prototype._process_comment = function() { + var endpos = this.pos + 2; + // Skip until the end of the line + var c = this.buf.charAt(this.pos + 2); + while (endpos < this.buflen && + !Lexer._isnewline(this.buf.charAt(endpos))) { + endpos++; + } + + var tok = { + name: 'COMMENT', + value: this.buf.substring(this.pos, endpos), + pos: this.pos + }; + this.pos = endpos + 1; + return tok; +} + +Lexer.prototype._process_identifier = function() { + var endpos = this.pos + 1; + while (endpos < this.buflen && + Lexer._isalphanum(this.buf.charAt(endpos))) { + endpos++; + } + + var tok = { + name: 'IDENTIFIER', + value: this.buf.substring(this.pos, endpos), + pos: this.pos + }; + this.pos = endpos; + return tok; +} + +Lexer.prototype._process_quote = function() { + // this.pos points at the opening quote. Find the ending quote. + var end_index = this.buf.indexOf('"', this.pos + 1); + + if (end_index === -1) { + throw Error('Unterminated quote at ' + this.pos); + } else { + var tok = { + name: 'QUOTE', + value: this.buf.substring(this.pos, end_index + 1), + pos: this.pos + }; + this.pos = end_index + 1; + return tok; + } +} + +Lexer.prototype._skipnontokens = function() { + while (this.pos < this.buflen) { + var c = this.buf.charAt(this.pos); + if (c == ' ' || c == '\t' || c == '\r' || c == '\n') { + this.pos++; + } else { + break; + } + } +} diff --git a/node_modules/jmespath/package.json b/node_modules/jmespath/package.json new file mode 100644 index 0000000..801e620 --- /dev/null +++ b/node_modules/jmespath/package.json @@ -0,0 +1,74 @@ +{ + "_from": "jmespath@0.15.0", + "_id": "jmespath@0.15.0", + "_inBundle": false, + "_integrity": "sha1-o/Iiqarp+Wb10nx5ZRDigJF2Qhc=", + "_location": "/jmespath", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "jmespath@0.15.0", + "name": "jmespath", + "escapedName": "jmespath", + "rawSpec": "0.15.0", + "saveSpec": null, + "fetchSpec": "0.15.0" + }, + "_requiredBy": [ + "/aws-sdk" + ], + "_resolved": "https://registry.npmjs.org/jmespath/-/jmespath-0.15.0.tgz", + "_shasum": "a3f222a9aae9f966f5d27c796510e28091764217", + "_spec": "jmespath@0.15.0", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/aws-sdk", + "author": { + "name": "James Saryerwinnie", + "email": "js@jamesls.com", + "url": "http://jamesls.com/" + }, + "bugs": { + "url": "http://github.com/jmespath/jmespath.js/issues" + }, + "bundleDependencies": false, + "contributors": [], + "dependencies": {}, + "deprecated": false, + "description": "JMESPath implementation in javascript", + "devDependencies": { + "grunt": "^0.4.5", + "grunt-contrib-jshint": "^0.11.0", + "grunt-contrib-uglify": "^0.11.1", + "grunt-eslint": "^17.3.1", + "mocha": "^2.1.0" + }, + "directories": { + "test": "test" + }, + "engines": { + "node": ">= 0.6.0" + }, + "homepage": "https://github.com/jmespath/jmespath.js", + "keywords": [ + "jmespath", + "jsonpath", + "json", + "xpath" + ], + "licenses": [ + { + "type": "Apache 2.0", + "url": "http://github.com/jmespath/jmespath.js/raw/master/LICENSE" + } + ], + "main": "jmespath.js", + "name": "jmespath", + "repository": { + "type": "git", + "url": "git://github.com/jmespath/jmespath.js.git" + }, + "scripts": { + "test": "mocha test/" + }, + "version": "0.15.0" +} diff --git a/node_modules/jmespath/perf.js b/node_modules/jmespath/perf.js new file mode 100644 index 0000000..58794ec --- /dev/null +++ b/node_modules/jmespath/perf.js @@ -0,0 +1,33 @@ +var jmespath = require('./jmespath') +var Benchmark = require('benchmark'); +var suite = new Benchmark.Suite; + +// add tests +suite.add('Parser#single_expr', function() { + jmespath.compile("foo"); +}) +.add('Parser#single_subexpr', function() { + jmespath.compile("foo.bar"); +}) +.add('Parser#deeply_nested_50', function() { + jmespath.compile("j49.j48.j47.j46.j45.j44.j43.j42.j41.j40.j39.j38.j37.j36.j35.j34.j33.j32.j31.j30.j29.j28.j27.j26.j25.j24.j23.j22.j21.j20.j19.j18.j17.j16.j15.j14.j13.j12.j11.j10.j9.j8.j7.j6.j5.j4.j3.j2.j1.j0"); + +}) +.add('Parser#deeply_nested_50_index', function() { + jmespath.compile("[49][48][47][46][45][44][43][42][41][40][39][38][37][36][35][34][33][32][31][30][29][28][27][26][25][24][23][22][21][20][19][18][17][16][15][14][13][12][11][10][9][8][7][6][5][4][3][2][1][0]"); +}) +.add('Parser#basic_list_projection', function() { + jmespath.compile("foo[*].bar"); +}) +.on('cycle', function(event) { + var bench = event.target; + var mean = bench.stats.mean * 1000; + var variance = bench.stats.variance * 1000000; + var result = 'Mean time: ' + mean.toFixed(6) + 'msec '; + result += event.target.toString(); + console.log(result); +}) +.on('complete', function() { +}) +// run async +.run({ 'async': false }); diff --git a/node_modules/jmespath/reservedWords.json b/node_modules/jmespath/reservedWords.json new file mode 100644 index 0000000..433cd35 --- /dev/null +++ b/node_modules/jmespath/reservedWords.json @@ -0,0 +1,4 @@ +{ + "vars": [ "define", "require", "exports"], + "props": ["compile", "search", "tokenize", "jmespath", "parse", "stringify", "prototype", "length"] +} diff --git a/node_modules/jmespath/test/compliance.js b/node_modules/jmespath/test/compliance.js new file mode 100644 index 0000000..6298e9e --- /dev/null +++ b/node_modules/jmespath/test/compliance.js @@ -0,0 +1,56 @@ +var fs = require('fs'); +var path = require('path'); +var assert = require('assert'); +var jmespath = require('../jmespath'); +var search = jmespath.search; + +// Compliance tests that aren't supported yet. +var notImplementedYet = []; + +function endsWith(str, suffix) { + return str.indexOf(suffix, str.length - suffix.length) !== -1; +} + +var listing = fs.readdirSync('test/compliance'); +for (var i = 0; i < listing.length; i++) { + var filename = 'test/compliance/' + listing[i]; + if (fs.statSync(filename).isFile() && endsWith(filename, '.json') && + notImplementedYet.indexOf(path.basename(filename)) === -1) { + addTestSuitesFromFile(filename); + } +} +function addTestSuitesFromFile(filename) { + describe(filename, function() { + var spec = JSON.parse(fs.readFileSync(filename, 'utf-8')); + var errorMsg; + for (var i = 0; i < spec.length; i++) { + var msg = "suite " + i + " for filename " + filename; + describe(msg, function() { + var given = spec[i].given; + var cases = spec[i].cases; + for (var j = 0; j < cases.length; j++) { + var testcase = cases[j]; + if (testcase.error !== undefined) { + // For now just verify that an error is thrown + // for error tests. + (function(testcase, given) { + it('should throw error for test ' + j, function() { + assert.throws( + function() { + search(given, testcase.expression); + }, Error, testcase.expression); + }); + })(testcase, given); + } else { + (function(testcase, given) { + it('should pass test ' + j + " expression: " + testcase.expression, function() { + assert.deepEqual(search(given, testcase.expression), + testcase.result); + }); + })(testcase, given); + } + } + }); + } + }); +} diff --git a/node_modules/jmespath/test/compliance/basic.json b/node_modules/jmespath/test/compliance/basic.json new file mode 100644 index 0000000..d550e96 --- /dev/null +++ b/node_modules/jmespath/test/compliance/basic.json @@ -0,0 +1,96 @@ +[{ + "given": + {"foo": {"bar": {"baz": "correct"}}}, + "cases": [ + { + "expression": "foo", + "result": {"bar": {"baz": "correct"}} + }, + { + "expression": "foo.bar", + "result": {"baz": "correct"} + }, + { + "expression": "foo.bar.baz", + "result": "correct" + }, + { + "expression": "foo\n.\nbar\n.baz", + "result": "correct" + }, + { + "expression": "foo.bar.baz.bad", + "result": null + }, + { + "expression": "foo.bar.bad", + "result": null + }, + { + "expression": "foo.bad", + "result": null + }, + { + "expression": "bad", + "result": null + }, + { + "expression": "bad.morebad.morebad", + "result": null + } + ] +}, +{ + "given": + {"foo": {"bar": ["one", "two", "three"]}}, + "cases": [ + { + "expression": "foo", + "result": {"bar": ["one", "two", "three"]} + }, + { + "expression": "foo.bar", + "result": ["one", "two", "three"] + } + ] +}, +{ + "given": ["one", "two", "three"], + "cases": [ + { + "expression": "one", + "result": null + }, + { + "expression": "two", + "result": null + }, + { + "expression": "three", + "result": null + }, + { + "expression": "one.two", + "result": null + } + ] +}, +{ + "given": + {"foo": {"1": ["one", "two", "three"], "-1": "bar"}}, + "cases": [ + { + "expression": "foo.\"1\"", + "result": ["one", "two", "three"] + }, + { + "expression": "foo.\"1\"[0]", + "result": "one" + }, + { + "expression": "foo.\"-1\"", + "result": "bar" + } + ] +} +] diff --git a/node_modules/jmespath/test/compliance/boolean.json b/node_modules/jmespath/test/compliance/boolean.json new file mode 100644 index 0000000..e3fa196 --- /dev/null +++ b/node_modules/jmespath/test/compliance/boolean.json @@ -0,0 +1,257 @@ +[ + { + "given": { + "outer": { + "foo": "foo", + "bar": "bar", + "baz": "baz" + } + }, + "cases": [ + { + "expression": "outer.foo || outer.bar", + "result": "foo" + }, + { + "expression": "outer.foo||outer.bar", + "result": "foo" + }, + { + "expression": "outer.bar || outer.baz", + "result": "bar" + }, + { + "expression": "outer.bar||outer.baz", + "result": "bar" + }, + { + "expression": "outer.bad || outer.foo", + "result": "foo" + }, + { + "expression": "outer.bad||outer.foo", + "result": "foo" + }, + { + "expression": "outer.foo || outer.bad", + "result": "foo" + }, + { + "expression": "outer.foo||outer.bad", + "result": "foo" + }, + { + "expression": "outer.bad || outer.alsobad", + "result": null + }, + { + "expression": "outer.bad||outer.alsobad", + "result": null + } + ] + }, + { + "given": { + "outer": { + "foo": "foo", + "bool": false, + "empty_list": [], + "empty_string": "" + } + }, + "cases": [ + { + "expression": "outer.empty_string || outer.foo", + "result": "foo" + }, + { + "expression": "outer.nokey || outer.bool || outer.empty_list || outer.empty_string || outer.foo", + "result": "foo" + } + ] + }, + { + "given": { + "True": true, + "False": false, + "Number": 5, + "EmptyList": [], + "Zero": 0 + }, + "cases": [ + { + "expression": "True && False", + "result": false + }, + { + "expression": "False && True", + "result": false + }, + { + "expression": "True && True", + "result": true + }, + { + "expression": "False && False", + "result": false + }, + { + "expression": "True && Number", + "result": 5 + }, + { + "expression": "Number && True", + "result": true + }, + { + "expression": "Number && False", + "result": false + }, + { + "expression": "Number && EmptyList", + "result": [] + }, + { + "expression": "Number && True", + "result": true + }, + { + "expression": "EmptyList && True", + "result": [] + }, + { + "expression": "EmptyList && False", + "result": [] + }, + { + "expression": "True || False", + "result": true + }, + { + "expression": "True || True", + "result": true + }, + { + "expression": "False || True", + "result": true + }, + { + "expression": "False || False", + "result": false + }, + { + "expression": "Number || EmptyList", + "result": 5 + }, + { + "expression": "Number || True", + "result": 5 + }, + { + "expression": "Number || True && False", + "result": 5 + }, + { + "expression": "(Number || True) && False", + "result": false + }, + { + "expression": "Number || (True && False)", + "result": 5 + }, + { + "expression": "!True", + "result": false + }, + { + "expression": "!False", + "result": true + }, + { + "expression": "!Number", + "result": false + }, + { + "expression": "!EmptyList", + "result": true + }, + { + "expression": "True && !False", + "result": true + }, + { + "expression": "True && !EmptyList", + "result": true + }, + { + "expression": "!False && !EmptyList", + "result": true + }, + { + "expression": "!(True && False)", + "result": true + }, + { + "expression": "!Zero", + "result": false + }, + { + "expression": "!!Zero", + "result": true + } + ] + }, + { + "given": { + "one": 1, + "two": 2, + "three": 3 + }, + "cases": [ + { + "expression": "one < two", + "result": true + }, + { + "expression": "one <= two", + "result": true + }, + { + "expression": "one == one", + "result": true + }, + { + "expression": "one == two", + "result": false + }, + { + "expression": "one > two", + "result": false + }, + { + "expression": "one >= two", + "result": false + }, + { + "expression": "one != two", + "result": true + }, + { + "expression": "one < two && three > one", + "result": true + }, + { + "expression": "one < two || three > one", + "result": true + }, + { + "expression": "one < two || three < one", + "result": true + }, + { + "expression": "two < one || three < one", + "result": false + } + ] + } +] diff --git a/node_modules/jmespath/test/compliance/current.json b/node_modules/jmespath/test/compliance/current.json new file mode 100644 index 0000000..0c26248 --- /dev/null +++ b/node_modules/jmespath/test/compliance/current.json @@ -0,0 +1,25 @@ +[ + { + "given": { + "foo": [{"name": "a"}, {"name": "b"}], + "bar": {"baz": "qux"} + }, + "cases": [ + { + "expression": "@", + "result": { + "foo": [{"name": "a"}, {"name": "b"}], + "bar": {"baz": "qux"} + } + }, + { + "expression": "@.bar", + "result": {"baz": "qux"} + }, + { + "expression": "@.foo[0]", + "result": {"name": "a"} + } + ] + } +] diff --git a/node_modules/jmespath/test/compliance/escape.json b/node_modules/jmespath/test/compliance/escape.json new file mode 100644 index 0000000..4a62d95 --- /dev/null +++ b/node_modules/jmespath/test/compliance/escape.json @@ -0,0 +1,46 @@ +[{ + "given": { + "foo.bar": "dot", + "foo bar": "space", + "foo\nbar": "newline", + "foo\"bar": "doublequote", + "c:\\\\windows\\path": "windows", + "/unix/path": "unix", + "\"\"\"": "threequotes", + "bar": {"baz": "qux"} + }, + "cases": [ + { + "expression": "\"foo.bar\"", + "result": "dot" + }, + { + "expression": "\"foo bar\"", + "result": "space" + }, + { + "expression": "\"foo\\nbar\"", + "result": "newline" + }, + { + "expression": "\"foo\\\"bar\"", + "result": "doublequote" + }, + { + "expression": "\"c:\\\\\\\\windows\\\\path\"", + "result": "windows" + }, + { + "expression": "\"/unix/path\"", + "result": "unix" + }, + { + "expression": "\"\\\"\\\"\\\"\"", + "result": "threequotes" + }, + { + "expression": "\"bar\".\"baz\"", + "result": "qux" + } + ] +}] diff --git a/node_modules/jmespath/test/compliance/filters.json b/node_modules/jmespath/test/compliance/filters.json new file mode 100644 index 0000000..5b9f52b --- /dev/null +++ b/node_modules/jmespath/test/compliance/filters.json @@ -0,0 +1,468 @@ +[ + { + "given": {"foo": [{"name": "a"}, {"name": "b"}]}, + "cases": [ + { + "comment": "Matching a literal", + "expression": "foo[?name == 'a']", + "result": [{"name": "a"}] + } + ] + }, + { + "given": {"foo": [0, 1], "bar": [2, 3]}, + "cases": [ + { + "comment": "Matching a literal", + "expression": "*[?[0] == `0`]", + "result": [[], []] + } + ] + }, + { + "given": {"foo": [{"first": "foo", "last": "bar"}, + {"first": "foo", "last": "foo"}, + {"first": "foo", "last": "baz"}]}, + "cases": [ + { + "comment": "Matching an expression", + "expression": "foo[?first == last]", + "result": [{"first": "foo", "last": "foo"}] + }, + { + "comment": "Verify projection created from filter", + "expression": "foo[?first == last].first", + "result": ["foo"] + } + ] + }, + { + "given": {"foo": [{"age": 20}, + {"age": 25}, + {"age": 30}]}, + "cases": [ + { + "comment": "Greater than with a number", + "expression": "foo[?age > `25`]", + "result": [{"age": 30}] + }, + { + "expression": "foo[?age >= `25`]", + "result": [{"age": 25}, {"age": 30}] + }, + { + "comment": "Greater than with a number", + "expression": "foo[?age > `30`]", + "result": [] + }, + { + "comment": "Greater than with a number", + "expression": "foo[?age < `25`]", + "result": [{"age": 20}] + }, + { + "comment": "Greater than with a number", + "expression": "foo[?age <= `25`]", + "result": [{"age": 20}, {"age": 25}] + }, + { + "comment": "Greater than with a number", + "expression": "foo[?age < `20`]", + "result": [] + }, + { + "expression": "foo[?age == `20`]", + "result": [{"age": 20}] + }, + { + "expression": "foo[?age != `20`]", + "result": [{"age": 25}, {"age": 30}] + } + ] + }, + { + "given": {"foo": [{"top": {"name": "a"}}, + {"top": {"name": "b"}}]}, + "cases": [ + { + "comment": "Filter with subexpression", + "expression": "foo[?top.name == 'a']", + "result": [{"top": {"name": "a"}}] + } + ] + }, + { + "given": {"foo": [{"top": {"first": "foo", "last": "bar"}}, + {"top": {"first": "foo", "last": "foo"}}, + {"top": {"first": "foo", "last": "baz"}}]}, + "cases": [ + { + "comment": "Matching an expression", + "expression": "foo[?top.first == top.last]", + "result": [{"top": {"first": "foo", "last": "foo"}}] + }, + { + "comment": "Matching a JSON array", + "expression": "foo[?top == `{\"first\": \"foo\", \"last\": \"bar\"}`]", + "result": [{"top": {"first": "foo", "last": "bar"}}] + } + ] + }, + { + "given": {"foo": [ + {"key": true}, + {"key": false}, + {"key": 0}, + {"key": 1}, + {"key": [0]}, + {"key": {"bar": [0]}}, + {"key": null}, + {"key": [1]}, + {"key": {"a":2}} + ]}, + "cases": [ + { + "expression": "foo[?key == `true`]", + "result": [{"key": true}] + }, + { + "expression": "foo[?key == `false`]", + "result": [{"key": false}] + }, + { + "expression": "foo[?key == `0`]", + "result": [{"key": 0}] + }, + { + "expression": "foo[?key == `1`]", + "result": [{"key": 1}] + }, + { + "expression": "foo[?key == `[0]`]", + "result": [{"key": [0]}] + }, + { + "expression": "foo[?key == `{\"bar\": [0]}`]", + "result": [{"key": {"bar": [0]}}] + }, + { + "expression": "foo[?key == `null`]", + "result": [{"key": null}] + }, + { + "expression": "foo[?key == `[1]`]", + "result": [{"key": [1]}] + }, + { + "expression": "foo[?key == `{\"a\":2}`]", + "result": [{"key": {"a":2}}] + }, + { + "expression": "foo[?`true` == key]", + "result": [{"key": true}] + }, + { + "expression": "foo[?`false` == key]", + "result": [{"key": false}] + }, + { + "expression": "foo[?`0` == key]", + "result": [{"key": 0}] + }, + { + "expression": "foo[?`1` == key]", + "result": [{"key": 1}] + }, + { + "expression": "foo[?`[0]` == key]", + "result": [{"key": [0]}] + }, + { + "expression": "foo[?`{\"bar\": [0]}` == key]", + "result": [{"key": {"bar": [0]}}] + }, + { + "expression": "foo[?`null` == key]", + "result": [{"key": null}] + }, + { + "expression": "foo[?`[1]` == key]", + "result": [{"key": [1]}] + }, + { + "expression": "foo[?`{\"a\":2}` == key]", + "result": [{"key": {"a":2}}] + }, + { + "expression": "foo[?key != `true`]", + "result": [{"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?key != `false`]", + "result": [{"key": true}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?key != `0`]", + "result": [{"key": true}, {"key": false}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?key != `1`]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?key != `null`]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?key != `[1]`]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": {"a":2}}] + }, + { + "expression": "foo[?key != `{\"a\":2}`]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}] + }, + { + "expression": "foo[?`true` != key]", + "result": [{"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?`false` != key]", + "result": [{"key": true}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?`0` != key]", + "result": [{"key": true}, {"key": false}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?`1` != key]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?`null` != key]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": [1]}, {"key": {"a":2}}] + }, + { + "expression": "foo[?`[1]` != key]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": {"a":2}}] + }, + { + "expression": "foo[?`{\"a\":2}` != key]", + "result": [{"key": true}, {"key": false}, {"key": 0}, {"key": 1}, {"key": [0]}, + {"key": {"bar": [0]}}, {"key": null}, {"key": [1]}] + } + ] + }, + { + "given": {"reservations": [ + {"instances": [ + {"foo": 1, "bar": 2}, {"foo": 1, "bar": 3}, + {"foo": 1, "bar": 2}, {"foo": 2, "bar": 1}]}]}, + "cases": [ + { + "expression": "reservations[].instances[?bar==`1`]", + "result": [[{"foo": 2, "bar": 1}]] + }, + { + "expression": "reservations[*].instances[?bar==`1`]", + "result": [[{"foo": 2, "bar": 1}]] + }, + { + "expression": "reservations[].instances[?bar==`1`][]", + "result": [{"foo": 2, "bar": 1}] + } + ] + }, + { + "given": { + "baz": "other", + "foo": [ + {"bar": 1}, {"bar": 2}, {"bar": 3}, {"bar": 4}, {"bar": 1, "baz": 2} + ] + }, + "cases": [ + { + "expression": "foo[?bar==`1`].bar[0]", + "result": [] + } + ] + }, + { + "given": { + "foo": [ + {"a": 1, "b": {"c": "x"}}, + {"a": 1, "b": {"c": "y"}}, + {"a": 1, "b": {"c": "z"}}, + {"a": 2, "b": {"c": "z"}}, + {"a": 1, "baz": 2} + ] + }, + "cases": [ + { + "expression": "foo[?a==`1`].b.c", + "result": ["x", "y", "z"] + } + ] + }, + { + "given": {"foo": [{"name": "a"}, {"name": "b"}, {"name": "c"}]}, + "cases": [ + { + "comment": "Filter with or expression", + "expression": "foo[?name == 'a' || name == 'b']", + "result": [{"name": "a"}, {"name": "b"}] + }, + { + "expression": "foo[?name == 'a' || name == 'e']", + "result": [{"name": "a"}] + }, + { + "expression": "foo[?name == 'a' || name == 'b' || name == 'c']", + "result": [{"name": "a"}, {"name": "b"}, {"name": "c"}] + } + ] + }, + { + "given": {"foo": [{"a": 1, "b": 2}, {"a": 1, "b": 3}]}, + "cases": [ + { + "comment": "Filter with and expression", + "expression": "foo[?a == `1` && b == `2`]", + "result": [{"a": 1, "b": 2}] + }, + { + "expression": "foo[?a == `1` && b == `4`]", + "result": [] + } + ] + }, + { + "given": {"foo": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]}, + "cases": [ + { + "comment": "Filter with Or and And expressions", + "expression": "foo[?c == `3` || a == `1` && b == `4`]", + "result": [{"a": 1, "b": 2, "c": 3}] + }, + { + "expression": "foo[?b == `2` || a == `3` && b == `4`]", + "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}] + }, + { + "expression": "foo[?a == `3` && b == `4` || b == `2`]", + "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}] + }, + { + "expression": "foo[?(a == `3` && b == `4`) || b == `2`]", + "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}] + }, + { + "expression": "foo[?((a == `3` && b == `4`)) || b == `2`]", + "result": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}] + }, + { + "expression": "foo[?a == `3` && (b == `4` || b == `2`)]", + "result": [{"a": 3, "b": 4}] + }, + { + "expression": "foo[?a == `3` && ((b == `4` || b == `2`))]", + "result": [{"a": 3, "b": 4}] + } + ] + }, + { + "given": {"foo": [{"a": 1, "b": 2, "c": 3}, {"a": 3, "b": 4}]}, + "cases": [ + { + "comment": "Verify precedence of or/and expressions", + "expression": "foo[?a == `1` || b ==`2` && c == `5`]", + "result": [{"a": 1, "b": 2, "c": 3}] + }, + { + "comment": "Parentheses can alter precedence", + "expression": "foo[?(a == `1` || b ==`2`) && c == `5`]", + "result": [] + }, + { + "comment": "Not expressions combined with and/or", + "expression": "foo[?!(a == `1` || b ==`2`)]", + "result": [{"a": 3, "b": 4}] + } + ] + }, + { + "given": { + "foo": [ + {"key": true}, + {"key": false}, + {"key": []}, + {"key": {}}, + {"key": [0]}, + {"key": {"a": "b"}}, + {"key": 0}, + {"key": 1}, + {"key": null}, + {"notkey": true} + ] + }, + "cases": [ + { + "comment": "Unary filter expression", + "expression": "foo[?key]", + "result": [ + {"key": true}, {"key": [0]}, {"key": {"a": "b"}}, + {"key": 0}, {"key": 1} + ] + }, + { + "comment": "Unary not filter expression", + "expression": "foo[?!key]", + "result": [ + {"key": false}, {"key": []}, {"key": {}}, + {"key": null}, {"notkey": true} + ] + }, + { + "comment": "Equality with null RHS", + "expression": "foo[?key == `null`]", + "result": [ + {"key": null}, {"notkey": true} + ] + } + ] + }, + { + "given": { + "foo": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + "cases": [ + { + "comment": "Using @ in a filter expression", + "expression": "foo[?@ < `5`]", + "result": [0, 1, 2, 3, 4] + }, + { + "comment": "Using @ in a filter expression", + "expression": "foo[?`5` > @]", + "result": [0, 1, 2, 3, 4] + }, + { + "comment": "Using @ in a filter expression", + "expression": "foo[?@ == @]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + } + ] + } +] diff --git a/node_modules/jmespath/test/compliance/functions.json b/node_modules/jmespath/test/compliance/functions.json new file mode 100644 index 0000000..8b8db36 --- /dev/null +++ b/node_modules/jmespath/test/compliance/functions.json @@ -0,0 +1,825 @@ +[{ + "given": + { + "foo": -1, + "zero": 0, + "numbers": [-1, 3, 4, 5], + "array": [-1, 3, 4, 5, "a", "100"], + "strings": ["a", "b", "c"], + "decimals": [1.01, 1.2, -1.5], + "str": "Str", + "false": false, + "empty_list": [], + "empty_hash": {}, + "objects": {"foo": "bar", "bar": "baz"}, + "null_key": null + }, + "cases": [ + { + "expression": "abs(foo)", + "result": 1 + }, + { + "expression": "abs(foo)", + "result": 1 + }, + { + "expression": "abs(str)", + "error": "invalid-type" + }, + { + "expression": "abs(array[1])", + "result": 3 + }, + { + "expression": "abs(array[1])", + "result": 3 + }, + { + "expression": "abs(`false`)", + "error": "invalid-type" + }, + { + "expression": "abs(`-24`)", + "result": 24 + }, + { + "expression": "abs(`-24`)", + "result": 24 + }, + { + "expression": "abs(`1`, `2`)", + "error": "invalid-arity" + }, + { + "expression": "abs()", + "error": "invalid-arity" + }, + { + "expression": "unknown_function(`1`, `2`)", + "error": "unknown-function" + }, + { + "expression": "avg(numbers)", + "result": 2.75 + }, + { + "expression": "avg(array)", + "error": "invalid-type" + }, + { + "expression": "avg('abc')", + "error": "invalid-type" + }, + { + "expression": "avg(foo)", + "error": "invalid-type" + }, + { + "expression": "avg(@)", + "error": "invalid-type" + }, + { + "expression": "avg(strings)", + "error": "invalid-type" + }, + { + "expression": "ceil(`1.2`)", + "result": 2 + }, + { + "expression": "ceil(decimals[0])", + "result": 2 + }, + { + "expression": "ceil(decimals[1])", + "result": 2 + }, + { + "expression": "ceil(decimals[2])", + "result": -1 + }, + { + "expression": "ceil('string')", + "error": "invalid-type" + }, + { + "expression": "contains('abc', 'a')", + "result": true + }, + { + "expression": "contains('abc', 'd')", + "result": false + }, + { + "expression": "contains(`false`, 'd')", + "error": "invalid-type" + }, + { + "expression": "contains(strings, 'a')", + "result": true + }, + { + "expression": "contains(decimals, `1.2`)", + "result": true + }, + { + "expression": "contains(decimals, `false`)", + "result": false + }, + { + "expression": "ends_with(str, 'r')", + "result": true + }, + { + "expression": "ends_with(str, 'tr')", + "result": true + }, + { + "expression": "ends_with(str, 'Str')", + "result": true + }, + { + "expression": "ends_with(str, 'SStr')", + "result": false + }, + { + "expression": "ends_with(str, 'foo')", + "result": false + }, + { + "expression": "ends_with(str, `0`)", + "error": "invalid-type" + }, + { + "expression": "floor(`1.2`)", + "result": 1 + }, + { + "expression": "floor('string')", + "error": "invalid-type" + }, + { + "expression": "floor(decimals[0])", + "result": 1 + }, + { + "expression": "floor(foo)", + "result": -1 + }, + { + "expression": "floor(str)", + "error": "invalid-type" + }, + { + "expression": "length('abc')", + "result": 3 + }, + { + "expression": "length('✓foo')", + "result": 4 + }, + { + "expression": "length('')", + "result": 0 + }, + { + "expression": "length(@)", + "result": 12 + }, + { + "expression": "length(strings[0])", + "result": 1 + }, + { + "expression": "length(str)", + "result": 3 + }, + { + "expression": "length(array)", + "result": 6 + }, + { + "expression": "length(objects)", + "result": 2 + }, + { + "expression": "length(`false`)", + "error": "invalid-type" + }, + { + "expression": "length(foo)", + "error": "invalid-type" + }, + { + "expression": "length(strings[0])", + "result": 1 + }, + { + "expression": "max(numbers)", + "result": 5 + }, + { + "expression": "max(decimals)", + "result": 1.2 + }, + { + "expression": "max(strings)", + "result": "c" + }, + { + "expression": "max(abc)", + "error": "invalid-type" + }, + { + "expression": "max(array)", + "error": "invalid-type" + }, + { + "expression": "max(decimals)", + "result": 1.2 + }, + { + "expression": "max(empty_list)", + "result": null + }, + { + "expression": "merge(`{}`)", + "result": {} + }, + { + "expression": "merge(`{}`, `{}`)", + "result": {} + }, + { + "expression": "merge(`{\"a\": 1}`, `{\"b\": 2}`)", + "result": {"a": 1, "b": 2} + }, + { + "expression": "merge(`{\"a\": 1}`, `{\"a\": 2}`)", + "result": {"a": 2} + }, + { + "expression": "merge(`{\"a\": 1, \"b\": 2}`, `{\"a\": 2, \"c\": 3}`, `{\"d\": 4}`)", + "result": {"a": 2, "b": 2, "c": 3, "d": 4} + }, + { + "expression": "min(numbers)", + "result": -1 + }, + { + "expression": "min(decimals)", + "result": -1.5 + }, + { + "expression": "min(abc)", + "error": "invalid-type" + }, + { + "expression": "min(array)", + "error": "invalid-type" + }, + { + "expression": "min(empty_list)", + "result": null + }, + { + "expression": "min(decimals)", + "result": -1.5 + }, + { + "expression": "min(strings)", + "result": "a" + }, + { + "expression": "type('abc')", + "result": "string" + }, + { + "expression": "type(`1.0`)", + "result": "number" + }, + { + "expression": "type(`2`)", + "result": "number" + }, + { + "expression": "type(`true`)", + "result": "boolean" + }, + { + "expression": "type(`false`)", + "result": "boolean" + }, + { + "expression": "type(`null`)", + "result": "null" + }, + { + "expression": "type(`[0]`)", + "result": "array" + }, + { + "expression": "type(`{\"a\": \"b\"}`)", + "result": "object" + }, + { + "expression": "type(@)", + "result": "object" + }, + { + "expression": "sort(keys(objects))", + "result": ["bar", "foo"] + }, + { + "expression": "keys(foo)", + "error": "invalid-type" + }, + { + "expression": "keys(strings)", + "error": "invalid-type" + }, + { + "expression": "keys(`false`)", + "error": "invalid-type" + }, + { + "expression": "sort(values(objects))", + "result": ["bar", "baz"] + }, + { + "expression": "keys(empty_hash)", + "result": [] + }, + { + "expression": "values(foo)", + "error": "invalid-type" + }, + { + "expression": "join(', ', strings)", + "result": "a, b, c" + }, + { + "expression": "join(', ', strings)", + "result": "a, b, c" + }, + { + "expression": "join(',', `[\"a\", \"b\"]`)", + "result": "a,b" + }, + { + "expression": "join(',', `[\"a\", 0]`)", + "error": "invalid-type" + }, + { + "expression": "join(', ', str)", + "error": "invalid-type" + }, + { + "expression": "join('|', strings)", + "result": "a|b|c" + }, + { + "expression": "join(`2`, strings)", + "error": "invalid-type" + }, + { + "expression": "join('|', decimals)", + "error": "invalid-type" + }, + { + "expression": "join('|', decimals[].to_string(@))", + "result": "1.01|1.2|-1.5" + }, + { + "expression": "join('|', empty_list)", + "result": "" + }, + { + "expression": "reverse(numbers)", + "result": [5, 4, 3, -1] + }, + { + "expression": "reverse(array)", + "result": ["100", "a", 5, 4, 3, -1] + }, + { + "expression": "reverse(`[]`)", + "result": [] + }, + { + "expression": "reverse('')", + "result": "" + }, + { + "expression": "reverse('hello world')", + "result": "dlrow olleh" + }, + { + "expression": "starts_with(str, 'S')", + "result": true + }, + { + "expression": "starts_with(str, 'St')", + "result": true + }, + { + "expression": "starts_with(str, 'Str')", + "result": true + }, + { + "expression": "starts_with(str, 'String')", + "result": false + }, + { + "expression": "starts_with(str, `0`)", + "error": "invalid-type" + }, + { + "expression": "sum(numbers)", + "result": 11 + }, + { + "expression": "sum(decimals)", + "result": 0.71 + }, + { + "expression": "sum(array)", + "error": "invalid-type" + }, + { + "expression": "sum(array[].to_number(@))", + "result": 111 + }, + { + "expression": "sum(`[]`)", + "result": 0 + }, + { + "expression": "to_array('foo')", + "result": ["foo"] + }, + { + "expression": "to_array(`0`)", + "result": [0] + }, + { + "expression": "to_array(objects)", + "result": [{"foo": "bar", "bar": "baz"}] + }, + { + "expression": "to_array(`[1, 2, 3]`)", + "result": [1, 2, 3] + }, + { + "expression": "to_array(false)", + "result": [false] + }, + { + "expression": "to_string('foo')", + "result": "foo" + }, + { + "expression": "to_string(`1.2`)", + "result": "1.2" + }, + { + "expression": "to_string(`[0, 1]`)", + "result": "[0,1]" + }, + { + "expression": "to_number('1.0')", + "result": 1.0 + }, + { + "expression": "to_number('1.1')", + "result": 1.1 + }, + { + "expression": "to_number('4')", + "result": 4 + }, + { + "expression": "to_number('notanumber')", + "result": null + }, + { + "expression": "to_number(`false`)", + "result": null + }, + { + "expression": "to_number(`null`)", + "result": null + }, + { + "expression": "to_number(`[0]`)", + "result": null + }, + { + "expression": "to_number(`{\"foo\": 0}`)", + "result": null + }, + { + "expression": "\"to_string\"(`1.0`)", + "error": "syntax" + }, + { + "expression": "sort(numbers)", + "result": [-1, 3, 4, 5] + }, + { + "expression": "sort(strings)", + "result": ["a", "b", "c"] + }, + { + "expression": "sort(decimals)", + "result": [-1.5, 1.01, 1.2] + }, + { + "expression": "sort(array)", + "error": "invalid-type" + }, + { + "expression": "sort(abc)", + "error": "invalid-type" + }, + { + "expression": "sort(empty_list)", + "result": [] + }, + { + "expression": "sort(@)", + "error": "invalid-type" + }, + { + "expression": "not_null(unknown_key, str)", + "result": "Str" + }, + { + "expression": "not_null(unknown_key, foo.bar, empty_list, str)", + "result": [] + }, + { + "expression": "not_null(unknown_key, null_key, empty_list, str)", + "result": [] + }, + { + "expression": "not_null(all, expressions, are_null)", + "result": null + }, + { + "expression": "not_null()", + "error": "invalid-arity" + }, + { + "description": "function projection on single arg function", + "expression": "numbers[].to_string(@)", + "result": ["-1", "3", "4", "5"] + }, + { + "description": "function projection on single arg function", + "expression": "array[].to_number(@)", + "result": [-1, 3, 4, 5, 100] + } + ] +}, { + "given": + { + "foo": [ + {"b": "b", "a": "a"}, + {"c": "c", "b": "b"}, + {"d": "d", "c": "c"}, + {"e": "e", "d": "d"}, + {"f": "f", "e": "e"} + ] + }, + "cases": [ + { + "description": "function projection on variadic function", + "expression": "foo[].not_null(f, e, d, c, b, a)", + "result": ["b", "c", "d", "e", "f"] + } + ] +}, { + "given": + { + "people": [ + {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"}, + {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"}, + {"age": 30, "age_str": "30", "bool": true, "name": "c"}, + {"age": 50, "age_str": "50", "bool": false, "name": "d"}, + {"age": 10, "age_str": "10", "bool": true, "name": 3} + ] + }, + "cases": [ + { + "description": "sort by field expression", + "expression": "sort_by(people, &age)", + "result": [ + {"age": 10, "age_str": "10", "bool": true, "name": 3}, + {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"}, + {"age": 30, "age_str": "30", "bool": true, "name": "c"}, + {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"}, + {"age": 50, "age_str": "50", "bool": false, "name": "d"} + ] + }, + { + "expression": "sort_by(people, &age_str)", + "result": [ + {"age": 10, "age_str": "10", "bool": true, "name": 3}, + {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"}, + {"age": 30, "age_str": "30", "bool": true, "name": "c"}, + {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"}, + {"age": 50, "age_str": "50", "bool": false, "name": "d"} + ] + }, + { + "description": "sort by function expression", + "expression": "sort_by(people, &to_number(age_str))", + "result": [ + {"age": 10, "age_str": "10", "bool": true, "name": 3}, + {"age": 20, "age_str": "20", "bool": true, "name": "a", "extra": "foo"}, + {"age": 30, "age_str": "30", "bool": true, "name": "c"}, + {"age": 40, "age_str": "40", "bool": false, "name": "b", "extra": "bar"}, + {"age": 50, "age_str": "50", "bool": false, "name": "d"} + ] + }, + { + "description": "function projection on sort_by function", + "expression": "sort_by(people, &age)[].name", + "result": [3, "a", "c", "b", "d"] + }, + { + "expression": "sort_by(people, &extra)", + "error": "invalid-type" + }, + { + "expression": "sort_by(people, &bool)", + "error": "invalid-type" + }, + { + "expression": "sort_by(people, &name)", + "error": "invalid-type" + }, + { + "expression": "sort_by(people, name)", + "error": "invalid-type" + }, + { + "expression": "sort_by(people, &age)[].extra", + "result": ["foo", "bar"] + }, + { + "expression": "sort_by(`[]`, &age)", + "result": [] + }, + { + "expression": "max_by(people, &age)", + "result": {"age": 50, "age_str": "50", "bool": false, "name": "d"} + }, + { + "expression": "max_by(people, &age_str)", + "result": {"age": 50, "age_str": "50", "bool": false, "name": "d"} + }, + { + "expression": "max_by(people, &bool)", + "error": "invalid-type" + }, + { + "expression": "max_by(people, &extra)", + "error": "invalid-type" + }, + { + "expression": "max_by(people, &to_number(age_str))", + "result": {"age": 50, "age_str": "50", "bool": false, "name": "d"} + }, + { + "expression": "min_by(people, &age)", + "result": {"age": 10, "age_str": "10", "bool": true, "name": 3} + }, + { + "expression": "min_by(people, &age_str)", + "result": {"age": 10, "age_str": "10", "bool": true, "name": 3} + }, + { + "expression": "min_by(people, &bool)", + "error": "invalid-type" + }, + { + "expression": "min_by(people, &extra)", + "error": "invalid-type" + }, + { + "expression": "min_by(people, &to_number(age_str))", + "result": {"age": 10, "age_str": "10", "bool": true, "name": 3} + } + ] +}, { + "given": + { + "people": [ + {"age": 10, "order": "1"}, + {"age": 10, "order": "2"}, + {"age": 10, "order": "3"}, + {"age": 10, "order": "4"}, + {"age": 10, "order": "5"}, + {"age": 10, "order": "6"}, + {"age": 10, "order": "7"}, + {"age": 10, "order": "8"}, + {"age": 10, "order": "9"}, + {"age": 10, "order": "10"}, + {"age": 10, "order": "11"} + ] + }, + "cases": [ + { + "description": "stable sort order", + "expression": "sort_by(people, &age)", + "result": [ + {"age": 10, "order": "1"}, + {"age": 10, "order": "2"}, + {"age": 10, "order": "3"}, + {"age": 10, "order": "4"}, + {"age": 10, "order": "5"}, + {"age": 10, "order": "6"}, + {"age": 10, "order": "7"}, + {"age": 10, "order": "8"}, + {"age": 10, "order": "9"}, + {"age": 10, "order": "10"}, + {"age": 10, "order": "11"} + ] + } + ] +}, { + "given": + { + "people": [ + {"a": 10, "b": 1, "c": "z"}, + {"a": 10, "b": 2, "c": null}, + {"a": 10, "b": 3}, + {"a": 10, "b": 4, "c": "z"}, + {"a": 10, "b": 5, "c": null}, + {"a": 10, "b": 6}, + {"a": 10, "b": 7, "c": "z"}, + {"a": 10, "b": 8, "c": null}, + {"a": 10, "b": 9} + ], + "empty": [] + }, + "cases": [ + { + "expression": "map(&a, people)", + "result": [10, 10, 10, 10, 10, 10, 10, 10, 10] + }, + { + "expression": "map(&c, people)", + "result": ["z", null, null, "z", null, null, "z", null, null] + }, + { + "expression": "map(&a, badkey)", + "error": "invalid-type" + }, + { + "expression": "map(&foo, empty)", + "result": [] + } + ] +}, { + "given": { + "array": [ + { + "foo": {"bar": "yes1"} + }, + { + "foo": {"bar": "yes2"} + }, + { + "foo1": {"bar": "no"} + } + ]}, + "cases": [ + { + "expression": "map(&foo.bar, array)", + "result": ["yes1", "yes2", null] + }, + { + "expression": "map(&foo1.bar, array)", + "result": [null, null, "no"] + }, + { + "expression": "map(&foo.bar.baz, array)", + "result": [null, null, null] + } + ] +}, { + "given": { + "array": [[1, 2, 3, [4]], [5, 6, 7, [8, 9]]] + }, + "cases": [ + { + "expression": "map(&[], array)", + "result": [[1, 2, 3, 4], [5, 6, 7, 8, 9]] + } + ] +} +] diff --git a/node_modules/jmespath/test/compliance/identifiers.json b/node_modules/jmespath/test/compliance/identifiers.json new file mode 100644 index 0000000..7998a41 --- /dev/null +++ b/node_modules/jmespath/test/compliance/identifiers.json @@ -0,0 +1,1377 @@ +[ + { + "given": { + "__L": true + }, + "cases": [ + { + "expression": "__L", + "result": true + } + ] + }, + { + "given": { + "!\r": true + }, + "cases": [ + { + "expression": "\"!\\r\"", + "result": true + } + ] + }, + { + "given": { + "Y_1623": true + }, + "cases": [ + { + "expression": "Y_1623", + "result": true + } + ] + }, + { + "given": { + "x": true + }, + "cases": [ + { + "expression": "x", + "result": true + } + ] + }, + { + "given": { + "\tF\uCebb": true + }, + "cases": [ + { + "expression": "\"\\tF\\uCebb\"", + "result": true + } + ] + }, + { + "given": { + " \t": true + }, + "cases": [ + { + "expression": "\" \\t\"", + "result": true + } + ] + }, + { + "given": { + " ": true + }, + "cases": [ + { + "expression": "\" \"", + "result": true + } + ] + }, + { + "given": { + "v2": true + }, + "cases": [ + { + "expression": "v2", + "result": true + } + ] + }, + { + "given": { + "\t": true + }, + "cases": [ + { + "expression": "\"\\t\"", + "result": true + } + ] + }, + { + "given": { + "_X": true + }, + "cases": [ + { + "expression": "_X", + "result": true + } + ] + }, + { + "given": { + "\t4\ud9da\udd15": true + }, + "cases": [ + { + "expression": "\"\\t4\\ud9da\\udd15\"", + "result": true + } + ] + }, + { + "given": { + "v24_W": true + }, + "cases": [ + { + "expression": "v24_W", + "result": true + } + ] + }, + { + "given": { + "H": true + }, + "cases": [ + { + "expression": "\"H\"", + "result": true + } + ] + }, + { + "given": { + "\f": true + }, + "cases": [ + { + "expression": "\"\\f\"", + "result": true + } + ] + }, + { + "given": { + "E4": true + }, + "cases": [ + { + "expression": "\"E4\"", + "result": true + } + ] + }, + { + "given": { + "!": true + }, + "cases": [ + { + "expression": "\"!\"", + "result": true + } + ] + }, + { + "given": { + "tM": true + }, + "cases": [ + { + "expression": "tM", + "result": true + } + ] + }, + { + "given": { + " [": true + }, + "cases": [ + { + "expression": "\" [\"", + "result": true + } + ] + }, + { + "given": { + "R!": true + }, + "cases": [ + { + "expression": "\"R!\"", + "result": true + } + ] + }, + { + "given": { + "_6W": true + }, + "cases": [ + { + "expression": "_6W", + "result": true + } + ] + }, + { + "given": { + "\uaBA1\r": true + }, + "cases": [ + { + "expression": "\"\\uaBA1\\r\"", + "result": true + } + ] + }, + { + "given": { + "tL7": true + }, + "cases": [ + { + "expression": "tL7", + "result": true + } + ] + }, + { + "given": { + "<": true + }, + "cases": [ + { + "expression": "\">\"", + "result": true + } + ] + }, + { + "given": { + "hvu": true + }, + "cases": [ + { + "expression": "hvu", + "result": true + } + ] + }, + { + "given": { + "; !": true + }, + "cases": [ + { + "expression": "\"; !\"", + "result": true + } + ] + }, + { + "given": { + "hU": true + }, + "cases": [ + { + "expression": "hU", + "result": true + } + ] + }, + { + "given": { + "!I\n\/": true + }, + "cases": [ + { + "expression": "\"!I\\n\\/\"", + "result": true + } + ] + }, + { + "given": { + "\uEEbF": true + }, + "cases": [ + { + "expression": "\"\\uEEbF\"", + "result": true + } + ] + }, + { + "given": { + "U)\t": true + }, + "cases": [ + { + "expression": "\"U)\\t\"", + "result": true + } + ] + }, + { + "given": { + "fa0_9": true + }, + "cases": [ + { + "expression": "fa0_9", + "result": true + } + ] + }, + { + "given": { + "/": true + }, + "cases": [ + { + "expression": "\"/\"", + "result": true + } + ] + }, + { + "given": { + "Gy": true + }, + "cases": [ + { + "expression": "Gy", + "result": true + } + ] + }, + { + "given": { + "\b": true + }, + "cases": [ + { + "expression": "\"\\b\"", + "result": true + } + ] + }, + { + "given": { + "<": true + }, + "cases": [ + { + "expression": "\"<\"", + "result": true + } + ] + }, + { + "given": { + "\t": true + }, + "cases": [ + { + "expression": "\"\\t\"", + "result": true + } + ] + }, + { + "given": { + "\t&\\\r": true + }, + "cases": [ + { + "expression": "\"\\t&\\\\\\r\"", + "result": true + } + ] + }, + { + "given": { + "#": true + }, + "cases": [ + { + "expression": "\"#\"", + "result": true + } + ] + }, + { + "given": { + "B__": true + }, + "cases": [ + { + "expression": "B__", + "result": true + } + ] + }, + { + "given": { + "\nS \n": true + }, + "cases": [ + { + "expression": "\"\\nS \\n\"", + "result": true + } + ] + }, + { + "given": { + "Bp": true + }, + "cases": [ + { + "expression": "Bp", + "result": true + } + ] + }, + { + "given": { + ",\t;": true + }, + "cases": [ + { + "expression": "\",\\t;\"", + "result": true + } + ] + }, + { + "given": { + "B_q": true + }, + "cases": [ + { + "expression": "B_q", + "result": true + } + ] + }, + { + "given": { + "\/+\t\n\b!Z": true + }, + "cases": [ + { + "expression": "\"\\/+\\t\\n\\b!Z\"", + "result": true + } + ] + }, + { + "given": { + "\udadd\udfc7\\ueFAc": true + }, + "cases": [ + { + "expression": "\"\udadd\udfc7\\\\ueFAc\"", + "result": true + } + ] + }, + { + "given": { + ":\f": true + }, + "cases": [ + { + "expression": "\":\\f\"", + "result": true + } + ] + }, + { + "given": { + "\/": true + }, + "cases": [ + { + "expression": "\"\\/\"", + "result": true + } + ] + }, + { + "given": { + "_BW_6Hg_Gl": true + }, + "cases": [ + { + "expression": "_BW_6Hg_Gl", + "result": true + } + ] + }, + { + "given": { + "\udbcf\udc02": true + }, + "cases": [ + { + "expression": "\"\udbcf\udc02\"", + "result": true + } + ] + }, + { + "given": { + "zs1DC": true + }, + "cases": [ + { + "expression": "zs1DC", + "result": true + } + ] + }, + { + "given": { + "__434": true + }, + "cases": [ + { + "expression": "__434", + "result": true + } + ] + }, + { + "given": { + "\udb94\udd41": true + }, + "cases": [ + { + "expression": "\"\udb94\udd41\"", + "result": true + } + ] + }, + { + "given": { + "Z_5": true + }, + "cases": [ + { + "expression": "Z_5", + "result": true + } + ] + }, + { + "given": { + "z_M_": true + }, + "cases": [ + { + "expression": "z_M_", + "result": true + } + ] + }, + { + "given": { + "YU_2": true + }, + "cases": [ + { + "expression": "YU_2", + "result": true + } + ] + }, + { + "given": { + "_0": true + }, + "cases": [ + { + "expression": "_0", + "result": true + } + ] + }, + { + "given": { + "\b+": true + }, + "cases": [ + { + "expression": "\"\\b+\"", + "result": true + } + ] + }, + { + "given": { + "\"": true + }, + "cases": [ + { + "expression": "\"\\\"\"", + "result": true + } + ] + }, + { + "given": { + "D7": true + }, + "cases": [ + { + "expression": "D7", + "result": true + } + ] + }, + { + "given": { + "_62L": true + }, + "cases": [ + { + "expression": "_62L", + "result": true + } + ] + }, + { + "given": { + "\tK\t": true + }, + "cases": [ + { + "expression": "\"\\tK\\t\"", + "result": true + } + ] + }, + { + "given": { + "\n\\\f": true + }, + "cases": [ + { + "expression": "\"\\n\\\\\\f\"", + "result": true + } + ] + }, + { + "given": { + "I_": true + }, + "cases": [ + { + "expression": "I_", + "result": true + } + ] + }, + { + "given": { + "W_a0_": true + }, + "cases": [ + { + "expression": "W_a0_", + "result": true + } + ] + }, + { + "given": { + "BQ": true + }, + "cases": [ + { + "expression": "BQ", + "result": true + } + ] + }, + { + "given": { + "\tX$\uABBb": true + }, + "cases": [ + { + "expression": "\"\\tX$\\uABBb\"", + "result": true + } + ] + }, + { + "given": { + "Z9": true + }, + "cases": [ + { + "expression": "Z9", + "result": true + } + ] + }, + { + "given": { + "\b%\"\uda38\udd0f": true + }, + "cases": [ + { + "expression": "\"\\b%\\\"\uda38\udd0f\"", + "result": true + } + ] + }, + { + "given": { + "_F": true + }, + "cases": [ + { + "expression": "_F", + "result": true + } + ] + }, + { + "given": { + "!,": true + }, + "cases": [ + { + "expression": "\"!,\"", + "result": true + } + ] + }, + { + "given": { + "\"!": true + }, + "cases": [ + { + "expression": "\"\\\"!\"", + "result": true + } + ] + }, + { + "given": { + "Hh": true + }, + "cases": [ + { + "expression": "Hh", + "result": true + } + ] + }, + { + "given": { + "&": true + }, + "cases": [ + { + "expression": "\"&\"", + "result": true + } + ] + }, + { + "given": { + "9\r\\R": true + }, + "cases": [ + { + "expression": "\"9\\r\\\\R\"", + "result": true + } + ] + }, + { + "given": { + "M_k": true + }, + "cases": [ + { + "expression": "M_k", + "result": true + } + ] + }, + { + "given": { + "!\b\n\udb06\ude52\"\"": true + }, + "cases": [ + { + "expression": "\"!\\b\\n\udb06\ude52\\\"\\\"\"", + "result": true + } + ] + }, + { + "given": { + "6": true + }, + "cases": [ + { + "expression": "\"6\"", + "result": true + } + ] + }, + { + "given": { + "_7": true + }, + "cases": [ + { + "expression": "_7", + "result": true + } + ] + }, + { + "given": { + "0": true + }, + "cases": [ + { + "expression": "\"0\"", + "result": true + } + ] + }, + { + "given": { + "\\8\\": true + }, + "cases": [ + { + "expression": "\"\\\\8\\\\\"", + "result": true + } + ] + }, + { + "given": { + "b7eo": true + }, + "cases": [ + { + "expression": "b7eo", + "result": true + } + ] + }, + { + "given": { + "xIUo9": true + }, + "cases": [ + { + "expression": "xIUo9", + "result": true + } + ] + }, + { + "given": { + "5": true + }, + "cases": [ + { + "expression": "\"5\"", + "result": true + } + ] + }, + { + "given": { + "?": true + }, + "cases": [ + { + "expression": "\"?\"", + "result": true + } + ] + }, + { + "given": { + "sU": true + }, + "cases": [ + { + "expression": "sU", + "result": true + } + ] + }, + { + "given": { + "VH2&H\\\/": true + }, + "cases": [ + { + "expression": "\"VH2&H\\\\\\/\"", + "result": true + } + ] + }, + { + "given": { + "_C": true + }, + "cases": [ + { + "expression": "_C", + "result": true + } + ] + }, + { + "given": { + "_": true + }, + "cases": [ + { + "expression": "_", + "result": true + } + ] + }, + { + "given": { + "<\t": true + }, + "cases": [ + { + "expression": "\"<\\t\"", + "result": true + } + ] + }, + { + "given": { + "\uD834\uDD1E": true + }, + "cases": [ + { + "expression": "\"\\uD834\\uDD1E\"", + "result": true + } + ] + } +] diff --git a/node_modules/jmespath/test/compliance/indices.json b/node_modules/jmespath/test/compliance/indices.json new file mode 100644 index 0000000..aa03b35 --- /dev/null +++ b/node_modules/jmespath/test/compliance/indices.json @@ -0,0 +1,346 @@ +[{ + "given": + {"foo": {"bar": ["zero", "one", "two"]}}, + "cases": [ + { + "expression": "foo.bar[0]", + "result": "zero" + }, + { + "expression": "foo.bar[1]", + "result": "one" + }, + { + "expression": "foo.bar[2]", + "result": "two" + }, + { + "expression": "foo.bar[3]", + "result": null + }, + { + "expression": "foo.bar[-1]", + "result": "two" + }, + { + "expression": "foo.bar[-2]", + "result": "one" + }, + { + "expression": "foo.bar[-3]", + "result": "zero" + }, + { + "expression": "foo.bar[-4]", + "result": null + } + ] +}, +{ + "given": + {"foo": [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}]}, + "cases": [ + { + "expression": "foo.bar", + "result": null + }, + { + "expression": "foo[0].bar", + "result": "one" + }, + { + "expression": "foo[1].bar", + "result": "two" + }, + { + "expression": "foo[2].bar", + "result": "three" + }, + { + "expression": "foo[3].notbar", + "result": "four" + }, + { + "expression": "foo[3].bar", + "result": null + }, + { + "expression": "foo[0]", + "result": {"bar": "one"} + }, + { + "expression": "foo[1]", + "result": {"bar": "two"} + }, + { + "expression": "foo[2]", + "result": {"bar": "three"} + }, + { + "expression": "foo[3]", + "result": {"notbar": "four"} + }, + { + "expression": "foo[4]", + "result": null + } + ] +}, +{ + "given": [ + "one", "two", "three" + ], + "cases": [ + { + "expression": "[0]", + "result": "one" + }, + { + "expression": "[1]", + "result": "two" + }, + { + "expression": "[2]", + "result": "three" + }, + { + "expression": "[-1]", + "result": "three" + }, + { + "expression": "[-2]", + "result": "two" + }, + { + "expression": "[-3]", + "result": "one" + } + ] +}, +{ + "given": {"reservations": [ + {"instances": [{"foo": 1}, {"foo": 2}]} + ]}, + "cases": [ + { + "expression": "reservations[].instances[].foo", + "result": [1, 2] + }, + { + "expression": "reservations[].instances[].bar", + "result": [] + }, + { + "expression": "reservations[].notinstances[].foo", + "result": [] + }, + { + "expression": "reservations[].notinstances[].foo", + "result": [] + } + ] +}, +{ + "given": {"reservations": [{ + "instances": [ + {"foo": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]}, + {"foo": [{"bar": 5}, {"bar": 6}, {"notbar": [7]}, {"bar": 8}]}, + {"foo": "bar"}, + {"notfoo": [{"bar": 20}, {"bar": 21}, {"notbar": [7]}, {"bar": 22}]}, + {"bar": [{"baz": [1]}, {"baz": [2]}, {"baz": [3]}, {"baz": [4]}]}, + {"baz": [{"baz": [1, 2]}, {"baz": []}, {"baz": []}, {"baz": [3, 4]}]}, + {"qux": [{"baz": []}, {"baz": [1, 2, 3]}, {"baz": [4]}, {"baz": []}]} + ], + "otherkey": {"foo": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]} + }, { + "instances": [ + {"a": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]}, + {"b": [{"bar": 5}, {"bar": 6}, {"notbar": [7]}, {"bar": 8}]}, + {"c": "bar"}, + {"notfoo": [{"bar": 23}, {"bar": 24}, {"notbar": [7]}, {"bar": 25}]}, + {"qux": [{"baz": []}, {"baz": [1, 2, 3]}, {"baz": [4]}, {"baz": []}]} + ], + "otherkey": {"foo": [{"bar": 1}, {"bar": 2}, {"notbar": 3}, {"bar": 4}]} + } + ]}, + "cases": [ + { + "expression": "reservations[].instances[].foo[].bar", + "result": [1, 2, 4, 5, 6, 8] + }, + { + "expression": "reservations[].instances[].foo[].baz", + "result": [] + }, + { + "expression": "reservations[].instances[].notfoo[].bar", + "result": [20, 21, 22, 23, 24, 25] + }, + { + "expression": "reservations[].instances[].notfoo[].notbar", + "result": [[7], [7]] + }, + { + "expression": "reservations[].notinstances[].foo", + "result": [] + }, + { + "expression": "reservations[].instances[].foo[].notbar", + "result": [3, [7]] + }, + { + "expression": "reservations[].instances[].bar[].baz", + "result": [[1], [2], [3], [4]] + }, + { + "expression": "reservations[].instances[].baz[].baz", + "result": [[1, 2], [], [], [3, 4]] + }, + { + "expression": "reservations[].instances[].qux[].baz", + "result": [[], [1, 2, 3], [4], [], [], [1, 2, 3], [4], []] + }, + { + "expression": "reservations[].instances[].qux[].baz[]", + "result": [1, 2, 3, 4, 1, 2, 3, 4] + } + ] +}, +{ + "given": { + "foo": [ + [["one", "two"], ["three", "four"]], + [["five", "six"], ["seven", "eight"]], + [["nine"], ["ten"]] + ] + }, + "cases": [ + { + "expression": "foo[]", + "result": [["one", "two"], ["three", "four"], ["five", "six"], + ["seven", "eight"], ["nine"], ["ten"]] + }, + { + "expression": "foo[][0]", + "result": ["one", "three", "five", "seven", "nine", "ten"] + }, + { + "expression": "foo[][1]", + "result": ["two", "four", "six", "eight"] + }, + { + "expression": "foo[][0][0]", + "result": [] + }, + { + "expression": "foo[][2][2]", + "result": [] + }, + { + "expression": "foo[][0][0][100]", + "result": [] + } + ] +}, +{ + "given": { + "foo": [{ + "bar": [ + { + "qux": 2, + "baz": 1 + }, + { + "qux": 4, + "baz": 3 + } + ] + }, + { + "bar": [ + { + "qux": 6, + "baz": 5 + }, + { + "qux": 8, + "baz": 7 + } + ] + } + ] + }, + "cases": [ + { + "expression": "foo", + "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]}, + {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}] + }, + { + "expression": "foo[]", + "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]}, + {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}] + }, + { + "expression": "foo[].bar", + "result": [[{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}], + [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]] + }, + { + "expression": "foo[].bar[]", + "result": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}, + {"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}] + }, + { + "expression": "foo[].bar[].baz", + "result": [1, 3, 5, 7] + } + ] +}, +{ + "given": { + "string": "string", + "hash": {"foo": "bar", "bar": "baz"}, + "number": 23, + "nullvalue": null + }, + "cases": [ + { + "expression": "string[]", + "result": null + }, + { + "expression": "hash[]", + "result": null + }, + { + "expression": "number[]", + "result": null + }, + { + "expression": "nullvalue[]", + "result": null + }, + { + "expression": "string[].foo", + "result": null + }, + { + "expression": "hash[].foo", + "result": null + }, + { + "expression": "number[].foo", + "result": null + }, + { + "expression": "nullvalue[].foo", + "result": null + }, + { + "expression": "nullvalue[].foo[].bar", + "result": null + } + ] +} +] diff --git a/node_modules/jmespath/test/compliance/literal.json b/node_modules/jmespath/test/compliance/literal.json new file mode 100644 index 0000000..b796d36 --- /dev/null +++ b/node_modules/jmespath/test/compliance/literal.json @@ -0,0 +1,190 @@ +[ + { + "given": { + "foo": [{"name": "a"}, {"name": "b"}], + "bar": {"baz": "qux"} + }, + "cases": [ + { + "expression": "`\"foo\"`", + "result": "foo" + }, + { + "comment": "Interpret escaped unicode.", + "expression": "`\"\\u03a6\"`", + "result": "Φ" + }, + { + "expression": "`\"✓\"`", + "result": "✓" + }, + { + "expression": "`[1, 2, 3]`", + "result": [1, 2, 3] + }, + { + "expression": "`{\"a\": \"b\"}`", + "result": {"a": "b"} + }, + { + "expression": "`true`", + "result": true + }, + { + "expression": "`false`", + "result": false + }, + { + "expression": "`null`", + "result": null + }, + { + "expression": "`0`", + "result": 0 + }, + { + "expression": "`1`", + "result": 1 + }, + { + "expression": "`2`", + "result": 2 + }, + { + "expression": "`3`", + "result": 3 + }, + { + "expression": "`4`", + "result": 4 + }, + { + "expression": "`5`", + "result": 5 + }, + { + "expression": "`6`", + "result": 6 + }, + { + "expression": "`7`", + "result": 7 + }, + { + "expression": "`8`", + "result": 8 + }, + { + "expression": "`9`", + "result": 9 + }, + { + "comment": "Escaping a backtick in quotes", + "expression": "`\"foo\\`bar\"`", + "result": "foo`bar" + }, + { + "comment": "Double quote in literal", + "expression": "`\"foo\\\"bar\"`", + "result": "foo\"bar" + }, + { + "expression": "`\"1\\`\"`", + "result": "1`" + }, + { + "comment": "Multiple literal expressions with escapes", + "expression": "`\"\\\\\"`.{a:`\"b\"`}", + "result": {"a": "b"} + }, + { + "comment": "literal . identifier", + "expression": "`{\"a\": \"b\"}`.a", + "result": "b" + }, + { + "comment": "literal . identifier . identifier", + "expression": "`{\"a\": {\"b\": \"c\"}}`.a.b", + "result": "c" + }, + { + "comment": "literal . identifier bracket-expr", + "expression": "`[0, 1, 2]`[1]", + "result": 1 + } + ] + }, + { + "comment": "Literals", + "given": {"type": "object"}, + "cases": [ + { + "comment": "Literal with leading whitespace", + "expression": "` {\"foo\": true}`", + "result": {"foo": true} + }, + { + "comment": "Literal with trailing whitespace", + "expression": "`{\"foo\": true} `", + "result": {"foo": true} + }, + { + "comment": "Literal on RHS of subexpr not allowed", + "expression": "foo.`\"bar\"`", + "error": "syntax" + } + ] + }, + { + "comment": "Raw String Literals", + "given": {}, + "cases": [ + { + "expression": "'foo'", + "result": "foo" + }, + { + "expression": "' foo '", + "result": " foo " + }, + { + "expression": "'0'", + "result": "0" + }, + { + "expression": "'newline\n'", + "result": "newline\n" + }, + { + "expression": "'\n'", + "result": "\n" + }, + { + "expression": "'✓'", + "result": "✓" + }, + { + "expression": "'𝄞'", + "result": "𝄞" + }, + { + "expression": "' [foo] '", + "result": " [foo] " + }, + { + "expression": "'[foo]'", + "result": "[foo]" + }, + { + "comment": "Do not interpret escaped unicode.", + "expression": "'\\u03a6'", + "result": "\\u03a6" + }, + { + "comment": "Can escape the single quote", + "expression": "'foo\\'bar'", + "result": "foo'bar" + } + ] + } +] diff --git a/node_modules/jmespath/test/compliance/multiselect.json b/node_modules/jmespath/test/compliance/multiselect.json new file mode 100644 index 0000000..8f2a481 --- /dev/null +++ b/node_modules/jmespath/test/compliance/multiselect.json @@ -0,0 +1,393 @@ +[{ + "given": { + "foo": { + "bar": "bar", + "baz": "baz", + "qux": "qux", + "nested": { + "one": { + "a": "first", + "b": "second", + "c": "third" + }, + "two": { + "a": "first", + "b": "second", + "c": "third" + }, + "three": { + "a": "first", + "b": "second", + "c": {"inner": "third"} + } + } + }, + "bar": 1, + "baz": 2, + "qux\"": 3 + }, + "cases": [ + { + "expression": "foo.{bar: bar}", + "result": {"bar": "bar"} + }, + { + "expression": "foo.{\"bar\": bar}", + "result": {"bar": "bar"} + }, + { + "expression": "foo.{\"foo.bar\": bar}", + "result": {"foo.bar": "bar"} + }, + { + "expression": "foo.{bar: bar, baz: baz}", + "result": {"bar": "bar", "baz": "baz"} + }, + { + "expression": "foo.{\"bar\": bar, \"baz\": baz}", + "result": {"bar": "bar", "baz": "baz"} + }, + { + "expression": "{\"baz\": baz, \"qux\\\"\": \"qux\\\"\"}", + "result": {"baz": 2, "qux\"": 3} + }, + { + "expression": "foo.{bar:bar,baz:baz}", + "result": {"bar": "bar", "baz": "baz"} + }, + { + "expression": "foo.{bar: bar,qux: qux}", + "result": {"bar": "bar", "qux": "qux"} + }, + { + "expression": "foo.{bar: bar, noexist: noexist}", + "result": {"bar": "bar", "noexist": null} + }, + { + "expression": "foo.{noexist: noexist, alsonoexist: alsonoexist}", + "result": {"noexist": null, "alsonoexist": null} + }, + { + "expression": "foo.badkey.{nokey: nokey, alsonokey: alsonokey}", + "result": null + }, + { + "expression": "foo.nested.*.{a: a,b: b}", + "result": [{"a": "first", "b": "second"}, + {"a": "first", "b": "second"}, + {"a": "first", "b": "second"}] + }, + { + "expression": "foo.nested.three.{a: a, cinner: c.inner}", + "result": {"a": "first", "cinner": "third"} + }, + { + "expression": "foo.nested.three.{a: a, c: c.inner.bad.key}", + "result": {"a": "first", "c": null} + }, + { + "expression": "foo.{a: nested.one.a, b: nested.two.b}", + "result": {"a": "first", "b": "second"} + }, + { + "expression": "{bar: bar, baz: baz}", + "result": {"bar": 1, "baz": 2} + }, + { + "expression": "{bar: bar}", + "result": {"bar": 1} + }, + { + "expression": "{otherkey: bar}", + "result": {"otherkey": 1} + }, + { + "expression": "{no: no, exist: exist}", + "result": {"no": null, "exist": null} + }, + { + "expression": "foo.[bar]", + "result": ["bar"] + }, + { + "expression": "foo.[bar,baz]", + "result": ["bar", "baz"] + }, + { + "expression": "foo.[bar,qux]", + "result": ["bar", "qux"] + }, + { + "expression": "foo.[bar,noexist]", + "result": ["bar", null] + }, + { + "expression": "foo.[noexist,alsonoexist]", + "result": [null, null] + } + ] +}, { + "given": { + "foo": {"bar": 1, "baz": [2, 3, 4]} + }, + "cases": [ + { + "expression": "foo.{bar:bar,baz:baz}", + "result": {"bar": 1, "baz": [2, 3, 4]} + }, + { + "expression": "foo.[bar,baz[0]]", + "result": [1, 2] + }, + { + "expression": "foo.[bar,baz[1]]", + "result": [1, 3] + }, + { + "expression": "foo.[bar,baz[2]]", + "result": [1, 4] + }, + { + "expression": "foo.[bar,baz[3]]", + "result": [1, null] + }, + { + "expression": "foo.[bar[0],baz[3]]", + "result": [null, null] + } + ] +}, { + "given": { + "foo": {"bar": 1, "baz": 2} + }, + "cases": [ + { + "expression": "foo.{bar: bar, baz: baz}", + "result": {"bar": 1, "baz": 2} + }, + { + "expression": "foo.[bar,baz]", + "result": [1, 2] + } + ] +}, { + "given": { + "foo": { + "bar": {"baz": [{"common": "first", "one": 1}, + {"common": "second", "two": 2}]}, + "ignoreme": 1, + "includeme": true + } + }, + "cases": [ + { + "expression": "foo.{bar: bar.baz[1],includeme: includeme}", + "result": {"bar": {"common": "second", "two": 2}, "includeme": true} + }, + { + "expression": "foo.{\"bar.baz.two\": bar.baz[1].two, includeme: includeme}", + "result": {"bar.baz.two": 2, "includeme": true} + }, + { + "expression": "foo.[includeme, bar.baz[*].common]", + "result": [true, ["first", "second"]] + }, + { + "expression": "foo.[includeme, bar.baz[*].none]", + "result": [true, []] + }, + { + "expression": "foo.[includeme, bar.baz[].common]", + "result": [true, ["first", "second"]] + } + ] +}, { + "given": { + "reservations": [{ + "instances": [ + {"id": "id1", + "name": "first"}, + {"id": "id2", + "name": "second"} + ]}, { + "instances": [ + {"id": "id3", + "name": "third"}, + {"id": "id4", + "name": "fourth"} + ]} + ]}, + "cases": [ + { + "expression": "reservations[*].instances[*].{id: id, name: name}", + "result": [[{"id": "id1", "name": "first"}, {"id": "id2", "name": "second"}], + [{"id": "id3", "name": "third"}, {"id": "id4", "name": "fourth"}]] + }, + { + "expression": "reservations[].instances[].{id: id, name: name}", + "result": [{"id": "id1", "name": "first"}, + {"id": "id2", "name": "second"}, + {"id": "id3", "name": "third"}, + {"id": "id4", "name": "fourth"}] + }, + { + "expression": "reservations[].instances[].[id, name]", + "result": [["id1", "first"], + ["id2", "second"], + ["id3", "third"], + ["id4", "fourth"]] + } + ] +}, +{ + "given": { + "foo": [{ + "bar": [ + { + "qux": 2, + "baz": 1 + }, + { + "qux": 4, + "baz": 3 + } + ] + }, + { + "bar": [ + { + "qux": 6, + "baz": 5 + }, + { + "qux": 8, + "baz": 7 + } + ] + } + ] + }, + "cases": [ + { + "expression": "foo", + "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]}, + {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}] + }, + { + "expression": "foo[]", + "result": [{"bar": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}]}, + {"bar": [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]}] + }, + { + "expression": "foo[].bar", + "result": [[{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}], + [{"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}]] + }, + { + "expression": "foo[].bar[]", + "result": [{"qux": 2, "baz": 1}, {"qux": 4, "baz": 3}, + {"qux": 6, "baz": 5}, {"qux": 8, "baz": 7}] + }, + { + "expression": "foo[].bar[].[baz, qux]", + "result": [[1, 2], [3, 4], [5, 6], [7, 8]] + }, + { + "expression": "foo[].bar[].[baz]", + "result": [[1], [3], [5], [7]] + }, + { + "expression": "foo[].bar[].[baz, qux][]", + "result": [1, 2, 3, 4, 5, 6, 7, 8] + } + ] +}, +{ + "given": { + "foo": { + "baz": [ + { + "bar": "abc" + }, { + "bar": "def" + } + ], + "qux": ["zero"] + } + }, + "cases": [ + { + "expression": "foo.[baz[*].bar, qux[0]]", + "result": [["abc", "def"], "zero"] + } + ] +}, +{ + "given": { + "foo": { + "baz": [ + { + "bar": "a", + "bam": "b", + "boo": "c" + }, { + "bar": "d", + "bam": "e", + "boo": "f" + } + ], + "qux": ["zero"] + } + }, + "cases": [ + { + "expression": "foo.[baz[*].[bar, boo], qux[0]]", + "result": [[["a", "c" ], ["d", "f" ]], "zero"] + } + ] +}, +{ + "given": { + "foo": { + "baz": [ + { + "bar": "a", + "bam": "b", + "boo": "c" + }, { + "bar": "d", + "bam": "e", + "boo": "f" + } + ], + "qux": ["zero"] + } + }, + "cases": [ + { + "expression": "foo.[baz[*].not_there || baz[*].bar, qux[0]]", + "result": [["a", "d"], "zero"] + } + ] +}, +{ + "given": {"type": "object"}, + "cases": [ + { + "comment": "Nested multiselect", + "expression": "[[*],*]", + "result": [null, ["object"]] + } + ] +}, +{ + "given": [], + "cases": [ + { + "comment": "Nested multiselect", + "expression": "[[*]]", + "result": [[]] + } + ] +} +] diff --git a/node_modules/jmespath/test/compliance/pipe.json b/node_modules/jmespath/test/compliance/pipe.json new file mode 100644 index 0000000..b10c0a4 --- /dev/null +++ b/node_modules/jmespath/test/compliance/pipe.json @@ -0,0 +1,131 @@ +[{ + "given": { + "foo": { + "bar": { + "baz": "subkey" + }, + "other": { + "baz": "subkey" + }, + "other2": { + "baz": "subkey" + }, + "other3": { + "notbaz": ["a", "b", "c"] + }, + "other4": { + "notbaz": ["a", "b", "c"] + } + } + }, + "cases": [ + { + "expression": "foo.*.baz | [0]", + "result": "subkey" + }, + { + "expression": "foo.*.baz | [1]", + "result": "subkey" + }, + { + "expression": "foo.*.baz | [2]", + "result": "subkey" + }, + { + "expression": "foo.bar.* | [0]", + "result": "subkey" + }, + { + "expression": "foo.*.notbaz | [*]", + "result": [["a", "b", "c"], ["a", "b", "c"]] + }, + { + "expression": "{\"a\": foo.bar, \"b\": foo.other} | *.baz", + "result": ["subkey", "subkey"] + } + ] +}, { + "given": { + "foo": { + "bar": { + "baz": "one" + }, + "other": { + "baz": "two" + }, + "other2": { + "baz": "three" + }, + "other3": { + "notbaz": ["a", "b", "c"] + }, + "other4": { + "notbaz": ["d", "e", "f"] + } + } + }, + "cases": [ + { + "expression": "foo | bar", + "result": {"baz": "one"} + }, + { + "expression": "foo | bar | baz", + "result": "one" + }, + { + "expression": "foo|bar| baz", + "result": "one" + }, + { + "expression": "not_there | [0]", + "result": null + }, + { + "expression": "not_there | [0]", + "result": null + }, + { + "expression": "[foo.bar, foo.other] | [0]", + "result": {"baz": "one"} + }, + { + "expression": "{\"a\": foo.bar, \"b\": foo.other} | a", + "result": {"baz": "one"} + }, + { + "expression": "{\"a\": foo.bar, \"b\": foo.other} | b", + "result": {"baz": "two"} + }, + { + "expression": "foo.bam || foo.bar | baz", + "result": "one" + }, + { + "expression": "foo | not_there || bar", + "result": {"baz": "one"} + } + ] +}, { + "given": { + "foo": [{ + "bar": [{ + "baz": "one" + }, { + "baz": "two" + }] + }, { + "bar": [{ + "baz": "three" + }, { + "baz": "four" + }] + }] + }, + "cases": [ + { + "expression": "foo[*].bar[*] | [0][0]", + "result": {"baz": "one"} + } + ] +}] diff --git a/node_modules/jmespath/test/compliance/slice.json b/node_modules/jmespath/test/compliance/slice.json new file mode 100644 index 0000000..3594772 --- /dev/null +++ b/node_modules/jmespath/test/compliance/slice.json @@ -0,0 +1,187 @@ +[{ + "given": { + "foo": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], + "bar": { + "baz": 1 + } + }, + "cases": [ + { + "expression": "bar[0:10]", + "result": null + }, + { + "expression": "foo[0:10:1]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[0:10]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[0:10:]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[0::1]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[0::]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[0:]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[:10:1]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[::1]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[:10:]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[::]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[:]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[1:9]", + "result": [1, 2, 3, 4, 5, 6, 7, 8] + }, + { + "expression": "foo[0:10:2]", + "result": [0, 2, 4, 6, 8] + }, + { + "expression": "foo[5:]", + "result": [5, 6, 7, 8, 9] + }, + { + "expression": "foo[5::2]", + "result": [5, 7, 9] + }, + { + "expression": "foo[::2]", + "result": [0, 2, 4, 6, 8] + }, + { + "expression": "foo[::-1]", + "result": [9, 8, 7, 6, 5, 4, 3, 2, 1, 0] + }, + { + "expression": "foo[1::2]", + "result": [1, 3, 5, 7, 9] + }, + { + "expression": "foo[10:0:-1]", + "result": [9, 8, 7, 6, 5, 4, 3, 2, 1] + }, + { + "expression": "foo[10:5:-1]", + "result": [9, 8, 7, 6] + }, + { + "expression": "foo[8:2:-2]", + "result": [8, 6, 4] + }, + { + "expression": "foo[0:20]", + "result": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + }, + { + "expression": "foo[10:-20:-1]", + "result": [9, 8, 7, 6, 5, 4, 3, 2, 1, 0] + }, + { + "expression": "foo[10:-20]", + "result": [] + }, + { + "expression": "foo[-4:-1]", + "result": [6, 7, 8] + }, + { + "expression": "foo[:-5:-1]", + "result": [9, 8, 7, 6] + }, + { + "expression": "foo[8:2:0]", + "error": "invalid-value" + }, + { + "expression": "foo[8:2:0:1]", + "error": "syntax" + }, + { + "expression": "foo[8:2&]", + "error": "syntax" + }, + { + "expression": "foo[2:a:3]", + "error": "syntax" + } + ] +}, { + "given": { + "foo": [{"a": 1}, {"a": 2}, {"a": 3}], + "bar": [{"a": {"b": 1}}, {"a": {"b": 2}}, + {"a": {"b": 3}}], + "baz": 50 + }, + "cases": [ + { + "expression": "foo[:2].a", + "result": [1, 2] + }, + { + "expression": "foo[:2].b", + "result": [] + }, + { + "expression": "foo[:2].a.b", + "result": [] + }, + { + "expression": "bar[::-1].a.b", + "result": [3, 2, 1] + }, + { + "expression": "bar[:2].a.b", + "result": [1, 2] + }, + { + "expression": "baz[:2].a", + "result": null + } + ] +}, { + "given": [{"a": 1}, {"a": 2}, {"a": 3}], + "cases": [ + { + "expression": "[:]", + "result": [{"a": 1}, {"a": 2}, {"a": 3}] + }, + { + "expression": "[:2].a", + "result": [1, 2] + }, + { + "expression": "[::-1].a", + "result": [3, 2, 1] + }, + { + "expression": "[:2].b", + "result": [] + } + ] +}] diff --git a/node_modules/jmespath/test/compliance/syntax.json b/node_modules/jmespath/test/compliance/syntax.json new file mode 100644 index 0000000..003c294 --- /dev/null +++ b/node_modules/jmespath/test/compliance/syntax.json @@ -0,0 +1,616 @@ +[{ + "comment": "Dot syntax", + "given": {"type": "object"}, + "cases": [ + { + "expression": "foo.bar", + "result": null + }, + { + "expression": "foo.1", + "error": "syntax" + }, + { + "expression": "foo.-11", + "error": "syntax" + }, + { + "expression": "foo", + "result": null + }, + { + "expression": "foo.", + "error": "syntax" + }, + { + "expression": "foo.", + "error": "syntax" + }, + { + "expression": ".foo", + "error": "syntax" + }, + { + "expression": "foo..bar", + "error": "syntax" + }, + { + "expression": "foo.bar.", + "error": "syntax" + }, + { + "expression": "foo[.]", + "error": "syntax" + } + ] +}, + { + "comment": "Simple token errors", + "given": {"type": "object"}, + "cases": [ + { + "expression": ".", + "error": "syntax" + }, + { + "expression": ":", + "error": "syntax" + }, + { + "expression": ",", + "error": "syntax" + }, + { + "expression": "]", + "error": "syntax" + }, + { + "expression": "[", + "error": "syntax" + }, + { + "expression": "}", + "error": "syntax" + }, + { + "expression": "{", + "error": "syntax" + }, + { + "expression": ")", + "error": "syntax" + }, + { + "expression": "(", + "error": "syntax" + }, + { + "expression": "((&", + "error": "syntax" + }, + { + "expression": "a[", + "error": "syntax" + }, + { + "expression": "a]", + "error": "syntax" + }, + { + "expression": "a][", + "error": "syntax" + }, + { + "expression": "!", + "error": "syntax" + } + ] + }, + { + "comment": "Boolean syntax errors", + "given": {"type": "object"}, + "cases": [ + { + "expression": "![!(!", + "error": "syntax" + } + ] + }, + { + "comment": "Wildcard syntax", + "given": {"type": "object"}, + "cases": [ + { + "expression": "*", + "result": ["object"] + }, + { + "expression": "*.*", + "result": [] + }, + { + "expression": "*.foo", + "result": [] + }, + { + "expression": "*[0]", + "result": [] + }, + { + "expression": ".*", + "error": "syntax" + }, + { + "expression": "*foo", + "error": "syntax" + }, + { + "expression": "*0", + "error": "syntax" + }, + { + "expression": "foo[*]bar", + "error": "syntax" + }, + { + "expression": "foo[*]*", + "error": "syntax" + } + ] + }, + { + "comment": "Flatten syntax", + "given": {"type": "object"}, + "cases": [ + { + "expression": "[]", + "result": null + } + ] + }, + { + "comment": "Simple bracket syntax", + "given": {"type": "object"}, + "cases": [ + { + "expression": "[0]", + "result": null + }, + { + "expression": "[*]", + "result": null + }, + { + "expression": "*.[0]", + "error": "syntax" + }, + { + "expression": "*.[\"0\"]", + "result": [[null]] + }, + { + "expression": "[*].bar", + "result": null + }, + { + "expression": "[*][0]", + "result": null + }, + { + "expression": "foo[#]", + "error": "syntax" + } + ] + }, + { + "comment": "Multi-select list syntax", + "given": {"type": "object"}, + "cases": [ + { + "expression": "foo[0]", + "result": null + }, + { + "comment": "Valid multi-select of a list", + "expression": "foo[0, 1]", + "error": "syntax" + }, + { + "expression": "foo.[0]", + "error": "syntax" + }, + { + "expression": "foo.[*]", + "result": null + }, + { + "comment": "Multi-select of a list with trailing comma", + "expression": "foo[0, ]", + "error": "syntax" + }, + { + "comment": "Multi-select of a list with trailing comma and no close", + "expression": "foo[0,", + "error": "syntax" + }, + { + "comment": "Multi-select of a list with trailing comma and no close", + "expression": "foo.[a", + "error": "syntax" + }, + { + "comment": "Multi-select of a list with extra comma", + "expression": "foo[0,, 1]", + "error": "syntax" + }, + { + "comment": "Multi-select of a list using an identifier index", + "expression": "foo[abc]", + "error": "syntax" + }, + { + "comment": "Multi-select of a list using identifier indices", + "expression": "foo[abc, def]", + "error": "syntax" + }, + { + "comment": "Multi-select of a list using an identifier index", + "expression": "foo[abc, 1]", + "error": "syntax" + }, + { + "comment": "Multi-select of a list using an identifier index with trailing comma", + "expression": "foo[abc, ]", + "error": "syntax" + }, + { + "comment": "Valid multi-select of a hash using an identifier index", + "expression": "foo.[abc]", + "result": null + }, + { + "comment": "Valid multi-select of a hash", + "expression": "foo.[abc, def]", + "result": null + }, + { + "comment": "Multi-select of a hash using a numeric index", + "expression": "foo.[abc, 1]", + "error": "syntax" + }, + { + "comment": "Multi-select of a hash with a trailing comma", + "expression": "foo.[abc, ]", + "error": "syntax" + }, + { + "comment": "Multi-select of a hash with extra commas", + "expression": "foo.[abc,, def]", + "error": "syntax" + }, + { + "comment": "Multi-select of a hash using number indices", + "expression": "foo.[0, 1]", + "error": "syntax" + } + ] + }, + { + "comment": "Multi-select hash syntax", + "given": {"type": "object"}, + "cases": [ + { + "comment": "No key or value", + "expression": "a{}", + "error": "syntax" + }, + { + "comment": "No closing token", + "expression": "a{", + "error": "syntax" + }, + { + "comment": "Not a key value pair", + "expression": "a{foo}", + "error": "syntax" + }, + { + "comment": "Missing value and closing character", + "expression": "a{foo:", + "error": "syntax" + }, + { + "comment": "Missing closing character", + "expression": "a{foo: 0", + "error": "syntax" + }, + { + "comment": "Missing value", + "expression": "a{foo:}", + "error": "syntax" + }, + { + "comment": "Trailing comma and no closing character", + "expression": "a{foo: 0, ", + "error": "syntax" + }, + { + "comment": "Missing value with trailing comma", + "expression": "a{foo: ,}", + "error": "syntax" + }, + { + "comment": "Accessing Array using an identifier", + "expression": "a{foo: bar}", + "error": "syntax" + }, + { + "expression": "a{foo: 0}", + "error": "syntax" + }, + { + "comment": "Missing key-value pair", + "expression": "a.{}", + "error": "syntax" + }, + { + "comment": "Not a key-value pair", + "expression": "a.{foo}", + "error": "syntax" + }, + { + "comment": "Missing value", + "expression": "a.{foo:}", + "error": "syntax" + }, + { + "comment": "Missing value with trailing comma", + "expression": "a.{foo: ,}", + "error": "syntax" + }, + { + "comment": "Valid multi-select hash extraction", + "expression": "a.{foo: bar}", + "result": null + }, + { + "comment": "Valid multi-select hash extraction", + "expression": "a.{foo: bar, baz: bam}", + "result": null + }, + { + "comment": "Trailing comma", + "expression": "a.{foo: bar, }", + "error": "syntax" + }, + { + "comment": "Missing key in second key-value pair", + "expression": "a.{foo: bar, baz}", + "error": "syntax" + }, + { + "comment": "Missing value in second key-value pair", + "expression": "a.{foo: bar, baz:}", + "error": "syntax" + }, + { + "comment": "Trailing comma", + "expression": "a.{foo: bar, baz: bam, }", + "error": "syntax" + }, + { + "comment": "Nested multi select", + "expression": "{\"\\\\\":{\" \":*}}", + "result": {"\\": {" ": ["object"]}} + } + ] + }, + { + "comment": "Or expressions", + "given": {"type": "object"}, + "cases": [ + { + "expression": "foo || bar", + "result": null + }, + { + "expression": "foo ||", + "error": "syntax" + }, + { + "expression": "foo.|| bar", + "error": "syntax" + }, + { + "expression": " || foo", + "error": "syntax" + }, + { + "expression": "foo || || foo", + "error": "syntax" + }, + { + "expression": "foo.[a || b]", + "result": null + }, + { + "expression": "foo.[a ||]", + "error": "syntax" + }, + { + "expression": "\"foo", + "error": "syntax" + } + ] + }, + { + "comment": "Filter expressions", + "given": {"type": "object"}, + "cases": [ + { + "expression": "foo[?bar==`\"baz\"`]", + "result": null + }, + { + "expression": "foo[? bar == `\"baz\"` ]", + "result": null + }, + { + "expression": "foo[ ?bar==`\"baz\"`]", + "error": "syntax" + }, + { + "expression": "foo[?bar==]", + "error": "syntax" + }, + { + "expression": "foo[?==]", + "error": "syntax" + }, + { + "expression": "foo[?==bar]", + "error": "syntax" + }, + { + "expression": "foo[?bar==baz?]", + "error": "syntax" + }, + { + "expression": "foo[?a.b.c==d.e.f]", + "result": null + }, + { + "expression": "foo[?bar==`[0, 1, 2]`]", + "result": null + }, + { + "expression": "foo[?bar==`[\"a\", \"b\", \"c\"]`]", + "result": null + }, + { + "comment": "Literal char not escaped", + "expression": "foo[?bar==`[\"foo`bar\"]`]", + "error": "syntax" + }, + { + "comment": "Literal char escaped", + "expression": "foo[?bar==`[\"foo\\`bar\"]`]", + "result": null + }, + { + "comment": "Unknown comparator", + "expression": "foo[?bar<>baz]", + "error": "syntax" + }, + { + "comment": "Unknown comparator", + "expression": "foo[?bar^baz]", + "error": "syntax" + }, + { + "expression": "foo[bar==baz]", + "error": "syntax" + }, + { + "comment": "Quoted identifier in filter expression no spaces", + "expression": "[?\"\\\\\">`\"foo\"`]", + "result": null + }, + { + "comment": "Quoted identifier in filter expression with spaces", + "expression": "[?\"\\\\\" > `\"foo\"`]", + "result": null + } + ] + }, + { + "comment": "Filter expression errors", + "given": {"type": "object"}, + "cases": [ + { + "expression": "bar.`\"anything\"`", + "error": "syntax" + }, + { + "expression": "bar.baz.noexists.`\"literal\"`", + "error": "syntax" + }, + { + "comment": "Literal wildcard projection", + "expression": "foo[*].`\"literal\"`", + "error": "syntax" + }, + { + "expression": "foo[*].name.`\"literal\"`", + "error": "syntax" + }, + { + "expression": "foo[].name.`\"literal\"`", + "error": "syntax" + }, + { + "expression": "foo[].name.`\"literal\"`.`\"subliteral\"`", + "error": "syntax" + }, + { + "comment": "Projecting a literal onto an empty list", + "expression": "foo[*].name.noexist.`\"literal\"`", + "error": "syntax" + }, + { + "expression": "foo[].name.noexist.`\"literal\"`", + "error": "syntax" + }, + { + "expression": "twolen[*].`\"foo\"`", + "error": "syntax" + }, + { + "comment": "Two level projection of a literal", + "expression": "twolen[*].threelen[*].`\"bar\"`", + "error": "syntax" + }, + { + "comment": "Two level flattened projection of a literal", + "expression": "twolen[].threelen[].`\"bar\"`", + "error": "syntax" + } + ] + }, + { + "comment": "Identifiers", + "given": {"type": "object"}, + "cases": [ + { + "expression": "foo", + "result": null + }, + { + "expression": "\"foo\"", + "result": null + }, + { + "expression": "\"\\\\\"", + "result": null + } + ] + }, + { + "comment": "Combined syntax", + "given": [], + "cases": [ + { + "expression": "*||*|*|*", + "result": null + }, + { + "expression": "*[]||[*]", + "result": [] + }, + { + "expression": "[*.*]", + "result": [null] + } + ] + } +] diff --git a/node_modules/jmespath/test/compliance/unicode.json b/node_modules/jmespath/test/compliance/unicode.json new file mode 100644 index 0000000..6b07b0b --- /dev/null +++ b/node_modules/jmespath/test/compliance/unicode.json @@ -0,0 +1,38 @@ +[ + { + "given": {"foo": [{"✓": "✓"}, {"✓": "✗"}]}, + "cases": [ + { + "expression": "foo[].\"✓\"", + "result": ["✓", "✗"] + } + ] + }, + { + "given": {"☯": true}, + "cases": [ + { + "expression": "\"☯\"", + "result": true + } + ] + }, + { + "given": {"♪♫•*¨*•.¸¸❤¸¸.•*¨*•♫♪": true}, + "cases": [ + { + "expression": "\"♪♫•*¨*•.¸¸❤¸¸.•*¨*•♫♪\"", + "result": true + } + ] + }, + { + "given": {"☃": true}, + "cases": [ + { + "expression": "\"☃\"", + "result": true + } + ] + } +] diff --git a/node_modules/jmespath/test/compliance/wildcard.json b/node_modules/jmespath/test/compliance/wildcard.json new file mode 100644 index 0000000..3bcec30 --- /dev/null +++ b/node_modules/jmespath/test/compliance/wildcard.json @@ -0,0 +1,460 @@ +[{ + "given": { + "foo": { + "bar": { + "baz": "val" + }, + "other": { + "baz": "val" + }, + "other2": { + "baz": "val" + }, + "other3": { + "notbaz": ["a", "b", "c"] + }, + "other4": { + "notbaz": ["a", "b", "c"] + }, + "other5": { + "other": { + "a": 1, + "b": 1, + "c": 1 + } + } + } + }, + "cases": [ + { + "expression": "foo.*.baz", + "result": ["val", "val", "val"] + }, + { + "expression": "foo.bar.*", + "result": ["val"] + }, + { + "expression": "foo.*.notbaz", + "result": [["a", "b", "c"], ["a", "b", "c"]] + }, + { + "expression": "foo.*.notbaz[0]", + "result": ["a", "a"] + }, + { + "expression": "foo.*.notbaz[-1]", + "result": ["c", "c"] + } + ] +}, { + "given": { + "foo": { + "first-1": { + "second-1": "val" + }, + "first-2": { + "second-1": "val" + }, + "first-3": { + "second-1": "val" + } + } + }, + "cases": [ + { + "expression": "foo.*", + "result": [{"second-1": "val"}, {"second-1": "val"}, + {"second-1": "val"}] + }, + { + "expression": "foo.*.*", + "result": [["val"], ["val"], ["val"]] + }, + { + "expression": "foo.*.*.*", + "result": [[], [], []] + }, + { + "expression": "foo.*.*.*.*", + "result": [[], [], []] + } + ] +}, { + "given": { + "foo": { + "bar": "one" + }, + "other": { + "bar": "one" + }, + "nomatch": { + "notbar": "three" + } + }, + "cases": [ + { + "expression": "*.bar", + "result": ["one", "one"] + } + ] +}, { + "given": { + "top1": { + "sub1": {"foo": "one"} + }, + "top2": { + "sub1": {"foo": "one"} + } + }, + "cases": [ + { + "expression": "*", + "result": [{"sub1": {"foo": "one"}}, + {"sub1": {"foo": "one"}}] + }, + { + "expression": "*.sub1", + "result": [{"foo": "one"}, + {"foo": "one"}] + }, + { + "expression": "*.*", + "result": [[{"foo": "one"}], + [{"foo": "one"}]] + }, + { + "expression": "*.*.foo[]", + "result": ["one", "one"] + }, + { + "expression": "*.sub1.foo", + "result": ["one", "one"] + } + ] +}, +{ + "given": + {"foo": [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}]}, + "cases": [ + { + "expression": "foo[*].bar", + "result": ["one", "two", "three"] + }, + { + "expression": "foo[*].notbar", + "result": ["four"] + } + ] +}, +{ + "given": + [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}], + "cases": [ + { + "expression": "[*]", + "result": [{"bar": "one"}, {"bar": "two"}, {"bar": "three"}, {"notbar": "four"}] + }, + { + "expression": "[*].bar", + "result": ["one", "two", "three"] + }, + { + "expression": "[*].notbar", + "result": ["four"] + } + ] +}, +{ + "given": { + "foo": { + "bar": [ + {"baz": ["one", "two", "three"]}, + {"baz": ["four", "five", "six"]}, + {"baz": ["seven", "eight", "nine"]} + ] + } + }, + "cases": [ + { + "expression": "foo.bar[*].baz", + "result": [["one", "two", "three"], ["four", "five", "six"], ["seven", "eight", "nine"]] + }, + { + "expression": "foo.bar[*].baz[0]", + "result": ["one", "four", "seven"] + }, + { + "expression": "foo.bar[*].baz[1]", + "result": ["two", "five", "eight"] + }, + { + "expression": "foo.bar[*].baz[2]", + "result": ["three", "six", "nine"] + }, + { + "expression": "foo.bar[*].baz[3]", + "result": [] + } + ] +}, +{ + "given": { + "foo": { + "bar": [["one", "two"], ["three", "four"]] + } + }, + "cases": [ + { + "expression": "foo.bar[*]", + "result": [["one", "two"], ["three", "four"]] + }, + { + "expression": "foo.bar[0]", + "result": ["one", "two"] + }, + { + "expression": "foo.bar[0][0]", + "result": "one" + }, + { + "expression": "foo.bar[0][0][0]", + "result": null + }, + { + "expression": "foo.bar[0][0][0][0]", + "result": null + }, + { + "expression": "foo[0][0]", + "result": null + } + ] +}, +{ + "given": { + "foo": [ + {"bar": [{"kind": "basic"}, {"kind": "intermediate"}]}, + {"bar": [{"kind": "advanced"}, {"kind": "expert"}]}, + {"bar": "string"} + ] + + }, + "cases": [ + { + "expression": "foo[*].bar[*].kind", + "result": [["basic", "intermediate"], ["advanced", "expert"]] + }, + { + "expression": "foo[*].bar[0].kind", + "result": ["basic", "advanced"] + } + ] +}, +{ + "given": { + "foo": [ + {"bar": {"kind": "basic"}}, + {"bar": {"kind": "intermediate"}}, + {"bar": {"kind": "advanced"}}, + {"bar": {"kind": "expert"}}, + {"bar": "string"} + ] + }, + "cases": [ + { + "expression": "foo[*].bar.kind", + "result": ["basic", "intermediate", "advanced", "expert"] + } + ] +}, +{ + "given": { + "foo": [{"bar": ["one", "two"]}, {"bar": ["three", "four"]}, {"bar": ["five"]}] + }, + "cases": [ + { + "expression": "foo[*].bar[0]", + "result": ["one", "three", "five"] + }, + { + "expression": "foo[*].bar[1]", + "result": ["two", "four"] + }, + { + "expression": "foo[*].bar[2]", + "result": [] + } + ] +}, +{ + "given": { + "foo": [{"bar": []}, {"bar": []}, {"bar": []}] + }, + "cases": [ + { + "expression": "foo[*].bar[0]", + "result": [] + } + ] +}, +{ + "given": { + "foo": [["one", "two"], ["three", "four"], ["five"]] + }, + "cases": [ + { + "expression": "foo[*][0]", + "result": ["one", "three", "five"] + }, + { + "expression": "foo[*][1]", + "result": ["two", "four"] + } + ] +}, +{ + "given": { + "foo": [ + [ + ["one", "two"], ["three", "four"] + ], [ + ["five", "six"], ["seven", "eight"] + ], [ + ["nine"], ["ten"] + ] + ] + }, + "cases": [ + { + "expression": "foo[*][0]", + "result": [["one", "two"], ["five", "six"], ["nine"]] + }, + { + "expression": "foo[*][1]", + "result": [["three", "four"], ["seven", "eight"], ["ten"]] + }, + { + "expression": "foo[*][0][0]", + "result": ["one", "five", "nine"] + }, + { + "expression": "foo[*][1][0]", + "result": ["three", "seven", "ten"] + }, + { + "expression": "foo[*][0][1]", + "result": ["two", "six"] + }, + { + "expression": "foo[*][1][1]", + "result": ["four", "eight"] + }, + { + "expression": "foo[*][2]", + "result": [] + }, + { + "expression": "foo[*][2][2]", + "result": [] + }, + { + "expression": "bar[*]", + "result": null + }, + { + "expression": "bar[*].baz[*]", + "result": null + } + ] +}, +{ + "given": { + "string": "string", + "hash": {"foo": "bar", "bar": "baz"}, + "number": 23, + "nullvalue": null + }, + "cases": [ + { + "expression": "string[*]", + "result": null + }, + { + "expression": "hash[*]", + "result": null + }, + { + "expression": "number[*]", + "result": null + }, + { + "expression": "nullvalue[*]", + "result": null + }, + { + "expression": "string[*].foo", + "result": null + }, + { + "expression": "hash[*].foo", + "result": null + }, + { + "expression": "number[*].foo", + "result": null + }, + { + "expression": "nullvalue[*].foo", + "result": null + }, + { + "expression": "nullvalue[*].foo[*].bar", + "result": null + } + ] +}, +{ + "given": { + "string": "string", + "hash": {"foo": "val", "bar": "val"}, + "number": 23, + "array": [1, 2, 3], + "nullvalue": null + }, + "cases": [ + { + "expression": "string.*", + "result": null + }, + { + "expression": "hash.*", + "result": ["val", "val"] + }, + { + "expression": "number.*", + "result": null + }, + { + "expression": "array.*", + "result": null + }, + { + "expression": "nullvalue.*", + "result": null + } + ] +}, +{ + "given": { + "a": [0, 1, 2], + "b": [0, 1, 2] + }, + "cases": [ + { + "expression": "*[0]", + "result": [0, 0] + } + ] +} +] diff --git a/node_modules/jmespath/test/jmespath.js b/node_modules/jmespath/test/jmespath.js new file mode 100644 index 0000000..15f61c1 --- /dev/null +++ b/node_modules/jmespath/test/jmespath.js @@ -0,0 +1,217 @@ +var assert = require('assert'); +var jmespath = require('../jmespath'); +var tokenize = jmespath.tokenize; +var compile = jmespath.compile; +var strictDeepEqual = jmespath.strictDeepEqual; + + +describe('tokenize', function() { + it('should tokenize unquoted identifier', function() { + assert.deepEqual(tokenize('foo'), + [{type: "UnquotedIdentifier", + value: "foo", + start: 0}]); + }); + it('should tokenize unquoted identifier with underscore', function() { + assert.deepEqual(tokenize('_underscore'), + [{type: "UnquotedIdentifier", + value: "_underscore", + start: 0}]); + }); + it('should tokenize unquoted identifier with numbers', function() { + assert.deepEqual(tokenize('foo123'), + [{type: "UnquotedIdentifier", + value: "foo123", + start: 0}]); + }); + it('should tokenize dotted lookups', function() { + assert.deepEqual( + tokenize('foo.bar'), + [{type: "UnquotedIdentifier", value: "foo", start: 0}, + {type: "Dot", value: ".", start: 3}, + {type: "UnquotedIdentifier", value: "bar", start: 4}, + ]); + }); + it('should tokenize numbers', function() { + assert.deepEqual( + tokenize('foo[0]'), + [{type: "UnquotedIdentifier", value: "foo", start: 0}, + {type: "Lbracket", value: "[", start: 3}, + {type: "Number", value: 0, start: 4}, + {type: "Rbracket", value: "]", start: 5}, + ]); + }); + it('should tokenize numbers with multiple digits', function() { + assert.deepEqual( + tokenize("12345"), + [{type: "Number", value: 12345, start: 0}]); + }); + it('should tokenize negative numbers', function() { + assert.deepEqual( + tokenize("-12345"), + [{type: "Number", value: -12345, start: 0}]); + }); + it('should tokenize quoted identifier', function() { + assert.deepEqual(tokenize('"foo"'), + [{type: "QuotedIdentifier", + value: "foo", + start: 0}]); + }); + it('should tokenize quoted identifier with unicode escape', function() { + assert.deepEqual(tokenize('"\\u2713"'), + [{type: "QuotedIdentifier", + value: "✓", + start: 0}]); + }); + it('should tokenize literal lists', function() { + assert.deepEqual(tokenize("`[0, 1]`"), + [{type: "Literal", + value: [0, 1], + start: 0}]); + }); + it('should tokenize literal dict', function() { + assert.deepEqual(tokenize("`{\"foo\": \"bar\"}`"), + [{type: "Literal", + value: {"foo": "bar"}, + start: 0}]); + }); + it('should tokenize literal strings', function() { + assert.deepEqual(tokenize("`\"foo\"`"), + [{type: "Literal", + value: "foo", + start: 0}]); + }); + it('should tokenize json literals', function() { + assert.deepEqual(tokenize("`true`"), + [{type: "Literal", + value: true, + start: 0}]); + }); + it('should not requiring surrounding quotes for strings', function() { + assert.deepEqual(tokenize("`foo`"), + [{type: "Literal", + value: "foo", + start: 0}]); + }); + it('should not requiring surrounding quotes for numbers', function() { + assert.deepEqual(tokenize("`20`"), + [{type: "Literal", + value: 20, + start: 0}]); + }); + it('should tokenize literal lists with chars afterwards', function() { + assert.deepEqual( + tokenize("`[0, 1]`[0]"), [ + {type: "Literal", value: [0, 1], start: 0}, + {type: "Lbracket", value: "[", start: 8}, + {type: "Number", value: 0, start: 9}, + {type: "Rbracket", value: "]", start: 10} + ]); + }); + it('should tokenize two char tokens with shared prefix', function() { + assert.deepEqual( + tokenize("[?foo]"), + [{type: "Filter", value: "[?", start: 0}, + {type: "UnquotedIdentifier", value: "foo", start: 2}, + {type: "Rbracket", value: "]", start: 5}] + ); + }); + it('should tokenize flatten operator', function() { + assert.deepEqual( + tokenize("[]"), + [{type: "Flatten", value: "[]", start: 0}]); + }); + it('should tokenize comparators', function() { + assert.deepEqual(tokenize("<"), + [{type: "LT", + value: "<", + start: 0}]); + }); + it('should tokenize two char tokens without shared prefix', function() { + assert.deepEqual( + tokenize("=="), + [{type: "EQ", value: "==", start: 0}] + ); + }); + it('should tokenize not equals', function() { + assert.deepEqual( + tokenize("!="), + [{type: "NE", value: "!=", start: 0}] + ); + }); + it('should tokenize the OR token', function() { + assert.deepEqual( + tokenize("a||b"), + [ + {type: "UnquotedIdentifier", value: "a", start: 0}, + {type: "Or", value: "||", start: 1}, + {type: "UnquotedIdentifier", value: "b", start: 3} + ] + ); + }); + it('should tokenize function calls', function() { + assert.deepEqual( + tokenize("abs(@)"), + [ + {type: "UnquotedIdentifier", value: "abs", start: 0}, + {type: "Lparen", value: "(", start: 3}, + {type: "Current", value: "@", start: 4}, + {type: "Rparen", value: ")", start: 5} + ] + ); + }); +}); + + +describe('parsing', function() { + it('should parse field node', function() { + assert.deepEqual(compile('foo'), + {type: 'Field', name: 'foo'}); + }); +}); + +describe('strictDeepEqual', function() { + it('should compare scalars', function() { + assert.strictEqual(strictDeepEqual('a', 'a'), true); + }); + it('should be false for different types', function() { + assert.strictEqual(strictDeepEqual('a', 2), false); + }); + it('should be false for arrays of different lengths', function() { + assert.strictEqual(strictDeepEqual([0, 1], [1, 2, 3]), false); + }); + it('should be true for identical arrays', function() { + assert.strictEqual(strictDeepEqual([0, 1], [0, 1]), true); + }); + it('should be true for nested arrays', function() { + assert.strictEqual( + strictDeepEqual([[0, 1], [2, 3]], [[0, 1], [2, 3]]), true); + }); + it('should be true for nested arrays of strings', function() { + assert.strictEqual( + strictDeepEqual([["a", "b"], ["c", "d"]], + [["a", "b"], ["c", "d"]]), true); + }); + it('should be false for different arrays of the same length', function() { + assert.strictEqual(strictDeepEqual([0, 1], [1, 2]), false); + }); + it('should handle object literals', function() { + assert.strictEqual(strictDeepEqual({a: 1, b: 2}, {a: 1, b: 2}), true); + }); + it('should handle keys in first not in second', function() { + assert.strictEqual(strictDeepEqual({a: 1, b: 2}, {a: 1}), false); + }); + it('should handle keys in second not in first', function() { + assert.strictEqual(strictDeepEqual({a: 1}, {a: 1, b: 2}), false); + }); + it('should handle nested objects', function() { + assert.strictEqual( + strictDeepEqual({a: {b: [1, 2]}}, + {a: {b: [1, 2]}}), true); + }); + it('should handle nested objects that are not equal', function() { + assert.strictEqual( + strictDeepEqual({a: {b: [1, 2]}}, + {a: {b: [1, 4]}}), false); + }); +}); diff --git a/node_modules/punycode/LICENSE-MIT.txt b/node_modules/punycode/LICENSE-MIT.txt new file mode 100644 index 0000000..a41e0a7 --- /dev/null +++ b/node_modules/punycode/LICENSE-MIT.txt @@ -0,0 +1,20 @@ +Copyright Mathias Bynens + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/punycode/README.md b/node_modules/punycode/README.md new file mode 100644 index 0000000..831e637 --- /dev/null +++ b/node_modules/punycode/README.md @@ -0,0 +1,176 @@ +# Punycode.js [![Build status](https://travis-ci.org/bestiejs/punycode.js.svg?branch=master)](https://travis-ci.org/bestiejs/punycode.js) [![Code coverage status](http://img.shields.io/coveralls/bestiejs/punycode.js/master.svg)](https://coveralls.io/r/bestiejs/punycode.js) [![Dependency status](https://gemnasium.com/bestiejs/punycode.js.svg)](https://gemnasium.com/bestiejs/punycode.js) + +A robust Punycode converter that fully complies to [RFC 3492](http://tools.ietf.org/html/rfc3492) and [RFC 5891](http://tools.ietf.org/html/rfc5891), and works on nearly all JavaScript platforms. + +This JavaScript library is the result of comparing, optimizing and documenting different open-source implementations of the Punycode algorithm: + +* [The C example code from RFC 3492](http://tools.ietf.org/html/rfc3492#appendix-C) +* [`punycode.c` by _Markus W. Scherer_ (IBM)](http://opensource.apple.com/source/ICU/ICU-400.42/icuSources/common/punycode.c) +* [`punycode.c` by _Ben Noordhuis_](https://github.com/bnoordhuis/punycode/blob/master/punycode.c) +* [JavaScript implementation by _some_](http://stackoverflow.com/questions/183485/can-anyone-recommend-a-good-free-javascript-for-punycode-to-unicode-conversion/301287#301287) +* [`punycode.js` by _Ben Noordhuis_](https://github.com/joyent/node/blob/426298c8c1c0d5b5224ac3658c41e7c2a3fe9377/lib/punycode.js) (note: [not fully compliant](https://github.com/joyent/node/issues/2072)) + +This project is [bundled](https://github.com/joyent/node/blob/master/lib/punycode.js) with [Node.js v0.6.2+](https://github.com/joyent/node/compare/975f1930b1...61e796decc). + +## Installation + +Via [npm](http://npmjs.org/) (only required for Node.js releases older than v0.6.2): + +```bash +npm install punycode +``` + +Via [Bower](http://bower.io/): + +```bash +bower install punycode +``` + +Via [Component](https://github.com/component/component): + +```bash +component install bestiejs/punycode.js +``` + +In a browser: + +```html + +``` + +In [Narwhal](http://narwhaljs.org/), [Node.js](http://nodejs.org/), and [RingoJS](http://ringojs.org/): + +```js +var punycode = require('punycode'); +``` + +In [Rhino](http://www.mozilla.org/rhino/): + +```js +load('punycode.js'); +``` + +Using an AMD loader like [RequireJS](http://requirejs.org/): + +```js +require( + { + 'paths': { + 'punycode': 'path/to/punycode' + } + }, + ['punycode'], + function(punycode) { + console.log(punycode); + } +); +``` + +## API + +### `punycode.decode(string)` + +Converts a Punycode string of ASCII symbols to a string of Unicode symbols. + +```js +// decode domain name parts +punycode.decode('maana-pta'); // 'mañana' +punycode.decode('--dqo34k'); // '☃-⌘' +``` + +### `punycode.encode(string)` + +Converts a string of Unicode symbols to a Punycode string of ASCII symbols. + +```js +// encode domain name parts +punycode.encode('mañana'); // 'maana-pta' +punycode.encode('☃-⌘'); // '--dqo34k' +``` + +### `punycode.toUnicode(input)` + +Converts a Punycode string representing a domain name or an email address to Unicode. Only the Punycoded parts of the input will be converted, i.e. it doesn’t matter if you call it on a string that has already been converted to Unicode. + +```js +// decode domain names +punycode.toUnicode('xn--maana-pta.com'); +// → 'mañana.com' +punycode.toUnicode('xn----dqo34k.com'); +// → '☃-⌘.com' + +// decode email addresses +punycode.toUnicode('джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq'); +// → 'джумла@джpумлатест.bрфa' +``` + +### `punycode.toASCII(input)` + +Converts a Unicode string representing a domain name or an email address to Punycode. Only the non-ASCII parts of the input will be converted, i.e. it doesn’t matter if you call it with a domain that's already in ASCII. + +```js +// encode domain names +punycode.toASCII('mañana.com'); +// → 'xn--maana-pta.com' +punycode.toASCII('☃-⌘.com'); +// → 'xn----dqo34k.com' + +// encode email addresses +punycode.toASCII('джумла@джpумлатест.bрфa'); +// → 'джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq' +``` + +### `punycode.ucs2` + +#### `punycode.ucs2.decode(string)` + +Creates an array containing the numeric code point values of each Unicode symbol in the string. While [JavaScript uses UCS-2 internally](https://mathiasbynens.be/notes/javascript-encoding), this function will convert a pair of surrogate halves (each of which UCS-2 exposes as separate characters) into a single code point, matching UTF-16. + +```js +punycode.ucs2.decode('abc'); +// → [0x61, 0x62, 0x63] +// surrogate pair for U+1D306 TETRAGRAM FOR CENTRE: +punycode.ucs2.decode('\uD834\uDF06'); +// → [0x1D306] +``` + +#### `punycode.ucs2.encode(codePoints)` + +Creates a string based on an array of numeric code point values. + +```js +punycode.ucs2.encode([0x61, 0x62, 0x63]); +// → 'abc' +punycode.ucs2.encode([0x1D306]); +// → '\uD834\uDF06' +``` + +### `punycode.version` + +A string representing the current Punycode.js version number. + +## Unit tests & code coverage + +After cloning this repository, run `npm install --dev` to install the dependencies needed for Punycode.js development and testing. You may want to install Istanbul _globally_ using `npm install istanbul -g`. + +Once that’s done, you can run the unit tests in Node using `npm test` or `node tests/tests.js`. To run the tests in Rhino, Ringo, Narwhal, PhantomJS, and web browsers as well, use `grunt test`. + +To generate the code coverage report, use `grunt cover`. + +Feel free to fork if you see possible improvements! + +## Author + +| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") | +|---| +| [Mathias Bynens](https://mathiasbynens.be/) | + +## Contributors + +| [![twitter/jdalton](https://gravatar.com/avatar/299a3d891ff1920b69c364d061007043?s=70)](https://twitter.com/jdalton "Follow @jdalton on Twitter") | +|---| +| [John-David Dalton](http://allyoucanleet.com/) | + +## License + +Punycode.js is available under the [MIT](https://mths.be/mit) license. diff --git a/node_modules/punycode/package.json b/node_modules/punycode/package.json new file mode 100644 index 0000000..71c9fc4 --- /dev/null +++ b/node_modules/punycode/package.json @@ -0,0 +1,80 @@ +{ + "_from": "punycode@1.3.2", + "_id": "punycode@1.3.2", + "_inBundle": false, + "_integrity": "sha1-llOgNvt8HuQjQvIyXM7v6jkmxI0=", + "_location": "/punycode", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "punycode@1.3.2", + "name": "punycode", + "escapedName": "punycode", + "rawSpec": "1.3.2", + "saveSpec": null, + "fetchSpec": "1.3.2" + }, + "_requiredBy": [ + "/url" + ], + "_resolved": "https://registry.npmjs.org/punycode/-/punycode-1.3.2.tgz", + "_shasum": "9653a036fb7c1ee42342f2325cceefea3926c48d", + "_spec": "punycode@1.3.2", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/url", + "author": { + "name": "Mathias Bynens", + "url": "https://mathiasbynens.be/" + }, + "bugs": { + "url": "https://github.com/bestiejs/punycode.js/issues" + }, + "bundleDependencies": false, + "contributors": [ + { + "name": "Mathias Bynens", + "url": "https://mathiasbynens.be/" + }, + { + "name": "John-David Dalton", + "url": "http://allyoucanleet.com/" + } + ], + "deprecated": false, + "description": "A robust Punycode converter that fully complies to RFC 3492 and RFC 5891, and works on nearly all JavaScript platforms.", + "devDependencies": { + "coveralls": "^2.10.1", + "grunt": "^0.4.5", + "grunt-contrib-uglify": "^0.5.0", + "grunt-shell": "^0.7.0", + "istanbul": "^0.2.13", + "qunit-extras": "^1.2.0", + "qunitjs": "~1.11.0", + "requirejs": "^2.1.14" + }, + "files": [ + "LICENSE-MIT.txt", + "punycode.js" + ], + "homepage": "https://mths.be/punycode", + "keywords": [ + "punycode", + "unicode", + "idn", + "idna", + "dns", + "url", + "domain" + ], + "license": "MIT", + "main": "punycode.js", + "name": "punycode", + "repository": { + "type": "git", + "url": "git+https://github.com/bestiejs/punycode.js.git" + }, + "scripts": { + "test": "node tests/tests.js" + }, + "version": "1.3.2" +} diff --git a/node_modules/punycode/punycode.js b/node_modules/punycode/punycode.js new file mode 100644 index 0000000..ac68597 --- /dev/null +++ b/node_modules/punycode/punycode.js @@ -0,0 +1,530 @@ +/*! https://mths.be/punycode v1.3.2 by @mathias */ +;(function(root) { + + /** Detect free variables */ + var freeExports = typeof exports == 'object' && exports && + !exports.nodeType && exports; + var freeModule = typeof module == 'object' && module && + !module.nodeType && module; + var freeGlobal = typeof global == 'object' && global; + if ( + freeGlobal.global === freeGlobal || + freeGlobal.window === freeGlobal || + freeGlobal.self === freeGlobal + ) { + root = freeGlobal; + } + + /** + * The `punycode` object. + * @name punycode + * @type Object + */ + var punycode, + + /** Highest positive signed 32-bit float value */ + maxInt = 2147483647, // aka. 0x7FFFFFFF or 2^31-1 + + /** Bootstring parameters */ + base = 36, + tMin = 1, + tMax = 26, + skew = 38, + damp = 700, + initialBias = 72, + initialN = 128, // 0x80 + delimiter = '-', // '\x2D' + + /** Regular expressions */ + regexPunycode = /^xn--/, + regexNonASCII = /[^\x20-\x7E]/, // unprintable ASCII chars + non-ASCII chars + regexSeparators = /[\x2E\u3002\uFF0E\uFF61]/g, // RFC 3490 separators + + /** Error messages */ + errors = { + 'overflow': 'Overflow: input needs wider integers to process', + 'not-basic': 'Illegal input >= 0x80 (not a basic code point)', + 'invalid-input': 'Invalid input' + }, + + /** Convenience shortcuts */ + baseMinusTMin = base - tMin, + floor = Math.floor, + stringFromCharCode = String.fromCharCode, + + /** Temporary variable */ + key; + + /*--------------------------------------------------------------------------*/ + + /** + * A generic error utility function. + * @private + * @param {String} type The error type. + * @returns {Error} Throws a `RangeError` with the applicable error message. + */ + function error(type) { + throw RangeError(errors[type]); + } + + /** + * A generic `Array#map` utility function. + * @private + * @param {Array} array The array to iterate over. + * @param {Function} callback The function that gets called for every array + * item. + * @returns {Array} A new array of values returned by the callback function. + */ + function map(array, fn) { + var length = array.length; + var result = []; + while (length--) { + result[length] = fn(array[length]); + } + return result; + } + + /** + * A simple `Array#map`-like wrapper to work with domain name strings or email + * addresses. + * @private + * @param {String} domain The domain name or email address. + * @param {Function} callback The function that gets called for every + * character. + * @returns {Array} A new string of characters returned by the callback + * function. + */ + function mapDomain(string, fn) { + var parts = string.split('@'); + var result = ''; + if (parts.length > 1) { + // In email addresses, only the domain name should be punycoded. Leave + // the local part (i.e. everything up to `@`) intact. + result = parts[0] + '@'; + string = parts[1]; + } + // Avoid `split(regex)` for IE8 compatibility. See #17. + string = string.replace(regexSeparators, '\x2E'); + var labels = string.split('.'); + var encoded = map(labels, fn).join('.'); + return result + encoded; + } + + /** + * Creates an array containing the numeric code points of each Unicode + * character in the string. While JavaScript uses UCS-2 internally, + * this function will convert a pair of surrogate halves (each of which + * UCS-2 exposes as separate characters) into a single code point, + * matching UTF-16. + * @see `punycode.ucs2.encode` + * @see + * @memberOf punycode.ucs2 + * @name decode + * @param {String} string The Unicode input string (UCS-2). + * @returns {Array} The new array of code points. + */ + function ucs2decode(string) { + var output = [], + counter = 0, + length = string.length, + value, + extra; + while (counter < length) { + value = string.charCodeAt(counter++); + if (value >= 0xD800 && value <= 0xDBFF && counter < length) { + // high surrogate, and there is a next character + extra = string.charCodeAt(counter++); + if ((extra & 0xFC00) == 0xDC00) { // low surrogate + output.push(((value & 0x3FF) << 10) + (extra & 0x3FF) + 0x10000); + } else { + // unmatched surrogate; only append this code unit, in case the next + // code unit is the high surrogate of a surrogate pair + output.push(value); + counter--; + } + } else { + output.push(value); + } + } + return output; + } + + /** + * Creates a string based on an array of numeric code points. + * @see `punycode.ucs2.decode` + * @memberOf punycode.ucs2 + * @name encode + * @param {Array} codePoints The array of numeric code points. + * @returns {String} The new Unicode string (UCS-2). + */ + function ucs2encode(array) { + return map(array, function(value) { + var output = ''; + if (value > 0xFFFF) { + value -= 0x10000; + output += stringFromCharCode(value >>> 10 & 0x3FF | 0xD800); + value = 0xDC00 | value & 0x3FF; + } + output += stringFromCharCode(value); + return output; + }).join(''); + } + + /** + * Converts a basic code point into a digit/integer. + * @see `digitToBasic()` + * @private + * @param {Number} codePoint The basic numeric code point value. + * @returns {Number} The numeric value of a basic code point (for use in + * representing integers) in the range `0` to `base - 1`, or `base` if + * the code point does not represent a value. + */ + function basicToDigit(codePoint) { + if (codePoint - 48 < 10) { + return codePoint - 22; + } + if (codePoint - 65 < 26) { + return codePoint - 65; + } + if (codePoint - 97 < 26) { + return codePoint - 97; + } + return base; + } + + /** + * Converts a digit/integer into a basic code point. + * @see `basicToDigit()` + * @private + * @param {Number} digit The numeric value of a basic code point. + * @returns {Number} The basic code point whose value (when used for + * representing integers) is `digit`, which needs to be in the range + * `0` to `base - 1`. If `flag` is non-zero, the uppercase form is + * used; else, the lowercase form is used. The behavior is undefined + * if `flag` is non-zero and `digit` has no uppercase form. + */ + function digitToBasic(digit, flag) { + // 0..25 map to ASCII a..z or A..Z + // 26..35 map to ASCII 0..9 + return digit + 22 + 75 * (digit < 26) - ((flag != 0) << 5); + } + + /** + * Bias adaptation function as per section 3.4 of RFC 3492. + * http://tools.ietf.org/html/rfc3492#section-3.4 + * @private + */ + function adapt(delta, numPoints, firstTime) { + var k = 0; + delta = firstTime ? floor(delta / damp) : delta >> 1; + delta += floor(delta / numPoints); + for (/* no initialization */; delta > baseMinusTMin * tMax >> 1; k += base) { + delta = floor(delta / baseMinusTMin); + } + return floor(k + (baseMinusTMin + 1) * delta / (delta + skew)); + } + + /** + * Converts a Punycode string of ASCII-only symbols to a string of Unicode + * symbols. + * @memberOf punycode + * @param {String} input The Punycode string of ASCII-only symbols. + * @returns {String} The resulting string of Unicode symbols. + */ + function decode(input) { + // Don't use UCS-2 + var output = [], + inputLength = input.length, + out, + i = 0, + n = initialN, + bias = initialBias, + basic, + j, + index, + oldi, + w, + k, + digit, + t, + /** Cached calculation results */ + baseMinusT; + + // Handle the basic code points: let `basic` be the number of input code + // points before the last delimiter, or `0` if there is none, then copy + // the first basic code points to the output. + + basic = input.lastIndexOf(delimiter); + if (basic < 0) { + basic = 0; + } + + for (j = 0; j < basic; ++j) { + // if it's not a basic code point + if (input.charCodeAt(j) >= 0x80) { + error('not-basic'); + } + output.push(input.charCodeAt(j)); + } + + // Main decoding loop: start just after the last delimiter if any basic code + // points were copied; start at the beginning otherwise. + + for (index = basic > 0 ? basic + 1 : 0; index < inputLength; /* no final expression */) { + + // `index` is the index of the next character to be consumed. + // Decode a generalized variable-length integer into `delta`, + // which gets added to `i`. The overflow checking is easier + // if we increase `i` as we go, then subtract off its starting + // value at the end to obtain `delta`. + for (oldi = i, w = 1, k = base; /* no condition */; k += base) { + + if (index >= inputLength) { + error('invalid-input'); + } + + digit = basicToDigit(input.charCodeAt(index++)); + + if (digit >= base || digit > floor((maxInt - i) / w)) { + error('overflow'); + } + + i += digit * w; + t = k <= bias ? tMin : (k >= bias + tMax ? tMax : k - bias); + + if (digit < t) { + break; + } + + baseMinusT = base - t; + if (w > floor(maxInt / baseMinusT)) { + error('overflow'); + } + + w *= baseMinusT; + + } + + out = output.length + 1; + bias = adapt(i - oldi, out, oldi == 0); + + // `i` was supposed to wrap around from `out` to `0`, + // incrementing `n` each time, so we'll fix that now: + if (floor(i / out) > maxInt - n) { + error('overflow'); + } + + n += floor(i / out); + i %= out; + + // Insert `n` at position `i` of the output + output.splice(i++, 0, n); + + } + + return ucs2encode(output); + } + + /** + * Converts a string of Unicode symbols (e.g. a domain name label) to a + * Punycode string of ASCII-only symbols. + * @memberOf punycode + * @param {String} input The string of Unicode symbols. + * @returns {String} The resulting Punycode string of ASCII-only symbols. + */ + function encode(input) { + var n, + delta, + handledCPCount, + basicLength, + bias, + j, + m, + q, + k, + t, + currentValue, + output = [], + /** `inputLength` will hold the number of code points in `input`. */ + inputLength, + /** Cached calculation results */ + handledCPCountPlusOne, + baseMinusT, + qMinusT; + + // Convert the input in UCS-2 to Unicode + input = ucs2decode(input); + + // Cache the length + inputLength = input.length; + + // Initialize the state + n = initialN; + delta = 0; + bias = initialBias; + + // Handle the basic code points + for (j = 0; j < inputLength; ++j) { + currentValue = input[j]; + if (currentValue < 0x80) { + output.push(stringFromCharCode(currentValue)); + } + } + + handledCPCount = basicLength = output.length; + + // `handledCPCount` is the number of code points that have been handled; + // `basicLength` is the number of basic code points. + + // Finish the basic string - if it is not empty - with a delimiter + if (basicLength) { + output.push(delimiter); + } + + // Main encoding loop: + while (handledCPCount < inputLength) { + + // All non-basic code points < n have been handled already. Find the next + // larger one: + for (m = maxInt, j = 0; j < inputLength; ++j) { + currentValue = input[j]; + if (currentValue >= n && currentValue < m) { + m = currentValue; + } + } + + // Increase `delta` enough to advance the decoder's state to , + // but guard against overflow + handledCPCountPlusOne = handledCPCount + 1; + if (m - n > floor((maxInt - delta) / handledCPCountPlusOne)) { + error('overflow'); + } + + delta += (m - n) * handledCPCountPlusOne; + n = m; + + for (j = 0; j < inputLength; ++j) { + currentValue = input[j]; + + if (currentValue < n && ++delta > maxInt) { + error('overflow'); + } + + if (currentValue == n) { + // Represent delta as a generalized variable-length integer + for (q = delta, k = base; /* no condition */; k += base) { + t = k <= bias ? tMin : (k >= bias + tMax ? tMax : k - bias); + if (q < t) { + break; + } + qMinusT = q - t; + baseMinusT = base - t; + output.push( + stringFromCharCode(digitToBasic(t + qMinusT % baseMinusT, 0)) + ); + q = floor(qMinusT / baseMinusT); + } + + output.push(stringFromCharCode(digitToBasic(q, 0))); + bias = adapt(delta, handledCPCountPlusOne, handledCPCount == basicLength); + delta = 0; + ++handledCPCount; + } + } + + ++delta; + ++n; + + } + return output.join(''); + } + + /** + * Converts a Punycode string representing a domain name or an email address + * to Unicode. Only the Punycoded parts of the input will be converted, i.e. + * it doesn't matter if you call it on a string that has already been + * converted to Unicode. + * @memberOf punycode + * @param {String} input The Punycoded domain name or email address to + * convert to Unicode. + * @returns {String} The Unicode representation of the given Punycode + * string. + */ + function toUnicode(input) { + return mapDomain(input, function(string) { + return regexPunycode.test(string) + ? decode(string.slice(4).toLowerCase()) + : string; + }); + } + + /** + * Converts a Unicode string representing a domain name or an email address to + * Punycode. Only the non-ASCII parts of the domain name will be converted, + * i.e. it doesn't matter if you call it with a domain that's already in + * ASCII. + * @memberOf punycode + * @param {String} input The domain name or email address to convert, as a + * Unicode string. + * @returns {String} The Punycode representation of the given domain name or + * email address. + */ + function toASCII(input) { + return mapDomain(input, function(string) { + return regexNonASCII.test(string) + ? 'xn--' + encode(string) + : string; + }); + } + + /*--------------------------------------------------------------------------*/ + + /** Define the public API */ + punycode = { + /** + * A string representing the current Punycode.js version number. + * @memberOf punycode + * @type String + */ + 'version': '1.3.2', + /** + * An object of methods to convert from JavaScript's internal character + * representation (UCS-2) to Unicode code points, and back. + * @see + * @memberOf punycode + * @type Object + */ + 'ucs2': { + 'decode': ucs2decode, + 'encode': ucs2encode + }, + 'decode': decode, + 'encode': encode, + 'toASCII': toASCII, + 'toUnicode': toUnicode + }; + + /** Expose `punycode` */ + // Some AMD build optimizers, like r.js, check for specific condition patterns + // like the following: + if ( + typeof define == 'function' && + typeof define.amd == 'object' && + define.amd + ) { + define('punycode', function() { + return punycode; + }); + } else if (freeExports && freeModule) { + if (module.exports == freeExports) { // in Node.js or RingoJS v0.8.0+ + freeModule.exports = punycode; + } else { // in Narwhal or RingoJS v0.7.0- + for (key in punycode) { + punycode.hasOwnProperty(key) && (freeExports[key] = punycode[key]); + } + } + } else { // in Rhino or a web browser + root.punycode = punycode; + } + +}(this)); diff --git a/node_modules/querystring/.History.md.un~ b/node_modules/querystring/.History.md.un~ new file mode 100644 index 0000000..c96a7dd Binary files /dev/null and b/node_modules/querystring/.History.md.un~ differ diff --git a/node_modules/querystring/.Readme.md.un~ b/node_modules/querystring/.Readme.md.un~ new file mode 100644 index 0000000..71613b5 Binary files /dev/null and b/node_modules/querystring/.Readme.md.un~ differ diff --git a/node_modules/querystring/.package.json.un~ b/node_modules/querystring/.package.json.un~ new file mode 100644 index 0000000..d86fe31 Binary files /dev/null and b/node_modules/querystring/.package.json.un~ differ diff --git a/node_modules/querystring/.travis.yml b/node_modules/querystring/.travis.yml new file mode 100644 index 0000000..895dbd3 --- /dev/null +++ b/node_modules/querystring/.travis.yml @@ -0,0 +1,4 @@ +language: node_js +node_js: + - 0.6 + - 0.8 diff --git a/node_modules/querystring/History.md b/node_modules/querystring/History.md new file mode 100644 index 0000000..4fddbaf --- /dev/null +++ b/node_modules/querystring/History.md @@ -0,0 +1,20 @@ +# 0.2.0 / 2013-02-21 + + - Refactor into function per-module idiomatic style. + - Improved test coverage. + +# 0.1.0 / 2011-12-13 + + - Minor project reorganization + +# 0.0.3 / 2011-04-16 + - Support for AMD module loaders + +# 0.0.2 / 2011-04-16 + + - Ported unit tests + - Removed functionality that depended on Buffers + +# 0.0.1 / 2011-04-15 + + - Initial release diff --git a/node_modules/querystring/License.md b/node_modules/querystring/License.md new file mode 100644 index 0000000..fc80e85 --- /dev/null +++ b/node_modules/querystring/License.md @@ -0,0 +1,19 @@ + +Copyright 2012 Irakli Gozalishvili. All rights reserved. +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to +deal in the Software without restriction, including without limitation the +rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +sell copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +IN THE SOFTWARE. diff --git a/node_modules/querystring/Readme.md b/node_modules/querystring/Readme.md new file mode 100644 index 0000000..a4fe252 --- /dev/null +++ b/node_modules/querystring/Readme.md @@ -0,0 +1,15 @@ +# querystring + +[![Build Status](https://secure.travis-ci.org/Gozala/querystring.png)](http://travis-ci.org/Gozala/querystring) + + +[![Browser support](http://ci.testling.com/Gozala/querystring.png)](http://ci.testling.com/Gozala/querystring) + + + +Node's querystring module for all engines. + +## Install ## + + npm install querystring + diff --git a/node_modules/querystring/decode.js b/node_modules/querystring/decode.js new file mode 100644 index 0000000..a6518b8 --- /dev/null +++ b/node_modules/querystring/decode.js @@ -0,0 +1,80 @@ +// Copyright Joyent, Inc. and other Node contributors. +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the +// "Software"), to deal in the Software without restriction, including +// without limitation the rights to use, copy, modify, merge, publish, +// distribute, sublicense, and/or sell copies of the Software, and to permit +// persons to whom the Software is furnished to do so, subject to the +// following conditions: +// +// The above copyright notice and this permission notice shall be included +// in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +// USE OR OTHER DEALINGS IN THE SOFTWARE. + +'use strict'; + +// If obj.hasOwnProperty has been overridden, then calling +// obj.hasOwnProperty(prop) will break. +// See: https://github.com/joyent/node/issues/1707 +function hasOwnProperty(obj, prop) { + return Object.prototype.hasOwnProperty.call(obj, prop); +} + +module.exports = function(qs, sep, eq, options) { + sep = sep || '&'; + eq = eq || '='; + var obj = {}; + + if (typeof qs !== 'string' || qs.length === 0) { + return obj; + } + + var regexp = /\+/g; + qs = qs.split(sep); + + var maxKeys = 1000; + if (options && typeof options.maxKeys === 'number') { + maxKeys = options.maxKeys; + } + + var len = qs.length; + // maxKeys <= 0 means that we should not limit keys count + if (maxKeys > 0 && len > maxKeys) { + len = maxKeys; + } + + for (var i = 0; i < len; ++i) { + var x = qs[i].replace(regexp, '%20'), + idx = x.indexOf(eq), + kstr, vstr, k, v; + + if (idx >= 0) { + kstr = x.substr(0, idx); + vstr = x.substr(idx + 1); + } else { + kstr = x; + vstr = ''; + } + + k = decodeURIComponent(kstr); + v = decodeURIComponent(vstr); + + if (!hasOwnProperty(obj, k)) { + obj[k] = v; + } else if (Array.isArray(obj[k])) { + obj[k].push(v); + } else { + obj[k] = [obj[k], v]; + } + } + + return obj; +}; diff --git a/node_modules/querystring/encode.js b/node_modules/querystring/encode.js new file mode 100644 index 0000000..4f2b561 --- /dev/null +++ b/node_modules/querystring/encode.js @@ -0,0 +1,64 @@ +// Copyright Joyent, Inc. and other Node contributors. +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the +// "Software"), to deal in the Software without restriction, including +// without limitation the rights to use, copy, modify, merge, publish, +// distribute, sublicense, and/or sell copies of the Software, and to permit +// persons to whom the Software is furnished to do so, subject to the +// following conditions: +// +// The above copyright notice and this permission notice shall be included +// in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +// USE OR OTHER DEALINGS IN THE SOFTWARE. + +'use strict'; + +var stringifyPrimitive = function(v) { + switch (typeof v) { + case 'string': + return v; + + case 'boolean': + return v ? 'true' : 'false'; + + case 'number': + return isFinite(v) ? v : ''; + + default: + return ''; + } +}; + +module.exports = function(obj, sep, eq, name) { + sep = sep || '&'; + eq = eq || '='; + if (obj === null) { + obj = undefined; + } + + if (typeof obj === 'object') { + return Object.keys(obj).map(function(k) { + var ks = encodeURIComponent(stringifyPrimitive(k)) + eq; + if (Array.isArray(obj[k])) { + return obj[k].map(function(v) { + return ks + encodeURIComponent(stringifyPrimitive(v)); + }).join(sep); + } else { + return ks + encodeURIComponent(stringifyPrimitive(obj[k])); + } + }).join(sep); + + } + + if (!name) return ''; + return encodeURIComponent(stringifyPrimitive(name)) + eq + + encodeURIComponent(stringifyPrimitive(obj)); +}; diff --git a/node_modules/querystring/index.js b/node_modules/querystring/index.js new file mode 100644 index 0000000..99826ea --- /dev/null +++ b/node_modules/querystring/index.js @@ -0,0 +1,4 @@ +'use strict'; + +exports.decode = exports.parse = require('./decode'); +exports.encode = exports.stringify = require('./encode'); diff --git a/node_modules/querystring/package.json b/node_modules/querystring/package.json new file mode 100644 index 0000000..032be27 --- /dev/null +++ b/node_modules/querystring/package.json @@ -0,0 +1,101 @@ +{ + "_from": "querystring@0.2.0", + "_id": "querystring@0.2.0", + "_inBundle": false, + "_integrity": "sha1-sgmEkgO7Jd+CDadW50cAWHhSFiA=", + "_location": "/querystring", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "querystring@0.2.0", + "name": "querystring", + "escapedName": "querystring", + "rawSpec": "0.2.0", + "saveSpec": null, + "fetchSpec": "0.2.0" + }, + "_requiredBy": [ + "/aws-sdk", + "/url" + ], + "_resolved": "https://registry.npmjs.org/querystring/-/querystring-0.2.0.tgz", + "_shasum": "b209849203bb25df820da756e747005878521620", + "_spec": "querystring@0.2.0", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/aws-sdk", + "author": { + "name": "Irakli Gozalishvili", + "email": "rfobic@gmail.com" + }, + "bugs": { + "url": "http://github.com/Gozala/querystring/issues/" + }, + "bundleDependencies": false, + "deprecated": false, + "description": "Node's querystring module for all engines.", + "devDependencies": { + "phantomify": "~0.x.0", + "retape": "~0.x.0", + "tape": "~0.1.5", + "test": "~0.x.0" + }, + "engines": { + "node": ">=0.4.x" + }, + "homepage": "https://github.com/Gozala/querystring#readme", + "id": "querystring", + "keywords": [ + "commonjs", + "query", + "querystring" + ], + "licenses": [ + { + "type": "MIT", + "url": "https://github.com/Gozala/enchain/License.md" + } + ], + "name": "querystring", + "repository": { + "type": "git", + "url": "git://github.com/Gozala/querystring.git", + "web": "https://github.com/Gozala/querystring" + }, + "scripts": { + "test": "npm run test-node && npm run test-browser && npm run test-tap", + "test-browser": "node ./node_modules/phantomify/bin/cmd.js ./test/common-index.js", + "test-node": "node ./test/common-index.js", + "test-tap": "node ./test/tap-index.js" + }, + "testling": { + "files": "test/tap-index.js", + "browsers": { + "iexplore": [ + 9, + 10 + ], + "chrome": [ + 16, + 20, + 25, + "canary" + ], + "firefox": [ + 10, + 15, + 16, + 17, + 18, + "nightly" + ], + "safari": [ + 5, + 6 + ], + "opera": [ + 12 + ] + } + }, + "version": "0.2.0" +} diff --git a/node_modules/querystring/test/.index.js.un~ b/node_modules/querystring/test/.index.js.un~ new file mode 100644 index 0000000..898eced Binary files /dev/null and b/node_modules/querystring/test/.index.js.un~ differ diff --git a/node_modules/querystring/test/common-index.js b/node_modules/querystring/test/common-index.js new file mode 100644 index 0000000..f356f98 --- /dev/null +++ b/node_modules/querystring/test/common-index.js @@ -0,0 +1,3 @@ +"use strict"; + +require("test").run(require("./index")) \ No newline at end of file diff --git a/node_modules/querystring/test/index.js b/node_modules/querystring/test/index.js new file mode 100644 index 0000000..62eb2ac --- /dev/null +++ b/node_modules/querystring/test/index.js @@ -0,0 +1,210 @@ +// Copyright Joyent, Inc. and other Node contributors. +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the +// "Software"), to deal in the Software without restriction, including +// without limitation the rights to use, copy, modify, merge, publish, +// distribute, sublicense, and/or sell copies of the Software, and to permit +// persons to whom the Software is furnished to do so, subject to the +// following conditions: +// +// The above copyright notice and this permission notice shall be included +// in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +// USE OR OTHER DEALINGS IN THE SOFTWARE. + +"use strict"; + +// test using assert +var qs = require('../'); + +// folding block, commented to pass gjslint +// {{{ +// [ wonkyQS, canonicalQS, obj ] +var qsTestCases = [ + ['foo=918854443121279438895193', + 'foo=918854443121279438895193', + {'foo': '918854443121279438895193'}], + ['foo=bar', 'foo=bar', {'foo': 'bar'}], + ['foo=bar&foo=quux', 'foo=bar&foo=quux', {'foo': ['bar', 'quux']}], + ['foo=1&bar=2', 'foo=1&bar=2', {'foo': '1', 'bar': '2'}], + ['my+weird+field=q1%212%22%27w%245%267%2Fz8%29%3F', + 'my%20weird%20field=q1!2%22\'w%245%267%2Fz8)%3F', + {'my weird field': 'q1!2"\'w$5&7/z8)?' }], + ['foo%3Dbaz=bar', 'foo%3Dbaz=bar', {'foo=baz': 'bar'}], + ['foo=baz=bar', 'foo=baz%3Dbar', {'foo': 'baz=bar'}], + ['str=foo&arr=1&arr=2&arr=3&somenull=&undef=', + 'str=foo&arr=1&arr=2&arr=3&somenull=&undef=', + { 'str': 'foo', + 'arr': ['1', '2', '3'], + 'somenull': '', + 'undef': ''}], + [' foo = bar ', '%20foo%20=%20bar%20', {' foo ': ' bar '}], + // disable test that fails ['foo=%zx', 'foo=%25zx', {'foo': '%zx'}], + ['foo=%EF%BF%BD', 'foo=%EF%BF%BD', {'foo': '\ufffd' }], + // See: https://github.com/joyent/node/issues/1707 + ['hasOwnProperty=x&toString=foo&valueOf=bar&__defineGetter__=baz', + 'hasOwnProperty=x&toString=foo&valueOf=bar&__defineGetter__=baz', + { hasOwnProperty: 'x', + toString: 'foo', + valueOf: 'bar', + __defineGetter__: 'baz' }], + // See: https://github.com/joyent/node/issues/3058 + ['foo&bar=baz', 'foo=&bar=baz', { foo: '', bar: 'baz' }] +]; + +// [ wonkyQS, canonicalQS, obj ] +var qsColonTestCases = [ + ['foo:bar', 'foo:bar', {'foo': 'bar'}], + ['foo:bar;foo:quux', 'foo:bar;foo:quux', {'foo': ['bar', 'quux']}], + ['foo:1&bar:2;baz:quux', + 'foo:1%26bar%3A2;baz:quux', + {'foo': '1&bar:2', 'baz': 'quux'}], + ['foo%3Abaz:bar', 'foo%3Abaz:bar', {'foo:baz': 'bar'}], + ['foo:baz:bar', 'foo:baz%3Abar', {'foo': 'baz:bar'}] +]; + +// [wonkyObj, qs, canonicalObj] +var extendedFunction = function() {}; +extendedFunction.prototype = {a: 'b'}; +var qsWeirdObjects = [ + [{regexp: /./g}, 'regexp=', {'regexp': ''}], + [{regexp: new RegExp('.', 'g')}, 'regexp=', {'regexp': ''}], + [{fn: function() {}}, 'fn=', {'fn': ''}], + [{fn: new Function('')}, 'fn=', {'fn': ''}], + [{math: Math}, 'math=', {'math': ''}], + [{e: extendedFunction}, 'e=', {'e': ''}], + [{d: new Date()}, 'd=', {'d': ''}], + [{d: Date}, 'd=', {'d': ''}], + [{f: new Boolean(false), t: new Boolean(true)}, 'f=&t=', {'f': '', 't': ''}], + [{f: false, t: true}, 'f=false&t=true', {'f': 'false', 't': 'true'}], + [{n: null}, 'n=', {'n': ''}], + [{nan: NaN}, 'nan=', {'nan': ''}], + [{inf: Infinity}, 'inf=', {'inf': ''}] +]; +// }}} + +var qsNoMungeTestCases = [ + ['', {}], + ['foo=bar&foo=baz', {'foo': ['bar', 'baz']}], + ['blah=burp', {'blah': 'burp'}], + ['gragh=1&gragh=3&goo=2', {'gragh': ['1', '3'], 'goo': '2'}], + ['frappucino=muffin&goat%5B%5D=scone&pond=moose', + {'frappucino': 'muffin', 'goat[]': 'scone', 'pond': 'moose'}], + ['trololol=yes&lololo=no', {'trololol': 'yes', 'lololo': 'no'}] +]; + +exports['test basic'] = function(assert) { + assert.strictEqual('918854443121279438895193', + qs.parse('id=918854443121279438895193').id, + 'prase id=918854443121279438895193'); +}; + +exports['test that the canonical qs is parsed properly'] = function(assert) { + qsTestCases.forEach(function(testCase) { + assert.deepEqual(testCase[2], qs.parse(testCase[0]), + 'parse ' + testCase[0]); + }); +}; + + +exports['test that the colon test cases can do the same'] = function(assert) { + qsColonTestCases.forEach(function(testCase) { + assert.deepEqual(testCase[2], qs.parse(testCase[0], ';', ':'), + 'parse ' + testCase[0] + ' -> ; :'); + }); +}; + +exports['test the weird objects, that they get parsed properly'] = function(assert) { + qsWeirdObjects.forEach(function(testCase) { + assert.deepEqual(testCase[2], qs.parse(testCase[1]), + 'parse ' + testCase[1]); + }); +}; + +exports['test non munge test cases'] = function(assert) { + qsNoMungeTestCases.forEach(function(testCase) { + assert.deepEqual(testCase[0], qs.stringify(testCase[1], '&', '=', false), + 'stringify ' + JSON.stringify(testCase[1]) + ' -> & ='); + }); +}; + +exports['test the nested qs-in-qs case'] = function(assert) { + var f = qs.parse('a=b&q=x%3Dy%26y%3Dz'); + f.q = qs.parse(f.q); + assert.deepEqual(f, { a: 'b', q: { x: 'y', y: 'z' } }, + 'parse a=b&q=x%3Dy%26y%3Dz'); +}; + +exports['test nested in colon'] = function(assert) { + var f = qs.parse('a:b;q:x%3Ay%3By%3Az', ';', ':'); + f.q = qs.parse(f.q, ';', ':'); + assert.deepEqual(f, { a: 'b', q: { x: 'y', y: 'z' } }, + 'parse a:b;q:x%3Ay%3By%3Az -> ; :'); +}; + +exports['test stringifying'] = function(assert) { + qsTestCases.forEach(function(testCase) { + assert.equal(testCase[1], qs.stringify(testCase[2]), + 'stringify ' + JSON.stringify(testCase[2])); + }); + + qsColonTestCases.forEach(function(testCase) { + assert.equal(testCase[1], qs.stringify(testCase[2], ';', ':'), + 'stringify ' + JSON.stringify(testCase[2]) + ' -> ; :'); + }); + + qsWeirdObjects.forEach(function(testCase) { + assert.equal(testCase[1], qs.stringify(testCase[0]), + 'stringify ' + JSON.stringify(testCase[0])); + }); +}; + +exports['test stringifying nested'] = function(assert) { + var f = qs.stringify({ + a: 'b', + q: qs.stringify({ + x: 'y', + y: 'z' + }) + }); + assert.equal(f, 'a=b&q=x%3Dy%26y%3Dz', + JSON.stringify({ + a: 'b', + 'qs.stringify -> q': { + x: 'y', + y: 'z' + } + })); + + var threw = false; + try { qs.parse(undefined); } catch(error) { threw = true; } + assert.ok(!threw, "does not throws on undefined"); +}; + +exports['test nested in colon'] = function(assert) { + var f = qs.stringify({ + a: 'b', + q: qs.stringify({ + x: 'y', + y: 'z' + }, ';', ':') + }, ';', ':'); + assert.equal(f, 'a:b;q:x%3Ay%3By%3Az', + 'stringify ' + JSON.stringify({ + a: 'b', + 'qs.stringify -> q': { + x: 'y', + y: 'z' + } + }) + ' -> ; : '); + + + assert.deepEqual({}, qs.parse(), 'parse undefined'); +}; diff --git a/node_modules/querystring/test/tap-index.js b/node_modules/querystring/test/tap-index.js new file mode 100644 index 0000000..70679b3 --- /dev/null +++ b/node_modules/querystring/test/tap-index.js @@ -0,0 +1,3 @@ +"use strict"; + +require("retape")(require("./index")) \ No newline at end of file diff --git a/node_modules/sax/LICENSE b/node_modules/sax/LICENSE new file mode 100644 index 0000000..ccffa08 --- /dev/null +++ b/node_modules/sax/LICENSE @@ -0,0 +1,41 @@ +The ISC License + +Copyright (c) Isaac Z. Schlueter and Contributors + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR +IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +==== + +`String.fromCodePoint` by Mathias Bynens used according to terms of MIT +License, as follows: + + Copyright Mathias Bynens + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/sax/LICENSE-W3C.html b/node_modules/sax/LICENSE-W3C.html new file mode 100644 index 0000000..a611e3f --- /dev/null +++ b/node_modules/sax/LICENSE-W3C.html @@ -0,0 +1,188 @@ + +W3C Software Notice and License
+ + + +
+

+ W3C + +

+ +
+ + + +
+
+ +
+ + +
+
+ +
+ +

Site Navigation

+

Policies and Legal Information Header link

+ +
+
+
+
+ +
+
+

W3C Software Notice and License

+
+
+

This work (and included software, documentation such as READMEs, or other +related items) is being provided by the copyright holders under the following +license.

+

License

+ +

+By obtaining, using and/or copying this work, you (the licensee) +agree that you have read, understood, and will comply with the following +terms and conditions.

+ +

Permission to copy, modify, and distribute this software and its +documentation, with or without modification, for any purpose and without +fee or royalty is hereby granted, provided that you include the following on +ALL copies of the software and documentation or portions thereof, including +modifications:

+ +
  • The full text of this NOTICE in a location viewable to users of the + redistributed or derivative work.
  • Any pre-existing intellectual property disclaimers, notices, or terms + and conditions. If none exist, the W3C Software Short + Notice should be included (hypertext is preferred, text is permitted) + within the body of any redistributed or derivative code.
  • Notice of any changes or modifications to the files, including the date + changes were made. (We recommend you provide URIs to the location from + which the code is derived.)
+ +

Disclaimers

+ +

THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS +MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR +PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE +ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.

+ +

COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR +DOCUMENTATION.

+ +

The name and trademarks of copyright holders may NOT be used in +advertising or publicity pertaining to the software without specific, written +prior permission. Title to copyright in this software and any associated +documentation will at all times remain with copyright holders.

+ +

Notes

+ +

This version: http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231

+ +

This formulation of W3C's notice and license became active on December 31 +2002. This version removes the copyright ownership notice such that this +license can be used with materials other than those owned by the W3C, +reflects that ERCIM is now a host of the W3C, includes references to this +specific dated version of the license, and removes the ambiguous grant of +"use". Otherwise, this version is the same as the previous +version and is written so as to preserve the Free +Software Foundation's assessment of GPL compatibility and OSI's certification +under the Open Source +Definition.

+
+
+
+
+ + + +
+ +
diff --git a/node_modules/sax/README.md b/node_modules/sax/README.md new file mode 100644 index 0000000..afcd3f3 --- /dev/null +++ b/node_modules/sax/README.md @@ -0,0 +1,225 @@ +# sax js + +A sax-style parser for XML and HTML. + +Designed with [node](http://nodejs.org/) in mind, but should work fine in +the browser or other CommonJS implementations. + +## What This Is + +* A very simple tool to parse through an XML string. +* A stepping stone to a streaming HTML parser. +* A handy way to deal with RSS and other mostly-ok-but-kinda-broken XML + docs. + +## What This Is (probably) Not + +* An HTML Parser - That's a fine goal, but this isn't it. It's just + XML. +* A DOM Builder - You can use it to build an object model out of XML, + but it doesn't do that out of the box. +* XSLT - No DOM = no querying. +* 100% Compliant with (some other SAX implementation) - Most SAX + implementations are in Java and do a lot more than this does. +* An XML Validator - It does a little validation when in strict mode, but + not much. +* A Schema-Aware XSD Thing - Schemas are an exercise in fetishistic + masochism. +* A DTD-aware Thing - Fetching DTDs is a much bigger job. + +## Regarding `Hello, world!').close(); + +// stream usage +// takes the same options as the parser +var saxStream = require("sax").createStream(strict, options) +saxStream.on("error", function (e) { + // unhandled errors will throw, since this is a proper node + // event emitter. + console.error("error!", e) + // clear the error + this._parser.error = null + this._parser.resume() +}) +saxStream.on("opentag", function (node) { + // same object as above +}) +// pipe is supported, and it's readable/writable +// same chunks coming in also go out. +fs.createReadStream("file.xml") + .pipe(saxStream) + .pipe(fs.createWriteStream("file-copy.xml")) +``` + + +## Arguments + +Pass the following arguments to the parser function. All are optional. + +`strict` - Boolean. Whether or not to be a jerk. Default: `false`. + +`opt` - Object bag of settings regarding string formatting. All default to `false`. + +Settings supported: + +* `trim` - Boolean. Whether or not to trim text and comment nodes. +* `normalize` - Boolean. If true, then turn any whitespace into a single + space. +* `lowercase` - Boolean. If true, then lowercase tag names and attribute names + in loose mode, rather than uppercasing them. +* `xmlns` - Boolean. If true, then namespaces are supported. +* `position` - Boolean. If false, then don't track line/col/position. +* `strictEntities` - Boolean. If true, only parse [predefined XML + entities](http://www.w3.org/TR/REC-xml/#sec-predefined-ent) + (`&`, `'`, `>`, `<`, and `"`) + +## Methods + +`write` - Write bytes onto the stream. You don't have to do this all at +once. You can keep writing as much as you want. + +`close` - Close the stream. Once closed, no more data may be written until +it is done processing the buffer, which is signaled by the `end` event. + +`resume` - To gracefully handle errors, assign a listener to the `error` +event. Then, when the error is taken care of, you can call `resume` to +continue parsing. Otherwise, the parser will not continue while in an error +state. + +## Members + +At all times, the parser object will have the following members: + +`line`, `column`, `position` - Indications of the position in the XML +document where the parser currently is looking. + +`startTagPosition` - Indicates the position where the current tag starts. + +`closed` - Boolean indicating whether or not the parser can be written to. +If it's `true`, then wait for the `ready` event to write again. + +`strict` - Boolean indicating whether or not the parser is a jerk. + +`opt` - Any options passed into the constructor. + +`tag` - The current tag being dealt with. + +And a bunch of other stuff that you probably shouldn't touch. + +## Events + +All events emit with a single argument. To listen to an event, assign a +function to `on`. Functions get executed in the this-context of +the parser object. The list of supported events are also in the exported +`EVENTS` array. + +When using the stream interface, assign handlers using the EventEmitter +`on` function in the normal fashion. + +`error` - Indication that something bad happened. The error will be hanging +out on `parser.error`, and must be deleted before parsing can continue. By +listening to this event, you can keep an eye on that kind of stuff. Note: +this happens *much* more in strict mode. Argument: instance of `Error`. + +`text` - Text node. Argument: string of text. + +`doctype` - The ``. Argument: +object with `name` and `body` members. Attributes are not parsed, as +processing instructions have implementation dependent semantics. + +`sgmldeclaration` - Random SGML declarations. Stuff like `` +would trigger this kind of event. This is a weird thing to support, so it +might go away at some point. SAX isn't intended to be used to parse SGML, +after all. + +`opentagstart` - Emitted immediately when the tag name is available, +but before any attributes are encountered. Argument: object with a +`name` field and an empty `attributes` set. Note that this is the +same object that will later be emitted in the `opentag` event. + +`opentag` - An opening tag. Argument: object with `name` and `attributes`. +In non-strict mode, tag names are uppercased, unless the `lowercase` +option is set. If the `xmlns` option is set, then it will contain +namespace binding information on the `ns` member, and will have a +`local`, `prefix`, and `uri` member. + +`closetag` - A closing tag. In loose mode, tags are auto-closed if their +parent closes. In strict mode, well-formedness is enforced. Note that +self-closing tags will have `closeTag` emitted immediately after `openTag`. +Argument: tag name. + +`attribute` - An attribute node. Argument: object with `name` and `value`. +In non-strict mode, attribute names are uppercased, unless the `lowercase` +option is set. If the `xmlns` option is set, it will also contains namespace +information. + +`comment` - A comment node. Argument: the string of the comment. + +`opencdata` - The opening tag of a ``) of a `` tags trigger a `"script"` +event, and their contents are not checked for special xml characters. +If you pass `noscript: true`, then this behavior is suppressed. + +## Reporting Problems + +It's best to write a failing test if you find an issue. I will always +accept pull requests with failing tests if they demonstrate intended +behavior, but it is very hard to figure out what issue you're describing +without a test. Writing a test is also the best way for you yourself +to figure out if you really understand the issue you think you have with +sax-js. diff --git a/node_modules/sax/lib/sax.js b/node_modules/sax/lib/sax.js new file mode 100644 index 0000000..f125c5f --- /dev/null +++ b/node_modules/sax/lib/sax.js @@ -0,0 +1,1576 @@ +;(function (sax) { // wrapper for non-node envs + sax.parser = function (strict, opt) { return new SAXParser(strict, opt) } + sax.SAXParser = SAXParser + sax.SAXStream = SAXStream + sax.createStream = createStream + + // When we pass the MAX_BUFFER_LENGTH position, start checking for buffer overruns. + // When we check, schedule the next check for MAX_BUFFER_LENGTH - (max(buffer lengths)), + // since that's the earliest that a buffer overrun could occur. This way, checks are + // as rare as required, but as often as necessary to ensure never crossing this bound. + // Furthermore, buffers are only tested at most once per write(), so passing a very + // large string into write() might have undesirable effects, but this is manageable by + // the caller, so it is assumed to be safe. Thus, a call to write() may, in the extreme + // edge case, result in creating at most one complete copy of the string passed in. + // Set to Infinity to have unlimited buffers. + sax.MAX_BUFFER_LENGTH = 64 * 1024 + + var buffers = [ + 'comment', 'sgmlDecl', 'textNode', 'tagName', 'doctype', + 'procInstName', 'procInstBody', 'entity', 'attribName', + 'attribValue', 'cdata', 'script' + ] + + sax.EVENTS = [ + 'text', + 'processinginstruction', + 'sgmldeclaration', + 'doctype', + 'comment', + 'opentagstart', + 'attribute', + 'opentag', + 'closetag', + 'opencdata', + 'cdata', + 'closecdata', + 'error', + 'end', + 'ready', + 'script', + 'opennamespace', + 'closenamespace' + ] + + function SAXParser (strict, opt) { + if (!(this instanceof SAXParser)) { + return new SAXParser(strict, opt) + } + + var parser = this + clearBuffers(parser) + parser.q = parser.c = '' + parser.bufferCheckPosition = sax.MAX_BUFFER_LENGTH + parser.opt = opt || {} + parser.opt.lowercase = parser.opt.lowercase || parser.opt.lowercasetags + parser.looseCase = parser.opt.lowercase ? 'toLowerCase' : 'toUpperCase' + parser.tags = [] + parser.closed = parser.closedRoot = parser.sawRoot = false + parser.tag = parser.error = null + parser.strict = !!strict + parser.noscript = !!(strict || parser.opt.noscript) + parser.state = S.BEGIN + parser.strictEntities = parser.opt.strictEntities + parser.ENTITIES = parser.strictEntities ? Object.create(sax.XML_ENTITIES) : Object.create(sax.ENTITIES) + parser.attribList = [] + + // namespaces form a prototype chain. + // it always points at the current tag, + // which protos to its parent tag. + if (parser.opt.xmlns) { + parser.ns = Object.create(rootNS) + } + + // mostly just for error reporting + parser.trackPosition = parser.opt.position !== false + if (parser.trackPosition) { + parser.position = parser.line = parser.column = 0 + } + emit(parser, 'onready') + } + + if (!Object.create) { + Object.create = function (o) { + function F () {} + F.prototype = o + var newf = new F() + return newf + } + } + + if (!Object.keys) { + Object.keys = function (o) { + var a = [] + for (var i in o) if (o.hasOwnProperty(i)) a.push(i) + return a + } + } + + function checkBufferLength (parser) { + var maxAllowed = Math.max(sax.MAX_BUFFER_LENGTH, 10) + var maxActual = 0 + for (var i = 0, l = buffers.length; i < l; i++) { + var len = parser[buffers[i]].length + if (len > maxAllowed) { + // Text/cdata nodes can get big, and since they're buffered, + // we can get here under normal conditions. + // Avoid issues by emitting the text node now, + // so at least it won't get any bigger. + switch (buffers[i]) { + case 'textNode': + closeText(parser) + break + + case 'cdata': + emitNode(parser, 'oncdata', parser.cdata) + parser.cdata = '' + break + + case 'script': + emitNode(parser, 'onscript', parser.script) + parser.script = '' + break + + default: + error(parser, 'Max buffer length exceeded: ' + buffers[i]) + } + } + maxActual = Math.max(maxActual, len) + } + // schedule the next check for the earliest possible buffer overrun. + var m = sax.MAX_BUFFER_LENGTH - maxActual + parser.bufferCheckPosition = m + parser.position + } + + function clearBuffers (parser) { + for (var i = 0, l = buffers.length; i < l; i++) { + parser[buffers[i]] = '' + } + } + + function flushBuffers (parser) { + closeText(parser) + if (parser.cdata !== '') { + emitNode(parser, 'oncdata', parser.cdata) + parser.cdata = '' + } + if (parser.script !== '') { + emitNode(parser, 'onscript', parser.script) + parser.script = '' + } + } + + SAXParser.prototype = { + end: function () { end(this) }, + write: write, + resume: function () { this.error = null; return this }, + close: function () { return this.write(null) }, + flush: function () { flushBuffers(this) } + } + + var Stream + try { + Stream = require('stream').Stream + } catch (ex) { + Stream = function () {} + } + + var streamWraps = sax.EVENTS.filter(function (ev) { + return ev !== 'error' && ev !== 'end' + }) + + function createStream (strict, opt) { + return new SAXStream(strict, opt) + } + + function SAXStream (strict, opt) { + if (!(this instanceof SAXStream)) { + return new SAXStream(strict, opt) + } + + Stream.apply(this) + + this._parser = new SAXParser(strict, opt) + this.writable = true + this.readable = true + + var me = this + + this._parser.onend = function () { + me.emit('end') + } + + this._parser.onerror = function (er) { + me.emit('error', er) + + // if didn't throw, then means error was handled. + // go ahead and clear error, so we can write again. + me._parser.error = null + } + + this._decoder = null + + streamWraps.forEach(function (ev) { + Object.defineProperty(me, 'on' + ev, { + get: function () { + return me._parser['on' + ev] + }, + set: function (h) { + if (!h) { + me.removeAllListeners(ev) + me._parser['on' + ev] = h + return h + } + me.on(ev, h) + }, + enumerable: true, + configurable: false + }) + }) + } + + SAXStream.prototype = Object.create(Stream.prototype, { + constructor: { + value: SAXStream + } + }) + + SAXStream.prototype.write = function (data) { + if (typeof Buffer === 'function' && + typeof Buffer.isBuffer === 'function' && + Buffer.isBuffer(data)) { + if (!this._decoder) { + var SD = require('string_decoder').StringDecoder + this._decoder = new SD('utf8') + } + data = this._decoder.write(data) + } + + this._parser.write(data.toString()) + this.emit('data', data) + return true + } + + SAXStream.prototype.end = function (chunk) { + if (chunk && chunk.length) { + this.write(chunk) + } + this._parser.end() + return true + } + + SAXStream.prototype.on = function (ev, handler) { + var me = this + if (!me._parser['on' + ev] && streamWraps.indexOf(ev) !== -1) { + me._parser['on' + ev] = function () { + var args = arguments.length === 1 ? [arguments[0]] : Array.apply(null, arguments) + args.splice(0, 0, ev) + me.emit.apply(me, args) + } + } + + return Stream.prototype.on.call(me, ev, handler) + } + + // character classes and tokens + var whitespace = '\r\n\t ' + + // this really needs to be replaced with character classes. + // XML allows all manner of ridiculous numbers and digits. + var number = '0124356789' + var letter = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' + + // (Letter | "_" | ":") + var quote = '\'"' + var attribEnd = whitespace + '>' + var CDATA = '[CDATA[' + var DOCTYPE = 'DOCTYPE' + var XML_NAMESPACE = 'http://www.w3.org/XML/1998/namespace' + var XMLNS_NAMESPACE = 'http://www.w3.org/2000/xmlns/' + var rootNS = { xml: XML_NAMESPACE, xmlns: XMLNS_NAMESPACE } + + // turn all the string character sets into character class objects. + whitespace = charClass(whitespace) + number = charClass(number) + letter = charClass(letter) + + // http://www.w3.org/TR/REC-xml/#NT-NameStartChar + // This implementation works on strings, a single character at a time + // as such, it cannot ever support astral-plane characters (10000-EFFFF) + // without a significant breaking change to either this parser, or the + // JavaScript language. Implementation of an emoji-capable xml parser + // is left as an exercise for the reader. + var nameStart = /[:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]/ + + var nameBody = /[:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u00B7\u0300-\u036F\u203F-\u2040\.\d-]/ + + var entityStart = /[#:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]/ + var entityBody = /[#:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u00B7\u0300-\u036F\u203F-\u2040\.\d-]/ + + quote = charClass(quote) + attribEnd = charClass(attribEnd) + + function charClass (str) { + return str.split('').reduce(function (s, c) { + s[c] = true + return s + }, {}) + } + + function isRegExp (c) { + return Object.prototype.toString.call(c) === '[object RegExp]' + } + + function is (charclass, c) { + return isRegExp(charclass) ? !!c.match(charclass) : charclass[c] + } + + function not (charclass, c) { + return !is(charclass, c) + } + + var S = 0 + sax.STATE = { + BEGIN: S++, // leading byte order mark or whitespace + BEGIN_WHITESPACE: S++, // leading whitespace + TEXT: S++, // general stuff + TEXT_ENTITY: S++, // & and such. + OPEN_WAKA: S++, // < + SGML_DECL: S++, // + SCRIPT: S++, // + +``` + +For version 3 uuids: + +```html + + +``` + +For version 4 uuids: + +```html + + +``` + +For version 5 uuids: + +```html + + +``` + +## API + +### Version 1 + +```javascript +const uuidv1 = require('uuid/v1'); + +// Incantations +uuidv1(); +uuidv1(options); +uuidv1(options, buffer, offset); +``` + +Generate and return a RFC4122 v1 (timestamp-based) UUID. + +* `options` - (Object) Optional uuid state to apply. Properties may include: + + * `node` - (Array) Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID. See note 1. + * `clockseq` - (Number between 0 - 0x3fff) RFC clock sequence. Default: An internally maintained clockseq is used. + * `msecs` - (Number) Time in milliseconds since unix Epoch. Default: The current time is used. + * `nsecs` - (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if `msecs` is unspecified. Default: internal uuid counter is used, as per 4.2.1.2. + +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Note: The id is generated guaranteed to stay constant for the lifetime of the current JS runtime. (Future versions of this module may use persistent storage mechanisms to extend this guarantee.) + +Example: Generate string UUID with fully-specified options + +```javascript +const v1options = { + node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab], + clockseq: 0x1234, + msecs: new Date('2011-11-01').getTime(), + nsecs: 5678 +}; +uuidv1(v1options); // ⇨ '710b962e-041c-11e1-9234-0123456789ab' + +``` + +Example: In-place generation of two binary IDs + +```javascript +// Generate two ids in an array +const arr = new Array(); +uuidv1(null, arr, 0); // ⇨ [ 69, 117, 109, 208, 123, 26, 17, 232, 146, 52, 45, 66, 178, 27, 26, 62 ] +uuidv1(null, arr, 16); // ⇨ [ 69, 117, 109, 208, 123, 26, 17, 232, 146, 52, 45, 66, 178, 27, 26, 62, 69, 117, 109, 209, 123, 26, 17, 232, 146, 52, 45, 66, 178, 27, 26, 62 ] + +``` + +### Version 3 + +```javascript +const uuidv3 = require('uuid/v3'); + +// Incantations +uuidv3(name, namespace); +uuidv3(name, namespace, buffer); +uuidv3(name, namespace, buffer, offset); +``` + +Generate and return a RFC4122 v3 UUID. + +* `name` - (String | Array[]) "name" to create UUID with +* `namespace` - (String | Array[]) "namespace" UUID either as a String or Array[16] of byte values +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0 + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Example: + +```javascript +uuidv3('hello world', MY_NAMESPACE); // ⇨ '042ffd34-d989-321c-ad06-f60826172424' + +``` + +### Version 4 + +```javascript +const uuidv4 = require('uuid/v4') + +// Incantations +uuidv4(); +uuidv4(options); +uuidv4(options, buffer, offset); +``` + +Generate and return a RFC4122 v4 UUID. + +* `options` - (Object) Optional uuid state to apply. Properties may include: + * `random` - (Number[16]) Array of 16 numbers (0-255) to use in place of randomly generated values + * `rng` - (Function) Random # generator function that returns an Array[16] of byte values (0-255) +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Example: Generate string UUID with predefined `random` values + +```javascript +const v4options = { + random: [ + 0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea, + 0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36 + ] +}; +uuidv4(v4options); // ⇨ '109156be-c4fb-41ea-b1b4-efe1671c5836' + +``` + +Example: Generate two IDs in a single buffer + +```javascript +const buffer = new Array(); +uuidv4(null, buffer, 0); // ⇨ [ 54, 122, 218, 70, 45, 70, 65, 24, 171, 53, 95, 130, 83, 195, 242, 45 ] +uuidv4(null, buffer, 16); // ⇨ [ 54, 122, 218, 70, 45, 70, 65, 24, 171, 53, 95, 130, 83, 195, 242, 45, 108, 204, 255, 103, 171, 86, 76, 94, 178, 225, 188, 236, 150, 20, 151, 87 ] + +``` + +### Version 5 + +```javascript +const uuidv5 = require('uuid/v5'); + +// Incantations +uuidv5(name, namespace); +uuidv5(name, namespace, buffer); +uuidv5(name, namespace, buffer, offset); +``` + +Generate and return a RFC4122 v5 UUID. + +* `name` - (String | Array[]) "name" to create UUID with +* `namespace` - (String | Array[]) "namespace" UUID either as a String or Array[16] of byte values +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0 + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Example: + +```javascript +uuidv5('hello world', MY_NAMESPACE); // ⇨ '9f282611-e0fd-5650-8953-89c8e342da0b' + +``` + +## Command Line + +UUIDs can be generated from the command line with the `uuid` command. + +```shell +$ uuid +ddeb27fb-d9a0-4624-be4d-4615062daed4 + +$ uuid v1 +02d37060-d446-11e7-a9fa-7bdae751ebe1 +``` + +Type `uuid --help` for usage details + +## Testing + +```shell +npm test +``` + +---- +Markdown generated from [README_js.md](README_js.md) by [![RunMD Logo](http://i.imgur.com/h0FVyzU.png)](https://github.com/broofa/runmd) \ No newline at end of file diff --git a/node_modules/uuid/README_js.md b/node_modules/uuid/README_js.md new file mode 100644 index 0000000..f34453b --- /dev/null +++ b/node_modules/uuid/README_js.md @@ -0,0 +1,280 @@ +```javascript --hide +runmd.onRequire = path => path.replace(/^uuid/, './'); +``` + +# uuid [![Build Status](https://secure.travis-ci.org/kelektiv/node-uuid.svg?branch=master)](http://travis-ci.org/kelektiv/node-uuid) # + +Simple, fast generation of [RFC4122](http://www.ietf.org/rfc/rfc4122.txt) UUIDS. + +Features: + +* Support for version 1, 3, 4 and 5 UUIDs +* Cross-platform +* Uses cryptographically-strong random number APIs (when available) +* Zero-dependency, small footprint (... but not [this small](https://gist.github.com/982883)) + +[**Deprecation warning**: The use of `require('uuid')` is deprecated and will not be +supported after version 3.x of this module. Instead, use `require('uuid/[v1|v3|v4|v5]')` as shown in the examples below.] + +## Quickstart - CommonJS (Recommended) + +```shell +npm install uuid +``` + +Then generate your uuid version of choice ... + +Version 1 (timestamp): + +```javascript --run v1 +const uuidv1 = require('uuid/v1'); +uuidv1(); // RESULT +``` + +Version 3 (namespace): + +```javascript --run v3 +const uuidv3 = require('uuid/v3'); + +// ... using predefined DNS namespace (for domain names) +uuidv3('hello.example.com', uuidv3.DNS); // RESULT + +// ... using predefined URL namespace (for, well, URLs) +uuidv3('http://example.com/hello', uuidv3.URL); // RESULT + +// ... using a custom namespace +// +// Note: Custom namespaces should be a UUID string specific to your application! +// E.g. the one here was generated using this modules `uuid` CLI. +const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341'; +uuidv3('Hello, World!', MY_NAMESPACE); // RESULT +``` + +Version 4 (random): + +```javascript --run v4 +const uuidv4 = require('uuid/v4'); +uuidv4(); // RESULT +``` + +Version 5 (namespace): + +```javascript --run v5 +const uuidv5 = require('uuid/v5'); + +// ... using predefined DNS namespace (for domain names) +uuidv5('hello.example.com', uuidv5.DNS); // RESULT + +// ... using predefined URL namespace (for, well, URLs) +uuidv5('http://example.com/hello', uuidv5.URL); // RESULT + +// ... using a custom namespace +// +// Note: Custom namespaces should be a UUID string specific to your application! +// E.g. the one here was generated using this modules `uuid` CLI. +const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341'; +uuidv5('Hello, World!', MY_NAMESPACE); // RESULT +``` + +## Quickstart - Browser-ready Versions + +Browser-ready versions of this module are available via [wzrd.in](https://github.com/jfhbrook/wzrd.in). + +For version 1 uuids: + +```html + + +``` + +For version 3 uuids: + +```html + + +``` + +For version 4 uuids: + +```html + + +``` + +For version 5 uuids: + +```html + + +``` + +## API + +### Version 1 + +```javascript +const uuidv1 = require('uuid/v1'); + +// Incantations +uuidv1(); +uuidv1(options); +uuidv1(options, buffer, offset); +``` + +Generate and return a RFC4122 v1 (timestamp-based) UUID. + +* `options` - (Object) Optional uuid state to apply. Properties may include: + + * `node` - (Array) Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID. See note 1. + * `clockseq` - (Number between 0 - 0x3fff) RFC clock sequence. Default: An internally maintained clockseq is used. + * `msecs` - (Number) Time in milliseconds since unix Epoch. Default: The current time is used. + * `nsecs` - (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if `msecs` is unspecified. Default: internal uuid counter is used, as per 4.2.1.2. + +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Note: The id is generated guaranteed to stay constant for the lifetime of the current JS runtime. (Future versions of this module may use persistent storage mechanisms to extend this guarantee.) + +Example: Generate string UUID with fully-specified options + +```javascript --run v1 +const v1options = { + node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab], + clockseq: 0x1234, + msecs: new Date('2011-11-01').getTime(), + nsecs: 5678 +}; +uuidv1(v1options); // RESULT +``` + +Example: In-place generation of two binary IDs + +```javascript --run v1 +// Generate two ids in an array +const arr = new Array(); +uuidv1(null, arr, 0); // RESULT +uuidv1(null, arr, 16); // RESULT +``` + +### Version 3 + +```javascript +const uuidv3 = require('uuid/v3'); + +// Incantations +uuidv3(name, namespace); +uuidv3(name, namespace, buffer); +uuidv3(name, namespace, buffer, offset); +``` + +Generate and return a RFC4122 v3 UUID. + +* `name` - (String | Array[]) "name" to create UUID with +* `namespace` - (String | Array[]) "namespace" UUID either as a String or Array[16] of byte values +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0 + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Example: + +```javascript --run v3 +uuidv3('hello world', MY_NAMESPACE); // RESULT +``` + +### Version 4 + +```javascript +const uuidv4 = require('uuid/v4') + +// Incantations +uuidv4(); +uuidv4(options); +uuidv4(options, buffer, offset); +``` + +Generate and return a RFC4122 v4 UUID. + +* `options` - (Object) Optional uuid state to apply. Properties may include: + * `random` - (Number[16]) Array of 16 numbers (0-255) to use in place of randomly generated values + * `rng` - (Function) Random # generator function that returns an Array[16] of byte values (0-255) +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Example: Generate string UUID with predefined `random` values + +```javascript --run v4 +const v4options = { + random: [ + 0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea, + 0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36 + ] +}; +uuidv4(v4options); // RESULT +``` + +Example: Generate two IDs in a single buffer + +```javascript --run v4 +const buffer = new Array(); +uuidv4(null, buffer, 0); // RESULT +uuidv4(null, buffer, 16); // RESULT +``` + +### Version 5 + +```javascript +const uuidv5 = require('uuid/v5'); + +// Incantations +uuidv5(name, namespace); +uuidv5(name, namespace, buffer); +uuidv5(name, namespace, buffer, offset); +``` + +Generate and return a RFC4122 v5 UUID. + +* `name` - (String | Array[]) "name" to create UUID with +* `namespace` - (String | Array[]) "namespace" UUID either as a String or Array[16] of byte values +* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. +* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0 + +Returns `buffer`, if specified, otherwise the string form of the UUID + +Example: + +```javascript --run v5 +uuidv5('hello world', MY_NAMESPACE); // RESULT +``` + +## Command Line + +UUIDs can be generated from the command line with the `uuid` command. + +```shell +$ uuid +ddeb27fb-d9a0-4624-be4d-4615062daed4 + +$ uuid v1 +02d37060-d446-11e7-a9fa-7bdae751ebe1 +``` + +Type `uuid --help` for usage details + +## Testing + +```shell +npm test +``` diff --git a/node_modules/uuid/bin/uuid b/node_modules/uuid/bin/uuid new file mode 100755 index 0000000..502626e --- /dev/null +++ b/node_modules/uuid/bin/uuid @@ -0,0 +1,65 @@ +#!/usr/bin/env node +var assert = require('assert'); + +function usage() { + console.log('Usage:'); + console.log(' uuid'); + console.log(' uuid v1'); + console.log(' uuid v3 '); + console.log(' uuid v4'); + console.log(' uuid v5 '); + console.log(' uuid --help'); + console.log('\nNote: may be "URL" or "DNS" to use the corresponding UUIDs defined by RFC4122'); +} + +var args = process.argv.slice(2); + +if (args.indexOf('--help') >= 0) { + usage(); + process.exit(0); +} +var version = args.shift() || 'v4'; + +switch (version) { + case 'v1': + var uuidV1 = require('../v1'); + console.log(uuidV1()); + break; + + case 'v3': + var uuidV3 = require('../v3'); + + var name = args.shift(); + var namespace = args.shift(); + assert(name != null, 'v3 name not specified'); + assert(namespace != null, 'v3 namespace not specified'); + + if (namespace == 'URL') namespace = uuidV3.URL; + if (namespace == 'DNS') namespace = uuidV3.DNS; + + console.log(uuidV3(name, namespace)); + break; + + case 'v4': + var uuidV4 = require('../v4'); + console.log(uuidV4()); + break; + + case 'v5': + var uuidV5 = require('../v5'); + + var name = args.shift(); + var namespace = args.shift(); + assert(name != null, 'v5 name not specified'); + assert(namespace != null, 'v5 namespace not specified'); + + if (namespace == 'URL') namespace = uuidV5.URL; + if (namespace == 'DNS') namespace = uuidV5.DNS; + + console.log(uuidV5(name, namespace)); + break; + + default: + usage(); + process.exit(1); +} diff --git a/node_modules/uuid/index.js b/node_modules/uuid/index.js new file mode 100644 index 0000000..e96791a --- /dev/null +++ b/node_modules/uuid/index.js @@ -0,0 +1,8 @@ +var v1 = require('./v1'); +var v4 = require('./v4'); + +var uuid = v4; +uuid.v1 = v1; +uuid.v4 = v4; + +module.exports = uuid; diff --git a/node_modules/uuid/lib/bytesToUuid.js b/node_modules/uuid/lib/bytesToUuid.js new file mode 100644 index 0000000..847c482 --- /dev/null +++ b/node_modules/uuid/lib/bytesToUuid.js @@ -0,0 +1,24 @@ +/** + * Convert array of 16 byte values to UUID string format of the form: + * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX + */ +var byteToHex = []; +for (var i = 0; i < 256; ++i) { + byteToHex[i] = (i + 0x100).toString(16).substr(1); +} + +function bytesToUuid(buf, offset) { + var i = offset || 0; + var bth = byteToHex; + // join used to fix memory issue caused by concatenation: https://bugs.chromium.org/p/v8/issues/detail?id=3175#c4 + return ([bth[buf[i++]], bth[buf[i++]], + bth[buf[i++]], bth[buf[i++]], '-', + bth[buf[i++]], bth[buf[i++]], '-', + bth[buf[i++]], bth[buf[i++]], '-', + bth[buf[i++]], bth[buf[i++]], '-', + bth[buf[i++]], bth[buf[i++]], + bth[buf[i++]], bth[buf[i++]], + bth[buf[i++]], bth[buf[i++]]]).join(''); +} + +module.exports = bytesToUuid; diff --git a/node_modules/uuid/lib/md5-browser.js b/node_modules/uuid/lib/md5-browser.js new file mode 100644 index 0000000..9b3b6c7 --- /dev/null +++ b/node_modules/uuid/lib/md5-browser.js @@ -0,0 +1,216 @@ +/* + * Browser-compatible JavaScript MD5 + * + * Modification of JavaScript MD5 + * https://github.com/blueimp/JavaScript-MD5 + * + * Copyright 2011, Sebastian Tschan + * https://blueimp.net + * + * Licensed under the MIT license: + * https://opensource.org/licenses/MIT + * + * Based on + * A JavaScript implementation of the RSA Data Security, Inc. MD5 Message + * Digest Algorithm, as defined in RFC 1321. + * Version 2.2 Copyright (C) Paul Johnston 1999 - 2009 + * Other contributors: Greg Holt, Andrew Kepert, Ydnar, Lostinet + * Distributed under the BSD License + * See http://pajhome.org.uk/crypt/md5 for more info. + */ + +'use strict'; + +function md5(bytes) { + if (typeof(bytes) == 'string') { + var msg = unescape(encodeURIComponent(bytes)); // UTF8 escape + bytes = new Array(msg.length); + for (var i = 0; i < msg.length; i++) bytes[i] = msg.charCodeAt(i); + } + + return md5ToHexEncodedArray( + wordsToMd5( + bytesToWords(bytes) + , bytes.length * 8) + ); +} + + +/* +* Convert an array of little-endian words to an array of bytes +*/ +function md5ToHexEncodedArray(input) { + var i; + var x; + var output = []; + var length32 = input.length * 32; + var hexTab = '0123456789abcdef'; + var hex; + + for (i = 0; i < length32; i += 8) { + x = (input[i >> 5] >>> (i % 32)) & 0xFF; + + hex = parseInt(hexTab.charAt((x >>> 4) & 0x0F) + hexTab.charAt(x & 0x0F), 16); + + output.push(hex); + } + return output; +} + +/* +* Calculate the MD5 of an array of little-endian words, and a bit length. +*/ +function wordsToMd5(x, len) { + /* append padding */ + x[len >> 5] |= 0x80 << (len % 32); + x[(((len + 64) >>> 9) << 4) + 14] = len; + + var i; + var olda; + var oldb; + var oldc; + var oldd; + var a = 1732584193; + var b = -271733879; + var c = -1732584194; + + var d = 271733878; + + for (i = 0; i < x.length; i += 16) { + olda = a; + oldb = b; + oldc = c; + oldd = d; + + a = md5ff(a, b, c, d, x[i], 7, -680876936); + d = md5ff(d, a, b, c, x[i + 1], 12, -389564586); + c = md5ff(c, d, a, b, x[i + 2], 17, 606105819); + b = md5ff(b, c, d, a, x[i + 3], 22, -1044525330); + a = md5ff(a, b, c, d, x[i + 4], 7, -176418897); + d = md5ff(d, a, b, c, x[i + 5], 12, 1200080426); + c = md5ff(c, d, a, b, x[i + 6], 17, -1473231341); + b = md5ff(b, c, d, a, x[i + 7], 22, -45705983); + a = md5ff(a, b, c, d, x[i + 8], 7, 1770035416); + d = md5ff(d, a, b, c, x[i + 9], 12, -1958414417); + c = md5ff(c, d, a, b, x[i + 10], 17, -42063); + b = md5ff(b, c, d, a, x[i + 11], 22, -1990404162); + a = md5ff(a, b, c, d, x[i + 12], 7, 1804603682); + d = md5ff(d, a, b, c, x[i + 13], 12, -40341101); + c = md5ff(c, d, a, b, x[i + 14], 17, -1502002290); + b = md5ff(b, c, d, a, x[i + 15], 22, 1236535329); + + a = md5gg(a, b, c, d, x[i + 1], 5, -165796510); + d = md5gg(d, a, b, c, x[i + 6], 9, -1069501632); + c = md5gg(c, d, a, b, x[i + 11], 14, 643717713); + b = md5gg(b, c, d, a, x[i], 20, -373897302); + a = md5gg(a, b, c, d, x[i + 5], 5, -701558691); + d = md5gg(d, a, b, c, x[i + 10], 9, 38016083); + c = md5gg(c, d, a, b, x[i + 15], 14, -660478335); + b = md5gg(b, c, d, a, x[i + 4], 20, -405537848); + a = md5gg(a, b, c, d, x[i + 9], 5, 568446438); + d = md5gg(d, a, b, c, x[i + 14], 9, -1019803690); + c = md5gg(c, d, a, b, x[i + 3], 14, -187363961); + b = md5gg(b, c, d, a, x[i + 8], 20, 1163531501); + a = md5gg(a, b, c, d, x[i + 13], 5, -1444681467); + d = md5gg(d, a, b, c, x[i + 2], 9, -51403784); + c = md5gg(c, d, a, b, x[i + 7], 14, 1735328473); + b = md5gg(b, c, d, a, x[i + 12], 20, -1926607734); + + a = md5hh(a, b, c, d, x[i + 5], 4, -378558); + d = md5hh(d, a, b, c, x[i + 8], 11, -2022574463); + c = md5hh(c, d, a, b, x[i + 11], 16, 1839030562); + b = md5hh(b, c, d, a, x[i + 14], 23, -35309556); + a = md5hh(a, b, c, d, x[i + 1], 4, -1530992060); + d = md5hh(d, a, b, c, x[i + 4], 11, 1272893353); + c = md5hh(c, d, a, b, x[i + 7], 16, -155497632); + b = md5hh(b, c, d, a, x[i + 10], 23, -1094730640); + a = md5hh(a, b, c, d, x[i + 13], 4, 681279174); + d = md5hh(d, a, b, c, x[i], 11, -358537222); + c = md5hh(c, d, a, b, x[i + 3], 16, -722521979); + b = md5hh(b, c, d, a, x[i + 6], 23, 76029189); + a = md5hh(a, b, c, d, x[i + 9], 4, -640364487); + d = md5hh(d, a, b, c, x[i + 12], 11, -421815835); + c = md5hh(c, d, a, b, x[i + 15], 16, 530742520); + b = md5hh(b, c, d, a, x[i + 2], 23, -995338651); + + a = md5ii(a, b, c, d, x[i], 6, -198630844); + d = md5ii(d, a, b, c, x[i + 7], 10, 1126891415); + c = md5ii(c, d, a, b, x[i + 14], 15, -1416354905); + b = md5ii(b, c, d, a, x[i + 5], 21, -57434055); + a = md5ii(a, b, c, d, x[i + 12], 6, 1700485571); + d = md5ii(d, a, b, c, x[i + 3], 10, -1894986606); + c = md5ii(c, d, a, b, x[i + 10], 15, -1051523); + b = md5ii(b, c, d, a, x[i + 1], 21, -2054922799); + a = md5ii(a, b, c, d, x[i + 8], 6, 1873313359); + d = md5ii(d, a, b, c, x[i + 15], 10, -30611744); + c = md5ii(c, d, a, b, x[i + 6], 15, -1560198380); + b = md5ii(b, c, d, a, x[i + 13], 21, 1309151649); + a = md5ii(a, b, c, d, x[i + 4], 6, -145523070); + d = md5ii(d, a, b, c, x[i + 11], 10, -1120210379); + c = md5ii(c, d, a, b, x[i + 2], 15, 718787259); + b = md5ii(b, c, d, a, x[i + 9], 21, -343485551); + + a = safeAdd(a, olda); + b = safeAdd(b, oldb); + c = safeAdd(c, oldc); + d = safeAdd(d, oldd); + } + return [a, b, c, d]; +} + +/* +* Convert an array bytes to an array of little-endian words +* Characters >255 have their high-byte silently ignored. +*/ +function bytesToWords(input) { + var i; + var output = []; + output[(input.length >> 2) - 1] = undefined; + for (i = 0; i < output.length; i += 1) { + output[i] = 0; + } + var length8 = input.length * 8; + for (i = 0; i < length8; i += 8) { + output[i >> 5] |= (input[(i / 8)] & 0xFF) << (i % 32); + } + + return output; +} + +/* +* Add integers, wrapping at 2^32. This uses 16-bit operations internally +* to work around bugs in some JS interpreters. +*/ +function safeAdd(x, y) { + var lsw = (x & 0xFFFF) + (y & 0xFFFF); + var msw = (x >> 16) + (y >> 16) + (lsw >> 16); + return (msw << 16) | (lsw & 0xFFFF); +} + +/* +* Bitwise rotate a 32-bit number to the left. +*/ +function bitRotateLeft(num, cnt) { + return (num << cnt) | (num >>> (32 - cnt)); +} + +/* +* These functions implement the four basic operations the algorithm uses. +*/ +function md5cmn(q, a, b, x, s, t) { + return safeAdd(bitRotateLeft(safeAdd(safeAdd(a, q), safeAdd(x, t)), s), b); +} +function md5ff(a, b, c, d, x, s, t) { + return md5cmn((b & c) | ((~b) & d), a, b, x, s, t); +} +function md5gg(a, b, c, d, x, s, t) { + return md5cmn((b & d) | (c & (~d)), a, b, x, s, t); +} +function md5hh(a, b, c, d, x, s, t) { + return md5cmn(b ^ c ^ d, a, b, x, s, t); +} +function md5ii(a, b, c, d, x, s, t) { + return md5cmn(c ^ (b | (~d)), a, b, x, s, t); +} + +module.exports = md5; diff --git a/node_modules/uuid/lib/md5.js b/node_modules/uuid/lib/md5.js new file mode 100644 index 0000000..7044b87 --- /dev/null +++ b/node_modules/uuid/lib/md5.js @@ -0,0 +1,25 @@ +'use strict'; + +var crypto = require('crypto'); + +function md5(bytes) { + if (typeof Buffer.from === 'function') { + // Modern Buffer API + if (Array.isArray(bytes)) { + bytes = Buffer.from(bytes); + } else if (typeof bytes === 'string') { + bytes = Buffer.from(bytes, 'utf8'); + } + } else { + // Pre-v4 Buffer API + if (Array.isArray(bytes)) { + bytes = new Buffer(bytes); + } else if (typeof bytes === 'string') { + bytes = new Buffer(bytes, 'utf8'); + } + } + + return crypto.createHash('md5').update(bytes).digest(); +} + +module.exports = md5; diff --git a/node_modules/uuid/lib/rng-browser.js b/node_modules/uuid/lib/rng-browser.js new file mode 100644 index 0000000..6361fb8 --- /dev/null +++ b/node_modules/uuid/lib/rng-browser.js @@ -0,0 +1,34 @@ +// Unique ID creation requires a high quality random # generator. In the +// browser this is a little complicated due to unknown quality of Math.random() +// and inconsistent support for the `crypto` API. We do the best we can via +// feature-detection + +// getRandomValues needs to be invoked in a context where "this" is a Crypto +// implementation. Also, find the complete implementation of crypto on IE11. +var getRandomValues = (typeof(crypto) != 'undefined' && crypto.getRandomValues && crypto.getRandomValues.bind(crypto)) || + (typeof(msCrypto) != 'undefined' && typeof window.msCrypto.getRandomValues == 'function' && msCrypto.getRandomValues.bind(msCrypto)); + +if (getRandomValues) { + // WHATWG crypto RNG - http://wiki.whatwg.org/wiki/Crypto + var rnds8 = new Uint8Array(16); // eslint-disable-line no-undef + + module.exports = function whatwgRNG() { + getRandomValues(rnds8); + return rnds8; + }; +} else { + // Math.random()-based (RNG) + // + // If all else fails, use Math.random(). It's fast, but is of unspecified + // quality. + var rnds = new Array(16); + + module.exports = function mathRNG() { + for (var i = 0, r; i < 16; i++) { + if ((i & 0x03) === 0) r = Math.random() * 0x100000000; + rnds[i] = r >>> ((i & 0x03) << 3) & 0xff; + } + + return rnds; + }; +} diff --git a/node_modules/uuid/lib/rng.js b/node_modules/uuid/lib/rng.js new file mode 100644 index 0000000..58f0dc9 --- /dev/null +++ b/node_modules/uuid/lib/rng.js @@ -0,0 +1,8 @@ +// Unique ID creation requires a high quality random # generator. In node.js +// this is pretty straight-forward - we use the crypto API. + +var crypto = require('crypto'); + +module.exports = function nodeRNG() { + return crypto.randomBytes(16); +}; diff --git a/node_modules/uuid/lib/sha1-browser.js b/node_modules/uuid/lib/sha1-browser.js new file mode 100644 index 0000000..5758ed7 --- /dev/null +++ b/node_modules/uuid/lib/sha1-browser.js @@ -0,0 +1,89 @@ +// Adapted from Chris Veness' SHA1 code at +// http://www.movable-type.co.uk/scripts/sha1.html +'use strict'; + +function f(s, x, y, z) { + switch (s) { + case 0: return (x & y) ^ (~x & z); + case 1: return x ^ y ^ z; + case 2: return (x & y) ^ (x & z) ^ (y & z); + case 3: return x ^ y ^ z; + } +} + +function ROTL(x, n) { + return (x << n) | (x>>> (32 - n)); +} + +function sha1(bytes) { + var K = [0x5a827999, 0x6ed9eba1, 0x8f1bbcdc, 0xca62c1d6]; + var H = [0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0]; + + if (typeof(bytes) == 'string') { + var msg = unescape(encodeURIComponent(bytes)); // UTF8 escape + bytes = new Array(msg.length); + for (var i = 0; i < msg.length; i++) bytes[i] = msg.charCodeAt(i); + } + + bytes.push(0x80); + + var l = bytes.length/4 + 2; + var N = Math.ceil(l/16); + var M = new Array(N); + + for (var i=0; i>> 0; + e = d; + d = c; + c = ROTL(b, 30) >>> 0; + b = a; + a = T; + } + + H[0] = (H[0] + a) >>> 0; + H[1] = (H[1] + b) >>> 0; + H[2] = (H[2] + c) >>> 0; + H[3] = (H[3] + d) >>> 0; + H[4] = (H[4] + e) >>> 0; + } + + return [ + H[0] >> 24 & 0xff, H[0] >> 16 & 0xff, H[0] >> 8 & 0xff, H[0] & 0xff, + H[1] >> 24 & 0xff, H[1] >> 16 & 0xff, H[1] >> 8 & 0xff, H[1] & 0xff, + H[2] >> 24 & 0xff, H[2] >> 16 & 0xff, H[2] >> 8 & 0xff, H[2] & 0xff, + H[3] >> 24 & 0xff, H[3] >> 16 & 0xff, H[3] >> 8 & 0xff, H[3] & 0xff, + H[4] >> 24 & 0xff, H[4] >> 16 & 0xff, H[4] >> 8 & 0xff, H[4] & 0xff + ]; +} + +module.exports = sha1; diff --git a/node_modules/uuid/lib/sha1.js b/node_modules/uuid/lib/sha1.js new file mode 100644 index 0000000..0b54b25 --- /dev/null +++ b/node_modules/uuid/lib/sha1.js @@ -0,0 +1,25 @@ +'use strict'; + +var crypto = require('crypto'); + +function sha1(bytes) { + if (typeof Buffer.from === 'function') { + // Modern Buffer API + if (Array.isArray(bytes)) { + bytes = Buffer.from(bytes); + } else if (typeof bytes === 'string') { + bytes = Buffer.from(bytes, 'utf8'); + } + } else { + // Pre-v4 Buffer API + if (Array.isArray(bytes)) { + bytes = new Buffer(bytes); + } else if (typeof bytes === 'string') { + bytes = new Buffer(bytes, 'utf8'); + } + } + + return crypto.createHash('sha1').update(bytes).digest(); +} + +module.exports = sha1; diff --git a/node_modules/uuid/lib/v35.js b/node_modules/uuid/lib/v35.js new file mode 100644 index 0000000..8b066cc --- /dev/null +++ b/node_modules/uuid/lib/v35.js @@ -0,0 +1,57 @@ +var bytesToUuid = require('./bytesToUuid'); + +function uuidToBytes(uuid) { + // Note: We assume we're being passed a valid uuid string + var bytes = []; + uuid.replace(/[a-fA-F0-9]{2}/g, function(hex) { + bytes.push(parseInt(hex, 16)); + }); + + return bytes; +} + +function stringToBytes(str) { + str = unescape(encodeURIComponent(str)); // UTF8 escape + var bytes = new Array(str.length); + for (var i = 0; i < str.length; i++) { + bytes[i] = str.charCodeAt(i); + } + return bytes; +} + +module.exports = function(name, version, hashfunc) { + var generateUUID = function(value, namespace, buf, offset) { + var off = buf && offset || 0; + + if (typeof(value) == 'string') value = stringToBytes(value); + if (typeof(namespace) == 'string') namespace = uuidToBytes(namespace); + + if (!Array.isArray(value)) throw TypeError('value must be an array of bytes'); + if (!Array.isArray(namespace) || namespace.length !== 16) throw TypeError('namespace must be uuid string or an Array of 16 byte values'); + + // Per 4.3 + var bytes = hashfunc(namespace.concat(value)); + bytes[6] = (bytes[6] & 0x0f) | version; + bytes[8] = (bytes[8] & 0x3f) | 0x80; + + if (buf) { + for (var idx = 0; idx < 16; ++idx) { + buf[off+idx] = bytes[idx]; + } + } + + return buf || bytesToUuid(bytes); + }; + + // Function#name is not settable on some platforms (#270) + try { + generateUUID.name = name; + } catch (err) { + } + + // Pre-defined namespaces, per Appendix C + generateUUID.DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8'; + generateUUID.URL = '6ba7b811-9dad-11d1-80b4-00c04fd430c8'; + + return generateUUID; +}; diff --git a/node_modules/uuid/package.json b/node_modules/uuid/package.json new file mode 100644 index 0000000..3a9c917 --- /dev/null +++ b/node_modules/uuid/package.json @@ -0,0 +1,95 @@ +{ + "_from": "uuid@3.3.2", + "_id": "uuid@3.3.2", + "_inBundle": false, + "_integrity": "sha512-yXJmeNaw3DnnKAOKJE51sL/ZaYfWJRl1pK9dr19YFCu0ObS231AB1/LbqTKRAQ5kw8A90rA6fr4riOUpTZvQZA==", + "_location": "/uuid", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "uuid@3.3.2", + "name": "uuid", + "escapedName": "uuid", + "rawSpec": "3.3.2", + "saveSpec": null, + "fetchSpec": "3.3.2" + }, + "_requiredBy": [ + "/aws-sdk" + ], + "_resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.2.tgz", + "_shasum": "1b4af4955eb3077c501c23872fc6513811587131", + "_spec": "uuid@3.3.2", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/aws-sdk", + "bin": { + "uuid": "./bin/uuid" + }, + "browser": { + "./lib/rng.js": "./lib/rng-browser.js", + "./lib/sha1.js": "./lib/sha1-browser.js", + "./lib/md5.js": "./lib/md5-browser.js" + }, + "bugs": { + "url": "https://github.com/kelektiv/node-uuid/issues" + }, + "bundleDependencies": false, + "commitlint": { + "extends": [ + "@commitlint/config-conventional" + ] + }, + "contributors": [ + { + "name": "Robert Kieffer", + "email": "robert@broofa.com" + }, + { + "name": "Christoph Tavan", + "email": "dev@tavan.de" + }, + { + "name": "AJ ONeal", + "email": "coolaj86@gmail.com" + }, + { + "name": "Vincent Voyer", + "email": "vincent@zeroload.net" + }, + { + "name": "Roman Shtylman", + "email": "shtylman@gmail.com" + } + ], + "deprecated": false, + "description": "RFC4122 (v1, v4, and v5) UUIDs", + "devDependencies": { + "@commitlint/cli": "7.0.0", + "@commitlint/config-conventional": "7.0.1", + "eslint": "4.19.1", + "husky": "0.14.3", + "mocha": "5.2.0", + "runmd": "1.0.1", + "standard-version": "4.4.0" + }, + "homepage": "https://github.com/kelektiv/node-uuid#readme", + "keywords": [ + "uuid", + "guid", + "rfc4122" + ], + "license": "MIT", + "name": "uuid", + "repository": { + "type": "git", + "url": "git+https://github.com/kelektiv/node-uuid.git" + }, + "scripts": { + "commitmsg": "commitlint -E GIT_PARAMS", + "md": "runmd --watch --output=README.md README_js.md", + "prepare": "runmd --output=README.md README_js.md", + "release": "standard-version", + "test": "mocha test/test.js" + }, + "version": "3.3.2" +} diff --git a/node_modules/uuid/v1.js b/node_modules/uuid/v1.js new file mode 100644 index 0000000..d84c0f4 --- /dev/null +++ b/node_modules/uuid/v1.js @@ -0,0 +1,109 @@ +var rng = require('./lib/rng'); +var bytesToUuid = require('./lib/bytesToUuid'); + +// **`v1()` - Generate time-based UUID** +// +// Inspired by https://github.com/LiosK/UUID.js +// and http://docs.python.org/library/uuid.html + +var _nodeId; +var _clockseq; + +// Previous uuid creation time +var _lastMSecs = 0; +var _lastNSecs = 0; + +// See https://github.com/broofa/node-uuid for API details +function v1(options, buf, offset) { + var i = buf && offset || 0; + var b = buf || []; + + options = options || {}; + var node = options.node || _nodeId; + var clockseq = options.clockseq !== undefined ? options.clockseq : _clockseq; + + // node and clockseq need to be initialized to random values if they're not + // specified. We do this lazily to minimize issues related to insufficient + // system entropy. See #189 + if (node == null || clockseq == null) { + var seedBytes = rng(); + if (node == null) { + // Per 4.5, create and 48-bit node id, (47 random bits + multicast bit = 1) + node = _nodeId = [ + seedBytes[0] | 0x01, + seedBytes[1], seedBytes[2], seedBytes[3], seedBytes[4], seedBytes[5] + ]; + } + if (clockseq == null) { + // Per 4.2.2, randomize (14 bit) clockseq + clockseq = _clockseq = (seedBytes[6] << 8 | seedBytes[7]) & 0x3fff; + } + } + + // UUID timestamps are 100 nano-second units since the Gregorian epoch, + // (1582-10-15 00:00). JSNumbers aren't precise enough for this, so + // time is handled internally as 'msecs' (integer milliseconds) and 'nsecs' + // (100-nanoseconds offset from msecs) since unix epoch, 1970-01-01 00:00. + var msecs = options.msecs !== undefined ? options.msecs : new Date().getTime(); + + // Per 4.2.1.2, use count of uuid's generated during the current clock + // cycle to simulate higher resolution clock + var nsecs = options.nsecs !== undefined ? options.nsecs : _lastNSecs + 1; + + // Time since last uuid creation (in msecs) + var dt = (msecs - _lastMSecs) + (nsecs - _lastNSecs)/10000; + + // Per 4.2.1.2, Bump clockseq on clock regression + if (dt < 0 && options.clockseq === undefined) { + clockseq = clockseq + 1 & 0x3fff; + } + + // Reset nsecs if clock regresses (new clockseq) or we've moved onto a new + // time interval + if ((dt < 0 || msecs > _lastMSecs) && options.nsecs === undefined) { + nsecs = 0; + } + + // Per 4.2.1.2 Throw error if too many uuids are requested + if (nsecs >= 10000) { + throw new Error('uuid.v1(): Can\'t create more than 10M uuids/sec'); + } + + _lastMSecs = msecs; + _lastNSecs = nsecs; + _clockseq = clockseq; + + // Per 4.1.4 - Convert from unix epoch to Gregorian epoch + msecs += 12219292800000; + + // `time_low` + var tl = ((msecs & 0xfffffff) * 10000 + nsecs) % 0x100000000; + b[i++] = tl >>> 24 & 0xff; + b[i++] = tl >>> 16 & 0xff; + b[i++] = tl >>> 8 & 0xff; + b[i++] = tl & 0xff; + + // `time_mid` + var tmh = (msecs / 0x100000000 * 10000) & 0xfffffff; + b[i++] = tmh >>> 8 & 0xff; + b[i++] = tmh & 0xff; + + // `time_high_and_version` + b[i++] = tmh >>> 24 & 0xf | 0x10; // include version + b[i++] = tmh >>> 16 & 0xff; + + // `clock_seq_hi_and_reserved` (Per 4.2.2 - include variant) + b[i++] = clockseq >>> 8 | 0x80; + + // `clock_seq_low` + b[i++] = clockseq & 0xff; + + // `node` + for (var n = 0; n < 6; ++n) { + b[i + n] = node[n]; + } + + return buf ? buf : bytesToUuid(b); +} + +module.exports = v1; diff --git a/node_modules/uuid/v3.js b/node_modules/uuid/v3.js new file mode 100644 index 0000000..ee7e14c --- /dev/null +++ b/node_modules/uuid/v3.js @@ -0,0 +1,4 @@ +var v35 = require('./lib/v35.js'); +var md5 = require('./lib/md5'); + +module.exports = v35('v3', 0x30, md5); \ No newline at end of file diff --git a/node_modules/uuid/v4.js b/node_modules/uuid/v4.js new file mode 100644 index 0000000..1f07be1 --- /dev/null +++ b/node_modules/uuid/v4.js @@ -0,0 +1,29 @@ +var rng = require('./lib/rng'); +var bytesToUuid = require('./lib/bytesToUuid'); + +function v4(options, buf, offset) { + var i = buf && offset || 0; + + if (typeof(options) == 'string') { + buf = options === 'binary' ? new Array(16) : null; + options = null; + } + options = options || {}; + + var rnds = options.random || (options.rng || rng)(); + + // Per 4.4, set bits for version and `clock_seq_hi_and_reserved` + rnds[6] = (rnds[6] & 0x0f) | 0x40; + rnds[8] = (rnds[8] & 0x3f) | 0x80; + + // Copy bytes to buffer, if provided + if (buf) { + for (var ii = 0; ii < 16; ++ii) { + buf[i + ii] = rnds[ii]; + } + } + + return buf || bytesToUuid(rnds); +} + +module.exports = v4; diff --git a/node_modules/uuid/v5.js b/node_modules/uuid/v5.js new file mode 100644 index 0000000..4945baf --- /dev/null +++ b/node_modules/uuid/v5.js @@ -0,0 +1,3 @@ +var v35 = require('./lib/v35.js'); +var sha1 = require('./lib/sha1'); +module.exports = v35('v5', 0x50, sha1); diff --git a/node_modules/xml2js/LICENSE b/node_modules/xml2js/LICENSE new file mode 100644 index 0000000..e3b4222 --- /dev/null +++ b/node_modules/xml2js/LICENSE @@ -0,0 +1,19 @@ +Copyright 2010, 2011, 2012, 2013. All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to +deal in the Software without restriction, including without limitation the +rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +sell copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +IN THE SOFTWARE. diff --git a/node_modules/xml2js/README.md b/node_modules/xml2js/README.md new file mode 100644 index 0000000..9c69d6f --- /dev/null +++ b/node_modules/xml2js/README.md @@ -0,0 +1,406 @@ +node-xml2js +=========== + +Ever had the urge to parse XML? And wanted to access the data in some sane, +easy way? Don't want to compile a C parser, for whatever reason? Then xml2js is +what you're looking for! + +Description +=========== + +Simple XML to JavaScript object converter. It supports bi-directional conversion. +Uses [sax-js](https://github.com/isaacs/sax-js/) and +[xmlbuilder-js](https://github.com/oozcitak/xmlbuilder-js/). + +Note: If you're looking for a full DOM parser, you probably want +[JSDom](https://github.com/tmpvar/jsdom). + +Installation +============ + +Simplest way to install `xml2js` is to use [npm](http://npmjs.org), just `npm +install xml2js` which will download xml2js and all dependencies. + +xml2js is also available via [Bower](http://bower.io/), just `bower install +xml2js` which will download xml2js and all dependencies. + +Usage +===== + +No extensive tutorials required because you are a smart developer! The task of +parsing XML should be an easy one, so let's make it so! Here's some examples. + +Shoot-and-forget usage +---------------------- + +You want to parse XML as simple and easy as possible? It's dangerous to go +alone, take this: + +```javascript +var parseString = require('xml2js').parseString; +var xml = "Hello xml2js!" +parseString(xml, function (err, result) { + console.dir(result); +}); +``` + +Can't get easier than this, right? This works starting with `xml2js` 0.2.3. +With CoffeeScript it looks like this: + +```coffeescript +{parseString} = require 'xml2js' +xml = "Hello xml2js!" +parseString xml, (err, result) -> + console.dir result +``` + +If you need some special options, fear not, `xml2js` supports a number of +options (see below), you can specify these as second argument: + +```javascript +parseString(xml, {trim: true}, function (err, result) { +}); +``` + +Simple as pie usage +------------------- + +That's right, if you have been using xml-simple or a home-grown +wrapper, this was added in 0.1.11 just for you: + +```javascript +var fs = require('fs'), + xml2js = require('xml2js'); + +var parser = new xml2js.Parser(); +fs.readFile(__dirname + '/foo.xml', function(err, data) { + parser.parseString(data, function (err, result) { + console.dir(result); + console.log('Done'); + }); +}); +``` + +Look ma, no event listeners! + +You can also use `xml2js` from +[CoffeeScript](https://github.com/jashkenas/coffeescript), further reducing +the clutter: + +```coffeescript +fs = require 'fs', +xml2js = require 'xml2js' + +parser = new xml2js.Parser() +fs.readFile __dirname + '/foo.xml', (err, data) -> + parser.parseString data, (err, result) -> + console.dir result + console.log 'Done.' +``` + +But what happens if you forget the `new` keyword to create a new `Parser`? In +the middle of a nightly coding session, it might get lost, after all. Worry +not, we got you covered! Starting with 0.2.8 you can also leave it out, in +which case `xml2js` will helpfully add it for you, no bad surprises and +inexplicable bugs! + +Parsing multiple files +---------------------- + +If you want to parse multiple files, you have multiple possibilities: + + * You can create one `xml2js.Parser` per file. That's the recommended one + and is promised to always *just work*. + * You can call `reset()` on your parser object. + * You can hope everything goes well anyway. This behaviour is not + guaranteed work always, if ever. Use option #1 if possible. Thanks! + +So you wanna some JSON? +----------------------- + +Just wrap the `result` object in a call to `JSON.stringify` like this +`JSON.stringify(result)`. You get a string containing the JSON representation +of the parsed object that you can feed to JSON-hungry consumers. + +Displaying results +------------------ + +You might wonder why, using `console.dir` or `console.log` the output at some +level is only `[Object]`. Don't worry, this is not because `xml2js` got lazy. +That's because Node uses `util.inspect` to convert the object into strings and +that function stops after `depth=2` which is a bit low for most XML. + +To display the whole deal, you can use `console.log(util.inspect(result, false, +null))`, which displays the whole result. + +So much for that, but what if you use +[eyes](https://github.com/cloudhead/eyes.js) for nice colored output and it +truncates the output with `…`? Don't fear, there's also a solution for that, +you just need to increase the `maxLength` limit by creating a custom inspector +`var inspect = require('eyes').inspector({maxLength: false})` and then you can +easily `inspect(result)`. + +XML builder usage +----------------- + +Since 0.4.0, objects can be also be used to build XML: + +```javascript +var fs = require('fs'), + xml2js = require('xml2js'); + +var obj = {name: "Super", Surname: "Man", age: 23}; + +var builder = new xml2js.Builder(); +var xml = builder.buildObject(obj); +``` + +At the moment, a one to one bi-directional conversion is guaranteed only for +default configuration, except for `attrkey`, `charkey` and `explicitArray` options +you can redefine to your taste. Writing CDATA is supported via setting the `cdata` +option to `true`. + +Processing attribute, tag names and values +------------------------------------------ + +Since 0.4.1 you can optionally provide the parser with attribute name and tag name processors as well as element value processors (Since 0.4.14, you can also optionally provide the parser with attribute value processors): + +```javascript + +function nameToUpperCase(name){ + return name.toUpperCase(); +} + +//transform all attribute and tag names and values to uppercase +parseString(xml, { + tagNameProcessors: [nameToUpperCase], + attrNameProcessors: [nameToUpperCase], + valueProcessors: [nameToUpperCase], + attrValueProcessors: [nameToUpperCase]}, + function (err, result) { + // processed data +}); +``` + +The `tagNameProcessors` and `attrNameProcessors` options +accept an `Array` of functions with the following signature: + +```javascript +function (name){ + //do something with `name` + return name +} +``` + +The `attrValueProcessors` and `valueProcessors` options +accept an `Array` of functions with the following signature: + +```javascript +function (value, name) { + //`name` will be the node name or attribute name + //do something with `value`, (optionally) dependent on the node/attr name + return value +} +``` + +Some processors are provided out-of-the-box and can be found in `lib/processors.js`: + +- `normalize`: transforms the name to lowercase. +(Automatically used when `options.normalize` is set to `true`) + +- `firstCharLowerCase`: transforms the first character to lower case. +E.g. 'MyTagName' becomes 'myTagName' + +- `stripPrefix`: strips the xml namespace prefix. E.g `` will become 'Bar'. +(N.B.: the `xmlns` prefix is NOT stripped.) + +- `parseNumbers`: parses integer-like strings as integers and float-like strings as floats +E.g. "0" becomes 0 and "15.56" becomes 15.56 + +- `parseBooleans`: parses boolean-like strings to booleans +E.g. "true" becomes true and "False" becomes false + +Options +======= + +Apart from the default settings, there are a number of options that can be +specified for the parser. Options are specified by ``new Parser({optionName: +value})``. Possible options are: + + * `attrkey` (default: `$`): Prefix that is used to access the attributes. + Version 0.1 default was `@`. + * `charkey` (default: `_`): Prefix that is used to access the character + content. Version 0.1 default was `#`. + * `explicitCharkey` (default: `false`) + * `trim` (default: `false`): Trim the whitespace at the beginning and end of + text nodes. + * `normalizeTags` (default: `false`): Normalize all tag names to lowercase. + * `normalize` (default: `false`): Trim whitespaces inside text nodes. + * `explicitRoot` (default: `true`): Set this if you want to get the root + node in the resulting object. + * `emptyTag` (default: `''`): what will the value of empty nodes be. + * `explicitArray` (default: `true`): Always put child nodes in an array if + true; otherwise an array is created only if there is more than one. + * `ignoreAttrs` (default: `false`): Ignore all XML attributes and only create + text nodes. + * `mergeAttrs` (default: `false`): Merge attributes and child elements as + properties of the parent, instead of keying attributes off a child + attribute object. This option is ignored if `ignoreAttrs` is `false`. + * `validator` (default `null`): You can specify a callable that validates + the resulting structure somehow, however you want. See unit tests + for an example. + * `xmlns` (default `false`): Give each element a field usually called '$ns' + (the first character is the same as attrkey) that contains its local name + and namespace URI. + * `explicitChildren` (default `false`): Put child elements to separate + property. Doesn't work with `mergeAttrs = true`. If element has no children + then "children" won't be created. Added in 0.2.5. + * `childkey` (default `$$`): Prefix that is used to access child elements if + `explicitChildren` is set to `true`. Added in 0.2.5. + * `preserveChildrenOrder` (default `false`): Modifies the behavior of + `explicitChildren` so that the value of the "children" property becomes an + ordered array. When this is `true`, every node will also get a `#name` field + whose value will correspond to the XML nodeName, so that you may iterate + the "children" array and still be able to determine node names. The named + (and potentially unordered) properties are also retained in this + configuration at the same level as the ordered "children" array. Added in + 0.4.9. + * `charsAsChildren` (default `false`): Determines whether chars should be + considered children if `explicitChildren` is on. Added in 0.2.5. + * `includeWhiteChars` (default `false`): Determines whether whitespace-only + text nodes should be included. Added in 0.4.17. + * `async` (default `false`): Should the callbacks be async? This *might* be + an incompatible change if your code depends on sync execution of callbacks. + Future versions of `xml2js` might change this default, so the recommendation + is to not depend on sync execution anyway. Added in 0.2.6. + * `strict` (default `true`): Set sax-js to strict or non-strict parsing mode. + Defaults to `true` which is *highly* recommended, since parsing HTML which + is not well-formed XML might yield just about anything. Added in 0.2.7. + * `attrNameProcessors` (default: `null`): Allows the addition of attribute + name processing functions. Accepts an `Array` of functions with following + signature: + ```javascript + function (name){ + //do something with `name` + return name + } + ``` + Added in 0.4.14 + * `attrValueProcessors` (default: `null`): Allows the addition of attribute + value processing functions. Accepts an `Array` of functions with following + signature: + ```javascript + function (name){ + //do something with `name` + return name + } + ``` + Added in 0.4.1 + * `tagNameProcessors` (default: `null`): Allows the addition of tag name + processing functions. Accepts an `Array` of functions with following + signature: + ```javascript + function (name){ + //do something with `name` + return name + } + ``` + Added in 0.4.1 + * `valueProcessors` (default: `null`): Allows the addition of element value + processing functions. Accepts an `Array` of functions with following + signature: + ```javascript + function (name){ + //do something with `name` + return name + } + ``` + Added in 0.4.6 + +Options for the `Builder` class +------------------------------- +These options are specified by ``new Builder({optionName: value})``. +Possible options are: + + * `rootName` (default `root` or the root key name): root element name to be used in case + `explicitRoot` is `false` or to override the root element name. + * `renderOpts` (default `{ 'pretty': true, 'indent': ' ', 'newline': '\n' }`): + Rendering options for xmlbuilder-js. + * pretty: prettify generated XML + * indent: whitespace for indentation (only when pretty) + * newline: newline char (only when pretty) + * `xmldec` (default `{ 'version': '1.0', 'encoding': 'UTF-8', 'standalone': true }`: + XML declaration attributes. + * `xmldec.version` A version number string, e.g. 1.0 + * `xmldec.encoding` Encoding declaration, e.g. UTF-8 + * `xmldec.standalone` standalone document declaration: true or false + * `doctype` (default `null`): optional DTD. Eg. `{'ext': 'hello.dtd'}` + * `headless` (default: `false`): omit the XML header. Added in 0.4.3. + * `allowSurrogateChars` (default: `false`): allows using characters from the Unicode + surrogate blocks. + * `cdata` (default: `false`): wrap text nodes in `` instead of + escaping when necessary. Does not add `` if it is not required. + Added in 0.4.5. + +`renderOpts`, `xmldec`,`doctype` and `headless` pass through to +[xmlbuilder-js](https://github.com/oozcitak/xmlbuilder-js). + +Updating to new version +======================= + +Version 0.2 changed the default parsing settings, but version 0.1.14 introduced +the default settings for version 0.2, so these settings can be tried before the +migration. + +```javascript +var xml2js = require('xml2js'); +var parser = new xml2js.Parser(xml2js.defaults["0.2"]); +``` + +To get the 0.1 defaults in version 0.2 you can just use +`xml2js.defaults["0.1"]` in the same place. This provides you with enough time +to migrate to the saner way of parsing in `xml2js` 0.2. We try to make the +migration as simple and gentle as possible, but some breakage cannot be +avoided. + +So, what exactly did change and why? In 0.2 we changed some defaults to parse +the XML in a more universal and sane way. So we disabled `normalize` and `trim` +so `xml2js` does not cut out any text content. You can reenable this at will of +course. A more important change is that we return the root tag in the resulting +JavaScript structure via the `explicitRoot` setting, so you need to access the +first element. This is useful for anybody who wants to know what the root node +is and preserves more information. The last major change was to enable +`explicitArray`, so everytime it is possible that one might embed more than one +sub-tag into a tag, xml2js >= 0.2 returns an array even if the array just +includes one element. This is useful when dealing with APIs that return +variable amounts of subtags. + +Running tests, development +========================== + +[![Build Status](https://travis-ci.org/Leonidas-from-XIV/node-xml2js.svg?branch=master)](https://travis-ci.org/Leonidas-from-XIV/node-xml2js) +[![Coverage Status](https://coveralls.io/repos/Leonidas-from-XIV/node-xml2js/badge.svg?branch=)](https://coveralls.io/r/Leonidas-from-XIV/node-xml2js?branch=master) +[![Dependency Status](https://david-dm.org/Leonidas-from-XIV/node-xml2js.svg)](https://david-dm.org/Leonidas-from-XIV/node-xml2js) + +The development requirements are handled by npm, you just need to install them. +We also have a number of unit tests, they can be run using `npm test` directly +from the project root. This runs zap to discover all the tests and execute +them. + +If you like to contribute, keep in mind that `xml2js` is written in +CoffeeScript, so don't develop on the JavaScript files that are checked into +the repository for convenience reasons. Also, please write some unit test to +check your behaviour and if it is some user-facing thing, add some +documentation to this README, so people will know it exists. Thanks in advance! + +Getting support +=============== + +Please, if you have a problem with the library, first make sure you read this +README. If you read this far, thanks, you're good. Then, please make sure your +problem really is with `xml2js`. It is? Okay, then I'll look at it. Send me a +mail and we can talk. Please don't open issues, as I don't think that is the +proper forum for support problems. Some problems might as well really be bugs +in `xml2js`, if so I'll let you know to open an issue instead :) + +But if you know you really found a bug, feel free to open an issue instead. diff --git a/node_modules/xml2js/lib/bom.js b/node_modules/xml2js/lib/bom.js new file mode 100644 index 0000000..7b8fb27 --- /dev/null +++ b/node_modules/xml2js/lib/bom.js @@ -0,0 +1,12 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + "use strict"; + exports.stripBOM = function(str) { + if (str[0] === '\uFEFF') { + return str.substring(1); + } else { + return str; + } + }; + +}).call(this); diff --git a/node_modules/xml2js/lib/builder.js b/node_modules/xml2js/lib/builder.js new file mode 100644 index 0000000..58f3638 --- /dev/null +++ b/node_modules/xml2js/lib/builder.js @@ -0,0 +1,127 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + "use strict"; + var builder, defaults, escapeCDATA, requiresCDATA, wrapCDATA, + hasProp = {}.hasOwnProperty; + + builder = require('xmlbuilder'); + + defaults = require('./defaults').defaults; + + requiresCDATA = function(entry) { + return typeof entry === "string" && (entry.indexOf('&') >= 0 || entry.indexOf('>') >= 0 || entry.indexOf('<') >= 0); + }; + + wrapCDATA = function(entry) { + return ""; + }; + + escapeCDATA = function(entry) { + return entry.replace(']]>', ']]]]>'); + }; + + exports.Builder = (function() { + function Builder(opts) { + var key, ref, value; + this.options = {}; + ref = defaults["0.2"]; + for (key in ref) { + if (!hasProp.call(ref, key)) continue; + value = ref[key]; + this.options[key] = value; + } + for (key in opts) { + if (!hasProp.call(opts, key)) continue; + value = opts[key]; + this.options[key] = value; + } + } + + Builder.prototype.buildObject = function(rootObj) { + var attrkey, charkey, render, rootElement, rootName; + attrkey = this.options.attrkey; + charkey = this.options.charkey; + if ((Object.keys(rootObj).length === 1) && (this.options.rootName === defaults['0.2'].rootName)) { + rootName = Object.keys(rootObj)[0]; + rootObj = rootObj[rootName]; + } else { + rootName = this.options.rootName; + } + render = (function(_this) { + return function(element, obj) { + var attr, child, entry, index, key, value; + if (typeof obj !== 'object') { + if (_this.options.cdata && requiresCDATA(obj)) { + element.raw(wrapCDATA(obj)); + } else { + element.txt(obj); + } + } else if (Array.isArray(obj)) { + for (index in obj) { + if (!hasProp.call(obj, index)) continue; + child = obj[index]; + for (key in child) { + entry = child[key]; + element = render(element.ele(key), entry).up(); + } + } + } else { + for (key in obj) { + if (!hasProp.call(obj, key)) continue; + child = obj[key]; + if (key === attrkey) { + if (typeof child === "object") { + for (attr in child) { + value = child[attr]; + element = element.att(attr, value); + } + } + } else if (key === charkey) { + if (_this.options.cdata && requiresCDATA(child)) { + element = element.raw(wrapCDATA(child)); + } else { + element = element.txt(child); + } + } else if (Array.isArray(child)) { + for (index in child) { + if (!hasProp.call(child, index)) continue; + entry = child[index]; + if (typeof entry === 'string') { + if (_this.options.cdata && requiresCDATA(entry)) { + element = element.ele(key).raw(wrapCDATA(entry)).up(); + } else { + element = element.ele(key, entry).up(); + } + } else { + element = render(element.ele(key), entry).up(); + } + } + } else if (typeof child === "object") { + element = render(element.ele(key), child).up(); + } else { + if (typeof child === 'string' && _this.options.cdata && requiresCDATA(child)) { + element = element.ele(key).raw(wrapCDATA(child)).up(); + } else { + if (child == null) { + child = ''; + } + element = element.ele(key, child.toString()).up(); + } + } + } + } + return element; + }; + })(this); + rootElement = builder.create(rootName, this.options.xmldec, this.options.doctype, { + headless: this.options.headless, + allowSurrogateChars: this.options.allowSurrogateChars + }); + return render(rootElement, rootObj).end(this.options.renderOpts); + }; + + return Builder; + + })(); + +}).call(this); diff --git a/node_modules/xml2js/lib/defaults.js b/node_modules/xml2js/lib/defaults.js new file mode 100644 index 0000000..0a21da0 --- /dev/null +++ b/node_modules/xml2js/lib/defaults.js @@ -0,0 +1,72 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + exports.defaults = { + "0.1": { + explicitCharkey: false, + trim: true, + normalize: true, + normalizeTags: false, + attrkey: "@", + charkey: "#", + explicitArray: false, + ignoreAttrs: false, + mergeAttrs: false, + explicitRoot: false, + validator: null, + xmlns: false, + explicitChildren: false, + childkey: '@@', + charsAsChildren: false, + includeWhiteChars: false, + async: false, + strict: true, + attrNameProcessors: null, + attrValueProcessors: null, + tagNameProcessors: null, + valueProcessors: null, + emptyTag: '' + }, + "0.2": { + explicitCharkey: false, + trim: false, + normalize: false, + normalizeTags: false, + attrkey: "$", + charkey: "_", + explicitArray: true, + ignoreAttrs: false, + mergeAttrs: false, + explicitRoot: true, + validator: null, + xmlns: false, + explicitChildren: false, + preserveChildrenOrder: false, + childkey: '$$', + charsAsChildren: false, + includeWhiteChars: false, + async: false, + strict: true, + attrNameProcessors: null, + attrValueProcessors: null, + tagNameProcessors: null, + valueProcessors: null, + rootName: 'root', + xmldec: { + 'version': '1.0', + 'encoding': 'UTF-8', + 'standalone': true + }, + doctype: null, + renderOpts: { + 'pretty': true, + 'indent': ' ', + 'newline': '\n' + }, + headless: false, + chunkSize: 10000, + emptyTag: '', + cdata: false + } + }; + +}).call(this); diff --git a/node_modules/xml2js/lib/parser.js b/node_modules/xml2js/lib/parser.js new file mode 100644 index 0000000..9e8261e --- /dev/null +++ b/node_modules/xml2js/lib/parser.js @@ -0,0 +1,357 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + "use strict"; + var bom, defaults, events, isEmpty, processItem, processors, sax, setImmediate, + bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; }, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + sax = require('sax'); + + events = require('events'); + + bom = require('./bom'); + + processors = require('./processors'); + + setImmediate = require('timers').setImmediate; + + defaults = require('./defaults').defaults; + + isEmpty = function(thing) { + return typeof thing === "object" && (thing != null) && Object.keys(thing).length === 0; + }; + + processItem = function(processors, item, key) { + var i, len, process; + for (i = 0, len = processors.length; i < len; i++) { + process = processors[i]; + item = process(item, key); + } + return item; + }; + + exports.Parser = (function(superClass) { + extend(Parser, superClass); + + function Parser(opts) { + this.parseString = bind(this.parseString, this); + this.reset = bind(this.reset, this); + this.assignOrPush = bind(this.assignOrPush, this); + this.processAsync = bind(this.processAsync, this); + var key, ref, value; + if (!(this instanceof exports.Parser)) { + return new exports.Parser(opts); + } + this.options = {}; + ref = defaults["0.2"]; + for (key in ref) { + if (!hasProp.call(ref, key)) continue; + value = ref[key]; + this.options[key] = value; + } + for (key in opts) { + if (!hasProp.call(opts, key)) continue; + value = opts[key]; + this.options[key] = value; + } + if (this.options.xmlns) { + this.options.xmlnskey = this.options.attrkey + "ns"; + } + if (this.options.normalizeTags) { + if (!this.options.tagNameProcessors) { + this.options.tagNameProcessors = []; + } + this.options.tagNameProcessors.unshift(processors.normalize); + } + this.reset(); + } + + Parser.prototype.processAsync = function() { + var chunk, err; + try { + if (this.remaining.length <= this.options.chunkSize) { + chunk = this.remaining; + this.remaining = ''; + this.saxParser = this.saxParser.write(chunk); + return this.saxParser.close(); + } else { + chunk = this.remaining.substr(0, this.options.chunkSize); + this.remaining = this.remaining.substr(this.options.chunkSize, this.remaining.length); + this.saxParser = this.saxParser.write(chunk); + return setImmediate(this.processAsync); + } + } catch (error1) { + err = error1; + if (!this.saxParser.errThrown) { + this.saxParser.errThrown = true; + return this.emit(err); + } + } + }; + + Parser.prototype.assignOrPush = function(obj, key, newValue) { + if (!(key in obj)) { + if (!this.options.explicitArray) { + return obj[key] = newValue; + } else { + return obj[key] = [newValue]; + } + } else { + if (!(obj[key] instanceof Array)) { + obj[key] = [obj[key]]; + } + return obj[key].push(newValue); + } + }; + + Parser.prototype.reset = function() { + var attrkey, charkey, ontext, stack; + this.removeAllListeners(); + this.saxParser = sax.parser(this.options.strict, { + trim: false, + normalize: false, + xmlns: this.options.xmlns + }); + this.saxParser.errThrown = false; + this.saxParser.onerror = (function(_this) { + return function(error) { + _this.saxParser.resume(); + if (!_this.saxParser.errThrown) { + _this.saxParser.errThrown = true; + return _this.emit("error", error); + } + }; + })(this); + this.saxParser.onend = (function(_this) { + return function() { + if (!_this.saxParser.ended) { + _this.saxParser.ended = true; + return _this.emit("end", _this.resultObject); + } + }; + })(this); + this.saxParser.ended = false; + this.EXPLICIT_CHARKEY = this.options.explicitCharkey; + this.resultObject = null; + stack = []; + attrkey = this.options.attrkey; + charkey = this.options.charkey; + this.saxParser.onopentag = (function(_this) { + return function(node) { + var key, newValue, obj, processedKey, ref; + obj = {}; + obj[charkey] = ""; + if (!_this.options.ignoreAttrs) { + ref = node.attributes; + for (key in ref) { + if (!hasProp.call(ref, key)) continue; + if (!(attrkey in obj) && !_this.options.mergeAttrs) { + obj[attrkey] = {}; + } + newValue = _this.options.attrValueProcessors ? processItem(_this.options.attrValueProcessors, node.attributes[key], key) : node.attributes[key]; + processedKey = _this.options.attrNameProcessors ? processItem(_this.options.attrNameProcessors, key) : key; + if (_this.options.mergeAttrs) { + _this.assignOrPush(obj, processedKey, newValue); + } else { + obj[attrkey][processedKey] = newValue; + } + } + } + obj["#name"] = _this.options.tagNameProcessors ? processItem(_this.options.tagNameProcessors, node.name) : node.name; + if (_this.options.xmlns) { + obj[_this.options.xmlnskey] = { + uri: node.uri, + local: node.local + }; + } + return stack.push(obj); + }; + })(this); + this.saxParser.onclosetag = (function(_this) { + return function() { + var cdata, emptyStr, key, node, nodeName, obj, objClone, old, s, xpath; + obj = stack.pop(); + nodeName = obj["#name"]; + if (!_this.options.explicitChildren || !_this.options.preserveChildrenOrder) { + delete obj["#name"]; + } + if (obj.cdata === true) { + cdata = obj.cdata; + delete obj.cdata; + } + s = stack[stack.length - 1]; + if (obj[charkey].match(/^\s*$/) && !cdata) { + emptyStr = obj[charkey]; + delete obj[charkey]; + } else { + if (_this.options.trim) { + obj[charkey] = obj[charkey].trim(); + } + if (_this.options.normalize) { + obj[charkey] = obj[charkey].replace(/\s{2,}/g, " ").trim(); + } + obj[charkey] = _this.options.valueProcessors ? processItem(_this.options.valueProcessors, obj[charkey], nodeName) : obj[charkey]; + if (Object.keys(obj).length === 1 && charkey in obj && !_this.EXPLICIT_CHARKEY) { + obj = obj[charkey]; + } + } + if (isEmpty(obj)) { + obj = _this.options.emptyTag !== '' ? _this.options.emptyTag : emptyStr; + } + if (_this.options.validator != null) { + xpath = "/" + ((function() { + var i, len, results; + results = []; + for (i = 0, len = stack.length; i < len; i++) { + node = stack[i]; + results.push(node["#name"]); + } + return results; + })()).concat(nodeName).join("/"); + (function() { + var err; + try { + return obj = _this.options.validator(xpath, s && s[nodeName], obj); + } catch (error1) { + err = error1; + return _this.emit("error", err); + } + })(); + } + if (_this.options.explicitChildren && !_this.options.mergeAttrs && typeof obj === 'object') { + if (!_this.options.preserveChildrenOrder) { + node = {}; + if (_this.options.attrkey in obj) { + node[_this.options.attrkey] = obj[_this.options.attrkey]; + delete obj[_this.options.attrkey]; + } + if (!_this.options.charsAsChildren && _this.options.charkey in obj) { + node[_this.options.charkey] = obj[_this.options.charkey]; + delete obj[_this.options.charkey]; + } + if (Object.getOwnPropertyNames(obj).length > 0) { + node[_this.options.childkey] = obj; + } + obj = node; + } else if (s) { + s[_this.options.childkey] = s[_this.options.childkey] || []; + objClone = {}; + for (key in obj) { + if (!hasProp.call(obj, key)) continue; + objClone[key] = obj[key]; + } + s[_this.options.childkey].push(objClone); + delete obj["#name"]; + if (Object.keys(obj).length === 1 && charkey in obj && !_this.EXPLICIT_CHARKEY) { + obj = obj[charkey]; + } + } + } + if (stack.length > 0) { + return _this.assignOrPush(s, nodeName, obj); + } else { + if (_this.options.explicitRoot) { + old = obj; + obj = {}; + obj[nodeName] = old; + } + _this.resultObject = obj; + _this.saxParser.ended = true; + return _this.emit("end", _this.resultObject); + } + }; + })(this); + ontext = (function(_this) { + return function(text) { + var charChild, s; + s = stack[stack.length - 1]; + if (s) { + s[charkey] += text; + if (_this.options.explicitChildren && _this.options.preserveChildrenOrder && _this.options.charsAsChildren && (_this.options.includeWhiteChars || text.replace(/\\n/g, '').trim() !== '')) { + s[_this.options.childkey] = s[_this.options.childkey] || []; + charChild = { + '#name': '__text__' + }; + charChild[charkey] = text; + if (_this.options.normalize) { + charChild[charkey] = charChild[charkey].replace(/\s{2,}/g, " ").trim(); + } + s[_this.options.childkey].push(charChild); + } + return s; + } + }; + })(this); + this.saxParser.ontext = ontext; + return this.saxParser.oncdata = (function(_this) { + return function(text) { + var s; + s = ontext(text); + if (s) { + return s.cdata = true; + } + }; + })(this); + }; + + Parser.prototype.parseString = function(str, cb) { + var err; + if ((cb != null) && typeof cb === "function") { + this.on("end", function(result) { + this.reset(); + return cb(null, result); + }); + this.on("error", function(err) { + this.reset(); + return cb(err); + }); + } + try { + str = str.toString(); + if (str.trim() === '') { + this.emit("end", null); + return true; + } + str = bom.stripBOM(str); + if (this.options.async) { + this.remaining = str; + setImmediate(this.processAsync); + return this.saxParser; + } + return this.saxParser.write(str).close(); + } catch (error1) { + err = error1; + if (!(this.saxParser.errThrown || this.saxParser.ended)) { + this.emit('error', err); + return this.saxParser.errThrown = true; + } else if (this.saxParser.ended) { + throw err; + } + } + }; + + return Parser; + + })(events.EventEmitter); + + exports.parseString = function(str, a, b) { + var cb, options, parser; + if (b != null) { + if (typeof b === 'function') { + cb = b; + } + if (typeof a === 'object') { + options = a; + } + } else { + if (typeof a === 'function') { + cb = a; + } + options = {}; + } + parser = new exports.Parser(options); + return parser.parseString(str, cb); + }; + +}).call(this); diff --git a/node_modules/xml2js/lib/processors.js b/node_modules/xml2js/lib/processors.js new file mode 100644 index 0000000..89aa85f --- /dev/null +++ b/node_modules/xml2js/lib/processors.js @@ -0,0 +1,34 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + "use strict"; + var prefixMatch; + + prefixMatch = new RegExp(/(?!xmlns)^.*:/); + + exports.normalize = function(str) { + return str.toLowerCase(); + }; + + exports.firstCharLowerCase = function(str) { + return str.charAt(0).toLowerCase() + str.slice(1); + }; + + exports.stripPrefix = function(str) { + return str.replace(prefixMatch, ''); + }; + + exports.parseNumbers = function(str) { + if (!isNaN(str)) { + str = str % 1 === 0 ? parseInt(str, 10) : parseFloat(str); + } + return str; + }; + + exports.parseBooleans = function(str) { + if (/^(?:true|false)$/i.test(str)) { + str = str.toLowerCase() === 'true'; + } + return str; + }; + +}).call(this); diff --git a/node_modules/xml2js/lib/xml2js.js b/node_modules/xml2js/lib/xml2js.js new file mode 100644 index 0000000..599d3dd --- /dev/null +++ b/node_modules/xml2js/lib/xml2js.js @@ -0,0 +1,37 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + "use strict"; + var builder, defaults, parser, processors, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + defaults = require('./defaults'); + + builder = require('./builder'); + + parser = require('./parser'); + + processors = require('./processors'); + + exports.defaults = defaults.defaults; + + exports.processors = processors; + + exports.ValidationError = (function(superClass) { + extend(ValidationError, superClass); + + function ValidationError(message) { + this.message = message; + } + + return ValidationError; + + })(Error); + + exports.Builder = builder.Builder; + + exports.Parser = parser.Parser; + + exports.parseString = parser.parseString; + +}).call(this); diff --git a/node_modules/xml2js/package.json b/node_modules/xml2js/package.json new file mode 100644 index 0000000..d585f99 --- /dev/null +++ b/node_modules/xml2js/package.json @@ -0,0 +1,279 @@ +{ + "_from": "xml2js@0.4.19", + "_id": "xml2js@0.4.19", + "_inBundle": false, + "_integrity": "sha512-esZnJZJOiJR9wWKMyuvSE1y6Dq5LCuJanqhxslH2bxM6duahNZ+HMpCLhBQGZkbX6xRf8x1Y2eJlgt2q3qo49Q==", + "_location": "/xml2js", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "xml2js@0.4.19", + "name": "xml2js", + "escapedName": "xml2js", + "rawSpec": "0.4.19", + "saveSpec": null, + "fetchSpec": "0.4.19" + }, + "_requiredBy": [ + "/aws-sdk" + ], + "_resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.19.tgz", + "_shasum": "686c20f213209e94abf0d1bcf1efaa291c7827a7", + "_spec": "xml2js@0.4.19", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/aws-sdk", + "author": { + "name": "Marek Kubica", + "email": "marek@xivilization.net", + "url": "https://xivilization.net" + }, + "bugs": { + "url": "https://github.com/Leonidas-from-XIV/node-xml2js/issues" + }, + "bundleDependencies": false, + "contributors": [ + { + "name": "maqr", + "email": "maqr.lollerskates@gmail.com", + "url": "https://github.com/maqr" + }, + { + "name": "Ben Weaver", + "url": "http://benweaver.com/" + }, + { + "name": "Jae Kwon", + "url": "https://github.com/jaekwon" + }, + { + "name": "Jim Robert" + }, + { + "name": "Ștefan Rusu", + "url": "http://www.saltwaterc.eu/" + }, + { + "name": "Carter Cole", + "email": "carter.cole@cartercole.com", + "url": "http://cartercole.com/" + }, + { + "name": "Kurt Raschke", + "email": "kurt@kurtraschke.com", + "url": "http://www.kurtraschke.com/" + }, + { + "name": "Contra", + "email": "contra@australia.edu", + "url": "https://github.com/Contra" + }, + { + "name": "Marcelo Diniz", + "email": "marudiniz@gmail.com", + "url": "https://github.com/mdiniz" + }, + { + "name": "Michael Hart", + "url": "https://github.com/mhart" + }, + { + "name": "Zachary Scott", + "email": "zachary@zacharyscott.net", + "url": "http://zacharyscott.net/" + }, + { + "name": "Raoul Millais", + "url": "https://github.com/raoulmillais" + }, + { + "name": "Salsita Software", + "url": "http://www.salsitasoft.com/" + }, + { + "name": "Mike Schilling", + "email": "mike@emotive.com", + "url": "http://www.emotive.com/" + }, + { + "name": "Jackson Tian", + "email": "shyvo1987@gmail.com", + "url": "http://weibo.com/shyvo" + }, + { + "name": "Mikhail Zyatin", + "email": "mikhail.zyatin@gmail.com", + "url": "https://github.com/Sitin" + }, + { + "name": "Chris Tavares", + "email": "ctavares@microsoft.com", + "url": "https://github.com/christav" + }, + { + "name": "Frank Xu", + "email": "yyfrankyy@gmail.com", + "url": "http://f2e.us/" + }, + { + "name": "Guido D'Albore", + "email": "guido@bitstorm.it", + "url": "http://www.bitstorm.it/" + }, + { + "name": "Jack Senechal", + "url": "http://jacksenechal.com/" + }, + { + "name": "Matthias Hölzl", + "email": "tc@xantira.com", + "url": "https://github.com/hoelzl" + }, + { + "name": "Camille Reynders", + "email": "info@creynders.be", + "url": "http://www.creynders.be/" + }, + { + "name": "Taylor Gautier", + "url": "https://github.com/tsgautier" + }, + { + "name": "Todd Bryan", + "url": "https://github.com/toddrbryan" + }, + { + "name": "Leore Avidar", + "email": "leore.avidar@gmail.com", + "url": "http://leoreavidar.com/" + }, + { + "name": "Dave Aitken", + "email": "dave.aitken@gmail.com", + "url": "http://www.actionshrimp.com/" + }, + { + "name": "Shaney Orrowe", + "email": "shaney.orrowe@practiceweb.co.uk" + }, + { + "name": "Candle", + "email": "candle@candle.me.uk" + }, + { + "name": "Jess Telford", + "email": "hi@jes.st", + "url": "http://jes.st" + }, + { + "name": "Tom Hughes", + "email": "=0.6.0", + "xmlbuilder": "~9.0.1" + }, + "deprecated": false, + "description": "Simple XML to JavaScript object converter.", + "devDependencies": { + "coffee-script": ">=1.10.0", + "coveralls": "^2.11.2", + "diff": ">=1.0.8", + "docco": ">=0.6.2", + "nyc": ">=2.2.1", + "zap": ">=0.2.9" + }, + "directories": { + "lib": "./lib" + }, + "files": [ + "lib" + ], + "homepage": "https://github.com/Leonidas-from-XIV/node-xml2js", + "keywords": [ + "xml", + "json" + ], + "license": "MIT", + "main": "./lib/xml2js", + "name": "xml2js", + "repository": { + "type": "git", + "url": "git+https://github.com/Leonidas-from-XIV/node-xml2js.git" + }, + "scripts": { + "coverage": "nyc npm test && nyc report", + "coveralls": "nyc npm test && nyc report --reporter=text-lcov | coveralls", + "test": "zap" + }, + "version": "0.4.19" +} diff --git a/node_modules/xmlbuilder/.npmignore b/node_modules/xmlbuilder/.npmignore new file mode 100644 index 0000000..b6ad1f6 --- /dev/null +++ b/node_modules/xmlbuilder/.npmignore @@ -0,0 +1,5 @@ +.travis.yml +src +test +perf +coverage diff --git a/node_modules/xmlbuilder/CHANGELOG.md b/node_modules/xmlbuilder/CHANGELOG.md new file mode 100644 index 0000000..6264283 --- /dev/null +++ b/node_modules/xmlbuilder/CHANGELOG.md @@ -0,0 +1,423 @@ +# Change Log + +All notable changes to this project are documented in this file. This project adheres to [Semantic Versioning](http://semver.org/#semantic-versioning-200). + +## [9.0.4] - 2017-08-16 +- `spacebeforeslash` writer option accepts `true` as well as space char(s). + +## [9.0.3] - 2017-08-15 +- `spacebeforeslash` writer option can now be used with XML fragments. + +## [9.0.2] - 2017-08-15 +- Added the `spacebeforeslash` writer option to add a space character before closing tags of empty elements. See +[#157](https://github.com/oozcitak/xmlbuilder-js/issues/157). + +## [9.0.1] - 2017-06-19 +- Fixed character validity checks to work with node.js 4.0 and 5.0. See +[#161](https://github.com/oozcitak/xmlbuilder-js/issues/161). + +## [9.0.0] - 2017-05-05 +- Removed case conversion options. +- Removed support for node.js 4.0 and 5.0. Minimum required version is now 6.0. +- Fixed valid char filter to use XML 1.1 instead of 1.0. See +[#147](https://github.com/oozcitak/xmlbuilder-js/issues/147). +- Added options for negative indentation and suppressing pretty printing of text +nodes. See +[#145](https://github.com/oozcitak/xmlbuilder-js/issues/145). + +## [8.2.2] - 2016-04-08 +- Falsy values can now be used as a text node in callback mode. + +## [8.2.1] - 2016-04-07 +- Falsy values can now be used as a text node. See +[#117](https://github.com/oozcitak/xmlbuilder-js/issues/117). + +## [8.2.0] - 2016-04-01 +- Removed lodash dependency to keep the library small and simple. See +[#114](https://github.com/oozcitak/xmlbuilder-js/issues/114), +[#53](https://github.com/oozcitak/xmlbuilder-js/issues/53), +and [#43](https://github.com/oozcitak/xmlbuilder-js/issues/43). +- Added title case to name conversion options. + +## [8.1.0] - 2016-03-29 +- Added the callback option to the `begin` export function. When used with a +callback function, the XML document will be generated in chunks and each chunk +will be passed to the supplied function. In this mode, `begin` uses a different +code path and the builder should use much less memory since the entire XML tree +is not kept. There are a few drawbacks though. For example, traversing the document +tree or adding attributes to a node after it is written is not possible. It is +also not possible to remove nodes or attributes. + +``` js +var result = ''; + +builder.begin(function(chunk) { result += chunk; }) + .dec() + .ele('root') + .ele('xmlbuilder').up() + .end(); +``` + +- Replaced native `Object.assign` with `lodash.assign` to support old JS engines. See [#111](https://github.com/oozcitak/xmlbuilder-js/issues/111). + +## [8.0.0] - 2016-03-25 +- Added the `begin` export function. See the wiki for details. +- Added the ability to add comments and processing instructions before and after the root element. Added `commentBefore`, `commentAfter`, `instructionBefore` and `instructionAfter` functions for this purpose. +- Dropped support for old node.js releases. Minimum required node.js version is now 4.0. + +## [7.0.0] - 2016-03-21 +- Processing instructions are now created as regular nodes. This is a major breaking change if you are using processing instructions. Previously processing instructions were inserted before their parent node. After this change processing instructions are appended to the children of the parent node. Note that it is not currently possible to insert processing instructions before or after the root element. +```js +root.ele('node').ins('pi'); +// pre-v7 + +// v7 + +``` + +## [6.0.0] - 2016-03-20 +- Added custom XML writers. The default string conversion functions are now collected under the `XMLStringWriter` class which can be accessed by the `stringWriter(options)` function exported by the module. An `XMLStreamWriter` is also added which outputs the XML document to a writable stream. A stream writer can be created by calling the `streamWriter(stream, options)` function exported by the module. Both classes are heavily customizable and the details are added to the wiki. It is also possible to write an XML writer from scratch and use it when calling `end()` on the XML document. + +## [5.0.1] - 2016-03-08 +- Moved require statements for text case conversion to the top of files to reduce lazy requires. + +## [5.0.0] - 2016-03-05 +- Added text case option for element names and attribute names. Valid cases are `lower`, `upper`, `camel`, `kebab` and `snake`. +- Attribute and element values are escaped according to the [Canonical XML 1.0 specification](http://www.w3.org/TR/2000/WD-xml-c14n-20000119.html#charescaping). See [#54](https://github.com/oozcitak/xmlbuilder-js/issues/54) and [#86](https://github.com/oozcitak/xmlbuilder-js/issues/86). +- Added the `allowEmpty` option to `end()`. When this option is set, empty elements are not self-closed. +- Added support for [nested CDATA](https://en.wikipedia.org/wiki/CDATA#Nesting). The triad `]]>` in CDATA is now automatically replaced with `]]]]>`. + +## [4.2.1] - 2016-01-15 +- Updated lodash dependency to 4.0.0. + +## [4.2.0] - 2015-12-16 +- Added the `noDoubleEncoding` option to `create()` to control whether existing html entities are encoded. + +## [4.1.0] - 2015-11-11 +- Added the `separateArrayItems` option to `create()` to control how arrays are handled when converting from objects. e.g. + +```js +root.ele({ number: [ "one", "two" ]}); +// with separateArrayItems: true + + + + +// with separateArrayItems: false +one +two +``` + +## [4.0.0] - 2015-11-01 +- Removed the `#list` decorator. Array items are now created as child nodes by default. +- Fixed a bug where the XML encoding string was checked partially. + +## [3.1.0] - 2015-09-19 +- `#list` decorator ignores empty arrays. + +## [3.0.0] - 2015-09-10 +- Allow `\r`, `\n` and `\t` in attribute values without escaping. See [#86](https://github.com/oozcitak/xmlbuilder-js/issues/86). + +## [2.6.5] - 2015-09-09 +- Use native `isArray` instead of lodash. +- Indentation of processing instructions are set to the parent element's. + +## [2.6.4] - 2015-05-27 +- Updated lodash dependency to 3.5.0. + +## [2.6.3] - 2015-05-27 +- Bumped version because previous release was not published on npm. + +## [2.6.2] - 2015-03-10 +- Updated lodash dependency to 3.5.0. + +## [2.6.1] - 2015-02-20 +- Updated lodash dependency to 3.3.0. + +## [2.6.0] - 2015-02-20 +- Fixed a bug where the `XMLNode` constructor overwrote the super class parent. +- Removed document property from cloned nodes. +- Switched to mocha.js for testing. + +## [2.5.2] - 2015-02-16 +- Updated lodash dependency to 3.2.0. + +## [2.5.1] - 2015-02-09 +- Updated lodash dependency to 3.1.0. +- Support all node >= 0.8. + +## [2.5.0] - 2015-00-03 +- Updated lodash dependency to 3.0.0. + +## [2.4.6] - 2015-01-26 +- Show more information from attribute creation with null values. +- Added iojs as an engine. +- Self close elements with empty text. + +## [2.4.5] - 2014-11-15 +- Fixed prepublish script to run on windows. +- Fixed bug in XMLStringifier where an undefined value was used while reporting an invalid encoding value. +- Moved require statements to the top of files to reduce lazy requires. See [#62](https://github.com/oozcitak/xmlbuilder-js/issues/62). + +## [2.4.4] - 2014-09-08 +- Added the `offset` option to `toString()` for use in XML fragments. + +## [2.4.3] - 2014-08-13 +- Corrected license in package description. + +## [2.4.2] - 2014-08-13 +- Dropped performance test and memwatch dependency. + +## [2.4.1] - 2014-08-12 +- Fixed a bug where empty indent string was omitted when pretty printing. See [#59](https://github.com/oozcitak/xmlbuilder-js/issues/59). + +## [2.4.0] - 2014-08-04 +- Correct cases of pubID and sysID. +- Use single lodash instead of separate npm modules. See [#53](https://github.com/oozcitak/xmlbuilder-js/issues/53). +- Escape according to Canonical XML 1.0. See [#54](https://github.com/oozcitak/xmlbuilder-js/issues/54). + +## [2.3.0] - 2014-07-17 +- Convert objects to JS primitives while sanitizing user input. +- Object builder preserves items with null values. See [#44](https://github.com/oozcitak/xmlbuilder-js/issues/44). +- Use modularized lodash functions to cut down dependencies. +- Process empty objects when converting from objects so that we don't throw on empty child objects. + +## [2.2.1] - 2014-04-04 +- Bumped version because previous release was not published on npm. + +## [2.2.0] - 2014-04-04 +- Switch to lodash from underscore. +- Removed legacy `ext` option from `create()`. +- Drop old node versions: 0.4, 0.5, 0.6. 0.8 is the minimum requirement from now on. + +## [2.1.0] - 2013-12-30 +- Removed duplicate null checks from constructors. +- Fixed node count in performance test. +- Added option for skipping null attribute values. See [#26](https://github.com/oozcitak/xmlbuilder-js/issues/26). +- Allow multiple values in `att()` and `ins()`. +- Added ability to run individual performance tests. +- Added flag for ignoring decorator strings. + +## [2.0.1] - 2013-12-24 +- Removed performance tests from npm package. + +## [2.0.0] - 2013-12-24 +- Combined loops for speed up. +- Added support for the DTD and XML declaration. +- `clone` includes attributes. +- Added performance tests. +- Evaluate attribute value if function. +- Evaluate instruction value if function. + +## [1.1.2] - 2013-12-11 +- Changed processing instruction decorator to `?`. + +## [1.1.1] - 2013-12-11 +- Added processing instructions to JS object conversion. + +## [1.1.0] - 2013-12-10 +- Added license to package. +- `create()` and `element()` accept JS object to fully build the document. +- Added `nod()` and `n()` aliases for `node()`. +- Renamed `convertAttChar` decorator to `convertAttKey`. +- Ignore empty decorator strings when converting JS objects. + +## [1.0.2] - 2013-11-27 +- Removed temp file which was accidentally included in the package. + +## [1.0.1] - 2013-11-27 +- Custom stringify functions affect current instance only. + +## [1.0.0] - 2013-11-27 +- Added processing instructions. +- Added stringify functions to sanitize and convert input values. +- Added option for headless XML documents. +- Added vows tests. +- Removed Makefile. Using npm publish scripts instead. +- Removed the `begin()` function. `create()` begins the document by creating the root node. + +## [0.4.3] - 2013-11-08 +- Added option to include surrogate pairs in XML content. See [#29](https://github.com/oozcitak/xmlbuilder-js/issues/29). +- Fixed empty value string representation in pretty mode. +- Added pre and postpublish scripts to package.json. +- Filtered out prototype properties when appending attributes. See [#31](https://github.com/oozcitak/xmlbuilder-js/issues/31). + +## [0.4.2] - 2012-09-14 +- Removed README.md from `.npmignore`. + +## [0.4.1] - 2012-08-31 +- Removed `begin()` calls in favor of `XMLBuilder` constructor. +- Added the `end()` function. `end()` is a convenience over `doc().toString()`. + +## [0.4.0] - 2012-08-31 +- Added arguments to `XMLBuilder` constructor to allow the name of the root element and XML prolog to be defined in one line. +- Soft deprecated `begin()`. + +## [0.3.11] - 2012-08-13 +- Package keywords are fixed to be an array of values. + +## [0.3.10] - 2012-08-13 +- Brought back npm package contents which were lost due to incorrect configuration of `package.json` in previous releases. + +## [0.3.3] - 2012-07-27 +- Implemented `importXMLBuilder()`. + +## [0.3.2] - 2012-07-20 +- Fixed a duplicated escaping problem on `element()`. +- Fixed a problem with text node creation from empty string. +- Calling `root()` on the document element returns the root element. +- `XMLBuilder` no longer extends `XMLFragment`. + +## [0.3.1] - 2011-11-28 +- Added guards for document element so that nodes cannot be inserted at document level. + +## [0.3.0] - 2011-11-28 +- Added `doc()` to return the document element. + +## [0.2.2] - 2011-11-28 +- Prevent code relying on `up()`'s older behavior to break. + +## [0.2.1] - 2011-11-28 +- Added the `root()` function. + +## [0.2.0] - 2011-11-21 +- Added Travis-CI integration. +- Added coffee-script dependency. +- Added insert, traversal and delete functions. + +## [0.1.7] - 2011-10-25 +- No changes. Accidental release. + +## [0.1.6] - 2011-10-25 +- Corrected `package.json` bugs link to `url` from `web`. + +## [0.1.5] - 2011-08-08 +- Added missing npm package contents. + +## [0.1.4] - 2011-07-29 +- Text-only nodes are no longer indented. +- Added documentation for multiple instances. + +## [0.1.3] - 2011-07-27 +- Exported the `create()` function to return a new instance. This allows multiple builder instances to be constructed. +- Fixed `u()` function so that it now correctly calls `up()`. +- Fixed typo in `element()` so that `attributes` and `text` can be passed interchangeably. + +## [0.1.2] - 2011-06-03 +- `ele()` accepts element text. +- `attributes()` now overrides existing attributes if passed the same attribute name. + +## [0.1.1] - 2011-05-19 +- Added the raw output option. +- Removed most validity checks. + +## [0.1.0] - 2011-04-27 +- `text()` and `cdata()` now return parent element. +- Attribute values are escaped. + +## [0.0.7] - 2011-04-23 +- Coerced text values to string. + +## [0.0.6] - 2011-02-23 +- Added support for XML comments. +- Text nodes are checked against CharData. + +## [0.0.5] - 2010-12-31 +- Corrected the name of the main npm module in `package.json`. + +## [0.0.4] - 2010-12-28 +- Added `.npmignore`. + +## [0.0.3] - 2010-12-27 +- root element is now constructed in `begin()`. +- moved prolog to `begin()`. +- Added the ability to have CDATA in element text. +- Removed unused prolog aliases. +- Removed `builder()` function from main module. +- Added the name of the main npm module in `package.json`. + +## [0.0.2] - 2010-11-03 +- `element()` expands nested arrays. +- Added pretty printing. +- Added the `up()`, `build()` and `prolog()` functions. +- Added readme. + +## 0.0.1 - 2010-11-02 +- Initial release + +[9.0.4]: https://github.com/oozcitak/xmlbuilder-js/compare/v9.0.3...v9.0.4 +[9.0.3]: https://github.com/oozcitak/xmlbuilder-js/compare/v9.0.2...v9.0.3 +[9.0.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v9.0.1...v9.0.2 +[9.0.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v9.0.0...v9.0.1 +[9.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v8.2.2...v9.0.0 +[8.2.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v8.2.1...v8.2.2 +[8.2.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v8.2.0...v8.2.1 +[8.2.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v8.1.0...v8.2.0 +[8.1.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v8.0.0...v8.1.0 +[8.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v7.0.0...v8.0.0 +[7.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v6.0.0...v7.0.0 +[6.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v5.0.1...v6.0.0 +[5.0.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v5.0.0...v5.0.1 +[5.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v4.2.1...v5.0.0 +[4.2.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v4.2.0...v4.2.1 +[4.2.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v4.1.0...v4.2.0 +[4.1.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v4.0.0...v4.1.0 +[4.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v3.1.0...v4.0.0 +[3.1.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v3.0.0...v3.1.0 +[3.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.6.5...v3.0.0 +[2.6.5]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.6.4...v2.6.5 +[2.6.4]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.6.3...v2.6.4 +[2.6.3]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.6.2...v2.6.3 +[2.6.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.6.1...v2.6.2 +[2.6.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.6.0...v2.6.1 +[2.6.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.5.2...v2.6.0 +[2.5.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.5.1...v2.5.2 +[2.5.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.5.0...v2.5.1 +[2.5.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.4.6...v2.5.0 +[2.4.6]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.4.5...v2.4.6 +[2.4.5]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.4.4...v2.4.5 +[2.4.4]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.4.3...v2.4.4 +[2.4.3]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.4.2...v2.4.3 +[2.4.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.4.1...v2.4.2 +[2.4.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.4.0...v2.4.1 +[2.4.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.3.0...v2.4.0 +[2.3.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.2.1...v2.3.0 +[2.2.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.2.0...v2.2.1 +[2.2.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.1.0...v2.2.0 +[2.1.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.0.1...v2.1.0 +[2.0.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v2.0.0...v2.0.1 +[2.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v1.1.2...v2.0.0 +[1.1.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v1.1.1...v1.1.2 +[1.1.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v1.1.0...v1.1.1 +[1.1.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v1.0.2...v1.1.0 +[1.0.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v1.0.1...v1.0.2 +[1.0.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v1.0.0...v1.0.1 +[1.0.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.4.3...v1.0.0 +[0.4.3]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.4.2...v0.4.3 +[0.4.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.4.1...v0.4.2 +[0.4.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.4.0...v0.4.1 +[0.4.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.3.11...v0.4.0 +[0.3.11]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.3.10...v0.3.11 +[0.3.10]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.3.3...v0.3.10 +[0.3.3]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.3.2...v0.3.3 +[0.3.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.3.1...v0.3.2 +[0.3.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.3.0...v0.3.1 +[0.3.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.2.2...v0.3.0 +[0.2.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.2.1...v0.2.2 +[0.2.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.2.0...v0.2.1 +[0.2.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.7...v0.2.0 +[0.1.7]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.6...v0.1.7 +[0.1.6]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.5...v0.1.6 +[0.1.5]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.4...v0.1.5 +[0.1.4]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.3...v0.1.4 +[0.1.3]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.2...v0.1.3 +[0.1.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.1...v0.1.2 +[0.1.1]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.1.0...v0.1.1 +[0.1.0]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.0.7...v0.1.0 +[0.0.7]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.0.6...v0.0.7 +[0.0.6]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.0.5...v0.0.6 +[0.0.5]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.0.4...v0.0.5 +[0.0.4]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.0.3...v0.0.4 +[0.0.3]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.0.2...v0.0.3 +[0.0.2]: https://github.com/oozcitak/xmlbuilder-js/compare/v0.0.1...v0.0.2 + diff --git a/node_modules/xmlbuilder/LICENSE b/node_modules/xmlbuilder/LICENSE new file mode 100644 index 0000000..e7cbac9 --- /dev/null +++ b/node_modules/xmlbuilder/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2013 Ozgur Ozcitak + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/xmlbuilder/README.md b/node_modules/xmlbuilder/README.md new file mode 100644 index 0000000..785c4dd --- /dev/null +++ b/node_modules/xmlbuilder/README.md @@ -0,0 +1,85 @@ +# xmlbuilder-js + +An XML builder for [node.js](https://nodejs.org/) similar to +[java-xmlbuilder](https://github.com/jmurty/java-xmlbuilder). + +[![License](http://img.shields.io/npm/l/xmlbuilder.svg?style=flat-square)](http://opensource.org/licenses/MIT) +[![NPM Version](http://img.shields.io/npm/v/xmlbuilder.svg?style=flat-square)](https://npmjs.com/package/xmlbuilder) +[![NPM Downloads](https://img.shields.io/npm/dm/xmlbuilder.svg?style=flat-square)](https://npmjs.com/package/xmlbuilder) + +[![Build Status](http://img.shields.io/travis/oozcitak/xmlbuilder-js.svg?style=flat-square)](http://travis-ci.org/oozcitak/xmlbuilder-js) +[![Dev Dependency Status](http://img.shields.io/david/dev/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://david-dm.org/oozcitak/xmlbuilder-js) +[![Code Coverage](https://img.shields.io/coveralls/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://coveralls.io/github/oozcitak/xmlbuilder-js) + +### Installation: + +``` sh +npm install xmlbuilder +``` + +### Usage: + +``` js +var builder = require('xmlbuilder'); +var xml = builder.create('root') + .ele('xmlbuilder') + .ele('repo', {'type': 'git'}, 'git://github.com/oozcitak/xmlbuilder-js.git') + .end({ pretty: true}); + +console.log(xml); +``` + +will result in: + +``` xml + + + + git://github.com/oozcitak/xmlbuilder-js.git + + +``` + +It is also possible to convert objects into nodes: + +``` js +builder.create({ + root: { + xmlbuilder: { + repo: { + '@type': 'git', // attributes start with @ + '#text': 'git://github.com/oozcitak/xmlbuilder-js.git' // text node + } + } + } +}); +``` + +If you need to do some processing: + +``` js +var root = builder.create('squares'); +root.com('f(x) = x^2'); +for(var i = 1; i <= 5; i++) +{ + var item = root.ele('data'); + item.att('x', i); + item.att('y', i * i); +} +``` + +This will result in: + +``` xml + + + + + + + + + +``` + +See the [wiki](https://github.com/oozcitak/xmlbuilder-js/wiki) for details and [examples](https://github.com/oozcitak/xmlbuilder-js/wiki/Examples) for more complex examples. diff --git a/node_modules/xmlbuilder/lib/Utility.js b/node_modules/xmlbuilder/lib/Utility.js new file mode 100644 index 0000000..908f8a8 --- /dev/null +++ b/node_modules/xmlbuilder/lib/Utility.js @@ -0,0 +1,73 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var assign, isArray, isEmpty, isFunction, isObject, isPlainObject, + slice = [].slice, + hasProp = {}.hasOwnProperty; + + assign = function() { + var i, key, len, source, sources, target; + target = arguments[0], sources = 2 <= arguments.length ? slice.call(arguments, 1) : []; + if (isFunction(Object.assign)) { + Object.assign.apply(null, arguments); + } else { + for (i = 0, len = sources.length; i < len; i++) { + source = sources[i]; + if (source != null) { + for (key in source) { + if (!hasProp.call(source, key)) continue; + target[key] = source[key]; + } + } + } + } + return target; + }; + + isFunction = function(val) { + return !!val && Object.prototype.toString.call(val) === '[object Function]'; + }; + + isObject = function(val) { + var ref; + return !!val && ((ref = typeof val) === 'function' || ref === 'object'); + }; + + isArray = function(val) { + if (isFunction(Array.isArray)) { + return Array.isArray(val); + } else { + return Object.prototype.toString.call(val) === '[object Array]'; + } + }; + + isEmpty = function(val) { + var key; + if (isArray(val)) { + return !val.length; + } else { + for (key in val) { + if (!hasProp.call(val, key)) continue; + return false; + } + return true; + } + }; + + isPlainObject = function(val) { + var ctor, proto; + return isObject(val) && (proto = Object.getPrototypeOf(val)) && (ctor = proto.constructor) && (typeof ctor === 'function') && (ctor instanceof ctor) && (Function.prototype.toString.call(ctor) === Function.prototype.toString.call(Object)); + }; + + module.exports.assign = assign; + + module.exports.isFunction = isFunction; + + module.exports.isObject = isObject; + + module.exports.isArray = isArray; + + module.exports.isEmpty = isEmpty; + + module.exports.isPlainObject = isPlainObject; + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLAttribute.js b/node_modules/xmlbuilder/lib/XMLAttribute.js new file mode 100644 index 0000000..67cc0bc --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLAttribute.js @@ -0,0 +1,31 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLAttribute; + + module.exports = XMLAttribute = (function() { + function XMLAttribute(parent, name, value) { + this.options = parent.options; + this.stringify = parent.stringify; + if (name == null) { + throw new Error("Missing attribute name of element " + parent.name); + } + if (value == null) { + throw new Error("Missing attribute value for attribute " + name + " of element " + parent.name); + } + this.name = this.stringify.attName(name); + this.value = this.stringify.attValue(value); + } + + XMLAttribute.prototype.clone = function() { + return Object.create(this); + }; + + XMLAttribute.prototype.toString = function(options) { + return this.options.writer.set(options).attribute(this); + }; + + return XMLAttribute; + + })(); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLCData.js b/node_modules/xmlbuilder/lib/XMLCData.js new file mode 100644 index 0000000..670e860 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLCData.js @@ -0,0 +1,32 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLCData, XMLNode, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLNode = require('./XMLNode'); + + module.exports = XMLCData = (function(superClass) { + extend(XMLCData, superClass); + + function XMLCData(parent, text) { + XMLCData.__super__.constructor.call(this, parent); + if (text == null) { + throw new Error("Missing CDATA text"); + } + this.text = this.stringify.cdata(text); + } + + XMLCData.prototype.clone = function() { + return Object.create(this); + }; + + XMLCData.prototype.toString = function(options) { + return this.options.writer.set(options).cdata(this); + }; + + return XMLCData; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLComment.js b/node_modules/xmlbuilder/lib/XMLComment.js new file mode 100644 index 0000000..c189714 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLComment.js @@ -0,0 +1,32 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLComment, XMLNode, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLNode = require('./XMLNode'); + + module.exports = XMLComment = (function(superClass) { + extend(XMLComment, superClass); + + function XMLComment(parent, text) { + XMLComment.__super__.constructor.call(this, parent); + if (text == null) { + throw new Error("Missing comment text"); + } + this.text = this.stringify.comment(text); + } + + XMLComment.prototype.clone = function() { + return Object.create(this); + }; + + XMLComment.prototype.toString = function(options) { + return this.options.writer.set(options).comment(this); + }; + + return XMLComment; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDTDAttList.js b/node_modules/xmlbuilder/lib/XMLDTDAttList.js new file mode 100644 index 0000000..8f911c2 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDTDAttList.js @@ -0,0 +1,50 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDTDAttList, XMLNode, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLNode = require('./XMLNode'); + + module.exports = XMLDTDAttList = (function(superClass) { + extend(XMLDTDAttList, superClass); + + function XMLDTDAttList(parent, elementName, attributeName, attributeType, defaultValueType, defaultValue) { + XMLDTDAttList.__super__.constructor.call(this, parent); + if (elementName == null) { + throw new Error("Missing DTD element name"); + } + if (attributeName == null) { + throw new Error("Missing DTD attribute name"); + } + if (!attributeType) { + throw new Error("Missing DTD attribute type"); + } + if (!defaultValueType) { + throw new Error("Missing DTD attribute default"); + } + if (defaultValueType.indexOf('#') !== 0) { + defaultValueType = '#' + defaultValueType; + } + if (!defaultValueType.match(/^(#REQUIRED|#IMPLIED|#FIXED|#DEFAULT)$/)) { + throw new Error("Invalid default value type; expected: #REQUIRED, #IMPLIED, #FIXED or #DEFAULT"); + } + if (defaultValue && !defaultValueType.match(/^(#FIXED|#DEFAULT)$/)) { + throw new Error("Default value only applies to #FIXED or #DEFAULT"); + } + this.elementName = this.stringify.eleName(elementName); + this.attributeName = this.stringify.attName(attributeName); + this.attributeType = this.stringify.dtdAttType(attributeType); + this.defaultValue = this.stringify.dtdAttDefault(defaultValue); + this.defaultValueType = defaultValueType; + } + + XMLDTDAttList.prototype.toString = function(options) { + return this.options.writer.set(options).dtdAttList(this); + }; + + return XMLDTDAttList; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDTDElement.js b/node_modules/xmlbuilder/lib/XMLDTDElement.js new file mode 100644 index 0000000..43f5d05 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDTDElement.js @@ -0,0 +1,35 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDTDElement, XMLNode, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLNode = require('./XMLNode'); + + module.exports = XMLDTDElement = (function(superClass) { + extend(XMLDTDElement, superClass); + + function XMLDTDElement(parent, name, value) { + XMLDTDElement.__super__.constructor.call(this, parent); + if (name == null) { + throw new Error("Missing DTD element name"); + } + if (!value) { + value = '(#PCDATA)'; + } + if (Array.isArray(value)) { + value = '(' + value.join(',') + ')'; + } + this.name = this.stringify.eleName(name); + this.value = this.stringify.dtdElementValue(value); + } + + XMLDTDElement.prototype.toString = function(options) { + return this.options.writer.set(options).dtdElement(this); + }; + + return XMLDTDElement; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDTDEntity.js b/node_modules/xmlbuilder/lib/XMLDTDEntity.js new file mode 100644 index 0000000..943f312 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDTDEntity.js @@ -0,0 +1,56 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDTDEntity, XMLNode, isObject, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + isObject = require('./Utility').isObject; + + XMLNode = require('./XMLNode'); + + module.exports = XMLDTDEntity = (function(superClass) { + extend(XMLDTDEntity, superClass); + + function XMLDTDEntity(parent, pe, name, value) { + XMLDTDEntity.__super__.constructor.call(this, parent); + if (name == null) { + throw new Error("Missing entity name"); + } + if (value == null) { + throw new Error("Missing entity value"); + } + this.pe = !!pe; + this.name = this.stringify.eleName(name); + if (!isObject(value)) { + this.value = this.stringify.dtdEntityValue(value); + } else { + if (!value.pubID && !value.sysID) { + throw new Error("Public and/or system identifiers are required for an external entity"); + } + if (value.pubID && !value.sysID) { + throw new Error("System identifier is required for a public external entity"); + } + if (value.pubID != null) { + this.pubID = this.stringify.dtdPubID(value.pubID); + } + if (value.sysID != null) { + this.sysID = this.stringify.dtdSysID(value.sysID); + } + if (value.nData != null) { + this.nData = this.stringify.dtdNData(value.nData); + } + if (this.pe && this.nData) { + throw new Error("Notation declaration is not allowed in a parameter entity"); + } + } + } + + XMLDTDEntity.prototype.toString = function(options) { + return this.options.writer.set(options).dtdEntity(this); + }; + + return XMLDTDEntity; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDTDNotation.js b/node_modules/xmlbuilder/lib/XMLDTDNotation.js new file mode 100644 index 0000000..2c0c698 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDTDNotation.js @@ -0,0 +1,37 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDTDNotation, XMLNode, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLNode = require('./XMLNode'); + + module.exports = XMLDTDNotation = (function(superClass) { + extend(XMLDTDNotation, superClass); + + function XMLDTDNotation(parent, name, value) { + XMLDTDNotation.__super__.constructor.call(this, parent); + if (name == null) { + throw new Error("Missing notation name"); + } + if (!value.pubID && !value.sysID) { + throw new Error("Public or system identifiers are required for an external entity"); + } + this.name = this.stringify.eleName(name); + if (value.pubID != null) { + this.pubID = this.stringify.dtdPubID(value.pubID); + } + if (value.sysID != null) { + this.sysID = this.stringify.dtdSysID(value.sysID); + } + } + + XMLDTDNotation.prototype.toString = function(options) { + return this.options.writer.set(options).dtdNotation(this); + }; + + return XMLDTDNotation; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDeclaration.js b/node_modules/xmlbuilder/lib/XMLDeclaration.js new file mode 100644 index 0000000..3251f28 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDeclaration.js @@ -0,0 +1,40 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDeclaration, XMLNode, isObject, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + isObject = require('./Utility').isObject; + + XMLNode = require('./XMLNode'); + + module.exports = XMLDeclaration = (function(superClass) { + extend(XMLDeclaration, superClass); + + function XMLDeclaration(parent, version, encoding, standalone) { + var ref; + XMLDeclaration.__super__.constructor.call(this, parent); + if (isObject(version)) { + ref = version, version = ref.version, encoding = ref.encoding, standalone = ref.standalone; + } + if (!version) { + version = '1.0'; + } + this.version = this.stringify.xmlVersion(version); + if (encoding != null) { + this.encoding = this.stringify.xmlEncoding(encoding); + } + if (standalone != null) { + this.standalone = this.stringify.xmlStandalone(standalone); + } + } + + XMLDeclaration.prototype.toString = function(options) { + return this.options.writer.set(options).declaration(this); + }; + + return XMLDeclaration; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDocType.js b/node_modules/xmlbuilder/lib/XMLDocType.js new file mode 100644 index 0000000..1bb0429 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDocType.js @@ -0,0 +1,107 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDTDAttList, XMLDTDElement, XMLDTDEntity, XMLDTDNotation, XMLDocType, XMLNode, isObject, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + isObject = require('./Utility').isObject; + + XMLNode = require('./XMLNode'); + + XMLDTDAttList = require('./XMLDTDAttList'); + + XMLDTDEntity = require('./XMLDTDEntity'); + + XMLDTDElement = require('./XMLDTDElement'); + + XMLDTDNotation = require('./XMLDTDNotation'); + + module.exports = XMLDocType = (function(superClass) { + extend(XMLDocType, superClass); + + function XMLDocType(parent, pubID, sysID) { + var ref, ref1; + XMLDocType.__super__.constructor.call(this, parent); + this.documentObject = parent; + if (isObject(pubID)) { + ref = pubID, pubID = ref.pubID, sysID = ref.sysID; + } + if (sysID == null) { + ref1 = [pubID, sysID], sysID = ref1[0], pubID = ref1[1]; + } + if (pubID != null) { + this.pubID = this.stringify.dtdPubID(pubID); + } + if (sysID != null) { + this.sysID = this.stringify.dtdSysID(sysID); + } + } + + XMLDocType.prototype.element = function(name, value) { + var child; + child = new XMLDTDElement(this, name, value); + this.children.push(child); + return this; + }; + + XMLDocType.prototype.attList = function(elementName, attributeName, attributeType, defaultValueType, defaultValue) { + var child; + child = new XMLDTDAttList(this, elementName, attributeName, attributeType, defaultValueType, defaultValue); + this.children.push(child); + return this; + }; + + XMLDocType.prototype.entity = function(name, value) { + var child; + child = new XMLDTDEntity(this, false, name, value); + this.children.push(child); + return this; + }; + + XMLDocType.prototype.pEntity = function(name, value) { + var child; + child = new XMLDTDEntity(this, true, name, value); + this.children.push(child); + return this; + }; + + XMLDocType.prototype.notation = function(name, value) { + var child; + child = new XMLDTDNotation(this, name, value); + this.children.push(child); + return this; + }; + + XMLDocType.prototype.toString = function(options) { + return this.options.writer.set(options).docType(this); + }; + + XMLDocType.prototype.ele = function(name, value) { + return this.element(name, value); + }; + + XMLDocType.prototype.att = function(elementName, attributeName, attributeType, defaultValueType, defaultValue) { + return this.attList(elementName, attributeName, attributeType, defaultValueType, defaultValue); + }; + + XMLDocType.prototype.ent = function(name, value) { + return this.entity(name, value); + }; + + XMLDocType.prototype.pent = function(name, value) { + return this.pEntity(name, value); + }; + + XMLDocType.prototype.not = function(name, value) { + return this.notation(name, value); + }; + + XMLDocType.prototype.up = function() { + return this.root() || this.documentObject; + }; + + return XMLDocType; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDocument.js b/node_modules/xmlbuilder/lib/XMLDocument.js new file mode 100644 index 0000000..38743ee --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDocument.js @@ -0,0 +1,48 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDocument, XMLNode, XMLStringWriter, XMLStringifier, isPlainObject, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + isPlainObject = require('./Utility').isPlainObject; + + XMLNode = require('./XMLNode'); + + XMLStringifier = require('./XMLStringifier'); + + XMLStringWriter = require('./XMLStringWriter'); + + module.exports = XMLDocument = (function(superClass) { + extend(XMLDocument, superClass); + + function XMLDocument(options) { + XMLDocument.__super__.constructor.call(this, null); + options || (options = {}); + if (!options.writer) { + options.writer = new XMLStringWriter(); + } + this.options = options; + this.stringify = new XMLStringifier(options); + this.isDocument = true; + } + + XMLDocument.prototype.end = function(writer) { + var writerOptions; + if (!writer) { + writer = this.options.writer; + } else if (isPlainObject(writer)) { + writerOptions = writer; + writer = this.options.writer.set(writerOptions); + } + return writer.document(this); + }; + + XMLDocument.prototype.toString = function(options) { + return this.options.writer.set(options).document(this); + }; + + return XMLDocument; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLDocumentCB.js b/node_modules/xmlbuilder/lib/XMLDocumentCB.js new file mode 100644 index 0000000..00da8dc --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLDocumentCB.js @@ -0,0 +1,402 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLAttribute, XMLCData, XMLComment, XMLDTDAttList, XMLDTDElement, XMLDTDEntity, XMLDTDNotation, XMLDeclaration, XMLDocType, XMLDocumentCB, XMLElement, XMLProcessingInstruction, XMLRaw, XMLStringWriter, XMLStringifier, XMLText, isFunction, isObject, isPlainObject, ref, + hasProp = {}.hasOwnProperty; + + ref = require('./Utility'), isObject = ref.isObject, isFunction = ref.isFunction, isPlainObject = ref.isPlainObject; + + XMLElement = require('./XMLElement'); + + XMLCData = require('./XMLCData'); + + XMLComment = require('./XMLComment'); + + XMLRaw = require('./XMLRaw'); + + XMLText = require('./XMLText'); + + XMLProcessingInstruction = require('./XMLProcessingInstruction'); + + XMLDeclaration = require('./XMLDeclaration'); + + XMLDocType = require('./XMLDocType'); + + XMLDTDAttList = require('./XMLDTDAttList'); + + XMLDTDEntity = require('./XMLDTDEntity'); + + XMLDTDElement = require('./XMLDTDElement'); + + XMLDTDNotation = require('./XMLDTDNotation'); + + XMLAttribute = require('./XMLAttribute'); + + XMLStringifier = require('./XMLStringifier'); + + XMLStringWriter = require('./XMLStringWriter'); + + module.exports = XMLDocumentCB = (function() { + function XMLDocumentCB(options, onData, onEnd) { + var writerOptions; + options || (options = {}); + if (!options.writer) { + options.writer = new XMLStringWriter(options); + } else if (isPlainObject(options.writer)) { + writerOptions = options.writer; + options.writer = new XMLStringWriter(writerOptions); + } + this.options = options; + this.writer = options.writer; + this.stringify = new XMLStringifier(options); + this.onDataCallback = onData || function() {}; + this.onEndCallback = onEnd || function() {}; + this.currentNode = null; + this.currentLevel = -1; + this.openTags = {}; + this.documentStarted = false; + this.documentCompleted = false; + this.root = null; + } + + XMLDocumentCB.prototype.node = function(name, attributes, text) { + var ref1; + if (name == null) { + throw new Error("Missing node name"); + } + if (this.root && this.currentLevel === -1) { + throw new Error("Document can only have one root node"); + } + this.openCurrent(); + name = name.valueOf(); + if (attributes == null) { + attributes = {}; + } + attributes = attributes.valueOf(); + if (!isObject(attributes)) { + ref1 = [attributes, text], text = ref1[0], attributes = ref1[1]; + } + this.currentNode = new XMLElement(this, name, attributes); + this.currentNode.children = false; + this.currentLevel++; + this.openTags[this.currentLevel] = this.currentNode; + if (text != null) { + this.text(text); + } + return this; + }; + + XMLDocumentCB.prototype.element = function(name, attributes, text) { + if (this.currentNode && this.currentNode instanceof XMLDocType) { + return this.dtdElement.apply(this, arguments); + } else { + return this.node(name, attributes, text); + } + }; + + XMLDocumentCB.prototype.attribute = function(name, value) { + var attName, attValue; + if (!this.currentNode || this.currentNode.children) { + throw new Error("att() can only be used immediately after an ele() call in callback mode"); + } + if (name != null) { + name = name.valueOf(); + } + if (isObject(name)) { + for (attName in name) { + if (!hasProp.call(name, attName)) continue; + attValue = name[attName]; + this.attribute(attName, attValue); + } + } else { + if (isFunction(value)) { + value = value.apply(); + } + if (!this.options.skipNullAttributes || (value != null)) { + this.currentNode.attributes[name] = new XMLAttribute(this, name, value); + } + } + return this; + }; + + XMLDocumentCB.prototype.text = function(value) { + var node; + this.openCurrent(); + node = new XMLText(this, value); + this.onData(this.writer.text(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.cdata = function(value) { + var node; + this.openCurrent(); + node = new XMLCData(this, value); + this.onData(this.writer.cdata(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.comment = function(value) { + var node; + this.openCurrent(); + node = new XMLComment(this, value); + this.onData(this.writer.comment(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.raw = function(value) { + var node; + this.openCurrent(); + node = new XMLRaw(this, value); + this.onData(this.writer.raw(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.instruction = function(target, value) { + var i, insTarget, insValue, len, node; + this.openCurrent(); + if (target != null) { + target = target.valueOf(); + } + if (value != null) { + value = value.valueOf(); + } + if (Array.isArray(target)) { + for (i = 0, len = target.length; i < len; i++) { + insTarget = target[i]; + this.instruction(insTarget); + } + } else if (isObject(target)) { + for (insTarget in target) { + if (!hasProp.call(target, insTarget)) continue; + insValue = target[insTarget]; + this.instruction(insTarget, insValue); + } + } else { + if (isFunction(value)) { + value = value.apply(); + } + node = new XMLProcessingInstruction(this, target, value); + this.onData(this.writer.processingInstruction(node, this.currentLevel + 1)); + } + return this; + }; + + XMLDocumentCB.prototype.declaration = function(version, encoding, standalone) { + var node; + this.openCurrent(); + if (this.documentStarted) { + throw new Error("declaration() must be the first node"); + } + node = new XMLDeclaration(this, version, encoding, standalone); + this.onData(this.writer.declaration(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.doctype = function(root, pubID, sysID) { + this.openCurrent(); + if (root == null) { + throw new Error("Missing root node name"); + } + if (this.root) { + throw new Error("dtd() must come before the root node"); + } + this.currentNode = new XMLDocType(this, pubID, sysID); + this.currentNode.rootNodeName = root; + this.currentNode.children = false; + this.currentLevel++; + this.openTags[this.currentLevel] = this.currentNode; + return this; + }; + + XMLDocumentCB.prototype.dtdElement = function(name, value) { + var node; + this.openCurrent(); + node = new XMLDTDElement(this, name, value); + this.onData(this.writer.dtdElement(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.attList = function(elementName, attributeName, attributeType, defaultValueType, defaultValue) { + var node; + this.openCurrent(); + node = new XMLDTDAttList(this, elementName, attributeName, attributeType, defaultValueType, defaultValue); + this.onData(this.writer.dtdAttList(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.entity = function(name, value) { + var node; + this.openCurrent(); + node = new XMLDTDEntity(this, false, name, value); + this.onData(this.writer.dtdEntity(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.pEntity = function(name, value) { + var node; + this.openCurrent(); + node = new XMLDTDEntity(this, true, name, value); + this.onData(this.writer.dtdEntity(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.notation = function(name, value) { + var node; + this.openCurrent(); + node = new XMLDTDNotation(this, name, value); + this.onData(this.writer.dtdNotation(node, this.currentLevel + 1)); + return this; + }; + + XMLDocumentCB.prototype.up = function() { + if (this.currentLevel < 0) { + throw new Error("The document node has no parent"); + } + if (this.currentNode) { + if (this.currentNode.children) { + this.closeNode(this.currentNode); + } else { + this.openNode(this.currentNode); + } + this.currentNode = null; + } else { + this.closeNode(this.openTags[this.currentLevel]); + } + delete this.openTags[this.currentLevel]; + this.currentLevel--; + return this; + }; + + XMLDocumentCB.prototype.end = function() { + while (this.currentLevel >= 0) { + this.up(); + } + return this.onEnd(); + }; + + XMLDocumentCB.prototype.openCurrent = function() { + if (this.currentNode) { + this.currentNode.children = true; + return this.openNode(this.currentNode); + } + }; + + XMLDocumentCB.prototype.openNode = function(node) { + if (!node.isOpen) { + if (!this.root && this.currentLevel === 0 && node instanceof XMLElement) { + this.root = node; + } + this.onData(this.writer.openNode(node, this.currentLevel)); + return node.isOpen = true; + } + }; + + XMLDocumentCB.prototype.closeNode = function(node) { + if (!node.isClosed) { + this.onData(this.writer.closeNode(node, this.currentLevel)); + return node.isClosed = true; + } + }; + + XMLDocumentCB.prototype.onData = function(chunk) { + this.documentStarted = true; + return this.onDataCallback(chunk); + }; + + XMLDocumentCB.prototype.onEnd = function() { + this.documentCompleted = true; + return this.onEndCallback(); + }; + + XMLDocumentCB.prototype.ele = function() { + return this.element.apply(this, arguments); + }; + + XMLDocumentCB.prototype.nod = function(name, attributes, text) { + return this.node(name, attributes, text); + }; + + XMLDocumentCB.prototype.txt = function(value) { + return this.text(value); + }; + + XMLDocumentCB.prototype.dat = function(value) { + return this.cdata(value); + }; + + XMLDocumentCB.prototype.com = function(value) { + return this.comment(value); + }; + + XMLDocumentCB.prototype.ins = function(target, value) { + return this.instruction(target, value); + }; + + XMLDocumentCB.prototype.dec = function(version, encoding, standalone) { + return this.declaration(version, encoding, standalone); + }; + + XMLDocumentCB.prototype.dtd = function(root, pubID, sysID) { + return this.doctype(root, pubID, sysID); + }; + + XMLDocumentCB.prototype.e = function(name, attributes, text) { + return this.element(name, attributes, text); + }; + + XMLDocumentCB.prototype.n = function(name, attributes, text) { + return this.node(name, attributes, text); + }; + + XMLDocumentCB.prototype.t = function(value) { + return this.text(value); + }; + + XMLDocumentCB.prototype.d = function(value) { + return this.cdata(value); + }; + + XMLDocumentCB.prototype.c = function(value) { + return this.comment(value); + }; + + XMLDocumentCB.prototype.r = function(value) { + return this.raw(value); + }; + + XMLDocumentCB.prototype.i = function(target, value) { + return this.instruction(target, value); + }; + + XMLDocumentCB.prototype.att = function() { + if (this.currentNode && this.currentNode instanceof XMLDocType) { + return this.attList.apply(this, arguments); + } else { + return this.attribute.apply(this, arguments); + } + }; + + XMLDocumentCB.prototype.a = function() { + if (this.currentNode && this.currentNode instanceof XMLDocType) { + return this.attList.apply(this, arguments); + } else { + return this.attribute.apply(this, arguments); + } + }; + + XMLDocumentCB.prototype.ent = function(name, value) { + return this.entity(name, value); + }; + + XMLDocumentCB.prototype.pent = function(name, value) { + return this.pEntity(name, value); + }; + + XMLDocumentCB.prototype.not = function(name, value) { + return this.notation(name, value); + }; + + return XMLDocumentCB; + + })(); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLElement.js b/node_modules/xmlbuilder/lib/XMLElement.js new file mode 100644 index 0000000..bd1f46c --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLElement.js @@ -0,0 +1,111 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLAttribute, XMLElement, XMLNode, isFunction, isObject, ref, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + ref = require('./Utility'), isObject = ref.isObject, isFunction = ref.isFunction; + + XMLNode = require('./XMLNode'); + + XMLAttribute = require('./XMLAttribute'); + + module.exports = XMLElement = (function(superClass) { + extend(XMLElement, superClass); + + function XMLElement(parent, name, attributes) { + XMLElement.__super__.constructor.call(this, parent); + if (name == null) { + throw new Error("Missing element name"); + } + this.name = this.stringify.eleName(name); + this.attributes = {}; + if (attributes != null) { + this.attribute(attributes); + } + if (parent.isDocument) { + this.isRoot = true; + this.documentObject = parent; + parent.rootObject = this; + } + } + + XMLElement.prototype.clone = function() { + var att, attName, clonedSelf, ref1; + clonedSelf = Object.create(this); + if (clonedSelf.isRoot) { + clonedSelf.documentObject = null; + } + clonedSelf.attributes = {}; + ref1 = this.attributes; + for (attName in ref1) { + if (!hasProp.call(ref1, attName)) continue; + att = ref1[attName]; + clonedSelf.attributes[attName] = att.clone(); + } + clonedSelf.children = []; + this.children.forEach(function(child) { + var clonedChild; + clonedChild = child.clone(); + clonedChild.parent = clonedSelf; + return clonedSelf.children.push(clonedChild); + }); + return clonedSelf; + }; + + XMLElement.prototype.attribute = function(name, value) { + var attName, attValue; + if (name != null) { + name = name.valueOf(); + } + if (isObject(name)) { + for (attName in name) { + if (!hasProp.call(name, attName)) continue; + attValue = name[attName]; + this.attribute(attName, attValue); + } + } else { + if (isFunction(value)) { + value = value.apply(); + } + if (!this.options.skipNullAttributes || (value != null)) { + this.attributes[name] = new XMLAttribute(this, name, value); + } + } + return this; + }; + + XMLElement.prototype.removeAttribute = function(name) { + var attName, i, len; + if (name == null) { + throw new Error("Missing attribute name"); + } + name = name.valueOf(); + if (Array.isArray(name)) { + for (i = 0, len = name.length; i < len; i++) { + attName = name[i]; + delete this.attributes[attName]; + } + } else { + delete this.attributes[name]; + } + return this; + }; + + XMLElement.prototype.toString = function(options) { + return this.options.writer.set(options).element(this); + }; + + XMLElement.prototype.att = function(name, value) { + return this.attribute(name, value); + }; + + XMLElement.prototype.a = function(name, value) { + return this.attribute(name, value); + }; + + return XMLElement; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLNode.js b/node_modules/xmlbuilder/lib/XMLNode.js new file mode 100644 index 0000000..00ab37d --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLNode.js @@ -0,0 +1,432 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLCData, XMLComment, XMLDeclaration, XMLDocType, XMLElement, XMLNode, XMLProcessingInstruction, XMLRaw, XMLText, isEmpty, isFunction, isObject, ref, + hasProp = {}.hasOwnProperty; + + ref = require('./Utility'), isObject = ref.isObject, isFunction = ref.isFunction, isEmpty = ref.isEmpty; + + XMLElement = null; + + XMLCData = null; + + XMLComment = null; + + XMLDeclaration = null; + + XMLDocType = null; + + XMLRaw = null; + + XMLText = null; + + XMLProcessingInstruction = null; + + module.exports = XMLNode = (function() { + function XMLNode(parent) { + this.parent = parent; + if (this.parent) { + this.options = this.parent.options; + this.stringify = this.parent.stringify; + } + this.children = []; + if (!XMLElement) { + XMLElement = require('./XMLElement'); + XMLCData = require('./XMLCData'); + XMLComment = require('./XMLComment'); + XMLDeclaration = require('./XMLDeclaration'); + XMLDocType = require('./XMLDocType'); + XMLRaw = require('./XMLRaw'); + XMLText = require('./XMLText'); + XMLProcessingInstruction = require('./XMLProcessingInstruction'); + } + } + + XMLNode.prototype.element = function(name, attributes, text) { + var childNode, item, j, k, key, lastChild, len, len1, ref1, val; + lastChild = null; + if (attributes == null) { + attributes = {}; + } + attributes = attributes.valueOf(); + if (!isObject(attributes)) { + ref1 = [attributes, text], text = ref1[0], attributes = ref1[1]; + } + if (name != null) { + name = name.valueOf(); + } + if (Array.isArray(name)) { + for (j = 0, len = name.length; j < len; j++) { + item = name[j]; + lastChild = this.element(item); + } + } else if (isFunction(name)) { + lastChild = this.element(name.apply()); + } else if (isObject(name)) { + for (key in name) { + if (!hasProp.call(name, key)) continue; + val = name[key]; + if (isFunction(val)) { + val = val.apply(); + } + if ((isObject(val)) && (isEmpty(val))) { + val = null; + } + if (!this.options.ignoreDecorators && this.stringify.convertAttKey && key.indexOf(this.stringify.convertAttKey) === 0) { + lastChild = this.attribute(key.substr(this.stringify.convertAttKey.length), val); + } else if (!this.options.separateArrayItems && Array.isArray(val)) { + for (k = 0, len1 = val.length; k < len1; k++) { + item = val[k]; + childNode = {}; + childNode[key] = item; + lastChild = this.element(childNode); + } + } else if (isObject(val)) { + lastChild = this.element(key); + lastChild.element(val); + } else { + lastChild = this.element(key, val); + } + } + } else { + if (!this.options.ignoreDecorators && this.stringify.convertTextKey && name.indexOf(this.stringify.convertTextKey) === 0) { + lastChild = this.text(text); + } else if (!this.options.ignoreDecorators && this.stringify.convertCDataKey && name.indexOf(this.stringify.convertCDataKey) === 0) { + lastChild = this.cdata(text); + } else if (!this.options.ignoreDecorators && this.stringify.convertCommentKey && name.indexOf(this.stringify.convertCommentKey) === 0) { + lastChild = this.comment(text); + } else if (!this.options.ignoreDecorators && this.stringify.convertRawKey && name.indexOf(this.stringify.convertRawKey) === 0) { + lastChild = this.raw(text); + } else if (!this.options.ignoreDecorators && this.stringify.convertPIKey && name.indexOf(this.stringify.convertPIKey) === 0) { + lastChild = this.instruction(name.substr(this.stringify.convertPIKey.length), text); + } else { + lastChild = this.node(name, attributes, text); + } + } + if (lastChild == null) { + throw new Error("Could not create any elements with: " + name); + } + return lastChild; + }; + + XMLNode.prototype.insertBefore = function(name, attributes, text) { + var child, i, removed; + if (this.isRoot) { + throw new Error("Cannot insert elements at root level"); + } + i = this.parent.children.indexOf(this); + removed = this.parent.children.splice(i); + child = this.parent.element(name, attributes, text); + Array.prototype.push.apply(this.parent.children, removed); + return child; + }; + + XMLNode.prototype.insertAfter = function(name, attributes, text) { + var child, i, removed; + if (this.isRoot) { + throw new Error("Cannot insert elements at root level"); + } + i = this.parent.children.indexOf(this); + removed = this.parent.children.splice(i + 1); + child = this.parent.element(name, attributes, text); + Array.prototype.push.apply(this.parent.children, removed); + return child; + }; + + XMLNode.prototype.remove = function() { + var i, ref1; + if (this.isRoot) { + throw new Error("Cannot remove the root element"); + } + i = this.parent.children.indexOf(this); + [].splice.apply(this.parent.children, [i, i - i + 1].concat(ref1 = [])), ref1; + return this.parent; + }; + + XMLNode.prototype.node = function(name, attributes, text) { + var child, ref1; + if (name != null) { + name = name.valueOf(); + } + attributes || (attributes = {}); + attributes = attributes.valueOf(); + if (!isObject(attributes)) { + ref1 = [attributes, text], text = ref1[0], attributes = ref1[1]; + } + child = new XMLElement(this, name, attributes); + if (text != null) { + child.text(text); + } + this.children.push(child); + return child; + }; + + XMLNode.prototype.text = function(value) { + var child; + child = new XMLText(this, value); + this.children.push(child); + return this; + }; + + XMLNode.prototype.cdata = function(value) { + var child; + child = new XMLCData(this, value); + this.children.push(child); + return this; + }; + + XMLNode.prototype.comment = function(value) { + var child; + child = new XMLComment(this, value); + this.children.push(child); + return this; + }; + + XMLNode.prototype.commentBefore = function(value) { + var child, i, removed; + i = this.parent.children.indexOf(this); + removed = this.parent.children.splice(i); + child = this.parent.comment(value); + Array.prototype.push.apply(this.parent.children, removed); + return this; + }; + + XMLNode.prototype.commentAfter = function(value) { + var child, i, removed; + i = this.parent.children.indexOf(this); + removed = this.parent.children.splice(i + 1); + child = this.parent.comment(value); + Array.prototype.push.apply(this.parent.children, removed); + return this; + }; + + XMLNode.prototype.raw = function(value) { + var child; + child = new XMLRaw(this, value); + this.children.push(child); + return this; + }; + + XMLNode.prototype.instruction = function(target, value) { + var insTarget, insValue, instruction, j, len; + if (target != null) { + target = target.valueOf(); + } + if (value != null) { + value = value.valueOf(); + } + if (Array.isArray(target)) { + for (j = 0, len = target.length; j < len; j++) { + insTarget = target[j]; + this.instruction(insTarget); + } + } else if (isObject(target)) { + for (insTarget in target) { + if (!hasProp.call(target, insTarget)) continue; + insValue = target[insTarget]; + this.instruction(insTarget, insValue); + } + } else { + if (isFunction(value)) { + value = value.apply(); + } + instruction = new XMLProcessingInstruction(this, target, value); + this.children.push(instruction); + } + return this; + }; + + XMLNode.prototype.instructionBefore = function(target, value) { + var child, i, removed; + i = this.parent.children.indexOf(this); + removed = this.parent.children.splice(i); + child = this.parent.instruction(target, value); + Array.prototype.push.apply(this.parent.children, removed); + return this; + }; + + XMLNode.prototype.instructionAfter = function(target, value) { + var child, i, removed; + i = this.parent.children.indexOf(this); + removed = this.parent.children.splice(i + 1); + child = this.parent.instruction(target, value); + Array.prototype.push.apply(this.parent.children, removed); + return this; + }; + + XMLNode.prototype.declaration = function(version, encoding, standalone) { + var doc, xmldec; + doc = this.document(); + xmldec = new XMLDeclaration(doc, version, encoding, standalone); + if (doc.children[0] instanceof XMLDeclaration) { + doc.children[0] = xmldec; + } else { + doc.children.unshift(xmldec); + } + return doc.root() || doc; + }; + + XMLNode.prototype.doctype = function(pubID, sysID) { + var child, doc, doctype, i, j, k, len, len1, ref1, ref2; + doc = this.document(); + doctype = new XMLDocType(doc, pubID, sysID); + ref1 = doc.children; + for (i = j = 0, len = ref1.length; j < len; i = ++j) { + child = ref1[i]; + if (child instanceof XMLDocType) { + doc.children[i] = doctype; + return doctype; + } + } + ref2 = doc.children; + for (i = k = 0, len1 = ref2.length; k < len1; i = ++k) { + child = ref2[i]; + if (child.isRoot) { + doc.children.splice(i, 0, doctype); + return doctype; + } + } + doc.children.push(doctype); + return doctype; + }; + + XMLNode.prototype.up = function() { + if (this.isRoot) { + throw new Error("The root node has no parent. Use doc() if you need to get the document object."); + } + return this.parent; + }; + + XMLNode.prototype.root = function() { + var node; + node = this; + while (node) { + if (node.isDocument) { + return node.rootObject; + } else if (node.isRoot) { + return node; + } else { + node = node.parent; + } + } + }; + + XMLNode.prototype.document = function() { + var node; + node = this; + while (node) { + if (node.isDocument) { + return node; + } else { + node = node.parent; + } + } + }; + + XMLNode.prototype.end = function(options) { + return this.document().end(options); + }; + + XMLNode.prototype.prev = function() { + var i; + i = this.parent.children.indexOf(this); + if (i < 1) { + throw new Error("Already at the first node"); + } + return this.parent.children[i - 1]; + }; + + XMLNode.prototype.next = function() { + var i; + i = this.parent.children.indexOf(this); + if (i === -1 || i === this.parent.children.length - 1) { + throw new Error("Already at the last node"); + } + return this.parent.children[i + 1]; + }; + + XMLNode.prototype.importDocument = function(doc) { + var clonedRoot; + clonedRoot = doc.root().clone(); + clonedRoot.parent = this; + clonedRoot.isRoot = false; + this.children.push(clonedRoot); + return this; + }; + + XMLNode.prototype.ele = function(name, attributes, text) { + return this.element(name, attributes, text); + }; + + XMLNode.prototype.nod = function(name, attributes, text) { + return this.node(name, attributes, text); + }; + + XMLNode.prototype.txt = function(value) { + return this.text(value); + }; + + XMLNode.prototype.dat = function(value) { + return this.cdata(value); + }; + + XMLNode.prototype.com = function(value) { + return this.comment(value); + }; + + XMLNode.prototype.ins = function(target, value) { + return this.instruction(target, value); + }; + + XMLNode.prototype.doc = function() { + return this.document(); + }; + + XMLNode.prototype.dec = function(version, encoding, standalone) { + return this.declaration(version, encoding, standalone); + }; + + XMLNode.prototype.dtd = function(pubID, sysID) { + return this.doctype(pubID, sysID); + }; + + XMLNode.prototype.e = function(name, attributes, text) { + return this.element(name, attributes, text); + }; + + XMLNode.prototype.n = function(name, attributes, text) { + return this.node(name, attributes, text); + }; + + XMLNode.prototype.t = function(value) { + return this.text(value); + }; + + XMLNode.prototype.d = function(value) { + return this.cdata(value); + }; + + XMLNode.prototype.c = function(value) { + return this.comment(value); + }; + + XMLNode.prototype.r = function(value) { + return this.raw(value); + }; + + XMLNode.prototype.i = function(target, value) { + return this.instruction(target, value); + }; + + XMLNode.prototype.u = function() { + return this.up(); + }; + + XMLNode.prototype.importXMLBuilder = function(doc) { + return this.importDocument(doc); + }; + + return XMLNode; + + })(); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLProcessingInstruction.js b/node_modules/xmlbuilder/lib/XMLProcessingInstruction.js new file mode 100644 index 0000000..e6f71d1 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLProcessingInstruction.js @@ -0,0 +1,35 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLNode, XMLProcessingInstruction, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLNode = require('./XMLNode'); + + module.exports = XMLProcessingInstruction = (function(superClass) { + extend(XMLProcessingInstruction, superClass); + + function XMLProcessingInstruction(parent, target, value) { + XMLProcessingInstruction.__super__.constructor.call(this, parent); + if (target == null) { + throw new Error("Missing instruction target"); + } + this.target = this.stringify.insTarget(target); + if (value) { + this.value = this.stringify.insValue(value); + } + } + + XMLProcessingInstruction.prototype.clone = function() { + return Object.create(this); + }; + + XMLProcessingInstruction.prototype.toString = function(options) { + return this.options.writer.set(options).processingInstruction(this); + }; + + return XMLProcessingInstruction; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLRaw.js b/node_modules/xmlbuilder/lib/XMLRaw.js new file mode 100644 index 0000000..dbe7fdc --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLRaw.js @@ -0,0 +1,32 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLNode, XMLRaw, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLNode = require('./XMLNode'); + + module.exports = XMLRaw = (function(superClass) { + extend(XMLRaw, superClass); + + function XMLRaw(parent, text) { + XMLRaw.__super__.constructor.call(this, parent); + if (text == null) { + throw new Error("Missing raw text"); + } + this.value = this.stringify.raw(text); + } + + XMLRaw.prototype.clone = function() { + return Object.create(this); + }; + + XMLRaw.prototype.toString = function(options) { + return this.options.writer.set(options).raw(this); + }; + + return XMLRaw; + + })(XMLNode); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLStreamWriter.js b/node_modules/xmlbuilder/lib/XMLStreamWriter.js new file mode 100644 index 0000000..20d98ee --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLStreamWriter.js @@ -0,0 +1,279 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLCData, XMLComment, XMLDTDAttList, XMLDTDElement, XMLDTDEntity, XMLDTDNotation, XMLDeclaration, XMLDocType, XMLElement, XMLProcessingInstruction, XMLRaw, XMLStreamWriter, XMLText, XMLWriterBase, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLDeclaration = require('./XMLDeclaration'); + + XMLDocType = require('./XMLDocType'); + + XMLCData = require('./XMLCData'); + + XMLComment = require('./XMLComment'); + + XMLElement = require('./XMLElement'); + + XMLRaw = require('./XMLRaw'); + + XMLText = require('./XMLText'); + + XMLProcessingInstruction = require('./XMLProcessingInstruction'); + + XMLDTDAttList = require('./XMLDTDAttList'); + + XMLDTDElement = require('./XMLDTDElement'); + + XMLDTDEntity = require('./XMLDTDEntity'); + + XMLDTDNotation = require('./XMLDTDNotation'); + + XMLWriterBase = require('./XMLWriterBase'); + + module.exports = XMLStreamWriter = (function(superClass) { + extend(XMLStreamWriter, superClass); + + function XMLStreamWriter(stream, options) { + XMLStreamWriter.__super__.constructor.call(this, options); + this.stream = stream; + } + + XMLStreamWriter.prototype.document = function(doc) { + var child, i, j, len, len1, ref, ref1, results; + ref = doc.children; + for (i = 0, len = ref.length; i < len; i++) { + child = ref[i]; + child.isLastRootNode = false; + } + doc.children[doc.children.length - 1].isLastRootNode = true; + ref1 = doc.children; + results = []; + for (j = 0, len1 = ref1.length; j < len1; j++) { + child = ref1[j]; + switch (false) { + case !(child instanceof XMLDeclaration): + results.push(this.declaration(child)); + break; + case !(child instanceof XMLDocType): + results.push(this.docType(child)); + break; + case !(child instanceof XMLComment): + results.push(this.comment(child)); + break; + case !(child instanceof XMLProcessingInstruction): + results.push(this.processingInstruction(child)); + break; + default: + results.push(this.element(child)); + } + } + return results; + }; + + XMLStreamWriter.prototype.attribute = function(att) { + return this.stream.write(' ' + att.name + '="' + att.value + '"'); + }; + + XMLStreamWriter.prototype.cdata = function(node, level) { + return this.stream.write(this.space(level) + '' + this.endline(node)); + }; + + XMLStreamWriter.prototype.comment = function(node, level) { + return this.stream.write(this.space(level) + '' + this.endline(node)); + }; + + XMLStreamWriter.prototype.declaration = function(node, level) { + this.stream.write(this.space(level)); + this.stream.write(''); + return this.stream.write(this.endline(node)); + }; + + XMLStreamWriter.prototype.docType = function(node, level) { + var child, i, len, ref; + level || (level = 0); + this.stream.write(this.space(level)); + this.stream.write(' 0) { + this.stream.write(' ['); + this.stream.write(this.endline(node)); + ref = node.children; + for (i = 0, len = ref.length; i < len; i++) { + child = ref[i]; + switch (false) { + case !(child instanceof XMLDTDAttList): + this.dtdAttList(child, level + 1); + break; + case !(child instanceof XMLDTDElement): + this.dtdElement(child, level + 1); + break; + case !(child instanceof XMLDTDEntity): + this.dtdEntity(child, level + 1); + break; + case !(child instanceof XMLDTDNotation): + this.dtdNotation(child, level + 1); + break; + case !(child instanceof XMLCData): + this.cdata(child, level + 1); + break; + case !(child instanceof XMLComment): + this.comment(child, level + 1); + break; + case !(child instanceof XMLProcessingInstruction): + this.processingInstruction(child, level + 1); + break; + default: + throw new Error("Unknown DTD node type: " + child.constructor.name); + } + } + this.stream.write(']'); + } + this.stream.write(this.spacebeforeslash + '>'); + return this.stream.write(this.endline(node)); + }; + + XMLStreamWriter.prototype.element = function(node, level) { + var att, child, i, len, name, ref, ref1, space; + level || (level = 0); + space = this.space(level); + this.stream.write(space + '<' + node.name); + ref = node.attributes; + for (name in ref) { + if (!hasProp.call(ref, name)) continue; + att = ref[name]; + this.attribute(att); + } + if (node.children.length === 0 || node.children.every(function(e) { + return e.value === ''; + })) { + if (this.allowEmpty) { + this.stream.write('>'); + } else { + this.stream.write(this.spacebeforeslash + '/>'); + } + } else if (this.pretty && node.children.length === 1 && (node.children[0].value != null)) { + this.stream.write('>'); + this.stream.write(node.children[0].value); + this.stream.write(''); + } else { + this.stream.write('>' + this.newline); + ref1 = node.children; + for (i = 0, len = ref1.length; i < len; i++) { + child = ref1[i]; + switch (false) { + case !(child instanceof XMLCData): + this.cdata(child, level + 1); + break; + case !(child instanceof XMLComment): + this.comment(child, level + 1); + break; + case !(child instanceof XMLElement): + this.element(child, level + 1); + break; + case !(child instanceof XMLRaw): + this.raw(child, level + 1); + break; + case !(child instanceof XMLText): + this.text(child, level + 1); + break; + case !(child instanceof XMLProcessingInstruction): + this.processingInstruction(child, level + 1); + break; + default: + throw new Error("Unknown XML node type: " + child.constructor.name); + } + } + this.stream.write(space + ''); + } + return this.stream.write(this.endline(node)); + }; + + XMLStreamWriter.prototype.processingInstruction = function(node, level) { + this.stream.write(this.space(level) + '' + this.endline(node)); + }; + + XMLStreamWriter.prototype.raw = function(node, level) { + return this.stream.write(this.space(level) + node.value + this.endline(node)); + }; + + XMLStreamWriter.prototype.text = function(node, level) { + return this.stream.write(this.space(level) + node.value + this.endline(node)); + }; + + XMLStreamWriter.prototype.dtdAttList = function(node, level) { + this.stream.write(this.space(level) + '' + this.endline(node)); + }; + + XMLStreamWriter.prototype.dtdElement = function(node, level) { + this.stream.write(this.space(level) + '' + this.endline(node)); + }; + + XMLStreamWriter.prototype.dtdEntity = function(node, level) { + this.stream.write(this.space(level) + '' + this.endline(node)); + }; + + XMLStreamWriter.prototype.dtdNotation = function(node, level) { + this.stream.write(this.space(level) + '' + this.endline(node)); + }; + + XMLStreamWriter.prototype.endline = function(node) { + if (!node.isLastRootNode) { + return this.newline; + } else { + return ''; + } + }; + + return XMLStreamWriter; + + })(XMLWriterBase); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLStringWriter.js b/node_modules/xmlbuilder/lib/XMLStringWriter.js new file mode 100644 index 0000000..49da759 --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLStringWriter.js @@ -0,0 +1,334 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLCData, XMLComment, XMLDTDAttList, XMLDTDElement, XMLDTDEntity, XMLDTDNotation, XMLDeclaration, XMLDocType, XMLElement, XMLProcessingInstruction, XMLRaw, XMLStringWriter, XMLText, XMLWriterBase, + extend = function(child, parent) { for (var key in parent) { if (hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + hasProp = {}.hasOwnProperty; + + XMLDeclaration = require('./XMLDeclaration'); + + XMLDocType = require('./XMLDocType'); + + XMLCData = require('./XMLCData'); + + XMLComment = require('./XMLComment'); + + XMLElement = require('./XMLElement'); + + XMLRaw = require('./XMLRaw'); + + XMLText = require('./XMLText'); + + XMLProcessingInstruction = require('./XMLProcessingInstruction'); + + XMLDTDAttList = require('./XMLDTDAttList'); + + XMLDTDElement = require('./XMLDTDElement'); + + XMLDTDEntity = require('./XMLDTDEntity'); + + XMLDTDNotation = require('./XMLDTDNotation'); + + XMLWriterBase = require('./XMLWriterBase'); + + module.exports = XMLStringWriter = (function(superClass) { + extend(XMLStringWriter, superClass); + + function XMLStringWriter(options) { + XMLStringWriter.__super__.constructor.call(this, options); + } + + XMLStringWriter.prototype.document = function(doc) { + var child, i, len, r, ref; + this.textispresent = false; + r = ''; + ref = doc.children; + for (i = 0, len = ref.length; i < len; i++) { + child = ref[i]; + r += (function() { + switch (false) { + case !(child instanceof XMLDeclaration): + return this.declaration(child); + case !(child instanceof XMLDocType): + return this.docType(child); + case !(child instanceof XMLComment): + return this.comment(child); + case !(child instanceof XMLProcessingInstruction): + return this.processingInstruction(child); + default: + return this.element(child, 0); + } + }).call(this); + } + if (this.pretty && r.slice(-this.newline.length) === this.newline) { + r = r.slice(0, -this.newline.length); + } + return r; + }; + + XMLStringWriter.prototype.attribute = function(att) { + return ' ' + att.name + '="' + att.value + '"'; + }; + + XMLStringWriter.prototype.cdata = function(node, level) { + return this.space(level) + '' + this.newline; + }; + + XMLStringWriter.prototype.comment = function(node, level) { + return this.space(level) + '' + this.newline; + }; + + XMLStringWriter.prototype.declaration = function(node, level) { + var r; + r = this.space(level); + r += ''; + r += this.newline; + return r; + }; + + XMLStringWriter.prototype.docType = function(node, level) { + var child, i, len, r, ref; + level || (level = 0); + r = this.space(level); + r += ' 0) { + r += ' ['; + r += this.newline; + ref = node.children; + for (i = 0, len = ref.length; i < len; i++) { + child = ref[i]; + r += (function() { + switch (false) { + case !(child instanceof XMLDTDAttList): + return this.dtdAttList(child, level + 1); + case !(child instanceof XMLDTDElement): + return this.dtdElement(child, level + 1); + case !(child instanceof XMLDTDEntity): + return this.dtdEntity(child, level + 1); + case !(child instanceof XMLDTDNotation): + return this.dtdNotation(child, level + 1); + case !(child instanceof XMLCData): + return this.cdata(child, level + 1); + case !(child instanceof XMLComment): + return this.comment(child, level + 1); + case !(child instanceof XMLProcessingInstruction): + return this.processingInstruction(child, level + 1); + default: + throw new Error("Unknown DTD node type: " + child.constructor.name); + } + }).call(this); + } + r += ']'; + } + r += this.spacebeforeslash + '>'; + r += this.newline; + return r; + }; + + XMLStringWriter.prototype.element = function(node, level) { + var att, child, i, j, len, len1, name, r, ref, ref1, ref2, space, textispresentwasset; + level || (level = 0); + textispresentwasset = false; + if (this.textispresent) { + this.newline = ''; + this.pretty = false; + } else { + this.newline = this.newlinedefault; + this.pretty = this.prettydefault; + } + space = this.space(level); + r = ''; + r += space + '<' + node.name; + ref = node.attributes; + for (name in ref) { + if (!hasProp.call(ref, name)) continue; + att = ref[name]; + r += this.attribute(att); + } + if (node.children.length === 0 || node.children.every(function(e) { + return e.value === ''; + })) { + if (this.allowEmpty) { + r += '>' + this.newline; + } else { + r += this.spacebeforeslash + '/>' + this.newline; + } + } else if (this.pretty && node.children.length === 1 && (node.children[0].value != null)) { + r += '>'; + r += node.children[0].value; + r += '' + this.newline; + } else { + if (this.dontprettytextnodes) { + ref1 = node.children; + for (i = 0, len = ref1.length; i < len; i++) { + child = ref1[i]; + if (child.value != null) { + this.textispresent++; + textispresentwasset = true; + break; + } + } + } + if (this.textispresent) { + this.newline = ''; + this.pretty = false; + space = this.space(level); + } + r += '>' + this.newline; + ref2 = node.children; + for (j = 0, len1 = ref2.length; j < len1; j++) { + child = ref2[j]; + r += (function() { + switch (false) { + case !(child instanceof XMLCData): + return this.cdata(child, level + 1); + case !(child instanceof XMLComment): + return this.comment(child, level + 1); + case !(child instanceof XMLElement): + return this.element(child, level + 1); + case !(child instanceof XMLRaw): + return this.raw(child, level + 1); + case !(child instanceof XMLText): + return this.text(child, level + 1); + case !(child instanceof XMLProcessingInstruction): + return this.processingInstruction(child, level + 1); + default: + throw new Error("Unknown XML node type: " + child.constructor.name); + } + }).call(this); + } + if (textispresentwasset) { + this.textispresent--; + } + if (!this.textispresent) { + this.newline = this.newlinedefault; + this.pretty = this.prettydefault; + } + r += space + '' + this.newline; + } + return r; + }; + + XMLStringWriter.prototype.processingInstruction = function(node, level) { + var r; + r = this.space(level) + '' + this.newline; + return r; + }; + + XMLStringWriter.prototype.raw = function(node, level) { + return this.space(level) + node.value + this.newline; + }; + + XMLStringWriter.prototype.text = function(node, level) { + return this.space(level) + node.value + this.newline; + }; + + XMLStringWriter.prototype.dtdAttList = function(node, level) { + var r; + r = this.space(level) + '' + this.newline; + return r; + }; + + XMLStringWriter.prototype.dtdElement = function(node, level) { + return this.space(level) + '' + this.newline; + }; + + XMLStringWriter.prototype.dtdEntity = function(node, level) { + var r; + r = this.space(level) + '' + this.newline; + return r; + }; + + XMLStringWriter.prototype.dtdNotation = function(node, level) { + var r; + r = this.space(level) + '' + this.newline; + return r; + }; + + XMLStringWriter.prototype.openNode = function(node, level) { + var att, name, r, ref; + level || (level = 0); + if (node instanceof XMLElement) { + r = this.space(level) + '<' + node.name; + ref = node.attributes; + for (name in ref) { + if (!hasProp.call(ref, name)) continue; + att = ref[name]; + r += this.attribute(att); + } + r += (node.children ? '>' : '/>') + this.newline; + return r; + } else { + r = this.space(level) + '') + this.newline; + return r; + } + }; + + XMLStringWriter.prototype.closeNode = function(node, level) { + level || (level = 0); + switch (false) { + case !(node instanceof XMLElement): + return this.space(level) + '' + this.newline; + case !(node instanceof XMLDocType): + return this.space(level) + ']>' + this.newline; + } + }; + + return XMLStringWriter; + + })(XMLWriterBase); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/XMLStringifier.js b/node_modules/xmlbuilder/lib/XMLStringifier.js new file mode 100644 index 0000000..c1844fb --- /dev/null +++ b/node_modules/xmlbuilder/lib/XMLStringifier.js @@ -0,0 +1,163 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLStringifier, + bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; }, + hasProp = {}.hasOwnProperty; + + module.exports = XMLStringifier = (function() { + function XMLStringifier(options) { + this.assertLegalChar = bind(this.assertLegalChar, this); + var key, ref, value; + options || (options = {}); + this.noDoubleEncoding = options.noDoubleEncoding; + ref = options.stringify || {}; + for (key in ref) { + if (!hasProp.call(ref, key)) continue; + value = ref[key]; + this[key] = value; + } + } + + XMLStringifier.prototype.eleName = function(val) { + val = '' + val || ''; + return this.assertLegalChar(val); + }; + + XMLStringifier.prototype.eleText = function(val) { + val = '' + val || ''; + return this.assertLegalChar(this.elEscape(val)); + }; + + XMLStringifier.prototype.cdata = function(val) { + val = '' + val || ''; + val = val.replace(']]>', ']]]]>'); + return this.assertLegalChar(val); + }; + + XMLStringifier.prototype.comment = function(val) { + val = '' + val || ''; + if (val.match(/--/)) { + throw new Error("Comment text cannot contain double-hypen: " + val); + } + return this.assertLegalChar(val); + }; + + XMLStringifier.prototype.raw = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.attName = function(val) { + return val = '' + val || ''; + }; + + XMLStringifier.prototype.attValue = function(val) { + val = '' + val || ''; + return this.attEscape(val); + }; + + XMLStringifier.prototype.insTarget = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.insValue = function(val) { + val = '' + val || ''; + if (val.match(/\?>/)) { + throw new Error("Invalid processing instruction value: " + val); + } + return val; + }; + + XMLStringifier.prototype.xmlVersion = function(val) { + val = '' + val || ''; + if (!val.match(/1\.[0-9]+/)) { + throw new Error("Invalid version number: " + val); + } + return val; + }; + + XMLStringifier.prototype.xmlEncoding = function(val) { + val = '' + val || ''; + if (!val.match(/^[A-Za-z](?:[A-Za-z0-9._-])*$/)) { + throw new Error("Invalid encoding: " + val); + } + return val; + }; + + XMLStringifier.prototype.xmlStandalone = function(val) { + if (val) { + return "yes"; + } else { + return "no"; + } + }; + + XMLStringifier.prototype.dtdPubID = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.dtdSysID = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.dtdElementValue = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.dtdAttType = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.dtdAttDefault = function(val) { + if (val != null) { + return '' + val || ''; + } else { + return val; + } + }; + + XMLStringifier.prototype.dtdEntityValue = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.dtdNData = function(val) { + return '' + val || ''; + }; + + XMLStringifier.prototype.convertAttKey = '@'; + + XMLStringifier.prototype.convertPIKey = '?'; + + XMLStringifier.prototype.convertTextKey = '#text'; + + XMLStringifier.prototype.convertCDataKey = '#cdata'; + + XMLStringifier.prototype.convertCommentKey = '#comment'; + + XMLStringifier.prototype.convertRawKey = '#raw'; + + XMLStringifier.prototype.assertLegalChar = function(str) { + var res; + res = str.match(/[\0\uFFFE\uFFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF]/); + if (res) { + throw new Error("Invalid character in string: " + str + " at index " + res.index); + } + return str; + }; + + XMLStringifier.prototype.elEscape = function(str) { + var ampregex; + ampregex = this.noDoubleEncoding ? /(?!&\S+;)&/g : /&/g; + return str.replace(ampregex, '&').replace(//g, '>').replace(/\r/g, ' '); + }; + + XMLStringifier.prototype.attEscape = function(str) { + var ampregex; + ampregex = this.noDoubleEncoding ? /(?!&\S+;)&/g : /&/g; + return str.replace(ampregex, '&').replace(/ 0) { + return new Array(indent).join(this.indent); + } else { + return ''; + } + } else { + return ''; + } + }; + + return XMLWriterBase; + + })(); + +}).call(this); diff --git a/node_modules/xmlbuilder/lib/index.js b/node_modules/xmlbuilder/lib/index.js new file mode 100644 index 0000000..d2a1dc1 --- /dev/null +++ b/node_modules/xmlbuilder/lib/index.js @@ -0,0 +1,53 @@ +// Generated by CoffeeScript 1.12.7 +(function() { + var XMLDocument, XMLDocumentCB, XMLStreamWriter, XMLStringWriter, assign, isFunction, ref; + + ref = require('./Utility'), assign = ref.assign, isFunction = ref.isFunction; + + XMLDocument = require('./XMLDocument'); + + XMLDocumentCB = require('./XMLDocumentCB'); + + XMLStringWriter = require('./XMLStringWriter'); + + XMLStreamWriter = require('./XMLStreamWriter'); + + module.exports.create = function(name, xmldec, doctype, options) { + var doc, root; + if (name == null) { + throw new Error("Root element needs a name"); + } + options = assign({}, xmldec, doctype, options); + doc = new XMLDocument(options); + root = doc.element(name); + if (!options.headless) { + doc.declaration(options); + if ((options.pubID != null) || (options.sysID != null)) { + doc.doctype(options); + } + } + return root; + }; + + module.exports.begin = function(options, onData, onEnd) { + var ref1; + if (isFunction(options)) { + ref1 = [options, onData], onData = ref1[0], onEnd = ref1[1]; + options = {}; + } + if (onData) { + return new XMLDocumentCB(options, onData, onEnd); + } else { + return new XMLDocument(options); + } + }; + + module.exports.stringWriter = function(options) { + return new XMLStringWriter(options); + }; + + module.exports.streamWriter = function(stream, options) { + return new XMLStreamWriter(stream, options); + }; + +}).call(this); diff --git a/node_modules/xmlbuilder/package.json b/node_modules/xmlbuilder/package.json new file mode 100644 index 0000000..5384c36 --- /dev/null +++ b/node_modules/xmlbuilder/package.json @@ -0,0 +1,65 @@ +{ + "_from": "xmlbuilder@~9.0.1", + "_id": "xmlbuilder@9.0.7", + "_inBundle": false, + "_integrity": "sha1-Ey7mPS7FVlxVfiD0wi35rKaGsQ0=", + "_location": "/xmlbuilder", + "_phantomChildren": {}, + "_requested": { + "type": "range", + "registry": true, + "raw": "xmlbuilder@~9.0.1", + "name": "xmlbuilder", + "escapedName": "xmlbuilder", + "rawSpec": "~9.0.1", + "saveSpec": null, + "fetchSpec": "~9.0.1" + }, + "_requiredBy": [ + "/xml2js" + ], + "_resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-9.0.7.tgz", + "_shasum": "132ee63d2ec5565c557e20f4c22df9aca686b10d", + "_spec": "xmlbuilder@~9.0.1", + "_where": "/Users/cyrille/Documents/GitHub/greenlock-storage-s3/node_modules/xml2js", + "author": { + "name": "Ozgur Ozcitak", + "email": "oozcitak@gmail.com" + }, + "bugs": { + "url": "http://github.com/oozcitak/xmlbuilder-js/issues" + }, + "bundleDependencies": false, + "contributors": [], + "dependencies": {}, + "deprecated": false, + "description": "An XML builder for node.js", + "devDependencies": { + "coffee-coverage": "2.*", + "coffeescript": "1.*", + "coveralls": "*", + "istanbul": "*", + "mocha": "*" + }, + "engines": { + "node": ">=4.0" + }, + "homepage": "http://github.com/oozcitak/xmlbuilder-js", + "keywords": [ + "xml", + "xmlbuilder" + ], + "license": "MIT", + "main": "./lib/index", + "name": "xmlbuilder", + "repository": { + "type": "git", + "url": "git://github.com/oozcitak/xmlbuilder-js.git" + }, + "scripts": { + "postpublish": "rm -rf lib", + "prepublish": "coffee -co lib src", + "test": "mocha \"test/**/*.coffee\" && istanbul report text lcov" + }, + "version": "9.0.7" +} diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..a8a5e88 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,108 @@ +{ + "name": "greenlock-storage-s3", + "version": "1.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "aws-sdk": { + "version": "2.451.0", + "resolved": "https://registry.npmjs.org/aws-sdk/-/aws-sdk-2.451.0.tgz", + "integrity": "sha512-ruVK/fnUFHumSgcqVkJTHLS9eWXc8lf14ZW2G6RVR0baj2MMNDS5gxInuy8GM24Exe0GfnDFk6PnPiSuQs4AVQ==", + "requires": { + "buffer": "4.9.1", + "events": "1.1.1", + "ieee754": "1.1.8", + "jmespath": "0.15.0", + "querystring": "0.2.0", + "sax": "1.2.1", + "url": "0.10.3", + "uuid": "3.3.2", + "xml2js": "0.4.19" + } + }, + "base64-js": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.3.0.tgz", + "integrity": "sha512-ccav/yGvoa80BQDljCxsmmQ3Xvx60/UpBIij5QN21W3wBi/hhIC9OoO+KLpu9IJTS9j4DRVJ3aDDF9cMSoa2lw==" + }, + "buffer": { + "version": "4.9.1", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-4.9.1.tgz", + "integrity": "sha1-bRu2AbB6TvztlwlBMgkwJ8lbwpg=", + "requires": { + "base64-js": "^1.0.2", + "ieee754": "^1.1.4", + "isarray": "^1.0.0" + } + }, + "dotenv": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.0.0.tgz", + "integrity": "sha512-30xVGqjLjiUOArT4+M5q9sYdvuR4riM6yK9wMcas9Vbp6zZa+ocC9dp6QoftuhTPhFAiLK/0C5Ni2nou/Bk8lg==", + "dev": true + }, + "events": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/events/-/events-1.1.1.tgz", + "integrity": "sha1-nr23Y1rQmccNzEwqH1AEKI6L2SQ=" + }, + "ieee754": { + "version": "1.1.8", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.1.8.tgz", + "integrity": "sha1-vjPUCsEO8ZJnAfbwii2G+/0a0+Q=" + }, + "isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=" + }, + "jmespath": { + "version": "0.15.0", + "resolved": "https://registry.npmjs.org/jmespath/-/jmespath-0.15.0.tgz", + "integrity": "sha1-o/Iiqarp+Wb10nx5ZRDigJF2Qhc=" + }, + "punycode": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.3.2.tgz", + "integrity": "sha1-llOgNvt8HuQjQvIyXM7v6jkmxI0=" + }, + "querystring": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/querystring/-/querystring-0.2.0.tgz", + "integrity": "sha1-sgmEkgO7Jd+CDadW50cAWHhSFiA=" + }, + "sax": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.1.tgz", + "integrity": "sha1-e45lYZCyKOgaZq6nSEgNgozS03o=" + }, + "url": { + "version": "0.10.3", + "resolved": "https://registry.npmjs.org/url/-/url-0.10.3.tgz", + "integrity": "sha1-Ah5NnHcF8hu/N9A861h2dAJ3TGQ=", + "requires": { + "punycode": "1.3.2", + "querystring": "0.2.0" + } + }, + "uuid": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.2.tgz", + "integrity": "sha512-yXJmeNaw3DnnKAOKJE51sL/ZaYfWJRl1pK9dr19YFCu0ObS231AB1/LbqTKRAQ5kw8A90rA6fr4riOUpTZvQZA==" + }, + "xml2js": { + "version": "0.4.19", + "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.19.tgz", + "integrity": "sha512-esZnJZJOiJR9wWKMyuvSE1y6Dq5LCuJanqhxslH2bxM6duahNZ+HMpCLhBQGZkbX6xRf8x1Y2eJlgt2q3qo49Q==", + "requires": { + "sax": ">=0.6.0", + "xmlbuilder": "~9.0.1" + } + }, + "xmlbuilder": { + "version": "9.0.7", + "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-9.0.7.tgz", + "integrity": "sha1-Ey7mPS7FVlxVfiD0wi35rKaGsQ0=" + } + } +} diff --git a/package.json b/package.json index 95e340c..16f4a61 100644 --- a/package.json +++ b/package.json @@ -25,5 +25,11 @@ "bugs": { "url": "https://github.com/cderche/greenlock-storage-s3/issues" }, - "homepage": "https://github.com/cderche/greenlock-storage-s3#readme" + "homepage": "https://github.com/cderche/greenlock-storage-s3#readme", + "dependencies": { + "aws-sdk": "^2.451.0" + }, + "devDependencies": { + "dotenv": "^8.0.0" + } }